1 libmraa - Low Level Skeleton Library for Communication on GNU/Linux platforms
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
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.
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
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" |
34 @snippet hellomraa.c Interesting
36 ## Supported platforms
38 Specific platform information for supported platforms is documented here:
53 Sometimes it just doesn't want to work, let us try and help you, you can file
54 issues in github or join us in #mraa on freenode IRC, hang around for a little
55 while because we're not necessarily on 24/7, but we'll get back to you! Have a
56 glance at our @debugging page too
60 More information on compiling is @ref building page.
64 Please see the @ref contributing page, the @ref internals page may also be of
69 This changelog is meant as a quick & rough guide to what has changed between
70 versions. The API is now fairly stable but when new calls/features are added
71 they are listed here. Anything pre 0.2.x is ignored.
74 * 5th Generation NUC i2c support
80 * Uart initialisation improved
81 * Better i2c bus detection on DE3815 & mmax
84 * DE3815 i2c fix when using different kernels
85 * Fixed various memory leaks in SWIG wrappers
86 * gpio enums all prefixed with mraa_
87 * Fix SPI CS pin caps causing mux_total to be > 0
88 * Improved error checking/handling
91 * Fix node.js npm builds with binding.gyp that didn't use --target-arch
94 * Uart now uses binary arrays and has optional 'Str' functions in C++/SWIG
95 * Various Uart module bugfixes
96 * Node.js 0.12.4 support
97 * Node.js documentation support
100 * Uart module now contains read/write interactions and configuration
101 * Python API contains more buffer checks
106 * Node.js 0.12 support
108 * Formatting done with clang-format
109 * Various examples and documentation updates
110 * Supported added for Beaglebone Black + Banana Pi
113 * 16bit spi iunctions added
114 * Node.js ISR now supported
117 * add device path queries for uart
118 * add platform configuration querying
120 * improve i2c/spi write/read API for python & nodejs
121 * performance improvements on edison & galileo
124 * pwm read_* fix introduced in 0.5.3
125 * improved npmpkg support
128 * OE toolchain support added to CMake
130 * SPI add CS exposure
131 * Remove functions from mraa.c into modules
132 * Rework of support for mmap
133 * Intel Edison MMAP support added. Read and Write
134 * I2C clean up, add cleaner functions
135 * MinnowBoard Max support added
136 * PWM period is written before duty
137 * Node GYP build supported added
138 * Add Get Platform Name function
141 * pwm improvement & bugfix
142 * spi mraa_spi_bit_per_word fix
143 * new spi transfer function
144 * i2c object api uses uint8_t
145 * i2c readReg() calls added
146 * edison i2c bus now defaults to a sensible value
147 * edison uart enable support
148 * edison hardware CS exposed as IO10
149 * DE3815tykhe NUC support
152 * Intel Edison - Mini breakout board support
153 * Change to use syslog throughout instead of printing to stderr.
154 * Fix misc issues brought up throuh coverity scans
155 * Clear up Analog call documentation
158 * Intel Edison - Arduino board support.
159 * Boost Allowable i2c busses to 12
160 * Additional platform hooks added
161 * ADC is now 10bits by default on all platforms but can be changed
164 * if only one spidev we default to it reguardless of number
165 * mraa_pwm_config_ms & mraa_pwm_config_percent functions added
166 * Uart C++ class added, adds python & node support
167 * galileo gen2 gpio modes supported
170 * prefix SPI mode with MRAA_SPI_
171 * added C++ adc bitness calls
174 * SPI Mode function now functional, API Change in SPI
175 * I2C read in swig worked on.
176 * Galileo Gen 2: PWM setting period sets all channel's period
177 * Galileo Gen 2: I2C setup now specific to Gen 2.
178 * General commits around freeing memory at the right times.
181 * Barebone UART module added.
182 * Hook branch merged.
183 * I2C init hooks added.
184 * Intel Galileo Gen 2, I2C gpio pins now go hiz input when I2C initialised.
187 * Rename python & nodejs modules to mraa
188 * common.hpp introduced for C++
189 * python & nodejs modules can now take binary strings for Spi & I2c
190 * improved Aio module and clear bitness
191 * Improved Galileo Gen 2 support
195 * get_platform_type function added.
198 * Initial Intel Galileo Gen 2 support
199 * mraa_gpio_isr parameters added.
200 * Detection of different supported platforms added.
203 * mraa_i2c_read now returns length of read
206 * Add global mraa.h & mraa.hpp headers
207 * usage of "gpio.h" is not legal you need to use "mraa/gpio.h" unless adding
211 * Added mraa_set_priority call
212 * Added mmap gpio call mraa_gpio_use_mmaped
215 * C++ API now uses basic types and not unistd types as C
216 * Clearer and consistent use of unistd tpyes in C api
219 * C++ examples added, using c++ headers/api.
220 * moved to open instead of fopen in all modules
221 * rename mraa_check functions and made them internal to mraa only.
222 * removed "export" functions from api
223 * Intel Galileo Gen 1 (rev d) fixes, incorrect definition of some items
224 * SPI, implementation completed.
225 * I2C internal function, completed.
226 * PWM fix bug in period set method.
227 * Swig upstream can be used for building.
228 * No longer builds docs on default cmake, needs flag
229 * GPIO/PWM ownership guard prevents closing on existing pins, still can be forced.
232 * C++/Python/Node Enums/const names now do not contain MRAA_GPIO
233 * Enum type declaration for C++ changed
234 * Python/Node get_version() -> GetVersion()
235 * i2c read calls don't use const char* and i2c write calls do
238 * All mraa_ contexts now are pointers to the actual struct which is not
239 delcared in the header. The only end user change is that instead of
240 returning a type mraa_gpio_context pointer mraa_gpio_init() now returns a
241 mraa_gpio_context (which is actually a pointer to struct _gpio internally).
242 * C++ API is available, use the .hpp headers and add stdc++ to the linker
244 * Initial SPI implementation is provided
247 * mraa_aio_read_u16() -> mraa_aio_read()
248 * mraa_aio_read() now returns a uint16_t instead of an unsigned int
251 * First version with API considered 'stable'