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