MGE/API
De uTech Tecnologia
(Diferença entre revisões)
(→Comandos) |
(→Eventos) |
||
| Linha 145: | Linha 145: | ||
| Evento enviado pelo medidor informando status estado de relê. | | Evento enviado pelo medidor informando status estado de relê. | ||
|- | |- | ||
| − | ! scope="row" style="width: 30%" align="right"| [[MGE/API/ | + | ! scope="row" style="width: 30%" align="right"| [[MGE/API/EvtPower|'''Evento Power''']] |
| − | | Evento enviado pelo medidor informando | + | | Evento enviado pelo medidor informando alteração no status de alarmes. |
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
|} | |} | ||
Edição atual tal como 18h38min de 8 de janeiro de 2021
API de integração com medidor uTech MGE
Tabela de conteúdo |
[editar] Protocolo / Formato das requisições
[editar] 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).
[editar] Métodos e Formatos
[editar] 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"
}
|
|---|
[editar] 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
[editar] Autenticação
Para acesso com usuário e senha, é usulizado o método e autenticação Basic'. Veja sobe em: Basic Authentication
[editar] 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. |
| 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. |
[editar] Eventos
| Eventos enviados pelo medidor para a Aplicação | |
|---|---|
| Evento de relê | Evento enviado pelo medidor informando status estado de relê. |
| Evento Power | Evento enviado pelo medidor informando alteração no status de alarmes. |
