docs/index.md

   1 MRAA - 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 names/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 libmraa 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 mraa::Gpio "Gpio class" |
  22 | @ref i2c.h "i2c"       | @ref mraa::I2c "I2c class"   |
  23 | @ref aio.h "aio"       | @ref mraa::Aio "Aio class"   |
  24 | @ref pwm.h "pwm"       | @ref mraa::Pwm "Pwm class"   |
  25 | @ref spi.h "spi"       | @ref mraa::Spi "Spi class"   |
  26 | @ref common.h "common" | @ref common.hpp "common"     |
  27 </center>
  28
  29 ### Hello Mraa
  30 @snippet hellomraa.c Interesting
  31
  32 ## Supported platforms
  33
  34 Specific platform information for supported platforms is documented here:
  35
  36 - @ref galileorevd
  37 - @ref galileorevh
  38
  39 ### ENV RECOMENDATIONS
  40
  41 All of these are 'optional', however they are recommended. Only a C compiler,
  42 cmake, libm and pthreads are technically required to compile.
  43
  44 - Swig 3.0.1+ built with node.js & python support (0.10.x)
  45 - doxygen
  46 - sphinx (requires doxygen)
  47 - pygments
  48
  49 ## COMPILING
  50
  51 More information on compiling is @ref building page
  52
  53 ## CONTRIBUTING
  54
  55 Please see the @ref contributing page
  56
  57 ## API Changelog
  58
  59 This changelog is meant as a quick & rough guide to what has changed between
  60 versions. The API is now fairly stable but when new calls/features are added
  61 they are listed here. Anything pre 0.2.x is ignored.
  62
  63 **0.4.3**
  64   * SPI Mode function now functional, API Change in SPI
  65   * I2C read in swig worked on.
  66   * Galileo Gen 2: PWM setting period sets all channel's period
  67   * Galileo Gen 2: I2C setup now specific to Gen 2.
  68   * General commits around freeing memory at the right times.
  69
  70 **0.4.2**
  71   * Barebone UART module added.
  72   * Hook branch merged.
  73   * I2C init hooks added.
  74   * Intel Galileo Gen 2, I2C gpio pins now go hiz input when I2C initialised.
  75
  76 **0.4.1**
  77   * Rename python & nodejs modules to mraa
  78   * common.hpp introduced for C++
  79   * python & nodejs modules can now take binary strings for Spi & I2c
  80   * improved Aio module and clear bitness
  81   * Improved Galileo Gen 2 support
  82
  83 **0.4.0**
  84   * Rename to mraa
  85   * get_platform_type function added.
  86
  87 **0.3.1**
  88   * Initial Intel Galileo Gen 2 support
  89   * mraa_gpio_isr parameters added.
  90   * Detection of different supported platforms added.
  91
  92 **0.3.0**
  93   * mraa_i2c_read now returns length of read
  94
  95 **0.2.9**
  96   * Add global mraa.h & mraa.hpp headers
  97   * usage of "gpio.h" is not legal you need to use "mraa/gpio.h" unless adding
  98     -L/usr/include/mraa
  99
 100 **0.2.8**
 101   * Added mraa_set_priority call
 102   * Added mmap gpio call mraa_gpio_use_mmaped
 103
 104 **0.2.7**
 105   * C++ API now uses basic types and not unistd types as C
 106   * Clearer and consistent use of unistd tpyes in C api
 107
 108 **0.2.6**
 109   * C++ examples added, using c++ headers/api.
 110   * moved to open instead of fopen in all modules
 111   * rename mraa_check functions and made them internal to mraa only.
 112   * removed "export" functions from api
 113   * Intel Galileo Gen 1 (rev d) fixes, incorrect definition of some items
 114   * SPI, implementation completed.
 115   * I2C internal function, completed.
 116   * PWM fix bug in period set method.
 117   * Swig upstream can be used for building.
 118   * No longer builds docs on default cmake, needs flag
 119   * GPIO/PWM ownership guard prevents closing on existing pins, still can be forced.
 120
 121 **0.2.5**
 122   * C++/Python/Node Enums/const names now do not contain MRAA_GPIO
 123   * Enum type declaration for C++ changed
 124   * Python/Node get_version() -> GetVersion()
 125   * i2c read calls don't use const char* and i2c write calls do
 126
 127 **0.2.4**
 128   * All mraa_ contexts now are pointers to the actual struct which is not
 129     delcared in the header. The only end user change is that instead of
 130     returning a type mraa_gpio_context pointer mraa_gpio_init() now returns a
 131     mraa_gpio_context (which is actually a pointer to struct _gpio internally).
 132   * C++ API is available, use the .hpp headers and add stdc++  to the linker
 133     flags.
 134   * Initial SPI implementation is provided
 135
 136 **0.2.3**
 137   * mraa_aio_read_u16() -> mraa_aio_read()
 138   * mraa_aio_read() now returns a uint16_t instead of an unsigned int
 139
 140 **0.2.2**
 141   * First version with API considered 'stable'