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-09 10:26:52 +00:00
Code Issues Packages Projects Releases Wiki Activity

Merge branch 'next' into rc

Browse Source
This commit is contained in:
Paulus Schoutsen 2019-02-13 20:42:00 -08:00
commit b18e459b07
363 changed files with 9335 additions and 8628 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

1
.themes/classic/sass/partials/_sidebar.scss
View File

@ -1,4 +1,3 @@
@import "sidebar/base";
@import "sidebar/googleplus";
@import "sidebar/pinboard";
@import "sidebar/delicious";

26
.themes/classic/sass/partials/sidebar/_googleplus.scss
View File

@ -1,26 +0,0 @@
.googleplus {
h1 {
-moz-box-shadow: none !important;
-webkit-box-shadow: none !important;
-o-box-shadow: none !important;
box-shadow: none !important;
border-bottom: 0px none !important;
}
a {
text-decoration: none;
white-space: normal !important;
line-height: 32px;
img {
float: left;
margin-right: 0.5em;
border: 0 none;
}
}
}
.googleplus-hidden {
position: absolute;
top: -1000em;
left: -1000em;
}

11
.themes/classic/source/_includes/asides/googleplus.html
View File

@ -1,11 +0,0 @@
{% if site.googleplus_user %}
<section class="googleplus{% if site.googleplus_hidden %} googleplus-hidden{% endif %}">
<h1>
<a href="https://plus.google.com/{{ site.googleplus_user }}?rel=author">
<img src="http://www.google.com/images/icons/ui/gprofile_button-32.png" width="32" height="32">
Google+
</a>
</h1>
</section>
{% endif %}

5
_config.yml
View File

@ -99,11 +99,6 @@ twitter_tweet_button: true
google_plus_one: true
google_plus_one_size: standard
# Google Plus Profile
# Hidden: No visible button, just add author information to search results
googleplus_user: +PaulusSchoutsen
googleplus_hidden: true
# Pinboard
pinboard_user:
pinboard_count: 3

1
sass/partials/_sidebar.scss
View File

@ -1,4 +1,3 @@
@import "sidebar/base";
@import "sidebar/googleplus";
@import "sidebar/pinboard";
@import "sidebar/delicious";

26
sass/partials/sidebar/_googleplus.scss
View File

@ -1,26 +0,0 @@
.googleplus {
h1 {
-moz-box-shadow: none !important;
-webkit-box-shadow: none !important;
-o-box-shadow: none !important;
box-shadow: none !important;
border-bottom: 0px none !important;
}
a {
text-decoration: none;
white-space: normal !important;
line-height: 32px;
img {
float: left;
margin-right: 0.5em;
border: 0 none;
}
}
}
.googleplus-hidden {
position: absolute;
top: -1000em;
left: -1000em;
}

22
source/_addons/lets_encrypt.markdown
View File

@ -79,4 +79,26 @@ Use this in your `automations.yaml` to attempt certificate renewal each day at m
addon: core_letsencrypt
```
If you are using the [Nginx Proxy add-on] you will need need to stop this during the renewal process. This can be achieved by stopping the add-on whilst restarting the Let's Encrypt add-on. This can be achieved the following configuration:
```yaml
- id: letsencrypt-renewal
alias: 'LetsEncrypt renewal'
trigger:
- platform: time
at: '00:00:00'
action:
- service: hassio.addon_stop
data:
addon: core_nginx_proxy
- service: hassio.addon_restart
data:
addon: core_letsencrypt
- delay: '00:01:30'
- service: hassio.addon_start
data:
addon: core_nginx_proxy
```
[DuckDNS add-on]: /addons/duckdns/
[Nginx Proxy add-on]: /addons/nginx_proxy/

59
source/_components/abode.markdown
View File

@ -8,28 +8,43 @@ comments: false
sharing: true
footer: true
logo: abode.jpg
ha_category: Hub
ha_category:
- Hub
- Alarm
- Binary Sensor
- Camera
- Cover
- Light
- Lock
- Sensor
- Switch
ha_release: 0.52
ha_iot_class: "Cloud Push"
redirect_from:
- /components/alarm_control_panel.abode/
- /components/binary_sensor.abode/
- /components/camera.abode/
- /components/cover.abode/
- /components/lock.abode/
- /components/light.abode/
- /components/switch.abode/
- /components/sensor.abode/
---
The `abode` component will allow users to integrate their Abode Home Security
systems into Home Assistant and use its alarm system and sensors to automate
their homes.
The `abode` component will allow users to integrate their Abode Home Security systems into Home Assistant and use its alarm system and sensors to automate their homes.
Please visit the [Abode website](https://goabode.com/) for further information
about Abode Security.
Please visit the [Abode website](https://goabode.com/) for further information about Abode Security.
There is currently support for the following device types within Home Assistant:
- [Alarm Control Panel](/components/alarm_control_panel.abode/): Reports on the current alarm status and can be used to arm and disarm the system.
- [Binary Sensor](/components/binary_sensor.abode/): Reports on `Quick Actions`, `Door Contacts`, `Connectivity` sensors (remotes, keypads, and status indicators), `Moisture` sensors, and `Motion` or `Occupancy` sensors.
- [Camera](/components/camera.abode/): Reports on `Camera` devices and will download and show the latest captured still image.
- [Cover](/components/cover.abode/): Reports on `Secure Barriers` and can be used to open and close the cover.
- [Lock](/components/cover.abode/): Reports on `Door Locks` and can be used to lock and unlock the door.
- [Light](/components/light.abode/): Reports on `Dimmer` lights and can be used to dim or turn the light on and off.
- [Switch](/components/switch.abode/): Reports on `Power Switch` devices and can be used to turn the power switch on and off. Also reports on `Automations` set up in the Abode system and allows you to activate or deactivate them.
- [Sensor](/components/sensor.abode/): Reports on `Temperature`, `Humidity`, and `Light` sensors.
- **Alarm Control Panel**: Reports on the current alarm status and can be used to arm and disarm the system.
- [**Binary Sensor**](/components/abode/#binary-sensor): Reports on `Quick Actions`, `Door Contacts`, `Connectivity` sensors (remotes, keypads, and status indicators), `Moisture` sensors, and `Motion` or `Occupancy` sensors.
- **Camera**: Reports on `Camera` devices and will download and show the latest captured still image.
- **Cover**: Reports on `Secure Barriers` and can be used to open and close the cover.
- **Lock**: Reports on `Door Locks` and can be used to lock and unlock the door.
- [**Light**](/components/abode/#light): Reports on `Dimmer` lights and can be used to dim or turn the light on and off.
- [**Switch**](/components/abode/#switch): Reports on `Power Switch` devices and can be used to turn the power switch on and off. Also reports on `Automations` set up in the Abode system and allows you to activate or deactivate them.
- **Sensor**: Reports on `Temperature`, `Humidity`, and `Light` sensors.
## {% linkable_title Configuration %}
@ -141,3 +156,19 @@ Trigger a quick action automation on your Abode system.
| Service data attribute | Optional | Description |
| ---------------------- | -------- | ----------- |
| `entity_id` | No | String or list of strings that point at `entity_id`s of binary_sensors that represent your Abode quick actions.
### {% linkable_title Binary Sensor %}
This component will add `Door Contacts`, `Connectivity` sensors (remotes, keypads, and status indicators), `Moisture` sensors, and `Motion` or `Occupancy` sensors.
This component will also list all Abode `Quick Actions` that are set up. You can trigger these quick actions by passing the `entity_id` of your quick action binary sensor to the [trigger_quick_action service](/components/abode/#trigger_quick_action).
### {% linkable_title Light %}
This component will automatically add `Lights` configured in your Abode account. You can reclassify `Switches` to show up within Home Assistant as lights by listing the Abode device ID in your [configuration](/components/abode/#configuration).
### {% linkable_title Switch %}
This component will automatically add `Power Switches` configured in your Abode account. You can reclassify switches to show up within Home Assistant as `Lights` by listing the Abode device ID in your [configuration](/components/abode/#configuration).
This component will also list all Abode `Automations` that are set up within the Abode system, allowing you to activate and deactivate the automations.

142
source/_components/ads.markdown
View File

@ -8,13 +8,30 @@ comments: false
sharing: true
footer: true
logo: beckhoff.png
ha_category: Hub
ha_category:
- Hub
- Binary Sensor
- Light
- Sensor
- Switch
ha_release: "0.60"
ha_iot_class: "Local Push"
redirect_from:
- /components/binary_sensor.ads/
- /components/light.ads/
- /components/sensor.ads/
- /components/switch.ads/
---
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.
There is currently support for the following device types within Home Assistant:
- [Binary Sensor](#binary-sensor)
- [Light](#light)
- [Sensor](#sensor)
- [Switch](#switch)
## {% linkable_title Configuration %}
To enable ADS, add the following lines to your `configuration.yaml` file:
@ -58,3 +75,126 @@ Service parameters:
- **adsvar**: Name of the variable on the ADS device. To access global variables on *TwinCAT2* use a prepending dot `.myvariable`, for TwinCAT3 use `GBL.myvariable`.
- **adstype**: Specify the type of the variable. Use one of the following: `int`, `byte`, `uint`, `bool`
- **value**: The value that will be written in the variable.
## {% linkable_title Binary Sensor %}
The `ads` binary sensor platform can be used to monitor a boolean value on your ADS device.
To use your ADS device, you first have to set up your [ADS hub](/components/ads/) and then add the following to your `configuration.yaml`
file:
```yaml
# Example configuration.yaml entry
binary_sensor:
- platform: ads
adsvar: .boolean1
```
{% configuration %}
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 %}
## {% linkable_title Light %}
The `ads` light platform allows you to control your connecte ADS lights.
To use your ADS device, you first have to set up your [ADS hub](/components/ads/) and then add the following to your `configuration.yaml`
file:
```yaml
# Example configuration.yaml entry
light:
- platform: ads
adsvar: GVL.enable_light
adsvar_brightness: GVL.brightness
```
{% configuration %}
adsvar:
required: true
description: The name of the boolean variable that switches the light on
type: string
adsvar_brightness:
required: false
description: The name of the variable that controls the brightness, use an unsigned integer on the PLC side
type: integer
name:
required: false
description: An identifier for the Light in the frontend
type: string
{% endconfiguration %}
## {% linkable_title Sensor %}
The `ads` sensor platform allows reading the value of a numeric variable on your ADS device. The variable can be of type *INT*, *UINT* or *BYTE*.
To use your ADS device, you first have to set up your [ADS hub](/components/ads/) and then add the following to your `configuration.yaml`
file:
```yaml
# Example configuration.yaml entry
sensor:
- platform: ads
adsvar: GVL.temperature
unit_of_measurement: '°C'
adstype: integer
```
{% configuration %}
adsvar:
required: true
description: The name of the variable which you want to access.
type: string
adstype:
required: false
description: The datatype of the ADS variable, possible values are int, uint, byte.
default: int
type: string
name:
required: false
description: An identifier for the sensor.
type: string
factor:
required: false
description: A factor that divides the stored value before displaying in Home Assistant.
default: 1
type: integer
{% endconfiguration %}
The *factor* can be used to implement fixed decimals. E.g., set *factor* to 100 if you want to display a fixed decimal value with two decimals. A variable value of `123` will be displayed as `1.23`.
## {% linkable_title Switch %}
The `ads` switch platform accesses a boolean variable on the connected ADS device. The variable is identified by its name.
To use your ADS device, you first have to set up your [ADS hub](/components/ads/) and then add the following to your `configuration.yaml`
file:
```yaml
# Example configuration.yaml entry
switch:
- platform: ads
adsvar: .global_bool
```
{% 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 switch in the frontend.
type: string
{% endconfiguration %}

18
source/_components/alarm_control_panel.abode.markdown
View File

@ -1,18 +0,0 @@
---
layout: page
title: "Abode Alarm Control Panel"
description: "Instructions on how to setup the Abode Alarm control panel within Home Assistant."
date: 2017-08-26 0:28
sidebar: true
comments: false
sharing: true
footer: true
logo: abode.jpg
ha_category: Alarm
ha_release: 0.52
ha_iot_class: "Cloud Push"
---
The `abode` security control panel platform allows you to control your [Abode](https://goabode.com/) alarms.
The requirement is that you have setup your [Abode hub](/components/abode/).

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

@ -1,83 +0,0 @@
---
layout: page
title: "Arlo Control Panel"
description: "Instructions on how to setup the Netgear Arlo Base Stations as a control panel within Home Assistant."
date: 2017-10-05 17:45
sidebar: true
comments: false
sharing: true
footer: true
logo: arlo.png
ha_category: Alarm
ha_release: 0.56
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:
```yaml
# Example configuration.yaml entry
alarm_control_panel:
- platform: arlo
```
{% configuration %}
home_mode_name:
description: "Arlo base station does not have a built-in home mode. You can map one of your custom modes to Home Assistant's home mode by setting the name of the custom mode in this configuration variable. The name of the custom mode should match exactly as you set it up in the Arlo app."
required: false
type: string
away_mode_name:
description: "Arlo base station does not have a built-in away mode. You can map one of your custom modes to Home Assistant's away mode by setting the name of the custom mode in this configuration variable. The name of the custom mode should match eactly as you set it up in the Arlo app."
required: false
type: string
default: "`Armed` mode in Arlo"
night_mode_name:
description: "Arlo base station does not have a built-in night mode. You can map one of your custom modes to Home Assistant's night mode by setting the name of the custom mode in this configuration variable. The name of the custom mode should match eactly as you set it up in the Arlo app."
required: false
type: string
default: "`Armed` mode in Arlo"
{% endconfiguration %}
## {% linkable_title Examples %}
These examples are based on an Arlo base station named `my_arlo_base_station`. Replace this with the name of your base station's `entity_id`.
Arming the Arlo Base Station when leaving.
```yaml
- id: arm_arlo_when_leaving
alias: Arm Arlo cameras when leaving
trigger:
platform: state
entity_id: group.family
from: home
to: not_home
action:
service: alarm_control_panel.alarm_arm_away
entity_id: alarm_control_panel.my_arlo_base_station
```
Setting Arlo to a custom mode (mapped to `home_mode_name` in `configuration.yaml`) when arriving.
```yaml
- id: disarm_arlo_when_arriving
alias: Set Arlo cameras to Home mode when arriving
trigger:
platform: state
entity_id: group.family
from: not_home
to: home
action:
service: alarm_control_panel.alarm_arm_home
entity_id: alarm_control_panel.my_arlo_base_station
```
You can also completely disarm the Arlo base station by calling the `alarm_control_panel.alarm_disarm` service, and trigger the alarm by calling the `alarm_control_panel.alarm_trigger` service.
More examples and configuration options can be found on the [Manual Alarm Control page](/components/alarm_control_panel.manual/#examples).

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

@ -1,17 +0,0 @@
---
layout: page
title: "Blink Alarm Control Panel"
description: "Instructions for how to setup Blink alarm control panel within Home Assistant."
date: 2018-10-01 22:13
sidebar: true
comments: false
sharing: true
footer: true
logo: blink.png
ha_category: Alarm
ha_release: "0.80"
---
<p class='note'>
To get your Blink alarm control panel working with Home Assistant, follow the instructions for the general [Blink component](/components/blink/).
</p>

18
source/_components/alarm_control_panel.canary.markdown
View File

@ -1,18 +0,0 @@
---
layout: page
title: "Canary Alarm Control Panel"
description: "Instructions on how to integrate your Canary devices into Home Assistant."
date: 2017-12-07 22:00
sidebar: true
comments: false
sharing: true
footer: true
logo: canary.png
ha_category: Alarm
ha_release: "0.60"
ha_iot_class: "Cloud Polling"
---
The `canary` alarm control panel platform allows you to integrate your [Canary](https://canary.is) alarm system in Home Assistant.
To add `canary` alarm control panel to your installation, follow instructions in [Canary component](/components/canary/).

16
source/_components/alarm_control_panel.egardia.markdown
View File

@ -1,16 +0,0 @@
---
layout: page
title: "Egardia / Woonveilig Alarm Control Panel"
description: "Instructions on how to integrate Egardia / Woonveilig into Home Assistant."
date: 2016-07-02 22:00
sidebar: true
comments: false
sharing: true
footer: true
logo: egardia.png
ha_release: 0.51
ha_category: Alarm
---
The `egardia` platform allows you to integrate your [Egardia](http://www.egardia.com)/[Woonveilig](http://www.woonveilig.nl) alarm control panel in Home Assistant.
You will need to set up your [Egardia hub](/components/egardia/).

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

@ -1,18 +0,0 @@
---
layout: page
title: "Envisalink Alarm"
description: "Instructions on how to setup the Envisalink Alarm control panel within Home Assistant."
date: 2016-07-01 08:00
sidebar: true
comments: false
sharing: true
footer: true
logo: eyezon.png
ha_category: Alarm
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/).

21
source/_components/alarm_control_panel.homematicip_cloud.markdown
View File

@ -1,21 +0,0 @@
---
layout: page
title: "HomematicIP Cloud Alarm Control Panel"
description: "Instructions on how to integrate HomematicIP alarm control panel into Home Assistant."
date: 2018-05-18 22:40
sidebar: true
comments: false
sharing: true
footer: true
logo: homematicip_cloud.png
ha_category: Sensor
ha_release: 0.73
ha_iot_class: "Cloud Push"
---
The `homematicip_cloud` alarm_control_panel platform allows you to control your [HomematicIP](https://www.homematic-ip.com) `Security Zones` through Home Assistant.
This component will automatically add `Security Zones` configured in your HomematicIP cloud.
Please refer to the
[component](/components/homematicip_cloud/) configuration on how to setup HomematicIP Cloud.

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

@ -205,3 +205,65 @@ automation:
- service: alarm_control_panel.alarm_disarm
entity_id: alarm_control_panel.house_alarm
```
Sending a Notification when the Alarm is Armed (Away/Home), Disarmed and in Pending Status
{% raw %}
```yaml
- alias: 'Send notification when alarm is Disarmed'
initial_state: 'on'
trigger:
- platform: state
entity_id: alarm_control_panel.home_alarm
to: 'disarmed'
action:
- service: notify.notify
data:
message: "ALARM! The alarm is Disarmed at {{ states('sensor.date__time') }}"
```
{% endraw %}
{% raw %}
```yaml
- alias: 'Send notification when alarm is in pending status'
initial_state: 'on'
trigger:
- platform: state
entity_id: alarm_control_panel.home_alarm
to: 'pending'
action:
- service: notify.notify
data:
message: "ALARM! The alarm is in pending status at {{ states('sensor.date__time') }}"
```
{% endraw %}
{% raw %}
```yaml
- alias: 'Send notification when alarm is Armed in Away mode'
initial_state: 'on'
trigger:
- platform: state
entity_id: alarm_control_panel.home_alarm
to: 'armed_away'
action:
- service: notify.notify
data:
message: "ALARM! The alarm is armed in Away mode {{ states('sensor.date__time') }}"
```
{% endraw %}
{% raw %}
```yaml
- alias: 'Send notification when alarm is Armed in Home mode'
initial_state: 'on'
trigger:
- platform: state
entity_id: alarm_control_panel.home_alarm
to: 'armed_home'
action:
- service: notify.notify
data:
message: "ALARM! The alarm is armed in Home mode {{ states('sensor.date__time') }}"
```
{% endraw %}

19
source/_components/alarm_control_panel.ness_alarm.markdown
View File

@ -1,19 +0,0 @@
---
layout: page
title: "Ness Alarm Control Panel"
description: "Instructions on how to setup the Ness alarm control panel within Home Assistant."
date: 2018-11-25 18:00
sidebar: true
comments: false
sharing: true
footer: true
logo: ness.png
ha_category: Alarm
ha_release: 0.85
ha_iot_class: "Local Push"
---
The `ness_alarm` alarm control panel platform allows you to control your [Ness](http://nesscorporation.com/) D8x and D16x alarms.
The alarm control panel is automatically added by configuring the [Ness alarm](/components/ness_alarm/) component.

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

@ -1,18 +0,0 @@
---
layout: page
title: "Satel Integra Alarm Control Panel"
description: "Instructions on how to setup the Satel Integra control panel within Home Assistant."
date: 2017-09-07 13:28
sidebar: true
comments: false
sharing: true
footer: true
logo: satel.jpg
ha_category: Alarm
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/).

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

@ -1,35 +0,0 @@
---
layout: page
title: "Verisure Alarm"
description: "Instructions on how to setup the Verisure Alarm control panel within Home Assistant."
date: 2016-02-15 22:00
sidebar: true
comments: false
sharing: true
footer: true
logo: verisure.png
ha_category: Alarm
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/).
The `changed_by` attribute enables one to be able to take different actions depending on who armed/disarmed the alarm in [automation](/getting-started/automation/).
```yaml
automation:
- alias: Alarm status changed
trigger:
- platform: state
entity_id: alarm_control_panel.alarm_1
action:
- service: notify.notify
data_template:
message: >
{% raw %}Alarm changed from {{ trigger.from_state.state }}
to {{ trigger.to_state.state }}
by {{ trigger.to_state.attributes.changed_by }}{% endraw %}
```

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

@ -1,27 +0,0 @@
---
layout: page
title: "Wink Alarm"
description: "Instructions on how to setup the Wink alarms within Home Assistant."
date: 2017-01-14 12:00
sidebar: true
comments: false
sharing: true
footer: true
logo: wink.png
ha_category: Alarm
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>

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

@ -7,6 +7,7 @@ sidebar: true
comments: false
sharing: true
footer: true
logo: yale.png
ha_category: Alarm
ha_release: 0.78
---

129
source/_components/ambient_station.markdown
View File

@ -14,10 +14,9 @@ redirect_from:
---
The `Ambient Weather Station` component retrieves local weather information
via personal weather stations from
[Ambient Weather](https://ambientweather.net).
via personal weather stations from [Ambient Weather](https://ambientweather.net).
## {% linkable_title Generating API Keys and Application Keys %}
## {% linkable_title Setup %}
Using this component requires both an Application Key and an API Key. To
generate both, simply utilize the profile section of
@ -31,8 +30,8 @@ following to your `configuration.yaml` file:
```yaml
# Example configuration.yaml entry
ambient_station:
api_key: <YOUR API KEY>
app_key: <YOUR APPLICATION KEY>
api_key: YOUR_API_KEY
app_key: YOUR_APPLICATION_KEY
```
{% configuration %}
@ -57,6 +56,26 @@ monitored_conditions:
description: Relative atmospheric pressure
battout:
description: Weather station battery health
batt1:
description: Sensor 1 battery health
batt2:
description: Sensor 2 battery health
batt3:
description: Sensor 3 battery health
batt4:
description: Sensor 4 battery health
batt5:
description: Sensor 5 battery health
batt6:
description: Sensor 6 battery health
batt7:
description: Sensor 7 battery health
batt8:
description: Sensor 8 battery health
batt9:
description: Sensor 9 battery health
batt10:
description: Sensor 10 battery health
co2:
description: CO2 level
dailyrainin:
@ -71,6 +90,26 @@ monitored_conditions:
description: Hourly rain accumulation
humidity:
description: Outdoor humidity
humidity1:
description: Sensor 1 humidity
humidity2:
description: Sensor 2 humidity
humidity3:
description: Sensor 3 humidity
humidity4:
description: Sensor 4 humidity
humidity5:
description: Sensor 5 humidity
humidity6:
description: Sensor 6 humidity
humidity7:
description: Sensor 7 humidity
humidity8:
description: Sensor 8 humidity
humidity9:
description: Sensor 9 humidity
humidity10:
description: Sensor 10 humidity
humidityin:
description: Indoor humidity
lastRain:
@ -79,8 +118,88 @@ monitored_conditions:
description: Max daily wind gust
monthlyrainin:
description: Monthly rain accumulation
relay1:
description: Sensor 1 relay status
relay2:
description: Sensor 2 relay status
relay3:
description: Sensor 3 relay status
relay4:
description: Sensor 4 relay status
relay5:
description: Sensor 5 relay status
relay6:
description: Sensor 6 relay status
relay7:
description: Sensor 7 relay status
relay8:
description: Sensor 8 relay status
relay9:
description: Sensor 9 relay status
relay10:
description: Sensor 10 relay status
soilhum1:
description: Sensor 1 soil humidity
soilhum2:
description: Sensor 2 soil humidity
soilhum3:
description: Sensor 3 soil humidity
soilhum4:
description: Sensor 4 soil humidity
soilhum5:
description: Sensor 5 soil humidity
soilhum6:
description: Sensor 6 soil humidity
soilhum7:
description: Sensor 7 soil humidity
soilhum8:
description: Sensor 8 soil humidity
soilhum9:
description: Sensor 9 soil humidity
soilhum10:
description: Sensor 10 soil humidity
soiltemp1f:
description: Sensor 1 soil temperature
soiltemp2f:
description: Sensor 2 soil temperature
soiltemp3f:
description: Sensor 3 soil temperature
soiltemp4f:
description: Sensor 4 soil temperature
soiltemp5f:
description: Sensor 5 soil temperature
soiltemp6f:
description: Sensor 6 soil temperature
soiltemp7f:
description: Sensor 7 soil temperature
soiltemp8f:
description: Sensor 8 soil temperature
soiltemp9f:
description: Sensor 9 soil temperature
soiltemp10f:
description: Sensor 10 soil temperature
solarradiation:
description: Solar radiation
temp1f:
description: Sensor 1 temperature
temp2f:
description: Sensor 2 temperature
temp3f:
description: Sensor 3 temperature
temp4f:
description: Sensor 4 temperature
temp5f:
description: Sensor 5 temperature
temp6f:
description: Sensor 6 temperature
temp7f:
description: Sensor 7 temperature
temp8f:
description: Sensor 8 temperature
temp9f:
description: Sensor 9 temperature
temp10f:
description: Sensor 10 temperature
tempf:
description: Outdoor temperature
tempinf:

60
source/_components/android_ip_webcam.markdown
View File

@ -8,15 +8,32 @@ comments: false
sharing: true
footer: true
logo: android_ip_webcam.png
ha_category: Hub
ha_category:
- Hub
- Binary Sensor
- Camera
- Sensor
- Switch
ha_release: "0.40"
ha_iot_class: "Local Polling"
redirect_from:
- /components/binary_sensor.android_ip_webcam/
- /components/camera.android_ip_webcam/
- /components/sensor.android_ip_webcam/
- /components/switch.android_ip_webcam/
---
The `android_ip_webcam` component turns any Android phone or tablet into a network camera with multiple viewing options.
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.
There is currently support for the following device types within Home Assistant:
- Binary Sensor
- Camera
- Sensor
- Switch
## {% linkable_title Setup %}
Download [the IP Webcam app](https://play.google.com/store/apps/details?id=com.pas.webcam) and launch the app. When you press 'Start Server', it will start streaming video from your phone and the IP address of the device will be shown on screen.
@ -153,3 +170,44 @@ android_ip_webcam:
- torch
```
## {% linkable_title Binary Sensor %}
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.
## {% linkable_title Examples %}
You can also setup the binary motion sensor with the following script:
{% raw %}
```yaml
binary_sensor:
- platform: rest
name: Kitchen Motion
sensor_class: motion
resource: http://IP:8080/sensors.json?sense=motion_active
value_template: '{{ value_json.motion_active.data[0][1][0] | round(0) }}'
```
{% endraw %}
## {% linkable_title Camera %}
The `android_ip_webcam` component adds a camera by default if you choose not to use the component but still want to see the video feed then the [`mjpeg` camera](/components/camera.mjpeg/) platform can be used.
## {% linkable_title Configuration %}
To enable only the camera in your installation, add the following to your `configuration.yaml` file:
```yaml
# Example configuration.yaml entry
camera:
- platform: mjpeg
mjpeg_url: http://IP_ADDRESS:8080/video
```
## {% linkable_title Sensor %}
The `android_ip_webcam` sensor platform lets you observe states of [Android IP webcam](https://play.google.com/store/apps/details?id=com.pas.webcam) sensors through Home Assistant. Devices will be configured automatically.
You can setup your own sensors by examining the JSON file from the webcam server: http://IP:8080/sensors.json

2
source/_components/aqualogic.markdown
View File

@ -28,7 +28,7 @@ aqualogic:
{% configuration %}
host:
description: The domain name or IP address of the RS-485 to Ethernet adapter connected to the pool controller, eg. 192.168.1.1.
description: The domain name or IP address of the RS-485 to Ethernet adapter connected to the pool controller, e.g., 192.168.1.1.
required: true
type: string
port:

168
source/_components/arlo.markdown
View File

@ -8,13 +8,27 @@ comments: false
sharing: true
footer: true
logo: arlo.png
ha_category: Hub
ha_category:
- Hub
- Alarm
- Camera
- Sensor
ha_release: 0.46
ha_iot_class: "Cloud Polling"
redirect_from:
- /components/alarm_control_panel.arlo/
- /components/camera.arlo/
- /components/sensor.arlo/
---
The `arlo` implementation allows you to integrate your [Arlo](https://arlo.netgear.com/) devices in Home Assistant.
There is currently support for the following device types within Home Assistant:
- [Alarm](#alarm)
- [Camera](#camera)
- [Sensor](#sensor)
## {% linkable_title Configuration %}
To enable device linked in your [Arlo](https://arlo.netgear.com/) account, add the following to your `configuration.yaml` file:
@ -58,3 +72,155 @@ The Arlo component also provides a camera service to enable/disable the motion d
service: camera.enable_motion_detection
entity_id: camera.arlo_frontdoor
```
## {% linkable_title Alarm %}
### {% linkable_title Configuration %}
Once you have enabled the [Arlo component](/components/arlo), add the following to your `configuration.yaml` file:
```yaml
# Example configuration.yaml entry
alarm_control_panel:
- platform: arlo
```
{% configuration %}
home_mode_name:
description: "Arlo base station does not have a built-in home mode. You can map one of your custom modes to Home Assistant's home mode by setting the name of the custom mode in this configuration variable. The name of the custom mode should match exactly as you set it up in the Arlo app."
required: false
type: string
away_mode_name:
description: "Arlo base station does not have a built-in away mode. You can map one of your custom modes to Home Assistant's away mode by setting the name of the custom mode in this configuration variable. The name of the custom mode should match eactly as you set it up in the Arlo app."
required: false
type: string
default: "`Armed` mode in Arlo"
night_mode_name:
description: "Arlo base station does not have a built-in night mode. You can map one of your custom modes to Home Assistant's night mode by setting the name of the custom mode in this configuration variable. The name of the custom mode should match eactly as you set it up in the Arlo app."
required: false
type: string
default: "`Armed` mode in Arlo"
{% endconfiguration %}
### {% linkable_title Examples %}
These examples are based on an Arlo base station named `my_arlo_base_station`. Replace this with the name of your base station's `entity_id`.
Arming the Arlo Base Station when leaving.
```yaml
- id: arm_arlo_when_leaving
alias: Arm Arlo cameras when leaving
trigger:
platform: state
entity_id: group.family
from: home
to: not_home
action:
service: alarm_control_panel.alarm_arm_away
entity_id: alarm_control_panel.my_arlo_base_station
```
Setting Arlo to a custom mode (mapped to `home_mode_name` in `configuration.yaml`) when arriving.
```yaml
- id: disarm_arlo_when_arriving
alias: Set Arlo cameras to Home mode when arriving
trigger:
platform: state
entity_id: group.family
from: not_home
to: home
action:
service: alarm_control_panel.alarm_arm_home
entity_id: alarm_control_panel.my_arlo_base_station
```
You can also completely disarm the Arlo base station by calling the `alarm_control_panel.alarm_disarm` service, and trigger the alarm by calling the `alarm_control_panel.alarm_trigger` service.
More examples and configuration options can be found on the [Manual Alarm Control page](/components/alarm_control_panel.manual/#examples).
## {% linkable_title Camera %}
This component is not yet able to live stream from your Arlo camera, but it will be able to playback the last video capture.
### {% linkable_title Configuration %}
Once you have enabled the [Arlo component](/components/arlo), add the following to your `configuration.yaml` file:
```yaml
# Example configuration.yaml entry
camera:
- platform: arlo
ffmpeg_arguments: '-pred 1 -q:v 2'
```
{% configuration %}
ffmpeg_arguments:
description: Extra options to pass to ffmpeg, e.g., image quality or video filter options.
required: false
type: string
{% endconfiguration %}
**Note:** To be able to playback the last capture, it is required to install the `ffmpeg` component. Make sure to follow the steps mentioned at [FFMPEG](/components/ffmpeg/) documentation.
## {% linkable_title Sensor %}
To get your [Arlo](https://arlo.netgear.com/) sensors working within Home Assistant, please follow the instructions for the general [Arlo component](/components/arlo).
This platform does not support Arlo Q.
### {% linkable_title Configuration %}
Once you have enabled the [Arlo component](/components/arlo), add the following to your `configuration.yaml` file:
```yaml
# Example configuration.yaml entry
sensor:
- platform: arlo
monitored_conditions:
- captured_today
- last_capture
- total_cameras
- battery_level
- signal_strength
```
Additionally, for Arlo Baby cameras that have additional sensors, you can add them to the `monitored_conditions` collection:
```yaml
# Additional sensors available for Arlo Baby cameras
sensor:
- platform: arlo
monitored_conditions:
# ...
- temperature
- humidity
- air_quality
```
{% configuration %}
monitored_conditions:
description: Conditions to display in the frontend. The following conditions can be monitored.
required: false
type: list
keys:
captured_today:
description: Return the number of videos captured on the current day.
last_capture:
description: Return the timestamp from the last video captured by your Arlo camera.
total_cameras:
description: Return the number of recognized and active cameras linked on your Arlo account.
battery_level:
description: Return the battery level of your Arlo camera.
signal_strength:
description: Return the wireless signal strength of your Arlo camera.
temperature:
description: Return the ambient temperature detected by your Arlo Baby camera.
humidity:
description: Return the ambient relative humidity detected by your Arlo Baby camera.
air_quality:
description: Return the ambient air quality (a reading of volatile organic compounds (VOCs) in parts per million) detected by your Arlo Baby camera.
{% endconfiguration %}
If no **monitored_conditions** are specified, all of above will be enabled by default.

31
source/_components/asuswrt.markdown
View File

@ -28,7 +28,7 @@ asuswrt:
{% configuration %}
host:
description: "The IP address of your router, eg. `192.168.1.1`."
description: "The IP address of your router, e.g., `192.168.1.1`."
required: true
type: string
username:
@ -67,7 +67,6 @@ sensors:
description: List of enabled sensors
required: false
type: list
default: all (`upload`, `download`, `upload_speed`, `download_speed`)
keys:
"upload":
description: TX upload sensor
@ -80,5 +79,29 @@ sensors:
{% endconfiguration %}
<p class='note warning'>
You need to [enable telnet](https://www.asus.com/support/faq/1005449/) on your router if you choose to use `protocol: telnet`.
</p>
You need to [enable telnet](https://www.asus.com/support/faq/1005449/) on your router if you choose to use `protocol: telnet`.
</p>
### {% linkable_title Example Sensor Configuration %}
To enable ASUSWRT sensors as part of your installation, reference the following example configuration:
```yaml
# Example configuration.yaml entry
asuswrt:
host: YOUR_ROUTER_IP
username: YOUR_ADMIN_USERNAME
ssh_key: /config/id_rsa
sensors:
- upload
- download
- upload_speed
- download_speed
```
The example above, creates the following sensors:
* sensor.asuswrt_download (unit_of_measurement: Gigabyte - *Daily accumulation*)
* sensor.asuswrt_download_speed (unit_of_measurement: Mbit/s)
* sensor.asuswrt_upload (unit_of_measurement: Gigabyte - *Daily accumulation*)
* sensor.asuswrt_upload_speed (unit_of_measurement: Mbit/s)

35
source/_components/august.markdown
View File

@ -8,12 +8,27 @@ comments: false
sharing: true
footer: true
logo: august.png
ha_category: Doorbell
ha_category:
- Doorbell
- Binary Sensor
- Camera
- Lock
ha_release: "0.64"
ha_iot_class: "Cloud Polling"
redirect_from:
- /components/binary_sensor.august/
- /components/camera.august/
- /components/lock.august/
---
The `august` component allows you to integrate your [August](http://august.com) devices in Home Assistant. Currently this component supports August Lock and Doorbell.
The `august` component allows you to integrate your [August](http://august.com) devices in Home Assistant.
There is currently support for the following device types within Home Assistant:
- Doorbell
- Binary Sensor
- Camera
- Lock
<p class='note'>
August Lock 2nd Gen will need either August Connect or Doorbell to connect to Home Assistant.
@ -54,3 +69,19 @@ timeout:
{% endconfiguration %}
Once Home Assistant is started, a configurator will pop up asking you to enter verification code that is sent to your phone number or email.
### {% linkable_title Binary Sensor %}
If you have August Doorbell, once you have enabled the August component, you should see following sensors:
- Doorbell ding sensor
- Doorbell motion sensor
- Doorbell online sensor
If you have August Smart Lock with DoorSense, once you have enabled the August component, you should see the following sensors:
- Door sensor
### {% linkable_title Camera %}
The `august` camera platform allows you to view the latest camera image (triggered by motion) by your [August](http://august.com) device in Home Assistant.

24
source/_components/axis.markdown
View File

@ -8,9 +8,14 @@ comments: false
sharing: true
footer: true
logo: axis.png
ha_category: Camera
ha_category:
- Camera
- Binary Sensor
ha_release: "0.45"
ha_iot_class: "Local Polling"
redirect_from:
- /components/binary_sensor.axis/
- /components/camera.axis/
---
[Axis Communications](https://www.axis.com/) devices are surveillance cameras and other security-related network connected hardware. Sensor API works with firmware 5.50 and newer.
@ -114,9 +119,11 @@ Any specific levels for triggers needs to be configured on the device.
</p>
## {% linkable_title Device services %}
Available services: `vapix_call`.
#### {% linkable_title Service `axis/vapix_call` %}
### {% linkable_title Service `axis/vapix_call` %}
Send a command using [Vapix](https://www.axis.com/support/developer-support/vapix). For details please read the API specifications.
| Service data attribute | Optional | Description |
@ -131,3 +138,16 @@ Response to call can be subscribed to on event `vapix_call_response`
## {% linkable_title Troubleshooting discovery %}
If a `169.x.x.x` address is discovered. On your camera, go to **System Options** -> **Advanced** -> **Plain Config**. Change the drop-down box to `network` and click `Select Group`. If `Network Interface I0 ZeroConf` contains the `169.x.x.x` IP address, unchecked the box next to `Enabled` for this section and click `Save`.
## {% linkable_title Binary Sensor %}
The `Axis` platform allows you to get data from your [Axis](https://www.axis.com/) devices from within Home Assistant.
The following sensor types are supported:
- Motion detection
- Passive IR motion detection
- Sound detection
- Day/night mode
- Tampering detection
- Input port

22
source/_components/binary_sensor.abode.markdown
View File

@ -1,22 +0,0 @@
---
layout: page
title: "Abode Binary Sensor"
description: "Instructions on how to integrate Abode binary sensors into Home Assistant."
date: 2017-08-26 0:28
sidebar: true
comments: false
sharing: true
footer: true
logo: abode.jpg
ha_release: 0.52
ha_category: Binary Sensor
ha_iot_class: "Cloud Push"
---
The `abode` security control panel platform allows you to control your [Abode](https://goabode.com/) alarms.
This component will add `Door Contacts`, `Connectivity` sensors (remotes, keypads, and status indicators), `Moisture` sensors, and `Motion` or `Occupancy` sensors.
This component will also list all Abode `Quick Actions` that are set up. You can trigger these quick actions by passing the `entity_id` of your quick action binary sensor to the [trigger_quick_action service](/components/abode/#trigger_quick_action).
The requirement is that you have setup your [Abode hub](/components/abode/).

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

@ -1,41 +0,0 @@
---
layout: page
title: "ADS Binary Sensor"
description: "Instructions on how to set up ADS binary sensors within Home Assistant."
date: 2017-10-25 10:00
sidebar: true
comments: false
sharing: true
footer: true
logo: beckhoff.png
ha_category: Binary Sensor
ha_release: "0.60"
ha_iot_class: "Local Push"
---
The `ads` binary sensor platform can be used to monitor a boolean value on your ADS device.
To use your ADS device, you first have to set up your [ADS hub](/components/ads/) and then add the following to your `configuration.yaml`
file:
```yaml
# Example configuration.yaml entry
binary_sensor:
- platform: ads
adsvar: .boolean1
```
{% configuration %}
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 %}

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

@ -1,33 +0,0 @@
---
layout: page
title: "Android IP Webcam Binary Sensor"
description: "Instructions on how to integrate binary motion sensors for Android IP webcam within Home Assistant."
date: 2017-03-10 00:00
sidebar: true
comments: false
sharing: true
footer: true
logo: android_ip_webcam.png
ha_category: Binary Sensor
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 [Android IP webcam](/components/android_ip_webcam/) configuration on how to setup.
## {% linkable_title Examples %}
You can also setup the binary motion sensor with the following script:
{% raw %}
```yaml
binary_sensor:
- platform: rest
name: Kitchen Motion
sensor_class: motion
resource: http://IP:8080/sensors.json?sense=motion_active
value_template: '{{ value_json.motion_active.data[0][1][0] | round(0) }}'
```
{% endraw %}

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

@ -1,26 +0,0 @@
---
layout: page
title: "August Binary Sensor"
description: "Instructions on how to integrate your August devices into Home Assistant."
date: 2018-02-17 22:00
sidebar: true
comments: false
sharing: true
footer: true
logo: august.png
ha_category: Binary Sensor
ha_release: "0.64"
ha_iot_class: "Cloud Polling"
---
To get your [August](http://august.com) doorbell binary sensors working within Home Assistant, please follow the instructions for the general [August component](/components/august/).
If you have August Doorbell, once you have enabled the [August component](/components/august/), you should see following sensors:
* Doorbell ding sensor
* 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

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

@ -1,27 +0,0 @@
---
layout: page
title: "Axis Binary Sensor"
description: "Instructions on how to integrate Axis binary sensors into Home Assistant."
date: 2017-04-01 19:00
sidebar: true
comments: false
sharing: true
footer: true
logo: axis.png
ha_category: Binary Sensor
ha_iot_class: "Local Push"
ha_release: "0.45"
---
The `Axis` platform allows you to get data from your [Axis](https://www.axis.com/) devices from within Home Assistant.
See the [Axis main component](/components/axis/) for configuration instructions.
The following sensor types are supported:
- Motion detection
- Passive IR motion detection
- Sound detection
- Day/night mode
- Tampering detection
- Input port

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

@ -1,17 +0,0 @@
---
layout: page
title: "Blink Binary Sensor"
description: "Instructions for how to setup Blink binary sensors within Home Assistant."
date: 2017-03-05 22:13
sidebar: true
comments: false
sharing: true
footer: true
logo: blink.png
ha_category: Binary Sensor
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>

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

@ -1,19 +0,0 @@
---
layout: page
title: "BMW Connected Drive Binary Sensor"
description: "Instructions on how to setup your BMW Connected Drive account with Home Assistant."
date: 2018-02-22 23:00
sidebar: true
comments: false
sharing: true
footer: true
logo: bmw.png
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.
For more configuration information see the [`bmw_connected_drive` component](/components/bmw_connected_drive/) documentation.

35
source/_components/binary_sensor.deconz.markdown
View File

@ -1,35 +0,0 @@
---
layout: page
title: "deCONZ Binary Sensor"
description: "Instructions on how to integrate Zigbee binary sensors from deCONZ into Home Assistant."
date: 2017-11-12 16:30
sidebar: true
comments: false
sharing: true
footer: true
logo: deconz.jpeg
ha_category: Binary Sensor
ha_release: "0.61"
ha_iot_class: "Local Push"
---
See the [deCONZ main component](/components/deconz/) for configuration instructions.
The following sensor types are supported:
* Fire/Smoke detection
* Open/Close detection
* Presence detection
* Water leakage detection
The `entity_id` name will be `binary_sensor.device_name`, where `device_name` is defined in deCONZ.
#### {% linkable_title Verified supported binary sensors %}
- Open/Close Detection
- Xiaomi Smart Home Security Door & Window Contact Sensor
- Presence Detection
- IKEA Trådfri Motion Sensor
- Philips Hue Motion Sensor
- Xiaomi Motion Sensor
- Xiaomi Smart Home Aqara Human Body Sensor

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

@ -1,36 +0,0 @@
---
layout: page
title: "Digital Ocean Binary Sensor"
description: "Instructions on how to set up Digital Ocean binary sensors within Home Assistant."
date: 2016-09-24 08:00
sidebar: true
comments: false
sharing: true
footer: true
ha_category: System Monitor
logo: digital_ocean.png
ha_release: "0.30"
ha_iot_class: "Local Polling"
---
The `digital_ocean` binary sensor platform allows you to monitor your Digital Ocean droplets.
## {% 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:
```yaml
# Example configuration.yaml entry
binary_sensor:
- platform: digital_ocean
droplets:
- 'fedora-512mb-nyc3-01'
- 'coreos-512mb-nyc3-01'
```
{% configuration %}
droplets:
description: List of droplets you want to monitor.
required: true
type: list
{% endconfiguration %}

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

@ -1,19 +0,0 @@
---
layout: page
title: "Egardia Binary Sensor"
description: "Instructions on how to integrate Egardia / Woonveilig binary sensors into Home Assistant."
date: 2018-03-02 09:00
sidebar: true
comments: false
sharing: true
footer: true
logo: egardia.png
ha_release: 0.65
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.
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/).

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

@ -1,18 +0,0 @@
---
layout: page
title: "Eight Sleep Binary Sensor"
description: "Instructions on how to integrate binary motion sensors for Eight Sleep within Home Assistant."
date: 2017-04-24 00:00
sidebar: true
comments: false
sharing: true
footer: true
logo: eight_sleep.png
ha_category: Health
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.

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

@ -1,20 +0,0 @@
---
layout: page
title: "Envisalink Binary Sensor"
description: "Instructions on how to integrate Envisalink binary sensors into Home Assistant."
date: 2016-07-01 08:00
sidebar: true
comments: false
sharing: true
footer: true
logo: eyezon.png
ha_release: 0.23
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.
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/).

21
source/_components/binary_sensor.homematicip_cloud.markdown
View File

@ -1,21 +0,0 @@
---
layout: page
title: "HomematicIP Cloud Binary Sensor"
description: "Instructions on how to integrate HomematicIP binary sensors within Home Assistant."
date: 2018-04-02 13:40
sidebar: true
comments: false
sharing: true
footer: true
logo: homematicip_cloud.png
ha_category: Binary Sensor
ha_release: 0.70
ha_iot_class: "Cloud Push"
---
The `homematicip_cloud` binary_switch platform allows you to control
[HomematicIP](http://www.homematic-ip.com) binary sensors through Home Assistant.
Devices will be configured automatically. Please refer to the
[component](/components/homematicip_cloud/) configuration on how to setup
HomematicIP Cloud.

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

@ -1,21 +0,0 @@
---
layout: page
title: "Insteon Binary Sensor"
description: "Instructions on how to setup the Insteon binary sensors locally within Home Assistant."
date: 2018-08-20 16:00
sidebar: true
comments: false
sharing: true
footer: true
logo: insteon.png
ha_category: Binary Sensor
ha_iot_class: "Local Push"
ha_version: 0.77
---
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/

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

@ -1,20 +0,0 @@
---
layout: page
title: "Konnected Binary Sensor"
description: "Connect wired open/close sensors to Home Assistant with Konnected and a NodeMCU ESP8266"
date: 2018-04-03 12:30
sidebar: true
comments: false
sharing: true
footer: true
logo: konnected.png
ha_category: Binary Sensor
ha_release: "0.70"
ha_iot_class: "Local Push"
---
The `konnected` binary sensor allows you to monitor wired door sensors, window sensors, motion sensors, smoke detectors, CO detectors, glass-break sensors, water leak sensors or any other simple wired open/close circuit attached to a NodeMCU ESP8266 WiFi module running the [open source Konnected software](https://github.com/konnected-io/konnected-security).
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.

20
source/_components/binary_sensor.mercedesme.markdown
View File

@ -1,20 +0,0 @@
---
layout: page
title: "Mercedes me Binary Sensor"
description: "Instructions on how to integrate Mercedes me binary sensors into Home Assistant."
date: 2018-01-27 17:00
sidebar: true
comments: false
sharing: true
footer: true
logo: mercedesme.png
ha_category: Car
ha_iot_class: "Cloud polling"
ha_release: 0.63
---
The `mercedesme` platform allows you to get data from your [Mercedes me connected car](https://www.mercedes-benz.com/en/mercedes-me/) sensors like windows, doors, lock, tire warnings from within Home Assistant.
They will be automatically discovered if the Mercedes me component is loaded.
For more configuration information see the [Mercedes me component](/components/mercedesme/) documentation.

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

@ -25,9 +25,11 @@ binary_sensor:
- platform: modbus
coils:
- name: Sensor1
hub: hub1
slave: 1
coil: 100
- name: Sensor2
hub: hub1
slave: 1
coil: 110
```
@ -42,6 +44,11 @@ coils:
description: Name of the sensor.
required: true
type: string
hub:
description: The name of the hub.
required: false
default: default
type: string
slave:
description: The number of the slave (Optional for TCP and UDP Modbus).
required: true
@ -64,9 +71,11 @@ binary_sensor:
scan_interval: 10
coils:
- name: Sensor1
hub: hub1
slave: 1
coil: 100
- name: Sensor2
hub: hub1
slave: 1
coil: 110
```

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

@ -1,18 +0,0 @@
---
layout: page
title: "Ness Alarm Binary Sensor"
description: "Instructions on how to setup the Ness alarm zones within Home Assistant."
date: 2018-11-25 18:00
sidebar: true
comments: false
sharing: true
footer: true
logo: ness.png
ha_category: Binary Sensor
ha_release: 0.85
ha_iot_class: "Local Push"
---
The `ness_alarm` binary sensor allows you to monitor your [Ness](http://nesscorporation.com/) D8x and D16x alarm zones.
Zone binary sensors are automatically added by configuring the [Ness alarm](/components/ness_alarm/) component.

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

@ -1,18 +0,0 @@
---
layout: page
title: "QwikSwitch Binary Sensor"
description: "Instructions on how to integrate Qwikswitch dimmers and relays as sensors into Home Assistant."
date: 2016-05-04 00:00
sidebar: true
comments: false
sharing: true
footer: true
logo: qwikswitch.png
ha_category: Sensor
ha_iot_class: "Local Push"
ha_release: "0.68"
---
The `qwikswitch` binary_sensor platform allows you to use your [QwikSwitch](http://www.qwikswitch.co.za/) sensors within Home Assistant.
The platform is configured through the [QwikSwitch component](/components/qwikswitch/).

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

@ -13,7 +13,7 @@ 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).
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/).
@ -37,7 +37,7 @@ binary_sensor:
devices:
description: A list of binary sensors.
required: false
type: map
type: list
keys:
rflink_ids:
description: RFLink ID of the device
@ -45,15 +45,16 @@ devices:
type: map
keys:
name:
description: Name of the device, defaults to RFLink ID.
description: Name for the device.
required: false
default: RFLink ID
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.
description: The [type or class of the sensor](/components/binary_sensor/#device-class) to set the icon in the frontend.
required: false
type: string
off_delay:

20
source/_components/binary_sensor.satel_integra.markdown
View File

@ -1,20 +0,0 @@
---
layout: page
title: "Satel Integra Binary Sensor"
description: "Instructions on how to integrate Satel Integra binary sensors into Home Assistant."
date: 2017-09-07 13:28
sidebar: true
comments: false
sharing: true
footer: true
logo: satel.jpg
ha_category: Binary Sensor
ha_release: 0.54
ha_iot_class: "Local Push"
---
The `satel_integra` binary sensor allows you to monitor your [SatelIntegra](http://www.satel.pl/en/) alarm zones (inputs).
Check the [type/class](/components/binary_sensor/) list for a possible visualization of your zone.
The requirement is that you have setup your [SatelIntegra hub](/components/satel_integra/).

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

@ -1,41 +0,0 @@
---
layout: page
title: "Skybell Binary Sensor"
description: "Instructions on how to integrate your Skybell HD devices within Home Assistant."
date: 2017-10-03 16:00
sidebar: true
comments: false
sharing: true
footer: true
logo: skybell.png
ha_category: Doorbell
ha_release: 0.56
ha_iot_class: "Cloud Polling"
---
To get your [Skybell.com](https://skybell.com/) binary sensors working within Home Assistant, please follow the instructions for the general [Skybell component](/components/skybell).
## {% linkable_title Configuration %}
Once you have enabled the [Skybell component](/components/skybell), add the following to your `configuration.yaml` file:
```yaml
# Example configuration.yaml entry
binary_sensor:
- platform: skybell
monitored_conditions:
- button
- motion
```
{% configuration %}
monitored_conditions:
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.
motion:
description: Returns whether movement was detected by the Skybell doorbell.
{% endconfiguration %}

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

@ -1,20 +0,0 @@
---
layout: page
title: "Tesla Binary Sensor"
description: "Instructions on how to integrate Tesla binary sensors into Home Assistant."
date: 2017-08-30 12:29
sidebar: true
comments: false
sharing: true
footer: true
logo: tesla.png
ha_category: Car
ha_iot_class: "Cloud polling"
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.

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

@ -1,18 +0,0 @@
---
layout: page
title: "Velbus sensors"
description: "Access and control your Velbus sensors."
date: 2017-06-17 16.58
sidebar: true
comments: false
sharing: true
footer: true
logo: velbus.png
ha_category: Binary Sensor
ha_iot_class: "Local Push"
ha_release: "0.50"
---
The `velbus` binary_sensor allows you to control [Velbus](http://www.velbus.eu) connected input devices.
For hub configuration, see [the Velbus component](/components/velbus/).

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

@ -1,18 +0,0 @@
---
layout: page
title: "Vera Binary Sensor"
description: "Instructions on how to integrate Vera binary sensors into Home Assistant."
date: 2016-03-26 23:00
sidebar: true
comments: false
sharing: true
footer: true
logo: vera.png
ha_category: Binary Sensor
ha_iot_class: "Local Push"
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.

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

@ -1,19 +0,0 @@
---
layout: page
title: "Verisure Binary Sensor"
description: "Instructions on how to integrate Verisure binary sensors into Home Assistant."
date: 2016-02-23 21:31 +0100
sidebar: true
comments: false
sharing: true
footer: true
logo: verisure.png
ha_category: Binary Sensor
ha_iot_class: "Cloud Polling"
---
Integrates Verisure binary sensors into Home Assistant. See the [main component](/components/verisure/) for configuration instructions.
The following binary sensor types are supported:
- Door & Window

69
source/_components/binary_sensor.w800rf32.markdown
View File

@ -1,69 +0,0 @@
---
layout: page
title: "W800rf32 Binary Sensor"
description: "Instructions on how to integrate W800rf32 binary sensors into Home Assistant."
date: 2018-10-16 12:45
sidebar: true
comments: false
sharing: true
footer: true
logo: w800rf32.png
ha_category: Binary Sensor
ha_release: 0.83
ha_iot_class: "Local Push"
---
The `w800rf32` platform supports X10 RF binary sensors such as Palm Pad
remotes, key chain remotes, Hawkeye motion detectors, and many, many other X10 RF devices.
Some that have specifically been used with this are the KR19A keychain, MS16A motion detector
and the RSS18 four button wall mount keypad.
# Setting up your devices
Once you have set up your [w800rf32 hub](/components/w800rf32/), add the
binary sensors to your `configuration.yaml`:
```yaml
# Example configuration.yaml entry
binary_sensor:
- platform: w800rf32
devices:
a1:
name: motion_hall
a2:
name: motion_kitchen
```
{% configuration %}
devices:
description: A list of devices.
required: true
type: map
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
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
{% endconfiguration %}
Binary sensors have only two states - "on" and "off". Many door or window
opening sensors will send a signal each time the door/window is open or closed.
However, depending on their hardware or on their purpose,
some sensors are only able to signal their "on" state:
- Most motion sensors send a signal each time they detect motion. They stay "on" for a few seconds and go back to sleep, ready to signal other motion events. Usually, they do not send a signal when they go back to sleep.
For those devices, use the *off_delay* parameter.
It defines a delay after which a device will go back to an "Off" state.
That "Off" state will be fired internally by Home Assistant, just as if
the device fired it by itself. If a motion sensor can only send signals
once every 5 seconds, sets the *off_delay* parameter to *seconds: 5*.

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

@ -1,18 +0,0 @@
---
layout: page
title: "Belkin WeMo Binary Sensor"
description: "Instructions on how to integrate Belkin WeMo binary sensors into Home Assistant."
date: 2016-02-20 00:45
sidebar: true
comments: false
sharing: true
footer: true
logo: belkin_wemo.png
ha_category: Binary Sensor
ha_iot_class: "Local Push"
ha_release: 0.14
---
The `wemo` platform allows you to monitor your Belkin WeMo Binary Sensor from within Home Assistant.
WeMo devices are automatically discovered if the `discovery` component is enabled. For more configuration information, see the [WeMo component](/components/wemo/) documentation.

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

@ -1,36 +0,0 @@
---
layout: page
title: "Wink Binary Sensor"
description: "Instructions on how to setup the Wink binary sensors within Home Assistant."
date: 2015-01-20 22:36
sidebar: true
comments: false
sharing: true
footer: true
logo: wink.png
ha_category: Binary Sensor
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)
- Window/Door sensors
- Motion sensors
- Ring Door bells (No hub required)
- Liquid presence sensors
- Z-wave lock key codes
- Lutron connected bulb remote buttons
- Wink Relay buttons and presence detection
- Wink spotter loudness and vibration (No Wink hub required)
- Wink hub devices connection status. This includes any paired hubs like Hue, Wink v1, Wink v2, Wink Relay...
- Dropcam sensors
<p class='note'>
The above devices are confirmed to work, but others may work as well.
</p>

18
source/_components/blink.markdown
View File

@ -8,11 +8,23 @@ comments: false
sharing: true
footer: true
logo: blink.png
ha_category: Hub
ha_category:
- Hub
- Alarm
- Binary Sensor
- Camera
- Sensor
ha_release: "0.40"
ha_iot_class: "Cloud Polling"
redirect_form:
- /components/alarm_control_panel.blink/
- /components/binary_sensor.blink/
- /components/camera.blink/
- /components/sensor.blink/
---
<p class='note warning'>Blink has started blocking Home Assistant users. More info in <a href="https://community.home-assistant.io/t/blink-block-account/98718">the forums</a>.</p>
The `blink` component lets you view camera images and motion events from [Blink](http://blinkforhome.com) camera and security systems.
## {% linkable_title Setup %}
@ -40,7 +52,7 @@ password:
required: true
type: string
scan_interval:
description: How frequently to query for new data. Defaults to 60 seconds.
description: How frequently to query for new data. Defaults to 300 seconds (5 minutes).
required: false
type: integer
binary_sensors:
@ -83,7 +95,7 @@ Below is an example showing every possible entry:
blink:
username: YOUR_USERNAME
password: YOUR_PASSWORD
scan_interval: 60
scan_interval: 300
binary_sensors:
monitored_conditions:
- motion_enabled

22
source/_components/bmw_connected_drive.markdown
View File

@ -8,8 +8,18 @@ comments: false
sharing: true
footer: true
logo: bmw.png
ha_category: Car
ha_category:
- Car
- Binary Sensor
- Presence Detection
- Lock
- Sensor
ha_release: 0.64
redirect_from:
- /components/binary_sensor.bmw_connected_drive/
- /components/device_tracker.bmw_connected_drive/
- /components/lock.bmw_connected_drive/
- /components/sensor.bmw_connected_drive/
---
The `bmw_connected_drive` component lets you retrieve data of your BMW vehicle from the BMW Connected Drive portal. You need to have a working BMW Connected Drive account, and a Connected Drive enabled vehicle for this to work.
@ -18,11 +28,11 @@ For compatibility with your BMW vehicle check the [bimmer_connected page](https:
This component provides the following platforms:
- Binary Sensors: Doors, windows, condition based services, check control messages, parking lights, door lock state, charging status (electric cars) and connections status (electric cars).
- Device tracker: The location of your car.
- Lock: Control the lock of your car.
- Sensors: Mileage, remaining range, remaining fuel, charging time remaining (electric cars), charging status (electric cars), remaining range electric (electric cars).
- Services: Turn on air condition, sound the horn, flash the lights and update the state. More details can be found [here](/components/bmw_connected_drive/#services).
- Binary Sensors: Doors, windows, condition based services, check control messages, parking lights, door lock state, charging status (electric cars) and connections status (electric cars).
- Device tracker: The location of your car.
- Lock: Control the lock of your car.
- Sensors: Mileage, remaining range, remaining fuel, charging time remaining (electric cars), charging status (electric cars), remaining range electric (electric cars).
- Services: Turn on air condition, sound the horn, flash the lights and update the state. More details can be found [here](/components/bmw_connected_drive/#services).
## {% linkable_title Configuration %}

20
source/_components/camera.abode.markdown
View File

@ -1,20 +0,0 @@
---
layout: page
title: "Abode Camera"
description: "Instructions on how to integrate Abode cameras into Home Assistant."
date: 2017-08-26 13:28
sidebar: true
comments: false
sharing: true
footer: true
logo: abode.jpg
ha_release: 0.54
ha_category: Camera
ha_iot_class: "Cloud Push"
---
The `abode` security control panel platform allows you to control your [Abode](https://goabode.com/) alarms.
This component will automatically add `Cameras` configured in your Abode account. You can request a new still image capture by passing the `entity_id` of your cameras to the [capture_image service](/components/abode/#capture_image).
The requirement is that you have setup your [Abode hub](/components/abode/).

27
source/_components/camera.android_ip_webcam.markdown
View File

@ -1,27 +0,0 @@
---
layout: page
title: "Android IP Webcam Camera"
description: "Instructions on how to integrate Android IP Webcam cameras within Home Assistant."
date: 2015-07-11 0:36
sidebar: true
comments: false
sharing: true
footer: true
ha_category: Camera
logo: android_ip_webcam.png
ha_release: "0.40"
ha_iot_class: "Local Polling"
---
The `android_ip_webcam` component adds a camera by default if you choose not to use the component but still want to see the video feed then the [`mjpeg` camera](/components/camera.mjpeg/) platform can be used.
## {% linkable_title Configuration %}
To enable only the camera in your installation, add the following to your `configuration.yaml` file:
```yaml
# Example configuration.yaml entry
camera:
- platform: mjpeg
mjpeg_url: http://IP_ADDRESS:8080/video
```

38
source/_components/camera.arlo.markdown
View File

@ -1,38 +0,0 @@
---
layout: page
title: "Arlo Camera"
description: "Instructions on how to integrate your Netgear Arlo cameras within Home Assistant."
date: 2016-05-30 10:00
sidebar: true
comments: false
sharing: true
footer: true
logo: arlo.png
ha_category: Camera
ha_release: 0.46
ha_iot_class: "Cloud Polling"
---
To get your [Arlo](https://arlo.netgear.com/) cameras working within Home Assistant, please follow the instructions for the general [Arlo component](/components/arlo).
This component is not yet able to live stream from your Arlo camera, but it will be able to playback the last video capture.
## {% linkable_title Configuration %}
Once you have enabled the [Arlo component](/components/arlo), add the following to your `configuration.yaml` file:
```yaml
# Example configuration.yaml entry
camera:
- platform: arlo
ffmpeg_arguments: '-pred 1 -q:v 2'
```
{% configuration %}
ffmpeg_arguments:
description: Extra options to pass to ffmpeg, e.g., image quality or video filter options.
required: false
type: string
{% endconfiguration %}
**Note:** To be able to playback the last capture, it is required to install the `ffmpeg` component. Make sure to follow the steps mentioned at [FFMPEG](/components/ffmpeg/) documentation.

18
source/_components/camera.august.markdown
View File

@ -1,18 +0,0 @@
---
layout: page
title: "August Camera"
description: "Instructions on how to integrate your August devices into Home Assistant."
date: 2018-02-17 22:00
sidebar: true
comments: false
sharing: true
footer: true
logo: august.png
ha_category: Camera
ha_release: "0.64"
ha_iot_class: "Cloud Polling"
---
The `august` camera platform allows you to view the latest camera image (triggered by motion) by your [August](http://august.com) device in Home Assistant.
To add `august` camera to your installation, follow instructions in [August component](/components/august/).

18
source/_components/camera.axis.markdown
View File

@ -1,18 +0,0 @@
---
layout: page
title: "Axis Camera"
description: "Instructions on how to setup Axis cameras within Home Assistant."
date: 2017-05-01 19:09
sidebar: true
comments: false
sharing: true
footer: true
logo: axis.png
ha_category: Camera
ha_release: "0.45"
ha_iot_class: "Local Polling"
---
The `Axis` camera platform allows you to stream video from your [Axis](https://www.axis.com/) cameras.
The requirement is that you have setup your [Axis camera](/components/axis/).

18
source/_components/camera.blink.markdown
View File

@ -1,18 +0,0 @@
---
layout: page
title: "Blink Camera"
description: "Instructions for how to setup Blink cameras within Home Assistant."
date: 2017-03-05 22:13
sidebar: true
comments: false
sharing: true
footer: true
logo: blink.png
ha_category: Camera
ha_release: "0.40"
ha_iot_class: "Cloud Polling"
---
<p class='note'>
To get your Blink cameras working with Home Assistant, follow the instructions for the general [Blink component](/components/blink/).
</p>

34
source/_components/camera.canary.markdown
View File

@ -1,34 +0,0 @@
---
layout: page
title: "Canary Camera"
description: "Instructions on how to integrate your Canary devices into Home Assistant."
date: 2017-12-07 22:00
sidebar: true
comments: false
sharing: true
footer: true
logo: canary.png
ha_category: Camera
ha_release: "0.60"
ha_iot_class: "Cloud Polling"
---
The `canary` camera platform allows you to watch the live stream of your [Canary](https://canary.is) camera in Home Assistant. This requires the [`ffmpeg` component](/components/ffmpeg/) to be already configured.
To add `canary` camera to your installation, follow instructions in [Canary component](/components/canary/). Once you have [Canary component](/components/canary/) setup, your [Canary](https://canary.is) camera(s) should show up automatically.
## {% linkable_title Configuration %}
You can add the following to your `configuration.yaml` file to configure `canary` camera with optional settings:
```yaml
camera:
- platform: canary
```
{% configuration %}
ffmpeg_arguments:
description: Extra options to pass to `ffmpeg`, e.g., image quality or video filter options. More details in [FFmpeg component](/components/ffmpeg).
required: false
type: string
{% endconfiguration %}

23
source/_components/camera.generic.markdown
View File

@ -30,7 +30,7 @@ camera:
{% configuration %}
still_image_url:
description: "The URL your camera serves the image on, eg. http://192.168.1.21:2112/. Can be a [template](/topics/templating/)."
description: "The URL your camera serves the image on, e.g., http://192.168.1.21:2112/. Can be a [template](/topics/templating/)."
required: true
type: string
name:
@ -56,16 +56,16 @@ limit_refetch_to_url_change:
default: false
type: boolean
content_type:
description: Set the content type for the IP camera if it is not a jpg file. Use `image/svg+xml` to add a dynamic svg file.
description: Set the content type for the IP camera if it is not a jpg file. Use `image/svg+xml` to add a dynamic SVG file.
required: false
default: image/jpeg
type: string
framerate:
description: The number of frames-per-second (FPS) of the stream. Can cause heavy traffic on the network and/or heavy load on the camera.
description: The number of frames-per-second (FPS) of the stream. Can cause heavy traffic on the network and/or heavy load on the camera.
required: false
type: integer
verify_ssl:
description: Enable or disable SSL certificate verification.
description: Enable or disable SSL certificate verification. Set to false to use an http-only camera, or you have a self-signed SSL certificate and haven't installed the CA certificate to enable verification.
required: false
default: true
type: boolean
@ -80,7 +80,7 @@ verify_ssl:
## {% linkable_title Examples %}
In this section you find some real-life examples of how to use this camera platform.
In this section, you find some real-life examples of how to use this camera platform.
### {% linkable_title Weather graph from yr.no %}
@ -106,7 +106,7 @@ camera:
### {% linkable_title Sharing a camera feed from one Home Assistant instance to another %}
If you are running more than one Home Assistant instance (let's call them the 'host' and 'receiver' instances) you may wish to display the camera feed from the host instance on the receiver instance. You can use the [REST API](/developers/rest_api/#get-apicamera_proxycameraltentity_id) to access the camera feed on the host (IP address 127.0.0.5) and display it on the receiver instance by configuring the receiver with the the following:
If you are running more than one Home Assistant instance (let's call them the 'host' and 'receiver' instances) you may wish to display the camera feed from the host instance on the receiver instance. You can use the [REST API](/developers/rest_api/#get-apicamera_proxycameraltentity_id) to access the camera feed on the host (IP address 127.0.0.5) and display it on the receiver instance by configuring the receiver with the following:
```yaml
camera:
@ -114,3 +114,14 @@ camera:
name: Host instance camera feed
still_image_url: https://127.0.0.5:8123/api/camera_proxy/camera.live_view
```
### {% linkable_title Image from HTTP only camera %}
To access a camera which is only available via HTTP, you must turn off SSL verification.
```yaml
camera:
- platform: generic
name: Some Image
still_image_url: http://example.org/your_image.png
verify_ssl: false
```

2
source/_components/camera.mjpeg.markdown
View File

@ -30,7 +30,7 @@ camera:
{% configuration %}
mjpeg_url:
description: The URL your camera serves the video on, eg. http://192.168.1.21:2112/
description: The URL your camera serves the video on, e.g., http://192.168.1.21:2112/
required: true
type: string
still_image_url:

2
source/_components/camera.onvif.markdown
View File

@ -46,7 +46,7 @@ password:
type: string
default: 888888
port:
description: The port for the camera.
description: The (HTTP) port for the camera.
required: false
type: integer
default: 5000

68
source/_components/camera.skybell.markdown
View File

@ -1,68 +0,0 @@
---
layout: page
title: "Skybell Camera"
description: "Instructions on how to integrate your Skybell HD devices within Home Assistant."
date: 2017-10-03 16:00
sidebar: true
comments: false
sharing: true
footer: true
logo: skybell.png
ha_category: Camera
ha_release: 0.56
ha_iot_class: "Cloud Polling"
---
To get your [Skybell.com](https://www.skybell.com/) cameras working within Home Assistant, please follow the instructions for the general [Skybell component](/components/skybell).
## {% linkable_title Configuration %}
Once you have enabled the [Skybell component](/components/skybell), add the following to your `configuration.yaml` file:
```yaml
# Example configuration.yaml entry
camera:
- platform: skybell
```
{% configuration %}
monitored_conditions:
description: The camera images to display. Default is `avatar`. The full list is `avatar`, `activity`.
required: false
type: list
avatar_name:
description: Name to append to the device name for the avatar image. Default is empty string.
required: false
type: string
activity_name:
description: Name to append to the device name for the last activity image. Default is empty string.
required: false
type: string
{% endconfiguration %}
## {% linkable_title Camera Types %}
There are two available camera types "Avatar", which is the default, displays the Skybell avatar image.
It is periodically updated with a fresh image. The other type is "Activity", which displays a snapshot from
the latest event (motion, bell, or on demand) captured by the camera. You may show either camera, or both, by
specifying its name under monitored_condtions. It's recommended, but not required, to set either avatar_name or activity_name
if you are showing both cameras so you can tell them apart. The name will be appended to the skybell device name.
```yaml
# Example configuration.yaml with both images
camera:
- platform: skybell
monitored_conditions:
- avatar
- activity
activity_name: "Last Activity"
```
```yaml
# Example configuration.yaml with just last activity image
camera:
- platform: skybell
monitored_conditions:
- activity
```

4
source/_components/camera.synology.markdown
View File

@ -15,6 +15,10 @@ ha_iot_class: "Local Polling"
The `synology` camera platform allows you to watch the live streams of your [Synology](https://www.synology.com/) Surveillance Station based IP cameras in Home Assistant.
<p class='note'>
Synology has disabled the livestreaming API and the component is currently broken if you are using Surveillance Station version 8.2.3-5828.
</p>
## {% linkable_title Configuration %}
To enable your Surveillance Station cameras in your installation, add the following to your `configuration.yaml` file:

18
source/_components/camera.verisure.markdown
View File

@ -1,18 +0,0 @@
---
layout: page
title: "Verisure Camera"
description: "Instructions on how to setup the Verisure cameras within Home Assistant."
date: 2016-10-22 09:00
sidebar: true
comments: false
sharing: true
footer: true
logo: verisure.png
ha_category: Camera
ha_release: 0.31
ha_iot_class: "Local Polling"
---
The `verisure` camera platform allows you to control your [Verisure](https://www.verisure.com/) cameras.
The requirement is that you have setup your [Verisure hub](/components/verisure/).

59
source/_components/canary.markdown
View File

@ -8,13 +8,26 @@ comments: false
sharing: true
footer: true
logo: canary.png
ha_category: Hub
ha_category:
- Alarm
- Camera
- Sensor
ha_release: "0.60"
ha_iot_class: "Cloud Polling"
redirect_from:
- /components/alarm_control_panel.canary/
- /components/camera.canary/
- /components/sensor.canary/
---
The `canary` component allows you to integrate your [Canary](https://canary.is) devices in Home Assistant.
There is currently support for the following device types within Home Assistant:
- Alarm
- [Camera](#camera)
- [Sensor](#sensor)
## {% linkable_title Configuration %}
You will need your Canary login information (username, usually your email address, and password) to use this module.
@ -46,8 +59,42 @@ timeout:
Once loaded, your front end will have the following components:
* A camera image triggered by motion for each camera.
* An alarm control panel for each location.
* A sensor per camera that reports temperature.
* A sensor per camera that reports humidity.
* A sensor per camera that reports air quality.
- A camera image triggered by motion for each camera.
- An alarm control panel for each location.
- A sensor per camera that reports temperature.
- A sensor per camera that reports humidity.
- A sensor per camera that reports air quality.
## {% linkable_title Camera %}
The `canary` camera platform allows you to watch the live stream of your [Canary](https://canary.is) camera in Home Assistant. This requires the [`ffmpeg` component](/components/ffmpeg/) to be already configured.
Once you have [Canary component](/components/canary/) setup, your [Canary](https://canary.is) camera(s) should show up automatically.
## {% linkable_title Configuration %}
You can add the following to your `configuration.yaml` file to configure `canary` camera with optional settings:
```yaml
camera:
- platform: canary
```
{% configuration %}
ffmpeg_arguments:
description: Extra options to pass to `ffmpeg`, e.g., image quality or video filter options. More details in [FFmpeg component](/components/ffmpeg).
required: false
type: string
{% endconfiguration %}
## {% linkable_title Sensor %}
The `canary` sensor platform allows you to integrate the sensors of your [Canary](https://canary.is) devices in Home Assistant.
To add `canary` sensors to your installation, follow instructions above.
Once loaded, you will see following sensors:
- A sensor per camera that reports temperature.
- A sensor per camera that reports humidity.
- A sensor per camera that reports air quality.

56
source/_components/climate.coolmaster.markdown Normal file
View File

@ -0,0 +1,56 @@
---
layout: page
title: "CoolMasterNet Climate"
description: "Instructions on how to integrate CoolMasterNet within Home Assistant."
date: 2019-02-05 00:00
sidebar: true
comments: false
sharing: true
footer: true
logo: coolautomation.png
ha_category: Climate
ha_release: 0.88
ha_iot_class: "Local Polling"
---
The `coolmaster` climate platform lets you control HVAC through [CoolMasterNet](https://coolautomation.com/products/coolmasternet/). To set it up, add the following information to your `configuration.yaml` file:
```yaml
climate:
- platform: coolmaster
host: YOUR_COOLMASTER_HOST
port: YOUR_COOLMASTER_PORT
supported_modes:
- heat
- cool
- dry
```
{% configuration %}
host:
description: The host address of your CoolMasterNet instance (IP or host name).
required: true
type: string
port:
description: The port number of your CoolMasterNet instance.
required: false
type: integer
default: 10102
supported_modes:
description: The operation modes supported by your HVAC.
required: false
type: list
default: All modes
keys:
heat:
description: Heat mode.
cool:
description: Cool mode.
auto:
description: Auto mode.
dry:
description: Dry mode.
fan_only:
description: Fan only mode.
{% endconfiguration %}

27
source/_components/climate.dyson.markdown
View File

@ -1,27 +0,0 @@
---
layout: page
title: "Dyson Climate Control"
description: "Instructions on how to integrate your Dyson Climate device within Home Assistant."
date: 2018-05-23 22:30
sidebar: true
comments: false
sharing: true
footer: true
logo: dyson.png
ha_category: Climate
ha_iot_class: "Cloud Polling"
ha_release: 0.81
---
The `dyson` climate platform allows you to control your Dyson Pure Hot+Cool Fan thermal control. For controlling the fan functionality, see the [Dyson fan](/components/fan.dyson/) platform.
You have first to set up the [Dyson component](/components/dyson/).
### {% linkable_title Component services %}
This component supports the following services (see [Climate](/components/climate/)):
* [`turn_on`](/components/climate/#service-climateturn_on)
* [`turn_off`](/components/climate/#service-climateturn_off)
* [`set_temperature`](/components/climate/#service-climateset_temperature)
* [`set_fan_mode`](/components/climate/#service-climateset_fan_mode)
* [`set_operation_mode`](/components/climate/#service-climateset_operation_mode)

7
source/_components/climate.flexit.markdown
View File

@ -35,6 +35,11 @@ name:
description: Displayed name of the A/C unit.
required: false
type: string
hub:
description: The name of the hub where this slave is located.
required: false
default: default
type: string
{% endconfiguration %}
<p class='note'>
@ -61,4 +66,4 @@ climate:
- platform: flexit
name: Main A/C
slave: 21
```
```

21
source/_components/climate.homematicip_cloud.markdown
View File

@ -1,21 +0,0 @@
---
layout: page
title: "HomematicIP Cloud Climate"
description: "Instructions on how to integrate HomematicIP climate within Home Assistant."
date: 2018-05-18 22:40
sidebar: true
comments: false
sharing: true
footer: true
logo: homematicip_cloud.png
ha_category: Sensor
ha_release: 0.71
ha_iot_class: "Cloud Push"
---
The `homematicip_cloud` climate platform allows you to control
[HomematicIP](https://www.homematic-ip.com) climate through Home Assistant.
Devices will be configured automatically. Please refer to the
[component](/components/homematicip_cloud/) configuration on how to setup
HomematicIP Cloud.

6
source/_components/climate.modbus.markdown
View File

@ -25,6 +25,7 @@ To use your Modbus thermostat in your installation, add the following to your `c
climate:
- platform: modbus
name: Watlow F4T
hub: hub1
slave: 1
target_temp_register: 2782
current_temp_register: 27586
@ -35,6 +36,11 @@ name:
description: Name of the device
required: true
type: string
hub:
description: The name of the hub.
required: false
default: default
type: string
slave:
description: The number of the slave (Optional for tcp and upd Modbus, use 1).
required: true

28
source/_components/climate.spider.markdown
View File

@ -1,28 +0,0 @@
---
layout: page
title: "Spider Thermostat"
description: "Instructions on how to integrate Spider thermostats within Home Assistant."
date: 2018-07-17 22:01
sidebar: true
comments: false
sharing: true
footer: true
logo: spider.png
ha_category: Climate
ha_iot_class: "Cloud Polling"
ha_release: 0.75
---
The `spider` climate platform allows you to control your temperature settings as well as if you want to cool or heat.
<p class='note'>
Full configuration details can be found on the main [Spider component](/components/spider/) page.
</p>
<p class='note'>
Although this component lets you change the operation mode to heating or cooling, it doesn't necessarily mean your boiler can. Spider is not aware of your current situation.
</p>
<p class='note warning'>
This component is not affiliated with Itho Daalderop Spider and retrieves data from the endpoints of the mobile application. Use at your own risk.
</p>

20
source/_components/climate.tesla.markdown
View File

@ -1,20 +0,0 @@
---
layout: page
title: "Tesla HVAC"
description: "Instructions on how to integrate Tesla climate system (HVAC) into Home Assistant."
date: 2017-08-30 12:20
sidebar: true
comments: false
sharing: true
footer: true
logo: tesla.png
ha_category: Car
ha_iot_class: "Cloud push"
ha_release: 0.53
---
The `tesla` climate platform allows you to control your [Tesla](https://www.tesla.com/) climate from within Home Assistant.
The climate platform will be automatically configured if Tesla component is configured.
For more configuration information see the [Tesla component](/components/tesla/) documentation.

18
source/_components/climate.velbus.markdown
View File

@ -1,18 +0,0 @@
---
layout: page
title: "Velbus Climate"
description: "Instructions how to integrate Velbus thermostat into Home Assistant."
date: 2018-08-22 06:00
sidebar: true
comments: false
sharing: true
footer: true
logo: velbus.png
ha_category: Climate
ha_iot_class: "Local Push"
ha_release: 0.83
---
The `velbus` climate devices allow you to control [Velbus](http://www.velbus.eu) connected thermostats.
For hub configuration, see [the Velbus component](/components/velbus/).

20
source/_components/climate.vera.markdown
View File

@ -1,20 +0,0 @@
---
layout: page
title: "Vera Thermostat"
description: "Instructions on how to integrate Vera thermostats into Home Assistant."
date: 2016-09-19 21:00
sidebar: true
comments: false
sharing: true
footer: true
logo: vera.png
ha_category: Climate
ha_iot_class: "Local Push"
ha_release: 0.13
---
The `vera` climate platform allows you to control your [Vera](http://getvera.com/) thermostats from within Home Assistant.
They will be automatically discovered if the vera component is loaded.
For more configuration information see the [Vera component](/components/vera/) documentation.

35
source/_components/climate.wink.markdown
View File

@ -1,35 +0,0 @@
---
layout: page
title: "Wink Climate"
description: "Instructions on how to setup the Wink climate devices within Home Assistant."
date: 2016-11-01 22:36
sidebar: true
comments: false
sharing: true
footer: true
logo: wink.png
ha_category: Climate
ha_release: 0.32
ha_iot_class: "Cloud Polling"
---
The Wink climate platform allows you to get data from your [Wink](http://www.wink.com/) thermostats and air conditioners.
The requirement is that you have setup [Wink](/components/wink/).
### {% linkable_title Supported climate devices %}
- Nest (No Wink hub required)
- Ecobee (No Wink hub required)
- Sensi (No Wink hub required)
- Carrier (Unconfirmed)
- Honeywell (No Wink hub required)
- Generic Z-Wave
- Quirky Aros window AC unit
<p class='note'>
The above devices are confirmed to work, but others may work as well.
</p>

20
source/_components/cover.abode.markdown
View File

@ -1,20 +0,0 @@
---
layout: page
title: "Abode Cover"
description: "Instructions on how to integrate Abode covers into Home Assistant."
date: 2017-08-26 13:28
sidebar: true
comments: false
sharing: true
footer: true
logo: abode.jpg
ha_release: 0.52
ha_category: Cover
ha_iot_class: "Cloud Push"
---
The `abode` security control panel platform allows you to control your [Abode](https://goabode.com/) alarms.
This component will automatically add `Secure Barriers` configured in your Abode account.
The requirement is that you have setup your [Abode hub](/components/abode/).

27
source/_components/cover.deconz.markdown
View File

@ -1,27 +0,0 @@
---
layout: page
title: "deCONZ Covers"
description: "Instructions on how to integrate Zigbee covers from deCONZ into Home Assistant."
date: 2018-09-20 23:32
sidebar: true
comments: false
sharing: true
footer: true
logo: deconz.jpeg
ha_category: Cover
ha_release: "0.79"
ha_iot_class: "Local Push"
---
See the [deCONZ main component](/components/deconz/) for configuration instructions.
Covers are devices like ventilation dampers or smart window covers.
Note that devices in the cover platform identify as lights, so there is a manually curated list that defines which "lights" are covers.
The `entity_id` name will be `cover.device_name`, where `device_name` is defined in deCONZ.
#### {% linkable_title Verified supported covers %}
- Keen vents
- Xiaomi Aqara Curtain controller

21
source/_components/cover.homematicip_cloud.markdown
View File

@ -1,21 +0,0 @@
---
layout: page
title: "HomematicIP Cloud Cover"
description: "Instructions on how to integrate HomematicIP covers within Home Assistant."
date: 2019-01-13 13:40
sidebar: true
comments: false
sharing: true
footer: true
logo: homematicip_cloud.png
ha_category: Cover
ha_release: 0.87
ha_iot_class: "Cloud Push"
---
The `homematicip_cloud` cover platform allows you to control
[HomematicIP](http://www.homematic-ip.com) covers through Home Assistant.
Devices will be configured automatically. Please refer to the
[component](/components/homematicip_cloud/) configuration on how to setup
HomematicIP Cloud.

22
source/_components/cover.insteon.markdown
View File

@ -1,22 +0,0 @@
---
layout: page
title: "Insteon Cover"
description: "Instructions on how to setup the Insteon cover locally within Home Assistant."
date: 2018-08-20 16:00
sidebar: true
comments: false
sharing: true
footer: true
logo: insteon.png
ha_category: Cover
ha_iot_class: "Local Push"
ha_version: 0.78
---
The `insteon` cover platform lets you control your [Open/Close Micro Module]
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/
[Open/Close Micro Module]: https://www.insteon.com/open-close-micro-module/

129
source/_components/cover.rflink.markdown
View File

@ -13,11 +13,11 @@ ha_release: 0.55
---
The `rflink` cover platform 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).
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/).
First, you have to set up your [RFLink hub](/components/rflink/).
After configuring the RFLink hub covers will be automatically discovered and added. Except the Somfy RTS devices.
After configuring the RFLink hub, covers will be automatically discovered and added. Except the Somfy RTS devices.
### {% linkable_title Setting up a Somfy RTS device %}
@ -29,7 +29,7 @@ Press the Learn button on the original Somfy remote enter the following code wit
10;RTS;02FFFF;0412;3;PAIR;
```
Your blinds will go up and down again. This means your Rflink is now paired with your RTS motor.
Your blinds will go up and down again. This means your RFLink is now paired with your RTS motor.
To check this enter the following code again and see if there is a record.
```text
@ -61,72 +61,105 @@ RFLink cover ID's are composed of: protocol, id, and gateway. For example: `RTS_
Once the ID of a cover is known, it can be used to configure the cover in Home Assistant, for example, to add it to a different group, hide it or set a nice name.
Assigning a name to a cover:
Configuring devices as a cover:
```yaml
# Example configuration.yaml entry
cover:
- platform: rflink
devices:
RTS_0100F2_0:
name: SunShade
bofumotor_455201_0f:
name: Sovrumsgardin
RTS_0100F2_0: {}
bofumotor_455201_0f: {}
```
{% configuration %}
devices:
description: A list of devices with their name to use in the frontend.
required: false
type: list
keys:
name:
description: The name for the device. Defaults to value for Rflink ID.
required: false
type: string
aliases:
description: The alternative Rflink ID's this device is known by.
required: false
type: list
fire_event:
description: Fire a `button_pressed` event if this device is turned on or off.
required: false
default: false
type: boolean
signal_repetitions:
description: The number of times every Rflink command should repeat.
required: false
type: integer
group:
description: Allow light to respond to group commands (ALLON/ALLOFF).
required: false
default: true
type: boolean
group_aliases:
description: The `aliases` which only respond to group commands.
required: false
type: list
no_group_aliases:
description: The `aliases` which do not respond to group commands.
required: false
type: list
device_defaults:
description: The default values for a device.
description: The defaults for the devices.
required: false
type: list
type: map
keys:
fire_event:
description: The default `fire_event` for Rflink cover devices.
description: Set default `fire_event` for RFLink cover devices.
required: false
default: false
type: boolean
signal_repetitions:
description: The default `signal_repetitions` for Rflink cover devices.
description: Set default `signal_repetitions` for RFLink cover devices.
required: false
default: 1
type: integer
devices:
description: A list of covers.
required: false
type: list
keys:
rflink_ids:
description: RFLink ID of the device
required: true
type: map
keys:
name:
description: Name for the device.
required: false
default: RFLink ID
type: string
aliases:
description: Alternative RFLink ID's this device is known by.
required: false
type: [list, string]
fire_event:
description: Fire a `button_pressed` event if this device is turned on or off.
required: false
default: False
type: boolean
signal_repetitions:
description: The number of times every RFLink command should repeat.
required: false
type: integer
group:
description: Allow light to respond to group commands (ALLON/ALLOFF).
required: false
default: true
type: boolean
group_aliases:
description: The `aliases` which only respond to group commands.
required: false
type: [list, string]
no_group_aliases:
description: The `aliases` which do not respond to group commands.
required: false
type: [list, string]
{% endconfiguration %}
### {% linkable_title Device support %}
See [device support](/components/rflink/#device-support).
### {% linkable_title Additional configuration examples %}
Multiple covers with custom names and aliases
```yaml
# Example configuration.yaml entry
cover:
- platform: rflink
devices:
RTS_0A8720_0:
name: enanos
aliases:
- rts_31e53f_01
- rts_32e53f_01
RTS_30E542_0:
name: comedor
aliases:
- rts_33e53f_01
- rts_fa872e_01
RTS_33E542_0:
name: dormitorio
aliases:
- rts_30e53f_01
- rts_32e53f_01
RTS_32E542_0:
name: habitaciones
fire_event: true
```

4
source/_components/cover.rfxtrx.markdown
View File

@ -42,7 +42,7 @@ cover:
##### {% linkable_title RFY %}
The [RFXtrx433e](http://www.rfxcom.com/RFXtrx433E-USB-43392MHz-Transceiver/en) is required for RFY support, however it does not support receive for the RFY protocol - as such devices cannot be automatically added. Instead, configure the device in the [rfxmngr](http://www.rfxcom.com/downloads.htm) tool. Make a note of the assigned ID and Unit Code and then add a device to the configuration with the following id `071a0000[id][unit_code]`. Eg, if the id was `0a` `00` `01`, and the unit code was `01` then the fully qualified id would be `071a00000a000101`, if you set your id/code to single digit in the rfxmngr eg, id: `1` `02` `04` and unit code: `1` you will need to add `0` before, so `102031` becomes `071a000001020301`.
The [RFXtrx433e](http://www.rfxcom.com/RFXtrx433E-USB-43392MHz-Transceiver/en) is required for RFY support, however it does not support receive for the RFY protocol - as such devices cannot be automatically added. Instead, configure the device in the [rfxmngr](http://www.rfxcom.com/downloads.htm) tool. Make a note of the assigned ID and Unit Code and then add a device to the configuration with the following id `071a0000[id][unit_code]`. E.g., if the id was `0a` `00` `01`, and the unit code was `01` then the fully qualified id would be `071a00000a000101`, if you set your id/code to single digit in the rfxmngr, e.g., id: `1` `02` `04` and unit code: `1` you will need to add `0` before, so `102031` becomes `071a000001020301`.
##### {% linkable_title Common %}
@ -88,6 +88,6 @@ signal_repetitions:
{% endconfiguration %}
<p class='note warning'>
If a device ID consists of only numbers, please make sure to surround it with quotes.
If a device ID consists of only numbers, please make sure to surround it with quotes.
This is a known limitation in YAML, because the device ID will be interpreted as a number otherwise.
</p>

52
source/_components/cover.scsgate.markdown
View File

@ -1,52 +0,0 @@
---
layout: page
title: "SCSGate Cover"
description: "Instructions on how to integrate SCSGate motorized devices into Home Assistant."
date: 2016-06-28 17:30
sidebar: true
comments: false
sharing: true
footer: true
logo: bus_scs.png
ha_category: Cover
ha_iot_class: "Local Polling"
---
The SCSGate devices can control motorized covers connected to the BTicino MyHome system.
To enable SCSGate covers in your installation, add the following to your `configuration.yaml` file:
```yaml
# Example configuration.yaml entry
cover:
- platform: scsgate
devices:
living_room:
name: Living Room
scs_id: XXXXX
```
{% configuration %}
devices:
description: A list of devices.
required: true
type: list
keys:
slug:
description: Slug of the device.
required: true
type: list
keys:
name:
description: Name to use in the frontend.
required: true
type: string
scs_id:
description: The ID of your SCSGate device.
required: true
type: string
{% endconfiguration %}
<p class='note'>
**Known limitation:** It is not possible to know the current state of the cover.
</p>

20
source/_components/cover.vera.markdown
View File

@ -1,20 +0,0 @@
---
layout: page
title: "Vera Cover"
description: "Instructions on how to integrate Vera covers into Home Assistant."
date: 2016-09-19 21:00
sidebar: true
comments: false
sharing: true
footer: true
logo: vera.png
ha_category: Cover
ha_iot_class: "Local Push"
ha_release: 0.13
---
The `vera` cover platform allows you to control your [Vera](http://getvera.com/) covers from within Home Assistant.
They will be automatically discovered if the Vera component is loaded.
For more configuration information see the [Vera component](/components/vera/) documentation.

32
source/_components/cover.wink.markdown
View File

@ -1,32 +0,0 @@
---
layout: page
title: "Wink Cover"
description: "Instructions on how to setup the Wink garage doors within Home Assistant."
date: 2016-06-28 17:30
sidebar: true
comments: false
sharing: true
footer: true
logo: wink.png
ha_category: Cover
ha_release: 0.13
ha_iot_class: "Cloud Polling"
---
Wink Cover garage door functionality varies on the product. Home Assistant can open, close, and view state of GoControl/Linear openers. For Chamberlain MyQ-enabled openers, Home Assistant is limited to show current state (open or closed) only using this Wink cover. This restriction was imposed by Chamberlain for third party control. Wink suggests that MyQ customers should contact Chamberlain directly to inquire about expanding permissions.
The [MyQ Cover](/components/cover.myq/) does provide full functionality for opening and closing Chamberlain MyQ-enabled garage doors. If installed along with the Wink Component, a duplicate garage door entity may exist. In that case, the semi-functional Wink garage door entity can be hidden via customize.yaml.
The requirement is that you have setup [Wink](/components/wink/).
### {% linkable_title Supported cover devices %}
- Bali window treatments
- Lutron shades
- Pella motorized blinds and shades
- GoControl garage door opener
- Chamberlain MyQ (Limited functionality) (No Wink hub required)
<p class='note'>
The above devices are confirmed to work, but others may work as well.
</p>

170
source/_components/deconz.markdown
View File

@ -8,17 +8,40 @@ comments: false
sharing: true
footer: true
logo: deconz.jpeg
ha_category: Hub
ha_category:
- Hub
- Binary Sensor
- Cover
- Light
- Scene
- Sensor
- Switch
ha_release: "0.61"
ha_iot_class: "Local Push"
ha_qa_scale: platinum
redirect_from:
- /components/binary_sensor.deconz/
- /components/cover.deconz/
- /components/light.deconz/
- /components/scene.deconz/
- /components/sensor.deconz/
- /components/switch.deconz/
---
[deCONZ](https://www.dresden-elektronik.de/funktechnik/products/software/pc/deconz/) by [Dresden Elektronik](https://www.dresden-elektronik.de) is a software that communicates with Conbee/Raspbee Zigbee gateways and exposes Zigbee devices that are connected to the gateway.
[deCONZ REST API](http://dresden-elektronik.github.io/deconz-rest-doc/).
### {% linkable_title Recommended way of running deCONZ %}
There is currently support for the following device types within Home Assistant:
- [Binary Sensor](/components/deconz/#binary-sensor)
- [Cover](/components/deconz/#cover)
- [Light](/components/deconz/#light)
- [Scene](/components/deconz/#scene)
- [Sensor](/components/deconz/#sensor)
- [Switch](/components/deconz/#switch)
## {% linkable_title Recommended way of running deCONZ %}
Use [community container](https://hub.docker.com/r/marthoc/deconz/) by Marthoc for your deCONZ needs. It works both as a standalone container as well as with HASS.io.
@ -50,7 +73,7 @@ logger:
Available services: `configure` and `deconz.refresh_devices`.
#### {% linkable_title Service `deconz.configure` %}
### {% linkable_title Service `deconz.configure` %}
Set attribute of device in deCONZ using [Rest API](http://dresden-elektronik.github.io/deconz-rest-doc/rest/).
@ -97,9 +120,10 @@ For the IKEA Tradfri remote the first digit equals, 1 for the middle button, 2 f
### {% linkable_title YAML %}
#### {% linkable_title Step up and step down input number with wireless dimmer %}
#### {% linkable_title Step up and step down input number with wireless dimmer %}
{% raw %}
```yaml
automation:
- alias: 'Toggle lamp from dimmer'
@ -146,15 +170,18 @@ automation:
{% set bri = states.light.lamp.attributes.brightness | int %}
{{ [bri-30, 0] | max }}
```
{% endraw %}
### {% linkable_title Appdaemon %}
#### {% linkable_title Appdaemon event helper %}
Helper app that creates a sensor `sensor.deconz_event` with a state that represents the id from the last event and an attribute to show the event data.
Put this in `apps.yaml`:
{% raw %}
```yaml
deconz_helper:
module: deconz_helper
@ -162,6 +189,7 @@ deconz_helper:
```
Put this in `deconz_helper.py`:
```python
import appdaemon.plugins.hass.hassapi as hass
import datetime
@ -179,6 +207,7 @@ class DeconzHelper(hass.Hass):
self.log("Deconz event received from {}. Event was: {}".format(event_id, event_data))
self.set_state("sensor.deconz_event", state = event_id, attributes = {"event_data": event_data, "event_received": str(event_received)})
```
{% endraw %}
Note: the event will not be visible before one event gets sent.
@ -186,6 +215,7 @@ Note: the event will not be visible before one event gets sent.
#### {% linkable_title Appdaemon remote template %}
{% raw %}
```yaml
remote_control:
module: remote_control
@ -215,6 +245,7 @@ class RemoteControl(hass.Hass):
elif data['event'] == 4002:
self.log('Button off')
```
{% endraw %}
#### {% linkable_title Appdaemon remote template %}
@ -222,6 +253,7 @@ class RemoteControl(hass.Hass):
Community app from [Teachingbirds](https://community.home-assistant.io/u/teachingbirds/summary). This app uses an Ikea Tradfri remote to control Sonos speakers with play/pause, volume up and down, next and previous track.
{% raw %}
```yaml
sonos_remote_control:
module: sonos_remote
@ -230,9 +262,11 @@ sonos_remote_control:
id: sonos_remote
sonos: media_player.sonos
```
{% endraw %}
{% raw %}
```python
import appdaemon.plugins.hass.hassapi as hass
@ -259,10 +293,136 @@ class SonosRemote(hass.Hass):
elif data['event'] == 4002:
self.log('Button previous')
self.call_service("media_player/media_previous_track", entity_id = self.sonos)
self.call_service("media_player/media_previous_track", entity_id = self.sonos)
elif data['event'] == 5002:
self.log('Button next')
self.call_service("media_player/media_next_track", entity_id = self.sonos)
```
{% endraw %}
## {% linkable_title Binary Sensor %}
The following sensor types are supported:
- Fire/Smoke detection
- Open/Close detection
- Presence detection
- Water leakage detection
The `entity_id` name will be `binary_sensor.device_name`, where `device_name` is defined in deCONZ.
### {% linkable_title Verified supported binary sensors %}
- Open/Close Detection
- Xiaomi Smart Home Security Door & Window Contact Sensor
- Presence Detection
- IKEA Trådfri Motion Sensor
- Philips Hue Motion Sensor
- Xiaomi Motion Sensor
- Xiaomi Smart Home Aqara Human Body Sensor
## {% linkable_title Cover %}
Covers are devices like ventilation dampers or smart window covers.
Note that devices in the cover platform identify as lights, so there is a manually curated list that defines which "lights" are covers.
The `entity_id` name will be `cover.device_name`, where `device_name` is defined in deCONZ.
### {% linkable_title Verified supported covers %}
- Keen vents
- Xiaomi Aqara Curtain controller
## {% linkable_title Light %}
The `entity_id` names will be `light.device_name`, where `device_name` is defined in deCONZ. Light groups created in deCONZ will be created in Home Assistant as lights named `light.group_name_in_deconz`, allowing the user to control groups of lights with only a single API call to deCONZ.
### {% linkable_title Verified supported lights %}
- IKEA Trådfri bulb E14 WS opal 400lm
- IKEA Trådfri Bulb E27 WS Opal 980lm
- IKEA Trådfri Bulb E27 WS Opal 1000lm
- IKEA Trådfri Bulb GU10 W 400lm
- OSRAM Flex RGBW
- OSRAM Gardenpole RGBW
- Philips Hue White A19
- Philips Hue White Ambiance A19
- Philips Hue Hue White ambiance Milliskin (recessed spotlight) LTW013
- Busch Jaeger ZigBee Light Link univ. relai (6711 U) with ZigBee Light Link control element 6735-84
## {% linkable_title Scene %}
The `entity_id` name will be `scene.group_scene_name`, where `group` is which group the scene belongs to and the name of the scene, both group and name are defined in deCONZ.
## {% linkable_title Sensor %}
The following sensor types are supported:
- Humidity sensor
- Light level sensor
- Pressure sensor
- Switches
- Temperature sensor
The `entity_id` name will be `sensor.device_name`, where `device_name` is defined in deCONZ. Switches aren't exposed as ordinary entities, see the [deCONZ main component](/components/deconz/) for more details.
### {% linkable_title Verified to be supported sensors %}
- Humidity Sensor
- Xiaomi Aqara Humidity/Temperature Sensor
- Xiaomi MiJia Smart Temperature & Humidity Sensor
- Light Level Sensor
- Pressure Sensor
- Switches
- IKEA Trådfri Wireless Dimmer
- Philips Hue Motion Sensor
- IKEA Trådfri Remote
- Philips Hue Dimmer Switch
- Xiaomi Cube
- Xiaomi Aqara Smart Light Switch
- Xiaomi Aqara Smart Wireless Switch
- Xiaomi Smart Home Wireless Switch
- Temperature Sensor
- Xiaomi Temperature/Humidity Sensor
### {% linkable_title deCONZ Daylight Sensor %}
The deCONZ Daylight sensor is a special sensor built into the deCONZ software since version 2.05.12. It is represented in Home Assistant as a sensor called sensor.daylight. The sensor's state value is a string corresponding to the phase of daylight (descriptions below taken from https://github.com/mourner/suncalc, on which the deCONZ implementation is based):
| Sensor State | Description |
|--------------|-------------|
| sunrise_start | sunrise (top edge of the sun appears on the horizon) |
| sunrise_end | sunrise ends (bottom edge of the sun touches the horizon) |
| golden_hour_1 | morning golden hour (soft light, the best time for photography) |
| solar_noon | solar noon (sun is in the highest position) |
| golden_hour_2 | evening golden hour |
| sunset_start | sunset starts (bottom edge of the sun touches the horizon) |
| sunset_end | sunset (sun disappears below the horizon, evening civil twilight starts) |
| dusk | dusk (evening nautical twilight starts) |
| nautical_dusk | nautical dusk (evening astronomical twilight starts) |
| night_start | night starts (dark enough for astronomical observations) |
| nadir | nadir (darkest moment of the night, the sun is in the lowest position) |
| night_end | night ends (morning astronomical twilight starts) |
| nautical_dawn | nautical dawn (morning nautical twilight starts) |
| dawn | dawn (morning nautical twilight ends, morning civil twilight starts) |
The sensor also has an attribute called "daylight" that has the value `true` when the sensor's state is `golden_hour_1`, `solar_noon`, or `golden_hour_2`, and `false` otherwise.
These states can be used in automations as a trigger (e.g., trigger when a certain phase of daylight starts or ends) or condition (e.g., trigger only if in a certain phase of daylight).
## {% linkable_title Switch %}
Switches are devices like power plugs and sirens.
Note that devices in the switch platform identify as lights, so there is a manually curated list that defines which "lights" are switches.
The `entity_id` name will be `switch.device_name`, where `device_name` is defined in deCONZ.
### {% linkable_title Verified supported switches %}
- Innr SP120
- Osram Outdoor plug
- Heiman siren

3
source/_components/device_tracker.actiontec.markdown
View File

@ -35,7 +35,7 @@ device_tracker:
{% configuration %}
host:
description: The IP address of your router, eg. `192.168.1.1`.
description: The IP address of your router, e.g., `192.168.1.1`.
required: true
type: string
username:
@ -49,4 +49,3 @@ password:
{% endconfiguration %}
See the [device tracker component page](/components/device_tracker/) for instructions how to configure the people to be tracked.

20
source/_components/device_tracker.bmw_connected_drive.markdown
View File

@ -1,20 +0,0 @@
---
layout: page
title: "BMW Connected Drive Device Tracker"
description: "Instructions on how to setup your BMW Connected Drive account with Home Assistant."
date: 2018-01-10 23:00
sidebar: true
comments: false
sharing: true
footer: true
logo: bmw.png
ha_category: Car
ha_release: 0.64
---
The `bmw_connected_drive` device tracker platform allows you to import data on your BMW into Home Assistant.
The device tracker platform will be automatically configured if the `bmw_connected_drive` component is configured.
For more configuration information see the [`bmw_connected_drive` component](/components/bmw_connected_drive/) documentation.

48
source/_components/device_tracker.googlehome.markdown
View File

@ -1,48 +0,0 @@
---
layout: page
title: "Google Home Bluetooth tracker"
description: "Instructions on how to use Google Home to track devices in Home Assistant."
date: 2018-11-04 00:00
sidebar: true
comments: false
sharing: true
footer: true
logo: google_home.png
ha_release: 0.83
ha_category: Presence Detection
ha_iot_class: "Local Polling"
---
The `googlehome` platform allows you to detect presence using an [unofficial Google Home API][googlehomeapi].
## {% linkable_title Configuration %}
To integrate Google Home Bluetooth tracker in Home Assistant, add the following section to your `configuration.yaml` file:
```yaml
# Example configuration.yaml entry
device_tracker:
- platform: googlehome
host: IP_ADDRESS
```
{% configuration %}
host:
description: The IP address of the Google Home unit.
required: true
type: string
rssi_threshold:
description: The threshold for the RSSI signal of the device.
required: false
default: -70
type: integer
{% endconfiguration %}
## {% linkable_title Usage %}
Devices will appear in the format `devicetracker.<home hub ip>_<device mac address>`. Note that dots are removed from the IP and BT MAC addresses.
After running this component for a little while, you will likely see many devices appear. It's advisable to set the configuration to not discover new devices once the device you want to track have appeared (see [device tracker configuration][devicetrackerconfig] for details).
[googlehomeapi]: https://rithvikvibhu.github.io/GHLocalApi/
[devicetrackerconfig]: /components/device_tracker/#configuring-a-device_tracker-platform

2
source/_components/device_tracker.markdown
View File

@ -86,7 +86,7 @@ devicename:
|----------------|-------------------------------|---------------------------------------------------------------------------------------------------------|
| `name` | Host name or "Unnamed Device" | The friendly name of the device. |
| `mac` | None | The MAC address of the device. Add this if you are using a network device tracker like Nmap or SNMP. |
| `picture` | None | A picture that you can use to easily identify the person or device. You can also save the image file in a folder "www" in the same location (can be obtained from developer tools) where you have your configuration.yaml file and just use `picture: /local/favicon-192x192.png`. |
| `picture` | None | A picture that you can use to easily identify the person or device. You can also save the image file in a folder "www" in the same location (can be obtained from developer tools) where you have your configuration.yaml file and just use `picture: /local/favicon-192x192.png`. The path 'local' is mapped to the 'www' folder you create. |
| `icon` | mdi:account | An icon for this device (use as an alternative to `picture`). |
| `gravatar` | None | An email address for the device's owner. If provided, it will override `picture`. |
| `track` | [uses platform setting] | If `yes`/`on`/`true` then the device will be tracked. Otherwise its location and state will not update. |

19
source/_components/device_tracker.mercedesme.markdown
View File

@ -1,19 +0,0 @@
---
layout: page
title: "Mercedes me Device Tracker"
description: "Instructions on for how to integrate Mercedes me into Home Assistant."
date: 2018-01-27 10:00
sidebar: true
comments: false
sharing: true
footer: true
logo: mercedesme.png
ha_category: Car
ha_release: 0.63
---
The `mercedesme` platform allows you to get data about the location of your [Mercedes me connected car](https://www.mercedes-benz.com/en/mercedes-me/) car within Home Assistant.
The device tracker platform will be automatically configured if Mercedes me component is configured.
For more configuration information see the [Mercedes me component](/components/mercedesme/) documentation.

19
source/_components/device_tracker.tesla.markdown
View File

@ -1,19 +0,0 @@
---
layout: page
title: "Tesla Device Tracker"
description: "Instructions on for how to integrate Tesla into Home Assistant."
date: 2017-08-02 12:20
sidebar: true
comments: false
sharing: true
footer: true
logo: tesla.png
ha_category: Car
ha_release: 0.53
---
The `tesla` platform allows you to get data about the location of your [Tesla](https://www.tesla.com/) car within Home Assistant.
The device tracker platform will be automatically configured if Tesla component is configured.
For more configuration information see the [Tesla component](/components/tesla/) documentation.

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