In previous versions, switch devices in setups with multiple cameras, would not have specific entity ID causing them to change randomly after each Home Assistant restart. The current version adds the name of the camera at the end of the switch entity ID, making it more specific and consistent and causes the name option to be required in a multi-camera system. This behavior matches the sensor behavior of the Amcrest component. Because of this, older automations may require updates to the entity ID.
-
+
diff --git a/source/_components/ampio.markdown b/source/_components/ampio.markdown
index cdd587dec49..22386b8baa4 100644
--- a/source/_components/ampio.markdown
+++ b/source/_components/ampio.markdown
@@ -1,12 +1,6 @@
---
-layout: page
title: "Ampio Smog"
description: "Instructions on how to setup Ampio Smog sensors in Home Assistant."
-date: 2019-02-17 00:00
-sidebar: true
-comments: false
-sharing: true
-footer: true
logo: ampio_smog.png
ha_category:
- Health
diff --git a/source/_components/android_ip_webcam.markdown b/source/_components/android_ip_webcam.markdown
index 04c19a03dac..1a383feb3c2 100644
--- a/source/_components/android_ip_webcam.markdown
+++ b/source/_components/android_ip_webcam.markdown
@@ -1,12 +1,6 @@
---
-layout: page
title: "Android IP Webcam"
description: "Connect Android devices as an IP webcam to Home Assistant"
-date: 2017-03-10 00:00
-sidebar: true
-comments: false
-sharing: true
-footer: true
logo: android_ip_webcam.png
ha_category:
- Hub
@@ -128,11 +122,14 @@ motion_sensor:
description: Activate motion sensor if `auto_discovery` is disabled.
required: false
type: boolean
+ default: false
{% endconfiguration %}
-
- You need to enable logging in the Android app (`Data logging` > `Enable data logging`), if you wish to see the sensor states in Home Assistant. The sensor states stays as `unknown`, until it's enabled.
-
+
+
+You need to enable logging in the Android app (`Data logging` > `Enable data logging`), if you wish to see the sensor states in Home Assistant. The sensor states stays as `unknown`, until it's enabled.
+
+
## Full example
diff --git a/source/_components/androidtv.markdown b/source/_components/androidtv.markdown
index ec7e91393f3..84fa928582a 100644
--- a/source/_components/androidtv.markdown
+++ b/source/_components/androidtv.markdown
@@ -1,12 +1,6 @@
---
-layout: page
title: "Android TV"
description: "Instructions on how to integrate Android TV and Fire TV devices into Home Assistant."
-date: 2015-10-23 18:00
-sidebar: true
-comments: false
-sharing: true
-footer: true
logo: androidtv.png
ha_category:
- Media Player
@@ -82,7 +76,7 @@ adb_server_port:
description: The port for the ADB server.
required: false
default: 5037
- type: port
+ type: integer
get_sources:
description: Whether or not to retrieve the running apps as the list of sources for Fire TV devices; not used for Android TV devices.
required: false
@@ -92,7 +86,7 @@ apps:
description: A dictionary where the keys are app IDs and the values are app names that will be displayed in the UI; see example below.
required: false
default: {}
- type: dict
+ type: map
device_class:
description: "The type of device: `auto` (detect whether it is an Android TV or Fire TV device), `androidtv`, or `firetv`."
required: false
@@ -155,9 +149,9 @@ If your device requires ADB authentication, you will need to follow the instruct
If you get a "Device authentication required, no keys available" error when trying to set up your Android TV or Fire TV, then you'll need to create an adbkey and add its path to your configuration. Follow the instructions on this page to connect to your device from your computer: [Connecting to Fire TV Through adb](https://developer.amazon.com/zh/docs/fire-tv/connecting-adb-to-device.html).
-
In the dialog appearing on your Android TV / Fire TV, you must check the box that says "always allow connections from this device." ADB authentication in Home Assistant will only work using a trusted key.
-
+
Once you've successfully connected to your Android TV / Fire TV via the command `adb connect `, the file `adbkey` will be created on your computer. The default locations for this file is (from [https://developer.android.com/studio/command-line/adb](https://developer.android.com/studio/command-line/adb)):
diff --git a/source/_components/anel_pwrctrl.markdown b/source/_components/anel_pwrctrl.markdown
index cbb9741a303..870df563a74 100644
--- a/source/_components/anel_pwrctrl.markdown
+++ b/source/_components/anel_pwrctrl.markdown
@@ -1,12 +1,6 @@
---
-layout: page
title: "ANEL PwrCtrl Switch"
description: "Instructions on how to integrate ANEL PwrCtrl switches within Home Assistant."
-date: 2016-10-02 19:04
-sidebar: true
-comments: false
-sharing: true
-footer: true
logo: anel.png
ha_category:
- Switch
@@ -58,4 +52,8 @@ password:
type: string
{% endconfiguration %}
-If no **host** is given the platform will try to auto-discover all devices on the network, that are listening on the given **port_recv**.
+
+
+If no **host** is given the platform will try to auto-discover all devices on the network, that are listening on the given **port_recv**.
+
+
diff --git a/source/_components/anthemav.markdown b/source/_components/anthemav.markdown
index 5e3b892f2cc..2711ba92612 100644
--- a/source/_components/anthemav.markdown
+++ b/source/_components/anthemav.markdown
@@ -1,12 +1,6 @@
---
-layout: page
title: "Anthem A/V Receivers"
description: "Instructions on how to integrate Anthem A/V Receivers into Home Assistant."
-date: 2016-12-31 23:11
-sidebar: true
-comments: false
-sharing: true
-footer: true
logo: anthemav.png
ha_category:
- Media Player
@@ -60,9 +54,11 @@ name:
- Enabling this platform will set and enforce "Standby IP Control On" in your Anthem device. You almost certainly want this. If you disable it on the device, it will just get re-enabled by Home Assistant.
- Only Zone 1 is currently supported.
-
- This platform will maintain a persistent connection to the network control port which will prevent any other application from communicating with the receiver. This includes the Anthem iOS and Android remote control apps as well as the ARC-2 Anthem Room Calibration software. You will need to disable this platform and restart Home Assistant if you want to use another
- application that makes use of the network control port.
-
- *The underlying Python module has hooks for halting and resuming the network connection but those functions are currently unsupported by the Home Assistant platform.*
-
+
+
+This platform will maintain a persistent connection to the network control port which will prevent any other application from communicating with the receiver. This includes the Anthem iOS and Android remote control apps as well as the ARC-2 Anthem Room Calibration software. You will need to disable this platform and restart Home Assistant if you want to use another
+application that makes use of the network control port.
+
+*The underlying Python module has hooks for halting and resuming the network connection but those functions are currently unsupported by the Home Assistant platform.*
+
+
diff --git a/source/_components/apcupsd.markdown b/source/_components/apcupsd.markdown
index 911db2cd7f1..686fc738314 100644
--- a/source/_components/apcupsd.markdown
+++ b/source/_components/apcupsd.markdown
@@ -1,12 +1,6 @@
---
-layout: page
title: "APCUPSd"
description: "Instructions on how to integrate APCUPSd status with Home Assistant."
-date: 2016-02-10 17:11
-sidebar: true
-comments: false
-sharing: true
-footer: true
logo: apcupsd.png
ha_category:
- System Monitor
@@ -54,9 +48,11 @@ port:
default: 3551
{% endconfiguration %}
-
+
+
If you get `ConnectionRefusedError: Connection refused` errors in the Home assistant logs, ensure the [APCUPSd](http://www.apcupsd.org/) configuration directives used by its Network Information Server is set to permit connections from all addresses [NISIP 0.0.0.0](http://www.apcupsd.org/manual/manual.html#configuration-directives-used-by-the-network-information-server), else non-local addesses will not connect. This includes Hass.io running in Docker, even when hosted on the same machine or a virtual machine.
-
+
+
## Binary sensor
diff --git a/source/_components/api.markdown b/source/_components/api.markdown
index 151530947b7..224057a452e 100644
--- a/source/_components/api.markdown
+++ b/source/_components/api.markdown
@@ -1,12 +1,6 @@
---
-layout: page
title: "API"
description: "Instructions on how to setup the RESTful API within Home Assistant."
-date: 2018-01-21 08:00
-sidebar: true
-comments: false
-sharing: true
-footer: true
logo: home-assistant.png
ha_category:
- Other
@@ -16,9 +10,11 @@ ha_release: 0.7
The `api` integration exposes a RESTful API and allows one to interact with a Home Assistant instance that is running headless. This integration depends on the [`http` integration](/components/http/).
-
+
+
It is HIGHLY recommended that you set the `api_password`, especially if you are planning to expose your installation to the internet.
-
+
+
```yaml
# Example configuration.yaml entry
diff --git a/source/_components/apns.markdown b/source/_components/apns.markdown
index ca29ec3ecf3..410a7b0ac8a 100644
--- a/source/_components/apns.markdown
+++ b/source/_components/apns.markdown
@@ -1,12 +1,6 @@
---
-layout: page
title: "APNS"
description: "Instructions on how to add APNS notifications to Home Assistant."
-date: 2016-09-05 23:00
-sidebar: true
-comments: false
-sharing: true
-footer: true
logo: apple.png
ha_category:
- Notifications
diff --git a/source/_components/apple_tv.markdown b/source/_components/apple_tv.markdown
index d7cf830ecb0..52d74a6b3a8 100644
--- a/source/_components/apple_tv.markdown
+++ b/source/_components/apple_tv.markdown
@@ -1,12 +1,6 @@
---
-layout: page
title: "Apple TV"
description: "Instructions on how to integrate Apple TV devices into Home Assistant."
-date: 2017-06-26 20:47
-sidebar: true
-comments: false
-sharing: true
-footer: true
logo: apple.png
ha_category:
- Multimedia
@@ -26,9 +20,9 @@ There is currently support for the following device types within Home Assistant:
- Media Player
- [Remote](#remote)
-
+
Currently, you must have Home Sharing enabled for this to work. Support for pairing Home Assistant with your device will be supported in a later release.
-
+
## Configuration
@@ -72,6 +66,7 @@ start_off:
description: Set to true if the device should start in fake standby.
required: false
type: boolean
+ default: false
credentials:
description: Credentials used for AirPlay playback.
required: false
@@ -154,9 +149,9 @@ The first two points are quite obvious. Fake standby is a concept implemented in
To put a device into fake standby when starting Home Assistant, add `start_off: true` to your configuration.
-
+
Turning the device on/off in the user interface will *not* turn the physical device on/off according to the description above.
-
+
## Services
diff --git a/source/_components/aprs.markdown b/source/_components/aprs.markdown
index 25ae43b2be4..8dc6cf88e8d 100644
--- a/source/_components/aprs.markdown
+++ b/source/_components/aprs.markdown
@@ -1,12 +1,6 @@
---
-layout: page
title: "APRS"
description: "Instructions on how to use APRS to track devices in Home Assistant."
-date: 2018-11-04 00:00
-sidebar: true
-comments: false
-sharing: true
-footer: true
logo: aprs.png
ha_release: 0.95
ha_category: Presence Detection
diff --git a/source/_components/aqualogic.markdown b/source/_components/aqualogic.markdown
index b133221bc97..eb0f2168f6e 100644
--- a/source/_components/aqualogic.markdown
+++ b/source/_components/aqualogic.markdown
@@ -1,12 +1,6 @@
---
-layout: page
title: "AquaLogic"
description: "Instructions on how to integrate an AquaLogic controller within Home Assistant."
-date: 2018-09-17 9:16
-sidebar: true
-comments: false
-sharing: true
-footer: true
logo: hayward.png
ha_category:
- Hub
@@ -45,7 +39,7 @@ host:
port:
description: The port provided by the RS-485 to Ethernet adapter.
required: true
- type: int
+ type: integer
{% endconfiguration %}
## Sensor
diff --git a/source/_components/aquostv.markdown b/source/_components/aquostv.markdown
index c69cfaefc23..179ed0a8ed3 100644
--- a/source/_components/aquostv.markdown
+++ b/source/_components/aquostv.markdown
@@ -1,12 +1,6 @@
---
-layout: page
title: "Sharp Aquos TV"
description: "Instructions on how to integrate a Sharp Aquos TV into Home Assistant."
-date: 2016-11-02 12:02
-sidebar: true
-comments: false
-sharing: true
-footer: true
logo: sharp_aquos.png
ha_category:
- Media Player
@@ -16,7 +10,7 @@ redirect_from:
- /components/media_player.aquostv/
---
-The `aquostv` platform allows you to control a [Sharp Aquos TV](http://www.sharp.ca/en-CA/ForHome/HomeEntertainment/LEDTV/QuattronPlus.aspx).
+The `aquostv` platform allows you to control a [Sharp Aquos TV](http://www.sharp-world.com/aquos/en/index.html).
When the TV is first connected, you will need to accept Home Assistant on the TV to allow communication.
@@ -38,7 +32,7 @@ port:
description: The port of the Sharp Aquos TV.
required: false
default: 10002
- type: int
+ type: integer
username:
description: The username of the Sharp Aquos TV.
required: false
@@ -60,13 +54,13 @@ power_on_enabled:
type: boolean
{% endconfiguration %}
+
-
When you set **power_on_enabled** as True, you have to turn on your TV on the first time with the remote.
Then you will be able to turn on with Home Assistant.
Also, with **power_on_enabled** as True, the Aquos logo on your TV will stay on when you turn off the TV and your TV could consumes more power.
-
+
+
A word of caution: The Arduino boards are not storing states. This means that with every initialization the pins are set to off/low.
-
+
Add the user who is used to run Home Assistant to the groups to allow access to the serial port.
@@ -98,7 +92,7 @@ pins:
type: map
keys:
name:
- default: Name that will be used in the frontend for the pin.
+ description: Name that will be used in the frontend for the pin.
type: string
{% endconfiguration %}
@@ -135,16 +129,16 @@ pins:
type: map
keys:
name:
- default: Name that will be used in the frontend for the pin.
+ description: Name that will be used in the frontend for the pin.
type: string
required: false
initial:
- default: The initial value for this port.
+ description: The initial value for this port.
type: boolean
required: false
default: false
negate:
- default: If this pin should be inverted.
+ description: If this pin should be inverted.
type: boolean
required: false
default: false
diff --git a/source/_components/arest.markdown b/source/_components/arest.markdown
index bb48218c52d..57282ff7410 100644
--- a/source/_components/arest.markdown
+++ b/source/_components/arest.markdown
@@ -1,12 +1,6 @@
---
-layout: page
title: "aREST"
description: "Instructions on how to integrate aREST within Home Assistant."
-date: 2015-11-20 18:15
-sidebar: true
-comments: false
-sharing: true
-footer: true
logo: arest.png
ha_category:
- DIY
@@ -74,9 +68,9 @@ binary_sensor:
name: Office
```
-
+
This sensor is not suitable for fast state changes because there is a high possibility that the change took place between two update cycle.
-
+
## Sensor
@@ -220,7 +214,7 @@ resource:
type: string
name:
description: Let you overwrite the name of the device. By default *name* from the device is used.
- required: optional
+ required: false
type: string
pins:
description: An array with all used pins.
diff --git a/source/_components/arlo.markdown b/source/_components/arlo.markdown
index 681c09b3a96..1e82b54d60a 100644
--- a/source/_components/arlo.markdown
+++ b/source/_components/arlo.markdown
@@ -1,12 +1,6 @@
---
-layout: page
title: "Arlo"
description: "Instructions on how to integrate your Netgear Arlo cameras within Home Assistant."
-date: 2017-05-30 10:00
-sidebar: true
-comments: false
-sharing: true
-footer: true
logo: arlo.png
ha_category:
- Hub
diff --git a/source/_components/aruba.markdown b/source/_components/aruba.markdown
index ab1b1ebacb9..e518e517663 100644
--- a/source/_components/aruba.markdown
+++ b/source/_components/aruba.markdown
@@ -1,12 +1,6 @@
---
-layout: page
title: "Aruba"
description: "Instructions on how to integrate Aruba routers into Home Assistant."
-date: 2015-08-31 08:45
-sidebar: true
-comments: false
-sharing: true
-footer: true
logo: aruba.png
ha_category:
- Presence Detection
@@ -22,9 +16,9 @@ Supported devices (tested):
- ARUBA AP-105
-
+
This device tracker needs telnet to be enabled on the router.
-
+
To use this device tracker in your installation, add the following to your `configuration.yaml` file:
diff --git a/source/_components/arwn.markdown b/source/_components/arwn.markdown
index 615fefd03c1..566b50d74bb 100644
--- a/source/_components/arwn.markdown
+++ b/source/_components/arwn.markdown
@@ -1,12 +1,6 @@
---
-layout: page
title: "ARWN Sensor"
description: "Instructions on how to integrate ARWN within Home Assistant."
-date: 2016-10-20 15:15
-sidebar: true
-comments: false
-sharing: true
-footer: true
ha_category:
- Sensor
ha_release: 0.31
diff --git a/source/_components/asterisk_cdr.markdown b/source/_components/asterisk_cdr.markdown
index 4cc68d5d505..9d854143473 100644
--- a/source/_components/asterisk_cdr.markdown
+++ b/source/_components/asterisk_cdr.markdown
@@ -1,12 +1,6 @@
---
-layout: page
title: "Asterisk Call Data Recorder"
description: "Instructions on how to integrate an Asterisk CDR within Home Assistant."
-date: 2018-09-12 06:30
-sidebar: true
-comments: false
-sharing: true
-footer: true
logo: asterisk.png
ha_category:
- Mailbox
diff --git a/source/_components/asterisk_mbox.markdown b/source/_components/asterisk_mbox.markdown
index e2ab37d0a11..8987a44328a 100644
--- a/source/_components/asterisk_mbox.markdown
+++ b/source/_components/asterisk_mbox.markdown
@@ -1,12 +1,6 @@
---
-layout: page
title: "Asterisk Voicemail"
description: "Instructions on how to integrate your existing Asterisk voicemail within Home Assistant."
-date: 2017-06-30 18:30
-sidebar: true
-comments: false
-sharing: true
-footer: true
logo: asterisk.png
ha_category:
- Mailbox
@@ -51,6 +45,6 @@ port:
type: string
{% endconfiguration %}
-
+
Communication between the Asterisk PBX server and the Home Assistant server is password-protected, but the data transmission is not encrypted. It is recommended to only use this integration when communication is contained within a local area network.
-
+
diff --git a/source/_components/asuswrt.markdown b/source/_components/asuswrt.markdown
index abd1a385c71..d4886aaac05 100644
--- a/source/_components/asuswrt.markdown
+++ b/source/_components/asuswrt.markdown
@@ -1,12 +1,6 @@
---
-layout: page
title: "Asuswrt"
description: "Instructions on how to integrate Asuswrt into Home Assistant."
-date: 2017-01-05 17:30
-sidebar: true
-comments: false
-sharing: true
-footer: true
logo: asus.png
ha_category:
- Hub
@@ -89,9 +83,11 @@ sensors:
description: upload mbit/s sensor
{% endconfiguration %}
-
+
+
You need to [enable telnet](https://www.asus.com/support/faq/1005449/) on your router if you choose to use `protocol: telnet`.
-
+
+
### Example Sensor Configuration
diff --git a/source/_components/august.markdown b/source/_components/august.markdown
index 8400ab48eae..b2f7ba1d9f1 100644
--- a/source/_components/august.markdown
+++ b/source/_components/august.markdown
@@ -1,12 +1,6 @@
---
-layout: page
title: "August"
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:
- Doorbell
@@ -30,9 +24,9 @@ There is currently support for the following device types within Home Assistant:
- Camera
- Lock
-
+
August Lock 2nd Gen will need either August Connect or Doorbell to connect to Home Assistant.
-
+
## Configuration
diff --git a/source/_components/aurora.markdown b/source/_components/aurora.markdown
index dd0f5539c2b..ed9c234558a 100644
--- a/source/_components/aurora.markdown
+++ b/source/_components/aurora.markdown
@@ -1,12 +1,6 @@
---
-layout: page
title: "Aurora sensor"
description: "Know when auroras might be visible at your location"
-date: 2017-02-14 10:00
-sidebar: true
-comments: false
-sharing: true
-footer: true
ha_category:
- Environment
ha_release: 0.39
diff --git a/source/_components/auth.markdown b/source/_components/auth.markdown
index 044caa74c1e..9e9f413a18a 100644
--- a/source/_components/auth.markdown
+++ b/source/_components/auth.markdown
@@ -1,12 +1,6 @@
---
-layout: page
title: "Auth"
description: "This integration is responsible for providing the authentication endpoints."
-date: 2018-03-19 21:04
-sidebar: true
-comments: false
-sharing: true
-footer: true
logo: home-assistant.png
ha_category:
- Other
diff --git a/source/_components/automatic.markdown b/source/_components/automatic.markdown
index 26bb173fe96..46917dc5866 100644
--- a/source/_components/automatic.markdown
+++ b/source/_components/automatic.markdown
@@ -1,12 +1,6 @@
---
-layout: page
title: "Automatic"
description: "Instructions for how to integrate Automatic ODB readers into Home Assistant."
-date: 2015-08-28 19:00
-sidebar: true
-comments: false
-sharing: true
-footer: true
logo: automatic.png
ha_category:
- Car
@@ -76,8 +70,8 @@ automation:
- service: light.turn_off
```
-
- You can obtain the correct ID for your vehicle from your known_devices.yaml file. Be sure to lower-case any letters contained in your vehicle's ID when using it in an automation trigger.
-
+
+You can obtain the correct ID for your vehicle from your known_devices.yaml file. Be sure to lower-case any letters contained in your vehicle's ID when using it in an automation trigger.
+
See the [device tracker integration page](/components/device_tracker/) for instructions how to configure the cars to be tracked.
diff --git a/source/_components/automation.markdown b/source/_components/automation.markdown
index 04f3da4413b..9306cd54a3b 100644
--- a/source/_components/automation.markdown
+++ b/source/_components/automation.markdown
@@ -1,12 +1,6 @@
---
-layout: page
title: "Automation"
description: "Instructions on how to setup automation within Home Assistant."
-date: 2015-01-20 22:36
-sidebar: true
-comments: false
-sharing: true
-footer: true
logo: home-assistant.png
ha_category:
- Automation
diff --git a/source/_components/avion.markdown b/source/_components/avion.markdown
index 4607e0213b0..8773091cfbc 100644
--- a/source/_components/avion.markdown
+++ b/source/_components/avion.markdown
@@ -1,12 +1,6 @@
---
-layout: page
title: "Avi-on"
description: "Instructions on how to setup GE Avi-on Bluetooth dimmers within Home Assistant."
-date: 2017-01-17 23:17
-sidebar: true
-comments: false
-sharing: true
-footer: true
ha_category:
- Light
ha_iot_class: Assumed State
diff --git a/source/_components/awair.markdown b/source/_components/awair.markdown
index e5b3c70d9dd..7cb261870b8 100644
--- a/source/_components/awair.markdown
+++ b/source/_components/awair.markdown
@@ -1,12 +1,6 @@
---
-layout: page
title: "Awair Air Quality Monitor"
description: "Instructions on how to setup Awair devices in Home Assistant."
-date: 2018-11-18 20:41
-sidebar: true
-comments: false
-sharing: true
-footer: true
logo: awair.jpg
ha_category:
- Health
diff --git a/source/_components/aws.markdown b/source/_components/aws.markdown
index 307bea1572e..80bc9627e64 100644
--- a/source/_components/aws.markdown
+++ b/source/_components/aws.markdown
@@ -1,12 +1,6 @@
---
-layout: page
title: "Amazon Web Services"
description: "Instructions on how to integrate Amazon Web Services with Home Assistant."
-date: 2019-03-21 00:00
-sidebar: true
-comments: false
-sharing: true
-footer: true
logo: aws.png
ha_category:
- Notifications
@@ -48,12 +42,12 @@ name:
required: true
type: string
aws_access_key_id:
- description: Your AWS Access Key ID. If provided, you must also provide an `aws_secret_access_key` and must **not** provide a `profile_name`.
- required: Required if aws_secret_access_key is provided
+ description: Your AWS Access Key ID. If provided, you must also provide an `aws_secret_access_key` and must **not** provide a `profile_name`. Required if `aws_secret_access_key` is provided.
+ required: false
type: string
aws_secret_access_key:
- description: Your AWS Secret Access Key. If provided, you must also provide an `aws_access_key_id` and must **not** provide a `profile_name`.
- required: Required if aws_access_key_id is provided
+ description: Your AWS Secret Access Key. If provided, you must also provide an `aws_access_key_id` and must **not** provide a `profile_name`. Required if `aws_access_key_id` is provided.
+ required: false
type: string
profile_name:
description: A credentials profile name.
@@ -86,8 +80,8 @@ aws_access_key_id:
required: false
type: string
aws_secret_access_key:
- description: Your AWS Secret Access Key. If provided, you must also provide an `aws_access_key_id`.
- required: Required if aws_access_key_id is provided
+ description: Your AWS Secret Access Key. If provided, you must also provide an `aws_access_key_id`. Required if aws_access_key_id is provided.
+ required: false
type: string
profile_name:
description: A credentials profile name.
@@ -144,9 +138,9 @@ If one exists, the SNS Subject will be set to the title. All attributes from the
- On the left-hand side, select "Users" then click "Create New Users". Enter a name here and then click "Create".
- You can either download the credentials or click the arrow to display them one time.
-
- If you do not download them, you will lose them and will have to recreate a new user.
-
+
+If you do not download them, you will lose them and will have to recreate a new user.
+
- Copy/Paste the two keys that are shown here in your `configuration.yaml` file.
- On the left-hand side of the screen go back to "Users" and select the user you just created. On the "Permissions" tab click the "Attach Policy" icon. Search for "SNS" and attach the policy "AmazonSNSFUullAccess".
diff --git a/source/_components/axis.markdown b/source/_components/axis.markdown
index f1694d780ba..9dd0688bf53 100644
--- a/source/_components/axis.markdown
+++ b/source/_components/axis.markdown
@@ -1,12 +1,6 @@
---
-layout: page
title: "Axis"
description: "Integration between network devices from Axis Communications with Home Assistant."
-date: 2017-04-30 23:04
-sidebar: true
-comments: false
-sharing: true
-footer: true
logo: axis.png
ha_category:
- Camera
@@ -28,9 +22,9 @@ Home Assistant will automatically discover their presence on your network.
For configuration go to the `Integrations pane` on your Home Assistant instance.
-
+
It is recommended that you create a user on your Axis device specifically for Home Assistant. For all current functionality, it is enough to create a user belonging to user group viewer.
-
+
## Troubleshooting discovery
diff --git a/source/_components/azure_event_hub.markdown b/source/_components/azure_event_hub.markdown
index 802c77f8f98..c7ed04efc3f 100644
--- a/source/_components/azure_event_hub.markdown
+++ b/source/_components/azure_event_hub.markdown
@@ -1,12 +1,6 @@
---
-layout: page
title: "Azure Event Hub"
description: "Setup for Azure Event Hub integration"
-date: 2019-05-15 08:00
-sidebar: true
-comments: false
-sharing: true
-footer: true
logo: azure_event_hub.svg
ha_category:
- History
@@ -62,7 +56,7 @@ event_hub_sas_key:
type: string
filter:
description: Filter domains and entities for Event Hub.
- required: false
+ required: true
type: map
default: Includes all entities from all domains
keys:
@@ -84,13 +78,13 @@ filter:
type: list
{% endconfiguration %}
-
- Not filtering domains or entities will send every event to Azure Event Hub, thus taking up a lot of space.
-
+
+Not filtering domains or entities will send every event to Azure Event Hub, thus taking up a lot of space.
+
-
+
Event Hubs have a retention time of at most 7 days, if you do not capture or use the events they are deleted automatically from the Event Hub, the default retention is 1 day.
-
+
### Using the data in Azure
diff --git a/source/_components/baidu.markdown b/source/_components/baidu.markdown
index 43f3cb97911..a02d82656f4 100644
--- a/source/_components/baidu.markdown
+++ b/source/_components/baidu.markdown
@@ -1,12 +1,6 @@
---
-layout: page
title: "Baidu Text-to-Speech"
description: "Instructions on how to setup Baidu TTS with Home Assistant."
-date: 2017-11-21 09:00
-sidebar: true
-comments: false
-sharing: true
-footer: true
logo: baiducloud.png
ha_category:
- Text-to-speech
diff --git a/source/_components/bayesian.markdown b/source/_components/bayesian.markdown
index 13bc25c6b9c..b12e2f856b5 100644
--- a/source/_components/bayesian.markdown
+++ b/source/_components/bayesian.markdown
@@ -1,12 +1,6 @@
---
-layout: page
title: "Bayesian Binary Sensor"
description: "Instructions on how to integrate threshold Bayesian sensors into Home Assistant."
-date: 2017-08-27 20:05
-sidebar: true
-comments: false
-sharing: true
-footer: true
logo: home-assistant.png
ha_category:
- Utility
@@ -68,12 +62,12 @@ observations:
required: true
type: string
entity_id:
- description: Name of the entity to monitor.
- required: true (for `state` and `numeric_state`)
+ description: Name of the entity to monitor. Required for `state` and `numeric_state`.
+ required: false
type: string
value_template:
- description: Defines the template to be used.
- required: true (for `template`)
+ description: Defines the template to be used. Required for `template`.
+ required: false
type: template
prob_given_true:
description: The probability of the observation occurring, given the event is `true`.
@@ -85,8 +79,8 @@ observations:
type: float
default: "`1 - prob_given_true` if `prob_given_false` is not set"
to_state:
- description: The target state.
- required: true (for `state`)
+ description: The target state. Required (for `state`).
+ required: false
type: string
{% endconfiguration %}
diff --git a/source/_components/bbb_gpio.markdown b/source/_components/bbb_gpio.markdown
index 825f7e94611..54abf69bb50 100644
--- a/source/_components/bbb_gpio.markdown
+++ b/source/_components/bbb_gpio.markdown
@@ -1,12 +1,6 @@
---
-layout: page
title: "BeagleBone Black GPIO"
description: "Instructions on how to integrate the GPIO capability of a BeagleBone Black into Home Assistant."
-date: 2017-01-14 10:00
-sidebar: true
-comments: false
-sharing: true
-footer: true
logo: beaglebone-black.png
ha_category:
- DIY
diff --git a/source/_components/bbox.markdown b/source/_components/bbox.markdown
index 639f102092a..48e36e05bd8 100644
--- a/source/_components/bbox.markdown
+++ b/source/_components/bbox.markdown
@@ -1,12 +1,6 @@
---
-layout: page
title: "Bbox"
description: "Instructions on how to integrate Bouygues Bbox routers into Home Assistant."
-date: 2016-10-22 01:00
-sidebar: true
-comments: false
-sharing: true
-footer: true
logo: bbox.png
ha_category:
- Network
@@ -26,9 +20,9 @@ There is currently support for the following device types within Home Assistant:
- [Presence Detection](#presence-detection)
- [Sensor](#sensor)
-
+
Due to third party limitation, the sensors will only be available if Home Assistant and the Bbox are on the same local area network. You can check this by going to 192.168.1.254 with your web browser.
-
+
## Presence Detection
@@ -56,10 +50,9 @@ host:
default: 192.168.1.254
{% endconfiguration %}
-
-
+
For now and due to third party limitation, the Bbox must be on the same local network as the Home Assistant installation.
-
+
See the [device tracker integration page](/components/device_tracker/) for instructions how to configure the people to be tracked.
diff --git a/source/_components/bh1750.markdown b/source/_components/bh1750.markdown
index 4a99008a375..a4e62649851 100644
--- a/source/_components/bh1750.markdown
+++ b/source/_components/bh1750.markdown
@@ -1,12 +1,6 @@
---
-layout: page
title: "BH1750 Light sensor"
description: "Instructions on how to integrate a BH1750 light sensor into Home Assistant."
-date: 2017-06-10 00:00
-sidebar: true
-comments: false
-sharing: true
-footer: true
logo: raspberry-pi.png
ha_category:
- DIY
diff --git a/source/_components/binary_sensor.knx.markdown b/source/_components/binary_sensor.knx.markdown
index 6f9e15a22e8..34148af2a5a 100644
--- a/source/_components/binary_sensor.knx.markdown
+++ b/source/_components/binary_sensor.knx.markdown
@@ -1,12 +1,6 @@
---
-layout: page
title: "KNX Binary Sensor"
description: "Instructions on how to setup the KNX binary sensors within Home Assistant."
-date: 2016-07-13 07:00
-sidebar: true
-comments: false
-sharing: true
-footer: true
logo: knx.png
ha_category:
- Binary Sensor
diff --git a/source/_components/binary_sensor.markdown b/source/_components/binary_sensor.markdown
index 650e5770aed..9622e53d1c2 100644
--- a/source/_components/binary_sensor.markdown
+++ b/source/_components/binary_sensor.markdown
@@ -1,12 +1,6 @@
---
-layout: page
title: "Binary Sensor"
description: "Instructions on how-to setup binary sensors with Home Assistant."
-date: 2015-11-20 14:00
-sidebar: true
-comments: false
-sharing: true
-footer: true
logo: home-assistant.png
ha_category:
- Binary Sensor
diff --git a/source/_components/binary_sensor.modbus.markdown b/source/_components/binary_sensor.modbus.markdown
index f5ecf118eea..042a2c8355f 100644
--- a/source/_components/binary_sensor.modbus.markdown
+++ b/source/_components/binary_sensor.modbus.markdown
@@ -1,12 +1,6 @@
---
-layout: page
title: "Modbus Binary Sensor"
description: "Instructions on how to set up Modbus binary sensors within Home Assistant."
-date: 2016-09-13 12:02
-sidebar: true
-comments: false
-sharing: true
-footer: true
logo: modbus.png
ha_category:
- Binary Sensor
diff --git a/source/_components/binary_sensor.mqtt.markdown b/source/_components/binary_sensor.mqtt.markdown
index 4fa2ad249e9..2e66c2e9778 100644
--- a/source/_components/binary_sensor.mqtt.markdown
+++ b/source/_components/binary_sensor.mqtt.markdown
@@ -1,12 +1,6 @@
---
-layout: page
title: "MQTT Binary Sensor"
description: "Instructions on how to integrate MQTT binary sensors within Home Assistant."
-date: 2015-05-30 23:21
-sidebar: true
-comments: false
-sharing: true
-footer: true
logo: mqtt.png
ha_category:
- Binary Sensor
@@ -111,11 +105,11 @@ device:
identifiers:
description: A list of IDs that uniquely identify the device. For example a serial number.
required: false
- type: list, string
+ type: [list, string]
connections:
description: "A list of connections of the device to the outside world as a list of tuples `[connection_type, connection_identifier]`. For example the MAC address of a network interface: `'connections': ['mac', '02:5b:26:a8:dc:12']`."
required: false
- type: list, tuple
+ type: [list, map]
manufacturer:
description: The manufacturer of the device.
required: false
diff --git a/source/_components/binary_sensor.mysensors.markdown b/source/_components/binary_sensor.mysensors.markdown
index 26bd943d707..295ad68b479 100644
--- a/source/_components/binary_sensor.mysensors.markdown
+++ b/source/_components/binary_sensor.mysensors.markdown
@@ -1,12 +1,6 @@
---
-layout: page
title: "MySensors Binary Sensor"
description: "Instructions on how to integrate MySensors binary sensors into Home Assistant."
-date: 2016-04-13 14:20 +0100
-sidebar: true
-comments: false
-sharing: true
-footer: true
logo: mysensors.png
ha_category:
- DIY
diff --git a/source/_components/binary_sensor.rest.markdown b/source/_components/binary_sensor.rest.markdown
index c551709bef9..f941901f6dc 100644
--- a/source/_components/binary_sensor.rest.markdown
+++ b/source/_components/binary_sensor.rest.markdown
@@ -1,12 +1,6 @@
---
-layout: page
title: "RESTful Binary Sensor"
description: "Instructions on how to integrate REST binary sensors into Home Assistant."
-date: 2015-12-17 19:10
-sidebar: true
-comments: false
-sharing: true
-footer: true
logo: restful.png
ha_category:
- Binary Sensor
@@ -94,7 +88,7 @@ verify_ssl:
timeout:
description: Defines max time to wait data from the endpoint.
required: false
- type: positive integer
+ type: integer
default: 10
authentication:
description: "Type of the HTTP authentication. `basic` or `digest`."
@@ -111,12 +105,12 @@ password:
headers:
description: The headers for the requests.
required: false
- type: list, string
+ type: [list, string]
{% endconfiguration %}
-
+
Make sure that the URL exactly matches your endpoint or resource.
-
+
## Examples
diff --git a/source/_components/binary_sensor.rflink.markdown b/source/_components/binary_sensor.rflink.markdown
index 005e1103066..90c9f65f4e9 100644
--- a/source/_components/binary_sensor.rflink.markdown
+++ b/source/_components/binary_sensor.rflink.markdown
@@ -1,12 +1,6 @@
---
-layout: page
title: "RFLink Binary Sensor"
description: "Instructions on how to integrate RFLink binary sensors into Home Assistant."
-date: 2018-10-04
-sidebar: true
-comments: false
-sharing: true
-footer: true
logo: rflink.png
ha_category:
- Binary Sensor
@@ -61,7 +55,7 @@ devices:
off_delay:
description: For sensors that only sends 'On' state updates, this variable sets a delay after which the sensor state will be updated back to 'Off'.
required: false
- type: int
+ type: integer
force_update:
description: Sends update events even if the value has not changed. Useful for sensors that only sends `On`.
required: false
diff --git a/source/_components/binary_sensor.rfxtrx.markdown b/source/_components/binary_sensor.rfxtrx.markdown
index dc0c63f2201..0cdb7344617 100644
--- a/source/_components/binary_sensor.rfxtrx.markdown
+++ b/source/_components/binary_sensor.rfxtrx.markdown
@@ -1,12 +1,6 @@
---
-layout: page
title: "RFXtrx Binary Sensor"
description: "Instructions on how to integrate RFXtrx binary sensors into Home Assistant."
-date: 2017-03-26 12:45
-sidebar: true
-comments: false
-sharing: true
-footer: true
logo: rfxtrx.png
ha_category:
- Binary Sensor
@@ -94,15 +88,19 @@ automatic_add:
default: false
{% endconfiguration %}
-
+
+
This integration and the [rfxtrx switch](/components/switch/rfxtrx/) can steal each other's devices when setting the `automatic_add` configuration parameter to `true`.
Set `automatic_add` only when you have some devices to add to your installation, otherwise leave it to `false`.
-
-
+
+
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.
-
+
+
Binary sensors have only two states - "on" and "off". Many door or window
opening sensors will send a signal each time the door/window is open or closed.
diff --git a/source/_components/binary_sensor.template.markdown b/source/_components/binary_sensor.template.markdown
index 48b55320fa0..d57dd513cdf 100644
--- a/source/_components/binary_sensor.template.markdown
+++ b/source/_components/binary_sensor.template.markdown
@@ -1,12 +1,6 @@
---
-layout: page
title: "Template Binary Sensor"
description: "Instructions on how to integrate Template Binary Sensors into Home Assistant."
-date: 2016-02-25 15:00
-sidebar: true
-comments: false
-sharing: true
-footer: true
ha_category:
- Binary Sensor
ha_release: 0.12
@@ -54,7 +48,7 @@ sensors:
entity_id:
description: A list of entity IDs so the sensor only reacts to state changes of these entities. This can be used if the automatic analysis fails to find all relevant entities.
required: false
- type: string, list
+ type: [string, list]
device_class:
description: Sets the [class of the device](/components/binary_sensor/), changing the device state and icon that is displayed on the frontend.
required: false
diff --git a/source/_components/binary_sensor.xiaomi_aqara.markdown b/source/_components/binary_sensor.xiaomi_aqara.markdown
index f998800dda5..b71436bda40 100644
--- a/source/_components/binary_sensor.xiaomi_aqara.markdown
+++ b/source/_components/binary_sensor.xiaomi_aqara.markdown
@@ -1,12 +1,6 @@
---
-layout: page
title: "Xiaomi Binary Sensor"
description: "Instructions on how to setup the Xiaomi binary sensors within Home Assistant."
-date: 2017-07-21 16:34
-sidebar: true
-comments: false
-sharing: true
-footer: true
logo: xiaomi.png
ha_category:
- Binary Sensor
diff --git a/source/_components/bitcoin.markdown b/source/_components/bitcoin.markdown
index b5c3ad70b6b..96982e1be3e 100644
--- a/source/_components/bitcoin.markdown
+++ b/source/_components/bitcoin.markdown
@@ -1,12 +1,6 @@
---
-layout: page
title: "Bitcoin"
description: "Instructions on how to integrate Bitcoin data within Home Assistant."
-date: 2015-05-08 17:15
-sidebar: true
-comments: false
-sharing: true
-footer: true
logo: bitcoin.png
ha_category:
- Finance
@@ -39,7 +33,7 @@ currency:
display_options:
description: Options to display in the frontend.
required: true
- type: map
+ type: list
keys:
exchangerate:
description: Exchange rate of 1 BTC
diff --git a/source/_components/bizkaibus.markdown b/source/_components/bizkaibus.markdown
index e496d3f6071..bd5b94cbe84 100644
--- a/source/_components/bizkaibus.markdown
+++ b/source/_components/bizkaibus.markdown
@@ -1,12 +1,6 @@
---
-layout: page
title: "Bizkaibus next bus tracking sensor"
description: "Instructions on how to integrate timetable data for traveling on Bizkaibus within Home Assistant."
-date: 2019-04-22 14:00
-sidebar: true
-comments: false
-sharing: true
-footer: true
logo: bizkaibus.png
ha_category:
- Transport
diff --git a/source/_components/blackbird.markdown b/source/_components/blackbird.markdown
index daf32ef63fb..5236d4f88a6 100644
--- a/source/_components/blackbird.markdown
+++ b/source/_components/blackbird.markdown
@@ -1,12 +1,6 @@
---
-layout: page
title: "Blackbird 8x8 HDMI Matrix Switch"
description: "Instructions on how to integrate Monoprice Blackbird 4k 8x8 HDBaseT Matrix Switch into Home Assistant."
-date: 2018-03-29 16:35
-sidebar: true
-comments: false
-sharing: true
-footer: true
logo: monoprice.svg
ha_category:
- Media Player
@@ -45,17 +39,19 @@ host:
zones:
description: This is the list of zones available. Valid zones are 1, 2, 3, 4, 5, 6, 7, 8. Each zone must have a name assigned to it.
required: true
- type: integer
+ type: map
keys:
- name:
+ ZONE_NUMBER:
description: The name of the zone.
+ type: string
sources:
description: The list of sources available. Valid source numbers are 1, 2, 3, 4, 5, 6, 7, 8. Each source number corresponds to the input number on the Blackbird matrix switch. Similar to zones, each source must have a name assigned to it.
required: true
- type: integer
+ type: map
keys:
- name:
+ ZONE_NUMBER:
description: The name of the source.
+ type: string
{% endconfiguration %}
### Service `media_player.blackbird_set_all_zones`
diff --git a/source/_components/blink.markdown b/source/_components/blink.markdown
index 465f2753dee..9227f6b2f23 100644
--- a/source/_components/blink.markdown
+++ b/source/_components/blink.markdown
@@ -1,12 +1,6 @@
---
-layout: page
title: "Blink"
description: "Instructions for how to integrate Blink camera/security system within Home Assistant."
-date: 2017-03-05 22:13
-sidebar: true
-comments: false
-sharing: true
-footer: true
logo: blink.png
ha_category:
- Hub
@@ -160,7 +154,7 @@ The following are some examples showing how to correctly make service calls usin
### Snap Picture and Save Locally
-This example script shows how to take a picture with your camera, named `My Camera` in your Blink app (this is **not necessarily** the friendly name in home-assistant). After snapping a picture, the image will then be saved to a local directory called `/tmp/my_image.jpg`. Note that this example makes use of services found in the [camera integration](https://www.home-assistant.io/components/camera#service-snapshot)
+This example script shows how to take a picture with your camera, named `My Camera` in your Blink app (this is **not necessarily** the friendly name in home-assistant). After snapping a picture, the image will then be saved to a local directory called `/tmp/my_image.jpg`. Note that this example makes use of services found in the [camera integration](/components/camera#service-snapshot)
```yaml
alias: Blink Snap Picture
@@ -178,9 +172,9 @@ sequence:
### Arm Blink When Away
-This example automation will arm your blink sync module to detect motion on any of your blink cameras that have motion detection enabled. By default, Blink enables motion detection on all cameras so, unless you've changed anything in your app, you're all set. If you want to manually enable motion detection for individual cameras, you can utilize the [appropriate camera service](https://www.home-assistant.io/components/camera#service-enable_motion_detection) but pelase note that motion will only be captured if the sync module is armed.
+This example automation will arm your blink sync module to detect motion on any of your blink cameras that have motion detection enabled. By default, Blink enables motion detection on all cameras so, unless you've changed anything in your app, you're all set. If you want to manually enable motion detection for individual cameras, you can utilize the [appropriate camera service](/components/camera#service-enable_motion_detection) but pelase note that motion will only be captured if the sync module is armed.
-Here, this example assumes your blink module is named `My Sync Module` and that you have [device trackers](https://www.home-assistant.io/components/device_tracker) set up for presence detection.
+Here, this example assumes your blink module is named `My Sync Module` and that you have [device trackers](/components/device_tracker) set up for presence detection.
```yaml
- id: arm_blink_when_away
@@ -214,7 +208,7 @@ Similar to the previous example, this automation will disarm blink when arriving
When motion is detected, you can use the Blink Home-Assistant integration to save the last recorded video locally, rather than relying on Blink's servers to save your data.
-Again, this example assumes your camera's name (in the blink app) is `My Camera` and your sync module name is `My Sync Module`. The file will be saved to `/tmp/videos/blink_video_{YYYMMDD_HHmmSS}.mp4` where `{YYYYMMDD_HHmmSS}` will be a timestamp create via the use of [templating](https://www.home-assistant.io/docs/configuration/templating/).
+Again, this example assumes your camera's name (in the blink app) is `My Camera` and your sync module name is `My Sync Module`. The file will be saved to `/tmp/videos/blink_video_{YYYMMDD_HHmmSS}.mp4` where `{YYYYMMDD_HHmmSS}` will be a timestamp create via the use of [templating](/docs/configuration/templating/).
{% raw %}
```yaml
diff --git a/source/_components/blinksticklight.markdown b/source/_components/blinksticklight.markdown
index f0af6ec55de..0c5dab78c2f 100644
--- a/source/_components/blinksticklight.markdown
+++ b/source/_components/blinksticklight.markdown
@@ -1,12 +1,6 @@
---
-layout: page
title: "Blinkstick Light"
description: "Instructions on how to setup Blinkstick lights within Home Assistant."
-date: 2015-10-08 10:00
-sidebar: true
-comments: false
-sharing: true
-footer: true
logo: blinkstick.png
ha_category:
- DIY
diff --git a/source/_components/blinkt.markdown b/source/_components/blinkt.markdown
index 320c456c96c..97e62a71574 100644
--- a/source/_components/blinkt.markdown
+++ b/source/_components/blinkt.markdown
@@ -1,12 +1,6 @@
---
-layout: page
title: "Blinkt! Light"
description: "Instructions on how to setup Blinkt! RGB LED lights within Home Assistant."
-date: 2017-04-30 9:00
-sidebar: true
-comments: false
-sharing: true
-footer: true
logo: raspberry-pi.png
ha_category:
- DIY
diff --git a/source/_components/blockchain.markdown b/source/_components/blockchain.markdown
index aea54943db0..855d6f354d0 100644
--- a/source/_components/blockchain.markdown
+++ b/source/_components/blockchain.markdown
@@ -1,12 +1,6 @@
---
-layout: page
title: "Blockchain.info"
description: "Instructions on how to integrate Blockchain.info data within Home Assistant."
-date: 2017-06-01 16:20
-sidebar: true
-comments: false
-sharing: true
-footer: true
logo: blockchain.png
ha_category:
- Finance
@@ -34,6 +28,6 @@ sensor:
addresses:
description: List of bitcoin wallet addresses to watch.
required: true
- type: string, list
+ type: [string, list]
{% endconfiguration %}
diff --git a/source/_components/bloomsky.markdown b/source/_components/bloomsky.markdown
index 6f10f46ef47..6d0e4a0e7b2 100644
--- a/source/_components/bloomsky.markdown
+++ b/source/_components/bloomsky.markdown
@@ -1,12 +1,6 @@
---
-layout: page
title: "BloomSky"
description: "Instructions on how to integrate the BloomSky within Home Assistant."
-date: 2016-02-03 20:00
-sidebar: true
-comments: false
-sharing: true
-footer: true
logo: bloomsky.png
ha_category:
- Environment
diff --git a/source/_components/bluesound.markdown b/source/_components/bluesound.markdown
index 370c7a4ec39..4997a1c91cc 100644
--- a/source/_components/bluesound.markdown
+++ b/source/_components/bluesound.markdown
@@ -1,12 +1,6 @@
---
-layout: page
title: "Bluesound"
description: "Instructions on how to integrate Bluesound devices into Home Assistant."
-date: 2017-04-21 19:00
-sidebar: true
-comments: false
-sharing: true
-footer: true
logo: bluesound.png
ha_category:
- Media Player
diff --git a/source/_components/bluetooth_le_tracker.markdown b/source/_components/bluetooth_le_tracker.markdown
index aeb85d85692..2fa75a28a6a 100644
--- a/source/_components/bluetooth_le_tracker.markdown
+++ b/source/_components/bluetooth_le_tracker.markdown
@@ -1,12 +1,6 @@
---
-layout: page
title: "Bluetooth LE Tracker"
description: "Instructions for integrating bluetooth low-energy tracking within Home Assistant."
-date: 2016-08-24 00:00
-sidebar: true
-comments: false
-sharing: true
-footer: true
logo: bluetooth.png
ha_category:
- Presence Detection
diff --git a/source/_components/bluetooth_tracker.markdown b/source/_components/bluetooth_tracker.markdown
index 26ee8eae907..6a23df6d4f1 100644
--- a/source/_components/bluetooth_tracker.markdown
+++ b/source/_components/bluetooth_tracker.markdown
@@ -1,12 +1,6 @@
---
-layout: page
title: "Bluetooth Tracker"
description: "Instructions for integrating Bluetooth tracking within Home Assistant."
-date: 2016-04-10 17:24
-sidebar: true
-comments: false
-sharing: true
-footer: true
logo: bluetooth.png
ha_category:
- Presence Detection
diff --git a/source/_components/bme280.markdown b/source/_components/bme280.markdown
index 501fca6feff..cb6fb70243d 100644
--- a/source/_components/bme280.markdown
+++ b/source/_components/bme280.markdown
@@ -1,12 +1,6 @@
---
-layout: page
title: "BME280 Sensor"
description: "Instructions on how to integrate a BME280 sensor into Home Assistant."
-date: 2017-06-10 00:00
-sidebar: true
-comments: false
-sharing: true
-footer: true
logo: raspberry-pi.png
ha_category:
- DIY
diff --git a/source/_components/bme680.markdown b/source/_components/bme680.markdown
index b4b99793268..d7c64777d27 100644
--- a/source/_components/bme680.markdown
+++ b/source/_components/bme680.markdown
@@ -1,12 +1,6 @@
---
-layout: page
title: "BME680 Sensor"
description: "Instructions on how to integrate a BME680 sensor into Home Assistant."
-date: 2018-01-16 00:00
-sidebar: true
-comments: false
-sharing: true
-footer: true
logo: raspberry-pi.png
ha_category:
- DIY
diff --git a/source/_components/bmw_connected_drive.markdown b/source/_components/bmw_connected_drive.markdown
index 0adea3cfc35..d23503603c1 100644
--- a/source/_components/bmw_connected_drive.markdown
+++ b/source/_components/bmw_connected_drive.markdown
@@ -1,12 +1,6 @@
---
-layout: page
title: "BMW Connected Drive"
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
diff --git a/source/_components/bom.markdown b/source/_components/bom.markdown
index ec69cbff90a..e8e86e3b870 100644
--- a/source/_components/bom.markdown
+++ b/source/_components/bom.markdown
@@ -1,12 +1,6 @@
---
-layout: page
title: "BOM Australia"
description: "Instructions on how to integrate Bureau of Meteorology Australia weather conditions into Home Assistant."
-date: 2016-09-29 09:00
-sidebar: true
-comments: false
-sharing: true
-footer: true
logo: bom.png
ha_category:
- Weather
@@ -39,19 +33,21 @@ weather:
{% configuration %}
name:
description: The name you would like to give to the weather station.
- required: optional
+ required: false
type: string
station:
description: "The station ID string. See the [`sensor.bom` docs](#sensor) for details on how to find the ID of a station."
- required: optional
+ required: false
type: string
default: The closest station
{% endconfiguration %}
-
+
+
This platform is an alternative to the [`bom`](#sensor) sensor.
The weather platform is easier to configure but less customizable.
-
+
+
## Camera
@@ -283,7 +279,9 @@ monitored_conditions:
description: Wind speed in kt.
{% endconfiguration %}
-
+
+
This sensor is an alternative to the [`bom`](#configuration) weather platform.
The weather platform is easier to configure but less customisable.
-
+
+
diff --git a/source/_components/braviatv.markdown b/source/_components/braviatv.markdown
index 4e87c7362fd..187fd9cc4a9 100644
--- a/source/_components/braviatv.markdown
+++ b/source/_components/braviatv.markdown
@@ -1,12 +1,6 @@
---
-layout: page
title: "Sony Bravia TV"
description: "Instructions on how to integrate a Sony Bravia TV into Home Assistant."
-date: 2016-07-01 08:00
-sidebar: true
-comments: false
-sharing: true
-footer: true
logo: bravia.png
ha_category:
- Media Player
diff --git a/source/_components/broadcast.markdown b/source/_components/broadcast.markdown
index 806ee3253aa..58dad653bef 100644
--- a/source/_components/broadcast.markdown
+++ b/source/_components/broadcast.markdown
@@ -1,12 +1,6 @@
---
-layout: page
title: "Telegram broadcast"
description: "Telegram support to send messages only"
-date: 2017-06-24 11:20
-sidebar: true
-comments: false
-sharing: true
-footer: true
logo: telegram.png
ha_category:
- Notifications
diff --git a/source/_components/broadlink.markdown b/source/_components/broadlink.markdown
index cefa1cd990e..ff8b32e040e 100644
--- a/source/_components/broadlink.markdown
+++ b/source/_components/broadlink.markdown
@@ -1,12 +1,6 @@
---
-layout: page
title: "Broadlink"
description: "Instructions on how to integrate Broadlink within Home Assistant."
-date: 2016-11-22 22:41
-sidebar: true
-comments: false
-sharing: true
-footer: true
logo: broadlink.png
ha_category:
- Switch
@@ -52,7 +46,7 @@ name:
description: Sensor name.
required: false
default: Broadlink sensor
- type: String
+ type: string
scan_interval:
description: Time in seconds to fetch data from sensors.
required: false
@@ -112,9 +106,11 @@ sensor:
### Microsoft Windows installation
-
+
+
The pycrypto library needs to be available on your platform. On a typical windows sysytem `pip install pycrypto` will fail, as a compiler needs to be installed first.
-
+
+
The quickest way around this is to use a pre-built binary, e.g., from [https://github.com/sfbahr/PyCrypto-Wheels](https://github.com/sfbahr/PyCrypto-Wheels)
@@ -159,12 +155,12 @@ friendly_name:
type: string
type:
description: "Switch type. Choose one from: `rm`, `rm2`, `rm_mini`, `rm_pro_phicomm`, `rm2_home_plus`, `rm2_home_plus_gdt`, `rm2_pro_plus`, `rm2_pro_plus2`, `rm2_pro_plus_bl`, `rm_mini_shate`, `sp1`, `sp2`, `honeywell_sp2`, `sp3`, `spmini2`, `spminiplus` or `mp1`. `SC1` devices can be registered as `sp2`."
- required: true/false
+ required: true
type: string
switches:
description: The array that contains all switches.
required: false
- type: array
+ type: map
keys:
identifier:
description: Name of the command switch as slug. Multiple entries are possible.
@@ -186,7 +182,7 @@ switches:
slots:
description: Friendly names of 4 slots of MP1 power strip. If not configured, slot name will be `switch's friendly_name + 'slot {slot_index}'`. e.g 'MP1 slot 1'
required: false
- type: array
+ type: map
keys:
slot_1:
description: Friendly names of slot 1
diff --git a/source/_components/brottsplatskartan.markdown b/source/_components/brottsplatskartan.markdown
index 008a2d906da..2a27ef21ec1 100644
--- a/source/_components/brottsplatskartan.markdown
+++ b/source/_components/brottsplatskartan.markdown
@@ -1,12 +1,6 @@
---
-layout: page
title: "Brottsplatskartan"
description: "Instructions on how to integrate brottsplatskartan.se into Home Assistant."
-date: 2018-12-02 20:00
-sidebar: true
-comments: false
-sharing: true
-footer: true
ha_category:
- Social
logo: brottsplatskartan.png
@@ -40,10 +34,12 @@ area:
latitude:
description: Latitude for sensor.
required: false
+ type: float
default: Your home zone latitude defined in your configuration.
longitude:
description: Longitude for sensor.
required: false
+ type: float
default: Your home zone longitude defined in your configuration.
{% endconfiguration %}
diff --git a/source/_components/browser.markdown b/source/_components/browser.markdown
index b33e41d1c47..ba23cbeba4f 100644
--- a/source/_components/browser.markdown
+++ b/source/_components/browser.markdown
@@ -1,12 +1,6 @@
---
-layout: page
title: "Browser"
description: "Instructions on how to setup the browser integration with Home Assistant."
-date: 2015-01-24 14:39
-sidebar: true
-comments: false
-sharing: true
-footer: true
logo: home-assistant.png
ha_category:
- Utility
diff --git a/source/_components/brunt.markdown b/source/_components/brunt.markdown
index 20bbf768da0..12a252fd657 100644
--- a/source/_components/brunt.markdown
+++ b/source/_components/brunt.markdown
@@ -1,12 +1,6 @@
---
-layout: page
title: Brunt Cover
description: "Instructions on how to set up Brunt Blind Engine within Home Assistant."
-date: 2018-06-24 14:36
-sidebar: true
-comments: false
-sharing: true
-footer: true
logo: brunt.png
ha_category:
- Cover
@@ -45,6 +39,6 @@ password:
type: string
{% endconfiguration %}
-
+
This integration is not affiliated with Brunt and retrieves data from the endpoints of the mobile application. Use at your own risk.
-
+
diff --git a/source/_components/bt_home_hub_5.markdown b/source/_components/bt_home_hub_5.markdown
index ec1326906fa..6d8216cdc9b 100644
--- a/source/_components/bt_home_hub_5.markdown
+++ b/source/_components/bt_home_hub_5.markdown
@@ -1,12 +1,6 @@
---
-layout: page
title: "BT Home Hub 5"
description: "Instructions on how to integrate BT Home Hub 5 router into Home Assistant."
-date: 2016-06-13 13:00
-sidebar: true
-comments: false
-sharing: true
-footer: true
logo: bt.png
ha_category:
- Presence Detection
diff --git a/source/_components/bt_smarthub.markdown b/source/_components/bt_smarthub.markdown
index b550004018d..07ad84467f7 100644
--- a/source/_components/bt_smarthub.markdown
+++ b/source/_components/bt_smarthub.markdown
@@ -1,12 +1,6 @@
---
-layout: page
title: "BT Smart Hub"
description: "Instructions on how to integrate BT Smart Hub router into Home Assistant."
-date: 2018-10-05 10:00
-sidebar: true
-comments: false
-sharing: true
-footer: true
logo: bt.png
ha_category:
- Presence Detection
diff --git a/source/_components/buienradar.markdown b/source/_components/buienradar.markdown
index 2931cd336f8..3eda01e9741 100644
--- a/source/_components/buienradar.markdown
+++ b/source/_components/buienradar.markdown
@@ -1,12 +1,6 @@
---
-layout: page
title: "Buienradar"
description: "Instructions on how to integrate buienradar.nl weather within Home Assistant."
-date: 2017-05-15 14:00
-sidebar: true
-comments: false
-sharing: true
-footer: true
logo: buienradar.png
ha_category:
- Weather
@@ -65,10 +59,12 @@ weather:
forecast: true
```
-
+
+
This platform is an alternative to the [`buienradar`](/components/sensor.buienradar/) sensor.
The weather platform is easier to configure but less customizable.
-
+
+
[Usage statement:](https://www.buienradar.nl/overbuienradar/gratis-weerdata)
> Buienradar makes free weather data available for use by individuals and businesses (website/intranet). The use of the weather data is allowed for **non-commercial purposes**. Please refer to the full usage statement linked above to confirm your use or to request permission.
diff --git a/source/_components/caldav.markdown b/source/_components/caldav.markdown
index 64bf40cd27d..f7fd60842d9 100644
--- a/source/_components/caldav.markdown
+++ b/source/_components/caldav.markdown
@@ -1,12 +1,6 @@
---
-layout: page
title: "CalDav"
description: "Instructions on how to integrate a WebDav calendar into Home Assistant."
-date: 2017-11-27 23:14
-sidebar: true
-comments: false
-sharing: true
-footer: true
ha_category:
- Calendar
ha_iot_class: Cloud Polling
diff --git a/source/_components/calendar.google.markdown b/source/_components/calendar.google.markdown
index 9ee52b731e1..1c54c4fdc0a 100644
--- a/source/_components/calendar.google.markdown
+++ b/source/_components/calendar.google.markdown
@@ -1,12 +1,6 @@
---
-layout: page
title: "Google Calendar Event"
description: "Instructions on how to use Google Calendars in Home Assistant."
-date: 2015-05-08 17:15
-sidebar: true
-comments: false
-sharing: true
-footer: true
logo: google_calendar.png
ha_category:
- Calendar
@@ -30,14 +24,14 @@ Generate a Client ID and Client Secret on
1. Follow the wizard using the following information.
1. When it gets to the point of asking _Which API are you using?_ just click cancel.
1. Under APIs & Services > Credentials, click on the tab 'OAuth consent screen'.
-1. Set 'Product name shown to users' to anything you want. We suggest "Home-Assistant".
+1. Set the 'Application Name' (the name of the application asking for consent) to anything you want. We suggest "Home-Assistant".
1. Save this page. You don't have to fill out anything else there.
1. Click 'Create credentials' -> OAuth client ID.
1. Set the Application type to 'Other' and give this credential set a name then click Create.
-1. Save the client ID and secret as you will need to put these in your `configuration.yaml` file.
-1. Click on "Library", search for "Google Calendar API" and enable it.
+1. Copy the client ID and secret to a text editor temporarily as you will need to put these in your `configuration.yaml` file.
+1. Under "API's and Services" (left sidebar), click on "Library." Search for "Google Calendar API" and enable it if it isn't already enabled automatically through this process.
-If you are adding more Google API scopes later to the OAuth than just "Google Calendar API" then you need to delete your token file. You will lose your refresh token due to the re-authenticating to add more API access. It's recommended to use different authorizations for different pieces of Google.
+If you will be adding more scopes than just the "Google Calendar API" to the OAuth for this application, you will need to delete your token file. You will lose your refresh token due to the re-authenticating to add more API access. It's recommended to use different authorizations for different pieces of Google.
## Configuration
@@ -127,6 +121,7 @@ entities:
description: "Should we create a sensor `true` or ignore it `false`?"
required: true
type: boolean
+ default: true
search:
description: If set will only trigger for matched events.
required: false
@@ -147,7 +142,7 @@ entities:
max_results:
description: "Max number of entries to retrieve"
required: false
- type: int
+ type: integer
default: 5
{% endconfiguration %}
@@ -160,10 +155,12 @@ not filter events out and always show the next event available.
But what if you only wanted it to toggle based on all events?
Just leave out the *search* parameter.
-
+
+
If you use a `#` sign for `search` then wrap the whole search term in quotes.
Otherwise everything following the hash sign would be considered a YAML comment.
-
+
+
### Sensor attributes
@@ -190,9 +187,11 @@ You can use the service `google.add_event` to create a new calendar event in a c
| `end_date` | yes | The date the whole day event should end. | 2019-03-11
| `in` | yes | Days or weeks that you want to create the event in. | "days": 2
-
+
+
You either use `start_date_time` and `end_date_time`, or `start_date` and `end_date`, or `in`.
-
+
+
## Using calendar in automations
diff --git a/source/_components/calendar.markdown b/source/_components/calendar.markdown
index 921aadb1d48..b26bd510275 100644
--- a/source/_components/calendar.markdown
+++ b/source/_components/calendar.markdown
@@ -1,12 +1,6 @@
---
-layout: page
title: "Calendar"
description: "Instructions on how to integrate calendars within Home Assistant."
-date: 2016-11-19 08:36
-sidebar: true
-comments: false
-sharing: true
-footer: true
ha_release: 0.33
---
diff --git a/source/_components/camera.ffmpeg.markdown b/source/_components/camera.ffmpeg.markdown
index 3240f027f2e..403e274b2cf 100644
--- a/source/_components/camera.ffmpeg.markdown
+++ b/source/_components/camera.ffmpeg.markdown
@@ -1,12 +1,6 @@
---
-layout: page
title: "FFmpeg Camera"
description: "Instructions on how to integrate a video feed via FFmpeg as a camera within Home Assistant."
-date: 2016-08-13 08:00
-sidebar: true
-comments: false
-sharing: true
-footer: true
logo: ffmpeg.png
ha_category:
- Camera
diff --git a/source/_components/camera.markdown b/source/_components/camera.markdown
index 22eba9e3fbf..1ba029c33f7 100644
--- a/source/_components/camera.markdown
+++ b/source/_components/camera.markdown
@@ -1,12 +1,6 @@
---
-layout: page
title: "Camera"
description: "Instructions on how to integrate cameras within Home Assistant."
-date: 2015-11-09 08:36
-sidebar: true
-comments: false
-sharing: true
-footer: true
logo: home-assistant.png
ha_category:
- Camera
diff --git a/source/_components/camera.mqtt.markdown b/source/_components/camera.mqtt.markdown
index b3574c644e8..68a06eb5659 100644
--- a/source/_components/camera.mqtt.markdown
+++ b/source/_components/camera.mqtt.markdown
@@ -1,12 +1,6 @@
---
-layout: page
title: "MQTT Camera"
description: "Instructions on how to use an MQTT image message as a Camera within Home Assistant."
-date: 2017-04-14 00:45
-sidebar: true
-comments: false
-sharing: true
-footer: true
logo: mqtt.png
ha_category:
- Camera
@@ -50,7 +44,7 @@ device:
identifiers:
description: 'A list of IDs that uniquely identify the device. For example a serial number.'
required: false
- type: list, string
+ type: [list, string]
connections:
description: 'A list of connections of the device to the outside world as a list of tuples `[connection_type, connection_identifier]`. For example the MAC address of a network interface: `"connections": ["mac", "02:5b:26:a8:dc:12"]`.'
required: false
diff --git a/source/_components/canary.markdown b/source/_components/canary.markdown
index 3ecdd85df5a..9afab99c4fb 100644
--- a/source/_components/canary.markdown
+++ b/source/_components/canary.markdown
@@ -1,12 +1,6 @@
---
-layout: page
title: "Canary"
description: "Instructions on how to integrate your Canary devices into Home Assistant."
-date: 2017-12-07 22:00
-sidebar: true
-comments: false
-sharing: true
-footer: true
logo: canary.png
ha_category:
- Alarm
diff --git a/source/_components/cast.markdown b/source/_components/cast.markdown
index 02d31753b95..21f939240e1 100644
--- a/source/_components/cast.markdown
+++ b/source/_components/cast.markdown
@@ -1,12 +1,6 @@
---
-layout: page
title: "Google Cast"
description: "Instructions on how to integrate Google Cast into Home Assistant."
-date: 2015-03-23 19:59
-sidebar: true
-comments: false
-sharing: true
-footer: true
logo: google_cast.png
ha_category:
- Media Player
@@ -38,9 +32,9 @@ cast:
- host: 192.168.1.10
```
-
+
You may need to enable Multicast DNS (MDNS) on your router if you are on a different subnet or VLAN.
-
+
{% configuration %}
media_player:
diff --git a/source/_components/cert_expiry.markdown b/source/_components/cert_expiry.markdown
index e6719b83b4f..fd73e961fed 100644
--- a/source/_components/cert_expiry.markdown
+++ b/source/_components/cert_expiry.markdown
@@ -1,12 +1,6 @@
---
-layout: page
title: "Certificate Expiry"
description: "Instructions on how to set up HTTPS (SSL) certificate expiry sensors within Home Assistant."
-date: 2017-04-24 14:14
-sidebar: true
-comments: false
-sharing: true
-footer: true
logo: home-assistant.png
ha_category:
- Network
@@ -46,6 +40,6 @@ name:
type: string
{% endconfiguration %}
-
+
Make sure that the URL exactly matches your endpoint or resource.
-
+
diff --git a/source/_components/channels.markdown b/source/_components/channels.markdown
index 9ab1f12dc0d..88f2e4c29a8 100644
--- a/source/_components/channels.markdown
+++ b/source/_components/channels.markdown
@@ -1,12 +1,6 @@
---
-layout: page
title: "Channels"
description: "Instructions on how to integrate Channels into Home Assistant."
-date: 2018-03-06 11:00
-sidebar: true
-comments: false
-sharing: true
-footer: true
logo: channels.png
ha_category:
- Media Player
diff --git a/source/_components/cisco_ios.markdown b/source/_components/cisco_ios.markdown
index 9a33ccc101a..0f3eb664c9e 100644
--- a/source/_components/cisco_ios.markdown
+++ b/source/_components/cisco_ios.markdown
@@ -1,12 +1,6 @@
---
-layout: page
title: "Cisco IOS"
description: "Instructions on how to integrate Cisco IOS routers into Home Assistant."
-date: 2016-11-07 19:59
-sidebar: true
-comments: false
-sharing: true
-footer: true
logo: cisco.png
ha_category:
- Presence Detection
@@ -17,9 +11,9 @@ redirect_from:
This is a presence detection scanner for [Cisco](http://www.cisco.com) IOS devices.
-
+
This device tracker needs SSH to be enabled on the router.
-
+
Before using this scanner it is recommended that you lower the ARP cache timeout on your router, as Cisco IOS normally comes with a 4 hour default ARP cache timeout.
@@ -45,9 +39,11 @@ arp timeout 120
copy running-config startup-config
```
-
+
+
If you have a very large number of devices on your VLan (+1000), then you may want to adjust the ARP cache timeout to suit your needs. See [this discussion](https://supportforums.cisco.com/discussion/10169296/arp-timeout) to learn more.
-
+
+
To use this device tracker in your installation, add the following to your `configuration.yaml` file:
diff --git a/source/_components/cisco_mobility_express.markdown b/source/_components/cisco_mobility_express.markdown
index f5878c778d4..e5a20190310 100644
--- a/source/_components/cisco_mobility_express.markdown
+++ b/source/_components/cisco_mobility_express.markdown
@@ -1,12 +1,6 @@
---
-layout: page
title: "Cisco Mobility Express"
description: "Instructions on how to integrate Cisco Mobility Express wireless controllers into Home Assistant."
-date: 2019-02-27 11:59
-sidebar: true
-comments: false
-sharing: true
-footer: true
logo: cisco.png
ha_category:
- Presence Detection
diff --git a/source/_components/cisco_webex_teams.markdown b/source/_components/cisco_webex_teams.markdown
index 149fbea8f53..cb3e793b2ae 100644
--- a/source/_components/cisco_webex_teams.markdown
+++ b/source/_components/cisco_webex_teams.markdown
@@ -1,12 +1,6 @@
---
-layout: page
title: "Cisco Webex Teams"
description: "Instructions on how to add Cisco Webex Teams notifications to Home Assistant."
-date: 2017-02-20 15:00
-sidebar: true
-comments: false
-sharing: true
-footer: true
logo: cisco_webex_teams.png
ha_category:
- Notifications
diff --git a/source/_components/ciscospark.markdown b/source/_components/ciscospark.markdown
index d7e95ef19a9..dbb98889968 100644
--- a/source/_components/ciscospark.markdown
+++ b/source/_components/ciscospark.markdown
@@ -1,12 +1,6 @@
---
-layout: page
title: "Cisco Spark"
description: "Instructions on how to add CiscoSpark notifications to Home Assistant."
-date: 2017-02-20 15:00
-sidebar: true
-comments: false
-sharing: true
-footer: true
logo: ciscospark.png
ha_category:
- Notifications
diff --git a/source/_components/citybikes.markdown b/source/_components/citybikes.markdown
index aa904d95091..fa86b793def 100644
--- a/source/_components/citybikes.markdown
+++ b/source/_components/citybikes.markdown
@@ -1,12 +1,6 @@
---
-layout: page
title: "CityBikes Sensor"
description: "Instructions on how to integrate data from the CityBikes API into Home Assistant."
-date: 2017-06-25 14:20
-sidebar: true
-comments: false
-sharing: true
-footer: true
logo: citybikes.png
ha_category:
- Transport
diff --git a/source/_components/clementine.markdown b/source/_components/clementine.markdown
index 3152d3859ac..03f0c7f2642 100644
--- a/source/_components/clementine.markdown
+++ b/source/_components/clementine.markdown
@@ -1,12 +1,6 @@
---
-layout: page
title: "Clementine Music Player"
description: "Instructions on how to integrate Clementine Music Player within Home Assistant."
-date: 2017-02-11 17:15
-sidebar: true
-comments: false
-sharing: true
-footer: true
logo: clementine.png
ha_category:
- Media Player
diff --git a/source/_components/clickatell.markdown b/source/_components/clickatell.markdown
index 0c2ccc317d3..e81970fcb81 100644
--- a/source/_components/clickatell.markdown
+++ b/source/_components/clickatell.markdown
@@ -1,12 +1,6 @@
---
-layout: page
title: "Clickatell SMS"
description: "Instructions on how to add Clickatell notifications to Home Assistant."
-date: 2017-10-09 00:00
-sidebar: true
-comments: false
-sharing: true
-footer: true
logo: clickatell.png
ha_category:
- Notifications
diff --git a/source/_components/clicksend.markdown b/source/_components/clicksend.markdown
index e83092f9844..3e63c1a7fe2 100644
--- a/source/_components/clicksend.markdown
+++ b/source/_components/clicksend.markdown
@@ -1,12 +1,6 @@
---
-layout: page
title: "ClickSend SMS"
description: "Instructions on how to add ClickSend notifications to Home Assistant."
-date: 2017-06-22 00:00
-sidebar: true
-comments: false
-sharing: true
-footer: true
logo: clicksend.png
ha_category:
- Notifications
@@ -15,7 +9,6 @@ redirect_from:
- /components/notify.clicksend/
---
-
The `clicksend` platform uses [ClickSend](https://clicksend.com) to deliver notifications from Home Assistant.
## Prerequisites
@@ -60,7 +53,7 @@ api_key:
recipient:
description: "A single or multiple phone numbers. This is where you want to send your SMS notification messages, e.g., `09171234567` or `[09171234567, 09177654321]`."
required: true
- type: string or list
+ type: [string, list]
sender:
description: The name or number of the sender.
required: false
diff --git a/source/_components/clicksend_tts.markdown b/source/_components/clicksend_tts.markdown
index 2f3d9a74e1e..e724655bf57 100644
--- a/source/_components/clicksend_tts.markdown
+++ b/source/_components/clicksend_tts.markdown
@@ -1,12 +1,6 @@
---
-layout: page
title: "ClickSend text-to-speech"
description: "Instructions on how to add ClickSend text-to-speech (TTS) notifications to Home Assistant."
-date: 2017-10-04 00:00
-sidebar: true
-comments: false
-sharing: true
-footer: true
logo: clicksend.png
ha_category:
- Notifications
diff --git a/source/_components/climate.knx.markdown b/source/_components/climate.knx.markdown
index 13e8c7640e0..9abcffc5443 100644
--- a/source/_components/climate.knx.markdown
+++ b/source/_components/climate.knx.markdown
@@ -1,12 +1,6 @@
---
-layout: page
title: "KNX Climate"
description: "Instructions on how to integrate KNX thermostats with Home Assistant."
-date: 2016-06-24 12:00
-sidebar: true
-comments: false
-sharing: true
-footer: true
logo: knx.png
ha_category:
- Climate
@@ -165,7 +159,7 @@ operation_mode_comfort_address:
operation_modes:
description: Overrides the supported operation modes.
required: false
- type: array
+ type: list
on_off_address:
description: KNX address for switching the climate device on/off.
required: false
diff --git a/source/_components/climate.markdown b/source/_components/climate.markdown
index c9c623ecb88..8431c9f216f 100644
--- a/source/_components/climate.markdown
+++ b/source/_components/climate.markdown
@@ -1,12 +1,6 @@
---
-layout: page
title: "Climate"
description: "Instructions on how to setup climate control devices within Home Assistant."
-date: 2016-08-26 19:00
-sidebar: true
-comments: false
-sharing: true
-footer: true
logo: home-assistant.png
ha_category:
- Climate
@@ -22,9 +16,11 @@ The `climate` integration is built for the controlling and monitoring of HVAC (h
Available services: `climate.set_aux_heat`, `climate.set_preset_mode`, `climate.set_temperature`, `climate.set_humidity`, `climate.set_fan_mode`, `climate.set_hvac_mode`, `climate.set_swing_mode`, `climate.turn_on`, `climate.turn_off`
-
+
\
+
Not all climate services may be available for your platform. Be sure to check the available services Home Assistant has enabled by checking
**Services**.
-
+
+
+
The "free" API key is limited to a limited number of calls. Too many requests can result in data loss.
-
+
## Configuration
diff --git a/source/_components/coinbase.markdown b/source/_components/coinbase.markdown
index 22854c1ca44..34a9bdb6969 100644
--- a/source/_components/coinbase.markdown
+++ b/source/_components/coinbase.markdown
@@ -1,12 +1,6 @@
---
-layout: page
title: "Coinbase"
description: "Instructions for how to add Coinbase sensors to Home Assistant."
-date: 2017-12-08 17:54
-sidebar: true
-comments: false
-sharing: true
-footer: true
logo: coinbase.png
ha_category:
- Finance
diff --git a/source/_components/coinmarketcap.markdown b/source/_components/coinmarketcap.markdown
index 86190bc4be4..1bc5ed1ef7d 100644
--- a/source/_components/coinmarketcap.markdown
+++ b/source/_components/coinmarketcap.markdown
@@ -1,12 +1,6 @@
---
-layout: page
title: "CoinMarketCap"
description: "Instructions on how to integrate CoinMarketCap data within Home Assistant."
-date: 2016-08-31 08:15
-sidebar: true
-comments: false
-sharing: true
-footer: true
logo: coinmarketcap.png
ha_category:
- Finance
diff --git a/source/_components/comed_hourly_pricing.markdown b/source/_components/comed_hourly_pricing.markdown
index 0128b33836b..7079fe6a495 100644
--- a/source/_components/comed_hourly_pricing.markdown
+++ b/source/_components/comed_hourly_pricing.markdown
@@ -1,12 +1,6 @@
---
-layout: page
title: "ComEd Hourly Pricing"
description: "Instructions on how to set up the ComEd Hourly Pricing sensor in Home Assistant."
-date: 2017-03-02 0:15
-sidebar: true
-comments: false
-sharing: true
-footer: true
logo: comed.png
ha_category:
- Energy
diff --git a/source/_components/comfoconnect.markdown b/source/_components/comfoconnect.markdown
index da74d90b9d7..c3aa788ed76 100644
--- a/source/_components/comfoconnect.markdown
+++ b/source/_components/comfoconnect.markdown
@@ -1,12 +1,6 @@
---
-layout: page
title: "Zehnder ComfoAir Q Ventilation"
description: "Instructions on how to integrate Zehnder ComfoAir Q350/450/600 ventilation systems into Home Assistant."
-date: 2017-06-28 18:00
-sidebar: true
-comments: false
-sharing: true
-footer: true
logo: zehnder.png
ha_category:
- Fan
@@ -74,6 +68,6 @@ sensor:
- air_flow_exhaust
```
-
+
Note that it's not possible to have multiple connection to the bridge at the same time. This integration will keep the connection open, and if you open the app, it will ask you to disconnect Home Assistant. If you close the app again, Home Assistant will reconnect automatically.
-
+
diff --git a/source/_components/command_line.markdown b/source/_components/command_line.markdown
index 7c182c757bc..9761296bdaf 100644
--- a/source/_components/command_line.markdown
+++ b/source/_components/command_line.markdown
@@ -1,12 +1,6 @@
---
-layout: page
title: "Command line Binary Sensor"
description: "Instructions on how to integrate Command binary sensors within Home Assistant."
-date: 2016-01-13 12:15
-sidebar: true
-comments: false
-sharing: true
-footer: true
logo: command_line.png
ha_category:
- Utility
@@ -28,9 +22,12 @@ binary_sensor:
- platform: command_line
command: 'cat /proc/sys/net/ipv4/ip_forward'
```
-
+
+
+
It's highly recommended to enclose the command in single quotes `'` as it ensures all characters can be used in the command and reduces the risk of unintentional escaping. To include a single quote in a command enclosed in single quotes, double it: `''`.
-
+
+
{% configuration %}
command:
diff --git a/source/_components/concord232.markdown b/source/_components/concord232.markdown
index 9c9a051fdb8..cc4fb988d7b 100644
--- a/source/_components/concord232.markdown
+++ b/source/_components/concord232.markdown
@@ -1,12 +1,6 @@
---
-layout: page
title: "Concord232"
description: "Instructions on how to integrate Interlogix/GE Concord4 into Home Assistant."
-date: 2016-10-11 10:00
-sidebar: true
-comments: false
-sharing: true
-footer: true
logo: interlogix.png
ha_category:
- Alarm
diff --git a/source/_components/config.markdown b/source/_components/config.markdown
index d11115d8519..90615cb5576 100644
--- a/source/_components/config.markdown
+++ b/source/_components/config.markdown
@@ -1,12 +1,6 @@
---
-layout: page
title: "Config"
description: "Instructions on how to setup the configuration panel for Home Assistant."
-date: 2017-02-24 20:00
-sidebar: true
-comments: false
-sharing: true
-footer: true
logo: home-assistant.png
ha_category:
- Front end
diff --git a/source/_components/configurator.markdown b/source/_components/configurator.markdown
index 296c74560e6..763a7e493d6 100644
--- a/source/_components/configurator.markdown
+++ b/source/_components/configurator.markdown
@@ -1,12 +1,6 @@
---
-layout: page
title: "Configurator"
description: "Instructions on how to integrate the configurator in your components."
-date: 2015-03-15 00:51
-sidebar: true
-comments: false
-sharing: true
-footer: true
logo: home-assistant.png
ha_category:
- Other
@@ -14,9 +8,9 @@ ha_qa_scale: internal
ha_release: 0.7
---
-
+
This integration is intended for developers.
-
+
The configurator integration allows integrations to request information from the user. It is currently implemented as the minimum viable product:
diff --git a/source/_components/conversation.markdown b/source/_components/conversation.markdown
index dd8a5fcb2de..a0672636102 100644
--- a/source/_components/conversation.markdown
+++ b/source/_components/conversation.markdown
@@ -1,12 +1,6 @@
---
-layout: page
title: "Conversation"
description: "Instructions on how to have conversations with your Home Assistant."
-date: 2015-03-15 00:39
-sidebar: true
-comments: false
-sharing: true
-footer: true
logo: home-assistant.png
ha_category:
- "Voice"
diff --git a/source/_components/coolmaster.markdown b/source/_components/coolmaster.markdown
index e11d76da089..87f7f0714da 100644
--- a/source/_components/coolmaster.markdown
+++ b/source/_components/coolmaster.markdown
@@ -1,12 +1,6 @@
---
-layout: page
title: "CoolMasterNet Climate"
description: "Instructions on how to integrate CoolMasterNet within Home Assistant."
-date: 2019-02-05 00:00
-sidebar: true
-comments: false
-sharing: true
-footer: true
logo: coolautomation.png
ha_category:
- Climate
diff --git a/source/_components/counter.markdown b/source/_components/counter.markdown
index 1c4a493efcd..8449140c273 100644
--- a/source/_components/counter.markdown
+++ b/source/_components/counter.markdown
@@ -1,12 +1,6 @@
---
-layout: page
title: "Counter"
description: "Instructions on how to integrate counters into Home Assistant."
-date: 2017-08-26 06:00
-sidebar: true
-comments: false
-sharing: true
-footer: true
logo: home-assistant.png
ha_category:
- Automation
diff --git a/source/_components/cover.command_line.markdown b/source/_components/cover.command_line.markdown
index 8326fc6ea04..b0053579b54 100644
--- a/source/_components/cover.command_line.markdown
+++ b/source/_components/cover.command_line.markdown
@@ -1,12 +1,6 @@
---
-layout: page
title: "Command Line Cover"
description: "How to control a cover with the command line."
-date: 2016-06-28 17:30
-sidebar: true
-comments: false
-sharing: true
-footer: true
logo: command_line.png
ha_category:
- Cover
diff --git a/source/_components/cover.group.markdown b/source/_components/cover.group.markdown
index 824ab062413..999daeee25b 100644
--- a/source/_components/cover.group.markdown
+++ b/source/_components/cover.group.markdown
@@ -1,12 +1,6 @@
---
-layout: page
title: "Cover Group"
description: "Instructions how to setup grouped covers in Home Assistant."
-date: 2018-02-11 10:00
-sidebar: true
-comments: false
-sharing: true
-footer: true
ha_category:
- Cover
ha_release: 0.66
@@ -37,7 +31,7 @@ cover:
entities:
description: List of all cover entities you want to control.
required: true
- type: [string | list]
+ type: [string, list]
{% endconfiguration %}
## Functionality
diff --git a/source/_components/cover.knx.markdown b/source/_components/cover.knx.markdown
index 606845df77c..e8f48ef6ca7 100644
--- a/source/_components/cover.knx.markdown
+++ b/source/_components/cover.knx.markdown
@@ -1,12 +1,6 @@
---
-layout: page
title: "KNX Cover"
description: "Instructions on how to integrate KNX covers with Home Assistant."
-date: 2017-06-18 12:00
-sidebar: true
-comments: false
-sharing: true
-footer: true
logo: knx.png
ha_category:
- Cover
diff --git a/source/_components/cover.markdown b/source/_components/cover.markdown
index a4fa15639e3..bcda65e85e6 100644
--- a/source/_components/cover.markdown
+++ b/source/_components/cover.markdown
@@ -1,12 +1,6 @@
---
-layout: page
title: "Covers"
description: "Instructions on how to integrate covers into Home Assistant."
-date: 2016-06-28 17:30
-sidebar: true
-comments: false
-sharing: true
-footer: true
logo: home-assistant.png
ha_category:
- Cover
diff --git a/source/_components/cover.mqtt.markdown b/source/_components/cover.mqtt.markdown
index 360e7284751..5d47ba55b8c 100644
--- a/source/_components/cover.mqtt.markdown
+++ b/source/_components/cover.mqtt.markdown
@@ -1,12 +1,6 @@
---
-layout: page
title: "MQTT Cover"
description: "Instructions on how to integrate MQTT covers into Home Assistant."
-date: 2016-09-28 17:30
-sidebar: true
-comments: false
-sharing: true
-footer: true
logo: mqtt.png
ha_category:
- Cover
@@ -202,7 +196,7 @@ device:
identifiers:
description: 'A list of IDs that uniquely identify the device. For example a serial number.'
required: false
- type: list, string
+ type: [list, string]
connections:
description: 'A list of connections of the device to the outside world as a list of tuples `[connection_type, connection_identifier]`. For example the MAC address of a network interface: `"connections": ["mac", "02:5b:26:a8:dc:12"]`.'
required: false
diff --git a/source/_components/cover.mysensors.markdown b/source/_components/cover.mysensors.markdown
index 02bf5333443..905d796a655 100644
--- a/source/_components/cover.mysensors.markdown
+++ b/source/_components/cover.mysensors.markdown
@@ -1,12 +1,6 @@
---
-layout: page
title: "MySensors Cover"
description: "Instructions on how to integrate MySensors covers into Home Assistant."
-date: 2016-10-01 15:00 +0200
-sidebar: true
-comments: false
-sharing: true
-footer: true
logo: mysensors.png
ha_category:
- DIY
diff --git a/source/_components/cover.rflink.markdown b/source/_components/cover.rflink.markdown
index 91148dd676d..38b2cff93df 100644
--- a/source/_components/cover.rflink.markdown
+++ b/source/_components/cover.rflink.markdown
@@ -1,12 +1,6 @@
---
-layout: page
title: "RFLink Cover"
description: "Instructions on how to integrate RFLink Somfy RTS Cover into Home Assistant."
-date: 2017-08-08
-sidebar: true
-comments: false
-sharing: true
-footer: true
logo: rflink.png
ha_category:
- Cover
diff --git a/source/_components/cover.rfxtrx.markdown b/source/_components/cover.rfxtrx.markdown
index 29bd8762549..3057625f566 100644
--- a/source/_components/cover.rfxtrx.markdown
+++ b/source/_components/cover.rfxtrx.markdown
@@ -1,12 +1,6 @@
---
-layout: page
title: "RFXtrx Cover"
description: "Instructions on how to integrate RFXtrx covers into Home Assistant."
-date: 2016-08-24 14:30
-sidebar: true
-comments: false
-sharing: true
-footer: true
logo: rfxtrx.png
ha_category:
- Cover
@@ -88,7 +82,7 @@ signal_repetitions:
type: integer
{% endconfiguration %}
-
+
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.
-
+
diff --git a/source/_components/cover.template.markdown b/source/_components/cover.template.markdown
index a363bd9cc49..951e750544a 100644
--- a/source/_components/cover.template.markdown
+++ b/source/_components/cover.template.markdown
@@ -1,12 +1,6 @@
---
-layout: page
title: "Template Cover"
description: "Instructions on how to integrate Template Covers into Home Assistant."
-date: 2017-06-19 20:32
-sidebar: true
-comments: false
-sharing: true
-footer: true
ha_category:
- Cover
ha_release: 0.48
diff --git a/source/_components/cover.xiaomi_aqara.markdown b/source/_components/cover.xiaomi_aqara.markdown
index ea8de2ac3fe..bd6f76d70d2 100644
--- a/source/_components/cover.xiaomi_aqara.markdown
+++ b/source/_components/cover.xiaomi_aqara.markdown
@@ -1,12 +1,6 @@
---
-layout: page
title: "Xiaomi Cover"
description: "Instructions on how to setup the Xiaomi cover within Home Assistant."
-date: 2017-07-21 16:34
-sidebar: true
-comments: false
-sharing: true
-footer: true
logo: xiaomi.png
ha_category:
- Cover
diff --git a/source/_components/cppm.markdown b/source/_components/cppm.markdown
index bdfb9c5b6b2..0414c51f099 100644
--- a/source/_components/cppm.markdown
+++ b/source/_components/cppm.markdown
@@ -1,12 +1,6 @@
---
-layout: page
title: "Aruba ClearPass"
description: "Instructions on how to integrate Aruba ClearPass into Home Assistant."
-date: 2019-03-05 10:45
-sidebar: true
-comments: false
-sharing: true
-footer: true
logo: aruba.png
ha_category:
- Presence Detection
@@ -20,9 +14,11 @@ Supported platforms (tested):
- Aruba ClearPass 6.7.5
-
+
+
You must first create an API client [here](https://clearpass.server.com/guest/api_clients.php).
-
+
+
To use this device tracker in your installation, add the following to your `configuration.yaml` file:
diff --git a/source/_components/cpuspeed.markdown b/source/_components/cpuspeed.markdown
index acd55e0bc84..35f93373062 100644
--- a/source/_components/cpuspeed.markdown
+++ b/source/_components/cpuspeed.markdown
@@ -1,12 +1,6 @@
---
-layout: page
title: "CPU speed"
description: "Instructions on how to integrate CPU speed within Home Assistant."
-date: 2015-10-15 11:00
-sidebar: true
-comments: false
-sharing: true
-footer: true
logo: cpu.png
ha_category:
- System Monitor
@@ -16,13 +10,13 @@ redirect_from:
- /components/sensor.cpuspeed/
---
-
The `cpuspeed` sensor platform to allow you to monitor the current CPU speed.
+
-
You can't use this sensor in a Container (like Hass.io) as it requires access to the physical CPU. Also, not all [ARM CPUs](https://github.com/workhorsy/py-cpuinfo/#cpu-support) are supported.
-
+
+
-If you want to communicate directly with the printer, you need the IP, the port number and the "Printer Name". Also your printer must support the IPP protocol. The port number is usually 631, while the "Printer Name" is usually "ipp/print". Remember to set "is_cups_server" to false.
-If the platform fails to load with those settings, you can look into the web interface of your printer for the port number and the "Printer Name". The procedure is different for different models.
+## Configuration
To enable the CUPS sensor, add the following lines to your `configuration.yaml`:
@@ -60,21 +57,3 @@ is_cups_server:
type: boolean
default: true
{% endconfiguration %}
-
-## {% linkable_title Examples %}
-
-Default configuration for an IPP printer:
-
-```yaml
-# Example configuration.yaml entry for an IPP printer
-sensor:
- - platform: cups
- host: PRINTER_IP
- is_cups_server: false
- printers:
- - ipp/print
-```
-
-
-You will need to install the `python3-dev` or `python3-devel` and the development files for CUPS (`libcups2-dev` or`cups-devel`) package on your system manually (eg. `sudo apt-get install python3-dev libcups2-dev` or `sudo dnf -y install python3-devel cups-devel`) along with a compiler (`gcc`).
-
diff --git a/source/_components/currencylayer.markdown b/source/_components/currencylayer.markdown
index d4ad7c6dc9b..cc3221508cf 100644
--- a/source/_components/currencylayer.markdown
+++ b/source/_components/currencylayer.markdown
@@ -1,12 +1,6 @@
---
-layout: page
title: "Currencylayer"
description: "Instructions on integrating exchange rates from https://currencylayer.com/ within Home Assistant."
-date: 2016-10-26 10:00
-sidebar: true
-comments: false
-sharing: true
-footer: true
ha_category:
- Finance
logo: currencylayer.png
@@ -42,7 +36,7 @@ api_key:
quote:
description: The symbol(s) of the quote or target currencies.
required: false
- type: string, list
+ type: [string, list]
default: Exchange rate
base:
description: The symbol of the base currency.
@@ -50,4 +44,3 @@ base:
type: string
default: USD
{% endconfiguration %}
-
diff --git a/source/_components/daikin.markdown b/source/_components/daikin.markdown
index 408fe7d2667..eb93f8840dc 100644
--- a/source/_components/daikin.markdown
+++ b/source/_components/daikin.markdown
@@ -1,12 +1,6 @@
---
-layout: page
title: "Daikin AC"
description: "Instructions on how to integrate Daikin AC devices with Home Assistant."
-date: 2017-12-10 21:00
-sidebar: true
-comments: false
-sharing: true
-footer: true
logo: daikin.png
ha_category:
- Climate
@@ -36,7 +30,7 @@ There is currently support for the following device types within Home Assistant:
## Configuration
-The Daikin integration can be configured in three ways.
+The Daikin integration can be configured in three ways.
- Automatically via the [discovery]({{site_root}}/components/discovery/) integration.
- Via the Home Assistant user interface where it will let you enter the IP-address of your Daikin AC.
@@ -69,9 +63,11 @@ The `daikin` climate platform integrates Daikin air conditioning systems into Ho
Current inside temperature is displayed.
-
+
+
Some models do not support setting of **fan speed** or **swing mode**.
-
+
+
## Sensor
@@ -80,14 +76,16 @@ The `daikin` sensor platform integrates Daikin air conditioning systems into Hom
- Inside temperature
- Outside temperature
-
+
Some models only report outside temperature when they are turned on.
-
+
## Switch
Daikin AirBase units exposes zones (typically rooms) that can be switched on/off individually.
-
+
+
Zones with the name `-` will be ignored, just as the AirBase application is working.
-
+
+
diff --git a/source/_components/danfoss_air.markdown b/source/_components/danfoss_air.markdown
index 2baa37ef111..e944546d3db 100644
--- a/source/_components/danfoss_air.markdown
+++ b/source/_components/danfoss_air.markdown
@@ -1,12 +1,6 @@
---
-layout: page
title: "Danfoss Air"
description: "How to integrate Danfoss Air HRV in Home Assistant."
-date: 2019-01-14 20:00
-sidebar: true
-comments: false
-sharing: true
-footer: true
ha_category:
- Climate
- Binary Sensor
diff --git a/source/_components/darksky.markdown b/source/_components/darksky.markdown
index 896f5d3717f..759306b4407 100644
--- a/source/_components/darksky.markdown
+++ b/source/_components/darksky.markdown
@@ -1,12 +1,6 @@
---
-layout: page
title: "Dark Sky Sensor"
description: "How to integrate Dark Sky within Home Assistant."
-date: 2016-09-26 08:00
-sidebar: true
-comments: false
-sharing: true
-footer: true
logo: dark_sky.png
ha_category:
- Weather
@@ -23,9 +17,11 @@ The `darksky` platform uses the [Dark Sky](https://darksky.net/) web service as
You need an API key which is free but requires [registration](https://darksky.net/dev/register). You can make up to 1000 calls per day for free which means that you could make one approximately every 86 seconds.
-
+
+
[Dark Sky](https://darksky.net/dev/) will charge you $0.0001 per API call if you enter your credit card details and create more than 1000 calls per day.
-
+
+
## Configuration
@@ -159,9 +155,11 @@ scan_interval:
type: time
{% endconfiguration %}
-
+
+
Please note that some monitored conditions, such as `temperature_high` or `temperature_low`, may only work when setting the `forecast` attribute to at least `0` (current day).
-
+
+
#### Time period dictionary example
@@ -234,9 +232,9 @@ All language options are described in this table that you can use for the dark s
|simplified Chinese|`zh`|
|traditional Chinese|`zh-tw`|
-
+
While the platform is called "darksky" the sensors will show up in Home Assistant as "dark_sky" (eg: sensor.dark_sky_summary).
-
+
More details about the API are available in the [Dark Sky API documentation][].
diff --git a/source/_components/datadog.markdown b/source/_components/datadog.markdown
index b9cb8acc1e4..1198064ad6b 100644
--- a/source/_components/datadog.markdown
+++ b/source/_components/datadog.markdown
@@ -1,13 +1,7 @@
---
-layout: page
title: "Datadog"
description: "Send data and events to Datadog."
-date: 2017-04-18 00:00
-sidebar: true
-comments: false
-sharing: true
logo: datadog.png
-footer: true
ha_category:
- History
ha_release: 0.45
diff --git a/source/_components/ddwrt.markdown b/source/_components/ddwrt.markdown
index 9be10b84028..291a84d867e 100644
--- a/source/_components/ddwrt.markdown
+++ b/source/_components/ddwrt.markdown
@@ -1,12 +1,6 @@
---
-layout: page
title: "DD-WRT"
description: "Instructions on how to integrate DD-WRT based routers into Home Assistant."
-date: 2015-05-11 09:00
-sidebar: true
-comments: false
-sharing: true
-footer: true
logo: ddwrt.png
ha_category:
- Presence Detection
diff --git a/source/_components/deconz.markdown b/source/_components/deconz.markdown
index 89c7a7a14c4..b88395d9023 100644
--- a/source/_components/deconz.markdown
+++ b/source/_components/deconz.markdown
@@ -1,12 +1,6 @@
---
-layout: page
title: "deCONZ"
description: "Instructions on how to setup Conbee/Raspbee devices with deCONZ from Dresden Elektronik within Home Assistant."
-date: 2017-11-12 16:30
-sidebar: true
-comments: false
-sharing: true
-footer: true
logo: deconz.jpeg
ha_category:
- Hub
@@ -371,6 +365,7 @@ The `entity_id` names will be `light.device_name`, where `device_name` is define
- 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
+- Xiaomi Aqara Smart Led Bulb (white) E27 ZNLDP12LM
## Scene
diff --git a/source/_components/decora.markdown b/source/_components/decora.markdown
index cb9a96aaef8..8c75c360370 100644
--- a/source/_components/decora.markdown
+++ b/source/_components/decora.markdown
@@ -1,12 +1,6 @@
---
-layout: page
title: "Leviton Decora"
description: "Instructions on how to setup Leviton Decora Bluetooth dimmers within Home Assistant."
-date: 2017-01-18 22:45
-sidebar: true
-comments: false
-sharing: true
-footer: true
ha_category:
- Light
ha_iot_class: Local Polling
@@ -51,10 +45,11 @@ devices:
type: string
{% endconfiguration %}
-
+
+
If you get an error looking like this:
-```bash
+```txt
Jun 20 19:41:18 androlapin hass[29588]: ERROR:homeassistant.components.light:Error while setting up platform decora
[...]
Jun 20 19:41:18 androlapin hass[29588]: File "/usr/lib/python3.6/concurrent/futures/thread.py", line 55, in run
@@ -69,4 +64,5 @@ Jun 20 19:41:18 androlapin hass[29588]: OSError: [Errno 8] Exec format error
2. Then go to `deps/bluepy` subfolder.
3. Then run `make all`
4. Restart Home Assistant
-
+
+
diff --git a/source/_components/decora_wifi.markdown b/source/_components/decora_wifi.markdown
index cfd60b0dcdc..a91435e3fee 100644
--- a/source/_components/decora_wifi.markdown
+++ b/source/_components/decora_wifi.markdown
@@ -1,12 +1,6 @@
---
-layout: page
title: "Leviton Decora Wi-Fi"
description: "Instructions on how to setup Leviton Decora Smart Wi-Fi switches/dimmers within Home Assistant."
-date: 2017-07-19 12:00
-sidebar: true
-comments: false
-sharing: true
-footer: true
ha_category:
- Light
ha_iot_class: Cloud Polling
diff --git a/source/_components/default_config.markdown b/source/_components/default_config.markdown
index 490065939ec..9d00e7d76ed 100644
--- a/source/_components/default_config.markdown
+++ b/source/_components/default_config.markdown
@@ -1,12 +1,6 @@
---
-layout: page
title: "Default Config"
description: "The default config integration will initate a default configuration for Home Assistant."
-date: 2019-02-15 20:00
-sidebar: true
-comments: false
-sharing: true
-footer: true
logo: home-assistant.png
ha_category:
- Other
diff --git a/source/_components/deluge.markdown b/source/_components/deluge.markdown
index 15b7879d98d..14236471b8d 100644
--- a/source/_components/deluge.markdown
+++ b/source/_components/deluge.markdown
@@ -1,12 +1,6 @@
---
-layout: page
title: "Deluge"
description: "Instructions on how to integrate Deluge within Home Assistant."
-date: 2017-10-19 09:00
-sidebar: true
-comments: false
-sharing: true
-footer: true
logo: deluge.png
ha_category:
- Downloading
diff --git a/source/_components/demo.markdown b/source/_components/demo.markdown
index 91f62e8cf49..915f7f27e6b 100644
--- a/source/_components/demo.markdown
+++ b/source/_components/demo.markdown
@@ -1,12 +1,6 @@
---
-layout: page
title: "Demo platforms"
description: "Instructions on how to use the Platform demos with Home Assistant."
-date: 2016-02-24 07:00
-sidebar: true
-comments: false
-sharing: true
-footer: true
logo: home-assistant.png
ha_category:
- Other
diff --git a/source/_components/denon.markdown b/source/_components/denon.markdown
index 5adf62188d7..6569d7264eb 100644
--- a/source/_components/denon.markdown
+++ b/source/_components/denon.markdown
@@ -1,12 +1,6 @@
---
-layout: page
title: "Denon Network Receivers"
description: "Instructions on how to integrate Denon Network Receivers into Home Assistant."
-date: 2015-09-08 09:00
-sidebar: true
-comments: false
-sharing: true
-footer: true
logo: denon.png
ha_category:
- Media Player
diff --git a/source/_components/denonavr.markdown b/source/_components/denonavr.markdown
index ad60ff2f242..074b8d3b6bf 100644
--- a/source/_components/denonavr.markdown
+++ b/source/_components/denonavr.markdown
@@ -1,12 +1,6 @@
---
-layout: page
title: "Denon AVR Network Receivers"
description: "Instructions on how to integrate Denon AVR Network Receivers into Home Assistant."
-date: 2015-09-08 09:00
-sidebar: true
-comments: false
-sharing: true
-footer: true
logo: denon.png
ha_category:
- Media Player
@@ -41,9 +35,9 @@ Supported devices:
- Other Denon AVR receivers (untested)
- Marantz receivers (experimental)
-
+
If you have something else using the IP controller for your Denon AVR 3808CI, such as your URC controller, it will not work! There is either a bug or security issue with some models where only one device could be controlling the IP functionality.
-
+
To add a Denon Network Receiver to your installation, add the following to your `configuration.yaml` file:
diff --git a/source/_components/deutsche_bahn.markdown b/source/_components/deutsche_bahn.markdown
index ba8b587cc30..de305669bd2 100644
--- a/source/_components/deutsche_bahn.markdown
+++ b/source/_components/deutsche_bahn.markdown
@@ -1,12 +1,6 @@
---
-layout: page
title: "Deutsche Bahn"
description: "Instructions on how to integrate timetable data for traveling in Germany within Home Assistant."
-date: 2015-06-02 21:45
-sidebar: true
-comments: false
-sharing: true
-footer: true
ha_category:
- Transport
logo: db.png
diff --git a/source/_components/device_sun_light_trigger.markdown b/source/_components/device_sun_light_trigger.markdown
index 9c4c011aab1..b18c43eb4c4 100644
--- a/source/_components/device_sun_light_trigger.markdown
+++ b/source/_components/device_sun_light_trigger.markdown
@@ -1,12 +1,6 @@
---
-layout: page
title: "Presence based lights"
description: "Instructions on how to automate your lights with Home Assistant."
-date: 2015-01-20 22:36
-sidebar: true
-comments: false
-sharing: true
-footer: true
logo: home-assistant.png
ha_category:
- Automation
diff --git a/source/_components/device_tracker.markdown b/source/_components/device_tracker.markdown
index b91a5ab8ce2..c0a5b8c64ab 100644
--- a/source/_components/device_tracker.markdown
+++ b/source/_components/device_tracker.markdown
@@ -1,12 +1,6 @@
---
-layout: page
title: "Device Tracker"
description: "Instructions on how to setup device tracking within Home Assistant."
-date: 2015-01-20 22:36
-sidebar: true
-comments: false
-sharing: true
-footer: true
logo: home-assistant.png
ha_category:
- Presence Detection
@@ -34,9 +28,9 @@ device_tracker:
The following optional parameters can be used with any platform:
-
+
Device tracker will only look for global settings under the configuration of the first configured platform.
-
+
| Parameter | Default | Description |
|----------------------|---------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
@@ -44,9 +38,11 @@ The following optional parameters can be used with any platform:
| `consider_home` | 180 | Seconds to wait till marking someone as not home after not being seen. This parameter is most useful for households with Apple iOS devices that go into sleep mode while still at home to conserve battery life. iPhones will occasionally drop off the network and then re-appear. `consider_home` helps prevent false alarms in presence detection when using IP scanners such as Nmap. `consider_home` accepts various time representations, (e.g., the following all represents 3 minutes: `180`, `0:03`, `0:03:00`) |
| `new_device_defaults`| | Default values for new discovered devices. Available options `track_new_devices` (default: `true`), `hide_if_away` (default: `false`) |
-
+
+
Note that setting `track_new_devices: false` will still result in new devices being recorded in `known_devices.yaml`, but they won't be tracked (`track: false`).
-
+
+
The extended example from above would look like the following sample:
@@ -66,9 +62,11 @@ Multiple device trackers can be used in parallel, such as [Owntracks](/component
## `known_devices.yaml`
-
+
+
As of 0.94 `known_devices.yaml` is being phased out, and no longer used by all trackers. Depending on the integration you use this section may no longer apply. This includes the mobile app, OwnTracks, GeoFency, GPSLogger, and Locative.
-
+
+
Once `device_tracker` is enabled, a file will be created in your config dir named `known_devices.yaml`. Edit this file to adjust which devices to be tracked.
@@ -83,9 +81,11 @@ devicename:
hide_if_away: false
```
-
- In the example above, `devicename` refers to the detected name of the device. For instance, `my_iphone`.
-
+
+
+In the example above, `devicename` refers to the detected name of the device. For instance, `my_iphone`.
+
+
| Parameter | Default | Description |
|----------------|-------------------------------|---------------------------------------------------------------------------------------------------------|
diff --git a/source/_components/device_tracker.mqtt.markdown b/source/_components/device_tracker.mqtt.markdown
index 91e67c845b5..5cdf62e3558 100644
--- a/source/_components/device_tracker.mqtt.markdown
+++ b/source/_components/device_tracker.mqtt.markdown
@@ -1,12 +1,6 @@
---
-layout: page
title: "MQTT Device Tracker"
description: "Instructions on how to use MQTT to track devices in Home Assistant."
-date: 2015-09-19 20:41
-sidebar: true
-comments: false
-sharing: true
-footer: true
logo: mqtt.png
ha_category:
- Presence Detection
diff --git a/source/_components/device_tracker.mysensors.markdown b/source/_components/device_tracker.mysensors.markdown
index 7c5cbd25242..6d8941a8a4c 100644
--- a/source/_components/device_tracker.mysensors.markdown
+++ b/source/_components/device_tracker.mysensors.markdown
@@ -1,12 +1,6 @@
---
-layout: page
title: "MySensors Device Tracker"
description: "Instructions on how to use MySensors to track devices in Home Assistant."
-date: 2017-02-06 15:00 +0100
-sidebar: true
-comments: false
-sharing: true
-footer: true
logo: mysensors.png
ha_category:
- DIY
diff --git a/source/_components/device_tracker.xiaomi.markdown b/source/_components/device_tracker.xiaomi.markdown
index db783f15b6d..6a222ce0267 100644
--- a/source/_components/device_tracker.xiaomi.markdown
+++ b/source/_components/device_tracker.xiaomi.markdown
@@ -1,12 +1,6 @@
---
-layout: page
title: "Xiaomi Router"
description: "Instructions on how to integrate Xiaomi routers into Home Assistant."
-date: 2017-01-12 12:04
-sidebar: true
-comments: false
-sharing: true
-footer: true
logo: xiaomi.png
ha_category:
- Presence Detection
diff --git a/source/_components/dht.markdown b/source/_components/dht.markdown
index a882343ac93..5cfaa00f000 100644
--- a/source/_components/dht.markdown
+++ b/source/_components/dht.markdown
@@ -1,12 +1,6 @@
---
-layout: page
title: "DHT Sensor"
description: "Instructions on how to integrate DHTxx sensors within Home Assistant."
-date: 2015-08-30 19:15
-sidebar: true
-comments: false
-sharing: true
-footer: true
ha_category:
- DIY
ha_release: 0.7
diff --git a/source/_components/dialogflow.markdown b/source/_components/dialogflow.markdown
index c96d607b1e5..62f7868afb9 100644
--- a/source/_components/dialogflow.markdown
+++ b/source/_components/dialogflow.markdown
@@ -1,12 +1,6 @@
---
-layout: page
title: "Dialogflow"
description: "Instructions on how integrate Dialogflow with Home Assistant."
-date: 2017-01-27 11:28
-sidebar: true
-comments: false
-sharing: true
-footer: true
logo: dialogflow.png
ha_category:
- Voice
diff --git a/source/_components/digital_ocean.markdown b/source/_components/digital_ocean.markdown
index 22005a23422..a7436fcb7f6 100644
--- a/source/_components/digital_ocean.markdown
+++ b/source/_components/digital_ocean.markdown
@@ -1,12 +1,6 @@
---
-layout: page
title: "Digital Ocean"
description: "Instructions on how to integrate the Digital Ocean within Home Assistant."
-date: 2016-09-24 20:00
-sidebar: true
-comments: false
-sharing: true
-footer: true
ha_category:
- System Monitor
- Binary Sensor
diff --git a/source/_components/digitalloggers.markdown b/source/_components/digitalloggers.markdown
index e8566551384..e491ce64ddc 100644
--- a/source/_components/digitalloggers.markdown
+++ b/source/_components/digitalloggers.markdown
@@ -1,12 +1,6 @@
---
-layout: page
title: "Digital Loggers Switch"
description: "Instructions on how to integrate Digital Loggers DIN III relays into Home Assistant."
-date: 2016-10-02 10:00
-sidebar: true
-comments: false
-sharing: true
-footer: true
logo: digitalloggers.png
ha_category:
- Switch
diff --git a/source/_components/directv.markdown b/source/_components/directv.markdown
index a3a1235c78e..a1097003b59 100644
--- a/source/_components/directv.markdown
+++ b/source/_components/directv.markdown
@@ -1,12 +1,6 @@
---
-layout: page
title: "DirecTV"
description: "Instructions on how to integrate DirecTV receivers into Home Assistant."
-date: 2016-07-19 01:0+0000
-sidebar: true
-comments: false
-sharing: true
-footer: true
logo: directv.png
ha_category:
- Media Player
diff --git a/source/_components/discogs.markdown b/source/_components/discogs.markdown
index bdaf1147af0..e1ca730dff7 100644
--- a/source/_components/discogs.markdown
+++ b/source/_components/discogs.markdown
@@ -1,12 +1,6 @@
---
-layout: page
title: Discogs Sensor
description: "Instructions on how to set up Discogs sensors within Home Assistant."
-date: 2017-12-04 22:00
-sidebar: true
-comments: false
-sharing: true
-footer: true
ha_category:
- Multimedia
ha_release: 0.61
diff --git a/source/_components/discord.markdown b/source/_components/discord.markdown
index be9ba27b241..16f0ea7f283 100644
--- a/source/_components/discord.markdown
+++ b/source/_components/discord.markdown
@@ -1,12 +1,6 @@
---
-layout: page
title: "Discord"
description: "Instructions on how to add Discord notifications to Home Assistant."
-date: 2016-01-14 15:15
-sidebar: true
-comments: false
-sharing: true
-footer: true
logo: discord.png
ha_category:
- Notifications
diff --git a/source/_components/discovery.markdown b/source/_components/discovery.markdown
index 3e8708f576f..006c1e91519 100644
--- a/source/_components/discovery.markdown
+++ b/source/_components/discovery.markdown
@@ -1,12 +1,6 @@
---
-layout: page
title: "Discovery"
description: "Instructions on how to setup Home Assistant to discover new devices."
-date: 2015-01-24 14:39
-sidebar: true
-comments: false
-sharing: true
-footer: true
logo: home-assistant.png
ha_category:
- Other
@@ -47,9 +41,11 @@ Home Assistant can discover and automatically configure [zeroconf](https://en.wi
It will be able to add Google Chromecasts and Belkin WeMo switches automatically,
for Philips Hue it will require some configuration from the user.
-
- Zeroconf discoverable integrations [Axis](/components/axis/)/[ESPHome](/components/esphome/)/[HomeKit](/components/homekit_controller/)/[Tradfri](/components/tradfri/) have been migrated to use [zeroconf](/components/zeroconf) integration to initiate discovery.
-
+
+
+Zeroconf discoverable integrations [Axis](/components/axis/)/[ESPHome](/components/esphome/)/[HomeKit](/components/homekit_controller/)/[Tradfri](/components/tradfri/) have been migrated to use [zeroconf](/components/zeroconf) integration to initiate discovery.
+
+
To load this component, add the following lines to your `configuration.yaml`:
diff --git a/source/_components/dispatcher.markdown b/source/_components/dispatcher.markdown
index 7f3e2b51f0b..8e8d6c53c62 100644
--- a/source/_components/dispatcher.markdown
+++ b/source/_components/dispatcher.markdown
@@ -1,12 +1,6 @@
---
-layout: page
title: "Dispatcher IP Camera"
description: "Instructions on how to integrate internal dispatcher cameras within Home Assistant."
-date: 2017-03-08 00:00
-sidebar: true
-comments: false
-sharing: true
-footer: true
ha_category:
- Camera
logo: camcorder.png
@@ -16,9 +10,9 @@ redirect_from:
- /components/camera.dispatcher/
---
-
+
This platform is meant for developers only.
-
+
The `dispatcher` camera platform allows developers to create virtual camera's.
diff --git a/source/_components/dlib_face_detect.markdown b/source/_components/dlib_face_detect.markdown
index 69c07a31098..9ef512b54e8 100644
--- a/source/_components/dlib_face_detect.markdown
+++ b/source/_components/dlib_face_detect.markdown
@@ -1,12 +1,6 @@
---
-layout: page
title: "Dlib Face Detect"
description: "Instructions on how to integrate Dlib Face Detect into Home Assistant."
-date: 2017-05-05 00:00
-sidebar: true
-comments: false
-sharing: true
-footer: true
logo: dlib.png
ha_category:
- Image Processing
diff --git a/source/_components/dlib_face_identify.markdown b/source/_components/dlib_face_identify.markdown
index eaa13e089db..04385831b3e 100644
--- a/source/_components/dlib_face_identify.markdown
+++ b/source/_components/dlib_face_identify.markdown
@@ -1,12 +1,6 @@
---
-layout: page
title: "Dlib Face Identify"
description: "Instructions on how to integrate Dlib Face Identify into Home Assistant."
-date: 2017-01-25 00:00
-sidebar: true
-comments: false
-sharing: true
-footer: true
logo: dlib.png
ha_category:
- Image Processing
@@ -57,6 +51,8 @@ confidence:
default: 0.6
{% endconfiguration %}
-
+
+
If the platform fails to load because it could not install its requirement, install cmake: `sudo apt-get install cmake`.
-
+
+
diff --git a/source/_components/dlink.markdown b/source/_components/dlink.markdown
index c05b4db9056..941d486dcc7 100644
--- a/source/_components/dlink.markdown
+++ b/source/_components/dlink.markdown
@@ -1,12 +1,6 @@
---
-layout: page
title: "D-Link Switch"
description: "Instructions on how to integrate D-Link switches into Home Assistant."
-date: 2016-02-21 09:00
-sidebar: true
-comments: false
-sharing: true
-footer: true
logo: dlink.png
ha_category:
- Switch
diff --git a/source/_components/dlna_dmr.markdown b/source/_components/dlna_dmr.markdown
index 315c28a84c2..8c4123710b7 100644
--- a/source/_components/dlna_dmr.markdown
+++ b/source/_components/dlna_dmr.markdown
@@ -1,12 +1,6 @@
---
-layout: page
title: "DLNA DMR"
description: "Instructions on how to integrate a DLNA DMR device into Home Assistant."
-date: 2018-06-01 14:27
-sidebar: true
-comments: false
-sharing: true
-footer: true
logo: dlna.png
ha_category:
- Media Player
diff --git a/source/_components/dnsip.markdown b/source/_components/dnsip.markdown
index 11283754964..fec191407c0 100644
--- a/source/_components/dnsip.markdown
+++ b/source/_components/dnsip.markdown
@@ -1,12 +1,6 @@
---
-layout: page
title: "DNS IP Sensor"
description: "Instructions on how to integrate a DNS IP sensor into Home Assistant."
-date: 2017-02-25 11:05
-sidebar: true
-comments: false
-sharing: true
-footer: true
logo: home-assistant.png
ha_category:
- Network
diff --git a/source/_components/dominos.markdown b/source/_components/dominos.markdown
index 7a116e5a6a0..dfc8d461628 100644
--- a/source/_components/dominos.markdown
+++ b/source/_components/dominos.markdown
@@ -1,12 +1,6 @@
---
-layout: page
title: "Dominos Pizza"
description: "Instructions on how to setup Dominos Pizza ordering within Home Assistant."
-date: 2017-11-05 17:30
-sidebar: true
-comments: false
-sharing: true
-footer: true
logo: dominos.png
ha_category:
- Other
@@ -22,7 +16,7 @@ At present, this integration only supports ordering within Canada and the US.
To enable the component, you need to set up your customer information and define some orders.
-Orders are a group of product codes. You can get these product codes by inspecting an order request from the Dominos web app, or you can [add this custom panel by following this readme](https://github.com/wardcraigj/hass-dominos-panel) to see the available product codes in a separate panel in your install.
+Orders are a group of product codes. You can get these product codes by inspecting an order request from the Dominos web app, or you can [add this custom panel by following this readme](https://github.com/craigjmidwinter/hass-dominos-panel) to see the available product codes in a separate panel in your install.
Currently, there is no support in this integration for toppings, coupons or order tracking.
diff --git a/source/_components/doorbird.markdown b/source/_components/doorbird.markdown
index 5c2b16266a9..5fdc81d2675 100644
--- a/source/_components/doorbird.markdown
+++ b/source/_components/doorbird.markdown
@@ -1,12 +1,6 @@
---
-layout: page
title: "DoorBird"
description: "Instructions on how to integrate your DoorBird video doorbell with Home Assistant."
-date: 2017-08-06 11:30
-sidebar: true
-comments: false
-sharing: true
-footer: true
logo: doorbird.png
ha_category:
- Doorbell
@@ -116,9 +110,9 @@ Event names will be prefixed by `doorbird_devicename`. For example, the example
See [Automation Example](#automation_example) section below for details on how to use the event names in an automation.
-
+
Events will not be received in Home Assistant until a schedule is defined via the DoorBird app.
-
+
#### Clearing Registered Events
Events can be cleared from DoorBird devices by visiting a special URL.
@@ -140,9 +134,9 @@ The following keys are available on `event_data`:
- `rtsp_live_video_url`
- `html5_viewer_url`
-
+
The URLs on the event will be based on the configuration used to connect to your Doorbird device. Ability to connect from outside your network will depend on your configuration.
-
+
#### Schedules
diff --git a/source/_components/dovado.markdown b/source/_components/dovado.markdown
index b274d61eeb1..96262afbe83 100644
--- a/source/_components/dovado.markdown
+++ b/source/_components/dovado.markdown
@@ -1,12 +1,6 @@
---
-layout: page
title: "Dovado"
description: "How to integrate Dovado within Home Assistant."
-date: 2019-01-26 15:45
-sidebar: true
-comments: false
-sharing: true
-footer: true
ha_category:
- System Monitor
- Notifications
diff --git a/source/_components/downloader.markdown b/source/_components/downloader.markdown
index c756cae308f..5be5d7be0cd 100644
--- a/source/_components/downloader.markdown
+++ b/source/_components/downloader.markdown
@@ -1,12 +1,6 @@
---
-layout: page
title: "Downloader"
description: "Instructions on how to setup the downloader integration with Home Assistant."
-date: 2015-01-24 14:39
-sidebar: true
-comments: false
-sharing: true
-footer: true
logo: home-assistant.png
ha_category:
- Downloading
diff --git a/source/_components/dsmr.markdown b/source/_components/dsmr.markdown
index 0bb9981df91..887827dd685 100644
--- a/source/_components/dsmr.markdown
+++ b/source/_components/dsmr.markdown
@@ -1,12 +1,6 @@
---
-layout: page
title: "DSMR or Slimme meter"
description: "Instructions on how to integrate DSMR Smartmeter within Home Assistant."
-date: 2016-11-12 12:00
-sidebar: true
-comments: false
-sharing: true
-footer: true
logo: netbeheernederland.jpg
ha_category:
- Energy
@@ -129,7 +123,7 @@ or
2001:raw:600:/dev/ttyUSB0:9600 EVEN 1STOPBIT 7DATABITS XONXOFF LOCAL -RTSCTS
```
-[HASSbian](/getting-started/installation-raspberry-pi-image/) users have to give dialout permission to the user `homeassistant`:
+[HASSbian](/docs/installation/hassbian/installation/) users have to give dialout permission to the user `homeassistant`:
```bash
$ sudo usermod -a -G dialout homeassistant
diff --git a/source/_components/dte_energy_bridge.markdown b/source/_components/dte_energy_bridge.markdown
index 3af953f521e..7830053b28d 100644
--- a/source/_components/dte_energy_bridge.markdown
+++ b/source/_components/dte_energy_bridge.markdown
@@ -1,12 +1,6 @@
---
-layout: page
title: "DTE Energy Bridge"
description: "Instructions on how to setup DTE Energy Bridge with Home Assistant."
-date: 2016-06-07 08:10
-sidebar: true
-comments: false
-sharing: true
-footer: true
logo: dte_energy.png
ha_category:
- Energy
@@ -16,7 +10,7 @@ redirect_from:
- /components/sensor.dte_energy_bridge/
---
-A sensor platform for the [DTE](https://www.dteenergy.com/) Energy Bridge. To find out which version of the DTE Energy Bridge sensor you have, find the status LED on your box.
+A sensor platform for the [DTE](https://www.newlook.dteenergy.com/) Energy Bridge. To find out which version of the DTE Energy Bridge sensor you have, find the status LED on your box.
- If the status LED is on the top, you have a v1.
- If the status LED is on the front, you have a v2.
diff --git a/source/_components/dublin_bus_transport.markdown b/source/_components/dublin_bus_transport.markdown
index d59ce3e0ebd..3899b7a7c58 100644
--- a/source/_components/dublin_bus_transport.markdown
+++ b/source/_components/dublin_bus_transport.markdown
@@ -1,12 +1,6 @@
---
-layout: page
title: "Dublin Bus Transport"
description: "Instructions on how to integrate timetable data for traveling on Dublin Bus within Home Assistant."
-date: 2017-01-09 21:45
-sidebar: true
-comments: false
-sharing: true
-footer: true
logo: dublin_bus.png
ha_category:
- Transport
diff --git a/source/_components/duckdns.markdown b/source/_components/duckdns.markdown
index 225a81f4589..cabe4677fcd 100644
--- a/source/_components/duckdns.markdown
+++ b/source/_components/duckdns.markdown
@@ -1,12 +1,6 @@
---
-layout: page
title: "DuckDNS"
description: "Keep your computer registered with the DuckDNS dynamic DNS."
-date: 2017-09-23 07:08
-sidebar: true
-comments: false
-sharing: true
-footer: true
logo: duckdns.png
ha_category:
- Network
@@ -37,6 +31,8 @@ duckdns:
type: string
{% endconfiguration %}
-
+
+
If you are running the Hass.io [DuckDNS add-on](/addons/duckdns/) this integration is not required. The add-on will keep your IP updated with DuckDNS.
-
+
+
diff --git a/source/_components/duke_energy.markdown b/source/_components/duke_energy.markdown
index 94550a9c079..b457129530f 100644
--- a/source/_components/duke_energy.markdown
+++ b/source/_components/duke_energy.markdown
@@ -1,12 +1,6 @@
---
-layout: page
title: "Duke Energy"
description: "Instructions on how to set Duke Energy smart meter sensors within Home Assistant."
-date: 2018-07-01 09:00
-sidebar: true
-comments: false
-sharing: true
-footer: true
logo: duke_energy.png
ha_category:
- Energy
@@ -47,7 +41,6 @@ password:
type: string
{% endconfiguration %}
-
-
+
Meter usage isn't updated until mid-morning. Prior to updating your meter will report 0 for usage starting at midnight. The API is only called to update every 2 hours from startup time.
-
+
diff --git a/source/_components/dunehd.markdown b/source/_components/dunehd.markdown
index 8f99d50807c..22f6809b270 100644
--- a/source/_components/dunehd.markdown
+++ b/source/_components/dunehd.markdown
@@ -1,12 +1,6 @@
---
-layout: page
title: "DuneHD media players"
description: "Instructions on how to integrate DuneHD media players into Home Assistant."
-date: 2016-11-26 09:00
-sidebar: true
-comments: false
-sharing: true
-footer: true
logo: dunehd.png
ha_category:
- Media Player
diff --git a/source/_components/dwd_weather_warnings.markdown b/source/_components/dwd_weather_warnings.markdown
index 87b1f0918f2..f5cef708543 100644
--- a/source/_components/dwd_weather_warnings.markdown
+++ b/source/_components/dwd_weather_warnings.markdown
@@ -1,12 +1,6 @@
---
-layout: page
title: "DWD Weather warnings"
description: "Instructions on how to integrate Deutsche Wetter Dienst weather warnings into Home Assistant."
-date: 2017-07-26 22:00
-sidebar: true
-comments: false
-sharing: true
-footer: true
#logo: dwdwarnapp.png
ha_category:
- Weather
@@ -32,14 +26,16 @@ sensor:
region_name: Hansestadt Hamburg
```
-
+
+
As it suggests the region name is not the city or nearest city you want to get the warnings for but the next higher level of the governmental district called "Kreis" in German.
Be aware, to get the region name you need to use the following link by replacing `Hamburg` with your city:
- Find your region here: `https://www.dwd.de/DE/wetter/warnungen_landkreise/warnWetter_node.html?ort=Hamburg`
- On the page that is loaded in your browser you will find the correct region ("Kreis") below the map as a headding.
- Verify if you find any warning for your region here. Your region ("Kreis") will appear only if warnings exist: `https://www.dwd.de/DWD/warnungen/warnapp_landkreise/json/warnings.json?jsonp=loadWarnings`
-
+
+
{% configuration %}
region_name:
@@ -72,6 +68,8 @@ name:
| `warning__description` | Details for the issued warning. |
| `warning__instruction` | The DWD is sometimes providing helpful information about precautions to take for the issued warning. |
-
+
+
In the attribute name `x` is the counter of the warning starting from `1`.
-
+
+
diff --git a/source/_components/dweet.markdown b/source/_components/dweet.markdown
index 88f86a7a94b..30a710ed2a6 100644
--- a/source/_components/dweet.markdown
+++ b/source/_components/dweet.markdown
@@ -1,12 +1,6 @@
---
-layout: page
title: "Dweet.io"
description: "Transfer events to Dweet.io."
-date: 2016-05-07 07:08
-sidebar: true
-comments: false
-sharing: true
-footer: true
logo: dweet.png
ha_category:
- History
@@ -23,9 +17,9 @@ The `dweet` integration makes it possible to transfer details collected with Hom
-
- The publishing interval is limited to 1 second. This means that it's possible to miss fast changes.
-
+
+The publishing interval is limited to 1 second. This means that it's possible to miss fast changes.
+
There is currently support for the following device types within Home Assistant:
diff --git a/source/_components/dyson.markdown b/source/_components/dyson.markdown
index 9bad80f8a8e..77e5c3fb157 100644
--- a/source/_components/dyson.markdown
+++ b/source/_components/dyson.markdown
@@ -1,12 +1,6 @@
---
-layout: page
title: "Dyson"
description: "Instructions on how to integrate Dyson into Home Assistant."
-date: 2017-05-27 10:00
-sidebar: true
-comments: false
-sharing: true
-footer: true
logo: dyson.png
ha_category:
- Hub
@@ -80,9 +74,11 @@ devices:
The `devices` list is optional, but you'll have to provide them if discovery is not working (warnings in the logs and the devices are not available in Home Assistant web interface).
-
+
+
Discovery is not yet supported for any robot vacuum models (Dyson 360 Eye). For these devices, you will need to provide them in the `devices` list.
-
+
+
To find a devices IP address, you can use your router or `nmap`:
diff --git a/source/_components/ebox.markdown b/source/_components/ebox.markdown
index 494393c937e..1ad3e460622 100644
--- a/source/_components/ebox.markdown
+++ b/source/_components/ebox.markdown
@@ -1,12 +1,6 @@
---
-layout: page
title: "EBox Sensor"
description: "Instructions on how to integrate EBox data usage within Home Assistant."
-date: 2017-02-15 17:17
-sidebar: true
-comments: false
-sharing: true
-footer: true
logo: ebox.png
ha_category:
- Network
diff --git a/source/_components/ebusd.markdown b/source/_components/ebusd.markdown
index c8d0b2019d2..533b24dd48c 100644
--- a/source/_components/ebusd.markdown
+++ b/source/_components/ebusd.markdown
@@ -1,12 +1,6 @@
---
-layout: page
title: "ebusd"
description: "The ebusd integration allows the integration between eBUS heating system and Home Assistant."
-date: 2018-12-27 15:00
-sidebar: true
-comments: false
-sharing: true
-footer: true
ha_category:
- Sensor
ha_iot_class: Local Polling
diff --git a/source/_components/ecoal_boiler.markdown b/source/_components/ecoal_boiler.markdown
index 06d4b903333..d49d8bf973f 100644
--- a/source/_components/ecoal_boiler.markdown
+++ b/source/_components/ecoal_boiler.markdown
@@ -1,13 +1,6 @@
---
-layout: page
title: "eCoal water boiler controller"
description: "Instructions on how to integrate eSterownik.pl eCoal.pl controller into Home Assistant."
-date: 2018-11-29 10:00
-sidebar: true
-comments: false
-sharing: true
-footer: true
-# logo: raspberry-pi.png
ha_category:
- Water heater
ha_release: 0.87
diff --git a/source/_components/ecobee.markdown b/source/_components/ecobee.markdown
index 64ff1350d2c..3fe50fb3ce6 100644
--- a/source/_components/ecobee.markdown
+++ b/source/_components/ecobee.markdown
@@ -1,12 +1,6 @@
---
-layout: page
title: "Ecobee"
description: "Instructions for how to integrate Ecobee thermostats and sensors within Home Assistant."
-date: 2015-11-30 17:54
-sidebar: true
-comments: false
-sharing: true
-footer: true
logo: ecobee.png
ha_category:
- Sensor
@@ -56,7 +50,7 @@ ecobee:
api_key: YOUR_API_KEY
```
-[Restart Home Assistant](https://www.home-assistant.io/docs/configuration/#reloading-changes) for the changes to take effect.
+[Restart Home Assistant](/docs/configuration/#reloading-changes) for the changes to take effect.
The first time you (re)run Home Assistant with this integration it will give you a PIN code that you need to authorize in the [ecobee consumer portal](https://www.ecobee.com/consumerportal/index.html). You can do this by clicking **Add Application** in the **My Apps** section in the sidebar.
diff --git a/source/_components/econet.markdown b/source/_components/econet.markdown
index 369f696c6c1..6120e7eba60 100644
--- a/source/_components/econet.markdown
+++ b/source/_components/econet.markdown
@@ -1,12 +1,6 @@
---
-layout: page
title: "EcoNet water heater"
description: "Instructions on how to integrate Rheem EcoNet water heaters into Home Assistant."
-date: 2017-12-28 14:51
-sidebar: true
-comments: false
-sharing: true
-footer: true
logo: econet.png
ha_category:
- Water heater
@@ -52,9 +46,11 @@ You can use the service `econet.add_vacation` to create a new vacation for your
| `start_date` | yes | This is a Unix timestamp for when the vacation should start.
| `end_date` | yes | this is a Unix timestamp for when the vacation should end.
-
+
+
The Unix timestamps can be obtained from the `input_datetime` component. This will allow you to graphically set the start and end date.
-
+
+
### Service `econet.delete_vacation`
@@ -64,6 +60,8 @@ You can use the service `econet.delete_vacation` to remove all vacations from an
| ---------------------- | -------- | ----------- |
| `entity_id` | yes | The entity id of the water heater to remove the vacation from.
-
+
+
Econet water heaters use to live under the `climate` platform prior to release 0.81.
-
+
+
diff --git a/source/_components/ecovacs.markdown b/source/_components/ecovacs.markdown
index b5fd46c5626..15d14a4cf24 100644
--- a/source/_components/ecovacs.markdown
+++ b/source/_components/ecovacs.markdown
@@ -1,12 +1,6 @@
---
-layout: page
title: "Ecovacs"
description: "Instructions on how to integrate Ecovacs vacuums within Home Assistant."
-date: 2018-07-29 09:00
-sidebar: true
-comments: false
-sharing: true
-footer: true
logo: ecovacs.png
ha_category:
- Hub
diff --git a/source/_components/eddystone_temperature.markdown b/source/_components/eddystone_temperature.markdown
index 95ec4ab3384..acdc8ae1f83 100644
--- a/source/_components/eddystone_temperature.markdown
+++ b/source/_components/eddystone_temperature.markdown
@@ -1,12 +1,6 @@
---
-layout: page
title: "Eddystone Beacon"
description: "Instructions on how to integrate Eddystone beacons with Home Assistant in order to receive temperature data."
-date: 2017-03-26 01:00
-sidebar: true
-comments: false
-sharing: true
-footer: true
logo: eddystone.png
ha_category:
- DIY
diff --git a/source/_components/edimax.markdown b/source/_components/edimax.markdown
index 9768ce73f8e..32ba1e7486d 100644
--- a/source/_components/edimax.markdown
+++ b/source/_components/edimax.markdown
@@ -1,12 +1,6 @@
---
-layout: page
title: "Edimax Switch"
description: "Instructions on how to integrate Edimax switches into Home Assistant."
-date: 2015-06-10 22:54
-sidebar: true
-comments: false
-sharing: true
-footer: true
logo: edimax.png
ha_category:
- Switch
diff --git a/source/_components/edp_redy.markdown b/source/_components/edp_redy.markdown
index 02eeca1e50b..a1a8347af11 100644
--- a/source/_components/edp_redy.markdown
+++ b/source/_components/edp_redy.markdown
@@ -1,12 +1,6 @@
---
-layout: page
title: "EDP re:dy"
description: "Instructions on how to integrate the EDP re:dy platform into Home Assistant."
-date: 2018-09-04 16:30
-sidebar: true
-comments: false
-sharing: true
-footer: true
logo: edp_redy.png
ha_category:
- Hub
diff --git a/source/_components/ee_brightbox.markdown b/source/_components/ee_brightbox.markdown
index c19e57ee00b..56293e3c962 100644
--- a/source/_components/ee_brightbox.markdown
+++ b/source/_components/ee_brightbox.markdown
@@ -1,12 +1,6 @@
---
-layout: page
title: "EE Bright Box"
description: "Instructions on how to integrate EE Bright Box router into Home Assistant."
-date: 2018-12-27 16:00
-sidebar: true
-comments: false
-sharing: true
-footer: true
logo: ee.png
ha_category:
- Presence Detection
diff --git a/source/_components/efergy.markdown b/source/_components/efergy.markdown
index cceca5dd031..c8aa9c8c854 100644
--- a/source/_components/efergy.markdown
+++ b/source/_components/efergy.markdown
@@ -1,12 +1,6 @@
---
-layout: page
title: "Efergy"
description: "Instructions on how to integrate Efergy devices within Home Assistant."
-date: 2015-07-11 0:15
-sidebar: true
-comments: false
-sharing: true
-footer: true
logo: efergy.png
ha_category:
- Energy
diff --git a/source/_components/egardia.markdown b/source/_components/egardia.markdown
index ab7fe2b47f0..d85003beeb8 100644
--- a/source/_components/egardia.markdown
+++ b/source/_components/egardia.markdown
@@ -1,12 +1,6 @@
---
-layout: page
title: "Egardia"
description: "Instructions on how to setup Egardia / Woonveilig within Home Assistant."
-date: 2018-03-13 09:00
-sidebar: true
-comments: false
-sharing: true
-footer: true
logo: egardia.png
ha_category:
- Hub
@@ -98,9 +92,9 @@ report_server_codes:
Note that this basic configuration will only enable you to read the armed/armed away/disarmed status of your alarm and will **not** update the status if the alarm is triggered. This is because of how Egardia built their system. The alarm triggers normally go through their servers.
You can change this, however, using the following procedure. This is a more advanced (and more useful) configuration.
-
+
There seem to be multiple versions of software running on GATE-02 devices; we have received reports from GATE-02 users who successfully run this package in GATE-02 mode. Others have reported they needed to specify GATE-03 as their version to integrate their GATE-02.
-
+
## Advanced configuration
diff --git a/source/_components/eight_sleep.markdown b/source/_components/eight_sleep.markdown
index cd6b58f37a5..3bbc657dd6c 100644
--- a/source/_components/eight_sleep.markdown
+++ b/source/_components/eight_sleep.markdown
@@ -1,12 +1,6 @@
---
-layout: page
title: "Eight Sleep"
description: "Interface an Eight Sleep smart cover or mattress to Home Assistant"
-date: 2017-04-24 00:00
-sidebar: true
-comments: false
-sharing: true
-footer: true
logo: eight_sleep.png
ha_category:
- Health
diff --git a/source/_components/eliqonline.markdown b/source/_components/eliqonline.markdown
index efa95897494..d1b57bfcc5e 100644
--- a/source/_components/eliqonline.markdown
+++ b/source/_components/eliqonline.markdown
@@ -1,12 +1,6 @@
---
-layout: page
title: "Eliqonline"
description: "Instructions on how to integrate Eliqonline devices within Home Assistant."
-date: 2015-07-11 0:15
-sidebar: true
-comments: false
-sharing: true
-footer: true
logo: eliq.png
ha_category:
- Energy
diff --git a/source/_components/elkm1.markdown b/source/_components/elkm1.markdown
index 727da614faf..063db11650f 100644
--- a/source/_components/elkm1.markdown
+++ b/source/_components/elkm1.markdown
@@ -1,12 +1,6 @@
---
-layout: page
title: "Elk-M1 Controller"
description: "Instructions to setup the Elk-M1 controller."
-date: 2018-10-07 00:00
-sidebar: true
-comments: false
-sharing: true
-footer: true
logo: elkproducts.png
ha_release: 0.81
ha_category:
diff --git a/source/_components/emby.markdown b/source/_components/emby.markdown
index 019fe8ad9a1..829b595c51d 100644
--- a/source/_components/emby.markdown
+++ b/source/_components/emby.markdown
@@ -1,12 +1,6 @@
---
-layout: page
title: "Emby"
description: "Instructions on how to integrate Emby into Home Assistant."
-date: 2016-10-13 22:00
-sidebar: true
-comments: false
-sharing: true
-footer: true
logo: emby.png
ha_category:
- Media Player
diff --git a/source/_components/emoncms.markdown b/source/_components/emoncms.markdown
index b03d4cdcc1f..b74c5040823 100644
--- a/source/_components/emoncms.markdown
+++ b/source/_components/emoncms.markdown
@@ -1,13 +1,7 @@
---
-layout: page
title: "Emoncms Sensor"
description: "Instructions on how to integrate Emoncms feeds as sensors into Home Assistant."
-date: 2016-09-08 00:15
logo: emoncms.png
-sidebar: true
-comments: false
-sharing: true
-footer: true
ha_category:
- Sensor
ha_release: 0.29
diff --git a/source/_components/emoncms_history.markdown b/source/_components/emoncms_history.markdown
index b6fbae26a28..c024e4b710c 100644
--- a/source/_components/emoncms_history.markdown
+++ b/source/_components/emoncms_history.markdown
@@ -1,12 +1,6 @@
---
-layout: page
title: "Emoncms history"
description: "Instructions on how to integrate Emoncms history into Home Assistant."
-date: 2016-09-25 12:50
-sidebar: true
-comments: false
-sharing: true
-footer: true
logo: emoncms.png
ha_category:
- History
diff --git a/source/_components/emulated_hue.markdown b/source/_components/emulated_hue.markdown
index 2667e8db0cc..90d37a24f1f 100644
--- a/source/_components/emulated_hue.markdown
+++ b/source/_components/emulated_hue.markdown
@@ -1,12 +1,6 @@
---
-layout: page
title: "Emulated Hue Bridge"
description: "Instructions on how to emulated Hue Bridge within Home Assistant."
-date: 2016-08-26 08:00
-sidebar: true
-comments: false
-sharing: true
-footer: true
logo: home-assistant.png
ha_category:
- Hub
@@ -15,25 +9,29 @@ ha_iot_class: Local Push
ha_qa_scale: internal
---
-
-Be aware that `emulated_hue` doesn't work for new users of **Google Home** with `emulated_hue`. If you've not previously set this up and had it working, use the [Google Assistant component](/components/google_assistant/) or [Nabu Casa cloud](https://www.home-assistant.io/components/cloud) component.
-
+
+
+Be aware that `emulated_hue` doesn't work for new users of **Google Home** with `emulated_hue`. If you've not previously set this up and had it working, use the [Google Assistant component](/components/google_assistant/) or [Nabu Casa cloud](/components/cloud) component.
+
+
The `emulated_hue` integration provides a virtual Philips Hue bridge, written entirely in software, which allows services that work with the Hue API to interact with Home Assistant
entities. The driving use case behind for functionality is to allow Home Assistant to work with an Amazon Echo or Google Home with no setup cost outside of configuration changes.
The virtual bridge can turn entities on/off or change the brightness of dimmable lights. The volume level of media players can be controlled as brightness.
-
+
A physical Hue Bridge is required for Philips Hue lights to function - this virtual bridge will not replace a physical bridge. Instead, it allows Home Assistant to represent non-Philips Hue devices to Amazon Echo as Philips Hue devices, which Amazon Echo can control with built-in support.
-
+
-
+
It is recommended to assign a static IP address to the computer running Home Assistant. This is because the Amazon Echo discovers devices by IP addresses, and if the IP changes, the Echo won't be able to control it. This is easiest done from your router, see your router's manual for details.
-
+
+
+
-
Both Google Home and Alexa use the device they were initially set up with for communication with `emulated_hue`. In other words: if you remove/replace this device you will also break `emulated_hue`. To recover your `emulated_hue` functionality, backup your `config/emulated_hue_ids.json` file, delete the original one and reboot your Home Assistant instance.
-
+
+
+
+
These attributes used to be found under the `customize` section of `homeassistant`, however, they have now been moved to `entities`. Emulated Hue configuration under `homeassistant.customize` will be deprecated in the near future.
-
+
+
### Troubleshooting
diff --git a/source/_components/emulated_roku.markdown b/source/_components/emulated_roku.markdown
index 520e5a922b6..b930c672b45 100644
--- a/source/_components/emulated_roku.markdown
+++ b/source/_components/emulated_roku.markdown
@@ -1,12 +1,6 @@
---
-layout: page
title: "Emulated Roku"
description: "Instructions on how to set up Emulated Roku within Home Assistant."
-date: 2019-01-10 08:00
-sidebar: true
-comments: false
-sharing: true
-footer: true
logo: home-assistant.png
ha_category:
- Hub
@@ -19,15 +13,19 @@ so remotes such as Harmony and Android apps can connect to it through WiFi as if
Home Assistant will see key presses and app launches as Events, which you can use as triggers for automations.
Multiple Roku servers may be started if you run out of buttons by specifying multiple server entries.
-
-Windows is not supported because Home Assistant uses `ProactorEventLoop` which does not support UDP sockets.
-
+
+
+Windows is not supported because Home Assistant uses `ProactorEventLoop` which does not support UDP sockets.
+
+
+
+
-
This integration opens an unauthenticated API on the host, allowing anything on the local network to access
your Home Assistant instance through the automations you create with emulated Roku as the trigger.
Using a proxy with whitelisted IP addresses is recommended. (set `advertise_ip` to the proxy's ip or DNS name)
-
+
+
Note that the underlying API is rate limited and to avoid getting your instance blocked from entur the sensor is only fetching new information every 45 seconds. It's recommended to not schedule updates more often than this.
-
+
+Note that the underlying API is rate limited and to avoid getting your instance blocked from entur the sensor is only fetching new information every 45 seconds. It's recommended to not schedule updates more often than this.
+
## Configuration
diff --git a/source/_components/environment_canada.markdown b/source/_components/environment_canada.markdown
index 40c74f709f7..3c229dd4594 100644
--- a/source/_components/environment_canada.markdown
+++ b/source/_components/environment_canada.markdown
@@ -1,12 +1,6 @@
---
-layout: page
title: "Environment Canada Weather"
description: "Weather data from Environment Canada."
-date: 2019-06-01 10:00
-sidebar: true
-comments: false
-sharing: true
-footer: true
logo: environment_canada.png
ha_category:
- Weather
@@ -16,7 +10,7 @@ ha_release: 0.95
ha_iot_class: Cloud Polling
---
-The `environment_canada` weather platforms provide meteorological data for Canadian locations from [Environment Canada](hhttps://weather.gc.ca/index_e.html).
+The `environment_canada` weather platforms provide meteorological data for Canadian locations from [Environment Canada](https://weather.gc.ca/index_e.html).
The following device types and data are supported:
diff --git a/source/_components/envirophat.markdown b/source/_components/envirophat.markdown
index 72354900f5c..5b3664ee2f0 100644
--- a/source/_components/envirophat.markdown
+++ b/source/_components/envirophat.markdown
@@ -1,12 +1,6 @@
---
-layout: page
title: "Enviro pHAT"
description: "Instructions on how to integrate the Enviro pHAT within Home Assistant."
-date: 2017-05-03 17:00
-sidebar: true
-comments: false
-sharing: true
-footer: true
logo: raspberry-pi.png
ha_category:
- DIY
diff --git a/source/_components/envisalink.markdown b/source/_components/envisalink.markdown
index d6af76afa04..c1a3360515f 100644
--- a/source/_components/envisalink.markdown
+++ b/source/_components/envisalink.markdown
@@ -1,12 +1,6 @@
---
-layout: page
title: "Envisalink Alarm Control Panel"
description: "Instructions on how to integrate a DSC/Honeywell alarm panel with Home Assistant using an envisalink evl3/evl4 board."
-date: 2016-09-30 22:45
-sidebar: true
-comments: false
-sharing: true
-footer: true
logo: eyezon.png
ha_category:
- Alarm
diff --git a/source/_components/ephember.markdown b/source/_components/ephember.markdown
index 9d3d2cd9cdf..cf38c911098 100644
--- a/source/_components/ephember.markdown
+++ b/source/_components/ephember.markdown
@@ -1,12 +1,6 @@
---
-layout: page
title: "EPH Controls EMBER Thermostat"
description: "Instructions on how to integrate EPH Controls EMBER thermostats within Home Assistant."
-date: 2017-10-07 12:40
-sidebar: true
-comments: false
-sharing: true
-footer: true
logo: ephcontrolsember.png
ha_category:
- Climate
diff --git a/source/_components/epson.markdown b/source/_components/epson.markdown
index edf50dfa218..3049bc8dbf8 100644
--- a/source/_components/epson.markdown
+++ b/source/_components/epson.markdown
@@ -1,12 +1,6 @@
---
-layout: page
title: "Epson"
description: "Instructions on how to integrate Epson projector into Home Assistant."
-date: 2018-06-13 15:00
-sidebar: true
-comments: false
-sharing: true
-footer: true
logo: epson.png
ha_category:
- Media Player
diff --git a/source/_components/epsonworkforce.markdown b/source/_components/epsonworkforce.markdown
index 135767fa12f..aaa6c43cd61 100644
--- a/source/_components/epsonworkforce.markdown
+++ b/source/_components/epsonworkforce.markdown
@@ -1,12 +1,6 @@
---
-layout: page
title: "Epson Workforce"
description: "Instructions on how to integrate Epson Workforce Printer into Home Assistant."
-date: 2019-04-09 16:00
-sidebar: true
-comments: false
-sharing: true
-footer: true
logo: epson.png
ha_category:
- Sensor
@@ -41,7 +35,7 @@ host:
monitored_conditions:
description: The cartridge colours to monitor.
required: true
- type: map
+ type: list
keys:
black:
description: The black ink cartridge
diff --git a/source/_components/eq3btsmart.markdown b/source/_components/eq3btsmart.markdown
index d855781b4a2..852962d3027 100644
--- a/source/_components/eq3btsmart.markdown
+++ b/source/_components/eq3btsmart.markdown
@@ -1,12 +1,6 @@
---
-layout: page
title: "EQ3 Bluetooth Smart Thermostats"
description: "Instructions on how to integrate EQ3 Bluetooth Smart Thermostats into Home Assistant."
-date: 2016-04-18 22:00
-sidebar: true
-comments: false
-sharing: true
-footer: true
logo: eq3.gif
ha_category:
- Climate
diff --git a/source/_components/esphome.markdown b/source/_components/esphome.markdown
index 14cc080732b..5d4167c13ad 100644
--- a/source/_components/esphome.markdown
+++ b/source/_components/esphome.markdown
@@ -1,13 +1,7 @@
---
-layout: page
title: "ESPHome"
description: "Support for ESPHome devices using the native ESPHome API."
-date: 2018-12-16 14:20
-sidebar: true
-comments: false
-sharing: true
featured: true
-footer: true
logo: esphome.png
ha_category:
- DIY
diff --git a/source/_components/essent.markdown b/source/_components/essent.markdown
index 36e7e530e05..4c786679a15 100644
--- a/source/_components/essent.markdown
+++ b/source/_components/essent.markdown
@@ -1,12 +1,6 @@
---
-layout: page
title: "Essent"
description: "Instructions on how to integrate Essent within Home Assistant."
-date: 2019-04-29 19:15
-sidebar: true
-comments: false
-sharing: true
-footer: true
logo: essent.png
ha_category:
- Energy
diff --git a/source/_components/etherscan.markdown b/source/_components/etherscan.markdown
index e3152596a5e..164deeaa945 100644
--- a/source/_components/etherscan.markdown
+++ b/source/_components/etherscan.markdown
@@ -1,12 +1,6 @@
---
-layout: page
title: "Etherscan"
description: "Instructions on how to integrate Etherscan.io data within Home Assistant."
-date: 2017-06-01 16:20
-sidebar: true
-comments: false
-sharing: true
-footer: true
logo: etherscan.png
ha_category:
- Finance
diff --git a/source/_components/eufy.markdown b/source/_components/eufy.markdown
index ca386741ef7..543eadb5b34 100644
--- a/source/_components/eufy.markdown
+++ b/source/_components/eufy.markdown
@@ -1,12 +1,6 @@
---
-layout: page
title: "Eufy"
description: "Instructions on how to integrate Eufy devices into Home Assistant."
-date: 2018-04-09 19:00
-sidebar: true
-comments: false
-sharing: true
-footer: true
logo: eufy.png
ha_category:
- Hub
diff --git a/source/_components/everlights.markdown b/source/_components/everlights.markdown
index 09d33ec971f..cc9c1a92ac6 100644
--- a/source/_components/everlights.markdown
+++ b/source/_components/everlights.markdown
@@ -1,12 +1,6 @@
---
-layout: page
title: "EverLights Light"
description: "Instructions on how to set up EverLights within Home Assistant."
-date: 2018-12-29
-sidebar: true
-comments: false
-sharing: true
-footer: true
logo: everlights.png
ha_category:
- Light
diff --git a/source/_components/evohome.markdown b/source/_components/evohome.markdown
index e457b8c691d..37579a80c23 100644
--- a/source/_components/evohome.markdown
+++ b/source/_components/evohome.markdown
@@ -1,12 +1,6 @@
---
-layout: page
title: "Honeywell evohome/TCC systems"
description: "Instructions on how to integrate a Honeywell evohome/TCC system with Home Assistant."
-date: 2018-09-25 12:00
-sidebar: true
-comments: false
-sharing: true
-footer: true
logo: honeywell.png
ha_category:
- Hub
@@ -62,12 +56,12 @@ password:
location_idx:
description: Used to select which location to use, if your login has access to more than one location. Multiple locations at one time are not supported.
required: false
- type: int
+ type: integer
default: 0
scan_interval:
description: How often updates are retrieved from Honeywell's web servers. The minimum value is 60 seconds.
required: false
- type: int
+ type: integer
default: 300
{% endconfiguration %}
diff --git a/source/_components/facebook.markdown b/source/_components/facebook.markdown
index 2ae65844614..18732d859a3 100644
--- a/source/_components/facebook.markdown
+++ b/source/_components/facebook.markdown
@@ -1,12 +1,6 @@
---
-layout: page
title: "Facebook Messenger"
description: "Instructions on how to add Facebook user notifications to Home Assistant."
-date: 2016-12-31 14:14
-sidebar: true
-comments: false
-sharing: true
-footer: true
logo: facebook.png
ha_category:
- Notifications
diff --git a/source/_components/facebox.markdown b/source/_components/facebox.markdown
index e77f812d912..4cb4dd14a9d 100644
--- a/source/_components/facebox.markdown
+++ b/source/_components/facebox.markdown
@@ -1,12 +1,6 @@
---
-layout: page
title: "Facebox"
description: "Detect and recognize faces with Facebox."
-date: 2018-05-03 00:00
-sidebar: true
-comments: false
-sharing: true
-footer: true
logo: machine-box.png
ha_category:
- Image Processing
diff --git a/source/_components/fail2ban.markdown b/source/_components/fail2ban.markdown
index ceefb1c8769..5d57383f163 100644
--- a/source/_components/fail2ban.markdown
+++ b/source/_components/fail2ban.markdown
@@ -1,12 +1,6 @@
---
-layout: page
title: "Fail2Ban Sensor"
description: "Instructions on how to integrate a fail2ban sensor into Home Assistant."
-date: 2017-10-19 10:30
-sidebar: true
-comments: false
-sharing: true
-footer: true
ha_category:
- Network
ha_iot_class: Local Polling
@@ -19,9 +13,11 @@ redirect_from:
The `fail2ban` sensor allows for IPs banned by [fail2ban](https://www.fail2ban.org/wiki/index.php/Main_Page) to be displayed in the Home Assistant frontend.
-
+
+
Your system must have `fail2ban` installed and correctly configured for this sensor to work. In addition, Home Assistant must be able to read the `fail2ban` log file.
-
+
+
## Configuration
@@ -59,9 +55,11 @@ For most setups, you can follow [this tutorial](/cookbook/fail2ban/) to set up `
### Fail2Ban with Docker
-
+
+
These steps assume you already have the Home Assistant docker running behind NGINX and that it is externally accessible. It also assumes the docker is running with the `--net='host'` flag.
-
+
+
For those of us using Docker, the above tutorial may not be sufficient. The following steps specifically outline how to set up `fail2ban` and Home Assistant when running Home Assistant within a Docker behind NGINX. The setup this was tested on was an unRAID server using the [let's encrypt docker](https://github.com/linuxserver/docker-letsencrypt) from linuxserver.io.
diff --git a/source/_components/familyhub.markdown b/source/_components/familyhub.markdown
index 8976e766cd8..bfd9b36fced 100644
--- a/source/_components/familyhub.markdown
+++ b/source/_components/familyhub.markdown
@@ -1,12 +1,6 @@
---
-layout: page
title: "Family Hub Camera"
description: "Instructions on how to integrate Samsung Family Hub refrigerator cameras within Home Assistant."
-date: 2018-05-04 09:44
-sidebar: true
-comments: false
-sharing: true
-footer: true
logo: familyhub.png
ha_category:
- Camera
diff --git a/source/_components/fan.markdown b/source/_components/fan.markdown
index 837749a1101..cdf478a8211 100644
--- a/source/_components/fan.markdown
+++ b/source/_components/fan.markdown
@@ -1,12 +1,6 @@
---
-layout: page
title: "Fan"
description: "Instructions on how to setup Fan devices within Home Assistant."
-date: 2016-08-26 19:00
-sidebar: true
-comments: false
-sharing: true
-footer: true
logo: home-assistant.png
ha_category:
- Fan
diff --git a/source/_components/fan.mqtt.markdown b/source/_components/fan.mqtt.markdown
index bdb177d3663..60471283ece 100644
--- a/source/_components/fan.mqtt.markdown
+++ b/source/_components/fan.mqtt.markdown
@@ -1,12 +1,6 @@
---
-layout: page
title: "MQTT Fan"
description: "Instructions on how to integrate MQTT fans into Home Assistant."
-date: 2016-08-27 09:00
-sidebar: true
-comments: false
-sharing: true
-footer: true
logo: mqtt.png
ha_category:
- Fan
@@ -128,7 +122,7 @@ speed_value_template:
speeds:
description: "List of speeds this fan is capable of running at. Valid entries are `off`, `low`, `medium` and `high`."
required: false
- type: string list
+ type: [string, list]
availability_topic:
description: The MQTT topic subscribed to receive availability (online/offline) updates.
required: false
@@ -163,11 +157,11 @@ device:
identifiers:
description: A list of IDs that uniquely identify the device. For example a serial number.
required: false
- type: list, string
+ type: [string, list]
connections:
description: 'A list of connections of the device to the outside world as a list of tuples `[connection_type, connection_identifier]`. For example the MAC address of a network interface: `"connections": [["mac", "02:5b:26:a8:dc:12"]]`.'
required: false
- type: list, tuple
+ type: [list, map]
manufacturer:
description: The manufacturer of the device.
required: false
@@ -186,9 +180,11 @@ device:
type: string
{% endconfiguration %}
-
+
+
Make sure that your topics match exactly. `some-topic/` and `some-topic` are different topics.
-
+
+
## Examples
diff --git a/source/_components/fan.template.markdown b/source/_components/fan.template.markdown
index 7309eec950f..077030cd16f 100644
--- a/source/_components/fan.template.markdown
+++ b/source/_components/fan.template.markdown
@@ -1,12 +1,6 @@
---
-layout: page
title: "Template Fan"
description: "Instructions how to setup the Template fans within Home Assistant."
-date: 2018-05-03 09:00
-sidebar: true
-comments: false
-sharing: true
-footer: true
ha_category:
- Fan
ha_release: 0.69
@@ -106,6 +100,6 @@ fan:
speeds:
description: List of speeds the fan is capable of running at.
required: false
- type: string list
+ type: [string, list]
default: ['low', 'medium', 'high']
{% endconfiguration %}
diff --git a/source/_components/fan.xiaomi_miio.markdown b/source/_components/fan.xiaomi_miio.markdown
index 910a88b0d70..586db197c63 100644
--- a/source/_components/fan.xiaomi_miio.markdown
+++ b/source/_components/fan.xiaomi_miio.markdown
@@ -1,12 +1,6 @@
---
-layout: page
title: "Xiaomi Air Purifier"
description: "Instructions on how to integrate your Xiaomi Air Purifier and Xiaomi Air Humidifier within Home Assistant."
-date: 2017-10-13 12:35
-sidebar: true
-comments: false
-sharing: true
-footer: true
logo: xiaomi.png
ha_category:
- Fan
diff --git a/source/_components/fastdotcom.markdown b/source/_components/fastdotcom.markdown
index 562fd9400bf..d0fa17548da 100644
--- a/source/_components/fastdotcom.markdown
+++ b/source/_components/fastdotcom.markdown
@@ -1,12 +1,6 @@
---
-layout: page
title: "Fast.com"
description: "How to integrate Fast.com within Home Assistant."
-date: 2019-02-01 21:30
-sidebar: true
-comments: false
-sharing: true
-footer: true
logo: fastdotcom.png
ha_category:
- System Monitor
@@ -19,9 +13,11 @@ redirect_from:
The `fastdotcom` integration uses the [Fast.com](https://fast.com/) web service to measure network bandwidth performance.
-
+
+
Currently fast.com only supports measuring download bandwidth. If you want to measure bandwidth metrics other then download such as ping and upload, utilize the [speedtest](/components/sensor.speedtest) component.
-
+
+
Enabling this integration will automatically create the Fast.com Sensor.
diff --git a/source/_components/fedex.markdown b/source/_components/fedex.markdown
index 9673ee4eed4..f76314d70bb 100644
--- a/source/_components/fedex.markdown
+++ b/source/_components/fedex.markdown
@@ -1,12 +1,6 @@
---
-layout: page
title: Fedex Sensor
description: "Instructions on how to set up FedEx sensors within Home Assistant."
-date: 2017-02-14 08:00
-sidebar: true
-comments: false
-sharing: true
-footer: true
logo: fedex.png
ha_category:
- Postal Service
@@ -48,6 +42,6 @@ Configuration options for the FedEx Sensor:
milliseconds: 0
-
+
The FedEx sensor logs into the FedEx Delivery Manager website to scrape package data. It does not use an API. Use at your own risk.
-
+
diff --git a/source/_components/feedreader.markdown b/source/_components/feedreader.markdown
index d79437e2a7e..98b1b7fcd6d 100644
--- a/source/_components/feedreader.markdown
+++ b/source/_components/feedreader.markdown
@@ -1,12 +1,6 @@
---
-layout: page
title: Feedreader
description: "Instructions on how to integrate RSS feeds into Home Assistant."
-date: 2016-04-18 22:00
-sidebar: true
-comments: false
-sharing: true
-footer: true
logo: rss.gif
ha_category:
- Other
@@ -35,7 +29,7 @@ feedreader:
description: Defines the update interval of the feeds.
required: false
default: 1 hour
- type: interval
+ type: time
max_entries:
description: The maximum number of entries to extract from each feed.
required: false
diff --git a/source/_components/ffmpeg.markdown b/source/_components/ffmpeg.markdown
index be586c9c01d..0e7dc2173ab 100644
--- a/source/_components/ffmpeg.markdown
+++ b/source/_components/ffmpeg.markdown
@@ -1,12 +1,6 @@
---
-layout: page
title: "FFmpeg"
description: "Instructions on how to integrate FFmpeg within Home Assistant."
-date: 2016-09-14 00:00
-sidebar: true
-comments: false
-sharing: true
-footer: true
logo: ffmpeg.png
ha_category:
- Image Processing
@@ -15,13 +9,17 @@ ha_release: 0.29
The `ffmpeg` integration allows other Home Assistant integrations to process video and audio streams. This integration supports all FFmpeg versions since 3.0.0; if you have an older version, please update.
-
-You need the `ffmpeg` binary in your system path. On Hassbian you will need to login as the `pi` user and `sudo apt install ffmpeg`. On Debian 8 or Raspbian (Jessie) you can install it from [debian-backports](https://backports.debian.org/Instructions/). If you want [hardware acceleration](https://trac.ffmpeg.org/wiki/HWAccelIntro) support on a Raspberry Pi, you will need to build from source by yourself. Windows binaries are available on the [FFmpeg](http://www.ffmpeg.org/) website.
-
+
+
+You need the `ffmpeg` binary in your system path. On Hassbian you will need to login as the `pi` user and `sudo apt install ffmpeg`. On Debian 8 or Raspbian (Jessie) you can install it from [debian-backports](https://backports.debian.org/Instructions/). If you want [hardware acceleration](https://trac.ffmpeg.org/wiki/HWAccelIntro) support on a Raspberry Pi, you will need to build from source by yourself. Windows binaries are available on the [FFmpeg](http://www.ffmpeg.org/) website.
+
+
+
+
-
If you are using [Hass.io](/hassio/) then just move forward to the configuration as all requirements are already fulfilled.
-
+
+
+
+
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*.
-
+
+
## Motion
diff --git a/source/_components/ffmpeg_noise.markdown b/source/_components/ffmpeg_noise.markdown
index 24792aad04f..926f957d601 100644
--- a/source/_components/ffmpeg_noise.markdown
+++ b/source/_components/ffmpeg_noise.markdown
@@ -1,12 +1,6 @@
---
-layout: page
title: "FFmpeg Noise Binary Sensor"
description: "Instructions on how to integrate an FFmpeg-based noise binary sensor"
-date: 2016-08-25 08:00
-sidebar: true
-comments: false
-sharing: true
-footer: true
logo: ffmpeg.png
ha_category:
- Image Processing
@@ -17,9 +11,11 @@ redirect_from:
The `ffmpeg` platform allows you to use any video or audio feed with [FFmpeg](http://www.ffmpeg.org/) for various sensors in Home Assistant.
-
+
+
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*.
-
+
+
## Configuration
diff --git a/source/_components/fibaro.markdown b/source/_components/fibaro.markdown
index efafc31d291..72ea2d53ece 100644
--- a/source/_components/fibaro.markdown
+++ b/source/_components/fibaro.markdown
@@ -1,12 +1,6 @@
---
-layout: page
title: "Fibaro"
description: "Instructions on how to setup Fibaro Z-Wave hubs (HCL and HC2) and configure devices within Home Assistant."
-date: 2019-01-10 20:04
-sidebar: true
-comments: false
-sharing: true
-footer: true
logo: fibaro.png
ha_category:
- Hub
@@ -70,7 +64,7 @@ gateways:
url:
description: The URL for your Fibaro HomeCenter device.
required: true
- type: url
+ type: string
username:
description: The username for your Fibaro account.
required: true
@@ -82,7 +76,7 @@ password:
plugins:
description: Whether to import plugin-generated devices from Fibaro HomeCenter, such as Netatmo and Sonos devices, etc.
required: false
- type: bool
+ type: boolean
default: false
device_config:
description: Lists device specific parameter or behaviour overrides.
@@ -91,9 +85,11 @@ device_config:
default: None
{% endconfiguration %}
-
+
+
It is recommended to assign a static IP address to your Fibaro controller. This ensures that it won't change its IP address, so you won't have to change the `url` if the controller reboots and comes up with a different IP address. See your router's manual for details on how to set this up. If you need the MAC address of your Fibaro, check the label on the bottom.
-
+
+
### Using Z-Wave devices in automation
diff --git a/source/_components/fido.markdown b/source/_components/fido.markdown
index 96d7bfca41b..c4da6da4d67 100644
--- a/source/_components/fido.markdown
+++ b/source/_components/fido.markdown
@@ -1,12 +1,6 @@
---
-layout: page
title: "Fido Sensor"
description: "Instructions on how to integrate Fido data usage within Home Assistant."
-date: 2017-01-01 17:17
-sidebar: true
-comments: false
-sharing: true
-footer: true
logo: fido.png
ha_category:
- Network
diff --git a/source/_components/file.markdown b/source/_components/file.markdown
index 35f0a3a0ad9..981bc079665 100644
--- a/source/_components/file.markdown
+++ b/source/_components/file.markdown
@@ -1,12 +1,6 @@
---
-layout: page
title: "File"
description: "Instructions on how to integrate sensors which read from files into Home Assistant."
-date: 2015-06-22 10:00
-sidebar: true
-comments: false
-sharing: true
-footer: true
logo: file.png
ha_category:
- Utility
diff --git a/source/_components/filesize.markdown b/source/_components/filesize.markdown
index 3f6d8fde2db..666ba7a2f8a 100644
--- a/source/_components/filesize.markdown
+++ b/source/_components/filesize.markdown
@@ -1,12 +1,6 @@
---
-layout: page
title: "File size Sensor"
description: "Component for monitoring the size of a file."
-date: 2018-02-06 14:00
-sidebar: true
-comments: false
-sharing: true
-footer: true
logo: file.png
ha_category:
- Utility
@@ -33,5 +27,5 @@ sensor:
file_paths:
description: The absolute path to the file.
required: true
- type: list of strings
+ type: list
{% endconfiguration %}
diff --git a/source/_components/filter.markdown b/source/_components/filter.markdown
index 65678b31807..9bd8417f0e1 100644
--- a/source/_components/filter.markdown
+++ b/source/_components/filter.markdown
@@ -1,12 +1,6 @@
---
-layout: page
title: "Filter Sensor"
description: "Instructions on how to integrate Data Filter Sensors into Home Assistant."
-date: 2018-02-20
-sidebar: true
-comments: false
-sharing: true
-footer: true
ha_category:
- Utility
ha_release: 0.65
@@ -79,7 +73,7 @@ filters:
window_size:
description: Size of the window of previous states. Time based filters such as `time_simple_moving_average` will require a time period (size in time), while other filters such as `outlier` will require an integer (size in number of states)
required: false
- type: [int, time]
+ type: [integer, time]
default: 1
precision:
description: See [_lowpass_](#low-pass) filter. Defines the precision of the filtered state, through the argument of round().
diff --git a/source/_components/fints.markdown b/source/_components/fints.markdown
index 6a5247ab1e4..b3fe72cb42c 100644
--- a/source/_components/fints.markdown
+++ b/source/_components/fints.markdown
@@ -1,12 +1,6 @@
---
-layout: page
title: "FinTS Sensor"
description: "Instructions on how to use the FinTS sensor."
-date: 2018-03-25 13:00
-sidebar: true
-comments: false
-sharing: true
-footer: true
ha_category:
- Finance
ha_release: "0.70"
diff --git a/source/_components/fitbit.markdown b/source/_components/fitbit.markdown
index b841e48f400..93dba7106b7 100644
--- a/source/_components/fitbit.markdown
+++ b/source/_components/fitbit.markdown
@@ -1,12 +1,6 @@
---
-layout: page
title: "Fitbit"
description: "Instructions on how to integrate Fitbit devices within Home Assistant."
-date: 2016-05-09 15:01
-sidebar: true
-comments: false
-sharing: true
-footer: true
logo: fitbit.png
ha_category:
- Health
diff --git a/source/_components/fixer.markdown b/source/_components/fixer.markdown
index 1d11848b626..d971a706bd5 100644
--- a/source/_components/fixer.markdown
+++ b/source/_components/fixer.markdown
@@ -1,12 +1,6 @@
---
-layout: page
title: "Fixer.io"
description: "Instructions on how to integrate exchange rates from Fixer.io within Home Assistant."
-date: 2016-06-20 10:00
-sidebar: true
-comments: false
-sharing: true
-footer: true
ha_category:
- Finance
logo: fixer-io.png
diff --git a/source/_components/flexit.markdown b/source/_components/flexit.markdown
index 44af442acc6..ac686656388 100644
--- a/source/_components/flexit.markdown
+++ b/source/_components/flexit.markdown
@@ -1,12 +1,6 @@
---
-layout: page
title: "Flexit A/C controller"
description: "Instructions on how to integrate Flexit A/C unit into Home Assistant."
-date: 2017-06-02 16:30 +0200
-sidebar: true
-comments: false
-sharing: true
-footer: true
logo: flexit.png
ha_category:
- Climate
@@ -45,9 +39,11 @@ hub:
type: string
{% endconfiguration %}
-
+
+
This integration requires the [Modbus](/components/modbus/) integration to be set up to work
-
+
+
Full configuration example including modbus setup shown below:
diff --git a/source/_components/flic.markdown b/source/_components/flic.markdown
index 6379ec0408f..3cf2602b7f4 100644
--- a/source/_components/flic.markdown
+++ b/source/_components/flic.markdown
@@ -1,12 +1,6 @@
---
-layout: page
title: Flic Smart Button
description: "Instructions on how to integrate flic buttons within Home Assistant."
-date: 2016-12-02 22:03
-sidebar: true
-comments: false
-sharing: true
-footer: true
logo: flic.png
ha_category:
- Binary Sensor
@@ -22,7 +16,7 @@ The platform does not directly interact with the buttons, *but communicates with
#### Service setup
-If you are using Hass.io, you can run the service locally by [installing](/hassio/installing_third_party_addons/) the flicd add-on from [pschmitt's repository](https://github.com/pschmitt/hassio-addons). On a Hass.io installation that's not yet based on HassOS, you also need to install the [bluetooth add-on](/addons/bluetooth_bcm43xx/).
+If you are using Hass.io, you can run the service locally by [installing](/hassio/installing_third_party_addons/) the flicd add-on from [pschmitt's repository](https://github.com/pschmitt/hassio-addons).
For instructions on how to install the service manually, visit the GitHub repository of the service for [Linux](https://github.com/50ButtonsEach/fliclib-linux-hci), [OS X](https://github.com/50ButtonsEach/flic-service-osx) or [Windows](https://github.com/50ButtonsEach/fliclib-windows).
diff --git a/source/_components/flock.markdown b/source/_components/flock.markdown
index e82290757c7..cf51432bf99 100644
--- a/source/_components/flock.markdown
+++ b/source/_components/flock.markdown
@@ -1,12 +1,6 @@
---
-layout: page
title: "Flock"
description: "Instructions on how to add Flock notifications to Home Assistant."
-date: 2017-08-17 18:00
-sidebar: true
-comments: false
-sharing: true
-footer: true
logo: flock.png
ha_category:
- Notifications
diff --git a/source/_components/flunearyou.markdown b/source/_components/flunearyou.markdown
index cb16b130615..3837099eb72 100644
--- a/source/_components/flunearyou.markdown
+++ b/source/_components/flunearyou.markdown
@@ -1,12 +1,6 @@
---
-layout: page
title: "Flu Near You"
description: "Instructions on how to use Flu Near You data within Home Assistant"
-date: 2018-11-02 21:05
-sidebar: true
-comments: false
-sharing: true
-footer: true
logo: flunearyou.png
ha_category:
- Health
@@ -39,13 +33,13 @@ monitored_conditions:
default: ['cdc_report', 'user_report']
latitude:
description: The latitude of the location to monitor.
- required: optional
- type: string
+ required: false
+ type: float
default: The latitude defined under the `homeassistant` key in `configuration.yaml`.
longitude:
description: The longitude of the location to monitor.
- required: optional
- type: string
+ required: false
+ type: float
default: The longitude defined under the `homeassistant` key in `configuration.yaml`.
{% endconfiguration %}
diff --git a/source/_components/flux.markdown b/source/_components/flux.markdown
index b0cd5a095a2..98df65023e1 100644
--- a/source/_components/flux.markdown
+++ b/source/_components/flux.markdown
@@ -1,12 +1,6 @@
---
-layout: page
title: "Flux Light Adjustment"
description: "Instructions on how to have switches call command line commands."
-date: 2016-06-01 17:41
-sidebar: true
-comments: false
-sharing: true
-footer: true
ha_category:
- Automation
ha_release: 0.21
@@ -78,6 +72,7 @@ disable_brightness_adjust:
description: If true, brightness will not be adjusted besides color temperature.
required: false
type: boolean
+ default: false
mode:
description: Select how color temperature is passed to lights. Valid values are `xy`, `mired` and `rgb`.
required: false
diff --git a/source/_components/flux_led.markdown b/source/_components/flux_led.markdown
index d2aed2bdfbd..99da271f031 100644
--- a/source/_components/flux_led.markdown
+++ b/source/_components/flux_led.markdown
@@ -1,12 +1,6 @@
---
-layout: page
title: "Flux Led/MagicLight"
description: "Instructions on how to setup Flux led/MagicLight within Home Assistant."
-date: 2015-07-17 20:09
-sidebar: true
-comments: false
-sharing: true
-footer: true
logo: magic_light.png
ha_category:
- Light
@@ -87,10 +81,12 @@ devices:
default: gradual
{% endconfiguration %}
-
+
+
Depending on your controller or bulb type, there are two ways to configure brightness.
The integration defaults to rgbw. If your device has a separate white channel, you do not need to specify anything else; changing the white value will adjust the brightness of white channel keeping rgb color constant. However, if your device does not have a separate white channel, you will need to set the mode to rgb. In this mode, the device will keep the same color, and adjust the rgb values to dim or brighten the color.
-
+
+
### Example configuration
diff --git a/source/_components/folder.markdown b/source/_components/folder.markdown
index 1041e990e72..2244d28c0bc 100644
--- a/source/_components/folder.markdown
+++ b/source/_components/folder.markdown
@@ -1,12 +1,6 @@
---
-layout: page
title: "Folder sensor"
description: "Sensor for monitoring the contents of a folder."
-date: 2018-02-21 14:00
-sidebar: true
-comments: false
-sharing: true
-footer: true
logo: file.png
ha_category:
- Utility
diff --git a/source/_components/folder_watcher.markdown b/source/_components/folder_watcher.markdown
index 551a934246a..41e6de16f6f 100644
--- a/source/_components/folder_watcher.markdown
+++ b/source/_components/folder_watcher.markdown
@@ -1,12 +1,6 @@
---
-layout: page
title: "Folder Watcher"
description: "Component for monitoring changes within the filesystem."
-date: 2018-03-11 14:00
-sidebar: true
-comments: false
-sharing: true
-footer: true
logo: home-assistant.png
ha_category:
- System Monitor
diff --git a/source/_components/foobot.markdown b/source/_components/foobot.markdown
index 5a10d9ca0ce..a52fad0e8d1 100644
--- a/source/_components/foobot.markdown
+++ b/source/_components/foobot.markdown
@@ -1,12 +1,6 @@
---
-layout: page
title: "Foobot Air Quality Monitor"
description: "Instructions on how to setup Foobot Air Quality sensor in Home Assistant."
-date: 2018-02-14 06:00
-sidebar: true
-comments: false
-sharing: true
-footer: true
logo: foobot.png
ha_category:
- Health
diff --git a/source/_components/foscam.markdown b/source/_components/foscam.markdown
index 7cf9451dcc4..dc7417c6abb 100644
--- a/source/_components/foscam.markdown
+++ b/source/_components/foscam.markdown
@@ -1,12 +1,6 @@
---
-layout: page
title: "Foscam IP Camera"
description: "Instructions on how to integrate Foscam IP cameras within Home Assistant."
-date: 2015-09-17 08:01
-sidebar: true
-comments: false
-sharing: true
-footer: true
logo: foscam.png
ha_category:
- Camera
@@ -60,9 +54,9 @@ name:
type: string
{% endconfiguration %}
-
+
There seems to be some issues within Foscam with lengthy passwords and passwords containing certain symbols. Be sure to check your camera's documentation.
-
+
### Control Foscam PTZ (Pan/Tilt/Zoom) - Home/Away
diff --git a/source/_components/foursquare.markdown b/source/_components/foursquare.markdown
index d5dc45dce43..307324cbc74 100644
--- a/source/_components/foursquare.markdown
+++ b/source/_components/foursquare.markdown
@@ -1,12 +1,6 @@
---
-layout: page
title: Foursquare
description: "Instructions on how to the Foursquare API into Home Assistant."
-date: 2016-08-08 17:20
-sidebar: true
-comments: false
-sharing: true
-footer: true
logo: foursquare.png
ha_category:
- Social
diff --git a/source/_components/free_mobile.markdown b/source/_components/free_mobile.markdown
index 7b231a1182d..c4a061eebd0 100644
--- a/source/_components/free_mobile.markdown
+++ b/source/_components/free_mobile.markdown
@@ -1,12 +1,6 @@
---
-layout: page
title: "Free Mobile"
description: "Instructions on how to add user notifications to Home Assistant."
-date: 2016-01-12 08:36
-sidebar: true
-comments: false
-sharing: true
-footer: true
logo: free_mobile.png
ha_category:
- Notifications
@@ -25,9 +19,9 @@ Before doing anything, you have to activate the SMS API option in your Free Mobi
This API only send classic SMS and only on the cell phone of the account owner. So you only have to provide a text message in your payload.
-
+
If you disable and re-enable the SMS API option, please be sure to update your token in your configuration.
-
+
To enable SMS notifications in your installation, add the following to your `configuration.yaml` file:
diff --git a/source/_components/freebox.markdown b/source/_components/freebox.markdown
index d50c2e34c1c..04327b4e502 100644
--- a/source/_components/freebox.markdown
+++ b/source/_components/freebox.markdown
@@ -1,12 +1,6 @@
---
-layout: page
title: "Freebox"
description: "Instructions on how to integrate Freebox routers into Home Assistant."
-date: 2018-11-15 20:00
-sidebar: true
-comments: false
-sharing: true
-footer: true
logo: freebox.svg
ha_category:
- Network
@@ -57,9 +51,9 @@ returned json should contain an api_domain (`host`) and a https_port (`port`).
### Initial setup
-
+
You must have set a password for your Freebox router web administration page. Enable the option "Permettre les nouvelles demandes d'associations" and check that the option "Accès à distance sécurisé à Freebox OS" is active in "Gestion des ports" > "Connexions entrantes".
-
+
The first time Home Assistant will connect to your Freebox, you will need to
authorize it by pressing the right arrow on the facade of the Freebox when
diff --git a/source/_components/freedns.markdown b/source/_components/freedns.markdown
index 251844f64c6..bf1dec6b950 100644
--- a/source/_components/freedns.markdown
+++ b/source/_components/freedns.markdown
@@ -1,13 +1,7 @@
---
-layout: page
title: "freedns.afraid.org"
description: "Keep your DNS record up to date with FreeDNS."
-date: 2018-03-27 21:30
-sidebar: true
-comments: false
-sharing: true
logo: afraid_freedns.png
-footer: true
ha_category:
- Network
ha_release: 0.67
@@ -48,6 +42,6 @@ freedns:
scan_interval:
description: How often to call the update service.
required: false
- type: time period
+ type: time
default: 10 minutes
{% endconfiguration %}
diff --git a/source/_components/fritz.markdown b/source/_components/fritz.markdown
index c92dad1bd0a..064c781671c 100644
--- a/source/_components/fritz.markdown
+++ b/source/_components/fritz.markdown
@@ -1,12 +1,6 @@
---
-layout: page
title: "FRITZ!Box"
description: "Instructions on how to integrate AVM FRITZ!Box based routers into Home Assistant."
-date: 2015-12-13 19:00
-sidebar: true
-comments: false
-sharing: true
-footer: true
logo: avm.png
ha_category:
- Presence Detection
@@ -20,9 +14,9 @@ The `fritz` platform offers presence detection by looking at connected devices t
## Setup
-
-It might be necessary to install additional packages: $ sudo apt-get install python3-lxml libxslt-dev libxml2-dev zlib1g-dev
-If you installed Home Assistant in a virtualenv, run the following commands inside it: $ pip3 install lxml; be patient this will take a while.
+
+It might be necessary to install additional packages: sudo apt-get install python3-lxml libxslt-dev libxml2-dev zlib1g-dev
+If you installed Home Assistant in a virtualenv, run the following commands inside it: pip3 install lxml; be patient this will take a while.
## Configuration
@@ -49,8 +43,8 @@ password:
type: string
{% endconfiguration %}
-
+
It seems that it is not necessary to use the password in current generation Fritz!Box routers because the necessary data can be retrieved anonymously.
-
+
See the [device tracker integration page](/components/device_tracker/) for instructions how to configure the people to be tracked.
diff --git a/source/_components/fritzbox.markdown b/source/_components/fritzbox.markdown
index 4afc8b1eb06..3e3722c6c65 100644
--- a/source/_components/fritzbox.markdown
+++ b/source/_components/fritzbox.markdown
@@ -1,12 +1,6 @@
---
-layout: page
title: "Fritzbox"
description: "Instructions on how to integrate the AVM Fritzbox Smart Home components."
-date: 2018-02-18 17:10
-sidebar: true
-comments: false
-sharing: true
-footer: true
logo: avm.png
ha_category:
- Binary Sensor
diff --git a/source/_components/fritzbox_callmonitor.markdown b/source/_components/fritzbox_callmonitor.markdown
index 674d745d81e..92a2a841775 100644
--- a/source/_components/fritzbox_callmonitor.markdown
+++ b/source/_components/fritzbox_callmonitor.markdown
@@ -1,12 +1,6 @@
---
-layout: page
title: "FRITZ!Box Call Monitor"
description: "Instructions on how to integrate a phone call monitor for AVM FRITZ!Box routers into Home Assistant."
-date: 2016-08-13 15:00
-sidebar: true
-comments: false
-sharing: true
-footer: true
logo: avm.png
ha_category:
- System Monitor
diff --git a/source/_components/fritzbox_netmonitor.markdown b/source/_components/fritzbox_netmonitor.markdown
index fced5ad5c9f..6e4b8ce1f35 100644
--- a/source/_components/fritzbox_netmonitor.markdown
+++ b/source/_components/fritzbox_netmonitor.markdown
@@ -1,12 +1,6 @@
---
-layout: page
title: "FRITZ!Box Net Monitor"
description: "Instructions on how to integrate an AVM FRITZ!Box monitor into Home Assistant."
-date: 2017-01-17 22:00
-sidebar: true
-comments: false
-sharing: true
-footer: true
logo: avm.png
ha_category:
- System Monitor
@@ -18,10 +12,10 @@ redirect_from:
The `fritzbox_netmonitor` sensor monitors the network statistics exposed by [AVM Fritz!Box](http://avm.de/produkte/fritzbox/) routers.
-
-It might be necessary to install additional packages: $ sudo apt-get install libxslt-dev libxml2-dev python3-lxml
-If you are working with the All-in-One installation, you may also need to execute also within your virtual environment the command pip3 install lxml; be patient this will take a while.
-
+
+It might be necessary to install additional packages: sudo apt-get install libxslt-dev libxml2-dev python3-lxml
+If you are working with the All-in-One installation, you may also need to execute also within your virtual environment the command pip3 install lxml; be patient this will take a while.
+
To use the Fritz!Box network monitor in your installation, add the following to your `configuration.yaml` file:
@@ -62,6 +56,6 @@ The following statistics will be exposed as attributes.
The sensor's state corresponds to the `is_linked` attribute and is either `online`, `offline`, or `unavailable` (in case connection to the router is lost).
-
+
This integration does not support "Fritz!Box 6490 Cable" with FritzOS 6.87 installed.
-
+
diff --git a/source/_components/fritzdect.markdown b/source/_components/fritzdect.markdown
index 1b568645d31..fc0a229b4e6 100644
--- a/source/_components/fritzdect.markdown
+++ b/source/_components/fritzdect.markdown
@@ -1,12 +1,6 @@
---
-layout: page
title: "AVM FRITZ!DECT Switch"
description: "Instructions on how to integrate your AVM FRITZ!DECT switches into Home Assistant."
-date: 2017-01-24 21:00
-sidebar: true
-comments: false
-sharing: true
-footer: true
logo: avm.png
ha_category:
- Switch
@@ -56,6 +50,6 @@ host:
It is recommended to create a dedicated user for Home Assistant and only allow access to "Smart Home".
-
+
If this integration throws an error when starting home-assistant you should check if all actors are plugged in and connected to the FritzBox. Inactive actors that are not deleted from FritzBox configuration might lead to errors.
-
+
diff --git a/source/_components/frontend.markdown b/source/_components/frontend.markdown
index 7b3d7e5a2c7..6efe0efa3da 100644
--- a/source/_components/frontend.markdown
+++ b/source/_components/frontend.markdown
@@ -1,12 +1,6 @@
---
-layout: page
title: "Frontend"
description: "Offers a frontend to Home Assistant."
-date: 2015-12-06 21:35
-sidebar: true
-comments: false
-sharing: true
-footer: true
logo: home-assistant.png
ha_category:
- Other
diff --git a/source/_components/frontier_silicon.markdown b/source/_components/frontier_silicon.markdown
index 7558b7e03e6..d71ce1e1d33 100644
--- a/source/_components/frontier_silicon.markdown
+++ b/source/_components/frontier_silicon.markdown
@@ -1,12 +1,7 @@
---
-layout: page
title: "Frontier Silicon Internet Radios"
description: "Instructions on how to integrate Frontier Silicon Internet Radios into Home Assistant."
-date: 2017-02-04 00:01
-sidebar: true
-comments: false
-sharing: true
-footer: true
+logo: frontier.png
ha_category:
- Media Player
ha_iot_class: Local Push
@@ -94,10 +89,12 @@ is based on [tiwillam]'s fsapi project. Special thanks to both developers, this
## Notes and Limitations
-
+
+
The Frontier Silicon API does not provide a multi-user environment. There is always a single user (session) controlling a device, which means that once Home Assistant connects to a device all other sessions will be invalidated. This renders the usage of [UNDOK] almost impossible, as the Home Assistant integration polls the device state every 30 seconds or issues a command by creating a new session.
*If you want to prevent Home Assistant to auto connect to your device, simply change the PIN code of the device to something else than: 1234*
-
+
+
[Frontier Silicon chipset]: http://www.frontier-silicon.com/digital-radio-solutions
[Medion Radios]: http://internetradio.medion.com/
diff --git a/source/_components/futurenow.markdown b/source/_components/futurenow.markdown
index 647d56b7f4b..d31f61d51ea 100644
--- a/source/_components/futurenow.markdown
+++ b/source/_components/futurenow.markdown
@@ -1,12 +1,6 @@
---
-layout: page
title: "P5 FutureNow Lights"
description: "Instructions on how to set up P5 FutureNow relay/dimmer units as lights within Home Assistant."
-date: 2018-07-24 15:00
-sidebar: true
-comments: false
-sharing: true
-footer: true
logo: p5.png
ha_category:
- Light
diff --git a/source/_components/garadget.markdown b/source/_components/garadget.markdown
index 2767f7d8de8..38f382effe0 100644
--- a/source/_components/garadget.markdown
+++ b/source/_components/garadget.markdown
@@ -1,12 +1,6 @@
---
-layout: page
title: "Garadget Cover"
description: "Instructions on how to integrate Garadget covers within Home Assistant."
-date: 2016-10-24 14:25
-sidebar: true
-comments: false
-sharing: true
-footer: true
logo: garadget.png
ha_category:
- Cover
diff --git a/source/_components/gc100.markdown b/source/_components/gc100.markdown
index 7edb21fefd9..b073fba7e30 100644
--- a/source/_components/gc100.markdown
+++ b/source/_components/gc100.markdown
@@ -1,12 +1,6 @@
---
-layout: page
title: "gc100"
description: "Instructions on how to integrate gc100 with Home Assistant."
-date: 2017-10-26 17:20
-sidebar: true
-comments: false
-sharing: true
-footer: true
ha_category:
- Hub
- Binary Sensor
diff --git a/source/_components/gearbest.markdown b/source/_components/gearbest.markdown
index 1503ad714ec..7955c2b662a 100644
--- a/source/_components/gearbest.markdown
+++ b/source/_components/gearbest.markdown
@@ -1,12 +1,6 @@
---
-layout: page
title: "Gearbest"
description: "Instructions on how to integrate a Gearbest sensor into Home Assistant."
-date: 2017-11-13 09:08
-sidebar: true
-comments: false
-sharing: true
-footer: true
logo: gearbest.png
ha_category:
- Sensor
diff --git a/source/_components/geizhals.markdown b/source/_components/geizhals.markdown
index 7f27e62e3e2..6c823218e09 100644
--- a/source/_components/geizhals.markdown
+++ b/source/_components/geizhals.markdown
@@ -1,12 +1,6 @@
---
-layout: page
title: "Geizhals"
description: "Instructions on how to integrate a Geizhals sensor into Home Assistant."
-date: 2017-07-15 14:15
-sidebar: true
-comments: false
-sharing: true
-footer: true
logo: geizhals.png
ha_category:
- Sensor
diff --git a/source/_components/generic.markdown b/source/_components/generic.markdown
index 9295eae9bd7..71211d34b14 100644
--- a/source/_components/generic.markdown
+++ b/source/_components/generic.markdown
@@ -1,12 +1,6 @@
---
-layout: page
title: "Generic IP Camera"
description: "Instructions on how to integrate IP cameras within Home Assistant."
-date: 2015-07-11 0:36
-sidebar: true
-comments: false
-sharing: true
-footer: true
ha_category:
- Camera
logo: home-assistant.png
diff --git a/source/_components/generic_thermostat.markdown b/source/_components/generic_thermostat.markdown
index 5532d0cf10a..348c8911ae2 100644
--- a/source/_components/generic_thermostat.markdown
+++ b/source/_components/generic_thermostat.markdown
@@ -1,12 +1,6 @@
---
-layout: page
title: "Generic Thermostat"
description: "Turn Home Assistant into a thermostat"
-date: 2015-03-23 19:59
-sidebar: true
-comments: false
-sharing: true
-footer: true
logo: home-assistant.png
ha_category:
- Climate
@@ -59,6 +53,7 @@ ac_mode:
description: Set the switch specified in the *heater* option to be treated as a cooling device instead of a heating device.
required: false
type: boolean
+ default: false
min_cycle_duration:
description: Set a minimum amount of time that the switch specified in the *heater* option must be in its current state prior to being switched either off or on.
required: false
diff --git a/source/_components/geniushub.markdown b/source/_components/geniushub.markdown
index 2cedff9d5fe..cc5aeb34de8 100644
--- a/source/_components/geniushub.markdown
+++ b/source/_components/geniushub.markdown
@@ -1,12 +1,6 @@
---
-layout: page
title: "Genius Hub"
description: "Instructions on how to integrate Genius Hub with Home Assistant."
-date: 2019-03-03 16:00
-sidebar: true
-comments: false
-sharing: true
-footer: true
logo: geniushub.png
ha_category:
- Climate
diff --git a/source/_components/geo_json_events.markdown b/source/_components/geo_json_events.markdown
index f7856098e98..d1af720e800 100644
--- a/source/_components/geo_json_events.markdown
+++ b/source/_components/geo_json_events.markdown
@@ -1,12 +1,6 @@
---
-layout: page
title: "GeoJSON Events"
description: "Instructions on how to integrate GeoJSON feeds into Home Assistant."
-date: 2018-09-19 08:00
-sidebar: true
-comments: false
-sharing: true
-footer: true
logo: geo_location.png
ha_category:
- Geolocation
diff --git a/source/_components/geo_location.markdown b/source/_components/geo_location.markdown
index 8b6600e2444..b115262e62b 100644
--- a/source/_components/geo_location.markdown
+++ b/source/_components/geo_location.markdown
@@ -1,12 +1,6 @@
---
-layout: page
title: "Geolocation"
description: "Instructions on how to integrate geolocation aware platforms into Home Assistant."
-date: 2018-08-27 08:00
-sidebar: true
-comments: false
-sharing: true
-footer: true
logo: geo_location.png
ha_release: 0.78
---
diff --git a/source/_components/geo_rss_events.markdown b/source/_components/geo_rss_events.markdown
index a03fcc390a4..b522f74c101 100644
--- a/source/_components/geo_rss_events.markdown
+++ b/source/_components/geo_rss_events.markdown
@@ -1,12 +1,6 @@
---
-layout: page
title: GeoRSS Events Sensor
description: "Instructions on how to set up GeoRSS sensors within Home Assistant."
-date: 2017-07-31
-sidebar: true
-comments: false
-sharing: true
-footer: true
logo: rss.png
ha_category:
- Sensor
diff --git a/source/_components/geofency.markdown b/source/_components/geofency.markdown
index 58043c8fb36..5458b6207f6 100644
--- a/source/_components/geofency.markdown
+++ b/source/_components/geofency.markdown
@@ -1,12 +1,6 @@
---
-layout: page
title: "Geofency"
description: "Instructions for how to use Geofency to track devices in Home Assistant."
-date: 2017-08-22 19:00
-sidebar: true
-comments: false
-sharing: true
-footer: true
logo: geofency.png
ha_category:
- Presence Detection
diff --git a/source/_components/github.markdown b/source/_components/github.markdown
index 8ff1b4f3f8c..221b3c9027b 100644
--- a/source/_components/github.markdown
+++ b/source/_components/github.markdown
@@ -1,12 +1,6 @@
---
-layout: page
title: "GitHub Sensor"
description: "How to integrate the GitHub sensor into Home Assistant."
-date: 2018-12-24 18:00
-sidebar: true
-comments: false
-sharing: true
-footer: true
logo: github.png
ha_category:
- Sensor
diff --git a/source/_components/gitlab_ci.markdown b/source/_components/gitlab_ci.markdown
index ebdf7770fa4..f757d7f3d62 100644
--- a/source/_components/gitlab_ci.markdown
+++ b/source/_components/gitlab_ci.markdown
@@ -1,12 +1,6 @@
---
-layout: page
title: "GitLab-CI Sensor"
description: "How to integrate GitLab-CI Job status within Home Assistant."
-date: 2018-09-10 19:00
-sidebar: true
-comments: false
-sharing: true
-footer: true
logo: gitlab.png
ha_category:
- Sensor
diff --git a/source/_components/gitter.markdown b/source/_components/gitter.markdown
index fa9b0c16208..b874bfb4d3a 100644
--- a/source/_components/gitter.markdown
+++ b/source/_components/gitter.markdown
@@ -1,12 +1,6 @@
---
-layout: page
title: "Gitter Sensor"
description: "Instructions on how to integrate a Gitter room sensor with Home Assistant"
-date: 2017-06-11 09:00
-sidebar: true
-comments: false
-sharing: true
-footer: true
logo: gitter.png
ha_category:
- Sensor
diff --git a/source/_components/glances.markdown b/source/_components/glances.markdown
index f3b54a52666..a2892121058 100644
--- a/source/_components/glances.markdown
+++ b/source/_components/glances.markdown
@@ -1,12 +1,6 @@
---
-layout: page
title: "Glances"
description: "Instructions on how to integrate Glances sensors into Home Assistant."
-date: 2015-09-14 19:10
-sidebar: true
-comments: false
-sharing: true
-footer: true
logo: glances.png
ha_category:
- System Monitor
@@ -38,7 +32,7 @@ $ curl -X GET http://IP_ADDRESS:61208/api/2/mem/free
{"free": 203943936}
```
-If this doesn't work, try changing the `2` for `3`, if you have installed the latest verison of Glances.
+If this doesn't work, try changing the `2` for `3`, if you have installed the latest version of Glances.
For details about auto-starting `glances`, please refer to [Start Glances through Systemd](https://github.com/nicolargo/glances/wiki/Start-Glances-through-Systemd).
@@ -97,7 +91,7 @@ version:
resources:
description: Entries to monitor.
required: false
- type: map
+ type: list
default: disk_use
keys:
disk_use_percent:
diff --git a/source/_components/gntp.markdown b/source/_components/gntp.markdown
index 8b0357ca4b3..50b4f025593 100644
--- a/source/_components/gntp.markdown
+++ b/source/_components/gntp.markdown
@@ -1,12 +1,6 @@
---
-layout: page
title: "GNTP (Growl)"
description: "Instructions for adding GNTP/Growl notifications to Home Assistant."
-date: 2016-03-25 18:18
-sidebar: true
-comments: false
-sharing: true
-footer: true
logo: gntp.png
ha_category:
- Notifications
@@ -15,7 +9,7 @@ redirect_from:
- /components/notify.gntp/
---
-[GNTP](http://www.growlforwindows.com/gfw/help/gntp.aspx) is a specification for sending and receiving notifications between computers. The most well known server implementations are [Growl](http://growl.info) for Mac and [Growl for Windows](http://www.growlforwindows.com/gfw/).
+[GNTP](http://growl.info/documentation/developer/gntp.php) is a specification for sending and receiving notifications between computers. The most well known server implementations are [Growl](http://growl.info) for Mac and [Growl for Windows](http://www.growlforwindows.com/).
To use GNTP notifications, add the following to your `configuration.yaml` file:
diff --git a/source/_components/goalfeed.markdown b/source/_components/goalfeed.markdown
index 284c1b238f6..e48394fa3a2 100644
--- a/source/_components/goalfeed.markdown
+++ b/source/_components/goalfeed.markdown
@@ -1,12 +1,6 @@
---
-layout: page
title: "Goalfeed"
description: "Instructions on how to setup Goalfeed events within Home Assistant."
-date: 2017-12-13 17:30
-sidebar: true
-comments: false
-sharing: true
-footer: true
logo: goalfeed.png
ha_category:
- Other
diff --git a/source/_components/gogogate2.markdown b/source/_components/gogogate2.markdown
index 756be2750cc..ab3688e7e46 100644
--- a/source/_components/gogogate2.markdown
+++ b/source/_components/gogogate2.markdown
@@ -1,12 +1,6 @@
---
-layout: page
title: "Gogogate2 Cover"
description: "Instructions on how to integrate Gogogate2-Enabled garage door covers into Home Assistant."
-date: 2018-03-26 20:02
-sidebar: true
-comments: false
-sharing: true
-footer: true
logo: gogogate2.png
ha_category:
- Cover
diff --git a/source/_components/google_assistant.markdown b/source/_components/google_assistant.markdown
index 50010a0d764..ab4f6bdaec0 100644
--- a/source/_components/google_assistant.markdown
+++ b/source/_components/google_assistant.markdown
@@ -1,12 +1,6 @@
---
-layout: page
title: "Google Assistant"
description: "Setup for Google Assistant integration"
-date: 2017-10-17 12:30
-sidebar: true
-comments: false
-sharing: true
-footer: true
logo: google-assistant.png
ha_category:
- Voice
@@ -26,14 +20,18 @@ For Home Assistant Cloud Users, documentation can be found [here](https://www.na
The Google Assistant integration requires a bit more setup than most due to the way Google requires Assistant Apps to be set up.
-
+
+
To use Google Assistant, your Home Assistant configuration has to be [externally accessible with a hostname and SSL certificate](/docs/configuration/remote/). If you haven't already configured that, you should do so before continuing.
-
+
+
## Migrate to release 0.80 and above
-
-If this is the first time setting up your Google Assistant integration, you can skip this section and continue with the [manual setup instructions](#first-time-setup) below.
-
+
+
+If this is the first time setting up your Google Assistant integration, you can skip this section and continue with the [maual setup instructions](#first-time-setup) below.
+
+
Since release 0.80, the `Authorization Code` type of `OAuth` account linking is supported. To migrate your existing configuration from release 0.79 or below, you need:
@@ -52,11 +50,13 @@ Since release 0.80, the `Authorization Code` type of `OAuth` account linking is
3. Restart Home Assistant, open the `Google Home` app on your mobile phone then go to `Account > Settings > Assistant > Home Control`, press the `3 dot icon in the top right > Manage accounts > [test] your app name > Unlink account` Then relink your account by selecting `[test] your app name` again.
4. A browser will open and ask you to login to your Home Assistant instance and will redirect back to the `Google Assistant` app right afterward.
-
+
+
If you've added Home Assistant to the home screen, you have to first remove it from home screen, otherwise, this HTML5 app will show up instead of a browser. Using it would prevent Home Assistant to redirect back to the `Google Assistant` app.
If you're still having trouble, make sure that you're not connected to the same network Home Assistant is running on, e.g., use 4G/LTE instead.
-
+
+
## First time setup
@@ -84,17 +84,21 @@ You need to create an API Key with the [Google Cloud API Console](https://consol
4. Add the `google_assistant` integration configuration to your `configuration.yaml` file and restart Home Assistant following the [configuration guide](#configuration) below.
5. Open the Google Home app and go into `Account > Settings > Assistant > Home Control`.
6. Click the `+` sign, and near the bottom, you should have `[test] your app name` listed under 'Add new.' Selecting that should lead you to a browser to login your Home Assistant instance, then redirect back to a screen where you can set rooms for your devices or nicknames for your devices.
-
+
+
+
If you've added Home Assistant to the home screen, you have to first remove it from home screen, otherwise, this HTML5 app will show up instead of a browser. Using it would prevent Home Assistant to redirect back to the `Google Assistant` app.
-
-7. If you want to allow other household users to control the devices:
+
+
+
+1. If you want to allow other household users to control the devices:
1. Go to the settings for the project you created in the [Actions on Google console](https://console.actions.google.com/).
2. Click `Test -> Simulator`, then click `Share` icon in the right top corner. Follow the on-screen instruction:
1. Add team members: Got to `Settings -> Permission`, click `Add`, type the new user's e-mail address and choose `Project -> Viewer` role.
2. Copy and share the link with the new user.
3. When the new user opens the link with their own Google account, it will enable your draft test app under their account.
3. Have the new user go to their `Google Assistant` app to add `[test] your app name` to their account.
-8. If you want to use the `google_assistant.request_sync` service, to update devices without unlinking and relinking, in Home Assistant, then enable Homegraph API for your project:
+2. If you want to use the `google_assistant.request_sync` service, to update devices without unlinking and relinking, in Home Assistant, then enable Homegraph API for your project:
1. Go to the [Google API Console](https://console.cloud.google.com/apis/api/homegraph.googleapis.com/overview).
2. Select your project and click Enable Homegraph API.
3. Go to Credentials, which you can find on the left navigation bar under the key icon, and select API Key from Create Credentials.
@@ -166,6 +170,7 @@ entity_config:
description: Force an entity to be exposed/excluded.
required: false
type: boolean
+ default: true
aliases:
description: Aliases that can also be used to refer to this entity
required: false
@@ -190,14 +195,14 @@ Currently, the following domains are available to be used with Google Assistant,
- light (on/off/brightness/rgb color/color temp)
- lock (lock/unlock (to allow assistant to unlock, set the `allow_unlock` key in configuration))
- cover (on/off/set position)
-- media_player (on/off/set volume (via set brightness)/source (via set input source))
+- media_player (on/off/set volume (via set volume)/source (via set input source))
- climate (temperature setting, hvac_mode)
- vacuum (dock/start/stop/pause)
- sensor (temperature setting, only for temperature sensor)
-
+
The domain groups contains groups containing all items, by example group.all_automations. When telling Google Assistant to shut down everything, this will lead in this example to disabling all automations
-
+
### Secure Devices
@@ -208,8 +213,7 @@ By default these cannot be opened by Google Assistant unless a `secure_devices_p
### Media Player Sources
Media Player sources are sent via the Modes trait in Google Assistant.
-There is currently a limitation with this feature that requires a hard-coded set of settings. Because of this, the only sources that will be usable by this feature are listed here:
-https://developers.google.com/actions/reference/smarthome/traits/modes
+There is currently a limitation with this feature that requires a hard-coded set of settings. Because of this, the only sources that will be usable by this feature [are listed here](https://developers.google.com/actions/reference/smarthome/traits/modes).
#### Example Command:
@@ -243,7 +247,7 @@ The request_sync service may fail with a 404 if the project_id of the Homegraph
3. Enable Homegraph API to the new project.
4. Generate a new API key.
5. Again, create a new project in the [Actions on Google console](https://console.actions.google.com/). Described above. But at the step 'Build under the Actions SDK box' choose your newly created project. By this, they share the same `project_id`.
-
+
Syncing may also fail after a period of time, likely around 30 days, due to the fact that your Actions on Google app is techincally in testing mode and has never been published. Eventually, it seems that the test expires. Control of devices will continue to work but syncing may not. If you say "Ok Google, sync my devices" and get the response "Unable to sync Home Assistant", this can usually be resolved by going back to your test app in the [Actions on Google console](https://console.actions.google.com/) and clicking `Simulator` under `TEST`. Regenerate the draft version Test App and try asking Google to sync your devices again.
### Troubleshooting with NGINX
diff --git a/source/_components/google_cloud.markdown b/source/_components/google_cloud.markdown
index 2fe0cb29f7f..b3239233729 100644
--- a/source/_components/google_cloud.markdown
+++ b/source/_components/google_cloud.markdown
@@ -1,12 +1,6 @@
---
-layout: page
title: "Google Cloud Platform"
description: "Google Cloud Platform integration."
-date: 2019-05-02 12:08
-sidebar: true
-comments: false
-sharing: true
-footer: true
logo: google_cloud.png
ha_category: Text-to-speech
ha_release: 0.95
diff --git a/source/_components/google_domains.markdown b/source/_components/google_domains.markdown
index f19649e4409..568344e69e7 100644
--- a/source/_components/google_domains.markdown
+++ b/source/_components/google_domains.markdown
@@ -1,12 +1,6 @@
---
-layout: page
title: "Google Domains"
description: "Keep your computer registered with the Google Domains dynamic DNS."
-date: 2017-10-23 12:00
-sidebar: true
-comments: false
-sharing: true
-footer: true
logo: google_domains.png
ha_category:
- Network
@@ -43,6 +37,6 @@ google_domains:
timeout:
description: Timeout (in seconds) for the API calls.
required: false
- type: number
+ type: integer
default: 10
{% endconfiguration %}
diff --git a/source/_components/google_maps.markdown b/source/_components/google_maps.markdown
index 9f81b0c1a91..e0dfa1f4b7f 100644
--- a/source/_components/google_maps.markdown
+++ b/source/_components/google_maps.markdown
@@ -1,12 +1,6 @@
---
-layout: page
title: "Google Maps Location Sharing"
description: "Instructions how to use Google Maps Location Sharing to track devices in Home Assistant."
-date: 2017-02-12 10:00
-sidebar: true
-comments: false
-sharing: true
-footer: true
logo: google_maps.png
ha_release: 0.67
ha_category:
@@ -24,10 +18,12 @@ You first need to create an additional Google account and share your location wi
This platform will create a file named `.google_maps_location_sharing.cookies` extended with the slugified username where it caches your login session.
-
+
+
Since this platform is using an unofficial API with the help of [locationsharinglib](https://github.com/costastf/locationsharinglib), Google seems to block access to your data the first time you've logged in with this platform.
This issue can be fixed by logging in with your new account and approving your login on the [Device Activity](https://myaccount.google.com/device-activity) page.
-
+
+
To integrate Google Maps Location Sharing in Home Assistant, add the following section to your `configuration.yaml` file:
diff --git a/source/_components/google_pubsub.markdown b/source/_components/google_pubsub.markdown
index 490909b2555..d940eadde8a 100644
--- a/source/_components/google_pubsub.markdown
+++ b/source/_components/google_pubsub.markdown
@@ -1,12 +1,6 @@
---
-layout: page
title: "Google Pub/Sub"
description: "Setup for Google Pub/Sub integration"
-date: 2019-01-12 13:30
-sidebar: true
-comments: false
-sharing: true
-footer: true
logo: google-pubsub.png
ha_category:
- History
@@ -76,9 +70,9 @@ filter:
type: list
{% endconfiguration %}
-
+
Not filtering domains or entities will send every event to Google PubSub, thus hitting the free tier limit very fast. Be sure to fill in this configuration parameter or have a paid subscription for Google Cloud.
-
+
### Saving the data using a Google Cloud Function
diff --git a/source/_components/google_translate.markdown b/source/_components/google_translate.markdown
index 7a01d4dc5e7..d0e7875433c 100644
--- a/source/_components/google_translate.markdown
+++ b/source/_components/google_translate.markdown
@@ -1,12 +1,6 @@
---
-layout: page
title: "Google Translate Text-to-Speech"
description: "Instructions on how to setup Google Translate Text-to-Speech with Home Assistant."
-date: 2016-12-13 07:00
-sidebar: true
-comments: false
-sharing: true
-footer: true
logo: google.png
ha_category:
- Text-to-speech
@@ -18,9 +12,11 @@ redirect_from:
The `google_translate` text-to-speech platform uses unofficial [Google Translate Text-to-Speech engine](https://translate.google.com/) to read a text with natural sounding voices.
-
+
+
This platform renamed to `google_translate` from `google` since release 0.92.
-
+
+
## Configuration
diff --git a/source/_components/google_travel_time.markdown b/source/_components/google_travel_time.markdown
index 22a6ba23c8d..4a7ccadf83b 100644
--- a/source/_components/google_travel_time.markdown
+++ b/source/_components/google_travel_time.markdown
@@ -1,12 +1,6 @@
---
-layout: page
title: "Google Maps Travel Time"
description: "Instructions on how to add Google Maps travel time to Home Assistant."
-date: 2016-03-28 10:19
-sidebar: true
-comments: false
-sharing: true
-footer: true
logo: google_maps.png
ha_category:
- Transport
diff --git a/source/_components/google_wifi.markdown b/source/_components/google_wifi.markdown
index 1c4bd6a8a85..4125cbaf46e 100644
--- a/source/_components/google_wifi.markdown
+++ b/source/_components/google_wifi.markdown
@@ -1,12 +1,6 @@
---
-layout: page
title: "Google Wifi"
description: "Instructions on how to integrate Google Wifi/OnHub routers into Home Assistant."
-date: 2017-07-15 21:22
-sidebar: true
-comments: false
-sharing: true
-footer: true
ha_category:
- System Monitor
logo: google_wifi.png
@@ -43,7 +37,7 @@ name:
monitored_conditions:
description: Defines the data to monitor as sensors. Defaults to all of the listed options below.
required: false
- type: map
+ type: list
keys:
current_version:
description: Current firmware version of the router.
diff --git a/source/_components/googlehome.markdown b/source/_components/googlehome.markdown
index 5d4cb29f40c..0921c73dbe5 100644
--- a/source/_components/googlehome.markdown
+++ b/source/_components/googlehome.markdown
@@ -1,12 +1,6 @@
---
-layout: page
title: "Google Home"
description: "Instructions on how to connect to your Google Home device."
-date: 2018-11-04 00:00
-sidebar: true
-comments: false
-sharing: true
-footer: true
logo: google_home.png
ha_release: 0.88
ha_category:
diff --git a/source/_components/gpmdp.markdown b/source/_components/gpmdp.markdown
index 20a96fd89d1..c52a3a8be43 100644
--- a/source/_components/gpmdp.markdown
+++ b/source/_components/gpmdp.markdown
@@ -1,12 +1,6 @@
---
-layout: page
title: "Google Play Music Desktop Player"
description: "Instructions on how to integrate GPMDP into Home Assistant."
-date: 2016-05-09 08:00
-sidebar: true
-comments: false
-sharing: true
-footer: true
logo: gpmdp.png
ha_category:
- Media Player
diff --git a/source/_components/gpsd.markdown b/source/_components/gpsd.markdown
index 64af59c6b1b..89e84ceef05 100644
--- a/source/_components/gpsd.markdown
+++ b/source/_components/gpsd.markdown
@@ -1,12 +1,6 @@
---
-layout: page
title: "GPSD"
description: "Instructions on how to integrate GPSD into Home Assistant."
-date: 2016-07-18 07:00
-sidebar: true
-comments: false
-sharing: true
-footer: true
logo: gpsd.png
ha_category:
- Utility
diff --git a/source/_components/gpslogger.markdown b/source/_components/gpslogger.markdown
index d8acd113ba5..75a4762b0d5 100644
--- a/source/_components/gpslogger.markdown
+++ b/source/_components/gpslogger.markdown
@@ -1,12 +1,6 @@
---
-layout: page
title: "GPSLogger"
description: "Instructions on how to use GPSLogger to track devices in Home Assistant."
-date: 2016-11-25 15:00
-sidebar: true
-comments: false
-sharing: true
-footer: true
logo: gpslogger.png
ha_category:
- Presence Detection
diff --git a/source/_components/graphite.markdown b/source/_components/graphite.markdown
index 902bb85fa71..3a1c3c73780 100644
--- a/source/_components/graphite.markdown
+++ b/source/_components/graphite.markdown
@@ -1,12 +1,6 @@
---
-layout: page
title: "Graphite"
description: "Instructions on how to record Home Assistant history in Graphite."
-date: 2016-02-10 17:11
-sidebar: true
-comments: false
-sharing: true
-footer: true
logo: graphite.png
ha_category:
- History
diff --git a/source/_components/greeneye_monitor.markdown b/source/_components/greeneye_monitor.markdown
index 84b8afdbd12..fea6c213fe6 100644
--- a/source/_components/greeneye_monitor.markdown
+++ b/source/_components/greeneye_monitor.markdown
@@ -1,12 +1,6 @@
---
-layout: page
title: "GreenEye Monitor"
description: "Instructions on how to integrate your GreenEye Monitor within Home Assistant."
-date: 2018-09-02 11:15
-sidebar: true
-comments: false
-sharing: true
-footer: true
logo: brultech.png
ha_category:
- Hub
@@ -76,7 +70,7 @@ monitors:
net_metering:
description: Set to `true` if the channel is configured for net metering in the GEM, otherwise `false`.
required: false
- type: bool
+ type: boolean
default: false
temperature_sensors:
description: Configuration for temperature sensors
diff --git a/source/_components/greenwave.markdown b/source/_components/greenwave.markdown
index 6e19678ab47..efdcd794150 100644
--- a/source/_components/greenwave.markdown
+++ b/source/_components/greenwave.markdown
@@ -1,12 +1,6 @@
---
-layout: page
title: Greenwave Reality (TCP Connected) Lights
description: "Instructions on how to set up Greenwave Reality lights within Home Assistant."
-date: 2017-11-17 18:50
-sidebar: true
-comments: false
-sharing: true
-footer: true
logo: greenwavereality.png
ha_category:
- Light
diff --git a/source/_components/group.markdown b/source/_components/group.markdown
index db00da88802..d56e3f7fdea 100644
--- a/source/_components/group.markdown
+++ b/source/_components/group.markdown
@@ -1,12 +1,6 @@
---
-layout: page
title: "Group"
description: "Instructions on how to setup groups within Home Assistant."
-date: 2015-03-23 19:59
-sidebar: true
-comments: false
-sharing: true
-footer: true
logo: home-assistant.png
ha_category:
- Organization
@@ -50,6 +44,7 @@ all:
description: Set this to `true` if the group state should only turn *on* if **all** grouped entities are *on*.
required: false
type: boolean
+ default: false
icon:
description: The icon that shows in the front end. **The rest of this only applies to the deprecated UI `/states`**. If the group is a view, this icon will show at the top in the frontend instead of the name. If the group is a view and both name and icon have been specified, the icon will appear at the top of the frontend and the name will be displayed as the mouse-over text.
required: false
@@ -58,6 +53,7 @@ view:
description: "**Only applies to the deprecated UI `/states`**. If yes then the entry will be shown as a view (tab) at the top. Groups that are set to `view: true` cannot be used as entities in other views. *Does not apply to Lovelace.*"
required: false
type: boolean
+ default: false
control:
description: "**Only applies to the deprecated UI `/states`**. Set value to `hidden`. If hidden then the group switch will be hidden. *Does not apply to Lovelace.*"
required: false
diff --git a/source/_components/gstreamer.markdown b/source/_components/gstreamer.markdown
index 6f711de1a24..65f7bf53d74 100644
--- a/source/_components/gstreamer.markdown
+++ b/source/_components/gstreamer.markdown
@@ -1,12 +1,6 @@
---
-layout: page
title: "Gstreamer"
description: "Instructions on how to integrate Gstreamer into Home Assistant."
-date: 2017-02-16 10:00
-sidebar: true
-comments: false
-sharing: true
-footer: true
ha_category:
- Media Player
logo: gstreamer.png
diff --git a/source/_components/gtfs.markdown b/source/_components/gtfs.markdown
index 2416c97cedb..5be94ee6788 100644
--- a/source/_components/gtfs.markdown
+++ b/source/_components/gtfs.markdown
@@ -1,12 +1,6 @@
---
-layout: page
title: "Public Transit (GTFS)"
description: "Instructions on how to use public transit open data in Home Assistant."
-date: 2016-03-28 10:19
-sidebar: true
-comments: false
-sharing: true
-footer: true
logo: train.png
ha_category:
- Transport
diff --git a/source/_components/gtt.markdown b/source/_components/gtt.markdown
index e72d52af96b..15a922a1074 100644
--- a/source/_components/gtt.markdown
+++ b/source/_components/gtt.markdown
@@ -1,12 +1,6 @@
---
-layout: page
title: "GTT"
description: "Instructions on how to integrate timetable data for a GTT stop within Home Assistant."
-date: 2018-11-13 12:09
-sidebar: true
-comments: false
-sharing: true
-footer: true
ha_category:
- Transport
logo: gtt.png
diff --git a/source/_components/habitica.markdown b/source/_components/habitica.markdown
index 7082fd5bcfd..1bfa73e545f 100644
--- a/source/_components/habitica.markdown
+++ b/source/_components/habitica.markdown
@@ -1,12 +1,6 @@
---
-layout: page
title: "Habitica"
description: "Instructions on enabling Habitica support for your Home Assistant"
-date: 2018-08-09 00:00
-sidebar: true
-comments: false
-sharing: true
-footer: true
logo: habitica.png
ha_category:
- Hub
diff --git a/source/_components/hangouts.markdown b/source/_components/hangouts.markdown
index e117fafc7b5..fe2a33ff3db 100644
--- a/source/_components/hangouts.markdown
+++ b/source/_components/hangouts.markdown
@@ -1,12 +1,6 @@
---
-layout: page
title: "Google Hangouts"
description: "Hangouts chatbot support"
-date: 2018-08-18 20:00
-sidebar: true
-comments: false
-sharing: true
-footer: true
logo: hangouts.png
ha_category:
- Hub
@@ -52,13 +46,13 @@ To obtain the `oauth_code` cookie value using Chrome or Firefox, follow the step
* In the sidebar, expand "Cookies" and select `https://accounts.google.com`
* In the cookie list, double click on the value for the `oauth_code` cookie to select it, and copy the value. This is the authorization code
-
+
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.
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.
The manual authentication work-around is a result of unofficial support for using bots in hangouts from Google.
-
+
The authentication token will be generated and stored internally.
diff --git a/source/_components/harman_kardon_avr.markdown b/source/_components/harman_kardon_avr.markdown
index 6d6d1a28ad9..c16910a0e2a 100644
--- a/source/_components/harman_kardon_avr.markdown
+++ b/source/_components/harman_kardon_avr.markdown
@@ -1,12 +1,6 @@
---
-layout: page
title: "Harman Kardon AVR Network Receivers"
description: "Instructions on how to integrate Harman Kardon AVR Network Receivers into Home Assistant."
-date: 2018-11-20 09:00
-sidebar: true
-comments: false
-sharing: true
-footer: true
logo: harman_kardon.png
ha_category:
- Media Player
diff --git a/source/_components/harmony.markdown b/source/_components/harmony.markdown
index dbcf68641c2..a6051b217ce 100644
--- a/source/_components/harmony.markdown
+++ b/source/_components/harmony.markdown
@@ -1,12 +1,6 @@
---
-layout: page
title: "Harmony Hub Remote"
description: "Instructions on how to integrate Harmony Hub remotes into Home Assistant."
-date: 2016-11-05 17:00
-sidebar: true
-comments: false
-sharing: true
-footer: true
logo: logitech.png
ha_category:
- Remote
@@ -72,6 +66,7 @@ delay_secs:
hold_secs:
description: Default duration in seconds between sending the "press" command and sending the "release" command.
required: false
+ type: integer
default: 0
{% endconfiguration %}
diff --git a/source/_components/haveibeenpwned.markdown b/source/_components/haveibeenpwned.markdown
index 3d6feb54adb..15de845e3d1 100644
--- a/source/_components/haveibeenpwned.markdown
+++ b/source/_components/haveibeenpwned.markdown
@@ -1,12 +1,6 @@
---
-layout: page
title: "HaveIBeenPwned Sensor"
description: "Instructions on how to integrate HaveIBeenPwned sensor into Home Assistant."
-date: 2016-09-29 18:00
-sidebar: true
-comments: false
-sharing: true
-footer: true
logo: haveibeenpwned.png
ha_category:
- Sensor
@@ -49,8 +43,8 @@ account has been breached as well as the added date of the breach data. This dat
-
+
The sensor will scan all email addresses specified with a 5 second delay between all breach data requests on Home Assistant startup.
After this initial startup scanning, the sensor will only scan one email account per 15 minutes to prevent abuse, and not hammer "the
Have I been Pwned" service, as this breach data almost never changes.
-
+
diff --git a/source/_components/hddtemp.markdown b/source/_components/hddtemp.markdown
index 1577dbb8775..3ad3a2ff6c3 100644
--- a/source/_components/hddtemp.markdown
+++ b/source/_components/hddtemp.markdown
@@ -1,12 +1,6 @@
---
-layout: page
title: "HDDTemp"
description: "Instructions on how to integrate hard drive temperature information into Home Assistant."
-date: 2016-10-28 07:00
-sidebar: true
-comments: false
-sharing: true
-footer: true
ha_category:
- System Monitor
ha_release: 0.32
diff --git a/source/_components/hdmi_cec.markdown b/source/_components/hdmi_cec.markdown
index 391a35e344c..485a0b11394 100644
--- a/source/_components/hdmi_cec.markdown
+++ b/source/_components/hdmi_cec.markdown
@@ -1,12 +1,6 @@
---
-layout: page
title: "HDMI CEC"
description: "Instructions on how to interact with HDMI CEC via Home Assistant."
-date: 2016-06-24 19:59
-sidebar: true
-comments: false
-sharing: true
-footer: true
ha_category:
- Automation
logo: hdmi.png
@@ -29,9 +23,11 @@ The computer running Home Assistant must support CEC, and of course be connected
[libcec](https://github.com/Pulse-Eight/libcec) must be installed for this integration to work. Follow the installation instructions for your environment, provided at the link. `libcec` installs Python 3 bindings by default as a system Python module. If you are running Home Assistant in a [Python virtual environment](/docs/installation/virtualenv/), make sure it can access the system module, by either symlinking it or using the `--system-site-packages` flag.
-
+
+
If you are using [Hass.io](/hassio/) then just move forward to the configuration as all requirements are already fulfilled.
-
+
+
#### Symlinking into virtual environment
@@ -53,9 +49,12 @@ $ ln -s /usr/local/lib/python*/dist-packages/_cec.so /srv/homeassistant/lib/pyth
```
-If after symlinking and adding `hdmi_cec:` to your configuration you are getting the following error in your logs,
+
+
+If after symlinking and adding `hdmi_cec:` to your configuration you are getting the following error in your logs,
`* failed to open vchiq instance` you will also need to add the user account Home Assistant runs under, to the `video` group. To add the Home Assistant user account to the `video` group, run the following command. `$ usermod -a -G video `
-
+
+
## Testing your installation
@@ -89,8 +88,11 @@ power status: on
language: ???
```
-`address:` entry above this will be used to configure Home Assistant, this address is represented below as 3: BlueRay player.
-
+
+
+`address:` entry above this will be used to configure Home Assistant, this address is represented below as 3: BlueRay player.
+
+
## Configuration Example
diff --git a/source/_components/heatmiser.markdown b/source/_components/heatmiser.markdown
index 7a3834a8bcd..d63a58764fc 100644
--- a/source/_components/heatmiser.markdown
+++ b/source/_components/heatmiser.markdown
@@ -1,12 +1,6 @@
---
-layout: page
title: "Heatmiser Thermostat"
description: "Instructions on how to integrate Heatmiser thermostats within Home Assistant."
-date: 2015-12-11 12:35
-sidebar: true
-comments: false
-sharing: true
-footer: true
logo: heatmiser.png
ha_category:
- Climate
diff --git a/source/_components/heos.markdown b/source/_components/heos.markdown
index d3462afa07e..2b27acccfbd 100644
--- a/source/_components/heos.markdown
+++ b/source/_components/heos.markdown
@@ -1,12 +1,6 @@
---
-layout: page
title: "Denon HEOS"
description: "Instructions on how to integrate Denon HEOS into Home Assistant."
-date: 2019-03-06 22:00
-sidebar: true
-comments: false
-sharing: true
-footer: true
logo: heos.png
ha_category:
- Media Player
@@ -39,9 +33,9 @@ host:
type: string
{% endconfiguration %}
-
+
A connection to a single device enables control for all devices on the network. If you have multiple HEOS devices, enter the host of one that is connected to the LAN via wire or has the strongest wireless signal.
-
+
## Services
diff --git a/source/_components/hikvision.markdown b/source/_components/hikvision.markdown
index 15d91c1014a..518a8cdaa0f 100644
--- a/source/_components/hikvision.markdown
+++ b/source/_components/hikvision.markdown
@@ -1,12 +1,6 @@
---
-layout: page
title: Hikvision Binary Sensor
description: "Instructions on how to set up Hikvision camera binary sensors within Home Assistant."
-date: 2016-12-08
-sidebar: true
-comments: false
-sharing: true
-footer: true
logo: hikvision.png
ha_category:
- Binary Sensor
@@ -27,10 +21,10 @@ as a trigger. If you would like to hide a sensor type you can do so by either
unchecking "Notify the surveillance center" in the camera configuration or by
using the "ignored" customize option detailed below.
-
+
In order for the sensors to work the hikvision user must have the 'Remote: Notify Surveillance Center/Trigger Alarm Output' permission which can be enabled from the user management section of the web interface.
Also the 'WEB Authentication' needs to be set to 'digest/basic' in the security/authentication section.
-
+
For example, if you configure a camera with the name "Front Porch" that has
motion detection and line crossing events enabled to notify the surveillance
@@ -105,6 +99,7 @@ ssl:
description: "`true` if you want to connect with https. Be sure to set the port also."
required: false
type: boolean
+ default: false
customize:
description: >
This attribute contains sensor-specific override values.
@@ -118,6 +113,7 @@ customize:
the Web Interface and no events are generated for it.
required: false
type: boolean
+ default: false
delay:
description: >
Specify the delay to wait after a sensor event ends before notifying
diff --git a/source/_components/hikvisioncam.markdown b/source/_components/hikvisioncam.markdown
index e6c544b04d9..fe8959b36a8 100644
--- a/source/_components/hikvisioncam.markdown
+++ b/source/_components/hikvisioncam.markdown
@@ -1,12 +1,6 @@
---
-layout: page
title: "Hikvision Camera Switch"
description: "Instructions on how to integrate Hikvision camera switches into Home Assistant."
-date: 2015-06-10 22:54
-sidebar: true
-comments: false
-sharing: true
-footer: true
logo: hikvision.png
ha_category:
- Switch
@@ -17,9 +11,9 @@ redirect_from:
This `hikvisioncam` switch platform allows you to control your motion detection setting on your [Hikvision](http://www.hikvision.com/) camera.
-
+
Currently works using default https port only.
-
+
To use your Hikvision cam in your installation, add the following to your `configuration.yaml` file:
diff --git a/source/_components/hipchat.markdown b/source/_components/hipchat.markdown
index 97cac0dceb0..e3de0fbd30c 100644
--- a/source/_components/hipchat.markdown
+++ b/source/_components/hipchat.markdown
@@ -1,12 +1,6 @@
---
-layout: page
title: "HipChat"
description: "Instructions on how to add HipChat notifications to Home Assistant."
-date: 2017-08-10 15:00
-sidebar: true
-comments: false
-sharing: true
-footer: true
logo: hipchat.png
ha_category:
- Notifications
@@ -15,12 +9,12 @@ redirect_from:
- /components/notify.hipchat/
---
-
+
This integration will be removed from Home Assistant in the future. Slack has taken over Hipchat and Stride and will therefore stop these platforms. For more information:
announcement.
Hipchat will be discontinued after February 15th, 2019. This to give customers the opportunity to make a switch.
-
+