21b65f5eb1
Functions inside namespace are tough to document, bypassing this by documenting the namespace and then using the namespace doc as common.hpp doc in the index Signed-off-by: Brendan Le Foll <brendan.le.foll@intel.com>
MRAA - Low Level Skeleton Library for Communication on GNU/Linux platforms
Library in C/C++ to interface with Galileo & other Intel platforms, in a structured and sane API with port names/numbering that match boards & with bindings to javascript & python.
The intent is to make it easier for developers and sensor manufacturers to map their sensors & actuators on top of supported hardware and to allow control of low level communication protocol by high level languages & constructs.
Supported Boards
Installing on your board
See the section below on compiling or use our repository to install on an eglibc based yocto poky image that supports opkg. Adding this repository is as simple as:
echo "src mraa-upm http://iotdk.intel.com/repos/1.1/intelgalactic" > /etc/opkg/mraa-upm.conf
opkg update
opkg install mraa
Compiling
See documentation on building
Examples
See the examples available for various languages
C/C++ API Documentation
The C/C++ documentation is available here
Python API Documentation
The Python documentation is available here
NodeJS API documentation
There is no explicit nodejs API documentation, see the examples. The API itself is very similar to the python one but with a js syntax. If you know of an autodoc tool for generating nodejs APIs from a native C++ nodejs extension please get in touch!