Set Sheet Property
set_sheet_propertySet or update custom sheet properties on hierarchical sheet blocks in KiCAD schematics. Identify the sheet by name or path; creates hidden property if missing, updates value if present.
Instructions
Add or update a custom property on a hierarchical sheet's (sheet ...) block — e.g. cell identity or generator parameters carried as sheet metadata. Identify the sheet by sheetName or sheetPath (basename match against the sheet's file property). The property is created hidden if absent, otherwise its value is updated in place; the file's formatting is preserved. The built-in 'Sheet name'/'Sheet file' properties cannot be set here — use add/remove_hierarchical_sheet to manage the sheet link.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| key | Yes | Property name (e.g. 'IS.Cell') | |
| value | Yes | Property value | |
| sheetName | No | Sheet display name (matches the Sheetname/Sheet name property) | |
| sheetPath | No | Sub-sheet file (matched by basename against the Sheetfile property) | |
| schematicPath | Yes | Path to the parent .kicad_sch |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| result | Yes |