Package Summary

Tags No category tags.
Version 0.5.9
License BSD
Build type CATKIN
Use RECOMMENDED

Repository Summary

Checkout URI https://github.com/baalexander/rospy_message_converter.git
VCS Type git
VCS Version master
Last Updated 2024-04-26
Dev Status MAINTAINED
CI status Continuous Integration
Released RELEASED
Tags No category tags.
Contributing Help Wanted (0)
Good First Issues (0)
Pull Requests to Review (0)

Package Description

Converts between Python dictionaries and JSON to rospy messages.

Additional Links

Maintainers

  • Martin G√ľnther

Authors

  • Brandon Alexander

rospy_message_converter

Rospy_message_converter is a lightweight ROS package and Python library to convert from Python dictionaries and JSON messages to rospy messages, and vice versa.

ROS 1 and ROS 2 branches

ROS 1 users should use the master branch. ROS 2 users should use the appropriate branch for their distro (foxy/galactic/humble/rolling/...).

Usage

Convert a dictionary to a ROS message

from rospy_message_converter import message_converter
from std_msgs.msg import String
dictionary = { 'data': 'Howdy' }
message = message_converter.convert_dictionary_to_ros_message('std_msgs/String', dictionary)

Convert a ROS message to a dictionary

from rospy_message_converter import message_converter
from std_msgs.msg import String
message = String(data = 'Howdy')
dictionary = message_converter.convert_ros_message_to_dictionary(message)

Convert JSON to a ROS message

from rospy_message_converter import json_message_converter
from std_msgs.msg import String
json_str = '{"data": "Hello"}'
message = json_message_converter.convert_json_to_ros_message('std_msgs/String', json_str)

Convert a ROS message to JSON

from rospy_message_converter import json_message_converter
from std_msgs.msg import String
message = String(data = 'Hello')
json_str = json_message_converter.convert_ros_message_to_json(message)

Test

To run the tests:

catkin_make test

pre-commit Formatting Checks

This repo has a pre-commit check that runs in CI. You can use this locally and set it up to run automatically before you commit something. To install, use pip:

pip3 install --user pre-commit

To run over all the files in the repo manually:

pre-commit run -a

To run pre-commit automatically before committing in the local repo, install the git hooks:

pre-commit install

License

Project is released under the BSD license.

GitHub actions - Continuous Integration

Build Status

ROS Buildfarm

binary deb source deb devel doc
noetic Build Status Build Status Build Status Build Status
CHANGELOG

Change Log

0.5.9 (2022-09-12)

  • Fix flake8 errors
  • Re-format code using black
  • package.xml: Add missing build_export_depend
  • Fix EOF and trailing whitespace
  • Add pre-commit config
  • README: Add note about branches
  • pass down log_level to helper functions (#60)
  • Declare file encoding This is necessary on ROS Melodic (Python2), because I have added a non-ASCII character (u umlaut) in my last commit.
  • Add LICENSE file and license headers
  • Contributors: Martin G

Wiki Tutorials

See ROS Wiki Tutorials for more details.

Source Tutorials

Not currently indexed.

Dependant Packages

No known dependants.

Recent questions tagged rospy_message_converter at Robotics Stack Exchange