Skip to content

Commit 873fc91

Browse files
sergeymaysakfrenck
sergeymaysak
authored and
frenck
committed
Wireless tags platform (home-assistant#5035)
* Docs for Wirelesstag platform. * Added Notes section. * Corrected list of push notifications events. * Removed malformed notes. * Removed nl. * Added icon. * Conformed docs to standards. * Corrected typos reported during PR review. * Fixed one last typo * Small change to force rebuild * Added ha_release: 0.67 and note how to make sure local push notifications are enabled. * ✏️ Tweaks * ✏️ Tweaks * ✏️ Tweaks * ✏️ Tweaks * Noted presence of Cloud Polling, added warning on https. * Corrected name of Tags Manager. * ⬆️ ha_release -> 0.68
1 parent c5cf0f2 commit 873fc91

File tree

5 files changed

+181
-0
lines changed

5 files changed

+181
-0
lines changed

‎source/_components/binary_sensor.wirelesstag.markdown

+48
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,48 @@
1+
---
2+
layout: page
3+
title: "WirelessTag Binary Sensor"
4+
description: "Instructions on how to integrate Wireless Tags sensors within Home Assistant."
5+
date: 2018-03-26 21:49
6+
comments: false
7+
sidebar: true
8+
sharing: true
9+
footer: true
10+
logo: wirelesstag.png
11+
ha_category: Binary Sensor
12+
ha_iot_class: "Local Push and Cloud Polling"
13+
ha_release: 0.68
14+
---
15+
16+
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).
17+
18+
To enable tags set up with your [wirelesstag.net](http://wirelesstag.net) account, add the following to your `configuration.yaml` file:
19+
20+
```yaml
21+
# Example configuration.yaml entry
22+
binary_sensor:
23+
- platform: wirelesstag
24+
monitored_conditions:
25+
- presence
26+
- door
27+
- low_battery
28+
```
29+
30+
{% configuration %}
31+
monitored_conditions:
32+
description: The conditions types to monitor; valid values are specified below
33+
required: true
34+
type: list
35+
{% endconfiguration %}
36+
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+
* (`low_battery`): On means tag battery is low, Off means normal.

‎source/_components/sensor.wirelesstag.markdown

+41
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,41 @@
1+
---
2+
layout: page
3+
title: "WirelessTag Sensor"
4+
description: "Instructions on how to integrate your Wireless Tags sensors within Home Assistant."
5+
date: 2018-03-26 21:50
6+
comments: false
7+
sidebar: true
8+
sharing: true
9+
footer: true
10+
logo: wirelesstag.png
11+
ha_category: Sensor
12+
ha_iot_class: "Local Push and Cloud Polling"
13+
ha_release: 0.68
14+
---
15+
16+
To get your [wirelesstag.net](http://wirelesstag.net) sensors working within Home Assistant, please follow the instructions for the general [WirelessTag component](/components/wirelesstag).
17+
18+
To enable tags set up with your [wirelesstag.net](http://wirelesstag.net) account, add the following to your `configuration.yaml` file:
19+
20+
```yaml
21+
# Example configuration.yaml entry
22+
sensor:
23+
- platform: wirelesstag
24+
monitored_conditions:
25+
- temperature
26+
- humidity
27+
```
28+
29+
{% configuration %}
30+
monitored_conditions:
31+
description: The metrics types to monitor; valid values are specified below
32+
required: true
33+
type: list
34+
{% endconfiguration %}
35+
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

+45
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,45 @@
1+
---
2+
layout: page
3+
title: "WirelessTag Switch"
4+
description: "Instructions on how to integrate your Wireless Tags sensors within Home Assistant."
5+
date: 2018-03-26 21:52
6+
comments: false
7+
sidebar: true
8+
sharing: true
9+
footer: true
10+
logo: wirelesstag.png
11+
ha_category: Switch
12+
ha_iot_class: "Local Push and Cloud Polling"
13+
ha_release: 0.68
14+
---
15+
16+
To get your [wirelesstag.net](http://wirelesstag.net) switches working within Home Assistant, please follow the instructions for the general [WirelessTag component](/components/wirelesstag).
17+
18+
To enable tags set up with your [wirelesstag.net](http://wirelesstag.net) account, add the following to your `configuration.yaml` file:
19+
20+
```yaml
21+
# Example configuration.yaml entry
22+
switch:
23+
- platform: wirelesstag
24+
monitored_conditions:
25+
- motion
26+
- humidity
27+
```
28+
29+
{% configuration %}
30+
monitored_conditions:
31+
description: The metrics types to control; valid values are specified below
32+
required: true
33+
type: list
34+
{% endconfiguration %}
35+
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+
44+
Arm/Disarm of motion switch is required to receive motion and door binary sensors events.
45+
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.

‎source/_components/wirelesstag.markdown

+47
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,47 @@
1+
---
2+
layout: page
3+
title: "WirelessTag"
4+
description: "Instructions on how to integrate your Wireless Tags sensors within Home Assistant."
5+
date: 2018-03-26 21:32
6+
comments: false
7+
sidebar: true
8+
sharing: true
9+
footer: true
10+
logo: wirelesstag.png
11+
ha_category: Hub
12+
ha_iot_class: "Local Push and Cloud Polling"
13+
ha_release: 0.68
14+
---
15+
16+
The `wirelesstag` implementation allows you to integrate your [wirelesstag.net](http://wirelesstag.net) sensors tags in Home Assistant.
17+
18+
To enable tags set up with your [wirelesstag.net](http://wirelesstag.net) account, add the following to your `configuration.yaml` file:
19+
20+
```yaml
21+
# Example configuration.yaml entry
22+
wirelesstag:
23+
username: [email protected]
24+
password: secret
25+
```
26+
27+
{% configuration %}
28+
username:
29+
description: Username for your [wirelesstag.net](http://wirelesstag.net) account.
30+
required: true
31+
type: string
32+
password:
33+
description: Password for your [wirelesstag.net](http://wirelesstag.net) account.
34+
required: true
35+
type: string
36+
{% endconfiguration %}
37+
38+
Finish your configuration by visiting the [WirelessTag binary sensor](/components/binary_sensor.wirelesstag/), [WirelessTag sensor](/components/sensor.wirelesstag/), or [WirelessTag switch](/components/switch.wirelesstag/) documentation.
39+
40+
<p class='note'>
41+
To enable local push notifications from the Tags Manager, you need to add the IP address of the Tags Manager into whitelist in `http` component; i.e., add it to `trusted_networks`. See the [HTTP](/components/http/) for details.
42+
Additionally, you need add at least one [WirelessTag binary sensor](/components/binary_sensor.wirelesstag/) in config to start receiving local push notifications.
43+
</p>
44+
45+
<p class='note warning'>
46+
Tags Manager supports local push notifications for `http` schema only. So if your hass uses `https`, local push notifications are disabled and data is received via cloud polling.
47+
</p>

‎source/images/supported_brands/wirelesstag.png

83.2 KB
Loading

0 commit comments

Comments
 (0)