Skip to content

README.md

Latest commit

 

History

History
90 lines (65 loc) · 3.46 KB

README.md

File metadata and controls

90 lines (65 loc) · 3.46 KB
Raw

Venus OS Integration Patterns

License Python Tests PRs Welcome Last Commit

Reference implementations for common Victron Venus OS integrations. Each pattern is a complete, working example you can adapt for your own setup.

Quick Start

# Clone this repo
git clone https://github.com/victron-venus/venus-os-integration-patterns.git

# Navigate to a pattern
cd venus-os-integration-patterns/patterns/mqtt-to-dbus

# Review the README, then start with docker-compose
docker-compose up -d

Patterns

Pattern Description Complexity Dependencies
mqtt-to-dbus Subscribe to MQTT topic, register D-Bus service, publish values Beginner paho-mqtt, dbus-python, systemd/docker
dbus-to-mqtt Monitor D-Bus path changes, publish to MQTT Beginner dbus-python, paho-mqtt
http-api-wrapper FastAPI wrapper around D-Bus for REST access Intermediate fastapi, dbus-python, uvicorn
scheduled-control Time-based inverter mode switching via cron Beginner python-cron, dbus-python
ha-automation Home Assistant automation YAML for Venus OS entities Beginner Home Assistant, MQTT

Architecture Overview

graph TD
    %% External systems
    HA[Home Assistant] -->|MQTT| MQTT[(MQTT Broker)]
    Extern[External Systems] -->|MQTT| MQTT
    
    %% Integration patterns
    MQTT -->|mqtt-to-dbus| M2D[MQTT → D-Bus Bridge]
    M2D --> DBUS[(D-Bus System Bus)]
    
    DBUS -->|dbus-to-mqtt| D2M[D-Bus → MQTT Bridge]
    D2M --> MQTT
    
    DBUS -->|http-api-wrapper| API[FastAPI REST Wrapper]
    API --> Client[REST Clients]
    
    Cron[Cron Scheduler] -->|scheduled-control| SC[Scheduled Control]
    SC --> DBUS
    
    HA -.->|ha-automation| DBUS
    
    %% Venus OS Core
    DBUS --> Venus[Venus OS Core<br/>MultiPlus, MPPT, BMS, etc.]
    Venus --> DBUS
    
    style MQTT fill:#f9f,stroke:#333
    style DBUS fill:#bbf,stroke:#333
    style Venus fill:#bfb,stroke:#333
Loading

Requirements

  • Venus OS (Cerbo GX, Raspberry Pi with Venus OS, or Venus OS Docker)
  • MQTT Broker (Mosquitto, EMQX, or cloud broker)
  • Python 3.10+ for Python patterns
  • Docker (optional, for containerized deployment)

Contributing

  1. Fork the repository
  2. Create a new pattern directory under patterns/
  3. Include: README.md, working code, docker-compose.yml, tests/
  4. Add entry to the patterns table above
  5. Submit a PR

License

MIT License — see LICENSE for details.

Related Projects