jeans/home-assistant.io
jeans/home-assistant.io
1
0
Fork 0
mirror of https://github.com/home-assistant/home-assistant.io.git synced 2025-07-15 05:16:49 +00:00
Code Issues Packages Projects Releases Wiki Activity

Merge branch 'current' into next

Browse Source
This commit is contained in:
Franck Nijhof 2024-05-14 13:53:40 +02:00
commit 98cff03f4b
No known key found for this signature in database
GPG Key ID: D62583BA8AB11CA3
424 changed files with 3235 additions and 1137 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

24
.github/workflows/add_prs_to_project.yml vendored
View File

@ -1,24 +0,0 @@
name: Add new PRs to project
on:
pull_request_target:
types:
- opened
jobs:
add-to-project:
name: Add new PR to project
runs-on: ubuntu-latest
steps:
- name: Generate app token
id: token
# Pinned to a specific version of the action for security reasons
uses: tibdex/github-app-token@3beb63f4bd073e61482598c45c71c1019b59b73a # v2.1.0
with:
app_id: ${{ secrets.PROJECTS_APP_ID }}
private_key: ${{ secrets.PROJECTS_APP_PEM }}
- name: Add to Project
uses: actions/add-to-project@v1.0.1
with:
project-url: https://github.com/orgs/home-assistant/projects/10
github-token: ${{ steps.token.outputs.token }}

4
.github/workflows/test.yml vendored
View File

@ -8,7 +8,7 @@ jobs:
runs-on: ubuntu-latest
steps:
- name: Check out files from GitHub
uses: actions/checkout@v4.1.4
uses: actions/checkout@v4.1.5
- name: Setting up Node.js
uses: actions/setup-node@v4.0.2
with:
@ -25,7 +25,7 @@ jobs:
runs-on: ubuntu-latest
steps:
- name: Check out files from GitHub
uses: actions/checkout@v4.1.4
uses: actions/checkout@v4.1.5
- name: Setting up Node.js
uses: actions/setup-node@v4.0.2
with:

4
Gemfile
View File

@ -10,7 +10,7 @@ group :development do
gem 'stringex', '2.8.6'
# > 2.1.0 causes slowdowns https://github.com/sass/sassc-ruby/issues/189
gem 'sassc', '2.1.0'
gem 'rubocop', '1.63.4'
gem 'rubocop', '1.63.5'
gem 'ruby-lsp', '0.16.6'
gem 'rackup', '2.1.0'
end
@ -23,7 +23,7 @@ group :jekyll_plugins do
end
gem 'sinatra', '4.0.0'
gem 'nokogiri', '1.16.4'
gem 'nokogiri', '1.16.5'
# Windows and JRuby does not include zoneinfo files, so bundle the tzinfo-data gem
# and associated library

18
Gemfile.lock
View File

@ -30,7 +30,7 @@ GEM
google-protobuf (4.26.1-x86_64-linux)
rake (>= 13)
http_parser.rb (0.8.0)
i18n (1.14.4)
i18n (1.14.5)
concurrent-ruby (~> 1.0)
jekyll (4.3.3)
addressable (~> 2.4)
@ -74,7 +74,7 @@ GEM
multi_json (1.15.0)
mustermann (3.0.0)
ruby2_keywords (~> 0.0.1)
nokogiri (1.16.4-x86_64-linux)
nokogiri (1.16.5-x86_64-linux)
racc (~> 1.4)
parallel (1.24.0)
parser (3.3.1.0)
@ -85,7 +85,7 @@ GEM
prism (0.27.0)
public_suffix (5.0.5)
racc (1.7.3)
rack (3.0.10)
rack (3.0.11)
rack-protection (4.0.0)
base64 (>= 0.1.0)
rack (>= 3.0.0, < 4)
@ -99,10 +99,10 @@ GEM
rb-fsevent (0.11.2)
rb-inotify (0.10.1)
ffi (~> 1.0)
regexp_parser (2.9.0)
regexp_parser (2.9.1)
rexml (3.2.6)
rouge (4.2.1)
rubocop (1.63.4)
rubocop (1.63.5)
json (~> 2.3)
language_server-protocol (>= 3.17.0)
parallel (~> 1.10)
@ -123,7 +123,7 @@ GEM
ruby2_keywords (0.0.5)
safe_yaml (1.0.5)
sass (3.4.25)
sass-embedded (1.76.0-x86_64-linux-gnu)
sass-embedded (1.77.1-x86_64-linux-gnu)
google-protobuf (>= 3.25, < 5.0)
sass-globbing (1.1.5)
sass (>= 3.1)
@ -135,7 +135,7 @@ GEM
rack-protection (= 4.0.0)
rack-session (>= 2.0.0, < 3)
tilt (~> 2.0)
sorbet-runtime (0.5.11367)
sorbet-runtime (0.5.11375)
stringex (2.8.6)
terminal-table (3.0.2)
unicode-display_width (>= 1.1.1, < 3)
@ -157,10 +157,10 @@ DEPENDENCIES
jekyll-paginate (= 1.1.0)
jekyll-sitemap (= 1.4.0)
jekyll-toc (= 0.18.0)
nokogiri (= 1.16.4)
nokogiri (= 1.16.5)
rackup (= 2.1.0)
rake (= 13.2.1)
rubocop (= 1.63.4)
rubocop (= 1.63.5)
ruby-lsp (= 0.16.6)
sass-globbing (= 1.1.5)
sassc (= 2.1.0)

4
_config.yml
View File

@ -110,8 +110,8 @@ social:
# Home Assistant release details
current_major_version: 2024
current_minor_version: 5
current_patch_version: 0
date_released: 2024-05-01
current_patch_version: 3
date_released: 2024-05-10
# Either # or the anchor link to latest release notes in the blog post.
# Must be prefixed with a # and have double quotes around it.

10
package-lock.json generated
View File

@ -23,7 +23,7 @@
"textlint": "^14.0.4",
"textlint-filter-rule-comments": "^1.2.2",
"textlint-rule-common-misspellings": "^1.0.1",
"textlint-rule-terminology": "^4.0.1"
"textlint-rule-terminology": "^5.0.0"
}
},
"node_modules/@aashutoshrathi/word-wrap": {
@ -6113,9 +6113,9 @@
}
},
"node_modules/textlint-rule-terminology": {
"version": "4.0.1",
"resolved": "https://registry.npmjs.org/textlint-rule-terminology/-/textlint-rule-terminology-4.0.1.tgz",
"integrity": "sha512-wKiVhc2B9HP2MFU4x7ZDx+oM5u43ETpKWTLHKvdhPRZ0+davi4M8mFmkZVovDIMO7igsGjixikcvFmnCMg3kmQ==",
"version": "5.0.0",
"resolved": "https://registry.npmjs.org/textlint-rule-terminology/-/textlint-rule-terminology-5.0.0.tgz",
"integrity": "sha512-z9RFKWTkt5m0fkEFwOYHq9QaMDsLc2dnNTZ5NybfW5oyp1iITPZOepV8EQYnrQJmPVgZflIpioUqzkDb0tUB8w==",
"dev": true,
"dependencies": {
"lodash": "^4.17.15",
@ -6123,7 +6123,7 @@
"textlint-rule-helper": "^2.1.1"
},
"engines": {
"node": ">=18"
"node": ">=20"
}
},
"node_modules/textlint-rule-terminology/node_modules/textlint-rule-helper": {

2
package.json
View File

@ -18,7 +18,7 @@
"textlint": "^14.0.4",
"textlint-filter-rule-comments": "^1.2.2",
"textlint-rule-common-misspellings": "^1.0.1",
"textlint-rule-terminology": "^4.0.1"
"textlint-rule-terminology": "^5.0.0"
},
"resolutions": {
"minimist": ">=1.2.5"

2
plugins/terminology_tooltip.rb
View File

@ -34,7 +34,7 @@ module Jekyll
if glossary.key?("link")
rendered_link = Liquid::Template.parse(glossary["link"]).render(context).strip
link = "<br><a class='terminology-link' href='#{rendered_link}' target='_blank'>[Learn more]</a>"
link = "<small><a class='terminology-link' href='#{rendered_link}' target='_blank'>[Learn more]</a></small>"
end
tooltip = "<span class='terminology-tooltip'>#{definition}#{link || ""}</span>"

3
sass/custom/_terminology_tooltip.scss
View File

@ -66,4 +66,7 @@
}
}
}
code {
border-bottom: 2px dotted $primary-color;
}
}

7
source/_data/glossary.yml
View File

@ -140,6 +140,13 @@
link: /docs/scripts/conditions/
aliases:
- conditions
- term: Configuration file
aliases:
- configuration.yaml
- "`configuration.yaml`"
definition: >-
The configuration.yaml file is the main configuration file for Home Assistant. It lists the integrations to be loaded and their specific configurations. In some cases, the configuration needs to be edited manually directly in the configuration.yaml file. Most integrations can be configured in the UI.
link: /docs/configuration/
- term: Cover
definition: >-
Covers are devices such as blinds, garage doors, etc that can be opened and

1
source/_includes/asides/about.html
View File

@ -8,6 +8,7 @@
<li><a href='https://demo.home-assistant.io'>Try the online demo</a></li>
<li><a href='https://building.open-home.io/#/portal'>Join our newsletter</a></li>
<li><a href="https://twitter.com/Home_Assistant">Follow Home Assistant on X</a></li>
<li><a href="https://www.openhomefoundation.org/">Home Assistant is part of the Open Home Foundation</a></li>
{% comment %}
<li>
Subscribe to the Home Assistant Newsletter

2
source/_includes/common-tasks/filters.md
View File

@ -32,4 +32,4 @@ Filters are applied as follows:
The following characters can be used in entity globs:
`*` - The asterisk represents zero, one, or multiple characters
`?` - The question mark represents a single character
`?` - The question mark represents zero or one character

2
source/_includes/common-tasks/flashing_n2_otg.md
View File

@ -72,7 +72,7 @@ This will configure the ODROID-N2+ and OTG to act as a memory card reader:
- Make sure to toggle the boot mode switch back to MMC.
4. Put the ODROID back in its case.
5. Connect your ODROID-N2+ to your network with an Ethernet cable and plug in power.
5. Connect your ODROID-N2+ to your network with an Ethernet cable, make sure there is internet access, and plug in power.
6. If your router supports mDNS, you can reach your installation at `http://homeassistant.local:8123`.
- If your network doesn’t support mDNS, you’ll have to use the IP address of your ODROID-N2+ instead of `homeassistant.local`. For example, `http://192.168.0.9:8123`.

6
source/_includes/installation/operating_system.md
View File

@ -227,7 +227,8 @@ Use this method only if Method 1 does not work for you.
- If you used method 2 for the installation, install the boot medium into your x86-64 hardware.
1. Plug in an Ethernet cable that is connected to the network.
1. Plug in an Ethernet cable that is connected to the network and to the internet.
- Note: Internet is required because the newly installed Home Assistant OS does not contain all Home Assistant components yet. It downloads the latest version of Home Assistant Core on first start.
2. Power the system on. If you have a screen connected to the {{site.installation.types[page.installation_type].board}} system, after a minute or so the Home Assistant welcome banner will appear in the console.
<div class="note">
@ -254,7 +255,8 @@ Or else, the BIOS might provide you with a tool to add boot options, there you c
{% else %}
1. Insert the boot medium ({{ site.installation.types[page.installation_type].installation_media }}) you just created.
2. Plug in an Ethernet cable that is connected to the network and power the system on.
2. Plug in an Ethernet cable that is connected to the network and to the internet and power the system on.
- Note: Internet is required because the newly installed Home Assistant OS does not contain all Home Assistant components yet. It downloads the latest version of Home Assistant Core on first start.
{% endif %}

1
source/_includes/integrations/restart_ha_after_config_inclusion.md Normal file
View File

@ -0,0 +1 @@
After changing the {% term "`configuration.yaml`" %} file, [restart Home Assistant](/docs/configuration/#reloading-the-configuration-to-apply-changes) to apply the changes. {% if page.ha_platforms %} {% if page.ha_quality_scale != "internal" or page.ha_domain contains 'generic' %} To view the changes, go to {% my entities title="**Settings** > **Devices & services** > **Entities**" %}. {% endif %}{% endif %}

1
source/_includes/site/footer.html
View File

@ -76,6 +76,7 @@
<li>
<a href="https://status.home-assistant.io">System Status</a>
</li>
<li><a href="https://www.openhomefoundation.org/">Home Assistant is part of the Open Home Foundation</a></li>
</ul>
</div>

6
source/_integrations/acer_projector.markdown
View File

@ -9,13 +9,17 @@ ha_domain: acer_projector
ha_platforms:
- switch
ha_integration_type: integration
related:
- docs: /docs/configuration/
title: Configuration file
---
The `acer_projector` switch platform allows you to control the state of RS232 connected projectors from [Acer](https://www.acer.com/).
## Configuration
To use your Acer Projector in your installation, add the following to your `configuration.yaml` file:
To use your Acer Projector in your installation, add the following to your {% term "`configuration.yaml`" %} file.
{% include integrations/restart_ha_after_config_inclusion.md %}
```yaml
# Example configuration.yaml entry

6
source/_integrations/actiontec.markdown
View File

@ -9,6 +9,9 @@ ha_domain: actiontec
ha_platforms:
- device_tracker
ha_integration_type: integration
related:
- docs: /docs/configuration/
title: Configuration file
---
The **Actiontec** {% term integration %} allows you to detect presence by looking at devices connected to an [Actiontec](https://www.actiontec.com/) device.
@ -21,7 +24,8 @@ Supported devices (tested):
This device tracker needs telnet to be enabled on the router.
</div>
To use this device tracker in your installation, add the following to your `configuration.yaml` file:
To use this device tracker in your installation, add the following to your {% term "`configuration.yaml`" %} file.
{% include integrations/restart_ha_after_config_inclusion.md %}
```yaml
# Example configuration.yaml entry

16
source/_integrations/ads.markdown
View File

@ -18,6 +18,9 @@ ha_platforms:
- sensor
- switch
ha_integration_type: integration
related:
- docs: /docs/configuration/
title: Configuration file
---
The ADS (automation device specification) describes a device-independent and fieldbus independent interface for communication between [Beckhoff](https://www.beckhoff.com/) automation devices running [TwinCAT](https://www.beckhoff.com/en-en/products/automation/twincat/) and other devices implementing this interface.
@ -32,7 +35,8 @@ There is currently support for the following device types within Home Assistant:
## Configuration
To enable ADS, add the following lines to your `configuration.yaml` file:
To enable ADS, add the following lines to your {% term "`configuration.yaml`" %} file.
{% include integrations/restart_ha_after_config_inclusion.md %}
```yaml
# Example configuration.yaml entry
@ -78,7 +82,7 @@ Service parameters:
The `ads` binary sensor platform can be used to monitor a boolean value on your ADS device.
To use your ADS device, you first have to set up your [ADS hub](#configuration) and then add the following to your `configuration.yaml`
To use your ADS device, you first have to set up your [ADS hub](#configuration) and then add the following to your {% term "`configuration.yaml`" %}
file:
```yaml
@ -107,7 +111,7 @@ device_class:
The `ads` light platform allows you to control your connected ADS lights.
To use your ADS device, you first have to set up your [ADS hub](#configuration) and then add the following to your `configuration.yaml`
To use your ADS device, you first have to set up your [ADS hub](#configuration) and then add the following to your {% term "`configuration.yaml`" %}
file:
```yaml
@ -137,7 +141,7 @@ name:
The `ads` sensor platform allows reading the value of a numeric variable on your ADS device. The variable can be of type *INT*, *UINT*, *BYTE*, *DINT* or *UDINT*.
To use your ADS device, you first have to set up your [ADS hub](#configuration) and then add the following to your `configuration.yaml`
To use your ADS device, you first have to set up your [ADS hub](#configuration) and then add the following to your {% term "`configuration.yaml`" %}
file:
```yaml
@ -176,7 +180,7 @@ The *factor* can be used to implement fixed decimals. E.g., set *factor* to 100
The `ads` switch platform accesses a boolean variable on the connected ADS device. The variable is identified by its name.
To use your ADS device, you first have to set up your [ADS hub](#configuration) and then add the following to your `configuration.yaml`
To use your ADS device, you first have to set up your [ADS hub](#configuration) and then add the following to your {% term "`configuration.yaml`" %}
file:
```yaml
@ -201,7 +205,7 @@ name:
The `ads` cover platform allows you to control your connected ADS covers.
To use your ADS device, you first have to set up your [ADS hub](#configuration) and then add the following to your `configuration.yaml`
To use your ADS device, you first have to set up your [ADS hub](#configuration) and then add the following to your {% term "`configuration.yaml`" %}
file:
```yaml

10
source/_integrations/alarm_control_panel.ifttt.markdown
View File

@ -5,11 +5,14 @@ ha_category:
- Alarm
ha_release: 0.66
ha_domain: ifttt
related:
- docs: /docs/configuration/
title: Configuration file
---
The `ifttt` platform allows you to integrate security systems that have no open API but can be controlled through [IFTTT](https://ifttt.com/explore).
The `ifttt` {% term integration %} allows you to integrate security systems that have no open API but can be controlled through [IFTTT](https://ifttt.com/explore).
This platform depends on the [IFTTT](/integrations/ifttt/) Home Assistant integration. See the integrations documentation to set it up.
This {% term integration %} depends on the [IFTTT](/integrations/ifttt/) Home Assistant integration. See the integrations documentation to set it up.
<div class='note'>
It is important to note that this platform fully relies on IFTTT to receive updates when the security system's state changes. Therefore, this platform shows an assumed state.
@ -17,7 +20,8 @@ It is important to note that this platform fully relies on IFTTT to receive upda
## Configuration
To enable this, add the following lines to your `configuration.yaml` file:
To enable this, add the following lines to your {% term "`configuration.yaml`" %} file.
{% include integrations/restart_ha_after_config_inclusion.md %}
```yaml
# Example configuration.yaml entry

12
source/_integrations/alarm_control_panel.mqtt.markdown
View File

@ -6,11 +6,14 @@ ha_category:
ha_release: 0.7.4
ha_iot_class: Configurable
ha_domain: mqtt
related:
- docs: /docs/configuration/
title: Configuration file
---
The `mqtt` alarm panel platform enables the possibility to control MQTT capable alarm panels. The Alarm icon will change state after receiving a new state from `state_topic`. If these messages are published with *RETAIN* flag, the MQTT alarm panel will receive an instant state update after subscription and will start with the correct state. Otherwise, the initial state will be `unknown`.
The `mqtt` alarm panel {% term integration %} enables the possibility to control MQTT capable alarm panels. The Alarm icon will change state after receiving a new state from `state_topic`. If these messages are published with *RETAIN* flag, the MQTT alarm panel will receive an instant state update after subscription and will start with the correct state. Otherwise, the initial state will be `unknown`.
The integration will accept the following states from your Alarm Panel (in lower case):
The {% term integration %} will accept the following states from your Alarm Panel (in lower case):
- `disarmed`
- `armed_home`
@ -23,11 +26,12 @@ The integration will accept the following states from your Alarm Panel (in lower
- `arming`
- `disarming`
The integration can control your Alarm Panel by publishing to the `command_topic` when a user interacts with the Home Assistant frontend.
The {% term integration %} can control your Alarm Panel by publishing to the `command_topic` when a user interacts with the Home Assistant frontend.
## Configuration
To enable this platform, add the following lines to your `configuration.yaml`:
To enable this {% term integration %}, add the following lines to your {% term "`configuration.yaml`" %} file.
{% include integrations/restart_ha_after_config_inclusion.md %}
```yaml
# Example configuration.yaml entry

10
source/_integrations/alarm_control_panel.template.markdown
View File

@ -7,11 +7,14 @@ ha_release: 0.105
ha_iot_class: "Local Push"
ha_qa_scale: internal
ha_domain: template
related:
- docs: /docs/configuration/
title: Configuration file
---
The `template` integrations creates alarm control panels that combine integrations or adds preprocessing logic to actions.
The `template` {% term integration %} creates alarm control panels that combine integrations or adds preprocessing logic to actions.
There are several powerful ways to use this integration, including grouping existing integrations into a simpler integrations, or adding logic that Home Assistant will execute when accessed.
There are several powerful ways to use this {% term integration %}, including grouping existing integrations into a simpler integrations, or adding logic that Home Assistant will execute when accessed.
For example, if you want to expose a true alarm panel to Google Home, Alexa, or HomeKit - but limit its ability to disarm when there's no one home, you can do that using a template.
@ -23,7 +26,8 @@ In optimistic mode, the alarm control panel will immediately change state after
## Configuration
To enable a template alarm control panel in your installation, add the following to your `configuration.yaml` file:
To enable a template alarm control panel in your installation, add the following to your {% term "`configuration.yaml`" %} file.
{% include integrations/restart_ha_after_config_inclusion.md %}
{% raw %}

16
source/_integrations/alert.markdown
View File

@ -11,6 +11,9 @@ ha_codeowners:
- '@home-assistant/core'
- '@frenck'
ha_integration_type: integration
related:
- docs: /docs/configuration/
title: Configuration file
---
The `alert` integration is designed to notify you when problematic issues arise.
@ -23,17 +26,18 @@ Alerts will add an entity to the front end.
This entity allows you to silence an alert until it is resolved and has three
possible states:
State | Description
-|-
`idle` | The condition for the alert is false.
`on` | The condition for the alert is true.
`off` | The condition for the alert is true but it was acknowledged.
| State | Description |
| ------ | ------------------------------------------------------------ |
| `idle` | The condition for the alert is false. |
| `on` | The condition for the alert is true. |
| `off` | The condition for the alert is true but it was acknowledged. |
### Basic example
The `alert` integration makes use of any of the `notification` integrations. To
setup the `alert` integration, first, you must set up a [notification integration](/integrations/notify).
Then, add the following to your configuration file:
Then, add the following to your {% term "`configuration.yaml`" %} file.
{% include integrations/restart_ha_after_config_inclusion.md %}
```yaml
# Example configuration.yaml entry

2
source/_integrations/alexa.flash_briefings.markdown
View File

@ -19,7 +19,7 @@ Additionally, note that at the time of this writing, your Alexa skill endpoint *
1. In your router, forward external 443 to your Home Assistant serving port (defaults to 8123)
OR
2. Change your Home Assistant serving port to 443 this is done in the [`http`](/integrations/http/) section with the `server_port` entry in your `configuration.yaml` file
2. Change your Home Assistant serving port to 443 this is done in the [`http`](/integrations/http/) section with the `server_port` entry in your {% term "`configuration.yaml`" %} file
[blog-lets-encrypt]: /blog/2015/12/13/setup-encryption-using-lets-encrypt/

6
source/_integrations/alexa.intent.markdown
View File

@ -5,6 +5,9 @@ ha_category:
- Voice
ha_release: "0.10"
ha_domain: alexa
related:
- docs: /docs/configuration/
title: Configuration file
---
## I want to build custom commands to use with Echo
@ -159,7 +162,8 @@ This means that we can now ask Alexa things like:
When activated, the Alexa integration will have Home Assistant's native intent support handle the incoming intents. If you want to run actions based on intents, use the [`intent_script`](/integrations/intent_script) integration.
To enable Alexa, add the following entry to your `configuration.yaml` file:
To enable Alexa, add the following entry to your {% term "`configuration.yaml`" %} file.
{% include integrations/restart_ha_after_config_inclusion.md %}
```yaml
alexa:

6
source/_integrations/alexa.smart_home.markdown
View File

@ -178,7 +178,7 @@ Next you need create a Lambda function.
### Test the Lambda Function
Now, you have created the Lambda function, but before you can test it, you have to set up the necessary aspects of your Home Assistant configuration. Put the following minimal configuration into your `configuration.yaml` file. It will expose all of your supported devices and automations to Alexa. It is strongly recommended to check the [configuration section](#alexa-smart-home-integration-configuration) and setup control of which devices and entities are exposed.
Now, you have created the Lambda function, but before you can test it, you have to set up the necessary aspects of your Home Assistant configuration. Put the following minimal configuration into your {% term "`configuration.yaml`" %} file. It will expose all of your supported devices and automations to Alexa. It is strongly recommended to check the [configuration section](#alexa-smart-home-integration-configuration) and setup control of which devices and entities are exposed.
```yaml
alexa:
@ -870,7 +870,7 @@ Adjust lights that support color temperature using the following friendly names:
The following table lists the possible friendly name synonyms available to lights that support color temperature.
| Color Temperature in Kelvin | Friendly Name Synonyms |
| -----| ---------------------------------------------- |
| --------------------------- | -------------------------------- |
| 2200 | _"warm"_, _"warm white"_ |
| 2700 | _"incandescent"_, _"soft white"_ |
| 4000 | _"white"_ |
@ -1090,7 +1090,7 @@ Disable and re-enable the skill using the Alexa App; then restart Home Assistant
## Debugging
The Alexa integration will log additional information about state updates and other messages when the log level is set to `debug`. Add the relevant line below to the `configuration.yaml`:
The Alexa integration will log additional information about state updates and other messages when the log level is set to `debug`. Add the relevant line below to the {% term "`configuration.yaml`" %}:
If using Alexa with an Alexa Smart Home Skill and Lambda function such as haaska:

6
source/_integrations/alpha_vantage.markdown
View File

@ -9,11 +9,15 @@ ha_domain: alpha_vantage
ha_platforms:
- sensor
ha_integration_type: integration
related:
- docs: /docs/configuration/
title: Configuration file
---
The `alpha_vantage` sensor platform uses [Alpha Vantage](https://www.alphavantage.co) to monitor the stock market. This platform also provides detail about exchange rates.
To enable the `alpha_vantage` platform, add the following lines to your `configuration.yaml` file:
To enable the `alpha_vantage` platform, add the following lines to your {% term "`configuration.yaml`" %} file.
{% include integrations/restart_ha_after_config_inclusion.md %}
```yaml
# Example configuration.yaml entry

6
source/_integrations/amazon_polly.markdown
View File

@ -9,6 +9,9 @@ ha_iot_class: Cloud Push
ha_platforms:
- tts
ha_integration_type: integration
related:
- docs: /docs/configuration/
title: Configuration file
---
The `amazon_polly` text-to-speech platform that works with [Amazon Polly](https://aws.amazon.com/polly/) to create the spoken output.
@ -22,7 +25,8 @@ Available voices are listed in the [Amazon Documentation](https://docs.aws.amazo
## Configuration
To get started, add the following lines to your `configuration.yaml` (example for Amazon Polly):
To get started, add the following lines to your {% term "`configuration.yaml`" %} file (example for Amazon Polly).
{% include integrations/restart_ha_after_config_inclusion.md %}
```yaml
# Example configuration.yaml entry

56
source/_integrations/amcrest.markdown
View File

@ -17,6 +17,9 @@ ha_platforms:
ha_codeowners:
- '@flacjacket'
ha_integration_type: integration
related:
- docs: /docs/configuration/
title: Configuration file
---
The `amcrest` camera platform allows you to integrate your [Amcrest](https://amcrest.com/) or Dahua IP camera or doorbell in Home Assistant.
@ -29,7 +32,8 @@ There is currently support for the following {% term device %} types within Home
## Configuration
To enable your camera in your installation, add the following to your `configuration.yaml` file:
To enable your camera in your installation, add the following to your {% term "`configuration.yaml`" %} file.
{% include integrations/restart_ha_after_config_inclusion.md %}
```yaml
# Example configuration.yaml entry
@ -204,61 +208,61 @@ Available {% term services %}:
These {% term services %} enable or disable the camera's audio stream.
Service data attribute | Optional | Description
-|-|-
`entity_id` | no | The entity ID of the camera to control. May be a list of multiple entity IDs. To target all cameras, set entity ID to `all`.
| Service data attribute | Optional | Description |
| ---------------------- | -------- | ---------------------------------------------------------------------------------------------------------------------------- |
| `entity_id` | no | The entity ID of the camera to control. May be a list of multiple entity IDs. To target all cameras, set entity ID to `all`. |
### Service `enable_motion_recording`/`disable_motion_recording`
These {% term services %} enable or disable the camera to record a clip to its configured storage location when motion is detected.
Service data attribute | Optional | Description
-|-|-
`entity_id` | no | The entity ID of the camera to control. May be a list of multiple entity IDs. To target all cameras, set entity ID to `all`.
| Service data attribute | Optional | Description |
| ---------------------- | -------- | ---------------------------------------------------------------------------------------------------------------------------- |
| `entity_id` | no | The entity ID of the camera to control. May be a list of multiple entity IDs. To target all cameras, set entity ID to `all`. |
### Service `enable_recording`/`disable_recording`
These services enable or disable the camera to continuously record to its configured storage location.
Service data attribute | Optional | Description
-|-|-
`entity_id` | no | The entity ID of the camera to control. May be a list of multiple entity IDs. To target all cameras, set entity ID to `all`.
| Service data attribute | Optional | Description |
| ---------------------- | -------- | ---------------------------------------------------------------------------------------------------------------------------- |
| `entity_id` | no | The entity ID of the camera to control. May be a list of multiple entity IDs. To target all cameras, set entity ID to `all`. |
### Service `goto_preset`
This service will cause the camera to move to one of the <abbr title="pan, tilt, and zoom">PTZ</abbr> locations configured within the camera.
Service data attribute | Optional | Description
-|-|-
`entity_id` | no | The entity ID of the camera to control. May be a list of multiple entity IDs. To target all cameras, set entity ID to `all`.
`preset` | no | Preset number, starting from 1.
| Service data attribute | Optional | Description |
| ---------------------- | -------- | ---------------------------------------------------------------------------------------------------------------------------- |
| `entity_id` | no | The entity ID of the camera to control. May be a list of multiple entity IDs. To target all cameras, set entity ID to `all`. |
| `preset` | no | Preset number, starting from 1. |
### Service `set_color_bw`
This service will set the color mode of the camera.
Service data attribute | Optional | Description
-|-|-
`entity_id` | no | The entity ID of the camera to control. May be a list of multiple entity IDs. To target all cameras, set entity ID to `all`.
`color_bw` | no | One of `auto`, `bw` or `color`.
| Service data attribute | Optional | Description |
| ---------------------- | -------- | ---------------------------------------------------------------------------------------------------------------------------- |
| `entity_id` | no | The entity ID of the camera to control. May be a list of multiple entity IDs. To target all cameras, set entity ID to `all`. |
| `color_bw` | no | One of `auto`, `bw` or `color`. |
### Service `start_tour`/`stop_tour`
These services start or stop the camera's <abbr title="pan, tilt, and zoom">PTZ</abbr> tour function.
Service data attribute | Optional | Description
-|-|-
`entity_id` | no | The entity ID of the camera to control. May be a list of multiple entity IDs. To target all cameras, set entity ID to `all`.
| Service data attribute | Optional | Description |
| ---------------------- | -------- | ---------------------------------------------------------------------------------------------------------------------------- |
| `entity_id` | no | The entity ID of the camera to control. May be a list of multiple entity IDs. To target all cameras, set entity ID to `all`. |
### Service `ptz_control`
If your Amcrest or Dahua camera supports <abbr title="pan, tilt, and zoom">PTZ</abbr>, you will be able to pan, tilt or zoom your camera.
Service data attribute | Optional | Description
-|-|-
`entity_id` | no| The entity ID of the camera to control. May be a list of multiple entity IDs. To target all cameras, set entity ID to `all`.
`movement` | no | Direction of the movement. Allowed values: `zoom_in`, `zoom_out`, `up`, `down`, `left`, `right`, `right_up`, `right_down`, `left_up`, `left_down`
`travel_time` | yes |Travel time in fractional seconds. Allowed values: `0` to `1`. Default: `0.2`.
| Service data attribute | Optional | Description |
| ---------------------- | -------- | -------------------------------------------------------------------------------------------------------------------------------------------------- |
| `entity_id` | no | The entity ID of the camera to control. May be a list of multiple entity IDs. To target all cameras, set entity ID to `all`. |
| `movement` | no | Direction of the movement. Allowed values: `zoom_in`, `zoom_out`, `up`, `down`, `left`, `right`, `right_up`, `right_down`, `left_up`, `left_down` |
| `travel_time` | yes | Travel time in fractional seconds. Allowed values: `0` to `1`. Default: `0.2`. |
## Notes

6
source/_integrations/ampio.markdown
View File

@ -10,6 +10,9 @@ ha_domain: ampio
ha_platforms:
- air_quality
ha_integration_type: integration
related:
- docs: /docs/configuration/
title: Configuration file
---
The `ampio` air quality platform will query the open data API of [ampio.pl](http://smog.ampio.pl/) to monitor air quality sensor station.
@ -20,7 +23,8 @@ To get the ID of a station you need to contact Ampio directly.
## Manual configuration
To enable this platform, add the following lines to your `configuration.yaml` file:
To enable this platform, add the following lines to your {% term "`configuration.yaml`" %} file.
{% include integrations/restart_ha_after_config_inclusion.md %}
```yaml
# Example configuration.yaml entry

6
source/_integrations/anel_pwrctrl.markdown
View File

@ -9,6 +9,9 @@ ha_domain: anel_pwrctrl
ha_platforms:
- switch
ha_integration_type: integration
related:
- docs: /docs/configuration/
title: Configuration file
---
The `anel_pwrctrl` switch platform allows you to control [ANEL PwrCtrl](https://en.anel.eu/index.htm?src=/produkte/produkte.htm) devices on firmware 6.x and older. [ANEL PwrCtrl](https://en.anel.eu/index.htm?src=/produkte/produkte.htm) devices on firmware 7.x are not supported.
@ -19,7 +22,8 @@ Supported devices (tested):
- PwrCtrl Advanced
- PwrCtrl Advanced Power
To add this platform to your installation, add the following to your `configuration.yaml` file:
To add this platform to your installation, add the following to your {% term "`configuration.yaml`" %} file.
{% include integrations/restart_ha_after_config_inclusion.md %}
```yaml
# Example configuration.yaml entry

6
source/_integrations/apprise.markdown
View File

@ -11,13 +11,17 @@ ha_domain: apprise
ha_platforms:
- notify
ha_integration_type: integration
related:
- docs: /docs/configuration/
title: Configuration file
---
The [Apprise service](https://github.com/caronc/apprise/) is an all-in-one solution to open up Home Assistant to _just about_ every Notification platform (such as Amazon SNS, Discord, Telegram, Slack, MSTeams, Twilio, etc.)
## Configuration
To use Apprise supported notifications, add the following to your `configuration.yaml` file:
To use Apprise supported notifications, add the following to your {% term "`configuration.yaml`" %} file.
{% include integrations/restart_ha_after_config_inclusion.md %}
```yaml
# Example configuration.yaml entry using URLs

6
source/_integrations/aprs.markdown
View File

@ -11,13 +11,17 @@ ha_domain: aprs
ha_platforms:
- device_tracker
ha_integration_type: integration
related:
- docs: /docs/configuration/
title: Configuration file
---
The `aprs` [(Automatic Packet Reporting System)](https://en.wikipedia.org/wiki/Automatic_Packet_Reporting_System) device tracker integration connects to the [APRS-IS](http://aprs-is.net/) network for tracking amateur radio devices.
## Configuration
To enable APRS tracking in Home Assistant, add the following section to `configuration.yaml`:
To enable APRS tracking in Home Assistant, add the following section to {% term "`configuration.yaml`" %} file.
{% include integrations/restart_ha_after_config_inclusion.md %}
```yaml
# Example configuration.yaml entry

10
source/_integrations/aqualogic.markdown
View File

@ -12,6 +12,9 @@ ha_platforms:
- sensor
- switch
ha_integration_type: integration
related:
- docs: /docs/configuration/
title: Configuration file
---
The AquaLogic integration provides connectivity to a Hayward/Goldline AquaLogic/ProLogic pool controller. Note that an RS-485 to Ethernet adapter connected to the pool controller is required.
@ -23,7 +26,8 @@ There is currently support for the following device types within Home Assistant:
## Configuration
To add the AquaLogic integration to your installation, add the following to your `configuration.yaml` file:
To add the AquaLogic integration to your installation, add the following to your {% term "`configuration.yaml`" %} file.
{% include integrations/restart_ha_after_config_inclusion.md %}
```yaml
# Example configuration.yaml entry
@ -45,7 +49,7 @@ port:
## Sensor
Once you have enabled the AquaLogic integration, add the following to your `configuration.yaml` file:
Once you have enabled the AquaLogic integration, add the following to your {% term "`configuration.yaml`" %} file:
```yaml
# Example configuration.yaml entry
@ -84,7 +88,7 @@ monitored_conditions:
## Switch
Once you have enabled the AquaLogic integration, add the following to your `configuration.yaml` file:
Once you have enabled the AquaLogic integration, add the following to your {% term "`configuration.yaml`" %} file:
```yaml
# Example configuration.yaml entry

6
source/_integrations/aquostv.markdown
View File

@ -9,6 +9,9 @@ ha_domain: aquostv
ha_platforms:
- media_player
ha_integration_type: integration
related:
- docs: /docs/configuration/
title: Configuration file
---
The `aquostv` platform allows you to control a [Sharp Aquos TV](https://global.sharp/aquos/index.html).
@ -17,7 +20,8 @@ When the TV is first connected, you will need to accept Home Assistant on the TV
## Configuration
To add a TV to your installation, add the following to your `configuration.yaml` file:
To add a TV to your installation, add the following to your {% term "`configuration.yaml`" %} file.
{% include integrations/restart_ha_after_config_inclusion.md %}
```yaml
# Example configuration.yaml entry

12
source/_integrations/arest.markdown
View File

@ -14,6 +14,9 @@ ha_platforms:
- sensor
- switch
ha_integration_type: integration
related:
- docs: /docs/configuration/
title: Configuration file
---
There is currently support for the following device types within Home Assistant:
@ -26,7 +29,8 @@ There is currently support for the following device types within Home Assistant:
The `arest` binary sensor platform allows you to get all data from your devices (like Arduinos with an ethernet/Wi-Fi connection, the ESP8266, and the Raspberry Pi) running the [aREST](https://arest.io/) RESTful framework.
To use your aREST binary sensor in your installation, add the following to your `configuration.yaml` file:
To use your aREST binary sensor in your installation, add the following to your {% term "`configuration.yaml`" %} file.
{% include integrations/restart_ha_after_config_inclusion.md %}
```yaml
# Example configuration.yaml entry
@ -77,7 +81,7 @@ This sensor is not suitable for fast state changes because there is a high possi
The `arest` sensor platform allows you to get all data from your devices (like Arduinos with a Ethernet/Wi-Fi connection, the ESP8266, and the Raspberry Pi) running the [aREST](https://arest.io/) RESTful framework.
To use your aREST enabled device in your installation, add the following to your `configuration.yaml` file:
To use your aREST enabled device in your installation, add the following to your {% term "`configuration.yaml`" %} file:
```yaml
# Example configuration.yaml entry
@ -180,7 +184,7 @@ The root will give you a JSON response that contains all variables and their cur
The `arest` switch platform allows you to toggle pins of your devices (like Arduino boards with an Ethernet/Wi-Fi connection, ESP8266 based devices, and the Raspberry Pi) running the [aREST](https://arest.io/) RESTful framework.
To use your aREST enabled device with pins in your installation, add the following to your `configuration.yaml` file:
To use your aREST enabled device with pins in your installation, add the following to your {% term "`configuration.yaml`" %} file:
```yaml
# Example configuration.yaml entry
@ -195,7 +199,7 @@ switch:
invert: true
```
If you want to use custom functions, then add the following to your `configuration.yaml` file:
If you want to use custom functions, then add the following to your {% term "`configuration.yaml`" %} file:
```yaml
# Example configuration.yaml entry

6
source/_integrations/arris_tg2492lg.markdown
View File

@ -11,6 +11,9 @@ ha_iot_class: Local Polling
ha_platforms:
- device_tracker
ha_integration_type: hub
related:
- docs: /docs/configuration/
title: Configuration file
---
This platform allows you to detect presence by looking at connected devices to an Arris TG2492LG router.
@ -24,7 +27,8 @@ This is one of the routers provided by:
The router prevents the admin user from logging in twice. This can cause problems with accessing the router's configuration pages while this platform is active.
</div>
To use this device tracker in your installation, add the following to your `configuration.yaml` file:
To use this device tracker in your installation, add the following to your {% term "`configuration.yaml`" %} file.
{% include integrations/restart_ha_after_config_inclusion.md %}
```yaml
# Example configuration.yaml entry

6
source/_integrations/aruba.markdown
View File

@ -9,6 +9,9 @@ ha_domain: aruba
ha_platforms:
- device_tracker
ha_integration_type: integration
related:
- docs: /docs/configuration/
title: Configuration file
---
This platform allows you to detect presence by looking at connected devices to an [Aruba Instant](https://www.arubanetworks.com/products/networking/aruba-instant/) device.
@ -27,7 +30,8 @@ Supported devices (tested):
This device tracker needs telnet to be enabled on the router.
</div>
To use this device tracker in your installation, add the following to your `configuration.yaml` file:
To use this device tracker in your installation, add the following to your {% term "`configuration.yaml`" %} file.
{% include integrations/restart_ha_after_config_inclusion.md %}
```yaml
# Example configuration.yaml entry

6
source/_integrations/arwn.markdown
View File

@ -9,11 +9,15 @@ ha_domain: arwn
ha_platforms:
- sensor
ha_integration_type: integration
related:
- docs: /docs/configuration/
title: Configuration file
---
The `arwn` sensor platform is a client for the [Ambient Radio Weather Network](https://github.com/sdague/arwn) project. This collects weather station data and makes it available in an MQTT subtree.
To use your ARWN setup, you must already have configured the [MQTT](/integrations/mqtt/) platform. Then add the following to your `configuration.yaml` file:
To use your ARWN setup, you must already have configured the [MQTT](/integrations/mqtt/) platform. Then add the following to your {% term "`configuration.yaml`" %} file.
{% include integrations/restart_ha_after_config_inclusion.md %}
```yaml
# Example configuration.yaml entry

12
source/_integrations/assist_pipeline.markdown
View File

@ -13,12 +13,20 @@ ha_integration_type: integration
ha_quality_scale: internal
ha_platforms:
- select
related:
- docs: /docs/configuration/
title: Configuration file
- docs: /voice_control/voice_remote_local_assistant/
title: Configuring a voice pipeline
- docs: /voice_control/
title: Assist
---
The Assist pipeline integration provides the foundation for the [Assist](/voice_control/) voice assistant in Home Assistant.
The Assist pipeline {% term integration %} provides the foundation for the [Assist](/voice_control/) voice assistant in Home Assistant.
For most users, there is no need to install this integration manually. The Assist pipeline integration is part of the default configuration and is set up automatically if needed by other integrations.
If you are not using the default integration, you need to add the following to your `configuration.yaml` file:
If you are not using the default {% term integration %}, you need to add the following to your {% term "`configuration.yaml`" %} file.
{% include integrations/restart_ha_after_config_inclusion.md %}
```yaml
# Example configuration.yaml entry

8
source/_integrations/aten_pe.markdown
View File

@ -11,9 +11,12 @@ ha_domain: aten_pe
ha_platforms:
- switch
ha_integration_type: integration
related:
- docs: /docs/configuration/
title: Configuration file
---
The `aten_pe` integration lets you control [ATEN Rack PDUs](https://www.aten.com/eu/en/products/energy-intelligence-pduupsracks/rack-pdu/) from Home Assistant.
The `aten_pe` {% term integration %} lets you control [ATEN Rack PDUs](https://www.aten.com/eu/en/products/energy-intelligence-pduupsracks/rack-pdu/) from Home Assistant.
In order to use it, SNMP must be enabled on your PDU. It is recommended to use SNMPv3 to protect your credentials from eavesdropping.
@ -21,7 +24,8 @@ Tested devices:
- [PE8324G](https://www.aten.com/eu/en/products/energy-intelligence-pduupsracks/rack-pdu/pe8324/)
To set it up, add the following information to your `configuration.yaml` file:
To set it up, add the following information to your {% term "`configuration.yaml`" %} file.
{% include integrations/restart_ha_after_config_inclusion.md %} file:
```yaml
switch:

6
source/_integrations/atome.markdown
View File

@ -12,6 +12,9 @@ ha_domain: atome
ha_platforms:
- sensor
ha_integration_type: integration
related:
- docs: /docs/configuration/
title: Configuration file
---
The `atome` sensor platform is retrieving the consumption of your home from the [Direct Energy Atome electric meter](https://total.direct-energie.com/particuliers/electricite/compteur-linky/atome).
@ -24,7 +27,8 @@ As there is no official documentation for the API, the integration retrieves dat
To use it, you need to order the device directly from "Total Direct Energie" Mobile App. Then you need to follow up the installation (covered in the Atome App).
The configuration (see below) needs your Atome username & password you created during the initialization of the Atome device.
Next, add the Atome sensor to your `configuration.yaml` file like below:
Next, add the Atome sensor to your {% term "`configuration.yaml`" %} file.
{% include integrations/restart_ha_after_config_inclusion.md %}
```yaml
# Example configuration.yaml entry

6
source/_integrations/avea.markdown
View File

@ -11,13 +11,17 @@ ha_domain: avea
ha_platforms:
- light
ha_integration_type: integration
related:
- docs: /docs/configuration/
title: Configuration file
---
[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
To enable Avea, add the following lines to your `configuration.yaml` file:
To enable Avea, add the following lines to your {% term "`configuration.yaml`" %} file.
{% include integrations/restart_ha_after_config_inclusion.md %}
```yaml
# Example configuration.yaml entry

3
source/_integrations/avion.markdown
View File

@ -27,7 +27,8 @@ with the email and password fields replaced with those used when registering the
## Configuration
To enable these lights, add the following lines to your `configuration.yaml` file:
To enable these lights, add the following lines to your {% term "`configuration.yaml`" %} file.
{% include integrations/restart_ha_after_config_inclusion.md %}
```yaml
# Example configuration.yaml entry

8
source/_integrations/aws.markdown
View File

@ -9,6 +9,9 @@ ha_domain: aws
ha_platforms:
- notify
ha_integration_type: integration
related:
- docs: /docs/configuration/
title: Configuration file
---
The `aws` integration provides a single place to interact with [Amazon Web Services](https://aws.amazon.com/). Currently it provides a notification platform that can send a message to [AWS SQS](https://aws.amazon.com/sqs/), [AWS SNS](https://aws.amazon.com/sns/), or invoke [AWS Lambda](https://aws.amazon.com/lambda/) functions.
@ -23,7 +26,8 @@ The `aws` integration is using [botocore](https://botocore.amazonaws.com/v1/docu
## Configuration
To use the `aws` integration and the `notify` platform in your installation, add the following to your `configuration.yaml` file:
To use the `aws` integration and the `notify` platform in your installation, add the following to your {% term "`configuration.yaml`" %} file.
{% include integrations/restart_ha_after_config_inclusion.md %}
```yaml
# Example configuration.yaml entry
@ -146,7 +150,7 @@ If one exists, the SNS Subject will be set to the title. All attributes from the
If you do not download them, you will lose them and will have to recreate a new user.
</div>
- Copy/Paste the two keys that are shown here in your `configuration.yaml` file.
- Copy/Paste the two keys that are shown here in your {% term "`configuration.yaml`" %} file.
- On the left-hand side of the screen go back to "Users" and select the user you just created. On the "Permissions" tab click the "Attach Policy" icon. Search for "SNS" and attach the policy "AmazonSNSFullAccess".
- Back to the AWS Console you now need to find "SNS" and click in to that service. It is under the Mobile Services group.
- On the left-hand side, select "Topics" then "Create new topic".

5
source/_integrations/azure_event_hub.markdown
View File

@ -10,6 +10,9 @@ ha_codeowners:
ha_domain: azure_event_hub
ha_config_flow: true
ha_integration_type: integration
related:
- docs: /docs/configuration/
title: Configuration file
---
The `Azure Event Hub` integration allows you to hook into the Home Assistant event bus and send events to [Azure Event Hub](https://azure.microsoft.com/products/event-hubs/) or to an [Azure IoT Hub](https://learn.microsoft.com/azure/iot-hub/iot-hub-devguide-messages-read-builtin).
@ -30,7 +33,7 @@ The final thing to consider is how often you want the integration to send messag
{% include integrations/config_flow.md %}
You can setup [filters](#filter-configuration) through the `configuration.yaml`.
You can setup [filters](#filter-configuration) through the {% term "`configuration.yaml`" %}.
<div class='note warning'>
Not filtering domains or entities will send every event to Azure Event Hub, thus taking up a lot of space and bandwidth.

6
source/_integrations/azure_service_bus.markdown
View File

@ -11,6 +11,9 @@ ha_domain: azure_service_bus
ha_platforms:
- notify
ha_integration_type: integration
related:
- docs: /docs/configuration/
title: Configuration file
---
The `Azure Service Bus` integration allows you to send messages to [Azure Service Bus](https://azure.microsoft.com/products/service-bus/) from within Home Assistant.
@ -33,7 +36,8 @@ The queue or topic that you are sending to needs to exists with the service bus
## Configuration
Add the following lines to your `configuration.yaml` file:
Add the following lines to your {% term "`configuration.yaml`" %} file.
{% include integrations/restart_ha_after_config_inclusion.md %}
```yaml
# Example configuration.yaml entry

6
source/_integrations/baidu.markdown
View File

@ -9,13 +9,17 @@ ha_domain: baidu
ha_platforms:
- tts
ha_integration_type: integration
related:
- docs: /docs/configuration/
title: Configuration file
---
The `baidu` text-to-speech platform uses [Baidu TTS engine](https://cloud.baidu.com/product/speech/tts) to read a text with natural sounding voices.
## Configuration
To get started, add the following lines to your `configuration.yaml`:
To get started, add the following lines to your {% term "`configuration.yaml`" %} file.
{% include integrations/restart_ha_after_config_inclusion.md %}
```yaml
#Example configuration.yaml entry

6
source/_integrations/bayesian.markdown
View File

@ -13,6 +13,9 @@ ha_platforms:
ha_integration_type: integration
ha_codeowners:
- '@HarvsG'
related:
- docs: /docs/configuration/
title: Configuration file
---
The `bayesian` binary sensor platform observes the state from multiple sensors. It uses [Bayes' rule](https://en.wikipedia.org/wiki/Bayes%27_theorem) to estimate the probability that an event is occurring given the state of the observed sensors. If the estimated posterior probability is above the `probability_threshold`, the sensor is `on`; otherwise, it is `off`.
@ -38,7 +41,8 @@ In the configuration use the probability of the observation (the sensor state in
## Configuration
To enable the Bayesian sensor, add the following lines to your `configuration.yaml`:
To enable the Bayesian sensor, add the following lines to your {% term "`configuration.yaml`" %} file.
{% include integrations/restart_ha_after_config_inclusion.md %}
```yaml
# Example configuration.yaml entry

15
source/_integrations/bbox.markdown
View File

@ -12,9 +12,12 @@ ha_platforms:
- device_tracker
- sensor
ha_integration_type: integration
related:
- docs: /docs/configuration/
title: Configuration file
---
The `bbox` platform uses the [Bbox Modem Router](https://www.bouyguestelecom.fr/offres-internet/bbox-fit) from the French Internet provider Bouygues Telecom. Sensors are mainly bandwidth measures.
The `bbox` {% term integration %} uses the [Bbox Modem Router](https://www.bouyguestelecom.fr/offres-internet/bbox-fit) from the French Internet provider Bouygues Telecom. Sensors are mainly bandwidth measures.
There is currently support for the following device types within Home Assistant:
@ -27,15 +30,16 @@ Due to third party limitation, the sensors will only be available if Home Assist
## Presence detection
The `bbox` platform offers presence detection by looking at connected devices to a [Bbox](https://www.bouyguestelecom.fr/offres-internet/bbox-fit) based router from [Bouygues](https://www.bouyguestelecom.fr/), which is one of the main Internet provider in France.
The `bbox` {% term integration %} offers presence detection by looking at connected devices to a [Bbox](https://www.bouyguestelecom.fr/offres-internet/bbox-fit) based router from [Bouygues](https://www.bouyguestelecom.fr/), which is one of the main Internet provider in France.
Bbox is a generic name for different hardware routers. The platform has been tested with the following devices:
Bbox is a generic name for different hardware routers. The {% term integration %} has been tested with the following devices:
- Sagem F@st 5330b
### Configuration
To use an Bbox router in your installation, add the following to your `configuration.yaml` file:
To use an Bbox router in your installation, add the following to your {% term "`configuration.yaml`" %} file.
{% include integrations/restart_ha_after_config_inclusion.md %}
```yaml
# Example configuration.yaml entry
@ -59,7 +63,8 @@ See the [device tracker integration page](/integrations/device_tracker/) for ins
## Sensor
To add Bbox sensors to your installation, add the following to your `configuration.yaml` file:
To add Bbox sensors to your installation, add the following to your {% term "`configuration.yaml`" %} file.
{% include integrations/restart_ha_after_config_inclusion.md %}
```yaml
# Example configuration.yaml entry

6
source/_integrations/beewi_smartclim.markdown
View File

@ -11,6 +11,9 @@ ha_domain: beewi_smartclim
ha_platforms:
- sensor
ha_integration_type: integration
related:
- docs: /docs/configuration/
title: Configuration file
---
The `beewi_smartclim` sensor platform allows one to monitor room or external temperature and humidity. The BeeWi SmartClim BLE is a Bluetooth Low Energy sensor device that monitors temperature from a room or a garden from your smartphone by using an APP. Use this integration to track these metrics from any location thanks to Home Assistant, as well as to create some automation scripts based on your room's temperature.
@ -48,7 +51,8 @@ Discovery started
Check for `BeeWi SmartClim` or similar entries, those are your sensor.
To use your Mi Temperature and Humidity sensor in your installation, add the following to your `configuration.yaml` file:
To use your Mi Temperature and Humidity sensor in your installation, add the following to your {% term "`configuration.yaml`" %} file.
{% include integrations/restart_ha_after_config_inclusion.md %}
```yaml
# Example configuration.yaml entry

2
source/_integrations/binary_sensor.mqtt.markdown
View File

@ -21,7 +21,7 @@ Stateless devices such as buttons, remote controls etc are better represented by
The `mqtt` binary sensor platform optionally supports a list of `availability` topics to receive online and offline messages (birth and LWT messages) from the MQTT device. During normal operation, if the MQTT sensor device goes offline (i.e., publishes `payload_not_available` to an `availability` topic), Home Assistant will display the binary sensor as `unavailable`. If these messages are published with the `retain` flag set, the binary sensor will receive an instant update after subscription and Home Assistant will display the correct availability state of the binary sensor when Home Assistant starts up. If the `retain` flag is not set, Home Assistant will display the binary sensor as `unavailable` when Home Assistant starts up. If no `availability` topic is defined, Home Assistant will consider the MQTT device to be `available` and will display its state.
To use an MQTT binary sensor in your installation,
add the following to your `configuration.yaml` file:
add the following to your {% term "`configuration.yaml`" %} file:
```yaml
# Example configuration.yaml entry

2
source/_integrations/binary_sensor.rest.markdown
View File

@ -33,7 +33,7 @@ The JSON messages can contain different values like `1`, `"1"`,
## Configuration
To enable this sensor,
add the following lines to your `configuration.yaml` file for a GET request:
add the following lines to your {% term "`configuration.yaml`" %} file for a GET request:
```yaml
# Example configuration.yaml entry

6
source/_integrations/bitcoin.markdown
View File

@ -9,11 +9,15 @@ ha_domain: bitcoin
ha_platforms:
- sensor
ha_integration_type: integration
related:
- docs: /docs/configuration/
title: Configuration file
---
The `bitcoin` sensor platform displays various details about the [Bitcoin](https://bitcoin.org) network.
To add the Bitcoin sensor to your installation, add a selection of the available display options to your `configuration.yaml` file:
To add the Bitcoin sensor to your installation, add a selection of the available display options to your {% term "`configuration.yaml`" %} file.
{% include integrations/restart_ha_after_config_inclusion.md %}
```yaml
# Example configuration.yaml entry

6
source/_integrations/bizkaibus.markdown
View File

@ -12,6 +12,9 @@ ha_domain: bizkaibus
ha_platforms:
- sensor
ha_integration_type: integration
related:
- docs: /docs/configuration/
title: Configuration file
---
The `bizkaibus` sensor will give you the time until the next bus in the selected stop.
@ -20,7 +23,8 @@ The next website can help to determine the id of your bus stop. You can check if
For a correct use of the sensor the selected route must stop in the selected stop.
Then add the data to your `configuration.yaml` file as shown in the example:
Then add the data to your {% term "`configuration.yaml`" %} file.
{% include integrations/restart_ha_after_config_inclusion.md %}
```yaml
# Example configuration.yaml entry

12
source/_integrations/blackbird.markdown
View File

@ -9,11 +9,15 @@ ha_domain: blackbird
ha_platforms:
- media_player
ha_integration_type: integration
related:
- docs: /docs/configuration/
title: Configuration file
---
The `blackbird` platform allows you to control [Monoprice Blackbird Matrix Switch](https://www.monoprice.com/product?p_id=21819) (8x8) using a serial or IP connection, this integration does not support the 4x4 matrix switch.
To add a Blackbird 8x8 device to your installation, add the following to your `configuration.yaml` file:
To add a Blackbird 8x8 device to your installation, add the following to your {% term "`configuration.yaml`" %} file.
{% include integrations/restart_ha_after_config_inclusion.md %}
```yaml
# Example configuration.yaml entry
@ -60,6 +64,6 @@ sources:
Set all zones to the same input source. This service allows you to immediately synchronize all the TVs in your home. Regardless of `entity_id` provided, all zones will be updated.
| Service data attribute | Optional | Description |
| ---------------------- | -------- | ----------- |
| `entity_id` | yes | String that points at an `entity_id` of a zone.
| `source` | no | String of source name to activate.
| ---------------------- | -------- | ----------------------------------------------- |
| `entity_id` | yes | String that points at an `entity_id` of a zone. |
| `source` | no | String of source name to activate. |

8
source/_integrations/blink.markdown
View File

@ -68,10 +68,10 @@ Trigger a camera to take a new still image.
### `blink.save_video`
Save the last recorded video of a camera to a local file. Note that in most cases, Home Assistant will need to know that the directory is writable via the `allowlist_external_dirs` in your `configuration.yaml` file (see example below).
Save the last recorded video of a camera to a local file. Note that in most cases, Home Assistant will need to know that the directory is writable via the `allowlist_external_dirs` in your {% term "`configuration.yaml`" %} file (see example below).
| Service Data Attribute | Optional | Description |
| ---------------------- | -------- | ---------------------------------------- |
| ---------------------- | -------- | ---------------------- |
| `filename` | no | Location of save file. |
```yaml
@ -82,10 +82,10 @@ homeassistant:
```
### `blink.save_recent_clips`
Save the recent video clips of a camera to a local file in the pattern `%Y%m%d_%H%M%S_{name}.mp4`. Note that in most cases, Home Assistant will need to know that the directory is writable via the `allowlist_external_dirs` in your `configuration.yaml` file.
Save the recent video clips of a camera to a local file in the pattern `%Y%m%d_%H%M%S_{name}.mp4`. Note that in most cases, Home Assistant will need to know that the directory is writable via the `allowlist_external_dirs` in your {% term "`configuration.yaml`" %} file.
| Service Data Attribute | Optional | Description |
| ---------------------- | -------- | ---------------------------------------- |
| ---------------------- | -------- | ----------------------- |
| `file_path` | no | Location of save files. |
### `blink.send_pin`

6
source/_integrations/blinksticklight.markdown
View File

@ -9,6 +9,9 @@ ha_domain: blinksticklight
ha_platforms:
- light
ha_integration_type: integration
related:
- docs: /docs/configuration/
title: Configuration file
---
The `blinkstick` platform lets you control your [Blinkstick](https://www.blinkstick.com/) lights from within Home Assistant.
@ -23,7 +26,8 @@ sudo blinkstick --add-udev-rule
## Configuration
To add a Blinkstick to your installation, add the following to your `configuration.yaml` file:
To add a Blinkstick to your installation, add the following to your {% term "`configuration.yaml`" %} file.
{% include integrations/restart_ha_after_config_inclusion.md %}
```yaml
# Example configuration.yaml entry

6
source/_integrations/blockchain.markdown
View File

@ -9,11 +9,15 @@ ha_domain: blockchain
ha_platforms:
- sensor
ha_integration_type: integration
related:
- docs: /docs/configuration/
title: Configuration file
---
The `Blockchain` sensor platform displays Bitcoin wallet balances from [blockchain.com](https://blockchain.com).
To add the Blockchain sensor to your installation, specify a list of bitcoin addresses to watch in the `configuration.yaml` file. The sensor state will be the sum of the balances of all addresses listed.
To add the Blockchain sensor to your installation, specify a list of bitcoin addresses to watch in the {% term "`configuration.yaml`" %} file.
{% include integrations/restart_ha_after_config_inclusion.md %}. The sensor state will be the sum of the balances of all addresses listed.
Currently, the original Bitcoin address format is supported.
For example, the newer Segwit and Taproot format are not supported.

12
source/_integrations/bloomsky.markdown
View File

@ -15,6 +15,9 @@ ha_platforms:
- camera
- sensor
ha_integration_type: integration
related:
- docs: /docs/configuration/
title: Configuration file
---
The **BloomSky** {% term integration %} allows you to access your [BloomSky](https://www.bloomsky.com/) weather station's.
@ -31,7 +34,8 @@ Obtain your API key from your [BloomSky dashboard](https://dashboard.bloomsky.co
## Configuration
To integrate your BloomSky hub with Home Assistant, add the following section to your `configuration.yaml` file:
To integrate your BloomSky hub with Home Assistant, add the following section to your {% term "`configuration.yaml`" %} file.
{% include integrations/restart_ha_after_config_inclusion.md %}
```yaml
# Example configuration.yaml entry
@ -54,7 +58,7 @@ To get your BloomSky binary sensors working with Home Assistant, follow the inst
### Configuration
To use your BloomSky binary sensor in your installation, add the following to your `configuration.yaml` file:
To use your BloomSky binary sensor in your installation, add the following to your {% term "`configuration.yaml`" %} file.
```yaml
# Example configuration.yaml entry
@ -83,7 +87,7 @@ The `bloomsky` camera integration allows you to view the current photo created b
### Configuration
To enable this camera in your installation, set up the BloomSky integration with your API key and add the following to your `configuration.yaml` file:
To enable this camera in your installation, set up the BloomSky integration with your API key and add the following to your {% term "`configuration.yaml`" %} file.
```yaml
# Example configuration.yaml entry
@ -97,7 +101,7 @@ The `bloomsky` sensor integration allows you to view the measurements made by se
### Configuration
To enable these sensors in your installation, set up the BloomSky integration with your API key add the following to your `configuration.yaml` file:
To enable these sensors in your installation, set up the BloomSky integration with your API key add the following to your {% term "`configuration.yaml`" %} file.
```yaml
# Example configuration.yaml entry

24
source/_integrations/bluesound.markdown
View File

@ -11,11 +11,15 @@ ha_platforms:
ha_codeowners:
- '@thrawnarn'
ha_integration_type: integration
related:
- docs: /docs/configuration/
title: Configuration file
---
The `bluesound` platform allows you to control your [Bluesound](https://www.bluesound.com/) HiFi wireless speakers and audio integrations from Home Assistant.
To manually add a Bluesound device to your installation, add the following to your `configuration.yaml` file:
To manually add a Bluesound device to your installation, add the following to your {% term "`configuration.yaml`" %} file.
{% include integrations/restart_ha_after_config_inclusion.md %}
```yaml
# Example configuration.yaml
@ -64,17 +68,17 @@ media_player:
Group players together under a single master speaker. That will make a new group or join an existing group.
| Service data attribute | Optional | Description |
| ---------------------- | -------- | ----------- |
| `master` | no | A single `entity_id` that will become/hold the master speaker.
| `entity_id` | no | String or list of a single `entity_id` that will group to master speaker.
| ---------------------- | -------- | ------------------------------------------------------------------------- |
| `master` | no | A single `entity_id` that will become/hold the master speaker. |
| `entity_id` | no | String or list of a single `entity_id` that will group to master speaker. |
### Service `bluesound.unjoin`
Remove one or more speakers from a group of speakers. If no `entity_id` is provided, all speakers are unjoined.
| Service data attribute | Optional | Description |
| ---------------------- | -------- | ----------- |
| `entity_id` | yes | String or list of `entity_id`s that will be separated from their master speaker.
| ---------------------- | -------- | -------------------------------------------------------------------------------- |
| `entity_id` | yes | String or list of `entity_id`s that will be separated from their master speaker. |
### Service `bluesound.set_sleep_timer`
@ -82,13 +86,13 @@ Sets a timer that will turn off the speaker. For each time you call this it will
If you increase an ongoing timer of for example 13 minutes, it will increase it to 15. If the timer is set to 90, it will remove the time (hence the 0).
| Service data attribute | Optional | Description |
| ---------------------- | -------- | ----------- |
| `entity_id` | no | String or list of `entity_id`s that will have their timers set.
| ---------------------- | -------- | --------------------------------------------------------------- |
| `entity_id` | no | String or list of `entity_id`s that will have their timers set. |
### Service `bluesound.clear_sleep_timer`
Clear the sleep timer on a speaker, if one is set.
| Service data attribute | Optional | Description |
| ---------------------- | -------- | ----------- |
| `entity_id` | no | String or list of `entity_id`s that will have their timers cleared.
| ---------------------- | -------- | ------------------------------------------------------------------- |
| `entity_id` | no | String or list of `entity_id`s that will have their timers cleared. |

5
source/_integrations/bluetooth.markdown
View File

@ -27,7 +27,8 @@ Suppose a Bluetooth proxy is not a good fit for your use case. Consider using th
## Configuration
While this integration is part of [`default_config:`](/integrations/default_config/) to enable automatic discovery of the Bluetooth Adapter, it will only be enabled by setting up the configuration flow, or manually adding it to your `configuration.yaml`.
While this integration is part of [`default_config:`](/integrations/default_config/) to enable automatic discovery of the Bluetooth Adapter, it will only be enabled by setting up the configuration flow, or manually adding it to your {% term "`configuration.yaml`" %} file.
{% include integrations/restart_ha_after_config_inclusion.md %}
```yaml
# Example configuration.yaml entry
@ -285,7 +286,7 @@ The connection time and performance vary greatly based on the Bluetooth adapter
While newer integrations can share the Bluetooth Adapter, some legacy integrations require exclusive use of the adapter. Enabling this integration may prevent an integration that has not been updated to use newer methods from functioning.
Deleting the config entry for this integration will release control of the adapter and allow another integration to gain exclusive use of the Bluetooth adapter. If you have manually added `bluetooth:` to your `configuration.yaml`, you must also remove it to prevent the configuration from being recreated. Consider adding a second Bluetooth adapter on Linux systems if you need to continue using legacy integrations, as more integrations will move to use the Bluetooth integration in the future.
Deleting the config entry for this integration will release control of the adapter and allow another integration to gain exclusive use of the Bluetooth adapter. If you have manually added `bluetooth:` to your {% term "`configuration.yaml`" %}, you must also remove it to prevent the configuration from being recreated. Consider adding a second Bluetooth adapter on Linux systems if you need to continue using legacy integrations, as more integrations will move to use the Bluetooth integration in the future.
### Bluetooth interference with other devices

6
source/_integrations/bluetooth_le_tracker.markdown
View File

@ -9,6 +9,9 @@ ha_domain: bluetooth_le_tracker
ha_platforms:
- device_tracker
ha_integration_type: integration
related:
- docs: /docs/configuration/
title: Configuration file
---
This tracker discovers new devices on boot and in regular intervals and tracks Bluetooth low-energy devices periodically based on interval_seconds value. It is not required to pair the devices with each other.
@ -21,7 +24,8 @@ This {% term integration %} requires the [Bluetooth](/integrations/bluetooth) in
## Configuration
To use the Bluetooth tracker in your installation, add the following to your `configuration.yaml` file:
To use the Bluetooth tracker in your installation, add the following to your {% term "`configuration.yaml`" %} file.
{% include integrations/restart_ha_after_config_inclusion.md %}
```yaml
# Example configuration.yaml entry

3
source/_integrations/bluetooth_tracker.markdown
View File

@ -23,7 +23,8 @@ sudo apt install bluetooth libbluetooth-dev
{% enddetails %}
To use the Bluetooth tracker in your installation, add the following to your `configuration.yaml` file:
To use the Bluetooth tracker in your installation, add the following to your {% term "`configuration.yaml`" %} file.
{% include integrations/restart_ha_after_config_inclusion.md %}
```yaml
# Example configuration.yaml entry

7
source/_integrations/broadlink.markdown
View File

@ -24,6 +24,9 @@ ha_platforms:
- switch
ha_dhcp: true
ha_integration_type: integration
related:
- docs: /docs/configuration/
title: Configuration file
---
The **Broadlink** {% term integration %} allows you to control and monitor Broadlink universal remotes, smart plugs, power strips, switches and sensors. The following devices are supported:
@ -350,7 +353,7 @@ You can also define custom IR/RF switches to be controlled with universal remote
### Setting up custom IR/RF switches
The first step is to configure the device normally via the configuration flow. Then add these lines to your `configuration.yaml`:
The first step is to configure the device normally via the configuration flow. Then add these lines to your {% term "`configuration.yaml`" %} file:
```yaml
# Example configuration.yaml entry
@ -503,7 +506,7 @@ First get or learn all the remotes you want to add to Home Assistant in e-Contro
[+] Dumping codes to TV.txt
```
6. Now there should be a file with the name of the remote you chose in the same directory ending in `.txt`. Open that up and it will contain the Base64 code required for Home Assistant. To ensure these codes work correctly you may need to add `==` to the end of the code in your `configuration.yaml` file (or wherever you have your switches).
6. Now there should be a file with the name of the remote you chose in the same directory ending in `.txt`. Open that up and it will contain the Base64 code required for Home Assistant. To ensure these codes work correctly you may need to add `==` to the end of the code in your {% term "`configuration.yaml`" %} file (or wherever you have your switches).
### Using Windows to obtain codes with Broadlink Manager

2
source/_integrations/brother.markdown
View File

@ -40,7 +40,7 @@ For some Brother devices, `SNMPv3 read-write access and v1/v2c read-only access`
## Sensor example
You can configure Home Assistant to alert you when the printer jams or runs out of paper as follows. First, add the following to `configuration.yaml` under the `template:` section (Note: replace `sensor.hl_l2340d_status` with the actual name of your sensor):
You can configure Home Assistant to alert you when the printer jams or runs out of paper as follows. First, add the following to {% term "`configuration.yaml`" %} under the `template:` section (Note: replace `sensor.hl_l2340d_status` with the actual name of your sensor):
{% raw %}

10
source/_integrations/browser.markdown
View File

@ -8,13 +8,17 @@ ha_iot_class: Local Push
ha_quality_scale: internal
ha_domain: browser
ha_integration_type: integration
related:
- docs: /docs/configuration/
title: Configuration file
---
The **Browser** {% term integration %} provides a service to open URLs in the default browser on the host machine.
## Configuration
To load this integration, add the following lines to your `configuration.yaml`:
To load this integration, add the following lines to your {% term "`configuration.yaml`" %} file.
{% include integrations/restart_ha_after_config_inclusion.md %}
```yaml
# Example configuration.yaml entry
@ -28,8 +32,8 @@ Once loaded, the `browser` platform will expose {% term services %} that can be
Available services: `browser/browse_url`.
| Service data attribute | Optional | Description |
| ---------------------- | -------- | ----------- |
| `url` | no | The URL to open.
| ---------------------- | -------- | ---------------- |
| `url` | no | The URL to open. |
### Usage

6
source/_integrations/bt_home_hub_5.markdown
View File

@ -9,11 +9,15 @@ ha_iot_class: Local Polling
ha_platforms:
- device_tracker
ha_integration_type: integration
related:
- docs: /docs/configuration/
title: Configuration file
---
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.
To use a BT Home Hub 5 router in your installation, add the following to your `configuration.yaml` file:
To use a BT Home Hub 5 router in your installation, add the following to your {% term "`configuration.yaml`" %} file.
{% include integrations/restart_ha_after_config_inclusion.md %}
```yaml
# Example configuration.yaml entry

6
source/_integrations/bt_smarthub.markdown
View File

@ -11,6 +11,9 @@ ha_domain: bt_smarthub
ha_platforms:
- device_tracker
ha_integration_type: integration
related:
- docs: /docs/configuration/
title: Configuration file
---
This platform offers presence detection by looking at connected devices to a [BT Smart Hub](https://en.wikipedia.org/wiki/BT_Smart_Hub) based router.
@ -18,7 +21,8 @@ This router is sometimes referred to as the BT Home Hub 6.
## Configuration
To use a BT Smart Hub router in your installation, add the following to your `configuration.yaml` file:
To use a BT Smart Hub router in your installation, add the following to your {% term "`configuration.yaml`" %} file.
{% include integrations/restart_ha_after_config_inclusion.md %}
```yaml
# Example configuration.yaml entry

6
source/_integrations/caldav.markdown
View File

@ -21,6 +21,9 @@ related:
title: To-do list card
- docs: /integrations/calendar
title: Calendar
related:
- docs: /docs/configuration/
title: Configuration file
---
The **CalDAV** integration allows you to connect your WebDAV calendar to Home Assistant
@ -47,7 +50,8 @@ This integration was tested against the following systems, but any other complyi
## Manual configuration
You may also manually add a WebDAV calendar in Home Assistant by adding the following section to your `configuration.yaml` file. This method does not support to-do lists.
You may also manually add a WebDAV calendar in Home Assistant by adding the following section to your {% term "`configuration.yaml`" %} file. This method does not support to-do lists.
{% include integrations/restart_ha_after_config_inclusion.md %}
{% details Manual configuration examples %}

20
source/_integrations/channels.markdown
View File

@ -9,6 +9,9 @@ ha_domain: channels
ha_platforms:
- media_player
ha_integration_type: integration
related:
- docs: /docs/configuration/
title: Configuration file
---
The Channels platform allows you to control [Channels](https://getchannels.com/) from Home Assistant. Play, pause, seek, or skip commercials on an instance of Channels that is running on your network.
@ -17,7 +20,8 @@ Your favorite channels will appear as sources in the Source List in Home Assista
## Configuration
To add Channels to your installation, add the following to your `configuration.yaml` file:
To add Channels to your installation, add the following to your {% term "`configuration.yaml`" %} file.
{% include integrations/restart_ha_after_config_inclusion.md %}
```yaml
# Example configuration.yaml entry
@ -49,22 +53,22 @@ name:
Seek forward by the number of seconds currently set in settings on the instance of Channels.
| Service data attribute | Optional | Description |
| ---------------------- | -------- | ----------- |
| `entity_id` | no | String that points at `entity_id` of Channels app.
| ---------------------- | -------- | -------------------------------------------------- |
| `entity_id` | no | String that points at `entity_id` of Channels app. |
### Service `seek_backward`
Seek backward by the number of seconds currently set in settings on the instance of Channels.
| Service data attribute | Optional | Description |
| ---------------------- | -------- | ----------- |
| `entity_id` | no | String that points at `entity_id` of Channels app.
| ---------------------- | -------- | -------------------------------------------------- |
| `entity_id` | no | String that points at `entity_id` of Channels app. |
### Service `seek_by`
Seek forward or backward by a provided number of seconds.
| Service data attribute | Optional | Description |
| ---------------------- | -------- | ----------- |
| `entity_id` | no | String that points at `entity_id` of Channels app.
| `seconds` | no | Number of seconds to seek in the timeline by. Negative seconds seeks backwards.
| ---------------------- | -------- | ------------------------------------------------------------------------------- |
| `entity_id` | no | String that points at `entity_id` of Channels app. |
| `seconds` | no | Number of seconds to seek in the timeline by. Negative seconds seeks backwards. |

6
source/_integrations/cisco_ios.markdown
View File

@ -11,6 +11,9 @@ ha_domain: cisco_ios
ha_platforms:
- device_tracker
ha_integration_type: integration
related:
- docs: /docs/configuration/
title: Configuration file
---
This is a presence detection scanner for [Cisco IOS](https://www.cisco.com/) devices.
@ -49,7 +52,8 @@ If you have a very large number of devices on your VLan (+1000), then you may wa
</div>
To use this device tracker in your installation, add the following to your `configuration.yaml` file:
To use this device tracker in your installation, add the following to your {% term "`configuration.yaml`" %} file.
{% include integrations/restart_ha_after_config_inclusion.md %}
```yaml
# Example configuration.yaml entry

6
source/_integrations/cisco_mobility_express.markdown
View File

@ -11,11 +11,15 @@ ha_domain: cisco_mobility_express
ha_platforms:
- device_tracker
ha_integration_type: integration
related:
- docs: /docs/configuration/
title: Configuration file
---
This is a presence detection scanner for [Cisco](https://www.cisco.com) Mobility Express wireless controllers.
To use this device tracker in your installation, add the following to your `configuration.yaml` file:
To use this device tracker in your installation, add the following to your {% term "`configuration.yaml`" %} file.
{% include integrations/restart_ha_after_config_inclusion.md %}
```yaml
# Example configuration.yaml entry

6
source/_integrations/cisco_webex_teams.markdown
View File

@ -11,6 +11,9 @@ ha_domain: cisco_webex_teams
ha_platforms:
- notify
ha_integration_type: integration
related:
- docs: /docs/configuration/
title: Configuration file
---
The `cisco_webex_teams` notification platform allows you to deliver rich notifications from Home Assistant to [Cisco Webex Teams](https://www.webex.com/team-collaboration.html) (formerly known as Cisco Spark).
@ -32,7 +35,8 @@ You must add the bot email (in the format `mybot@webex.bot`) as a participant to
</div>
To enable this platform in your installation, add the following to your `configuration.yaml` file:
To enable this platform in your installation, add the following to your {% term "`configuration.yaml`" %} file.
{% include integrations/restart_ha_after_config_inclusion.md %}
```yaml
# Example configuration.yaml entry

6
source/_integrations/citybikes.markdown
View File

@ -9,13 +9,17 @@ ha_domain: citybikes
ha_platforms:
- sensor
ha_integration_type: integration
related:
- docs: /docs/configuration/
title: Configuration file
---
The `citybikes` sensor platform monitors bike availability at bike sharing stations in a chosen area. The data is provided by [CityBikes](https://citybik.es/#about), which supports bike sharing systems all around the world.
## Configuration
To enable it, add the following lines to your `configuration.yaml`:
To enable it, add the following lines to your {% term "`configuration.yaml`" %} file.
{% include integrations/restart_ha_after_config_inclusion.md %}
```yaml
# Example configuration.yaml entry (using radius)

6
source/_integrations/clementine.markdown
View File

@ -9,11 +9,15 @@ ha_domain: clementine
ha_platforms:
- media_player
ha_integration_type: integration
related:
- docs: /docs/configuration/
title: Configuration file
---
The `clementine` platform allows you to control a [Clementine Music Player](https://www.clementine-player.org).
To add a Clementine Player to your Home Assistant installation, add the following to your `configuration.yaml` file:
To add a Clementine Player to your Home Assistant installation, add the following to your {% term "`configuration.yaml`" %} file.
{% include integrations/restart_ha_after_config_inclusion.md %}
```yaml
# Example configuration.yaml entry

6
source/_integrations/clickatell.markdown
View File

@ -9,6 +9,9 @@ ha_domain: clickatell
ha_platforms:
- notify
ha_integration_type: integration
related:
- docs: /docs/configuration/
title: Configuration file
---
The `clickatell` platform uses [Clickatell](https://www.clickatell.com) to deliver SMS notifications from Home Assistant.
@ -26,7 +29,8 @@ Go to your [Clickatell SMS Platform Portal](https://portal.clickatell.com/#/) se
## Configuration
To add Clickatell to your installation, add the following to your Home Assistant `configuration.yaml` file:
To add Clickatell to your installation, add the following to your Home Assistant {% term "`configuration.yaml`" %} file.
{% include integrations/restart_ha_after_config_inclusion.md %}
```yaml
# Example configuration.yaml entry

6
source/_integrations/clicksend.markdown
View File

@ -9,6 +9,9 @@ ha_iot_class: Cloud Push
ha_platforms:
- notify
ha_integration_type: integration
related:
- docs: /docs/configuration/
title: Configuration file
---
The `clicksend` platform uses [ClickSend](https://clicksend.com) to deliver notifications from Home Assistant.
@ -19,7 +22,8 @@ Go to your [ClickSend Dashboard](https://dashboard.clicksend.com) section and cr
## Configuration
To add ClickSend to your installation, add the following to your Home Assistant `configuration.yaml` file:
To add ClickSend to your installation, add the following to your Home Assistant {% term "`configuration.yaml`" %} file.
{% include integrations/restart_ha_after_config_inclusion.md %}
```yaml
# Example configuration.yaml entry

5
source/_integrations/cmus.markdown
View File

@ -13,7 +13,10 @@ ha_integration_type: integration
The `cmus` platform allows you to control a [cmus](https://cmus.github.io/) music player on a remote or local machine from Home Assistant.
To add cmus to your installation, add the following to your `configuration.yaml` file if running locally it will look like:
To add cmus to your installation, add the following to your {% term "`configuration.yaml`" %} file.
{% include integrations/restart_ha_after_config_inclusion.md %}
Running it locally will look like:
```yaml
# Example configuration.yaml entry

3
source/_integrations/comed_hourly_pricing.markdown
View File

@ -15,7 +15,8 @@ The ComEd Hourly Pricing program is an optional program available to ComEd elect
There are two price feeds available: the 5-minute price and current hour average price.
To use this sensor in your installation, add the following to your `configuration.yaml` file:
To use this sensor in your installation, add the following to your {% term "`configuration.yaml`" %} file.
{% include integrations/restart_ha_after_config_inclusion.md %}
```yaml
# Example configuration.yaml entry

3
source/_integrations/command_line.markdown
View File

@ -19,6 +19,9 @@ ha_platforms:
ha_integration_type: integration
ha_codeowners:
- '@gjohansson-ST'
related:
- docs: /docs/configuration/
title: Configuration file
---
The **Command line** {% term integration %} offers functionality that issues specific commands to get data or to control a device.

3
source/_integrations/compensation.markdown
View File

@ -18,7 +18,8 @@ The **Compensation** {% term integration %} consumes the {% term state %} from o
## Configuration
To enable the compensation sensor, add the following lines to your `configuration.yaml`:
To enable the compensation sensor, add the following lines to your {% term "`configuration.yaml`" %} file.
{% include integrations/restart_ha_after_config_inclusion.md %}
```yaml
# Example configuration.yaml entry

3
source/_integrations/concord232.markdown
View File

@ -24,7 +24,8 @@ There is currently support for the following device types within Home Assistant:
## Alarm control panel
To enable the alarm control panel platform, add the following lines to your `configuration.yaml`:
To enable the alarm control panel platform, add the following lines to your {% term "`configuration.yaml`" %} file.
{% include integrations/restart_ha_after_config_inclusion.md %}
```yaml
# Example configuration.yaml entry

3
source/_integrations/cppm_tracker.markdown
View File

@ -23,7 +23,8 @@ You must first create an API client [here](https://www.arubanetworks.com/techdoc
</div>
To use this device tracker in your installation, add the following to your `configuration.yaml` file:
To use this device tracker in your installation, add the following to your {% term "`configuration.yaml`" %} file.
{% include integrations/restart_ha_after_config_inclusion.md %}
```yaml
# Example configuration.yaml entry

6
source/_integrations/cups.markdown
View File

@ -11,6 +11,9 @@ ha_domain: cups
ha_platforms:
- sensor
ha_integration_type: integration
related:
- docs: /docs/configuration/
title: Configuration file
---
The `cups` sensor platform uses the open source printing system [CUPS](https://www.cups.org/) to show details about your printers, including the ink levels. It can obtain the information using a CUPS server or by communicating directly with the printer with the Internet Printing Protocol.
@ -27,7 +30,8 @@ To set up the sensor the "Queue Name" of the printer is needed. The fastest way
## Configuration
To enable the CUPS sensor, add the following lines to your `configuration.yaml`:
To enable the CUPS sensor, add the following lines to your {% term "`configuration.yaml`" %} file.
{% include integrations/restart_ha_after_config_inclusion.md %}
```yaml
# Example configuration.yaml entry

6
source/_integrations/currencylayer.markdown
View File

@ -9,6 +9,9 @@ ha_domain: currencylayer
ha_platforms:
- sensor
ha_integration_type: integration
related:
- docs: /docs/configuration/
title: Configuration file
---
The `currencylayer` sensor will show you the current exchange rate from [Currencylayer](https://currencylayer.com/) that provides real-time exchange rates for [170 currencies](https://currencylayer.com/currencies). The free account is limited to only USD as a base currency, allows 250 requests per month and updates daily.
@ -19,7 +22,8 @@ Obtain your API key from [here](https://currencylayer.com/product).
## Configuration
To enable this sensor, add the following lines to your `configuration.yaml` file:
To enable this sensor, add the following lines to your {% term "`configuration.yaml`" %} file.
{% include integrations/restart_ha_after_config_inclusion.md %}
```yaml
# Example configuration.yaml entry

3
source/_integrations/danfoss_air.markdown
View File

@ -26,6 +26,9 @@ There is currently support for the following device types within Home Assistant:
- [Sensor](#sensor)
- [Switch](#switch)
To enable Danfoss Air, add the following lines to your {% term "`configuration.yaml`" %} file.
{% include integrations/restart_ha_after_config_inclusion.md %}
```yaml
# Example configuration.yaml entry
danfoss_air:

6
source/_integrations/datadog.markdown
View File

@ -7,6 +7,9 @@ ha_iot_class: Local Push
ha_release: 0.45
ha_domain: datadog
ha_integration_type: integration
related:
- docs: /docs/configuration/
title: Configuration file
---
The **Datadog** {% term integration %} sends all state changes to [Datadog](https://www.datadoghq.com/) using a [Datadog Agent](https://docs.datadoghq.com/guides/basic_agent_usage/).
@ -31,7 +34,8 @@ In the [Datadog Agent configuration](https://github.com/DataDog/datadog-agent/bl
## Configuration
To use the `datadog` integration in your installation, add the following to your `configuration.yaml` file:
To use the `datadog` integration in your installation, add the following to your {% term "`configuration.yaml`" %} file.
{% include integrations/restart_ha_after_config_inclusion.md %}
```yaml
# Example configuration.yaml entry

8
source/_integrations/ddwrt.markdown
View File

@ -9,11 +9,15 @@ ha_domain: ddwrt
ha_platforms:
- device_tracker
ha_integration_type: integration
related:
- docs: /docs/configuration/
title: Configuration file
---
This platform offers presence detection by looking at connected devices to a [DD-WRT](https://dd-wrt.com/) based router.
The `ddwrt` {% term integration %} offers presence detection by looking at connected devices to a [DD-WRT](https://dd-wrt.com/) based router.
To use a DD-WRT router in your installation, add the following to your `configuration.yaml` file:
To use a DD-WRT router in your installation, add the following to your {% term "`configuration.yaml`" %} file.
{% include integrations/restart_ha_after_config_inclusion.md %}
```yaml
# Example configuration.yaml entry

6
source/_integrations/debugpy.markdown
View File

@ -10,6 +10,9 @@ ha_domain: debugpy
ha_quality_scale: internal
ha_iot_class: Local Push
ha_integration_type: service
related:
- docs: /docs/configuration/
title: Configuration file
---
The **Remote Python debugger** {% term integration %} allows you to use the Visual Studio Code
@ -27,7 +30,8 @@ performance when not injected.
## Configuration
To enable the remote Python debugger integration add the following to
your `configuration.yaml` file:
your {% term "`configuration.yaml`" %} file.
{% include integrations/restart_ha_after_config_inclusion.md %}
```yaml
# Example configuration.yaml entry

8
source/_integrations/delijn.markdown
View File

@ -13,9 +13,12 @@ ha_domain: delijn
ha_platforms:
- sensor
ha_integration_type: integration
related:
- docs: /docs/configuration/
title: Configuration file
---
The `delijn` sensor will give you the departure time of the next bus, tram or subway at a specific stop of the De Lijn public transport network in Flanders (Belgium).
The `delijn` {% term integration %} will give you the departure time of the next bus, tram or subway at a specific stop of the De Lijn public transport network in Flanders (Belgium).
## Setup
@ -24,7 +27,8 @@ For valid stop IDs check for the 6 digits at the physical stops or visit the [st
## Configuration
To enable this sensor, add the following lines to your `configuration.yaml` file:
To enable this sensor, add the following lines to your {% term "`configuration.yaml`" %} file.
{% include integrations/restart_ha_after_config_inclusion.md %}
```yaml
# Example configuration.yaml entry

8
source/_integrations/demo.markdown
View File

@ -45,9 +45,12 @@ ha_platforms:
- water_heater
- weather
ha_integration_type: integration
related:
- docs: /docs/configuration/
title: Configuration file
---
The `demo` platform allows you to use integrations which are providing a demo of their implementation. The demo entities are dummies but show you how the actual platform looks like. This way you can run own demonstration instance like the online [Home Assistant demo](/demo/) but combined with your own real/functional platforms.
The `demo` {% term integration %} allows you to use integrations which are providing a demo of their implementation. The demo entities are dummies but show you how the actual platform looks like. This way you can run own demonstration instance like the online [Home Assistant demo](/demo/) but combined with your own real/functional platforms.
Available demo platforms:
@ -81,7 +84,8 @@ Available demo platforms:
- [Water heater](/integrations/water_heater/) (`water_heater`)
- [Weather](/integrations/weather/) (`weather`)
To integrate a demo platform in Home Assistant, add the following section to your `configuration.yaml` file:
To integrate a demo platform in Home Assistant, add the following section to your {% term "`configuration.yaml`" %} file.
{% include integrations/restart_ha_after_config_inclusion.md %}
```yaml
# Example configuration.yaml entry

8
source/_integrations/denon.markdown
View File

@ -9,9 +9,12 @@ ha_domain: denon
ha_platforms:
- media_player
ha_integration_type: integration
related:
- docs: /docs/configuration/
title: Configuration file
---
The `denon` platform allows you to control a Denon Network Receiver from Home Assistant. It might be that your device is supported by the [Denon AVR] platform.
The `denon` {% term integration %} allows you to control a Denon Network Receiver from Home Assistant. It might be that your device is supported by the [Denon AVR] platform.
Supported devices:
@ -20,7 +23,8 @@ Supported devices:
- Denon RCD-N9 (partial support)
- Denon AVR receivers with integrated Network support (partial support)
To add a Denon Network Receiver to your installation, add the following to your `configuration.yaml` file:
To add a Denon Network Receiver to your installation, add the following to your {% term "`configuration.yaml`" %} file.
{% include integrations/restart_ha_after_config_inclusion.md %}
## Telnet platform

8
source/_integrations/device_sun_light_trigger.markdown
View File

@ -10,9 +10,12 @@ ha_release: pre 0.7
ha_quality_scale: internal
ha_domain: device_sun_light_trigger
ha_integration_type: integration
related:
- docs: /docs/configuration/
title: Configuration file
---
Home Assistant has a built-in integration called `device_sun_light_trigger` to help you automate your lights. The integration will:
Home Assistant has a built-in {% term integration %} called `device_sun_light_trigger` to help you automate your lights. The integration will:
- Fade in the lights when the sun is setting and there are people home
- Turn on the lights when people get home after the sun has set
@ -20,7 +23,8 @@ Home Assistant has a built-in integration called `device_sun_light_trigger` to h
This integration requires the integrations [sun](/integrations/sun/), [device_tracker](/integrations/device_tracker/), [person](/integrations/person/) and [light](/integrations/light/) to be enabled.
To enable this integration, add the following lines to your `configuration.yaml` file:
To enable this integration, add the following lines to your {% term "`configuration.yaml`" %} file.
{% include integrations/restart_ha_after_config_inclusion.md %}
```yaml
# Example configuration.yaml entry

3
source/_integrations/dialogflow.markdown
View File

@ -8,6 +8,9 @@ ha_config_flow: true
ha_iot_class: Cloud Push
ha_domain: dialogflow
ha_integration_type: integration
related:
- docs: /docs/configuration/
title: Configuration file
---
The **Dialogflow** {% term integration %} is designed to be used with the [webhook](https://cloud.google.com/dialogflow/es/docs/fulfillment-webhook) integration of [Dialogflow](https://cloud.google.com/dialogflow/docs/). After each phrase a user says, Dialogflow sends an action and parameters to the webhook.

6
source/_integrations/digital_ocean.markdown
View File

@ -14,6 +14,9 @@ ha_platforms:
- binary_sensor
- switch
ha_integration_type: integration
related:
- docs: /docs/configuration/
title: Configuration file
---
The **Digital Ocean** {% term integration %} allows you to access the information about your [Digital Ocean](https://www.digitalocean.com/) droplets from Home Assistant.
@ -29,7 +32,8 @@ Obtain your API key from your [Digital Ocean dashboard](https://cloud.digitaloce
## Configuration
To integrate your Digital Ocean droplets with Home Assistant, add the following section to your `configuration.yaml` file:
To integrate your Digital Ocean droplets with Home Assistant, add the following section to your {% term "`configuration.yaml`" %} file.
{% include integrations/restart_ha_after_config_inclusion.md %}
```yaml
# Example configuration.yaml entry

8
source/_integrations/discogs.markdown
View File

@ -11,9 +11,12 @@ ha_domain: discogs
ha_platforms:
- sensor
ha_integration_type: integration
related:
- docs: /docs/configuration/
title: Configuration file
---
The `discogs` platform allows you to see the current amount of records in your [Discogs](https://www.discogs.com) collection.
The `discogs` {% term integration %} allows you to see the current amount of records in your [Discogs](https://www.discogs.com) collection.
## Setup
@ -22,7 +25,8 @@ You can generate a token from your profile's [Developer settings](https://www.di
## Configuration
To enable this sensor, add the following lines to your `configuration.yaml`:
To enable this sensor, add the following lines to your {% term "`configuration.yaml`" %} file.
{% include integrations/restart_ha_after_config_inclusion.md %}
```yaml
# Example configuration.yaml entry

8
source/_integrations/dlib_face_detect.markdown
View File

@ -7,9 +7,12 @@ ha_iot_class: Local Push
ha_release: 0.44
ha_domain: dlib_face_detect
ha_integration_type: integration
related:
- docs: /docs/configuration/
title: Configuration file
---
The `dlib_face_detect` image processing platform allows you to use the [Dlib](http://www.dlib.net/) through Home Assistant. This platform enables face detection from cameras, and can fire events with attributes.
The `dlib_face_detect` image processing {% term integration %} allows you to use the [Dlib](http://www.dlib.net/) through Home Assistant. This platform enables face detection from cameras, and can fire events with attributes.
This can be used to trigger an automation rule. Further info is on the [integration](/integrations/image_processing/) page.
@ -19,6 +22,9 @@ This integration is only available on Home Assistant Core installation types. Un
## Configuration
To enable Dlib Face Detect, add the following lines to your {% term "`configuration.yaml`" %} file.
{% include integrations/restart_ha_after_config_inclusion.md %}
```yaml
# Example configuration.yaml entry
image_processing:

8
source/_integrations/dlib_face_identify.markdown
View File

@ -7,9 +7,12 @@ ha_iot_class: Local Push
ha_release: 0.44
ha_domain: dlib_face_identify
ha_integration_type: integration
related:
- docs: /docs/configuration/
title: Configuration file
---
The `dlib_face_identify` image processing platform allows you to use the [Dlib](http://www.dlib.net/) through Home Assistant. This platform allow you to identify persons on camera and fire an event with identify persons.
The `dlib_face_identify` image processing {% term integration %} allows you to use the [Dlib](http://www.dlib.net/) through Home Assistant. This platform allow you to identify persons on camera and fire an event with identify persons.
For using the result inside an automation rule, take a look at the [integration](/integrations/image_processing/) page.
@ -19,6 +22,9 @@ This integration is only available on Home Assistant Core installation types. Un
## Configuration
To enable Dlib Face Identify, add the following lines to your {% term "`configuration.yaml`" %} file.
{% include integrations/restart_ha_after_config_inclusion.md %}
```yaml
# Example configuration.yaml entry
image_processing:

8
source/_integrations/doods.markdown
View File

@ -7,9 +7,12 @@ ha_iot_class: Local Polling
ha_release: '0.100'
ha_domain: doods
ha_integration_type: integration
related:
- docs: /docs/configuration/
title: Configuration file
---
The `doods` image processing integration allows you to detect and recognize objects in a camera image using [DOODS](https://github.com/snowzach/doods/). The state of the entity is the number of objects detected and recognized objects are listed in the `summary` attribute along with quantity. The `matches` attribute provides the confidence `score` for recognition and the bounding `box` of the object for each detection category.
The `doods` image processing {% term integration %} allows you to detect and recognize objects in a camera image using [DOODS](https://github.com/snowzach/doods/). The state of the entity is the number of objects detected and recognized objects are listed in the `summary` attribute along with quantity. The `matches` attribute provides the confidence `score` for recognition and the bounding `box` of the object for each detection category.
## Setup
@ -20,7 +23,8 @@ The DOODS software needs to be running before this integration can be used. Opti
## Configuration
To enable this integration in your installation, add the following to your `configuration.yaml` file:
To enable this integration in your installation, add the following to your {% term "`configuration.yaml`" %} file.
{% include integrations/restart_ha_after_config_inclusion.md %}
```yaml
# Example configuration.yaml entry

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