Brendan Le Foll 6d239b9f63 docs: fix warnings in doc creation | 10 years ago | |
---|---|---|
cmake/modules | 10 years ago | |
docs | 10 years ago | |
examples | 10 years ago | |
src | 10 years ago | |
.gitignore | 10 years ago | |
CMakeLists.txt | 10 years ago | |
COPYING | 10 years ago | |
Doxyfile.in | 10 years ago | |
README.md | 10 years ago |
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 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.
A sensor/acturo is expected to work as such (here is the servo ES08A api): @snippet es08a.cxx Interesting
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.
See @ref building
@ref porting has more information on making new UPM modules