package kiapi.common.types

Get desktop application:
View/edit binary Protocol Buffers messages

Corresponds to EDA_ANGLE, where the underlying storage is degrees

Used in: board.types.FootprintInstance, board.types.HatchFillSettings, board.types.PadStack, board.types.ThermalSpokeSettings, TextAttributes

• double value_degrees = 1

The formulation of arc that is used in KiCad core geometry code. Start, midpoint (on the arc) and end are stored. Angle, center point, etc are calculated.

Used in: PolyLineNode

• optional Vector2 start = 1

• optional Vector2 mid = 2

• optional Vector2 end = 3

Used in: board.types.OrthogonalDimensionAttributes

• AA_UNKNOWN = 0

• AA_X_AXIS = 1

• AA_Y_AXIS = 2

Used in: commands.GetBoundingBoxResponse

• optional Vector2 position = 1

• optional Vector2 size = 2

Corresponds to COLOR4D. Each color channel is a double from 0.0 to 1.0.

Used in: board.BoardStackupLayer, project.NetClassBoardSettings, project.NetClassSchematicSettings, GraphicFillAttributes, StrokeAttributes

• double r = 1

• double g = 2

• double b = 3

• double a = 4

Used in: CommandStatusResponse

• CS_UNKNOWN = 0

• CS_OK = 1

  Command succeeded

• CS_FAILED = 2

  Command failed

• CommandStatus status = 1

A SHAPE_COMPOUND in KiCad

Used in: commands.TextWithShapes

• repeated GraphicShape shapes = 1

Describes a quantity of distance (size, length, etc). All coordinates are in nanometers.

Used in: board.BoardLayerGraphicsDefaults, board.BoardStackupDielectricProperties, board.BoardStackupLayer, board.types.AlignedDimensionAttributes, board.types.Arc, board.types.CopperZoneSettings, board.types.Dimension, board.types.FootprintDesignRuleOverrides, board.types.HatchFillSettings, board.types.OrthogonalDimensionAttributes, board.types.Pad, board.types.RadialDimensionAttributes, board.types.SolderMaskOverrides, board.types.SolderPasteOverrides, board.types.ThermalSpokeSettings, board.types.Track, board.types.ZoneBorderSettings, project.NetClassBoardSettings, project.NetClassSchematicSettings, StrokeAttributes, TextAttributes

• int64 value_nm = 1

* Describes a document that will be the target of a request

Used in: board.commands.GetActiveLayer, board.commands.GetBoardOrigin, board.commands.GetBoardStackup, board.commands.GetGraphicsDefaults, board.commands.GetNets, board.commands.GetPadShapeAsPolygon, board.commands.GetVisibleLayers, board.commands.InteractiveMoveItems, board.commands.RefillZones, board.commands.SetActiveLayer, board.commands.SetBoardOrigin, board.commands.SetVisibleLayers, board.commands.UpdateBoardStackup, commands.ExpandTextVariables, commands.GetOpenDocumentsResponse, commands.GetTextVariables, commands.GetTitleBlockInfo, commands.ParseAndCreateItemsFromString, commands.RevertDocument, commands.SaveCopyOfDocument, commands.SaveDocument, commands.SaveDocumentToString, commands.SavedDocumentResponse, commands.SetTextVariables, ItemHeader

• DocumentType type = 1

• oneof identifier

  • LibraryIdentifier lib_id = 2

    If type == DT_SYMBOL or DT_FOOTPRINT, identifies a certain library entry

  • SheetPath sheet_path = 3

    If type == DT_SCHEMATIC, identifies a sheet with a given path

  • string board_filename = 4

    If type == DT_PCB, identifies a PCB with a given filename, e.g. "board.kicad_pcb"

• optional ProjectSpecifier project = 5

* Identifier for the type of document being targeted by a request

Used in: commands.GetOpenDocuments, DocumentSpecifier

• DOCTYPE_UNKNOWN = 0

• DOCTYPE_SCHEMATIC = 1

• DOCTYPE_SYMBOL = 2

• DOCTYPE_PCB = 3

• DOCTYPE_FOOTPRINT = 4

• DOCTYPE_DRAWING_SHEET = 5

• DOCTYPE_PROJECT = 6

* Some commands are specific to a KiCad window (frame). This list contains all addressable frames.

Used in: commands.RefreshEditor

• FT_UNKNOWN = 0

• FT_PROJECT_MANAGER = 1

• FT_SCHEMATIC_EDITOR = 2

• FT_PCB_EDITOR = 3

• FT_SPICE_SIMULATOR = 4

• FT_SYMBOL_EDITOR = 5

• FT_FOOTPRINT_EDITOR = 6

• FT_DRAWING_SHEET_EDITOR = 7

Used in: GraphicShape

• optional Vector2 start = 1

• optional Vector2 mid = 2

• optional Vector2 end = 3

Used in: GraphicShape

• optional StrokeAttributes stroke = 1

• optional GraphicFillAttributes fill = 2

Used in: GraphicShape

• optional Vector2 start = 1

• optional Vector2 control1 = 2

• optional Vector2 control2 = 3

• optional Vector2 end = 4

Used in: GraphicShape

• optional Vector2 center = 1

• optional Vector2 radius_point = 2

  A point on the radius of the circle. This is stored instead of just a radius so that the point by which the user can adjust the circle radius is persisted.

Used in: GraphicAttributes

• GraphicFillType fill_type = 1

• optional Color color = 2

  Color of the fill (not used in board and footprints)

Used in: GraphicFillAttributes

• GFT_UNKNOWN = 0

• GFT_UNFILLED = 1

• GFT_FILLED = 2

Used in: GraphicShape

• optional Vector2 top_left = 1

• optional Vector2 bottom_right = 2

Used in: GraphicShape

• optional Vector2 start = 1

• optional Vector2 end = 2

Used in: board.types.BoardGraphicShape, CompoundShape

• optional GraphicAttributes attributes = 3

  Reserved for future use; base EDA_SHAPE doesn't have an ID or locked state right now KIID id = 1; LockedState locked = 2;

• oneof geometry

  • GraphicSegmentAttributes segment = 4

  • GraphicRectangleAttributes rectangle = 5

  • GraphicArcAttributes arc = 6

  • GraphicCircleAttributes circle = 7

  • PolySet polygon = 8

  • GraphicBezierAttributes bezier = 9

Mapped to GR_TEXT_H_ALIGN_T

Used in: TextAttributes

• HA_UNKNOWN = 0

• HA_LEFT = 1

• HA_CENTER = 2

• HA_RIGHT = 3

• HA_INDETERMINATE = 4

* This header is included in requests and responses about item(s) in a document

Used in: board.commands.GetItemsByNet, board.commands.GetItemsByNetClass, commands.AddToSelection, commands.ClearSelection, commands.CreateItems, commands.CreateItemsResponse, commands.DeleteItems, commands.DeleteItemsResponse, commands.GetBoundingBox, commands.GetItems, commands.GetItemsResponse, commands.GetSelection, commands.HitTest, commands.RemoveFromSelection, commands.UpdateItems, commands.UpdateItemsResponse

• optional DocumentSpecifier document = 1

  Which document is this request targeting?

• optional KIID container = 2

  Which container within the document is this request targeting? If container is omitted or empty, the document is used as the container.

• optional google.protobuf.FieldMask field_mask = 3

  Which fields on the item(s) are included with this request or response

* Status of a request that included an ItemHeader

Used in: commands.CreateItemsResponse, commands.DeleteItemsResponse, commands.GetItemsResponse, commands.UpdateItemsResponse

• IRS_UNKNOWN = 0

• IRS_OK = 1

• IRS_DOCUMENT_NOT_FOUND = 2

  The given document is not open in KiCad

• IRS_FIELD_MASK_INVALID = 3

  The given field_mask contains invalid specifiers

* Describes a KIID, or UUID of an object in a KiCad editor model.

Used in: board.commands.GetPadShapeAsPolygon, board.commands.InteractiveMoveItems, board.commands.PadShapeAsPolygonResponse, board.commands.RefillZones, board.types.Arc, board.types.BoardGraphicShape, board.types.BoardText, board.types.BoardTextBox, board.types.Dimension, board.types.FootprintInstance, board.types.Pad, board.types.Track, board.types.Via, board.types.Zone, commands.AddToSelection, commands.BeginCommitResponse, commands.CreateItems, commands.DeleteItems, commands.EndCommit, commands.GetBoundingBox, commands.GetBoundingBoxResponse, commands.HitTest, commands.ItemDeletionResult, commands.RemoveFromSelection, commands.SavedSelectionResponse, ItemHeader, SheetPath, schematic.types.DirectiveLabel, schematic.types.GlobalLabel, schematic.types.HierarchicalLabel, schematic.types.Line, schematic.types.LocalLabel

• string value = 1

  The KIID's value in standard UUID format, stored as a string for easy portability

The set of object types (from KICAD_T) that are exposed to the API.

Used in: board.commands.GetItemsByNet, board.commands.GetItemsByNetClass, commands.GetItems, commands.GetSelection

• KOT_UNKNOWN = 0

• KOT_PCB_FOOTPRINT = 1

• KOT_PCB_PAD = 2

• KOT_PCB_SHAPE = 3

• KOT_PCB_REFERENCE_IMAGE = 4

• KOT_PCB_FIELD = 5

• KOT_PCB_GENERATOR = 6

• KOT_PCB_TEXT = 7

• KOT_PCB_TEXTBOX = 8

• KOT_PCB_TABLE = 9

• KOT_PCB_TABLECELL = 10

• KOT_PCB_TRACE = 11

• KOT_PCB_VIA = 12

• KOT_PCB_ARC = 13

• KOT_PCB_MARKER = 14

• KOT_PCB_DIMENSION = 15

• KOT_PCB_ZONE = 16

• KOT_PCB_GROUP = 17

• KOT_SCH_MARKER = 18

• KOT_SCH_JUNCTION = 19

• KOT_SCH_NO_CONNECT = 20

• KOT_SCH_BUS_WIRE_ENTRY = 21

• KOT_SCH_BUS_BUS_ENTRY = 22

• KOT_SCH_LINE = 23

• KOT_SCH_SHAPE = 24

• KOT_SCH_BITMAP = 25

• KOT_SCH_TEXTBOX = 26

• KOT_SCH_TEXT = 27

• KOT_SCH_TABLE = 28

• KOT_SCH_TABLECELL = 29

• KOT_SCH_LABEL = 30

• KOT_SCH_GLOBAL_LABEL = 31

• KOT_SCH_HIER_LABEL = 32

• KOT_SCH_DIRECTIVE_LABEL = 33

• KOT_SCH_FIELD = 34

• KOT_SCH_SYMBOL = 35

• KOT_SCH_SHEET_PIN = 36

• KOT_SCH_SHEET = 37

• KOT_SCH_PIN = 38

• KOT_LIB_SYMBOL = 39

  KOT_LIB_SHAPE = 40; KOT_LIB_TEXT = 41; KOT_LIB_TEXTBOX = 42; KOT_LIB_PIN = 43; KOT_LIB_FIELD = 44;

• KOT_WSG_LINE = 45

• KOT_WSG_RECT = 46

• KOT_WSG_POLY = 47

• KOT_WSG_TEXT = 48

• KOT_WSG_BITMAP = 49

• KOT_WSG_PAGE = 50

• KOT_SCH_GROUP = 51

* Describes a particular version of KiCad

Used in: commands.GetVersionResponse

• uint32 major = 1

• uint32 minor = 2

• uint32 patch = 3

• string full_version = 4

  Full identifier string, potentially containing git hashes, packager-added info, etc.

* Describes a KiCad LIB_ID; a unique identifier for a loaded symbol or footprint

Used in: board.types.Footprint, DocumentSpecifier

• string library_nickname = 1

  The library portion of the LIB_ID

• string entry_name = 2

  The symbol or footprint name

Describes whether or not an item is locked for editing or movement

Used in: board.types.Arc, board.types.BoardGraphicShape, board.types.BoardText, board.types.BoardTextBox, board.types.Dimension, board.types.FootprintInstance, board.types.Pad, board.types.Track, board.types.Via, board.types.Zone

• LS_UNKNOWN = 0

• LS_UNLOCKED = 1

• LS_LOCKED = 2

Used in: commands.SetNetClasses, commands.SetTextVariables

• MMM_UNKNOWN = 0

• MMM_MERGE = 1

  The existing map will be merged with the incoming map; keys that are not present in the incoming map will be preserved with their original values

• MMM_REPLACE = 2

  The existing map will be cleared and replaced with the incoming map

Corresponds to class SHAPE_LINE_CHAIN: A closed or open polyline that can include arcs. For non-arc cases, each node is a point along the line. An implicit line segment exists between the last and first node if closed is true. When arcs are present, the arc start and end points are not duplicated by point nodes (meaning, for example, a rectangle with rounded corners could be represented with four arc nodes and no point nodes).

Used in: PolygonWithHoles

• repeated PolyLineNode nodes = 1

• bool closed = 2

Used in: PolyLine

• oneof geometry

  • Vector2 point = 1

  • ArcStartMidEnd arc = 2

Corresponds to SHAPE_POLY_SET: a set of polygons or polylines

Used in: board.types.Zone, board.types.ZoneFilledPolygons, GraphicShape

• repeated PolygonWithHoles polygons = 1

Used in: board.commands.PadShapeAsPolygonResponse, PolySet

• optional PolyLine outline = 1

• repeated PolyLine holes = 2

* Describes a KiCad project

Used in: DocumentSpecifier

• string name = 1

  The name of the project (without the kicad_pro extension)

• string path = 2

  The path to the project directory

Represents a value from 0.0 to 1.0

Used in: board.types.SolderPasteOverrides

• double value = 1

* Describes a unique sheet in a schematic

Used in: board.types.FootprintInstance, DocumentSpecifier

• repeated KIID path = 1

  The canonical path to the sheet. The first KIID will be the root sheet, etc.

• string path_human_readable = 2

  The path converted to a human readable form such as "/", "/child", or "/child/grandchild"

Used in: GraphicAttributes

• optional Distance width = 1

• StrokeLineStyle style = 2

• optional Color color = 3

Mapped to LINE_STYLE

Used in: project.NetClassSchematicSettings, StrokeAttributes

• SLS_UNKNOWN = 0

• SLS_DEFAULT = 1

• SLS_SOLID = 2

• SLS_DASH = 3

• SLS_DOT = 4

• SLS_DASHDOT = 5

• SLS_DASHDOTDOT = 6

Used in: board.types.BoardText, board.types.Dimension, commands.GetTextExtents, commands.TextOrTextBox, schematic.types.Text

• optional Vector2 position = 2

  Reserved for future use; base text objects don't have IDs right now kiapi.common.types.KIID id = 1;

• optional TextAttributes attributes = 3

• string text = 5

• string hyperlink = 6

Used in: board.BoardLayerGraphicsDefaults, Text, TextBox

• string font_name = 1

• HorizontalAlignment horizontal_alignment = 2

• VerticalAlignment vertical_alignment = 3

• optional Angle angle = 4

• double line_spacing = 5

• optional Distance stroke_width = 6

• bool italic = 7

• bool bold = 8

• bool underlined = 9

• bool visible = 10

  Deprecated since 9.0.1 (text items are now always visible, only Fields can be hidden)

• bool mirrored = 11

• bool multiline = 12

• bool keep_upright = 13

• optional Vector2 size = 14

Used in: board.types.BoardTextBox, commands.TextOrTextBox

• optional Vector2 top_left = 2

• optional Vector2 bottom_right = 3

• optional TextAttributes attributes = 4

• string text = 6

The text strings that can be set in a drawing sheet for the title block

• string title = 1

• string date = 2

• string revision = 3

• string company = 4

• string comment1 = 5

• string comment2 = 6

• string comment3 = 7

• string comment4 = 8

• string comment5 = 9

• string comment6 = 10

• string comment7 = 11

• string comment8 = 12

• string comment9 = 13

Describes a point or distance in 2D space. All coordinates are in nanometers.

Used in: board.commands.SetBoardOrigin, board.types.AlignedDimensionAttributes, board.types.Arc, board.types.CenterDimensionAttributes, board.types.DrillProperties, board.types.Footprint, board.types.FootprintInstance, board.types.LeaderDimensionAttributes, board.types.OrthogonalDimensionAttributes, board.types.Pad, board.types.PadStackLayer, board.types.RadialDimensionAttributes, board.types.Track, board.types.Via, board.types.ZoneLayerProperties, commands.HitTest, ArcStartMidEnd, Box2, GraphicArcAttributes, GraphicBezierAttributes, GraphicCircleAttributes, GraphicRectangleAttributes, GraphicSegmentAttributes, PolyLineNode, Text, TextAttributes, TextBox, schematic.types.DirectiveLabel, schematic.types.GlobalLabel, schematic.types.HierarchicalLabel, schematic.types.Line, schematic.types.LocalLabel

• int64 x_nm = 1

• int64 y_nm = 2

Describes a point or distance in 3D space. All coordinates are in nanometers.

• int64 x_nm = 1

• int64 y_nm = 2

• int64 z_nm = 3

Used in: board.types.Footprint3DModel

• double x_nm = 1

• double y_nm = 2

• double z_nm = 3

Mapped to GR_TEXT_V_ALIGN_T

Used in: TextAttributes

• VA_UNKNOWN = 0

• VA_TOP = 1

• VA_CENTER = 2

• VA_BOTTOM = 3

• VA_INDETERMINATE = 4