From a1de70ff89d17f2b9fb7ba1005d9ea18537146be Mon Sep 17 00:00:00 2001 From: Arksine Date: Wed, 11 Nov 2020 17:59:08 -0500 Subject: [PATCH] docs: document "notify_klippy_ready" websocket notfication Signed-off-by: Eric Callahan --- docs/api_changes.md | 2 ++ docs/web_api.md | 5 +++++ 2 files changed, 7 insertions(+) diff --git a/docs/api_changes.md b/docs/api_changes.md index 30f1c31..b5d343c 100644 --- a/docs/api_changes.md +++ b/docs/api_changes.md @@ -18,6 +18,8 @@ facing APIs. Currenlty subscriptions are only supported over the a websocket connection, one may use the id received from `server.websocket.id`. +- The `notify_klippy_ready` websocket notification has been + added. ### November 2nd 2020 - The `GET /server/files/directory` endpoint now accepts a new diff --git a/docs/web_api.md b/docs/web_api.md index ec9d76e..c0a767a 100644 --- a/docs/web_api.md +++ b/docs/web_api.md @@ -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 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: Notify clients when Moonraker's connection to Klippy has terminated