Skip to content

Commit

Permalink
📝 Updated documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
Rikj000 committed Aug 11, 2021
1 parent 7fc89d7 commit 30f9d4a
Showing 1 changed file with 6 additions and 6 deletions.
12 changes: 6 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,8 +3,8 @@ An example project that implements following packages in a ASP.NET 5 MQTT Broker

## Current Implemented Package Status:
- [**MQTTnet**](https://github.com/chkr1011/MQTTnet) - `v3.0.16` - Working
- [**MQTTnet - AspNetCore - AttributeRouting**](https://github.com/Atlas-LiftTech/MQTTnet.AspNetCore.AttributeRouting) - `v3.0.16` (Forked, see [NuGet](https://www.nuget.org/packages/MQTTnet.AspNetCore.AttributeRouting.Forked/)) - Working
- [**Saunter**](https://github.com/tehmantra/saunter) - `v0.3.1` - Working
- [**MQTTnet - AspNetCore - AttributeRouting**](https://github.com/Atlas-LiftTech/MQTTnet.AspNetCore.AttributeRouting) - `v3.0.16` *(Forked, see [NuGet](https://www.nuget.org/packages/MQTTnet.AspNetCore.AttributeRouting.Forked/))* - Working
- [**Saunter**](https://github.com/tehmantra/saunter) - `v0.4.0` - Working *(Newer versions will break documentation generation)*

## Some Notes:
- Tested with [**MQTTnet.App**](https://github.com/chkr1011/MQTTnet.App) as the client, configured as following:
Expand All @@ -13,15 +13,15 @@ An example project that implements following packages in a ASP.NET 5 MQTT Broker
- Host: `localhost:5000/mqtt`
- Port: `5000`
- A [**CatchAllController**](https://github.com/Rikj000/Saunter-MQTTnet-AspNet5-AttributeRouting-ExampleProject/blob/main/Saunter-MQTTnet-AspNet5-AttributeRouting-ExampleProject/Controllers/Mqtt/CatchAllController.cs) has been implemented, this will log all MQTT related messages going in/out of the MQTTnet Broker/Server
- A (MQTT) [**ExampleController**](https://github.com/Rikj000/Saunter-MQTTnet-AspNet5-AttributeRouting-ExampleProject/blob/main/Saunter-MQTTnet-AspNet5-AttributeRouting-ExampleProject/Controllers/Mqtt/ExampleController.cs) has been implemented with following Publish Topics:
- A (MQTT) [**ExampleController**](https://github.com/Rikj000/Saunter-MQTTnet-AspNet5-AttributeRouting-ExampleProject/blob/main/Saunter-MQTTnet-AspNet5-AttributeRouting-ExampleProject/Controllers/Mqtt/ExampleController.cs) has been implemented with following **Publish Topics**:
- `ExampleController/publish/<PostalCode>/temperature`
- PostalCode: `90210`
- Payload: `int`
- `ExampleController/publish/test`
- Payload: `string`
- The [**MqttService**](https://github.com/Rikj000/Saunter-MQTTnet-AspNet5-AttributeRouting-ExampleProject/blob/main/Saunter-MQTTnet-AspNet5-AttributeRouting-ExampleProject/Services/MqttService.cs) has been implemented with following Subscribe Topic:
- `MqttService/subscribe/kiss-message`
- It will send a Payload every 5 minutes after a client has connected
- The [**MqttService**](https://github.com/Rikj000/Saunter-MQTTnet-AspNet5-AttributeRouting-ExampleProject/blob/main/Saunter-MQTTnet-AspNet5-AttributeRouting-ExampleProject/Services/MqttService.cs) has been implemented with following **Subscribe Topic**:
- `MqttService/subscribe/kiss`
- It will send a Payload every `KissIntervalSeconds` *(Configurable in `appsettings.json`)* for as long as there are clients connected.
- Payload: `$"MQTTnet hosted on {frameworkName} is still running at {DateTime.Now}!"`
- Here you can also configure various MQTT Broker related settings / handlers
- [**Startup**](https://github.com/Rikj000/Saunter-MQTTnet-AspNet5-AttributeRouting-ExampleProject/blob/main/Saunter-MQTTnet-AspNet5-AttributeRouting-ExampleProject/Startup.cs) is where most of the other Package configuration happens

0 comments on commit 30f9d4a

Please sign in to comment.