# juliodltv/zros architecture

> Architecture diagram of the GitHub repository juliodltv/zros, generated by GitDiagram from its file tree, README and a sample of source files (last updated 2026-10-07). It is an AI-made overview: check details against the source.

- Interactive diagram: https://gitdiagram.com/juliodltv/zros
- Repository: https://github.com/juliodltv/zros

## Overview

ZROS is a lightweight Python messaging library with a ROS-like node API, using ZeroMQ for asynchronous topic transport. The main workflow is that application nodes publish and subscribe to topics through a shared broker; node timers and callbacks drive work. Built-in command-line tools publish, echo, and report node status, while optional OpenCV bridges encode and decode image messages. A graph visualizer is present under `future/`. The graph follows the sampled runtime and README; no other repository files were inspected.

Main entry points: [`zros/zros.py`](https://github.com/juliodltv/zros/blob/main/zros/zros.py) (Node API), [`zros/zros_pub.py`](https://github.com/juliodltv/zros/blob/main/zros/zros_pub.py) (Publish CLI), [`zros/zros_echo.py`](https://github.com/juliodltv/zros/blob/main/zros/zros_echo.py) (Echo CLI), [`zros/zros_status.py`](https://github.com/juliodltv/zros/blob/main/zros/zros_status.py) (Status CLI)

## Diagram (Mermaid)

```mermaid
flowchart TD

subgraph group_runtime["Node Runtime"]
  node_node["Node API<br/>[zros.py]"]
  node_publisher["Publisher<br/>[zros.py]"]
  node_timer["Timer<br/>[zros.py]"]
end

subgraph group_transport["Topic Transport"]
  node_broker["ZROS broker<br/>[zroscore.py]"]
end

subgraph group_tools["CLI and Discovery"]
  node_pubcli["Publish CLI<br/>[zros_pub.py]"]
  node_echocli["Echo CLI<br/>[zros_echo.py]"]
  node_statuscli["Status CLI<br/>[zros_status.py]"]
  node_graphviz["Graph visualizer<br/>[zros_graph.py]"]
end

subgraph group_images["Image Bridges"]
  node_cvbridge["Raw CV bridge<br/>[zros.py]"]
  node_compressed["Compressed CV bridge<br/>[zros.py]"]
end

node_app(("Python application"))

node_app -->|"uses API"| node_node
node_node -->|"creates"| node_publisher
node_node -->|"creates"| node_timer
node_node -->|"connects sockets"| node_broker
node_pubcli -->|"creates node"| node_node
node_pubcli -->|"publishes payload"| node_publisher
node_echocli -->|"subscribes via"| node_node
node_statuscli -->|"subscribes via"| node_node
node_graphviz -->|"subscribes via"| node_node
node_node -->|"broadcasts graph"| node_publisher
node_app -->|"encodes images"| node_cvbridge
node_app -->|"compresses images"| node_compressed

click node_node "https://github.com/juliodltv/zros/blob/main/zros/zros.py"
click node_publisher "https://github.com/juliodltv/zros/blob/main/zros/zros.py"
click node_timer "https://github.com/juliodltv/zros/blob/main/zros/zros.py"
click node_broker "https://github.com/juliodltv/zros/blob/main/zros/zroscore.py"
click node_pubcli "https://github.com/juliodltv/zros/blob/main/zros/zros_pub.py"
click node_echocli "https://github.com/juliodltv/zros/blob/main/zros/zros_echo.py"
click node_statuscli "https://github.com/juliodltv/zros/blob/main/zros/zros_status.py"
click node_graphviz "https://github.com/juliodltv/zros/blob/main/future/zros_graph.py"
click node_cvbridge "https://github.com/juliodltv/zros/blob/main/zros/zros.py"
click node_compressed "https://github.com/juliodltv/zros/blob/main/zros/zros.py"

classDef toneNeutral fill:#f8fafc,stroke:#334155,stroke-width:1.5px,color:#0f172a
classDef toneBlue fill:#dbeafe,stroke:#2563eb,stroke-width:1.5px,color:#172554
classDef toneAmber fill:#fef3c7,stroke:#d97706,stroke-width:1.5px,color:#78350f
classDef toneMint fill:#dcfce7,stroke:#16a34a,stroke-width:1.5px,color:#14532d
classDef toneRose fill:#ffe4e6,stroke:#e11d48,stroke-width:1.5px,color:#881337
classDef toneIndigo fill:#e0e7ff,stroke:#4f46e5,stroke-width:1.5px,color:#312e81
classDef toneTeal fill:#ccfbf1,stroke:#0f766e,stroke-width:1.5px,color:#134e4a
class node_node,node_publisher,node_timer toneBlue
class node_broker toneAmber
class node_pubcli,node_echocli,node_statuscli,node_graphviz toneMint
class node_cvbridge,node_compressed toneRose
class node_app toneIndigo
```

## Components

### Node Runtime

- [Node API](https://github.com/juliodltv/zros/blob/main/zros/zros.py): `zros/zros.py`
- [Publisher](https://github.com/juliodltv/zros/blob/main/zros/zros.py): `zros/zros.py`
- [Timer](https://github.com/juliodltv/zros/blob/main/zros/zros.py): `zros/zros.py`

### Topic Transport

- [ZROS broker](https://github.com/juliodltv/zros/blob/main/zros/zroscore.py): `zros/zroscore.py`

### CLI and Discovery

- [Publish CLI](https://github.com/juliodltv/zros/blob/main/zros/zros_pub.py): `zros/zros_pub.py`
- [Echo CLI](https://github.com/juliodltv/zros/blob/main/zros/zros_echo.py): `zros/zros_echo.py`
- [Status CLI](https://github.com/juliodltv/zros/blob/main/zros/zros_status.py): `zros/zros_status.py`
- [Graph visualizer](https://github.com/juliodltv/zros/blob/main/future/zros_graph.py): `future/zros_graph.py`

### Image Bridges

- [Raw CV bridge](https://github.com/juliodltv/zros/blob/main/zros/zros.py): `zros/zros.py`
- [Compressed CV bridge](https://github.com/juliodltv/zros/blob/main/zros/zros.py): `zros/zros.py`

### Other components

- **Python application**

## Connections

- Python application → Node API: uses API (evidence: `README.md`)
- Node API → Publisher: creates (evidence: `zros/zros.py`)
- Node API → Timer: creates (evidence: `zros/zros.py`)
- Node API → ZROS broker: connects sockets (evidence: `zros/zros.py`)
- Publish CLI → Node API: creates node (evidence: `zros/zros_pub.py`)
- Publish CLI → Publisher: publishes payload (evidence: `zros/zros_pub.py`)
- Echo CLI → Node API: subscribes via (evidence: `zros/zros_echo.py`)
- Status CLI → Node API: subscribes via (evidence: `zros/zros_status.py`)
- Graph visualizer → Node API: subscribes via (evidence: `future/zros_graph.py`)
- Node API → Publisher: broadcasts graph (evidence: `zros/zros.py`)
- Python application → Raw CV bridge: encodes images (evidence: `README.md`)
- Python application → Compressed CV bridge: compresses images (evidence: `README.md`)
