| Action | Description | Syntax | Plugin |
|---|---|---|---|
| About | Present the about box | About() | dialogs plugin |
| acompnet | Attempt to auto-complete the current network | acompnet() | acompnet plugin | +
| ActionString | Execute a pcb-rnd action parsing a string; syntac: "action(arg,arg,arg)" | ActionString(action) | script plugin |
| AddRats | Add one or more rat lines to the board. | AddRats(AllRats|SelectedRats|Close, [manhattan]) | |
| AddTimer | Add a new timer | AddTimer(action, period, [repeat], [userdata]) | script plugin |
| AdjustStyle | Open the dialog box for editing the route styles. | AdjustStyle([routestyle_idx]) | lib_hid_pcbui/route_style | @@ -27,7 +28,7 @@
| ArcNew | Create a pcb arc segment on a layer. For now data must be "pcb". Returns the idpath of the new object or 0 on error. | ArcNew([noundo,] data, layer, centx, centy, radiusx, radiusy, start_ang, delta_ang, thickness, clearance, flags) | act_draw |
| asm | Interactive assembly assistant | asm() | asm plugin |
| Atomic | Save or restore the undo serial number. | Atomic(Save|Restore|Close|Block) | - |
| Attributes | Let the user edit the attributes of the layout, current or given layer, or selected subcircuit. | Attributes(Layout|Layer|Element|Subc) Attributes(Layer,layername) | + |
| Attributes | Let the user edit the attributes of the layout, current or given layer, or selected subcircuit. | Attributes(Layout|Layer|Element|Subc) Attributes(Layer,layername) | oldactions plugin |
| autocrop | Autocrops the board dimensions to (extants + a margin of 1 grid), keeping the move and board size grid aligned | autocrop() | autocrop plugin |
| AutoPlaceSelected | Auto-place selected components. | AutoPlaceSelected() | autoplace plugin |
| AutoRoute | Auto-route some or all rat lines. | AutoRoute(AllRats|SelectedRats) | autoroute plugin | @@ -82,7 +83,7 @@
| Cursor | Move the cursor. | Cursor(Type,DeltaUp,DeltaRight,Units) | |
| CycleDrag | Cycle through which object is being dragged | CycleDrag() | |
| d1 | debug action for development | d1() | diag plugin | -
| dad | Manipulate Dynamic Attribute Dialogs | dad(dlgname, new) - create new dialog dad(dlgname, label, text) - append a label widget dad(dlgname, button, text) - append a button widget dad(dlgname, button_closes, label, retval, ...) - standard close buttons dad(dlgname, enum, choices) - append an enum (combo box) widget; choices is a tab separated list dad(dlgname, bool, [label]) - append an checkbox widget (default off) dad(dlgname, integer|real|coord, min, max, [label]) - append an input field dad(dlgname, string) - append a single line text input field dad(dlgname, progress) - append a progress bar (set to 0) dad(dlgname, tree, cols, istree, [header]) - append tree-table widget; header is like enum values dad(dlgname, tree_append, row, cells) - append after row (0 means last item of the root); cells is like enum values; returns a row pointer dad(dlgname, tree_append_under, row, cells) - append at the end of the list under row (0 means last item of the root); cells is like enum values; returns a row pointer dad(dlgname, tree_insert, row, cells) - insert before row (0 means first item of the root); cells is like enum values; returns a row pointer dad(dlgname, begin_hbox) - begin horizontal box dad(dlgname, begin_vbox) - begin vertical box dad(dlgname, begin_hpane) - begin horizontal paned box dad(dlgname, begin_vpane) - begin vertical paned box dad(dlgname, begin_table, cols) - begin table layout box dad(dlgname, begin_tabbed, tabnames) - begin a view with tabs; tabnames are like choices in an enum; must have as many children widgets as many names it has dad(dlgname, end) - end the last begin dad(dlgname, flags, flg1, flg2, ...) - change the flags of the last created widget dad(dlgname, onchange, action) - set the action to be called on widget change dad(dlgname, run, title) - present dlgname as a non-modal dialog dad(dlgname, run_modal, title) - present dlgname as a modal dialog dad(dlgname, exists) - returns wheter the named dialog exists (0 or 1) dad(dlgname, set, widgetID, val) - changes the value of a widget in a running dialog dad(dlgname, get, widgetID, [unit]) - return the current value of a widget | lib_hid_common plugin | +
| dad | Manipulate Dynamic Attribute Dialogs | dad(dlgname, new) - create new dialog dad(dlgname, label, text) - append a label widget dad(dlgname, button, text) - append a button widget dad(dlgname, button_closes, label, retval, ...) - standard close buttons dad(dlgname, enum, choices) - append an enum (combo box) widget; choices is a tab separated list dad(dlgname, bool) - append an checkbox widget (default off) dad(dlgname, integer|real|coord, min, max) - append an input field dad(dlgname, string) - append a single line text input field dad(dlgname, default, val) - set the default value of a widet while creating the dialog dad(dlgname, help, tooltip) - set the help (tooltip) text for the current widget dad(dlgname, progress) - append a progress bar (set to 0) dad(dlgname, preview, cb_act_prefix, minsize_x, minsize_y, [ctx]) - append a preview with a viewbox of 10*10mm, minsize in pixels dad(dlgname, tree, cols, istree, [header]) - append tree-table widget; header is like enum values dad(dlgname, tree_append, row, cells) - append after row (0 means last item of the root); cells is like enum values; returns a row pointer dad(dlgname, tree_append_under, row, cells) - append at the end of the list under row (0 means last item of the root); cells is like enum values; returns a row pointer dad(dlgname, tree_insert, row, cells) - insert before row (0 means first item of the root); cells is like enum values; returns a row pointer dad(dlgname, begin_hbox) - begin horizontal box dad(dlgname, begin_vbox) - begin vertical box dad(dlgname, begin_hpane) - begin horizontal paned box dad(dlgname, begin_vpane) - begin vertical paned box dad(dlgname, begin_table, cols) - begin table layout box dad(dlgname, begin_tabbed, tabnames) - begin a view with tabs; tabnames are like choices in an enum; must have as many children widgets as many names it has dad(dlgname, end) - end the last begin dad(dlgname, flags, flg1, flg2, ...) - change the flags of the last created widget dad(dlgname, onchange, action) - set the action to be called on widget change dad(dlgname, run, title) - present dlgname as a non-modal dialog dad(dlgname, run_modal, title) - present dlgname as a modal dialog dad(dlgname, exists) - returns wheter the named dialog exists (0 or 1) dad(dlgname, set, widgetID, val) - changes the value of a widget in a running dialog dad(dlgname, get, widgetID, [unit]) - return the current value of a widget | lib_hid_common plugin |
| ddraft | Enter 2d drafting CLI mode or execute command | ddraft([command]) | ddraft plugin |
| Debug | Debug action. | Debug(...) | oldactions plugin |
| DebugXY | Debug action, with coordinates | DebugXY(...) | oldactions plugin | @@ -92,7 +93,7 @@
| DescribeLocation | Return a string constant (valud until the next call) containing a short description at x;y (object, net, etc.) | DescribeLocation(x, y) | lib_hid_pcbui/status |
| DisableVendor | Disables automatic drill size mapping. | DisableVendor() | oldactions plugin |
| DisperseElements | Disperses subcircuits. | DisperseElements(All|Selected) | - |
| Display | Several display-related actions. | Display(SubcID, template) Display(Grid|Redraw|Pinout|PinOrPadName) Display(CycleClip|CycleCrosshair|ToggleAllDirections|ToggleStartDirection) Display(ToggleGrid|ToggleRubberBandMode|ToggleUniqueNames) Display(ToggleName|ToggleClearLine|ToggleFullPoly|ToggleSnapPin) Display(ToggleSnapOffGridLine|ToggleHighlightOnPoint|ToggleCheckPlanes) Display(ToggleThindraw|ToggleThindrawPoly|ToggleOrthoMove|ToggleLocalRef) Display(ToggleLiveRoute|ToggleShowDRC|ToggleAutoDRC|LockNames|OnlyNames) | + |
| Display | Several display-related actions. | Display(SubcID, template) Display(Grid|Redraw|Pinout|PinOrPadName) Display(CycleClip|ToggleAllDirections|ToggleStartDirection) Display(ToggleGrid|ToggleRubberBandMode|ToggleUniqueNames) Display(ToggleName|ToggleClearLine|ToggleFullPoly|ToggleSnapPin) Display(ToggleSnapOffGridLine|ToggleHighlightOnPoint|ToggleCheckPlanes) Display(ToggleThindraw|ToggleThindrawPoly|ToggleOrthoMove|ToggleLocalRef) Display(ToggleLiveRoute|ToggleShowDRC|ToggleAutoDRC|LockNames|OnlyNames) | |
| distribute | Distribute objects | Distribute(X/Y, [Lefts/Rights/Tops/Bottoms/Centers/Marks/Gaps, [First/Last/pcb_crosshair, First/Last/pcb_crosshair[, Gridless]]]) | distalign plugin |
| distributetext | Distribute objects | Distribute(X/Y, [Lefts/Rights/Tops/Bottoms/Centers/Marks/Gaps, [First/Last/pcb_crosshair, First/Last/pcb_crosshair[, Gridless]]]) | distalign plugin |
| djopt | Perform various optimizations on the current board. | djopt(debumpify|unjaggy|simple|vianudge|viatrim|orthopull) djopt(auto) - all of the above djopt(miter) | djopt | @@ -99,6 +100,10 @@
| dlg_confval_edit | Present a dialog box for editing the value of a conf node at path. | dlg_confval_edit(path, idx, role, [modal]) | dialogs plugin |
| dlg_obj_list | Let the user select an object from a list of objects | dlg_obj_list() | dialogs plugin |
| dlg_test | test the attribute dialog | dlg_test() | dialogs plugin | +
| DrawColor | Set pen color in of a gc. | DrawColor(gc, colorstr) | act_draw | +
| DrawLine | Low level draw (render) a line using graphic context gc. | DrawLine(gc, x1, y1, x2, y2, thickness) | act_draw | +
| DrawPoly | Low level draw (render) a polygon using graphic context gc. | DrawPoly(gc, x, y, x, y, x, y, [x, y...]) | act_draw | +
| DrawText | Low level draw (render) a text object using graphic context gc. | DrawText(gc, x, y, string, rot, scale_percent) | act_draw |
| DRC | Invoke the DRC check. Results are presented as the argument requests. | DRC([list|simple|print|log|dump]) | |
| DrcDialog | Execute drc checks and invoke a view list dialog box for presenting the results | DrcDialog([list|simple]) | dialogs plugin |
| DrcQueryDefMod | Automated DRC rule editing (for scripting and import) | DrcQueryDefMod(clear, source) DrcQueryDefMod(create, rule_name) DrcQueryDefMod(get, rule_name, field_name) DrcQueryDefMod(set, rule_name, field_name, value) | drc_query | @@ -149,6 +154,7 @@
| FontSave | Convert the current PCB back to a font. | FontSave() | fontmode plugin |
| Fontsel | Open the font selection dialog | Fontsel() | dialogs plugin |
| forcecolor | change selected objects' color to #RRGGBB, reset if does not start with '#' | forcecolor(#RRGGBB) | diag plugin | +
| formula_bisect | Find the value for exactly one of the arguments that produces the expected result. One argument must be a string with type:min:max:precision, the rest of the arguments and res must be numeric. | formula_bisect(action, res, args) | lib_formula plugin |
| fpas | Execute a script one-liner using a specific language | Oneliner(lang, script) | script plugin |
| fp_rehash | Flush the library index; rescan all library search paths and rebuild the library index. Useful if there are changes in the library during a pcb-rnd session. | fp_rehash() | |
| FreeRotateBuffer | Rotates the current paste buffer contents by the specified angle. The angle is given in degrees. If no angle is given, the user is prompted for one. | FreeRotateBuffer([Angle]) | @@ -171,6 +177,8 @@ |
| Help | On-line action help | Help() | |
| IDP | Basic idpath manipulation. | IDP([print|free|dup], idpath) | act_read |
| IDPList | Basic idpath list manipulation. | IDPList(alloc) IDPList(free|clear|print|dup|length, list) IDPList(get|pop|remove, list, idx) IDPList(prepend|append|push, list, idpath) | act_read | +
| impedance_coplanar_waveguide | Calculate the approximated impedance of a coplanar_waveguide transmission line, in ohms | impedance_coplanar_waveguide(trace_width, trace_clearance, subst_height, dielectric) | lib_formula plugin | +
| impedance_microstrip | Calculate the approximated impedance of a microstrip transmission line, in ohms | impedance_microstrip(trace_width, trace_height, subst_height, dielectric) | lib_formula plugin |
| Import | Import schematics. | Import() Import([gnetlist|make[,source,source,...]]) Import(setnewpoint[,(mark|center|X,Y)]) Import(setdisperse,D,units) | oldactions plugin |
| ImportcpcbFrom | Loads the auto-routed tracks from the specified c-pcb output. | ImportcpcbFrom(filename) | cpcb plugin |
| ImportGUI | Asks user which schematics to import into PCB. | ImportGUI() | oldactions plugin | @@ -186,7 +194,7 @@
| IsPointOnLine | Returns 1 if point x;y with radius r is on the line addressed by idpath, 0 else. | IsPointOnLine(x, y, r, idpath) | act_read |
| jostle | Make room by moving wires away. | Jostle(diameter) | jostle plugin |
| l | Loads layout data. | l [name] [format] | shand_cmd plugin | -
| LayerBinding | Change the layer binding. | LayerBinding(object) LayerBinding(selected) LayerBinding(buffer) | dialogs plugin | +
| LayerBinding | Change the layer binding. | LayerBinding(object) LayerBinding(buffer) | dialogs plugin |
| LayerByStack | Layer operations based on physical layer stacking | LayerByStack(select, prev|next) | |
| LayerHotkey | Change the key binding for a layer | LayerHotkey(layer, select|vis) | lib_hid_pcbui/actions |
| LayerObjDup | Duplicate srcobj on a layer. Srcobj is specified by an idpath. For now data must be "pcb". Returns the idpath of the new object or 0 on error. | LayerObjDup([noundo,] data, layer, srcobj) | act_draw | @@ -213,6 +221,7 @@
| LoadLtspiceFrom | Loads the specified ltspice .net and .asc file - the netlist must be mentor netlist. | LoadLtspiceFrom(filename) | ltspice importer |
| LoadMentorFrom | Loads the specified Mentor Graphics Design Capture schematics flat .edf file. | LoadMentorFrom(filename) | mentor_sch importer |
| LoadMucsFrom | Loads the specified mucs routing file. | LoadMucsFrom(filename) | mucs importer | +
| LoadPadsNetFrom | Loads the specified pads ascii netlist .asc file. | LoadPadsNetFrom(filename) | pads_net importer |
| LoadPixmap | Loads a pixmap image from disk and creates a gfx object in buffer. | LoadPixmap([filename]) | |
| LoadScript | Load a fungw script | LoadScript(id, filename, [language]) | script plugin |
| LoadTedaxFrom | Loads the specified block from a tedax file. | LoadTedaxFrom(netlist|board|footprint|stackup|layer|drc|drc_query, filename, [block_id, [silent, [src]]]) | tEDAx IO | @@ -224,6 +233,7 @@
| m | Loads a layout into the current buffer. | m [name] | shand_cmd plugin |
| ManagePlugins | Manage plugins dialog. | ManagePlugins() | dialogs plugin |
| MarkCrosshair | Set/Reset the pcb_crosshair mark. | MarkCrosshair() MarkCrosshair(Center) | + |
| MenuPatch | Manage menu patches | MenuPatch(load, cookie, path, desc) MenuPatch(unload, cookie) MenuPatch(list) MenuPatch(InhibitInc|InhibitDec) | |
| mesh | generate a mesh for simulation | mesh() | openems HID |
| Message | Writes a message to the log window. | message([ERROR|WARNING|INFO|DEBUG,] message) | |
| MessageBox | Open a modal message dialog box with title and label. If icon string is not empty, display the named icon on the left. Present one or more window close buttons with different text and return value. | MessageBox(icon, title, label, button_txt, button_retval, ...) | @@ -242,8 +252,9 @@ |
| NetlistChanged | Tells the GUI that the netlist has changed. | NetlistChanged() | oldactions plugin |
| NetlistDialog | Open the netlist dialog or refresh network lengths in an already open dialog. | NetlistDialog([RefreshNetLens]) | dialogs plugin |
| New | Starts a new layout. | New([name]) | - |
| NewGroup | Create a new layer group with a single, positive drawn layer in it | NewGroup(type [,location [, purpose[, auto|sub [,name[,grp_attribs]]]]) | + |
| NewGroup | Create a new layer group with a single, positive drawn layer in it | NewGroup(type [,location [, purpose[, auto|sub [,name[,grp_attribs[,unique|first|last]]]]]) | |
| Normalize | Move all objects within the drawing area (or buffer 0;0), align the drawing to 0;0 (or set buffer grab point to 0;0) | Normalize([board|buffer[n]]) | + |
| ObjCenter | Returns the x or y coordinate of the center of an object | ObjCenter(idpath, x|y) | act_read |
| Oneliner | Execute a script one-liner using a specific language | Oneliner(lang, script) | script plugin |
| OpenemsExcitation | Select which openEMS excitation method should be exported and manipulate the associated parameters. When invoked without arguments a dialog box with the same functionality is presented. | OpenemsExcitation([interactive]) OpenemsExcitation(select, excitationname) OpenemsExcitation(set, [excitationnme], paramname, paramval) OpenemsExcitation(get, [excitationnme], paramname) | openems HID |
| OptAutoOnly | Toggles the optimize-only-autorouted flag. | OptAutoOnly() | oldactions plugin | @@ -310,12 +321,12 @@
| QueryCompileField | With "compile": precompiles textual field name to field ID; with "free": frees the memory allocated for a previously precompiled fieldID. | QueryCompileField(compile, fieldname) QueryCompileField(free, fieldID) | query plugin |
| QueryObj | Return the value of a field of an object, addressed by the object's idpath and the field's name or precompiled ID. Returns NIL on error. | QueryObj(idpath, [.fieldname|fieldID]) | query plugin |
| Quit | Quits the application after confirming. | Quit() | - |
| ReadGroup | Length returns the number of groups on the current PCB. Field returns one of the fields of the group named in groupid. Layerid returns the integer layer ID (as interpreted within data) for the idxth layer of the group. | ReadGroup(length) ReadGroup(field, group, [init_invis|ltype|ltypestr|name|open|purpose|vis|length]) ReadGroup(layerid, idx) | act_read | +
| ReadGroup | Length returns the number of groups on the current PCB. Field returns one of the fields of the group named in groupid. Layerid returns the integer layer ID (as interpreted within data) for the idxth layer of the group. | ReadGroup(length) ReadGroup(field, group, [init_invis|ltype|ltypestr|ltypehas|name|open|purpose|vis|length]) ReadGroup(layerid, group, idx) | act_read |
| Redo | Redo recent "undo" operations. | redo() | |
| Redraw | Redraw the entire screen | Redraw() | |
| regpoly | Generate regular polygon. Where is x;y and radius is either r or rx;ry. Rotation is in degrees. | regpoly([where,] corners, radius [,rotation]) | shape plugin |
| ReloadScript | Reload a fungw script | ReloadScript(id) | script plugin | -
| RemoveMenu | Recursively removes a new menu, popup (only path specified) or submenu. | RemoveMenu(path|cookie) | + |
| RemoveMenu | Recursively removes a new menu, popup (only path specified) or submenu. | RemoveMenu(path, cookie) | |
| RemoveSelected | Removes any selected objects. | pcb_remove_selected() | |
| Renumber | Renumber all subcircuits. The changes will be recorded to filename for use in backannotating these changes to the schematic. | Renumber() Renumber(filename) | renumber plugin |
| RenumberBlock | TODO | RenumberBlock(old_base,new_base) | renumber plugin | @@ -327,7 +338,7 @@
| rn | Reads netlist. | rn [name] | shand_cmd plugin |
| Rotate90 | Rotates the object under the crosshair by 90 degree steps. | pcb_move_obj(steps) | |
| roundrect | Generate a rectangle with round corners | roundrect([where,] width[;height] [,rx[;ry] [,rotation [,cornstyle [,roundness]]]]) | shape plugin | -
| RouteStyle | Copies the indicated routing style into the current pen. | RouteStyle(style_id|style_name) | + |
| RouteStyle | Without second argument: copies the indicated routing style into the current pen; with second argument sets or gets a field of the routing style. | RouteStyle(style_id|style_name|current, [set|get, width|clearance, [value]]) | |
| RouteStylesChanged | Tells the GUI that the routing styles have changed. | RouteStylesChanged() | oldactions plugin |
| s | Saves layout data. | s [name] w [name] | shand_cmd plugin |
| Save | Save layout data to a user-selected file. | Save() Save(Layout|LayoutAs) Save(AllConnections|AllUnusedPins|ElementConnections) Save(PasteBuffer) Save(DialogByPattern, pcb|footprint|font|buffer, none|board|fp, prompt, [default_pattern]) | dialogs plugin | @@ -334,7 +345,7 @@
| SaveFontTo | Save PCB font to a file | SaveFontTo([file, id]) | |
| SaveLib | Saves all subcircuits to a library file or directory from a board or buffer. | SaveLib(file|dir, board|buffer, [filename], [fmt]) | |
| SavePatch | Save netlist patch for back annotation. | SavePatch(filename) | - |
| SaveTedax | Saves the specific type of data in a tEDAx file. | SaveTedax(netlist|board-footprints|stackup|layer|board|drc|etest, filename) SaveTedax(drc_query, filename, [rule_name]) | tEDAx IO | +
| SaveTedax | Saves the specific type of data in a tEDAx file. | SaveTedax(netlist|board-footprints|stackup|layer|board|drc|etest, filename) SaveTedax(drc_query, filename, [rule_name])SaveTedax(route_req, filename) | tEDAx IO |
| SaveTo | Saves data to a file. | SaveTo(Layout|LayoutAs,filename,[fmt]) SaveTo(PasteBuffer,filename,[fmt]) | |
| ScaleBuffer | Scales the buffer by multiplying all coordinates by a floating point number. If only x is given, it is also used for y and thickness too. If subc is not empty, subcircuits are also scaled | ScaleBuffer(x [,y [,thickness [,subc]]]) | |
| ScriptCookie | Return a cookie specific to the current script instance during script initialization | ScriptCookie() | script plugin |