SKA Tango Base
1.2.0
How-To Guides
Getting started
How to implement a long running command
How to invoke a long running command
How to use the logger
Concepts
Components and component managers
Logging configuration
Long Running Commands
Guidelines on reporting failure of long running commands
Reference
Long Running Command client/server interface
commandedState and commandedObsState attributes
API
Releases
Migrating to 1.0
Migrating to 1.2
Changelog
SKA Tango Base
Index
Index
A
|
B
|
C
|
D
|
E
|
F
|
G
|
H
|
I
|
J
|
L
|
M
|
N
|
O
|
P
|
Q
|
R
|
S
|
T
|
U
|
V
|
W
A
abort() (BaseComponentManager method)
Abort() (SKABaseDevice method)
abort() (TaskExecutor method)
abort_commands() (BaseComponentManager method)
abort_tasks() (BaseComponentManager method)
(TaskExecutorComponentManager method)
AbortCommands() (SKABaseDevice method)
ABORTED (ResultCode attribute)
(TaskStatus attribute)
activationTime() (SKACapability method)
(SKASubarray method)
,
[1]
activeAlarms() (SKAAlarmHandler method)
activeAlerts() (SKAAlarmHandler method)
add_attribute() (SKABaseDevice method)
adminMode() (SKABaseDevice method)
AlarmHandlerComponentManager (class in ska_tango_base.alarm_handler_device)
ArgumentValidator (class in ska_tango_base.commands)
assign() (FakeSubarrayComponent method)
(ReferenceSubarrayComponentManager method)
(SubarrayComponentManager method)
assigned_resources (ReferenceSubarrayComponentManager property)
(SubarrayComponentManager property)
assignedResources() (SKASubarray method)
,
[1]
AssignResources() (SKASubarray method)
,
[1]
availableCapabilities() (SKAController method)
B
BaseComponentManager (class in ska_tango_base.base.base_component_manager)
buildState() (SKABaseDevice method)
C
CapabilityComponentManager (class in ska_tango_base.capability_device)
CapabilityValidationError
check_communicating() (in module ska_tango_base.base.base_component_manager)
check_on() (in module ska_tango_base.base.base_component_manager)
CheckLongRunningCommandStatus() (SKABaseDevice method)
coerce_value() (in module ska_tango_base.utils)
command_exception (CommandTracker property)
command_id (LrcSubscriptions property)
command_progresses (CommandTracker property)
command_result (CommandTracker property)
command_statuses (CommandTracker property)
commandedObsState() (SKAObsDevice method)
commandedState() (SKABaseDevice method)
CommandError
commands_in_queue (CommandTracker property)
CommandTracker (class in ska_tango_base.base.command_tracker)
CommandTrackerProtocol (class in ska_tango_base.commands)
communication_state (BaseComponentManager property)
COMPLETED (TaskStatus attribute)
component_state (BaseComponentManager property)
ComponentError
ComponentFault
configurationDelayExpected() (SKAObsDevice method)
configurationProgress() (SKAObsDevice method)
configure() (FakeSubarrayComponent method)
(ReferenceSubarrayComponentManager method)
Configure() (SKASubarray method)
,
[1]
configure() (SubarrayComponentManager method)
configured_capabilities (FakeSubarrayComponent property)
(ReferenceSubarrayComponentManager property)
(SubarrayComponentManager property)
configuredCapabilities() (SKASubarray method)
,
[1]
configuredInstances() (SKACapability method)
ConfigureInstances() (SKACapability method)
ControllerComponentManager (class in ska_tango_base.controller_device)
controlMode() (SKABaseDevice method)
convert_api_value() (in module ska_tango_base.utils)
convert_dict_to_list() (in module ska_tango_base.utils)
create_component_manager() (SKAAlarmHandler method)
(SKABaseDevice method)
(SKACapability method)
(SKAController method)
(SKALogger method)
(SKAObsDevice method)
(SKASubarray method)
,
[1]
(SKATelState method)
create_logging_handler() (LoggingUtils static method)
D
DebugDevice() (SKABaseDevice method)
deconfigure() (FakeSubarrayComponent method)
(ReferenceSubarrayComponentManager method)
(SubarrayComponentManager method)
deprecate_kwarg() (in module ska_tango_base.utils)
DeviceInitCommand (class in ska_tango_base.commands)
do() (SKAAlarmHandler.GetAlarmAdditionalInfoCommand method)
(SKAAlarmHandler.GetAlarmDataCommand method)
(SKAAlarmHandler.GetAlarmRuleCommand method)
(SKAAlarmHandler.GetAlarmStatsCommand method)
(SKAAlarmHandler.GetAlertStatsCommand method)
(SKABaseDevice.AbortCommand method)
(SKABaseDevice.AbortCommandsCommand method)
(SKABaseDevice.CheckLongRunningCommandStatusCommand method)
(SKABaseDevice.DebugDeviceCommand method)
(SKABaseDevice.InitCommand method)
(SKACapability.ConfigureInstancesCommand method)
(SKACapability.InitCommand method)
(SKAController.InitCommand method)
(SKAController.IsCapabilityAchievableCommand method)
(SKALogger.SetLoggingLevelCommand method)
(SKAObsDevice.InitCommand method)
(SKASubarray.InitCommand method)
,
[1]
(SubmittedSlowCommand method)
dp_set_property() (in module ska_tango_base.utils)
E
elementAlarmAddress() (SKAController method)
elementDatabaseAddress() (SKAController method)
elementLoggerAddress() (SKAController method)
elementTelStateAddress() (SKAController method)
emit() (TangoLoggingServiceHandler method)
End() (SKASubarray method)
,
[1]
end_scan() (FakeSubarrayComponent method)
(ReferenceSubarrayComponentManager method)
(SubarrayComponentManager method)
EndScan() (SKASubarray method)
,
[1]
evict_command() (CommandTracker method)
exception_manager() (in module ska_tango_base.utils)
ExecutePendingOperations() (SKABaseDevice method)
F
FAILED (ResultCode attribute)
(TaskStatus attribute)
FakeBaseComponent (class in ska_tango_base.testing.reference.reference_base_component_manager)
FakeSubarrayComponent (class in ska_tango_base.testing.reference.reference_subarray_component_manager)
FastCommand (class in ska_tango_base.commands)
fault_state (GenericBaseComponentManager property)
faulty (FakeBaseComponent property)
for_testing_only() (in module ska_tango_base.utils)
G
generate_command_id() (in module ska_tango_base.utils)
GenericBaseComponentManager (class in ska_tango_base.testing.reference.reference_base_component_manager)
get_all_methods() (SKABaseDevice.DebugDeviceCommand method)
get_command_object() (SKABaseDevice method)
get_command_status() (CommandTracker method)
get_dev_info() (in module ska_tango_base.utils)
get_device_group_and_id() (in module ska_tango_base.utils)
get_dp_attribute() (in module ska_tango_base.utils)
get_dp_command() (in module ska_tango_base.utils)
get_groups_from_json() (in module ska_tango_base.utils)
get_input_queue_size() (TaskExecutor method)
get_request() (PollingComponentManager method)
(PollModel method)
get_syslog_address_and_socktype() (LoggingUtils static method)
get_tango_device_type_id() (in module ska_tango_base.utils)
GetAlarmAdditionalInfo() (SKAAlarmHandler method)
GetAlarmData() (SKAAlarmHandler method)
GetAlarmRule() (SKAAlarmHandler method)
GetAlarmStats() (SKAAlarmHandler method)
GetAlertStats() (SKAAlarmHandler method)
GetVersionInfo() (SKABaseDevice method)
GroupDefinitions (SKABaseDevice attribute)
GroupDefinitionsError
H
has_current_thread_locked() (CommandTracker method)
healthState() (SKABaseDevice method)
I
IN_PROGRESS (TaskStatus attribute)
init_command_objects() (SKAAlarmHandler method)
(SKABaseDevice method)
(SKACapability method)
(SKAController method)
(SKALogger method)
(SKASubarray method)
,
[1]
init_device() (SKABaseDevice method)
invoke() (FastCommand method)
(SlowCommand method)
invoke_lrc() (in module ska_tango_base.long_running_commands_api)
is_Abort_allowed() (SKASubarray method)
,
[1]
is_AssignResources_allowed() (SKASubarray method)
,
[1]
is_Configure_allowed() (SKASubarray method)
,
[1]
is_End_allowed() (SKASubarray method)
,
[1]
is_EndScan_allowed() (SKASubarray method)
,
[1]
is_ObsReset_allowed() (SKASubarray method)
,
[1]
is_Off_allowed() (SKABaseDevice method)
is_On_allowed() (SKABaseDevice method)
is_ReleaseAllResources_allowed() (SKASubarray method)
,
[1]
is_ReleaseResources_allowed() (SKASubarray method)
,
[1]
is_Reset_allowed() (SKABaseDevice method)
is_Restart_allowed() (SKASubarray method)
,
[1]
is_Scan_allowed() (SKASubarray method)
,
[1]
is_Standby_allowed() (SKABaseDevice method)
IsCapabilityAchievable() (SKAController method)
J
JSONData (in module ska_tango_base.base.base_component_manager)
JsonValidator (class in ska_tango_base.commands)
L
LoggerComponentManager (class in ska_tango_base.logger_device)
loggingLevel() (SKABaseDevice method)
LoggingLevelDefault (SKABaseDevice attribute)
LoggingLevelError
LoggingTargetError
loggingTargets() (SKABaseDevice method)
LoggingTargetsDefault (SKABaseDevice attribute)
LoggingUtils (class in ska_tango_base.base.logging)
longRunningCommandIDsInQueue() (SKABaseDevice method)
longRunningCommandInProgress() (SKABaseDevice method)
longRunningCommandProgress() (SKABaseDevice method)
longRunningCommandResult() (SKABaseDevice method)
longRunningCommandsInQueue() (SKABaseDevice method)
longRunningCommandStatus() (SKABaseDevice method)
LrcCallback (class in ska_tango_base.long_running_commands_api)
lrcExecuting() (SKABaseDevice method)
lrcFinished() (SKABaseDevice method)
lrcProtocolVersions() (SKABaseDevice method)
lrcQueue() (SKABaseDevice method)
LrcSubscriptions (class in ska_tango_base.long_running_commands_api)
M
main() (in module ska_tango_base.alarm_handler_device)
(in module ska_tango_base.base.base_device)
(in module ska_tango_base.capability_device)
(in module ska_tango_base.controller_device)
(in module ska_tango_base.logger_device)
(in module ska_tango_base.obs.obs_device)
(in module ska_tango_base.subarray.subarray_device)
(in module ska_tango_base.tel_state_device)
(in module ska_tango_base.testing.reference.reference_subarray_device)
max_executing_tasks (BaseComponentManager property)
max_queued_tasks (BaseComponentManager property)
(TaskExecutorComponentManager property)
maxCapabilities() (SKAController method)
method_must_be_patched_for_debugger() (SKABaseDevice.DebugDeviceCommand static method)
module
ska_tango_base
ska_tango_base.alarm_handler_device
ska_tango_base.base
ska_tango_base.base.admin_mode_model
ska_tango_base.base.base_component_manager
ska_tango_base.base.base_device
ska_tango_base.base.command_tracker
ska_tango_base.base.logging
ska_tango_base.base.op_state_model
ska_tango_base.capability_device
ska_tango_base.commands
ska_tango_base.control_model
ska_tango_base.controller_device
ska_tango_base.executor
ska_tango_base.executor.executor
ska_tango_base.executor.executor_component_manager
ska_tango_base.faults
ska_tango_base.logger_device
ska_tango_base.long_running_commands_api
ska_tango_base.obs
ska_tango_base.obs.obs_device
ska_tango_base.obs.obs_state_model
ska_tango_base.poller
ska_tango_base.poller.poller
ska_tango_base.poller.polling_component_manager
ska_tango_base.subarray
ska_tango_base.subarray.subarray_component_manager
ska_tango_base.subarray.subarray_device
ska_tango_base.tel_state_device
ska_tango_base.testing
ska_tango_base.testing.reference
ska_tango_base.testing.reference.reference_base_component_manager
ska_tango_base.testing.reference.reference_subarray_component_manager
ska_tango_base.testing.reference.reference_subarray_device
ska_tango_base.utils
monkey_patch_all_methods_for_debugger() (SKABaseDevice.DebugDeviceCommand method)
N
new_command() (CommandTracker method)
(CommandTrackerProtocol method)
NOT_ALLOWED (ResultCode attribute)
NOT_FOUND (TaskStatus attribute)
O
ObsDeviceComponentManager (class in ska_tango_base.obs.obs_device)
obsMode() (SKAObsDevice method)
obsreset() (FakeSubarrayComponent method)
(ReferenceSubarrayComponentManager method)
ObsReset() (SKASubarray method)
,
[1]
obsreset() (SubarrayComponentManager method)
obsState() (SKAObsDevice method)
off() (BaseComponentManager method)
(FakeBaseComponent method)
(GenericBaseComponentManager method)
Off() (SKABaseDevice method)
OK (ResultCode attribute)
on() (BaseComponentManager method)
(FakeBaseComponent method)
(GenericBaseComponentManager method)
On() (SKABaseDevice method)
P
P (in module ska_tango_base.utils)
patch_method_for_debugger() (SKABaseDevice.DebugDeviceCommand method)
poll() (PollingComponentManager method)
(PollModel method)
poll_failed() (PollingComponentManager method)
(PollModel method)
poll_succeeded() (PollingComponentManager method)
(PollModel method)
Poller (class in ska_tango_base.poller.poller)
polling_started() (PollingComponentManager method)
(PollModel method)
polling_stopped() (PollingComponentManager method)
(PollModel method)
PollingComponentManager (class in ska_tango_base.poller.polling_component_manager)
PollModel (class in ska_tango_base.poller.poller)
PollRequestT (class in ska_tango_base.poller.poller)
PollResponseT (class in ska_tango_base.poller.poller)
power_state (FakeBaseComponent property)
(GenericBaseComponentManager property)
protocol_version (LrcSubscriptions property)
push_archive_event() (SKABaseDevice method)
push_change_event() (SKABaseDevice method)
Q
QUEUED (ResultCode attribute)
(TaskStatus attribute)
R
ReferenceBaseComponentManager (class in ska_tango_base.testing.reference.reference_base_component_manager)
ReferenceSubarrayComponentManager (class in ska_tango_base.testing.reference.reference_subarray_component_manager)
register_command_object() (SKABaseDevice method)
REJECTED (ResultCode attribute)
(TaskStatus attribute)
release() (FakeSubarrayComponent method)
(ReferenceSubarrayComponentManager method)
(SubarrayComponentManager method)
release_all() (FakeSubarrayComponent method)
(ReferenceSubarrayComponentManager method)
(SubarrayComponentManager method)
ReleaseAllResources() (SKASubarray method)
,
[1]
ReleaseResources() (SKASubarray method)
,
[1]
report_progress_message() (FakeBaseComponent method)
(GenericBaseComponentManager method)
reset() (BaseComponentManager method)
(FakeBaseComponent method)
(GenericBaseComponentManager method)
Reset() (SKABaseDevice method)
restart() (FakeSubarrayComponent method)
(ReferenceSubarrayComponentManager method)
Restart() (SKASubarray method)
,
[1]
restart() (SubarrayComponentManager method)
ResultCode (class in ska_tango_base.commands)
ResultCodeError
S
sanitise_logging_targets() (LoggingUtils static method)
scan() (FakeSubarrayComponent method)
(ReferenceSubarrayComponentManager method)
Scan() (SKASubarray method)
,
[1]
scan() (SubarrayComponentManager method)
set_change_event() (SKABaseDevice method)
set_logging_level() (SKABaseDevice method)
set_logging_targets() (SKABaseDevice method)
set_state() (SKABaseDevice method)
set_state_change_callback() (FakeBaseComponent method)
set_status() (SKABaseDevice method)
SetLoggingLevel() (SKALogger method)
simulate_command_error() (FakeBaseComponent method)
(GenericBaseComponentManager method)
simulate_communication_failure() (GenericBaseComponentManager method)
simulate_fault() (FakeBaseComponent method)
simulate_is_cmd_allowed_error() (FakeBaseComponent method)
(GenericBaseComponentManager method)
simulate_obsfault() (FakeSubarrayComponent method)
simulate_power_state() (FakeBaseComponent method)
simulate_scan_stopped() (FakeSubarrayComponent method)
simulationMode() (SKABaseDevice method)
ska_tango_base
module
ska_tango_base.alarm_handler_device
module
ska_tango_base.base
module
ska_tango_base.base.admin_mode_model
module
ska_tango_base.base.base_component_manager
module
ska_tango_base.base.base_device
module
ska_tango_base.base.command_tracker
module
ska_tango_base.base.logging
module
ska_tango_base.base.op_state_model
module
ska_tango_base.capability_device
module
ska_tango_base.commands
module
ska_tango_base.control_model
module
ska_tango_base.controller_device
module
ska_tango_base.executor
module
ska_tango_base.executor.executor
module
ska_tango_base.executor.executor_component_manager
module
ska_tango_base.faults
module
ska_tango_base.logger_device
module
ska_tango_base.long_running_commands_api
module
ska_tango_base.obs
module
ska_tango_base.obs.obs_device
module
ska_tango_base.obs.obs_state_model
module
ska_tango_base.poller
module
ska_tango_base.poller.poller
module
ska_tango_base.poller.polling_component_manager
module
ska_tango_base.subarray
module
ska_tango_base.subarray.subarray_component_manager
module
ska_tango_base.subarray.subarray_device
module
ska_tango_base.tel_state_device
module
ska_tango_base.testing
module
ska_tango_base.testing.reference
module
ska_tango_base.testing.reference.reference_base_component_manager
module
ska_tango_base.testing.reference.reference_subarray_component_manager
module
ska_tango_base.testing.reference.reference_subarray_device
module
ska_tango_base.utils
module
SKAAlarmHandler (class in ska_tango_base.alarm_handler_device)
SKAAlarmHandler.GetAlarmAdditionalInfoCommand (class in ska_tango_base.alarm_handler_device)
SKAAlarmHandler.GetAlarmDataCommand (class in ska_tango_base.alarm_handler_device)
SKAAlarmHandler.GetAlarmRuleCommand (class in ska_tango_base.alarm_handler_device)
SKAAlarmHandler.GetAlarmStatsCommand (class in ska_tango_base.alarm_handler_device)
SKAAlarmHandler.GetAlertStatsCommand (class in ska_tango_base.alarm_handler_device)
SKABaseDevice (class in ska_tango_base.base.base_device)
SKABaseDevice.AbortCommand (class in ska_tango_base.base.base_device)
SKABaseDevice.AbortCommandsCommand (class in ska_tango_base.base.base_device)
SKABaseDevice.CheckLongRunningCommandStatusCommand (class in ska_tango_base.base.base_device)
SKABaseDevice.DebugDeviceCommand (class in ska_tango_base.base.base_device)
SKABaseDevice.InitCommand (class in ska_tango_base.base.base_device)
SKABaseError
SKACapability (class in ska_tango_base.capability_device)
SKACapability.ConfigureInstancesCommand (class in ska_tango_base.capability_device)
SKACapability.InitCommand (class in ska_tango_base.capability_device)
SKAController (class in ska_tango_base.controller_device)
SKAController.InitCommand (class in ska_tango_base.controller_device)
SKAController.IsCapabilityAchievableCommand (class in ska_tango_base.controller_device)
SkaLevel (SKABaseDevice attribute)
SKALogger (class in ska_tango_base.logger_device)
SKALogger.SetLoggingLevelCommand (class in ska_tango_base.logger_device)
SKAObsDevice (class in ska_tango_base.obs.obs_device)
SKAObsDevice.InitCommand (class in ska_tango_base.obs.obs_device)
SKASubarray (class in ska_tango_base.subarray.subarray_device)
(class in ska_tango_base.testing.reference.reference_subarray_device)
SKASubarray.AssignResourcesCommand (class in ska_tango_base.subarray.subarray_device)
(class in ska_tango_base.testing.reference.reference_subarray_device)
SKASubarray.ConfigureCommand (class in ska_tango_base.subarray.subarray_device)
(class in ska_tango_base.testing.reference.reference_subarray_device)
SKASubarray.EndCommand (class in ska_tango_base.subarray.subarray_device)
(class in ska_tango_base.testing.reference.reference_subarray_device)
SKASubarray.EndScanCommand (class in ska_tango_base.subarray.subarray_device)
(class in ska_tango_base.testing.reference.reference_subarray_device)
SKASubarray.InitCommand (class in ska_tango_base.subarray.subarray_device)
(class in ska_tango_base.testing.reference.reference_subarray_device)
SKASubarray.ObsResetCommand (class in ska_tango_base.subarray.subarray_device)
(class in ska_tango_base.testing.reference.reference_subarray_device)
SKASubarray.ReleaseAllResourcesCommand (class in ska_tango_base.subarray.subarray_device)
(class in ska_tango_base.testing.reference.reference_subarray_device)
SKASubarray.ReleaseResourcesCommand (class in ska_tango_base.subarray.subarray_device)
(class in ska_tango_base.testing.reference.reference_subarray_device)
SKASubarray.RestartCommand (class in ska_tango_base.subarray.subarray_device)
(class in ska_tango_base.testing.reference.reference_subarray_device)
SKASubarray.ScanCommand (class in ska_tango_base.subarray.subarray_device)
(class in ska_tango_base.testing.reference.reference_subarray_device)
SKATelState (class in ska_tango_base.tel_state_device)
SlowCommand (class in ska_tango_base.commands)
STAGING (TaskStatus attribute)
standby() (BaseComponentManager method)
(FakeBaseComponent method)
(GenericBaseComponentManager method)
Standby() (SKABaseDevice method)
start_communicating() (BaseComponentManager method)
(GenericBaseComponentManager method)
(PollingComponentManager method)
start_debugger_and_get_port() (SKABaseDevice.DebugDeviceCommand method)
start_polling() (Poller method)
STARTED (ResultCode attribute)
StateModelError
statsNrAlarms() (SKAAlarmHandler method)
statsNrAlerts() (SKAAlarmHandler method)
statsNrNewAlarms() (SKAAlarmHandler method)
statsNrRtnAlarms() (SKAAlarmHandler method)
statsNrUnackAlarms() (SKAAlarmHandler method)
stop_communicating() (BaseComponentManager method)
(GenericBaseComponentManager method)
(PollingComponentManager method)
stop_polling() (Poller method)
SubarrayComponentManager (class in ska_tango_base.subarray.subarray_component_manager)
submit() (TaskExecutor method)
submit_task() (TaskExecutorComponentManager method)
SubmittedSlowCommand (class in ska_tango_base.commands)
T
T (class in ska_tango_base.utils)
TangoLoggingServiceHandler (class in ska_tango_base.base.logging)
TaskCallbackType (class in ska_tango_base.base.base_component_manager)
TaskExecutor (class in ska_tango_base.executor.executor)
TaskExecutorComponentManager (class in ska_tango_base.executor.executor_component_manager)
TaskStatus (class in ska_tango_base.executor.executor)
TelStateComponentManager (class in ska_tango_base.tel_state_device)
testMode() (SKABaseDevice method)
U
UNKNOWN (ResultCode attribute)
update_command_info() (CommandTracker method)
(CommandTrackerProtocol method)
update_logging_handlers() (LoggingUtils static method)
usedComponents() (SKACapability method)
V
validate() (ArgumentValidator method)
(JsonValidator method)
validate_capability_types() (in module ska_tango_base.utils)
validate_input_sizes() (in module ska_tango_base.utils)
versionId() (SKABaseDevice method)
W
wait_until_done() (in module ska_tango_base.testing.reference.reference_base_component_manager)