Architecture
...
Then, the used devices have to be created. This is done within the "Device definitions" within the menu "Modules" -> "Kaba". Each definition line corresponds to one device. The first column defines the device name. The device name must be unique and is shown within the item tree the NETx Server. The next column "Device ID" is optional. "Device Name" and "Device ID" are used to assign a web service notification to the corresponding item within the item tree. This means that either "Device Name" or "Device ID" must be the same as the Kaba software uses within the web service request. The 3rd column "Path" is used to define an optional structure within the item tree. "Description" is used to provide additional information which is stored within the item property "Description". The remaining field "Persistent", "Historical" (NETx BMS Server 2.0 only) and "Synchronize" have the same functionality as for all other interfaces within the NETx Server.
| Filed | Description |
|---|---|
| Device Name | Must be the same as the Kaba software uses within the web service request |
| Device ID | Must be the same as the Kaba software uses within the web service request |
| Path | Define an optional structure within the item tree |
| Description | Provide additional information which is stored within the item property |
...
The most important information is the "Event ID" and "Event Name" which indicate the event type. This information can be linked to an XLogic command or LUA task in order to trigger some actions like changing a data point (e.g. trigger a lighting scene). The following table gives an overview of all events:
Event ID | Event Name | Event Description |
|---|---|---|
| 3 | Door Ajar Generic | Device left open (unlocked) for more than 5 minutes. |
| 4 | Door ajar clear or door secure | Device secured [before X number of minutes] |
| 7 | Key Error - Canceled key used | Canceled credential/key card used at the device |
| 8 | Key Error - Other | Device access denied for a credential/key card for a reason not otherwise specified |
| 10 | Low battery | Battery voltage level in the device is low |
| 17 | Generic Egress | Guest egress; the door is locked |
| 18 | Door Latched | "Lock door" command sent to the door (secure mode) |
| 22 | Wandering Intruder | Alert: possible wandering intruder; credential/keycard presented at multiple doors |
| 23 | Standing Intruder | Alert: Possible standing intruder; multiple credentials/key cards are presented at a single door |
| 26 | Deadbolt / Privacy | Deadbolt (privacy feature) thrown |
| 31 | Key error - Wrong room | Credential/key card used at the wrong room |
| 34 | Date time Error | Device reports: Date and/or time not set; date-time error |
| 37 | Low Battery Clear or Battery Normal | Device reports: Low Battery Clear or Battery Normal |
| 38 | Door Ajar Staff Short | Staff Ajar "A" timer reached |
| 39 | Door Ajar Staff Long | Staff Ajar "B" timer reached |
40 | Door Ajar Guest Short | Guest Ajar "A" timer reached |
| 41 | Door Ajar Guest Long | Guest Ajar "B" timer reached |
| 42 | Deadbolt reset (retracted) | Deadbolt has been reset (retracted) |
| 44 | New Guest Key Used | New Guest Key Used |
| 45 | Guest Key Used | Guest-level credential/key card used |
| 46 | Staff Key Used | Staff-level or non-opening credential/keycard used |
| 50 | Door Unlatched | "Door unlock" command sent to the door (Unlatched mode) |
| 52 | Date time OK | Device reports: Date time OK (after an error notification) |
| 53 | Transaction Failed | Messenger-initiated transaction failed (including errors or and timing out) |
| 54 | Lock status ONLINE | |
| 55 | Lock status OFFLINE | |
| 8195 | Hub status OFFLINE | |
| 8194 | Hub status ONLINE | |
| Key Error - Canceled Key Used | ||
| 66 | Key error - Expired | |
| Key error - Wrong Room | ||
| 55 | ||
| Low battery | ||
| Low Battery Clear or Battery Normal | ||
| Mechanical Key Override | ||
| New Guest Key Used | ||
| Paging Keys | ||
| Staff Key Used | ||
| Standing Intruder | ||
| Transaction Failed | ||
| Wandering Intruder |
Article applies to the following products:
...