`CfgComponents`#

class pyedb.configuration.cfg_components.CfgComponents(pedb=None, components_data=None)#: Fluent builder for the components configuration list.

Overview#

Methods

`get`	Return a `CfgComponent` for an existing EDB component.
`add`	Add a component configuration entry.
`clean`	Clear all components from the list.
`apply`	Apply all component settings to the EDB design.
`retrieve_parameters_from_edb`	Read all component settings from the open EDB design.
`get_data_from_db`	Read all component settings from the open EDB design.
`to_list`	Serialize all configured components.

Import detail#

from pyedb.configuration.cfg_components import CfgComponents

Method detail#

CfgComponents.get(reference_designator: str) → CfgComponent#

Return a CfgComponent for an existing EDB component.

The component is looked up by reference_designator in the live EDB session and its current properties (type, model, die, solder-ball, port) are pre-loaded into the returned builder. Mutate the returned object and then call edb.configuration.run(cfg) to push the changes back to the database.

If the component has already been registered via add() or a previous get() call, the cached entry is returned instead of creating a duplicate.

Parameters:

reference_designatorstr: Reference designator of the component to retrieve, e.g. "U1".

Returns:

CfgComponent: Component builder pre-populated with current EDB properties.

Raises:

KeyError: If no EDB session is attached or the component does not exist.

Examples

>>> cfg = edb.configuration.create_config_builder()
>>> u1 = cfg.components.get("U1")
>>> u1.set_solder_ball_properties("cylinder", "150um", "100um")
>>> edb.configuration.run(cfg)

CfgComponents.add(reference_designator: str, part_type=None, enabled=None, definition=None, placement_layer=None)#

Add a component configuration entry.