README.md

   1 UPM - Sensor/Actuator repository for Mraa
   2 ==============
   3
   4 UPM is a high level repository for sensors that use mraa. Each sensor links to
   5 libmraa and are not meant to be interlinked although some groups of sensors may
   6 be. Each sensor contains a header which allows to interface with it. Typically
   7 a sensor is represented as a class and instanciated.
   8
   9 The constructor is expected to initialise the sensor and paramters may be used
  10 to provide identification/pin location on the board.
  11
  12 Typically an update() function will be called in order to get new data from the
  13 sensor in order to reduce load when doing multiple reads to sensor data.
  14
  15 ### Example
  16
  17 A sensor/acturo is expected to work as such (here is the servo ES08A api):
  18 @snippet es08a.cxx Interesting
  19
  20 However implementation and API design is compeltely up to the developer, some
  21 enumerable sensors for example may provide much clever instanciation. Displays
  22 may also create more complex structures in order to interface with them.
  23
  24 ### Building UPM
  25
  26 See @ref building
  27
  28 ### Making your own UPM module
  29
  30 @ref porting has more information on making new UPM modules
  31