Code: |
AS + 520 |
Symbolic: |
bccAlarmSGet |
This command will query a single alarm stack entry from the connected device. Request has the following parameters:
Offset |
Type |
Label |
Description |
|---|---|---|---|
0 |
U32 |
FLAGS |
Query flags: 0x00000001 Query for extra parameters (ALPx)(#1) 0x00000002 Query for original alarm text only 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 |
ALIX |
Alarm index (1-ASCAP, see bccAlarmSInfo) |
(#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.
On success, a bccAck is received with following data (in case of normal alarm format):
Offset |
Type |
Label |
Description |
|---|---|---|---|
0 |
U32 |
ALIX |
Alarm index (1-ASCAP) |
4 |
U32 |
CODE |
Alarm code |
8 |
DBL |
ALP1 |
Alarm extra parameter 1 |
16 |
DBL |
ALP2 |
Alarm extra parameter 2 |
24 |
DBL |
ALP3 |
Alarm extra parameter 3 |
32 |
U8[8] |
- |
Reserved |
40 |
STRZ |
TEXT |
Alarm text |
or with the following structure (in case of extended alarm format):
Offset |
Type |
Label |
Description |
|---|---|---|---|
0 |
U32 |
ALIX |
Alarm index (1-ASCAP) |
4 |
U32 |
CODE |
Alarm code (0=none) |
8 |
U8 |
NITEMS |
N. of alarm items |
9 |
.. |
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 index (I32) 14 = User source text parameter index (I32) |
+1 |
... |
DATA |
Item data (content and length according type) |
In case of RTE firmware (see bccSysInfo, FIRMWTYPE=8), the CODE field contains the following data:
Offset |
Type |
Label |
Description |
|---|---|---|---|
0 |
U16 |
ALCODE |
RTE alarm code (0=none) |
2 |
U16 |
ALAXIS |
RTE alarm axis ID (0=none) |
On failure, a bccNack is received.
