2014-06-25 10:05:27 +01:00
|
|
|
UPM - Sensor/Actuator repository for Mraa
|
2014-04-30 15:47:12 +01:00
|
|
|
==============
|
2014-04-25 14:48:43 +01:00
|
|
|
|
2014-06-25 10:05:27 +01:00
|
|
|
UPM is a high level repository for sensors that use mraa. Each sensor links to
|
|
|
|
libmraa and are not meant to be interlinked although some groups of sensors may
|
2014-04-25 15:48:27 +01:00
|
|
|
be. Each sensor contains a header which allows to interface with it. Typically
|
|
|
|
a sensor is represented as a class and instanciated.
|
|
|
|
|
|
|
|
The constructor is expected to initialise the sensor and paramters 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.
|
|
|
|
|
2014-06-13 11:53:51 +01:00
|
|
|
### Example
|
|
|
|
|
|
|
|
A sensor/acturo is expected to work as such (here is the servo ES08A api):
|
|
|
|
@snippet es08a.cxx Interesting
|
2014-04-25 15:48:27 +01:00
|
|
|
|
|
|
|
However implementation and API design is compeltely up to the developer, some
|
|
|
|
enumerable sensors for example may provide much clever instanciation. Displays
|
|
|
|
may also create more complex structures in order to interface with them.
|
2014-04-25 14:48:43 +01:00
|
|
|
|
2014-06-13 11:53:51 +01:00
|
|
|
### Building UPM
|
|
|
|
|
|
|
|
See @ref building
|
|
|
|
|
|
|
|
### Making your own UPM module
|
|
|
|
|
|
|
|
@ref porting has more information on making new UPM modules
|
|
|
|
|