Skip to content
Visualize ROS topics inside a terminal with Unicode/ASCII art
Branch: master
Clone or download
Latest commit 3112584 Apr 19, 2019
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
rosshow support for nav_msgs/Path Apr 18, 2019
rosshow2 readme Mar 21, 2019
.gitignore gitignore May 7, 2017
README.md support for nav_msgs/Path Apr 18, 2019
screenshot0.png
screenshot2.png update imu screenshot Mar 28, 2019
screenshot3-ascii.png update Mar 28, 2019
screenshot3.png greatly improved NavSatFix visualization Mar 28, 2019
screenshot4.png fix scaling Mar 23, 2019
screenshot5.png srgb Mar 27, 2019
screenshot6.png update Mar 23, 2019

README.md

rosshow: Visualize ROS topics in a terminal

Have you ever SSH'ed into a robot to debug whether sensors are outputting what they should, e.g. rostopic echo /camera/image_raw?

If so, rosshow is for you.

This displays various sensor messages in a useful fashion using Unicode Braille art in the terminal so you don't need to fire up port forwards, rviz, or any other shenanigans just to see if something is working. It currently only supports types from std_msgs and sensor_msgs but support for more types is coming. Contributions welcome!

Installation

Prerequisites:

sudo pip install numpy pillow requests

This package will install to your ROS bin directory, i.e. where other ROS binaries such as rostopic, rosnode, etc. are located. Or if you don't want to do that or don't have permissions, you can add it to your catkin workspace and run it using rosrun.

To install to the system:

cd rosshow
source /opt/ros/kinetic/setup.bash
./ros-install-this

Usage

If you installed it to the system:

rosshow <topicname>

If you're using it from a catkin workspace:

rosrun rosshow rosshow <topicname>

Most visualizations use Unicode Braille characters to render visualizations. If your terminal supports only ASCII, you can use the -a option for a purely ASCII-art render:

rosshow -a <topicname>

You can also force 1-bit, 4-bit, or 24-bit color modes if your terminal type is not detected correctly. You may need these when using rosshow inside of a screen.

rosshow -c1 <topicname>
rosshow -c4 <topicname>
rosshow -c24 <topicname>

Screenshots

sensor_msgs/PointCloud2

You can rotate and tilt with the arrow keys, and zoom with the +/- keys. This has been tested with Velodyne data. PointClouds from devices that don't have "x", "y", and "z" fields are not supported.

screenshot

sensor_msgs/Image, sensor_msgs/CompressedImage

screenshot

sensor_msgs/LaserScan

You can zoom with the +/- keys.

screenshot

sensor_msgs/Imu

screenshot

sensor_msgs/NavSatFix

The NavSatFix visualization fetches map tiles from OpenStreetMaps, so your machine or robot needs to have internet access to be able to view those. Otherwise, you'll still be able to see a trace of points.

screenshot

The ASCII-only "-a" option works for all types. Here's what the NavSatFix message looks like on pure ASCII:

screenshot

std_msgs/Int32, std_msgs/Float32, etc.

For most std_msgs numeric types you will get a time series plot.

screenshot

Full list of supported types

nav_msgs

  • nav_msgs/Odometry
  • nav_msgs/Path

std_msgs

  • std_msgs/Bool
  • std_msgs/Float32
  • std_msgs/Float64
  • std_msgs/Int8
  • std_msgs/Int16
  • std_msgs/Int32
  • std_msgs/Int64
  • std_msgs/UInt8
  • std_msgs/UInt16
  • std_msgs/UInt32
  • std_msgs/UInt64

sensor_msgs

  • sensor_msgs/CompressedImage
  • sensor_msgs/FluidPressure
  • sensor_msgs/Illuminance
  • sensor_msgs/Image
  • sensor_msgs/Imu
  • sensor_msgs/LaserScan
  • sensor_msgs/NavSatFix
  • sensor_msgs/PointCloud2
  • sensor_msgs/Range
  • sensor_msgs/RelativeHumidity
  • sensor_msgs/Temperature
You can’t perform that action at this time.