from .....Internal.Core import Core
from .....Internal.CommandsGroup import CommandsGroup
from .....Internal import Conversions
from .....Internal.StructBase import StructBase
from .....Internal.ArgStruct import ArgStruct
# noinspection PyPep8Naming,PyAttributeOutsideInit,SpellCheckingInspection
[docs]
class DeviceCls:
"""Device commands group definition. 8 total commands, 3 Subgroups, 5 group commands"""
def __init__(self, core: Core, parent):
self._core = core
self._cmd_group = CommandsGroup("device", core, parent)
@property
def license(self):
"""license commands group. 0 Sub-classes, 1 commands."""
if not hasattr(self, '_license'):
from .License import LicenseCls
self._license = LicenseCls(self._core, self._cmd_group)
return self._license
@property
def setup(self):
"""setup commands group. 0 Sub-classes, 1 commands."""
if not hasattr(self, '_setup'):
from .Setup import SetupCls
self._setup = SetupCls(self._core, self._cmd_group)
return self._setup
@property
def split(self):
"""split commands group. 0 Sub-classes, 1 commands."""
if not hasattr(self, '_split'):
from .Split import SplitCls
self._split = SplitCls(self._core, self._cmd_group)
return self._split
# noinspection PyTypeChecker
[docs]
class SubinstStruct(StructBase): # From ReadStructDefinition CmdPropertyTemplate.xml
"""Structure for reading output parameters. Fields: \n
- Cur_Sub_Inst: int: Device number of the addressed channel, as indicated in a VISA resource string for HiSLIP and as returned by *DEV?. Mapping: device number 0 = channel 1 = assigned instrument 1
- Sub_Inst_Count: int: Total number of channels into which the instrument is split."""
__meta_args_list = [
ArgStruct.scalar_int('Cur_Sub_Inst'),
ArgStruct.scalar_int('Sub_Inst_Count')]
def __init__(self):
StructBase.__init__(self, self)
self.Cur_Sub_Inst: int = None
self.Sub_Inst_Count: int = None
[docs]
def get_subinst(self) -> SubinstStruct:
"""SCPI: SYSTem:BASE:DEVice:SUBinst \n
Snippet: value: SubinstStruct = driver.system.base.device.get_subinst() \n
Queries the device number of the addressed channel and the total number of existing channels. \n
:return: structure: for return value, see the help for SubinstStruct structure arguments.
"""
return self._core.io.query_struct('SYSTem:BASE:DEVice:SUBinst?', self.__class__.SubinstStruct())
[docs]
def get_count(self) -> int:
"""SCPI: SYSTem:BASE:DEVice:COUNt \n
Snippet: value: int = driver.system.base.device.get_count() \n
Splits the instrument into channels or assigns all hardware resources to a single channel. Send this command to the
channel with the lowest number (device 0 / channel 1 / assigned instrument 1) . To assign/distribute the available
hardware resources to the channels, a reboot is performed automatically after you have changed the number of channels. \n
:return: count: Number of channels The allowed subset of values depends on the number of connected RRHs.
"""
response = self._core.io.query_str('SYSTem:BASE:DEVice:COUNt?')
return Conversions.str_to_int(response)
[docs]
def set_count(self, count: int) -> None:
"""SCPI: SYSTem:BASE:DEVice:COUNt \n
Snippet: driver.system.base.device.set_count(count = 1) \n
Splits the instrument into channels or assigns all hardware resources to a single channel. Send this command to the
channel with the lowest number (device 0 / channel 1 / assigned instrument 1) . To assign/distribute the available
hardware resources to the channels, a reboot is performed automatically after you have changed the number of channels. \n
:param count: Number of channels The allowed subset of values depends on the number of connected RRHs.
"""
param = Conversions.decimal_value_to_str(count)
self._core.io.write(f'SYSTem:BASE:DEVice:COUNt {param}')
[docs]
def reset(self) -> None:
"""SCPI: SYSTem:BASE:DEVice:RESet \n
Snippet: driver.system.base.device.reset() \n
No command help available \n
"""
self._core.io.write(f'SYSTem:BASE:DEVice:RESet')
[docs]
def reset_with_opc(self, opc_timeout_ms: int = -1) -> None:
"""SCPI: SYSTem:BASE:DEVice:RESet \n
Snippet: driver.system.base.device.reset_with_opc() \n
No command help available \n
Same as reset, but waits for the operation to complete before continuing further. Use the RsCMPX_Base.utilities.opc_timeout_set() to set the timeout value. \n
:param opc_timeout_ms: Maximum time to wait in milliseconds, valid only for this call."""
self._core.io.write_with_opc(f'SYSTem:BASE:DEVice:RESet', opc_timeout_ms)
[docs]
def get_mscont(self) -> int:
"""SCPI: SYSTem:BASE:DEVice:MSCont \n
Snippet: value: int = driver.system.base.device.get_mscont() \n
No command help available \n
:return: max_si_count: No help available
"""
response = self._core.io.query_str('SYSTem:BASE:DEVice:MSCont?')
return Conversions.str_to_int(response)
[docs]
def get_msc_count(self) -> int:
"""SCPI: SYSTem:BASE:DEVice:MSCCount \n
Snippet: value: int = driver.system.base.device.get_msc_count() \n
Returns the maximum number of channels into which the instrument can be split. \n
:return: max_sc_count: The value 0 indicates that no split is possible.
"""
response = self._core.io.query_str('SYSTem:BASE:DEVice:MSCCount?')
return Conversions.str_to_int(response)
def clone(self) -> 'DeviceCls':
"""Clones the group by creating new object from it and its whole existing subgroups
Also copies all the existing default Repeated Capabilities setting,
which you can change independently without affecting the original group"""
new_group = DeviceCls(self._core, self._cmd_group.parent)
self._cmd_group.synchronize_repcaps(new_group)
return new_group