DRAFT

User Manual

Ethernet Lock Interface for Allure

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.

January 2022

2
Table of contents
1. Install Ethernet lock interface
.................................................................................................4

2. Connect.................................................................................................6
an Ethernet lock interface to the Visionline server

3. Make changes in web interface

.................................................................................................7

4. Perform.................................................................................................8
a reset (no configuration changes)

5. Perform.................................................................................................9
a factory reset

Appendix.................................................................................................10
A: Quick reference of technical data

Appendix.................................................................................................10
B: Firmware upgrade

Appendix.................................................................................................10
C: How the Ethernet lock interface finds the server
Commission Ethernet lock interfaces
................................................................................................................... 11
Single
...................................................................................................................
server - commission Ethernet lock interfaces with DNS 11
Multiple
...................................................................................................................
servers - commission Ethernet lock interfaces with DNS 11
Commission
...................................................................................................................
Ethernet lock interfaces without DNS 12
Switch to...................................................................................................................
backup server 13
Single
...................................................................................................................
server - switch to backup server with DNS 13
Multiple
...................................................................................................................
servers - switch to backup server with DNS 13
Switch
...................................................................................................................
to backup server without DNS 13
Advanced information
................................................................................................................... 13

Revision.................................................................................................15
history

3
1. Install Ethernet lock interface
This manual describes the Ethernet lock interface for Allure which can be used
together with a VingCard Allure online lock. A cable assembly is included at
delivery of Ethernet lock interface for Allure; see details below.

Cable assembly 4825330:

• 0.10 m (3 15/16’’)
• 6 x 26 AWG
• UL 1061

Note: For information about the VingCard Allure lock, and other parts which might
be used together with the lock, see Technical Manual VingCard Allure RFID BLE.

Attention: Observe precautions for handling;

electrostatic sensitive devices.

Figure 1

The item Ethernet lock interface for Allure* contains:

Pos Description

1 PCBA 7110

2 Cable assy. D06 - D06 Type 2

3 Ferrite tool

4 Ferrite, for cable Table 1

*)
The complete name 'Ethernet lock interface for Allure' is in the rest of this document for simplicity
abbreviated to 'Ethernet lock interface'.

4 66 1100 122-0
 Figure 3

Figure 4
Figure 2

1. Use the ferrite tool 2. Mount the Ethernet 3. If the ferrite later
to open the ferrite. cable in the ferrite. needs to be opened,
use the ferrite tool
again; see Figure 4.

4. To fasten an Ethernet lock interface to the electronics housing, slide the module
in place inside the plastic features in the housing; see Figures 5-6.

Note: For commissioning of the Ethernet lock interface, see Appendix C.

Figure 5 Figure 6

5 66 1100 122-0
2. Connect an Ethernet lock interface to the
Visionline server
An Ethernet lock interface for Allure connects to the server via TCP/IP and
automatically adjusts to 10 or 100 MBit/s networks. The Ethernet lock interface
starts by retrieving an IP address via DHCP (Dynamic Host Configuration Protocol)
and then tries to automatically find the server. Note: Depending on the way which
is used for finding the server, additional configuration might be needed; see details
in Appendix C. Note: If more than around 500 Ethernet lock interfaces are used
in the system, it is recommended to use one or more TCP Concentrators (one TCP
Concentrator per 500 Ethernet lock interfaces). See Installation instruction TCP
Concentrator for detailed information. To find out what IP address the Ethernet
lock interface has:

1. Double click on SysMon.exe (located in the Visionline installation folder).

2. Go to View/Online Network; the Online Network tree will be shown.
Note: If one or more TCP Concentrators are used in the system, the Online
Network tree will look somewhat different; see details in Installation
Instruction TCP Concentrator.

3.Go to View/Device Properties;

this will open an empty window
as in Figure 7.
Figure 7

4. Mark the concerned 'ELI' (Ethernet lock

interface) in the Online Network tree;
see example in Figure 8.
Figure 8

5.Mac address, IP address etc will be

shown in the Device Properties
window; see example in Figure 9.

Figure 9

Important: A lock with room number etc will not appear under an Ethernet lock
interface in the Online Network tree until the first event (e.g. card opening)
has been sent from the lock to the Visionline server.

If no DHCP server is available, the IP address of the Ethernet lock interface will
change to an IP address in the range 169.254.1.0 – 169.254.254.255; this IP
address range is based on the zero config standard.

Note: When the Ethernet lock interface has got an IP address, either via DHCP or
via zero config, it makes an announcement broadcast which the Visionline server
should answer to.

6 66 1100 122-0
3. Make changes in web interface

If the parameters for the Ethernet lock interface need to be modified to suit the
network where it is located, this can be done via a web interface; see screenshot
with example values in Figure 10. See procedure and description of parameters on
next page.

Figure 10

7 66 1100 122-0
1. Look in SysMon to see what IP address the Ethernet lock interface has;
see details in chapter 2.
2. In the web browser, enter http://ipaddress. Example:
3. Make the desired changes in the Ethernet Lock Interface Setup page;
see example in Figure 10.
4. If the server IP should be changed and there is no DNS (domain name system),
either enter the applicable Server IP or make sure that the radio button
'Enable' is marked for Announcement Broadcast; this makes the Ethernet lock
interface find the server.
5. When all desired changes have been done: click Save, then click Reboot
and press the reset button on the Ethernet lock interface again to close the web
interface.

Dynamic IP address Enable/Disable; if this parameter is set to 'Enable', the Ethernet lock interface
retrieves an IP address via DHCP (Dynamic Host Configuration Protocol) and then
automatically finds the server
Host IP IP address for the Ethernet lock interface
Default gateway This is the subnet unit to which all IP packets that are heading for an address
outside the subnet should be addressed, i.e. the IP address for the router of
the concerned subnet
Subnet mask A mask used to determine what subnet an IP address belongs to
Announcement broadcast Enable/Disable; makes the Ethernet lock interface find the server
Table 2: Description of Ethernet lock interface parameters

4. Perform a reset (no configuration changes)

If the Ethernet lock interface hangs, a reset can be done. All parameters in the
Ethernet lock interface will remain the same after the reset.

1. Lift out the Ethernet lock interface from

the electronics housing (see housing in
Figure 5).
2. Press the button marked in Figure 11.
The button is named SW1 on the board.

Figure 11

8 66 1100 122-0
5. Perform a factory reset
If an Ethernet lock interface with unknown IP address e.g. should be used at a
demo installation, a factory reset must be made to set the Ethernet lock interface
back to its default values.

1. To make a factory reset, press and hold

the button marked in Figure 12 while
powering up the Ethernet lock interface.
The button is named SW2 on the board.
Note: The Ethernet lock interface is only
powered up when the PoE (power over
Ethernet) cable is inserted. Note the order
of connection: Make sure that the backup
battery* is connected before the PoE cable
is inserted.
2. Lift out the Ethernet lock interface from
the electronics housing (see housing in
Figure 5).

Figure 12

*) If door communication unit is applicable, the batteries in that unit should also be connected before
the PoE cable is inserted.

9 66 1100 122-0
Appendix A: Quick reference of technical data

Dimensions, W x H x D: 63 x 66 x 22 mm (2 31/64'' x2 19/32'' x 7/8'')

Climatic resistance: Indoor use, 20-95% relative humidity, non-condensing
Operating temperature: 5-60 °C (41–140 °F)
PoE output: 12V 1A
Ferrite dimensions, W x H x D: 24,5 x 21,0 x 40,5 (31/32)'' x (53/64)'' x (1 19/32)''

Appendix B: Firmware upgrade

Ethernet lock interface is delivered with the correct firmware in it.
However, if the firmware later needs to be upgraded, follow this procedure:

1.Follow the steps in section 'To prepare for module firmware upgrade'
in Setup manual Visionline.
2.Upload the firmware via Lock Service 3G; see Quick reference guide
Lock Service 3G.

Appendix C: How the Ethernet lock interface

finds the server
This appendix describes the process of how the Ethernet lock interface 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;
see chapter 2 for information about the zero config IP address range.

Note: For more information about setting up DNS entries etc, contact the hotel
IT department. A general description of this cannot be made in this document,
since this varies with the type of DNS server that is used.

There are three challenges when the Ethernet lock interface is connected to
the network:

1. A new Ethernet lock interface must be able to find the server even if it is
located on a separate subnet.
2. The Ethernet lock interface must be able to locate a backup server in case
the primary server fails. The backup server is assumed to have the latest
database from the primary server.
3. The above must be fulfilled even if there are multiple Visionline servers
on the same network.

10 66 1100 122-0
Commission Ethernet lock interfaces:
Single server - commission Ethernet lock interfaces with DNS
Multiple servers - commmission Ethernet lock interfaces with DNS
Commission Ethernet lock interfaces without DNS

Switch to backup server:

Single server - switch to backup server with DNS
Multiple servers - switch to backup server with DNS
Switch to backup server without DNS

Advanced information on how the Ethernet lock interface finds the server

Commission Ethernet lock interfaces

Single server - commission Ethernet lock interfaces with DNS

1. Add a DNS entry called timeloxserver and let its IP address be the address
of the Visionline server to which the new Ethernet lock interface shall connect.
The Ethernet lock interface will then make a DNS query using the name
timeloxserver and in this way get the IP address of the server.
2. Connect the Ethernet lock interface to Ethernet and wait for it to appear
in the SysMon online view.

Multiple servers - commission Ethernet lock interfaces with DNS

1a.Visionline 1.27.1 or higher: For each Visionline server, add a new DNS
entry with the System DNS Name for the concerned server. The System
DNS Name is found by double-clicking on System settings under Reports
in the software navigation window; see details in the picture below.

Figure C1

1b.Visionline 1.27.0: Configure one gateway in the subnet so that the

Visionline server can find it.

11 66 1100 122-0
 1c. Visionline lower than 1.27.0: For each Visionline server, add a new
DNS entry with the system name for the concerned server. To find
out the system name, the system code is required. The system code
is found by double-clicking on System settings under Reports in
the software navigation window; see details in the picture below.
The system name is timelox_12-character system code without
dashes, in this example timelox_D124BD233D13.

Figure C2

2. For each Visionline server, add a new DNS entry with the system name for
the concerned server. The system name is timelox_12-character system code
without dashes, e.g. timelox_D124BD233D13.
3. In order to find the correct server at first installation, the Ethernet lock
interfaces must be installed for one server at a time.
4. Let timeloxserver refer to the IP address of the first Visionline server.
5. When all Ethernet lock interfaces have been installed for one server, the DNS
entry for timeloxserver must be changed to the IP address of the next server.
6. When all Ethernet lock interfaces for the last server have been installed, the
timeloxserver entry must be removed.

Note: Each Ethernet lock interface, once connected to the network, will ask the
DNS server for the Visionline IP address by using the system DNS name/system name.
If an Ethernet lock interface for some reason needs to use DNS again in the future,
the procedure will be as below:
Visionline 1.27.1 or higher: the system DNS name (see example in step 1a above)
will "win" over the default name. When the Ethernet lock interface makes a
DNS request, the system DNS name will connect it to the correct Visionline server.
Visionline lower than 1.27.0: the system name (see example in step 1c above)
will "win" over the default name. When the Ethernet lock interface makes a
DNS request, the system name will connect it to the correct Visionline server.

Commission Ethernet lock interfaces without DNS

1. Connect one Ethernet lock interface to each subnet. Use the web interface
for the Ethernet lock interface to configure the IP address of the Visionline
server; see details in section 4.2.2. Note: This is only needed for the first
Ethernet lock interface for each subnet, since the other Ethernet lock
interfaces on the same subnet will retrieve the server IP address from
the first one by announcement broadcast.
2. Continue adding Ethernet lock interfaces. They will automatically obtain the
IP address of the Visionline server from the Ethernet lock interfaces on the
same subnet that are already online with the server.

12 66 1100 122-0
Switch to backup server

Single server - switch to backup server with DNS

1. Change the IP address of the timeloxserver entry in the DNS so it points
to the backup server. The Ethernet lock interfaces will then connect to the
backup server if the connection to the primary server is lost and cannot
be re-established.

Multiple servers - switch to backup server with DNS

1. For each Visionline server, change the IP address of the system DNS name
(Visionline 1.27.1 or higher)/system name (Visionline lower than 1.27.0)
entry in the DNS so it points to the backup server. The Ethernet lock
interfaces will then connect to the backup server if the connection to
the primary server is lost and cannot be re-established.

Switch to backup server without DNS

1. Remove the primary server from the network.
2. Assign the IP address of the primary server to the backup server
OR
Enter the IP address of the backup server in the web interface for
one Ethernet lock interface per subnet.
Note: It will take one hour after the primary server closes its sockets until
the rest of the Ethernet lock interfaces enable their announcement broadcast.

Advanced information
1. When an Ethernet lock interface comes out of reset, it reads its
IP configuration from a non-volatile memory.
2. If 'Dynamic IP Address' is set to Disable (see chapter 3): the Ethernet lock
interface 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 chapter 3): the Ethernet
lock interface 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. If the network/subnet configuration has not changed, the DHCP server will
most likely send a DHCP ACK packet, allowing the Ethernet lock interface to
continue to use the same IP. The DHCP server may use either IP broadcast
or unicast for this packet; broadcast is however most commonly used.
Continue at step 10 below.
5. If the DHCP server is unwilling to let the Ethernet lock interface use the
same address as before, or if the requested IP is out of scope, it sends

13 66 1100 122-0
 a DHCP NAK.
6. The Ethernet lock interface resets its IP address to 0.0.0.0 and sends
a DHCP Discover packet with IP destination address 255.255.255.255;
IP broadcast.
7. If a DHCP server is available, it sends a DHCP Offer packet. Since the
Ethernet lock interface has no valid IP address, the DHCP server must
send to IP destination 255.255.255.255; IP broadcast.
8. The Ethernet lock interface receives the offer and sends a DHCP Request
packet, as in step 3 above, but this time requests the IP address offered
by the DHCP server.
9. The DHCP server sends a DHCP ACK packet, confirming that the Ethernet
lock interface may start using the new IP address. Unlike the ACK in
step 4 above, this ACK packet must be sent to IP destination address
255.255.255.255 (IP broadcast), since the Ethernet lock interface has
not got any confirmed IP address yet.
10. The Ethernet lock interface performs gratuitous ARP (Address Resolution
Protocol) to ensure that no other host has got the same IP.
11. If IP collision is detected, the Ethernet lock interface sends a DHCP
Decline packet which refuses the assigned IP address and restarts the
IP acquirement procedure for the Ethernet lock interface.
12. The Ethernet lock interface reads the most recently used Visionline server
IP address and tries to open a TCP connection to the server.
13. If the TCP connection attempt fails, the Ethernet lock interface will continue
to try connections to the same IP over and over again – unless it detects
that the network/subnet setup has changed, e.g. the Ethernet lock
interface may have been moved to a new location. Then it will send an
application specific service discovery request (announcement broadcast)
with IP destination address 255.255.255.255; IP broadcast. Even if the
network/subnet setup is unchanged, but long time (one hour) has elapsed
without any successful TCP connection with the Visionline server, the
Ethernet lock interface will start sending service discovery requests.
14. If a Visionline server is on the same subnet - or if another Ethernet
lock interface with a valid TCP connection to the server is on the subnet -
it will send a reply to the querying unit, letting it know the IP address
and TCP port of the Visionline server. The Ethernet lock interface then
tries TCP connection to that IP. From the payload supplied in the reply
(the reply is sent with IP destination address 255.255.255.255, IP
broadcast), the querying unit can determine if its own IP address properties
are correct with respect to network class, default encoder IP and subnet
mask. If required, it will self-assign a new IP address within the subnet
specified in the reply, and then send gratuitous ARP to ensure that no other
host has got the same IP. Then it goes on and tries TCP connection to the
received server IP address.

Note: 13 and 14 will go on in a round robin way until the Ethernet lock interface
has reached the server.

14 66 1100 122-0
Revision history

Date Change By
KG

15 66 1100 122-0
16