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-23 01:06:52 +00:00
Code Issues Packages Projects Releases Wiki Activity

Merge pull request #1 from home-assistant/current

Browse Source 
Update fork Current
This commit is contained in:
javicalle 2018-10-28 13:28:55 +01:00 committed by GitHub
commit 7df3074f66
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
554 changed files with 10251 additions and 3401 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
.github/PULL_REQUEST_TEMPLATE.md vendored
View File

@ -6,6 +6,6 @@
## Checklist:
- [ ] Branch: `next` is for changes and new documentation that will go public with the next [home-assistant](https://github.com/home-assistant/home-assistant) release. Fixes, changes and adjustments for the current release should be created against `current`.
- [ ] The documentation follow the [standards][standards].
- [ ] The documentation follows the [standards][standards].
[standards]: https://home-assistant.io/developers/documentation/standards/
[standards]: https://developers.home-assistant.io/docs/documentation_standards.html

4
README.markdown
View File

@ -1,6 +1,6 @@
[![Discord](https://img.shields.io/discord/330944238910963714.svg)](https://discord.gg/CxqDrfU)
[![Travis branch](https://img.shields.io/travis/home-assistant/home-assistant.github.io/next.svg)](https://travis-ci.org/home-assistant/home-assistant.github.io)
[![Krihelimeter](http://www.krihelinator.xyz/badge/home-assistant/home-assistant.github.io)](http://www.krihelinator.xyz)
[![Krihelimeter](https://img.shields.io/badge/Krihelimeter-unknown-brightgreen.svg)](http://www.krihelinator.xyz)
[![License: CC BY-NC-SA 4.0](https://img.shields.io/badge/License-CC%20BY--NC--SA%204.0-lightgrey.svg)](https://creativecommons.org/licenses/by-nc-sa/4.0/)
# Home Assistant website
@ -9,7 +9,7 @@ This is the source for the [Home-Assistant.io website](https://home-assistant.io
## Setup
Setting up to contribute to documentation and the process for submitting pull requests is [explained here](https://home-assistant.io/developers/documentation/).
Setting up to contribute to documentation and the process for submitting pull requests is explained in the [developer documentation](https://developers.home-assistant.io/docs/documentation_index.html).
## Site preview

11
_config.yml
View File

@ -141,17 +141,20 @@ social:
# Home Assistant release details
current_major_version: 0
current_minor_version: 80
current_patch_version: 0
date_released: 2018-10-12
current_minor_version: 81
current_patch_version: 1
date_released: 2018-10-28
# Either # or the anchor link to latest release notes in the blog post.
# Must be prefixed with a # and have double quotes around it.
# Major release:
patch_version_notes: "#"
patch_version_notes: "#release-0811---october-28"
# Minor release (Example #release-0431---april-25):
# Date we moved to Discourse for comments
# disqus_end_date: 2018-01-26 0:00:00
# Disqus is adding gross ads, move all comments to discourse.
disqus_end_date: 2010-01-26 0:00:00
# Support .well-known directory
include: [".well-known"]

13
source/.well-known/apple-app-site-association Normal file
View File

@ -0,0 +1,13 @@
{
"applinks": {
"apps": [],
"details": [
{
"appID": "UTQFCBPQRF.io.robbie.HomeAssistant",
"paths": [
"/ios/*"
]
}
]
}
}

86
source/_addons/configurator.markdown
View File

@ -57,27 +57,77 @@ Screenshot of the HASS Configurator.
],
"dirsfirst": false,
"enforce_basepath": false,
"notify_service": "persistent_notification.create",
"ignore_ssl": false
"notify_service": "persistent_notification.create"
}
```
- **username** (*Required*): Set a username to access your configuration is protected.
- **password** (*Required*): Set a password for access.
- **ssl** (*Required*): Enable or Disable SSL/TLS for the editor.
- **certfile** (*Required*): Set the path the your SSL certificate if the ssl-option is set to `true`.
- **keyfile** (*Required*): Set the path the your SSL private key if the ssl-option is set to `true`.
- **allowed_networks** (*Required*): Limit access to the configurator by adding allowed IP addresses/networks to the list.
- **banned_ips** (*Required*): List of statically banned IP addresses.
- **banlimit** (*Required*): Ban access from IPs after `banlimit` failed login attempts. The default value `0` disables this feature. Restart the add-on to clear the list of banned IP addresses.
- **ignore_pattern** (*Required*): Files and folders to ignore in the UI.
- **dirsfirst** (*Required*): List directories before files in the file browser.
- **enforce_basepath** (*Required*): If set to `true`, access is limited to files within the `/config` directory.
- **notify_service** (*Required*): Specify a custom notify-service to be used to push notifications.
- **ignore_ssl** (*Required*): Ignore SSL errors when accessing the Home Assistant API.
- **sesame** (*Optional*): Secret token to dynamically allow access from the IP the request originates from. Open your bookmark https://hassio.yourdomain.com:8123/somesecretnobodycanguess while `allowed_networks` is set to `[]` and your IP will get whitelisted. You can use the _Network status_ menu to revoke IP addresses for which access has been granted. Regular authentication is still required.
- **sesame_totp_secret** (*Optional*): Like the `sesame` option, but instead as Base32 encoded secret string must be provided. This string then can be added to a TOTP App like Google Authenticator. This way you get a 6-digit `sesame` that changes every 30 seconds.
- **loglevel** (*Optional*): You can change the logging level from the default value `info` if you want to. Valid values are: `debug`, `info`, `warning`, `error`, `critical`.
{% configuration %}
username:
description: Set a username so that access your configuration is protected.
required: true
type: string
password:
description: Set a password for access.
required: true
type: string
ssl:
description: Enable or Disable SSL/TLS for the editor.
required: true
type: boolean
default: false
certfile:
description: Set the path the your SSL certificate if the ssl-option is set to `true`.
required: true
type: string
keyfile:
description: Set the path the your SSL private key if the ssl-option is set to `true`.
required: true
type: string
allowed_networks:
description: Limit access to the configurator by adding allowed IP addresses/networks to the list.
required: true
type: string
banned_ips:
description: List of statically banned IP addresses.
required: true
type: string
banlimit:
description: Ban access from IPs after `banlimit` failed login attempts, setting the value to 0 disables this feature. Restart the add-on to clear the list of banned IP addresses.
required: true
type: integer
default: 0
ignore_pattern:
description: Regex of files and folders to ignore in the UI.
required: true
type: string
dirsfirst:
description: List directories before files in the file browser.
required: true
type: boolean
default: false
enforce_basepath:
description: If set to `true`, access is limited to files within the `/config` directory.
required: true
type: boolean
default: false
notify_service:
description: Specify a custom notify-service to be used to push notifications.
required: true
type: string
loglevel:
description: The log level the configurator should run with. Valid values are `debug`, `info`, `warning`, `error`, `critical`.
required: false
type: string
default: info
sesame:
description: Secret token to dynamically allow access from the IP the request originates from. Open your bookmark https://hassio.yourdomain.com:8123/somesecretnobodycanguess while `allowed_networks` is set to `[]` and your IP will get whitelisted. You can use the Network status menu to revoke IP addresses for which access has been granted. Regular authentication is still required.
required: false
type: string
sesame_totp_secret:
description: Like the `sesame` option, but instead as Base32 encoded secret string must be provided. This string then can be added to a TOTP App like Google Authenticator. This way you get a 6-digit `sesame` that changes every 30 seconds.
required: false
type: string
{% endconfiguration %}
<p class='note warning'>
Be careful when setting up port forwarding to the configurator while embedding into Home Assistant. If you don't restrict access by requiring authentication and/or blocking based on client IP addresses, your configuration will be exposed to the internet!

30
source/_addons/nginx_proxy.markdown
View File

@ -27,13 +27,29 @@ In the `http` section of the `configuration.yaml` file remove `ssl_certificate`
}
```
Configuration variables:
- **domain** (*Required*): Domain they will proxy run with it.
- **certfile** (*Required*): Certificate file to use in the /ssl dir.
- **keyfile** (*Required*): Private key file to use in the /ssl dir.
- **hsts** (*Optional*): Value for the [`Strict-Transport-Security`](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Strict-Transport-Security) HTTP header to send. If empty or `null`, the header is not sent.
- **customize** (*Optional*): If true, additional NGINX configuration files for the default server and additional servers are read from files in the /share dir specified by the `default` and `servers` variables.
{% configuration %}
domain:
description: The Domain to use for the proxy.
required: true
type: string
certfile:
description: The certificate file to use in the `/ssl` directory.
required: true
type: string
keyfile:
description: Private key file to use in the `/ssl` directory.
required: true
type: string
hsts:
description: Value for the [`Strict-Transport-Security`](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Strict-Transport-Security) HTTP header to send. If empty or `null`, the header is not sent.
required: false
type: string
customize:
description: If true, additional NGINX configuration files for the default server and additional servers are read from files in the `/share` directory specified by the `default` and `servers` variables.
required: false
type: boolean
default: false
{% endconfiguration %}
<p class='note'>
It is possible to deactivate port 80 if you need this for things like `emulate_hue`. Remove the host port from Network option of this add-on.

26
source/_components/ads.markdown
View File

@ -15,6 +15,8 @@ ha_iot_class: "Local Push"
The ADS (automation device specification) describes a device-independent and fieldbus independent interface for communication between [Beckhoff](https://www.beckhoff.com/) automation devices running [TwinCAT](http://www.beckhoff.hu/english.asp?twincat/default.htm) and other devices implementing this interface.
## {% linkable_title Configuration %}
To enable ADS, add the following lines to your `configuration.yaml` file:
```yaml
@ -25,18 +27,18 @@ ads:
```
{% configuration %}
device:
required: true
description: The AMS NetId that identifies the device.
type: string
port:
required: true
description: The port that runs the AMS server on the device, typically this would be 801 or 851.
type: integer
ip_address:
required: false
description: The IP address of the ADS device, if not set the first 4 bytes of the device id will be used.
type: string
device:
description: The AMS NetId that identifies the device.
required: true
type: string
port:
description: The port that runs the AMS server on the device, typically this would be 801 or 851.
required: true
type: integer
ip_address:
description: The IP address of the ADS device, if not set the first 4 bytes of the device id will be used.
required: false
type: string
{% endconfiguration %}
## {% linkable_title Service %}

4
source/_components/alarm_control_panel.alarmdotcom.markdown
View File

@ -14,6 +14,8 @@ ha_release: 0.11
The `alarmdotcom` platform is consuming the information provided by [Alarm.com](https://www.alarm.com/).
## {% linkable_title Configuration %}
To enable this, add the following lines to your `configuration.yaml`:
```yaml
@ -41,5 +43,5 @@ name:
code:
description: Specifies a code to enable or disable the alarm in the frontend.
required: false
type: int
type: integer
{% endconfiguration %}

2
source/_components/alarm_control_panel.arlo.markdown
View File

@ -15,6 +15,8 @@ ha_iot_class: "Cloud Polling"
The `arlo` alarm control panel allows you to control your [Arlo](https://arlo.netgear.com/) base stations. You can use it to switch modes and trigger alarms from Home Assistant.
## {% linkable_title Configuration %}
To get your [Arlo](https://arlo.netgear.com/) base stations working within Home Assistant, please follow the instructions for the general [Arlo component](/components/arlo).
Once you have enabled the [Arlo component](/components/arlo), add the following to your `configuration.yaml` file:

2
source/_components/alarm_control_panel.blink.markdown
View File

@ -8,7 +8,7 @@ comments: false
sharing: true
footer: true
logo: blink.png
ha_category: Alarm Control Panel
ha_category: Alarm
ha_release: "0.80"
---

11
source/_components/alarm_control_panel.concord232.markdown
View File

@ -14,7 +14,12 @@ ha_release: 0.31
The `concord232` platform provides integration with GE, Interlogix (and other brands) alarm panels that support the RS-232 Automation Control Panel interface module (or have it built in). Supported panels include Concord 4.
To use this platform, you will need to have the external concord232 client and server installed. The server must be running on the device which is connected to the automation module's serial port. The client must be installed on the machine running Home Assistant. These may often be the same machine, but do not have to be. For additional details in setting up and testing the client and server, see <https://github.com/JasonCarter80/concord232>
To use this platform, you will need to have the external concord232 client and server installed.
The server must be running on the device which is connected to the automation module's serial port.
The client must be installed on the machine running Home Assistant. These may often be the same machine, but do not have to be.
For additional details in setting up and testing the client and server, see <https://github.com/JasonCarter80/concord232>.
## {% linkable_title Configuration %}
To enable this platform in Home Assistant, add the following lines to your `configuration.yaml`:
@ -28,11 +33,11 @@ alarm_control_panel:
host:
description: The host where the concord232 server process is running.
required: false
default: localhost
type: string
default: localhost
port:
description: The port where the Alarm panel is listening.
required: false
default: 5007
type: integer
default: 5007
{% endconfiguration %}

2
source/_components/alarm_control_panel.envisalink.markdown
View File

@ -13,8 +13,6 @@ ha_release: 0.23
ha_iot_class: "Local Push"
---
The `envisalink` alarm control panel platform allows you to control your [Envisalink](http://www.eyezon.com) alarms.
The requirement is that you have setup your [Envisalink hub](/components/envisalink/).

34
source/_components/alarm_control_panel.ialarm.markdown
View File

@ -16,6 +16,8 @@ The `ialarm` platform provides connectivity with the [Antifurto365](https://www.
This platform supports the following services: `alarm_arm_away`, `alarm_arm_home` and `alarm_disarm`.
## {% linkable_title Configuration %}
To enable this, add the following lines to your `configuration.yaml` file:
```yaml
@ -28,22 +30,22 @@ alarm_control_panel:
```
{% configuration %}
host:
description: The IP address of the iAlarm device on your home network.
required: true
type: string
username:
description: Username used to sign into the iAlarm web client (should be admin by default).
required: true
type: string
password:
description: Password used to sign into the iAlarm web client. If it has a leading zero you need to put the password within quotes.
required: true
type: string
name:
description: Name of device in Home Assistant.
required: false
type: string
host:
description: The IP address of the iAlarm device on your home network.
required: true
type: string
username:
description: Username used to sign into the iAlarm web client (should be admin by default).
required: true
type: string
password:
description: Password used to sign into the iAlarm web client. If it has a leading zero you need to put the password within quotes.
required: true
type: string
name:
description: Name of device in Home Assistant.
required: false
type: string
{% endconfiguration %}
This platform has also been confirmed to work with the alarm system brands Meian and Emooluxr.

85
source/_components/alarm_control_panel.ifttt.markdown
View File

@ -20,13 +20,15 @@ This platform depends on the [IFTTT](/components/ifttt/) Home Assistant componen
It is important to note that this platform fully relies on IFTTT to receive updates when the security system's state changes. Therefore, this platform shows an assumed state.
</p>
To enable this, setup the required IFTTT applets as listed below and add the following lines to your `configuration.yaml` file:
## {% linkable_title Configuration %}
To enable this, add the following lines to your `configuration.yaml` file:
```yaml
# Example configuration.yaml entry
ifttt:
key: YOUR_WEBHOOK_KEY
alarm_control_panel:
- platform: ifttt
name: YOUR_ALARM_NAME
@ -37,13 +39,51 @@ alarm_control_panel:
event_disarm: YOUR_DISARM_EVENT
```
{% configuration %}
name:
description: The name of your Home Assistant alarm control panel.
required: false
type: string
code:
description: The code for the alarm control panel.
required: false
type: string
event_arm_away:
description: IFTTT webhook event to call when the state is set to armed away.
required: false
type: string
default: alarm_arm_away
event_arm_home:
description: IFTTT webhook event to call when the state is set to armed home.
required: false
type: string
default: alarm_arm_home
event_arm_night:
description: IFTTT webhook event to call when the state is set to armed night.
required: false
type: string
default: alarm_arm_night
event_disarm:
description: IFTTT webhook event to call when the state is set to disarmed.
required: false
type: string
default: alarm_disarm
optimistic:
description: Specify if the state will be updated by an ifttt_push_alarm_state call (false) or can be set immediately (true).
required: false
type: boolean
default: false
{% endconfiguration %}
<p class='note warning'>
It is strongly discouraged to use this platform when you don't use encryption; otherwise, your API password will be send unprotected through the IFTTT Webhooks. It is advised to [setup encryption using Let's Encrypt](https://home-assistant.io/blog/2017/09/27/effortless-encryption-with-lets-encrypt-and-duckdns/).
</p>
{% linkable_title Required IFTTT applets %}
### {% linkable_title Required IFTTT applets %}
This platform supports the services `alarm_disarm`, `alarm_arm_away`, `alarm_arm_home` and `alarm_arm_night`. For each of these services, an IFTTT webhook will be triggered.
Next, you will need to set up the required IFTTT applets as listed below.
This platform supports the services `alarm_disarm`, `alarm_arm_away`, `alarm_arm_home` and `alarm_arm_night`. For each of these services, an IFTTT webhook will be triggered.
For this system to operate correctly, the following IFTTT applets have to be setup. Obviously, if your alarm device does not support some states, no applets have to be provided for those.
* **IF** Webhook event `YOUR_DISARM_EVENT` is called, **THEN** disarm the alarm system.
@ -54,40 +94,3 @@ For this system to operate correctly, the following IFTTT applets have to be set
* **IF** the alarm system state changed to armed home, **THEN** perform a Webhook `POST` web request to url `https://HASS_URL/api/services/alarm_control_panel/ifttt_push_alarm_state?api_password=API_PASSWORD` with content type `application/json` and body `{"entity_id": "alarm_control_panel.DEVICE_NAME", "state": "armed_home"}`.
* **IF** the alarm system state changed to armed away, **THEN** perform a Webhook `POST` web request to url `https://HASS_URL/api/services/alarm_control_panel/ifttt_push_alarm_state?api_password=API_PASSWORD` with content type `application/json` and body `{"entity_id": "alarm_control_panel.DEVICE_NAME", "state": "armed_away"}`.
* **IF** the alarm system state changed to armed night, **THEN** perform a Webhook `POST` web request to url `https://HASS_URL/api/services/alarm_control_panel/ifttt_push_alarm_state?api_password=API_PASSWORD` with content type `application/json` and body `{"entity_id": "alarm_control_panel.DEVICE_NAME", "state": "armed_night"}`.
{% configuration %}
name:
description: The name of your Home Assistant alarm control panel.
required: false
type: string
code:
description: The code for the alarm control panel.
required: false
type: string
event_arm_away:
description: IFTTT webhook event to call when the state is set to armed away.
required: false
type: string
default: alarm_arm_away
event_arm_home:
description: IFTTT webhook event to call when the state is set to armed home.
required: false
type: string
default: alarm_arm_home
event_arm_night:
description: IFTTT webhook event to call when the state is set to armed night.
required: false
type: string
default: alarm_arm_night
event_disarm:
description: IFTTT webhook event to call when the state is set to disarmed.
required: false
type: string
default: alarm_disarm
optimistic:
description: Specify if the state will be updated by an ifttt_push_alarm_state call (false) or can be set immediately (true).
required: false
type: boolean
default: false
{% endconfiguration %}

82
source/_components/alarm_control_panel.manual.markdown
View File

@ -13,28 +13,74 @@ ha_release: 0.7.6
ha_qa_scale: internal
---
The `manual` alarm control panel platform enables you to set manual alarms in Home Assistant.
## {% linkable_title Configuration %}
To enable this, add the following lines to your `configuration.yaml` file:
```yaml
# Example configuration.yaml entry
alarm_control_panel:
- platform: manual
```
Configuration variables:
- **name** (*Optional*): The name of the alarm. Default is "HA Alarm".
- **code** (*Optional*): If defined, specifies a code to enable or disable the alarm in the frontend.
- **code_template** (*Optional*): If defined, returns a code to enable or disable the alarm in the frontend; an empty string disables checking the code. Inside the template, the variables **from_state** and **to_state** identify the current and desired state. Only one of **code** and **code_template** can be specified.
- **delay_time** (*Optional*): The time in seconds of the pending time before triggering the alarm. Default is 0 seconds.
- **pending_time** (*Optional*): The time in seconds of the pending time before effecting a state change. Default is 60 seconds.
- **trigger_time** (*Optional*): The time in seconds of the trigger time in which the alarm is firing. Default is 120 seconds.
- **disarm_after_trigger** (*Optional*): If true, the alarm will automatically disarm after it has been triggered instead of returning to the previous state.
- **armed_custom_bypass/armed_home/armed_away/armed_night/disarmed/triggered** (*Optional*): State specific settings
- **delay_time** (*Optional*): State specific setting for **delay_time** (all states except **triggered**)
- **pending_time** (*Optional*): State specific setting for **pending_time** (all states except **disarmed**)
- **trigger_time** (*Optional*): State specific setting for **trigger_time** (all states except **triggered**)
{% configuration %}
name:
description: The name of the alarm.
required: false
type: string
default: HA Alarm
code:
description: >
If defined, specifies a code to enable or disable the alarm in the frontend.
Only one of **code** and **code_template** can be specified.
required: exclusive
type: string
code_template:
description: >
If defined, returns a code to enable or disable the alarm in the frontend; an empty string disables checking the code.
Inside the template, the variables **from_state** and **to_state** identify the current and desired state.
Only one of **code** and **code_template** can be specified.
required: exclusive
type: string
delay_time:
description: The time in seconds of the pending time before triggering the alarm.
required: false
type: integer
default: 0
pending_time:
description: The time in seconds of the pending time before effecting a state change.
required: false
type: integer
default: 60
trigger_time:
description: The time in seconds of the trigger time in which the alarm is firing.
required: false
type: integer
default: 120
disarm_after_trigger:
description: If true, the alarm will automatically disarm after it has been triggered instead of returning to the previous state.
required: false
type: boolean
armed_custom_bypass/armed_home/armed_away/armed_night/disarmed/triggered:
description: State specific settings
required: false
type: list
keys:
delay_time:
description: State specific setting for **delay_time** (all states except **triggered**)
required: false
type: integer
pending_time:
description: State specific setting for **pending_time** (all states except **disarmed**)
required: false
type: integer
trigger_time:
description: State specific setting for **trigger_time** (all states except **triggered**)
required: false
type: integer
{% endconfiguration %}
## {% linkable_title State machine %}
@ -75,12 +121,12 @@ garage door opens, but not for the "armed home" state.
**trigger_time** is useful to disable the alarm when disarmed, but it can also
be used for example to sound the siren for a shorter time during the night.
## {% linkable_title Examples %}
In the config example below:
- the disarmed state never triggers the alarm;
- the armed_home state will leave no time to leave the building or disarm the alarm;
- while other states state will give 30 seconds to leave the building before triggering the alarm, and 20 seconds to disarm the alarm when coming back.
```yaml
@ -99,9 +145,7 @@ alarm_control_panel:
delay_time: 0
```
## {% linkable_title Examples %}
In this section, you find some real-life examples of how to use this panel.
In the rest of this section, you find some real-life examples on how to use this panel.
### {% linkable_title Sensors %}

131
source/_components/alarm_control_panel.manual_mqtt.markdown
View File

@ -32,6 +32,8 @@ When the state of the manual alarm changes, Home Assistant will publish one of t
- 'pending'
- 'triggered'
## {% linkable_title Configuration %}
To use your panel in your installation, add the following to your `configuration.yaml` file:
```yaml
@ -42,39 +44,114 @@ alarm_control_panel:
command_topic: home/alarm/set
```
Configuration variables:
The following configuration variables from the base manual alarm platform are available:
- **name** (*Optional*): The name of the alarm. Default is "HA Alarm".
- **code** (*Optional*): If defined, specifies a code to enable or disable the alarm in the frontend. This code is not required for MQTT interactions.
- **code_template** (*Optional*): If defined, returns a code to enable or disable the alarm in the frontend; an empty string disables checking the code. Inside the template, the variables **from_state** and **to_state** identify the current and desired state. Only one of **code** and **code_template** can be specified.
- **delay_time** (*Optional*): The time in seconds of the pending time before triggering the alarm. Default is 0 seconds.
- **pending_time** (*Optional*): The time in seconds of the pending time before effecting a state change. Default is 60 seconds.
- **trigger_time** (*Optional*): The time in seconds of the trigger time in which the alarm is firing. Default is 120 seconds.
- **disarm_after_trigger** (*Optional*): If true, the alarm will automatically disarm after it has been triggered instead of returning to the previous state.
- **armed_home/armed_away/armed_night/disarmed/triggered** (*Optional*): State specific settings
- **delay_time** (*Optional*): State specific setting for **delay_time** (all states except **triggered**)
- **pending_time** (*Optional*): State specific setting for **pending_time** (all states except **disarmed**)
- **trigger_time** (*Optional*): State specific setting for **trigger_time** (all states except **triggered**)
{% configuration %}
name:
description: The name of the alarm.
required: false
type: string
default: HA Alarm
code:
description: >
If defined, specifies a code to enable or disable the alarm in the frontend.
This code is not required for MQTT interactions.
Only one of **code** and **code_template** can be specified.
required: exclusive
type: string
code_template:
description: >
If defined, returns a code to enable or disable the alarm in the frontend; an empty string disables checking the code.
Inside the template, the variables **from_state** and **to_state** identify the current and desired state.
Only one of **code** and **code_template** can be specified.
required: exclusive
type: string
delay_time:
description: The time in seconds of delay added to the triggered state's **pending_time** before triggering the alarm.
required: false
type: integer
default: 0
pending_time:
description: The time in seconds of the pending time before effecting a state change.
required: false
type: integer
default: 60
trigger_time:
description: The time in seconds of the trigger time in which the alarm is firing.
required: false
type: integer
default: 120
disarm_after_trigger:
description: If true, the alarm will automatically disarm after it has been triggered instead of returning to the previous state.
required: false
type: boolean
armed_home/armed_away/armed_night/disarmed/triggered:
description: State specific settings
required: false
type: list
keys:
delay_time:
description: State specific setting for **delay_time** (all states except **triggered**)
required: false
type: integer
pending_time:
description: State specific setting for **pending_time** (all states except **disarmed**)
required: false
type: integer
trigger_time:
description: State specific setting for **trigger_time** (all states except **triggered**)
required: false
type: integer
{% endconfiguration %}
See the documentation for the [manual alarm platform](/components/alarm_control_panel.manual/) for a description.
Additionally, the following MQTT configuration variables are also available:
Additionally, the following MQTT configuration variables are also available.
- **state_topic** (*Required*): The MQTT topic HA will publish state updates to.
- **command_topic** (*Required*): The MQTT topic HA will subscribe to, to receive commands from a remote device to change the alarm state.
- **qos** (*Optional*): The maximum QoS level for subscribing and publishing to MQTT messages. Default is 0.
- **payload_disarm** (*Optional*): The payload to disarm this Alarm Panel. Default is "DISARM".
- **payload_arm_home** (*Optional*): The payload to set armed-home mode on this Alarm Panel. Default is "ARM_HOME".
- **payload_arm_away** (*Optional*): The payload to set armed-away mode on this Alarm Panel. Default is "ARM_AWAY".
- **payload_arm_night** (*Optional*): The payload to set armed-night mode on this Alarm Panel. Default is "ARM_NIGHT".
{% configuration %}
state_topic:
description: The MQTT topic HA will publish state updates to.
required: true
type: string
command_topic:
description: The MQTT topic HA will subscribe to, to receive commands from a remote device to change the alarm state.
required: true
type: string
qos:
description: The maximum QoS level for subscribing and publishing to MQTT messages.
required: false
type: int
default: 0
payload_disarm:
description: The payload to disarm this Alarm Panel.
required: false
type: string
default: DISARM
payload_arm_home:
description: The payload to set armed-home mode on this Alarm Panel.
required: false
type: string
default: ARM_HOME
payload_arm_away:
description: The payload to set armed-away mode on this Alarm Panel.
required: false
type: string
default: ARM_AWAY
payload_arm_night:
description: The payload to set armed-night mode on this Alarm Panel.
required: false
type: string
default: ARM_NIGHT
{% endconfiguration %}
## {% linkable_title Examples %}
In the configuration example below:
- The disarmed state never triggers the alarm.
- The armed_home state will leave no time to leave the building or disarm the alarm.
- While other states state will give 30 seconds to leave the building before triggering the alarm, and 20 seconds to disarm the alarm when coming back.
- The disarmed state never triggers the alarm;
- The armed_home state will leave no time to leave the building or disarm the alarm;
- While other states state will give 30 seconds to leave the building before triggering the alarm, and 20 seconds to disarm the alarm when coming back;
- Setting pending_time to 0 for triggered state allows the alarm to trigger after previous state's delay time only. If not set, the alarm will be pending for previous state's delay_time plus the default pending_time before triggering.
```yaml
# Example configuration.yaml entry
@ -90,11 +167,11 @@ alarm_control_panel:
armed_home:
pending_time: 0
delay_time: 0
triggered:
pending_time: 0
```
## {% linkable_title Examples %}
Refer to the [Manual Alarm Control page](/components/alarm_control_panel.manual/#examples) for some real-life examples of how to use this panel.
Refer to the [Manual Alarm Control page](/components/alarm_control_panel.manual/#examples) for more real-life examples on how to use this panel.
## {% linkable_title MQTT Control %}

2
source/_components/alarm_control_panel.markdown
View File

@ -9,11 +9,9 @@ sharing: true
footer: true
---
Home Assistant can give you an interface with is similar to a classic alarm system. There are several panels supported:
- [Alarm.com](/components/alarm_control_panel.alarmdotcom/)
- [Manual](/components/alarm_control_panel.manual/)
- [MQTT](/components/alarm_control_panel.mqtt/)
- [Verisure](/components/verisure/)

2
source/_components/alarm_control_panel.mqtt.markdown
View File

@ -25,6 +25,8 @@ The component will accept the following states from your Alarm Panel (in lower c
The component can control your Alarm Panel by publishing to the `command_topic` when a user interacts with the Home Assistant frontend.
## {% linkable_title Configuration %}
To enable this platform, add the following lines to your `configuration.yaml`:
```yaml

8
source/_components/alarm_control_panel.nx584.markdown
View File

@ -14,6 +14,8 @@ ha_release: 0.13
The `nx584` platform provides integration with GE, Caddx, Interlogix (and other brands) alarm panels that support the NX584 interface module (or have it built in). Supported panels include NX4/6/8/8E. Actual integration is done through [pynx584](http://github.com/kk7ds/pynx584) which is required for this to work.
## {% linkable_title Configuration %}
To enable this, add the following lines to your `configuration.yaml`:
```yaml
@ -26,16 +28,16 @@ alarm_control_panel:
host:
description: The host where the nx584 server process is running.
required: false
default: localhost
type: string
default: localhost
name:
description: This parameter allows you to override the name.
required: false
default: NX584
type: string
default: NX584
port:
description: The port where the Alarm panel is listening.
required: false
default: 5007
type: integer
default: 5007
{% endconfiguration %}

2
source/_components/alarm_control_panel.satel_integra.markdown
View File

@ -13,8 +13,6 @@ ha_release: 0.54
ha_iot_class: "Local Push"
---
The `satel_integra` alarm control panel platform allows you to control your [SatelIntegra](http://www.satel.pl/en/) alarms.
The requirement is that you have setup your [SatelIntegra hub](/components/satel_integra/).

34
source/_components/alarm_control_panel.simplisafe.markdown
View File

@ -12,33 +12,9 @@ ha_release: 0.24
ha_category: Alarm
---
The `simplisafe` platform enables the ability to control a [SimpliSafe](http://simplisafe.com/) control panel.
The `simplisafe` alarm control panel platform gives users the ability to
control a SimpliSafe home alarm system.
To enable this, add the following lines to your `configuration.yaml`:
```yaml
# Example configuration.yaml entry
alarm_control_panel:
platform: simplisafe
username: YOUR_USERNAME
password: YOUR_PASSWORD
```
{% configuration %}
username:
description: Username for the SimpliSafe account.
required: true
type: string
password:
description: Password for SimpliSafe account.
required: true
type: string
name:
description: The name of the alarm. Default is the SimpliSafe alarm id.
required: false
type: string
code:
description: Specifies a code to enable or disable the alarm in the frontend.
required: false
type: string
{% endconfiguration %}
You must have the [`simplisafe` component](/components/simplisafe/) configured
to use this platform. After configuring that component, any alarm control
panels defined will automatically appear.

1
source/_components/alarm_control_panel.spc.markdown
View File

@ -13,7 +13,6 @@ ha_release: 0.47
ha_iot_class: "Local Push"
---
The `spc` alarm control panel platform allows you to control your [Vanderbilt SPC](https://www.spcsupportinfo.com/) alarms.
The requirement is that you have setup your [SPC hub](/components/spc/).

25
source/_components/alarm_control_panel.totalconnect.markdown
View File

@ -18,6 +18,8 @@ This platform supports the following services: `alarm_arm_away`, `alarm_arm_home
If you have issues running this component, you may require `libxml2-dev` and `libxmlsec1-dev` packages. To install these on Hassbian, run the command `apt install libxml2-dev libxmlsec1-dev` with sudo.
## {% linkable_title Configuration %}
To enable this, add the following lines to your `configuration.yaml`:
```yaml
@ -28,13 +30,22 @@ alarm_control_panel:
password: YOUR_PASSWORD
```
Configuration variables:
{% configuration %}
name:
description: Name of device in Home Assistant.
required: false
type: string
username:
description: Username used to sign into the TotalConnect app/web client.
required: true
type: string
password:
description: Password used to sign into the TotalConnect app/web client.
required: true
type: string
{% endconfiguration %}
- **name** (*Optional*): Name of device in Home Assistant.
- **username** (*Required*): Username used to sign into the TotalConnect app/web client.
- **password** (*Required*): Password used to sign into the TotalConnect app/web client.
Automation example:
## {% linkable_title Automation example %}
```yaml
automation:
@ -56,5 +67,5 @@ automation:
to: 'armed_away'
action:
service: scene.turn_on
entity_id: scene.OnArmedAway
entity_id: scene.OnArmedAway
```

1
source/_components/alarm_control_panel.verisure.markdown
View File

@ -13,7 +13,6 @@ ha_release: 0.7.3
ha_iot_class: "Cloud Polling"
---
The Verisure alarm control panel platform allows you to control your [Verisure](https://www.verisure.com/) Alarms.
The requirement is that you have setup your [Verisure hub](/components/verisure/).

4
source/_components/alarm_control_panel.wink.markdown
View File

@ -14,18 +14,14 @@ ha_release: 0.37
No Wink hub is required to support these devices.
The Wink alarm platform allows you to control your [Wink](http://www.wink.com/) Canary all-in-one security camera.
The requirement is that you have setup [Wink](/components/wink/).
### {% linkable_title Supported devices %}
- Canary all-in-one security camera
<p class='note'>
The above devices are confirmed to work, but others may work as well.
</p>

30
source/_components/alarm_control_panel.yale_smart_alarm.markdown
View File

@ -16,6 +16,7 @@ The `yale_smart_alarm` platform provides connectivity with the Yale Smart Alarm
This platform supports the following services: `alarm_arm_away`, `alarm_arm_home`, `alarm_arm_night` (duplicate of home) and `alarm_disarm`.
Currently only one alarm is supported.
## {% linkable_title Configuration %}
To enable, add the following lines to your `configuration.yaml`:
@ -27,14 +28,27 @@ alarm_control_panel:
password: YOUR_PASSWORD
```
Configuration variables:
{% configuration %}
name:
description: Name of device in Home Assistant.
required: false
type: string
username:
description: Username used to sign into the Yale app/web client.
required: true
type: string
password:
description: Password used to sign into the Yale app/web client.
required: true
type: string
area_id:
description: Area ID of the device when talking to Yale's API if required.
required: false
type: int
default: 1
{% endconfiguration %}
- **name** (*Optional*): Name of device in Home Assistant.
- **username** (*Required*): Username used to sign into the Yale app/web client.
- **password** (*Required*): Password used to sign into the Yale app/web client.
- **area_id** (*Optional*): Area ID of the device when talking to Yale's API if required ('1' by default).
Automation example:
## {% linkable_title Automation example %}
```yaml
automation:
@ -56,5 +70,5 @@ automation:
to: 'armed_away'
action:
service: scene.turn_on
entity_id: scene.OnArmedAway
entity_id: scene.OnArmedAway
```

79
source/_components/alarmdecoder.markdown
View File

@ -13,7 +13,7 @@ ha_release: 0.43
ha_iot_class: "Local Push"
---
The `alarmdecoder` component will allow Home Assistant users who own either a DSC or Honeywell alarm panel to leverage their alarm system and its sensors to provide Home Assistant with rich information about their homes. Connectivity between Home Assistant and the alarm panel is accomplished through a device produced by Nu Tech Software Solutions, known as the AlarmDecoder. The AlarmDecoder devices provide a serial, TCP/IP socket or USB interface to the alarm panel, where it emulates an alarm keypad.
The `alarmdecoder` component will allow Home Assistant users who own either a DSC or Honeywell alarm panel to leverage their alarm system and its sensors to provide Home Assistant with rich information about their homes. Connectivity between Home Assistant and the alarm panel is accomplished through a device produced by Nu Tech Software Solutions, known as the AlarmDecoder. The AlarmDecoder devices provide a serial, TCP/IP socket or USB interface to the alarm panel, where it emulates an alarm keypad.
Please visit the [AlarmDecoder website](https://www.alarmdecoder.com/) for further information about the AlarmDecoder devices.
@ -34,7 +34,7 @@ alarmdecoder:
type: socket
host: 192.168.1.20
port: 10000
panel_display: On
panel_display: false
zones:
01:
name: 'Smoke Detector'
@ -45,15 +45,66 @@ alarmdecoder:
type: 'opening'
```
Configuration variables:
- **type** (*Required*): The type of AlarmDecoder device: socket, serial or USB
- **host** (*Optional*): The IP address of the AlarmDecoder device on your home network, if using socket type. Default: `localhost`
- **port** (*Optional*): The port of the AlarmDecoder device on your home network, if using socket type. Default: `10000`
- **path** (*Optional*): The path of the AlarmDecoder device, if using socket type. Default: `/dev/ttyUSB0`
- **baudrate** (*Optional*): The baud rate of the AlarmDecoder device, if using serial type. Default: `115200`
- **panel_display** (*Optional*): Create a sensor called sensor.alarm_display to match the Alarm Keypad display. Default: `off`
- **zones** (*Optional*): AlarmDecoder has no way to tell us which zones are actually in use, so each zone must be configured in Home Assistant. For each zone, at least a name must be given. For more information on the available zone types, take a look at the [Binary Sensor](/components/binary_sensor.alarmdecoder/) docs. *Note: If no zones are specified, Home Assistant will not load any binary_sensor components.*
- **rfid** (*Optional*): The RF serial-number associated with RF zones. Providing this field allows Home Assistant to associate raw sensor data to a given zone, allowing direct monitoring of the state, battery, and supervision status.
- **relayaddr** (*Optional*): Address of the relay expander board to associate with the zone. (ex: 12, 13, 14, or 15). Typically used in cases where a panel will not send bypassed zones such as motion during an armed home state, the Vista 20P is an example of this. Alarmdecoder can emulate a zone expander board and the panel can be programmed to push zone events to this virtual expander. This allows the bypassed zone binary sensors to be utilized. One example is using bypassed motion sensors at night for motion-based automated lights while the system is armed with the motion sensor bypassed.
- **relaychan** (*Optional*): Channel of the relay expander board to associate with the zone. (ex: 1, 2, 3, or 4)
{% configuration %}
device:
description: List of variables for the AlarmDecoder device.
required: true
type: list
keys:
type:
description: "The type of AlarmDecoder device: socket, serial or USB."
required: true
default: socket
type: string
host:
description: The IP address of the AlarmDecoder device on your home network, if using socket type.
required: false
default: localhost
type: string
port:
description: The IP address of the AlarmDecoder device on your home network, if using socket type.
required: false
default: 10000
type: integer
path:
description: The path of the AlarmDecoder device, if using serial type.
required: false
default: "/dev/ttyUSB0"
type: string
baudrate:
description: The baud rate of the AlarmDecoder device, if using serial type.
required: false
default: 115200
type: string
panel_display:
description: Create a sensor called sensor.alarm_display to match the Alarm Keypad display.
required: false
default: false
type: boolean
zones:
description: "AlarmDecoder has no way to tell us which zones are actually in use, so each zone must be configured in Home Assistant. For each zone, at least a name must be given. For more information on the available zone types, take a look at the [Binary Sensor](/components/binary_sensor.alarmdecoder/) docs. *Note: If no zones are specified, Home Assistant will not load any binary_sensor components.*"
required: false
type: list
keys:
name:
description: A name for the zone.
required: true
type: string
type:
description: "A type for the zone. Here you can find a list of [Device Classes](https://www.home-assistant.io/components/binary_sensor/#device-class)."
required: false
default: opening
type: string
rfid:
description: The RF serial-number associated with RF zones. Providing this field allows Home Assistant to associate raw sensor data to a given zone, allowing direct monitoring of the state, battery, and supervision status.
required: false
type: string
relayaddr:
description: "Address of the relay expander board to associate with the zone. (ex: 12, 13, 14, or 15). Typically used in cases where a panel will not send bypassed zones such as motion during an armed home state, the Vista 20P is an example of this. Alarmdecoder can emulate a zone expander board and the panel can be programmed to push zone events to this virtual expander. This allows the bypassed zone binary sensors to be utilized. One example is using bypassed motion sensors at night for motion-based automated lights while the system is armed with the motion sensor bypassed."
required: inclusive
type: integer
relaychan:
description: "Channel of the relay expander board to associate with the zone. (ex: 1, 2, 3, or 4)"
required: inclusive
type: integer
{% endconfiguration %}

51
source/_components/android_ip_webcam.markdown
View File

@ -17,7 +17,13 @@ The `android_ip_webcam` component turns an Android phone into a network camera w
It's setup as an MJPEG camera and all settings as switches inside of Home Assistant. You can also expose the sensors. If you have multiple phones, you can use all options inside a list.
To set it up, download [the IP Webcam app][app], and add the following information to your `configuration.yaml` file:
## {% linkable_title Setup %}
Download [the IP Webcam app](https://play.google.com/store/apps/details?id=com.pas.webcam) and launch the app. You will be able to the IP address of the device.
## {% linkable_title Configuration %}
To set it up the component, add the following information to your `configuration.yaml` file:
```yaml
# Example configuration.yaml entry
@ -27,7 +33,7 @@ android_ip_webcam:
{% configuration %}
host:
description: The IP Address of the phone on the network.
description: The IP address of the phone on the network.
required: true
type: string
port:
@ -59,50 +65,50 @@ sensors:
type: list
keys:
audio_connections:
description: Audio Connections
description: The audio connections
battery_level:
description: Battery Level
description: The battery level
battery_temp:
description: Battery Temperature
description: The battery temperature
battery_voltage:
description: Battery Voltage
description: The battery voltage
light:
description: Light Level
description: The light level
motion:
description: Motion
description: Motion detection
pressure:
description: Pressure
description: The current pressure
proximity:
description: Proximity
description: The proximity
sound:
description: Sound
description: The sound detection
video_connections:
description: Video Connections
description: The video connections
switches:
description: Conditions to display settings in the frontend. See the list of supported switches.
required: false
type: list
keys:
exposure_lock:
description: Exposure Lock
description: Control the exposure lock
ffc:
description: Front-facing Camera
description: Control the front-facing camera.
focus:
description: Focus
description: Control the focus.
gps_active:
description: GPS Active
description: Control the GPS.
night_vision:
description: Night Vision
description: Control the night vision.
overlay:
description: Overlay
description: Control the overlay.
torch:
description: Torch
description: Control the torch.
whitebalance_lock:
description: White Balance Lock
description: Control the white balance lock.
video_recording:
description: Video Recording
description: Control the video recording.
motion_sensor:
description: Activate motion sensor if auto_discovery is disabled.
description: Activate motion sensor if `auto_discovery` is disabled.
required: false
type: boolean
{% endconfiguration %}
@ -147,4 +153,3 @@ android_ip_webcam:
- torch
```
[app]: https://play.google.com/store/apps/details?id=com.pas.webcam

1
source/_components/apcupsd.markdown
View File

@ -35,4 +35,3 @@ port:
type: integer
default: 3551
{% endconfiguration %}

2
source/_components/api.markdown
View File

@ -23,4 +23,4 @@ It is HIGHLY recommended that you set the `api_password`, especially if you are
api:
```
For details to use the API, please refer to the [REST API](/developers/rest_api/) or the [Python REST API documentation](/developers/python_api/) in the "Developer" section.
For details to use the API, please refer to the [REST API](/developers/rest_api/) or the [Python REST API documentation](/developers/python_api/) in the "Developer" section.

2
source/_components/apple_tv.markdown
View File

@ -19,6 +19,8 @@ The `apple_tv` platform allows you to control an Apple TV (3rd and 4th generatio
Currently, you must have Home Sharing enabled for this to work. Support for pairing Home Assistant with your device will be supported in a later release.
</p>
## {% linkable_title Configuration %}
To use this component, you must first install some system libraries and a compiler. For Debian or a similar system, this should be enough:
```shell

8
source/_components/arduino.markdown
View File

@ -14,12 +14,15 @@ ha_release: pre 0.7
ha_iot_class: "Local Polling"
---
The [Arduino](https://www.arduino.cc/) device family are microcontroller boards that are often based on the ATmega328 chip. They come with digital input/output pins (some can be used as PWM outputs), analog inputs, and a USB connection. The equipment depends on the [type](https://www.arduino.cc/en/Main/Products) of the board. The most common ones are the Arduino Uno and the Arduino Leonardo with 14 digital input/output pins and 6 analog input pins.
The [Arduino](https://www.arduino.cc/) device family are microcontroller boards that are often based on the ATmega328 chip. They come with digital input/output pins (some can be used as PWM outputs), analog inputs, and a USB connection.
The equipment depends on the [type](https://www.arduino.cc/en/Main/Products) of the board. The most common ones are the Arduino Uno and the Arduino Leonardo with 14 digital input/output pins and 6 analog input pins.
There are a lot of extensions (so-called [shields](https://www.arduino.cc/en/Main/ArduinoShields)) available. Those shields can be plugged-in into the existing connectors and stacked on top of each other. This makes it possible to expand the capabilities of the Arduino boards.
There are a lot of extensions (so-called [shields](https://www.arduino.cc/en/Main/ArduinoShields)) available. Those shields can be plugged-in into the existing connectors and stacked on top of each other. This makes it possible to expand the capabilities of the Arduino boards.
The `arduino` component is designed to let you use a directly attached board to your Home Assistant host over USB.
## {% linkable_title Configuration %}
You need to have the [Firmata firmware](https://github.com/firmata/) on your board. Please upload the `StandardFirmata` sketch to your board; please refer to the [Arduino documentation](https://www.arduino.cc/en/Main/Howto) for further information.
To integrate an Arduino boards with Home Assistant, add the following section to your `configuration.yaml` file:
@ -54,4 +57,3 @@ Add the user who is used to run Home Assistant to the groups to allow access to
```bash
$ sudo usermod -a -G dialout,lock $USER
```

3
source/_components/auth.markdown
View File

@ -13,4 +13,5 @@ ha_release: 0.73
ha_qa_scale: internal
---
This component creates the endpoints for the [authentication system](/docs/authentication/) that is built into Home Assistant. There are no configuration options for this component directly as it relies on the auth system in the core.
This component creates the endpoints for the [authentication system](/docs/authentication/) that is built into Home Assistant.
There are no configuration options for this component directly as it relies on the auth system in the core.

9
source/_components/axis.markdown
View File

@ -42,27 +42,26 @@ host:
username:
description: The username to your Axis device.
required: false
default: root
type: string
default: root
password:
description: The password to your Axis device.
required: false
default: pass
type: string
default: pass
trigger_time:
description: Minimum time (in seconds) a sensor should keep its positive value.
required: false
default: 0
type: integer
default: 0
port:
description: Configure port web server of device is accessible from.
required: false
default: 80
type: integer
default: 80
location:
description: Physical location of your Axis device.
required: false
default: not set
type: string
include:
description: This cannot be empty else there would be no use adding the device at all.

4
source/_components/bbb_gpio.markdown
View File

@ -13,5 +13,5 @@ ha_release: 0.36
ha_iot_class: "Local Push"
---
The `bbb_gpio` component is the base for all [BeagleBone Black](https://beagleboard.org/black) related GPIO platforms in Home Assistant. There is no setup needed for the component itself, for the platforms please check their corresponding pages.
The `bbb_gpio` component is the base for all [BeagleBone Black](https://beagleboard.org/black) related GPIO platforms in Home Assistant.
There is no setup needed for the component itself, for the platforms please check their corresponding pages.

24
source/_components/binary_sensor.ads.markdown
View File

@ -26,16 +26,16 @@ binary_sensor:
```
{% configuration %}
adsvar:
required: true
description: The name of the variable which you want to access on the ADS device.
type: string
name:
required: false
description: An identifier for the light in the frontend.
type: string
device_class:
required: false
description: The [type/class](/components/binary_sensor/) of the sensor to set the icon in the frontend.
type: string
adsvar:
description: The name of the variable which you want to access on the ADS device.
required: true
type: string
name:
description: An identifier for the light in the frontend.
required: false
type: string
device_class:
description: The [type/class](/components/binary_sensor/) of the sensor to set the icon in the frontend.
required: false
type: string
{% endconfiguration %}

3
source/_components/binary_sensor.android_ip_webcam.markdown
View File

@ -13,10 +13,9 @@ ha_release: "0.40"
ha_iot_class: "Local Polling"
---
The `android_ip_webcam` binary sensor platform lets you observe the motion state of [Android IP webcam](https://play.google.com/store/apps/details?id=com.pas.webcam) sensors through Home Assistant.
Devices will be configured automatically. Please refer to the [component](/components/android_ip_webcam/) configuration on how to setup.
Devices will be configured automatically. Please refer to the [Android IP webcam](/components/android_ip_webcam/) configuration on how to setup.
## {% linkable_title Examples %}

3
source/_components/binary_sensor.arest.markdown
View File

@ -13,7 +13,6 @@ ha_iot_class: "Local Polling"
ha_release: 0.9
---
The `arest` binary sensor platform allows you to get all data from your devices (like Arduinos with an ethernet/wifi connection, the ESP8266, and the Raspberry Pi) running the [aREST](http://arest.io/) RESTful framework.
## {% linkable_title Configuration %}
@ -62,5 +61,5 @@ binary_sensor:
```
<p class='note'>
This sensor is not suitable for fast state changes because there is a high possibility that the change took place between two update cycle.
This sensor is not suitable for fast state changes because there is a high possibility that the change took place between two update cycle.
</p>

5
source/_components/binary_sensor.august.markdown
View File

@ -8,7 +8,7 @@ comments: false
sharing: true
footer: true
logo: august.png
ha_category: Doorbell
ha_category: Binary Sensor
ha_release: "0.64"
ha_iot_class: "Cloud Polling"
---
@ -21,3 +21,6 @@ If you have August Doorbell, once you have enabled the [August component](/compo
* Doorbell motion sensor
* Doorbell online sensor
If you have August Smart Lock with DoorSense, once you have enabled the [August component](/components/august/), you should see the following sensors:
* Door sensor

12
source/_components/binary_sensor.aurora.markdown
View File

@ -32,17 +32,19 @@ binary_sensor:
forecast_threshold:
description: Provide your own threshold number above which the sensor will trigger.
required: false
default: 75
type: integer
default: 75
name:
description: The name of the sensor.
required: false
default: Aurora Visibility
type: string
default: Aurora Visibility
{% endconfiguration %}
## {% linkable_title Full example %}
```yaml
binary_sensor:
- platform: aurora
forecast_threshold: 50
binary_sensor:
- platform: aurora
forecast_threshold: 50
```

63
source/_components/binary_sensor.bayesian.markdown
View File

@ -14,7 +14,6 @@ ha_release: 0.53
ha_qa_scale: internal
---
The `bayesian` binary sensor platform observes the state from multiple sensors and uses [Bayes' rule](https://en.wikipedia.org/wiki/Bayes%27_theorem) to estimate the probability that an event has occurred given the state of the observed sensors. If the estimated posterior probability is above the `probability_threshold`, the sensor is `on` otherwise it is `off`.
This allows for the detection of complex events that may not be readily observable, e.g., cooking, showering, in bed, the start of a morning routine, etc. It can also be used to gain greater confidence about events that _are_ directly observable, but for which the sensors can be unreliable, e.g., presence.
@ -36,20 +35,58 @@ binary_sensor:
to_state: 'on'
```
Configuration variables:
- **prior** (*Required*): The prior probability of the event. At any point in time (ignoring all external influences) how likely is this event to occur?
- **probability_threshold** (*Optional*): The probability at which the sensor should trigger to `on`.
- **name** (*Optional*): Name of the sensor to use in the frontend. Defaults to `Bayesian Binary sensor`.
- **observations** array (*Required*): The observations which should influence the likelihood that the given event has occurred.
- **entity_id** (*Required*): Name of the entity to monitor.
- **prob_given_true** (*Required*): The probability of the observation occurring, given the event is `true`.
- **prob_given_false** (*Optional*): The probability of the observation occurring, given the event is `false` can be set as well. If `prob_given_false` is not set, it will default to `1 - prob_given_true`.
- **platform** (*Required*): The only supported observation platforms are `state` and `numeric_state`, which are modeled after their corresponding triggers for automations, requiring `below` and/or `above` instead of `to_state`.
- **to_state** (*Required*): The target state.
{% configuration %}
prior:
description: >
The prior probability of the event. At any point in time
(ignoring all external influences) how likely is this event to occur?
required: true
type: float
probability_threshold:
description: The probability at which the sensor should trigger to `on`.
required: false
type: float
default: 0.5
name:
description: Name of the sensor to use in the frontend.
required: false
type: string
default: Bayesian Binary Sensor
observations:
description: The observations which should influence the likelihood that the given event has occurred.
required: true
type: list
keys:
entity_id:
description: Name of the entity to monitor.
required: true
type: string
prob_given_true:
description: The probability of the observation occurring, given the event is `true`.
required: true
type: float
prob_given_false:
description: The probability of the observation occurring, given the event is `false` can be set as well.
required: false
type: float
default: "`1 - prob_given_true` if `prob_given_false` is not set"
platform:
description: >
The only supported observation platforms are `state` and `numeric_state`,
which are modeled after their corresponding triggers for automations,
requiring `below` and/or `above` instead of `to_state`.
required: true
type: string
to_state:
description: The target state.
required: true
type: string
{% endconfiguration %}
## {% linkable_title Full examples %}
The following is an example for the `state` observation platform.
```yaml
# Example configuration.yaml entry
binary_sensor:
@ -78,6 +115,8 @@ binary_sensor:
to_state: 'below_horizon'
```
Next up an example which targets the `numeric_state` observation platform,
as seen in the configuration it requires `below` and/or `above` instead of `to_state`.
```yaml
# Example configuration.yaml entry

8
source/_components/binary_sensor.bbb_gpio.markdown
View File

@ -48,18 +48,18 @@ pins:
bouncetime:
description: Debounce time for reading input pin defined in milliseconds [ms].
required: false
default: 50
type: integer
default: 50
invert_logic:
description: If `true`, inverts the input logic to ACTIVE LOW
required: false
default: false
type: boolean
default: false
pull_mode:
description: Type of internal pull resistor connected to input. Options are `UP` - pull-up resistor and `DOWN` - pull-down resistor.
required: false
default: UP
type: string
type: string
default: UP
{% endconfiguration %}
For more details about the GPIO layout, visit the [article](http://elinux.org/Beagleboard:BeagleBoneBlack) about the BeagleBone Black.

2
source/_components/binary_sensor.blink.markdown
View File

@ -14,4 +14,4 @@ ha_release: "0.40"
<p class='note'>
To get your Blink binary sensors working with Home Assistant, follow the instructions for the general [Blink component](/components/blink/).
</p>
</p>

16
source/_components/binary_sensor.bloomsky.markdown
View File

@ -30,8 +30,14 @@ binary_sensor:
- Rain
```
Configuration variables:
- **monitored_conditions** array (*Required*): The sensors that you wish to monitor on all of your devices. Select from these options:
- Night
- Rain
{% configuration %}
monitored_conditions:
description: "The sensors that you wish to monitor on all of your devices. Select from these options:"
required: true
type: list
keys:
night:
description: Night
rain:
description: Rain
{% endconfiguration %}

1
source/_components/binary_sensor.bmw_connected_drive.markdown
View File

@ -12,7 +12,6 @@ ha_category: Car
ha_release: 0.66
---
The `bmw_connected_drive` binary sensor platform allows you to import data on your BMW into Home Assistant.
The binary sensors will be automatically configured if `bmw_connected_drive` component is configured.

13
source/_components/binary_sensor.command_line.markdown
View File

@ -13,7 +13,6 @@ ha_release: 0.12
ha_iot_class: "Local Polling"
---
The `command_line` binary sensor platform issues specific commands to get data.
## {% linkable_title Configuration %}
@ -33,10 +32,10 @@ command:
required: true
type: string
name:
description: Let you overwrite the name of the device. By default *name* from the device is used.
description: Let you overwrite the name of the device.
required: false
default: name
type: string
default: "*name* from the device"
device_class:
description: The [type/class](/components/binary_sensor/) of the sensor to set the icon in the frontend.
required: false
@ -44,13 +43,13 @@ device_class:
payload_on:
description: The payload that represents enabled state.
required: false
default: ON
type: string
default: ON
payload_off:
description: The payload that represents disabled state.
required: false
default: OFF
type: string
default: OFF
value_template:
description: Defines a [template](/docs/configuration/templating/#processing-incoming-data) to extract a value from the payload.
required: false
@ -58,13 +57,13 @@ value_template:
scan_interval:
description: Defines number of seconds for polling interval.
required: false
default: 60
type: integer
default: 60
command_timeout:
description: Defines number of seconds for command timeout.
required: false
default: 15
type: integer
default: 15
{% endconfiguration %}
## {% linkable_title Examples %}

6
source/_components/binary_sensor.concord232.markdown
View File

@ -14,6 +14,8 @@ ha_release: 0.31
The `concord232` platform provides integration with GE, Interlogix (and other brands) alarm panels that support the RS-232 Automation Control Panel interface module (or have it built in). Supported panels include Concord 4.
## {% linkable_title Configuration %}
To enable this, add the following lines to your `configuration.yaml`:
```yaml
@ -26,11 +28,11 @@ binary_sensor:
host:
description: The host where the concord232 server process is running.
required: false
default: localhost
type: string
default: localhost
port:
description: The port where the Alarm panel is listening.
required: false
default: 5007
type: integer
default: 5007
{% endconfiguration %}

3
source/_components/binary_sensor.digital_ocean.markdown
View File

@ -15,7 +15,7 @@ ha_iot_class: "Local Polling"
The `digital_ocean` binary sensor platform allows you to monitor your Digital Ocean droplets.
### {% linkable_title Configuration %}
## {% linkable_title Configuration %}
To use your Digital Ocean droplets, you first have to set up your [Digital Ocean hub](/components/digital_ocean/) and then add the following to your `configuration.yaml` file:
@ -34,4 +34,3 @@ droplets:
required: true
type: list
{% endconfiguration %}

2
source/_components/binary_sensor.egardia.markdown
View File

@ -13,7 +13,7 @@ ha_category: Binary Sensor
ha_iot_class: "Polling"
---
The `egardia` platform allows you to get data from your [Egardia](http://www.egardia.com)/[Woonveilig](http://www.woonveilig.nl) binary sensors from within Home Assistant.
The `egardia` platform allows you to get data from your [Egardia](http://www.egardia.com)/[Woonveilig](http://www.woonveilig.nl) binary sensors from within Home Assistant.
Currently only door contacts are supported. IR sensors are not supported and will probably never be since their status cannot be read outside of the alarm control panel. Smoke sensors and others might be added but currently are not supported.
You will need to set up your [Egardia hub](/components/egardia/).

1
source/_components/binary_sensor.eight_sleep.markdown
View File

@ -13,7 +13,6 @@ ha_release: "0.44"
ha_iot_class: "Cloud Polling"
---
The `eight_sleep` binary sensor platform lets you observe the presence state of a [Eight Sleep](https://eightsleep.com/) cover/mattress through Home Assistant.
Devices will be configured automatically. Please refer to the [`eight_sleep` component](/components/eight_sleep/) configuration on how to setup.

10
source/_components/binary_sensor.enocean.markdown
View File

@ -13,14 +13,16 @@ ha_release: 0.21
ha_iot_class: "Local Push"
---
This can typically be one of those batteryless wall switches.
Tested with:
This can typically be one of those batteryless wall switches.
Tested with:
- Eltako FT55 which uses the EnOcean PTM 215 module
- [TRIO2SYS Wall switches](http://www.trio2sys.fr/index.php/fr/produits-enocean-sans-fil-sans-pile-interoperable/emetteur-sans-fils-sans-pile-interoperable-enocean) which uses the EnOcean PTM210 DB module
All switches using theses modules are expected to work. Other devices will most likely not work without changing the Home Assistant code.
## {% linkable_title Configuration %}
To use your EnOcean device, you first have to set up your [EnOcean hub](/components/enocean/) and then add the following to your `configuration.yaml` file:
```yaml
@ -38,8 +40,8 @@ id:
name:
description: An identifier for the switch in the frontend.
required: false
default: EnOcean binary sensor
type: string
default: EnOcean binary sensor
device_class:
description: The [type/class](/components/binary_sensor/) of the sensor to set the icon in the frontend.
required: false
@ -53,6 +55,8 @@ EnOcean binary sensors only generate 'button_pressed' events. The event data has
- **which**: Always `0` when using the single rocket. `0` or `1` when using the dual rocket switch.
- **onoff**: `0` or `1` for either side of the rocket.
## {% linkable_title Automation example %}
Sample automation to switch lights on and off:
```yaml

4
source/_components/binary_sensor.envisalink.markdown
View File

@ -13,8 +13,8 @@ ha_category: Binary Sensor
ha_iot_class: "Local Push"
---
The `envisalink` platform allows you to get data from your [Envisalink](http://www.eyezon.com/) binary sensors from within Home Assistant.
The `envisalink` platform allows you to get data from your [Envisalink](http://www.eyezon.com/) binary sensors from within Home Assistant.
Check the [type/class](/components/binary_sensor/) list for a possible visualization of your zone.
The requirement is that you have setup your [Envisalink hub](/components/envisalink/).

11
source/_components/binary_sensor.ffmpeg_motion.markdown
View File

@ -13,7 +13,6 @@ ha_release: 0.27
redirect_from: /components/binary_sensor.ffmpeg/
---
The `ffmpeg` platform allows you to use any video feed with [FFmpeg](http://www.ffmpeg.org/) for motion sensors in Home Assistant.
<p class='note'>
@ -47,28 +46,28 @@ name:
initial_state:
description: Start `ffmpeg` with Home Assistant.
required: false
default: true
type: boolean
default: true
changes:
description: How much needs to change between two frames to detect it as motion, value in percentage (a lower value is more sensitive).
required: false
default: 10%
type: integer
default: 10
reset:
description: The time to reset the state after no new motion is detected.
required: false
default: 20
type: integer
default: 20
repeat:
description: How many events need to be detected in *repeat_time* in order to trigger a motion, 0 repeats means deactivated.
required: false
default: 0
type: integer
default: 0
repeat_time:
description: The span of time *repeat* events need to occur in before triggering a motion, 0 seconds means deactivated.
required: false
default: 0
type: integer
default: 0
extra_arguments:
description: Extra options to pass to `ffmpeg`, e.g., video denoise filtering.
required: false

9
source/_components/binary_sensor.ffmpeg_noise.markdown
View File

@ -12,7 +12,6 @@ ha_category: Image Processing
ha_release: 0.27
---
The `ffmpeg` platform allows you to use any video or audio feed with [FFmpeg](http://www.ffmpeg.org/) for various sensors in Home Assistant.
<p class='note'>
@ -42,23 +41,23 @@ name:
initial_state:
description: Start ffmpeg with home-assistant.
required: false
default: true
type: boolean
default: true
peak:
description: The threshold of detecting noise, in dB. 0 is very loud and -100 is low.
required: false
default: -30
type: integer
default: -30
duration:
description: How long the noise needs to be over the peak to trigger the state.
required: false
default: 1
type: integer
default: 1
reset:
description: The time to reset the state after no new noise is over the peak.
required: false
default: 20
type: integer
default: 20
extra_arguments:
description: Extra options to pass to `ffmpeg`, like audio frequency filtering.
required: false

2
source/_components/binary_sensor.flic.markdown
View File

@ -15,7 +15,7 @@ ha_release: 0.35
The `flic` platform allows you to receive click events from [flic](https://flic.io) smart buttons.
The platform does not directly interact with the buttons, *but communicates with a flic service* that manages the buttons. The service can run on the same instance as Home Assistant or any other reachable machine.
The platform does not directly interact with the buttons, *but communicates with a flic service* that manages the buttons. The service can run on the same instance as Home Assistant or any other reachable machine.
#### {% linkable_title Service setup %}

12
source/_components/binary_sensor.gc100.markdown
View File

@ -23,7 +23,11 @@ binary_sensor:
- '3:2': Garage Obstruction
```
Configuration variables:
- **ports** (*Required*): A list of module-address to name mappings in the format 'x:y': name, where x is module #, y is address.
{% configuration %}
ports:
description: >
A list of module-address to name mappings in the format `'x:y': name`,
where x is module #, y is address.
required: true
type: list
{% endconfiguration %}

6
source/_components/binary_sensor.hikvision.markdown
View File

@ -61,6 +61,8 @@ and has been confirmed to work with the following models:
- DS-2CD2142FWD-I
- DS-2CD2155FWD-IS
## {% linkable_title Configuration %}
To enable this sensor,
add the following lines are required in your `configuration.yaml` file:
@ -123,6 +125,8 @@ customize:
default: 5
{% endconfiguration %}
### {% linkable_title Supported types %}
Supported sensor/event types are:
- Motion
@ -142,6 +146,8 @@ Supported sensor/event types are:
- Face Detection
- Scene Change Detection
## {% linkable_title Examples %}
Example of a configuration in your `configuration.yaml`
that utilizes the customize options for a camera:

4
source/_components/binary_sensor.hive.markdown
View File

@ -13,7 +13,6 @@ ha_release: 0.59
ha_iot_class: "Cloud Polling"
---
The `hive` binary sensor component integrates your Hive sensors into Home Assistant.
The platform supports the following Hive products:
@ -21,9 +20,6 @@ The platform supports the following Hive products:
- Hive Window or Door Sensor
- Hive Motion Sensor
<p class='note'>
Full configuration details can be found on the main [Hive component](/components/hive/) page.
</p>

3
source/_components/binary_sensor.homematic.markdown
View File

@ -13,7 +13,6 @@ ha_release: 0.23
ha_iot_class: "Local Push"
---
The `homematic` binary sensor platform lets you observe the state changes of binary [Homematic](http://www.homematic.com/) sensors through Home Assistant.
Devices will be configured automatically. Please refer to the [component](/components/homematic/) configuration on how to setup Homematic.
Devices will be configured automatically. Please refer to the [component](/components/homematic/) configuration on how to setup Homematic.

2
source/_components/binary_sensor.ihc.markdown
View File

@ -27,6 +27,8 @@ be found in the IHC project and setup as binary sensors:
- Dataline gas detector
- Dataline light sensor
## {% linkable_title Manual configuration %}
To manually configure IHC Binary Sensors
insert this section in your configuration:

4
source/_components/binary_sensor.insteon.markdown
View File

@ -13,9 +13,9 @@ ha_iot_class: "Local Push"
ha_version: 0.77
---
The `insteon` binary sensor platform lets you control your sensors through
The `insteon` binary sensor platform lets you control your sensors through
an INSTEON Modem (PLM and Hub) device connected directly to your system on a
USB, serial port or TCPIP connection. To add support, set up the primary
[insteon] component.
[insteon]: /components/insteon/
[insteon]: /components/insteon/

9
source/_components/binary_sensor.iss.markdown
View File

@ -21,6 +21,8 @@ This means that ISS is 10° above the horizon of your home.
You can check in the attributes of the sensor to see the timestamp for the next
rise of the station, its current coordinates, and the number of people in space.
## {% linkable_title Configuration %}
To add ISS binary sensor to your installation,
add the following to your `configuration.yaml` file:
@ -31,11 +33,16 @@ binary_sensor:
```
{% configuration %}
name:
description: The name for this sensor in the frontend.
required: false
type: string
default: ISS
show_on_map:
description: Option to show the position of the ISS on the map.
required: optional
type: boolean
default: false
type: string
{% endconfiguration %}
<p class='note warning'>

2
source/_components/binary_sensor.isy994.markdown
View File

@ -14,5 +14,5 @@ ha_release: pre 0.7
---
The `isy994` platform allows you to get data from your [ISY994](https://www.universal-devices.com/residential/isy994i-series/) binary sensors from within Home Assistant.
They will be automatically discovered if the `isy994` component is loaded.

8
source/_components/binary_sensor.knx.markdown
View File

@ -42,14 +42,16 @@ device_class:
significant_bit:
description: Specify which significant bit of the KNX value should be used.
required: false
default: 1
type: integer
default: 1
reset_after:
description: Reset back to OFF state after specified milliseconds.
required: false
type: integer
{% endconfiguration %}
### {% linkable_title Automation actions %}
You can also attach actions to binary sensors (e.g., to switch on a light when a switch was pressed). In this example, one light is switched on when the button was pressed once and two others when the button was pressed a second time.
```yaml
@ -81,13 +83,13 @@ name:
counter:
description: Set to 2 if your only want the action to be executed if the button was pressed twice. To 3 for three times button pressed.
required: false
default: 1
type: integer
default: 1
hook:
description: Indicates if the automation should be executed on what state of the binary sensor. Values are "on" or "off".
required: false
default: "on"
type: string
default: "on"
action:
description: Specify a list of actions analog to the [automation rules](/docs/automation/action/).
required: false

1
source/_components/binary_sensor.konnected.markdown
View File

@ -18,4 +18,3 @@ The `konnected` binary sensor allows you to monitor wired door sensors, window s
See the [`konnected`](/components/konnected/) component for configuration and setup instructions.
This component supports all of the built-in device classes of the generic [Binary Sensor](/components/binary_sensor/) component.

9
source/_components/binary_sensor.linode.markdown
View File

@ -28,9 +28,8 @@ binary_sensor:
```
{% configuration %}
nodes:
description: List of VPSs you want to control.
required: true
type: string
nodes:
description: List of VPSs you want to control.
required: true
type: string
{% endconfiguration %}

41
source/_components/binary_sensor.mqtt.markdown
View File

@ -109,12 +109,43 @@ value_template:
required: false
type: string
force_update:
description: >
Sends update events even if the value has not changed.
Useful if you want to have meaningful value graphs in history.
reqired: false
description: Sends update events even if the value hasn't changed. Useful if you want to have meaningful value graphs in history.
required: false
type: boolean
default: false
default: False
off_delay:
description: For sensors that only sends ‘On’ state updates, this variable sets a delay in seconds after which the sensor state will be updated back to ‘Off’.
required: false
type: integer
device:
description: 'Information about the device this binary sensor is a part of to tie it into the [device registry](https://developers.home-assistant.io/docs/en/device_registry_index.html). Only works through [MQTT discovery](/docs/mqtt/discovery/) and when [`unique_id`](#unique_id) is set.'
required: false
type: map
keys:
identifiers:
description: 'A list of IDs that uniquely identify the device. For example a serial number.'
required: false
type: list, string
connections:
description: 'A list of connections of the device to the outside world as a list of tuples `[connection_type, connection_identifier]`. For example the MAC address of a network interface: `"connections": [["mac", "02:5b:26:a8:dc:12"]]`.'
required: false
type: list, tuple
manufacturer:
description: 'The manufacturer of the device.'
required: false
type: string
model:
description: 'The model of the device.'
required: false
type: string
name:
description: 'The name of the device.'
required: false
type: string
sw_version:
description: 'The firmware version of the device.'
required: false
type: string
{% endconfiguration %}
## {% linkable_title Examples %}

1
source/_components/binary_sensor.mychevy.markdown
View File

@ -18,4 +18,3 @@ The `mychevy` binary sensor platform allows you to monitor your Chevy Bolt car f
The binary sensor platform will be automatically configured if the `mychevy` component is configured.
For configuration instructions, see the [`mychevy` component](/components/mychevy/) documentation.

1
source/_components/binary_sensor.mystrom.markdown
View File

@ -13,7 +13,6 @@ ha_iot_class: "Local Polling"
ha_release: 0.45
---
The `mystrom` binary sensor platform allows you to use [myStrom Wifi Buttons](https://mystrom.ch/wifi-button/) with Home Assistant. The myStrom Wifi Buttons support three and the myStrom WiFi Button + four different push pattern:
- `single`: Short push (approx. 1/2 seconds)

12
source/_components/binary_sensor.nest.markdown
View File

@ -13,13 +13,14 @@ ha_release: pre 0.7
ha_iot_class: "Cloud Push"
---
The `nest` binary sensor platform lets you monitor various states of your [Nest](https://nest.com) devices.
<p class='note'>
You must have the [Nest component](/components/nest/) configured to use these sensors. The binary sensors will be setup if the `nest` component is configured and the required configuration for the `nest binary sensor` is set.
</p>
## {% linkable_title Configuration %}
To enable binary sensors and customize which sensors are setup, you can extend the [Nest component](/components/nest/) configuration in your `configuration.yaml` file with the following settings:
```yaml
@ -33,9 +34,12 @@ nest:
By default all binary sensors for your available Nest devices will be monitored. Leave `monitored_conditions` blank to disable all binary sensors for the [Nest component](/components/nest/).
Configuration variables:
- **monitored_conditions** array (*Optional*): States to monitor.
{% configuration %}
monitored_conditions:
description: States to monitor.
required: false
type: list
{% endconfiguration %}
The following conditions are available by device:

4
source/_components/binary_sensor.netatmo.markdown
View File

@ -12,12 +12,12 @@ ha_category: Binary Sensor
ha_release: 0.31
---
### {% linkable_title Basic Configuration %}
The `netatmo` binary sensor platform is consuming the information provided by a
[Netatmo](https://www.netatmo.com) camera.
This component allows you to get the latest event seen by the camera.
### {% linkable_title Basic Configuration %}
To enable the Netatmo binary sensor, you have to set up
[netatmo](/components/netatmo/),
this will use discovery to add your binary sensor.

10
source/_components/binary_sensor.nx584.markdown
View File

@ -17,6 +17,8 @@ The `nx584` platform provides integration with GE, Caddx, Interlogix (and other
Enabling this sensor platform exposes all of your zones as binary sensors, which provides visibility through the UI as well as the ability to trigger automation actions instantly when something happens like a door opening, or a motion sensor trigger.
## {% linkable_title Configuration %}
To enable this feature, add the following lines to your `configuration.yaml`:
```yaml
@ -29,19 +31,19 @@ binary_sensor:
host:
description: This is the host where the nx584 server process is running. If unset, it is assumed to be `localhost`, which will work if the server process is running on the same system as Home Assistant.
required: false
default: localhost
type: string
default: localhost
port:
description: The port where the server process is running.
required: false
default: 5007
type: integer
default: 5007
exclude_zones:
description: This is a list of zone numbers that should be excluded. Use this to avoid exposing a zone that is of no interest, unconnected, etc.
required: false
type: [list, integer]
zone_types:
description: This is a list of zone numbers mapped to zone types. Use this to designate zones as doors, motion sensors, smoke detectors, etc. See the list of available zone types relevant to alarm zones below.
description: This is a list of zone numbers mapped to zone types. Use this to designate zones as doors, motion sensors, smoke detectors, etc. See the list of available zone types relevant to alarm zones below.
required: false
type: map
keys:
@ -59,6 +61,8 @@ zone_types:
description: Safety
{% endconfiguration %}
## {% linkable_title Full example %}
An extended configuration entry could look like this:
```yaml

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

@ -13,13 +13,14 @@ 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 sensor.
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
@ -30,9 +31,19 @@ binary_sensor:
- Printing Error
```
Configuration variables:
- **monitored_conditions** array (*Required*): States to monitor.
- **Printing**: State of the printer.
- **Printing Error**: Error while printing.
- **name** (*Optional*): The name of the sensor. Default is 'OctoPrint'.
{% 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 %}

24
source/_components/binary_sensor.opentherm_gw.markdown Normal file
View File

@ -0,0 +1,24 @@
---
layout: page
title: "OpenTherm Gateway Binary Sensor"
description: "Expose internal data from the OpenTherm Gateway."
date: 2018-10-19 18:23
sidebar: true
comments: false
sharing: true
footer: true
logo: opentherm.png
ha_category: Binary Sensor
ha_release: 0.81
ha_iot_class: "Local Push"
---
The `opentherm_gw` binary sensor platform is used to expose internal data from the [OpenTherm Gateway](http://otgw.tclcode.com/) in Home Assistant.
# {% linkable_title Configuration %}
Configuration of this platform is achieved through the [OpenTherm Gateway Hub](/components/opentherm_gw/) configuration.
<p class='note'>
The OpenTherm protocol is based on polling. The thermostat sends requests to the boiler at specific intervals. As a result, it may take some time for changes to propagate between Home Assistant and the thermostat.
</p>

1
source/_components/binary_sensor.openuv.markdown
View File

@ -16,4 +16,3 @@ ha_iot_class: "Cloud Polling"
The `openuv` binary sensor platform allows you to view binary sensor data from [OpenUV](http://openuv.io).
You must have the [`openuv` component](/components/openuv/) configured to use this platform. After configuring that component, binary sensors will automatically appear.

2
source/_components/binary_sensor.pilight.markdown
View File

@ -67,6 +67,8 @@ reset_delay_sec:
default: 30
{% endconfiguration %}
## {% linkable_title Full example %}
A full configuration example could look like this:
```yaml

7
source/_components/binary_sensor.ping.markdown
View File

@ -13,7 +13,6 @@ ha_release: 0.43
ha_qa_scale: internal
---
The `ping` binary sensor platform allows you to using `ping` to send ICMP echo requests. This way you can check if a given host is online and determine the round trip times from your Home Assistant instance to that system.
## {% linkable_title Configuration %}
@ -26,6 +25,7 @@ binary_sensor:
- platform: ping
host: 192.168.0.1
```
{% configuration %}
host:
description: The IP address or hostname of the system you want to track.
@ -40,10 +40,10 @@ name:
description: Let you overwrite the name of the device.
required: false
type: string
default: "`Ping Binary sensor`"
default: Ping Binary sensor
{% endconfiguration %}
The sensor exposes the different round trip times values measured by `ping` as attributes:
The sensor exposes the different round trip times values measured by `ping` as attributes:
- `round trip time mdev`
- `round trip time avg`
@ -64,4 +64,3 @@ binary_sensor:
<p class='note'>
When run on Windows systems, the round trip time attributes are rounded to the nearest millisecond and the mdev value is unavailable.
</p>

17
source/_components/binary_sensor.raincloud.markdown
View File

@ -25,8 +25,15 @@ binary_sensor:
- platform: raincloud
```
Configuration variables:
- **monitored_conditions** array (*Optional*): Conditions to display in the frontend. If not specified, all conditions below will be enabled by default. The following conditions can be monitored.
- **is_watering**: Return if is currently watering per zone.
- **status**: Return status from the Melnor RainCloud Controller and Melnor RainCloud Faucet.
{% configuration %}
monitored_conditions:
description: Conditions to display in the frontend. The following conditions can be monitored.
required: false
type: list
default: If not specified,, all conditions below will be enabled
keys:
is_watering:
description: Return if is currently watering per zone.
status:
description: Return status from the Melnor RainCloud Controller and Melnor RainCloud Faucet.
{% endconfiguration %}

2
source/_components/binary_sensor.rainmachine.markdown
View File

@ -14,7 +14,7 @@ ha_release: 0.71
---
The `rainmachine` binary sensor platform allows you to view crucial sensor data
within a [RainMachine smart Wi-Fi sprinkler controller](http://www.rainmachine.com/).
within a [RainMachine smart Wi-Fi sprinkler controller](http://www.rainmachine.com/).
<p class='note'>
You must have the [RainMachine component](https://www.home-assistant.io/components/rainmachine/)

2
source/_components/binary_sensor.random.markdown
View File

@ -31,5 +31,5 @@ name:
description: Name to use in the frontend.
required: false
type: string
default: Random Binary Sensor
{% endconfiguration %}

48
source/_components/binary_sensor.raspihats.markdown
View File

@ -35,16 +35,44 @@ binary_sensor:
name: PIR Bedroom
```
Configuration variables:
- **i2c_hats** (*Optional*): Array of used I2C-HATs.
- **board** (*Required*): The board name [Di16, Di6Rly6, DI16ac, DI6acDQ6rly].
- **address** (*Required*): The board I2C address, hex value.
- **channels** (*Required*): Array of used digital input channels.
- **index** (*Required*): Digital input channel index.
- **name** (*Required*): Friendly name to use for the frontend.
- **invert_logic** (*Optional*): Inverts the input logic, default is `false`.
- **device_class** (*Optional*): See device classes in [binary_sensor component](/components/binary_sensor/), default is `None`
{% configuration %}
i2c_hats:
description: An array of used I2C-HATs.
required: false
type: list
keys:
board:
description: The board name either Di16, Di6Rly6, DI16ac or DI6acDQ6rly.
required: true
type: string
address:
description: The board I2C address as HEX value.
required: true
type: string
channels:
description: Array of used digital input channels.
required: true
type: list
keys:
index:
description: Digital input channel index.
required: true
type: integer
name:
description: Friendly name to use for the frontend.
required: true
type: string
invert_logic:
description: Inverts the input logic.
required: false
default: false
type: boolean
device_class:
description: See device classes in [binary_sensor component](/components/binary_sensor/).
required: false
default: "None"
type: string
{% endconfiguration %}
## {% linkable_title Directions for installing smbus support on Raspberry Pi %}

2
source/_components/binary_sensor.rest.markdown
View File

@ -33,6 +33,8 @@ The JSON messages can contain different values like `1`, `"1"`,
}
```
## {% linkable_title Configuration %}
To enable this sensor,
add the following lines to your `configuration.yaml` file for a GET request:

95
source/_components/binary_sensor.rflink.markdown Normal file
View File

@ -0,0 +1,95 @@
---
layout: page
title: "RFLink Binary Sensor"
description: "Instructions on how to integrate RFLink binary sensors into Home Assistant."
date: 2018-10-04
sidebar: true
comments: false
sharing: true
footer: true
logo: rflink.png
ha_category: Binary Sensor
ha_iot_class: "Local Push"
ha_release: "0.81"
---
The `rflink` component supports devices that use [RFLink gateway firmware](http://www.nemcon.nl/blog2/), for example, the [Nodo RFLink Gateway](https://www.nodo-shop.nl/nl/21-rflink-gateway). RFLink gateway is an Arduino firmware that allows two-way communication with a multitude of RF wireless devices using cheap hardware (Arduino + transceiver).
First, you have to set up your [RFLink hub](/components/rflink/).
The RFLink component does not know the difference between a `binary_sensor`, a `switch` and a `light`. Therefore all switchable devices are automatically added as `light` by default.
RFLink binary_sensor/switch/light ID's are composed of: protocol, id, switch/channel. For example: `newkaku_0000c6c2_1`.
Once the ID of a binary sensor is known, it can be used to configure it as a binary sensor type in Home Assistant, for example, to hide it or configure a nice name.
Configuring a device as a binary sensor:
```yaml
# Example configuration.yaml entry
binary_sensor:
- platform: rflink
devices:
pt2262_00174754_0: {}
```
{% configuration %}
devices:
description: A list of binary sensors.
required: false
type: map
keys:
rflink_ids:
description: RFLink ID of the device
required: true
type: map
keys:
name:
description: Name of the device, defaults to RFLink ID.
required: false
type: string
aliases:
description: Alternative RFLink ID's this device is known by.
required: false
type: list
device_class:
description: The [type or class of the sensor](/components/binary_sensor/) to set the icon in the frontend.
required: false
type: string
off_delay:
description: For sensors that only sends 'On' state updates, this variable sets a delay after which the sensor state will be updated back to 'Off'.
required: false
type: int
force_update:
description: Sends update events even if the value has not changed. Useful for sensors that only sends `On`.
required: false
type: boolean
default: false
{% endconfiguration %}
### {% linkable_title Sensor state %}
Initially, the state of a binary sensor is unknown. When a sensor update is received, the state is known and will be shown in the frontend.
### {% linkable_title Device support %}
See [device support](/components/rflink/#device-support)
### {% linkable_title Additional configuration examples %}
Multiple sensors with custom name and device class and set off_delay
```yaml
# Example configuration.yaml entry
binary_sensor:
- platform: rflink
devices:
pt2262_00174754_0:
name: PIR Entrance
device_class: motion
off_delay: 5
pt2262_00174758_0:
name: PIR Living Room
device_class: motion
off_delay: 5
```

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

@ -21,7 +21,7 @@ them may be recognized under the X10 protocol but most of them are recognized
under the *Lighting4* protocol. The rfxtrx binary sensor component provides
some special options for them, while other rfxtrx protocols should work too.
# Setting up your devices
## {% linkable_title Setting up your devices %}
Once you have set up your [rfxtrx hub](/components/rfxtrx/), the easiest way
to find your binary sensors is to add this to your `configuration.yaml`:
@ -50,11 +50,47 @@ binary_sensor:
name: device_name
```
Configuration variables:
- **automatic_add** (*Optional*): To enable the automatic addition of new binary sensors.
- **device_class** (*Optional*): The [type or class of the sensor](/components/binary_sensor/) to set the icon in the frontend.
- **off_delay** (*Optional*): For sensors that only sends 'On' state updates, this variable sets a delay after which the sensor state will be updated back to 'Off'.
{% configuration %}
devices:
description: A list of devices.
required: false
type: list
keys:
name:
description: Override the name to use in the frontend.
required: false
type: string
device_class:
description: "The [type or class of the sensor](/components/binary_sensor/) to set the icon in the frontend."
required: false
type: device_class
fire_event:
description: Fires an event even if the state is the same as before. Can be used for automations.
required: false
type: boolean
default: false
off_delay:
description: For sensors that only sends 'On' state updates, this variable sets a delay after which the sensor state will be updated back to 'Off'.
required: false
type: integer
data_bits:
description: Defines how many bits are used for commands inside the data packets sent by the device.
required: false
type: integer
command_on:
description: Defines the data bits value that is sent by the device upon an 'On' command.
required: false
type: string
command_off:
description: Defines the data bits value that is sent by the device upon an 'Off' command.
required: false
type: string
automatic_add:
description: To enable the automatic addition of new binary sensors.
required: false
type: boolean
default: false
{% endconfiguration %}
<p class='note warning'>
This component and the [rfxtrx switch](/components/switch/rfxtrx/) can steal each other's devices when setting the `automatic_add` configuration parameter to `true`.
@ -95,7 +131,7 @@ binary_sensor:
seconds: 5
```
## Options for PT-2262 devices under the Lighting4 protocol
### {% linkable_title Options for PT-2262 devices under the Lighting4 protocol %}
When a data packet is transmitted by a PT-2262 device using the Lighting4
protocol, there is no way to automatically extract the device identifier and the
@ -104,9 +140,9 @@ and the fields lengths are not included in the data. One device that sends 2
different commands will be seen as 2 devices on Home Assistant. For such cases,
the following options are available in order to circumvent the problem:
- **data_bits** (*Optional*): Defines how many bits are used for commands inside the data packets sent by the device.
- **command_on** (*Optional*): Defines the data bits value that is sent by the device upon an 'On' command.
- **command_off** (*Optional*): Defines the data bits value that is sent by the device upon an 'Off' command.
- **data_bits** (*Optional*)
- **command_on** (*Optional*)
- **command_off** (*Optional*)
Let's try to add a new PT-2262 sensor using the "automatic_add"
option and have a look at Home Assistant system log.
@ -165,7 +201,7 @@ This automatic guess should work most of the time but there is
no guarantee on that. You should activate it only when you
want to configure your new devices and leave it off otherwise.
## Known working devices
### {% linkable_title Known working devices %}
The following devices are known to work with the rfxtrx binary sensor component.
There are too many other to list.

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

@ -28,13 +28,33 @@ binary_sensor:
12: PIR Bedroom
```
Configuration variables:
- **ports** array (*Required*): Array of used ports.
- **port: name** (*Required*): Port numbers (BCM mode pin numbers) and corresponding names.
- **pull_mode** (*Optional*): The internal pull to use (UP or DOWN). Default is UP.
- **bouncetime** (*Optional*): The time in milliseconds for port debouncing. Default is 50ms.
- **invert_logic** (*Optional*): If true, inverts the output logic to ACTIVE LOW. Default is false (ACTIVE HIGH).
{% configuration %}
ports:
description: List of used ports.
required: true
type: map
keys:
"port: name":
description: The port numbers (BCM mode pin numbers) and corresponding names.
required: true
type: string
bouncetime:
description: The time in milliseconds for port debouncing.
required: false
type: integer
default: 50
invert_logic:
description: If `true`, inverts the output logic to ACTIVE LOW.
required: false
type: boolean
default: "`false` (ACTIVE HIGH)"
pull_mode:
description: >
Type of internal pull resistor to use.
Options are `UP` - pull-up resistor and `DOWN` - pull-down resistor.
required: false
type: string
default: "`UP`"
{% endconfiguration %}
For more details about the GPIO layout, visit the Wikipedia [article](https://en.wikipedia.org/wiki/Raspberry_Pi#GPIO_connector) about the Raspberry Pi.

34
source/_components/binary_sensor.rpi_pfio.markdown
View File

@ -32,11 +32,29 @@ binary_sensor:
settle_time: 50
```
Configuration variables:
- **ports** array (*Required*): Array of used ports.
- **num** (*Required*): Port number.
- **name** (*Required*): Port name.
- **settle_time** (*Optional*): The time in milliseconds for port debouncing. Default is 2 0ms.
- **invert_logic** (*Optional*): If true, inverts the output logic to ACTIVE LOW. Default is false (ACTIVE HIGH).
{% configuration %}
ports:
description: List of used ports.
required: true
type: map
keys:
num:
description: The port number.
required: true
type: map
keys:
name:
description: The port name.
required: true
type: string
settle_time:
description: The time in milliseconds for port debouncing.
required: false
type: integer
default: 20
invert_logic:
description: If `true`, inverts the output logic to ACTIVE LOW.
required: false
type: boolean
default: "`false` (ACTIVE HIGH)"
{% endconfiguration %}

4
source/_components/binary_sensor.skybell.markdown
View File

@ -30,9 +30,9 @@ binary_sensor:
{% configuration %}
monitored_conditions:
type: list
required: true
description: Conditions to display in the frontend. The following conditions can be monitored.
required: true
type: list
keys:
button:
description: Returns whether the doorbell button was pressed.

4
source/_components/binary_sensor.spc.markdown
View File

@ -13,8 +13,8 @@ ha_category: Binary Sensor
ha_iot_class: "Local Push"
---
The `spc` platform allows you to get data from your [Vanderbilt SPC](http://www.spc-intruder-detection.com/ssp-spc/) binary sensors from within Home Assistant.
The `spc` platform allows you to get data from your [Vanderbilt SPC](http://www.spc-intruder-detection.com/ssp-spc/) binary sensors from within Home Assistant.
Check the [type/class](/components/binary_sensor/) list for a possible visualization of your zone. Currently motion, smoke and door sensors are supported.
The requirement is that you have setup your [SPC hub](/components/spc/).

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

@ -14,8 +14,9 @@ ha_release: 0.47
ha_iot_class: "Local Polling"
---
The `tapsaff` binary sensor provides the 'Taps Aff' status for a given location within the UK using [Taps Aff](http://www.taps-aff.co.uk).
The `tapsaff` binary sensor provides the 'Taps Aff' status for a given location within the UK using [Taps Aff](http://www.taps-aff.co.uk).
## {% linkable_title Configuration %}
To enable this sensor, add the following lines to your `configuration.yaml`:
@ -26,7 +27,14 @@ binary_sensor:
location: glasgow
```
Configuration variables:
- **location** (*Required*): The location for the Taps Aff. It must be configured with a UK postcode or city to work.
- **name** (*Optional*): The name to use when displaying this sensor.
{% configuration %}
location:
description: The location for the Taps Aff. It must be configured with a UK postcode or city to work.
required: true
type: string
name:
description: The name to use when displaying this sensor.
required: false
type: string
default: Taps Aff
{% endconfiguration %}

76
source/_components/binary_sensor.tcp.markdown
View File

@ -14,53 +14,57 @@ ha_release: 0.14
The TCP Binary Sensor is a type of [TCP Sensor](/components/sensor.tcp/) which is either "off" or "on". In order to use this sensor type, in addition to the configuration for the TCP Sensor, you must supply a `value_on` value to represent what is returned when the device is turned on.
## {% linkable_title Configuration %}
To enable this sensor, add the following lines to your `configuration.yaml`:
```yaml
binary_sensor:
# Example configuration.yaml entry
platform: tcp
name: TCP Binary Sensor
host: IP_ADDRESS
port: PORT
payload: "r State\n"
value_on: 1
timeout: 5
binary_sensor:
- platform: tcp
name: TCP Binary Sensor
host: IP_ADDRESS
port: PORT
payload: "r State\n"
value_on: 1
timeout: 5
```
Configuration options for the a TCP Sensor:
{% configuration %}
name:
required: true
description: The name you'd like to give the sensor in Home Assistant.
type: string
description: The name you'd like to give the sensor in Home Assistant.
required: false
type: string
default: TCP Sensor
host:
required: true
description: The hostname/IP address to connect to.
type: string
description: The hostname/IP address to connect to.
required: true
type: string
port:
required: true
description: The port to connect to the host on.
type: integer
description: The port to connect to the host on.
required: true
type: integer
payload:
required: true
description: What to send to the host in order to get the response we're interested in.
type: string
description: What to send to the host in order to get the response we're interested in.
required: true
type: string
value_on:
required: true
description: The value returned when the device is "on".
type: string
timeout:
required: false
description: How long in seconds to wait for a response from the service before giving up and disconnecting. Defaults to 10.
type: integer
description: The value returned when the device is "on".
required: true
type: string
value_template:
required: false
description: Defines a [template](/docs/configuration/templating/#processing-incoming-data) to extract the value. By default it's assumed that the entire response is the value.
type: string
description: Defines a [template](/docs/configuration/templating/#processing-incoming-data) to extract the value.
required: false
type: template
default: entire response is the value
buffer_size:
required: false
description: The size of the receive buffer in bytes. Set this to a larger value if you expect to receive a response larger than the default. Defaults to 1024.
type: integer
{% endconfiguration %}
description: The size of the receive buffer in bytes. Set this to a larger value if you expect to receive a response larger than the default.
required: false
type: integer
default: 1024
timeout:
description: How long in seconds to wait for a response from the service before giving up and disconnecting.
required: false
type: integer
default: 10
{% endconfiguration %}

1
source/_components/binary_sensor.tellduslive.markdown
View File

@ -13,4 +13,3 @@ featured: false
---
Integrates Telldus Live binary sensors into Home Assistant. See the [main component](/components/tellduslive/) for configuration instructions.

92
source/_components/binary_sensor.template.markdown
View File

@ -14,10 +14,12 @@ logo: home-assistant.png
ha_qa_scale: internal
---
The `template` platform supports sensors which breaks out the `state` and
The `template` platform supports sensors which break out the `state` and
`state_attributes` from other entities. The state of a Template Binary Sensor
can only be `on` or `off`.
## {% linkable_title Configuration %}
To enable Template Binary Sensors in your installation, add the following to
your `configuration.yaml` file:
@ -34,50 +36,50 @@ binary_sensor:
```
{% endraw %}
{% configuration binary_sensor.template %}
sensors:
description: List of your sensors.
required: true
type: map
keys:
sensor_name:
description: The slug of the sensor.
required: true
type: map
keys:
friendly_name:
description: Name to use in the frontend.
required: false
type: string
entity_id:
description: A list of entity IDs so the sensor only reacts to state changes of these entities. This can be used if the automatic analysis fails to find all relevant entities.
required: false
type: string, list
device_class:
description: The type/class of the sensor to set the icon in the frontend.
required: false
type: device_class
default: None
value_template:
description: Defines a template to set the state of the sensor.
required: true
type: template
icon_template:
description: Defines a template for the icon of the sensor.
required: false
type: template
entity_picture_template:
description: Defines a template for the entity picture of the sensor.
required: false
type: template
delay_on:
description: The amount of time the template state must be ***met*** before this sensor will switch to `on`.
required: false
type: time
delay_off:
description: The amount of time the template state must be ***not met*** before this sensor will switch to `off`.
required: false
type: time
{% configuration %}
sensors:
description: List of your sensors.
required: true
type: map
keys:
sensor_name:
description: The slug of the sensor.
required: true
type: map
keys:
friendly_name:
description: Name to use in the frontend.
required: false
type: string
entity_id:
description: A list of entity IDs so the sensor only reacts to state changes of these entities. This can be used if the automatic analysis fails to find all relevant entities.
required: false
type: string, list
device_class:
description: The type/class of the sensor to set the icon in the frontend.
required: false
type: device_class
default: None
value_template:
description: Defines a template to set the state of the sensor.
required: true
type: template
icon_template:
description: Defines a template for the icon of the sensor.
required: false
type: template
entity_picture_template:
description: Defines a template for the entity picture of the sensor.
required: false
type: template
delay_on:
description: The amount of time the template state must be ***met*** before this sensor will switch to `on`.
required: false
type: time
delay_off:
description: The amount of time the template state must be ***not met*** before this sensor will switch to `off`.
required: false
type: time
{% endconfiguration %}
## {% linkable_title Considerations %}

2
source/_components/binary_sensor.tesla.markdown
View File

@ -14,7 +14,7 @@ ha_release: 0.53
---
The `tesla` platform allows you to get data from your [Tesla](https://www.tesla.com/) sensors from within Home Assistant.
They will be automatically discovered if the Tesla component is loaded.
For more configuration information see the [Tesla component](/components/tesla/) documentation.

4
source/_components/binary_sensor.threshold.markdown
View File

@ -14,7 +14,6 @@ ha_release: 0.34
ha_qa_scale: internal
---
The `threshold` binary sensor platform observes the state of another sensor. If the value is below (`lower`) or higher (`upper`) than the given threshold then state of the threshold sensor is changed. It support also a range if `lower` and `upper` are given.
If the sensor is configured with no hysteresis and the sensor value is equal to the threshold, the sensor is turned off since it is not `lower` or `upper` with respect to the threshold.
@ -61,6 +60,5 @@ name:
description: Name of the sensor to use in the frontend.
required: false
type: string
default:
default: Threshold
{% endconfiguration %}

2
source/_components/binary_sensor.vera.markdown
View File

@ -14,5 +14,5 @@ ha_release: pre 0.7
---
The `vera` platform allows you to get data from your [Vera](http://getvera.com/) binary sensors from within Home Assistant.
They will be automatically discovered if the vera component is loaded.

2
source/_components/binary_sensor.verisure.markdown
View File

@ -16,4 +16,4 @@ Integrates Verisure binary sensors into Home Assistant. See the [main component]
The following binary sensor types are supported:
Door & Window
- Door & Window

4
source/_components/binary_sensor.vultr.markdown
View File

@ -15,6 +15,8 @@ ha_iot_class: "Cloud Polling"
The `vultr` binary sensor platform allows you to monitor your [Vultr](https://www.vultr.com/) subscription to see if it is powered on or not.
## {% linkable_title Configuration %}
To use this binary sensor, you first have to set up your [Vultr hub](/components/vultr/).
<p class='note'>
@ -42,6 +44,7 @@ name:
type: string
{% endconfiguration %}
## {% linkable_title Full example %}
Full `configuration.yaml` (produces `binary_sensor.totally_awesome_server`):
@ -51,4 +54,3 @@ binary_sensor:
name: totally_awesome_server
subscription: 12345
```

3
source/_components/binary_sensor.wink.markdown
View File

@ -13,12 +13,10 @@ ha_release: 0.14
ha_iot_class: "Cloud Polling"
---
The Wink binary sensor platform allows you to get data from your [Wink](http://www.wink.com/) binary sensors.
The requirement is that you have setup [Wink](/components/wink/).
### {% linkable_title Supported Binary sensor devices %}
- Smoke and CO detectors (No Wink hub required for Nest)
@ -36,4 +34,3 @@ The requirement is that you have setup [Wink](/components/wink/).
<p class='note'>
The above devices are confirmed to work, but others may work as well.
</p>

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

@ -56,4 +56,3 @@ monitored_conditions:
battery:
description: On means tag battery is low, Off means normal.
{% endconfiguration %}

12
source/_components/binary_sensor.workday.markdown
View File

@ -45,13 +45,13 @@ name:
country:
description: >
Country code according to
[holidays](https://pypi.python.org/pypi/holidays/0.9.4) notation.
[holidays](https://pypi.org/project/holidays/) notation.
required: true
type: string
province:
description: >
Province code according to
[holidays](https://pypi.python.org/pypi/holidays/0.9.4) notation.
[holidays](https://pypi.org/project/holidays/) notation.
required: false
type: string
workdays:
@ -82,6 +82,8 @@ If you use the sensor for Canada (`CA`) with Ontario (`ON`) as `province:` then
Otherwise the value is evaluated as `true` (check the YAML documentation for further details) and the sensor will not work.
</p>
## {% linkable_title Automation example %}
Example usage for automation:
```yaml
@ -98,3 +100,9 @@ automation:
service: switch.turn_on
entity_id: switch.heater
```
<p class='note'>
Please remember that [as explained here][devices] you can only have a single `automation:` entry. Add the automation to your existing automations.
</p>
[devices]: https://www.home-assistant.io/docs/configuration/devices/

Some files were not shown because too many files have changed in this diff Show More