README.md

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