package kiapi.schematic.jobs

Get desktop application:
View/edit binary Protocol Buffers messages

Used in: BOMFieldSettings

• string name = 1

  The name of the field in KiCad to export

• string label = 2

  The name to give the field in the exported BOM (i.e. the column header name)

• bool group_by = 3

  Whether or not to group exported components by this field

Used in: RunSchematicJobExportBOM

• string preset_name = 1

  If supplied, will apply a default or user-stored preset to the other field settings. Default values available include 'Default Editing', 'Grouped By Value', 'Grouped By Value and Footprint', and 'Attributes'.

• repeated BOMField fields = 2

  An ordered list of fields to export

• string sort_field = 3

• BOMSortDirection sort_direction = 4

  Sort direction; defaults to ascending if unspecified

• string filter = 5

Used in: RunSchematicJobExportBOM

• string preset_name = 1

  If supplied, will apply a preset to the other format settings. Built-in values 'CSV', 'TSV', and 'Semicolons' are always available, as well as any user-saved presets.

• string field_delimiter = 2

  Delimiter between fields (columns) in a data row

• string string_delimiter = 3

  Character to use for quoting strings

• string ref_delimiter = 4

  Delimiter between reference designators when exporting a list (e.g. "R1,R3,R5")

• string ref_range_delimiter = 5

  Delimiter between reference designators when exporting a range (e.g. "R1-R10")

• bool keep_tabs = 6

  Whether tab characters in field values will be preserved when exporting or stripped (default)

• bool keep_line_breaks = 7

  Whether line breaks in field values will be preserved when exporting or stripped (default)

Used in: BOMFieldSettings

• BSD_UNKNOWN = 0

• BSD_ASCENDING = 1

• BSD_DESCENDING = 2

Exports a schematic bill of materials. Returns RunJobResponse.

• optional common.types.RunJobSettings job_settings = 1

• optional BOMFormatSettings format = 2

• optional BOMFieldSettings fields = 3

• bool exclude_dnp = 4

  If true, "do not populate" components will be omitted from the exported BOM

• bool group_symbols = 5

  If true, will group symbols into a single BOM row when they have matching values for any fields where group_by is true

• string variant_name = 6

  If the design contains variants, this field can be set to the name of a variant to use for the BOM export

Plots a schematic to DXF. Returns RunJobResponse.

• optional common.types.RunJobSettings job_settings = 1

• optional SchematicPlotSettings plot_settings = 2

Exports a schematic netlist. Returns RunJobResponse.

• optional common.types.RunJobSettings job_settings = 1

• SchematicNetlistFormat format = 2

• string variant_name = 3

  If the design contains variants, this field can be set to the name of a variant to use for the BOM export

Plots a schematic to PDF. Returns RunJobResponse.

• optional common.types.RunJobSettings job_settings = 1

• optional SchematicPlotSettings plot_settings = 2

• bool property_popups = 3

• bool hierarchical_links = 4

• bool include_metadata = 5

Plots a schematic to PostScript. Returns RunJobResponse.

• optional common.types.RunJobSettings job_settings = 1

• optional SchematicPlotSettings plot_settings = 2

Plots a schematic to SVG. Returns RunJobResponse.

• optional common.types.RunJobSettings job_settings = 1

• optional SchematicPlotSettings plot_settings = 2

Page size override used for schematic plotting jobs

Used in: SchematicPlotSettings

• SJPS_UNKNOWN = 0

• SJPS_AUTO = 1

  Auto-select page size from sheet settings

• SJPS_A4 = 2

  Force A4 page size

• SJPS_A = 3

  Force ANSI A page size

Netlist format for schematic netlist export.

Used in: RunSchematicJobExportNetlist

• SNF_UNKNOWN = 0

• SNF_KICAD_XML = 1

• SNF_KICAD_SEXPR = 2

• SNF_ORCAD_PCB2 = 3

• SNF_CADSTAR = 4

• SNF_SPICE = 5

• SNF_SPICE_MODEL = 6

• SNF_PADS = 7

• SNF_ALLEGRO = 8

Shared plot options for schematic plot exports

Used in: RunSchematicJobExportDxf, RunSchematicJobExportPdf, RunSchematicJobExportPs, RunSchematicJobExportSvg

• string drawing_sheet = 1

• string default_font = 2

• string variant = 3

• bool plot_all = 4

• bool plot_drawing_sheet = 5

• repeated string plot_pages = 6

• bool show_hop_over = 7

• bool black_and_white = 8

• SchematicJobPageSize page_size = 9

• bool use_background_color = 10

• int32 min_pen_width = 11

• string theme = 12