🤖 robot-log-visualizer

robot-log-visualizer implements a python visualizer to display the data logged with YarpRobotLoggerDevice application.

📝 Install

Please follow one of the following methods to use the software

Install with conda (recommended)

Assuming that you have conda installed, you can create a new environment and install the robot-log-visualizer with the following commands:

conda create -n visualizer-env
conda activate visualizer-env

and you can install the robot-log-visualizer with the following command

conda install -c robotology robot-log-visualizer

🐍 Install from pip with apt python

Install python3, if not installed (in Ubuntu 20.04):

sudo apt install python3.8 python3-virtualenv swig

Create a virtual environment and activate it. For example:

python3 -m venv visualizer-env
. visualizer-env/bin/activate

Inside the virtual environment, install the application from pip:

pip install robot-log-visualizer

👷 Install the latest version (not recommended)

If you want to use the latest feature of the robot-log-visualizer you can install it with the following command

python -m pip install git+https://github.com/ami-iit/robot-log-visualizer.git

🏃 Usage

Once you have installed the robot-log-visualizer you can run it from the terminal

robot-log-visualizer.webm

You can navigate the dataset thanks to the slider or by pressing Ctrl-f and Ctrl-b to move forward and backward.

Important

robot-log-visualizer only supports reading .mat file version 7.3 or newer.

💡 Environment variables

robot-log-visualizer looks for the model in the folders pointed by one of the following environment variables: GAZEBO_MODEL_PATH, ROS_PACKAGE_PATH, AMENT_PREFIX_PATH Please remember to add your model folder to one of these environment variables. For instance, if you have a model in the folder ~/my-models you can add it to the GAZEBO_MODEL_PATH with the following command

export GAZEBO_MODEL_PATH=${GAZEBO_MODEL_PATH}:~/my-models

Where ~/my-models is the path to your models folder that is structured as follows

tree ~/my-models
~/my-models
├── model1
│   ├── model.config
│   └── model.urdf
└── model2
    ├── model.config
    └── model.urdf

And the name of the robot stored in the mat file is model1 or model2.

🐛 Bug reports and support

All types of issues are welcome.

📝 License

Materials in this repository are distributed under the following license:

All software is licensed under the BSD 3-Clause License. See LICENSE file for details.

🧑‍💻 Maintainer

• Giulio Romualdi (@GiulioRomualdi)