MLI/API/CmdGetConfig

De uTech Tecnologia
(Diferença entre revisões)
Ir para: navegação, pesquisa
(→‎Comando)
Linha 86: Linha 86:
 
** '''6''': Sábado
 
** '''6''': Sábado
 
|-
 
|-
−
| align="left"| passowrd || Senha do ramal/extensão do leitor.
+
| align="left"| server || Endereço IP do servidor de integração, PABX ou porteiro uTech.
 
|-
 
|-
−
| align="left"| hotline || Numero discado nao pressionar o botão '''Portaria'''.
+
| align="left"| server_port || Porta do servidor de integração, PABX uTech (Padrão do PABX uTech - 8090) ou porteiro uTech (Configurado em [[MPI/ConfiguracaoWEB#Configura.C3.A7.C3.A3o_do_Servidor|Configuração do servidor de integração no MPI]]).
 
|-
 
|-
−
| align="left"| volmicrofone || Volume do microfone (min:0 - max:20)
+
| align="left"| server_user || Usuário de acesso à API de integração do Leitor.
 
|-
 
|-
−
| align="left"| volspeaker || Volume do alto falante (min:0 - max:20)
+
| align="left"| server_user || Senha de acesso à API de integração do Leitor.
 
|-
 
|-
−
| align="left"| keyboard || Define se está habilitado ou não o teclado do leitor.
+
| align="left"| ota_url || URL para atualização de firmware.
−
* '''on''': Teclado habilitado.
+
−
* '''off:''' Teclado desabilitado.
+
 
|-
 
|-
−
| align="left"| release || Informação da versão de firmware do equipamento.
+
| align="left"| rfid || Indica se o leitor RFID/NFC está habilitado. ('''On'''/'''Off''').
 
|-
 
|-
−
| align="left"| doublepass_timeout || Tempo, em segundos, para dupla passagem (0 - Desabilitado)
+
| align="left"| rfid_timeout || Timeout de leitura RFID/NFC.
 
|-
 
|-
−
| align="left"| http_server  || '''Cliente''' - Endereço do Servidor de Integração.
+
| align="left"| rfid_nfc || Indica se NFC móvel está habilitado.  ('''On'''/'''Off''').
 
|-
 
|-
−
| align="left"| http_port    || '''Cliente''' - Porta do Servidor de Integração.
+
| align="left"| qrcode || Indica se o leitor '''QR Code''' está habilitado. ('''On'''/'''Off''').
 
|-
 
|-
−
| align="left"| http_username || '''Cliente''' - Usuário do Servidor de Integração.
+
| align="left"| qrcode_timeout || Timeout de dos '''QR Codes'''.
 
|-
 
|-
−
| align="left"| http_password || '''Cliente''' - Senha do Servidor de Integração.
+
| align="left"| control_mode || Tipo de acionamento do rele. 0 - Continuo / 1 - Manual.
 
|-
 
|-
−
| align="left"| http_url      || '''Cliente''' - URL do Servidor de Integração.
+
| align="left"| control_timeout || Tempo de acionamento do rele
 
|-
 
|-
−
| align="left"| http_timeout  || '''Cliente''' - Timeout da Requisição em segundos.
+
| align="left"| control_external || Indica se o acionamento de relé externo está acionado. '''true''' ou '''false'''.
 
|-
 
|-
−
| align="left"| http_retries  || '''Cliente''' - Número de Tentativas da Requisição.
+
| align="left"| control_url || URL para acionamento externo. Ex: '''http://utech:1234@10.0.0.1:8080/request=relay&interface=1&state=on'''
 
|-
 
|-
−
| align="left"| httpd_username  || '''Servidor''' - Usuário de acesso das aplicações a API do Leitor IP MLI.
+
| align="left"| rs488 || Indica se a interface RS-485 está ativa (''''on''' / '''off''').
 
|-
 
|-
−
| align="left"| httpd_password  || '''Servidor''' - Senha de acesso das aplicações a API do Leitor IP MLI.
+
| align="left"| rs485_address || Endereço da interface RS-485. 1 a 15.
 
|-
 
|-
−
| align="left"| httpd_port  || '''Servidor''' - Porta que o Leitor IP receberá conexões das aplicações.
+
| align="left"| rf433 || Indica se a interface RS-485 está ativa (''''on''' / '''off''').
 
|-
 
|-
−
| align="left"| httpd_timeout  || '''Servidor''' - Timeout para conexão TCP.
+
| align="left"| fingerprint || Indica se o leitor biométrico está ativo (''''on''' / '''off''').
 
|-
 
|-
−
| align="left"| httpd_auth  || '''Servidor''' - Se habilitado, o Leitor IP MLI aceitará conexões de todos os usuários configurados (com conta e senha).
+
| align="left"| fingerprint_timeout || Timeout de leitura do sensor biométrico.
 
|-
 
|-
−
| align="left"|interface1_control_enable    || Habilitar/Desabilitar Acionamento (Relê) da Interface 1.
+
| align="left"| fingerprint_security || Nível de segurança do leitor biométrico ('''1''' a '''5''').
−
* '''true''': Habilita.
+
−
* '''false''': Desabilita.
+
 
|-
 
|-
−
| align="left"|interface1_control_type      || Tipo de Acionamento da Interface 1:
+
| align="left"| latitude || Localização do leitor / latitude.
−
* '''0''': Contínuo.
+
−
* '''1''': Pulsado.
+
−
* '''2''': Manual.
+
 
|-
 
|-
−
| align="left"|interface1_control_time      || Tempo de acionamento da interface 1 (segundos)
+
| align="left"| longitude || Localização do leitor / longitude.
 
|-
 
|-
−
| align="left"|interface1_control_acc_time  || Tempo de acionamento da interface 1 para acessibilidade (segundos).
+
| align="left"| user_auth || Indica se os usuários do leitor tem permissão para acessar a API ('''on''' / '''off''').
 
|-
 
|-
−
| align="left"|interface1_interlocking      || Habilitar/Desabilitar intertravamento na interface 1.
+
| align="left"| qrcode_config || Indica se o leitor está habilitado para ser configurado via QR Code ('''on''' / '''off''').
−
* '''true''': Habilita.
+
−
* '''false''': Desabilita.
+
 
|-
 
|-
−
| align="left"|interface1_sensor_enable    || Habilitar/Desabilitar sensor da interface 1.
+
| align="left"| debug || Endereço IP/servidor e porta destino para envio do log/debug do leitor.
−
* '''true''': Habilita.
+
−
* '''false''': Desabilita.
+
 
|-
 
|-
−
| align="left"|interface1_sensor_panic      || Habilitar/Desabilitar função pâncio no sensor da interface 1.
+
| align="left"| control_acc_timeout || Tempo de acionamento do rele para '''acessibilidade''' Em milissegundos.
−
* '''true''': Habilita.
+
−
* '''false''': Desabilita.
+
 
|-
 
|-
−
| align="left"|interface1_sensor_alarm      || Tempo, em segundos, para alarme no sensor de porta aberta da interface 1 (0 - Desabilitado).
+
| align="left"| rfid_panic_timeout || Timeout para Pânico no Leitor NFC. Em milissegundos.
−
* '''true''': Habilita.
+
−
* '''false''': Desabilita.
+
 
|-
 
|-
−
| align="left"|interface1_sensor_breakin    || Habilitar/Desabilitar alarme de arrombamento na Interface 1.
+
| align="left"| qrcode_panic_timeout || Timeout para Pânico no Leitor QR Code. Em milissegundos.
−
* '''true''': Habilita.
+
−
* '''false''': Desabilita.
+
 
|-
 
|-
−
| align="left"|interface1_button_enable    || Habilitar/Desabilitar botoeira na interface 1.
+
| align="left"| channel || Canal utilizado na rede WIFI ('''1''' a ''''13'''').
−
* '''true''': Habilita.
+
−
* '''false''': Desabilita.
+
 
|-
 
|-
−
| align="left"|interface1_button_panic      || Habilitar/Desabilitar função pânico na botoeira na interface 1.
+
| align="left"| beacon_interval || Intervalo de tempo para envio dos '''beacon frames''. Em milissegundos.
−
* '''true''': Habilita.
+
−
* '''false''': Desabilita.
+
 
|-
 
|-
−
| align="left"|interface1_button_relay      || Habilitar/Desabilitar acionamento da botoeira na interface 1.
+
| align="left"| fingerprint_identify || Quantidade de vezes que o sensor biométrico tentará verificar a identidade na leitura ('''1''' a '''5''').
−
* '''true''': Habilita.
+
−
* '''false''': Desabilita.
+
−
|-
+
−
| align="left"|interface1_button_interface || Interface de acionamento da botoeira na interface 1.
+
−
* '''0''': Ambas
+
−
* '''1''': Interface 1
+
−
* '''2''': Interface 2
+
−
|-
+
−
| align="left"|interface2_control_enable    || Habilitar/Desabilitar Acionamento (Relê) da Interface 1.
+
−
* '''true''': Habilita.
+
−
* '''false''': Desabilita.
+
−
|-
+
−
| align="left"|interface2_control_type      || Tipo de Acionamento da Interface 1:
+
−
* '''0''': Contínuo.
+
−
* '''1''': Pulsado.
+
−
* '''2''': Manual.
+
−
|-
+
−
| align="left"|interface2_control_time      || Tempo de acionamento da interface 1 (segundos)
+
−
|-
+
−
| align="left"|interface2_control_acc_time  || Tempo de acionamento da interface 1 para acessibilidade (segundos).
+
−
|-
+
−
| align="left"|interface2_interlocking      || Habilitar/Desabilitar intertravamento na interface 1.
+
−
* '''true''': Habilita.
+
−
* '''false''': Desabilita.
+
−
|-
+
−
| align="left"|interface2_sensor_enable    || Habilitar/Desabilitar sensor da interface 1.
+
−
* '''true''': Habilita.
+
−
* '''false''': Desabilita.
+
−
|-
+
−
| align="left"|interface2_sensor_panic      || Habilitar/Desabilitar função pâncio no sensor da interface 1.
+
−
* '''true''': Habilita.
+
−
* '''false''': Desabilita.
+
−
|-
+
−
| align="left"|interface2_sensor_alarm      || Tempo, em segundos, para alarme no sensor de porta aberta da interface 1 (0 - Desabilitado).
+
−
* '''true''': Habilita.
+
−
* '''false''': Desabilita.
+
−
|-
+
−
| align="left"|interface2_sensor_breakin    || Habilitar/Desabilitar alarme de arrombamento na Interface 1.
+
−
* '''true''': Habilita.
+
−
* '''false''': Desabilita.
+
−
|-
+
−
| align="left"|interface2_button_enable    || Habilitar/Desabilitar botoeira na interface 1.
+
−
* '''true''': Habilita.
+
−
* '''false''': Desabilita.
+
−
|-
+
−
| align="left"|interface2_button_panic      || Habilitar/Desabilitar função pânico na botoeira na interface 1.
+
−
* '''true''': Habilita.
+
−
* '''false''': Desabilita.
+
−
|-
+
−
| align="left"|interface2_button_relay      || Habilitar/Desabilitar acionamento da botoeira na interface 1.
+
−
* '''true''': Habilita.
+
−
* '''false''': Desabilita.
+
−
|-
+
−
| align="left"|interface2_button_interface  || Interface de acionamento da botoeira na interface 1.
+
−
* '''0''': Ambas
+
−
* '''1''': Interface 1
+
−
* '''2''': Interface 2
+
 
|}
 
|}
  
Linha 249: Linha 171:
  
 
{
 
{
−
"serial":"0000003048",
+
    "serial":"0000001234",
−
"mac":"F8:E7:B5:00:0B:EE",
+
    "mac":"f8:e7:b5:01:02:03",
−
"release":"1.1.12",
+
    "hotspot":"off",
−
"dhcp":"off",
+
    "ap_mode":"off",
−
"ip":"10.0.0.1",
+
    "standalone":"on",
−
"netmask":"255.255.255.0",
+
    "ssid":"uTech",
−
"gateway":"10.0.0.2",
+
    "password":"1234",
−
"dns":"1.1.1.1",
+
    "ssid_hidden":"off",
−
"ntp":"2.3.4.5",
+
    "dhcp":"on",
−
"server":"10.0.0.3",
+
    "ip":"10.0.0.1",
−
"port":"5060",
+
    "netmask":"255.255.255.0",
−
"stun":"",
+
    "gateway":"10.0.0.2",
−
"exten":"1000",
+
    "dns":"10.0.0.1",
−
"password":"1234",
+
    "ntp":"pool.ntp.br",
−
"hotline":"94",
+
    "hostname":"ulip",
−
"volmicrophone":"18",
+
    "timezone":"-3",
−
"volspeaker":"20",
+
    "dst":"off",
−
"keyboard":"true",
+
    "dst_date":"10/3/0 2/3/0",
−
"http_server":"10.0.0.100",
+
    "server":"10.0.0.3",
−
"http_port":"7777",
+
    "server_port":"8090",
−
"http_username":"admin",
+
    "server_user":"utech",
−
"http_password":"1234",
+
    "server_password":"1234",
−
"http_url":"",
+
    "server_url":"",
−
"http_timeout":"30",
+
    "ota_url":"http://utech.com.br/firmware/ulip-1.1.2/MLI-1WQB/",
−
"http_retries":"1",
+
    "rfid":"on",
−
"interface1_control_enable":"false",
+
    "rfid_timeout":"1000",
−
"interface1_control_type":"1",
+
    "rfid_nfc":"on",
−
"interface1_control_time":"5",
+
    "qrcode":"on",
−
"interface1_control_acc_time":"20",
+
    "qrcode_timeout":"1000",
−
"interface1_interlocking":"false",
+
    "control_mode":"0",
−
"interface1_sensor_enable":"true",
+
    "control_timeout":"3000",
−
"interface1_sensor_panic":"false",
+
    "control_external":"false",
−
"interface1_sensor_alarm":"0",
+
    "control_url":"http://utech:1234@10.0.0.9:8080/?request=relay&interface=1&state=on",
−
"interface1_sensor_breakin":"false",
+
    "rs485":"off",
−
"interface1_button_enable":"false",
+
    "rs485_address":"0",
−
"interface1_button_panic":"true",
+
    "rf433":"off",
−
"interface1_button_relay":"false",
+
    "fingerprint":"on",
−
"interface1_button_interface":"0",
+
    "fingerprint_timeout":"1000",
−
"interface2_control_enable":"true",
+
    "fingerprint_security":"3",
−
"interface2_control_type":"1",
+
    "latitude":"",
−
"interface2_control_time":"5",
+
    "longitude":"",
−
"interface2_control_acc_time":"20",
+
    "user_auth":"on",
−
"interface2_interlocking":"false",
+
    "qrcode_config":"on",
−
"interface2_sensor_enable":"true",
+
    "debug":"2:7:10.0.0.5:999",
−
"interface2_sensor_panic":"false",
+
    "control_acc_timeout":"30000",
−
"interface2_sensor_alarm":"0",
+
    "rfid_panic_timeout":"0",
−
"interface2_sensor_breakin":"false",
+
    "qrcode_panic_timeout":"0",
−
"interface2_button_enable":"false",
+
    "channel":"1",
−
"interface2_button_panic":"false",
+
    "beacon_interval":"100",
−
"interface2_button_relay":"true",
+
    "fingerprint_identify":"2"
−
"interface2_button_interface":"2"
+
 
−
}
+
 
</source>
 
</source>
 
|}
 
|}

Edição de 21h05min de 28 de setembro de 2018

Tabela de conteúdo


O comando Buscar Configuração é utilizado solicitar as configurações básicas do leitor.

Comando


MÉTODO: GET

Parâmetros enviados para o Leitor
request getconfig
Resposta enviada pelo o Leitor
serial Numero de série do equipamento.
mac Endereço MAC do leitor.
hotspot Indica se o modo hotspot está ativo.
  • on: Habilitado
  • off: Desabilitado
ap_mode Indica se o modo Access Point esta habilitado.
  • on: Habilitado
  • off: Desabilitado
standalone Indica se o modo standalone esta habilitado.
  • on: Habilitado
  • off: Desabilitado
ssid Informa o SSID/rede configurado no Access Point.
password Senha de acesso a rede WIFI.
ssid_hidden Identifica se está configurado para esconder ou não SSID da rede WIFI.
  • on: Habilitado
  • off: Desabilitado
dhcp Identifica se o cliente dhcp está habilitado.
  • on: Habilitado
  • off: Desabilitado
ip Endereço IP do leitor.
netmask Endereço da mascara de rede do leitor.
gateway Endereço da rota padrão do leitor.
dns Endereço do servidor DNS primário do leitor.
ntp Endereço do servidor NTP do leitor.
hostname Hostname do leitor.
timezone Timezone configurado no leitor.
dst Indica se o horário de verão está habilitado.
  • on: Habilitado
  • off: Desabilitado
dst_date Data de inicio e final do horário de verão. Ex: 10/3/0 2/3/0. O formato é definido por duas sequencias, onde a primeira é a data inicial e a segunda é a data final do horário de verão. => X/Y/Z T/V/W, onde:
  • X: Mês inicial do horário de verão. Utilizar a faixa de 1 a 12, onde 1 é janeiro e 12 é dezembro.
  • Y: Semana do mês de inicio do horário de verão. Utilizar valores de 1 a 6, onde a primeira semana é representada por 1.
  • Z: Dia da semana de inicio do horário de verão. Utilizar valores de 0 a 6, onde:
    • 0: Domingo
    • 1: Segunda-feira
    • 2: Terça-feira
    • 3: Quarta-feira
    • 4: Quinta-feira
    • 5: Sexta-feira
    • 6: Sábado
  • T: Mês final do horário de verão. Utilizar a faixa de 1 a 12, onde 1 é janeiro e 12 é dezembro.
  • V: Semana do mês de inicio do horário de verão. Utilizar valores de 1 a 6, onde a primeira semana é representada por 1.
  • W: Dia da semana final do horário de verão. Utilizar valores de 0 a 6, onde:
    • 0: Domingo
    • 1: Segunda-feira
    • 2: Terça-feira
    • 3: Quarta-feira
    • 4: Quinta-feira
    • 5: Sexta-feira
    • 6: Sábado
server Endereço IP do servidor de integração, PABX ou porteiro uTech.
server_port Porta do servidor de integração, PABX uTech (Padrão do PABX uTech - 8090) ou porteiro uTech (Configurado em Configuração do servidor de integração no MPI).
server_user Usuário de acesso à API de integração do Leitor.
server_user Senha de acesso à API de integração do Leitor.
ota_url URL para atualização de firmware.
rfid Indica se o leitor RFID/NFC está habilitado. (On/Off).
rfid_timeout Timeout de leitura RFID/NFC.
rfid_nfc Indica se NFC móvel está habilitado. (On/Off).
qrcode Indica se o leitor QR Code está habilitado. (On/Off).
qrcode_timeout Timeout de dos QR Codes.
control_mode Tipo de acionamento do rele. 0 - Continuo / 1 - Manual.
control_timeout Tempo de acionamento do rele
control_external Indica se o acionamento de relé externo está acionado. true ou false.
control_url URL para acionamento externo. Ex: http://utech:1234@10.0.0.1:8080/request=relay&interface=1&state=on
rs488 Indica se a interface RS-485 está ativa ('on / off).
rs485_address Endereço da interface RS-485. 1 a 15.
rf433 Indica se a interface RS-485 está ativa ('on / off).
fingerprint Indica se o leitor biométrico está ativo ('on / off).
fingerprint_timeout Timeout de leitura do sensor biométrico.
fingerprint_security Nível de segurança do leitor biométrico (1 a 5).
latitude Localização do leitor / latitude.
longitude Localização do leitor / longitude.
user_auth Indica se os usuários do leitor tem permissão para acessar a API (on / off).
qrcode_config Indica se o leitor está habilitado para ser configurado via QR Code (on / off).
debug Endereço IP/servidor e porta destino para envio do log/debug do leitor.
control_acc_timeout Tempo de acionamento do rele para acessibilidade Em milissegundos.
rfid_panic_timeout Timeout para Pânico no Leitor NFC. Em milissegundos.
qrcode_panic_timeout Timeout para Pânico no Leitor QR Code. Em milissegundos.
channel Canal utilizado na rede WIFI (1 a '13').
beacon_interval Intervalo de tempo para envio dos 'beacon frames. Em milissegundos.
fingerprint_identify Quantidade de vezes que o sensor biométrico tentará verificar a identidade na leitura (1 a 5).

Exemplo 

http://ip:porta/?request=getconfig

Resposta:

  • 400 => Parâmetros incorretos
  • 401 => Erro de autenticação da API
  • 200 => OK 
 
User-Agent: uTech/0000002874
Connection: close
Date: Wed, 13 Jun 2018 17:22:35
Host: 10.0.0.200
Content-Type: application/json
 
{
    "serial":"0000001234",
    "mac":"f8:e7:b5:01:02:03",
    "hotspot":"off",
    "ap_mode":"off",
    "standalone":"on",
    "ssid":"uTech",
    "password":"1234",
    "ssid_hidden":"off",
    "dhcp":"on",
    "ip":"10.0.0.1",
    "netmask":"255.255.255.0",
    "gateway":"10.0.0.2",
    "dns":"10.0.0.1",
    "ntp":"pool.ntp.br",
    "hostname":"ulip",
    "timezone":"-3",
    "dst":"off",
    "dst_date":"10/3/0 2/3/0",
    "server":"10.0.0.3",
    "server_port":"8090",
    "server_user":"utech",
    "server_password":"1234",
    "server_url":"",
    "ota_url":"http://utech.com.br/firmware/ulip-1.1.2/MLI-1WQB/",
    "rfid":"on",
    "rfid_timeout":"1000",
    "rfid_nfc":"on",
    "qrcode":"on",
    "qrcode_timeout":"1000",
    "control_mode":"0",
    "control_timeout":"3000",
    "control_external":"false",
    "control_url":"http://utech:1234@10.0.0.9:8080/?request=relay&interface=1&state=on",
    "rs485":"off",
    "rs485_address":"0",
    "rf433":"off",
    "fingerprint":"on",
    "fingerprint_timeout":"1000",
    "fingerprint_security":"3",
    "latitude":"",
    "longitude":"",
    "user_auth":"on",
    "qrcode_config":"on",
    "debug":"2:7:10.0.0.5:999",
    "control_acc_timeout":"30000",
    "rfid_panic_timeout":"0",
    "qrcode_panic_timeout":"0",
    "channel":"1",
    "beacon_interval":"100",
    "fingerprint_identify":"2"



PHP 

<?php
 
$user = "utech";
$pass = "1234";
$port = "8080";
$ipaddr = "10.0.0.1";
 
$url = "";
$url = "$ipaddr:$port?request=getconfig";
$ch = curl_init($url);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, 1);
curl_setopt($ch, CURLOPT_HTTPAUTH, CURLAUTH_BASIC);
curl_setopt($ch, CURLOPT_USERPWD, "$user:$pass");
$result = curl_exec($ch);
if(!$result) {
    echo "error!\n";
    return 2;
}
print_r(json_decode($result, true));
?>




Voltar

Obtida de "https://wiki.utech.com.br/wiki/index.php?title=MLI/API/CmdGetConfig&oldid=5505"
Ferramentas pessoais
Espaços nominais

Variantes
Visualizações
Ações
Navegação
Ferramentas