From 1069f926d06f00aadfa814bfe14a35e2a8045567 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?C=C3=ADan=20Hughes?= <cian+github@cian.ws>
Date: Thu, 14 Dec 2023 09:00:58 +0000
Subject: [PATCH] Update modbus documentation to add fan state settings (core
 PR#104577) (#30018)

* Update modbus documentation to add fan state settings

core PR incoming to add this feature

* Update modbus.markdown

Remove list option from fan mode values
---
 source/_integrations/modbus.markdown | 59 +++++++++++++++++++++++++++-
 1 file changed, 57 insertions(+), 2 deletions(-)

diff --git a/source/_integrations/modbus.markdown b/source/_integrations/modbus.markdown
index d9e038519bc..000eeba1d1f 100644
--- a/source/_integrations/modbus.markdown
+++ b/source/_integrations/modbus.markdown
@@ -531,7 +531,7 @@ The master configuration like device_class are automatically copied to the slave
 
 ## Configuring climate entities
 
-The Modbus climate platform allows you to monitor a thermostat or heaters as well as set a target temperature.
+The Modbus climate platform allows you to monitor a thermostat or heaters as well as set a target temperature, HVAC mode and fan state.
 
 Please refer to [Parameter usage](#parameters-usage-matrix) for conflicting parameters.
 
@@ -613,7 +613,7 @@ climates:
             state_auto:
               description: "Value corresponding to HVAC Auto mode."
               required: false
-              type: integer
+              type: [integer, list]
             state_dry:
               description: "Value corresponding to HVAC Dry mode."
               required: false
@@ -626,6 +626,61 @@ climates:
               description: "Value corresponding to HVAC Heat/Cool mode."
               required: false
               type: [integer, list]
+    fan_mode_register:
+      description: "Configuration of register for Fan mode"
+      required: false
+      type: map
+      keys:
+        address:
+          description: "Address of Fan mode register."
+          required: true
+          type: integer
+        values:
+          description: "Mapping between the register values and Fan modes
+            This is typically used to control one of: Speed, Direction or On/Off state."
+          required: true
+          type: map
+          keys:
+            state_fan_on:
+              description: "Value corresponding to Fan On mode."
+              required: false
+              type: integer
+            state_fan_off:
+              description: "Value corresponding to Fan Off mode."
+              required: false
+              type: integer
+            state_fan_low:
+              description: "Value corresponding to Fan Low mode."
+              required: false
+              type: integer
+            state_fan_medium:
+              description: "Value corresponding to Fan Medium mode."
+              required: false
+              type: integer
+            state_fan_high:
+              description: "Value corresponding to Fan High mode."
+              required: false
+              type: integer
+            state_fan_auto:
+              description: "Value corresponding to Fan Auto mode."
+              required: false
+              type: integer
+            state_fan_top:
+              description: "Value corresponding to Fan Top mode."
+              required: false
+              type: integer
+            state_fan_middle:
+              description: "Value corresponding to Fan Middle mode."
+              required: false
+              type: integer
+            state_fan_focus:
+              description: "Value corresponding to Fan Focus mode."
+              required: false
+              type: integer
+            state_fan_diffuse:
+              description: "Value corresponding to Fan Diffuse mode."
+              required: false
+              type: integer
     hvac_onoff_register:
       description: "Address of On/Off state.
         When zero is read from this register, the HVAC state is set to Off, otherwise the `hvac_mode_register`