README.md

   1 UPM - Sensor/Actuator repository for Maa
   2 ==============
   3
   4 UPM is a high level repository for sensors that use maa. Each sensor links to
   5 libmaa 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 A basic sensor is expected to work as such:
  16 s = new sensor();
  17 print(sensor->read());
  18 sleep(1);
  19 s->update();
  20 print(sensor->read();
  21
  22 However implementation and API design is compeltely up to the developer, some
  23 enumerable sensors for example may provide much clever instanciation. Displays
  24 may also create more complex structures in order to interface with them.
  25
  26 For more information on maa, see the maa documentation