from .....Internal.Core import Core
from .....Internal.CommandsGroup import CommandsGroup
from .....Internal import Conversions
from ..... import enums
from ..... import repcap
# noinspection PyPep8Naming,PyAttributeOutsideInit,SpellCheckingInspection
class OrderCls:
"""
| Commands in total: 1
| Subgroups: 0
| Direct child commands: 1
"""
def __init__(self, core: Core, parent):
self._core = core
self._cmd_group = CommandsGroup("order", core, parent)
[docs]
def set(self, channel_order: enums.BusChannelOrder, bus=repcap.Bus.Default) -> None:
"""
``BUS<*>:I2S:CHANnel:ORDer`` \n
Snippet: ``driver.bus.i2S.channel.order.set(channel_order = enums.BusChannelOrder.LFIRst, bus = repcap.Bus.Default)`` \n
Defines if the left or the right channel is the first channel in the frame. The setting is not available for TDM audio
signals.
:param channel_order: Left channel first or right first
:param bus: optional repeated capability selector. Default value: Nr1 (settable in the interface 'Bus')
"""
param = Conversions.enum_scalar_to_str(channel_order, enums.BusChannelOrder)
bus_cmd_val = self._cmd_group.get_repcap_cmd_value(bus, repcap.Bus)
self._core.io.write(f'BUS{bus_cmd_val}:I2S:CHANnel:ORDer {param}')
# noinspection PyTypeChecker
[docs]
def get(self, bus=repcap.Bus.Default) -> enums.BusChannelOrder:
"""
``BUS<*>:I2S:CHANnel:ORDer`` \n
Snippet: ``value: enums.BusChannelOrder = driver.bus.i2S.channel.order.get(bus = repcap.Bus.Default)`` \n
Defines if the left or the right channel is the first channel in the frame. The setting is not available for TDM audio
signals.
:param bus: optional repeated capability selector. Default value: Nr1 (settable in the interface 'Bus')
:return: channel_order: Left channel first or right first
"""
bus_cmd_val = self._cmd_group.get_repcap_cmd_value(bus, repcap.Bus)
response = self._core.io.query_str(f'BUS{bus_cmd_val}:I2S:CHANnel:ORDer?')
return Conversions.str_to_scalar_enum(response, enums.BusChannelOrder)