0093dc3f0d
Signed-off-by: Michael Ring <mail@michael-ring.org> Signed-off-by: Brendan Le Foll <brendan.le.foll@intel.com>
97 lines
3.0 KiB
Markdown
97 lines
3.0 KiB
Markdown
libmraa - Low Level Skeleton Library for Communication on GNU/Linux platforms
|
|
==============
|
|
|
|
Libmraa is a C/C++ library with bindings to javascript & python to interface
|
|
with the IO on Galileo, Edison & other platforms, with a structured and sane
|
|
API where port names/numbering matches the board that you are on. Use of
|
|
libmraa does not tie you to specific hardware with board detection done at
|
|
runtime you can create portable code that will work across the supported
|
|
platforms.
|
|
|
|
The intent is to make it easier for developers and sensor manufacturers to map
|
|
their sensors & actuators on top of supported hardware and to allow control of
|
|
low level communication protocol by high level languages & constructs.
|
|
|
|
Supported Boards
|
|
================
|
|
|
|
X86
|
|
---
|
|
* [Galileo Gen 1 - Rev D](../master/docs/galileorevd.md)
|
|
* [Galileo Gen 2 - Rev H](../master/docs/galileorevh.md)
|
|
* [Edison](../master/docs/edison.md)
|
|
* [Intel DE3815](../master/docs/intel_de3815.md)
|
|
* [Minnowboard Max](../master/docs/minnow_max.md)
|
|
|
|
ARM
|
|
---
|
|
* [Raspberry Pi](../master/docs/raspberry_pi.md)
|
|
* [Bannana Pi](../master/docs/banana_pi.md)
|
|
* [Beaglebone Black](../master/docs/beaglebone.md)
|
|
|
|
Installing on your board
|
|
========
|
|
|
|
See the section below on compiling or use our repository to install on an
|
|
eglibc based yocto poky image that supports opkg. Adding this repository is as
|
|
simple as and you'll have the latest stable tagged build of mraa installed!
|
|
|
|
``` bash
|
|
echo "src mraa-upm http://iotdk.intel.com/repos/1.1/intelgalactic" > /etc/opkg/mraa-upm.conf
|
|
opkg update
|
|
opkg install libmraa0
|
|
```
|
|
|
|
If you would like to get the latest & greatest builds from master HEAD you can
|
|
use our -dev repository
|
|
|
|
```bash
|
|
echo "src mraa-upm http://iotdk.intel.com/repos/1.1/intelgalactic-dev" > /etc/opkg/mraa-upm.conf
|
|
opkg update
|
|
opkg install libmraa0
|
|
```
|
|
|
|
You can also install just the node.js mraa module by using npm. You will need a
|
|
C++ compiler and the node development headers, however it's not required to
|
|
have SWIG installed.
|
|
|
|
```bash
|
|
npm install mraa
|
|
```
|
|
|
|
Compiling
|
|
=========
|
|
|
|
See documentation on [building](../master/docs/building.md)
|
|
|
|
Examples
|
|
========
|
|
|
|
See the [examples](../../tree/master/examples) available for various languages
|
|
|
|
Debugging
|
|
=========
|
|
|
|
Sometimes it just doesn't want to work, let us try and help you, you can file
|
|
issues in github or join us in #mraa on freenode IRC, hang around for a little
|
|
while because we're not necessarily on 24/7, but we'll get back to you! Have a
|
|
glance at our [debugging](../master/docs/debugging.md) page too.
|
|
|
|
C/C++ API Documentation
|
|
===========
|
|
|
|
The C/C++ documentation is available [here](http://iotdk.intel.com/docs/master/mraa/)
|
|
|
|
Python API Documentation
|
|
===========
|
|
|
|
The Python documentation is available [here](http://iotdk.intel.com/docs/master/mraa/python)
|
|
|
|
NodeJS API documentation
|
|
===========
|
|
|
|
There is no explicit nodejs API documentation, see the examples. The API itself
|
|
is very similar to the python one but with a js syntax. If you know of an
|
|
autodoc tool for generating nodejs APIs from a native C++ nodejs extension
|
|
please get in touch!
|