X-Git-Url: https://git.giacomolli.uk/onehouse/blobdiff_plain/b28ae53ae04c41116acb2beae9d5a2128a187c83..4bba0e163f1a4dc07b34fd9e4dc403de1f9b4cb9:/doc/mqtt.rst?ds=sidebyside diff --git a/doc/mqtt.rst b/doc/mqtt.rst index 55a9a67..1f5fa4a 100644 --- a/doc/mqtt.rst +++ b/doc/mqtt.rst @@ -7,17 +7,17 @@ command, and message IDs use canonical uppercase ULIDs. Capabilities and events use lowercase ASCII letters and digits, with single internal hyphen or period separators. Topic builders reject invalid addresses. -``Address.Topic`` and ``ParseTopic`` cover device descriptor, -availability, reported values, telemetry, events, commands, command -batches, results, and Zigbee hub status. Subscription helpers supply the -core input filters, each device's command filter, and hub status filter. -The command filter includes the reserved ``$batch`` target. - -``EncodeEnvelope`` and ``ParseEnvelope`` validate schema, IDs, optional -UTC timestamps, and a required object payload. Unknown envelope fields, -trailing JSON, unsupported schema versions, and malformed topics are -errors. A receiver checks expiry against its own clock. The message ID -stays unchanged on retry. Its timestamp is not the observation time. +Private topic helpers cover device descriptor, availability, reported +values, telemetry, events, commands, command batches, results, and +Zigbee hub status. Subscription helpers supply the core input filters, +each device's command filter, and hub status filter. The command filter +includes the reserved ``$batch`` target. + +Private envelope helpers validate schema, IDs, optional UTC timestamps, +and a required object payload. Unknown envelope fields, trailing JSON, +unsupported schema versions, and malformed topics are errors. A receiver +checks expiry against its own clock. The message ID stays unchanged on +retry. Its timestamp is not the observation time. Measurements and online availability repeat at five-minute intervals. The device contact timeout is fifteen minutes. These constants do not