MCI/API/CmdSetConfig

De uTech Tecnologia
(Diferença entre revisões)
Ir para: navegação, pesquisa
(→‎Exemplo)
(→‎Comando)
 
(4 edições intermediárias de um usuário não apresentadas)
Linha 2: Linha 2:
 
__TOC__
 
__TOC__
  
−
O comando '''Configurar Porteiro''' é utilizado alterar as configurações básicas da catraca.
+
O comando '''Configurar Catraca''' é utilizado alterar as configurações básicas da catraca.
  
 
== Comando ==
 
== Comando ==
Linha 34: Linha 34:
 
| align="left"| ntp || Endereço do servidor NTP da catraca.
 
| align="left"| ntp || Endereço do servidor NTP da catraca.
 
|-
 
|-
−
| align="left"| server || Servidor SIP primário.
+
| align="left"| keyboard || Define se está habilitado ou não o teclado da catraca.
 +
* '''on''': Teclado habilitado.
 +
* '''off:''' Teclado desabilitado.
 
|-
 
|-
−
| align="left"| port || Porta de sinalização do servidor SIP.
+
| align="left"| keyboard_sound || Habilita ou desabilita beep ao pressionar as teclas do teclado.
 
|-
 
|-
−
| align="left"| stun || Endereço do servidor STUN.
+
| align="left"| sharp_cancel || Utilizar a tecla ''Sharp'' ('''#''') como tecla para cancelar operação.
 +
* '''true''': Habilitado.
 +
* '''false:''' Desabilitado.
 
|-
 
|-
−
| align="left"| exten || Ramal/extensão da catraca.
+
| align="left"| asterisk_password || Utilizar a tecla asterisco ('''*''') como tecla para operação de login.
 +
* '''true''': Habilitado.
 +
* '''false:''' Desabilitado.
 
|-
 
|-
−
| align="left"| passowrd || Senha do ramal/extensão da catraca.
+
| align="left"| password_timeout || Tempo, em segundos, de ''timeout'' que a catraca irá esperar os dígitos de login e senha.
 +
* '''true''': Habilitado.
 +
* '''false:''' Desabilitado.
 
|-
 
|-
−
| align="left"| hotline || Numero discado nao pressionar o botão '''Portaria'''.
+
| align="left"| display || Define se o ''display'' da catraca ficará ligado ou desligado.
 +
* '''true''': Ligado.
 +
* '''false:''' Desligado.
 
|-
 
|-
−
| align="left"| volmicrofone || Volume do microfone (min:0 - max:20)
+
| align="left"| display_text || Texto/Informação que será mostrado durante o estado de ''stand by'' da catraca. Texto será truncado caso ultrapasse 20 caracteres.
 +
|-
 +
| align="left"| backlight || Define se a iluminação do ''display'' permanecerá ligada ou desligada durante operação (no caso de ''display=true'').
 +
* '''true''': Ligado.
 +
* '''false:''' Desligado.
 
|-
 
|-
 
| align="left"| volspeaker || Volume do alto falante (min:0 - max:20)
 
| align="left"| volspeaker || Volume do alto falante (min:0 - max:20)
−
|-
 
−
| align="left"| keyboard || Define se está habilitado ou não o teclado da catraca.
 
−
* '''on''': Teclado habilitado.
 
−
* '''off:''' Teclado desabilitado.
 
−
|-
 
−
| align="left"| doublepass_timeout || Tempo, em segundos, para dupla passagem (0 - Desabilitado)
 
 
|-
 
|-
 
| align="left"| http_server  || '''Cliente''' - Endereço do Servidor de Integração.
 
| align="left"| http_server  || '''Cliente''' - Endereço do Servidor de Integração.
Linha 80: Linha 88:
 
| align="left"| httpd_auth  || '''Servidor''' - Se habilitado, a Catraca IP MCI aceitará conexões de todos os usuários configurados (com conta e senha).
 
| align="left"| httpd_auth  || '''Servidor''' - Se habilitado, a Catraca IP MCI aceitará conexões de todos os usuários configurados (com conta e senha).
 
|-
 
|-
−
| align="left"|interface1_control_enable    || Habilitar/Desabilitar Acionamento (Relê) da Interface 1.
+
| align="left"| standalone  || define se a catraca irá operar no modo ''standalone'' ou não.
−
* '''true''': Habilita.
+
* '''true''': Standalone habilitado. Indica que a toda informação de usuários e acessos será armazenado e manipulado pela catraca.
−
* '''false''': Desabilita.
+
* '''false''': Standalone desabilitado. Indica que o controle de acesso deverá ser operado remotamente via API ou interface WEB.
 
|-
 
|-
−
| align="left"|interface1_control_type      || Tipo de Acionamento da Interface 1:
+
| align="left"| unlock  || Define se o controle de acesso da catraca está habilita ou não. Se desabilitado, libera a passagem de entrada e saída sem controle.
−
* '''0''': Contínuo.
+
* '''true''': Controle de acesso habilitado.
−
* '''1''': Pulsado.
+
* '''false''': Controle de acesso desabilitado. Passagem livre pela catraca.
−
* '''2''': Manual.
+
 
|-
 
|-
−
| align="left"|interface1_control_time      || Tempo de acionamento da interface 1 (segundos)
+
| align="left"| announce  || Se habilitado, reproduz mensagem para os usuários, como por exemplo: "Acesso liberado" ou "Dupla passagem não permitida". Se desabilitado, emitirá apenas bipes.
 +
* '''true''': Habilitado.
 +
* '''false''': Desabilitado.
 
|-
 
|-
−
| align="left"|interface1_control_acc_time || Tempo de acionamento da interface 1 para acessibilidade (segundos).
+
| align="left"| alarm_type || Define tipo do alarme que será reproduzido quando o alarme da catraca for acionado. Valores de 0 a 4.
 
|-
 
|-
−
| align="left"|interface1_interlocking      || Habilitar/Desabilitar intertravamento na interface 1.
+
| align="left"| lock_direction  || Define qual o método de bloqueio e controle utilizado na catraca. Como a catraca será utilizada. Para entrada e saída, somente entrada ou somente saída.
−
* '''true''': Habilita.
+
* '''both''': Catraca utilizada para entrada e saída. Bloqueada nos dois sentidos.
−
* '''false''': Desabilita.
+
* '''input''': Catraca utilizada somente para entrada - Controle de acesso para entrada e, por padrão, saída bloqueada.
 +
* '''output''': Catraca utilizada para saída - Controle de acesso para saída e, por padrão, entrada bloqueada.
 
|-
 
|-
−
| align="left"|interface1_sensor_enable    || Habilitar/Desabilitar sensor da interface 1.
+
| align="left"| unlock_direction  || Define se catraca terá algum sentido liberado.
−
* '''true''': Habilita.
+
* '''none''': Nenhum sentido liberado.
−
* '''false''': Desabilita.
+
* '''input''' Entrada liberada, sem controle de acesso.
 +
* '''output''': Saída liberada, sem controle de acesso.
 
|-
 
|-
−
| align="left"|interface1_sensor_panic      || Habilitar/Desabilitar função pâncio no sensor da interface 1.
+
| align="left"| rotation  || Define o sentido / referência de rotação da catraca.
−
* '''true''': Habilita.
+
* '''clockwise''': Define o sentido horário para entrada na catraca.
−
* '''false''': Desabilita.
+
*'''counterclockwise''': Define o sentido anti-horário para entrada na catraca.
 
|-
 
|-
−
| align="left"|interface1_sensor_alarm      || Tempo, em segundos, para alarme no sensor de porta aberta da interface 1 (0 - Desabilitado).
+
| align="left"| control_time  || Tempo de Acionamento - Tempo, em segundos, que a catraca manterá o acesso liberado para entrada e saída quando detectado usuário válido (Cartão, biometria, etc...)
−
* '''true''': Habilita.
+
−
* '''false''': Desabilita.
+
 
|-
 
|-
−
| align="left"|interface1_sensor_breakin    || Habilitar/Desabilitar alarme de arrombamento na Interface 1.
+
| align="left"| control_acc_time  || Tempo de Acionamento para Acessibilidade - Tempo, em segundos, que a catraca manterá o acesso liberado para entrada e saída quando detectado usuário válido (Cartão, biometria, etc...) e o mesmo estiver cadastrado como Acessibilidade (Ver [[MCI/ConfiguracaoWEB#Inserindo_Usu.C3.A1rios|'''Usuários''']])
−
* '''true''': Habilita.
+
−
* '''false''': Desabilita.
+
 
|-
 
|-
−
| align="left"|interface1_button_enable    || Habilitar/Desabilitar botoeira na interface 1.
+
| align="left"| collector_time  || Tempo de Acionamento do Coletor- Tempo, em segundos, que a catraca manterá o coletor de cartões aberto ao detectar um cartão válido.
−
* '''true''': Habilita.
+
−
* '''false''': Desabilita.
+
 
|-
 
|-
−
| align="left"|interface1_button_panic      || Habilitar/Desabilitar função pânico na botoeira na interface 1.
+
| align="left"| doublepass_timeout || Tempo, em segundos, que a catraca manterá o acesso bloqueado ao detectar uma dupla passagem ('''''Anti-Passback''''').  
−
* '''true''': Habilita.
+
−
* '''false''': Desabilita.
+
−
|-
+
−
| align="left"|interface1_button_relay      || Habilitar/Desabilitar acionamento da botoeira na interface 1.
+
−
* '''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 256: Linha 200:
 
$ipaddr = "10.0.0.1";
 
$ipaddr = "10.0.0.1";
  
−
$data array(
+
$data = array(
−
{
+
"dhcp"               =>"off",
−
    "serial"        => "0000005555",
+
"ip"                 =>"10.0.0.2",
−
    "mac"          => "F8:E7:B5:00:0B:3F",
+
"netmask"           =>"255.255.255.0",
−
    "dhcp"         => "off",
+
"gateway"           =>"10.0.0.1",
−
    "ip"           => "10.0.0.1",
+
"dns"               =>"1.1.1.1",
−
    "netmask"       => "255.255.255.0",
+
"ntp"                =>"pool.ntp.br",
−
    "gateway"       => "10.0.0.3",
+
"keyboard"          =>"true",
−
    "dns"           => "8.8.8.8",
+
"keyboard_sound"     =>"1",
−
    "ntp"          => "",
+
"sharp_cancel"      =>"false",
−
     "server"        => "10.0.0.2",
+
"asterisk_password"  =>"false",
−
    "port"          => "5060",
+
"password_timeout"  =>"3",
−
    "stun"         => "",
+
"display"            =>"true",
−
     "exten"        => "7000",
+
"display_text"      =>"",
−
    "password"      => "1234",
+
"backlight"          =>"true",
−
    "hotline"       => "98",
+
"volspeaker"        =>"20",
−
    "volmicrophone" => "15",
+
"http_server"        =>"10.0.0.20",
−
     "volspeaker"   => "18",
+
"http_port"          =>"8090",
−
     "keyboard"     => "true"
+
"http_username"     =>"admin",
 +
"http_password"      =>"1234",
 +
"http_url"          =>"",
 +
"http_timeout"      =>"30",
 +
"http_retries"      =>"1",
 +
"httpd_username"     =>"admin",
 +
"httpd_password"    =>"1234",
 +
"httpd_port"        =>"8080",
 +
"httpd_timeout"      =>"60",
 +
"httpd_auth"         =>"true",
 +
"standalone"         =>"true",
 +
"unlock"            =>"false"
 +
"announce"          =>"true",
 +
"alarm_type"        =>"0",
 +
"lock_direction"     =>"both",
 +
"unlock_direction"  =>"none",
 +
"rotation"          =>"clockwise",
 +
"control_time"      =>"3000",
 +
"control_acc_time"  =>"30000",
 +
"collector_time"     =>"1000",
 +
"doublepass_timeout" =>"30"
 
);
 
);
 
      
 
      

Edição atual tal como 16h14min de 29 de julho de 2019

Tabela de conteúdo


O comando Configurar Catraca é utilizado alterar as configurações básicas da catraca.

[editar] Comando


MÉTODO: POST

Parâmetros enviados para a Catraca
request setconfig

POST-DATA:

Parâmetros enviados para a Catraca via JSON
dhcp Identifica se o cliente dhcp está habilitado.
  • on: Habilitado
  • off: Desabilitado
ip Endereço IP da catraca.
netmask Endereço da mascara de rede da catraca.
gateway Endereço da rota padrão da catraca.
dns Endereço do servidor DNS primário da catraca.
ntp Endereço do servidor NTP da catraca.
keyboard Define se está habilitado ou não o teclado da catraca.
  • on: Teclado habilitado.
  • off: Teclado desabilitado.
keyboard_sound Habilita ou desabilita beep ao pressionar as teclas do teclado.
sharp_cancel Utilizar a tecla Sharp (#) como tecla para cancelar operação.
  • true: Habilitado.
  • false: Desabilitado.
asterisk_password Utilizar a tecla asterisco (*) como tecla para operação de login.
  • true: Habilitado.
  • false: Desabilitado.
password_timeout Tempo, em segundos, de timeout que a catraca irá esperar os dígitos de login e senha.
  • true: Habilitado.
  • false: Desabilitado.
display Define se o display da catraca ficará ligado ou desligado.
  • true: Ligado.
  • false: Desligado.
display_text Texto/Informação que será mostrado durante o estado de stand by da catraca. Texto será truncado caso ultrapasse 20 caracteres.
backlight Define se a iluminação do display permanecerá ligada ou desligada durante operação (no caso de display=true).
  • true: Ligado.
  • false: Desligado.
volspeaker Volume do alto falante (min:0 - max:20)
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 da Catraca IP MCI.
httpd_password Servidor - Senha de acesso das aplicações a API da Catraca IP MCI.
httpd_port Servidor - Porta que a Catraca IP receberá conexões das aplicações.
httpd_timeout Servidor - Timeout para conexão TCP.
httpd_auth Servidor - Se habilitado, a Catraca IP MCI aceitará conexões de todos os usuários configurados (com conta e senha).
standalone define se a catraca irá operar no modo standalone ou não.
  • true: Standalone habilitado. Indica que a toda informação de usuários e acessos será armazenado e manipulado pela catraca.
  • false: Standalone desabilitado. Indica que o controle de acesso deverá ser operado remotamente via API ou interface WEB.
unlock Define se o controle de acesso da catraca está habilita ou não. Se desabilitado, libera a passagem de entrada e saída sem controle.
  • true: Controle de acesso habilitado.
  • false: Controle de acesso desabilitado. Passagem livre pela catraca.
announce Se habilitado, reproduz mensagem para os usuários, como por exemplo: "Acesso liberado" ou "Dupla passagem não permitida". Se desabilitado, emitirá apenas bipes.
  • true: Habilitado.
  • false: Desabilitado.
alarm_type Define tipo do alarme que será reproduzido quando o alarme da catraca for acionado. Valores de 0 a 4.
lock_direction Define qual o método de bloqueio e controle utilizado na catraca. Como a catraca será utilizada. Para entrada e saída, somente entrada ou somente saída.
  • both: Catraca utilizada para entrada e saída. Bloqueada nos dois sentidos.
  • input: Catraca utilizada somente para entrada - Controle de acesso para entrada e, por padrão, saída bloqueada.
  • output: Catraca utilizada para saída - Controle de acesso para saída e, por padrão, entrada bloqueada.
unlock_direction Define se catraca terá algum sentido liberado.
  • none: Nenhum sentido liberado.
  • input Entrada liberada, sem controle de acesso.
  • output: Saída liberada, sem controle de acesso.
rotation Define o sentido / referência de rotação da catraca.
  • clockwise: Define o sentido horário para entrada na catraca.
  • counterclockwise: Define o sentido anti-horário para entrada na catraca.
control_time Tempo de Acionamento - Tempo, em segundos, que a catraca manterá o acesso liberado para entrada e saída quando detectado usuário válido (Cartão, biometria, etc...)
control_acc_time Tempo de Acionamento para Acessibilidade - Tempo, em segundos, que a catraca manterá o acesso liberado para entrada e saída quando detectado usuário válido (Cartão, biometria, etc...) e o mesmo estiver cadastrado como Acessibilidade (Ver Usuários)
collector_time Tempo de Acionamento do Coletor- Tempo, em segundos, que a catraca manterá o coletor de cartões aberto ao detectar um cartão válido.
doublepass_timeout Tempo, em segundos, que a catraca manterá o acesso bloqueado ao detectar uma dupla passagem (Anti-Passback).

[editar] Exemplo 

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

{
"model":"MCI-41E",
"serial":"0000004354",
"mac":"F8:E7:B5:00:00:01",
"release":"1.1.1",
"dhcp":"off",
"ip":"10.0.0.2",
"netmask":"255.255.255.0",
"gateway":"10.0.0.1",
"dns":"1.1.1.1",
"ntp":"pool.ntp.br",
"keyboard":"true",
"keyboard_sound":"1",
"sharp_cancel":"false",
"asterisk_password":"false",
"password_timeout":"3",
"display":"true",
"display_text":"",
"backlight":"true",
"volspeaker":"20",
"http_server":"10.0.0.200",
"http_port":"8090",
"http_username":"admin",
"http_password":"1234",
"http_url":"",
"http_timeout":"30",
"http_retries":"1",
"httpd_username":"admin",
"httpd_password":"1234",
"httpd_port":"8080",
"httpd_timeout":"60",
"httpd_auth":"true",
"standalone":"true",
"unlock":"false"
"announce":"true",
"alarm_type":"0",
"lock_direction":"both",
"unlock_direction":"none",
"rotation":"clockwise",
"control_time":"3000",
"control_acc_time":"30000",
"collector_time":"1000",
"doublepass_timeout":"30"
}

Resposta:

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




[editar] PHP 

<?php
 
$user = "utech";
$pass = "1234";
$port = "8080";
$ipaddr = "10.0.0.1";
 
$data = array(
 "dhcp"               =>"off",
 "ip"                 =>"10.0.0.2",
 "netmask"            =>"255.255.255.0",
 "gateway"            =>"10.0.0.1",
 "dns"                =>"1.1.1.1",
 "ntp"                =>"pool.ntp.br",
 "keyboard"           =>"true",
 "keyboard_sound"     =>"1",
 "sharp_cancel"       =>"false",
 "asterisk_password"  =>"false",
 "password_timeout"   =>"3",
 "display"            =>"true",
 "display_text"       =>"",
 "backlight"          =>"true",
 "volspeaker"         =>"20",
 "http_server"        =>"10.0.0.20",
 "http_port"          =>"8090",
 "http_username"      =>"admin",
 "http_password"      =>"1234",
 "http_url"           =>"",
 "http_timeout"       =>"30",
 "http_retries"       =>"1",
 "httpd_username"     =>"admin",
 "httpd_password"     =>"1234",
 "httpd_port"         =>"8080",
 "httpd_timeout"      =>"60",
 "httpd_auth"         =>"true",
 "standalone"         =>"true",
 "unlock"             =>"false"
 "announce"           =>"true",
 "alarm_type"         =>"0",
 "lock_direction"     =>"both",
 "unlock_direction"   =>"none",
 "rotation"           =>"clockwise",
 "control_time"       =>"3000",
 "control_acc_time"   =>"30000",
 "collector_time"     =>"1000",
 "doublepass_timeout" =>"30"
);
 
$data_string = json_encode($data);
$url = "$ipaddr:$port?request=setconfig";
$ch = curl_init($url);
curl_setopt($ch, CURLOPT_HTTPAUTH, CURLAUTH_BASIC);
curl_setopt($ch, CURLOPT_USERPWD, "$user:$pass");
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, "POST");    
curl_setopt($ch, CURLOPT_POSTFIELDS, $data_string); 
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, array(
    'Content-Type: application/json',
    'Content-Length: ' . strlen($data_string))
);                                           
 
$result = curl_exec($ch);
if(!$result) {
    echo "error!\n";
    return 2;
}
 
$fs = preg_replace("/<html><body>/", "", "$result");
$rc = preg_replace("/<\/body><\/html>/", "", "$fs");
 
switch($rc) {
 
    case "400":
        echo "400 => Parametros Invalidos\n";
    break;
 
    case "401":
        echo "401 => Erro de autenticação da API\n";
    break;
 
    case "200":
        echo "200 => OK\n";
    break;
 
    default:
        echo "Return Code: $rc\n";
}
 
?>




Voltar

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

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