From 699184043f8a29c80c2a8a7d46ef6745aa34dfde Mon Sep 17 00:00:00 2001 From: Jorim Tielemans Date: Sun, 22 Jul 2018 23:47:12 +0200 Subject: [PATCH 01/24] Fix typos in Insteon fan --- source/_components/fan.insteon_local.markdown | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/source/_components/fan.insteon_local.markdown b/source/_components/fan.insteon_local.markdown index d9738043c9a..ed61a40a096 100644 --- a/source/_components/fan.insteon_local.markdown +++ b/source/_components/fan.insteon_local.markdown @@ -12,6 +12,6 @@ ha_category: Fan ha_version: 0.48 --- -The `insteon_local` fan component lets you control your fan connected to an [Insteon Hub](http://www.insteon.com/insteon-hub/) with Home Assistant. +The `insteon_local` fan component lets you control your fans connected to an [Insteon Hub](http://www.insteon.com/insteon-hub/) with Home Assistant. -To get your insteon fans working with Home Assistant, follow the instructions for the general [Insteon local component](/components/insteon_local/). The fans will be automatically disovered and added to Home Assistant. The device names will be the Insteon address of the fans. +To get your Insteon fans working with Home Assistant, follow the instructions for the general [Insteon local component](/components/insteon_local/). The fans will be automatically discovered and added to Home Assistant. The device names will be the Insteon address of the fans. From 2df0a9bf4c79d83eab04d285eb20cc310e522858 Mon Sep 17 00:00:00 2001 From: Jorim Tielemans Date: Sun, 22 Jul 2018 23:53:47 +0200 Subject: [PATCH 02/24] Fix typos in Insteon light --- source/_components/light.insteon_local.markdown | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/source/_components/light.insteon_local.markdown b/source/_components/light.insteon_local.markdown index b9aacb3250f..83c0a8eb21f 100644 --- a/source/_components/light.insteon_local.markdown +++ b/source/_components/light.insteon_local.markdown @@ -15,4 +15,4 @@ ha_iot_class: "Local Push" The `insteon_local` light component lets you control your lights connected to an [Insteon Hub](http://www.insteon.com/insteon-hub/) with Home Assistant. -To get your insteon lights working with Home Assistant, follow the instructions for the general [Insteon local component](/components/insteon_local/). The lights will be automatically disovered and added to Home Assistant. The device names will be the Insteon address of the lights. +To get your Insteon lights working with Home Assistant, follow the instructions for the general [Insteon local component](/components/insteon_local/). The lights will be automatically discovered and added to Home Assistant. The device names will be the Insteon address of the lights. From 709bab789fed289946493cfddea3bb6b7d55e02d Mon Sep 17 00:00:00 2001 From: Jorim Tielemans Date: Sun, 22 Jul 2018 23:55:29 +0200 Subject: [PATCH 03/24] Fix typos in Insteon switch --- source/_components/switch.insteon_local.markdown | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/source/_components/switch.insteon_local.markdown b/source/_components/switch.insteon_local.markdown index 8a3c3f93603..f968005ac65 100644 --- a/source/_components/switch.insteon_local.markdown +++ b/source/_components/switch.insteon_local.markdown @@ -14,4 +14,4 @@ ha_version: 0.36 The `insteon_local` switch component lets you control your switches connected to an [Insteon Hub](http://www.insteon.com/insteon-hub/) with Home Assistant. -To get your insteon switches working with Home Assistant, follow the instructions for the general [Insteon local component](/components/insteon_local/). The switches will be automatically disovered and added to Home Assistant. The device names will be the Insteon address of the switch. +To get your Insteon switches working with Home Assistant, follow the instructions for the general [Insteon local component](/components/insteon_local/). The switches will be automatically discovered and added to Home Assistant. The device names will be the Insteon address of the switch. From e2ce0f738005b8a3049c40b78e26e99fab699fae Mon Sep 17 00:00:00 2001 From: Jorim Tielemans Date: Mon, 23 Jul 2018 00:31:44 +0200 Subject: [PATCH 04/24] Redirect from old fan.insteon_hub component --- source/_components/fan.insteon_local.markdown | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/source/_components/fan.insteon_local.markdown b/source/_components/fan.insteon_local.markdown index ed61a40a096..7b77c7f15ac 100644 --- a/source/_components/fan.insteon_local.markdown +++ b/source/_components/fan.insteon_local.markdown @@ -1,6 +1,6 @@ --- layout: page -title: "Insteon (Local) Fan" +title: "Insteon (local) Fan" description: "Instructions on how to setup the Insteon Hub Fans locally within Home Assistant." date: 2017-04-06 11:00 sidebar: true @@ -10,6 +10,7 @@ footer: true logo: insteon.png ha_category: Fan ha_version: 0.48 +redirect_from: /components/fan.insteon_hub/ --- The `insteon_local` fan component lets you control your fans connected to an [Insteon Hub](http://www.insteon.com/insteon-hub/) with Home Assistant. From a507fb4f5ea9fa910b22a551228f75a196c015cc Mon Sep 17 00:00:00 2001 From: Jorim Tielemans Date: Mon, 23 Jul 2018 00:32:26 +0200 Subject: [PATCH 05/24] Remove old fan.insteon_hub component Now redirects to fan.insteon_local --- source/_components/fan.insteon_hub.markdown | 17 ----------------- 1 file changed, 17 deletions(-) delete mode 100644 source/_components/fan.insteon_hub.markdown diff --git a/source/_components/fan.insteon_hub.markdown b/source/_components/fan.insteon_hub.markdown deleted file mode 100644 index 0436d4bddee..00000000000 --- a/source/_components/fan.insteon_hub.markdown +++ /dev/null @@ -1,17 +0,0 @@ ---- -layout: page -title: "Insteon Hub Fan" -description: "Instructions on how to setup the Insteon Hub Fans within Home Assistant." -date: 2017-08-26 08:00 -sidebar: true -comments: false -sharing: true -footer: true -logo: insteon.png -ha_category: Fan -ha_release: "0.30" ---- - -The `insteon_hub` fan component lets you control your fans connected to an [Insteon Hub](http://www.insteon.com/insteon-hub/) with Home Assistant. - -To get your Insteon Hub fan working with Home Assistant, follow the instructions for the general [Insteon Hub component](/components/insteon_hub/). From e0660a42bdca23169db66f4599f5624627160c26 Mon Sep 17 00:00:00 2001 From: Jorim Tielemans Date: Mon, 23 Jul 2018 13:05:17 +0200 Subject: [PATCH 06/24] Redirect from old fan.insteon_hub component --- source/_components/light.insteon_local.markdown | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/source/_components/light.insteon_local.markdown b/source/_components/light.insteon_local.markdown index 83c0a8eb21f..21a960f75fa 100644 --- a/source/_components/light.insteon_local.markdown +++ b/source/_components/light.insteon_local.markdown @@ -1,6 +1,6 @@ --- layout: page -title: "Insteon (Local) Light" +title: "Insteon (local) Light" description: "Instructions on how to setup the Insteon Hub Lights locally within Home Assistant." date: 2016-12-18 08:00 sidebar: true @@ -11,6 +11,7 @@ logo: insteon.png ha_category: Light ha_version: 0.36 ha_iot_class: "Local Push" +redirect_from: /components/light.insteon_hub/ --- The `insteon_local` light component lets you control your lights connected to an [Insteon Hub](http://www.insteon.com/insteon-hub/) with Home Assistant. From 470e68385ca6a158513e63eacfc225257fd3b288 Mon Sep 17 00:00:00 2001 From: Jorim Tielemans Date: Mon, 23 Jul 2018 13:06:50 +0200 Subject: [PATCH 07/24] Remove old light.insteon_hub component Now redirects to light.insteon_local --- source/_components/light.insteon_hub.markdown | 18 ------------------ 1 file changed, 18 deletions(-) delete mode 100644 source/_components/light.insteon_hub.markdown diff --git a/source/_components/light.insteon_hub.markdown b/source/_components/light.insteon_hub.markdown deleted file mode 100644 index f581706b92c..00000000000 --- a/source/_components/light.insteon_hub.markdown +++ /dev/null @@ -1,18 +0,0 @@ ---- -layout: page -title: "Insteon Hub Light" -description: "Instructions on how to setup the Insteon Hub Lights within Home Assistant." -date: 2016-09-10 08:00 -sidebar: true -comments: false -sharing: true -footer: true -logo: insteon.png -ha_category: Light -ha_release: 0.21 -ha_iot_class: "Local Push" ---- - -The `insteon_hub` light component lets you control your lights connected to an [Insteon Hub](http://www.insteon.com/insteon-hub/) with Home Assistant. - -To get your Insteon Hub fan working with Home Assistant, follow the instructions for the general [Insteon Hub component](/components/insteon_hub/). From dd49c9b3069f285dd70ae60c8d786afdc642a5bf Mon Sep 17 00:00:00 2001 From: Jorim Tielemans Date: Mon, 23 Jul 2018 13:07:51 +0200 Subject: [PATCH 08/24] Update switch.insteon_local.markdown --- source/_components/switch.insteon_local.markdown | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/source/_components/switch.insteon_local.markdown b/source/_components/switch.insteon_local.markdown index f968005ac65..fad626ca1a3 100644 --- a/source/_components/switch.insteon_local.markdown +++ b/source/_components/switch.insteon_local.markdown @@ -1,6 +1,6 @@ --- layout: page -title: "Insteon (Local) Switch" +title: "Insteon (local) Switch" description: "Instructions on how to setup the Insteon Hub switches locally within Home Assistant." date: 2016-12-18 08:00 sidebar: true From b768d09e674078e8e05edb0b9ed3539c4b24b5d4 Mon Sep 17 00:00:00 2001 From: Jorim Tielemans Date: Mon, 23 Jul 2018 13:25:14 +0200 Subject: [PATCH 09/24] Redirect from insteon_hub and clarify why --- source/_components/insteon_local.markdown | 7 ++++++- 1 file changed, 6 insertions(+), 1 deletion(-) diff --git a/source/_components/insteon_local.markdown b/source/_components/insteon_local.markdown index 40ed93c1d56..e20ecac6758 100644 --- a/source/_components/insteon_local.markdown +++ b/source/_components/insteon_local.markdown @@ -11,11 +11,16 @@ logo: insteon.png ha_category: Hub ha_iot_class: "Local Polling" ha_version: 0.36 +redirect_from: /components/insteon_hub/ --- +

+This component replaces the old `insteon_hub` component, which has been removed due to a complaint by Insteon. +

+ The `insteon_local` component let you use your [Insteon Hub](http://www.insteon.com/insteon-hub/) with Home Assistant. -To integrate your Insteon local setup with Home Assistant, add the following section to your `configuration.yaml` file: +To integrate your Insteon Hub (local setup) with Home Assistant, add the following section to your `configuration.yaml` file: ```yaml # Example configuration.yaml platform entry From 70558d27343fe61969afbe69df09349122d6db7c Mon Sep 17 00:00:00 2001 From: Jorim Tielemans Date: Mon, 23 Jul 2018 13:27:36 +0200 Subject: [PATCH 10/24] Remove old documentation for insteon_hub Component won't be fixed, replaced by insteon_local --- source/_components/insteon_hub.markdown | 37 ------------------------- 1 file changed, 37 deletions(-) delete mode 100644 source/_components/insteon_hub.markdown diff --git a/source/_components/insteon_hub.markdown b/source/_components/insteon_hub.markdown deleted file mode 100644 index 5c9813bc5ca..00000000000 --- a/source/_components/insteon_hub.markdown +++ /dev/null @@ -1,37 +0,0 @@ ---- -layout: page -title: "Insteon Hub" -description: "Instructions on how to setup the Insteon Hub within Home Assistant." -date: 2016-01-27 08:00 -sidebar: true -comments: false -sharing: true -footer: true -logo: insteon.png -ha_category: Hub -ha_iot_class: "Cloud Polling" ---- - -

-This component has been disabled due to a complaint by Insteon. It will be enabled again once this issue has been resolved. -

- -The `insteon` component lets you use your [Insteon Hub](http://www.insteon.com/insteon-hub/) with Home Assistant. - -You will need to obtain an Insteon REST API key from the [Insteon Developer program](http://www.insteon.com/become-an-insteon-developer) to use this component. - -To integrate your Insteon Hub with Home Assistant, add the following section to your `configuration.yaml` file: - -```yaml -# Example configuration.yaml entry -insteon_hub: - username: YOUR_USERNAME - password: YOUR_PASSWORD - api_key: YOUR_API_KEY -``` - -Configuration variables: - -- **username** (*Required*): The username used to access the Insteon interface (e.g., the [connect.insteon.com](http://connect.insteon.com/) site). -- **password** (*Required*): The password used to access the Insteon interface. -- **api_key** (*Required*): The Insteon REST API key emailed to you once you are approved in the Insteon Developer program. From 2802630c4cf3e9a47cc4e7b81e5672ad681a57f0 Mon Sep 17 00:00:00 2001 From: Jorim Tielemans Date: Mon, 23 Jul 2018 14:29:32 +0200 Subject: [PATCH 11/24] Update insteon_local.markdown --- source/_components/insteon_local.markdown | 58 +++++++++++++---------- 1 file changed, 34 insertions(+), 24 deletions(-) diff --git a/source/_components/insteon_local.markdown b/source/_components/insteon_local.markdown index e20ecac6758..cd76a7d7b20 100644 --- a/source/_components/insteon_local.markdown +++ b/source/_components/insteon_local.markdown @@ -10,43 +10,53 @@ footer: true logo: insteon.png ha_category: Hub ha_iot_class: "Local Polling" -ha_version: 0.36 +ha_release: 0.36 redirect_from: /components/insteon_hub/ --- -

-This component replaces the old `insteon_hub` component, which has been removed due to a complaint by Insteon. -

- The `insteon_local` component let you use your [Insteon Hub](http://www.insteon.com/insteon-hub/) with Home Assistant. -To integrate your Insteon Hub (local setup) with Home Assistant, add the following section to your `configuration.yaml` file: +## {% linkable_title Configuration %} + +To integrate your Insteon Hub (local setup) with Home Assistant, add the following to your `configuration.yaml` file: ```yaml # Example configuration.yaml platform entry insteon_local: - host: YOUR HUB IP - username: YOUR HUB USERNAME - password: YOUR HUB PASSWORD + host: YOUR_HUB_IP + username: YOUR_HUB_USERNAME + password: YOUR_HUB_PASSWORD ``` -Configuration variables: *Note: The username and password here are for the hub and are different than the ones used to access the app. You can usually find these on the bottom of your hub (unless you've changed them through the settings in the app)* -- **host** (*Required*): The IP address of your hub. -- **username** (*Required*): The username used to access the Insteon interface (find in your Insteon app). -- **password** (*Required*): The password used to access the Insteon interface. -- **timeout** (*Optional*): Timeout to wait for connections. Defaults to 10 seconds. -- **port** (*Optional*): The port your hub is configured to listen to. Defaults to `25105`. -### {% linkable_title Full configuration %} +{% configuration %} +host: + description: The IP address of your hub. + required: true + type: string +username: + description: The username used to access the Insteon interface (find in your Insteon app). + required: true + type: string +password: + description: The password used to access the Insteon interface. + required: true + type: string +timeout: + description: Timeout to wait for connections. + required: false + type: time + default: 10 seconds +port: + description: The port your hub is configured to listen to. + required: false + type: string + default: 25105 +{% endconfiguration %} The `insteon_local` component currently supports lights (dimmers), switches and fans. -```yaml -insteon_local: - host: YOUR HUB IP - username: YOUR HUB USERNAME - password: YOUR HUB PASSWORD - timeout: 10 - port: 25105 -``` +

+This component replaces the old `insteon_hub` component, which has been removed due to a complaint by Insteon. +

From 0830ceb91e0a5c0046487783100131e1bbd64d87 Mon Sep 17 00:00:00 2001 From: Jorim Tielemans Date: Mon, 23 Jul 2018 15:45:42 +0200 Subject: [PATCH 12/24] Update insteon_local.markdown --- source/_components/insteon_local.markdown | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/source/_components/insteon_local.markdown b/source/_components/insteon_local.markdown index cd76a7d7b20..b4b534aabd9 100644 --- a/source/_components/insteon_local.markdown +++ b/source/_components/insteon_local.markdown @@ -28,8 +28,6 @@ insteon_local: password: YOUR_HUB_PASSWORD ``` -*Note: The username and password here are for the hub and are different than the ones used to access the app. You can usually find these on the bottom of your hub (unless you've changed them through the settings in the app)* - {% configuration %} host: description: The IP address of your hub. @@ -55,6 +53,8 @@ port: default: 25105 {% endconfiguration %} +*Note: The username and password here are for the hub and are different than the ones used to access the app. You can usually find these on the bottom of your hub (unless you've changed them through the settings in the app)* + The `insteon_local` component currently supports lights (dimmers), switches and fans.

From 69554db4d42d8fea0796612fc2280123b7f67595 Mon Sep 17 00:00:00 2001 From: Jorim Tielemans Date: Mon, 23 Jul 2018 15:47:55 +0200 Subject: [PATCH 13/24] Update switch.insteon_local.markdown Fix ha_release tag --- source/_components/switch.insteon_local.markdown | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/source/_components/switch.insteon_local.markdown b/source/_components/switch.insteon_local.markdown index fad626ca1a3..d465cae2fe5 100644 --- a/source/_components/switch.insteon_local.markdown +++ b/source/_components/switch.insteon_local.markdown @@ -9,7 +9,7 @@ sharing: true footer: true logo: insteon.png ha_category: Switch -ha_version: 0.36 +ha_release: 0.36 --- The `insteon_local` switch component lets you control your switches connected to an [Insteon Hub](http://www.insteon.com/insteon-hub/) with Home Assistant. From 812ace1c9a51555e613d6e0aea6c764bb2ec6223 Mon Sep 17 00:00:00 2001 From: Jorim Tielemans Date: Mon, 23 Jul 2018 15:48:13 +0200 Subject: [PATCH 14/24] Update light.insteon_local.markdown Fix ha_release tag --- source/_components/light.insteon_local.markdown | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/source/_components/light.insteon_local.markdown b/source/_components/light.insteon_local.markdown index 21a960f75fa..ec497ca75df 100644 --- a/source/_components/light.insteon_local.markdown +++ b/source/_components/light.insteon_local.markdown @@ -9,7 +9,7 @@ sharing: true footer: true logo: insteon.png ha_category: Light -ha_version: 0.36 +ha_release: 0.36 ha_iot_class: "Local Push" redirect_from: /components/light.insteon_hub/ --- From edf85f3acb6ac098ed3fb6ebca65a4cadab272af Mon Sep 17 00:00:00 2001 From: Jorim Tielemans Date: Mon, 23 Jul 2018 15:48:57 +0200 Subject: [PATCH 15/24] Update fan.insteon_local.markdown Fix ha_release tag --- source/_components/fan.insteon_local.markdown | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/source/_components/fan.insteon_local.markdown b/source/_components/fan.insteon_local.markdown index 7b77c7f15ac..69a2249ff9a 100644 --- a/source/_components/fan.insteon_local.markdown +++ b/source/_components/fan.insteon_local.markdown @@ -9,7 +9,7 @@ sharing: true footer: true logo: insteon.png ha_category: Fan -ha_version: 0.48 +ha_release: 0.48 redirect_from: /components/fan.insteon_hub/ --- From 8dcb1445b402383d51d2e9add543805d97498dbc Mon Sep 17 00:00:00 2001 From: Jorim Tielemans Date: Mon, 23 Jul 2018 17:14:25 +0200 Subject: [PATCH 16/24] Update switch.insteon_plm.markdown --- source/_components/switch.insteon_plm.markdown | 10 ++-------- 1 file changed, 2 insertions(+), 8 deletions(-) diff --git a/source/_components/switch.insteon_plm.markdown b/source/_components/switch.insteon_plm.markdown index 8843679bb01..39f7d1235dc 100644 --- a/source/_components/switch.insteon_plm.markdown +++ b/source/_components/switch.insteon_plm.markdown @@ -10,13 +10,7 @@ footer: true logo: insteon.png ha_category: Switch ha_iot_class: "Local Push" -ha_version: 0.39 +ha_release: 0.39 --- -The `insteon_plm` switch platform lets you control your on/off switches through -an INSTEON PowerLinc Modem (PLM) device connected directly to your system on a -USB or serial port. To add support, set up the primary [insteon_plm] -component. - -[insteon_plm]: /components/insteon_plm/ - +The `insteon_plm` switch platform lets you control your on/off switches through an INSTEON PowerLinc Modem (PLM) device connected directly to your system on a USB or serial port. To add support, set up the primary [insteon_plm](/components/insteon_plm/) component. From 4fd8ba14ce270fcc85b5c255c3da39f9abb6368f Mon Sep 17 00:00:00 2001 From: Jorim Tielemans Date: Mon, 23 Jul 2018 17:14:51 +0200 Subject: [PATCH 17/24] Update light.insteon_local.markdown --- source/_components/light.insteon_local.markdown | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/source/_components/light.insteon_local.markdown b/source/_components/light.insteon_local.markdown index ec497ca75df..818e450eb90 100644 --- a/source/_components/light.insteon_local.markdown +++ b/source/_components/light.insteon_local.markdown @@ -9,11 +9,11 @@ sharing: true footer: true logo: insteon.png ha_category: Light -ha_release: 0.36 ha_iot_class: "Local Push" +ha_release: 0.36 redirect_from: /components/light.insteon_hub/ --- The `insteon_local` light component lets you control your lights connected to an [Insteon Hub](http://www.insteon.com/insteon-hub/) with Home Assistant. -To get your Insteon lights working with Home Assistant, follow the instructions for the general [Insteon local component](/components/insteon_local/). The lights will be automatically discovered and added to Home Assistant. The device names will be the Insteon address of the lights. +To get your Insteon lights working with Home Assistant, follow the instructions for the general [Insteon local component] (/components/insteon_local/). The lights will be automatically discovered and added to Home Assistant. The device names will be the Insteon address of the lights. From c88cdbea455880607b67e2af71c1b71711c9a1dc Mon Sep 17 00:00:00 2001 From: Jorim Tielemans Date: Mon, 23 Jul 2018 17:15:12 +0200 Subject: [PATCH 18/24] Update light.insteon_plm.markdown --- source/_components/light.insteon_plm.markdown | 5 ++--- 1 file changed, 2 insertions(+), 3 deletions(-) diff --git a/source/_components/light.insteon_plm.markdown b/source/_components/light.insteon_plm.markdown index 65026cf5761..40561bdd914 100644 --- a/source/_components/light.insteon_plm.markdown +++ b/source/_components/light.insteon_plm.markdown @@ -1,7 +1,7 @@ --- layout: page title: "Insteon PLM Light" -description: "Instructions on how to setup Insteon PLM lights locally within Home Assistant." +description: "Instructions on how to setup the Insteon PLM Lights locally within Home Assistant." date: 2017-02-19 17:00 sidebar: true comments: false @@ -10,8 +10,7 @@ footer: true logo: insteon.png ha_category: Light ha_iot_class: "Local Push" -ha_version: 0.39 +ha_release: 0.39 --- The `insteon_plm` light platform lets you control your dimmable light switches through an INSTEON PowerLinc Modem (PLM) device connected directly to your system on an USB or serial port. To add support, set up the primary [insteon_plm](/components/insteon_plm/) component. - From 28aa44fb2b63ba23f28919962daaa9f01aacb988 Mon Sep 17 00:00:00 2001 From: Jorim Tielemans Date: Mon, 23 Jul 2018 17:15:37 +0200 Subject: [PATCH 19/24] Update fan.insteon_plm.markdown --- source/_components/fan.insteon_plm.markdown | 14 +++----------- 1 file changed, 3 insertions(+), 11 deletions(-) diff --git a/source/_components/fan.insteon_plm.markdown b/source/_components/fan.insteon_plm.markdown index 3f2323e16eb..0c4478778e3 100644 --- a/source/_components/fan.insteon_plm.markdown +++ b/source/_components/fan.insteon_plm.markdown @@ -1,7 +1,7 @@ --- layout: page title: "Insteon PLM Fan" -description: "Instructions on how to setup the Insteon PLM fan locally within Home Assistant." +description: "Instructions on how to setup the Insteon PLM Fans locally within Home Assistant." date: 2017-02-19 17:00 sidebar: true comments: false @@ -10,15 +10,7 @@ footer: true logo: insteon.png ha_category: Fan ha_iot_class: "Local Push" -ha_version: 0.65 +ha_release: 0.65 --- -The `insteon_plm` fan platform lets you control your [FanLinc] through -an INSTEON PowerLinc Modem (PLM) device connected directly to your system on a -USB or serial port. To add support, set up the primary [insteon_plm] -component. - -[insteon_plm]: /components/insteon_plm/ -[FanLinc]: https://www.smarthome.com/fanlinc-insteon-2475f-ceiling-fan-and-light-controller-fixture-module-dual-band.html - - +The `insteon_plm` fan platform lets you control your [FanLinc](https://www.smarthome.com/fanlinc-insteon-2475f-ceiling-fan-and-light-controller-fixture-module-dual-band.html) through an INSTEON PowerLinc Modem (PLM) device connected directly to your system on a USB or serial port. To add support, set up the primary [insteon_plm](/components/insteon_plm/) component. From ada186a6a6540e0c0a2caf0ce0dda567f0ffd917 Mon Sep 17 00:00:00 2001 From: Jorim Tielemans Date: Mon, 23 Jul 2018 17:15:51 +0200 Subject: [PATCH 20/24] Update sensor.insteon_plm.markdown --- source/_components/sensor.insteon_plm.markdown | 10 ++-------- 1 file changed, 2 insertions(+), 8 deletions(-) diff --git a/source/_components/sensor.insteon_plm.markdown b/source/_components/sensor.insteon_plm.markdown index 1974ea95404..d394cd05d82 100644 --- a/source/_components/sensor.insteon_plm.markdown +++ b/source/_components/sensor.insteon_plm.markdown @@ -10,13 +10,7 @@ footer: true logo: insteon.png ha_category: Sensor ha_iot_class: "Local Push" -ha_version: 0.65 +ha_release: 0.65 --- -The `insteon_plm` sensor platform lets you control your sensors through -an INSTEON PowerLinc Modem (PLM) device connected directly to your system on a -USB or serial port. To add support, set up the primary [insteon_plm] -component. - -[insteon_plm]: /components/insteon_plm/ - +The `insteon_plm` sensor platform lets you control your sensors through an INSTEON PowerLinc Modem (PLM) device connected directly to your system on a USB or serial port. To add support, set up the primary [insteon_plm](/components/insteon_plm/) component. From 51e35bdcb6ad03837e1417df7e43841b119dc83e Mon Sep 17 00:00:00 2001 From: Jorim Tielemans Date: Mon, 23 Jul 2018 17:15:54 +0200 Subject: [PATCH 21/24] Update binary_sensor.insteon_plm.markdown --- source/_components/binary_sensor.insteon_plm.markdown | 10 ++-------- 1 file changed, 2 insertions(+), 8 deletions(-) diff --git a/source/_components/binary_sensor.insteon_plm.markdown b/source/_components/binary_sensor.insteon_plm.markdown index d06c324a442..27c0cf98082 100644 --- a/source/_components/binary_sensor.insteon_plm.markdown +++ b/source/_components/binary_sensor.insteon_plm.markdown @@ -10,13 +10,7 @@ footer: true logo: insteon.png ha_category: Binary Sensor ha_iot_class: "Local Push" -ha_version: 0.39 +ha_release: 0.39 --- -The `insteon_plm` binary sensor platform lets you control your sensors through -an INSTEON PowerLinc Modem (PLM) device connected directly to your system on a -USB or serial port. To add support, set up the primary [insteon_plm] -component. - -[insteon_plm]: /components/insteon_plm/ - +The `insteon_plm` binary sensor platform lets you control your sensors through an INSTEON PowerLinc Modem (PLM) device connected directly to your system on a USB or serial port. To add support, set up the primary [insteon_plm](/components/insteon_plm/) component. From 6fe6a9ce5c8e1124e42465c3ab0210e234d410c0 Mon Sep 17 00:00:00 2001 From: Jorim Tielemans Date: Mon, 23 Jul 2018 23:20:23 +0200 Subject: [PATCH 22/24] Update insteon_plm.markdown --- source/_components/insteon_plm.markdown | 163 ++++++++++-------------- 1 file changed, 67 insertions(+), 96 deletions(-) diff --git a/source/_components/insteon_plm.markdown b/source/_components/insteon_plm.markdown index fff18634a17..b125d86a676 100644 --- a/source/_components/insteon_plm.markdown +++ b/source/_components/insteon_plm.markdown @@ -10,22 +10,17 @@ footer: true logo: insteon.png ha_category: Hub ha_iot_class: "Local Push" -ha_version: 0.39 +ha_release: 0.39 --- -This component adds "local push" support for INSTEON PowerLinc Modems allowing -linked INSTEON devices to be used within Home Assistant as lights, switches, -and binary sensors. Device support is provided by the underlying [insteonplm] -package. It is known to work with the [2413U] USB and [2412S] RS242 flavors -of PLM and the [2448A7] USB stick. This component does not work with the -IP-based hub products. For that, you'll want the "Insteon (Local)" component -instead. +This component adds "local push" support for INSTEON PowerLinc Modems allowing linked INSTEON devices to be used within Home Assistant as lights, switches, and binary sensors. Device support is provided by the underlying [insteonplm] package. It is known to work with the [2413U] USB and [2412S] RS242 flavors of PLM and the [2448A7] USB stick. This component does not work with the IP-based hub products. For that, you'll want the [Insteon local component](/components/insteon_local/) instead. [insteonplm]: https://github.com/nugget/python-insteonplm [2413U]: https://www.insteon.com/powerlinc-modem-usb [2412S]: https://www.insteon.com/powerlinc-modem-serial [2448A7]: https://www.smarthome.com/insteon-2448a7-portable-usb-adapter.html +## {% linkable_title Configuration %} ```yaml # insteon_plm supported configuration variables @@ -46,78 +41,73 @@ insteon_plm: x10_all_lights_on: HOUSECODE x10_all_lights_off: HOUSECODE ``` -Configuration variables: -- **port** (*Required*): The port for your device, e.g., `/dev/ttyUSB0` -- **device_override** (*Optional*): Override the default device definition - - *ADDRESS* is found on the device itself in the form 1A.2B.3C or 1a2b3c - - *CATEGORY* is found in the back of the device's User Guide in the form of - 0x00 - 0xff - - *SUBCATEGORY* is found in the back of the device's User Guide in the form - of 0x00 - 0xff - - *FIRMWARE* and *PRODUCT_KEY* are more advanced options and will typically - not be used. -- **x10_devices** (*Optional*): Define X10 devices to control or respond to - - *HOUSECODE* is the X10 housecode values a - p - - *UNITCODE* is the X10 unit code values 1 - 16 - - *PLATFORM* is the Home Assistant Platform to associate the device with. - The following platforms are supported - - binary_sensor: Used for on/off devices or keypad buttons that are read only. - - light: Used for dimmable X10 devices - - switch: Used for On/Off X10 devices - - *STEPS* is the number of dim/bright steps the device supports. Used for - dimmable X10 devices only. Default value is 22. -- **x10_all_units_off** (*Optional*): Creates an binary_sensor that responds - to the X10 standard command for All Units Off. -- **x10_all_lights_on** (*Optional*): Creates an binary_sensor that responds - to the X10 standard command for All Lights On -- **x10_all_lights_off** (*Optional*): Creates an binary_sensor that responds - to the X10 standard command for All Lights Off + +{% configuration %} +port: + description: The port for your device, e.g., `/dev/ttyUSB0` + required: true + type: string +device_override: + description: Override the default device definition + required: false + type: list + keys: + ADDRESS: + description: is found on the device itself in the form 1A.2B.3C or 1a2b3c + CATEGORY: + description: is found in the back of the device's User Guide in the form of 0x00 - 0xff + SUBCATEGORY: + description: is found in the back of the device's User Guide in the form of 0x00 - 0xff + FIRMWARE: + description: is a more advanced option and will typically not be used. + PRODUCT_KEY: + description: is a more advanced option and will typically not be used. +x10_devices: + description: Define X10 devices to control or respond to + required: false + type: map + keys: + HOUSECODE: + description: is the X10 housecode values a - p + UNITCODE: + description: is the X10 unit code values 1 - 16 + PLATFORM: + description: is the Home Assistant Platform to associate the device with. The following platforms are supported: + - binary_sensor: Used for on/off devices or keypad buttons that are read only. + - light: Used for dimmable X10 devices + - switch: Used for On/Off X10 devices + STEPS: + description: is the number of dim/bright steps the device supports. Used for dimmable X10 devices only. + default: 22 +x10_all_units_off: + description: Creates an binary_sensor that responds to the X10 standard command for All Units Off. + required: false +x10_all_lights_on: + description: Creates an binary_sensor that responds to the X10 standard command for All Lights On + required: false +x10_all_lights_off: + description: Creates an binary_sensor that responds to the X10 standard command for All Lights Off + required: false +{% endconfiguration %} ### {% linkable_title Autodiscovery %} -The first time autodiscovery runs, the duration may require up to 20 seconds -per device. Subsequent startups will occur much quicker using cached device -information. If a device is not recognized during autodiscovery, you can add -the device to the **device_override** configuration. +The first time autodiscovery runs, the duration may require up to 20 seconds per device. Subsequent startups will occur much quicker using cached device information. If a device is not recognized during autodiscovery, you can add the device to the **device_override** configuration. -In order for a device to be discovered it must be linked to the PLM as either -a responder or a controller. +In order for a device to be discovered it must be linked to the PLM as either a responder or a controller. ### {% linkable_title Linking Devices to the PLM %} -In order for any two Insteon devices to talk with one another, they must be -linked. For an overview of device linking please read the Insteon page on -[understanding linking]. The Insteon PLM module supports All-Linking through -[Development Tools] service calls. The following services are available: +In order for any two Insteon devices to talk with one another, they must be linked. For an overview of device linking, please read the Insteon page on [understanding linking]. The Insteon PLM module supports All-Linking through [Development Tools] service calls. The following services are available: -In order for any two Insteon devices to talk with one another, they must be -linked. For an overview of device linking, please read the Insteon page on -[understanding linking]. The Insteon PLM module supports All-Linking through -[Development Tools] service calls. The following services are available: -- **insteon_plm.add_all_link**: Tells the Insteon Modem (IM) start All-Linking -mode. Once the IM is in All-Linking mode, press the link button on the device -to complete All-Linking. -- **insteon_plm.delete_all_link**: Tells the Insteon Modem (IM) to remove an -All-Link record from the All-Link Database of the IM and a device. Once the IM -is set to delete the link, press the link button on the corresponding device -to complete the process. -- **insteon_plm.load_all_link_database**: Load the All-Link Database for a -device. WARNING - Loading a device All-Link database is very time consuming -and inconsistent. This may take a LONG time and may need to be repeated to -obtain all records. -- **insteon_plm.print_all_link_database**: Print the All-Link Database for a -device. Requires that the All-Link Database is loaded into memory. -- **insteon_plm.print_im_all_link_database**: Print the All-Link Database for -the INSTEON Modem (IM). +- **insteon_plm.add_all_link**: Tells the Insteon Modem (IM) start All-Linking mode. Once the IM is in All-Linking mode, press the link button on the device to complete All-Linking. +- **insteon_plm.delete_all_link**: Tells the Insteon Modem (IM) to remove an All-Link record from the All-Link Database of the IM and a device. Once the IM is set to delete the link, press the link button on the corresponding device to complete the process. +- **insteon_plm.load_all_link_database**: Load the All-Link Database for a device. WARNING - Loading a device All-Link database is very time consuming and inconsistent. This may take a LONG time and may need to be repeated to obtain all records. +- **insteon_plm.print_all_link_database**: Print the All-Link Database for a device. Requires that the All-Link Database is loaded into memory. +- **insteon_plm.print_im_all_link_database**: Print the All-Link Database for the INSTEON Modem (IM). -If you are looking for more advanced options, you can use the -[insteonplm_interactive] command line tool that is distributed with the -[insteonplm] Python module. Please see the documentation on the [insteonplm] -GitHub site. Alternatively, you can download [HouseLinc] which runs on any -Windows PC, or you can use [Insteon Terminal] which is open source and runs -on most platforms. SmartHome no longer supports HouseLinc, but it still -works. Insteon Terminal is a very useful tool but please read the disclaimers -carefully, they are important. +If you are looking for more advanced options, you can use the [insteonplm_interactive] command line tool that is distributed with the +[insteonplm] Python module. Please see the documentation on the [insteonplm] GitHub site. Alternatively, you can download [HouseLinc] which runs on any Windows PC, or you can use [Insteon Terminal] which is open source and runs on most platforms. SmartHome no longer supports HouseLinc, but it still works. Insteon Terminal is a very useful tool but please read the disclaimers carefully, they are important. [understanding linking]: http://www.insteon.com/support-knowledgebase/2015/1/28/understanding-linking [Development Tools]: https://www.home-assistant.io/docs/tools/dev-tools/ @@ -127,31 +117,15 @@ carefully, they are important. ### {% linkable_title Customization %} -The only configuration item that is absolutely necessary is the port so that -Home Assistant can connect to the PLM. This will expose all the supported -INSTEON devices which exist in the modem’s ALL-Link database. However, devices -will only be shown by their INSTEON hex address (e.g., “1A.2B.3C”) which can -be a bit unwieldy. As you link and unlink devices using the ‘Set’ buttons, -they’ll be added and removed from Home Assistant automatically. +The only configuration item that is absolutely necessary is the port so that Home Assistant can connect to the PLM. This will expose all the supported INSTEON devices which exist in the modem’s ALL-Link database. However, devices will only be shown by their INSTEON hex address (e.g., “1A.2B.3C”) which can be a bit unwieldy. As you link and unlink devices using the ‘Set’ buttons, they’ll be added and removed from Home Assistant automatically. -You can use the normal Home Assistant [device customization] section of your -configuration to assign friendly names and special icons to your devices. This -is especially useful for setting device_class on your binary_sensor INSTEON -devices. - -[device customization]: /getting-started/customizing-devices/ +You can use the normal Home Assistant [device customization](/getting-started/customizing-devices/) section of your configuration to assign friendly names and special icons to your devices. This is especially useful for setting device_class on your binary_sensor INSTEON devices. ### {% linkable_title Device Overrides %} -INSTEON devices are added to Home Assistant using the platform(s) that make the -most sense given the model and features of the hardware. The features of the -INSTEON device are built into the Home Assistant platform. Changing the -platform is not recommended. There are two primary uses for the -**device_override** feature. -- Devices that do not respond during autodiscovery. This is common for battery - operated devices. -- Devices that have not been fully developed. This allows an unknown device to - be mapped to a device that operates similarly to another device. +INSTEON devices are added to Home Assistant using the platform(s) that make the most sense given the model and features of the hardware. The features of the INSTEON device are built into the Home Assistant platform. Changing the platform is not recommended. There are two primary uses for the **device_override** feature. +- Devices that do not respond during autodiscovery. This is common for battery operated devices. +- Devices that have not been fully developed. This allows an unknown device to be mapped to a device that operates similarly to another device. ### {% linkable_title Example Configuration with Options%} @@ -176,10 +150,7 @@ insteon_plm: ### {% linkable_title What NOT to do %} -Insteon PLM is a top level component and device discovery will identify -the Home Assistant platform the device belongs in. As such, do not -declare Insteon devices in other platforms. For example, this configuration -will NOT work: +Insteon PLM is a top level component and device discovery will identify the Home Assistant platform the device belongs in. As such, do not declare Insteon devices in other platforms. For example, this configuration will NOT work: ```yaml light: From 86b8e1ad73e79e71acaed2537f84ac5b40d56077 Mon Sep 17 00:00:00 2001 From: Jorim Tielemans Date: Mon, 23 Jul 2018 23:34:43 +0200 Subject: [PATCH 23/24] Update insteon_plm.markdown --- source/_components/insteon_plm.markdown | 13 +++++++++---- 1 file changed, 9 insertions(+), 4 deletions(-) diff --git a/source/_components/insteon_plm.markdown b/source/_components/insteon_plm.markdown index b125d86a676..33f777579e5 100644 --- a/source/_components/insteon_plm.markdown +++ b/source/_components/insteon_plm.markdown @@ -65,7 +65,7 @@ device_override: x10_devices: description: Define X10 devices to control or respond to required: false - type: map + type: list keys: HOUSECODE: description: is the X10 housecode values a - p @@ -73,9 +73,14 @@ x10_devices: description: is the X10 unit code values 1 - 16 PLATFORM: description: is the Home Assistant Platform to associate the device with. The following platforms are supported: - - binary_sensor: Used for on/off devices or keypad buttons that are read only. - - light: Used for dimmable X10 devices - - switch: Used for On/Off X10 devices + type: string + keys: + binary_sensor: + description: Used for on/off devices or keypad buttons that are read only. + light: + description: Used for dimmable X10 devices + switch: + description: Used for On/Off X10 devices STEPS: description: is the number of dim/bright steps the device supports. Used for dimmable X10 devices only. default: 22 From 7f82629c7870c2ca2261281f94168e66e2d4939c Mon Sep 17 00:00:00 2001 From: Jorim Tielemans Date: Mon, 23 Jul 2018 23:47:41 +0200 Subject: [PATCH 24/24] Update insteon_plm.markdown --- source/_components/insteon_plm.markdown | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/source/_components/insteon_plm.markdown b/source/_components/insteon_plm.markdown index 33f777579e5..f22cd2b623d 100644 --- a/source/_components/insteon_plm.markdown +++ b/source/_components/insteon_plm.markdown @@ -72,7 +72,7 @@ x10_devices: UNITCODE: description: is the X10 unit code values 1 - 16 PLATFORM: - description: is the Home Assistant Platform to associate the device with. The following platforms are supported: + description: is the Home Assistant Platform to associate the device with. Choose one of the following supported platforms. type: string keys: binary_sensor: