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 All of these are 'optional', however they are recommended. Only a C compiler,
  22 cmake and default system libraries are technically required to compile.
  23
  24 1. node.js 0.10.26
  25 2. python 3.3.x or 2.7.x
  26 3. swig-v8 3.0.1 (swig 2.x will work but you will not be able to build node.js
  27 module so comment out add_directories(javacsript) in src/CmakeLists.txt)
  28 4. doxygen (needed to generate even python doc)
  29 5. sphinx
  30 6. pydoc
  31
  32 To install swig-v8 the swig-v8-git package from AUR is helpful.
  33
  34 ## COMPILING
  35
  36 NOTE: The **only** supported cmake build configuration is to have the build/ dir
  37 inside of the repo/tarball.
  38
  39 *if swig-v8 is not in your default path you can try run cmake with
  40 "-DCMAKE_PREFIX_PATH="/path/to/swig-v8"*
  41
  42 mkdir build/
  43 cmake ..
  44 make
  45
  46 ## DEVELOPMENT
  47
  48 Please fork the code on github and then send pull requests. Please avoid merges
  49 in your forks. I will also accept patches sent in git style with signoffs to
  50 brendan.le.foll@intel.com
  51
  52 ## USING
  53
  54 see examples/
  55
  56 *for node.js make sure that maajs.node is in the current dir and set export
  57 NODE_PATH=.*
  58
  59 Simple python html documentation can be generated with **make pydoc**, this
  60 does not require the full doxygen/sphinx setup.
  61
  62 ## API Changelog
  63
  64 When the API breaks in a small way there will be a changelog listed here
  65
  66 **0.2.5**
  67   * C++/Python/Node Enums/const names now do not contain MAA_GPIO
  68   * Enum type declaration for C++ changed
  69   * Python/Node get_version() -> GetVersion()
  70   * i2c read calls don't use const char* and i2c write calls do
  71
  72 **0.2.4**
  73   * All maa_ contexts now are pointers to the actual struct which is not
  74     delcared in the header. The only end user change is that instead of
  75     returning a type maa_gpio_context pointer maa_gpio_init() now returns a
  76     maa_gpio_context (which is actually a pointer to struct _gpio internally).
  77   * C++ API is available, use the .hpp headers and add stdc++  to the linker
  78     flags.
  79   * Initial SPI implementation is provided
  80
  81 **0.2.3**
  82   * maa_aio_read_u16() -> maa_aio_read()
  83   * maa_aio_read() now returns a uint16_t instead of an unsigned int
  84
  85 **0.2.2**
  86   * First version with API considered 'stable'