README

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