diff --git a/skabase/SKAAlarmHandler/SKAAlarmHandler/SKAAlarmHandler.py b/skabase/SKAAlarmHandler/SKAAlarmHandler/SKAAlarmHandler.py index cf4196931a625f4321c59e65fcb682f16ca15c29..7f575aab99fa0222bc30bbbb5326c3c07f038bff 100644 --- a/skabase/SKAAlarmHandler/SKAAlarmHandler/SKAAlarmHandler.py +++ b/skabase/SKAAlarmHandler/SKAAlarmHandler/SKAAlarmHandler.py @@ -7,7 +7,9 @@ """ SKAAlarmHandler -A generic base device for Alarms for SKA. +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. """ # tango imports diff --git a/skabase/SKABaseDevice/SKABaseDevice/SKABaseDevice.py b/skabase/SKABaseDevice/SKABaseDevice/SKABaseDevice.py index 859400c4e866153ad60e2b0784d8cdef9af807a5..425e4305698b549c66ddadcb6de9317cb8898e18 100644 --- a/skabase/SKABaseDevice/SKABaseDevice/SKABaseDevice.py +++ b/skabase/SKABaseDevice/SKABaseDevice/SKABaseDevice.py @@ -7,7 +7,7 @@ """ SKABASE -A generic base device for SKA. +A generic base device for SKA. It exposes the generic attributes, properties and commands of an SKA device. """ # tango imports diff --git a/skabase/SKACapability/SKACapability/SKACapability.py b/skabase/SKACapability/SKACapability/SKACapability.py index e9658ecae95dd5b038a60b04bdfa83e26b130eab..2c1f3625e5a7b6f492f8dfc74af3cbd6c26fd1e3 100644 --- a/skabase/SKACapability/SKACapability/SKACapability.py +++ b/skabase/SKACapability/SKACapability/SKACapability.py @@ -23,7 +23,7 @@ __all__ = ["SKACapability", "main"] class SKACapability(SKAObsDevice): """ - Subarray handling device + A Subarray handling device. It exposes the instances of configured capabilities. """ __metaclass__ = DeviceMeta # PROTECTED REGION ID(SKACapability.class_variable) ENABLED START # diff --git a/skabase/SKALogger/SKALogger/SKALogger.py b/skabase/SKALogger/SKALogger/SKALogger.py index 78ae83c626df3fde56511dc91bd989d781ca787b..5a1c30f34aa9656b5108033e2617c6bbdaea13ed 100644 --- a/skabase/SKALogger/SKALogger/SKALogger.py +++ b/skabase/SKALogger/SKALogger/SKALogger.py @@ -8,7 +8,8 @@ """ SKALogger -A generic base device for Logging for SKA. +A generic base device for Logging for SKA. It enables to view on-line logs through the TANGO Logging Services + and to store logs using Python logging. It configures the log levels of remote logging for selected devices. """ # tango imports diff --git a/skabase/SKAObsDevice/SKAObsDevice/SKAObsDevice.py b/skabase/SKAObsDevice/SKAObsDevice/SKAObsDevice.py index 5034d641b93d3d4601ec6d304dc2a6a9a94d2221..d004456855435c64e09d93f3dd52cdfcb724df2d 100644 --- a/skabase/SKAObsDevice/SKAObsDevice/SKAObsDevice.py +++ b/skabase/SKAObsDevice/SKAObsDevice/SKAObsDevice.py @@ -7,7 +7,8 @@ """ SKAObsDevice -A generic base device for Observations for SKA. +A generic base device for Observations for SKA. It inherits SKABaseDevice class. Any device implementing +and obsMode will inherit from SKAObsDevice instead of just SKABaseDevice. """ # tango imports diff --git a/skabase/SKASubarray/SKASubarray/SKASubarray.py b/skabase/SKASubarray/SKASubarray/SKASubarray.py index 8297abb0afdba2c62400aaca67132723bda758e9..a52e11b80b31b820bf4d757a780bbe090d557ffe 100644 --- a/skabase/SKASubarray/SKASubarray/SKASubarray.py +++ b/skabase/SKASubarray/SKASubarray/SKASubarray.py @@ -7,7 +7,8 @@ """ SKASubarray -SubArray handling device +A SubArray handling device. It allows the assigning/releasing of resources into/from Subarray, configuring +capabilities, and exposes the related information like assigned resources, configured capabilities, etc. """ # tango imports