From 33dc15e5a5e3a4574d7778b49e42659bacfe530f Mon Sep 17 00:00:00 2001 From: brefra Date: Fri, 15 May 2020 22:51:04 +0200 Subject: [PATCH 1/4] Add Plugwise USB-Stick integration page --- source/_integrations/plugwise_stick.markdown | 94 ++++++++++++++++++++ 1 file changed, 94 insertions(+) create mode 100644 source/_integrations/plugwise_stick.markdown diff --git a/source/_integrations/plugwise_stick.markdown b/source/_integrations/plugwise_stick.markdown new file mode 100644 index 000000000000..7d8b4698a900 --- /dev/null +++ b/source/_integrations/plugwise_stick.markdown @@ -0,0 +1,94 @@ +--- +title: Plugwise USB-stick +description: Plugwise USB-stick integration. +ha_category: + - Sensor + - Switch +ha_iot_class: Local Push +ha_release: 0.110 +ha_codeowners: + - '@brefra' +ha_domain: plugwise_stick +--- + +This integration enables switching of the relay and monitoring of consumed power of the legacy [Plugwise](https://plugwise.com) Circle+, [Circle](https://www.plugwise.com/en_US/products/circle) and [Stealth](https://www.plugwise.com/en_US/products/stealth) devices. + +
+ + Be aware this integration does **not** support the more recent [Plug](https://www.plugwise.com/en_US/products/plug) devices, which can be identified by having a local button as opposed to the old Circles. + If you want to control the new Plugwise devices like the Plugwise Anna thermostat and plugs check out the [Plugwise](/integrations/plugwise/) integration. + +
+ +This integration requires to have a Plugwise USB-stick and Circle+ to communicate directly to the Plugwise devices. The additional Plugwise devices should be linked to the Circle+. +There is currently support for the following Plugwise devices types within Home Assistant: + +- Circle+ +- [Circle](https://www.plugwise.com/en_US/products/circle) +- [Stealth](https://www.plugwise.com/en_US/products/stealth) + +The power use of the devices wil + +## Configuration + +From the Home Assistant front page go to **Configuration** and then select **Integrations** from the list. +Use the plus button in the bottom right to add a new integration called **Plugwise USB-Stick**. + +In the set up wizard at the 'USB Device Path' it will list all detected serial ports available to Home Assistant. You need to pick the serialport of the connected Plugwise USB-Stick. +If required the selection list contains the possibility to manually enter the device path. + +When you press `Submit` and the integration will try to initialize the USB-Stick at the supplied device path. If the connection to the USB-stick is initialized successfully, it will automatically do a discovery of all linked Plugwise nodes stored at the Circle+ device. +An error will be displayed in the wizard if Home Assistant can't access the USB-stick or the connection fails. + +The integration will automatically save the connection by the serial path (eg `/dev/serial/by-id/*`) to keep the connection consistent between system restarts. + +## Switches + +A `switch` entity will be automatically created for the Circle+, Circle and Steath devices to control the power to the attached load. If required the switch control can be disabled in Home Assistant. + +## Sensors + +The following `sensor` entities will automatically be created. Some `sensor` entities are less useful and disabled by default. If required these can be enabled from the `Devices` panel in the `Configuration` page of the web interface. + +- **Ping roundtrip** + Network roundtrip time (milliseconds). + +- **Power use** + Average power use during 1 second measurement (Watt). + +- **Power usage 8 seconds** + Average power use during 8 seconds measurement (Watt). + +- **Power consumption current hour** + Total power consumption during this hour (kWh). + +- **Power consumption previous hour** + Total power consumption during previous hour (kWh). + +- **Power consumption today** + Total power usage from today to the present (kWh). + +- **Power consumption yesterday** + Total power usage from yesterday (kWh). + +- **Power production current hour** + Total power production during this hour (kWh). + +- **Power production previous hour** + Total power production during previous hour (kWh). + +## Known issues + +The following Plugwise are not supported: + +- [Scan](https://www.plugwise.com/en_US/products/scan) +- [Sense](https://www.plugwise.com/en_US/products/sense) +- [Switch](https://www.plugwise.com/en_US/products/switch) +- [Sting](https://www.plugwise.com/en_US/products/sting) +- [Stealth-M](https://www.plugwise.com/en_US/products/stealth-m) + +Currently there is no support for linking (or removing) nodes from the Plugwise network. You still need the Plugwise [Source software](https://www.plugwise.com/en_US/source) for that. + +The sensors are automatically refreshed. The used refresh time is based on the number linked devices. + +When a device is not reachable it will be marked as unavailable. Every hour another attempt is made to check whether the device is available again. If this is the case, the device will be made available again in Home Assistant. After this, the sensors will also be updated again. From 0d68f148381b1f3ac7aa981d84878e0cc6a1cabb Mon Sep 17 00:00:00 2001 From: brefra Date: Sat, 16 May 2020 20:42:13 +0200 Subject: [PATCH 2/4] Some small tweaks --- source/_integrations/plugwise_stick.markdown | 4 +--- 1 file changed, 1 insertion(+), 3 deletions(-) diff --git a/source/_integrations/plugwise_stick.markdown b/source/_integrations/plugwise_stick.markdown index 7d8b4698a900..a0a8357c9227 100644 --- a/source/_integrations/plugwise_stick.markdown +++ b/source/_integrations/plugwise_stick.markdown @@ -15,7 +15,7 @@ This integration enables switching of the relay and monitoring of consumed power
- Be aware this integration does **not** support the more recent [Plug](https://www.plugwise.com/en_US/products/plug) devices, which can be identified by having a local button as opposed to the old Circles. + Be aware this integration does **not** support the more recent [Plug](https://www.plugwise.com/en_US/products/plug) devices, which can be identified by having a local button as opposed to the old Circles which don't have a button at all. If you want to control the new Plugwise devices like the Plugwise Anna thermostat and plugs check out the [Plugwise](/integrations/plugwise/) integration.
@@ -27,8 +27,6 @@ There is currently support for the following Plugwise devices types within Home - [Circle](https://www.plugwise.com/en_US/products/circle) - [Stealth](https://www.plugwise.com/en_US/products/stealth) -The power use of the devices wil - ## Configuration From the Home Assistant front page go to **Configuration** and then select **Integrations** from the list. From afc420414ba04beac1b62178d4d8c31d9aebdbae Mon Sep 17 00:00:00 2001 From: brefra Date: Mon, 25 May 2020 12:57:36 +0200 Subject: [PATCH 3/4] Raise HA release to 0.111 --- source/_integrations/plugwise_stick.markdown | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/source/_integrations/plugwise_stick.markdown b/source/_integrations/plugwise_stick.markdown index a0a8357c9227..7bccfd5e4b0a 100644 --- a/source/_integrations/plugwise_stick.markdown +++ b/source/_integrations/plugwise_stick.markdown @@ -5,7 +5,7 @@ ha_category: - Sensor - Switch ha_iot_class: Local Push -ha_release: 0.110 +ha_release: 0.111 ha_codeowners: - '@brefra' ha_domain: plugwise_stick From f199c4722329a34f3fb99a68b2f9f9eb0e5c9098 Mon Sep 17 00:00:00 2001 From: Franck Nijhof Date: Fri, 29 May 2020 10:41:29 +0200 Subject: [PATCH 4/4] :pencil2: Tweaks --- source/_integrations/plugwise_stick.markdown | 24 ++++++++++---------- 1 file changed, 12 insertions(+), 12 deletions(-) diff --git a/source/_integrations/plugwise_stick.markdown b/source/_integrations/plugwise_stick.markdown index 7bccfd5e4b0a..01daf77c15e3 100644 --- a/source/_integrations/plugwise_stick.markdown +++ b/source/_integrations/plugwise_stick.markdown @@ -15,8 +15,8 @@ This integration enables switching of the relay and monitoring of consumed power
- Be aware this integration does **not** support the more recent [Plug](https://www.plugwise.com/en_US/products/plug) devices, which can be identified by having a local button as opposed to the old Circles which don't have a button at all. - If you want to control the new Plugwise devices like the Plugwise Anna thermostat and plugs check out the [Plugwise](/integrations/plugwise/) integration. +Be aware this integration does **not** support the more recent [Plug](https://www.plugwise.com/en_US/products/plug) devices, which can be identified by having a local button as opposed to the old Circles which don't have a button at all. + If you want to control the new Plugwise devices like the Plugwise Anna thermostat and plugs, check out the [Plugwise](/integrations/plugwise/) integration.
@@ -29,16 +29,16 @@ There is currently support for the following Plugwise devices types within Home ## Configuration -From the Home Assistant front page go to **Configuration** and then select **Integrations** from the list. +From the Home Assistant front page, go to **Configuration** and then select **Integrations** from the list. Use the plus button in the bottom right to add a new integration called **Plugwise USB-Stick**. -In the set up wizard at the 'USB Device Path' it will list all detected serial ports available to Home Assistant. You need to pick the serialport of the connected Plugwise USB-Stick. -If required the selection list contains the possibility to manually enter the device path. +In the setup wizard at the 'USB Device Path', it will list all detected serial ports available to Home Assistant. You need to pick the serial port of the connected Plugwise USB-Stick. +If required, the selection list contains the possibility to manually enter the device path. When you press `Submit` and the integration will try to initialize the USB-Stick at the supplied device path. If the connection to the USB-stick is initialized successfully, it will automatically do a discovery of all linked Plugwise nodes stored at the Circle+ device. An error will be displayed in the wizard if Home Assistant can't access the USB-stick or the connection fails. -The integration will automatically save the connection by the serial path (eg `/dev/serial/by-id/*`) to keep the connection consistent between system restarts. +The integration will automatically save the connection by the serial path (e.g., `/dev/serial/by-id/*`) to keep the connection consistent between system restarts. ## Switches @@ -46,7 +46,7 @@ A `switch` entity will be automatically created for the Circle+, Circle and Stea ## Sensors -The following `sensor` entities will automatically be created. Some `sensor` entities are less useful and disabled by default. If required these can be enabled from the `Devices` panel in the `Configuration` page of the web interface. +The following `sensor` entities will automatically be created. Some `sensor` entities are less useful and disabled by default. If required, these can be enabled from the `Devices` panel in the `Configuration` page of the web interface. - **Ping roundtrip** Network roundtrip time (milliseconds). @@ -61,7 +61,7 @@ The following `sensor` entities will automatically be created. Some `sensor` ent Total power consumption during this hour (kWh). - **Power consumption previous hour** - Total power consumption during previous hour (kWh). + Total power consumption during the previous hour (kWh). - **Power consumption today** Total power usage from today to the present (kWh). @@ -73,7 +73,7 @@ The following `sensor` entities will automatically be created. Some `sensor` ent Total power production during this hour (kWh). - **Power production previous hour** - Total power production during previous hour (kWh). + Total power production during the previous hour (kWh). ## Known issues @@ -85,8 +85,8 @@ The following Plugwise are not supported: - [Sting](https://www.plugwise.com/en_US/products/sting) - [Stealth-M](https://www.plugwise.com/en_US/products/stealth-m) -Currently there is no support for linking (or removing) nodes from the Plugwise network. You still need the Plugwise [Source software](https://www.plugwise.com/en_US/source) for that. +Currently, there is no support for linking (or removing) nodes from the Plugwise network. You still need the Plugwise [Source software](https://www.plugwise.com/en_US/source) for that. -The sensors are automatically refreshed. The used refresh time is based on the number linked devices. +The sensors are automatically refreshed. The used refresh time is based on the number of linked devices. -When a device is not reachable it will be marked as unavailable. Every hour another attempt is made to check whether the device is available again. If this is the case, the device will be made available again in Home Assistant. After this, the sensors will also be updated again. +When a device is not reachable, it will be marked as unavailable. Every hour another attempt is made to check whether the device is available again. If this is the case, the device will be made available again in Home Assistant. After this, the sensors will also be updated again.