Skip to content

Latest commit

 

History

History
71 lines (50 loc) · 2.15 KB

README.md

File metadata and controls

71 lines (50 loc) · 2.15 KB
Raw

Neuron Library - Peripheral API Library for ROScube

Neuron Library is the API library for ADLINK products, such as ROScube-I and ROScube-X. Neuron Library provides a common API of C++ bindings to Python to interface with the peripheral IO of the controller. With a structured and same API where port index matches the platform that you are on, it's 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.

Supported Hardware

X86

ARM

Examples

See the examples available for supported languages, include C++ and Python.

To use API of Neuron library with ROS 2, please check examples from here

Build

  • Install necessary packages
# Ubuntu 18.04
sudo apt-get install git build-essential swig3.0 python3-dev nodejs-dev cmake libjson-c-dev
# Ubuntu 20.04
sudo apt-get install git build-essential swig3.0 python3-dev libnode-dev cmake libjson-c-dev
  • Get the code
git clone https://github.com/Adlink-ROS/mraa.git
cd mraa
  • Build the Debian package
cmake -Bbuild -H. -DBUILDSWIGNODE=OFF -DCMAKE_INSTALL_PREFIX=/opt/adlink/neuron-sdk/neuron-library/
cmake --build build --target package

The deb package will be under /build.

API Documentation

Bump Version

  • Version changelog here.
  • Version number: CPACK_PACKAGE_VERSION in CMakeLists.txt.
  • git tag -a <new_version>