06-240 07 PassMan Software Manual
06-240 07 PassMan Software Manual
Copyright
The copyright and ownership of this document belongs to TagMaster AB. The document may be
downloaded or copied provided that all copies contain the full information from the complete document. All
other copying requires a written approval from TagMaster AB.
Disclaimer
While effort has been taken to ensure the accuracy of the information in this document TagMaster AB
assumes no responsibility for any errors or omissions, or for damages resulting from the use of the
information contained herein. The information in this document is subject to change without notice.
© TagMaster AB 2 (40)
PassMan Software Manual Doc no. 06-240 07
1 Introduction 4
2 General Information 5
2.1 Basic Tasks .................................................................................................. 6
2.2 Communication Interfaces ............................................................................ 7
2.3 ID-tag Data ................................................................................................... 8
3 Message Formats 8
3.1 Site Code...................................................................................................... 9
3.2 ID-tag Mark ................................................................................................. 10
3.3 Mag-stripe Message Format ....................................................................... 11
3.4 Wiegand Message Format .......................................................................... 12
3.5 Serial Message Format............................................................................... 13
4 Serial Communication Commands 15
4.1 Commands Sent from the Host to the Reader............................................. 15
4.2 Messages sent from the Reader to the Host ............................................... 17
5 Configuration 19
5.1 Configuration Interfaces.............................................................................. 19
5.2 System Settings.......................................................................................... 22
5.3 ID-tag Settings ............................................................................................ 30
6 Testing 37
6.1 Testing the Reading Lobe ........................................................................... 37
6.2 Trouble Shooting ........................................................................................ 37
7 Contact 38
7.1 Technical Support ....................................................................................... 38
7.2 Office .......................................................................................................... 38
8 Glossary 39
9 References 40
© TagMaster AB 3 (40)
PassMan Software Manual Doc no. 06-240 07
1 Introduction
This section introduces PassMan, which is application software for the LR-series
Reader.
The PassMan software is suited for a Reader which is being integrated with an existing
access control system or for a Reader connected to a host computer and used in an
identification system. The Reader communicates with an access control system or a
host computer via standard communication interfaces.
The Reader has two main software layers. Every Reader is installed with system
software, which constitutes the software foundation of the Reader. The Reader system
software can be compared to the operating system of a host computer.
Different Reader application software can reside on top of the system software. The
Reader application software defines the behaviour of the Reader.
Access
Control
System
Reader Host
Communication
Application Application
Interface
Software Software
06-300 01
© TagMaster AB 4 (40)
PassMan Software Manual Doc no. 06-240 07
2 General Information
This section describes the purpose and the basic tasks of the PassMan software.
The main function of the PassMan software is to detect an ID-tag and automatically
forward ID-tag data to the access control system or to the host computer.
The Reader installed with PassMan has only limited decision-making capabilities on its
own. The Reader application software cannot store any information about read ID-tags.
Functionality is primarily placed in the access control system or the host computer.
06-301 01
© TagMaster AB 5 (40)
PassMan Software Manual Doc no. 06-240 07
06-302 01
Output includes causing the relay to be pulled, sounding the buzzer, and turning on the
externally-visible indicator. Output can also be information about events which is sent
to an access control system or to a host computer, or both.
PassMan Access
Software Control
Input System
Output
06-303 01
Figure 4 Basic tasks of the PassMan software when the Reader is connected to an access
control system
When the Reader is connected to an access control system, output includes
information about read ID-tags that is sent to the access control system over the
Wiegand/Mag-stripe interface. The Wiegand/Mag-stripe interface sends information
© TagMaster AB 6 (40)
PassMan Software Manual Doc no. 06-240 07
one-way, from the Reader to the access control system. When the Reader is
connected to an access control system, input includes signals received from the
access control system to the input connection.
PassMan Host
Software Application
Input
Software
Output
06-304 01
Figure 5 Basic tasks of the PassMan software when the Reader is connected to a host
computer
When a Reader is connected to a host computer, output includes information about
read ID-tags and motion detections that is sent to the host computer over a serial
communication interface. When a Reader is connected to a host computer, input
includes information received from the host computer over a serial communication
interface.
Output generated by the Reader is based on the configuration settings of the PassMan
software. Application settings are stored in Flash memory and are unaffected when the
Reader is reset.
For a chart of the controller board with the external connections mentioned above, see
the LR-series Installation Manual [2].
© TagMaster AB 7 (40)
PassMan Software Manual Doc no. 06-240 07
The two protocols Wiegand and Mag-stripe share the same physical interface on the
controller board of the Reader and therefore cannot be used simultaneously.
If the Reader is connected to a host computer, host application software is needed for
establishing a communication link between the Reader and the host.
Every ID-tag has a unique and permanent identification number called ID-tag mark.
The data stored in a MarkTag includes the ID-tag mark. The data stored in a ScriptTag
includes the ID-tag mark and a writable data field called ID-tag user data.
The term ID-tag data is used to describe the collective data stored in an ID-tag (the ID-
tag mark or the ID-tag user data, or both). For MarkTags, ID-tag data also include an
optional site code stored in the Reader.
The ID-tag data is sent to the access control system or the host computer in different
formats, which correspond to the available communication interfaces as shown in the
table below.
3 Message Formats
This section describes the different formats used in the messages sent from the
Reader to an access control system and to a host computer.
Messages transmitted from the Reader consist of separate fields and differ in format,
depending on the communication interface and type of ID-tag.
Settings regarding the different communication interfaces, ID-tag marks and ID-tag
user data can be combined in a variety of ways.
© TagMaster AB 8 (40)
PassMan Software Manual Doc no. 06-240 07
All configuration settings are listed and explained briefly in section 5 Configuration.
However, some settings and terminology regarding the message formats require
clarification and will be described in more detail in the subsections below.
A Site code is used in some access control systems for separating different sites or
facilities. The site code is an arbitrary number that is set in the Reader application
software. The site code is optional and sent together with the ID-tag mark to an access
control system or to a host computer.
The field that the site code occupies in a sent message is of fixed length. The field
length is configured in the Reader application software and is set so that it is large
enough to hold the actual site code.
If the field length is larger than the space occupied by the site code, the site code will
be preceded by zeros. If the field length is smaller than the space occupied by the site
code, the site code will be truncated and the most significant digits will be omitted.
Note that the field size sets an upper limit for the value of the site code. To omit the site
code from the message, set the field length to 0.
© TagMaster AB 9 (40)
PassMan Software Manual Doc no. 06-240 07
Site code size and field length are expressed as number of digits when using Mag-
stripe and serial data formats, as exemplified in the table below.
Table 4 Site code example using Mag-stripe and serial data formats.
Site Code value Site Code Size Site Code Site Code as Sent by
Field length PassMan
3381 4 digits 4 digits 3381
(3381)
6 digits 003381
Site code size and field length are expressed as number of bits when using Wiegand
data format, as exemplified in the table below.
Site Code value Site Code Size Site Code Site Code as Sent by
Field Length PassMan
3381 12 bits 12 bits 110100110101
(110100110101)
14 bits 00110100110101
The ID-tag mark is the unique identification number stored in every ID-tag, typically
consisting of eight digits. The ID-tag mark is transmitted to the Reader when the ID-tag
is read. The ID-tag mark is formatted by the PassMan software before being forwarded
to the access control system or the host computer.
The field that the ID-tag mark occupies in a sent message is of fixed length. The whole
ID-tag mark stored in the ID-tag is not necessarily used in the message sent to the host
computer or the access control system. The field length is configured in the Reader
application software and is set so that it is large enough to hold the desired size of the
ID-tag mark. The size of the ID-tag mark forwarded from the Reader is configured in
the Reader application software and can be smaller than the original ID-tag mark.
If the field length is larger than the space occupied by the ID-tag mark, the ID-tag mark
will be preceded by zeros. If the field length is smaller than the space occupied by the
ID-tag mark, the ID-tag mark will be truncated and the most significant digits will be
omitted.
© TagMaster AB 10 (40)
PassMan Software Manual Doc no. 06-240 07
The field length is expressed as number of digits when using Mag-stripe and serial data
formats, as exemplified in the table below.
Table 6 ID-tag mark example using Mag-stripe and serial data formats
The field length is expressed as number of bits when using the Wiegand data format,
as exemplified in the table below.
Note that the ID-tag mark represented by bits will result in entirely different decimal
values depending on the used number of bits. For instance, the bit sequence
101111000101101010110001 has the decimal value 12343985 and the truncated bit
sequence 0101101010110001 has the decimal value 23217.
The Mag-stripe message format is applicable to the PassMan settings described in the
following sections:
The messages sent over the Mag-stripe interface is enclosed by leading and trailing
zero bits, which are used by the access control system for synchronisation. The
number of leading zero bits and the number of trailing zero bits are configured in the
Reader application software.
The Mag-stripe protocol format organises the data in groups of five bits called
sentinels, four data bits and one parity bit. A sentinel is transmitted with the least
significant bit first and the parity bit last.
© TagMaster AB 11 (40)
PassMan Software Manual Doc no. 06-240 07
Each sentinel represents a digit of the ID-tag data or a control character, which can
have values in the range 0Hex–FHex.
If PassMan is configured to send the optional site code and ID-tag mark to the access
control system, then the message is structured as shown in the figure below.
Leading zero bits Optional site code ID-tag mark Trailing zero bits
Figure 6 Mag-stripe message format sending site code and ID-tag mark
The ID-tag user data consists of two fields when using the Mag-stripe data format, an
optional constant field and a number field. If PassMan is configured to send ID-tag user
data to the access control system, then the message is structured as shown in the
figure below.
Leading zero bits Optional constant field Number field Trailing zero bits
The Wiegand message format is applicable to the PassMan settings described in the
following sections:
The ID-tag data is enclosed by a first and a last parity bit when using the Wiegand data
format. The two parity bits are calculated over two separate bit ranges of the message,
which are defined when configuring the PassMan software.
The first parity bit is calculated over a range from the second bit to a defined position in
the message. The last parity bit is calculated over a range from a defined position in
the message to the second-last bit of the message.
Note that the total length of the message is the sum of the ID-tag mark field length and
the site code field length plus two bits (the first and the last parity bits).
If PassMan is configured to send the optional site code and ID-tag mark to the access
control system, then the message is structured as shown in the figure below.
© TagMaster AB 12 (40)
PassMan Software Manual Doc no. 06-240 07
First parity bit Optional site code ID-tag mark Last parity bit
Figure 8 Wiegand message format sending site code and ID-tag mark
The ID-tag user data consists of three number fields when using Wiegand data format.
The first and last parity bits can be omitted when sending the ID-tag user data.
If PassMan is configured to send ID-tag user data to the access control system, then
the message is structured as shown in the figure below.
First parity bit First number Second number Third number Last parity bit
The message sent over the RS485 serial communication interface consists in its most
rudimentary form of the site code and ID-tag mark or data format descriptor and ID-tag
user data.
If PassMan is configured to send the site code and ID-tag mark to the host computer,
then the message is structured as shown in the figure below.
Figure 10 Serial message format sending site code and ID-tag mark
A data format descriptor is included when sending the ID-tag user data over RS485
interface. The data format descriptor is two ASCII characters that indicate the format of
the ID-tag user data. (See Table 3 in section 2.3 ID-tag Data for a complete listing of
the available data formats.)
If PassMan is configured to send ID-tag user data to the host computer, then the
message is structured as shown in the figure below.
© TagMaster AB 13 (40)
PassMan Software Manual Doc no. 06-240 07
To ensure integrity of the sent data a checksum is calculated and included in the
message frame before the ETX control character. The checksum is an XOR-calculation
of all bytes from STX to the last byte in the ID-tag data. A hexadecimal value 00–FF is
used to represent the checksum, which is sent as two ASCII characters over the
RS485 interface. The first character in the checksum is referred to as CS1 and the
second character in the checksum is referred to as CS2.
Figure 12 Serial message format sending site code and ID-tag mark with the message frame
highlighted in grey
STX Data format descriptor ID-tag user data CS1 CS2 ETX
Figure 13 Serial message format sending ID-tag user data with the message frame highlighted
in grey
STX Site code ID-tag mark CS1 CS2 ETX Message terminator
Figure 14 Serial message format sending site code and ID-tag data mark with message frame
and message terminator highlighted in grey
STX Format descriptor ID-tag user data CS1 CS2 ETX Message terminator
Figure 15 Serial message format sending site code and ID-tag data mark with message frame
and message terminator highlighted in grey
It is possible to inspect the ID-tag user data by transmitting the information as 4-bit
nibbles converted to ASCII instead of standard 8-bit ASCII.
The bit sequence 00001000 (decimal value 8), for instance, represents the ASCII
character backspace, which will corrupt the output in the terminal emulator if sent as 8-
bit ASCII. The same bit sequence represented by two 4-bit nibbles generates the bit
sequences 0000 (decimal value 0) and 1000 (decimal value 8), which will be converted
and sent as the ASCII characters “0” followed by “8”.
© TagMaster AB 14 (40)
PassMan Software Manual Doc no. 06-240 07
In addition to the transmitted ID-tag data, a host computer can communicate with a
Reader installed with PassMan software by sending and receiving commands over the
RS485 interface.
The sections below describe the commands, their structure, and the responses to the
commands.
The convention used to specify the syntax of the commands and the responses are as
follows:
An Acknowledgement (ACK) ASCII character is returned if the reader accepts the sent
command, and an Negative Acknowledgement (NAK) ASCII character is returned if the
reader does not accept the sent command.
Description Syntax
Command structure <STX>RL1C<ETX>[<CR><LF>]
Normal response <DLE>[ID-tag data>] or
<DLE><STX>[<ID-tag data>]<Checksum><ETX>[<CR><LF>]
No message to <STX><CAN>1A<ETX>[<CR><LF>]
repeat response
© TagMaster AB 15 (40)
PassMan Software Manual Doc no. 06-240 07
Description Syntax
Command structure <STX>B171<ETX>[<CR><LF>]
ACK response <STX><ACK>04<ETX>[<CR><LF>]
NAK response <STX><NAK>17<ETX>[<CR><LF>]
Description Syntax
Command structure <STX>E176<ETX>[<CR><LF>]
ACK response <STX><ACK>04<ETX>[<CR><LF>]
NAK response <STX><NAK>17<ETX>[<CR><LF>]
Description Syntax
Command structure <STX>B272<ETX>[<CR><LF>]
ACK response <STX><ACK>04<ETX>[<CR><LF>]
NAK response <STX><NAK>17<ETX>[<CR><LF>]
Description Syntax
Command structure <STX>E275<ETX>[<CR><LF>]
ACK response <STX><ACK>04<ETX>[<CR><LF>]
NAK response <STX><NAK>17<ETX>[<CR><LF>]
© TagMaster AB 16 (40)
PassMan Software Manual Doc no. 06-240 07
Description Syntax
Command structure <STX>MA0E<ETX>[<CR><LF>]
ACK response <STX><ACK>04<ETX>[<CR><LF>]
NAK response <STX><NAK>17<ETX>[<CR><LF>]
Description Syntax
Command structure <STX>MS1C<ETX>[<CR><LF>]
ACK response <STX><ACK>04<ETX>[<CR><LF>]
NAK response <STX><NAK>17<ETX>[<CR><LF>]
Description Syntax
Message <STX>MO00<ETX>[<CR>LF>]
structure
Description Syntax
Message <STX>LA0F<ETX>[<CR><LF>]
structure
© TagMaster AB 17 (40)
PassMan Software Manual Doc no. 06-240 07
Description Syntax
Message <STX>LP1E<ETX>[<CR><LF>]
structure
© TagMaster AB 18 (40)
PassMan Software Manual Doc no. 06-240 07
5 Configuration
This section describes the available configuration settings in the PassMan software
and how to change them.
The configuration settings are divided into two general groups. The “System Settings”
group covers reading performance, operating logic, and communication interfaces. The
“ID-tag Settings” group covers how the Reader formats information transmitted from
the ID-tags before it is forwarded to an access control system or a host computer.
The Reader can be configured using a temporarily connected PC via the web interface
or the terminal interface. For backwards compatibility it is also possible to configure the
Reader via the RS232 interface.
© TagMaster AB 19 (40)
PassMan Software Manual Doc no. 06-240 07
PassMan v1.6.0
A. System settings menu
B. ID-tag settings menu
© TagMaster AB 20 (40)
PassMan Software Manual Doc no. 06-240 07
Tip: In case of a type error, press backspace or enter to return to the main
menu.
6. Depending on the setting, the options in the submenus are set in two different
ways:
a. Options of character type are set by typing a character as seen in the
example below:
© TagMaster AB 21 (40)
PassMan Software Manual Doc no. 06-240 07
PassMan v1.6.0
A. System settings menu
B. ID-tag settings menu
9. Type a character to change the options for the corresponding setting in the
same manner as in the system settings menu described above.
10. A setting is automatically sent to the Reader when an option is configured. A
short beep indicates that a valid setting has been saved.
For a chart of the controller board with input and output connections mentioned below,
see the LR-series Installation Manual [2].
© TagMaster AB 22 (40)
PassMan Software Manual Doc no. 06-240 07
configuration interface.
B. RS485 RS485 is used as serial interface to
host computer. RS232 is used as
configuration interface.
© TagMaster AB 23 (40)
PassMan Software Manual Doc no. 06-240 07
© TagMaster AB 24 (40)
PassMan Software Manual Doc no. 06-240 07
Note: Never mix ID-tag data speeds by using high for the Reader and low for the ID-
tag or vice versa; in such cases the ID-tag will not be read.
© TagMaster AB 25 (40)
PassMan Software Manual Doc no. 06-240 07
© TagMaster AB 26 (40)
PassMan Software Manual Doc no. 06-240 07
If motion detection is enabled, the sensitivity level is set according to the section 5.2.16
and an output can be activated according to the setting described in section 5.2.17.
© TagMaster AB 27 (40)
PassMan Software Manual Doc no. 06-240 07
© TagMaster AB 28 (40)
PassMan Software Manual Doc no. 06-240 07
© TagMaster AB 29 (40)
PassMan Software Manual Doc no. 06-240 07
© TagMaster AB 30 (40)
PassMan Software Manual Doc no. 06-240 07
© TagMaster AB 31 (40)
PassMan Software Manual Doc no. 06-240 07
Table 40 ID-tag mark and site code as serial data: ID-tag mark field setting
Set the site code field length to zero to omit the site code from the sent message.
© TagMaster AB 32 (40)
PassMan Software Manual Doc no. 06-240 07
Set the site code field length to zero to omit the site code from the sent message.
© TagMaster AB 33 (40)
PassMan Software Manual Doc no. 06-240 07
Table 52 ID-tag mark and site code as Wiegand data: ID-tag mark used number of bits setting
© TagMaster AB 34 (40)
PassMan Software Manual Doc no. 06-240 07
Set the site code field length to zero to omit the site code from the sent message.
© TagMaster AB 35 (40)
PassMan Software Manual Doc no. 06-240 07
Table 57 ID-tag mark and site code as Wiegand data: First parity bit range setting
© TagMaster AB 36 (40)
PassMan Software Manual Doc no. 06-240 07
6 Testing
This section describes how to carry out performance tests using the Reader application
software.
After completing the configuration as described in the previous sections, carry out a
basic reading test.
The guidelines in section 6.2 Trouble Shooting may be valuable if an error occurs.
1. Switch on power to the Reader. The externally-visible indicator will flash green
to show that the Reader has been initiated.
2. Set the Reader to operating mode “Read test”.
3. Place an ID-tag in front of the Reader having the ID-tag on the object where it
normally will be mounted. Perform repeated readings while simultaneously
moving the ID-tag along the expected movement path and check that the ID-tag
can be read in all expected positions. Each reported reading will be indicated by
a beep and a flash by the externally-visible indicator.
Problem Solution
The externally-visible indicator is Check the Reader installation according
constantly off. to the LR-series Installation Manual [2].
The Reader does not beep when an ID- If several Readers are used in close
tag is presented during read test mode. proximity to each other, set them to
different frequency channels.
Verify that the tag speed setting of the
Reader corresponds to the tag speed of
the ID-tag.
© TagMaster AB 37 (40)
PassMan Software Manual Doc no. 06-240 07
7 Contact
For any further inquiries, please contact TagMaster AB.
7.2 Office
TagMaster AB
Kronborgsgränd 1
S-164 87 KISTA, Sweden
© TagMaster AB 38 (40)
PassMan Software Manual Doc no. 06-240 07
8 Glossary
The following abbreviations and acronyms are used in this manual:
© TagMaster AB 39 (40)
PassMan Software Manual Doc no. 06-240 07
9 References
[1] GEN4 Reader User's Manual
Doc no. 06-118
[2] LR-series Installation Manual
Doc no. 06-136
© TagMaster AB 40 (40)