SmartLink Reference Manual · DN1327-1004 3 EntraPass SmartLink Reference Manual 2.0 - SmartLink Configuration 2.1 Start-up On start-up, SmartLink sends a request to the server in

DN1327-1004

SmartLink

Reference Manual

Reference Manual

DN1327-1004 I

EntraPass SmartLink Reference Manual

TABLE OF CONTENTS

1.0 - Introduction ............................................................................. 11.1 Starting the Application ...................................................................................... 1

2.0 - SmartLink Configuration ......................................................... 32.1 Start-up .............................................................................................................. 32.2 Message Mode (light blue) ................................................................................ 32.3 Command Mode (dark blue) .............................................................................. 3

3.0 - Message Mode Processing ..................................................... 53.1 List of Message Variables ................................................................................. 63.2 List of Destination Variables .............................................................................. 93.3 Secondary Commands ................................................................................... 103.4 Emailing ........................................................................................................... 113.5 Modem and Pager ......................................................................................... 143.6 Network .......................................................................................................... 15

4.0 - Communication Protocol....................................................... 174.1 Communication modes.................................................................................... 17

4.0.1 Serial Port ........................................................................................................ 174.2 Command Format ............................................................................................ 174.3 Returned Format ............................................................................................. 17

4.0.2 Common error messages................................................................................. 18

5.0 - Commands.............................................................................. 195.1 Standard Command List Summary ................................................................ 195.2 Enhanced Command List Summary ............................................................... 225.3 Login ................................................................................................................ 235.4 Logout .............................................................................................................. 235.5 ConnectionState .............................................................................................. 245.6 AddCard .......................................................................................................... 245.7 ModifyCard ...................................................................................................... 255.8 DeleteCard ...................................................................................................... 265.9 GetCardInfo ..................................................................................................... 265.10 GetCardInfoPicture ........................................................................................ 275.11 GetCardPicture .............................................................................................. 285.12 SetCardPicture .............................................................................................. 285.13 GetCardSignature .......................................................................................... 285.14 SetCardSignature .......................................................................................... 295.15 GetNip ........................................................................................................... 295.16 SetNip ............................................................................................................ 295.17 GetCountUsage ............................................................................................. 305.18 SetCountUsage ............................................................................................. 305.19 SetCountUsageManual ................................................................................. 315.20 DecCountUsage ............................................................................................ 315.21 IncCountUsage .............................................................................................. 315.22 ResetCountUsage ......................................................................................... 325.23 GetLastAddedCard ........................................................................................ 325.24 ArmAlarmSystem (Global only) ..................................................................... 335.25 DisarmAlarmSystem (Global only) ................................................................ 335.26 PostponeAlarmSystem (Global only) ............................................................. 335.27 AreaMoveCard (Global only) ......................................................................... 34

DN1327-1004II

5.28 HardResetController ...................................................................................... 345.29 SoftResetController ....................................................................................... 345.30 ForgiveController ........................................................................................... 355.31 ReloadController ............................................................................................ 355.32 LockDoor ....................................................................................................... 355.33 UnlockDoor .................................................................................................... 365.34 UnlockTempoDoor ......................................................................................... 365.35 ReturnScheduleDoor ..................................................................................... 365.36 ToggleDoorStrike ........................................................................................... 375.37 LockDoorGroup ............................................................................................. 375.38 UnlockDoorGroup .......................................................................................... 375.39 UnlockTempoDoorGroup ............................................................................... 385.40 ReturnScheduleDoorGroup ........................................................................... 385.41 ArmDoor ........................................................................................................ 395.42 DisarmDoor ................................................................................................... 395.43 ArmDoorGroup .............................................................................................. 395.44 DisarmDoorGroup ......................................................................................... 405.45 DeactivateRelay ............................................................................................ 405.46 ActivateRelay ................................................................................................. 405.47 ActivateTempoRelay ..................................................................................... 415.48 ReturnScheduleRelay .................................................................................... 415.49 ToggleRelayActivation ................................................................................... 425.50 DeactivateRelayGroup .................................................................................. 425.51 ActivateRelayGroup ....................................................................................... 425.52 ActivateTempoRelayGroup ........................................................................... 435.53 ReturnScheduleRelayGroup .......................................................................... 435.54 UnshuntInput ................................................................................................. 445.55 ShuntInput ..................................................................................................... 445.56 ShuntInputTempo .......................................................................................... 445.57 SuperviseInput ............................................................................................... 455.58 ReturnScheduleInput ..................................................................................... 455.59 ToggleInputShunt .......................................................................................... 465.60 UnshuntInputGroup ....................................................................................... 465.61 ShuntInputGroup ........................................................................................... 465.62 ShuntTempoInputGroup ................................................................................ 475.63 SuperviseInputGroup ..................................................................................... 475.64 ReturnScheduleInputGroup ........................................................................... 485.65 EnableDoor .................................................................................................... 485.66 DisableDoor ................................................................................................... 485.67 EnableDoorGroup .......................................................................................... 495.68 DisableDoorGroup ......................................................................................... 495.69 LockElevatorDoor .......................................................................................... 505.70 UnlockElevatorDoor ....................................................................................... 505.71 UnlockTempoElevatorDoor ........................................................................... 505.72 ReturnScheduleElevatorDoor ........................................................................ 515.73 LockElevatorDoorGroup ................................................................................ 515.74 UnlockElevatorDoorGroup ............................................................................. 525.75 UnlockTempoElevatorDoorGroup ................................................................. 525.76 ReturnScheduleElevatorDoorGroup .............................................................. 525.77 EnableElevatorDoor ...................................................................................... 535.78 DisableElevatorDoor ...................................................................................... 535.79 EnableElevatorDoorGroup ............................................................................ 54

DN1327-1004 III


5.80 DisableElevatorDoorGroup ............................................................................ 545.81 EnableFloorElevatorDoor .............................................................................. 545.82 DisableFloorElevatorDoor ............................................................................. 555.83 EnableFloorElevatorDoorGroup .................................................................... 555.84 DisableFloorElevatorDoorGroup ................................................................... 565.85 WorkstationStatus ......................................................................................... 565.86 GatewayStatus .............................................................................................. 565.87 SiteStatus ...................................................................................................... 575.88 ControllerStatus ............................................................................................. 575.89 DoorStatus ..................................................................................................... 585.90 RelayStatus ................................................................................................... 595.91 InputStatus .................................................................................................... 605.92 OutputStatus (Not implemented) ................................................................... 615.93 AlarmSystemStatus (Global only) .................................................................. 615.94 AreaStatus (Global only) ............................................................................... 625.95 GuardTourStatus (Global only) ...................................................................... 625.96 GetLastTransactionCard ............................................................................... 635.97 GetReportEmail ............................................................................................. 635.98 ConnectSite ................................................................................................... 645.99 DisconnectSite ............................................................................................... 645.100 UpdateRemoteSite ...................................................................................... 645.101 UpdateRemoteSiteGateway ........................................................................ 655.102 UpdateAllSite ............................................................................................... 655.103 ExecuteTask ................................................................................................ 655.104 BatchModify ................................................................................................. 665.105 GetDescription ............................................................................................. 665.106 EmailPassword ............................................................................................ 675.107 ChangePassword ........................................................................................ 675.108 GetCardAccessGroup ................................................................................. 675.109 GetAccessLevelDescription ......................................................................... 685.110 AddToTrigger ............................................................................................... 685.111 RemoveFromTrigger ................................................................................... 695.112 GetList ......................................................................................................... 695.113 GetListOwnerBy .......................................................................................... 705.114 GetListGraphicUrl ........................................................................................ 705.115 GetFind ........................................................................................................ 715.116 GetFindNext ................................................................................................ 725.117 AddHoliday .................................................................................................. 725.118 GetHoliday ................................................................................................... 735.119 ModifyHoliday .............................................................................................. 745.120 DeleteHoliday .............................................................................................. 745.121 AddSchedule ............................................................................................... 745.122 GetSchedule ................................................................................................ 755.123 ModifySchedule ........................................................................................... 765.124 DeleteSchedule ........................................................................................... 765.125 AddAccessLevel .......................................................................................... 775.126 GetAccessLevel ........................................................................................... 775.127 ModifyAccessLevel ...................................................................................... 785.128 DeleteAccessLevel ...................................................................................... 785.129 AddSite (FastSetup) .................................................................................... 795.130 GetSite ......................................................................................................... 815.131 ModifySite .................................................................................................... 81

DN1327-1004IV

5.132 DeleteSite .................................................................................................... 825.133 AddController (ExpressSetup) ..................................................................... 825.134 GetController ............................................................................................... 855.135 ModifyController .......................................................................................... 855.136 DeleteController ........................................................................................... 865.137 GetDoor ....................................................................................................... 865.138 ModifyDoor .................................................................................................. 905.139 DeleteDoor .................................................................................................. 905.140 GetRelay ...................................................................................................... 905.141 ModifyRelay ................................................................................................. 915.142 DeleteRelay ................................................................................................. 915.143 GetInput ....................................................................................................... 915.144 ModifyInput .................................................................................................. 925.145 DeleteInput .................................................................................................. 935.146 GetOutput .................................................................................................... 935.147 ModifyOutput ............................................................................................... 945.148 DeleteOutput ............................................................................................... 945.149 GetSiteStructure .......................................................................................... 945.150 GetSiteCard ................................................................................................. 955.151 AddAccount ................................................................................................. 955.152 GetAccount .................................................................................................. 965.153 ModifyAccount ............................................................................................. 975.154 DeleteAccount ............................................................................................. 975.155 SwitchAccount ............................................................................................. 97

6.0 - SmartDll................................................................................... 99

7.0 - Appendix #1, Error messages............................................. 108

8.0 - Appendix #2, EntraPass events .......................................... 111

DN1327-1004 V


DN1327-1004VI

DN1327-1004 1


1.0 - IntroductionThe SmartLink option is available with EntraPass Corporate and Global editions and provides optimalautomated 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 ApplicationSmartLink allows for many operation s to be carried out with an unlimited number of events. For suchpurposes, the EntraPass interface is sufficient. However, for a wider and more special ized range ofoptions, SmartLink can be used apart from th e EntraPass interface, as a st and alone program (.exefile). A Customer Sof tware D evelopper may inte rface directly with SmartLink u sing a provided DL Lcalled 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-10042

Below is the main window of the SmartLink application, in which SmartLink tasks are executed:

DN1327-1004 3


2.0 - SmartLink Configuration

2.1 Start-upOn start-up, SmartLink sends a reques t to the server i n order to retrieve the connection options forserial output and network modes. Following that request, if the SmartLink network connection mode isother than ’None’, the network server will start-up to a llow a client application to connect, either toexecute network commands or to receive messages sent over the network, or both simultaneously. Amacro is in cluded in thi s request and wi ll b e ex ecuted at st art-up (yellow). It is d efined on theworkstation (green) and ca n be used to open the bidirectional or unidirectional serial output, or anyother valid SmartLink co mmand. Another macro is u sed to manage messa ges when n o ma cro isspecified.

2.2 Message Mode (light blue)To enable the message sending functionality from t he serial or n etwork outp ut, SmartLink must b eproperly configured from the workstations:

Sending messages from the serial output :Option on screen : Smartl ink serial con nection = Messages only or Messages andCommands.

Sending messages from the network output :Option on screen : Smartlink network connection = Messages only or Messages andCommands.

2.3 Command Mode (dark blue)To enable the co mmand sending functionality (bidirectional mode) through the serial or the netwo rkoutput, 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 andCommands.

Commands from the network output :Option on screen : Smartlink network connection = Commands only or Messages andCommands.

DN1327-10044

DN1327-1004 5


3.0 - Message Mode ProcessingThe 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 processed 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 ofconnection trials too h igh. Otherwise, SmartLink will wait for an established connection orfor the connection delay or the number of trials to expire.

EntraPass Server

SmartLink

ConnectionId 1000

ConnectionId 2000

ConnectionId 3000

ConnectionId 4000

E-mail

Network

RS-232

Modem

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

Pager

Disk or CD

DN1327-10046

3.1 List of Message Variables

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

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)



$o2 Text of field #2









$z0 Card number

$z1 Card user name

$z2 Card Information field #1






$z8 Card comment field


$za Card Information field #8

$zb Card Information field #9

$zc Card Information field #10

DN1327-1004 7


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-10048

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

Index Number Index Text

DN1327-1004 9


3.2 List of Destination Variables


Variable Description

$p Save SmartLink actual mode

$r

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 65000 inclusive.ex : $r25$r

$r begins and ends the command. If the identifier’s value = 0, then send to all clients

$sReset of the serial output and communication speed for bidirectionalex : $s com1:9600$s

$s begins and ends the command

$t Restore SmartLink mode previously saved

$u

Reset of the serial output and communication speed for unidirectionalex : $u com1:9600$u

$u begins and ends the commandThis command activates the serial output mode

$v

Defines a file for future writing useex : $vc:\ep_2000.inf$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

$x Write the data on the hard disk Forced writing of the opened file (close / open) if the disk writing mode is not enabled, nothing will be processed

DN1327-100410

3.3 Secondary Commands

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

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

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

Command Description

[xxxProcesses characters on the left only (xxx = indicates the number of characters to keep in the command’s characters string)Ex: $[15h, only the first 15 characters from the left will be kept

]xxxProcesses characters on the right only (xxx = indicates the number of characters to keep in the 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 valueEx: $+c the current day’s value is incremented of 1

- Decrements the command’s numeric valueEx: $-g the event’s number value is decremented of 1

~w”xxxxxxxxx”

Delay of xxxxxxxxxx in tenth of seconds before the next character is sent, in serial output sending mode. If this command is received in disk writing mode, it will be ignored

~l”x” Language selection to interpret instructionsx = 1 (first language) or 2 (second language)

DN1327-1004 11


3.4 Emailing

Command Description

~e Indicates the beginning of an email

~f”xxxxx”

The email sender’s addressMust include < “> at the beginning and at the end of the address xxxxx = email addressOn some sites, this address must be valid on the email server account in order to send the email out of the local network.

~a”xxxxx”

The email addressee’s addressMust include < “> at the beginning and at the end of the addressxxxxx = email addressMultiple addresses can be defined (see example below)

~o”xxxxx”

The email CC’s addressMust include < “> at the beginning and at the end of the addressxxxxx = email addressMultiple addresses can be defined (see example below)

~t”xxxxx”The email’s subject Must include < “> at the beginning and at the end of the subject (title)xxxxx = subject content (title)

~c”xxxxx”

The email’s content (text)Must include < “> at the beginning and at the end of the subjectxxxxx = email contentEach 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-100412

Example 1: Single address email

~e~f”validaccount@localserver”~a"[email protected] "~o”Address in CC”~t”Subject ofthis 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 ucan enter the email body text”~s

Example 3: Single address email with primary i nstructions included in the text. Year, month and current day areadded 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 orcontent.

Email title definition : ~t$a”/”$b”/”$c” : “”Generated event : ”$hEmail 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 andend with < ~s >. The order of commands inserted between thebeginning and end of the email is irrelevant. This instruction cancontain multiple address commands (addressees and CC), andalso many commands of < ~c > type corresponding to a distinctline of text in the email.


DN1327-1004 13


DN1327-100414

3.5 Modem and Pager

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


Command Description

~m”x:yyyy :xxxxxxxx”

Modem start-up and initialization for the selected serial outputx = serial output 1 to xxyyyy = modem speed in baud rates (default : 19200)xxxxxxxx = characters string for the modem initialization.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)

~dz”xxxxxxx” Dialing of phone number xxxxxxx. z is the number of redial attempts in case of failure.

~p”xxxxxxx:yyyy:zzzzzzzzzzzz”

Send a numeric message to a pager.xxxxxxxx : phone number to dialyyyy: delay before sending the messagezzzzzzzzzzzz : message (numeric only)

~b”xxxx:yyyy”Modem connection delay :xxxx = connection delay (dial) in secondsyyyy = delay in seconds between each connection trial in case of failure.

~h Hang-up the line for the modem in use

DN1327-1004 15


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

Example: ID = 0 ($r0$r), this instruction in ‘MessageMode’ returns the result to all the clients actually connectedto 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-byuntil the application is reconnected. As soon as the application is reconnected, all the information on

DN1327-100416

stand-by will be sent. If more th an one person is connected using the same identifier, the system wil lkeep only the last connected one.

Note: The information on stand-by wil l be d eleted if SmartLink is stopp ed before the clientapplication 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 workstation configurationwindow corresponding to SmartLink should be: Messag es onlyor Messages and Commands.


DN1327-1004 17


4.0 - Communication ProtocolThis secti on d escribes the particular fea tures of the different communi cation methods use d withSmartLink.

4.1 Communication modesThere are two communication modes between the Operator and SmartLink. The first on e uses the IPNetwork and the second one the serial port. In both cases, the data format is almost the same. Thissection explains the differences.

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

4.1.2 Serial PortOnce the first byte of data is received by SmartLink, any other command coming to the same serialport will be blo cked and placed into a queue . A time r is a utomatically st arted o nce a command isreceived at SmartLink. That timer eventually times out when the packet takes too long to a rrive. Thismethod of time management allows SmartLink to free up the communication port in case a commandtakes too long to arrive.

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

STX: Start Transmission byte = 0x02FS: File separator byte = 0x1CETX: End of Transmission byte = 0x03 Optional

The formatted packet must always begin with an STX byte to identify its starting point. The commandis then pre ceeded w ith “ Command=”. Th e FS byte delimiter must fo llow the comma nd an d anyprovided p arameters. Th e last byte within th e fo rmatted packet must be an ETX that specifies theending point. The parameters are optional and may be placed in any order since keywords are used.All keywords must be followed with an equal sign. The characters are not case sensitive. Spaces arenot 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 FormatSmartLink returns an acknowledged reply different for the Serial Port and the IP Network. Note that,the returned keywords are always displayed in upper case except in the present documentation forreadability purposes.

STX Command=x FS Parameter1 FS ParameterN FS ETX

DN1327-100418

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

4.3.1 IP NetworkThe 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 messagesList 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

39 SMARTLINK_COMMANDINVALIDKEYWORD The “command=” keyword is invalid within the command.

40 SMARTLINK_COMMANDTIMEOUT Timeout while processing the command by the serial port.

42 SMARTLINK_SECURITYRESTRICTED The operator doesn’t have the appropriate security level for this command

48 SMARTLINK_CHANGECOMMAND_ERROR The component doesn’t exist

DN1327-1004 19


5.0 - CommandsThis 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 ofeach 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

AddToTrigger1 Add a component filter to a trigger 2.110

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

DecCountUsage1 Remove 1 to count usage for a specific card 2.20

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

DisableElevatorDoorGroup1 Disable an elevator group of readers (door) 2.80

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

EmaiPassword2 Email a password 2.106

EnableDoor Enable a reader (door) 2.65

EnableDoorGroup Enable a group of readers (door) 2.67

EnableElevatorDoor1 Enable an elevator reader (door) 2.77

EnableElevatorDoorGroup1 Enable an elevator group of readers (door) 2.79

EnableFloorElevatorDoor1 Enable floor group for a cab (door) 2.81

DN1327-100420

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

GetAccessLevelDescription2 Get access level description 2.109

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

GetFind2 Get a list of component specific parameters 2.115

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

GetListGraphicUrl2 Get a list of graphic URLs 2.114

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

LockElevatorDoor1 Lock an elevator door 2.69

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 only) Postpone an alarm system 2.26

RelayStatus Receive a relay status 2.90

ReloadController Reload the controller database 2.31

RemoveFromTrigger1 Remove a component filter to a trigger 2.111

ResetCountUsage1 Restart count usage to 0 use 2.22

ReturnScheduleDoor1 Return door to normal schedule 2.35

ReturnScheduleDoorGroup1 Return group of doors to normal schedule 2.40


DN1327-1004 21


ReturnScheduleElevatorDoor1 Return elevator door to normal schedule 2.72

ReturnScheduleElevatorDoorGroup1

Return elevator group of doors to normal schedule 2.76

ReturnScheduleInput1 Return input to normal schedule 2.58

ReturnScheduleInputGroup1 Return group of inputs to normal schedule 2.64

ReturnScheduleRelay1 Return relay to normal schedule 2.48

ReturnScheduleRelayGroup1 Return group of relays to normal schedule 2.53

SetCardPicture2 Change a card’s picture 2.12

SetCardSignature2 Change card’s signature 2.14

SetCountUsage Modify the maximum number of card usages 2.18

SetCountUsageManual1Modify the maximum number of card usages and 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

SuperviseInput1 Continuously supervise an input 2.57

SuperviseInputGroup1 Continuously supervise a group of inputs 2.63

ToggleDoorStrike1 Toggle the Door Strike 2.36

ToggleInputShunt1 Toggle shunt or unshunt input 2.59

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

UpdateRemoteSiteGateway Call all sites on a specific gateway with modified data 2.101

WorkstationStatus Receive the workstation status 2.85

SiteStatus Receive the site status 2.87

SoftResetController Execute a board level soft reset 2.29

SuperviseInput1 Continuously supervise an input 2.57

SuperviseInputGroup1 Continuously supervise a group of inputs 2.63


DN1327-100422

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 ofeach command is given in subsequent sections.

ToggleDoorStrike1 Toggle the Door Strike 2.36

ToggleInputShunt1 Toggle shunt or unshunt input 2.59

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

UpdateRemoteSiteGateway Call all sites on a specific gateway with modified data 2.101

WorkstationStatus Receive the workstation status 2.85


Commands Description

AddAccessLevel Add an access level to the system. A maximum of 250 access levels can be programmed per site.

AddController (ExpressSetup)

Add a controller to the system. Can create relay, input, door, output in the same way as the ExpressSetup utility

AddHoliday Add a holiday

AddSchedule Add a schedule to the system. A maximum of four intervals can be configured

AddSite (FastSetup) Add a site to the system. Can create controllers in the same way as the 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

DN1327-1004 23


5.3 LoginThis command allows a new user to reque st a conn ection to the netw ork according to the p rovidedusername and password. All commands (except for lo gin and logoff) need Login executed first to beprocessed successfully.

Returned data :

5.4 LogoutThis command allows the operator to disconnect from the SmartLink network.

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

GetSiteStructure Advanced command to retrieve all component references from a specific site. Allow 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

Commands Description

Field Keyword & format Detail

Command Command =Login

Parameter1 OperatorLoginName=x x is the operator login name

Parameter2 OperatorPassword=x x is the password


Result

See section 17: Returned Formatfor format details.See Appendix #1 for all returned codes.

Most common returned values:0 = SMARTLINK_COMMAND_OK (granted)33 = SMARTLINK_INVALID_LOGIN34 = SMARTLINK_INVALID_LOGINNAME35 = SMARTLINK_INVALID_PASSWORD


Command Command= Logout

DN1327-100424

Returned data :

5.5 ConnectionStateThis command allows the operator to disconnect from the SmartLink network.

Returned data :

5.6 AddCardThis command a dds a card in the syste m. If the ca rd a lready exist s, then the correspon ding errormessage is displayed.

Field Keyword & format Details

Result

See section 17: Returned Format for format details.See Appendix #1 for all returned codes.

Most common returned values:0 = SMARTLINK_COMMAND_OK (granted)


Command Command= ConnectionState


Result




Command Command =AddCard

Parameter1 CardNumber=xxxx :xxxx Main card. x is the format based on system definition

Parameter2 UserName=x Maximum of 40 characters

Parameter3 CardInfo1=x Maximum of 40 characters










Parameter13 StartDate=YYYY\MM\DD YYYY = Year, MM = Month, DD = Day

Parameter14 UsingEndDate=x x = YES or NO

Parameter15 EndDate=YYYY\MM\DD YYYY = Year, MM = Month, DD = Day

DN1327-1004 25


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

Returned data :

5.7 ModifyCardThis command modifies a card in the system.

Note: As in Ad dCard, the pi cture associated to a card can be sen t throu ghSendDataPicture().

Returned data

Parameter16 DeleteOnExpired=x x = YES or NO

Parameter17 CardState=x x value can be:VALID , INVALID , 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

Parameter24 DeleteCardId=xx is the Card ID of the card owner. When provided, the corresponding Card ID is deleted.

Parameter25 TransferCardId=x

This field is only used in Enhanced user management mode.x is the original Card ID that is holding the card number. The card number will be removed from the original Card ID.



Result


Most common returned values:0= SMARTLINK_COMMAND_OK37=SMARTLINK_INVALIDCARDEXIST


Command Command= ModifyCard

Parameter1 CardNumber=xxxx :xxxx ORCardId=y

x format is based on system definitiony is the unique system based number (PkData)

Parameter2 to Parameter23 As per section 24: AddCard

Parameter24 ReplaceCardNumber=xxxx :xxxx

Format based on system definition.This field makes it possible to execute a SaveAs on a card. The system will delete the card and create a new one with the deleted data.

DN1327-100426

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

Returned data:

5.9 GetCardInfoThis command retrieves a card information according to its number.

Returned data:


Result


Most common returned values:0 = SMARTLINK_COMMAND_OK (granted)38 = SMARTLINK_INVALIDCARDNOTEXIST


Command Command= DeleteCard




Result


Most common returned values:0 = SMARTLINK_COMMAND_OK


Command Command= GetCardInfo



DN1327-1004 27


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

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

Returned data:


Result



Parameter1 to Parameter23 As per section 24: AddCard

As many cards CardNumberx=yyyy : yyyy x is a multiple card rank. y is a format based on system definition

As many cards DisplayCardNumberx=y x is a multiple card rank. y is a “to be displayed”: Yes 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

As many cards CardStatex=y X is a card rank. Y value can be:VALID , INVALID , STOLEN\LOST


Command Command= GetCardInfoPicture




Result



Parameter1 to Parameter23 As per the section 24: AddCard

As many cards CardNumberx=yyyy : yyyy x is a multiple card rank. y is a format based on system definition

As many cards DisplayCardNumberx=y x is a multiple card rank. y is for “to be displayed”: Yes 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

As many cards CardStatex=y x is a card rank. Y value can be:VALID , INVALID , STOLEN\LOST

DN1327-100428

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

5.11 GetCardPictureThis command retrieves a card Picture according to its number

Returned data:

5.12 SetCardPictureThis command changes a card picture according to its number

Returned data:

5.13 GetCardSignatureThis command gets a card Signature according to its number

Returned data:


Command Command= GetCardPicture




Result




Command Command= SetCardPicture



Parameter2 PictureType=x x is the Image type: 1=BMP, 2=EPS, 3=GIF, 4=JPG(default), 5=PCX, 6=PNG, 7=TGA, 8=TIF

Parameter3 PictureLength=x x is the picture size


Result




Command Command= GetCardSignature



DN1327-1004 29


5.14 SetCardSignatureThis command sets a card signature according to its number

Returned data:

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

Returned data:

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


Result




Command Command= SetCardSignature



Parameter2 SignatureType=x x is the image type: 1=BMP, 2=EPS, 3=GIF, 4=JPG(default), 5=PCX, 6=PNG, 7=TGA, 8=TIF

Parameter3 SignatureLength=x x is the signature size


Result




Command Command= GetNip




Result


Most common returned values:0 = SMARTLINK_COMMAND_OK38 = SMARTLINK_INVALIDCARDNOTEXIST

Parameter1 8000NIP=x x is the card PIN

DN1327-100430

Returned data:

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

Returned data:

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

Returned data:


Command Command= SetNip



Parameter1 8000NIP=x x is the card PIN


Result




Command Command= GetCountUsage




Result



Parameter1 CountUsage=x x is the count usage of the card


Command Command= SetCountUsage



Parameter2 CountUsage=x x is the count usage

DN1327-1004 31


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

Returned data:

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

Returned data:

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


Result




Command Command= SetCountUsageManual



Parameter2 CountUsage=x x is the count usage


Result




Command Command= DecCountUsage




Result



DN1327-100432

Returned data:

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

Returned data:

5.23 GetLastAddedCardThis command retrieves the last added card ID.

Returned data:


Command Command= IncCountUsage




Result




Command Command= ResetCountUsage




Result




Command Command= GetLastAddedCard

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


Result



DN1327-1004 33


5.24 ArmAlarmSystem (Global only)This command arms an alarm system.

Returned data:

5.25 DisarmAlarmSystem (Global only)This command disarms an alarm system.

Returned data:

5.26 PostponeAlarmSystem (Global only)This command postpones the arming of an alarm system.

Returned data:


Command Command= ArmAlarmSystem

Parameter1 AlarmSystemId=x x is the Alarm System Reference Identifier


Result




Command Command= DisarmAlarmSystem



Result




Command Co mmand=PostponeAlarmSystem


Parameter1 PostponeDelay=x x is the postponement delay in seconds form 1 to 65535


Result



DN1327-100434

5.27 AreaMoveCard (Global only)This command moves a card to a specific area.

Returned data:

5.28 HardResetControllerThis command performs a hard reset on a controller.

Returned data:

5.29 SoftResetControllerThis command performs a soft reset on a controller.

Returned data:


Command Command= AreaMoveCard

Parameter1 AreaId=x x is the Area Reference Identifier

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


Result




Command Command= HardReset

Parameter1 ControllerID=x x is the controller reference ID


Result




Command Command= SoftReset



Result



DN1327-1004 35


5.30 ForgiveControllerThis command clears the Anti-Passback.

Returned data:

5.31 ReloadControllerThis command reloads the controller database.

Returned data:

5.32 LockDoorThis command locks a door according to its identifier.

Returned data:


Command Command= ForgveController



Result




Command Command= ReloadController

Parameter1 ControllerID=x X is the controller reference ID


Result




Command Command= LockDoor

Parameter1 DoorId=x x is the door reference ID

Parameter2 ForceSend=x Optional: x=YES, forces the controller to execute all pending commands


Result



DN1327-100436

5.33 UnlockDoorThis command unlocks a door according to its identifier.

Returned data:

5.34 UnlockTempoDoorThis command temporarily unlocks a door according to its identifier.

Returned data:

5.35 ReturnScheduleDoorThis command returns a door to the normal schedule.

Returned data:


Command Command= UnlockDoor



Result




Command C ommand=UnlockTempoDoor


Parameter2 DoorDelay=x x is the door delay in seconds from 1 to 255



Result




Command Command= ReturnScheduleDoor



DN1327-1004 37


5.36 ToggleDoorStrikeThis command toggles the door strike.

Returned data:

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

Returned data:

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


Result




Command Command= ToggleDoorStrike




Result



ToggleDoorStrike Lock or Unlock door


Command Command= LockDoorGroup

Parameter1 DoorGroupId=x x is the door group reference ID



Result



DN1327-100438

Returned data:

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

Returned data:

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

Returned data:


Command Command= UnlockDoorGroup



Result




Command Command= UnlockTempoDoorGroup

Parameter1 DoorGroupId=x x is the door reference ID




Result




Command Command= UnlockTempoDoorGroup

Parameter1 DoorGroupId=x x is the door reference ID



Result



DN1327-1004 39


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

Returned data:

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

Returned data:

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

Returned data:


Command Command= ArmDoor




Result




Command Command= DisarmDoor




Result




Command Command= ArmDoorGroup



DN1327-100440

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

Returned data:

5.45 DeactivateRelayThis command deactivates a relay according to its identifier

Returned data:

5.46 ActivateRelayThis command activates a relay according to its identifier


Result




Command Command= DisarmDoorGroup




Result




Command Command= DeactivateRelay

Parameter1 RelayId=x x is the Relay reference ID



Result



DN1327-1004 41


Returned data:

5.47 ActivateTempoRelayThis command temporarily activates a relay according to its identifier

Returned data:

5.48 ReturnScheduleRelayThis command returns a relay to its normal schedule according to its identifier

Returned data:


Command Command= ActivateRelay




Result




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



Result




Command Command= ReturnScheduleRelay

Parameter1 RelayId=x x is the relay reference ID


DN1327-100442

5.49 ToggleRelayActivationThis command toggles the relay state according to its identifier.

Returned data:

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

Returned data:

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


Result




Command Command= ToggleRelayActivation




Result




Command Command= DeactivateRelayGroup

Parameter1 RelayGroupId=x x is the Relay group reference ID



Result



DN1327-1004 43


Returned data:

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

Returned data:

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

Returned data:


Command Command= ActivateRelayGroup




Result




Command Command=ActivateTempoRelayGroup





Result




Command Command=ReturnScheduleRelayGroup




DN1327-100444

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

Returned data:

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

Returned data:

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


Result




Command Command= UnshuntInput

Parameter1 InputId=x x is the Input reference ID



Result




Command Command= ShuntInput




Result



DN1327-1004 45


Returned data:

5.57 SuperviseInputThis command continuously supervises an input according to its identifier.

Returned data:

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

Returned data:


Command Command= ShuntInputTempo


Parameter2 InputDelay=x x is the relay delay in seconds from 1 to 255



Result




Command Command= SupervisedInput




Result




Command Command= ReturnScheduleInput



DN1327-100446

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

Returned data:

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

Returned data:

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


Result




Command Command= ToggleInputShunt




Result




Command Command= UnshuntInputGroup

Parameter1 InputGroupId=x x is the Input group reference ID



Result



DN1327-1004 47


Returned data:

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

Returned data:

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

Returned data:


Command Command= ShuntInputGroup




Result




Command Command= ShuntTempoInputGroup


Parameter2 InputDelay=x x is the relay delay in seconds from 1 to 255



Result




Command Command= SuperviseInputGroup



DN1327-100448

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

Returned data:

5.65 EnableDoorThis command enables a door according to its identifier.

Returned data:

5.66 DisableDoorThis command disables a door according to its identifier.


Result




Command Command=ReturnScheduleInputGroup




Result




Command Command= EnableDoor

Parameter1 DoorId=x x is the Door reference ID



Result



DN1327-1004 49


Returned data:

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

Returned data:

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

Returned data:


Command Command= DisableDoor

Parameter1 DoorId=x x is the Door reference ID



Result




Command Command= EnableDoorGroup

Parameter1 DoorGroupId=x x is the Door group reference ID



Result




Command Command= DisableDoorGroup

Parameter1 DoorGroupId=x x is the Door group reference ID


DN1327-100450

5.69 LockElevatorDoorThis command locks an elevator door according to its identifier.

Returned data:

5.70 UnlockElevatorDoorThis command unlocks an elevator door according to its identifier.

Returned data:

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


Result




Command Command= LockElevatorDoor

Parameter1 DoorId=x x is the elevator door reference ID



Result




Command Command= UnlockElevatorDoor




Result



DN1327-1004 51


Returned data:

5.72 ReturnScheduleElevatorDoorThis command returns an elevator door to normal schedule.

Returned data:

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

Returned data:


Command Command=UnlockTempoElevatorDoor





Result




Command Command=ReturnScheduleElevatorDoor




Result




Command Command= LockElevatorDoorGroup

Parameter1 DoorGroupId=x x is the Elevator door group reference ID


DN1327-100452

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

Returned data:

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

Returned data:

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


Result




Command Command=UnlockElevatorDoorGroup

Parameter1 DoorGroupId=x x is the Elevator door group reference ID



Result




Command Command=UnlockTempoElevatorDoorGroup

Parameter1 DoorGroupId=x x is the Elevator door reference ID




Result



DN1327-1004 53


Returned data:

5.77 EnableElevatorDoorThis command enables an elevator door according to its identifier.

Returned data:

5.78 DisableElevatorDoorThis command disables an elevator door according to its identifier.

Returned data:


Command Command=UnlockTempoElevatorDoorGroup

Parameter1 DoorGroupId=x x is the Elevator door reference ID



Result




Command Command= EnableElevatorDoor

Parameter1 DoorId=x x is the Elevator Door reference ID



Result




Command Command= DisableElevatorDoor

Parameter1 DoorId=x x is the Elevator Door reference ID


DN1327-100454

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

Returned data:

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

Returned data:

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


Result




Command Command=EnableElevatorDoorGroup

Parameter1 DoorGroupId=x x is the Elevator Door group reference ID



Result




Command Command= DisableDoorGroup

Parameter1 DoorGroupId=x x is the Elevator Door group reference ID



Result



DN1327-1004 55


Returned data:

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

Returned data:

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

Returned data:


Command Command=EnableFloorElevatorDoor

Parameter1 DoorId=x x is the Floor Elevator Door reference ID



Result




Command Command=DisableFloorElevatorDoor

Parameter1 DoorId=x x is the Floor Elevator Door reference ID



Result




Command Command=EnableFloorElevatorDoorGroup

Parameter1 DoorGroupId=x x is the Floor Elevator Door group reference ID


DN1327-100456

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

Returned data:

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

Returned data:

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


Result




Command Command= DisableFloorDoorGroup

Parameter1 DoorGroupId=x x is the Floor Elevator Door group reference ID



Result




Command Command= WorkstationStatus

Parameter1 WorkstationID=x x is for the workstation reference ID


Result



Parameter1 CommunicationState=xCommunication state, x can be:• Connected• Disconnected

DN1327-1004 57


Returned data:

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

Returned data:

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

Returned data:


Command Command= GatewayStatus

Parameter1 GatewayID=x x is the Gateway reference ID


Result



Parameter1 CommunicationState=xCommunication state. x can be:• OK• Failure

Parameter2 ServerReload=xInforms that server is reloading, x can be:• No• Yes

Parameter3 WorkstationReload=xInforms that workstation is reloading, x can be:• No• Yes


Command Command= SiteStatus

Parameter1 SiteID=x x is the Site Reference ID


Result



Parameter1 COMMUNICATIONSTATE=x x = CONNECTED or NOTCONNECTED


Command Command= ControllerStatus


DN1327-100458

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

Returned data:


Result



Parameter1 Exist=xController defined, x can be:• No• Yes

Parameter2 Failure=xCommunication failure, x can be:• No• Yes

Parameter3 HardReset=xController is in hard reset, x can be:• No• Yes

Parameter4 AcAlarm=xAC power failure, x can be:• No• Yes

Parameter5 TamperAlarm=xTamper is in alarm, x can be:• No• Yes

Parameter6 AcSchedule=xValid AC schedule, x can be:• No• Yes

Parameter7 TamperSchedule=xValid tamper schedule, x can be:• No• Yes

Parameter8 Version=xx.xx Controller version


Command Command= DoorStatus

Parameter1 DoorID=x x is the door reference ID

DN1327-1004 59


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

Returned data:


Result



Parameter1 ControllerExist=xController defined, x can be:NoYes

Parameter2 ControllerFailure=xController failure, x can be:• No• Yes

Parameter3 DoorExist=xDoor is defined, x can be:• No• Yes

Parameter4 OpenState=x

Door opened, x can be:• Close• Forced• OpenTooLong• PreAlarmOpenTooLong• StillOpen• Open

Parameter5 LockState=x

Door is locked, x can be:• Lock• UnlockOperator• UnlockSchedule

Parameter6 ReaderDisable=xReader is disabled, x can be:• No• Yes


Command Command= RelayStatus

Parameter1 RelayID=x x is the relay reference ID

DN1327-100460

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

Returned data:


Result



Parameter1 ControllerExist=xController defined, x can be:• No• Yes


Parameter3 RelayExist=xRelay is defined, x can be:• No• Yes

Parameter4 State=x

Relay State, x can be:• Deactivate• ActivateOperator• ActivateSchedule• ActivateInput• ActivateArea• ActivateEvent• ActivateAlarmSystem• ActivateAlarmSystemStatus• ActivateAlarmSystemPostpone• ActivateAlarmSystemEntryDelay• ActivateAlarmSystemExitDelay• ActivateAlarmSystemArmingDelay• ActivateAlarmSystemPreventArming• ActivateAlarmSystemAlarm1• ActivateAlarmSystemAlarm2• ActivateAlarmSystemBell

Parameter5 ActivateTempo=xRelay temporarily activated, x can be:• No• Yes

Parameter6 AlarmSystemID=x x is the alarm system ID. When the relay is not activated by an alarm system, the value is 0.


Command Command= InputStatus

Parameter1 InputID=x x is the input reference ID

DN1327-1004 61


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.

Returned data:


Result



Parameter1 ControllerExist=xController defined, x can be:• No• Yes


Parameter3 InputExist=xInput is defined, x can be:• No• Yes

Parameter4 State=x

Input state, x can be:• Normal• NormalNotSupervised• Alarm• AlarmNotSupervised

Parameter5 Supervision=x

Zone supervision, x can be:• Normal• Continuous• None• Reverse

Parameter6 Armed=xZone is armed, x can be:• No• Yes


Command Command= AlarmSystemStatus

Parameter1 AlarmSystemID=x x is the alarm system reference ID

DN1327-100462

5.94 AreaStatus (Global only)This command gets the status of an area according to its identifier.

Returned data:

5.95 GuardTourStatus (Global only)This command gets the status of a guard tour according to its identifier.

Returned data:


Result



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


Command Command= AreaStatus

Parameter1 AreaID=x x is the area reference ID


Result



Parameter1 State=x Status of the area, x = OPEN or CLOSE


Command Command= AreaStatus

Parameter1 GuardTourID=x x is the guardTour reference ID

DN1327-1004 63


5.96 GetLastTransactionCardThis command gets the … TBD

Returned data:

5.97 GetReportEmailThis command gets the … TBD

Returned data:


Result



Parameter1 State=x Status of the area, x = OPEN or CLOSE


Command C ommand=GetLastTransactioncard

ProcessCMDGetLastTransactionCardParameter1

ProcessCMDGetLastTransactionCard ProcessCMDGetLastTransactionCard


Result



Parameter1 EventCard=x

Parameter2 DoorDescription=x

Parameter3 TransactionDate=x


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

DN1327-100464

5.98 ConnectSiteThis command sends a connection request to a site.

Returned data:

5.99 DisconnectSiteThis command sends a disconnection request to a site.

Returned data:

5.100 UpdateRemoteSiteThis command calls one site with modified data.

Returned data:


Result




Command Command= ConnectSite

Parameter1 SiteId=x x is the Site Reference ID


Result




Command Command= DisconnectSite



Result




Command Command= UpdateRemoteSite


DN1327-1004 65


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

Returned data:

5.102 UpdateAllSiteThis command calls all gateway sites with modified data.

Returned data:

5.103 ExecuteTaskThis command asks the server to execute a specific task.

Returned data:


Result




Command Command=UpdateRemoteSiteGateway

Parameter1 GatewayId=x x is the Gateway reference ID


Result




Command Command= UpdateAllSite


Result




Command Command= ExecuteTask

Parameter1 TaskId=x x is the task id

DN1327-100466

5.104 BatchModifyThis command modifies a batch of cards.

Returned data:

Parameter2 to parameter14 are optional according to the requested process.

5.105 GetDescriptionThis command gets the description of a specific component.

Returned data:


Result




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


Result




Command Command= GetDescription

Parameter1 PkData=x x is the Component reference ID

DN1327-1004 67


5.106 EmailPasswordThis command emails a password.

Returned data:

5.107 ChangePasswordThis command changes the password for a specific operator.

Returned data:

5.108 GetCardAccessGroupThis command gets the card access group information.

Returned data:


Result




Command Command= EmailPassword

Parameter1 Email=x x is the email address


Result




Command Command= GetDescription

Parameter1 OldPassword=x x is the Old password string

Parameter2 NewPassword=x x is the New password string


Result




Command Command= GetCardAccessGroup


DN1327-100468

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

Returned data:

5.110 AddToTriggerThis command adds a component filter to a trigger.

Returned data:


Result



Parameter1 Description=x Return the card access group description in the current language.

Parameter2 AccessLevel= “x \t y” x = Reference Id for the Gateway global or the sitey = Reference Id for the Access Level

ParameterN AccessLevel=… … repeat for each access level as required


Command Command=GetAccessLevelDescription



Result



Parameter1 Description=x Returns the field description in the current language.

Parameter2 AccessLevel= “a \t b \t c \t d \t e \t f”

a = PkDatab = Descriptionc = Links to schedule (Unique ID)d = description of data schedulee = Links to floor group (Unique ID)f = Description of floor group

ParameterN AccessLevel=… … repeat for each access level as required


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

DN1327-1004 69


5.111 RemoveFromTriggerThis command removes a component filter to trigger.

Returned data:

5.112 GetListThis command gets a list of component.

Returned data:


Result




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)


Result




Command Command= GetList

Parameter2 ComponentId=x

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 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

DN1327-100470

5.113 GetListOwnerByThis command gets a list of components.

Returned data:

5.114 GetListGraphicUrlThis command gets a list of graphic Urls.


Result



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


Command Command= GetListOwnerBy



Parameter2 ListOwner=x x is the List Owner reference ID (may be optional)

Parameter3 ListFilter=x x is the text filter (may be optional)


Result




Parameter2 Owner=x x is the owner reference Id

Parameter3 Object=x x is the object Id


ParameterN Parameter1-2-3-4=… … repeat for each element as required

DN1327-1004 71


Returned data:

5.115 GetFindThis command gets a list of component specific parameters.


Command Command= GetListGraphicUrl


Result





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) ?


Command Command= GetFind



Parameter2 ListNumberToRead=x x is the number to read (may be optional) default is 1000

Parameter3 ListFilterType=x x is the filter type = ListBegin or ListContain (may be 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.

Parameter6 ListIndex=x

x is the list index and could be =For Card: CardNumber, UserName, CardInfo1, CardInfo2, CardInfo3, CardInfo4, CardInfo5, CardInfo6, CardInfo7, CardInfo8, CardInfo9, CardInfo10

DN1327-100472

Returned data:

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

Returned data:

5.117 AddHolidayThis command adds a holiday in the system.


Result



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)



Command Command= GetFindNext

Parameter1 ComponentId=x x is the Component filter unique ID

Parameter2 ListNumberToRead=x x is the number to read (may be optional) default is 1000

Parameter3 ListFilterType=x x is the filter type = ListBegin or ListContain (may be 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.

Parameter6 ListIndex=x

x is the list index and could be =For Card: CardNumber, UserName, CardInfo1, CardInfo2, CardInfo3, CardInfo4, CardInfo5, CardInfo6, CardInfo7, CardInfo8, CardInfo9, CardInfo10


Result



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)


DN1327-1004 73


Returned data :

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

Returned data


Command Command= AddHoliday

Parameter1 GatewaySiteId=x x specifies the gateway or Site Reference. x can be 0 for global holiday

Parameter2 PrimaryName=x Maximum of 40 characters, field is optional, default is “New holiday”

Parameter3 SecondaryName = x Maximum of 40 characters, field is optional, default is “New holiday”

Parameter4 HolidayDate=YYYY/MM/DDYYYY = Year, MM = Month, DD = DayInvalid date will use day 0 (1899/12/30)Field is optional, default is the current day

Parameter5 HolidayRange=x

x can be:• 1 = Holiday1• 2 = Holiday2• 3 = Holiday3• 4 = Holiday4Field is optional, default is 1

Parameter6 HolidayRecurring =xx = Yes or NoAnything else is considered as a NoField is optional, default is No


Result


Most common returned values:0= SMARTLINK_COMMAND_OK

Parameter1 HolidayID=x Return the Holiday ID reference number needed to modify or delete


Command Command=ReadHoliday

Parameter1 HolidayID=x x is the Holiday ID reference number


Result



Parameter2 to Parameter6 Same as in section 72: AddHoliday

DN1327-100474

5.119 ModifyHolidayThis command modifies a holiday in the system according to its reference number.

Returned data

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

Returned data:

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


Command Command=ModifyHoliday


Parameter2 to Parameter6 Same as in section 72: AddHoliday


Result




Command Command= DeleteHoliday



Result



DN1327-1004 75


Returned data :

5.122 GetScheduleThis command gets a schedule from the system.


Command Command= AddSchedule

Parameter1 GatewaySiteId=xx specifies the gateway or Site Reference. x is ignored when advanced schedule capability is disabled. x can be 0 for global holiday

Parameter2 PrimaryName=x Maximum of 40 charactersField is optional, default is “New schedule”

Parameter3 SecondaryName = x Maximum of 40 charactersField is optional, default is “New schedule”

Parameter4 Interval = x Specify the interval, x is from 1 to 4

Parameter5 StartTime=xx is the time in minutes from 0 to 1440 minutes where 1440 is for 24:00Field is optional, default is 0

Parameter6 EndTime=xx is the time in minutes from 0 to 1440 minutes where 1440 is for 24:00Field 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)




Parameter18 Interval=x Specify the next interval, x is from 1 to 4

Parameter19 StartTime=x x is the time in minutes from 0 to 1440 minutes where 1440 is for 24:00. Field is optional, default is 0

Parameter20 EndTime=x x is the time in minutes from 0 to 1440 minutes where 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


Result



Parameter1 ScheduleID=x Return the schedule ID reference number needed to modify or delete

DN1327-100476

Returned data :

5.123 ModifyScheduleThis command modifies a schedule in the system.

Returned data :

5.124 DeleteScheduleThis command deletes a schedule in the system.

Returned data :


Command Command=GetSchedule

Parameter1 ScheduleID=x x is the Schedule ID reference number


Result



Parameter2 AllValid=x 0 = No1 = Yes

Parameter2 to ParameterN Same as in section 74: AddSchedule


Command Command=ModifySchedule

Parameter1 ScheduleID=x x is the schedule ID reference number

Parameter2 to ParameterN same as in section 74: AddSchedule


Result




Command Command=DeleteSchedule Schedule ID reference number

Parameter1 ScheduleID=x x is the schedule ID reference number

DN1327-1004 77


5.125 AddAccessLevelThis command ad ds an access le vel i n the system. A maximum of 250 access le vels can b eprogrammed in a site.

Returned data :

5.126 GetAccessLevelThis command gets an access level from the system.

Returned data :


Result




Command Command= AddAccessLevel

Parameter1 GatewaySiteId=x x specifies the gateway or Site Reference

Parameter2 DefaultScheduleID=xx specifies the default schedule reference for all doors related to the specified site. Field is optional, default is 0 for None

Parameter3 DefaultFloorsGroupId=xx specifies a default floor group reference for all doors related to the specified site.Field is optional, default is 0 for None

Parameter4 PrimaryName=x Maximum of 40 charactersField is optional, default is “New access level”

Parameter5 SecondaryName = x Maximum of 40 charactersField is optional, default is “New access level”

Parameter6 Item=x, y, z

Field is optional x specifies the door reference IDy specifies the schedule reference IDz specifies the floor group ID (optional)

ParameterN Item=…, …, … … repeat for each door as required


Result



Parameter1 AccessLevelID=x Returns the Access level ID reference number needed to modify or delete


Command Command= GetAccessLevel

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

DN1327-100478

5.127 ModifyAccessLevelThis command modifies an access level in the system.

Returned data :

5.128 DeleteAccessLevelThis command deletes an access level in the system.

Returned data :


Result



Parameter1 AccessLevelID=x Returns the access level ID reference number

Parameter2 AllValid=x 0 = No1 = Yes

Parameter3 to ParameterN Corresponds to parameter 4 to N in section 77: AddAccessLevel


Command Command= ModifyAccessLevel

Parameter1 AccessLevelID=x x is the access level ID reference number

Parameter2 to ParameterN Corresponds to parameter 4 to N in section 77: AddAccessLevel


Result




Command Command= DeleteAccessLevel Schedule ID reference number

Parameter1 AccessLevelID=x x is the access level ID reference number


Result



DN1327-1004 79


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 tuputility.

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

Optional 1 ConnectionType=x UChar0=Direct (default), 1=TCP/IP, 2=Modem

Optional 1 SerialPort=x UCharAlso referred as the “Com port” within the FastSetup: 1=COM1(default), 2=COM2, …, 99=COM99

Optional 1 BaudRate=x UChar

Also referred as the “Loop speed” within the FastSetup:0=115200, 1=57600, 2=38400, 3=19200 (default),4=9600, 5=4800, 6=2400, 7=1200.

Optional 1 UseProtocol=x UChar 0=TCP/IP (default), 1=UDP/IP.

Optional 1 IpAddress=x Str[16] Doted string type as “127.0.0.1” (each number must be separated by “.”)

Optional 1 IpPort=x Int

Optional UseDayLightSavingTime=x UChar 0=Don’t use day light1=Use day light (default)

Optional FloatTimeAdjustement=x Float -12.0 to +12.0 (0.5 increment), default 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

Optional PhoneLineType=x UChar 0 = Tone (default)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-100480

Optional ReportEventsAutomatically=x Int Links to schedule ID

Optional FailToReportAfter=x Int 60 to 3599 seconds, default is 300

Miscellaneous

Optional CallbackForConnection=x UChar 0 = no call1= 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

Optional AfterReceptionStayOnLineFor=x UChar 0 = don’t stay on line1= Stay on line (default)

Optional DisconnectLineAfter=x Int 60 to 86399 seconds, default is 180

Optional CallImmediatelyWhenSlaveFailure=x UChar 0 = no call1 = call (default)

Optional CallImmediatelyWhenbuffer70Full=x UChar 0 = no call1 = call (default)

Setup timings

Optional ResponseTimeoutRatio=x Int

1 to 40,Default in DIALUP = 7Default in TCPIP =5Default in RS232 = 1

Optional PollingFrequency=x Int0 to 40Default in TCPIP =5Default 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



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 4Fast Setup Optional

FastSetup 1 ReaderDriverName=x Str[40] Optional field, default is taken from the server file DefCorReaDriver.DRV.

Controllers (part of FastSetup)Optional (repeat for as many controllers as needed)

DN1327-1004 81


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

Returned data :

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

Returned data

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

FastSetup 2 ControllerItem= Number,Name, SN,SameDoor, Passback

Number: Controller number (1 to 32) mandatoryName: 40 char max, (optional), no “,” allowed in the name, default = “Controller #n”SN: serial number, (optional), default 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.


Result



Parameter1 SiteID=x Return the site ID reference number

Controller1 ControllerID=x,y X is the controller number, Y is the controller ID reference number field is optional.

ControllerN ControllerID=n,y This field repeats for as many controllers as defined (as above).


Command Command=GetSite

Parameter1 SiteID=x x is the site ID reference number


Result



Parameter2 HowManyController=x 0 to 32

Parameter N Same as for the optional parameter fields in section 79: AddSite (FastSetup)

DN1327-100482

Returned data

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

Returned data

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


Command Command=ModifySite


Optional Same as for the optional parameter fields in section 79: AddSite (FastSetup)


Result




Command Command= DeleteSite

Parameter1 SiteID=x X is the site ID reference number


Result



Field Keyword & format Type Detail

Command Command =AddController

Parameter1 SiteID=x x specifies the Site Reference

General

Optional PrimaryName=x Str[40] Field is optional, default is “New controller” (40 characters max)

Optional SecondaryName=x Str[40] Field is optional, default is “New controller” (40 characters max)

Optional Graphic=x Int Links to graphic ID

Optional VideoView=x Int Links to VideoView ID

DN1327-1004 83


Optional ControllerKtType=x UChar

0 = KT-2001 = KT-300 (Default and the only one supported for now)2 = KT-1003 = KT-NCC4 = Unknown

Optional DisableController=x UChar 0 = Controller enabled1 = Controller disabled

Optional ReaderDriverName=x Str[40]Name of the first reader type, the field is optional. If nothing is provided, the default reader will be taken from the server file DefCorReaDriver.DRV.

Optional ReaderDriverName2=x Str[40]

Name of the second reader type, the field is optional. If nothing is provided, the default reader will be taken from the server file DefCorReaDriver.DRV.

Optional KeypadType=x UChar

0 = KP-1003H1 = KP-500, KP-2000, KP-2500, KP-30002 = P555KP, KP-1000, SH-2KP, HID-PR5355KP3 = POL-2KP 5 digits Integrated Keypad4 = None

KT-300

Optional SerialNumber=x Str[8] Field is optional. If nothing is provided, the default is 00000000

Optional PowerFailureLocalActivation=x Int Links to relay

Optional PowerFailurePriorityCall=x UChar0 = No Call1 = Immediate call2 = Scheduled call

Optional CombusFailureLocalActivation=x Int Links to relay

Optional CombusFailurePriorityCall=x UChar0 = No Call1 = Immediate call2 = Scheduled call

Optional CombusTroubleLocalActivation=x Int Links to relay

Optional CombusTroublePriorityCall=x UChar0 = No Call1 = Immediate call2 = Scheduled call

Optional WaitForSecondAccessCard=x UChar 1 to 127

Optional KeypadEscapeKey=x UChar

0 = None1 = 0 to 10 = 9,11 = *12 = #

Optional InputResistorType=x Int 0 = No resistor1 = Single resistor

Options

Optional DuressOnAccessGranted=x UChar 0 = No duress1 = Duress

Optional DuressOnAccessDenied=x UChar 0 = No duress1 = Duress

Optional TypeAntiPassback=x UChar0 = None1 = Soft anti-passback2 = Hard anti-passback

Optional ForgiveSchedule=x Int Links to schedule

Optional EnableFailsoftDelay=x Int 10 to 255

DN1327-100484

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

Setup SelectAll=x UChar 0 = Don’t force all controller’s components (default)1 = Force all controller’s components

Basic Express Setup

Optional

Basic1ExpressSetup= SameDoor, Door1Contact, Door1Rex, Door2Contact, Door2Rex

Defines the components as per Express Setup.This field is optional. Same as in Workstation.SameDoor: 0=No (Default), 1 or non 0=YesDoor1Contact: 0=No (Default), 1 or non 0=YesDoor1Rex: 0=No (Default), 1 or non 0=YesDoor2Contact : 0=No (Default), 1 or non 0=YesDoor2Rex: 0=No (Default), 1 or non 0=Yes

Advanced Express Setup

Optional

AdvanceDoor=number,PrimaryName, SecondaryName,Type,Lock, Contact,RequestExit

Defines the door as per Advanced Express SetupThis field is optional, repeat for as many doors.Number: specifies the door (1 or 2)PrimaryName: optional, 40 char max. SecondaryName: optional, 40 char max.Type: 0=Access (default), 1=Entry, 2=ExitLock (device): 0=doorLock (default), 1=MagneticLock Contact: 0=No, 1=YesRequestExit: 0=No, 1=Yes

AdvanceInput=Number,PrimaryName, SecondaryName,State, MonitoringSchedule

Defines the input as per Advanced Express SetupThis field is optional, repeat for as many inputs.Number: specifies the Input (1 to 8)PrimaryName: optional, 40 char max. SecondaryName: optional, 40 char max.State: optional, 0=Closed (default), 1=OpenedMonitoringSchedule: optional, specifies the schedule ID, the default is always.

Advance Output=Number, PrimaryName, SecondaryName, Mode, Door

Defines the output as per Advanced Express SetupThis field is optional, repeat for as many outputsNumber: specifies the Output (1 to 4)PrimaryName: optional, 40 char max. SecondaryName: optional, 40 char max.Mode of operation (optional): 0=Normal (default), 1=Inversed Door (optional): 0=Door#1 (default), 1=Door#2, 2=Door#1 & #2

DN1327-1004 85


Returned data :

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

Returned data

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

Returned data

Advance Relay=Number, Mode, Activation, Disable

Defines the relay as per Advanced Express SetupThis field is optional, repeat for as many relays.Number: specifies the relay (1 to 2)PrimaryName: optional, 40 char max. SecondaryName: optional, 40 char max.Mode: 0=Normal, 1=ReverseActivation: Activation Schedule IDDisable: Disable Relay Action Schedule ID


Result



Parameter1 ControllerID=x Returns the newly created Controller ID reference number.


Command Command=GetController

Parameter1 ControllerID=x x is the Controller ID reference number


Result



Parameter N Same as for the optional parameter fields in section 82: AddController (ExpressSetup)


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)

DN1327-100486

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

Returned data

5.137 GetDoorThis command gets a door from the system.

Returned data :


Result




Command Command= DeleteController

Parameter1 ControllerID=x X is the controller ID reference number


Result




Command Comman d=GetDoor

Parameter DoorID=x Int x specifies the door reference


ResultSee section 17: Returned Format for format details.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)

Parameter DoorLockMode=x UChar 0 = Fails-Secure1 = Fails-Safe

Parameter UnlockTime=x UShort 1 to 255

Parameter OpenTime=x UShort 1 to 255

Parameter DoorType=x UChar0 = Access1 = Entry2 = Exit

Parameter TimeAndAttendance=x UChar 0 = No Time and attendance 1 = Time and attendance

DN1327-1004 87


Parameter ElevatorCab=x UChar 0 = No Elevator Cab1 = 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

Parameter ReaderKeypad=x UChar0 = Reader Only1 = Keypad Only2 = 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

Parameter DoorOpenReading=x UChar 0 = No read1 = Read

Parameter DoorUnlockReading=x UChar 0 = No read1 = Read

Parameter PreAlarmOnDoorOpenTooLong=x UChar 0 = No Pre-alarm1 = Pre-Alarm

Parameter OnAccessRelock=x UChar 0 = On Door Opening1 = On Door Closing

Rex

Parameter OnRexRelock=x UChar 0 = On Door Opening1 = On Door Closing

Parameter RexContact=x Int Links to input

Parameter RexSchedule=x Int Links to schedule

Parameter UnlockOnRex=x UChar 0 = No unlock1 = Unlock

Parameter ResettableRexFunction=x UChar 0 = No restart1 = Restart

Parameter SecondaryRexContact=x Int Links to input

Parameter SecondaryRexSchedule=x Int Links to schedule

Parameter SecondaryUnlockOnRex=x UChar 0 = No unlock1 = Unlock

Parameter SecondaryResettableRexFunction=x UChar 0 = No restart1 = Restart

Miscellaneous

Parameter InterlinkContact=x Int Links to input

Parameter EnableDuressFunction=x UChar 0 = No duress1 = Duress

Parameter NoUnlockByInputWhenArmed=x UChar 0 = Unlock, 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-100488

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

Parameter SuperviseDoorLockDevice=x UChar 0 = Supervised1 = not supervised

Parameter UlockDoorBySchedulesAfterFirstManIn=x Int 0 = No unlock1 = Unlock

Parameter MotorLockDelay=x UChar 0 to 255

Parameter RequireSecondCardSchedule=x Int Links to schedule

Door events

Parameter DoorForcedOpenLocalActivation=x Int Links to relay

Parameter DoorForcedOpenPriorityCall=x UChar0 = do not call1 = call Immediately2 = call when scheduled

Parameter DoorOpenTooLongLocalActivation=x Int Links to relay

Parameter DoorOpenTooLongPriorityCall=x UChar0 = do not call1 = call Immediately2 = call when scheduled

Parameter DoorAlarmOnRelockLocalActivation=x Int Links to relay

Parameter DoorAlarmOnRelockPriorityCall=x UChar0 = do not call1 = call Immediately2 = call when scheduled

Access Events

Parameter AccessGrantedLocalActivation=x Int Links to relay

Parameter AccessGrantedPriorityCall=x UChar0 = do not call1 = call Immediately2 = call when scheduled

Parameter CardTracedLocalActivation=x Int Links to relay

Parameter CardTracedPriorityCall=x UChar0 = do not call1 = call Immediately2 = call when scheduled

Parameter InvalidCardStatusLocalActivation=x Int Links to relay

Parameter InvalidCardStatusPriorityCall=x UChar0 = do not call1 = call Immediately2 = call when scheduled

Parameter BadAccessLevelLocalActivation=x Int Links to relay

Parameter BadAccessLevelPriorityCall=x UChar0 = do not call1 = call Immediately2 = call when scheduled

Parameter OtherAccessDeniedLocalActivation=x Int Links to relay

Parameter OtherAccessDeniedPriorityCall=x UChar0 = do not call1 = call Immediately2 = call when scheduled

Parameter DuressAlarmLocalActivation=x Int Links to relay

Parameter DuressAlarmPriorityCall=x UChar0 = do not call1 = call Immediately2 = call when scheduled

Parameter ExtendedDoorAccessDelayLocalActivation=x Int Links to relay

DN1327-1004 89


Parameter ExtendedDoorAccessDelayPriorityCall=x UChar0 = do not call1 = call Immediately2 = call when scheduled

Arming Request

Parameter ArmingRequestInput=x Int Links to input

Parameter WaitForAccessGrantedToArm=x UChar 0 = No wait1 = Wait

Parameter RelockDoorOnRequestToArm=x UChar 0 = No relock1 = Relock

Parameter PreventArmingRequestOnInputStatus=x UChar 0 = Arm1 = Prevent arming

Parameter KeypadButton=x UChar0 = none, 1=0 to 10=9, 11 = *, 12 = #

Parameter EnableArmingRequestSchedule=x Int Links to schedule

Parameter ArmingAccessLevel=x Int Links to Access level (single or group see IdAccesslevelArmRequest)

Parameter SingleGroupArmRequest=x UChar0 = No component link1 = Links to single component2 = Links to group component

Parameter ExitDelay=x UShort 0 to 32767

Parameter EntryDelay=x UShort 0 to 32767

Parameter ExternalAlarmSystemPanel=x Int Links to inputInput

Parameter Supervised=x UShort0 = Not supervised1 = Supervised(for each 16 inputs)

Parameter ShuntedOnDisarm=x Int0 = No shunt1 = Shunted (for each 16 inputs)

Parameter ShuntedOnExit=x Int0 = No shunt1 = Shunt(for each 16 inputs)

Parameter ShuntedOnDelay=x Int 0 = unchecked, 1 = checked (for each 16 inputs)

Postpone Arming

Parameter InputToPostponeArming=x Int Links to input

Parameter EnablePostponeArmingSchedule=x Int Links to schedule

Parameter WaitForAccessGrantedToPospone=x UChar 0 = No wait1 = Wait

Parameter KeypadButtonPostpone=x UChar0 = none, 1=0 to 10=9, 11 = *, 12 = #

Parameter PostponeOrDisarmAccessLevel=x Int Links to access level (see IdAccesslevelPostpone)

Parameter SingleGroupAccessLevelPostpone=x UChar0 = No component link1 = Links to single component2 = Links to group component

Relay

Parameter AlarmRelay=x Int Links to relay

Parameter ActivationType=x UChar Relay activatedRelay temporary activated

DN1327-100490

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

Returned data

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

5.140 GetRelayThis command gets a relay from the system.

Returned data :

Parameter PriorityCallType=x UChar0 = No call1 = Immediate call2 = scheduled call

Parameter InputStatus=x Int Links to relay

Parameter WorkWhenSystemArmed=x UChar 0 = No work1 = 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

Parameter PriorityCallTypeArm=x UCharNo callImmediate callscheduled call


Command Command=ModifyDoor

Parameter DoorID=x x specifies the door reference

Parameter Same as for the parameter fields within the return section 86: GetDoor


Result




Command Command= DeleteDoor

Parameter1 DoorID=x x is the door ID reference number


Command Comman d=GetRelay

Parameter RelayID=x x specifies the relay reference number

DN1327-1004 91


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

Returned data

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

5.143 GetInputThis command gets an input from the system.

Returned data :


Result



Parameter PrimaryName=x Str[40] default is “New relay” (40 char max)

Parameter SecondaryName=x Str[40] default is “New relay” (40 char max)

Parameter OperationMode=x UChar 0 = Normal1 = Inverse

Parameter ActivationSchedule=x Int Links to schedule

Parameter TempoActivationTimer=x Int 1 to 255

Parameter DeactivationSchedule=x Int Links to schedule


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


Result




Command Command= DeleteRelay

Parameter1 RelayID=x x is the relay ID reference number


Command Comman d=GetInput

Parameter1 InputID=x x specifies the input reference

DN1327-100492

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


Result



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

Parameter ActivateRelay=x Int Links to Relay (single or group, see IdInputActivateRelay)

Parameter SingleGroupRelay=x UChar0 = No component link1 = Links to single component2 = Links to group component

Parameter ActivateRelayTemporarily=x UChar 0 = No activation1 = Activation

Parameter KeepRelayActivated=x Int 0 to 65535

Parameter TemoraryShuntTimer=x Int 0 to 32767

Parameter ShuntInput=x Int Links to input (single or group see IdInputShuntInput)

Parameter SingleGroupInput=x UChar0 = None component link1 = Links to single component2 = Links to group component

Parameter ShuntInputTemporarily=x UChar 0 = No shunt1 = Shunt

Parameter ResetDelayForShuntTemporarily=x UChar 0 = No reset

1 = Reset

Parameter DelayBeforeUnshunt=x UShort 0 to 32767

Elevator

Parameter SelectCab=x UChar

0 = No Selection1 = Cab #12 = Cab #23 = 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

Parameter InputInAlarmPriorityCall=x UChar0 = do not call1 = call Immediately2 = call when scheduled

DN1327-1004 93


Returned data

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

5.146 GetOutputThis command gets an output from the system.

Returned data :


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


Result




Command Command= DeleteInput

Parameter1 InputID=x x is the input ID reference number


Command Comman d=GetOutput

Parameter1 OutputID=x x specifies the output reference


Result



Parameter PrimaryName Str[40] default is “New Output” (40 char max)

Parameter SecondaryName Str[40] default is “New Output” (40 char max)

Parameter OperationMode UChar 0 = Normal1 = Inverse

Parameter SelectedDoor UChar0 = Door #11 = Door #22 = Door #1 and Door #2

Parameter ActivationPeriod UChar 1 to 255

DN1327-100494

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

Returned data

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

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

Returned data :

Parameter Event=x,y UChar[32]

x is the event number(0 to31), repeat for each event y is the event status:0 = None1 = Steady Timed2 = Flash Timed3 = Steady4 = Flash


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


Result




Command Command= DeleteOutput

Parameter1 OutputID=x x is the Output ID reference number


Command Command=GetSiteS tructure

Parameter1 SiteId=x X is the requested site ID

DN1327-1004 95


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

5.150 GetSiteCardThis command retrieves all cards from a specific site.

Returned data

5.151 AddAccountThis command adds an account in the system.


Result



For each controller this block repeats

Repeats for as many controllers

ControllerId=x,y,z Controller=rank, y=ID, z=defined (0 or 1)

DoorId=x,y,z Door: x=rank, y=ID, z=definedDoes repeat for as many doors

RelayId=x,y,z Door: x=rank, y=ID, z=definedDoes repeat for as many relays

InputId=x,y,z Door: x=rank, y=ID, z=definedDoes repeat for as many inputs

OutputId=x,y,z Door: x=rank, y=ID, z=definedDoes repeat for as many outputs

Holidays (outside previous controller block)

HolidayId=y,z Holiday: y=ID, z=definedDoes repeat for as many holidays

Schedule

ScheduleId=y,z Schedule: y=ID, z=definedDoes repeat for as many schedules

Access Level

AccessLevelId=y,z Access Level: y=ID, z=definedDoes repeat for as many access levels


Command Command=GetSiteCard



Result



TBD…

DN1327-100496

Returned data :

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

Returned data


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.




















Parameter24 Comment = x Default is empty, field is optional, 255 digits max.


Result



Parameter1 AccountID=x Return the Account ID reference number


Command Command=GetAccount

Parameter1 AccoutID=x x is the account ID reference number

DN1327-1004 97


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

Returned data

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

Returned data

5.155 SwitchAccountThis comma nd all ows accessi ng componen ts visi ble o nly from an op erator account wi th th eappropriate rights.


Result



Parameter1 AccountID=x Return the account ID reference number

Parameter 2 to Parameter 24 Same as for parameter fields in section 95: AddAccount


Command Command=ModifyAccount

Parameter1 AccountID=x x is the account ID reference number

Parameter 2 to Parameter 24 Same as for parameter fields in section 95: AddAccount


Result




Command Command= DeleteSite

Parameter1 AccountID=x x is the account ID reference number


Result



DN1327-100498

Returned data


Command Command= SwitchSite

Parameter1 AccountID=xx is the account ID reference number. A value of zero forces a logout of the account. Note that logging out of SmartLink automatically logout from the account.


Result



DN1327-1004 99


6.0 - SmartDllThis DLL allows connecting to SmartLink in ord er to execute various commands and also to receivemessages 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

extern "C" __declspec(dllexport) long __stdcall Connect (long theSmartlinkTag, char* theIpAddress)

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

65000. This identifier is important for programmed 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

extern "C" __declspec(dllexport) long __stdcall AutomaticConnect (long theSmartlinkTag, char* theIpAddress)

Used with ‘SetLoginPassword’, this function indicates to the DLL to take care of all the connection aspects and the authentication to the server. The ‘SetLoginPassword’ function will process the usual authentication command.

extern "C" __declspec(dllexport) long __stdcall Disconnect ()

This function disconnect the link between the DLL and SmartLink and ends the requesting process

extern "C" __declspec(dllexport) long __stdcall SendData (long theLengthSend, unsigned char* theBufferSend, long* theLengthReceive, unsigned char* theBufferReceive)

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

contains the command to be sent• theLengthReceive: Receiving space length. Upon

completion, the system will indicate the number of 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-1004100

extern "C" __declspec(dllexport) long __stdcall SendDataPicture (long theLengthSend, unsigned char* theBufferSend, long* theLengthReceive, unsigned char* theBufferReceive, char* thePicture)

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• theLengthReceive: Receiving space length. Upon

completion, the system will indicate the number of 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

• 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)


DN1327-1004 101


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

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)


DN1327-1004102

in a visibl e page and the returned parameter will be the selected item in the list. This parameter wil lallow for the selected component’s ’UniqueID’ to be returned.


extern "C" __declspec(dllexport) long __stdcall ShowCard (long theSize, char* theCard, char* theSource, long theIndex)

• 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: SMARTLINK_INVALID_OUTPUT_LENGTH

• theSource: Characters string used as a filter. The desired value should begin with the characters string

• theIndex: The search index• 0: User name• 1 to10: Configurable fieldsThis function can retreive the data of a card and save it in a file

extern "C" __declspec(dllexport) long __stdcall ShowAllCard (char* theFileName, long theIndex)

• theFileName: Name of the file that contains the results.• theIndex: The search index• 0: User name• 1 to10: Configurable fields

extern "C" __declspec(dllexport) long __stdcall About () Function that returns the DLL version number

extern "C" __declspec(dllexport) long __stdcall GetMessageData (long theLength, long* theMessageLength, unsigned char* theMessage)

• theLength: Receiving space length• theMessageLength : Received message length• theMessage: Pointer on a memory space that receives

information. If the memory space is insufficient, the system will return the following error message: SMARTLINK_INVALID_OUTPUT_LENGTH

DN1327-1004 103


extern "C" __declspec(dllexport) long __stdcall SetPostMessage (long theWnd, long theMsg)

• theWnd : Handle of the window that receives messages• theMsg : Message contentThis function saves the window that receives ‘PostMessage’ sent by the DLL and gives the number used. During a modification, saving messages allows the automatic reception of the following information:• The communication status between the Server and SmartLink• 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 __stdcall SetLoginPassword (long theCommandLength, unsigned char* theCommand)

This function can save a login command so the system can reuse it automatically in case of a disconnection. Note that the initial connection must be performed with the ‘AutomaticConnect’ command

extern "C" __declspec(dllexport) long __stdcall EnableViewActivity ()

extern "C" __declspec(dllexport) long __stdcall DisableViewActivity ()

During the development phase, the function ‘EnableViewActivity’ can be called to display a window showing the internal process details for the commands sent. The function ‘DisableViewActivity’ will stop the process

extern "C" __declspec(dllexport) long __stdcall GetErrorCodeText (long theErrorCode, long theTextLength, unsigned char* theText)

• theErrorCode : Error code number• theTextLength : Length of the characters string that holds the

error code.• theText : Characters string into which the error message text is

copied.This function is used to receive the text corresponding to a specific error code

extern "C" __declspec(dllexport) long __stdcall GetServerState ()

extern "C" __declspec(dllexport) long __stdcall GetSmartLinkState ()

extern "C" __declspec(dllexport) long __stdcall GetLoginState ();

These three functions return the SmartLink status with the server, the link status between the DLL and SmartLink, and the operator’s identification status. The value 0 indicates an abnormal condition while the value 1 indicates either a normal condition or the operator is properly identified with the server

extern "C" __declspec(dllexport) long __stdcall SetConnectionName (char* theName, long theSize)

This function is used to give a name to the connection with SmartLink. The connection name can be viewed by scrolling the user’s list connected to SmartLink or to a workstation

extern "C" __declspec(dllexport) long __stdcall SetBuffersSize (long theUntagBufferSize, long theTagBufferSize)

This function is used to determine the maximum number of messages currently held by SmartLink. There are two types of messages: ’Untag’ messages’ that identify messages not specifically intended for ‘TagConnection’ and ‘Tag’/’Untag’ that identify messages specifically intended for the connection

extern "C" __declspec(dllexport) long __stdcall SetListName (char* theName, long theSize, long theSeparator)

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 value for the field separator and call the ShowOperator function:• theName : Name of the file to be saved• theSize : Length of the theName field• theSeparator : The character used as a field separator. Usually 9

for <Tab> or 44 for a comma


DN1327-1004104

extern "C" __declspec(dllexport) long __stdcall GetComponentDescription (long* theDescriptionSize, char* theDescription, long* theComponent)

This function retrieves the description of a selected component. • theDescriptionSize : The theDescription field length. Returns the

content length of the field• theDescription : Pointer that receives the description of the

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)


DN1327-1004 105


These functions are used to e xecute specific t asks on a specific co mponent easily. However, for al lthese commands, you can always use the ’SendData’ function.

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)


DN1327-1004106


extern "C" __declspec(dllexport) long __stdcall WorkstationStatus (long theComponent, long* theLengthReceive, unsigned char* theBufferReceive)

These functions are used to retrieve the status of a specific component easily. However, for all these commands, you can always use the ’SendData’ function.• theComponent: ‘UniqueId’ of the component for which the status

has to be retreive.• theLengthReceive: Length of the variable that holds the

information. The variable contains the number of characters received

• theBufferReceive: Pointer on a variable into which the received data is placed

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)

extern "C" __declspec(dllexport) long __stdcall DoorStatus (long theComponent, long* theLengthReceive, unsigned char* theBufferReceive)

extern "C" __declspec(dllexport) long __stdcall RelayStatus (long theComponent, long* theLengthReceive, unsigned char* theBufferReceive)

extern "C" __declspec(dllexport) long __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)

DN1327-1004 107


extern "C" __declspec(dllexport) long __stdcall SetPhysicalAddressId (long theParameter)

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• Right: Entry door (04.02.2)• None: Entry door

The Parameter: Possible values are:• SMARTLINK_PHYSICAL_ADDRESS_LEFT = 0• SMARTLINK_PHYSICAL_ADDRESS_RIGHT = 1• SMARTLINK_NO_PHYSICAL_ADDRESS = 2

extern "C" __declspec(dllexport) long __stdcall SetTimeout (long theTimeout, long theDelay)

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) • TIMEOUT_SEND_DATA = 2 ( 15000, 5000)• 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 __stdcall GetRequestCount () Not currently used

extern "C" __declspec(dllexport) long __stdcall BuildLoginPassword (char* theUserName, char* thePassword, long theSize, long* theResultLength, char* theResult)

This function builds the characters string used to login with the opertor’s identifier and password.• theUserName: Operator’s identifier• thePassword: Password• theSize: Length of the characters string for the command’s result• theResultLength: Length of the characters string result• theResult: Characters string that contains the command used to

login into the system

extern "C" __declspec(dllexport) long __stdcall AddComponentToTrigger (long theTriggerId, long theComponentId, long theParameter1, long theParameter2, long* theResultLength, char* theResult)

This command is used to add an item to an existing trigger• theTriggerId: ‘UniqueId’ that identifies the trigger• theComponentId: This field gives the ‘UniqueId’ of the component

to be added to a trigger• theParameter1: Parameter 1 corresponding to the component• theParameter2: Parameter 2 corresponding to the component• theResultLength: Length of the result field• theResult: Field that contains the command’s result

extern "C" __declspec(dllexport) long __stdcall RemoveComponentFromTrigger (long theTriggerId, long theComponentId, long* theResultLength, char* theResult)

This command is used to remove an item from an existing trigger. • theTriggerId: ‘UniqueId’ that identifies the trigger• theComponentId: This field gives the ‘UniqueId’ of the component

to be removed from a trigger• theResultLength: Lengthof the result field• theResult: Field that contains the command’s result


DN1327-1004108

7.0 - Appendix #1, Error messagesThe 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

39 SMARTLINK_COMMANDINVALIDKEYWORD The “command=” keyword is invalid within the command.

DN1327-1004 109


40 SMARTLINK_COMMANDTIMEOUT Timeout while processing the command by the serial port.

41 SMARTLINK_COMMANDWAITINGDATA

42 SMARTLINK_SECURITYRESTRICTED The operator doesn’t have the 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

74 SMARTLINK_CANNOT_PROCESS_GATEWAY_RELOAD

75 SMARTLINK_GATEWAY_COMMAND_NOT_COMPLETED

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-1004110

81 SMARTLINK_NEW_PASSWORD_BAD_SIZE

82 SMARTLINK_REPORT_EMAIL_UNDEFINED

83 SMARTLINK_IMAGE_NOT_SUPPORTED

84 SMARTLINK_CONTROLLER_IN_FAILURE


DN1327-1004 111


8.0 - Appendix #2, EntraPass eventsThe 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-1004112

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


DN1327-1004 113


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-1004114

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


DN1327-1004 115


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-1004116

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


DN1327-1004 117


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-1004118

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


DN1327-1004 119


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-1004120

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










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


DN1327-1004 121


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-1004122

DN1327-1004 123


DN1327-1004124

Documents

SmartLink Reference Manual · DN1327-1004 3 EntraPass SmartLink Reference Manual 2.0 - SmartLink Configuration 2.1 Start-up On start-up, SmartLink sends a request to the server in