MccsCalibrationStore Tango Device
An implementation of the CalibrationStore Tango device.
Properties
- CircuitBreakTimeout
- Data type:
DevDouble
- Default value:
0.1
- GroupDefinitions
Each string in the list is a JSON serialised dict defining the
group_name,devicesandsubgroupsin the group. A Tango Group object is created for each item in the list, according to the hierarchy defined. This provides easy access to the managed devices in bulk, or individually.- Data type:
DevVarStringArray
- LoggingLevelDefault
Default logging level at device startup.
- Data type:
DevUShort
- Default value:
4
- LoggingTargetsDefault
Default logging targets at device startup.
- Data type:
DevVarStringArray
- Default value:
[‘tango::logger’]
- ParentConnectionTimeout
- Data type:
DevDouble
- Default value:
120
- ParentTRL
- Data type:
DevString
- PolicyFrequencyTolerance
- Data type:
DevLong64
- PolicyTemperatureTolerance
- Data type:
DevDouble
- Default value:
200.0
- SelectionPolicy
- Data type:
DevString
- Default value:
preferred
- SkaLevel
Indication of importance of the device in the SKA hierarchy to support drill-down navigation: 1..6, with 1 highest.
- Data type:
DevShort
- Default value:
4
- WindowFailureSize
- Data type:
DevDouble
- Default value:
30.0
- WindowFailureThreshold
- Data type:
DevDouble
- Default value:
1
Attributes
- State
The operational state of the device as enumeration.
- Access:
READ
- Data type:
DevState
- Data format:
SCALAR
- Status
More detailed textual information about the device’s status.
- Access:
READ
- Data type:
DevString
- Data format:
SCALAR
- adminMode
The Admin Mode of the device.
It may interpret the current device condition and condition of all managed devices to set this.
- Access:
READ_WRITE
- Data type:
DevEnum
- Data format:
SCALAR
- buildState
Read the Build State of the device.
- Access:
READ
- Data type:
DevString
- Data format:
SCALAR
- 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
- controlMode
The control mode of the device.
A Tango Device accepts only from a ‘local’ client and ignores commands and queries received from TM or any other ‘remote’ clients. The local client has to release LOCAL control before REMOTE clients can take control again.
- Access:
READ_WRITE
- Data type:
DevEnum
- Data format:
SCALAR
- eventHistory
Return the event history of the event serialiser.
- Access:
READ
- Data type:
DevString
- Data format:
SCALAR
- healthInfo
(‘Read the Health Info of the device.nnIt provides an explanation for the currently reported Health State’,)
- Access:
READ
- Data type:
DevString
- Data format:
SPECTRUM
- Max_dim_x:
256
- healthState
Read the Health State of the device.
It interprets the current device condition and condition of all managed devices to set this.
- Access:
READ
- Data type:
DevEnum
- Data format:
SCALAR
- inheritModes
Read the mode inheritance attribute.
- Access:
READ_WRITE
- Data type:
DevBoolean
- Data format:
SCALAR
- lastJobID
Return the last job ID stored in the database.
- Access:
READ
- Data type:
DevLong64
- Data format:
SCALAR
- lastSweepID
Return the last sweep ID stored in the database.
- Access:
READ
- Data type:
DevLong64
- Data format:
SCALAR
- loggingFilter
Return if the logging filter is used.
- Access:
READ_WRITE
- Data type:
DevBoolean
- Data format:
SCALAR
- loggingLevel
Read the logging level of the device.
Initialises to LoggingLevelDefault on startup. See
LoggingLevel- Access:
READ_WRITE
- Data type:
DevEnum
- Data format:
SCALAR
- 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.
- Access:
READ_WRITE
- Data type:
DevString
- Data format:
SPECTRUM
- Max_dim_x:
4
- 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_timeseconds after they have finished.DEPRECATED: A client can check for the queued command(s) in ‘lrcQueue’.
- Access:
READ
- Data type:
DevString
- Data format:
SPECTRUM
- Max_dim_x:
66
- 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).
DEPRECATED: A client can check for the command(s) in progress in ‘lrcExecuting’.
- Access:
READ
- Data type:
DevString
- Data format:
SPECTRUM
- Max_dim_x:
2
- 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.
DEPRECATED: A client can check the progress of command(s) in ‘lrcExecuting’.
- Access:
READ
- Data type:
DevString
- Data format:
SPECTRUM
- Max_dim_x:
4
- longRunningCommandResult
Read the result of the completed long running command.
Reports unique ID and json-encoded result. Clients can subscribe to on change event and wait for the ID they are interested in.
DEPRECATED: A client can check for the result of a command in ‘lrcFinished’.
- Access:
READ
- Data type:
DevString
- Data format:
SPECTRUM
- Max_dim_x:
2
- 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.
DEPRECATED: A client can check for the status of a command in the ‘lrcQueue’, ‘lrcExecuting’ and ‘lrcFinished’ attributes.
- Access:
READ
- Data type:
DevString
- Data format:
SPECTRUM
- Max_dim_x:
132
- 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_timeseconds after they have finished.DEPRECATED: A client can check for the queued command(s) in ‘lrcQueue’.
- Access:
READ
- Data type:
DevString
- Data format:
SPECTRUM
- Max_dim_x:
66
- lrcExecuting
A list of info JSON blobs of the currently executing commands.
- Access:
READ
- Data type:
DevString
- Data format:
SPECTRUM
- Max_dim_x:
2
- lrcFinished
A list of info JSON blobs of the finished long running commands.
- Access:
READ
- Data type:
DevString
- Data format:
SPECTRUM
- Max_dim_x:
100
- lrcProtocolVersions
Return supported protocol versions.
- Access:
READ
- Data type:
DevLong64
- Data format:
SPECTRUM
- Max_dim_x:
2
- lrcQueue
A list of info JSON blobs of the commands in queue.
- Access:
READ
- Data type:
DevString
- Data format:
SPECTRUM
- Max_dim_x:
32
- parentConnectionFailed
Return whether the connection to the parent device is failing.
- Access:
READ
- Data type:
DevLong64
- Data format:
SCALAR
- parentTRL
Return the current parent TRL.
- Access:
READ
- Data type:
DevString
- Data format:
SCALAR
- selectionPolicy
Read the selectionPolicy used by this device.
- Access:
READ
- Data type:
DevString
- Data format:
SCALAR
- selectionPolicyDescription
Read the full selectionPolicy description in use.
- Access:
READ
- Data type:
DevString
- Data format:
SCALAR
- simulationMode
When TRUE the device is using a simulator
- Access:
READ_WRITE
- Data type:
DevEnum
- Data format:
SCALAR
- testMode
If TEST the device is using testing logic
- Access:
READ_WRITE
- Data type:
DevEnum
- Data format:
SCALAR
- versionId
Read the Version Id of the device.
- Access:
READ
- Data type:
DevString
- Data format:
SCALAR
Commands
- Abort() DevVarLongStringArray
Abort any executing long running command(s) and empty the queue.
- Returns:
[ResultCode.STARTED][Command ID]
- AbortCommands() DevVarLongStringArray
Empty out long running commands in queue.
DEPRECATED: A client should call the tracked ‘Abort’ long running command instead.
- Returns:
[ResultCode.STARTED][‘Aborting commands’]
- CheckCalibrationId(DevString) DevBoolean
- Parameter:
the cal ID to check.
- Returns:
True if the cal ID is already in the database
- CheckLongRunningCommandStatus(DevString) DevString
Check the status of a long running command by ID.
- Returns:
Status of the asynchronous task.
- DebugDevice() DevUShort
Enable remote debugging of this device.
- Returns:
The TCP port the debugger is listening on.
- GetCalibrationIds() DevVarStringArray
Get calibration ids
- Returns:
All calibration_ids from the database.
- GetFittedSolutions(DevString) DevVarFloatArray
- Parameter:
the id of the station to get fit params for
- Returns:
flat float array of fitted gains, empty if no params found
- GetLatestPreferredJobID(DevLong64) DevString
- Parameter:
the station ID to query for.
- Returns:
the user_friendly_name of the most recent preferred job for the station, or an empty string if no preferred job exists.
- GetSolution(DevString) DevVarFloatArray
- Parameter:
the id of the station to get the solution for
- Returns:
the solution or an empty list
- GetVersionInfo() DevVarStringArray
Get the version information of the device.
- Returns:
The device class name and its package information.
- Init() DevVoid
Reinitialise the Tango device.
- MarkCalibrationJobPreferred(DevString) DevVarLongStringArray
- Parameter:
the unique name of the calibration job to mark.
- Returns:
a tuple containing the ResultCode and a message.
- Off() DevVarLongStringArray
Turn the device off.
- Returns:
[ResultCode][Status message or command ID]
- On() DevVarLongStringArray
Turn the device on.
- Returns:
[ResultCode][Status message or command ID]
- Reset() DevVarLongStringArray
Reset the device.
- Returns:
[ResultCode][Status message or command ID]
- ResetParentTRL() DevVarLongStringArray
Reset parent t r l
- Returns:
A tuple containing a return code and a string message indicating status. The message is for information purpose only.
- SetParentTRL(DevString) DevVarLongStringArray
- Parameter:
the TRL of the new parent device.
- Returns:
A tuple containing a return code and a string message indicating status. The message is for information purpose only.
- Standby() DevVarLongStringArray
Put the device into standby mode.
- Returns:
[ResultCode][Status message or command ID]
- StoreCalibrationJob(DevString) DevVarLongStringArray
- Parameter:
the frequency sweep ID this job refers to.
- Returns:
tuple of result code and message
- StoreFrequencySweep(DevString) DevVarLongStringArray
- Parameter:
the id of the station to store this frequency sweep for
- Returns:
tuple of result code and message
- StorePhaseFitParams(DevString) DevVarLongStringArray
- Parameter:
the calibration job ID these fit params belong to.
- Returns:
tuple of result code and message
- StoreSolution(DevString) DevVarLongStringArray
- Parameter:
Solution dataset
- Returns:
the solution or an empty list
- UpdateFrequencySweep(DevString) DevVarLongStringArray
- Parameter:
the sweep to update.
- Returns:
tuple of result code and message
- UpdateSelectionPolicy(DevString) DevVarLongStringArray
- Parameter:
name of the policy
- Returns:
a tuple containing the ResultCode and a message