Sensor Ring Library

💡 The EduArt Sensor Ring library is the high level software interface of the EduArt sensor boards.

Source Code
License

Quick Start Guide

Choose your target platform or target framework for a quick Start guide:

Target Platform
Target Framework

Application Example

A Raspberry Pi based EduBot equipped 12 sensor boards.

3D map of an office room recorded with the EduBot and Octomap.

Hardware

ℹ️ Have a look at the hardware guide on how to set up and use the sensors with your computer.

Installation

ℹ️ Have a look at the installation guide on how build the library on your platform.

Quick Start - Use the library in other CMake projects

include(FetchContent)
FetchContent_Declare(
  sensorring
  URL      https://github.com/EduArt-Robotik/edu_lib_sensorring/archive/refs/heads/master.zip
  DOWNLOAD_EXTRACT_TIMESTAMP OFF
)
 
FetchContent_MakeAvailable(sensorring)
add_library(sensorring::sensorring ALIAS sensorring)

Quick Start - Build and install the library from source

• Quick Start Linux

  git clone https://github.com/EduArt-Robotik/edu_lib_sensorring
  mkdir -p edu_lib_sensorring/build
  cd edu_lib_sensorring/build
  cmake .. -DCMAKE_BUILD_TYPE=Release -DBUILD_EXAMPLES=ON
  cmake --build . -j4
  sudo cmake --install

• Quick Start Windows

  git clone https://github.com/EduArt-Robotik/edu_lib_sensorring
  mkdir edu_lib_sensorring/build
  cd edu_lib_sensorring/build
  cmake .. -DCMAKE_BUILD_TYPE=Release -DBUILD_EXAMPLES=ON
  cmake --build . --config=Release -- -j4
  cmake --install . --config=Release # Requires terminal with admin privileges

Software

ℹ️ Have a look at the software guide on how to use the library in your own projects.

• Quick Start ROS2 Native

  mkdir ros2_ws/src -p
  cd ros2_ws
  git clone https://github.com/EduArt-Robotik/edu_sensorring_ros2.git ./src
  colcon build --packages-select edu_sensorring_ros2 --symlink-install --event-handlers console_direct+
  source install/setup.bash
  ros2 launch edu_sensorring_ros2 usb_sensorring.launch.py

• Quick Start ROS2 Docker

  git clone https://github.com/EduArt-Robotik/edu_sensorring_ros2.git
  cd edu_sensorring_ros2/docker/
  docker compose build
  docker compose up -d

	Read Next
	Hardware