TmcLeafNodeCspControl Tango Device

CSP Controller leaf node acts as a CSP contact point for Master Node and also to monitor and issue commands to the CSP Master.

Properties

TmcLeafNodeCspControl.AdapterTimeOut

Data type:: DevFloat
Default value:: 2

TmcLeafNodeCspControl.CommandTimeOutDefault

Data type:: DevFloat
Default value:: 30

TmcLeafNodeCspControl.CspMasterFQDN

FQDN of the CSP Master Tango Device Server.

Data type:: DevString

TmcLeafNodeCspControl.EventSubscriptionCheckPeriod

Data type:: DevFloat
Default value:: 1

TmcLeafNodeCspControl.GroupDefinitions

Data type:: DevVarStringArray

TmcLeafNodeCspControl.LivelinessCheckPeriod

Data type:: DevFloat
Default value:: 1

TmcLeafNodeCspControl.LoggingLevelDefault

Data type:: DevUShort
Default value:: 4

TmcLeafNodeCspControl.LoggingTargetsDefault

Data type:: DevVarStringArray
Default value:: [‘tango::logger’]

TmcLeafNodeCspControl.SkaLevel

Data type:: DevShort
Default value:: 4

Attributes

TmcLeafNodeCspControl.State

The operational state of the device as enumeration.

Access:: READ
Data type:: DevState
Data format:: SCALAR

TmcLeafNodeCspControl.Status

More detailed textual information about the device’s status.

Access:: READ
Data type:: DevString
Data format:: SCALAR

TmcLeafNodeCspControl.adminMode

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

TmcLeafNodeCspControl.buildState

Read the Build State of the device.

Returns:: the build state of the device
Access:: READ
Data type:: DevString
Data format:: SCALAR

TmcLeafNodeCspControl.commandTimeOut

Command execution time limit.

Access:: READ_WRITE
Data type:: DevUShort
Data format:: SCALAR

TmcLeafNodeCspControl.commandedState

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

TmcLeafNodeCspControl.controlMode

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

TmcLeafNodeCspControl.cspControllerAdminMode

Csp Controller Admin Mode

Access:: READ
Data type:: DevEnum
Data format:: SCALAR

TmcLeafNodeCspControl.cspMasterDevName

Returns the cspmasterdevname attribute.

Access:: READ_WRITE
Data type:: DevString
Data format:: SCALAR

TmcLeafNodeCspControl.healthInfo

JSON string representing the health information.

Access:: READ
Data type:: DevString
Data format:: SCALAR

TmcLeafNodeCspControl.healthState

Health state of the monitored CSP Controller device.

Access:: READ
Data type:: DevEnum
Data format:: SCALAR

TmcLeafNodeCspControl.isAdminModeEnabled

No description

Access:: READ_WRITE
Data type:: DevBoolean
Data format:: SCALAR

TmcLeafNodeCspControl.isSubsystemAvailable

Boolean Flag for sub system available

Access:: READ
Data type:: DevBoolean
Data format:: SCALAR

TmcLeafNodeCspControl.loggingLevel

Read the logging level of the device.

Initialises to LoggingLevelDefault on startup. See LoggingLevel

Returns:: Logging level of the device.
Access:: READ_WRITE
Data type:: DevEnum
Data format:: SCALAR

TmcLeafNodeCspControl.loggingTargets

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.

Returns:: Logging level of the device.
Access:: READ_WRITE
Data type:: DevString
Data format:: SPECTRUM
Max_dim_x:: 4

TmcLeafNodeCspControl.longRunningCommandIDsInQueue

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

TmcLeafNodeCspControl.longRunningCommandInProgress

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

TmcLeafNodeCspControl.longRunningCommandProgress

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

TmcLeafNodeCspControl.longRunningCommandResult

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

TmcLeafNodeCspControl.longRunningCommandStatus

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

TmcLeafNodeCspControl.longRunningCommandsInQueue

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

TmcLeafNodeCspControl.lrcExecuting

Expose a signal as a Tango attribute.

Access:: READ
Data type:: DevString
Data format:: SPECTRUM
Max_dim_x:: 2

TmcLeafNodeCspControl.lrcFinished

Expose a signal as a Tango attribute.

Access:: READ
Data type:: DevString
Data format:: SPECTRUM
Max_dim_x:: 100

TmcLeafNodeCspControl.lrcProtocolVersions

Return supported protocol versions.

Returns:: 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

TmcLeafNodeCspControl.lrcQueue

Expose a signal as a Tango attribute.

Access:: READ
Data type:: DevString
Data format:: SPECTRUM
Max_dim_x:: 32

TmcLeafNodeCspControl.simulationMode

When TRUE the device is using a simulator

Access:: READ_WRITE
Data type:: DevEnum
Data format:: SCALAR

TmcLeafNodeCspControl.testMode

If TEST the device is using testing logic

Access:: READ_WRITE
Data type:: DevEnum
Data format:: SCALAR

TmcLeafNodeCspControl.versionId

Read the Version Id of the device.

Returns:: the version id of the device
Access:: READ
Data type:: DevString
Data format:: SCALAR

Commands

TmcLeafNodeCspControl.Abort() → DevVarLongStringArray

No input parameter (DevVoid)

Returns:: [ResultCode.STARTED][command_id]

TmcLeafNodeCspControl.AbortCommands() → DevVarLongStringArray

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.

TmcLeafNodeCspControl.CheckLongRunningCommandStatus(DevString) → DevString

command id

Returns:: TaskStatus

TmcLeafNodeCspControl.DebugDevice() → DevUShort

No input parameter (DevVoid)

Returns:: The TCP port the debugger is listening on.

TmcLeafNodeCspControl.GetVersionInfo() → DevVarStringArray

No input parameter (DevVoid)

Returns:: returns (None): The result code and the command unique ID

TmcLeafNodeCspControl.Init() → DevVoid: Init

TmcLeafNodeCspControl.Off() → DevVarLongStringArray

No input parameter (DevVoid)

Returns:

return:: (not documented)
rtype:: DevVarLongStringArray

TmcLeafNodeCspControl.On() → DevVarLongStringArray

No input parameter (DevVoid)

Returns:

return:: (not documented)
rtype:: DevVarLongStringArray

TmcLeafNodeCspControl.Reset() → DevVarLongStringArray

No input parameter (DevVoid)

Returns:: [ResultCode][message or command id]

TmcLeafNodeCspControl.SetAdminMode(DevEnum) → DevVarLongStringArray

The input string in JSON format.

Returns:: (ReturnType, ‘informational message’)

TmcLeafNodeCspControl.Standby() → DevVarLongStringArray

No input parameter (DevVoid)

Returns:

return:: (not documented)
rtype:: DevVarLongStringArray