Source code for rsrtx.Implementations.Bus.I2S.Wlength

from ....Internal.Core import Core
from ....Internal.CommandsGroup import CommandsGroup
from ....Internal import Conversions
from .... import repcap


# noinspection PyPep8Naming,PyAttributeOutsideInit,SpellCheckingInspection
class WlengthCls:
	"""
	| Commands in total: 1
	| Subgroups: 0
	| Direct child commands: 1
	"""

	def __init__(self, core: Core, parent):
		self._core = core
		self._cmd_group = CommandsGroup("wlength", core, parent)

[docs] def set(self, word_length: int, bus=repcap.Bus.Default) -> None: """ ``BUS<*>:I2S:WLENgth`` \n Snippet: ``driver.bus.i2S.wlength.set(word_length = 1, bus = repcap.Bus.Default)`` \n Defines the number of bits in an audio data word. :param word_length: 4 to 32 :param bus: optional repeated capability selector. Default value: Nr1 (settable in the interface 'Bus') """ param = Conversions.decimal_value_to_str(word_length) bus_cmd_val = self._cmd_group.get_repcap_cmd_value(bus, repcap.Bus) self._core.io.write(f'BUS{bus_cmd_val}:I2S:WLENgth {param}')
[docs] def get(self, bus=repcap.Bus.Default) -> int: """ ``BUS<*>:I2S:WLENgth`` \n Snippet: ``value: int = driver.bus.i2S.wlength.get(bus = repcap.Bus.Default)`` \n Defines the number of bits in an audio data word. :param bus: optional repeated capability selector. Default value: Nr1 (settable in the interface 'Bus') :return: word_length: 4 to 32 """ 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:WLENgth?') return Conversions.str_to_int(response)