Skip to content

Commit

Permalink
Updated README with enableDiscovery
Browse files Browse the repository at this point in the history
  • Loading branch information
mrbig committed Jan 26, 2019
1 parent 99816ae commit 56fdd56
Showing 1 changed file with 15 additions and 1 deletion.
16 changes: 15 additions & 1 deletion addons/binding/org.openhab.binding.modbus.sunspec/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -32,6 +32,20 @@ You need first to set up either a TCP or a Serial Modbus bridge according to the

The preferred way to add new things is by using the discovery feature. This way the binding will automatically detect if the Modbus bridge supports the SunSpec protocol and if so what type of models are available. It will automatically detect the register addresses for each model.

### Auto discovering things

This bingind fully supports modbus auto discovery, that means all supported profiles should appear in the inbox once you connect your device.

Auto discovery is turned off by default in the modbus binding so you have to enable it manually.

You can add `enableDiscovery=true` attribute to your bridge config, or you can enable it in the paper ui under the modbus tcp|serial slave thing.

A typical bridge configuration would looke like this:

```
Bridge modbus:tcp:bridge [ host="10.0.0.2", port=502, id=1, enableDiscovery=true ]
```

### Adding things manually

If you decide to add a thing manually then first you have to find out the start address of the model block and the length of it. While the length is usually fixed the address isn't. Please refer to your device's vendor documentation how model blocks are laid for your equipment.
Expand Down Expand Up @@ -238,4 +252,4 @@ If you want to extend the bundle yourself, you have to do the followings:
- To include your block type in auto discovery you have to add its id to the `SUPPORTED_THING_TYPES_UIDS` map in `SunSpecBindingConstants`. This is enough for our discovery process to include your thing type in the results.

If you have questions or need help don't hesitate to contact us.


0 comments on commit 56fdd56

Please sign in to comment.