from ....Internal.Core import Core
from ....Internal.CommandsGroup import CommandsGroup
from ....Internal import Conversions
from ....Internal.Types import DataType
from ....Internal.Utilities import trim_str_response
from ....Internal.StructBase import StructBase
from ....Internal.ArgStruct import ArgStruct
from ....Internal.ArgSingleList import ArgSingleList
from ....Internal.ArgSingle import ArgSingle
from .... import enums
# noinspection PyPep8Naming,PyAttributeOutsideInit,SpellCheckingInspection
[docs]
class TimeCls:
"""Time commands group definition. 12 total commands, 4 Subgroups, 3 group commands"""
def __init__(self, core: Core, parent):
self._core = core
self._cmd_group = CommandsGroup("time", core, parent)
@property
def daylightSavingTime(self):
"""daylightSavingTime commands group. 1 Sub-classes, 1 commands."""
if not hasattr(self, '_daylightSavingTime'):
from .DaylightSavingTime import DaylightSavingTimeCls
self._daylightSavingTime = DaylightSavingTimeCls(self._core, self._cmd_group)
return self._daylightSavingTime
@property
def local(self):
"""local commands group. 0 Sub-classes, 1 commands."""
if not hasattr(self, '_local'):
from .Local import LocalCls
self._local = LocalCls(self._core, self._cmd_group)
return self._local
@property
def utc(self):
"""utc commands group. 0 Sub-classes, 1 commands."""
if not hasattr(self, '_utc'):
from .Utc import UtcCls
self._utc = UtcCls(self._core, self._cmd_group)
return self._utc
@property
def hrTimer(self):
"""hrTimer commands group. 1 Sub-classes, 1 commands."""
if not hasattr(self, '_hrTimer'):
from .HrTimer import HrTimerCls
self._hrTimer = HrTimerCls(self._core, self._cmd_group)
return self._hrTimer
[docs]
def set(self, hour: int, min_py: int, sec: int) -> None:
"""SCPI: SYSTem:TIME \n
Snippet: driver.system.time.set(hour = 1, min_py = 1, sec = 1) \n
No command help available \n
:param hour: No help available
:param min_py: No help available
:param sec: No help available
"""
param = ArgSingleList().compose_cmd_string(ArgSingle('hour', hour, DataType.Integer), ArgSingle('min_py', min_py, DataType.Integer), ArgSingle('sec', sec, DataType.Integer))
self._core.io.write(f'SYSTem:TIME {param}'.rstrip())
# noinspection PyTypeChecker
[docs]
class TimeStruct(StructBase):
"""Response structure. Fields: \n
- Hour: int: No parameter help available
- Min_Py: int: No parameter help available
- Sec: int: No parameter help available"""
__meta_args_list = [
ArgStruct.scalar_int('Hour'),
ArgStruct.scalar_int('Min_Py'),
ArgStruct.scalar_int('Sec')]
def __init__(self):
StructBase.__init__(self, self)
self.Hour: int = None
self.Min_Py: int = None
self.Sec: int = None
[docs]
def get(self) -> TimeStruct:
"""SCPI: SYSTem:TIME \n
Snippet: value: TimeStruct = driver.system.time.get() \n
No command help available \n
:return: structure: for return value, see the help for TimeStruct structure arguments."""
return self._core.io.query_struct(f'SYSTem:TIME?', self.__class__.TimeStruct())
# noinspection PyTypeChecker
[docs]
def get_source(self) -> enums.TimeSource:
"""SCPI: SYSTem:TIME:SOURce \n
Snippet: value: enums.TimeSource = driver.system.time.get_source() \n
Selects the source for the date and time information. \n
:return: time_source:
- MANual: Manual configuration via SYSTem:DATE[:UTC] and SYSTem:TIME[:UTC].
- NTP: NTP server configured via SYSTem:TIME:NTP."""
response = self._core.io.query_str('SYSTem:TIME:SOURce?')
return Conversions.str_to_scalar_enum(response, enums.TimeSource)
[docs]
def set_source(self, time_source: enums.TimeSource) -> None:
"""SCPI: SYSTem:TIME:SOURce \n
Snippet: driver.system.time.set_source(time_source = enums.TimeSource.MANual) \n
Selects the source for the date and time information. \n
:param time_source:
- MANual: Manual configuration via SYSTem:DATE[:UTC] and SYSTem:TIME[:UTC].
- NTP: NTP server configured via SYSTem:TIME:NTP."""
param = Conversions.enum_scalar_to_str(time_source, enums.TimeSource)
self._core.io.write(f'SYSTem:TIME:SOURce {param}')
[docs]
def get_ntp(self) -> str:
"""SCPI: SYSTem:TIME:NTP \n
Snippet: value: str = driver.system.time.get_ntp() \n
Configures the NTP server address for the time source NTP, see method RsCMPX_Base.System.Time.source. \n
:return: time_server: No help available
"""
response = self._core.io.query_str('SYSTem:TIME:NTP?')
return trim_str_response(response)
[docs]
def set_ntp(self, time_server: str) -> None:
"""SCPI: SYSTem:TIME:NTP \n
Snippet: driver.system.time.set_ntp(time_server = 'abc') \n
Configures the NTP server address for the time source NTP, see method RsCMPX_Base.System.Time.source. \n
:param time_server: No help available
"""
param = Conversions.value_to_quoted_str(time_server)
self._core.io.write(f'SYSTem:TIME:NTP {param}')
def clone(self) -> 'TimeCls':
"""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 = TimeCls(self._core, self._cmd_group.parent)
self._cmd_group.synchronize_repcaps(new_group)
return new_group