Merge pull request #5852 from tjorim/patch-2

Improve documentation for Insteon components
This commit is contained in:
DubhAd 2018-07-24 18:48:15 +01:00 committed by GitHub
commit e8142b764f
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
13 changed files with 131 additions and 237 deletions

View File

@ -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.

View File

@ -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/).

View File

@ -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
@ -9,9 +9,10 @@ sharing: true
footer: true
logo: insteon.png
ha_category: Fan
ha_version: 0.48
ha_release: 0.48
redirect_from: /components/fan.insteon_hub/
---
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.

View File

@ -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.

View File

@ -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"
---
<p class='note warning'>
This component has been disabled due to a complaint by Insteon. It will be enabled again once <a href='https://github.com/home-assistant/home-assistant/issues/3811'>this issue</a> has been resolved.
</p>
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.

View File

@ -10,38 +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/
---
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:
## {% 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`.
{% 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 %}
### {% linkable_title Full configuration %}
*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.
```yaml
insteon_local:
host: YOUR HUB IP
username: YOUR HUB USERNAME
password: YOUR HUB PASSWORD
timeout: 10
port: 25105
```
<p class='note'>
This component replaces the old `insteon_hub` component, which has been removed due to a complaint by Insteon.
</p>

View File

@ -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,78 @@ 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: list
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. Choose one of the following supported platforms.
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
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 +122,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 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.
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
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 +155,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:

View File

@ -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/).

View File

@ -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
@ -9,10 +9,11 @@ sharing: true
footer: true
logo: insteon.png
ha_category: Light
ha_version: 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 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.

View File

@ -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.

View File

@ -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.

View File

@ -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
@ -9,9 +9,9 @@ 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.
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.

View File

@ -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.