C# e .NET MQTT 3.1.1 e 5.0

Cliente MQTT para C# para MQTT 3.1.1 e 5.0

Conecte aplicativos C# a qualquer broker MQTT por TCP ou WebSocket com este cliente MQTT para .NET, do .NET Framework 2.0 ao .NET 10.

MQTT 3.1.1 e MQTT 5.0
QoS 0, 1 e 2
TLS sobre TCP ou WebSocket
Last will, retain, keep-alive

Conecte, assine e publique em C# → · Ver preços →

Cliente MQTT para C#
using esegece.sgcWebSockets;

var client = new TsgcWebSocketClient();
client.Host = "broker.example.com";
client.Port = 8883;
client.TLS = true;
client.Specifications.RFC6455 = false; // MQTT over TCP

var mqtt = new TsgcWSPClient_MQTT();
mqtt.Client = client;
mqtt.MQTTVersion = TwsMQTTVersion.mqtt5;

mqtt.OnMQTTConnect += (conn, session, code, reason, props) =>
    mqtt.Subscribe("sensors/#");
mqtt.OnMQTTPublish += (conn, topic, text, props) =>
    Console.WriteLine(topic + ": " + text);

client.Active = true;

Um cliente MQTT que funciona sobre o cliente do sgcWebSockets

Um componente de transporte, um componente de protocolo, eventos para cada pacote MQTT.

O cliente MQTT para C# do sgcWebSockets .NET é TsgcWSPClient_MQTT, no namespace esegece.sgcWebSockets. Ele não abre sockets por conta própria. Você atribui um TsgcWebSocketClient à sua propriedade Client, e esse cliente transporta os pacotes MQTT como um stream TCP simples (portas 1883 e 8883) ou dentro de frames WebSocket para brokers que expõem um endpoint MQTT sobre WebSocket. Host, porta, TLS, proxy e reconexão automática ficam no transporte, e a sessão MQTT, os tópicos e o QoS ficam no componente de protocolo.

Cada resposta do broker vira um evento C#: OnMQTTConnect, OnMQTTPublish, OnMQTTSubscribe, OnMQTTPubAck, OnMQTTPubRec, OnMQTTPubComp, OnMQTTPing e OnMQTTDisconnect, além de OnMQTTAuth para a autenticação avançada do MQTT 5.0. O mesmo pacote tem como destino .NET Framework 2.0 a 4.8.1, .NET Core 1.0 a 3.1, .NET 5 a .NET 10 e .NET Standard 1.6 e 2.0, no Windows, Linux e macOS.

MQTT 3.1.1 e 5.0

Escolha o protocolo com MQTTVersion: TwsMQTTVersion.mqtt311 ou TwsMQTTVersion.mqtt5.

TCP ou WebSocket

Specifications.RFC6455 = false no transporte envia MQTT bruto sobre TCP; deixe ativado para encapsular o MQTT em um caminho WebSocket.

Três níveis de QoS

TmqttQoS.mtqsAtMostOnce, mtqsAtLeastOnce e mtqsExactlyOnce em cada publicação e assinatura.

Controle de sessão

Nome de usuário e senha em Authentication, pings de keep-alive em HeartBeat, um last will em LastWillTestament.

Conecte, assine e publique em C#

Instale o pacote NuGet esegece.sgcWebSockets (ou esegece.sgcWebSockets.Community) e siga os quatro passos.

using esegece.sgcWebSockets;

// transport: TCP with TLS on the standard secure MQTT port
var client = new TsgcWebSocketClient();
client.Host = "broker.example.com";
client.Port = 8883;
client.TLS = true;
client.TLSOptions.Version = TwsTLSVersions.tls1_2;
client.Specifications.RFC6455 = false;   // raw MQTT, no WebSocket handshake

// protocol: MQTT 3.1.1 with credentials and keep-alive
var mqtt = new TsgcWSPClient_MQTT();
mqtt.Client = client;
mqtt.MQTTVersion = TwsMQTTVersion.mqtt311;
mqtt.Authentication.Enabled = true;
mqtt.Authentication.UserName = "device-01";
mqtt.Authentication.Password = "secret";
mqtt.HeartBeat.Enabled = true;
mqtt.HeartBeat.Interval = 30;

mqtt.OnMQTTConnect += (conn, session, reasonCode, reasonName, props) =>
    Console.WriteLine("#mqtt connected: " + reasonName);
mqtt.OnMQTTDisconnect += (conn, reasonCode, reasonName, props) =>
    Console.WriteLine("#mqtt disconnected: " + reasonName);

client.Active = true;
// subscribe once the broker has accepted the session
mqtt.OnMQTTConnect += (conn, session, reasonCode, reasonName, props) =>
{
    mqtt.Subscribe("sensors/+/temperature");
    mqtt.Subscribe("alerts/#", TmqttQoS.mtqsExactlyOnce, null);
};

mqtt.OnMQTTSubscribe += (conn, packetId, codes, props) =>
    Console.WriteLine("#subscribed, packet " + packetId);

// every message on a subscribed topic arrives here
mqtt.OnMQTTPublish += (conn, topic, text, props) =>
    Console.WriteLine(topic + " = " + text);

// stop receiving a topic
mqtt.UnSubscribe("alerts/#");
// QoS 0: fire and forget
mqtt.Publish("sensors/room1/temperature", "21.5");

// QoS 1 with the retain flag, so late subscribers get the last value
mqtt.Publish("devices/device-01/status", "online", TmqttQoS.mtqsAtLeastOnce, true);

// QoS 2: wait up to 10 seconds for the broker to confirm
bool ok = mqtt.PublishAndWait("orders/new", "{\"id\": 42}", TmqttQoS.mtqsExactlyOnce, 10000);

// binary payloads
mqtt.Publish("images/cam1", File.ReadAllBytes("frame.jpg"));

// acknowledgements
mqtt.OnMQTTPubAck  += (conn, packetId, reasonCode, reasonName, props) =>
    Console.WriteLine("#puback " + packetId);
mqtt.OnMQTTPubComp += (conn, packetId, reasonCode, reasonName, props) =>
    Console.WriteLine("#pubcomp " + packetId);
using esegece.sgcWebSockets;

// the same MQTT client, tunnelled through a secure WebSocket (wss://)
var client = new TsgcWebSocketClient();
client.Host = "broker.example.com";
client.Port = 443;
client.TLS = true;
client.Options.Parameters = "/mqtt";   // the broker's WebSocket path
client.WatchDog.Enabled = true;          // reconnect after network drops

var mqtt = new TsgcWSPClient_MQTT();
mqtt.Client = client;
mqtt.OnMQTTPublish += (conn, topic, text, props) => Console.WriteLine(topic + ": " + text);

client.Active = true;

As demonstrações WinForms MQTT Client e MQTT Console no download .NET ligam as mesmas chamadas a um formulário, com uma lista de brokers, configurações de TLS e proxy, e opções de QoS e retain.

MQTT QoS 0, 1 e 2 a partir do C#

Passe um valor TmqttQoS para Publish, PublishAndWait ou Subscribe. Em QoS 1 e 2, o cliente reenvia uma mensagem quando a confirmação não chega a tempo. Trate OnMQTTPubAck ou OnMQTTPubComp para acompanhar a entrega, ou chame PublishAndWait, que retorna false quando o broker não responde dentro do tempo limite (10 segundos por padrão).

QoSValor em C#EntregaEvento de confirmação
0TmqttQoS.mtqsAtMostOnceNo máximo uma vez, melhor esforço, sem respostanenhum
1TmqttQoS.mtqsAtLeastOncePelo menos uma vez, confirmada pelo brokerOnMQTTPubAck
2TmqttQoS.mtqsExactlyOnceExatamente uma vez, handshake de quatro etapasOnMQTTPubRec, OnMQTTPubComp

TLS, credenciais, last will e keep-alive

TLS na porta 8883

Defina TLS = true no transporte e escolha o protocolo em TLSOptions.Version, até TLS 1.3. Para brokers que exigem certificados de cliente, TLSOptions também aceita CertFile, KeyFile, Password e RootCertFile, e VerifyCertificate verifica o certificado do servidor.

Nome de usuário e senha

Authentication.Enabled, Authentication.UserName e Authentication.Password vão no pacote CONNECT.

Last will

LastWillTestament define Topic, Text, QoS e Retain, de modo que o broker publique uma mensagem "offline" quando um dispositivo cai sem uma desconexão limpa.

Keep-alive

HeartBeat.Enabled e HeartBeat.Interval enviam pacotes PINGREQ; OnMQTTPing informa cada resposta, e Ping() envia um sob demanda.

ID de cliente e sessão limpa

OnMQTTBeforeConnect passa CleanSession e ClientIdentifier por referência, então você escolhe uma sessão persistente e um ID de cliente fixo por dispositivo.

Proxy e reconexão

As configurações de Proxy do transporte e a reconexão automática WatchDog valem para o MQTT sem alterações.

mqtt.LastWillTestament.Enabled = true;
mqtt.LastWillTestament.Topic = "devices/device-01/status";
mqtt.LastWillTestament.Text = "offline";
mqtt.LastWillTestament.QoS = TmqttQoS.mtqsAtLeastOnce;
mqtt.LastWillTestament.Retain = true;

mqtt.OnMQTTBeforeConnect += (TsgcWSConnection conn, ref bool cleanSession, ref string clientId) =>
{
    cleanSession = false;
    clientId = "device-01";
};

Recursos do MQTT 5.0 em C#

Defina MQTTVersion = TwsMQTTVersion.mqtt5 e o cliente fala MQTT 5.0. Cada evento de confirmação passa a trazer o ReasonCode e o ReasonName do broker junto com as propriedades do pacote, então as falhas chegam com um motivo em vez de uma conexão derrubada.

Propriedades de conexão

ConnectProperties define SessionExpiryInterval, ReceiveMaximum, MaximumPacketSize, TopicAliasMaximum, UserProperties e sinalizadores de solicitação para informações de resposta e de problema.

Propriedades de publicação

ContentType, ResponseTopic, CorrelationData, MessageExpiryInterval, TopicAlias, PayloadFormat e propriedades de usuário por mensagem para padrões de requisição e resposta.

Autenticação avançada

Auth() envia pacotes AUTH com um AuthenticationMethod e AuthenticationData, incluindo reautenticação, e OnMQTTAuth recebe o desafio do broker.

Propriedades de will e de desconexão

Um intervalo de atraso do will e a expiração da mensagem no last will, além de um código de motivo, uma string de motivo e a expiração da sessão em Disconnect.

mqtt.MQTTVersion = TwsMQTTVersion.mqtt5;
mqtt.ConnectProperties.Enabled = true;
mqtt.ConnectProperties.SessionExpiryInterval = 3600;   // keep the session one hour
mqtt.ConnectProperties.ReceiveMaximum = 100;

mqtt.OnMQTTConnect += (conn, session, reasonCode, reasonName, props) =>
    Console.WriteLine("CONNACK " + reasonCode + " " + reasonName);

Qualquer broker MQTT padrão, além de AWS IoT e Azure IoT

Como o cliente segue as especificações MQTT 3.1.1 e 5.0, ele se conecta tanto a brokers próprios quanto a brokers gerenciados: na porta 1883 para TCP simples, 8883 para TLS, ou no caminho WebSocket do broker quando só as portas HTTPS estão abertas. Para as plataformas IoT na nuvem, o sgcWebSockets .NET também inclui um cliente AWS IoT para o AWS IoT Core e um cliente Azure IoT para o Azure IoT Hub, ambos baseados em MQTT, listados na matriz de recursos do .NET.

A mesma biblioteca também oferece AMQP 0.9.1 e 1.0, STOMP, Kafka e o cliente e servidor WebSocket para C#, então uma única dependência cobre todos os protocolos de mensagens do aplicativo.

Grátis para começar, um preço para todos os protocolos

O cliente MQTT está em todas as edições .NET. A Community é gratuita para uso comercial e não comercial por equipes pequenas (receita abaixo de EUR 1M, até 5 desenvolvedores), com o conjunto completo de recursos e um aviso na inicialização. A Professional remove o aviso e começa em €149 por desenvolvedor com 1 ano de atualizações; a Enterprise adiciona o código-fonte para recompilar os assemblies. As licenças Team e Site estão na página de preços (aba .NET).

Perguntas sobre MQTT em C#

Crie um TsgcWebSocketClient com o Host e a Port do broker, defina Specifications.RFC6455 = false para um broker TCP simples, crie um TsgcWSPClient_MQTT e atribua o cliente à sua propriedade Client. Definir client.Active = true abre a conexão, e OnMQTTConnect é disparado quando o broker aceita a sessão.

Sim. Defina MQTTVersion como TwsMQTTVersion.mqtt5 para MQTT 5.0 ou TwsMQTTVersion.mqtt311 para MQTT 3.1.1. O MQTT 5.0 adiciona códigos de motivo em cada confirmação, propriedades de conexão e de publicação, propriedades de usuário e autenticação avançada.

Chame Publish(topic, text, TmqttQoS.mtqsAtLeastOnce) ou TmqttQoS.mtqsExactlyOnce, opcionalmente com um sinalizador retain. Use PublishAndWait quando o código precisar saber que o broker processou a mensagem: ele retorna false se nenhuma resposta chegar dentro do tempo limite.

Sim. Defina Port = 8883 e TLS = true no TsgcWebSocketClient, escolha a versão em TLSOptions.Version (até TLS 1.3) e adicione TLSOptions.CertFile e KeyFile se o broker pedir um certificado de cliente.

Sim, esse é o padrão do transporte. Deixe Specifications.RFC6455 ativado, defina Options.Parameters como o caminho WebSocket do broker (por exemplo /mqtt) e use TLS = true na porta 443 para wss://. Isso leva o MQTT através de firewalls que só permitem HTTPS.

.NET Framework 2.0 a 4.8.1, .NET Core 1.0 a 3.1, .NET 5 a .NET 10 e .NET Standard 1.6 e 2.0, no Windows, Linux e macOS. Instale esegece.sgcWebSockets ou o pacote gratuito esegece.sgcWebSockets.Community do nuget.org.

Sim. A edição Community inclui o cliente MQTT e é gratuita para uso comercial e não comercial por equipes pequenas (receita abaixo de EUR 1M, até 5 desenvolvedores), com um aviso na inicialização. Organizações maiores compram a Professional, a partir de €149 por desenvolvedor, ou a Enterprise.

Mais sobre o sgcWebSockets .NET

Biblioteca WebSocket para C#

O cliente e o servidor WebSocket que transportam o tráfego MQTT, com TLS, compressão e reconexão automática.

Matriz de recursos do .NET

Todos os componentes e protocolos das edições .NET, incluindo MQTT, AMQP, STOMP, AWS IoT e Azure IoT.

Download

Edição Community, pacotes NuGet e as demonstrações .NET compiladas, entre elas MQTT Client e MQTT Console.

Também para Delphi e C++Builder

O mesmo cliente MQTT está disponível para Delphi e C++Builder, com a mesma classe TsgcWSPClient_MQTT e os mesmos eventos.

Melhor custo-benefício: All-AccessTodos os produtos da eSeGeCe, com Suporte Premium incluído, a partir de €1,059/ano.
Ver preços do All-Access

Publique hoje a sua primeira mensagem MQTT a partir do C#

Baixe a versão de avaliação ou instale esegece.sgcWebSockets.Community pelo NuGet. Professional a partir de €149 por desenvolvedor.