from typing import List
from ...Internal.Core import Core
from ...Internal.CommandsGroup import CommandsGroup
from ...Internal import Conversions
# noinspection PyPep8Naming,PyAttributeOutsideInit,SpellCheckingInspection
[docs]class Frame:
"""Frame commands group definition. 11 total commands, 3 Sub-groups, 5 group commands"""
def __init__(self, core: Core, parent):
self._core = core
self._base = CommandsGroup("frame", core, parent)
@property
def define(self):
"""define commands group. 0 Sub-classes, 1 commands."""
if not hasattr(self, '_define'):
from .Frame_.Define import Define
self._define = Define(self._core, self._base)
return self._define
@property
def insert(self):
"""insert commands group. 0 Sub-classes, 1 commands."""
if not hasattr(self, '_insert'):
from .Frame_.Insert import Insert
self._insert = Insert(self._core, self._base)
return self._insert
@property
def importPy(self):
"""importPy commands group. 1 Sub-classes, 3 commands."""
if not hasattr(self, '_importPy'):
from .Frame_.ImportPy import ImportPy
self._importPy = ImportPy(self._core, self._base)
return self._importPy
[docs] def get_catalog(self) -> List[str]:
"""SCPI: CONFigure:FRAMe:CATalog \n
Snippet: value: List[str] = driver.configure.frame.get_catalog() \n
Returns a comma-separated configuration list of all 'frames' (switch units in single state or in an interconnection
setup) that are stored in the primary switch unit's volatile memory. Use the command method RsOsp.Configure.Frame.export
to save the configuration list to the switch unit's compact flash memory. The configuration is also saved automatically
to the flash memory during the shutdown procedure and loaded at startup into the volatile memory. \n
:return: frame_info_list: The information on each frame comprises the following information: Fxx|Address|Status|TransmittedHostname. In detail:
- Fxx: Frame ID, where F01 is the primary switch unit, F02 is the 1st secondary switch unit, F03 is the 2nd secondary switch unit, and so on.
- Address: IP address or configured hostname, as specified by CONF:FRAM:DEF or in the user interface ('WebGUI') at 'Configuration' 'Interconnection' 'Edit Secondary' 'Address:'No address is defined for the primary switch unit (F01) . For the primary switch unit, the query returns an empty field in the response string.For primary and secondary switch units that are in 'Virtual Mode', the query returns Not available (virtual frame) in this field.
- Status: For example, Single, Primary, or in the secondary switch units: Connected, Broken (secondary switch unit not available) , Refused (when trying to configure another primary switch unit as a secondary switch unit) .
- TransmittedHostname: Hostname, if available, or Not available (virtual frame) .If no address or hostname is defined for an existing frame, for example due to an incomplete definition in the user interface ('WebGUI') , the query returns an empty field.For example, the response can be 'F02||Invalid address|'."""
response = self._core.io.query_str('CONFigure:FRAMe:CATalog?')
return Conversions.str_to_str_list(response, clear_one_empty_item=True)
[docs] def set_add(self, configured_address: str) -> None:
"""SCPI: CONFigure:FRAMe:ADD \n
Snippet: driver.configure.frame.set_add(configured_address = '1') \n
Adds an entry for a secondary switch unit at the end of the list of frame IDs in the switch unit’s internal volatile
memory. The command assigns the next available frame ID to the new secondary switch unit. \n
:param configured_address: Specifies the IP address or the hostname of the secondary switch unit that you want to add.
"""
param = Conversions.value_to_quoted_str(configured_address)
self._core.io.write(f'CONFigure:FRAMe:ADD {param}')
[docs] def delete(self, frame_id: str) -> None:
"""SCPI: CONFigure:FRAMe:DELete \n
Snippet: driver.configure.frame.delete(frame_id = r1) \n
Deletes the definition of a selected secondary switch unit from the primary switch unit’s internal volatile memory. Use
the command method RsOsp.Configure.Frame.catalog to query the existing secondary switch unit definitions. When you delete
a secondary switch unit from an existing list of secondary devices, all following frame IDs of secondary switch units
listed after the deleted device are automatically renumbered (decremented by 1) . For example, if you delete a secondary
switch unit with frame ID F03, the next remaining secondary device F04 becomes secondary device F03, the next remaining
secondary device F05 becomes secondary device F04, etc. Note that the deletion of a secondary switch unit can impact your
path definitions, even if the deleted frame was not used for any path definitions. For example, consider a setup with 4
secondary devices (F02 to F05) . If you delete the 2nd secondary device (F03) , a path that includes modules in the
previous 3rd secondary device (F04) now addresses the new 3rd secondary device, which previously was the 4th secondary
device (F05) . This change can destroy the functionality of your path definitions - or it can be intentional. \n
:param frame_id: Selects the frame ID Fxx of the secondary switch unit you wish to delete, starting with F02 (note that the 1st secondary switch unit is the 2nd frame) . Use the frame ID without quotation marks.
"""
param = Conversions.value_to_str(frame_id)
self._core.io.write(f'CONFigure:FRAMe:DELete {param}')
[docs] def delete_all(self) -> None:
"""SCPI: CONFigure:FRAMe:DELete:ALL \n
Snippet: driver.configure.frame.delete_all() \n
Deletes all currently defined secondary switch units from the primary switch unit’s internal volatile memory. Before you
delete all secondary switch unit definitions, we recommend using the command method RsOsp.Configure.Frame.catalog to
query all currently defined secondary switch units. \n
"""
self._core.io.write(f'CONFigure:FRAMe:DELete:ALL')
[docs] def delete_all_with_opc(self) -> None:
"""SCPI: CONFigure:FRAMe:DELete:ALL \n
Snippet: driver.configure.frame.delete_all_with_opc() \n
Deletes all currently defined secondary switch units from the primary switch unit’s internal volatile memory. Before you
delete all secondary switch unit definitions, we recommend using the command method RsOsp.Configure.Frame.catalog to
query all currently defined secondary switch units. \n
Same as delete_all, but waits for the operation to complete before continuing further. Use the RsOsp.utilities.opc_timeout_set() to set the timeout value. \n
"""
self._core.io.write_with_opc(f'CONFigure:FRAMe:DELete:ALL')
[docs] def export(self, slave_config_file: str) -> None:
"""SCPI: CONFigure:FRAMe:EXPort \n
Snippet: driver.configure.frame.export(slave_config_file = '1') \n
Stores the currently defined secondary devices configuration as a nonvolatile file in the compact flash memory of your
primary switch unit. For configuring secondary switch units, see method RsOsp.Configure.Frame.Define.set. All secondary
switch unit configuration filenames have the extension '.iconn'. Do not enter the extension when specifying a filename. A
filename query does not return the extension. For example, when you save the interconnection configuration file
'subunit1', it is saved as 'subunit1.iconn'. A query returns this filename as 'subunit1', only. \n
:param slave_config_file: String parameter to specify the name of the file to be stored.
"""
param = Conversions.value_to_quoted_str(slave_config_file)
self._core.io.write(f'CONFigure:FRAMe:EXPort {param}')