https://github.com/iwatake2222/dear_ros_node_viewer

Dear RosNodeViewer: Visualize ROS2 Node Graph
https://github.com/iwatake2222/dear_ros_node_viewer

Last synced: 3 months ago
JSON representation

Dear RosNodeViewer: Visualize ROS2 Node Graph

• Host: GitHub
• URL: https://github.com/iwatake2222/dear_ros_node_viewer
• Owner: iwatake2222
• License: apache-2.0
• Created: 2022-06-24T23:38:13.000Z (almost 2 years ago)
• Default Branch: main
• Last Pushed: 2023-11-04T18:54:14.000Z (8 months ago)
• Last Synced: 2024-03-25T03:11:16.136Z (3 months ago)
• Language: Python
• Homepage: https://pypi.org/project/dear-ros-node-viewer/
• Size: 396 KB
• Stars: 91
• Watchers: 4
• Forks: 4
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Lists

• awesome-mobile-robotics - Dear ROS Node Viewer

README

        


  



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

[![Python application](https://github.com/iwatake2222/dear_ros_node_viewer/actions/workflows/python-app.yml/badge.svg)](https://github.com/iwatake2222/dear_ros_node_viewer/actions/workflows/python-app.yml)

[![PyPI Publish](https://github.com/iwatake2222/dear_ros_node_viewer/actions/workflows/pypi-publish.yml/badge.svg)](https://pypi.org/project/dear-ros-node-viewer/)

# Dear RosNodeViewer

## About

- Visualize ROS2 node diagram

- Support the following sources:

  - *architecture.yaml* generated by [CARET](https://github.com/tier4/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

- Not tested in Windows / Mac

## Get Started

```sh

# 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](https://github.com/iwatake2222/dear_ros_node_viewer/wiki/01.-How-to-Use)

# Acknowledgements

- Dear RosNodeViewer utilizes [Dear PyGui](https://github.com/hoffstadt/DearPyGui)

  - *Dear RosNodeViewer* is named in honor of Dear PyGui

- Dear RosNodeViewer contains [Roboto font](https://fonts.google.com/specimen/Roboto)

  - licensed under the Apache License, Version 2.0.