Add shared MQTT client and ResourceManagement-based MQTT integration service

[MathoMathiasCamara]

The following Issue is resolved in this PR.

Motivation :

Based on #656 and #657, we want to allow applications to share resources throughout multiple MORYX instances.

This PR contains the following features:

• New feautures :
  • A shared MQTT client called IManagedMqttClient
  • ResourceSynchronizationService (Listen to resource change event and sends a message to the broker)
• Old feature that were refactored to work with the new IManagedMqttClient
  • An MqttEndpointService for topic template support ex: "my-topic/{id:int}/invoke/{methodName}"
  • A ResourceEventService (listen to public Resource events and sends a message to the broker)
  • A ResourceRpcEndpoint (when the client receives a method invocation message, the method is invoked on the matching resource , any return value (except Task<T>) is sent back to the broker)

How the new feature works ?

Mqtt Service

Config/Moryx.Mqtt.Config.json

  {
    "Host": "localhost",
    "Port": 1883,
    "Id": "device-2",
    "Username": null,
    "Password": null,
    "Tls": false,
    "QoS": 1,
    "ReconnectDelayMs": 30000,
    "ReconnectWithClientSession": true,
    "ConfigState": "Generated",
    "RootTopic":  "moryx/device-2"
  }

// BlablaService.cs
 public class BlablaService : IMqttService
 {
    private IMyDependency _dependency;
    private IManagedMqttClient _client;
    public Blabla(IMyDependency dependency, IManagedMqttClient client)
    {
        _dependency = dependency;
        _client = client;
    }

    // </inherited>
    public override Task StartAsync(CancellationToken cancellationToken)
    {
        // your logic here
        // _client.OnConnectedAync += ....
        // _client.OnMessagereceived += ...
        return Task.CompletedTask;
    }

    // </inherited>
    public override Task StopAsync(CancellationToken cancellationToken)
    {
        //your logic here
        return Task.CompletedTask;
    }
 }
 

 // Program.cs

  builder.Services.AddMqttClient("Moryx.Mqtt.Config")
      .AddMqttService<BlablaService>()

Endpoint feature

Example 1 :

// Program.cs
  builder.Services.AddMqttClient()
     .AddMqttEndpoints(builder =>
{
    builder.MapGet("my-topic/{id:int}", ctx =>
    {
         var messageBuilder = new MqttApplicationMessageBuilder();
        messageBuilder.WithTopic("another-topic");
        messageBuilder.WithPayload(MqttMessageSerialization.GetJsonPayload("Hello World!!!!"));
        return messageBuilder.Build();
    });
});

Example 2:

// Program.cs
  builder.Services.AddMqttClient()
     .AddMqttEndpoints();

// BlablaEndpoint.cs
 public class Blabla : IMqttEndpoint 
 {
    private IMyDependency _dependency;
    public Blabla(IMyDependency dependency)
    {
        _dependency = dependency;
    }

    public void Map(IMqttRouteBuilder route)
    {
        //topic template is supported here
        route.MapGet("my-topic/{id:int}/method/{methodName}", context =>
        {
             var messageBuilder = new MqttApplicationMessageBuilder();
            messageBuilder.WithTopic("another-topic");
            messageBuilder.WithPayload(MqttMessageSerialization.GetJsonPayload("Hello World!!!!"));
            return messageBuilder.Build();
        });
    }
}

[dbeuchler]

If you want it is better to reference the file as a link or use a markdown table with value and description. Dont copy code in docs...

[dbeuchler]

Same here.. why do you copy the code to the docs?

[dbeuchler]

why must the filename be defined? The config manager normally does that automatically by the typename. Which class is used for the serialization?

[dbeuchler]

sometimes you use csharp, sometimes cs - i vote for constistant usage of cs.

[dbeuchler]

Again copied code to docs..

[dbeuchler]

Its a special case.. this Endpoint has a dependency to mqtt stuff, and I definitely don't want a reference to that in Moryx.AbstractionLayer.Resources.Endpoints. For my POV, this endpoint should be separated because I also dont see a reference of Moryx.AbstractionLayer in Moryx.Communication.Mqtt

[dbeuchler]

Moryx.Communication.Mqtt should not reference Moryx.AbstractionLayer nor Moryx.Runtime

[dbeuchler]

Why is the readme placed within the package and not part of the documentation?

[dbeuchler]

Where do they come from? Maybe reference another doc instead of copy the stuff into these docs.