dear-ros-node-viewer 1.1.2

dear_ros_node_viewer

https://user-images.githubusercontent.com/105265012/177068238-eaf4fed9-12c0-4c5b-ac7f-9597483c4c3c.mp4

Dear RosNodeViewer

About

• Visualize ROS2 node diagram
• Support the following sources:
  • architecture.yaml generated by CARET
  • rosgraph.dot generated by rqt_graph
  • running ROS graph analysis

Requirements

• Ubuntu 20.04 or 22.04
  • graphviz is required
• optional: ROS 2 Galactic or Humble if you need runtime ROS graph analysis
  • e.g., sudo apt install ros-humble-rqt-graph , sudo apt install ros-humble-desktop
• Not tested in Windows / Mac

Get Started

# Install requirements
sudo apt install graphviz

# Install Dear RosNodeViewer
pip install dear-ros-node-viewer

# Download sample graph
wget https://raw.githubusercontent.com/iwatake2222/dear_ros_node_viewer/main/sample/architecture_autoware.yaml

# Run Dear RosNodeViewer
dear_ros_node_viewer architecture_autoware.yaml

• Quick operation guide:
  • Middle button drag: move graph area
  • Mouse scroll: zoom in/out (zoom function is tentative)

How to Use

See WiKi

Development

Setup

git clone https://github.com/iwatake2222/dear_ros_node_viewer.git
cd dear_ros_node_viewer
pip install -e .
pip install -r requirements.txt

Running Tests

# Run all tests
pytest tests/ -v

# Run with coverage
pytest --doctest-modules -v --cov=./src/dear_ros_node_viewer

# Run single test file
pytest tests/test_caret2networkx.py -v

Linting

flake8 . --exclude=.venv --count --select=E9,F63,F7,F82 --show-source --statistics
pylint ./src/dear_ros_node_viewer --disable=E0401,W1203,C0301

Acknowledgements

• Dear RosNodeViewer utilizes Dear PyGui
  • Dear RosNodeViewer is named in honor of Dear PyGui
• Dear RosNodeViewer contains Roboto font
  • licensed under the Apache License, Version 2.0.