Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[modbus] Update README.md #8228

Merged
merged 3 commits into from
Sep 14, 2020
Merged

[modbus] Update README.md #8228

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
49eea6f
Update README.md
Rossko57 Jul 30, 2020
68ed85b
Update README.md
Rossko57 Aug 26, 2020
361f378
Update README.md
Rossko57 Sep 11, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 10 additions & 2 deletions bundles/org.openhab.binding.modbus/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,14 @@ The binding has the following extensions:

<!--list-subs-->

The rest of this page contains details for configuring this binding:

{::options toc_levels="2..4"/}

- TOC
{:toc}



## Main Features

Expand Down Expand Up @@ -168,7 +176,7 @@ You must give each of your bridge Things a reference (thing ID) that is unique f
| Parameter | Type | Required | Default if omitted | Description |
| ------------- | ------- | -------- | ------------------ | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `start` | integer | | `0` | Address of the first register, coil, or discrete input to poll. Input as zero-based index number. |
| `length` | integer | ✓ | (-) | Number of registers, coils or discrete inputs to read. |
| `length` | integer | ✓ | (-) | Number of registers, coils or discrete inputs to read. Note that protocol limits max length, depending on type |
| `type` | text | ✓ | (-) | Type of modbus items to poll. This matches directly to Modbus request type or function code (FC). Valid values are: `"coil"` (FC01), `"discrete"` (FC02), `"holding"`(FC03), `"input"` (FC04). |
| `refresh` | integer | | `500` | Poll interval in milliseconds. Use zero to disable automatic polling. |
| `maxTries` | integer | | `3` | Maximum tries when reading. <br /><br />Number of tries when reading data, if some of the reading fail. For single try, enter 1. |
Expand Down Expand Up @@ -302,7 +310,7 @@ Main documentation on `autoupdate` in [Items section of openHAB docs](https://ww

Device specific modbus bindings can take part in the discovery of things, and detect devices automatically. The discovery is initiated by the `tcp` and `serial` bridges when they have `enableDiscovery` setting enabled.

Note that the main binding does not recognize any device, so it is pointless to turn this on unless you have the correct binding installed.
Note that the main binding does not recognize any devices, so it is pointless to turn this on unless you have a suitable add-on binding installed.

## Details

Expand Down