MidTmcLeafNodeCspControl Tango Device
Tango device class for TMC CSP Controller leaf node MID.
Properties
- MidTmcLeafNodeCspControl.AdapterTimeOut
- Data type:
DevFloat
- Default value:
2
- MidTmcLeafNodeCspControl.CommandTimeOutDefault
- Data type:
DevFloat
- Default value:
30
- MidTmcLeafNodeCspControl.CspMasterFQDN
FQDN of the CSP Master Tango Device Server.
- Data type:
DevString
- MidTmcLeafNodeCspControl.EventSubscriptionCheckPeriod
- Data type:
DevFloat
- Default value:
1
- MidTmcLeafNodeCspControl.GroupDefinitions
- Data type:
DevVarStringArray
- MidTmcLeafNodeCspControl.LivelinessCheckPeriod
- Data type:
DevFloat
- Default value:
1
- MidTmcLeafNodeCspControl.LoggingLevelDefault
- Data type:
DevUShort
- Default value:
4
- MidTmcLeafNodeCspControl.LoggingTargetsDefault
- Data type:
DevVarStringArray
- Default value:
[‘tango::logger’]
- MidTmcLeafNodeCspControl.SkaLevel
- Data type:
DevShort
- Default value:
4
Attributes
- MidTmcLeafNodeCspControl.DishVccMapValidationResult
Dish Vcc Validation Result status
- Access:
READ
- Data type:
DevString
- Data format:
SCALAR
- MidTmcLeafNodeCspControl.State
The operational state of the device as enumeration.
- Access:
READ
- Data type:
DevState
- Data format:
SCALAR
- MidTmcLeafNodeCspControl.Status
More detailed textual information about the device’s status.
- Access:
READ
- Data type:
DevString
- Data format:
SCALAR
- MidTmcLeafNodeCspControl.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
- MidTmcLeafNodeCspControl.buildState
Read the Build State of the device.
- Returns:
the build state of the device
- Access:
READ
- Data type:
DevString
- Data format:
SCALAR
- MidTmcLeafNodeCspControl.commandTimeOut
Command execution time limit.
- Access:
READ_WRITE
- Data type:
DevUShort
- Data format:
SCALAR
- MidTmcLeafNodeCspControl.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
- MidTmcLeafNodeCspControl.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
- MidTmcLeafNodeCspControl.cspControllerAdminMode
Csp Controller Admin Mode
- Access:
READ
- Data type:
DevEnum
- Data format:
SCALAR
- MidTmcLeafNodeCspControl.cspMasterDevName
Returns the cspmasterdevname attribute.
- Access:
READ_WRITE
- Data type:
DevString
- Data format:
SCALAR
- MidTmcLeafNodeCspControl.dishVccConfig
No description
- Access:
READ
- Data type:
DevString
- Data format:
SCALAR
- MidTmcLeafNodeCspControl.healthInfo
JSON string representing the health information.
- Access:
READ
- Data type:
DevString
- Data format:
SCALAR
- MidTmcLeafNodeCspControl.healthState
Health state of the monitored CSP Controller device.
- Access:
READ
- Data type:
DevEnum
- Data format:
SCALAR
- MidTmcLeafNodeCspControl.isAdminModeEnabled
No description
- Access:
READ_WRITE
- Data type:
DevBoolean
- Data format:
SCALAR
- MidTmcLeafNodeCspControl.isSubsystemAvailable
Boolean Flag for sub system available
- Access:
READ
- Data type:
DevBoolean
- Data format:
SCALAR
- MidTmcLeafNodeCspControl.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
- MidTmcLeafNodeCspControl.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
- MidTmcLeafNodeCspControl.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
- MidTmcLeafNodeCspControl.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
- MidTmcLeafNodeCspControl.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
- MidTmcLeafNodeCspControl.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
- MidTmcLeafNodeCspControl.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
- MidTmcLeafNodeCspControl.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
- MidTmcLeafNodeCspControl.lrcExecuting
Expose a signal as a Tango attribute.
- Access:
READ
- Data type:
DevString
- Data format:
SPECTRUM
- Max_dim_x:
2
- MidTmcLeafNodeCspControl.lrcFinished
Expose a signal as a Tango attribute.
- Access:
READ
- Data type:
DevString
- Data format:
SPECTRUM
- Max_dim_x:
100
- MidTmcLeafNodeCspControl.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
- MidTmcLeafNodeCspControl.lrcQueue
Expose a signal as a Tango attribute.
- Access:
READ
- Data type:
DevString
- Data format:
SPECTRUM
- Max_dim_x:
32
- MidTmcLeafNodeCspControl.memorizedDishVccMap
This attribute stores the latest dish VCC map version data
in the Tango DB. The attribute is memorized so that when the device restarts, the last set dish VCC map version will be used for loading dish VCC config on the CSP master.
- Access:
READ_WRITE
- Data type:
DevString
- Data format:
SCALAR
- MidTmcLeafNodeCspControl.simulationMode
When TRUE the device is using a simulator
- Access:
READ_WRITE
- Data type:
DevEnum
- Data format:
SCALAR
- MidTmcLeafNodeCspControl.sourceDishVccConfig
source Dish Vcc Config data
- Access:
READ
- Data type:
DevString
- Data format:
SCALAR
- MidTmcLeafNodeCspControl.testMode
If TEST the device is using testing logic
- Access:
READ_WRITE
- Data type:
DevEnum
- Data format:
SCALAR
- MidTmcLeafNodeCspControl.versionId
Read the Version Id of the device.
- Returns:
the version id of the device
- Access:
READ
- Data type:
DevString
- Data format:
SCALAR
Commands
- MidTmcLeafNodeCspControl.Abort() DevVarLongStringArray
No input parameter (DevVoid)
- Returns:
[ResultCode.STARTED][command_id]
- MidTmcLeafNodeCspControl.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.
- MidTmcLeafNodeCspControl.CheckLongRunningCommandStatus(DevString) DevString
command id
- Returns:
TaskStatus
- MidTmcLeafNodeCspControl.DebugDevice() DevUShort
No input parameter (DevVoid)
- Returns:
The TCP port the debugger is listening on.
- MidTmcLeafNodeCspControl.GetVersionInfo() DevVarStringArray
No input parameter (DevVoid)
- Returns:
returns (None): The result code and the command unique ID
- MidTmcLeafNodeCspControl.Init() DevVoid
Init
- MidTmcLeafNodeCspControl.LoadDishCfg(DevString) DevVarLongStringArray
argin (None): JSON formatted string with data source, path,
and interface.
- Returns:
returns (None): A tuple containing a list of ResultCodes and a list of informational messages.
- MidTmcLeafNodeCspControl.Off() DevVarLongStringArray
No input parameter (DevVoid)
- Returns:
- return:
(not documented)
- rtype:
DevVarLongStringArray
- MidTmcLeafNodeCspControl.On() DevVarLongStringArray
No input parameter (DevVoid)
- Returns:
- return:
(not documented)
- rtype:
DevVarLongStringArray
- MidTmcLeafNodeCspControl.Reset() DevVarLongStringArray
No input parameter (DevVoid)
- Returns:
[ResultCode][message or command id]
- MidTmcLeafNodeCspControl.SetAdminMode(DevEnum) DevVarLongStringArray
The input string in JSON format.
- Returns:
(ReturnType, ‘informational message’)
- MidTmcLeafNodeCspControl.Standby() DevVarLongStringArray
No input parameter (DevVoid)
- Returns:
- return:
(not documented)
- rtype:
DevVarLongStringArray