SKA AlarmHandler

This module implements SKAAlarmHandler, a generic base device for Alarms for SKA. It exposes SKA alarms and SKA alerts as TANGO attributes. SKA Alarms and SKA/Element Alerts are rules-based configurable conditions that can be defined over multiple attribute values and quality factors, and are separate from the “built-in” TANGO attribute alarms.

class ska_tango_base.SKAAlarmHandler(*args, **kwargs)

A generic base device for Alarms for SKA.

AlarmConfigFile

Used by autodoc_mock_imports.

GetAlarmAdditionalInfo(argin)

Get additional alarm information.

To modify behaviour for this command, modify the do() method of the command class.

Parameters:argin – Name of the alarm Returns:JSON string containing additional alarm information

class GetAlarmAdditionalInfoCommand(target, state_model, logger=None)

A class for the SKAAlarmHandler’s GetAlarmAdditionalInfo() command.

do(argin)

Stateless hook for SKAAlarmHandler GetAlarmAdditionalInfo() command.

Returns:Alarm additional info Return type:JSON string

GetAlarmData(argin)

Get list of current value, quality factor and status of all attributes participating in the alarm rule.

To modify behaviour for this command, modify the do() method of the command class.

Parameters:argin – Name of the alarm Returns:JSON string containing alarm data

class GetAlarmDataCommand(target, state_model, logger=None)

A class for the SKAAlarmHandler’s GetAlarmData() command.

do(argin)

Stateless hook for SKAAlarmHandler GetAlarmData() command.

Returns:Alarm data Return type:JSON string

GetAlarmRule(argin)

Get all configuration info of the alarm, e.g. rule, defined action, etc.

To modify behaviour for this command, modify the do() method of the command class.

Parameters:argin – Name of the alarm Returns:JSON string containing configuration information of the alarm

class GetAlarmRuleCommand(target, state_model, logger=None)

A class for the SKAAlarmHandler’s GetAlarmRule() command.

do(argin)

Stateless hook for SKAAlarmHandler GetAlarmRule() command.

Returns:Alarm configuration info: rule, actions, etc. Return type:JSON string

GetAlarmStats()

Get current alarm stats.

To modify behaviour for this command, modify the do() method of the command class.

Returns:JSON string containing alarm statistics

class GetAlarmStatsCommand(target, state_model, logger=None)

A class for the SKAAlarmHandler’s GetAlarmStats() command.

do()

Stateless hook for SKAAlarmHandler GetAlarmStats() command.

Returns:Alarm stats Return type:JSON string

GetAlertStats()

Get current alert stats.

To modify behaviour for this command, modify the do() method of the command class.

Returns:JSON string containing alert statistics

class GetAlertStatsCommand(target, state_model, logger=None)

A class for the SKAAlarmHandler’s GetAlertStats() command.

do()

Stateless hook for SKAAlarmHandler GetAlertStats() command.

Returns:Alert stats Return type:JSON string

SubAlarmHandlers

Used by autodoc_mock_imports.

activeAlarms

Used by autodoc_mock_imports.

activeAlerts

Used by autodoc_mock_imports.

always_executed_hook()

Method that is always executed before any device command gets executed.

delete_device()

Method to cleanup when device is stopped.

init_command_objects()

Sets up the command objects

read_activeAlarms()

Reads list of active alarms. :return: List of active alarms

read_activeAlerts()

Reads list of active alerts. :return: List of active alerts

read_statsNrAlarms()

Reads number of active alarms. :return: Number of active alarms

read_statsNrAlerts()

Reads number of active alerts. :return: Number of active alerts

read_statsNrNewAlarms()

Reads number of new active alarms. :return: Number of new active alarms

read_statsNrRtnAlarms()

Reads number of returned alarms. :return: Number of returned alarms

read_statsNrUnackAlarms()

Reads number of unacknowledged alarms. :return: Number of unacknowledged alarms.

statsNrAlarms

Used by autodoc_mock_imports.

statsNrAlerts

Used by autodoc_mock_imports.

statsNrNewAlarms

Used by autodoc_mock_imports.

statsNrRtnAlarms

Used by autodoc_mock_imports.

statsNrUnackAlarms

Used by autodoc_mock_imports.