aboutsummaryrefslogtreecommitdiffstats
path: root/docs/API_Server.md
diff options
context:
space:
mode:
authorKevin O'Connor <kevin@koconnor.net>2021-08-12 15:59:41 -0400
committerKevin O'Connor <kevin@koconnor.net>2021-08-30 12:26:39 -0400
commitf11acd806555ee28898a5f9c9777815b59d6c4f7 (patch)
treea0ce34d2b2b0d20885dc1685287cb2eb2bf2f97f /docs/API_Server.md
parent0b4fbc78a8d055ecbc0c4922c01416bc1c84653d (diff)
downloadkutter-f11acd806555ee28898a5f9c9777815b59d6c4f7.tar.gz
kutter-f11acd806555ee28898a5f9c9777815b59d6c4f7.tar.xz
kutter-f11acd806555ee28898a5f9c9777815b59d6c4f7.zip
motan: Add support for dumping and analyzing adxl345 data
Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
Diffstat (limited to 'docs/API_Server.md')
-rw-r--r--docs/API_Server.md20
1 files changed, 20 insertions, 0 deletions
diff --git a/docs/API_Server.md b/docs/API_Server.md
index 77470137..562ad57e 100644
--- a/docs/API_Server.md
+++ b/docs/API_Server.md
@@ -321,6 +321,26 @@ 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.
+### adxl345/dump_adxl345
+
+This endpoint is used to subscribe to ADXL345 accelerometer data.
+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":"adxl345/dump_adxl345",
+"params": {"sensor": "adxl345", "response_template": {}}}`
+and might return:
+`{"id": 123,"result":{"header":["time","x_acceleration","y_acceleration",
+"z_acceleration"]}}`
+and might later produce asynchronous messages such as:
+`{"params":{"overflows":0,"data":[[3292.432935,-535.44309,-1529.8374,9561.4],
+[3292.433256,-382.45935,-1606.32927,9561.48375]]}}`
+
+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.