Version

A versão do protocolo. As opções disponíveis são 3.1, 3.1.1 ou 5

Client ID

Nome que este cliente utiliza como identificador para os demais clientes. Não deve haver outro cliente conectado no mesmo Broker com este nome

User

Nome de usuário usado nas mensagens de conexão (ConnAck), caso desejado e permitido pelo Broker

Password

Senha usada juntamente com o nome de usuário

Read QoS

Indica o código QoS (Quality of Service) usado para solicitar as assinaturas dos Tags. Os valores possíveis são 0: No Confirm, 1: Confirm ou 2: Handshake. O Broker compara o código QoS solicitado e o código QoS originalmente publicado, enviando um dado no mínimo compatível

KeepAlive (s)

Tempo, em segundos, que um cliente envia uma mensagem de ping no protocolo MQTT (PingReq) para verificar se a conexão com um Broker ainda está ativa. O valor padrão para esta opção é 5 (cinco) segundos

Receive Max

Disponível apenas na versão 5 do protocolo MQTT, define quantas mensagens QoS 1 (um) ou 2 (dois) podem ser recebidas do Broker simultaneamente antes de serem confirmadas

Max Packet Size

Disponível apenas na versão 5 do protocolo MQTT, define o tamanho máximo, em bytes, para os pacotes MQTT

Use Topic Alias

Disponível apenas na versão 5 do protocolo MQTT. Ao selecionar esta opção, internamente é usado um identificador numérico que substitui um tópico longo, reduzindo o tamanho dos pacotes

Topic Alias Max

Disponível quando a opção Use Topic Alias está selecionada. Limita quantos tópicos podem ser substituídos por identificadores numéricos durante a comunicação

Use Session Control

Informa se este Driver deve manter o estado da sessão ativa, ou seja, caso ocorra uma desconexão e posterior reconexão, as mensagens QoS 1 (um) e 2 (dois) enviadas por outros clientes podem ser recuperadas

Session Expiry Interval

Disponível apenas na versão 5 do protocolo MQTT, define o tempo, em segundos, que a sessão permanece armazenada no Broker após a desconexão

Resend Unanswered Subscriptions Timeout (s)

Informa o número de segundos para reenviar uma assinatura de um item se este não recebeu o primeiro valor dentro do tempo informado

Max Simultaneous Subscription Requests

Número máximo de pedidos de assinaturas (subscriptions) requisitados a cada mensagem

Error on Tags Response Mismatch

Informa se este Driver deve retornar erro para Tags cuja mensagem não coincida com o Template configurado

Use Mosquitto Dynamic Security Integration

Habilita a integração do controle ou configuração das permissões do Mosquitto, através de mensagens padronizadas MQTT, disparadas através de Tags

Use Elipse Agent Integration

Habilita a integração com o Agente Elipse para computadores com Windows

Last Will Read Config

Abre a janela Last Will Read Config, mostrada na figura a seguir, para configuração da mensagem de Last Will recebida por este Driver

Use Last Will Msg for Quality Hierarchy

Ao selecionar esta opção, todas as demais configurações desta janela são habilitadas para edição, exceto a opção Echo ignore duration (seconds). Se este Driver recebe a mensagem configurada na opção Last Will Message em um tópico que corresponda ao valor definido na opção Last Will Topic Template, todos os tópicos que coincidem com o valor configurado na opção Associated Topics Template são marcados com a qualidade ruim 20, 24 ou 28 (inválida)

Last Will Topic Template

Modelo de tópico MQTT para a mensagem de Last Will

Last Will Message

Mensagem de Last Will, como por exemplo "Adeus"

Associated Topics Template

Modelo de tópicos MQTT associados à mensagem de Last Will, ou seja, os tópicos que são marcados com qualidade ruim

Ignore echo as valid response

Ao selecionar esta opção, a opção Echo ignore duration (seconds) é habilitada para edição

Echo ignore duration (seconds)

Essa opção define o período, em segundos, durante o qual uma mensagem recebida em um tópico é considerada um eco enviado pelo Broker quando este Driver publica neste tópico. Assim, esta mensagem é desconsiderada como uma comunicação válida e os tópicos correspondentes ao valor da opção Associated Topics Template não são marcados com qualidade boa (192)

QoS

Indica o nível de serviço das mensagens publicadas por este Driver. As opções disponíveis são QoS 0: Quase sempre uma entrega (pode haver zero ou mais entregas), QoS 1: Pelo menos uma ou mais entregas ou QoS 2: Exatamente uma entrega

Deadband %

Valor da banda morta relativa a ser aplicada em todos os Tags na escrita de valores numéricos sem Templates

Retain Messages on Server

Selecionar esta opção instrui o Broker a manter as mensagens deste cliente juntamente com o QoS para que clientes que se subscreverem no futuro possam receber mensagens acumuladas. Quando um novo cliente subscreve, a última mensagem de cada tópico, se houver, deve ser enviada ao cliente pelo Broker

Publish Texts in UTF-8

Informa se Tags do tipo Texto devem ter os valores convertidos para o formato UTF-8 antes de serem escritos. Isto evita a interpretação errada por outros clientes de caracteres com símbolos especiais

Enable Last Will and Testament

Ao habilitar esta opção, o servidor deve manter em memória um tópico e uma mensagem para o cliente, que são enviados para todos os demais clientes quando há uma desconexão não ordeira, ou seja, sem o envio da mensagem de Disconnect

Topic

Tópico ou endereço que é enviado na desconexão (Last Will), como por exemplo "ELIPSE\goodbye"

Message

Mensagem associada ao tópico, como por exemplo "Adeus"

Delay Interval

Disponível apenas na versão 5 do protocolo MQTT, define o tempo, em segundos, que um Broker espera após a desconexão inesperada antes de publicar a mensagem de Last Will

Use Expiry Interval

Disponível apenas na versão 5 do protocolo MQTT, habilita a opção Expiry Interval

Expiry Interval

Disponível apenas na versão 5 do protocolo MQTT, define o tempo, em segundos, após o qual a mensagem de Last Will é descartada pelo Broker se ainda não tiver sido entregue

Apply local timezone to timestamps

Quando esta opção está selecionada, as estampas de tempo recebidas são convertidas para o fuso horário utilizado pelo sistema operacional. Do contrário, as estampas de tempo recebidas são exibidas no fuso horário UTC

Template Name

Informa o nome do Template desejado. Não podem existir dois Templates com o mesmo nome

Data Format

Declara o formato da mensagem do Template. As opções disponíveis são JSON, CSV ou XML. O formato JSON é o preferido para uso pelo MQTT, pois permite a definição de qualquer tipo de estrutura de dados com o menor número de bytes

Add

Adiciona um Template na lista de Templates

Edit

Abre uma janela para edição do Template selecionado

Delete

Apaga o Template selecionado da lista de Templates

Save

Registra as modificações realizadas e fecha esta janela

Cancel

Descarta as modificações realizadas e fecha esta janela

Syntax Help

Informa a sintaxe da mensagem, no formato selecionado (JSON, CSV ou XML) juntamente com palavras-chave que são usadas durante o processamento para substituição por estampas de tempo, qualidades ou valores. Para mais informações, consulte o tópico Sintaxe dos Templates

Start driver OFFLINE

Selecione esta opção para que este Driver inicie em modo Offline ou parado. Isto significa que a interface Ethernet não é criada até que se configure este Driver em modo Online utilizando-se um Tag em uma aplicação. Este modo possibilita a configuração dinâmica da interface Ethernet em tempo de execução

Retry failed connection every n seconds

Selecione esta opção para habilitar a retentativa de conexão deste Driver em um intervalo n, em segundos. Se a opção Give up after n failed retries não está selecionada, este Driver continua retentando até que a conexão seja efetuada, ou que a aplicação seja parada

Give up after n failed retries

Habilite esta opção para definir um número máximo de retentativas de conexão. Quando o número especificado de tentativas consecutivas de reconexão é atingido, este Driver vai para o modo Offline, assumindo que um problema de hardware foi detectado. Se este Driver estabelece uma conexão com sucesso, o número de retentativas sem sucesso é zerado. Se esta nova conexão é perdida, então o contador de retentativas inicia do zero

Log to file

Habilite esta opção e configure o nome do arquivo onde o log é escrito. Arquivos de log podem ser bem extensos, portanto utilize esta opção por curtos períodos de tempo, apenas para o propósito de testes e depurações. Caso se utilize a macro %PROCESS% no nome do arquivo de log, esta é substituída pelo identificador do processo atual. Esta opção é particularmente útil ao se utilizar várias instâncias de um mesmo Driver no Elipse E3, Elipse Power ou Elipse Water, permitindo assim que cada instância gere um arquivo separado de log. Por exemplo, ao configurar esta opção com o valor "c:\e3logs\drivers\mqtt_%PROCESS%.log", gera-se um arquivo c:\e3logs\drivers\mqtt_00000FDA.log para o processo 0FDAh. Pode-se também utilizar a macro %DATE% no nome do arquivo. Neste caso é gerado um arquivo de log por dia, no formato aaaa_mm_dd. Por exemplo, ao configurar esta opção com o valor "c:\e3logs\drivers\mqtt_%DATE%.log", gera-se o arquivo c:\e3logs\drivers\mqtt_2005_12_31.log em 31/12/2025 e o arquivo c:\e3logs\drivers\mqtt_2026_01_01.log em 01/01/2006. De forma semelhante, a macro %DATE_HOUR% gera um arquivo de log por hora, no formato aaaa_mm_dd_hh

File size limit (MB)

Configure o limite de tamanho do arquivo de log, em megabytes. Um valor igual a 0 (zero) significa que não há limite de tamanho para o arquivo de log

Use SSL

Ao selecionar esta opção, o protocolo SSL (Secure Sockets Layer) é utilizado para uma conexão segura com um Broker. A opção SSL Settings é habilitada para configurar os certificados

SSL Settings

Abre a janela SSL Settings para configuração de certificados, mostrada na figura a seguir

Main IP

Digite o endereço IP de um dispositivo remoto. Pode-se usar tanto o endereço IP separado por pontos quanto uma URL. No caso de uma URL, este Driver usa o serviço de DNS disponível para mapear a URL para um endereço IP, como por exemplo "192.168.0.13" ou "Server1"

Port

Digite a porta TCP/IP de um dispositivo remoto, entre 0 (zero) e 65535

CA File Path (.crt)

Nome e caminho de um arquivo para o Certificado de Autoridade (CA). Clique em para selecionar um arquivo

Certificate File Path (.crt)

Nome e caminho de um arquivo para o Certificado SSL do cliente. Clique em para selecionar um arquivo

Private Key File Path (.key)

Nome e caminho de um arquivo de chaves privadas para o Certificado SSL do cliente. Clique em para selecionar um arquivo

Private Key Password

Senha da chave privada, se aplicável

Validate Local Private Key

Habilita ou desabilita a validação do arquivo definido na opção Private Key File Path (.key)

Check Peer Certificate

Habilita ou desabilita a verificação do Certificado SSL do cliente

Check Peer Certificate Expiration

Habilita ou desabilita a verificação da data de expiração do Certificado SSL do cliente