transformer module#

Transformer symbol for JITX Standard Library

This module provides the transformer symbol definition, which is composed of multiple inductor-like coils.

class CoilConfig(config, direction, taps=(), polarized=None)[source]#

Configuration for a single transformer coil

Parameters:
config: InductorConfig#

Inductor parameters for the coil. ‘core_style’ is ignored and should instead be specified at the Transformer level. ‘polarized’ is ignored and should instead be specified at this CoilConfig level.

direction: Direction#

The direction of the coil, either Direction.Left or Direction.Right.

taps: tuple[int, ...] = ()#

Optional tap locations for this coil. The indices in this list are dependent on the number of ‘periods’ in the coil’s ‘config’. The max number of taps is one less than the number of periods. These indices are 0-based.

polarized: Direction | None = None#

Optional polarization marker that adds a dot near either the top or bottom of the coil. The direction specified should be either Direction.Up or Direction.Down, if not None.

class TransformerConfig(label_config=None, coils=<factory>, core_style=InductorCoreStyle.NO_CORE, tap_length=2, pin_pitch=2.0, pin_length=4, pad_name_size=1.3)[source]#

Bases: LabelConfigurable

Configuration for a transformer symbol.

Parameters:
coils: list[CoilConfig]#

The coils are an ordered list of CoilConfig objects, rendered in order depending on their Left/Right direction.

core_style: InductorCoreStyle = 'no_core'#

Style for the graphical representation of the transformer’s core. This is typically used to indicate features like “Air Core”, “Iron Core”, or “Ferrite Core”, etc.

tap_length: int = 2#

The extra line added in the X direction to extend the connection points away from the winding. This value is optional but can be useful for clearer symbols when using windings with one or more taps. This extends the tap position line either to the left or right depending on the coil configuration. Integral values are required to fit to the schematic grid.

pin_pitch: float = 2.0#

The size of the winding half-circle shapes.

pin_length: int = 4#

The length of the pins extending out from the winding.

pad_name_size: float = 1.3#

The text size for the pad reference labels shown on each pin.

class TransformerSymbol(config=None, **kwargs)[source]#

Bases: LabelledSymbol

Transformer symbol with coil graphics and pins.

Parameters:

config (TransformerConfig | None)

inductor_composites: tuple[Composite, ...]#
core_bars: tuple[Polyline, Polyline] | Polyline | None = None#
config: TransformerConfig#
property coils: list[CoilConfig]#

See coils.

property core_style: InductorCoreStyle#

See core_style.

property tap_length: int#

See tap_length.

property pin_pitch: float#

See pin_pitch.

property pin_length: int#

See pin_length.

property label_config: LabelConfigurable#

Configuration object that provides label configuration

class CoilPortContainer[source]#

Bases: Container