mirror of
https://github.com/home-assistant/home-assistant.io.git
synced 2025-07-14 12:56:54 +00:00
Insteon merge (#6057)
* Add X10 support * insteon_plm binary_sensor on event * revert * Add binary_sensor_on event information * Describe events for Mini-Remotes * Remove blank line * Update for Hub connections * Merge insteon_plm and insteon_local into insteon * Revert GEM changes * Revert Gem changes
This commit is contained in:
Tom Harris
Paulus Schoutsen
parent
f3e0efcf79
commit
0817f273ba
21
source/_components/binary_sensor.insteon.markdown
Normal file
21
source/_components/binary_sensor.insteon.markdown
Normal file
@ -0,0 +1,21 @@
|
||||
---
|
||||
layout: page
|
||||
title: "Insteon Binary Sensor"
|
||||
description: "Instructions on how to setup the Insteon binary sensors locally within Home Assistant."
|
||||
date: 2018-08-20 16:00
|
||||
sidebar: true
|
||||
comments: false
|
||||
sharing: true
|
||||
footer: true
|
||||
logo: insteon.png
|
||||
ha_category: Binary Sensor
|
||||
ha_iot_class: "Local Push"
|
||||
ha_version: 0.77
|
||||
---
|
||||
|
||||
The `insteon` binary sensor platform lets you control your sensors through
|
||||
an INSTEON Modem (PLM and Hub) device connected directly to your system on a
|
||||
USB, serial port or TCPIP connection. To add support, set up the primary
|
||||
[insteon] component.
|
||||
|
||||
[insteon]: /components/insteon/
|
||||
@ -1,21 +0,0 @@
|
||||
---
|
||||
layout: page
|
||||
title: "Insteon PLM Binary Sensor"
|
||||
description: "Instructions on how to setup the Insteon PLM binary sensors locally within Home Assistant."
|
||||
date: 2017-02-19 17:00
|
||||
sidebar: true
|
||||
comments: false
|
||||
sharing: true
|
||||
footer: true
|
||||
logo: insteon.png
|
||||
ha_category: Binary Sensor
|
||||
ha_iot_class: "Local Push"
|
||||
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/
|
||||
24
source/_components/fan.insteon.markdown
Normal file
24
source/_components/fan.insteon.markdown
Normal file
@ -0,0 +1,24 @@
|
||||
---
|
||||
layout: page
|
||||
title: "Insteon Fan"
|
||||
description: "Instructions on how to setup the Insteon fan locally within Home Assistant."
|
||||
date: 2018-08-20 16:00
|
||||
sidebar: true
|
||||
comments: false
|
||||
sharing: true
|
||||
footer: true
|
||||
logo: insteon.png
|
||||
ha_category: Fan
|
||||
ha_iot_class: "Local Push"
|
||||
ha_version: 0.77
|
||||
---
|
||||
|
||||
The `insteon` fan platform lets you control your [FanLinc] through
|
||||
an INSTEON Modem (PLM and Hub) device connected directly to your system on a
|
||||
USB, serial port or TCPIP connection. To add support, set up the primary
|
||||
[insteon] component.
|
||||
|
||||
[insteon]: /components/insteon/
|
||||
[FanLinc]: https://www.smarthome.com/fanlinc-insteon-2475f-ceiling-fan-and-light-controller-fixture-module-dual-band.html
|
||||
|
||||
|
||||
@ -1,18 +0,0 @@
|
||||
---
|
||||
layout: page
|
||||
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
|
||||
comments: false
|
||||
sharing: true
|
||||
footer: true
|
||||
logo: insteon.png
|
||||
ha_category: Fan
|
||||
ha_release: 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.
|
||||
|
||||
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.
|
||||
@ -1,16 +0,0 @@
|
||||
---
|
||||
layout: page
|
||||
title: "Insteon PLM Fan"
|
||||
description: "Instructions on how to setup the Insteon PLM Fans locally within Home Assistant."
|
||||
date: 2017-02-19 17:00
|
||||
sidebar: true
|
||||
comments: false
|
||||
sharing: true
|
||||
footer: true
|
||||
logo: insteon.png
|
||||
ha_category: Fan
|
||||
ha_iot_class: "Local Push"
|
||||
ha_release: 0.65
|
||||
---
|
||||
|
||||
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.
|
||||
288
source/_components/insteon.markdown
Normal file
288
source/_components/insteon.markdown
Normal file
@ -0,0 +1,288 @@
|
||||
---
|
||||
layout: page
|
||||
title: "Insteon"
|
||||
description: "Instructions on how to setup an Insteon Modem (PLM or Hub) locally within Home Assistant."
|
||||
date: 2018-08-20 16:00
|
||||
sidebar: true
|
||||
comments: false
|
||||
sharing: true
|
||||
footer: true
|
||||
logo: insteon.png
|
||||
ha_category: Hub
|
||||
ha_iot_class: "Local Push"
|
||||
ha_version: 0.77
|
||||
---
|
||||
|
||||
This component adds "local push" support for INSTEON Modems allowing
|
||||
linked INSTEON devices to be used within Home Assistant as binary sensors,
|
||||
lights, fans, sensors and switches. 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. It has also been
|
||||
tested to work with the [2245] Hub.
|
||||
|
||||
[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
|
||||
[2245]: https://www.insteon.com/insteon-hub/
|
||||
|
||||
|
||||
### {% linkable_title INSTEON Modem configuration %}
|
||||
|
||||
To setup a Powerline Modem (PLM) device such as the [2413U], use the following
|
||||
configuration:
|
||||
|
||||
```yaml
|
||||
# PLM configuration variables
|
||||
insteon:
|
||||
port: SERIAL_PORT
|
||||
```
|
||||
|
||||
To setup an INSTEON Hub such as the [2245], use the following configuration:
|
||||
|
||||
```yaml
|
||||
# Hub configuration variables
|
||||
insteon:
|
||||
host: HOST
|
||||
ip_port: IP_PORT
|
||||
username: USERNAME
|
||||
password: PASSWORD
|
||||
```
|
||||
|
||||
Addtional configuration items are available:
|
||||
|
||||
```yaml
|
||||
insteon:
|
||||
<PLM or Hub configruation>
|
||||
device_override:
|
||||
- address: ADDRESS
|
||||
cat: CATEGORY
|
||||
subcat: SUBCATEGORY
|
||||
firmware: FIRMWARE
|
||||
product_key: PRODUCT_KEY
|
||||
x10_devices:
|
||||
- housecode: HOUSECODE
|
||||
unitcode: UNITCODE
|
||||
platform: PLATFORM
|
||||
steps: STEPS
|
||||
x10_all_units_off: HOUSECODE
|
||||
x10_all_lights_on: HOUSECODE
|
||||
x10_all_lights_off: HOUSECODE
|
||||
```
|
||||
Configuration variables:
|
||||
- **port** (*Required for PLM setup*): The serial or USB port for your device,
|
||||
e.g., `/dev/ttyUSB0`
|
||||
- **host** (*Required for Hub setup*): The host name or IP address of the Hub
|
||||
- **ip_port** (*Optional for Hub setup*): The IP port number of the Hub.
|
||||
(default value is 25105)
|
||||
- **username** (*Required for Hub setup*): The username to login to the local
|
||||
Hub
|
||||
- **password** (*Required for Hub setup*): The password to login to the local
|
||||
Hub
|
||||
- **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
|
||||
|
||||
### {% 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.
|
||||
|
||||
In order for a device to be discovered it must be linked to the INSTEON Modem
|
||||
as either a responder or a controller.
|
||||
|
||||
### {% linkable_title Linking Devices to the INSTEON Modem %}
|
||||
|
||||
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 Modem module supports All-Linking through
|
||||
[Development Tools] service calls. The following services are available:
|
||||
|
||||
- **insteon.add_all_link**: Puts the Insteon Modem (IM) into All-Linking
|
||||
mode. The IM can be set as as controller or a responder. If the IM is a
|
||||
controler, put the IM into linking mode then press the SET button on the
|
||||
device. If the IM is a responer, press the SET button on the device then
|
||||
put the IM into linking mode.
|
||||
- **insteon.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 SET button on the corresponding device
|
||||
to complete the process.
|
||||
- **insteon.load_all_link_database**: Load the All-Link Database for a
|
||||
device. WARNING - Loading a device All-Link database may take a LONG time and
|
||||
may need to be repeated to obtain all records.
|
||||
- **insteon.print_all_link_database**: Print the All-Link Database for a
|
||||
device. Requires that the All-Link Database is loaded first.
|
||||
- **insteon.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.
|
||||
|
||||
[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 necessary is the PLM port or Hub IP
|
||||
address, username and password so that Home Assistant can connect to the
|
||||
INSTEON Modem. 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/
|
||||
|
||||
### {% 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.
|
||||
|
||||
### {% linkable_title Example Configuration with Options%}
|
||||
|
||||
```yaml
|
||||
# Full example of insteon configuration with customizations and overrides
|
||||
|
||||
homeassistant:
|
||||
customize:
|
||||
light.a1b2c3:
|
||||
friendly_name: Bedside Lamp
|
||||
binary_sensor.a2b3c4:
|
||||
friendly_name: Garage Door
|
||||
device_class: opening
|
||||
|
||||
insteon:
|
||||
port: /dev/ttyUSB0
|
||||
device_override:
|
||||
- address: a1b2c3 # Hidden Door Sensor [2845-222]
|
||||
cat: 0x10
|
||||
subcat: 0x11
|
||||
```
|
||||
|
||||
### {% linkable_title What NOT to do %}
|
||||
|
||||
Insteon Modem 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:
|
||||
- platform: insteon
|
||||
address: 1a2b3c
|
||||
```
|
||||
|
||||
### {% linkable_title Events and Mini-Remotes %}
|
||||
|
||||
Mini-Remote devices do not appear as Home Assistant entities. They generate
|
||||
events. The following events are available:
|
||||
|
||||
- **insteon.button_on**
|
||||
- **address**: (required) The Insteon device address in lower case without
|
||||
dots (e.g. 1a2b3c)
|
||||
- **button**: (Optional) The button id in lower case. For an 4 button remote
|
||||
the values are a to d. For an 8 button remote the values are a to g. For
|
||||
a one button remote this field is not used.
|
||||
- **insteon.button_of**
|
||||
- **address**: (required) The Insteon device address in lower case without
|
||||
dots (e.g. 1a2b3c)
|
||||
- **button**: (Optional) The button id in lower case. For an 4 button remote
|
||||
the values are a to d. For an 8 button remote the values are a to g. For
|
||||
a one button remote this field is not used.
|
||||
|
||||
This allows the mini-remotes to be configured as
|
||||
|
||||
Here is an example of how to use these events for automations:
|
||||
|
||||
```
|
||||
automation:
|
||||
# 4 or 8 button remote with button c pressed
|
||||
trigger:
|
||||
platform: event
|
||||
event_type: insteon.button_on
|
||||
event_data:
|
||||
address: 1a2b3c
|
||||
button: c
|
||||
condition:
|
||||
- condition: state
|
||||
entity_id: light.some_light
|
||||
state: 'off'
|
||||
action:
|
||||
service: light.turn_on
|
||||
entity_id: light.some_light
|
||||
|
||||
# single button remote
|
||||
trigger:
|
||||
platform: event
|
||||
event_type: insteon.button_on
|
||||
event_data:
|
||||
address: 1a2b3c
|
||||
condition:
|
||||
- condition: state
|
||||
entity_id: light.some_light
|
||||
state: 'off'
|
||||
action:
|
||||
service: light.turn_on
|
||||
entity_id: light.some_light
|
||||
```
|
||||
|
||||
### {% linkable_title Known Issues with the INSTEON Hub %}
|
||||
|
||||
The INSTEON Hub has three known issues that are inherent to the design of the
|
||||
Hub:
|
||||
|
||||
1. If you see multiple error messages in the log file stating the Hub
|
||||
connection is closed and reconnection has failed, this generally requires
|
||||
the Hub to be restarted in order to reconnect.
|
||||
|
||||
2. You cannot use both Home Assistant and the INSTEON app. If you do, the
|
||||
changes made in the app will not appear in Home Assistant. Changes made in
|
||||
Home Assistant will appear in the app after a period of time, however.
|
||||
|
||||
3. The Hub response times can be very slow. This is due to the Hub polling
|
||||
devices frequently. Since only one INSTEON message can be broadcast at a time,
|
||||
messages to and from Home Assistant can be delayed.
|
||||
@ -10,53 +10,9 @@ footer: true
|
||||
logo: insteon.png
|
||||
ha_category: Hub
|
||||
ha_iot_class: "Local Polling"
|
||||
ha_release: 0.36
|
||||
redirect_from: /components/insteon_hub/
|
||||
ha_version: 0.36
|
||||
---
|
||||
|
||||
The `insteon_local` component let you use your [Insteon Hub](http://www.insteon.com/insteon-hub/) with Home Assistant.
|
||||
The `insteon_local` component is depreciated and has been replaced by the [Insteon] component.
|
||||
|
||||
## {% 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
|
||||
```
|
||||
|
||||
{% 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 %}
|
||||
|
||||
*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.
|
||||
|
||||
<p class='note'>
|
||||
This component replaces the old `insteon_hub` component, which has been removed due to a complaint by Insteon.
|
||||
</p>
|
||||
[Insteon] /component/insteon
|
||||
|
||||
@ -10,209 +10,10 @@ footer: true
|
||||
logo: insteon.png
|
||||
ha_category: Hub
|
||||
ha_iot_class: "Local Push"
|
||||
ha_release: 0.39
|
||||
ha_version: 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](/components/insteon_local/) instead.
|
||||
The `insteon_plm` component is depreciated and has been replaced by the [Insteon] component.
|
||||
|
||||
[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
|
||||
[Insteon] /component/insteon
|
||||
|
||||
## {% linkable_title Configuration %}
|
||||
|
||||
```yaml
|
||||
# insteon_plm supported configuration variables
|
||||
insteon_plm:
|
||||
port: SERIAL_PORT
|
||||
device_override:
|
||||
- address: ADDRESS
|
||||
cat: CATEGORY
|
||||
subcat: SUBCATEGORY
|
||||
firmware: FIRMWARE
|
||||
product_key: PRODUCT_KEY
|
||||
x10_devices:
|
||||
- housecode: HOUSECODE
|
||||
unitcode: UNITCODE
|
||||
platform: PLATFORM
|
||||
steps: STEPS
|
||||
x10_all_units_off: HOUSECODE
|
||||
x10_all_lights_on: HOUSECODE
|
||||
x10_all_lights_off: HOUSECODE
|
||||
```
|
||||
|
||||
{% 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.
|
||||
|
||||
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:
|
||||
|
||||
- **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.
|
||||
|
||||
[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 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](/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.
|
||||
|
||||
### {% linkable_title Example Configuration with Options%}
|
||||
|
||||
```yaml
|
||||
# Full example of insteon_plm configuration with customizations and overrides
|
||||
|
||||
homeassistant:
|
||||
customize:
|
||||
light.a1b2c3:
|
||||
friendly_name: Bedside Lamp
|
||||
binary_sensor.a2b3c4:
|
||||
friendly_name: Garage Door
|
||||
device_class: opening
|
||||
|
||||
insteon_plm:
|
||||
port: /dev/ttyUSB0
|
||||
device_override:
|
||||
- address: a1b2c3 # Hidden Door Sensor [2845-222]
|
||||
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 will NOT work:
|
||||
|
||||
```yaml
|
||||
light:
|
||||
- platform: insteon_plm
|
||||
address: 1a2b3c
|
||||
```
|
||||
|
||||
### {% linkable_title Events and Mini-Remotes %}
|
||||
|
||||
Mini-Remote devices do not appear as Home Assistant entities. They generate
|
||||
events. The following events are available:
|
||||
|
||||
- **insteon_plm.button_on**
|
||||
- **address**: (required) The Insteon device address in lower case without
|
||||
dots (e.g. 1a2b3c)
|
||||
- **button**: (Optional) The button id in lower case. For an 4 button remote
|
||||
the values are a to d. For an 8 button remote the values are a to g. For
|
||||
a one button remote this field is not used.
|
||||
- **insteon_plm.button_of**
|
||||
- **address**: (required) The Insteon device address in lower case without
|
||||
dots (e.g. 1a2b3c)
|
||||
- **button**: (Optional) The button id in lower case. For an 4 button remote
|
||||
the values are a to d. For an 8 button remote the values are a to g. For
|
||||
a one button remote this field is not used.
|
||||
|
||||
This allows the mini-remotes to be configured as
|
||||
|
||||
Here is an example of how to use these events for automations:
|
||||
|
||||
```
|
||||
automation:
|
||||
# 4 or 8 button remote with button c pressed
|
||||
trigger:
|
||||
platform: event
|
||||
event_type: insteon_plm.button_on
|
||||
event_data:
|
||||
address: 1a2b3c
|
||||
button: c
|
||||
condition:
|
||||
- condition: state
|
||||
entity_id: light.some_light
|
||||
state: 'off'
|
||||
action:
|
||||
service: light.turn_on
|
||||
entity_id: light.some_light
|
||||
|
||||
# single button remote
|
||||
trigger:
|
||||
platform: event
|
||||
event_type: insteon_plm.button_on
|
||||
event_data:
|
||||
address: 1a2b3c
|
||||
condition:
|
||||
- condition: state
|
||||
entity_id: light.some_light
|
||||
state: 'off'
|
||||
action:
|
||||
service: light.turn_on
|
||||
entity_id: light.some_light
|
||||
```
|
||||
|
||||
21
source/_components/light.insteon.markdown
Normal file
21
source/_components/light.insteon.markdown
Normal file
@ -0,0 +1,21 @@
|
||||
---
|
||||
layout: page
|
||||
title: "Insteon Light"
|
||||
description: "Instructions on how to setup Insteon lights locally within Home Assistant."
|
||||
date: 2018-08-20 16:00
|
||||
sidebar: true
|
||||
comments: false
|
||||
sharing: true
|
||||
footer: true
|
||||
logo: insteon.png
|
||||
ha_category: Light
|
||||
ha_iot_class: "Local Push"
|
||||
ha_version: 0.77
|
||||
---
|
||||
|
||||
The `insteon` light platform lets you control your lights through
|
||||
an INSTEON Modem (PLM and Hub) device connected directly to your system on a
|
||||
USB, serial port or TCPIP connection. To add support, set up the primary
|
||||
[insteon] component.
|
||||
|
||||
[insteon]: /components/insteon/
|
||||
@ -1,19 +0,0 @@
|
||||
---
|
||||
layout: page
|
||||
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
|
||||
comments: false
|
||||
sharing: true
|
||||
footer: true
|
||||
logo: insteon.png
|
||||
ha_category: Light
|
||||
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.
|
||||
@ -1,16 +0,0 @@
|
||||
---
|
||||
layout: page
|
||||
title: "Insteon PLM Light"
|
||||
description: "Instructions on how to setup the Insteon PLM Lights locally within Home Assistant."
|
||||
date: 2017-02-19 17:00
|
||||
sidebar: true
|
||||
comments: false
|
||||
sharing: true
|
||||
footer: true
|
||||
logo: insteon.png
|
||||
ha_category: Light
|
||||
ha_iot_class: "Local Push"
|
||||
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.
|
||||
21
source/_components/sensor.insteon.markdown
Normal file
21
source/_components/sensor.insteon.markdown
Normal file
@ -0,0 +1,21 @@
|
||||
---
|
||||
layout: page
|
||||
title: "Insteon Sensor"
|
||||
description: "Instructions on how to setup the Insteon sensors locally within Home Assistant."
|
||||
date: 2018-08-20 16:00
|
||||
sidebar: true
|
||||
comments: false
|
||||
sharing: true
|
||||
footer: true
|
||||
logo: insteon.png
|
||||
ha_category: Sensor
|
||||
ha_iot_class: "Local Push"
|
||||
ha_version: 0.77
|
||||
---
|
||||
|
||||
The `insteon` sensor platform lets you control your sensors through
|
||||
an INSTEON Modem (PLM and Hub) device connected directly to your system on a
|
||||
USB, serial port or TCPIP connection. To add support, set up the primary
|
||||
[insteon] component.
|
||||
|
||||
[insteon]: /components/insteon/
|
||||
@ -1,16 +0,0 @@
|
||||
---
|
||||
layout: page
|
||||
title: "Insteon PLM Sensor"
|
||||
description: "Instructions on how to setup the Insteon PLM sensors locally within Home Assistant."
|
||||
date: 2017-02-19 17:00
|
||||
sidebar: true
|
||||
comments: false
|
||||
sharing: true
|
||||
footer: true
|
||||
logo: insteon.png
|
||||
ha_category: Sensor
|
||||
ha_iot_class: "Local Push"
|
||||
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](/components/insteon_plm/) component.
|
||||
21
source/_components/switch.insteon.markdown
Normal file
21
source/_components/switch.insteon.markdown
Normal file
@ -0,0 +1,21 @@
|
||||
---
|
||||
layout: page
|
||||
title: "Insteon Switch"
|
||||
description: "Instructions on how to setup the Insteon switches locally within Home Assistant."
|
||||
date: 2018-08-20 16:00
|
||||
sidebar: true
|
||||
comments: false
|
||||
sharing: true
|
||||
footer: true
|
||||
logo: insteon.png
|
||||
ha_category: Switch
|
||||
ha_iot_class: "Local Push"
|
||||
ha_version: 0.77
|
||||
---
|
||||
|
||||
The `insteon` switch platform lets you control your on/off switches through
|
||||
an INSTEON Modem (PLM and Hub) device connected directly to your system on a
|
||||
USB, serial port or TCPIP connection. To add support, set up the primary
|
||||
[insteon] component.
|
||||
|
||||
[insteon]: /components/insteon/
|
||||
@ -1,17 +0,0 @@
|
||||
---
|
||||
layout: page
|
||||
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
|
||||
comments: false
|
||||
sharing: true
|
||||
footer: true
|
||||
logo: insteon.png
|
||||
ha_category: Switch
|
||||
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 discovered and added to Home Assistant. The device names will be the Insteon address of the switch.
|
||||
@ -1,16 +0,0 @@
|
||||
---
|
||||
layout: page
|
||||
title: "Insteon PLM Switch"
|
||||
description: "Instructions on how to setup the Insteon PLM switches locally within Home Assistant."
|
||||
date: 2017-02-19 17:00
|
||||
sidebar: true
|
||||
comments: false
|
||||
sharing: true
|
||||
footer: true
|
||||
logo: insteon.png
|
||||
ha_category: Switch
|
||||
ha_iot_class: "Local Push"
|
||||
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](/components/insteon_plm/) component.
|
||||
Loading…
x
Reference in New Issue
Block a user