=========================== MidTmcSubarray Tango Device =========================== Provides the monitoring and control interface required by users as well as other TM Components (such as OET, Central Node) for a Subarray. :Device Properties: DishLeafNodePrefix: Device name prefix for the Dish Leaf Node. :Device Attributes: Properties ---------- .. index:: single: AbortCommandTimeOut; MidTmcSubarray.AbortCommandTimeOut .. py:attribute:: AbortCommandTimeOut :module: MidTmcSubarray :data type: DevUShort :default value: 40 .. index:: single: CapabilityTypes; MidTmcSubarray.CapabilityTypes .. py:attribute:: CapabilityTypes :module: MidTmcSubarray :data type: DevVarStringArray .. index:: single: CommandTimeOutDefault; MidTmcSubarray.CommandTimeOutDefault .. py:attribute:: CommandTimeOutDefault :module: MidTmcSubarray :data type: DevFloat :default value: 30 .. index:: single: CspAssignResourcesInterfaceURL; MidTmcSubarray.CspAssignResourcesInterfaceURL .. py:attribute:: CspAssignResourcesInterfaceURL :module: MidTmcSubarray This property contains the interface URL of theCSP sub-system for AssignResources command :data type: DevString .. index:: single: CspScanInterfaceURL; MidTmcSubarray.CspScanInterfaceURL .. py:attribute:: CspScanInterfaceURL :module: MidTmcSubarray This property contains the interface URL of theCSP sub-system for Scan command :data type: DevString .. index:: single: CspSubarrayFQDN; MidTmcSubarray.CspSubarrayFQDN .. py:attribute:: CspSubarrayFQDN :module: MidTmcSubarray This property contains the FQDN of the CSP Subarrayassociated with the Subarray Node. :data type: DevString .. index:: single: CspSubarrayLNFQDN; MidTmcSubarray.CspSubarrayLNFQDN .. py:attribute:: CspSubarrayLNFQDN :module: MidTmcSubarray This property contains the FQDN of the CSP Subarray Leaf Nodeassociated with the Subarray Node. :data type: DevString .. index:: single: DevFamily; MidTmcSubarray.DevFamily .. py:attribute:: DevFamily :module: MidTmcSubarray :data type: DevString :default value: leaf-node .. index:: single: DishLeafNodePrefix; MidTmcSubarray.DishLeafNodePrefix .. py:attribute:: DishLeafNodePrefix :module: MidTmcSubarray Device name prefix for the Dish Leaf Node :data type: DevString .. index:: single: DishMasterFQDNs; MidTmcSubarray.DishMasterFQDNs .. py:attribute:: DishMasterFQDNs :module: MidTmcSubarray List of Dish Master devices :data type: DevVarStringArray .. index:: single: DishMasterIdentifier; MidTmcSubarray.DishMasterIdentifier .. py:attribute:: DishMasterIdentifier :module: MidTmcSubarray Device name tag for the Dish Master :data type: DevString .. index:: single: EventSubscriptionCheckPeriod; MidTmcSubarray.EventSubscriptionCheckPeriod .. py:attribute:: EventSubscriptionCheckPeriod :module: MidTmcSubarray :data type: DevFloat :default value: 1 .. index:: single: GroupDefinitions; MidTmcSubarray.GroupDefinitions .. py:attribute:: GroupDefinitions :module: MidTmcSubarray :data type: DevVarStringArray .. index:: single: JonesURI; MidTmcSubarray.JonesURI .. py:attribute:: JonesURI :module: MidTmcSubarray This property contains URI for Jones :data type: DevString .. index:: single: LivelinessCheckPeriod; MidTmcSubarray.LivelinessCheckPeriod .. py:attribute:: LivelinessCheckPeriod :module: MidTmcSubarray :data type: DevFloat :default value: 1 .. index:: single: LoggingLevelDefault; MidTmcSubarray.LoggingLevelDefault .. py:attribute:: LoggingLevelDefault :module: MidTmcSubarray :data type: DevUShort :default value: 4 .. index:: single: LoggingTargetsDefault; MidTmcSubarray.LoggingTargetsDefault .. py:attribute:: LoggingTargetsDefault :module: MidTmcSubarray :data type: DevVarStringArray :default value: ['tango::logger'] .. index:: single: ProxyTimeout; MidTmcSubarray.ProxyTimeout .. py:attribute:: ProxyTimeout :module: MidTmcSubarray :data type: DevUShort :default value: 500 .. index:: single: ScanStartTimeEnabled; MidTmcSubarray.ScanStartTimeEnabled .. py:attribute:: ScanStartTimeEnabled :module: MidTmcSubarray Flag to control start_time key injection in Scan cmd interface :data type: DevBoolean .. index:: single: SdpScanInterfaceURL; MidTmcSubarray.SdpScanInterfaceURL .. py:attribute:: SdpScanInterfaceURL :module: MidTmcSubarray This property contains the interface URL of theSDP sub-system for Scan command :data type: DevString .. index:: single: SdpSubarrayFQDN; MidTmcSubarray.SdpSubarrayFQDN .. py:attribute:: SdpSubarrayFQDN :module: MidTmcSubarray This property contains the FQDN of the SDP Subarrayassociated with the Subarray Node. :data type: DevString .. index:: single: SdpSubarrayLNFQDN; MidTmcSubarray.SdpSubarrayLNFQDN .. py:attribute:: SdpSubarrayLNFQDN :module: MidTmcSubarray This property contains the FQDN of the SDP Subarray Leaf Nodeassociated with the Subarray Node. :data type: DevString .. index:: single: SkaLevel; MidTmcSubarray.SkaLevel .. py:attribute:: SkaLevel :module: MidTmcSubarray :data type: DevShort :default value: 4 .. index:: single: SubID; MidTmcSubarray.SubID .. py:attribute:: SubID :module: MidTmcSubarray :data type: DevString .. index:: single: TelmodelPath; MidTmcSubarray.TelmodelPath .. py:attribute:: TelmodelPath :module: MidTmcSubarray Telmodel path for array layout. :data type: DevString .. index:: single: TelmodelSource; MidTmcSubarray.TelmodelSource .. py:attribute:: TelmodelSource :module: MidTmcSubarray Telmodel source for array layout. :data type: DevString Attributes ---------- .. index:: single: State; MidTmcSubarray.State .. py:attribute:: State :module: MidTmcSubarray The operational state of the device as enumeration. :access: READ :data type: DevState :data format: SCALAR .. index:: single: Status; MidTmcSubarray.Status .. py:attribute:: Status :module: MidTmcSubarray More detailed textual information about the device's status. :access: READ :data type: DevString :data format: SCALAR .. index:: single: activationTime; MidTmcSubarray.activationTime .. py:attribute:: activationTime :module: MidTmcSubarray The time of activation in seconds since Unix epoch. :access: READ :data type: DevDouble :data format: SCALAR :unit: s .. index:: single: adminMode; MidTmcSubarray.adminMode .. py:attribute:: adminMode :module: MidTmcSubarray The Admin Mode of the device. It may interpret the current device condition and condition of all managed devices to set this. Most possibly an aggregate attribute. :access: READ_WRITE :data type: DevEnum :data format: SCALAR .. index:: single: arrayLayoutUrl; MidTmcSubarray.arrayLayoutUrl .. py:attribute:: arrayLayoutUrl :module: MidTmcSubarray Get the memorized Array Layout URI. :access: READ_WRITE :data type: DevString :data format: SCALAR .. index:: single: assignedResources; MidTmcSubarray.assignedResources .. py:attribute:: assignedResources :module: MidTmcSubarray Expose a signal as a Tango attribute. :access: READ :data type: DevString :data format: SPECTRUM :max_dim_x: 1024 .. index:: single: buildState; MidTmcSubarray.buildState .. py:attribute:: buildState :module: MidTmcSubarray Read the Build State of the device. :return: the build state of the device :access: READ :data type: DevString :data format: SCALAR .. index:: single: commandTimeOut; MidTmcSubarray.commandTimeOut .. py:attribute:: commandTimeOut :module: MidTmcSubarray Command execution time limit. :access: READ_WRITE :data type: DevUShort :data format: SCALAR .. index:: single: commandedObsState; MidTmcSubarray.commandedObsState .. py:attribute:: commandedObsState :module: MidTmcSubarray The last commanded stable Observation State of the device. Initial value is EMPTY. The only stable states it can change to are EMPTY, IDLE, READY or ABORTED, following the start of any state transition command. :access: READ :data type: DevEnum :data format: SCALAR .. index:: single: commandedState; MidTmcSubarray.commandedState .. py:attribute:: commandedState :module: MidTmcSubarray The last commanded Operating State of the device. Initial string is "None". Only other strings it can change to is "OFF", "STANDBY" or "ON", following the Off(), Standby() or On() commands. If the state transition commands are long running commands the commanded state will only update when the long running command starts executing. :access: READ :data type: DevString :data format: SCALAR .. index:: single: configurationDelayExpected; MidTmcSubarray.configurationDelayExpected .. py:attribute:: configurationDelayExpected :module: MidTmcSubarray The expected configuration delay of the device in seconds. :access: READ :data type: DevUShort :data format: SCALAR :unit: seconds .. index:: single: configurationProgress; MidTmcSubarray.configurationProgress .. py:attribute:: configurationProgress :module: MidTmcSubarray The percentage configuration progress of the device. :access: READ :data type: DevUShort :data format: SCALAR :unit: % .. index:: single: configuredCapabilities; MidTmcSubarray.configuredCapabilities .. py:attribute:: configuredCapabilities :module: MidTmcSubarray The cabailities configured in the device. For example, ["Correlators:512", "PssBeams:4", "PstBeams:4", "VlbiBeams:0"]. :access: READ :data type: DevString :data format: SPECTRUM :max_dim_x: 10 .. index:: single: controlMode; MidTmcSubarray.controlMode .. py:attribute:: controlMode :module: MidTmcSubarray The control mode of the device are REMOTE, LOCAL Tango Device accepts only from a ‘local’ client and ignores commands and queries received from TM or any other ‘remote’ clients. The Local clients has to release LOCAL control before REMOTE clients can take control again. :access: READ_WRITE :data type: DevEnum :data format: SCALAR .. index:: single: healthInfo; MidTmcSubarray.healthInfo .. py:attribute:: healthInfo :module: MidTmcSubarray Expose a signal as a Tango attribute. :access: READ :data type: DevString :data format: SCALAR .. index:: single: healthState; MidTmcSubarray.healthState .. py:attribute:: healthState :module: MidTmcSubarray Read the Health State of the device. It interprets the current device condition and condition of all managed devices to set this. Most possibly an aggregate attribute. :access: READ :data type: DevEnum :data format: SCALAR .. index:: single: internalModel; MidTmcSubarray.internalModel .. py:attribute:: internalModel :module: MidTmcSubarray Json String representing the entire internal model. :access: READ :data type: DevString :data format: SCALAR .. index:: single: isAdminModeEnabled; MidTmcSubarray.isAdminModeEnabled .. py:attribute:: isAdminModeEnabled :module: MidTmcSubarray Return the isAdminModeEnabled attribute value Returns: bool: True if the admin mode is enabled, False otherwise :access: READ_WRITE :data type: DevBoolean :data format: SCALAR .. index:: single: isSubarrayAvailable; MidTmcSubarray.isSubarrayAvailable .. py:attribute:: isSubarrayAvailable :module: MidTmcSubarray Shows aggregated value for availability on subarray device :access: READ :data type: DevBoolean :data format: SCALAR .. index:: single: lastDeviceInfoChanged; MidTmcSubarray.lastDeviceInfoChanged .. py:attribute:: lastDeviceInfoChanged :module: MidTmcSubarray Json String representing the last device info changed in the internal model. :access: READ :data type: DevString :data format: SCALAR .. index:: single: loggingLevel; MidTmcSubarray.loggingLevel .. py:attribute:: loggingLevel :module: MidTmcSubarray Read the logging level of the device. Initialises to LoggingLevelDefault on startup. See :py:class:`~ska_control_model.LoggingLevel` :return: Logging level of the device. :access: READ_WRITE :data type: DevEnum :data format: SCALAR .. index:: single: loggingTargets; MidTmcSubarray.loggingTargets .. py:attribute:: loggingTargets :module: MidTmcSubarray Read the additional logging targets of the device. Note that this excludes the handlers provided by the ska_ser_logging library defaults - initialises to LoggingTargetsDefault on startup. :return: Logging level of the device. :access: READ_WRITE :data type: DevString :data format: SPECTRUM :max_dim_x: 4 .. index:: single: longRunningCommandIDsInQueue; MidTmcSubarray.longRunningCommandIDsInQueue .. py:attribute:: longRunningCommandIDsInQueue :module: MidTmcSubarray Read the IDs of the long running commands in the queue. Every client that executes a command will receive a command ID as response. Keep track of IDs currently allocated. Entries are removed `self._command_tracker._removal_time` seconds after they have finished. :access: READ :data type: DevString :data format: SPECTRUM :max_dim_x: 66 .. index:: single: longRunningCommandInProgress; MidTmcSubarray.longRunningCommandInProgress .. py:attribute:: longRunningCommandInProgress :module: MidTmcSubarray Read the name(s) of the currently executing long running command(s). Name(s) of command and possible abort in progress or empty string(s). :access: READ :data type: DevString :data format: SPECTRUM :max_dim_x: 2 .. index:: single: longRunningCommandProgress; MidTmcSubarray.longRunningCommandProgress .. py:attribute:: longRunningCommandProgress :module: MidTmcSubarray Read the progress of the currently executing long running command(s). ID, progress of the currently executing command(s). Clients can subscribe to on_change event and wait for the ID they are interested in. :access: READ :data type: DevString :data format: SPECTRUM :max_dim_x: 4 .. index:: single: longRunningCommandResult; MidTmcSubarray.longRunningCommandResult .. py:attribute:: longRunningCommandResult :module: MidTmcSubarray Read the result of the completed long running command. Reports unique_id, json-encoded result. Clients can subscribe to on_change event and wait for the ID they are interested in. :access: READ :data type: DevString :data format: SPECTRUM :max_dim_x: 2 .. index:: single: longRunningCommandStatus; MidTmcSubarray.longRunningCommandStatus .. py:attribute:: longRunningCommandStatus :module: MidTmcSubarray Read the status of the currently executing long running commands. ID, status pairs of the currently executing commands. Clients can subscribe to on_change event and wait for the ID they are interested in. :access: READ :data type: DevString :data format: SPECTRUM :max_dim_x: 132 .. index:: single: longRunningCommandsInQueue; MidTmcSubarray.longRunningCommandsInQueue .. py:attribute:: longRunningCommandsInQueue :module: MidTmcSubarray Read the long running commands in the queue. Keep track of which commands are that are currently known about. Entries are removed `self._command_tracker._removal_time` seconds after they have finished. :access: READ :data type: DevString :data format: SPECTRUM :max_dim_x: 66 .. index:: single: lrcExecuting; MidTmcSubarray.lrcExecuting .. py:attribute:: lrcExecuting :module: MidTmcSubarray Expose a signal as a Tango attribute. :access: READ :data type: DevString :data format: SPECTRUM :max_dim_x: 2 .. index:: single: lrcFinished; MidTmcSubarray.lrcFinished .. py:attribute:: lrcFinished :module: MidTmcSubarray Expose a signal as a Tango attribute. :access: READ :data type: DevString :data format: SPECTRUM :max_dim_x: 100 .. index:: single: lrcProtocolVersions; MidTmcSubarray.lrcProtocolVersions .. py:attribute:: lrcProtocolVersions :module: MidTmcSubarray Return supported protocol versions. :return: A tuple containing the lower and upper bounds of supported long running command protocol versions. :access: READ :data type: DevLong64 :data format: SPECTRUM :max_dim_x: 2 .. index:: single: lrcQueue; MidTmcSubarray.lrcQueue .. py:attribute:: lrcQueue :module: MidTmcSubarray Expose a signal as a Tango attribute. :access: READ :data type: DevString :data format: SPECTRUM :max_dim_x: 32 .. index:: single: obsMode; MidTmcSubarray.obsMode .. py:attribute:: obsMode :module: MidTmcSubarray The Observation Mode of the device. :access: READ :data type: DevEnum :data format: SCALAR .. index:: single: obsState; MidTmcSubarray.obsState .. py:attribute:: obsState :module: MidTmcSubarray The Observation State of the device. :access: READ :data type: DevEnum :data format: SCALAR .. index:: single: sbID; MidTmcSubarray.sbID .. py:attribute:: sbID :module: MidTmcSubarray ID of ongoing Scheduling Block :access: READ :data type: DevString :data format: SCALAR .. index:: single: scanDuration; MidTmcSubarray.scanDuration .. py:attribute:: scanDuration :module: MidTmcSubarray This attribute is used for exposing the scan duration of ongoing scan to other subsystems. Returns: float: The scan duration of the ongoing scan :access: READ :data type: DevDouble :data format: SCALAR .. index:: single: scanID; MidTmcSubarray.scanID .. py:attribute:: scanID :module: MidTmcSubarray ID of ongoing SCAN :access: READ :data type: DevString :data format: SCALAR .. index:: single: scanStartTimeOffset; MidTmcSubarray.scanStartTimeOffset .. py:attribute:: scanStartTimeOffset :module: MidTmcSubarray Offset for start_time for scan command in seconds. :access: READ_WRITE :data type: DevFloat :data format: SCALAR :unit: s .. index:: single: simulationMode; MidTmcSubarray.simulationMode .. py:attribute:: simulationMode :module: MidTmcSubarray When TRUE the device is using a simulator :access: READ_WRITE :data type: DevEnum :data format: SCALAR .. index:: single: testMode; MidTmcSubarray.testMode .. py:attribute:: testMode :module: MidTmcSubarray If TEST the device is using testing logic :access: READ_WRITE :data type: DevEnum :data format: SCALAR .. index:: single: transformedInternalModel; MidTmcSubarray.transformedInternalModel .. py:attribute:: transformedInternalModel :module: MidTmcSubarray Json String representing the entire internal model transformed for better reading. :access: READ :data type: DevString :data format: SCALAR .. index:: single: versionId; MidTmcSubarray.versionId .. py:attribute:: versionId :module: MidTmcSubarray Read the Version Id of the device. :return: the version id of the device :access: READ :data type: DevString :data format: SCALAR Commands -------- .. index:: single: Abort; MidTmcSubarray.Abort .. py:method:: Abort() -> DevVarLongStringArray :module: MidTmcSubarray No input parameter (DevVoid) :returns: information-only string .. index:: single: AbortCommands; MidTmcSubarray.AbortCommands .. py:method:: AbortCommands() -> DevVarLongStringArray :module: MidTmcSubarray No input parameter (DevVoid) :returns: returns (None): A tuple containing a return code and a string message indicating status. The message is for information purpose only. .. index:: single: AssignResources; MidTmcSubarray.AssignResources .. py:method:: AssignResources(DevString) -> DevVarLongStringArray :module: MidTmcSubarray argin (str): the resources to be assigned :returns: returns (None): A tuple containing a return code and a string message indicating status. The message is for information purpose only. .. index:: single: CheckLongRunningCommandStatus; MidTmcSubarray.CheckLongRunningCommandStatus .. py:method:: CheckLongRunningCommandStatus(DevString) -> DevString :module: MidTmcSubarray command id :returns: TaskStatus .. index:: single: Configure; MidTmcSubarray.Configure .. py:method:: Configure(DevString) -> DevVarLongStringArray :module: MidTmcSubarray argin (str): configuration specification :returns: returns (None): A tuple containing a return code and a string message indicating status. The message is for information purpose only. .. index:: single: DebugDevice; MidTmcSubarray.DebugDevice .. py:method:: DebugDevice() -> DevUShort :module: MidTmcSubarray No input parameter (DevVoid) :returns: The TCP port the debugger is listening on. .. index:: single: End; MidTmcSubarray.End .. py:method:: End() -> DevVarLongStringArray :module: MidTmcSubarray No input parameter (DevVoid) :returns: returns (None): A tuple containing a return code and a string message indicating status. The message is for information purpose only. .. index:: single: EndScan; MidTmcSubarray.EndScan .. py:method:: EndScan() -> DevVarLongStringArray :module: MidTmcSubarray No input parameter (DevVoid) :returns: returns (None): A tuple containing a return code and a string message indicating status. The message is for information purpose only. .. index:: single: GetVersionInfo; MidTmcSubarray.GetVersionInfo .. py:method:: GetVersionInfo() -> DevVarStringArray :module: MidTmcSubarray No input parameter (DevVoid) :returns: returns (None): The result code and the command unique ID .. index:: single: Init; MidTmcSubarray.Init .. py:method:: Init() -> DevVoid :module: MidTmcSubarray Init .. index:: single: ObsReset; MidTmcSubarray.ObsReset .. py:method:: ObsReset() -> DevVarLongStringArray :module: MidTmcSubarray No input parameter (DevVoid) :returns: [ResultCode][message or command id] .. index:: single: Off; MidTmcSubarray.Off .. py:method:: Off() -> DevVarLongStringArray :module: MidTmcSubarray No input parameter (DevVoid) :returns: returns (None): A tuple containing a return code and a string message indicating status. The message is for information purpose only. .. index:: single: On; MidTmcSubarray.On .. py:method:: On() -> DevVarLongStringArray :module: MidTmcSubarray No input parameter (DevVoid) :returns: returns ((ResultCode, str)): None .. index:: single: ReleaseAllResources; MidTmcSubarray.ReleaseAllResources .. py:method:: ReleaseAllResources() -> DevVarLongStringArray :module: MidTmcSubarray No input parameter (DevVoid) :returns: returns (None): A tuple containing a return code and a string message indicating status. The message is for information purpose only. .. index:: single: ReleaseResources; MidTmcSubarray.ReleaseResources .. py:method:: ReleaseResources(DevString) -> DevVarLongStringArray :module: MidTmcSubarray The resources to be released :returns: [ResultCode][message or command id] .. index:: single: Reset; MidTmcSubarray.Reset .. py:method:: Reset() -> DevVarLongStringArray :module: MidTmcSubarray No input parameter (DevVoid) :returns: [ResultCode][message or command id] .. index:: single: Restart; MidTmcSubarray.Restart .. py:method:: Restart() -> DevVarLongStringArray :module: MidTmcSubarray No input parameter (DevVoid) :returns: returns (None): A tuple containing a return code and a string message indicating status. The message is for information purpose only. .. index:: single: Scan; MidTmcSubarray.Scan .. py:method:: Scan(DevString) -> DevVarLongStringArray :module: MidTmcSubarray argin (Array of str): Information about the scan :returns: returns (None): A tuple containing a return code and a string message indicating status. The message is for information purpose only. .. index:: single: SetAdminMode; MidTmcSubarray.SetAdminMode .. py:method:: SetAdminMode(DevString) -> DevVarLongStringArray :module: MidTmcSubarray argin (str): The adminMode in json format :returns: returns (None): A tuple containing a return code and a string message indicating status. The message is for information purpose only. .. index:: single: Standby; MidTmcSubarray.Standby .. py:method:: Standby() -> DevVarLongStringArray :module: MidTmcSubarray No input parameter (DevVoid) :returns: returns (None): A tuple containing a return code and a string message indicating status. The message is for information purpose only.