automatika_ros_sugar

Syntactic sugar for ROS2 nodes creation and management

• Links

  • Rosindex

  • Website

• Message Definitions
  • ComponentStatus
• Service Definitions
  • ChangeParameter
  • ChangeParameters
  • ConfigureFromYaml
  • ReplaceTopic
• Standard Documents
  • LICENSE
  • PACKAGE
  • README

README

ROS SUGAR 🍬 provides a whole lot of syntactic sugar for creating multinode ROS2 event-driven systems and management using an intuitive Python API.

• Learn more about the design concepts in ROS Sugar 📚

• Learn how to create your own ROS2 package using ROS Sugar 🚀

Packages created using ROS Sugar

• Kompass: a framework for building robust and comprehensive event-driven navigation stacks using an easy-to-use and intuitive Python API

• ROS Agents: a fully-loaded framework for creating interactive embodied agents that can understand, remember, and act upon contextual information from their environment.

Overview

ROS Sugar is built for ROS2 developers who want to create robust, event-driven systems with multiple nodes that are easy to use and can be configured and started with an intuitive python API. It provides primitives for writing ROS nodes and events/actions which can start/stop/modify the nodes, in the spirit of event driven software standard. ROS Sugar is also a replacement for the ROS Launch API.

A Component is the main execution unit in ROS Sugar, each component is configured with Inputs/Outputs and Fallback behaviors. Additionally, each component updates its own Health Status. Components can be handled and reconfigured dynamically at runtime using Events and Actions. Events, Actions and Components are passed to the Launcher which runs the set of components as using multi-threaded or multi-process execution. The Launcher also uses an internal Monitor to keep track of the components and monitor events.

Base Component

Multi-Process Execution

Installation

Install python dependencies using pip as follows:

pip install 'attrs>=23.2.0' msgpack-numpy numpy-quaternion setproctitle

Grab your favorite deb package from the release page and install it as follows:

sudo dpkg -i ros-$ROS_DISTRO-sugar_$version$DISTRO_$ARCHITECTURE.deb

Building from source

mkdir -p ros-sugar-ws/src
cd ros-sugar-ws/src
git clone https://github.com/automatika-robotics/ros-sugar && cd ..
pip install pillow numpy opencv-python-headless 'attrs>=23.2.0' jinja2 msgpack msgpack-numpy numpy-quaternion setproctitle
colcon build
source install/setup.bash

Copyright

The code in this distribution is Copyright (c) 2024 Automatika Robotics unless explicitly indicated otherwise.

ROS Sugar is made available under the MIT license. Details can be found in the LICENSE file.

Contributions

ROS Agents has been developed in collaboration between Automatika Robotics and Inria. Contributions from the community are most welcome.