Device: DishLogger
Dish Logger device
Description
This device collects logs from other Dish devices and logs them according to the SKA logging format. All devices that can log are configured to log to this device by default.
The following attributes are set:
ElementLoggerEnabledDefault is set to True
LoggingTargetElementDefault is set to the DishLogger device
API
- class: DishLogger
meta:
commands:
- name: AbortCommands
disp_level: OPERATOR
doc_in: Uninitialised
doc_out: Uninitialised
dtype_in: DevVoid
dtype_out: DevVarLongStringArray
- name: CheckLongRunningCommandStatus
disp_level: OPERATOR
doc_in: Uninitialised
doc_out: Uninitialised
dtype_in: DevString
dtype_out: DevString
- name: DebugDevice
disp_level: OPERATOR
doc_in: Uninitialised
doc_out: The TCP port the debugger is listening on.
dtype_in: DevVoid
dtype_out: DevUShort
- name: GetVersionInfo
disp_level: OPERATOR
doc_in: Uninitialised
doc_out: Version strings
dtype_in: DevVoid
dtype_out: DevVarStringArray
- name: Init
disp_level: OPERATOR
doc_in: Uninitialised
doc_out: Uninitialised
dtype_in: DevVoid
dtype_out: DevVoid
- name: Log
disp_level: OPERATOR
doc_in: Uninitialised
doc_out: Consume a log message from TLS
dtype_in: DevVarStringArray
dtype_out: DevVoid
- name: 'Off'
disp_level: OPERATOR
doc_in: Uninitialised
doc_out: (ReturnType, 'informational message')
dtype_in: DevVoid
dtype_out: DevVarLongStringArray
- name: 'On'
disp_level: OPERATOR
doc_in: Uninitialised
doc_out: (ReturnType, 'informational message')
dtype_in: DevVoid
dtype_out: DevVarLongStringArray
- name: PushChanges
disp_level: OPERATOR
doc_in: Uninitialised
doc_out: Uninitialised
dtype_in: DevVoid
dtype_out: DevVoid
- name: RemoveDishLoggerTarget
disp_level: OPERATOR
doc_in: name of the device to remove new logging target
doc_out: Uninitialised
dtype_in: DevString
dtype_out: DevVoid
- name: Reset
disp_level: OPERATOR
doc_in: Uninitialised
doc_out: (ReturnType, 'informational message')
dtype_in: DevVoid
dtype_out: DevVarLongStringArray
- name: SetDishLoggerTarget
disp_level: OPERATOR
doc_in: name of the device to add new logging target
doc_out: Uninitialised
dtype_in: DevString
dtype_out: DevVoid
- name: Standby
disp_level: OPERATOR
doc_in: Uninitialised
doc_out: Uninitialised
dtype_in: DevVoid
dtype_out: DevVarLongStringArray
- name: State
disp_level: OPERATOR
doc_in: Uninitialised
doc_out: Device state
dtype_in: DevVoid
dtype_out: DevState
- name: Status
disp_level: OPERATOR
doc_in: Uninitialised
doc_out: Device status
dtype_in: DevVoid
dtype_out: DevString
attributes:
- name: State
data_format: SCALAR
data_type: DevState
description: No description
disp_level: OPERATOR
display_unit: No display unit
format: Not specified
label: State
max_alarm: Not specified
max_dim_x: 1
max_value: Not specified
min_alarm: Not specified
min_value: Not specified
standard_unit: No standard unit
writable: READ
writable_attr_name: None
- name: Status
data_format: SCALAR
data_type: DevString
description: No description
disp_level: OPERATOR
display_unit: No display unit
format: '%s'
label: Status
max_alarm: Not specified
max_dim_x: 1
max_value: Not specified
min_alarm: Not specified
min_value: Not specified
standard_unit: No standard unit
writable: READ
writable_attr_name: None
- name: adminMode
data_format: SCALAR
data_type: DevEnum
description: The admin mode reported for this device. It may interpret the current
device condition and condition of all managed devices to set this. Most possibly
an aggregate attribute.
disp_level: OPERATOR
display_unit: No display unit
enum_labels:
- ONLINE
- OFFLINE
- MAINTENANCE
- NOT_FITTED
- RESERVED
format: '%s'
label: adminMode
max_alarm: Not specified
max_dim_x: 1
max_value: Not specified
min_alarm: Not specified
min_value: Not specified
standard_unit: No standard unit
writable: READ_WRITE
writable_attr_name: adminMode
- name: buildState
data_format: SCALAR
data_type: DevString
description: Build state of this device
disp_level: OPERATOR
display_unit: No display unit
format: '%s'
label: buildState
max_alarm: Not specified
max_dim_x: 1
max_value: Not specified
min_alarm: Not specified
min_value: Not specified
standard_unit: No standard unit
writable: READ
writable_attr_name: None
- name: controlMode
data_format: SCALAR
data_type: DevEnum
description: "The control mode of the device. REMOTE, LOCAL\nTango Device accepts\
\ only from a \u2018local\u2019 client and ignores commands and queries received\
\ from TM or any other \u2018remote\u2019 clients. The Local clients has to\
\ release LOCAL control before REMOTE clients can take control again."
disp_level: OPERATOR
display_unit: No display unit
enum_labels:
- REMOTE
- LOCAL
format: '%s'
label: controlMode
max_alarm: Not specified
max_dim_x: 1
max_value: Not specified
min_alarm: Not specified
min_value: Not specified
standard_unit: No standard unit
writable: READ_WRITE
writable_attr_name: controlMode
- name: healthState
data_format: SCALAR
data_type: DevEnum
description: The health state reported for this device. It interprets the current
device condition and condition of all managed devices to set this. Most possibly
an aggregate attribute.
disp_level: OPERATOR
display_unit: No display unit
enum_labels:
- OK
- DEGRADED
- FAILED
- UNKNOWN
format: '%s'
label: healthState
max_alarm: Not specified
max_dim_x: 1
max_value: Not specified
min_alarm: Not specified
min_value: Not specified
standard_unit: No standard unit
writable: READ
writable_attr_name: None
- name: loggingLevel
data_format: SCALAR
data_type: DevEnum
description: Current logging level for this device - initialises to LoggingLevelDefault
on startup
disp_level: OPERATOR
display_unit: No display unit
enum_labels:
- 'OFF'
- FATAL
- ERROR
- WARNING
- INFO
- DEBUG
format: '%s'
label: loggingLevel
max_alarm: Not specified
max_dim_x: 1
max_value: Not specified
min_alarm: Not specified
min_value: Not specified
standard_unit: No standard unit
writable: READ_WRITE
writable_attr_name: loggingLevel
- name: loggingTargets
data_format: SPECTRUM
data_type: DevString
description: Logging targets for this device, excluding ska_ser_logging defaults
- initialises to LoggingTargetsDefault on startup
disp_level: OPERATOR
display_unit: No display unit
format: '%s'
label: loggingTargets
max_alarm: Not specified
max_dim_x: 4
max_value: Not specified
min_alarm: Not specified
min_value: Not specified
standard_unit: No standard unit
writable: READ_WRITE
writable_attr_name: loggingTargets
- name: longRunningCommandIDsInQueue
data_format: SPECTRUM
data_type: DevString
description: "Every client that executes a command will receive a command ID\
\ as response. \nKeep track of IDs in the queue. Pop off from front as they\
\ complete."
disp_level: OPERATOR
display_unit: No display unit
format: '%s'
label: longRunningCommandIDsInQueue
max_alarm: Not specified
max_dim_x: 64
max_value: Not specified
min_alarm: Not specified
min_value: Not specified
standard_unit: No standard unit
writable: READ
writable_attr_name: None
- name: longRunningCommandProgress
data_format: SPECTRUM
data_type: DevString
description: "ID, progress of the currently executing command. \nClients can\
\ subscribe to on_change event and wait for the ID they are interested in.."
disp_level: OPERATOR
display_unit: No display unit
format: '%s'
label: longRunningCommandProgress
max_alarm: Not specified
max_dim_x: 32
max_value: Not specified
min_alarm: Not specified
min_value: Not specified
standard_unit: No standard unit
writable: READ
writable_attr_name: None
- name: longRunningCommandResult
data_format: SPECTRUM
data_type: DevString
description: "unique_id, json-encoded result. \nClients can subscribe to on_change\
\ event and wait for the ID they are interested in."
disp_level: OPERATOR
display_unit: No display unit
format: '%s'
label: longRunningCommandResult
max_alarm: Not specified
max_dim_x: 2
max_value: Not specified
min_alarm: Not specified
min_value: Not specified
standard_unit: No standard unit
writable: READ
writable_attr_name: None
- name: longRunningCommandStatus
data_format: SPECTRUM
data_type: DevString
description: "ID, status pair of the currently executing command. \nClients\
\ can subscribe to on_change event and wait for the ID they are interested\
\ in."
disp_level: OPERATOR
display_unit: No display unit
format: '%s'
label: longRunningCommandStatus
max_alarm: Not specified
max_dim_x: 32
max_value: Not specified
min_alarm: Not specified
min_value: Not specified
standard_unit: No standard unit
writable: READ
writable_attr_name: None
- name: longRunningCommandsInQueue
data_format: SPECTRUM
data_type: DevString
description: "Keep track of which commands are in the queue. \nPop off from\
\ front as they complete."
disp_level: OPERATOR
display_unit: No display unit
format: '%s'
label: longRunningCommandsInQueue
max_alarm: Not specified
max_dim_x: 64
max_value: Not specified
min_alarm: Not specified
min_value: Not specified
standard_unit: No standard unit
writable: READ
writable_attr_name: None
- name: simulationMode
data_format: SCALAR
data_type: DevEnum
description: "Reports the simulation mode of the device. \nSome devices may\
\ implement both modes, while others will have simulators that set simulationMode\
\ to True while the real devices always set simulationMode to False."
disp_level: OPERATOR
display_unit: No display unit
enum_labels:
- 'FALSE'
- 'TRUE'
format: '%s'
label: simulationMode
max_alarm: Not specified
max_dim_x: 1
max_value: Not specified
min_alarm: Not specified
min_value: Not specified
standard_unit: No standard unit
writable: READ_WRITE
writable_attr_name: simulationMode
- name: testMode
data_format: SCALAR
data_type: DevEnum
description: "The test mode of the device. \nEither no test mode or an indication\
\ of the test mode."
disp_level: OPERATOR
display_unit: No display unit
enum_labels:
- NONE
- TEST
format: '%s'
label: testMode
max_alarm: Not specified
max_dim_x: 1
max_value: Not specified
min_alarm: Not specified
min_value: Not specified
standard_unit: No standard unit
writable: READ_WRITE
writable_attr_name: testMode
- name: versionId
data_format: SCALAR
data_type: DevString
description: Version Id of this device
disp_level: OPERATOR
display_unit: No display unit
format: '%s'
label: versionId
max_alarm: Not specified
max_dim_x: 1
max_value: Not specified
min_alarm: Not specified
min_value: Not specified
standard_unit: No standard unit
writable: READ
writable_attr_name: None
properties:
- name: polled_cmd