Nav apraksta
Brendan Le Foll 02fb40f058 max5847: improve documentation 10 gadus atpakaļ
cmake/modules ipk: add cpack ipk generation 10 gadus atpakaļ
docs max5847: improve documentation 10 gadus atpakaļ
examples th02:: added new humidity&temperature sensor 10 gadus atpakaļ
src max5847: improve documentation 10 gadus atpakaļ
.gitignore .gitignore: add git ignore file 10 gadus atpakaļ
CMakeLists.txt upm: update to 0.1.7 10 gadus atpakaļ
COPYING COPYING: add MIT license 10 gadus atpakaļ
Doxyfile.in Doxygen: add layout file and make formatting more sensible 10 gadus atpakaļ
DoxygenLayout.xml Doxygen: add layout file and make formatting more sensible 10 gadus atpakaļ
README.md mraa: change all existing code to use libmraa. 10 gadus atpakaļ

README.md

UPM - Sensor/Actuator repository for Mraa

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.

Example

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.

Building UPM

See @ref building

Making your own UPM module

@ref porting has more information on making new UPM modules