MLW/API/CmdGetConfig

De uTech Tecnologia
Ir para: navegação, pesquisa

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
model Informação do modelo do equipamento.
serial Numero de série do equipamento.
mac Endereço MAC do leitor.
release Versão de firmware 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.
channel Canal utilizado na rede WIFI (1 a 13).
beacon_interval Intervalo de tempo para envio dos beacon frames. Em milissegundos.
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.
ddns Domonio dinâmico configurado no leitor.
ddns_domain Estado da configuração de DDNS.
  • on: DDNS habilitado.
  • off: DDNS desabilitado.
ddns_user DDNS (domínio dinâmico) configurado no leitor.
ddns_user Usuário de acesso a configuração do serviço de DDNS.
ddns_password Senha de acesso a configuração do serviço de DDNS.
wifi_disable Indica se a interface Wifi está habilitada.
  • true: Wifi habilitado.
  • false: Wifi desabilitado.
wifi_mac Endereço MAC da interface Wifi.
wifi_dhcp Estado do dhcp cliente para a interface Wifi.
  • true: DHCP habilitado.
  • false: DGCP desabilitado.
wifi_ip Endereço IP da interface Wifi.
wifi_netmask Mascara de rede da interface Wifi.
wifi_gateway Gateway / rota padrão da interface Wifi.
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_password Senha de acesso à API de integração do Leitor.
server_url URL de acesso ao servidor de aplicação para a API enviar eventos. Tamanho máximo 128 caracteres.
server_retries Número de re-tentativas de envio dos eventos em caso de falha.
ota_url URL para atualização de firmware.
rf433 Indica se a interface RF-433 está habilitada.
  • on: Habilitada.
  • off: Desabilitada.
rf433_rc Indica se a configuração Rolling Code está habilitda.
  • on: Habilitada.
  • off: Desabilitada.
rf433_hc Configuração de tolerância do Hopping Conde. Valores: 8, 16, 64, 128, 256, 512, 1024 e 2048.
rf433_alarm Indica se a configuração de alamre sonoro está habilitada.
  • on: Habilitada.
  • off: Desabilitada.
rf433_bc Indica a configuração para inserir código do botão está habilitada.
  • on: Habilitada.
  • off: Desabilitada.
rf433_bp Indica a configuração para botão para pânico está habilitada.
  • on: Habilitada.
  • off: Desabilitada.
rf433_rf433_panic_timeout Tempo em milissegundos para timetout de ativação do pânico.
rf433_ba Mascara de 8 bits a configuração de acionamento dos botões 1, 2 3 e 4. O Valor retornado é um inteiro.
  • Bit 0: Botão 1 - Interface 1
  • Bit 1: Botão 1 - Interface 2
  • Bit 2: Botão 2 - Interface 1
  • Bit 3: Botão 2 - Interface 2
  • Bit 4: Botão 3 - Interface 1
  • Bit 5: Botão 3 - Interface 2
  • Bit 6: Botão 4 - Interface 1
  • Bit 7: Botão 4 - Interface 2


Exemplo: Se selecionar o botão 1 como interface 1, botão 2 como interface 2 e botão 3 como Ambas, serão setados os bits 0, 3, 4 e 5. Então o valor retornado (interiro) será 57 (0x39).

control_description Descrição do acionamento. Configurado na interface web.
control_mode Tipo de acionamento do rele. 0 - Continuo / 1 - Manual.
control_timeout Tempo de acionamento do relê. Em milissegundos.
control_external Indica se o acionamento de relé externo está acionado.
  • true: Habilitado.
  • false: Desabilitado.
control_url URL para acionamento externo. Ex: http://utech:1234@10.0.0.1:8080/request=relay&interface=1&state=on
control_acc_timeout Tempo de acionamento do relê para acessibilidade. Em milissegundos.
control_doublepass_timeout Tempo de bloqueio para dupla passagem. Em segundos.
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).
watchdog_shutdown Tempo pediódico para reiniciar o leitor. Em horas. Valor zero desabilita a configuração.
debug Configuração do log remoto. ESTADO' : 'NIVEL' : 'ENDEREÇO IP' : 'PORTA'
  • ESTADO: Estado do debug.
    • 0: Desabilitado.
    • 2: Habilitado.
  • NIVEL: Nivel de log
    • 0 - Nenhum.
    • 2 - ERROR.
    • 3 - CRITICAL.
    • 4 - WARNING.
    • 5 - MESSAGE.
    • 6 - INFO.
    • 7 - DEBUG.

Exemplo: "debug":"2:7:10.0.0.50:8888" ⇒ Debug ativo, nivel 7 (dbug), endereço ip 10.0.0.50 e porta 8888.

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.2
Content-Type: application/json
 
{
 "model":"MLW-1EWF",
 "serial":"9999999999",
 "mac":"F8:E7:B5:00:28:98",
 "release":"1.1.1",
 "hotspot":"on",
 "ap_mode":"off",
 "standalone":"on",
 "ssid":"uTech-AP",
 "password":"adminutech",
 "channel":"1",
 "beacon_interval":"100",
 "ssid_hidden":"off",
 "dhcp":"off",
 "ip":"10.0.0.20",
 "netmask":"255.255.255.0",
 "gateway":"10.0.0.1",
 "dns":"1.1.1.1",
 "ntp":"pool.ntp.br",
 "hostname":"ulet",
 "ddns":"off",
 "ddns_domain":"",
 "ddns_user":"",
 "ddns_password":"",
 "wifi_disable":"false",
 "wifi_mac":"F8:E7:B5:00:28:99",
 "wifi_dhcp":"true",
 "wifi_ip":"192.168.0.1",
 "wifi_netmask":"255.255.255.0",
 "wifi_gateway":"192.168.0.2",
 "timezone":"-3",
 "dst":"off",
 "dst_date":"10/3/0 2/3/0",
 "server":"",
 "server_port":"80",
 "server_user":"",
 "server_password":"",
 "server_url":"",
 "server_retries":"0",
 "ota_url":"",
 "rf433":"on",
 "rf433_rc":"off",
 "rf433_hc":"256",
 "rf433_alarm":"off",
 "rf433_bc":"on",
 "rf433_bp":"0",
 "rf433_panic_timeout":"0",
 "rf433_ba":"0",
 "control_description":"",
 "control_mode":"0",
 "control_timeout":"3000",
 "control_external":"false",
 "control_url":"",
 "control_acc_timeout":"30000",
 "control_doublepass_timeout":"0",
 "latitude":"",
 "longitude":"",
 "user_auth":"on",
 "watchdog_shutdown":"24",
 "debug":"0:0:10.0.0.3:8888"
}



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=MLW/API/CmdGetConfig&oldid=9135"
Ferramentas pessoais
Espaços nominais

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