Skip to content

Commit 73200d6

Browse files
authored
Add modbus hvac action documentation (home-assistant#37823)
* Added documentation for modbus climate attribute hvac_action. * added documentation for hvac action input_type. * Updated labels to match the parent pull request.
1 parent f2c8b75 commit 73200d6

File tree

1 file changed

+52
-1
lines changed

1 file changed

+52
-1
lines changed

source/_integrations/modbus.markdown

Lines changed: 52 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -527,7 +527,7 @@ The master configuration like device_class are automatically copied to the slave
527527

528528
## Configuring climate entities
529529

530-
The Modbus climate platform allows you to monitor a thermostat or heaters as well as set a target temperature, HVAC mode, swing mode, and fan state.
530+
The Modbus climate platform allows you to monitor a thermostat or heaters as well as set a target temperature, HVAC action, HVAC mode, swing mode, and fan state.
531531

532532
Please refer to [Parameter usage](#parameters-usage-matrix) for conflicting parameters.
533533

@@ -652,6 +652,57 @@ climates:
652652
description: "Swap word ABCD -> CDAB, **not valid with data types: `int16`, `uint16`**"
653653
word_byte:
654654
description: "Swap word ABCD -> DCBA, **not valid with data types: `int16`, `uint16`**"
655+
hvac_action_register:
656+
description: "Configuration of register for HVAC action"
657+
required: false
658+
type: map
659+
keys:
660+
address:
661+
description: "Address of HVAC action register."
662+
required: true
663+
type: integer
664+
input_type:
665+
description: "Type of register, either `holding` or `input`"
666+
required: false
667+
default: holding
668+
type: string
669+
values:
670+
description: "Mapping between the register values and HVAC actions"
671+
required: true
672+
type: map
673+
keys:
674+
action_off:
675+
description: "Value corresponding to HVAC Off action."
676+
required: false
677+
type: [integer, list]
678+
action_cooling:
679+
description: "Value corresponding to HVAC Cooling action."
680+
required: false
681+
type: [integer, list]
682+
action_defrosting:
683+
description: "Value corresponding to HVAC Defrosting action."
684+
required: false
685+
type: [integer, list]
686+
action_drying:
687+
description: "Value corresponding to HVAC Drying action."
688+
required: false
689+
type: [integer, list]
690+
action_fan:
691+
description: "Value corresponding to HVAC Fan action."
692+
required: false
693+
type: [integer, list]
694+
action_heating:
695+
description: "Value corresponding to HVAC Heating action."
696+
required: false
697+
type: [integer, list]
698+
action_idle:
699+
description: "Value corresponding to HVAC Idle action."
700+
required: false
701+
type: [integer, list]
702+
action_preheating:
703+
description: "Value corresponding to HVAC Preheating action."
704+
required: false
705+
type: [integer, list]
655706
hvac_mode_register:
656707
description: "Configuration of register for HVAC mode"
657708
required: false

0 commit comments

Comments
 (0)