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 PolarityCls:
"""
| Commands in total: 1
| Subgroups: 0
| Direct child commands: 1
"""
def __init__(self, core: Core, parent):
self._core = core
self._cmd_group = CommandsGroup("polarity", core, parent)
[docs]
def set(self, ws_polarity: enums.BusDataSignalPolarity, bus=repcap.Bus.Default) -> None:
"""
``BUS<*>:I2S:WSELect:POLarity`` \n
Snippet: ``driver.bus.i2S.wselect.polarity.set(ws_polarity = enums.BusDataSignalPolarity.INVert, bus = repcap.Bus.Default)`` \n
For a word select line, the polarity defines the signal values assigned to the left and right channels. For an FSYNC line
(TDM) , the polarity defines the edge of the FSYNC pulse that identifies the beginning of a frame.
:param ws_polarity: NORMal: 0 = left, 1 = right channel; or rising edge for TDM INVert: 1= left, 0 = right channel; or falling edge for TDM
:param bus: optional repeated capability selector. Default value: Nr1 (settable in the interface 'Bus')
"""
param = Conversions.enum_scalar_to_str(ws_polarity, enums.BusDataSignalPolarity)
bus_cmd_val = self._cmd_group.get_repcap_cmd_value(bus, repcap.Bus)
self._core.io.write(f'BUS{bus_cmd_val}:I2S:WSELect:POLarity {param}')
# noinspection PyTypeChecker
[docs]
def get(self, bus=repcap.Bus.Default) -> enums.BusDataSignalPolarity:
"""
``BUS<*>:I2S:WSELect:POLarity`` \n
Snippet: ``value: enums.BusDataSignalPolarity = driver.bus.i2S.wselect.polarity.get(bus = repcap.Bus.Default)`` \n
For a word select line, the polarity defines the signal values assigned to the left and right channels. For an FSYNC line
(TDM) , the polarity defines the edge of the FSYNC pulse that identifies the beginning of a frame.
:param bus: optional repeated capability selector. Default value: Nr1 (settable in the interface 'Bus')
:return: ws_polarity: NORMal: 0 = left, 1 = right channel; or rising edge for TDM INVert: 1= left, 0 = right channel; or falling edge for TDM
"""
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:WSELect:POLarity?')
return Conversions.str_to_scalar_enum(response, enums.BusDataSignalPolarity)