Manual do usuário

IED102

1
Índice
1. Introdução ……………………………………………………………………………………………………………………………..... página 3
2. Apresentação …………………………………………………………………………………………………………………….…… página 3
3. Informações técnicas …………………………………………………………………………………………………………… página 3
3.1. Principais características do IED102 …………….………………………………………………………… página 4
3.2. Conexões, LEDs e botão RESET …………….………………………………………………………………… página 4
4. Instalação ………….……………………………………………………………………………..……………………………………… página 6
4.1. Fixando o IED102 no local de operação ……….………………………………………………………… página 6
4.2. Modelos de aplicação …………….…………………………………………………………………………………… página 7
5. Acesso à Interface Web ……………….……………………………………………………………………………………… página 9
6. Configurando o sistema via Interface Web ……………….……………………………………………………… página 10
6.1. Painel de informações ……………..………………………………………………………………………………… página 10
7. Configurações ………………………………………………………………………………………………………………………… página 11
7.1. Configuração de rede …………..……………………………………………………………………………………… página 11
8. Configuração MQTT ……………………………………………………………………………………………………………… página 12
8.1. Configuração de APNs …………..…………………………………………………………………………………… página 13
8.2. Configuração de servidores da internet ………..……………………………………………………… página 14
8.3. Upload de certificados ………………………………………………………………………………………………… página 14
8.4. Update de software ……………………………………………………………………………………………………… página 15
8.5. Sincronizar data e hora ………….…………………………………………………………………………………… página 15
9. Restaurar configurações de fábrica …………………………………………………………………………………. página 14
10. API MQTT ……………………………………………………………………………………………………………………………… página 15
10.1. Estabelecendo conexão MQTT com o IED102 …………………………………………………… página 15
10.2. Definições do protocolo de comunicação ………………………………………………………….. página 17
10.3. Tipos de dados e validação da API ………………………………………………………………………. página 17
11. MQTT publishing …………………………………………………………………………………………………………………… página 18
12. MQTT subscribing ………………………………………………………………………………………………………………… página 20
13. Obter acesso à documentação adicional ……………………………………………………………………… página 27

2
1. Introdução
Este manual apresenta os procedimentos para instalação, configuração e monitoramento do
IED102 da Khomp. Para informações mais detalhadas dos produtos, consulte os demais documentos no
site da Khomp.

2. Apresentação
IED102 é uma solução para telemetria de dados de energia. Os dados são coletados a partir da
saída de usuário (saída óptica), disponibilizada por medidores, de acordo com o protocolo descrito na
norma ABNT NBR 14522. Os dados são transmitidos ao servidor através de rede celular (2G/3G) ou rede
Ethernet. Pode ser utilizado para medição de clientes do grupo A.

3. Informações técnicas
● Rede: 2 portas RJ45 fast Ethernet 10/100 Mbps.
● Conectores de saída pulsada:
● SU - IN.
● SU - OUT (replica o sinal).
● 3G: Entrada interna para SIM card.
● SIM card: Modelo mini SIM (2FF).
● Banda disponível:
● 3G: 800/850/900/1900/2100 MHz.
● 2G: 850/900/1800/1900 MHz.
● Antena: 3 dBi.
● Dimensões (CxLxA): 142,4x110,9x28,9 mm.
● Fonte de energia: 100 VAC a 240 VAC, 50/60 Hz.
● Consumo máximo de energia: 6 W.
● Temperatura de operação: 0 °C a 60 °C.
● Temperatura de armazenamento: 0 °C a 85 °C. 3
● Umidade de operação/armazenamento: 10 a 90% não condensado.
3.1. Principais características do IED102

● Realiza a leitura da "Saída Pulsada do Usuário" e registra em memória os frames coletados.

● Projetado para armazenar frames por 20 dias, em caso de falta de comunicação.
● Interface de acesso à internet por meio das redes 2G, 3G e Ethernet.
● Suporta configuração de APN privada ou pública.
● A comunicação com o servidor é baseada no protocolo MQTT.
● Status é enviado quando o sistema é iniciado e a cada 15 minutos (frequência parametrizável).
● Envio de eventos da Remota a cada 15 minutos (frequência parametrizável).
● Atualização de software local e remotamente.
● Suporta comandos via SMS.
● Possui um conjunto de LEDs para realizar a interface com o usuário, indicando o status de leitura dos
frames, a qualidade de sinal da operadora e a conexão com o servidor.
● Contém uma saída de duplicação do sinal de entrada, permitindo que outros equipamentos possam
ler a mesma medição em paralelo.
● Dispõe de um watchdog interno para restart do equipamento, em um cenário de falha no software, o
qual comprometa a comunicação.
● Possui uma interface HTTP para realizar a configuração de parâmetros do dispositivo.
● Envia paralelamente os frames pela interface ETH através do protocolo MODBUS TCP/IP.
● Atua como roteador 3G para outros dispositivos da família IED conectados via porta ETH.

3.2. Conexões, LEDs e botão RESET

Vista frontal
Na vista frontal é possível identificar somente a conexão para antena do modem 3G. A conexão
está localizada no canto inferior esquerdo da parte frontal do IED102.

Vista superior
O IED102 possui na parte superior da carcaça 4 LEDs. 3 LEDs que realizam a interface local com o
usuário e 1 LED para indicar que o dispositivo está ligado.

Legenda:

User Output: Estado da Saída do Usuário (recepção dos frames

ABNT NBR 14522).

Internet connection: Estado da conexão à internet/servidor.

GSM Signal: Nível de sinal recebido da operadora GSM.

On: Fonte de energia conectada e alimentando o dispositivo.

Os 3 primeiros LEDs são controlados com base em ciclos. O ciclo de um LED é definido como 1
segundo, e contempla um período ligado e um período desligado. Esses períodos, por sua vez, são
definidos através da configuração do Duty Cycle.
O Duty Cycle é um valor entre 0 e 1 que representa a proporção de ligado e desligado. Por exemplo,
dado um LED com Duty Cycle de 0.6, seu período ligado é 60% do ciclo, ou seja 600 ms. Da mesma
maneira, o período desligado são os 40% restantes do ciclo. 4
Assim, foram definidos os seguintes valores de Duty Cycle:
 Duty Cycle LED ligado (milissegundos) LED desligado (milissegundos)

0.0 0 1000
0.1 100 900
0.9 900 100
1.0 1000 0

Com base na definição acima, os LEDs são especificados:

User Output: LED associado ao recebimento dos frames ABNT NBR 14522 pela Saída de Usuário
(conexão óptica). Pode assumir os seguintes valores de Duty Cycle:
0.0 - Porta serial sem comunicação com o medidor.
0.1 - Porta serial com comunicação, mas frame inválido (fora da especificação).
0.9 - Porta serial com comunicação, frame dentro da especificação, mas CRC não confere.
1.0 - Porta serial com comunicação, frame válido com CRC ok.

GSM Signal: LED associado ao sinal da operadora GSM. Pode assumir os seguintes valores de Duty
Cycle:
0.0 - Nível de sinal igual à 0 ou desconhecido.
0.1 - Nível de sinal entre 1 e 5.
0.9 - Nível de sinal entre 6 e 11.
1.0 - Nível de sinal acima de 11.

Internet connection: LED associado à conexão com a internet. Pode assumir os seguintes valores de
Duty Cycle:
0.0 - Ping nos servidores com perda total de pacotes.
0.1 - Ping nos servidores com sucesso.
0.9 - Ping nos servidores de domínio com sucesso.
1.0 - Conexão ativa com o servidor.

Vista posterior
As principais conexões são observadas na parte posterior do produto. A imagem a seguir indica
cada uma das conexões.

Legenda:
1. Conector da fonte de energia 12 V.
2. Porta RJ45 fast Ethernet ETH0.
3. Porta RJ45 fast Ethernet ETH1.
4. Sinal pulsado (SU - IN).
5. Sinal pulsado (SU - OUT), interface para replicar o sinal.
6. Botão RESET, usado para reiniciar o sistema.
7. Conexão de aterramento, protege o equipamento e seus usuários de uma sobrecarga.

● O IED102 deve ser aterrado antes de ser ligado à rede elétrica.

5
Atenção ● Não abra o IED102 com o dispositivo ligado!
 O cabeamento utilizado para conexão da porta de sinal pulsado "SU - OUT" (usado para replicar o
sinal) é o mesmo utilizado na conexão da porta de sinal pulsado "SU - IN".
O cabeamento utilizado para conexão de entrada "SU - IN" é observado na imagem a seguir:

4. Instalação
Os procedimentos para correta fixação do IED102, padrões aceitáveis para o ambiente de
operação, indicações para aterramento e conexões com sensores ou outros dispositivos serão
abordados neste subtítulo.

4.1. Fixando o IED102 no local de operação

Procure por um local protegido da luz solar, onde a chuva e as atividades climáticas não tenham
contato com o produto para sua correta fixação. O local também deve ter rede elétrica aterrada no padrão
ABNT observado na norma NBR14136 (referente à padronização de tomadas e plugues).

Legenda:
1. Orifícios para encaixe
dos dois parafusos de
fixação. A carcaça possui
a distância de 10 cm
entre os encaixes.
2. Locais para colar os
quatro pinos auto
adesivos de borracha.
6
4.2. Modelos de aplicação

No segundo modelo, é possível observar um segundo IED 102 funcionando como extensor do
sistema e passando os dados para a rede da operadora.

7
 No terceiro modelo de exemplo, observamos a extensão do sistema conectada ao "Controlador de
demanda".

Em todos os modelos, a distância entre o medidor de energia e a entrada SU-IN do

IED102 não pode ser superior a 2 metros (tamanho do cabo utilizado na conexão). 8
Atenção
5. Acesso à Interface Web
A Khomp desenvolveu uma Interface Web para configurar, atualizar certificados MQTT, monitorar o
sistema, efetuar manutenções no IED102 e sincronizar o relógio do dispositivo.
Para acessar a Interface Web enquanto o IED102 estiver com as configurações de fábrica,
configure seu computador com a mesma faixa de endereço IP e máscara de sub-rede observados a
seguir. Utilize um navegador Web de sua preferência para realizar o acesso.

Endereço IP: 10.10.10.100

Máscara de rede: 255.255.255.0
Usuário: admin
Senha: khomp
A Interface Web do dispositivo utiliza o protocolo HTTPS por questões de segurança. Como o
certificado armazenado é auto assinado, no primeiro acesso do usuário, o navegador emitirá um alerta
de segurança e é necessário permitir a navegação.

O usuário deve clicar no botão "Avançado…".

Em seguida, clique no botão "Aceitar o risco e continuar".

Acessando a Interface Web é possível observar na parte superior da página o estado atual do
sistema, como é observado na imagem a seguir.

Número Serial: Número de série do IED102.

Versão SW: Indica a versão de software do sistema.
Versão HW: Indica a versão de hardware do produto.
HW Modem: Indica se existe um modem.
HW Submedição: Indica se há uma placa de submedição conectada (o IED102 não possui este atributo).
Horário: Demonstra data e hora configurados no sistema do IED102.
Sessão: Número identificador da sessão aberta na interface web (muda a cada reinício do IED102)
Logout: Botão para sair da Interface Web.

9
6. Configurando o sistema via Interface Web
6.1. Painel de informações

Ao acessar a Interface Web do IED102 o usuário é encaminhado diretamente para o Painel de

Informações. No Painel de informações é possível identificar o "Estado da Remota" e observar os
"Últimos frames recebidos". A imagem a seguir indica um exemplo do Painel de Informações.

Legenda:
Sinal GSM: Indica o nível de sinal. Demonstra nível 99 quando não houver sinal da rede GSM e 30 para
nível máximo. Na imagem, o IED102 está com nível médio de sinal, operando com nível 29.
ICCID (Integrated Circuit Card ID): É o número do SIM card utilizado.
COPS: Campo que indica a operadora do SIM card.
APN (Access Point Name): É o nome do ponto de acesso, geralmente é o nome de um gateway entre
uma rede móvel GSM e outra rede de computadores.
Conexão Server: Indica se o IED102 está conectado ao servidor MQTT.
Uptime (min): Indica quanto tempo (em minutos) o IED102 está com o sistema ativo.

Ao clicar sobre o botão "Mostrar configurações", novos atributos do sistema são apresentados,
possibilitando a configuração do IED102.

10
7. Configurações
Para acessar as configurações do IED102, clique no botão "Mostrar configurações" após ter
entrado na Interface Web do sistema. Novos atributos do sistema são apresentados, possibilitando a
configuração.

7.1. Configuração de rede

Após clicar no botão "Mostrar configurações" do painel de informações, é possível manipular as

informações do painel "Configuração de Rede". Após configurar os campos do painel "Configuração de
Rede", clique no botão "Enviar Configuração". A imagem a seguir exemplifica este painel de
configurações e indica detalhes sobre cada campo.

Método IP
Permite selecionar entre uma configuração manual da interface ETH (inserindo endereço IP,
máscara de rede e gateway padrão) ou automática (DHCP), obtendo IP de um servidor IP conectado à
mesma rede.

Servidor DHCP
O IED102 pode fornecer IPs para dispositivos conectados à mesma rede Ethernet. Essa
configuração pode ser habilitada ou desabilitada neste campo. Com a opção habilitada, os campos de
endereçamento IP exibem os valores fixos estabelecidos para o servidor DHCP sem a possibilidade de
alterar configurações e range de endereçamento.
Fornece IPs na faixa de 10.10.10.10 a 10.10.10.49, é configurado com endereço fixo no IP
10.10.10.1.

Endereço IP, Máscara de Rede e Gateway Padrão

Por meio desses três campos é possível configurar os parâmetros da interface Ethernet do
IED102, caso o Método IP selecionado seja Manual.

Usuário e senha HTTP

No painel "Mostrar configurações" também é possível alterar o usuário e senha de acesso à
Interface Web. Configure o novo usuário no campo "Nome do usuário HTTP" e sua respectiva senha no
campo "Senha HTTP". Pressione o botão "Enviar Configuração", observado no final da Interface Web,
para aplicar a configuração no sistema.

11
8. Configuração MQTT
Após clicar no botão "Mostrar configurações" do painel de informações, é possível manipular as
informações do painel "Configuração MQTT". Após configurar os campos do painel "Configuração
MQTT", clique no botão "Enviar Configuração", observado no final da Interface Web. A imagem a seguir
exemplifica este painel de configurações e detalhes específicos de cada campo são dados a seguir.

Interface de saída
Neste campo é possível selecionar qual interface será utilizada para comunicação com o servidor
através do protocolo MQTT. As opções são: "Modem (3G)" para utilizar a rede GPRS e "Ethernet", para
utilizar a rede cabeada.

Endereço do broker MQTT

O endereço do servidor broker MQTT pode ser alterado no painel "Mostrar configurações". Aplique
o endereço no campo "Endereço do servidor broker MQTT" e pressione o botão "Enviar Configuração"
para aplicar a configuração no sistema.

Nome do usuário do broker e Senha broker

No painel "Mostrar configurações" é possível observar o usuário e senha broker. Para alterar,
descreva o novo usuário no campo "Nome do usuário broker" e sua respectiva senha de acesso no
campo "Senha broker".
Após configurar os campos, clique no botão "Enviar Configuração", observado no final da
Interface Web.

Período de envio de Logs

O período (em segundos) para envio de Logs do IED102 pode ser alterado no campo "Período de
envio de logs". O período de envio é padronizado em 900 segundos. Pressione o botão "Enviar
Configuração", observado no final da Interface Web, para aplicar a configuração no sistema.Este
período é referente à "remota/<esn>/logs".

Períodos de envio do frame medidor

Após clicar no botão "Mostrar configurações" do Painel de Informações e ter acessado o menu
"Configuração MQTT", é possível manipular as informações do período de envio do frame medidor.
Configure os campos deste painel e clique no botão "Enviar Configuração", observado no final da
Interface Web.

Período de reporte de estado

O período (em segundos) para reporte do estado de operação do IED102 pode ser alterado no campo
"Período de reporte de estado". O período de reporte é padronizado em 900 segundos. Pressione o
botão "Enviar Configuração", observado no final da Interface Web, para aplicar a configuração no
sistema. Este período é referente à "remota/<esn>/status".

12
8.1. Configuração de APNs

Após clicar no botão "Mostrar configurações" do Painel de Informações, é possível manipular as

informações do painel "Configuração de APNs" (Access Point Name) para conexão 3G. A imagem a
seguir exemplifica este painel de configurações.

Legenda: Imagem da interface que vai ser configurada.

Legenda: Imagem de exemplo da interface configurada.

Após configurar os campos deste painel, clique no botão "Enviar Configuração", observado no
final da Interface Web. Abordaremos mais detalhes de cada campo a seguir.

Endereço APN, usuário e senha

No painel APN é possível alterar os endereços APNs e seus respectivos usuários/senhas.
Configure o novo endereço APN em um campo vazio do painel. O usuário pode ser configurado no
campo "Usuário" e sua respectiva senha no campo "Senha". Na Interface Web é possível configurar até
6 APN’s com respectivos usuários e senhas. Pressione o botão "Enviar Configuração", observado no
final da Interface Web, para aplicar a configuração no sistema. A configuração via comandos MQTT
possibilita programar até 10 APN’s.

13
8.2. Configuração de servidores da internet

Mostrar configurações" do Painel de Informações, é possível manipular as informações do painel

"Servidores Internet". A imagem a seguir exemplifica este painel de configurações.

Neste painel é possível indicar 3 endereços IP, e 3 ISN's para teste de conexão com o IED102.
Após configurar os campos deste painel, clique no botão "Enviar Configuração", observado no
final da Interface Web.

8.3. Upload de certificados

Na Interface Web é possível observar o botão "Certificados". Pressione o botão para abrir a
interface de atualização de certificados.

Esta interface possibilita a atualização da "Unidade Certificadora (CA)", renovação do "Certificado

(CRT)" e upgrade da "Chave Privada (KEY)".
Selecione o arquivo clicando no botão "Escolher arquivo" e solicite a atualização ao clicar no
botão "Enviar Certificados".

14
8.4. Update de software

Na Interface Web é possível observar o botão "Manutenção". Pressione o botão para abrir a
interface de atualização de software.

O software atual é indicado na barra superior de estado na Interface Web. Clique no botão
"Escolher arquivo" para selecionar o arquivo de atualização. É possível selecionar o campo "Restore"
para que o sistema seja reiniciado após a atualização. Clique no botão "Update de software" para
atualizar o software do dispositivo.

8.5. Sincronizar data e hora

Na Interface Web é possível observar o botão "Sincronizar". Pressione o botão para abrir a
interface de atualização da data e hora do sistema.

Clique no botão "Confirmar" para atualizar a data e hora do sistema.

9. Restaurar configurações de fábrica

Para restaurar as configurações do sistema para o padrão de fábrica, aplique as indicações
observadas a seguir.

1. Tirar a alimentação do IED e preparar a ponta de um clipe para pressionar o botão de RESET.

2. Religue a alimentação de energia do IED com o botão RESET pressionado por 5 segundos.

3. Ao final do tempo, solte o botão RESET.

4. Acessar a Interface Web do IED no padrão de fábrica (IP: 10.10.10.100).

5. O sistema disponibilizará a indicação observada na imagem:

Não utilize o botão

Nota "Procurar…" para
atualizar o firmware!

15
3. Clicar em "Reset device to factory state" e aguardar mensagem indicada na imagem a seguir:

4. Após 1 minuto, limpe o cache de memória do navegador e acesse a Interface Web no IP

10.10.10.100.

5. O IED estará na configuração padrão para acesso à Interface Web:

Login: admin
Senha: khomp

6. As configurações de broker MQTT e de rede serão perdidas. É necessário configurar o sistema para
utilizar as funções novamente.

10. API MQTT

Esta seção fornece as informações técnicas necessárias para estabelecer uma comunicação
funcional com o IED102 através do protocolo MQTT, onde são descritos os parâmetros para se
estabelecer um canal de comunicação ativo, são detalhados todos os dados enviados e comandos
recebidos pelo produto. Para informações sobre o protocolo MQTT, consultar a documentação oficial
do protocolo em http://mqtt.org/.
O protocolo MQTT (Message Queue Telemetry Transport) é o padrão de envio/recebimento de
dados adotado pelo IED102, considerando sua versatilidade, facilidade de integração com outras
aplicações e reduzido consumo de dados. O protocolo é baseado no padrão publicador-subscritor
(publisher-subscriber), onde um broker é responsável por fazer a intermediação da troca de mensagens
entre dois clientes distintos.

10.1. Estabelecendo conexão MQTT com o IED102

O primeiro passo para estabelecer uma comunicação MQTT com o IED102 é criar um servidor
(broker) MQTT para que o IED102 possa realizar publicações e receber comandos. A implementação,
configuração e manutenção do broker é de responsabilidade do cliente, e detalhes sobre esse
procedimento não serão indicados neste manual. O broker deve considerar as definições listadas em
"Definições do protocolo de comunicação" para que a comunicação com o IED102 funcione
corretamente.
Assim que o broker estiver devidamente configurado e disponível, basta realizar a configuração
do IED102 para realizar a conexão através da Interface Web, no campo "Configuração MQTT". Os
parâmetros "Endereço do broker MQTT", "Nome do usuário broker" e "Senha broker" devem ser
ajustados de acordo com o broker. Além disso, caso o broker contenha certificação SSL, é necessário
enviar os certificados gerados para o IED102 através do campo "Certificados", também na Interface
Web.

16
 Após esses passos terem sido executados com sucesso, o IED102 irá se conectar
automaticamente ao broker configurado e iniciará as publicações conforme os períodos configurados
no campo "Configuração MQTT" na Interface Web. O equipamento também estará recebendo qualquer
comando enviado, de acordo com os tópicos descritos na seção "MQTT subscribing".

10.2. Definições do protocolo de comunicação

1. O protocolo MQTT opera em 2 portas padrões:

● Porta 1883 - aberta (sem autenticação ou com autenticação por usuário e senha).

● Porta 8883 - protocolo SSL com certificados requeridos.

2. O endereço MQTT a ser configurado deve obedecer à seguinte sintaxe:
● tcp://test.mosquitto.org:1883 - TCP sem segurança.
● ssl://test.mosquitto.org:8883 - SSL.

Requer a atualização dos certificados através do campo "Certificados" na Interface Web.

Nota

3. Todas as mensagens publicadas ou recebidas pelo IED102 estão estruturadas em formato JSON
(json.org), organizadas de acordo com o esquema "chave-valor".
4. Todo JSON enviado e recebido deve conter o parâmetro timestamp representado pelo formato
"YYYY-MM-DDThh:mm:ss" (ISO 8601). É utilizado para estatísticas de delay/latência/controle do pacote
a nível de aplicação.
5. Os tipos de dados finais (elementares) possíveis são apenas Number, String, Boolean, Null. No
entanto, um valor que acompanha uma chave no objeto JSON pode também ser do tipo Object ou Array
(que, por sua vez, conterão outros dados mais elementares). Os tipos de cada parâmetro de cada
tópico estão descritos na seção correspondente.
6. Por padrão, apenas os tópicos "remota/<esn>/connection_status", "remota/<esn>/login" e
"remota/<esn>/status" são configurados como retidos, ou seja, a última mensagem enviada nesses
tópicos é armazenada e enviada para cada cliente que se conecta a esses tópicos. Para configuração
de tópicos retidos/não retidos, consulte "remota/<esn>/commands/mqtt_params".

7. A inscrição do IED102 nos tópicos de comando ("MQTT subscribing") é efetuada com QoS igual a 1.
Para que haja garantia na entrega das mensagens de comando, é necessário que a aplicação publique
as mensagens nesses tópicos também com QoS igual a 1 (pelo menos).

10.3. Tipos de dados e validação da API

1. Todos os comandos devem ter tipo de dados definidos.

2. A validação dos tipos de dados é obrigatória.
3. Os valores mínimos e máximos dos parâmetros são obrigatórios e devem ser validados quando tais
limites estejam descritos no comando.
4. Apenas os tipos de dados são verificados, entretanto em alguns comandos existe uma checagem
adicional, além do tipo de dados:
● IP (tipo string): Deve aceitar apenas endereço IP.
● Níveis de log (tipo string): Nos respectivos comandos, está listado quais os tipos de logs são
permitidos.
17
11. MQTT publishing
Nessa seção são listados e descritos todos os tópicos MQTT utilizados pelo IED102 para publicar
dados. Para receber esses dados, o usuário/aplicação deve conectar um cliente MQTT ao mesmo
broker configurado no IED102 e inscrevê-lo nos tópicos desejados. Cada tópico contempla um conjunto
específico de dados, que podem ser relacionados à aquisição (frames com informações de energia
coletados do medidor) ou ao próprio funcionamento e estado do equipamento (informações gerais do
produto, registro de eventos, configuração atual). Para cada tópico, os eventos de publicação são
distintos, podendo ser periódicos (com o período definido pelo usuário), a partir de requisição ou
disparados por eventos registrados pelo IED102.
Cada subseção (que corresponde a um tópico específico) contém a assinatura do tópico, uma
breve descrição da informação publicada e a estrutura JSON das mensagens publicadas, com o tipo e
descrição de cada chave contida. Na assinatura dos tópicos, a indicação "<esn>" deve ser substituída
pelo número serial do IED102 (assim, como exemplo, um IED102 com número serial "756324" irá
publicar mensagens de login no tópico "remota/756324/login", por exemplo).

● remota/<esn>/frames
Tópico com os frames em codificação ABNT NBR14522 recebidos pelo IED102 através da porta
de Saída de Usuário. Os frames são enviados na íntegra, ou seja, sem decodificação/processamento,
exatamente da maneira como o medidor enviou. O máximo de frames enviados em uma publicação é
de 100 unidades. Caso o IED102 fique, por exemplo, o dia todo sem conexão de dados/servidor
offline/entre outros, quando a conexão com o servidor for restabelecida, os frames serão enviados de
100 em 100, até que todos sejam enviados. Mensagens são publicadas neste tópico com período
parametrizável (padrão de fábrica: 15 minutos), sempre que existir registro de frames no período.
● Formato:
● cmd [string]: nome do comando interno de publicação da mensagem
● esn [string]: número serial do IED102
● frames [array]: lista contendo os frames recebidos desde a última publicação neste tópico
● fc [number]: número identificador do frame dentro do intervalo de medição (frame counter)
● pt [number]: protocolo do frame (0 = normal, 1 = estendido) (protocol type)
● frame [string]: frame recebido
● ts [string]: data e horário de registro do frame
● timestamp [string]: data e horário da publicação da mensagem

● remota/<esn>/connection_status
Tópico contendo unicamente a informação de estado de conexão do equipamento ao broker
MQTT. Este tópico é configurado como o recurso Last Will (ou Testament) do MQTT, de forma que, caso
o broker detecte a desconexão do dispositivo, automaticamente uma mensagem é publicada com esta
informação neste tópico.
● Formato:
● status [string]: Texto informando o atual estado de conexão do dispositivo ao broker MQTT.

● remota/<esn>/login
Tópico com informações básicas publicado toda vez que o IED102 se conecta ao broker.
● Formato:
● cmd [string]: Nome do comando interno de publicação da mensagem.
● esn [string]: Número serial do IED102.
● iccid [string]: Número identificador do cartão SIM.
● uptime [number]: Tempo desde a última inicialização (em minutos).
● protocol [string]: Protocolo MQTT utilizado.
● version [string]: Versão de software.
● board_model [string]: Modelo de hardware.
● timestamp [string]: Data e horário da publicação da mensagem.

18
● remota/<esn>/status
Tópico com mensagens de status do IED102, contendo informações básicas do produto e da
configuração atual. Mensagens são publicadas neste tópico com período parametrizável (padrão de
fábrica: 15 minutos).
● Formato:
● apn_list [array]: Lista de arrays contendo endereço, usuário e senha das APNs
cadastradas para conexão. Exemplo: "apn_list": [["apn1", "user_apn1", "password_apn1"],
["apn2", "user_apn2", "password_apn2"]]
● board_model [string]: Modelo de hardware.
● cmd [string]: Nome do comando interno de publicação da mensagem.
● esn [string]: Número serial do IED102.
● iccid [string]: Número identificador do cartão SIM .
● internet_server_lists [object]: Objeto contendo informações dos servidores utilizados para
teste de conexão à internet.
● ip_list [array]: Lista de strings contendo os endereços dos servidores.
● isn_list [array]: Lista de strings contendo os nomes de domínio dos servidores.
● mqtt_configuration [object]: Objeto contendo as informações de configuração da
comunicação MQTT.
● broker_address [string]: Endereço do broker MQTT.
● broker_password [string]: Senha de conexão ao broker MQTT.
● broker_username [string]: Nome de usuário de conexão ao broker MQTT.
● frames_frequency [number]: Período de publicação no tópico "remota/<esn>/frames".
● logs_frequency [number]: Período de publicação no tópico "remota/<esn>/logs".
● output_interface [number]: Código da rede que está sendo utilizada para publicações
no MQTT (1 = modem, 2 = Ethernet).
● status_frequency [number]: Período de publicação no tópico "remota/<esn>/status"
● network_configuration [object]: Objeto contendo as informações de configuração de
conexão à rede Ethernet.
● default_gateway [string]: Endereço do gateway.
● dhcp_server [number]: Indicador de ativação do modo de servidor DHCP: fornece IP
para outros dispositivos da família IED conectados a uma rede Ethernet local e pode
encaminhar pacotes MQTT funcionando como gateway através da rede celular. (1 =
desligado, 2 = ligado).
● http_password [string]: Senha de acesso à Interface Web.
● http_username [string]: Nome de usuário de acesso à Interface Web.
● ip_address [string]: Endereço IP do IED102.
● ip_method [number]: Método IP selecionado (1 = manual, 2 = automático (DHCP)).
● ip_method [number]: método IP selecionado (1 = manual, 2 = automático (DHCP)).
● net_mask [string]: Máscara de sub-rede.
● op [string]: código da operadora selecionada para conexão à rede celular.
● rssi [number]: Indicador de qualidade do sinal recebido da rede celular.
● timestamp [string]: Data e horário da publicação da mensagem.
● uptime [number]: Tempo desde a última inicialização (em minutos).
● version [string]: Versão de software.

19
● remota/<esn>/logs
Tópico contendo mensagens de informação sobre eventos ocorridos no funcionamento do
produto. Mensagens são publicadas neste tópico com período parametrizável (padrão de fábrica: 15
minutos), sempre que existir registro de um ou mais eventos no período.

● Formato:
● cmd [string]: Nome do comando interno de publicação da mensagem.
● logs [array]: Lista de objetos contendo informações sobre cada log registrado no período.
● log [string]: Mensagem sobre o evento ocorrido.
● log_id [number]: Número classificador do evento (0 = modem e conexão com a
operadora, 1 = sistema, 2 = outros, 3 = atualizações, 4 = interface web, 5 = aquisição, 6
= erros de comandos executados pelo servidor MQTT).
● timestamp [string]: Data e horário de registro do evento.
● timestamp [string]: Data e horário da publicação da mensagem.

12. MQTT subscribing

Nessa seção são listados e descritos todos os tópicos MQTT que estão disponíveis para serem
utilizados pelo usuário/aplicação para enviar comandos para o IED102. No momento em que se
conecta ao broker, o IED102 se inscreve (realiza o subscribing) na assinatura
"remota/<esn>/commands/+", passando então a receber todas as mensagens publicadas nessa
assinatura. Cada tópico corresponde a um comando específico, que pode representar uma simples
instrução de execução de procedimento (como executar o sincronismo do relógio interno) até o envio
de dados de configuração (como configurar o período de envio dos frames coletados através da Saída
de Usuário, por exemplo).
Cada subseção (que corresponde a um tópico específico) contém a assinatura do tópico, uma
breve descrição do que o comando representa, a estrutura JSON esperada pelo IED102 ao receber a
mensagem MQTT e um exemplo de mensagem no formato JSON. Na assinatura dos tópicos, a
indicação "<esn>" deve ser substituída pelo número serial do IED102 (assim, o comando de sincronismo
de relógio para um IED102 com número serial "756324" deverá ser publicado no tópico
"remota/756324/commands/sync_clock", por exemplo).
É importante ressaltar que para evitar problemas relacionados à perda de pacote no envio do
comando, deve-se utilizar QoS 1 (no mínimo) no momento de publicar o comando no broker. Isto deve
ser feito independentemente do "client MQTT" utilizado e garante que o comando seja entregue ao
broker.

● remota/<esn>/commands/mqtt_qos

Comando para configurar o QoS (Quality of Service) dos tópicos de publicação do equipamento
(exceto tópico connection_status). O QoS indica o nível de garantia de entrega das mensagens
publicadas pelo equipamento no broker MQTT (veja a documentação do protocolo MQTT para mais
detalhes). Os valores aceitos de QoS são 0 (At Most Once), 1 (At Least Once) e 2 (Exactly Once). É
importante ressaltar que o QoS correspondente à recepção dos tópicos por parte de um outro cliente
inscrito é determinado pelo menor QoS na cadeia.

● Formato
● login [integer]: QoS de publicação do tópico ‘login’. O valor padrão é 1.
● status [integer]: QoS de publicação do tópico ‘status’. O valor padrão é 0.
● frames [integer]: QoS de publicação do tópico ‘frames’. O valor padrão é 0.
● logs [integer]: QoS de publicação do tópico ‘logs’. O valor padrão é 0.

20
 ● Exemplo

{
"login": 1,
"status": 0,
"frames": 2,
"logs": 0,
}

● remota/<esn>/commands/sync_clock
Comando para requisitar o sincronismo de clock do IED102. Os comandos publicados neste
tópico só serão aplicadas caso forem enviados após o IED102 publicar a primeira mensagem no tópico
"remota/<esn>/status".

● Formato
● cmd [string]: "sync_clock"
● timestamp [string]: data e horário da publicação da mensagem no broker
● Exemplo

{
"cmd":"sync_clock",
"timestamp":"2018-10-29T14:34:57"
}

● remota/<esn>/commands/factory_reset
Comando para requisitar a operação de reset de fábrica do IED102, restaurando todas as
configurações para seu valor padrão.

Esse comando desfaz as configurações MQTT também, sendo necessário aplicar a

configuração novamente via Interface Web. Além disso, todos os dados armazenados
Atenção
(frames, logs, alarmes) são apagados.

● Formato
● cmd [string]: "factory_reset"
● timestamp [string]: data e horário da publicação da mensagem no broker
● Exemplo

{
"cmd":"factory_reset",
"timestamp":"2018-10-29T14:34:57"
}

21
● remota/<esn>/commands/software_update
Comando para realizar a atualização da versão de software do IED102. Se a atualização ocorrer
com sucesso, o IED102 deve reiniciar. Ao reconectar, vai apresentar a nova versão de software (que
pode ser verificada em "remota/<esn>/login" ou "remota/<esn>/status"). No caso de falha na
atualização, existem duas possibilidades: O IED102 reinicia e desconecta do broker, ou não reinicia e
mantém a conexão - em ambos os casos, um log com o problema detectado deve ser registrado.

● Formato
● cmd [string]: "software_update"
● url [string]: endereço URL contendo a imagem de atualização (arquivo .bin). URLs do
Google Drive não são válidas para este comando. Recomenda-se a instanciação de um
serviço HTTP no mesmo servidor do broker MQTT para hospedar o arquivo de atualização.
● factory_reset [boolean]: seleção de restauração da configuração de fábrica após
atualização (false = mantém configurações atuais, true = restaura configuração de fábrica).
Atenção: a restauração para o padrão de fábrica retorna todas as configurações para seus
valores padrão, bem como apaga todos os registros armazenados (frames,, logs, alarmes)
● timestamp [string]: data e horário da publicação da mensagem no broker
● Exemplo

{
"cmd":"software_update",
"url":"https://serverHTTP/remota-update-image.bin",
"factory_reset":true,
"timestamp":"2018-10-29T14:34:57"
}

● remota/<esn>/commands/server_address
Comando para configurar o endereço do broker MQTT.

● Formato
● cmd [string]: "server_address"
● url [string]: endereço do broker MQTT a ser utilizado. Mais detalhes sobre a configuração
da conexão com o broker podem ser vistos em 9.2. Definições do protocolo de
comunicação.
● timestamp [string]: data e horário da publicação da mensagem no broker
● Exemplo

{
"cmd":"server_address",
"url":"ssl://test.mosquitto.org:8884",
"timestamp":"2018-10-29T14:34:57"
}

22
● remota/<esn>/commands/remote_login
Comando para configurar os dados de autenticação (nome de usuário e senha) do IED102TC no
broker MQTT.

● Formato
● cmd [string]: "remote_login"
● user [string]: nome de usuário
● passwd [string]: senha
● timestamp [string]: data e horário da publicação da mensagem no broker
● Exemplo

{
"cmd":"remote_login",
"user":"urem23",
"passwd":"remi345f",
"timestamp":"2018-10-29T14:34:57"
}

● remota/<esn>/commands/local_login
Comando para configurar os dados de autenticação da Interface Web de configuração e
monitoramento do IED102.

● Formato
● cmd [string]: "local_login"
● user [string]: nome de usuário
● passwd [string]: senha
● timestamp [string]: data e horário da publicação da mensagem no broker

● Exemplo

{
"cmd":"local_login",
"user":"admin",
"passwd":"P4ssw0rd",
"timestamp":"2018-10-29T14:34:57"
}

23
● remota/<esn>/commands/tasks_frequency
Comando para configurar os períodos de publicação de mensagens nos tópicos MQTT. A
configuração só está disponível para os tópicos nos quais há configuração periódica (os demais são
enviados a partir de requisições).

● Formato
● cmd [string]: "tasks_frequency"
● send_measures [number]: período de publicação do tópico remota/<esn>/measures
● send_logs [number]: período de publicação do tópico remota/<esn>/logs
● send_status [number]: período de publicação do tópico remota/<esn>/status
● timestamp [string]: data e horário da publicação da mensagem no broker
● Exemplo

{
"cmd":"tasks_frequency",
"send_logs":1800,
"send_status":1800,
"timestamp":"2018-10-29T14:34:57"
}

● remota/<esn>/commands/apn_list
Comando para configurar a lista de APNs (Access Point Names) utilizadas pelo IED102 para
estabelecer conexão com a internet através da rede celular. As APNs só são utilizadas caso o IED102
esteja configurado para utilizar o modem como interface para conexão à internet.

● Formato
● cmd [string]: "apn_list"
● new_list [array]: lista contendo informações sobre as APNs de conexão a serem utilizadas
pelo IED102. Cada item da lista deve ser um array contendo três strings, onde o primeiro
índice se refere ao endereço da APN, o segundo ao usuário da APN e o terceiro à senha.
Exemplo: [<apn>, <apn_user>, apn_passwd]. A lista deve conter no máximo 10 elementos
para que a configuração seja aplicada.
● timestamp [string]: data e horário da publicação da mensagem no broker

● Exemplo

{
"cmd":"apn_list",
"new_list":[
["tmdata.vivo.com.br", "tmdata", "tmdata"],
["datatem.vivo.com.br", "datatem", "datatem"],
["inlog.vivo.com.br", null, null]
],
"timestamp":"2018-10-29T14:34:57"
}

24
● remota/<esn>/commands/server_ip_list
Comando para configurar os servidores utilizados pelo IED102 e testar a conexão com a internet.

● Formato
● cmd [string]: "server_ip_list"
● new_list [array]: lista contendo dados do tipo string correspondendo aos endereços IPs dos
servidores a serem utilizados para teste da conexão à internet. A lista deve conter no
máximo 5 elementos para que a configuração seja aplicada
● timestamp [string]: data e horário da publicação da mensagem no broker
● Exemplo

{
"cmd":"server_ip_list",
"new_list":["200.160.2.3", "177.11.80.10", "8.8.8.8"],
"timestamp":"2018-10-29T14:34:57"
}

● remota/<esn>/commands/server_name_list
Comando para configurar a lista de nomes de domínio (DNS) utilizados pelo IED102 para teste de
conexão à internet. É importante que os nomes de domínio inseridos correspondam (não importando a
ordem em que forem inseridos) aos endereços IPs configurados no comando
"remota/<esn>/commands/server_ip_list".

● Formato
● cmd [string]: "server_name_list"
● new_list [array]: lista contendo dados do tipo string correspondendo aos nomes de domínio
(DNS) dos servidores a serem utilizados para teste da conexão à internet. A lista deve
conter no máximo 5 elementos para que a configuração seja aplicada.
● timestamp [string]: data e horário da publicação da mensagem no broker
● Exemplo

{
"cmd":"server_name_list",
"new_list":["google.com", "registro.br"],
"timestamp":"2018-10-29T14:34:57"
}

● remota/<esn>/commands/dns_server_list
Comando para configurar a lista de servidores DNS utilizados pelo IED102 para a resolução de
endereços de acesso.

● Formato
● cmd [string]: “dns_server_list”

● new_list [array]: lista contendo dados do tipo string correspondendo aos endereços IP dos

servidores DNS. A lista deve conter no máximo 3 elementos para que a configuração seja
aplicada
● timestamp [string]: data e horário da publicação da mensagem no broker

● Exemplo
{
"cmd":"dns_server_list",
"new_list":["8.8.8.8", "8.8.4.4"],
25
"timestamp":"2018-10-29T14:34:57"
}
● remota/<esn>/commands/mqtt_params
Comando para configurar os parâmetros da conexão MQTT do IED102 ao broker.

● Formato
● cmd [string]: "mqtt_params"
● keep_alive [number]: intervalo de tempo máximo, em segundos, em que o broker e o
IED102 podem permanecer sem troca de pacotes. É utilizado para verificar se a
comunicação entre os dois continua ativa (caso esse tempo seja atingido e nenhuma
pacote tenha sido trocado, o IED102 será desconectado e tentará se conectar novamente).
Para mais detalhes, ler a especificação do protocolo MQTT. Esta chave deve assumir um
valor inteiro entre 100 e 900, inclusive.
● retained [array]: lista contendo os parâmetros de configuração de quais tópicos serão
retidos ou não no broker MQTT - um tópico configurado para reter mensagens sempre
armazena a última mensagem recebida. A lista deve conter 6 valores inteiros que devem
assumir valor "0" (publicação não retida) ou "1" (publicação retida). Cada índice da lista
corresponde a um tópico de publicação: 0 = login, 1 = status, 2 = frames, 3 = logs, 4 =
measures, 5 = alarms, 6 = connection status.
● timestamp [string]: data e horário da publicação da mensagem no broker
● Exemplo

{
"cmd":"mqtt_params",
"keep_alive":100,
"retained":[1, 1, 0, 0, 0, 0, 1],
"timestamp":"2018-10-29T14:34:57"
}

No exemplo indicado anteriormente, o resultado é que somente as mensagens dos

Nota
tópicos login e status serão retidas.

● remota/<esn>/commands/ntp_server_list
Comando para configurar a lista de servidores NTP utilizados pelo IED102 para sincronismo do
relógio interno.

● Formato
● cmd [string]: “ntp_server_list”
● new_list [array]: lista contendo dados do tipo string correspondendo aos endereços IP dos
servidores NTP. A lista deve conter no máximo 3 elementos para que a configuração seja
aplicada
● timestamp [string]: data e horário da publicação da mensagem no broker

● Exemplo

{
"cmd":"ntp_server_list",
"new_list":["a.ntp.br", "b.ntp.br", "c.ntp.br"],
"timestamp":"2018-10-29T14:34:57"
} 26
13. Obter acesso à documentação adicional
Você encontra o manual e outros documentos em nosso site, www.khomp.com. Veja a seguir
como se cadastrar e acessar nossa documentação:

Para usuários que não possuem cadastro:

1. No site da Khomp, acesse o menu "Suporte Técnico" → "Área restrita".
2. Clique em "Inscreva-se".
3. Escolha o perfil que melhor o descreve.
4. Cadastre seu endereço de e-mail. É necessário utilizar um e-mail corporativo.
5. Preencha o formulário que será enviado ao seu e-mail. Caso não tenha recebido em sua caixa de
entrada, confira sua caixa de spam.
6. Siga os passos descritos a seguir para fazer login na área restrita.

Para usuários que possuem cadastro:

1. Acesse o menu "Suporte Técnico" → "Área restrita".
2. Faça login com seu endereço de e-mail e senha cadastrada.
3. Acesse a opção Documentos. Você será direcionado à Wiki da Khomp.

Você também pode entrar em contato com nosso suporte técnico através do e-mail
suporte@khomp.com ou pelo telefone +55 (48) 3722-2930.

"Incorpora produto homologado pela Anatel sob número 06237-18-07968"

Rua Joe Collaço, 253 - Florianópolis, SC

+55 (48) 3722.2930 27
suporte@khomp.com