Common Utilities

This section documents shared enums, health checks, and other utility modules used throughout PyTestLab.

Enums

`pytestlab.common.enums`

Bases: str, Enum

Bases: str, Enum

Bases: str, Enum

Bases: str, Enum

Bases: str, Enum

Bases: str, Enum

Bases: str, Enum

Bases: str, Enum

Bases: str, Enum

Bases: str, Enum

Bases: str, Enum

Bases: str, Enum

Bases: str, Enum

Bases: str, Enum

Health Checks

`pytestlab.common.health`

Bases: BaseModel

Bases: str, Enum

Common Utilities

Common Utilities

Enums

pytestlab.common.enums

__all__ = ['SCPIOnOff', 'WaveformType', 'TriggerSlope', 'AcquisitionType', 'OutputLoadImpedance', 'OutputPolarity', 'VoltageUnit', 'TriggerSource', 'SyncMode', 'ModulationSource'] module-attribute

AcquisitionType

AVERAGE = 'AVER' class-attribute instance-attribute

HIGH_RES = 'HRES' class-attribute instance-attribute

NORMAL = 'NORM' class-attribute instance-attribute

PEAK = 'PEAK' class-attribute instance-attribute

ArbAdvanceMode

SRATE = 'SRATe' class-attribute instance-attribute

TRIGGER = 'TRIGger' class-attribute instance-attribute

ArbFilterType

NORMAL = 'NORMal' class-attribute instance-attribute

OFF = 'OFF' class-attribute instance-attribute

STEP = 'STEP' class-attribute instance-attribute

BurstMode

GATED = 'GATed' class-attribute instance-attribute

TRIGGERED = 'TRIGgered' class-attribute instance-attribute

ModulationSource

CH1 = 'CH1' class-attribute instance-attribute

CH2 = 'CH2' class-attribute instance-attribute

EXTERNAL = 'EXTernal' class-attribute instance-attribute

INTERNAL = 'INTernal' class-attribute instance-attribute

OutputLoadImpedance

DEFAULT = 'DEFault' class-attribute instance-attribute

FIFTY_OHM = '50' class-attribute instance-attribute

INFINITY = 'INFinity' class-attribute instance-attribute

MAXIMUM = 'MAXimum' class-attribute instance-attribute

MINIMUM = 'MINimum' class-attribute instance-attribute

OutputPolarity

INVERTED = 'INVerted' class-attribute instance-attribute

NORMAL = 'NORMal' class-attribute instance-attribute

SCPIOnOff

OFF = 'OFF' class-attribute instance-attribute

ON = 'ON' class-attribute instance-attribute

SweepSpacing

LINEAR = 'LINear' class-attribute instance-attribute

LOGARITHMIC = 'LOGarithmic' class-attribute instance-attribute

SyncMode

CARRIER = 'CARRier' class-attribute instance-attribute

MARKER = 'MARKer' class-attribute instance-attribute

NORMAL = 'NORMal' class-attribute instance-attribute

TriggerSlope

ALTERNATING = 'ALT' class-attribute instance-attribute

EITHER = 'EITH' class-attribute instance-attribute

NEGATIVE = 'NEG' class-attribute instance-attribute

POSITIVE = 'POS' class-attribute instance-attribute

TriggerSource

BUS = 'BUS' class-attribute instance-attribute

EXTERNAL = 'EXTernal' class-attribute instance-attribute

IMMEDIATE = 'IMMediate' class-attribute instance-attribute

TIMER = 'TIMer' class-attribute instance-attribute

VoltageUnit

DBM = 'DBM' class-attribute instance-attribute

VPP = 'VPP' class-attribute instance-attribute

VRMS = 'VRMS' class-attribute instance-attribute

WaveformType

ARB = 'ARB' class-attribute instance-attribute

DC = 'DC' class-attribute instance-attribute

NOISE = 'NOIS' class-attribute instance-attribute

PULSE = 'PULS' class-attribute instance-attribute

RAMP = 'RAMP' class-attribute instance-attribute

SINE = 'SIN' class-attribute instance-attribute

SQUARE = 'SQU' class-attribute instance-attribute

Health Checks

pytestlab.common.health

HealthReport

backend_status = None class-attribute instance-attribute

errors = [] class-attribute instance-attribute

instrument_idn = None class-attribute instance-attribute

model_config = ConfigDict(validate_assignment=True) class-attribute instance-attribute

status = HealthStatus.UNKNOWN class-attribute instance-attribute

supported_features = {} class-attribute instance-attribute

warnings = [] class-attribute instance-attribute

HealthStatus

ERROR = 'ERROR' class-attribute instance-attribute

OK = 'OK' class-attribute instance-attribute

UNKNOWN = 'UNKNOWN' class-attribute instance-attribute

`pytestlab.common.enums`

`all = ['SCPIOnOff', 'WaveformType', 'TriggerSlope', 'AcquisitionType', 'OutputLoadImpedance', 'OutputPolarity', 'VoltageUnit', 'TriggerSource', 'SyncMode', 'ModulationSource']` `module-attribute`

`AcquisitionType`

`AVERAGE = 'AVER'` `class-attribute` `instance-attribute`

`HIGH_RES = 'HRES'` `class-attribute` `instance-attribute`

`NORMAL = 'NORM'` `class-attribute` `instance-attribute`

`PEAK = 'PEAK'` `class-attribute` `instance-attribute`

`ArbAdvanceMode`

`SRATE = 'SRATe'` `class-attribute` `instance-attribute`

`TRIGGER = 'TRIGger'` `class-attribute` `instance-attribute`

`ArbFilterType`

`NORMAL = 'NORMal'` `class-attribute` `instance-attribute`

`OFF = 'OFF'` `class-attribute` `instance-attribute`

`STEP = 'STEP'` `class-attribute` `instance-attribute`

`BurstMode`

`GATED = 'GATed'` `class-attribute` `instance-attribute`

`TRIGGERED = 'TRIGgered'` `class-attribute` `instance-attribute`

`ModulationSource`

`CH1 = 'CH1'` `class-attribute` `instance-attribute`

`CH2 = 'CH2'` `class-attribute` `instance-attribute`

`EXTERNAL = 'EXTernal'` `class-attribute` `instance-attribute`

`INTERNAL = 'INTernal'` `class-attribute` `instance-attribute`

`OutputLoadImpedance`

`DEFAULT = 'DEFault'` `class-attribute` `instance-attribute`

`FIFTY_OHM = '50'` `class-attribute` `instance-attribute`

`INFINITY = 'INFinity'` `class-attribute` `instance-attribute`

`MAXIMUM = 'MAXimum'` `class-attribute` `instance-attribute`

`MINIMUM = 'MINimum'` `class-attribute` `instance-attribute`

`OutputPolarity`

`INVERTED = 'INVerted'` `class-attribute` `instance-attribute`

`NORMAL = 'NORMal'` `class-attribute` `instance-attribute`

`SCPIOnOff`

`OFF = 'OFF'` `class-attribute` `instance-attribute`

`ON = 'ON'` `class-attribute` `instance-attribute`

`SweepSpacing`

`LINEAR = 'LINear'` `class-attribute` `instance-attribute`

`LOGARITHMIC = 'LOGarithmic'` `class-attribute` `instance-attribute`

`SyncMode`

`CARRIER = 'CARRier'` `class-attribute` `instance-attribute`

`MARKER = 'MARKer'` `class-attribute` `instance-attribute`

`NORMAL = 'NORMal'` `class-attribute` `instance-attribute`

`TriggerSlope`

`ALTERNATING = 'ALT'` `class-attribute` `instance-attribute`

`EITHER = 'EITH'` `class-attribute` `instance-attribute`

`NEGATIVE = 'NEG'` `class-attribute` `instance-attribute`

`POSITIVE = 'POS'` `class-attribute` `instance-attribute`

`TriggerSource`

`BUS = 'BUS'` `class-attribute` `instance-attribute`

`EXTERNAL = 'EXTernal'` `class-attribute` `instance-attribute`

`IMMEDIATE = 'IMMediate'` `class-attribute` `instance-attribute`

`TIMER = 'TIMer'` `class-attribute` `instance-attribute`

`VoltageUnit`

`DBM = 'DBM'` `class-attribute` `instance-attribute`

`VPP = 'VPP'` `class-attribute` `instance-attribute`

`VRMS = 'VRMS'` `class-attribute` `instance-attribute`

`WaveformType`

`ARB = 'ARB'` `class-attribute` `instance-attribute`

`DC = 'DC'` `class-attribute` `instance-attribute`

`NOISE = 'NOIS'` `class-attribute` `instance-attribute`

`PULSE = 'PULS'` `class-attribute` `instance-attribute`

`RAMP = 'RAMP'` `class-attribute` `instance-attribute`

`SINE = 'SIN'` `class-attribute` `instance-attribute`

`SQUARE = 'SQU'` `class-attribute` `instance-attribute`

`pytestlab.common.health`

`HealthReport`

`backend_status = None` `class-attribute` `instance-attribute`

`errors = []` `class-attribute` `instance-attribute`

`instrument_idn = None` `class-attribute` `instance-attribute`

`model_config = ConfigDict(validate_assignment=True)` `class-attribute` `instance-attribute`

`status = HealthStatus.UNKNOWN` `class-attribute` `instance-attribute`

`supported_features = {}` `class-attribute` `instance-attribute`

`warnings = []` `class-attribute` `instance-attribute`

`HealthStatus`

`ERROR = 'ERROR'` `class-attribute` `instance-attribute`

`OK = 'OK'` `class-attribute` `instance-attribute`

`UNKNOWN = 'UNKNOWN'` `class-attribute` `instance-attribute`

`WARNING = 'WARNING'` `class-attribute` `instance-attribute`