diff options
| author | Gareth Farrington <gareth@waves.ky> | 2025-03-20 16:53:44 -0700 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2025-03-20 19:53:44 -0400 |
| commit | 06d65ef5ac139e2c84e7381c190ee2b1e4ec4237 (patch) | |
| tree | 757285e437b6d53673a3560d3b1cad18f7cc4e0c /docs/API_Server.md | |
| parent | d886c1761bbdfd23833996489afba6b75f312a4a (diff) | |
| download | kutter-06d65ef5ac139e2c84e7381c190ee2b1e4ec4237.tar.gz kutter-06d65ef5ac139e2c84e7381c190ee2b1e4ec4237.tar.xz kutter-06d65ef5ac139e2c84e7381c190ee2b1e4ec4237.zip | |
load_cell: Load cell gram scale (#6729)
* Add gram scale features to load_cell
* Convert sensor counts to grams and make this available via unix socket and object status
* Basic GCodes for tearing and reading the load cell
* Guided Calibration
* Diagnostic gcode to check the health of the load cell
* Update load_cell Documentation
* Add API server load_cell/dump_force endpoint
* Update [load_cell] config with calibration fields
* Add G-Code commands for working with load cells
* Add status reference for load_cell objects
Signed-off-by: Gareth Farrington <gareth@waves.ky>
Diffstat (limited to 'docs/API_Server.md')
| -rw-r--r-- | docs/API_Server.md | 32 |
1 files changed, 8 insertions, 24 deletions
diff --git a/docs/API_Server.md b/docs/API_Server.md index 3837f737..87e38031 100644 --- a/docs/API_Server.md +++ b/docs/API_Server.md @@ -364,37 +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 +### load_cell/dump_force -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. +This endpoint is used to subscribe to force data produced by a load_cell. +Using this endpoint may increase Klipper's system load. A request may look like: -`{"id": 123, "method":"hx71x/dump_hx71x", +`{"id": 123, "method":"load_cell/dump_force", "params": {"sensor": "load_cell", "response_template": {}}}` and might return: -`{"id": 123,"result":{"header":["time","counts","value"]}}` +`{"id": 123,"result":{"header":["time", "force (g)", "counts", "tare_counts"]}}` and might later produce asynchronous messages such as: -`{"params":{"data":[[3292.432935, 562534, 0.067059278], -[3292.4394937, 5625322, 0.670590639]]}}` - -### ads1220/dump_ads1220 - -This endpoint is used to subscribe to raw ADS1220 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. +`{"params":{"data":[[3292.432935, 40.65, 562534, -234467]]}}` -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","value"]}}` -and might later produce asynchronous messages such as: -`{"params":{"data":[[3292.432935, 562534, 0.067059278], -[3292.4394937, 5625322, 0.670590639]]}}` +The "header" field in the initial query response is used to describe +the fields found in later "data" responses. ### pause_resume/cancel |