DEV Community

Eduardo Julião
Eduardo Julião

Posted on

Basic MQTT with C#

#iot #mqtt #csharp

In this post, we're going to have a look on how to work with MQTT and Csharp. Creating a Broker and a Client that sends data to it.

But first...

What is MQTT?

According to the MQTT.org:

MQTT (short for Message Queuing Telemetry Transport) is an OASIS standard messaging protocol for the Internet of Things (IoT). It is designed as an extremely lightweight publish/subscribe messaging transport that is ideal for connecting remote devices with a small code footprint and minimal network bandwidth. MQTT today is used in a wide variety of industries, such as automotive, manufacturing, telecommunications, oil and gas, etc.

Coding

Project structure

The project structure contains a .sln file and two c# console projects, as it follows:

.
├── MQTTFirstLook.Broker
├── MQTTFirstLook.Client
└── MQTTFirstLook.sln
Enter fullscreen mode Exit fullscreen mode

Libraries used

MQTTNet
MQTTnet.Extensions.ManagedClient
Serilog
Serilog.Sinks.Console
Newtonsoft.Json

Broker implementation

This small broker implementation has the responsibility to read data received from connected clients and display it on the screen.

For this, we're going to create a new MQTTServer that listen to the port 707 on localhost.

Here is what is needed:

Usings

These are the libraries used by the server.

using System;
using System.Text;
using MQTTnet;
using MQTTnet.Server;
using Serilog;
Enter fullscreen mode Exit fullscreen mode

Implementation

Here's how we create a new MQTTServer. In this example, this code is inside the void Main(string[] args) method.


// Create the options for our MQTT Broker
MqttServerOptionsBuilder options = new MqttServerOptionsBuilder()
                                     // set endpoint to localhost
                                     .WithDefaultEndpoint()
                                     // port used will be 707
                                     .WithDefaultEndpointPort(707) 
                                     // handler for new connections
                                     .WithConnectionValidator(OnNewConnection) 
                                     // handler for new messages
                                     .WithApplicationMessageInterceptor(OnNewMessage);

// creates a new mqtt server     
IMqttServer mqttServer = new MqttFactory().CreateMqttServer();

// start the server with options  
mqttServer.StartAsync(options.Build()).GetAwaiter().GetResult();

// keep application running until user press a key
Console.ReadLine();
Enter fullscreen mode Exit fullscreen mode

Handlers

Handlers are callbacks that MQTT calls whenever an action is called. In this example, we have a handler for new connections and for whenever the server gets a new message.

public static void OnNewConnection(MqttConnectionValidatorContext context)
{
    Log.Logger.Information(
            "New connection: ClientId = {clientId}, Endpoint = {endpoint}",
            context.ClientId,
            context.Endpoint);
}

public static void OnNewMessage(MqttApplicationMessageInterceptorContext context)
{
    var payload = context.ApplicationMessage?.Payload == null ? null : Encoding.UTF8.GetString(context.ApplicationMessage?.Payload);

    MessageCounter++;

    Log.Logger.Information(
        "MessageId: {MessageCounter} - TimeStamp: {TimeStamp} -- Message: ClientId = {clientId}, Topic = {topic}, Payload = {payload}, QoS = {qos}, Retain-Flag = {retainFlag}",
        MessageCounter,
        DateTime.Now,
        context.ClientId,
        context.ApplicationMessage?.Topic,
        payload,
        context.ApplicationMessage?.QualityOfServiceLevel,
        context.ApplicationMessage?.Retain);
}
Enter fullscreen mode Exit fullscreen mode

Client

In our client, we're going to create a new MQTTClient instance. This instance will connect to our Broker on localhost:707 and send messages to the topic Dev.to/topic/json

What is needed for this implementation is below:

Usings

These are the libraries used by the server.

using System;
using System.Threading.Tasks;
using MQTTnet;
using MQTTnet.Client.Connecting;
using MQTTnet.Client.Disconnecting;
using MQTTnet.Client.Options;
using MQTTnet.Extensions.ManagedClient;
using Newtonsoft.Json;
using Serilog;
Enter fullscreen mode Exit fullscreen mode

Implementation

Our MQTTClient will coonnect to our broker via TCP. And same as the server, this code will be inside void Main(string[] args) method.


// Creates a new client
MqttClientOptionsBuilder builder = new MqttClientOptionsBuilder()
                                        .WithClientId("Dev.To")
                                        .WithTcpServer("localhost", 707);

// Create client options objects
ManagedMqttClientOptions options = new ManagedMqttClientOptionsBuilder()
                        .WithAutoReconnectDelay(TimeSpan.FromSeconds(60))
                        .WithClientOptions(builder.Build())
                        .Build();

// Creates the client object
IManagedMqttClient _mqttClient = new MqttFactory().CreateManagedMqttClient();

// Set up handlers
_mqttClient.ConnectedHandler = new MqttClientConnectedHandlerDelegate(OnConnected);
_mqttClient.DisconnectedHandler = new MqttClientDisconnectedHandlerDelegate(OnDisconnected);
_mqttClient.ConnectingFailedHandler = new ConnectingFailedHandlerDelegate(OnConnectingFailed);

// Starts a connection with the Broker
_mqttClient.StartAsync(options).GetAwaiter().GetResult();

// Send a new message to the broker every second
while (true)
{
    string json = JsonConvert.SerializeObject(new { message = "Heyo :)", sent= DateTimeOffset.UtcNow });
    _mqttClient.PublishAsync("dev.to/topic/json", json);

    Task.Delay(1000).GetAwaiter().GetResult();
}
Enter fullscreen mode Exit fullscreen mode

Handlers

The client Handlers are called when the client recieves a signal that is connection, connection failed and when is disconnected.

public static void OnConnected(MqttClientConnectedEventArgs obj)
{
    Log.Logger.Information("Successfully connected.");
}

public static void OnConnectingFailed(ManagedProcessFailedEventArgs obj)
{
    Log.Logger.Warning("Couldn't connect to broker.");
}

public static void OnDisconnected(MqttClientDisconnectedEventArgs obj)
{
    Log.Logger.Information("Successfully disconnected.");
}
Enter fullscreen mode Exit fullscreen mode

Ending note

You can find this project on Github

Top comments (11)

Collapse
 
simondarksidej profile image
Simon (Darkside) Jackson •

Great example and got me going quick and simple. Needs updating to the latest version of mqtt, but a fantastic start.

Collapse
 
djaus2 profile image
David Jones •

This is a clear and simple guide for getting started with MQTTnet, Thanks.
I am looking at using it for sending Telemetry to an Azure IoT Hub. The only chenages I have made thus far are:

                MqttClientOptionsBuilder builder = new MqttClientOptionsBuilder()
                                        .WithClientId(Secrets.deviceId)
                                        .WithTcpServer(Secrets.IOT_CONFIG_IOTHUB_FQDN, 8883);
Enter fullscreen mode Exit fullscreen mode

IOT_CONFIG_IOTHUB_FQDN is of the form HUB_NAME.azure-devices.net
It "works" OK but doesn't report connect/non connection, but doesn't fail.
Does report non connection if incorrect Hub FQDN is used.

I understand I have to create a secure connection using the SAS key or connection string.
Any ideas of how to proceed? I can manually get the SAS key so can skip that code.

Thx in advance.

Collapse
 
djaus2 profile image
David Jones •

Nb: Can attempt to send messages. They do get queued.

Collapse
 
djaus2 profile image
David Jones • • Edited

Have improved my code. Got to work out Authentication:

                MqttClientOptionsBuilder builder = new MqttClientOptionsBuilder()
                                        .WithClientId(Secrets.deviceId)
                                        .WithTls()
                                        //.WithAuthentication( )
                                        .WithTcpServer(Secrets.IOT_CONFIG_IOTHUB_FQDN, Secrets.MqttPort);
Enter fullscreen mode Exit fullscreen mode
Collapse
 
nhatanhni profile image
nhatanhni •

thanks

Collapse
 
qtaza profile image
QT •

Thanks for this code example! 👍

In github code, you have ApplicationMessageReceivedHandler which is probably never called in this sample. (not working for me localy)

Collapse
 
codemaker profile image
codemaker •

Nice article, Could you please give tutorial or article on enabling TLS on MQTT communication? also explain more on port 8883. It helps

Collapse
 
thanhdt2782 profile image
thanhdt2782 •

Thanks.

Collapse
 
simonong profile image
simonong •

Hi: Is there anyway to poll the Topic and payload instead of using event?
or the broker will send the message periodically ?

Collapse
 
elgamily profile image
Hassan Elgamily •

How to connect Client to Broker remotely on two different devices?

Collapse
 
rmaurodev profile image
Ricardo •

According to the documentation there are multiple protocol communication you can use, such as websocket, socket and even http.

Check out the documentation for more details

View full discussion (11 comments)

Read next

bytehide profile image

Everything New in .NET 9: The Ultimate Developer's Guide

ByteHide -

moh_moh701 profile image

C# Clean Code: Commenting Conventions

mohamed Tayel -

juarezasjunior profile image

C# Tip: Prefer String Interpolation over Concatenation

Juarez Júnior -

yeehawtoast profile image

A .NET TUI for Advent of Code

Christopher Smith -