docs/index.java.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 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 ## Supported platforms
  34
  35 Specific platform information for supported platforms is documented here:
  36
  37 - @ref galileorevd
  38 - @ref galileorevh
  39 - @ref edison
  40 - @ref de3815
  41 - @ref minnowmax
  42 - @ref rasppi
  43 - @ref bananapi
  44 - @ref beaglebone
  45 - @ref nuc5
  46 - @ref ft4222
  47
  48 ## DEBUGGING
  49
  50 Sometimes it just doesn't want to work, let us try and help you, you can file
  51 issues in github or join us in #mraa on freenode IRC, hang around for a little
  52 while because we're not necessarily on 24/7, but we'll get back to you! Have a
  53 glance at our @debugging page too
  54
  55 ## COMPILING
  56
  57 More information on compiling is @ref building page.
  58
  59 ## CONTRIBUTING
  60
  61 Please see the @ref contributing page, the @ref internals page may also be of
  62 use.
  63