Low Level Skeleton Library for Communication on GNU/Linux platforms
libmraa uses cmake in order to make compilation relatively painless. CMake runs build out of tree so the recommended way is to clone from git and make a
build/ directory inside the clone directory.
For building imraa check ./imraa.md "building imraa"
Not all these are required but if you're unsure of what you're doing this is what you'll need:
For Debian-like distros the below command installs the basic set:
```bash sudo apt-get install git build-essential swig3.0 python-dev nodejs-dev cmake libjson-c-dev ```
To build the documentation you'll also need:
If this goes wrong and you have all the dependencies installed, then please file an issue with the full output of
cmake .. and
make or however far you got.
After that you can install built files (into default path) by running:
```bash sudo make install ```
See flags for adjusting install paths in the section below.
Currently our install logic puts Python bindings into standard paths, which do not work on Debian due to their policy.
We are working on a permanent solution, in the meantime please use this command after
make install to link installed modules where Debian's Python expects them:
```bash sudo ln -s <your install prefix, e.g. /usr>/lib/python2.7/site-packages/* /usr/lib/python2.7/dist-packages ```
Same approach works for Python 3, you'll just need to adjust the version number in the path accordingly.
Our CMake configuration has a number of options,
cmake -i is no longer with us :() can show you all the options. A few of the more common ones are listed below. Note that when the option starts with
CMAKE_ it's an option that is made available by CMake and will be similar in all CMake projects. You need to add them after
cmake but before
A few recommended options:
Changing install path from
Building debug build - adds
-g and disables optimisations - this will force a full rebuild:
clang instead of
Disabling Python module building:
Building doc, this will require SPHINX & Doxygen:
-DBUILDDOC=ON You will also require clone git submodules from your existing checkout:
git submodule update --init --recursive The from doxygen2jsdoc dir:
npm install mkdirp commander lodash bluebird pegjs
Override build architecture (this is useful because on x86 ARM code is not compiled so use this flag to force the target arch)
You can also enable -Wall for gcc before running cmake by exporting your wanted CC flags to the CC env var
export CC="gcc -Wall"
Sometimes it's nice to build a static libary, on Linux systems just set
During the build, we'll assume you're building from git, note that if you compile with
git installed your version of mraa will be versioned with
git desribe --tag to make it easy for intentification. You can easily modify version.c in build/src. If you don't build from a git tree then you will simply have a version which matches the latest released version of mraa.
In order to compile with a Yocto/OE toolchain use the following toolchain file. This works well on the Edison 1.7.2 SDK. First source the environment file, then use our CMake toolchain file.
This is the procedure to submit a build to Coverity. You'll need to install
coverity-submit for your OS.
Have JAVA_HOME set to JDK install directory. Most distributions set this from
/etc/profile.d/ and have a way of switching between alternatives. We support both OpenJDK and Oracle's JDK. On Arch Linux with OpenJDK 8 you'll have to set this yourself like this:
Then use the CMake configuration flag:
-DBUILDSWIGJAVA=ON To compile
To run, make sure
libmraajava.so is in
If you want to add or improve Java bindings for mraa, please follow the https://github.com/intel-iot-devkit/upm/blob/master/docs/creating_java_bindings.md "Creating Java Bindings Guide".
You can get
cpack to generate an IPK or RPM package fairly easily if you have the correct packaging tools
To use RPM simply enable the RPM option. You'll need
rpmbuild installed on your build machine.