Sie sind auf Seite 1von 71

Developers Manual

EasyInner SDK
MD EasyInner-01-03-07/13/2007

Index

! "#

$%

!
&

$'

("

"

))

'(
+
+

!
!" #
$ % &
$
&
!
) *! &
$ %
! &
$
! &
$ % &
$
&
&

$'

$*

,
,
,
,
,

Description of Functions:

- . * &

/
/
/
/
/
23
23
23
23
23
2%
2%
2%

*&
$
*
.* .* *
.
.
.
.
.
.(

+ !0 .
&
- 1. &
1. &
&
&
- &
&
'
! &
45
! &
'
! &( ! &
45
! &( ! &
4
! &
0 .
&

,
*
*
6

&
&

-$

0 .
0 .
! 6

*
*
*
*
*

7'
%

7
7

.
.
% 0
.
0
!* '
!*
)(
)(
9 : 4
9 :
.
;
!! *
;
!!
( ;
!+
(
* $(
*
$*
) *!
$*
+
.
.
.* $
.*
- <
+
4=
.
!!
)
+
+
*
+
'(
4
4
7
'(
7
!
&
- > !
$
6
! 0 .
$
*
? * !
.
6
7'
4
'(
*
&
.
'( $
'( 6
7+

* &
>
7

7 7+ 7
76 7+
&
7 &
7+ &
76
7+

%
7

74 * !
&
76

&

7+

&

83
7
83

* 6

"#$ %%&'

2
2
2
22
22
22
22
22
28
28
28
28
28
2
2
2
2
2
2
2
2
2
2
2,
2,
2,
2/
2/
2/

&

) )

Description of Functions:

&
6
'( 6

6
&

76

7+

8
8

.
* .
&
9
'( 6

&

.
&
.

'( +
'( +

*
*

'(

7'
&
7'
)

&
6 7+

74 * ! 7

&

7+@ 7

7.

7-

7;

7;

74

74

&

76

&

8/
'%

74

/"
&
&

!7
'
7

!7

'

7+ 7

76

!7
3
7
%

+ !
0 .
'
! + !
+
*
!
+
*
!
'
! + !
*
*
+

'$
%74

)
33 &
&

"#$ %%&'

7+

.
*
*

8,
!7
8,
8,

'(

8
8
8
8
8
8
8
8

'
! 0 .
&
7; !
!7
!
! 0 .
&
70 * 7
74 * !

'

, )

'(

'( +
'( +

88
88

76

&

. 4

!
3

*
7+

0 1 22

4
4

&

7+

* '
!0 .
'
7+
*
* 4 !0 .
'
7+
*
*
! 0 .
'
7+
*
*
0 .
+
* 7
76
* 0 .
&
* 0 .
&
*
7
7$ %7$
*
&
.

* 6
6
*
'( 6

0 .
&
0 .

.
+
+
+
+
'( +
* +

82
82
82

!76

74

,
7+
7+

'*
*

2
2
5

0 .
6
7
0 .
! 7.
%7.
7
+ !
0 .
'
7+
*
+ !
0 .
'
7+
*
0 .
'
!
!0 .
* 7'
A7
!
0 . 0 .
&

'
8
8
8

) )

Description of Functions:

/ "

'6

B
=
1 !!
4
+ ! - &
$
+ ! - &
70 . 7+ !
4
>
- &
$
>
- &
70 . 7>
7>
4
;
!!9
- &
$
;
!!9
- &
70 . 7;
!!
4
9
!
!- &
79
$
9
!
!- &
70 . 7
4
'
9
&
79
9
'
! &
70 .
&
9
.
- &
7
79
$
!&
9
.
- &
70 .
$
!>
&
70 .
: &
!
- &
$
!&
!
&
70 . 79
4
.
&
$
.
&
70 . 7
*
- &
76
&
!
76
>
$
!
*
- &
70 .
'( 9
- &
7
9
'( ! &
70 .
* .
&
7
$
!
* .
&
70 .
&
9
4
* '( . 9
4
* - &
4
- .* .*
3
&
4
$
$

:
.
9

*6

&

,
,
,
,
/

- &
79

6%

' ( 4 *&
. -A + !
+ !

"#$ %%&'

2
2
2
8
8
8

. 9
9
. 9
.
&
9

5 #)

,
,
,
/
/
/
/
3
3
3
%

+ !
74 7

4 #
7

7&

3
3
3

) !)

3 9

Description of Functions:

Revision History

: 3
%

!
3C
3C
3
23C
3C
3

(
D*
$

%2C
3C
3

D*

!
(
E
E
E
E
E

!
&
&
&
&

E&
!
E&
E&

"#$ %%&'

!
!
!
!
!
!

!
!

"

!
A =

*
4

! !
+

!
!
*
1

! *
!
!
=

&

) )

Introduction
Description of Functions:

Library for communication with the Inners


Introduction
Topdata Sistemas de Automao Ltda, manufacturer of the Inner line equipments, has developed and
provides the library for communication with Inner line equipments.
Whenever Inner is mentioned, a reference is also made to other equipment, such as Inner Plus, Inner
Catraca, Inner Bio, Inner Verid, and others, which have very similar functions.
Five files are necessary in order to communicate with the Inners:
1 - EasyInner.dll File that provides all the interface described in this manual, it is the only
file your application should access directly. Compatible with Windows 95, 98, ME, NT,
2000, XP, or later.
2 Inner2K.dll File used by EasyInner.dll, this file should be copied to the
same directory in which EasyInner dll was installed. It will not be directly accessed by the
application. Responsible for the serial communication.
3 InnerTCP.dll File used by EasyInner.dll, this file should be copied to the
same directory in which EasyInner dll was installed. It will not be directly accessed by the
application. Responsible for the TCP/IP communication with the variable port.
4 InnerTCP2.dll File used by EasyInner.dll, this file should be copied to the
same directory in which EasyInner dll was installed. It will not be directly accessed by the
application. Responsible for the TCP/IP communication with the fixed port.
5 InnerTCPLib.dll File used by InnerTCP2.dll, this file should be copied to the
same directory in which InnerTCP2 dll was installed. It will not be directly accessed by the
application.
For greater detail about the functions of the Inner line equipments, check the manual packaged with the
product.
Send us your questions or suggestions to the e-mail desenvolvimento@topdata.com.br . Send the
question only or a piece of code related to the question/problem.

"#$ %%&'

) )

Description of Functions:

Inner communication modes


Serial Mode:
In this operating mode, the inner receives all settings needed from the software and starts operating
independently, without having to be connected to the PC. The transactions made by users are stored in
the equipments memory, being necessary to collect them later.

TCP/IP Mode:
In this operating mode, the inner receives all settings needed from the software and starts operating
independently, without having to be connected to the PC. The transactions made by users are stored in
the equipments memory, being necessary to collect them later.

"#$ %%&'

) )

Operation Modes
Description of Functions:

Inner operating modes


Off Line Mode:
In this operating mode, the inner receives all settings needed from the software and starts operating
independently, without having to be connected to the PC. The transactions made by users are stored in
the equipments memory, being necessary to collect them later.

On Line Mode
In this operating mode, the inner operates totally dependent on the software, as a dumb terminal. All
actions must be taken in real time by the software and sent to the inner.
When under online mode, the software should run a sequence of basic steps to operate properly. Such
steps are:
1 - Open the communication port.

2 Connect to inner.

3 Setup Inner to Online mode.

4 - Send inner'
s Online standard message.
5 Setup Online data entry forms.

6 Loop using function ReceberDadosOnLine by polling in the inner.

7 When receiving some data, you may perform some validations, send a
temporary message, activate inners beep, etc. Go back to step 4.

"#$ %%&'

) )

Description
Status Machine
of Functions:

Status Machine
We recommend your program follows what we agreed to call the Status Machine. The Status
Machine is no more than a routine which loops testing a variable we call Status. Depending on the current
status, we run some procedures and, then, change the status that is to be checked by the status machine
again in the next step of the loop.
As a result, the program makes the understanding and maintenance of the code easier. To better make
an example of the concept, open the On-Line example software that comes with this SDK.
In case you are using Visual Basic, the example can be found in the "Exemplos\VB\On-Line folder.
In case you are using Delphi, the example can be found in the "Exemplos\Delphi\On-Line folder.
In case you are using Java, the example can be found in the "Exemplos\Java\On-Line folder.

Try to connect to Inner using Ping


command.

Connecting

Set up

Send Standard
Message

Keeps asking Inner if


there are data.

Set up Online
Entries

Receive Online
Data - Polling

In case there are, run the proper tasks and set


Inner entries again.

Note that the status sequence follows a logic order, thus making it easier to comprehend the
operation of the process as a whole. Such example is a functional and may be used as basis for its
development.

"#$ %%&'

Description of Functions:

The fake code below shows an Inners status machine:


//Variable to store the current status of each Inner, lets suppose that the vector has already been
initialized using value 1 for each index.
Inteiro VetorInners[32];
//Variable that says which Inner we are talking about
Inteiro InnerAtual = 1;
//Defines what type of communication is to be used (in this case, TCP/IP)
DefinirTipoConexao(1);
//Close previously opened communication port, only as a precautionary measure
FecharPortaComunicacao();
//Initializes the TCP/IP communication port, the parameter is ignored in this case
if(AbrirPortaComunicacao(3570) = 0){
while(TRUE){
//Check what is Inners current status
Case VetorInner[InnerAtual] {
1: //Runs status 1 for the current Inner, connects to the inner
if( Ping(InnerAtual) = 0 ){
//Takes current Inner to the next status
VetorInners[InnerAtual] = 2;
}
2: //Runs status 2 for the current Inner, sets the inner
ConfigurarInnerOnLine();
DefinirQuantidadeDigitosCartao( 14 );
HabilitarTeclado( 1, 0 );
ConfigurarTipoLeitor( 0 );
ConfigurarLeitor1( 3 );
ReceberDataHoraDadosOnLine( 1 );
if( EnviarConfiguracoes( InnerAtual ) = 0) {
//Sets current Inner to the next status
VetorInners[InnerAtual] = 3;
}
3: //Runs status 3 for the current Inner, sends standard message
if( EnviarMensagemPadraoOnLine(InnerAtual, 1, " ON LINE ") = 0){
//Sets current Inner to the next status
VetorInners[InnerAtual] = 4;
}
4: //Runs status 4 for the current Inner, sets entry forms
if( EnviarFormasEntradasOnLine(InnerAtual, 6, 1, 7, 15, 17) = 0){
//Sets current Inner to the next status
VetorInners[InnerAtual] = 5;

"#$ %%&'

Description of Functions:

}
5: //Runs step 5 for current Inner, keeps polling
if(ReceberDadosOnLine(InnerAtual, Origem, Complemento, Cartao, Dia,
Mes, Ano, Hora, Minuto, Segundo) = 0){
//Runs necessary tasks, such as saving to database,
sending a beep, etc.
//Sets current Inner to the next status
VetorInners[InnerAtual] = 4;
}
OutroPasso:
//Insert other steps here, as many as you find necessary
}

//Skips to the next Inner


InnerAtual = InnerAtual + 1;
If(InnerAtual > InnersCadastrados){
InnerAtual = 1;
}
}
//Closes software, closes communication port
FecharPortaComunicacao();
}

"#$ %%&'

Description of Functions:

Detecting if the connection with Inner was lost


While polling, in case inner does not have data or if there is a failure when returning funtion
Recebe_Dados, the software is to send a command 10 (ping) to test the connection with Inner. Such
command is to be sent every 3 seconds.
You may try to send command 10 more than once before assuming inner has lost its connection.
In case command 10 returns a value other than 31, that is because the connection is lost. Thus, the
software must run the following steps:
- Try to connect to Inner using command 10 until you receive return 31.
- You should start the process of registers collection that may have been stored while
inner was in offline mode.
- After collecting all registers, command 26 must be sent in order to set Inner to online
mode once again.
Below, you can see a flowchart to detect a connection interruption.

"#$ %%&'

Declarations
Description in
of Visual
Functions:
Basic

Description of the DLLs functions

Functions in Visual Basic:


Public Declare Function DefinirTipoConexao Lib "EasyInner.dll" (ByVal Tipo As Byte) As Byte
Public Declare Function AbrirPortaComunicacao Lib "EasyInner.dll" (ByVal Porta As Long) As Byte
Public Declare Sub FecharPortaComunicacao Lib "EasyInner.dll" ()
Public Declare Function DefinirPadraoCartao Lib "EasyInner.dll" (ByVal Padrao As Byte) As Byte
Public Declare Function AcionarRele1 Lib "EasyInner.dll" (ByVal Inner As Long) As Byte
Public Declare Function AcionarRele2 Lib "EasyInner.dll" (ByVal Inner As Long) As Byte
Public Declare Function EnviarComandoAcessoNegado Lib "EasyInner.dll" (ByVal Inner As Long) As
Byte
Public Declare Function ManterRele1Acionado Lib "EasyInner.dll" (ByVal Inner As Long) As Byte
Public Declare Function ManterRele2Acionado Lib "EasyInner.dll" (ByVal Inner As Long) As Byte
Public Declare Function DesabilitarRele1 Lib "EasyInner.dll" (ByVal Inner As Long) As Byte
Public Declare Function DesabilitarRele2 Lib "EasyInner.dll" (ByVal Inner As Long) As Byte
Public Declare Function AcionarBipCurto Lib "EasyInner.dll" (ByVal Inner As Long) As Byte
Public Declare Function AcionarBipLongo Lib "EasyInner.dll" (ByVal Inner As Long) As Byte
Public Declare Function Ping Lib "EasyInner.dll" (ByVal Inner As Long) As Byte
Public Declare Function ResetarModoOnLine Lib "EasyInner.dll" (ByVal Inner As Long) As Byte
Public Declare Function LigarBackLite Lib "EasyInner.dll" (ByVal Inner As Long) As Byte
Public Declare Function DesligarBackLite Lib "EasyInner.dll" (ByVal Inner As Long) As Byte
Public Declare Function LigarBipIntermitente Lib "EasyInner.dll" (ByVal Inner As Long) As Byte
Public Declare Function DesligarBipIntermitente Lib "EasyInner.dll" (ByVal Inner As Long) As Byte
Public Declare Function LiberarCatracaEntrada Lib "EasyInner.dll" (ByVal Inner As Long) As Byte
Public Declare Function LiberarCatracaSaida Lib "EasyInner.dll" (ByVal Inner As Long) As Byte
Public Declare Function LiberarCatracaEntradaInvertida Lib "EasyInner.dll" (ByVal Inner As Long) As
Byte
Public Declare Function LiberarCatracaSaidaInvertida Lib "EasyInner.dll" (ByVal Inner As Long) As Byte
Public Declare Function LiberarCatracaDoisSentidos Lib "EasyInner.dll" (ByVal Inner As Long) As Byte
Public Declare Function DevolverCartao Lib "EasyInner.dll" (ByVal Inner As Long) As Byte
Public Declare Function EngolirCartao Lib "EasyInner.dll" (ByVal Inner As Long) As Byte
Public Declare Function LevantarParaOnLine Lib "EasyInner.dll" (ByVal Inner As Long) As Byte

Public Declare Function ConfigurarLeitorProximidadeHIDAbaTrack2 Lib "EasyInner.dll" () As Byte


Public Declare Function ConfigurarLeitorProximidadeMotorolaAbaTrack2 Lib "EasyInner.dll" () As Byte
Public Declare Function ConfigurarLeitorProximidadeWiegand Lib "EasyInner.dll" () As Byte
Public Declare Function ConfigurarLeitorProximidadeSmartCard Lib "EasyInner.dll" () As Byte
Public Declare Function ConfigurarLeitorProximidadeAcura Lib "EasyInner.dll" () As Byte
Public Declare Function ConfigurarLeitorProximidadeWiegandFacilityCode Lib "EasyInner.dll" () As Byte
Public Declare Function ConfigurarLeitorProximidadeSmartCardAcura Lib "EasyInner.dll" () As Byte
Public Declare Function ConfigurarInnerOffLine Lib "EasyInner.dll" () As Byte
Public Declare Function ConfigurarInnerOnLine Lib "EasyInner.dll" () As Byte

"#$ %%&'

Declarations
Basic
Description in
of Visual
Functions:

Public Declare Function HabilitarTeclado Lib "EasyInner.dll" (ByVal Habilita As Byte, ByVal Ecoar As
Byte) As Byte
Public Declare Function ConfigurarAcionamento1 Lib "EasyInner.dll" (ByVal Funcao As Byte, ByVal
Tempo As Byte) As Byte
Public Declare Function ConfigurarAcionamento2 Lib "EasyInner.dll" (ByVal Funcao As Byte, ByVal
Tempo As Byte) As Byte
Public Declare Function ConfigurarTipoLeitor Lib "EasyInner.dll" (ByVal Tipo As Byte) As Byte
Public Declare Function ConfigurarLeitor1 Lib "EasyInner.dll" (ByVal Operacao As Byte) As Byte
Public Declare Function ConfigurarLeitor2 Lib "EasyInner.dll" (ByVal Operacao As Byte) As Byte
Public Declare Function DefinirCodigoEmpresa Lib "EasyInner.dll" (ByVal Codigo As Long) As Byte
Public Declare Function DefinirNivelAcesso Lib "EasyInner.dll" (ByVal Nivel As Byte) As Byte
Public Declare Function UtilizarSenhaAcesso Lib "EasyInner.dll" (ByVal Utiliza As Byte) As Byte
Public Declare Function DefinirTipoListaAcesso Lib "EasyInner.dll" (ByVal Tipo As Byte) As Byte
Public Declare Function DefinirQuantidadeDigitosCartao Lib "EasyInner.dll" (ByVal Quantidade As Byte)
As Byte
Public Declare Function AvisarQuandoMemoriaCheia Lib "EasyInner.dll" (ByVal Avisa As Byte) As Byte
Public Declare Function DefinirPorcentagemRevista Lib "EasyInner.dll" (ByVal Porcentagem As Byte) As
Byte
Public Declare Function RegistrarAcessoNegado Lib "EasyInner.dll" (ByVal TipoRegistro As Byte) As
Byte
Public Declare Function CartaoMasterLiberaAcesso Lib "EasyInner.dll" (ByVal Libera As Byte) As Byte
Public Declare Function DefinirLogicaRele Lib "EasyInner.dll" (ByVal Logica As Byte) As Byte
Public Declare Function DesabilitarBloqueioCatracaMicroSwitch Lib "EasyInner.dll" (ByVal Desabilita As
Byte) As Byte
Public Declare Function DefinirFuncaoDefaultLeitoresProximidade Lib "EasyInner.dll" (ByVal Funcao As
Byte) As Byte
Public Declare Function DefinirNumeroCartaoMaster Lib "EasyInner.dll" (ByVal Master As String) As Byte
Public Declare Function DefinirFormasPictogramasMillenium Lib "EasyInner.dll" (ByVal Forma As Byte)
As Byte
Public Declare Function DesabilitarBipCatraca Lib "EasyInner.dll" (ByVal Desabilita As Byte) As Byte
Public Declare Function DefinirEventoSensor Lib "EasyInner.dll" (ByVal Sensor As Byte, ByVal Evento
As Byte, ByVal Tempo As Byte) As Byte
Public Declare Function PermitirCadastroInnerBioVerid Lib "EasyInner.dll" (ByVal Permite As Byte) As
Byte
Public Declare Function ReceberDataHoraDadosOnLine Lib "EasyInner.dll" (ByVal Recebe As Byte) As
Byte
Public Declare Function InserirQuantidadeDigitoVariavel Lib "EasyInner.dll" (ByVal Digito As Byte) As
Byte
Public Declare Function ConfigurarWiegandDoisLeitores Lib "EasyInner.dll" (ByVal Habilita As Byte,
ByVal ExibirMensagem As Byte) As Byte
Public Declare Function DefinirFuncaoDefaultSensorBiometria Lib "EasyInner.dll" (ByVal Funcao As
Byte) As Byte
Public Declare Function EnviarConfiguracoes Lib "EasyInner.dll" (ByVal Inner As Long) As Byte

Public Declare Function EnviarRelogio Lib "EasyInner.dll" (ByVal Inner As Long, _


ByVal Dia As Byte, ByVal Mes As Byte, ByVal Ano As Byte, _
ByVal Hora As Byte, ByVal Minuto As Byte, ByVal Segundo As Byte) As Byte
Public Declare Function EnviarHorarioVerao Lib "EasyInner.dll" (ByVal Inner As Long, _

"#$ %%&'

) !)

Declaraes
Visual Basic
Descriptionem
of Functions:

ByVal DiaInicio As Byte, ByVal MesInicio As Byte, ByVal AnoInicio As Byte, _


ByVal HoraInicio As Byte, ByVal MinutoInicio As Byte, _
ByVal DiaFim As Byte, ByVal MesFim As Byte, ByVal AnoFim As Byte, _
ByVal HoraFim As Byte, ByVal MinutoFim As Byte) As Byte

Public Declare Function ApagarHorariosAcesso Lib "EasyInner.dll" (ByVal Inner As Long) As Byte
Public Declare Function InserirHorarioAcesso Lib "EasyInner.dll" (ByVal Horario As Byte, ByVal
DiaSemana As Byte, ByVal FaixaDia As Byte, ByVal Hora As Byte, ByVal Minuto As Byte) As Byte
Public Declare Function EnviarHorariosAcesso Lib "EasyInner.dll" (ByVal Inner As Long) As Byte

Public Declare Function ApagarListaAcesso Lib "EasyInner.dll" (ByVal Inner As Long) As Byte
Public Declare Function InserirUsuarioListaAcesso Lib "EasyInner.dll" (ByVal Cartao As String, ByVal
Horario As Byte) As Byte
Public Declare Function EnviarListaAcesso Lib "EasyInner.dll" (ByVal Inner As Long) As Byte

Public Declare Function EnviarMensagemPadraoOnLine Lib "EasyInner.dll" (ByVal Inner As Long, ByVal
ExibirData As Byte, ByVal Mensagem As String) As Byte
Public Declare Function EnviarMensagemTemporariaOnLine Lib "EasyInner.dll" (ByVal Inner As Long,
ByVal ExibirData As Byte, ByVal Mensagem As String, ByVal Tempo As Byte) As Byte
Public Declare Function DefinirMensagemEntradaOffLine Lib "EasyInner.dll" (ByVal ExibirData As Byte,
ByVal Mensagem As String) As Byte
Public Declare Function DefinirMensagemSaidaOffLine Lib "EasyInner.dll" (ByVal ExibirData As Byte,
ByVal Mensagem As String) As Byte
Public Declare Function DefinirMensagemPadraoOffLine Lib "EasyInner.dll" (ByVal ExibirData As Byte,
ByVal Mensagem As String) As Byte
Public Declare Function DefinirMensagemFuncaoOffLine Lib "EasyInner.dll" (ByVal Mensagem As String,
ByVal Funcao As Byte, ByVal Habilitada As Byte) As Byte
Public Declare Function EnviarMensagensOffLine Lib "EasyInner.dll" (ByVal Inner As Long) As Byte
Public Declare Function ApagarMensagensOffLine Lib "EasyInner.dll" (ByVal Inner As Long) As Byte

Public Declare Function ApagarHorariosSirene Lib "EasyInner.dll" (ByVal Inner As Long) As Byte
Public Declare Function InserirHorarioSirene Lib "EasyInner.dll" (ByVal Hora As Byte, ByVal Minuto As
Byte, _
ByVal Segunda As Byte, ByVal Terca As Byte, ByVal Quarta As Byte, ByVal Quinta As Byte, _
ByVal Sexta As Byte, ByVal Sabado As Byte, ByVal DomingoFeriado As Byte) As Byte
Public Declare Function EnviarHorariosSirene Lib "EasyInner.dll" (ByVal Inner As Long) As Byte

Public Declare Function ColetarBilhete Lib "EasyInner.dll" (ByVal Inner As Long, ByRef Tipo As Byte,
ByRef Dia As Byte, ByRef Mes As Byte, ByRef Ano As Byte, ByRef Hora As Byte, ByRef Minuto As Byte,
ByVal Cartao As String) As Byte

"#$ %%&'

Declarations
Basic
Description in
of Visual
Functions:

Public Declare Function EnviarFormasEntradasOnLine Lib "EasyInner.dll" (ByVal Inner As Long, ByVal
QtdeDigitosTeclado As Byte, ByVal EcoTeclado As Byte, ByVal FormaEntrada As Byte, ByVal
TempoTeclado As Byte, ByVal PosicaoCursorTeclado As Byte) As Byte
Public Declare Function ReceberDadosOnLine Lib "EasyInner.dll" (ByVal Inner As Long, ByRef Origem
As Byte, ByRef Complemento As Byte, ByVal Cartao As String, ByRef Dia As Byte, ByRef Mes As Byte,
ByRef Ano As Byte, ByRef Hora As Byte, ByRef Minuto As Byte, ByRef Segundo As Byte) As Byte

Public Declare Function LerSensoresInner Lib "EasyInner.dll" (ByVal Inner As Long, ByRef
StatusSensor1 As Byte, ByRef StatusSensor2 As Byte, ByRef StatusSensor3 As Byte) As Byte

Public Declare Function EnviarMensagemImpressora00 Lib "EasyInner.dll" (ByVal Inner As Long, ByVal
Mensagem As String) As Byte
Public Declare Function EnviarMensagemImpressoraFF Lib "EasyInner.dll" (ByVal Inner As Long, ByVal
Mensagem As String) As Byte

Public Declare Function HabilitarMudancaOnLineOffLine Lib "EasyInner.dll" (ByVal Habilita As Byte,


ByVal Tempo As Byte) As Byte
Public Declare Function DefinirEntradasMudancaOffLine Lib "EasyInner.dll" (ByVal Teclado As Byte,
ByVal Leitor1 As Byte, ByVal Leitor2 As Byte, ByVal Catraca As Byte) As Byte
Public Declare Function DefinirMensagemPadraoMudancaOffLine Lib "EasyInner.dll" (ByVal ExibirData
As Byte, ByVal Mensagem As String) As Byte
Public Declare Function DefinirMensagemPadraoMudancaOnLine Lib "EasyInner.dll" (ByVal ExibirData
As Byte, ByVal Mensagem As String) As Byte
Public Declare Function DefinirEntradasMudancaOnLine Lib "EasyInner.dll" (ByVal Entrada As Byte) As
Byte
Public Declare Function DefinirConfiguracaoTecladoOnLine Lib "EasyInner.dll" (ByVal Digitos As Byte,
ByVal EcoDisplay As Byte, ByVal Tempo As Byte, ByVal PosicaoCursor As Byte) As Byte
Public Declare Function EnviarConfiguracoesMudancaAutomaticaOnLineOffLine Lib "EasyInner.dll"
(ByVal Inner As Long) As Byte

Public Declare Function DefinirConfiguracoesFuncoes Lib "EasyInner.dll" (ByVal Funcao As Byte, ByVal
Catraca As Byte, ByVal Rele1 As Byte, ByVal Rele2 As Byte, ByVal Lista As Byte, ByVal Biometria As
Byte) As Byte
Public Declare Function EnviarConfiguracoesFuncoes Lib "EasyInner.dll" (ByVal Inner As Long) As Byte

Public Declare Function SolicitarModeloBio Lib "EasyInner.dll" (ByVal Inner As Long) As Byte
Public Declare Function ReceberModeloBio Lib "EasyInner.dll" (ByVal Inner As Long, ByVal OnLine As
Byte, ByRef Modelo As Long) As Byte
Public Declare Function SolicitarVersaoBio Lib "EasyInner.dll" (ByVal Inner As Long) As Byte

"#$ %%&'

Declarations
Basic
Description ofVisual
Functions:

Public Declare Function ReceberVersaoBio Lib "EasyInner.dll" (ByVal Inner As Long, ByVal OnLine As
Byte, ByRef VersaoAlta As Long, ByRef VersaoBaixa As Long) As Byte
Public Declare Function SolicitarQuantidadeUsuariosBio Lib "EasyInner.dll" (ByVal Inner As Long) As
Byte
Public Declare Function ReceberQuantidadeUsuariosBio Lib "EasyInner.dll" (ByVal Inner As Long, ByVal
OnLine As Byte, ByRef Quantidade As Long) As Byte
Public Declare Sub InicializarColetaListaUsuariosBio Lib "EasyInner.dll" ()
Public Declare Function SolicitarListaUsuariosBio Lib "EasyInner.dll" (ByVal Inner As Long) As Byte
Public Declare Function ReceberPacoteListaUsuariosBio Lib "EasyInner.dll" (ByVal Inner As Long) As
Byte
Public Declare Function ReceberUsuarioLista Lib "EasyInner.dll" (ByVal Inner As Long, ByVal Usuario As
String) As Byte
Public Declare Function TemProximoUsuario Lib "EasyInner.dll" () As Long
Public Declare Function TemProximoPacote Lib "EasyInner.dll" () As Long
Public Declare Sub SetarBioLight Lib "EasyInner.dll" (ByVal Light As Long)
Public Declare Function SolicitarUsuarioCadastradoBio Lib "EasyInner.dll" (ByVal Inner As Long, ByVal
Usuario As String) As Byte
Public Declare Function ReceberUsuarioCadastradoBio Lib "EasyInner.dll" (ByVal Inner As Long, ByVal
OnLine As Byte, ByVal Template As String) As Byte
Public Declare Function SolicitarExclusaoUsuario Lib "EasyInner.dll" (ByVal Inner As Long, ByVal
Usuario As String) As Byte
Public Declare Function UsuarioFoiExcluido Lib "EasyInner.dll" (ByVal Inner As Long, ByVal OnLine As
Byte) As Byte
Public Declare Function InserirUsuarioLeitorBio Lib "EasyInner.dll" (ByVal Inner As Long, ByVal Tipo As
Byte, ByVal Usuario As String) As Byte
Public Declare Function ResultadoInsercaoUsuarioLeitorBio Lib "EasyInner.dll" (ByVal Inner As Long,
ByVal OnLine As Byte) As Byte
Public Declare Function FazerVerificacaoBiometricaBio Lib "EasyInner.dll" (ByVal Inner As Long, ByVal
Usuario As String) As Byte
Public Declare Function ResultadoVerificacaoBiometrica Lib "EasyInner.dll" (ByVal Inner As Long, ByVal
OnLine As Byte) As Byte
Public Declare Function FazerIdentificacaoBiometricaBio Lib "EasyInner.dll" (ByVal Inner As Long) As
Byte
Public Declare Function ResultadoIdentificacaoBiometrica Lib "EasyInner.dll" (ByVal Inner As Long,
ByVal OnLine As Byte, ByVal Usuario As String) As Byte
Public Declare Function SolicitarTemplateLeitor Lib "EasyInner.dll" (ByVal Inner As Long) As Byte
Public Declare Function ReceberTemplateLeitor Lib "EasyInner.dll" (ByVal Inner As Long, ByVal OnLine
As Byte, ByVal Template As String) As Byte
Public Declare Function ConfigurarBio Lib "EasyInner.dll" (ByVal Inner As Long, ByVal
HabilitaIdentificacao As Byte, ByVal HabilitaVerificacao As Byte) As Byte
Public Declare Function ResultadoConfiguracaoBio Lib "EasyInner.dll" (ByVal Inner As Long, ByVal
OnLine As Byte) As Byte
Public Declare Function EnviarUsuarioBio Lib "EasyInner.dll" (ByVal Inner As Long, ByVal Template As
String) As Byte
Public Declare Function UsuarioFoiEnviado Lib "EasyInner.dll" (ByVal Inner As Long, ByVal OnLine As
Byte) As Byte
Public Declare Function CompararDigitalLeitor Lib "EasyInner.dll" (ByVal Inner As Long, ByVal Template
As String) As Byte
Public Declare Function ResultadoComparacaoDigitalLeitor Lib "EasyInner.dll" (ByVal Inner As Long,
ByVal OnLine As Byte) As Byte
Public Declare Function IncluirUsuarioSemDigitalBio Lib "EasyInner.dll" (ByVal Cartao As String) As Byte
Public Declare Function EnviarListaUsuariosSemDigitalBio Lib "EasyInner.dll" (ByVal Inner As Long) As
Byte

"#$ %%&'

Description of Functions:

Public Declare Function EnviarStringInicializacaoModem Lib "EasyInner.dll" (ByVal Str As String) As


Long
Public Declare Function LerByteModem Lib "EasyInner.dll" () As Long
Public Declare Function ConectarModem Lib "EasyInner.dll" (ByVal Porta As Long, ByVal Str As String,
ByVal Tom As Long, ByVal Telefone As String, ByVal Inner As Long) As Long

"#$ %%&'

Description
Declarations
of Functions:
in Delphi

Declaration of Functions in Delphi:


Function DefinirTipoConexao(Tipo:Byte):Byte; stdcall; external '
EasyInner.dll'
;

Function AbrirPortaComunicacao(Porta:Integer):Byte; stdcall; external '


EasyInner.dll'
;
Procedure FecharPortaComunicacao(); stdcall; external '
EasyInner.dll'
;

Function DefinirPadraoCartao(Padrao:Byte):Byte; stdcall; external '


EasyInner.dll'
;

Function AcionarRele1( Inner:Integer):Byte; stdcall; external '


EasyInner.dll'
;
Function AcionarRele2( Inner:Integer):Byte; stdcall; external '
EasyInner.dll'
;
Function EnviarComandoAcessoNegado( Inner:Integer):Byte; stdcall; external '
EasyInner.dll'
;
Function ManterRele1Acionado( Inner:Integer):Byte; stdcall; external '
EasyInner.dll'
;
Function ManterRele2Acionado( Inner:Integer):Byte; stdcall; external '
EasyInner.dll'
;
Function DesabilitarRele1( Inner:Integer):Byte; stdcall; external '
EasyInner.dll'
;
Function DesabilitarRele2( Inner:Integer):Byte; stdcall; external '
EasyInner.dll'
;
Function AcionarBipCurto( Inner:Integer):Byte; stdcall; external '
EasyInner.dll'
;
Function AcionarBipIntegero( Inner:Integer):Byte; stdcall; external '
EasyInner.dll'
;
Function Ping( Inner:Integer):Byte; stdcall; external '
EasyInner.dll'
;
Function ResetarModoOnLine( Inner:Integer):Byte; stdcall; external '
EasyInner.dll'
;
Function LigarBackLite( Inner:Integer):Byte; stdcall; external '
EasyInner.dll'
;
Function DesligarBackLite( Inner:Integer):Byte; stdcall; external '
EasyInner.dll'
;
Function LigarBipIntermitente( Inner:Integer):Byte; stdcall; external '
EasyInner.dll'
;
Function DesligarBipIntermitente( Inner:Integer):Byte; stdcall; external '
EasyInner.dll'
;
Function LiberarCatracaEntrada( Inner:Integer):Byte; stdcall; external '
EasyInner.dll'
;
Function LiberarCatracaSaida( Inner:Integer):Byte; stdcall; external '
EasyInner.dll'
;
Function LiberarCatracaEntradaInvertida( Inner:Integer):Byte; stdcall; external '
EasyInner.dll'
;
Function LiberarCatracaSaidaInvertida( Inner:Integer):Byte; stdcall; external '
EasyInner.dll'
;
Function LiberarCatracaDoisSentidos( Inner:Integer):Byte; stdcall; external '
EasyInner.dll'
;
Function DevolverCartao( Inner:Integer):Byte; stdcall; external '
EasyInner.dll'
;
Function EngolirCartao( Inner:Integer):Byte; stdcall; external '
EasyInner.dll'
;
Function LevantarParaOnLine(Inner: Integer):Byte; stdcall; external '
EasyInner.dll'
;

Function ConfigurarLeitorProximidadeHIDAbaTrack2():Byte; stdcall; external '


EasyInner.dll'
;
Function ConfigurarLeitorProximidadeMotorolaAbaTrack2():Byte; stdcall; external '
EasyInner.dll'
;
Function ConfigurarLeitorProximidadeWiegand():Byte; stdcall; external '
EasyInner.dll'
;
Function ConfigurarLeitorProximidadeSmartCard():Byte; stdcall; external '
EasyInner.dll'
;
Function ConfigurarLeitorProximidadeAcura():Byte; stdcall; external '
EasyInner.dll'
;
Function ConfigurarLeitorProximidadeWiegandFacilityCode():Byte; stdcall; external '
EasyInner.dll'
;
Function ConfigurarLeitorProximidadeSmartCardAcura():Byte; stdcall; external '
EasyInner.dll'
;
Function ConfigurarInnerOffLine():Byte; stdcall; external '
EasyInner.dll'
;
Function ConfigurarInnerOnLine():Byte; stdcall; external '
EasyInner.dll'
;
Function HabilitarTeclado( Habilita, Ecoar:Byte):Byte; stdcall; external '
EasyInner.dll'
;
Function ConfigurarAcionamento1( Funcao,Tempo:Byte):Byte; stdcall; external '
EasyInner.dll'
;
Function ConfigurarAcionamento2( Funcao,Tempo:Byte):Byte; stdcall; external '
EasyInner.dll'
;

"#$ %%&'

Declarations
in Delphi
Description
of Functions:

Function ConfigurarTipoLeitor( Tipo:Byte):Byte; stdcall; external '


EasyInner.dll'
;
Function ConfigurarLeitor1( Operacao:Byte):Byte; stdcall; external '
EasyInner.dll'
;
Function ConfigurarLeitor2( Operacao:Byte):Byte; stdcall; external '
EasyInner.dll'
;
Function DefinirCodigoEmpresa( Codigo:Integer):Byte; stdcall; external '
EasyInner.dll'
;
Function DefinirNivelAcesso( Nivel:Byte):Byte; stdcall; external '
EasyInner.dll'
;
Function UtilizarSenhaAcesso( Utiliza:Byte):Byte; stdcall; external '
EasyInner.dll'
;
Function DefinirTipoListaAcesso( Tipo:Byte):Byte; stdcall; external '
EasyInner.dll'
;
Function DefinirQuantidadeDigitosCartao( Quantidade:Byte):Byte; stdcall; external '
EasyInner.dll'
;
Function AvisarQuandoMemoriaCheia( Avisa:Byte):Byte; stdcall; external '
EasyInner.dll'
;
Function DefinirPorcentagemRevista( Porcentagem:Byte):Byte; stdcall; external '
EasyInner.dll'
;
Function RegistrarAcessoNegado( TipoRegistro:Byte):Byte; stdcall; external '
EasyInner.dll'
;
Function CartaoMasterLiberaAcesso( Libera:Byte):Byte; stdcall; external '
EasyInner.dll'
;
Function DefinirLogicaRele( Logica:Byte):Byte; stdcall; external '
EasyInner.dll'
;
Function DesabilitarBloqueioCatracaMicroSwitch( Desabilita:Byte):Byte; stdcall; external '
EasyInner.dll'
;
Function DefinirFuncaoDefaultLeitoresProximidade( Funcao:Byte):Byte; stdcall; external '
EasyInner.dll'
;
Function DefinirNumeroCartaoMaster( Master:String):Byte; stdcall; external '
EasyInner.dll'
;
Function DefinirFormasPictogramasMillenium( Forma:Byte):Byte; stdcall; external '
EasyInner.dll'
;
Function DesabilitarBipCatraca( Desabilita:Byte):Byte; stdcall; external '
EasyInner.dll'
;
Function DefinirEventoSensor( Sensor,Evento,Tempo:Byte):Byte; stdcall; external '
EasyInner.dll'
;
Function PermitirCadastroInnerBioVerid( Permite:Byte):Byte; stdcall; external '
EasyInner.dll'
;
Function ReceberDataHoraDadosOnLine( Recebe:Byte):Byte; stdcall; external '
EasyInner.dll'
;
Function InserirQuantidadeDigitoVariavel( Digito:Byte):Byte; stdcall; external '
EasyInner.dll'
;
Function ConfigurarWiegandDoisLeitores( Habilita,ExibirMensagem:Byte):Byte; stdcall; external
'
EasyInner.dll'
;
Function DefinirFuncaoDefaultSensorBiometria( Funcao:Byte):Byte; stdcall; external '
EasyInner.dll'
;
Function EnviarConfiguracoes( Inner:Integer):Byte; stdcall; external '
EasyInner.dll'
;

Function EnviarRelogio( Inner:Integer;


Dia,Mes,Ano,
Hora,Minuto,Segundo:Byte):Byte; stdcall; external '
EasyInner.dll'
;
Function EnviarHorarioVerao( Inner:Integer;
DiaInicio, MesInicio, AnoInicio,
HoraInicio,MinutoInicio,
DiaFim, MesFim,AnoFim,
HoraFim,MinutoFim:Byte):Byte; stdcall; external '
EasyInner.dll'
;

Function ApagarHorariosAcesso( Inner:Integer):Byte; stdcall; external '


EasyInner.dll'
;
Function InserirHorarioAcesso( Horario,DiaSemana,FaixaDia,Hora,Minuto:Byte):Byte; stdcall; external
'
EasyInner.dll'
;
Function EnviarHorariosAcesso( Inner:Integer):Byte; stdcall; external '
EasyInner.dll'
;

Function ApagarListaAcesso( Inner:Integer):Byte; stdcall; external '


EasyInner.dll'
;
Function InserirUsuarioListaAcesso( Cartao:String; Horario:Byte):Byte; stdcall; external '
EasyInner.dll'
;
Function EnviarListaAcesso( Inner:Integer):Byte; stdcall; external '
EasyInner.dll'
;

"#$ %%&'

Declarations
in Delphi
Delphi
Description
Declaraes
ofem
Functions:

Function EnviarMensagemPadraoOnLine( Inner:Integer; ExibirData:Byte; Mensagem:String):Byte; stdcall;


external '
EasyInner.dll'
;
Function EnviarMensagemTemporariaOnLine( Inner:Integer; ExibirData:Byte; Mensagem:String;
Tempo:Byte):Byte; stdcall; external '
EasyInner.dll'
;
Function DefinirMensagemEntradaOffLine( ExibirData:Byte; Mensagem:String):Byte; stdcall; external
'
EasyInner.dll'
;
Function DefinirMensagemSaidaOffLine( ExibirData:Byte; Mensagem:String):Byte; stdcall; external
'
EasyInner.dll'
;
Function DefinirMensagemPadraoOffLine( ExibirData:Byte; Mensagem:String):Byte; stdcall; external
'
EasyInner.dll'
;
Function DefinirMensagemFuncaoOffLine( Mensagem:String; Funcao,Habilitada:Byte):Byte; stdcall;
external '
EasyInner.dll'
;
Function EnviarMensagensOffLine( Inner:Integer):Byte; stdcall; external '
EasyInner.dll'
;
Function ApagarMensagensOffLine( Inner:Integer):Byte; stdcall; external '
EasyInner.dll'
;

Function ApagarHorariosSirene( Inner:Integer):Byte; stdcall; external '


EasyInner.dll'
;
Function InserirHorarioSirene( Hora, Minuto,
Segunda, Terca, Quarta, Quinta,
Sexta, Sabado, DomingoFeriado:Byte):Byte; stdcall; external '
EasyInner.dll'
;
Function EnviarHorariosSirene( Inner:Integer):Byte; stdcall; external '
EasyInner.dll'
;

Function ColetarBilhete( Inner:Integer; Tipo, Dia, Mes, Ano, Hora, Minuto: Pointer; Cartao:PChar):Byte;
stdcall; external '
EasyInner.dll'
;

Function EnviarFormasEntradasOnLine(
Inner:Integer;QtdeDigitosTeclado,EcoTeclado,FormaEntrada,TempoTeclado,PosicaoCursorTeclado:Byte
):Byte; stdcall; external '
EasyInner.dll'
;
Function ReceberDadosOnLine( Inner:Integer; Origem, Complemento: Pointer; Cartao: PChar; Dia, Mes,
Ano, Hora, Minuto, Segundo:Pointer):Byte; stdcall; external '
EasyInner.dll'
;

Function LerSensoresInner( Inner:Integer; StatusSensor1, StatusSensor2, StatusSensor3:Pointer):Byte;


stdcall; external '
EasyInner.dll'
;

Function EnviarMensagemImpressora00( Inner:Integer; Mensagem:String):Byte; stdcall; external


'
EasyInner.dll'
;
Function EnviarMensagemImpressoraFF( Inner:Integer; Mensagem:String):Byte; stdcall; external
'
EasyInner.dll'
;
Declarations in Delphi

Function HabilitarMudancaOnLineOffLine( Habilita, Tempo:Byte):Byte; stdcall; external '


EasyInner.dll'
;
Function DefinirEntradasMudancaOffLine( Teclado, Leitor1, Leitor2, Catraca:Byte):Byte; stdcall; external
'
EasyInner.dll'
;

"#$ %%&'

Description of Functions:

Function DefinirMensagemPadraoMudancaOffLine( ExibirData:Byte; Mensagem:String):Byte; stdcall;


external '
EasyInner.dll'
;
Function DefinirMensagemPadraoMudancaOnLine( ExibirData:Byte; Mensagem:String):Byte; stdcall;
external '
EasyInner.dll'
;
Function DefinirEntradasMudancaOnLine( Entrada:Byte):Byte; stdcall; external '
EasyInner.dll'
;
Function DefinirConfiguracaoTecladoOnLine( Digitos, EcoDisplay, Tempo, PosicaoCursor:Byte):Byte;
stdcall; external '
EasyInner.dll'
;
Function EnviarConfiguracoesMudancaAutomaticaOnLineOffLine( Inner:Integer):Byte; stdcall; external
'
EasyInner.dll'
;

Function DefinirConfiguracoesFuncoes( Funcao, Catraca, Rele1, Rele2, Lista, Biometria:Byte):Byte;


stdcall; external '
EasyInner.dll'
;
Function EnviarConfiguracoesFuncoes( Inner:Integer):Byte; stdcall; external '
EasyInner.dll'
;

Function SolicitarModeloBio( Inner:Integer):Byte; stdcall; external '


EasyInner.dll'
;
Function ReceberModeloBio( Inner:Integer; OnLine:Byte; Modelo:Pointer):Byte; stdcall; external
'
EasyInner.dll'
;
Function SolicitarVersaoBio( Inner:Integer):Byte; stdcall; external '
EasyInner.dll'
;
Function ReceberVersaoBio( Inner:Integer; OnLine:Byte; VersaoAlta, VersaoBaixa:Pointer):Byte; stdcall;
external '
EasyInner.dll'
;
Function SolicitarQuantidadeUsuariosBio( Inner:Integer):Byte; stdcall; external '
EasyInner.dll'
;
Function ReceberQuantidadeUsuariosBio( Inner:Integer; OnLine:Byte; Quantidade:Pointer):Byte; stdcall;
external '
EasyInner.dll'
;
Procedure InicializarColetaListaUsuariosBio(); stdcall; external '
EasyInner.dll'
;
Function SolicitarListaUsuariosBio( Inner:Integer):Byte; stdcall; external '
EasyInner.dll'
;
Function ReceberPacoteListaUsuariosBio( Inner:Integer):Byte; stdcall; external '
EasyInner.dll'
;
Function ReceberUsuarioLista( Inner:Integer; Usuario:Pointer):Byte; stdcall; external '
EasyInner.dll'
;
Function TemProximoUsuario():Integer; stdcall; external '
EasyInner.dll'
;
Function TemProximoPacote():Integer; stdcall; external '
EasyInner.dll'
;
Procedure SetarBioLight(Light: Integer); stdcall; external '
EasyInner.dll'
;
Function SolicitarUsuarioCadastradoBio( Inner:Integer; Usuario:String):Byte; stdcall; external
'
EasyInner.dll'
;
Function ReceberUsuarioCadastradoBio( Inner:Integer; OnLine:Byte; Template:Pointer):Byte; stdcall;
external '
EasyInner.dll'
;
Function SolicitarExclusaoUsuario( Inner:Integer; Usuario:String):Byte; stdcall; external '
EasyInner.dll'
;
Function UsuarioFoiExcluido( Inner:Integer; OnLine:Byte):Byte; stdcall;
external '
EasyInner.dll'
;
Declarations in Delphi
Function InserirUsuarioLeitorBio( Inner:Integer; Tipo:Byte;
Usuario:String):Byte; stdcall; external '
EasyInner.dll'
;
Function ResultadoInsercaoUsuarioLeitorBio( Inner:Integer; OnLine:Byte):Byte; stdcall; external
'
EasyInner.dll'
;
Function FazerVerificacaoBiometricaBio( Inner:Integer; Usuario:String):Byte; stdcall; external
'
EasyInner.dll'
;

"#$ %%&'

Description of Functions:

Function ResultadoVerificacaoBiometrica( Inner:Integer; OnLine:Byte):Byte; stdcall; external


'
EasyInner.dll'
;
Function FazerIdentificacaoBiometricaBio( Inner:Integer):Byte; stdcall; external '
EasyInner.dll'
;
Function ResultadoIdentificacaoBiometrica( Inner:Integer; OnLine:Byte; Usuario:PChar):Byte; stdcall;
external '
EasyInner.dll'
;
Function SolicitarTemplateLeitor( Inner:Integer):Byte; stdcall; external '
EasyInner.dll'
;
Function ReceberTemplateLeitor( Inner:Integer; OnLine:Byte; Template:Pointer):Byte; stdcall; external
'
EasyInner.dll'
;
Function ConfigurarBio( Inner:Integer; HabilitaIdentificacao, HabilitaVerificacao:Byte):Byte; stdcall;
external '
EasyInner.dll'
;
Function ResultadoConfiguracaoBio( Inner:Integer; OnLine:Byte):Byte; stdcall; external '
EasyInner.dll'
;
Function EnviarUsuarioBio( Inner:Integer; Template:Pointer):Byte; stdcall; external '
EasyInner.dll'
;
Function UsuarioFoiEnviado( Inner:Integer; OnLine:Byte):Byte; stdcall; external '
EasyInner.dll'
;
Function CompararDigitalLeitor( Inner:Integer; Template:Pointer):Byte; stdcall; external '
EasyInner.dll'
;
Function ResultadoComparacaoDigitalLeitor( Inner:Integer; OnLine:Byte):Byte; stdcall; external
'
EasyInner.dll'
;
Function IncluirUsuarioSemDigitalBio( Cartao:String):Byte; stdcall; external '
EasyInner.dll'
;
Function EnviarListaUsuariosSemDigitalBio( Inner:Integer):Byte; stdcall; external '
EasyInner.dll'
;
Function EnviarStringInicializacaoModem(Str:String): Integer; stdcall; external '
EasyInner.dll'
;
Function LerByteModem(): Integer; stdcall; external '
EasyInner.dll'
;
Function ConectarModem(Porta: Integer; Str:String; Tom: Integer; Telefone:String; Inner: Integer):
Integer; stdcall; external '
EasyInner.dll'
;

"#$ %%&'

Description of Functions:

Description of functions included in the dll


Notes:
All data sending and receiving functions are sent more than once by the dll, preventing the
communication from being harmed by any failure.
Another important detail is that the dll is in charge of performing necessary pauses between the
function calls in order to avoid communication failures; this is why it is not necessary to do so in your
application by inserting Windows API function calls such as Sleep.
The dll also processes windows messages automatically at each call, thus avoiding the need to use
functions such as DoEvents, on VB, or API ProcessMessages.
The dll is not thread-safe or multi-thread, that way, only one thread should access the dlls functions.
The dll should not be called from inside a timer, because depending on the programming language
used, the event triggered by the timers may be damaged due to the processing of windows messages,
which is necessary due to the TCP/IP communication.

Types of function responses:


Before we start the description of each function of the dll, we will analyze the types of values the function
may return:
General responses
Values which can be returned by all functions, they are common to all of the dlls functions.
The values and their meanings are described below:
0
0
0
1
1
1
2
3
4
5
6
8
9

Data sent successfully.


Data received successfully.
The communication port was opened.
Type of connection successfully set.
Error when sending data.
Error when receiving data.
Error when opening the communication port.
The communication port was not opened.
The communication port is already open.
The dll Inner2K.dll was not found.
The dll InnerTCP.dll was not found.
The dll InnerTCP2.dll was not found.
GPF error in the dll, there was an exception in the dll.
Invalid type of connection.

Specific responses for each function

"#$ %%&'

) !)

Description of Functions:

These values are exclusive to each function; their meaning is specific to each function. These values are
explained in the descriptions for each function of the dll, under the item Specific responses.

Direct commands
DefineConnectionType (Type)
Description: Defines which type of connection (comm type) will be used by the dll, if it will be serial or
TCP/IP.
Parameters:

Type:

0 Serial communication.
1 TCP/IP communication using variable port.
2 TCP/IP communication using fixed port.
3 Communication using modem.

- For TCP/IP communication with variable port, the inners will connect to the following
ports:
Inner 01 Connects to port 3570.
Inner 01 Connects to port 3571.
Inner 03 Connects to port 3572.
Inner 04 Connects to port 3573.
And so on. This process will be visible to the application.
The port number sent by the OpenCommPort function will be ignored
by the dll.
- For the TCP/IP communication using a fixed port, all the inners will connect to a single
port, whose number is specified using function OpenCommPort.
General responses: Yes.
Specific responses: None.
OpenCommPort (Port)
Description: Opens the desired communication port. This function must be called before initiating any
data transmission or receiving process with the Inner.
Parameters: Port number of serial or TCP/IP port.
General responses: Yes.
Specific responses: None.

"#$ %%&'

Description of Functions:

CloseCommPort ()
Description: Closes the previously opened communication port, whether it is serial or TCP/IP.
Parameters: None.
General responses: None.
Specific responses: None.
DefineCardStandard (Standard);
Description: Defines which card standard is to be used by the inners, topdata or free standard. The
topdata standard is described in the manual for the equipment and is used only with the inners in Offline
mode. In free standard all card digits are considered as registration ones. It can be used in Online or
Offline mode.
Parameters:

Standard:

0 Topdata standard.
1 Free standard.

General responses: Yes.


Specific responses: 128 Invalid card standard.
ActivateRelay1 (Inner)
Description: Activates (grips) inners relay 1.
Parameters: Inner Number of the desired inner.
General responses: Yes.
Specific responses: None.
ActivateRelay2 (Inner)
Description: Activates (grips) inners relay 2.
Parameters: Inner Number of the desired inner.
General responses: Yes.
Specific responses: None.
SendCommandAccessDenied (Inner)
Description: Makes inner show Access denied on the display. This is an obsolete function and we do not
recommend using it.
Parameters: Inner Number of the desired inner.

"#$ %%&'

Description of Functions:

General responses: Yes.


Specific responses: None.
KeepRelay1Activated (Inner)
Description: Keeps inners relay 1 activated (gripped) until DeactivateRelay1 command is sent.
Parameters: Inner Number of the desired inner.
General responses: Yes.
Specific responses: None.
KeepRelay2Activated (Inner)
Description: Keeps inners relay 2 activated (gripped) until DeactivateRelay2 command is sent.
Parameters: Inner Number of the desired inner.
General responses: Yes.
Specific responses: None.
DeactivateRelay1 (Inner)
Description: Deactivates relay1, which was previously activated with KeepRelay1Activated command.
Parameters: Inner Number of the desired inner.
General responses: Yes.
Specific responses: None.
DeactivateRelay2 (Inner)
Description: Deactivates relay2, which was previously activated with KeepRelay2Activated command.
Parameters: Inner Number of the desired inner.
General responses: Yes.
Specific responses: None.

ActivateShortBeep (Inner)
Description: Makes inner sound a short beep (sound alarm).

"#$ %%&'

Description of Functions:

Parameters: Inner Number of the desired inner.


General responses: Yes.
Specific responses: None.
ActivateLongBeep (Inner)
Description: Makes inner sound a long beep (sound alarm).
Parameters: Inner Number of the desired inner.
General responses: Yes.
Specific responses: None.
Ping (Inner)
Description: Tests communication with inner, also used to start the connection to the inner.
Parameters: Inner Number of the desired inner.
General responses: Yes.
Specific responses: None.
ResetModeOnLine (Inner)
Description: Cleans inners memory used in the online process. This is an obsolete function and we do
not recommend using it.
Parameters: Inner Number of the desired inner.
General responses: Yes.
Specific responses: None.
SwitchBackLiteOff (Inner)
Description: Switches the light emitted by inners display off.
Parameters: Inner Number of the desired inner.
General responses: Yes.
Specific responses: None.
SwitchBackLiteOn (Inner)
Description: Switches the light emitted by inners display on.

"#$ %%&'

Description of Functions:

Parameters: Inner Number of the desired inner.


General responses: Yes.
Specific responses: None.
ActivateIntermittentBeep (Inner)
Description: Makes inner activate beep periodically, that is, inner will sound an alarm repeatedly.
Parameters: Inner Number of the desired inner.
General responses: Yes.
Specific responses: None.
DeactivateIntermittentBeep (Inner)
Description: Makes inner disable beep activated by ActivateIntermittentBeep command.
Parameters: Inner Number of the desired inner.
General responses: Yes.
Specific responses: None.
ReleaseTurnstileEntry (Inner)
Description: Releases turnstile movement toward inners standard entry direction so that the user may
turn it. For ReceiveDataOnLine function, the value for the Complement parameter will be an entry type.
Parameters: Inner Number of the desired inner.
General responses: Yes.
Specific responses: None.
ReleaseTurnstileExit (Inner)
Description: Releases turnstile movement toward inners standard exit direction so that the user may turn
it. For ReceiveDataOnLine function, the value for the Complement parameter will be an exit type.
Parameters: Inner Number of the desired inner.
General responses: Yes.
Specific responses: None.
ReleaseTurnstileEntryInverted (Inner)

"#$ %%&'

Description of Functions:

Description: Releases turnstile movement opposite to inners standard entry direction so that the user
may turn it. For ReceiveDataOnLine function, the value for the Complement parameter will be an exit
type.
Parameters: Inner Number of the desired inner.
General responses: Yes.
Specific responses: None.
ReleaseTurnstileExitInverted (Inner)
Description: Releases turnstile movement opposite to inners standard exit direction so that the user may
turn it. For ReceiveDataOnLine function, the value for the Complement parameter will be an entry type.
Parameters: Inner Number of the desired inner.
General responses: Yes.
Specific responses: None.
ReleaseTurnstileBothDirections (Inner)
Description: Releases turnstile movement so that user may turn it toward both directions.
Parameters: Inner Number of the desired inner.
General responses: Yes.
Specific responses: None.
GoBackOnLine (Inner)
Description: After inner goes offline and retrieves connection, this command initializes inner to online
mode without having to send the settings command again.
Parameters: Inner Number of the desired inner.
General responses: Yes.
Specific responses: None.

"#$ %%&'

Description of Functions:

General inner settings functions


The options set by the next functions are stored internally in the dll, inside a buffer, and such information
will only be sent to the inner after calling the SendSettings function.
SetupInnerOffLine ()
Description: Prepares inner to operate in offline mode. However, this command does not send such
information to the equipment.
Parameters: None.
General responses: Yes.
Specific responses: None.
SetupInnerOnLine ()
Description: Prepares inner to operate in online mode. However, this command does not send such
information to the equipment.
Parameters: None.
General responses: Yes.
Specific responses: None.
EnableKeyboard (Enable, Echo)
Description: Allows for the data to be inserted in the inner using the equipments keyboard. Once you
enable the echo parameter, the keyboard will echo asterisks in the inners display.
Parameters:

Enable: 1 Enables keyboard.


0 Disables keyboard.
Echo:

0 Echoes what is typed on the inners display.


1 Echoes asterisks on the inners display.

General responses: Yes.


Specific responses: None.

"#$ %%&'

Description of Functions:

SetActivation1 (Function, Time)


SetActivation2 (Function, Time)
Description: Sets the activation 1 (relay) of the inner, and for how long it will be activated.
Parameters:

Function:

0 Not used
1 Entrance and exit
2 Entrance
3 Exit
4 Buzzer
5 Search
6 Entry turnstile, with free exit
7 Exit turnstile, with free entry
8 Turnstile with free movement in both directions
9 Turnstile with free movement in both directions and record is
generated according to the direction.

Tempo:

0 to 50 seconds.

General responses: Yes.


Specific responses:

128 Invalid function.


129 Invalid activation time.

SetReaderType (Type)
Description: Sets the type of reader the inner is using, if it is a bar code, magnetic, or proximity reader.
Parameters:

Type:

0 Bar code reader.


1 Magnetic reader.
2 HID and Motorola Aba Track2 proximity reader.
3 Wiegand and Wiegand Facility Code proximity reader.
4 Smart Card proximity reader.

General responses: Yes.


Specific responses: 128 Invalid type of reader.
SetReader1 (Operation)
SetReader2 (Operation)
Description: Sets operations that are to be run by the reader, if it is to record data upon entry, exit, or both
directions.
Parameters:

Operation:

0 Deactivated reader.
1 Entrance only.
2 Exit only.
3 Entrance and exit.
4 Inverted entrance and exit.

General responses: Yes.

"#$ %%&'

Description of Functions:

Specific responses: 128 Invalid operation.


DefineCompanyCode (Code)
Description: Defines the company code used for the cards, valid only when you are using the Topdata
standard card.
Parameters:

Code: 0 to 999.

General responses: Yes.


Specific responses: 128 Invalid company code.
DefineAcessLevel (Level)
Description: Defines the level of access accepted by this inner. It should be used only in inners that are
set to use topdata standard cards.
Parameters:

Nvel: 0 to 9.

General responses: Yes.


Specific responses: 128 Invalid access level.
UseAcessPassword (Use)
Description: Sets inner to request the access password registered in the user card. This option is valid
only for inners that are set to use topdata standard cards.
Parameters:

Use:

0 Does not request access password.


1 Requests access password.

General responses: Yes.


Specific responses: None.
DefineAccessType (Type)
Description: Defines which type of access list (control) the inner is to use.
Parameters:

Type:

0 Do not use access list.


1 Use white list (cards not on the list are denied access).
2 Use black list (blocks only cards on the list).

General responses: Yes.


Specific responses: 128 Invalid list type.
DefineQuantityCardDigits (Quantity)
Description: Defines the amount of card digits that are to be read by the inner.

"#$ %%&'

Description of Functions:

Parameters:

Quantity: 4 to 16 digits.

General responses: Yes.


Specific responses: 128 - Invalid amount of digits.
WarnWhenMemoryFull (Warn)
Description: Sets inner to warn when offline registers storing memory is 50% full.
Parameters:

Warn: 0 Disables full memory warning.


1 Enables full memory warning.

General responses: Yes.


Specific responses: None.
DefinePercentageRevised (Percentage)
Description: Defines the percentage of cards that are to be selected for a search when exiting inner.
When a card is selected, the inner sounds a warning, shows a message on the display, and activates the
relay in case it is enabled.
Parameters:

Percentage:

0 to 100.

General responses: Yes.


Specific responses: 128 Invalid percentage.
RecordAccessDenied (RecordType)
Description: Sets inner to record attempts that had access denied. The inner will record only the denied
accesses in relation to the access list set.
Parameters:

RecordType:

0 Do not record denied access.


1 Only access denied.
2 Validating fingerprint failure.
3 Access denied and validating fingerprint failure.

General responses: Yes.


Specific responses: 128 Invalid record type.
MasterCardReleaseAccess (Release)
Description: Sets inner to allow for master card to release access to cards that are currently blocked by
the access list.
Parameters:

Release:

"#$ %%&'

0 Does not release access.


1 Releases access.

) !)

Description of Functions:

General responses: Yes.


Specific responses: None.
DefineRelayLogic (Logic)
Description: Defines the logic that is to be used by the inner in the relays (activations), if the relays are
normally open (NO), that is, the relays are deactivated, or if the relays are normally closed (NC), that is,
they are normally activated.
Parameters:

Logic: 0 Normally open


1 Normally closed.

General responses: Yes.


Specific responses: 128 Invalid relay logic.
DesableTurnstileBlockMicroSwitch (Disable)
Description: Obsolete function, no longer used. This function was used by very old turnstiles. It set the
turnstile not to automatically block the forceful turn of the equipment.
Parameters:

Disable:

0 Enables block.
1 Disables automatic block.

General responses: Yes.


Specific responses: None.
DefineDefaultFunctionProximityReaders (Function)
Description: Defines how the inner will record when a proximity card approaches the reader and the user
did not press the entry, exit, or function key.
Parameters:

Function:

0 Disabled.
1 to 9 Record as an inners keyboard function.
10 Always record as an entry.
11 Always record as an exit.
12 Releases turnstile movement in both directions and records
the register according to direction of movement.

General responses: Yes.


Specific responses: 128 Invalid function of reader.
DefineMasterCardNumber (Master)
Description: Sets what master card number the inner is to accept. Valid only for free standard cards.
Parameters:

Master:

"#$ %%&'

0 to 99999999999999 (Maximum of 14 digits)

Description of Functions:

General responses: Yes.


Specific responses: 128 Invalid master number.
DefinePictogramShapeMillenium (Shape)
Description: Obsolete function, no longer should it be used. This function sets the shape of the
pictograms for the old millenium turnstile.
Parameters:

Shape:

Value
0
1
2
3
4
5
6
7
8

Side 1
Arrow
Arrow
Denied
Denied
Arrow
Erased
Denied
Erased
Erased

Side 2
Arrow
Denied
Arrow
Denied
Erased
Arrow
Erased
Denied
Erased

General responses: Yes.


Specific responses: 128 Invalid pictogram shape.
DesableTurnstileBeep (Disable)
Description: Disables the ongoing beep used by the turnstile to warn that someone is forcing passage
through the equipment.
Parameters:

Disable:

1 Disables beep.
0 Does not disable beep.

General responses: Yes.


Specific responses: None.

"#$ %%&'

Description of Functions:

DefineSensorEvent (Sensor, Event, Time)


Description: Changes the way in which inners sensor events are triggered. We do not recommend
changing such values, unless it is extremely necessary.
Parameters:

Sensor:

1 to 3, number of the sensor to be set.

Event:

0 does not generate event.


1 generates ascending event (0->1).
2 generates descending event (1->0)
3 both.
4 ascends activating beep (see time in bytes below).
5 descends activating beep (see time in bytes below).

Time:

1 to 50, time to activate the beep after the event.

General responses: Yes.


Specific responses: 128 Invalid sensor.
129 Invalid event.
130 Invalid time.
AllowRegistrationInnerBioVerid (Allow)
Description: Allows for new user registrations to be made using the master card menu. For Bio series
inners only.
Parameters:

Allow: 0 Does not allow registration.


1 Allows registration.

General responses: Yes.


Specific responses: None.
ReceiveDateTimeDataOnLine (Receive)
Description: Sets inner to send date/time information with the online register, and such data will be
returned in the parameters of the ReceiveDataOnLine function.
Parameters:

Receive:

0 Do not receive registers date/time.


1 Receive registers date/time.

General responses: Yes.


Specific responses: None.

"#$ %%&'

Description of Functions:

SetWiegandTwoReaders (Enable, ShowMessage)


Description: Enables wiegand readers for the inner'
s first and second readers, and defines if the second
reader will show the messages set.
Parameters:

Enable: 0 Does not enable the second reader as wiegand.


1 Enables the second reader as wiegand.
ShowMessage: 0 Does not show message in second reader.
1 Shows message in second reader.

General responses: Yes.


Specific responses: None.
DefineDefaultFunctionBiometrySensor (Function)
Description: Sets the type of record that will be associated to a transaction when the finger is placed on
inner bio without the user having defined if it is an entry, exit, function, etc.
Parameters:

Function:

0 disabled.
1 to 9 functions from 1 to 9.
10 entrance.
11 exit.
12 releases turnstile for both directions and records register
according to the turn.

General responses: Yes.


Specific responses: 128 Invalid value for serial port.
SendSettings (Inner)
Description: Sends internal buffer of the dll that contains all settings for the inners previous functions.
After sending, such buffer is cleaned, being necessary to call functions above once more in order to reset
it.
Parameters:

Inner:

1 to 32 For serial communication.


1 to 99 For TCP/IP communication using variable port.
1 to ... For TCP/IP communication using fixed port.

General responses: Yes.


Specific responses: None.

"#$ %%&'

Description of Functions:

Functions to adjust inner date/time


SendClock (Inner, Day, Month, Year, Hour, Minute, Second)
Description: Sets inners current clock.
Parameters:

Inner:

1 to 32 For serial communication.


1 to 99 For TCP/IP communication using variable port.
1 to ... For TCP/IP communication using fixed port.

Day:
Month:
Year:
Hour:
Minute
Second:

1 to 31.
1 to 12.
0 to 99.
0 to 23.
0 to 59.
0 to 59.

General responses: Yes.


Specific responses: 128 Invalid day.
129 Invalid month.
130 Invalid hour.
131 Invalid minute.
132 Invalid second.
133 Invalid year.
SendDaylightSavingTime (Inner, SartDay, StartMonth, StartYear, StartHour, StartMinute,
EndDay, EndMonth, EndYear, EndHour, EndMinute)
Description: Sets start and end date/time for daylight saving time.
Parameters:

Inner:

1 to 32 For serial communication.


1 to 99 For TCP/IP communication using variable port.
1 to ... For TCP/IP communication using fixed port.

StartDay:
StartMonth:
StartYear:
StartHour:
StartMinute:

1 to 31.
1 to 12.
0 to 99.
0 to 23.
0 to 59.

EndDay:
EndMonth:
EndYear:
EndHour:
EndMinute:

1 to 31.
1 to 12.
0 to 99.
0 to 23.
0 to 59.

General responses: Yes.


Specific responses: 128 Invalid start day.
129 Invalid start month.
130 Invalid start hour.
131 Invalid start minute.

"#$ %%&'

Description of Functions:

132 Invalid end day.


133 Invalid end month.
134 Invalid end hour.
135 Invalid end minute.

"#$ %%&'

Description of Functions:

Functions to adjust access times


The access control times are internally stored in a buffer inside the dll. After sending the access times,
the buffer is automatically cleaned by the dll.
EraseAccessTimes (Inner)
Description: Erases buffer that contains the access times list and automatically sends it to the inner.
Parameters:

Inner:

1 to 32 For serial communication.


1 to 99 For TCP/IP communication using variable port.
1 to ... For TCP/IP communication using fixed port.

General responses: Yes.


Specific responses: None.
InsertAccessTime (Time, WeekDay, DayPart, Hour, Minute)
Description: Inserts an access time in the dlls buffer.
Parameters:

Time: 1 to 100 - Timetable number.


WeekDay:
1 to 7 Weekday to which the time range belongs.
DayPart:
1 to 4 For each weekday, there are 4 time
ranges.
Hour:
0 to 23.
Minute:
0 to 59.

General responses: Yes.


Specific responses: 128 Invalid time.
129 Invalid weekday.
130 Invalid part of the day.
131 Invalid hour.
132 Invalid minute.
SendAccessTimes (Inner)
Description: Sends the buffer containing the access times list to the inner. After running the command,
the buffer is automatically cleaned by the dll.
Parameters:

Inner:

1 to 32 For serial communication.


1 to 99 For TCP/IP communication using variable port.
1 to ... For TCP/IP communication using fixed port.

General responses: Yes.


Specific responses: None.

"#$ %%&'

Description of Functions:

Functions to adjust access list


The users in the access list are internally stored in a buffer inside the dll. After sending the access list,
using the SendAccessList function, the buffer is automatically cleaned by the dll.
Before starting to enter users and before sending the list, it is mandatory that you call the
DefinirCardStandard and DefineQuantityCardDigits functions, in this sequence.
EraseAccessList (Inner)
Description: Cleans buffer that contains the registered user list and automatically sends it to the inner.
Parameters:

Inner:

1 to 32 For serial communication.


1 to 99 For TCP/IP communication using variable port.
1 to ... For TCP/IP communication using fixed port.

General responses: Yes.


Specific responses: None.
InsertUserAccessList (Card, Time)
Description: Enter a user from the list in the dlls buffer, and to which access time he is associated. The
times will have to have already been registered using InsertAccessTime function and sent using
SendAccessTime function so that the list has the proper effect.
Parameters:

Card:

1 to ... - Depends on the previously defined card standard and on


the previously defined amount of digits.

Time:

1 to 100 - Number of the time already registered in the inner.


101 User always has free access.
102 User is always denied access.

General responses: Yes.


Specific responses: 128 Invalid card.
129 Amount of digits for invalid card.
130 Invalid time.
SendAccessTime (Inner)
Description: Sends buffer containing the users from the access list to the inner. After running the
command, the buffer is automatically cleaned by the dll.
Parameters:

Inner:

1 to 32 For serial communication.


1 to 99 For TCP/IP communication using variable port.
1 to ... For TCP/IP communication using fixed port.

General responses: Yes.


Specific responses: None.

"#$ %%&'

Description of Functions:

Functions to adjust inners OnLine messages


Functions below work only with the inner in online mode.
SendStandardMessageOnLine (Inner, ShowDate, Message)
Description: Sends the standard message that will always be shown by the inner.
Parameters:

Inner:

1 to 32 For serial communication.


1 to 99 For TCP/IP communication using variable port.
1 to ... For TCP/IP communication using fixed port.

ShowDate:

0 Does not show date/time on the top line of the display.


1 Shows date/time on the top line of the display.

Message:

String containing message that is to be shown. In case it is


showing date/time, the size of the message becomes
16, instead of 32. In case an empty string is passed, the
inner will not show the message on the display.

General responses: Yes.


Specific responses: None.
SendTemporaryMessageOnLine(Inner, ShowDate, Menssage, Time)
Description: Sends a temporary message to the inner.
Parameters:

Inner:

1 to 32 For serial communication.


1 to 99 For TCP/IP communication using variable port.
1 to ... For TCP/IP communication using fixed port.

ShowDate:

0 Does not show date/time on the top line of the display.


1 Shows date/time on the top line of the display.

Message:

String containing message that is to be shown. In case it is


showing date/time, the size of the message becomes
16, instead of 32. In case an empty string is passed, the
inner will not show the message on the display.

Time:

Time, in seconds, the message is to be on the display.


1 to 50.

General responses: Yes.


Specific responses: None.

"#$ %%&'

Description of Functions:

Functions to adjust inners OffLine messages


All offline messages set are to be stored in a buffer inside the dll and will be sent only after
SendMessagesOffLine function is called. Such functions work only with the inner in offline mode.
DefineEntryMessageOffLine (ShowDate, Message)
Description: Sets the message that is to be shown when the user passes the card in the inners entrance
direction.
Parameters:

ShowDate:

0 Does not show date/time on the top line of the display.


1 Shows date/time on the top line of the display.

Message:

String containing message that is to be shown. In case it is


showing date/time, the size of the message becomes
16, instead of 32. In case an empty string is passed, the
inner will not show the message on the display.

General responses: Yes.


Specific responses: None.
DefineExitMessageOffLine (ShowDate, Message)
Description: Sets the message that is to be shown when the user passes the card in the inners exit
direction.
Parameters:

ShowDate:

0 Does not show date/time on the top line of the display.


1 Shows date/time on the top line of the display.

Message:

String containing message that is to be shown. In case it is


showing date/time, the size of the message becomes
16, instead of 32. In case an empty string is passed, the
inner will not show the message on the display.

General responses: Yes.


Specific responses: None.
DefineStandardMessageOffLine (ShowDate, Message)
Description: Sets message that is to be shown by the inner when it is still.
Parameters:

"#$ %%&'

ShowDate:

0 Does not show date/time on the top line of the display.


1 Shows date/time on the top line of the display.

Message:

String containing message that is to be shown. In case it is


showing date/time, the size of the message becomes
16, instead of 32. In case an empty string is passed, the
inner will not show the message on the display.

) !)

Description of Functions:

General responses: Yes.


Specific responses: None.
DefineMessageFunctionOffLine (Message, Function, Enabled)
Description: Sets message that is to be shown when user passes the card using one of the inners
functions (From 0 to 9) and enables or disables such functions.
Parameters:

Menssage:

String containing message that is to be shown. In case it is


showing date/time, the size of the message becomes
16, instead of 32. In case an empty string is passed, the
inner will not show the message on the display.

Function:

0 to 9.

Enabled:

0 Disables inners function.


1 Enables inners function.

General responses: Yes.


Specific responses: 128 Invalid function.
SendMessagesOffLine (Inner)
Description: Sends buffer with all previously set offline messages to the inner. After running this function,
the buffer containing the messages is automatically cleaned by the dll.
Parameters:

Inner:

1 to 32 For serial communication.


1 to 99 For TCP/IP communication using variable port.
1 to ... For TCP/IP communication using fixed port.

General responses: Yes.


Specific responses: None.
CleanMessagesOffLine (Inner)
Description: Cleans buffer containing messages, setting it with the inners default messages, and
automatically sends the buffer to the inner.
Parameters:

Inner:

1 to 32 For serial communication.


1 to 99 For TCP/IP communication using variable port.
1 to ... For TCP/IP communication using fixed port.

General responses: Yes.


Specific responses: None.
DefineSettingsFunctions (Function, Turnstile, Relay1, Relay2, List, Biometry)

"#$ %%&'

Description of Functions:

Description: Individually sets the inners reaction to each function, that is, if the inner is to activate relay 1
and request biometry when using function 0, for example.
The settings will be stored in a buffer inside the dll and will be sent only after DefineSettingsFunctions
function is called.
Parameters:

Function:

0 to 9.

Turnstile:

0 Does not release turnstile movement.


1 Releases turnstile for entrance.
2 Releases turnstile for exit.
3 Turnstile with free movement in both directions

Relay1:

0 Does not activate relay 1.


1 Activates relay 1.

Relay2:

0 Does not activate relay 2.


1 Activates relay 2.

List:

0 Does not check list to record function


1 Check the list, if the card is allowed
access, records function.

Biometry:

0 Records function from the card or keyboard


reading. Does not perform biometric check/identification.
1 Performs biometric check or identification.

General responses: Yes.


Specific responses: 128 Invalid function.
129 Invalid turnstile setup.
DefineSettingsFunctions (Inner)
Description: Sends buffer containing settings for all functions to the inner. After running this function, the
buffer containing settings for the functions is automatically cleaned by the dll.
Parameters:

Inner:

1 to 32 For serial communication.


1 to 99 For TCP/IP communication using variable port.
1 to ... For TCP/IP communication using fixed port.

General responses: Yes.


Specific responses: None.

"#$ %%&'

Description of Functions:

Functions to adjust inner'


s buzzer sounding times
Functions below work only with the inner in offline mode. The registered buzzer times are stored in a
buffer inside the dll. They will be sent to the inner only after calling SendBuzzerTimes function.
In order to assure a proper operation at the times registered at least one inner activation should have
been set to work as a buzzer. This is performed using SetActivation1 or SetActivation2 functions. In
case both activations are set as buzzers, both will sound at the registered times.
CleanBuzzerTimes (Inner)
Description: Cleans the buffer that contains buzzer times and automatically sends it to the inner.
Parameters:

Inner:

1 to 32 For serial communication.


1 to 99 For TCP/IP communication using variable port.
1 to ... For TCP/IP communication using fixed port.

General responses: Yes.


Specific responses: None.
InsertBuzzerTime (Hour, Minute, Monday, Tuesday, Wednesday, Thursday, Friday, Saturday,
SundayHoliday)
Description: Inserts a buzzer time and sets the days of the week when this buzzer times are to operate.
Parameters:

Hour:

0 to 23.

Minute:

0 to 59.

Other parameters:

0 Disables the alarm on this day.


1 Enables the alarm on this day.

General responses: Yes.


Specific responses: 128 Invalid hour.
129 Invalid minute.
SendBuzzerTimes (Inner)
Description: Sends buffer containing the registered buzzer times to the inner. After running this function,
the buffer is automatically cleaned by the dll.
Parameters:

Inner:

1 to 32 For serial communication.


1 to 99 For TCP/IP communication using variable port.
1 to ... For TCP/IP communication using fixed port.

General responses: Yes.


Specific responses: None.

Function to receive the inners Offline registers

"#$ %%&'

Description of Functions:

This command operates only with the inner in OffLine mode.


CollectRegisters (Inner, Type, Day, Month, Year, Hour, Minute, Card)
Description: Collects an OffLine register stored in the inner'
s memory. The register'
s data will be returned
by reference in the function'
s parameters. Before calling this function for the first time, it is mandatory
that you call DefineCardStandard and DefineQuantityCardDigits functions, in this sequence, so that
the card number is calculated properly.
Parameters:

Inner:

1 to 32 For serial communication.


1 to 99 For TCP/IP communication using variable port.
1 to ... For TCP/IP communication using fixed port.

Type:

Type of transaction recorded.


0 to 9 Functions recorded by the card.
10 Entrance using card.
11 Exit using card.
12 Entrance attempt denied by card.
13 Exit attempt denied by card.
100 to 109 Functions recorded by the keyboard.
110 Entrance using keyboard.
111 Exit using keyboard.
112 Entrance attempt denied by keyboard.
113 Exit attempt denied by keyboard.

Day:

1 to 31.

Month:

1 to 12.

Year:

0 to 99.

Hour:

0 to 23.

Card:

User card number.

General responses: Yes.


Specific responses: 128 Repeated register received from inner.

"#$ %%&'

Description of Functions:

Functions to adjust inners OnLine data


The commands below work only with the Inner in OnLine mode.
SendInputMethodsOnLine (Inner, KeyboardDigitsQuantity, KeyboardEcho, InputMethod,
KeyboardTime, KeyboardCursorPosition)
Description: Sets the inners data input methods when in OnLine mode. Every time some information is
received in OnLine mode using the ReceiveDataOnLine function, the SendInputMethodsOnLine
function is to be called again so the inner can be reset.
Parameters:

Inner:

1 to 32 For serial communication.


1 to 99 For TCP/IP communication using variable port.
1 to ... For TCP/IP communication using fixed port.

KeyboardDigitsQuantity:

0 to 20 digits.

KeyboardEcho:

0 for no
1 for yes
2 echo *

InputMethod:

0 does not accept data entry


1 accepts keyboard
2 accepts reading in reader 1
3 accepts reading in reader 2
4 keyboard and reader 1
5 keyboard and reader 2
6 reader 1 and reader 2
7 keyboard, reader 1, and reader 2
10 keyboard + biometrical check
11 reader1 + biometrical check
12 keyboard + reader1 + biometrical check
13 reader1 with biometric check + reader2
without biometric check
14 reader1 with biometric check + reader2
without biometric check + keyboard without
biometric check

KeyboardTime:

1 to 50.

KeyboardCursorPosition:

1 to 32.

General responses: Yes.


Specific responses: 128 - Invalid amount of digits.
129 Invalid type of echo on the display.
130 Invalid method for data input.
131 Invalid input time using keyboard.
132 Invalid cursor position.

"#$ %%&'

)! )

Description of Functions:

ReceiveDataOnLine (Inner, Origin, Complement, Card, Day, Month, Year, Hour, Minute, Second)
Description: Collects an OnLine register in case the user has passed or typed some card into the Inner.
Returns the card information in the function'
s parameters. In order to return the OnLine register date/time,
the inner must have previously been set using ReceiveDateTimeDataOnLine function.
Parameters:

Inner:

1 to 32 For serial communication.


1 to 99 For TCP/IP communication using variable port.
1 to ... For TCP/IP communication using fixed port.

Origin: Origin of data received.


1 through keyboard
2 through reader 1
3 through reader 2
4 turnstile sensor (obsolete)
5 end of activation time
6 turn of Topdata turnstile (optical sensor)
7 Urn (Millenium turnstile)
8 Event in Sensor 1
9 Event in Sensor 2
10 Event in Sensor 3
Complement:

Additional information on the data received.


0 exit (with card)
1 entrance (with card)
35 - # through keyboard (1st key)
42 - * through keyboard (1st key)
65 through keyboard Function
66 through keyboard Entrance
67 through keyboard Exit
Sensor Event
0/1 Current level of sensor

Card:

Number of card received.

Day:

1 to 31.

Month:

1 to 12.

Year:

0 to 99.

Hour:

0 to 23.

Minute:

0 to 59.

Second:

0 to 59.

General responses: Yes.


Specific responses: 128 No data to be received.

"#$ %%&'

)! )

Description of Functions:

Function to read the status of Inners sensors


ReadSensorsInner(Inner, StatusSensor1, StatusSensor2, StatusSensor3)
Description: Receives the current status of inners sensors. This function is to be used only in very
specific cases.
Parameters:

Inner:

1 to 32 For serial communication.


1 to 99 For TCP/IP communication using variable port.
1 to ... For TCP/IP communication using fixed port.

Other parameters:

Returns the status of the respective sensor.


0 low level (closed)
1 high level (open)

General responses: Yes.


Specific responses: None.

"#$ %%&'

)! )

Description of Functions:

Functions to adjust inners printer messages


These functions must be used only by customers abroad and with the exclusive firmware version that
accepts these commands. These functions set the messages that are to be shown in microprinters
connected to the inner.
SendMessagePrinter00 (Inner, Message)
Description: Sends the message to printer ending in 0x00.
Parameters:

Inner:

1 to 32 For serial communication.


1 to 99 For TCP/IP communication using variable port.
1 to ... For TCP/IP communication using fixed port.

Message:

Characters/numbers that will be printed in the printer.


It is possible to use special characters (line advances,
etc.), it depends on the characterset supported by the printer
model used.
254 characters is the maximum size for a message.

General responses: Yes.


Specific responses: None.
SendMessagePrinterFF (Inner, Message)
Description: Sends the message to printer ending in 0xFF.
Parameters:

Inner:

1 to 32 For serial communication.


1 to 99 For TCP/IP communication using variable port.
1 to ... For TCP/IP communication using fixed port.

Message:

Characters/numbers that will be printed in the printer.


It is possible to use special characters (line advances,
etc.), it depends on the characterset supported by the printer
model used.
254 characters is the maximum size for a message.

General responses: Yes.


Specific responses: None.

"#$ %%&'

)! )

Description of Functions:

Functions to set inner'


s automatic OnLine OffLine switch
The settings of the functions below are stored in a dlls internal buffer and will be sent to the inner only
after EnviarConfiguracoesMudancaAutomaticaOnLineOffLine function is called.
EnableSwitchOnLineOffLine (Enable, Time)
Description: Enables/Disables the automatic switch from OffLine to OnLine mode, and vice-versa. Sets
the interrupted communications time after which such change should occur.
Parameters:

Enable:

0 - Disables the change.


1 - Enables the change.

Time:

Time, in seconds, for the change to occur.


1 to 50.

General responses: Yes.


Specific responses: 128 Invalid time.
DefineInputSwitchOffLine (Keyboard, Reader1, Reader2, Turnstile)
Description: Sends the message to printer ending in 0x00.
Parameters:

Keyboard:

0 Does not accept data input using keyboard.


1 Accepts data input using keyboard.

Reader1, Reader2:

Turnstile:

0 deactivated
1 entrance only
2 exit only
3 entrance and exit
4 exit and entrance

0 Enables the turnstile turn sensor.


1 Disables the turnstile turn sensor.

General responses: Yes.


Specific responses:

128 Invalid reader1 setting.


129 Invalid reader2 setting.

DefineStandardMessageSwitchOffLine (ShowDate, Message)


Description: Sets the standard message displayed by the inner when it goes to offline mode.
Parameters:

"#$ %%&'

ShowDate:

0 Does not show date/time on the top line of the display.


1 Shows date/time on the top line of the display.

Message:

String containing message that is to be shown. In case it is


showing date/time, the size of the message becomes

)! )

Description of Functions:

16, instead of 32. In case an empty string is passed, the


inner will not show the message on the display.
General responses: Yes.
Specific responses: None.
DefineStandardMessageSwitchOnLine (ShowDate, Message)
Description: Sets the standard message when the inner goes online after it was offline.
Parameters:

ShowDate:

0 Does not show date/time on the top line of display.


1 Shows date/time on the top line of display.

Message:

String containing message that is to be shown. In case it is


showing date/time, the size of the message becomes
16, instead of 32. In case an empty string is passed, the
inner will not show the message on the display.

General responses: Yes.


Specific responses: None.
DefineInputSwitchOnLine (Input)
Description: Sets the data input methods when the inner goes back to OnLine mode after it was OffLine.
Parameters:

Input:

0 Does not accept data input.


1 Accepts keyboard.
2 Accepts reader 1.
3 Accepts reader 2.
4 Keyboard and reader 1.
5 Keyboard and reader 2.
6 Reader 1 and reader 2.
7 Keyboard, reader 1, and reader 2.
8 Turnstiles sensor.

General responses: Yes.


Specific responses: 128 Invalid input method.
DefineKeyboardSettingOnLine(Digits, EchoDisplay, Time, CursorPosition)
Description: Sets keyboard for cases when inner goes back OnLine after being OffLine.
Parameters:

"#$ %%&'

Digits:

0 to 20 digits.

EchoDisplay:

0 no echo
1 for yes
2 echo *

) !!)

Description of Functions:

Time:

1 to 50.

CursorPosition:

1 to 32.

General responses: Yes.


Specific responses:

128 - Invalid amount of digits.


129 Invalid type of echo on the display.
130 Invalid time.
131 Invalid cursor position.

SendSettingsAutomaticSwitchOnLineOffLine (Inner)
Description: Sends buffer with settings of automatic change from OnLine to OffLine mode.
Parameters:

Inner:

1 to 32 For serial communication.


1 to 99 For TCP/IP communication using variable port.
1 to ... For TCP/IP communication using fixed port.

General responses: Yes.


Specific responses: None.

"#$ %%&'

)! )

Description of Functions:

Inner Bios specific functions


Besides the general responses for all dll functions, inner bio'
s specific functions may return the following
values:
General returns for inner bio:
128 Processing last command.
129 Communication failure with inners bio board.
130 Inner bio is not on master mode.
131 User is already registered in inner bios database.
132 User is not registered in inner bios database.
133 User database is full.
134 Error when reading users second finger.
135 Invalid request to inner bio.
Differences between Biometric check and Biometric identification.
Biometric check: The user should provide the card number associated to his fingerprint using the
card or keyboard. Inner bio will check the fingerprint database to confirm that the fingerprint associated to
the number given is the same as the fingerprint inserted in the biometric reader.
Such type of comparison is known as 1 to 1, and is the fastest type of comparison.
Biometric identification: The user only provides the fingerprint. That way, inner bio will search his
fingerprint database, comparing the fingerprint read with all fingerprints registered in the database.
Such type of comparison is known as 1 to N (many), and is the slowest type of comparison, varying from
1 to 7 seconds, depending on the amount of users registered and on the quality of the fingerprint.

RequestModelBio (Inner)
Description: Requests the model of Inner bio. To receive the result from this operation, you should call the
ReceberModeloBio function while the operation is processed.
Parameters:

Inner:

1 to 32 For serial communication.


1 to 99 For TCP/IP communication using variable port.
1 to ... For TCP/IP communication using fixed port.

General responses: Yes.


Specific responses: None.

"#$ %%&'

)! )

Description of Functions:

ReceiveModelBio (Inner, OnLine, Model)


Description: Returns the result from RequestModelBio command. Inner Bios model is returned by
reference in the parameter of the function.
Parameters:

Inner:

1 to 32 For serial communication.


1 to 99 For TCP/IP communication using variable port.
1 to ... For TCP/IP communication using fixed port.

OnLine:

0 The command was used with inner in OffLine mode.


1 The command was used with inner in OnLine mode.

Model:

2 Bio Light 100 users.


4 Bio 1000/4000 users.
255 - Unknown version.

General responses: Yes.


Specific responses: None.
RequestVersionBio (Inner)
Description: Requests the firmware version of the Inner Bios board, which is the board that stores the
fingerprints.
Parameters:

Inner:

1 to 32 For serial communication.


1 to 99 For TCP/IP communication using variable port.
1 to ... For TCP/IP communication using fixed port.

General responses: Yes.


Specific responses: None.

ReceiveVersionBio (Inner, OnLine, HighVersion, LowVersion)


Description: Returns the result from RequestVersionBio command. Inner Bios model is returned by
reference in the parameters of the function.
Parameters:

Inner:

1 to 32 For serial communication.


1 to 99 For TCP/IP communication using variable port.
1 to ... For TCP/IP communication using fixed port.

OnLine:

0 The command was used with inner in OffLine mode.


1 The command was used with inner in OnLine mode.

HighVersion:

High part of version.

LowVersion:

Low part of version.

General responses: Yes.

"#$ %%&'

)! )

Description of Functions:

Specific responses: None.


RequestUsersQuantityBio (Inner)
Description: Requests the amount of users registered in Inner Bio.
Parameters:

Inner:

1 to 32 For serial communication.


1 to 99 For TCP/IP communication using variable port.
1 to ... For TCP/IP communication using fixed port.

General responses: Yes.


Specific responses: None.
ReceiveUsersQuantityBio (Inner, OnLine, Quantity)
Description: Returns the result from SolicitarQuantidadeUsuariosBio command. The amount of users
registered in Inner Bio is returned by reference in the parameters of the function.
Parameters:

Inner:

1 to 32 For serial communication.


1 to 99 For TCP/IP communication using variable port.
1 to ... For TCP/IP communication using fixed port.

OnLine:

0 The command was used with inner in OffLine mode.


1 The command was used with inner in OnLine mode.

Quantity:

Total users registered in Inner Bio.

General responses: Yes.


Specific responses: None.

RequestResgisteredUserBio (Inner, User)


Description: Requests a template containing both fingerprints from the specific User to Inner Bio.
Parameters:

Inner:

1 to 32 For serial communication.


1 to 99 For TCP/IP communication using variable port.
1 to ... For TCP/IP communication using fixed port.

User:

Registered user card number.

General responses: Yes.


Specific responses: 128 Invalid user.
ReceiveRegisteredUserBio (Inner, OnLine, Template)

"#$ %%&'

)! )

Description of Functions:

Description: Returns the result obtained with RequestRegisteredUserBio command and the template
containing both fingerprints from user registered in Inner Bio. The template is returned by reference in the
function parameters.
Parameters:

Inner:

1 to 32 For serial communication.


1 to 99 For TCP/IP communication using variable port.
1 to ... For TCP/IP communication using fixed port.

OnLine:

0 The command was used with inner in OffLine mode.


1 The command was used with inner in OnLine mode.

Template:

User registration with both fingerprints, the data is in


binary form and should never be changed. The template
size is 844 bytes.

General responses: Yes.


Specific responses: None.
RequestDeleteUser (Inner, User)
Description: Requests Inner bio to delete the user registration of a specific user. The response of the
deletion is checked using UserWasDeleted function.
Parameters:

Inner:

1 to 32 For serial communication.


1 to 99 For TCP/IP communication using variable port.
1 to ... For TCP/IP communication using fixed port.

User:

Number of user that is to be deleted.

General responses: Yes.


Specific responses: 128 Invalid user.
UserWasDeleted (Inner, OnLine)
Description: Returns the result obtained with command RequestDeleteUser. If the function returns 0, the
user was successfully deleted.
Parameters:

Inner:

1 to 32 For serial communication.


1 to 99 For TCP/IP communication using variable port.
1 to ... For TCP/IP communication using fixed port.

OnLine:

0 The command was used with inner in OffLine mode.


1 The command was used with inner in OnLine mode.

General responses: Yes.


Specific responses: None.
InsertUserReaderBio (Inner, Type, User)

"#$ %%&'

Description of Functions:

Description: Requests Inner Bio to insert a user using the biometric reader. The reader will lit the red light
and, after the user inserts fingerprint, he/she will automatically be registered in the Inner Bio with the card
number used in the User parameter.
Parameters:

Inner:

1 to 32 For serial communication.


1 to 99 For TCP/IP communication using variable port.
1 to ... For TCP/IP communication using fixed port.

Type:

0 to request the first template


1 - to request the second template (same finger) and
save.
2 - to request the second template (different finger) and
save.

User:

Card number the user is to receive.

General responses:

Yes.

Specific responses:

128 Invalid user.


129 Invalid type of registration.

ResultInsertUserReaderBio (Inner, OnLine)


Description: Returns the result of InsertUserReaderBio command. If the response is 0, the user was
successfully registered.
Parameters:

Inner:

1 to 32 For serial communication.


1 to 99 For TCP/IP communication using variable port.
1 to ... For TCP/IP communication using fixed port.

OnLine:

0 The command was used with inner in OffLine mode.


1 The command was used with inner in OnLine mode.

General responses: Yes.


Specific responses: None.
PerformBiometricVerificationBio (Inner, User)
Description: When calling this function, the Inner will lit the biometric reader and ask the user to insert
his/her finger. After that, it will compare the fingerprint(s) associated to the number of the card passed in
the parameters, which is stored in its memory with the fingerprint inserted by the user. The response from
this process is returned in ResultBiometricVerification function.
Parameters:

"#$ %%&'

Inner:

1 to 32 For serial communication.


1 to 99 For TCP/IP communication using variable port.
1 to ... For TCP/IP communication using fixed port.

User:

Number of user registered in inners memory.

Description of Functions:

General responses: Yes.


Specific responses: 128 Invalid user.
ResultBiomatricVerification (Inner, OnLine)
Description: Returns the result of PerformBiometricVerificationBio command. If the response is 0, the
user was successfully compared.
Parameters:

Inner:

1 to 32 For serial communication.


1 to 99 For TCP/IP communication using variable port.
1 to ... For TCP/IP communication using fixed port.

OnLine:

0 The command was used with inner in OffLine mode.


1 The command was used with inner in OnLine mode.

General responses: Yes.


Specific responses: None.
PerformBiometricIdentificationBio (Inner)
Description: When this function is called, the Inner will lit the biometric reader and ask the user to insert
his/her finger. Then, it will compare the fingerprint to all fingerprints registered in the equipments
database. The result of this operation is returned through ResultadoIdentificacaoBiometrica function.
Parameters:

Inner:

1 to 32 For serial communication.


1 to 99 For TCP/IP communication using variable port.
1 to ... For TCP/IP communication using fixed port.

General responses: Yes.


Specific responses: None.
ResultBiometricIdentification (Inner, OnLine, User)
Description: Returns the result of InserirUsuarioLeitorBio command. If the return is 0, the user was
successfully identified, and his/her card number will return by reference in the function parameter.
Parameters:

Inner:

1 to 32 For serial communication.


1 to 99 For TCP/IP communication using variable port.
1 to ... For TCP/IP communication using fixed port.

OnLine:

0 The command was used with inner in OffLine mode.


1 The command was used with inner in OnLine mode.

User:

Number of user registered in Inner Bio which has the


same fingerprint as the finger placed onto the biometric reader.

General responses: Yes.


Specific responses: None.

"#$ %%&'

Description of Functions:

RequestTemplateReader (Inner)
Description: Requests a template containing only one fingerprint to Inner Bio. When this function is
performed, Inner Bio'
s biometric reader will lit and the fingerprint inserted will be sent directly to the
application, without being stored in the database.
It is necessary to call ReceiveTemplateReader function to receive the fingerprint.
Parameters:

Inner:

1 to 32 For serial communication.


1 to 99 For TCP/IP communication using variable port.
1 to ... For TCP/IP communication using fixed port.

General responses: Yes.


Specific responses: None.
ReceiveTemplateReader (Inner, OnLine, Template)
Description: Returns the result of RequestTemplateReader command. If the response is 0, the template
was successfully received. The template is returned by reference in the function parameter.
Parameters:

Inner:

1 to 32 For serial communication.


1 to 99 For TCP/IP communication using variable port.
1 to ... For TCP/IP communication using fixed port.

OnLine:

0 The command was used with inner in OffLine mode.


1 The command was used with inner in OnLine mode.

Template:

Fingerprint received by the biometric reader. It consists of a byte


Array and its content must never be changed. Its size is 404
bytes.

General responses: Yes.


Specific responses: None.
SetupBio (Inner, EnableIdentification, EnableVerification)
Description: Enables/Disables the biometric identification and/or biometric check of the Inner Bio. The
settings'result should be obtained using ResultSetupBio command.
Parameters:

Inner:

"#$ %%&'

1 to 32 For serial communication.


1 to 99 For TCP/IP communication using variable port.
1 to ... For TCP/IP communication using fixed port.

EnableIdentification:

0 Disables.
1 Enables.

EnableVerification:

0 Disables.
1 Enables.

Description of Functions:

General responses: Yes.


Specific responses: None.
ResultSetupBio (Inner, OnLine)
Description: Returns the result of Inner Bio'
s setting, SetupBio function. If the response is 0, Inner Bio
was successfully set.
Parameters:

Inner:

1 to 32 For serial communication.


1 to 99 For TCP/IP communication using variable port.
1 to ... For TCP/IP communication using fixed port.

OnLine:

0 The command was used with inner in OffLine mode.


1 The command was used with inner in OnLine mode.

General responses: Yes.


Specific responses: None.
SendUserBio (Inner, Template)
Description: Sends a template with two fingerprints so that Inner Bio registers them in its database. The
result of this process is to be checked when returning UserWasSent function.
Parameters:

Inner:

1 to 32 For serial communication.


1 to 99 For TCP/IP communication using variable port.
1 to ... For TCP/IP communication using fixed port.

Template:

User registration containing two fingerprints and the


user number. It is a byte array sized
844 bytes.

General responses: Yes.


Specific responses: None.
UserWasSent (Inner, OnLine)
Description: Returns the result obtained after registering Template in Inner Bio using SendUserBio
function. If the response is 0, the template was successfully registered.
Parameters:

Inner:

1 to 32 For serial communication.


1 to 99 For TCP/IP communication using variable port.
1 to ... For TCP/IP communication using fixed port.

OnLine:

0 The command was used with inner in OffLine mode.


1 The command was used with inner in OnLine mode.

General responses: Yes.


Specific responses: None.

"#$ %%&'

Description of Functions:

CompareFingerprintReader (Inner, Template)


Description: When this function is run, Inner Bio will lit the biometric reader to request the user'
s
fingerprint and will compare the fingerprint inserted by the user to the fingerprint sent by the function in
the Template parameter. The result of the comparison is returned by the
ResultCompareFingerprintReader function.
Parameters:

Inner:

1 to 32 For serial communication.


1 to 99 For TCP/IP communication using variable port.
1 to ... For TCP/IP communication using fixed port.

Template:

Fingerprint to be compared. Byte array sized 404 bytes.

General responses: Yes.


Specific responses: None.
ResultCompareFingerprintReader (Inner, OnLine)
Description: Returns the result obtained from comparing the user'
s fingerprint to the template sent to
Inner Bio through the CompareFingerprintReader function. If the response is 0, the fingerprint inserted
is the same that was sent.
Parameters:

Inner:

1 to 32 For serial communication.


1 to 99 For TCP/IP communication using variable port.
1 to ... For TCP/IP communication using fixed port.

OnLine:

0 The command was used with inner in OffLine mode.


1 The command was used with inner in OnLine mode.

General responses: Yes.


Specific responses: None.
InsertUserWithoutFingerprintBio (Card)
Description: Inserts the card number in the user list without Inner Bio'
s fingerprint. Such number is stored
in an buffer inside the dll and will only be sent to the inner after the SendUserListWithoutFingerprintBio
function is called. The maximum amount of digits for the card is 10. In case the cards have more than 10
digits, use 10 less significant digits on the card.
Parameters:

Card:

1 to 9999999999 - User card number.

General responses: Yes.


Specific responses: 128 Invalid card.
SendUserListWithoutFingerprintBio (Inner)

"#$ %%&'

) !)

Description of Functions:

Description: Sends buffer containing non-fingerprint user list to Inner. After running command, the buffer
is cleaned by the dll.
Parameters:

Inner:

1 to 32 For serial communication.


1 to 99 For TCP/IP communication using variable port.
1 to ... For TCP/IP communication using fixed port.

General responses: Yes.


Specific responses: None.

SetBioLight (Light)
Description: Defines that the inner used in the moment is a bio light inner, instead of a bio 1000/4000
inner. This function must be called whenever necessary before RequestRegisteredUserBio,
RequestDeleteUser, InsertUserReaderBio, and PerformBiometricVerificationBio functions.
Parameters:

Light:

1 A Bio Light Inner


0 A Bio 1000/4000 Inner (default value)

General responses: None.


Specific responses: None.

"#$ %%&'

Description of Functions:

Functions to receive all users registered in Inner Bio


The functions below are used to receive all users registered in Inner Bio. This process may take long, so
it may not be performed in OnLine mode and the user collection must be made in only one inner at a
time.
Inner Bio'
s user list is transmitted by the equipment in many packages.
Below there is a fake code to receive all users registered in Inner Bio:
//Lets assume the communication has already been established to the Inner.
char Usuario[16];
InitializeCollectionUserListBio ();
Do While ThereisNextPackage ()
//Requests a package of the bios user list
Ret = RequestUserListBio (1);
If (Ret = 0) {
//Receives a part of the list containing users
Ret = ReceivePackageUserListBio (1);
//Checks if there is a user
Do While ThereisNextUser ()
//Requests a user from the list
Ret = ReceiveListUser (1, User);
If (Ret = 0) {
//Stores the user number in the database
//Or requests the user'
s full registration (including his fingerprints)
}
Loop
}
Loop
InitializeCollectionUserListBio ()
Description: Prepares the dll to start the collection of Inner Bio'
s users. It is mandatory that this function
be called at process start.
Parameters: None.
General responses: Yes.
Specific responses: None.

"#$ %%&'

Description of Functions:

RequestUserListBio (Inner)
Description: Requests the current Inner Bios user list package.
Parameters:

Inner:

1 to 32 For serial communication.


1 to 99 For TCP/IP communication using variable port.
1 to ... For TCP/IP communication using fixed port.

General responses: Yes.


Specific responses: None.
ReceivePackageUserListBio (Inner)
Description: Receives package requested by RequestUserListBio function.
Parameters:

Inner:

1 to 32 For serial communication.


1 to 99 For TCP/IP communication using variable port.
1 to ... For TCP/IP communication using fixed port.

General responses: Yes.


Specific responses:

128 No user registered.


129 Invalid package received.

ReceiveListUser (Inner, User)


Description: Receives one user at a time from package previously received. The user number is returned
by the parameter of the function.
Parameters:

Inner:

1 to 32 For serial communication.


1 to 99 For TCP/IP communication using variable port.
1 to ... For TCP/IP communication using fixed port.

User:

Number of user registered.

General responses: Yes.


Specific responses: 128 The user list was not requested.
ThereisNextUser ()
Description: Returns 1 if there are users in the package received.
Parameters: None.
General responses: None.

"#$ %%&'

Description of Functions:

Specific responses:

0 No user.
1 There are users.

ThereisNextPackage ()
Description: Returns 1 if there are more packages in the user list to be received from Inner Bio.
Parameters: None.
General responses: None.
Specific responses:

"#$ %%&'

0 There are no more packages.


1 There are more packages.

Description of Functions:

Inner with modem functions


After initializing communication via modem, all further functions are valid for communication via modem.
SendStringInitializingModem (Str);
Description: Sends a string to be run by the modem. The string should contain a valid AT command for
the modem used.
Parameters:

Str Valid string of an AT command.

General responses: Yes.


Specific responses: None.
ReadByteModem ()
Description: Checks the response after sending an AT command to be run.
Parameters: None.
General responses: None.
Specific responses:

-1 Processing.
1, 5, 10, or 12 Connected modem.
3 No answer from modem.
6 No dial tone.
7 Busy.

ConnectModem (Port, Str, Tone, Telephone, Inner);


Description: Sets, dials, and connects to the desired modem and inner.
Parameters:

Port Number of the modems serial port.


Str Modems initialization string, with AT commands.
Tone If 0, pulse dial.
If 1, tone dial.
Telephone String containing the phone/extension number to be dialed.
Inner Number of inner connected to modem.

General responses: None.


Specific responses:

"#$ %%&'

-3 Invalid telephone.
-2 Invalid initialization string.
-1 Processing.
1, 5, 10, or 12 Connected modem.

Description of Functions:

3 No answer from modem.


6 No dial tone.
7 Busy.

"#$ %%&'

Das könnte Ihnen auch gefallen