package kiapi.board.commands

Get desktop application:
View/edit binary Protocol Buffers messages

Appends embedded files to the board. Returns Empty.

• optional common.types.DocumentSpecifier board = 1

• optional common.types.EmbeddedFiles files = 2

What items to use to calculate the board bounding box Since: 11.0

Used in: GetBoardBoundingBox

• BBBM_UNKNOWN = 0

• BBBM_ALL_ITEMS = 1

  All board items on visible layers

• BBBM_PHYSICAL_LAYERS_ONLY = 2

  Items on visible physical (copper/technical) layers only

• BBBM_BOARD_EDGES_ONLY = 3

  Graphics on Edge.Cuts only

Since: 11.0

• optional common.types.Box2 box = 1

  zero-size box for an empty board

• optional BoardDesignRules rules = 1

• CustomRulesStatus custom_rules_status = 2

Used in: SetBoardEditorAppearanceSettings

• InactiveLayerDisplayMode inactive_layer_display = 1

• NetColorDisplayMode net_color_display = 2

• BoardFlipMode board_flip = 3

• RatsnestDisplayMode ratsnest_display = 4

• uint32 copper_layer_count = 1

  The number of copper layers enabled in this board.

• repeated types.BoardLayer layers = 2

  A list of all layers enabled in this board, including copper layers and ones which cannot be disabled.

Used in: FlipItems

• BFD_UNKNOWN = 0

• BFD_LEFT_RIGHT = 1

  Flip left to right (around the Y axis)

• BFD_TOP_BOTTOM = 2

  Flip top to bottom (around the X axis)

Used in: BoardEditorAppearanceSettings

• BFM_UNKNOWN = 0

• BFM_NORMAL = 1

  Normal ("non-flipped") mode

• BFM_FLIPPED_X = 2

  "Flipped" mode, viewed from the back and mirrored around the X axis

• string name = 1

  The name of the layer shown in the KiCad GUI, which may be a default value like "F.Cu" or may have been customized by the user.

• types.BoardLayer layer = 1

• repeated types.BoardLayer layers = 1

Used in: GetBoardOrigin, SetBoardOrigin

• BOT_UNKNOWN = 0

• BOT_GRID = 1

• BOT_DRILL = 2

• optional jobs.BoardPlotSettings plot_settings = 1

• optional BoardStackup stackup = 1

Tests if the given set of items with padstacks (pads or vias) has content on the given set of layers. This is a dynamic call rather than a property of the padstack because pads and vias can be set to only include shapes on connected copper layers, and whether or not the pad is connected can't be determined in isolation. To optimize API call performance, multiple items and multiple layers to test may be passed in with this command message. The return will include the results for each valid item on each valid layer. Note that not all layers make sense for a given item (for example, testing against BL_UNDEFINED never makes sense). In general, the internal KiCad APIs will not return an error when testing non-sensical layers for a given item, and instead will return a default of "true" for any such layers.

• optional common.types.DocumentSpecifier board = 1

• repeated common.types.KIID items = 2

• repeated types.BoardLayer layers = 3

• CustomRulesStatus status = 1

• repeated CustomRule rules = 2

• string error_text = 3

Used in: BoardDesignRulesResponse, CustomRulesResponse

• CRS_UNKNOWN = 0

• CRS_NONE = 1

• CRS_VALID = 2

• CRS_INVALID = 3

Deprecated - use common.types.RuleSeverity

Used in: InjectDrcError

• DRS_UNKNOWN = 0

• DRS_WARNING = 1

• DRS_ERROR = 2

• DRS_EXCLUSION = 3

• DRS_IGNORE = 4

• DRS_INFO = 5

• DRS_ACTION = 6

• DRS_DEBUG = 7

• DRS_UNDEFINED = 8

Flips one or more board items to the opposite side of the board. Returns FlipItemsResponse.

• optional common.types.ItemHeader header = 1

• repeated common.types.KIID items = 2

• BoardFlipDirection direction = 3

  Direction to flip the items; BFD_TOP_BOTTOM if unspecified.

• optional common.types.ItemHeader header = 1

• common.types.ItemRequestStatus status = 2

  Status of the overall request; may return IRS_OK even if no items were flipped

• repeated ItemFlipResult flipped_items = 3

returns BoardLayerResponse

• optional common.types.DocumentSpecifier board = 1

Returns BoardBoundingBoxResponse Since: 11.0

• optional common.types.DocumentSpecifier board = 1

• BoardBoundingBoxMode mode = 2

• optional common.types.DocumentSpecifier board = 1

Returns BoardEditorAppearanceSettings

(message has no fields)

• optional common.types.DocumentSpecifier board = 1

Since: 10.0.6 Returns BoardLayerResponse

• optional common.types.DocumentSpecifier board = 1

• string name = 2

  A name to retrieve the layer ID for, which may be a user-customized or a KiCad standard one.

• optional common.types.DocumentSpecifier board = 1

• types.BoardLayer layer = 2

Returns a Vector2 with the specified origin point

• optional common.types.DocumentSpecifier board = 1

• BoardOriginType type = 2

Returns BoardPlotSettingsResponse

• optional common.types.DocumentSpecifier board = 1

• optional common.types.DocumentSpecifier board = 1

Retrieve all copper-connected items connected to one or more source items returns kiapi.common.commands.GetItemsResponse

• optional common.types.ItemHeader header = 1

  Specifies which document to query, which fields to return, etc.

• repeated common.types.KIID items = 2

  One or more item IDs used as the source set for connectivity queries

• repeated common.types.KiCadObjectType types = 3

  Optional list of item types to return. If empty, all connected item types are returned.

• optional common.types.DocumentSpecifier board = 1

Returns kiapi.common.types.EmbeddedFiles

• optional common.types.DocumentSpecifier board = 1

• optional common.types.DocumentSpecifier board = 1

Retrieve all the copper items belonging to a certain net or set of nets returns kiapi.common.commands.GetItemsResponse

• optional common.types.ItemHeader header = 1

  Specifies which document to query, which fields to return, etc.

• repeated common.types.KiCadObjectType types = 2

  Optional list of item types to filter by. If not provided, will return pads, vias, tracks, and zones.

• repeated types.Net nets = 4

  A list of nets to filter items by

Retrieve all the copper items belonging to a certain net class or set of net classes returns kiapi.common.commands.GetItemsResponse

• optional common.types.ItemHeader header = 1

  Specifies which document to query, which fields to return, etc.

• repeated common.types.KiCadObjectType types = 2

  Optional list of item types to filter by. If not provided, will return pads, vias, tracks, and zones.

• repeated string net_classes = 3

  A list of net class names to filter items by

A net may be part of multiple classes that have a priority ordering, which will result in a composite "effective" netclass containing the merged/overridden properties of all the constituent netclasses it contains. This message retrieves this effective netclass for a net or list of nets. Returns NetClassForNetsResponse

• repeated types.Net net = 1

• optional common.types.DocumentSpecifier board = 1

• repeated string netclass_filter = 2

  If provided, will only return nets that belong to the given netclass. If more than one netclass_filter is given, nets belonging to any of the given classes will be returned.

Computes the polygon representation of a pad, merging any custom shapes together. This representation will approximate curves as a series of segments.

• optional common.types.DocumentSpecifier board = 1

  The board to process

• repeated common.types.KIID pads = 2

  A list of one or more pads to process

• types.BoardLayer layer = 3

  The layer to process

returns BoardLayers

• optional common.types.DocumentSpecifier board = 1

• optional GraphicsDefaults defaults = 1

Imports a netlist file exported from the schematic and updates the board. Returns ImportNetlistResponse.

• optional common.types.DocumentSpecifier board = 1

• string netlist_path = 2

  Path to the netlist file.

• bool dry_run = 3

  If true, report planned changes without modifying the board.

• NetlistMatchMode match_mode = 4

• bool delete_extra_footprints = 5

• bool update_footprints = 6

• bool transfer_groups = 7

• bool override_locks = 8

• uint32 error_count = 1

• uint32 warning_count = 2

• uint32 new_footprint_count = 3

• string report = 4

  Human-readable report of changes and any warnings or errors.

Used in: BoardEditorAppearanceSettings

• ILDM_UNKNOWN = 0

• ILDM_NORMAL = 1

  Inactive layers are shown

• ILDM_DIMMED = 2

  Inactive layers are shown with dimmed colors

• ILDM_HIDDEN = 3

  Inactive layers are hidden

Returns InjectDrcErrorResponse

• optional common.types.DocumentSpecifier board = 1

• DrcSeverity severity = 2

• string message = 3

• optional common.types.Vector2 position = 4

• repeated common.types.KIID items = 5

• optional common.types.KIID marker = 1

Selects and begins an interactive move of the given item(s). NOTE: Takes ownership of the active commit, if one exists: the move tool will push the commit when the user confirms the move, or roll back the commit if the user cancels the move. Keep this in mind if using this command in combination with commands that create or modify items using an explicit commit.

• optional common.types.DocumentSpecifier board = 1

• repeated common.types.KIID items = 2

Used in: FlipItemsResponse

• optional common.commands.ItemStatus status = 1

• optional google.protobuf.Any item = 2

  Updated version of the item after the flip (only populated when status.status is ISC_OK)

• map<string, common.project.NetClass> classes = 1

  Map of net name to netclass info

Used in: BoardEditorAppearanceSettings

• NCDM_UNKNOWN = 0

• NCDM_ALL = 1

  Net and netclass colors are shown in the ratsnest and on all copper items

• NCDM_RATSNEST = 2

  Net and netclass colors are shown in the ratsnest only

• NCDM_OFF = 3

  Net and netclass colors are not shown

How schematic components are matched to board footprints during netlist import.

Used in: ImportNetlist

• NMM_UNKNOWN = 0

• NMM_UUID = 1

  Match by unique ID.

• NMM_REFERENCE = 2

  Match by reference designator.

• repeated types.Net nets = 1

Returned from GetPadShapeAsPolygon. The pads and polygons repeated fields will have the same length and can be treated as a list of tuples.

• repeated common.types.KIID pads = 1

  The pads that were processed

• repeated common.types.PolygonWithHoles polygons = 2

  The polygon representation of each pad

Used in: PadstackPresenceEntry

• PSP_UNKNOWN = 0

• PSP_PRESENT = 1

  The padstack has a shape on a given layer (is flashed)

• PSP_NOT_PRESENT = 2

  The padstack has no shape on a given layer (is not flashed)

Used in: PadstackPresenceResponse

• optional common.types.KIID item = 1

• types.BoardLayer layer = 2

• PadstackPresence presence = 3

• repeated PadstackPresenceEntry entries = 1

Requests placement of a footprint on a board Returns PlaceFromLibraryResponse Since: 11.0

• optional common.types.ItemHeader header = 1

• optional common.types.LibraryIdentifier lib_id = 2

• optional common.types.Vector2 position = 3

• optional common.types.Angle orientation = 4

  If unspecified, will use default orientation

• optional types.BoardLayer layer = 5

  If unspecified, will place on F_Cu. Footprint will be flipped if placed on B_Cu.

Used in: BoardEditorAppearanceSettings

• RDM_UNKNOWN = 0

• RDM_ALL_LAYERS = 1

  Ratsnest lines are drawn to objects even if they are on hidden layers

• RDM_VISIBLE_LAYERS = 2

  Ratsnest lines are hidden when at least one endpoint is an item on a hidden layer

Refills some or all zones on the board. When zones is empty and a board editor is running, all zones are refilled in the background: Empty is returned immediately and KiCad returns ApiStatusCode.AS_BUSY to all future API requests until the fill completes. When specific zones are given, or in headless sessions, the fill runs synchronously and the response is not sent until it has completed.

• optional common.types.DocumentSpecifier board = 1

• repeated common.types.KIID zones = 2

  A list of zones to refill. If empty, all zones are refilled.

• optional common.types.DocumentSpecifier board = 1

• types.BoardLayer layer = 2

• optional common.types.DocumentSpecifier board = 1

• optional BoardDesignRules rules = 2

• optional BoardEditorAppearanceSettings settings = 1

Changes which layers are enabled in the board stackup WARNING: any existing content on layers that are removed by this call is deleted. This operation cannot be undone. Returns BoardEnabledLayersResponse with the updated layer set.

• optional common.types.DocumentSpecifier board = 1

• uint32 copper_layer_count = 2

  The number of copper layers to enable in the board. Currently, this must be an even number >= 2.

• repeated types.BoardLayer layers = 3

  The non-copper layers to enable. Note that any copper layers in this list are ignored; copper layers are enabled by setting copper_layer_count. Note that the F/B.Courtyard, Edge.Cuts, and Margin layers cannot be disabled and will be present in the board even if they are omitted from this list.

• optional common.types.DocumentSpecifier board = 1

• BoardOriginType type = 2

• optional common.types.Vector2 origin = 3

• optional common.types.DocumentSpecifier board = 1

• optional jobs.BoardPlotSettings plot_settings = 2

Returns CustomRulesResponse

• optional common.types.DocumentSpecifier board = 1

• repeated CustomRule rules = 2

Replaces all embedded files in the board. Returns Empty.

• optional common.types.DocumentSpecifier board = 1

• optional common.types.EmbeddedFiles files = 2

• optional common.types.DocumentSpecifier board = 1

• repeated types.BoardLayer layers = 2

Changes the stackup for the given board according to the contents of the message (**not yet implemented**) WARNING: any existing content on layers that are removed by this call is deleted. This operation cannot be undone. Returns BoardStackupResponse with the updated stackup, in normalized form

• optional common.types.DocumentSpecifier board = 1

• optional BoardStackup stackup = 2