Skip to content

Commit 30f9d4a

Browse files
committed
📝 Updated documentation
1 parent 7fc89d7 commit 30f9d4a

File tree

1 file changed

+6
-6
lines changed

1 file changed

+6
-6
lines changed

README.md

+6-6
Original file line numberDiff line numberDiff line change
@@ -3,8 +3,8 @@ An example project that implements following packages in a ASP.NET 5 MQTT Broker
33

44
## Current Implemented Package Status:
55
- [**MQTTnet**](https://github.com/chkr1011/MQTTnet) - `v3.0.16` - Working
6-
- [**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
7-
- [**Saunter**](https://github.com/tehmantra/saunter) - `v0.3.1` - Working
6+
- [**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
7+
- [**Saunter**](https://github.com/tehmantra/saunter) - `v0.4.0` - Working *(Newer versions will break documentation generation)*
88

99
## Some Notes:
1010
- Tested with [**MQTTnet.App**](https://github.com/chkr1011/MQTTnet.App) as the client, configured as following:
@@ -13,15 +13,15 @@ An example project that implements following packages in a ASP.NET 5 MQTT Broker
1313
- Host: `localhost:5000/mqtt`
1414
- Port: `5000`
1515
- 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
16-
- 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:
16+
- 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**:
1717
- `ExampleController/publish/<PostalCode>/temperature`
1818
- PostalCode: `90210`
1919
- Payload: `int`
2020
- `ExampleController/publish/test`
2121
- Payload: `string`
22-
- 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:
23-
- `MqttService/subscribe/kiss-message`
24-
- It will send a Payload every 5 minutes after a client has connected
22+
- 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**:
23+
- `MqttService/subscribe/kiss`
24+
- It will send a Payload every `KissIntervalSeconds` *(Configurable in `appsettings.json`)* for as long as there are clients connected.
2525
- Payload: `$"MQTTnet hosted on {frameworkName} is still running at {DateTime.Now}!"`
2626
- Here you can also configure various MQTT Broker related settings / handlers
2727
- [**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 commit comments

Comments
 (0)