README.md

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