Update homematic.markdown config variables style (#6459)

* Update homematic.markdown config variables style

Per #6385 updating the configuration description.

* Changes based on code review

Change "int" to "integer" and restore section about fetching names.
This commit is contained in:
Ryan Bahm 2018-10-14 00:31:11 -07:00 committed by Franck Nijhof
parent d7bea08402
commit 3551e14e61

View File

@ -34,28 +34,83 @@ homematic:
Configuration variables (global):
- **interfaces** (*Required*): Configuration for each XML-RPC interface to integrate into Home Assistant.
- **hosts** (*Optional*): Configuration for each Hub (CCU/Homegear) to integrate into Home Assistant.
- **local_ip** (*Optional*): IP of device running Home Assistant. Override auto-detected value for exotic network setups.
- **local_port** (*Optional*): Port for connection with Home Assistant. By default it is randomly assigned.
{% configuration %}
interfaces:
description: Configuration for each XML-RPC interface to integrate into Home Assistant.
required: true
type: list
hosts:
description: Configuration for each Hub (CCU/Homegear) to integrate into Home Assistant.
required: false
type: list
local_ip:
description: IP of device running Home Assistant. Override auto-detected value for exotic network setups.
required: false
type: string
local_port:
description: Port for connection with Home Assistant. By default it is randomly assigned.
required: false
type: integer
{% endconfiguration %}
Configuration variables (interface):
- **host** (*Required*): IP address or Hostname of CCU/Homegear device or Hass.io add-on.
- **port** (*Optional*): Port of CCU/Homegear XML-RPC Server. Wireless: 2001, wired: 2000, IP: 2010, thermostatgroups: 9292.
- **callback_ip** (*Optional*): Set this, if Home Assistant is reachable under a different IP from the CCU (NAT, Docker etc.).
- **callback_port** (*Optional*): Set this, if Home Assistant is reachable under a different port from the CCU (NAT, Docker etc.).
- **resolvenames** (*Optional*): [`metadata`, `json`, `xml`] Try to fetch device names. Defaults to `false` if not specified.
- **jsonport** (*Optional*): Port of CCU JSON-RPC Server. The default is 80, but it may be different when running CCU virtually via Docker.
- **username** (*Optional*): When fetching names via JSON-RPC, you need to specify a user with guest-access to the CCU.
- **password** (*Optional*): When fetching names via JSON-RPC, you need to specify the password of the user you have configured above.
- **path** (*Optional*): Set to `/groups` when using port 9292.
{% configuration %}
host:
description: IP address or Hostname of CCU/Homegear device or Hass.io add-on.
required: true
type: string
port:
description: "Port of CCU/Homegear XML-RPC Server. Wireless: 2001, wired: 2000, IP: 2010, thermostatgroups: 9292."
required: false
type: integer
callback_ip:
description: Set this, if Home Assistant is reachable under a different IP from the CCU (NAT, Docker etc.).
required: false
type: string
callback_port:
description: Set this, if Home Assistant is reachable under a different IP from the CCU (NAT, Docker etc.).
required: false
type: integer
resolvenames:
description: Try to fetch device names. Defaults to `false` if not specified.
required: false
type: string
default: false
jsonport:
description: Port of CCU JSON-RPC Server. The default is 80, but it may be different when running CCU virtually via Docker.
required: false
type: integer
username:
description: When fetching names via JSON-RPC, you need to specify a user with guest-access to the CCU.
required: false
type: string
password:
description: When fetching names via JSON-RPC, you need to specify the password of the user you have configured above.
required: false
type: string
path:
description: Set to `/groups` when using port 9292.
required: false
type: string
{% endconfiguration %}
Configuration variables (host):
- **host** (*Required*): IP address of CCU/Homegear device.
- **username** (*Optional*): When fetching names via JSON-RPC, you need to specify a user with guest-access to the CCU.
- **password** (*Optional*): When fetching names via JSON-RPC, you need to specify the password of the user you have configured above.
{% configuration %}
host:
description: IP address of CCU/Homegear device.
required: true
type: string
username:
description: When fetching names via JSON-RPC, you need to specify a user with guest-access to the CCU.
required: false
type: string
password:
description: When fetching names via JSON-RPC, you need to specify the password of the user you have configured above.
required: false
type: string
{% endconfiguration %}
#### Example configuration with multiple protocols and some other options set:
@ -320,7 +375,7 @@ When the connection to your HomeMatic CCU or Homegear is lost, Home Assistant wi
string now = system.Date("%d.%m.%Y %H:%M:%S");
obj.State(now);
```
The HomeMatic CCU will execute all active programs which meet their conditions (none in this case) on every reboot.
3. Set up a template sensor in Home Assistant, which contains the value of the system variable: