Parâmetros Configuração

Descrição dos parâmetros de configuração dos equipamentos:

general

Configurações gerais do equipamento.

Campo Tipo Descrição
auto_reboot_hour string Hora em que o equipamento reinicia automaticamente. Valores entre "0" e "23". É necessário reiniciar o equipamento para que alterações nesse parâmetro entrem em vigor.
auto_reboot_minute string Minuto em que o equipamento realiza o reinício automático. Valores entre "0" e "59". É necessário reiniciar o equipamento para que alterações nesse parâmetro entrem em vigor.
clear_expired_users string Parâmetro que configura o grupo de pessoas expiradas a ter seus dados limpos após o reinício diário do equipamento. Valores: "all" (usuários e visitantes), "visitors" (somente visitantes) ou "disable" (desabilitado). É necessário reiniciar o equipamento para que alterações nesse parâmetro entrem em vigor.
url_reboot_enabled string Habilita a possibilidade de reinício imediato do dispositivo a partir do endpoint "/reboot". Para desabilitar "0", e para habilitar "1".
keep_user_image int Parâmetro responsável por manter ou não a foto do usuário após o seu cadastro. Valores: "1", padrão, a foto do usuário é mantida; ou "0", a foto do usuário é removida imediatamente após o cadastro.
beep_enabled string Ativa o som de beep do equipamento. Valores: "0" ou "1".
ssh_enabled string Ativa a conexão com o dispositivo via SSH, indicando que pode ser acessado remotamente para diagnósticos de engenharia. Para desabilitar "0" e para habilitar "1".
relayN_enabled string Habilita o uso do relé N, onde N vai de 1 à 4 indicando o relé (o número máximo de relés depende do produto). Para desabilitar "0" e para habilitar "1".
relayN_timeout string Tempo de ativação do relé em milissegundos, onde N vai de 1 à 4 indicando o relé (o número máximo de relés depende do produto). Exemplo: "3000".
relayN_auto_close int A configuração do relay permite que seja configurado de duas formas neste caso N é o número da porta em questão (No caso do iDAccess pode ser 0 ou 1, no caso da catraca é sempre 0 enquanto a iDBox vai de 0 a 3) e a sua configuração pode ser "0" (Funcionamento normal) e "1" (Quando sensor de porta abrir, o relê fechará) - Evita que a porta fique aberta mais tempo do que o necessário.
door_sensorN_enabled string Habilita o uso do sensor de porta N, onde N vai de 1 à 4 indicando a porta (o número máximo depende do produto). Para desabilitar "0" e para habilitar "1".
door_sensorN_idle string Indica qual o nível lógico do sensor da porta N quando ela estiver fechada, onde N vai de 1 à 4 indicando a porta (o número máximo depende do produto). Valores: "0" ou "1".
doorN_interlock string Numero das portas que estão intertravadas separados por vírgula (ex: "1,3"), onde N vai de 1 à 4 indicando a porta (o número máximo depende do produto).
bell_enabled string Habilita ou desabilita a campainha.
bell_relay string Relê no qual a campainha está conectada, o padrão é "2".
catra_timeout string Tempo que a catraca fica liberada para um giro em ms. timeout igual a zero significa tempo infinito, ou seja, liberada até o próximo giro, Exemplo: "3000". Atenção: método aplicável somente quando o dispositivo for catraca.
online string Esse parâmetro determina se o equipamento deve operar online (Modo Pro ou Modo Enterprise), ou seja, com liberação de acesso processada em servidor externo. Os valores possíveis são "0" ou "1".
local_identification string Quando o equipamento opera online, esse parâmetro define se o ele está no Modo Pro, em que a identificação é feita no próprio equipamento, ou no Modo Enterprise, em que a identificação é feita no servidor externo. Os valores possíveis são "0" ou "1".
exception_mode string Esse parâmetro deve ser setado quando o equipamento precisa permanecer com a entrada sempre liberada ou sempre bloqueada, as opções são emergency e lock_down. Para sair destes modos, basta setar esta configuração para qualquer outro valor, o padrão é none. Quando emergency está habilitado, o equipamento permanece com a entrada sempre liberada e a tela e as identificações permanecem travadas. Quando lock_down está habilitado, o equipamento permanece com a entrada sempre bloqueada e a tela e as identificações permanecem travadas.
doorN_exception_mode string Esse parâmetro - exclusivo para a linha de acesso V3 - configura o comportamento da porta N, onde N varia de 1 à 4, caso o exception_mode não seja emergency e nem lock_down. As opções possíveis são as mesmas do exception_mode (emergency e lock_down) - ambas travam as identificações, mas não travam a tela - sendo que o valor padrão também é none. Caso o valor o seja emergency, a porta permanece liberada. Quando lock_down está habilitado, a porta permanece sempre bloqueada. Por fim, para qualquer outro valor, a porta volta a operar normalmente.
language string Usado para alterar o idioma do equipamento, os valores possíveis são: pt_BR (Português), spa_SPA (Espanhol) e en_US (Inglês). Após a alteração do idioma do equipamento é necessário reinicia-lo.
daylight_savings_time_start int A data de inicio do horário de verão (Unix timestamp).
daylight_savings_time_end int A data de fim do horário de verão (Unix timestamp).
password_only string Quando habilitado e no modo online, o equipamento pedirá somente a senha ao invés de pedir o ID e senha para identificação do usuário através da interface gráfica do dispositivo. O request new_user_id_and_password enviado pelo dispositivo não muda, o user_id irá zerado. Utilize os valores "1" ou "0" para habilitar ou desabilitar respectivamente.
hide_password_only string Quando é atribuindo o valor "0" para este parâmetro e password_only (descrito acima) esta habilitado, o equipamento não esconderá a senha que é digitada. O padrão é "1".
password_only_tip string Esta configuração muda o texto da dica que é mostrada quando password_only está habilitado. Quando vazio, mostra a mensagem padrão. O valor padrão é vazio.
hide_name_on_identification string Ocultar nome no acesso. Uma vez ativado, o nome do usuário não será exibido na badge de identificação, tanto para acesso autorizado quanto não autorizado. Para desabilitar "0", e para habilitar "1".

catra

Configurações específicas da catraca.

Campo Tipo Descrição
anti_passback string Habilita ou desabilita o controle de anti-dupla entrada.
daily_reset string "0" ou "1". Habilita o reset de logs para o controle de anti-dupla entrada. Os acessos serão apagados todos os dias a meia-noite.
gateway string Sentido da entrada. Deve ser "clockwise" ou "anticlockwise" (horário ou anti-horário respectivamente).
operation_mode string Modo de operação da catraca. Controla quais sentidos da catraca serão controlados ou liberados. Deve ser "blocked", "entrance_open", "exit_open", "both_open" (Ambas controladas, entrada liberada, saída liberada e ambas liberadas respectivamente).

opening_times

Essa configuração permite definir qual o tempo de abertura da porta em milissegundos.

Campo Tipo Descrição
id int 64 Identificador único da regra de tempo de abertura especial.
user_id int 64 Inteiro indicando o usuário (referência a tabela users).
door_id int 64 Inteiro indicando a porta (valor inicial 1).
time int Tempo diferenciado de abertura em milissegundos.

RS485

Parâmetros de configuração da interface de comunicação RS485.

Campo Tipo Descrição
enabled int Habilita ou desabilita a transmissão de sinal via protocolo RS485. Os valores de entrada possíveis são: "0" (desabilitado) ou "1" (habilitado). Por padrão, o valor de entrada é "0", ou seja, a comunicação padrão não ocorrerá via RS485 e será somente via modulo de acionamento externo (MAE/Security Box)
legacy_mode int Define o modo de comunicação da interface RS485. Os valores de entrada possíveis são: "0", "1" ou "2". Para a entrada "0", a comunicação RS485 será padrão, de acordo com protocolo fornecido pela Control iD (entre em contato com suporte). Para a entrada "1", ocorrerá o envio do ID, nome e matrícula do usuário autorizado no seguinte formato em hexadecimal: "01 02 00 00 00 00 03 0D". E por fim, se for inserida a entrada "2", a transmissão será do ID do usuário em formato ASCII com 20 dígitos, sem quebra de linha. Por padrão, o valor de entrada de fábrica é "0". *Este parâmetro só está disponível para os equipamentos: iDFlex, iDAccess Pro, iDAccess Nano e iDFace.
receive_timeout int Timeout das transmissões de dados (em milissegundos). O valor padrão deste parâmetro é 1000 ms.

mifare

A configuração do modulo MIFARE permite que a quantidade de bits que a leitora do device vai ler seja configurável, podendo ser 24 ou 32 bits.

Campo Tipo Descrição
byte_order string O byte_order possui dois possíveis valores "W_26" (MIFARE c/ 24 bits de informação) usado para manter compatibilidade com plantas antigas e "LSB" (Least Significant Byte) onde lê 32 bits de dados e inverte a ordem dos bytes, qualquer configuração diferente de "W_26" irá operar no modo "LSB".
read_sector string Indica qual setor do cartão MIFARE será automaticamente lido quando aproximado do leitor. Quando vazio, nenhum setor será lido. O padrão é vazio.
read_block string Indica qual bloco do cartão MIFARE será automaticamente lido quando aproximado do leitor. Quando vazio, nenhum bloco será lido. O padrão é vazio.
authentication_type string Tipo de chave que será usado para autenticação do bloco indicado por read_block. Pode ser "A" ou "B". Valor padrão: "A".
authentication_key string Valor em base64 de chave usada para autenticar o bloco indicado por read_block. Valor padrão: "////////" (ou "ffffffffffff" em hexadecimal).

RFID

A configuração do módulo RFID permite que, para cartões ASK, a quantidade de bits que a leitora do device vai ler seja configurável, podendo ser 0 ou 8 bits para tamanho de código de area, e 16, 24, 32 ou 40 bits para o tamanho do código de usuário.

Campo Tipo Descrição
ask_site_code_size string Tamanho do código de área, possui dois possíveis valores "0" bits e "8" bits. O valor de "0" bits possibilita que o tamanho do código de usuário, indicado por ask_user_code_size, seja de "40" bits. Padrão é "0" bits.
ask_user_code_size string Tamanho do código de usuário, possui quatro possíveis valores "16" bits, "24" bits, "32" bits e "40" bits. O valor de "40" bits só é válido se o tamanho do código de área, indicado por ask_site_code_size, for "0" bits. Padrão é "16" bits.

HID

Configuração do módulo de leitura HID. Possibilita operação do leitor com diferentes formatos de cartões. Durante a operação, apenas um formato deve estar ativo ("1"), enquanto os demais permanecem desativados ("0").

Campo Tipo Descrição
format_w37 string Configura operação do leitor HID com formato W37. Valores: "0" ou "1".
w37_cardid_size string Define número de bits de identificação do formato W37, desconsiderando bits de paridade. Valores: "19", "25" ou "35".
format_w26 string Configura operação do leitor HID com formato W26. Valores: "0" ou "1".
format_mifare string Configura operação do leitor HID com formato Mifare. Valores: "0" ou "1".
format_indala_b1 string Configura operação do leitor HID com formato Indala-B1. Valores: "0" ou "1".
format_ask string Configura operação do leitor HID com formato ASK. Valores: "0" ou "1".
ignore_facility string Possibilita ignorar bits referentes ao facility code do cartão ASK. Se ativo "1", os bits são ignorados, se não "0", os bits são considerados. Valores: "0" ou "1".

card_readerN

Configuração da entrada wiegand, em que o N em card_readerN representa o número da wiegand in. Por exemplo, no iDAccess é sempre zero, ou seja, card_reader0, enquanto que na iDBlock tem-se as opções 0 para a wiegand principal e 1 para wiegand da urna, e na iDBox, 4 opções (de 0 a 3), correspondendo à quantidade de leitoras wiegand.

Campo Tipo Descrição
mode string A configuração mode pode ter dois valores, "WIN" para wiegand e "MAG" para cartão magnético (ABA Track II, disponível nos modelos iDBlock H2, iDFit H2 e iDAccess H2). É importante sempre reiniciar o equipamento após a mudança de mode.
type int A configuração type pode ter dois estados, LSB (Least Significant Byte). Quando a leitura for wiegand 34, é invertida a ordem dos bytes; para qualquer outro valor ("") a inversão não será realizada.

alarm

Parâmetros de configuração de alarme do equipamento.

Campo Tipo Descrição
door_sensor_enabled string Habilita ou desabilita o sensor de porta. Os valores possíveis são "0" ou "1" para desabilitar e habilitar respectivamente.
door_sensor_delay string Define o tempo em segundos em que a porta deverá permanecer aberta antes que o alarme de porta aberta seja gerado. O valore padrão é "5".
forced_access_enabled string Habilita ou desabilita a detecção de arrombamento de porta. Os valores possíveis são "0" ou "1" para desabilitar e habilitar respectivamente.
siren_enabled string Habilita ou desabilita a sirene (aplicável apenas para o iDAccess e iDFit). Para que a sirene seja acionada por um relê é necessário especificar o número através do parâmetro siren_relay. Os valores possíveis são "0" ou "1" para desabilitar e habilitar respectivamente.
siren_relay string Relê no qual a sirene está conectada, o padrão é "2" (aplicável apenas para o iDAccess e iDFit).
timed_alarm_timeout int Indica o tempo em segundos que o dispositivo deixará a sirene acionada.

identifier

Configurações do identificador.

Campo Tipo Descrição
card_identification_enabled int Disponível para dispositivos iDFace a partir da versão 6.5.1. Determina se a identificação por cartão está habilitada. Valores: "0" para desativada ou "1" para ativada.
face_identification_enabled int Disponível para dispositivos iDFace a partir da versão 6.5.1. Determina se a identificação facial está habilitada. Valores: "0" para desativada ou "1" para ativada.
qrcode_identification_enabled int Disponível para dispositivos iDFace a partir da versão 6.5.1. Determina se a identificação por QR Code está habilitada. Valores: "0" para desativada ou "1" para ativada.
pin_identification_enabled int No momento só está disponível para o iDFace a partir da versão 6.9.0. Em breve estará disponível para os equipamentos da linha V5. Determina se a identificação habilitada é o modo de ID + Senha ou o modo PIN. Valores: "0" para ativar apenas o modo de ID + Senha e "1" para habilitar apenas o modo PIN.
log_type bool Esta configuração só é válida para o iDFlex ponto. (Apesar dela existir para os outros dispositivos) e determina se as batidas customizadas estão habilitadas. (Tipos de batidas)
multi_factor_authentication int

Esta configuração determina se a autenticação múltipla deve ser utilizada.

Para a linha de acesso V5:

0 = Desabilitado
1 = Cartão + Biometria

Para dispositivos iDFace:

0 = Desabilitado
1 = identificação qualquer: {Cartão, Senha, QR Code ou PIN} + Face.

verbose_logging string Se ativado, registra todos os tipos de acesso, inclusive não identificados. Utiliza mais memória. Se desativado, registra apenas acessos autorizados e não-autorizados. Valores: "0" ou "1".
antipassback_enabled string Habilita ou desabilita a configuração de anti-passback, que bloqueia o acesso de uma mesma pessoa. Valores: "0" ou "1".
antipassback_mode string Modo de operação do anti-passback, por padrão possui o valor "timed". Valores: "daily_catra" para acesso diário de catraca, "timed_catra" para bloqueio por tempo para catracas e "timed" para bloqueio por tempo em outros dispositivos.
antipassback_timeout int Tempo de bloqueio do anti passback quando os modos "timed" ou "timed_catra" estão em uso. Valor especificado em minutos.

bio_id

Configurações da biometria do equipamento.

Campo Tipo Descrição
similarity_threshold_1ton string Quanto maior o numero setado, mais rigorosa será a identificação. Aumentar este número irá diminuir a taxa de falsas aceitações e aumentar a taxa de falsas rejeições, diminuí-la terá o efeito inverso. Valor padrão: "12300".

online_client

Configurações do client (equipamento) quando em modo enterprise.

Campo Tipo Descrição
server_id int 64 Id do servidor de acesso na tabela devices, que indica para quem será enviado os eventos de identificação.
extract_template string Configura se, em caso de identificação por biometria, o equipamento irá extrair o template da digital e enviá-lo ou se irá enviar a imagem da digital. Valores: "0" ou "1".
contingency_enabled int Indica se o terminal deve ou não entrar em contingência quando houver falha na comunicação com o servidor de acesso. Valores: 0 ou 1. Valor 0 indica modo de contingência desativado, o valor 1 indica modo de contingência ativado.
max_request_attempts int Quantidade de tentativas que o equipamento faz para se comunicar com o servidor antes de entrar no modo de contingência.
request_timeout int Indica o tempo de timeout em milissegundo que o dispositivo irá aguardar pela resposta das requisições. O tempo máximo permitido é de 5000 ms.
alive_interval int Indica o intervalo de tempo em milissegundo em que dispositivo irá tentar voltar para o modo online quando em contingência (device_is_alive).

monitor

Parâmetros de configuração do Monitor.

Campo Tipo Descrição
request_timeout int O tempo em ms para o request dar timeout.
hostname string O endereço para onde a request será enviado, por exemplo, o IP do servidor.
port string A porta para onde a request será enviado.
path string Este parâmetro define o caminho que compõe o endpoint onde os eventos do monitor são notificados. A valor padrão deste parâmetro é "api/notifications".
inform_access_event_id int Determina se o id da entrada na tabela access_events deve ser reportado nos endpoints catra_event, door e secbox

push_server

Parâmetros de configuração do Push.

Campo Tipo Descrição
push_request_timeout int Timeout das requisições do equipamento para o servidor em milissegundos.
push_request_period int Período entre as requisições de push em segundos.
push_remote_address string Endereço ip e porta em que o servidor está rodando separados por ':'. Exemplo: 192.168.120.94:80

uhf

Parâmetros de configuração específicas da antena iDUHF.

Campo Tipo Descrição
identification_bits int Indica quantos bits serão usados na identificação da tag. Valores possíveis: 26, 32, 34 ou 66. Padrão: 26
reader_type string Define a ordem dos bytes, podendo ter os seguintes valores: "lsb" ou "default"
read_interval int Define o intervalo mínimo, em milissegundos, para que duas leituras consecutivas de cartões DIFERENTES sejam consideradas leituras distintas, evitando leitura duplicada acidental. Valor mínimo: 250. Valor máximo: 30000.
read_interval_diff_tags int Define o intervalo mínimo, em milissegundos, para que duas leituras consecutivas DO MESMO CARTÃO sejam consideradas leituras distintas, evitando leitura duplicada acidental. Valor mínimo: 100. Valor máximo: 30000.
transmit_power int Define a potência de transmissão da antena. Valor mínimo: 1500. Valor máximo: 2400.
work_channel string Define os canais de operação da antena que serão usados. Exemplo: permitir canais 1, 2, 3, 4, 5, 7, 8, 9 e 10: "1-5;7-10"
operation_mode string Define o modo de operação, "continuous" para modo contínuo, "trigger" para modo trigger e "inhibit" para modo inibição. No modo contínuo, o dispositivo realizará a leitura de tags independentemente do estado do pino de trigger. No modo trigger, o dispositivo realizará a leitura durante o período de timeout sempre que houver uma borda de descida (pulso) no pino de trigger. Já no modo inibição, o dispositivo não realizará a leitura enquanto o pino de trigger estiver ativado. Quando o pino for desativado, após o período de timeout, o dispositivo voltará a realizar a leitura das tags.
trigger_timeout int Define o timeout do trigger, em milissegundos. Usado somente quando operation_mode for configurado para modo trigger. Valor mínimo: 250. Valor máximo: 60000.
trig_idle int Indica qual o nível lógico do trigger quando ele estiver ocioso. Valores: "0" ou "1"
tag_detector_enabled int Indica o modo de funcionamento do relé interno da iDUHF. Caso seja "0", o dispositivo assume o comportamento padrão em relação à abertura do relé interno. Caso seja "1", sempre que uma tag estiver visível, o relé estará ativo. Logo, enquanto uma ou mais tags estiverem na frente da antena, o relé ficará ativo. Se estiver habilitada, o relé interno da iDUHF fica reservado a essa funcionalidade.

sec_boxs

A maioria das configurações do módulo de acionamento externo (MAE/Security Box) usado no iDFlex, iDAccess Pro, iDAccess Nano e iDFace, por estarem armazenadas em banco de dados, necessitam ser alteradas através do objeto sec_boxs, e manipuladas através das funções de manipulação de objetos. As demais configurações, internas ao módulo, encontram-se descritas a seguir.

Campo Tipo Descrição
mode string Indica a posição do bit mais significativo do protocolo Wiegand. Assume o valor ("LSB") se o bit mais significativo está à direita e ("") caso esteja à esquerda (MSB, Padrão).
wiegand_out_size string Define o número de bits de saída do protocolo Wiegand. Valores: "26", "32", "34", "35", "37", "40", "42", "66".
out_mode string Define o tipo de dado de saída via protocolo Wiegand, ("") para transmissão de ID (Padrão), "CARD" para transmissão de cartões autorizados e "RELAY_CARD" para transmissão de qualquer cartão.

w_out0

Parâmetros de configuração referentes a saída wiegand dos equipamentos sem módulo de acionamento externo (MAE/Security Box). Através desse módulo, é possível realizar a configuração do modo de saída e tamanho do seu protocolo.

Campo Tipo Descrição
size string Define o número de bits de saída do protocolo Wiegand. Valores: "26", "32", "34", "35", "37", "40", "42", "66".
data string Define o tipo de dado de saída via protocolo Wiegand, ("") para transmissão de ID (Padrão), "CARD" para transmissão de cartões autorizados e "RELAY_CARD" para transmissão de qualquer cartão.

gpio

Parâmetros de configuração referentes aos GPIOs dos equipamentos. Através desse módulo, é possível realizar a configuração dos relés das catracas da Control iD.

Campo Tipo Descrição
catra_relay_1_enabled int Indica se o relé 1 da catraca está habilitado. Valores: "0" para desabilitado e "1" para habilitado.
catra_relay_1_enable_direction string Indica a direção da liberação de rotação do braço da catraca que causará a ativação do relé 1, caso o parâmetro catra_relay_1_enabled esteja habilitado. Valores: "left" para rotação em sentido anti-horário e "right" para rotação em sentido horário.
catra_relay_2_enabled int Indica se o relé 2 da catraca está habilitado. Valores: "0" para desabilitado e "1" para habilitado.
catra_relay_2_enable_direction string Indica a direção da liberação de rotação do braço da catraca que causará a ativação do relé 2, caso o parâmetro catra_relay_2_enabled esteja habilitado. Valores: "left" para rotação em sentido anti-horário e "right" para rotação em sentido horário.

onvif

Parâmetros de configuração referentes a Streaming iDFace. Através desse módulo, é possível realizar a configuração dos modos de operação, resolução desejada e orientação da imagem que será mostrada.

Campo Tipo Descrição
rtsp_enabled int Indica se streaming RTSP está habilitado. Valores: "0" para desabilitado e "1" para habilitado.
rtsp_rgb int Altera a câmera que está sendo utilizada para o streaming. Valores: "0" para IR e "1" para RGB.
rtsp_username string Altera a credencial de usuário para que a transmissão só seja habilitada a partir do preenchimento do usuário e senhas corretos
rtsp_password string Altera a credencial de senha para que a transmissão só seja habilitada a partir do preenchimento do usuário e senhas corretos
rtsp_port int Altera a porta utilizada para a transmissão.
rtsp_codec string Altera o codec de vídeo utilizado na transmissão. Valores: "mjpeg" para codec MJPEG e "h264" para codec H.264
rtsp_flipped int Habilita o espelhamento do vídeo. Valores: "0" para desabilitado e "1" para habilitado.
onvif_enabled int Habilita a transmissão seguindo padrão ONVIF. Valores: "0" para desabilitado e "1" para habilitado.
onvif_port int Altera a porta utilizada para a transmissão seguindo o padrão ONVIF.