<-- back to the index of Rosetta examples

drill list exporter

Create a new exporter that prints a list of drills in x,y,dia table in CSV, TSV or text format

Example implementations

Explanation, step by step

An exporter is a hid registered. During the export process, pcb-rnd calls the exporter to draw objects on layers. The GPMI layer converts these calls to bindable events. An exporter script catches the drawing events relevant to the output format and draws everything from event handlers.

An exporter is sort of a drawing backend: pcb-rnd sets up graphic contexts (gc for short) and draws on them. The first gc set up should open the output file, the last gc closed should flush/close the file.

Theory of operation

Assume only filled circles on the top assembly layer are holes. Emit a line for each of these and ignore everything else.

Implementation

Load packages the script depends on:

hid for registering the new exporter;
layout for unit conversion;
dialogs for error reporting.

Set up an exporter hid, storing the handle of each object created in a global variable:

create a hid using hid_create
add two attributes (fields) to the dialog using hid_add_attribute
register the new hid using hid_register - this makes it an exporter

Set up global state variables:

fmt will be a cache for the format selected by the user
conv is the conversion scale between mm and PCB internal coordinate unit
channel specifies a file handle or indicates that the output file is open
green_light indicates that the exporter is drawing the relevant layer

Define a make_gc callback. It is called when a new graphic context is created (e.g. for layers). An exporter is sort of a drawing backend: pcb-rnd sets up gc's and draws on them. The first gc set up should open the output file, the last gc closed should flush/close the file. Define a destroy_gc callback for the latter. GCs are destroyed at the end of the export process. Use global variable channel to make sure the file is open/close only once (see TODO script context ).

Define a set_layer callback that sets green_light to true if layer name is "topasssembly", false otherwise.

Callback fill_circle is the workhorse: check if we have the green light to emit lines, then convert coordinates and diameter to mm and decide what format to use for printing a line for each filled circle.

Finally, bind all four callbacks to exporter events.