MLI/API/CmdSetConfig

De uTech Tecnologia
(Diferença entre revisões)
Ir para: navegação, pesquisa
(Criou página com ' __TOC__ O comando '''Configurar Leitor''' é utilizado alterar as configurações básicas do leitor. == Comando == <BR\> '''MÉTODO:''' <span style="color:red">'''POST'''...')
 
(→‎Exemplo)
 
(8 edições intermediárias de um usuário não apresentadas)
Linha 1: Linha 1:
 +
[[MLI/API#Comandos|'''Voltar''']]
 +
  
 
__TOC__
 
__TOC__
Linha 19: Linha 21:
 
{| class="wikitable" width="65%"
 
{| class="wikitable" width="65%"
 
! align="center" colspan="2" | Parâmetros enviados para o Leitor via JSON
 
! align="center" colspan="2" | Parâmetros enviados para o Leitor via JSON
−
|-
 
−
| align="left"| serial || Numero de série do equipamento.
 
−
|-
 
−
| align="left"| mac || Endereço MAC do leitor.
 
 
|-
 
|-
 
| align="left"| hotspot || Indica se o modo ''hotspot'' está ativo.
 
| align="left"| hotspot || Indica se o modo ''hotspot'' está ativo.
Linha 38: Linha 36:
 
| align="left"| ssid || Informa o '''SSID'''/rede configurado no '''Access Point'''.
 
| align="left"| ssid || Informa o '''SSID'''/rede configurado no '''Access Point'''.
 
|-
 
|-
−
| align="left"| password || Senha de acesso a rede WIFI.
+
| align="left"| password || Senha de acesso a rede WIFI. Tamanho máximo 64 caracteres. '''Minimo 8 caracteres'''.
 
|-
 
|-
 
| align="left"| ssid_hidden || Identifica se está configurado para esconder ou não '''SSID''' da rede WIFI.  
 
| align="left"| ssid_hidden || Identifica se está configurado para esconder ou não '''SSID''' da rede WIFI.  
Linha 48: Linha 46:
 
* '''off''': Desabilitado
 
* '''off''': Desabilitado
 
|-
 
|-
−
| align="left"| ip || Endereço IP do leitor.
+
| align="left"| ip || Endereço IP do leitor. Tamanho máximo 16 caracteres.
 
|-
 
|-
−
| align="left"| netmask || Endereço da mascara de rede do leitor.
+
| align="left"| netmask || Endereço da mascara de rede do leitor. Tamanho máximo 16 caracteres.
 
|-
 
|-
−
| align="left"| gateway || Endereço da rota padrão do leitor.
+
| align="left"| gateway || Endereço da rota padrão do leitor. Tamanho máximo 16 caracteres.
 
|-
 
|-
−
| align="left"| dns || Endereço do servidor DNS primário do leitor.
+
| align="left"| dns || Endereço do servidor DNS primário do leitor. Tamanho máximo 16 caracteres.
 
|-
 
|-
−
| align="left"| ntp || Endereço do servidor NTP do leitor.
+
| align="left"| ntp || Endereço do servidor NTP do leitor. Tamanho máximo 128 caracteres.
 
|-
 
|-
−
| align="left"| hostname || Hostname do leitor.
+
| align="left"| hostname || Hostname do leitor. Tamanho máximo 20 caracteres.
 
|-
 
|-
−
| align="left"| timezone || Timezone configurado no leitor.
+
| align="left"| timezone || Timezone configurado no leitor. Valor numérico: '''-23 a 23'''.
 
|-
 
|-
 
| align="left"| dst || Indica se o horário de verão está habilitado.
 
| align="left"| dst || Indica se o horário de verão está habilitado.
Linha 88: Linha 86:
 
** '''6''': Sábado
 
** '''6''': Sábado
 
|-
 
|-
−
| align="left"| server || Endereço IP do servidor de integração, PABX ou porteiro uTech.
+
| align="left"| web_password || Senha de acesso a interface WEB e API do Leitor.
 
|-
 
|-
−
| 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"| server || Endereço IP do servidor de integração, PABX ou porteiro uTech. Tamanho máximo 16 caracteres.
 
|-
 
|-
−
| align="left"| server_user || Usuário de acesso à API de integração do Leitor.
+
| 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]]). Valor inteiro de 1 a 65355.
 
|-
 
|-
−
| align="left"| server_user || Senha de acesso à API de integração do Leitor.
+
| align="left"| server_user || Usuário de acesso ao servidor de aplicação para a API enviar eventos. Tamanho máximo 20 caracteres.
 
|-
 
|-
−
| align="left"| ota_url || URL para atualização de firmware.
+
| align="left"| server_password || Senha de acesso ao servidor de aplicação para a API enviar eventos. Tamanho máximo 20 caracteres.
 +
|-
 +
| align="left"| server_url || URL de acesso ao servidor de aplicação para a API enviar eventos. Tamanho máximo 128 caracteres.
 +
|-
 +
| align="left"| ota_url || URL para atualização de firmware. Tamanho máximo 80 caracteres.
 
|-
 
|-
 
| align="left"| rfid || Indica se o leitor RFID/NFC está habilitado. ('''On'''/'''Off''').
 
| align="left"| rfid || Indica se o leitor RFID/NFC está habilitado. ('''On'''/'''Off''').
 
|-
 
|-
−
| align="left"| rfid_timeout || Timeout de leitura RFID/NFC.
+
| align="left"| rfid_timeout || Timeout de leitura RFID/NFC. Valor inteiro, de 0 a 4294967295 - em milissegundos.
 +
|-
 +
| align="left"| rfid_panic_timeout || Timeout de leitura RFID/NFC para Pânico. Valor inteiro, de 0 a 4294967295 - em milissegundos.
 
|-
 
|-
 
| align="left"| rfid_nfc || Indica se NFC móvel está habilitado.  ('''On'''/'''Off''').
 
| align="left"| rfid_nfc || Indica se NFC móvel está habilitado.  ('''On'''/'''Off''').
Linha 106: Linha 110:
 
| align="left"| qrcode || Indica se o leitor '''QR Code''' está habilitado. ('''On'''/'''Off''').
 
| align="left"| qrcode || Indica se o leitor '''QR Code''' está habilitado. ('''On'''/'''Off''').
 
|-
 
|-
−
| align="left"| qrcode_timeout || Timeout de dos '''QR Codes'''.
+
| align="left"| qrcode_timeout || Timeout de leitura dos '''QR Code's'''. Valor inteiro, de 0 a 4294967295 - em milissegundos.
 +
|-
 +
| align="left"| qrcode_panic_timeout || Timeout de leitura dos '''QR Code's''' para Pânico. Valor inteiro, de 0 a 4294967295 - em milissegundos.
 
|-
 
|-
 
| align="left"| control_mode || Tipo de acionamento do rele. 0 - Continuo / 1 - Manual.
 
| align="left"| control_mode || Tipo de acionamento do rele. 0 - Continuo / 1 - Manual.
 
|-
 
|-
−
| align="left"| control_timeout || Tempo de acionamento do rele
+
| align="left"| control_timeout || Tempo de acionamento do relé. Tempo inteiro, em segundos de 0 a 4294967295.
 
|-
 
|-
 
| align="left"| control_external || Indica se o acionamento de relé externo está acionado. '''true''' ou '''false'''.
 
| align="left"| control_external || Indica se o acionamento de relé externo está acionado. '''true''' ou '''false'''.
 
|-
 
|-
−
| 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"| control_url || URL para acionamento externo. Ex: '''http://utech:1234@10.0.0.1:8080/request=relay&interface=1&state=on'''. Tamanho máximo 256 caracteres.
 +
|-
 +
| align="left"| control_acc_timeout || Tempo de acionamento do rele para '''acessibilidade''' Valor inteiro, em milissegundos de 0 a 4294967295.
 
|-
 
|-
−
| align="left"| rs488 || Indica se a interface RS-485 está ativa (''''on''' / '''off''').
+
| align="left"| rs485 || Indica se a interface RS-485 está ativa (''''on''' / '''off''').
 
|-
 
|-
−
| align="left"| rs485_address || Endereço da interface RS-485. 1 a 15.
+
| align="left"| rs485_address || Endereço da interface RS-485. Valor inteiro de 1 a 15.
 
|-
 
|-
 
| align="left"| rf433 || Indica se a interface RS-485 está ativa (''''on''' / '''off''').
 
| align="left"| rf433 || Indica se a interface RS-485 está ativa (''''on''' / '''off''').
Linha 124: Linha 132:
 
| align="left"| fingerprint || Indica se o leitor biométrico está ativo (''''on''' / '''off''').
 
| align="left"| fingerprint || Indica se o leitor biométrico está ativo (''''on''' / '''off''').
 
|-
 
|-
−
| align="left"| fingerprint_timeout || Timeout de leitura do sensor biométrico.
+
| align="left"| fingerprint_timeout || Timeout de leitura do sensor biométrico. Valor inteiro de 0 a 4294967295, em milissegundos
 
|-
 
|-
−
| align="left"| fingerprint_security || Nível de segurança do leitor biométrico ('''1''' a '''5''').
+
| align="left"| fingerprint_security || Nível de segurança do leitor biométrico. Valor inteiro de '''1''' a '''5'''.
 
|-
 
|-
−
| align="left"| latitude || Localização do leitor / latitude.
+
| align="left"| fingerprint_retries || Número de tentativas de leitura da biometria antes de enviar erro.
 
|-
 
|-
−
| align="left"| longitude || Localização do leitor / longitude.
+
| align="left"| latitude || Localização do leitor / latitude. Tamanho máximo 16 caracteres.
 +
|-
 +
| align="left"| longitude || Localização do leitor / longitude. Tamanho máximo 16 caracteres.
 
|-
 
|-
 
| align="left"| user_auth || Indica se os usuários do leitor tem permissão para acessar a API ('''on''' / '''off''').
 
| align="left"| user_auth || Indica se os usuários do leitor tem permissão para acessar a API ('''on''' / '''off''').
Linha 136: Linha 146:
 
| align="left"| qrcode_config || Indica se o leitor está habilitado para ser configurado via QR Code ('''on''' / '''off''').
 
| align="left"| qrcode_config || Indica se o leitor está habilitado para ser configurado via QR Code ('''on''' / '''off''').
 
|-
 
|-
−
| align="left"| debug || Endereço IP/servidor e porta destino para envio do log/debug do leitor.
+
| align="left"| debug || Endereço IP/servidor e porta destino para envio do log/debug do leitor. Tamanho máximo 128 caracteres.
−
|-
+
−
| align="left"| control_acc_timeout || Tempo de acionamento do rele para '''acessibilidade''' Em milissegundos.
+
−
|-
+
−
| align="left"| rfid_panic_timeout || Timeout para Pânico no Leitor NFC. Em milissegundos.
+
−
|-
+
−
| align="left"| qrcode_panic_timeout || Timeout para Pânico no Leitor QR Code. Em milissegundos.
+
−
|-
+
−
| align="left"| channel || Canal utilizado na rede WIFI ('''1''' a ''''13'''').
+
−
|-
+
−
| align="left"| beacon_interval || Intervalo de tempo para envio dos '''beacon frames''. Em milissegundos.
+
−
|-
+
−
| align="left"| fingerprint_identify || Quantidade de vezes que o sensor biométrico tentará verificar  a identidade na leitura ('''1''' a '''5''').
+
 
|}
 
|}
−
 
  
 
== Exemplo ==
 
== Exemplo ==
Linha 206: Linha 203:
 
   "control_acc_timeout":"30000"
 
   "control_acc_timeout":"30000"
 
   "rfid_panic_timeout":"0"
 
   "rfid_panic_timeout":"0"
−
  "qrcode_panic_timeout":"0"
 
−
  "channel":"1"
 
−
  "beacon_interval":"100"
 
−
  "fingerprint_identify":"2"
 
 
}
 
}
 
</pre>
 
</pre>
Linha 225: Linha 218:
 
<br/>
 
<br/>
 
<br/>
 
<br/>
−
[[MPI/API#Comandos|'''Voltar''']]
+
[[MLI/API#Comandos|'''Voltar''']]
 
-----
 
-----

Edição atual tal como 18h20min de 3 de junho de 2020

Voltar


Tabela de conteúdo


O comando Configurar Leitor é utilizado alterar as configurações básicas do leitor.

[editar] Comando


MÉTODO: POST

Parâmetros enviados para o Leitor
request setconfig

POST-DATA:

Parâmetros enviados para o Leitor via JSON
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. Tamanho máximo 64 caracteres. Minimo 8 caracteres.
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. Tamanho máximo 16 caracteres.
netmask Endereço da mascara de rede do leitor. Tamanho máximo 16 caracteres.
gateway Endereço da rota padrão do leitor. Tamanho máximo 16 caracteres.
dns Endereço do servidor DNS primário do leitor. Tamanho máximo 16 caracteres.
ntp Endereço do servidor NTP do leitor. Tamanho máximo 128 caracteres.
hostname Hostname do leitor. Tamanho máximo 20 caracteres.
timezone Timezone configurado no leitor. Valor numérico: -23 a 23.
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
web_password Senha de acesso a interface WEB e API do Leitor.
server Endereço IP do servidor de integração, PABX ou porteiro uTech. Tamanho máximo 16 caracteres.
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). Valor inteiro de 1 a 65355.
server_user Usuário de acesso ao servidor de aplicação para a API enviar eventos. Tamanho máximo 20 caracteres.
server_password Senha de acesso ao servidor de aplicação para a API enviar eventos. Tamanho máximo 20 caracteres.
server_url URL de acesso ao servidor de aplicação para a API enviar eventos. Tamanho máximo 128 caracteres.
ota_url URL para atualização de firmware. Tamanho máximo 80 caracteres.
rfid Indica se o leitor RFID/NFC está habilitado. (On/Off).
rfid_timeout Timeout de leitura RFID/NFC. Valor inteiro, de 0 a 4294967295 - em milissegundos.
rfid_panic_timeout Timeout de leitura RFID/NFC para Pânico. Valor inteiro, de 0 a 4294967295 - em milissegundos.
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 leitura dos QR Code's. Valor inteiro, de 0 a 4294967295 - em milissegundos.
qrcode_panic_timeout Timeout de leitura dos QR Code's para Pânico. Valor inteiro, de 0 a 4294967295 - em milissegundos.
control_mode Tipo de acionamento do rele. 0 - Continuo / 1 - Manual.
control_timeout Tempo de acionamento do relé. Tempo inteiro, em segundos de 0 a 4294967295.
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. Tamanho máximo 256 caracteres.
control_acc_timeout Tempo de acionamento do rele para acessibilidade Valor inteiro, em milissegundos de 0 a 4294967295.
rs485 Indica se a interface RS-485 está ativa ('on / off).
rs485_address Endereço da interface RS-485. Valor inteiro de 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. Valor inteiro de 0 a 4294967295, em milissegundos
fingerprint_security Nível de segurança do leitor biométrico. Valor inteiro de 1 a 5.
fingerprint_retries Número de tentativas de leitura da biometria antes de enviar erro.
latitude Localização do leitor / latitude. Tamanho máximo 16 caracteres.
longitude Localização do leitor / longitude. Tamanho máximo 16 caracteres.
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. Tamanho máximo 128 caracteres.

[editar] Exemplo 

POST /?request=setconfig HTTP/1.1
Content-Type: application/json
Content-Length: 167

{
  "hotspot":"off"
  "ap_mode":"off"
  "standalone":"on"
  "ssid":"uTech-Test"
  "password":"adminutech"
  "ssid_hidden":"off"
  "dhcp":"on"
  "ip":"10.0.0.1"
  "netmask":"255.255.255.0"
  "gateway":"10.0.0.2"
  "dns":"10.0.0.2"
  "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":"admin"
  "server_password":"admin"
  "server_url":""
  "ota_url":"http://10.0.0.10"
  "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://admin:admin@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.8:7777"
  "control_acc_timeout":"30000"
  "rfid_panic_timeout":"0"
}

Resposta:

  • 400 => Parâmetros incorretos
  • 401 => Erro de autenticação da API
  • 200 => OK





Voltar

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

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