jeans/home-assistant.io
jeans/home-assistant.io
1
0
Fork 0
mirror of https://github.com/home-assistant/home-assistant.io.git synced 2025-07-23 09:17:06 +00:00
Code Issues Packages Projects Releases Wiki Activity

Merge branch 'next' into awarecan-patch-1

Browse Source
This commit is contained in:
Jason Hu 2018-09-06 13:56:17 -07:00 committed by GitHub
commit ea28791f6b
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
326 changed files with 1690 additions and 895 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
.github/PULL_REQUEST_TEMPLATE.md vendored
View File

@ -5,7 +5,7 @@
## Checklist:
- [ ] Branch: Fixes, changes and adjustments should be created against `current`. New documentation for platforms/components and features should go to `next`.
- [ ] Branch: `next` is for changes and new documentation that will go public with the next [home-assistant](https://github.com/home-assistant/home-assistant) release. Fixes, changes and adjustments for the current release should be created against `current`.
- [ ] The documentation follow the [standards][standards].
[standards]: https://home-assistant.io/developers/documentation/standards/

6
_config.yml
View File

@ -142,13 +142,13 @@ social:
# Home Assistant release details
current_major_version: 0
current_minor_version: 77
current_patch_version: 0
date_released: 2018-08-29
current_patch_version: 3
date_released: 2018-09-03
# Either # or the anchor link to latest release notes in the blog post.
# Must be prefixed with a # and have double quotes around it.
# Major release:
patch_version_notes: "#"
patch_version_notes: "#release-0773---september-3"
# Minor release (Example #release-0431---april-25):
# Date we moved to Discourse for comments

4
source/_addons/git_pull.markdown
View File

@ -18,6 +18,7 @@ Load and update configuration files for Home Assistant from a [Git](https://git-
"git_branch": "master",
"git_command": "pull",
"git_remote": "origin",
"git_prune": "false",
"repeat": {
"active": false,
"interval": 300
@ -38,8 +39,9 @@ Load and update configuration files for Home Assistant from a [Git](https://git-
```
- **repository** (*Required*): Git URL to your repository (make sure to use double quotes). You have to add `.git` to your GitHub repository URL (see example configuration)
- **git_branch** (*Required*): Branch name of the Git repo, leave this as 'master' if you are unsure.
- **git_branch** (*Required*): Branch name of the Git repo. If left empty, the currently checked out branch will be updated. Leave this as 'master' if you are unsure.
- **git_remote** (*Required*): Name of the tracked repository. Leave this as `origin` if you are unsure.
- **git_prune** (*Required*): If set to true, the add-on will cleanup branches that are deleted on the remote repository, but still have cached entries on the local machine. Leave this as `false` if you are unsure.
- **git_command** (*Required*): Must be either `pull` or `reset`. Leave this as `pull` if you are unsure.
* **pull**: Incorporates changes from a remote repository into the current branch. Will preserve any local changes to tracked files.

5
source/_addons/mosquitto.markdown
View File

@ -89,10 +89,11 @@ See the following links for more information:
Add the following configuration to enable ACLs:
1. Set `customize` flag to `true` in your configuration.
1. Set the `active` flag within the `customize` section to `true` in your configuration.
2. Create a file in `/share/mosquitto` named `acl.conf` with the following contents:
```text
acl_file /share/mosquitto/accesscontrollist
```
3. Create a file in `/share/mosquitto` named `accesscontrollist` and add contents according to your requirements.
The `/share` folder can be found on the host filesystem under `/usr/share/hassio/share`, or via the `Share` folder through SMB (Samba).

20
source/_components/apcupsd.markdown
View File

@ -8,12 +8,14 @@ comments: false
sharing: true
footer: true
logo: apcupsd.png
ha_category: Hub
ha_category: System Monitor
ha_release: 0.13
---
[APCUPSd](http://www.apcupsd.org/) status information can be integrated into Home Assistant when the Network Information Server (NIS) [is configured](http://www.apcupsd.org/manual/manual.html#nis-server-client-configuration-using-the-net-driver) is enabled on the APC device.
## {% linkable_title Configuration %}
To enable this sensor, add the following lines to your `configuration.yaml`:
```yaml
@ -21,8 +23,16 @@ To enable this sensor, add the following lines to your `configuration.yaml`:
apcupsd:
```
Configuration variables:
- **host** (*Optional*): The hostname/IP address on which the APCUPSd NIS is being served. Defaults to `localhost`.
- **port** (*Optional*): The port on which the APCUPSd NIS is listening. Defaults to `3551`.
{% configuration %}
host:
description: The hostname/IP address on which the APCUPSd NIS is being served.
required: false
type: string
default: localhost
port:
description: The port on which the APCUPSd NIS is listening.
required: false
type: int
default: 3551
{% endconfiguration %}

2
source/_components/apple_tv.markdown
View File

@ -8,7 +8,7 @@ comments: false
sharing: true
footer: true
logo: apple.png
ha_category: Hub
ha_category: Multimedia
ha_iot_class: "Local Push"
ha_release: 0.49
---

4
source/_components/asterisk_mbox.markdown
View File

@ -8,7 +8,7 @@ comments: false
sharing: true
footer: true
logo: asterisk.png
ha_category: Other
ha_category: Mailbox
ha_iot_class: "Local Push"
ha_release: 0.51
---
@ -19,6 +19,8 @@ To enable the component, a configuration is required in both Home Assistant as w
First follow the [Asterisk PBX configuration guide](/docs/asterisk_mbox/) to setup the necessary server on the Asterisk PBX server (this is needed even if Asterisk and Home Assistant are running on the same server)
## {% linkable_title Configuration %}
Once that is complete, add the following entry `configuration.yaml` file:
```yaml

2
source/_components/august.markdown
View File

@ -8,7 +8,7 @@ comments: false
sharing: true
footer: true
logo: august.png
ha_category: Hub
ha_category: Doorbell
ha_release: "0.64"
ha_iot_class: "Cloud Polling"
---

6
source/_components/axis.markdown
View File

@ -8,7 +8,7 @@ comments: false
sharing: true
footer: true
logo: axis.png
ha_category: Hub
ha_category: Camera
ha_release: "0.45"
ha_iot_class: "Local Polling"
---
@ -17,6 +17,8 @@ ha_iot_class: "Local Polling"
Home Assistant will automatically discover their presence on your network.
## {% linkable_title Configuration %}
You can also manually configure your devices by adding the following lines to your `configuration.yaml` file:
```yaml
@ -28,8 +30,6 @@ axis:
- camera
```
Configuration variables:
## {% linkable_title Configuration variables %}
- **device** (*Required*): Unique name

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

@ -15,6 +15,8 @@ ha_iot_class: "Local Polling"
In addition to the [APCUPSd Sensor](/components/sensor.apcupsd/) devices, you may also create a device which is simply "on" when the UPS status is online and "off" at all other times.
## {% linkable_title Configuration %}
To enable this sensor, you first have to set up [apcupsd](/components/apcupsd/), and add the following lines to your `configuration.yaml` file:
```yaml
@ -23,6 +25,10 @@ binary_sensor:
- platform: apcupsd
```
Configuration variables:
- **name** (*Optional*): Name to use in the front end.
{% configuration %}
name:
description: Name to use in the frontend.
required: false
type: string
default: UPS Online Status
{% endconfiguration %}

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

@ -8,7 +8,7 @@ comments: false
sharing: true
footer: true
logo: arest.png
ha_category: Binary Sensor
ha_category: DIY
ha_iot_class: "Local Polling"
ha_release: 0.9
---
@ -16,6 +16,8 @@ ha_release: 0.9
The `arest` binary sensor platform allows you to get all data from your devices (like Arduinos with an ethernet/wifi connection, the ESP8266, and the Raspberry Pi) running the [aREST](http://arest.io/) RESTful framework.
## {% linkable_title Configuration %}
To use your aREST binary sensor in your installation, add the following to your `configuration.yaml` file:
```yaml

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

@ -8,7 +8,7 @@ comments: false
sharing: true
footer: true
logo: august.png
ha_category: Binary Sensor
ha_category: Doorbell
ha_release: "0.64"
ha_iot_class: "Cloud Polling"
---
@ -20,3 +20,4 @@ If you have August Doorbell, once you have enabled the [August component](/compo
* Doorbell ding sensor
* Doorbell motion sensor
* Doorbell online sensor

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

@ -7,7 +7,7 @@ sidebar: true
comments: false
sharing: true
footer: true
ha_category: Binary Sensor
ha_category: Environment
ha_release: 0.39
logo: noaa.png
---
@ -18,6 +18,8 @@ This service gives a number 0-100 representing the current likelihood of visible
You can check the attributes of the sensor to see your exact forecast.
## {% linkable_title Configuration %}
To add the aurora binary sensor to your installation, add the following to your `configuration.yaml` file:
```yaml

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

@ -8,7 +8,7 @@ comments: false
sharing: true
footer: true
logo: home-assistant.png
ha_category: Binary Sensor
ha_category: Utility
ha_iot_class: "Local Polling"
ha_release: 0.53
---
@ -18,6 +18,8 @@ The `bayesian` binary sensor platform observes the state from multiple sensors a
This allows for the detection of complex events that may not be readily observable, e.g., cooking, showering, in bed, the start of a morning routine, etc. It can also be used to gain greater confidence about events that _are_ directly observable, but for which the sensors can be unreliable, e.g., presence.
## {% linkable_title Configuration %}
To enable the Bayesian sensor, add the following lines to your `configuration.yaml`:
```yaml

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

@ -8,13 +8,15 @@ comments: false
sharing: true
footer: true
logo: beaglebone-black.png
ha_category: Binary Sensor
ha_category: DIY
ha_release: 0.37
ha_iot_class: "Local Push"
---
The `bbb_gpio` binary sensor platform allows you to read sensor values of the GPIOs of your [BeagleBone Black](https://beagleboard.org/black).
## {% linkable_title Configuration %}
To use your BeagleBone Black's GPIO in your installation, add the following to your `configuration.yaml` file:
```yaml

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

@ -8,7 +8,7 @@ comments: false
sharing: true
footer: true
logo: bloomsky.png
ha_category: Binary Sensor
ha_category: Environment
ha_release: 0.14
ha_iot_class: "Cloud Polling"
---
@ -17,6 +17,8 @@ The `bloomsky` binary sensor platform allows you to get data from your BloomSky
To get your BloomSky binary sensors working with Home Assistant, follow the instructions for the [BloomSky component](/components/bloomsky/) first.
## {% linkable_title Configuration %}
To use your BloomSky binary sensor in your installation, add the following to your `configuration.yaml` file:
```yaml

4
source/_components/binary_sensor.bmw_connected_drive.markdown Executable file → Normal file
View File

@ -8,12 +8,12 @@ comments: false
sharing: true
footer: true
logo: bmw.png
ha_category: Binary Sensor
ha_category: Car
ha_release: 0.66
---
The `bmw_connected_drive` platform allows you to import data on your BMW into Home Assistant.
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.

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

@ -8,7 +8,7 @@ comments: false
sharing: true
footer: true
logo: command_line.png
ha_category: Binary Sensor
ha_category: Utility
ha_release: 0.12
ha_iot_class: "Local Polling"
---
@ -16,6 +16,8 @@ ha_iot_class: "Local Polling"
The `command_line` binary sensor platform issues specific commands to get data.
## {% linkable_title Configuration %}
To use your Command binary sensor in your installation, add the following to your `configuration.yaml` file:
```yaml

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

@ -15,6 +15,8 @@ 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

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

@ -8,7 +8,7 @@ comments: false
sharing: true
footer: true
logo: ecobee.png
ha_category: Binary Sensor
ha_category: Environment
ha_release: 0.9
ha_iot_class: "Local Push"
---

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

@ -8,7 +8,7 @@ comments: false
sharing: true
footer: true
logo: eight_sleep.png
ha_category: Binary Sensor
ha_category: Health
ha_release: "0.44"
ha_iot_class: "Cloud Polling"
---
@ -16,4 +16,4 @@ 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 [component](/components/eight_sleep/) configuration on how to setup.
Devices will be configured automatically. Please refer to the [`eight_sleep` component](/components/eight_sleep/) configuration on how to setup.

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

@ -8,7 +8,7 @@ comments: false
sharing: true
footer: true
logo: ffmpeg.png
ha_category: Binary Sensor
ha_category: Image Processing
ha_release: 0.27
redirect_from: /components/binary_sensor.ffmpeg/
---
@ -20,10 +20,12 @@ The `ffmpeg` platform allows you to use any video feed with [FFmpeg](http://www.
If the `ffmpeg` process is broken, the sensor will be unavailable. To control the ffmpeg process of sensor, use the service *ffmpeg.start*, *ffmpeg.stop*, *ffmpeg.restart*.
</p>
### {% linkable_title Motion %}
## {% linkable_title Motion %}
FFmpeg doesn't have a motion detection filter, but can use a scene filter to detect a new scene/motion. You can set how much needs to change in order to detect motion with the option 'changes', the percent value of change between frames. If you want a really small value for 'changes', you can also add a denoise filter.
## {% linkable_title Configuration %}
To add FFmpeg with motion detection to your installation, add the following to your `configuration.yaml` file:
```yaml

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

@ -8,7 +8,7 @@ comments: false
sharing: true
footer: true
logo: ffmpeg.png
ha_category: Binary Sensor
ha_category: Image Processing
ha_release: 0.27
---
@ -19,7 +19,7 @@ The `ffmpeg` platform allows you to use any video or audio feed with [FFmpeg](ht
If the `ffmpeg` process is broken, the sensor will be unavailable. To control the ffmpeg process of sensor, use the service *ffmpeg.start*, *ffmpeg.stop*, *ffmpeg.restart*.
</p>
### {% linkable_title Noise %}
## {% linkable_title Configuration %}
To add FFmpeg with noise detection to your installation, add the following to your `configuration.yaml` file:

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

@ -8,13 +8,15 @@ comments: false
sharing: true
footer: true
logo: hydrawise_logo.png
ha_category: Binary Sensor
ha_category: Irrigation
ha_release: 0.71
ha_iot_class: Cloud Polling
---
Before setting up the [Hunter Hydrawise](https://hydrawise.com) binary sensors please follow the instructions for setting up the [Hydrawise hub](/components/hydrawise) component.
## {% linkable_title Configuration %}
Once you have enabled the `hydrawise` component, add the following to your `configuration.yaml` file:
```yaml

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

@ -15,26 +15,24 @@ ha_iot_class: "Local Polling"
The `knx` sensor platform allows you to monitor [KNX](http://www.knx.org) binary sensors.
## {% linkable_title Configuration %}
The `knx` component must be configured correctly, see [KNX Component](/components/knx).
```yaml
# Example configuration.yaml entry
binary_sensor:
- platform: knx
name: "Entrance.Motion.Sensor"
address: '6/0/2'
device_class: 'motion'
#significant_bit: 2
#reset_after: 100
```
Configuration variables:
- **address** (*Required*): KNX group address of the binary sensor.
- **name** (*Optional*): A name for this device used within Home Assistant.
- **address**: KNX group address of the binary sensor.
- **device_class** (Optional): HASS device class e.g., "motion".
- **significant_bit** (Optional): Specify which significant bit of the KNX value should be used. Default is 1.
- **reset_after** (Optional): Reset back to OFF state after specified milliseconds.
- **device_class** (*Optional*): HASS device class e.g., "motion".
- **significant_bit** (*Optional*): Specify which significant bit of the KNX value should be used. Default is 1.
- **reset_after** (*Optional*): Reset back to OFF state after specified milliseconds.
You can also attach actions to binary sensors (e.g., to switch on a light when a switch was pressed). In this example, one light is switched on when the button was pressed once and two others when the button was pressed a second time.

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

@ -15,6 +15,8 @@ ha_iot_class: "Cloud Polling"
The `linode` binary sensor platform allows you to monitor your Linode nodes.
## {% linkable_title Configuration %}
Add the following to your `configuration.yaml` file:
```yaml

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

@ -8,12 +8,12 @@ comments: false
sharing: true
footer: true
logo: mercedesme.png
ha_category: Binary Sensor
ha_category: Car
ha_iot_class: "Cloud polling"
ha_release: 0.63
---
The `Mercedes me` 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.
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.

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

@ -1,6 +1,6 @@
---
layout: page
title: "MyChevy Binary Sensors"
title: "MyChevy Binary Sensor"
description: "Instructions on how to integrate Chevy Bolt binary sensors car into Home Assistant."
date: 2017-08-28 17:00
sidebar: true
@ -8,9 +8,14 @@ comments: false
sharing: true
footer: true
logo: chevy.png
ha_category: Binary Sensor
ha_category: Car
ha_release: 0.62
ha_iot_class: "Cloud Polling"
---
For configuration instructions, see [main component config](/components/mychevy/).
The `mychevy` binary sensor platform allows you to monitor your Chevy Bolt car from within Home Assistant.
The binary sensor platform will be automatically configured if the `mychevy` component is configured.
For configuration instructions, see the [`mychevy` component](/components/mychevy/) documentation.

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

@ -8,7 +8,7 @@ comments: false
sharing: true
footer: true
logo: mysensors.png
ha_category: Binary Sensor
ha_category: DIY
ha_release: 0.14
ha_iot_class: "Local Push"
---

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

@ -8,16 +8,12 @@ comments: false
sharing: true
footer: true
logo: openuv.jpg
ha_category: Binary Sensor
ha_category: Health
ha_release: 0.76
ha_iot_class: "Cloud Polling"
---
The `openuv` binary sensor platform allows you to view binary sensor data from
[OpenUV](http://openuv.io).
The `openuv` binary sensor platform allows you to view binary sensor data from [OpenUV](http://openuv.io).
You must have the [`openuv` component](/components/openuv/) configured to use this platform. After configuring that component, binary sensors will automatically appear.
<p class='note'>
You must have the [OpenUV component](/components/openuv/) configured to use
this platform. After configuring that component, binary sensors will
automatically appear.
</p>

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

@ -8,14 +8,14 @@ comments: false
sharing: true
footer: true
logo: pilight.png
ha_category: Binary Sensor
ha_category: DIY
ha_release: 0.44
ha_iot_class: "Local Polling"
---
The `pilight` binary sensor platform implement the [pilight hub](/components/pilight/) binary sensor functionality. Two type of Pilight binary sensor configuration available. A normal sensor which send the on and off state cyclical and a trigger sensor which send only a trigger when an event happened (for example lots of cheap PIR motion detector).
## {% linkable_title Configuration %}
To enable a Pilight binary sensor in your installation, add the following to your `configuration.yaml` file:

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

@ -8,13 +8,15 @@ comments: false
sharing: true
footer: true
logo: home-assistant.png
ha_category: Binary Sensor
ha_category: Network
ha_release: 0.43
---
The `ping` binary sensor platform allows you to using `ping` to send ICMP echo requests. This way you can check if a given host is online and determine the round trip times from your Home Assistant instance to that system.
## {% linkable_title Configuration %}
To use this sensor in your installation, add the following to your `configuration.yaml` file:
```yaml

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

@ -8,7 +8,7 @@ comments: false
sharing: true
footer: true
logo: rachio.png
ha_category: Hub
ha_category: Irrigation
ha_iot_class: "Cloud Push"
ha_release: 0.73
---
@ -18,9 +18,10 @@ The `rachio` binary sensor platform allows you to view the status of your [Rachi
Once configured, a binary sensor will be added that shows whether or not each controller in the account provided is online and reachable by Rachio's servers.
<p class='note'>
You must have the [Rachio component](/components/rachio/) configured to use this switch.
You must have the [Rachio component](/components/rachio/) configured to use this switch.
</p>
## {% linkable_title Configuration %}
To add this platform to your installation, add the following to your `configuration.yaml` file:

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

@ -8,13 +8,15 @@ comments: false
sharing: true
footer: true
logo: raincloud.jpg
ha_category: Binary Sensor
ha_category: Irrigation
ha_release: "0.55"
ha_iot_class: "Cloud Polling"
---
To get your [Melnor RainCloud](https://wifiaquatimer.com) binary sensors working within Home Assistant, please follow the instructions for the general [Raincloud component](/components/raincloud).
## {% linkable_title Configuration %}
Once you have enabled the [Raincloud component](/components/raincloud), add the following to your `configuration.yaml` file:
```yaml

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

@ -8,7 +8,7 @@ comments: false
sharing: true
footer: true
logo: rainmachine.png
ha_category: Binary Sensor
ha_category: Irrigation
ha_iot_class: "Cloud Polling"
ha_release: 0.71
---

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

@ -8,7 +8,7 @@ comments: false
sharing: true
footer: true
logo: home-assistant.png
ha_category: Sensor
ha_category: Utility
ha_iot_class: "Local Polling"
ha_release: 0.57
---
@ -18,7 +18,7 @@ The `random` binary sensor platform is creating random states (`True`, 1, `on` o
## {% linkable_title Configuration %}
To enable the random binary sensor, add the following lines to your `configuration.yaml`:
To enable the random binary sensor, add the following lines to your `configuration.yaml` file:
```yaml
# Example configuration.yaml entry

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

@ -8,13 +8,15 @@ comments: false
sharing: true
footer: true
logo: raspihats.png
ha_category: Binary Sensor
ha_category: DIY
ha_release: 0.44
ha_iot_class: "Local Push"
---
The `raspihats` binary sensor platform allows you to read sensor values ​​using the digital inputs of the [raspihats](http://www.raspihats.com/) boards.
## {% linkable_title Configuration %}
To use your `raspihats` boards in your installation, add the following to your `configuration.yaml` file:
```yaml

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

@ -8,13 +8,15 @@ comments: false
sharing: true
footer: true
logo: ring.png
ha_category: Binary Sensor
ha_category: Doorbell
ha_release: 0.42
ha_iot_class: "Cloud Polling"
---
To get your [Ring.com](https://ring.com/) binary sensors working within Home Assistant, please follow the instructions for the general [Ring component](/components/ring).
## {% linkable_title Configuration %}
Once you have enabled the [Ring component](/components/ring), add the following to your `configuration.yaml` file:
```yaml

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

@ -8,13 +8,15 @@ comments: false
sharing: true
footer: true
logo: raspberry-pi.png
ha_category: Binary Sensor
ha_category: DIY
ha_release: pre 0.7
ha_iot_class: "Local Push"
---
The `rpi_gpio` binary sensor platform allows you to read sensor values of the GPIOs of your [Raspberry Pi](https://www.raspberrypi.org/).
## {% linkable_title Configuration %}
To use your Raspberry Pi's GPIO in your installation, add the following to your `configuration.yaml` file:
```yaml

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

@ -8,13 +8,15 @@ comments: false
sharing: true
footer: true
logo: raspberry-pi.png
ha_category: Binary Sensor
ha_category: DIY
ha_release: 0.45
ha_iot_class: "Local Push"
---
The `rpi_pfio` binary sensor platform allows you to read sensor values of the [PiFace Digital I/O](http://www.piface.org.uk/products/piface_digital/) .
## {% linkable_title Configuration %}
To use your PiFace Digital I/O module in your installation, add the following to your `configuration.yaml` file:
```yaml

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

@ -8,13 +8,15 @@ comments: false
sharing: true
footer: true
logo: skybell.png
ha_category: Binary Sensor
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

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

@ -8,7 +8,7 @@ comments: false
sharing: true
footer: true
logo: sleepiq.png
ha_category: Binary Sensor
ha_category: Health
ha_release: 0.29
ha_iot_class: "Local Polling"
---

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

@ -8,12 +8,12 @@ comments: false
sharing: true
footer: true
logo: tesla.png
ha_category: Binary Sensor
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.
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.

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

@ -8,7 +8,7 @@ comments: false
sharing: true
footer: true
logo: home-assistant.png
ha_category: Binary Sensor
ha_category: Utility
ha_iot_class: "Local Polling"
ha_release: 0.34
---
@ -26,6 +26,8 @@ It's an alternative to the template binary sensor's `value_template:` to get the
```
{% endraw %}
## {% linkable_title Configuration %}
To enable the threshold sensor, add the following lines to your `configuration.yaml`:
```yaml

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

@ -7,7 +7,7 @@ sidebar: true
comments: false
sharing: true
footer: true
ha_category: Binary Sensor
ha_category: Utility
logo: home-assistant.png
ha_release: 0.28
ha_iot_class: "Local Push"
@ -15,6 +15,8 @@ ha_iot_class: "Local Push"
The `trend` platform allows you to create sensors which show the trend of numeric `state` or`state_attributes` from other entities. This sensor requires at least two updates of the underlying sensor to establish a trend. Thus it can take some time to show an accurate state. It can be useful as part of automations, where you want to base an action on a trend.
## {% linkable_title Configuration %}
To enable Trend binary sensors in your installation, add the following to your `configuration.yaml` file:
```yaml

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

@ -15,6 +15,8 @@ ha_iot_class: Cloud Polling
The `upcloud` binary sensor platform allows you to monitor your UpCloud servers.
## {% linkable_title Configuration %}
To use your UpCloud servers, you first have to set up your [UpCloud hub](/components/upcloud/) and then add the following to your `configuration.yaml` file:
```yaml

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

@ -8,19 +8,22 @@ comments: false
sharing: true
footer: true
logo: uptimerobot.png
ha_category: Binary Sensor
ha_category: System Monitor
ha_release: "0.72"
ha_iot_class: "Cloud Polling"
---
The `uptimerobot` binary_sensor platform allows you get the status for all of your monitors from your account on [Uptime Robot.]( https://uptimerobot.com)
The `uptimerobot` binary sensor platform allows you get the status for all of your monitors from your account on [Uptime Robot.]( https://uptimerobot.com).
## Example for `configuration.yaml` :
## {% linkable_title Configuration %}
To enable the sensor, add the following lines to your `configuration.yaml`:
```yaml
# Example configuration.yaml entry
binary_sensor:
- platform: uptimerobot
api_key: u432898-d2507e493b31217e6c64fd35
api_key: YOUR_API_KEY
```
{% configuration %}

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

@ -1,6 +1,6 @@
---
layout: page
title: "Belkin WeMo Binary Sensors"
title: "Belkin WeMo Binary Sensor"
description: "Instructions on how to integrate Belkin WeMo binary sensors into Home Assistant."
date: 2016-02-20 00:45
sidebar: true

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

@ -8,7 +8,7 @@ comments: false
sharing: true
footer: true
logo: home-assistant.png
ha_category: Binary Sensor
ha_category: Utility
ha_iot_class: "Local Polling"
ha_release: 0.41
---

15
source/_components/bloomsky.markdown
View File

@ -8,15 +8,19 @@ comments: false
sharing: true
footer: true
logo: bloomsky.png
ha_category: Hub
ha_category: Environment
ha_release: 0.14
ha_iot_class: "Cloud Polling"
---
The `bloomsky` component allows you to access your [BloomSky](https://www.bloomsky.com/) weather station's [sensors](/components/sensor.bloomsky), [binary sensors](/components/binary_sensor.bloomsky), and [camera](/components/camera.bloomsky) from Home Assistant.
## {% linkable_title Setup %}
Obtain your API key from your [BloomSky dashboard](https://dashboard.bloomsky.com). Click `developers` in the bottom left of the screen.
## {% linkable_title Configuration %}
To integrate your BloomSky hub with Home Assistant, add the following section to your `configuration.yaml` file:
```yaml
@ -25,6 +29,9 @@ bloomsky:
api_key: YOUR_API_KEY
```
Configuration variables:
- **api_key** (*Required*): Your BloomSky API key.
{% configuration %}
api_key:
description: Your BloomSky API key.
required: true
type: string
{% endconfiguration %}

4
source/_components/bmw_connected_drive.markdown
View File

@ -8,11 +8,11 @@ comments: false
sharing: true
footer: true
logo: bmw.png
ha_category: Hub
ha_category: Car
ha_release: 0.64
---
This component lets you retrieve data on 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.
The `bmw_connected_drive` component lets you retrieve data on 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.
For compatibility with your BMW vehicle check the [bimmer_connected page](https://github.com/m1n3rva/bimmer_connected) on github.

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

@ -16,6 +16,8 @@ ha_iot_class: "Local Polling"
The `bloomsky` camera component allows you to view the current photo created by the camera in the [BloomSky](https://www.bloomsky.com) weather station. This can work in concert with [BloomSky sensors](/components/sensor.bloomsky).
## {% linkable_title Configuration %}
To enable this camera in your installation, set up the [BloomSky component](/components/bloomsky) with your API key and add the following to your `configuration.yaml` file:
```yaml

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

@ -15,6 +15,8 @@ ha_iot_class: "Cloud Polling"
To get your [Ring.com](https://ring.com/) cameras working within Home Assistant, please follow the instructions for the general [Ring component](/components/ring). Please note that downloading and playing Ring video will require a Ring Protect plan.
## {% linkable_title Configuration %}
Once you have enabled the [Ring component](/components/ring), add the following to your `configuration.yaml` file:
```yaml

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

@ -8,7 +8,7 @@ comments: false
sharing: true
footer: true
logo: raspberry-pi.png
ha_category: Camera
ha_category: DIY
ha_iot_class: "Local Polling"
ha_release: 0.17
---
@ -16,6 +16,8 @@ ha_release: 0.17
The `rpi_camera` platform allows you to integrate the Raspberry Pi camera into Home Assistant. This component uses the application [`raspistill`](https://www.raspberrypi.org/documentation/usage/camera/raspicam/raspistill.md) to store the image from camera.
## {% linkable_title Configuration %}
To enable this camera in your installation, add the following to your `configuration.yaml` file:
```yaml

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

@ -15,6 +15,8 @@ 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

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

@ -31,7 +31,7 @@ In order to integrate the camera with Home Assistant, it is necessary to install
Once installed, please ensure that you have enabled FTP and Telnet on your device.
<p class='note warning'>
Currently, version 0.1.4-beta2 of the custom firmware is the highest supported. Firmwares higher than this version use [Pure-FTPd](https://www.pureftpd.org/project/pure-ftpd), which has a bug that prevents FFmpeg from correctly rendering video files.
Currently, version 0.1.4-beta2 of the custom firmware is the highest supported without having to make additional modifications. Firmwares higher than this version use [Pure-FTPd](https://www.pureftpd.org/project/pure-ftpd), which has a bug that prevents FFmpeg from correctly rendering video files. To use higher firmware versions you must also follow [this workaround](https://github.com/shadow-1/yi-hack-v3/issues/129#issuecomment-361723075) to revert back to ftpd.
</p>
<p class='note warning'>

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

@ -23,11 +23,7 @@ The `daikin` climate platform integrates Daikin air conditioning systems into Ho
Current temperature is displayed.
<p class='note warning'>
Please note, the `daikin` platform integrates **ONLY the european versions of Daikin ACs (models BRP069A41, 42, 43, 45)** into Home Assistant. BRP069A42 does not support setting of fan speed or fan swing mode.
</p>
The platform has been integrated with discovery so all your Daikin AC's climate devices can be automatically discovered.
## {% linkable_title Configuration %}
To enable the platform, add the following lines to your `configuration.yaml` file:

2
source/_components/climate.melissa.markdown
View File

@ -13,7 +13,7 @@ ha_iot_class: "Cloud Polling"
ha_release: 0.63
---
The `Melissa` climate platform allows you to control your [Melissa Climate](http://seemelissa.com/) from within Home Assistant.
The `melissa` climate platform allows you to control your [Melissa Climate](http://seemelissa.com/) from within Home Assistant.
The climate platform will be automatically configured if Melissa component is configured.

2
source/_components/climate.mysensors.markdown
View File

@ -8,7 +8,7 @@ comments: false
sharing: true
footer: true
logo: mysensors.png
ha_category: Climate
ha_category: DIY
ha_release: 0.29
ha_iot_class: "Local Push"
---

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

@ -8,12 +8,12 @@ comments: false
sharing: true
footer: true
logo: tesla.png
ha_category: Climate
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 `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.

2
source/_components/cloudflare.markdown
View File

@ -8,7 +8,7 @@ comments: false
sharing: true
footer: true
logo: cloudflare.png
ha_category: Utility
ha_category: Network
featured: false
ha_release: 0.74
---

5
source/_components/coinbase.markdown
View File

@ -1,6 +1,6 @@
---
layout: page
title: "coinbase"
title: "Coinbase"
description: "Instructions for how to add Coinbase sensors to Home Assistant."
date: 2017-12-08 17:54
sidebar: true
@ -8,6 +8,7 @@ comments: false
sharing: true
footer: true
logo: coinbase.png
ha_category: Finance
ha_release: 0.61
ha_iot_class: "Cloud Polling"
---
@ -17,6 +18,8 @@ The `coinbase` component lets you access account balances and exchange rates fro
You will need to obtain an API key from coinbase's [developer site](https://www.coinbase.com/settings/api) to use this component. You need to give read access to `wallet:accounts` in order for the component to access relevant data.
## {% linkable_title Configuration %}
To set it up, add the following information to your `configuration.yaml` file:
```yaml

8
source/_components/counter.markdown
View File

@ -44,7 +44,7 @@ Increments the counter with 1 or the given value for the steps.
| Service data attribute | Optional | Description |
| ---------------------- | -------- | ----------- |
| `entity_id` | no | Name of the entity to take action, e.g., `counter.count0`. |
| `entity_id` | no | Name of the entity to take action, e.g., `counter.my_custom_counter`. |
#### {% linkable_title Service `counter.decrement` %}
@ -52,7 +52,7 @@ Decrements the counter with 1 or the given value for the steps.
| Service data attribute | Optional | Description |
| ---------------------- | -------- | ----------- |
| `entity_id` | no | Name of the entity to take action, e.g., `counter.count0`. |
| `entity_id` | no | Name of the entity to take action, e.g., `counter.my_custom_counter`. |
#### {% linkable_title Service `counter.reset` %}
@ -60,7 +60,7 @@ With this service the counter is reset to its initial value.
| Service data attribute | Optional | Description |
| ---------------------- | -------- | ----------- |
| `entity_id` | no | Name of the entity to take action, e.g., `counter.count0`. |
| `entity_id` | no | Name of the entity to take action, e.g., `counter.my_custom_counter`. |
### {% linkable_title Use the service %}
@ -69,7 +69,7 @@ Select <img src='/images/screenshots/developer-tool-services-icon.png' alt='serv
```json
{
"entity_id": "counter.count0"
"entity_id": "counter.my_custom_counter"
}
```

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

@ -0,0 +1,22 @@
---
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/

0
source/_components/cover.mqtt.markdown Executable file → Normal file
View File

2
source/_components/cover.mysensors.markdown
View File

@ -8,7 +8,7 @@ comments: false
sharing: true
footer: true
logo: mysensors.png
ha_category: Cover
ha_category: DIY
ha_release: "0.30"
ha_iot_class: "Local Push"
---

7
source/_components/cover.opengarage.markdown
View File

@ -8,12 +8,14 @@ comments: false
sharing: true
footer: true
logo: opengarage.png
ha_category: Cover
ha_category: DIY
ha_release: 0.44
---
The `opengarage` cover platform lets you control the open-source [OpenGarage.io](https://opengarage.io/) device through Home Assistant.
## {% linkable_title Configuration %}
To enable OpenGarage Covers in your installation, add the following to your `configuration.yaml` file:
```yaml
@ -87,7 +89,7 @@ sensor:
{% endif %}
{% else %}
n/a
{% endif %}'{% endraw %}
{% endif %}'
group:
garage:
@ -104,3 +106,4 @@ customize:
sensor.garage_car_present:
icon: mdi:car
```
{% endraw %}

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

@ -8,7 +8,7 @@ comments: false
sharing: true
footer: true
logo: raspberry-pi.png
ha_category: Cover
ha_category: DIY
ha_release: 0.23
ha_iot_class: "Local Push"
---
@ -22,6 +22,8 @@ It uses two pins on the Raspberry Pi.
Although you do not need Andrews Hilliday's software controller when you run Home Assistant, he has written clear instructions on how to hook your garage door and sensors up to your Raspberry Pi, which can be found [here](https://github.com/andrewshilliday/garage-door-controller#hardware-setup).
## {% linkable_title Configuration %}
To enable Raspberry Pi Covers in your installation, add the following to your `configuration.yaml` file:
```yaml

6
source/_components/cover.template.markdown
View File

@ -13,9 +13,9 @@ ha_iot_class: "Local Push"
logo: home-assistant.png
---
The `template` platform can create covers that combine components and provides
the ability to run scripts or invoke services for each of the open, close,
stop, position, and tilt commands of a cover.
The `template` platform can create covers that combine components and provides the ability to run scripts or invoke services for each of the open, close, stop, position and tilt commands of a cover.
## {% linkable_title Configuration %}
To enable Template Covers in your installation, add the following to your
`configuration.yaml` file:

18
source/_components/daikin.markdown
View File

@ -8,7 +8,7 @@ comments: false
sharing: true
footer: true
logo: daikin.png
ha_category: Hub
ha_category: Climate
ha_release: 0.59
ha_iot_class: "Local Polling"
---
@ -16,11 +16,15 @@ ha_iot_class: "Local Polling"
The `daikin` component integrates Daikin air conditioning systems into Home Assistant.
To automatically add all your Daikin devices (ACs and associated sensors) into your Home Assistant installation, add the following to your 'configuration.yaml' file:
## {% linkable_title Supported hardware %}
<p class='note warning'>
Please note, the Daikin platform integrates **ONLY the european versions of Daikin ACs (models BRP069A41, 42, 43, 45)** into Home Assistant.
</p>
**Only** the european versions of Daikin ACs (models BRP069A41, 42, 43, 45).
The model BRP069A42 does not support setting of fan speed or fan swing mode.
Please note that some AC devices may report outside temperature only when they are turned on.
## {% linkable_title Configuration %}
To automatically add all your Daikin devices (ACs and associated sensors) into your Home Assistant installation, add the following to your `configuration.yaml` file:
@ -52,7 +56,3 @@ monitored_conditions:
description: The current temperature measured outside the house.
{% endconfiguration %}
<p class='note warning'>
Please note that some AC devices may report outside temperature only when they are turned on.
</p>

64
source/_components/deconz.markdown
View File

@ -31,7 +31,7 @@ Home Assistant will automatically discover deCONZ presence on your network, if `
If you don't have the API key, you can generate an API key for deCONZ by using the one-click functionality similar to Philips Hue. Go to **Menu** -> **Settings** -> **Unlock Gateway** in deCONZ and then use the deCONZ configurator in Home Assistant frontend to create an API key. When you're done setting up deCONZ it will be stored as a config entry.
You can add the following to your configuration.yaml file if you are not using the `discovery:` component:
You can add the following to your `configuration.yaml` file if you are not using the `discovery:` component:
```yaml
# Example configuration.yaml entry
@ -118,9 +118,9 @@ For the IKEA Tradfri remote, 1 is the middle button, 2 is up, 3 is down, 4 is le
## {% linkable_title Examples %}
### {% linkable_title Step up and step down input number with wireless dimmer %}
### {% linkable_title YAML %}
#### YAML
#### {% linkable_title Step up and step down input number with wireless dimmer %}
{% raw %}
```yaml
@ -171,15 +171,17 @@ automation:
```
{% endraw %}
#### Appdaemon
### {% linkable_title Appdaemon %}
#### {% linkable_title Appdaemon remote template %}
{% raw %}
```yaml
remote_control_living_room:
remote_control:
module: remote_control
class: RemoteControl
event: deconz_event
id: dimmer_switch_3
id: dimmer_switch_1
```
```python
@ -204,3 +206,53 @@ class RemoteControl(hass.Hass):
self.log('Button off')
```
{% endraw %}
#### {% linkable_title Appdaemon remote template %}
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
class: SonosRemote
event: deconz_event
id: sonos_remote
sonos: media_player.sonos
```
{% endraw %}
{% raw %}
```python
import appdaemon.plugins.hass.hassapi as hass
class SonosRemote(hass.Hass):
def initialize(self):
self.sonos = self.args['sonos']
if 'event' in self.args:
self.listen_event(self.handle_event, self.args['event'])
def handle_event(self, event_name, data, kwargs):
if data['id'] == self.args['id']:
if data['event'] == 1002:
self.log('Button toggle')
self.call_service("media_player/media_play_pause", entity_id = self.sonos)
elif data['event'] == 2002:
self.log('Button volume up')
self.call_service("media_player/volume_up", entity_id = self.sonos)
elif data['event'] == 3002:
self.log('Button volume down')
self.call_service("media_player/volume_down", entity_id = self.sonos)
elif data['event'] == 4002:
self.log('Button previous')
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 %}

8
source/_components/device_tracker.automatic.markdown
View File

@ -8,18 +8,22 @@ comments: false
sharing: true
footer: true
logo: automatic.png
ha_category: Presence Detection
ha_category: Car
ha_release: 0.28
ha_iot_class: "Cloud Push"
---
The `automatic` platform offers presence detection by retrieving your car's information from the [Automatic](http://automatic.com/) cloud service.
The `automatic` device tracker platform offers presence detection by retrieving your car's information from the [Automatic](http://automatic.com/) cloud service.
## {% linkable_title Setup %}
To use Automatic with Home Assistant, first you must [create a free development account](https://developer.automatic.com/). Automatic will generate a Client ID and Secret for you to use in your Home Assistant configuration. You will need to update your Event Delivery preferences to ensure Home Assistant can receive updates. On the developer page, under App Settings / Event Delivery, select "Websocket" for Event Delivery Preference. Next, specify the OAuth Redirect URL in the developer page. This should be configured to `<home-assistant-url>/api/automatic/callback`. (Example: `http://hassio.local:8123/api/automatic/callback`) Note that this URL only needs to be accessible from the browser you use to perform the authentication.
Home Assistant can also take advantage of `scope:current_location` if available. This will allow Home Assistant to receive periodic location updates during a trip. In order to use this functionality, you must request the scope for your application from Automatic. Once `scope:current_location` is available, change `current_location` to `true` in your configuration.yaml.
## {% linkable_title Configuration %}
Once your developer account is created, add the following to your `configuration.yaml` file:
```yaml

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

@ -8,12 +8,12 @@ comments: false
sharing: true
footer: true
logo: bmw.png
ha_category: Presence Detection
ha_category: Car
ha_release: 0.64
---
The `bmw_connected_drive` platform allows you to import data on your BMW into Home Assistant.
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.

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

@ -8,11 +8,11 @@ comments: false
sharing: true
footer: true
logo: mercedesme.png
ha_category: Presence Detection
ha_category: Car
ha_release: 0.63
---
The `Mercedes me` 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 `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.

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

@ -8,8 +8,7 @@ comments: false
sharing: true
footer: true
logo: mysensors.png
ha_category: Presence Detection
featured: false
ha_category: DIY
ha_release: "0.38"
ha_iot_class: "Local Push"
---

6
source/_components/device_tracker.ping.markdown
View File

@ -8,12 +8,14 @@ comments: false
sharing: true
footer: true
logo: home-assistant.png
ha_category: Presence Detection
ha_category: Network
ha_release: 0.36
---
The `ping` platform offers presence detection by using `ping` to send ICMP echo requests. This can be useful when devices are running a firewall and are blocking UDP or TCP packets but responding to ICMP requests (like Android phones). This tracker doesn't need to know the MAC address since the host can be on a different subnet. This makes this an option to detect hosts on a different subnet when `nmap` or other solutions don't work since `arp` doesn't work.
The `ping` device tracker platform offers presence detection by using `ping` to send ICMP echo requests. This can be useful when devices are running a firewall and are blocking UDP or TCP packets but responding to ICMP requests (like Android phones). This tracker doesn't need to know the MAC address since the host can be on a different subnet. This makes this an option to detect hosts on a different subnet when `nmap` or other solutions don't work since `arp` doesn't work.
## {% linkable_title Configuration %}
To use this presence detection in your installation, add the following to your `configuration.yaml` file:

17
source/_components/device_tracker.ritassist.markdown
View File

@ -8,17 +8,19 @@ comments: false
sharing: true
footer: true
logo: ritassist.png
ha_category: Presence Detection
ha_category: Car
ha_iot_class: Cloud Polling
ha_release: 0.76
---
This platform allows you to integrate your vehicles equipped with [RitAssist](https://ritassist.nl/) or [FleetGO](https://fleetgo.com) hardware into Home Assistant. It allows you to see certain details about your vehicle, but also shows your vehicle on the map.
The `ritassist` device tracker platform allows you to integrate your vehicles equipped with [RitAssist](https://ritassist.nl/) or [FleetGO](https://fleetgo.com) hardware into Home Assistant. It allows you to see certain details about your vehicle, but also shows your vehicle on the map.
## {% linkable_title Setup %}
## API key
To use this component, you need an **API key** and **API secret**, which can be requested by contacting [info@fleetgo.com](mailto:info@fleetgo.com?subject=API%20Key).
## Configuration
## {% linkable_title Configuration %}
To use this device tracker in your installation, add the following to your `configuration.yaml` file:
```yaml
@ -58,7 +60,7 @@ include:
See the [device tracker component page](/components/device_tracker/) for instructions on how to configure the people to be tracked.
## Available Attributes
## {% linkable_title Available attributes %}
| Attribute | Description |
|---|---|
@ -78,5 +80,8 @@ See the [device tracker component page](/components/device_tracker/) for instruc
| coolant_temperature | Temperature of the coolant [1] |
| power_voltage | Power voltage measured by the hardware [1] |
| distance_from_home | How far is your vehicle located from your Home Assistant Home location |
| current_max_speed | The maximum speed on the road the device is currently on (if available) |
| current_address | Object with address information the device is currently on. This resolves to the closest address to the coordinates of the device. |
[1] Only available on certain cars and hardware revisions.
[1] Only available on certain cars and hardware revisions.

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

@ -8,11 +8,11 @@ comments: false
sharing: true
footer: true
logo: tesla.png
ha_category: Presence Detection
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 `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.

2
source/_components/device_tracker.volvooncall.markdown
View File

@ -8,7 +8,7 @@ comments: false
sharing: true
footer: true
logo: volvo.png
ha_category: Presence Detection
ha_category: Car
ha_release: "0.30"
---

6
source/_components/digital_ocean.markdown
View File

@ -7,7 +7,7 @@ sidebar: true
comments: false
sharing: true
footer: true
ha_category: Hub
ha_category: System Monitor
ha_release: "0.30"
logo: digital_ocean.png
ha_iot_class: "Local Polling"
@ -16,8 +16,12 @@ ha_iot_class: "Local Polling"
The `digital_ocean` component allows you to access the information about your [Digital Ocean](https://www.digitalocean.com/) droplets from Home Assistant.
## {% linkable_title Setup %}
Obtain your API key from your [Digital Ocean dashboard](https://cloud.digitalocean.com/settings/api/tokens).
## {% linkable_title Configuration %}
To integrate your Digital Ocean droplets with Home Assistant, add the following section to your `configuration.yaml` file:
```yaml

6
source/_components/doorbird.markdown
View File

@ -8,13 +8,15 @@ comments: false
sharing: true
footer: true
logo: doorbird.png
ha_category: Hub
ha_category: Doorbell
ha_release: "0.54"
ha_iot_class: "Local Polling"
---
The `doorbird` implementation allows you to integrate your [DoorBird](http://www.doorbird.com/) device in Home Assistant.
## {% linkable_title Configuration %}
To connect your device, add the following to your `configuration.yaml` file:
```yaml
@ -94,4 +96,4 @@ Enabling any monitored condition will delete all registered notification service
action:
service: light.turn_on
entity_id: light.side_entry_porch
```
```

4
source/_components/duckdns.markdown
View File

@ -8,13 +8,15 @@ comments: false
sharing: true
footer: true
logo: duckdns.png
ha_category: Utility
ha_category: Network
featured: false
ha_release: 0.55
---
With the DuckDNS component you can keep your DuckDNS record up to date. DuckDNS is a free dynamic DNS service that allows you to point a subdomain under `duckdns.org` at your computer.
## {% linkable_title Configuration %}
To use the component in your installation, add the following to your `configuration.yaml` file:
```yaml

4
source/_components/eight_sleep.markdown
View File

@ -8,7 +8,7 @@ comments: false
sharing: true
footer: true
logo: eight_sleep.png
ha_category: Hub
ha_category: Health
ha_release: "0.44"
ha_iot_class: "Cloud Polling"
---
@ -17,7 +17,7 @@ The `eight_sleep` component allows Home Assistant to fetch data from your [Eight
## {% linkable_title Configuration %}
It's setup utilizing 'Sensor' components to convey the current state of your bed and results of your sleep sessions and a 'Binary Sensor' component to indicate your presence in the bed. A service is also provided to set the heating level and duration of the bed.
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.
You must have at least two sleep sessions recorded in the Eight Sleep app prior to setting up the Home Assistant component.

18
source/_components/eufy.markdown
View File

@ -38,17 +38,21 @@ eufy:
name: Smart Switch
```
access_token can be obtained by running:
`access_token can be obtained by running:
```
curl -H "Content-Type: application/json" -d '{"client_id":"eufyhome-app", "client_Secret":"GQCpr9dSp3uQpsOMgJ4xQ", "email":"USERNAME", "password":"PASSWORD"}' https://home-api.eufylife.com/v1/user/email/login | jq
```bash
$ curl -H "Content-Type: application/json" \
-d '{"client_id":"eufyhome-app", "client_Secret":"GQCpr9dSp3uQpsOMgJ4xQ", "email":"USERNAME", "password":"PASSWORD"}' \
https://home-api.eufylife.com/v1/user/email/login \
| jq
```
replacing USERNAME and PASSWORD with the Eufy username and password. This will give an access_token. Then run:
replacing USERNAME and PASSWORD with the Eufy username and password. This will give an `access_token`. Then run:
```
curl -H token:TOKEN -H category:Home https://home-api.eufylife.com/v1/device/list/devices-and-groups | jq
```bash
$ curl -H token:TOKEN -H category:Home \
https://home-api.eufylife.com/v1/device/list/devices-and-groups | jq
```
replacing TOKEN with the access_token from the previous command. This will provide the local_code for each device.
replacing TOKEN with the `access_token` from the previous command. This will provide the local_code for each device.

4
source/_components/ffmpeg.markdown
View File

@ -8,7 +8,7 @@ comments: false
sharing: true
footer: true
logo: ffmpeg.png
ha_category: Hub
ha_category: Image Processing
---
The `ffmpeg` component allows other Home Assistant components to process video and audio streams. This component supports all FFmpeg versions since 3.0.0; if you have an older version, please update.
@ -21,6 +21,8 @@ You need the `ffmpeg` binary in your system path. On Debian 8 or Raspbian (Jessi
If you are using [Hass.io](/hassio/) then just move forward to the configuration as all requirements are already fulfilled.
</p>
## {% linkable_title Configuration %}
To set it up, add the following information to your `configuration.yaml` file:
```yaml

2
source/_components/folder_watcher.markdown
View File

@ -22,6 +22,8 @@ This component adds [Watchdog](https://pythonhosted.org/watchdog/) file system m
Configured folders must be added to [whitelist_external_dirs](/docs/configuration/basic/). Note that by default folder monitoring is recursive, meaning that the contents of sub-folders are also monitored.
## {% linkable_title Configuration %}
To enable the Folder Watcher component in your installation, add the following to your `configuration.yaml` file:
{% raw %}

6
source/_components/freedns.markdown
View File

@ -7,13 +7,13 @@ sidebar: true
comments: false
sharing: true
footer: true
ha_category: Utility
ha_category: Network
ha_release: 0.67
---
With the `freedns` component you can keep your [FreeDNS](https://freedns.afraid.org) record up to date.
## {% linkable_title Configuration %}
## {% linkable_title Setup %}
You need to determine your update URL or your access token.
@ -24,6 +24,8 @@ You need to determine your update URL or your access token.
5. The access token is the part at the end of the link: `https://freedns.afraid.org/dynamic/update.php?YOUR_UPDATE_TOKEN`
6. Either put the token as `access_token` _or_ the whole URL into the `url` attribute.
## {% linkable_title Configuration %}
To use the component in your installation, add the following to your `configuration.yaml` file:
```yaml

8
source/_components/frontend.markdown
View File

@ -112,10 +112,10 @@ automation:
### {% linkable_title Manual Theme Selection %}
When themes are enabled in the `configuration.yaml` file, a new option will show up in the Configuration panel under **General** called "Set a theme." You can then choose any installed theme from the dropdown list and it will be applied immediately.
When themes are enabled in the `configuration.yaml` file, a new option will show up in the user profile menu (before 0.77 it was in the Configuration panel under **General** called "Set a theme"). You can then choose any installed theme from the dropdown list and it will be applied immediately.
<p class='img'>
<img src='/images/frontend/choose-theme.png' />
<img src='/images/frontend/user-theme.png' />
Set a theme
</p>
@ -137,9 +137,9 @@ Those will be loaded via `<link rel='import' href='{{ extra_url }}' async>` on a
### {% linkable_title Manual Language Selection %}
The browser language is automatically detected. To use a different language, go to **General** in the Configuration panel and select one from "Choose a Language". It will be applied immediately.
The browser language is automatically detected. To use a different language, go to the user profile menu (before 0.77 it was found in **General** in the Configuration panel) and select one. It will be applied immediately.
<p class='img'>
<img src='/images/frontend/choose-language.png' />
<img src='/images/frontend/user-language.png' />
Choose a Language
</p>

4
source/_components/google_domains.markdown
View File

@ -8,12 +8,14 @@ comments: false
sharing: true
footer: true
logo: google_domains.png
ha_category: Utility
ha_category: Network
ha_release: 0.57
---
With the Google Domains component you can keep your Google Domains record up to date.
## {% linkable_title Configuration %}
To use the component in your installation, add the following to your `configuration.yaml` file:
```yaml

14
source/_components/hangouts.markdown
View File

@ -12,21 +12,21 @@ ha_category: Hub
ha_release: 0.77
---
This component allows you to send messages to [Google Hangouts](http://hangouts.google.com) conversations, as well as to react to messages in conversations. Reacting to commands is accomplished by firing an event when one of the configured commands is triggered.
This component allows you to send messages to [Google Hangouts](https://hangouts.google.com) conversations, as well as to react to messages in conversations. Reacting to commands is accomplished by firing an event when one of the configured commands is triggered.
## {% linkable_title Setup the component via the frontend %}
Menu: *Configuration* -> *Integrations*
Fill the form:
* Your **Google Mail Address** and **Password**
* If needed, you will be asked for a 2-factor authorization token
Configure the integration:
* Enter your **Google Mail Address** and **Password**
* If you secured your account with 2-factor authentication you will be asked for a 2-factor authentication token.
**BEST PRACTICE:** You can't write messages to yourself or get notifications in a group, if "you" write the message. The best way is to create a own google account for your hangouts bot.
**BEST PRACTICE:** You can't write messages to yourself or get notifications in a group, if "you" write the message. The best way is to create a new Google Hangouts account for this integration.
**IMPORTANT:** If you secured your account with 2 factor authorization: Only verification by app or SMS are supported. There is no support for verification by prompt on your phone.
**IMPORTANT:** If you secured your account with 2-factor authentication: Only verification by app or SMS are supported. There is no support for verification by prompt on your phone.
**IMPORTANT 2:** If you are sure your email and password is correct, but the component says the login is invalid. Wait a few hours and try it again, it might be, that google asks for a captcha which we can't support. Google official don't support bots at hangouts, that's why we have to work around this.
**IMPORTANT 2:** If you are sure your email and password is correct, but the component says the login is invalid. Wait a few hours and try it again, it might be, that google asks for a captcha which we can't support. Google does not provide official support for using bots with Google Hangouts, that's why we have to work around this.
The authentication token will be generated and stored internally.

4
source/_components/hydrawise.markdown
View File

@ -8,13 +8,15 @@ comments: false
sharing: true
footer: true
logo: hydrawise_logo.png
ha_category: Hub
ha_category: Irrigation
ha_release: 0.71
ha_iot_class: Cloud Polling
---
The `hydrawise` component allows you to integrate your [Hunter Hydrawise](https://hydrawise.com) Wi-Fi irrigation controller system in Home Assistant.
## {% linkable_title Configuration %}
To enable it, add the following to your `configuration.yaml` file:
```yaml

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

@ -17,6 +17,8 @@ ha_release: 0.47
Some pre-defined classifiers can be found [here](https://github.com/opencv/opencv/tree/master/data).
## {% linkable_title Configuration %}
To setup OpenCV with Home Assistant, add the following section to your `configuration.yaml` file:
```yaml

3
source/_components/input_number.markdown
View File

@ -179,9 +179,8 @@ automation:
entity_id: input_number.target_temp
value: "{{ trigger.payload }}"
# This automation script runs when the target temperature slider is moved.
# This second automation script runs when the target temperature slider is moved.
# It publishes its value to the same MQTT topic it is also subscribed to.
automation:
- alias: Temp slider moved
trigger:
platform: state

4
source/_components/insteon_local.markdown
View File

@ -13,6 +13,6 @@ ha_iot_class: "Local Polling"
ha_version: 0.36
---
The `insteon_local` component is depreciated and has been replaced by the [Insteon] component.
The `insteon_local` component is depreciated and has been replaced by the [insteon] component.
[Insteon] /component/insteon
[insteon]: /component/insteon

5
source/_components/insteon_plm.markdown
View File

@ -13,7 +13,6 @@ ha_iot_class: "Local Push"
ha_version: 0.39
---
The `insteon_plm` component is depreciated and has been replaced by the [Insteon] component.
[Insteon] /component/insteon
The `insteon_plm` component is depreciated and has been replaced by the [insteon] component.
[insteon]: /component/insteon

2
source/_components/juicenet.markdown
View File

@ -8,7 +8,7 @@ comments: false
sharing: true
footer: true
logo: juicenet.png
ha_category: Hub
ha_category: Energy
ha_release: 0.47
---

23
source/_components/knx.markdown
View File

@ -33,7 +33,7 @@ There is currently support for the following device types within Home Assistant:
- [Notify](/components/notify.knx)
- [Scene](/components/scene.knx)
### {% linkable_title Configuration %}
## {% linkable_title Configuration %}
To use your KNX in your installation, add the following lines to your `configuration.yaml` file:
@ -77,8 +77,8 @@ knx:
```yaml
knx:
fire_event: True
fire_event_filter: ["1/0/*", "6/2,3,4-6/*"]
fire_event: True
fire_event_filter: ["1/0/*", "6/2,3,4-6/*"]
```
- **fire_event** (*Optional*): If set to True, platform will write all received KNX messages to event bus
@ -105,21 +105,20 @@ KNX component is able to expose time or sensor values to KNX bus. The component
```yaml
# Example configuration.yaml entry
knx:
expose::
- type: 'temperature'
entity_id: 'sensor.owm_temperature'
address: '0/0/2'
- type: 'time'
address: '0/0/1'
- type: 'datetime'
address: '0/0/23'
expose:
- type: 'temperature'
entity_id: 'sensor.owm_temperature'
address: '0/0/2'
- type: 'time'
address: '0/0/1'
- type: 'datetime'
address: '0/0/23'
```
* **type**: Type of the exposed value. Either time or datetime or any supported type of [KNX Sensor](/components/sensor.knx/) (e.g., "temperature" or "humidity").
* **entity_id**: Entity id of the HASS component to be exposed. Not necessary for types time and datetime.
* **address**: KNX group address.
### {% linkable_title Known issues %}
Due to lame multicast support the routing abstraction and the gateway scanner only work with Python >=3.5.

27
source/_components/konnected.markdown
View File

@ -23,7 +23,7 @@ The component currently supports the following device types in Home Assistant:
This component requires the [`discovery`](https://www.home-assistant.io/components/discovery) component to be enabled.
## {% linkable_title Configuration %}
### {% linkable_title Configuration %}
A `konnected` section must be present in the `configuration.yml` file that specifies the Konnected devices on the network and the sensors or actuators attached to them:
@ -32,13 +32,13 @@ A `konnected` section must be present in the `configuration.yml` file that speci
konnected:
access_token: REPLACE_ME_WITH_A_RANDOM_STRING
devices:
- id: 8bcd53
- id: 6001948bcd53
binary_sensors:
- zone: 1
type: door
switches:
- zone: out
- id: 438a38
- id: 5ccf7f438a38
binary_sensors:
- pin: 2
type: door
@ -62,7 +62,7 @@ devices:
type: list
keys:
id:
description: The MAC address of the WiFi module with colons/punctuation removed. You can either use the full 12-character MAC address or only the last 6 characters. This is visible in the device's WiFi SSID and hostname.
description: The MAC address of the NodeMCU WiFi module with colons/punctuation removed, for example `68c63a8bcd53`. You can usually find the mac address in your router's client list. Or, check the home-assistant.log for log messages from automatically discovered devices.
required: true
type: string
binary_sensors:
@ -118,14 +118,14 @@ devices:
- Either **pin** or **zone** is required for each actuator or sensor. Do not use both in the same definition.
- Pin `D8` or the `out` zone will only work when activation is set to high (the default).
## {% linkable_title Full Configuration %}
### {% linkable_title Extended Configuration %}
```yaml
# Example configuration.yaml entry
konnected:
access_token: REPLACE_ME_WITH_A_RANDOM_STRING
devices:
- id: 8bcd53
- id: 6001948bcd53
binary_sensors:
- zone: 1
type: door
@ -149,7 +149,7 @@ konnected:
momentary: 65
pause: 55
repeat: -1
- id: 438a38
- id: 5ccf7f438a38
binary_sensors:
- pin: 1
type: motion
@ -179,3 +179,16 @@ Konnected runs on an ESP8266 board with the NodeMCU firmware. It is commonly use
| 5 | D7 | 7 | GPIO13 |
| 6 | RX | 9 | GPIO3 |
| ALARM or OUT | D8 | 8 | GPIO15 |
### {% linkable_title Revision History %}
#### 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.
#### 0.72
* Adds `api_host` configuration option [[#14896](https://github.com/home-assistant/home-assistant/pull/14896)]
#### 0.70
* Initial release

22
source/_components/light.blinksticklight.markdown
View File

@ -1,6 +1,6 @@
---
layout: page
title: "Blinkstick"
title: "Blinkstick Light"
description: "Instructions on how to setup Blinkstick lights within Home Assistant."
date: 2015-10-08 10:00
sidebar: true
@ -8,7 +8,7 @@ comments: false
sharing: true
footer: true
logo: blinkstick.png
ha_category: Light
ha_category: DIY
ha_release: 0.7.5
ha_iot_class: "Local Polling"
---
@ -16,6 +16,8 @@ ha_iot_class: "Local Polling"
The `blinkstick` platform lets you control your [Blinkstick](https://www.blinkstick.com/) lights from within Home Assistant.
## {% linkable_title Configuration %}
To add blinkstick to your installation, add the following to your `configuration.yaml` file:
```yaml
@ -23,10 +25,18 @@ To add blinkstick to your installation, add the following to your `configuration
light:
- platform: blinksticklight
serial: BS000795-1.1
name: Living Room
```
Configuration variables:
{% configuration %}
serial:
description: The serial number of your stick.
required: true
default: 640
type: string
name:
description: Name of the stick.
required: false
type: string
default: Blinkstick
{% endconfiguration %}
- **serial** (*Required*): The serial number of your stick.
- **name** (*Required*): Name of the stick.

7
source/_components/light.blinkt.markdown
View File

@ -1,6 +1,6 @@
---
layout: page
title: "Blinkt!"
title: "Blinkt! Light"
description: "Instructions on how to setup Blinkt! RGB LED lights within Home Assistant."
date: 2017-04-30 9:00
sidebar: true
@ -8,13 +8,15 @@ comments: false
sharing: true
footer: true
logo: raspberry-pi.png
ha_category: Light
ha_category: DIY
ha_iot_class: "Local Push"
ha_release: 0.44
---
The `blinkt` light platform lets you control the [Blinkt!](https://shop.pimoroni.com/products/blinkt) board, featuring eight super-bright RGB LEDs.
## {% linkable_title Configuration %}
To enable `blinkt` in your installation, add the following to your `configuration.yaml` file:
```yaml
@ -22,3 +24,4 @@ To enable `blinkt` in your installation, add the following to your `configuratio
light:
- platform: blinkt
```

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