MX Series DC Power Supply

Connect to an MX100QP, MX100TP, MX103QP or MX180TP DC power supply from Aim and Thurlby Thandar Instruments.

MXSeries (MultiMessageBased)

MXSeries(equipment: Equipment)

              flowchart LR
              msl.equipment_resources.aim_tti.mx_series.MXSeries[MXSeries]
              msl.equipment_resources.multi_message_based.MultiMessageBased[MultiMessageBased]
              msl.equipment.interfaces.message_based.MessageBased[MessageBased]
              msl.equipment.schema.Interface[Interface]

                              msl.equipment_resources.multi_message_based.MultiMessageBased --> msl.equipment_resources.aim_tti.mx_series.MXSeries
                                msl.equipment.interfaces.message_based.MessageBased --> msl.equipment_resources.multi_message_based.MultiMessageBased
                                msl.equipment.schema.Interface --> msl.equipment.interfaces.message_based.MessageBased
                




              click msl.equipment_resources.aim_tti.mx_series.MXSeries href "" "msl.equipment_resources.aim_tti.mx_series.MXSeries"
              click msl.equipment_resources.multi_message_based.MultiMessageBased href "" "msl.equipment_resources.multi_message_based.MultiMessageBased"
              click msl.equipment.interfaces.message_based.MessageBased href "" "msl.equipment.interfaces.message_based.MessageBased"
              click msl.equipment.schema.Interface href "" "msl.equipment.schema.Interface"
            

Connect to an MX100QP, MX100TP, MX103QP or MX180TP DC power supply.

Regular-expression patterns that are used to select this Resource when connect() is called.

manufacturer=r"Aim\s*[-&_]?\s*(and)?\s*T(hurlby)?\s*T(handar)?\s*I(nstruments)?"
model=r"MX1[80][03][TQ]P"
flags=IGNORECASE

Parameters:

Name	Type	Description	Default
equipment	Equipment	An Equipment instance.	required

Source code in packages/resources/src/msl/equipment_resources/aim_tti/mx_series.py

def __init__(self, equipment: Equipment) -> None:
    r"""Connect to an MX100QP, MX100TP, MX103QP or MX180TP DC power supply from [Aim and Thurlby Thandar Instruments].

    [Aim and Thurlby Thandar Instruments]: https://www.aimtti.com/

    Regular-expression patterns that are used to select this Resource when
    [connect()][msl.equipment.schema.Equipment.connect] is called.
    ```python
    manufacturer=r"Aim\s*[-&_]?\s*(and)?\s*T(hurlby)?\s*T(handar)?\s*I(nstruments)?"
    model=r"MX1[80][03][TQ]P"
    flags=IGNORECASE
    ```

    Args:
        equipment: An [Equipment][] instance.
    """  # noqa: E501
    super().__init__(equipment)
    self.rstrip: bool = True

clear

clear() -> None

Send the clear command, *CLS.

Source code in packages/resources/src/msl/equipment_resources/aim_tti/mx_series.py

def clear(self) -> None:
    """Send the clear command, `*CLS`."""
    _ = self.write("*CLS")

decrement_current

decrement_current(channel: int) -> None

Decrement the current by step size for the output channel.

See also

get_current_step_size, set_current_step_size

Parameters:

Name	Type	Description	Default
channel	int	The output channel. The first output channel is 1 (not 0).	required

Source code in packages/resources/src/msl/equipment_resources/aim_tti/mx_series.py

def decrement_current(self, channel: int) -> None:
    """Decrement the current by step size for the output channel.

    !!! note "See also"
        [get_current_step_size][msl.equipment_resources.aim_tti.mx_series.MXSeries.get_current_step_size],
        [set_current_step_size][msl.equipment_resources.aim_tti.mx_series.MXSeries.set_current_step_size]

    Args:
        channel: The output channel. The first output channel is 1 (not 0).
    """
    self._write_and_check(f"DECI{channel}")

decrement_voltage

decrement_voltage(channel: int, *, verify: bool = True) -> None

Decrement the voltage by step size for the output channel.

See also

get_voltage_step_size, set_voltage_step_size

Parameters:

Name	Type	Description	Default
channel	int	The output channel. The first output channel is 1 (not 0).	required
verify	bool	Whether to verify that the output voltage has stabilized at the decremented voltage before returning to the calling program.	True

Source code in packages/resources/src/msl/equipment_resources/aim_tti/mx_series.py

def decrement_voltage(self, channel: int, *, verify: bool = True) -> None:
    """Decrement the voltage by step size for the output channel.

    !!! note "See also"
        [get_voltage_step_size][msl.equipment_resources.aim_tti.mx_series.MXSeries.get_voltage_step_size],
        [set_voltage_step_size][msl.equipment_resources.aim_tti.mx_series.MXSeries.set_voltage_step_size]

    Args:
        channel: The output channel. The first output channel is 1 (not 0).
        verify: Whether to verify that the output voltage has stabilized at
            the decremented voltage before returning to the calling program.
    """
    v = "V" if verify else ""
    self._write_and_check(f"DECV{channel}{v}")

event_status_register

event_status_register() -> int

Read and clear the standard event status register.

Returns:

Type	Description
int	The event status register value.

Source code in packages/resources/src/msl/equipment_resources/aim_tti/mx_series.py

def event_status_register(self) -> int:
    """Read and clear the standard event status register.

    Returns:
        The event status register value.
    """
    return int(self.query("*ESR?"))

get_current

get_current(channel: int) -> float

Get the output current of the output channel.

Parameters:

Name	Type	Description	Default
channel	int	The output channel. The first output channel is 1 (not 0).	required

Returns:

Type	Description
float	The output current (in Amps).

Source code in packages/resources/src/msl/equipment_resources/aim_tti/mx_series.py

def get_current(self, channel: int) -> float:
    """Get the output current of the output channel.

    Args:
        channel: The output channel. The first output channel is 1 (not 0).

    Returns:
        The output current (in Amps).
    """
    reply = self._query_and_check(f"I{channel}O?")
    return float(reply[:-1])  # the reply ends with 'A'

get_current_limit

get_current_limit(channel: int) -> float

Get the current limit of the output channel.

Parameters:

Name	Type	Description	Default
channel	int	The output channel. The first output channel is 1 (not 0).	required

Returns:

Type	Description
float	The current limit (in Amps).

Source code in packages/resources/src/msl/equipment_resources/aim_tti/mx_series.py

def get_current_limit(self, channel: int) -> float:
    """Get the current limit of the output channel.

    Args:
        channel: The output channel. The first output channel is 1 (not 0).

    Returns:
        The current limit (in Amps).
    """
    reply = self._query_and_check(f"I{channel}?")
    return float(reply[2:])

get_current_step_size

get_current_step_size(channel: int) -> float

Get the current step size of the output channel.

Parameters:

Name	Type	Description	Default
channel	int	The output channel. The first output channel is 1 (not 0).	required

Returns:

Type	Description
float	The current step size (in Amps).

Source code in packages/resources/src/msl/equipment_resources/aim_tti/mx_series.py

def get_current_step_size(self, channel: int) -> float:
    """Get the current step size of the output channel.

    Args:
        channel: The output channel. The first output channel is 1 (not 0).

    Returns:
        The current step size (in Amps).
    """
    reply = self._query_and_check(f"DELTAI{channel}?")
    return float(reply[7:])

get_over_current_protection

get_over_current_protection(channel: int) -> float | None

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

Parameters:

Name	Type	Description	Default
channel	int	The output channel. The first output channel is 1 (not 0).	required

Returns:

Type	Description
float | None	If the trip point is enabled then returns the trip point value in Amps. Otherwise, returns None if the over-current protection is disabled.

Source code in packages/resources/src/msl/equipment_resources/aim_tti/mx_series.py

def get_over_current_protection(self, channel: int) -> float | None:
    """Get the over-current protection trip point of the output channel.

    Args:
        channel: The output channel. The first output channel is 1 (not 0).

    Returns:
        If the trip point is enabled then returns the trip point value in Amps.
            Otherwise, returns `None` if the over-current protection is disabled.
    """
    reply = self._query_and_check(f"OCP{channel}?")
    if reply.endswith("OFF"):
        return None
    return float(reply[3:])

get_over_voltage_protection

get_over_voltage_protection(channel: int) -> float | None

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

Parameters:

Name	Type	Description	Default
channel	int	The output channel. The first output channel is 1 (not 0).	required

Returns:

Type	Description
float | None	If the trip point is enabled then returns the trip point value in Volts. Otherwise, returns None if the over-voltage protection is disabled.

Source code in packages/resources/src/msl/equipment_resources/aim_tti/mx_series.py

def get_over_voltage_protection(self, channel: int) -> float | None:
    """Get the over-voltage protection trip point of the output channel.

    Args:
        channel: The output channel. The first output channel is 1 (not 0).

    Returns:
        If the trip point is enabled then returns the trip point value in Volts.
            Otherwise, returns `None` if the over-voltage protection is disabled.
    """
    reply = self._query_and_check(f"OVP{channel}?")
    if reply.endswith("OFF"):
        return None
    return float(reply[3:])

get_voltage

get_voltage(channel: int) -> float

Get the output voltage of the output channel.

Parameters:

Name	Type	Description	Default
channel	int	The output channel. The first output channel is 1 (not 0).	required

Returns:

Type	Description
float	The output voltage (in Volts).

Source code in packages/resources/src/msl/equipment_resources/aim_tti/mx_series.py

def get_voltage(self, channel: int) -> float:
    """Get the output voltage of the output channel.

    Args:
        channel: The output channel. The first output channel is 1 (not 0).

    Returns:
        The output voltage (in Volts).
    """
    reply = self._query_and_check(f"V{channel}O?")
    return float(reply[:-1])  # the reply ends with 'V'

get_voltage_range

get_voltage_range(channel: int) -> int

Get the output voltage range index of the output channel.

Parameters:

Name	Type	Description	Default
channel	int	The output channel. The first output channel is 1 (not 0).	required

Returns:

Type	Description
int	The output voltage range index, e.g., 2 → 35V/3A. See the manual for more details.

Source code in packages/resources/src/msl/equipment_resources/aim_tti/mx_series.py

def get_voltage_range(self, channel: int) -> int:
    """Get the output voltage range index of the output channel.

    Args:
        channel: The output channel. The first output channel is 1 (not 0).

    Returns:
        The output voltage range index, e.g., 2 → 35V/3A. See the manual for more details.
    """
    return int(self._query_and_check(f"VRANGE{channel}?"))

get_voltage_setpoint

get_voltage_setpoint(channel: int) -> float

Get the set-point voltage of the output channel.

Parameters:

Name	Type	Description	Default
channel	int	The output channel. The first output channel is 1 (not 0).	required

Returns:

Type	Description
float	The set-point voltage (in Volts).

Source code in packages/resources/src/msl/equipment_resources/aim_tti/mx_series.py

def get_voltage_setpoint(self, channel: int) -> float:
    """Get the set-point voltage of the output channel.

    Args:
        channel: The output channel. The first output channel is 1 (not 0).

    Returns:
        The set-point voltage (in Volts).
    """
    reply = self._query_and_check(f"V{channel}?")
    return float(reply[2:])

get_voltage_step_size

get_voltage_step_size(channel: int) -> float

Get the voltage step size of the output channel.

Parameters:

Name	Type	Description	Default
channel	int	The output channel. The first output channel is 1 (not 0).	required

Returns:

Type	Description
float	The voltage step size (in Volts).

Source code in packages/resources/src/msl/equipment_resources/aim_tti/mx_series.py

def get_voltage_step_size(self, channel: int) -> float:
    """Get the voltage step size of the output channel.

    Args:
        channel: The output channel. The first output channel is 1 (not 0).

    Returns:
        The voltage step size (in Volts).
    """
    reply = self._query_and_check(f"DELTAV{channel}?")
    return float(reply[7:])

get_voltage_tracking_mode

get_voltage_tracking_mode() -> int

Get the voltage tracking mode of the unit.

Returns:

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

Source code in packages/resources/src/msl/equipment_resources/aim_tti/mx_series.py

def get_voltage_tracking_mode(self) -> int:
    """Get the voltage tracking mode of the unit.

    Returns:
        The voltage tracking mode. See the manual for more details.
    """
    return int(self._query_and_check("CONFIG?"))

increment_current

increment_current(channel: int) -> None

Increment the current by the step size for the output channel.

See also

get_current_step_size, set_current_step_size

Parameters:

Name	Type	Description	Default
channel	int	The output channel. The first output channel is 1 (not 0).	required

Source code in packages/resources/src/msl/equipment_resources/aim_tti/mx_series.py

def increment_current(self, channel: int) -> None:
    """Increment the current by the step size for the output channel.

    !!! note "See also"
        [get_current_step_size][msl.equipment_resources.aim_tti.mx_series.MXSeries.get_current_step_size],
        [set_current_step_size][msl.equipment_resources.aim_tti.mx_series.MXSeries.set_current_step_size]

    Args:
        channel: The output channel. The first output channel is 1 (not 0).
    """
    self._write_and_check(f"INCI{channel}")

increment_voltage

increment_voltage(channel: int, *, verify: bool = True) -> None

Increment the voltage by the step size for the output channel.

See also

get_voltage_step_size, set_voltage_step_size

Parameters:

Name	Type	Description	Default
channel	int	The output channel. The first output channel is 1 (not 0).	required
verify	bool	Whether to verify that the output voltage has stabilized at the incremented voltage before returning to the calling program.	True

Source code in packages/resources/src/msl/equipment_resources/aim_tti/mx_series.py

def increment_voltage(self, channel: int, *, verify: bool = True) -> None:
    """Increment the voltage by the step size for the output channel.

    !!! note "See also"
        [get_voltage_step_size][msl.equipment_resources.aim_tti.mx_series.MXSeries.get_voltage_step_size],
        [set_voltage_step_size][msl.equipment_resources.aim_tti.mx_series.MXSeries.set_voltage_step_size]

    Args:
        channel: The output channel. The first output channel is 1 (not 0).
        verify: Whether to verify that the output voltage has stabilized at
            the incremented voltage before returning to the calling program.
    """
    v = "V" if verify else ""
    self._write_and_check(f"INCV{channel}{v}")

is_output_on

is_output_on(channel: int) -> bool

Check if the output channel is on or off.

Parameters:

Name	Type	Description	Default
channel	int	The output channel. The first output channel is 1 (not 0).	required

Returns:

Type	Description
bool	Whether the output channel is on or off.

Source code in packages/resources/src/msl/equipment_resources/aim_tti/mx_series.py

def is_output_on(self, channel: int) -> bool:
    """Check if the output channel is on or off.

    Args:
        channel: The output channel. The first output channel is 1 (not 0).

    Returns:
        Whether the output channel is on or off.
    """
    reply = self._query_and_check(f"OP{channel}?")
    return reply == "1"

recall

recall(channel: int, index: int) -> None

Recall the settings of the output channel from the store.

Parameters:

Name	Type	Description	Default
channel	int	The output channel. The first output channel is 1 (not 0).	required
index	int	The store index number, can be 0-49.	required

Source code in packages/resources/src/msl/equipment_resources/aim_tti/mx_series.py

def recall(self, channel: int, index: int) -> None:
    """Recall the settings of the output channel from the store.

    Args:
        channel: The output channel. The first output channel is 1 (not 0).
        index: The store index number, can be 0-49.
    """
    self._write_and_check(f"RCL{channel} {index}")

recall_all

recall_all(index: int) -> None

Recall the settings for all output channels from the store.

Parameters:

Name	Type	Description	Default
index	int	The store index number, can be 0-49.	required

Source code in packages/resources/src/msl/equipment_resources/aim_tti/mx_series.py

def recall_all(self, index: int) -> None:
    """Recall the settings for all output channels from the store.

    Args:
        index: The store index number, can be 0-49.
    """
    self._write_and_check(f"*SAV {index}")

reset

reset() -> None

Send the reset command, *RST.

Source code in packages/resources/src/msl/equipment_resources/aim_tti/mx_series.py

def reset(self) -> None:
    """Send the reset command, `*RST`."""
    _ = self.write("*RST")

reset_trip

reset_trip() -> None

Attempt to clear all trip conditions.

Source code in packages/resources/src/msl/equipment_resources/aim_tti/mx_series.py

def reset_trip(self) -> None:
    """Attempt to clear all trip conditions."""
    _ = self.write("TRIPRST")

save

save(channel: int, index: int) -> None

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

Parameters:

Name	Type	Description	Default
channel	int	The output channel. The first output channel is 1 (not 0).	required
index	int	The store index number, can be 0-49.	required

Source code in packages/resources/src/msl/equipment_resources/aim_tti/mx_series.py

def save(self, channel: int, index: int) -> None:
    """Save the present settings of the output channel to the store.

    Args:
        channel: The output channel. The first output channel is 1 (not 0).
        index: The store index number, can be 0-49.
    """
    self._write_and_check(f"SAV{channel} {index}")

save_all

save_all(index: int) -> None

Save the settings of all output channels to the store.

Parameters:

Name	Type	Description	Default
index	int	The store index number, can be 0-49.	required

Source code in packages/resources/src/msl/equipment_resources/aim_tti/mx_series.py

def save_all(self, index: int) -> None:
    """Save the settings of all output channels to the store.

    Args:
        index: The store index number, can be 0-49.
    """
    self._write_and_check(f"*RCL {index}")

set_current_limit

set_current_limit(channel: int, value: float) -> None

Set the current limit of the output channel.

Parameters:

Name	Type	Description	Default
channel	int	The output channel. The first output channel is 1 (not 0).	required
value	float	The current limit (in Amps).	required

Source code in packages/resources/src/msl/equipment_resources/aim_tti/mx_series.py

def set_current_limit(self, channel: int, value: float) -> None:
    """Set the current limit of the output channel.

    Args:
        channel: The output channel. The first output channel is 1 (not 0).
        value: The current limit (in Amps).
    """
    self._write_and_check(f"I{channel} {value}")

set_current_meter_averaging

set_current_meter_averaging(
    channel: int, mode: Literal["ON", "OFF", "LOW", "MED", "HIGH"]
) -> None

Set the current meter measurement averaging of the output channel.

Parameters:

Name	Type	Description	Default
channel	int	The output channel. The first output channel is 1 (not 0).	required
mode	Literal['ON', 'OFF', 'LOW', 'MED', 'HIGH']	Averaging mode.	required

Source code in packages/resources/src/msl/equipment_resources/aim_tti/mx_series.py

def set_current_meter_averaging(self, channel: int, mode: Literal["ON", "OFF", "LOW", "MED", "HIGH"]) -> None:
    """Set the current meter measurement averaging of the output channel.

    Args:
        channel: The output channel. The first output channel is 1 (not 0).
        mode: Averaging mode.
    """
    self._write_and_check(f"DAMPING{channel} {mode}")

set_current_step_size

set_current_step_size(channel: int, size: float) -> None

Set the current step size of the output channel.

Parameters:

Name	Type	Description	Default
channel	int	The output channel. The first output channel is 1 (not 0).	required
size	float	The current step size, in Amps.	required

Source code in packages/resources/src/msl/equipment_resources/aim_tti/mx_series.py

def set_current_step_size(self, channel: int, size: float) -> None:
    """Set the current step size of the output channel.

    Args:
        channel: The output channel. The first output channel is 1 (not 0).
        size: The current step size, in Amps.
    """
    self._write_and_check(f"DELTAI{channel} {size}")

set_multi_off_action

set_multi_off_action(
    channel: int, action: Literal["QUICK", "NEVER", "DELAY"]
) -> None

Set the Multi-Off action of the output channel.

Parameters:

Name	Type	Description	Default
channel	int	The output channel. The first output channel is 1 (not 0).	required
action	Literal['QUICK', 'NEVER', 'DELAY']	The Multi-Off action.	required

Source code in packages/resources/src/msl/equipment_resources/aim_tti/mx_series.py

def set_multi_off_action(self, channel: int, action: Literal["QUICK", "NEVER", "DELAY"]) -> None:
    """Set the Multi-Off action of the output channel.

    Args:
        channel: The output channel. The first output channel is 1 (not 0).
        action: The Multi-Off action.
    """
    self._write_and_check(f"OFFACTION{channel} {action}")

set_multi_off_delay

set_multi_off_delay(channel: int, delay: int) -> None

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

Parameters:

Name	Type	Description	Default
channel	int	The output channel. The first output channel is 1 (not 0).	required
delay	int	The turn-off delay (in milliseconds).	required

Source code in packages/resources/src/msl/equipment_resources/aim_tti/mx_series.py

def set_multi_off_delay(self, channel: int, delay: int) -> None:
    """Set the Multi-Off delay, in milliseconds, of the output channel.

    Args:
        channel: The output channel. The first output channel is 1 (not 0).
        delay: The turn-off delay (in milliseconds).
    """
    self._write_and_check(f"OFFDELAY{channel} {delay}")

set_multi_on_action

set_multi_on_action(
    channel: int, action: Literal["QUICK", "NEVER", "DELAY"]
) -> None

Set the Multi-On action of the output channel.

Parameters:

Name	Type	Description	Default
channel	int	The output channel. The first output channel is 1 (not 0).	required
action	Literal['QUICK', 'NEVER', 'DELAY']	The Multi-On action.	required

Source code in packages/resources/src/msl/equipment_resources/aim_tti/mx_series.py

def set_multi_on_action(self, channel: int, action: Literal["QUICK", "NEVER", "DELAY"]) -> None:
    """Set the Multi-On action of the output channel.

    Args:
        channel: The output channel. The first output channel is 1 (not 0).
        action: The Multi-On action.
    """
    self._write_and_check(f"ONACTION{channel} {action}")

set_multi_on_delay

set_multi_on_delay(channel: int, delay: int) -> None

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

Parameters:

Name	Type	Description	Default
channel	int	The output channel. The first output channel is 1 (not 0).	required
delay	int	The turn-on delay (in milliseconds).	required

Source code in packages/resources/src/msl/equipment_resources/aim_tti/mx_series.py

def set_multi_on_delay(self, channel: int, delay: int) -> None:
    """Set the Multi-On delay, in milliseconds, of the output channel.

    Args:
        channel: The output channel. The first output channel is 1 (not 0).
        delay: The turn-on delay (in milliseconds).
    """
    self._write_and_check(f"ONDELAY{channel} {delay}")

set_over_current_protection

set_over_current_protection(
    channel: int, *, enable: bool, value: float | None = None
) -> None

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

Parameters:

Name	Type	Description	Default
channel	int	The output channel. The first output channel is 1 (not 0).	required
enable	bool	Whether to enable or disable the over-current protection trip point.	required
value	float | None	If the trip point is enabled then you must specify a value (in Amps).	None

Source code in packages/resources/src/msl/equipment_resources/aim_tti/mx_series.py

def set_over_current_protection(self, channel: int, *, enable: bool, value: float | None = None) -> None:
    """Set the over-current protection trip point of the output channel.

    Args:
        channel: The output channel. The first output channel is 1 (not 0).
        enable: Whether to enable or disable the over-current protection trip point.
        value: If the trip point is enabled then you must specify a value (in Amps).
    """
    if enable:
        if value is None:
            msg = "Must specify the trip point value if the trip point is enabled"
            raise ValueError(msg)
        command = f"OCP{channel} ON;OCP{channel} {value}"
    else:
        command = f"OCP{channel} OFF"
    self._write_and_check(command)

set_over_voltage_protection

set_over_voltage_protection(
    channel: int, *, enable: bool, value: float | None = None
) -> None

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

Parameters:

Name	Type	Description	Default
channel	int	The output channel. The first output channel is 1 (not 0).	required
enable	bool	Whether to enable or disable the over-voltage protection trip point.	required
value	float | None	If the trip point is enabled then you must specify a value (in Volts).	None

Source code in packages/resources/src/msl/equipment_resources/aim_tti/mx_series.py

def set_over_voltage_protection(self, channel: int, *, enable: bool, value: float | None = None) -> None:
    """Set the over-voltage protection trip point of the output channel.

    Args:
        channel: The output channel. The first output channel is 1 (not 0).
        enable: Whether to enable or disable the over-voltage protection trip point.
        value: If the trip point is enabled then you must specify a value (in Volts).
    """
    if enable:
        if value is None:
            msg = "Must specify the trip point value if the trip point is enabled"
            raise ValueError(msg)
        command = f"OVP{channel} ON;OVP{channel} {value}"
    else:
        command = f"OVP{channel} OFF"
    self._write_and_check(command)

set_voltage

set_voltage(channel: int, value: float, *, verify: bool = True) -> None

Set the output voltage of the output channel.

Parameters:

Name	Type	Description	Default
channel	int	The output channel. The first output channel is 1 (not 0).	required
value	float	The value (in Volts).	required
verify	bool	Whether to verify that the output voltage has stabilized at value before returning to the calling program.	True

Source code in packages/resources/src/msl/equipment_resources/aim_tti/mx_series.py

def set_voltage(self, channel: int, value: float, *, verify: bool = True) -> None:
    """Set the output voltage of the output channel.

    Args:
        channel: The output channel. The first output channel is 1 (not 0).
        value: The value (in Volts).
        verify: Whether to verify that the output voltage has stabilized at `value`
            before returning to the calling program.
    """
    command = f"V{channel}V {value}" if verify else f"V{channel} {value}"
    self._write_and_check(command)

set_voltage_range

set_voltage_range(channel: int, index: int) -> None

Set the output voltage range of the output channel.

Parameters:

Name	Type	Description	Default
channel	int	The output channel. The first output channel is 1 (not 0).	required
index	int	The output voltage range index. See the manual for more details. For example, 2 → 35V/3A.	required

Source code in packages/resources/src/msl/equipment_resources/aim_tti/mx_series.py

def set_voltage_range(self, channel: int, index: int) -> None:
    """Set the output voltage range of the output channel.

    Args:
        channel: The output channel. The first output channel is 1 (not 0).
        index: The output voltage range index. See the manual for more details.
            For example, 2 → 35V/3A.
    """
    self._write_and_check(f"VRANGE{channel} {index}")

set_voltage_step_size

set_voltage_step_size(channel: int, size: float) -> None

Set the voltage step size of the output channel.

Parameters:

Name	Type	Description	Default
channel	int	The output channel. The first output channel is 1 (not 0).	required
size	float	The voltage step size (in Volts).	required

Source code in packages/resources/src/msl/equipment_resources/aim_tti/mx_series.py

def set_voltage_step_size(self, channel: int, size: float) -> None:
    """Set the voltage step size of the output channel.

    Args:
        channel: The output channel. The first output channel is 1 (not 0).
        size: The voltage step size (in Volts).
    """
    self._write_and_check(f"DELTAV{channel} {size}")

set_voltage_tracking_mode

set_voltage_tracking_mode(mode: int) -> None

Set the voltage tracking mode of the unit.

Parameters:

Name	Type	Description	Default
mode	int	The voltage tracking mode. See the manual for more details.	required

Source code in packages/resources/src/msl/equipment_resources/aim_tti/mx_series.py

def set_voltage_tracking_mode(self, mode: int) -> None:
    """Set the voltage tracking mode of the unit.

    Args:
        mode: The voltage tracking mode. See the manual for more details.
    """
    self._write_and_check(f"CONFIG {mode}")

turn_off

turn_off(channel: int) -> None

Turn the output channel off.

Parameters:

Name	Type	Description	Default
channel	int	The output channel. The first output channel is 1 (not 0).	required

Source code in packages/resources/src/msl/equipment_resources/aim_tti/mx_series.py

def turn_off(self, channel: int) -> None:
    """Turn the output channel off.

    Args:
        channel: The output channel. The first output channel is 1 (not 0).
    """
    self._write_and_check(f"OP{channel} 0")

turn_off_multi

turn_off_multi(options: dict[int, bool | int] | None = None) -> None

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

Parameters:

Name	Type	Description	Default
options	dict[int, bool | int] | None	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} → channel 1 does not turn off {2: 100} → channel 2 has a 100-ms delay {1: 100, 3: True} → channel 1 has a 100-ms delay and channel 3 turns off immediately {1: 100, 2: 200, 3: 300} → channel 1 has a 100-ms delay, channel 2 has a 200-ms delay and channel 3 has a 300-ms delay	None

Source code in packages/resources/src/msl/equipment_resources/aim_tti/mx_series.py

def turn_off_multi(self, options: dict[int, bool | int] | None = None) -> None:
    """Turn multiple output channels off (the Multi-Off feature).

    Args:
        options: 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}` → channel 1 does not turn off
            * `{2: 100}` → channel 2 has a 100-ms delay
            * `{1: 100, 3: True}` → channel 1 has a 100-ms delay and channel 3 turns off immediately
            * `{1: 100, 2: 200, 3: 300}` → channel 1 has a 100-ms delay, channel 2 has a 200-ms delay
                and channel 3 has a 300-ms delay
    """
    if options:
        for channel, value in options.items():
            if isinstance(value, bool):
                self.set_multi_off_action(channel, "QUICK" if value else "NEVER")
            else:
                self.set_multi_off_action(channel, "DELAY")
                self.set_multi_off_delay(channel, value)
                time.sleep(0.1)  # otherwise the power supply may not set the delay properly
    self._write_and_check("OPALL 0")

turn_on

turn_on(channel: int) -> None

Turn the output channel on.

Parameters:

Name	Type	Description	Default
channel	int	The output channel. The first output channel is 1 (not 0).	required

Source code in packages/resources/src/msl/equipment_resources/aim_tti/mx_series.py

def turn_on(self, channel: int) -> None:
    """Turn the output channel on.

    Args:
        channel: The output channel. The first output channel is 1 (not 0).
    """
    self._write_and_check(f"OP{channel} 1")

turn_on_multi

turn_on_multi(options: dict[int, bool | int] | None = None) -> None

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

Parameters:

Name	Type	Description	Default
options	dict[int, bool | int] | None	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} → channel 1 does not turn on {2: 100} → channel 2 has a 100-ms delay {1: 100, 3: True} → channel 1 has a 100-ms delay and channel 3 turns on immediately {1: 100, 2: 200, 3: 300} → channel 1 has a 100-ms delay, channel 2 has a 200-ms delay and channel 3 has a 300-ms delay	None

Source code in packages/resources/src/msl/equipment_resources/aim_tti/mx_series.py

def turn_on_multi(self, options: dict[int, bool | int] | None = None) -> None:
    """Turn multiple output channels on (the Multi-On feature).

    Args:
        options: 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}` → channel 1 does not turn on
            * `{2: 100}` → channel 2 has a 100-ms delay
            * `{1: 100, 3: True}` → channel 1 has a 100-ms delay and channel 3 turns on immediately
            * `{1: 100, 2: 200, 3: 300}` → channel 1 has a 100-ms delay, channel 2 has a 200-ms delay
                and channel 3 has a 300-ms delay
    """
    if options:
        for channel, value in options.items():
            if isinstance(value, bool):
                self.set_multi_on_action(channel, "QUICK" if value else "NEVER")
            else:
                self.set_multi_on_action(channel, "DELAY")
                self.set_multi_on_delay(channel, value)
                time.sleep(0.1)  # otherwise the power supply may not set the delay properly
    self._write_and_check("OPALL 1")