DRAFT User Manual Online Option ASSA ABLOY Hospitality 1
Copyrights The information in this document is subject to change at the sole discretion of ASSA ABLOY without notice. Any use, operation or repair in contravention of this document is at your own risk. ASSA ABLOY does not assume any responsibility for incidental or consequential damages arising from the use of this manual. All information and drawings in this document are the property of ASSA ABLOY. Unauthorized use and reproduction is prohibited. VingCard and Elsafe are registered trademarks of ASSA ABLOY.
Table of contents FCC and .................................................................................................6 ISED (IC) statements FCC statements ........................................................................................................................ 6 ISED (IC) ........................................................................................................................ statements 7 OEM responsibilities ...............................................................
.1 Setting ........................................................................................................................ up door parameters in a hotel system 34 4.1.1....................................................................................................................... Door ajar alarm 34 4.1.2....................................................................................................................... Status 35 4.1.2.1 ....................................................
9.2.2....................................................................................................................... Fallback 55 Appendix .................................................................................................56 A: Online devices Gateway ........................................................................................................................ 56 Router ............................................................................................................
FCC and ISED (IC) statements FCC (Federal Communications Commission) statements These devices comply with Part 15 of the FCC Rules. Operation is subject to the following two conditions: (1) these devices may not cause harmful interference, and (2) these devices must accept any interference received, including interference that may cause undesired operation.
ISED (IC) statements These devices comply with Industry Canada licence-exempt RSS standard CAN ICES-3 (B)/NMB-3(B) B. Operation is subject to the following two conditions: (1) these devices may not cause interference, and (2) these devices must accept any interference, including interference that may cause undesired operation of the devices. Les présents appareils sont conformes aux CNR d’Industrie Canada applicables aux appareils radio exempts de licence.
End product labeling The endnode module is labeled with its own IC Certification Number. If the IC Certification Number is not visible when a module is installed inside another device, then the outside of the device into which the module is installed must also display a label referring to the enclosed module.
1. Introduction Figure 1: Example of online configuration. Several other configurations are possible; see Appendix C for some examples. With the online option, the locks can both send and retrieve information. Commands can be sent from the front desk (hotel systems)/company reception (access control systems) to the lock. e.g., in hotel systems a guest can change rooms without needing to go to the reception. Events are directly sent to the application server.
1.1 ZigBee standard The online option is based on the ZigBee standard, a standard for transmission of data via radio. The ZigBee devices have low power consumption and the standard is aimed at control applications with relatively low data rate. Below are some basic facts for the standard: based on IEEE 802.15.4 (Open ISM 2.
The dialog Enter MAC address will be shown; fill it in and click OK. Figure 3 The gateway contains functionality for coordination of a PAN (Personal Area Network). The PAN is a wireless network that communicates on the 2.4GHz band. The gateway allows routers (see section 1.4) and endnodes (see section 1.5) to join the PAN and assigns network addresses. Each ZigBee node has a unique 64-bit IEEE address similar to Mac addresses used in TCP/IP. The gateway chooses which of the 16 channels in the 2.
1.4 Router A router acts either as a repeater for range extension, or as a parent for endnodes. It will also act as a buffer for messages sent to endnodes connected to the router. Routers are externally powered. The router can have either five routers or 15 endnodes connected as direct descendants. There can be a maximum of five hops down the gateway; i.e. gateway – router – router – router – router – endnode. This limits the physical coverage of a PAN.
The commands for 'permit joining' and 'forbid joining' are sent from SysMon. The 'permit joining'/'forbid joining' states of routers can also be toggled by pressing the F1 button. The LED on the router indicates 'permit joining' by fast blinking; short blink every 0.5 seconds. 'Forbid joining' is indicated by slow blinking; short blink every two seconds. See Appendix A for a router picture with buttons, LED etc. 1.8 Discovery Discovery is the process when a node shall join a PAN.
To set up SysMon authorities: 1. Double click on Operator templates under the Lists tab in the navigation window of the client. 2. Mark an existing operator template and click Properties, or click Add to create a new operator template. 3. In the Operator Template Details dialog, click SysMon in the left pane. 4. Mark the applicable checkboxes for operations that operators belonging to the template should be allowed to perform in SysMon. 5.
1.11 Link quality The Link Quality Index (LQI) is an average percentage that should not be below 30%. It is displayed when the mouse hovers over a node in the SysMon Online Network view; see example in the screenshot below. See section 3.2 Installing a gateway for information about how to log on to SysMon and find the Online Network view.
2. Installing the option If the option has been ordered together with the software, it is included in the license code and will be set in the software when the license code is entered. If the option should be added to the system at a later occasion, when the license code has already been entered and system ID is therefore set, an option code is used instead. Several software options can be included in one option code. An operator with the authority to handle option codes must be logged on.
3. Installing online devices The online devices were designed to allow for maximum flexibility during installation. There are no particular location specifications as long as the devices are within reasonable range of each other and good radio communication can be attained. Generally, the range is however around 20 metres or through a wall. The range of the devices depends to large extent on the building material(s) in the surroundings.
3.1 Installing a server The application server must be connected to the same network that the GW devices will be connected to. The application server must have the online option installed; see chapter 2 for details. 1. Before you install the first GW device, you must add a ZigBee gateway to the device list in the software (double click on Devices under the Lists tab in the navigation window and click Add to add a new device) using the following parameters: Figure 9 2.
3.1.1.1 TL Concentrator setup The application server is set up to listen for GWs on port 7799. This is where TLConcentrator will connect. TLConcentrator is set up to listen for GWs on port 7798 and to open sockets on the application server using port 7799. To set up these parameters: 1. Go to Start/Run. 2. Browse to the installation folder, mark TLConcentrator.exe and click Open. 3. Add /config Note: There should be a space before / 4. Click OK. A Configuration dialog will be shown. 1.
3.2 Installing a gateway Power and network connections should be made in a manner that will reduce the chances of the device being unplugged. The GW is powered by 5VDC using a plug in wall power adapter, or via power over Ethernet. For network connectivity, the GW requires an available Ethernet port and a patch cord. 1. Open the System Monitor (SysMon), which is used for managing the online network. To open SysMon, double click on SysMon.exe in the installation folder. 2.
Figure 14 8. Name the GW something meaningful – it should generally indicate the GW's location or coverage area. Figure 15 9. Right click on the GW and select Form new network to make sure that the GW is reset and gets a PAN ID.
3.3 Adding routers to a gateway The RT is powered by 5VDC using a plug in wall power adapter or a wired transformer. No wired Ethernet network connection is required as it communicates with the GW via radio. Note: The recommended installation method is to use the enclosed VELCRO® strip to attach the RT to a wall or some other convenient location. As described in section 1.10 SysMon and the client, it is set up in the operator template what operations a certain operator can perform in SysMon. 1.
3. When the RT has been mounted with the VELCRO® strip, press the F1 button on the RT while connecting power to the RT. The RT will power up and automatically begin looking for a parent device to associate with. It will discover the GW on which Permit Joining has been made, announce itself, and appear in the Online Network tree in SysMon. Figure 19 4. Right click on the RT and choose Edit Name to name the RT something meaningful.
7. Hold your mouse over each RT to check the LQI making sure it is within acceptable limits. 8. When all desired RTs have been added to the GW, right click on the GW and choose Forbid Joining. Figure 23 9. Hold your mouse over the GW to confirm it no longer says Join permitted.
3.4 Adding endnodes to a router The EN is the radio board inside the door lock unit. This device should not be confused with the lock electronics themselves, and when troubleshooting communication or lock issues care should be taken to diagnose the correct piece of hardware. 1. To add an EN to an RT, right click on the RT the EN should join and choose Permit Joining (or press the F1 button on the RT). Hold your mouse over the RT to verify that joining is permitted. Figure 25 2.
3.5 Using routers as repeaters In the event there are locks that are not in range of a GW and RT combination, an additional RT can be added for extended range. 1. Add the GW and first RT as normal. This first RT will act as a repeater between the GW and the 2nd RT which will be communicating with the locks. In our example we named the first RT 'RPTR 620-623' to indicate that it will act as a repeater for the RT serving 620-623. Figure 28 2. Choose Forbid Joining on the GW and Permit Joining on the 1st RT.
3.6 Adding locks to gateways There may be cases where the locks will communicate directly with the GW. To do this: 1. Choose Permit Joining on the GW and present the Discovery card at the lock (see chapter 5 Issuing a ZigBee configuration card); the lock will chirp once and/or show a green LED signal, depending on lock model. The lock will attach itself to the GW on which Permit Joining has been made, and when the first event is received the room number will automatically fill in. Figure 31 2.
2. 3. 4. 5. Note: Due to a bug in BeeStack radio nodes of versions before 1.0.49, do not use the Leave Network command for these older versions. Important: Wait for 40 seconds to avoid confusing RT-A from which the EN has deregistered. Make sure that Forbid Joining has been chosen for RT-A and that Permit Joining has been chosen for RT-B.
3.8.1 Right-click menu choices for GWs Figure 32 Figure 33: Bootload dialog - see 'Upgrade Firmware in PAN Coordinator' and 'Upgrade Firmware in Gateway' in Table 1 and 'Upgrade Firmware in Router' in section 3.8.2.
Menu choice Description Form new network makes a total reset of the GW Set channels selects allowed channels; see section 9.1 Communication channel for further information Set PAN ID sets another identity Note: The Set PAN ID choice is normally not used, since the PAN ID is given automatically by the network. If the PAN ID is 0x000, choose Form new network in the right-click menu for the GW; see above. Reset makes a reset; all data is retained Get User Description gets parameters (e.g.
Details about 'Add Node': 1. When Add Node is chosen in the right-click menu of a gateway or router, a dialog as in Figure 34 is shown. 2. If the node that should be added is a router, mark the checkbox Router. 3. Choose the applicable Network Address in the drop-down-menu; the network addresses are shown in the Online Network tree of SysMon, see example in Figure 35. 4.
3.8.2 Right-click menu choices for RTs Figure 37 Menu choice Description Leave network deregisters from the parent so another node can join Note: Due to a bug in BeeStack radio nodes of versions before 1.0.49, do not use the Leave Network command for these older versions. Get User Description gets parameters (e.g. link quality index, LQI) for the node Note: The LQI which is shown with Get User Description is an instantaneous value.
3.8.3 Right-click menu choices for ENs Figure 38 Menu choice Description Leave network deregisters from the parent so another node can join Note: Due to a bug in BeeStack radio nodes of versions before 1.0.49, do not use the Leave Network command for these older versions. Get User Description gets parameters (e.g. link quality index, LQI) for the node Note: The LQI which is shown with Get User Description is an instantaneous value.
4. Online settings in the client This section describes door parameters for online doors online authorities for operator templates the function prevent invalid staff card usage; this function is only applicable for hotel systems For setup of doors (online as well as non-online doors), see the section about doors in the setup manual for the client. 4.1 Setting up door parameters in a hotel system Go to Tools/Options in the client and click Online in the left column; you can make settings regarding 1.
4.1.2 Status Figure 40 The values for intruder status and offline status can be modified. See the screenshot above and the sections below for default values. 4.1.2.1 Intruder status After five failed attempts in the same online door, an alarm is triggered. This is referred to as sequential intruder. After five failed attempts in different online doors, the card is cancelled and an alarm is triggered. This is referred to as wandering intruder. 4.1.2.
4.1.3 Miscellaneous Figure 41 Under the Miscellaneous choice, you can set the grace time, i.e. for how long the guest(s) can enter a room after a check-out. The grace time can be 0-24 hours, default is 0. Note: The default grace time which is set up at Tools/Options/Online/ Miscellaneous applies unless a specific grace time is specified when the guest is checked out using the PMS interface. It also applies if the check-out is sent from the client.
cancelled. If the checkbox 'Automatic cancel of wandering intruder' is unmarked, the card will not be cancelled when the alarm is triggered. choose whether automatic privacy should be used or not; only applicable if the Orion EMS option is used. If 'Automatic privacy' is marked, the room will automatically be set in privacy as long as it is rented and there is a detection that someone is in the room.
'The maximum number of minutes a staff person may be inside an unsold room with the door closed before an alarm is triggered'; default is 30 minutes. This parameter is related to the alarm Invalid staff-card usage; see the user manual for the client for more information. 'The maximum number of guest cards that may be issued from the client before an alarm is triggered.
4.3 Setting up operator templates in a hotel system In the Operator Template Details dialog, it is possible to set up what online commands a certain operator template should be allowed to perform. See the section about the Online tab in User manual Visionline for further information about the different online commands. To set up/modify an operator template: Figure 44 1. Double click on Operator templates under the Lists tab in the navigation window. 2.
4.4 Setting up operator templates in an access control system In the Operator Template Details dialog, it is possible to set up what online commands a certain operator template should be allowed to perform. See the section about the Online tab in the client user manual for further information about the different online commands. To set up/modify an operator template: Figure 45 1. Double click on Operator templates under the Lists tab in the navigation window. 2.
4.5 Preventing invalid staff card usage (only applicable for hotel systems) To avoid unsuitable use of other cards than different types of guest cards in guest rooms, it is possible to set up that an alarm should be triggered if a person with a non-guest card dead-bolts a guest room from the inside, or stays too long inside the guest room. The function requires that the online option has been set.
5. Issuing a ZigBee configuration card The ZigBee configuration cards are smart/4k cards that are used for setting up online locks of ZigBee type. The following cards are available: Type Description Set subproduct ZigBee Sets the lock in ZigBee mode Start discovery in ZigBee See section 1.8 Discovery. This card also sets the lock in ZigBee mode. Start orphan join in ZigBee See section 1.9 Orphan join. Check ZigBee status See section 7.
6. System operation There is a two-way communication with the locks – online commands are sent to the locks, and the locks send events. 6.1 Events This section describes the transmission of events from the locks. Events are sent from the lock as they occur. Should there be any events in the queue, the first queued event is sent instead. 6.1.1 Acknowledge If there are any queued events, the lock will send the next event when the EN sends an acknowledgement to the lock.
6.2.1 Commands The commands that are sent online to the locks include: Room move (only applicable for hotel systems; add a card to the new room and cancel it from the old room, and/or change the card expiration time) Check-out of guest; only applicable for hotel systems Cancellation of card Sending of parameters; time, calendar etc Remote open/stand open/emergency open and clear stand open/emergency close Blocking and unblocking of user groups Read-out of missing events 6.2.1.
alarms occur. From the user notification list, it is also possible to set up that reports should be sent via e-mail. The reports can either be alarm reports, or reports about items that do not trigger alarms; e.g. a summary of issued cards. See Installation instruction Communication option for more information about the user notification list and other features of the Communication option. 6.2.
6.2.4 Router list The router list in the software contains all ZigBee routers in the system. The date column shows the last time the router announced itself. In case a router has been physically replaced there will be duplicates in the router list, but the last announcement time gives a hint of which router should be deleted. To remove a router from the router list: 1. Double click on Routers under the Lists tab in the navigation window. Figure 48 2. Mark the router in the list and click Remove.
6.2.5 Gateway list The gateway list in the software contains all ZigBee gateways in the system. To remove a gateway from the gateway list: 1. Double click on Gateways under the Lists tab in the navigation window. Figure 49 2. Mark the gateway in the list and click Remove. The gateway will automatically also be removed from the treeview in SysMon. Note: If a * is shown in the dialog caption, one or more gateways have been added, removed or renamed.
7. Commissioning 7.1 Printing a status report SysMon provides a simple method for printing out the status of all the connected devices in the online network. 1. In the Online Network view in SysMon, click the Print Status button. Note: When clicking Print Status, it is possible to choose where to save the status report. Figure 50 2. A Microsoft Excel spreadsheet will be written to the TempData folder in your installation folder.
7.2 Pinging a door While the spreadsheet described in section 7.1 is convenient in showing the communication status of the online devices, it does not show that the locks themselves are communicating with the server. To do that it is necessary to 'ping' every online door from SysMon. A ping is a simple 'are you there' message sent from the server to the lock and back. The ping shows that the lock, the server, and all the devices in between are operating correctly. To ping a door in SysMon: 1. 2.
As part of the commissioning process it is necessary to show that the server is able to communicate to every lock. This is shown in the last column of the status report in section 7.1. If the server has been restarted, the last column of the status report will show 'n/a' for all locks – in this case the Broadcast Answers dialog can be used to determine whether the locks have answered or not, for all broadcast commands except for 'Ping'.
8. Power loss and hardware failure This section describes the mechanisms in place to recover from power loss as well as instructions to replace devices in case of hardware failure. 8.1 Lock electronics If the lock electronics (not the online EN radio) have gone bad, they can be replaced with no interruption to the online network. Replace the lock electronics and put the lock back together. If power was temporarily disconnected from the EN, it will rejoin its parent on power up. 8.
8.3 Router If an RT loses power none of its children will be able to communicate to the server. When an RT loses power it will send a special SOS message to the server at least once to indicate that power may have been disconnected. A power cut is illustrated with a red dot in front of the RT in SysMon: Figure 54 It can take up to three hours for the ENs to get online after recovery from a power cut. Upon power up the RT will perform an orphan join and will rejoin its parent GW or RT.
8.4 Gateway If a GW loses power, none of its children (RT or EN) will be able to communicate to the server. A power cut is illustrated with a red dot in front of the GW in SysMon: Figure 55 Note: If a GW is replaced, the entire commissioning process must be performed again; see sections 3.2-3.7. 8.5 Server If the server loses power, no commands can be sent to the locks. When the server is recovered it will need to query the locks to retrieve any events it may have missed while it was down.
9. Redundancy and recovery 9.1 Communication channel The ZigBee communication protocol has the built in capability to communicate on any one of 16 different channels (or frequencies). In the event that one or more channels are blocked or do not allow for adequate signal strength and stability, other channels may be used. Important: The ZigBee communication can be disturbed by e.g.
9.1.1 Automatic channel change Note: Automatic channel change requires Visionline 1.12.2 or higher. Note: Contact Technical support for details about how to enable automatic channel change.
Appendix A: Online devices Gateway Figure A1 Automatic adjustment to 10 or 100 Mbit/s networks Powered via Ethernet or by a power adapter (5VDC) Note: The gateway is of PoE class 1; power range 0.44-3.84W.
Router Figure A2 Powered by a power adapter (5VDC) Low power consumption Can have either five routers or 15 endnodes connected as direct descendants There can be a maximum of five hops down the gateway (i.e. gateway - router - router router - router - endnode). This limits the physical coverage of a PAN. Important: Even though it is possible to have five hops, it is recommended to have maximum three hops, i.e. gateway - router - router - endnode. The link quality index (LQI) should be at least 30%.
Appendix B: Mounting of gateway and router Preferred way of mounting the gateway is horizontally on the wall: Figure B1 Note: The older type of gateway (9VDC) should be mounted vertically.
Appendix C: Example configurations Several online configurations are possible. Here are some examples: Figure C1: Basic setup with GWs, RTs and no firewall Notes for the configuration in Figure C1: RF door locks communicate with RF routers; maximum 15 locks per router. RF routers 1 and 2 communicate with the Rf gateway (it is recommended to have maximum three hops down the gateway, i.e. gateway - router - router - door lock, and an LQI, link quality index, of at least 30%).
Appendix C: Example configurations Figure C2: GWs using Power over Ethernet (PoE) communicating directly with doors. Notes for the configuration in Figure C2: RF door locks communicate with RF gateways; maximum 15 locks per gateway. RF gateways communicate with the application server over the Ethernet network of the property. Gateways are powered centrally by a PoE (Power over Ethernet) network switch.
Appendix D: Web interface for gateway The gateway parameters can be modified to suit the network where the gateway is located. This is done via the web interface as described below. Note: See Table E1 in Appendix E for a description of the gateway parameters. To modify the gateway parameters: 1. Press the F button on the gateway for a short while; the status LED on top of the gateway will blink yellow. See in Appendix A where the F button is located. 2.
Appendix E: Reset of gateway If the gateway parameters need to be reset to default values, e.g. if a gateway should be used at a demo installation, press and hold the F button while powering up the gateway. Parameter Default value Dynamic IP address (DHCP; Dynamic Host Configuration Protocol) Enabled Host IP address 192.168.0.100 Default gateway 192.168.0.1 Subnet mask 255.255.255.
Appendix F: Gateway boot-up 1. When a ZigBee gateway comes out of reset, it reads its IP configuration from a non-volatile memory. 2. If 'Dynamic IP Address' is set to Disable (see Appendix D): the gateway sets its IP address to the address stored in the config memory. Continue at step 13 below. 3. If 'Dynamic IP Address' is set to Enable (see Appendix D): the gateway sends a DHCP Request packet with IP destination address 255.255.255.255, i.e. IP broadcast, requesting its most recently used IP address. 4.
Appendix F: Gateway boot-up 15. If a Visionline server is on the same subnet, or if another gateway with a valid TCP connection to the server is on the subnet, they will send a reply to the querying unit, letting it know the IP address and TCP port of the Visionline server. The gateway then tries TCP connection to that IP. 15 b. New functionality, Zigbee gateway version 2.3.0 and later: From the payload supplied in the reply (the reply is sent with IP destination address 255.255.255.
Appendix G: More about how the gateway finds the server Introduction This appendix describes the process of how the gateway finds the server. The solution is based on DNS (domain name system) as well as on announcement broadcast, which is a proprietary implementation of zero config. Note: A general description of setup of DNS entries cannot be made in this document, since this varies with the type of DNS server that is used. There are three challenges when the gateway is connected to the network: 1.
Appendix G: More about how the gateway finds the server Commissioning of gateways If the gateway is located on the same subnet as the server, the gateway will locate the server using announcement broadcast without any need for manual configuration. However, the normal case is that the server and the gateway are located on different subnets. The first gateway for each subnet requires help from the DNS to locate the server. Single server - commissioning of gateways with DNS 1.
Commissioning of gateways without DNS 1. Connect one gateway to each subnet. Use the web interface for the gateway to configure the IP address of the Visionline server. Note: This is only needed for the first gateway for each subnet, since the other gateways on the same subnet will retrieve the server IP address from the first one by announcement broadcast. 2. Continue adding gateways.
Appendix H: Firmware upgrade If one or a few online devices should be upgraded, this is done from SysMon; the applicable firmware must however first be saved to the database from the Tools/Module firmware dialog in the client. For details about Tools/ Module firmware, see the appendix about firmware upgrade in the client setup manual. When the firmware that is applicable for an upgrade has been loaded into the database, follow the steps below: 1.
ASSA ABLOY Hospitality APAC E-mail: apac.hospitality@assaabloy.com Phone: +65 6305 7670 ASSA ABLOY Hospitality EMEA E-mail: emea.hospitality@assaabloy.com Phone: +47 69 24 50 00 ASSA ABLOY Hospitality North America E-mail: northam.hospitality@assaabloy.com Phone: +1 972 907 2273 ASSA ABLOY Hospitality Latin America E-mail: lam.hospitality@assaabloy.com Phone: +52 55 36 40 12 00 www.assaabloyhospitality.
