CfgTerminalInfo

class pyedb.configuration.cfg_terminals.CfgTerminalInfo

Factory for terminal-location descriptors used in port/source definitions.

Overview

Static methods

from_pin	Return a pin-based terminal descriptor.
from_net	Return a net-based terminal descriptor.
from_pin_group	Return a pin-group-based terminal descriptor.
from_padstack	Return a padstack-instance-based terminal descriptor.
from_coordinates	Return a coordinate-based terminal descriptor.
from_nearest_pin	Return a nearest-pin terminal descriptor.

Import detail

from pyedb.configuration.cfg_terminals import CfgTerminalInfo

Method detail

static CfgTerminalInfo.from_pin(pin: str, reference_designator: str | None = None) → dict

Return a pin-based terminal descriptor.

Parameters:

pinstr

Pin name.

reference_designatorstr, optional

Component reference designator.

Returns:

dict

static CfgTerminalInfo.from_net(net: str, reference_designator: str | None = None) → dict

Return a net-based terminal descriptor.

Parameters:

netstr

Net name.

reference_designatorstr, optional

Component reference designator.

Returns:

dict

static CfgTerminalInfo.from_pin_group(pin_group: str) → dict

Return a pin-group-based terminal descriptor.

Parameters:

pin_groupstr

Pin group name.

Returns:

dict

static CfgTerminalInfo.from_padstack(padstack: str) → dict

Return a padstack-instance-based terminal descriptor.

Parameters:

padstackstr

Padstack instance name.

Returns:

dict

static CfgTerminalInfo.from_coordinates(layer: str, x: float | int | str, y: float | int | str, net: str) → dict

Return a coordinate-based terminal descriptor.

Parameters:

layerstr

Layer name.

xfloat, int, or str

X coordinate.

yfloat, int, or str

Y coordinate.

netstr

Net name.

Returns:

dict

static CfgTerminalInfo.from_nearest_pin(reference_net: str, search_radius: str = '5mm') → dict

Return a nearest-pin terminal descriptor.

Parameters:

reference_netstr

Reference net name used to find the nearest pin.

search_radiusstr, optional

Search radius, default is "5mm".

Returns:

dict