Skip to content

Commit cd8d10f

Browse files
authored
Followup on rework modbus (home-assistant#28692)
* Followup on rework modbus. * typo. * link not correct.
1 parent fadf974 commit cd8d10f

File tree

1 file changed

+23
-10
lines changed

1 file changed

+23
-10
lines changed

source/_integrations/modbus.markdown

Lines changed: 23 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -372,6 +372,8 @@ modbus entities are grouped below each modbus communication entry.
372372

373373
All modbus entities have the following parameters:
374374

375+
Please refer to [Parameter usage](#parameters-usage-matrix) for conflicting parameters.
376+
375377
{% configuration %}
376378
address:
377379
description: "Address of coil/register."
@@ -460,6 +462,7 @@ For that reason, many devices (especially older ones) do not share the coil addr
460462
and this `input` would read from a different address space than `coil`. The problem is present in devices with
461463
shared address space and are a frequent cause of problems when configuring entities.
462464

465+
Please refer to [Parameter usage](#parameters-usage-matrix) for conflicting parameters.
463466

464467
{% configuration %}
465468
binary_sensors:
@@ -551,6 +554,8 @@ The master configuration like device_class are automatically copied to the slave
551554

552555
The Modbus climate platform allows you to monitor a thermostat or heaters as well as set a target temperature.
553556

557+
Please refer to [Parameter usage](#parameters-usage-matrix) for conflicting parameters.
558+
554559
{% configuration %}
555560
climates:
556561
description: "A list of all climate entities in this modbus instance."
@@ -773,6 +778,8 @@ Cover that uses `input_type: coil` is not able to determine intermediary states
773778

774779
If your cover uses `input_type: holding` (default) to send commands, it can also read the intermediary states. To adjust which value represents what state, you can fine-tune the optional state attributes, like `state_open`. These optional state values are also used for specifying values written into the register. If you specify an optional status_register attribute, cover states will be read from status_register instead of the register used for sending commands.
775780

781+
Please refer to [Parameter usage](#parameters-usage-matrix) for conflicting parameters.
782+
776783
{% configuration %}
777784
covers:
778785
description: "A list of all cover entities configured for this connection."
@@ -958,6 +965,7 @@ modbus:
958965

959966
The `modbus` fan platform allows you to control [Modbus](http://www.modbus.org/) coils or registers.
960967

968+
Please refer to [Parameter usage](#parameters-usage-matrix) for conflicting parameters.
961969

962970
{% configuration %}
963971
fans:
@@ -1064,6 +1072,8 @@ modbus:
10641072

10651073
The `modbus` light platform allows you to control [Modbus](http://www.modbus.org/) coils or registers.
10661074

1075+
Please refer to [Parameter usage](#parameters-usage-matrix) for conflicting parameters.
1076+
10671077
{% configuration %}
10681078
lights:
10691079
description: "A list of all light entities in this modbus instance."
@@ -1170,6 +1180,7 @@ modbus:
11701180

11711181
The `modbus` sensor allows you to gather data from [Modbus](http://www.modbus.org/) registers.
11721182

1183+
Please refer to [Parameter usage](#parameters-usage-matrix) for conflicting parameters.
11731184

11741185
{% configuration %}
11751186
sensors:
@@ -1359,6 +1370,8 @@ modbus:
13591370

13601371
The `modbus` switch platform allows you to control [Modbus](http://www.modbus.org/) coils or registers.
13611372

1373+
Please refer to [Parameter usage](#parameters-usage-matrix) for conflicting parameters.
1374+
13621375
{% configuration %}
13631376
switches:
13641377
description: "A list of all switches in this modbus instance."
@@ -1490,19 +1503,19 @@ modbus:
14901503
state_off: 1
14911504
```
14921505

1493-
## Parameters usage matrix:
1506+
## Parameters usage matrix
14941507

14951508
Some parameters exclude other parameters, the following tables show what can be combined:
14961509

1497-
| Datatype: | custom | string | <type>16 | <type>32 | <type>64 |
1498-
| --------------- | ------ | ------ | -------- | -------- | -------- |
1499-
| count | Yes | Yes | No | No | No |
1500-
| structure | Yes | No | No | No | No |
1501-
| slave_count | No | No | Yes | Yes | Yes |
1502-
| swap: none | Yes | Yes | Yes | Yes | Yes |
1503-
| swap: byte | No | No | Yes | Yes | Yes |
1504-
| swap: word | No | No | No | Yes | Yes |
1505-
| swap: word_byte | No | No | No | Yes | Yes |
1510+
| Datatype: | custom | string | *16 | *32 | *64 |
1511+
| --------------- | ------ | ------ | --- | --- | --- |
1512+
| count | Yes | Yes | No | No | No |
1513+
| structure | Yes | No | No | No | No |
1514+
| slave_count | No | No | Yes | Yes | Yes |
1515+
| swap: none | Yes | Yes | Yes | Yes | Yes |
1516+
| swap: byte | No | No | Yes | Yes | Yes |
1517+
| swap: word | No | No | No | Yes | Yes |
1518+
| swap: word_byte | No | No | No | Yes | Yes |
15061519

15071520

15081521
# modbus services

0 commit comments

Comments
 (0)