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 X86
  19 ---
  20 * [Galileo Gen 1 - Rev D](../master/docs/galileorevd.md)
  21 * [Galileo Gen 2 - Rev H](../master/docs/galileorevh.md)
  22 * [Edison](../master/docs/edison.md)
  23 * [Intel DE3815](../master/docs/intel_de3815.md)
  24 * [Minnowboard Max](../master/docs/minnow_max.md)
  25
  26 ARM
  27 ---
  28 * [Raspberry Pi](../master/docs/raspberry_pi.md)
  29 * [Bannana Pi](../master/docs/banana_pi.md)
  30 * [Beaglebone Black](../master/docs/beaglebone.md)
  31
  32 Installing on your board
  33 ========
  34
  35 See the section below on compiling or use our repository to install on an
  36 eglibc based yocto poky image that supports opkg. Adding this repository is as
  37 simple as and you'll have the latest stable tagged build of mraa installed!
  38
  39 ``` bash
  40 echo "src mraa-upm http://iotdk.intel.com/repos/1.1/intelgalactic" > /etc/opkg/mraa-upm.conf
  41 opkg update
  42 opkg install libmraa0
  43 ```
  44
  45 If you would like to get the latest & greatest builds from master HEAD you can
  46 use our -dev repository
  47
  48 ```bash
  49 echo "src mraa-upm http://iotdk.intel.com/repos/1.1/intelgalactic-dev" > /etc/opkg/mraa-upm.conf
  50 opkg update
  51 opkg install libmraa0
  52 ```
  53
  54 You can also install just the node.js mraa module by using npm. You will need a
  55 C++ compiler and the node development headers, however it's not required to
  56 have SWIG installed.
  57
  58 ```bash
  59 npm install mraa
  60 ```
  61
  62 Compiling
  63 =========
  64
  65 See documentation on [building](../master/docs/building.md)
  66
  67 Examples
  68 ========
  69
  70 See the [examples](../../tree/master/examples) available for various languages
  71
  72 Debugging
  73 =========
  74
  75 Sometimes it just doesn't want to work, let us try and help you, you can file
  76 issues in github or join us in #mraa on freenode IRC, hang around for a little
  77 while because we're not necessarily on 24/7, but we'll get back to you! Have a
  78 glance at our [debugging](../master/docs/debugging.md) page too.
  79
  80 C/C++ API Documentation
  81 ===========
  82
  83 The C/C++ documentation is available [here](http://iotdk.intel.com/docs/master/mraa/)
  84
  85 Python API Documentation
  86 ===========
  87
  88 The Python documentation is available [here](http://iotdk.intel.com/docs/master/mraa/python)
  89
  90 NodeJS API documentation
  91 ===========
  92
  93 There is no explicit nodejs API documentation, see the examples. The API itself
  94 is very similar to the python one but with a js syntax. If you know of an
  95 autodoc tool for generating nodejs APIs from a native C++ nodejs extension
  96 please get in touch!