aboutsummaryrefslogtreecommitdiffstats
path: root/docs/G-Codes.md
diff options
context:
space:
mode:
authorGareth Farrington <gareth@waves.ky>2025-03-20 16:53:44 -0700
committerGitHub <noreply@github.com>2025-03-20 19:53:44 -0400
commit06d65ef5ac139e2c84e7381c190ee2b1e4ec4237 (patch)
tree757285e437b6d53673a3560d3b1cad18f7cc4e0c /docs/G-Codes.md
parentd886c1761bbdfd23833996489afba6b75f312a4a (diff)
downloadkutter-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/G-Codes.md')
-rw-r--r--docs/G-Codes.md34
1 files changed, 34 insertions, 0 deletions
diff --git a/docs/G-Codes.md b/docs/G-Codes.md
index 25c69604..b2272887 100644
--- a/docs/G-Codes.md
+++ b/docs/G-Codes.md
@@ -715,6 +715,40 @@ and RAW sensor value for calibration points.
#### DISABLE_FILAMENT_WIDTH_LOG
`DISABLE_FILAMENT_WIDTH_LOG`: Turn off diameter logging.
+### [load_cell]
+
+The following commands are enabled if a
+[load_cell config section](Config_Reference.md#load_cell) has been enabled.
+
+### LOAD_CELL_DIAGNOSTIC
+`LOAD_CELL_DIAGNOSTIC [LOAD_CELL=<config_name>]`: This command collects 10
+seconds of load cell data and reports statistics that can help you verify proper
+operation of the load cell. This command can be run on both calibrated and
+uncalibrated load cells.
+
+### LOAD_CELL_CALIBRATE
+`LOAD_CELL_CALIBRATE [LOAD_CELL=<config_name>]`: Start the guided calibration
+utility. Calibration is a 3 step process:
+1. First you remove all load from the load cell and run the `TARE` command
+1. Next you apply a known load to the load cell and run the
+`CALIBRATE GRAMS=nnn` command
+1. Finally use the `ACCEPT` command to save the results
+
+You can cancel the calibration process at any time with `ABORT`.
+
+### LOAD_CELL_TARE
+`LOAD_CELL_TARE [LOAD_CELL=<config_name>]`: This works just like the tare button
+on digital scale. It sets the current raw reading of the load cell to be the
+zero point reference value. The response is the percentage of the sensors range
+that was read and the raw value in counts.
+
+### LOAD_CELL_READ load_cell="name"
+`LOAD_CELL_READ [LOAD_CELL=<config_name>]`:
+This command takes a reading from the load cell. The response is the percentage
+of the sensors range that was read and the raw value in counts. If the load cell
+is calibrated a force in grams is also reported.
+
+
### [heaters]
The heaters module is automatically loaded if a heater is defined in