Private
Public Access
2
0
Files
mraa/docs/index.java.md
Norbert Wesp 4472ff1629 phyboard-wega: Added platform support for phyBOARD-Wega
Like the beaglebone, the phyBOARD-Wega also got an am335x.
So I merged the four mmap-functions for gpio_context and some
identical defines in a separate header and c-file.
The new platform support-files are based on beaglebone-files.

The documentation of phyBOARD-Wega is still in process,
but for now there are enough informations.
At this time it is possible to use GPIO-Pins and Uart0
(tested via python with mraa). The code for using SPI, I2C and
PWM is also still in process and not tested yet.

Signed-off-by: Norbert Wesp <nwesp@phytec.de>
Signed-off-by: Brendan Le Foll <brendan.le.foll@intel.com>
2017-01-26 22:11:46 +01:00

73 lines
2.2 KiB
Markdown

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.
<center>
| 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" |
</center>
### Hello Mraa
@snippet HelloEdison.java Interesting
## 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 phyboard-wega
- @ref nuc5
- @ref up
- @ref grossetete
- @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.
## API Changelog
Version @ref changelog here.