====================================== MidTmcLeafNodeCspSubarray Tango Device ====================================== Tango device class for tmc csp subarray leaf node low Properties ---------- .. index:: single: AdapterTimeOut; MidTmcLeafNodeCspSubarray.AdapterTimeOut .. py:attribute:: AdapterTimeOut :module: MidTmcLeafNodeCspSubarray :data type: DevFloat :default value: 2 .. index:: single: CommandTimeOutDefault; MidTmcLeafNodeCspSubarray.CommandTimeOutDefault .. py:attribute:: CommandTimeOutDefault :module: MidTmcLeafNodeCspSubarray :data type: DevFloat :default value: 30 .. index:: single: CspSubarrayFQDN; MidTmcLeafNodeCspSubarray.CspSubarrayFQDN .. py:attribute:: CspSubarrayFQDN :module: MidTmcLeafNodeCspSubarray FQDN of the CSP Subarray Tango Device . :data type: DevString .. index:: single: DelayCadence; MidTmcLeafNodeCspSubarray.DelayCadence .. py:attribute:: DelayCadence :module: MidTmcLeafNodeCspSubarray :data type: DevFloat .. index:: single: DelayModelTimeInAdvance; MidTmcLeafNodeCspSubarray.DelayModelTimeInAdvance .. py:attribute:: DelayModelTimeInAdvance :module: MidTmcLeafNodeCspSubarray :data type: DevShort :default value: 30 .. index:: single: DelayValidityPeriod; MidTmcLeafNodeCspSubarray.DelayValidityPeriod .. py:attribute:: DelayValidityPeriod :module: MidTmcLeafNodeCspSubarray :data type: DevFloat .. index:: single: EventSubscriptionCheckPeriod; MidTmcLeafNodeCspSubarray.EventSubscriptionCheckPeriod .. py:attribute:: EventSubscriptionCheckPeriod :module: MidTmcLeafNodeCspSubarray :data type: DevFloat :default value: 1 .. index:: single: GroupDefinitions; MidTmcLeafNodeCspSubarray.GroupDefinitions .. py:attribute:: GroupDefinitions :module: MidTmcLeafNodeCspSubarray :data type: DevVarStringArray .. index:: single: LivelinessCheckPeriod; MidTmcLeafNodeCspSubarray.LivelinessCheckPeriod .. py:attribute:: LivelinessCheckPeriod :module: MidTmcLeafNodeCspSubarray :data type: DevFloat :default value: 1 .. index:: single: LoggingLevelDefault; MidTmcLeafNodeCspSubarray.LoggingLevelDefault .. py:attribute:: LoggingLevelDefault :module: MidTmcLeafNodeCspSubarray :data type: DevUShort :default value: 4 .. index:: single: LoggingTargetsDefault; MidTmcLeafNodeCspSubarray.LoggingTargetsDefault .. py:attribute:: LoggingTargetsDefault :module: MidTmcLeafNodeCspSubarray :data type: DevVarStringArray :default value: ['tango::logger'] .. index:: single: SkaLevel; MidTmcLeafNodeCspSubarray.SkaLevel .. py:attribute:: SkaLevel :module: MidTmcLeafNodeCspSubarray :data type: DevShort :default value: 4 .. index:: single: TelmodelPath; MidTmcLeafNodeCspSubarray.TelmodelPath .. py:attribute:: TelmodelPath :module: MidTmcLeafNodeCspSubarray Telmodel path for array layout. :data type: DevString .. index:: single: TelmodelSource; MidTmcLeafNodeCspSubarray.TelmodelSource .. py:attribute:: TelmodelSource :module: MidTmcLeafNodeCspSubarray Telmodel source for array layout. :data type: DevString .. index:: single: WeatherStationDevName; MidTmcLeafNodeCspSubarray.WeatherStationDevName .. py:attribute:: WeatherStationDevName :module: MidTmcLeafNodeCspSubarray TRL of Weather Monitoring Station device. :data type: DevString Attributes ---------- .. index:: single: State; MidTmcLeafNodeCspSubarray.State .. py:attribute:: State :module: MidTmcLeafNodeCspSubarray The operational state of the device as enumeration. :access: READ :data type: DevState :data format: SCALAR .. index:: single: Status; MidTmcLeafNodeCspSubarray.Status .. py:attribute:: Status :module: MidTmcLeafNodeCspSubarray More detailed textual information about the device's status. :access: READ :data type: DevString :data format: SCALAR .. index:: single: adminMode; MidTmcLeafNodeCspSubarray.adminMode .. py:attribute:: adminMode :module: MidTmcLeafNodeCspSubarray 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: buildState; MidTmcLeafNodeCspSubarray.buildState .. py:attribute:: buildState :module: MidTmcLeafNodeCspSubarray 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; MidTmcLeafNodeCspSubarray.commandTimeOut .. py:attribute:: commandTimeOut :module: MidTmcLeafNodeCspSubarray Command execution time limit. :access: READ_WRITE :data type: DevUShort :data format: SCALAR .. index:: single: commandedState; MidTmcLeafNodeCspSubarray.commandedState .. py:attribute:: commandedState :module: MidTmcLeafNodeCspSubarray 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: controlMode; MidTmcLeafNodeCspSubarray.controlMode .. py:attribute:: controlMode :module: MidTmcLeafNodeCspSubarray 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: cspSubarrayAdminMode; MidTmcLeafNodeCspSubarray.cspSubarrayAdminMode .. py:attribute:: cspSubarrayAdminMode :module: MidTmcLeafNodeCspSubarray Admin Mode of Csp Subarray :access: READ :data type: DevEnum :data format: SCALAR .. index:: single: cspSubarrayDevName; MidTmcLeafNodeCspSubarray.cspSubarrayDevName .. py:attribute:: cspSubarrayDevName :module: MidTmcLeafNodeCspSubarray No description :access: READ_WRITE :data type: DevString :data format: SCALAR .. index:: single: cspSubarrayObsState; MidTmcLeafNodeCspSubarray.cspSubarrayObsState .. py:attribute:: cspSubarrayObsState :module: MidTmcLeafNodeCspSubarray Obs State of Csp Subarray Obs State :access: READ_WRITE :data type: DevEnum :data format: SCALAR .. index:: single: delayModel; MidTmcLeafNodeCspSubarray.delayModel .. py:attribute:: delayModel :module: MidTmcLeafNodeCspSubarray No description :access: READ :data type: DevString :data format: SCALAR .. index:: single: delayModelError; MidTmcLeafNodeCspSubarray.delayModelError .. py:attribute:: delayModelError :module: MidTmcLeafNodeCspSubarray String representing the last DelayModel error. :access: READ :data type: DevString :data format: SCALAR .. index:: single: healthInfo; MidTmcLeafNodeCspSubarray.healthInfo .. py:attribute:: healthInfo :module: MidTmcLeafNodeCspSubarray JSON string representing the health information. :access: READ :data type: DevString :data format: SCALAR .. index:: single: healthState; MidTmcLeafNodeCspSubarray.healthState .. py:attribute:: healthState :module: MidTmcLeafNodeCspSubarray Health state of the monitored CSP Subarray :access: READ :data type: DevEnum :data format: SCALAR .. index:: single: isAdminModeEnabled; MidTmcLeafNodeCspSubarray.isAdminModeEnabled .. py:attribute:: isAdminModeEnabled :module: MidTmcLeafNodeCspSubarray No description :access: READ_WRITE :data type: DevBoolean :data format: SCALAR .. index:: single: isSubsystemAvailable; MidTmcLeafNodeCspSubarray.isSubsystemAvailable .. py:attribute:: isSubsystemAvailable :module: MidTmcLeafNodeCspSubarray Boolean Flag for sub system available :access: READ :data type: DevBoolean :data format: SCALAR .. index:: single: lastDeviceInfoChanged; MidTmcLeafNodeCspSubarray.lastDeviceInfoChanged .. py:attribute:: lastDeviceInfoChanged :module: MidTmcLeafNodeCspSubarray Json String representing the last device changed in the internal model. :access: READ :data type: DevString :data format: SCALAR .. index:: single: loggingLevel; MidTmcLeafNodeCspSubarray.loggingLevel .. py:attribute:: loggingLevel :module: MidTmcLeafNodeCspSubarray 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; MidTmcLeafNodeCspSubarray.loggingTargets .. py:attribute:: loggingTargets :module: MidTmcLeafNodeCspSubarray 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; MidTmcLeafNodeCspSubarray.longRunningCommandIDsInQueue .. py:attribute:: longRunningCommandIDsInQueue :module: MidTmcLeafNodeCspSubarray 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; MidTmcLeafNodeCspSubarray.longRunningCommandInProgress .. py:attribute:: longRunningCommandInProgress :module: MidTmcLeafNodeCspSubarray 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; MidTmcLeafNodeCspSubarray.longRunningCommandProgress .. py:attribute:: longRunningCommandProgress :module: MidTmcLeafNodeCspSubarray 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; MidTmcLeafNodeCspSubarray.longRunningCommandResult .. py:attribute:: longRunningCommandResult :module: MidTmcLeafNodeCspSubarray 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; MidTmcLeafNodeCspSubarray.longRunningCommandStatus .. py:attribute:: longRunningCommandStatus :module: MidTmcLeafNodeCspSubarray 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; MidTmcLeafNodeCspSubarray.longRunningCommandsInQueue .. py:attribute:: longRunningCommandsInQueue :module: MidTmcLeafNodeCspSubarray 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; MidTmcLeafNodeCspSubarray.lrcExecuting .. py:attribute:: lrcExecuting :module: MidTmcLeafNodeCspSubarray Expose a signal as a Tango attribute. :access: READ :data type: DevString :data format: SPECTRUM :max_dim_x: 2 .. index:: single: lrcFinished; MidTmcLeafNodeCspSubarray.lrcFinished .. py:attribute:: lrcFinished :module: MidTmcLeafNodeCspSubarray Expose a signal as a Tango attribute. :access: READ :data type: DevString :data format: SPECTRUM :max_dim_x: 100 .. index:: single: lrcProtocolVersions; MidTmcLeafNodeCspSubarray.lrcProtocolVersions .. py:attribute:: lrcProtocolVersions :module: MidTmcLeafNodeCspSubarray 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; MidTmcLeafNodeCspSubarray.lrcQueue .. py:attribute:: lrcQueue :module: MidTmcLeafNodeCspSubarray Expose a signal as a Tango attribute. :access: READ :data type: DevString :data format: SPECTRUM :max_dim_x: 32 .. index:: single: simulationMode; MidTmcLeafNodeCspSubarray.simulationMode .. py:attribute:: simulationMode :module: MidTmcLeafNodeCspSubarray When TRUE the device is using a simulator :access: READ_WRITE :data type: DevEnum :data format: SCALAR .. index:: single: testMode; MidTmcLeafNodeCspSubarray.testMode .. py:attribute:: testMode :module: MidTmcLeafNodeCspSubarray If TEST the device is using testing logic :access: READ_WRITE :data type: DevEnum :data format: SCALAR .. index:: single: versionId; MidTmcLeafNodeCspSubarray.versionId .. py:attribute:: versionId :module: MidTmcLeafNodeCspSubarray 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; MidTmcLeafNodeCspSubarray.Abort .. py:method:: Abort() -> DevVarLongStringArray :module: MidTmcLeafNodeCspSubarray No input parameter (DevVoid) :returns: information-only string .. index:: single: AbortCommands; MidTmcLeafNodeCspSubarray.AbortCommands .. py:method:: AbortCommands() -> DevVarLongStringArray :module: MidTmcLeafNodeCspSubarray 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; MidTmcLeafNodeCspSubarray.AssignResources .. py:method:: AssignResources(DevString) -> DevVarLongStringArray :module: MidTmcLeafNodeCspSubarray :param argin: (not documented) :type argin: DevString :returns: :return: (not documented) :rtype: DevVarLongStringArray .. index:: single: CheckLongRunningCommandStatus; MidTmcLeafNodeCspSubarray.CheckLongRunningCommandStatus .. py:method:: CheckLongRunningCommandStatus(DevString) -> DevString :module: MidTmcLeafNodeCspSubarray command id :returns: TaskStatus .. index:: single: Configure; MidTmcLeafNodeCspSubarray.Configure .. py:method:: Configure(DevString) -> DevVarLongStringArray :module: MidTmcLeafNodeCspSubarray :param argin: (not documented) :type argin: DevString :returns: :return: (not documented) :rtype: DevVarLongStringArray .. index:: single: DebugDevice; MidTmcLeafNodeCspSubarray.DebugDevice .. py:method:: DebugDevice() -> DevUShort :module: MidTmcLeafNodeCspSubarray No input parameter (DevVoid) :returns: The TCP port the debugger is listening on. .. index:: single: End; MidTmcLeafNodeCspSubarray.End .. py:method:: End() -> DevVarLongStringArray :module: MidTmcLeafNodeCspSubarray No input parameter (DevVoid) :returns: :return: (not documented) :rtype: DevVarLongStringArray .. index:: single: EndScan; MidTmcLeafNodeCspSubarray.EndScan .. py:method:: EndScan() -> DevVarLongStringArray :module: MidTmcLeafNodeCspSubarray No input parameter (DevVoid) :returns: :return: (not documented) :rtype: DevVarLongStringArray .. index:: single: GetVersionInfo; MidTmcLeafNodeCspSubarray.GetVersionInfo .. py:method:: GetVersionInfo() -> DevVarStringArray :module: MidTmcLeafNodeCspSubarray No input parameter (DevVoid) :returns: returns (None): The result code and the command unique ID .. index:: single: Init; MidTmcLeafNodeCspSubarray.Init .. py:method:: Init() -> DevVoid :module: MidTmcLeafNodeCspSubarray Init .. index:: single: Off; MidTmcLeafNodeCspSubarray.Off .. py:method:: Off() -> DevVarLongStringArray :module: MidTmcLeafNodeCspSubarray No input parameter (DevVoid) :returns: [ResultCode][message or command id] .. index:: single: On; MidTmcLeafNodeCspSubarray.On .. py:method:: On() -> DevVarLongStringArray :module: MidTmcLeafNodeCspSubarray No input parameter (DevVoid) :returns: [ResultCode][message or command id] .. index:: single: ReleaseAllResources; MidTmcLeafNodeCspSubarray.ReleaseAllResources .. py:method:: ReleaseAllResources() -> DevVarLongStringArray :module: MidTmcLeafNodeCspSubarray No input parameter (DevVoid) :returns: :return: (not documented) :rtype: DevVarLongStringArray .. index:: single: Reset; MidTmcLeafNodeCspSubarray.Reset .. py:method:: Reset() -> DevVarLongStringArray :module: MidTmcLeafNodeCspSubarray No input parameter (DevVoid) :returns: [ResultCode][message or command id] .. index:: single: Restart; MidTmcLeafNodeCspSubarray.Restart .. py:method:: Restart() -> DevVarLongStringArray :module: MidTmcLeafNodeCspSubarray No input parameter (DevVoid) :returns: :return: (not documented) :rtype: DevVarLongStringArray .. index:: single: Scan; MidTmcLeafNodeCspSubarray.Scan .. py:method:: Scan(DevString) -> DevVarLongStringArray :module: MidTmcLeafNodeCspSubarray :param argin: (not documented) :type argin: DevString :returns: :return: (not documented) :rtype: DevVarLongStringArray .. index:: single: SetAdminMode; MidTmcLeafNodeCspSubarray.SetAdminMode .. py:method:: SetAdminMode(DevEnum) -> DevVarLongStringArray :module: MidTmcLeafNodeCspSubarray The input string in JSON format. :returns: (ReturnType, 'informational message') .. index:: single: Standby; MidTmcLeafNodeCspSubarray.Standby .. py:method:: Standby() -> DevVarLongStringArray :module: MidTmcLeafNodeCspSubarray No input parameter (DevVoid) :returns: [ResultCode][message or command id]