Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

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. 

FiledDescription
Device NameMust be the same as the Kaba software uses within the web service request
Device IDMust be the same as the Kaba software uses within the web service request
PathDefine an optional structure within the item tree
DescriptionProvide 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
3Door Ajar GenericDevice left open (unlocked) for more than 5 minutes
.
4Door ajar clear or door secureDevice secured [before X number of minutes]
7Key Error - Canceled key usedCanceled credential/key card used at the device
8Key Error - OtherDevice access denied for a credential/key card for a reason not otherwise specified
10Low batteryBattery voltage level in the device is low
17Generic EgressGuest egress; the door is locked
18Door Latched"Lock door" command sent to the door (secure mode)
22Wandering IntruderAlert: possible wandering intruder; credential/
keycard
key card presented at multiple doors
23Standing IntruderAlert: Possible standing intruder; multiple credentials/key cards are presented at a single door
26Deadbolt / PrivacyDeadbolt (privacy feature) thrown
31Key error - Wrong roomCredential/key card used at the wrong room
34Date time ErrorDevice reports: Date and/or time not set; date-time error
37Low Battery Clear or Battery NormalDevice reports: Low Battery Clear or Battery Normal
38Door Ajar Staff ShortStaff Ajar "A" timer reached
39Door Ajar Staff LongStaff Ajar "B" timer reached

40

Door Ajar Guest ShortGuest Ajar "A" timer reached
41Door Ajar Guest LongGuest Ajar "B" timer reached
42Deadbolt reset (retracted)Deadbolt has been reset (retracted)
44New Guest Key UsedNew Guest Key Used
45Guest Key UsedGuest-level credential/key card used
46Staff Key UsedStaff-level or non-opening credential/
keycard
key card used
50Door Unlatched"Door unlock" command sent to the door (Unlatched mode)
52Date time OKDevice reports: Date time OK (after an error notification)
53Transaction FailedMessenger-initiated transaction failed (including errors or and timing out)
54Lock status ONLINEZigBee lock back online (after having been offline)
55Lock status OFFLINEZigBee lock offline (after having been online)
66Key error - ExpiredExpired credential/key card used at the device
99Paging KeysPaging key used
8194Hub status ONLINEHub back online (after having been offline)
8195Hub status OFFLINE
8194Hub status ONLINEKey Error - Canceled Key Used66Key error - ExpiredNew Guest Key UsedPaging KeysStaff Key UsedStanding IntruderTransaction FailedWandering Intruder
Hub offline (after having been online)
100T/A Clock InThe employee {0} has clocked-in
101T/A AbsenceThe employee {0} initiated an absence
102T/A Clock OutThe employee {0} has clocked-out
103T/A PauseThe employee {0} initiated a pause
104SSA Guest - Check-InThe guest user has checked-in
105SSA Guest - Check-OutThe guest user has checked-out
106SSA Guest - Room MoveThe guest user changed his/her room
107SSA Guest - Extended StayThe guest user has extended his/her stay
108SSA Paging - Multi-MediaProblem detected on one or more media devices
109SSA Paging - ElectricalElectrical problem detected
110SSA Paging - Room VacantPart 1 of VCI state
111SSA Paging - Room Service Pick-upRequest for room service pick-up
112SSA Paging - Plumbing ServicePlumbing problem detected
113SSA Paging - Room CleanedPart 2 of VCI state
114SSA Paging - Laundry ServiceRequest for laundry service
115SSA Paging - HVACProblem detected on heating/ventilation system
116SSA Paging - Room InspectedPart 3 of VCI state
117SSA Paging - Generic RepairRequest for a generic repair
507Digital Key error - CancelCanceled digital key used at the device
508Digital Key error - OthersDevice access denied for a digital key for a reason not otherwise specified
510Digital Low batteryDigital key reports that the Battery voltage level in the device is low
522Digital Key Wandering IntruderDigital key used as a wandering intruder
523Digital Key Standing IntruderDigital key used as a standing intruder
531Digital Key error - Wrong Room
55Low batteryLow Battery Clear or Battery NormalMechanical Key Override
Digital key accessing wrong room
544Digital New Guest Key UsedDigital key used for New Guest
545Digital Existing Guest Key UsedDigital key used for current Guest
546Digital Staff Key UsedDigital key used for staff
566Digital Key Error ExpiredDigital key expired

Article applies to the following products:

...