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 RstoCls:
"""
| Commands in total: 1
| Subgroups: 0
| Direct child commands: 1
"""
def __init__(self, core: Core, parent):
self._core = core
self._cmd_group = CommandsGroup("rsto", core, parent)
[docs]
def set(self, settings: enums.ZvcOverloadReset, zvcProbe=repcap.ZvcProbe.Default, zvcChannel=repcap.ZvcChannel.Default) -> None:
"""
``ZVC:Z<*>:I<*>:OVERload:RSTO`` \n
Snippet: ``driver.zvc.z.icurrent.overload.rsto.set(settings = enums.ZvcOverloadReset.ADJusted, zvcProbe = repcap.ZvcProbe.Default, zvcChannel = repcap.ZvcChannel.Default)`` \n
Resets the overload indication at the probe. In internal shunt mode (method ``RsRtx.zvc.z.icurrent.shunt.mode.set()`` is
set to INTShunt) , chooses whether to keep the operation range adjusted by the R&S RT-ZVC during overload or to restore
the original settings for the given current channel. In external shunt mode (method
``RsRtx.zvc.z.icurrent.shunt.mode.set()`` is set to EXTShunt) , there is no adjustment of the operation range during
overload.
:param settings: ADJusted | ORIGinal \n
- ADJusted: The operation range that is automatically adjusted by the probe during overload is kept.In internal shunt mode, during an overload at a current channel, the probe switches automatically to the next higher range. If the 10A range is also exceeded, the amperemeter switches to external shunt mode to protect the probe against permanent damage.
- ORIGinal: The original operation range is restored as before the overload and the adjustment of the operation range.
:param zvcProbe: optional repeated capability selector. Default value: Ix1 (settable in the interface 'Z')
:param zvcChannel: optional repeated capability selector. Default value: Nr1 (settable in the interface 'Icurrent')
"""
param = Conversions.enum_scalar_to_str(settings, enums.ZvcOverloadReset)
zvcProbe_cmd_val = self._cmd_group.get_repcap_cmd_value(zvcProbe, repcap.ZvcProbe)
zvcChannel_cmd_val = self._cmd_group.get_repcap_cmd_value(zvcChannel, repcap.ZvcChannel)
self._core.io.write_with_opc(f'ZVC:Z{zvcProbe_cmd_val}:I{zvcChannel_cmd_val}:OVERload:RSTO {param}')