Skip to main content

ZeroROS middleware

Project description

Zero-dependency ROS-like middleware for Python

This library is intended to be used for small projects that require a simple middleware for communication between processes. It is not intended to be a replacement for ROS.

PyPI Wheels platforms Downloads License

Why ZeroROS?

See these discussions in ROS Discourse and this one in reddit/ROS.

Installation

Use pip to install the library:

pip install zeroros

Usage

The library is composed of three main classes: Publisher, Subscriber and MessageBroker.

MessageBroker

The MessageBroker class is used to create a message broker that can be used by publishers and subscribers to communicate with each other.

from zeroros import MessageBroker

broker = MessageBroker()

Publisher

The Publisher class is used to publish messages to a topic. The constructor takes two arguments: the topic name and the message type. The topic name is a string, while the message type is a Python class. The message type is used to serialize and deserialize messages.

from zeroros import Publisher

pub = Publisher("topic_name", String)
pub.publish("Hello world!")

Subscriber

The Subscriber class is used to subscribe to a topic and receive messages. The constructor takes two arguments: the topic name and the message type. The topic name is a string, while the message type is a Python class. The message type is used to serialize and deserialize messages.

import time
from zeroros import Subscriber

def callback(msg):
    print(msg)

sub = Subscriber("topic_name", String, callback)
while True:
    # Do something else
    time.sleep(1)

# Stop the subscriber
sub.stop()

Messages

The library comes with a few built-in messages that can be used out of the box. The following messages are available:

  • std_msgs.String
  • std_msgs.Int
  • std_msgs.Float
  • std_msgs.Bool
  • std_msgs.Header
  • geometry_msgs.Vector3
  • geometry_msgs.Vector3Stamped
  • geometry_msgs.Twist
  • geometry_msgs.Quaternion
  • geometry_msgs.Pose
  • geometry_msgs.PoseStamped
  • geometry_msgs.PoseWithCovariance
  • geometry_msgs.TwistWithCovariance
  • nav_msgs.Odometry
  • nav_msgs.Path
  • sensors_msgs.LaserScan
  • More to come...

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

zeroros-1.0.9.tar.gz (11.8 kB view details)

Uploaded Source

File details

Details for the file zeroros-1.0.9.tar.gz.

File metadata

  • Download URL: zeroros-1.0.9.tar.gz
  • Upload date:
  • Size: 11.8 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.1.1 CPython/3.12.7

File hashes

Hashes for zeroros-1.0.9.tar.gz
Algorithm Hash digest
SHA256 453eb8e82aa74082edcbc28cff374caaac31fd0b9a87e6ee49282cd2bea55896
MD5 4324a153800fd9a6dce01d5eb1f66625
BLAKE2b-256 09d79a88743de831ccc95227883c1385b3dde5fb5f3de3fbf6e51da2ba4dcc7e

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