From 6ccc5228569a82092b9459f8408b1dfae049c86a Mon Sep 17 00:00:00 2001
From: gscalamera <graziano.scalamera@elettra.eu>
Date: Mon, 17 Mar 2025 12:07:49 +0100
Subject: [PATCH] Fix table and add link
---
README.md | 3 +++
docs/AlarmHandler.md | 14 ++++++++------
2 files changed, 11 insertions(+), 6 deletions(-)
diff --git a/README.md b/README.md
index 50fccca..43dd04e 100644
--- a/README.md
+++ b/README.md
@@ -1,6 +1,9 @@
# Alarm-handler
Elettra alarm-handler Tango device
+## Documentation
+
+[Alarm-handler](docs/AlarmHandler.md)
## Building and Installation
diff --git a/docs/AlarmHandler.md b/docs/AlarmHandler.md
index fc961d5..947af6f 100644
--- a/docs/AlarmHandler.md
+++ b/docs/AlarmHandler.md
@@ -46,12 +46,14 @@ See [Formula.md](./Formula.md).
### Attributes
-* Dynamic Attributes
+#### Dynamic Attributes
+
| Name | Attr. type | R/W type | Data type | Description |
|------|:-----:|:-----:|:-----:|-----|
| AlarmState | Scalar | READ |DEV_ENUM <br>Labels: NORM, UNACK, ACKED, RTNUN, SHLVD, DSUPR, OOSRV, ERROR | Dynamically created with the tag name as the attribute name for each alarm |
-* Static Attributes
+#### Static Attributes
+
| Name | Attr. type | R/W type | Data type | Description |
|------|:-----:|:-----:|:-----:|-----|
| alarmAudible | Scalar | READ | DEV_BOOLEAN | True if there is at least one alarm that needs an audible indication on the GUI |
@@ -71,7 +73,7 @@ See [Formula.md](./Formula.md).
| eventList | Spectrum | READ | DEV_STRING | List of all attributes subscribed (attributes present in formulas) |
| eventSummary | Spectrum | READ | DEV_STRING | List of all attributes subscribed and their status. Format described below |
- * _alarm_
+* _alarm_
```
<timestamp seconds>\t<timestamp us>\t<tag>\t<ALARM|NORMAL|ERROR>\t<ACK|NACK>\t<priority>\t<silenced time>\t<group>\t<message>
Example:
@@ -79,13 +81,13 @@ See [Formula.md](./Formula.md).
1741280601 438811 pssip_ctf.03_ch3_off NORMAL NACK high 0 gr_vac sip_ctf.07 PS not ON
1741595157 64811 pssip_kg04.01_ch1_off ERROR ACK high 0 gr_vac Tango error for kg04/vacuum/pssip_kg04.01/stat1: Not valid status
```
- * _alarmDisabled_
+* _alarmDisabled_
```
<timestamp seconds>\t<timestamp us>\t<tag>\t<OOSRV|SHLVD>\t<ACK|NACK>\t<priority>\t<silenced time>\t<group>\t<message>
Example:
1740990965 41097 pssip_kg07.15_ch2_off OOSRV NACK high 0 gr_vac sip75_boc_l02.01 PS not ON
```
- * _alarmSummary_
+* _alarmSummary_
```
tag=<tag>;state=<state>;priority=<priority>;time=<date time us>;formula=<formula>;message=<message>;
Example:
@@ -93,7 +95,7 @@ See [Formula.md](./Formula.md).
tag=pssip_ctf.03_ch3_off;state=ACKED;priority=high;time=2025-03-06 18:03:21.438811;formula=(ctf/vacuum/pssip_ctf.03/state3!=ON);message=sip_ctf.07 PS not ON
tag=pssip_kg04.01_ch1_off;state=ERROR;priority=high;time=2025-03-10 09:25:57.64811;formula=(kg04/vacuum/pssip_kg04.01/stat1[0] == 0);message=sip02_kg04.01 PS not ON
```
- * _eventSummary_
+* _eventSummary_
```
event=<attribute fqdn>;time=<date time s>;values=<attribute values>;exception=<attribute exception>;quality=<attribute quality>;
Example:
--
GitLab