CO104950_TGL_LILLE_V06R08

Page 1
Versions
Standard SGV Version Date Authors Comments
Version

Draft 29/11/2011 N. Péqueux

Y. Therasse

0.2 15/05/2012 N. Péqueux Add counter list

0.4 20/09/2012 N. Péqueux Add language message

codes

0.5 15/10/2012 N. Péqueux Add error list

0.7 19/12/2012 N. Péqueux Add Timeout

0.10 04/03/2014 J.Hemroulle

0.11 11/03/2014 J.Hemroulle Add SetOutputClient

0.12 08/04/2014 J.Hemroulle Add GetVersion

0.13 18/08/2014 B. Dani Add GetInternalCouters

0.14 30/09/2014 B. Dani Add Partial & PMR

Authorisation in
SetAuthorisation()

1.0 06/11/2014 B. Dani Add FraudRamping in

FraudList

1.1 27/04/2015 K. De Cuyper Add GetSetAEA,

SetModeAEA and
GetSetTempoAEA

1.2 02/12/2015 K. De Cuyper Added GetInputs method

Reordering of the document
Clarification of multiple
sections

1.3 09/03/2015 SICE Creación de Anexo para

incorporar nuevas
funcionalidades:
Añadir configuración de
tiempos de apertura y cierre
Añadir ajustes de
intensidad de la señal
sonora
Añadir lista de usuarios y
perfiles de mantenimiento
autorizados
Añadir registro de eventos
de mantenimiento

1.4 15/03/2015 AS remarks on Appendix 4

1.5 04/05/2015 AS comments added

following meeting on 26/04
on Appendix 4

1.0 23/06/2015 K. De Cuyper Added SendCommandSGV

Modified GetStatusPGV

Modified SetOutputs

First Confluence version

Added OutputEnable
command

Added OutputSelect
command

Added SendReboot
command

1.1 14/09/2015 K. De Cuyper Added fraud intrusion in

SetOutput

Added Client outputs 3 and

4

Page 2
 1.2 23/11/2015 K. De Cuyper Explanation of the minor
and major defects

Added Presence in exit

zone in GetStatusSGV

Cleaning and clarification of

the documentation for UAE
SGV

Added examples of
GetStatusSGV

1.3 24/11/2015 K. De Cuyper Added missing counters

Added counters description

Clarification in Result[0] of
GetStatusSGV

Clarification of
SendCommandSGV

1.6 01/sep/2016 A. Lemmens Review + update

information about the SICE
/ Secured functions.

1.7 Draft A. Lemmens Add GetDate + review +

more details

1.4 21/10/2016 N Péqueux Added

GetMaintenanceLogFromTo

1.5 3/11/2016 N Péqueux Parafe additional command

GetUPSStatus and
SetIPCStatus

1.8 08/12/2016 N. Péqueux Correct Get status

error major/minor

1.6 13/12/2016 K. De Cuyper Clarified GetUPSStatus

and SetIPCStatus
Added
SetMaintenanceMode

Version Date Authors Comments

2.0 17 Feb 2017 N. Péqueux Unified Documentation

2.1 15 Mar 2017 B. Dani Add WheelchairMode in

GetStatusSGV

2.2 29 Mar 2017 B. Dani Add TGL functions

Add
SetAuthorisationTGL
Add new parameters
in GetStatus
(validation & rejection)

25 Apr 2017 N. Péqueux Add Parkeon log method

Add push method

2.3 08 May 2017 N. Péqueux Add Annexe for customer

input correspondence

Add SetMode for TGL

Add GetStatus, Result[0]

- Char 7: Side modes and
Door modes forced by
Inputs

2.4 10 Aug 2017 A. Lemmens Flag "Side" in GetCounters

functions as "kept for
compatibility purpose"

2.5 24 Oct 2017 B. Dani Add new method:

SetOperatingDirection

2.6 13 Nov 2017 N. Péqueux AEA update

2.7 23 Apr 2018 N. Péqueux Add Camera version error

Page 3
Version Date Software Change log

6.0 14 May 2018 26708_2a15f8d Update to 6.0

6.2 27 Nov 2018 27280_bb05154 GetCurrentPassage : Correction of

the documentation ( inversion of
the output values for the field 2&3 )

6.3 27440_6c97f02 No changes to XML-RPC

6.4 10 May 2019 27797_0b2d9a9 Removed 3 digital inputs (UPS :

Main power lost, UPS : battery
charging, UPS : alarm)

Added 2 new counters (Total

running time (s), Total failure time
(s))

6.6 17 Sep 2019 28429_ea22199 GetDate function also return

timezone difference if available

Removed invalid door mode for

TGL (Locked open A/B)

Added new error type : Camera

height (minor) if camera wrongly
configured

Removed SetBuzzerMode function

(using a speaker implies no buzzer)

Fixed some typos

6.6hf1 15 Oct 2019 28433_23d6daed3 ApplyUpdate Function has more

returned code

GetStatus function return a new

error code: 'Camera height error'

6.7 28 Feb 2020 Modified Function :

GetCounter (update counters list)

GetCounterFromTo (update
counters list)

GetCurrentPassage (add Amount

of people detected by the camera)

GetDate (add time zone

parameters)

GetInputs (update input list)

GetStatus (update status list)

SetAuthorisation (remove partial

opening)

SetDate (add timezone parameter)

SetMode (update parameter list)

Removed function :

GetStatusStd

6.7hf1 13 Mar 2020 29172 Modified Function :

GetClientInfo (return an array)

GetCounter (return "01015"
and "01021")
GetCounterFromTo (return
"01015" and "01021")

Page 4
6.8 27 Apr 2020 29384_040ed2efb Modified Functions :

GetCounter ( Add "01050","

01051","01067","01074","
01075","02040" )
GetCounterFromTo ( Label
for "01050","01051", Add
"01067","01074","01075","
02040" )
GetInputs ( Label for "74090","
74065","74061","74062" )
GetStatus ( Label for "01009","
01010" )
SetOutputClient ( Add
Customer Output 9 )

Page 5
Table of Contents

Versions
Table of Contents
Introduction
Purpose
Interface definition
Unencrypted channel
Encrypted channel
XML-RPC References
How-to
Python code Example
Secured Functions
Introduction
Generate hashed password
Conventions
Description
Software version
ApplyUpdate (Secured Function)
GetAuthorizedUserList (Secured Function)
GetBuzzerFraud
GetBuzzerIntrusion
GetClientInfo
GetCounter
Counters
GetCounterFromTo
Counters
GetCurrentPassage
GetDate
GetDoorOperationModeList
GetInputs
Digital Inputs
Analog Inputs
GetMaintenanceLogFromTo
GetMotorSpeed
GetOperatingDirection
GetParkeonLogFromTo
GetProperties
GetSetTempo
GetSideOperationModeList
GetStatus
Door Modes
Side Operating Modes
Infractions
Timeouts
Errors
GetVersion
SendReboot
SendRestart
SetAuthorisation
SetAuthorisationTGL
SetAuthorizedUserList (Secured Function)
SetBuzzerFraud
SetBuzzerIntrusion
SetClientInfo
SetCredentials (Secured Function)
SetDate
SetEmergency
SetMaintenanceMode
SetMode
Door Modes
Side Operating Modes
SetMotorSpeed
SetOperatingDirection
SetOutputClient
Digital Outputs
Pictograms
SetProperties

Page 6
Introduction

Purpose
This document describes the API (Application Programming Interface) that is available on the gate product line. Clients can use this API to
manage and control a gate. This API offers the following features:

1. Get and set operational modes

2. Get and set the number of authorizations
3. Get the alarms (frauds, intrusions, etc)
4. Get the technical defects
5. Get the counters
6. …

This API is implemented as a XML-RPC API. As a consequence, the API can be called remotely through an HTTP connection. Clients can
be written in a wide variety of programming languages as libraries implementing the XML-RPC protocol are available.

Interface definition

Unencrypted channel

Physical interface : ethernet

Protocol : XML/RPC
Port : 8081

Encrypted channel

Physical interface : ethernet

Protocol : XML/RPC over TLSv1.2
Port : 8082

The following cipher suites are offered (presented here in order of precedence) :

ECDHE-RSA-AES256-GCM-SHA384, ECDHE-RSA-AES128-GCM-SHA256, DHE-RSA-AES256-GCM-SHA384, DHE-RSA-AES128-GCM-

SHA256, ECDHE-RSA-AES256-SHA384, ECDHE-RSA-AES256-SHA, DHE-RSA-AES256-SHA256, DHE-RSA-AES256-SHA

The following elliptic curves are offered :

sect283k1, sect283r1, sect409k1, sect409r1, sect571k1, sect571r1, secp256k1, prime256v1, secp384r1, secp521r1, brainpoolP256r1,
brainpoolP384r1, brainpoolP512r1

XML-RPC References
XML-RPC is a well documented protocol. Numerous books have been published on this topic. See for example the following book published
by O'REILLY:

Programming Web Services with XML-RPC

by S. St. Laurent, J. Johnston & E. Dumbill.
ISBN: 0-596-00119-3

Programming of a XML-RPC client can be simplified by using libraries that implements the protocol. XML-RPC libraries exist for a wide
range of programming languages including C/C++, Java, PHP, Perl, Python, Ruby, etc.

How-to
How to connect to the XML-RPC server

The following URI must be used: http://host:8081

Python code Example

The following is written in Python 2.6 using the standard library xmlrpclib. It shows how to connect to the gate XML-PRC server and how to
use the different calls that are provided:

File: gateRPC.py

Page 7
 import xmlrpclib
def run(IPaddress,port=8081):
URI="http://%s:%i" % (IPaddress,port)
proxy=xmlrpclib.ServerProxy(URI,xmlrpclib.Transport())
#get the list of RPC calls supported by the gate
methods=proxy.system.listMethods()
print "gate RPC calls:"
print
for name in methods:
if name.find("system.") <> 0: # exclude introspection
methods
print "method: %s" % (name,)
if _name_ == "_main_":
IPaddress=raw_input("gate IP address: ")
run(IPaddress)

Execution:

C:\pyScripts>python gateRPC.py
gate IP address: 172.18.0.206
gate RPC calls:
method: GetCounter
method: GetCounterFromTo
method: GetDoorOperationModeList
method: GetProperties
method: GetSideOperationModeList
method: GetStatus
method: SetAuthorisation
method: SetEmergency
method: SetMode
C:\pyScripts>

Page 8
Secured Functions

Introduction
The be able to use the secured functions you need to be authenticated (at least integrator level). The SetCredentials function call will return
you a cookie to be used afterward with the other functions.

Here is a example of usage of the SetCredentials and GetAuthorizedUserList.

1. Use the SetCredentials function that returns the cookie (using integrator or techician level of accreditation).
2. Use the GetAuthorizedUserList with the cookie created by the call to SetCredentials.

Generate hashed password

The System’s Access Hashed Password use crypt (SVr4, 4.3BSD, POSIX.1-2001) and the selected hashing method used is SHA-512 ($6).

Structure of the password :

$hash_type$salt$hashed_password

Example "password" hashed with salt "xkztK57I" with SHA-512 hashing :

$6$xkztK57I$2X7.o3ebRDKlWv8rHDG.aa2mudNHgpO1BohOc6TXMrLo/68VFTwVEglF7bp99xlyuSFjlT/wQHzvjScpSgDUS1

Example to generate password for Python 2.7+ :

import crypt
import string
import random
salt = ''.join(random.SystemRandom().choice(string.ascii_uppercase + string.ascii_lowercase + string.
digits) for _ in range(8))
salt = "$6$" + salt + "$"
hashed = crypt.crypt("password", salt)

Page 9
Conventions
The available XML-RPC functions are documented according to the following convention:
Results = function_name(Parameters)
Where:

1. Args are the function parameters and is a list of integer or string

2. Results are the values returned by the function call and is a array of integer, string, structure, array or any combination thereof.

Note: Globally the functions will returns 0 if their is a problem with the parameters.

Description

Software version
This documentation was generated for the following device:

Gate type TGL

Software T04E00V06R08

Compilation Date 2020-04-27 07:06:07

SVN 29384_040ed2efb583b8105ca28f57c28bef484c6a4af4

ApplyUpdate (Secured Function)

This is a secured function. To be able to use it, you need to be authenticated by the SetCredentials function.
This function applies the uploaded archive.
The archive must be uploaded via SFTP before calling this function:

user = upload
password = upload
target directory = update.

Results Type Comments

0 int
1: the gate is about to reboot
2: the archive is gzipped
3: can not read the file status of the
archive
4: the archive is too short
5: the archive is corrupted
6: There is not enough disk space for
the archive
7: The communication is lost. Try
again.
0: No changes needed
-1: Invalid archive

GetAuthorizedUserList (Secured Function)

Returns the list of users authorised to access the maintenance interface uploaded in the gate, as well as their password and accreditation
level.
Note: This is a secured function. To be able to use it, you need to be authenticated by the SetCredentials function.

Results Type SubType Descriptor Comments

0 int Number of authorised

users (N)

1..N struct int ivalue Index in array

string username User’s identifier

string password System’s Access Hashed

Password (See Annexes /
Generate hashed
password)

Page 10
 string level Level of accreditation
(profile) : technician,
integrator, client

Note: Accreditation levels are in descending order:

Technician
Integrator
Client

GetBuzzerFraud
Return the volume of the buzzer during a fraud

Results Type Comments

0 int Buzzer volume (between 0 and 255 )

GetBuzzerIntrusion
Return the volume of the buzzer during an intrusion

Results Type Comments

0 int Buzzer volume (between 0 and 255 )

GetClientInfo
Retrieve the Client information stored with SetClientInfo

Args Type Comments

0 string Client information (an empty string if never setted)

GetCounter
Return the current counters

Results Type SubType Descriptor Comments

0 int INbrCounterLabels Nb of Counters (N)

1 array of struct aCounters counters

string Name Message code for the #Counters

int Perp Perpetual value, never reset

int Main Main value, reset only by AS technicians

int Partial Partial value, may be reset by everyone

int Side Always 0 (kept for compatibility purpose)

int Level Accreditation level required to have access to the counter

Counters

The following counters are available through the XML-RPC Interface and through the Web Interface
The accreditation level required to have access to the counters is equal to "Client" for all counters available through this command

Code Level Name Description

"01001" Client Number of authorisations in Authorisations given to cross the

direction A gate from the entrance (A side)

"01002" Client Number of authorisations in Authorisations given to cross the

direction B gate from the exit (B side)

"01003" Client Crossings in direction A Complete passages from the

entrance to the exit

Page 11
 "01004" Client Crossings in direction B Complete passages from the exit
to the entrance

"01005" Client Intrusion in direction A An unauthorised person is standing

at the entrance while the gate is
idle or during a passage from the
entry

"01006" Client Intrusion in direction B An unauthorised person is standing

at the exit while the gate is idle or
during a passage from the exit

"01011" Client Exit timeout The exit has not been cleared
completely in the allotted time

"01015" Client Right motor reached side A open

position

"01016" Client Right motor reached side B open

position

"01021" Client Exit right motor reached side A

open position

"01022" Client Exit right motor reached side B

open position

"01045" Client No Entry timeout Timeouts during boarding (the

person did not enter the gate in the
allotted time)

"01047" Client Fraud disappearance A person has disappeared from the

gate

"01050" Client Number of validation Authorisations given to leave the

gate through the exit

"01051" Client Number of rejection Users rejected by the gate

"01053" Client Fraud camera occulted Somebody is hiding the camera

"01061" Client Validation in direction A Authorisations given to leave the

gate through the exit

"01062" Client Validation in direction B Authorisations given to leave the

gate through the entry

"01064" Client Total running time (s)

"01065" Client Total failure time (s)

"01067" Client Modbus Validation

"01074" Client Modbus Validation in direction A

"01075" Client Modbus Validation in direction B

"02040" Client Glitch

GetCounterFromTo
Return the list of counters saved every hour during a given time-period.
Note : This function can generate a lot of data, be sure that the used client/library support it, or use a smaller time range
Note2 : If the difference between date is more than 7 days, the query is executed only on the last 7 days of the time windows (maximum
24*7+1 entries)

Args Type Comments

0 int Starting date - Year

1 int Starting date - Month (1 - 12)

2 int Starting date - Day (1 - 31

3 int Starting date - Hour (0 - 23)

4 int Ending date - Year

5 int Ending date - Month (1 - 12)

6 int Ending date - Day (1 - 31)

7 int Ending date - Hour (0 - 23)

Page 12
 Results Type SubType SubSubType Descriptor Comments

0 int Number of counters backups (N)

1 array of struct int iYear Event date - Year

int iMonth Event date - Month

int iDay Event date - Day

int iHour Event date - Hour

int INbrCounterLabels Nb of Counters (M)

array of struct aCounters counters

string Name Message code for the #Counters

int Perp Perpetual value, never reset

int Main Main value, reset only by AS technicians

int Partial Partial value, may be reset by everyone

int Side Always 0 (kept for compatibility purpose)

int Level Accreditation level required to have access to the counter

Counters

The following counters are available through the XML-RPC Interface and through the Web Interface
The accreditation level required to have access to the counters is equal to "Client" for all counters available through this command

Code Level Name Description

"01001" Client Number of authorisations in Authorisations given to cross the

direction A gate from the entrance (A side)

"01002" Client Number of authorisations in Authorisations given to cross the

direction B gate from the exit (B side)

"01003" Client Crossings in direction A Complete passages from the

entrance to the exit

"01004" Client Crossings in direction B Complete passages from the exit

to the entrance

"01005" Client Intrusion in direction A An unauthorised person is standing

at the entrance while the gate is
idle or during a passage from the
entry

"01006" Client Intrusion in direction B An unauthorised person is standing

at the exit while the gate is idle or
during a passage from the exit

"01011" Client Exit timeout The exit has not been cleared
completely in the allotted time

"01015" Client Right motor reached side A open

position

"01016" Client Right motor reached side B open

position

"01021" Client Exit right motor reached side A

open position

"01022" Client Exit right motor reached side B

open position

"01045" Client No Entry timeout Timeouts during boarding (the

person did not enter the gate in the
allotted time)

"01047" Client Fraud disappearance A person has disappeared from the

gate

"01050" Client Number of validation Authorisations given to leave the

gate through the exit

"01051" Client Number of rejection Users rejected by the gate

"01053" Client Fraud camera occulted Somebody is hiding the camera

"01061" Client Validation in direction A Authorisations given to leave the

gate through the exit

Page 13
 "01062" Client Validation in direction B Authorisations given to leave the
gate through the entry

"01064" Client Total running time (s)

"01065" Client Total failure time (s)

"01067" Client Modbus Validation

"01074" Client Modbus Validation in direction A

"01075" Client Modbus Validation in direction B

"02040" Client Glitch

GetCurrentPassage
Return the summary of the last passage.

Results Type Comments

0 string File name

1 int
1: Tracking in progress
0: Tracking in standby, no occulted
sensor in the tracking area

2 int
0: Entry doors are closed
1: Entry doors are open or in motion

3 int
0: Exit doors are closed
1: Exit doors are open or in motion

4 int Amount of people detected by the camera

5 int Amount of people detected by the tracking

6 int Total of detected people

GetDate
Return the system date as UTC date/time.
Return the timezone modifier if available.

Results Type Comments

0 int Year (ex : 2016)

1 int Month (1..12)

2 int Day (1..31)

3 int Hour (0..23)

4 int Minute (0..59)

5 int Second (0..59)

6 (optional) int Seconds to be added to UTC for localtime (can be negative)

7 (optional) string Timezone string

GetDoorOperationModeList
Return the list of all lane status that are supported by the gate.

Results Type SubType Descriptor Comments

0 int Number of lane status (N)

Page 14
 1..N array of int ivalue Index in array

string sDescription Message code for the Door Modes

Door Modes

Message code Description

00323 Normally Closed

00325 Normally Opened A

00326 Normally Opened B

00320 Optical Mode A

00321 Optical Mode B

00318 Locked Closed

00327 Locked Open side A

00328 Locked Open side B

GetInputs
Return the current value of the digital and analog inputs.

Notes:

The value of the digital inputs are the logical state, not the electrical one.
If multiple digital inputs have the same function (i.e. the same sType), only one entry is present in the returned array. The iValue
field contains the result of a logical OR applied to all inputs of the corresponding type.
If multiple analog inputs have the same function (i.e. the same sType), only one entry is present in the returned array. The iValue
field contains the maximum value of all inputs of the corresponding type.

Results Type SubType Descriptor Comments

0 array of struct int iValue Value of digital Input i

0 : off
1 : on

string sType Message code for the #Digital Inputs

1 array of struct int iValue Value of analog Input i

0 : off
1 : on

string sType Message code for the #Analog Inputs

Digital Inputs

Message code Description

"74999" Disabled

"74090" Emergency evacuation EN13637

"74065" Emergency evacuation

"74955" Maintenance switch

"74061" Badge (direction A)

"74062" Badge (direction B)

"74972" Rejection

"74971" Validation

"74967" Normally Closed (entry door)

"74964" Locked opened A (entry door)

Page 15
 "74962" Locked Closed (entry door)

"74961" Normally Closed (exit door)

"74960" Locked opened A (exit door)

"74958" Locked Closed (exit door)

"74978" Safety (entry door)

"74901" Safety (exit door)

"74937" Customer Input 1

"74938" Customer Input 2

"74939" Customer Input 3

"74940" Customer Input 4

"74908" Customer Input 5

"74907" Customer Input 6

Analog Inputs

Message code Description

"74999" Disabled

"74985" Enabled

"74983" ASDAS : Left top

"74982" ASDAS : Right top

"74981" ASDAS : Left bottom

"74980" ASDAS : Right bottom

"74946" Left position sensor

"74945" Right position sensor

"74918" Exit Left position sensor

"74917" Exit Right position sensor

"74992" ADC1

"74885" ADC2

"74992" ADC1

"74885" ADC2

GetMaintenanceLogFromTo
Returns the list of events during a given time-period. Those events include :

the actions made by the operators from the maintenance’s interface

the infractions occured in the gate
the timeouts
the technical defects

Note : the number of actions returned by the method is limited to 1000 , to get all the information split the request.

Args Type Comments

0 int Start date - Year

1 int Start date - Month (1 - 12)

2 int Start date - Day (1 - 31

3 int Start date - Hour (0 - 23)

Page 16
 4 int Start date - Minute (0 - 59)

5 int Start date - Second (0 - 59)

6 int End date - Year

7 int End date - Month (1 - 12)

8 int End date - Day (1 - 31)

9 int End date - Hour (0 - 23)

10 int End date - Minute (0 - 59)

11 int End date - Second (0 - 59)

Results Type SubType Comments

0 int Number of actions made by the operators (N)

1..N array of struct 0: int Index

1: int Event date - Year

2: int Event date - Month

3: int Event date - Day

4: int Event date - Hour

5: int Event date - Minute

6: int Event date - Second

7: string Event description

8: string Event details

9: string Identifier of the user who performed the action (if relevant)

GetMotorSpeed
Return the opening and closing speeds of the doors. These speeds are defined in percent of the maximum speed, which is computed
internally by the application.
Modified using the maintenance interface SetMotorSpeed.
Note : the parameters defined in Results1 are only used when the gate is equipped with two sets of obstacles.

Results Type SubType Comments

0 array string "Entry"

int Standard opening speed percent

(0-100)

int Standard closing speed percent (0-

100)

int Security opening / closing speed

percent (0-100)
Used when somebody or
something is detected in the
security zone during a movement.
Also used when opening the gate
in case of emergency.

int Disapperance speed percent (0-

100)
Used when a person dissapears
while crossing the gate.

int Fraud closing speed percent (0-

100)

int Security fraud closing speed

percent (0-100)
Used when somebody or
something is detected in the
security zone while closing
because a fraud has been detected.

1 array string "Exit"

Page 17
 int Standard opening speed percent
(0-100)

int Standard closing speed percent (0-

100)

int Security opening / closing speed

percent (0-100).
Used when somebody or
something is detected in the
security zone during a movement.
Also used when opening the gate
in case of emergency.

int Disapperance speed percent (0-

100)
used when a person dissapears
while crossing the gate.

int Fraud closing speed percent (0-

100)

int Security fraud closing speed

percent (0-100)
used when somebody or
something is detected in the
security zone while closing
because a fraud has been detected.

GetOperatingDirection
Return the operating direction of the gate.
It specifies if the gate is available in both directions or not.

Results Type Comments

0 string Operating direction, see Message code for the Operating Direction

Operating Direction

Message code Description

"00329" Bidirectionnal gate: available in both directions

"00330" Unidirectional gate: available only in direction A

"00331" Unidirectional gate: available only in direction B

GetParkeonLogFromTo
Returns the list of events during a given time-period, those events are :

Parkeon status
Parkeon function
Parkeon validation result
Parkeon Contract Serial
Parkeon Media Serial
Parkeon nb of authorizations
Note : the Number of actions returned by the method is limited to 1000 , to get all the information please split the request.

Args Type Comments

0 int Starting date - Year

1 int Starting date - Month (1 - 12)

2 int Starting date - Day (1 - 31

3 int Starting date - Hour (0 - 23)

4 int Starting date - Minute (0 - 59)

5 int Starting date - Second (0 - 59)

6 int Ending date - Year

7 int Ending date - Month (1 - 12)

Page 18
 8 int Ending date - Day (1 - 31)

9 int Ending date - Hour (0 - 23)

10 int Ending date - Minute (0 - 59)

11 int Ending date - Second (0 - 59)

Results Type Comments

0 int Number of elements (N)

1..N int Index

int Event date - Year

int Event date - Month (1 - 12)

int Event date - Day (1 - 31)

int Event date - Hour (0 - 23)

int Event date - Minute (0 - 59)

int Event date - Second (0 - 59)

int Status

int Function

int Validation result

int Contract Serial

int Media Serial

int Number of Authorizations

GetProperties
Return the name assigned to the lane, the group that contains the lane, and the position of the lane in the group. These properties are used
by the Smart&Slim monitoring panel.

Results Type Descriptor Comments

0 int iPosition Position of the lane in the group

string sDeviceName Name of the lane

string sGroupName Name of the group that contains the lane

string sType Gate Type

string sFamily Gate Family (SlimLane, FirstLane ...)

string sSetup Gate Setup (Default or a specific client)

GetSetTempo
Change the timer durations (ms) and return the current/new values in Results.
If you pass -1 as a parameter it will not change the current timer value, so to get all the values pass 9 times -1.

Args Type Comments

0 int Time the obstacles remain open after a

user leaves the lane (in Free Mode).

1 int Unused (compatibility with old release).

2 int Time allotted to enter in the lane after an

authorisation is granted

3 int Unused (compatibility with old release).

Page 19
 4 int Intrusion time delay after a user is
detected in the lane (in Controlled Mode
only).

5 int Unused (compatibility with old release).

6 int Time allotted to completely cross the lane

after a person is detected.

7 int Time allotted to exit the safety zone.

8 int Time allotted to completely cross the lane

after an authorisation is granted

Results Type Comments

0..8 int Configured timer durations in ms (the

timers are not changed when the values
are not appropriate).

GetSideOperationModeList
Return the list of all entry/exit operating modes that are supported by the gate.

Results Type SubType Descriptor Comments

0 int Number of entry/exit operating mode (N)

1..N array of int ivalue Index in array

string sDescription Message code for the Side Operating Modes

Side Operating Modes

Message code Description

00316 Free

00315 Controlled

00317 Closed

GetStatus
Return status information. The following data are returned:

Summary
Number of entrance/exit authorisations
Lane status and entrance/exit operating mode
Frauds
Timeouts
Technical defects

Results Type SubType Descriptor Comments

0 string
Char 0: User
processing on-going
(0-1)
Char 1: Door is open
(0-1)
Char 2: Fraud or
Intrusion (0-1)
Char 3: Timeout (0-1)
Char 4: Technical
defect (0 : OK / 1 :
Minor defect / 2 :
Major defect)
Char 5: Emergency (0-
1)
Char 6: Maintenance
(0-1)
Char 7: Side modes
and #Door Modes
forced by inputs (0-1) 1

Page 20
 1 int Number of authorisations to
cross from the entrance

2 int Number of authorisations to

cross from the exit

3 string Operating mode of the

door, see Message code
for the #Door Modes

4 string Operating mode of the

entry side, Message code
for the Side Operating
Mode

5 string Operating mode of the exit

side, Message code for the
Side Operating Mode

6 int Number of infractions (I)

7 int Number of timeouts (T)

8 int Number of technical

defects (D)

9 array of string see Message code for the

#Infractions

10 array of string see Message code for the

#Timeouts

11 array of struct string sDescription see Message code for the

#Errors

int iIsMajor Severity

0: Minor
1: Major

12 string sDescription Operator’s identifier

registered in the
maintenance’s interface.
This field will be non-empty
if a logged user performed
an action on the
maintenance interface in
the last 5 minutes.
If multiple users are logged
simultaneously, only the
identifier corresponding to
the last action will be
returned.

13 int Number of validations

14 int Number of rejections

15 int Operating mode of the exit

door, see Message code
for the #Door Modes

16 int Number of persons in the

Gate

Note 1: The inputs are overwriting the configuration files and the configurations sent by Xml-Rpc.
Operator’s identifier
This field will be non-empty if a logged user performed an action on the maintenance interface in the last 5 minutes.
If multiple users are logged simultaneously, only the identifier corresponding to the last action will be returned.

Door Modes

Message code Description

"00323" Normally Closed

"00325" Normally Opened A

"00326" Normally Opened B

"00320" Optical Mode A

"00321" Optical Mode B

"00318" Locked Closed

Page 21
Side Operating Modes

Message code Description

"00316" Free

"00315" Controlled

"00317" Closed

Infractions

Message code Name Description

"01012" Fraud in direction A An unauthorised person has crossed the

gate from the entrance (A side)

"01013" Fraud in direction B An unauthorised person has crossed the

gate from the exit (B side)

"01048" Fraud crawling Somebody is crawling under the obstacles

"01052" Fraud jump Somebody has jumped over the obstacles

"01005" Intrusion in direction A An unauthorised person is standing at the

entrance while the gate is idle or during a
passage from the entry

"01006" Intrusion in direction B An unauthorised person is standing at the

exit while the gate is idle or during a
passage from the exit

"01007" Opposite direction intrusion in direction A An unauthorised person is standing at the

entrance during a passage from the exit

"01008" Opposite direction intrusion in direction B An unauthorised person is standing at the

exit during a passage from the entrance

"01060" Stop in the gate Someone has stopped his movement for
too long inside the gate.

"01063" Fraud in Mantrap

"01047" Fraud disappearance A person has disappeared from the gate

Timeouts

Message code Name Description

"01009" No crossing in direction A A passenger coming from the entrance (A

side) did not cross the gate in the allotted
time

"01010" No crossing in direction B A passenger coming from the exit (B side)

did not cross the gate in the allotted time

"01011" Exit timeout The exit has not been cleared completely
in the allotted time

"01045" No Entry timeout Timeouts during boarding (the person did

not enter the gate in the allotted time)

"01046" No crossing timeout A passenger coming did not cross the gate
in the allotted time

Errors

Message code Description

"02001"
Name : CAN Heartbeat
Major Error: One or more CAN boards are missing
Minor Error: There are too many CAN boards connected to
the bus

Page 22
"02002"
Name : Software version on CAN board
Major Error: Software version is not OK on 1 or more boards
Minor Error: Software version is not OK on 1 or more boards

"02003"
Name : Product number on CAN board
Major Error: One or more board product version is not OK
Minor Error: One or more board product version is not OK

"02004"
Name : DIRAS emitter
Major Error: A DIRAS emitter board has failed
Minor Error: A DIRAS emitter board has failed

"02005"
Name : DIRAS receiver
Major Error: A DIRAS receiver board has failed
Minor Error: A DIRAS receiver board has failed

"02006"
Name : Obstructed photocells
Major Error: One or more photocells are obstructed
Minor Error: One or more photocells are obstructed

"02008"
Name : Obstacle blocked
Major Error: The motor is blocked, verify if the motor can be
moved freely
Minor Error: The motor is blocked, verify if the motor can be
moved freely

"02009"
Name : Motor : high current consumption
Major Error: The motor current consumption is too high
Minor Error: The motor current consumption is too high

"02010"
Name : Brake
Major Error: The mechanical lock blocks the movement of
the obstacles
Minor Error: Brake malfunction. Check the brake output

"02011"
Name : Motor drive
Major Error: The motor board has failed or is not installed
Minor Error: The motor board has failed or is not installed

"02012"
Name : Detection
Major Error: Multiple photocells have failed
Minor Error: Multiple photocells have failed

"02013"
Name : Client communication
Major Error: No message have been received using the
communication interface. Check the wiring with the
“customer” device
Minor Error: Communication with server is lost

"02014"
Name : Frontal detection
Major Error: The communication with the camera is lost.
Check if the camera is powered and/or if there is activity on
the network cable.
Minor Error:

Page 23
"02026"
Name : Frontal detection occulted
Major Error:
Minor Error: Something obstruct the sight of view of the
camera. This minor defect leads to a camera fraud.

"02020"
Name : Temperature
Major Error: The processor or a motor board is overheating
Minor Error: The processor or a motor board is overheating

"02023"
Name : Motor drive configuration
Major Error: The obstacle width and/or height are not ok,
please measure the obstacles and check the dimensions in
the motor parameters
Minor Error: The obstacle width and/or height are not ok,
please measure the obstacles and check the dimensions in
the motor parameters

"02024"
Name : Egress configuration
Major Error: Error on Egress input. Check the input. If the
gate have no egress function check the configuration
(configuration > General configuration > Mode configuration
> Security mode )
Minor Error: Error on Egress input. Check the input. If the
gate have no egress function check the configuration
(configuration > General configuration > Mode configuration
> Security mode )

"02025"
Name : Motor not initialized
Major Error: One or more motor did not finish its
initialisation. If the door has moved check the limit switches, if
not, check if no cells are obstructed ( Individual tests > IR
sensors )
Minor Error:

"02019"
Name : Installation
Major Error: One or more board does not have the same
number of IO as configured. Create an debug archive to
investigate this problem
Minor Error: Wrong detection plane height. The default
value based on the gate type is used.

"02027"
Name : CPU
Major Error: CPU board is faulty and must be replaced
Minor Error: CPU board is faulty and must be replaced

"02028"
Name : CAN Overflow
Major Error: There are too many CAN message on the bus.
Check the CANbus information (individual tests).
Minor Error: There are too many CAN messages on the bus.
Check the bus status (Individual Tests > Diagnostics).

"02021"
Name : Inputs/Outputs
Major Error: Error while reading the value of the angular
position sensor. Check if it is correctly connected to the
motherboard. Check if the sensor is working correctly
Minor Error: One or more of the digital outputs is/are active
but not using power. Check the page: Visualization > Show
device info. The corresponding output(s) will appear in red.
Check the outputs connections and if the connected device is
working as expected.

Page 24
 "02031"
Name : Extension board
Major Error: Check connection with the extension board and
then restart the system
Minor Error: Check connection with the extension board and
then restart the system

"02033"
Name : Client controller failure
Major Error: The client controller / CPU is defective, please
check its own maintenance interface to correct this problem
Minor Error: The client controller / CPU is defective, please
check its own maintenance interface to correct this problem

"02032"
Name : CAN bus
Major Error: Abnormal error rate on CAN bus, please check
wiring and shielding (check Unitary Test>Diagnostic>CANx)
Minor Error: Abnormal error rate on CAN bus, please check
wiring and shielding (check Unitary Test>Diagnostic>CANx)

"02034"
Name : Failed FTP synchronisation
Major Error:
Minor Error: No answer from ftp server

"02035"
Name : LCD
Major Error:
Minor Error: No communiction with LCD. Check wiring or
replace the LCD

"02036"
Name : Reader
Major Error: No Communication with the reader, check the
wiring or replace the Reader
Minor Error: No Communication with the reader, check the
wiring or replace the Reader

"02037"
Name : Camera error
Major Error: Check the connection with the camera
computer, and connect on its maintenance interface
Minor Error:

"02038"
Name : Sound reader error
Major Error:
Minor Error: No communication with sound board. Check
the wiring or replace the sound board

"02039"
Name : Camera version error
Major Error:
Minor Error: Check Camacq version

"02041"
Name : Camera height error
Major Error:
Minor Error: Check Camacq Camera Height

GetVersion
Return the installed software attributes

Results Type Comments

Page 25
 0 string Type of the lane

1 string Automatic Systems software version

2 string Compilation date

3 string GIT version

4 string GIT date

SendReboot
Reboot the whole system immediately.

Results Type Comments

0 int 1 : OK

SendRestart
Restart the application immediately.

Results Type Comments

0 int 1 : OK

SetAuthorisation
Sets the number of authorisations for both directions (entry to exit and exit to entry)
Since this command must wait for the functional module to cycle before setting the Results, it may take up to 200ms before sending the
response

Args Type Comments

0 int Number of authorisations for direction A (entry to exit)

1 int Number of authorisations for direction B (exit to entry)

2 int Number of validations in the mantrap

3 int Number of rejections in the mantrap

Results Type Comments

0 int 1 : OK

SetAuthorisationTGL
Set the number of authorisations for both directions (entry to exit and exit to entry)

Args Type Comments

0 int Number of authorisations for direction A (entry to exit)

1 int Number of authorisations for direction B (exit to entry)

2 int Number of validations in the mantrap

3 int Number of rejections in the mantrap

Results Type Comments

0 int 1 : OK

SetAuthorizedUserList (Secured Function)

This is a secured function. To be able to use it, you need to be authenticated by the SetCredentials function.

Page 26
Establishes and uploads the list of users authorised to access the maintenance interface uploaded in the gate, as well as their password and
accreditation level.
The easiest way to update the user list is to first get them via GetAuthorizedUserList function.
Note : the command completely replaces the current user list.

Args Type SubType Descriptor Comments

0 int Number of authorised

users (N)

1..N struct int ivalue Index in array

string username User’s identifier

string password System’s Access Hashed

Password (See Annexes /
Generate hashed
password)

string level Level of accreditation

(profile) : technician,
integrator, client

Results Type Comments

0 int
1: User’s list properly uploaded
0: No changes needed
-1: Invalid number of arguments or
Invalid value for Params 0
-2: Error in some element Params N

Note : Accreditation levels are in descending order:

Technician
Integrator
Client

SetBuzzerFraud
Configure the volume of the buzzer during a fraud.

Args Type Comments

0 int Buzzer volume (between 0 and 255 )

1 int Buzzer note (optional field)

0: Disabled
1: C / DO
2: D / RE
3: E / MI
4: F / FA
5: G / SOL
6: A / LA
7: B / SI

Results Type Comments

0 int
1: Valid
0: Invalid number of Params
-1: Not valid

SetBuzzerIntrusion
Configure the volume of the buzzer during an intrusion.

Args Type Comments

0 int Buzzer volume (between 0 and 255 )

Page 27
 1 int Buzzer note (optional field)

0: Disabled
1: C / DO
2: D / RE
3: E / MI
4: F / FA
5: G / SOL
6: A / LA
7: B / SI

Results Type Comments

0 int
1: Valid
0: Invalid number of Params
-1: Not valid

SetClientInfo
Set the Client information string

Args Type Comments

0 string The string to be stored, 64 chars maximum

Type Comments

string
"OK"
"Invalid lenght"
"Invalid number of arguments"

SetCredentials (Secured Function)

In order to enable some critical functionalities, the user must first be authenticated using this XML-RPC function.
This function returns a cookie header (XMLRPCID) that needs to be sent back with the secured function.
SetCredentials requires "technician" or "integrator" level of accreditation.

Args Type Comments

0 string User name

1 string User password

Results Type Comments

0 int
1: Access granted
0: Invalid number of Params
-1: Access denied

Note : Accreditation levels are in descending order:

Technician
Integrator
Client

SetDate
Change the system date, used for log synchronisation.
Date/Time is considered as being UTC.

Args Type Comments

0 int Year (ex : 2016)

Page 28
 1 int Month (1..12)

2 int Day (1..31)

3 int Hour (0..23)

4 int Minute (0..59)

5 int Second (0..59)

6 (optional) string Timezone string

Results Type Comments

0 int
1 : Success
0 : Invalid number of parameters
-1: Not OK

Accepted timezone list:

Africa/Abidjan, Africa/Accra, Africa/Addis_Ababa, Africa/Algiers, Africa/Asmara, Africa/Asmera, Africa/Bamako, Africa/Bangui, Africa/Banjul,
Africa/Bissau, Africa/Blantyre, Africa/Brazzaville, Africa/Bujumbura, Africa/Cairo, Africa/Casablanca, Africa/Ceuta, Africa/Conakry, Africa
/Dakar, Africa/Dar_es_Salaam, Africa/Djibouti, Africa/Douala, Africa/El_Aaiun, Africa/Freetown, Africa/Gaborone, Africa/Harare, Africa
/Johannesburg, Africa/Juba, Africa/Kampala, Africa/Khartoum, Africa/Kigali, Africa/Kinshasa, Africa/Lagos, Africa/Libreville, Africa/Lome,
Africa/Luanda, Africa/Lubumbashi, Africa/Lusaka, Africa/Malabo, Africa/Maputo, Africa/Maseru, Africa/Mbabane, Africa/Mogadishu, Africa
/Monrovia, Africa/Nairobi, Africa/Ndjamena, Africa/Niamey, Africa/Nouakchott, Africa/Ouagadougou, Africa/Porto-Novo, Africa/Sao_Tome,
Africa/Timbuktu, Africa/Tripoli, Africa/Tunis, Africa/Windhoek, Atlantic/Azores, Atlantic/Bermuda, Atlantic/Canary, Atlantic/Cape_Verde,
Atlantic/Faeroe, Atlantic/Faroe, Atlantic/Jan_Mayen, Atlantic/Madeira, Atlantic/Reykjavik, Atlantic/South_Georgia, Atlantic/Stanley, Atlantic
/St_Helena, America/Adak, America/Anchorage, America/Anguilla, America/Antigua, America/Araguaina, America/Argentina/Buenos_Aires,
America/Argentina/Catamarca, America/Argentina/ComodRivadavia, America/Argentina/Cordoba, America/Argentina/Jujuy, America
/Argentina/La_Rioja, America/Argentina/Mendoza, America/Argentina/Rio_Gallegos, America/Argentina/Salta, America/Argentina/San_Juan,
America/Argentina/San_Luis, America/Argentina/Tucuman, America/Argentina/Ushuaia, America/Aruba, America/Asuncion, America
/Atikokan, America/Atka, America/Bahia, America/Bahia_Banderas, America/Barbados, America/Belem, America/Belize, America/Blanc-
Sablon, America/Boa_Vista, America/Bogota, America/Boise, America/Buenos_Aires, America/Cambridge_Bay, America/Campo_Grande,
America/Cancun, America/Caracas, America/Catamarca, America/Cayenne, America/Cayman, America/Chicago, America/Chihuahua,
America/Coral_Harbour, America/Cordoba, America/Costa_Rica, America/Creston, America/Cuiaba, America/Curacao, America
/Danmarkshavn, America/Dawson, America/Dawson_Creek, America/Denver, America/Detroit, America/Dominica, America/Edmonton,
America/Eirunepe, America/El_Salvador, America/Ensenada, America/Fortaleza, America/Fort_Nelson, America/Fort_Wayne, America
/Glace_Bay, America/Godthab, America/Goose_Bay, America/Grand_Turk, America/Grenada, America/Guadeloupe, America/Guatemala,
America/Guayaquil, America/Guyana, America/Halifax, America/Havana, America/Hermosillo, America/Indiana/Indianapolis, America/Indiana
/Knox, America/Indiana/Marengo, America/Indiana/Petersburg, America/Indiana/Tell_City, America/Indiana/Vevay, America/Indiana
/Vincennes, America/Indiana/Winamac, America/Indianapolis, America/Inuvik, America/Iqaluit, America/Jamaica, America/Jujuy, America
/Juneau, America/Kentucky/Louisville, America/Kentucky/Monticello, America/Knox_IN, America/Kralendijk, America/La_Paz, America/Lima,
America/Los_Angeles, America/Louisville, America/Lower_Princes, America/Maceio, America/Managua, America/Manaus, America/Marigot,
America/Martinique, America/Matamoros, America/Mazatlan, America/Mendoza, America/Menominee, America/Merida, America/Metlakatla,
America/Mexico_City, America/Miquelon, America/Moncton, America/Monterrey, America/Montevideo, America/Montreal, America
/Montserrat, America/Nassau, America/New_York, America/Nipigon, America/Nome, America/Noronha, America/North_Dakota/Beulah,
America/North_Dakota/Center, America/North_Dakota/New_Salem, America/Ojinaga, America/Panama, America/Pangnirtung, America
/Paramaribo, America/Phoenix, America/Port-au-Prince, America/Porto_Acre, America/Port_of_Spain, America/Porto_Velho, America
/Puerto_Rico, America/Punta_Arenas, America/Rainy_River, America/Rankin_Inlet, America/Recife, America/Regina, America/Resolute,
America/Rio_Branco, America/Rosario, America/Santa_Isabel, America/Santarem, America/Santiago, America/Santo_Domingo, America
/Sao_Paulo, America/Scoresbysund, America/Shiprock, America/Sitka, America/St_Barthelemy, America/St_Johns, America/St_Kitts,
America/St_Lucia, America/St_Thomas, America/St_Vincent, America/Swift_Current, America/Tegucigalpa, America/Thule, America
/Thunder_Bay, America/Tijuana, America/Toronto, America/Tortola, America/Vancouver, America/Virgin, America/Whitehorse, America
/Winnipeg, America/Yakutat, America/Yellowknife, Asia/Aden, Asia/Almaty, Asia/Amman, Asia/Anadyr, Asia/Aqtau, Asia/Aqtobe, Asia
/Ashgabat, Asia/Ashkhabad, Asia/Atyrau, Asia/Baghdad, Asia/Bahrain, Asia/Baku, Asia/Bangkok, Asia/Barnaul, Asia/Beirut, Asia/Bishkek,
Asia/Brunei, Asia/Calcutta, Asia/Chita, Asia/Choibalsan, Asia/Chongqing, Asia/Chungking, Asia/Colombo, Asia/Dacca, Asia/Damascus, Asia
/Dhaka, Asia/Dili, Asia/Dubai, Asia/Dushanbe, Asia/Famagusta, Asia/Gaza, Asia/Harbin, Asia/Hebron, Asia/Ho_Chi_Minh, Asia/Hong_Kong,
Asia/Hovd, Asia/Irkutsk, Asia/Istanbul, Asia/Jakarta, Asia/Jayapura, Asia/Jerusalem, Asia/Kabul, Asia/Kamchatka, Asia/Karachi, Asia
/Kashgar, Asia/Kathmandu, Asia/Katmandu, Asia/Khandyga, Asia/Kolkata, Asia/Krasnoyarsk, Asia/Kuala_Lumpur, Asia/Kuching, Asia
/Kuwait, Asia/Macao, Asia/Macau, Asia/Magadan, Asia/Makassar, Asia/Manila, Asia/Muscat, Asia/Nicosia, Asia/Novokuznetsk, Asia
/Novosibirsk, Asia/Omsk, Asia/Oral, Asia/Phnom_Penh, Asia/Pontianak, Asia/Pyongyang, Asia/Qatar, Asia/Qostanay, Asia/Qyzylorda, Asia
/Rangoon, Asia/Riyadh, Asia/Saigon, Asia/Sakhalin, Asia/Samarkand, Asia/Seoul, Asia/Shanghai, Asia/Singapore, Asia/Srednekolymsk, Asia
/Taipei, Asia/Tashkent, Asia/Tbilisi, Asia/Tehran, Asia/Tel_Aviv, Asia/Thimbu, Asia/Thimphu, Asia/Tokyo, Asia/Tomsk, Asia/Ujung_Pandang,
Asia/Ulaanbaatar, Asia/Ulan_Bator, Asia/Urumqi, Asia/Ust-Nera, Asia/Vientiane, Asia/Vladivostok, Asia/Yakutsk, Asia/Yangon, Asia
/Yekaterinburg, Asia/Yerevan, Australia/ACT, Australia/Adelaide, Australia/Brisbane, Australia/Broken_Hill, Australia/Canberra, Australia
/Currie, Australia/Darwin, Australia/Eucla, Australia/Hobart, Australia/LHI, Australia/Lindeman, Australia/Lord_Howe, Australia/Melbourne,
Australia/North, Australia/NSW, Australia/Perth, Australia/Queensland, Australia/South, Australia/Sydney, Australia/Tasmania, Australia
/Victoria, Australia/West, Australia/Yancowinna, Brazil/Acre, Brazil/DeNoronha, Brazil/East, Brazil/West, Canada/Atlantic, Canada/Central,
Canada/Eastern, Canada/Mountain, Canada/Newfoundland, Canada/Pacific, Canada/Saskatchewan, Canada/Yukon, Chile/Continental,
Chile/EasterIsland, Europe/Amsterdam, Europe/Andorra, Europe/Astrakhan, Europe/Athens, Europe/Belfast, Europe/Belgrade, Europe
/Berlin, Europe/Bratislava, Europe/Brussels, Europe/Bucharest, Europe/Budapest, Europe/Busingen, Europe/Chisinau, Europe
/Copenhagen, Europe/Dublin, Europe/Gibraltar, Europe/Guernsey, Europe/Helsinki, Europe/Isle_of_Man, Europe/Istanbul, Europe/Jersey,
Europe/Kaliningrad, Europe/Kiev, Europe/Kirov, Europe/Lisbon, Europe/Ljubljana, Europe/London, Europe/Luxembourg, Europe/Madrid,
Europe/Malta, Europe/Mariehamn, Europe/Minsk, Europe/Monaco, Europe/Moscow, Europe/Nicosia, Europe/Oslo, Europe/Paris, Europe
/Podgorica, Europe/Prague, Europe/Riga, Europe/Rome, Europe/Samara, Europe/San_Marino, Europe/Sarajevo, Europe/Saratov, Europe
/Simferopol, Europe/Skopje, Europe/Sofia, Europe/Stockholm, Europe/Tallinn, Europe/Tirane, Europe/Tiraspol, Europe/Ulyanovsk, Europe
/Uzhgorod, Europe/Vaduz, Europe/Vatican, Europe/Vienna, Europe/Vilnius, Europe/Volgograd, Europe/Warsaw, Europe/Zagreb, Europe

Page 29
/Zaporozhye, Europe/Zurich, Indian/Antananarivo, Indian/Chagos, Indian/Christmas, Indian/Cocos, Indian/Comoro, Indian/Kerguelen, Indian
/Mahe, Indian/Maldives, Indian/Mauritius, Indian/Mayotte, Indian/Reunion, Mexico/BajaNorte, Mexico/BajaSur, Mexico/General, Pacific/Apia,
Pacific/Auckland, Pacific/Bougainville, Pacific/Chatham, Pacific/Chuuk, Pacific/Easter, Pacific/Efate, Pacific/Enderbury, Pacific/Fakaofo,
Pacific/Fiji, Pacific/Funafuti, Pacific/Galapagos, Pacific/Gambier, Pacific/Guadalcanal, Pacific/Guam, Pacific/Honolulu, Pacific/Johnston,
Pacific/Kiritimati, Pacific/Kosrae, Pacific/Kwajalein, Pacific/Majuro, Pacific/Marquesas, Pacific/Midway, Pacific/Nauru, Pacific/Niue, Pacific
/Norfolk, Pacific/Noumea, Pacific/Pago_Pago, Pacific/Palau, Pacific/Pitcairn, Pacific/Pohnpei, Pacific/Ponape, Pacific/Port_Moresby, Pacific
/Rarotonga, Pacific/Saipan, Pacific/Samoa, Pacific/Tahiti, Pacific/Tarawa, Pacific/Tongatapu, Pacific/Truk, Pacific/Wake, Pacific/Wallis,
Pacific/Yap, US/Alaska, US/Aleutian, US/Arizona, US/Central, US/Eastern, US/East-Indiana, US/Hawaii, US/Indiana-Starke, US/Michigan,
US/Mountain, US/Pacific, US/Pacific-New, US/Samoa, Global/CET, Global/CST6CDT, Global/EET, Global/EST, Global/EST5EDT, Global
/GMT, Global/HST, Global/MET, Global/MST, Global/MST7MDT, Global/NZ, Global/PRC, Global/PST8PDT, Global/ROC, Global/ROK,
Global/UCT, Global/UTC, Global/WET, Global/W-SU

SetEmergency
Put the gate in emergency mode or return to normal operation mode
When the emergency mode is set by a digital input, this command has no effect.

Args Type Comments

0 int Emergency mode.

0: Disabled
1: Enabled

Results Type Comments

0 int
1 : Success
0 : Invalid number of parameters
-1: Invalid value

SetMaintenanceMode
Sets the gate in maintenance mode (door are in free wheel)
After reboot, the modifications are lost

Args Type Comments

0 int
1: Enable
0: Disable

Results Type Comments

0 int
1: Success
0: Invalid number of parameters
*-1: Not OK

SetMode
Set the lane status, the entry operating mode and the exit operating mode. You can change specific parameters by setting invalid value (like
empty string) for the parameter(s) you don't want to change.
After reboot, the modifications are lost (the gate will use the modes written in its configuration file)
Note : Take care to use, string arguments.

Args Type Comments

0 string Entrance door, see Message code for the #Door Modes

1 string Entrance Side, see Message code for the #Side Operating Modes

2 string Exit Side, see Message code for the #Side Operating Modes

3 string Exit door, see Message code for the #Door Modes

Results Type Comments

Page 30
 0 int
1 : Success
-1 : All Params are invalid

Door Modes

Message code Description

"00323" Normally Closed

"00325" Normally Opened A

"00326" Normally Opened B

"00320" Optical Mode A

"00321" Optical Mode B

"00318" Locked Closed

Side Operating Modes

Message code Description

"00316" Free

"00315" Controlled

"00317" Closed

SetMotorSpeed
Configure the opening and closing speeds of the doors. These speeds are defined in percent (0-100) of the maximum speed, which is
computed internally by the application.
See the Maintenance Interface Manual for detailed information about the different speeds.
Notes

The parameters are saved in the configuration files.

Need to call SendRestart to apply the new values.
The parameters defined in Results 1 are only used when the gate is equipped with two sets of obstacles.

Args Type Comments

0 string "Entry" or "Exit"

1 int Standard opening speed percent (0-100)

2 int Standard closing speed percent (0-100)

3 int Security opening / closing speed percent

(0-100).

4 int Disapperance speed percent (0-100), used

when a person dissapears while crossing
the gate.

5 int Fraud closing speed percent (0-100)

6 int Security fraud closing speed percent (0-

100), used when somebody or something
is detected in the security zone while
closing because a fraud has been
detected.

Results Type Comments

0 int
1: Valid
0: Invalid number of Params
-1: Not valid

Page 31
SetOperatingDirection
Set the operating direction of the gate.
Note : Take care to use, for example, 00329 and not 329.

Args Type Comments

0 string Operating direction, see Message code for the Operating Direction

Results Type Comments

0 int
1 : Success
-1 : invalid value

Operating Direction

Message code Description

"00329" Bidirectionnal gate: available in both directions

"00330" Unidirectional gate: available only in direction A

"00331" Unidirectional gate: available only in direction B

SetOutputClient
Sets the client-controlled binary digital outputs and pictograms
For Customer outputs, refer to the 'Digital output' table
For Customer pictograms, refer to the 'Pictograms' table

Args Type Comments

0 int Customer Output 1

1 int Customer Output 2

2 int Customer Pictogram 1

3 int Customer Pictogram 2

4 int Customer Pictogram 3

5 int Customer Pictogram 4

6 int Customer Output 3

7 int Customer Output 4

8 int Customer Output 5

9 int Customer Output 6

10 int Customer Output 7

11 int Customer Output 8

12 int Customer Output 9

Results Type Comments

0 int 1: OK

Digital Outputs

Value Description

0 Off

1 On

2 Temporized

Page 32
 3 Pulsing

Pictograms

Value Description

0 Off

1 Red

2 Green

3 Yellow

4 Blue

5 Magenta

6 Cyan

7 White

8 Custom

9 Pulsing Red

10 Pulsing Green

11 Pulsing Yellow

12 Pulsing Blue

13 Pulsing Magenta

14 Pulsing Cyan

15 Pulsing White

16 Pulsing Custom

Note : The pulsing frequency is equal to 1Hz.

SetProperties
Set the name assigned to the lane, the group that contains the lane, and the position of the lane in the group. These properties are used by
the Smart&Slim monitoring panel.

Paramaters Type Comments

0 string Name of the group that contains the lane

1 string Name of the lane

2 int Position of the lane in the group

Results Type Comments

0 int
1: OK
0: Invalid number of Params
-1: Invalid param values

Page 33