Address supported functionality section for Plugwise (#36515)

* Initial scaffolding for supported entities

* Generalise cooling description

* Revert deletion

* Revert deletion

* Fix nitpicks

* CRAI nitpicks

* Add suggestions

* Reworded

* Improve binary

* Improve binary
This commit is contained in:
Tom 2024-12-29 09:28:13 +01:00 committed by GitHub
parent c19e55c0a3
commit 00ef5754e1
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194

View File

@ -65,13 +65,88 @@ For a thermostat, the active schedule can be deactivated or reactivated via the
Auto means the schedule is active, and Heat means it's not active. The active thermostat schedule can be changed via the connected thermostat select entity. Please note that only schedules with two or more schedule points will be shown as select options.
## Entities
## Supported functionality
This integration will show all Plugwise devices (like hardware devices, multi-thermostat climate-zones, and virtual switchgroups) present in your Plugwise configuration. In addition, you will see a Gateway device representing your central Plugwise gateway (i.e., the Smile Anna, Smile P1, Adam or Stretch).
This integration displays all Plugwise devices in your configuration, including hardware devices, multi-thermostat climate zones, and virtual switch groups. Additionally, a device representing your Plugwise gateway (e.g., Adam, Smile-T, or P1) will be visible.
For example, if you have an Adam setup with a Lisa named 'Living' and a Tom named 'Bathroom', these will show up as individual devices. The heating/cooling device connected to your Smile will be shown as 'OpenTherm' or 'OnOff', depending on how the Smile communicates with the device. If you have Plugs (as in, pluggable switches connecting to an Adam) those will be shown as devices as well.
For example, if you have an Adam setup with a Lisa named 'Living' and a Tom named 'Bathroom', these will show up as individual devices. The heating/cooling device connected to your gateway will be shown as 'OpenTherm' or 'OnOff', depending on how the gateway communicates with the device. If you have Plugs (as in, pluggable switches connecting to an Adam) or Aqara Smart Plugs, those will be shown as devices as well.
Under each device there will be entities shown like binary_sensors, sensors, etc. depending on the capabilities of the device: for instance centralized measurements such as 'power' for a P1, 'outdoor_temperature' on Anna or Adam will be assigned to your gateway device. Heating/cooling device measurements such as 'boiler_temperature' will be assigned to the OpenTherm/OnOff device.
Each device will list entities such as `binary sensors`, `sensors`, etc., depending on its capabilities: for instance, centralized measurements such as `power` for a P1, `outdoor_temperature` on Anna or Adam will be assigned to your gateway device. Heating/cooling device measurements such as `boiler_temperature` will be assigned to the OpenTherm/OnOff device.
### Climate entities
#### Binary sensors
Depending on your setup, one or more binary sensors will provide the state of your connected elements. Examples include:
- **Cooling** & **Heating**
- **Description**: Indicates if your system is actively cooling or heating.
- **DHW State**
- **Description**: Indicates active heating of domestic hot water.
- **Flame State**
- **Description**: If gas is being consumed by your heater, i.e., firing for space or DHW-heating.
#### Numbers
Modifying specific number-based settings allows you to fine-tune your setup.
- **Maximum boiler temperature setpoint**
- **Description**: Adjust the maximum temperature for secondary heater.
- **Domestic hot water setpoint**
- **Description**: Adjust the temperature for your domestic hot water.
- **Temperature offset**
- **Description**: Fine-tune the perceived temperature.
#### Sensors
A generous number of sensors is provided for your climate setup. Examples include:
- **Setpoint**
- **Description**: The setpoint for the current zone (Adam) or generic (Anna).
- **Indoor temperature**
- **Description**: For Anna, Lisa or Jip this will show the temperature measured at the specific thermostat.
- **Outdoor temperature**
- **Description**: The temperature your climate gateway retrieves online.
- **Outdoor air temperature**
- **Description**: The temperature reported by the sensor present in the outdoor unit of your HVAC system, such as a heat pump.
#### Selects
- **Thermostat schedule**
- **Description**: Select between available schedules, generic (Anna) or for the current zone (Adam).
- **Remark**: Please check the [further configuration](#further-configuration) for requirements on configuring schedules.
#### Switches
- **Cooling**
- **Description**: Toggle if cooling should be enabled.
- **DHW Comfort Mode**
- **Description**: Toggle comfort mode for domestic hot water.
### Power and gas entities
#### Sensors
A generous number of sensors is provided. Examples include:
- **Electricity consumed point**
- **Description**: Electricity (in Watt) consumed currently by a phase (P1) or a plug.
- **Gateways**: Adam, P1 or Stretch.
- **Gas Consumed Interval**
- **Description**: The gas consumed since the last interval.
- **Gateways**: P1.
- **P1 Net Electricity Point**
- **Description**: Your netto electricity use at this time, can be negative when producing energy, i.e. though solar panels.
- **Gateways**: P1.
- **P1 Electricity Produced off-peak cumulative**
- **Description**: The total produced electricity during off-peak.
- **Gateways**: P1.
#### Switches
- **Relay**
- **Description**: Switch a plug on or off
- **Gateways**: Adam, P1 or Stretch.
## Data updates