Wireless tags platform (#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
This commit is contained in:
Sergiy Maysak 2018-06-17 22:27:44 +03:00 committed by Franck Nijhof
parent c5cf0f2445
commit 873fc918c8
5 changed files with 181 additions and 0 deletions

View File

@ -0,0 +1,48 @@
---
layout: page
title: "WirelessTag Binary Sensor"
description: "Instructions on how to integrate Wireless Tags sensors within Home Assistant."
date: 2018-03-26 21:49
comments: false
sidebar: true
sharing: true
footer: true
logo: wirelesstag.png
ha_category: Binary Sensor
ha_iot_class: "Local Push and Cloud Polling"
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).
To enable tags set up with your [wirelesstag.net](http://wirelesstag.net) account, add the following to your `configuration.yaml` file:
```yaml
# Example configuration.yaml entry
binary_sensor:
- platform: wirelesstag
monitored_conditions:
- presence
- door
- low_battery
```
{% configuration %}
monitored_conditions:
description: The conditions types to monitor; valid values are specified below
required: true
type: list
{% 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).
* (`low_battery`): On means tag battery is low, Off means normal.

View File

@ -0,0 +1,41 @@
---
layout: page
title: "WirelessTag Sensor"
description: "Instructions on how to integrate your Wireless Tags sensors within Home Assistant."
date: 2018-03-26 21:50
comments: false
sidebar: true
sharing: true
footer: true
logo: wirelesstag.png
ha_category: Sensor
ha_iot_class: "Local Push and Cloud Polling"
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).
To enable tags set up with your [wirelesstag.net](http://wirelesstag.net) account, add the following to your `configuration.yaml` file:
```yaml
# Example configuration.yaml entry
sensor:
- platform: wirelesstag
monitored_conditions:
- temperature
- humidity
```
{% configuration %}
monitored_conditions:
description: The metrics types to monitor; valid values are specified below
required: true
type: list
{% 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

@ -0,0 +1,45 @@
---
layout: page
title: "WirelessTag Switch"
description: "Instructions on how to integrate your Wireless Tags sensors within Home Assistant."
date: 2018-03-26 21:52
comments: false
sidebar: true
sharing: true
footer: true
logo: wirelesstag.png
ha_category: Switch
ha_iot_class: "Local Push and Cloud Polling"
ha_release: 0.68
---
To get your [wirelesstag.net](http://wirelesstag.net) switches working within Home Assistant, please follow the instructions for the general [WirelessTag component](/components/wirelesstag).
To enable tags set up with your [wirelesstag.net](http://wirelesstag.net) account, add the following to your `configuration.yaml` file:
```yaml
# Example configuration.yaml entry
switch:
- platform: wirelesstag
monitored_conditions:
- motion
- humidity
```
{% configuration %}
monitored_conditions:
description: The metrics types to control; valid values are specified below
required: true
type: list
{% 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.

View File

@ -0,0 +1,47 @@
---
layout: page
title: "WirelessTag"
description: "Instructions on how to integrate your Wireless Tags sensors within Home Assistant."
date: 2018-03-26 21:32
comments: false
sidebar: true
sharing: true
footer: true
logo: wirelesstag.png
ha_category: Hub
ha_iot_class: "Local Push and Cloud Polling"
ha_release: 0.68
---
The `wirelesstag` implementation allows you to integrate your [wirelesstag.net](http://wirelesstag.net) sensors tags in Home Assistant.
To enable tags set up with your [wirelesstag.net](http://wirelesstag.net) account, add the following to your `configuration.yaml` file:
```yaml
# Example configuration.yaml entry
wirelesstag:
username: you@example.com
password: secret
```
{% configuration %}
username:
description: Username for your [wirelesstag.net](http://wirelesstag.net) account.
required: true
type: string
password:
description: Password for your [wirelesstag.net](http://wirelesstag.net) account.
required: true
type: string
{% endconfiguration %}
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.
<p class='note'>
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.
Additionally, you need add at least one [WirelessTag binary sensor](/components/binary_sensor.wirelesstag/) in config to start receiving local push notifications.
</p>
<p class='note warning'>
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.
</p>

Binary file not shown.

After

Width:  |  Height:  |  Size: 83 KiB