Types and definitions#

Instrument type enums and classes.

class qblox_instruments.InstrumentClass(value)[source]#

Bases: TypeEnum

Instrument class enum.

CLUSTER = 'Cluster'#
class qblox_instruments.InstrumentType(value)[source]#

Bases: TypeEnum

Instrument/module type enum.

MM = 'MM'#
QCM = 'QCM'#
QRM = 'QRM'#
QTM = 'QTM'#
QDM = 'QDM'#
LINQ = 'LINQ'#
QRC = 'QRC'#
QSM = 'QSM'#
class qblox_instruments.ClusterType(value)[source]#

Bases: TypeEnum

Cluster module type enum.

CLUSTER_QCM = 'Cluster QCM'#
CLUSTER_QCM_RF = 'Cluster QCM-RF'#
CLUSTER_QRM = 'Cluster QRM'#
CLUSTER_QRM_RF = 'Cluster QRM-RF'#
CLUSTER_QTM = 'Cluster QTM'#
CLUSTER_QTM_EOM = 'Cluster QTM-Pulse'#
CLUSTER_QDM = 'Cluster QDM'#
CLUSTER_LINQ = 'Cluster LINQ'#
CLUSTER_QRC = 'Cluster QRC'#
CLUSTER_QSM = 'Cluster QSM'#
class qblox_instruments.TypeHandle(instrument: ClusterType | str)[source]#

Bases: object

Instrument type handler class.

__init__(instrument: ClusterType | str) None[source]#

Create instrument type handler object.

Parameters:

instrument (Union[ClusterType, str]) – Instrument/module type specification.

property instrument_class: InstrumentClass#

Get instrument class (e.g. Cluster).

Returns:

Instrument class

Return type:

InstrumentClass

property instrument_type: InstrumentType#

Get instrument type (e.g. MM, QRM, QCM, QTM).

Returns:

Instrument type

Return type:

InstrumentType

property is_mm_type: bool#

Return if module is of type MM.

Returns:

True if module is of type MM.

Return type:

bool

property is_qcm_type: bool#

Return if module is of type QCM.

Returns:

True if module is of type QCM.

Return type:

bool

property is_qrm_type: bool#

Return if module is of type QRM.

Returns:

True if module is of type QRM.

Return type:

bool

property is_qtm_type: bool#

Return if module is of type QTM.

Returns:

True if module is of type QTM.

Return type:

bool

property is_qdm_type: bool#

Return if module is of type QDM.

Returns:

True if module is of type QDM.

Return type:

bool

property is_eom_type: bool#

Return if module is of type EOM.

Returns:

True if module is of type EOM.

Return type:

bool

property is_linq_type: bool#

Return if module is of type LINQ.

Returns:

True if module is of type LINQ.

Return type:

bool

property is_qrc_type: bool#

Return if module is of type QRC.

Returns:

True if module is of type QRC.

Return type:

bool

property is_qsm_type: bool#

Return if module is of type QSM.

Returns:

True if module is of type QSM.

Return type:

bool

property is_rf_type: bool#

Return if has RF functionality.

Returns:

True if module has RF functionality.

Return type:

bool

class qblox_instruments.types.DebugLevel(value)[source]#

Bases: IntEnum

Debug level for communication with the instrument.

MINIMAL_CHECK = 0#

Check for version mismatch between qblox-instruments and the firmware. Perform a system error check only when starting or stopping sequencers.

ERROR_CHECK = 1#

Do not check for a version mismatch. Perform an error check on every SCPI call.

NO_CHECK = 2#

Do not check for a version mismatch or system errors.

VERSION_AND_ERROR_CHECK = 3#

Check for version mismatch between qblox-instruments and the firmware. Perform an error check on every SCPI call.

class qblox_instruments.types.TypeEnum(value)[source]#

Bases: Enum

Type base class that arranges child enum string representations.

class qblox_instruments.types.FrequencyParameter(*args, calibration_function, **kwargs)[source]#

Bases: DelegateParameter

__init__(*args, calibration_function, **kwargs) None[source]#
set_raw(val, cal_type=None) None[source]#

set_raw is called to perform the actual setting of a parameter on the instrument. This method should either be overwritten to perform the desired operation or alternatively for Parameter a suitable method is automatically generated if set_cmd is supplied to the parameter constructor. The method is automatically wrapped to provide a set method on the parameter instance.

class qblox_instruments.native.definitions.StateEnum(value)[source]#

Bases: Enum

State enum base class that arranges child enum string representations.

class qblox_instruments.native.definitions.DeprecatedStateEnum(value)[source]#

Bases: StateEnum

State enum class that throws deprecation warning.

__init__(_warning_message) None[source]#
class qblox_instruments.native.definitions.StateTuple(_warning_message)[source]#

Bases: object

State tuple base class that arranges child tuple string representations.

__init__(_warning_message) None[source]#
class qblox_instruments.native.definitions.SystemStatusTuple[source]#

Bases: object

System Status tuple base class that arranges child tuple string representations.

class qblox_instruments.native.definitions.StatusTuple[source]#

Bases: object

Status tuple base class that arranges child tuple string representations.

class qblox_instruments.native.definitions.SystemStatuses(value)[source]#

Bases: StateEnum

System status enum.

BOOTING = 'System is booting.'#
OKAY = 'System is okay.'#
RESOLVED = 'An error indicated by the flags occurred, but has been resolved.'#
ERROR = 'An error indicated by the flags is occurring.'#
CRIT_ERROR = 'A critical error indicated by the flags is occurring'#
class qblox_instruments.native.definitions.SystemStatusFlags(value)[source]#

Bases: StateEnum

System status flags enum.

PLL_UNLOCKED = 'PLL is unlocked.'#
TEMPERATURE_OUT_OF_RANGE = 'Temperature is out of range.'#
CRIT_TEMPERATURE_OUT_OF_RANGE = 'Temperature is critically out of range.'#
MODULE_NOT_CONNECTED = 'Module is not connected.'#
MODULE_FIRM_OR_HARDWARE_INCOMPATIBLE = 'Module firmware is incompatible'#
FEEDBACK_NETWORK_CALIBRATION_FAILED = 'The feedback network calibration failed.'#
HARDWARE_COMPONENT_FAILED = 'Hardware component failed'#
TRIGGER_NETWORK_MISSED_EXT_TRIGGER = 'Trigger Network Missed External Trigger.'#
class qblox_instruments.native.definitions.SystemStatusSlotFlags(slot_flags: dict | None = None)[source]#

Bases: SystemStatusSlotFlags

Tuple containing lists of Cluster slot status flag enums of type SystemStatusFlags. Each Cluster slot has its own status flag list attribute named slot<X>.

class qblox_instruments.native.definitions.SystemStatus(status, flags, slot_flags)[source]#

Bases: SystemStatus, SystemStatusTuple

System status tuple returned by get_system_status(). The tuple contains a system status enum of type SystemStatuses, a list of associated system status flag enums of type SystemStatusFlags and a tuple of type SystemStatusSlotFlags containing Cluster slot status flags.

class qblox_instruments.native.definitions.SequencerStates(value)[source]#

Bases: StateEnum

Sequencer state enum.

IDLE = 'Sequencer waiting to be armed and started.'#
ARMED = 'Sequencer is armed and ready to start.'#
RUNNING = 'Sequencer is running.'#
Q1_STOPPED = 'Classical part of the sequencer has stopped; waiting for real-time part to stop.'#
STOPPED = 'Sequencer has completely stopped.'#
class qblox_instruments.native.definitions.SequencerStatuses(value)[source]#

Bases: StateEnum

Sequencer status enum.

OKAY = 'OKAY'#
WARNING = 'WARNING'#
ERROR = 'ERROR'#
class qblox_instruments.native.definitions.SequencerStatusFlags(value)[source]#

Bases: StateEnum

Sequencer status flags enum.

DISARMED = 'Sequencer was disarmed.'#
FORCED_STOP = 'Sequencer was stopped while still running.'#
SEQUENCE_PROCESSOR_Q1_ILLEGAL_INSTRUCTION = 'Classical sequencer part executed an unknown instruction.'#
SEQUENCE_PROCESSOR_RT_EXEC_ILLEGAL_INSTRUCTION = 'Real-time sequencer part executed an unknown instruction.'#
SEQUENCE_PROCESSOR_RT_EXEC_COMMAND_UNDERFLOW = 'Real-time sequencer part command queue underflow.'#
AWG_WAVE_PLAYBACK_INDEX_INVALID_PATH_0 = 'AWG path 0 tried to play an unknown waveform.'#
AWG_WAVE_PLAYBACK_INDEX_INVALID_PATH_1 = 'AWG path 1 tried to play an unknown waveform.'#
ACQ_WEIGHT_PLAYBACK_INDEX_INVALID_PATH_0 = 'Acquisition path 0 tried to play an unknown weight.'#
ACQ_WEIGHT_PLAYBACK_INDEX_INVALID_PATH_1 = 'Acquisition path 1 tried to play an unknown weight.'#
ACQ_SCOPE_DONE_PATH_0 = 'Scope acquisition for path 0 has finished.'#
ACQ_SCOPE_OUT_OF_RANGE_PATH_0 = 'Scope acquisition data for path 0 was out-of-range.'#
ACQ_SCOPE_OVERWRITTEN_PATH_0 = 'Scope acquisition data for path 0 was overwritten.'#
ACQ_SCOPE_DONE_PATH_1 = 'Scope acquisition for path 1 has finished.'#
ACQ_SCOPE_OUT_OF_RANGE_PATH_1 = 'Scope acquisition data for path 1 was out-of-range.'#
ACQ_SCOPE_OVERWRITTEN_PATH_1 = 'Scope acquisition data for path 1 was overwritten.'#
ACQ_SCOPE_DONE_PATH_2 = 'Scope acquisition for path 2 has finished.'#
ACQ_SCOPE_OUT_OF_RANGE_PATH_2 = 'Scope acquisition data for path 2 was out-of-range.'#
ACQ_SCOPE_OVERWRITTEN_PATH_2 = 'Scope acquisition data for path 2 was overwritten.'#
ACQ_SCOPE_DONE_PATH_3 = 'Scope acquisition for path 3 has finished.'#
ACQ_SCOPE_OUT_OF_RANGE_PATH_3 = 'Scope acquisition data for path 3 was out-of-range.'#
ACQ_SCOPE_OVERWRITTEN_PATH_3 = 'Scope acquisition data for path 3 was overwritten.'#
ACQ_BINNING_DONE = 'Acquisition binning completed.'#
ACQ_BINNING_FIFO_ERROR = 'Acquisition binning encountered internal FIFO error.'#
ACQ_BINNING_COMM_ERROR = 'Acquisition binning encountered internal communication error.'#
ACQ_BINNING_OUT_OF_RANGE = 'Acquisition binning data out-of-range.'#
ACQ_INDEX_INVALID = 'Acquisition tried to process an invalid acquisition.'#
ACQ_BIN_INDEX_INVALID = 'Acquisition tried to process an invalid bin.'#
TRIGGER_NETWORK_CONFLICT = 'Trigger network has encountered a conflict.'#
TRIGGER_NETWORK_MISSED_INTERNAL_TRIGGER = 'Trigger network missed an internal trigger.'#
OUTPUT_OVERFLOW = 'Output overflow.'#
CLOCK_INSTABILITY = 'Clock source instability occurred.'#
ACQ_INTEGRATOR_OUT_OF_RANGE_PATH_0 = 'Acquisition integration input data for path 0 was out-of-range.'#
ACQ_INTEGRATOR_OUT_OF_RANGE_PATH_1 = 'Acquisition integration input data for path 1 was out-of-range.'#
DIO_COMMAND_OVERFLOW = 'DIO_COMMAND_OVERFLOW'#
DIO_DELAY_OUT_OF_ORDER = 'DIO_DELAY_OUT_OF_ORDER'#
DIO_UNSUPPORTED_PULSE_WIDTH = 'DIO_UNSUPPORTED_PULSE_WIDTH'#
DIO_TIMETAG_DEADLINE_MISSED = 'DIO_TIMETAG_DEADLINE_MISSED'#
DIO_TIME_DELTA_INVALID = 'DIO_TIME_DELTA_INVALID'#
DIO_COUNT_INVALID = 'DIO_COUNT_INVALID'#
DIO_THRESHOLD_INVALID = 'DIO_THRESHOLD_INVALID'#
DIO_INTERNAL_ERROR = 'DIO_INTERNAL_ERROR'#
class qblox_instruments.native.definitions.SequencerStatus(status, state, info_flags, warn_flags, err_flags, log)[source]#

Bases: SequencerStatus, StatusTuple

Sequencer status tuple returned by get_sequencer_status(). The tuple contains a sequencer status, state, flags and log. The tuple contains: a sequencer status enum of type SequencerStatuses, a sequencer state enum of type SequencerStates, a list of associated info flags enums of type SequencerStatusFlags, a list of associated warning flags enums of type SequencerStatusFlags, a list of associated error flags enums of type SequencerStatusFlags, a list of informative log message of type str.