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, in a
   5 structured and sane API with port nanmes/numbering that match boards & with
   6 bindings to javascript & python.
   7
   8 The intent is to make it easier for developers and sensor manufacturers to map
   9 their sensors & actuators on top of supported hardware and to allow control of
  10 low level communication protocol by high level languages & constructs.
  11
  12 ## API
  13
  14 These interfaces allow you to interact with all libmaa functionality. The C++
  15 classes directly wrap the C API and provide a near 1:1 mapping of
  16 functionality.
  17
  18 <center>
  19 C API Modules        | C++ API Classes
  20 :-------------------:|:-------------------:
  21  @ref gpio.h "gpio"  | @ref maa::Gpio "Gpio class"
  22  @ref i2c.h "i2c"    | @ref maa::I2c "I2c class"
  23  @ref aio.h "aio"    | @ref maa::Aio "Aio class"
  24  @ref pwm.h "pwm"    | @ref maa::Pwm "Pwm class"
  25  @ref spi.h "spi"    | @ref maa::Spi "Spi class"
  26  @ref maa.h "maa"    | @ref maa.h "maa"
  27 </center>
  28
  29 ### Hello Maa
  30 @snippet hellomaa.c Interesting
  31
  32 ### Basic GPIO
  33 @snippet gpio_read6.c Interesting
  34
  35 ### Basic PWM
  36 @snippet cycle-pwm3.c Interesting
  37
  38 ### Basic I2C
  39 @snippet analogin_a0.c Interesting
  40
  41 ### Basic AIO
  42 @snippet analogin_a0.c Interesting
  43
  44 ### Basic SPI
  45 @snippet spi_mcp4261.c Interesting
  46
  47 ## Supported platforms
  48
  49 - Galileo (Fab D)
  50
  51 ### ENV RECOMENDATIONS
  52
  53 All of these are 'optional', however they are recommended. Only a C compiler,
  54 cmake, libm and pthreads are technically required to compile.
  55
  56 - Swig 3.0.1+ built with node.js & python support (0.10.x)
  57 - doxygen
  58 - sphinx (requires doxygen)
  59 - pygments
  60
  61 ## COMPILING
  62
  63 mkdir build/
  64 cmake -i ..
  65 make
  66
  67 ## DEVELOPMENT
  68
  69 Please fork the code on github and then send pull requests. Please avoid merges
  70 in your forks. I will also accept patches sent in git style with signoffs to
  71 brendan.le.foll@intel.com
  72
  73 ## API Changelog
  74
  75 When the API breaks in a small way there will be a changelog listed here
  76
  77 **0.2.7**
  78   * C++ API now uses basic types and not unistd types as C
  79   * Clearer and consistent use of unistd tpyes in C api
  80
  81 **0.2.6**
  82   * C++ examples added, using c++ headers/api.
  83   * moved to open instead of fopen in all modules
  84   * rename maa_check functions and made them internal to maa only.
  85   * removed "export" functions from api
  86   * Intel Galileo Gen 1 (rev d) fixes, incorrect definition of some items
  87   * SPI, implementation completed.
  88   * I2C internal function, completed.
  89   * PWM fix bug in period set method.
  90   * Swig upstream can be used for building.
  91   * No longer builds docs on default cmake, needs flag
  92   * GPIO/PWM ownership guard prevents closing on existing pins, still can be forced.
  93
  94 **0.2.5**
  95   * C++/Python/Node Enums/const names now do not contain MAA_GPIO
  96   * Enum type declaration for C++ changed
  97   * Python/Node get_version() -> GetVersion()
  98   * i2c read calls don't use const char* and i2c write calls do
  99
 100 **0.2.4**
 101   * All maa_ contexts now are pointers to the actual struct which is not
 102     delcared in the header. The only end user change is that instead of
 103     returning a type maa_gpio_context pointer maa_gpio_init() now returns a
 104     maa_gpio_context (which is actually a pointer to struct _gpio internally).
 105   * C++ API is available, use the .hpp headers and add stdc++  to the linker
 106     flags.
 107   * Initial SPI implementation is provided
 108
 109 **0.2.3**
 110   * maa_aio_read_u16() -> maa_aio_read()
 111   * maa_aio_read() now returns a uint16_t instead of an unsigned int
 112
 113 **0.2.2**
 114   * First version with API considered 'stable'