From 74937326d313ae741c42207035ebcf8c09aa9e01 Mon Sep 17 00:00:00 2001 From: Kevin O'Connor Date: Fri, 9 Jul 2021 22:04:10 -0400 Subject: sensor_angle: Add support for bulk querying of spi angle sensors Signed-off-by: Kevin O'Connor --- docs/API_Server.md | 18 ++++++++++++++++++ 1 file changed, 18 insertions(+) (limited to 'docs/API_Server.md') diff --git a/docs/API_Server.md b/docs/API_Server.md index 562ad57e..8c3e966e 100644 --- a/docs/API_Server.md +++ b/docs/API_Server.md @@ -341,6 +341,24 @@ and might later produce asynchronous messages such as: The "header" field in the initial query response is used to describe the fields found in later "data" responses. +### angle/dump_angle + +This endpoint is used to subscribe to +[angle sensor data](Config_Reference.md#angle). Obtaining these +low-level motion updates may be useful for diagnostic and debugging +purposes. Using this endpoint may increase Klipper's system load. + +A request may look like: +`{"id": 123, "method":"angle/dump_angle", +"params": {"sensor": "my_angle_sensor", "response_template": {}}}` +and might return: +`{"id": 123,"result":{"header":["time","angle"]}}` +and might later produce asynchronous messages such as: +`{"params":{"errors":0,"data":[[1290.951905,-5063],[1290.952321,-5065]]}}` + +The "header" field in the initial query response is used to describe +the fields found in later "data" responses. + ### pause_resume/cancel This endpoint is similar to running the "PRINT_CANCEL" G-Code command. -- cgit v1.2.3-70-g09d2