-
-
Notifications
You must be signed in to change notification settings - Fork 3
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
10 changed files
with
147 additions
and
11 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,45 @@ | ||
## MQTT Firmware | ||
|
||
Bei Verwendung der MQTT-Firmware werden verschiedene Topics an deinen Broker gesendet. So funktioniert die Struktur der Topics und Steuerung. | ||
|
||
### Topic Struktur | ||
Jede Entität veröffentlicht ihren Status auf einem Topic im folgenden Format: | ||
``` | ||
<TOPIC_PREFIX>/<COMPONENT_TYPE>/<COMPONENT_NAME>/state | ||
``` | ||
|
||
Du kannst bestimmte Entitäten steuern, indem du einen Befehl an ein Topic mit folgendem Format sendest: | ||
``` | ||
Topic: <TOPIC_PREFIX>/<COMPONENT_TYPE>/<COMPONENT_NAME>/command | ||
Payload: ON oder OFF oder was immer unterstützt wird | ||
``` | ||
|
||
### Beispiel | ||
Um die [Ring-To-Open](../automation/ring-to-open.md) Automatisierung zu aktivieren oder zu deaktivieren, sende ON oder OFF als Payload an dieses Topic: | ||
``` | ||
Topic: doorman-s3/switch/ring_to_open/command | ||
Payload: ON | ||
``` | ||
|
||
### Spezielle Topics | ||
Es gibt spezielle Topics, die erweiterte Befehle ermöglichen. | ||
|
||
#### Senden eines hexadezimalen Commands | ||
Um einen hexadezimalen Befehl an den Bus zu senden, verwende das Topic `doorman-s3/send_raw_command` mit einer JSON-Payload. Beispiel: | ||
```json | ||
{ | ||
"command": 0x1C30BA80, | ||
"is_long": false | ||
} | ||
``` | ||
|
||
#### Senden eines Commands mit Command Builder | ||
Um einen Befehl mittels Command Builder an den Bus zu senden, verwende das Topic `doorman-s3/send_command` mit einer JSON-Payload. Beispiel: | ||
```json | ||
{ | ||
"type": "open_door", | ||
"address": 0, | ||
"payload": 0, | ||
"serial_number": 123456 | ||
} | ||
``` |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,45 @@ | ||
## MQTT Firmware | ||
|
||
When using the MQTT firmware, various topics are published to your broker. Here's how the topic structure and controls work. | ||
|
||
### Topic Structure | ||
Each entity publishes its state to a topic in the following format: | ||
``` | ||
<TOPIC_PREFIX>/<COMPONENT_TYPE>/<COMPONENT_NAME>/state | ||
``` | ||
|
||
You can control certain entities by publishing a command to this topic format: | ||
``` | ||
Topic: <TOPIC_PREFIX>/<COMPONENT_TYPE>/<COMPONENT_NAME>/command | ||
Payload: ON or OFF or whatever is supported | ||
``` | ||
|
||
### Example | ||
To enable or disable the [Ring-To-Open](../automation/ring-to-open.md) automation, send `ON` or `OFF` as the payload to the topic: | ||
``` | ||
Topic: doorman-s3/switch/ring_to_open/command | ||
Payload: ON | ||
``` | ||
|
||
### Special Topics | ||
Certain special topics allow for advanced commands. | ||
|
||
#### Send a hexadecimal Command | ||
To send a hexadecimal command to the bus, use the topic `doorman-s3/send_raw_command ` with a JSON payload. Here's an example payload: | ||
```json | ||
{ | ||
"command": 0x1C30BA80, | ||
"is_long": false | ||
} | ||
``` | ||
|
||
#### Send a parsed Command | ||
To send a command via command builder to the bus, use the topic `doorman-s3/send_command` with a JSON payload. Here's an example payload: | ||
```json | ||
{ | ||
"type": "open_door", | ||
"address": 0, | ||
"payload": 0, | ||
"serial_number": 123456 | ||
} | ||
``` |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters