c1f9d15f67
Test commit for building C UPM modules.
* Added C include directory
* Added C utilities directory
* Rename C++ upm.h -> upm.hpp to make room for C upm.h
* Added upm_mixed_module_init function to src/CMakeLists.txt. This
function takes filesnames similar to upm_module_init and does a
bit of processing before calling upm_module_init.
* Added c example directory. Changed c++ example names.
* Added dfrph implemention for testing (C++ wraps C). Added mraa
to .pc requires for dfrph. Tested against stand-alone project.
Added dfrph c example.
* Update implemention of pkg-config file generation.
* Added two cmake cache variables: BUILDCPP and BUILDFTI
* Removed src from swig_add_module calls, added libname to
swig_link_libraries calls. Shrinks swig'ed binaries by ~13%.
* Added install target in upm/CMakeLists.txt to install C header,
directory. Is this where we want this?
* C FTI header directory is include/fti
Signed-off-by: Noel Eck <noel.eck@intel.com>
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 ES08ASample.java 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.
Multi-sensor samples for the starter and specialized kits can be found in the iot-devkit-samples repository.
Supported Sensors
Supported sensor list from API documentation.
You can also refer to the Intel® IoT Developer Zone.
IDE Compatibility
If you would like to create Eclipse IDE projects using the UPM Java samples, please follow the instructions provided on the Intel Developer Zone IDE page.
@htmlonly
@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
@endhtmlonly
Changelog
Version @ref changelog here.
Known Limitations
List of @ref knownlimitations here.