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-15 21:36:52 +00:00
Code Issues Packages Projects Releases Wiki Activity

Update Kankun switch component configuration variable (#6682)

Browse Source 
* Update Kankun switch component configuration variable

Update style of Kankun switch component documentation to follow new configuration variables description.
Related to #6385.

* ✏️ Tweak
This commit is contained in:
Klaas Schoute 2018-10-11 20:02:01 +02:00 committed by Franck Nijhof
parent 9bc92ec1e4
commit e8f962fa7d
1 changed files with 38 additions and 11 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

49
source/_components/switch.kankun.markdown
View File

@ -30,14 +30,41 @@ switch:
host: hostname_or_ipaddr
```
Configuration variables:
- **switches** (*Required*): The array that contains all Kankun switches.
- **identifier** (*Required*): Name of the Kankun switch as slug. Multiple entries are possible.
- **host** (*Required*): Hostname or IP address of the switch on the local network.
- **name** (*Optional*): Friendly name of the switch.
- **port** (*Optional*): HTTP connection port, defaults to 80.
- **path** (*Optional*): Path of CGI script, defaults to `/cgi-bin/json.cgi`.
- **username** (*Optional*): Username for basic authentication.
- **password** (*Optional*): Password for basic authentication.
{% configuration %}
switches:
description: The array that contains all Kankun switches.
required: true
type: map
keys:
identifier:
description: Name of the Kankun switch as slug. Multiple entries are possible.
required: true
type: map
keys:
host:
description: Hostname or IP address of the switch on the local network.
required: true
type: string
name:
description: Friendly name of the switch.
required: false
type: string
port:
description: HTTP connection port.
required: false
default: 80
type: integer
patch:
description: Path of CGI script.
required: false
default: "/cgi-bin/json.cgi"
type: string
username:
description: Username for basic authentication.
required: false
type: string
password:
description: Password for basic authentication.
required: false
type: string
{% endconfiguration %}