Merge branch 'pwm' into for-pull
[contrib/mraa.git] / README
1 MAA - Low Level Skeleton Library for Communication on Intel platforms
2
3 Library for C/C++ to interface with Galileo & other Intel platforms over:
4
5 - I2C
6 - SPI
7 - GPIO
8 - PWM
9
10 In a structured and sane API with port nanmes/numbering that match boards.
11
12 The intent is to make it easier for developers and sensor manufacturers to map
13 their sensors & actuators on top of Intel hardware.
14
15 === ENV REQUIREMENTS ===
16
17 node.js 0.10.26
18 python 3.3.5
19 swig-v8 3.0.1 (if you want node.js to work you need to use swig-v8)
20 I'm using f31c1dce7a45c4b8ed7e6ff845f4c74539e056f1 from
21 http://github.com:oliver----/swig-v8
22
23 === COMPILING ===
24
25 if swig-v8 is not in your default path you can try run cmake with
26 "-DCMAKE_PREFIX_PATH="/path/to/swig-v8"
27
28 mkdir build/
29 cmake ..
30 make
31
32 Install is currently unsuported. Javascript and python modules will be in
33 build/src/{javascript, python}
34
35 === DEVELOPMENT ===
36
37 Unit tests for all features must be completed prior to implementations, please
38 run `ctest -V` from the build dir in order to see current implementation status
39
40 === USING ===
41
42 see examples/
43
44 for node.js make sure that maajs.node is in the current dir and set export
45 NODE_PATH=.
46
47 python2/3 should both work, although testing is done on python3 exclusively.
48 Node.js bindings may be dodgy, I'm so far unclear of how good swig-v8 is.