MGE/API
De uTech Tecnologia
(Diferença entre revisões)
(→Comandos) |
(→Comandos) |
||
Linha 106: | Linha 106: | ||
|- | |- | ||
! scope="row" style="width: 30%" align="right"| [[MGE/API/CmdControlarRele|'''Controlar acionamento do relê''']] | ! scope="row" style="width: 30%" align="right"| [[MGE/API/CmdControlarRele|'''Controlar acionamento do relê''']] | ||
− | | Comando enviado para o medidor para controlar o acionamento/status | + | | Comando enviado para o medidor para controlar o acionamento/status do Relê. |
+ | |- | ||
+ | ! scope="row" style="width: 30%" align="right"| [[MGE/API/CmdControlarReleAux|'''Controlar acionamento do relê auxiliar''']] | ||
+ | | Comando enviado para o medidor para controlar o acionamento/status do Relê auxiliar. | ||
|- | |- | ||
! scope="row" style="width: 30%" align="right"| [[MGE/API/CmdControlarAlarme|'''Controlar acionamento do alarme''']] | ! scope="row" style="width: 30%" align="right"| [[MGE/API/CmdControlarAlarme|'''Controlar acionamento do alarme''']] |
Edição de 21h19min de 7 de janeiro de 2021
API de integração com medidor uTech MGE
Tabela de conteúdo |
Protocolo / Formato das requisições
Integração do medidor uTech MGE via API - Comandos e Eventos
- Comandos: Serão enviados da aplicação para o medidor.
- Eventos: Serão enviados pelo medidor para a aplicação (O destino dos eventos deve ser configurado no medidor).
Métodos e Formatos
Formato dos Comandos
- Comandos enviados para o medidor, devem utilizar o protocolo HTTP] e os métodos [GET] e [POST].
- As respostas estarão codificadas no padrão JSON (Caso houver dados. Veja a lista completa de comandos e eventos abaixo)
Requisição:
http://IP_DO_MGE:porta/?request=<requisição>... |
---|
Resposta do Comando
- 400 => Requisição ou parâmetros incorretos!
- 200 => Requisição OK.
Content-Type: application/json { "relay":"off", "sensor":"off", "description": "MGE Teste" } |
---|
Formato dos Eventos
- Para eventos gerados pelo medidor MGE, será enviado uma requisição [HTTP] utilizando o método [GET].
Evento:
http://ip:porta/url/?event=alarm&state=on User-Agent: uTech/0000002874 Connection: close Date: Wed, 13 Jun 2018 17:22:35 Host: 10.0.0.200 |
---|
Utilize o campo (header http) User-Agent para identificar qual medidor MGE está enviando os eventos para sua aplicação. |
Resposta do evento
A aplicação deverá responder os eventos com o Status code 200 OK
Autenticação
Para acesso com usuário e senha, é usulizado o método e autenticação Basic'. Veja sobe em: Basic Authentication
Comandos
Comandos enviados pela Aplicação ao medidor | |
---|---|
Status | Comando enviado para o medidor solicitando status dos relés, sensores e botoeiras. |
Status e Níveis dos Sensores de Telemetria | Comando enviado para o medidor solicitando status de telemetria dos sensores. |
Log de Dados da Telemetria | Comando enviado para o medidor solicitando o log dos últimos 8000 status dos sensores de telemetria. |
Remover Log de Telemetria | Comando enviado para o medidor solicitando para apagar todos os registros/logs de telemetria. |
Listar usuários | Comando enviado para o medidor para solicitar a lista de usuários cadastrados. |
Buscar Usuário | Comando enviado para o medidor para solicitar a configuração de um usuário. |
Adicionar usuário | Comando enviado para o medidor solicitando a inclusão de um novo usuário. |
Remover usuário | Comando enviado para o medidor solicitando remoção de um usuário. |
Remover todos os usuários | Comando enviado para o medidor solicitando a remoção de TODOS os usuários. |
Controlar acionamento do relê | Comando enviado para o medidor para controlar o acionamento/status do Relê. |
Controlar acionamento do relê auxiliar | Comando enviado para o medidor para controlar o acionamento/status do Relê auxiliar. |
Controlar acionamento do alarme | Comando enviado para o medidor para controlar o acionamento/status dos alarmes. |
Controlar função pânico | Comando enviado para o medidor para controlar o acionamento/status da função pânico. |
Listar Status dos Alarmes | Comando enviado para buscar o estado atual dos alarmes do medidor. |
Buscar Localização | Comando enviado para buscar a localização do medidor (configurado via interface WEB). |
Buscar Configuração | Comando enviado para pegar a configuração do medidor. |
Configurar medidor | Comando enviado para configurar o medidor. |
Restaurar Configuração do medidor | Comando enviado para restaurar a configuração do medidor para a configuração de padrão/fabrica. |
Reiniciar o equipamento | Comando enviado para reiniciar o medidor. |
Atualizar o firmware do equipamento | Comando enviado para realizar o update de firmware do medidor. |
Buscar Data/Hora atual do equipamento | Comando enviado para solicitar DATA e HORA atual do medidor MGE. |
Configurar Data/Hora do equipamento | Comando enviado configurar a DATA e HORA atual do medidor MGE. |
Buscar Lista de acesso | Comando utilizado para buscar a lista de acesso realizados no medidor. |
Remover lista de acesso | Comando utilizado para remover a lista de acesso realizados no medidor |
Emitir Beep | Comando utilizado para emitir um beep curto ou longo. |
Eventos
Eventos enviados pelo medidor para a Aplicação | |
---|---|
Evento de relê | Evento enviado pelo medidor informando status estado de relê. |
Evento de Sensor | Evento enviado pelo medidor informando status estado de sensor. |
Evento de Temperatura e Umidade | Evento enviado pelo medidor informando status/alteração nos níveis de temperatura e umidade. |
Evento de Detecção de Gás | Evento enviado pelo medidor informando status/alteração nos níveis de detecção de gás. |
Evento de sensor de Nível | Evento enviado pelo medidor informando status do sensor de nível. |
Evento de sensor de Volume | Evento enviado pelo medidor informando status do sensor de volume. |
Evento de Detecção de Movimento | Evento enviado pelo medidor informando status de detecção de movimento. |
Evento de Arrombamento | Evento enviado pelo medidor informando que foi detecção de arrombamento de porta. |
Evento Mifire / NFC | Evento enviado pelo medidor informando status de cartão lido. |
Evento RF433 Code | Evento enviado pelo medidor informando status de cartão/controle RF 433 lido. |
Evento Fingerprint | Evento enviado pelo medidor informando status de biometria lida. |
Evento Fingerprint Status (Enrolment) | Evento enviado pelo medidor informando o status de cadastro de uma biometria (Enrolment). |
Evento de Usuário e Senha | Evento enviado pelo medidor informando nova requisição de acesso por usuário e senha. |
Evento QR Code | Evento enviado pelo medidor informando status de leitura de QR Code. |
Evento Add User | Evento enviado pelo medidor informando que um novo usuário foi adicionado. |
Evento Del User | Evento enviado pelo medidor informando que um usuário foi removido. |
Evento de Cadastro Automático de Usuário | Evento enviado pelo medidor informando o status do cadastro automático de usuário (enviado após o comando probeuser. |
Evento de Remoção Automática de Usuário | Evento enviado pelo medidor informando o status da remoção automática de usuário (enviado após o comando eraseuser. |
Evento de Alarme | Evento enviado pelo medidor informando novo status de alarme. |
Evento Pânico | Evento enviado pelo medidor informando status da função pânico. |
Evento de Boot | Evento enviado pelo medidor informando Boot do medidor. |