2015-02-25 15:14:25 -08:00
|
|
|
UPM - Sensor/Actuator repository for libmraa
|
2014-04-30 15:47:12 +01:00
|
|
|
==============
|
2014-04-25 14:48:43 +01:00
|
|
|
|
2015-02-25 15:14:25 -08:00
|
|
|
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.
|
2014-04-25 15:48:27 +01:00
|
|
|
|
2015-02-25 15:14:25 -08:00
|
|
|
The constructor is expected to initialise the sensor and parameters may be used
|
2014-04-25 15:48:27 +01:00
|
|
|
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.
|
|
|
|
|
2014-06-13 11:53:51 +01:00
|
|
|
### Example
|
|
|
|
|
2015-02-25 15:14:25 -08:00
|
|
|
A sensor/actuator is expected to work as such (here is the servo ES08A API):
|
2014-06-13 11:53:51 +01:00
|
|
|
@snippet es08a.cxx Interesting
|
2014-04-25 15:48:27 +01:00
|
|
|
|
2015-02-25 15:14:25 -08:00
|
|
|
However implementation and API design is completely up to the developer, some
|
|
|
|
enumerable sensors for example may provide much clever instantiation. Displays
|
2014-04-25 15:48:27 +01:00
|
|
|
may also create more complex structures in order to interface with them.
|
2014-04-25 14:48:43 +01:00
|
|
|
|
2015-02-25 15:14:25 -08:00
|
|
|
Browse through the list of all [examples](https://github.com/intel-iot-devkit/upm/tree/master/examples).
|
2014-08-29 15:37:11 +01:00
|
|
|
|
2015-02-25 15:14:25 -08:00
|
|
|
### Supported Sensors
|
2014-08-29 15:37:11 +01:00
|
|
|
|
2015-02-25 15:14:25 -08:00
|
|
|
Supported [sensor list](http://iotdk.intel.com/docs/master/upm/modules.html) from API documentation.
|
2014-09-01 15:31:55 +01:00
|
|
|
|
2015-02-25 15:14:25 -08:00
|
|
|
You can also refer to the [Intel® IoT Developer Zone](https://software.intel.com/iot/sensors).
|
2014-08-29 15:37:11 +01:00
|
|
|
|
2015-02-25 15:14:25 -08:00
|
|
|
### Building UPM
|
2014-08-29 15:37:11 +01:00
|
|
|
|
2015-02-25 15:14:25 -08:00
|
|
|
See @ref building [here](docs/building.md).
|
2014-08-29 15:37:11 +01:00
|
|
|
|
2015-02-25 15:14:25 -08:00
|
|
|
### Making your own UPM module
|
2014-08-29 15:37:11 +01:00
|
|
|
|
2015-02-25 15:14:25 -08:00
|
|
|
@ref porting [link](docs/porting.md) has more information on making new UPM modules.
|
2014-08-29 15:37:11 +01:00
|
|
|
|
2015-02-25 15:14:25 -08:00
|
|
|
There is also an example available for @ref max31855 [sensor](docs/max31855.md).
|
2014-09-07 21:47:07 +01:00
|
|
|
|
2015-02-25 15:14:25 -08:00
|
|
|
### Naming conventions and rules for new UPM contributions
|
2014-06-13 11:53:51 +01:00
|
|
|
|
2015-02-25 15:14:25 -08:00
|
|
|
Before you begin development, take a look at our @ref naming [conventions](docs/naming.md).
|
2014-06-13 11:53:51 +01:00
|
|
|
|
2015-02-25 15:14:25 -08:00
|
|
|
Also, please read the guidelines for @ref contributions [to UPM](docs/contributions.md).
|
2014-06-13 11:53:51 +01:00
|
|
|
|
2015-02-25 15:14:25 -08:00
|
|
|
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.
|
2014-06-13 11:53:51 +01:00
|
|
|
|
2014-09-23 10:29:18 +01:00
|
|
|
C/C++ API Documentation
|
2015-02-25 15:14:25 -08:00
|
|
|
==============
|
2014-09-23 10:29:18 +01:00
|
|
|
|
2015-02-25 15:14:25 -08:00
|
|
|
The C/C++ documentation is available [here](http://iotdk.intel.com/docs/master/upm/).
|