docs: note addition of the "eventtime" param to "notify_status_update"

Signed-off-by:  Eric Callahan <arksine.code@gmail.com>
This commit is contained in:
Eric Callahan 2021-07-06 15:43:02 -04:00
parent c6fee3c1f4
commit 12a7f957c3
1 changed files with 6 additions and 1 deletions

View File

@ -3038,13 +3038,18 @@ Status Subscriptions arrive as a "notify_status_update" notification:
{ {
"jsonrpc": "2.0", "jsonrpc": "2.0",
"method": "notify_status_update", "method": "notify_status_update",
"params": [{<status object>}] "params": [{<status object>}, <eventtime>]
} }
``` ```
The structure of the `status object` is identical to the structure that is The structure of the `status object` is identical to the structure that is
returned from an [object query's](#query-printer-object-status) returned from an [object query's](#query-printer-object-status)
`status` field. `status` field.
The `eventtime` is a timestamp generated by Klipper when
the update was originally pushed. This timestamp is a float value,
relative to Klipper's monotonic clock. Note that this value will be
reset when Klipper restarts.
#### Klippy Ready #### Klippy Ready
Notify clients when Klippy has reported a ready state Notify clients when Klippy has reported a ready state
```json ```json