Source code for rsrtx.Implementations.Bus.I3C.Frame.Ack

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 AckCls:
	"""
	| Commands in total: 1
	| Subgroups: 0
	| Direct child commands: 1
	"""

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

	# noinspection PyTypeChecker
[docs] def get(self, bus=repcap.Bus.Default, busFrameNull=repcap.BusFrameNull.Default) -> enums.BusI2cAckBit: """ ``BUS<*>:I3C:FRAMe<*>:ACK`` \n Snippet: ``value: enums.BusI2cAckBit = driver.bus.i3C.frame.ack.get(bus = repcap.Bus.Default, busFrameNull = repcap.BusFrameNull.Default)`` \n Returns the value of the acknowledge bit for the selected frame. Because this ACK bit is transmitted right after the address field, it acknowledges receiving the address. :param bus: optional repeated capability selector. Default value: Nr1 (settable in the interface 'Bus') :param busFrameNull: optional repeated capability selector. Default value: Nr0 (settable in the interface 'Frame') :return: address_ack_bit: INComplete | ACK | NACK | EITHer """ bus_cmd_val = self._cmd_group.get_repcap_cmd_value(bus, repcap.Bus) busFrameNull_cmd_val = self._cmd_group.get_repcap_cmd_value(busFrameNull, repcap.BusFrameNull) response = self._core.io.query_str(f'BUS{bus_cmd_val}:I3C:FRAMe{busFrameNull_cmd_val}:ACK?') return Conversions.str_to_scalar_enum(response, enums.BusI2cAckBit)