Setup Guide for OMY
This guide will walk you through the process of setting up your OMY hardware and software environment.
Hardware Setup
OMY-3M
OMY-F3M
OMY-L100
OMY-AI3M
Power connection
SSH connection
Network Access Method
Start by connecting the robot pc
to the same network as the user PC
using a LAN cable, then power on the OMY (press and release the power button until it turns white). The OMY OS uses mDNS technology to discover its IP address. Each time OMY OS boots, it sets the SBC’s hostname to the serial number (SN) written on the product (e.g., SNPR44B9999). In environments where UDP Multicast is available (such as being on the same router), you can connect directly to the robot pc
using the hostname. Static IP assignment and other network settings for more advanced connection options are supported through the Manager.
SSH Access Method
(Assuming the SN is ‘SNPR44B9999’) To access via SSH over the local network from a Linux environment, use the following command:
ssh root@omy-SNPR44B9999.local
Docker Setup
- Connect to the OMY via SSH.
- Check running containers using
docker ps
. - Docker-related files are located in
/data/docker/open_manipulator/docker
. Navigate to this location usingcd
:
cd /data/docker/open_manipulator/docker
- Access the container using
./container.sh enter
.
TIP
The /workspace
folder inside the container is volume mapped (a feature that links file systems) to /data/docker/open_manipulator/workspace
on the host. All other areas are volatile and will be lost if the container is damaged or deleted.
Unpacking
DANGER
- Following initial setup, the Unpacking script must be executed to prevent self-collision.
- Run this script ONLY in the packed posture, running it in any other orientation may cause damage.
When you first receive the OMY, the manipulator is folded as shown in the image below.
You can move it to the initial position by running the following command for UNPACKING:
ros2 launch open_manipulator_bringup unpack_y.launch.py
The image below shows the initial position after UNPACKING.
and the following is the command to PACK it back into it's folded configuration.
ros2 launch open_manipulator_bringup pack_y.launch.py
Software Setup
WARNING
This setup is intended for development on the user PC. The robot PC included with OMY comes pre-configured with the same software stack.
Software Setup for OMY
The ROBOTIS OMY robotic arm utilizes two key software packages to enable intelligent manipulation through Physical AI:
- open_manipulator: Provides control of the 6-DOF OMY arm via ros2_control using DYNAMIXEL-Y actuators. Supports teleoperation and low-level control.
- physical_ai_tools: A toolkit for imitation learning, including modules for data collection, training, inference, and visualization.
Prerequisites
Operating System: Any Linux distribution
- The container runs Ubuntu 24.04 + ROS 2 Jazzy
- The Host OS version does not need to match.
Docker Engine
Install using the official Docker guide
After installation:
bashsudo usermod -aG docker $USER sudo systemctl enable docker docker run hello-world
Git
bashsudo apt install git
Docker Volume Configuration
The Docker container uses volume mappings for hardware access, development, and data persistence:
volumes:
# Hardware and system access
- /dev:/dev
- /tmp/.X11-unix:/tmp/.X11-unix:rw
- /tmp/.docker.xauth:/tmp/.docker.xauth:rw
# Development and data directories
- ./workspace:/workspace
- ../:/root/ros2_ws/src/open_manipulator/
TIP
Store your development code in /workspace
to preserve your codes.
Container Lifecycle
Initial Setup
# Clone the open_manipulator repository
cd ~
git clone -b jazzy https://github.com/ROBOTIS-GIT/open_manipulator.git
cd open_manipulator
Starting and Managing the Container
# Start container
./docker/container.sh start
# Enter the running container
./docker/container.sh enter
# Stop the container
./docker/container.sh stop
Docker Command Reference
Command | Description |
---|---|
help | Display usage help |
start | Start container |
enter | Enter the running container |
stop | Stop the container |
Example Usage
./container.sh help
./container.sh start
./container.sh enter
./container.sh stop