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