Installation - peaq

The ROS 2 packages live in the peaq-robotics-ros2 repository. Clone the workspace and choose either a Docker-based workflow or a native ROS 2 Humble setup.

Docker Workflow (Recommended)

git clone https://github.com/peaqnetwork/peaq-robotics-ros2.git
cd peaq-robotics-ros2

# Build the development image
docker build -t peaq-ros2:latest .

# Start a container with workspace mounted
docker run -it --rm \
  --name peaq-ros2-dev \
  -v "$(pwd)":/work \
  -w /work \
  -p 5001:5001 -p 8080:8080 \
  peaq-ros2:latest

# Inside the container: the image installs peaq-robot-sdk from requirements.txt,
# which has no access module; swap it for peaq-robotics-sdk
pip uninstall -y peaq-robot-sdk && pip install -U peaq-robotics-sdk
source /opt/ros/humble/setup.bash
colcon build
source install/setup.bash

The Docker image installs ROS 2 Humble, Python dependencies, and build tooling. The Dockerfile downloads the linux-amd64 Kubo build, so the image builds on x86_64 hosts only. The exposed ports are the local IPFS API (5001) and gateway (8080) used by the storage bridge.

Native Humble Setup

git clone https://github.com/peaqnetwork/peaq-robotics-ros2.git
cd peaq-robotics-ros2

# Install Python requirements
pip install -r requirements.txt

# requirements.txt installs peaq-robot-sdk, which has no access module; swap it for peaq-robotics-sdk
pip uninstall -y peaq-robot-sdk && pip install -U peaq-robotics-sdk

# Ensure ROS 2 Humble is installed and sourced
source /opt/ros/humble/setup.bash

# (Optional) install additional system dependencies
sudo rosdep init 2>/dev/null || true
rosdep update
rosdep install --from-paths . --ignore-src -r -y || true

# Build the workspace
colcon build
source install/setup.bash

IPFS (with Optional Managed Pinning)

The storage bridge relies on an IPFS node. Follow the repository guide to install Kubo, run ipfs daemon, and optionally supply Pinata credentials in the configuration file. Continue with configuration once the workspace builds successfully.

⌘I