package kiapi.board.commands

Get desktop application:
View/edit binary Protocol Buffers messages

Used in: SetBoardEditorAppearanceSettings

• InactiveLayerDisplayMode inactive_layer_display = 1

• NetColorDisplayMode net_color_display = 2

• BoardFlipMode board_flip = 3

• RatsnestDisplayMode ratsnest_display = 4

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

• types.BoardLayer layer = 1

• repeated types.BoardLayer layers = 1

Used in: GetBoardOrigin, SetBoardOrigin

• BOT_UNKNOWN = 0

• BOT_GRID = 1

• BOT_DRILL = 2

• optional BoardStackup stackup = 1

returns BoardLayerResponse

• optional common.types.DocumentSpecifier board = 1

Returns BoardEditorAppearanceSettings

(message has no fields)

Returns a Vector2 with the specified origin point

• optional common.types.DocumentSpecifier board = 1

• BoardOriginType type = 2

• 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

  List of one or more types of items to retreive

• repeated types.NetCode net_codes = 3

  A list of net codes 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

  List of one or more types of items to retreive

• 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

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

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

• 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

• 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: 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. This is a blocking operation; it will return Empty immediately, but KiCad will return ApiStatusCode.AS_BUSY to all future API requests until the zone fill 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 BoardEditorAppearanceSettings settings = 1

• optional common.types.DocumentSpecifier board = 1

• BoardOriginType type = 2

• optional common.types.Vector2 origin = 3

• optional common.types.DocumentSpecifier board = 1

• repeated types.BoardLayer layers = 2

• optional common.types.DocumentSpecifier board = 1

• optional BoardStackup stackup = 2