docs/index.md

   1 libmraa - Low Level Skeleton Library for Communication on Intel platforms
   2 ==============
   3
   4 Libmraa is a C/C++ library with bindings to javascript & python to interface
   5 with the IO on Galileo, Edison & other platforms, with a structured and sane
   6 API where port names/numbering matches the board that you are on. Use of
   7 libmraa does not tie you to specific hardware with board detection done at
   8 runtime you can create portable code that will work across the supported
   9 platforms.
  10
  11 The intent is to make it easier for developers and sensor manufacturers to map
  12 their sensors & actuators on top of supported hardware and to allow control of
  13 low level communication protocol by high level languages & constructs.
  14
  15 ## API
  16
  17 These interfaces allow you to interact with all libmraa functionality. The C++
  18 classes directly wrap the C API and provide a near 1:1 mapping of
  19 functionality.
  20
  21 <center>
  22 | C API Modules          | C++ API Classes              |
  23 |:----------------------:|:----------------------------:|
  24 | @ref gpio.h "gpio"     | @ref mraa::Gpio "Gpio class" |
  25 | @ref i2c.h "i2c"       | @ref mraa::I2c "I2c class"   |
  26 | @ref aio.h "aio"       | @ref mraa::Aio "Aio class"   |
  27 | @ref pwm.h "pwm"       | @ref mraa::Pwm "Pwm class"   |
  28 | @ref spi.h "spi"       | @ref mraa::Spi "Spi class"   |
  29 | @ref uart.h "uart"     | @ref mraa::Uart "Uart class" |
  30 | @ref common.h "common" | @ref mraa "common"           |
  31 </center>
  32
  33 ### Hello Mraa
  34 @snippet hellomraa.c Interesting
  35
  36 ## Supported platforms
  37
  38 Specific platform information for supported platforms is documented here:
  39
  40 - @ref galileorevd
  41 - @ref galileorevh
  42 - @ref edison
  43 - @ref de3815
  44 - @ref minnowmax
  45
  46 ### ENV RECOMENDATIONS
  47
  48 All of these are 'optional', however they are recommended. Only a C compiler,
  49 cmake, libm and pthreads are technically required to compile.
  50
  51 - Swig 3.0.1+ built with node.js (0.10.x) & python support
  52 - doxygen
  53 - sphinx (requires doxygen)
  54 - pygments
  55
  56 ## COMPILING
  57
  58 More information on compiling is @ref building page.
  59
  60 ## CONTRIBUTING
  61
  62 Please see the @ref contributing page, the @ref internals page may also be of
  63 use.
  64
  65 ## API Changelog
  66
  67 This changelog is meant as a quick & rough guide to what has changed between
  68 versions. The API is now fairly stable but when new calls/features are added
  69 they are listed here. Anything pre 0.2.x is ignored.
  70
  71 **0.5.4**
  72   * pwm read_* fix introduced in 0.5.3
  73   * improved npmpkg support
  74
  75 **0.5.3**
  76   * OE toolchain support added to CMake
  77   * Various UART fixes
  78   * SPI add CS exposure
  79   * Remove functions from mraa.c into modules
  80   * Rework of support for mmap
  81   * Intel Edison MMAP support added. Read and Write
  82   * I2C clean up, add cleaner functions
  83   * MinnowBoard Max support added
  84   * PWM period is written before duty
  85   * Node GYP build supported added
  86   * Add Get Platform Name function
  87
  88 **0.5.2**
  89   * pwm improvement & bugfix
  90   * spi mraa_spi_bit_per_word fix
  91   * new spi transfer function
  92   * i2c object api uses uint8_t
  93   * i2c readReg() calls added
  94   * edison i2c bus now defaults to a sensible value
  95   * edison uart enable support
  96   * edison hardware CS exposed as IO10
  97   * DE3815tykhe NUC support
  98
  99 **0.5.1**
 100   * Intel Edison - Mini breakout board support
 101   * Change to use syslog throughout instead of printing to stderr.
 102   * Fix misc issues brought up throuh coverity scans
 103   * Clear up Analog call documentation
 104
 105 **0.5.0**
 106   * Intel Edison - Arduino board support.
 107   * Boost Allowable i2c busses to 12
 108   * Additional platform hooks added
 109   * ADC is now 10bits by default on all platforms but can be changed
 110
 111 **0.4.5**
 112   * if only one spidev we default to it reguardless of number
 113   * mraa_pwm_config_ms & mraa_pwm_config_percent functions added
 114   * Uart C++ class added, adds python & node support
 115   * galileo gen2 gpio modes supported
 116
 117 **0.4.4**
 118   * prefix SPI mode with MRAA_SPI_
 119   * added C++ adc bitness calls
 120
 121 **0.4.3**
 122   * SPI Mode function now functional, API Change in SPI
 123   * I2C read in swig worked on.
 124   * Galileo Gen 2: PWM setting period sets all channel's period
 125   * Galileo Gen 2: I2C setup now specific to Gen 2.
 126   * General commits around freeing memory at the right times.
 127
 128 **0.4.2**
 129   * Barebone UART module added.
 130   * Hook branch merged.
 131   * I2C init hooks added.
 132   * Intel Galileo Gen 2, I2C gpio pins now go hiz input when I2C initialised.
 133
 134 **0.4.1**
 135   * Rename python & nodejs modules to mraa
 136   * common.hpp introduced for C++
 137   * python & nodejs modules can now take binary strings for Spi & I2c
 138   * improved Aio module and clear bitness
 139   * Improved Galileo Gen 2 support
 140
 141 **0.4.0**
 142   * Rename to mraa
 143   * get_platform_type function added.
 144
 145 **0.3.1**
 146   * Initial Intel Galileo Gen 2 support
 147   * mraa_gpio_isr parameters added.
 148   * Detection of different supported platforms added.
 149
 150 **0.3.0**
 151   * mraa_i2c_read now returns length of read
 152
 153 **0.2.9**
 154   * Add global mraa.h & mraa.hpp headers
 155   * usage of "gpio.h" is not legal you need to use "mraa/gpio.h" unless adding
 156     -L/usr/include/mraa
 157
 158 **0.2.8**
 159   * Added mraa_set_priority call
 160   * Added mmap gpio call mraa_gpio_use_mmaped
 161
 162 **0.2.7**
 163   * C++ API now uses basic types and not unistd types as C
 164   * Clearer and consistent use of unistd tpyes in C api
 165
 166 **0.2.6**
 167   * C++ examples added, using c++ headers/api.
 168   * moved to open instead of fopen in all modules
 169   * rename mraa_check functions and made them internal to mraa only.
 170   * removed "export" functions from api
 171   * Intel Galileo Gen 1 (rev d) fixes, incorrect definition of some items
 172   * SPI, implementation completed.
 173   * I2C internal function, completed.
 174   * PWM fix bug in period set method.
 175   * Swig upstream can be used for building.
 176   * No longer builds docs on default cmake, needs flag
 177   * GPIO/PWM ownership guard prevents closing on existing pins, still can be forced.
 178
 179 **0.2.5**
 180   * C++/Python/Node Enums/const names now do not contain MRAA_GPIO
 181   * Enum type declaration for C++ changed
 182   * Python/Node get_version() -> GetVersion()
 183   * i2c read calls don't use const char* and i2c write calls do
 184
 185 **0.2.4**
 186   * All mraa_ contexts now are pointers to the actual struct which is not
 187     delcared in the header. The only end user change is that instead of
 188     returning a type mraa_gpio_context pointer mraa_gpio_init() now returns a
 189     mraa_gpio_context (which is actually a pointer to struct _gpio internally).
 190   * C++ API is available, use the .hpp headers and add stdc++  to the linker
 191     flags.
 192   * Initial SPI implementation is provided
 193
 194 **0.2.3**
 195   * mraa_aio_read_u16() -> mraa_aio_read()
 196   * mraa_aio_read() now returns a uint16_t instead of an unsigned int
 197
 198 **0.2.2**
 199   * First version with API considered 'stable'