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 CsignalCls:
"""
| Commands in total: 1
| Subgroups: 0
| Direct child commands: 1
"""
def __init__(self, core: Core, parent):
self._core = core
self._cmd_group = CommandsGroup("csignal", core, parent)
# noinspection PyTypeChecker
[docs]
def get(self, channelNull=repcap.ChannelNull.Default, stepNull=repcap.StepNull.Default) -> enums.BtoCsCompanionSignal:
"""
``[SOURce<HW>]:BB:BTOoth:CS:[SEVent<CH0>]:[STEP<ST0>]:CSIGnal`` \n
Snippet: ``value: enums.BtoCsCompanionSignal = driver.source.bb.btooth.cs.sevent.step.csignal.get(channelNull = repcap.ChannelNull.Default, stepNull = repcap.StepNull.Default)`` \n
Sets the companion signal.
:param channelNull: optional repeated capability selector. Default value: Nr0 (settable in the interface 'Sevent')
:param stepNull: optional repeated capability selector. Default value: Nr0 (settable in the interface 'Step')
:return: companion_signal: NONE | P2 | M2 | P4 | M4 | M2P2 | M4P4 NONE Companion signal is disabled. P2 | P4 Positive companion signal with values 2 or 4. M2 | M4 Negative companion signal with values -2 or -4. M2P2 | M4P4 Positive and negative companion signal with values -2 and 2 or -4 and 4.
"""
channelNull_cmd_val = self._cmd_group.get_repcap_cmd_value(channelNull, repcap.ChannelNull)
stepNull_cmd_val = self._cmd_group.get_repcap_cmd_value(stepNull, repcap.StepNull)
response = self._core.io.query_str(f'SOURce<HwInstance>:BB:BTOoth:CS:SEVent{channelNull_cmd_val}:STEP{stepNull_cmd_val}:CSIGnal?')
return Conversions.str_to_scalar_enum(response, enums.BtoCsCompanionSignal)