SmartLink. Reference Manual. Reference Manual DN

Transcription

1 SmartLink Reference Manual Reference Manual

2 EntraPass SmartLink Reference Manual TABLE OF CONTENTS Introduction Starting the Application SmartLink Configuration Start-up Message Mode (light blue) Command Mode (dark blue) Message Mode Processing List of Message Variables List of Destination Variables Secondary Commands ing Modem and Pager Network Communication Protocol Communication modes Serial Port Command Returned Common error messages Commands Standard Command List Summary Login Logout ConnectionState AddCard ModifyCard DeleteCard GetCardInfo GetCardInfoPicture GetCardPicture SetCardPicture GetCardSignature SetCardSignature GetNip SetNip GetCountUsage SetCountUsage SetCountUsageManual DecCountUsage IncCountUsage ResetCountUsage GetLastAddedCard ArmAlarmSystem (Global only) DisarmAlarmSystem (Global only) PostponeAlarmSystem (Global only) AreaMoveCard (Global only) HardResetController I

3 5.28 SoftResetController ForgiveController ReloadController LockDoor UnlockDoor UnlockTempoDoor ReturnScheduleDoor ToggleDoorStrike LockDoorGroup UnlockDoorGroup UnlockTempoDoorGroup ReturnScheduleDoorGroup ArmDoor DisarmDoor ArmDoorGroup DisarmDoorGroup DeactivateRelay ActivateRelay ActivateTempoRelay ReturnScheduleRelay ToggleRelayActivation DeactivateRelayGroup ActivateRelayGroup ActivateTempoRelayGroup ReturnScheduleRelayGroup UnshuntInput ShuntInput ShuntInputTempo SuperviseInput ReturnScheduleInput ToggleInputShunt UnshuntInputGroup ShuntInputGroup ShuntTempoInputGroup SuperviseInputGroup ReturnScheduleInputGroup EnableDoor DisableDoor EnableDoorGroup DisableDoorGroup LockElevatorDoor UnlockElevatorDoor UnlockTempoElevatorDoor ReturnScheduleElevatorDoor LockElevatorDoorGroup UnlockElevatorDoorGroup UnlockTempoElevatorDoorGroup ReturnScheduleElevatorDoorGroup EnableElevatorDoor DisableElevatorDoor EnableElevatorDoorGroup DisableElevatorDoorGroup II

4 EntraPass SmartLink Reference Manual 5.80 EnableFloorElevatorDoor DisableFloorElevatorDoor EnableFloorElevatorDoorGroup DisableFloorElevatorDoorGroup WorkstationStatus GatewayStatus SiteStatus ControllerStatus DoorStatus RelayStatus InputStatus OutputStatus (Not implemented) AlarmSystemStatus (Global only) AreaStatus (Global only) GuardTourStatus (Global only) GetLastTransactionCard GetReport ConnectSite DisconnectSite UpdateRemoteSite UpdateRemoteSiteGateway UpdateAllSite SmartDll Appendix #1, Error messages Appendix #2, EntraPass events III

5 1.0 - Introduction EntraPass SmartLink Reference Manual The SmartLink option is available with EntraPass Corporate and Global editions and provides optimal automated monitoring tools to security, monitoring, configuration and automation administrators. One of the main features consists in creating SmartLink instructions (events generator) through which, for example, s are sent to a predefined recipient when predetermined alarm events such as a door forced or card trace occur. 1.1 Starting the Application SmartLink allows for many operations to be carried out with an unlimited number of events. For such purposes, the EntraPass interface is sufficient. However, for a wider and more specialized range of options, SmartLink can be used apart from the EntraPass interface, as a stand alone program (.exe file). A Customer Software Developper may interface directly with SmartLink using a provided DLL called SmartDLL. From the EntraPass interface, the SmartLink operation can be invoked through the Definition tab 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: 1

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

7 2.0 - SmartLink Configuration 2.1 Start-up EntraPass SmartLink Reference Manual On start-up, SmartLink sends a request to the server in order to retrieve the connection options for serial output and network modes. Following that request, if the SmartLink network connection mode is other than None, the network server will start-up to allow a client application to connect, either to execute network commands or to receive messages sent over the network, or both simultaneously. A macro is included in this request and will be executed at start-up (yellow). It is defined on the workstation (green) and can be used to open the bidirectional or unidirectional serial output, or any other valid SmartLink command. Another macro is used to manage messages when no macro is specified. 2.2 Message Mode (light blue) To enable the message sending functionality from the serial or network output, SmartLink must be properly configured from the workstations: Sending messages from the serial output : Option on screen : Smartlink serial connection = Messages only or Messages and Commands. Sending messages from the network output : Option on screen : Smartlink network connection = Messages only or Messages and Commands. 2.3 Command Mode (dark blue) To enable the command sending functionality (bidirectional mode) through the serial or the network output, SmartLink must be properly configured from the workstations: Commands from the serial output : Option on screen : Smartlink serial connection = Commands only or Messages and Commands. Commands from the network output : Option on screen : Smartlink network connection = Commands only or Messages and Commands. 3

8 3.0 - Message Mode Processing The message mode allows redirecting formatted data to a selected location : write on the hard disk, a diskette or CD/DVD (see : $v) send through a serial port (com1, com2..) (see : $u) send through a modem (modem link) (see : ~m) send through a modem (digital pager) (see : ~m) send through an (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 special care should be taken when defining an instruction, particularly for processing through a modem. Example: During a modem connection (function : Dial), it is better not to define a number of connection trials too high. Otherwise, SmartLink will wait for an established connection or for the connection delay or the number of trials to expire. EntraPass Server Connection Id 1000 Connection Id 2000 Connection Id 3000 Connection Id 4000 SmartLink Network Id = 1000 Id = 2000 Id = 3000 Id = 4000 RS-232 Modem Pager Disk or CD 4

9 EntraPass SmartLink Reference Manual 3.1 List of Message Variables Variable Description $a Year (4 characters) $b Month (2 characters) $c Day (2 characters) $d Hour (2 characters) $e Minute (2 characters) $f Second (2 characters) $g Event number (4 characters) $h Event text (up to 50 characters) $l1 Number of indexes #1 fixed (2 characters) $m1 Text of index #1 $n1 Number of fields #1 $o 1 Text of field #1 $l2 Number of indexes #2 (2 characters) $m2 Text of index #2 $n2 Number of fields #2 $o2 Text of field #2 $l3 Number of indexes #3 (2 characters) $m3 Text of index #3 $n3 Number of fields #3 $o3 Text of field #3 $l4 Number of indexes #4 (2 characters) $m4 Text of index #4 $n4 Number of fields #4 $o4 Text of field #4 $z0 Card number $z1 Card user name $z2 Card Information field #1 $z3 Card Information field #2 $z4 Card Information field #3 $z5 Card Information field #4 $z6 Card Information field #5 $z7 Card Information field #6 $z8 Card comment field $z9 Card Information field #7 $za Card Information field #8 $zb Card Information field #9 $zc Card Information field #10 The EntraPass Command Editor can be used to generate the code needed to execute the operation. 5

10 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 23 Input group 6

11 EntraPass SmartLink Reference Manual Index Number Index Text 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 7

12 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 inclusive. ex : $r25$r $r begins and ends the command. If the identifier s value = 0, then send to all clients Reset of the serial output and communication speed for bidirectional $s ex : $s com1:9600$s $s begins and ends the command $t Restore SmartLink mode previously saved $u Reset of the serial output and communication speed for unidirectional ex : $u com1:9600$u $u begins and ends the command This command activates the serial output mode Defines a file for future writing use ex : $vc:\ep_2000.inf$v $v the file is c:\ep_2000.inf $v begins and ends the command This command activates the disk writing mode $w Close the file previously opened with $v...$v Write the data on the hard disk Forced writing of the opened file (close / open) $x if the disk writing mode is not enabled, nothing will be processed The EntraPass Command Editor can be used to generate the code needed to execute the operation. 8

13 EntraPass SmartLink Reference Manual 3.3 Secondary Commands Command Description <xxxx> Processing of a numeric value (xxxx = numeric value to be inserted fully) text Processing of a character string (all characters between quotation marks ( ) will be inserted fully) : Insert a carriage return and a line feed The following commands must be inserted between the character $ and the command s letter. Command [xxx Description Processes 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 Processes characters on the right only (xxx = indicates the number of characters to keep in the ]xxx command s characters string) Ex: $[10z1 only the first 10 characters from the right will be kept { Deletes spaces at right of text + - ~w xxxxxxx xx ~l x Increments the command s numeric value Ex: $+c the current day s value is incremented of 1 Decrements the command s numeric value Ex: $-g the event s number value is decremented of 1 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 Language selection to interpret instructions x = 1 (first language) or 2 (second language) : The EntraPass Command Editor can be used to generate the code needed to execute the operation. 9

14 3.4 ing Command Description ~e Indicates the beginning of an ~f xxxxx ~a xxxxx ~o xxxxx ~t xxxxx Example 1: Single address ~e~f "~o Address in CC ~t Subject of this ~c here you can enter the body text ~s Example 2: Multiple addresses , with no address in CC. ~t Subject of this ~c here you can enter the body text ~s Example 3: Single address with primary instructions included in the text. Year, month and current day are added at the end of title. The text section can be empty in a . Example 4: The sender s address Must include < > at the beginning and at the end of the address xxxxx = address On some sites, this address must be valid on the server account in order to send the out of the local network. The addressee s address Must include < > at the beginning and at the end of the address xxxxx = address Multiple addresses can be defined (see example below) The CC s address Must include < > at the beginning and at the end of the address xxxxx = address Multiple addresses can be defined (see example below) The s subject Must include < > at the beginning and at the end of the subject (title) xxxxx = subject content (title) The s content (text) Must include < > at the beginning and at the end of the subject ~c xxxxx xxxxx = content Each command of this type corresponds to a distinct line of text in the (see example below) ~s Indicates the end of the and triggers an immediate sending ~e~a"name@kantech.com "~t Subject of this $a / $b / $c~s To define the , all the primary commands previously defined can be used to build the title or content. title definition : ~t$a / $b / $c : Generated event : $h content definition : ~c Event # $g ( text first line) ~c This event has been sent automatically ( text second line) 10

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

16 3.5 Modem and Pager Command ~m x:yyyy :xxxxxxxx ~dz xxxxxxx ~p xxxxxxx:yyyy:zzzzzzzzzzzz Description Modem start-up and initialization for the selected serial output x = serial output 1 to xx yyyy = modem speed in baud rates (default : 19200) xxxxxxxx = characters string for the modem initialization. The characters string for the modem initialization can be omitted. In this case, the modem will use the default characters string. ex : ~m 1:9600 (modem initialization for COM 1 serial output at the speed of 9600 bauds) ex : ~m 1:9600 :ATX4M1V1E0 (modem initialization for COM 1 serial output at the speed of 9600 bauds with a characters string) Dialing of phone number xxxxxxx. z is the number of redial attempts in case of failure. Send a numeric message to a pager. xxxxxxxx : phone number to dial yyyy: delay before sending the message zzzzzzzzzzzz : message (numeric only) Modem connection delay : ~b xxxx:yyyy xxxx = connection delay (dial) in seconds yyyy = delay in seconds between each connection trial in case of failure. ~h Hang-up the line for the modem in use List of default values for a modem communication Number of connection trials: 1 Connection delays: 30 seconds Delay between each trial: 15 seconds Serial output value: Com1 Modem speed: bauds Initialization string: ATX4M1V1E0 Pager options: Delay before message: 15 seconds The EntraPass Command Editor can be used to generate the code needed to execute the operation. 12

17 EntraPass SmartLink Reference Manual 3.6 Network Example: In Message Mode, the instructions used to send data via the network can be redirected to a specific client application or to all the client applications connected to the SmartLink network. The result of an instruction depends on the identifier included in the message, the last selected identifier or the identifier defined during the initialization process. ID = 0 ($r0$r), this instruction in MessageMode returns the result to all the clients actually connected to the SmartLink server. The identifier 0 indicates a sending to all connected clients. ID = xx ($r25$r), this instruction in MessageMode returns the result to a client with an identifier #25. If no client application with this identifier is connected, the system will put the information on stand-by until the application is reconnected. As soon as the application is reconnected, all the information on stand-by will be sent. If more than one person is connected using the same identifier, the system will keep only the last connected one. Note: The information on stand-by will be deleted if SmartLink is stopped before the client application with this identifier was connected. Important: In order to make the network mode accessible for SmartLink, the network connection option of the workstation configuration window corresponding to SmartLink should be: Messages only or Messages and Commands. The EntraPass Command Editor can be used to generate the code needed to execute the operation. 13

18 14

19 4.0 - Communication Protocol EntraPass SmartLink Reference Manual This section describes the particular features of the different communication methods used with SmartLink. 4.1 Communication modes IP Network Serial Port There are two communication modes between the Operator and SmartLink. The first one uses the IP Network and the second one the serial port. In both cases, the data format is almost the same. This section explains the differences. A command received via the IP Network is treated Immediately. SmartLink is capable of receiving many simultaneous commands but processes them in chronological order. The data format, explained in the following sections, relates to the data that pass through the SmartDll as a packet. Once the first byte of data is received by SmartLink, any other command coming to the same serial port will be blocked and placed into a queue. A timer is automatically started once a command is received at SmartLink. That timer eventually times out when the packet takes too long to arrive. This method of time management allows SmartLink to free up the communication port in case a command takes too long to arrive. 4.2 Command The command must be sent using a predefined format, as shown bellow, and is applicable to the serial communication port (raw data) or to the IP communication Network (SmartDll). STX Command=x FS Parameter1 FS ParameterN FS ETX STX: Start Transmission byte = 0x02 FS: File separator byte = 0x1C ETX: End of Transmission byte = 0x03 Optional The formatted packet must always begin with an STX byte to identify its starting point. The command is then preceeded with Command=. The FS byte delimiter must follow the command and any provided parameters. The last byte within the formatted packet must be an ETX that specifies the ending point. The parameters are optional and may be placed in any order since keywords are used. All keywords must be followed with an equal sign. The characters are not case sensitive. Spaces are not allowed within the command or operator keywords. Example with the login command from section 20: Login In both cases, the command format is identical for the IP Network and the Serial Port. 4.3 Returned SmartLink 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 for readability purposes. 15

20 4.3.1 Serial Port The whole result and the optional parameters are returned as described here: IP Network The result is returned by the DLL function call in two parts: a. Integer value returned from the DLL function call return. b. Optional parameters returned by the DLL within a provided buffer according to this format: Common error messages List of common returned error messages for all commands. For a complete list see Appendix #1. ErrMsg Header Name Description 10 SMARTLINK_NOT_LOGIN Operator must be first connected. 36 SMARTLINK_COMMAND_INVALID Invalid command 39 SMARTLINK_COMMANDINVALIDKEYWORD 40 SMARTLINK_COMMANDTIMEOUT The command= keyword is invalid within the command. 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 16

21 EntraPass SmartLink Reference Manual Commands This section provides details on each command that can be sent to SmartLink. 5.1 Standard Command List Summary The following is a list summary of commands that can be sent to the SmartLink server. The detail of each command is given in subsequent sections. Commands Description Paragraph ActivateRelay Activate a relay 2.46 ActivateRelayGroup Activate a group of relays 2.51 ActivateTempoRelay Temporarily activate a relay 2.47 ActivateTempoRelayGroup Temporarily activate a group of relays 2.52 AddCard Add a new card to the system 2.6 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 ConnectionState 2 Validate the connection to SmartLink 2.5 ConnectSite Send a connection request to a site ControllerStatus Receive the controller status 2.88 DeactivateRelay Deactivate a relay 2.45 DeactivateRelayGroup Deactivate a group of relays 2.50 DecCountUsage 1 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 DisableElevatorDoor 1 Disable an elevator reader (door) 2.78 DisableElevatorDoorGroup 1 Disable an elevator group of readers (door) 2.80 DisableFloorElevatorDoor 1 Disable floor group for a cab (door) 2.82 DisableFloorElevatorDoorGroup 1 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 DoorStatus Receive a door status 2.89 EnableDoor Enable a reader (door) 2.65 EnableDoorGroup Enable a group of readers (door) 2.67 EnableElevatorDoor 1 Enable an elevator reader (door) 2.77 EnableElevatorDoorGroup 1 Enable an elevator group of readers (door) 2.79 EnableFloorElevatorDoor 1 Enable floor group for a cab (door) 2.81 EnableFloorElevatorDoorGroup 1 Enable floor group for a group of cabs (door) 2.83 ForgiveController Reset the Anti-Passback 2.30 GatewayStatus Receive the gateway status 2.86 GetCardInfo Retrieve card specific information

22 Commands Description Paragraph GetCardInfoPicture 1 Retrieve card specific information and Picture 2.10 GetCardPicture2 Retrieve card Picture 2.11 GetCardSignature 2 Retrieve card Signature 2.13 GetCountUsage Get the maximum number of a card usages 2.17 GetLastAddedCard 1 Retrieve Id of the last added card 2.23 GetLastTransactionCard Get a card last transaction 2.96 GetNip Retrieve a PIN from a specific card 2.15 GetReport Create a report and send it by GuardTourStatus (Global only) 1 Receive a guard tour status 2.95 HardResetController Execute a board level hard reset 2.28 IncCountUsage 1 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 LockElevatorDoor 1 Lock an elevator door 2.69 LockElevatorDoorGroup 1 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 ResetCountUsage 1 Restart count usage to 0 use 2.22 ReturnScheduleDoor 1 Return door to normal schedule 2.35 ReturnScheduleDoorGroup 1 Return group of doors to normal schedule 2.40 ReturnScheduleElevatorDoor 1 Return elevator door to normal schedule 2.72 ReturnScheduleElevatorDoorGroup 1 Return elevator group of doors to normal schedule 2.76 ReturnScheduleInput 1 Return input to normal schedule 2.58 ReturnScheduleInputGroup 1 Return group of inputs to normal schedule 2.64 ReturnScheduleRelay 1 Return relay to normal schedule 2.48 ReturnScheduleRelayGroup 1 Return group of relays to normal schedule 2.53 SetCardPicture 2 Change a card s picture 2.12 SetCardSignature 2 Change card s signature 2.14 SetCountUsage Modify the maximum number of card usages 2.18 SetCountUsageManual 1 Modify the maximum number of card usages and set the manual operation 2.19 SetNip 3 Change the PIN for a specific card? ShuntInput Disable an input 2.55 ShuntInputGroup Disable a group of inputs

23 EntraPass SmartLink Reference Manual Commands Description Paragraph 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 SuperviseInput 1 Continuously supervise an input 2.57 SuperviseInputGroup 1 Continuously supervise a group of inputs 2.63 ToggleDoorStrike 1 Toggle the Door Strike 2.36 ToggleInputShunt 1 Toggle shunt or unshunt input 2.59 ToggleRelayActivation 1 Activate or deactivate a relay 2.49 UnlockDoor Unlock a door 2.33 UnlockDoorGroup Unlock a group of doors 2.38 UnlockElevatorDoor 1 Unlock an elevator door 2.70 UnlockElevatorDoorGroup 1 Unlock an elevator group of doors 2.74 UnlockTempoDoor Temporarily unlock a door 2.34 UnlockTempoDoorGroup Temporarily unlock a group of doors 2.39 UnlockTempoElevatorDoor 1 Temporarily unlock an elevator door 2.71 UnlockTempoElevatorDoorGroup 1 Temporarily unlock an elevator group of doors 2.75 UnshuntInput Enable an input 2.54 UpdateAllSite Call all gateway sites with modified data UpdateRemoteSite Call one site with modified data UpdateRemoteSiteGateway Call all sites on a specific gateway with modified data WorkstationStatus Receive the workstation status 2.85 SiteStatus Receive the site status 2.87 SoftResetController Execute a board level soft reset 2.29 SuperviseInput 1 Continuously supervise an input 2.57 SuperviseInputGroup 1 Continuously supervise a group of inputs 2.63 ToggleDoorStrike 1 Toggle the Door Strike 2.36 ToggleInputShunt 1 Toggle shunt or unshunt input 2.59 ToggleRelayActivation 1 Activate or deactivate a relay 2.49 UnlockDoor Unlock a door 2.33 UnlockDoorGroup Unlock a group of doors 2.38 UnlockElevatorDoor 1 Unlock an elevator door 2.70 UnlockElevatorDoorGroup 1 Unlock an elevator group of doors 2.74 UnlockTempoDoor Temporarily unlock a door 2.34 UnlockTempoDoorGroup Temporarily unlock a group of doors 2.39 UnlockTempoElevatorDoor 1 Temporarily unlock an elevator door 2.71 UnlockTempoElevatorDoorGroup 1 Temporarily unlock an elevator group of doors 2.75 UnshuntInput Enable an input 2.54 UpdateAllSite Call all gateway sites with modified data UpdateRemoteSite Call one site with modified data

24 Commands Description Paragraph UpdateRemoteSiteGateway Call all sites on a specific gateway with modified data WorkstationStatus Receive the workstation status Recently added. 2 SDK only. 3 Not yet supported. 5.2 Login This command allows a new user to request a connection to the network according to the provided username and password. All commands (except for login and logoff) need Login executed first to be processed successfully. Command Command=Login Parameter1 OperatorLoginName=x x is the operator login name Parameter2 OperatorPassword=x x is the password Returned data : 5.3 Logout (granted) 33 = SMARTLINK_INVALID_LOGIN 34 = SMARTLINK_INVALID_LOGINNAME 35 = SMARTLINK_INVALID_PASSWORD This command allows the operator to disconnect from the SmartLink network. Command Command=Logout Returned data : s 5.4 ConnectionState (granted) This command allows the operator to disconnect from the SmartLink network. Command Command=ConnectionState 20

25 EntraPass SmartLink Reference Manual Returned data : 5.5 AddCard (granted) This command adds a card in the system. If the card already exists, then the corresponding error message is displayed. 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 Parameter4 CardInfo2=x Maximum of 40 characters Parameter5 CardInfo3=x Maximum of 40 characters Parameter6 CardInfo4=x Maximum of 40 characters Parameter7 CardInfo5=x Maximum of 40 characters Parameter8 CardInfo6=x Maximum of 40 characters Parameter9 CardInfo7=x Maximum of 40 characters Parameter10 CardInfo8=x Maximum of 40 characters Parameter11 CardInfo9=x Maximum of 40 characters Parameter12 CardInfo10=x Maximum of 40 characters 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 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=x x is the Card ID of the card owner. When provided, the corresponding Card ID is deleted. 21

26 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. Note: The picture associated to a card can be sent through SendDataPicture(). Returned data : 5.6 ModifyCard This command modifies a card in the system. 0= SMARTLINK_COMMAND_OK 37=SMARTLINK_INVALIDCARDEXIST Command Command=ModifyCard Parameter1 Parameter2 to Parameter23 Parameter24 CardNumber=xxxx :xxxx OR CardId=y ReplaceCardNumber=xxxx :xxxx x format is based on system definition y is the unique system based number (PkData) As per section 21: AddCard 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. Note: As in AddCard, the picture associated to a card can be sent through SendDataPicture(). Returned data 5.7 DeleteCard This command deletes a card in the system according to its number. (granted) 38 = SMARTLINK_INVALIDCARDNOTEXIST Command Command=DeleteCard Parameter1 CardNumber=xxxx :xxxx OR CardId=y x format is based on system definition y is the unique system based number (PkData) 22

27 EntraPass SmartLink Reference Manual 5.8 GetCardInfo This command retrieves a card information according to its number. Command Command=GetCardInfo Parameter1 CardNumber=xxxx :xxxx OR CardId=y x format is based on system definition y is the unique system based number (PkData) Parameter1 to Parameter23 As many cards 5.9 GetCardInfoPicture CardNumberx=yyyy : yyyy As per section 21: AddCard 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 Note: The picture data associated to the card is of JPEG format and is returned when invoking the SendDataPicture() to be saved as a file according to the filename provided as an argument to the function. This command retrieves a card information and picture according to its number Command Command=GetCardInfoPicture Parameter1 CardNumber=xxxx :xxxx OR CardId=y x format is based on system definition y is the unique system based number (PkData) 23

28 Parameter1 to Parameter23 As many cards 5.10 GetCardPicture CardNumberx=yyyy : yyyy Note: The picture data associated to the card is of JPEG format and is returned when invoking the SendDataPicture() to be saved as a file according to the filename provided as an argument to the function. This command retrieves a card Picture according to its number As per the section 21: AddCard 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 Command Command=GetCardPicture Parameter1 CardNumber=xxxx :xxxx OR CardId=y x format is based on system definition y is the unique system based number (PkData) 5.11 SetCardPicture This command changes a card picture according to its number Command Command=SetCardPicture Parameter1 CardNumber=xxxx :xxxx OR CardId=y x format is based on system definition y is the unique system based number (PkData) 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 24

29 EntraPass SmartLink Reference Manual 5.12 GetCardSignature This command gets a card Signature according to its number Command Command=GetCardSignature Parameter1 CardNumber=xxxx :xxxx OR CardId=y x format is based on system definition y is the unique system based number (PkData) 5.13 SetCardSignature This command sets a card signature according to its number Command Command=SetCardSignature Parameter1 CardNumber=xxxx :xxxx OR CardId=y x format is based on system definition y is the unique system based number (PkData) 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 25

30 5.14 GetNip This command gets the PIN of a card in the system according to its number. Command Command=GetNip Parameter1 CardNumber=xxxx :xxxx OR CardId=y x format is based on system definition y is the unique system based number (PkData) 5.15 SetNip Parameter1 8000NIP=x x is the card PIN 38 = SMARTLINK_INVALIDCARDNOTEXIST This command changes the PIN of a card in the system according to its number. Command Command=SetNip Parameter1 CardNumber=xxxx :xxxx OR CardId=y Parameter1 8000NIP=x x is the card PIN x format is based on system definition y is the unique system based number (PkData) 5.16 GetCountUsage 38 = SMARTLINK_INVALIDCARDNOTEXIST This command gets the count usage of a card in the system according to its number. Command Command=GetCountUsage Parameter1 CardNumber=xxxx :xxxx OR CardId=y x format is based on system definition y is the unique system based number (PkData) 26

31 EntraPass SmartLink Reference Manual 5.17 SetCountUsage 38 = SMARTLINK_INVALIDCARDNOTEXIST Parameter1 CountUsage=x x is the count usage of the card This command sets the count usage of a card in the system according to its number. Command Command=SetCountUsage Parameter1 CardNumber=xxxx :xxxx OR CardId=y Parameter2 CountUsage=x x is the count usage x format is based on system definition y is the unique system based number (PkData) 5.18 SetCountUsageManual 38 = SMARTLINK_INVALIDCARDNOTEXIST This command sets the count usage of a card and set the manual operation in the system. Command Command=SetCountUsageManual Parameter1 CardNumber=xxxx :xxxx OR CardId=y Parameter2 CountUsage=x x is the count usage x format is based on system definition y is the unique system based number (PkData) 38 = SMARTLINK_INVALIDCARDNOTEXIST 27

32 5.19 DecCountUsage This command removes 1 from the count usage of a card in the system. Command Command=DecCountUsage Parameter1 CardNumber=xxxx :xxxx OR CardId=y x format is based on system definition y is the unique system based number (PkData) 5.20 IncCountUsage This command adds 1 to the count usage of a card in the system. 38 = SMARTLINK_INVALIDCARDNOTEXIST Command Command=IncCountUsage Parameter1 CardNumber=xxxx :xxxx OR CardId=y x format is based on system definition y is the unique system based number (PkData) 5.21 ResetCountUsage This command restarts count usage to 0 of a card in the system. 38 = SMARTLINK_INVALIDCARDNOTEXIST Command Command=ResetCountUsage Parameter1 CardNumber=xxxx :xxxx OR CardId=y x format is based on system definition y is the unique system based number (PkData) 28

33 EntraPass SmartLink Reference Manual 5.22 GetLastAddedCard This command retrieves the last added card ID. 38 = SMARTLINK_INVALIDCARDNOTEXIST Command Command=GetLastAddedCard Parameter1 CardId=y y is the unique card ID system based number (PkData) 5.23 ArmAlarmSystem (Global only) This command arms an alarm system. 38 = SMARTLINK_INVALIDCARDNOTEXIST Command Command=ArmAlarmSystem Parameter1 AlarmSystemId=x x is the Alarm System Reference Identifier 5.24 DisarmAlarmSystem (Global only) This command disarms an alarm system. Command Command=DisarmAlarmSystem Parameter1 AlarmSystemId=x x is the Alarm System Reference Identifier 29

34 5.25 PostponeAlarmSystem (Global only) This command postpones the arming of an alarm system. Command Command=PostponeAlarmSystem Parameter1 AlarmSystemId=x x is the Alarm System Reference Identifier Parameter1 PostponeDelay=x x is the postponement delay in seconds form 1 to AreaMoveCard (Global only) This command moves a card to a specific area. 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 30

35 5.27 HardResetController This command performs a hard reset on a controller. EntraPass SmartLink Reference Manual Command Command=HardReset Parameter1 ControllerID=x x is the controller reference ID 5.28 SoftResetController This command performs a soft reset on a controller. Command Command=SoftReset Parameter1 ControllerID=x x is the controller reference ID 5.29 ForgiveController This command clears the Anti-Passback. Command Command=ForgveController Parameter1 ControllerID=x x is the controller reference ID 31

36 5.30 ReloadController This command reloads the controller database. Command Command=ReloadController Parameter1 ControllerID=x X is the controller reference ID 5.31 LockDoor This command locks a door according to its identifier. Command Command=LockDoor Parameter1 DoorId=x x is the door reference ID Parameter2 ForceSend=x 5.32 UnlockDoor This command unlocks a door according to its identifier. Command Command=UnlockDoor Parameter1 DoorId=x x is the door reference ID 32

37 5.33 UnlockTempoDoor This command temporarily unlocks a door according to its identifier. EntraPass SmartLink Reference Manual Command Command=UnlockTempoDoor Parameter1 DoorId=x x is the door reference ID Parameter2 DoorDelay=x x is the door delay in seconds from 1 to 255 Parameter3 ForceSend=x 5.34 ReturnScheduleDoor This command returns a door to the normal schedule. Command Command=ReturnScheduleDoor Parameter1 DoorId=x x is the door reference ID Parameter2 ForceSend=x 5.35 ToggleDoorStrike This command toggles the door strike. Command Command=ToggleDoorStrike Parameter1 DoorId=x x is the door reference ID Parameter2 ForceSend=x 33

38 ToggleDoorStrike Lock or Unlock door 5.36 LockDoorGroup This command locks a group of doors according to its identifier. Command Command=LockDoorGroup Parameter1 DoorGroupId=x x is the door group reference ID Parameter2 ForceSend=x 5.37 UnlockDoorGroup This command unlocks a group of doors according to its identifier. Command Command=UnlockDoorGroup Parameter1 DoorGroupId=x x is the door group reference ID 34

39 5.38 UnlockTempoDoorGroup EntraPass SmartLink Reference Manual This command temporarily unlocks a group of doors according to its identifier. Command Command=UnlockTempoDoorGroup Parameter1 DoorGroupId=x x is the door reference ID Parameter2 DoorDelay=x x is the door delay in seconds from 1 to 255 Parameter3 ForceSend=x 5.39 ReturnScheduleDoorGroup This command returns a group of doors to the normal schedule. Command Command=UnlockTempoDoorGroup Parameter1 DoorGroupId=x x is the door reference ID Parameter2 ForceSend=x 5.40 ArmDoor This command arms the alarm on a door. Only available with the Corporate edition. Command Command=ArmDoor Parameter1 DoorId=x x is the door reference ID Parameter2 ForceSend=x 35

40 5.41 DisarmDoor This command disarms the alarm on a door. Only available with the Corporate edition. Command Command=DisarmDoor Parameter1 DoorId=x x is the door reference ID Parameter2 ForceSend=x 5.42 ArmDoorGroup This command arms a group of doors according to its identifier. Command Command=ArmDoorGroup Parameter1 DoorGroupId=x x is the door group reference ID Parameter2 ForceSend=x 36

41 5.43 DisarmDoorGroup This command disarms a group of doors according to its identifier. EntraPass SmartLink Reference Manual Command Command=DisarmDoorGroup Parameter1 DoorGroupId=x x is the door group reference ID Parameter2 ForceSend=x 5.44 DeactivateRelay This command deactivates a relay according to its identifier Command Command=DeactivateRelay Parameter1 RelayId=x x is the Relay reference ID Parameter2 ForceSend=x 5.45 ActivateRelay This command activates a relay according to its identifier Command Command=ActivateRelay Parameter1 RelayId=x x is the Relay reference ID Parameter2 ForceSend=x 37

42 5.46 ActivateTempoRelay This command temporarily activates a relay according to its identifier 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 Parameter3 ForceSend=x 5.47 ReturnScheduleRelay This command returns a relay to its normal schedule according to its identifier Command Command=ReturnScheduleRelay Parameter1 RelayId=x x is the relay reference ID Parameter2 ForceSend=x 38

43 5.48 ToggleRelayActivation This command toggles the relay state according to its identifier. EntraPass SmartLink Reference Manual Command Command=ToggleRelayActivation Parameter1 RelayId=x x is the Relay reference ID Parameter2 ForceSend=x 5.49 DeactivateRelayGroup This command deactivates a group of relays according to its identifier. Command Command=DeactivateRelayGroup Parameter1 RelayGroupId=x x is the Relay group reference ID Parameter2 ForceSend=x 5.50 ActivateRelayGroup This command activates a group of relays according to its identifier. Command Command=ActivateRelayGroup Parameter1 RelayGroupId=x x is the Relay group reference ID Parameter2 ForceSend=x 39

44 5.51 ActivateTempoRelayGroup This command temporarily activates a group of relays according to its identifier. Command Command=ActivateTempoRelay Group Parameter1 RelayGroupId=x x is the Relay group reference ID Parameter2 RelayDelay=x x is the relay delay in seconds from 1 to 255 Parameter3 ForceSend=x 5.52 ReturnScheduleRelayGroup This command returns a group of relays to normal schedule according to its identifier. Command Command=ReturnScheduleRelay Group Parameter1 RelayGroupId=x x is the Relay group reference ID Parameter2 RelayDelay=x x is the relay delay in seconds from 1 to 255 Parameter3 ForceSend=x 40

45 5.53 UnshuntInput EntraPass SmartLink Reference Manual This command forces an input to be monitored according to its identifier. Command Command=UnshuntInput Parameter1 InputId=x x is the Input reference ID Parameter2 ForceSend=x 5.54 ShuntInput This command prevents an input from being monitored according to its identifier. Command Command=ShuntInput Parameter1 InputId=x x is the Input reference ID Parameter2 ForceSend=x 5.55 ShuntInputTempo This command temporarily prevents an input from being monitored according to its identifier. Command Command=ShuntInputTempo Parameter1 InputId=x x is the Input reference ID Parameter2 InputDelay=x x is the relay delay in seconds from 1 to 255 Parameter3 ForceSend=x 41

46 5.56 SuperviseInput This command continuously supervises an input according to its identifier. Command Command=SupervisedInput Parameter1 InputId=x x is the Input reference ID Parameter2 ForceSend=x 5.57 ReturnScheduleInput This command returns an input to its normal schedule according to its identifier. Command Command=ReturnScheduleInput Parameter1 InputId=x x is the Input reference ID Parameter2 ForceSend=x 42

47 5.58 ToggleInputShunt EntraPass SmartLink Reference Manual This command toggles shunt or unshunt an input according to its identifier. Command Command=ToggleInputShunt Parameter1 InputId=x x is the Input reference ID Parameter2 ForceSend=x 5.59 UnshuntInputGroup This command forces a group of inputs to be monitored according to its identifier. Command Command=UnshuntInputGroup Parameter1 InputGroupId=x x is the Input group reference ID Parameter2 ForceSend=x 5.60 ShuntInputGroup This command prevents a group of inputs from being monitored according to its identifier. Command Command=ShuntInputGroup Parameter1 InputGroupId=x x is the Input group reference ID Parameter2 ForceSend=x 43

48 5.61 ShuntTempoInputGroup This command temporarily prevents a group of inputs from being monitored according to its identifier. Command Command=ShuntTempoInputGroup Parameter1 InputGroupId=x x is the Input group reference ID Parameter2 InputDelay=x x is the relay delay in seconds from 1 to 255 Parameter3 ForceSend=x 5.62 SuperviseInputGroup This command continuously supervises a group of inputs according to its identifier. Command Command=SuperviseInputGroup Parameter1 InputGroupId=x x is the Input group reference ID Parameter2 ForceSend=x 5.63 ReturnScheduleInputGroup This command returns a group of inputs to normal schedule according to its identifier. 44

49 EntraPass SmartLink Reference Manual Command Command=ReturnScheduleInput Group Parameter1 InputGroupId=x x is the Input group reference ID Parameter2 ForceSend=x 5.64 EnableDoor This command enables a door according to its identifier. Command Command=EnableDoor Parameter1 DoorId=x x is the Door reference ID Parameter2 ForceSend=x 5.65 DisableDoor This command disables a door according to its identifier. Command Command=DisableDoor Parameter1 DoorId=x x is the Door reference ID Parameter2 ForceSend=x 45

50 5.66 EnableDoorGroup This command enables a group of doors according to its identifier. Command Command=EnableDoorGroup Parameter1 DoorGroupId=x x is the Door group reference ID Parameter2 ForceSend=x 5.67 DisableDoorGroup This command disables a group of doors according to its identifier. Command Command=DisableDoorGroup Parameter1 DoorGroupId=x x is the Door group reference ID Parameter2 ForceSend=x 46

51 5.68 LockElevatorDoor This command locks an elevator door according to its identifier. EntraPass SmartLink Reference Manual Command Command=LockElevatorDoor Parameter1 DoorId=x x is the elevator door reference ID Parameter2 ForceSend=x 5.69 UnlockElevatorDoor This command unlocks an elevator door according to its identifier. Command Command=UnlockElevatorDoor Parameter1 DoorId=x x is the elevator door reference ID Parameter2 ForceSend=x 5.70 UnlockTempoElevatorDoor This command temporarily unlocks an elevator door according to its identifier. Command Command=UnlockTempoElevator Door Parameter1 DoorId=x x is the elevator door reference ID Parameter2 DoorDelay=x x is the door delay in seconds from 1 to 255 Parameter3 ForceSend=x 47

52 5.71 ReturnScheduleElevatorDoor This command returns an elevator door to normal schedule. Command Command=ReturnScheduleElev atordoor Parameter1 DoorId=x x is the elevator door reference ID Parameter2 ForceSend=x 5.72 LockElevatorDoorGroup This command locks a group of elevator doors according to its identifier. Command Command=LockElevatorDoorGroup Parameter1 DoorGroupId=x x is the Elevator door group reference ID Parameter2 ForceSend=x 48

53 5.73 UnlockElevatorDoorGroup EntraPass SmartLink Reference Manual This command unlocks a group of elevator doors according to its identifier. Command Command=UnlockElevatorDoor Group Parameter1 DoorGroupId=x x is the Elevator door group reference ID Parameter2 ForceSend=x 5.74 UnlockTempoElevatorDoorGroup This command temporarily unlocks a group of elevator doors according to its identifier. Command Command=UnlockTempoElevator DoorGroup Parameter1 DoorGroupId=x x is the Elevator door reference ID Parameter2 DoorDelay=x x is the door delay in seconds from 1 to 255 Parameter3 ForceSend=x 5.75 ReturnScheduleElevatorDoorGroup This command returns a group of elevator doors to normal schedule. Command Command=UnlockTempoElevator DoorGroup Parameter1 DoorGroupId=x x is the Elevator door reference ID Parameter2 ForceSend=x 49

54 5.76 EnableElevatorDoor This command enables an elevator door according to its identifier. Command Command=EnableElevatorDoor Parameter1 DoorId=x x is the Elevator Door reference ID Parameter2 ForceSend=x 5.77 DisableElevatorDoor This command disables an elevator door according to its identifier. Command Command=DisableElevatorDoor Parameter1 DoorId=x x is the Elevator Door reference ID Parameter2 ForceSend=x 50

55 5.78 EnableElevatorDoorGroup EntraPass SmartLink Reference Manual This command enables a group of elevator doors according to its identifier. Command Command=EnableElevatorDoor Group Parameter1 DoorGroupId=x x is the Elevator Door group reference ID Parameter2 ForceSend=x 5.79 DisableElevatorDoorGroup This command disables a group of elevator doors according to its identifier. Command Command=DisableDoorGroup Parameter1 DoorGroupId=x x is the Elevator Door group reference ID Parameter2 ForceSend=x 5.80 EnableFloorElevatorDoor This command enables a floor elevator door according to its identifier. Command Command=EnableFloorElevator Door Parameter1 DoorId=x x is the Floor Elevator Door reference ID Parameter2 ForceSend=x 51

56 5.81 DisableFloorElevatorDoor This command disables a floor elevator door according to its identifier. Command Command=DisableFloorElevator Door Parameter1 DoorId=x x is the Floor Elevator Door reference ID Parameter2 ForceSend=x 5.82 EnableFloorElevatorDoorGroup This command enables a group of floor elevator doors according to its identifier. Command Command=EnableFloorElevator DoorGroup Parameter1 DoorGroupId=x x is the Floor Elevator Door group reference ID Parameter2 ForceSend=x 52

57 5.83 DisableFloorElevatorDoorGroup EntraPass SmartLink Reference Manual This command disables a group of floor elevator doors according to its identifier. Command Command=DisableFloorDoorGroup Parameter1 DoorGroupId=x x is the Floor Elevator Door group reference ID Parameter2 ForceSend=x 5.84 WorkstationStatus This command gets the status of a workstation according to its identifier. Command Command=WorkstationStatus Parameter1 WorkstationID=x x is for the workstation reference ID Parameter GatewayStatus CommunicationState=x Communication state, x can be: Connected Disconnected This command gets the state of a Gateway according to its identifier. Command Command=GatewayStatus Parameter1 GatewayID=x x is the Gateway reference ID 53

58 Parameter1 Parameter2 Parameter SiteStatus CommunicationState=x ServerReload=x WorkstationReload=x Communication state. x can be: OK Failure This command gets the status of a site according to its identifier. Informs that server is reloading, x can be: No Yes Informs that workstation is reloading, x can be: No Yes Command Command=SiteStatus Parameter1 SiteID=x x is the Site Reference ID 5.87 ControllerStatus Parameter1 COMMUNICATIONSTATE=x x = CONNECTED or NOTCONNECTED This command gets the status of a controller according to its identifier. Command Command=ControllerStatus Parameter1 ControllerID=x x is the controller reference ID 54

59 EntraPass SmartLink Reference Manual Parameter1 Parameter2 Parameter3 Parameter4 Parameter5 Parameter DoorStatus Exist=x Failure=x HardReset=x AcAlarm=x TamperAlarm=x AcSchedule=x Controller defined, x can be: No Yes Communication failure, x can be: No Yes Controller is in hard reset, x can be: No Yes AC power failure, x can be: No Yes Tamper is in alarm, x can be: No Yes Valid AC schedule, x can be: No Yes Valid tamper schedule, x can be: Parameter7 TamperSchedule=x No Yes Parameter8 Version=xx.xx Controller version This command gets the status of a door according to its identifier. Command Command=DoorStatus Parameter1 DoorID=x x is the door reference ID 55

60 Parameter1 Parameter2 Parameter3 Parameter4 Parameter5 Parameter RelayStatus ControllerExist=x ControllerFailure=x DoorExist=x OpenState=x LockState=x ReaderDisable=x Controller defined, x can be: No Yes Controller failure, x can be: No Yes Door is defined, x can be: No Yes Door opened, x can be: Close Forced OpenTooLong PreAlarmOpenTooLong StillOpen Open Door is locked, x can be: Lock UnlockOperator UnlockSchedule Reader is disabled, x can be: No Yes This command gets the status of a relay according to its identifier. Command Command=RelayStatus Parameter1 RelayID=x x is the relay reference ID 56

61 EntraPass SmartLink Reference Manual Parameter1 Parameter2 Parameter3 Parameter4 Parameter5 Parameter InputStatus ControllerExist=x ControllerFailure=x RelayExist=x State=x ActivateTempo=x AlarmSystemID=x Controller defined, x can be: No Yes Controller failure, x can be: No Yes Relay is defined, x can be: No Yes Relay State, x can be: Deactivate ActivateOperator ActivateSchedule ActivateInput ActivateArea ActivateEvent ActivateAlarmSystem ActivateAlarmSystemStatus ActivateAlarmSystemPostpone ActivateAlarmSystemEntryDelay ActivateAlarmSystemExitDelay ActivateAlarmSystemArmingDelay ActivateAlarmSystemPreventArming ActivateAlarmSystemAlarm1 ActivateAlarmSystemAlarm2 ActivateAlarmSystemBell Relay temporarily activated, x can be: No Yes This command gets the status of an input according to its identifier. 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 57

62 Parameter1 Parameter2 Parameter3 Parameter4 Parameter5 Parameter6 ControllerExist=x ControllerFailure=x InputExist=x State=x Supervision=x Armed=x 5.91 OutputStatus (Not implemented) This command is not implemented AlarmSystemStatus (Global only) Controller defined, x can be: No Yes Controller failure, x can be: No Yes Input is defined, x can be: No Yes Input state, x can be: Normal NormalNotSupervised Alarm AlarmNotSupervised Zone supervision, x can be: Normal Continuous None Reverse Zone is armed, x can be: No Yes This command gets the status of an alarm system according to its identifier. Command Command=AlarmSystemStatus Parameter1 AlarmSystemID=x x is the alarm system reference ID 58

63 EntraPass SmartLink Reference Manual 5.93 AreaStatus (Global only) 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 Parameter9 ExitDelay=x Exit delay, x=0 to Parameter10 ArmingDelay=x Arming delay, x = 0 to Parameter11 Postponedelay=x Postponement delay, x = 0 to This command gets the status of an area according to its identifier. Command Command=AreaStatus Parameter1 AreaID=x x is the area reference ID 5.94 GuardTourStatus (Global only) Parameter1 State=x Status of the area, x = OPEN or CLOSE This command gets the status of a guard tour according to its identifier. Command Command=AreaStatus Parameter1 GuardTourID=x x is the guardtour reference ID 59

64 5.95 GetLastTransactionCard This command gets the TBD Parameter1 State=x Status of the area, x = OPEN or CLOSE Command Command=GetLastTransactioncard ProcessCMDGet LastTransactionC ardparameter1 ProcessCMDGetLastTransactionCard ProcessCMDGetLastTransactionCard Parameter1 Parameter2 Parameter GetReport EventCard=x DoorDescription=x TransactionDate=x This command gets the TBD Command Command=GetReport 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 Id=x x is the TBD Parameter7 Report=x x is the TBD 60

65 EntraPass SmartLink Reference Manual 5.97 ConnectSite This command sends a connection request to a site. Command Command=ConnectSite Parameter1 SiteId=x x is the Site Reference ID 5.98 DisconnectSite This command sends a disconnection request to a site. Command Command=DisconnectSite Parameter1 SiteId=x x is the Site Reference ID 5.99 UpdateRemoteSite This command calls one site with modified data. Command Command=UpdateRemoteSite Parameter1 SiteId=x x is the Site Reference ID 61

66 5.100 UpdateRemoteSiteGateway This command calls all sites on a specific gateway with modified data. Command Command=UpdateRemoteSite Gateway Parameter1 GatewayId=x x is the Gateway reference ID UpdateAllSite This command calls all gateway sites with modified data. Command Command=UpdateAllSite 62

67 EntraPass SmartLink Reference Manual SmartDll This DLL allows connecting to SmartLink in order to execute various commands and also to receive messages programmed in the software. SmartTest.exe is a software used to test the DLL s functionalities. Here is a list of the available functions : Function stdcall Connect (long thesmartlinktag, char* theipaddress) stdcall AutomaticConnect (long thesmartlinktag, char* theipaddress) stdcall Disconnect () stdcall SendData (long thelengthsend, unsigned char* thebuffersend, long* thelengthreceive, unsigned char* thebufferreceive) Description This function is used to establish communication between the SmartDll and SmartLink. Once completed, the DLL will perform an optimized poll of SmartLink to pick the messages intended for the connection thesmartlinktag : Connection identifier from 0 to 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 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. This function disconnect the link between the DLL and SmartLink and ends the requesting process This function is used to send commands to SmartLink and also to receive informations. A list of commands is available in section... thelengthsend: Length of the information to be sent thebuffersend: Pointer on a memory space that 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. 63

68 Function stdcall SendDataPicture (long thelengthsend, unsigned char* thebuffersend, long* thelengthreceive, unsigned char* thebufferreceive, char* thepicture) stdcall ShowWorkstation (long* thentm) stdcall ShowGateway (long* thegsi) stdcall ShowSite (long* thesite) stdcall ShowController (long* thecontroller) stdcall ShowControllerGroup (long* thecontrollergroup) stdcall ShowDoor (long* thedoor) stdcall ShowDoorGroup (long* thedoorgroup) stdcall ShowRelay (long* therelay) stdcall ShowRelayGroup (long* therelaygroup) stdcall ShowInput (long* theinput) stdcall ShowInputGroup (long* theinputgroup) stdcall ShowOutput (long* theoutput) stdcall ShowFloor (long* thefloor) stdcall ShowFloorGroup (long* thefloorgroup) stdcall ShowSchedule (long* theschedule) stdcall ShowOperator (long* theoperator) stdcall ShowSecurityLevel (long* thesecuritylevel) stdcall ShowCardAccessGroup (long* thecardaccessgroup) Description This function is used to send a command to SmartLink by including a picture. It can also receive informations. A list of commands is available in section... thelengthsend: Length of the information to be sent thebuffersend: Pointer on a memory space that contains to command to be sent 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 64

69 EntraPass SmartLink Reference Manual Function stdcall ShowCardType (long* thecardtype) stdcall ShowBadging (long* thebadging) stdcall ShowAlarmSystem (long* thealarmsystem) stdcall ShowArea (long* thearea) stdcall ShowGuardTour (long* theguardtour) stdcall ShowGraphic (long* thegraphic) stdcall ShowVideoServer (long* thevideoserver) stdcall ShowCamera (long* thecamera) stdcall ShowReport (long* thereport) stdcall ShowAccessLevel (long* theaccesslevel) stdcall ShowHoliday (long* theholiday) stdcall ShowWorkspace (long* theholiday) stdcall ShowMusterReport (long* themusterreport) stdcall ShowAreaGroup (long* theareagroup) stdcall ShowTaskBuilder (long* thetaskbuilder) stdcall ShowTrigger (long* thetrigger) stdcall ShowPanel (long* thepanel) stdcall ShowPanelComponent (long* thepanelcomponent) Description The list of above-mentioned functions allow viewing the list of components for a specific type. This list will be also determined according to parameters that qualify the identified operator. It will be displayed in a visible page and the returned parameter will be the selected item in the list. This parameter will allow for the selected component s UniqueID to be returned. 65