MLI/API/CmdGetConfig
De uTech Tecnologia
(Diferença entre revisões)
(Criou página com ' __TOC__ O comando '''Buscar Configuração''' é utilizado solicitar as configurações básicas do leitor. == Comando == <BR\> '''MÉTODO:''' <span style="color:red">'''G...') |
(→Comando) |
||
Linha 21: | Linha 21: | ||
|- | |- | ||
| align="left"| mac || Endereço MAC do leitor. | | align="left"| mac || Endereço MAC do leitor. | ||
+ | |- | ||
+ | | align="left"| hotspot || Indica se o modo ''hotspot'' está ativo. | ||
+ | * '''on''': Habilitado | ||
+ | * '''off''': Desabilitado | ||
+ | |- | ||
+ | | align="left"| ap_mode || Indica se o modo ''Access Point'' esta habilitado. | ||
+ | * '''on''': Habilitado | ||
+ | * '''off''': Desabilitado | ||
+ | |- | ||
+ | | align="left"| standalone || Indica se o modo ''standalone'' esta habilitado. | ||
+ | * '''on''': Habilitado | ||
+ | * '''off''': Desabilitado | ||
+ | |- | ||
+ | | align="left"| ssid || Informa o '''SSID'''/rede configurado no '''Access Point'''. | ||
+ | |- | ||
+ | | align="left"| password || Senha de acesso a rede WIFI. | ||
+ | |- | ||
+ | | align="left"| ssid_hidden || Identifica se está configurado para esconder ou não '''SSID''' da rede WIFI. | ||
+ | * '''on''': Habilitado | ||
+ | * '''off''': Desabilitado | ||
|- | |- | ||
| align="left"| dhcp || Identifica se o cliente dhcp está habilitado. | | align="left"| dhcp || Identifica se o cliente dhcp está habilitado. | ||
Linha 36: | Linha 56: | ||
| align="left"| ntp || Endereço do servidor NTP do leitor. | | align="left"| ntp || Endereço do servidor NTP do leitor. | ||
|- | |- | ||
− | | align="left"| | + | | align="left"| hostname || Hostname do leitor. |
|- | |- | ||
− | | align="left"| | + | | align="left"| timezone || Timezone configurado no leitor. |
|- | |- | ||
− | | align="left"| | + | | align="left"| dst || Indica se o horário de verão está habilitado. |
+ | * '''on''': Habilitado | ||
+ | * '''off''': Desabilitado | ||
|- | |- | ||
− | | align="left"| | + | | align="left"| 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 | ||
|- | |- | ||
| align="left"| passowrd || Senha do ramal/extensão do leitor. | | align="left"| passowrd || Senha do ramal/extensão do leitor. |
Edição de 14h29min 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.
|
ap_mode | Indica se o modo Access Point esta habilitado.
|
standalone | Indica se o modo standalone esta habilitado.
|
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.
|
dhcp | Identifica se o cliente dhcp está habilitado.
|
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.
|
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:
|
passowrd | Senha do ramal/extensão do leitor. |
hotline | Numero discado nao pressionar o botão Portaria. |
volmicrofone | Volume do microfone (min:0 - max:20) |
volspeaker | Volume do alto falante (min:0 - max:20) |
keyboard | Define se está habilitado ou não o teclado do leitor.
|
release | Informação da versão de firmware do equipamento. |
doublepass_timeout | Tempo, em segundos, para dupla passagem (0 - Desabilitado) |
http_server | Cliente - Endereço do Servidor de Integração. |
http_port | Cliente - Porta do Servidor de Integração. |
http_username | Cliente - Usuário do Servidor de Integração. |
http_password | Cliente - Senha do Servidor de Integração. |
http_url | Cliente - URL do Servidor de Integração. |
http_timeout | Cliente - Timeout da Requisição em segundos. |
http_retries | Cliente - Número de Tentativas da Requisição. |
httpd_username | Servidor - Usuário de acesso das aplicações a API do Leitor IP MLI. |
httpd_password | Servidor - Senha de acesso das aplicações a API do Leitor IP MLI. |
httpd_port | Servidor - Porta que o Leitor IP receberá conexões das aplicações. |
httpd_timeout | Servidor - Timeout para conexão TCP. |
httpd_auth | Servidor - Se habilitado, o Leitor IP MLI aceitará conexões de todos os usuários configurados (com conta e senha). |
interface1_control_enable | Habilitar/Desabilitar Acionamento (Relê) da Interface 1.
|
interface1_control_type | Tipo de Acionamento da Interface 1:
|
interface1_control_time | Tempo de acionamento da interface 1 (segundos) |
interface1_control_acc_time | Tempo de acionamento da interface 1 para acessibilidade (segundos). |
interface1_interlocking | Habilitar/Desabilitar intertravamento na interface 1.
|
interface1_sensor_enable | Habilitar/Desabilitar sensor da interface 1.
|
interface1_sensor_panic | Habilitar/Desabilitar função pâncio no sensor da interface 1.
|
interface1_sensor_alarm | Tempo, em segundos, para alarme no sensor de porta aberta da interface 1 (0 - Desabilitado).
|
interface1_sensor_breakin | Habilitar/Desabilitar alarme de arrombamento na Interface 1.
|
interface1_button_enable | Habilitar/Desabilitar botoeira na interface 1.
|
interface1_button_panic | Habilitar/Desabilitar função pânico na botoeira na interface 1.
|
interface1_button_relay | Habilitar/Desabilitar acionamento da botoeira na interface 1.
|
interface1_button_interface | Interface de acionamento da botoeira na interface 1.
|
interface2_control_enable | Habilitar/Desabilitar Acionamento (Relê) da Interface 1.
|
interface2_control_type | Tipo de Acionamento da Interface 1:
|
interface2_control_time | Tempo de acionamento da interface 1 (segundos) |
interface2_control_acc_time | Tempo de acionamento da interface 1 para acessibilidade (segundos). |
interface2_interlocking | Habilitar/Desabilitar intertravamento na interface 1.
|
interface2_sensor_enable | Habilitar/Desabilitar sensor da interface 1.
|
interface2_sensor_panic | Habilitar/Desabilitar função pâncio no sensor da interface 1.
|
interface2_sensor_alarm | Tempo, em segundos, para alarme no sensor de porta aberta da interface 1 (0 - Desabilitado).
|
interface2_sensor_breakin | Habilitar/Desabilitar alarme de arrombamento na Interface 1.
|
interface2_button_enable | Habilitar/Desabilitar botoeira na interface 1.
|
interface2_button_panic | Habilitar/Desabilitar função pânico na botoeira na interface 1.
|
interface2_button_relay | Habilitar/Desabilitar acionamento da botoeira na interface 1.
|
interface2_button_interface | Interface de acionamento da botoeira na interface 1.
|
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":"0000003048", "mac":"F8:E7:B5:00:0B:EE", "release":"1.1.12", "dhcp":"off", "ip":"10.0.0.1", "netmask":"255.255.255.0", "gateway":"10.0.0.2", "dns":"1.1.1.1", "ntp":"2.3.4.5", "server":"10.0.0.3", "port":"5060", "stun":"", "exten":"1000", "password":"1234", "hotline":"94", "volmicrophone":"18", "volspeaker":"20", "keyboard":"true", "http_server":"10.0.0.100", "http_port":"7777", "http_username":"admin", "http_password":"1234", "http_url":"", "http_timeout":"30", "http_retries":"1", "interface1_control_enable":"false", "interface1_control_type":"1", "interface1_control_time":"5", "interface1_control_acc_time":"20", "interface1_interlocking":"false", "interface1_sensor_enable":"true", "interface1_sensor_panic":"false", "interface1_sensor_alarm":"0", "interface1_sensor_breakin":"false", "interface1_button_enable":"false", "interface1_button_panic":"true", "interface1_button_relay":"false", "interface1_button_interface":"0", "interface2_control_enable":"true", "interface2_control_type":"1", "interface2_control_time":"5", "interface2_control_acc_time":"20", "interface2_interlocking":"false", "interface2_sensor_enable":"true", "interface2_sensor_panic":"false", "interface2_sensor_alarm":"0", "interface2_sensor_breakin":"false", "interface2_button_enable":"false", "interface2_button_panic":"false", "interface2_button_relay":"true", "interface2_button_interface":"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)); ?> |