pcb-rnd User Manual: Appendix

Action Reference

This is pcb-rnd 2.2.1 (svn r31696) an interactive printed circuit board editor , Revision: 31737
Action Description Syntax Plugin
AboutPresent the about boxAbout()dialogs plugin
acompnetAttempt to auto-complete the current networkacompnet()acompnet plugin
AddRatsAdd one or more rat lines to the board.AddRats(AllRats|SelectedRats|Close, [manhattan])
AddTimerAdd a new timerAddTimer(action, period, [repeat], [userdata])script plugin
AdjustStyleOpen the dialog box for editing the route styles.AdjustStyle([routestyle_idx])lib_hid_pcbui/route_style
alignAlign objectsAlign(X/Y, [Lefts/Rights/Tops/Bottoms/Centers/Marks, [First/Last/pcb_crosshair/Average[, Gridless]]])distalign plugin
aligntextAlign objectsAlign(X/Y, [Lefts/Rights/Tops/Bottoms/Centers/Marks, [First/Last/pcb_crosshair/Average[, Gridless]]])distalign plugin
ApplyVendorApplies the currently loaded vendor drill table to the current design.ApplyVendor()vendor drill mapping
ArcNewCreate 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
asmInteractive assembly assistantasm()asm plugin
AtomicSave or restore the undo serial number.Atomic(Save|Restore|Close|Block)
AttributesLet the user edit the attributes of the layout, current or given
layer, or selected subcircuit.
Attributes(Layout|Layer|Element|Subc)
Attributes(Layer,layername)
autocropAutocrops the board dimensions to (extants + a margin of 1 grid), keeping the move and board size grid alignedautocrop()autocrop plugin
AutoPlaceSelectedAuto-place selected components.AutoPlaceSelected()autoplace plugin
AutoRouteAuto-route some or all rat lines.AutoRoute(AllRats|SelectedRats)autoroute plugin
BackupBackup the current layout - save using the same method that the timed backup function usesBackup()
basExecute a script one-liner using a specific languageOneliner(lang, script)script plugin
BellAttempt to produce audible notification (e.g. beep the speaker).Bell()oldactions plugin
BenchmarkBenchmark the GUI speed.Benchmark()
BoardFlipMirror the board over the x axis, optionally mirroring sides as well.BoardFlip([sides])
BraveChanges brave settings.Brave()
Brave(setting, on|off)
BrowseScriptsPresent a dialog box for browsing scriptsBrowseScripts()script plugin
camExport jobs for feeding cam processescam(exec, script, [options])
cam(call, jobname, [options])
cam([gui])
cam exporter
CenterMoves the pointer to the center of the window.Center()lib_hid_common plugin
ChangeAngleChanges the start angle, delta angle or both angles of an arc.ChangeAngle(Object, start|delta|both, delta)
ChangeAngle(SelectedObjects|Selected, start|delta|both, delta)
ChangeAngle(SelectedArcs, start|delta|both, delta)
ChangeClearSizeChanges the clearance size of objects.ChangeClearSize(Object, delta|style)
ChangeClearSize(SelectedPins|SelectedPads|SelectedVias, delta|style)
ChangeClearSize(SelectedLines|SelectedArcs, delta|style)
ChangeClearSize(Selected|SelectedObjects, delta|style)
ChangeDrillSizeChanges the drilling hole size of objects.ChangeDrillSize(Object, delta|style)
ChangeDrillSize(SelectedPins|SelectedVias|Selected|SelectedObjects, delta|style)
ChangeFlagSets or clears flags on objects.ChangeFlag(Object|Selected|SelectedObjects, flag, value)
ChangeFlag(SelectedLines|SelectedPins|SelectedVias, flag, value)
ChangeFlag(SelectedPads|SelectedTexts|SelectedNames, flag, value)
ChangeFlag(SelectedElements, flag, value)
flag = thermal | join
value = 0 | 1
ChangeHoleoldactions plugin
ChangeJoinChanges the join (clearance through polygons) of objects.ChangeJoin(ToggleObject|SelectedLines|SelectedArcs|Selected)
ChangeNameSets the name, text string, terminal ID or refdes of objects.ChangeName(Object)
ChangeName(Refdes)
ChangeName(Layout|Layer)
ChangeNonetlistChanges the nonetlist flag of subcircuits.ChangeNonetlist(ToggleObject)
ChangeNonetlist(SelectedElements)
ChangeNonetlist(Selected|SelectedObjects)
ChangeOctagonoldactions plugin
ChangePasteoldactions plugin
ChangePinNameSets the name of a specific pin on a specific subcircuit.ChangePinName(Refdes,PinNumber,PinName)
ChangeRadiusChanges the width or height (radius) of an arc.ChangeRadius(Object, width|x|height|y|both, delta)
ChangeRadius(SelectedObjects|Selected, width|x|height|y|both, delta)
ChangeRadius(SelectedArcs, width|x|height|y|both, delta)
ChangeSizeChanges the size of objects.ChangeSize(Object, delta|style)
ChangeSize(SelectedObjects|Selected, delta|style)
ChangeSize(SelectedLines|SelectedPins|SelectedVias, delta|style)
ChangeSize(SelectedPads|SelectedTexts|SelectedNames, delta|style)
ChangeSize(SelectedElements, delta|style)
ChangeSizesChanges all sizes of objects.ChangeSizes(Object, delta|style)
ChangeSizes(SelectedObjects|Selected, delta|style)
ChangeSizes(SelectedLines|SelectedPins|SelectedVias, delta|style)
ChangeSizes(SelectedPads|SelectedTexts|SelectedNames, delta|style)
ChangeSizes(SelectedElements, delta|style)
ChangeSquareoldactions plugin
ChkBufferReturn 1 if currently selected buffer's index matches idxChkBuffer(idx)
ChkGridSizeReturn 1 if the currently selected grid matches the expected_size. If argument is "none" return 1 if there is no grid.ChkGridSize(expected_size)
ChkGridSize(none)
ChkGridUnitsReturn 1 if currently selected grid unit matches the expected (normally mm or mil)ChkGridUnits(expected)
ChkLayerReturns 1 if the specified layer is the active layerChkLayer(layerid)
ChkModeReturn 1 if the currently selected mode is the expected_modeChkMode(expected_mode)
ChkRstReturn 1 if route_style_id matches pen.ChkRst(route_style_id)
ChkSubcIDReturn 1 if currently shown subc ID matches the requested patternChkSubcID(pattern)
ChkTermIDReturn 1 if currently shown term ID matches the requested patternChkTermID(pattern)
ChkViewReturn 1 if layerid is visible.ChkView(layerid)
circleGenerate a filled circle (zero length round cap line)circle([where,] diameter)shape plugin
claimnetClaim existing connections and create a new netClaimNet(object|selected|found,[netname])
ClearOctagonoldactions plugin
ClearSquareoldactions plugin
ClipInhibitClipInhibit Feature Template.ClipInhibit([on|off|check])
cli_MessageBoxIntenal: CLI frontend action. Do not use directly.
cli_PromptForIntenal: CLI frontend action. Do not use directly.
ClrFlagClears flags on objects.ClrFlag(Object|Selected|SelectedObjects, flag)
ClrFlag(SelectedLines|SelectedPins|SelectedVias, flag)
ClrFlag(SelectedPads|SelectedTexts|SelectedNames, flag)
ClrFlag(SelectedElements, flag)
flag = thermal | join
CommandDisplays the command line input in the status area.Command()lib_hid_common plugin
confPerform various operations on the configuration tree.conf(set, path, value, [role], [policy]) - change a config setting to an absolute value
conf(delta, path, value, [role], [policy]) - change a config setting by a delta value (numerics-only)
conf(toggle, path, [role]) - invert boolean value of a flag; if no role given, overwrite the highest prio config
conf(reset, role) - reset the in-memory lihata of a role
conf(iseq, path, value) - returns whether the value of a conf item matches value (for menu checked's)
ConnectionSearches connections of the object at the cursor position.Connection(Find|ResetLinesAndPolygons|ResetPinsAndVias|Reset)
constraintConfigure or remove a drawing constraintconstraint(type, off)
constraint(type, value, [value...])
ddraft plugin
cpcbExecuted external autorouter cpcb to route the board or parts of the boardcpcb(board|selected, [command])cpcb plugin
CreateMenuCreates a new menu, popup (only path specified) or submenu (at least path and action are specified)CreateMenu(path)
CreateMenu(path, action, tooltip, cookie)
CreateTextCreate a new text objectCreateText(layer, fontID, X, Y, direction, scale, text)
CursorMove the cursor.Cursor(Type,DeltaUp,DeltaRight,Units)
CycleDragCycle through which object is being draggedCycleDrag()
d1debug action for developmentd1()diag plugin
dadManipulate Dynamic Attribute Dialogsdad(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
ddraftEnter 2d drafting CLI mode or execute commandddraft([command])ddraft plugin
DebugDebug action.Debug(...)oldactions plugin
DebugXYDebug action, with coordinatesDebugXY(...)oldactions plugin
DeleteDelete stuff.Delete(Object [,idpath])
Delete(Selected)
Delete(AllRats|SelectedRats)
DeleteRatsDelete rat lines.DeleteRats(AllRats|Selected|SelectedRats)
DelGroupRemove a layer group; if the first argument is not specified, the current group is removedDelGroup([@group])
DescribeLocationReturn 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
DisableVendorDisables automatic drill size mapping.DisableVendor()oldactions plugin
DisperseElementsDisperses subcircuits.DisperseElements(All|Selected)
DisplaySeveral 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)
distributeDistribute objectsDistribute(X/Y, [Lefts/Rights/Tops/Bottoms/Centers/Marks/Gaps, [First/Last/pcb_crosshair, First/Last/pcb_crosshair[, Gridless]]])distalign plugin
distributetextDistribute objectsDistribute(X/Y, [Lefts/Rights/Tops/Bottoms/Centers/Marks/Gaps, [First/Last/pcb_crosshair, First/Last/pcb_crosshair[, Gridless]]])distalign plugin
djoptPerform various optimizations on the current board.djopt(debumpify|unjaggy|simple|vianudge|viatrim|orthopull)
djopt(auto) - all of the above
djopt(miter)
djopt
dlg_confval_editPresent a dialog box for editing the value of a conf node at path.dlg_confval_edit(path, idx, role, [modal])dialogs plugin
dlg_obj_listLet the user select an object from a list of objectsdlg_obj_list()dialogs plugin
dlg_testtest the attribute dialogdlg_test()dialogs plugin
DRCInvoke the DRC check. Results are presented as the argument requests.DRC([list|simple|print|log|dump])
DrcDialogExecute drc checks and invoke a view list dialog box for presenting the resultsDrcDialog([list|simple])dialogs plugin
DrcQueryDefModAutomated 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
DrcQueryEditRuleInteractive, GUI based DRC rule editorDrcQueryEditRule(role, path, rule)
DrcQueryEditRule(role, rule)
drc_query
DrcQueryExportExport a rule and related definitions to a file.DrcQueryExport(ruleID, [filename], [format])drc_query
DrcQueryImportImport a rule and related definitions from a file.DrcQueryImport([filename])drc_query
DrcQueryListRulesList all drc rules implemented in drc_queryDrcQueryListRules()drc_query
DrcQueryRuleModAutomated DRC rule editing (for scripting and import)DrcQueryRuleMod(clear, source)
DrcQueryRuleMod(create, rule_name)
DrcQueryRuleMod(get, rule_name, field_name)
DrcQueryRuleMod(set, rule_name, field_name, value)
drc_query
DumpActionsDump all actions available.DumpActions()
dumpconfPerform various operations on the configuration tree.dumpconf(native, [verbose], [prefix]) - dump the native (binary) config tree to stdout
dumpconf(lihata, role, [prefix]) - dump in-memory lihata representation of a config tree
diag plugin
DumpCsectPrint the cross-section of the board (layer stack)DumpCsect()draw_csect
dumpdataDump an aspect of the datadumpdata()diag plugin
dumpflagsdump flags, optionally using the format string provided by the userdumpflags([fmt])diag plugin
dumpfontsPrint info about fontsdumpfonts()diag plugin
dumpidsDump the ID hashDumpIDs()diag plugin
dumplayersPrint info about each layerdumplayers([all])diag plugin
DumpLibFootprintprint footprint file and metadata to stdoutDumpLibFootprint(footprintname, [bbox|origin])diag plugin
DumpLibraryDisplay the entire contents of the libraries.DumpLibrary()oldactions plugin
DumpObjFlagsPrint a script processable digest of all flags, per object typeDumpObjFlags()
DumpPluginDirsPrint plugins directories in a format digestable by scripts.DumpPluginDirs()
DumpPluginsPrint plugins loaded in a format digestable by scripts.DumpPlugins()
dumpundoPrint info about fontsdumpfonts()diag plugin
DumpVersionDump version in script readable format.DumpVersion()
DupGroupDuplicate a layer group; if the first argument is not specified, the current group is duplicatedDupGroup([@group])
EditGroupChange a property or attribute of a layer group. If the first argument starts with @, it is taken as the group name to manipulate, else the action uses the current layer's group. Without arguments or if only a layer name is specified, interactive runs editing.Editgroup([@group], [name=text|type=+bit|type=-bit])]
Editlayer([@layer], attrib, key=value)
EditLayerChange a property or attribute of a layer. If the first argument starts with @, it is taken as the layer name to manipulate, else the action uses the current layer. Without arguments or if only a layer name is specified, interactive runs editing.Editlayer([@layer], [name=text|auto=[0|1]|sub=[0|1])]
Editlayer([@layer], attrib, key=value)
ElementListAdds the given element if it doesn't already exist.ElementList(Start|Done|Need,,,)
ElementSetAttrSets or clears an element-specific attribute.ElementSetAttr(refdes,name[,value])
EnableVendorEnables automatic drill size mapping.EnableVendor()oldactions plugin
EvalConfPerform various operations on the configuration tree.EvalConf(path) - evaluate a config path in different config sources to figure how it ended up in the native databasediag plugin
ExecCommandRun shell commandSystem(shell_cmd)
ExecuteFileRun actions from the given file.ExecuteFile(filename)
ExpFeatTmpExperimental Feature Template.ExpFeatTmp(...)experimental features plugin
ExportExport the current layout, e.g. Export(png, --dpi, 600)Export(exporter, [exporter-args])
ExportcpcbToDumps the current board in c-pcb format.ExportcpcbTo(filename)cpcb plugin
ExportGUIOpen the export dialog.ExportGUI()dialogs plugin
ExportOldConnExport galvanic connection data in an old, custom file format.ExportOldConn(AllConnections|AllUnusedPins|ElementConnections,filename)export_oldconn HID
ExportScadPolyexports all selected polygons to an openscad script; only the outmost contour of each poly is exportedScadExportPoly(filename)openscad HID
exteditextedit(object|selected|buffer, [interactive|method])Invoke an external program to edit a specific part of the current board.extedit plugin
ExtobjConvFromCreate a new extended object of extotype by converting existing objectsExtobjConvFrom(selected|buffer, extotype)
ExtobjConvFrom(object, extotype, [idpath])
ExtobjGUIPropEditInvoke the extobj-implementation-specific GUI property editor, if availableExtobjGUIPropEdit([object, [idpath]])
fawkExecute a script one-liner using a specific languageOneliner(lang, script)script plugin
fbasExecute a script one-liner using a specific languageOneliner(lang, script)script plugin
find2perfMeasure the peformance of find2.cfind2perf()diag plugin
FlagEditChange the layer binding.FlagEdit(object)dialogs plugin
FlipFlip a subcircuit to the opposite side of the board.Flip(Object|Selected)
FontEditConvert the current font to a PCB for editing.FontEdit()fontmode plugin
FontSaveConvert the current PCB back to a font.FontSave()fontmode plugin
FontselOpen the font selection dialogFontsel()dialogs plugin
forcecolorchange selected objects' color to #RRGGBB, reset if does not start with '#'forcecolor(#RRGGBB)diag plugin
fpasExecute a script one-liner using a specific languageOneliner(lang, script)script plugin
fp_rehashFlush 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()
FreeRotateBufferRotates 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])
FullScreenHide widgets to get edit area full screenFullScreen(on|off|toggle)
GetMarkReturn mark properties in numeric form.GetMark(active|user_placed|x|y)act_read
GetParentDataReturn the closest upstream pcb_data_t * parent of an objectGetParentData([root_data,] idpath)act_read
GetStyleReturn integer index (>=0) of the currently active style or -1 if no style is selected (== custom style)GetStyle()
GetValueConvert a coordinate value. Returns an unitless double or FGW_ERR_ARG_CONV. The 3rd parameter controls whether to require relative coordinates (+- prefix). Wraps rnd_get_value_ex().GetValue(input, units, relative, default_unit)act_read
GetXYGet a coordinate. If x or y specified, the return value of the action is the x or y coordinate.GetXY([message, [x|y]])
GfxModModify a gfx object: set transparent pixel on the pixmap or resize by measurementGfxMod(transparent, [idpath, [#rrggbb]])
GfxMod(transparent, [idpath, [x, y]])
GfxMod(resize, [idpath, [pdx, pdy1, len]])
GlobalPullerPull all traces tight. With no argument it runs on the current layer.pcb_act_GlobalPuller([Found|Selected])puller plugin
GridSet the grid.grid(set, [name:]size[@offs][!unit])
grid(+|up)
grid(-|down)
grid(#N)
grid(idx, N)
GroupPropGuiChange group flags and propertiesGroupPropGui(groupid)dialogs plugin
gui_FallbackColorPickIntenal: GUI frontend action. Do not use directly.lib_hid_common plugin
gui_fpmap_chooseInternal call action for a dialog to select a footprint from a map.gui_fpmap_choose(map)dialogs plugin
gui_MayOverwriteFileIntenal: GUI frontend action. Do not use directly.lib_hid_common plugin
gui_MessageBoxIntenal: GUI frontend action. Do not use directly.lib_hid_common plugin
gui_PromptForIntenal: GUI frontend action. Do not use directly.lib_hid_common plugin
hPrint a help message for commands.hshand_cmd plugin
HelpOn-line action helpHelp()
IDPBasic idpath manipulation.IDP([print|free|dup], idpath)act_read
IDPListBasic 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
ImportImport schematics.Import()
Import([gnetlist|make[,source,source,...]])
Import(setnewpoint[,(mark|center|X,Y)])
Import(setdisperse,D,units)
oldactions plugin
ImportcpcbFromLoads the auto-routed tracks from the specified c-pcb output.ImportcpcbFrom(filename)cpcb plugin
ImportGUIAsks user which schematics to import into PCB.ImportGUI()oldactions plugin
ImportSchImport schematics/netlist.ImportSch()
ImportSch(reimport)
ImportSch(setup, importer, [args...])
import_sch2 plugin
Inforeport plugin
InfoBarFileChangedPresent the "file changed" warning info bar with buttons to reload or cancelInfoBarFileChanged(open|close)dialogs plugin
integrityperform integrirty check on the current board and generate errors if neededintegrity()diag plugin
IntersectObjObjReturns 1 if point x;y with radius r is on the arc addressed by idpath, 0 else.IntersectObjObj(idpath, idpath)act_read
IOIncompatListPresent the format incompatibilities of the last save to file operation.IOIncompatList([list|simple])
IOIncompatListDialogPresent the format incompatibilities of the last save to file operation in a GUI dialog.IOIncompatListDialog([list|simple])dialogs plugin
ircnon-modal, single-instance, single-server, single-channel irc window for online supportirc()irc plugin
IsPointOnArcReturns 1 if point x;y with radius r is on the arc addressed by idpath, 0 else.IsPointOnArc(x, y, r, idpath)act_read
IsPointOnLineReturns 1 if point x;y with radius r is on the line addressed by idpath, 0 else.IsPointOnLine(x, y, r, idpath)act_read
jostleMake room by moving wires away.Jostle(diameter)jostle plugin
lLoads layout data.l [name] [format]shand_cmd plugin
LayerBindingChange the layer binding.LayerBinding(object)
LayerBinding(selected)
LayerBinding(buffer)
dialogs plugin
LayerByStackLayer operations based on physical layer stackingLayerByStack(select, prev|next)
LayerHotkeyChange the key binding for a layerLayerHotkey(layer, select|vis)lib_hid_pcbui/actions
LayerObjDupDuplicate 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
LayerPropGuiChange layer flags and propertiesLayerPropGui(layerid)dialogs plugin
LayerVisResetReset layer visibility to safe defaults.LayerVisReset()
leLoads an element (subcircuit, footprint) into the current buffer.le [name]shand_cmd plugin
LibraryChangedTells the GUI that the libraries have changed.LibraryChanged()oldactions plugin
LibraryDialogOpen the library dialog.libraryDialog()dialogs plugin
LineNewCreate a pcb line segment on a layer. For now data must be "pcb". Returns the idpath of the new object or 0 on error.LineNew([noundo,] data, layer, X1, Y1, X2, Y2, Thickness, Clearance, Flags)act_draw
ListRotationsoldactions plugin
ListScriptsList fungw scripts, optionally filtered wiht regex pat.ListScripts([pat])script plugin
LiveScriptManage a live scriptLiveScript([new], [name])
LiveScript(load|save, name, [filame])
LiveScript(run|stop|rerun|undo, name)
script plugin
LoadLoad layout data from a user-selected file.Load()
Load(Layout|LayoutToBuffer|ElementToBuffer|Netlist|Revert)
dialogs plugin
LoadCalayFromLoads the specified calay netlist/component file pair.LoadCalayFrom(filename)calay importer
LoadDsnFromLoads the specified routed dsn file.LoadDsnFrom(filename)dsn importer
LoadEeschemaFromLoads the specified eeschema .net file - the netlist must be an s-expression.LoadEeschemaFrom(filename)kicad plugin
LoadFontFromLoad PCB font from a fileLoadFontFrom([file, id])
LoadFootprintLoads a single footprint by name.LoadFootprint(filename[,refdes,value])
LoadFpcbnlFromLoads the specified freepcb netlist.LoadFpcbnlFrom(filename)fpcb_nl importer
LoadFromLoad layout data from a file.LoadFrom(Layout|LayoutToBuffer|SubcToBuffer|Netlist|Revert,filename[,format])
LoadHpglFromLoads the specified hpgl plot file to the current bufferLoadHpglFrom(filename)hpgl importer
LoadhypFromLoads the specified Hyperlynx file.LoadhypFrom(filename[, "debug"]...)hyp importer
LoadIpc356FromLoads the specified IPC356-D netlistLoadIpc356From(filename, [nonet], [nopad], [nosubc])ipcd356 importer
LoadLtspiceFromLoads the specified ltspice .net and .asc file - the netlist must be mentor netlist.LoadLtspiceFrom(filename)ltspice importer
LoadMentorFromLoads the specified Mentor Graphics Design Capture schematics flat .edf file.LoadMentorFrom(filename)mentor_sch importer
LoadMucsFromLoads the specified mucs routing file.LoadMucsFrom(filename)mucs importer
LoadPixmapLoads a pixmap image from disk and creates a gfx object in buffer.LoadPixmap([filename])
LoadScriptLoad a fungw scriptLoadScript(id, filename, [language])script plugin
LoadTedaxFromLoads the specified block from a tedax file.LoadTedaxFrom(netlist|board|footprint|stackup|layer|drc|drc_query, filename, [block_id, [silent, [src]]])tEDAx IO
LoadTinycadFromLoads the specified tinycad .net file - the netlist must be tinycad netlist output.LoadTinycadFrom(filename)tinycad importer
LoadTtfGlyphsLoads glyphs from an outline ttf in the specified source range, optionally remapping them to dstchars range in the pcb-rnd fontLoadTtfGlyphs(filename, srcglyps, [dstchars])ttf importer
LoadVendorFromLoads the specified vendor lihata file.LoadVendorFrom(filename)vendor drill mapping
LogManages the central, in-memory log.Log(clear, [fromID, [toID])
Log(export, [filename, [text|lihata])
LogDialogOpen the log dialog.LogDialog()lib_hid_common plugin
mLoads a layout into the current buffer.m [name]shand_cmd plugin
ManagePluginsManage plugins dialog.ManagePlugins()dialogs plugin
MarkCrosshairSet/Reset the pcb_crosshair mark.MarkCrosshair()
MarkCrosshair(Center)
meshgenerate a mesh for simulationmesh()openems HID
MessageWrites a message to the log window.message([ERROR|WARNING|INFO|DEBUG,] message)
MessageBoxOpen 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, ...)
millCalculate toolpath for milling away coppermill([script])millpath plugin
MinClearGapEnsures that polygons are a minimum distance from objects.MinClearGap(delta)
MinClearGap(Selected, delta)
oldactions plugin
MinMaskGapoldactions plugin
ModeChange or use the tool mode.Tool(Arc|Arrow|Copy|InsertPoint|Line|Lock|Move|None|PasteBuffer)
Tool(Poly|Rectangle|Remove|Rotate|Text|Thermal|Via)
Tool(Press|Release|Cancel|Stroke)
Tool(Save|Restore)
MorphPolygonConverts dead polygon islands into separate polygons.pcb_poly_morph(Object|Selected)
MoveCursorToMove the cursor to absolute coords, pan the view as needed.MoveCursorTo(x,y)
MoveLayerMoves/Creates/Deletes Layers.MoveLayer(old,new)
MoveLayer(lid,group,gid)
MoveObjectMoves the object under the crosshair.pcb_move_obj(X,Y,[units])
MoveToCurrentLayerMoves objects to the current layer.MoveToCurrentLayer(Object|SelectedObjects)
netPerform various actions on netlists.Net(find|select|rats|norats||ripup|addrats|clear[,net[,pin]])
Net(freeze|thaw|forcethaw)
Net(swap)
Net(add,net,pin)Net([rename|merge],srcnet,dstnet)
NetLengthReport physical network lengthNetLength(clear)
NetLength(object)
report plugin
netlistPerform various actions on netlists.Net(find|select|rats|norats||ripup|addrats|clear[,net[,pin]])
Net(freeze|thaw|forcethaw)
Net(swap)
Net(add,net,pin)Net([rename|merge],srcnet,dstnet)
NetlistChangedTells the GUI that the netlist has changed.NetlistChanged()oldactions plugin
NetlistDialogOpen the netlist dialog or refresh network lengths in an already open dialog.NetlistDialog([RefreshNetLens])dialogs plugin
NewStarts a new layout.New([name])
NewGroupCreate a new layer group with a single, positive drawn layer in itNewGroup(type [,location [, purpose[, auto|sub [,name[,grp_attribs]]]])
NormalizeMove 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]])
OnelinerExecute a script one-liner using a specific languageOneliner(lang, script)script plugin
OpenemsExcitationSelect 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
OptAutoOnlyToggles the optimize-only-autorouted flag.OptAutoOnly()oldactions plugin
OrderPCBOrder the board from a faborderPCB([gui])order plugin
PadstackBreakupBreak up a padstack into one non-padstack object per layer type (the hole is ignored)PadstackBreakup(buffer|selected|objet)
PadstackConvertConvert selection or current buffer to padstackPadstackConvert(buffer|selected, [originx, originy])
PadstackEditinteractive pad stack editorPadstackEdit(object, [tab])dialogs plugin
PadstackPlacePlace a pad stack (either proto_id, or if not specified, the default for style)PadstackPlace([proto_id|default], [x, y])
PanStart or stop panning (Mode = 1 to start, 0 to stop)Pan(Mode)lib_hid_common plugin
paralDraw a line perpendicular to another lineperp()ddraft plugin
pasExecute a script one-liner using a specific languageOneliner(lang, script)script plugin
PasteBufferVarious operations on the paste buffer.PasteBuffer(AddSelected|MoveSelected|Clear|1..PCB_MAX_BUFFER)
PasteBuffer(Rotate, 1..3)
PasteBuffer(Convert|Restore|Mirror)
PasteBuffer(ToLayout, X, Y, units)
PasteBuffer(ToLayout, crosshair)
PasteBuffer(Save, Filename, [format], [force])
PasteBuffer(SaveAll, Filename, [format])
PasteBuffer(LoadAll, Filename)
PasteBuffer(Push)
PasteBuffer(Pop)
PasteBuffer(GetSource, [1..PCB_MAX_BUFFER])
PCBChangedTells the GUI that the whole PCB has changed. The optional "revert"parameter can be used as a hint to the GUI that the same design is beingreloaded, and that it might keep some viewport settingsPCBChanged([revert])oldactions plugin
PcbDeleteAlias to Delete()
pcbsplitSplit objects (idpath or idpath list) with cutting edges (idpath or idpath list), returning the idpath list of the newly created objectsPcbSplit(cutting_edges, objs)ddraft plugin
pcb_acosscript plugin
pcb_asinscript plugin
pcb_atan2script plugin
pcb_atanscript plugin
pcb_cosscript plugin
pcb_sinscript plugin
pcb_sqrtscript plugin
pcb_tanscript plugin
perpDraw a line perpendicular to another lineperp()ddraft plugin
PinoutPresent the subcircuit pinout boxPinout()dialogs plugin
PolyBoolPerform polygon boolean operation on the clipped polygons referred. A poly is either and idpath, selected, found or object (for the object under the cursor). When not specified, two object polygons are used.PstkProto([noundo,] unite|isect|sub, [poly1, poly2, [poly...]])act_draw
PolyCombinepolycombine plugin
PolygonSome polygon related stuff.Polygon(Close|CloseHole|PreviousPoint)
PolyHatchhatch the selected polygon(s) with lines of the current style; lines are drawn on the current layer; flags are h:horizontal, v:vertical, c:contour, p:polyPolyHatch([spacing], [hvcp])
PolyHatch(interactive)
lib_polyhelp
PolyNewCreate an empty polygon. For now data must be "pcb". Use PolyNewPoint to add points. Returns a polygon pointer valid until PolyNewEnd() is called.PolyNew([noundo,] data, layer, ptlist, clearance, flags)act_draw
PolyNewEndClose and place a polygon started by PolyNew. Returns the idpath of the new object or 0 on error.PolyNewEnd([noundo,] data, layer, poly)act_draw
PolyNewFromPointsCreate a polygon. For now data must be "pcb". ptlist is a comma separated list of coordinates (untiless coordinates are treated as mm). Returns the idpath of the new object or 0 on error.PolyNewFromRectangle([noundo,] data, layer, ptlist, clearance, flags)act_draw
PolyNewFromRectangleCreate a rectangular polygon. For now data must be "pcb". Returns the idpath of the new object or 0 on error.PolyNewFromRectangle([noundo,] data, layer, x1, y1, x2, y2, clearance, flags)act_draw
PolyNewPointsAdd a list of points to a polygon created by PolyNew. Returns 0 on success.PolyNewPoints([noundo,] poly, ptlist)act_draw
PolyOffsreplicate the outer contour of the selected polygon(s) with growing or shrinking them by offset; the new polygon is drawn on the current layerPolyOffs(offset)lib_polyhelp
PolyStitchpolystitch plugin
PopupBring up the popup menu specified by MenuName, optionally modified with the object type under the cursor.Popup(MenuName, [obj-type])lib_hid_pcbui/actions
PreferencesPresent the preferences dialog, optionally opening the tab requested.Preferences([tabname])dialogs plugin
PrintPresent the print export dialog for printing the layout from the GUI.Print()
PrintActionsPrint all actions available.PrintActions()
PrintCalibrateCalibrate the printer.PrintCalibrate()dialogs plugin
PrintCopyrightPrint copyright notice.PrintCopyright()
PrintFilesPrint files currently loaded.PrintFiles()
PrintGUIOpen the print dialog.PrintGUI()dialogs plugin
PrintPathsPrint full paths and search paths.PrintPaths()
PrintUsagePrint command line arguments of pcb-rnd or a plugin loaded.PrintUsage()
PrintUsage(plugin)
PrintVersionPrint version.PrintVersion()
PromptForPrompt for a string. Returns the string (or NULL on cancel)PromptFor([message[,default[,title]]])
propeditpropedit(object[:id]|layer[:id]|layergrp[:id]|pcb|subc|selection|selected)propedit
propgetReturn the named property of scope or all selected objects to/by value. Scope is documented at PropEdit().propget([scope], name, [stattype])propedit
propprintPrint a property map of objects matching the scope. Scope is documented at PropEdit().PropPrint([scope])propedit
propsetChange the named property of scope or all selected objects to/by value. Scope is documented at PropEdit().propset([scope], name, value)propedit
proptoggleToggle the named property of scope or all selected objects, assuming the property is boolean. Scope is documented at PropEdit(). If create is true, non-existing attributes are created as true.proptoggle([scope], name, [create])propedit
pscalibps HID
pstklibPresent the padstack library dialog on board padstacks or the padstacks of a subcircuitpstklib([board|subcid|object])dialogs plugin
PstkNewCreate a padstack. For now data must be "pcb". glob_clearance=0 turns off global clearance. Returns the idpath of the new object or 0 on error.PstkNew([noundo,] data, protoID, x, y, glob_clearance, flags)act_draw
PstkProtoEditEdit a padstack prototype specified by its pointer.PstkProto([noundo,] proto, remove, layer_type)
PstkProto([noundo,] proto, copy, dst_layer_type, src_layer_type)
PstkProto([noundo,] proto, hdia, dia)
PstkProto([noundo,] proto, shape:line, layer_type, x1, y1, x2, y2, th, [square])
act_draw
PstkProtoTmpAllocate, insert or free a temporary padstack prototypePstkProto([noundo,] new)
PstkProto([noundo,] dup, idpath)
PstkProto([noundo,] dup, data, src_proto_id)
PstkProto([noundo,] insert, idpath|data, proto)
PstkProto([noundo,] insert_dup, idpath|data, proto)
PstkProto([noundo,] free, proto)
act_draw
PullerPull an arc-line junction tight.pcb_act_Puller()puller plugin
q!Quits the application without confirming.q!shand_cmd plugin
qQuits the application after confirming.qshand_cmd plugin
queryPerform various queries on PCB data.query(dump, expr) - dry run: compile and dump an expression
query(eval|evalidp, expr) - compile and evaluate an expression and print a list of results on stdout
query(select|unselect|view, expr) - select or unselect or build a view of objects matching an expression
query(setflag:flag|unsetflag:flag, expr) - set or unset a named flag on objects matching an expression
query(append, idplist, expr) - compile and run expr and append the idpath of resulting objects on idplist
query plugin
QueryCalcNetLenCalculates the network length by netname; returns an error message string or a positive coord with the lengthQueryCalcNetLen(netname)query plugin
QueryCompileFieldWith "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
QueryObjReturn 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
QuitQuits the application after confirming.Quit()
ReadGroupLength 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
RedoRedo recent "undo" operations.redo()
RedrawRedraw the entire screenRedraw()
regpolyGenerate 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
ReloadScriptReload a fungw scriptReloadScript(id)script plugin
RemoveMenuRecursively removes a new menu, popup (only path specified) or submenu. RemoveMenu(path|cookie)
RemoveSelectedRemoves any selected objects.pcb_remove_selected()
RenumberRenumber all subcircuits. The changes will be recorded to filename
for use in backannotating these changes to the schematic.
Renumber()
Renumber(filename)
renumber plugin
RenumberBlockTODORenumberBlock(old_base,new_base)renumber plugin
RenumberBufferTODORenumberBlock(old_base,new_base)renumber plugin
ReplaceFootprintReplace the footprint of the selected components with the footprint specified.ReplaceFootprint([Selected|Object], [footprint], [dumb])
ReportProduce various report.Report([DrillReport|FoundPins|NetLengthTo])
Report(NetLength, [netname])
Report(Object|Subc, [log])
Report(AllNetLengths, [unit])
report plugin
ReportObjectReport on the object under the crosshairReportObject()report plugin
RipUpRipup auto-routed tracksRipUp(All|Selected|Element)
rnReads netlist.rn [name]shand_cmd plugin
Rotate90Rotates the object under the crosshair by 90 degree steps.pcb_move_obj(steps)
roundrectGenerate a rectangle with round cornersroundrect([where,] width[;height] [,rx[;ry] [,rotation [,cornstyle [,roundness]]]])shape plugin
RouteStyleCopies the indicated routing style into the current pen.RouteStyle(style_id|style_name)
RouteStylesChangedTells the GUI that the routing styles have changed.RouteStylesChanged()oldactions plugin
sSaves layout data.s [name]
w [name]
shand_cmd plugin
SaveSave 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
SaveFontToSave PCB font to a fileSaveFontTo([file, id])
SaveLibSaves all subcircuits to a library file or directory from a board or buffer.SaveLib(file|dir, board|buffer, [filename], [fmt])
SavePatchSave netlist patch for back annotation.SavePatch(filename)
SaveTedaxSaves 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
SaveToSaves data to a file.SaveTo(Layout|LayoutAs,filename,[fmt])
SaveTo(PasteBuffer,filename,[fmt])
ScaleBufferScales 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]]])
ScriptCookieReturn a cookie specific to the current script instance during script initializationScriptCookie()script plugin
ScriptPersistencyRead or remove script persistency data savd on preunloadScriptPersistency(read|remove)script plugin
ScrollScroll the viewport.Scroll(up|down|left|right, [pixels])lib_hid_common plugin
SearchDialogOpen the log dialog.SearchDialog()query plugin
SelectToggles or sets the selection.Select(Object, [idpath])
Select(ToggleObject)
Select(All|Block|Connection|Invert)
Select(Convert)
SelectLayerSelect which layer is the current layer.SelectLayer(1..MAXLAYER|Silk|Rats)
SetFlagSets flags on objects.SetFlag(Object|Selected|SelectedObjects, flag)
SetFlag(SelectedLines|SelectedPins|SelectedVias, flag)
SetFlag(SelectedPads|SelectedTexts|SelectedNames, flag)
SetFlag(SelectedElements, flag)
flag = thermal | join
SetGridChange various board-wide values and sizes.SetGrid(delta|*mult|/div, [unit])
SetOctagonoldactions plugin
SetSameSets current layer and sizes to match indicated item.SetSame()
SetSquareoldactions plugin
SetThermalSet the thermal (on the current layer) of padstacks to the given style.
Style = 0 means no thermal.
Style = 1 has diagonal fingers with sharp edges.
Style = 2 has horizontal and vertical fingers with sharp edges.
Style = 3 is a solid connection to the plane.
Style = 4 has diagonal fingers with rounded edges.
Style = 5 has horizontal and vertical fingers with rounded edges.
SetThermal(Object|SelectedPins|SelectedVias|Selected, Style)
SetUnitsSet the default measurement units.SetUnits(mm|mil)
SetValueChange various board-wide values and sizes.SetValue(Grid|Line|LineSize|Text|TextScale, delta)
shapeInteractive shape generator.shape()shape plugin
smartdisperseDisperse subcircuits into clusters, by netlist connectionsSmartDisperse([All|Selected])smartdisperse plugin
splitUse one or more objects as cutting edge and trim or split other objects. First argument is the cutting edgetrim([selected|found|object], [selected|found|object])
split([selected|found|object], [selected|found|object])
ddraft plugin
StatusSetTextReplace status printout with text temporarily; turn status printout back on if text is not provided.StatusSetText([text])lib_hid_pcbui/status
strokeVarious gesture recognition related functionsstroke(gesture, seq)stroke plugin
subcVarious operations on subcsubc(hash, [board|selected])
subc(loose, on|off|toggle|check)
SwapSidesSwaps the side of the board you're looking at.SwapSides(|v|h|r, [S])lib_hid_pcbui/actions
SystemRun shell commandSystem(shell_cmd)
tangDraw a line to be tangential to a circletang()ddraft plugin
Teardropsteardrops plugin
TedaxTestParseReturns 1 if the file looks like tEDAx (0 if not)TedaxTestParse(filename|FILE*)tEDAx IO
TextNewCreate a pcb text on a layer. For now data must be "pcb". Font id 0 is the default font. Thickness 0 means default, calculated thickness. Scale=100 is the original font size. Returns the idpath of the new object or 0 on error.TextNew([noundo,] data, layer, fontID, x, y, rot, scale, thickness, text_string, flags)act_draw
ToggleHideNameoldactions plugin
ToggleVendorToggles the state of automatic drill size mapping.ToggleVendor()oldactions plugin
ToggleViewToggle the visibility of the specified layer or layer group.ToggleView(1..MAXLAYER)
ToggleView(layername)
ToggleView(Silk|Rats|Pins|Vias|BackSide)
ToggleView(All, Open|Vis, Set|Clear|Toggle)
ToolChange or use the tool mode.Tool(Arc|Arrow|Copy|InsertPoint|Line|Lock|Move|None|PasteBuffer)
Tool(Poly|Rectangle|Remove|Rotate|Text|Thermal|Via)
Tool(Press|Release|Cancel|Stroke)
Tool(Save|Restore)
ToPolyconvert a closed loop of lines and arcs into a polygonToPoly()
ToPoly(outline)
lib_polyhelp
trimUse one or more objects as cutting edge and trim or split other objects. First argument is the cutting edgetrim([selected|found|object], [selected|found|object])
split([selected|found|object], [selected|found|object])
ddraft plugin
UndoUndo recent changes.undo()
undo(ClearList|FreezeSerial|UnfreezeSerial|IncSerial)
UndoDialogOpen the undo dialog.UndoDialog()dialogs plugin
UnloadScriptUnload a fungw scriptUnloadScript(id)script plugin
UnloadVendorUnloads the current vendor drill mapping table.UnloadVendor()vendor drill mapping
UnselectUnselects the object at the pointer location or the specified objects.Unselect(All|Block|Connection)
ViewListPresent a new empty view listviewlist([name, [winid, [listptr]]])dialogs plugin
wSaves layout data.s [name]
w [name]
shand_cmd plugin
wqSaves the layout data and quits.wqshand_cmd plugin
ZoomGUI zoomZoom()
Zoom([+|-|=]factor)
Zoom(x1, y1, x2, y2)
Zoom(?)
Zoom(get)
Zoom(found|selected)
lib_hid_pcbui/actions
ZoomToGUI zoomZoom()
Zoom([+|-|=]factor)
Zoom(x1, y1, x2, y2)
Zoom(?)
Zoom(get)
Zoom(found|selected)
lib_hid_pcbui/actions