design_live_snapshot
Publishes a PCB board to the live view as a new version from the current EDA state, a saved LayoutBoard JSON, or the last published board, and highlights changes since the previous version.
Instructions
Publish a board to the live view as its next version.
The placement and routing jobs publish on their own, and their
apply tools republish what they wrote. Use this for any other
board state: the board as it is in the EDA now (expect_file),
a board saved as LayoutBoard JSON (LayoutBoard.save, .json
or .json.gz), or the last board again with a note. The Layout
tab highlights what changed since the version before.
Only expect_file calls the bridge: it reads the focused board
exactly (pcb.get_layout_model), a few seconds on a large board.
It is never done on its own, because reading some boards has
crashed Altium's scripting engine.
Args: note: what this snapshot shows; also logged as a decision. board_json_path: a LayoutBoard JSON file. expect_file: full path of the focused board, to read it from Altium as it is now. The read refuses if another board is focused. (Neither: republish the board the last engine job, apply or snapshot in this server published.)
Returns:
{"version", "board", "status": {nets, routed, partly, not_started}, "changes": {added, moved, removed}, "seconds", "url"}, or {"error": ...}.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| note | No | ||
| expect_file | No | ||
| board_json_path | No |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
No arguments | |||