Manual SDK Leitor de Biometria Facial

I
Catraca
SDK4 Leitor de Biometria Facial
SDK Leitor de Biometria Facial
NOTA AO USUÁRIO .......................................................................................... 3
1 USUÁRIO ADMINISTRADOR ............................................................................ 4
2 APRESENTAÇÃO ........................................................................................ 6
3 CONEXÕES DO LEITOR ................................................................................ 7
4 MENU ..................................................................................................... 8
4.1 COMO ACESSAR O MENU DO EQUIPAMENTO ................................................................................... 9
4.2 COMO ACESSAR O MENU SENDO USUÁRIO ADMINISTRADOR ..................................................... 9
5 GUIA RÁPIDO PARA CONFIGURAÇÕES DO LEITOR FACIAL E
SOFTWARE .................................................................................................. 10
5.1 CONFIGURAÇÕES BÁSICAS NO EQUIPAMENTO ............................................................................. 10
5.2 REQUISITOS ............................................................................................................................................. 12
5.3 CONFIGURAÇÕES NO SOFTWARE ...................................................................................................... 12
5.4 COMANDO BÁSICO SDK: ENVIAR USUÁRIOS .................................................................................. 13
5.5 COMANDO BÁSICO SDK: BUSCAR DADOS SOBRE USUÁRIOS ..................................................... 16
5.5.1 Buscar Foto ........................................................................................................................................ 16
5.5.2 Buscar Senha ...................................................................................................................................... 17
5.5.3 Buscar Cartão ..................................................................................................................................... 18
5.6 COMANDO BÁSICO SDK: APAGAR USUÁRIOS ................................................................................. 18
5.6.1 Apagar usuário ................................................................................................................................... 18
5.6.2 Apagar todos ....................................................................................................................................... 19
5.7 COMANDO BÁSICO SDK: LISTA .......................................................................................................... 20
5.7.1 Buscar lista ......................................................................................................................................... 20
5.7.2 Adicionar na lista................................................................................................................................ 21
5.8 COMANDO BÁSICO SDK: SALVAR FOTOS ........................................................................................ 25
5.8.1 Salvar fotos ......................................................................................................................................... 25
6 REQUISITOS PARA USO DE IMAGENS ENVIADAS VIA SOFTWARE .............................. 26
7 COMANDOS UTILIZADOS NA SDK PARA BIOMETRIA FACIAL ................................... 27
8 DIAGRAMA INICIANDO COMUNICAÇÃO ............................................................. 33
9 DIAGRAMA BUSCAR LISTA DE USUÁRIOS .......................................................... 34
10 DIAGRAMA ENVIAR LISTA DE USUÁRIOS ........................................................ 35
11 ESPECIFICAÇÕES TÉCNICAS ....................................................................... 36
12 HISTÓRICO DE REVISÕES DESTE MANUAL ...................................................... 39
Manual SDK Leitor de Biometria Facial PG - 2 -

NOTA AO USUÁRIO
Este manual detalha a comunicação com o leitor de biometria facial, utilizado nos
produtos Topdata®, dada através da biblioteca “SDK Biometria Facial” sendo direcionado ao
desenvolvedor de software que fará uso deste recurso.
Detalhes sobre o funcionamento do leitor podem ser encontrados no “Manual Leitor Biometria
Facial”.
Recomendamos que leia este documento com atenção e aplique apenas as configurações
aqui contidas. Configurações divergentes podem alterar o modo de funcionamento do leitor.

1 USUÁRIO ADMINISTRADOR
ATENÇÃO:
Caso configure algum usuário via menu para ser “Administrador”, lembre-se que
ele será o único a acessar os menus de configurações e cadastros do equipamento, logo
se o mesmo não estiver disponível, ninguém terá acesso ao menu de configuração.
Por essa razão a Topdata recomenda o cadastro de dois ou mais “Administradores”
relacionados à biometria facial, além de outro associado a um cartão de proximidade
garantindo o acesso ao menu.
Apenas usuários com permissão para acessar o menu devem ser definidos como
“Administrador”. Por padrão, podem ser configurados até 10 usuários nesta categoria.
Para os demais, o campo “Tipo” deve ser configurado como “Usuário” permitindo assim
o reconhecimento através de face.
Configuração de usuário administrador no Leitor Facial:
Usuário comum, sem permissão de

acesso ao menu
Usuário com permissão de acesso ao menu, via
face ou cartão
Login de usuário administrador no Software:
Tipos :
• Usuário: Tipo “Usuário” consiste no usuário padrão para conhecimento facial e que não
tem acesso ao menu de configurações do equipamento.
• Admin: Tipo “Admin” consiste no usuário que além do reconhecimento facial padrão,
terá acesso a todo menu de configurações do equipamento. Por padrão, podem ser
configurados até 10 usuários do tipo “Administrador”. Se nenhum “Admin” for
configurado, o menu de configurações fica desprotegido e acessado sem solicitação da

identificação de um administrador. A utilização de usuários “Administradores” restringe

o acesso aos menus de configurações e cadastros do equipamento à apenas esta
categoria, logo, se o mesmo não estiver disponível, ninguém terá acesso aos menus.
• Superusuário: Esta opção só será exibida após configurar pelo menos um usuário com
permissão de “Admin” através do “Menu”. A utilização de “Superusuário” não é
recomendada pela Topdata. Consiste em um usuário com permissão inferior em
comparação com o "Admin". Permite adicionar, modificar e excluir funcionários, com
exceção da alteração de permissões e ajustar configurações de rede e visualizar
informações.

2 APRESENTAÇÃO
O leitor de biometria facial permite, através do cadastro e reconhecimento de faces, o

controle de acesso de forma rápida, inteligente e segura. Com ele é possível:
• Cadastro de usuários através do leitor de biometria facial.
• Cadastro de usuários através de fotos em formato “JPG” enviadas do software para o
leitor, o que substitui o cadastro direto no equipamento.
• Função para detecção de "Rosto Vivo".
• Função para detecção de usuários que utilizam máscara de proteção.
• Atribuir funções distintas para usuários: “Usuário” ou “Administrador”, concedendo
permissão para utilizar o menu de configuração e cadastro das biometrias.
• Proteção de tela do leitor, ativada automaticamente.
• Desligamento automático de tela, após período de inatividade.
• Ativação automática da tela através da detecção da face pela câmera do leitor.
• Detecção de face repetida.
• Configuração da distância para leitura facial.
• Iluminação automática da parte frontal do leitor para identificação de usuários em
ambiente com pouca luz.

3 CONEXÕES DO LEITOR
Energia elétrica e rede TCP/IP

Consultar o “Manual Leitor Biometria Facial", capítulo 2.1 para detalhes quanto a
alimentação do equipamento e também para comunicação TCP/IP.
Local de instalação
Consultar o “Manual Leitor Biometria Facial", capítulo 2.2, para obter orientações
quanto a definição do "Local de instalação".

4 MENU
Neste manual são abordados apenas os menus básicos do leitor de biometria facial que
podem ser configurados para funcionamento do equipamento. Mais detalhes poderão ser
encontrados no “Manual Leitor Biometria Facial”.
No menu geral do dispositivo de biometria facial poderão ser encontradas as seguintes
funções, onde:
Menu Display Descrição

Permite cadastrar, alterar ou excluir biometrias faciais,
números de cartões de proximidade e senha. Este menu
USUÁRIOS
possui ainda a possibilidade de exportar e importar
usuários de/para um pendrive.
Menu utilizado para configurar o formato de saída da

ACESSO
interface.
REDE Permite configurar a Rede, Servidor e Ethernet do leitor.
Permite configurar parâmetros de funcionamento do

dispositivo como idioma, tempo de repouso de tela,
SISTEMA
distância, rosto vivo, além de configurações avançadas
como uso de máscara e atualização de firmware.
Permite exportar e apagar registros, excluir usuários

DADOS inclusive administradores, limpar banco de dados e
restaurar configurações.

Mostra a capacidade de armazenamento do leitor em

INFORMAÇÕES termos de usuários com biometrias faciais cadastradas,
cartão, senha e quantidade de registros.
4.1 COMO ACESSAR O MENU DO EQUIPAMENTO
Para acessar o menu de configuração do leitor de biometria facial, o usuário deve tocar
qualquer local da tela até a exibição do icone engrenagem localizado no seu canto inferior
esquerdo .
Clicar sobre o ícone. A seguinte tela será exibida:
4.2 COMO ACESSAR O MENU SENDO USUÁRIO ADMINISTRADOR
Consultar o “Manual Leitor Biometria Facial”, capítulo 5.2 para saber como acessar
menu do leitor sendo um usuário do tipo “Administrador”.

5 GUIA RÁPIDO PARA CONFIGURAÇÕES DO LEITOR FACIAL E SOFTWARE
Este capítulo apresenta as configurações básicas necessárias para operação e

comunicação do leitor de biometria facial com o software Topdata®. Mais detalhes podem ser
encontrados no “Manual Leitor Biometria Facial”.
5.1 CONFIGURAÇÕES BÁSICAS NO EQUIPAMENTO
Ao utilizar o equipamento pela primeira vez ou após restaurar as configurações de fábrica,

para operação e comunicação, deve-se configurar os parâmetros indicados a seguir:
Passo Descrição Tela
MENU -> REDE -> REDE:
ID: Configurar cada leitor com um número.

Exemplo : “1”.
1
PORTA: Mais de um equipamento pode utilizar a
mesma porta. Configurar por exemplo 5005.
BAUD RATE: 38.400 bps.
FUNÇÃO COM: Configurar “Ethernet”.

MENU -> REDE -> SERVIDOR configurar:
Req. Servidor: “Sim”.

Domínio: “Não”.
URL: “Vazio”, sem preencher.
IP: Configurar o IP do computador em que está
2
instalado o software de comunicação.
Porta: Porta de comunicação do computador, é a
mesma para todos dispositivos. Valor padrão
“7792” podendo ser outro valor.
Heartbeat: Utilizar o valor padrão “3”.
Servidor valida: Configurar “Não”.
MENU -> REDE -> ETHERNET:
DHCP: Para utilização de DHCP, configurar

“Sim”, caso contrário, “Não”.
IP: Se utiliza IP fixo, atribuir um IP compatível
3
com a rede utilizada para cada equipamento.
MÁSCARA: Configurar a máscara compatível à
rede onde se encontra o equipamento.
DNS: Configurar 8.8.8.8.
GATEWAY: Configurar o gateway compatível.

5.2 REQUISITOS
Software:
• É requisito a instalação do .NET Core 3.1
Sistemas compatíveis:
• Sistemas operacionais compatíveis: Windows 11, Windows 10, Windows 8, Windows
7, Vista, XP, 2000, Windows Server 2019, Windows Server 2016, Windows Server 2012
R2, Windows Server 2008 R2 e Windows Server 2008, sendo 32 ou 64 bits.
5.3 CONFIGURAÇÕES NO SOFTWARE
a) O pacote contendo o arquivo SDK Leitor Facial deverá ser disponibilizado em uma pasta
do seu computador.
b) Executar o aplicativo “SDK Leitor Facial.exe” como “Administrador” . A pasta é por
exemplo C:\SDK Leitor Facial\SDK Leitor Facial\bin\Debug\netcoreapp3.1:
c) Verificar se a SDK foi carregada corretamente.

d) A porta configurada no software deverá ser a mesma configurada no equipamento,

conforme descrito no capítulo 8.2 do “Manual Leitor Biometria Facial”. Após selecionar
a porta de comunicação do servidor clicar em “Iniciar”:
A opção “Equipamento” exibe o número de série do leitor facial conectado:
e) Permitir acesso no Firewall do seu computador, caso seja necessário.
5.4 COMANDO BÁSICO SDK: ENVIAR USUÁRIOS
ID: Corresponde ao identificador do usuário. Obrigatório que o valor deve estar

compreendido entre 1 e 65.535.

User: Configurar o tipo como “User”. Atentar-se ao fato de que em caso de cadastros
de usuários “Admin” apenas esta categoria terá permissão para acessar o “MENU” do
equipamento. O mais comum é configurar todos os “ID’s” como “User”, o que permite o acesso
aos menus a todos os usuários. Os usuários podem ser do tipo:
• Usuário: Tipo “Usuário” consiste no usuário padrão para conhecimento facial e que não
tem acesso ao menu de configurações do equipamento.
• Admin: Tipo “Admin” consiste no usuário que além do reconhecimento facial padrão,
terá acesso a todo menu de configurações do equipamento. Por padrão, podem ser
configurados até 10 usuários do tipo “Administrador”. Se nenhum “Admin” for
configurado, o menu de configurações fica desprotegido e acessado sem solicitação da
identificação de um administrador. A utilização de usuários “Administradores” restringe
o acesso aos menus de configurações e cadastros do equipamento à apenas esta
categoria, logo, se o mesmo não estiver disponível, ninguém terá acesso aos menus.
• Superusuário: Esta opção só será exibida após configurar pelo menos um usuário com
permissão de “Admin” através do “Menu”. A utilização de “Superusuário” não é
recomendada pela Topdata. Consiste em um usuário com permissão inferior em
comparação com o "Admin". Permite adicionar, modificar e excluir funcionários, com
exceção da alteração de permissões e ajustar configurações de rede e visualizar
informações.
Cartão: Corresponde ao número do cartão do usuário caso utilize. Este campo deverá
ser preenchido com 8 dígitos que correspondem ao número Facility Code seguido do número
Wiegand. Desses 8 dígitos observar que:
• Os 3 primeiros dígitos: devem ser compreendidos entre 001 a 255.
• Os últimos 5 dígitos: devem ser compreendidos entre 00001 a 65535.
Exemplo: 25565535
Senha: Não é necessário preencher. Utilizar o máximo possível o acesso através da face
e evitar contato digitando senha no display do leitor.
Foto: Associar a foto que será utilizada como biometria facial. Os seguintes requisitos
devem ser obedecidos:

• O arquivo com a foto do usuário deve ter qualidade, nitidez, posição do rosto vertical
sem uso de acessórios como máscara, boné, touca, óculos escuros, entre outros. Estes
objetos poderão influenciar no processo de reconhecimento.
• O formato do arquivo deve ser somente JPG.
• O tamanho do arquivo de imagem deve ser inferior a 150Kb.
Para mais informações consultar o manual do “Leitor Facial” e verificar os requisitos
para utilizar a foto, quanto a formato, tamanho e resolução.
Para enviar os comandos, clicar no botão à direita do campo preenchido, por exemplo,
clicando em “Foto” o envio da foto será realizado. Idem para “Senha” e “Cartão” :

Utilize “Menu” -> “Usuários” -> “Usuários” para verificar os dados enviados do software
ao equipamento:
5.5 COMANDO BÁSICO SDK: BUSCAR DADOS SOBRE USUÁRIOS
5.5.1 Buscar Foto
Para buscar a foto de um usuário será necessário:

a) Digitar o “ID” do usuário e clicar em “Buscar foto”:
b) O comando para buscar a foto será enviado para o equipamento.

c) O botão “CopyBoard” permite que os dados recebidos sejam lidos em um editor de
texto. Por exemplo:
AIPK02000571: 11:54:17:847 - Enviar comando!

{"cmd":"getuserinfo","enrollid":1,"backupnum":50}

AIPK02000571: 11:54:17:853 - Retorno :

{"ret":"getuserinfo","sn":"AIPK02000571","result":true,"enrollid":1,"aliasid"
:"","name":"Funcionario
Topdata","backupnum":50,"admin":0,"record":"/9j/4AAQSkZJRgABAQAAAQABAAD/2wBD.
.........................................................................lEGt
F6cgmhh5O8//9k="}
5.5.2 Buscar Senha
a) Digitar o “ID” do usuário e clicar em “Buscar senha”:
b) O comando para buscar a senha será enviado.

texto. Por exemplo:

AIPK02000571: 11:59:00:632 - Retorno :
:"","name":"Funcionario Topdata","backupnum":10,"admin":0,"record":1234}

5.5.3 Buscar Cartão
a) Digitar o “ID” do usuário e clicar em “Buscar cartão”:
b) O comando para buscar o cartão será enviado.

texto. Por exemplo:

AIPK02000571: 12:03:00:119 - Retorno :
:"","name":"Funcionario Topdata","backupnum":11,"admin":0,"record":8094384}
5.6 COMANDO BÁSICO SDK: APAGAR USUÁRIOS
5.6.1 Apagar usuário
a) Digitar o “ID” do usuário e clicar em “Apagar”:
b) O comando para excluir o usuário será enviado.


texto. Por exemplo:

{"cmd":"deleteuser","enrollid":1,"backupnum":13}
AIPK02000571: 13:01:10:590 - Retorno :
{"ret":"deleteuser","enrollid":1,"aliasid":"","sn":"AIPK02000571","backupnum"
:13,"result":true}
5.6.2 Apagar todos
a) Digitar o “ID” do usuário e clicar em “Apagar todos”:
b) O comando para excluir TODOS os usuários será enviado.

texto. Por exemplo:
AIPK02000571: 13:29:41:739 - Enviar comando! {"cmd":"cleanuser","stn":false}

AIPK02000571: 13:29:41:822 - Retorno :
{"ret":"cleanuser","sn":"AIPK02000571","result":true}

5.7 COMANDO BÁSICO SDK: LISTA
5.7.1 Buscar lista
a) Para obter a lista de usuários do leitor de biometria facial, clicar em “Buscar lista”:
b) O comando para buscar lista será enviado.

texto. Por exemplo:
AIPK02000571: 13:32:17:170 - Enviar comando! {"cmd":"disabledevice"}

AIPK02000571: 13:32:17:181 - Retorno :
{"ret":"disabledevice","sn":"AIPK02000571","result":true}
AIPK02000571: 13:32:17:189 - Enviar comando! {"cmd":"getuserlist","stn":true}
AIPK02000571: 13:32:17:199 - Retorno :

{"ret":"getuserlist","sn":"AIPK02000571","result":true,"count":3,"from":0,"to
":3,"record":[{"enrollid":1,"aliasid":"","admin":"0","backupnum":50},{"enroll
id":2,"aliasid":"","admin":"0","backupnum":11},{"enrollid":3,"aliasid":"","ad
min":"0","backupnum":10}]}
{"cmd":"getuserlist","stn":false}
AIPK02000571: 13:32:17:285 - Consultando
AIPK02000571: 13:32:17:310 - Retorno :
":0,"record":[]}
AIPK02000571: 13:32:17:371 - Fim da consulta
AIPK02000571: 13:32:17:405 - Retorno :
:"","name":"","backupnum":11,"admin":0,"record":8555218}
AIPK02000571: 13:32:17:453 - Retorno :
AIPK02000571: 13:32:17:498 - Enviar comando! {"cmd":"enabledevice"}
AIPK02000571: 13:32:17:531 - Retorno :
{"ret":"enabledevice","sn":"AIPK02000571","result":true}

5.7.2 Adicionar na lista
a) Para adicionar usuários na lista, preencher dados e clicar em “Adicionar Lista”:
b) Uma mensagem será exibida indicando “Usuário cadastrado” :

c) Clicar na aba “Lista Usuários” e verificar que o usuário foi incluído. Selecionar os
usuários a serem transferidos e clicar em “Enviar selecionados”:
d) Ao clicar em “Buscar lista” observa-se que os usuários selecionados anteriormente foram

incluídos e somados aos que já existentes:

e) O botão “CopyBoard” permite que os dados recebidos sejam lidos em um editor de

texto. Por exemplo:
AIPK02000571: 14:10:43:976 - Enviar comando! {"cmd":"disabledevice"}

AIPK02000571: 14:10:43:979 - Retorno :
{"ret":"disabledevice","sn":"AIPK02000571","result":true}
AIPK02000571: 14:10:43:980 - Enviar comando! {"cmd":"getuserlist","stn":true}
AIPK02000571: 14:10:44:150 - Retorno :

{"ret":"getuserlist","sn":"AIPK02000571","result":true,"count":21,"from":0,"t
o":21,"record":[{"enrollid":1,"aliasid":"","admin":"0","backupnum":50},{"enro
llid":2,"aliasid":"","admin":"0","backupnum":11},{"enrollid":3,"aliasid":"","
admin":"0","backupnum":10},{"enrollid":5,"aliasid":"","admin":"0","backupnum"
:10},{"enrollid":5,"aliasid":"","admin":"0","backupnum":11},{"enrollid":5,"al
iasid":"","admin":"0","backupnum":50},{"enrollid":6,"aliasid":"","admin":"0",
"backupnum":10},{"enrollid":6,"aliasid":"","admin":"0","backupnum":11},{"enro
:11},{"enrollid":7,"aliasid":"","admin":"0","backupnum":50},{"enrollid":8,"al
iasid":"","admin":"0","backupnum":10},{"enrollid":8,"aliasid":"","admin":"0",
"backupnum":11},{"enrollid":8,"aliasid":"","admin":"0","backupnum":50},{"enro
:50},{"enrollid":10,"aliasid":"","admin":"0","backupnum":10},{"enrollid":10,"
aliasid":"","admin":"0","backupnum":11},{"enrollid":10,"aliasid":"","admin":"
0","backupnum":50}]}
{"cmd":"getuserlist","stn":false}
AIPK02000571: 14:10:44:155 - Consultando
AIPK02000571: 14:10:44:161 - Retorno :
":0,"record":[]}
AIPK02000571: 14:10:44:325 - Fim da consulta
AIPK02000571: 14:10:44:326 - Retorno :
AIPK02000571: 14:10:44:337 - Retorno :
AIPK02000571: 14:10:44:348 - Retorno :
:"","name":"Nome 5","backupnum":11,"admin":0,"record":12855644}
AIPK02000571: 14:10:44:359 - Retorno :
AIPK02000571: 14:10:44:370 - Retorno :
AIPK02000571: 14:10:44:381 - Retorno :

AIPK02000571: 14:10:44:393 - Retorno :
AIPK02000571: 14:10:44:404 - Retorno :
AIPK02000571: 14:10:44:415 - Retorno :
AIPK02000571: 14:10:44:427 - Retorno :
AIPK02000571: 14:10:44:438 - Retorno :
AIPK02000571: 14:10:44:449 - Retorno :
AIPK02000571: 14:10:44:460 - Retorno :
{"ret":"getuserinfo","sn":"AIPK02000571","result":true,"enrollid":10,"aliasid
":"","name":"Nome 10","backupnum":11,"admin":0,"record":12855649}
AIPK02000571: 14:10:44:471 - Retorno :
{"ret":"getuserinfo","sn":"AIPK02000571","result":true,"enrollid":10,"aliasid
":"","name":"Nome 10","backupnum":10,"admin":0,"record":123456}
AIPK02000571: 14:10:44:472 - Enviar comando! {"cmd":"enabledevice"}
AIPK02000571: 14:10:44:482 - Retorno :
{"ret":"enabledevice","sn":"AIPK02000571","result":true}

5.8 COMANDO BÁSICO SDK: SALVAR FOTOS
5.8.1 Salvar fotos
Permite salvar em arquivos JPG as imagens dos usuários cadastradas no equipamento.

Para isso:
a) Na aba “Lista Usuários”, campo “Dados Equipamento”, selecionar os usuários e o
caminho para salvar as biometrias no computador. Clicar em “Baixar fotos”:
b) Os comandos para receber as digitais são realizados e os arquivos salvos na pasta

configurada.

6 REQUISITOS PARA USO DE IMAGENS ENVIADAS VIA SOFTWARE
a) O arquivo com a foto do usuário deve ter qualidade, nitidez, posição do rosto vertical
sem uso de acessórios como máscara, boné, touca, óculos escuro, dentre outros.
Esses elementos poderão influenciar no processo de reconhecimento.
b) O formato do arquivo deve ser somente JPG.
c) O tamanho do arquivo de imagem deve ser inferior a 150Kb.
d) A imagem deve conter entre 240X320 e 800X1280 pixels.
e) O formato recomendado é JPG 480X640. Este formato apresenta melhor
desempenho.
f) Para verificar se o formato do arquivo utilizado atende às recomendações, deve-se
verificar suas propriedades:
g) O arquivo deve conter apenas a imagem de uma pessoa. Caso a foto contenha várias
pessoas o reconhecimento da biometria pode ser prejudicado.
h) A variação de iluminação no processo de reconhecimento facial pode resultar no não
reconhecimento. Sendo assim, é necessário que a iluminação da foto seja adquada
e não esteja contra luz.
i) Fotos com tamanho e resolução fora da especificação serão rejeitadas pelo leitor no
momento da comunicação.

7 COMANDOS UTILIZADOS NA SDK PARA BIOMETRIA FACIAL
Cmd: reg
Ao realizar a comunicação com o servidor o leitor enviará o comando de registro com suas
informações.
Cmd: Nome do comando.

Sn: Nome do equipamento.
Devinfo: Informações do equipamento.
Modelname: Nome do modelo.
Usersize: Capacidade de cadastro de usuários.
Facesize: Capacidade de cadastro de fotos.
Fpsize: Não aplicado nesse modelo.
Cardsize: Capacidade de cadastro de cartões.
Pwdsize: Capacidade de cadastro de senhas.
Logsize: Capacidade de informações de log.
Useduser: Usuários cadastrados.
Usedface: Fotos cadastradas.
Usedfp: Não aplicado nesse modelo.
Usedcard: Cartões cadastradas.
Usedpwd: Senhas cadastradas.
Firmware: Versão de firmware.
Time: Horário do leitor.
Mac: Mac do equipamento.
Exemplo:
{"cmd":"reg","sn":"AIPH23004863","devinfo":{"modelname":"AiFace","usersize":
5000,"facesize":5000,"fpsize":0,"cardsize":5000,"pwdsize":5000,"logsize":500
000,"useduser":10,"usedface":10,"usedfp":0,"usedcard":10,"usedpwd":10,"usedl
og":46,"usednewlog":46,"netinuse":1,"fpalgo":"thbio3.0","firmware":"AiF43V_v
4.30","time":"2022-11-24 10:28:07","mac":"00-01-A9-13-70-4B"}}
Ret: reg
Após o equipamento enviar o comando com o registro, o software retorna que recebeu o
comando.
Ret: Informando o comando que está retornando.

Result: Retorna o comando. (true)
Cloudtime: Data e hora do servidor. (YYYY-MM-DD HH:mm:ss)
Exemplo:
{"ret":"reg","result":true,"cloudtime":"2022-11-24 10:28:08"}
Cmd: disabledevice
Comando enviado para desabilitar a captura de faces e acesso ao menu pelo leitor.
Necessário enviar antes de utilizar outros comandos.

Exemplo:
{"cmd":" disabledevice"}
Ret: disabledevice
Retorno do equipamento com a resposta sobre desabilitar o leitor.

Result: Retorno do comando.
Exemplo:
{"ret":"disabledevice","sn":"AIPH23004863","result":true}
Cmd: enabledevice
Comando enviado para habilitar o leitor para captura de faces e acesso ao menu.
Exemplo:
{"cmd":"enabledevice"}
Ret: enabledevice
Retorno do equipamento com a resposta sobre habilitar o leitor.

Result: Retorno do comando.
Exemplo:
{"ret":"enabledevice","sn":"AIPH23004863","result":true}
Cmd: setuserinfo (foto)

Comando para enviar a foto do usuário para o leitor

Enrollid: ID do usuário no leitor.
Name: Nome do usuário.
Backupnum: código da informação que irá cadastrar. (50 - foto)
Admin: Informar se o usuário é user ou admin. (0 – user, 1 – admin, 2 –

super user)
Record: Arquivo da foto em base 64.
Exemplo:
{{"cmd":"setuserinfo","enrollid":1,"name":"Teste","backupnum":50,"admin":0,"
record":"/9j/4AAQSkZJRgABAQEAYABgAAD/2wBDAAM..........YpSPnHXivVfgcvk6rdqvA2
miivVy/wDjRPFzP\u002BDI9vU5Cmn0UV9f1Z8J0CiiigAooooA/9k="}
Cmd: setuserinfo (senha)


Backupnum: código da informação que irá cadastrar. (10 - senha)
super user)
Record: Valor da senha.
Exemplo:
{
"cmd":"setuserinfo",
"enrollid":1,
"name":"Teste",
"backupnum":10,
"admin":0,
"record":123456
}
Cmd: setuserinfo (Cartão)


Backupnum: código da informação que irá cadastrar. (11 - cartão)
super user)
Record: Número do cartão Wiegand(utilizar no formato 10 bits).
Exemplo:
{"cmd":"setuserinfo","enrollid":1,"name":"Teste","backupnum":11,"admin":0,
"record":15253016}
Ret: setuserinfo
Retorno do equipamento com a resposta da inclusão do usuário.


Result: Retorna a resposta da inclusão. (true / false)
Exemplo:
{"ret":"setuserinfo","enrollid":1,"aliasid":"","sn":"AIPH23004863",
"result":true}
Cmd: getuserlist
Comando para solicitar a lista de usuário do equipamento.

Stn: Informar se é o primeiro pacote. (True caso é o primeiro pacote, false
para os pacotes seguintes)
Exemplo:
{"cmd":"getuserlist","stn":true} (primeiro pacote)
{"cmd":"getuserlist","stn":false} (de mais pacotes)
Ret: getuserlist
Retorna o pacote com a lista de funcionários.

Count: Quantidade de registo no equipamento.
From: Primeiro registro da lista.
To: Último registro da lista.
Recond: Lista de usuários.
- enrollid: ID do usuário.
- aliasid: não utilizado.
- admin: Se o usuário é usuário ou admin.
- backupnum: Tipo do registro (10 - Senha, 11 - Cartão, 50 Foto)
Exemplo:
Primeiro pacote:
{"ret":"getuserlist","sn":"AIPH23004863","result":true,"count":528,"from":0,
"to":100,"record":[{"enrollid":1,"aliasid":"","admin":"0","backupnum":10},{"
enrollid":1,"aliasid":"","admin":"0","backupnum":11},{"enrollid":1,"aliasid"
:"","admin":"0","backupnum":50},{"enrollid":2,"aliasid":"","admin":"0","back
upnum":10},......,{"enrollid":33,"aliasid":"","admin":"0","backupnum":11},{"
enrollid":33,"aliasid":"","admin":"0","backupnum":50},{"enrollid":34,"aliasi
d":"","admin":"0","backupnum":10}]}
Segundo pacote:
{"ret":"getuserlist","sn":"AIPH23004863","result":true,"count":528,"from":10
0,"to":200,"record":[{"enrollid":34,"aliasid":"","admin":"0","backupnum":11}
,{"enrollid":34,"aliasid":"","admin":"0","backupnum":50},{"enrollid":35,"ali
asid":"","admin":"0","backupnum":10},{"enrollid":35,"aliasid":"","admin":"0"

,"backupnum":11}, ...... ,{"enrollid":67,"aliasid":"","admin":"0","backupnu

m":10},{"enrollid":67,"aliasid":"","admin":"0","backupnum":11}]}
Último pacote:
{"ret":"getuserlist","sn":"AIPH23004863","result":true,"count":0,"from":0,"t
o":0,"record":[]}
Cmd: getuserinfo
Comando para solicitar a informação do usuário no equipamento.

Backupnum: código da informação que irá cadastrar
Exemplo:
Buscar informação da senha:
Buscar informação do cartão:
Buscar informações da foto:
Ret: getuserinfo
Retorna o pacote com a lista do funcionário.

Count: Quantidade de registo no equipamento.
From: Primeiro registro da lista.
To: Último registro da lista.
Recond: Valor da informação (Para cartão e senha o tipo é inteiro, para foto
é string)
Exemplo:
Retorno da senha:
{"ret":"getuserinfo","sn":"AIPH23004863","result":true,"enrollid":1,"aliasid
":"","name":"Teste","backupnum":10,"admin":0,"record":123456}
Retorno do cartão (retorna no formato Wiegand 10 bits):
":"","name":"Teste","backupnum":11,"admin":0,"record":12855641}
Retorno foto:
":"","name":"Teste","backupnum":50,"admin":0,"record":"/9j/4AAQSkZJRgABAQEAe
AB4AAD/2wBDAAMCAgMCAgMDAwMEAwMEB ... /YtIpPXFbRTuzmqSuj//2Q=="}
Cmd: deleteuser
Apaga a informação de um usuário especifico do equipamento.


Backupnum: código da informação que deseja apagar. (10 - Senha, 11 - Cartão,
50 Foto, 13- Todos)
Exemplo:
{"cmd":"deleteuser","enrollid":1,"backupnum":50}
Ret: deleteuser
Retorno do equipamento com a resposta da exclusão.

Result: Retorna a resposta da exclusão. (true / false)
Exemplo:
{"ret":"deleteuser","enrollid":1,"aliasid":"","sn":"AIPH23004863","result":t
rue}
Cmd: cleanuser
Apaga as informações de todos os usuários.
Exemplo:
{"cmd":"cleanuser" }
Ret: cleanuser
Retorno do equipamento com a resposta da exclusão de todos os usuários.

Result: Retorna a resposta da exclusão. (true / false)
Exemplo:
{"ret":"cleanuser","sn":"AIPH23004863","result":true}

8 DIAGRAMA INICIANDO COMUNICAÇÃO

9 DIAGRAMA BUSCAR LISTA DE USUÁRIOS

10 DIAGRAMA ENVIAR LISTA DE USUÁRIOS

11 ESPECIFICAÇÕES TÉCNICAS
Peso
• Kit Leitor Facial: 563,5g
• Leitor Facial Individual: 332,5g
Alimentação
• 12V DC
Câmera
• Binocular Colorida + Infravermelha 200W (live câmera)
• Precisão no reconhecimento: 99.7% FRA (Face Recognition Accuracy).
• WDR: Compensa luminosidade tornando a imagem mais nítida
• Velocidade de reconhecimento: menor que 0.2s
• Distância de reconhecimento: entre 0.5m e 1.5m, conforme configuração do leitor.
Display e Teclado
• HD 272*480 colorido.
• Touch screen capacitivo.
• Tamanho 4.3 polegadas.
Verificação e acesso
• Reconhecimento facial dinâmico.
• Cartão de proximidade RFID.
• Senha.
Cartões
• Compatível com cartões de proximidade RFID 125 KHz.
• Cartões Wiegand com Facility Code.
USB
• Uma porta do tipo USB 2.0.
• Permite exportação e importação de usuários além da atualização de firmware.
Rede
• Comunicação: Ethernet 10/100Mbps (TCP/IP).
• IP fixo ou DHCP.

Armazenamento
• Até 500.000 registros.
• Memória não volátil.
• Até 5.000 usuários com biometria facial.
• Até 5.000 usuários com cartão de proximidade.
• Até 5.000 usuários com senha.
Campainha
• Ativada através de toque na tela.
• Permite acionamento de porta ou sirene.
Iluminação externa
• Acende luz frontal em caso de ambiente com pouca iluminação.
• Configurável nos modos “Automático”, “Sempre ligado”, “Sempre desligado”.
Relógio
• Configurável via menu e software
• Horário de Verão.
• Calendário Perpétuo.
• Formato de data e hora na tela configurável.
Firmware
• Permite atualização através da porta USB.
• Mensagens na tela em Português.
• Mensagens de voz em Português.
Biometria facial
• Cadastro através do menu leitor.
• Utilizando fotos enviadas via software para o leitor.
• Distância de leitura configurável entre “Perto”, “Média” ou “Longa”. Padrão utilizado
"Perto".
Detecção por rosto vivo

• Bloqueia reconhecimento e acesso através de foto ou vídeo
• Opção configurável. Padrão sempre ativado.

Detecção de Máscara
• Configurável. Padrão desativado.
• Bloqueio do acesso à usuários não protegidos com máscara: Configurável.
Tipos de usuários
• Usuário padrão
• Administrador, com pemissão para utilizar menu
Quantidade de usuários Adminitradores

• Padrão até 10 administradores, porém este valor é configurável.
Proteção de tela
• Ativada automaticamente, com temporização configurável.
Desligamento automático
• Com temporização configurável.
• Ativação automática do leitor através da detecção da face.
Detecção de face repetida
• Para cadastros através do equipamento.
Fotos importadas para o leitor

• Podem ser enviadas através do software.
• Formato do arquivo JPG.
• Tamanho inferior a 150Kb.
• Imagem entre 240X320 e 800X1280.
• Recomendado 480x640, pois apresenta melhor desempenho.
Restauração de fábrica
• Menu permite realizar a restauração de fábrica do equipamento.

12 HISTÓRICO DE REVISÕES DESTE MANUAL
Revisão Data Alterações
Revisão 01 21/12/2022 Primeira versão do manual.

Revisão 02 10/05/2023 Correção de texto referente ao comando “deleteuser”.
Atualização referente as telas do manual. Atualização de
Revisão 03 23/06/2023
comandos, requisitos.
Revisão 04 26/06/2023 Atualização de telas referentes à v4.50 do FW.

Manual SDK Leitor de Biometria Facial

Enviado por

Dados do documento

Direitos autorais

Formatos disponíveis

Compartilhar este documento

Compartilhar ou incorporar documento

Opções de compartilhamento

Você considera este documento útil?

Este conteúdo é inapropriado?

Direitos autorais:

Formatos disponíveis

Manual SDK Leitor de Biometria Facial

Enviado por

Direitos autorais:

Formatos disponíveis

I

NOTA AO USUÁRIO .......................................................................................... 3

1 USUÁRIO ADMINISTRADOR ............................................................................ 4

3 CONEXÕES DO LEITOR ................................................................................ 7

7 COMANDOS UTILIZADOS NA SDK PARA BIOMETRIA FACIAL ................................... 27

8 DIAGRAMA INICIANDO COMUNICAÇÃO ............................................................. 33

9 DIAGRAMA BUSCAR LISTA DE USUÁRIOS .......................................................... 34

10 DIAGRAMA ENVIAR LISTA DE USUÁRIOS ........................................................ 35

11 ESPECIFICAÇÕES TÉCNICAS ....................................................................... 36

12 HISTÓRICO DE REVISÕES DESTE MANUAL ...................................................... 39

Manual SDK Leitor de Biometria Facial PG - 2 -

Manual SDK Leitor de Biometria Facial PG - 3 -

Configuração de usuário administrador no Leitor Facial:

Usuário comum, sem permissão de

Login de usuário administrador no Software:

Manual SDK Leitor de Biometria Facial PG - 4 -

identificação de um administrador. A utilização de usuários “Administradores” restringe

Manual SDK Leitor de Biometria Facial PG - 5 -

O leitor de biometria facial permite, através do cadastro e reconhecimento de faces, o

Manual SDK Leitor de Biometria Facial PG - 6 -

Energia elétrica e rede TCP/IP

Manual SDK Leitor de Biometria Facial PG - 7 -

Menu Display Descrição

Menu utilizado para configurar o formato de saída da

REDE Permite configurar a Rede, Servidor e Ethernet do leitor.

Permite configurar parâmetros de funcionamento do

Permite exportar e apagar registros, excluir usuários

Manual SDK Leitor de Biometria Facial PG - 8 -

Mostra a capacidade de armazenamento do leitor em

4.1 COMO ACESSAR O MENU DO EQUIPAMENTO

Clicar sobre o ícone. A seguinte tela será exibida:

4.2 COMO ACESSAR O MENU SENDO USUÁRIO ADMINISTRADOR

Manual SDK Leitor de Biometria Facial PG - 9 -

5 GUIA RÁPIDO PARA CONFIGURAÇÕES DO LEITOR FACIAL E SOFTWARE

Este capítulo apresenta as configurações básicas necessárias para operação e

5.1 CONFIGURAÇÕES BÁSICAS NO EQUIPAMENTO

Ao utilizar o equipamento pela primeira vez ou após restaurar as configurações de fábrica,

Passo Descrição Tela

MENU -> REDE -> REDE:

ID: Configurar cada leitor com um número.

Manual SDK Leitor de Biometria Facial PG - 10 -

MENU -> REDE -> SERVIDOR configurar:

Req. Servidor: “Sim”.

MENU -> REDE -> ETHERNET:

DHCP: Para utilização de DHCP, configurar

Manual SDK Leitor de Biometria Facial PG - 11 -

5.3 CONFIGURAÇÕES NO SOFTWARE

c) Verificar se a SDK foi carregada corretamente.

Manual SDK Leitor de Biometria Facial PG - 12 -

d) A porta configurada no software deverá ser a mesma configurada no equipamento,

A opção “Equipamento” exibe o número de série do leitor facial conectado:

e) Permitir acesso no Firewall do seu computador, caso seja necessário.

5.4 COMANDO BÁSICO SDK: ENVIAR USUÁRIOS

ID: Corresponde ao identificador do usuário. Obrigatório que o valor deve estar

Manual SDK Leitor de Biometria Facial PG - 13 -

Manual SDK Leitor de Biometria Facial PG - 14 -

Manual SDK Leitor de Biometria Facial PG - 15 -

5.5 COMANDO BÁSICO SDK: BUSCAR DADOS SOBRE USUÁRIOS

5.5.1 Buscar Foto

Para buscar a foto de um usuário será necessário:

b) O comando para buscar a foto será enviado para o equipamento.

AIPK02000571: 11:54:17:847 - Enviar comando!

Manual SDK Leitor de Biometria Facial PG - 16 -

AIPK02000571: 11:54:17:853 - Retorno :