docs/index.md

   1 libmraa - Low Level Skeleton Library for Communication on GNU/Linux 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 - @ref rasppi
  46 - @ref bananapi
  47 - @ref beaglebone
  48
  49 ## DEBUGGING
  50
  51 Sometimes it just doesn't want to work, let us try and help you, you can file
  52 issues in github or join us in #mraa on freenode IRC, hang around for a little
  53 while because we're not necessarily on 24/7, but we'll get back to you! Have a
  54 glance at our @debugging page too
  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.7.1**
  72   * Uart now uses binary arrays and has optional 'Str' functions in C++/SWIG
  73   * Various Uart module bugfixes
  74   * Node.js 0.12.4 support
  75   * Node.js documentation support
  76
  77 **0.7.0**
  78   * Uart module now contains read/write interactions and configuration
  79   * Python API contains more buffer checks
  80   * Java support
  81   * RPM cpack support
  82
  83 **0.6.2**
  84   * Node.js 0.12 support
  85   * NPM support
  86   * Formatting done with clang-format
  87   * Various examples and documentation updates
  88   * Supported added for Beaglebone Black + Banana Pi
  89
  90 **0.6.1**
  91   * 16bit spi iunctions added
  92   * Node.js ISR now supported
  93
  94 **0.6.0**
  95   * add device path queries for uart
  96   * add platform configuration querying
  97   * gpio sample added
  98   * improve i2c/spi write/read API for python & nodejs
  99   * performance improvements on edison & galileo
 100
 101 **0.5.4**
 102   * pwm read_* fix introduced in 0.5.3
 103   * improved npmpkg support
 104
 105 **0.5.3**
 106   * OE toolchain support added to CMake
 107   * Various UART fixes
 108   * SPI add CS exposure
 109   * Remove functions from mraa.c into modules
 110   * Rework of support for mmap
 111   * Intel Edison MMAP support added. Read and Write
 112   * I2C clean up, add cleaner functions
 113   * MinnowBoard Max support added
 114   * PWM period is written before duty
 115   * Node GYP build supported added
 116   * Add Get Platform Name function
 117
 118 **0.5.2**
 119   * pwm improvement & bugfix
 120   * spi mraa_spi_bit_per_word fix
 121   * new spi transfer function
 122   * i2c object api uses uint8_t
 123   * i2c readReg() calls added
 124   * edison i2c bus now defaults to a sensible value
 125   * edison uart enable support
 126   * edison hardware CS exposed as IO10
 127   * DE3815tykhe NUC support
 128
 129 **0.5.1**
 130   * Intel Edison - Mini breakout board support
 131   * Change to use syslog throughout instead of printing to stderr.
 132   * Fix misc issues brought up throuh coverity scans
 133   * Clear up Analog call documentation
 134
 135 **0.5.0**
 136   * Intel Edison - Arduino board support.
 137   * Boost Allowable i2c busses to 12
 138   * Additional platform hooks added
 139   * ADC is now 10bits by default on all platforms but can be changed
 140
 141 **0.4.5**
 142   * if only one spidev we default to it reguardless of number
 143   * mraa_pwm_config_ms & mraa_pwm_config_percent functions added
 144   * Uart C++ class added, adds python & node support
 145   * galileo gen2 gpio modes supported
 146
 147 **0.4.4**
 148   * prefix SPI mode with MRAA_SPI_
 149   * added C++ adc bitness calls
 150
 151 **0.4.3**
 152   * SPI Mode function now functional, API Change in SPI
 153   * I2C read in swig worked on.
 154   * Galileo Gen 2: PWM setting period sets all channel's period
 155   * Galileo Gen 2: I2C setup now specific to Gen 2.
 156   * General commits around freeing memory at the right times.
 157
 158 **0.4.2**
 159   * Barebone UART module added.
 160   * Hook branch merged.
 161   * I2C init hooks added.
 162   * Intel Galileo Gen 2, I2C gpio pins now go hiz input when I2C initialised.
 163
 164 **0.4.1**
 165   * Rename python & nodejs modules to mraa
 166   * common.hpp introduced for C++
 167   * python & nodejs modules can now take binary strings for Spi & I2c
 168   * improved Aio module and clear bitness
 169   * Improved Galileo Gen 2 support
 170
 171 **0.4.0**
 172   * Rename to mraa
 173   * get_platform_type function added.
 174
 175 **0.3.1**
 176   * Initial Intel Galileo Gen 2 support
 177   * mraa_gpio_isr parameters added.
 178   * Detection of different supported platforms added.
 179
 180 **0.3.0**
 181   * mraa_i2c_read now returns length of read
 182
 183 **0.2.9**
 184   * Add global mraa.h & mraa.hpp headers
 185   * usage of "gpio.h" is not legal you need to use "mraa/gpio.h" unless adding
 186     -L/usr/include/mraa
 187
 188 **0.2.8**
 189   * Added mraa_set_priority call
 190   * Added mmap gpio call mraa_gpio_use_mmaped
 191
 192 **0.2.7**
 193   * C++ API now uses basic types and not unistd types as C
 194   * Clearer and consistent use of unistd tpyes in C api
 195
 196 **0.2.6**
 197   * C++ examples added, using c++ headers/api.
 198   * moved to open instead of fopen in all modules
 199   * rename mraa_check functions and made them internal to mraa only.
 200   * removed "export" functions from api
 201   * Intel Galileo Gen 1 (rev d) fixes, incorrect definition of some items
 202   * SPI, implementation completed.
 203   * I2C internal function, completed.
 204   * PWM fix bug in period set method.
 205   * Swig upstream can be used for building.
 206   * No longer builds docs on default cmake, needs flag
 207   * GPIO/PWM ownership guard prevents closing on existing pins, still can be forced.
 208
 209 **0.2.5**
 210   * C++/Python/Node Enums/const names now do not contain MRAA_GPIO
 211   * Enum type declaration for C++ changed
 212   * Python/Node get_version() -> GetVersion()
 213   * i2c read calls don't use const char* and i2c write calls do
 214
 215 **0.2.4**
 216   * All mraa_ contexts now are pointers to the actual struct which is not
 217     delcared in the header. The only end user change is that instead of
 218     returning a type mraa_gpio_context pointer mraa_gpio_init() now returns a
 219     mraa_gpio_context (which is actually a pointer to struct _gpio internally).
 220   * C++ API is available, use the .hpp headers and add stdc++  to the linker
 221     flags.
 222   * Initial SPI implementation is provided
 223
 224 **0.2.3**
 225   * mraa_aio_read_u16() -> mraa_aio_read()
 226   * mraa_aio_read() now returns a uint16_t instead of an unsigned int
 227
 228 **0.2.2**
 229   * First version with API considered 'stable'