From 48fb041798ea133d72f7d7941d0ffe5824ea5022 Mon Sep 17 00:00:00 2001 From: Roland Jax Date: Tue, 11 Feb 2025 19:44:26 +0100 Subject: [PATCH 1/4] doc/mqtt.md created --- doc/mqtt.md | 0 1 file changed, 0 insertions(+), 0 deletions(-) create mode 100644 doc/mqtt.md diff --git a/doc/mqtt.md b/doc/mqtt.md new file mode 100644 index 0000000..e69de29 From b7015d1ac764651993df0f7109d360f4a8f2b664 Mon Sep 17 00:00:00 2001 From: Roland Jax Date: Tue, 11 Feb 2025 22:35:36 +0100 Subject: [PATCH 2/4] first --- doc/mqtt.md | 52 ++++++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 52 insertions(+) diff --git a/doc/mqtt.md b/doc/mqtt.md index e69de29..3b7d9f1 100644 --- a/doc/mqtt.md +++ b/doc/mqtt.md @@ -0,0 +1,52 @@ +# mqtt interface + +The mqtt interface serves two purposes. +* Data is made available at regular intervals. +* Defined commands can be sent to the device. + +Every topic starts as subtopic of **ebus/** + +These topics are available on every device. +|***topic*** |***description*** +|:- |:- +|**device** | +|ebus/device |information about your device +|ebus/device/ebus |basic ebus adapter settings (Configration) +|ebus/device/firmware |details of installed firmware +|ebus/device/wifi |wifi details +|**counter** | +|ebus/arbitration |arbitration over common interface +|ebus/arbitration/won |details of won arbitration +|ebus/arbitration/lost|details of lost arbitration +|**commands** | +|ebus/config/restart |restarting of the device +|- | +|**EBUS_INTERNAL=1** | +|**output** | +|ebus/commands |list of installed commands +|ebus/value |received values of installed commands +|ebus/system |time and outdoor temperature of system (Service 07h 00h) +|ebus/nodes |decoded answer from an active sent identification telegram (Service 07h 04h) +|ebus/sent |values of 'send' command: subtopic=master; value=slave; +|ebus/raw |values of 'raw' printout: subtopic=master; value=slave; +|**counter** | +|ebus/messages |processed messages +|ebus/errors |errors of finite state machine +|ebus/resets |resets of finite state machine +|ebus/requets |bus requests (arbitration) +|**commands** | +|ebus/config/insert |insert new command +|ebus/config/remove |remove loaded command +|ebus/config/list |list loaded commands +|ebus/config/load |loading saved commands +|ebus/config/save |saving loaded commands +|ebus/config/wipe |wiping saved commands +|ebus/config/send |sending of given ebus command(s) once +|ebus/config/raw |enable/disable of raw data printout +|ebus/config/filter |filter for raw data printout +|**response** | +|ebus/config/loading |bytes of loaded commands +|ebus/config/saving |bytes of saved commands +|ebus/config/wiping |bytes of wiped commands +|ebus/conifg/error |message of last occurred error + From 93a2ab72f13102c11942cdc680615948928075f3 Mon Sep 17 00:00:00 2001 From: Roland Jax Date: Tue, 11 Feb 2025 22:39:33 +0100 Subject: [PATCH 3/4] second --- doc/mqtt.txt | 52 ++++++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 52 insertions(+) create mode 100644 doc/mqtt.txt diff --git a/doc/mqtt.txt b/doc/mqtt.txt new file mode 100644 index 0000000..69c3197 --- /dev/null +++ b/doc/mqtt.txt @@ -0,0 +1,52 @@ +# mqtt interface + +The mqtt interface serves two purposes. +* Data is made available at regular intervals. +* Defined commands can be sent to the device. + +Every topic starts as subtopic of **ebus/** + +These topics are available on every device. +|***topic*** |***description*** +|:- |:- +|**device** | +|ebus/device |information about your device +|ebus/device/ebus |basic ebus adapter settings (Configration) +|ebus/device/firmware |details of installed firmware +|ebus/device/wifi |wifi details +|**counter** | +|ebus/arbitration |arbitration over common interface +|ebus/arbitration/won |details of won arbitration +|ebus/arbitration/lost|details of lost arbitration +|**commands** | +|ebus/config/restart |restarting of the device +|- | +|**EBUS_INTERNAL=1** | +|**output** | +|ebus/commands |list of installed commands +|ebus/value |received values of installed commands +|ebus/system |time and outdoor temperature of system (Service 07h 00h) +|ebus/nodes |decoded answer from an active sent identification telegram (Service 07h 04h) +|ebus/sent |values of 'send' command: subtopic=master; value=slave; +|ebus/raw |values of 'raw' printout: subtopic=master; value=slave; +|**counter** | +|ebus/messages |processed messages +|ebus/errors |errors of finite state machine +|ebus/resets |resets of finite state machine +|ebus/requets |bus requests (arbitration) +|**commands** | +|ebus/config/insert |insert new command +|ebus/config/remove |remove loaded command +|ebus/config/list |list loaded commands +|ebus/config/load |loading saved commands +|ebus/config/save |saving loaded commands +|ebus/config/wipe |wiping saved commands +|ebus/config/send |sending of given ebus command(s) once +|ebus/config/raw |enable/disable of raw data printout +|ebus/config/filter |filter for raw data printout +|**response** | +|ebus/config/loading |bytes of loaded commands +|ebus/config/saving |bytes of saved commands +|ebus/config/wiping |bytes of wiped commands +|ebus/conifg/error |message of last occurred error + From 046b13c530efbbef8d920f2f3928f0f11494bcfe Mon Sep 17 00:00:00 2001 From: Roland Jax Date: Sat, 8 Mar 2025 17:21:45 +0100 Subject: [PATCH 4/4] details added --- doc/commands.txt | 76 ++++++++++++++++++++++++++++++++++++++++++++++++ doc/mqtt.md | 2 -- doc/mqtt.txt | 2 -- 3 files changed, 76 insertions(+), 4 deletions(-) create mode 100644 doc/commands.txt diff --git a/doc/commands.txt b/doc/commands.txt new file mode 100644 index 0000000..2715cc8 --- /dev/null +++ b/doc/commands.txt @@ -0,0 +1,76 @@ +Details of mqtt commands + +Restart the device +* topic : ebus/config/restart +* payload: true + + +The following commands are available when the firmware is compiled with EBUS_INTERNAL=1 + +Insert new command +* topic : ebus/config/insert +* payload: ebus command in form of "ZZPBSBNNDBx" for e.g. +{ + "key": "UNIQUE_KEY", + "command": "fe070009", + "unit": "°C", + "active": false, + "interval": 0, + "master": true, + "position": 1, + "datatype": "DATA2b", + "topic": "outdoor/temperature", + "ha": true, + "ha_class": "temperature" +} + + +Remove loaded command +* topic : ebus/config/remove +* payload: UNIQUE_KEY of ebus command +{ + "key": "UNIQUE_KEY" +} + + +Publish loaded commands +* topic : ebus/config/list +* payload: true + + +Enable/disable the raw data printout +* topic : ebus/config/raw +* payload: true + + +Insert raw data filter +* topic : ebus/config/filter +* payload: array of sequences for e.g. +[ + "0700", + "fe" +] + + +Loading saved commands +* topic : ebus/config/load +* payload: true + + +Saving loaded commands +* topic : ebus/config/save +* payload: true + + +Wiping saved commands +* topic : ebus/config/wipe +* payload: true + + +Sending of given ebus command(s) once +* topic : ebus/config/send +* payload: array of ebus command(s) in form of "ZZPBSBNNDBx" for e.g. +[ + "05070400", + "15070400" +] diff --git a/doc/mqtt.md b/doc/mqtt.md index 3b7d9f1..7eda3cc 100644 --- a/doc/mqtt.md +++ b/doc/mqtt.md @@ -25,8 +25,6 @@ These topics are available on every device. |**output** | |ebus/commands |list of installed commands |ebus/value |received values of installed commands -|ebus/system |time and outdoor temperature of system (Service 07h 00h) -|ebus/nodes |decoded answer from an active sent identification telegram (Service 07h 04h) |ebus/sent |values of 'send' command: subtopic=master; value=slave; |ebus/raw |values of 'raw' printout: subtopic=master; value=slave; |**counter** | diff --git a/doc/mqtt.txt b/doc/mqtt.txt index 69c3197..4712353 100644 --- a/doc/mqtt.txt +++ b/doc/mqtt.txt @@ -25,8 +25,6 @@ These topics are available on every device. |**output** | |ebus/commands |list of installed commands |ebus/value |received values of installed commands -|ebus/system |time and outdoor temperature of system (Service 07h 00h) -|ebus/nodes |decoded answer from an active sent identification telegram (Service 07h 04h) |ebus/sent |values of 'send' command: subtopic=master; value=slave; |ebus/raw |values of 'raw' printout: subtopic=master; value=slave; |**counter** |