ItemAlarm
- Last UpdatedDec 16, 2023
- 3 minute read
The ItemAlarm node is used for handling alarms. The ItemAlarm node inherits from ItemStateDisplay.
An alarm is characterized by three possible states.
|
Alarm state |
Description |
|---|---|
|
Off |
Displays its OFF mesh. |
|
On |
Displays its ON mesh. |
|
Blinking |
Alternates display between ON and OFF meshes. |
Platform support
This node is fully supported on XR-Windows platform.
It is partially supported on XR-Portable Windows, XR-Portable iOS, XR-Portable Android, and XR-P WASM platforms.
Item integrated inspect animation is not supported. Label support is minimal.
|
XR-WIN |
XR-P-WIN |
XR-P-IOS |
XR-P-AND |
XR-P-WASM |
|---|---|---|---|---|
|
Full support |
Partial support |
Partial support |
Partial support |
Partial support |
|
|
|
|
|
|
Alarm types
The ItemAlarm node has several alarm logics that define the alarm behavior. The selected logic is defined by the type parameter.
direct
The alarm goes ON and Off in realtime depending on the value.
directReset
When the value goes from 0 to 1 (and the alarm is Off), the alarm turns On.
When the value is 0 (and the alarm is On) and it receives the reset event, the alarm turns Off.
blinkAck
-
If the alarm is Off and the value goes from 0 to 1, the alarm blinks.
-
If the value goes to 0 while blinking, the alarm continues to blink.
-
If the alarm is On when it receives the acknowledge event, it turns to On if the value is 1, or turns to Off if the value is 0.
-
If the alarm is On, it turns to Off when the value goes to 0.
blinkAckReset
-
If the alarm is Off and the value goes from 0 to 1, the alarm starts blinking.
-
If the value goes to 0 while blinking, the alarm continues to blink.
-
if the alarm receives the reset event when blinking, it continues to blink.
-
If the alarm is blinking when it receives the acknowledge event, it turns to On not depending on the value 0 or 1.
-
If the alarm is On and receives the reset event, it turns to Off if the value is 0.
Code example
This is a code example for ItemAlarm.
<ItemAlarm name="PDAH52025" type="blinkAckReset"/>
ItemAlarm Fields
These are the fields for ItemAlarm node. Only the node-specific fields are indicated, not fields obtained by inheritance.
Field inheritance: NodeBase > NodeBaseMovable > Item > ItemStateDisplay > ItemAlarm
|
Fields |
Type |
Use |
Default value |
Description |
|---|---|---|---|---|
|
acknowledge |
sevent |
Optional |
Not set |
When received, the alarm performs its acknowledge behavior according to its type. |
|
blinkTime |
sfloat |
Optional |
0.5 |
The blink interval, in seconds. |
|
emissiveMulRange |
svec2 |
Optional |
1 2 |
If alarm on/off is based on emissivity change rather than on mesh change, this value represents the material base/fEmissiveMul range. The first value is for Off state, the second value is for On state. |
|
lampState |
senum |
Read only |
Off |
The current alarm lamp state: off, on, or blink. |
|
overrideAlarm |
sbool |
Optional |
false |
When set to true, the lampState is overridden to On and the alarm appears On. When set to false, the alarm returns to its actual state. |
|
reset |
sevent |
Optional |
Not set |
When received, the alarm performs its reset behavior according to its type. |
|
type |
senum |
Optional |
blinckAck |
Defines the alarm type: direct, directReset, blinckAck, or blinckAckReset. |