Skip to main content

ROS2 workspace scaffolder + multi-machine diagnostics toolkit

Project description

rosforge

ROS2 workspace scaffolder + multi-machine diagnostics toolkit.

Two tools. One install.


Install

pip install rosforge

Or from source:

git clone https://github.com/yourname/rosforge
cd rosforge && pip install -e .

rosforge scaf

Scaffold a complete ROS2 workspace interactively:

rosforge scaf

Generates:

  • config/cyclonedds.xml or fastdds.xml — correct for your network topology
  • config/bashrc_block.sh — exact exports, ready to paste
  • scripts/install_device1.sh, install_device2.sh — full per-device install scripts
  • src/<pkg>/<node>.py — publisher / subscriber / service node, colcon-ready
  • package.xml, setup.py
  • README.md with device-specific steps

Supports: Humble / Iron / Jazzy / Rolling, RPi / Jetson / x86 / STM32, CycloneDDS / FastDDS, same LAN / cross-subnet / hotspot / single machine, micro-ROS agent config.


rosforge doctor

Diagnose your ROS2 multi-machine setup:

# Local checks only
rosforge doctor

# Check peer connectivity too
rosforge doctor raspberrypi.local 192.168.1.42

Checks:

  • ROS2 installation and distro detection
  • RMW / DDS environment variables
  • ROS_DOMAIN_ID and ROS_LOCALHOST_ONLY
  • Network interface enumeration
  • Multicast reachability
  • UFW / iptables firewall rules blocking UDP
  • DDS port availability (7400–7411)
  • NTP clock synchronization
  • ROS2 daemon health
  • Cross-distro compatibility warnings
  • Live topic discovery smoke-test
  • Per-peer: ICMP ping + UDP reachability

Every failure comes with a specific fix command.


Workflow

# 1. Scaffold your workspace
rosforge scaf

# 2. Diagnose immediately after
rosforge doctor raspberrypi.local jetson.local

# 3. Apply fixes, re-run until clean
rosforge doctor

License

MIT

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

ros2forge-0.4.1.tar.gz (16.8 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

ros2forge-0.4.1-py3-none-any.whl (18.2 kB view details)

Uploaded Python 3

File details

Details for the file ros2forge-0.4.1.tar.gz.

File metadata

  • Download URL: ros2forge-0.4.1.tar.gz
  • Upload date:
  • Size: 16.8 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.10.12

File hashes

Hashes for ros2forge-0.4.1.tar.gz
Algorithm Hash digest
SHA256 a03f6f305f794314a28ad4c4e6337e8115db4b4f94dfed2bebfcc647bdd5b32c
MD5 897720ca9bff80c4168e7c7e58e15960
BLAKE2b-256 608fb5438427a70b4b99fa766ae7676942ad513de03523d0c844846b21218a62

See more details on using hashes here.

File details

Details for the file ros2forge-0.4.1-py3-none-any.whl.

File metadata

  • Download URL: ros2forge-0.4.1-py3-none-any.whl
  • Upload date:
  • Size: 18.2 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.10.12

File hashes

Hashes for ros2forge-0.4.1-py3-none-any.whl
Algorithm Hash digest
SHA256 e2407c64031c62332537ffd949805079620320dd28c3ff5af19906f13c4ee4cb
MD5 20fc6871bc4ea8f5944d5f734aa95f09
BLAKE2b-256 5e43206d2fa105a06c49e26ff41a4077e4a888bc535dc8c5a4dd141e6234c62f

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page