C# y .NET MQTT 3.1.1 y 5.0

Cliente MQTT para C# para MQTT 3.1.1 y 5.0

Conecta aplicaciones C# a cualquier broker MQTT por TCP o WebSocket con este cliente MQTT para .NET, desde .NET Framework 2.0 hasta .NET 10.

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

Conecta, suscríbete y publica en C# → · Ver precios →

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;

Un cliente MQTT que se apoya en el cliente de sgcWebSockets

Un componente de transporte, un componente de protocolo, eventos para cada paquete MQTT.

El cliente MQTT para C# de sgcWebSockets .NET es TsgcWSPClient_MQTT, en el espacio de nombres esegece.sgcWebSockets. No abre sockets por sí mismo. Asignas un TsgcWebSocketClient a su propiedad Client, y ese cliente transporta los paquetes MQTT como un flujo TCP simple (puertos 1883 y 8883) o dentro de tramas WebSocket para brokers que exponen un endpoint de MQTT sobre WebSocket. El host, el puerto, TLS, el proxy y la reconexión automática se quedan en el transporte, y la sesión MQTT, los topics y el QoS viven en el componente de protocolo.

Cada respuesta del broker se convierte en un evento de C#: OnMQTTConnect, OnMQTTPublish, OnMQTTSubscribe, OnMQTTPubAck, OnMQTTPubRec, OnMQTTPubComp, OnMQTTPing y OnMQTTDisconnect, además de OnMQTTAuth para la autenticación mejorada de MQTT 5.0. El mismo paquete apunta a .NET Framework 2.0 a 4.8.1, .NET Core 1.0 a 3.1, .NET 5 a .NET 10 y .NET Standard 1.6 y 2.0, en Windows, Linux y macOS.

MQTT 3.1.1 y 5.0

Elige el protocolo con MQTTVersion: TwsMQTTVersion.mqtt311 o TwsMQTTVersion.mqtt5.

TCP o WebSocket

Specifications.RFC6455 = false en el transporte envía MQTT sin procesar por TCP; déjalo activado para encapsular MQTT en una ruta WebSocket.

Tres niveles de QoS

TmqttQoS.mtqsAtMostOnce, mtqsAtLeastOnce y mtqsExactlyOnce en cada publicación y suscripción.

Control de sesión

Usuario y contraseña en Authentication, pings de keep-alive en HeartBeat, un last will en LastWillTestament.

Conecta, suscríbete y publica en C#

Instala el paquete NuGet esegece.sgcWebSockets (o esegece.sgcWebSockets.Community) y sigue los cuatro pasos.

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;

Las demos de WinForms MQTT Client y MQTT Console de la descarga de .NET conectan las mismas llamadas a un formulario, con una lista de brokers, ajustes de TLS y proxy, y opciones de QoS y retain.

MQTT QoS 0, 1 y 2 desde C#

Pasa un valor TmqttQoS a Publish, PublishAndWait o Subscribe. Con QoS 1 y 2 el cliente reenvía un mensaje cuando la confirmación no llega a tiempo. Gestiona OnMQTTPubAck u OnMQTTPubComp para seguir la entrega, o llama a PublishAndWait, que devuelve false cuando el broker no responde dentro del tiempo de espera (10 segundos por defecto).

QoSValor en C#EntregaEvento de confirmación
0TmqttQoS.mtqsAtMostOnceComo máximo una vez, mejor esfuerzo, sin respuestaninguno
1TmqttQoS.mtqsAtLeastOnceAl menos una vez, confirmado por el brokerOnMQTTPubAck
2TmqttQoS.mtqsExactlyOnceExactamente una vez, protocolo de cuatro pasosOnMQTTPubRec, OnMQTTPubComp

TLS, credenciales, last will y keep-alive

TLS en el puerto 8883

Establece TLS = true en el transporte y elige el protocolo en TLSOptions.Version, hasta TLS 1.3. Para brokers que exigen certificados de cliente, TLSOptions también admite CertFile, KeyFile, Password y RootCertFile, y VerifyCertificate comprueba el certificado del servidor.

Usuario y contraseña

Authentication.Enabled, Authentication.UserName y Authentication.Password van en el paquete CONNECT.

Last will

LastWillTestament establece Topic, Text, QoS y Retain, de modo que el broker publica un mensaje "offline" cuando un dispositivo se cae sin una desconexión limpia.

Keep-alive

HeartBeat.Enabled y HeartBeat.Interval envían paquetes PINGREQ; OnMQTTPing informa de cada respuesta, y Ping() envía uno bajo demanda.

Id de cliente y sesión limpia

OnMQTTBeforeConnect pasa CleanSession y ClientIdentifier por referencia, así que eliges una sesión persistente y un id de cliente fijo por dispositivo.

Proxy y reconexión

Los ajustes de Proxy del transporte y la reconexión automática de WatchDog se aplican a MQTT sin cambios.

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

Características de MQTT 5.0 en C#

Establece MQTTVersion = TwsMQTTVersion.mqtt5 y el cliente habla MQTT 5.0. Cada evento de confirmación lleva entonces el ReasonCode y el ReasonName del broker junto con las propiedades del paquete, de modo que los fallos llegan con un motivo en lugar de una conexión caída.

Propiedades de conexión

ConnectProperties establece SessionExpiryInterval, ReceiveMaximum, MaximumPacketSize, TopicAliasMaximum, UserProperties e indicadores de solicitud de información de respuesta y de problemas.

Propiedades de publicación

Por mensaje ContentType, ResponseTopic, CorrelationData, MessageExpiryInterval, TopicAlias, PayloadFormat y propiedades de usuario para patrones de petición y respuesta.

Autenticación mejorada

Auth() envía paquetes AUTH con un AuthenticationMethod y AuthenticationData, incluida la reautenticación, y OnMQTTAuth recibe el desafío del broker.

Propiedades de will y de desconexión

Un intervalo de retraso del will y una caducidad del mensaje en el last will, además de un código de motivo, una cadena de motivo y la caducidad de la sesión en 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);

Cualquier broker MQTT estándar, más AWS IoT y Azure IoT

Como el cliente sigue las especificaciones MQTT 3.1.1 y 5.0, se conecta tanto a brokers autoalojados como gestionados: en el puerto 1883 para TCP simple, 8883 para TLS, o la ruta WebSocket del broker cuando solo están abiertos los puertos HTTPS. Para las plataformas IoT en la nube, sgcWebSockets .NET también incluye un cliente AWS IoT para AWS IoT Core y un cliente Azure IoT para Azure IoT Hub, ambos basados en MQTT, que aparecen en la matriz de características de .NET.

La misma biblioteca también te ofrece AMQP 0.9.1 y 1.0, STOMP, Kafka y el cliente y servidor WebSocket para C#, de modo que una sola dependencia cubre todos los protocolos de mensajería de la aplicación.

Gratis para empezar, un precio para todos los protocolos

El cliente MQTT está en todas las ediciones de .NET. Community es gratuita para uso comercial y no comercial por equipos pequeños (menos de 1 M EUR de ingresos, hasta 5 desarrolladores), con todas las características y un aviso al iniciar. Professional elimina el aviso y parte de €149 por desarrollador con 1 año de actualizaciones; Enterprise añade el código fuente para recompilar los ensamblados. Las licencias Team y Site están en la página de precios (pestaña .NET).

Preguntas sobre MQTT en C#

Crea un TsgcWebSocketClient con el Host y el Port del broker, establece Specifications.RFC6455 = false para un broker TCP simple, crea un TsgcWSPClient_MQTT y asigna el cliente a su propiedad Client. Al establecer client.Active = true se abre la conexión, y OnMQTTConnect se dispara cuando el broker acepta la sesión.

Sí. Establece MQTTVersion en TwsMQTTVersion.mqtt5 para MQTT 5.0 o en TwsMQTTVersion.mqtt311 para MQTT 3.1.1. MQTT 5.0 añade códigos de motivo en cada confirmación, propiedades de conexión y de publicación, propiedades de usuario y autenticación mejorada.

Llama a Publish(topic, text, TmqttQoS.mtqsAtLeastOnce) o TmqttQoS.mtqsExactlyOnce, opcionalmente con un indicador retain. Usa PublishAndWait cuando el código deba saber que el broker procesó el mensaje: devuelve false si no llega ninguna respuesta dentro del tiempo de espera.

Sí. Establece Port = 8883 y TLS = true en el TsgcWebSocketClient, elige la versión en TLSOptions.Version (hasta TLS 1.3) y añade TLSOptions.CertFile y KeyFile si el broker pide un certificado de cliente.

Sí, es el transporte por defecto. Deja activado Specifications.RFC6455, establece Options.Parameters con la ruta WebSocket del broker (por ejemplo /mqtt) y usa TLS = true en el puerto 443 para wss://. Así MQTT atraviesa los firewalls que solo permiten HTTPS.

.NET Framework 2.0 a 4.8.1, .NET Core 1.0 a 3.1, .NET 5 a .NET 10 y .NET Standard 1.6 y 2.0, en Windows, Linux y macOS. Instala esegece.sgcWebSockets o el paquete gratuito esegece.sgcWebSockets.Community desde nuget.org.

Sí. La edición Community incluye el cliente MQTT y es gratuita para uso comercial y no comercial por equipos pequeños (menos de 1 M EUR de ingresos, hasta 5 desarrolladores), con un aviso al iniciar. Las organizaciones más grandes compran Professional, desde €149 por desarrollador, o Enterprise.

Más sobre sgcWebSockets .NET

Biblioteca WebSocket para C#

El cliente y el servidor WebSocket que transportan el tráfico MQTT, con TLS, compresión y reconexión automática.

Matriz de características de .NET

Todos los componentes y protocolos de las ediciones .NET, MQTT, AMQP, STOMP, AWS IoT y Azure IoT incluidos.

Descargar

Edición Community, paquetes NuGet y las demos .NET compiladas, entre ellas MQTT Client y MQTT Console.

También para Delphi y C++Builder

El mismo cliente MQTT está disponible para Delphi y C++Builder, con la misma clase TsgcWSPClient_MQTT y los mismos eventos.

La mejor opción: All-AccessTodos los productos de eSeGeCe, con Premium Support incluido, desde €1,059 al año.
Ver precios de All-Access

Publica hoy tu primer mensaje MQTT desde C#

Descarga la prueba o instala esegece.sgcWebSockets.Community desde NuGet. Professional desde €149 por desarrollador.