from ....Internal.Core import Core
from ....Internal.CommandsGroup import CommandsGroup
from .... import repcap
# noinspection PyPep8Naming,PyAttributeOutsideInit,SpellCheckingInspection
class AddFrameCls:
"""
| Commands in total: 1
| Subgroups: 0
| Direct child commands: 1
"""
def __init__(self, core: Core, parent):
self._core = core
self._cmd_group = CommandsGroup("addFrame", core, parent)
[docs]
def set(self, bus=repcap.Bus.Default) -> None:
"""
``BUS<*>:CMSB:ADDFrame`` \n
Snippet: ``driver.bus.cmsb.addFrame.set(bus = repcap.Bus.Default)`` \n
Creates an empty frame format description and adds it to the end of the frame description list.
:param bus: optional repeated capability selector. Default value: Nr1 (settable in the interface 'Bus')
"""
bus_cmd_val = self._cmd_group.get_repcap_cmd_value(bus, repcap.Bus)
self._core.io.write(f'BUS{bus_cmd_val}:CMSB:ADDFrame')
[docs]
def set_and_wait(self, bus=repcap.Bus.Default, opc_timeout_ms: int = -1) -> None:
bus_cmd_val = self._cmd_group.get_repcap_cmd_value(bus, repcap.Bus)
"""
``BUS<*>:CMSB:ADDFrame`` \n
Snippet: ``driver.bus.cmsb.addFrame.set_and_wait(bus = repcap.Bus.Default)`` \n
Creates an empty frame format description and adds it to the end of the frame description list.
Same as set, but waits for the operation to complete before continuing further. Use the RsRtx.utilities.opc_timeout_set() to set the timeout value.
:param bus: optional repeated capability selector. Default value: Nr1 (settable in the interface 'Bus')
:param opc_timeout_ms: Maximum time to wait in milliseconds, valid only for this call.
"""
self._core.io.write_with_opc(f'BUS{bus_cmd_val}:CMSB:ADDFrame', opc_timeout_ms)