Skip to main content

Visualizer for robot logger

Project description

🤖 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 with pixi

You can also run the application using pixi:

pixi run robot-log-visualizer

See the pixi homepage: pixi.

🐍 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

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

robot_log_visualizer-0.14.1.tar.gz (204.4 kB view details)

Uploaded Source

Built Distribution

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

robot_log_visualizer-0.14.1-py3-none-any.whl (134.8 kB view details)

Uploaded Python 3

File details

Details for the file robot_log_visualizer-0.14.1.tar.gz.

File metadata

  • Download URL: robot_log_visualizer-0.14.1.tar.gz
  • Upload date:
  • Size: 204.4 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.9.25

File hashes

Hashes for robot_log_visualizer-0.14.1.tar.gz
Algorithm Hash digest
SHA256 ec78a9541bbdc2f4b431310696978992dd0067d00769854140d9c702fa942be7
MD5 c2aed154b217e60c20abedd39ef9bdae
BLAKE2b-256 0fd0306210e39047a1b5a69b2ad1e0e16bc99a9e9951004582d89187e567b324

See more details on using hashes here.

File details

Details for the file robot_log_visualizer-0.14.1-py3-none-any.whl.

File metadata

File hashes

Hashes for robot_log_visualizer-0.14.1-py3-none-any.whl
Algorithm Hash digest
SHA256 6b015181e42ee78472526137b9999434f831370a0c96f19d96e70912cb707cad
MD5 9e067a278ecadadf95aebb224a722918
BLAKE2b-256 86d85d8380f50f8b14e50642c6fb07b8a04c6de82c7ec611d1e72711c4076f61

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