You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
description: "Instructions how to integrate ISY994 binary sensors into Home Assistant."
5
+
date: 2016-09-03 23:00
6
+
sidebar: true
7
+
comments: false
8
+
sharing: true
9
+
footer: true
10
+
logo: universal_devices.png
11
+
ha_category: Binary Sensor
12
+
ha_iot_class: "Local Push"
13
+
---
14
+
15
+
The `isy994` platform allows you to get data from your [ISY994](https://www.universal-devices.com/residential/isy994i-series/) binary sensors from within Home Assistant.
16
+
17
+
They will be automatically discovered if the isy994 component is loaded.
description: "Instructions how to integrate ISY994 covers into Home Assistant."
5
+
date: 2016-09-03 23:00
6
+
sidebar: true
7
+
comments: false
8
+
sharing: true
9
+
footer: true
10
+
logo: universal_devices.png
11
+
ha_category: Cover
12
+
ha_iot_class: "Local Push"
13
+
---
14
+
15
+
The `isy994` platform allows you to get data from your [ISY994](https://www.universal-devices.com/residential/isy994i-series/) cover from within Home Assistant.
16
+
17
+
They will be automatically discovered if the isy994 component is loaded.
description: "Instructions how to integrate ISY994 fans into Home Assistant."
5
+
date: 2016-09-03 23:00
6
+
sidebar: true
7
+
comments: false
8
+
sharing: true
9
+
footer: true
10
+
logo: universal_devices.png
11
+
ha_category: Fan
12
+
ha_iot_class: "Local Push"
13
+
---
14
+
15
+
The `isy994` platform allows you to get data from your [ISY994](https://www.universal-devices.com/residential/isy994i-series/) fan from within Home Assistant.
16
+
17
+
They will be automatically discovered if the isy994 component is loaded.
Copy file name to clipboardExpand all lines: source/_components/isy994.markdown
+64-31Lines changed: 64 additions & 31 deletions
Original file line number
Diff line number
Diff line change
@@ -9,15 +9,15 @@ sharing: true
9
9
footer: true
10
10
logo: universal_devices.png
11
11
ha_category: Hub
12
-
ha_release: pre 0.7
12
+
ha_release: 0.28
13
13
---
14
14
15
-
The ISY994 is a home automation controller that is capable of controlling Insteon and X10 devices. The controller is also capable of controlling Z-Wave devices but that functionality has not yet been confirmed with Home Assistant.
15
+
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.
16
16
The ISY994 controller is manufactured by [Universal Devices](https://www.universal-devices.com/residential/isy994i-series/).
17
17
18
18
### {% linkable_title Basic Configuration %}
19
19
20
-
Home Assistant is capable of communicating with any switch, sensor, and lightthat is configured on the controller. Using the programs on the controller, custom switches and sensors can also be created.
20
+
Home Assistant is capable of communicating with any binary sensor, cover, fan, light, lock, sensor and switch that is configured on the controller. Using the programs on the controller, custom binary sensors, cover, fan, lock, and switches can also be created.
21
21
22
22
To integrate your ISY994 controller with Home Assistant, add the following section to your `configuration.yaml` file:
23
23
@@ -37,52 +37,85 @@ Configuration variables:
37
37
- **username** (*Required*): The username that used to access the ISY interface.
38
38
- **password** (*Required*): The password that used to access the ISY interface.
39
39
40
-
- **sensor_string** (*Optional*): This is the string that is used to identify which devices are to be assumed to be sensors instead of lights of switches. By default, this string is 'Sensor'. If this string is found in the device name, Home Assistant will assume it is as a sensor.
40
+
- **sensor_string** (*Optional*): This is the string that is used to identify which devices are to be assumed to be sensors instead of lights of switches. By default, this string is 'sensor'. If this string is found in the device name or folder, Home Assistant will assume it is as a sensor or binary sensor (if the device has on/off or true/false states).
41
41
- **hidden_string** (*Optional*): The HIDDEN_STRING is a string that is used to identify which devices are to be hidden on Home Assistant's front page. This string will be stripped from the device's name before being used. By default, this value is '{HIDE ME}'.
42
42
- **tls** (*Optional*): This entry should refelct the version of TLS that the ISY controller is using for HTTPS encryption. This value can be either 1.1 or 1.2. If this value is not set, it is assumed to be version 1.1. This is the default for most users. ISY994 Pro users may likely be using 1.2. When using HTTPS in the host entry, it is best practice to set this value.
43
43
44
-
Once the ISY controller is configured, it will automatically import any lights, switches, and sensors it can locate.
44
+
Once the ISY controller is configured, it will automatically import any binary sensors, covers, fans, lights, locks, sensors and switches it can locate.
45
45
46
-
### {% linkable_title Creating Custom Switches %}
46
+
### {% linkable_title Creating Custom Devices %}
47
47
48
-
Using the Programs tab in the controller's Administrative Console, custom switches can be created that will appear natively inside of Home Assistant. Home Assistant will scan two different directories for switch configurations on the controller. These directories must exist at the root level. The two directories used to make switches are *HA.doors* and *HA.switches*. Currently, the two receive identical treatment in Home Assistant.
48
+
Using the Programs tab in the controller's Administrative Console, custom devices can be created that will appear natively inside of Home Assistant. Home Assistant will scan the following folders and build the device to the associated domains:
49
49
50
-
A switch is created by creating a directory under either of these root dirctories with the name you would like to call the switch. Two programs are then required in this directory: *status* and *actions*. The image below shows a sample configuration. This sample includes an extra program called *auto on*. This is ignored by Home Assistant.
50
+
```
51
+
My Programs
52
+
├── HA.binary_sensor
53
+
| ├── Movement In House
54
+
| | └── status
55
+
| └── Garage Open
56
+
| | └── status
57
+
├── HA.cover
58
+
| ├── Left Garage Door
59
+
| | ├── actions
60
+
| | └── status
61
+
| ├── Living Room Blinds
62
+
| | ├── actions
63
+
| | └── status
64
+
├── HA.fan
65
+
| ├── Desk Fan
66
+
| | ├── actions
67
+
| | └── status
68
+
| ├── Living Room Fan
69
+
| | ├── actions
70
+
| | └── status
71
+
├── HA.lock
72
+
| ├── Front Door
73
+
| | ├── actions
74
+
| | └── status
75
+
| ├── Back Door
76
+
| | ├── actions
77
+
| | └── status
78
+
├── HA.switch
79
+
| ├── Dining Lights
80
+
| | ├── actions
81
+
| | └── status
82
+
| ├── Sleep Mode
83
+
| | ├── actions
84
+
| | └── status
85
+
```
86
+
87
+
A device is created by creating a directory, with the name for the device, under any of the following root directories:
88
+
**HA.binary_sensor* will create a binary sensor (see [Customizing Devices](https://home-assistant.io/getting-started/customizing-devices/) to set the sensor class)
89
+
**HA.cover* will create a cover
90
+
**HA.fan* will create a fan
91
+
**HA.lock* will create a lock
92
+
**HA.switch* will create a switch
93
+
94
+
A program, named *status*, is required under the program device directory. A program, named *actions*, is required for all program devices except for binary_sensor. Any other programs in these device directories will be ignored.
The *status* program in this directory is what indicates if the switch is on or off. Only the IF clause is evaluated. If the clause returns True, the switch will be on. False will indicate the switch is off.
100
+
The *status* program in this directory is what indicates the state of the device:
101
+
**binary_sensor* on if the clause returns true, otherwise off
102
+
**cover* closed if the clause returns true, otherwise open
103
+
**fan* on if the clause returns true, otherwise off
104
+
**lock* locked if the clause returns true, otherwise unlocked
105
+
**switch* on if the clause returns true, otherwise off
The *actions* program indicates what should be performed to turn the switch on or off. The THEN clause gives instructions for turning the switch on while the ELSE clause gives instructions for turning the switch off. Below is an example.
111
+
The *actions* program indicates what should be performed for the following device services:
112
+
**cover* the THEN clause is evaluated for the open_cover service, the ELSE clause is evaluated for the close_cover service
113
+
**fan* the THEN clause is evaluated for the turn_on service, the ELSE clause is evaluated for the turn_off service
114
+
**lock* the THEN clause is evaluated for the lock service, the ELSE clause is evaluated for the unlock service
115
+
**switch* the THEN clause is evaluated for the turn_on srevice, the ELSE clause is evaluated for the turn_off service
The example program above shows how to control a legacy X10 device from Home Assistant using an ISY controller.
69
-
70
-
### {% linkable_title Creating Custom Sensors %}
71
-
72
-
Custom sensors can also be created using the Programs tab in the ISY controller's Administrative Console. For programs, three different root level folders are evaluated that are all handled a little differently inside of Home Assistant.
73
-
74
-
* *HA.sensors* will have states of Open or Closed
75
-
* *HA.states* will have states of On or Off
76
-
* *HA.locations* will have states of Home or Away
77
-
78
-
To create a custom sensor, create a program under any of the three root directories. The name of the program will be the name of the sensor. An example below shows a location indicator setup.
The program created only needs an IF clause. It will be evaluated to either Open/On/Home when it returns True and Closed/Off/Away when it returns False. An example is below.
description: "Instructions how to integrate ISY994 lights into Home Assistant."
5
+
date: 2016-09-03 23:00
6
+
sidebar: true
7
+
comments: false
8
+
sharing: true
9
+
footer: true
10
+
logo: universal_devices.png
11
+
ha_category: Light
12
+
ha_iot_class: "Local Push"
13
+
---
14
+
15
+
The `isy994` platform allows you to get data from your [ISY994](https://www.universal-devices.com/residential/isy994i-series/) light from within Home Assistant.
16
+
17
+
They will be automatically discovered if the isy994 component is loaded.
description: "Instructions how to integrate ISY994 locks into Home Assistant."
5
+
date: 2016-09-03 23:00
6
+
sidebar: true
7
+
comments: false
8
+
sharing: true
9
+
footer: true
10
+
logo: universal_devices.png
11
+
ha_category: Lock
12
+
ha_iot_class: "Local Push"
13
+
---
14
+
15
+
The `isy994` platform allows you to get data from your [ISY994](https://www.universal-devices.com/residential/isy994i-series/) lock from within Home Assistant.
16
+
17
+
They will be automatically discovered if the isy994 component is loaded.
description: "Instructions how to integrate ISY994 sensors into Home Assistant."
5
+
date: 2016-09-03 23:00
6
+
sidebar: true
7
+
comments: false
8
+
sharing: true
9
+
footer: true
10
+
logo: universal_devices.png
11
+
ha_category: Sensor
12
+
ha_iot_class: "Local Push"
13
+
---
14
+
15
+
The `isy994` platform allows you to get data from your [ISY994](https://www.universal-devices.com/residential/isy994i-series/) sensor from within Home Assistant.
16
+
17
+
They will be automatically discovered if the isy994 component is loaded.
description: "Instructions how to integrate ISY994 switch into Home Assistant."
5
+
date: 2016-09-03 23:00
6
+
sidebar: true
7
+
comments: false
8
+
sharing: true
9
+
footer: true
10
+
logo: universal_devices.png
11
+
ha_category: Switch
12
+
ha_iot_class: "Local Push"
13
+
---
14
+
15
+
The `isy994` platform allows you to get data from your [ISY994](https://www.universal-devices.com/residential/isy994i-series/) switch from within Home Assistant.
16
+
17
+
They will be automatically discovered if the isy994 component is loaded.
Copy file name to clipboardExpand all lines: source/getting-started/customizing-devices.markdown
+19-1Lines changed: 19 additions & 1 deletion
Original file line number
Diff line number
Diff line change
@@ -41,9 +41,27 @@ homeassistant:
41
41
| --------- | ----------- |
42
42
| friendly_name | Name of the entity
43
43
| hidden | Set to `true` to hide the entity.
44
-
| entity_picture | url to use as picture for entity
44
+
| entity_picture | Url to use as picture for entity
45
45
| icon | Any icon from [MaterialDesignIcons.com](http://MaterialDesignIcons.com). Prefix name with `mdi:`, ie `mdi:home`.
46
46
| assumed_state | For switches with an assumed state two buttons are shown (turn off, turn on) instead of a switch. By setting `assumed_state` to `false` you will get the default switch icon.
47
+
| sensor_class | Sets the class of the sensor, changing the device state and icon that is displayed on the UI (see below).
48
+
49
+
| sensor_class | Description |
50
+
| ------------ | ----------- |
51
+
| cold | On means cold (or too cold) |
52
+
| connectivity | On meanse connection present, Off means no connection
53
+
| gas | CO, CO2, etc. |
54
+
| heat | On means hot (or too hot) |
55
+
| light | Lightness threshold |
56
+
| moisture | Specifically a wetness sensor |
57
+
| motion | Motion sensor |
58
+
| moving | On means moving, Off means stopped |
59
+
| opening | Door, window, etc. |
60
+
| power | Power, over-current, etc. |
61
+
| safety | On meanse unsafe, Off means safe |
62
+
| smoke | Smoke detector |
63
+
| sound | On means sound detected, Off meanse no sound |
64
+
| vibration | On means vibration detected, Off meanse no vibration |
0 commit comments