3diy
/
moonraker
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

docs: document "notify_klippy_ready" websocket notfication 

Signed-off-by:  Eric Callahan <arksine.code@gmail.com>
This commit is contained in:
Arksine 2020-11-11 17:59:08 -05:00
parent 6254586a65
commit a1de70ff89
2 changed files with 7 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
docs/api_changes.md
View File

@ -18,6 +18,8 @@ facing APIs.
Currenlty subscriptions are only supported over the a Currenlty subscriptions are only supported over the a
websocket connection, one may use the id received from websocket connection, one may use the id received from
`server.websocket.id`. `server.websocket.id`.
- The `notify_klippy_ready` websocket notification has been
added.
### November 2nd 2020 ### November 2nd 2020
- The `GET /server/files/directory` endpoint now accepts a new - The `GET /server/files/directory` endpoint now accepts a new

5
docs/web_api.md
View File

@ -816,6 +816,11 @@ Status Subscriptions arrive as a "notify_status_update" notification:
The structure of the status data is identical to the structure that is The structure of the status data is identical to the structure that is
returned from an object query's "status" attribute. returned from an object query's "status" attribute.
### Klippy Ready:
Notify clients when Klippy has reported a ready state
`{jsonrpc: "2.0", method: "notify_klippy_ready"}`
### Klippy Disconnected: ### Klippy Disconnected:
Notify clients when Moonraker's connection to Klippy has terminated Notify clients when Moonraker's connection to Klippy has terminated