2014-10-03 10:18:13 +01:00
|
|
|
libmraa - Low Level Skeleton Library for Communication on GNU/Linux platforms
|
2014-04-28 18:39:07 +01:00
|
|
|
==============
|
2014-04-08 18:43:26 +01:00
|
|
|
|
2014-11-12 13:48:46 +00:00
|
|
|
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.
|
2014-04-08 18:43:26 +01:00
|
|
|
|
|
|
|
|
The intent is to make it easier for developers and sensor manufacturers to map
|
2014-04-25 15:49:19 +01:00
|
|
|
their sensors & actuators on top of supported hardware and to allow control of
|
|
|
|
|
low level communication protocol by high level languages & constructs.
|
2014-04-08 18:52:54 +01:00
|
|
|
|
2014-06-11 14:16:47 +01:00
|
|
|
Supported Boards
|
|
|
|
|
================
|
2014-05-23 14:47:23 +01:00
|
|
|
|
2014-09-01 23:19:24 +01:00
|
|
|
* [Galileo Gen 1 - Rev D](../master/docs/galileorevd.md)
|
|
|
|
|
* [Galileo Gen 2 - Rev H](../master/docs/galileorevh.md)
|
2014-09-09 15:30:36 +01:00
|
|
|
* [Edison](../master/docs/edison.md)
|
2014-10-24 14:23:56 +01:00
|
|
|
* [Intel DE3815](../master/docs/intel_de3815.md)
|
2014-11-20 17:14:48 -08:00
|
|
|
* [Minnowboard Max](../master/docs/minnow_max.md)
|
2014-05-23 14:47:23 +01:00
|
|
|
|
2014-08-14 11:40:34 +01:00
|
|
|
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:
|
|
|
|
|
|
|
|
|
|
``` bash
|
|
|
|
|
echo "src mraa-upm http://iotdk.intel.com/repos/1.1/intelgalactic" > /etc/opkg/mraa-upm.conf
|
|
|
|
|
opkg update
|
2014-09-01 23:19:24 +01:00
|
|
|
opkg install libmraa0
|
2014-08-14 11:40:34 +01:00
|
|
|
```
|
|
|
|
|
|
2014-06-11 14:16:47 +01:00
|
|
|
Compiling
|
|
|
|
|
=========
|
2014-05-23 14:47:23 +01:00
|
|
|
|
2014-08-14 11:27:22 +01:00
|
|
|
See documentation on [building](../master/docs/building.md)
|
2014-05-28 11:00:36 +01:00
|
|
|
|
2014-06-11 14:16:47 +01:00
|
|
|
Examples
|
|
|
|
|
========
|
2014-05-23 14:47:23 +01:00
|
|
|
|
2014-08-14 11:27:22 +01:00
|
|
|
See the [examples](../../tree/master/examples) available for various languages
|
2014-05-29 14:51:38 +01:00
|
|
|
|
2014-08-14 11:27:22 +01:00
|
|
|
C/C++ API Documentation
|
2014-06-11 14:16:47 +01:00
|
|
|
===========
|
2014-05-23 14:47:23 +01:00
|
|
|
|
2014-08-14 11:27:22 +01:00
|
|
|
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!
|
