1UPM (Useful Packages & Modules) Sensor/Actuator repository for MRAA 2============== 3 4UPM is a high level repository for sensors that use MRAA. Each sensor links 5to MRAA and are not meant to be interlinked although some groups of sensors 6may be. Each sensor contains a header which allows to interface with it. 7Typically a sensor is represented as a class and instantiated. 8 9The constructor is expected to initialise the sensor and parameters may be used 10to provide identification/pin location on the board. 11 12Typically an update() function will be called in order to get new data from the 13sensor in order to reduce load when doing multiple reads to sensor data. 14 15### Example 16 17A sensor/actuator is expected to work as such (here is the servo ES08A API): 18@snippet es08a.cxx Interesting 19 20However implementation and API design is completely up to the developer, some 21enumerable sensors for example may provide much clever instantiation. Displays 22may also create more complex structures in order to interface with them. 23 24Browse through the list of all [examples](https://github.com/intel-iot-devkit/upm/tree/master/examples/c%2B%2B). 25 26Multi-sensor samples for the starter and specialized kits can be found in the 27[iot-devkit-samples](https://github.com/intel-iot-devkit/iot-devkit-samples) repository. 28 29### Supported Sensors 30 31Supported [sensor list](http://iotdk.intel.com/docs/master/upm/modules.html) from API documentation. 32 33You can also refer to the [Intel® IoT Developer Zone](https://software.intel.com/iot/sensors). 34 35### IDE Compatibility 36 37If you would like to create Eclipse IDE projects using the UPM C++ samples, 38please follow the instructions provided on the Intel Developer Zone IDE page. 39 40@htmlonly 41<a href="https://software.intel.com/iot/software/ide"><img src="docs/icons/eclipse.png"/></a> 42@endhtmlonly 43 44### Building UPM 45 46See @ref building here. 47 48### Making your own UPM module 49 50@ref porting link has more information on making new UPM modules. 51 52There is also an example available for @ref max31855 sensor. 53 54### Naming conventions and rules for new UPM contributions 55 56Before you begin development, take a look at our @ref naming conventions. 57 58Also, please read the guidelines for @ref contributions to UPM. 59 60Don't forget to check the @ref documentation section. 61 62Make sure you add yourself as an author on every new code file submitted. 63If you are providing a fix with significant changes, feel free to add yourself 64as a contributor. Signing-off your commits is mandatory. 65 66API Documentation 67============== 68 69@htmlonly 70 71<a href="http://iotdk.intel.com/docs/master/upm"><img src="docs/icons/c++.png"/></a> 72<a href="http://iotdk.intel.com/docs/master/upm/java"><img src="docs/icons/java.png"/></a> 73<a href="http://iotdk.intel.com/docs/master/upm/python"><img src="docs/icons/python.png"/></a> 74<a href="http://iotdk.intel.com/docs/master/upm/node"><img src="docs/icons/node.png"/></a> 75 76@endhtmlonly 77 78### Changelog 79Version @ref changelog here. 80 81### Known Limitations 82List of @ref knownlimitations here. 83
