qcodes_contrib_drivers.drivers.QphoX.CryoSwitchController package¶

Submodules¶

qcodes_contrib_drivers.drivers.QphoX.CryoSwitchController.CryoSwitchController module¶

class qcodes_contrib_drivers.drivers.QphoX.CryoSwitchController.CryoSwitchController.Cryoswitch(debug=False, COM_port='', IP=None, SN=None, override_abspath=False)[source]¶

Bases: object

calculate_OCP_code(OCP_value)[source]¶

calculate_error(measured, set)[source]¶

calculate_output_code(Vout)[source]¶

calculate_polarization_current_mA(voltage=None, resistance=None)[source]¶

check_voltage(measured_voltage, target_voltage, tolerance=0.1, pre_str='')[source]¶

connect(port, contact)[source]¶

disable_3V3()[source]¶

disable_5V()[source]¶

disable_chopping()[source]¶

disable_converter()[source]¶

disable_negative_supply()[source]¶

disable_output_channels()[source]¶

discharge()[source]¶

disconnect(port, contact)[source]¶

disconnect_all(port)[source]¶

enable_3V3()[source]¶

enable_5V()[source]¶

enable_OCP()[source]¶

enable_chopping()[source]¶

enable_converter(init_voltage=None)[source]¶

enable_negative_supply()[source]¶

enable_output_channels()[source]¶

flash(path=None)[source]¶

get_HW_revision()[source]¶

get_OCP_status()[source]¶

get_UIDs()[source]¶

get_V_ref()[source]¶

get_bias_voltage()[source]¶

get_converter_voltage()[source]¶

get_internal_temperature()[source]¶

get_ip()[source]¶

get_output_state()[source]¶

get_power_status()[source]¶

get_pulse_history(port=None, pulse_number=None)[source]¶

get_sub_net_mask()[source]¶

get_switches_state(port=None)[source]¶

log_pulse(port, contact, polarity, max_current)[source]¶

log_wav_init()[source]¶

log_waveform(port, contact, polarity, current_profile)[source]¶

measure_ADC(channel)[source]¶

plotting_function(current_profile, port, contact, polarity)[source]¶

pulse_logging_init()[source]¶

reconnect()[source]¶

reset()[source]¶

reset_OCP()[source]¶

reset_output_supervisor()[source]¶

save_switch_state(port, contact, polarity)[source]¶

select_and_pulse(port, contact, polarity)[source]¶

select_output_channel(port, number, polarity)[source]¶

select_switch_model(model='R583423141')[source]¶

send_pulse()[source]¶

set_FW_upgrade_mode()[source]¶

set_OCP_mA(OCP_value)[source]¶

set_ip(add='192.168.1.101')[source]¶

set_output_voltage(Vout)[source]¶

set_pulse_duration_ms(ms_duration)[source]¶

set_sampling_frequency_khz(f_khz)[source]¶

set_sub_net_mask(mask='255.255.255.0')[source]¶

smart_connect(port, contact, force=False)[source]¶

standby()[source]¶

start()[source]¶

test_internals(voltage=10)[source]¶

tracking_init()[source]¶

validate_port_contact(port, contact)[source]¶

validate_selected_channel(number, polarity, reply)[source]¶

qcodes_contrib_drivers.drivers.QphoX.CryoSwitchController.libphox module¶

class qcodes_contrib_drivers.drivers.QphoX.CryoSwitchController.libphox.Labphox(port=None, debug=False, IP=None, cmd_logging=False, SN=None, HW_val=False)[source]¶

Bases: object

ADC3_cmd(cmd, value=0)[source]¶

ADC_cmd(cmd, value=0)[source]¶

DAC_cmd(cmd, DAC=1, value=0)[source]¶

ETHERNET_cmd(cmd, value=0)[source]¶

FLASH_utils(path=None)[source]¶

IO_expander_cmd(cmd, port='A', value=0)[source]¶

TCP_communication_handler(encoded_cmd=None)[source]¶

UDP_communication_handler(encoded_cmd=None)[source]¶

UDP_packet_handler(encoded_cmd, end_sequence)[source]¶

UPGRADE_cmd(cmd, value)[source]¶

USB_communication_handler(encoded_cmd=None)[source]¶

USB_packet_handler(encoded_cmd, end_sequence)[source]¶

application_cmd(cmd, value=0)[source]¶

communication_handler(cmd, standard=True, is_encoded=False)[source]¶

compare_cmd(cmd1, cmd2)[source]¶

connect(HW_val=True)[source]¶

debug_func(cmd, reply)[source]¶

decode_buffer()[source]¶

decode_simple_response(response)[source]¶

disconnect()[source]¶

encode(value)[source]¶

flush_input_buffer()[source]¶

gpio_cmd(cmd, value=0)[source]¶

input_buffer()[source]¶

logger_init(logger_instance, outfolder=None)[source]¶

logging(list_name, cmd)[source]¶

packet_handler(cmd, end_sequence=b'\x00\xff\x00\xff')[source]¶

parse_response()[source]¶

query_line(cmd)[source]¶

raise_value_mismatch(cmd, response)[source]¶

read(size)[source]¶

read_buffer()[source]¶

read_line()[source]¶

reset_cmd(cmd)[source]¶

standard_reply_parser(cmd, reply)[source]¶

timer_cmd(cmd, value=0)[source]¶

utility_cmd(cmd, value=0)[source]¶

validate_reply(cmd, response)[source]¶

write(cmd)[source]¶

qcodes_contrib_drivers.drivers.QphoX.CryoSwitchController.qcodes_driver module¶

class qcodes_contrib_drivers.drivers.QphoX.CryoSwitchController.qcodes_driver.CryoSwitchChannel(parent: Instrument, name: str, channel: str)[source]¶

Bases: InstrumentChannel

CryoSwitchChannel class is used to define the channels for the CryoSwitchControllerDriver. It is a subclass of the InstrumentChannel class from qcodes.

parent¶

The parent instrument to which the channel is attached.

Type:: Instrument

name¶

The name of the channel.

Type:: str

channel¶

The channel identifier.

Type:: str

active_contact¶

The active contact for the channel. It can be a number between 0 and 6.

Type:: Parameter

__init__(parent: Instrument, name: str, channel: str)[source]¶

Initializes a new instance of the CryoSwitchChannel class.

Parameters:

parent (Instrument) – The parent instrument to which the channel is attached.
name (str) – The name of the channel.
channel (str) – The channel identifier.

connect(contact: int)[source]¶

Applies a current pulse to make a specified contact.

Parameters:: contact (int) – The contact to be connected.
Returns:: The current waveform after the connection.
Return type:: np.ndarray

disconnect(contact: int)[source]¶

Applies a current pulse to disconnect a specified contact.

Parameters:: contact (int) – The contact to be disconnected.
Returns:: The current waveform after the disconnection.
Return type:: np.ndarray

disconnect_all()[source]¶

Applies a disconnecting pulse to all contacts.

Returns:: The current waveform after all contacts are disconnected.
Return type:: np.ndarray

smart_connect(contact: int)[source]¶

Connects a contact to the channel smartly, i.e., disconnects the previously connected contacts and connects the specified switch contact based on the tracking history.

Parameters:: contact (int) – The contact to be connected.
Returns:: The current waveform after the smart connection.
Return type:: np.ndarray

class qcodes_contrib_drivers.drivers.QphoX.CryoSwitchController.qcodes_driver.CryoSwitchControllerDriver(*args: Any, **kwargs: Any)[source]¶

Bases: Instrument

CryoSwitchControllerDriver class is used to control the Cryoswitch. It is a subclass of the Instrument class from qcodes.

name¶

The name of the instrument.

Type:: str

output_voltage¶

The output voltage of the controller. It can be a number between 0 and 25 (V).

Type:: Parameter

pulse_duration¶

The pulse duration of the controller. It can be a number between 0 and 1000 (ms).

Type:: Parameter

OCP_value¶

The overcurrent protection trigger value of the controller. It can be a number between 0 and 1000 (mA).

Type:: Parameter

chopping¶

The chopping function status of the controller. It can be a boolean value.

Type:: Parameter

switch_model¶

The switch model used by the controller. It can be either ‘R583423141’ or ‘R573423600’. Equvalently, one may set the model using ‘RT’ (room temperature) for R573423600, and ‘CRYO’ instead of ‘R583423141’. The two switch types require different connectivity between the D-Sub on the controller box and the switch.

Type:: Parameter

power_status¶

The power status of the controller. It can be either 0 (disabled) or 1 (enabled).

Type:: Parameter

__init__(name: str, **kwargs)[source]¶

Initializes a new instance of the CryoSwitchControllerDriver class.

Parameters:: name (str) – The name of the instrument.

close()[source]¶: Disconnect from the switch controller.

connect(port: str, contact: int)[source]¶

Applies a current pulse to connect a specific contact of a switch at a selected port.

Parameters:

port (str) – The port to which the contact is connected.
contact (int) – The contact to be connected.

Returns:

The current waveform after the connection.

Return type:

trace

disconnect(port: str, contact: int)[source]¶

Applies a current pulse to disconnect a specific contact of a switch at a selected port.

Parameters:

port (str) – The port from which the contact is disconnected.
contact (int) – The contact to be disconnected.

Returns:

The current waveform after the disconnection.

Return type:

trace

disconnect_all(port: str)[source]¶

Applies a disconnecting current pulse to all contacts of the specified port

Parameters:: port (str) – A letter A-D indicating the port to be controlled.

get_idn()[source]¶: A dummy getidn function for the instrument initialization in QCoDeS to work.

get_switches_state(port: str | None = None)[source]¶

Read and return the state of the contacts as recorded in the states.json

Parameters:: port (str|None) – A port which states are to be returned. None will return the state of all contacts. (default None)
Returns:: dictionary listing a state of every contact.
Return type:: dict

smart_connect(port: str, contact: int)[source]¶

Disconnects from all the connected contacts for a specified channel and connects only to the indicated one.

Parameters:

port (str) – A letter A-D indicating the port to be controlled.
contact (int) – Number of the contact that is to be connected

Module contents¶

qcodes_contrib_drivers.drivers.QphoX.CryoSwitchController.create_json_structure()[source]¶

qcodes_contrib_drivers.drivers.QphoX.CryoSwitchController.create_port_template()[source]¶