Skip to main content

ZROS: ZeroMQ ROS-like framework

Project description

ZROS: A fast, lightweight ROS-like library

PyPI version License: MIT Python versions

zros_logo

ZROS is a fast, lightweight ROS-like library designed to bring the ease of ROS-2 to Python projects that require minimal overhead and high performance, using ZeroMQ for fast, asynchronous communication.

It provides a simple, pure Python alternative for robotic applications, computer vision pipelines, and distributed systems where a full ROS installation might be overkill.

Key Features

  • Fast & Lightweight: Built on top of ZeroMQ, ensuring low-latency communication between nodes.
  • ROS-like API: Uses familiar concepts like Node, Publisher, Subscriber, Timer, and spin() making it easy for ROS-2 developers to adapt.
  • No Complex Build System: Pure Python. No catkin_make, no colcon build, no source setup.bash. Just run your Python scripts.
  • Computer Vision Ready: Includes a built-in CvBridge for seamless OpenCV image transport.

Installation

From PyPI (Recommended)

uv venv --python 3.12
uv pip install zros --upgrade

From Source

git clone https://github.com/juliodltv/zros.git
cd zros
uv sync

Quick Start

Create a Publisher (publisher.py)

from zros import Node, CvBridge
import cv2

class CameraPublisher(Node):
    def __init__(self):
        super().__init__("camera_pub")
        self.pub = self.create_publisher("video_topic")
        self.bridge = CvBridge()
        self.cap = cv2.VideoCapture(0)
        self.create_timer(1/60, self.timer_callback)

    def timer_callback(self):
        ret, frame = self.cap.read()
        if ret:
            # Payload is a dictionary
            msg = {
                "image": self.bridge.cv2_to_msg(frame),
                "info": "My Camera Frame"
            }
            self.pub.publish(msg)

if __name__ == "__main__":
    CameraPublisher().spin()

Create a Subscriber (subscriber.py)

from zros import Node, CvBridge
import cv2

class VideoSubscriber(Node):
    def __init__(self):
        super().__init__("video_sub")
        self.bridge = CvBridge()
        self.create_subscriber("video_topic", self.callback)

    def callback(self, payload):
        img = self.bridge.msg_to_cv2(payload["image"])
        cv2.imshow("Video", img)
        cv2.waitKey(1)

if __name__ == "__main__":
    VideoSubscriber().spin()

Running Examples

You can find another examples in the examples/ directory.

# Terminal 1
uv run zroscore

# Terminal 2
uv run publisher.py

# Terminal 3
uv run subscriber.py

Documentation

For detailed usage instructions, please refer to the ZROS Documentation.

Citation

@software{zros2026,
  author = {Julio De La Torre-Vanegas},
  title = {ZROS: A fast, lightweight ZeroMQ ROS-like library},
  year = {2026},
  url = {https://github.com/juliodltv/zros}
}

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

zros-0.1.4.tar.gz (8.4 kB view details)

Uploaded Source

Built Distribution

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

zros-0.1.4-py3-none-any.whl (8.6 kB view details)

Uploaded Python 3

File details

Details for the file zros-0.1.4.tar.gz.

File metadata

  • Download URL: zros-0.1.4.tar.gz
  • Upload date:
  • Size: 8.4 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for zros-0.1.4.tar.gz
Algorithm Hash digest
SHA256 96b77ef5bc612e85542a3f19493243f38605b0f2adcc3d1bdda2f35fbdd7f215
MD5 95cd749a7f1d268c06d475bdeadef489
BLAKE2b-256 191afa70efe7b9d4a1e71f32345cbe760af22dd7048daa330cd678f8513e5564

See more details on using hashes here.

File details

Details for the file zros-0.1.4-py3-none-any.whl.

File metadata

  • Download URL: zros-0.1.4-py3-none-any.whl
  • Upload date:
  • Size: 8.6 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for zros-0.1.4-py3-none-any.whl
Algorithm Hash digest
SHA256 9bc969afe7ec1da33eceb2e812dde889a78d77a51eec95f5773f491663f6dcd4
MD5 e52a910b4a83dd16d606ab140b361261
BLAKE2b-256 91417aa900a883634e7b7190efdd0a03275d7395fb7e532c25d383ae9d083476

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