jeans/home-assistant.io
jeans/home-assistant.io
1
0
Fork 0
mirror of https://github.com/home-assistant/home-assistant.io.git synced 2025-07-22 08:46:51 +00:00
Code Issues Packages Projects Releases Wiki Activity

Merge branch 'current' into next

Browse Source
This commit is contained in:
Franck Nijhof 2019-02-27 02:20:18 +01:00
commit f6e8408a81
No known key found for this signature in database
GPG Key ID: D62583BA8AB11CA3
45 changed files with 708 additions and 867 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

18
source/_components/binary_sensor.fibaro.markdown
View File

@ -1,18 +0,0 @@
---
layout: page
title: "Fibaro Binary Sensor"
description: "Instructions on how to integrate Fibaro binary sensors into Home Assistant."
date: 2018-11-14 23:00
sidebar: true
comments: false
sharing: true
footer: true
logo: fibaro.png
ha_category: Binary Sensor
ha_iot_class: "Local Push"
ha_release: 0.83
---
The `fibaro` platform allows you to get data from your [Fibaro](http://fibaro.com/) binary sensors connected to your Fibaro HCL or HC2 from within Home Assistant.
They will be automatically discovered if the `fibaro` component is loaded.

49
source/_components/binary_sensor.octoprint.markdown
View File

@ -1,49 +0,0 @@
---
layout: page
title: "OctoPrint Binary Sensor"
description: "Instructions on how to integrate OctoPrint binary sensors within Home Assistant."
date: 2016-05-05 08:00
sidebar: true
comments: false
sharing: true
footer: true
logo: octoprint.png
ha_category: Binary Sensor
ha_release: 0.19
ha_iot_class: "Local Polling"
---
The `octoprint` binary sensor platform let you monitor if your 3D printer is printing or if there was a printing error.
<p class='note'>
You must have the [OctoPrint component](/components/octoprint/) configured to use this binary sensor. After configuring that component, binary sensors automatically appear.
</p>
## {% linkable_title Configuration %}
To set it up, add the following information to your `configuration.yaml` file:
```yaml
binary_sensor:
- platform: octoprint
monitored_conditions:
- Printing
- Printing Error
```
{% configuration %}
monitored_conditions:
description: States to monitor.
required: true
type: list
keys:
printing:
description: State of the printer.
printing error:
description: Error while printing.
name:
description: The name of the sensor.
required: false
type: string
default: OctoPrint
{% endconfiguration %}

36
source/_components/binary_sensor.upcloud.markdown
View File

@ -1,36 +0,0 @@
---
layout: page
title: UpCloud Binary Sensor
description: Instructions on how to set up UpCloud binary sensors within Home Assistant.
date: 2018-01-28 20:00
sidebar: true
comments: false
sharing: true
footer: true
ha_category: System Monitor
logo: upcloud.png
ha_release: 0.65
ha_iot_class: Cloud Polling
---
The `upcloud` binary sensor platform allows you to monitor your UpCloud servers.
## {% linkable_title Configuration %}
To use your UpCloud servers, you first have to set up your [UpCloud hub](/components/upcloud/) and then add the following to your `configuration.yaml` file:
```yaml
# Example configuration.yaml entry
binary_sensor:
- platform: upcloud
servers:
- 002167b7-4cb1-44b7-869f-e0900ddeeae1
- 00886296-6137-4074-afe3-068e16d89d00
```
{% configuration %}
servers:
description: List of servers you want to monitor.
required: true
type: list
{% endconfiguration %}

58
source/_components/binary_sensor.wirelesstag.markdown
View File

@ -1,58 +0,0 @@
---
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).
## {% 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
# Example configuration.yaml entry
binary_sensor:
- platform: wirelesstag
monitored_conditions:
- presence
- door
- battery
```
{% configuration %}
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 %}

3
source/_components/camera.push.markdown
View File

@ -25,7 +25,8 @@ The `push` camera can as an example be used with [motionEye](https://github.com/
In motionEye, under **File Storage -> Run A Command** type in:
```bash
curl -X POST -F "image=@%f" http://my.hass.server.com:8123/api/webhook/my_custom_webhook_id
curl -X POST -F "image=@%f" http://my.hass.server.com:8123/api/webhoo\k/my_custom_webhook_id
# inserting a backslash in the middle of "webhook" stops Motion to move the command to a webhook
```
Optionally configure motionEye to save only motion triggered images by going into **Still Images -> Capture Mode** and setting **Motion Triggered**. Tune your preferences under **Motion Detection**.

32
source/_components/camera.usps.markdown
View File

@ -1,32 +0,0 @@
---
layout: page
title: USPS Camera
description: "Instructions on how to set up USPS camera within Home Assistant."
date: 2017-07-28 20:00
sidebar: true
comments: false
sharing: true
footer: true
logo: usps.png
ha_category: Camera
ha_release: 0.52
ha_iot_class: "Cloud Polling"
---
The `usps` camera component allows you to view the mail piece images made available through USPS via the Informed Delivery service. You must "Opt-In" to [Informed Delivery](https://informeddelivery.usps.com/box/pages/intro/start.action) to see mail images. This works in concert with [USPS sensors](/components/sensor.usps).
<p class='note'>
You must have the [USPS component](/components/usps/) configured to use this camera. The camera will be setup if the `usps` component is configured and the required configuration is set.
</p>
## {% linkable_title Configuration %}
To customize the interval that mail images are rotated in the mail camera you can edit your `configuration.yaml` file with the following settings:
```yaml
# Example configuration.yaml entry
camera:
- platform: usps
scan_interval: 5
```
To enable this camera in your installation, set up the [USPS component](/components/usps) with your username and password.

139
source/_components/climate.nuheat.markdown
View File

@ -1,139 +0,0 @@
---
layout: page
title: "NuHeat Thermostat"
description: "Instructions on how to integrate your NuHeat Signature thermostats within Home Assistant."
date: 2017-11-11 18:00
sidebar: true
comments: false
sharing: true
footer: true
logo: nuheat.png
ha_category: Climate
ha_release: 0.61
ha_iot_class: "Cloud Polling"
---
<p class='note'>
To get your [NuHeat Signature](http://www.nuheat.com/products/thermostats/signature-thermostat) thermostats working within Home Assistant, please follow the instructions for the general [NuHeat component](/components/nuheat)
</p>
## {% linkable_title Concepts %}
The NuHeat Thermostat supports the following key concepts.
The `target temperature` is the temperature that the device attempts to achieve. The target temperature is either determined by the schedule programmed into the thermostat (`auto mode`) or may be overridden. When the target temperature is set by Home Assistant, the thermostat will hold this temperature until the schedule is resumed.
## {% linkable_title Attributes %}
The following attributes are provided by the NuHeat thermostat: `name`, `temperature_unit`, `current_temperature`, `target_temperature`, `current_hold_mode`, `current_operation`, `operation_list`, `min_temp` and `max_temp`.
### {% linkable_title Attribute `name` %}
Returns the name of the NuHeat Thermostat.
| Attribute type | Description |
| ---------------| ----------- |
| String | Name of the thermostat
### {% linkable_title Attribute `temperature_unit` %}
Returns the unit of measurement used for temperature by the thermostat.
| Attribute type | Description |
| ---------------| ----------- |
| String | Name of the temperature unit
### {% linkable_title Attribute `current_temperature` %}
Returns the current temperature measured by the thermostat.
| Attribute type | Description |
| ---------------| ----------- |
| Integer | Currently measured temperature
### {% linkable_title Attribute `target_temperature` %}
Returns the target temperature of the thermostat, when the thermostat is
not in auto operation mode.
| Attribute type | Description |
| ---------------| ----------- |
| Integer | Target temperature
### {% linkable_title Attribute `current_hold_mode` %}
Returns the current temperature hold, if any.
| Attribute type | Description |
| ---------------| ----------- |
| String | 'temperature', 'temporary_temperature', 'auto', etc.
### {% linkable_title Attribute `current_operation` %}
Returns the current operation of the thermostat.
| Attribute type | Description |
| ---------------| ----------- |
| String | 'heat', 'idle'
### {% linkable_title Attribute `operation_list` %}
Returns the list of available operation modes.
| Attribute type | Description |
| ---------------| ----------- |
| List of String | Available operation modes
### {% linkable_title Attribute `min_temp` %}
Returns the minimum supported temperature by the thermostat
| Attribute type | Description |
| ---------------| ----------- |
| Integer | Minimum supported temperature
### {% linkable_title Attribute `max_temp` %}
Returns the maximum supported temperature by the thermostat
| Attribute type | Description |
| ---------------| ----------- |
| Integer | Maximum supported temperature
## {% linkable_title Services %}
The following services are provided by the NuHeat Thermostat: `set_temperature`, `set_hold_mode`, `nuheat_resume_program`.
The services `fan_min_on_time`, `set_aux_heat`, `set_away_mode`, `set_humidity`, `set_fan_mode`, `set_operation_mode` and `set_swing_mode` offered by the [Climate component](/components/climate/) are not implemented for this thermostat.
### {% linkable_title Service `set_temperature` %}
Puts the thermostat into an indefinite hold at the given temperature.
| Service data attribute | Optional | Description |
| ---------------------- | -------- | ----------- |
| `entity_id` | yes | String or list of strings that point at `entity_id`'s of climate devices to control. Else targets all.
| `temperature` | no | Desired target temperature (when not in auto mode)
Only the target temperatures relevant for the current operation mode need to
be provided.
### {% linkable_title Service `set_hold_mode` %}
Sets the thermostat's hold mode. The NuHeat thermostat supports "auto" (to run the thermostat's programmed schedule), "temperature" (to indefinitely hold the thermostat's current target temperature), or "temporary_temperature" (to hold the thermostat's current target temperature until the thermostat's next scheduled event).
| Service data attribute | Optional | Description |
| ---------------------- | -------- | ----------- |
| `entity_id` | yes | String or list of strings that point at `entity_id`'s of climate devices to control. Else targets all.
| `hold_mode` | no | New value of hold mode.
### {% linkable_title Service `nuheat_resume_program` %}
Resumes the currently active schedule.
| Service data attribute | Optional | Description |
| ---------------------- | -------- | ----------- |
| `entity_id` | yes | String or list of strings that point at `entity_id`'s of climate devices to control. Else targets all.

18
source/_components/cover.fibaro.markdown
View File

@ -1,18 +0,0 @@
---
layout: page
title: "Fibaro covers"
description: "Instructions on how to integrate Fibaro covers into Home Assistant."
date: 2018-11-14 23:00
sidebar: true
comments: false
sharing: true
footer: true
logo: fibaro.png
ha_category: Light
ha_iot_class: "Local Push"
ha_release: 0.83
---
The `fibaro` platform allows you to get data from your [Fibaro](http://fibaro.com/) covers connected to your Fibaro HCL or HC2 from within Home Assistant.
They will be automatically discovered if the `fibaro` component is loaded.

27
source/_components/device_tracker.locative.markdown
View File

@ -1,27 +0,0 @@
---
layout: page
title: "Locative"
description: "Instructions on how to use Locative to track devices in Home Assistant."
date: 2015-10-13 19:00
sidebar: true
comments: false
sharing: true
footer: true
logo: locative.png
ha_category: Presence Detection
ha_iot_class: "Cloud Push"
---
<p class='note'>
Locative is no longer under active development. See https://blog.locative.io/bye-everyone-df01871fe949
</p>
This platform allows you to detect presence using [Locative](https://my.locative.io/). Locative is an open source app for [iOS](https://github.com/LocativeHQ/ios-app) and [Android](https://github.com/LocativeHQ/Locative-Android) that allows users to set up a `GET` or `POST` request when a geofence is entered or exited. This can be configured with Home Assistant to update your location.
<p class='note'>
You must have the [Locative component](/components/locative/) configured to use this device tracker.
</p>
When you enter a geofence, your location name in Home Assistant will be set to the name of the geofence in Locative. When you exit a geofence, your location name in Home Assistant will be set to "not home".
To use Locative in combination with another device tracker, such as [Nmap](/components/device_tracker.nmap_tracker/) or [Netgear](/components/device_tracker.netgear/), fill in the `mac` field to the Locative entry in `known_devices.yaml` with the MAC address of the device you want to track. The state of the device will be determined by the source that reported last.

1
source/_components/device_tracker.snmp.markdown
View File

@ -31,6 +31,7 @@ The following OID examples pull the current MAC Address table from a router. Thi
| Mikrotik | unknown RouterOS version/model | `1.3.6.1.4.1.14988.1.1.1.2.1.1` |
| Mikrotik | RouterOS 6.x on RB2011 | `1.3.6.1.2.1.4.22.1.2` |
| OpenWrt | Chaos Calmer 15.05 | `1.3.6.1.2.1.4.22.1.2` |
| OPNSense | 19.1 | `1.3.6.1.2.1.4.22.1.2` |
| pfSense | 2.2.4 | `1.3.6.1.2.1.4.22.1.2` |
| Ruckus | ZoneDirector 9.13.3 | `1.3.6.1.4.1.25053.1.2.2.1.1.3.1.1.1.6` |
| TP-Link | Archer VR2600v | `1.3.6.1.2.1.3.1.1.2.19.1` |

25
source/_components/fibaro.markdown
View File

@ -8,16 +8,37 @@ comments: false
sharing: true
footer: true
logo: fibaro.png
ha_category: Hub
ha_category:
- Hub
- Binary Sensor
- Cover
- Light
- Sensor
- Scene
- Switch
ha_release: "0.83"
ha_iot_class: "Local Push"
redirect_from:
- /components/scene.fibaro/
- /components/binary_sensor.fibaro/
- /components/cover.fibaro/
- /components/light.fibaro/
- /components/sensor.fibaro/
- /components/switch.fibaro/
---
The [Fibaro](http://fibaro.com) hub is a controller mainly connecting to Z-Wave devices.
Binary sensors, switches, lights (including Dimmers), locks, sensors and covers are supported and will be automatically added when Home Assistant connects to your Fibaro controller.
There is currently support for the following device types within Home Assistant:
- Binary Sensor
- Cover
- Light
- Sensor
- Scene
- Switch
They will be automatically added when the `fibaro` hub is connected to Home Assistant.
## {% linkable_title Configuration %}

2
source/_components/graphite.markdown
View File

@ -23,7 +23,7 @@ graphite:
{% configuration %}
host:
description: IP address of your graphite host, e.g., http://192.168.1.10.
description: IP address of your graphite host, e.g., 192.168.1.10.
required: false
type: string
default: localhost

23
source/_components/habitica.markdown
View File

@ -8,13 +8,23 @@ comments: false
sharing: true
footer: true
logo: habitica.png
ha_category: Hub
ha_category:
- Hub
- Sensor
ha_version: 0.78
ha_iot_class: "Cloud Polling"
redirect_from:
- /components/sensor.habitica/
---
This component allows you to monitor and manage your Habitica profile. This component exposes the [Habitica's API](https://habitica.com/apidoc/) as a Home Assistant service. It supports multiple users and allows you to automate checking out your habits and daily tasks or casting magics using Home Assistant.
This component enables usage of [`sensor.habitica` platform.](/components/sensor.habitica/)
There is currently support for the following device types within Home Assistant:
- Sensor - Allows you to view and monitor your player data from [Habitica](https://habitica.com/) in Home Assistant.
The sensors will automatically appear, after setup the Habitica component.
To use the component you should use this example configuration:
```yaml
@ -79,15 +89,17 @@ For example, let's say that there is a configured `habitica` platform for user `
Let's create a new task (a todo) for this user via Home Assistant. There is an [API call](https://habitica.com/apidoc/#api-Task-CreateUserTasks) for this purpose.
To create a new task one should hit `https://habitica.com/api/v3/tasks/user` endpoint with `POST` request with a json object with task properties.
So let's call the API on `habitica.api_call`.
* The `name` key becomes `xxxNotAValidNickxxx`.
* The `path` key is trickier.
* Remove 'https://habitica.com/api/v3/' at the beginning of the endpoint URL.
* Split the remaining on slashes (/) and **append the lowercase method** at the end.
* You should get `["tasks", "user", "post"]`. To get a better idea of the API you are recommended to try all of the API calls in IPython console [using this package](https://github.com/ASMfreaK/habitipy/blob/master/README.md).
* Remove 'https://habitica.com/api/v3/' at the beginning of the endpoint URL.
* Split the remaining on slashes (/) and **append the lowercase method** at the end.
* You should get `["tasks", "user", "post"]`. To get a better idea of the API you are recommended to try all of the API calls in IPython console [using this package](https://github.com/ASMfreaK/habitipy/blob/master/README.md).
* The `args` key is more or less described in the [docs](https://habitica.com/apidoc/).
Combining all together:
call `habitica.api_call` with data
```
{
"name": "xxxNotAValidNickxxx",
@ -101,6 +113,7 @@ This call will create a new todo on `xxxNotAValidNickxxx`'s account with text `U
![example task created](/images/screenshots/habitica_new_task.png)
Also an event `habitica_api_call_success` will be fired with the following data:
```
{
"name": "xxxNotAValidNickxxx",

18
source/_components/light.fibaro.markdown
View File

@ -1,18 +0,0 @@
---
layout: page
title: "Fibaro Lights"
description: "Instructions on how to integrate Fibaro lights into Home Assistant."
date: 2018-11-14 23:00
sidebar: true
comments: false
sharing: true
footer: true
logo: fibaro.png
ha_category: Light
ha_iot_class: "Local Push"
ha_release: 0.83
---
The `fibaro` platform allows you to get data from your [Fibaro](http://fibaro.com/) lights connected to your Fibaro HCL or HC2 from within Home Assistant.
They will be automatically discovered if the `fibaro` component is loaded.

49
source/_components/light.mochad.markdown
View File

@ -1,49 +0,0 @@
---
layout: page
title: "Mochad Light"
description: "Instructions on how to integrate X10 Mochad lights into Home Assistant."
date: 2017-07-14 11:29
sidebar: true
comments: false
sharing: true
footer: true
ha_category: Light
ha_release: 0.51
---
The `mochad` light platform lets you control an X10 enabled dimmer/light device.
To enable this sensor, you first have to set up the [mochad component](/components/mochad/) and then add the following to your `configuration.yaml` file:
```yaml
# Example configuration.yaml entry
light:
- platform: mochad
devices:
- address: a1
- address: a5
```
{% configuration %}
address:
description: The X10 address of the light.
required: true
type: string
name:
description: The name of the light.
required: false
default: x10_light_dev_address
type: string
comm_type:
description: pl (powerline) or rf (radio frequency).
required: false
default: pl
type: string
brightness_levels:
description: The number of brightness levels the X10 light device supports. This can either be 32, 64, or 256 (note that the max value sent to the device will be n-1 because it starts at 0).
required: false
default: 32
type: integer
{% endconfiguration %}

6
source/_components/locative.md
View File

@ -11,10 +11,12 @@ logo: locative.png
ha_category: Presence Detection
ha_release: 0.86
ha_iot_class: "Cloud Push"
redirect_from:
- /components/device_tracker.locative/
---
<p class='note'>
Locative is no longer under active development. See https://blog.locative.io/bye-everyone-df01871fe949
Locative is no longer under active development. <a href="https://blog.locative.io/bye-everyone-df01871fe949">Read more here</a>
</p>
This platform allows you to detect presence using [Locative](https://my.locative.io/). Locative is an open source app for [iOS](https://github.com/LocativeHQ/ios-app) and [Android](https://github.com/LocativeHQ/Locative-Android) that allows users to set up a `GET` or `POST` request when a geofence is entered or exited. This can be configured with Home Assistant to update your location.
@ -31,3 +33,5 @@ To configure Locative, you must set it up via the integrations panel in the conf
</p>
When you enter a geofence, your location name in Home Assistant will be set to the name of the geofence in Locative. When you exit a geofence, your location name in Home Assistant will be set to "not home".
To use Locative in combination with another device tracker, such as [Nmap](/components/device_tracker.nmap_tracker/) or [Netgear](/components/device_tracker.netgear/), fill in the `mac` field to the Locative entry in `known_devices.yaml` with the MAC address of the device you want to track. The state of the device will be determined by the source that reported last.

82
source/_components/mochad.markdown
View File

@ -7,12 +7,23 @@ sidebar: true
comments: false
sharing: true
footer: true
ha_category: Hub
ha_category:
- Hub
- Light
- Switch
ha_release: 0.32
redirect_from:
- /components/light.mochad/
- /components/switch.mochad/
---
The `mochad` component is the main component to integrate all X10 platforms being controlled by [mochad](https://sourceforge.net/projects/mochad/). Besides this component you will have to setup your X10 devices separately.
There is currently support for the following device types within Home Assistant:
- [Light](#light)
- [Switch](#switch)
## {% linkable_title Configuration %}
To integrate your Mochad units with Home Assistant, add the following section to your `configuration.yaml` file:
@ -45,3 +56,72 @@ mochad:
host: localhost
port: 1099
```
## {% linkable_title Light %}
The `mochad` light platform lets you control an X10 enabled dimmer/light device.
To enable this sensor, you first have to set up the [mochad component](#configuration) and then add the following to your `configuration.yaml` file:
```yaml
# Example configuration.yaml entry
light:
- platform: mochad
devices:
- address: a1
- address: a5
```
{% configuration %}
address:
description: The X10 address of the light.
required: true
type: string
name:
description: The name of the light.
required: false
default: x10_light_dev_address
type: string
comm_type:
description: pl (powerline) or rf (radio frequency).
required: false
default: pl
type: string
brightness_levels:
description: The number of brightness levels the X10 light device supports. This can either be 32, 64, or 256 (note that the max value sent to the device will be n-1 because it starts at 0).
required: false
default: 32
type: integer
{% endconfiguration %}
## {% linkable_title Switch %}
The `mochad` switch platform lets you control an X10 enabled switch device.
To enable this sensor, you first have to set up the [mochad component](#configuration) and then add the following to your `configuration.yaml` file:
```yaml
# Example configuration.yaml entry
switch:
- platform: mochad
devices:
- address: a1
- address: a5
```
{% configuration %}
address:
description: The X10 address of the switch.
required: true
type: string
name:
description: The name of the switch.
required: false
default: x10_switch_dev_*address*
type: string
comm_type:
description: pl (powerline) or rf (radio frequency).
required: false
default: pl
type: string
{% endconfiguration %}

84
source/_components/netgear_lte.markdown
View File

@ -9,12 +9,23 @@ sharing: true
footer: true
logo: netgear.png
ha_release: 0.72
ha_category: Network
ha_category:
- Network
- Notifications
- Sensor
ha_iot_class: "Local Polling"
redirect_from:
- /components/notify.netgear_lte/
- /components/sensor.netgear_lte/
---
The Netgear LTE integration for Home Assistant allows you to observe and control [Netgear LTE modems](https://www.netgear.com/home/products/mobile-broadband/lte-modems/default.aspx), currently only tested with LB2120.
There is currently support for the following device types within Home Assistant:
- [Notifications](#notifications)
- [Sensor](#sensor)
The integration provides:
* a notify service that will send an SMS
@ -34,11 +45,70 @@ netgear_lte:
{% configuration %}
host:
description: The IP address of the modem web interface.
required: true
type: string
description: The IP address of the modem web interface.
required: true
type: string
password:
description: The password used for the modem web interface.
required: true
type: string
description: The password used for the modem web interface.
required: true
type: string
{% endconfiguration %}
## {% linkable_title Notifications %}
The `netgear_lte` platform allows you to use a Netgear LTE modem for notifications from Home Assistant. The message will be sent as an SMS text message.
```yaml
# Example configuration.yaml entry
notify:
- platform: netgear_lte
name: sms
target: "+15105550123"
```
{% configuration %}
target:
description: The phone number of a default recipient or a list with multiple recipients.
required: true
type: string, list
name:
description: Setting the optional parameter `name` allows multiple notifiers to be created.
required: false
default: notify
type: string
host:
description: The modem to use. Not needed if you only have one.
required: false
type: string
{% endconfiguration %}
## {% linkable_title Sensor %}
The `netgear_lte` sensor platform allows you to monitor your Netgear LTE modem.
To enable the sensor, add the following lines to your `configuration.yaml` file:
```yaml
# Example configuration.yaml entry
sensor:
- platform: netgear_lte
sensors:
- sms
- usage
```
{% configuration %}
sensors:
description: Sensor types to create.
required: true
type: list
keys:
sms:
description: Number of unread SMS messages in the modem inbox.
usage:
description: Amount of data transferred.
host:
description: The modem to use. Not needed if you only have one.
required: false
type: string
{% endconfiguration %}

41
source/_components/notify.netgear_lte.markdown
View File

@ -1,41 +0,0 @@
---
layout: page
title: "Netgear LTE Notify"
description: "Instructions on how to add Netgear LTE notifications to Home Assistant."
date: 2018-06-06 23:00
sidebar: true
comments: false
sharing: true
footer: true
logo: netgear.png
ha_category: Notifications
ha_release: 0.72
---
The `netgear_lte` platform allows you to use a Netgear LTE modem for notifications from Home Assistant. The message will be sent as an SMS text message.
This requires you to have set up the [Netgear LTE component](/components/netgear_lte/).
```yaml
# Example configuration.yaml entry
notify:
- platform: netgear_lte
name: sms
target: "+15105550123"
```
{% configuration %}
target:
description: The phone number of a default recipient or a list with multiple recipients.
required: true
type: string, list
name:
description: Setting the optional parameter `name` allows multiple notifiers to be created.
required: false
default: notify
type: string
host:
description: The modem to use. Not needed if you only have one.
required: false
type: string
{% endconfiguration %}

132
source/_components/nuheat.markdown
View File

@ -8,12 +8,19 @@ comments: false
sharing: true
footer: true
logo: nuheat.png
ha_category: Hub
ha_category:
- Climate
ha_release: 0.61
ha_iot_class: "Cloud Polling"
redirect_from:
- /components/climate.nuheat/
---
The `nuheat` component lets you control connected floor heating thermostats from [NuHeat](http://www.nuheat.com/).
The `nuheat` component lets control your connected [NuHeat Signature]([NuHeat Signature](http://www.nuheat.com/products/thermostats/signature-thermostat)) floor heating thermostats from [NuHeat](http://www.nuheat.com/).
There is currently support for the following device types within Home Assistant:
- Climate
First, you will need to obtain your thermostat's numeric serial number or ID by logging into [MyNuHeat.com](https://mynuheat.com/) and selecting your thermostat(s).
@ -49,3 +56,124 @@ devices:
required: true
type: [string, int]
{% endconfiguration %}
## {% linkable_title Concepts %}
The NuHeat Thermostat supports the following key concepts.
The `target temperature` is the temperature that the device attempts to achieve. The target temperature is either determined by the schedule programmed into the thermostat (`auto mode`) or may be overridden. When the target temperature is set by Home Assistant, the thermostat will hold this temperature until the schedule is resumed.
## {% linkable_title Attributes %}
The following attributes are provided by the NuHeat thermostat: `name`, `temperature_unit`, `current_temperature`, `target_temperature`, `current_hold_mode`, `current_operation`, `operation_list`, `min_temp` and `max_temp`.
### {% linkable_title Attribute `name` %}
Returns the name of the NuHeat Thermostat.
| Attribute type | Description |
| ---------------| ----------- |
| String | Name of the thermostat
### {% linkable_title Attribute `temperature_unit` %}
Returns the unit of measurement used for temperature by the thermostat.
| Attribute type | Description |
| ---------------| ----------- |
| String | Name of the temperature unit
### {% linkable_title Attribute `current_temperature` %}
Returns the current temperature measured by the thermostat.
| Attribute type | Description |
| ---------------| ----------- |
| Integer | Currently measured temperature
### {% linkable_title Attribute `target_temperature` %}
Returns the target temperature of the thermostat, when the thermostat is
not in auto operation mode.
| Attribute type | Description |
| ---------------| ----------- |
| Integer | Target temperature
### {% linkable_title Attribute `current_hold_mode` %}
Returns the current temperature hold, if any.
| Attribute type | Description |
| ---------------| ----------- |
| String | 'temperature', 'temporary_temperature', 'auto', etc.
### {% linkable_title Attribute `current_operation` %}
Returns the current operation of the thermostat.
| Attribute type | Description |
| ---------------| ----------- |
| String | 'heat', 'idle'
### {% linkable_title Attribute `operation_list` %}
Returns the list of available operation modes.
| Attribute type | Description |
| ---------------| ----------- |
| List of String | Available operation modes
### {% linkable_title Attribute `min_temp` %}
Returns the minimum supported temperature by the thermostat
| Attribute type | Description |
| ---------------| ----------- |
| Integer | Minimum supported temperature
### {% linkable_title Attribute `max_temp` %}
Returns the maximum supported temperature by the thermostat
| Attribute type | Description |
| ---------------| ----------- |
| Integer | Maximum supported temperature
## {% linkable_title Services %}
The following services are provided by the NuHeat Thermostat: `set_temperature`, `set_hold_mode`, `nuheat_resume_program`.
The services `fan_min_on_time`, `set_aux_heat`, `set_away_mode`, `set_humidity`, `set_fan_mode`, `set_operation_mode` and `set_swing_mode` offered by the [Climate component](/components/climate/) are not implemented for this thermostat.
### {% linkable_title Service `set_temperature` %}
Puts the thermostat into an indefinite hold at the given temperature.
| Service data attribute | Optional | Description |
| ---------------------- | -------- | ----------- |
| `entity_id` | yes | String or list of strings that point at `entity_id`'s of climate devices to control. Else targets all.
| `temperature` | no | Desired target temperature (when not in auto mode)
Only the target temperatures relevant for the current operation mode need to
be provided.
### {% linkable_title Service `set_hold_mode` %}
Sets the thermostat's hold mode. The NuHeat thermostat supports "auto" (to run the thermostat's programmed schedule), "temperature" (to indefinitely hold the thermostat's current target temperature), or "temporary_temperature" (to hold the thermostat's current target temperature until the thermostat's next scheduled event).
| Service data attribute | Optional | Description |
| ---------------------- | -------- | ----------- |
| `entity_id` | yes | String or list of strings that point at `entity_id`'s of climate devices to control. Else targets all.
| `hold_mode` | no | New value of hold mode.
### {% linkable_title Service `nuheat_resume_program` %}
Resumes the currently active schedule.
| Service data attribute | Optional | Description |
| ---------------------- | -------- | ----------- |
| `entity_id` | yes | String or list of strings that point at `entity_id`'s of climate devices to control. Else targets all.

52
source/_components/octoprint.markdown
View File

@ -8,14 +8,29 @@ comments: false
sharing: true
footer: true
logo: octoprint.png
ha_category: Hub
ha_category:
- Hub
- Binary Sensor
- Sensor
featured: false
ha_release: 0.19
ha_iot_class: "Local Polling"
redirect_from:
- /components/binary_sensor.octoprint/
- /components/sensor.octoprint/
---
[OctoPrint](http://octoprint.org/) is a web interface for your 3D printer. This is the main component to integrate OctoPrint sensors.
There is currently support for the following device types within Home Assistant:
- [Binary Sensor](#binary-sensor)
- [Sensor](#sensor)
<p class='note'>
You must have the <a href="#configuration">OctoPrint component</a> configured (below) to use the sensor and binary sensor. After configuring that component, the sensors and binary sensors automatically appear.
</p>
## {% linkable_title Configuration %}
To get started with the OctoPrint API, please follow the directions on their [site](http://docs.octoprint.org/en/master/api/general.html). Once OctoPrint is configured you will need to add your API key and host to your `configuration.yaml`.
@ -136,3 +151,38 @@ camera:
still_image_url: http://YOUR_OCTOPRINT_HOST_IP/webcam/?action=snapshot
mjpeg_url: http://YOUR_OCTOPRINT_HOST_IP/webcam/?action=stream
```
## {% linkable_title Binary Sensor %}
The `octoprint` binary sensor platform let you monitor if your 3D printer is printing or if there was a printing error.
To set it up, add the following information to your `configuration.yaml` file:
```yaml
binary_sensor:
- platform: octoprint
monitored_conditions:
- Printing
- Printing Error
```
{% configuration %}
monitored_conditions:
description: States to monitor.
required: true
type: list
keys:
printing:
description: State of the printer.
printing error:
description: Error while printing.
name:
description: The name of the sensor.
required: false
type: string
default: OctoPrint
{% endconfiguration %}
## {% linkable_title Sensor %}
The `octoprint` sensor platform let you monitor various states of your 3D printer and its print jobs.

6
source/_components/point.markdown
View File

@ -27,6 +27,12 @@ The Point hub enables integration with the [Minut Point](https://minut.com/). To
Once Home Assistant is started, a configurator will pop up asking you to Authenticate your Point account via a link. When you follow the link and click on **Accept** you will be redirected to the `callback url` and the Point integration will be automatically configured and you can go back to the original dialog and press **Submit**.
There is currently support for the following device types within Home Assistant:
- [Alarm](#alarm)
- [Binary Sensor](#binary-sensor)
- [Sensor](#sensor)
### {% linkable_title Configuration %}
```yaml

18
source/_components/sensor.fibaro.markdown
View File

@ -1,18 +0,0 @@
---
layout: page
title: "Fibaro sensors"
description: "Instructions on how to integrate Fibaro sensors into Home Assistant."
date: 2018-11-14 23:00
sidebar: true
comments: false
sharing: true
footer: true
logo: fibaro.png
ha_category: Light
ha_iot_class: "Local Push"
ha_release: 0.83
---
The `fibaro` platform allows you to get data from your [Fibaro](http://fibaro.com/) sensors connected to your Fibaro HCL or HC2 from within Home Assistant.
They will be automatically discovered if the `fibaro` component is loaded.

21
source/_components/sensor.habitica.markdown
View File

@ -1,21 +0,0 @@
---
layout: page
title: "Habitica Sensor"
description: "Instructions on enabling Habitica support for your Home Assistant"
date: 2018-08-09 00:00
sidebar: true
comments: false
sharing: true
footer: true
logo: habitica.png
ha_category: Sensor
ha_iot_class: "Cloud Polling"
ha_version: 0.78
---
The `habitica` sensor platform allows you to view and monitor your player data from [Habitica](https://habitica.com/) in Home Assistant.
<p class='note'>
You must have the [`habitica` component](/components/habitica/)
configured to use this platform. After configuring that component, sensors specified there will automatically appear.
</p>

27
source/_components/sensor.imap_email_content.markdown
View File

@ -13,7 +13,6 @@ ha_iot_class: "Cloud Push"
ha_release: 0.25
---
The `imap_email_content` sensor platform will read emails from an IMAP email server and report them as a state change within Home Assistant. This is useful if you have a device that only reports its state via email.
## {% linkable_title Configuration %}
@ -78,3 +77,29 @@ value_template:
date:
description: The date and time the email was sent.
{% endconfiguration %}
## {% linkable_title Example %}
The following example shows the usage of the IMAP email content sensor to scan the subject of an email for text, in this case, an email from the APC SmartConnect service which tells whether the UPS is running on battery or not.
{% raw %}
```yaml
sensor:
- platform: imap_email_content
server: imap.gmail.com
name: house_electricity
port: 993
username: MY_EMAIL_USERNAME
password: MY_EMAIL_PASSWORD
senders:
- no-reply@smartconnect.apc.com
value_template: >-
{% if 'UPS On Battery' in subject %}
power_out
{% elif 'Power Restored' in subject %}
power_on
{% endif %}
```
{% endraw %}
The same template structure can scan the date, body, or sender for matching text before setting the state of the sensor.

47
source/_components/sensor.netgear_lte.markdown
View File

@ -1,47 +0,0 @@
---
layout: page
title: "Netgear LTE Sensor"
description: "Instructions on how to integrate Netgear LTE sensors into Home Assistant."
date: 2018-06-06 23:00
sidebar: true
comments: false
sharing: true
footer: true
logo: netgear.png
ha_release: 0.72
ha_category: Network
ha_iot_class: "Local Polling"
---
The `netgear_lte` sensor platform allows you to monitor your Netgear LTE modem.
This requires you to have set up the [Netgear LTE component](/components/netgear_lte/).
## {% linkable_title Configuration %}
To enable the sensor, add the following lines to your `configuration.yaml` file:
```yaml
# Example configuration.yaml entry
sensor:
- platform: netgear_lte
sensors:
- sms
- usage
```
{% configuration %}
sensors:
description: Sensor types to create.
required: true
type: list
keys:
sms:
description: Number of unread SMS messages in the modem inbox.
usage:
description: Amount of data transferred.
host:
description: The modem to use. Not needed if you only have one.
required: false
type: string
{% endconfiguration %}

21
source/_components/sensor.octoprint.markdown
View File

@ -1,21 +0,0 @@
---
layout: page
title: "OctoPrint Sensor"
description: "Instructions on how to integrate OctoPrint sensors within Home Assistant."
date: 2016-05-05 08:00
sidebar: true
comments: false
sharing: true
footer: true
logo: octoprint.png
ha_category: Sensor
ha_release: 0.19
ha_iot_class: "Local Polling"
---
The `octoprint` sensor platform let you monitor various states of your 3D printer and its print jobs.
<p class='note'>
You must have the [OctoPrint component](/components/octoprint/) configured to use this sensor. After configuring that component, sensors automatically appear.
</p>

33
source/_components/sensor.rejseplanen.markdown
View File

@ -1,7 +1,7 @@
---
layout: page
title: "Rejseplanen Public Transport"
description: "Instructions on how to integrate timetable data for danish Rejseplanen within Home Assistant."
description: "Instructions on how to integrate timetable data for Danish Rejseplanen within Home Assistant."
date: 2019-01-09 08:52
sidebar: true
comments: false
@ -13,7 +13,7 @@ ha_iot_class: "Cloud Polling"
ha_release: 0.88
---
The `rejseplanen` sensor will provide you with traveling details for Danish public transport, using timetable data from [Rejseplanen](https://www.rejseplanen.dk/).
The `rejseplanen` sensor will provide you with travel details for Danish public transport, using timetable data from [Rejseplanen](https://www.rejseplanen.dk/).
## {% linkable_title Configuration %}
@ -61,6 +61,35 @@ departure_type:
type: string|list
{% endconfiguration %}
## {% linkable_title Direction %}
If you use the direction filter it's important to put correct destination, or else the sensor will not work at all.
The direction has to be the destination(s) for the transport type(s) for the departure stop destination, and NOT the stop where you want to get off. Check <http://rejseplanen.dk> and make a search, and use the destinations from there in your configuration. Make sure you use the exact name as the destination(s)
A working example on how to use this sensor with direction:
```yaml
# Example configuration.yaml entry with the correct use of direction.
sensor:
- platform: rejseplanen
stop_id: '008600615'
direction:
- 'CPH Lufthavn'
- 'Helsingør St.'
```
A NOT WORKING example use this sensor with direction:
```yaml
# Example configuration.yaml entry with the correct use of direction.
sensor:
- platform: rejseplanen
stop_id: '008600615'
direction:
- 'København H'
```
It fails because the destination from the departure is NOT København H, but 'CPH Lufthavn', 'Helsingør St.' and others.
## {% linkable_title Examples %}
A more extensive example on how to use this sensor:

18
source/_components/sensor.usps.markdown
View File

@ -1,18 +0,0 @@
---
layout: page
title: USPS Sensor
description: "Instructions on how to set up USPS sensors within Home Assistant."
date: 2017-01-06 08:00
sidebar: true
comments: false
sharing: true
footer: true
logo: usps.png
ha_category: Postal Service
ha_release: 0.36
ha_iot_class: "Cloud Polling"
---
The `usps` sensor component allows you to view statistics on incoming mail and packages made available through USPS via the Informed Delivery service. You must "Opt-In" to [Informed Delivery](https://informeddelivery.usps.com/box/pages/intro/start.action) to see mail images. This works in concert with [USPS camera](/components/camera.usps).
To enable this sensor in your installation, set up the [USPS component](/components/usps) with your username and password.

45
source/_components/sensor.wirelesstag.markdown
View File

@ -1,45 +0,0 @@
---
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).
## {% 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
# Example configuration.yaml entry
sensor:
- platform: wirelesstag
monitored_conditions:
- temperature
- humidity
```
{% configuration %}
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 %}

10
source/_components/smhi.markdown
View File

@ -8,13 +8,21 @@ comments: false
sharing: true
footer: true
logo: smhi.png
ha_category: Hub
ha_category:
- Hub
- Weather
ha_release: 0.81
ha_iot_class: "Cloud Polling"
redirect_from:
- /components/weather.smhi/
---
The `smhi` component adds support for the [SMHI.se](https://www.smhi.se/) web service as a source for meteorological data for your location.
There is currently support for the following device types within Home Assistant:
- Weather
## {% linkable_title Configuration %}
The SMHI weather service is free under the Creative Commons Attribution 4.0, international license. Weather data will be pulled once every 30 minutes.

24
source/_components/switch.edimax.markdown
View File

@ -12,7 +12,7 @@ ha_category: Switch
ha_release: pre 0.7
---
This `edimax` switch platform allows you to control the state of your [Edimax](http://www.edimax.com/edimax/merchandise/merchandise_list/data/edimax/global/home_automation_smart_plug/) switches.
This `edimax` switch platform allows you to control the state of your [Edimax](https://www.edimax.com/edimax/merchandise/merchandise_list/data/edimax/global/home_automation_smart_plug/) switches.
To use your Edimax switch in your installation, add the following to your `configuration.yaml` file:
@ -44,3 +44,25 @@ name:
default: Edimax Smart Plug
type: string
{% endconfiguration %}
## {% linkable_title Power consumption sensor %}
Starting with [version 2 of the firmware](https://www.edimax.com/edimax/download/download/data/edimax/global/download/), the Edimax switches can also report the current and accumulated daily power consumption in their state objects. Use a [template sensor](/components/sensor.template/) to extract their values:
{% raw %}
```yaml
- platform: template
sensors:
edimax_current_power:
friendly_name: Edimax Current power consumption
unit_of_measurement: 'W'
value_template: "{{ state_attr('switch.edimax_smart_plug', 'current_power_w') | replace('None', 0) }}"
edimax_total_power:
friendly_name: Edimax Accumulated daily power consumption
unit_of_measurement: 'kWh'
value_template: "{{ state_attr('switch.edimax_smart_plug', 'today_energy_kwh') | replace('None', 0) }}"
```
{% endraw %}
Note that if the smart plug is off, these states report the string `None`. By using a `replace()` in the template, these sensors report purely numerical values.

18
source/_components/switch.fibaro.markdown
View File

@ -1,18 +0,0 @@
---
layout: page
title: "Fibaro switches"
description: "Instructions on how to integrate Fibaro switches into Home Assistant."
date: 2018-11-14 23:00
sidebar: true
comments: false
sharing: true
footer: true
logo: fibaro.png
ha_category: Light
ha_iot_class: "Local Push"
ha_release: 0.83
---
The `fibaro` platform allows you to get data from your [Fibaro](http://fibaro.com/) switches connected to your Fibaro HCL or HC2 from within Home Assistant.
They will be automatically discovered if the `fibaro` component is loaded.

45
source/_components/switch.mochad.markdown
View File

@ -1,45 +0,0 @@
---
layout: page
title: "Mochad Switch"
description: "Instructions on how to integrate X10 Mochad switches into Home Assistant."
date: 2016-10-20 21:13
sidebar: true
comments: false
sharing: true
footer: true
ha_category: Switch
ha_iot_class: depends
ha_release: 0.32
---
The `mochad` switch platform lets you control an X10 enabled switch device.
## {% linkable_title Configuration %}
To enable this sensor, you first have to set up the [mochad component](/components/mochad/) and then add the following to your `configuration.yaml` file:
```yaml
# Example configuration.yaml entry
switch:
- platform: mochad
devices:
- address: a1
- address: a5
```
{% configuration %}
address:
description: The X10 address of the switch.
required: true
type: string
name:
description: The name of the switch.
required: false
default: x10_switch_dev_*address*
type: string
comm_type:
description: pl (powerline) or rf (radio frequency).
required: false
default: pl
type: string
{% endconfiguration %}

36
source/_components/switch.upcloud.markdown
View File

@ -1,36 +0,0 @@
---
layout: page
title: UpCloud Switch
description: Instructions on how to set up UpCloud switches within Home Assistant.
date: 2018-01-28 20:00
sidebar: true
comments: false
sharing: true
footer: true
logo: upcloud.png
ha_category: System Monitor
ha_release: 0.65
ha_iot_class: Cloud Polling
---
The `upcloud` switch platform allows you to control (start/stop) your UpCloud servers.
## {% linkable_title Configuration %}
To use your UpCloud servers, you first have to set up your [UpCloud hub](/components/upcloud/) and then add the following to your `configuration.yaml` file:
```yaml
# Example configuration.yaml entry
switch:
- platform: upcloud
servers:
- 002167b7-4cb1-44b7-869f-e0900ddeeae1
- 00886296-6137-4074-afe3-068e16d89d00
```
{% configuration %}
servers:
description: List of servers you want to control.
required: true
type: list
{% endconfiguration %}

48
source/_components/switch.wirelesstag.markdown
View File

@ -1,48 +0,0 @@
---
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.
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 %}
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.

4
source/_components/timer.markdown
View File

@ -85,7 +85,7 @@ Pause a running timer. This will retain the remaining duration for later continu
| ---------------------- | -------- | ----------- |
| `entity_id` | no | Name of the entity to take action, e.g., `timer.timer0`. |
#### {% linkable_title Service `timer.cancel` %}
### {% linkable_title Service `timer.cancel` %}
Cancel an active timer. This resets the duration to the last known initial value without firing the `timer.finished` event. You can also use `entity_id: all` and all active timers will be canceled.
@ -93,7 +93,7 @@ Cancel an active timer. This resets the duration to the last known initial value
| ---------------------- | -------- | ----------- |
| `entity_id` | no | Name of the entity to take action, e.g., `timer.timer0`. |
#### {% linkable_title Service `timer.finish` %}
### {% linkable_title Service `timer.finish` %}
Manually finish a running timer earlier than scheduled. You can also use `entity_id: all` and all active timers will be finished.

57
source/_components/upcloud.markdown
View File

@ -7,14 +7,25 @@ sidebar: true
comments: false
sharing: true
footer: true
ha_category: System Monitor
ha_category:
- System Monitor
- Binary Sensor
- Switch
ha_release: 0.65
logo: upcloud.png
ha_iot_class: Cloud Polling
redirect_from:
- /components/binary_sensor.upcloud/
- /components/switch.upcloud/
---
The `upcloud` component allows you to access the information about your [UpCloud](https://www.upcloud.com/) servers from Home Assistant.
There is currently support for the following device types within Home Assistant:
- [Binary Sensor](#binary-sensor)
- [Switch](#switch)
## {% linkable_title Setup %}
Set up your API user credentials in your [UpCloud control panel](https://my.upcloud.com/).
@ -45,3 +56,47 @@ scan_interval:
type: integer
default: 60
{% endconfiguration %}
## {% linkable_title Binary Sensor %}
The `upcloud` binary sensor platform allows you to monitor your UpCloud servers.
To use your UpCloud servers, you first have to set up your [UpCloud hub](#configuration) and then add the following to your `configuration.yaml` file:
```yaml
# Example configuration.yaml entry
binary_sensor:
- platform: upcloud
servers:
- 002167b7-4cb1-44b7-869f-e0900ddeeae1
- 00886296-6137-4074-afe3-068e16d89d00
```
{% configuration %}
servers:
description: List of servers you want to monitor.
required: true
type: list
{% endconfiguration %}
## {% linkable_title Switch %}
The `upcloud` switch platform allows you to control (start/stop) your UpCloud servers.
To use your UpCloud servers, you first have to set up your [UpCloud hub](#configuration) and then add the following to your `configuration.yaml` file:
```yaml
# Example configuration.yaml entry
switch:
- platform: upcloud
servers:
- 002167b7-4cb1-44b7-869f-e0900ddeeae1
- 00886296-6137-4074-afe3-068e16d89d00
```
{% configuration %}
servers:
description: List of servers you want to control.
required: true
type: list
{% endconfiguration %}

42
source/_components/usps.markdown
View File

@ -8,29 +8,40 @@ comments: false
sharing: true
footer: true
logo: usps.png
ha_category: Postal Service
ha_category:
- Postal Service
- Camera
- Sensor
ha_release: 0.52
ha_iot_class: "Cloud Polling"
redirect_from:
- /components/camera.usps/
- /components/sensor.usps/
---
The `usps` platform allows one to track deliveries and inbound mail from the [US Postal Service (USPS)](https://www.usps.com/).
In addition to having a USPS account, you will need to complete the "Opt-In" process for packages by clicking "Get Started Now" on [this page](https://my.usps.com/mobileWeb/pages/intro/start.action). You must also "Opt-In" to [Informed Delivery](https://informeddelivery.usps.com/box/pages/intro/start.action) to see inbound mail.
There is currently support for the following device types within Home Assistant:
- [Camera](#camera)
- [Sensor](#sensor)
## {% linkable_title Prerequisites %}
This component requires that a headless-capable web browser is installed on your system - either PhantomJS or Google Chrome. Preferably use Chrome if your operating system supports it, since PhantomJS is deprecated.
<p class='note warning'>
If you are using a Raspberry Pi, you must use PhantomJS.
If you are using a Raspberry Pi, you must use PhantomJS.
</p>
<p class='note warning'>
Hass.io containers are based on Alpine Linux. PhanthomJS is not available for Alpine Linux. Therefore it is currently not possible to use this component on Hass.io.
Hass.io containers are based on Alpine Linux. PhanthomJS is not available for Alpine Linux. Therefore it is currently not possible to use this component on Hass.io.
</p>
### {% linkable_title PhantomJS %}
Install the latest version of [PhantomJS]( http://phantomjs.org/download.html). Ensure the executable is on your `PATH`. `phantomjs --version` should work and report the correct version. This is the default option and requires no further configuration.
Install the latest version of [PhantomJS](http://phantomjs.org/download.html). Ensure the executable is on your `PATH`. `phantomjs --version` should work and report the correct version. This is the default option and requires no further configuration.
<p class='note warning'>
Don't use apt-get to install PhantomJS. This version is not compatible.
@ -86,3 +97,26 @@ name:
<p class='note warning'>
The USPS sensor logs into the MyUSPS website to scrape package data. It does not use an API.
</p>
## {% linkable_title Camera %}
The `usps` camera component allows you to view the mail piece images made available through USPS via the Informed Delivery service. You must "Opt-In" to [Informed Delivery](https://informeddelivery.usps.com/box/pages/intro/start.action) to see mail images. This works in concert with [USPS sensors](#sensor).
### {% linkable_title Configuration %}
To customize the interval that mail images are rotated in the mail camera you can edit your `configuration.yaml` file with the following settings:
```yaml
# Example configuration.yaml entry
camera:
- platform: usps
scan_interval: 5
```
To enable this camera in your installation, set up the USPS component first.
## {% linkable_title Sensor %}
The `usps` sensor component allows you to view statistics on incoming mail and packages made available through USPS via the Informed Delivery service. You must "Opt-In" to [Informed Delivery](https://informeddelivery.usps.com/box/pages/intro/start.action) to see mail images. This works in concert with [USPS camera](#camera).
To enable this sensor in your installation, set up the USPS component first.

4
source/_components/velux.markdown
View File

@ -35,7 +35,7 @@ A `velux` section must be present in the `configuration.yaml` file and contain t
# Example configuration.yaml entry
velux:
host: "192.168.1.23"
password: "velux123"
password: "VELUX_PASSWORD"
```
{% configuration %}
@ -44,7 +44,7 @@ host:
required: true
type: string
password:
description: The password of the KLF 200 interface.
description: The password of the KLF 200 interface. Note that this is the same as the WiFi password (in the upper box on the back), *not* the password for the web login.
required: true
type: string
{% endconfiguration %}

20
source/_components/weather.smhi.markdown
View File

@ -1,20 +0,0 @@
---
layout: page
title: "SMHI Weather"
description: "Instructions on how to integrate SMHI forecasts within Homeassistant."
date: 2018-09-23 20:00
sidebar: true
comments: false
sharing: true
footer: true
logo: smhi.png
ha_category: Weather
ha_release: 0.81
ha_iot_class: "Cloud Polling"
---
The `smhi` platform uses the [SMHI.se](https://www.smhi.se/) web service as a source for meteorological data for your location.
## {% linkable_title Configuration %}
Please see the [component](/components/smhi/) documentation for details and configuration.

125
source/_components/wirelesstag.markdown
View File

@ -8,13 +8,27 @@ sidebar: true
sharing: true
footer: true
logo: wirelesstag.png
ha_category: Hub
ha_category:
- Hub
- Binary Sensor
- Sensor
- Switch
ha_iot_class: "Local Push and Cloud Polling"
ha_release: 0.68
redirect_from:
- /components/binary_sensor.wirelesstag/
- /components/sensor.wirelesstag/
- /components/switch.wirelesstag/
---
The `wirelesstag` implementation allows you to integrate your [wirelesstag.net](http://wirelesstag.net) sensors tags in Home Assistant.
There is currently support for the following device types within Home Assistant:
- [Binary Sensor](#binary-sensor)
- [Sensor](#sensor)
- [Switch](#switch)
## {% linkable_title Configuration %}
To enable tags set up with your [wirelesstag.net](http://wirelesstag.net) account, add the following to your `configuration.yaml` file:
@ -37,13 +51,116 @@ password:
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.
Additionally, you need add at least one [WirelessTag binary sensor](#binary-sensor) 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>
## {% linkable_title Binary Sensor %}
To enable the binary sensor platform for your 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
- battery
```
{% configuration %}
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 %}
## {% linkable_title Sensor %}
To enable the sensor platform for your 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.
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 %}
## {% linkable_title Switch %}
To enable the switch platform for your 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.
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 %}
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.

6
source/_docs/automation.markdown
View File

@ -49,7 +49,9 @@ Actions are all about calling services. To explore the available services open t
### {% linkable_title Automation initial state %}
If you always want your automations to be set to a certain enabled or disabled state upon Home Assistant restart, then you have to set an initial state in your automations. Otherwise, this setting is optional.
If you always want your automations to be enabled or disabled upon Home Assistant restart, then you have to set an initial state in your automations. Otherwise the previous state will be restored.
If an automation is disabled (turned off) then it will never trigger. Only automations that are enabled (turned on) will trigger.
```text
automation:
@ -58,5 +60,3 @@ automation:
trigger:
...
```
If you don't set this then the previous state prior to restart is restored. However, if you shut down Home Assistant again before it finishes starting, any automation that doesn't have the initial state set to `true` will be stored as being off, and those automations will be disabled at the next startup.

2
source/_docs/configuration.markdown
View File

@ -36,7 +36,7 @@ If you run into trouble while configuring Home Assistant, have a look at the [co
## {% linkable_title Reloading changes %}
You will have to restart Home Assistant for most changes to `configuration.yaml` to take effect.
You can load changes to [automations](/docs/automation/), [customize](/docs/configuration/customizing-devices/), [groups](/components/group/), and [scripts](/components/script/) without restarting.
You can load changes to [automations](/docs/automation/), [core (customize)](/docs/configuration/customizing-devices/), [groups](/components/group/), and [scripts](/components/script/) without restarting.
<p class='note warning'>
If you've made any changes, remember to [check your configuration](/docs/configuration/troubleshooting/#problems-with-the-configuration) before trying to reload or restart.

3
source/_docs/ecosystem/ios/notifications/actions.markdown
View File

@ -132,8 +132,7 @@ automation:
platform: event
event_type: ios.notification_action_fired
event_data:
data:
actionName: SOUND_ALARM
actionName: SOUND_ALARM
action:
...
```