jeans/home-assistant.io
jeans/home-assistant.io
1
0
Fork 0
mirror of https://github.com/home-assistant/home-assistant.io.git synced 2025-07-18 23:06:58 +00:00
Code Issues Packages Projects Releases Wiki Activity

Update ISY994 documentation to be model agnostic (#25514)

Browse Source
This commit is contained in:
shbatm 2023-01-03 03:24:18 -06:00 committed by GitHub
parent a0e59c658c
commit e6e2fd9889
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
3 changed files with 15 additions and 13 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

1
.textlintrc.json
View File

@ -142,6 +142,7 @@
"IP",
"iPad",
"iPhone",
"ISY",
"ISY994",
"iTunes",
"JSON-RPC",

25
source/_integrations/isy994.markdown
View File

@ -1,6 +1,6 @@
---
title: Universal Devices ISY994
description: Instructions on how to setup the ISY994 controller within Home Assistant.
title: Universal Devices ISY/IoX
description: Instructions on how to setup an ISY controller within Home Assistant.
ha_category:
- Binary Sensor
- Climate
@ -32,8 +32,9 @@ ha_dhcp: true
ha_integration_type: hub
---
The ISY994 is a home automation controller that is capable of controlling Insteon and X10 devices. Some models of the ISY994 can even control Z-Wave devices.
The ISY994 controller is manufactured by [Universal Devices](https://www.universal-devices.com/smarthome).
ISY is a home automation controller capable of controlling Insteon, X10, Z-Wave and Zigbee/Matter devices connected to supported hardware manufactured by [Universal Devices, Inc.](https://www.universal-devices.com/).
This integration supports the legacy ISY994 hardware family, as well as current ISY-on-Anything (IoX) hardware, such as the [eisy](https://www.universal-devices.com/product/eisy-home/) or [Polisy](https://www.universal-devices.com/polisy/) devices.
There is currently support for the following device types within Home Assistant:
@ -105,9 +106,9 @@ Once the ISY controller is configured, it will automatically import any binary s
### Sensors
An Insteon door/window sensor will show up as a single Binary Sensor rather than two discrete devices like it does in the ISY994 admin panel. Note that when in "Two Nodes" mode, the sensor will have an UNKNOWN state until the sensor changes for the first time since the last Home Assistant reboot. If you do not use Insteon scenes that are controlled directly from the door sensor, you may prefer to set the sensor to "One Node" mode using the ISY Admin Panel.
An Insteon door/window sensor will show up as a single Binary Sensor rather than two discrete devices like it does in the ISY Admin Console. Note that when in "Two Nodes" mode, the sensor will have an UNKNOWN state until the sensor changes for the first time since the last Home Assistant reboot. If you do not use Insteon scenes that are controlled directly from the door sensor, you may prefer to set the sensor to "One Node" mode using the ISY Admin Panel.
Each Insteon leak sensor will also show up as a single Binary Sensor as opposed to the two nodes seen in the ISY994. The name of the device will be based on what the parent node is named in the ISY994, which is typically the one with "-Dry" at the end of the name. This may be confusing, because "On" means wet in Home Assistant. You can rename this node in Home Assistant to be more clear, see the [Customization section](/docs/configuration/customizing-devices/) of your configuration.
Each Insteon leak sensor will also show up as a single Binary Sensor as opposed to the two nodes seen in the ISY Admin Console. The name of the device will be based on what the parent node is named in the ISY, which is typically the one with "-Dry" at the end of the name. This may be confusing, because "On" means wet in Home Assistant. You can rename this node in Home Assistant to be more clear, see the [Customization section](/docs/configuration/customizing-devices/) of your configuration.
If your leak or door/window sensor supports heartbeats, a new binary_sensor device will be added to Home Assistant to represent the battery state. The sensor will stay "Off" so long as the daily heartbeats occur. If a heartbeat is missed, the sensor will flip to "On". The name of this device will be based on the heartbeat node in the ISY.
@ -136,7 +137,7 @@ automation:
entity_id: light.lr_track_lights_rear
```
All `isy994_control` events will have an `entity_id` and `control` parameter in its `event_data`. You'll need to refer to ISY994 documentation for the list of every possible control type, but the common ones are:
All `isy994_control` events will have an `entity_id` and `control` parameter in its `event_data`. You'll need to refer to ISY documentation for the list of every possible control type, but the common ones are:
- `DON`: On button.
- `DOF`: Off button.
@ -150,7 +151,7 @@ All `isy994_control` events will have an `entity_id` and `control` parameter in
### Insteon Scenes & Keypad/Remote Buttons
All Insteon scenes configured in the ISY994 will show up as a `switch` in Home Assistant, as they do not support dimming or setting specific brightness settings as Home Assistant's `light` component.
All Insteon scenes configured in the ISY Admin Console will show up as a `switch` in Home Assistant, as they do not support dimming or setting specific brightness settings as Home Assistant's `light` component.
Insteon Secondary Keypad buttons and Remote buttons are added to Home Assistant to allow support for using Control Events in Automations. These devices are added as `sensors` since they cannot be directly controlled (turned on/off); their state is the last ON level command they sent, in a range from `0` (Off) to `255` (On 100%). Note: these devices may report incorrect states before being used after a reboot of the ISY. Secondary Keypad buttons may be turned on or off using ISY Scenes (refer to ISY Documentation for more details).
@ -160,7 +161,7 @@ Once loaded, the following services will be exposed with the `isy994.` prefix, t
- Entity services for Home Assistant-connected entities: `send_node_command`, `send_raw_node_command`, `set_on_level`, and `set_ramp_rate`.
- Generic ISY services: `system_query`, `set_variable`, `send_program_command`, and `run_network_resource`.
- Management services for the ISY994 Home Assistant integration: `reload` and `cleanup_entities`.
- Management services for the ISY Home Assistant integration: `reload` and `cleanup_entities`.
#### Service `isy994.send_node_command`
@ -210,7 +211,7 @@ Rename a node or group (scene) on the ISY994. Note: this will not automatically
| Service data attribute | Optional | Description |
| ---------------------- | -------- | -------------------------------------------------------------- |
| `entity_id` | no | Name of target entity for the command, e.g., `light.front_porch`. |
| `name` | no | The new name to use within the ISY994. |
| `name` | no | The new name to use within the ISY. |
#### Service `isy994.set_on_level`
@ -275,11 +276,11 @@ Run a network resource on the ISY.
#### Service `isy994.reload`
Reload the ISY994 connection(s) without restarting Home Assistant. Use this service to pick up new devices that have been added or changed on the ISY since the last restart of Home Assistant.
Reload the ISY connection(s) without restarting Home Assistant. Use this service to pick up new devices that have been added or changed on the ISY since the last restart of Home Assistant.
#### Service `isy994.cleanup_entities`
Cleanup old entities no longer used by the ISY994 integrations. Useful if you've removed devices from the ISY or changed the filter string options in the configuration to exclude additional items and they were not properly removed
Cleanup old entities no longer used by the ISY integration. Useful if you've removed devices from the ISY or changed the filter string options in the configuration to exclude additional items and they were not properly removed
by Home Assistant.
### Creating Custom Devices using ISY Programs

2
source/_integrations/ssdp.markdown
View File

@ -47,6 +47,6 @@ The following integrations are automatically discovered by the SSDP integration:
- [Sony Songpal](/integrations/songpal/)
- [Synology DSM](/integrations/synology_dsm/)
- [Ubiquiti UniFi](/integrations/unifi/)
- [Universal Devices ISY994](/integrations/isy994/)
- [Universal Devices ISY/IoX](/integrations/isy994/)
- [UPnP](/integrations/upnp/)
- [WiLight](/integrations/wilight/)