From 300e022e3b38261aa6220bfd2f161c701aff9566 Mon Sep 17 00:00:00 2001 From: karlowiczpl Date: Fri, 7 Feb 2025 18:53:19 +0100 Subject: [PATCH 01/23] added gryf smart docs --- source/_integrations/gryfsmart.md | 188 ++++++++++++++++++++++++++++++ 1 file changed, 188 insertions(+) create mode 100644 source/_integrations/gryfsmart.md diff --git a/source/_integrations/gryfsmart.md b/source/_integrations/gryfsmart.md new file mode 100644 index 000000000000..7dc622782823 --- /dev/null +++ b/source/_integrations/gryfsmart.md @@ -0,0 +1,188 @@ + +--- + +# GRYF_SMART Integration for Home Assistant + +This document describes how to configure and use the GRYFSMART integration with Home Assistant. The integration supports both YAML configuration and Config Flow (UI-based setup). + +--- + +## 1. Important Integration Information + +### 1.1 How to Use the ID + +The ID is a combination of the driver ID and the cell number (for outputs, inputs, etc.). +``` + XY + - X is the driver ID + - Y is the cell number +``` + +### 1.2 Communication + +To connect GRYFSMART, you can use either a Physical RS-232 connection or a USB/RS-232 converter. You need to know the address of the device. Typically, it is "/dev/ttyS0" for a physical RS-232 port, or "/dev/ttyUSB0" for a converter. You can list all devices using the following commands: + +##### If you are using a converter: +```bash +ls /dev/ttyUSB* # if you are using a converter +``` + +##### If you are using a physical port: +```bash +ls /dev/ttyS* # if you are using a physical port +``` + +### 1.3 Module Count + +The module count is the number of modules in the network. + +### 1.4 Entities + +**Gryf SMART driver supports 5 types of functions:** + +- **Relay Output (O)** +- **Input (I)** +- **PWM** +- **Temperature Input (T)** +- **Cover Output** + +#### 1.4.1 Light + +- **Type of function:** Relay Output +- **Services:** turn_on, turn_off +- **Icon:** lightbulb +- **Entity type:** light +- **Configuration scheme:** classic +- **Device class:** None + +#### 1.4.2 Switch + +- **Type of function:** Relay Output +- **Services:** turn_on, turn_off, toggle +- **Icon:** switch, outlet +- **Entity type:** switch +- **Configuration scheme:** device class +- **Device class:** switch, outlet +- **Default device class:** switch + +#### 1.4.3 Thermostat + +- **Type of function:** Relay Output and Temperature Input +- **Services:** turn_on, turn_off, toggle, set_temperature +- **Entity type:** climate +- **Configuration scheme:** thermostat + ```yaml + thermostat: + - name: # Name of the entity + t_id: # Thermometer ID + o_id: # Output ID + ``` + In Config Flow, you enter the t_id into the "extra" parameter and the o_id into the "id" parameter. +- **Device class:** None + +#### 1.4.4 Binary Input + +- **Type of function:** Input +- **Services:** None +- **Icon:** Specific for the chosen device class +- **Entity type:** binary_sensor +- **Configuration scheme:** device class +- **Device class:** door, garage_door, heat, light, motion, window, smoke, sound, power +- **Default device class:** opening + +#### 1.4.5 PWM + +- **Type of function:** PWM +- **Services:** turn_on, turn_off, toggle, set_value +- **Icon:** lightbulb +- **Entity type:** light +- **Configuration scheme:** classic +- **Device class:** None + +#### 1.4.6 Thermometer + +- **Type of function:** Temperature Input +- **Services:** None +- **Icon:** thermometer +- **Entity type:** sensor +- **Configuration scheme:** classic +- **Device class:** None + +#### 1.4.7 Input + +- **Type of function:** Input +- **Services:** None +- **Icon:** switch +- **Entity type:** sensor +- **Configuration scheme:** classic +- **Device class:** None +- **Extra information:** + If the input is a short press and release, the sensor state is 2; if it is a long press, the state is 3. + +--- + +## 2. Configuring via YAML + +### Example Configuration Tree +```yaml +gryfsmart: + port: "/dev/ttyS0" # RS-232 port location + module_count: 10 # Number of modules in the network + states_update: True # Enable asynchronous state updates + lights: # Lights (relay output) elements + - name: "Living Room Lamp" + id: 11 # Combined ID: controller 1, pin 1 + - name: "Kitchen Lamp" + id: 28 # Combined ID: controller 2, pin 8 + buttons: # Buttons (inputs) + - name: "Living Room Panel" + id: 17 # Combined ID: controller 1, pin 7 + climate: # Regulator (climate) elements + - name: "Regulator" + o_id: 34 # Combined ID: controller 3, pin 4 (for example) + t_id: 21 # Combined ID: controller 2, pin 1 (for example) + binary_input: + - name: "binary" + id: 34 + device_class: door +``` + +### 2.1 Configuration Schemes + +The configuration for each type follows specific rules. Remember: +- Names may include uppercase letters, numbers, and spaces, but no special characters other than “_”. +- Parameters are provided without any brackets. +- **Syntax and spacing are critical.** +- The entire configuration is stored under the key `gryfsmart:` in your `configuration.yaml`. +- The key `gryfsmart:` should appear only once. + +#### Classic Scheme +```yaml +gryf_smart: + lights: + - name: "Example Lamp" # Example name + id: 11 # Combined ID: where 1 = controller ID and 1 = pin +``` + +#### Device Class Scheme +```yaml +gryf_smart: + p_cover: + - name: "Example Blind" # Example name + id: 12 # Combined ID: 1 for controller, 2 for pin + device_class: door # Optional device class +``` + +--- + +## 3. Configuration via Config Flow + +The "extra" parameter corresponds to the device_class if it exists. In the case of a thermostat, the "extra" parameter maps to **t_id** instead. Otherwise, this parameter is not required. Additionally, the integration supports editing of individual devices and configuration. Please note that after making changes, you must reload the integration for the changes to take effect. + +--- + +## 4. Helper Entities + +Additionally, the configuration automatically generates two entities—**gryf_in** and **gryf_out**. The **gryf_in** entity receives incoming messages, and the **gryf_out** entity handles outgoing messages. However, if you are not an experienced GRYF SMART installer, you may ignore these details. + +--- From c8b9a0b40563b61b2b29114d5c8464b9fd313740 Mon Sep 17 00:00:00 2001 From: karlowiczpl Date: Fri, 7 Feb 2025 18:55:53 +0100 Subject: [PATCH 02/23] added gryf smart docs --- source/_integrations/gryfsmart.md | 188 ------------------------------ 1 file changed, 188 deletions(-) delete mode 100644 source/_integrations/gryfsmart.md diff --git a/source/_integrations/gryfsmart.md b/source/_integrations/gryfsmart.md deleted file mode 100644 index 7dc622782823..000000000000 --- a/source/_integrations/gryfsmart.md +++ /dev/null @@ -1,188 +0,0 @@ - ---- - -# GRYF_SMART Integration for Home Assistant - -This document describes how to configure and use the GRYFSMART integration with Home Assistant. The integration supports both YAML configuration and Config Flow (UI-based setup). - ---- - -## 1. Important Integration Information - -### 1.1 How to Use the ID - -The ID is a combination of the driver ID and the cell number (for outputs, inputs, etc.). -``` - XY - - X is the driver ID - - Y is the cell number -``` - -### 1.2 Communication - -To connect GRYFSMART, you can use either a Physical RS-232 connection or a USB/RS-232 converter. You need to know the address of the device. Typically, it is "/dev/ttyS0" for a physical RS-232 port, or "/dev/ttyUSB0" for a converter. You can list all devices using the following commands: - -##### If you are using a converter: -```bash -ls /dev/ttyUSB* # if you are using a converter -``` - -##### If you are using a physical port: -```bash -ls /dev/ttyS* # if you are using a physical port -``` - -### 1.3 Module Count - -The module count is the number of modules in the network. - -### 1.4 Entities - -**Gryf SMART driver supports 5 types of functions:** - -- **Relay Output (O)** -- **Input (I)** -- **PWM** -- **Temperature Input (T)** -- **Cover Output** - -#### 1.4.1 Light - -- **Type of function:** Relay Output -- **Services:** turn_on, turn_off -- **Icon:** lightbulb -- **Entity type:** light -- **Configuration scheme:** classic -- **Device class:** None - -#### 1.4.2 Switch - -- **Type of function:** Relay Output -- **Services:** turn_on, turn_off, toggle -- **Icon:** switch, outlet -- **Entity type:** switch -- **Configuration scheme:** device class -- **Device class:** switch, outlet -- **Default device class:** switch - -#### 1.4.3 Thermostat - -- **Type of function:** Relay Output and Temperature Input -- **Services:** turn_on, turn_off, toggle, set_temperature -- **Entity type:** climate -- **Configuration scheme:** thermostat - ```yaml - thermostat: - - name: # Name of the entity - t_id: # Thermometer ID - o_id: # Output ID - ``` - In Config Flow, you enter the t_id into the "extra" parameter and the o_id into the "id" parameter. -- **Device class:** None - -#### 1.4.4 Binary Input - -- **Type of function:** Input -- **Services:** None -- **Icon:** Specific for the chosen device class -- **Entity type:** binary_sensor -- **Configuration scheme:** device class -- **Device class:** door, garage_door, heat, light, motion, window, smoke, sound, power -- **Default device class:** opening - -#### 1.4.5 PWM - -- **Type of function:** PWM -- **Services:** turn_on, turn_off, toggle, set_value -- **Icon:** lightbulb -- **Entity type:** light -- **Configuration scheme:** classic -- **Device class:** None - -#### 1.4.6 Thermometer - -- **Type of function:** Temperature Input -- **Services:** None -- **Icon:** thermometer -- **Entity type:** sensor -- **Configuration scheme:** classic -- **Device class:** None - -#### 1.4.7 Input - -- **Type of function:** Input -- **Services:** None -- **Icon:** switch -- **Entity type:** sensor -- **Configuration scheme:** classic -- **Device class:** None -- **Extra information:** - If the input is a short press and release, the sensor state is 2; if it is a long press, the state is 3. - ---- - -## 2. Configuring via YAML - -### Example Configuration Tree -```yaml -gryfsmart: - port: "/dev/ttyS0" # RS-232 port location - module_count: 10 # Number of modules in the network - states_update: True # Enable asynchronous state updates - lights: # Lights (relay output) elements - - name: "Living Room Lamp" - id: 11 # Combined ID: controller 1, pin 1 - - name: "Kitchen Lamp" - id: 28 # Combined ID: controller 2, pin 8 - buttons: # Buttons (inputs) - - name: "Living Room Panel" - id: 17 # Combined ID: controller 1, pin 7 - climate: # Regulator (climate) elements - - name: "Regulator" - o_id: 34 # Combined ID: controller 3, pin 4 (for example) - t_id: 21 # Combined ID: controller 2, pin 1 (for example) - binary_input: - - name: "binary" - id: 34 - device_class: door -``` - -### 2.1 Configuration Schemes - -The configuration for each type follows specific rules. Remember: -- Names may include uppercase letters, numbers, and spaces, but no special characters other than “_”. -- Parameters are provided without any brackets. -- **Syntax and spacing are critical.** -- The entire configuration is stored under the key `gryfsmart:` in your `configuration.yaml`. -- The key `gryfsmart:` should appear only once. - -#### Classic Scheme -```yaml -gryf_smart: - lights: - - name: "Example Lamp" # Example name - id: 11 # Combined ID: where 1 = controller ID and 1 = pin -``` - -#### Device Class Scheme -```yaml -gryf_smart: - p_cover: - - name: "Example Blind" # Example name - id: 12 # Combined ID: 1 for controller, 2 for pin - device_class: door # Optional device class -``` - ---- - -## 3. Configuration via Config Flow - -The "extra" parameter corresponds to the device_class if it exists. In the case of a thermostat, the "extra" parameter maps to **t_id** instead. Otherwise, this parameter is not required. Additionally, the integration supports editing of individual devices and configuration. Please note that after making changes, you must reload the integration for the changes to take effect. - ---- - -## 4. Helper Entities - -Additionally, the configuration automatically generates two entities—**gryf_in** and **gryf_out**. The **gryf_in** entity receives incoming messages, and the **gryf_out** entity handles outgoing messages. However, if you are not an experienced GRYF SMART installer, you may ignore these details. - ---- From d023a400e02e1c29a1d38c76cabbf5055afcba30 Mon Sep 17 00:00:00 2001 From: karlowiczpl Date: Fri, 7 Feb 2025 18:56:51 +0100 Subject: [PATCH 03/23] added gryf smart docs --- source/_integrations/gryfsmart.markdown | 211 ++++++++++++++++++++++++ 1 file changed, 211 insertions(+) create mode 100644 source/_integrations/gryfsmart.markdown diff --git a/source/_integrations/gryfsmart.markdown b/source/_integrations/gryfsmart.markdown new file mode 100644 index 000000000000..e8df0273f1cf --- /dev/null +++ b/source/_integrations/gryfsmart.markdown @@ -0,0 +1,211 @@ +--- +title: Gryfsmart +description: Instructions on how to integrate GryfSmart within Home Assistant. +ha_release: 2025.1 +ha_category: + - Binary sensor + - Climate + - Sensor + - Switch + - Light +ha_iot_class: Local Pushing +ha_config_flow: true +ha_domain: gryfsmart +ha_platforms: + - Binary sensor + - Climate + - Sensor + - Switch + - Light + - binary_sensor +ha_codeowners: + - '@karlowiczpl' +ha_integration_type: hub +--- +--- + +# GRYF_SMART Integration for Home Assistant + +This document describes how to configure and use the GRYFSMART integration with Home Assistant. The integration supports both YAML configuration and Config Flow (UI-based setup). + +--- + +## 1. Important Integration Information + +### 1.1 How to Use the ID + +The ID is a combination of the driver ID and the cell number (for outputs, inputs, etc.). +``` + XY + - X is the driver ID + - Y is the cell number +``` + +### 1.2 Communication + +To connect GRYFSMART, you can use either a Physical RS-232 connection or a USB/RS-232 converter. You need to know the address of the device. Typically, it is "/dev/ttyS0" for a physical RS-232 port, or "/dev/ttyUSB0" for a converter. You can list all devices using the following commands: + +##### If you are using a converter: +```bash +ls /dev/ttyUSB* # if you are using a converter +``` + +##### If you are using a physical port: +```bash +ls /dev/ttyS* # if you are using a physical port +``` + +### 1.3 Module Count + +The module count is the number of modules in the network. + +### 1.4 Entities + +**Gryf SMART driver supports 5 types of functions:** + +- **Relay Output (O)** +- **Input (I)** +- **PWM** +- **Temperature Input (T)** +- **Cover Output** + +#### 1.4.1 Light + +- **Type of function:** Relay Output +- **Services:** turn_on, turn_off +- **Icon:** lightbulb +- **Entity type:** light +- **Configuration scheme:** classic +- **Device class:** None + +#### 1.4.2 Switch + +- **Type of function:** Relay Output +- **Services:** turn_on, turn_off, toggle +- **Icon:** switch, outlet +- **Entity type:** switch +- **Configuration scheme:** device class +- **Device class:** switch, outlet +- **Default device class:** switch + +#### 1.4.3 Thermostat + +- **Type of function:** Relay Output and Temperature Input +- **Services:** turn_on, turn_off, toggle, set_temperature +- **Entity type:** climate +- **Configuration scheme:** thermostat + ```yaml + thermostat: + - name: # Name of the entity + t_id: # Thermometer ID + o_id: # Output ID + ``` + In Config Flow, you enter the t_id into the "extra" parameter and the o_id into the "id" parameter. +- **Device class:** None + +#### 1.4.4 Binary Input + +- **Type of function:** Input +- **Services:** None +- **Icon:** Specific for the chosen device class +- **Entity type:** binary_sensor +- **Configuration scheme:** device class +- **Device class:** door, garage_door, heat, light, motion, window, smoke, sound, power +- **Default device class:** opening + +#### 1.4.5 PWM + +- **Type of function:** PWM +- **Services:** turn_on, turn_off, toggle, set_value +- **Icon:** lightbulb +- **Entity type:** light +- **Configuration scheme:** classic +- **Device class:** None + +#### 1.4.6 Thermometer + +- **Type of function:** Temperature Input +- **Services:** None +- **Icon:** thermometer +- **Entity type:** sensor +- **Configuration scheme:** classic +- **Device class:** None + +#### 1.4.7 Input + +- **Type of function:** Input +- **Services:** None +- **Icon:** switch +- **Entity type:** sensor +- **Configuration scheme:** classic +- **Device class:** None +- **Extra information:** + If the input is a short press and release, the sensor state is 2; if it is a long press, the state is 3. + +--- + +## 2. Configuring via YAML + +### Example Configuration Tree +```yaml +gryfsmart: + port: "/dev/ttyS0" # RS-232 port location + module_count: 10 # Number of modules in the network + states_update: True # Enable asynchronous state updates + lights: # Lights (relay output) elements + - name: "Living Room Lamp" + id: 11 # Combined ID: controller 1, pin 1 + - name: "Kitchen Lamp" + id: 28 # Combined ID: controller 2, pin 8 + buttons: # Buttons (inputs) + - name: "Living Room Panel" + id: 17 # Combined ID: controller 1, pin 7 + climate: # Regulator (climate) elements + - name: "Regulator" + o_id: 34 # Combined ID: controller 3, pin 4 (for example) + t_id: 21 # Combined ID: controller 2, pin 1 (for example) + binary_input: + - name: "binary" + id: 34 + device_class: door +``` + +### 2.1 Configuration Schemes + +The configuration for each type follows specific rules. Remember: +- Names may include uppercase letters, numbers, and spaces, but no special characters other than “_”. +- Parameters are provided without any brackets. +- **Syntax and spacing are critical.** +- The entire configuration is stored under the key `gryfsmart:` in your `configuration.yaml`. +- The key `gryfsmart:` should appear only once. + +#### Classic Scheme +```yaml +gryf_smart: + lights: + - name: "Example Lamp" # Example name + id: 11 # Combined ID: where 1 = controller ID and 1 = pin +``` + +#### Device Class Scheme +```yaml +gryf_smart: + p_cover: + - name: "Example Blind" # Example name + id: 12 # Combined ID: 1 for controller, 2 for pin + device_class: door # Optional device class +``` + +--- + +## 3. Configuration via Config Flow + +The "extra" parameter corresponds to the device_class if it exists. In the case of a thermostat, the "extra" parameter maps to **t_id** instead. Otherwise, this parameter is not required. Additionally, the integration supports editing of individual devices and configuration. Please note that after making changes, you must reload the integration for the changes to take effect. + +--- + +## 4. Helper Entities + +Additionally, the configuration automatically generates two entities—**gryf_in** and **gryf_out**. The **gryf_in** entity receives incoming messages, and the **gryf_out** entity handles outgoing messages. However, if you are not an experienced GRYF SMART installer, you may ignore these details. + +--- From 192a36f18268eac75d1cd1cd4824add311ad8ccb Mon Sep 17 00:00:00 2001 From: karlowiczpl Date: Fri, 7 Feb 2025 19:05:09 +0100 Subject: [PATCH 04/23] added gryf smart docs --- source/_integrations/gryfsmart.markdown | 210 +++++++++++++----------- 1 file changed, 117 insertions(+), 93 deletions(-) diff --git a/source/_integrations/gryfsmart.markdown b/source/_integrations/gryfsmart.markdown index e8df0273f1cf..c38c3ccbdb4a 100644 --- a/source/_integrations/gryfsmart.markdown +++ b/source/_integrations/gryfsmart.markdown @@ -1,5 +1,6 @@ + --- -title: Gryfsmart +title: GryfSmart description: Instructions on how to integrate GryfSmart within Home Assistant. ha_release: 2025.1 ha_category: @@ -17,195 +18,218 @@ ha_platforms: - Sensor - Switch - Light - - binary_sensor ha_codeowners: - '@karlowiczpl' ha_integration_type: hub --- ---- -# GRYF_SMART Integration for Home Assistant +# GryfSmart integration for Home Assistant -This document describes how to configure and use the GRYFSMART integration with Home Assistant. The integration supports both YAML configuration and Config Flow (UI-based setup). +This document describes how to configure and use the *GryfSmart* integration with Home Assistant. The integration supports both YAML configuration and Config Flow (UI-based setup). --- -## 1. Important Integration Information +## Important integration information -### 1.1 How to Use the ID +### How to use the ID + +The ID is a combination of the driver ID and the cell number (for outputs, inputs, etc.): -The ID is a combination of the driver ID and the cell number (for outputs, inputs, etc.). ``` - XY - - X is the driver ID - - Y is the cell number +XY +- X is the driver ID +- Y is the cell number ``` -### 1.2 Communication +### Communication -To connect GRYFSMART, you can use either a Physical RS-232 connection or a USB/RS-232 converter. You need to know the address of the device. Typically, it is "/dev/ttyS0" for a physical RS-232 port, or "/dev/ttyUSB0" for a converter. You can list all devices using the following commands: +To connect *GryfSmart*, you can use either a physical RS-232 connection or a USB/RS-232 converter. You need to know the address of the device. Typically, it is **/dev/ttyS0** for a physical RS-232 port or **/dev/ttyUSB0** for a converter. You can list all devices using the following commands: -##### If you are using a converter: +**If you are using a converter:** ```bash -ls /dev/ttyUSB* # if you are using a converter +ls /dev/ttyUSB* # Lists USB converter devices ``` -##### If you are using a physical port: +**If you are using a physical port:** ```bash -ls /dev/ttyS* # if you are using a physical port +ls /dev/ttyS* # Lists physical RS-232 ports ``` -### 1.3 Module Count +### Module count -The module count is the number of modules in the network. +The module count refers to the number of modules in the network. -### 1.4 Entities +### Entities -**Gryf SMART driver supports 5 types of functions:** +*GryfSmart* driver supports five types of functions: -- **Relay Output (O)** -- **Input (I)** -- **PWM** -- **Temperature Input (T)** -- **Cover Output** +- *Relay Output (O)* +- *Input (I)* +- *PWM* +- *Temperature Input (T)* +- *Cover Output* -#### 1.4.1 Light +#### Light - **Type of function:** Relay Output -- **Services:** turn_on, turn_off +- **Services:** `turn_on`, `turn_off` - **Icon:** lightbulb - **Entity type:** light -- **Configuration scheme:** classic +- **Configuration scheme:** Classic - **Device class:** None -#### 1.4.2 Switch +#### Switch - **Type of function:** Relay Output -- **Services:** turn_on, turn_off, toggle +- **Services:** `turn_on`, `turn_off`, `toggle` - **Icon:** switch, outlet - **Entity type:** switch -- **Configuration scheme:** device class +- **Configuration scheme:** Device class - **Device class:** switch, outlet - **Default device class:** switch -#### 1.4.3 Thermostat +#### Thermostat - **Type of function:** Relay Output and Temperature Input -- **Services:** turn_on, turn_off, toggle, set_temperature +- **Services:** `turn_on`, `turn_off`, `toggle`, `set_temperature` - **Entity type:** climate -- **Configuration scheme:** thermostat +- **Configuration scheme:** Thermostat ```yaml thermostat: - - name: # Name of the entity - t_id: # Thermometer ID - o_id: # Output ID + - name: YOUR_THERMOSTAT_NAME # Name of the entity + t_id: YOUR_THERMOMETER_ID # Thermometer ID + o_id: YOUR_OUTPUT_ID # Output ID ``` - In Config Flow, you enter the t_id into the "extra" parameter and the o_id into the "id" parameter. + In Config Flow, enter the **t_id** into the **Extra** parameter and the **o_id** into the **ID** parameter. - **Device class:** None -#### 1.4.4 Binary Input +#### Binary input - **Type of function:** Input - **Services:** None -- **Icon:** Specific for the chosen device class +- **Icon:** Specific to the chosen device class - **Entity type:** binary_sensor -- **Configuration scheme:** device class +- **Configuration scheme:** Device class - **Device class:** door, garage_door, heat, light, motion, window, smoke, sound, power - **Default device class:** opening -#### 1.4.5 PWM +#### PWM - **Type of function:** PWM -- **Services:** turn_on, turn_off, toggle, set_value +- **Services:** `turn_on`, `turn_off`, `toggle`, `set_value` - **Icon:** lightbulb - **Entity type:** light -- **Configuration scheme:** classic +- **Configuration scheme:** Classic - **Device class:** None -#### 1.4.6 Thermometer +#### Thermometer - **Type of function:** Temperature Input - **Services:** None - **Icon:** thermometer - **Entity type:** sensor -- **Configuration scheme:** classic +- **Configuration scheme:** Classic - **Device class:** None -#### 1.4.7 Input +#### Input - **Type of function:** Input - **Services:** None - **Icon:** switch - **Entity type:** sensor -- **Configuration scheme:** classic +- **Configuration scheme:** Classic - **Device class:** None - **Extra information:** - If the input is a short press and release, the sensor state is 2; if it is a long press, the state is 3. + - If the input is a short press and release, the sensor state is 2. + - If it is a long press, the state is 3. --- -## 2. Configuring via YAML +## Configuring via YAML + +### Example configuration tree -### Example Configuration Tree ```yaml gryfsmart: - port: "/dev/ttyS0" # RS-232 port location - module_count: 10 # Number of modules in the network - states_update: True # Enable asynchronous state updates - lights: # Lights (relay output) elements - - name: "Living Room Lamp" - id: 11 # Combined ID: controller 1, pin 1 - - name: "Kitchen Lamp" - id: 28 # Combined ID: controller 2, pin 8 - buttons: # Buttons (inputs) - - name: "Living Room Panel" - id: 17 # Combined ID: controller 1, pin 7 - climate: # Regulator (climate) elements - - name: "Regulator" - o_id: 34 # Combined ID: controller 3, pin 4 (for example) - t_id: 21 # Combined ID: controller 2, pin 1 (for example) - binary_input: - - name: "binary" - id: 34 - device_class: door + port: "YOUR_PORT_PATH" # e.g., /dev/ttyS0 or /dev/ttyUSB0 + module_count: 10 # Number of modules in the network + states_update: true # Enable asynchronous state updates + lights: # Lights (relay output) elements + - name: "Living Room Lamp" + id: 11 # Combined ID: controller 1, pin 1 + - name: "Kitchen Lamp" + id: 28 # Combined ID: controller 2, pin 8 + buttons: # Buttons (inputs) + - name: "Living Room Panel" + id: 17 # Combined ID: controller 1, pin 7 + climate: # Regulator (climate) elements + - name: "Regulator" + o_id: 34 # Combined ID: controller 3, pin 4 + t_id: 21 # Combined ID: controller 2, pin 1 + binary_input: + - name: "Binary Sensor" + id: 34 + device_class: door ``` -### 2.1 Configuration Schemes +### Configuration variables + +{% configuration %} +port: + description: RS-232 port location. + required: true + type: string + default: "/dev/ttyS0" + +module_count: + description: Number of modules in the network. + required: true + type: integer + +states_update: + description: Enable asynchronous state updates. + required: false + type: boolean + default: true +{% endconfiguration %} -The configuration for each type follows specific rules. Remember: -- Names may include uppercase letters, numbers, and spaces, but no special characters other than “_”. -- Parameters are provided without any brackets. -- **Syntax and spacing are critical.** -- The entire configuration is stored under the key `gryfsmart:` in your `configuration.yaml`. -- The key `gryfsmart:` should appear only once. +### Configuration schemes + +#### Classic scheme -#### Classic Scheme ```yaml -gryf_smart: - lights: - - name: "Example Lamp" # Example name - id: 11 # Combined ID: where 1 = controller ID and 1 = pin +gryfsmart: + lights: + - name: "Example Lamp" + id: 11 # Combined ID: controller 1, pin 1 ``` -#### Device Class Scheme +#### Device class scheme + ```yaml -gryf_smart: - p_cover: - - name: "Example Blind" # Example name - id: 12 # Combined ID: 1 for controller, 2 for pin - device_class: door # Optional device class +gryfsmart: + p_cover: + - name: "Example Blind" + id: 12 + device_class: door # Optional device class ``` --- -## 3. Configuration via Config Flow +## Configuring via Config Flow -The "extra" parameter corresponds to the device_class if it exists. In the case of a thermostat, the "extra" parameter maps to **t_id** instead. Otherwise, this parameter is not required. Additionally, the integration supports editing of individual devices and configuration. Please note that after making changes, you must reload the integration for the changes to take effect. +The **Extra** parameter corresponds to the **device_class** if it exists. For thermostats, the **Extra** parameter maps to **t_id**. If not applicable, this parameter is not required. The integration also supports editing individual devices and configurations. After making changes, reload the integration for updates to take effect. --- -## 4. Helper Entities +## Helper entities -Additionally, the configuration automatically generates two entities—**gryf_in** and **gryf_out**. The **gryf_in** entity receives incoming messages, and the **gryf_out** entity handles outgoing messages. However, if you are not an experienced GRYF SMART installer, you may ignore these details. +The configuration automatically generates two helper entities—**gryf_in** and **gryf_out**: + +- **gryf_in:** Receives incoming messages. +- **gryf_out:** Handles outgoing messages. + +If you are not an experienced *GryfSmart* installer, you may ignore these details. --- + From b445c30465da761a90e9c7a152d3be2b4e8d4cdd Mon Sep 17 00:00:00 2001 From: karlowiczpl Date: Fri, 7 Feb 2025 19:21:55 +0100 Subject: [PATCH 05/23] added gryf smart docs --- source/_integrations/gryfsmart.markdown | 224 +++++++++++------------- 1 file changed, 98 insertions(+), 126 deletions(-) diff --git a/source/_integrations/gryfsmart.markdown b/source/_integrations/gryfsmart.markdown index c38c3ccbdb4a..e31b319c4bde 100644 --- a/source/_integrations/gryfsmart.markdown +++ b/source/_integrations/gryfsmart.markdown @@ -1,6 +1,5 @@ - --- -title: GryfSmart +title: Gryfsmart description: Instructions on how to integrate GryfSmart within Home Assistant. ha_release: 2025.1 ha_category: @@ -18,218 +17,191 @@ ha_platforms: - Sensor - Switch - Light + - binary_sensor ha_codeowners: - '@karlowiczpl' ha_integration_type: hub --- -# GryfSmart integration for Home Assistant - -This document describes how to configure and use the *GryfSmart* integration with Home Assistant. The integration supports both YAML configuration and Config Flow (UI-based setup). +# GRYF_SMART Integration for Home Assistant ---- +This document describes how to configure and use the GRYFSMART integration with Home Assistant. The integration supports both YAML configuration and Config Flow (UI-based setup). -## Important integration information +## 1. Important Integration Information -### How to use the ID +### 1.1 How to Use the ID -The ID is a combination of the driver ID and the cell number (for outputs, inputs, etc.): +The ID is a combination of the driver ID and the cell number (for outputs, inputs, etc.). -``` XY -- X is the driver ID -- Y is the cell number -``` + - X is the driver ID + - Y is the cell number + +### 1.2 Communication -### Communication +To connect GRYFSMART, you can use either a Physical RS-232 connection or a USB/RS-232 converter. You need to know the address of the device. Typically, it is "/dev/ttyS0" for a physical RS-232 port, or "/dev/ttyUSB0" for a converter. You can list all devices using the following commands: -To connect *GryfSmart*, you can use either a physical RS-232 connection or a USB/RS-232 converter. You need to know the address of the device. Typically, it is **/dev/ttyS0** for a physical RS-232 port or **/dev/ttyUSB0** for a converter. You can list all devices using the following commands: +If you are using a converter: -**If you are using a converter:** ```bash -ls /dev/ttyUSB* # Lists USB converter devices +ls /dev/ttyUSB* ``` -**If you are using a physical port:** +If you are using a physical port: + ```bash -ls /dev/ttyS* # Lists physical RS-232 ports +ls /dev/ttyS* ``` -### Module count +### 1.3 Module Count -The module count refers to the number of modules in the network. +The module count is the number of modules in the network. -### Entities +### 1.4 Entities -*GryfSmart* driver supports five types of functions: +**Gryf SMART driver supports 5 types of functions:** -- *Relay Output (O)* -- *Input (I)* -- *PWM* -- *Temperature Input (T)* -- *Cover Output* +- **Relay Output (O)** +- **Input (I)** +- **PWM** +- **Temperature Input (T)** +- **Cover Output** -#### Light +#### 1.4.1 Light - **Type of function:** Relay Output -- **Services:** `turn_on`, `turn_off` +- **Services:** turn_on, turn_off - **Icon:** lightbulb - **Entity type:** light -- **Configuration scheme:** Classic +- **Configuration scheme:** classic - **Device class:** None -#### Switch +#### 1.4.2 Switch - **Type of function:** Relay Output -- **Services:** `turn_on`, `turn_off`, `toggle` +- **Services:** turn_on, turn_off, toggle - **Icon:** switch, outlet - **Entity type:** switch -- **Configuration scheme:** Device class +- **Configuration scheme:** device class - **Device class:** switch, outlet - **Default device class:** switch -#### Thermostat +#### 1.4.3 Thermostat - **Type of function:** Relay Output and Temperature Input -- **Services:** `turn_on`, `turn_off`, `toggle`, `set_temperature` +- **Services:** turn_on, turn_off, toggle, set_temperature - **Entity type:** climate -- **Configuration scheme:** Thermostat - ```yaml - thermostat: - - name: YOUR_THERMOSTAT_NAME # Name of the entity - t_id: YOUR_THERMOMETER_ID # Thermometer ID - o_id: YOUR_OUTPUT_ID # Output ID - ``` - In Config Flow, enter the **t_id** into the **Extra** parameter and the **o_id** into the **ID** parameter. +- **Configuration scheme:** thermostat + +```yaml +thermostat: + - name: # Name of the entity + t_id: # Thermometer ID + o_id: # Output ID +``` + +In Config Flow, you enter the t_id into the "extra" parameter and the o_id into the "id" parameter. - **Device class:** None -#### Binary input +#### 1.4.4 Binary Input - **Type of function:** Input - **Services:** None -- **Icon:** Specific to the chosen device class +- **Icon:** Specific for the chosen device class - **Entity type:** binary_sensor -- **Configuration scheme:** Device class +- **Configuration scheme:** device class - **Device class:** door, garage_door, heat, light, motion, window, smoke, sound, power - **Default device class:** opening -#### PWM +#### 1.4.5 PWM - **Type of function:** PWM -- **Services:** `turn_on`, `turn_off`, `toggle`, `set_value` +- **Services:** turn_on, turn_off, toggle, set_value - **Icon:** lightbulb - **Entity type:** light -- **Configuration scheme:** Classic +- **Configuration scheme:** classic - **Device class:** None -#### Thermometer +#### 1.4.6 Thermometer - **Type of function:** Temperature Input - **Services:** None - **Icon:** thermometer - **Entity type:** sensor -- **Configuration scheme:** Classic +- **Configuration scheme:** classic - **Device class:** None -#### Input +#### 1.4.7 Input - **Type of function:** Input - **Services:** None - **Icon:** switch - **Entity type:** sensor -- **Configuration scheme:** Classic +- **Configuration scheme:** classic - **Device class:** None - **Extra information:** - - If the input is a short press and release, the sensor state is 2. - - If it is a long press, the state is 3. + If the input is a short press and release, the sensor state is 2; if it is a long press, the state is 3. ---- - -## Configuring via YAML +## 2. Configuring via YAML -### Example configuration tree +### Example Configuration Tree ```yaml gryfsmart: - port: "YOUR_PORT_PATH" # e.g., /dev/ttyS0 or /dev/ttyUSB0 - module_count: 10 # Number of modules in the network - states_update: true # Enable asynchronous state updates - lights: # Lights (relay output) elements - - name: "Living Room Lamp" - id: 11 # Combined ID: controller 1, pin 1 - - name: "Kitchen Lamp" - id: 28 # Combined ID: controller 2, pin 8 - buttons: # Buttons (inputs) - - name: "Living Room Panel" - id: 17 # Combined ID: controller 1, pin 7 - climate: # Regulator (climate) elements - - name: "Regulator" - o_id: 34 # Combined ID: controller 3, pin 4 - t_id: 21 # Combined ID: controller 2, pin 1 - binary_input: - - name: "Binary Sensor" - id: 34 - device_class: door + port: "/dev/ttyS0" # RS-232 port location + module_count: 10 # Number of modules in the network + states_update: True # Enable asynchronous state updates + lights: # Lights (relay output) elements + - name: "Living Room Lamp" + id: 11 # Combined ID: controller 1, pin 1 + - name: "Kitchen Lamp" + id: 28 # Combined ID: controller 2, pin 8 + buttons: # Buttons (inputs) + - name: "Living Room Panel" + id: 17 # Combined ID: controller 1, pin 7 + climate: # Regulator (climate) elements + - name: "Regulator" + o_id: 34 # Combined ID: controller 3, pin 4 (for example) + t_id: 21 # Combined ID: controller 2, pin 1 (for example) + binary_input: + - name: "binary" + id: 34 + device_class: door ``` -### Configuration variables - -{% configuration %} -port: - description: RS-232 port location. - required: true - type: string - default: "/dev/ttyS0" +### 2.1 Configuration Schemes -module_count: - description: Number of modules in the network. - required: true - type: integer +The configuration for each type follows specific rules. Remember: +- Names may include uppercase letters, numbers, and spaces, but no special characters other than "_". +- Parameters are provided without any brackets. +- **Syntax and spacing are critical.** +- The entire configuration is stored under the key gryfsmart: in your configuration.yaml. +- The key gryfsmart: should appear only once. -states_update: - description: Enable asynchronous state updates. - required: false - type: boolean - default: true -{% endconfiguration %} - -### Configuration schemes - -#### Classic scheme +#### Classic Scheme ```yaml -gryfsmart: - lights: - - name: "Example Lamp" - id: 11 # Combined ID: controller 1, pin 1 +gryf_smart: + lights: + - name: "Example Lamp" # Example name + id: 11 # Combined ID: where 1 = controller ID and 1 = pin ``` -#### Device class scheme +#### Device Class Scheme ```yaml -gryfsmart: - p_cover: - - name: "Example Blind" - id: 12 - device_class: door # Optional device class +gryf_smart: + p_cover: + - name: "Example Blind" # Example name + id: 12 # Combined ID: 1 for controller, 2 for pin + device_class: door # Optional device class ``` ---- - -## Configuring via Config Flow +## 3. Configuration via Config Flow -The **Extra** parameter corresponds to the **device_class** if it exists. For thermostats, the **Extra** parameter maps to **t_id**. If not applicable, this parameter is not required. The integration also supports editing individual devices and configurations. After making changes, reload the integration for updates to take effect. +The "extra" parameter corresponds to the device_class if it exists. In the case of a thermostat, the "extra" parameter maps to **t_id** instead. Otherwise, this parameter is not required. Additionally, the integration supports editing of individual devices and configuration. Please note that after making changes, you must reload the integration for the changes to take effect. ---- - -## Helper entities - -The configuration automatically generates two helper entities—**gryf_in** and **gryf_out**: +## 4. Helper Entities -- **gryf_in:** Receives incoming messages. -- **gryf_out:** Handles outgoing messages. - -If you are not an experienced *GryfSmart* installer, you may ignore these details. - ---- +Additionally, the configuration automatically generates two entities—**gryf_in** and **gryf_out**. The **gryf_in** entity receives incoming messages, and the **gryf_out** entity handles outgoing messages. However, if you are not an experienced GRYF SMART installer, you may ignore these details. From 7faa9163c87b4df465a7bc6ccb598204e352033b Mon Sep 17 00:00:00 2001 From: karlowiczpl Date: Fri, 7 Feb 2025 19:57:37 +0100 Subject: [PATCH 06/23] Add some feature --- source/_integrations/gryfsmart.markdown | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/source/_integrations/gryfsmart.markdown b/source/_integrations/gryfsmart.markdown index e31b319c4bde..d9808df766c1 100644 --- a/source/_integrations/gryfsmart.markdown +++ b/source/_integrations/gryfsmart.markdown @@ -181,7 +181,7 @@ The configuration for each type follows specific rules. Remember: #### Classic Scheme ```yaml -gryf_smart: +gryfsmart: lights: - name: "Example Lamp" # Example name id: 11 # Combined ID: where 1 = controller ID and 1 = pin @@ -190,7 +190,7 @@ gryf_smart: #### Device Class Scheme ```yaml -gryf_smart: +gryfsmart: p_cover: - name: "Example Blind" # Example name id: 12 # Combined ID: 1 for controller, 2 for pin From 15d6e6242691301e3f8df66ae6c83a33a9fa0e71 Mon Sep 17 00:00:00 2001 From: karlowiczpl Date: Fri, 7 Feb 2025 20:30:13 +0100 Subject: [PATCH 07/23] added GryfSmart docs --- source/_integrations/gryfsmart.markdown | 122 ++++++++++++++---------- 1 file changed, 70 insertions(+), 52 deletions(-) diff --git a/source/_integrations/gryfsmart.markdown b/source/_integrations/gryfsmart.markdown index d9808df766c1..6a83a11cffb9 100644 --- a/source/_integrations/gryfsmart.markdown +++ b/source/_integrations/gryfsmart.markdown @@ -3,44 +3,50 @@ title: Gryfsmart description: Instructions on how to integrate GryfSmart within Home Assistant. ha_release: 2025.1 ha_category: - - Binary sensor - - Climate - - Sensor - - Switch - - Light + - Binary sensor + - Climate + - Sensor + - Switch + - Light ha_iot_class: Local Pushing ha_config_flow: true ha_domain: gryfsmart ha_platforms: - - Binary sensor - - Climate - - Sensor - - Switch - - Light - - binary_sensor + - Binary sensor + - Climate + - Sensor + - Switch + - Light + - binary_sensor ha_codeowners: - - '@karlowiczpl' + - "@karlowiczpl" ha_integration_type: hub --- -# GRYF_SMART Integration for Home Assistant +## gryfsmart Integration for Home Assistant -This document describes how to configure and use the GRYFSMART integration with Home Assistant. The integration supports both YAML configuration and Config Flow (UI-based setup). +This document describes how to configure and use the gryfsmart integration with +Home Assistant. The integration supports both YAML configuration and Config +Flow (UI-based setup). ## 1. Important Integration Information ### 1.1 How to Use the ID -The ID is a combination of the driver ID and the cell number (for outputs, inputs, etc.). +The ID is a combination of the driver ID and the cell number (for outputs, +inputs, etc.). -XY - - X is the driver ID - - Y is the cell number +17 -### 1.2 Communication +- 1 is the driver ID +- 7 is the cell number -To connect GRYFSMART, you can use either a Physical RS-232 connection or a USB/RS-232 converter. You need to know the address of the device. Typically, it is "/dev/ttyS0" for a physical RS-232 port, or "/dev/ttyUSB0" for a converter. You can list all devices using the following commands: +### 1.2 Communication +To connect gryfsmart, you can use either a Physical RS-232 connection or a +USB/RS-232 converter. You need to know the address of the device. Typically, it +is "/dev/ttyS0" for a physical RS-232 port, or "/dev/ttyUSB0" for a converter. +You can list all devices using the following commands: If you are using a converter: ```bash @@ -59,7 +65,7 @@ The module count is the number of modules in the network. ### 1.4 Entities -**Gryf SMART driver supports 5 types of functions:** +**gryfsmart driver supports 5 types of functions:** - **Relay Output (O)** - **Input (I)** @@ -82,7 +88,7 @@ The module count is the number of modules in the network. - **Services:** turn_on, turn_off, toggle - **Icon:** switch, outlet - **Entity type:** switch -- **Configuration scheme:** device class +- **Configuration scheme:** with device class - **Device class:** switch, outlet - **Default device class:** switch @@ -91,16 +97,18 @@ The module count is the number of modules in the network. - **Type of function:** Relay Output and Temperature Input - **Services:** turn_on, turn_off, toggle, set_temperature - **Entity type:** climate -- **Configuration scheme:** thermostat - +- **Configuration scheme:** thermostat + ```yaml thermostat: - - name: # Name of the entity - t_id: # Thermometer ID - o_id: # Output ID + - name: # Name of the entity + t_id: # Thermometer ID + o_id: # Output ID ``` -In Config Flow, you enter the t_id into the "extra" parameter and the o_id into the "id" parameter. +In Config Flow, you enter the t_id into the "extra" parameter +and the o_id into the "id" parameter. + - **Device class:** None #### 1.4.4 Binary Input @@ -109,8 +117,9 @@ In Config Flow, you enter the t_id into the "extra" parameter and the o_id into - **Services:** None - **Icon:** Specific for the chosen device class - **Entity type:** binary_sensor -- **Configuration scheme:** device class -- **Device class:** door, garage_door, heat, light, motion, window, smoke, sound, power +- **Configuration scheme:** with device class +- **Device class:** door, garage_door, heat, light, motion, +window, smoke, sound, power - **Default device class:** opening #### 1.4.5 PWM @@ -140,7 +149,8 @@ In Config Flow, you enter the t_id into the "extra" parameter and the o_id into - **Configuration scheme:** classic - **Device class:** None - **Extra information:** - If the input is a short press and release, the sensor state is 2; if it is a long press, the state is 3. + If the input is a short press and release, the sensor state is 2; +if it is a long press, the state is 3. ## 2. Configuring via YAML @@ -148,21 +158,21 @@ In Config Flow, you enter the t_id into the "extra" parameter and the o_id into ```yaml gryfsmart: - port: "/dev/ttyS0" # RS-232 port location - module_count: 10 # Number of modules in the network - states_update: True # Enable asynchronous state updates - lights: # Lights (relay output) elements + port: "/dev/ttyS0" # RS-232 port location + module_count: 10 # Number of modules in the network + states_update: True # Enable asynchronous state updates + lights: # Lights (relay output) elements - name: "Living Room Lamp" - id: 11 # Combined ID: controller 1, pin 1 + id: 11 # Combined ID: controller 1, pin 1 - name: "Kitchen Lamp" - id: 28 # Combined ID: controller 2, pin 8 - buttons: # Buttons (inputs) + id: 28 # Combined ID: controller 2, pin 8 + buttons: # Buttons (inputs) - name: "Living Room Panel" - id: 17 # Combined ID: controller 1, pin 7 - climate: # Regulator (climate) elements + id: 17 # Combined ID: controller 1, pin 7 + climate: # Regulator (climate) elements - name: "Regulator" - o_id: 34 # Combined ID: controller 3, pin 4 (for example) - t_id: 21 # Combined ID: controller 2, pin 1 (for example) + o_id: 34 # Combined ID: controller 3, pin 4 (for example) + t_id: 21 # Combined ID: controller 2, pin 1 (for example) binary_input: - name: "binary" id: 34 @@ -172,7 +182,9 @@ gryfsmart: ### 2.1 Configuration Schemes The configuration for each type follows specific rules. Remember: -- Names may include uppercase letters, numbers, and spaces, but no special characters other than "_". + +- Names may include uppercase letters, numbers, and spaces, but no +special characters other than "\_". - Parameters are provided without any brackets. - **Syntax and spacing are critical.** - The entire configuration is stored under the key gryfsmart: in your configuration.yaml. @@ -183,25 +195,31 @@ The configuration for each type follows specific rules. Remember: ```yaml gryfsmart: lights: - - name: "Example Lamp" # Example name - id: 11 # Combined ID: where 1 = controller ID and 1 = pin + - name: "Example Lamp" # Example name + id: 11 # Combined ID: where 1 = controller ID and 1 = pin ``` -#### Device Class Scheme +#### With Device Class Scheme ```yaml gryfsmart: p_cover: - - name: "Example Blind" # Example name - id: 12 # Combined ID: 1 for controller, 2 for pin - device_class: door # Optional device class + - name: "Example Blind" # Example name + id: 12 # Combined ID: 1 for controller, 2 for pin + device_class: door # Optional device class ``` ## 3. Configuration via Config Flow -The "extra" parameter corresponds to the device_class if it exists. In the case of a thermostat, the "extra" parameter maps to **t_id** instead. Otherwise, this parameter is not required. Additionally, the integration supports editing of individual devices and configuration. Please note that after making changes, you must reload the integration for the changes to take effect. +The "extra" parameter corresponds to the device_class if it exists. In the case +of a thermostat, the "extra" parameter maps to **t_id** instead. Otherwise, this +parameter is not required. Additionally, the integration supports editing of +individual devices and configuration. Please note that after making changes, +you must reload the integration for the changes to take effect. ## 4. Helper Entities -Additionally, the configuration automatically generates two entities—**gryf_in** and **gryf_out**. The **gryf_in** entity receives incoming messages, and the **gryf_out** entity handles outgoing messages. However, if you are not an experienced GRYF SMART installer, you may ignore these details. - +Additionally, the configuration automatically generates two entities—**gryf_in** +and **gryf_out**. The **gryf_in** entity receives incoming messages, and the +**gryf_out** entity handles outgoing messages. However, if you are not an +experienced GRYF SMART installer, you may ignore these details. From 1ff80b28019bbbf2aae0c7dc22ca9255d9fd2642 Mon Sep 17 00:00:00 2001 From: karlowiczpl <159330051+karlowiczpl@users.noreply.github.com> Date: Thu, 27 Feb 2025 09:24:48 +0100 Subject: [PATCH 08/23] Update gryfsmart.markdown --- source/_integrations/gryfsmart.markdown | 87 +------------------------ 1 file changed, 3 insertions(+), 84 deletions(-) diff --git a/source/_integrations/gryfsmart.markdown b/source/_integrations/gryfsmart.markdown index 6a83a11cffb9..993947de60a8 100644 --- a/source/_integrations/gryfsmart.markdown +++ b/source/_integrations/gryfsmart.markdown @@ -46,18 +46,6 @@ inputs, etc.). To connect gryfsmart, you can use either a Physical RS-232 connection or a USB/RS-232 converter. You need to know the address of the device. Typically, it is "/dev/ttyS0" for a physical RS-232 port, or "/dev/ttyUSB0" for a converter. -You can list all devices using the following commands: -If you are using a converter: - -```bash -ls /dev/ttyUSB* -``` - -If you are using a physical port: - -```bash -ls /dev/ttyS* -``` ### 1.3 Module Count @@ -88,7 +76,6 @@ The module count is the number of modules in the network. - **Services:** turn_on, turn_off, toggle - **Icon:** switch, outlet - **Entity type:** switch -- **Configuration scheme:** with device class - **Device class:** switch, outlet - **Default device class:** switch @@ -97,15 +84,6 @@ The module count is the number of modules in the network. - **Type of function:** Relay Output and Temperature Input - **Services:** turn_on, turn_off, toggle, set_temperature - **Entity type:** climate -- **Configuration scheme:** thermostat - -```yaml -thermostat: - - name: # Name of the entity - t_id: # Thermometer ID - o_id: # Output ID -``` - In Config Flow, you enter the t_id into the "extra" parameter and the o_id into the "id" parameter. @@ -117,7 +95,6 @@ and the o_id into the "id" parameter. - **Services:** None - **Icon:** Specific for the chosen device class - **Entity type:** binary_sensor -- **Configuration scheme:** with device class - **Device class:** door, garage_door, heat, light, motion, window, smoke, sound, power - **Default device class:** opening @@ -128,7 +105,6 @@ window, smoke, sound, power - **Services:** turn_on, turn_off, toggle, set_value - **Icon:** lightbulb - **Entity type:** light -- **Configuration scheme:** classic - **Device class:** None #### 1.4.6 Thermometer @@ -137,7 +113,6 @@ window, smoke, sound, power - **Services:** None - **Icon:** thermometer - **Entity type:** sensor -- **Configuration scheme:** classic - **Device class:** None #### 1.4.7 Input @@ -146,70 +121,14 @@ window, smoke, sound, power - **Services:** None - **Icon:** switch - **Entity type:** sensor -- **Configuration scheme:** classic - **Device class:** None - **Extra information:** If the input is a short press and release, the sensor state is 2; if it is a long press, the state is 3. -## 2. Configuring via YAML - -### Example Configuration Tree - -```yaml -gryfsmart: - port: "/dev/ttyS0" # RS-232 port location - module_count: 10 # Number of modules in the network - states_update: True # Enable asynchronous state updates - lights: # Lights (relay output) elements - - name: "Living Room Lamp" - id: 11 # Combined ID: controller 1, pin 1 - - name: "Kitchen Lamp" - id: 28 # Combined ID: controller 2, pin 8 - buttons: # Buttons (inputs) - - name: "Living Room Panel" - id: 17 # Combined ID: controller 1, pin 7 - climate: # Regulator (climate) elements - - name: "Regulator" - o_id: 34 # Combined ID: controller 3, pin 4 (for example) - t_id: 21 # Combined ID: controller 2, pin 1 (for example) - binary_input: - - name: "binary" - id: 34 - device_class: door -``` - -### 2.1 Configuration Schemes - -The configuration for each type follows specific rules. Remember: - -- Names may include uppercase letters, numbers, and spaces, but no -special characters other than "\_". -- Parameters are provided without any brackets. -- **Syntax and spacing are critical.** -- The entire configuration is stored under the key gryfsmart: in your configuration.yaml. -- The key gryfsmart: should appear only once. - -#### Classic Scheme - -```yaml -gryfsmart: - lights: - - name: "Example Lamp" # Example name - id: 11 # Combined ID: where 1 = controller ID and 1 = pin -``` - -#### With Device Class Scheme - -```yaml -gryfsmart: - p_cover: - - name: "Example Blind" # Example name - id: 12 # Combined ID: 1 for controller, 2 for pin - device_class: door # Optional device class -``` - -## 3. Configuration via Config Flow + + +## 2. Configuration via Config Flow The "extra" parameter corresponds to the device_class if it exists. In the case of a thermostat, the "extra" parameter maps to **t_id** instead. Otherwise, this From f1144b5c6f5129d8e271d0d3338fb297a73c62b5 Mon Sep 17 00:00:00 2001 From: karlowiczpl <159330051+karlowiczpl@users.noreply.github.com> Date: Thu, 27 Feb 2025 09:30:45 +0100 Subject: [PATCH 09/23] Update gryfsmart.markdown --- source/_integrations/gryfsmart.markdown | 9 ++++----- 1 file changed, 4 insertions(+), 5 deletions(-) diff --git a/source/_integrations/gryfsmart.markdown b/source/_integrations/gryfsmart.markdown index 993947de60a8..1690b90d9a3a 100644 --- a/source/_integrations/gryfsmart.markdown +++ b/source/_integrations/gryfsmart.markdown @@ -23,11 +23,10 @@ ha_codeowners: ha_integration_type: hub --- -## gryfsmart Integration for Home Assistant +# GryfSmart +## The GryfSmart integration for home assistant allows you to connect to GryfSmart devices -This document describes how to configure and use the gryfsmart integration with -Home Assistant. The integration supports both YAML configuration and Config -Flow (UI-based setup). +This document describes how to configure and use the GryfSmart integration. The integration support Config Flow (UI-based setup), and requires RS232 interface. ## 1. Important Integration Information @@ -59,7 +58,7 @@ The module count is the number of modules in the network. - **Input (I)** - **PWM** - **Temperature Input (T)** -- **Cover Output** +- **Cover Output(S)** #### 1.4.1 Light From 632d811bd7a20a694ac293d7731d827ad4a8cf0d Mon Sep 17 00:00:00 2001 From: karlowiczpl <159330051+karlowiczpl@users.noreply.github.com> Date: Thu, 27 Feb 2025 09:38:06 +0100 Subject: [PATCH 10/23] Update gryfsmart.markdown --- source/_integrations/gryfsmart.markdown | 3 +-- 1 file changed, 1 insertion(+), 2 deletions(-) diff --git a/source/_integrations/gryfsmart.markdown b/source/_integrations/gryfsmart.markdown index 1690b90d9a3a..fd845bfcb3fc 100644 --- a/source/_integrations/gryfsmart.markdown +++ b/source/_integrations/gryfsmart.markdown @@ -23,8 +23,7 @@ ha_codeowners: ha_integration_type: hub --- -# GryfSmart -## The GryfSmart integration for home assistant allows you to connect to GryfSmart devices +# The GryfSmart integration for home assistant allows you to connect to GryfSmart devices This document describes how to configure and use the GryfSmart integration. The integration support Config Flow (UI-based setup), and requires RS232 interface. From 78702e41cf0dd85c66762761ddf7bed09a0f32c2 Mon Sep 17 00:00:00 2001 From: karlowiczpl <159330051+karlowiczpl@users.noreply.github.com> Date: Thu, 27 Feb 2025 09:47:26 +0100 Subject: [PATCH 11/23] Update gryfsmart.markdown --- source/_integrations/gryfsmart.markdown | 10 +++++++--- 1 file changed, 7 insertions(+), 3 deletions(-) diff --git a/source/_integrations/gryfsmart.markdown b/source/_integrations/gryfsmart.markdown index fd845bfcb3fc..2acdc77dbd00 100644 --- a/source/_integrations/gryfsmart.markdown +++ b/source/_integrations/gryfsmart.markdown @@ -1,6 +1,6 @@ --- -title: Gryfsmart -description: Instructions on how to integrate GryfSmart within Home Assistant. +title: GRYFSMART +description: Instructions on how to integrate GryfSmart components with Home Assistant. ha_release: 2025.1 ha_category: - Binary sensor @@ -23,10 +23,14 @@ ha_codeowners: ha_integration_type: hub --- -# The GryfSmart integration for home assistant allows you to connect to GryfSmart devices +# The [GryfSmart](https://gryfsmart.pl) integration for home assistant allows you to connect to GryfSmart devices This document describes how to configure and use the GryfSmart integration. The integration support Config Flow (UI-based setup), and requires RS232 interface. +There is currently support for the following device types within Home Assistant: + + - [Light](#1.4.1 Light) + ## 1. Important Integration Information ### 1.1 How to Use the ID From 3234a6a2a097c756744210eb8ef02257e3581106 Mon Sep 17 00:00:00 2001 From: karlowiczpl <159330051+karlowiczpl@users.noreply.github.com> Date: Thu, 27 Feb 2025 09:47:58 +0100 Subject: [PATCH 12/23] Update gryfsmart.markdown --- source/_integrations/gryfsmart.markdown | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/source/_integrations/gryfsmart.markdown b/source/_integrations/gryfsmart.markdown index 2acdc77dbd00..31734524dcb7 100644 --- a/source/_integrations/gryfsmart.markdown +++ b/source/_integrations/gryfsmart.markdown @@ -29,7 +29,7 @@ This document describes how to configure and use the GryfSmart integration. The There is currently support for the following device types within Home Assistant: - - [Light](#1.4.1 Light) + - [Light](#1.4.1-Light) ## 1. Important Integration Information From 8e486e45ad569d222c65586f769336e2ad2510e6 Mon Sep 17 00:00:00 2001 From: karlowiczpl <159330051+karlowiczpl@users.noreply.github.com> Date: Thu, 27 Feb 2025 09:49:08 +0100 Subject: [PATCH 13/23] Update gryfsmart.markdown --- source/_integrations/gryfsmart.markdown | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/source/_integrations/gryfsmart.markdown b/source/_integrations/gryfsmart.markdown index 31734524dcb7..9623b628f105 100644 --- a/source/_integrations/gryfsmart.markdown +++ b/source/_integrations/gryfsmart.markdown @@ -29,7 +29,7 @@ This document describes how to configure and use the GryfSmart integration. The There is currently support for the following device types within Home Assistant: - - [Light](#1.4.1-Light) + - [Light](#141-Light) ## 1. Important Integration Information From aa03c62a3a8df2cdcc71479b8c6a255f7996a47d Mon Sep 17 00:00:00 2001 From: karlowiczpl <159330051+karlowiczpl@users.noreply.github.com> Date: Thu, 27 Feb 2025 09:53:55 +0100 Subject: [PATCH 14/23] Update gryfsmart.markdown --- source/_integrations/gryfsmart.markdown | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/source/_integrations/gryfsmart.markdown b/source/_integrations/gryfsmart.markdown index 9623b628f105..7c208bb7069d 100644 --- a/source/_integrations/gryfsmart.markdown +++ b/source/_integrations/gryfsmart.markdown @@ -30,6 +30,12 @@ This document describes how to configure and use the GryfSmart integration. The There is currently support for the following device types within Home Assistant: - [Light](#141-Light) + - [Switch](#142-Switch) + - [Thermostat](#143-Thermostat) + - [Binary Input](#144-Binary-Input) + - [PWM](#145-PWM) + - [Termometer](#146-Thermometer) + - [Input](#147-Input) ## 1. Important Integration Information From 0fc27abdee251cb4c820aca4e027262b1939a4cf Mon Sep 17 00:00:00 2001 From: karlowiczpl <159330051+karlowiczpl@users.noreply.github.com> Date: Thu, 27 Feb 2025 09:55:49 +0100 Subject: [PATCH 15/23] Update gryfsmart.markdown --- source/_integrations/gryfsmart.markdown | 2 ++ 1 file changed, 2 insertions(+) diff --git a/source/_integrations/gryfsmart.markdown b/source/_integrations/gryfsmart.markdown index 7c208bb7069d..48c7c5be82ae 100644 --- a/source/_integrations/gryfsmart.markdown +++ b/source/_integrations/gryfsmart.markdown @@ -37,6 +37,8 @@ There is currently support for the following device types within Home Assistant: - [Termometer](#146-Thermometer) - [Input](#147-Input) +{% include integrations/config_flow.md %} + ## 1. Important Integration Information ### 1.1 How to Use the ID From 42456dfcb9dd8bdf2da9fb770f1f7ab63e8e837d Mon Sep 17 00:00:00 2001 From: karlowiczpl <159330051+karlowiczpl@users.noreply.github.com> Date: Thu, 27 Feb 2025 11:15:08 +0100 Subject: [PATCH 16/23] Update gryfsmart.markdown --- source/_integrations/gryfsmart.markdown | 20 ++++++++++++-------- 1 file changed, 12 insertions(+), 8 deletions(-) diff --git a/source/_integrations/gryfsmart.markdown b/source/_integrations/gryfsmart.markdown index 48c7c5be82ae..c7aa5226ae69 100644 --- a/source/_integrations/gryfsmart.markdown +++ b/source/_integrations/gryfsmart.markdown @@ -23,19 +23,19 @@ ha_codeowners: ha_integration_type: hub --- -# The [GryfSmart](https://gryfsmart.pl) integration for home assistant allows you to connect to GryfSmart devices +## The [GryfSmart](https://gryfsmart.pl) integration for home assistant allows you to connect to GryfSmart devices This document describes how to configure and use the GryfSmart integration. The integration support Config Flow (UI-based setup), and requires RS232 interface. There is currently support for the following device types within Home Assistant: - - [Light](#141-Light) - - [Switch](#142-Switch) - - [Thermostat](#143-Thermostat) - - [Binary Input](#144-Binary-Input) - - [PWM](#145-PWM) - - [Termometer](#146-Thermometer) - - [Input](#147-Input) + - Light + - Switch + - Thermostat + - Binary Input + - PWM + - Termometer + - Input {% include integrations/config_flow.md %} @@ -63,6 +63,8 @@ The module count is the number of modules in the network. ### 1.4 Entities +{% note %} + **gryfsmart driver supports 5 types of functions:** - **Relay Output (O)** @@ -71,6 +73,8 @@ The module count is the number of modules in the network. - **Temperature Input (T)** - **Cover Output(S)** +{% endnote %} + #### 1.4.1 Light - **Type of function:** Relay Output From a13e874d22f370097f1ec9ea773913999fd64fec Mon Sep 17 00:00:00 2001 From: karlowiczpl <159330051+karlowiczpl@users.noreply.github.com> Date: Thu, 27 Feb 2025 11:24:32 +0100 Subject: [PATCH 17/23] Update gryfsmart.markdown --- source/_integrations/gryfsmart.markdown | 14 +++++++------- 1 file changed, 7 insertions(+), 7 deletions(-) diff --git a/source/_integrations/gryfsmart.markdown b/source/_integrations/gryfsmart.markdown index c7aa5226ae69..fe0571315dfe 100644 --- a/source/_integrations/gryfsmart.markdown +++ b/source/_integrations/gryfsmart.markdown @@ -29,13 +29,13 @@ This document describes how to configure and use the GryfSmart integration. The There is currently support for the following device types within Home Assistant: - - Light - - Switch - - Thermostat - - Binary Input - - PWM - - Termometer - - Input +- Light +- Switch +- Thermostat +- Binary Input +- PWM +- Thermometer +- Input {% include integrations/config_flow.md %} From 0cdd7c0fd8130e675c303b6c09d281e0ab4e48df Mon Sep 17 00:00:00 2001 From: karlowiczpl <159330051+karlowiczpl@users.noreply.github.com> Date: Thu, 27 Feb 2025 11:33:43 +0100 Subject: [PATCH 18/23] Update gryfsmart.markdown --- source/_integrations/gryfsmart.markdown | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/source/_integrations/gryfsmart.markdown b/source/_integrations/gryfsmart.markdown index fe0571315dfe..33ccdfe897bc 100644 --- a/source/_integrations/gryfsmart.markdown +++ b/source/_integrations/gryfsmart.markdown @@ -23,7 +23,7 @@ ha_codeowners: ha_integration_type: hub --- -## The [GryfSmart](https://gryfsmart.pl) integration for home assistant allows you to connect to GryfSmart devices +## The[GryfSmart](https://gryfsmart.pl)integration for home assistant allows you to connect to GryfSmart devices This document describes how to configure and use the GryfSmart integration. The integration support Config Flow (UI-based setup), and requires RS232 interface. From b5779beaa6fe11421c6706acf3490b2c2c8f48c2 Mon Sep 17 00:00:00 2001 From: karlowiczpl <159330051+karlowiczpl@users.noreply.github.com> Date: Thu, 27 Feb 2025 11:41:59 +0100 Subject: [PATCH 19/23] Update gryfsmart.markdown --- source/_integrations/gryfsmart.markdown | 10 ++++------ 1 file changed, 4 insertions(+), 6 deletions(-) diff --git a/source/_integrations/gryfsmart.markdown b/source/_integrations/gryfsmart.markdown index 33ccdfe897bc..6cc1a6a66ac4 100644 --- a/source/_integrations/gryfsmart.markdown +++ b/source/_integrations/gryfsmart.markdown @@ -23,9 +23,9 @@ ha_codeowners: ha_integration_type: hub --- -## The[GryfSmart](https://gryfsmart.pl)integration for home assistant allows you to connect to GryfSmart devices +## The[GryfSmart](https://gryfsmart.pl)integration for Home Assistant allows you to connect to GryfSmart devices -This document describes how to configure and use the GryfSmart integration. The integration support Config Flow (UI-based setup), and requires RS232 interface. +This document describes how to configure and use the GryfSmart integration. The integration supports Config Flow (UI-based setup), and requires an RS232 interface. There is currently support for the following device types within Home Assistant: @@ -71,7 +71,7 @@ The module count is the number of modules in the network. - **Input (I)** - **PWM** - **Temperature Input (T)** -- **Cover Output(S)** +- **Cover Output** {% endnote %} @@ -140,8 +140,6 @@ window, smoke, sound, power If the input is a short press and release, the sensor state is 2; if it is a long press, the state is 3. - - ## 2. Configuration via Config Flow The "extra" parameter corresponds to the device_class if it exists. In the case @@ -155,4 +153,4 @@ you must reload the integration for the changes to take effect. Additionally, the configuration automatically generates two entities—**gryf_in** and **gryf_out**. The **gryf_in** entity receives incoming messages, and the **gryf_out** entity handles outgoing messages. However, if you are not an -experienced GRYF SMART installer, you may ignore these details. +experienced GRYF SMART installer, you may ignore these details. \ No newline at end of file From f931375325cbcfae94d9dc64762afe97ea1fbb9f Mon Sep 17 00:00:00 2001 From: karlowiczpl <159330051+karlowiczpl@users.noreply.github.com> Date: Fri, 28 Feb 2025 11:19:29 +0100 Subject: [PATCH 20/23] Update gryfsmart.markdown --- source/_integrations/gryfsmart.markdown | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/source/_integrations/gryfsmart.markdown b/source/_integrations/gryfsmart.markdown index 6cc1a6a66ac4..1ac6fe155b4d 100644 --- a/source/_integrations/gryfsmart.markdown +++ b/source/_integrations/gryfsmart.markdown @@ -1,5 +1,5 @@ --- -title: GRYFSMART +title: GryfSmart description: Instructions on how to integrate GryfSmart components with Home Assistant. ha_release: 2025.1 ha_category: @@ -23,9 +23,9 @@ ha_codeowners: ha_integration_type: hub --- -## The[GryfSmart](https://gryfsmart.pl)integration for Home Assistant allows you to connect to GryfSmart devices +## The [GryfSmart](https://gryfsmart.pl) integration for Home Assistant allows you to connect to GryfSmart devices -This document describes how to configure and use the GryfSmart integration. The integration supports Config Flow (UI-based setup), and requires an RS232 interface. +This document describes how to configure and use the GryfSmart integration. The integration supports Config Flow (UI-based setup), and requires an RS-232 interface. There is currently support for the following device types within Home Assistant: @@ -65,7 +65,7 @@ The module count is the number of modules in the network. {% note %} -**gryfsmart driver supports 5 types of functions:** +**GryfSmart driver supports 5 types of functions:** - **Relay Output (O)** - **Input (I)** From cc07357e92cafbd28ba1f5f16e96b28e6a8a1d7e Mon Sep 17 00:00:00 2001 From: karlowiczpl <159330051+karlowiczpl@users.noreply.github.com> Date: Fri, 28 Feb 2025 11:31:50 +0100 Subject: [PATCH 21/23] Update gryfsmart.markdown --- source/_integrations/gryfsmart.markdown | 15 ++++++++------- 1 file changed, 8 insertions(+), 7 deletions(-) diff --git a/source/_integrations/gryfsmart.markdown b/source/_integrations/gryfsmart.markdown index 1ac6fe155b4d..daf7dda3fa25 100644 --- a/source/_integrations/gryfsmart.markdown +++ b/source/_integrations/gryfsmart.markdown @@ -25,6 +25,7 @@ ha_integration_type: hub ## The [GryfSmart](https://gryfsmart.pl) integration for Home Assistant allows you to connect to GryfSmart devices + This document describes how to configure and use the GryfSmart integration. The integration supports Config Flow (UI-based setup), and requires an RS-232 interface. There is currently support for the following device types within Home Assistant: @@ -43,17 +44,16 @@ There is currently support for the following device types within Home Assistant: ### 1.1 How to Use the ID -The ID is a combination of the driver ID and the cell number (for outputs, -inputs, etc.). +The ID is a combination of the driver ID and the cell number (for outputs, inputs, etc.). -17 +Example: `17` -- 1 is the driver ID -- 7 is the cell number +- `1` is the driver ID +- `7` is the cell number ### 1.2 Communication -To connect gryfsmart, you can use either a Physical RS-232 connection or a +To connect GryfSmart, you can use either a Physical RS-232 connection or a USB/RS-232 converter. You need to know the address of the device. Typically, it is "/dev/ttyS0" for a physical RS-232 port, or "/dev/ttyUSB0" for a converter. @@ -153,4 +153,5 @@ you must reload the integration for the changes to take effect. Additionally, the configuration automatically generates two entities—**gryf_in** and **gryf_out**. The **gryf_in** entity receives incoming messages, and the **gryf_out** entity handles outgoing messages. However, if you are not an -experienced GRYF SMART installer, you may ignore these details. \ No newline at end of file +experienced GryfSmart installer, you may ignore these details. + \ No newline at end of file From 61013da5521cc4414f553f6f9515c63527c6b77d Mon Sep 17 00:00:00 2001 From: karlowiczpl <159330051+karlowiczpl@users.noreply.github.com> Date: Fri, 28 Feb 2025 11:53:37 +0100 Subject: [PATCH 22/23] Update gryfsmart.markdown --- source/_integrations/gryfsmart.markdown | 26 +++++++++++++++---------- 1 file changed, 16 insertions(+), 10 deletions(-) diff --git a/source/_integrations/gryfsmart.markdown b/source/_integrations/gryfsmart.markdown index daf7dda3fa25..69117f211a52 100644 --- a/source/_integrations/gryfsmart.markdown +++ b/source/_integrations/gryfsmart.markdown @@ -25,7 +25,6 @@ ha_integration_type: hub ## The [GryfSmart](https://gryfsmart.pl) integration for Home Assistant allows you to connect to GryfSmart devices - This document describes how to configure and use the GryfSmart integration. The integration supports Config Flow (UI-based setup), and requires an RS-232 interface. There is currently support for the following device types within Home Assistant: @@ -61,6 +60,9 @@ is "/dev/ttyS0" for a physical RS-232 port, or "/dev/ttyUSB0" for a converter. The module count is the number of modules in the network. +Example: If there are three modules in the network, the module count is `3`. +This value is used to determine communication limits and resource allocation. + ### 1.4 Entities {% note %} @@ -107,7 +109,6 @@ and the o_id into the "id" parameter. - **Type of function:** Input - **Services:** None -- **Icon:** Specific for the chosen device class - **Entity type:** binary_sensor - **Device class:** door, garage_door, heat, light, motion, window, smoke, sound, power @@ -131,14 +132,20 @@ window, smoke, sound, power #### 1.4.7 Input -- **Type of function:** Input -- **Services:** None -- **Icon:** switch -- **Entity type:** sensor -- **Device class:** None +- **Type of function:** Input +- **Services:** None +- **Icon:** `switch` +- **Entity type:** `sensor` +- **Device class:** None - **Extra information:** - If the input is a short press and release, the sensor state is 2; -if it is a long press, the state is 3. + If the input is a short press and release, the sensor state is `2`. + If it is a long press, the state is `3`. + For **on**, the state is `1`; for **off**, the state is `2`. + +Example: +- A short press (`2`) might be used to toggle a light on or off. +- A long press (`3`) could trigger a scene or activate a different function, + such as dimming a light or opening a garage door. ## 2. Configuration via Config Flow @@ -154,4 +161,3 @@ Additionally, the configuration automatically generates two entities—**gryf_in and **gryf_out**. The **gryf_in** entity receives incoming messages, and the **gryf_out** entity handles outgoing messages. However, if you are not an experienced GryfSmart installer, you may ignore these details. - \ No newline at end of file From 0b4cf4f23728389ed56a61da03b6308b52b4fdcd Mon Sep 17 00:00:00 2001 From: karlowiczpl <159330051+karlowiczpl@users.noreply.github.com> Date: Fri, 28 Feb 2025 12:03:27 +0100 Subject: [PATCH 23/23] Update gryfsmart.markdown --- source/_integrations/gryfsmart.markdown | 7 ++++--- 1 file changed, 4 insertions(+), 3 deletions(-) diff --git a/source/_integrations/gryfsmart.markdown b/source/_integrations/gryfsmart.markdown index 69117f211a52..10ef1daec7eb 100644 --- a/source/_integrations/gryfsmart.markdown +++ b/source/_integrations/gryfsmart.markdown @@ -60,7 +60,7 @@ is "/dev/ttyS0" for a physical RS-232 port, or "/dev/ttyUSB0" for a converter. The module count is the number of modules in the network. -Example: If there are three modules in the network, the module count is `3`. +Example: If there are three modules in the network, the module count is `3`. This value is used to determine communication limits and resource allocation. ### 1.4 Entities @@ -142,14 +142,15 @@ window, smoke, sound, power If it is a long press, the state is `3`. For **on**, the state is `1`; for **off**, the state is `2`. -Example: +Example: + - A short press (`2`) might be used to toggle a light on or off. - A long press (`3`) could trigger a scene or activate a different function, such as dimming a light or opening a garage door. ## 2. Configuration via Config Flow -The "extra" parameter corresponds to the device_class if it exists. In the case +The "extra" parameter corresponds to the device_class, if it exists. In the case of a thermostat, the "extra" parameter maps to **t_id** instead. Otherwise, this parameter is not required. Additionally, the integration supports editing of individual devices and configuration. Please note that after making changes,