diff --git a/source/_components/alarm_control_panel.elkm1.markdown b/source/_components/alarm_control_panel.elkm1.markdown deleted file mode 100644 index 89a57e26fe4..00000000000 --- a/source/_components/alarm_control_panel.elkm1.markdown +++ /dev/null @@ -1,22 +0,0 @@ ---- -layout: page -title: "Elk-M1 Alarm Control Panel" -description: "Instructions how to integrate Elk M1 alarm control panel." -date: 2018-10-07 00:00 -sidebar: true -comments: false -sharing: true -footer: true -logo: elkproducts.png -ha_release: 0.81 -ha_category: Alarm -ha_iot_class: "Local Push" ---- - -The `elkm1` platform allows you to control your [Elk-M1](https://www.elkproducts.com/m1_controls.html). - -An Elk-M1 area (also known as partition) is represented as an `alarm_control_panel`. - -
-Full configuration details can be found on the main [Elk-M1 component](/components/elkm1/) page. -
diff --git a/source/_components/calendar.google.markdown b/source/_components/calendar.google.markdown index cfb94721485..888f52f1851 100644 --- a/source/_components/calendar.google.markdown +++ b/source/_components/calendar.google.markdown @@ -28,13 +28,15 @@ 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 'Product name shown to users' 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. +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. + ## {% linkable_title Configuration %} To integrate Google Calendar in Home Assistant, diff --git a/source/_components/climate.elkm1.markdown b/source/_components/climate.elkm1.markdown deleted file mode 100644 index b93f06baf87..00000000000 --- a/source/_components/climate.elkm1.markdown +++ /dev/null @@ -1,22 +0,0 @@ ---- -layout: page -title: "Elk-M1 Thermostat" -description: "Instructions how to integrate Elk-M1 thermostats." -date: 2018-10-20 00:00 -sidebar: true -comments: false -sharing: true -footer: true -logo: elkproducts.png -ha_release: 0.81 -ha_category: Climate -ha_iot_class: "Local Push" ---- - -The `elkm1` platform allows you to control your [Elk-M1](https://www.elkproducts.com/m1_controls.html). - -An Elk-M1 thermostat is represented as a `climate` entity. - --Full configuration details can be found on the main [Elk-M1 component](/components/elkm1/) page. -
diff --git a/source/_components/climate.tado.markdown b/source/_components/climate.tado.markdown deleted file mode 100644 index c49a8ef4bdc..00000000000 --- a/source/_components/climate.tado.markdown +++ /dev/null @@ -1,21 +0,0 @@ ---- -layout: page -title: "Tado Thermostat" -description: "Instructions on how to integrate Tado thermostats with Home Assistant." -date: 2017-03-20 12:00 -sidebar: true -comments: false -sharing: true -footer: true -logo: tado.png -ha_category: Climate -ha_release: 0.41 -ha_iot_class: "Cloud Polling" ---- - - -The `tado` climate platform is interact with your climate devices. - - -The requirement is that you have set up the [tado](/components/tado/) component. - diff --git a/source/_components/climate.toon.markdown b/source/_components/climate.toon.markdown deleted file mode 100644 index 61e4258847d..00000000000 --- a/source/_components/climate.toon.markdown +++ /dev/null @@ -1,27 +0,0 @@ ---- -layout: page -title: "Toon Thermostat" -description: "Instructions on how to integrate Toon thermostats within Home Assistant." -date: 2017-10-22 12:00 -sidebar: true -comments: false -sharing: true -footer: true -ha_category: Climate -ha_release: 0.56 -logo: toon.png -ha_iot_class: "Cloud Polling" ---- - -The `toon` climate platform allows you to interact with your Toon thermostat. For compatibility reasons, the states in Home Assistant are different from the states displayed on your Toon device and are mapped as follows: - - -| Home Assistant | Toon | -|:---------------|:--------| -| Performance | Comfort | -| Heat | Thuis | -| Eco | Weg | -| Cool | Slapen | - - -Please refer to the [hub component](/components/toon/) for setup instructions. diff --git a/source/_components/climate.tuya.markdown b/source/_components/climate.tuya.markdown deleted file mode 100644 index 4d89a4783b1..00000000000 --- a/source/_components/climate.tuya.markdown +++ /dev/null @@ -1,22 +0,0 @@ ---- -layout: page -title: "Tuya Climate" -description: "Instructions on how to setup the Tuya climate devices within Home Assistant." -date: 2018-07-16 09:00 -sidebar: true -comments: false -sharing: true -footer: true -logo: tuya.png -ha_category: Climate -ha_release: 0.75 -ha_iot_class: "Cloud Polling" ---- - -The `tuya` climate platform allows you to control your [Tuya Smart](https://www.tuya.com) climate devices. - -The platform supports the air conditioner and heater. - --Full configuration details can be found on the main [Tuya component](/components/tuya/) page. -
diff --git a/source/_components/cover.tuya.markdown b/source/_components/cover.tuya.markdown deleted file mode 100644 index 82040f93ecc..00000000000 --- a/source/_components/cover.tuya.markdown +++ /dev/null @@ -1,23 +0,0 @@ ---- -layout: page -title: "Tuya Cover" -description: "Instructions on how to setup the Tuya cover within Home Assistant." -date: 2018-07-20 09:00 -sidebar: true -comments: false -sharing: true -footer: true -logo: tuya.png -ha_category: Cover -ha_iot_class: "Cloud Polling" -ha_release: 0.75 ---- - - -The `tuya` cover platform allows you to control your [Tuya Smart](https://www.tuya.com) curtains. - -The platform supports curtains. - --Full configuration details can be found on the main [Tuya component](/components/tuya/) page. -
\ No newline at end of file diff --git a/source/_components/device_tracker.tado.markdown b/source/_components/device_tracker.tado.markdown deleted file mode 100644 index 06e7df3c472..00000000000 --- a/source/_components/device_tracker.tado.markdown +++ /dev/null @@ -1,69 +0,0 @@ ---- -layout: page -title: "Tado Device Tracker" -description: "Instructions on how to integrate Tado device tracker into Home Assistant." -date: 2017-01-17 12:00 -sidebar: true -comments: false -sharing: true -footer: true -logo: tado.png -ha_category: Presence Detection -ha_release: 0.37 ---- - -The `tado` device tracker is using the [Tado Smart Thermostat](https://www.tado.com/) and its support for person presence detection based on smartphone location by geofencing. - -This tracker uses the Tado API to determine if a mobile device is at home. It tracks all devices in your home that Tado knows about. - -To use the Tado platform in your installation, add the following to your `configuration.yaml` file: - -```yaml -# Example configuration.yaml entry for Tado -device_tracker: - - platform: tado - username: YOUR_USERNAME - password: YOUR_PASSWORD - home_id: YOUR_HOME_ID -``` - -{% configuration %} -username: - description: The username for your Tado account. - required: true - type: string -password: - description: The password for your Tado account. - required: true - type: string -home_id: - description: The id of your home of which you want to track devices. If provided, the Tado device tracker will tack *all* devices known to Tado associated with this home. See below how to find it. - required: false - type: integer -{% endconfiguration %} - -After configuration, your device has to be at home at least once before showing up as *home* or *away*. -Polling Tado API for presence information will happen at most once every 30 seconds. - -See the [device tracker component page](/components/device_tracker/) for instructions how to configure the people to be tracked. Beware that the Tado (v2) API does not provide GPS location of devices, only a bearing, therefore Home Assistant only uses `home`/`not-home` status. - -### {% linkable_title Finding your `home_id` %} -Find your `home_id` by browsing to `https://my.tado.com/api/v2/me?username=YOUR_USERNAME&password=YOUR_PASSWORD`. There you'll see something like the following: - -```json -{ - "name": "Mark", - "email": "your@email.tld", - "username": "your@email.tld", - "homes": [ - { - "id": 12345, - "name": "Home Sweet Home" - } - ], - "locale": "en_US", - "mobileDevices": [] -} -``` - -In this example `12345` is the `home_id` you'll need to configure. diff --git a/source/_components/elkm1.markdown b/source/_components/elkm1.markdown index 02f567db96c..3593bce7fbc 100644 --- a/source/_components/elkm1.markdown +++ b/source/_components/elkm1.markdown @@ -9,14 +9,37 @@ sharing: true footer: true logo: elkproducts.png ha_release: 0.81 -ha_category: Hub +ha_category: + - Hub + - Alarm + - Climate + - Light + - Scene + - Sensor + - Switch ha_iot_class: "Local Push" +redirect_from: + - /components/alarm_control_panel.elkm1/ + - /components/climate.elkm1/ + - /components/light.elkm1/ + - /components/scene.elkm1/ + - /components/sensor.elkm1/ + - /components/switch.elkm1/ --- The Elk-M1 is a home security and automation controller that is capable of alarm control panel functions and automation. The Elk-M1 controller is manufactured by [Elk Products](https://www.elkproducts.com). +There is currently support for the following device types within Home Assistant: + +- **Alarm** - An Elk-M1 area (also known as partition) is represented as an `alarm_control_panel`. +- **Climate** - An Elk-M1 thermostat is represented as a `climate` entity. +- **Light** - An Elk-M1 light (which can be X10, Insteon, UPB) is represented as a `light`. +- **Scene** - Elk-M1 tasks are represented as `scene` entities. +- **Sensor** - Elk-M1 counters, keypads, panel, settings, and zones are represented as `sensor` entities. +- **Switch** - Elk-M1 outputs are represented as `switch` entities. + ## {% linkable_title Configuration %} To integrate Elk-M1 controller with Home Assistant, add the following @@ -238,6 +261,7 @@ zone: {% endconfiguration %} Example configuration of the above: + ```yaml elkm1: host: elks://IP_ADDRESS @@ -253,6 +277,7 @@ elkm1: ``` Example for a serial port instance on /dev/ttyS1 at 9600 baud: + ```yaml elkm1: host: serial://dev/ttyS1:9600 @@ -266,4 +291,3 @@ elkm1: include: [a1-d16, 192] exclude: [b12-d5] ``` - diff --git a/source/_components/eufy.markdown b/source/_components/eufy.markdown index 1780b3e4b5e..7a7b7268df6 100644 --- a/source/_components/eufy.markdown +++ b/source/_components/eufy.markdown @@ -8,19 +8,31 @@ comments: false sharing: true footer: true logo: eufy.png -ha_category: Hub +ha_category: + - Hub + - Light + - Switch ha_release: 0.68 +ha_iot_class: "Local Polling" +redirect_from: + - /components/light.eufy/ + - /components/switch.eufy/ --- The `eufy` component is the main component to integrate various [eufy](https://www.eufylife.com/) devices with Home Assistant. +There is currently support for the following device types within Home Assistant: + +- Light +- Switch + Supported devices will be discovered after the `eufy` component is configured: ```yaml # Example configuration.yaml entry eufy: - username: testuser@domain - password: p4ssw0rd + username: EMAIL_ADDRESS + password: PASSWORD ``` where username and password are the ones configured in the EufyHome app. Alternately, Eufy devices that are not discoverable can be statically configured. @@ -54,4 +66,3 @@ $ curl -H token:TOKEN -H category:Home \ ``` replacing TOKEN with the `access_token` from the previous command. This will provide the local_code for each device. - diff --git a/source/_components/fan.tuya.markdown b/source/_components/fan.tuya.markdown deleted file mode 100644 index 273a6f00729..00000000000 --- a/source/_components/fan.tuya.markdown +++ /dev/null @@ -1,23 +0,0 @@ ---- -layout: page -title: "Tuya Fan" -description: "Instructions on how to setup the Tuya fan within Home Assistant." -date: 2018-07-17 09:00 -sidebar: true -comments: false -sharing: true -footer: true -logo: tuya.png -ha_category: Fan -ha_iot_class: "Cloud Polling" -ha_release: 0.75 ---- - - -The `tuya` fan platform allows you to control your [Tuya Smart](https://www.tuya.com) fan. - -The platform supports most kinds of Tuya fans. - --Full configuration details can be found on the main [Tuya component](/components/tuya/) page. -
\ No newline at end of file diff --git a/source/_components/light.elkm1.markdown b/source/_components/light.elkm1.markdown deleted file mode 100644 index 2dfa79a4114..00000000000 --- a/source/_components/light.elkm1.markdown +++ /dev/null @@ -1,22 +0,0 @@ ---- -layout: page -title: "Elk-M1 Light" -description: "Instructions how to integrate Elk-M1 light." -date: 2018-10-07 00:00 -sidebar: true -comments: false -sharing: true -footer: true -logo: elkproducts.png -ha_release: 0.81 -ha_category: Light -ha_iot_class: "Local Push" ---- - -The `elkm1` platform allows you to control your [Elk-M1](https://www.elkproducts.com/m1_controls.html). - -An Elk-M1 light (which can be X10, Insteon, UPB) is represented as a `light`. - --Full configuration details can be found on the main [Elk-M1 component](/components/elkm1/) page. -
diff --git a/source/_components/light.eufy.markdown b/source/_components/light.eufy.markdown deleted file mode 100644 index d8596c00487..00000000000 --- a/source/_components/light.eufy.markdown +++ /dev/null @@ -1,19 +0,0 @@ ---- -layout: page -title: "Eufy Lights" -description: "Instructions on how to integrate Eufy LED lights into Home Assistant." -date: 2018-04-09 19:00 -sidebar: true -comments: false -sharing: true -footer: true -logo: eufy.png -ha_category: Light -ha_iot_class: "Local Polling" -ha_release: 0.68 ---- - -The `eufy` platform allows you to control your [Eufy](http://www.eufylife.com) lights from within Home Assistant. - -They will be automatically discovered if the [Eufy](/components/eufy/) component is enabled. - diff --git a/source/_components/light.tuya.markdown b/source/_components/light.tuya.markdown deleted file mode 100644 index ec3d418e5e5..00000000000 --- a/source/_components/light.tuya.markdown +++ /dev/null @@ -1,23 +0,0 @@ ---- -layout: page -title: "Tuya Light" -description: "Instructions on how to setup the Tuya lights within Home Assistant." -date: 2018-07-16 09:00 -sidebar: true -comments: false -sharing: true -footer: true -logo: tuya.png -ha_category: Light -ha_iot_class: "Cloud Polling" -ha_release: 0.74 ---- - - -The `tuya` light platform allows you to control your [Tuya Smart](https://www.tuya.com) lights. - -The platform supports most kinds of Tuya light. - --Full configuration details can be found on the main [Tuya component](/components/tuya/) page. -
\ No newline at end of file diff --git a/source/_components/scene.elkm1.markdown b/source/_components/scene.elkm1.markdown deleted file mode 100644 index 346e54be32a..00000000000 --- a/source/_components/scene.elkm1.markdown +++ /dev/null @@ -1,22 +0,0 @@ ---- -layout: page -title: "Elk-M1 Scene" -description: "Instructions on how to integrate Elk-M1 tasks (macros)." -date: 2018-10-07 00:00 -sidebar: true -comments: false -sharing: true -footer: true -logo: elkproducts.png -ha_release: 0.81 -ha_category: Scene -ha_iot_class: "Local Push" ---- - -The `elkm1` platform allows you to control your [Elk-M1](https://www.elkproducts.com/m1_controls.html). - -Elk-M1 tasks are represented as `scene` entities. - --Full configuration details can be found on the main [Elk-M1 component](/components/elkm1/) page. -
diff --git a/source/_components/scene.tuya.markdown b/source/_components/scene.tuya.markdown deleted file mode 100644 index 70babb97885..00000000000 --- a/source/_components/scene.tuya.markdown +++ /dev/null @@ -1,24 +0,0 @@ ---- -layout: page -title: "Tuya Scene" -description: "Instructions on how to setup the Tuya scene within Home Assistant." -date: 2018-07-20 09:00 -sidebar: true -comments: false -sharing: true -footer: true -logo: tuya.png -ha_category: Scene -ha_release: 0.75 ---- - - -The `tuya` scene platform allows you to activate your [Tuya Smart](https://www.tuya.com) scenes. - -The platform supports scenes. - -The device state in frontend panel will not change immediately after you activate a scene. - --Full configuration details can be found on the main [Tuya component](/components/tuya/) page. -
\ No newline at end of file diff --git a/source/_components/sensor.elkm1.markdown b/source/_components/sensor.elkm1.markdown deleted file mode 100644 index 97216415589..00000000000 --- a/source/_components/sensor.elkm1.markdown +++ /dev/null @@ -1,22 +0,0 @@ ---- -layout: page -title: "Elk-M1 Sensor" -description: "Instructions on how to integrate Elk-M1 counters, keypads, panel, settings, and zones." -date: 2018-10-11 00:00 -sidebar: true -comments: false -sharing: true -footer: true -logo: elkproducts.png -ha_release: 0.81 -ha_category: Sensor -ha_iot_class: "Local Push" ---- - -The `elkm1` platform allows you to control your [Elk-M1](https://www.elkproducts.com/m1_controls.html). - -Elk-M1 counters, keypads, panel, settings, and zones are represented as `sensor` entities. - --Full configuration details can be found on the main [Elk-M1 component](/components/elkm1/) page. -
diff --git a/source/_components/sensor.scrape.markdown b/source/_components/sensor.scrape.markdown index 86ebfe26ce2..82241743ae0 100644 --- a/source/_components/sensor.scrape.markdown +++ b/source/_components/sensor.scrape.markdown @@ -13,7 +13,6 @@ ha_release: 0.31 ha_iot_class: "Cloud Polling" --- - The `scrape` sensor platform is scraping information from websites. The sensor loads a HTML page and gives you the option to search and split out a value. As this is not a full-blown web scraper like [scrapy](https://scrapy.org/), it will most likely only work with simple web pages and it can be time-consuming to get the right section. To enable this sensor, add the following lines to your `configuration.yaml` file: diff --git a/source/_components/sensor.season.markdown b/source/_components/sensor.season.markdown index e12c1c401f2..e6000b37eb8 100644 --- a/source/_components/sensor.season.markdown +++ b/source/_components/sensor.season.markdown @@ -18,13 +18,13 @@ The `season` sensor will display the current astronomical or meteorological seas For information on the difference between astronomical and meteorological seasons please see the link below: - - [https://www.ncei.noaa.gov/news/meteorological-versus-astronomical-seasons](https://www.ncei.noaa.gov/news/meteorological-versus-astronomical-seasons) +- [https://www.ncei.noaa.gov/news/meteorological-versus-astronomical-seasons](https://www.ncei.noaa.gov/news/meteorological-versus-astronomical-seasons) All information about how the seasons work was taken from Wikipedia: - - [https://en.wikipedia.org/wiki/Season#Astronomical](https://en.wikipedia.org/wiki/Season#Astronomical) - - [https://en.wikipedia.org/wiki/Equinox](https://en.wikipedia.org/wiki/Equinox) - - [https://en.wikipedia.org/wiki/Solstice](https://en.wikipedia.org/wiki/Solstice) +- [https://en.wikipedia.org/wiki/Season#Astronomical](https://en.wikipedia.org/wiki/Season#Astronomical) +- [https://en.wikipedia.org/wiki/Equinox](https://en.wikipedia.org/wiki/Equinox) +- [https://en.wikipedia.org/wiki/Solstice](https://en.wikipedia.org/wiki/Solstice) ## {% linkable_title Configuration %} @@ -44,4 +44,3 @@ type: type: string default: astronomical {% endconfiguration %} - diff --git a/source/_components/sensor.sensehat.markdown b/source/_components/sensor.sensehat.markdown index 608f749db35..f2440de1c71 100644 --- a/source/_components/sensor.sensehat.markdown +++ b/source/_components/sensor.sensehat.markdown @@ -53,7 +53,7 @@ is_hat_attached: type: boolean {% endconfiguration %} -#### {% linkable_title Customizing the Sense HAT data %} +## {% linkable_title Customizing the Sense HAT data %} **Format the sensor values** Add the following to your `sensor`: @@ -124,11 +124,11 @@ group: - group.sense_hat ``` -### {% linkable_title Directions for installing on Raspberry Pi All-In-One installer and HASSbian: %} +## {% linkable_title Directions for installing on Raspberry Pi All-In-One installer and HASSbian: %} Here are the steps to make the _SenseHAT_ sensor work _successfully_ with the virtual environment versions. -#### {% linkable_title Install SenseHAT package to _homeassistant_venv_ %} +### {% linkable_title Install SenseHAT package to _homeassistant_venv_ %} ```bash # switch to the homeassistant_venv environment @@ -140,13 +140,13 @@ pip3 install sense-hat # be patient, this will take a long while ``` -#### {% linkable_title Return to `pi` %} +### {% linkable_title Return to `pi` %} Type `exit` to quit out of the _homeassistant_venv_ back to your `pi` environment. As all of the following steps should be under the `pi` user environment. -#### {% linkable_title Install _RTIMU_ %} +### {% linkable_title Install _RTIMU_ %} ```bash # pi user environment: Install RTIMU @@ -166,7 +166,7 @@ sudo reboot Unfortunately enabling the SenseHAT Sensor component for a Virtual Environment install of Home Assistant fails with errors. _(The Raspberry Pi All-In-One installer and HASSbian both run Home Assistant in an virtual environment)._ -These issues have been discussed in the repository issue (#5093)[https://github.com/home-assistant/home-assistant/issues/5093) +These issues have been discussed in the repository issue [#5093](https://github.com/home-assistant/home-assistant/issues/5093) This fix has been tested with a clean install of: diff --git a/source/_components/sensor.serial.markdown b/source/_components/sensor.serial.markdown index 4954fb15fc6..5386914e1da 100644 --- a/source/_components/sensor.serial.markdown +++ b/source/_components/sensor.serial.markdown @@ -15,12 +15,14 @@ ha_iot_class: "Local Polling" The `serial` sensor platform is using the data provided by a device connected to the serial port of the system where Home Assistant is running. With [`ser2net`](http://ser2net.sourceforge.net/) and [`socat`](http://www.dest-unreach.org/socat/) would it also work for sensors connected to a remote system. -To check what kind of data is arriving at your serial port, use a command-line tool like `minicom` or `picocom` on Linux, on a macOS you can use `screen` or on Windows `putty`. +To check what kind of data is arriving at your serial port, use a command-line tool like `minicom` or `picocom` on Linux, on a macOS you can use `screen` or on Windows `putty`. ```bash -$ sudo minicom -D /dev/ttyACM0 +sudo minicom -D /dev/ttyACM0 ``` +## {% linkable_title Configuration %} + To setup a serial sensor to your installation, add the following to your `configuration.yaml` file: ```yaml @@ -47,10 +49,9 @@ baudrate: value_template: description: "Defines a [template](/docs/configuration/templating/#processing-incoming-data) to extract a value from the serial line." required: false - type: template + type: template {% endconfiguration %} - ## {% linkable_title `value_template` for Template sensor %} ### {% linkable_title TMP36 %} @@ -67,7 +68,7 @@ value_template: For controllers of the Arduino family a possible sketch to read the temperature and the humidity could look like the sample below. -``` +```c #include- You control what access is granted using this token. This integration only needs very basic access (see below). + You control what access is granted using this token. This integration only needs very basic access (see below).
-Once you've signed up: -1. Head to the [Personal Access Section](https://developer.starlingbank.com/personal/token) of your developer account. +Once you've signed up: + +1. Head to the [Personal Access Section](https://developer.starlingbank.com/personal/token) of your developer account. 2. Click "Create Token". 3. Give your token a name e.g., "Home Assistant". 4. Tick the permissions "account:read" and "balance:read". The others you can leave un-ticked. diff --git a/source/_components/sensor.startca.markdown b/source/_components/sensor.startca.markdown index 5d36a629eec..c91b0a5b709 100644 --- a/source/_components/sensor.startca.markdown +++ b/source/_components/sensor.startca.markdown @@ -83,4 +83,3 @@ monitored_conditions: used_remaining: description: Remaining bandwidth calucated from used and supplied total bandwidth (gigabytes). {% endconfiguration %} - diff --git a/source/_components/sensor.statistics.markdown b/source/_components/sensor.statistics.markdown index ad60be7beb0..75a1d8cd8f9 100644 --- a/source/_components/sensor.statistics.markdown +++ b/source/_components/sensor.statistics.markdown @@ -14,11 +14,10 @@ ha_release: "0.30" ha_qa_scale: internal --- - The `statistics` sensor platform consumes the state from other sensors. It exports the `mean` value as state and the following values as attributes: `count`, `mean`, `median`, `stdev`, `variance`, `total`, `min`, `max`, `min_age`, `max_age`, `change`, `average_change` and `change_rate`. If it's a binary sensor then only state changes are counted. If you are running the [recorder](/components/recorder/) component, on startup the data is read from the database. So after a restart of the platform, you will immediately have data available. If you're using the [history](/components/history/) component, this will automatically also start the `recorder` component on startup. -If you are *not* running the `recorder` component, it can take time till the sensor starts to work because a couple of attributes need more than one value to do the calculation. +If you are *not* running the `recorder` component, it can take time till the sensor starts to work because a couple of attributes need more than one value to do the calculation. ## {% linkable_title Configuration %} diff --git a/source/_components/sensor.steam_online.markdown b/source/_components/sensor.steam_online.markdown index b42e343aeea..7914ab33826 100644 --- a/source/_components/sensor.steam_online.markdown +++ b/source/_components/sensor.steam_online.markdown @@ -13,7 +13,6 @@ ha_iot_class: "Cloud Polling" ha_release: 0.14 --- - The `steam` sensor platform will allow you to track the online status of public [Steam](https://steamcommunity.com) accounts. ## {% linkable_title Setup %} diff --git a/source/_components/sensor.supervisord.markdown b/source/_components/sensor.supervisord.markdown index bc1c2880b90..2e0464e0484 100644 --- a/source/_components/sensor.supervisord.markdown +++ b/source/_components/sensor.supervisord.markdown @@ -28,7 +28,6 @@ After a restart of `supervisord` you should be able to access the web interface.
@@ -80,4 +80,3 @@ sensor:
required: true
type: list
{% endconfiguration %}
-
diff --git a/source/_components/sensor.time_date.markdown b/source/_components/sensor.time_date.markdown
index 4a922a7e408..2f7d8d94981 100644
--- a/source/_components/sensor.time_date.markdown
+++ b/source/_components/sensor.time_date.markdown
@@ -14,7 +14,6 @@ ha_release: pre 0.7
ha_qa_scale: internal
---
-
The time and date (`time_date`) sensor platform simple displays the time in various formats, the date, or both.
To enable this sensor in your installation, add the following to your `configuration.yaml` file:
@@ -37,4 +36,3 @@ sensor:
diff --git a/source/_components/sensor.volkszaehler.markdown b/source/_components/sensor.volkszaehler.markdown index 0d9d7c6f89d..06bae90dc2c 100644 --- a/source/_components/sensor.volkszaehler.markdown +++ b/source/_components/sensor.volkszaehler.markdown @@ -76,4 +76,3 @@ sensor: - min - max ``` - diff --git a/source/_components/sensor.vultr.markdown b/source/_components/sensor.vultr.markdown index 5aa03c73931..89f87369f76 100644 --- a/source/_components/sensor.vultr.markdown +++ b/source/_components/sensor.vultr.markdown @@ -13,7 +13,6 @@ ha_category: System Monitor ha_iot_class: "Cloud Polling" --- - The `vultr` sensor platform will allow you to view current bandwidth usage and pending charges against your [Vultr](https://www.vultr.com/) subscription. To use this sensor, you must set up your [Vultr hub](/components/vultr/). @@ -73,4 +72,3 @@ sensor: monitored_conditions: - current_bandwidth_used ``` - diff --git a/source/_components/sensor.waze_travel_time.markdown b/source/_components/sensor.waze_travel_time.markdown index a1a02c7dd0f..4886e21ce55 100644 --- a/source/_components/sensor.waze_travel_time.markdown +++ b/source/_components/sensor.waze_travel_time.markdown @@ -62,10 +62,9 @@ realtime: type: boolean {% endconfiguration %} - ## {% linkable_title Example using dynamic destination %} -Using the flexible option to set a sensor value to the `destination`, you can setup a single Waze component that will calculate travel time to multiple optional locations on demand. +Using the flexible option to set a sensor value to the `destination`, you can setup a single Waze component that will calculate travel time to multiple optional locations on demand. In the following example, the `Input Select` is converted into an address which is used to modify the destination for Waze route calculation from `device_tracker.myphone` location (It takes a few minutes for the value to update due to the interval set to fetch Waze data). @@ -78,7 +77,7 @@ input_select: - Home - Work - Parents - + sensor: - platform: template sensors: @@ -93,7 +92,7 @@ sensor: {%- else -%} Unknown {%- endif %} - + - platform: waze_travel_time name: "Me to destination" origin: device_tracker.myphone diff --git a/source/_components/sensor.whois.markdown b/source/_components/sensor.whois.markdown index 95e351dd9e7..596f12e802c 100644 --- a/source/_components/sensor.whois.markdown +++ b/source/_components/sensor.whois.markdown @@ -13,7 +13,6 @@ ha_release: "0.57" ha_iot_class: "Cloud Polling" --- - The `whois` sensor platform allows you to perform daily WHOIS lookups against your owned domains. This provides you with information such as `expiration_date`, `name_servers` and `registrar` details. ## {% linkable_title Configuration %} @@ -38,4 +37,3 @@ sensor: default: Whois type: string {% endconfiguration %} - diff --git a/source/_components/smappee.markdown b/source/_components/smappee.markdown index 79f6f32d8dc..042cc8be8aa 100644 --- a/source/_components/smappee.markdown +++ b/source/_components/smappee.markdown @@ -9,12 +9,25 @@ sharing: true footer: true logo: smappee.png ha_release: "0.64" -ha_category: Hub +ha_category: + - Hub + - Energy + - Sensor + - Switch +ha_iot_class: "Local Push" +redirect_from: + - /components/sensor.smappee/ + - /components/switch.smappee/ --- The `smappee` component adds support for the [Smappee](https://www.smappee.com/) controller for energy monitoring and Comport plug switches. -Switches and Sensors are supported - and will be automatically added when you connect to the Smappee controller. +There is currently support for the following device types within Home Assistant: + +- Sensor +- Switch + +Will be automatically added when you connect to the Smappee controller. The smappee component gets information from [Smappee API](https://smappee.atlassian.net/wiki/display/DEVAPI/API+Methods). diff --git a/source/_components/switch.elkm1.markdown b/source/_components/switch.elkm1.markdown deleted file mode 100644 index 8ef52a09af6..00000000000 --- a/source/_components/switch.elkm1.markdown +++ /dev/null @@ -1,22 +0,0 @@ ---- -layout: page -title: "Elk-M1 Switch" -description: "Instructions on how to integrate Elk-M1 outputs (relays)." -date: 2018-10-07 00:00 -sidebar: true -comments: false -sharing: true -footer: true -logo: elkproducts.png -ha_release: 0.81 -ha_category: Switch -ha_iot_class: "Local Push" ---- - -The `elkm1` platform allows you to control your [Elk-M1](https://www.elkproducts.com/m1_controls.html). - -Elk-M1 outputs are represented as `switch` entities. - -
-Full configuration details can be found on the main [Elk-M1 component](/components/elkm1/) page. -
diff --git a/source/_components/switch.eufy.markdown b/source/_components/switch.eufy.markdown deleted file mode 100644 index e96ee77d324..00000000000 --- a/source/_components/switch.eufy.markdown +++ /dev/null @@ -1,18 +0,0 @@ ---- -layout: page -title: "Eufy Switch" -description: "Instructions on how to integrate Eufy switches into Home Assistant." -date: 2018-04-09 19:00 -sidebar: true -comments: false -sharing: true -footer: true -logo: eufy.png -ha_category: Switch -ha_iot_class: "Local Polling" -ha_release: 0.68 ---- - -The `eufy` platform allows you to control your [Eufy](http://www.eufylife.com) switches from within Home Assistant. - -They will be automatically discovered if the [Eufy](/components/eufy/) component is enabled. diff --git a/source/_components/switch.smappee.markdown b/source/_components/switch.smappee.markdown deleted file mode 100644 index 0576738e51a..00000000000 --- a/source/_components/switch.smappee.markdown +++ /dev/null @@ -1,20 +0,0 @@ ---- -layout: page -title: "Smappee Switch" -description: "Instructions on how to integrate Smappee Comfort Plug into Home Assistant." -date: 2018-02-26 08:37 -sidebar: true -comments: false -sharing: true -footer: true -logo: smappee.png -ha_release: "0.64" -ha_category: Switch -ha_iot_class: "Local Push" ---- - -[Smappee](https://www.smappee.com/) controller for energy monitoring and Comport plug switches. - -Comport Plugs will be automatically added when you connect to the Smappee controller. - -For more configuration information see the [Smappee component](/components/smappee/) documentation. diff --git a/source/_components/switch.toon.markdown b/source/_components/switch.toon.markdown deleted file mode 100644 index 744622da786..00000000000 --- a/source/_components/switch.toon.markdown +++ /dev/null @@ -1,18 +0,0 @@ ---- -layout: page -title: "Toon Smart Plugs" -description: "Instructions on how to integrate Toon smart plugs within Home Assistant." -date: 2017-10-22 12:00 -sidebar: true -comments: false -sharing: true -footer: true -ha_category: Switch -ha_release: 0.56 -logo: toon.png -ha_iot_class: "Cloud Polling" ---- - -The `toon` switch platform allows you to control your smart plugs if they are connected to Toon. - -The requirement is that you have setup the [`toon`](/components/toon/) component. diff --git a/source/_components/switch.tuya.markdown b/source/_components/switch.tuya.markdown deleted file mode 100644 index 28a130e0ce8..00000000000 --- a/source/_components/switch.tuya.markdown +++ /dev/null @@ -1,22 +0,0 @@ ---- -layout: page -title: "Tuya Switch" -description: "Instructions on how to set up the Tuya switch within Home Assistant." -date: 2018-07-09 09:00 -sidebar: true -comments: false -sharing: true -footer: true -logo: tuya.png -ha_category: Switch -ha_iot_class: "Cloud Polling" -ha_release: 0.74 ---- - -The `tuya` switch platform allows you to control your [Tuya Smart](https://www.tuya.com) switch. - -The platform supports switch and socket. - --Full configuration details can be found on the main [Tuya component](/components/tuya/) page. -
diff --git a/source/_components/tado.markdown b/source/_components/tado.markdown index f78c99ae627..efd8c821113 100644 --- a/source/_components/tado.markdown +++ b/source/_components/tado.markdown @@ -8,12 +8,26 @@ comments: false sharing: true footer: true logo: tado.png -ha_category: Hub +ha_category: + - Hub + - Climate + - Presence Detection + - Sensor ha_release: 0.41 ha_iot_class: "Cloud Polling" +redirect_from: + - /components/climate.tado/ + - /components/device_tracker.tado/ + - /components/sensor.tado/ --- -The `tado` component platform is used as an interface to the [my.tado.com](https://my.tado.com/webapp/#/account/sign-in) website. It adds climate devices for every tado zone and sensors for some additional information of the zones. +The `tado` component platform is used as an interface to the [my.tado.com](https://my.tado.com/webapp/#/account/sign-in) website. + +There is currently support for the following device types within Home Assistant: + +- Climate - for every tado zone. +- [Presence Detection](#presence-detection) +- Sensor - for some additional information of the zones. ## {% linkable_title Configuration %} @@ -40,3 +54,62 @@ password: The tado thermostats are internet connected thermostats. There exists an unofficial API at [my.tado.com](https://my.tado.com/webapp/#/account/sign-in), which is used by their website and now by this component. It currently supports presenting the current temperature, the setting temperature and the current operation mode. Switching the mode is also supported. If no user is at home anymore, the devices are showing the away-state. Switching to away-mode is not supported. + +## {% linkable_title Presence Detection %} + +The `tado` device tracker is using the [Tado Smart Thermostat](https://www.tado.com/) and its support for person presence detection based on smartphone location by geofencing. + +This tracker uses the Tado API to determine if a mobile device is at home. It tracks all devices in your home that Tado knows about. + +To use the Tado platform in your installation, add the following to your `configuration.yaml` file: + +```yaml +# Example configuration.yaml entry for Tado +device_tracker: + - platform: tado + username: YOUR_USERNAME + password: YOUR_PASSWORD + home_id: YOUR_HOME_ID +``` + +{% configuration %} +username: + description: The username for your Tado account. + required: true + type: string +password: + description: The password for your Tado account. + required: true + type: string +home_id: + description: The id of your home of which you want to track devices. If provided, the Tado device tracker will tack *all* devices known to Tado associated with this home. See below how to find it. + required: false + type: integer +{% endconfiguration %} + +After configuration, your device has to be at home at least once before showing up as *home* or *away*. +Polling Tado API for presence information will happen at most once every 30 seconds. + +See the [device tracker component page](/components/device_tracker/) for instructions how to configure the people to be tracked. Beware that the Tado (v2) API does not provide GPS location of devices, only a bearing, therefore Home Assistant only uses `home`/`not-home` status. + +### {% linkable_title Finding your `home_id` %} + +Find your `home_id` by browsing to `https://my.tado.com/api/v2/me?username=YOUR_USERNAME&password=YOUR_PASSWORD`. There you'll see something like the following: + +```json +{ + "name": "Mark", + "email": "your@email.tld", + "username": "your@email.tld", + "homes": [ + { + "id": 12345, + "name": "Home Sweet Home" + } + ], + "locale": "en_US", + "mobileDevices": [] +} +``` + +In this example `12345` is the `home_id` you'll need to configure. \ No newline at end of file diff --git a/source/_components/toon.markdown b/source/_components/toon.markdown index 1e81b2f2be6..ec93aa16bf4 100644 --- a/source/_components/toon.markdown +++ b/source/_components/toon.markdown @@ -7,14 +7,28 @@ sidebar: true comments: false sharing: true footer: true -ha_category: Hub +ha_category: + - Hub + - Climate + - Sensor + - Switch ha_release: 0.56 logo: toon.png ha_iot_class: "Cloud Polling" +redirect_from: + - /components/climate.toon/ + - /components/sensor.toon/ + - /components/switch.toon/ --- The `toon` component platform can be used to control your Toon thermostat. This component adds a climate device for your Toon thermostat and sensors for power and gas consumption. The component also auto-detects any smart plugs, solar panels and smoke detectors connected to Toon and adds sensors and switches for them. +There is currently support for the following device types within Home Assistant: + +- [Climate](#climate) +- Sensor +- Switch + For the `toon` component to work, you'll need an active Toon subscription with Eneco. The component uses your Mijn Eneco credentials to control your thermostat through the [toonopafstand](https://toonopafstand.eneco.nl) domain. ## {% linkable_title Configuration %} @@ -52,3 +66,14 @@ solar: Toon is a smart thermostat delivered by the Eneco power company in The Netherlands. It can measure energy consumption (power and gas), but also the amount of energy generated in case solar panels are connected to it. Toon also acts as a z-wave hub for supported devices like the wall plug and the smoke detector. This component uses the [toonlib library](https://github.com/costastf/toonlib) by Costas Tyfoxylos that connects to the unofficial API on [https://toonopafstand.eneco.nl](https://toonopafstand.eneco.nl). The current version of this component supports setting any of the four built-in programs and setting the temperature manually. It polls the Toon API at 30 second intervals so the status is relatively fresh without overloading the API. + +## {% linkable_title Climate %} + +The `toon` climate platform allows you to interact with your Toon thermostat. For compatibility reasons, the states in Home Assistant are different from the states displayed on your Toon device and are mapped as follows: + +| Home Assistant | Toon | +|:---------------|:--------| +| Performance | Comfort | +| Heat | Thuis | +| Eco | Weg | +| Cool | Slapen | diff --git a/source/_components/tuya.markdown b/source/_components/tuya.markdown index c08bc5ab3fa..52c79e31f4d 100644 --- a/source/_components/tuya.markdown +++ b/source/_components/tuya.markdown @@ -8,13 +8,36 @@ comments: false sharing: true footer: true logo: tuya.png -ha_category: Hub +ha_category: + - Hub + - Climate + - Cover + - Fan + - Light + - Scene + - Switch ha_iot_class: "Cloud Polling" ha_release: 0.74 +redirect_from: + - /components/climate.tuya/ + - /components/cover.tuya/ + - /components/fan.tuya/ + - /components/light.tuya/ + - /components/scene.tuya/ + - /components/switch.tuya/ --- The `tuya` component is the main component to integrate all [Tuya Smart](https://www.tuya.com) related platforms. You will need your Tuya account information (username, password and account country code) to discover and control devices which related to your account. +There is currently support for the following device types within Home Assistant: + +- **Climate** - The platform supports the air conditioner and heater. +- **Cover** - The platform supports curtains. +- **Fan** - The platform supports most kinds of Tuya fans. +- **Light** - The platform supports most kinds of Tuya light. +- **Scene** - The device state in frontend panel will not change immediately after you activate a scene. +- **Switch** - The platform supports switch and socket. + ## {% linkable_title Configuration %} To add your Tuya devices into your Home Assistant installation, add the following to your `configuration.yaml` file: diff --git a/source/_docs/installation/updating.markdown b/source/_docs/installation/updating.markdown index b82e53d1488..a1d2b06d662 100644 --- a/source/_docs/installation/updating.markdown +++ b/source/_docs/installation/updating.markdown @@ -32,6 +32,13 @@ For a Docker container, simply pull the latest one: $ sudo docker pull homeassistant/home-assistant:latest ``` +For a Raspberry Pi Docker container, simply pull the latest one: + +```bash +$ sudo docker pull homeassistant/raspberrypi3-homeassistant:latest +``` + + After updating, you must start/restart Home Assistant for the changes to take effect. This means that you will have to restart `hass` itself or the [autostarting](/docs/autostart/) daemon (if applicable). Startup can take considerable amount of time (i.e. minutes) depending on your device. This is because all requirements are updated as well. [BRUH automation](http://www.bruhautomation.com) has created [a tutorial video](https://www.youtube.com/watch?v=tuG2rs1Cl2Y) explaining how to upgrade Home Assistant. diff --git a/source/_docs/mqtt/service.markdown b/source/_docs/mqtt/service.markdown index d4a7aad206d..223d554d3f9 100644 --- a/source/_docs/mqtt/service.markdown +++ b/source/_docs/mqtt/service.markdown @@ -12,6 +12,20 @@ logo: mqtt.png The MQTT component will register the service `mqtt.publish` which allows publishing messages to MQTT topics. There are two ways of specifying your payload. You can either use `payload` to hard-code a payload or use `payload_template` to specify a [template](/topics/templating/) that will be rendered to generate the payload. +### {% linkable_title Service `mqtt.publish` %} + +| Service data attribute | Optional | Description | +| ---------------------- | -------- | ----------- | +| `topic` | no | Topic to publish payload to. +| `payload` | yes | Payload to publish. +| `payload_template` | yes | Template to render as payload value. Ignored if payload given. +| `qos` | yes | Quality of Service to use. +| `retain` | yes | If message should have the retain flag set. (default: false) + ++You need to include either payload or payload_template, but not both. +
+ ```json { "topic": "home-assistant/light/1/command", @@ -36,3 +50,14 @@ The MQTT component will register the service `mqtt.publish` which allows publish "payload":"{\"Status\":\"off\", \"Data\":\"something\"}" } ``` + +Example of how to use `qos` and `retain`: + +```json +{ + "topic": "home-assistant/light/1/command", + "payload": "on", + "qos": 2, + "retain": true +} +``` diff --git a/source/_lovelace/alarm-panel.markdown b/source/_lovelace/alarm-panel.markdown index 03e635b79be..103df57a77a 100644 --- a/source/_lovelace/alarm-panel.markdown +++ b/source/_lovelace/alarm-panel.markdown @@ -18,8 +18,8 @@ Screenshot of the Alarm Panel card. ```yaml -- type: alarm-panel - entity: alarm_control_panel.alarm +type: alarm-panel +entity: alarm_control_panel.alarm ``` {% configuration %} @@ -70,12 +70,12 @@ Screenshot of the Alarm Panel card. Define the State List: ```yaml -- type: alarm-panel - name: House Alarm - entity: alarm_control_panel.alarm - states: - - arm_home - - arm_away - - arm_night - - armed_custom_bypass +type: alarm-panel +name: House Alarm +entity: alarm_control_panel.alarm +states: + - arm_home + - arm_away + - arm_night + - armed_custom_bypass ``` diff --git a/source/_lovelace/conditional.markdown b/source/_lovelace/conditional.markdown index d2f7f881315..71ea10803ac 100644 --- a/source/_lovelace/conditional.markdown +++ b/source/_lovelace/conditional.markdown @@ -47,18 +47,18 @@ Note: Conditions with more than one entity are treated as an 'and' condition. Th ### {% linkable_title Examples %} ```yaml -- type: conditional - conditions: - - entity: light.bed_light - state: "on" - - entity: switch.decorative_lights - state_not: "off" - card: - type: entities - entities: - - device_tracker.demo_paulus - - cover.kitchen_window - - group.kitchen - - lock.kitchen_door - - light.bed_light +type: conditional +conditions: + - entity: light.bed_light + state: "on" + - entity: switch.decorative_lights + state_not: "off" +card: + type: entities + entities: + - device_tracker.demo_paulus + - cover.kitchen_window + - group.kitchen + - lock.kitchen_door + - light.bed_light ``` diff --git a/source/_lovelace/entities.markdown b/source/_lovelace/entities.markdown index 216c7a1ded0..d5f3ebcf7be 100644 --- a/source/_lovelace/entities.markdown +++ b/source/_lovelace/entities.markdown @@ -155,35 +155,35 @@ icon: Entity rows: ```yaml -- type: entities - title: Entities card sample - show_header_toggle: true - entities: - - entity: alarm_control_panel.alarm - name: Alarm Panel - - device_tracker.demo_paulus - - switch.decorative_lights - - group.all_lights - - group.all_locks +type: entities +title: Entities card sample +show_header_toggle: true +entities: + - entity: alarm_control_panel.alarm + name: Alarm Panel + - device_tracker.demo_paulus + - switch.decorative_lights + - group.all_lights + - group.all_locks ``` Special rows: ```yaml -- type: entities - title: Entities card sample - show_header_toggle: true - entities: - - type: call-service - icon: mdi:power - name: Bed light - action_name: Toggle light - service: light.toggle - service_data: - entity_id: light.bed_light - - type: divider - - type: weblink - name: Home Assistant - url: https://www.home-assistant.io/ - icon: mdi:home-assistant +type: entities +title: Entities card sample +show_header_toggle: true +entities: + - type: call-service + icon: mdi:power + name: Bed light + action_name: Toggle light + service: light.toggle + service_data: + entity_id: light.bed_light + - type: divider + - type: weblink + name: Home Assistant + url: https://www.home-assistant.io/ + icon: mdi:home-assistant ``` diff --git a/source/_lovelace/entity-button.markdown b/source/_lovelace/entity-button.markdown index e0d63044505..78cbcac9788 100644 --- a/source/_lovelace/entity-button.markdown +++ b/source/_lovelace/entity-button.markdown @@ -18,12 +18,8 @@ Screenshot of the Entity Button card. ```yaml -- type: entity-button - entity: light.living_room -- type: entity-button - entity: light.office -- type: entity-button - entity: light.bedroom +type: entity-button +entity: light.living_room ``` {% configuration %} @@ -106,14 +102,14 @@ theme: Title and Script Service Example: ```yaml -- type: entity-button - name: Turn Off Lights - tap_action: - action: call-service - service: script.turn_on - service_data: - entity_id: script.turn_off_lights - entity: script.turn_off_lights +type: entity-button +name: Turn Off Lights +tap_action: + action: call-service + service: script.turn_on + service_data: + entity_id: script.turn_off_lights +entity: script.turn_off_lights ```diff --git a/source/_lovelace/entity-filter.markdown b/source/_lovelace/entity-filter.markdown index 1bd4f6a0238..d2fe9bafe6e 100644 --- a/source/_lovelace/entity-filter.markdown +++ b/source/_lovelace/entity-filter.markdown @@ -48,29 +48,29 @@ show_empty: Show only active switches or lights in the house ```yaml -- type: entity-filter - entities: - - entity: light.bed_light - name: Bed - - light.kitchen_lights - - light.ceiling_lights - state_filter: - - "on" +type: entity-filter +entities: + - entity: light.bed_light + name: Bed + - light.kitchen_lights + - light.ceiling_lights +state_filter: + - "on" ``` Show only people that are at home using [glance](/lovelace/glance/): ```yaml -- type: entity-filter - entities: - - device_tracker.demo_paulus - - device_tracker.demo_anne_therese - - device_tracker.demo_home_boy - state_filter: - - home - card: - type: glance - title: People at home +type: entity-filter +entities: + - device_tracker.demo_paulus + - device_tracker.demo_anne_therese + - device_tracker.demo_home_boy +state_filter: + - home +card: + type: glance + title: People at home ```
diff --git a/source/_lovelace/gauge.markdown b/source/_lovelace/gauge.markdown index d8de956b693..ca5a10a5361 100644 --- a/source/_lovelace/gauge.markdown +++ b/source/_lovelace/gauge.markdown @@ -18,8 +18,8 @@ Screenshot of the gauge card.
```yaml -- type: gauge - entity: sensor.cpu_usage +type: gauge +entity: sensor.cpu_usage ``` {% configuration %} @@ -79,10 +79,10 @@ severity: Title and Unit of Measurement Example: ```yaml -- type: gauge - name: CPU Usuage - unit: '%' - entity: sensor.cpu_usage +type: gauge +name: CPU Usuage +unit: '%' +entity: sensor.cpu_usage ```@@ -93,12 +93,12 @@ Screenshot of the gauge card with custom title and unit of measurement. Define the severity map: ```yaml -- type: gauge - name: With Severity - unit: '%' - entity: sensor.cpu_usage - severity: - green: 0 - yellow: 45 - red: 85 +type: gauge +name: With Severity +unit: '%' +entity: sensor.cpu_usage +severity: + green: 0 + yellow: 45 + red: 85 ``` diff --git a/source/_lovelace/glance.markdown b/source/_lovelace/glance.markdown index 49c46ceec03..9bb335b1fca 100644 --- a/source/_lovelace/glance.markdown +++ b/source/_lovelace/glance.markdown @@ -124,16 +124,16 @@ hold_action: Basic example: ```yaml -- type: glance - title: Glance card sample - entities: - - binary_sensor.movement_backyard - - light.bed_light - - binary_sensor.basement_floor_wet - - sensor.outside_temperature - - light.ceiling_lights - - switch.ac - - lock.kitchen_door +type: glance +title: Glance card sample +entities: + - binary_sensor.movement_backyard + - light.bed_light + - binary_sensor.basement_floor_wet + - sensor.outside_temperature + - light.ceiling_lights + - switch.ac + - lock.kitchen_door ```
@@ -144,18 +144,18 @@ Screenshot of the glance card with custom title. Define entities as objects and apply a custom name: ```yaml -- type: glance - title: Better names - entities: - - entity: binary_sensor.movement_backyard - name: Movement? - - light.bed_light - - binary_sensor.basement_floor_wet - - sensor.outside_temperature - - light.ceiling_lights - - switch.ac - - lock.kitchen_door - - entity: switch.wall_plug_switch - tap_action: - action: toggle +type: glance +title: Better names +entities: + - entity: binary_sensor.movement_backyard + name: Movement? + - light.bed_light + - binary_sensor.basement_floor_wet + - sensor.outside_temperature + - light.ceiling_lights + - switch.ac + - lock.kitchen_door + - entity: switch.wall_plug_switch + tap_action: + action: toggle ``` diff --git a/source/_lovelace/history-graph.markdown b/source/_lovelace/history-graph.markdown index 0ff77517850..8b603b26d3c 100644 --- a/source/_lovelace/history-graph.markdown +++ b/source/_lovelace/history-graph.markdown @@ -65,10 +65,10 @@ name: ## {% linkable_title Example %} ```yaml -- type: history-graph - title: 'My Graph' - entities: - - sensor.outside_temperature - - entity: media_player.lounge_room - name: Main player +type: history-graph +title: 'My Graph' +entities: + - sensor.outside_temperature + - entity: media_player.lounge_room + name: Main player ``` diff --git a/source/_lovelace/horizontal-stack.markdown b/source/_lovelace/horizontal-stack.markdown index 248d5923dd0..5925cb912f7 100644 --- a/source/_lovelace/horizontal-stack.markdown +++ b/source/_lovelace/horizontal-stack.markdown @@ -26,14 +26,14 @@ cards: ## {% linkable_title Example %} ```yaml -- type: horizontal-stack - cards: - - type: picture-entity - image: /local/bed_1.png - entity: light.ceiling_lights - - type: picture-entity - image: /local/bed_2.png - entity: light.bed_light +type: horizontal-stack +cards: + - type: picture-entity + image: /local/bed_1.png + entity: light.ceiling_lights + - type: picture-entity + image: /local/bed_2.png + entity: light.bed_light ```
diff --git a/source/_lovelace/iframe.markdown b/source/_lovelace/iframe.markdown index 1547781a56c..ebeb9fc3dea 100644 --- a/source/_lovelace/iframe.markdown +++ b/source/_lovelace/iframe.markdown @@ -44,7 +44,7 @@ title: ### {% linkable_title Examples %} ```yaml -- type: iframe - url: https://grafana.localhost/d/000000027/worldping-endpoint-summary?var-probe=All&panelId=2&fullscreen&orgId=3&theme=light - aspect_ratio: 75% +type: iframe +url: https://grafana.localhost/d/000000027/worldping-endpoint-summary?var-probe=All&panelId=2&fullscreen&orgId=3&theme=light +aspect_ratio: 75% ``` diff --git a/source/_lovelace/light.markdown b/source/_lovelace/light.markdown index 391da7ed304..a4d2fdbc786 100644 --- a/source/_lovelace/light.markdown +++ b/source/_lovelace/light.markdown @@ -19,10 +19,8 @@ Screenshot of the Light card.
```yaml -- type: light - entity: light.bedroom -- type: light - entity: light.office +type: light +entity: light.bedroom ``` {% configuration %} @@ -46,12 +44,15 @@ name: Overwriting names example: ```yaml -- type: light - entity: light.bedroom - name: Kids Bedroom -- type: light - entity: light.office - name: My Office +type: light +entity: light.bedroom +name: Kids Bedroom +``` + +```yaml +type: light +entity: light.office +name: My Office ```diff --git a/source/_lovelace/map.markdown b/source/_lovelace/map.markdown index f7f3169fb0c..daae59d69f8 100644 --- a/source/_lovelace/map.markdown +++ b/source/_lovelace/map.markdown @@ -58,18 +58,18 @@ default_zoom: ## {% linkable_title Examples %} ```yaml -- type: map - aspect_ratio: 16:9 - default_zoom: 8 - entities: - - device_tracker.demo_paulus - - zone.home +type: map +aspect_ratio: 16:9 +default_zoom: 8 +entities: + - device_tracker.demo_paulus + - zone.home ``` ```yaml -- type: map - geo_location_sources: - - nsw_rural_fire_service_feed - entities: - - zone.home +type: map +geo_location_sources: + - nsw_rural_fire_service_feed +entities: + - zone.home ``` diff --git a/source/_lovelace/markdown.markdown b/source/_lovelace/markdown.markdown index de239baa5ce..9881a40217c 100644 --- a/source/_lovelace/markdown.markdown +++ b/source/_lovelace/markdown.markdown @@ -36,9 +36,9 @@ title: ## {% linkable_title Example %} ```yaml -- type: markdown - content: > - ## Lovelace +type: markdown +content: > + ## Lovelace - Starting with Home Assistant 0.72, we're experimenting with a new way of defining your interface. We're calling it the **Lovelace UI**. + Starting with Home Assistant 0.72, we're experimenting with a new way of defining your interface. We're calling it the **Lovelace UI**. ``` diff --git a/source/_lovelace/media-control.markdown b/source/_lovelace/media-control.markdown index 313d7492227..13f4ca19bf6 100644 --- a/source/_lovelace/media-control.markdown +++ b/source/_lovelace/media-control.markdown @@ -31,6 +31,6 @@ entity: ## {% linkable_title Example %} ```yaml -- type: media-control - entity: media_player.lounge_room +type: media-control +entity: media_player.lounge_room ``` diff --git a/source/_lovelace/picture-elements.markdown b/source/_lovelace/picture-elements.markdown index d9f73c8c652..f2f5962d23b 100644 --- a/source/_lovelace/picture-elements.markdown +++ b/source/_lovelace/picture-elements.markdown @@ -461,91 +461,91 @@ hold_action: ## {% linkable_title Example %} ```yaml -- type: picture-elements - image: /local/floorplan.png - elements: - - type: state-icon - tap_action: - action: toggle - entity: light.ceiling_lights - style: - top: 47% - left: 42% - - type: state-icon - tap_action: - action: toggle - entity: light.kitchen_lights - style: - top: 30% - left: 15% - - type: state-label - entity: sensor.outside_temperature - style: - top: 82% - left: 79% - - type: service-button - title: Turn lights off - style: - top: 95% - left: 60% - service: homeassistant.turn_off - service_data: - entity_id: group.all_lights - - type: icon - icon: mdi:home - tap_action: - action: navigate - navigation_path: /lovelace/0 - style: - top: 10% - left: 10% +type: picture-elements +image: /local/floorplan.png +elements: + - type: state-icon + tap_action: + action: toggle + entity: light.ceiling_lights + style: + top: 47% + left: 42% + - type: state-icon + tap_action: + action: toggle + entity: light.kitchen_lights + style: + top: 30% + left: 15% + - type: state-label + entity: sensor.outside_temperature + style: + top: 82% + left: 79% + - type: service-button + title: Turn lights off + style: + top: 95% + left: 60% + service: homeassistant.turn_off + service_data: + entity_id: group.all_lights + - type: icon + icon: mdi:home + tap_action: + action: navigate + navigation_path: /lovelace/0 + style: + top: 10% + left: 10% ``` ## {% linkable_title Images Example %} ```yaml -- type: picture-elements - image: /local/floorplan.png - elements: - # state_image & state_filter - toggle on click - - type: image - entity: light.living_room - tap_action: - action: toggle - image: /local/living_room.png - state_image: - "off": /local/living_room_off.png - filter: saturate(.8) - state_filter: - "on": brightness(120%) saturate(1.2) - style: - top: 25% - left: 75% - width: 15% - # Camera, red border, rounded-rectangle - show more-info on click - - type: image - entity: camera.driveway_camera - camera_image: camera.driveway_camera +type: picture-elements +image: /local/floorplan.png +elements: + # state_image & state_filter - toggle on click + - type: image + entity: light.living_room + tap_action: + action: toggle + image: /local/living_room.png + state_image: + "off": /local/living_room_off.png + filter: saturate(.8) + state_filter: + "on": brightness(120%) saturate(1.2) style: - top: 5% - left: 10% - width: 10% - border: 2px solid red - border-radius: 10% - # Single image, state_filter - call-service on click - - type: image - entity: media_player.living_room - tap_action: - action: call-service - service: media_player.media_play_pause - service_data: - entity_id: media_player.living_room - image: /local/television.jpg - filter: brightness(5%) - state_filter: - playing: brightness(100%) - style: - top: 40% + top: 25% left: 75% - width: 5% + width: 15% + # Camera, red border, rounded-rectangle - show more-info on click + - type: image + entity: camera.driveway_camera + camera_image: camera.driveway_camera + style: + top: 5% + left: 10% + width: 10% + border: 2px solid red + border-radius: 10% + # Single image, state_filter - call-service on click + - type: image + entity: media_player.living_room + tap_action: + action: call-service + service: media_player.media_play_pause + service_data: + entity_id: media_player.living_room + image: /local/television.jpg + filter: brightness(5%) + state_filter: + playing: brightness(100%) + style: + top: 40% + left: 75% + width: 5% ``` diff --git a/source/_lovelace/picture-entity.markdown b/source/_lovelace/picture-entity.markdown index 9b8862c051e..1a6f84fbf6d 100644 --- a/source/_lovelace/picture-entity.markdown +++ b/source/_lovelace/picture-entity.markdown @@ -113,17 +113,17 @@ hold_action: Basic example: ```yaml -- type: picture-entity - entity: light.bed_light - image: /local/bed_light.png +type: picture-entity +entity: light.bed_light +image: /local/bed_light.png ``` Different images for each state: ```yaml -- type: picture-entity - entity: light.bed_light - state_image: - "on": /local/bed_light_on.png - "off": /local/bed_light_off.png +type: picture-entity +entity: light.bed_light +state_image: + "on": /local/bed_light_on.png + "off": /local/bed_light_off.png ``` diff --git a/source/_lovelace/picture-glance.markdown b/source/_lovelace/picture-glance.markdown index e1b1809878e..4acef6811dc 100644 --- a/source/_lovelace/picture-glance.markdown +++ b/source/_lovelace/picture-glance.markdown @@ -125,47 +125,47 @@ icon: ## {% linkable_title Examples %} ```yaml -- type: picture-glance - title: Living room - entities: - - switch.decorative_lights - - light.ceiling_lights - - lock.front_door - - binary_sensor.movement_backyard - - binary_sensor.basement_floor_wet - image: /local/living_room.png +type: picture-glance +title: Living room +entities: + - switch.decorative_lights + - light.ceiling_lights + - lock.front_door + - binary_sensor.movement_backyard + - binary_sensor.basement_floor_wet +image: /local/living_room.png ``` Display a camera image as background: ```yaml -- type: picture-glance - title: Living room - entities: - - switch.decorative_lights - - light.ceiling_lights - camera_image: camera.demo_camera +type: picture-glance +title: Living room +entities: + - switch.decorative_lights + - light.ceiling_lights +camera_image: camera.demo_camera ``` Display a camera image without additional entities: ```yaml -- type: picture-glance - title: Front garden - entities: [] - camera_image: camera.front_garden_camera +type: picture-glance +title: Front garden +entities: [] +camera_image: camera.front_garden_camera ``` Use different images based on entity state: ```yaml -- type: picture-glance - title: Living room - entities: - - switch.decorative_lights - - light.ceiling_lights - state_image: - "on": /local/living_room_on.png - "off": /local/living_room_off.png - entity: group.living.room +type: picture-glance +title: Living room +entities: + - switch.decorative_lights + - light.ceiling_lights +state_image: + "on": /local/living_room_on.png + "off": /local/living_room_off.png +entity: group.living.room ``` diff --git a/source/_lovelace/picture.markdown b/source/_lovelace/picture.markdown index 8c8fea3b6fd..fd8d6d2e67b 100644 --- a/source/_lovelace/picture.markdown +++ b/source/_lovelace/picture.markdown @@ -83,11 +83,11 @@ hold_action: Navigate to another view: ```yaml -- type: picture - image: /local/home.jpg - tap_action: - action: navigate - navigation_path: /lovelace/home +type: picture +image: /local/home.jpg +tap_action: + action: navigate + navigation_path: /lovelace/home ``` Check the [views](/lovelace/views/) setup on how to setup custom IDs. @@ -95,9 +95,9 @@ Check the [views](/lovelace/views/) setup on how to setup custom IDs. Toggle entity using a service: ```yaml -- type: picture - image: /local/light.png - service: light.toggle - service_data: - entity_id: light.ceiling_lights +type: picture +image: /local/light.png +service: light.toggle +service_data: + entity_id: light.ceiling_lights ``` diff --git a/source/_lovelace/plant-status.markdown b/source/_lovelace/plant-status.markdown index 82e694fb22a..6a86c3931f2 100644 --- a/source/_lovelace/plant-status.markdown +++ b/source/_lovelace/plant-status.markdown @@ -36,6 +36,6 @@ name: ## {% linkable_title Example %} ```yaml -- type: plant-status - entity: plant.bonsai +type: plant-status +entity: plant.bonsai ``` diff --git a/source/_lovelace/sensor.markdown b/source/_lovelace/sensor.markdown index ddc70520d89..814b71e50e4 100644 --- a/source/_lovelace/sensor.markdown +++ b/source/_lovelace/sensor.markdown @@ -61,7 +61,7 @@ theme: ## {% linkable_title Example %} ```yaml -- type: sensor - entity: sensor.illumination - name: Illumination +type: sensor +entity: sensor.illumination +name: Illumination ``` diff --git a/source/_lovelace/shopping-list.markdown b/source/_lovelace/shopping-list.markdown index ab0d78462f4..b7c53c2d00d 100644 --- a/source/_lovelace/shopping-list.markdown +++ b/source/_lovelace/shopping-list.markdown @@ -20,7 +20,7 @@ Screenshot of the Shopping List card.
```yaml -- type: shopping-list +type: shopping-list ``` {% configuration %} @@ -39,6 +39,6 @@ title: Title Example: ```yaml -- type: shopping-list - title: Shopping List +type: shopping-list +title: Shopping List ``` diff --git a/source/_lovelace/thermostat.markdown b/source/_lovelace/thermostat.markdown index 5c29f7d3d7e..afa7180514d 100644 --- a/source/_lovelace/thermostat.markdown +++ b/source/_lovelace/thermostat.markdown @@ -36,6 +36,6 @@ name: ## {% linkable_title Example %} ```yaml -- type: thermostat - entity: climate.nest +type: thermostat +entity: climate.nest ``` diff --git a/source/_lovelace/vertical-stack.markdown b/source/_lovelace/vertical-stack.markdown index d88f7f246ef..3cf49875da4 100644 --- a/source/_lovelace/vertical-stack.markdown +++ b/source/_lovelace/vertical-stack.markdown @@ -28,14 +28,14 @@ cards: Basic example: ```yaml -- type: vertical-stack - cards: - - type: picture-entity - entity: camera.demo_camera - show_info: false - - type: entities - entities: - - binary_sensor.movement_backyard +type: vertical-stack +cards: + - type: picture-entity + entity: camera.demo_camera + show_info: false + - type: entities + entities: + - binary_sensor.movement_backyard ```@@ -46,19 +46,19 @@ Basic example: Combination of vertical and horizontal stack card: ```yaml -- type: vertical-stack - cards: - - type: picture-entity - entity: group.all_lights - image: /local/house.png - - type: horizontal-stack - cards: - - type: picture-entity - entity: light.ceiling_lights - image: /local/bed_1.png - - type: picture-entity - entity: light.bed_light - image: /local/bed_2.png +type: vertical-stack +cards: + - type: picture-entity + entity: group.all_lights + image: /local/house.png + - type: horizontal-stack + cards: + - type: picture-entity + entity: light.ceiling_lights + image: /local/bed_1.png + - type: picture-entity + entity: light.bed_light + image: /local/bed_2.png ```
diff --git a/source/_lovelace/weather-forecast.markdown b/source/_lovelace/weather-forecast.markdown index 02095b64a19..0dbc1173895 100644 --- a/source/_lovelace/weather-forecast.markdown +++ b/source/_lovelace/weather-forecast.markdown @@ -36,8 +36,8 @@ name: {% linkable_title Example %} ```yaml -- type: weather-forecast - entity: weather.dark_sky +type: weather-forecast +entity: weather.dark_sky ```