From 75b815f15b082dcf4160276757746aabb860ad02 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?=D0=86=D0=BB=D0=BB=D1=8F=20=D0=9F=D1=96=D1=81=D0=BA=D1=83?=
 =?UTF-8?q?=D1=80=D1=8C=D0=BE=D0=B2?=
 <74793674+illia-piskurov@users.noreply.github.com>
Date: Tue, 14 Jan 2025 07:23:32 +0200
Subject: [PATCH] =?UTF-8?q?Add=20documentation=20for=20hvac=5Fon=5Fvalue?=
 =?UTF-8?q?=20and=20hvac=5Foff=5Fvalue=20in=20Modbus=20clim=E2=80=A6=20(#3?=
 =?UTF-8?q?5245)?=
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit

* Add documentation for hvac_on_value and hvac_off_value in Modbus climate configuration

* Update hvac_onoff_register documentation

* Update docs
---
 source/_integrations/modbus.markdown | 19 +++++++++++++++++++
 1 file changed, 19 insertions(+)

diff --git a/source/_integrations/modbus.markdown b/source/_integrations/modbus.markdown
index 4506ebdcce1..97c15c39e65 100644
--- a/source/_integrations/modbus.markdown
+++ b/source/_integrations/modbus.markdown
@@ -756,6 +756,25 @@ climates:
               description: "Value corresponding to Fan Diffuse mode."
               required: false
               type: integer
+    hvac_onoff_register:
+      description: "Address of On/Off state.
+        When the value defined by `hvac_off_value` is read from this register, the HVAC
+        state is set to Off. Otherwise, the `hvac_mode_register` dictates the state
+        of the HVAC. If no such register is defined, it defaults to Auto.
+        When the HVAC mode is set to Off, the value defined by `hvac_off_value` is written to
+        the register, otherwise the value defined by `hvac_on_value` is written."
+      required: false
+      type: integer
+    hvac_on_value:
+      description: "The value that will be written to the `hvac_onoff_register` to turn the HVAC system on.
+        If not specified, the default value is 1."
+      required: false
+      type: integer
+    hvac_off_value:
+      description: "The value that will be written to the `hvac_onoff_register` to turn the HVAC system off.
+        If not specified, the default value is 0."
+      required: false
+      type: integer
     swing_mode_register:
       description: "Configuration of the register for swing mode"
       required: false