C# et .NET MQTT 3.1.1 et 5.0

Client MQTT C# pour MQTT 3.1.1 et 5.0

Connecte des applications C# à n'importe quel broker MQTT via TCP ou WebSocket avec ce client MQTT .NET, de .NET Framework 2.0 à .NET 10.

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

Connexion, abonnement et publication en C# → · Voir les tarifs →

Client MQTT 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;

Un client MQTT qui s'appuie sur le client sgcWebSockets

Un composant de transport, un composant de protocole, des événements pour chaque paquet MQTT.

Le client MQTT C# de sgcWebSockets .NET est TsgcWSPClient_MQTT, dans l'espace de noms esegece.sgcWebSockets. Il n'ouvre pas de sockets lui-même. Tu assignes un TsgcWebSocketClient à sa propriété Client, et ce client transporte les paquets MQTT soit comme un flux TCP simple (ports 1883 et 8883), soit dans des trames WebSocket pour les brokers qui exposent un point de terminaison MQTT sur WebSocket. L'hôte, le port, TLS, le proxy et la reconnexion automatique restent sur le transport ; la session MQTT, les topics et la QoS vivent sur le composant de protocole.

Chaque réponse du broker devient un événement C# : OnMQTTConnect, OnMQTTPublish, OnMQTTSubscribe, OnMQTTPubAck, OnMQTTPubRec, OnMQTTPubComp, OnMQTTPing et OnMQTTDisconnect, plus OnMQTTAuth pour l'authentification renforcée de MQTT 5.0. Le même package cible .NET Framework 2.0 à 4.8.1, .NET Core 1.0 à 3.1, .NET 5 à .NET 10 et .NET Standard 1.6 et 2.0, sous Windows, Linux et macOS.

MQTT 3.1.1 et 5.0

Choisis le protocole avec MQTTVersion : TwsMQTTVersion.mqtt311 ou TwsMQTTVersion.mqtt5.

TCP ou WebSocket

Specifications.RFC6455 = false sur le transport envoie du MQTT brut sur TCP ; laisse-le activé pour faire passer MQTT dans un chemin WebSocket.

Trois niveaux de QoS

TmqttQoS.mtqsAtMostOnce, mtqsAtLeastOnce et mtqsExactlyOnce sur chaque publication et chaque abonnement.

Contrôle de session

Nom d'utilisateur et mot de passe dans Authentication, pings keep-alive dans HeartBeat, un last will dans LastWillTestament.

Connexion, abonnement et publication en C#

Installe le package NuGet esegece.sgcWebSockets (ou esegece.sgcWebSockets.Community), puis suis les quatre étapes.

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;

Les démos WinForms MQTT Client et MQTT Console du téléchargement .NET relient les mêmes appels à une fiche, avec une liste de brokers, les paramètres TLS et proxy, et les options QoS et retain.

MQTT QoS 0, 1 et 2 depuis C#

Transmets une valeur TmqttQoS à Publish, PublishAndWait ou Subscribe. En QoS 1 et 2, le client renvoie un message quand l'accusé de réception n'arrive pas à temps. Gère OnMQTTPubAck ou OnMQTTPubComp pour suivre la livraison, ou appelle PublishAndWait, qui renvoie false quand le broker ne répond pas dans le délai (10 secondes par défaut).

QoSValeur C#LivraisonÉvénement de confirmation
0TmqttQoS.mtqsAtMostOnceAu plus une fois, au mieux, sans réponseaucun
1TmqttQoS.mtqsAtLeastOnceAu moins une fois, acquitté par le brokerOnMQTTPubAck
2TmqttQoS.mtqsExactlyOnceExactement une fois, échange en quatre étapesOnMQTTPubRec, OnMQTTPubComp

TLS, identifiants, last will et keep-alive

TLS sur le port 8883

Mets TLS = true sur le transport et choisis le protocole dans TLSOptions.Version, jusqu'à TLS 1.3. Pour les brokers qui exigent des certificats client, TLSOptions accepte aussi CertFile, KeyFile, Password et RootCertFile, et VerifyCertificate vérifie le certificat du serveur.

Nom d'utilisateur et mot de passe

Authentication.Enabled, Authentication.UserName et Authentication.Password vont dans le paquet CONNECT.

Last will

LastWillTestament définit Topic, Text, QoS et Retain, pour que le broker publie un message "offline" quand un appareil se déconnecte sans déconnexion propre.

Keep-alive

HeartBeat.Enabled et HeartBeat.Interval envoient des paquets PINGREQ ; OnMQTTPing signale chaque réponse, et Ping() en envoie un à la demande.

Identifiant client et session propre

OnMQTTBeforeConnect transmet CleanSession et ClientIdentifier par référence, donc tu choisis une session persistante et un identifiant client fixe par appareil.

Proxy et reconnexion

Les paramètres Proxy du transport et la reconnexion automatique WatchDog s'appliquent à MQTT sans changement.

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";
};

Les fonctionnalités MQTT 5.0 en C#

Mets MQTTVersion = TwsMQTTVersion.mqtt5 et le client parle MQTT 5.0. Chaque événement d'accusé de réception porte alors le ReasonCode et le ReasonName du broker avec les propriétés du paquet, donc les échecs arrivent avec une raison au lieu d'une connexion coupée.

Propriétés de connexion

ConnectProperties définit SessionExpiryInterval, ReceiveMaximum, MaximumPacketSize, TopicAliasMaximum, UserProperties et les indicateurs de demande d'informations de réponse et de problème.

Propriétés de publication

Par message : ContentType, ResponseTopic, CorrelationData, MessageExpiryInterval, TopicAlias, PayloadFormat et propriétés utilisateur pour les schémas requête et réponse.

Authentification renforcée

Auth() envoie des paquets AUTH avec un AuthenticationMethod et des AuthenticationData, y compris la réauthentification, et OnMQTTAuth reçoit le défi du broker.

Propriétés de will et de déconnexion

Un délai de will et une expiration de message sur le last will, plus un code de raison, une chaîne de raison et une expiration de session sur 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);

N'importe quel broker MQTT standard, plus AWS IoT et Azure IoT

Comme le client suit les spécifications MQTT 3.1.1 et 5.0, il se connecte aussi bien aux brokers auto-hébergés qu'aux brokers managés : sur le port 1883 pour du TCP simple, 8883 pour TLS, ou le chemin WebSocket du broker quand seuls les ports HTTPS sont ouverts. Pour les plateformes IoT cloud, sgcWebSockets .NET fournit aussi un client AWS IoT pour AWS IoT Core et un client Azure IoT pour Azure IoT Hub, tous deux basés sur MQTT, listés dans la matrice des fonctionnalités .NET.

La même bibliothèque te donne aussi AMQP 0.9.1 et 1.0, STOMP, Kafka et le client et serveur WebSocket C#, donc une seule dépendance couvre tous les protocoles de messagerie de l'application.

Gratuit pour commencer, un seul prix pour tous les protocoles

Le client MQTT est dans toutes les éditions .NET. Community est gratuite pour un usage commercial et non commercial par les petites équipes (moins de 1 M EUR de chiffre d'affaires, 5 développeurs au plus), avec toutes les fonctionnalités et un avis au démarrage. Professional supprime l'avis et démarre à €149 par développeur avec 1 an de mises à jour ; Enterprise ajoute le code source pour recompiler les assemblies. Les licences Team et Site sont sur la page des tarifs (onglet .NET).

Questions sur MQTT en C#

Crée un TsgcWebSocketClient avec le Host et le Port du broker, mets Specifications.RFC6455 = false pour un broker TCP simple, crée un TsgcWSPClient_MQTT et assigne le client à sa propriété Client. Mettre client.Active = true ouvre la connexion, et OnMQTTConnect se déclenche quand le broker accepte la session.

Oui. Mets MQTTVersion à TwsMQTTVersion.mqtt5 pour MQTT 5.0 ou à TwsMQTTVersion.mqtt311 pour MQTT 3.1.1. MQTT 5.0 ajoute des codes de raison sur chaque accusé de réception, des propriétés de connexion et de publication, des propriétés utilisateur et l'authentification renforcée.

Appelle Publish(topic, text, TmqttQoS.mtqsAtLeastOnce) ou TmqttQoS.mtqsExactlyOnce, avec éventuellement un indicateur retain. Utilise PublishAndWait quand le code doit savoir que le broker a traité le message : il renvoie false si aucune réponse n'arrive dans le délai.

Oui. Mets Port = 8883 et TLS = true sur le TsgcWebSocketClient, choisis la version dans TLSOptions.Version (jusqu'à TLS 1.3) et ajoute TLSOptions.CertFile et KeyFile si le broker demande un certificat client.

Oui, c'est le transport par défaut. Laisse Specifications.RFC6455 activé, mets Options.Parameters au chemin WebSocket du broker (par exemple /mqtt) et utilise TLS = true sur le port 443 pour wss://. Cela fait passer MQTT à travers les pare-feu qui n'autorisent que HTTPS.

.NET Framework 2.0 à 4.8.1, .NET Core 1.0 à 3.1, .NET 5 à .NET 10 et .NET Standard 1.6 et 2.0, sous Windows, Linux et macOS. Installe esegece.sgcWebSockets ou le package gratuit esegece.sgcWebSockets.Community depuis nuget.org.

Oui. L'édition Community inclut le client MQTT et est gratuite pour un usage commercial et non commercial par les petites équipes (moins de 1 M EUR de chiffre d'affaires, 5 développeurs au plus), avec un avis au démarrage. Les organisations plus grandes achètent Professional, à partir de €149 par développeur, ou Enterprise.

Plus sur sgcWebSockets .NET

Bibliothèque WebSocket C#

Le client et le serveur WebSocket qui transportent le trafic MQTT, avec TLS, compression et reconnexion automatique.

Matrice des fonctionnalités .NET

Chaque composant et chaque protocole des éditions .NET, MQTT, AMQP, STOMP, AWS IoT et Azure IoT compris.

Téléchargement

Édition Community, packages NuGet et démos .NET compilées, dont MQTT Client et MQTT Console.

Aussi pour Delphi et C++Builder

Le même client MQTT est disponible pour Delphi et C++Builder, avec la même classe TsgcWSPClient_MQTT et les mêmes événements.

Meilleur rapport qualité-prix : All-AccessTous les produits eSeGeCe, Support Premium inclus, à partir de €1,059/an.
Voir les tarifs All-Access

Publie dès aujourd'hui ton premier message MQTT depuis C#

Télécharge l'essai ou installe esegece.sgcWebSockets.Community depuis NuGet. Professional à partir de €149 par développeur.