diff options
Diffstat (limited to 'docs/API_Server.md')
| -rw-r--r-- | docs/API_Server.md | 15 |
1 files changed, 15 insertions, 0 deletions
diff --git a/docs/API_Server.md b/docs/API_Server.md index cc0922e3..36d67b1a 100644 --- a/docs/API_Server.md +++ b/docs/API_Server.md @@ -364,6 +364,21 @@ 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. +### hx71x/dump_hx71x + +This endpoint is used to subscribe to raw HX711 and HX717 ADC data. +Obtaining these low-level ADC 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":"hx71x/dump_hx71x", +"params": {"sensor": "load_cell", "response_template": {}}}` +and might return: +`{"id": 123,"result":{"header":["time","counts"]}}` +and might later produce asynchronous messages such as: +`{"params":{"data":[[3292.432935, 562534], [3292.4394937, 5625322]]}}` + ### pause_resume/cancel This endpoint is similar to running the "PRINT_CANCEL" G-Code command. |