Skip to content

Commit 43a6076

Browse files
committed
Update README.md
1 parent 8cfaaab commit 43a6076

File tree

1 file changed

+7
-10
lines changed

1 file changed

+7
-10
lines changed

README.md

Lines changed: 7 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -218,7 +218,7 @@ For that, you need to a `Device` node with the correct brand/model attributes fo
218218
- The serial number is required for In One by Legrand and MyHome Play devices and optional for MyHome Up devices.
219219
- The unit node is not used for MyHome Up devices but is generally required for In One by Legrand and MyHome Play devices.
220220
- The unit must match one of the unit identifiers offered by the specific device. If you're unsure what identifier should be used,
221-
you can see [OpenNettyDevices.xml](src/OpenNetty/OpenNettyDevices.xml) for a list of all the supported devices and the units they expose.
221+
you can see [`OpenNettyDevices.xml`](src/OpenNetty/OpenNettyDevices.xml) for a list of all the supported devices and the units they expose.
222222
- For MyHome Up devices, the area/point attributes must match the values assigned via [MyHome Suite](https://www.homesystems-legrandgroup.com/home?p_p_id=it_smc_bticino_homesystems_search_AutocompletesearchPortlet&p_p_lifecycle=0&p_p_state=normal&p_p_mode=view&_it_smc_bticino_homesystems_search_AutocompletesearchPortlet_journalArticleId=2493426&_it_smc_bticino_homesystems_search_AutocompletesearchPortlet_mvcPath=%2Fview_journal_article_content.jsp).
223223
- The endpoint name must be chosen carefully as it will be used to infer the MQTT topic used for the endpoint (e.g state changes dispatched
224224
by an endpoint named `Bedroom/Wall light` will be posted under the `opennetty/bedroom/wall light` MQTT topic).
@@ -304,6 +304,12 @@ sudo service opennetty start
304304
>
305305
> You can also send an empty `opennetty/bedroom/wall light/switch_state/get` message to get the current switch state of the endpoint.
306306
307+
> [!TIP]
308+
> The complete list of supported MQTT attributes can be found in the [`OpenNettyMqttAttributes.cs` file](src/OpenNetty.Mqtt/OpenNettyMqttAttributes.cs).
309+
>
310+
> Ready-to-use templates for Jeedom's [jMQTT plugin](https://market.jeedom.com/index.php?v=d&p=market_display&id=3166)
311+
> can be found in the [opennetty-resources](https://github.com/opennetty/opennetty-resources) repository.
312+
307313
## Using OpenNetty as a library
308314

309315
### Primitives
@@ -405,9 +411,6 @@ and extract the corresponding response returned by the gateway, if applicable:
405411
```csharp
406412
var builder = Host.CreateApplicationBuilder();
407413
408-
builder.Services.AddSystemd()
409-
.AddWindowsService();
410-
411414
builder.Services.AddOpenNetty(options =>
412415
{
413416
// Register the SCS gateway used to communicate with MyHome devices.
@@ -449,9 +452,6 @@ await app.StopAsync();
449452
```csharp
450453
var builder = Host.CreateApplicationBuilder();
451454

452-
builder.Services.AddSystemd()
453-
.AddWindowsService();
454-
455455
builder.Services.AddOpenNetty(options =>
456456
{
457457
options.AddGateway(OpenNettyGateway.Create(
@@ -511,9 +511,6 @@ By implementing the `IOpenNettyHandler` interface, it is possible to subscribe t
511511
```csharp
512512
var builder = Host.CreateApplicationBuilder();
513513

514-
builder.Services.AddSystemd()
515-
.AddWindowsService();
516-
517514
builder.Services.AddOpenNetty(options =>
518515
{
519516
var file = builder.Environment.ContentRootFileProvider.GetFileInfo("OpenNettyConfiguration.xml");

0 commit comments

Comments
 (0)