package kiapi.common.commands

Get desktop application:
View/edit binary Protocol Buffers messages

Adds the given items to the selection. Returns SelectionResponse

• optional types.ItemHeader header = 1

• repeated types.KIID items = 2

  The items to select

Begins a staged set of changes. Any modifications made to a document through the API after this call will be saved to a pending commit, and will not appear in KiCad until a matching call to END_COMMIT.

• optional types.ItemHeader header = 1

  Specifies which document to associate the commit with

• optional types.KIID id = 1

  Opaque identifier tracking a commit

Used in: GetBoundingBox

• BBM_UNKNOWN = 0

• BBM_ITEM_ONLY = 1

• BBM_ITEM_AND_CHILD_TEXT = 2

Removes all items from selection

• optional types.ItemHeader header = 1

• optional types.DocumentSpecifier document = 1

Used in: EndCommit

• CMA_UNKNOWN = 0

• CMA_COMMIT = 1

  Commit the changes to the design

• CMA_DROP = 2

  Cancel this commit

Creates new items on a given document

• optional types.ItemHeader header = 1

  Specifies which document to create on, which fields are included, etc.

• repeated google.protobuf.Any items = 2

  List of items to create

• optional types.KIID container = 3

  Items may be created on a top-level document (sheet, board, etc) or inside a container (symbol, footprint). If this field is not empty, it holds the ID of a symbol or footprint that the items should be added to. This ID must be an existing symbol (for schematic documents) or footprint (for board documents). If the given container does not exist or is not the correct item type, the CreateItems call will fail.

• optional types.ItemHeader header = 1

  Specifies which document was modified, which fields are included in created_items, etc.

• types.ItemRequestStatus status = 2

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

• repeated ItemCreationResult created_items = 3

  Status of each item to be created

Deletes items in a given document

• optional types.ItemHeader header = 1

  Specifies which document to modify

• repeated types.KIID item_ids = 2

  List of item KIIDs to delete

• optional types.ItemHeader header = 1

  Specifies which document was modified, etc.

• types.ItemRequestStatus status = 2

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

• repeated ItemDeletionResult deleted_items = 3

  Status of each item requested to be deleted

• optional types.KIID id = 1

  The ID that was given by BeginCommit

• CommitAction action = 2

  What to do with this commit

• string message = 3

  Optional message describing this changeset

• optional types.ItemHeader header = 4

  Specifies which document to associate the commit with

(message has no fields)

• optional types.DocumentSpecifier document = 1

• repeated string text = 2

• repeated string text = 1

• optional types.ItemHeader header = 1

• repeated types.KIID items = 2

• BoundingBoxMode mode = 3

  Some item types can have independently-movable text as children (e.g. footprints) This mode controls whether or not these are included in the box

• repeated types.KIID items = 1

• repeated types.Box2 boxes = 2

• optional types.ItemHeader header = 1

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

• repeated types.KiCadObjectType types = 2

  List of one or more types of items to retreive

• optional types.ItemHeader header = 1

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

• repeated types.KIID items = 2

• optional types.ItemHeader header = 1

  Specifies which document was modified, which fields are included in items, etc.

• types.ItemRequestStatus status = 2

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

• repeated google.protobuf.Any items = 3

Returns the full path to the given KiCad binary

• string binary_name = 1

  The short name of the binary, such as `kicad-cli` or `kicad-cli.exe`. If on Windows, an `.exe` extension will be assumed if not present.

(message has no fields)

Retrieves a list of open documents of the given type

• types.DocumentType type = 1

  Which type of documents to query

• repeated types.DocumentSpecifier documents = 1

returns common.types.PageSettings

• optional types.DocumentSpecifier document = 1

Return a writeable path that a plugin can use for storing persistent data such as configuration files, etc. This path may not yet exist; actual creation of the directory for a given plugin is up to the plugin itself. Files in this path will not be modified if the plugin is uninstalled or upgraded. Returns StringResponse

• string identifier = 1

  The identifier of the plugin

Retrieves a list of items. Returns SelectionResponse

• optional types.ItemHeader header = 1

  Specifies which document to query for selected items.

• repeated types.KiCadObjectType types = 2

  An optional list of types to filter on. If none are provided, all selected items will be returned.

Render the given text object(s) as shapes. Depending on whether the text is using the KiCad stroke font or a custom font, the response will be a compound shape containing a set of polygons or a set of segments.

• repeated TextOrTextBox text = 1

• repeated TextWithShapes text_with_shapes = 1

returns kiapi.common.types.Box2

• optional types.Text text = 1

  A temporary text item to calculate the bounding box for

returns kiapi.common.project.TextVariables

• optional types.DocumentSpecifier document = 1

returns common.types.TitleBlockInfo

• optional types.DocumentSpecifier document = 1

(message has no fields)

• optional types.KiCadVersion version = 1

Tests if a certain point falls within tolerance of an item's geometry

• optional types.ItemHeader header = 1

• optional types.KIID id = 2

• optional types.Vector2 position = 3

• int32 tolerance = 4

• HitTestResult result = 1

Used in: HitTestResponse

• HTR_UNKNOWN = 0

• HTR_NO_HIT = 1

• HTR_HIT = 2

Used in: CreateItemsResponse

• optional ItemStatus status = 1

• optional google.protobuf.Any item = 2

  The created version of the item, including an updated KIID as applicable

Used in: DeleteItemsResponse

• optional types.KIID id = 1

• ItemDeletionStatus status = 2

Used in: ItemDeletionResult

• IDS_UNKNOWN = 0

• IDS_OK = 1

• IDS_NONEXISTENT = 2

  The item did not exist in the given document

• IDS_IMMUTABLE = 3

  The item is not allowed to be modified by the API

Per-item status feedback for creation and update calls

Used in: ItemCreationResult, ItemUpdateResult

• ItemStatusCode code = 1

• string error_message = 2

Used in: ItemStatus

• ISC_UNKNOWN = 0

• ISC_OK = 1

  The item was created or updated

• ISC_INVALID_TYPE = 2

  The item's type is not valid for the given document

• ISC_EXISTING = 3

  The item to be created had a specified KIID and that KIID was already in use

• ISC_NONEXISTENT = 4

  The item to be updated did not exist in the given document

• ISC_IMMUTABLE = 5

  The item to be updated is not allowed to be modified by the API

• ISC_INVALID_DATA = 7

  The item to be created does not have valid data for the given document

Used in: UpdateItemsResponse

• optional ItemStatus status = 1

• optional google.protobuf.Any item = 2

  The update version of the item

• repeated project.NetClass net_classes = 1

• types.DocumentType type = 1

• string path = 2

• optional types.DocumentSpecifier document = 1

Opens a specific item from a library by identifier

• types.DocumentType type = 1

• optional types.LibraryIdentifier identifier = 2

Attempts to parse the given string as a s-expression formatted container with items, similar to how the Paste action inside the KiCad editor works. If the parse is successful, the items will be created and inserted into the editor. Returns CreateItemsResponse

• optional types.DocumentSpecifier document = 1

• string contents = 2

• string path = 1

A command to check if the connection to KiCad is OK

(message has no fields)

Refreshes the given frame, if that frame is open

• types.FrameType frame = 1

Removes the given items to the selection. Returns SelectionResponse

• optional types.ItemHeader header = 1

• repeated types.KIID items = 2

  The items to deselect

• optional types.DocumentSpecifier document = 1

Runs a TOOL_ACTION using the TOOL_MANAGER of a given frame. WARNING: The TOOL_ACTIONs are specifically *not* an API. Command names may change as code is refactored, and commands may disappear. This API method is provided for low-level prototyping purposes only.

• string action = 1

  Action name, like "eeschema.InteractiveSelection.ClearSelection"

NOTE: At the moment, RAS_FRAME_NOT_OPEN won't be returned as the handler is inside the frame.

• RunActionStatus status = 1

Used in: RunActionResponse

• RAS_UNKNOWN = 0

• RAS_OK = 1

  The action was submitted successfully.

• RAS_INVALID = 2

  The action was unknown for the targeted frame.

• RAS_FRAME_NOT_OPEN = 3

  The targeted frame was not open when the call was submitted.

Saves the given document to a new location and does not open the new copy

• optional types.DocumentSpecifier document = 1

• string path = 2

• optional SaveOptions options = 3

• optional types.DocumentSpecifier document = 1

• optional types.DocumentSpecifier document = 1

Used in: SaveCopyOfDocument

• bool overwrite = 1

  Overwrite destination file(s) if they exist

• bool include_project = 2

  If the file being saved normally requires a project (for example, a board or schematic), this flag will cause a new project to be saved alongside the new file

(message has no fields)

• optional types.DocumentSpecifier document = 1

• string contents = 2

• repeated types.KIID ids = 1

• string contents = 2

The set of currently selected items

• repeated google.protobuf.Any items = 1

• repeated project.NetClass net_classes = 1

• types.MapMergeMode merge_mode = 3

  Whether to merge or replace the existing netclasses with the contents of this message Note that this only happens at the level of netclass name: for example, if merge_mode is set to MMM_MERGE, the design has netclasses ["Default", "HV"], and this message has netclasses ["Default", "LV"], the resulting set will be ["Default", "HV", "LV"] -- the Default netclass will have its properties replaced with those in this message, the "LV" netclass will be added, and the "HV" netclass will be left alone. If merge_mode is set to MMM_REPLACE, the "HV" class will be erased. Note that there must always be a "Default" netclass, so it will not be erased even if merge_mode is MMM_REPLACE and there is no "Default" class specified in this message.

• optional types.DocumentSpecifier document = 1

• optional types.PageSettings page_settings = 2

• optional types.DocumentSpecifier document = 1

• optional project.TextVariables variables = 2

• types.MapMergeMode merge_mode = 3

  Whether to merge or replace the existing text variables map with the contents of this message

• optional types.DocumentSpecifier document = 1

• optional types.TitleBlockInfo title_block = 2

• string response = 1

Used in: GetTextAsShapes, TextWithShapes

• oneof inner

  • types.Text text = 1

  • types.TextBox textbox = 2

Used in: GetTextAsShapesResponse

• optional TextOrTextBox text = 1

• optional types.CompoundShape shapes = 2

Updates items in a given document

• optional types.ItemHeader header = 1

  Specifies which document to modify, which fields are included, etc.

• repeated google.protobuf.Any items = 2

  List of items to modify

• optional types.ItemHeader header = 1

  Specifies which document was modified, which fields are included in updated_items, etc.

• types.ItemRequestStatus status = 2

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

• repeated ItemUpdateResult updated_items = 3

  Status of each item to be created