From 7d11bd4cdcd0c283e8a280ec4ab364d44e9df25f Mon Sep 17 00:00:00 2001 From: Mircea Bardac Date: Mon, 21 Sep 2015 22:26:31 +0300 Subject: [PATCH] docs: Added index for Java documentation Signed-off-by: Mircea Bardac Signed-off-by: Brendan Le Foll --- docs/index.java.md | 63 ++++++++++++++++++++++++++++++++++++++++++++++++++++++ docs/index.md | 10 ++++----- 2 files changed, 68 insertions(+), 5 deletions(-) create mode 100644 docs/index.java.md diff --git a/docs/index.java.md b/docs/index.java.md new file mode 100644 index 0000000..9f51444 --- /dev/null +++ b/docs/index.java.md @@ -0,0 +1,63 @@ +libmraa - Low Level Skeleton Library for Communication on GNU/Linux platforms +============== + +Libmraa is a C/C++ library with bindings to Java, Python and JavaScript to +interface with the I/O 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 +their sensors & actuators on top of supported hardware and to allow control of +low level communication protocol by high level languages & constructs. + +## API + +These interfaces allow you to interact with all libmraa functionality. The +Java classes directly wrap the C/C++ API and provide a near 1:1 mapping of +functionality. + +
+| C API Modules | Java 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 uart.h "uart" | @ref mraa::Uart "Uart class" | +| @ref common.h "common" | @ref mraa::mraa "mraa class" | +
+ +## Supported platforms + +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 +- @ref nuc5 +- @ref ft4222 + +## DEBUGGING + +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. + +## CONTRIBUTING + +Please see the @ref contributing page, the @ref internals page may also be of +use. + diff --git a/docs/index.md b/docs/index.md index 383328f..242bbb8 100644 --- a/docs/index.md +++ b/docs/index.md @@ -1,14 +1,14 @@ libmraa - Low Level Skeleton Library for Communication on GNU/Linux platforms ============== -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 +Libmraa is a C/C++ library with bindings to Python, Javascript and Java to +interface with the I/O 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. -- 2.7.4