Home | History | Annotate | Download | only in docs 
      1 libmraa - Low Level Skeleton Library for Communication on GNU/Linux platforms
      2 ==============
      3 
      4 Libmraa is a C/C++ library with bindings to Java, Python and JavaScript to
      5 interface with the I/O on Galileo, Edison & other platforms, with a structured
      6 and sane API where port names/numbering matches the board that you are on. Use
      7 of 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
     18 Java classes directly wrap the C/C++ API and provide a near 1:1 mapping of
     19 functionality.
     20 
     21 <center>
     22 | C API Modules          | Java 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::mraa "mraa class" |
     31 </center>
     32 
     33 ### Hello Mraa
     34 @snippet HelloEdison.java 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 - @ref nuc5
     49 - @ref ft4222
     50 
     51 ## DEBUGGING
     52 
     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
     57 
     58 ## COMPILING
     59 
     60 More information on compiling is @ref building page.
     61 
     62 ## CONTRIBUTING
     63 
     64 Please see the @ref contributing page, the @ref internals page may also be of
     65 use.
     66 
     67 ## API Changelog
     68 
     69 Version @ref changelog here.
     70