Update configuration variables description (#6416)

* Update configuration variables description

* Change type back to list

* Fix value
This commit is contained in:
Fabian Affolter 2018-10-01 22:43:17 +02:00 committed by GitHub
parent 457390bbe4
commit cf23a4e263
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
3 changed files with 57 additions and 38 deletions

View File

@ -15,6 +15,8 @@ ha_release: 0.68
To get your [wirelesstag.net](http://wirelesstag.net) binary sensors working within Home Assistant, please follow the instructions for the general [WirelessTag component](/components/wirelesstag).
## {% linkable_title Configuration %}
To enable tags set up with your [wirelesstag.net](http://wirelesstag.net) account, add the following to your `configuration.yaml` file:
```yaml
@ -28,21 +30,30 @@ binary_sensor:
```
{% configuration %}
monitored_conditions:
description: The conditions types to monitor; valid values are specified below
required: true
type: list
monitored_conditions:
description: The conditions types to monitor.
required: true
type: list
keys:
presence:
description: On means in range, Off means out of range.
motion:
description: On when a movement was detected, Off when clear.
door:
description: On when a door is open, Off when the door is closed.
cold:
description: On means temperature become too cold, Off means normal.
heat:
description: On means hot, Off means normal.
dry:
description: On means too dry (humidity), Off means normal.
wet:
description: On means too wet (humidity), Off means normal.
light:
description: On means light detected, Off means no light.
moisture:
description: On means moisture detected (wet), Off means no moisture (dry).
battery:
description: On means tag battery is low, Off means normal.
{% endconfiguration %}
The following conditions can be monitored:
* (`presence`): On means in range, Off means out of range.
* (`motion`): On when a movement was detected, Off when clear.
* (`door`): On when a door is open, Off when the door is closed.
* (`cold`): On means temperature become too cold, Off means normal.
* (`heat`): On means hot, Off means normal.
* (`dry`): On means too dry (humidity), Off means normal.
* (`wet`): On means too wet (humidity), Off means normal.
* (`light`): On means light detected, Off means no light.
* (`moisture`): On means moisture detected (wet), Off means no moisture (dry).
* (`battery`): On means tag battery is low, Off means normal.

View File

@ -15,6 +15,8 @@ ha_release: 0.68
To get your [wirelesstag.net](http://wirelesstag.net) sensors working within Home Assistant, please follow the instructions for the general [WirelessTag component](/components/wirelesstag).
## {% linkable_title Configuration %}
To enable tags set up with your [wirelesstag.net](http://wirelesstag.net) account, add the following to your `configuration.yaml` file:
```yaml
@ -27,15 +29,18 @@ sensor:
```
{% configuration %}
monitored_conditions:
description: The metrics types to monitor; valid values are specified below
required: true
type: list
monitored_conditions:
description: The metrics types to monitor.
required: true
type: list
keys:
temperature:
description: Value is in Celsius or Fahrenheit (according to your settings at Tag Manager).
humidity:
description: "Humidity level in %."
moisture:
description: "Water level/soil moisture in % (applicable for Water Tag only)."
light:
description: Brightness in lux (if supported by tag).
{% endconfiguration %}
The following metrics can be monitored:
* (`temperature`): Value is in Celsius or Fahrenheit (according to your settings at Tag Manager).
* (`humidity`): Humidity level in %.
* (`moisture`): Water level/soil moisture in % (applicable for Water Tag only).
* (`light`): Brightness in lux (if supported by tag).

View File

@ -27,19 +27,22 @@ switch:
```
{% configuration %}
monitored_conditions:
description: The metrics types to control; valid values are specified below
required: true
type: list
monitored_conditions:
description: The metrics types to control.
required: true
type: list
keys:
temperature:
description: Control arm/disarm temperature monitoring.
humidity:
description: Control arm/disarm humidity monitoring.
motion:
description: Control arm/disarm motion and door open/close events monitoring.
light:
description: Control monitoring of light changes.
moisture:
description: Control monitoring of water level/soil moisture for water sensor.
{% endconfiguration %}
The following metrics can be controlled:
* (`temperature`): Control arm/disarm temperature monitoring.
* (`humidity`): Control arm/disarm humidity monitoring.
* (`motion`): Control arm/disarm motion and door open/close events monitoring.
* (`light`): Control monitoring of light changes.
* (`moisture`): Control monitoring of water level/soil moisture for water sensor.
Arm/Disarm of motion switch is required to receive motion and door binary sensors events.
Others are only needed if you want to receive push notifications from tags on a specific range of changes in temperature, humidity, light or moisture.