Skip to content

Commit 412869f

Browse files
dingusdkfrenck
dingusdk
authored and
frenck
committed
New IHC platform (home-assistant#4129)
* New IHC platform * autosetup -> auto_setup * Moved auto setup to the IHC component * Removed by LK in logo * Changes from review. * Defaults in configurations. manualy setup" changed to "manual setup" (Anchors adjusted) * Relative links changed to absolute links
1 parent 20c82d5 commit 412869f

File tree

6 files changed

+339
-0
lines changed

6 files changed

+339
-0
lines changed

‎source/_components/binary_sensor.ihc.markdown

Lines changed: 69 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,69 @@
1+
---
2+
layout: page
3+
title: "IHC Binary Sensor"
4+
description: "Instructions how to integrate IHC Binary Sensors within Home Assistant."
5+
date: 2017-11-27 13:35
6+
sidebar: true
7+
comments: false
8+
sharing: true
9+
footer: true
10+
logo: ihc.png
11+
ha_category: Binary Sensor
12+
ha_release: 0.62
13+
ha_iot_class: "Local Push"
14+
---
15+
16+
Before you can use the IHC Binary Sensor platform, you must setup the [IHC Component](/components/ihc/)
17+
18+
When auto setup is enabled the following products will be found in the IHC project and setup as binary sensors:
19+
20+
* Dataline magnet contacts
21+
* Dataline Pir sensors
22+
* Dataline Pir sensors with twilight detection
23+
* Dataline Pir alarm sensor
24+
* Dataline smoke detector
25+
* Dataline gas detector
26+
* Dataline light sensor
27+
28+
To manually configure IHC Binary Sensors insert this section in your configuration:
29+
30+
```yaml
31+
binary_sensor:
32+
- platform: ihc
33+
binary_sensors:
34+
- id: 12345
35+
name: mysensor
36+
type: opening
37+
inverting: True
38+
- id: 12346
39+
...
40+
```
41+
42+
{% configuration %}
43+
binary_sensors:
44+
description: List of binary sensors to setup manually.
45+
required: false
46+
type: map
47+
keys:
48+
id:
49+
description: The IHC resource id.
50+
required: true
51+
type: int
52+
inverting:
53+
description: If True the sensor will be inverted.
54+
required: false
55+
type: bool
56+
default: false
57+
name:
58+
description: The name of the component
59+
required: false
60+
type: string
61+
type:
62+
description: The binary sensor type. See [Home Assistant binary sensor](/components/binary_sensor/) for available types.
63+
required: false
64+
type: string
65+
{% endconfiguration %}
66+
67+
The resource id should be an id of a boolean IHC resource.
68+
For more information about IHC resource ids see [Manual Setup](/components/ihc/#manual-setup)
69+

‎source/_components/ihc.markdown

Lines changed: 90 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,90 @@
1+
---
2+
layout: page
3+
title: "IHC"
4+
description: "Instructions on how to integrate the IHC components with Home Assistant"
5+
date: 2017-11-11 22:00
6+
sidebar: true
7+
comments: false
8+
sharing: true
9+
footer: true
10+
logo: ihc.png
11+
ha_category: Hub
12+
ha_release: "0.62"
13+
ha_iot_class: "Local Push"
14+
---
15+
16+
IHC Controller integration for Home Assistant allows you to connect the LK IHC controller to Home Assistant.
17+
(The controller is sold under other names in different countries - "ELKO Living system" in Sweden and Norway)
18+
19+
An `ihc` section must be present in the `configuration.yaml` file and contain the following options:
20+
21+
```yaml
22+
# Example configuration.yaml entry
23+
ihc:
24+
host: http://192.168.1.3
25+
username: admin
26+
password: mysecret
27+
auto_setup: True
28+
info: True
29+
```
30+
31+
{% configuration %}
32+
auto_setup:
33+
description: True to have IHC products auto setup.
34+
required: false
35+
type: bool
36+
host:
37+
description: The URL of the IHC Controller.
38+
required: true
39+
type: string
40+
info:
41+
description: If True additional IHC info will be shown on each component.
42+
required: false
43+
type: bool
44+
password:
45+
description: The password for the IHC Controller.
46+
required: true
47+
type: string
48+
username:
49+
description: The username for the IHC Controller.
50+
required: true
51+
type: string
52+
{% endconfiguration %}
53+
54+
The info option will show the IHC "name", "note" and "position" attributes.
55+
This will make it easier to identify the IHC products within Home Assistant
56+
57+
There is currently support for the following device types within Home Assistant:
58+
59+
- [Binary Sensor](/components/binary_sensor.ihc/)
60+
- [Sensor](/components/sensor.ihc/)
61+
- [Light](/components/light.ihc/)
62+
- [Switch](/components/switch.ihc/)
63+
64+
### Auto setup of IHC products
65+
66+
If auto setup is enabled, the `ihc` component will automatically find IHC products and insert these as devices in Home Assistant.
67+
To disable this set auto_setup to False. (Auto setup is on by default)
68+
See the individual device types for a list of IHC products to be recognized automatically.
69+
70+
Components will get a default name that is a combination of the IHC group and IHC resource id.
71+
If you want to change the display names use the [Customizing entities](/docs/configuration/customizing-devices/)
72+
73+
### {% linkable_title Manual setup %}
74+
75+
Each device is associated with an IHC resource id.
76+
To manually setup components you specify resource ids from the IHC project.
77+
(The IHC project is the file you edit/upload to the IHC Controller using LK IHC Visual - or similar program if your controller is not the LK brand).
78+
The project file is an XML file and you can view it with any text/XML editor.
79+
You can rename it to have the XML extension and use a browser like Chrome or Internet Explorer.
80+
The resources are the \<airlink_xxx> or \<dataline_xxx> eleements.
81+
Shown as inputs or outputs of products in the IHC application.
82+
You can also use inputs and outputs from function blocks.
83+
These are the \<resource_input> and \<resource_output> elements from the project file.
84+
85+
The IHC resource id should be specified as an integer value. (In the project file the id will be specified as a hex number)
86+
87+
If you want an easier way to get the IHC resource ids, you can download the [Alternative Service View application](https://www.dingus.dk/updated-ihc-alternative-service-view/).
88+
The application will show the product tree. You can expand it, select inputs and outputs and when selected you can see the resource id.
89+
90+
See each device type for the manual configuration options.

‎source/_components/light.ihc.markdown

Lines changed: 65 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,65 @@
1+
---
2+
layout: page
3+
title: "IHC Light"
4+
description: "Instructions how to integrate IHC lights within Home Assistant."
5+
date: 2017-11-27 13:35
6+
sidebar: true
7+
comments: false
8+
sharing: true
9+
footer: true
10+
logo: ihc.png
11+
ha_category: Light
12+
ha_release: 0.62
13+
ha_iot_class: "Local Push"
14+
---
15+
16+
Before you can use the IHC Light platform, you must setup the [IHC Component](/components/ihc/)
17+
18+
When auto setup is enabled the following products will be found in the IHC project and setup as light devices:
19+
20+
* Wireless lamp outlet dimmer
21+
* Wireless dimmer
22+
* Wireless combi dimmer 4 buttons
23+
* Wireless lamp outlet relay
24+
* Wireless combi relay 4 buttons
25+
* Wireless mobile dimmer
26+
* Dataline lamp outlet
27+
28+
To manually configure IHC lights insert this section in your configuration:
29+
30+
```yaml
31+
light:
32+
- platform: ihc
33+
lights:
34+
- id: 12345
35+
name: tablelight
36+
dimmable: True
37+
- id: 12346
38+
name: anotherlight
39+
...
40+
```
41+
42+
{% configuration %}
43+
lights:
44+
description: List of lights to setup manually
45+
required: false
46+
type: map
47+
keys:
48+
dimmable:
49+
description: Set to True if the IHC resource is a light level
50+
required: false
51+
type: bool
52+
default: false
53+
id:
54+
description: The IHC resource id.
55+
required: true
56+
type: int
57+
name:
58+
description: The name of the component
59+
required: false
60+
type: string
61+
{% endconfiguration %}
62+
63+
In the example above 12345 is ihc resource id and "tablelight" is the name.
64+
The IHC resource id can be a light level for dimmers or an boolean output of a relay.
65+
For more information about IHC resource ids see [Manual Setup](/components/ihc/#manual-setup)

‎source/_components/sensor.ihc.markdown

Lines changed: 59 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,59 @@
1+
---
2+
layout: page
3+
title: "IHC Sensor"
4+
description: "Instructions how to integrate IHC Sensors within Home Assistant."
5+
date: 2017-11-27 13:35
6+
sidebar: true
7+
comments: false
8+
sharing: true
9+
footer: true
10+
logo: ihc.png
11+
ha_category: Sensor
12+
ha_release: 0.62
13+
ha_iot_class: "Local Push"
14+
---
15+
16+
Before you can use the IHC Sensor platform, you must setup the [IHC Component](/components/ihc/)
17+
18+
When auto setup is enabled the following products will be found in the IHC project and setup as sensors:
19+
20+
* Dataline temperature sensor - Will insert 2 temperature sensors
21+
* Dataline Humidity - Will insert 1 humidity and 2 temperature sensors (calculated dewpoint)
22+
* Dataline Lux - will insert 1 light and 1 temperature sensor
23+
24+
To manually configure IHC sensors insert this section:
25+
26+
```yaml
27+
sensor:
28+
- platform: ihc
29+
sensors:
30+
- id: 12345
31+
name: 'mysensor'
32+
unit_of_measurement: '°C'
33+
- id: 12346
34+
...
35+
```
36+
37+
{% configuration %}
38+
sensors:
39+
description: List of sensors to setup manually
40+
required: false
41+
type: map
42+
keys:
43+
id:
44+
description: The IHC resource id.
45+
required: true
46+
type: int
47+
name:
48+
description: The name of the component
49+
required: false
50+
type: string
51+
unit_of_measurement:
52+
description: Defines the unit of measurement of the sensor, if any.
53+
required: false
54+
type: string
55+
{% endconfiguration %}
56+
57+
The resource id should be a IHC float resource.
58+
For more information about IHC resource ids see [Manual Setup](/components/ihc/#manual-setup)
59+

‎source/_components/switch.ihc.markdown

Lines changed: 56 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,56 @@
1+
---
2+
layout: page
3+
title: "IHC Switch"
4+
description: "Instructions how to integrate IHC switches within Home Assistant."
5+
date: 2017-11-27 13:35
6+
sidebar: true
7+
comments: false
8+
sharing: true
9+
footer: true
10+
logo: ihc.png
11+
ha_category: Switch
12+
ha_release: 0.62
13+
ha_iot_class: "Local Push"
14+
---
15+
16+
Before you can use the IHC Switch platform, you must setup the [IHC Component](/components/ihc/)
17+
18+
When auto setup is enabled the following products will be found in the ihc project and setup as switch devices:
19+
20+
* Wireless plug outlet
21+
* Wireless relay
22+
* Mobile wireless relay
23+
* Dataline plug outlet
24+
25+
To manually configure IHC switches insert this section in your configuration:
26+
27+
```yaml
28+
switch:
29+
- platform: ihc
30+
auto_setup: True
31+
switches:
32+
- id: 12345
33+
name: myswitch
34+
- id: 12346
35+
....
36+
```
37+
38+
{% configuration %}
39+
switches:
40+
description: List of switches to setup manually
41+
required: false
42+
type: map
43+
keys:
44+
id:
45+
description: The IHC resource id.
46+
required: true
47+
type: int
48+
name:
49+
description: The name of the component
50+
required: false
51+
type: string
52+
{% endconfiguration %}
53+
54+
The resource id should be a boolean resource. (On/Off)
55+
For more information about IHC resource ids see [Manual Setup](/components/ihc/#manual-setup)
56+

‎source/images/supported_brands/ihc.png

4.59 KB
Loading

0 commit comments

Comments
 (0)