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