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.
- 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).
See also
- decrement_voltage(channel, verify=True)[source]
Decrement the voltage by step size of the output channel.
- Parameters:
See also
- 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 anint
.- Returns:
int
orstr
– The event status register value. The data type depends on the value of as_integer. If astr
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_over_current_protection(channel)[source]
Get the over-current protection trip point of the output channel.
- get_over_voltage_protection(channel)[source]
Get the over-voltage protection trip point of the output channel.
- 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).
See also
- increment_voltage(channel, verify=True)[source]
Increment the voltage by step size of the output channel.
- Parameters:
See also
- 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 toNEVER
, see the manual for more details),True
(set the channel toQUICK
, see the manual for more details) or a delay in milliseconds (as anint
).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
See also
- 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 toNEVER
, see the manual for more details),True
(set the channel toQUICK
, see the manual for more details) or a delay in milliseconds (as anint
).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
See also
- recall(channel, index)[source]
Recall the settings of the output channel from the store.
- Parameters:
See also
- 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(channel, index)[source]
Save the present settings of the output channel to the store.
- Parameters:
See also
- 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
- set_current_meter_averaging(channel, value)[source]
Set the current meter measurement averaging of the output channel.
- set_current_step_size(channel, size)[source]
Set the current limit step size of the output channel.
- set_multi_on_delay(channel, delay)[source]
Set the Multi-On delay, in milliseconds, of the output channel.
- set_multi_off_delay(channel, delay)[source]
Set the Multi-Off delay, in milliseconds, of the output channel.
- set_over_current_protection(channel, enable, value=None)[source]
Set the over-current protection trip point of the output channel.
- set_over_voltage_protection(channel, enable, value=None)[source]
Set the over-voltage protection trip point of the output channel.