rosthrottle package from rosthrottle repo

rosthrottle

Package Summary

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

Repository Summary

Checkout URI https://github.com/UTNuclearRoboticsPublic/rosthrottle.git
VCS Type git
VCS Version master
Last Updated 2019-05-06
Dev Status MAINTAINED
Released RELEASED

Package Description

ROS Python package for throttling ROS topics programatically in Python. Sits on top of the ros_comm topic_tools throttle utility.

Additional Links

Maintainers

  • Carson Schubert

Authors

  • Carson Schubert

rosthrottle

ROS Python package for throttling ROS nodes programatically in Python. Sits on top of ros_comm topic_tools throttle utility.

Use

The rosthrottle package provides two types of throttlers: MessageThrottle and Bandwidth Throttle.

MessageThrottle

Used to throttle a topic on a message frequency basis. Example:

from rosthrottle import MessageThrottle

intopic = 'in'
outtopic = 'out_throttled'
rate = 1.0
bt = MessageThrottle(intopic, outtopic, rate)
# start throttler process
pid = bt.start()
# update throttler configuration
bt.update(rate=5.0)
# kill throttler
bt.stop()

BandwidthThrottle

Used to throttle a topic on a bandwidth basis. Example:

from rosthrottle import BandwidthThrottle

intopic = 'in'
outtopic = 'out_throttled'
bandwidth = 1024
window = 1.0
bt = BandwidthThrottle(intopic, outtopic, bandwidth, window)
# start throttler process
pid = bt.start()
# update throttler configuration
bt.update(bandwidth=100)
# kill throttler
bt.stop()

See src/rosthrottle/tests/ for additional examples and documentation.

CHANGELOG

Changelog for package rosthrottle

Forthcoming

  • Add BSD license. Update README. Better docstrings. Update package.xml
  • remove unnecessary comment in bandwidth_test
  • add cleanup test. better testing README. add setup script for testing.
  • Add cleanup function to ensure throttle process death on program exit
  • Remove incorrect docstring line in update function
  • Fix README
  • add gitignore, finalize docs and tests
  • v 0.1 of rosthrottle
  • Initial commit
  • Contributors: Carson Schubert

Wiki Tutorials

See ROS Wiki Tutorials for more details.

Source Tutorials

Not currently indexed.

Package Dependencies

System Dependencies

No direct system dependencies.

Dependant Packages

No known dependants.

Launch files

No launch files found

Messages

No message files found.

Services

No service files found

Plugins

No plugins found.

Recent questions tagged rosthrottle at answers.ros.org