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-04-26 14:27:34 +00:00
Code Issues Packages Projects Releases Wiki Activity

Merge branch 'current' into next

Browse Source
This commit is contained in:
Fabian Affolter 2019-02-13 18:04:19 +01:00
commit ea4598343c
No known key found for this signature in database
GPG Key ID: E23CD2DD36A4397F
210 changed files with 5538 additions and 6278 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 %}

9
_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
@ -144,8 +139,8 @@ social:
# Home Assistant release details
current_major_version: 0
current_minor_version: 87
current_patch_version: 0
date_released: 2019-02-06
current_patch_version: 1
date_released: 2019-02-10
# Either # or the anchor link to latest release notes in the blog post.
# Must be prefixed with a # and have double quotes around it.

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).

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/).

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/).

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 %}

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

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.

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.

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/).

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.

2
source/_components/blink.markdown
View File

@ -23,6 +23,8 @@ redirect_form:
- /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 %}

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/).

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/).

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:

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
```

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)

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 and fan 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.

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

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/

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.

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.

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.

3
source/_components/dialogflow.markdown
View File

@ -49,7 +49,7 @@ To get the webhook URL, go to the integrations page in the configuration screen
- Click "Save"
- Create a new intent
- Below "User says" write one phrase that you, the user, will tell Dialogflow, e.g., `What is the temperature at home?`
- In "Action" set some key (this will be the bind with Home Assistant configuration), eg.: GetTemperature
- In "Action" set some key (this will be the bind with Home Assistant configuration), e.g.,: GetTemperature
- In "Response" set "Cannot connect to Home Assistant or it is taking to long" (fall back response)
- At the end of the page, click on "Fulfillment" and check "Use webhook"
- Click "Save"
@ -114,4 +114,3 @@ intent_script:
entity_id: "switch.light_{{ Room | replace(' ', '_') }}"
```
{% endraw %}

61
source/_components/digital_ocean.markdown
View File

@ -7,15 +7,25 @@ sidebar: true
comments: false
sharing: true
footer: true
ha_category: System Monitor
ha_category:
- System Monitor
- Binary Sensor
- Switch
ha_release: "0.30"
logo: digital_ocean.png
ha_iot_class: "Local Polling"
redirect_from:
- /components/binary_sensor.digital_ocean/
- /components/switch.digital_ocean/
---
The `digital_ocean` component allows you to access the information about your [Digital Ocean](https://www.digitalocean.com/) droplets from Home Assistant.
There is currently support for the following device types within Home Assistant:
- [Binary Sensor](/components/digital_ocean/#binary-sensor)
- [Switch](/components/digital_ocean/#switch)
## {% linkable_title Setup %}
Obtain your API key from your [Digital Ocean dashboard](https://cloud.digitalocean.com/settings/api/tokens).
@ -37,3 +47,50 @@ access_token:
type: string
{% endconfiguration %}
## {% linkable_title Binary Sensor %}
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 %}
## {% linkable_title Switch %}
The `digital_ocean` switch platform allows you to control (start/stop) 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
switch:
- platform: digital_ocean
droplets:
- 'fedora-512mb-nyc3-01'
- 'coreos-512mb-nyc3-01'
```
{% configuration %}
droplets:
description: List of droplets you want to control.
required: true
type: list
{% endconfiguration %}

77
source/_components/dovado.markdown
View File

@ -7,13 +7,24 @@ sidebar: true
comments: false
sharing: true
footer: true
ha_category: System Monitor
ha_category:
- System Monitor
- Notifications
- Sensor
logo: dovado.png
ha_release: 0.87
ha_iot_class: "Local Polling"
redirect_from:
- /components/notify.dovado/
- /components/sensor.dovado/
---
The `dovado` component manages communication with the [Dovado](http://www.dovado.com/) router. Once you've setup this component, you should enable the [sensor](/components/sensor.dovado) and [notify](/components/notity.dovado) platforms to use Dovado.
The `dovado` component manages communication with the [Dovado](http://www.dovado.com/) router.
There is currently support for the following device types within Home Assistant:
- [Notifications](/components/dovado/#notifications)
- [Sensor](/components/dovado/#sensor)
To add a Dovado component to your installation, add the following to your `configuration.yaml` file:
@ -44,3 +55,65 @@ port:
type: integer
default: 6435
{% endconfiguration %}
## {% linkable_title Notifications %}
The `dovado` notify platform allows you to send SMS from your [Dovado](http://www.dovado.com/) router, if it supports it.
To add the Dovado notify platform to your installation, add the following to your `configuration.yaml` file:
```yaml
# Example configuration.yaml entry
notify:
- platform: dovado
```
### {% linkable_title Usage %}
This is a notify platform and thus can be controlled by calling the notify service [as described here](/components/notify/). It will send an SMS notification to a single phone number in the notification **target**.
```yaml
# Example automation notification entry
automation:
- alias: The sun has set
trigger:
platform: sun
event: sunset
action:
service: notify.dovado
data:
message: 'The sun has set'
target: '+14151234567'
```
## {% linkable_title Sensor %}
The `dovado` sensor platform let you monitor your [Dovado](http://www.dovado.com/) router.
To add a Dovado sensor to your installation, add the following to your `configuration.yaml` file:
```yaml
# Example configuration.yaml entry
sensor:
- platform: dovado
sensors:
- network
```
{% configuration %}
sensors:
description: Conditions to display in the frontend. Only accepts the values listed here.
required: true
type: list
keys:
network:
description: Creates a sensor for Network State (3G, 4G, etc.).
signal:
description: Creates a sensor for the signal strength.
download:
description: Creates a sensor for download speed.
upload:
description: Creates a sensor for download speed.
sms:
description: Creates a sensor for number of unread text messages.
{% endconfiguration %}

81
source/_components/dyson.markdown
View File

@ -8,12 +8,29 @@ comments: false
sharing: true
footer: true
logo: dyson.png
ha_category: Hub
ha_category:
- Hub
- Climate
- Fan
- Sensor
- Vacuum
ha_iot_class: "Cloud Polling"
ha_release: 0.47
redirect_from:
- /components/vacuum.dyson/
- /components/climate.dyson/
- /components/fan.dyson/
- /components/sensor.dyson/
---
The `dyson` component is the main component to integrate all [Dyson](https://dyson.com) related platforms: [Fans](/components/fan.dyson/) and [Robot vacuum cleaners](/components/vacuum.dyson/).
The `dyson` component is the main component to integrate all [Dyson](https://dyson.com) related platforms.
There is currently support for the following device types within Home Assistant:
- Climate
- Fan
- Sensor
- Vacuum
## {% linkable_title Configuration %}
@ -26,7 +43,7 @@ dyson:
password: YOUR_DYSON_PASSWORD
language: YOUR_DYSON_ACCOUNT_LANGUAGE
devices:
- device_id: DEVICE_ID_1 # eg. Serial number: XXX-XX-XXXXXXXX
- device_id: DEVICE_ID_1 # e.g., Serial number: XXX-XX-XXXXXXXX
device_ip: DEVICE_IP_1
- device_id: DEVICE_ID_2
device_ip: DEVICE_IP_2
@ -82,3 +99,61 @@ For example:
```bash
$ nmap -p 1883 192.168.0.0/24 -- open
```
## {% linkable_title Vacuum %}
The `dyson` vacuum platform allows you to control your Dyson 360 Eye robot vacuum.
### {% linkable_title Component services %}
This component support the following services (see [Vacuum Cleaner Robots](/components/vacuum/)):
- [`turn_on`](/components/vacuum/#service-vacuumturn_on)
- [`turn_off`](/components/vacuum/#service-vacuumturn_off)
- [`start_pause`](/components/vacuum/#service-vacuumstart_pause)
- [`stop`](/components/vacuum/#service-vacuumstop)
- [`return_to_home`](/components/vacuum/#service-vacuumreturn_to_home)
- [`set_fan_speed`](/components/vacuum/#service-vacuumset_fanspeed). Fan speed values:
- `Quiet`
- `Max`
## {% linkable_title Climate %}
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 part on this page.
### {% 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)
## {% linkable_title Fan %}
The `dyson` fan platform allows you to control your Dyson Purifier fans.
### {% linkable_title Supported fan devices %}
- Pure Cool link (desk and tower)
- Pure Hot+cool link (see climate part) for thermal control
### {% linkable_title Attributes %}
There are several attributes which can be used for automations and templates.
| Attribute | Description |
| --------- | ----------- |
| `is_night_mode` | A boolean that indicates if the night mode of the fan device is on.
| `is_auto_mode` | A boolean that indicates if the auto mode of the fan device is on.
## {% linkable_title Sensor %}
The `dyson` sensor platform allows you to control your Dyson Purifier's filter life time.
### {% linkable_title Supported fan devices %}
- Pure Cool link (desk and tower)
- Pure Hot+cool link (see climate part) for thermal control

2
source/_components/ecobee.markdown
View File

@ -11,7 +11,7 @@ logo: ecobee.png
ha_category:
- Sensor
- Binary Sensor
- Notify
- Notifications
- Climate
- Weather
featured: true

49
source/_components/egardia.markdown
View File

@ -7,9 +7,16 @@ sidebar: true
comments: false
sharing: true
footer: true
ha_category: Hub
ha_release: 0.65
logo: egardia.png
ha_category:
- Hub
- Alarm
- Binary Sensor
ha_release: 0.65
ha_iot_class: "Polling"
redirect_from:
- /components/alarm_control_panel.egardia/
- /components/binary_sensor.egardia/
---
The `egardia` platform enables the ability to control an [Egardia](http://egardia.com/)/[Woonveilig](http://woonveilig.nl) control panel. These alarm panels are known under different brand names across the world, including Woonveilig in the Netherlands. This was tested on the WL-1716, GATE-01, GATE-02 and GATE-03 versions of the Egardia/Woonveilig platform. Not only will you integrate your alarm control panel, supported sensors (door contacts at this moment) will be added automatically (hidden by default).
@ -19,6 +26,7 @@ You will need to know the IP of your alarm panel on your local network. Test if
## {% linkable_title Basic configuration %}
To enable the integration with your alarm panel, add the following lines to your `configuration.yaml` file:
```yaml
# Example configuration.yaml entry
egardia:
@ -100,22 +108,25 @@ There seem to be multiple versions of software running on GATE-02 devices; we ha
2. Once logged in, go to *System Settings*, *Report* and change the Server Address for your primary server to the IP or hostname of your Home Assistant machine. You can leave the port number set to 52010 or change it to anything you like. **Make sure to change the settings of the primary server otherwise the messages will not come through. Note that this will limit (or fully stop) the number of alarm messages you will get through Egardia's / Woonveilig services.** Maybe, that is just what you want. Make sure to save your settings by selecting 'OK'.
3. The Egardia component relies on capturing the status codes that your alarm emits when something happens (status change or trigger). These codes will be unique for every situation - i.e. the code emitted by the alarm when a sensor is triggered is unique to that sensor. Also, if you have multiple users or remotes, each remote has unique codes that are emitted by the alarm when status is changed using that remote or by that user. For the Egardia component to work correctly you will need to capture the codes. To do this, on your Home Assistant machine run `$ sudo python3 egardiaserver.py`. Refer to the [python-egardia repository](https://github.com/jeroenterheerdt/python-egardia) for detailed documentation on parameters. This will receive status codes from your alarm control panel and display them. Record the codes shown as well as the status they relate to (see step 4 below). Make sure to change the status of your alarm to all states (disarm, arm, home) by all means possible (all users, remotes, web login, app) as well as trigger the alarm in all ways possible to get 100% coverage of all the codes the alarm system generates. You will need to run this script once and stop it once you have captured all the possible codes. Also, if you ever add users, remotes or sensors to your alarm system, make sure to re-run the script to capture the extra codes so you can update your configuration (see step 4 below). **For comfort, before triggering the alarm it might be good to disable the siren temporarily (can be done in Panel Settings).**
4. Once you have the codes, update your `configuration.yaml`:
```yaml
# Example configuration.yaml entry
egardia:
host: YOUR_HOST
username: YOUR_USERNAME
password: YOUR_PASSWORD
report_server_enabled: true
report_server_port: PORT_OF_EGARDIASERVER (optional, defaults to 52010)
report_server_codes:
arm: XXXXXXXXXXXXXXXX, XXXXXXXXXXXXXXXX
disarm: XXXXXXXXXXXXXXXX, XXXXXXXXXXXXXXXX
armhome: XXXXXXXXXXXXXXXX
triggered: XXXXXXXXXXXXXXXX, XXXXXXXXXXXXXXXX, XXXXXXXXXXXXXXXX
ignore: XXXXXXXXXXXXXXXX
```
```yaml
# Example configuration.yaml entry
egardia:
host: YOUR_HOST
username: YOUR_USERNAME
password: YOUR_PASSWORD
report_server_enabled: true
report_server_port: PORT_OF_EGARDIASERVER (optional, defaults to 52010)
report_server_codes:
arm: XXXXXXXXXXXXXXXX, XXXXXXXXXXXXXXXX
disarm: XXXXXXXXXXXXXXXX, XXXXXXXXXXXXXXXX
armhome: XXXXXXXXXXXXXXXX
triggered: XXXXXXXXXXXXXXXX, XXXXXXXXXXXXXXXX, XXXXXXXXXXXXXXXX
ignore: XXXXXXXXXXXXXXXX
```
Note that for all code groups (*arm*,*disarm*, etc) multiple codes can be entered since each sensor triggers with a different code and each user of the system has its own arm and disarm codes. Also note that your system will do regular system checks which will be reported as well. Since Home Assistant provides no way of handling them properly, you can enter those codes as *ignore* (again, multiple codes can be used here). The egardia component will ignore these codes and continue returning the old status if it receives any of the codes that are listed as ignore. This is useful for example when you have armed your alarm at night: normally a system check will occur at least once during the night and if that code is not specified anywhere Home Assistant will set the status of the alarm to its default, which is unarmed. This is in fact wrong. Listing the code as ignore changes this behavior and Home Assistant will continue to show the status the alarm is in (disarm, arm, home, triggered) even when system checks occur.
5. Test your setup and enjoy. The component will update if the alarm status changes, including triggers. You can use this to build your own automations and send notifications as you wish. *Note*: previous versions required a separate egardiaserver to be set up. This is no longer necessary and corresponding system services can be removed (using systemctl).
## {% linkable_title Binary Sensor %}
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.

15
source/_components/eight_sleep.markdown
View File

@ -8,13 +8,24 @@ comments: false
sharing: true
footer: true
logo: eight_sleep.png
ha_category: Health
ha_category:
- Health
- Binary Sensor
- Sensor
ha_release: "0.44"
ha_iot_class: "Cloud Polling"
redirect_from:
- /components/binary_sensor.eight_sleep/
- /components/sensor.eight_sleep/
---
The `eight_sleep` component allows Home Assistant to fetch data from your [Eight Sleep](https://eightsleep.com/) smart cover or mattress.
There is currently support for the following device types within Home Assistant:
- Binary Sensor - lets observe the presence state of a [Eight Sleep](https://eightsleep.com/) cover/mattress through Home Assistant.
- Sensor - This includes bed state and results of the current and previous sleep sessions.
## {% linkable_title Configuration %}
It's setup utilizing 'Sensor' platform to convey the current state of your bed and results of your sleep sessions and a 'Binary Sensor' platform to indicate your presence in the bed. A service is also provided to set the heating level and duration of the bed.
@ -82,4 +93,4 @@ script:
entity_id: "sensor.eight_left_bed_state"
target: 35
duration: 3600
```
```

33
source/_components/fan.dyson.markdown
View File

@ -1,33 +0,0 @@
---
layout: page
title: "Dyson Purifier Fan"
description: "Instructions on how to setup the Dyson Purifier fans within Home Assistant."
date: 2017-05-27 10:00
sidebar: true
comments: false
sharing: true
footer: true
logo: dyson.png
ha_category: Fan
ha_iot_class: "Cloud Polling"
ha_release: 0.47
---
The `dyson` fan platform allows you to control your Dyson Purifier fans.
You first have to setup the [Dyson component](/components/dyson/)
### {% linkable_title Supported fan devices %}
- Pure Cool link (desk and tower)
- Pure Hot+cool link (see [climate](/components/climate.dyson/) for thermal control)
### {% linkable_title Attributes %}
There are several attributes which can be used for automations and templates.
| Attribute | Description |
| --------- | ----------- |
| `is_night_mode` | A boolean that indicates if the night mode of the fan device is on.
| `is_auto_mode` | A boolean that indicates if the auto mode of the fan device is on.

24
source/_components/fan.insteon.markdown
View File

@ -1,24 +0,0 @@
---
layout: page
title: "Insteon Fan"
description: "Instructions on how to setup the Insteon fan locally within Home Assistant."
date: 2018-08-20 16:00
sidebar: true
comments: false
sharing: true
footer: true
logo: insteon.png
ha_category: Fan
ha_iot_class: "Local Push"
ha_version: 0.77
---
The `insteon` fan platform lets you control your [FanLinc] 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/
[FanLinc]: https://www.smarthome.com/fanlinc-insteon-2475f-ceiling-fan-and-light-controller-fixture-module-dual-band.html

2
source/_components/gpslogger.md
View File

@ -60,7 +60,7 @@ https://YOUR.DNS.HOSTNAME:PORT/api/webhook/WEBHOOK_ID
```text
latitude=%LAT&longitude=%LON&device=%SER&accuracy=%ACC&battery=%BATT&speed=%SPD&direction=%DIR&altitude=%ALT&provider=%PROV&activity=%ACT
```
- You can change the name of your device name by replacing `&device=%SER` with `&device=%DEVICE_NAME`.
- You can change the `device_id` of your phone by replacing `&device=%SER` with `&device=SOME_DEVICE_ID`, otherwise your phone's serial number will be used.
- Check that the **HTTP Headers** setting contains
```text
Content-Type: application/x-www-form-urlencoded

7
source/_components/greeneye_monitor.markdown
View File

@ -8,9 +8,13 @@ comments: false
sharing: true
footer: true
logo: brultech.png
ha_category: Hub
ha_category:
- Hub
- Sensor
ha_release: 0.82
ha_iot_class: "Local Push"
redirect_from:
- /components/sensor.greeneye_monitor/
---
The [GreenEye Monitor (GEM)](http://www.brultech.com/greeneye/) integration for Home Assistant allows you to create sensors for the various data channels of the GEM. Each current transformer (CT) channel, pulse counter, and temperature sensor appears in Home Assistant as a sensor, and can be used in automations.
@ -123,4 +127,3 @@ monitors:
type: string
default: s
{% endconfiguration %}

6
source/_components/hlk_sw16.markdown
View File

@ -8,9 +8,13 @@ comments: false
sharing: true
footer: true
logo: hlktech.jpg
ha_category: DIY
ha_category:
- DIY
- Switch
ha_release: 0.84
ha_iot_class: "Local Push"
redirect_from:
- /components/switch.hlk_sw16/
---
The [HLK-SW16](http://www.hlktech.net/product_detail.php?ProId=48) by [Hi-Link](http://www.hlktech.net/) is a simple networkable 16 port relay device.

2
source/_components/homekit.markdown
View File

@ -146,7 +146,7 @@ homekit:
After Home Assistant has started, the entities specified by the filter are exposed to HomeKit if they are [supported](#supported-components). To add them:
1. Open the Home Assistant frontend. A new card will display the `pin code`.
1. Open the Home Assistant frontend. A new card will display the `pin code`. Note: If pin code is not displayed, check "Notifications" (the bell icon) in the upper-right of the Home Assistant UI.
1. Open the `Home` app.
2. Click `Add Accessory`, then select `Don't Have a Code or Can't Scan?` and choose the `Home Assistant Bridge`.
4. Confirm that you are adding an `Uncertified Accessory` by clicking on `Add Anyway`.

8
source/_components/homematic.markdown
View File

@ -15,7 +15,7 @@ ha_category:
- Cover
- Light
- Lock
- Notify
- Notifications
- Sensor
- Switch
ha_iot_class: "Local Push"
@ -42,7 +42,7 @@ There is currently support for the following device types within Home Assistant:
- Cover
- Light
- Lock
- Notify
- Notifications
- Sensor
- Switch
@ -406,7 +406,7 @@ When the connection to your HomeMatic CCU or Homegear is lost, Home Assistant wi
service: homematic.reconnect
```
- If you have a CCU you can also create a system variable on the CCU, which stores its last reboot time. Since Home Assistant can still refresh system variables from the CCU (even after a reboot), this is a pretty reliable way to detect situations where you need to call *homematic.reconnect*. This is how this can be done:
- If you have a CCU you can also create a system variable on the CCU, which stores its last reboot time. Since Home Assistant can still refresh system variables from the CCU (even after a reboot) this is another option to call *homematic.reconnect*. Even though this option might look preferrable to many since it does not rely on a sensor, **it is less fail-safe** than checking for updates of a sensor. Since the variable on the CCU is only changed on boot, any problem that causes the connection between Home Assistant and the CCU to break but will not result in a reboot will not be detected (eg. in case of networking issues). This is how this can be done:
1. Create a string variable **V_Last_Reboot** on the CCU
@ -541,4 +541,4 @@ alert:
```
{% endraw %}
Please note that the first `data` element belongs to the service `my_hm`, while the second one belongs to the event payload.
Please note that the first `data` element belongs to the service `my_hm`, while the second one belongs to the event payload.

45
source/_components/homematicip_cloud.markdown
View File

@ -61,34 +61,35 @@ authtoken:
## {% linkable_title Implemented and tested devices %}
- homematicip_cloud.alarm_control_panel
- Security zones (*HmIP-SecurityZone*)
- Security zones (*HmIP-SecurityZone*)
- homematicip_cloud.binary_sensor
- Window and door contact (*HmIP-SWDO, HmIP-SWDO-I*)
- Rotary Handle Sensor (*HmIP-SRH*)
- Smoke sensor and alarm (*HmIP-SWSD*)
- Motion detectors (*HmIP-SMI*)
- Motion detectors and push button (*HmIP-SMI55*)
- Water detector (*HmIP-SWD*)
- homematicip_cloud.binary_sensor
- Window and door contact (*HmIP-SWDO, HmIP-SWDO-I*)
- Rotary Handle Sensor (*HmIP-SRH*)
- Smoke sensor and alarm (*HmIP-SWSD*)
- Motion detectors (*HmIP-SMI*)
- Motion detectors and push button (*HmIP-SMI55*)
- Water detector (*HmIP-SWD*)
- homematicip_cloud.climate
- Radiator thermostat (*HmIP-eTRV,-2*)
- Climate group (*HmIP-HeatingGroup*)
- Radiator thermostat (*HmIP-eTRV,-2*)
- Climate group (*HmIP-HeatingGroup*)
- homematicip_cloud.light
- Switch actuator and meter for brand switches (*HmIP-BSM*)
- Dimming actuator for brand switches (*HmIP-BDT*)
- Switch Actuator for brand switches – with signal lamp (*HmIP-BSL*)
- Switch actuator and meter for brand switches (*HmIP-BSM*)
- Dimming actuator for brand switches (*HmIP-BDT*)
- Switch Actuator for brand switches – with signal lamp (*HmIP-BSL*)
- homematicip_cloud.sensor
- Accesspoint duty-cycle (*HmIP-HAP*)
- Wall-mounted thermostat (*HmIP-WTH*)
- Temperature and humidity sensor (*HmIP-STH*)
- Temperature and humidity Sensor with display (*HmIP-STHD*)
- Outdoor temperature and humidity sensor (*HmIP-STHO*)
- Illuminance sensor (*HmIP-SMI, 55*)
- Light sensor Outdoor (*HmIP-SLO*)
- Accesspoint duty-cycle (*HmIP-HAP*)
- Wall-mounted thermostat (*HmIP-WTH*)
- Temperature and humidity sensor (*HmIP-STH*)
- Temperature and humidity Sensor with display (*HmIP-STHD*)
- Outdoor temperature and humidity sensor (*HmIP-STHO*)
- Illuminance sensor (*HmIP-SMI, 55*)
- Light sensor Outdoor (*HmIP-SLO*)
- homematicip_cloud.switch
- Pluggable Switch and Meter (*HmIP-PSM*)
- Full flush Switch and Meter (*HmIP-FSM, HmIP-FSM16*)
- Pluggable Switch and Meter (*HmIP-PSM*)
- Full flush Switch and Meter (*HmIP-FSM, HmIP-FSM16*)

4
source/_components/hue.markdown
View File

@ -35,7 +35,7 @@ hue:
{% configuration %}
host:
description: The IP address of the device, eg. 192.168.1.10. Required if not using the `discovery` component to discover Hue bridges.
description: The IP address of the device, e.g., 192.168.1.10. Required if not using the `discovery` component to discover Hue bridges.
required: true
type: string
allow_unreachable:
@ -108,7 +108,7 @@ To create a `LightGroup` named `Ceiling lights` that contains the lights 1, 2 an
$ curl -XPOST -d '{"name": "Ceiling lights", "lights": ["1", "2", "3"]}' http://<bridge>/api/<username>/groups
```
The `<username>` is the string that is used to register Home Assistant on the bridge, you can find it in the `phue.conf` file in your configuration path. `<bridge>` is the IP address or hostname of your Hue bridge.
The `<username>` is the string that is used to register Home Assistant on the bridge, you can find it in the `core.config_entries` file in your configuration\.storage path. `<bridge>` is the IP address or hostname of your Hue bridge.
You can find out the ids of your lights by executing the following command:

4
source/_components/ifttt.markdown
View File

@ -19,8 +19,12 @@ ha_iot_class: "Cloud Push"
To be able to receive events from IFTTT, your Home Assistant instance needs to be accessible from the web ([Hass.io instructions](/addons/duckdns/)) and you need to have the `base_url` configured for the HTTP component ([docs](/components/http/#base_url)).
### {% linkable_title Setting up the integration %}
To set it up, go to the integrations page in the configuration screen and find IFTTT. Click on configure. Follow the instructions on the screen to configure IFTTT.
### {% linkable_title Using the incoming data %}
Events coming in from IFTTT will be available as events in Home Assistant and are fired as `ifttt_webhook_received`. The data specified in IFTTT will be available as the event data. You can use this event to trigger automations.
For example, set the body of the IFTTT webhook to:

2
source/_components/image_processing.qrcode.markdown
View File

@ -15,6 +15,8 @@ ha_release: 0.87
The `qrcode` image processing platform enables QR code recognition from cameras.
To get this running, please install `zbar-tools` (Ubuntu 18.04)
## {% linkable_title Configuration %}
To enable this, add the following lines to your `configuration.yaml` file:

24
source/_components/input_datetime.markdown
View File

@ -114,9 +114,11 @@ automation:
{% endraw %}
To dynamically set the `input_datetime` you can call
`input_datetime.set_datetime`. The following example can be used in an
automation rule:
`input_datetime.set_datetime`. The values for `date` and `time` must be in a certain format for the call to be successful.
You can use either `strftime("%Y-%m-%d")`/`strftime("%H:%M:%S")` or `timestamp_custom("%Y-%m-%d", true)`/`timestamp_custom("%H:%M:%S", true)` filter respectively.
The following example can be used in an automation rule:
{% raw %}
```yaml
# Example configuration.yaml entry
# Sets input_datetime to '05:30' when an input_boolean is turned on.
@ -126,8 +128,24 @@ automation:
entity_id: input_boolean.example
to: 'on'
action:
service: input_datetime.set_datetime
- service: input_datetime.set_datetime
entity_id: input_datetime.bedroom_alarm_clock_time
data:
time: '05:30:00'
- service: input_datetime.set_datetime
entity_id: input_datetime.another_time
data_template:
time: '{{ now().strftime("%H:%M:%S") }}'
- service: input_datetime.set_datetime
entity_id: input_datetime.another_date
data_template:
date: '{{ now().strftime("%Y-%m-%d") }}'
- service: input_datetime.set_datetime
data_template:
entity_id: input_datetime.date_and_time
date: >
{{ now().timestamp() | timestamp_custom("%Y-%m-%d", true) }}
time: >
{{ now().timestamp() | timestamp_custom("%H:%M:%S", true) }}
```
{% endraw %}

32
source/_components/insteon.markdown
View File

@ -8,13 +8,37 @@ comments: false
sharing: true
footer: true
logo: insteon.png
ha_category: Hub
ha_category:
- Hub
- Binary Sensor
- Cover
- Fan
- Light
- Sensor
- Switch
ha_iot_class: "Local Push"
ha_version: 0.77
redirect_from:
- /components/binary_sensor.insteon/
- /components/cover.insteon/
- /components/fan.insteon/
- /components/light.insteon/
- /components/sensor.insteon/
- /components/switch.insteon/
---
This component adds "local push" support for INSTEON Modems allowing linked INSTEON devices to be used within Home Assistant as binary sensors, lights, fans, sensors and switches. Device support is provided by the
underlying [insteonplm] package. It is known to work with the [2413U] USB and [2412S] RS242 flavors of PLM and the [2448A7] USB stick. It has also been tested to work with the [2242] and [2245] Hubs.
This component adds "local push" support for INSTEON Modems allowing linked INSTEON devices to be used within Home Assistant.
There is currently support for the following device types within Home Assistant:
- Binary Sensor
- Cover
- Fan
- Light
- Sensor
- Switch
Device support is provided by the underlying [insteonplm] package. It is known to work with the [2413U] USB and [2412S] RS242 flavors of PLM and the [2448A7] USB stick. It has also been tested to work with the [2242] and [2245] Hubs.
[insteonplm]: https://github.com/nugget/python-insteonplm
[2413U]: https://www.insteon.com/powerlinc-modem-usb
@ -287,4 +311,4 @@ The INSTEON Hub has three known issues that are inherent to the design of the Hu
2. You cannot use both Home Assistant and the INSTEON app. If you do, the changes made in the app will not appear in Home Assistant. Changes made in Home Assistant will appear in the app after a period of time, however.
3. The Hub response times can be very slow. This is due to the Hub polling devices frequently. Since only one INSTEON message can be broadcast at a time, messages to and from Home Assistant can be delayed.
3. The Hub response times can be very slow. This is due to the Hub polling devices frequently. Since only one INSTEON message can be broadcast at a time, messages to and from Home Assistant can be delayed.

18
source/_components/insteon_local.markdown
View File

@ -1,18 +0,0 @@
---
layout: page
title: "Insteon (local)"
description: "Instructions on how to setup the Insteon Hub locally within Home Assistant."
date: 2016-12-18 08:00
sidebar: true
comments: false
sharing: true
footer: true
logo: insteon.png
ha_category: Hub
ha_iot_class: "Local Polling"
ha_version: 0.36
---
The `insteon_local` component is depreciated and has been replaced by the [insteon] component.
[insteon]: /components/insteon

18
source/_components/insteon_plm.markdown
View File

@ -1,18 +0,0 @@
---
layout: page
title: "Insteon PLM"
description: "Instructions on how to setup an Insteon USB PLM locally within Home Assistant."
date: 2017-02-19 16:00
sidebar: true
comments: false
sharing: true
footer: true
logo: insteon.png
ha_category: Hub
ha_iot_class: "Local Push"
ha_version: 0.39
---
The `insteon_plm` component is depreciated and has been replaced by the [insteon] component.
[insteon]: /components/insteon

4
source/_components/isy994.markdown
View File

@ -58,7 +58,7 @@ isy994:
{% configuration %}
host:
description: The host entry should be in full URL format, eg. http://192.168.10.100:80
description: The host entry should be in full URL format, e.g., http://192.168.10.100:80
required: true
type: string
username:
@ -75,7 +75,7 @@ sensor_string:
type: string
default: sensor
ignore_string:
description: Any devices that contain this string in their name (or folder path) will be ignored by Home Assistant. They will not become entities at all.
description: Any devices that contain this string in their name (or folder path) will be ignored by Home Assistant. They will not become entities at all.
required: false
type: string
default: {IGNORE ME}

2
source/_components/joaoapps_join.markdown
View File

@ -10,7 +10,7 @@ footer: true
logo: joaoapps_join.png
ha_category:
- Hub
- Notify
- Notifications
ha_release: "0.24"
redirect_from:
- /components/notify.joaoapps_join/

13
source/_components/kira.markdown
View File

@ -8,12 +8,23 @@ comments: false
sharing: true
footer: true
logo: keene.png
ha_category: Hub
ha_category:
- Hub
- Remote
- Sensor
ha_release: 0.45
redirect_from:
- /components/sensor.kira/
- /components/remote.kira/
---
The `kira` component is the main component to integrate Keene Electronics IR over IP [Kira](https://www.keene.co.uk/keene-ir-anywhere-single-worldwide.html) modules with Home Assistant.
There is currently support for the following device types within Home Assistant:
- Remote
- Sensor
### {% linkable_title Example Configuration %}
```yaml

45
source/_components/konnected.markdown
View File

@ -8,8 +8,14 @@ comments: false
sharing: true
footer: true
logo: konnected.png
ha_category: Alarm
ha_category:
- Alarm
- Binary Sensor
- Switch
ha_release: "0.70"
redirect_from:
- /components/binary_sensor.konnected/
- /components/switch.konnected/
---
The `konnected` component lets you connect wired sensors and switches to a NodeMCU ESP8226 based device running the [open source Konnected software](https://github.com/konnected-io/konnected-security). Reuse the wired sensors and siren from an old or pre-wired alarm system installation and integrate them directly into Home Assistant.
@ -18,8 +24,8 @@ Visit the [Konnected.io website](https://konnected.io) for more information abou
The component currently supports the following device types in Home Assistant:
- [Binary Sensor](/components/binary_sensor.konnected/): Wired door and window sensors, motion detectors, glass-break detectors, leak sensors, smoke & CO detectors or any open/close switch.
- [Switch](/components/switch.konnected/): Actuate a siren, strobe, buzzer or relay module.
- Binary Sensor: Wired door and window sensors, motion detectors, glass-break detectors, leak sensors, smoke & CO detectors or any open/close switch.
- Switch: Actuate a siren, strobe, buzzer or relay module.
This component requires the [`discovery`](/components/discovery) component to be enabled.
@ -134,7 +140,7 @@ devices:
required: false
default: true
description: Blink the blue LED upon successful transmission of a state change.
{% endconfiguration%}
#### {% linkable_title Configuration Notes %}
@ -208,19 +214,34 @@ Konnected runs on an ESP8266 board with the NodeMCU firmware. It is commonly use
### {% linkable_title Revision History %}
#### 0.80
* Added ability to specify `host` and `port` to set up devices without relying on discovery.
* Added `discovery` and `blink` config options to enable/disable these features.
- Added ability to specify `host` and `port` to set up devices without relying on discovery.
- Added `discovery` and `blink` config options to enable/disable these features.
#### 0.79
* Added `inverse` configuration option for binary sensors.
- Added `inverse` configuration option for binary sensors.
#### 0.77
* Added support for momentary and beep/blink switches. [[#15973](https://github.com/home-assistant/home-assistant/pull/15973)]
* Decouple entity initialization from discovery, enabling devices to recover faster after a Home Assistant reboot. [[#16146](https://github.com/home-assistant/home-assistant/pull/16146)]
* **Breaking change:** Device `id` in `configuration.yaml` must now be the full 12-character device MAC address. Previously, omitting the first 6 characters was allowed.
- Added support for momentary and beep/blink switches. [[#15973](https://github.com/home-assistant/home-assistant/pull/15973)]
- Decouple entity initialization from discovery, enabling devices to recover faster after a Home Assistant reboot. [[#16146](https://github.com/home-assistant/home-assistant/pull/16146)]
- **Breaking change:** Device `id` in `configuration.yaml` must now be the full 12-character device MAC address. Previously, omitting the first 6 characters was allowed.
#### 0.72
* Adds `api_host` configuration option [[#14896](https://github.com/home-assistant/home-assistant/pull/14896)]
- Adds `api_host` configuration option [[#14896](https://github.com/home-assistant/home-assistant/pull/14896)]
#### 0.70
* Initial release
- Initial release
### {% linkable_title Binary Sensor %}
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).
This component supports all of the built-in device classes of the generic [Binary Sensor](/components/binary_sensor/) component.
### {% linkable_title Switch %}
The `konnected` switch platform allows you to actuate an alarm system siren, strobe light, buzzer or any other wired device using a [Konnected Alarm Panel board](https://konnected.io) or relay module and a NodeMCU ESP8266 WiFi module running the [open source Konnected software](https://github.com/konnected-io/konnected-security).

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

@ -1,20 +0,0 @@
---
layout: page
title: "Abode Light"
description: "Instructions on how to integrate Abode lights 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: Light
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 `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).
The requirement is that you have setup your [Abode hub](/components/abode/).

42
source/_components/light.ads.markdown
View File

@ -1,42 +0,0 @@
---
layout: page
title: "ADS Light"
description: Instructions on how to set up ADS lights within Home Assistant
date: 2017-10-25 10:00
sidebar: true
comments: false
sharing: true
footer: true
logo: beckhoff.png
ha_category: Light
ha_release: "0.60"
ha_iot_class: "Local Push"
---
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 %}

31
source/_components/light.deconz.markdown
View File

@ -1,31 +0,0 @@
---
layout: page
title: "deCONZ Lights"
description: "Instructions on how to integrate Zigbee lights from deCONZ into Home Assistant."
date: 2017-11-12 16:30
sidebar: true
comments: false
sharing: true
footer: true
logo: deconz.jpeg
ha_category: Light
ha_release: "0.61"
ha_iot_class: "Local Push"
---
See the [deCONZ main component](/components/deconz/) for configuration instructions.
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

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

@ -1,21 +0,0 @@
---
layout: page
title: "Insteon Light"
description: "Instructions on how to setup Insteon lights locally within Home Assistant."
date: 2018-08-20 16:00
sidebar: true
comments: false
sharing: true
footer: true
logo: insteon.png
ha_category: Light
ha_iot_class: "Local Push"
ha_version: 0.77
---
The `insteon` light platform lets you control your lights 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/

3
source/_components/light.opple.markdown
View File

@ -35,8 +35,7 @@ name:
type: string
default: opple light
host:
description: "The IP address of your Opple light, eg. `192.168.0.21`."
description: "The IP address of your Opple light, e.g., `192.168.0.21`."
required: true
type: string
{% endconfiguration %}

19
source/_components/light.qwikswitch.markdown
View File

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

35
source/_components/light.scsgate.markdown
View File

@ -1,35 +0,0 @@
---
layout: page
title: "SCSGate Light"
description: "Instructions on how to integrate SCSGate lights into Home Assistant."
date: 2016-01-31 19:30
sidebar: true
comments: false
sharing: true
footer: true
logo: bus_scs.png
ha_category: Light
ha_release: 0.13
ha_iot_class: "Local Polling"
---
The SCSGate device can control lights of the BTicino MyHome system.
To enable SCSGate lights in your installation, add the following to your `configuration.yaml` file:
```yaml
# Example configuration.yaml entry
light:
- platform: scsgate
devices:
living_room:
name: Living Room
scs_id: XXXXX
```
{% configuration %}
devices:
description: A list of devices with their name to use in the frontend.
required: true
type: list
{% endconfiguration %}

26
source/_components/light.skybell.markdown
View File

@ -1,26 +0,0 @@
---
layout: page
title: "Skybell Light"
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: Light
ha_release: 0.56
ha_iot_class: "Cloud Polling"
---
To get your [Skybell.com](https://skybell.com/) LED light 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
light:
- platform: skybell
```

2
source/_components/light.tplink.markdown
View File

@ -42,7 +42,7 @@ name:
type: string
default: TP-Link Light
host:
description: "The IP address of your TP-Link bulb, eg. `192.168.1.32`."
description: "The IP address of your TP-Link bulb, e.g., `192.168.1.32`."
required: true
type: string
{% endconfiguration %}

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