C# en .NET MQTT 3.1.1 en 5.0

C# MQTT-client voor MQTT 3.1.1 en 5.0

Verbind C#-apps met elke MQTT-broker via TCP of WebSocket met deze .NET MQTT-client, van .NET Framework 2.0 tot .NET 10.

MQTT 3.1.1 en MQTT 5.0
QoS 0, 1 en 2
TLS via TCP of WebSocket
Last will, retain, keep-alive

Verbinden, abonneren en publiceren in C# → · Bekijk de prijzen →

C# MQTT-client
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;

Een MQTT-client die op de sgcWebSockets-client meelift

Eén transportcomponent, één protocolcomponent, gebeurtenissen voor elk MQTT-pakket.

De C# MQTT-client in sgcWebSockets .NET is TsgcWSPClient_MQTT, in de namespace esegece.sgcWebSockets. Hij opent zelf geen sockets. Je wijst een TsgcWebSocketClient toe aan zijn eigenschap Client, en die client draagt de MQTT-pakketten als gewone TCP-stream (poorten 1883 en 8883) of binnen WebSocket-frames voor brokers die een MQTT-over-WebSocket-eindpunt aanbieden. Host, poort, TLS, proxy en automatisch opnieuw verbinden blijven bij het transport, de MQTT-sessie, topics en QoS horen bij de protocolcomponent.

Elk antwoord van de broker wordt een C#-gebeurtenis: OnMQTTConnect, OnMQTTPublish, OnMQTTSubscribe, OnMQTTPubAck, OnMQTTPubRec, OnMQTTPubComp, OnMQTTPing en OnMQTTDisconnect, plus OnMQTTAuth voor verbeterde authenticatie in MQTT 5.0. Hetzelfde package richt zich op .NET Framework 2.0 tot 4.8.1, .NET Core 1.0 tot 3.1, .NET 5 tot .NET 10 en .NET Standard 1.6 en 2.0, op Windows, Linux en macOS.

MQTT 3.1.1 en 5.0

Kies het protocol met MQTTVersion: TwsMQTTVersion.mqtt311 of TwsMQTTVersion.mqtt5.

TCP of WebSocket

Specifications.RFC6455 = false op het transport verstuurt ruwe MQTT via TCP; laat het aan staan om MQTT door een WebSocket-pad te tunnelen.

Drie QoS-niveaus

TmqttQoS.mtqsAtMostOnce, mtqsAtLeastOnce en mtqsExactlyOnce bij elke publicatie en elk abonnement.

Sessiebeheer

Gebruikersnaam en wachtwoord in Authentication, keep-alive-pings in HeartBeat, een last will in LastWillTestament.

Verbinden, abonneren en publiceren in C#

Installeer het NuGet-package esegece.sgcWebSockets (of esegece.sgcWebSockets.Community) en volg daarna de vier stappen.

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;

De WinForms-demo's MQTT Client en MQTT Console in de .NET-download koppelen dezelfde aanroepen aan een formulier, met een brokerlijst, TLS- en proxy-instellingen, QoS- en retain-opties.

MQTT QoS 0, 1 en 2 vanuit C#

Geef een TmqttQoS-waarde door aan Publish, PublishAndWait of Subscribe. Bij QoS 1 en 2 verstuurt de client een bericht opnieuw wanneer de bevestiging niet op tijd binnenkomt. Verwerk OnMQTTPubAck of OnMQTTPubComp om de aflevering te volgen, of roep PublishAndWait aan, dat false teruggeeft wanneer de broker binnen de time-out (standaard 10 seconden) niet antwoordt.

QoSC#-waardeAfleveringBevestigingsgebeurtenis
0TmqttQoS.mtqsAtMostOnceHooguit één keer, best effort, geen antwoordgeen
1TmqttQoS.mtqsAtLeastOnceMinstens één keer, bevestigd door de brokerOnMQTTPubAck
2TmqttQoS.mtqsExactlyOncePrecies één keer, handshake in vier stappenOnMQTTPubRec, OnMQTTPubComp

TLS, inloggegevens, last will en keep-alive

TLS op poort 8883

Stel TLS = true in op het transport en kies het protocol in TLSOptions.Version, tot TLS 1.3. Voor brokers die clientcertificaten vereisen, accepteert TLSOptions ook CertFile, KeyFile, Password en RootCertFile, en VerifyCertificate controleert het servercertificaat.

Gebruikersnaam en wachtwoord

Authentication.Enabled, Authentication.UserName en Authentication.Password gaan mee in het CONNECT-pakket.

Last will

LastWillTestament stelt Topic, Text, QoS en Retain in, zodat de broker een bericht "offline" publiceert wanneer een apparaat wegvalt zonder nette verbreking.

Keep-alive

HeartBeat.Enabled en HeartBeat.Interval sturen PINGREQ-pakketten; OnMQTTPing meldt elk antwoord, en Ping() stuurt er op aanvraag een.

Client-id en schone sessie

OnMQTTBeforeConnect geeft CleanSession en ClientIdentifier by reference door, zodat je een persistente sessie en een vaste client-id per apparaat kiest.

Proxy en opnieuw verbinden

De Proxy-instellingen en het automatisch opnieuw verbinden met WatchDog van het transport gelden ongewijzigd voor MQTT.

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

MQTT 5.0-functies in C#

Stel MQTTVersion = TwsMQTTVersion.mqtt5 in en de client spreekt MQTT 5.0. Elke bevestigingsgebeurtenis bevat dan de ReasonCode en ReasonName van de broker samen met de pakketeigenschappen, zodat fouten met een reden binnenkomen in plaats van met een weggevallen verbinding.

Verbindingseigenschappen

ConnectProperties stelt SessionExpiryInterval, ReceiveMaximum, MaximumPacketSize, TopicAliasMaximum, UserProperties en aanvraagvlaggen voor respons- en probleeminformatie in.

Publicatie-eigenschappen

Per bericht ContentType, ResponseTopic, CorrelationData, MessageExpiryInterval, TopicAlias, PayloadFormat en gebruikerseigenschappen voor aanvraag- en antwoordpatronen.

Verbeterde authenticatie

Auth() verstuurt AUTH-pakketten met een AuthenticationMethod en AuthenticationData, inclusief heraanmelding, en OnMQTTAuth ontvangt de uitdaging van de broker.

Will- en verbrekingseigenschappen

Een vertragingsinterval en berichtverloop voor de last will, plus een reden-code, redentekst en sessieverloop bij 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);

Elke standaard MQTT-broker, plus AWS IoT en Azure IoT

Omdat de client de specificaties van MQTT 3.1.1 en 5.0 volgt, verbindt hij met zowel zelf gehoste als beheerde brokers: op poort 1883 voor gewone TCP, 8883 voor TLS, of het WebSocket-pad van de broker wanneer alleen HTTPS-poorten open zijn. Voor de IoT-cloudplatforms levert sgcWebSockets .NET ook een AWS IoT-client voor AWS IoT Core en een Azure IoT-client voor Azure IoT Hub, beide op MQTT gebaseerd, opgenomen in de .NET-functiematrix.

Dezelfde bibliotheek geeft je ook AMQP 0.9.1 en 1.0, STOMP, Kafka en de C# WebSocket-client en -server, zodat één afhankelijkheid elk berichtenprotocol in de toepassing dekt.

Gratis om mee te beginnen, één prijs voor elk protocol

De MQTT-client zit in elke .NET-editie. Community is gratis voor commercieel en niet-commercieel gebruik door kleine teams (minder dan EUR 1 mln omzet, tot 5 ontwikkelaars), met de volledige functieset en een opstartmelding. Professional verwijdert de melding en begint bij €149 per ontwikkelaar met 1 jaar updates; Enterprise voegt de broncode toe om de assemblies opnieuw te bouwen. Team- en Site-licenties staan op de prijspagina (tabblad .NET).

Vragen over C# MQTT

Maak een TsgcWebSocketClient aan met de Host en Port van de broker, stel Specifications.RFC6455 = false in voor een gewone TCP-broker, maak een TsgcWSPClient_MQTT aan en wijs de client toe aan zijn eigenschap Client. Met client.Active = true open je de verbinding, en OnMQTTConnect wordt afgevuurd wanneer de broker de sessie accepteert.

Ja. Stel MQTTVersion in op TwsMQTTVersion.mqtt5 voor MQTT 5.0 of TwsMQTTVersion.mqtt311 voor MQTT 3.1.1. MQTT 5.0 voegt reden-codes toe aan elke bevestiging, verbindings- en publicatie-eigenschappen, gebruikerseigenschappen en verbeterde authenticatie.

Roep Publish(topic, text, TmqttQoS.mtqsAtLeastOnce) of TmqttQoS.mtqsExactlyOnce aan, eventueel met een retain-vlag. Gebruik PublishAndWait wanneer de code moet weten dat de broker het bericht heeft verwerkt: het geeft false terug als er binnen de time-out geen antwoord komt.

Ja. Stel Port = 8883 en TLS = true in op de TsgcWebSocketClient, kies de versie in TLSOptions.Version (tot TLS 1.3) en voeg TLSOptions.CertFile en KeyFile toe als de broker om een clientcertificaat vraagt.

Ja, dat is de standaard van het transport. Laat Specifications.RFC6455 aan, stel Options.Parameters in op het WebSocket-pad van de broker (bijvoorbeeld /mqtt) en gebruik TLS = true op poort 443 voor wss://. Zo komt MQTT door firewalls die alleen HTTPS toestaan.

.NET Framework 2.0 tot 4.8.1, .NET Core 1.0 tot 3.1, .NET 5 tot .NET 10 en .NET Standard 1.6 en 2.0, op Windows, Linux en macOS. Installeer esegece.sgcWebSockets of het gratis package esegece.sgcWebSockets.Community van nuget.org.

Ja. De Community-editie bevat de MQTT-client en is gratis voor commercieel en niet-commercieel gebruik door kleine teams (minder dan EUR 1 mln omzet, tot 5 ontwikkelaars), met een opstartmelding. Grotere organisaties kopen Professional, vanaf €149 per ontwikkelaar, of Enterprise.

Meer over sgcWebSockets .NET

C# WebSocket-bibliotheek

De WebSocket-client en -server die het MQTT-verkeer dragen, met TLS, compressie en automatisch opnieuw verbinden.

.NET-functiematrix

Elke component en elk protocol in de .NET-edities, MQTT, AMQP, STOMP, AWS IoT en Azure IoT inbegrepen.

Download

Community-editie, NuGet-packages en de gecompileerde .NET-demo's, waaronder MQTT Client en MQTT Console.

Ook voor Delphi en C++Builder

Dezelfde MQTT-client is beschikbaar voor Delphi en C++Builder, met dezelfde klasse TsgcWSPClient_MQTT en dezelfde gebeurtenissen.

De beste deal: All-AccessElk eSeGeCe-product, inclusief Premium-ondersteuning, vanaf €1,059 per jaar.
Bekijk de All-Access-prijzen

Publiceer vandaag je eerste MQTT-bericht vanuit C#

Download de proefversie of installeer esegece.sgcWebSockets.Community vanuit NuGet. Professional vanaf €149 per ontwikkelaar.