C# e .NET MQTT 3.1.1 e 5.0

Client MQTT C# per MQTT 3.1.1 e 5.0

Connetti le app C# a qualsiasi broker MQTT via TCP o WebSocket con questo client MQTT .NET, da .NET Framework 2.0 a .NET 10.

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

Connetti, sottoscrivi e pubblica in C# → · Vedi i prezzi →

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 che si appoggia al client sgcWebSockets

Un componente di trasporto, un componente di protocollo, eventi per ogni pacchetto MQTT.

Il client MQTT C# in sgcWebSockets .NET è TsgcWSPClient_MQTT, nel namespace esegece.sgcWebSockets. Non apre socket da solo. Assegni un TsgcWebSocketClient alla sua proprietà Client, e quel client trasporta i pacchetti MQTT come flusso TCP semplice (porte 1883 e 8883) oppure dentro frame WebSocket per i broker che espongono un endpoint MQTT su WebSocket. Host, porta, TLS, proxy e riconnessione automatica restano sul trasporto, mentre sessione MQTT, topic e QoS stanno sul componente di protocollo.

Ogni risposta del broker diventa un evento C#: OnMQTTConnect, OnMQTTPublish, OnMQTTSubscribe, OnMQTTPubAck, OnMQTTPubRec, OnMQTTPubComp, OnMQTTPing e OnMQTTDisconnect, più OnMQTTAuth per l'autenticazione avanzata di MQTT 5.0. Lo stesso pacchetto è destinato a .NET Framework da 2.0 a 4.8.1, .NET Core da 1.0 a 3.1, da .NET 5 a .NET 10 e .NET Standard 1.6 e 2.0, su Windows, Linux e macOS.

MQTT 3.1.1 e 5.0

Scegli il protocollo con MQTTVersion: TwsMQTTVersion.mqtt311 o TwsMQTTVersion.mqtt5.

TCP o WebSocket

Specifications.RFC6455 = false sul trasporto invia MQTT grezzo su TCP; lascialo attivo per incapsulare MQTT in un percorso WebSocket.

Tre livelli di QoS

TmqttQoS.mtqsAtMostOnce, mtqsAtLeastOnce e mtqsExactlyOnce su ogni pubblicazione e sottoscrizione.

Controllo della sessione

Nome utente e password in Authentication, ping keep-alive in HeartBeat, un last will in LastWillTestament.

Connetti, sottoscrivi e pubblica in C#

Installa il pacchetto NuGet esegece.sgcWebSockets (o esegece.sgcWebSockets.Community), poi segui i quattro passaggi.

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;

Le demo WinForms MQTT Client e MQTT Console nel download .NET collegano le stesse chiamate a un form, con un elenco di broker, impostazioni TLS e proxy, opzioni di QoS e retain.

MQTT QoS 0, 1 e 2 da C#

Passa un valore TmqttQoS a Publish, PublishAndWait o Subscribe. Con QoS 1 e 2 il client rinvia un messaggio quando la conferma non arriva in tempo. Gestisci OnMQTTPubAck o OnMQTTPubComp per seguire la consegna, oppure chiama PublishAndWait, che restituisce false quando il broker non risponde entro il timeout (10 secondi per impostazione predefinita).

QoSValore C#ConsegnaEvento di conferma
0TmqttQoS.mtqsAtMostOnceAl massimo una volta, al meglio delle possibilità, nessuna rispostanessuno
1TmqttQoS.mtqsAtLeastOnceAlmeno una volta, confermato dal brokerOnMQTTPubAck
2TmqttQoS.mtqsExactlyOnceEsattamente una volta, handshake in quattro passaggiOnMQTTPubRec, OnMQTTPubComp

TLS, credenziali, last will e keep-alive

TLS sulla porta 8883

Imposta TLS = true sul trasporto e scegli il protocollo in TLSOptions.Version, fino a TLS 1.3. Per i broker che richiedono certificati client, TLSOptions accetta anche CertFile, KeyFile, Password e RootCertFile, e VerifyCertificate controlla il certificato del server.

Nome utente e password

Authentication.Enabled, Authentication.UserName e Authentication.Password vanno nel pacchetto CONNECT.

Last will

LastWillTestament imposta Topic, Text, QoS e Retain, così il broker pubblica un messaggio "offline" quando un dispositivo cade senza una disconnessione pulita.

Keep-alive

HeartBeat.Enabled e HeartBeat.Interval inviano pacchetti PINGREQ; OnMQTTPing segnala ogni risposta, e Ping() ne invia uno su richiesta.

Client id e sessione pulita

OnMQTTBeforeConnect passa CleanSession e ClientIdentifier per riferimento, così scegli una sessione persistente e un client id fisso per dispositivo.

Proxy e riconnessione

Le impostazioni Proxy del trasporto e la riconnessione automatica WatchDog si applicano a MQTT senza modifiche.

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

Funzionalità di MQTT 5.0 in C#

Imposta MQTTVersion = TwsMQTTVersion.mqtt5 e il client parla MQTT 5.0. Ogni evento di conferma porta allora il ReasonCode e il ReasonName del broker insieme alle proprietà del pacchetto, così i fallimenti arrivano con un motivo invece di una connessione interrotta.

Proprietà di connessione

ConnectProperties imposta SessionExpiryInterval, ReceiveMaximum, MaximumPacketSize, TopicAliasMaximum, UserProperties e i flag di richiesta per le informazioni di risposta e di problema.

Proprietà di pubblicazione

Per messaggio ContentType, ResponseTopic, CorrelationData, MessageExpiryInterval, TopicAlias, PayloadFormat e proprietà utente per i modelli richiesta e risposta.

Autenticazione avanzata

Auth() invia pacchetti AUTH con un AuthenticationMethod e AuthenticationData, compresa la riautenticazione, e OnMQTTAuth riceve la richiesta del broker.

Proprietà di will e disconnessione

Un intervallo di ritardo del will e la scadenza del messaggio sul last will, più un reason code, una reason string e la scadenza della sessione su 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);

Qualsiasi broker MQTT standard, più AWS IoT e Azure IoT

Poiché il client segue le specifiche MQTT 3.1.1 e 5.0, si connette sia a broker self-hosted sia a broker gestiti: sulla porta 1883 per TCP semplice, 8883 per TLS, o sul percorso WebSocket del broker quando sono aperte solo le porte HTTPS. Per le piattaforme IoT cloud, sgcWebSockets .NET include anche un client AWS IoT per AWS IoT Core e un client Azure IoT per Azure IoT Hub, entrambi basati su MQTT, elencati nella matrice delle funzionalità .NET.

La stessa libreria ti offre anche AMQP 0.9.1 e 1.0, STOMP, Kafka e il client e server WebSocket C#, così una sola dipendenza copre ogni protocollo di messaggistica dell'applicazione.

Gratuito per iniziare, un solo prezzo per ogni protocollo

Il client MQTT è in ogni edizione .NET. Community è gratuita per uso commerciale e non commerciale da parte di piccoli team (ricavi inferiori a 1 milione di EUR, fino a 5 sviluppatori), con l'insieme completo delle funzionalità e un avviso all'avvio. Professional rimuove l'avviso e parte da €149 per sviluppatore con 1 anno di aggiornamenti; Enterprise aggiunge il codice sorgente per ricompilare gli assembly. Le licenze Team e Site sono nella pagina dei prezzi (scheda .NET).

Domande su MQTT in C#

Crea un TsgcWebSocketClient con Host e Port del broker, imposta Specifications.RFC6455 = false per un broker TCP semplice, crea un TsgcWSPClient_MQTT e assegna il client alla sua proprietà Client. Impostando client.Active = true si apre la connessione, e OnMQTTConnect scatta quando il broker accetta la sessione.

Sì. Imposta MQTTVersion su TwsMQTTVersion.mqtt5 per MQTT 5.0 o su TwsMQTTVersion.mqtt311 per MQTT 3.1.1. MQTT 5.0 aggiunge reason code su ogni conferma, proprietà di connessione e pubblicazione, proprietà utente e autenticazione avanzata.

Chiama Publish(topic, text, TmqttQoS.mtqsAtLeastOnce) o TmqttQoS.mtqsExactlyOnce, se vuoi con un flag retain. Usa PublishAndWait quando il codice deve sapere che il broker ha elaborato il messaggio: restituisce false se non arriva alcuna risposta entro il timeout.

Sì. Imposta Port = 8883 e TLS = true sul TsgcWebSocketClient, scegli la versione in TLSOptions.Version (fino a TLS 1.3) e aggiungi TLSOptions.CertFile e KeyFile se il broker richiede un certificato client.

Sì, è il comportamento predefinito del trasporto. Lascia attivo Specifications.RFC6455, imposta Options.Parameters sul percorso WebSocket del broker (per esempio /mqtt) e usa TLS = true sulla porta 443 per wss://. Così MQTT passa attraverso i firewall che consentono solo HTTPS.

.NET Framework da 2.0 a 4.8.1, .NET Core da 1.0 a 3.1, da .NET 5 a .NET 10 e .NET Standard 1.6 e 2.0, su Windows, Linux e macOS. Installa esegece.sgcWebSockets o il pacchetto gratuito esegece.sgcWebSockets.Community da nuget.org.

Sì. L'edizione Community include il client MQTT ed è gratuita per uso commerciale e non commerciale da parte di piccoli team (ricavi inferiori a 1 milione di EUR, fino a 5 sviluppatori), con un avviso all'avvio. Le organizzazioni più grandi acquistano Professional, da €149 per sviluppatore, o Enterprise.

Altro su sgcWebSockets .NET

Libreria WebSocket C#

Il client e il server WebSocket che trasportano il traffico MQTT, con TLS, compressione e riconnessione automatica.

Matrice delle funzionalità .NET

Ogni componente e protocollo nelle edizioni .NET, compresi MQTT, AMQP, STOMP, AWS IoT e Azure IoT.

Download

Edizione Community, pacchetti NuGet e demo .NET compilate, tra cui MQTT Client e MQTT Console.

Anche per Delphi e C++Builder

Lo stesso client MQTT è disponibile per Delphi e C++Builder, con la stessa classe TsgcWSPClient_MQTT e gli stessi eventi.

La scelta più conveniente: All-AccessTutti i prodotti eSeGeCe, con Supporto Premium incluso, a partire da €1,059/anno.
Vedi i prezzi All-Access

Pubblica oggi il tuo primo messaggio MQTT da C#

Scarica la versione di prova o installa esegece.sgcWebSockets.Community da NuGet. Professional da €149 per sviluppatore.