Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/nick-adams-au/5500shac-cbus2mqtt
Push and pull CBus events from a 5500SHAC to MQTT
https://github.com/nick-adams-au/5500shac-cbus2mqtt
cbus clipsal-cbus home-assistant lua mosquitto mqtt
Last synced: 3 months ago
JSON representation
Push and pull CBus events from a 5500SHAC to MQTT
- Host: GitHub
- URL: https://github.com/nick-adams-au/5500shac-cbus2mqtt
- Owner: Nick-Adams-AU
- License: mit
- Created: 2020-03-04T02:17:22.000Z (almost 5 years ago)
- Default Branch: master
- Last Pushed: 2022-08-28T04:18:42.000Z (over 2 years ago)
- Last Synced: 2023-05-22T16:20:15.727Z (over 1 year ago)
- Topics: cbus, clipsal-cbus, home-assistant, lua, mosquitto, mqtt
- Language: Lua
- Size: 18.6 KB
- Stars: 6
- Watchers: 5
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# 5500SHAC-Cbus2MQTT
Push and pull Cbus events from a 5500SHAC to MQTT.
I use this to integrate my Cbus installation with [Home Assistant](https://www.home-assistant.io/).
[Based on cgateweb by the1laz](https://github.com/the1laz/cgateweb).
## Similar projects:
- [acMqtt](https://github.com/autoSteve/acMqtt) from autoSteve. Includes Home Assistant auto-discovery by using Cbus tags. Very cool!
- [cbus](https://github.com/micolous/cbus) from micolous.
## Install:
1. Log into your 5500SHAC, navigate to the "Scripting" section and install the two resident scripts and the event based script into their relevant sections.
2. Update your MQTT server hostname, username and password details in the resident scripts.
3. Activate the scripts.
4. Tag all the objects with the "All" keyword to events are pushed to the cbus2mqtt script. You can use this script to easily do this
```lua
for i = 0,255 do
grp.addtags('0/56/'..i, 'All')
end
```
## Examples
In these examples, #1, #2 and #3 represent the Cbus network number, application number, and the group number.
### Updates get published on these topics:
- cbus/read/#1/#2/#3/state - ON/OFF gets published to these topics if the group is turned ON/OFF.
- cbus/read/#1/#2/#3/level - The level of the group gets published to these topics. 0-255
### Publish to these topics to control a group address:
- cbus/write/#1/#2/#3/switch - Publish ON/OFF to these topics to turn lights on/off
- cbus/write/#1/#2/#3/ramp - Publish a CBus level (0-255) to ramp to. Optionally add a comma then a time in seconds (e.g. 50,4 or 128,2).
- cbus/write/#1/#2/#3/measurement - Publish a measurement value (i.e. temperature) to a Cbus measurement application. Values are divided by 10 so a MQTT value of 301 becomes 30.1 when published to Cbus.
### This requests an update from all addresses:
- cbus/write/#1/#2//getall - Current values get published on the cbus/read topics. This is handy to periodically "re-sync" your MQTT subscribers on reboot or if they miss an update.
## Home Assistant MQTT config
Your Home Assistant MQTT light, switch, fan or cover entities should look like this:
```yaml
mqtt:
switch:
# Switch
- name: Bathroom
state_topic: 'cbus/read/254/56/1/state'
command_topic: 'cbus/write/254/56/1/switch'
payload_on: 'ON'
payload_off: 'OFF'
unique_id: mqtt_1
# Dimmer
- name: Bedroom
state_topic: 'cbus/read/254/56/2/state'
command_topic: 'cbus/write/254/56/2/switch'
brightness_state_topic: 'cbus/read/254/56/2/level'
brightness_command_topic: 'cbus/write/254/56/2/ramp'
payload_on: 'ON'
payload_off: 'OFF'
on_command_type: 'brightness'
unique_id: mqtt_2
fan:
# Fan
- name: Bedroom fan
state_topic: 'cbus/read/254/56/3/state'
command_topic: 'cbus/write/254/56/3/switch'
percentage_state_topic: 'cbus/read/254/56/3/level'
percentage_command_topic: 'cbus/write/254/56/3/ramp'
speed_range_max: 255
payload_on: 'ON'
payload_off: 'OFF'
optimistic: true
unique_id: mqtt_3
cover:
# Cover
- name: Outdoor blind - south
position_topic: 'cbus/read/254/56/4/level'
set_position_topic: 'cbus/write/254/56/4/ramp'
position_open: 255
position_closed: 0
payload_open: 255
payload_close: 0
state_open: 255
state_closed: 0
device_class: blind
command_topic: 'cbus/write/254/56/4/ramp'
unique_id: mqtt_4
```