diff --git a/source/_components/binary_sensor.ihc.markdown b/source/_components/binary_sensor.ihc.markdown new file mode 100644 index 00000000000..5a3d7769dea --- /dev/null +++ b/source/_components/binary_sensor.ihc.markdown @@ -0,0 +1,69 @@ +--- +layout: page +title: "IHC Binary Sensor" +description: "Instructions how to integrate IHC Binary Sensors within Home Assistant." +date: 2017-11-27 13:35 +sidebar: true +comments: false +sharing: true +footer: true +logo: ihc.png +ha_category: Binary Sensor +ha_release: 0.62 +ha_iot_class: "Local Push" +--- + +Before you can use the IHC Binary Sensor platform, you must setup the [IHC Component](/components/ihc/) + +When auto setup is enabled the following products will be found in the IHC project and setup as binary sensors: + +* Dataline magnet contacts +* Dataline Pir sensors +* Dataline Pir sensors with twilight detection +* Dataline Pir alarm sensor +* Dataline smoke detector +* Dataline gas detector +* Dataline light sensor + +To manually configure IHC Binary Sensors insert this section in your configuration: + +```yaml +binary_sensor: + - platform: ihc + binary_sensors: + - id: 12345 + name: mysensor + type: opening + inverting: True + - id: 12346 + ... +``` + +{% configuration %} +binary_sensors: + description: List of binary sensors to setup manually. + required: false + type: map + keys: + id: + description: The IHC resource id. + required: true + type: int + inverting: + description: If True the sensor will be inverted. + required: false + type: bool + default: false + name: + description: The name of the component + required: false + type: string + type: + description: The binary sensor type. See [Home Assistant binary sensor](/components/binary_sensor/) for available types. + required: false + type: string +{% endconfiguration %} + +The resource id should be an id of a boolean IHC resource. +For more information about IHC resource ids see [Manual Setup](/components/ihc/#manual-setup) + diff --git a/source/_components/ihc.markdown b/source/_components/ihc.markdown new file mode 100644 index 00000000000..7bffc484155 --- /dev/null +++ b/source/_components/ihc.markdown @@ -0,0 +1,90 @@ +--- +layout: page +title: "IHC" +description: "Instructions on how to integrate the IHC components with Home Assistant" +date: 2017-11-11 22:00 +sidebar: true +comments: false +sharing: true +footer: true +logo: ihc.png +ha_category: Hub +ha_release: "0.62" +ha_iot_class: "Local Push" +--- + +IHC Controller integration for Home Assistant allows you to connect the LK IHC controller to Home Assistant. +(The controller is sold under other names in different countries - "ELKO Living system" in Sweden and Norway) + +An `ihc` section must be present in the `configuration.yaml` file and contain the following options: + +```yaml +# Example configuration.yaml entry +ihc: + host: http://192.168.1.3 + username: admin + password: mysecret + auto_setup: True + info: True +``` + +{% configuration %} +auto_setup: + description: True to have IHC products auto setup. + required: false + type: bool +host: + description: The URL of the IHC Controller. + required: true + type: string +info: + description: If True additional IHC info will be shown on each component. + required: false + type: bool +password: + description: The password for the IHC Controller. + required: true + type: string +username: + description: The username for the IHC Controller. + required: true + type: string +{% endconfiguration %} + +The info option will show the IHC "name", "note" and "position" attributes. +This will make it easier to identify the IHC products within Home Assistant + +There is currently support for the following device types within Home Assistant: + +- [Binary Sensor](/components/binary_sensor.ihc/) +- [Sensor](/components/sensor.ihc/) +- [Light](/components/light.ihc/) +- [Switch](/components/switch.ihc/) + +### Auto setup of IHC products + +If auto setup is enabled, the `ihc` component will automatically find IHC products and insert these as devices in Home Assistant. +To disable this set auto_setup to False. (Auto setup is on by default) +See the individual device types for a list of IHC products to be recognized automatically. + +Components will get a default name that is a combination of the IHC group and IHC resource id. +If you want to change the display names use the [Customizing entities](/docs/configuration/customizing-devices/) + +### {% linkable_title Manual setup %} + +Each device is associated with an IHC resource id. +To manually setup components you specify resource ids from the IHC project. +(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). +The project file is an XML file and you can view it with any text/XML editor. +You can rename it to have the XML extension and use a browser like Chrome or Internet Explorer. +The resources are the \ or \ eleements. +Shown as inputs or outputs of products in the IHC application. +You can also use inputs and outputs from function blocks. +These are the \ and \ elements from the project file. + +The IHC resource id should be specified as an integer value. (In the project file the id will be specified as a hex number) + +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/). +The application will show the product tree. You can expand it, select inputs and outputs and when selected you can see the resource id. + +See each device type for the manual configuration options. diff --git a/source/_components/light.ihc.markdown b/source/_components/light.ihc.markdown new file mode 100644 index 00000000000..a289ea942f3 --- /dev/null +++ b/source/_components/light.ihc.markdown @@ -0,0 +1,65 @@ +--- +layout: page +title: "IHC Light" +description: "Instructions how to integrate IHC lights within Home Assistant." +date: 2017-11-27 13:35 +sidebar: true +comments: false +sharing: true +footer: true +logo: ihc.png +ha_category: Light +ha_release: 0.62 +ha_iot_class: "Local Push" +--- + +Before you can use the IHC Light platform, you must setup the [IHC Component](/components/ihc/) + +When auto setup is enabled the following products will be found in the IHC project and setup as light devices: + +* Wireless lamp outlet dimmer +* Wireless dimmer +* Wireless combi dimmer 4 buttons +* Wireless lamp outlet relay +* Wireless combi relay 4 buttons +* Wireless mobile dimmer +* Dataline lamp outlet + +To manually configure IHC lights insert this section in your configuration: + +```yaml +light: + - platform: ihc + lights: + - id: 12345 + name: tablelight + dimmable: True + - id: 12346 + name: anotherlight + ... +``` + +{% configuration %} +lights: + description: List of lights to setup manually + required: false + type: map + keys: + dimmable: + description: Set to True if the IHC resource is a light level + required: false + type: bool + default: false + id: + description: The IHC resource id. + required: true + type: int + name: + description: The name of the component + required: false + type: string +{% endconfiguration %} + +In the example above 12345 is ihc resource id and "tablelight" is the name. +The IHC resource id can be a light level for dimmers or an boolean output of a relay. +For more information about IHC resource ids see [Manual Setup](/components/ihc/#manual-setup) diff --git a/source/_components/sensor.ihc.markdown b/source/_components/sensor.ihc.markdown new file mode 100644 index 00000000000..70ec6c11e2c --- /dev/null +++ b/source/_components/sensor.ihc.markdown @@ -0,0 +1,59 @@ +--- +layout: page +title: "IHC Sensor" +description: "Instructions how to integrate IHC Sensors within Home Assistant." +date: 2017-11-27 13:35 +sidebar: true +comments: false +sharing: true +footer: true +logo: ihc.png +ha_category: Sensor +ha_release: 0.62 +ha_iot_class: "Local Push" +--- + +Before you can use the IHC Sensor platform, you must setup the [IHC Component](/components/ihc/) + +When auto setup is enabled the following products will be found in the IHC project and setup as sensors: + +* Dataline temperature sensor - Will insert 2 temperature sensors +* Dataline Humidity - Will insert 1 humidity and 2 temperature sensors (calculated dewpoint) +* Dataline Lux - will insert 1 light and 1 temperature sensor + +To manually configure IHC sensors insert this section: + +```yaml +sensor: + - platform: ihc + sensors: + - id: 12345 + name: 'mysensor' + unit_of_measurement: '°C' + - id: 12346 + ... +``` + +{% configuration %} +sensors: + description: List of sensors to setup manually + required: false + type: map + keys: + id: + description: The IHC resource id. + required: true + type: int + name: + description: The name of the component + required: false + type: string + unit_of_measurement: + description: Defines the unit of measurement of the sensor, if any. + required: false + type: string +{% endconfiguration %} + +The resource id should be a IHC float resource. +For more information about IHC resource ids see [Manual Setup](/components/ihc/#manual-setup) + diff --git a/source/_components/switch.ihc.markdown b/source/_components/switch.ihc.markdown new file mode 100644 index 00000000000..011ef33a023 --- /dev/null +++ b/source/_components/switch.ihc.markdown @@ -0,0 +1,56 @@ +--- +layout: page +title: "IHC Switch" +description: "Instructions how to integrate IHC switches within Home Assistant." +date: 2017-11-27 13:35 +sidebar: true +comments: false +sharing: true +footer: true +logo: ihc.png +ha_category: Switch +ha_release: 0.62 +ha_iot_class: "Local Push" +--- + +Before you can use the IHC Switch platform, you must setup the [IHC Component](/components/ihc/) + +When auto setup is enabled the following products will be found in the ihc project and setup as switch devices: + +* Wireless plug outlet +* Wireless relay +* Mobile wireless relay +* Dataline plug outlet + +To manually configure IHC switches insert this section in your configuration: + +```yaml +switch: + - platform: ihc + auto_setup: True + switches: + - id: 12345 + name: myswitch + - id: 12346 + .... +``` + +{% configuration %} +switches: + description: List of switches to setup manually + required: false + type: map + keys: + id: + description: The IHC resource id. + required: true + type: int + name: + description: The name of the component + required: false + type: string +{% endconfiguration %} + +The resource id should be a boolean resource. (On/Off) +For more information about IHC resource ids see [Manual Setup](/components/ihc/#manual-setup) + diff --git a/source/images/supported_brands/ihc.png b/source/images/supported_brands/ihc.png new file mode 100644 index 00000000000..36e60f58e10 Binary files /dev/null and b/source/images/supported_brands/ihc.png differ