aboutsummaryrefslogtreecommitdiffstats
path: root/docs/API_Server.md
diff options
context:
space:
mode:
authorKevin O'Connor <kevin@koconnor.net>2024-08-02 13:44:26 -0400
committerKevin O'Connor <kevin@koconnor.net>2024-08-14 22:17:10 -0400
commitd5e5a6da2defb357ac986fb2a79003a8e1dd738d (patch)
tree3f2ff7b99115b67fd2bef85326a553aaf338ebeb /docs/API_Server.md
parentc0edfbc4ea02d7d0fb5824a686b4376a05972266 (diff)
downloadkutter-d5e5a6da2defb357ac986fb2a79003a8e1dd738d.tar.gz
kutter-d5e5a6da2defb357ac986fb2a79003a8e1dd738d.tar.xz
kutter-d5e5a6da2defb357ac986fb2a79003a8e1dd738d.zip
hx71x: Update api header and docs to correctly note "value" field
Update both hx71x and ads1220 to reflect that there is a third "value" field in the reported data. Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
Diffstat (limited to 'docs/API_Server.md')
-rw-r--r--docs/API_Server.md10
1 files changed, 6 insertions, 4 deletions
diff --git a/docs/API_Server.md b/docs/API_Server.md
index f29bbeba..3837f737 100644
--- a/docs/API_Server.md
+++ b/docs/API_Server.md
@@ -375,9 +375,10 @@ 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"]}}`
+`{"id": 123,"result":{"header":["time","counts","value"]}}`
and might later produce asynchronous messages such as:
-`{"params":{"data":[[3292.432935, 562534], [3292.4394937, 5625322]]}}`
+`{"params":{"data":[[3292.432935, 562534, 0.067059278],
+[3292.4394937, 5625322, 0.670590639]]}}`
### ads1220/dump_ads1220
@@ -390,9 +391,10 @@ A request may look like:
`{"id": 123, "method":"ads1220/dump_ads1220",
"params": {"sensor": "load_cell", "response_template": {}}}`
and might return:
-`{"id": 123,"result":{"header":["time","counts"]}}`
+`{"id": 123,"result":{"header":["time","counts","value"]}}`
and might later produce asynchronous messages such as:
-`{"params":{"data":[[3292.432935, 562534], [3292.4394937, 5625322]]}}`
+`{"params":{"data":[[3292.432935, 562534, 0.067059278],
+[3292.4394937, 5625322, 0.670590639]]}}`
### pause_resume/cancel