Prompts the user for a coordinate, if one is not already selected. +
+Imports subcircuits and netlist data from the schematics (or some other source). The first parameter, which is optional, is the mode. If not specified, the + +import::mode + + attribute in the board is used. Possible values: + +gnetlist + + means gnetlist is used to obtain the information from the schematics; + +make + + invokes make, assuming the user has a Makefile in the current directory. The Makefile will be invoked with the following variables set: +
+ +
| +PCB + | + The name of the .pcb file + |
|---|---|
| + SRCLIST + | + A space-separated list of source files + |
| + OUT + | + The name of the file in which to put the command script, which may contain any @pcb{} actions. By default, this is a temporary file selected by @pcb{}, but if you specify an + +import::outfile + + attribute, that file name is used instead (and not automatically deleted afterwards). + |
+ The target specified to be built is the first of these that apply: +
+ If you specify an + +import::makefile + + attribute, then "-f + +that file + +" will be added to the command line. +
+ If you specify the mode, you may also specify the source files (schematics). If you do not specify any, the list of schematics is obtained by reading the + +import::srcN + + attributes (like + +import::src0 + +, + +import::src1 + +, etc). +
+ For compatibility with future extensions to the import file format, the generated file + +must not + + start with the two characters #%. +
+ If a temporary file is needed the + +TMPDIR + + environment variable is used to select its location. +
+ Note that the programs + +gnetlist + + and + +make + + must be configured. +
+ If pcb-rnd cannot determine which schematic(s) to import from, the GUI is called to let user choose (see +importgui() +). +
+ Note that +import() + doesn't delete anything - after an Import, subcircuits which shouldn't be on the board are selected and may be removed once it's determined that the deletion is appropriate. TODO: is this still true? +
+ If +import() + is called with +setnewpoint +, then the location of new components can be specified. This is where parts show up when they're added to the board. The default is the center of the board. Argument combinations: +
+ +
| + Import(setnewpoint) + | + Prompts the user to click on the board somewhere, uses that point. If called by a hotkey, uses the current location of the crosshair. + |
|---|---|
| + Import(setnewpoint,mark) + | + Uses the location of the mark. If no mark is present, the point is not changed. + |
| + Import(setnewpoint,center) + | + Resets the point to the center of the board. + |
| + Import(setnewpoint,X,Y,units) + |
+ Sets the point to the specific coordinates given.
+ + + |
+ Note that the +X + and +Y + locations are stored in attributes named + +import::newX + + and + +import::newY} + + so you could change them manually if you wished. +
+ Calling
+
+Import(setdisperse,D,units)
+
+ sets how much the newly placed subcircuits are dispersed relative to the set point. For example,
+
+Import(setdisperse,10,mm)
+
+ will offset each part randomly up to 10mm away from the point. The default dispersion is 1/10th of the smallest board dimension. Dispersion is saved in the
+
+import::disperse
+
+ attribute.
+
l
Loads a new datafile (layout) and, if confirmed, overwrites any existing unsaved data. If no filename is specified a file select box will popup. Index: trunk/doc/user/09_appendix/action_reference.html =================================================================== --- trunk/doc/user/09_appendix/action_reference.html (revision 20642) +++ trunk/doc/user/09_appendix/action_reference.html (revision 20643) @@ -12,7 +12,7 @@
| Action | Description | Syntax | Plugin |
|---|---|---|---|
| About | Present the about box | About() | dialogs plugin | @@ -99,7 +99,7 @@
| GlobalPuller | Pull all traces tight. | pcb_act_GlobalPuller([Found|Selected]) | puller plugin |
| Grid | Set the grid. | grid(set, [name:]size[@offs][!unit]) grid(+|up) grid(-|down) grid(#N) grid(idx, N) | |
| GroupPropGui | Change group flags and properties | GroupPropGui(groupid) | dialogs plugin | -
| Import | Import schematics. | Import() Import([gnetlist|make[,source,source,...]]) Import(setnewpoint[,(mark|center|X,Y)]) Import(setdisperse,D,units) | import_sch plugin | +
| Import | Import schematics. | Import() Import([gnetlist|make[,source,source,...]]) Import(setnewpoint[,(mark|center|X,Y)]) Import(setdisperse,D,units) | import_sch plugin |
| ImportcpcbFrom | Loads the auto-routed tracks from the specified c-pcb output. | ImportcpcbFrom(filename) | cpcb plugin |
| LayerBinding | Change the layer binding. | LayerBinding(object) LayerBinding(selected) LayerBinding(buffer) | dialogs plugin |
| LayerPropGui | Change layer flags and properties | LayerPropGui(layerid) | dialogs plugin | @@ -244,10 +244,10 @@
| javascript | Execute a script one-liner using a specific language | Oneliner(lang, script) | script plugin |
| jostle | Make room by moving wires away. | Jostle(diameter) | jostle plugin |
| js | Execute a script one-liner using a specific language | Oneliner(lang, script) | script plugin | -
| l | Loads layout data. | l [name] [format] | shand_cmd plugin | -
| le | Loads an element (subcircuit, footprint) into the current buffer. | le [name] | shand_cmd plugin | +
| l | Loads layout data. | l [name] [format] | shand_cmd plugin | +
| le | Loads an element (subcircuit, footprint) into the current buffer. | le [name] | shand_cmd plugin |
| lua | Execute a script one-liner using a specific language | Oneliner(lang, script) | script plugin | -
| m | Loads a layout into the current buffer. | m [name] | shand_cmd plugin | +
| m | Loads a layout into the current buffer. | m [name] | shand_cmd plugin |
| mawk | Execute a script one-liner using a specific language | Oneliner(lang, script) | script plugin |
| mesh | generate a mesh for simulation | mesh() | openems HID |
| mill | Calculate toolpath for milling away copper | mill() | millpath plugin | @@ -264,14 +264,14 @@
| py | Execute a script one-liner using a specific language | Oneliner(lang, script) | script plugin |
| python | Execute a script one-liner using a specific language | Oneliner(lang, script) | script plugin |
| q! | Quits the application without confirming. | q! | shand_cmd plugin | -
| q | Quits the application after confirming. | q | shand_cmd plugin | +
| q | Quits the application after confirming. | q | shand_cmd plugin |
| query | Perform various queries on PCB data. | query(dump, expr) - dry run: compile and dump an expression | |
| 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 |
| rehash | Reload all gpmi scripts | TODO | GPMI plugin cookie | -
| rn | Reads netlist. | rn [name] | shand_cmd plugin | +
| rn | Reads netlist. | rn [name] | shand_cmd plugin |
| roundrect | Generate a rectangle with round corners | roundrect([where,] width[;height] [,rx[;ry] [,rotation]]) | shape plugin |
| ruby | Execute a script one-liner using a specific language | Oneliner(lang, script) | script plugin | -
| s | Saves layout data. | s [name] w [name] | shand_cmd plugin | +
| s | Saves layout data. | s [name] w [name] | shand_cmd plugin |
| shape | Interactive shape generator. | shape() | shape plugin |
| skline | Tool for drawing sketch lines | skline() | sketch_route plugin |
| skretriangulate | Reconstruct CDT on all layer groups | skretriangulate() | sketch_route plugin | @@ -284,8 +284,8 @@
| tang | Draw a line to be tangential to a circle | tang() | ddraft plugin |
| tcl | Execute a script one-liner using a specific language | Oneliner(lang, script) | script plugin |
| trim | Use one or more objects as cutting edge and trim or split other objects. First argument is the cutting edge | trim([selected|found|object], [selected|found|object]) split([selected|found|object], [selected|found|object]) | ddraft plugin | -
| w | Saves layout data. | s [name] w [name] | shand_cmd plugin | -
| wq | Saves the layout data and quits. | wq | shand_cmd plugin | +
| w | Saves layout data. | s [name] w [name] | shand_cmd plugin | +
| wq | Saves the layout data and quits. | wq | shand_cmd plugin |