C# i .NET MQTT 3.1.1 i 5.0

Klient MQTT dla C# dla MQTT 3.1.1 i 5.0

Łącz aplikacje C# z dowolnym brokerem MQTT przez TCP lub WebSocket za pomocą tego klienta MQTT dla .NET, od .NET Framework 2.0 do .NET 10.

MQTT 3.1.1 i MQTT 5.0
QoS 0, 1 i 2
TLS przez TCP lub WebSocket
Last will, retain, keep-alive

Połącz, subskrybuj i publikuj w C# → · Zobacz cennik →

Klient MQTT dla 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;

Klient MQTT oparty na kliencie sgcWebSockets

Jeden komponent transportu, jeden komponent protokołu, zdarzenia dla każdego pakietu MQTT.

Klient MQTT dla C# w sgcWebSockets .NET to TsgcWSPClient_MQTT, w przestrzeni nazw esegece.sgcWebSockets. Sam nie otwiera gniazd. Przypisujesz TsgcWebSocketClient do jego właściwości Client, a ten klient przenosi pakiety MQTT jako zwykły strumień TCP (porty 1883 i 8883) lub wewnątrz ramek WebSocket dla brokerów udostępniających punkt końcowy MQTT przez WebSocket. Host, port, TLS, proxy i automatyczne łączenie ponowne pozostają w transporcie, a sesja MQTT, tematy i QoS są w komponencie protokołu.

Każda odpowiedź brokera staje się zdarzeniem C#: OnMQTTConnect, OnMQTTPublish, OnMQTTSubscribe, OnMQTTPubAck, OnMQTTPubRec, OnMQTTPubComp, OnMQTTPing i OnMQTTDisconnect, a także OnMQTTAuth dla rozszerzonego uwierzytelniania MQTT 5.0. Ten sam pakiet obsługuje .NET Framework 2.0 do 4.8.1, .NET Core 1.0 do 3.1, .NET 5 do .NET 10 oraz .NET Standard 1.6 i 2.0, w systemach Windows, Linux i macOS.

MQTT 3.1.1 i 5.0

Wybierz protokół przez MQTTVersion: TwsMQTTVersion.mqtt311 lub TwsMQTTVersion.mqtt5.

TCP lub WebSocket

Specifications.RFC6455 = false w transporcie wysyła surowy MQTT przez TCP; zostaw włączone, aby tunelować MQTT przez ścieżkę WebSocket.

Trzy poziomy QoS

TmqttQoS.mtqsAtMostOnce, mtqsAtLeastOnce i mtqsExactlyOnce przy każdej publikacji i subskrypcji.

Kontrola sesji

Nazwa użytkownika i hasło w Authentication, pingi keep-alive w HeartBeat, last will w LastWillTestament.

Połącz, subskrybuj i publikuj w C#

Zainstaluj pakiet NuGet esegece.sgcWebSockets (lub esegece.sgcWebSockets.Community), a potem wykonaj cztery kroki.

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;

Dema WinForms MQTT Client i MQTT Console w pakiecie .NET do pobrania podłączają te same wywołania do formularza, z listą brokerów, ustawieniami TLS i proxy oraz opcjami QoS i retain.

MQTT QoS 0, 1 i 2 z C#

Przekaż wartość TmqttQoS do Publish, PublishAndWait lub Subscribe. Przy QoS 1 i 2 klient wysyła wiadomość ponownie, gdy potwierdzenie nie nadejdzie na czas. Obsłuż OnMQTTPubAck lub OnMQTTPubComp, aby śledzić dostarczenie, lub wywołaj PublishAndWait, które zwraca false, gdy broker nie odpowie w limicie czasu (domyślnie 10 sekund).

QoSWartość C#DostarczenieZdarzenie potwierdzenia
0TmqttQoS.mtqsAtMostOnceCo najwyżej raz, w miarę możliwości, bez odpowiedzibrak
1TmqttQoS.mtqsAtLeastOnceCo najmniej raz, potwierdzone przez brokeraOnMQTTPubAck
2TmqttQoS.mtqsExactlyOnceDokładnie raz, uzgadnianie w czterech krokachOnMQTTPubRec, OnMQTTPubComp

TLS, poświadczenia, last will i keep-alive

TLS na porcie 8883

Ustaw TLS = true w transporcie i wybierz protokół w TLSOptions.Version, do TLS 1.3. Dla brokerów wymagających certyfikatów klienta TLSOptions przyjmuje także CertFile, KeyFile, Password i RootCertFile, a VerifyCertificate sprawdza certyfikat serwera.

Nazwa użytkownika i hasło

Authentication.Enabled, Authentication.UserName i Authentication.Password trafiają do pakietu CONNECT.

Last will

LastWillTestament ustawia Topic, Text, QoS i Retain, więc broker publikuje wiadomość „offline”, gdy urządzenie rozłączy się bez czystego rozłączenia.

Keep-alive

HeartBeat.Enabled i HeartBeat.Interval wysyłają pakiety PINGREQ; OnMQTTPing zgłasza każdą odpowiedź, a Ping() wysyła jeden na żądanie.

Identyfikator klienta i czysta sesja

OnMQTTBeforeConnect przekazuje CleanSession i ClientIdentifier przez referencję, więc wybierasz sesję trwałą i stały identyfikator klienta dla każdego urządzenia.

Proxy i ponowne łączenie

Ustawienia Proxy transportu i automatyczne łączenie ponowne WatchDog działają w MQTT bez zmian.

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

Funkcje MQTT 5.0 w C#

Ustaw MQTTVersion = TwsMQTTVersion.mqtt5, a klient mówi MQTT 5.0. Każde zdarzenie potwierdzenia niesie wtedy ReasonCode i ReasonName brokera wraz z właściwościami pakietu, więc błędy przychodzą z przyczyną zamiast zerwanego połączenia.

Właściwości połączenia

ConnectProperties ustawia SessionExpiryInterval, ReceiveMaximum, MaximumPacketSize, TopicAliasMaximum, UserProperties i flagi żądań informacji o odpowiedzi i problemie.

Właściwości publikacji

Dla każdej wiadomości ContentType, ResponseTopic, CorrelationData, MessageExpiryInterval, TopicAlias, PayloadFormat i właściwości użytkownika dla wzorców żądanie-odpowiedź.

Rozszerzone uwierzytelnianie

Auth() wysyła pakiety AUTH z AuthenticationMethod i AuthenticationData, w tym ponowne uwierzytelnianie, a OnMQTTAuth odbiera wyzwanie brokera.

Właściwości will i rozłączenia

Opóźnienie will i wygaśnięcie wiadomości w last will oraz kod przyczyny, ciąg przyczyny i wygaśnięcie sesji w 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);

Dowolny standardowy broker MQTT, a także AWS IoT i Azure IoT

Ponieważ klient stosuje specyfikacje MQTT 3.1.1 i 5.0, łączy się zarówno z brokerami własnymi, jak i zarządzanymi: na porcie 1883 dla zwykłego TCP, 8883 dla TLS lub przez ścieżkę WebSocket brokera, gdy otwarte są tylko porty HTTPS. Dla chmurowych platform IoT sgcWebSockets .NET zawiera też klienta AWS IoT dla AWS IoT Core i klienta Azure IoT dla Azure IoT Hub, oba oparte na MQTT, wymienione w macierzy funkcji .NET.

Ta sama biblioteka daje Ci też AMQP 0.9.1 i 1.0, STOMP, Kafka oraz klienta i serwer WebSocket dla C#, więc jedna zależność obejmuje każdy protokół komunikacyjny w aplikacji.

Bezpłatny start, jedna cena za każdy protokół

Klient MQTT jest w każdej edycji .NET. Community jest bezpłatna do użytku komercyjnego i niekomercyjnego dla małych zespołów (przychód poniżej 1 mln EUR, do 5 programistów), z pełnym zestawem funkcji i informacją przy uruchomieniu. Professional usuwa informację i zaczyna się od €149 za programistę z 1 rokiem aktualizacji; Enterprise dodaje kod źródłowy do przebudowy assemblies. Licencje Team i Site są na stronie cennika (zakładka .NET).

Pytania o MQTT w C#

Utwórz TsgcWebSocketClient z Host i Port brokera, ustaw Specifications.RFC6455 = false dla zwykłego brokera TCP, utwórz TsgcWSPClient_MQTT i przypisz klienta do jego właściwości Client. Ustawienie client.Active = true otwiera połączenie, a OnMQTTConnect zgłasza się, gdy broker zaakceptuje sesję.

Tak. Ustaw MQTTVersion na TwsMQTTVersion.mqtt5 dla MQTT 5.0 lub TwsMQTTVersion.mqtt311 dla MQTT 3.1.1. MQTT 5.0 dodaje kody przyczyn przy każdym potwierdzeniu, właściwości połączenia i publikacji, właściwości użytkownika i rozszerzone uwierzytelnianie.

Wywołaj Publish(topic, text, TmqttQoS.mtqsAtLeastOnce) lub TmqttQoS.mtqsExactlyOnce, opcjonalnie z flagą retain. Użyj PublishAndWait, gdy kod musi wiedzieć, że broker przetworzył wiadomość: zwraca false, jeśli odpowiedź nie nadejdzie w limicie czasu.

Tak. Ustaw Port = 8883 i TLS = true w TsgcWebSocketClient, wybierz wersję w TLSOptions.Version (do TLS 1.3) i dodaj TLSOptions.CertFile oraz KeyFile, jeśli broker wymaga certyfikatu klienta.

Tak, to domyślny transport. Zostaw włączone Specifications.RFC6455, ustaw Options.Parameters na ścieżkę WebSocket brokera (na przykład /mqtt) i użyj TLS = true na porcie 443 dla wss://. Dzięki temu MQTT przechodzi przez zapory, które przepuszczają tylko HTTPS.

.NET Framework 2.0 do 4.8.1, .NET Core 1.0 do 3.1, .NET 5 do .NET 10 oraz .NET Standard 1.6 i 2.0, w systemach Windows, Linux i macOS. Zainstaluj esegece.sgcWebSockets lub bezpłatny pakiet esegece.sgcWebSockets.Community z nuget.org.

Tak. Edycja Community zawiera klienta MQTT i jest bezpłatna do użytku komercyjnego i niekomercyjnego dla małych zespołów (przychód poniżej 1 mln EUR, do 5 programistów), z informacją przy uruchomieniu. Większe organizacje kupują Professional, od €149 za programistę, lub Enterprise.

Więcej o sgcWebSockets .NET

Biblioteka WebSocket dla C#

Klient i serwer WebSocket, które przenoszą ruch MQTT, z TLS, kompresją i automatycznym łączeniem ponownym.

Macierz funkcji .NET

Każdy komponent i protokół w edycjach .NET, w tym MQTT, AMQP, STOMP, AWS IoT i Azure IoT.

Pobierz

Edycja Community, pakiety NuGet i skompilowane dema .NET, między innymi MQTT Client i MQTT Console.

Także dla Delphi i C++Builder

Ten sam klient MQTT jest dostępny dla Delphi i C++Builder, z tą samą klasą TsgcWSPClient_MQTT i zdarzeniami.

Najkorzystniejsza oferta: All-AccessWszystkie produkty eSeGeCe, ze wsparciem Premium w cenie, już od €1,059 rocznie.
Zobacz cennik All-Access

Opublikuj swoją pierwszą wiadomość MQTT z C# już dziś

Pobierz wersję próbną lub zainstaluj esegece.sgcWebSockets.Community z NuGet. Professional od €149 za programistę.