Realtime monitoring

Know when a user is watching the device live, to send data more often.

TopicDirection
things5-production/v1/devices/{device_id}/cmd/realtime_monitoring_reqThings5 → device

Things5 → device: cmd/realtime_monitoring_req

Used to let the device know that a user has opened the monitoring page.
This allows the device to perform an action in response.
For example the device could start publishing data more frequently.

Things5 will keep sending a message at least once every polling_intervalseconds if the user has still the monitoring page opened (device should account for a delay receiving the next message depending on the network conditions). Multiple users will generate multiple messages.

This message is sent only when the Supports realtime session notifications flag is enabled in the machine model

things5-production/v1/devices/<device-id>/cmd/realtime_monitoring_req

Payload

{
  "request_id": "UUID",
  "polling_interval": 30
}

Payload Parameters

typedesctiptionexample
request_idA unique id that identifies the request"a7e3e4be-4350-4446-a86d-f6bc021538e8"
polling_intervaltime in seconds after which if no message from this topic is received the request is considered expired30