Skip to content

thomasddn/qbusmqtt

Repository files navigation

QBUSMQTT

Exposes states and events of the Qbus Home Automation system to an MQTT broker, and allows you to control it through MQTT. The API at https://github.com/Qbus-iot/qbusmqttapi is an ideal match for this.

QBUSMQTT is also available as a Home Assistant app: https://github.com/thomasddn/home-assistant-addons.

GitHub release (with filter)

Supports amd64 Architecture Supports arm Architecture Supports arm64 Architecture Supports i386 Architecture

🥤 Snack-fueled coding

You know what goes great with open-source coding? Snacks! If my project helped you out, maybe throw a little something my way so my potato chips and Coca-Cola stash doesn't run out!

ko-fi sponsor github sponsor

🛠️ Setup

Prerequisites

Important

QBUSMQTT and the controller(s) must be in the same subnet.

Installation

  1. Create docker-compose.yaml
  2. Adjust environment variables as needed
  3. Start the container: docker compose up -d

Example docker-compose.yaml:

services:
  qbusmqtt:
    image: thomasddn/qbusmqtt:latest
    container_name: qbusmqtt
    restart: unless-stopped
    network_mode: host          # Must be host so it can discover the controller
    volumes:
      - './data:/opt/qbusmqttgw/data'
    environment:
      MQTT_HOST: 192.168.0.123
      MQTT_PORT: 1883
      MQTT_USER: user
      MQTT_PWD: secret
      TZ: Europe/Brussels

Configuration

Key Required Default value Description
MQTT_HOST Y <empty> The IP or host name of the MQTT broker.
MQTT_PORT N 1883 The port of the MQTT broker.
MQTT_USER N <empty> The username to connect to the MQTT broker.
MQTT_PWD N <empty> The password to connect to the MQTT broker.

🏠 Home Assistant

QBUSMQTT is commonly used as the bridge between a Qbus controller and Home Assistant through MQTT. In this setup, the gateway publishes Qbus states and events to MQTT topics and listens for MQTT commands, so Home Assistant can both monitor and control your Qbus installation using its MQTT and Qbus integrations.

Data flow is bidirectional end-to-end:

  • Qbus events and state changes flow from the controller to the gateway, then to the MQTT broker, and finally to Home Assistant.
  • Commands from Home Assistant flow back through MQTT to the gateway, which forwards them to the Qbus Controller.

Note

If you are running Home Assistant OS (HAOS), use the Home Assistant app instead.

ha-docker-architecture

🗣️ Remarks

⚠️ This is not officially supported by Qbus.

About

Qbus 2 MQTT

Topics

Resources

License

Stars

Watchers

Forks

Sponsor this project

Contributors