New IHC platform by dingusdk · Pull Request #4129 · home-assistant/home-assistant.io

dingusdk · 2017-12-03T15:26:21Z

Description:

Documentation of the IHC platform

Pull request in home-assistant (if applicable): home-assistant/core#10916

MartinHjelmare · 2018-01-20T15:30:16Z

+footer: true
+logo: ihc.png
+ha_category: Binary Sensor
+ha_release: 0.59


MartinHjelmare · 2018-01-20T15:32:42Z

+ha_iot_class: "Local Push"
+---
+
+Before you can use the IHC Binary Sensor platform, you must setup the [IHC Component](../ihc/)


Does the relative link work?

It does work because the url has an ending / but I have changed all links to absolute /components/... (I can see that is how it is done on the other pages)

MartinHjelmare · 2018-01-20T15:35:21Z

+           ...
+```
+
+Configuration variables:


Please use configuration tag instead:
https://home-assistant.io/developers/documentation/create_page/#configuration

MartinHjelmare · 2018-01-20T15:35:53Z

+footer: true
+logo: ihc.png
+ha_category: Hub
+ha_release: "0.59"


MartinHjelmare · 2018-01-20T15:37:00Z

+---
+
+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 Sweeden and Norway)


MartinHjelmare · 2018-01-20T15:44:55Z

+      ...
+```
+
+Configuration variables:


Use configuration tag:
https://home-assistant.io/developers/documentation/create_page/#configuration

MartinHjelmare · 2018-01-20T15:45:29Z

+footer: true
+logo: ihc.png
+ha_category: Sensor
+ha_release: 0.59


MartinHjelmare · 2018-01-20T15:50:11Z

+      - id: 12346
+        ...
+```
+Configuration variables:


Use configuration tag:
https://home-assistant.io/developers/documentation/create_page/#configuration

MartinHjelmare · 2018-01-20T15:50:39Z

+footer: true
+logo: ihc.png
+ha_category: Switch
+ha_release: 0.59


MartinHjelmare · 2018-01-20T15:50:53Z

+        ....
+```
+
+Configuration variables:


Use configuration tag:
https://home-assistant.io/developers/documentation/create_page/#configuration

frenck · 2018-01-20T15:54:16Z

+
+### 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.


Place backticks around the ich when referencing to the component.

frenck · 2018-01-20T15:54:51Z

+
+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 regocnized automatically.


regocnized -> recognized

frenck · 2018-01-20T15:55:55Z

+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 a XML file and you can view it with any text/xml editor. 


a XML -> an XML

text/xml -> text/XML

frenck · 2018-01-20T15:56:16Z

+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 a 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.


xml -> XML

frenck · 2018-01-20T15:57:16Z

+
+- **auto_setup** (*Optional*): True to have IHC products auto setup.
+- **host** (*Required*): The url of the IHC Controller.
+- **info** (*Optional*): If True additional ihc info will be shown on each component.


ich -> ICH

frenck · 2018-01-20T15:57:26Z

+Configuration variables:
+
+- **auto_setup** (*Optional*): True to have IHC products auto setup.
+- **host** (*Required*): The url of the IHC Controller.


url -> URL

frenck · 2018-01-20T15:58:22Z

@dingusdk You documentation PR has been reviewed by @MartinHjelmare and myself.
We both left some change requests. Could you please take a look? Awesome! 👍

dingusdk · 2018-01-21T10:50:40Z

@MartinHjelmare and @frenck - I have been going through your comments, and all should have been fixed now.

MartinHjelmare · 2018-01-21T23:19:16Z

+      required: true
+      type: int
+    inverting:
+      description: If True the sensor will be inverted. Default False.


You should be able to put the default value as a separate key value pair with key default.

MartinHjelmare · 2018-01-21T23:20:56Z

+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 Manualy setup %}


"Manual setup"
Make sure links to anchor are adjusted.

MartinHjelmare · 2018-01-21T23:21:38Z

+{% 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/#manualy-setup)


Adjust anchor after fix below.

MartinHjelmare · 2018-01-21T23:33:52Z

+
+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/#manualy-setup)


Adjust anchor.

MartinHjelmare · 2018-01-21T23:35:18Z

+{% endconfiguration %}
+
+The resource id should be a boolean resource. (On/Off)
+For more information about IHC resource ids see [Manual Setup](/components/ihc/#manualy-setup)


Adjust anchor.

…(Anchors adjusted)

MartinHjelmare

Looks good, thanks!

frenck

I agree as well 👍
Thanks @dingusdk 🏅

New IHC platform

b5028ba

dingusdk mentioned this pull request Dec 3, 2017

Ihc component and platforms home-assistant/core#10916

Merged

fabaff added the new-integration This PR adds documentation for a new Home Assistant integration label Dec 3, 2017

dingusdk added 3 commits January 6, 2018 16:37

autosetup -> auto_setup

b783e35

Moved auto setup to the IHC component

056d485

Removed by LK in logo

6a3b1e6

MartinHjelmare requested changes Jan 20, 2018

View reviewed changes

frenck requested changes Jan 20, 2018

View reviewed changes

Changes from review.

42025f2

MartinHjelmare requested changes Jan 21, 2018

View reviewed changes

dingusdk added 2 commits January 22, 2018 11:32

Defaults in configurations. manualy setup" changed to "manual setup" …

13ba9d1

…(Anchors adjusted)

Relative links changed to absolute links

22968b7

MartinHjelmare approved these changes Jan 22, 2018

View reviewed changes

frenck approved these changes Jan 22, 2018

View reviewed changes

frenck merged commit 412869f into home-assistant:next Jan 22, 2018


		### 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.

Uh oh!

Conversation

dingusdk commented Dec 3, 2017

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

frenck commented Jan 20, 2018

Uh oh!

dingusdk commented Jan 21, 2018

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!