https://github.com/thomasddn/qbusmqtt

Qbus 2 MQTT
https://github.com/thomasddn/qbusmqtt

qbus-home-automation

Last synced: about 1 month ago
JSON representation

Qbus 2 MQTT

• Host: GitHub
• URL: https://github.com/thomasddn/qbusmqtt
• Owner: thomasddn
• License: gpl-3.0
• Created: 2023-10-19T13:29:12.000Z (over 1 year ago)
• Default Branch: main
• Last Pushed: 2024-06-21T15:15:24.000Z (7 months ago)
• Last Synced: 2024-06-23T05:58:48.336Z (7 months ago)
• Topics: qbus-home-automation
• Language: Dockerfile
• Homepage:
• Size: 29 MB
• Stars: 7
• Watchers: 4
• Forks: 2
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • Funding: .github/FUNDING.yml
  • License: LICENSE

Awesome Lists containing this project

README

        
# QBUSMQTT

Exposes states and events of the Qbus Home Automation system to a MQTT broker.

It is also available as a Home Assistant add-on: https://github.com/thomasddn/home-assistant-addons.

[![GitHub release (with filter)][releases-shield]][releases]

![Supports amd64 Architecture][amd64-shield]

![Supports arm Architecture][arm-shield]

![Supports i386 Architecture][i386-shield]

## 🥤 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](https://ko-fi.com/img/githubbutton_sm.svg)](https://ko-fi.com/N4N7UZ6KN)

## 🛠️ Setup

### Prerequisites

- Qbus home automation system (hardware)

- MQTT broker (e.g. https://hub.docker.com/_/eclipse-mosquitto)

### Installation

1. Create docker-compose.yaml

1. Adjust [environment variables](#configuration) as needed

1. Start the container:  `docker compose up -d`

Example docker-compose.yaml:

```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

    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 | \ | The IP or host name of the MQTT broker. |

| MQTT_PORT | N | 1883 | The port of the MQTT broker. |

| MQTT_USER | N | \ | The username to connect to the MQTT broker. |

| MQTT_PWD | N | \ | The password to connect to the MQTT broker. |

## 🗣️ Remarks

:warning: This is **not** officially supported by Qbus.

[releases-shield]: https://img.shields.io/github/v/release/thomasddn/qbusmqtt?style=flat-square

[amd64-shield]: https://img.shields.io/badge/amd64-yes-green.svg?style=flat-square

[arm-shield]: https://img.shields.io/badge/arm-yes-green.svg?style=flat-square

[i386-shield]: https://img.shields.io/badge/i386-yes-green.svg?style=flat-square

[releases]: https://github.com/thomasddn/qbusmqtt/releases