Timelox RT067, EN055 Users Manual
© Timelox AB 2009
The information in this document is subject to change without notice, Timelox AB makes a reservation against changes in the performance of
the above described product.
66 3081 004-10
The information in this document is subject to
change at the sole discretion of Timelox without
notice.
Any use, operation or repair in contravention of this
document is at your own risk. Timelox 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 Timelox AB. Unauthorized use and
reproduction is prohibited.
Copyright © 2009.
FCC/IC approval
The router and the endnode comply with RSS-GEN and part 15 of the FCC Rules. Operation is subject to the
following two conditions: (1) The router and the endnode may not cause harmful interference, and (2) the router
and the endnode must accept any interference received, including interference that may cause undesired operation.
Note: To maintain compliance with FCC´s RF exposure guidelines, this equipment should be installed and
operated with minimum distance 20cm between the radiator and your body. Use only the supplied antenna.
Changes or modifications not expressively approved by Timelox could void the user’s authority to operate the
equipment.
Note: This equipment has been tested and found to comply with the limits for a Class B digital device, pursuant to
part 15 of the FCC Rules. These limits are designed to provide reasonable protection against harmful interference
in a residential installation. This equipment generates, uses, and can radiate radio frequency energy and, if not
installed and used in accordance with the instructions, may cause harmful interference to radio communications.
However, there is no guarantee that interference will not occur in a particular installation. If this equipment does
cause harmful interference to radio or television reception, which can be determined by turning the equipment off
and on, the user is encouraged to try to correct the interference by one or more of the following measures:
• Reorient or relocate the receiving antenna.
• Increase the separation between the equipment and receiver.
• Connect the equipment into an outlet on a circuit different from that to which the receiver is connected.
• Consult the dealer or an experienced radio/TV technician for help.
Router:
FCC: WYV-RT067
IC 8231A-RT067
Endnode:
FCC: WYV-EN055
IC 8231A-EN055
© Timelox AB 2009
66 3081 004-10
2
Table of contents
1 INTRODUCTION..............................................................................................................................................5
1.1 ZIGBEE STANDARD .........................................................................................................................................5
1.2 SERVER ...........................................................................................................................................................6
1.3 GATEWAY.......................................................................................................................................................6
1.4 ROUTER...........................................................................................................................................................6
1.5 ENDNODE........................................................................................................................................................6
1.6 LOCK...............................................................................................................................................................6
1.7 PERMIT JOINING/FORBID JOINING....................................................................................................................6
1.8 DISCOVERY.....................................................................................................................................................7
1.9 ORPHAN JOIN ..................................................................................................................................................7
1.10 SYSMON AND TIMELOX DC-ONE.................................................................................................................7
1.11 LINK QUALITY...............................................................................................................................................7
1.12 ABBREVIATIONS............................................................................................................................................8
2 INSTALLATION...............................................................................................................................................9
2.1 OPTION INSTALLATION ...................................................................................................................................9
2.2 SERVER INSTALLATION...................................................................................................................................9
2.2.1 TL Concentrator.....................................................................................................................................10
2.2.1.1 TL Concentrator setup.............................................................................................................................................................10
2.2.1.2 TL Concentrator monitor.........................................................................................................................................................10
2.3 GATEWAY INSTALLATION.............................................................................................................................10
2.4 ADDING ROUTERS TO A GATEWAY................................................................................................................11
2.5 ADDING ENDNODES TO A ROUTER.................................................................................................................13
2.6 USING ROUTERS AS REPEATERS ....................................................................................................................13
2.7 ADDING LOCKS TO GATEWAYS .....................................................................................................................14
2.8 FORCING PARENTS ........................................................................................................................................14
2.9 RIGHT-CLICK MENUS IN SYSMON.................................................................................................................15
2.9.1 Right-click menu choices for GWs........................................................................................................16
2.9.2 Right-click menu choices for RTs...........................................................................................................16
2.9.3 Right-click menu choices for ENs...........................................................................................................17
3 SYSTEM OPERATION..................................................................................................................................18
3.1 EVENTS .........................................................................................................................................................18
3.1.1 Acknowledge..........................................................................................................................................18
3.1.2 Retransmission.......................................................................................................................................18
3.1.3 Fallback.................................................................................................................................................18
3.2 ONLINE FUNCTIONALITY...............................................................................................................................18
3.2.1 Commands..............................................................................................................................................18
3.2.2 Alerts......................................................................................................................................................18
3.2.3 Warnings................................................................................................................................................18
3.2.4 Alarms....................................................................................................................................................18
3.3 SETTING IN CONSTRUCTION MODE................................................................................................................19
4 COMMISSIONING.........................................................................................................................................20
4.1 PRINTING A STATUS REPORT .........................................................................................................................20
4.2 PINGING A DOOR ...........................................................................................................................................20
4.3 CHECKING ONLINE STATUS WITH CARD ........................................................................................................21
© Timelox AB 2009
66 3081 004-10
3
5 GENERAL IN DC-ONE..................................................................................................................................22
5.1 AUTOMATIC OPERATIONS .............................................................................................................................22
5.2 ONLINE EVENTS ............................................................................................................................................22
5.3 ROUTER LIST.................................................................................................................................................22
6 SETTINGS IN DC-ONE..................................................................................................................................24
6.1 SETTING UP OPERATOR TEMPLATES..............................................................................................................24
6.2 SETTING UP DOOR PARAMETERS ...................................................................................................................24
6.2.1 Door ajar alarm...........................................................................................................................................................................24
6.2.2 Status......................................................................................................................................................25
6.2.2.1 Intruder status..........................................................................................................................................................................25
6.2.2.2 Offline status............................................................................................................................................................................25
6.2.3 Miscellaneous.........................................................................................................................................25
6.2.4 Alarms....................................................................................................................................................26
6.2.5 Safes.......................................................................................................................................................26
7. ONLINE COMMANDS IN DC-ONE.............................................................................................................27
7.1 EMERGENCY OPEN ........................................................................................................................................27
7.2 EMERGENCY CLOSE.......................................................................................................................................27
7.3 BLOCK...........................................................................................................................................................27
7.4 UNBLOCK......................................................................................................................................................28
7.5 BROADCAST COMMANDS ..............................................................................................................................29
7.6 MOVE/EXTEND CARD....................................................................................................................................29
7.6.1 Add card to room...................................................................................................................................31
7.6.2 Show history...........................................................................................................................................31
7.7 PENDING CANCEL COMMANDS......................................................................................................................32
7.8 ONLINE COMMANDS FOR A SPECIFIC DOOR...................................................................................................32
7.9 CANCELLING A CARD....................................................................................................................................33
8 POWER LOSS & HARDWARE FAILURE..................................................................................................35
8.1 LOCK ELECTRONICS ......................................................................................................................................35
8.2 ENDNODE......................................................................................................................................................35
8.3 ROUTER.........................................................................................................................................................35
8.4 GATEWAY.....................................................................................................................................................37
8.5 SERVER .........................................................................................................................................................37
9 REDUNDANCY AND RECOVERY..............................................................................................................38
9.1 COMMUNICATION CHANNEL .........................................................................................................................38
9.2 RECOVERY....................................................................................................................................................38
9.2.1 Polling....................................................................................................................................................38
9.2.2 Fallback.................................................................................................................................................38
APPENDIX A: ONLINE DEVICES...................................................................................................................39
GATEWAY...........................................................................................................................................................39
ROUTER ..............................................................................................................................................................39
LOCK ..................................................................................................................................................................40
APPENDIX B: MOUNTING OF GATEWAY AND ROUTER.......................................................................41
APPENDIX C: EXAMPLE CONFIGURATIONS............................................................................................42
© Timelox AB 2009
66 3081 004-10
4
Example of Timelox online configuration. Several other configurations are possible (see Appendix C for some examples).
1 Introduction
With the online option, the locks can both send and
retrieve information. Commands can be sent from
the front desk to the lock. For example, a guest can
change rooms without needing to go to the
reception. Events are directly sent to the TimeLox
DC-One server.
This section describes the online network topology
all the way from the server to the lock. Commands
1.1 ZigBee standard
The online option is based on the ZigBee standard, a
new 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.4GHz
band; ISM = industrial, scientific and medical).
sent from the server to a lock will pass through the
items in the order they are mentioned. Answers will
pass through the same items but in the opposite
direction.
• 16 Channels spread spectrum (DSSS, Direct
Sequence Spread Spectrum)
• 250kbit/s (~2kbit/s @ 1% duty-cycle)
• Consists of a virtually unlimited number of
small networks (PANs, personal area networks).
© Timelox AB 2009
66 3081 004-10
5
1.2 Server
The server is the manager of the whole network for a
property. It can manage a virtually unlimited number
of gateways. All commands sent from the server are
encrypted.
1.3 Gateway
The gateways connect to the server via TCP/IP or
RS-485. It automatically adjusts to 10 or 100 Mbit/s
networks. In the TCP/IP case, the gateway starts by
retrieving an IP address via DHCP (Dynamic Host
Configuration Protocol). The gateway then automatically finds the server.
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.4GHz band the nodes in the PAN should use.
• The gateway is powered either over Ethernet or
by a power adapter.
• The total number of gateways is virtually
unlimited.
• The maximum theoretical limit of endnodes per
PAN is high, but a practical limit is some
hundred. In most cases, only some ten to 20
endnodes will be connected to each gateway.
However, this can change due to the building
construction, materialwise etc.
• The gateway can have either five routers or 15
endnodes connected.
See Appendix A for more information about the
gateway, including a detailed picture.
See Appendix B for preferred way of mounting the
gateway.
See Appendix C for configuration examples.
• Routers are externally powered.
• The router can have either five routers or 15
endnodes connected.
• 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.
Note: Timelox recommends a maximum of
three hops, i.e. gateway – router – router – end
node, down the gateway. The link quality index
(LQI) should be at least 30%. See section 1.11
for more information about the LQI.
See Appendix A for more information about the
router, including a detailed picture.
See Appendix B for preferred way of mounting the
router.
See Appendix C for configuration examples.
1.5 Endnode
An endnode is built into each lock. It is optimized
for low power consumption. The parent router will
act as a buffer for commands from the server. A
command sent from the server to a lock will be sent
from the gateway to the lock’s parent router. The
command will be sent through the routers that may
be located between the gateway and the lock’s
parent router.
Any message sent from the lock will be passed on to
the server through the parent router, any
intermediate routers and the gateway. Messages
from the lock are sent instantly.
• The total number of endnodes is virtually
unlimited.
1.6 Lock
The locks are the destination for commands and the
source of events.
• The lock and the endnode are powered by six
AA cells in a special package.
See Appendix A for an exploded view of a lock.
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.
© Timelox AB 2009
66 3081 004-10
1.7 Permit joining/Forbid joining
In order to prevent nodes from joining randomly,
“permit joining” can for each PAN only be made at
one router or its “parent gateway” at a time. When a
6
node is to be joined to the PAN, “permit joining”
must be made at the router or gateway that shall be
its parent. When the node has joined, “forbid
joining” should be made at the parent. “Forbid
joining” will automatically be made on the parent
after 15 minutes in case it is forgotten.
Note: It is only possible to make “permit joining” at
one RT per PAN at a time. If you make “permit
joining” at one RT and then at another RT in the
same PAN, the first RT will automatically make
“forbid joining”.
The commands for “permit joining” and “forbid
joining” are sent from SysMon (see section 1.10 for
more information about 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. It starts by the node broadcasting a discovery
message. Any plausible parent will answer and the
node will join the one on which “permit joining” has
been made, provided that it is within range.
Routers make discovery when given a reset while
the F1 button is being pressed (see Appendix A for a
router picture with buttons).
An endnode makes discovery when a Discovery
card (see section about ZigBee configuration card in
User manual TimeLox DC-One, Art. No 865 100) is
inserted into the lock. When the card is inserted, the
lock will chirp once. If the endnode in the lock is
busy at the moment, a tick will be heard instead. In
this case, make a new try by inserting the Discovery
card again.
1.9 Orphan join
As it can take up to three hours for the endnodes to
get online after recovery from a power cut, there is
an Orphan Join card (see section about ZigBee
configuration card in User manual TimeLox
DC-One, Art. No 865 100) that will initiate an
orphan join when inserted into a lock. When the card
is inserted, the lock will chirp once. If the endnode
in the lock is busy at the moment, a tick will be
heard instead. In this case, make a new try by
inserting the Orphan Join card again.
1.10 SysMon and TimeLox DC-One
The System Monitor (SysMon; found in the folder
where TimeLox DC-One has been installed) is used
for managing the online network. In SysMon all
connected gateways, routers and endnodes are
shown. There are two different operator levels for
the online option in SysMon:
• system manager and other operators for which
“Allow changing the settings in the ‘Options’
dialog” has been marked under the Options
alternative at Tools/Operator Template
X-reference in TimeLox DC-One.
• other operators.
Note: If the distributor is going to log on to SysMon,
system manager must be logged on first.
System manager and other operators for which
“Allow changing the settings in the ‘Options’
dialog” has been marked can perform all
online operations in SysMon (except for those on
distributor level), while other operators can basically
only look in SysMon.
Online settings and commands are made in the
TimeLox DC-One client; see sections 6 Settings in
DC-One and 7 Online Commands in DC-One.
Different operator templates can be given different
authorities to give online commands; see section 6.1
Setting up operator templates. For supervision of the
system, see sections 4 Commissioning and 5 General
in DC-One. If a dialog should be refreshed due to
online changes, this is shown with a * in the dialog
header (see example in the following screenshot).
Click the Refresh button in the dialog.
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 ZigBee view; see example in the screenshot
below. See section 2.3 for information about how to
log on to SysMon and find the ZigBee view.
Note: The LQI value which is shown when the
mouse hovers over a node is not an instantaneous
value but an average (the last instantaneous value,
with timestamp, is however shown within
© Timelox AB 2009
66 3081 004-10
7
parantheses after the average). To get an
instantaneous value of the LQI, right click on a
gateway, router or endnode in the SysMon ZigBee
view and choose Get User Description.
The LQI is valid for the link between the node and
its parent.
If the LQI is below 25%, the dot in front of the node
in SysMon is yellow; see example below.
If the LQI is below 15%, the dot in front of the node
is SysMon is red; see example below.
1.12 Abbreviations
In the rest of this user manual, the following
abbreviations are used:
GW = gateway
RT = router
EN = endnode
PAN = personal area network
© Timelox AB 2009
66 3081 004-10
8
2 Installation
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. As much effort as possible should be
made to securely install each device in a location
where it will be dry, cool, and undisturbed, yet still
maintain good radio contact with its parent or
children.
This section will describe how to install the
online option in the TimeLox DC-One software, and
also discuss the installation methods for each device
in the system as well as options for forcing devices
to connect to specific parent devices.
Software requirement
• TimeLox DC-One 1.7.0 or later is needed
2.2 Server installation
• The Timelox DC-One server must be connected
to the same network that the GW devices will be
connected to
• The Timelox DC-One server must have the
online option installed (see section 2.1).
1. Before you install the first GW device, you must
add a ZigBee gateway to the device list in
DC-One (double click on Devices under the
Lists tab in the navigation window and click
Add to add a new device) using the following
parameters:
2.1 Option installation
The online option must be installed in the Timelox
DC-One software.
An operator with the authority to handle option
codes must be logged on when options are set.
System ID must be set before any option can be
installed. Normally, options are set by the system
manager or the distributor.
1. Go to Tools/Option code.
2. Click Read card and insert the option card in
the encoder. The card will be overwritten and
can only be used once.
2. OR
Enter the option code (supplied by the
distributor) and click Apply.
2. When the fields have been filled in according to
the screenshot above (port 7799 is pre-filled as
default when choosing “ZigBee gateway” at
Type), click Save and Close.
Note: The same device is used for all GWs.
For testing and commissioning purposes it is a good
idea to have either a laptop with DC-One installed
which you can use to directly connect to gateways as
they are installed, or a laptop with a connection to
the live TimeLox DC-One server. This will allow
you to test radio signal strength as you are installing
the devices on each floor so issues can be addressed
immediately.
Note: The network information is stored in the GWs
and not in the laptop.
© Timelox AB 2009
66 3081 004-10
9
2.2.1 TL Concentrator
TL Concentrator is a utility for simplifying the setup
of a firewall when the GWs are located on a
different network. TLConcentrator runs on the
ZigBee server and listens for GWs on one port and
forwards all traffic to the TimeLox DC-One server
on another port. All traffic from the TimeLox
DC-One server is sent to the correct GW. In this
way, the firewall will only have to be set up to allow
sockets from the ZigBee server. The alternative
would be to set up the firewall to allow sockets for
every GW. This would add implications, especially
when adding or exchanging GWs.
2.2.1.1 TL Concentrator setup
The TimeLox DC-One software on the TimeLox
DC-One 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 TimeLox DC-One
server using port 7799.
To set up these parameters:
1. Go to Start/Run.
2. Browse to the DC-One installation folder, mark
TLConcentrator.exe and click Open.
3. Add /config
2.2.1.2 TL Concentrator monitor
It is possible to monitor the traffic through
TLConcentrator using TLConcentrator.exe
/monitor.
1. Go to Start/Run.
2. Browse to the DC-One installation folder, mark
TLConcentrator.exe and click Open.
3. Add /monitor
Note: There should be a space before /
4. Click OK. The following dialog (with example
statistics) is shown.
Note: There should be a space before /
4. Click OK.
A Configuration dialog will be shown.
1. Let the default 7798 be at Listen Port.
2. State the host’s IP address at Host Address.
3. Let the default 7799 be at Host Port.
2.3 Gateway installation
• The GW is powered by 9VDC 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.
© Timelox AB 2009
66 3081 004-10
10
Power and network connections should be made in a
manner that will reduce the chances of the device
being unplugged.
1. Open the System Monitor (SysMon), which is
used for managing the online network. To open
SysMon, double click on SysMon.exe in the
DC-One installation folder.
2. Log on to SysMon: go to File/Log on and enter
user ID and password. At “Operator card”,
choose the appropriate card encoder. Click
Enter.
7. Right click on the new GW to bring up the
device option menu and choose Edit Name.
8. Name the GW something meaningful – it should
generally indicate the GW’s location or coverage
area.
3. If it is not open already, open SysMon’s ZigBee
view at View/ZigBee. The ZigBee view of
SysMon shows all connected GWs, RTs and
ENs. Several useful commands are available by
right clicking on nodes (see sections 2.9.1-2.9.3
for more information about the different
commands).
4. Mount the GW in a convenient, out of the way
location using the VELCRO® strip.
5. Connect the network cable and power cable to
the GW.
6. After approximately 30 seconds the GW will
announce itself to the server and appear as a new
GW in the ZigBee tree in SysMon.
2.4 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.
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 TimeLox
DC-One, system manager and other operators for
which “Allow changing the settings in the ‘Options’
dialog” has been marked have the authority to
perform all online operations in SysMon (except for
those on distributor level). In sections 2.9.1-2.9.3, it
is described what operations that are available for all
operators and what operations that can only be
performed by system manager and other operators
for which “Allow changing the settings in the
‘Options’ dialog” has been marked.
© Timelox AB 2009
66 3081 004-10
11
1. To add an RT to the online network, right click
on the GW the RT should join and choose
Permit Joining.
2. Hold your mouse over the GW name and a box
will pop up containing some information about
that device. At the bottom of that box you will
see it says Join permitted, indicating that the
GW now allows new connections.
5. Hold your mouse over the device to view the RF
link quality (LQI) between the RT and the GW.
It shows the average LQI followed by the last
measurement with timestamp in parentheses.
Note: The LQI should not be below 30%.
6. While the GW still says Join permitted when
holding the mouse over the GW, plug in any
additional RTs as needed (up to five per GW)
and name them.
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 ZigBee
tree in SysMon.
4. Right click on the RT and choose Edit Name to
name the RT something meaningful. In our
example we have named it “RT 620-623” to
indicate the group of rooms that will be attached
to that RT.
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.
© Timelox AB 2009
66 3081 004-10
12
9. Hold your mouse over the GW to confirm it no
longer says Join permitted.
2.5 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 trouble-shooting
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.
3. Hold your mouse over the lock to verify the LQI
is within acceptable limits. Continue adding
additional locks to the RT as needed. When
finished, right click on the RT and choose
Forbid Joining.
2.6 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.
2. Insert the Discovery card (see section about
ZigBee configuration card in User manual
TimeLox DC-One, Art. No 865 100) in the lock.
The lock will chirp once to indicate it has read
the card, and will start searching for the RT on
which Permit Joining has been made to join.
When it finds the RT it will announce itself to
the server and appear in the ZigBee tree.
After the lock sends its first event, the room number
that is programmed in the lock will automatically fill
in. This can be forced by inserting a working key in
the lock.
2. Choose Forbid Joining on the GW and Permit
Joining on the 1st RT.
3. Plug in the 2nd RT. The 2nd RT will find and
attach itself to the 1st RT.
4. Choose Forbid Joining on the 1st RT. Name the
2nd RT and choose Permit Joining on it.
5. Insert the Discovery card (see section about
ZigBee configuration card in User manual
TimeLox DC-One, Art. No 865 100) in the lock;
the lock will chirp once. The lock will find and
attach itself to the RT on which Permit Joining
has been made, and when the first event is
© Timelox AB 2009
66 3081 004-10
13
Loading...