| date | desc |
|---|---|
| 2 aug 2022 | Initial |
| 15 aug 2022 | Expanded category variations and added PBX |
| 30 Aug 2022 | Added PBX.7 and PBX.8, shifted values |
Most events in this list can be sent to ICON Signals using the external events API. Some of them can also be represented by virtual devices within the Signals sensor grid in order to hold state information and potentially escalate a raised signal.
The code value is used when creating and looking up virtual devices. It is not dependant on the external system details and is only used internally within Signals.
Some amount of bit-level logic is involved.
0x001 category variation 1
0x002 category variation 2
0x003 category variation 3
0x004 category variation 4
0x005 category variation 5
0x006 category variation 6
0x007 category variation 7
0x008 SRP (lockdown, e911, evac, shelter, lockout)
0x010 medical
0x020 security
0x040 alert
0x080 pbx
0x100 reserved
0x200 reserved
0x400 clear bit
0x7FF all clear
| name | code | hex | definition / use |
|---|---|---|---|
| LOCKDOWN | 8 | 0x008 |
Lockdown / Active Shooter (SRP) |
| E911 | 9 | 0x009 |
Emergency Call Made (generated from PBX events) |
| EVACUATE | 10 | 0x00A |
Evacuate (SRP) |
| SHELTER | 11 | 0x00B |
Hazard and Safety Strategy (SRP) |
| LOCKOUT | 12 | 0x00C |
Lockout / Secure Bldg(s) (SRP) |
| MEDICAL | 16 | 0x010 |
Medical Primary |
| MEDICAL2 | 17 | 0x011 |
Medical Secondary |
| MEDICAL3 | 18 | 0x012 |
Medical Tertiary |
| SECURITY | 32 | 0x020 |
Security Primary |
| SECURITY2 | 33 | 0x021 |
Security Secondary |
| SECURITY3 | 34 | 0x022 |
Security Tertiary |
| ALERT | 64 | 0x040 |
Generic Alert (e.g. environmental device or system in alarm mode) |
| ALERT2 | 65 | 0x041 |
Alert Secondary |
| ALERT3 | 66 | 0x042 |
Alert Tertiary |
| PBX1 | 128 | 0x080 |
PBX Index 1 |
| PBX2 | 129 | 0x081 |
PBX Index 2 |
| PBX3 | 130 | 0x082 |
PBX Index 3 |
| PBX4 | 131 | 0x083 |
PBX Index 4 |
| PBX5 | 132 | 0x084 |
PBX Index 5 |
| PBX6 | 133 | 0x085 |
PBX Index 6 |
| PBX7 | 134 | 0x086 |
PBX Index 7 |
| PBX8 | 135 | 0x087 |
PBX Index 8 |
| CLEAR (base) | 1024 | 0x400 |
Clear (abstract) |
| CLEAR_SRP | 1039 | 0x40F |
CLEAR (SRP including E911) |
| CLEAR_MEDICAL | 1047 | 0x417 |
Clear Medical events |
| CLEAR_SECURITY | 1063 | 0x427 |
Clear Security events |
| CLEAR_ALERT | 1095 | 0x447 |
Clear Alert events |
| CLEAR_PBX | 1159 | 0x487 |
Clear PBX Disconnect events |
| CLEAR | 2047 | 0x7FF |
All Clear |
A category clear mask is basically:
Clear_Bit + Category_Bit + Least_Significant_3_Bits
So for PBXs we have:
0x400 + 0x080 + 0x007 = 0x487 (1159)
These events which start with '@' may be sent via the external events API for the purpose of verifying access or retrieving status and configuration data. They will not raise signals or update virtual devices.
| name | definition / use |
|---|---|
| @PING | return OK 200 |
| @ECHO | return OK 200 w/ request params |
| @CONTACT | return contact record value for a given number, ext, or email (in that order) |
| @STATUS | return status information |
| @CONFIG | return site configuration data |
ICON Signals | 2018-2022 ICON Voice Networks