Improve initial section and supported devices for Plugwise (#36500)

* Incremental restart * Fix (future and) current link endpoints * CRAI nitpicks * Known limitations for next PR * Rework from 36333 data updates * Textlint Zigbee
home-assistant · Dec 29, 2024 · 76eed77 · 76eed77
1 parent a4e1a1c
commit 76eed77
Showing 1 changed file with 60 additions and 40 deletions.
diff --git a/source/_integrations/plugwise.markdown b/source/_integrations/plugwise.markdown
@@ -1,6 +1,6 @@
 ---
 title: Plugwise
-description: Plugwise Smile platform integration.
+description: Plugwise Gateway platform integration.
 ha_category:
   - Binary sensor
   - Button
@@ -30,40 +30,42 @@ ha_platforms:
 ha_integration_type: hub
 ---
 
-This enables [Plugwise](https://www.plugwise.com) integrations with a central Smile gateway to be integrated. This integration talks locally to your **Smile** interface, and you will need its password and IP address.
-The platform supports [Anna](https://www.plugwise.com/en_US/products/anna), [Adam (zonecontrol)](https://www.plugwise.com/en_US/zonecontrol), [P1](https://www.plugwise.com/en_US/products/smile-p1) Smile products and the Stretch products (not in sale). See below list for more details.
+[Plugwise](https://www.plugwise.com) provides smart home devices that allow you to monitor and control your climate, energy (including gas) consumption, and energy production. The energy information can be used for the [energy dashboard](/home-energy-management).
 
-Platforms available - depending on your Smile and setup include:
-
- - `climate` (for the stand-alone Anna, for Adam, a climate entity is shown for each zone containing devices like an Anna or another type of wired-thermostat, Jip or Lisa combined with one or more Tom/Floor devices)
- - `binary_sensor` (for showing the status of e.g. domestic hot water heating or secondary heater)
- - `button` (for the Adam and the non-legacy Anna and P1 gateways)
- - `number` (for changing a boiler setpoint, a temperature offset)
- - `sensor` (for all relevant products including the Smile P1)
- - `select` (for changing a thermostat schedule, a regulation mode (Adam only))
- - `switch` (for Plugs connected to Adam, or Circles and Stealths connected to a Stretch)
+This integration supports one or multiple Plugwise Gateways connected to your network. You can connect to these gateways using your browser, the Plugwise App, or Home Assistant. There are 4 [supported](#supported-devices) types of gateways:
 
+- Full zonecontrol using the [Adam](https://www.plugwise.com/en_US/zonecontrol) using [additional devices](#adam) such as zone thermostats, smart valves and smart-plugs.
+- A stand-alone smart thermostat called [Anna](https://www.plugwise.com/en_US/products/anna).
+- For power and gas-usage monitoring there is a device simply called the [P1](https://www.plugwise.com/en_US/products/smile-p1).
+- Although no longer sold, there also is support for Stretch, a gateway to create network connectivity for their older power products.
 
 ## Pre-requisites
 
-The Plugwise Smile(s) in your network will be automatically discovered and shown on the integrations dashboard. All you need is the Smile ID as its password, which is an 8-character string printed on the sticker on the bottom of your Smile. Repeat this for each individual Smile.
+Plugwise gateways on your network are automatically discovered and displayed on the integrations dashboard. Each gateway requires its unique 8-character ID, found on a sticker at the bottom, as its password. Repeat this process for each gateway.
 
 {% include integrations/config_flow.md %}
 
 {% configuration_basic %}
 Host:
-  description: "The hostname or IP address of your Smile. For example: `192.168.1.25`. You can find it in your router or in the Plugwise app using the **Settings** icon (&#9776;) -> **System** -> **Network**. If you are looking for a different device in the Plugwise App, on the main screen first select **Gateways** -> the Smile of your choice, and then follow the previous instruction. Normally, the Smile(s) are automatically discovered, and you don't have to provide the hostname or IP address."
+  description: "The hostname or IP address of your gateway. For example: `192.168.1.25`. You can find it in your router or in the Plugwise app using the **Settings** icon (&#9776;) -> **System** -> **Network**. In the Plugwise App, to locate a specific device, select **Gateways** on the main screen, choose your desired gateway, and then follow the previous instructions. Normally, the gateway(s) are automatically discovered, and you don't have to provide the hostname or IP address."
 Username:
-  description: "Username to log in to the Smile. This should be just `smile` - or `stretch` for a Stretch."
+  description: "Username to log in to the gateway. This should be 'smile' for most devices, or 'stretch' for a Stretch."
 Password:
-  description: "This is the password (i.e. Smile ID) printed on the sticker on the back of your Smile (i.e. Adam, Smile-T, or P1) and should be 8 characters long."
+  description: "Each gateway requires its unique 8-character ID, found on a sticker at the bottom, as its password."
 {% endconfiguration_basic %}
 
-### Further configuration
+### Schedule Management
 
-For a thermostat, the active schedule can be deactivated or reactivated via the climate card. Please note, that when no schedule is active, one must first be activated in the Plugwise App. Once that has been done, the Plugwise Integration can manage future operations.
+1. **Initial Setup**: First, activate a schedule using the Plugwise App or browser.
+2. **Control via Home Assistant**:
+   - Use the climate card to activate/deactivate schedules.
+   - 'Auto' mode indicates the schedule is active.
+   - 'Heat', 'Cool' or 'Heat_cool' modes signify the schedule is inactive.
+3. **Changing Schedules**: Use the thermostat [select](#change-climate-schedule) entity.
 
-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.
+{% note %}
+Only schedules with two or more schedule points will appear as options.
+{% endnote %}
 
 ## Supported functionality
 
@@ -150,11 +152,13 @@ A generous number of sensors is provided. Examples include:
 
 ## Data updates
 
-The interval which the integration fetches data from the Smile depends on the device:
+The interval at which the integration fetches data from the gateway depends on the device-type.
 
-- Power entities, such as the P1, will be refreshed every 10 seconds.
-- Climate entities will be refreshed every 60 seconds.
-- Stretch entities will be refreshed every 60 seconds.
+|Device-type|Interval|
+--- | ---
+| Climate entities |60 seconds|
+| Energy and gas entities |10 seconds|
+| Stretch entities |60 seconds|
 
 ## Removing the integration
 
@@ -311,33 +315,49 @@ script:
           preset_mode: asleep
 ```
 
-### Supported devices
+## Supported devices
 
-The current implementation of the Python module (Plugwise-Smile) includes:
+### Adam
 
-Adam (zone_control) with On/Off, OpenTherm, and Loria/Thermastage heating and cooling support:
+A complete zone control system also known as [Adam HA](https://www.plugwise.com/en_US/zonecontrol), supporting:
 
- - v3.x
- - v2.3
+- On/Off, OpenTherm heating and cooling support.
+- Running firmwares v3.x or v2.3.
+- Additional devices:
+  - Zone thermostats such as Lisa or Anna (see warning below on Anna),
+  - A temperature sensor, Jip,
+  - Valve controllers called Floor or Tom,
+  - An under-floor heating controller Koen (note: a Koen always comes with a Plug, which is the active part),
+  - Smart switches, either Plug or Aqara Smart Plug.
 
- - Devices supported are Anna, Lisa, Jip, Floor, Tom, Plug, Aqara Smart Plug, and Koen (a Koen always comes with a Plug, the active part)
+{% note %}
+You can also use the Adam SA (Stand-alone, no Zigbee stick present) to make your regular OpenTherm thermostat smart.
+{% endnote %}
 
-Anna (thermostat) with OnOff, OpenTherm heating, and Elga and Loria/Thermastage with heating and cooling support:
+### Anna
 
- - v4.x
- - v3.x
- - v1.x
+A [smart thermostat](https://www.plugwise.com/en_US/products/anna), supporting:
 
-On the Elga, the cooling-mode can only be turned on, or off, via a switch present on the device, not via a toggle in the Plugwise App.
-Please make sure to reload the Plugwise integration after the cooling-mode-switch is turned off after being on, or the other way around. This will ensure that the Plugwise integration is being adapted to the change in function of the Elga.
+- On/Off, OpenTherm heating and cooling support.
+- Running firmware v4.x, v3.x or v1.x.
 
-Smile P1 (DSMR):
+### P1 (DSMR)
 
- - v4.x
- - v3.x
- - v2.x
+A [P1](https://www.plugwise.com/en_US/products/smile-p1) smart meter monitor for the single- or multi-phase grid power connection to your home including gas usage monitoring. Running firmware v4.x, v3.x or v2.x.
+
+### Stretch (end-of-sale)
+
+For controlling and monitoring legacy power switches, such as the Circles or Stealths, with v3.x or v2.x Stretch firmware.
+
+### Unsupported devices
+
+#### Anna P1
+
+A smart thermostat [combined](https://www.plugwise.com/en_US/products/anna-p1) with an energy monitor can transform the way you manage energy. If your solar setup generates surplus energy and you're charged for it, this combination ensures that excess solar power is redirected efficiently. Powering your heat pump for instance to make the most of renewable energy. Do you have a setup like this? We’d love to hear your experience!
+
+#### Stick
 
-Stretch (power switches):
+Plugwise formerly sold power-based products comprised of a USB stick, as the controller, and smart plugs (amongst a few other items). This integration does not support the USB-stick. Reuse of the these products, such as Circles and Stealths using a Stretch or an Adam is supported. Work for USB support is in development by the community, but not ready to become a formal Home Assistant integration just yet.
 
  - v3.x
  - v2.x