[python source code]

channel_control_mixin

A mixin class that provides access to methods for controlling channels on a device.

ChannelControlMixin

Bases: ABC

flowchart LR tm_devices.driver_mixins.abstract_device_functionality.channel_control_mixin.ChannelControlMixin[ChannelControlMixin] click tm_devices.driver_mixins.abstract_device_functionality.channel_control_mixin.ChannelControlMixin href "" "tm_devices.driver_mixins.abstract_device_functionality.channel_control_mixin.ChannelControlMixin"

A mixin class which adds methods and properties for controlling channels on a device.

all_channel_names_list abstractmethod property 

all_channel_names_list: tuple[str, ...]

Return a tuple containing all the channel names.

total_channels abstractmethod cached property 

total_channels: int

Return the total number of channels (all types).

turn_all_channels_off 

turn_all_channels_off() -> None

Turn all channels off.

turn_all_channels_on 

turn_all_channels_on() -> None

Turn all channels on.

turn_channel_off abstractmethod 

turn_channel_off(channel_str: str) -> None

Turn off the specified channel.

Parameters:
  • channel_str (str) –

    The name of the channel to turn off.

turn_channel_on abstractmethod 

turn_channel_on(channel_str: str) -> None

Turn on the specified channel.

Parameters:
  • channel_str (str) –

    The name of the channel to turn on.