Skip to content

Commit 75720bb

Browse files
committed
docs: add MQTT message structure and common sensor payloads to README
1 parent 079db0c commit 75720bb

File tree

1 file changed

+23
-0
lines changed

1 file changed

+23
-0
lines changed

README.md

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -285,6 +285,29 @@ mosquitto_sub -t 'matter/#' -v
285285
# matter/living_room_air/availability → online
286286
```
287287

288+
### MQTT Message Structure (Practical Summary)
289+
290+
**Topic layout**
291+
- Base: `matter/<device>/...` where `<device>` is the friendly name from `bridge-config.yaml` (falls back to `node_<id>`).
292+
- Availability: `matter/<device>/availability` with payload `online` or `offline` (retained).
293+
- Bridge status: `matter/bridge/state` and `matter/bridge/info`.
294+
295+
**Common sensor payloads (human-friendly topics)**
296+
- `matter/<device>/temperature` → JSON object with `temperature`, `unit`, `timestamp`.
297+
- `matter/<device>/humidity` → JSON object with `humidity`, `unit`, `timestamp`.
298+
- `matter/<device>/air_quality` → JSON object with `quality`, `value`, `timestamp`.
299+
- `matter/<device>/battery` → JSON object with `battery`, `unit`, `timestamp`.
300+
301+
Example payloads (single-line JSON):
302+
`{"temperature": 22.5, "unit": "°C", "timestamp": "2026-02-13T16:05:02.203433"}`
303+
`{"humidity": 45.2, "unit": "%", "timestamp": "2026-02-13T16:05:02.203433"}`
304+
305+
**Raw attribute stream (if you need full Matter data)**
306+
- `matter/<device>/cluster_XXXX/attr_YYYY` for every attribute the bridge receives.
307+
- Useful for debugging or building custom mappings; not meant for everyday use.
308+
309+
Full details and command topics are in [docs/INTEGRATION.md](docs/INTEGRATION.md).
310+
288311
## 📊 Usage
289312

290313
### Monitor Sensors in Real-Time

0 commit comments

Comments
 (0)