Merge branch 'current' into rc

This commit is contained in:
Franck Nijhof 2020-10-07 12:26:34 +02:00
commit f8b7591f47
No known key found for this signature in database
GPG Key ID: D62583BA8AB11CA3
340 changed files with 855 additions and 623 deletions

View File

@ -10,7 +10,7 @@ jobs:
- name: Check out files from GitHub
uses: actions/checkout@v2
- name: Setting up Node.js ${{ matrix.node-version }}
uses: actions/setup-node@v2.1.1
uses: actions/setup-node@v2.1.2
with:
node-version: 12.x
- name: Setup NPM cache
@ -33,7 +33,7 @@ jobs:
- name: Check out files from GitHub
uses: actions/checkout@v2
- name: Setting up Node.js ${{ matrix.node-version }}
uses: actions/setup-node@v2.1.1
uses: actions/setup-node@v2.1.2
with:
node-version: 12.x
- name: Setup NPM cache
@ -57,7 +57,7 @@ jobs:
- name: Check out files from GitHub
uses: actions/checkout@v2
- name: Setting up Ruby 2.6
uses: actions/setup-ruby@v1.1.1
uses: actions/setup-ruby@v1.1.2
with:
ruby-version: 2.6
- name: Setup Ruby Gems cache

View File

@ -12,7 +12,6 @@ end
group :jekyll_plugins do
gem 'jekyll-paginate', '1.1.0'
gem 'jekyll-redirect-from', '0.16.0'
gem 'jekyll-sitemap', '1.4.0'
gem 'jekyll-time-to-read', '0.1.2'
gem 'jekyll-commonmark', '1.3.1'

View File

@ -50,8 +50,6 @@ GEM
commonmarker (~> 0.14)
jekyll (>= 3.7, < 5.0)
jekyll-paginate (1.1.0)
jekyll-redirect-from (0.16.0)
jekyll (>= 3.3, < 5.0)
jekyll-sass-converter (2.1.0)
sassc (> 2.0.1, < 3.0)
jekyll-sitemap (1.4.0)
@ -124,7 +122,6 @@ DEPENDENCIES
jekyll (= 4.1.1)
jekyll-commonmark (= 1.3.1)
jekyll-paginate (= 1.1.0)
jekyll-redirect-from (= 0.16.0)
jekyll-sitemap (= 1.4.0)
jekyll-time-to-read (= 0.1.2)
nokogiri (= 1.10.10)

View File

@ -45,7 +45,6 @@ commonmark:
highlighter: none
plugins:
- jekyll-redirect-from
- jekyll-time-to-read
paginate: 10 # Posts per page on the blog index

27
package-lock.json generated
View File

@ -1633,6 +1633,24 @@
}
}
},
"mdast-util-frontmatter": {
"version": "0.2.0",
"resolved": "https://registry.npmjs.org/mdast-util-frontmatter/-/mdast-util-frontmatter-0.2.0.tgz",
"integrity": "sha512-FHKL4w4S5fdt1KjJCwB0178WJ0evnyyQr5kXTM3wrOVpytD0hrkvd+AOOjU9Td8onOejCkmZ+HQRT3CZ3coHHQ==",
"dev": true,
"requires": {
"micromark-extension-frontmatter": "^0.2.0"
}
},
"micromark-extension-frontmatter": {
"version": "0.2.2",
"resolved": "https://registry.npmjs.org/micromark-extension-frontmatter/-/micromark-extension-frontmatter-0.2.2.tgz",
"integrity": "sha512-q6nPLFCMTLtfsctAuS0Xh4vaolxSFUWUWR6PZSrXXiRy+SANGllpcqdXFv2z07l0Xz/6Hl40hK0ffNCJPH2n1A==",
"dev": true,
"requires": {
"fault": "^1.0.0"
}
},
"minimatch": {
"version": "3.0.4",
"resolved": "https://registry.npmjs.org/minimatch/-/minimatch-3.0.4.tgz",
@ -2019,12 +2037,13 @@
}
},
"remark-frontmatter": {
"version": "2.0.0",
"resolved": "https://registry.npmjs.org/remark-frontmatter/-/remark-frontmatter-2.0.0.tgz",
"integrity": "sha512-uNOQt4tO14qBFWXenF0MLC4cqo3dv8qiHPGyjCl1rwOT0LomSHpcElbjjVh5CwzElInB38HD8aSRVugKQjeyHA==",
"version": "3.0.0",
"resolved": "https://registry.npmjs.org/remark-frontmatter/-/remark-frontmatter-3.0.0.tgz",
"integrity": "sha512-mSuDd3svCHs+2PyO29h7iijIZx4plX0fheacJcAoYAASfgzgVIcXGYSq9GFyYocFLftQs8IOmmkgtOovs6d4oA==",
"dev": true,
"requires": {
"fault": "^1.0.1"
"mdast-util-frontmatter": "^0.2.0",
"micromark-extension-frontmatter": "^0.2.0"
}
},
"remark-lint": {

View File

@ -5,7 +5,7 @@
"dependencies": {},
"devDependencies": {
"remark-cli": "^8.0.1",
"remark-frontmatter": "^2.0.0",
"remark-frontmatter": "^3.0.0",
"remark-lint": "^7.0.1",
"remark-lint-fenced-code-flag": "^2.0.1",
"remark-lint-no-shell-dollars": "^2.0.2",

View File

@ -4,8 +4,6 @@ description: "Instructions on how to add MQTT notifications to Home Assistant."
logo: mqtt.png
ha_category: Notifications
ha_iot_class: Configurable
redirect_from:
/integrations/notify.mqtt/
---
The MQTT notification support is different than the other [notification](/integrations/notify/) platforms. It is a service. This means that you don't have to create a configuration entry but you need to provide more details when calling the service.

View File

@ -13,9 +13,9 @@
- topic: Cookbook
description: "The [Cookbook](/cookbook/) contains a set of configuration examples of Home Assistant from the community."
- topic: Cover
description: "[Covers](/integrations/cover) are devices such as blinds, garage doors, etc than can be opened and closed and optionally set to a specific position."
description: "[Covers](/integrations/cover) are devices such as blinds, garage doors, etc that can be opened and closed and optionally set to a specific position."
- topic: Customize
description: "[Customization](/docs/configuration/customizing-devices/) allows you to overwrite the default parameter of your devices in the configuration."
description: "[Customization](/docs/configuration/customizing-devices/) allows you to overwrite the default parameters of your devices in the configuration."
- topic: Device
description: "A device is usually a physical unit which can do or observe something."
- topic: Device tracker
@ -23,21 +23,23 @@
- topic: Discovery
description: "[Discovery](/integrations/discovery/) is the automatic setup of zeroconf/mDNS and uPnP devices after they are discovered."
- topic: Entity
description: "An [entity](/docs/configuration/platform_options/) is the representation of function a single device, unit, or web service. There may be multiple entities for a single device, unit, or web service, or there may be only one."
description: "An [entity](/docs/configuration/platform_options/) is the representation of a function of a single device, unit, or web service. There may be multiple entities for a single device, unit, or web service, or there may be only one."
- topic: Event
description: "An [event](/docs/configuration/events/) is when something happens."
- topic: Frontend
description: "The [frontend](/integrations/frontend/) is a necessary component for the UI, it is also where you can define your themes."
- topic: Group
description: "[Groups](/integrations/group/) are a way to organize your entities into a single unit."
- topic: hass
- topic: HASS
description: "HASS or [hass](/docs/tools/hass/) is often used as an abbreviation for Home Assistant. It is also the command-line tool."
- topic: HassOS
description: "Another name for Home Assistant Operating System"
- topic: Home Assistant Core
description: Home Assistant Core is a Python program. It can be run on various operating systems and is the basis for Home Assistant. When people are talking about Home Assistant Core they usually refer to a standalone installation method that can be installed using a Virtual Environment or Docker. Home Assistant Core does not use the Home Assistant Supervisor.
- topic: Home Assistant Supervised (Previously Hass.io)
description: "[Home Assistant](/hassio/) is a full UI managed home automation ecosystem that runs Home Assistant, the Home Assistant Supervisor and add-ons. It comes pre-installed on Home Assistant OS, but can be installed on any Linux system. It leverages Docker, which is managed by the Home Assistant Supervisor."
- topic: Home Assistant Supervisor
description: "The Home Assistant Supervisor is a program that manages a Home Assistant installation, taking care of installing and updating Home Assistant, add-ons, itself and, if used, updating the HassOS operating system."
description: "The Home Assistant Supervisor is a program that manages a Home Assistant installation, taking care of installing and updating Home Assistant, add-ons, itself and, if used, updating the Home Assistant Operating System."
- topic: Home Assistant Operating System
description: "Home Assistant OS, the Home Assistant Operating System, is an embedded, minimalistic, operating system designed to run the Home Assistant ecosystem on single board computers (like the Raspberry Pi) or Virtual Machines. The Home Assistant Supervisor can keep it up to date, removing the need for you to manage an operating system."
- topic: Integration

View File

@ -1,8 +1,6 @@
---
title: "Authentication"
description: "Guide on authentication in Home Assistant."
redirect_from:
- /integrations/auth/
---
Our authentication system secures access to Home Assistant.

View File

@ -1,7 +1,6 @@
---
title: "Multi-factor authentication"
description: "Guide on configuring different multi-factor authentication modules."
redirect_from: /integrations/auth/
---
The Multi-factor Authentication (MFA) modules require you to solve a second challenge after you provide your password.

View File

@ -1,7 +1,6 @@
---
title: "Authentication Providers"
description: "Guide on configuring different auth providers."
redirect_from: /integrations/auth/
---
When you log in, an _auth provider_ checks your credentials to make sure you are an authorized user.

View File

@ -31,7 +31,7 @@ The difference between a condition and a trigger can be confusing as they are ve
### Exploring the internal state
Automation rules interact directly with the internal state of Home Assistant, so you'll need to familiarize yourself with it. Home Assistant exposes its current state via the developer tools. These are available at the bottom of the sidebar in the frontend. The <img src='/images/screenshots/developer-tool-states-icon.png' class='no-shadow' height='38' /> icon will show all currently available states. An entity can be anything. A light, a switch, a person and even the sun. A state consists of the following parts:
Automation rules interact directly with the internal state of Home Assistant, so you'll need to familiarize yourself with it. Home Assistant exposes its current state via the developer tools. These are available at the bottom of the sidebar in the frontend. **Developer Tools** -> **States** will show all currently available states. An entity can be anything. A light, a switch, a person and even the sun. A state consists of the following parts:
| Name | Description | Example |
| ---- | ----- | ---- |

View File

@ -1,7 +1,6 @@
---
title: "Automation Actions"
description: "Automations result in action."
redirect_from: /getting-started/automation-action/
---
The action of an automation rule is what is being executed when a rule fires. The action part follows the [script syntax](/docs/scripts/) which can be used to interact with anything via services or events. For services you can specify the entity_id that it should apply to and optional service parameters (to specify for example the brightness).
@ -46,11 +45,11 @@ Conditions can also be part of an action. You can combine multiple service calls
```yaml
automation:
- alias: 'Enciende Despacho'
- alias: 'Office at evening'
trigger:
platform: state
entity_id: sensor.mini_despacho
to: 'ON'
entity_id: sensor.office_occupancy
to: 'on'
action:
- service: notify.notify
data:
@ -60,7 +59,7 @@ automation:
- condition: template
value_template: '{% raw %}{{ state_attr('sun.sun', 'elevation') < 4 }}{% endraw %}'
- condition: template
value_template: '{% raw %}{{ states('sensor.sensorluz_7_0') < 10 }}{% endraw %}'
value_template: '{% raw %}{{ states('sensor.office_illuminance') < 10 }}{% endraw %}'
- service: scene.turn_on
entity_id: scene.DespiertaDespacho
entity_id: scene.office_at_evening
```

View File

@ -1,7 +1,6 @@
---
title: "Automation Conditions"
description: "Automations can test conditions when invoked."
redirect_from: /getting-started/automation-condition/
---
Conditions are an optional part of an automation rule and can be used to prevent an action from happening when triggered. When a condition does not return true, the automation will stop executing. Conditions look very similar to triggers but are very different. A trigger will look at events happening in the system while a condition only looks at how the system looks right now. A trigger can observe that a switch is being turned on. A condition can only see if a switch is currently on or off.

View File

@ -10,19 +10,19 @@ From the UI choose **Configuration** which is located in the sidebar, then click
Choose a meaningful name for your automation rules.
<p class='img'>
<img src='{{site_root}}/images/docs/automation-editor/new-automation.png' />
<img src='/images/docs/automation-editor/new-automation.png' />
</p>
If the value of the sensor is greater than 10, then the automation rule should apply.
<p class='img'>
<img src='{{site_root}}/images/docs/automation-editor/new-trigger.png' />
<img src='/images/docs/automation-editor/new-trigger.png' />
</p>
Firing a [persistent notification](/integrations/persistent_notification/) is the result.
<p class='img'>
<img src='{{site_root}}/images/docs/automation-editor/new-action.png' />
<img src='/images/docs/automation-editor/new-action.png' />
</p>
As "Service Data" we want a simple text that is shown as part of the notification.

View File

@ -1,7 +1,6 @@
---
title: "Automation Examples"
description: "Some automation examples to get you started."
redirect_from: /getting-started/automation-examples/
---
Just some sample automation rules to get you started.

View File

@ -1,7 +1,6 @@
---
title: "Automation Templating"
description: "Advanced automation documentation using templating."
redirect_from: /getting-started/automation-templating/
---
In Home Assistant 0.19 we introduced a new powerful feature: variables in scripts and automations. This makes it possible to adjust your condition and action based on the information of the trigger.
@ -64,7 +63,7 @@ Remembering these simple rules will help save you from many headaches and endles
## Trigger State Object
Knowing how to access the [state object](/docs/configuration/state_object/) of a trigger entity can be useful in automations. Here are a few ways to access the [`state`](#state), [`numeric_state`](#numeric_state) and [`template`](#template) triggers:
Knowing how to access the [state object](/docs/configuration/state_object/) of a trigger entity can be useful in automations. Here are a few ways to access the [`state`](#state), [`numeric state`](#numeric-state) and [`template`](#template) triggers:
* `trigger.from_state` will return the **previous** [state object](/docs/configuration/state_object/) of the entity.
* `trigger.to_state` will return the **new** [state object](/docs/configuration/state_object/) that triggered trigger.

View File

@ -1,7 +1,6 @@
---
title: "Automation Trigger"
description: "All the different ways how automations can be triggered."
redirect_from: /getting-started/automation-trigger/
---
### What are triggers
@ -287,7 +286,7 @@ automation:
trigger:
platform: numeric_state
entity_id: sun.sun
value_template: "{{ state_attr('sun.sun', 'elevation') }}"
attribute: elevation
# Can be a positive or negative number
below: -4.0
action:
@ -297,7 +296,7 @@ automation:
{% endraw %}
If you want to get more precise, start with the US Naval Observatory [tool](https://aa.usno.navy.mil/data/docs/AltAz.php) which will help you estimate what the solar elevation will be at any specific time. Then from this, you can select from the defined twilight numbers.
If you want to get more precise, you can use this [solar calculator](https://www.esrl.noaa.gov/gmd/grad/solcalc/), which will help you estimate what the solar elevation will be at any specific time. Then from this, you can select from the defined twilight numbers.
Although the actual amount of light depends on weather, topography and land cover, they are defined as:

View File

@ -1,7 +1,6 @@
---
title: "Troubleshooting Automations"
description: "Tips on how to troubleshoot your automations."
redirect_from: /getting-started/automation-troubleshooting/
---
You can verify that your automation rules are being initialized correctly by watching both the realtime logs (`homeassistant.log` in the configuration directory) and also the [Logbook](/integrations/logbook/). The realtime logs will show the rules being initialized (once for each trigger), example:

View File

@ -1,7 +1,6 @@
---
title: "Database"
description: "Details about the database used by Home Assistant."
redirect_from: /details/database/
---
Database is used in by Home Assistant as history and tracker only, to store the events and its parameters. The default database used by Home Assistant is [SQLite](https://www.sqlite.org/), and the database file is stored in your [configuration directory](/getting-started/configuration/) (e.g., `<path to config dir>/home-assistant_v2.db`). If you prefer to run a database server (e.g., PostgreSQL), use the [`recorder` component](/integrations/recorder/).

View File

@ -1,7 +1,6 @@
---
title: "Updater"
description: "Details what the updater integration is reporting about your Home Assistant instance."
redirect_from: /details/updater/
---
Starting with 0.31 the [updater component](/integrations/updater/) sends an optional report about Home Assistant instance.

View File

@ -1,7 +1,6 @@
---
title: "Setup basic information"
description: "Setting up the basic info of Home Assistant."
redirect_from: /getting-started/basic/
---
As part of the default onboarding process, Home Assistant can detect your location from IP address geolocation. Home Assistant will automatically select a temperature unit and time zone based on this location. You may adjust this during onboarding, or afterwards at Configuration -> General.

View File

@ -1,7 +1,6 @@
---
title: "Customizing entities"
description: "Simple customization for entities in the frontend."
redirect_from: /getting-started/customizing-devices/
---
## Changing the entity_id

View File

@ -1,7 +1,6 @@
---
title: "Adding devices to Home Assistant"
description: "Steps to help you get your devices in Home Assistant."
redirect_from: /getting-started/devices/
---
Home Assistant will be able to automatically discover many devices and services available on your network if you have [the discovery component](/integrations/discovery/) enabled (the default setting).
@ -63,7 +62,7 @@ switch 2:
## Grouping devices
Once you have several devices set up, it is time to organize them into groups.
Each group consists of a name and a list of entity IDs. Entity IDs can be retrieved from the web interface by using the Set State page in the Developer Tools (<img src='/images/screenshots/developer-tool-states-icon.png' alt='service developer tool icon' class="no-shadow" height="38" />).
Each group consists of a name and a list of entity IDs. Entity IDs can be retrieved from the web interface by using the “States” page in the Developer Tools.
```yaml
# Example configuration.yaml entry showing two styles

View File

@ -1,7 +1,6 @@
---
title: "Events"
description: "Describes all there is to know about events in Home Assistant."
redirect_from: /topics/events/
---
The core of Home Assistant is the event bus. The event bus allows any integration to fire or listen for events. It is the core of everything. For example, any state change will be announced on the event bus as a `state_changed` event containing the previous and the new state of an entity.

View File

@ -1,7 +1,6 @@
---
title: "Packages"
description: "Describes all there is to know about configuration packages in Home Assistant."
redirect_from: /topics/packages/
---
Packages in Home Assistant provide a way to bundle different component's configuration together. We already learned about the two configuration styles (specifying platforms entries together or individually) on the [adding devices](/docs/configuration/devices/) page. Both of these configuration methods require you to create the integration key in the main `configuration.yaml` file. With packages we have a way to include different components, or different configuration parts using any of the `!include` directives introduced in [splitting the configuration](/docs/configuration/splitting_configuration).

View File

@ -1,7 +1,6 @@
---
title: "Entity integration platform options"
description: "Shows how to customize polling interval for any integration via configuration.yaml."
redirect_from: /topics/platform_options/
---
<div class='note info'>

View File

@ -1,7 +1,6 @@
---
title: "Storing secrets"
description: "Storing secrets outside of your configuration.yaml."
redirect_from: /topics/secrets/
---
The `configuration.yaml` file is a plain-text file, thus it is readable by anyone who has access to the file. The file contains passwords and API tokens which need to be redacted if you want to share your configuration. By using `!secret` you can remove any private information from your configuration files. This separation can also help you to keep easier track of your passwords and API keys, as they are all stored at one place and no longer spread across the `configuration.yaml` file or even multiple YAML files if you [split up your configuration](/docs/configuration/splitting_configuration/).

View File

@ -1,7 +1,6 @@
---
title: "Securing"
description: "Instructions on how to secure your Home Assistant installation."
redirect_from: /getting-started/securing/
---
One major advantage of Home Assistant is that it's not dependent on cloud services. Even if you're only using Home Assistant on a local network, you should take steps to secure your instance.

View File

@ -1,7 +1,6 @@
---
title: "Splitting up the configuration"
description: "Splitting the configuration.yaml into several files."
redirect_from: /topics/splitting_configuration/
---
So you've been using Home Assistant for a while now and your `configuration.yaml` file brings people to tears or you simply want to start off with the distributed approach, here's how to split the `configuration.yaml` into more manageable (read: humanly readable) pieces.

View File

@ -1,7 +1,6 @@
---
title: "State Objects"
description: "Describes all there is to know about state objects in Home Assistant."
redirect_from: /topics/state_object/
---
Your devices are represented in Home Assistant as entities. The entities will write their current state to the state machine for other entities/templates/frontend to access. States are a current representation of the entity.

View File

@ -1,7 +1,6 @@
---
title: "Templating"
description: "Instructions on how to use the templating feature of Home Assistant."
redirect_from: /topics/templating/
---
This is an advanced feature of Home Assistant. You'll need a basic understanding of:

View File

@ -1,7 +1,6 @@
---
title: "Troubleshooting your configuration"
description: "Common problems with tweaking your configuration and their solutions."
redirect_from: /getting-started/troubleshooting-configuration/
---
It can happen that you run into trouble while configuring Home Assistant. Perhaps an integration is not showing up or is acting strangely. This page will discuss a few of the most common problems.

View File

@ -1,14 +1,13 @@
---
title: "YAML"
description: "Details about YAML to configure Home Assistant."
redirect_from: /getting-started/yaml/
---
Home Assistant uses the [YAML](https://yaml.org/) syntax for configuration. YAML might take a while to get used to but is really powerful in allowing you to express complex configurations.
For integrations that you want to use in Home Assistant, you add code in your `configuration.yaml` file to specify its settings. This especially applies to integrations that are not yet available to configure through the UI.
The following example entry assumes that you would like to set up the [notify component](/integrations/notify) with the [pushbullet platform](/integrations/pushbullet).
The following example entry assumes that you would like to set up the [notify integration](/integrations/notify) with the [pushbullet platform](/integrations/pushbullet).
```yaml
notify:
@ -17,12 +16,12 @@ notify:
name: pushbullet
```
- A **component** provides the core logic for some functionality (like `notify` provides sending notifications).
- An **integration** provides the core logic for some functionality (like `notify` provides sending notifications).
- A **platform** makes the connection to a specific software or hardware platform (like `pushbullet` works with the service from pushbullet.com).
The basics of YAML syntax are block collections and mappings containing key-value pairs. Each item in a collection starts with a `-` while mappings have the format `key: value`. If you specify duplicate keys, the last value for a key is used. This is somewhat similar to a Hash table or more specifically a dictionary in Python. These can be nested as well.
The basics of YAML syntax are block collections and mappings containing key-value pairs. Each item in a collection starts with a `-` while mappings have the format `key: value`. This is somewhat similar to a Hash table or more specifically a dictionary in Python. These can be nested as well. **Beware that if you specify duplicate keys, the last value for a key is used**.
Note that indentation is an important part of specifying relationships using YAML. Things that are indented are nested "inside" things that are one level higher. So in the above example, `platform: pushbullet` is a property of (nested inside) the `notify` component.
Note that indentation is an important part of specifying relationships using YAML. Things that are indented are nested "inside" things that are one level higher. So in the above example, `platform: pushbullet` is a property of (nested inside) the `notify` integration.
Getting the right indentation can be tricky if you're not using an editor with a fixed width font. Tabs are not allowed to be used for indentation. Convention is to use 2 spaces for each level of indentation.
@ -64,7 +63,7 @@ sensor:
## Including values
### Environmental variables
### Environment variables
On Home Assistant Core installations, you can include values from your system's environment variables with `!env_var`.
Note that this will only work for Home Assistant Core installations, in a scenario where it is possible to specify these.

View File

@ -6,7 +6,7 @@ description: "Frontend of Home Assistant."
The frontend of Home Assistant is built with [Polymer](https://www.polymer-project.org/).
<p class='img'>
<img src='{{site_root}}/images/screenshots/ui2015.png' />
<img src='/images/screenshots/ui2015.png' />
</p>
The [User Interface section](/cookbook/#user-interface) can give you some starting points to expand the frontend.

View File

@ -1,7 +1,6 @@
---
title: "Browsers"
description: "Browser Compatibility List"
redirect_from: /getting-started/browsers/
---
Home Assistant requires a web browser to show the frontend and supports all major modern browsers. We don't test the web interface against all available browsers but this page tracks different browsers on various operating systems and should help you to pick a browser which works. The "Release" column contains the release number which was tested. This doesn't mean that older or newer releases will not work.
@ -81,7 +80,7 @@ There are reports that devices running with iOS prior to iOS 10, especially old
[Iridium]: https://iridiumbrowser.de/
[Konqueror]: https://konqueror.org/
[Lynx]: https://lynx.browser.org/
[Midori]: https://www.midori-browser.org/
[Midori]: https://astian.org/midori-browser/
[Opera]: https://www.opera.com/
[Safari]: https://www.apple.com/safari/
[surf]: https://surf.suckless.org/

View File

@ -1,7 +1,6 @@
---
title: "Installation of Home Assistant"
description: "Instructions on how to install Home Assistant to launch on start."
redirect_from: /getting-started/installation/
---
<div class='note'>

View File

@ -1,7 +1,6 @@
---
title: "Installation on Docker"
description: "Instructions to install Home Assistant on a Docker."
redirect_from: /getting-started/installation-docker/
---
<div class='note warning'>

View File

@ -1,10 +1,9 @@
---
title: "Manual installation on a Raspberry Pi"
description: "Instructions to install Home Assistant Core on a Raspberry Pi running Raspberry Pi OS Lite."
redirect_from: /getting-started/installation-raspberry-pi/
---
This installation of Home Assistant Core requires the Raspberry Pi to run [Raspberry Pi OS Lite](https://www.raspberrypi.org/downloads/raspberry-pi-os//). The installation will be installed in a [Virtual Environment](/docs/installation/virtualenv) with minimal overhead. Instructions assume this is a new installation of Raspberry Pi OS Lite.
This installation of Home Assistant Core requires the Raspberry Pi to run [Raspberry Pi OS Lite](https://www.raspberrypi.org/downloads/raspberry-pi-os/). The installation will be installed in a [Virtual Environment](/docs/installation/virtualenv) with minimal overhead. Instructions assume this is a new installation of Raspberry Pi OS Lite.
You must have Python 3.7 or later installed (including the package `python3-dev`) which is *not* the case for Raspberry Pi OS Stretch.

View File

@ -1,7 +1,6 @@
---
title: "Troubleshooting installation problems"
description: "Common installation problems and their solutions."
redirect_from: /getting-started/troubleshooting/
---
It can happen that you run into trouble while installing Home Assistant. This page is here to help you solve the most common problems.

View File

@ -1,7 +1,6 @@
---
title: "Updating Home Assistant"
description: "Step to update Home Assistant."
redirect_from: /getting-started/updating/
---
<div class='note warning'>

View File

@ -1,7 +1,6 @@
---
title: "Installation in Python virtual environment"
description: "How to install Home Assistant in a Python virtual environment."
redirect_from: /getting-started/installation-virtualenv/
---
If you already have Python 3.7 or later installed, you can easily give Home Assistant a spin.

View File

@ -23,5 +23,3 @@ For detailed setup instructions, please refer to the [MQTT broker](/docs/mqtt/br
- [Birth and last will messages](/docs/mqtt/birth_will/)
- [Testing your setup](/docs/mqtt/testing/)
- [Logging](/docs/mqtt/logging/)
See the [MQTT example component](/cookbook/python_component_mqtt_basic/) how to integrate your own component.

View File

@ -133,7 +133,6 @@ Supported abbreviations:
'hs_val_tpl': 'hs_value_template',
'ic': 'icon',
'init': 'initial',
'json_attr': 'json_attributes',
'json_attr_t': 'json_attributes_topic',
'json_attr_tpl': 'json_attributes_template',
'max_mirs': 'max_mireds',
@ -269,6 +268,7 @@ The following software has built-in support for MQTT discovery:
- [Tasmota](https://github.com/arendst/Tasmota) (starting with 5.11.1e)
- [ESPHome](https://esphome.io)
- [ESPurna](https://github.com/xoseperez/espurna)
- [SmartHome](https://github.com/roncoa/SmartHome)
- [Arilux AL-LC0X LED controllers](https://github.com/mertenats/Arilux_AL-LC0X)
- [room-assistant](https://github.com/mKeRix/room-assistant) (starting with 1.1.0)
- [Zigbee2mqtt](https://github.com/koenkk/zigbee2mqtt)

View File

@ -1,7 +1,6 @@
---
title: "Script Syntax"
description: "Documentation for the Home Assistant Script Syntax."
redirect_from: /getting-started/scripts/
---
Scripts are a sequence of actions that Home Assistant will execute. Scripts are available as an entity through the standalone [Script component] but can also be embedded in [automations] and [Alexa/Amazon Echo] configurations.
@ -420,6 +419,7 @@ For example:
sequence:
- ...
```
{% endraw %}
### Repeat Loop Variable

View File

@ -1,7 +1,6 @@
---
title: "Conditions"
description: "Documentation about all available conditions."
redirect_from: /getting-started/scripts-conditions/
---
Conditions can be used within a script or automation to prevent further execution. When a condition does not return true, the script or automation stops executing. A condition will look at the system at that moment. For example, a condition can test if a switch is currently turned on or off.

View File

@ -1,7 +1,6 @@
---
title: "Script Editor"
description: "Instructions on how to use the new script editor."
redirect_from: /docs/script/editor/
---
In Home Assistant 0.52 we introduced the first version of our script editor. If you just created a new configuration with Home Assistant then you're all set! Go to the UI and enjoy.

View File

@ -1,7 +1,6 @@
---
title: "Service Calls"
description: "Instructions on how to call services in Home Assistant."
redirect_from: /getting-started/scripts-service-calls/
---
Various integrations allow calling services when a certain event occurs. The most common one is calling a service when an automation trigger happens. But a service can also be called from a script or via the Amazon Echo.

View File

@ -1,5 +1,5 @@
---
title: "Development Tools"
title: "Developer Tools"
description: "Description of the Developer Tools."
---
@ -19,24 +19,24 @@ Screenshot of Home Assistant's Developer Tools.
## What can I do with Developer Tools?
The Developer Tools is meant for **all** (not just for the developers) to quickly try out things - like calling services, update states, raising events, and publish messages in mqtt…etc.). It is also a necessary tool for those who write custom automations and scripts by hand. The following describes each of the section in detail.
The Developer Tools is meant for **all** (not just for the developers) to quickly try out things - like calling services, updating states, raising events, and publishing messages in MQTT). It is also a necessary tool for those who write custom automations and scripts by hand. The following describes each of the sections in detail.
## Services
This section is used to call Services that are available in the ServiceRegistry.
The list of services in the “Service” drop down are automatically populated based on the integrations that are found in the configuration, automation and script files. If a desired service does not exist, it means either the integration is not configured properly or not defined in the configuration, automation or script files.
The list of services in the “Service” dropdown are automatically populated based on the integrations that are found in the configuration, automation and script files. If a desired service does not exist, it means either the integration is not configured properly or not defined in the configuration, automation or script files.
When a Service is selected, and if that service requires an `entity_id` to be passed, the “Entity” drop down will automatically be populated with corresponding entities.
When a Service is selected, and if that service requires an `entity_id` to be passed, the “Entity” dropdown will automatically be populated with corresponding entities.
A Service may also require additional input to be passed. It is commonly referred to as “service data”. The service data is accepted in YAML format, and it may be optional depending on the service.
When an entity is selected from the Entity drop down, it automatically populates service data with the corresponding `entity_id`. The service data YAML can then be modified to pass additional \[optional\] parameters. The following is an illustration on how to call a `light.turn_on` service.
When an entity is selected from the Entity dropdown, it automatically populates service data with the corresponding `entity_id`. The service data YAML can then be modified to pass additional \[optional\] parameters. The following is an illustration on how to call a `light.turn_on` service.
To turn on a light bulb, use the following steps:
1. Select `light.turn_on` from the Service drop down
2. Select the entity (typically the light bulb) from the Entity drop down (if no entity_id is selected, it turns on ALL lights)
3. If an entity is selected, the service data is populated with basic JSON that will be passed to the service. An additional data can also be passed by updating the JSON as below.
1. Select `light.turn_on` from the Service dropdown
2. Select the entity (typically the light bulb) from the Entity dropdown (if no entity_id is selected, it turns on ALL lights)
3. If an entity is selected, the service data is populated with basic YAML that will be passed to the service. Additional data can also be passed by updating the YAML as below.
```yaml
entity_id: light.bedroom
@ -50,7 +50,7 @@ This section shows all the available entities, their corresponding state and the
Note that this is the state representation of a device within Home Assistant. That means, it is what Home Assistant sees, and it does not communicate with the actual device in any manner. The updated information can still be used to trigger events, and state changes. To communicate with the actual device, it is recommended to call services in the services section above, instead of updating state.
For ex: Changing the `light.bedroom` state from `off` to `on` does not turn on the light. If there is an automation that triggers on the `state` change of the `light.bedroom`, it will be triggered even though the actual bulb has not turned on. Also, when the bulb state changes the state information will be overridden. In other words, the changes that are made through the “States” section are temporary, and is recommended to use for testing purposes only.
For example, changing the `light.bedroom` state from `off` to `on` does not turn on the light. If there is an automation that triggers on the `state` change of the `light.bedroom`, it will be triggered even though the actual bulb has not turned on. Also, when the bulb state changes the state information will be overridden. In other words, the changes that are made through the “States” section are temporary, and is recommended to use for testing purposes only.
## Events
@ -77,10 +77,8 @@ If there is an automation that handles that event, it will be automatically trig
## Template Editor
The Template Editor provides a way to test the template code quickly. When the Template Editor page is loaded, it comes with a sample template code that illustrates how the code can be written and tested.
The Template Editor provides a way to quickly test templates prior to placing them into automations and scripts. A code editor is on the left side and your real-time output is displayed in the preview on the right side.
It has two sections, code goes on the left hand side, and the output is shown on the right hand side. The code can be removed and replaced, and when the page is loaded/refreshed, the default sample code will be loaded back.
By default this will contain sample code that illustrates how templates can be written and tested. This sample code can be removed and replaced with your own. You can restore the default example by pressing the "Reset to Demo Template" button beneath the code editor.
It is a good practice to test the template code in the template editor prior to putting it in automations and scripts.
For more information about jinja2, visit [jinja2 documentation](http://jinja.pocoo.org/docs/dev/templates/), and also read templating document [here](/topics/templating/)
For more information about Jinja2, visit [Jinja2 documentation](http://jinja.pocoo.org/docs/dev/templates/), and also read templating document [here](/topics/templating/).

View File

@ -1,7 +0,0 @@
---
title: "Tools"
description: "Description of tools which helps when using Home Assistant."
redirect_from: /docs/tools/
---

View File

@ -1,7 +1,6 @@
---
title: "Z-Wave"
description: "Using Z-Wave with Home Assistant."
redirect_from: /getting-started/z-wave/
---
[Z-Wave](https://www.z-wave.com/) integration for Home Assistant allows you to observe and control connected Z-Wave devices. Z-Wave support requires a [supported Z-Wave USB stick or module](/docs/z-wave/controllers/) to be plugged into the host.

View File

@ -1,7 +1,6 @@
---
title: "Z-Wave Control Panel"
description: "How to use the Z-Wave control panel."
redirect_from: /getting-started/z-wave-panel/
---
<div class='note'>

View File

@ -1,7 +1,6 @@
---
title: "Z-Wave Device Specific Settings"
description: "Notes for specific Z-Wave devices."
redirect_from: /getting-started/z-wave-device-specific/
---
## Device Categories

View File

@ -1,7 +1,6 @@
---
title: "Z-Wave Devices"
description: "What you need to know about Z-Wave devices."
redirect_from: /getting-started/z-wave-devices/
---
## Devices, Nodes, Entities

View File

@ -1,7 +1,6 @@
---
title: "Z-Wave"
description: "Installation of the Z-Wave component."
redirect_from: /getting-started/z-wave-installation/
---
Z-Wave can be configured using the Z-Wave *Integration* in the *Configuration* menu, or manually using an entry in `configuration.yaml`

View File

@ -186,7 +186,6 @@
</li>
<li>{% active_link /docs/mqtt/testing/ Testing your setup %}</li>
<li>{% active_link /docs/mqtt/logging/ Logging %}</li>
<li>{% active_link /docs/mqtt/processing_json/ Processing JSON %}</li>
</ul>
</li>
</ul>

View File

@ -9,7 +9,7 @@
<div class="icons">
<a rel="me" href='https://twitter.com/home_assistant' title="Twitter"><i class="icon-twitter"></i></a>
<a rel="me" href='https://www.facebook.com/homeassistantio' title="Facebook"><i class="icon-facebook"></i></a>
<a rel="me" href='https://github.com/home-assistant/home-assistant' title="GitHub"><i class="icon-github"></i></a>
<a rel="me" href='https://github.com/home-assistant/core' title="GitHub"><i class="icon-github"></i></a>
</div>
</div>

View File

@ -3,6 +3,7 @@ title: Actiontec
description: Instructions on how to integrate Actiontec routers into Home Assistant.
ha_category:
- Presence Detection
ha_iot_class: Local Polling
ha_release: 0.7
ha_domain: actiontec
---

View File

@ -2,6 +2,7 @@
title: Air Quality
description: Instructions on how to add air quality sensors with Home Assistant
ha_release: 0.85
ha_iot_class: ~
ha_domain: air_quality
---

View File

@ -11,11 +11,11 @@ ha_domain: airvisual
ha_config_flow: true
---
The `airvisual` sensor platform queries the [AirVisual](https://airvisual.com/) cloud API for air quality data. Data can be collected via latitude/longitude, by city/state/country, or from an [AirVisual Node/Pro unit](https://www.airvisual.com/air-quality-monitor).
The `airvisual` sensor platform queries the [AirVisual](https://www.iqair.com) cloud API for air quality data. Data can be collected via latitude/longitude, by city/state/country, or from an [AirVisual Node/Pro unit](https://www.iqair.com/air-quality-monitors/airvisual-pro).
## Using the AirVisual Cloud API
AirVisual API keys can be obtained [here](https://airvisual.com/api). Note that the platform was designed using the "Community" package; the "Startup" and "Enterprise" package keys should continue to function, but actual results may vary (or not work at all).
AirVisual API keys can be obtained [here](https://www.iqair.com/air-pollution-data-api). Note that the platform was designed using the "Community" package; the "Startup" and "Enterprise" package keys should continue to function, but actual results may vary (or not work at all).
The Community API key is valid for 12 months after which it will expire. You must then go back to the AirVisual website, delete your old key, create a new one following the same steps and update your configuration with the new key.
@ -33,7 +33,7 @@ For example:
## Using an AirVisual Node/Pro Unit
The integration can communicate to Node/Pro units over the local network. You will need the IP address/hostname of the unit and its Samba password (which can be found on the unit; instructions here: https://support.airvisual.com/en/articles/3029331-download-the-airvisual-node-pro-s-data-using-samba).
The integration can communicate to Node/Pro units over the local network. You will need the IP address/hostname of the unit and its Samba password (which can be found on the unit; instructions here: https://support.iqair.com/en/articles/3029331-download-the-airvisual-node-pro-s-data-using-samba).
## Configuration
@ -125,7 +125,7 @@ airvisual:
## Determining the City/State/Country
To easily determine the proper values for a particular location, use the [AirVisual region directory](https://airvisual.com/world). Once you browse to the particular city you want, take note of the breadcrumb title, which is of the form `country > state/region > city`. Use this information to fill out `configuration.yaml`.
To easily determine the proper values for a particular location, use the [AirVisual region directory](https://www.iqair.com/world-air-quality). Once you browse to the particular city you want, take note of the breadcrumb title, which is of the form `country > state/region > city`. Use this information to fill out `configuration.yaml`.
For example, Sao Paulo, Brazil shows a breadcrumb title of `Brazil > Sao Paulo > Sao Paulo`. Thus, the proper configuration would look like this:

View File

@ -6,6 +6,7 @@ ha_category:
ha_release: 0.7.3
ha_quality_scale: internal
ha_domain: alarm_control_panel
ha_iot_class: ~
---
Home Assistant can give you an interface which is similar to a classic alarm system.

View File

@ -4,6 +4,7 @@ description: Instructions on how to setup automatic alerts within Home Assistant
ha_category:
- Automation
ha_release: 0.38
ha_iot_class: Local Push
ha_quality_scale: internal
ha_domain: alert
---

View File

@ -23,7 +23,7 @@ The built-in Alexa integration allows you to integrate Home Assistant into Alexa
### Create Your Amazon Alexa Custom Skill
- Log in to [Amazon developer console][amazon-dev-console]
- Log in to the [Amazon developer console][amazon-dev-console]
- Click the Alexa button at the top of the console
- Click the yellow "Add a new skill" button in the top right
- Skill Type: Custom Interaction Model (default)
@ -60,7 +60,7 @@ The first thing you need to do after you sign in to the [AWS console](https://co
Next you need to create a Lambda function.
- Click `Service` in top navigation bar, expand the menu to display all AWS services, click `Lambda` under `Compute` section to navigate to Lambda console. Or you may use this [link](https://console.aws.amazon.com/lambda/home)
- **IMPORTANT** Your current region will be displayed on the top right corner, make sure you select right region base on your Amazon account's country:
- **IMPORTANT** Your current region will be displayed in the top right corner. Make sure you select the right region based on your Amazon account's country:
- **US East (N.Virginia)** region for English (US) or English (CA) skills
- **EU (Ireland)** region for English (UK), English (IN), German (DE), Spanish (ES) or French (FR) skills
- **US West (Oregon)** region for Japanese and English (AU) skills.
@ -70,9 +70,9 @@ Next you need to create a Lambda function.
- Select *Use an existing role* as `Execution role`, then select the role you just created from the `Existing role` list.
- Click `Create function`, then you can configuration detail of Lambda function.
- Under `Configuration` tab, expand `Designer`, then click `Alexa Skills Kit` in the left part of the panel to add a Alexa Skills Kit trigger to your Lambda function.
- Scroll down little bit, you need to input the `Skill ID` from the skill you created in previous step. (You may need to switch back to the Alexa Developer Console to copy the `Skill ID`.)
- Scroll down a little bit, you need to input the `Skill ID` from the skill you created in the previous step. (You may need to switch back to the Alexa Developer Console to copy the `Skill ID`).
- Click your Lambda Function icon in the middle of the diagram and scroll down, you will see a `Function code` window.
- Clear the example code and copy the Python script from: [https://gist.github.com/lpomfrey/97381cf4316553b03622c665ae3a47da](https://gist.github.com/lpomfrey/97381cf4316553b03622c665ae3a47da)
- Clear the example code and copy the Python script from this [GitHub Gist](https://gist.github.com/lpomfrey/97381cf4316553b03622c665ae3a47da).
- Click the `Deploy` button of the `Function code` window.
- Scroll down again and you will find `Environment variables`, click on `Edit` button and add the following environment variables as needed:
- BASE_URL *(required)*: your Home Assistant instance's Internet accessible URL with port if needed. *Do not include the trailing `/`*.
@ -84,11 +84,12 @@ Next you need to create a Lambda function.
### Account Linking
Alexa can link your Amazon account to your Home Assistant account. Therefore Home Assistant can make sure only authenticated Alexa requests are actioned. In order to link the account, you have to make sure your Home Assistant can be accessed from Internet.
Alexa can link your Amazon account to your Home Assistant account. Therefore Home Assistant can make sure only authenticated Alexa requests are actioned. In order to link the account, you have to make sure your Home Assistant instance can be accessed from the Internet.
- Sign in to the [Alexa Developer Console][alexa-dev-console] and go to the `Alexa Skills` page.
- Log in to the [Amazon developer console][amazon-dev-console]
- Go to the `Alexa Skills` page.
- Find the skill you just created and click `Edit` in the `Actions` column.
- Click `ACCOUNT LINKING` in the left navigation bar of build page
- Click `ACCOUNT LINKING` in the left navigation bar of the build page
- Input all information required. Assuming your Home Assistant can be accessed by `https://[YOUR HOME ASSISTANT URL:PORT]`
- `Authorization URI`: `https://[YOUR HOME ASSISTANT URL]/auth/authorize`
- `Access Token URI`: `https://[YOUR HOME ASSISTANT URL]/auth/token`
@ -110,7 +111,7 @@ Alexa can link your Amazon account to your Home Assistant account. Therefore Hom
</p>
- Click `Save` button in the top right corner.
- Next, you will use the Alexa Mobile App or [Alexa web-based app](#alexa-web-based-app) to link your account.
- Next, you will use the Alexa Mobile App or [Alexa web-based app](http://alexa.amazon.com/) to link your account.
- Open the Alexa app, navigate to `Skills` -> `Your Skills` -> `Dev Skills`
- Click the Custom skill you just created.
- Click `Enable`.

View File

@ -3,6 +3,7 @@ title: Amazon Alexa
description: Instructions on how to connect Alexa/Amazon Echo to Home Assistant.
ha_category:
- Voice
ha_iot_class: Cloud Push
featured: true
ha_release: '0.10'
ha_codeowners:

View File

@ -3,6 +3,7 @@ title: Apprise
description: Instructions on how to add Apprise notifications to Home Assistant.
ha_category:
- Notifications
ha_iot_class: Cloud Push
ha_release: 0.101
ha_codeowners:
- '@caronc'

View File

@ -8,6 +8,7 @@ ha_release: 0.109
ha_domain: arris_tg2492lg
ha_codeowners:
- '@vanbalken'
ha_iot_class: Local Polling
---
This platform allows you to detect presence by looking at connected devices to an Arris TG2492LG router.

View File

@ -4,6 +4,7 @@ description: Instructions on how to integrate Aruba routers into Home Assistant.
ha_category:
- Presence Detection
ha_release: 0.7
ha_iot_class: Local Polling
ha_domain: aruba
---

View File

@ -3,6 +3,7 @@ title: Asterisk Call Detail Records
description: Instructions on how to integrate an Asterisk CDR within Home Assistant.
ha_category:
- Mailbox
ha_iot_class: Local Polling
ha_release: 0.79
ha_domain: asterisk_cdr
---

View File

@ -3,6 +3,7 @@ title: ATEN Rack PDU
description: Instructions on how to integrate ATEN Rack PDUs into Home Assistant.
ha_category:
- Switch
ha_iot_class: Local Polling
ha_release: 0.103
ha_codeowners:
- '@mtdcr'

View File

@ -3,6 +3,7 @@ title: Aurora
description: Know when auroras might be visible at your location
ha_category:
- Environment
ha_iot_class: Cloud Polling
ha_release: 0.39
ha_domain: aurora
---

View File

@ -7,6 +7,7 @@ ha_release: 0.7
ha_quality_scale: internal
ha_codeowners:
- '@home-assistant/core'
ha_iot_class: ~
ha_domain: automation
---
@ -14,7 +15,7 @@ Please see [Automating Home Assistant](/docs/automation/) for in-depth
documentation on how to use the automation integration.
<p class='img'>
<img src='{{site_root}}/images/screenshots/automation-switches.png' />
<img src='/images/screenshots/automation-switches.png' />
</p>
## Configuration

View File

@ -10,7 +10,7 @@ ha_codeowners:
ha_domain: avea
---
[Elgato Avea](https://www.elgato.com/en/news/elgato-avea-transform-your-home) is a Bluetooth light bulb that is no longer supported by the manufacturer. The `avea` integration allows you to control all your Avea bulbs with Home Assistant.
[Elgato Avea](https://www.evehome.com/en/news/elgato-avea-transform-your-home) is a Bluetooth light bulb that is no longer supported by the manufacturer. The `avea` integration allows you to control all your Avea bulbs with Home Assistant.
### Configuration

View File

@ -4,6 +4,7 @@ description: Setup for Azure Event Hub integration
ha_category:
- History
ha_release: 0.94
ha_iot_class: Cloud Push
ha_codeowners:
- '@eavanvalkenburg'
ha_domain: azure_event_hub

View File

@ -3,6 +3,7 @@ title: Baidu
description: Instructions on how to setup Baidu TTS with Home Assistant.
ha_category:
- Text-to-speech
ha_iot_class: Cloud Push
ha_release: 0.59
ha_domain: baidu
---

View File

@ -4,6 +4,7 @@ description: Instructions on how-to setup binary sensors with Home Assistant.
ha_category:
- Binary Sensor
ha_release: 0.9
ha_iot_class: ~
ha_quality_scale: internal
ha_domain: binary_sensor
---

View File

@ -47,10 +47,6 @@ sensors:
description: Name to use in the frontend.
required: false
type: string
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]
unique_id:
description: An ID that uniquely identifies this binary sensor. Set this to an unique value to allow customisation through the UI.
required: false
@ -280,8 +276,6 @@ binary_sensor:
- platform: template
sensors:
sun_up:
entity_id:
- sun.sun
value_template: >-
{{ is_state("sun.sun", "above_horizon") }}
icon_template: >-

View File

@ -26,7 +26,7 @@ Supported devices (see Requirements section below):
## Configuration
To use Bond controlled devices in your installation, add your Bond hub host and access token from the integrations page.
To use Bond controlled devices in your installation, add your Bond hub host and access token from the integrations page. Instructions for how to obtain an access token can be found on the [Bond Local API](http://docs-local.appbond.com/#section/Getting-Started/Get-Device-Information) documentation, which includes a section for how to obtain the [IP address of the device](http://docs-local.appbond.com/#section/Getting-Started/Finding-the-Bond-IP) which you will need to obtain the access token.
Menu: **Configuration** -> **Integrations**.

View File

@ -13,7 +13,7 @@ ha_config_flow: true
The `braviatv` platform allows you to control a [Sony Bravia TV](https://www.sony.com/).
Almost all [Sony Bravia TV 2013 and newer](https://info.tvsideview.sony.net/en_ww/home_device.html#bravia) are supported. A more generic method for older TVs connected to a Raspberry Pi with HDMI-CEC is explained further [below](#For-TVs-older-than-2013).
Almost all [Sony Bravia TV 2013 and newer](https://info.tvsideview.sony.net/en_ww/home_device.html#bravia) are supported. A more generic method for older TVs connected to a Raspberry Pi with HDMI-CEC is explained further [below](#for-tvs-older-than-2013).
## Configuration
@ -28,8 +28,8 @@ To ensure a clean re-configuration, please perform the following steps:
- Ensure that all braviatv entries in `configuration.yaml` have been removed and `bravia.conf` does not exist in your `.homeassistant` folder.
- Remove the entities you are reconfiguring from Home Assistant.
- Restart Home Assistant.
- Perform the [TV does not generate new pin](#TV-does-not-generate-new-pin) steps.
- Retry [configuration](###Setup-via-the-User-Interface).
- Perform the [TV does not generate new pin](#tv-does-not-generate-new-pin) steps.
- Retry [configuration](#configuration).
### TV does not generate new pin:

View File

@ -5,6 +5,7 @@ ha_category:
- Presence Detection
ha_release: 0.22
ha_domain: bt_home_hub_5
ha_iot_class: Local Polling
---
This platform offers presence detection by looking at connected devices to a [BT Home Hub 5](https://en.wikipedia.org/wiki/BT_Home_Hub) based router.

View File

@ -2,6 +2,7 @@
title: Calendar
description: Instructions on how to integrate calendars within Home Assistant.
ha_release: 0.33
ha_iot_class: ~
ha_domain: calendar
---

View File

@ -4,6 +4,7 @@ description: Instructions on how to integrate Cisco IOS routers into Home Assist
ha_category:
- Presence Detection
ha_release: 0.33
ha_iot_class: Local Polling
ha_codeowners:
- '@fbradyirl'
ha_domain: cisco_ios

View File

@ -4,6 +4,7 @@ description: Instructions on how to integrate Cisco Mobility Express wireless co
ha_category:
- Presence Detection
ha_release: '0.90'
ha_iot_class: Local Polling
ha_codeowners:
- '@fbradyirl'
ha_domain: cisco_mobility_express

View File

@ -4,6 +4,7 @@ description: Instructions on how to integrate data from the CityBikes API into H
ha_category:
- Transport
ha_release: 0.49
ha_iot_class: Cloud Polling
ha_domain: citybikes
---

View File

@ -5,6 +5,7 @@ ha_category:
- Notifications
ha_release: 0.48
ha_domain: clicksend
ha_iot_class: Cloud Push
---
The `clicksend` platform uses [ClickSend](https://clicksend.com) to deliver notifications from Home Assistant.

View File

@ -18,7 +18,7 @@ Available services: `climate.set_aux_heat`, `climate.set_preset_mode`, `climate.
<div class='note'>
Not all climate services may be available for your platform. Be sure to check the available services Home Assistant has enabled by checking <img src='/images/screenshots/developer-tool-services-icon.png' alt='service developer tool icon' class="no-shadow" height="38" /> **Services**.
Not all climate services may be available for your platform. You can check which climate services are available under **Developer Tools** -> **Services**.
</div>
@ -220,3 +220,14 @@ Turn climate device off. This is only supported if the climate device has the HV
| Service data attribute | Optional | Description |
| ---------------------- | -------- | ----------- |
| `entity_id` | yes | String or list of strings that define the entity ID(s) of climate device(s) to control. To target all climate devices, use `all`.
## Attributes
The climate entity has extra attributes to represent the state of the thermostat.
| Name | Description |
| ---- | ----------- |
| `hvac_action` | Current state: `heating` / `cooling` / `idle`.
| `fan` | If the fan is currently on or off: `on` / `off`.
It depends on the thermostat you are using which states are available.

View File

@ -4,6 +4,7 @@ description: Automatically update your Cloudflare DNS records.
ha_category:
- Network
ha_release: 0.74
ha_iot_class: Cloud Push
ha_codeowners:
- '@ludeeus'
ha_domain: cloudflare

View File

@ -36,4 +36,4 @@ display_currency_decimals:
default: 2
{% endconfiguration %}
All supported currencies can be found [here](https://coinmarketcap.com/api/documentation/v1/#section/Standards-and-Conventions), a list of currency IDs can be found [here](https://api.coinmarketcap.com/v2/ticker/).
All supported currencies can be found [here](https://coinmarketcap.com/api/documentation/v1/#section/Standards-and-Conventions), a list of currency IDs can be found [here](https://coinmarketcap.com/api/v1/#section/Standards-and-Conventions).

View File

@ -89,7 +89,7 @@ binary_sensor:
### Check RasPlex
Check if [RasPlex](https://www.rasplex.com/) is `online`.
Check if [RasPlex](https://github.com/RasPlex/RasPlex) is `online`.
```yaml
binary_sensor:

View File

@ -4,6 +4,7 @@ description: Instructions on how to setup the configuration panel for Home Assis
ha_category:
- Front End
ha_release: 0.39
ha_iot_class: ~
ha_quality_scale: internal
ha_codeowners:
- '@home-assistant/core'
@ -36,7 +37,7 @@ This section enables you to manage the name, location, and unit system of your H
This section enables you to control Home Assistant from within Home Assistant. Check your configuration, reload the core, groups, scripts, automations, and the Home Assistant process itself with a single mouse click.
<p class='img'>
<img src='{{site_root}}/images/screenshots/server-management.png' />
<img src='/images/screenshots/server-management.png' />
</p>
### Persons

View File

@ -4,6 +4,7 @@ description: Instructions on how to integrate the configurator in your component
ha_category:
- Other
ha_release: 0.7
ha_iot_class: ~
ha_quality_scale: internal
ha_codeowners:
- '@home-assistant/core'

View File

@ -4,6 +4,7 @@ description: Instructions on how to integrate counters into Home Assistant.
ha_category:
- Automation
ha_release: 0.53
ha_iot_class: Calculated
ha_quality_scale: internal
ha_codeowners:
- '@fabaff'

View File

@ -4,6 +4,7 @@ description: "Instructions on how to integrate RFLink Somfy RTS and KAKU ASUN-65
logo: rflink.png
ha_category:
- Cover
ha_iot_class: Assumed State
ha_release: 0.55
ha_domain: rflink
---

View File

@ -19,7 +19,7 @@ You will need to install the `python3-dev` or `python3-devel` package and the de
To set up the sensor the "Queue Name" of the printer is needed. The fastest way to get it, is to visit the CUPS web interface at "http://[IP ADDRESS PRINT SERVER]:631" and go to "Printers".
<p class='img'>
<img src='{{site_root}}/images/screenshots/cups-sensor.png' />
<img src='/images/screenshots/cups-sensor.png' />
</p>
## Configuration

View File

@ -16,7 +16,7 @@ The `darksky` platform uses the [Dark Sky](https://darksky.net/) web service as
<div class='note warning'>
On March 31, 2020 Dark Sky was [acquired by Apple](https://blog.darksky.net/dark-sky-has-a-new-home/) and is no longer allowing new API registrations. The Dark Sky API will continue to function for existing users through the end of 2021, but it is no longer possible to obtain an API key for new users.
On March 31, 2020 Dark Sky was [acquired by Apple](https://blog.darksky.net/dark-sky-has-a-new-home/) and is no longer allowing new API registrations. The Dark Sky API will continue to function for existing users through the end of 2021, but it is no longer possible to obtain an API key for new users. Home Assistant supports many alternative [weather integrations](/integrations/#weather).
</div>

View File

@ -12,13 +12,13 @@ The `datadog` integration sends all state changes to [Datadog](https://www.datad
Datadog allows you to analyze, monitor, cross-reference and alert upon your data. You can use it to detect statistical anomalies, see graphs across multiple sources in real-time, send critical alerts to Slack, etc.
<p class='img'>
<img src='{{site_root}}/images/screenshots/datadog-board-example.png' />
<img src='/images/screenshots/datadog-board-example.png' />
</p>
The integration also sends events from the logbook into Datadog, allowing you to correlate these events with your data.
<p class='img'>
<img src='{{site_root}}/images/screenshots/datadog-event-stream.png' />
<img src='/images/screenshots/datadog-event-stream.png' />
</p>
To use the `datadog` integration in your installation, add the following to your `configuration.yaml` file:

View File

@ -3,6 +3,7 @@ title: DD-WRT
description: Instructions on how to integrate DD-WRT based routers into Home Assistant.
ha_category:
- Presence Detection
ha_iot_class: Local Polling
ha_release: pre 0.7
ha_domain: ddwrt
---

View File

@ -8,7 +8,7 @@ ha_release: 0.7.2
ha_domain: denon
---
The `denon` platform allows you to control a [Denon Network Receivers](https://www.denon.co.uk/chg/product/compactsystems/networkmusicsystems/ceolpiccolo) from Home Assistant. It might be that your device is supported by the [Denon AVR] platform.
The `denon` platform allows you to control a [Denon Network Receiver](https://www.denon.com/category/homecinema/avreceiver) from Home Assistant. It might be that your device is supported by the [Denon AVR] platform.
Supported devices:

View File

@ -30,6 +30,7 @@ Known supported devices:
- Denon AVR-X3300W
- Denon AVR-X3400H
- Denon AVR-X3600H
- Denon AVR-X3700H
- Denon AVR-X4100W
- Denon AVR-X4300H
- Denon AVR-X4500H

View File

@ -4,6 +4,7 @@ description: Instructions on how to setup device tracking within Home Assistant.
ha_category:
- Presence Detection
ha_release: 0.7
ha_iot_class: ~
ha_quality_scale: internal
ha_domain: device_tracker
---

View File

@ -5,6 +5,7 @@ ha_category:
- Voice
ha_release: 0.56
ha_config_flow: true
ha_iot_class: Cloud Push
ha_domain: dialogflow
---

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