diff options
Diffstat (limited to 'peripheral/libupm/doxy/README.cpp.md')
| -rw-r--r-- | peripheral/libupm/doxy/README.cpp.md | 82 |
1 files changed, 0 insertions, 82 deletions
diff --git a/peripheral/libupm/doxy/README.cpp.md b/peripheral/libupm/doxy/README.cpp.md deleted file mode 100644 index 7bbb9f3..0000000 --- a/peripheral/libupm/doxy/README.cpp.md +++ /dev/null @@ -1,82 +0,0 @@ -UPM (Useful Packages & Modules) Sensor/Actuator repository for MRAA -============== - -UPM is a high level repository for sensors that use MRAA. Each sensor links -to MRAA 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 instantiated. - -The constructor is expected to initialise the sensor and parameters 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/actuator is expected to work as such (here is the servo ES08A API): -@snippet es08a.cxx Interesting - -However implementation and API design is completely up to the developer, some -enumerable sensors for example may provide much clever instantiation. Displays -may also create more complex structures in order to interface with them. - -Browse through the list of all [examples](https://github.com/intel-iot-devkit/upm/tree/master/examples/c%2B%2B). - -Multi-sensor samples for the starter and specialized kits can be found in the -[iot-devkit-samples](https://github.com/intel-iot-devkit/iot-devkit-samples) repository. - -### Supported Sensors - -Supported [sensor list](http://iotdk.intel.com/docs/master/upm/modules.html) from API documentation. - -You can also refer to the [Intel IoT Developer Zone](https://software.intel.com/iot/sensors). - -### IDE Compatibility - -If you would like to create Eclipse IDE projects using the UPM C++ samples, -please follow the instructions provided on the Intel Developer Zone IDE page. - -@htmlonly -<a href="https://software.intel.com/iot/software/ide"><img src="docs/icons/eclipse.png"/></a> -@endhtmlonly - -### Building UPM - -See @ref building here. - -### Making your own UPM module - -@ref porting link has more information on making new UPM modules. - -There is also an example available for @ref max31855 sensor. - -### Naming conventions and rules for new UPM contributions - -Before you begin development, take a look at our @ref naming conventions. - -Also, please read the guidelines for @ref contributions to UPM. - -Don't forget to check the @ref documentation section. - -Make sure you add yourself as an author on every new code file submitted. -If you are providing a fix with significant changes, feel free to add yourself -as a contributor. Signing-off your commits is mandatory. - -API Documentation -============== - -@htmlonly - -<a href="http://iotdk.intel.com/docs/master/upm"><img src="docs/icons/c++.png"/></a> -<a href="http://iotdk.intel.com/docs/master/upm/java"><img src="docs/icons/java.png"/></a> -<a href="http://iotdk.intel.com/docs/master/upm/python"><img src="docs/icons/python.png"/></a> -<a href="http://iotdk.intel.com/docs/master/upm/node"><img src="docs/icons/node.png"/></a> - -@endhtmlonly - -### Changelog -Version @ref changelog here. - -### Known Limitations -List of @ref knownlimitations here. |