Skip to content

Commit cf23a4e

Browse files
authored
Update configuration variables description (#6416)
* Update configuration variables description * Change type back to list * Fix value
1 parent 457390b commit cf23a4e

File tree

3 files changed

+57
-38
lines changed

3 files changed

+57
-38
lines changed

source/_components/binary_sensor.wirelesstag.markdown

Lines changed: 27 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -15,6 +15,8 @@ ha_release: 0.68
1515

1616
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).
1717

18+
## {% linkable_title Configuration %}
19+
1820
To enable tags set up with your [wirelesstag.net](http://wirelesstag.net) account, add the following to your `configuration.yaml` file:
1921

2022
```yaml
@@ -28,21 +30,30 @@ binary_sensor:
2830
```
2931
3032
{% configuration %}
31-
monitored_conditions:
32-
description: The conditions types to monitor; valid values are specified below
33-
required: true
34-
type: list
33+
monitored_conditions:
34+
description: The conditions types to monitor.
35+
required: true
36+
type: list
37+
keys:
38+
presence:
39+
description: On means in range, Off means out of range.
40+
motion:
41+
description: On when a movement was detected, Off when clear.
42+
door:
43+
description: On when a door is open, Off when the door is closed.
44+
cold:
45+
description: On means temperature become too cold, Off means normal.
46+
heat:
47+
description: On means hot, Off means normal.
48+
dry:
49+
description: On means too dry (humidity), Off means normal.
50+
wet:
51+
description: On means too wet (humidity), Off means normal.
52+
light:
53+
description: On means light detected, Off means no light.
54+
moisture:
55+
description: On means moisture detected (wet), Off means no moisture (dry).
56+
battery:
57+
description: On means tag battery is low, Off means normal.
3558
{% endconfiguration %}
3659
37-
The following conditions can be monitored:
38-
39-
* (`presence`): On means in range, Off means out of range.
40-
* (`motion`): On when a movement was detected, Off when clear.
41-
* (`door`): On when a door is open, Off when the door is closed.
42-
* (`cold`): On means temperature become too cold, Off means normal.
43-
* (`heat`): On means hot, Off means normal.
44-
* (`dry`): On means too dry (humidity), Off means normal.
45-
* (`wet`): On means too wet (humidity), Off means normal.
46-
* (`light`): On means light detected, Off means no light.
47-
* (`moisture`): On means moisture detected (wet), Off means no moisture (dry).
48-
* (`battery`): On means tag battery is low, Off means normal.

source/_components/sensor.wirelesstag.markdown

Lines changed: 15 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -15,6 +15,8 @@ ha_release: 0.68
1515

1616
To get your [wirelesstag.net](http://wirelesstag.net) sensors working within Home Assistant, please follow the instructions for the general [WirelessTag component](/components/wirelesstag).
1717

18+
## {% linkable_title Configuration %}
19+
1820
To enable tags set up with your [wirelesstag.net](http://wirelesstag.net) account, add the following to your `configuration.yaml` file:
1921

2022
```yaml
@@ -27,15 +29,18 @@ sensor:
2729
```
2830
2931
{% configuration %}
30-
monitored_conditions:
31-
description: The metrics types to monitor; valid values are specified below
32-
required: true
33-
type: list
32+
monitored_conditions:
33+
description: The metrics types to monitor.
34+
required: true
35+
type: list
36+
keys:
37+
temperature:
38+
description: Value is in Celsius or Fahrenheit (according to your settings at Tag Manager).
39+
humidity:
40+
description: "Humidity level in %."
41+
moisture:
42+
description: "Water level/soil moisture in % (applicable for Water Tag only)."
43+
light:
44+
description: Brightness in lux (if supported by tag).
3445
{% endconfiguration %}
3546
36-
The following metrics can be monitored:
37-
38-
* (`temperature`): Value is in Celsius or Fahrenheit (according to your settings at Tag Manager).
39-
* (`humidity`): Humidity level in %.
40-
* (`moisture`): Water level/soil moisture in % (applicable for Water Tag only).
41-
* (`light`): Brightness in lux (if supported by tag).

source/_components/switch.wirelesstag.markdown

Lines changed: 15 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -27,19 +27,22 @@ switch:
2727
```
2828
2929
{% configuration %}
30-
monitored_conditions:
31-
description: The metrics types to control; valid values are specified below
32-
required: true
33-
type: list
30+
monitored_conditions:
31+
description: The metrics types to control.
32+
required: true
33+
type: list
34+
keys:
35+
temperature:
36+
description: Control arm/disarm temperature monitoring.
37+
humidity:
38+
description: Control arm/disarm humidity monitoring.
39+
motion:
40+
description: Control arm/disarm motion and door open/close events monitoring.
41+
light:
42+
description: Control monitoring of light changes.
43+
moisture:
44+
description: Control monitoring of water level/soil moisture for water sensor.
3445
{% endconfiguration %}
3546
36-
The following metrics can be controlled:
37-
38-
* (`temperature`): Control arm/disarm temperature monitoring.
39-
* (`humidity`): Control arm/disarm humidity monitoring.
40-
* (`motion`): Control arm/disarm motion and door open/close events monitoring.
41-
* (`light`): Control monitoring of light changes.
42-
* (`moisture`): Control monitoring of water level/soil moisture for water sensor.
43-
4447
Arm/Disarm of motion switch is required to receive motion and door binary sensors events.
4548
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.

0 commit comments

Comments
 (0)