From 8a515198af926befac2f633a7fcb97258113e35e Mon Sep 17 00:00:00 2001 From: Tom Harris Date: Mon, 23 Apr 2018 23:41:24 -0400 Subject: [PATCH 1/5] Describe the new services added --- source/_components/insteon_plm.markdown | 47 +++++++++++++++++++------ 1 file changed, 36 insertions(+), 11 deletions(-) diff --git a/source/_components/insteon_plm.markdown b/source/_components/insteon_plm.markdown index 58a1bad12cce..60b6e06167a3 100644 --- a/source/_components/insteon_plm.markdown +++ b/source/_components/insteon_plm.markdown @@ -1,7 +1,7 @@ --- layout: page title: "Insteon PLM" -description: "Instructions on how to setup an Insteon USB PLM locally within Home Assistant." +description: "Instructions how to setup an Insteon USB PLM locally within Home Assistant." date: 2017-02-19 16:00 sidebar: true comments: false @@ -39,7 +39,7 @@ insteon_plm: product_key: PRODUCT_KEY ``` Configuration variables: -- **port** (*Required*): The port for your device, e.g., `/dev/ttyUSB0` +- **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 @@ -63,24 +63,50 @@ a responder or a controller. 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]. Currently Insteon PLM does not support software -linking of devices. If you need software that can link your devices (if you -are using a USB Stick PLM for example), 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. HouseLinc is no longer supported by SmartHome but it -still works. Insteon Terminal is a very useful tool but please read the -disclaimers carefully, they are important. +[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 Insteom 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 inconsistant. 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. HouseLinc is no longer supported by SmartHome 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/ [HouseLinc]: https://www.smarthome.com/houselinc.html [Insteon Terminal]: https://github.com/pfrommerd/insteon-terminal +[insteonplm_interactive]: https://github.com/nugget/python-insteonplm#command-line-interface ### {% 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 +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. @@ -134,4 +160,3 @@ light: - platform: insteon_plm address: 1a2b3c ``` - From 65abc5ef497a87194e20de9f3857f9d76dc6f060 Mon Sep 17 00:00:00 2001 From: Tom Harris Date: Tue, 24 Apr 2018 17:23:54 -0400 Subject: [PATCH 2/5] Edits per review --- source/_components/insteon_plm.markdown | 26 ++++++++++++------------- 1 file changed, 13 insertions(+), 13 deletions(-) diff --git a/source/_components/insteon_plm.markdown b/source/_components/insteon_plm.markdown index 60b6e06167a3..e7ebb92bb682 100644 --- a/source/_components/insteon_plm.markdown +++ b/source/_components/insteon_plm.markdown @@ -1,7 +1,7 @@ --- layout: page title: "Insteon PLM" -description: "Instructions how to setup an Insteon USB PLM locally within Home Assistant." +description: "Instructions on how to setup an Insteon USB PLM locally within Home Assistant." date: 2017-02-19 16:00 sidebar: true comments: false @@ -39,7 +39,7 @@ insteon_plm: product_key: PRODUCT_KEY ``` Configuration variables: -- **port** (*Required*): The port for your device, e.g. `/dev/ttyUSB0` +- **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 @@ -67,10 +67,10 @@ linked. For an overview of device linking please read the Insteon page on [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 +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 Insteom Modem (IM) start All-Linking +- **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 @@ -78,8 +78,8 @@ 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 inconsistant. This may take a LONG time and may need to be repeated to +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. @@ -91,7 +91,7 @@ If you are looking for more advanced options, you can use 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. HouseLinc is no longer supported by SmartHome but it still +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. @@ -103,12 +103,12 @@ 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 modems 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, +theyll 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 From f167121ca66d540d2918b3cfe6a13ebf9a48ad5f Mon Sep 17 00:00:00 2001 From: Tom Harris Date: Sat, 5 May 2018 13:24:50 -0400 Subject: [PATCH 3/5] UTF-8 error --- 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 e7ebb92bb682..82065f4eca6c 100644 --- a/source/_components/insteon_plm.markdown +++ b/source/_components/insteon_plm.markdown @@ -145,7 +145,7 @@ homeassistant: insteon_plm: port: /dev/ttyUSB0 device_override: - - address: a1b2c3 # Hidden Door Sensor [2845-222] + - address: a1b2c3 # Hidden Door Sensor cat: 0x10 subcat: 0x11 ``` From 4963c03977a35dfe8aff36d465d523b697542c8a Mon Sep 17 00:00:00 2001 From: Tom Harris Date: Sat, 5 May 2018 13:29:29 -0400 Subject: [PATCH 4/5] UTF-8 Error --- 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 82065f4eca6c..e7ebb92bb682 100644 --- a/source/_components/insteon_plm.markdown +++ b/source/_components/insteon_plm.markdown @@ -145,7 +145,7 @@ homeassistant: insteon_plm: port: /dev/ttyUSB0 device_override: - - address: a1b2c3 # Hidden Door Sensor + - address: a1b2c3 # Hidden Door Sensor [2845-222] cat: 0x10 subcat: 0x11 ``` From 3929974398b53a3f35edaa527c66f38b056429b6 Mon Sep 17 00:00:00 2001 From: Paulus Schoutsen Date: Sat, 5 May 2018 14:53:38 -0400 Subject: [PATCH 5/5] Convert to utf-8 --- source/_components/insteon_plm.markdown | 10 ++++++---- 1 file changed, 6 insertions(+), 4 deletions(-) diff --git a/source/_components/insteon_plm.markdown b/source/_components/insteon_plm.markdown index e7ebb92bb682..9e15bb0f7d06 100644 --- a/source/_components/insteon_plm.markdown +++ b/source/_components/insteon_plm.markdown @@ -105,10 +105,10 @@ carefully, they are important. 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 modems 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, -theyll be added and removed from Home Assistant automatically. +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 @@ -149,7 +149,9 @@ insteon_plm: cat: 0x10 subcat: 0x11 ``` + ### {% 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