-MAA - 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 over:
-
-- I2C
-- SPI
-- GPIO
-- PWM
-- AIO
-
-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
their sensors & actuators on top of supported hardware and to allow control of
low level communication protocol by high level languages & constructs.
-### ENV RECOMENDATIONS
-
-All of these are 'optional', however they are recommended. Only a C compiler,
-cmake and default system libraries are technically required to compile.
-
-1. node.js 0.10.26
-2. python 3.3.x or 2.7.x
-3. swig-v8 3.0.1 (swig 2.x will work but you will not be able to build node.js
-module so comment out add_directories(javacsript) in src/CmakeLists.txt)
-4. doxygen (needed to generate even python doc)
-5. sphinx
-6. pygments
-7. pydoc
+Supported Boards
+================
-To install swig-v8 the swig-v8-git package from AUR is helpful.
+X86
+---
+* [Galileo Gen 1 - Rev D](../master/docs/galileorevd.md)
+* [Galileo Gen 2 - Rev H](../master/docs/galileorevh.md)
+* [Edison](../master/docs/edison.md)
+* [Intel DE3815](../master/docs/intel_de3815.md)
+* [Minnowboard Max](../master/docs/minnow_max.md)
-## COMPILING
+ARM
+---
+* [Raspberry Pi](../master/docs/raspberry_pi.md)
-NOTE: The **only** supported cmake build configuration is to have the build/ dir
-inside of the repo/tarball.
+Installing on your board
+========
-*if swig-v8 is not in your default path you can try run cmake with
-"-DCMAKE_PREFIX_PATH="/path/to/swig-v8"*
+See the section below on compiling or use our repository to install on an
+eglibc based yocto poky image that supports opkg. Adding this repository is as
+simple as:
-mkdir build/
-cmake ..
-make
+``` bash
+echo "src mraa-upm http://iotdk.intel.com/repos/1.1/intelgalactic" > /etc/opkg/mraa-upm.conf
+opkg update
+opkg install libmraa0
+```
-## DEVELOPMENT
+Compiling
+=========
-Please fork the code on github and then send pull requests. Please avoid merges
-in your forks. I will also accept patches sent in git style with signoffs to
-brendan.le.foll@intel.com
+See documentation on [building](../master/docs/building.md)
-## USING
+Examples
+========
-see examples/
+See the [examples](../../tree/master/examples) available for various languages
-*for node.js make sure that maajs.node is in the current dir and set export
-NODE_PATH=.*
+Debugging
+=========
-Simple python html documentation can be generated with **make pydoc**, this
-does not require the full doxygen/sphinx setup.
+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](../master/docs/debugging.md) page too.
-## API Changelog
+C/C++ API Documentation
+===========
-When the API breaks in a small way there will be a changelog listed here
+The C/C++ documentation is available [here](http://iotdk.intel.com/docs/master/mraa/)
-**0.2.5**
- * C++/Python/Node Enums/const names now do not contain MAA_GPIO
- * Enum type declaration for C++ changed
- * Python/Node get_version() -> GetVersion()
- * i2c read calls don't use const char* and i2c write calls do
+Python API Documentation
+===========
-**0.2.4**
- * All maa_ contexts now are pointers to the actual struct which is not
- delcared in the header. The only end user change is that instead of
- returning a type maa_gpio_context pointer maa_gpio_init() now returns a
- maa_gpio_context (which is actually a pointer to struct _gpio internally).
- * C++ API is available, use the .hpp headers and add stdc++ to the linker
- flags.
- * Initial SPI implementation is provided
+The Python documentation is available [here](http://iotdk.intel.com/docs/master/mraa/python)
-**0.2.3**
- * maa_aio_read_u16() -> maa_aio_read()
- * maa_aio_read() now returns a uint16_t instead of an unsigned int
+NodeJS API documentation
+===========
-**0.2.2**
- * First version with API considered 'stable'
+There is no explicit nodejs API documentation, see the examples. The API itself
+is very similar to the python one but with a js syntax. If you know of an
+autodoc tool for generating nodejs APIs from a native C++ nodejs extension
+please get in touch!
projects / contrib / mraa.git / blobdiff