1libmraa - Low Level Skeleton Library for Communication on GNU/Linux platforms
2==============
3
4Libmraa is a C/C++ library with bindings to javascript & python to interface
5with the IO on Galileo, Edison & other platforms, with a structured and sane
6API where port names/numbering matches the board that you are on. Use of
7libmraa does not tie you to specific hardware with board detection done at
8runtime you can create portable code that will work across the supported
9platforms.
10
11The intent is to make it easier for developers and sensor manufacturers to map
12their sensors & actuators on top of supported hardware and to allow control of
13low level communication protocol by high level languages & constructs.
14
15Supported Boards
16================
17
18X86
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
27ARM
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
33USB
34---
35* [FT4222](../master/docs/ftdi_ft4222.md)
36
37Installing on your board
38========
39
40See the section below on compiling or use our repository to install on a glibc
41based yocto poky image that supports opkg. Adding this repository is as simple
42as and you'll have the latest stable tagged build of mraa installed!
43
44``` bash
45echo "src mraa-upm http://iotdk.intel.com/repos/2.0/intelgalactic" > /etc/opkg/mraa-upm.conf
46opkg update
47opkg install mraa
48```
49
50If you would like to get the latest & greatest builds from master HEAD you can
51use our -dev repository
52
53```bash
54echo "src mraa-upm http://iotdk.intel.com/repos/2.0/intelgalactic-dev" > /etc/opkg/mraa-upm.conf
55opkg update
56opkg install mraa
57```
58
59You can also install just the node.js mraa module by using npm. You will need a
60C++ compiler and the node development headers, however it's not required to
61have SWIG installed.
62
63```bash
64npm install mraa
65```
66
67Compiling
68=========
69
70See documentation on [building](../master/docs/building.md)
71
72Examples
73========
74
75See the [examples](../../tree/master/examples) available for various languages
76
77Debugging
78=========
79
80Sometimes it just doesn't want to work, let us try and help you, you can file
81issues in github or join us in #mraa on freenode IRC, hang around for a little
82while because we're not necessarily on 24/7, but we'll get back to you! Have a
83glance at our [debugging](../master/docs/debugging.md) page too.
84
85API Documentation
86=================
87
88<a href="http://c.mraa.io"><img src="http://iotdk.intel.com/misc/logos/c++.png"/></a>
89<a href="http://java.mraa.io"><img src="http://iotdk.intel.com/misc/logos/java.png"/></a>
90<a href="http://py.mraa.io"><img src="http://iotdk.intel.com/misc/logos/python.png"/></a>
91<a href="http://js.mraa.io"><img src="http://iotdk.intel.com/misc/logos/node.png"/></a>
92
93Changelog
94=========
95
96Version changelog [here](docs/changelog.md).
97