docs/index.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 ## Supported platforms
  33
  34 Specific platform information for supported platforms is documented here:
  35
  36 - @ref galileorevd
  37
  38 ### ENV RECOMENDATIONS
  39
  40 All of these are 'optional', however they are recommended. Only a C compiler,
  41 cmake, libm and pthreads are technically required to compile.
  42
  43 - Swig 3.0.1+ built with node.js & python support (0.10.x)
  44 - doxygen
  45 - sphinx (requires doxygen)
  46 - pygments
  47
  48 ## COMPILING
  49
  50 More information on compiling is @ref building page
  51
  52 ## CONTRIBUTING
  53
  54 Please see the @ref contributing page
  55
  56 ## API Changelog
  57
  58 This changelog is meant as a quick & rough guide to what has changed between
  59 versions. The API is now fairly stable but when new calls/features are added
  60 they are listed here. Anything pre 0.2.x is ignored.
  61
  62 **0.2.9**
  63   * Add global maa.h & maa.hpp headers
  64   * usage of "gpio.h" is not legal you need to use "maa/gpio.h" unless adding
  65     -L/usr/include/maa
  66
  67 **0.2.8**
  68   * Added maa_set_priority call
  69   * Added mmap gpio call maa_gpio_use_mmaped
  70
  71 **0.2.7**
  72   * C++ API now uses basic types and not unistd types as C
  73   * Clearer and consistent use of unistd tpyes in C api
  74
  75 **0.2.6**
  76   * C++ examples added, using c++ headers/api.
  77   * moved to open instead of fopen in all modules
  78   * rename maa_check functions and made them internal to maa only.
  79   * removed "export" functions from api
  80   * Intel Galileo Gen 1 (rev d) fixes, incorrect definition of some items
  81   * SPI, implementation completed.
  82   * I2C internal function, completed.
  83   * PWM fix bug in period set method.
  84   * Swig upstream can be used for building.
  85   * No longer builds docs on default cmake, needs flag
  86   * GPIO/PWM ownership guard prevents closing on existing pins, still can be forced.
  87
  88 **0.2.5**
  89   * C++/Python/Node Enums/const names now do not contain MAA_GPIO
  90   * Enum type declaration for C++ changed
  91   * Python/Node get_version() -> GetVersion()
  92   * i2c read calls don't use const char* and i2c write calls do
  93
  94 **0.2.4**
  95   * All maa_ contexts now are pointers to the actual struct which is not
  96     delcared in the header. The only end user change is that instead of
  97     returning a type maa_gpio_context pointer maa_gpio_init() now returns a
  98     maa_gpio_context (which is actually a pointer to struct _gpio internally).
  99   * C++ API is available, use the .hpp headers and add stdc++  to the linker
 100     flags.
 101   * Initial SPI implementation is provided
 102
 103 **0.2.3**
 104   * maa_aio_read_u16() -> maa_aio_read()
 105   * maa_aio_read() now returns a uint16_t instead of an unsigned int
 106
 107 **0.2.2**
 108   * First version with API considered 'stable'