Brak opisu

Noel Eck 6b273a1b49 docs: Added exclude to Doxyfile for boschdriver src. The boschdriver.h file contains tags which are picked up by doxygen and cause incorrect results. For example, the \mainpage and \license cause the Bosch header collateral to be placed on the index.html page of the UPM docs. Added an entry to EXCLUDE_PATTERNS which handles this. Signed-off-by: Noel Eck <noel.eck@intel.com>		8 lat temu
..
node	docs: changed libmraa references to MRAA	9 lat temu
Doxyfile.in	docs: Added exclude to Doxyfile for boschdriver src.	8 lat temu
Doxyfile.java.in	docs: fixed mispelled cmake variable and improved java doxyfile	9 lat temu
DoxygenLayout.xml	doxygen: moved group/library graphs to bottom of the page	9 lat temu
README.cpp.md	cmake: added doxygen doc content to python sensor modules	9 lat temu
README.java.md	docs: changed libmraa references to MRAA	9 lat temu
conf.py.in	cmake: minor cleanup and changes for pydoc target	9 lat temu
index.rst	docs: fixed links and minor typos in index files	9 lat temu
samples.mapping.txt	doxy: Corrected sample mapping	8 lat temu

UPM (Useful Packages & Modules) Sensor/Actuator repository for MRAA

UPM is a high level repository for sensors that use MRAA. Each sensor links to MRAA 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.

The constructor is expected to initialise the sensor and parameters may be used to provide identification/pin location on the board.

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.

Example

A sensor/actuator is expected to work as such (here is the servo ES08A API): @snippet es08a.cxx Interesting

However implementation and API design is completely up to the developer, some enumerable sensors for example may provide much clever instantiation. Displays may also create more complex structures in order to interface with them.

Browse through the list of all examples.

Multi-sensor samples for the starter and specialized kits can be found in the iot-devkit-samples repository.

Supported Sensors

Supported sensor list from API documentation.

You can also refer to the Intel IoT Developer Zone.

IDE Compatibility

If you would like to create Eclipse IDE projects using the UPM C++ samples, please follow the instructions provided on the Intel Developer Zone IDE page.

@htmlonly @endhtmlonly

Building UPM

See @ref building here.

Making your own UPM module

@ref porting link has more information on making new UPM modules.

There is also an example available for @ref max31855 sensor.

Naming conventions and rules for new UPM contributions

Before you begin development, take a look at our @ref naming conventions.

Also, please read the guidelines for @ref contributions to UPM.

Don’t forget to check the @ref documentation section.

Make sure you add yourself as an author on every new code file submitted. If you are providing a fix with significant changes, feel free to add yourself as a contributor. Signing-off your commits is mandatory.