1 libmraa - Low Level Skeleton Library for Communication on Intel platforms
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.
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.
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
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 uart.h "uart" | @ref mraa::Uart "Uart class" |
27 | @ref common.h "common" | @ref mraa "common" |
31 @snippet hellomraa.c Interesting
33 ## Supported platforms
35 Specific platform information for supported platforms is documented here:
40 ### ENV RECOMENDATIONS
42 All of these are 'optional', however they are recommended. Only a C compiler,
43 cmake, libm and pthreads are technically required to compile.
45 - Swig 3.0.1+ built with node.js & python support (0.10.x)
47 - sphinx (requires doxygen)
52 More information on compiling is @ref building page.
56 Please see the @ref contributing page, the @ref internals page may also be of
61 This changelog is meant as a quick & rough guide to what has changed between
62 versions. The API is now fairly stable but when new calls/features are added
63 they are listed here. Anything pre 0.2.x is ignored.
66 * Intel Edison - Arduino board support.
67 * Boost Allowable i2c busses to 12
68 * Additional platform hooks added
69 * ADC is now 10bits by default on all platforms but can be changed
72 * if only one spidev we default to it reguardless of number
73 * mraa_pwm_config_ms & mraa_pwm_config_percent functions added
74 * Uart C++ class added, adds python & node support
75 * galileo gen2 gpio modes supported
78 * prefix SPI mode with MRAA_SPI_
79 * added C++ adc bitness calls
82 * SPI Mode function now functional, API Change in SPI
83 * I2C read in swig worked on.
84 * Galileo Gen 2: PWM setting period sets all channel's period
85 * Galileo Gen 2: I2C setup now specific to Gen 2.
86 * General commits around freeing memory at the right times.
89 * Barebone UART module added.
91 * I2C init hooks added.
92 * Intel Galileo Gen 2, I2C gpio pins now go hiz input when I2C initialised.
95 * Rename python & nodejs modules to mraa
96 * common.hpp introduced for C++
97 * python & nodejs modules can now take binary strings for Spi & I2c
98 * improved Aio module and clear bitness
99 * Improved Galileo Gen 2 support
103 * get_platform_type function added.
106 * Initial Intel Galileo Gen 2 support
107 * mraa_gpio_isr parameters added.
108 * Detection of different supported platforms added.
111 * mraa_i2c_read now returns length of read
114 * Add global mraa.h & mraa.hpp headers
115 * usage of "gpio.h" is not legal you need to use "mraa/gpio.h" unless adding
119 * Added mraa_set_priority call
120 * Added mmap gpio call mraa_gpio_use_mmaped
123 * C++ API now uses basic types and not unistd types as C
124 * Clearer and consistent use of unistd tpyes in C api
127 * C++ examples added, using c++ headers/api.
128 * moved to open instead of fopen in all modules
129 * rename mraa_check functions and made them internal to mraa only.
130 * removed "export" functions from api
131 * Intel Galileo Gen 1 (rev d) fixes, incorrect definition of some items
132 * SPI, implementation completed.
133 * I2C internal function, completed.
134 * PWM fix bug in period set method.
135 * Swig upstream can be used for building.
136 * No longer builds docs on default cmake, needs flag
137 * GPIO/PWM ownership guard prevents closing on existing pins, still can be forced.
140 * C++/Python/Node Enums/const names now do not contain MRAA_GPIO
141 * Enum type declaration for C++ changed
142 * Python/Node get_version() -> GetVersion()
143 * i2c read calls don't use const char* and i2c write calls do
146 * All mraa_ contexts now are pointers to the actual struct which is not
147 delcared in the header. The only end user change is that instead of
148 returning a type mraa_gpio_context pointer mraa_gpio_init() now returns a
149 mraa_gpio_context (which is actually a pointer to struct _gpio internally).
150 * C++ API is available, use the .hpp headers and add stdc++ to the linker
152 * Initial SPI implementation is provided
155 * mraa_aio_read_u16() -> mraa_aio_read()
156 * mraa_aio_read() now returns a uint16_t instead of an unsigned int
159 * First version with API considered 'stable'