Code: |
AS + 524 |
Symbolic: |
bccAlarmHListE |
This command will get complete (or partial) enhanced alarm history from the remote device: this is a standard download transfer sequence.
REQDATA structure is the following:
Offset |
Type |
Label |
Description |
|---|---|---|---|
0 |
U32 |
FLAGS |
Query flags: 0x00000001 Query for extra parameters (ALPx)(#1) 0x00000002 Query for original alarm text 0x00000004 Disable query for alarm text 0x00000008 Query using extended alarm format 0x00000010 Query source text parameter index (#2) 0x00000020 Query source text in neutral language (#3) 0x00000040 Disable common prefixes for alarm text |
4 |
U32 |
FROMID |
First alarm history ID required |
8 |
U32 |
TOID |
Last alarm history ID required |
(#1) When the extended format is required, parameters are always queried.
(#2) Query of the source text parameter index is available only with the extended format and apply both to system and user text parameters.
(#3) Query source text in neutral language is available only if query for original alarm text (0x2) is active.
ACKDATA structure is the following:
Offset |
Type |
Label |
Description |
|---|---|---|---|
0 |
U32 |
COUNT |
Transfer items count (see download transfer sequence) |
4 |
U32 |
HSIZE |
History size (no. of storable alarms) |
8 |
U32 |
HID |
History content ID |
If initial request fails, bccNack is received. Specific errors
NACK code |
Description |
Extra data |
|---|---|---|
nackIllegalArgs |
Illegal parameters |
U16 What illegal: 1=Flags |
ITEMDATA structure is the following (in case of normal alarm format):
Offset |
Type |
Label |
Description |
|---|---|---|---|
0 |
U32 |
ID |
Alarm history ID |
4 |
U8 |
HH |
Time (hour) of the item |
5 |
U8 |
MM |
Time (minute) of the item |
6 |
U8 |
SS |
Time (second) of the item |
7 |
U8 |
DD |
Date (day) of the item |
8 |
U8 |
MO |
Data (month) of the item |
9 |
U8 |
YY |
Data (year - 2000) of the item |
10 |
U16 |
ALCODE |
Alarm code (0=none) |
12 |
U16 |
ALAXIS |
Alarm axis ID (0=none) |
14 |
U8[2] |
- |
(reserved) |
... |
DBL |
ALP1 |
Alarm extra parameter 1 (#1) |
... |
DBL |
ALP2 |
Alarm extra parameter 2 (#1) |
... |
DBL |
ALP3 |
Alarm extra parameter 3 (#1) |
... |
STRZ |
TEXT |
Alarm text (#2) |
(#1) Fields present only if FLAGS parameter contains 0x00000001 value.
(#2) Fields present only if FLAGS parameter does not contains 0x00000004 value.
ITEMDATA structure is the following (in case of extended alarm format):
Offset |
Type |
Label |
Description |
|---|---|---|---|
0 |
U32 |
ID |
Alarm history ID |
4 |
U8 |
HH |
Time (hour) of the item |
5 |
U8 |
MM |
Time (minute) of the item |
6 |
U8 |
SS |
Time (second) of the item |
7 |
U8 |
DD |
Date (day) of the item |
8 |
U8 |
MO |
Data (month) of the item |
9 |
U8 |
YY |
Data (year - 2000) of the item |
10 |
U16 |
ALCODE |
Alarm code (0=none) |
12 |
U16 |
ALAXIS |
Alarm axis ID (0=none) |
14 |
U8 |
NITEMS |
N. of alarm items |
15 |
.. |
ITEM0 |
Alarm item 0 |
... |
... |
ITEM1 |
Alarm item 1 |
... |
... |
ITEMn |
Alarm item N |
where every ITEMx structure is the following:
Offset |
Type |
Label |
Description |
|---|---|---|---|
+0 |
U8 |
TYPE |
Item type: 1 = Signed 8bit value (I8) 2 = Unsigned 8bit value (U8) 3 = Signed 16bit value (I16) 4 = Unsigned 16bit value (U16) 5 = Signed 32bit value (I32) 6 = Unsigned 32bit value (U32) 7 = Signed 64bit value (I64) 8 = Unsigned 64bit value (U64) 9 = Float value (FLT) 10 = Double value (DBL) 11 = String value (STRZ) 12 = Alarm text (STRZ) 13 = System source text parameter (I32) 14 = User source text parameter index (I32) |
+1 |
... |
DATA |
Item data (content and length according type) |
As general, you can get items with the following order:
•from OLDID to NEWID for native order.
•from NEWID to OLDID for reversed order.
When using RTE version 33.16.x (or lower), you should consider two different cases:
1.NEWID is greater/equal than OLDID.
2.NEWID is less than OLDID.
In case 1, you can get items with a single request, as:
•from OLDID to NEWID for native order.
•from NEWID to OLDID for reversed order.
In case 2, you must get items with two different request, as:
•from OLDID to 0xFFFFFFFF and from 0 to NEWID for native order.
•form NEWID to 0 and from 0xFFFFFFFF to OLDID for reversed order.
