README.md

   1 libmraa - Low Level Skeleton Library for Communication on GNU/Linux platforms
   2 ==============
   3
   4 Library in C/C++ to interface with Galileo & other Intel platforms, in a
   5 structured and sane API with port names/numbering that match boards & with
   6 bindings to javascript & python.
   7
   8 The intent is to make it easier for developers and sensor manufacturers to map
   9 their sensors & actuators on top of supported hardware and to allow control of
  10 low level communication protocol by high level languages & constructs.
  11
  12 Supported Boards
  13 ================
  14
  15 * [Galileo Gen 1 - Rev D](../master/docs/galileorevd.md)
  16 * [Galileo Gen 2 - Rev H](../master/docs/galileorevh.md)
  17 * [Edison](../master/docs/edison.md)
  18
  19 Installing on your board
  20 ========
  21
  22 See the section below on compiling or use our repository to install on an
  23 eglibc based yocto poky image that supports opkg. Adding this repository is as
  24 simple as:
  25
  26 ``` bash
  27 echo "src mraa-upm http://iotdk.intel.com/repos/1.1/intelgalactic" > /etc/opkg/mraa-upm.conf
  28 opkg update
  29 opkg install libmraa0
  30 ```
  31
  32 Compiling
  33 =========
  34
  35 See documentation on [building](../master/docs/building.md)
  36
  37 Examples
  38 ========
  39
  40 See the [examples](../../tree/master/examples) available for various languages
  41
  42 C/C++ API Documentation
  43 ===========
  44
  45 The C/C++ documentation is available [here](http://iotdk.intel.com/docs/master/mraa/)
  46
  47 Python API Documentation
  48 ===========
  49
  50 The Python documentation is available [here](http://iotdk.intel.com/docs/master/mraa/python)
  51
  52 NodeJS API documentation
  53 ===========
  54
  55 There is no explicit nodejs API documentation, see the examples. The API itself
  56 is very similar to the python one but with a js syntax. If you know of an
  57 autodoc tool for generating nodejs APIs from a native C++ nodejs extension
  58 please get in touch!