Source code for rsmxo.Implementations.Sbus.Manch.FormatPy.Clr

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


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

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

[docs] def set(self, serialBus=repcap.SerialBus.Default) -> None: """ ``SBUS<*>:MANCh:FORMat:CLR`` \n Snippet: ``driver.sbus.manch.formatPy.clr.set(serialBus = repcap.SerialBus.Default)`` \n Erases from the volatile memory all field and frame format descriptions that you have created for a specific custom protocol. :param serialBus: optional repeated capability selector. Default value: Nr1 (settable in the interface 'Sbus') """ serialBus_cmd_val = self._cmd_group.get_repcap_cmd_value(serialBus, repcap.SerialBus) self._core.io.write(f'SBUS{serialBus_cmd_val}:MANCh:FORMat:CLR')
[docs] def set_and_wait(self, serialBus=repcap.SerialBus.Default, opc_timeout_ms: int = -1) -> None: serialBus_cmd_val = self._cmd_group.get_repcap_cmd_value(serialBus, repcap.SerialBus) """ ``SBUS<*>:MANCh:FORMat:CLR`` \n Snippet: ``driver.sbus.manch.formatPy.clr.set_and_wait(serialBus = repcap.SerialBus.Default)`` \n Erases from the volatile memory all field and frame format descriptions that you have created for a specific custom protocol. Same as set, but waits for the operation to complete before continuing further. Use the RsMxo.utilities.opc_timeout_set() to set the timeout value. :param serialBus: optional repeated capability selector. Default value: Nr1 (settable in the interface 'Sbus') :param opc_timeout_ms: Maximum time to wait in milliseconds, valid only for this call. """ self._core.io.write_with_opc(f'SBUS{serialBus_cmd_val}:MANCh:FORMat:CLR', opc_timeout_ms)