vw_import_hookup
Imports channel hookups or instrument schedules from CSV/TSV exports into Vectorworks Lighting Devices, previewing planned changes first and applying them as one revertible, all-or-nothing update.
Instructions
Load a channel hookup or instrument schedule from a spreadsheet export into the Lighting Devices, as a dry run first and then one revertible step.
Changes the document only with dry_run=False. Each row is matched to exactly
one device by key; the other columns are written as Lighting Device fields
when their header is a field name, unknown headers are ignored and listed,
empty cells are not written. The dry run returns {dry_run, rows, updates
(the planned per-device changes), ignored_columns, skipped_rows, next_step}.
Applying goes through vw_set_lighting_device_fields: all-or-nothing (a row
that matches no device, or several, stops everything), undone with
vw_revert_last, with result holding before/after and not_applied for
values Spotlight overrode. For a handful of edits call
vw_set_lighting_device_fields directly.
Tool call template
Replace each placeholder with a value matching the input schema. Only required parameters are included; add optional parameters as needed.
{
"id": 1,
"jsonrpc": "2.0",
"method": "tools/call",
"params": {
"arguments": {
"path": "<path>"
},
"name": "vw_import_hookup"
}
}Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| key | No | Which column(s) identify the device each row belongs to: "channel" (default, the Channel column), "unit_number" (only when unit numbers are unique in the whole plot) or "position+unit_number" (Position and Unit Number columns together; unit numbers repeat per position). | channel |
| path | Yes | Path on this Mac to a .csv or .tsv exported from the spreadsheet; the first row holds the column headers. | |
| dry_run | No | True (default) changes nothing and returns the plan to show the user; False applies it and then needs `document`. | |
| document | No | Name of the document this call is meant for (as vw_list_documents shows it, with or without .vwx). If another document is active nothing changes; use vw_switch_document first. Always set it for a write. Required when dry_run is False. | |
| column_map | No | Spreadsheet header to Lighting Device field name, for headers the automatic match does not understand, for example {"What": "Purpose"}. Automatic matches are case-insensitive and know Address/Addr/DMX (UniverseAddress), Unit (Unit Number), Inst/Type (Inst Type) and Gel (Color). Omit when the headers are field names. |