Papyrus Time Trek

Papyrus Time Trek Telnet Communication Protocol Version 3.0.x

Major Changes in 3.0

Biometric Algorithm is improved to allow finger to scan even through the wet surface. This has increased the template size from 272 Byte to 938 Byte. Thus the command 2207 and 2263 for download template is further breakup into 2 session to minimize the no of byte send per session.
The maximum ID length is limit to 10 digit from 15 digit to maximize the memory space.

The terminal can be used as a Telnet client terminal to connect to a Telnet Server. The Telnet Host can send down the command specify in the protocol. the command must be sent with [,] as separator and terminate the line with <CR><LF>

To send the command, the format should follow:-

Terminal MacID, Command, Mode, parameter 1, parameter 2, ... parameter n

Command Mode is set either in 0 or 1. 0 is to query the current terminal setting and 1 will set the terminal in accordance to the parameter sent. If the terminal receive the command successfully, it will reply in the same format and parameter of the new setting. Otherwise either there is error in the data format send or the command is not allow at the point where the terminal receiving it.

The detail format of the command as follows:-

Command

Function

Parameter

Default Value

1101

Configure Network Setting. When DHCP option is enable and with the DHCP server present, the network setting can be set automatically by the DHCP server.

MacID

1101

Mode (0-Query,1-Set)

Terminal IP Address dotted IP address

10.0.0.2

Terminal Net Mask dotted IP address

255.255.255.0

Terminal Gateway dotted IP address

0.0.0.0

Terminal DNS (Not Use, must specify as 0)

DHCP. Option (0-Disable,1-Enable)

1102

Set Host IP. The terminal will use the host IP setting here to connect to the host. It can automatically switch to next setting when the connection lost. Leave the IP as "0.0.0.0" if the additional host is not use.

MacID

1102

Mode (0-Query,1-Set)

Host Server #1 IP Address dotted IP address

10.0.0.1

Host Server #2 IP Address dotted IP address

0.0.0.0

Host Server #3 IP Address dotted IP address

0.0.0.0

1105

Set Telnet Host port. Telnet host port can be set other that port 23 as long as the port is not used by other application.

MacID

1105

Mode (0-Query,1-Set)

Telnet Host Port

1106

Set encryption option and encryption key. Encryption method is using Rijndael Advance Encryption Standard (AES 128 bit ) with 4 by 4 block 10 rounds encryption.

MacID

1106

Mode (0-Query,1-Set)

Encryption Mode (0-Disable,1-Enable)

Encryption Key (32 byte Hex Representation)

1107

When "encrypted mode" is enable in command "1106". Scramble option will automatically turn on each time the terminal establish the connection to the host, until disable by using this command. When enable, any data that is send to the terminal will be decrypted before being process by the terminal. Therefore if the data is not encrypted using the same key set in "1106", the terminal will just ignore it.

MacID

1107

Mode (0-Query,1-Set)

Scramble option (0-Disable,1-Enable)

1108

Encryption test.

The terminal will reply with the decrypted data in 32byte hex representation.

MacID

1108

Mode (0-Query,1-Set)

Encryption Data (32 byte Hex Representation)

1201

Set Serial port configuration. The serial port will wait for the end character specify or the time out duration specify to consider as completion of data.

MacID

1201

Mode (0-Query,1-Set)

Port Number (1/ 2 others ignore)

Baud Rate (2400/4800/9600/115200)

9600

Parity (N-none, E-even, O-Odd)

Data bit 7/8

Stop bit 1/2

End Char Terminating Character

Time Out in millisecond

1000

1202

Enable or disable Serial port 2 as Gateway. This port can be used to attach a serial printer. When Gateway is enable, Host can send down any string or printer command to this port. The communication for this port is bidirectional.

MacID

1202

Mode (0-Query,1-Set)

Use as serial gateway (0-Disable,1-Enable)

Start gateway function (0-Stop,1-Start)

1203

Start or stop the Gateway. By default the gateway is stop even it is enable. The host software needs to control the use of this port by using this command.

MacID

1202

Mode (0-Query,1-Set)

Option 0-Stop,1-Start

1204

Gateway data collected from serial. The data will be send in 127 byte per block or when End character receive or Time out due.

MacID

1204

Mode (0-Query,1-Set)

No Of Actual Byte 0-127

Hex Representation 00 hex - FF hex

1205

Host send data through the gateway to the attached serial device. Data longer then 127 byte should be break up in multiple block of less than 128 byte. The terminal will reply the actual no of byte delivered to the serial. If the buffer is full or block at the time of sending, host can re-sent the no of byte that is not sent.

MacID

1205

Mode (0-Query,1-Set)

No Of Actual Byte 0-127

Hex Representation 00 hex - FF hex

1301

Set Terminal extended Identification. The extended Identifier is use for the host software to identify the terminal when it is connected to the host.

MacID

1301

Mode (0-Query,1-Set)

Terminal Identification use to identify the terminal

Terminal Function use to identify the usage of the terminal

Terminal Location use to identify the location of the terminal.

1302

Set System Clock

MacID

1302

Mode (0-Query,1-Set)

Month 01-12

Day 01-31

Year 1980-2116

Hour 01-23

Minute 01-59

Second 01-59

1303

LCD Back light idle time. The backlight will automatically turn off to preserve the operating power particularly when it is power by backup battery.

MacID

1303

Mode (0-Query,1-Set)

Time Idle 0-Always On, 1-9999 seconds

1401

Check available ram space

Host Send

MacID

1401

Mode (0-Query)

Terminal Reply

MacID

1401

Mode (0-Query)

Max Validation record

Max Transaction record

1901

Set terminal reply after receiving of command. Terminal reply can be turn off to reduce network traffic.

MacID

1901

Mode (0-Query,1-Set)

Option (0-no reply,1-require reply)

1902

Save Setting to Flash Ram. Changes to the setting will not save to the flash ram until this command is sent.

MacID

1902

Mode (0-Query,1-Set)

Option (0-ignore,1-Set)

1903

Reset configuration to factory default. The terminal will reset itself, once the default configuration is loaded.

MacID

1903

Mode (0-Query,1-Set)

Option (0-not reset,1-Reset and Load Factory default)

1904

Reset Terminal

MacID

1904

Mode (0-Query,1-Set)

Option (0-not reset,1-Reset Terminal)

2101

Display Text at LCD display

MacID

2101

Mode (0-Query,1-Set)

Line No 1 to 4

Display Text Max 20 Byte ASCII Character

2102

Set and condition Input. Input 1 to 8 can be transfer to control to the host application.

Input #	Local Function
1	DOOR OPEN SENSOR
2	PUSH BUTTON
3	ALARM RESET
4	INPUT4 3
5	INPUT5 4
6	INPUT6 5
7	INPUT7 6
8	INPUT8 7

MacID

2102

Mode (0-Query,1-Set)

Input No 1 to 8

Local or Host Control (0-Local,1-Host)

Input de-bounce duration 0-65535 seconds

2103

Query Input Status

Host Send

MacID

2103

Mode 0-Request

Terminal Reply

MacID

2103

Mode 0-Request

Input#1 0-Off,1-On

Input#2 0-Off,1-On

Input#3 0-Off,1-On

Input#4 0-Off,1-On

Input#5 0-Off,1-On

Input#6 0-Off,1-On

Input#7 0-Off,1-On

Input#8 0-Off,1-On

2104

When Input is set to acknowledge host in <2403>.The terminal will send the data upon change of state or when acknowledge interval expires.

MacID

2104

Mode 0-Query

Input No 1 to 8

Input State 0-Off,1-On

Time Stamp yyyymmddhhmnss

2105

Enable Output Control to host control.

Output #	Local Function
1	NO READ Signal
2	GOOD READ Signal
3	LOCK
4	ALARM
5	OUTPUT 5
6	SIREN 1
7	SIREN 2
8	OUTPUT 8
9	BUZZER

When use with dual scanner and biometric reader,Output1 is not available

MacID

2105

Mode (0-Query,1-Set)

Output No 1 to 9 where 8-LCD back light 9-Buzzer

Control 0-Local,1-Host

default duration 0-65535 seconds (NOT USED)

2106

Query Output Status

Host Send

MacID

2106

Mode 0-Query

Terminal Reply

MacID

2106

Mode 0-Request

Output#1 0-Off, 1-On

Output#2 0-Off, 1-On

Output#3 0-Off, 1-On

Output#4 0-Off, 1-On

Output#5 0-Off, 1-On

Output#6 0-Off, 1-On

Output#7 0-Off, 1-On

LCD Back Light 0-Off, 1-On

Buzzer 0-Off, 1-On

2107

Change Output State. Output 1 to Output 7 are external output. Output 8 is LCD. Back Light and Output 9 is Buzzer.

MacID

2107

Mode 0-Query, 1-Set

Output No 1 to 9

Frequency 0-permenent On, other-no of times

Duration 0-65535 seconds

2201

TimeTrek Terminal Configuration.

MacID

2201

Mode 0-Query, 1-Set

Time Display Format 0-24Hours military time, 1-Am Pm

Show Scan ID 0-Enable, 1-Disable

Swipe Display Time Out seconds

Re-Entrant Time seconds

Door Open Period seconds

Look Release Period seconds

Reader Type (1-Single 2-Dual)

ID Length (Length must not exceed 20)

Data Auto Clearing Mode (0-None,1-FIFO)

Reserved

Host Verify Option 0-Disable, 1-Enable

Local Verify Option 0-Disable, 1-Enable

Strict Verification 0-Disable, 1-Enable

Host Verify Time Out 0-65535 ms

Reason Selection (0-Disable ,1-Enable)

Default Reason Code

Remain Last Reason Selected

2202

Set option to store name or descriptive text for the ID Scan. This option can only be changed when validation table and transaction table is empty.

MacID

2202

Mode 0-Query, 1-Set

0-do not store name,1-require to store

2203

Host Verify.

If host verify is enable, the terminal will send the ID to the host and get the host verification. In this case data will not store to ram, and host application has to take care of the data collection. However, if the local verification option is enable and host is not present or host verification is disable, the local verification and data retention will take place. When strict verification is enable, all invalid card will not be register.

When host verifying the ID, the result or response from host can be sent down with custom message or standard message assigned in "SYSTEM TEXT" using command "2210"

For host verification with Biometric, use command "2207" to update the current biometric data for Finger#1 and Finger#2 before sending "2203" command.

Terminal Send

MacID

2203

Mode 0-Query

Month 01 to 12

Day 01 to 31

Year 1980-2116

Hour 01 to 24

Minute 01 to 59

Seconds 01 to 59

Reason Code 1 to 40

Scanner No 1 to 2

Host Send

Mac ID

2203

Mode 1-Reply

Verification Result 0 or 4 - invalid ,1 or 3-Valid (3 and 4 use custom message)

Confirm ID send by terminal

Custom Messages Display at Line 1 and Line 2 (40 Character)

2204

Synchronize Data store in RAM during Host absent. When host request the terminal to sync its data using <2205>, the terminal will reply as follows.

Terminal Send

MacID

2204

Mode 0-Request to synchronize

Month 01 to 12

Day 01 to 31

Year 1980-2116

Hour 01 to 24

Minute 01 to 59

Seconds 01 to 59

Reason Code 1 to 40

Scanner No 1 to 2

Host Send

Mac ID

2204

Mode 1-Reply

Synchronize Result 0-not ready, 1-Syncronise Done

2205

Request Terminal to Synchronize Data in RAM. The terminal will reply to the host the status of synchronization. Synchronization will not start if the terminal is busy collecting scanned data.

MacID

2205

Mode 0-Query, 1-Set

Option 0-Stop, 1-Start

2206

Request Terminal to stop scanning, Display of text can be send down to alert
users.

MacID

2206

Mode 0-Query, 1-Set

Option 0-Stop, 1-Start

2207

Set current biometric data use for verification.

suggestion: To reduce the amount of network traffic, use command "1901" to disable the reply from terminal.

MacID

2207

Mode 0-Query, 1-Set

Record No (always use 0)

Finger No (1-Finger#1 , 2-Finger#2)

Parts Of Finger (1-1st Part,2-2nd Part)

Finger Print Data ( HEX 469 * 2 byte) or (ASCII 938 / 2 byte)

2208

Biometric Configuration.

MacID

2208

Mode 0-Query, 1-Set

Finger Detection Time Out (1-30 seconds)

Biometric Capturing Level (1-100%)

100

Biometric Verification Level (1-100%)

No Of Retry (1-10)

2210

Request Terminal to list out the System Text.

MacID

2210

Mode 0-Query, 1-not use

From Item No

To Item No

(Default System Text)

Item	Text	Display When
1	Verifying Pls wait..	During verification from local or host
2	ID Verification OK	Verification successful
3	IN-VALID ID !!!	Verification un-successful
4	Give Way Please !!!	when 2 terminal control the same shuttle, inform the other to wait. (ST Version only)
5	Scan Again Later...	Host is busy or time out.
6	Door Released...	Door is opened (DA Version only)
7	ID Registered...	Verification successful (DA Version only)
8	Buffer Full...	Storage memory for transaction full.
9	Card Is Passed Back!	ID is registered twice in anti pass back (DA Version only)
10	remove finger	Biometric Verification Message
11	finger detected	Biometric Verification Message
12	finger detected	Biometric Verification Message
13	move finger up	Biometric Verification Message
14	move finger down	Biometric Verification Message
15	move finger left	Biometric Verification Message
16	move finger right	Biometric Verification Message
17	press finger harder	Biometric Verification Message
18	bad detection	Biometric Verification Message
19	no finger detected	Biometric Verification Message
20	verification fail	Biometric Verification Message
21	user info in-correct	Biometric Verification Message
22	user data not exist	Biometric Verification Message
23	sensor error	Biometric Verification Message
24	next finger	Biometric Verification Message
25	system is busy	Biometric Verification Message
26	try left thumb	Biometric Verification Message
27	place right thumb	Biometric Verification Message
28	place left thumb	Biometric Verification Message
29	2nd verification	Request 2nd verification when Adhoc table sets in "2291"
30	wrong biodata format	Biometric Verification Message
31	matching fail	Biometric Verification Message
32	matching successful	Biometric Verification Message

2211

Set and Change System Text Content

MacID

2211

Mode 0-Query, 1-Set

Item No 1 to 10

Content ASCII 20 Byte

2220

Request Terminal to list out the Reason Code.

(Up to 40 Reason Code can be stored)

MacID

2220

Mode 0-Query, 1-not use

From Item No

To Item No

2221

Set or Change Reason Code Content

MacID

2221

Mode 0-Query, 1-Set

Item No 0-Add others to change (Max 40)

Content ASCII 20 Byte

2222

Delete All Reason Code Content

MacID

2222

Mode 0-not use, 1-Set

Option 0-not use, 1-Delete

2230

Request Terminal to list out the Alarm Setting.

(Up to 40 Alarm Setting can be set)

MacID

2230

Mode 0-Query, 1-not use

From Item No

To Item No

2231

Set or Change Alarm Setting.

When date is specify, the day of week will be offset for the particular date.

MacID

2231

Mode 0-Query, 1-Set

Item No 0-Add others to change (Max 40)

Hour 00 to 24

Minute 00 to 59

Month 01 to 12

Day 01 to 31

Year 1980 to 2116

Every Sunday (0-not apply ,1-applicable)

Every Monday (0-not apply ,1-applicable)

Every Tuesday (0-not apply ,1-applicable)

Every Wednesday (0-not apply ,1-applicable)

Every Thursday (0-not apply ,1-applicable)

Every Friday (0-not apply ,1-applicable)

Every Saturday (0-not apply ,1-applicable)

Door allow to remain open (0 - No, 1-Yes)

Siren# 1 trigger duration 0-Disable Others -Length of trigger (Max=255sec)

Siren# 2 trigger duration 0-Disable Others-Length of trigger (Max=255sec)

2232

Delete All Alarm Setting

MacID

2232

Mode 0-not use, 1-Set

Option 0-not use, 1-Delete

2260

Request Terminal to list out the Validation Table

MacID

2260

Mode 0-Query, 1-not use

From Item No

To Item No

2261

Set or Change Validation Table

(Up to 9600 records when store with name and 24000 records when store w/o name)

When Time Zone group is set, Status will match against the time range set forth in the time zone group.

MacID

2261

Mode 0-Query, 1-Set

Record No 0-Add others to change

ID (ASCII 20 Byte)

Status (0-Active 1-On Hold) / Time Zone Group

Name (Optional)

2262

Delete Validation Table

MacID

2261

Mode 0-not use, 1-Set

Option 0-not use, 1-Delete

2263

Set or Change Biometric Data.

Record No is the record location of the validation table that store the ID.

Use command "1901" to disable the reply from terminal to reduce the network traffic

MacID

2263

Mode 0-Query, 1-Set

Record No

Finger No (1-Finger#1 , 2-Finger#2)

Parts Of Finger (1-1st Part,2-2nd Part)

Finger Print Data ( HEX 469 * 2 byte) or (ASCII 938 / 2 byte)

2270

Request Terminal to list out the Transaction record store in Ram.

The reply format is the same as in "2203"

(Up to 10,000 transaction can be stored in RAM)

MacID

2270

Mode 0-Query, 1-not use

From Item No

To Item No

2272

Delete All Transaction Store in RAM

MacID

2272

Mode 0-not use, 1-Set

Option 0-not use, 1-Delete

2280

Request terminal to list Time Zone Group

MacID

2280

Mode 0-Query, 1-not use

From Item No

To Item No

2281

Set or Change Time Zone Group.

Up to 255 time zone can be set to verify authorize access of ID group.

MacID

2281

Mode 0-Query, 1-Set

Record No 0-Add others to change

Group No (0-254 max 255 groups)

From Hour (0-23)

From Minute (0-59)

To Hour (0-23)

To Minute (0-59)

Every Sunday (0-not apply ,1-applicable)

Every Monday (0-not apply ,1-applicable)

Every Tuesday (0-not apply ,1-applicable)

Every Wednesday (0-not apply ,1-applicable)

Every Thursday (0-not apply ,1-applicable)

Every Friday (0-not apply ,1-applicable)

Every Saturday (0-not apply ,1-applicable)

2282

Delete all Time Zone Group

MacID

2282

Mode 0-not use, 1-Set

Option 0-not use, 1-Delete

2290

Request terminal to list Adhoc item

MacID

2290

Mode 0-Query, 1-not use

From Item No

To Item No

2291

Set or Change Adhoc Table and set double verification option.

Total 100 Adhoc item can be set. All item has to be sorted on ID. Each ID allow more then one item. Set 2nd ID to "FFFFFFFFFF" if 2nd verification is not requied.

(Double Verification is only available in Biometric Version)

MacID

2291

Mode 0-Query, 1-Set

Record No 0-Add others to change

ID (ASCII 20 Byte)

Month 01 to 12

Day 01 to 31

Year 1980 to 2116

From Hour (0-23)

From Minute (0-59)

To Hour (0-23)

To Minute (0-59)

ID for 2nd Verification (ASCII 20 Byte)

2292

Delete all Adhoc item

MacID

2292

Mode 0-not use, 1-Set

Option 0-not use, 1-Delete

5.1 Flash Memory Utilization Note

The validation table and some system data except transaction data is store in flash memory. Since there is a maximum write cycle of 10,000,Special care
should be taken when writing data to the flash, the terminal is already programmed to check if write access is necessary before writing to the sector, when data
is the same as in the memory the write cycle is by pass. However, if the memory is cleared by the clear command, the terminal need to re-write the data.

The recommended approach is to check the current number of item available and use change instead of add new by specifying the item number to update
the memory. Apply add new after the item number that is greater than the available.

5.2 4 MB Extended Flash Ram

The 4 MB extended ram is required to store the biometric data when reader type is set to BIOMETRIC II. Up to a total of 14000 biometric data
can be stored in the ram with 7000 record for Finger#1 and Finger#2 respectively.