mirror of
https://github.com/eclipse/upm.git
synced 2025-11-04 17:14:54 +03:00
docs: modified index pages for documentation to link to samples repo
Signed-off-by: Mihai Tudor Panu <mihai.tudor.panu@intel.com>
This commit is contained in:
Mihai Tudor Panu
@@ -23,6 +23,9 @@ may also create more complex structures in order to interface with them.
|
|||||||
|
|
||||||
Browse through the list of all [examples](https://github.com/intel-iot-devkit/upm/tree/master/examples).
|
Browse through the list of all [examples](https://github.com/intel-iot-devkit/upm/tree/master/examples).
|
||||||
|
|
||||||
|
Multi-sensor samples for the starter and specialized kits can be found in the
|
||||||
|
[iot-devkit-samples](https://github.com/intel-iot-devkit/iot-devkit-samples) repository.
|
||||||
|
|
||||||
### Supported Sensors
|
### Supported Sensors
|
||||||
|
|
||||||
Supported [sensor list](http://iotdk.intel.com/docs/master/upm/modules.html) from API documentation.
|
Supported [sensor list](http://iotdk.intel.com/docs/master/upm/modules.html) from API documentation.
|
||||||
|
|||||||
@@ -15,6 +15,14 @@
|
|||||||
|
|
||||||
For building UPM, please follow this `link <https://github.com/intel-iot-devkit/upm/blob/master/docs/building.md>`_.
|
For building UPM, please follow this `link <https://github.com/intel-iot-devkit/upm/blob/master/docs/building.md>`_.
|
||||||
|
|
||||||
|
``Examples``
|
||||||
|
############
|
||||||
|
|
||||||
|
Multi-sensor samples for the starter and specialized kits can be found in the `iot-devkit-samples <https://github.com/intel-iot-devkit/iot-devkit-samples>`_
|
||||||
|
repository.
|
||||||
|
|
||||||
|
Individual sensor usage examples for python are available `here <https://github.com/intel-iot-devkit/upm/tree/master/examples/python>`_.
|
||||||
|
|
||||||
``Making your own UPM Module``
|
``Making your own UPM Module``
|
||||||
##############################
|
##############################
|
||||||
|
|
||||||
|
|||||||
@@ -1,150 +1,166 @@
|
|||||||
<div class="apidocs">
|
<div class="apidocs">
|
||||||
<div class="content" id="docs-main">
|
<div class="content" id="docs-main">
|
||||||
<h1><strong>Welcome to UPM Node.JS Documentation!</strong><a class="headerlink"
|
<h1><strong>Welcome to UPM Node.JS Documentation!</strong><a class="headerlink"
|
||||||
href="#welcome-to-upm-python-documentation"></a></h1>
|
href="#welcome-to-upm-python-documentation"></a></h1>
|
||||||
|
|
||||||
|
|
||||||
|
<p>Browse to a module or class using the sidebar to view its API
|
||||||
|
documentation.</p>
|
||||||
|
|
||||||
|
<p>UPM is a high level repository for sensors that use libmraa. Each
|
||||||
|
sensor links to libmraa and are not meant to be interlinked although
|
||||||
|
some groups of sensors may be. Each sensor contains a header which
|
||||||
|
allows to interface with it. Typically a sensor is represented as a
|
||||||
|
class and instantiated.</p>
|
||||||
|
|
||||||
|
<p>The constructor is expected to initialise the sensor and parameters
|
||||||
|
may be used to provide identification/pin location on the board.</p>
|
||||||
|
|
||||||
|
<p>Typically an update() function will be called in order to get new
|
||||||
|
data from the sensor in order to reduce load when doing multiple reads
|
||||||
|
to sensor data.</p>
|
||||||
|
<div class="section" id="examples">
|
||||||
|
<h3><code class="docutils literal"><span class="pre">Examples</span></code><a class="headerlink"
|
||||||
|
href="#examples"
|
||||||
|
title="Permalink to this headline">*</a></h3>
|
||||||
|
|
||||||
|
|
||||||
<p>Browse to a module or class using the sidebar to view its API
|
<p>Multi-sensor samples for the starter and specialized kits can be
|
||||||
documentation.</p>
|
found in the
|
||||||
|
<a class="reference external"
|
||||||
|
href="https://github.com/intel-iot-devkit/iot-devkit-samples">iot-devkit-samples</a>
|
||||||
|
repository.</p>
|
||||||
|
|
||||||
<p>UPM is a high level repository for sensors that use libmraa. Each
|
<p>Individual sensor usage examples for node.js are available
|
||||||
sensor links to libmraa and are not meant to be interlinked although
|
<a class="reference external"
|
||||||
some groups of sensors may be. Each sensor contains a header which
|
href="https://github.com/intel-iot-devkit/upm/tree/master/examples/javascript">here</a>.</p>
|
||||||
allows to interface with it. Typically a sensor is represented as a
|
|
||||||
class and instantiated.</p>
|
</div>
|
||||||
|
<div class="section" id="building-upm">
|
||||||
|
<h3><tt class="docutils literal"><span class="pre">Building</span>
|
||||||
|
<span class="pre">UPM</span></tt><a class="headerlink"
|
||||||
|
href="#building-upm"
|
||||||
|
title="Permalink to this headline">*</a></h3>
|
||||||
|
|
||||||
|
|
||||||
<p>The constructor is expected to initialise the sensor and
|
<p>For building UPM, please follow this
|
||||||
parameters may be used to provide identification/pin location on the
|
<a class="reference external"
|
||||||
board.</p>
|
href="https://github.com/intel-iot-devkit/upm/blob/master/docs/building.md">link</a>.</p>
|
||||||
|
|
||||||
|
</div>
|
||||||
|
<div class="section" id="making-your-own-upm-module">
|
||||||
|
<h3><tt class="docutils literal"><span class="pre">Making</span>
|
||||||
|
<span class="pre">your</span> <span class="pre">own</span>
|
||||||
|
<span class="pre">UPM</span> <span class="pre">Module</span></tt><a class="headerlink"
|
||||||
|
href="#making-your-own-upm-module"
|
||||||
|
title="Permalink to this headline">*</a></h3>
|
||||||
|
|
||||||
|
|
||||||
<p>Typically an update() function will be called in order to get new
|
<p>This
|
||||||
data from the sensor in order to reduce load when doing multiple
|
<a class="reference external"
|
||||||
reads to sensor data.</p>
|
href="https://github.com/intel-iot-devkit/upm/blob/master/docs/porting.md">link</a>
|
||||||
<div class="section" id="building-upm">
|
has more information on making a new UPM module.</p>
|
||||||
<h3><tt class="docutils literal"><span class="pre">Building</span>
|
|
||||||
<span class="pre">UPM</span></tt><a class="headerlink"
|
|
||||||
href="#building-upm"
|
|
||||||
title="Permalink to this headline">*</a></h3>
|
|
||||||
|
|
||||||
|
|
||||||
<p>For building UPM, please follow this
|
<p>There is also an example available for max31855
|
||||||
<a class="reference external"
|
<a class="reference external"
|
||||||
href="https://github.com/intel-iot-devkit/upm/blob/master/docs/building.md">link</a>.</p>
|
href="https://github.com/intel-iot-devkit/upm/blob/master/docs/max31855.md">sensor</a>.</p>
|
||||||
|
|
||||||
|
</div>
|
||||||
|
<div class="section"
|
||||||
|
id="naming-conventions-and-rules-for-new-upm-contributions">
|
||||||
|
<h3><tt class="docutils literal"><span class="pre">Naming</span>
|
||||||
|
<span class="pre">Conventions</span> <span class="pre">and</span>
|
||||||
|
<span class="pre">Rules</span> <span class="pre">for</span>
|
||||||
|
<span class="pre">New</span> <span class="pre">UPM</span>
|
||||||
|
<span class="pre">Contributions</span></tt><a class="headerlink"
|
||||||
|
href="#naming-conventions-and-rules-for-new-upm-contributions"
|
||||||
|
title="Permalink to this headline">*</a></h3>
|
||||||
|
|
||||||
|
|
||||||
|
<p>Before you begin development, please take a look at our naming
|
||||||
|
<a class="reference external"
|
||||||
|
href="https://github.com/intel-iot-devkit/upm/blob/master/docs/naming.md">conventions</a>.</p>
|
||||||
|
|
||||||
|
|
||||||
|
<p>Also, please read the guidelines for contributions to
|
||||||
|
<a class="reference external"
|
||||||
|
href="https://github.com/intel-iot-devkit/upm/blob/master/docs/contributions.md">UPM</a>.</p>
|
||||||
|
|
||||||
|
|
||||||
|
<p>Don’t forget to check the documentation
|
||||||
|
<a class="reference external"
|
||||||
|
href="https://github.com/intel-iot-devkit/upm/blob/master/docs/documentation.md">section</a>.</p>
|
||||||
|
|
||||||
|
<div class="admonition note">
|
||||||
|
|
||||||
|
<p class="first admonition-title">Note</p>
|
||||||
|
<ul class="last simple">
|
||||||
|
<li>Make sure you add yourself as an author on every new code
|
||||||
|
file submitted.</li>
|
||||||
|
<li>If you are providing a fix with significant changes, feel
|
||||||
|
free to add yourself as a contributor.</li>
|
||||||
|
<li>Signing-off your commits is mandatory.</li>
|
||||||
|
</ul>
|
||||||
</div>
|
</div>
|
||||||
<div class="section" id="making-your-own-upm-module">
|
</div>
|
||||||
<h3><tt class="docutils literal"><span class="pre">Making</span>
|
<div class="section" id="api-documentation">
|
||||||
<span class="pre">your</span> <span class="pre">own</span>
|
<h1><strong>API Documentation</strong><a class="headerlink"
|
||||||
<span class="pre">UPM</span> <span class="pre">Module</span></tt><a class="headerlink"
|
href="#api-documentation"
|
||||||
href="#making-your-own-upm-module"
|
title="Permalink to this headline"></a></h1>
|
||||||
title="Permalink to this headline">*</a></h3>
|
|
||||||
|
|
||||||
|
|
||||||
<p>This
|
<p><a href="http://iotdk.intel.com/docs/master/upm/"><img src="../docs/c++.png" /></a>
|
||||||
<a class="reference external"
|
<a href="http://iotdk.intel.com/docs/master/upm/python"><img src="../docs/python.png" /></a>
|
||||||
href="https://github.com/intel-iot-devkit/upm/blob/master/docs/porting.md">link</a>
|
<a href="http://iotdk.intel.com/docs/master/upm/node"><img src="../docs/node.png" /></a>
|
||||||
has more information on making a new UPM module.</p>
|
</p>
|
||||||
|
</div>
|
||||||
|
<div class="section" id="version-changelog">
|
||||||
|
<h3><tt class="docutils literal"><span class="pre">Version</span>
|
||||||
|
<span class="pre">Changelog</span></tt><a class="headerlink"
|
||||||
|
href="#version-changelog"
|
||||||
|
title="Permalink to this headline">*</a></h3>
|
||||||
|
|
||||||
|
|
||||||
<p>There is also an example available for max31855
|
<p>For our Version Changelog, please see
|
||||||
<a class="reference external"
|
<a class="reference external"
|
||||||
href="https://github.com/intel-iot-devkit/upm/blob/master/docs/max31855.md">sensor</a>.</p>
|
href="https://github.com/intel-iot-devkit/upm/blob/master/docs/changelog.md">here</a>.</p>
|
||||||
|
|
||||||
</div>
|
</div>
|
||||||
<div class="section"
|
<div class="section" id="known-limitations">
|
||||||
id="naming-conventions-and-rules-for-new-upm-contributions">
|
<h3><tt class="docutils literal"><span class="pre">Known</span>
|
||||||
<h3><tt class="docutils literal"><span class="pre">Naming</span>
|
<span class="pre">Limitations</span></tt><a class="headerlink"
|
||||||
<span class="pre">Conventions</span> <span class="pre">and</span>
|
href="#known-limitations"
|
||||||
<span class="pre">Rules</span> <span class="pre">for</span>
|
title="Permalink to this headline">*</a></h3>
|
||||||
<span class="pre">New</span> <span class="pre">UPM</span>
|
|
||||||
<span class="pre">Contributions</span></tt><a class="headerlink"
|
|
||||||
href="#naming-conventions-and-rules-for-new-upm-contributions"
|
|
||||||
title="Permalink to this headline">*</a></h3>
|
|
||||||
|
|
||||||
|
|
||||||
<p>Before you begin development, please take a look at our naming
|
<p>For the List of Known Limitations, please see
|
||||||
<a class="reference external"
|
<a class="reference external"
|
||||||
href="https://github.com/intel-iot-devkit/upm/blob/master/docs/naming.md">conventions</a>.</p>
|
href="https://github.com/intel-iot-devkit/upm/blob/master/docs/knownlimitations.md">here</a>.</p>
|
||||||
|
|
||||||
|
</div>
|
||||||
|
<div class="section" id="keyboard-shortcuts">
|
||||||
|
<h3><tt class="docutils literal"><span class="pre">Keyboard</span>
|
||||||
|
<span class="pre">Shortcuts</span></tt><a class="headerlink"
|
||||||
|
href="#keyboard-shortcuts"
|
||||||
|
title="Permalink to this headline">*</a></h3>
|
||||||
|
|
||||||
|
<ul>
|
||||||
|
<li>
|
||||||
|
|
||||||
<p>Also, please read the guidelines for contributions to
|
<p>Press <kbd>s</kbd> to focus the API search box.</p> </li>
|
||||||
<a class="reference external"
|
<li>
|
||||||
href="https://github.com/intel-iot-devkit/upm/blob/master/docs/contributions.md">UPM</a>.</p>
|
|
||||||
|
|
||||||
|
|
||||||
<p>Don’t forget to check the documentation
|
<p>Use <kbd>Up</kbd> and <kbd>Down</kbd> to select classes,
|
||||||
<a class="reference external"
|
modules, and search results.</p> </li>
|
||||||
href="https://github.com/intel-iot-devkit/upm/blob/master/docs/documentation.md">section</a>.</p>
|
<li class="mac-only">
|
||||||
|
|
||||||
<div class="admonition note">
|
|
||||||
|
|
||||||
<p class="first admonition-title">Note</p>
|
<p>With the API search box or sidebar focused, use <kbd><span class="cmd">⌘</span>-Left</kbd>
|
||||||
<ul class="last simple">
|
or <kbd><span class="cmd">⌘</span>-Right</kbd> to switch
|
||||||
<li>Make sure you add yourself as an author on every new
|
sidebar tabs.</p> </li>
|
||||||
code file submitted.</li>
|
<li class="pc-only">
|
||||||
<li>If you are providing a fix with significant changes,
|
|
||||||
feel free to add yourself as a contributor.</li>
|
|
||||||
<li>Signing-off your commits is mandatory.</li>
|
|
||||||
</ul>
|
|
||||||
</div>
|
|
||||||
</div>
|
|
||||||
<div class="section" id="api-documentation">
|
|
||||||
<h1><strong>API Documentation</strong><a class="headerlink"
|
|
||||||
href="#api-documentation"
|
|
||||||
title="Permalink to this headline"></a></h1>
|
|
||||||
|
|
||||||
|
|
||||||
<p><a href="http://iotdk.intel.com/docs/master/upm/"><img src="../docs/c++.png" /></a>
|
<p>With the API search box or sidebar focused, use <kbd>Ctrl+Left</kbd>
|
||||||
<a href="http://iotdk.intel.com/docs/master/upm/python"><img src="../docs/python.png" /></a>
|
and <kbd>Ctrl+Right</kbd> to switch sidebar tabs.</p> </li>
|
||||||
<a href="http://iotdk.intel.com/docs/master/upm/node"><img src="../docs/node.png" /></a>
|
</ul>
|
||||||
</p>
|
</div>
|
||||||
</div>
|
</div>
|
||||||
<div class="section" id="version-changelog">
|
|
||||||
<h3><tt class="docutils literal"><span class="pre">Version</span>
|
|
||||||
<span class="pre">Changelog</span></tt><a class="headerlink"
|
|
||||||
href="#version-changelog"
|
|
||||||
title="Permalink to this headline">*</a></h3>
|
|
||||||
|
|
||||||
|
|
||||||
<p>For our Version Changelog, please see
|
|
||||||
<a class="reference external"
|
|
||||||
href="https://github.com/intel-iot-devkit/upm/blob/master/docs/changelog.md">here</a>.</p>
|
|
||||||
|
|
||||||
</div>
|
|
||||||
<div class="section" id="known-limitations">
|
|
||||||
<h3><tt class="docutils literal"><span class="pre">Known</span>
|
|
||||||
<span class="pre">Limitations</span></tt><a class="headerlink"
|
|
||||||
href="#known-limitations"
|
|
||||||
title="Permalink to this headline">*</a></h3>
|
|
||||||
|
|
||||||
|
|
||||||
<p>For the List of Known Limitations, please see
|
|
||||||
<a class="reference external"
|
|
||||||
href="https://github.com/intel-iot-devkit/upm/blob/master/docs/knownlimitations.md">here</a>.</p>
|
|
||||||
|
|
||||||
</div>
|
|
||||||
<div class="section" id="keyboard-shortcuts">
|
|
||||||
<h3><tt class="docutils literal"><span class="pre">Keyboard</span>
|
|
||||||
<span class="pre">Shortcuts</span></tt><a class="headerlink"
|
|
||||||
href="#keyboard-shortcuts"
|
|
||||||
title="Permalink to this headline">*</a></h3>
|
|
||||||
|
|
||||||
<ul>
|
|
||||||
<li>
|
|
||||||
|
|
||||||
<p>Press <kbd>s</kbd> to focus the API search box.</p> </li>
|
|
||||||
<li>
|
|
||||||
|
|
||||||
<p>Use <kbd>Up</kbd> and <kbd>Down</kbd> to select classes,
|
|
||||||
modules, and search results.</p> </li>
|
|
||||||
<li class="mac-only">
|
|
||||||
|
|
||||||
<p>With the API search box or sidebar focused, use <kbd><span class="cmd">⌘</span>-Left</kbd>
|
|
||||||
or <kbd><span class="cmd">⌘</span>-Right</kbd> to switch
|
|
||||||
sidebar tabs.</p> </li>
|
|
||||||
<li class="pc-only">
|
|
||||||
|
|
||||||
<p>With the API search box or sidebar focused, use <kbd>Ctrl+Left</kbd>
|
|
||||||
and <kbd>Ctrl+Right</kbd> to switch sidebar tabs.</p> </li>
|
|
||||||
</ul>
|
|
||||||
</div>
|
|
||||||
</div>
|
|
||||||
|
|||||||
Reference in New Issue
Block a user