Skip to content

Commit a71e254

Browse files
balloobfrenck
authored andcommitted
Add mqtt.dump docs (home-assistant#11955)
1 parent 9fb3a8b commit a71e254

File tree

2 files changed

+15
-2
lines changed

2 files changed

+15
-2
lines changed

source/_docs/mqtt/service.markdown

Lines changed: 14 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -37,7 +37,7 @@ payload_template: {{ states('device_tracker.paulus') }}
3737
```yaml
3838
topic: home-assistant/light/1/state
3939
payload: "{\"Status\":\"off\", \"Data\":\"something\"}"
40-
```
40+
```
4141

4242
Example of how to use `qos` and `retain`:
4343

@@ -47,3 +47,16 @@ payload: on
4747
qos: 2
4848
retain: true
4949
```
50+
51+
### Service `mqtt.dump`
52+
53+
Listen to the specified topic matcher and dumps all received messages within a specific duration into the file `mqtt_dump.txt` in your config folder. This is useful when debugging a problem.
54+
55+
| Service data attribute | Optional | Description |
56+
| ---------------------- | -------- | ----------- |
57+
| `topic` | no | Topic to dump. Can contain a wildcard (`#` or `+`).
58+
| `duration` | no | Duration in seconds that we will listen for messages. Default is 5 seconds.
59+
60+
```yaml
61+
topic: openzwave/#
62+
```

source/_integrations/mqtt.markdown

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -44,7 +44,7 @@ This allows you to connect to the MQTT broker with user `homeassistant` and pass
4444

4545
- [Certificate](/docs/mqtt/certificate/)
4646
- [Discovery](/docs/mqtt/discovery/)
47-
- [Publish service](/docs/mqtt/service/)
47+
- [Publish & Dump services](/docs/mqtt/service/)
4848
- [Birth and last will messages](/docs/mqtt/birth_will/)
4949
- [Testing your setup](/docs/mqtt/testing/)
5050
- [Logging](/docs/mqtt/logging/)

0 commit comments

Comments
 (0)