SmartLink

Reference Manual

Reference Manual

DN1327-1004
 EntraPass SmartLink Reference Manual

TABLE OF CONTENTS

1.0 - Introduction ............................................................................. 1

1.1 Starting the Application ...................................................................................... 1
2.0 - SmartLink Configuration ......................................................... 3
2.1 Start-up .............................................................................................................. 3
2.2 Message Mode (light blue) ................................................................................ 3
2.3 Command Mode (dark blue) .............................................................................. 3
3.0 - Message Mode Processing ..................................................... 5
3.1 List of Message Variables ................................................................................. 6
3.2 List of Destination Variables .............................................................................. 9
3.3 Secondary Commands ................................................................................... 10
3.4 Emailing ........................................................................................................... 11
3.5 Modem and Pager ......................................................................................... 14
3.6 Network .......................................................................................................... 15
4.0 - Communication Protocol....................................................... 17
4.1 Communication modes.................................................................................... 17
4.0.1 Serial Port ........................................................................................................ 17
4.2 Command Format ............................................................................................ 17
4.3 Returned Format ............................................................................................. 17
4.0.2 Common error messages................................................................................. 18
5.0 - Commands.............................................................................. 19
5.1 Standard Command List Summary ................................................................ 19
5.2 Enhanced Command List Summary ............................................................... 22
5.3 Login ................................................................................................................ 23
5.4 Logout .............................................................................................................. 23
5.5 ConnectionState .............................................................................................. 24
5.6 AddCard .......................................................................................................... 24
5.7 ModifyCard ...................................................................................................... 25
5.8 DeleteCard ...................................................................................................... 26
5.9 GetCardInfo ..................................................................................................... 26
5.10 GetCardInfoPicture ........................................................................................ 27
5.11 GetCardPicture .............................................................................................. 28
5.12 SetCardPicture .............................................................................................. 28
5.13 GetCardSignature .......................................................................................... 28
5.14 SetCardSignature .......................................................................................... 29
5.15 GetNip ........................................................................................................... 29
5.16 SetNip ............................................................................................................ 29
5.17 GetCountUsage ............................................................................................. 30
5.18 SetCountUsage ............................................................................................. 30
5.19 SetCountUsageManual ................................................................................. 31
5.20 DecCountUsage ............................................................................................ 31
5.21 IncCountUsage .............................................................................................. 31
5.22 ResetCountUsage ......................................................................................... 32
5.23 GetLastAddedCard ........................................................................................ 32
5.24 ArmAlarmSystem (Global only) ..................................................................... 33
5.25 DisarmAlarmSystem (Global only) ................................................................ 33
5.26 PostponeAlarmSystem (Global only) ............................................................. 33
5.27 AreaMoveCard (Global only) ......................................................................... 34

DN1327-1004 I
 5.28 HardResetController ...................................................................................... 34
5.29 SoftResetController ....................................................................................... 34
5.30 ForgiveController ........................................................................................... 35
5.31 ReloadController ............................................................................................ 35
5.32 LockDoor ....................................................................................................... 35
5.33 UnlockDoor .................................................................................................... 36
5.34 UnlockTempoDoor ......................................................................................... 36
5.35 ReturnScheduleDoor ..................................................................................... 36
5.36 ToggleDoorStrike ........................................................................................... 37
5.37 LockDoorGroup ............................................................................................. 37
5.38 UnlockDoorGroup .......................................................................................... 37
5.39 UnlockTempoDoorGroup ............................................................................... 38
5.40 ReturnScheduleDoorGroup ........................................................................... 38
5.41 ArmDoor ........................................................................................................ 39
5.42 DisarmDoor ................................................................................................... 39
5.43 ArmDoorGroup .............................................................................................. 39
5.44 DisarmDoorGroup ......................................................................................... 40
5.45 DeactivateRelay ............................................................................................ 40
5.46 ActivateRelay ................................................................................................. 40
5.47 ActivateTempoRelay ..................................................................................... 41
5.48 ReturnScheduleRelay .................................................................................... 41
5.49 ToggleRelayActivation ................................................................................... 42
5.50 DeactivateRelayGroup .................................................................................. 42
5.51 ActivateRelayGroup ....................................................................................... 42
5.52 ActivateTempoRelayGroup ........................................................................... 43
5.53 ReturnScheduleRelayGroup .......................................................................... 43
5.54 UnshuntInput ................................................................................................. 44
5.55 ShuntInput ..................................................................................................... 44
5.56 ShuntInputTempo .......................................................................................... 44
5.57 SuperviseInput ............................................................................................... 45
5.58 ReturnScheduleInput ..................................................................................... 45
5.59 ToggleInputShunt .......................................................................................... 46
5.60 UnshuntInputGroup ....................................................................................... 46
5.61 ShuntInputGroup ........................................................................................... 46
5.62 ShuntTempoInputGroup ................................................................................ 47
5.63 SuperviseInputGroup ..................................................................................... 47
5.64 ReturnScheduleInputGroup ........................................................................... 48
5.65 EnableDoor .................................................................................................... 48
5.66 DisableDoor ................................................................................................... 48
5.67 EnableDoorGroup .......................................................................................... 49
5.68 DisableDoorGroup ......................................................................................... 49
5.69 LockElevatorDoor .......................................................................................... 50
5.70 UnlockElevatorDoor ....................................................................................... 50
5.71 UnlockTempoElevatorDoor ........................................................................... 50
5.72 ReturnScheduleElevatorDoor ........................................................................ 51
5.73 LockElevatorDoorGroup ................................................................................ 51
5.74 UnlockElevatorDoorGroup ............................................................................. 52
5.75 UnlockTempoElevatorDoorGroup ................................................................. 52
5.76 ReturnScheduleElevatorDoorGroup .............................................................. 52
5.77 EnableElevatorDoor ...................................................................................... 53
5.78 DisableElevatorDoor ...................................................................................... 53
5.79 EnableElevatorDoorGroup ............................................................................ 54

II DN1327-1004
 EntraPass SmartLink Reference Manual

5.80 DisableElevatorDoorGroup ............................................................................ 54

5.81 EnableFloorElevatorDoor .............................................................................. 54
5.82 DisableFloorElevatorDoor ............................................................................. 55
5.83 EnableFloorElevatorDoorGroup .................................................................... 55
5.84 DisableFloorElevatorDoorGroup ................................................................... 56
5.85 WorkstationStatus ......................................................................................... 56
5.86 GatewayStatus .............................................................................................. 56
5.87 SiteStatus ...................................................................................................... 57
5.88 ControllerStatus ............................................................................................. 57
5.89 DoorStatus ..................................................................................................... 58
5.90 RelayStatus ................................................................................................... 59
5.91 InputStatus .................................................................................................... 60
5.92 OutputStatus (Not implemented) ................................................................... 61
5.93 AlarmSystemStatus (Global only) .................................................................. 61
5.94 AreaStatus (Global only) ............................................................................... 62
5.95 GuardTourStatus (Global only) ...................................................................... 62
5.96 GetLastTransactionCard ............................................................................... 63
5.97 GetReportEmail ............................................................................................. 63
5.98 ConnectSite ................................................................................................... 64
5.99 DisconnectSite ............................................................................................... 64
5.100 UpdateRemoteSite ...................................................................................... 64
5.101 UpdateRemoteSiteGateway ........................................................................ 65
5.102 UpdateAllSite ............................................................................................... 65
5.103 ExecuteTask ................................................................................................ 65
5.104 BatchModify ................................................................................................. 66
5.105 GetDescription ............................................................................................. 66
5.106 EmailPassword ............................................................................................ 67
5.107 ChangePassword ........................................................................................ 67
5.108 GetCardAccessGroup ................................................................................. 67
5.109 GetAccessLevelDescription ......................................................................... 68
5.110 AddToTrigger ............................................................................................... 68
5.111 RemoveFromTrigger ................................................................................... 69
5.112 GetList ......................................................................................................... 69
5.113 GetListOwnerBy .......................................................................................... 70
5.114 GetListGraphicUrl ........................................................................................ 70
5.115 GetFind ........................................................................................................ 71
5.116 GetFindNext ................................................................................................ 72
5.117 AddHoliday .................................................................................................. 72
5.118 GetHoliday ................................................................................................... 73
5.119 ModifyHoliday .............................................................................................. 74
5.120 DeleteHoliday .............................................................................................. 74
5.121 AddSchedule ............................................................................................... 74
5.122 GetSchedule ................................................................................................ 75
5.123 ModifySchedule ........................................................................................... 76
5.124 DeleteSchedule ........................................................................................... 76
5.125 AddAccessLevel .......................................................................................... 77
5.126 GetAccessLevel ........................................................................................... 77
5.127 ModifyAccessLevel ...................................................................................... 78
5.128 DeleteAccessLevel ...................................................................................... 78
5.129 AddSite (FastSetup) .................................................................................... 79
5.130 GetSite ......................................................................................................... 81
5.131 ModifySite .................................................................................................... 81

DN1327-1004 III
 5.132 DeleteSite .................................................................................................... 82
5.133 AddController (ExpressSetup) ..................................................................... 82
5.134 GetController ............................................................................................... 85
5.135 ModifyController .......................................................................................... 85
5.136 DeleteController ........................................................................................... 86
5.137 GetDoor ....................................................................................................... 86
5.138 ModifyDoor .................................................................................................. 90
5.139 DeleteDoor .................................................................................................. 90
5.140 GetRelay ...................................................................................................... 90
5.141 ModifyRelay ................................................................................................. 91
5.142 DeleteRelay ................................................................................................. 91
5.143 GetInput ....................................................................................................... 91
5.144 ModifyInput .................................................................................................. 92
5.145 DeleteInput .................................................................................................. 93
5.146 GetOutput .................................................................................................... 93
5.147 ModifyOutput ............................................................................................... 94
5.148 DeleteOutput ............................................................................................... 94
5.149 GetSiteStructure .......................................................................................... 94
5.150 GetSiteCard ................................................................................................. 95
5.151 AddAccount ................................................................................................. 95
5.152 GetAccount .................................................................................................. 96
5.153 ModifyAccount ............................................................................................. 97
5.154 DeleteAccount ............................................................................................. 97
5.155 SwitchAccount ............................................................................................. 97
6.0 - SmartDll................................................................................... 99
7.0 - Appendix #1, Error messages............................................. 108
8.0 - Appendix #2, EntraPass events .......................................... 111

IV DN1327-1004
EntraPass SmartLink Reference Manual

DN1327-1004 V
VI DN1327-1004
 EntraPass SmartLink Reference Manual

1.0 - Introduction
The SmartLink option is available with EntraPass Corporate and Global editions and provides optimal
automated monitoring tools to security, monitoring, configuration and automation administrators.

One of the main features consists in creating SmartLink instructions (events generator) through which,
for example, e-mails are s ent to a p redefined recipient when predetermined alarm events such as a
“door forced” or “card trace”occur.

1.1 Starting the Application

SmartLink allows for many operation s to be carried out with an unlimited number of event s. For such
purposes, the EntraPass i nterface is sufficient. H owever, for a wider a nd more special ized range of
options, SmartLink can be used apart from th e EntraPass interface, as a st and alone program (.exe
file). A Customer Sof tware D evelopper may inte rface directly with SmartLink u sing a provided DL L
called SmartDLL.

From the Entra Pass interface, the SmartLi nk oper ation ca n be invoked through the De finition t ab |
Event Trigger.

The figure below indicates a SmartLink command being requested after an event has been initiated:

The Event Trigger feature sends the task to be executed to the SmartLink application:

DN1327-1004 1
 Below is the main window of the SmartLink application, in which SmartLink tasks are executed:

2 DN1327-1004
 EntraPass SmartLink Reference Manual

2.0 - SmartLink Configuration

2.1 Start-up
On st art-up, SmartLink sends a reques t to the server i n order to re trieve the conn ection o ptions for
serial output and network modes. Following that request, if the SmartLink network connection mode is
other than ’None’, the network serve r will st art-up to a llow a client a pplication to connect, eith er to
execute network commands or to receive messages sent over the network, or both simultaneously. A
macro is in cluded in thi s request and wi ll b e ex ecuted at st art-up (yellow). It is d efined on the
workstation (gree n) and ca n be used to open th e bidirectional or unidirectional serial output, or any
other valid SmartLink co mmand. Another macro is u sed to manage messa ges when n o ma cro is
specified.

2.2 Message Mode (light blue)

To ena ble the message sen ding functionality from t he serial or n etwork outp ut, SmartLink must b e
properly configured from the workstations:

Sending messages from the serial output :

Option on screen : Smartl ink serial con nection = Messages only or Messages and
Commands.

Sending messages from the network output :

Option on screen : Sma rtlink network connection = Messages only or Messages and
Commands.

2.3 Command Mode (dark blue)

To enab le the co mmand sending function ality (bidirectional mode ) through the serial or the netwo rk
output, SmartLink must be properly configured from the workstations:

Commands from the serial output :

Option on scree n : Smartl ink se rial co nnection = Commands only or Messages and
Commands.

Commands from the network output :

Option on screen : Smartlink network connection = Commands only or Messages and
Commands.

DN1327-1004 3
4 DN1327-1004
 EntraPass SmartLink Reference Manual

3.0 - Message Mode Processing

The message mode allows redirecting formatted data to a selected location :
• write on the hard disk, a diskette or CD/DVD (see : $v)
• send through a serial port (com1, com2 ..) (see : $u)
• send through a modem (modem link) (see : ~m)
• send through a modem (digital pager) (see : ~m)
• send through an email (see : ~e)
• send through a network (see : $r)
• to all connected client applications
• to an application with a specific identifier

Important: All messages received in Smartlink are pro cessed sequentially,

so sp ecial care should b e t aken when defining an instru ction,
particularly for processing through a modem.
Example: During a modem connection (function : Dial), it is better not to define a number of
connection trials too h igh. Otherwise, SmartLink will wait for an established connection or
for the connection delay or the number of trials to expire.

EntraPass Server

Connection Connection Connection Connection

Id 1000 Id 2000 Id 3000 Id 4000

SmartLink

E-mail

Id = 2000
Network Id = 1000 Id = 3000 Id = 4000

RS-232

Modem

Pager

Disk or CD

DN1327-1004 5
 3.1 List of Message Variables

Variable Description
$a Year (4 characters)
$b Month (2 characters)
$c Day (2 characters)
$d Hour (2 characters)
$e Minute (2 characters)
$f Second (2 characters)
$g Event number (4 characters)
$h Event text (up to 50 characters)
$l1 Number of indexes #1 fixed (2 characters)
$m1 Text of index #1
$n1 Number of fields #1
$o 1 Text of field #1
$l2 Number of indexes #2 (2 characters)
$m2 Text of index #2
$n2 Number of fields #2
$o2 Text of field #2
$l3 Number of indexes #3 (2 characters)
$m3 Text of index #3
$n3 Number of fields #3
$o3 Text of field #3
$l4 Number of indexes #4 (2 characters)
$m4 Text of index #4
$n4 Number of fields #4
$o4 Text of field #4
$z0 Card number
$z1 Card user name
$z2 Card Information field #1
$z3 Card Information field #2
$z4 Card Information field #3
$z5 Card Information field #4
$z6 Card Information field #5
$z7 Card Information field #6
$z8 Card comment field
$z9 Card Information field #7
$za Card Information field #8
$zb Card Information field #9
$zc Card Information field #10

The EntraPass Command Editor can be used to generate the code needed to execute the operation.

6 DN1327-1004
 EntraPass SmartLink Reference Manual

Here is a list of the possible values for the index number and the index text

Index Number Index Text

01 Access level
02 Access level group
03 Alarm system
04 Area
05 Card
06 Card access group
07 Visitor card
08 Card type
10 Controller
11 Controller group
12 Door
13 Door group
15 Event relay
16 Floor
17 Floor group
18 Graphic
19 Gateway
20 Guard tour
21 Holiday
22 Input

DN1327-1004 7
 Index Number Index Text
23 Input group
24 Instruction
25 Trigger
26 Roll call report
35 Video record
36 Panel
37 Panel component
39 Muster report
41 Tenant
42 Camera
43 Message view
44 EntraPass Application
45 Operator
46 Security level
47 Output
48 Video trigger
49 Relay
50 Relay group
51 Archival Report
52 Schedule
53 Site
54 Time and attendance report
55 Tenant list
57 Account
58 Workspace
59 Task builder
60 Badging
61 DVR
62 Video view
63 Area group

8 DN1327-1004
 EntraPass SmartLink Reference Manual

3.2 List of Destination Variables

Variable Description
$p Save SmartLink actual mode
This command allows sending data over the network via TCP-IP (SmartDll.dll). A value
corresponding to an identifier is included with this command, the value should range between 0 and
$r 65000 inclusive.
ex : $r25$r
$r begins and ends the command. If the identifier’s value = 0, then send to all clients
Reset of the serial output and communication speed for bidirectional
$s ex : $s com1:9600$s
$s begins and ends the command
$t Restore SmartLink mode previously saved
Reset of the serial output and communication speed for unidirectional
ex : $u com1:9600$u
$u
$u begins and ends the command
This command activates the serial output mode
Defines a file for future writing use
ex : $vc:\ep_2000.inf$v
$v the file is c:\ep_2000.inf
$v begins and ends the command
This command activates the disk writing mode
$w Close the file previously opened with $v....$v
Write the data on the hard disk  Forced writing of the opened file (close / open)
$x
if the disk writing mode is not enabled, nothing will be processed

The EntraPass Command Editor can be used to generate the code needed to execute the operation.

DN1327-1004 9
 3.3 Secondary Commands

Command Description
<xxxx> Processing of a numeric value (xxxx = numeric value to be inserted fully)
“text” Processing of a character string (all characters between quotation marks (“) will be inserted fully)
|: Insert a carriage return and a line feed

The following commands must be inserted between the character $ and the command’s letter.

Command Description
Processes characters on the left only (xxx = indicates the number of characters to keep in the
[xxx command’s characters string)
Ex: $[15h, only the first 15 characters from the left will be kept
Processes characters on the right only (xxx = indicates the number of characters to keep in the
]xxx command’s characters string)
Ex: $[10z1 only the first 10 characters from the right will be kept
{ Deletes spaces at right of text
Increments the command’s numeric value
+
Ex: $+c the current day’s value is incremented of 1
Decrements the command’s numeric value
-
Ex: $-g the event’s number value is decremented of 1
~w”xxxxxxx Delay of xxxxxxxxxx in tenth of seconds before the next character is sent, in serial output sending
xx” mode. If this command is received in disk writing mode, it will be ignored
Language selection to interpret instructions
~l”x”
x = 1 (first language) or 2 (second language)

:
The EntraPass Command Editor can be used to generate the code needed to execute the operation.

10 DN1327-1004
 EntraPass SmartLink Reference Manual

3.4 Emailing

Command Description
~e Indicates the beginning of an email
The email sender’s address
Must include < “> at the beginning and at the end of the address
~f”xxxxx” xxxxx = email address
On some sites, this address must be valid on the email server account in order to send the email
out of the local network.
The email addressee’s address
Must include < “> at the beginning and at the end of the address
~a”xxxxx”
xxxxx = email address
Multiple addresses can be defined (see example below)
The email CC’s address
Must include < “> at the beginning and at the end of the address
~o”xxxxx”
xxxxx = email address
Multiple addresses can be defined (see example below)
The email’s subject
~t”xxxxx” Must include < “> at the beginning and at the end of the subject (title)
xxxxx = subject content (title)
The email’s content (text)
Must include < “> at the beginning and at the end of the subject
~c”xxxxx” xxxxx = email content
Each command of this type corresponds to a distinct line of text in the email (see example
below)
~s Indicates the end of the email and triggers an immediate sending

DN1327-1004 11
 Example 1:
Single address email

~e~f”validaccount@localserver”~a"[email protected] "~o”Address in CC”~t”Subject of

this email”~c”here you can enter the email body text”~s

Example 2:
Multiple addresses email, with no address in CC.

~e~a"[email protected]"~a”[email protected]”~t”Subject o f thi s email”~c”here yo u

can enter the email body text”~s

Example 3:
Single address email with primary i nstructions included in the tex t. Year, month and current day are
added at the end of email title. The text section can be empty in a email.

~e~a"[email protected] "~t”Subject of this email ”$a” / “$b” / “$c~s

Example 4:
To define the email, all the primary commands previously defined can be used to build the email title or
content.

Email title definition : ~t$a”/”$b”/”$c” : “”Generated event : ”$h

Email content definition :
~c”Event # ”$g (email text first line)
~c”This event has been sent automatically” (email text second line)

Important: An email instru ction must begin with the < ~e > command and
end with < ~s >. The order of commands inserted between the
beginning and end of the email is irrelevant. This instruction can
contain multiple address commands (a ddressees and CC), an d
also many commands of < ~c > type corresponding to a distinct
line of text in the email.
The EntraPass Command Editor can be used to generate the code needed to execute the operation.

12 DN1327-1004
 EntraPass SmartLink Reference Manual

DN1327-1004 13
 3.5 Modem and Pager

Command Description
Modem start-up and initialization for the selected serial output
x = serial output 1 to xx
yyyy = modem speed in baud rates (default : 19200)
xxxxxxxx = characters string for the modem initialization.
~m”x:yyyy :xxxxxxxx” The characters string for the modem initialization can be omitted. In this case,
the modem will use the default characters string.
ex : ~m”1:9600” (modem initialization for COM 1 serial output at the speed of
9600 bauds)
ex : ~m”1:9600 :ATX4M1V1E0” (modem initialization for COM 1 serial output at
the speed of 9600 bauds with a characters string)
Dialing of phone number xxxxxxx. z is the number of redial attempts in case of
~dz”xxxxxxx”
failure.
Send a numeric message to a pager.
xxxxxxxx : phone number to dial
~p”xxxxxxx:yyyy:zzzzzzzzzzzz”
yyyy: delay before sending the message
zzzzzzzzzzzz : message (numeric only)
Modem connection delay :
~b”xxxx:yyyy” xxxx = connection delay (dial) in seconds
yyyy = delay in seconds between each connection trial in case of failure.
~h Hang-up the line for the modem in use

List of default values for a modem communication

• Number of connection trials: 1
• Connection delays: 30 seconds
• Delay between each trial: 15 seconds
• Serial output value: Com1
• Modem speed: 19200 bauds
• Initialization string: ATX4M1V1E0
• Pager options: Delay before message: 15 seconds

The EntraPass Command Editor can be used to generate the code needed to execute the operation.

14 DN1327-1004
 EntraPass SmartLink Reference Manual

3.6 Network
In ’Message Mode’, the instructions used to send data via the network can be redirected to a specific
client application or to all the client applications connected to the SmartLink network. The result of a n
instruction depe nds on th e identi fier included in the message, the last selected identifier or th e
identifier defined during the initialization process.

Example:
ID = 0 ($r0$r), this instruction in ‘MessageMode’ returns the result to all the clients actually connected
to the SmartLink server. The identifier 0 indicates a sending to all connected clients.

ID = xx ($r25$r), this instruction in ‘MessageMode’ returns the result to a client with an identifier #25.
If no client application with this identifier is connected, the system will put the information on stand-by
until the application is reconne cted. As soon as the application is reconnected, all the information on

DN1327-1004 15
 stand-by will be sent. If more th an one person is connected using the same identifier, the system will
keep only the last connected one.
Note: The information on stand-by wil l be d eleted if SmartLink is stopp ed be fore the client
application with this identifier was connected.

Important: In order to make the network mode accessible fo r Smar tLink,

the network conne ction option of th e wo rkstation config uration
window corresponding to SmartLink should be: Messag es only
or Messages and Commands.

The EntraPass Command Editor can be used to generate the code needed to execute the operation.

16 DN1327-1004
 EntraPass SmartLink Reference Manual

4.0 - Communication Protocol

This secti on d escribes the particular fea tures of the different communi cation methods use d with
SmartLink.

4.1 Communication modes

There are two communication modes between the Operator and SmartLink. The first on e uses the IP
Network and the second one the serial port. In both cases, the data format is almost the same. This
section explains the differences.

4.1.1 IP Network
A co mmand re ceived vi a the IP Netwo rk is tre ated Immediately. SmartLi nk is cap able of re ceiving
many simultaneous commands but processes them in chronological order. The data format, explained
in the following sections, relates to the data that pass through the SmartDll as a packet.

4.1.2 Serial Port

Once the first byte of data is received by SmartLink, any other command coming to the same serial
port will be blo cked and placed into a queue . A time r is a utomatically st arted o nce a command is
received at Sma rtLink. That timer eventually times o ut when the packet takes too long to a rrive. This
method of time management allows SmartLink to free up the communication port in case a command
takes too long to arrive.

4.2 Command Format

The command must be sent using a predefined format, as shown bellow, and is applicable to the serial
communication port (raw data) or to the IP communication Network (SmartDll).

STX Command=x FS Parameter1 FS ParameterN FS ETX

STX: Start Transmission byte = 0x02

FS: File separator byte = 0x1C
ETX: End of Transmission byte = 0x03 Optional

The formatted packet must always begin with an STX byte to iden tify its starting point. The command
is then pre ceeded w ith “ Command=”. Th e FS byte delimiter must fo llow the comma nd an d any
provided p arameters. Th e last byte within th e fo rmatted packet must be an ETX that specifies the
ending point. The parameters are optional and may be placed in any order since keywords are used.
All keywords must be followed with an equ al sign. The characters are not case sensitive. Spaces are
not allowed within the command or operator keywords.

Example with the login command from section 23: Login

In both cases, the command format is identical for the IP Network and the Serial Port.

4.3 Returned Format

SmartLink returns an acknowledged reply different for the Serial Port and the IP Network. Note that,
the returned keywords are always di splayed in upp er case exce pt in the present document ation for
readability purposes.

DN1327-1004 17
 4.3.1 Serial Port
The whole result and the optional parameters are returned as described here:

4.3.1 IP Network
The result is returned by the DLL function call in two parts:
a. Integer value returned from the DLL function call return.
b. Optional parameters returned by the DLL within a provided buffer according to this format:

4.3.2 Common error messages

List of common returned error messages for all commands. For a complete list see Appendix #1.

ErrMsg Header Name Description

10 SMARTLINK_NOT_LOGIN Operator must be first connected.
36 SMARTLINK_COMMAND_INVALID Invalid command
The “command=” keyword is invalid within the
39 SMARTLINK_COMMANDINVALIDKEYWORD
command.
Timeout while processing the command by the
40 SMARTLINK_COMMANDTIMEOUT
serial port.
The operator doesn’t have the appropriate
42 SMARTLINK_SECURITYRESTRICTED
security level for this command
48 SMARTLINK_CHANGECOMMAND_ERROR The component doesn’t exist

18 DN1327-1004
 EntraPass SmartLink Reference Manual

5.0 - Commands
This section provides details on each command that can be sent to SmartLink.

5.1 Standard Command List Summary

The following is a list summary of commands that c an be sent to the SmartLink server. The detail of
each command is given in subsequent sections.

Commands Description Paragraph

ActivateRelay Activate a relay 2.46
ActivateRelayGroup Activate a group of relays 2.51
ActivateTempoRelay Temporarily activate a relay 2.47
ActivateTempoRelayGroup Temporarily activate a group of relays 2.52
AddCard Add a new card to the system 2.6
1 Add a component filter to a trigger 2.110
AddToTrigger
AlarmSystemStatus (Global only) Receive the status of an alarm system 2.93
AreaGetCard (Global only) 3 Get a card from a specific area ?

AreaMoveCard (Global only) 1 Move a card to a specific area 2.27

AreaStatus (Global only) Receive the status of an area 2.94
ChangePassword2 Change the password for a specific operator 2.107

ConnectionState2 Validate the connection to SmartLink 2.5

ConnectSite Send a connection request to a site. 2.98
ControllerStatus Receive the controller status 2.88
DeactivateRelay Deactivate a relay 2.45
DeactivateRelayGroup Deactivate a group of relays 2.50
1 Remove 1 to count usage for a specific card 2.20
DecCountUsage
DeleteCard Delete a card from the system 2.8
DisableDoor Disable a reader (door) 2.66
DisableDoorGroup Disable a group of readers (door) 2.68
DisableElevatorDoor1 Disable an elevator reader (door) 2.78
1 Disable an elevator group of readers (door) 2.80
DisableElevatorDoorGroup
DisableFloorElevatorDoor1 Disable floor group for a cab (door) 2.82

DisableFloorElevatorDoorGroup1 Disable floor group for a group of cabs (door) 2.84

DisarmAlarmSystem (Global only) Arm a virtual alarm system 2.24
DisarmAlarmSystem (Global only) Disarm a virtual alarm system 2.25
DisconnectSite Send a disconnection request to a site. 2.99
DoorStatus Receive a door status 2.89
2 Email a password 2.106
EmaiPassword
EnableDoor Enable a reader (door) 2.65
EnableDoorGroup Enable a group of readers (door) 2.67
1 Enable an elevator reader (door) 2.77
EnableElevatorDoor
EnableElevatorDoorGroup1 Enable an elevator group of readers (door) 2.79

EnableFloorElevatorDoor1 Enable floor group for a cab (door) 2.81

DN1327-1004 19
 Commands Description Paragraph
EnableFloorElevatorDoorGroup1 Enable floor group for a group of cabs (door) 2.83
ExecuteTask Call all gateway sites with modified data 2.102
ForgiveController Reset the Anti-Passback 2.30
GatewayStatus Receive the gateway status 2.86
2 Get access level description 2.109
GetAccessLevelDescription
GetCardAccessGroup2 Get card access group information 2.108
GetCardInfo Retrieve card specific information 2.9
GetCardInfoPicture1 Retrieve card specific information and Picture 2.10
GetCardPicture2 Retrieve card Picture 2.11
GetCardSignature2 Retrieve card Signature 2.13
GetCountUsage Get the maximum number of a card usages 2.17
GetDescription2 Get the description of a specific component 2.105
2 Get a list of component specific parameters 2.115
GetFind
GetFindNext2 Get a list of component specific parameters (next) 2.116

GetLastAddedCard1 Retrieve Id of the last added card 2.23

GetLastTransactionCard Get a card last transaction 2.96
GetList2 Get a list of components 2.112
2 Get a list of graphic URLs 2.114
GetListGraphicUrl
GetListOwnerBy2 Get a list of components with a owner 2.113
GetNip Retrieve a PIN from a specific card 2.15
GetReportEmail Create a report and send it by email 2.97
GuardTourStatus (Global only)1 Receive a guard tour status 2.95
HardResetController Execute a board level hard reset 2.28
IncCountUsage1 Add 1 to count usage for a specific card 2.21
InputStatus Receive an input status 2.91
LockDoor Lock a door 2.32
LockDoorGroup Lock a group of doors 2.37
1 Lock an elevator door 2.69
LockElevatorDoor
LockElevatorDoorGroup1 Lock an elevator group of door 2.73
Login Connect to the network 2.3
Logout Disconnect from the network 2.4
ModifyCard Modify an existing card in the system 2.7
OutputStatus (Not implemented) 2.92
PostponeAlarmSystem (Global
Postpone an alarm system 2.26
only)
RelayStatus Receive a relay status 2.90
ReloadController Reload the controller database 2.31
1 Remove a component filter to a trigger 2.111
RemoveFromTrigger
1 Restart count usage to 0 use 2.22
ResetCountUsage
ReturnScheduleDoor1 Return door to normal schedule 2.35

ReturnScheduleDoorGroup1 Return group of doors to normal schedule 2.40

20 DN1327-1004
 EntraPass SmartLink Reference Manual

Commands Description Paragraph

ReturnScheduleElevatorDoor1 Return elevator door to normal schedule 2.72
ReturnScheduleElevatorDoorGroup
Return elevator group of doors to normal schedule 2.76
1

ReturnScheduleInput1 Return input to normal schedule 2.58

1 Return group of inputs to normal schedule 2.64
ReturnScheduleInputGroup
ReturnScheduleRelay1 Return relay to normal schedule 2.48

ReturnScheduleRelayGroup1 Return group of relays to normal schedule 2.53

2 Change a card’s picture 2.12
SetCardPicture
SetCardSignature2 Change card’s signature 2.14
SetCountUsage Modify the maximum number of card usages 2.18
Modify the maximum number of card usages and
SetCountUsageManual1 set the manual operation
2.19

SetNip3 Change the PIN for a specific card ?

ShuntInput Disable an input 2.55
ShuntInputGroup Disable a group of inputs 2.61
ShuntInputTempo Disable an input temporarily 2.56
ShuntTempoInputGroup Disable a group of inputs temporarily 2.62
SiteStatus Receive the site status 2.87
SoftResetController Execute a board level soft reset 2.29
1 Continuously supervise an input 2.57
SuperviseInput
SuperviseInputGroup1 Continuously supervise a group of inputs 2.63

ToggleDoorStrike1 Toggle the Door Strike 2.36

1 Toggle shunt or unshunt input 2.59
ToggleInputShunt
ToggleRelayActivation1 Activate or deactivate a relay 2.49
UnlockDoor Unlock a door 2.33
UnlockDoorGroup Unlock a group of doors 2.38
UnlockElevatorDoor1 Unlock an elevator door 2.70

UnlockElevatorDoorGroup1 Unlock an elevator group of doors 2.74

UnlockTempoDoor Temporarily unlock a door 2.34
UnlockTempoDoorGroup Temporarily unlock a group of doors 2.39
UnlockTempoElevatorDoor1 Temporarily unlock an elevator door 2.71

UnlockTempoElevatorDoorGroup1 Temporarily unlock an elevator group of doors 2.75

UnshuntInput Enable an input 2.54
UpdateAllSite Call all gateway sites with modified data 2.102
UpdateRemoteSite Call one site with modified data. 2.100
Call all sites on a specific gateway with modified
UpdateRemoteSiteGateway 2.101
data
WorkstationStatus Receive the workstation status 2.85
SiteStatus Receive the site status 2.87
SoftResetController Execute a board level soft reset 2.29
1 Continuously supervise an input 2.57
SuperviseInput
SuperviseInputGroup1 Continuously supervise a group of inputs 2.63

DN1327-1004 21
 Commands Description Paragraph
ToggleDoorStrike1 Toggle the Door Strike 2.36

ToggleInputShunt1 Toggle shunt or unshunt input 2.59

1 Activate or deactivate a relay 2.49
ToggleRelayActivation
UnlockDoor Unlock a door 2.33
UnlockDoorGroup Unlock a group of doors 2.38
1 Unlock an elevator door 2.70
UnlockElevatorDoor
UnlockElevatorDoorGroup1 Unlock an elevator group of doors 2.74
UnlockTempoDoor Temporarily unlock a door 2.34
UnlockTempoDoorGroup Temporarily unlock a group of doors 2.39
1 Temporarily unlock an elevator door 2.71
UnlockTempoElevatorDoor
UnlockTempoElevatorDoorGroup1 Temporarily unlock an elevator group of doors 2.75
UnshuntInput Enable an input 2.54
UpdateAllSite Call all gateway sites with modified data 2.102
UpdateRemoteSite Call one site with modified data. 2.100
Call all sites on a specific gateway with modified
UpdateRemoteSiteGateway 2.101
data
WorkstationStatus Receive the workstation status 2.85

1 Recently added.
2 SDK only.
3 Not yet supported.

5.2 Enhanced Command List Summary

The following is a list summary of commands that c an be sent to the SmartLink server. The detail of
each command is given in subsequent sections.

Commands Description
Add an access level to the system. A maximum of 250 access levels can be
AddAccessLevel
programmed per site.
AddController Add a controller to the system. Can create relay, input, door, output in the same way as
(ExpressSetup) the ExpressSetup utility
AddHoliday Add a holiday
AddSchedule Add a schedule to the system. A maximum of four intervals can be configured
Add a site to the system. Can create controllers in the same way as the fastSetup
AddSite (FastSetup)
utility
DeleteAccessLevel Delete an access level to the system
DeleteController Delete a Controller within the system according to its reference number
DeleteDoor Delete a door in the system according to its reference
DeleteHoliday Delete a holiday
DeleteInput Delete an input in the system according to its reference
DeleteOutput Delete an output in the system according to its reference
DeleteRelay Delete a relay in the system according to its reference
DeleteSchedule Delete a schedule in the system
DeleteSite Delete a site in the system according to its reference number
GetAccessLevel Get access level details

22 DN1327-1004
 EntraPass SmartLink Reference Manual

Commands Description
GetController Get controller details
GetDoor Add a door to the system
GetHoliday Get holiday details
GetInput Add an input in the system
GetOutput Add an output in the system
GetRelay Add a relay in the system
GetSchedule Get schedule details
GetSite Get site details
GetSiteCard Advanced command to retrieve all cards from a specific site
Advanced command to retrieve all component references from a specific site. Allow
GetSiteStructure
MAS to make the component association
ModifyAccessLevel Modify an access level in the system
ModifyController Modify a controller in the system according to its reference number
ModifyDoor Modify a door in the system according to its reference
ModifyHoliday Modify a holiday
ModifyInput Modify an input in the system according to its reference
ModifyOutput Modify an output in the system according to its reference
ModifyRelay Modify a relay in the system according to its reference
ModifySchedule Modify a schedule in the system
ModifySite Modify a site in the system according to its reference number

5.3 Login
This comma nd all ows a new use r to reque st a conn ection to the netw ork acco rding to the p rovided
username and password. All commands (except for lo gin and logoff) need Login executed first to be
processed successfully.

Field Keyword & format Detail

Command Command = Login
Parameter1 OperatorLoginName=x x is the operator login name
Parameter2 OperatorPassword=x x is the password

Returned data :

Field Keyword & format Detail

See section 17: Returned Most common returned values:
Format 0 = SMARTLINK_COMMAND_OK (granted)
Result for format details. 33 = SMARTLINK_INVALID_LOGIN
See Appendix #1 for all returned 34 = SMARTLINK_INVALID_LOGINNAME
codes. 35 = SMARTLINK_INVALID_PASSWORD

5.4 Logout
This command allows the operator to disconnect from the SmartLink network.

Field Keyword & format Detail

Command Command
= Logout

DN1327-1004 23
 Returned data :

Field Keyword & format Details

See section 17: Returned
Format
Most common returned values:
Result for format details.
0 = SMARTLINK_COMMAND_OK (granted)
See Appendix #1 for all returned
codes.

5.5 ConnectionState
This command allows the operator to disconnect from the SmartLink network.

Field Keyword & format Detail

Command Command
= ConnectionState

Returned data :

Field Keyword & format Detail

See section 17: Returned
Format
Most common returned values:
Result for format details.
0 = SMARTLINK_COMMAND_OK (granted)
See Appendix #1 for all returned
codes.

5.6 AddCard
This command a dds a card in the syste m. If the ca rd a lready exist s, then the correspon ding error
message is displayed.

Field Keyword & format Detail

Command Command = AddCard
Main card. x is the format based
Parameter1 CardNumber=xxxx :xxxx
on system definition
Parameter2 UserName=x Maximum of 40 characters
Parameter3 CardInfo1=x Maximum of 40 characters
Parameter4 CardInfo2=x Maximum of 40 characters
Parameter5 CardInfo3=x Maximum of 40 characters
Parameter6 CardInfo4=x Maximum of 40 characters
Parameter7 CardInfo5=x Maximum of 40 characters
Parameter8 CardInfo6=x Maximum of 40 characters
Parameter9 CardInfo7=x Maximum of 40 characters
Parameter10 CardInfo8=x Maximum of 40 characters
Parameter11 CardInfo9=x Maximum of 40 characters
Parameter12 CardInfo10=x Maximum of 40 characters
YYYY = Year, MM = Month, DD =
Parameter13 StartDate=YYYY\MM\DD
Day
Parameter14 UsingEndDate=x x = YES or NO
YYYY = Year, MM = Month, DD =
Parameter15 EndDate=YYYY\MM\DD
Day

24 DN1327-1004
 EntraPass SmartLink Reference Manual

Field Keyword & format Detail

Parameter16 DeleteOnExpired=x x = YES or NO
x value can be:VALID , INVALID ,
Parameter17 CardState=x
STOLEN\LOST
Parameter18 Trace=x x = YES or NO
Parameter19 WaitForKeypad=x x = YES or NO
Parameter20 KeypadValue=0
Parameter21 Comment=x Maximum of 240 characters
Parameter22 CardAccessGroup=x
Parameter23 CardType=x
x is the Card ID of the card
Parameter24 DeleteCardId=x owner. When provided, the
corresponding Card ID is deleted.
This field is only used in
Enhanced user management
mode.
Parameter25 TransferCardId=x x is the original Card ID that is
holding the card number. The
card number will be removed
from the original Card ID.

Note: The picture associated to a card can be sent through SendDataPicture().

Returned data :

Field Keyword & format Detail

See section 17: Returned
Format Most common returned values:
Result for format details. 0= SMARTLINK_COMMAND_OK
See Appendix #1 for all returned 37=SMARTLINK_INVALIDCARDEXIST
codes.

5.7 ModifyCard
This command modifies a card in the system.

Field Keyword & format Detail

Command Command
= ModifyCard
CardNumber=xxxx :xxxx OR x format is based on system definition
Parameter1
CardId=y y is the unique system based number (PkData)
Parameter2 to
As per section 24: AddCard
Parameter23
Format based on system definition.
This field makes it possible to execute a SaveAs on a
Parameter24 ReplaceCardNumber=xxxx :xxxx
card. The system will delete the card and create a new
one with the deleted data.

Note: As in Ad dCard, the pi cture associated to a card can be sen t throu gh

SendDataPicture().
Returned data

DN1327-1004 25
 Field Keyword & format Detail
See section 17: Returned
Format Most common returned values:
Result for format details. 0 = SMARTLINK_COMMAND_OK (granted)
See Appendix #1 for all returned 38 = SMARTLINK_INVALIDCARDNOTEXIST
codes.

5.8 DeleteCard
This command deletes a card in the system according to its number.

Field Keyword & format Detail

Command Command
= DeleteCard
CardNumber=xxxx :xxxx OR x format is based on system definition
Parameter1
CardId=y y is the unique system based number (PkData)

Returned data:

Field Keyword & format Detail

See section 17: Returned
Format
Most common returned values:
Result for format details.
0 = SMARTLINK_COMMAND_OK
See Appendix #1 for all returned
codes.

5.9 GetCardInfo
This command retrieves a card information according to its number.

Field Keyword & format Detail

Command Command
= GetCardInfo
CardNumber=xxxx :xxxx OR x format is based on system definition
Parameter1
CardId=y y is the unique system based number (PkData)

Returned data:

26 DN1327-1004
 EntraPass SmartLink Reference Manual

Field Keyword & format Detail

See section 17: Returned
Format
Most common returned values:
Result for format details.
0 = SMARTLINK_COMMAND_OK
See Appendix #1 for all returned
codes.
Parameter1 to
As per section 24: AddCard
Parameter23
x is a multiple card rank. y is a format based on system
As many cards CardNumberx=yyyy : yyyy
definition
x is a multiple card rank. y is a “to be displayed”: Yes or
As many cards DisplayCardNumberx=y
No
As many cards UsingEndDatex= YYYY\MM\DD x is a card rank. YYYY = Year, MM = Month, DD = Day
As many cards EndDatexYYY\MM\DD X is a card rank. YYYY = Year, MM = Month, DD = Day
As many cards Tracex=y X is a card rank. y = YES or NO
X is a card rank. Y value can be:VALID , INVALID ,
As many cards CardStatex=y
STOLEN\LOST

Note: The pi cture data associated to the card is of JPEG fo rmat an d is re turned wh en
invoking the SendDataPicture() to be saved as a file according to the filename provided
as an argument to the function.

5.10 GetCardInfoPicture
This command retrieves a card information and picture according to its number

Field Keyword & format Detail

Command Command
= GetCardInfoPicture
CardNumber=xxxx :xxxx OR x format is based on system definition
Parameter1
CardId=y y is the unique system based number (PkData)

Returned data:

Field Keyword & format Detail

See section 17: Returned
Format
Most common returned values:
Result for format details.
0 = SMARTLINK_COMMAND_OK
See Appendix #1 for all returned
codes.
Parameter1 to
As per the section 24: AddCard
Parameter23
x is a multiple card rank. y is a format based on system
As many cards CardNumberx=yyyy : yyyy
definition
x is a multiple card rank. y is for “to be displayed”: Yes
As many cards DisplayCardNumberx=y
or No
As many cards UsingEndDatex= YYYY\MM\DD x is a card rank. YYYY = Year ,MM = Month , DD = Day
As many cards EndDatexYYY\MM\DD x is a card rank. YYYY = Year ,MM = Month , DD = Day
As many cards Tracex=y x is a card rank. Y = YES or NO
x is a card rank. Y value can be:VALID , INVALID ,
As many cards CardStatex=y
STOLEN\LOST

DN1327-1004 27
 Note: The pi cture data associated to the card is of JPEG fo rmat an d is re turned wh en
invoking the SendDataPicture() to be saved as a file according to the filename provided
as an argument to the function.

5.11 GetCardPicture
This command retrieves a card Picture according to its number

Field Keyword & format Detail

Command Command
= GetCardPicture
CardNumber=xxxx :xxxx OR x format is based on system definition
Parameter1
CardId=y y is the unique system based number (PkData)

Returned data:

Field Keyword & format Detail

See section 17: Returned
Format
Most common returned values:
Result for format details.
0 = SMARTLINK_COMMAND_OK
See Appendix #1 for all returned
codes.

5.12 SetCardPicture
This command changes a card picture according to its number

Field Keyword & format Detail

Command Command
= SetCardPicture
CardNumber=xxxx :xxxx OR x format is based on system definition
Parameter1
CardId=y y is the unique system based number (PkData)
x is the Image type: 1=BMP, 2=EPS, 3=GIF,
Parameter2 PictureType=x
4=JPG(default), 5=PCX, 6=PNG, 7=TGA, 8=TIF
Parameter3 PictureLength=x x is the picture size

Returned data:

Field Keyword & format Detail

See section 17: Returned
Format
Most common returned values:
Result for format details.
0 = SMARTLINK_COMMAND_OK
See Appendix #1 for all returned
codes.

5.13 GetCardSignature
This command gets a card Signature according to its number

Field Keyword & format Detail

Command Command
= GetCardSignature
CardNumber=xxxx :xxxx OR x format is based on system definition
Parameter1
CardId=y y is the unique system based number (PkData)

Returned data:

28 DN1327-1004
 EntraPass SmartLink Reference Manual

Field Keyword & format Detail

See section 17: Returned
Format
Most common returned values:
Result for format details.
0 = SMARTLINK_COMMAND_OK
See Appendix #1 for all returned
codes.

5.14 SetCardSignature
This command sets a card signature according to its number

Field Keyword & format Detail

Command Command
= SetCardSignature
CardNumber=xxxx :xxxx OR x format is based on system definition
Parameter1
CardId=y y is the unique system based number (PkData)
x is the image type: 1=BMP, 2=EPS, 3=GIF,
Parameter2 SignatureType=x
4=JPG(default), 5=PCX, 6=PNG, 7=TGA, 8=TIF
Parameter3 SignatureLength=x x is the signature size

Returned data:

Field Keyword & format Detail

See section 17: Returned
Format
Most common returned values:
Result for format details.
0 = SMARTLINK_COMMAND_OK
See Appendix #1 for all returned
codes.

5.15 GetNip
This command gets the PIN of a card in the system according to its number.

Field Keyword & format Detail

Command Command
= GetNip
CardNumber=xxxx :xxxx OR x format is based on system definition
Parameter1
CardId=y y is the unique system based number (PkData)

Returned data:

Field Keyword & format Detail

See section 17: Returned
Format Most common returned values:
Result for format details. 0 = SMARTLINK_COMMAND_OK
See Appendix #1 for all returned 38 = SMARTLINK_INVALIDCARDNOTEXIST
codes.
Parameter1 8000NIP=x x is the card PIN

5.16 SetNip
This command changes the PIN of a card in the system according to its number.

DN1327-1004 29
 Field Keyword & format Detail
Command Command
= SetNip
CardNumber=xxxx :xxxx OR x format is based on system definition
Parameter1
CardId=y y is the unique system based number (PkData)
Parameter1 8000NIP=x x is the card PIN

Returned data:

Field Keyword & format Detail

See section 17: Returned
Format Most common returned values:
Result for format details. 0 = SMARTLINK_COMMAND_OK
See Appendix #1 for all returned 38 = SMARTLINK_INVALIDCARDNOTEXIST
codes.

5.17 GetCountUsage
This command gets the count usage of a card in the system according to its number.

Field Keyword & format Detail

Command Command
= GetCountUsage
CardNumber=xxxx :xxxx OR x format is based on system definition
Parameter1
CardId=y y is the unique system based number (PkData)

Returned data:

Field Keyword & format Detail

See section 17: Returned
Format Most common returned values:
Result for format details. 0 = SMARTLINK_COMMAND_OK
See Appendix #1 for all returned 38 = SMARTLINK_INVALIDCARDNOTEXIST
codes.
Parameter1 CountUsage=x x is the count usage of the card

5.18 SetCountUsage
This command sets the count usage of a card in the system according to its number.

Field Keyword & format Detail

Command Command
= SetCountUsage
CardNumber=xxxx :xxxx OR x format is based on system definition
Parameter1
CardId=y y is the unique system based number (PkData)
Parameter2 CountUsage=x x is the count usage

Returned data:

30 DN1327-1004
 EntraPass SmartLink Reference Manual

Field Keyword & format Detail

See section 17: Returned
Format Most common returned values:
Result for format details. 0 = SMARTLINK_COMMAND_OK
See Appendix #1 for all returned 38 = SMARTLINK_INVALIDCARDNOTEXIST
codes.

5.19 SetCountUsageManual
This command sets the count usage of a card and set the manual operation in the system.

Field Keyword & format Detail

Command Command
= SetCountUsageManual
CardNumber=xxxx :xxxx OR x format is based on system definition
Parameter1
CardId=y y is the unique system based number (PkData)
Parameter2 CountUsage=x x is the count usage

Returned data:

Field Keyword & format Detail

See section 17: Returned
Format Most common returned values:
Result for format details. 0 = SMARTLINK_COMMAND_OK
See Appendix #1 for all returned 38 = SMARTLINK_INVALIDCARDNOTEXIST
codes.

5.20 DecCountUsage
This command removes 1 from the count usage of a card in the system.

Field Keyword & format Detail

Command Command
= DecCountUsage
CardNumber=xxxx :xxxx OR x format is based on system definition
Parameter1
CardId=y y is the unique system based number (PkData)

Returned data:

Field Keyword & format Detail

See section 17: Returned
Format Most common returned values:
Result for format details. 0 = SMARTLINK_COMMAND_OK
See Appendix #1 for all returned 38 = SMARTLINK_INVALIDCARDNOTEXIST
codes.

5.21 IncCountUsage
This command adds 1 to the count usage of a card in the system.

DN1327-1004 31
 Field Keyword & format Detail
Command Command
= IncCountUsage
CardNumber=xxxx :xxxx OR x format is based on system definition
Parameter1
CardId=y y is the unique system based number (PkData)

Returned data:

Field Keyword & format Detail

See section 17: Returned
Format Most common returned values:
Result for format details. 0 = SMARTLINK_COMMAND_OK
See Appendix #1 for all returned 38 = SMARTLINK_INVALIDCARDNOTEXIST
codes.

5.22 ResetCountUsage
This command restarts count usage to 0 of a card in the system.

Field Keyword & format Detail

Command Command
= ResetCountUsage
CardNumber=xxxx :xxxx OR x format is based on system definition
Parameter1
CardId=y y is the unique system based number (PkData)

Returned data:

Field Keyword & format Detail

See section 17: Returned
Format Most common returned values:
Result for format details. 0 = SMARTLINK_COMMAND_OK
See Appendix #1 for all returned 38 = SMARTLINK_INVALIDCARDNOTEXIST
codes.

5.23 GetLastAddedCard
This command retrieves the last added card ID.

Field Keyword & format Detail

Command Command
= GetLastAddedCard
Parameter1 CardId=y y is the unique card ID system based number (PkData)

Returned data:

Field Keyword & format Detail

See section 17: Returned
Format Most common returned values:
Result for format details. 0 = SMARTLINK_COMMAND_OK
See Appendix #1 for all returned 38 = SMARTLINK_INVALIDCARDNOTEXIST
codes.

32 DN1327-1004
 EntraPass SmartLink Reference Manual

5.24 ArmAlarmSystem (Global only)

This command arms an alarm system.

Field Keyword & format Detail

Command Command
= ArmAlarmSystem
Parameter1 AlarmSystemId=x x is the Alarm System Reference Identifier

Returned data:

Field Keyword & format Detail

See section 17: Returned
Format
Most common returned values:
Result for format details.
0 = SMARTLINK_COMMAND_OK
See Appendix #1 for all returned
codes.

5.25 DisarmAlarmSystem (Global only)

This command disarms an alarm system.

Field Keyword & format Detail

Command Command
= DisarmAlarmSystem
Parameter1 AlarmSystemId=x x is the Alarm System Reference Identifier

Returned data:

Field Keyword & format Detail

See section 17: Returned
Format
Most common returned values:
Result for format details.
0 = SMARTLINK_COMMAND_OK
See Appendix #1 for all returned
codes.

5.26 PostponeAlarmSystem (Global only)

This command postpones the arming of an alarm system.

Field Keyword & format Detail

Command Co mmand
= PostponeAlarmSystem
Parameter1 AlarmSystemId=x x is the Alarm System Reference Identifier
Parameter1 PostponeDelay=x x is the postponement delay in seconds form 1 to 65535

Returned data:

Field Keyword & format Detail

See section 17: Returned
Format
Most common returned values:
Result for format details.
0 = SMARTLINK_COMMAND_OK
See Appendix #1 for all returned
codes.

DN1327-1004 33
 5.27 AreaMoveCard (Global only)
This command moves a card to a specific area.

Field Keyword & format Detail

Command Command
= AreaMoveCard
Parameter1 AreaId=x x is the Area Reference Identifier
x is the Area Reference Identifier where to move the
Parameter1 MoveTo=x
card

Returned data:

Field Keyword & format Detail

See section 17: Returned
Format
Most common returned values:
Result for format details.
0 = SMARTLINK_COMMAND_OK
See Appendix #1 for all returned
codes.

5.28 HardResetController
This command performs a hard reset on a controller.

Field Keyword & format Detail

Command Command
= HardReset
Parameter1 ControllerID=x x is the controller reference ID

Returned data:

Field Keyword & format Detail

See section 17: Returned
Format
Most common returned values:
Result for format details.
0 = SMARTLINK_COMMAND_OK
See Appendix #1 for all returned
codes.

5.29 SoftResetController
This command performs a soft reset on a controller.

Field Keyword & format Detail

Command Command
= SoftReset
Parameter1 ControllerID=x x is the controller reference ID

Returned data:

Field Keyword & format Detail

See section 17: Returned
Format
Most common returned values:
Result for format details.
0 = SMARTLINK_COMMAND_OK
See Appendix #1 for all returned
codes.

34 DN1327-1004
 EntraPass SmartLink Reference Manual

5.30 ForgiveController
This command clears the Anti-Passback.

Field Keyword & format Detail

Command Command
= ForgveController
Parameter1 ControllerID=x x is the controller reference ID

Returned data:

Field Keyword & format Detail

See section 17: Returned
Format
Most common returned values:
Result for format details.
0 = SMARTLINK_COMMAND_OK
See Appendix #1 for all returned
codes.

5.31 ReloadController
This command reloads the controller database.

Field Keyword & format Detail

Command Command
= ReloadController
Parameter1 ControllerID=x X is the controller reference ID

Returned data:

Field Keyword & format Detail

See section 17: Returned
Format
Most common returned values:
Result for format details.
0 = SMARTLINK_COMMAND_OK
See Appendix #1 for all returned
codes.

5.32 LockDoor
This command locks a door according to its identifier.

Field Keyword & format Detail

Command Command
= LockDoor
Parameter1 DoorId=x x is the door reference ID
Optional: x=YES, forces the controller to execute all
Parameter2 ForceSend=x
pending commands

Returned data:

Field Keyword & format Detail

See section 17: Returned
Format
Most common returned values:
Result for format details.
0 = SMARTLINK_COMMAND_OK
See Appendix #1 for all returned
codes.

DN1327-1004 35
 5.33 UnlockDoor
This command unlocks a door according to its identifier.

Field Keyword & format Detail

Command Command
= UnlockDoor
Parameter1 DoorId=x x is the door reference ID

Returned data:

Field Keyword & format Detail

See section 17: Returned
Format
Most common returned values:
Result for format details.
0 = SMARTLINK_COMMAND_OK
See Appendix #1 for all returned
codes.

5.34 UnlockTempoDoor
This command temporarily unlocks a door according to its identifier.

Field Keyword & format Detail

Command C ommand
= UnlockTempoDoor
Parameter1 DoorId=x x is the door reference ID
Parameter2 DoorDelay=x x is the door delay in seconds from 1 to 255
Optional: x=YES, forces the controller to execute all
Parameter3 ForceSend=x
pending commands

Returned data:

Field Keyword & format Detail

See section 17: Returned
Format
Most common returned values:
Result for format details.
0 = SMARTLINK_COMMAND_OK
See Appendix #1 for all returned
codes.

5.35 ReturnScheduleDoor
This command returns a door to the normal schedule.

Field Keyword & format Detail

Command Command
= ReturnScheduleDoor
Parameter1 DoorId=x x is the door reference ID
Optional: x=YES, forces the controller to execute all
Parameter2 ForceSend=x
pending commands

Returned data:

36 DN1327-1004
 EntraPass SmartLink Reference Manual

Field Keyword & format Detail

See section 17: Returned
Format
Most common returned values:
Result for format details.
0 = SMARTLINK_COMMAND_OK
See Appendix #1 for all returned
codes.

5.36 ToggleDoorStrike
This command toggles the door strike.

Field Keyword & format Detail

Command Command
= ToggleDoorStrike
Parameter1 DoorId=x x is the door reference ID
Optional: x=YES, forces the controller to execute all
Parameter2 ForceSend=x
pending commands

Returned data:

Field Keyword & format Detail

See section 17: Returned
Format
Most common returned values:
Result for format details.
0 = SMARTLINK_COMMAND_OK
See Appendix #1 for all returned
codes.

ToggleDoorStrike Lock or Unlock door

5.37 LockDoorGroup
This command locks a group of doors according to its identifier.

Field Keyword & format Detail

Command Command
= LockDoorGroup
Parameter1 DoorGroupId=x x is the door group reference ID
Optional: x=YES, forces the controller to execute all
Parameter2 ForceSend=x
pending commands

Returned data:

Field Keyword & format Detail

See section 17: Returned
Format
Most common returned values:
Result for format details.
0 = SMARTLINK_COMMAND_OK
See Appendix #1 for all returned
codes.

5.38 UnlockDoorGroup
This command unlocks a group of doors according to its identifier.

DN1327-1004 37
 Field Keyword & format Detail
Command Command
= UnlockDoorGroup
Parameter1 DoorGroupId=x x is the door group reference ID

Returned data:

Field Keyword & format Detail

See section 17: Returned
Format
Most common returned values:
Result for format details.
0 = SMARTLINK_COMMAND_OK
See Appendix #1 for all returned
codes.

5.39 UnlockTempoDoorGroup
This command temporarily unlocks a group of doors according to its identifier.

Field Keyword & format Detail

Command Command
= UnlockTempoDoorGroup
Parameter1 DoorGroupId=x x is the door reference ID
Parameter2 DoorDelay=x x is the door delay in seconds from 1 to 255
Optional: x=YES, forces the controller to execute all
Parameter3 ForceSend=x
pending commands

Returned data:

Field Keyword & format Detail

See section 17: Returned Format
for format details. Most common returned values:
Result
See Appendix #1 for all returned 0 = SMARTLINK_COMMAND_OK
codes.

5.40 ReturnScheduleDoorGroup
This command returns a group of doors to the normal schedule.

Field Keyword & format Detail

Command Command
= UnlockTempoDoorGroup
Parameter1 DoorGroupId=x x is the door reference ID
Optional: x=YES, forces the controller to execute all
Parameter2 ForceSend=x
pending commands

Returned data:

Field Keyword & format Detail

See section 17: Returned Format
for format details. Most common returned values:
Result
See Appendix #1 for all returned 0 = SMARTLINK_COMMAND_OK
codes.

38 DN1327-1004
 EntraPass SmartLink Reference Manual

5.41 ArmDoor
This command arms the alarm on a door. Only available with the Corporate edition.

Field Keyword & format Detail

Command Command
= ArmDoor
Parameter1 DoorId=x x is the door reference ID
Optional: x=YES, forces the controller to execute all
Parameter2 ForceSend=x
pending commands

Returned data:

Field Keyword & format Detail

See section 17: Returned
Format
Most common returned values:
Result for format details.
0 = SMARTLINK_COMMAND_OK
See Appendix #1 for all returned
codes.

5.42 DisarmDoor
This command disarms the alarm on a door. Only available with the Corporate edition.

Field Keyword & format Detail

Command Command
= DisarmDoor
Parameter1 DoorId=x x is the door reference ID
Optional: x=YES, forces the controller to execute all
Parameter2 ForceSend=x
pending commands

Returned data:

Field Keyword & format Detail

See section 17: Returned
Format
Most common returned values:
Result for format details.
0 = SMARTLINK_COMMAND_OK
See Appendix #1 for all returned
codes.

5.43 ArmDoorGroup
This command arms a group of doors according to its identifier.

Field Keyword & format Detail

Command Command
= ArmDoorGroup
Parameter1 DoorGroupId=x x is the door group reference ID
Optional: x=YES, forces the controller to execute all
Parameter2 ForceSend=x
pending commands

Returned data:

DN1327-1004 39
 Field Keyword & format Detail
See section 17: Returned
Format
Most common returned values:
Result for format details.
0 = SMARTLINK_COMMAND_OK
See Appendix #1 for all returned
codes.

5.44 DisarmDoorGroup
This command disarms a group of doors according to its identifier.

Field Keyword & format Detail

Command Command
= DisarmDoorGroup
Parameter1 DoorGroupId=x x is the door group reference ID
Optional: x=YES, forces the controller to execute all
Parameter2 ForceSend=x
pending commands

Returned data:

Field Keyword & format Detail

See section 17: Returned
Format
Most common returned values:
Result for format details.
0 = SMARTLINK_COMMAND_OK
See Appendix #1 for all returned
codes.

5.45 DeactivateRelay
This command deactivates a relay according to its identifier

Field Keyword & format Detail

Command Command
= DeactivateRelay
Parameter1 RelayId=x x is the Relay reference ID
Optional: x=YES, forces the controller to execute all
Parameter2 ForceSend=x
pending commands

Returned data:

Field Keyword & format Detail

See section 17: Returned
Format
Most common returned values:
Result for format details.
0 = SMARTLINK_COMMAND_OK
See Appendix #1 for all returned
codes.

5.46 ActivateRelay
This command activates a relay according to its identifier

40 DN1327-1004
 EntraPass SmartLink Reference Manual

Field Keyword & format Detail

Command Command
= ActivateRelay
Parameter1 RelayId=x x is the Relay reference ID
Optional: x=YES, forces the controller to execute all
Parameter2 ForceSend=x
pending commands

Returned data:

Field Keyword & format Detail

See section 17: Returned
Format
Most common returned values:
Result for format details.
0 = SMARTLINK_COMMAND_OK
See Appendix #1 for all returned
codes.

5.47 ActivateTempoRelay
This command temporarily activates a relay according to its identifier

Field Keyword & format Detail

Command Command
= ActivateTempoRelay
Parameter1 RelayId=x x is the relay reference ID
Parameter2 RelayDelay=x x is the relay delay in seconds from 1 to 255
Optional: x=YES, forces the controller to execute all
Parameter3 ForceSend=x
pending commands

Returned data:

Field Keyword & format Detail

See section 17: Returned
Format
Most common returned values:
Result for format details.
0 = SMARTLINK_COMMAND_OK
See Appendix #1 for all returned
codes.

5.48 ReturnScheduleRelay
This command returns a relay to its normal schedule according to its identifier

Field Keyword & format Detail

Command Command
= ReturnScheduleRelay
Parameter1 RelayId=x x is the relay reference ID
Optional: x=YES, forces the controller to execute all
Parameter2 ForceSend=x
pending commands

Returned data:

DN1327-1004 41
 Field Keyword & format Detail
See section 17: Returned Format
for format details. Most common returned values:
Result
See Appendix #1 for all returned 0 = SMARTLINK_COMMAND_OK
codes.

5.49 ToggleRelayActivation
This command toggles the relay state according to its identifier.

Field Keyword & format Detail

Command Command
= ToggleRelayActivation
Parameter1 RelayId=x x is the Relay reference ID
Optional: x=YES, forces the controller to execute all
Parameter2 ForceSend=x
pending commands

Returned data:

Field Keyword & format Detail

See section 17: Returned
Format
Most common returned values:
Result for format details.
0 = SMARTLINK_COMMAND_OK
See Appendix #1 for all returned
codes.

5.50 DeactivateRelayGroup
This command deactivates a group of relays according to its identifier.

Field Keyword & format Detail

Command Command
= DeactivateRelayGroup
Parameter1 RelayGroupId=x x is the Relay group reference ID
Optional: x=YES, forces the controller to execute all
Parameter2 ForceSend=x
pending commands

Returned data:

Field Keyword & format Detail

See section 17: Returned
Format
Most common returned values:
Result for format details.
0 = SMARTLINK_COMMAND_OK
See Appendix #1 for all returned
codes.

5.51 ActivateRelayGroup
This command activates a group of relays according to its identifier.

42 DN1327-1004
 EntraPass SmartLink Reference Manual

Field Keyword & format Detail

Command Command
= ActivateRelayGroup
Parameter1 RelayGroupId=x x is the Relay group reference ID
Optional: x=YES, forces the controller to execute all
Parameter2 ForceSend=x
pending commands

Returned data:

Field Keyword & format Detail

See section 17: Returned
Format
Most common returned values:
Result for format details.
0 = SMARTLINK_COMMAND_OK
See Appendix #1 for all returned
codes.

5.52 ActivateTempoRelayGroup
This command temporarily activates a group of relays according to its identifier.

Field Keyword & format Detail

Command=ActivateTempoRelay
Command
Group
Parameter1 RelayGroupId=x x is the Relay group reference ID
Parameter2 RelayDelay=x x is the relay delay in seconds from 1 to 255
Optional: x=YES, forces the controller to execute all
Parameter3 ForceSend=x
pending commands

Returned data:

Field Keyword & format Detail

See section 17: Returned
Format
Most common returned values:
Result for format details.
0 = SMARTLINK_COMMAND_OK
See Appendix #1 for all returned
codes.

5.53 ReturnScheduleRelayGroup
This command returns a group of relays to normal schedule according to its identifier.

Field Keyword & format Detail

Command=ReturnScheduleRelay
Command
Group
Parameter1 RelayGroupId=x x is the Relay group reference ID
Parameter2 RelayDelay=x x is the relay delay in seconds from 1 to 255
Optional: x=YES, forces the controller to execute all
Parameter3 ForceSend=x
pending commands

Returned data:

DN1327-1004 43
 Field Keyword & format Detail
See section 17: Returned
Format
Most common returned values:
Result for format details.
0 = SMARTLINK_COMMAND_OK
See Appendix #1 for all returned
codes.

5.54 UnshuntInput
This command forces an input to be monitored according to its identifier.

Field Keyword & format Detail

Command Command
= UnshuntInput
Parameter1 InputId=x x is the Input reference ID
Optional: x=YES, forces the controller to execute all
Parameter2 ForceSend=x
pending commands

Returned data:

Field Keyword & format Detail

See section 17: Returned
Format
Most common returned values:
Result for format details.
0 = SMARTLINK_COMMAND_OK
See Appendix #1 for all returned
codes.

5.55 ShuntInput
This command prevents an input from being monitored according to its identifier.

Field Keyword & format Detail

Command Command
= ShuntInput
Parameter1 InputId=x x is the Input reference ID
Optional: x=YES, forces the controller to execute all
Parameter2 ForceSend=x
pending commands

Returned data:

Field Keyword & format Detail

See section 17: Returned
Format
Most common returned values:
Result for format details.
0 = SMARTLINK_COMMAND_OK
See Appendix #1 for all returned
codes.

5.56 ShuntInputTempo
This command temporarily prevents an input from being monitored according to its identifier.

44 DN1327-1004
 EntraPass SmartLink Reference Manual

Field Keyword & format Detail

Command Command
= ShuntInputTempo
Parameter1 InputId=x x is the Input reference ID
Parameter2 InputDelay=x x is the relay delay in seconds from 1 to 255
Optional: x=YES, forces the controller to execute all
Parameter3 ForceSend=x
pending commands

Returned data:

Field Keyword & format Detail

See section 17: Returned
Format
Most common returned values:
Result for format details.
0 = SMARTLINK_COMMAND_OK
See Appendix #1 for all returned
codes.

5.57 SuperviseInput
This command continuously supervises an input according to its identifier.

Field Keyword & format Detail

Command Command
= SupervisedInput
Parameter1 InputId=x x is the Input reference ID
Optional: x=YES, forces the controller to execute all
Parameter2 ForceSend=x
pending commands

Returned data:

Field Keyword & format Detail

See section 17: Returned
Format
Most common returned values:
Result for format details.
0 = SMARTLINK_COMMAND_OK
See Appendix #1 for all returned
codes.

5.58 ReturnScheduleInput
This command returns an input to its normal schedule according to its identifier.

Field Keyword & format Detail

Command Command
= ReturnScheduleInput
Parameter1 InputId=x x is the Input reference ID
Optional: x=YES, forces the controller to execute all
Parameter2 ForceSend=x
pending commands

Returned data:

DN1327-1004 45
 Field Keyword & format Detail
See section 17: Returned
Format
Most common returned values:
Result for format details.
0 = SMARTLINK_COMMAND_OK
See Appendix #1 for all returned
codes.

5.59 ToggleInputShunt
This command toggles shunt or unshunt an input according to its identifier.

Field Keyword & format Detail

Command Command
= ToggleInputShunt
Parameter1 InputId=x x is the Input reference ID
Optional: x=YES, forces the controller to execute all
Parameter2 ForceSend=x
pending commands

Returned data:

Field Keyword & format Detail

See section 17: Returned
Format
Most common returned values:
Result for format details.
0 = SMARTLINK_COMMAND_OK
See Appendix #1 for all returned
codes.

5.60 UnshuntInputGroup
This command forces a group of inputs to be monitored according to its identifier.

Field Keyword & format Detail

Command Command
= UnshuntInputGroup
Parameter1 InputGroupId=x x is the Input group reference ID
Optional: x=YES, forces the controller to execute all
Parameter2 ForceSend=x
pending commands

Returned data:

Field Keyword & format Detail

See section 17: Returned
Format
Most common returned values:
Result for format details.
0 = SMARTLINK_COMMAND_OK
See Appendix #1 for all returned
codes.

5.61 ShuntInputGroup
This command prevents a group of inputs from being monitored according to its identifier.

46 DN1327-1004
 EntraPass SmartLink Reference Manual

Field Keyword & format Detail

Command Command
= ShuntInputGroup
Parameter1 InputGroupId=x x is the Input group reference ID
Optional: x=YES, forces the controller to execute all
Parameter2 ForceSend=x
pending commands

Returned data:

Field Keyword & format Detail

See section 17: Returned
Format
Most common returned values:
Result for format details.
0 = SMARTLINK_COMMAND_OK
See Appendix #1 for all returned
codes.

5.62 ShuntTempoInputGroup
This command temporarily prevents a group of inputs from being monitored according to its identifier.

Field Keyword & format Detail

Command Command
= ShuntTempoInputGroup
Parameter1 InputGroupId=x x is the Input group reference ID
Parameter2 InputDelay=x x is the relay delay in seconds from 1 to 255
Optional: x=YES, forces the controller to execute all
Parameter3 ForceSend=x
pending commands

Returned data:

Field Keyword & format Detail

See section 17: Returned
Format
Most common returned values:
Result for format details.
0 = SMARTLINK_COMMAND_OK
See Appendix #1 for all returned
codes.

5.63 SuperviseInputGroup
This command continuously supervises a group of inputs according to its identifier.

Field Keyword & format Detail

Command Command
= SuperviseInputGroup
Parameter1 InputGroupId=x x is the Input group reference ID
Optional: x=YES, forces the controller to execute all
Parameter2 ForceSend=x
pending commands

Returned data:

DN1327-1004 47
 Field Keyword & format Detail
See section 17: Returned
Format
Most common returned values:
Result for format details.
0 = SMARTLINK_COMMAND_OK
See Appendix #1 for all returned
codes.

5.64 ReturnScheduleInputGroup
This command returns a group of inputs to normal schedule according to its identifier.

Field Keyword & format Detail

Command=ReturnScheduleInput
Command
Group
Parameter1 InputGroupId=x x is the Input group reference ID
Optional: x=YES, forces the controller to execute all
Parameter2 ForceSend=x
pending commands

Returned data:

Field Keyword & format Detail

See section 17: Returned
Format
Most common returned values:
Result for format details.
0 = SMARTLINK_COMMAND_OK
See Appendix #1 for all returned
codes.

5.65 EnableDoor
This command enables a door according to its identifier.

Field Keyword & format Detail

Command Command
= EnableDoor
Parameter1 DoorId=x x is the Door reference ID
Optional: x=YES, forces the controller to execute all
Parameter2 ForceSend=x
pending commands

Returned data:

Field Keyword & format Detail

See section 17: Returned
Format
Most common returned values:
Result for format details.
0 = SMARTLINK_COMMAND_OK
See Appendix #1 for all returned
codes.

5.66 DisableDoor
This command disables a door according to its identifier.

48 DN1327-1004
 EntraPass SmartLink Reference Manual

Field Keyword & format Detail

Command Command
= DisableDoor
Parameter1 DoorId=x x is the Door reference ID
Optional: x=YES, forces the controller to execute all
Parameter2 ForceSend=x
pending commands

Returned data:

Field Keyword & format Detail

See section 17: Returned
Format
Most common returned values:
Result for format details.
0 = SMARTLINK_COMMAND_OK
See Appendix #1 for all returned
codes.

5.67 EnableDoorGroup
This command enables a group of doors according to its identifier.

Field Keyword & format Detail

Command Command
= EnableDoorGroup
Parameter1 DoorGroupId=x x is the Door group reference ID
Optional: x=YES, forces the controller to execute all
Parameter2 ForceSend=x
pending commands

Returned data:

Field Keyword & format Detail

See section 17: Returned
Format
Most common returned values:
Result for format details.
0 = SMARTLINK_COMMAND_OK
See Appendix #1 for all returned
codes.

5.68 DisableDoorGroup
This command disables a group of doors according to its identifier.

Field Keyword & format Detail

Command Command
= DisableDoorGroup
Parameter1 DoorGroupId=x x is the Door group reference ID
Optional: x=YES, forces the controller to execute all
Parameter2 ForceSend=x
pending commands

Returned data:

DN1327-1004 49
 Field Keyword & format Detail
See section 17: Returned
Format
Most common returned values:
Result for format details.
0 = SMARTLINK_COMMAND_OK
See Appendix #1 for all returned
codes.

5.69 LockElevatorDoor
This command locks an elevator door according to its identifier.

Field Keyword & format Detail

Command Command
= LockElevatorDoor
Parameter1 DoorId=x x is the elevator door reference ID
Optional: x=YES, forces the controller to execute all
Parameter2 ForceSend=x
pending commands

Returned data:

Field Keyword & format Detail

See section 17: Returned
Format
Most common returned values:
Result for format details.
0 = SMARTLINK_COMMAND_OK
See Appendix #1 for all returned
codes.

5.70 UnlockElevatorDoor
This command unlocks an elevator door according to its identifier.

Field Keyword & format Detail

Command Command
= UnlockElevatorDoor
Parameter1 DoorId=x x is the elevator door reference ID
Optional: x=YES, forces the controller to execute all
Parameter2 ForceSend=x
pending commands

Returned data:

Field Keyword & format Detail

See section 17: Returned
Format
Most common returned values:
Result for format details.
0 = SMARTLINK_COMMAND_OK
See Appendix #1 for all returned
codes.

5.71 UnlockTempoElevatorDoor
This command temporarily unlocks an elevator door according to its identifier.

50 DN1327-1004
 EntraPass SmartLink Reference Manual

Field Keyword & format Detail

Command=UnlockTempoElevator
Command
Door
Parameter1 DoorId=x x is the elevator door reference ID
Parameter2 DoorDelay=x x is the door delay in seconds from 1 to 255
Optional: x=YES, forces the controller to execute all
Parameter3 ForceSend=x
pending commands

Returned data:

Field Keyword & format Detail

See section 17: Returned
Format
Most common returned values:
Result for format details.
0 = SMARTLINK_COMMAND_OK
See Appendix #1 for all returned
codes.

5.72 ReturnScheduleElevatorDoor
This command returns an elevator door to normal schedule.

Field Keyword & format Detail

Command=ReturnScheduleElev
Command
atorDoor
Parameter1 DoorId=x x is the elevator door reference ID
Optional: x=YES, forces the controller to execute all
Parameter2 ForceSend=x
pending commands

Returned data:

Field Keyword & format Detail

See section 17: Returned
Format
Most common returned values:
Result for format details.
0 = SMARTLINK_COMMAND_OK
See Appendix #1 for all returned
codes.

5.73 LockElevatorDoorGroup
This command locks a group of elevator doors according to its identifier.

Field Keyword & format Detail

Command Command
= LockElevatorDoorGroup
Parameter1 DoorGroupId=x x is the Elevator door group reference ID
Optional: x=YES, forces the controller to execute all
Parameter2 ForceSend=x
pending commands

Returned data:

DN1327-1004 51
 Field Keyword & format Detail
See section 17: Returned
Format
Most common returned values:
Result for format details.
0 = SMARTLINK_COMMAND_OK
See Appendix #1 for all returned
codes.

5.74 UnlockElevatorDoorGroup
This command unlocks a group of elevator doors according to its identifier.

Field Keyword & format Detail

Command=UnlockElevatorDoor
Command
Group
Parameter1 DoorGroupId=x x is the Elevator door group reference ID
Optional: x=YES, forces the controller to execute all
Parameter2 ForceSend=x
pending commands

Returned data:

Field Keyword & format Detail

See section 17: Returned
Format
Most common returned values:
Result for format details.
0 = SMARTLINK_COMMAND_OK
See Appendix #1 for all returned
codes.

5.75 UnlockTempoElevatorDoorGroup
This command temporarily unlocks a group of elevator doors according to its identifier.

Field Keyword & format Detail

Command=UnlockTempoElevator
Command
DoorGroup
Parameter1 DoorGroupId=x x is the Elevator door reference ID
Parameter2 DoorDelay=x x is the door delay in seconds from 1 to 255
Optional: x=YES, forces the controller to execute all
Parameter3 ForceSend=x
pending commands

Returned data:

Field Keyword & format Detail

See section 17: Returned
Format
Most common returned values:
Result for format details.
0 = SMARTLINK_COMMAND_OK
See Appendix #1 for all returned
codes.

5.76 ReturnScheduleElevatorDoorGroup
This command returns a group of elevator doors to normal schedule.

52 DN1327-1004
 EntraPass SmartLink Reference Manual

Field Keyword & format Detail

Command=UnlockTempoElevator
Command
DoorGroup
Parameter1 DoorGroupId=x x is the Elevator door reference ID
Optional: x=YES, forces the controller to execute all
Parameter2 ForceSend=x
pending commands

Returned data:

Field Keyword & format Detail

See section 17: Returned
Format
Most common returned values:
Result for format details.
0 = SMARTLINK_COMMAND_OK
See Appendix #1 for all returned
codes.

5.77 EnableElevatorDoor
This command enables an elevator door according to its identifier.

Field Keyword & format Detail

Command Command
= EnableElevatorDoor
Parameter1 DoorId=x x is the Elevator Door reference ID
Optional: x=YES, forces the controller to execute all
Parameter2 ForceSend=x
pending commands

Returned data:

Field Keyword & format Detail

See section 17: Returned
Format
Most common returned values:
Result for format details.
0 = SMARTLINK_COMMAND_OK
See Appendix #1 for all returned
codes.

5.78 DisableElevatorDoor
This command disables an elevator door according to its identifier.

Field Keyword & format Detail

Command Command
= DisableElevatorDoor
Parameter1 DoorId=x x is the Elevator Door reference ID
Optional: x=YES, forces the controller to execute all
Parameter2 ForceSend=x
pending commands

Returned data:

DN1327-1004 53
 Field Keyword & format Detail
See section 17: Returned
Format
Most common returned values:
Result for format details.
0 = SMARTLINK_COMMAND_OK
See Appendix #1 for all returned
codes.

5.79 EnableElevatorDoorGroup
This command enables a group of elevator doors according to its identifier.

Field Keyword & format Detail

Command=EnableElevatorDoor
Command
Group
Parameter1 DoorGroupId=x x is the Elevator Door group reference ID
Optional: x=YES, forces the controller to execute all
Parameter2 ForceSend=x
pending commands

Returned data:

Field Keyword & format Detail

See section 17: Returned
Format
Most common returned values:
Result for format details.
0 = SMARTLINK_COMMAND_OK
See Appendix #1 for all returned
codes.

5.80 DisableElevatorDoorGroup
This command disables a group of elevator doors according to its identifier.

Field Keyword & format Detail

Command Command
= DisableDoorGroup
Parameter1 DoorGroupId=x x is the Elevator Door group reference ID
Optional: x=YES, forces the controller to execute all
Parameter2 ForceSend=x
pending commands

Returned data:

Field Keyword & format Detail

See section 17: Returned
Format
Most common returned values:
Result for format details.
0 = SMARTLINK_COMMAND_OK
See Appendix #1 for all returned
codes.

5.81 EnableFloorElevatorDoor
This command enables a floor elevator door according to its identifier.

54 DN1327-1004
 EntraPass SmartLink Reference Manual

Field Keyword & format Detail

Command=EnableFloorElevator
Command
Door
Parameter1 DoorId=x x is the Floor Elevator Door reference ID
Optional: x=YES, forces the controller to execute all
Parameter2 ForceSend=x
pending commands

Returned data:

Field Keyword & format Detail

See section 17: Returned
Format
Most common returned values:
Result for format details.
0 = SMARTLINK_COMMAND_OK
See Appendix #1 for all returned
codes.

5.82 DisableFloorElevatorDoor
This command disables a floor elevator door according to its identifier.

Field Keyword & format Detail

Command=DisableFloorElevator
Command
Door
Parameter1 DoorId=x x is the Floor Elevator Door reference ID
Optional: x=YES, forces the controller to execute all
Parameter2 ForceSend=x
pending commands

Returned data:

Field Keyword & format Detail

See section 17: Returned
Format
Most common returned values:
Result for format details.
0 = SMARTLINK_COMMAND_OK
See Appendix #1 for all returned
codes.

5.83 EnableFloorElevatorDoorGroup
This command enables a group of floor elevator doors according to its identifier.

Field Keyword & format Detail

Command=EnableFloorElevator
Command
DoorGroup
Parameter1 DoorGroupId=x x is the Floor Elevator Door group reference ID
Optional: x=YES, forces the controller to execute all
Parameter2 ForceSend=x
pending commands

Returned data:

DN1327-1004 55
 Field Keyword & format Detail
See section 17: Returned
Format
Most common returned values:
Result for format details.
0 = SMARTLINK_COMMAND_OK
See Appendix #1 for all returned
codes.

5.84 DisableFloorElevatorDoorGroup
This command disables a group of floor elevator doors according to its identifier.

Field Keyword & format Detail

Command Command
= DisableFloorDoorGroup
Parameter1 DoorGroupId=x x is the Floor Elevator Door group reference ID
Optional: x=YES, forces the controller to execute all
Parameter2 ForceSend=x
pending commands

Returned data:

Field Keyword & format Detail

See section 17: Returned
Format
Most common returned values:
Result for format details.
0 = SMARTLINK_COMMAND_OK
See Appendix #1 for all returned
codes.

5.85 WorkstationStatus
This command gets the status of a workstation according to its identifier.

Field Keyword & format Detail

Command Command
= WorkstationStatus
Parameter1 WorkstationID=x x is for the workstation reference ID

Returned data:

Field Keyword & format Detail

See section 17: Returned
Format
Most common returned values:
Result for format details.
0 = SMARTLINK_COMMAND_OK
See Appendix #1 for all returned
codes.
Communication state, x can be:
Parameter1 CommunicationState=x • Connected
• Disconnected

5.86 GatewayStatus
This command gets the state of a Gateway according to its identifier.

56 DN1327-1004
 EntraPass SmartLink Reference Manual

Field Keyword & format Detail

Command Command
= GatewayStatus
Parameter1 GatewayID=x x is the Gateway reference ID

Returned data:

Field Keyword & format Detail

See section 17: Returned
Format
Most common returned values:
Result for format details.
0 = SMARTLINK_COMMAND_OK
See Appendix #1 for all returned
codes.
Communication state. x can be:
Parameter1 CommunicationState=x • OK
• Failure
Informs that server is reloading, x can be:
Parameter2 ServerReload=x • No
• Yes
Informs that workstation is reloading, x can be:
Parameter3 WorkstationReload=x • No
• Yes

5.87 SiteStatus
This command gets the status of a site according to its identifier.

Field Keyword & format Detail

Command Command
= SiteStatus
Parameter1 SiteID=x x is the Site Reference ID

Returned data:

Field Keyword & format Detail

See section 17: Returned
Format
Most common returned values:
Result for format details.
0 = SMARTLINK_COMMAND_OK
See Appendix #1 for all returned
codes.
Parameter1 COMMUNICATIONSTATE=x x = CONNECTED or NOTCONNECTED

5.88 ControllerStatus
This command gets the status of a controller according to its identifier.

Field Keyword & format Detail

Command Command
= ControllerStatus
Parameter1 ControllerID=x x is the controller reference ID

Returned data:

DN1327-1004 57
 Field Keyword & format Detail
See section 17: Returned
Format
Most common returned values:
Result for format details.
0 = SMARTLINK_COMMAND_OK
See Appendix #1 for all returned
codes.
Controller defined, x can be:
Parameter1 Exist=x • No
• Yes
Communication failure, x can be:
Parameter2 Failure=x • No
• Yes
Controller is in hard reset, x can be:
Parameter3 HardReset=x • No
• Yes
AC power failure, x can be:
Parameter4 AcAlarm=x • No
• Yes
Tamper is in alarm, x can be:
Parameter5 TamperAlarm=x • No
• Yes
Valid AC schedule, x can be:
Parameter6 AcSchedule=x • No
• Yes
Valid tamper schedule, x can be:
Parameter7 TamperSchedule=x • No
• Yes
Parameter8 Version=xx.xx Controller version

5.89 DoorStatus
This command gets the status of a door according to its identifier.

Field Keyword & format Detail

Command Command
= DoorStatus
Parameter1 DoorID=x x is the door reference ID

Returned data:

58 DN1327-1004
 EntraPass SmartLink Reference Manual

Field Keyword & format Detail

See section 17: Returned
Format
Most common returned values:
Result for format details.
0 = SMARTLINK_COMMAND_OK
See Appendix #1 for all returned
codes.
Controller defined, x can be:
Parameter1 ControllerExist=x No
Yes
Controller failure, x can be:
Parameter2 ControllerFailure=x • No
• Yes
Door is defined, x can be:
Parameter3 DoorExist=x • No
• Yes
Door opened, x can be:
• Close
• Forced
Parameter4 OpenState=x • OpenTooLong
• PreAlarmOpenTooLong
• StillOpen
• Open
Door is locked, x can be:
• Lock
Parameter5 LockState=x
• UnlockOperator
• UnlockSchedule
Reader is disabled, x can be:
Parameter6 ReaderDisable=x • No
• Yes

5.90 RelayStatus
This command gets the status of a relay according to its identifier.

Field Keyword & format Detail

Command Command
= RelayStatus
Parameter1 RelayID=x x is the relay reference ID

Returned data:

DN1327-1004 59
 Field Keyword & format Detail
See section 17: Returned
Format
Most common returned values:
Result for format details.
0 = SMARTLINK_COMMAND_OK
See Appendix #1 for all returned
codes.
Controller defined, x can be:
Parameter1 ControllerExist=x • No
• Yes
Controller failure, x can be:
Parameter2 ControllerFailure=x • No
• Yes
Relay is defined, x can be:
Parameter3 RelayExist=x • No
• Yes
Relay State, x can be:
• Deactivate
• ActivateOperator
• ActivateSchedule
• ActivateInput
• ActivateArea
• ActivateEvent
• ActivateAlarmSystem
Parameter4 State=x • ActivateAlarmSystemStatus
• ActivateAlarmSystemPostpone
• ActivateAlarmSystemEntryDelay
• ActivateAlarmSystemExitDelay
• ActivateAlarmSystemArmingDelay
• ActivateAlarmSystemPreventArming
• ActivateAlarmSystemAlarm1
• ActivateAlarmSystemAlarm2
• ActivateAlarmSystemBell
Relay temporarily activated, x can be:
Parameter5 ActivateTempo=x • No
• Yes
x is the alarm system ID. When the relay is not
Parameter6 AlarmSystemID=x
activated by an alarm system, the value is 0.

5.91 InputStatus
This command gets the status of an input according to its identifier.

Field Keyword & format Detail

Command Command
= InputStatus
Parameter1 InputID=x x is the input reference ID

Returned data:

60 DN1327-1004
 EntraPass SmartLink Reference Manual

Field Keyword & format Detail

See section 17: Returned
Format
Most common returned values:
Result for format details.
0 = SMARTLINK_COMMAND_OK
See Appendix #1 for all returned
codes.
Controller defined, x can be:
Parameter1 ControllerExist=x • No
• Yes
Controller failure, x can be:
Parameter2 ControllerFailure=x • No
• Yes
Input is defined, x can be:
Parameter3 InputExist=x • No
• Yes
Input state, x can be:
• Normal
Parameter4 State=x • NormalNotSupervised
• Alarm
• AlarmNotSupervised
Zone supervision, x can be:
• Normal
Parameter5 Supervision=x • Continuous
• None
• Reverse
Zone is armed, x can be:
Parameter6 Armed=x • No
• Yes

5.92 OutputStatus (Not implemented)

This command is not implemented.

5.93 AlarmSystemStatus (Global only)

This command gets the status of an alarm system according to its identifier.

Field Keyword & format Detail

Command Command
= AlarmSystemStatus
Parameter1 AlarmSystemID=x x is the alarm system reference ID

Returned data:

DN1327-1004 61
 Field Keyword & format Detail
See section 17: Returned
Format
Most common returned values:
Result for format details.
0 = SMARTLINK_COMMAND_OK
See Appendix #1 for all returned
codes.
Parameter1 ALARMSYSTEMEXIST=x Define alarm system, x = Yes or No
Parameter2 Armed=x System is armed, x = Yes or No
Parameter3 Alarm1=x Alarm #1 activated, x = Yes or No
Parameter4 Alarm2=x Alarm #2 activated, x = Yes or No
Parameter5 ArmingSchedule=x Arming schedule, x = VALID or INVALID
Parameter6 DisarmingSchedule=x Disarming schedule, x = VALID or INVALID
Parameter7 StatusRelay=x Status relay activated, x=Yes or No
Parameter8 EntryDelay=x Entry delay, x=0 to 65535
Parameter9 ExitDelay=x Exit delay, x=0 to 65535
Parameter10 ArmingDelay=x Arming delay, x = 0 to 65535
Parameter11 Postponedelay=x Postponement delay, x = 0 to 65535

5.94 AreaStatus (Global only)

This command gets the status of an area according to its identifier.

Field Keyword & format Detail

Command Command
= AreaStatus
Parameter1 AreaID=x x is the area reference ID

Returned data:

Field Keyword & format Detail

See section 17: Returned
Format
Most common returned values:
Result for format details.
0 = SMARTLINK_COMMAND_OK
See Appendix #1 for all returned
codes.
Parameter1 State=x Status of the area, x = OPEN or CLOSE

5.95 GuardTourStatus (Global only)

This command gets the status of a guard tour according to its identifier.

Field Keyword & format Detail

Command Command
= AreaStatus
Parameter1 GuardTourID=x x is the guardTour reference ID

Returned data:

62 DN1327-1004
 EntraPass SmartLink Reference Manual

Field Keyword & format Detail

See section 17: Returned
Format
Most common returned values:
Result for format details.
0 = SMARTLINK_COMMAND_OK
See Appendix #1 for all returned
codes.
Parameter1 State=x Status of the area, x = OPEN or CLOSE

5.96 GetLastTransactionCard
This command gets the … TBD

Field Keyword & format Detail

Command C ommand
= GetLastTransactioncard
ProcessCMDGet
LastTransactionC ProcessCMDGetLastTransactionCard ProcessCMDGetLastTransactionCard
ardParameter1

Returned data:

Field Keyword & format Detail

See section 17: Returned
Format
Most common returned values:
Result for format details.
0 = SMARTLINK_COMMAND_OK
See Appendix #1 for all returned
codes.
Parameter1 EventCard=x
Parameter2 DoorDescription=x
Parameter3 TransactionDate=x

5.97 GetReportEmail
This command gets the … TBD

Field Keyword & format Detail

Command Command
= GetReportEmail
Parameter1 ReportId=x x is the TBD
Parameter2 StartDateId=YYYY\MM\DD YYYY = Year, MM = Month, DD = Day
Parameter3 StartTimeId=HH:MM:SS HH = Hours, MM = Minutes, SS = seconds
Parameter4 EndDateId=YYYY\MM\DD YYYY = Year, MM = Month, DD = Day
Parameter5 EndTimeId=HH:MM:SS HH = Hours, MM=Minutes, SS = seconds
Parameter6 EmailId=x x is the TBD
Parameter7 ReportFormat=x x is the TBD

Returned data:

DN1327-1004 63
 Field Keyword & format Detail
See section 17: Returned
Format
Most common returned values:
Result for format details.
0 = SMARTLINK_COMMAND_OK
See Appendix #1 for all returned
codes.

5.98 ConnectSite
This command sends a connection request to a site.

Field Keyword & format Detail

Command Command
= ConnectSite
Parameter1 SiteId=x x is the Site Reference ID

Returned data:

Field Keyword & format Detail

See section 17: Returned
Format
Most common returned values:
Result for format details.
0 = SMARTLINK_COMMAND_OK
See Appendix #1 for all returned
codes.

5.99 DisconnectSite
This command sends a disconnection request to a site.

Field Keyword & format Detail

Command Command
= DisconnectSite
Parameter1 SiteId=x x is the Site Reference ID

Returned data:

Field Keyword & format Detail

See section 17: Returned
Format
Most common returned values:
Result for format details.
0 = SMARTLINK_COMMAND_OK
See Appendix #1 for all returned
codes.

5.100 UpdateRemoteSite
This command calls one site with modified data.

Field Keyword & format Detail

Command Command
= UpdateRemoteSite
Parameter1 SiteId=x x is the Site Reference ID

Returned data:

64 DN1327-1004
 EntraPass SmartLink Reference Manual

Field Keyword & format Detail

See section 17: Returned
Format
Most common returned values:
Result for format details.
0 = SMARTLINK_COMMAND_OK
See Appendix #1 for all returned
codes.

5.101 UpdateRemoteSiteGateway
This command calls all sites on a specific gateway with modified data.

Field Keyword & format Detail

Command=UpdateRemoteSite
Command
Gateway
Parameter1 GatewayId=x x is the Gateway reference ID

Returned data:

Field Keyword & format Detail

See section 17: Returned
Format
Most common returned values:
Result for format details.
0 = SMARTLINK_COMMAND_OK
See Appendix #1 for all returned
codes.

5.102 UpdateAllSite
This command calls all gateway sites with modified data.

Field Keyword & format Detail

Command Command
= UpdateAllSite

Returned data:

Field Keyword & format Detail

See section 17: Returned
Format
Most common returned values:
Result for format details.
0 = SMARTLINK_COMMAND_OK
See Appendix #1 for all returned
codes.

5.103 ExecuteTask
This command asks the server to execute a specific task.

Field Keyword & format Detail

Command Command
= ExecuteTask
Parameter1 TaskId=x x is the task id

Returned data:

DN1327-1004 65
 Field Keyword & format Detail
See section 17: Returned
Format
Most common returned values:
Result for format details.
0 = SMARTLINK_COMMAND_OK
See Appendix #1 for all returned
codes.

5.104 BatchModify
This command modifies a batch of cards.

Field Keyword & format Detail

Command Command
= BatchModify
Parameter1 CardTpeId=x x is the card type reference ID
Parameter2 CardState=x x is Valid or Invalid or Stolen or Lost
Parameter3 SupervisorLevel=x x is a value from 0 to 15
Parameter4 UsingCardCount=x x is Yes or No
Parameter5 CardCountValue=x X is a value from 1 to 32767
Parameter6 Trace=x x is Yes or No
Parameter7 StartDate=x x is a date
Parameter8 UsingEndDate=x x is Yes or No
Parameter9 EndDate=x x is a date
Parameter10 DeleteOnExpired=x x is Yes or No
Parameter11 WaitForKeypad=x x is Yes or No
Parameter12 CardAccessGroupAction=x x is Replace or Update or Add or UpdateAdd
Parameter13 CardAccessGroup=x X is the card access group reference id
Parameter14 Badging=x X is the badging reference id

Returned data:

Field Keyword & format Detail

See section 17: Returned
Format
Most common returned values:
Result for format details.
0 = SMARTLINK_COMMAND_OK
See Appendix #1 for all returned
codes.

Parameter2 to parameter14 are optional according to the requested process.

5.105 GetDescription
This command gets the description of a specific component.

Field Keyword & format Detail

Command Command
= GetDescription
Parameter1 PkData=x x is the Component reference ID

Returned data:

66 DN1327-1004
 EntraPass SmartLink Reference Manual

Field Keyword & format Detail

See section 17: Returned
Format
Most common returned values:
Result for format details.
0 = SMARTLINK_COMMAND_OK
See Appendix #1 for all returned
codes.

5.106 EmailPassword
This command emails a password.

Field Keyword & format Detail

Command Command
= EmailPassword
Parameter1 Email=x x is the email address

Returned data:

Field Keyword & format Detail

See section 17: Returned
Format
Most common returned values:
Result for format details.
0 = SMARTLINK_COMMAND_OK
See Appendix #1 for all returned
codes.

5.107 ChangePassword
This command changes the password for a specific operator.

Field Keyword & format Detail

Command Command
= GetDescription
Parameter1 OldPassword=x x is the Old password string
Parameter2 NewPassword=x x is the New password string

Returned data:

Field Keyword & format Detail

See section 17: Returned
Format
Most common returned values:
Result for format details.
0 = SMARTLINK_COMMAND_OK
See Appendix #1 for all returned
codes.

5.108 GetCardAccessGroup
This command gets the card access group information.

Field Keyword & format Detail

Command Command
= GetCardAccessGroup
Parameter1 PkData=x x is the Component reference ID

Returned data:

DN1327-1004 67
 Field Keyword & format Detail
See section 17: Returned
Format
Most common returned values:
Result for format details.
0 = SMARTLINK_COMMAND_OK
See Appendix #1 for all returned
codes.
Return the card access group description in the current
Parameter1 Description=x
language.
x = Reference Id for the Gateway global or the site
Parameter2 AccessLevel= “x \t y”
y = Reference Id for the Access Level
ParameterN AccessLevel=… … repeat for each access level as required

5.109 GetAccessLevelDescription
This command gets the access level description of a specific component.

Field Keyword & format Detail

Command=GetAccessLevel
Command
Description
Parameter1 PkData=x x is the Component reference ID

Returned data:

Field Keyword & format Detail

See section 17: Returned Format
for format details. Most common returned values:
Result
See Appendix #1 for all returned 0 = SMARTLINK_COMMAND_OK
codes.
Parameter1 Description=x Returns the field description in the current language.
a = PkData
b = Description
c = Links to schedule (Unique ID)
Parameter2 AccessLevel= “a \t b \t c \t d \t e \t f”
d = description of data schedule
e = Links to floor group (Unique ID)
f = Description of floor group
ParameterN AccessLevel=… … repeat for each access level as required

5.110 AddToTrigger
This command adds a component filter to a trigger.

Field Keyword & format Detail

Command Command
= AddToTrigger
Parameter1 TriggerId=x x is the trigger unique ID
Parameter2 ComponentId=x x is the Component filter unique ID
Parameter3 Parameter1=x x is the first parameter unique ID
Parameter4 Parameter2=x x is the second parameter unique ID

Returned data:

68 DN1327-1004
 EntraPass SmartLink Reference Manual

Field Keyword & format Detail

See section 17: Returned
Format
Most common returned values:
Result for format details.
0 = SMARTLINK_COMMAND_OK
See Appendix #1 for all returned
codes.

5.111 RemoveFromTrigger
This command removes a component filter to trigger.

Field Keyword & format Detail

Command Command
= RemoveFromTrigger
Parameter1 ComponentId=x x is the Component filter reference ID
Parameter2 ListFilter=x x is the filter reference ID
Parameter3 ListParent=x x is the parent reference ID (may be optional)
Parameter4 ListNtm=x x is the NTM reference ID (may be optional)
Parameter5 ListGsi=x x is the GSI reference ID (may be optional)

Returned data:

Field Keyword & format Detail

See section 17: Returned
Format
Most common returned values:
Result for format details.
0 = SMARTLINK_COMMAND_OK
See Appendix #1 for all returned
codes.

5.112 GetList
This command gets a list of component.

Field Keyword & format Detail

Command Command
= GetList
x is the Component’s accesslevel ID,accesslevelgroup
ID,alarmsystem ID,area ID,card ID,cardaccessgroup ID,
cardarchive ID,cardtype ID,controller ID,controllergroup
ID,door ID,doorgroup ID, floor ID,floorgroup ID,graphic
ID,gsi ID,guardtour ID,holiday ID,input ID,inputgroup ID,
instruction ID,trigger ID,rollcallreport ID,cardfilter
Parameter2 ComponentId=x
ID,record ID,musterreport ID, camera ID,messageview
ID,ntm ID,operator ID,operatorconfig ID,output ID,
videotrigger ID,relay ID,relaygroup ID,report
ID,schedule ID,site ID,timeandattendance ID,
macromaker ID,badging ID,matrix ID,view ID,areagroup
ID

Returned data:

DN1327-1004 69
 Field Keyword & format Detail
See section 17: Returned
Format
Most common returned values:
Result for format details.
0 = SMARTLINK_COMMAND_OK
See Appendix #1 for all returned
codes.
Parameter1 PkData=x x is the Component element reference ID
Parameter2 Description=x x is the Component element description
ParameterN PkData=… … repeat for each element as required
ParameterN+1 Description=… … repeat for each element as required

5.113 GetListOwnerBy
This command gets a list of components.

Field Keyword & format Detail

Command Command
= GetListOwnerBy
x is the Component’s accesslevel ID,accesslevelgroup
ID,alarmsystem ID,area ID,card ID,cardaccessgroup ID,
cardarchive ID,cardtype ID,controller ID,controllergroup
ID,door ID,doorgroup ID, floor ID,floorgroup ID,graphic
ID,gsi ID,guardtour ID,holiday ID,input ID,inputgroup ID,
instruction ID,trigger ID,rollcallreport ID,cardfilter
Parameter1 ComponentId=x
ID,record ID,musterreport ID, camera ID,messageview
ID,ntm ID,operator ID,operatorconfig ID,output ID,
videotrigger ID,relay ID,relaygroup ID,report
ID,schedule ID,site ID,timeandattendance ID,
macromaker ID,badging ID,matrix ID,view ID,areagroup
ID
Parameter2 ListOwner=x x is the List Owner reference ID (may be optional)
Parameter3 ListFilter=x x is the text filter (may be optional)

Returned data:

Field Keyword & format Detail

See section 17: Returned
Format
Most common returned values:
Result for format details.
0 = SMARTLINK_COMMAND_OK
See Appendix #1 for all returned
codes.
Parameter1 PkData=x x is the Component element reference ID
Parameter2 Owner=x x is the owner reference Id
Parameter3 Object=x x is the object Id
Parameter4 Description=x x is the Component element description
ParameterN Parameter1-2-3-4=… … repeat for each element as required

5.114 GetListGraphicUrl
This command gets a list of graphic Urls.

70 DN1327-1004
 EntraPass SmartLink Reference Manual

Field Keyword & format Detail

Command Command
= GetListGraphicUrl

Returned data:

Field Keyword & format Detail

See section 17: Returned
Format
Most common returned values:
Result for format details.
0 = SMARTLINK_COMMAND_OK
See Appendix #1 for all returned
codes.
Parameter1 PkData=x x is the Component element reference ID
Parameter2 Description=x x is the Component element description
Parameter3 Url=x x is the Url
Parameter4 LoginName=x x is the login name
Parameter5 Password=x x is the password
ParameterN Parameter1-2-3-4-5=… … repeat for each element as required

GetListGraphicUrl1 Get a list of graphic URL ?

GetFind1 Get a list of component specific parameters ?

GetFindNext1 Get a list of component specific parameters (next) ?

5.115 GetFind
This command gets a list of component specific parameters.

Field Keyword & format Detail

Command Command
= GetFind
x is the Component’s accesslevel ID,accesslevelgroup
ID,alarmsystem ID,area ID,card ID,cardaccessgroup ID,
cardarchive ID,cardtype ID,controller ID,controllergroup
ID,door ID,doorgroup ID, floor ID,floorgroup ID,graphic
ID,gsi ID,guardtour ID,holiday ID,input ID,inputgroup ID,
instruction ID,trigger ID,rollcallreport ID,cardfilter
Parameter1 ComponentId=x
ID,record ID,musterreport ID, camera ID,messageview
ID,ntm ID,operator ID,operatorconfig ID,output ID,
videotrigger ID,relay ID,relaygroup ID,report
ID,schedule ID,site ID,timeandattendance ID,
macromaker ID,badging ID,matrix ID,view ID,areagroup
ID
Parameter2 ListNumberToRead=x x is the number to read (may be optional) default is 1000
x is the filter type = ListBegin or ListContain (may be
Parameter3 ListFilterType=x
optional). Default is ListBegin
Parameter4 ListFilter=x x is the text filter.
Parameter5 AllCardNumber=x x is the all card number state, 0 is false any other is true.
x is the list index and could be =
For Card: CardNumber, UserName, CardInfo1,
Parameter6 ListIndex=x
CardInfo2, CardInfo3, CardInfo4, CardInfo5, CardInfo6,
CardInfo7, CardInfo8, CardInfo9, CardInfo10

DN1327-1004 71
 Returned data:

Field Keyword & format Detail

See section 17: Returned
Format
Most common returned values:
Result for format details.
0 = SMARTLINK_COMMAND_OK
See Appendix #1 for all returned
codes.
Parameter1 CardNumber=x x is the card number (may be optional)
Parameter2 UserName=x x is the user name (may be optional)
Parameter3 CardInfo=x x is the card info (may be optional)
Parameter4 Description=x x is the description (may be optional)
ParameterN Parameter1-2-3-4=… … repeat for each element as required

5.116 GetFindNext
This command gets a list of component (next) specific parameters.

Field Keyword & format Detail

Command Command
= GetFindNext
Parameter1 ComponentId=x x is the Component filter unique ID
x is the number to read (may be optional) default is
Parameter2 ListNumberToRead=x
1000
x is the filter type = ListBegin or ListContain (may be
Parameter3 ListFilterType=x
optional). Default is ListBegin
Parameter4 ListFilter=x x is the filter value.
Parameter5 AllCardNumber=x x is the all card number state, 0 is false any other is true.
x is the list index and could be =
For Card: CardNumber, UserName, CardInfo1,
Parameter6 ListIndex=x
CardInfo2, CardInfo3, CardInfo4, CardInfo5, CardInfo6,
CardInfo7, CardInfo8, CardInfo9, CardInfo10

Returned data:

Field Keyword & format Detail

See section 17: Returned
Format
Most common returned values:
Result for format details.
0 = SMARTLINK_COMMAND_OK
See Appendix #1 for all returned
codes.
Parameter1 CardNumber=x x is the card number (may be optional)
Parameter2 UserName=x x is the user name (may be optional)
Parameter3 CardInfo=x x is the card Info (may be optional)
Parameter4 Description=x x is the description (may be optional)
ParameterN Parameter1-2-3-4=… … repeat for each element as required

5.117 AddHoliday
This command adds a holiday in the system.

72 DN1327-1004
 EntraPass SmartLink Reference Manual

Field Keyword & format Detail

Command Command
= AddHoliday
x specifies the gateway or Site Reference. x can be 0 for
Parameter1 GatewaySiteId=x
global holiday
Maximum of 40 characters, field is optional, default is
Parameter2 PrimaryName=x
“New holiday”
Maximum of 40 characters, field is optional, default is
Parameter3 SecondaryName = x
“New holiday”
YYYY = Year, MM = Month, DD = Day
Parameter4 HolidayDate=YYYY/MM/DD Invalid date will use day 0 (1899/12/30)
Field is optional, default is the current day
x can be:
• 1 = Holiday1
• 2 = Holiday2
Parameter5 HolidayRange=x
• 3 = Holiday3
• 4 = Holiday4
Field is optional, default is 1
x = Yes or No
Parameter6 HolidayRecurring =x Anything else is considered as a No
Field is optional, default is No

Returned data :

Field Keyword & format Detail

See section 17: Returned
Format
Most common returned values:
Result for format details.
0= SMARTLINK_COMMAND_OK
See Appendix #1 for all returned
codes.
Return the Holiday ID reference number needed to
Parameter1 HolidayID=x
modify or delete

5.118 GetHoliday
This command modifies a holiday to the system according to its reference number.

Field Keyword & format Detail

Command Command=ReadHoliday
Parameter1 HolidayID=x x is the Holiday ID reference number

Returned data

Field Keyword & format Detail

See section 17: Returned
Format
Most common returned values:
Result for format details.
0 = SMARTLINK_COMMAND_OK (granted)
See Appendix #1 for all returned
codes.
Parameter2 to
Same as in section 72: AddHoliday
Parameter6

DN1327-1004 73
 5.119 ModifyHoliday
This command modifies a holiday in the system according to its reference number.

Field Keyword & format Detail

Command Command=ModifyHoliday
Parameter1 HolidayID=x x is the Holiday ID reference number
Parameter2 to
Same as in section 72: AddHoliday
Parameter6

Returned data

Field Keyword & format Detail

See section 17: Returned
Format
Most common returned values:
Result for format details.
0 = SMARTLINK_COMMAND_OK (granted)
See Appendix #1 for all returned
codes.

5.120 DeleteHoliday
This command deletes a holiday within the system according to its reference number.

Field Keyword & format Detail

Command Command
= DeleteHoliday
Parameter1 HolidayID=x x is the Holiday ID reference number

Returned data:

Field Keyword & format Detail

See section 17: Returned
Format
Most common returned values:
Result for format details.
0 = SMARTLINK_COMMAND_OK
See Appendix #1 for all returned
codes.

5.121 AddSchedule
This command adds a schedule to the system. A ma ximum of four interva ls can be configu red. Each
interval must be preceeded with the “Interval=” keyword.

74 DN1327-1004
 EntraPass SmartLink Reference Manual

Field Keyword & format Detail

Command Command
= AddSchedule
x specifies the gateway or Site Reference. x is ignored
Parameter1 GatewaySiteId=x when advanced schedule capability is disabled. x can
be 0 for global holiday
Maximum of 40 characters
Parameter2 PrimaryName=x
Field is optional, default is “New schedule”
Maximum of 40 characters
Parameter3 SecondaryName = x
Field is optional, default is “New schedule”
Parameter4 Interval = x Specify the interval, x is from 1 to 4
x is the time in minutes from 0 to 1440 minutes where
Parameter5 StartTime=x 1440 is for 24:00
Field is optional, default is 0
x is the time in minutes from 0 to 1440 minutes where
Parameter6 EndTime=x 1440 is for 24:00
Field is optional, default is 0
Parameter7 Sunday=x x = Yes or No (optional, default is No)
Parameter8 Monday=x x = Yes or No (optional, default is No)
Parameter9 Tuesday=x x = Yes or No (optional, default is No)
Parameter10 Wednesday=x x = Yes or No (optional, default is No)
Parameter11 Thursday=x x = Yes or No (optional, default is No)
Parameter12 Friday=x x = Yes or No (optional, default is No)
Parameter13 Saturday=x x = Yes or No (optional, default is No)
Parameter14 Holiday1=x x = Yes or No (optional, default is No)
Parameter15 Holiday2=x x = Yes or No (optional, default is No)
Parameter16 Holiday3=x x = Yes or No (optional, default is No)
Parameter17 Holiday4=x x = Yes or No (optional, default is No)
Parameter18 Interval=x Specify the next interval, x is from 1 to 4
x is the time in minutes from 0 to 1440 minutes where
Parameter19 StartTime=x
1440 is for 24:00. Field is optional, default is 0
x is the time in minutes from 0 to 1440 minutes where
Parameter20 EndTime=x
1440 is for 24:00. Field is optional, default is 0
Parameter21 Sunday=x x = Yes or No (optional, default is No)
ParameterN … … repeat for each interval as required

Returned data :

Field Keyword & format Detail

See section 17: Returned
Format
Most common returned values:
Result for format details.
0= SMARTLINK_COMMAND_OK
See Appendix #1 for all returned
codes.
Return the schedule ID reference number needed to
Parameter1 ScheduleID=x
modify or delete

5.122 GetSchedule
This command gets a schedule from the system.

DN1327-1004 75
 Field Keyword & format Detail
Command Command=GetSchedule
Parameter1 ScheduleID=x x is the Schedule ID reference number

Returned data :

Field Keyword & format Detail

See section 17: Returned
Format
Most common returned values:
Result for format details.
0= SMARTLINK_COMMAND_OK
See Appendix #1 for all returned
codes.
0 = No
Parameter2 AllValid=x
1 = Yes
Parameter2 to
Same as in section 74: AddSchedule
ParameterN

5.123 ModifySchedule
This command modifies a schedule in the system.

Field Keyword & format Detail

Command Command=ModifySchedule
Parameter1 ScheduleID=x x is the schedule ID reference number
Parameter2 to
same as in section 74: AddSchedule
ParameterN

Returned data :

Field Keyword & format Detail

See section 17: Returned
Format
Most common returned values:
Result for format details.
0= SMARTLINK_COMMAND_OK
See Appendix #1 for all returned
codes.

5.124 DeleteSchedule
This command deletes a schedule in the system.

Field Keyword & format Detail

Command Command=DeleteSchedule Schedule ID reference number
Parameter1 ScheduleID=x x is the schedule ID reference number

Returned data :

76 DN1327-1004
 EntraPass SmartLink Reference Manual

Field Keyword & format Detail

See section 17: Returned
Format
Most common returned values:
Result for format details.
0= SMARTLINK_COMMAND_OK
See Appendix #1 for all returned
codes.

5.125 AddAccessLevel
This command ad ds an access le vel i n the system. A maximum of 250 access le vels can b e
programmed in a site.

Field Keyword & format Detail

Command Command
= AddAccessLevel
Parameter1 GatewaySiteId=x x specifies the gateway or Site Reference
x specifies the default schedule reference for all doors
Parameter2 DefaultScheduleID=x related to the specified site.
Field is optional, default is 0 for None
x specifies a default floor group reference for all doors
Parameter3 DefaultFloorsGroupId=x related to the specified site.
Field is optional, default is 0 for None
Maximum of 40 characters
Parameter4 PrimaryName=x
Field is optional, default is “New access level”
Maximum of 40 characters
Parameter5 SecondaryName = x
Field is optional, default is “New access level”
Field is optional
x specifies the door reference ID
Parameter6 Item=x, y, z
y specifies the schedule reference ID
z specifies the floor group ID (optional)
ParameterN Item=…, …, … … repeat for each door as required

Returned data :

Field Keyword & format Detail

See section 17: Returned
Format
Most common returned values:
Result for format details.
0= SMARTLINK_COMMAND_OK
See Appendix #1 for all returned
codes.
Returns the Access level ID reference number needed
Parameter1 AccessLevelID=x
to modify or delete

5.126 GetAccessLevel
This command gets an access level from the system.

Field Keyword & format Detail

Command Command
= GetAccessLevel
Parameter1 AccessLevelID=x x is the Access level ID reference number

Returned data :

DN1327-1004 77
 Field Keyword & format Detail
See section 17: Returned
Format
Most common returned values:
Result for format details.
0= SMARTLINK_COMMAND_OK
See Appendix #1 for all returned
codes.
Parameter1 AccessLevelID=x Returns the access level ID reference number
0 = No
Parameter2 AllValid=x
1 = Yes
Parameter3 to
Corresponds to parameter 4 to N in section 77: AddAccessLevel
ParameterN

5.127 ModifyAccessLevel
This command modifies an access level in the system.

Field Keyword & format Detail

Command Command
= ModifyAccessLevel
Parameter1 AccessLevelID=x x is the access level ID reference number
Parameter2 to
Corresponds to parameter 4 to N in section 77: AddAccessLevel
ParameterN

Returned data :

Field Keyword & format Detail

See section 17: Returned
Format
Most common returned values:
Result for format details.
0= SMARTLINK_COMMAND_OK
See Appendix #1 for all returned
codes.

5.128 DeleteAccessLevel
This command deletes an access level in the system.

Field Keyword & format Detail

Command Command
= DeleteAccessLevel Schedule ID reference number
Parameter1 AccessLevelID=x x is the access level ID reference number

Returned data :

Field Keyword & format Detail

See section 17: Returned
Format
Most common returned values:
Result for format details.
0= SMARTLINK_COMMAND_OK
See Appendix #1 for all returned
codes.

78 DN1327-1004
 EntraPass SmartLink Reference Manual

5.129 AddSite (FastSetup)

This command a dds a site in the system. It ca n create controllers in the same way as the fastSe tup
utility.

Field Keyword & format Type Details

Command Co =
mmand AddSite
Parameter1 GatewayID=x Int x specifies the gateway reference ID
Optional PrimaryName=x Str[40] default = “New site” (40 digits max)
Optional SecondaryName = x Str[40] default = “New site” (40 digits max)
Optional Graphic=x Int Links to graphic ID
Optional VideoView=x Int Links to VideoView ID
Options
0=Direct (default),
Optional 1 ConnectionType=x UChar 1=TCP/IP,
2=Modem
Also referred as the “Com port” within
Optional 1 SerialPort=x UChar the FastSetup: 1=COM1(default),
2=COM2, …, 99=COM99
Also referred as the “Loop speed”
within the FastSetup:
0=115200,
1=57600,
2=38400,
Optional 1 BaudRate=x UChar
3=19200 (default),
4=9600,
5=4800,
6=2400,
7=1200.
Optional 1 UseProtocol=x UChar 0=TCP/IP (default), 1=UDP/IP.
Doted string type as “127.0.0.1” (each
Optional 1 IpAddress=x Str[16]
number must be separated by “.”)
Optional 1 IpPort=x Int
0=Don’t use day light
Optional UseDayLightSavingTime=x UChar
1=Use day light (default)
-12.0 to +12.0 (0.5 increment), default
Optional FloatTimeAdjustement=x Float
is 0.0
Modem Options
Optional CodeToAccessAnOutsideLine=x Str[4] 4 digits, default is empty
Optional RemotePhoneNumber=x Str[63] 63 digits, default is empty
Optional ModemBrand=x UChar From Modem.db database
Optional ModemInitSettings=x Str[45] From Modem.db database
0 = Tone (default)
Optional PhoneLineType=x UChar
1= Pulse
Optional NumberOfRingBeforeAnswer=x UChar 1 to 16, default is 1
Optional NumberOfRetries=x UChar 0 to 16, default is 4
Optional AnswerOnFirstRingSchedule=x Int Links to schedule ID
Modem Schedule Parameter
Optional RetrieveSiteEvents=x Int Links to schedule ID
Optional IfDataIsModifiedSinceLast=x Int Links to schedule ID
Optional ReportEventsUnderPriorityCall=x Int Links to schedule ID

DN1327-1004 79
 Optional ReportEventsAutomatically=x Int Links to schedule ID
Optional FailToReportAfter=x Int 60 to 3599 seconds, default is 300
Miscellaneous
0 = no call
Optional CallbackForConnection=x UChar
1= call (default)
Optional FailToCallbackDelay=x Int 60 to 300 seconds, default is 90
Optional PrimaryHostModem=x UChar Gateway Modem list
Optional SecondaryHostModem=x UChar Gateway Modem list
0 = don’t stay on line
Optional AfterReceptionStayOnLineFor=x UChar
1= Stay on line (default)
Optional DisconnectLineAfter=x Int 60 to 86399 seconds, default is 180
0 = no call
Optional CallImmediatelyWhenSlaveFailure=x UChar
1 = call (default)
0 = no call
Optional CallImmediatelyWhenbuffer70Full=x UChar
1 = call (default)
Setup timings
1 to 40,
Default in DIALUP = 7
Optional ResponseTimeoutRatio=x Int
Default in TCPIP =5
Default in RS232 = 1
0 to 40
Optional PollingFrequency=x Int Default in TCPIP =5
Default in DIALUP or RS232 = 1
Optional ControllerFailureTimer=x Int 0 to 255 cc, default = 10
Optional PollDelay1=x Int 0 to 255 cc, default = 20
Optional PollDelay2=x Int 0 to 255 cc, default = 80
Optional PollDelay3=x Int 0 to 255 cc, default = 100
Modem Timing
Optional DelayBeforeSendInitString=x UChar 0 to 255 cc, default is 150
Optional DelayDtrLow=x UChar 0 to 255 cc, default is 250
Optional DelayForWaitingResponse=x UChar 0 to 255 cc, default is 250
Optional DelayBeforePickupLine=x UChar 0 to 255 cc, default is 30
Optional DelayforRetryDial=x UChar 0 to 255 cc, default is 10
Optional DelayReceiveCall=x UChar 0 to 255 cc, default is 8
Optional MaximumDelayForSynchronization=x UChar 0 to 255 cc, default is 30
Optional DelayDcdOnReceiveCall=x UChar 0 to 255 cc, default is 30
Optional DelayDcdOnDial=x UChar 0 to 255 cc, default is 50
Optional DelayOfFirstSynchronizationByte=x UChar 0 to 255 cc, default is 8
Optional DelayBetweenSynchronizationBytes=x UChar 0 to 255 cc, default is 150
Optional DelayBeforeCallback=x UChar 0 to 255 cc, default is 4
Fast Setup Optional
Optional field, default is taken from
FastSetup 1 ReaderDriverName=x Str[40]
the server file DefCorReaDriver.DRV.
Optional (repeat for as many
Controllers (part of FastSetup)
controllers as needed)

80 DN1327-1004
 EntraPass SmartLink Reference Manual

Number: Controller number (1 to 32)

mandatory
Name: 40 char max, (optional), no “,”
allowed in the name,
default = “Controller #n”
ControllerItem= Number,Name,
FastSetup 2 SN: serial number, (optional), default
SN,SameDoor, Passback
is “00000000”
SameDoor: 0=No(default) 1=Yes (or
anything different to 0)
Passback: 0=None (default), 1=Soft,
2=Hard (optional)
FastSetup N ControllerItem=… as above As above for each controller added.

1
Parameters that can also be used for the FastSetup utility (as per the workstation).

Returned data :

Field Keyword & format Detail

See section 17: Returned Format
for format details. Most common returned values:
Result
See Appendix #1 for all returned 0= SMARTLINK_COMMAND_OK
codes.
Parameter1 SiteID=x Return the site ID reference number
X is the controller number, Y is the controller ID
Controller1 ControllerID=x,y
reference number field is optional.
This field repeats for as many controllers as defined
ControllerN ControllerID=n,y
(as above).

5.130 GetSite
This command gets the site of the system according to its reference number.

Field Keyword & format Detail

Command Command=GetSite
Parameter1 SiteID=x x is the site ID reference number

Returned data

Field Keyword & format Detail

See section 17: Returned
Format
Most common returned values:
Result for format details.
0 = SMARTLINK_COMMAND_OK (granted)
See Appendix #1 for all returned
codes.
Parameter2 HowManyController=x 0 to 32
Parameter N Same as for the optional parameter fields in section 79: AddSite (FastSetup)

5.131 ModifySite
This command modifies a site to the system according to its reference number.

DN1327-1004 81
 Field Keyword & format Detail
Command Command=ModifySite
Parameter1 SiteID=x x is the site ID reference number
Optional Same as for the optional parameter fields in section 79: AddSite (FastSetup)

Returned data

Field Keyword & format Detail

See section 17: Returned
Format
Most common returned values:
Result for format details.
0 = SMARTLINK_COMMAND_OK (granted)
See Appendix #1 for all returned
codes.

5.132 DeleteSite
This command deletes a site in the system according to its reference number.

Field Keyword & format Detail

Command Command
= DeleteSite
Parameter1 SiteID=x X is the site ID reference number

Returned data

Field Keyword & format Detail

See section 17: Returned
Format
Most common returned values:
Result for format details.
0 = SMARTLINK_COMMAND_OK (granted)
See Appendix #1 for all returned
codes.

5.133 AddController (ExpressSetup)

This command adds a controller in the system. It can create relay, input, door and output in the same
way as with the ExpressSetup utility (Advanced).

Field Keyword & format Type Detail

Command Command = AddController
Parameter1 SiteID=x x specifies the Site Reference
General
Field is optional, default is “New controller” (40
Optional PrimaryName=x Str[40]
characters max)
Field is optional, default is “New controller” (40
Optional SecondaryName=x Str[40]
characters max)
Optional Graphic=x Int Links to graphic ID
Optional VideoView=x Int Links to VideoView ID

82 DN1327-1004
 EntraPass SmartLink Reference Manual

0 = KT-200
1 = KT-300 (Default and the only one supported for
now)
Optional ControllerKtType=x UChar
2 = KT-100
3 = KT-NCC
4 = Unknown
0 = Controller enabled
Optional DisableController=x UChar
1 = Controller disabled
Name of the first reader type, the field is optional. If
Optional ReaderDriverName=x Str[40] nothing is provided, the default reader will be taken
from the server file DefCorReaDriver.DRV.
Name of the second reader type, the field is
optional. If nothing is provided, the default reader
Optional ReaderDriverName2=x Str[40]
will be taken from the server file
DefCorReaDriver.DRV.
0 = KP-1003H
1 = KP-500, KP-2000, KP-2500, KP-3000
Optional KeypadType=x UChar 2 = P555KP, KP-1000, SH-2KP, HID-PR5355KP
3 = POL-2KP 5 digits Integrated Keypad
4 = None
KT-300
Field is optional. If nothing is provided, the default
Optional SerialNumber=x Str[8]
is 00000000
Optional PowerFailureLocalActivation=x Int Links to relay
0 = No Call
Optional PowerFailurePriorityCall=x UChar 1 = Immediate call
2 = Scheduled call
Optional CombusFailureLocalActivation=x Int Links to relay
0 = No Call
Optional CombusFailurePriorityCall=x UChar 1 = Immediate call
2 = Scheduled call
CombusTroubleLocalActivation=
Optional Int Links to relay
x
0 = No Call
Optional CombusTroublePriorityCall=x UChar 1 = Immediate call
2 = Scheduled call
Optional WaitForSecondAccessCard=x UChar 1 to 127
0 = None
1 = 0 to 10 = 9,
Optional KeypadEscapeKey=x UChar
11 = *
12 = #
0 = No resistor
Optional InputResistorType=x Int
1 = Single resistor
Options
0 = No duress
Optional DuressOnAccessGranted=x UChar
1 = Duress
0 = No duress
Optional DuressOnAccessDenied=x UChar
1 = Duress
0 = None
Optional TypeAntiPassback=x UChar 1 = Soft anti-passback
2 = Hard anti-passback
Optional ForgiveSchedule=x Int Links to schedule
Optional EnableFailsoftDelay=x Int 10 to 255

DN1327-1004 83
 Optional CardFamily32Bits=x UChar 2 hexdigits
Optional MaximumCards=x Int 0 to 65535
Optional ActivateRelay=x Int Links to relay
Schedule
Optional PowerSupervisionSchedule=x Int Links to relay
Basic and
Express
Setup
0 = Don’t force all controller’s components (default)
Setup SelectAll=x UChar
1 = Force all controller’s components
Basic
Express Optional
Setup
Defines the components as per Express Setup.
This field is optional. Same as in Workstation.
ExpressSetup= SameDoor, SameDoor: 0=No (Default), 1 or non 0=Yes
Basic1 Door1Contact, Door1Rex, Door1Contact: 0=No (Default), 1 or non 0=Yes
Door2Contact, Door2Rex Door1Rex: 0=No (Default), 1 or non 0=Yes
Door2Contact : 0=No (Default), 1 or non 0=Yes
Door2Rex: 0=No (Default), 1 or non 0=Yes
Advanced
Express Optional
Setup
Defines the door as per Advanced Express Setup
This field is optional, repeat for as many doors.
Number: specifies the door (1 or 2)
PrimaryName: optional, 40 char max.
Door=number,PrimaryName,
SecondaryName: optional, 40 char max.
Advance SecondaryName,Type,Lock,
Type: 0=Access (default), 1=Entry, 2=Exit
Contact,RequestExit
Lock (device): 0=doorLock (default),
1=MagneticLock
Contact: 0=No, 1=Yes
RequestExit: 0=No, 1=Yes
Defines the input as per Advanced Express Setup
This field is optional, repeat for as many inputs.
Number: specifies the Input (1 to 8)
Input=Number,PrimaryName,
PrimaryName: optional, 40 char max.
Advance SecondaryName,State,
SecondaryName: optional, 40 char max.
MonitoringSchedule
State: optional, 0=Closed (default), 1=Opened
MonitoringSchedule: optional, specifies the
schedule ID, the default is always.
Defines the output as per Advanced Express Setup
This field is optional, repeat for as many outputs
Number: specifies the Output (1 to 4)
PrimaryName: optional, 40 char max.
Output=Number, PrimaryName,
Advance SecondaryName: optional, 40 char max.
SecondaryName, Mode, Door
Mode of operation (optional): 0=Normal (default),
1=Inversed
Door (optional): 0=Door#1 (default), 1=Door#2,
2=Door#1 & #2

84 DN1327-1004
 EntraPass SmartLink Reference Manual

Defines the relay as per Advanced Express Setup

This field is optional, repeat for as many relays.
Number: specifies the relay (1 to 2)
Relay=Number, Mode, Activation, PrimaryName: optional, 40 char max.
Advance
Disable SecondaryName: optional, 40 char max.
Mode: 0=Normal, 1=Reverse
Activation: Activation Schedule ID
Disable: Disable Relay Action Schedule ID

Returned data :

Field Keyword & format Detail

See section 17: Returned
Format
Most common returned values:
Result for format details.
0= SMARTLINK_COMMAND_OK
See Appendix #1 for all returned
codes.
Returns the newly created Controller ID reference
Parameter1 ControllerID=x
number.

5.134 GetController
This command gets the controller of the system according to its reference number.

Field Keyword & format Type Detail

Command Command=GetController
x is the Controller ID reference
Parameter1 ControllerID=x
number

Returned data

Field Keyword & format Detail

See section 17: Returned
Format
Most common returned values:
Result for format details.
0 = SMARTLINK_COMMAND_OK (granted)
See Appendix #1 for all returned
codes.
Parameter N Same as for the optional parameter fields in section 82: AddController (ExpressSetup)

5.135 ModifyController
This command modifies a controller in the system according to its reference number.

Field Keyword & format Detail

Command Command=ModifyController
Parameter1 ControllerID=x X is the site ID reference number
ParameterN Same as for the optional parameter fields in section 82: AddController (ExpressSetup)

Returned data

DN1327-1004 85
 Field Keyword & format Detail
See section 17: Returned
Format
Most common returned values:
Result for format details.
0 = SMARTLINK_COMMAND_OK (granted)
See Appendix #1 for all returned
codes.

5.136 DeleteController
This command deletes a controller in the system according to its reference number.

Field Keyword & format Detail

Command Command
= DeleteController
Parameter1 ControllerID=x X is the controller ID reference number

Returned data

Field Keyword & format Detail

See section 17: Returned
Format
Most common returned values:
Result for format details.
0 = SMARTLINK_COMMAND_OK (granted)
See Appendix #1 for all returned
codes.

5.137 GetDoor
This command gets a door from the system.

Field Keyword & format Type Detail

Command Comman =d GetDoor
Parameter DoorID=x Int x specifies the door reference

Returned data :

Field Keyword & format Type Detail

See section 17: Returned Format
Most common returned values:
Result for format details.
0= SMARTLINK_COMMAND_OK
See Appendix #1 for all returned codes.
General
Parameter PrimaryName=x Str[40] default is “New door” (40 char max)
Parameter SecondaryName=x Str[40] default is “New door” (40 char max)
0 = Fails-Secure
Parameter DoorLockMode=x UChar
1 = Fails-Safe
Parameter UnlockTime=x UShort 1 to 255
Parameter OpenTime=x UShort 1 to 255
0 = Access
Parameter DoorType=x UChar 1 = Entry
2 = Exit
0 = No Time and attendance 1 = Time
Parameter TimeAndAttendance=x UChar
and attendance

86 DN1327-1004
 EntraPass SmartLink Reference Manual

0 = No Elevator Cab
Parameter ElevatorCab=x UChar
1 = Elevator Cab
Parameter ExtendedUnlockTime=x UShort 1 to 255
Parameter ExtendedOpenTime=x UShort 1 to 255
Parameter UnlockSchedule=x Int Links to schedule
Parameter Graphic=x Int Links to graphic
Parameter VideoView=x Int Links to video view
Keypad
0 = Reader Only
Parameter ReaderKeypad=x UChar 1 = Keypad Only
2 = Reader and Keypad
Parameter ScheduleCardAndNip=x Int Links to schedule
Parameter RelayActivatedByPoudKey=x Int Links to relay
Parameter RelayActivatedByStarKey=x Int Links to relay
Contact
Parameter DoorContact=x Int Links to input
0 = No read
Parameter DoorOpenReading=x UChar
1 = Read
0 = No read
Parameter DoorUnlockReading=x UChar
1 = Read
0 = No Pre-alarm
Parameter PreAlarmOnDoorOpenTooLong=x UChar
1 = Pre-Alarm
0 = On Door Opening
Parameter OnAccessRelock=x UChar
1 = On Door Closing
Rex
0 = On Door Opening
Parameter OnRexRelock=x UChar
1 = On Door Closing
Parameter RexContact=x Int Links to input
Parameter RexSchedule=x Int Links to schedule
0 = No unlock
Parameter UnlockOnRex=x UChar
1 = Unlock
0 = No restart
Parameter ResettableRexFunction=x UChar
1 = Restart
Parameter SecondaryRexContact=x Int Links to input
Parameter SecondaryRexSchedule=x Int Links to schedule
0 = No unlock
Parameter SecondaryUnlockOnRex=x UChar
1 = Unlock
0 = No restart
Parameter SecondaryResettableRexFunction=x UChar
1 = Restart
Miscellaneous
Parameter InterlinkContact=x Int Links to input
0 = No duress
Parameter EnableDuressFunction=x UChar
1 = Duress
0 = Unlock,
Parameter NoUnlockByInputWhenArmed=x UChar
1 = No unlock
Parameter InterlockSchedule=x Int Links to schedule
Parameter SuspendReportDelayOnDoorRelock=x Int 4 to 255 sec.
Parameter ShuntInputs=x Int 0 to 0xffff
Elevator

DN1327-1004 87
 Parameter UnlockSchedule1=x Int Links to schedule
Parameter FloorsGroup1=x Int Links to floor group
Parameter UnlockSchedule2=x Int Links to schedule
Parameter FloorsGroup2=x Int Links to floor group
Options and alarm system
0 = Supervised
Parameter SuperviseDoorLockDevice=x UChar
1 = not supervised
0 = No unlock
Parameter UlockDoorBySchedulesAfterFirstManIn=x Int
1 = Unlock
Parameter MotorLockDelay=x UChar 0 to 255
Parameter RequireSecondCardSchedule=x Int Links to schedule
Door events
Parameter DoorForcedOpenLocalActivation=x Int Links to relay
0 = do not call
Parameter DoorForcedOpenPriorityCall=x UChar 1 = call Immediately
2 = call when scheduled
Parameter DoorOpenTooLongLocalActivation=x Int Links to relay
0 = do not call
Parameter DoorOpenTooLongPriorityCall=x UChar 1 = call Immediately
2 = call when scheduled
Parameter DoorAlarmOnRelockLocalActivation=x Int Links to relay
0 = do not call
Parameter DoorAlarmOnRelockPriorityCall=x UChar 1 = call Immediately
2 = call when scheduled
Access Events
Parameter AccessGrantedLocalActivation=x Int Links to relay
0 = do not call
Parameter AccessGrantedPriorityCall=x UChar 1 = call Immediately
2 = call when scheduled
Parameter CardTracedLocalActivation=x Int Links to relay
0 = do not call
Parameter CardTracedPriorityCall=x UChar 1 = call Immediately
2 = call when scheduled
Parameter InvalidCardStatusLocalActivation=x Int Links to relay
0 = do not call
Parameter InvalidCardStatusPriorityCall=x UChar 1 = call Immediately
2 = call when scheduled
Parameter BadAccessLevelLocalActivation=x Int Links to relay
0 = do not call
Parameter BadAccessLevelPriorityCall=x UChar 1 = call Immediately
2 = call when scheduled
Parameter OtherAccessDeniedLocalActivation=x Int Links to relay
0 = do not call
Parameter OtherAccessDeniedPriorityCall=x UChar 1 = call Immediately
2 = call when scheduled
Parameter DuressAlarmLocalActivation=x Int Links to relay
0 = do not call
Parameter DuressAlarmPriorityCall=x UChar 1 = call Immediately
2 = call when scheduled
ExtendedDoorAccessDelayLocalActivation=
Parameter Int Links to relay
x

88 DN1327-1004
 EntraPass SmartLink Reference Manual

0 = do not call
Parameter ExtendedDoorAccessDelayPriorityCall=x UChar 1 = call Immediately
2 = call when scheduled
Arming Request
Parameter ArmingRequestInput=x Int Links to input
0 = No wait
Parameter WaitForAccessGrantedToArm=x UChar
1 = Wait
0 = No relock
Parameter RelockDoorOnRequestToArm=x UChar
1 = Relock
0 = Arm
Parameter PreventArmingRequestOnInputStatus=x UChar
1 = Prevent arming
0 = none,
Parameter KeypadButton=x UChar 1=0 to 10=9,
11 = *, 12 = #
Parameter EnableArmingRequestSchedule=x Int Links to schedule
Links to Access level (single or group
Parameter ArmingAccessLevel=x Int
see IdAccesslevelArmRequest)
0 = No component link
Parameter SingleGroupArmRequest=x UChar 1 = Links to single component
2 = Links to group component
Parameter ExitDelay=x UShort 0 to 32767
Parameter EntryDelay=x UShort 0 to 32767
Parameter ExternalAlarmSystemPanel=x Int Links to input
Input
0 = Not supervised
Parameter Supervised=x UShort 1 = Supervised
(for each 16 inputs)
0 = No shunt
Parameter ShuntedOnDisarm=x Int 1 = Shunted
(for each 16 inputs)
0 = No shunt
Parameter ShuntedOnExit=x Int 1 = Shunt
(for each 16 inputs)
0 = unchecked, 1 = checked (for each
Parameter ShuntedOnDelay=x Int
16 inputs)
Postpone Arming
Parameter InputToPostponeArming=x Int Links to input
Parameter EnablePostponeArmingSchedule=x Int Links to schedule
0 = No wait
Parameter WaitForAccessGrantedToPospone=x UChar
1 = Wait
0 = none,
Parameter KeypadButtonPostpone=x UChar 1=0 to 10=9,
11 = *, 12 = #
Links to access level (see
Parameter PostponeOrDisarmAccessLevel=x Int
IdAccesslevelPostpone)
0 = No component link
Parameter SingleGroupAccessLevelPostpone=x UChar 1 = Links to single component
2 = Links to group component
Relay
Parameter AlarmRelay=x Int Links to relay
Relay activated
Parameter ActivationType=x UChar
Relay temporary activated

DN1327-1004 89
 0 = No call
Parameter PriorityCallType=x UChar 1 = Immediate call
2 = scheduled call
Parameter InputStatus=x Int Links to relay
0 = No work
Parameter WorkWhenSystemArmed=x UChar
1 = Work
Parameter ArmingAlarmPanel=x Int Links to relay
Parameter PostponeAlarmPanel=x Int Links to relay
Parameter DisarmingAlarmPanel=x Int Links to relay
Parameter SystemArmed=x Int Links to relay
No call
Parameter PriorityCallTypeArm=x UChar Immediate call
scheduled call

5.138 ModifyDoor
This command modifies a controller in the system according to its reference number.

Field Keyword & format Detail

Command Command=ModifyDoor
Parameter DoorID=x x specifies the door reference
Parameter Same as for the parameter fields within the return section 86: GetDoor

Returned data

Field Keyword & format Detail

See section 17: Returned
Format
Most common returned values:
Result for format details.
0 = SMARTLINK_COMMAND_OK (granted)
See Appendix #1 for all returned
codes.

5.139 DeleteDoor
This command deletes a door in the system according to its reference number.

Field Keyword & format Detail

Command Command
= DeleteDoor
Parameter1 DoorID=x x is the door ID reference number

5.140 GetRelay
This command gets a relay from the system.

Field Keyword & format Detail

Command Comman =d GetRelay
Parameter RelayID=x x specifies the relay reference number

Returned data :

90 DN1327-1004
 EntraPass SmartLink Reference Manual

Field Keyword & format Type Detail

See section 17: Returned
Format
Most common returned values:
Result for format details.
0= SMARTLINK_COMMAND_OK
See Appendix #1 for all returned
codes.
Parameter PrimaryName=x Str[40] default is “New relay” (40 char max)
Parameter SecondaryName=x Str[40] default is “New relay” (40 char max)
0 = Normal
Parameter OperationMode=x UChar
1 = Inverse
Parameter ActivationSchedule=x Int Links to schedule
Parameter TempoActivationTimer=x Int 1 to 255
Parameter DeactivationSchedule=x Int Links to schedule

5.141 ModifyRelay
This command modifies a relay in the system according to its reference number.

Field Keyword & format Detail

Command Command=ModifyRelay
Parameter RelayID=x x is the relay ID reference number
Parameter Same as for the parameter fields in the return section 86: GetDoor

Returned data

Field Keyword & format Detail

See section 17: Returned
Format
Most common returned values:
Result for format details.
0 = SMARTLINK_COMMAND_OK (granted)
See Appendix #1 for all returned
codes.

5.142 DeleteRelay
This command deletes a relay in the system according to its reference number.

Field Keyword & format Detail

Command Command
= DeleteRelay
Parameter1 RelayID=x x is the relay ID reference number

5.143 GetInput
This command gets an input from the system.

Field Keyword & format Detail

Command Comman =d GetInput
Parameter1 InputID=x x specifies the input reference

Returned data :

DN1327-1004 91
 Field Keyword & format Type Detail
See section 17: Returned
Format
Most common returned values:
Result for format details.
0= SMARTLINK_COMMAND_OK
See Appendix #1 for all returned
codes.
Parameter PrimaryName=x Str[40] default is “New Input” (40 char max)
Parameter SecondaryName=x Str[40] default is “New Input” (40 char max)
Parameter MonitoringSchedule=x Int Links to schedule
Parameter NormalCondition=x UChar 0 = Closed, 1 = Opened
Parameter AlarmResponseTime=x Int 10 to 65535
Parameter RestoreResponseTime=x Int 10 to 65535
Relay and Input
Links to Relay (single or group, see
Parameter ActivateRelay=x Int
IdInputActivateRelay)
0 = No component link
Parameter SingleGroupRelay=x UChar 1 = Links to single component
2 = Links to group component
0 = No activation
Parameter ActivateRelayTemporarily=x UChar
1 = Activation
Parameter KeepRelayActivated=x Int 0 to 65535
Parameter TemoraryShuntTimer=x Int 0 to 32767
Links to input (single or group see
Parameter ShuntInput=x Int
IdInputShuntInput)
0 = None component link
Parameter SingleGroupInput=x UChar 1 = Links to single component
2 = Links to group component
0 = No shunt
Parameter ShuntInputTemporarily=x UChar
1 = Shunt
ResetDelayForShuntTemporarily= 0 = No reset
Parameter UChar
x 1 = Reset
Parameter DelayBeforeUnshunt=x UShort 0 to 32767
Elevator
0 = No Selection
1 = Cab #1
Parameter SelectCab=x UChar
2 = Cab #2
3 = Cab #1 and Cab #2
Parameter FloorsGroup=x Int Links to floor group
Parameter EnableSchedule=x Int Links to schedule
Input Event
Parameter InputInAlarmLocalActivation=x Int
0 = do not call
Parameter InputInAlarmPriorityCall=x UChar 1 = call Immediately
2 = call when scheduled

5.144 ModifyInput
This command modifies an input in the system according to its reference number.

92 DN1327-1004
 EntraPass SmartLink Reference Manual

Field Keyword & format Detail

Command Command=ModifyInput
Parameter InputID=x x is the Input ID reference number
Parameter Same as for the parameter fields within the return section 91: GetInput

Returned data

Field Keyword & format Detail

See section 17: Returned
Format
Most common returned values:
Result for format details.
0 = SMARTLINK_COMMAND_OK (granted)
See Appendix #1 for all returned
codes.

5.145 DeleteInput
This command deletes an input in the system according to its reference number.

Field Keyword & format Detail

Command Command
= DeleteInput
Parameter1 InputID=x x is the input ID reference number

5.146 GetOutput
This command gets an output from the system.

Field Keyword & format Detail

Command Comman =d GetOutput
Parameter1 OutputID=x x specifies the output reference

Returned data :

Field Keyword & format Type Detail

See section 17: Returned
Format
Most common returned values:
Result for format details.
0= SMARTLINK_COMMAND_OK
See Appendix #1 for all returned
codes.
default is “New Output” (40 char
Parameter PrimaryName Str[40]
max)
default is “New Output” (40 char
Parameter SecondaryName Str[40]
max)
0 = Normal
Parameter OperationMode UChar
1 = Inverse
0 = Door #1
Parameter SelectedDoor UChar 1 = Door #2
2 = Door #1 and Door #2
Parameter ActivationPeriod UChar 1 to 255

DN1327-1004 93
 x is the event number(0 to31), repeat
for each event
y is the event status:
0 = None
Parameter Event=x,y UChar[32]
1 = Steady Timed
2 = Flash Timed
3 = Steady
4 = Flash

5.147 ModifyOutput
This command modifies an output in the system according to its reference number.

Field Keyword & format Detail

Command Command=ModifyOutput
Parameter OutputID=x x is the Output ID reference number
Parameter Same as for the parameter fields within the return section 93: GetOutput

Returned data

Field Keyword & format Detail

See section 17: Returned
Format
Most common returned values:
Result for format details.
0 = SMARTLINK_COMMAND_OK (granted)
See Appendix #1 for all returned
codes.

5.148 DeleteOutput
This command deletes an output in the system according to its reference number.

Field Keyword & format Detail

Command Command
= DeleteOutput
Parameter1 OutputID=x x is the Output ID reference number

5.149 GetSiteStructure
This command returns the structure of all co mponents unde r a sp ecified site. Each co mponent is
described by it s Referen ce n umber ID , its rank and its st atus that determine i f the compo nent is
defined or not within the system.

Field Keyword & format Detail

Command Command
= GetSiteS tructure
Parameter1
= SiteId x X is the requested site ID

Returned data :

94 DN1327-1004
 EntraPass SmartLink Reference Manual

Field Keyword & format Detail

See section 17: Returned Format
for format details. Most common returned values:
Result
See Appendix #1 for all returned 0= SMARTLINK_COMMAND_OK
codes.
For each controller this block
Repeats for as many controllers
repeats
ControllerId=x,y,z Controller=rank, y=ID, z=defined (0 or 1)
Door: x=rank, y=ID, z=defined
DoorId=x,y,z
Does repeat for as many doors
Door: x=rank, y=ID, z=defined
RelayId=x,y,z
Does repeat for as many relays
Door: x=rank, y=ID, z=defined
InputId=x,y,z
Does repeat for as many inputs
Door: x=rank, y=ID, z=defined
OutputId=x,y,z
Does repeat for as many outputs
Holidays (outside previous
controller block)
Holiday: y=ID, z=defined
HolidayId=y,z
Does repeat for as many holidays
Schedule
Schedule: y=ID, z=defined
ScheduleId=y,z
Does repeat for as many schedules
Access Level
Access Level: y=ID, z=defined
AccessLevelId=y,z
Does repeat for as many access levels

Eventually could be added: Flo orId, Con trollerGroupId, DoorGroupId, Inpu tGroupID, Re layGroupId,
FloorGroupId, AccessLevelGroupId

5.150 GetSiteCard
This command retrieves all cards from a specific site.

Field Keyword & format Detail

Command Command=GetSiteCard
Parameter1 SiteID=x x is the site ID reference number

Returned data

Field Keyword & format Detail

See section 17: Returned
Format
Most common returned values:
Result for format details.
0 = SMARTLINK_COMMAND_OK (granted)
See Appendix #1 for all returned
codes.
TBD…

5.151 AddAccount
This command adds an account in the system.

DN1327-1004 95
 Field Keyword & format Detail
Command Command = AddAccount
Parameter1 GatewayID=x x specifies the gateway reference ID
Parameter2 PrimaryName=x default = “New account” (40 digits max), field is optional
Parameter3 SecondaryName = x default = “New account” (40 digits max), field is optional
Parameter4 Info1 = x Default is empty, field is optional, 50 digits max.
Parameter5 Info2 = x Default is empty, field is optional, 50 digits max.
Parameter6 Info3 = x Default is empty, field is optional, 50 digits max.
Parameter7 Info4 = x Default is empty, field is optional, 50 digits max.
Parameter8 Info5 = x Default is empty, field is optional, 50 digits max.
Parameter9 Info6 = x Default is empty, field is optional, 50 digits max.
Parameter10 Info7 = x Default is empty, field is optional, 50 digits max.
Parameter11 Info8 = x Default is empty, field is optional, 50 digits max.
Parameter12 Info9 = x Default is empty, field is optional, 50 digits max.
Parameter13 Info10 = x Default is empty, field is optional, 50 digits max.
Parameter14 Info11 = x Default is empty, field is optional, 50 digits max.
Parameter15 Info12 = x Default is empty, field is optional, 50 digits max.
Parameter16 Info13 = x Default is empty, field is optional, 50 digits max.
Parameter17 Info14 = x Default is empty, field is optional, 50 digits max.
Parameter18 Info15 = x Default is empty, field is optional, 50 digits max.
Parameter19 Info16 = x Default is empty, field is optional, 50 digits max.
Parameter20 Info17 = x Default is empty, field is optional, 50 digits max.
Parameter21 Info18 = x Default is empty, field is optional, 50 digits max.
Parameter22 Info19 = x Default is empty, field is optional, 50 digits max.
Parameter23 Info20 = x Default is empty, field is optional, 50 digits max.
Parameter24 Comment = x Default is empty, field is optional, 255 digits max.

Returned data :

Field Keyword & format Detail

See section 17: Returned
Format
Most common returned values:
Result for format details.
0= SMARTLINK_COMMAND_OK
See Appendix #1 for all returned
codes.
Parameter1 AccountID=x Return the Account ID reference number

5.152 GetAccount
This command gets an account from the system according to its reference number.

Field Keyword & format Detail

Command Command=GetAccount
Parameter1 AccoutID=x x is the account ID reference number

Returned data

96 DN1327-1004
 EntraPass SmartLink Reference Manual

Field Keyword & format Detail

See section 17: Returned
Format
Most common returned values:
Result for format details.
0 = SMARTLINK_COMMAND_OK (granted)
See Appendix #1 for all returned
codes.
Parameter1 AccountID=x Return the account ID reference number
Parameter 2 to
Same as for parameter fields in section 95: AddAccount
Parameter 24

5.153 ModifyAccount
This command modifies an account in the system according to its reference number.

Field Keyword & format Detail

Command Command=ModifyAccount
Parameter1 AccountID=x x is the account ID reference number
Parameter 2 to
Same as for parameter fields in section 95: AddAccount
Parameter 24

Returned data

Field Keyword & format Detail

See section 17: Returned
Format
Most common returned values:
Result for format details.
0 = SMARTLINK_COMMAND_OK (granted)
See Appendix #1 for all returned
codes.

5.154 DeleteAccount
This command deletes an account in the system according to its reference number.

Field Keyword & format Detail

Command Command
= DeleteSite
Parameter1 AccountID=x x is the account ID reference number

Returned data

Field Keyword & format Detail

See section 17: Returned
Format
Most common returned values:
Result for format details.
0 = SMARTLINK_COMMAND_OK (granted)
See Appendix #1 for all returned
codes.

5.155 SwitchAccount
This comma nd all ows accessi ng componen ts visi ble o nly from an op erator account wi th th e
appropriate rights.

DN1327-1004 97
 Field Keyword & format Detail
Command Command
= SwitchSite
x is the account ID reference number. A value of zero
Parameter1 AccountID=x forces a logout of the account. Note that logging out of
SmartLink automatically logout from the account.

Returned data

Field Keyword & format Detail

See section 17: Returned
Format
Most common returned values:
Result for format details.
0 = SMARTLINK_COMMAND_OK (granted)
See Appendix #1 for all returned
codes.

98 DN1327-1004
 EntraPass SmartLink Reference Manual

6.0 - SmartDll
This DLL allows connecting to SmartLink in ord er to execute various commands and also to receive
messages programmed in the software.

SmartTest.exe is a software used to test the DLL’s functionalities.

Here is a list of the available functions :

Function Description
This function is used to establish communication
between the SmartDll and SmartLink. Once completed,
the DLL will perform an optimized poll of SmartLink to
pick the messages intended for the connection
• theSmartlinkTag : Connection identifier from 0 to
extern "C" __declspec(dllexport) long __stdcall
65000. This identifier is important for programmed
Connect (long theSmartlinkTag, char* theIpAddress)
messages that need to be sent on a specific
connection. Otherwise, this number is useless. Note
that only one occurence of the number will be
allowed
• theIpAddress : SmartLink ’s IP address
Used with ‘SetLoginPassword’, this function indicates
extern "C" __declspec(dllexport) long __stdcall to the DLL to take care of all the connection aspects
AutomaticConnect (long theSmartlinkTag, char* and the authentication to the server. The
theIpAddress) ‘SetLoginPassword’ function will process the usual
authentication command.
extern "C" __declspec(dllexport) long __stdcall This function disconnect the link between the DLL and
Disconnect () SmartLink and ends the requesting process
This function is used to send commands to SmartLink
and also to receive informations. A list of commands is
available in section...
• theLengthSend: Length of the information to be sent
• theBufferSend: Pointer on a memory space that
extern "C" __declspec(dllexport) long __stdcall contains the command to be sent
SendData (long theLengthSend, unsigned char* • theLengthReceive: Receiving space length. Upon
theBufferSend, long* theLengthReceive, unsigned completion, the system will indicate the number of
char* theBufferReceive) characters received.
• theBufferReceive: Pointer on a memory space that
receives information. If the memory space is
unsufficient, the system will return the following error
message:
SMARTLINK_INVALID_OUTPUT_LENGTH.

DN1327-1004 99
 Function Description
This function is used to send a command to SmartLink
by including a picture. It can also receive informations. A
list of commands is available in section...
• theLengthSend: Length of the information to be sent
• theBufferSend: Pointer on a memory space that
contains to command to be sent
extern "C" __declspec(dllexport) long __stdcall • theLengthReceive: Receiving space length. Upon
SendDataPicture (long theLengthSend, unsigned completion, the system will indicate the number of
char* theBufferSend, long* theLengthReceive, characters received
unsigned char* theBufferReceive, char* thePicture) • theBufferReceive: Pointer on a memory space that
receives information. If the memory space is
unsufficient, the system will return the following error
message:
SMARTLINK_INVALID_OUTPUT_LENGTH
• thePicture: Name of the file that contains the picture
to be sent
extern "C" __declspec(dllexport) long __stdcall
ShowWorkstation (long* theNTM)
extern "C" __declspec(dllexport) long __stdcall
ShowGateway (long* theGSI)
extern "C" __declspec(dllexport) long __stdcall
ShowSite (long* theSite)
extern "C" __declspec(dllexport) long __stdcall
ShowController (long* theController)
extern "C" __declspec(dllexport) long __stdcall
ShowControllerGroup (long* theControllerGroup)
extern "C" __declspec(dllexport) long __stdcall
ShowDoor (long* theDoor)
extern "C" __declspec(dllexport) long __stdcall
ShowDoorGroup (long* theDoorGroup)
extern "C" __declspec(dllexport) long __stdcall
ShowRelay (long* theRelay)
extern "C" __declspec(dllexport) long __stdcall
ShowRelayGroup (long* theRelayGroup)
extern "C" __declspec(dllexport) long __stdcall
ShowInput (long* theInput)
extern "C" __declspec(dllexport) long __stdcall
ShowInputGroup (long* theInputGroup)
extern "C" __declspec(dllexport) long __stdcall
ShowOutput (long* theOutput)
extern "C" __declspec(dllexport) long __stdcall
ShowFloor (long* theFloor)
extern "C" __declspec(dllexport) long __stdcall
ShowFloorGroup (long* theFloorGroup)
extern "C" __declspec(dllexport) long __stdcall
ShowSchedule (long* theSchedule)
extern "C" __declspec(dllexport) long __stdcall
ShowOperator (long* theOperator)
extern "C" __declspec(dllexport) long __stdcall
ShowSecurityLevel (long* theSecurityLevel)
extern "C" __declspec(dllexport) long __stdcall
ShowCardAccessGroup (long* theCardAccessGroup)

100 DN1327-1004
 EntraPass SmartLink Reference Manual

Function Description
extern "C" __declspec(dllexport) long __stdcall
ShowCardType (long* theCardType)
extern "C" __declspec(dllexport) long __stdcall
ShowBadging (long* theBadging)
extern "C" __declspec(dllexport) long __stdcall
ShowAlarmSystem (long* theAlarmSystem)
extern "C" __declspec(dllexport) long __stdcall
ShowArea (long* theArea)
extern "C" __declspec(dllexport) long __stdcall
ShowGuardTour (long* theGuardTour)
extern "C" __declspec(dllexport) long __stdcall
ShowGraphic (long* theGraphic)
extern "C" __declspec(dllexport) long __stdcall
ShowVideoServer (long* theVideoServer)
extern "C" __declspec(dllexport) long __stdcall
ShowCamera (long* theCamera)
extern "C" __declspec(dllexport) long __stdcall
ShowReport (long* theReport)
extern "C" __declspec(dllexport) long __stdcall
ShowAccessLevel (long* theAccessLevel)
extern "C" __declspec(dllexport) long __stdcall
ShowHoliday (long* theHoliday)
extern "C" __declspec(dllexport) long __stdcall
ShowWorkspace (long* theHoliday)
extern "C" __declspec(dllexport) long __stdcall
ShowMusterReport (long* theMusterReport)
extern "C" __declspec(dllexport) long __stdcall
ShowAreaGroup (long* theAreaGroup)
extern "C" __declspec(dllexport) long __stdcall
ShowTaskBuilder (long* theTaskBuilder)
extern "C" __declspec(dllexport) long __stdcall
ShowTrigger (long* theTrigger)
extern "C" __declspec(dllexport) long __stdcall
ShowPanel (long* thePanel)
extern "C" __declspec(dllexport) long __stdcall
ShowPanelComponent (long* thePanelComponent)

The list of above-mentioned functions allow viewing the list of components for a specific type. This list
will be also determined according to parameters that qualify the identified operator. It will be displayed

DN1327-1004 101
 in a visibl e page and the returned parameter will be the selected item in the list. This parameter will
allow for the selected component’s ’UniqueID’ to be returned.

Function Description
• theSize: Receiving space length. Upon completion, the system
will indicate the number of characters received
• theCard: Pointer on a memory space that receives information. If
the memory space is insufficient, the system will return the
following error message:
extern "C" __declspec(dllexport) long SMARTLINK_INVALID_OUTPUT_LENGTH
__stdcall ShowCard (long theSize, char* • theSource: Characters string used as a filter. The desired value
theCard, char* theSource, long theIndex) should begin with the characters string
• theIndex: The search index
• 0: ser U name
• 1 to10: Configurable fields
This function can retreive the data of a card and save it in a file
• theFileName: Name of the file that contains the results.
extern "C" __declspec(dllexport) long • theIndex: The search index
__stdcall ShowAllCard (char*
• 0: serU name
theFileName, long theIndex)
• 1 to10: Configurable fields
extern "C" __declspec(dllexport) long
Function that returns the DLL version number
__stdcall About ()
• theLength: Receiving space length
extern "C" __declspec(dllexport) long • theMessageLength : Received message length
__stdcall GetMessageData (long • theMessage: Pointer on a memory space that receives
theLength, long* theMessageLength, information. If the memory space is insufficient, the system will
unsigned char* theMessage) return the following error message:
SMARTLINK_INVALID_OUTPUT_LENGTH

102 DN1327-1004
 EntraPass SmartLink Reference Manual

Function Description
• theWnd : Handle of the window that receives messages
• theMsg : Message content
This function saves the window that receives ‘PostMessage’ sent by
extern "C" __declspec(dllexport) long the DLL and gives the number used. During a modification, saving
__stdcall SetPostMessage ( messages allows the automatic reception of the following information:
long theWnd,
• The communication status between the Server and SmartLink
long theMsg)
• The communication status between the DLL and SmartLink
• Operator’s current login/logout connection status
• A new message is available
extern "C" __declspec(dllexport) long
This function can save a login command so the system can reuse it
__stdcall SetLoginPassword (long
automatically in case of a disconnection. Note that the initial
theCommandLength, unsigned char*
connection must be performed with the ‘AutomaticConnect’ command
theCommand)
extern "C" __declspec(dllexport) long
During the development phase, the function ‘EnableViewActivity’ can
__stdcall EnableViewActivity ()
be called to display a window showing the internal process details for
the commands sent. The function ‘DisableViewActivity’ will stop the
extern "C" __declspec(dllexport) long
process
__stdcall DisableViewActivity ()
• theErrorCode : Error code number
• theTextLength : Length of the characters string that holds the
extern "C" __declspec(dllexport) long
error code.
__stdcall GetErrorCodeText (long
theErrorCode, long theTextLength, • theText : Characters string into which the error message text is
unsigned char* theText) copied.
This function is used to receive the text corresponding to a specific
error code
extern "C" __declspec(dllexport) long
__stdcall GetServerState ()
These three functions return the SmartLink status with the server, the
link status between the DLL and SmartLink, and the operator’s
extern "C" __declspec(dllexport) long
identification status. The value 0 indicates an abnormal condition
__stdcall GetSmartLinkState ()
while the value 1 indicates either a normal condition or the operator is
properly identified with the server
extern "C" __declspec(dllexport) long
__stdcall GetLoginState ();
extern "C" __declspec(dllexport) long This function is used to give a name to the connection with SmartLink.
__stdcall SetConnectionName (char* The connection name can be viewed by scrolling the user’s list
theName, long theSize) connected to SmartLink or to a workstation
This function is used to determine the maximum number of messages
extern "C" __declspec(dllexport) long
currently held by SmartLink. There are two types of messages:
__stdcall SetBuffersSize (long
’Untag’ messages’ that identify messages not specifically intended for
theUntagBufferSize, long
‘TagConnection’ and ‘Tag’/’Untag’ that identify messages specifically
theTagBufferSize)
intended for the connection
This function is used to save the next list request in a file. For
example, to place the list of operators in a file, name the file, give a
extern "C" __declspec(dllexport) long value for the field separator and call the ShowOperator function:
__stdcall SetListName (char* theName, • theName : Name of the file to be saved
long theSize, long theSeparator) • theSize : Length of the theName field
• theSeparator : The character used as a field separator. Usually 9
for <Tab> or 44 for a comma

DN1327-1004 103
 Function Description
This function retrieves the description of a selected component.
• theDescriptionSize : The theDescription field length. Returns the
extern "C" __declspec(dllexport) long
content length of the field
__stdcall GetComponentDescription
(long* theDescriptionSize, char* • theDescription : Pointer that receives the description of the
theDescription, long* theComponent) selected component
• theComponent : This variable receives the ‘UniqueID’ of the
selected component
extern "C" __declspec(dllexport) long
__stdcall HardResetController (long
theComponent)
extern "C" __declspec(dllexport) long
__stdcall SoftResetController (long
theComponent)
extern "C" __declspec(dllexport) long
__stdcall ForgiveController (long
theComponent)
extern "C" __declspec(dllexport) long
__stdcall ReloadController (long
theComponent)
extern "C" __declspec(dllexport) long
__stdcall LockDoor (long theComponent)
extern "C" __declspec(dllexport) long
__stdcall UnlockDoor (long
theComponent)
extern "C" __declspec(dllexport) long
__stdcall UnlockDoorTempo (long
theComponent, long theDelay)
extern "C" __declspec(dllexport) long
__stdcall ReturnToScheduleDoor (long
theComponent)
extern "C" __declspec(dllexport) long
__stdcall DoorToggleStrike (long
theComponent)
extern "C" __declspec(dllexport) long
__stdcall UnshuntInput (long
theComponent)
extern "C" __declspec(dllexport) long
__stdcall ShuntInput (long
theComponent)
extern "C" __declspec(dllexport) long
__stdcall ShuntInputTempo (long
theComponent, long theDelay)
extern "C" __declspec(dllexport) long
__stdcall ContinuousSuperviseInput
(long theComponent)
extern "C" __declspec(dllexport) long
__stdcall ReturnToScheduleInput (long
theComponent)
extern "C" __declspec(dllexport) long
__stdcall InputToggleShunt (long
theComponent)
extern "C" __declspec(dllexport) long
__stdcall DeactivateRelay (long
theComponent)

104 DN1327-1004
 EntraPass SmartLink Reference Manual

Function Description
extern "C" __declspec(dllexport) long
__stdcall ActivateRelay (long
theComponent)
extern "C" __declspec(dllexport) long
__stdcall ActivateRelayTempo (long
theComponent, long theDelay)
extern "C" __declspec(dllexport) long
__stdcall ReturnToScheduleRelay (long
theComponent)
extern "C" __declspec(dllexport) long
__stdcall AlarmSystemArm (long
theComponent)
extern "C" __declspec(dllexport) long
__stdcall AlarmSystemDisarm (long
theComponent)
extern "C" __declspec(dllexport) long
__stdcall AlarmSystemPostpone (long
theComponent, long theDelay)
extern "C" __declspec(dllexport) long
__stdcall MoveCardFromToArea (long
theComponent, long theComponentTo)
extern "C" __declspec(dllexport) long
__stdcall GetCardFromArea (long
theComponent, long* theLengthReceive,
unsigned char* theBufferReceive)
extern "C" __declspec(dllexport) long
__stdcall ConnectRemoteSite (long
theComponent)
extern "C" __declspec(dllexport) long
__stdcall DisconnectRemoteSite (long
theComponent)
extern "C" __declspec(dllexport) long
__stdcall UpdateRemoteSite (long
theComponent)
extern "C" __declspec(dllexport) long
__stdcall UpdateRemoteSiteGateway
(long theComponent)
extern "C" __declspec(dllexport) long
__stdcall UpdateAllSite ()
extern "C" __declspec(dllexport) long
__stdcall ExecuteTask (long
theComponent)

These fu nctions are used to e xecute specific t asks on a specific co mponent e asily. However, for al l
these commands, you can always use the ’SendData’ function.

DN1327-1004 105
 Function Description
extern "C" __declspec(dllexport) long
__stdcall WorkstationStatus (long
theComponent, long* theLengthReceive,
unsigned char* theBufferReceive)
extern "C" __declspec(dllexport) long
__stdcall GatewayStatus (long
theComponent, long* theLengthReceive,
unsigned char* theBufferReceive)
extern "C" __declspec(dllexport) long
__stdcall SiteStatus (long
theComponent, long* theLengthReceive,
unsigned char* theBufferReceive)
extern "C" __declspec(dllexport) long
__stdcall ControllerStatus (long
theComponent, long* theLengthReceive,
unsigned char* theBufferReceive)
extern "C" __declspec(dllexport) long
__stdcall DoorStatus (long
theComponent, long* theLengthReceive,
unsigned char* theBufferReceive) These functions are used to retrieve the status of a specific
extern "C" __declspec(dllexport) long component easily. However, for all these commands, you can
__stdcall DoorStatus (long always use the ’SendData’ function.
theComponent, long* theLengthReceive, • theComponent: ‘UniqueId’ of the component for which the status
unsigned char* theBufferReceive) has to be retreive.
extern "C" __declspec(dllexport) long • theLengthReceive: Length of the variable that holds the
__stdcall RelayStatus (long information. The variable contains the number of characters
theComponent, long* theLengthReceive, received
unsigned char* theBufferReceive) • theBufferReceive: Pointer on a variable into which the received
extern "C" __declspec(dllexport) long data is placed
__stdcall InputStatus (long
theComponent, long* theLengthReceive,
unsigned char* theBufferReceive)
extern "C" __declspec(dllexport) long
__stdcall OutputStatus (long
theComponent, long* theLengthReceive,
unsigned char* theBufferReceive)
extern "C" __declspec(dllexport) long
__stdcall AreaStatus (long
theComponent, long* theLengthReceive,
unsigned char* theBufferReceive)
extern "C" __declspec(dllexport) long
__stdcall AlarmSystemStatus (long
theComponent, long* theLengthReceive,
unsigned char* theBufferReceive)
extern "C" __declspec(dllexport) long
__stdcall GuardTourStatus (long
theComponent, long* theLengthReceive,
unsigned char* theBufferReceive)

106 DN1327-1004
 EntraPass SmartLink Reference Manual

Function Description
This method allows you to determine the location of the physical
address of a component. For example, if you ask for the description of
door 2 of the third controller in loop 4, you will get:
• Left: (04.02.2) Entry door
extern "C" __declspec(dllexport) long • Right: Entry door (04.02.2)
__stdcall SetPhysicalAddressId (long • None: Entry door
theParameter)
The Parameter: Possible values are:
• SMARTLINK_PHYSICAL_ADDRESS_LEFT = 0
• SMARTLINK_PHYSICAL_ADDRESS_RIGHT = 1
• SMARTLINK_NO_PHYSICAL_ADDRESS = 2
This function is used to determine the maximum waiting delay of a
response per category of process in thousands of seconds.

theTimeout: Below is a list of categories. Between parenthesis are the

default value followed by the maximum possible value.
• TIMEOUT_START_SMARTLINK = 0 (15000, 5000)
• TIMEOUT_STOP_SMARTLINK = 1 (5000, 5000)
extern "C" __declspec(dllexport) long
__stdcall SetTimeout (long theTimeout, • TIMEOUT_SEND_DATA = 2 ( 15000, 5000)
long theDelay) • TIMEOUT_LIST_ELEMENT = 3 (40000, 10000)
• TIMEOUT_NEXT_PREVIOUS = 4 (40000, 10000)
• TIMEOUT_READ_MESSAGE = 5 ( 10000, 5000)
• TIMEOUT_CHECK_MESSAGE = 6 ( 10000, 10000)
• TIMEOUT_GET_PARAMETERS = 7 (10000, 5000)
• TIMEOUT_SET_PARAMETERS = 8 (10000, 5000)
• TIMEOUT_PREPARE_TO_STOP = 9 (5000, 5000)
extern "C" __declspec(dllexport) long
Not currently used
__stdcall GetRequestCount ()
This function builds the characters string used to login with the
opertor’s identifier and password.
extern "C" __declspec(dllexport) long • theUserName: Operator’s identifier
__stdcall BuildLoginPassword (char*
• thePassword: Password
theUserName, char* thePassword, long
theSize, long* theResultLength, char* • theSize: Length of the characters string for the command’s result
theResult) • theResultLength: Length of the characters string result
• theResult: Characters string that contains the command used to
login into the system
This command is used to add an item to an existing trigger
• theTriggerId: ‘UniqueId’ that identifies the trigger
extern "C" __declspec(dllexport) long • theComponentId: This field gives the ‘UniqueId’ of the component
__stdcall AddComponentToTrigger (long to be added to a trigger
theTriggerId, long theComponentId, long
• theParameter1: Parameter 1 corresponding to the component
theParameter1, long theParameter2,
long* theResultLength, char* theResult) • theParameter2: Parameter 2 corresponding to the component
• theResultLength: Length of the result field
• theResult: Field that contains the command’s result
This command is used to remove an item from an existing trigger.
extern "C" __declspec(dllexport) long • theTriggerId: ‘UniqueId’ that identifies the trigger
__stdcall
• theComponentId: This field gives the ‘UniqueId’ of the component
RemoveComponentFromTrigger (long
to be removed from a trigger
theTriggerId, long theComponentId,
long* theResultLength, char* theResult) • theResultLength: Lengthof the result field
• theResult: Field that contains the command’s result

DN1327-1004 107
7.0 - Appendix #1, Error messages
The following error returned codes are defined within the SmartDll.h file.

Error Code Error Message Description

0 SMARTLINK_COMMAND_OK command successful
1 SMARTLINK_NOT_CONNECTED
2 SMARTLINK_ALREADY_CONNECTED
3 SMARTLINK_INVALID_INPUT_POINTER
4 SMARTLINK_INVALID_OUTPUT_POINTER
5 SMARTLINK_INVALID_INPUT_LENGTH
6 SMARTLINK_INVALID_OUTPUT_LENGTH
7 SMARTLINK_RETURNVALUE_TOO_LONG
8 SMARTLINK_PICTURE_NOT_FOUND
9 SMARTLINK_NO_IPADDRESS_DEFINED
10 SMARTLINK_NOT_LOGIN Operator must be connected first.
11 SMARTLINK_EMPTY_LIST
12 SMARTLINK_NETWORK_ERROR
13 SMARTLINK_NO_SERVER_CONNECTION
14 SMARTLINK_COMMAND_CANCEL
15 SMARTLINK_INCOMPATIBLE_VERSION
16 SMARTLINK_NOT_ENOUGH_SPACE
17 SMARTLINK_NO_MESSAGE_AVAILABLE
18 SMARTLINK_SERVER_NOT_READY
19 SMARTLINK_COMMANDS_PROCESS_DENIED
20 SMARTLINK_MESSAGES_PROCESS_DENIED
21 SMARTLINK_ERROR_PROCEED_NETWORK
22 SMARTLINK_NETWORK_TAG_ALREADY_EXIST
23 SMARTLINK_INTERNAL_DIALOG_ERROR
24 SMARTLINK_NETWORK_UNKNOWN_ERROR
25 SMARTLINK_ERROR_TCPIP_CONNECTION
26 SMARTLINK_NOT_ABLE_TO_CONNECTION
27 SMARTLINK_UNEXPECTED_ERROR
28 SMARTLINK_INVALID_CHANNEL_VALUE
29 SMARTLINK_INVALID_TAG
30 SMARTLINK_ACTIVITY_ALREADY_ENABLE
31 SMARTLINK_ACTIVITY_ALREADY_DISABLE
32 SMARTLINK_INVALID_SESSIONID_LIST
33 SMARTLINK_INVALID_LOGIN
34 SMARTLINK_INVALID_LOGINNAME
35 SMARTLINK_INVALID_PASSWORD
36 SMARTLINK_COMMAND_INVALID Invalid command
37 SMARTLINK_INVALIDCARDEXIST
38 SMARTLINK_INVALIDCARDNOTEXIST
The “command=” keyword is invalid
39 SMARTLINK_COMMANDINVALIDKEYWORD
within the command.

108 DN1327-1004
 EntraPass SmartLink Reference Manual

Error Code Error Message Description

Timeout while processing the
40 SMARTLINK_COMMANDTIMEOUT
command by the serial port.
41 SMARTLINK_COMMANDWAITINGDATA
The operator doesn’t have the
42 SMARTLINK_SECURITYRESTRICTED
security level for this command
43 SMARTLINK_ASKCOMMAND_ERROR
44 SMARTLINK_ASKCOMMAND_SUBERROR
45 SMARTLINK_COMPONENT_NOT_EXIST
46 SMARTLINK_OPERATOR_ALREADY_LOGIN
47 SMARTLINK_CARDNUMBER_MUST_BE_LOWER
48 SMARTLINK_CHANGECOMMAND_ERROR The component doesn’t exist
49 SMARTLINK_CHANGECOMMAND_SUBERROR
50 SMARTLINK_PROCESS_INVALID
51 SMARTLINK_CANNOT_CREATE_FILE
52 SMARTLINK_ERROR_DURING_WRITE_FILE
53 SMARTLINK_INVALID_CARD_INDEX
54 SMARTLINK_INVALIDCARD_NOT_EXIST
55 SMARTLINK_INVALID_DATETIME_FORMAT
56 SMARTLINK_CANNOT_PROCESS_REPORT
57 SMARTLINK_INVALID_REPORT_FORMAT
58 SMARTLINK_SITE_NOT_CONNECTED
59 SMARTLINK_CANNOT_PROCESS_AS_REQUESTED
60 SMARTLINK_COMMAND_ARGUMENT
61 SMARTLINK_INVALID_FIRST_COMMAND
62 SMARTLINK_UNKNOWN_WEB_ID
63 SMARTLINK_INVALID_COMPONENT_ID
64 SMARTLINK_ERROR_NO_CONFIGURATION
65 SMARTLINK_NOT_ENOUGH_ALLOCATE_MEMORY
66 SMARTLINK_CARDNUMBER_UNKNOWN_FORMAT
67 SMARTLINK_CARD_UNDEFINED
68 SMARTLINK_CARD_DELETED
69 SMARTLINK_UNSUPPPORTED_PICTURE_TYPE
70 SMARTLINK_NO_PICTURE
71 SMARTLINK_NO_SIGNATURE
72 SMARTLINK_REACH_MAXIMUM_CONNECTION
73 SMARTLINK_NO_GATEWAY_COMMUNICATION
SMARTLINK_CANNOT_PROCESS_GATEWAY_RELOA
74
D
SMARTLINK_GATEWAY_COMMAND_NOT_COMPLETE
75
D
76 SMARTLINK_GATEWAY_INVALID_DATA
77 SMARTLINK_GATEWAY_INVALID_COMPONENT
78 SMARTLINK_GATEWAY_INVALID_COMMAND
79 SMARTLINK_INVALID_EMAIL
80 SMARTLINK_OLD_PASSWORD_MISMATCH

DN1327-1004 109
 Error Code Error Message Description
81 SMARTLINK_NEW_PASSWORD_BAD_SIZE
82 SMARTLINK_REPORT_EMAIL_UNDEFINED
83 SMARTLINK_IMAGE_NOT_SUPPORTED
84 SMARTLINK_CONTROLLER_IN_FAILURE

110 DN1327-1004
 EntraPass SmartLink Reference Manual

8.0 - Appendix #2, EntraPass events

The following list contains all event messages that can be sent from the SmartLink Server.

Event # Event Message Description

0 Start Server
1 End Server
2 Start Redundancy Server
3 End Redundancy Server
5 Start Workstation
6 End Workstation
7 Start Workstation Server connection
8 End Workstation Server normal disconnection
9 End Workstation Server abnormal disconnection
20 Loop communication failure
21 Loop communication restore
22 Loop communication trouble
30 Controller communication failed
31 Controller communication restored
32 Controller AC power failed
33 Controller AC power restored
34 Tamper switch in alarm
35 Tamper switch restored
36 Hard reset controller
37 Soft reset controller
38 Failsoft mode on
39 Failsoft mode off
40 Event buffer overflow
41 Elevator interface failure
42 Elevator interface restore
43 Elevator interface override enabled
44 Elevator interface override disabled
45 Controller successfully reloaded
46 Controller reload failure
47 Controller firmware reload start
48 Controller firmware reload fail
49 Controller firmware reload end
50 Cards counter In - Out
51 Controller firmware file invalid
60 Door armed - alarm interface
61 Door Disarmed - alarm interface
62 Door exit delay start - alarm interface
63 Door exit delay end - alarm interface
64 Door entry delay start - alarm interface
65 Door entry delay end - alarm interface

DN1327-1004 111
 Event # Event Message Description
66 alarm system not ready - alarm interface
67 alarm system ready - alarm interface
68 Door alarm - alarm interface
69 Door alarm restored- alarm interface
70 Request to disarm - alarm interface
80 Door forced open restored
81 Door closed/normal condition
82 Door forced open
83 Pre-Alarm on Door Open Too Long
84 Door open too long
85 Door alarm on re-lock
86 Request to exit granted
87 Request to exit denied
88 Timeout on REX
89 Timeout on manually unlock
90 Unlock overridden by door armed
91 Waiting for keypad
92 Bad code on keypad
93 Time-out on keypad
96 Door unlocked by schedule
97 Door locked by schedule
98 Request to exit denied by Interlock
99 Door lock device failure
100 Door lock device normal condition
107 Reader or Keypad locked
108 Reader or Keypad unlocked
109 Alarm supervision - reader found
110 Supervision restored
111 Reader low power
112 Reader low power restored
113 Reader's antenna - no voltage
114 Reader restarted
115 Reader's antenna - back to back voltage
116 Reader's antenna - normal voltage
120 Input restored or in normal condition
121 Input in pre-alarm
122 Input in alarm 'Return to service'
123 Input in alarm
124 Input shunted by input
125 Input unshunted by input
126 Input group shunted by input
127 Input group unshunted by input
130 Floor group activated by input
131 Floor group activation by input denied

112 DN1327-1004
 EntraPass SmartLink Reference Manual

Event # Event Message Description

132 Input shunted temporarily
133 Input unshunted temporarily
134 Input shunted on exit delay - alarm interface
135 Input unshunted on exit delay - alarm interface
136 Input shunted on disarm - alarm interface
137 Input unshunted on disarm - alarm interface
138 Input shunted on entry delay - alarm interface
139 Input unshunted on entry delay - alarm interface
150 Relay activated by schedule
151 Relay deactivated by schedule
152 Relay activated by input
153 Relay deactivated by input
154 Relay group activated by input
155 Relay group deactivated by input
160 Relay activated by an event
161 Relay temporarily activated by an event
162 Relay deactivated by an event
166 Relay temporarily activated by door access extended delay
167 Relay deactivated after temporarily action
168 Relay temporarily activated by input
175 Relay temporarily activated by keypad key
195 Time and attendance entry
196 Time and attendance exit
199 Access denied - Card not loaded in controller
200 Time-out on access granted
201 Access - Second entrance
202 Access - Door unlocked
203 Access granted
204 Access denied - Card unknown
205 Access denied - Bad card status
206 Access denied - Card lost or stolen
207 Access denied - Card expired
208 Access denied - Card pending
213 Access denied - Bad access level
215 Access denied - Passback bad location
220 Access denied - Interlock active
221 Access denied - Door manually disabled
225 Access granted - Passback bad location
234 Card traced
238 Valid floor selection
239 Invalid floor selection
240 Time-out on floor selection
241 Alarm duress on door
242 Invalid keypad code

DN1327-1004 113
 Event # Event Message Description
243 Invalid family card
244 Waiting second card
245 Timeout on waiting second card
246 Access denied - Waiting second card
247 Access denied - Reader or keypad locked
248 Access denied - Door armed - alarm interface
249 Request to arm granted - alarm interface
250 Request to arm denied - alarm interface
251 Request to postpone granted - alarm interface
252 Request to postpone denied - alarm interface
253 Alarm duress
254 Access schedule invalid
255 Wireless button battery power restored
256 Wireless button battery power failure
257 Wireless button selection number
258 Access denied
270 Card pending on service
271 Card expired
272 Card access level expired
320 Report aborted
321 Report successfully completed
322 Report aborted not enough free disk space
323 Automatic report requested
400 Access level definition modified
401 Access level group definition modified
404 Card definition modified
405 Card Access Group modified
406 Card Archive modified
407 Card Type modified
408 Controller definition modified
409 Controller group definition modified
410 Door definition modified
411 Door group definition modified
412 Event parameter definition modified
414 Floor definition modified
415 Floor group definition modified
416 Graphic definition modified
417 GSI definition modified
419 Holiday definition modified
420 Input definition modified
421 Input group definition modified
422 Instruction definition modified
423 Message view definition modified
424 NTM definition modified

114 DN1327-1004
 EntraPass SmartLink Reference Manual

Event # Event Message Description

425 Operator definition modified
426 Security level definition modified
427 Auxiliary output definition modified
428 Relay definition modified
429 Relay group definition modified
430 Historical report definition modified
431 Schedule definition modified
432 Site definition modified
434 Time and attendance report modified
435 Panel modified
436 Virtual modified
437 gateway virtual modified
438 site virtual modified
439 Badging layout modified
440 Video Server modified
441 Video View modified
442 Recording parameters modified
443 Camera modified
444 Video trigger modified
445 Video record modified
450 Login on Workstation
451 Logout on Workstation
452 Bad Login on Workstation
453 Login on Server
454 Logout on Server
455 Bad login on Server
456 Login on Smartlink
457 Logout on Smartlink
458 Bad Login on Smartlink
460 Acknowledge
461 Acknowledge time-out
462 Alarm log added
463 Acknowledge suspended
464 Alarm message flagged
465 Alarm message unflagged
466 Manual log added by operator
480 Workstation locked by operator
481 Workstation unlocked by operator
485 Controller hard reset by operator
486 Controller soft reset by operator
487 Controller reloaded by operator
488 Controller group hard reset by operator
489 Controller group soft reset by operator
490 Controller group reloaded by operator

DN1327-1004 115
 Event # Event Message Description
491 Controller reader/keypad unlocked by operator
492 Controller reader power reset by operator
493 Controller detailed status requested by operator
494 Controller passback forgiven by operator
495 Controller cards in requested by operator
496 Controller cards out requested by operator
497 Controller cards list cancelled by operator
498 controller not assigned requested by operator
500 Door locked by operator
501 Door unlocked by operator
502 Door temporarily unlocked by operator
503 Door group locked by operator
504 Door group unlocked by operator
505 Door group temporarily unlocked by operator
506 Reader enabled by operator
507 Reader disabled by operator
508 Reader group enabled by operator
509 Reader group disabled by operator
520 Relay deactivated by operator
521 Relay activated by operator
522 Relay temporarily activated by operator
523 Relay group deactivated by operator
524 Relay group activated by operator
525 Relay group temporarily activated by operator
530 Input returned to normal by operator
531 Input shunted by operator
532 Input continuous supervision by operator
534 Input group returned to normal by operator
535 Input group shunted by operator
536 Input group continuous supervision by operator
538 Input group shunted temporarily by operator
539 Input shunted temporarily by operator
540 Floor group manually enabled
541 Floor group manually disabled
542 Video Server archive enabled by operator
543 Video Server archive disabled by operator
570 Date and time modified
572 Create a daypass card
575 Card state modified to valid
576 Card state modified to invalid
590 System status request
591 View Workstation status
592 View data explorer
593 View active report

116 DN1327-1004
 EntraPass SmartLink Reference Manual

Event # Event Message Description

594 View current recording
595 New video search
596 Playback request
597 Export video request
598 Browse Video Vault
600 Device reloading data by operator
601 Begin reloading, Server procedure
602 End reloading, Server procedure
603 Error reloading, Server procedure
610 Report request by operator
611 Quick report request by operator
620 Time and attendance manually modified
624 Change programmable messages
625 Change operating language
627 Change log printer
628 Change master password
629 Change card format
630 Change card label
631 Change Sound and Video parameters
632 Change system parameters
633 Change automatic backup parameters
634 Transfer firmware files
635 Verify database integrity on Workstation
636 Cannot process card on Card Gateway
650 Registration connection granted
651 Registration connection failed
652 Registration
680 Server low free disk space
681 Server Communication Failed
690 Data backup by operator
691 Data restore by operator
692 Archive backup by operator
693 Archive restore by operator
694 Server shutdown by workstation
695 Redundancy Server Shutdown
696 View Connection On Server
697 View Command Log On Server
698 View Error Log On Server
699 Verify Database Integrity On Server
700 Verify Database Index On Server
701 Verify Database Link On Server
702 Verify Database Hierarchy On Server
703 Time and Attendance backup by operator
704 Time and Attendance restored by operator

DN1327-1004 117
 Event # Event Message Description
705 Enroll a connection on Server
706 Modify an enroll connection on Server
707 Swap database description
708 Data backup automatic
709 Archive backup automatic
710 Time and Attendance backup automatic
711 Data backup automatic - Completed
712 Archive backup automatic - Completed
713 Time and Attendance backup automatic - Completed
714 Data backup automatic - Failed
715 Archive backup automatic - Failed
716 Time and Attendance backup automatic - Failed
717 Clean Server database
720 Controller Auxiliary power failure
721 Controller Auxiliary power restored
722 Controller pre-alarm AC power failure
723 Controller pre-alarm AC power restored
724 Controller combus power failure
725 Controller combus power restored
726 Controller reader power failure
727 Controller reader power restored
728 Controller battery power failure
729 Controller battery power restored
730 Controller eprom reading failure
731 Controller date time RTC reading failure
732 Controller execute program parity failure
733 Controller execute program memory startup
734 Controller module failure
735 Controller module restored
736 Controller module tamper alarm
737 Controller module tamper restored
738 Controller module combus power failure
739 Controller module combus power restored
740 Controller module off line
741 Controller module on line
742 Controller module data received
743 Controller module end transmission
744 Controller module battery power failure
745 Controller module battery power restored
746 Controller module AC power failure
747 Controller module AC power restored
748 Controller module auxiliary power failure
749 Controller module auxiliary power restored
750 Controller module phone line #1 failure

118 DN1327-1004
 EntraPass SmartLink Reference Manual

Event # Event Message Description

751 Controller module phone line #1 restored
752 Controller module phone line #2 failure
753 Controller module phone line #2 restored
754 Controller module input class A alarm
755 Controller module input class A alarm restored
756 Controller module input class B alarm
757 Controller module input class B alarm restored
758 Controller module input class A trouble
759 Controller module input class A trouble restored
760 Controller module input class B trouble
761 Controller module input class B trouble restored
762 Controller module bell output failure
763 Controller module bell output restored
764 Controller module ground detect alarm
765 Controller module ground detect restored
766 Controller or module not assigned
767 Controller module communication failure
768 Controller module communication restore
769 Controller module trouble
770 Controller module trouble restore
780 Data restored from redundancy server
781 Archive restored from redundancy server
782 Archive merged from redundancy server
783 Time and attendance restored from redundancy server
784 Time and attendance merged from redundancy server
785 Video record restored from redundancy server
786 Video record merged from redundancy server
787 Data merged from redundancy server
790 Video record backup automatic
791 Video record backup automatic - Completed
792 Video record backup automatic - Failed
793 Video record backup by operator
794 Video record restored by operator
800 Add site to connection list
801 Disconnect site
802 Update data to site
803 Update all sites
804 Disconnect modem
805 Initialize modem
806 Reset modem
807 Connect this site next
808 Remove from connection list
809 Change priority from connection list
810 Clear connection list

DN1327-1004 119
 Event # Event Message Description
811 Connection for site synchronization
812 Remaining time remove by operator
815 Modem site connection
816 Modem site disconnection
817 Modem site connection failed
818 Modem site callback failed
819 Modem site bad UCK
820 Modem site first initialization
821 Modem site wait for callback
822 Modem site invalid command
823 Modem site callback on schedule
824 Modem site callback priority call
825 Modem site callback on buffer
826 Modem site fail to report
970 Video Server communication failed
971 Video Server communication restored
972 Camera video lost
973 Camera video restored
980 Start recording by video trigger
981 Stop recording by video trigger
982 Stop recording by timer
983 Recording requested by operator
984 Start recording requested by operator
985 Stop recording requested by operator
986 Video sent to Video Vault by operator
987 Video failed to saved
988 Video Vault reach disk space threshold
989 Video Vault no more disk space
1001 Programmable message #1
1002 Programmable message #2
1003 Programmable message #3
1004 Programmable message #4
1005 Programmable message #5
1006 Programmable message #6
1007 Programmable message #7
1008 Programmable message #8
1009 Programmable message #9
1010 Programmable message #10
1501 Camera motion alarm activated
1502 Camera motion alarm restored
1503 Camera alarm activated
1504 Camera alarm restored
1505 Camera perimeter activated
1506 Camera perimeter restored

120 DN1327-1004
 EntraPass SmartLink Reference Manual

Event # Event Message Description

1507 Camera light alarm activated
1508 Camera light alarm restored
1509 Camera advanced motion alarm activated
1510 Camera advanced motion alarm restored
1511 Camera museum activated
1512 Camera museum restored

DN1327-1004 121
122 DN1327-1004
 EntraPass SmartLink Reference Manual

DN1327-1004 123
124 DN1327-1004