X-Git-Url: http://review.tizen.org/git/?a=blobdiff_plain;f=docs%2Findex.md;h=e63f465688eacd5465d4aff29ccc52719b3f5788;hb=ef28607ceadb9868215d703bc8594c5270dca75e;hp=22d39309830aa077836b112fad2bce5558107574;hpb=d47364189d26558ee4fc1f514520b58ea0f558d1;p=contrib%2Fmraa.git diff --git a/docs/index.md b/docs/index.md index 22d3930..e63f465 100644 --- a/docs/index.md +++ b/docs/index.md @@ -1,11 +1,14 @@ -MRAA - Low Level Skeleton Library for Communication on Intel platforms +libmraa - Low Level Skeleton Library for Communication on GNU/Linux platforms ============== -Library in C/C++ to interface with Galileo & other Intel platforms, in a -structured and sane API with port nanmes/numbering that match boards & with -bindings to javascript & python. +Libmraa is a C/C++ library with bindings to javascript & python to interface +with the IO on Galileo, Edison & other platforms, with a structured and sane +API where port names/numbering matches the board that you are on. Use of +libmraa does not tie you to specific hardware with board detection done at +runtime you can create portable code that will work across the supported +platforms. -The intent is to make it easier for developers and sensor manufacturers to map +The intent is to make it easier for developers and sensor manufacturers to map their sensors & actuators on top of supported hardware and to allow control of low level communication protocol by high level languages & constructs. @@ -16,14 +19,15 @@ classes directly wrap the C API and provide a near 1:1 mapping of functionality.
-| C API Modules | C++ API Classes | -|:----------------------:|:---------------------------:| +| C API Modules | C++ API Classes | +|:----------------------:|:----------------------------:| | @ref gpio.h "gpio" | @ref mraa::Gpio "Gpio class" | | @ref i2c.h "i2c" | @ref mraa::I2c "I2c class" | | @ref aio.h "aio" | @ref mraa::Aio "Aio class" | | @ref pwm.h "pwm" | @ref mraa::Pwm "Pwm class" | | @ref spi.h "spi" | @ref mraa::Spi "Spi class" | -| @ref common.h "common" | @ref common.h "common" | +| @ref uart.h "uart" | @ref mraa::Uart "Uart class" | +| @ref common.h "common" | @ref mraa "common" |
### Hello Mraa @@ -34,24 +38,29 @@ functionality. Specific platform information for supported platforms is documented here: - @ref galileorevd +- @ref galileorevh +- @ref edison +- @ref de3815 +- @ref minnowmax +- @ref rasppi +- @ref bananapi +- @ref beaglebone -### ENV RECOMENDATIONS +## DEBUGGING -All of these are 'optional', however they are recommended. Only a C compiler, -cmake, libm and pthreads are technically required to compile. - -- Swig 3.0.1+ built with node.js & python support (0.10.x) -- doxygen -- sphinx (requires doxygen) -- pygments +Sometimes it just doesn't want to work, let us try and help you, you can file +issues in github or join us in #mraa on freenode IRC, hang around for a little +while because we're not necessarily on 24/7, but we'll get back to you! Have a +glance at our @debugging page too ## COMPILING -More information on compiling is @ref building page +More information on compiling is @ref building page. ## CONTRIBUTING -Please see the @ref contributing page +Please see the @ref contributing page, the @ref internals page may also be of +use. ## API Changelog @@ -59,6 +68,116 @@ This changelog is meant as a quick & rough guide to what has changed between versions. The API is now fairly stable but when new calls/features are added they are listed here. Anything pre 0.2.x is ignored. +**0.7.3** + * DE3815 i2c fix when using different kernels + * Fixed various memory leaks in SWIG wrappers + * gpio enums all prefixed with mraa_ + * Fix SPI CS pin caps causing mux_total to be > 0 + * Improved error checking/handling + +**0.7.2** + * Fix node.js npm builds with binding.gyp that didn't use --target-arch + +**0.7.1** + * Uart now uses binary arrays and has optional 'Str' functions in C++/SWIG + * Various Uart module bugfixes + * Node.js 0.12.4 support + * Node.js documentation support + +**0.7.0** + * Uart module now contains read/write interactions and configuration + * Python API contains more buffer checks + * Java support + * RPM cpack support + +**0.6.2** + * Node.js 0.12 support + * NPM support + * Formatting done with clang-format + * Various examples and documentation updates + * Supported added for Beaglebone Black + Banana Pi + +**0.6.1** + * 16bit spi iunctions added + * Node.js ISR now supported + +**0.6.0** + * add device path queries for uart + * add platform configuration querying + * gpio sample added + * improve i2c/spi write/read API for python & nodejs + * performance improvements on edison & galileo + +**0.5.4** + * pwm read_* fix introduced in 0.5.3 + * improved npmpkg support + +**0.5.3** + * OE toolchain support added to CMake + * Various UART fixes + * SPI add CS exposure + * Remove functions from mraa.c into modules + * Rework of support for mmap + * Intel Edison MMAP support added. Read and Write + * I2C clean up, add cleaner functions + * MinnowBoard Max support added + * PWM period is written before duty + * Node GYP build supported added + * Add Get Platform Name function + +**0.5.2** + * pwm improvement & bugfix + * spi mraa_spi_bit_per_word fix + * new spi transfer function + * i2c object api uses uint8_t + * i2c readReg() calls added + * edison i2c bus now defaults to a sensible value + * edison uart enable support + * edison hardware CS exposed as IO10 + * DE3815tykhe NUC support + +**0.5.1** + * Intel Edison - Mini breakout board support + * Change to use syslog throughout instead of printing to stderr. + * Fix misc issues brought up throuh coverity scans + * Clear up Analog call documentation + +**0.5.0** + * Intel Edison - Arduino board support. + * Boost Allowable i2c busses to 12 + * Additional platform hooks added + * ADC is now 10bits by default on all platforms but can be changed + +**0.4.5** + * if only one spidev we default to it reguardless of number + * mraa_pwm_config_ms & mraa_pwm_config_percent functions added + * Uart C++ class added, adds python & node support + * galileo gen2 gpio modes supported + +**0.4.4** + * prefix SPI mode with MRAA_SPI_ + * added C++ adc bitness calls + +**0.4.3** + * SPI Mode function now functional, API Change in SPI + * I2C read in swig worked on. + * Galileo Gen 2: PWM setting period sets all channel's period + * Galileo Gen 2: I2C setup now specific to Gen 2. + * General commits around freeing memory at the right times. + +**0.4.2** + * Barebone UART module added. + * Hook branch merged. + * I2C init hooks added. + * Intel Galileo Gen 2, I2C gpio pins now go hiz input when I2C initialised. + +**0.4.1** + * Rename python & nodejs modules to mraa + * common.hpp introduced for C++ + * python & nodejs modules can now take binary strings for Spi & I2c + * improved Aio module and clear bitness + * Improved Galileo Gen 2 support + **0.4.0** * Rename to mraa * get_platform_type function added.