Request to implement documentation for a new Integration (Qbus) (#36294)

* Add documentation for Qbus integration

* end

* Revert "end"

This reverts commit a70d21586c6feb441cc00df178d3b8985aded269.

* Update files as requested by coderabbitai

* Update source/_integrations/qbus.markdown

Co-authored-by: c0ffeeca7 <38767475+c0ffeeca7@users.noreply.github.com>

* Update source/_integrations/qbus.markdown

Co-authored-by: c0ffeeca7 <38767475+c0ffeeca7@users.noreply.github.com>

* Update source/_integrations/qbus.markdown

Co-authored-by: c0ffeeca7 <38767475+c0ffeeca7@users.noreply.github.com>

* Update source/_integrations/qbus.markdown

Co-authored-by: c0ffeeca7 <38767475+c0ffeeca7@users.noreply.github.com>

* Update qbus.markdown

Just added our Toggle sitches as device

* Update qbus.markdown

Updated ha_release

* Update qbus.markdown

Changed description of Switch

---------

Co-authored-by: Koen <ks@qbus.be>
Co-authored-by: c0ffeeca7 <38767475+c0ffeeca7@users.noreply.github.com>
This commit is contained in:
qbus-iot 2025-01-15 16:38:51 +01:00 committed by GitHub
parent 38e8c87e16
commit 85a45abb69
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
2 changed files with 78 additions and 0 deletions

View File

@ -668,6 +668,7 @@ source/_integrations/pvoutput.markdown @frenck
source/_integrations/pvpc_hourly_pricing.markdown @azogue
source/_integrations/pyload.markdown @tr4nt0r
source/_integrations/qbittorrent.markdown @geoffreylagaisse @finder39
source/_integrations/qbus.markdown @Qbus-iot @thomasddn
source/_integrations/qingping.markdown @bdraco
source/_integrations/qld_bushfire.markdown @exxamalte
source/_integrations/qnap.markdown @disforw

View File

@ -0,0 +1,77 @@
---
title: Qbus
description: Instructions on how to integrate your Qbus installation with Home Assistant.
ha_category:
- Switch
ha_platforms:
- switch
ha_iot_class: Local Push
ha_codeowners:
- '@Qbus-iot'
- '@thomasddn'
ha_release: 2025.1
ha_domain: qbus
ha_integration_type: device
ha_config_flow: true
---
The **Qbus** {% term integration %} allows you to integrate your [Qbus Control](https://www.qbus.be) into Home Assistant. **Qbus** is a Belgian manufacturer of Home Automation systems.
## Prerequisites
This integration communicates with a **Qbus** controller over an MQTT server.
The controllers cannot communicate directly with MQTT. Therefore, you need to install the Qbus gateway before enabling this integration. The Qbus gateway is a software tool that runs on all Linux platforms. It can be installed by running a script or a Docker container. For detailed instructions, please refer to the [Qbus MQTT Gateway documentation](https://github.com/Qbus-iot/qbus-mqttgw).
For information on setting up Home Assistant with a **Qbus** controller, refer to the [Qbus documentation](https://iot.qbus.be/). The documentation is currently only available in Dutch, but translations are planned for the future.
Once the Qbus controller is connected to the MQTT server, you need to set up an MQTT client in Home Assistant to enable communication between Home Assistant and your **Qbus** system. This client should connect to the same MQTT Server as your Qbus controller. For detailed instructions, refer to the [MQTT integration documentation](https://www.home-assistant.io/integrations/mqtt/).
{% include integrations/config_flow.md %}
## Supported devices
There is currently support for the following **Qbus** products within Home Assistant:
- **CTD 3.0**: main controller.
- **CTD 3.5**: main controller.
- **Toggle**: toggle outputs on controllers.
## Available entities
- **Switch**: toggles on/off outputs.
## Removing the integration
This integration follows standard integration removal. No extra steps are required.
{% include integrations/remove_device_service.md %}
## Data updates
All data from **Qbus** entities are pushed to Home Assistant over MQTT.
## Known limitations
The integration does not provide a way to update the firmware on the devices. This can only be done with the configuration software System Manager.
## Troubleshooting
### Cant set up the device
#### Symptom: "No devices are discovered"
When trying to set up the integration, no devices are discovered.
##### Description
This means that the integration did not receive a valid configuration from the gateway.
##### Resolution
To resolve this issue, try the following steps:
1. Make sure your controller is online and not connected to System Manager.
2. Make sure you have an MQTT broker running.
3. Make sure that the gateway software is up and running (see [Prerequisites](#prerequisites)) and connected to the broker.
4. Make sure you have an MQTT client integration (see [Prerequisites](#prerequisites)) connected to the broker.