Update Digitalloggers switch component configuration (#6941)

This commit is contained in:
Klaas Schoute 2018-10-19 20:01:29 +02:00 committed by Fabian Affolter
parent 3b91c3f7f2
commit e2e638a2bb

View File

@ -27,16 +27,37 @@ switch:
host: 192.168.1.43
```
Configuration variables:
- **host** (*Required*): The IP address or FQDN of your DIN III relay, eg. `192.168.1.32` or `myrelay.example.com`.
- **name** (*Optional*): The name to use when controlling this relay. Default: `DINRelay`.
- **username** (*Optional*): Credentials for controlling this relay. Default: `admin`.
- **password** (*Optional*): Credentials for controlling this relay. Default: `admin`.
- **timeout** (*Optional*): Default timeout as set by the underlying python-dlipower library is `20` seconds. Override it if you need to. Valid range is 1 to 600.
- **cycletime** (*Optional*): This is the delay enforced by the library when you send multiple commands to the same device. The default relay cycle time is `2` seconds. Override it if you need to. Valid range is 1 to 600. A delay is a recommendation of Digital Loggers:
>Many loads draw more power when they are initially switched on. Sequencing prevents circuit overloads when loads devices are attached to a single circuit.
{% configuration %}
host:
description: The IP address or FQDN of your DIN III relay, e.g., `192.168.1.32` or `myrelay.example.com`.
required: true
type: string
name:
description: The name to use when controlling this relay.
required: false
default: DINRelay
type: string
username:
description: Username for controlling this relay.
required: false
default: admin
type: string
password:
description: Password for controlling this relay.
required: false
default: admin
type: string
timeout:
description: Override the timeout in seconds if you need to, valid range is 1 to 600.
required: false
default: 20
type: integer
cycletime:
description: "This is the delay enforced by the library when you send multiple commands to the same device. Override it if you need to. Valid range is 1 to 600. A delay is a recommendation of Digital Loggers: Many loads draw more power when they are initially switched on. Sequencing prevents circuit overloads when loads devices are attached to a single circuit."
required: false
default: 2
type: integer
{% endconfiguration %}
Your relays will be available in the form `switch.fantasticrelaydevice_individualrelayname`