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