Permalink
Fetching contributors…
Cannot retrieve contributors at this time
178 lines (133 sloc) 5.5 KB

libmraa - Low Level Skeleton Library for Communication on GNU/Linux platforms

Libmraa is a C/C++ library with bindings to Java, Python and JavaScript 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.

Build Status Quality Gate

Supported Boards

X86

ARM

MIPS

FPGA

USB

I2C

Mock

JSON platform

Installing on your board

Installing on Ubuntu

Here is a PPA for installing on Ubuntu Xenial or Bionic: https://launchpad.net/~mraa/+archive/ubuntu/mraa

sudo add-apt-repository ppa:mraa/mraa
sudo apt-get update
sudo apt-get install libmraa2 libmraa-dev libmraa-java python-mraa python3-mraa node-mraa mraa-tools

Running MRAA tools or applications on Ubuntu systems requires elevated permissions (e.g. run with sudo).

Install on Arch Linux

There is an AUR package for mraa here: https://aur.archlinux.org/packages/mraa

Install on openSUSE

REPO="openSUSE_Tumbleweed"
if test "$(arch)" == "aarch64"; then
  REPO="openSUSE_Factory_ARM"
fi
sudo zypper ar http://download.opensuse.org/repositories/hardware/$REPO/hardware.repo
sudo zypper in mraa

Install on Fedora Linux

There is an mraa package in the main Fedora repository so it can be dnf installed in all recent Fedora releases. The Node.js and Python 3 bindings are packaged as separate packages.

sudo dnf install mraa nodejs-mraa python3-mraa

Installing for Node.js only

Note: Node.js 7.0.0+ is not currently supported unless compiling with a patched vesion of SWIG. See the corresponding section and document below.

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. This works for node versions 6.x.x and prior.

npm install mraa

Note that installing mraa in this way builds mraa without json-c so you cannot use mraa_init_json_platform(). Also building this way means the mraa.node includes a static version of libmraa rather than relying on a dynamic library in /usr/lib.

Subplatforms (i.e. Firmata) have to be added manually with this kind of install from your application, as shown in this example.

Compiling

See documentation on building

Examples

See the 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 page too.

API Documentation

Contact Us

To ask questions either file issues in github or send emails on our mailing list. You might also catch us on the mraa channel on freenode IRC.

See the Contribution documentation for more details.

Changelog

Version changelog here.