Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
kevinchalet committed Dec 16, 2024
1 parent 8cfaaab commit 43a6076
Showing 1 changed file with 7 additions and 10 deletions.
17 changes: 7 additions & 10 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -218,7 +218,7 @@ For that, you need to a `Device` node with the correct brand/model attributes fo
- The serial number is required for In One by Legrand and MyHome Play devices and optional for MyHome Up devices.
- The unit node is not used for MyHome Up devices but is generally required for In One by Legrand and MyHome Play devices.
- The unit must match one of the unit identifiers offered by the specific device. If you're unsure what identifier should be used,
you can see [OpenNettyDevices.xml](src/OpenNetty/OpenNettyDevices.xml) for a list of all the supported devices and the units they expose.
you can see [`OpenNettyDevices.xml`](src/OpenNetty/OpenNettyDevices.xml) for a list of all the supported devices and the units they expose.
- 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).
- 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
by an endpoint named `Bedroom/Wall light` will be posted under the `opennetty/bedroom/wall light` MQTT topic).
Expand Down Expand Up @@ -304,6 +304,12 @@ sudo service opennetty start
>
> You can also send an empty `opennetty/bedroom/wall light/switch_state/get` message to get the current switch state of the endpoint.
> [!TIP]
> The complete list of supported MQTT attributes can be found in the [`OpenNettyMqttAttributes.cs` file](src/OpenNetty.Mqtt/OpenNettyMqttAttributes.cs).
>
> Ready-to-use templates for Jeedom's [jMQTT plugin](https://market.jeedom.com/index.php?v=d&p=market_display&id=3166)
> can be found in the [opennetty-resources](https://github.com/opennetty/opennetty-resources) repository.
## Using OpenNetty as a library

### Primitives
Expand Down Expand Up @@ -405,9 +411,6 @@ and extract the corresponding response returned by the gateway, if applicable:
```csharp
var builder = Host.CreateApplicationBuilder();
builder.Services.AddSystemd()
.AddWindowsService();
builder.Services.AddOpenNetty(options =>
{
// Register the SCS gateway used to communicate with MyHome devices.
Expand Down Expand Up @@ -449,9 +452,6 @@ await app.StopAsync();
```csharp
var builder = Host.CreateApplicationBuilder();

builder.Services.AddSystemd()
.AddWindowsService();

builder.Services.AddOpenNetty(options =>
{
options.AddGateway(OpenNettyGateway.Create(
Expand Down Expand Up @@ -511,9 +511,6 @@ By implementing the `IOpenNettyHandler` interface, it is possible to subscribe t
```csharp
var builder = Host.CreateApplicationBuilder();

builder.Services.AddSystemd()
.AddWindowsService();

builder.Services.AddOpenNetty(options =>
{
var file = builder.Environment.ContentRootFileProvider.GetFileInfo("OpenNettyConfiguration.xml");
Expand Down

0 comments on commit 43a6076

Please sign in to comment.