Update a grinder
update_grinderCorrect a registered grinder — its name, burrs, collar scheme, nominal step, layout, range or notes. Only the keys you send in fields change; send null to clear an optional field (an empty string also clears a text field, but not a number or a closed list). Required fields can be changed but not cleared. fields may be omitted when only reason is sent. setting_scheme, nominal_step and components_spec describe the collar every recorded grind label is read through: call with dry_run first to see which recorded settings would read as a different position, and tell the user before saving. Saving records the change in the grinder's maintenance history; when a locked recipe's setting moves it also opens an unmeasured calibration epoch (set_maintenance_offset resolves it). The collar's current setting is marked assumed when it reads differently, or cleared when the new collar cannot read it, and measured offsets are converted when a click changes worth. Changing direction_convention is a correction — it moves no number, but every finer/coarser said about this grinder was the wrong way round.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| fields | No | ||
| reason | No | Optional note, appended to this record's own notes as an ordinary line. Omit it and nothing is written. | |
| dry_run | No | true: write nothing, and answer with what the edit would do to the settings already recorded (moved[], checked, epoch, position_moved, position_cleared, rescaled_offsets, resigned_offsets, step_ignored, direction_flipped, recipe_count) | |
| grinder_id | Yes | This account's own grinder number, from list_grinders. Never guess one. |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| epoch | Yes | ||
| moved | Yes | ||
| status | Yes | ||
| checked | Yes | ||
| dry_run | Yes | ||
| message | Yes | ||
| entry_id | Yes | ||
| grinder_id | Yes | ||
| unreadable | Yes | ||
| moved_count | Yes | ||
| changed_keys | Yes | ||
| recipe_count | Yes | ||
| step_ignored | Yes | ||
| reads_changed | Yes | ||
| position_moved | Yes | ||
| untranslatable | Yes | ||
| position_cleared | Yes | ||
| rescaled_offsets | Yes | ||
| resigned_offsets | Yes | ||
| direction_flipped | Yes | ||
| untranslatable_recipes | Yes |