kigadgets.module

Module Contents

Classes

FootprintLabel

wrapper for TEXTE_MODULE or (old) FP_TEXT

FootprintLine

Wrapper for EDGE_MODULE or (old) FP_SHAPE

Footprint

Board items that has valid position property should inherit

Attributes

Module

ModuleLine

ModuleLabel

class kigadgets.module.FootprintLabel(mod, text=None, layer=None)

Bases: kigadgets.item.HasPosition, kigadgets.item.HasLayer, kigadgets.item.Selectable, kigadgets.item.BoardItem, kigadgets.item.TextEsque

Inheritance diagram of kigadgets.module.FootprintLabel

wrapper for TEXTE_MODULE or (old) FP_TEXT

property visible
property position
property x
property y
property layer
property is_selected
property native_obj
property board
property text
property thickness
property size
property orientation
property justification
justification_lookups
geohash()
select(value=True)

Selecting changes the appearance and also plays a role in determining what will be the subject of a subsequent command (delete, move to layer, etc.)

deselect()
brighten(value=True)

Brightening gives a bright green appearance

classmethod wrap(instance)
class kigadgets.module.FootprintLine

Bases: kigadgets.item.HasLayer, kigadgets.item.Selectable, kigadgets.item.BoardItem

Inheritance diagram of kigadgets.module.FootprintLine

Wrapper for EDGE_MODULE or (old) FP_SHAPE

property layer
property is_selected
property native_obj
property board
geohash()
select(value=True)

Selecting changes the appearance and also plays a role in determining what will be the subject of a subsequent command (delete, move to layer, etc.)

deselect()
brighten(value=True)

Brightening gives a bright green appearance

classmethod wrap(instance)
class kigadgets.module.Footprint(ref=None, pos=None, board=None)

Bases: kigadgets.item.HasPosition, kigadgets.item.HasOrientation, kigadgets.item.Selectable, kigadgets.item.BoardItem

Inheritance diagram of kigadgets.module.Footprint

Board items that has valid position property should inherit this.

property reference
property reference_label
property value
property value_label
property graphical_items

Text and drawings of module iterator.

property layer
property lib_name
property fp_name
property pads
property position
property x
property y
property orientation

Rotation of the item in degrees.

property is_selected
property native_obj
property board
flip()
copy(ref, pos=None, board=None)

Create a copy of an existing module on the board A new reference designator is required, example:

mod2 = mod1.copy('U2')
mod2.reference == 'U2'  # True

mod2 is automatically placed in mod1.board

remove(element, permanent=False)

Makes it so Ctrl-Z works. Keeps a reference to the element in the python pcb object, so it persists for the life of that object

restore_removed()
geohash()
select(value=True)

Selecting changes the appearance and also plays a role in determining what will be the subject of a subsequent command (delete, move to layer, etc.)

deselect()
brighten(value=True)

Brightening gives a bright green appearance

classmethod wrap(instance)
kigadgets.module.Module
kigadgets.module.ModuleLine
kigadgets.module.ModuleLabel