Setup

Getting Started

Prerequisites

• ROS 2
• C++17 compatible compiler
• Python 3
• Required ROS 2 dependencies
• Git LFS (for large files)

Installation

a. Install Git LFS (if not already installed)

git lfs install

b. Clone the repository
Make sure to clone the repository after installing Git LFS so that all large files are downloaded correctly.

git clone git@gitlab.com:enchantedtools-open/ros2-sdk.git
cd ros2-sdk

- Note: If you already cloned the repository before installing LFS, run:

git lfs pull

c. Build the packages

colcon build
source install/setup.bash

Note

• For simulation: Use only mirokai_description and control_examples packages
• For real robot: You must set up the Zenoh network first
• The Zenoh network is only needed when working with physical robots
• Simulation mode provides a complete environment without external dependencies
• Real robot mode requires network communication through Zenoh to connect with the physical robot

Documentation

Each package contains its own detailed documentation: - Control Examples Documentation - Docker Visualization Documentation - Native Visualization Documentation

Support

For support or questions, please refer to the documentation in each package's README file or contact the development team.

Contributing

Contributions are welcome! Please follow the standard ROS 2 development guidelines and maintain consistency with the existing codebase.