msl.equipment.resources.aim_tti.mx_series module

Establishes a connection to an MX100QP, MX100TP or MX180TP DC power supply from Aim and Thurlby Thandar Instruments

class msl.equipment.resources.aim_tti.mx_series.MXSeries(record)[source]

Bases: object

Establishes a connection to an MX100QP, MX100TP or MX180TP DC power supply from Aim and Thurlby Thandar Instruments for different interfaces:

Do not instantiate this class directly. Use the connect() method to connect to the equipment.

Parameters

record (EquipmentRecord) – A record from an Equipment-Register Database.

clear()[source]

Send the clear, *CLS, command.

decrement_current(channel)[source]

Decrement the current limit by step size of the output channel.

Parameters

channel (int) – The output channel. The first output channel is 1 (not 0).

decrement_voltage(channel, verify=True)[source]

Decrement the voltage by step size of the output channel.

Parameters
  • channel (int) – The output channel. The first output channel is 1 (not 0).

  • verify (bool, optional) – Whether to verify that the output voltage has stabilized at the decremented voltage before returning to the calling program.

event_status_register(as_integer=True)[source]

Read and clear the standard event status register.

Parameters

as_integer (bool, optional) – Whether to return the value as an int.

Returns

int or str – The event status register value. The data type depends on the value of as_integer. If a str is returned then it will have a length of 8. For example,

  • ’10000000’ or the integer value 128

  • ’00100000’ or the integer value 32

get_current(channel)[source]

Get the output current of the output channel.

Parameters

channel (int) – The output channel. The first output channel is 1 (not 0).

Returns

float – The output current, in Amps.

get_current_limit(channel)[source]

Get the current limit of the output channel.

Parameters

channel (int) – The output channel. The first output channel is 1 (not 0).

Returns

float – The current limit, in Amps.

get_current_step_size(channel)[source]

Get the current limit step size of the output channel.

Parameters

channel (int) – The output channel. The first output channel is 1 (not 0).

Returns

float – The current limit step size, in Amps.

get_over_current_protection(channel)[source]

Get the over-current protection trip point of the output channel.

Parameters

channel (int) – The output channel. The first output channel is 1 (not 0).

Returns

float or None – If the trip point is enabled then returns the trip point value, in Amps. Returns None if the over-current protection is disabled.

get_over_voltage_protection(channel)[source]

Get the over-voltage protection trip point of the output channel.

Parameters

channel (int) – The output channel. The first output channel is 1 (not 0).

Returns

float or None – If the trip point is enabled then returns the trip point value, in Volts. Returns None if the over-voltage protection is disabled.

get_voltage(channel)[source]

Get the output voltage of the output channel.

Parameters

channel (int) – The output channel. The first output channel is 1 (not 0).

Returns

float – The output voltage, in Volts.

get_voltage_range(channel)[source]

Get the output voltage range index of the output channel.

Parameters

channel (int) – The output channel. The first output channel is 1 (not 0).

Returns

int – The output voltage range index. See the manual for more details. For example, 2 = 35V/3A.

get_voltage_setpoint(channel)[source]

Get the set-point voltage of the output channel.

Parameters

channel (int) – The output channel. The first output channel is 1 (not 0).

Returns

float – The set-point voltage, in Volts.

get_voltage_step_size(channel)[source]

Get the voltage step size of the output channel.

Parameters

channel (int) – The output channel. The first output channel is 1 (not 0).

Returns

float – The voltage step size, in Volts.

get_voltage_tracking_mode()[source]

Get the voltage tracking mode of the unit.

Returns

int – The voltage tracking mode. See the manual for more details.

increment_current(channel)[source]

Increment the current limit by step size of the output channel.

Parameters

channel (int) – The output channel. The first output channel is 1 (not 0).

increment_voltage(channel, verify=True)[source]

Increment the voltage by step size of the output channel.

Parameters
  • channel (int) – The output channel. The first output channel is 1 (not 0).

  • verify (bool, optional) – Whether to verify that the output voltage has stabilized at the incremented voltage before returning to the calling program.

is_output_on(channel)[source]

Check if the output channel is on or off.

Parameters

channel (int) – The output channel. The first output channel is 1 (not 0).

Returns

bool – Whether the output channel is on (True) or off (False).

turn_on(channel)[source]

Turn the output channel on.

Parameters

channel (int) – The output channel. The first output channel is 1 (not 0).

turn_on_multi(options=None)[source]

Turn multiple output channels on (the Multi-On feature).

Parameters

options (dict, optional) –

Set the Multi-On option for each output channel before setting Multi-On. If not specified then uses the pre-programmed options. If a particular output channel is not included in options then uses the pre-programmed option for that channel. The keys are the output channel number and the value can be False (set the channel to NEVER, see the manual for more details), True (set the channel to QUICK, see the manual for more details) or a delay in milliseconds (as an int).

Examples:

  • {1: False} \(\rightarrow\) channel 1 does not turn on

  • {2: 100} \(\rightarrow\) channel 2 has a 100-ms delay

  • {1: 100, 3: True} \(\rightarrow\) channel 1 has a 100-ms delay and channel 3 turns on immediately

  • {1: 100, 2: 200, 3: 300} \(\rightarrow\) channel 1 has a 100-ms delay, channel 2 has a 200-ms delay and channel 3 has a 300-ms delay

turn_off(channel)[source]

Turn the output channel off.

Parameters

channel (int) – The output channel. The first output channel is 1 (not 0).

turn_off_multi(options=None)[source]

Turn multiple output channels off (the Multi-Off feature).

Parameters

options (dict, optional) –

Set the Multi-Off option for each output channel before setting Multi-Off. If not specified then uses the pre-programmed options. If a particular output channel is not included in options then uses the pre-programmed option for that channel. The keys are the output channel number and the value can be False (set the channel to NEVER, see the manual for more details), True (set the channel to QUICK, see the manual for more details) or a delay in milliseconds (as an int).

Examples:

  • {1: False} \(\rightarrow\) channel 1 does not turn off

  • {2: 100} \(\rightarrow\) channel 2 has a 100-ms delay

  • {1: 100, 3: True} \(\rightarrow\) channel 1 has a 100-ms delay and channel 3 turns off immediately

  • {1: 100, 2: 200, 3: 300} \(\rightarrow\) channel 1 has a 100-ms delay, channel 2 has a 200-ms delay and channel 3 has a 300-ms delay

recall(channel, index)[source]

Recall the settings of the output channel from the store.

Parameters
  • channel (int) – The output channel. The first output channel is 1 (not 0).

  • index (int) – The store index number, can be 0-49.

See also

save()

recall_all(index)[source]

Recall the settings for all output channels from the store.

Parameters

index (int) – The store index number, can be 0-49.

See also

save_all()

reset()[source]

Send the reset, *RST, command.

reset_trip()[source]

Attempt to clear all trip conditions.

save(channel, index)[source]

Save the present settings of the output channel to the store.

Parameters
  • channel (int) – The output channel. The first output channel is 1 (not 0).

  • index (int) – The store index number, can be 0-49.

See also

recall()

save_all(index)[source]

Save the settings of all output channels to the store.

Parameters

index (int) – The store index number, can be 0-49.

See also

recall_all()

set_current_limit(channel, value)[source]

Set the current limit of the output channel.

Parameters
  • channel (int) – The output channel. The first output channel is 1 (not 0).

  • value (float) – The current limit, in Amps.

set_current_meter_averaging(channel, value)[source]

Set the current meter measurement averaging of the output channel.

Parameters
  • channel (int) – The output channel. The first output channel is 1 (not 0).

  • value (str) – Can be ON, OFF, LOW, MED or HIGH.

set_current_step_size(channel, size)[source]

Set the current limit step size of the output channel.

Parameters
  • channel (int) – The output channel. The first output channel is 1 (not 0).

  • size (float) – The current limit step size, in Amps.

set_multi_on_action(channel, action)[source]

Set the Multi-On action of the output channel.

Parameters
  • channel (int) – The output channel. The first output channel is 1 (not 0).

  • action (str) – The Multi-On action, one of QUICK, NEVER or DELAY.

set_multi_on_delay(channel, delay)[source]

Set the Multi-On delay, in milliseconds, of the output channel.

Parameters
  • channel (int) – The output channel. The first output channel is 1 (not 0).

  • delay (int) – The delay, in milliseconds.

set_multi_off_action(channel, action)[source]

Set the Multi-Off action of the output channel.

Parameters
  • channel (int) – The output channel. The first output channel is 1 (not 0).

  • action (str) – The Multi-Off action, one of QUICK, NEVER or DELAY.

set_multi_off_delay(channel, delay)[source]

Set the Multi-Off delay, in milliseconds, of the output channel.

Parameters
  • channel (int) – The output channel. The first output channel is 1 (not 0).

  • delay (int) – The delay, in milliseconds.

set_over_current_protection(channel, enable, value=None)[source]

Set the over-current protection trip point of the output channel.

Parameters
  • channel (int) – The output channel. The first output channel is 1 (not 0).

  • enable (bool) – Whether to enable (True) or disable (False) the over-current protection trip point.

  • value (float, optional) – If the trip point is enabled then you must specify a value, in Amps.

set_over_voltage_protection(channel, enable, value=None)[source]

Set the over-voltage protection trip point of the output channel.

Parameters
  • channel (int) – The output channel. The first output channel is 1 (not 0).

  • enable (bool) – Whether to enable (True) or disable (False) the over-voltage protection trip point.

  • value (float, optional) – If the trip point is enabled then you must specify a value, in Volts.

set_voltage(channel, value, verify=True)[source]

Set the output voltage of the output channel.

Parameters
  • channel (int) – The output channel. The first output channel is 1 (not 0).

  • value (float) – The value, in Volts.

  • verify (bool, optional) – Whether to verify that the output voltage has stabilized at value before returning to the calling program.

set_voltage_range(channel, index)[source]

Set the output voltage range of the output channel.

Parameters
  • channel (int) – The output channel. The first output channel is 1 (not 0).

  • index (int) – The output voltage range index. See the manual for more details. For example, 2 = 35V/3A.

set_voltage_step_size(channel, size)[source]

Set the voltage step size of the output channel.

Parameters
  • channel (int) – The output channel. The first output channel is 1 (not 0).

  • size (float) – The voltage step size, in Volts.

set_voltage_tracking_mode(mode)[source]

Set the voltage tracking mode of the unit.

Parameters

mode (int) – The voltage tracking mode. See the manual for more details.