-MAA - Low Level Skeleton Library for Communication on Intel platforms
+libmraa - Low Level Skeleton Library for Communication on GNU/Linux platforms
==============
-Library in C/C++ to interface with Galileo & other Intel platforms over:
-
-- I2C
-- SPI
-- GPIO
-- PWM
-- AIO
-
-In a structured and sane API with port nanmes/numbering that match boards &
-with bindings to javascript & python.
+Libmraa is a C/C++ library with bindings to javascript & python to interface
+with the IO on Galileo, Edison & other platforms, with a structured and sane
+API where port names/numbering matches the board that you are on. Use of
+libmraa does not tie you to specific hardware with board detection done at
+runtime you can create portable code that will work across the supported
+platforms.
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.
-=== ENV RECOMENDATIONS ===
---------------
+Supported Boards
+================
+
+* [Galileo Gen 1 - Rev D](../master/docs/galileorevd.md)
+* [Galileo Gen 2 - Rev H](../master/docs/galileorevh.md)
+* [Edison](../master/docs/edison.md)
+* [Intel DE3815](../master/docs/intel_de3815.md)
+* [Minnowboard Max](../master/docs/minnow_max.md)
+
+Installing on your board
+========
-node.js 0.10.26
-python 3.3.x or 2.7.x
-swig-v8 3.0.1 (if you want node.js to work you need to use swig-v8)
-I'm using f31c1dce7a45c4b8ed7e6ff845f4c74539e056f1 from
-http://github.com:oliver----/swig-v8
+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:
-=== COMPILING ===
---------------
+``` bash
+echo "src mraa-upm http://iotdk.intel.com/repos/1.1/intelgalactic" > /etc/opkg/mraa-upm.conf
+opkg update
+opkg install libmraa0
+```
-NOTE: The only supported cmake build configuration is to have the build/ dir
-inside of the repo/tarball.
+Compiling
+=========
-if swig-v8 is not in your default path you can try run cmake with
-"-DCMAKE_PREFIX_PATH="/path/to/swig-v8"
+See documentation on [building](../master/docs/building.md)
-mkdir build/
-cmake ..
-make
+Examples
+========
-Install is currently unsuported. Javascript and python modules will be in
-build/src/{javascript, python}
+See the [examples](../../tree/master/examples) available for various languages
-=== DEVELOPMENT ===
---------------
+C/C++ API Documentation
+===========
-Unit tests for all features must be completed prior to implementations, please
-run `ctest -V` from the build dir in order to see current implementation status
+The C/C++ documentation is available [here](http://iotdk.intel.com/docs/master/mraa/)
-=== USING ===
---------------
+Python API Documentation
+===========
-see examples/
+The Python documentation is available [here](http://iotdk.intel.com/docs/master/mraa/python)
-for node.js make sure that maajs.node is in the current dir and set export
-NODE_PATH=.
+NodeJS API documentation
+===========
-python2/3 should both work, although testing is done on python3 exclusively.
-Node.js bindings may be dodgy, I'm so far unclear of how good swig-v8 is.
+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!
projects / contrib / mraa.git / blobdiff