from ......Internal.Core import Core
from ......Internal.CommandsGroup import CommandsGroup
from ......Internal import Conversions
from ......Internal.Utilities import trim_str_response
from ...... import repcap
# noinspection PyPep8Naming,PyAttributeOutsideInit,SpellCheckingInspection
class Id2FieldCls:
"""
| Commands in total: 1
| Subgroups: 0
| Direct child commands: 1
"""
def __init__(self, core: Core, parent):
self._core = core
self._cmd_group = CommandsGroup("id2Field", core, parent)
[docs]
def set(self, id_2_field: str, serialBus=repcap.SerialBus.Default, frame=repcap.Frame.Default) -> None:
"""
``SBUS<*>:SWIRe:FORMat:FRAMe<*>:ID2Field`` \n
Snippet: ``driver.sbus.swire.formatPy.frame.id2Field.set(id_2_field = 'abc', serialBus = repcap.SerialBus.Default, frame = repcap.Frame.Default)`` \n
Sets the identifying field type for the configured frame type.
:param serialBus: optional repeated capability selector. Default value: Nr1 (settable in the interface 'Sbus')
:param frame: optional repeated capability selector. Default value: Ix1 (settable in the interface 'Frame')
"""
param = Conversions.value_to_quoted_str(id_2_field)
serialBus_cmd_val = self._cmd_group.get_repcap_cmd_value(serialBus, repcap.SerialBus)
frame_cmd_val = self._cmd_group.get_repcap_cmd_value(frame, repcap.Frame)
self._core.io.write(f'SBUS{serialBus_cmd_val}:SWIRe:FORMat:FRAMe{frame_cmd_val}:ID2Field {param}')
[docs]
def get(self, serialBus=repcap.SerialBus.Default, frame=repcap.Frame.Default) -> str:
"""
``SBUS<*>:SWIRe:FORMat:FRAMe<*>:ID2Field`` \n
Snippet: ``value: str = driver.sbus.swire.formatPy.frame.id2Field.get(serialBus = repcap.SerialBus.Default, frame = repcap.Frame.Default)`` \n
Sets the identifying field type for the configured frame type.
:param serialBus: optional repeated capability selector. Default value: Nr1 (settable in the interface 'Sbus')
:param frame: optional repeated capability selector. Default value: Ix1 (settable in the interface 'Frame')
"""
serialBus_cmd_val = self._cmd_group.get_repcap_cmd_value(serialBus, repcap.SerialBus)
frame_cmd_val = self._cmd_group.get_repcap_cmd_value(frame, repcap.Frame)
response = self._core.io.query_str(f'SBUS{serialBus_cmd_val}:SWIRe:FORMat:FRAMe{frame_cmd_val}:ID2Field?')
return trim_str_response(response)