← Commit history

altium-lane: reference/altium-0.2.76.json updated (223 verbs: all 21 of batch 1 now). Not regenerated: standard-lane regenerates

Colby Knox ·98fa2322e1 ·12d ago ·parent 8bfdab8
1 file changed +256
reference/altium-0.2.76.json+256
@@ -3895,6 +3895,262 @@    "summary": "Snap near-miss wire ends onto the pin, label, sheet pin or wire end they almost touch, within a tolerance. dryRun (the default) lists the moves; dryRun:false makes them. Coordinates are mm in the sheet's frame (Altium's own, y up), the EDA Bridge Standard's schematic frame.",    "timeoutSeconds": 120   },+  {+   "example": {+    "paper": "A3",+    "rev": "B",+    "sheet": "C:/proj/Main.SchDoc",+    "title": "Main board"+   },+   "hint": "With no change arguments it only reads. An empty string removes a title-block field. Each sheet of a hierarchy has its own page.",+   "input": {+    "comments": "[string]: comment lines in order",+    "company": "string",+    "date": "string",+    "dryRun": "bool, default false: answer the plan and change nothing",+    "heightMm": "number (custom paper)",+    "orientation": "portrait|landscape",+    "paper": "A5 to A0, A to E, USLetter, USLegal, USLedger or custom",+    "rev": "string",+    "save": "bool, default true: save the sheet after the edit",+    "sheet": "path to the schematic sheet file (required)",+    "title": "string",+    "widthMm": "number (custom paper)"+   },+   "longRunning": false,+   "name": "altium_sch_page",+   "output": {+    "changed": "bool",+    "heightMm": "number",+    "orientation": "string",+    "paper": "string",+    "saved": "bool",+    "titleBlock": "{title, date, rev, company, comments}",+    "widthMm": "number"+   },+   "pitfalls": [+    "Shrinking the paper moves nothing: items outside the new frame stay where they are (render_schematic shows it).",+    "Altium's title block shows Title, Date, Revision and CompanyName; comments are kept as parameters Comment1, Comment2... A5 has no Altium sheet style and is set as a custom size."+   ],+   "related": [],+   "statusVerb": null,+   "summary": "Read or set a sheet's page: paper size, orientation and title block (title, date, revision, company, comment lines). Millimetres, the sheet's frame (y up).",+   "timeoutSeconds": 300+  },+  {+   "example": {+    "project": "C:/proj/Board.PrjPcb",+    "sheet": "C:/proj/Power.SchDoc",+    "sheetName": "Power",+    "title": "Power"+   },+   "hint": "Without project the sheet stands alone. With project it is linked from the root sheet as a child sheet with the next page number.",+   "input": {+    "at": "[x, y] mm: where the sheet symbol goes on the root",+    "comments": "[string]",+    "company": "string",+    "date": "string",+    "dryRun": "bool, default false: answer the plan and change nothing",+    "heightMm": "number (custom)",+    "orientation": "portrait|landscape",+    "paper": "A4, A3 ... USLetter or custom",+    "project": "path: add the sheet to this project under its root sheet",+    "rev": "string",+    "sheet": "path of the sheet to create (required)",+    "sheetName": "string: the sheet symbol's name in the root",+    "title": "string",+    "widthMm": "number (custom)"+   },+   "longRunning": false,+   "name": "altium_sch_create",+   "output": {+    "created": "bool",+    "page": "int",+    "sheet": "path",+    "sheetSymbol": "{id, name, at} or null"+   },+   "pitfalls": [+    "Never overwrites: an existing file is refused.",+    "A new child sheet has no pins on its symbol: add hierarchical ports inside, then sch_sheet_pins {import:true}.",+    "Made from Altium's ANSI B Landscape template and resized; the page number is one past the project's highest."+   ],+   "related": [],+   "statusVerb": null,+   "summary": "Create an empty schematic sheet with a paper size and title block; optionally add it to a project as a child sheet of the root. It places no parts or nets (build_schematic does). Millimetres, the sheet's frame (y up).",+   "timeoutSeconds": 300+  },+  {+   "example": {+    "project": "C:/proj/Board.PrjPcb",+    "renumber": true+   },+   "hint": "Pass the root sheet or the project. renumber writes only the numbers that change.",+   "input": {+    "dryRun": "bool, default false: answer the plan and change nothing",+    "project": "path to the project (instead of sheet)",+    "renumber": "bool, default false",+    "sheet": "path to the root sheet"+   },+   "longRunning": false,+   "name": "altium_sch_hierarchy",+   "output": {+    "duplicatePages": "[int]",+    "problems": "[{sheet, problem: missing|unreadable|recursive}]",+    "renumbered": "[{sheet, from, to}]",+    "tree": "[{name, file, id, path, page, at, sizeMm, pins: [{name, kind}], children: [...]}]"+   },+   "pitfalls": [+    "A sheet file used by two sheet symbols appears twice in the tree (one instance each) but is one file.",+    "Read from the saved files without Altium: save open sheets first."+   ],+   "related": [],+   "statusVerb": null,+   "summary": "The sheet tree of a design, recursively: each sheet's name, file, id, instance path, page number, position, size and pins. renumber:true renumbers pages depth-first from the root. Millimetres, the sheet's frame (y up).",+   "timeoutSeconds": 300+  },+  {+   "example": {+    "import": true,+    "sheet": "C:/proj/Main.SchDoc",+    "sheetSymbol": "Power"+   },+   "hint": "Inputs go on the left edge and outputs on the right by default, in the first free slot. A pin joins the child's hierarchical port of the same name; wire it on the parent side at its at.",+   "input": {+    "action": "list|add|edit|delete, default list",+    "at": "[x, y] mm: snapped to the nearest edge point",+    "dryRun": "bool, default false: answer the plan and change nothing",+    "import": "bool",+    "kind": "input|output|bidirectional|tri_state|passive",+    "name": "string: the pin",+    "newName": "string (edit)",+    "save": "bool, default true: save the sheet after the edit",+    "sheet": "path to the parent sheet (required)",+    "sheetSymbol": "the sheet symbol's name or id (default: validate checks every one)",+    "side": "left|right|top|bottom",+    "validate": "bool"+   },+   "longRunning": false,+   "name": "altium_sch_sheet_pins",+   "output": {+    "added": "[name]",+    "pins": "[{id, name, kind, side, at}]",+    "problems": "[{sheetSymbol, pin, problem: no_port|no_pin|kind_mismatch}]",+    "saved": "bool"+   },+   "pitfalls": [+    "Renaming a pin does not rename the port inside the child sheet: validate afterwards.",+    "A pin moved or deleted leaves its parent-side wire dangling.",+    "Altium has no tri-state or passive sheet entry: tri_state is stored as bidirectional, passive as unspecified."+   ],+   "related": [],+   "statusVerb": null,+   "summary": "A sheet symbol's pins: list, add, edit (rename, kind, move along an edge) or delete. import:true adds a pin for every hierarchical port inside the child sheet that the symbol lacks; validate:true reports ports without pins, pins without ports and kind mismatches. Millimetres, the sheet's frame (y up).",+   "timeoutSeconds": 300+  },+  {+   "example": {+    "references": [+     "R5",+     "C3"+    ],+    "sheet": "C:/proj/Main.SchDoc"+   },+   "hint": "Font and visibility stay as they are; only position, angle and justification move.",+   "input": {+    "all": "bool: every part on the sheet",+    "dryRun": "bool, default false: answer the plan and change nothing",+    "fields": "[designator, value] by default; other field names as the tool names them",+    "references": "[\"R5\", \"C3\"]",+    "save": "bool, default true: save the sheet after the edit",+    "sheet": "path to the schematic sheet file (required)"+   },+   "longRunning": false,+   "name": "altium_sch_reset_fields",+   "output": {+    "reset": "[{ref, field}]",+    "saved": "bool"+   },+   "pitfalls": [+    "The library's offsets are what the symbol's author drew; the tool's automatic field placement may put them elsewhere.",+    "Positions come from the part's library file (its library path); parts from integrated or database libraries have none and are reported."+   ],+   "related": [],+   "statusVerb": null,+   "summary": "Put parts' designator and value text (or the named fields) back where the library symbol places them, through each part's rotation and mirror. One undo step. Millimetres, the sheet's frame (y up).",+   "timeoutSeconds": 300+  },+  {+   "example": {+    "dryRun": true,+    "sheet": "C:/proj/Main.SchDoc"+   },+   "hint": "Run with dryRun first. A symbol whose new version drops a placed pin is refused unless force:true. Check the sheet afterwards with run_erc.",+   "input": {+    "dryRun": "bool, default false: answer the plan and change nothing",+    "force": "bool, default false: update even when a placed pin would be dropped",+    "library": "path to one library to take them all from (with symbols)",+    "save": "bool, default true: save the sheet after the edit",+    "sheet": "path to the schematic sheet file (required)",+    "symbols": "[library symbol name or id, ...] (default all)"+   },+   "longRunning": false,+   "name": "altium_sch_update_from_library",+   "output": {+    "changed": "[{symbol, pinsAdded, pinsRemoved}]",+    "notFound": "[symbol]",+    "refused": "[{symbol, droppedPins}]",+    "saved": "bool",+    "unchanged": "[symbol]"+   },+   "pitfalls": [+    "A pin that moved in the library moves off its wire: check with sch_pins or run_erc after an update that reports changes.",+    "Altium cannot compare graphics from the sheet: a symbol with the same pins is reported unchanged unless named in symbols or library is given, which re-places it anyway."+   ],+   "related": [],+   "statusVerb": null,+   "summary": "Update the placed symbols on a sheet from their libraries (all, or the listed ones) and report which changed, which already matched and which no library has. Millimetres, the sheet's frame (y up).",+   "timeoutSeconds": 300+  },+  {+   "example": {+    "baseline": "compare",+    "sheet": "C:/proj/Power.SchDoc"+   },+   "hint": "A sub-sheet renders with its real designators. compare renders at the baseline's width and passes when driftPercent <= threshold. show_* verbs open a window; this one does not.",+   "input": {+    "baseline": "set|compare",+    "drawingSheet": "bool, default true: include the frame and title block",+    "outputDir": "folder for the image (default beside the project)",+    "sheet": "path to the schematic sheet file (required)",+    "threshold": "percent of pixels, default 0.5 (compare)",+    "width": "int px, default 2000"+   },+   "longRunning": false,+   "name": "altium_render_schematic",+   "output": {+    "changedRegionMm": "[x1, y1, x2, y2] (compare)",+    "diffPng": "path: the changed pixels in red (compare)",+    "driftPercent": "number (compare)",+    "height": "int",+    "pass": "bool (compare)",+    "png": "path",+    "rendererChanged": "bool: the tool's plotter changed since the baseline",+    "width": "int"+   },+   "pitfalls": [+    "Anti-aliasing differs between tool versions: rendererChanged:true means drift may not be a design change.",+    "A baseline is per sheet and per width; a paper size change reads as 100 percent drift.",+    "Altium prints the sheet to PDF (through its project when one beside it lists the sheet) and Windows renders it.",+    "Altium's print now and then leaves the title block's special strings (=Title, sheet numbers) unfilled; a failed comparison prints once more and keeps the closer image (reprinted:true), so drift confined to the title block is usually that."+   ],+   "related": [+    "altium_export_pdf",+    "altium_show_schematic"+   ],+   "statusVerb": null,+   "summary": "Render a sheet to an image without opening a window, through the tool's own plotter, and keep visual baselines: baseline set stores the image, baseline compare reports the pixel drift, the changed region and a diff image.",+   "timeoutSeconds": 400+  },   {    "example": {     "connections": [