mirror of
https://github.com/home-assistant/home-assistant.io.git
synced 2025-07-23 09:17:06 +00:00
Merge branch 'current' into next
This commit is contained in:
Franck Nijhof
commit
8f53689a00
4
.github/workflows/test.yml
vendored
4
.github/workflows/test.yml
vendored
@ -8,7 +8,7 @@ jobs:
|
||||
runs-on: ubuntu-latest
|
||||
steps:
|
||||
- name: Check out files from GitHub
|
||||
uses: actions/checkout@v4.1.5
|
||||
uses: actions/checkout@v4.1.6
|
||||
- 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.5
|
||||
uses: actions/checkout@v4.1.6
|
||||
- name: Setting up Node.js
|
||||
uses: actions/setup-node@v4.0.2
|
||||
with:
|
||||
|
||||
@ -841,7 +841,7 @@ source/_integrations/ukraine_alarm.markdown @PaulAnnekov
|
||||
source/_integrations/unifi.markdown @Kane610
|
||||
source/_integrations/unifi_direct.markdown @tofuSCHNITZEL
|
||||
source/_integrations/unifiled.markdown @florisvdk
|
||||
source/_integrations/unifiprotect.markdown @AngellusMortis @bdraco
|
||||
source/_integrations/unifiprotect.markdown @bdraco
|
||||
source/_integrations/upb.markdown @gwww
|
||||
source/_integrations/upc_connect.markdown @pvizeli @fabaff
|
||||
source/_integrations/upcloud.markdown @scop
|
||||
|
||||
6
Gemfile
6
Gemfile
@ -10,8 +10,8 @@ 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.5'
|
||||
gem 'ruby-lsp', '0.16.6'
|
||||
gem 'rubocop', '1.64.0'
|
||||
gem 'ruby-lsp', '0.16.7'
|
||||
gem 'rackup', '2.1.0'
|
||||
end
|
||||
|
||||
@ -19,7 +19,7 @@ group :jekyll_plugins do
|
||||
gem 'jekyll-paginate', '1.1.0'
|
||||
gem 'jekyll-sitemap', '1.4.0'
|
||||
gem 'jekyll-commonmark', '1.4.0'
|
||||
gem 'jekyll-toc', '0.18.0'
|
||||
gem 'jekyll-toc', '0.19.0'
|
||||
end
|
||||
|
||||
gem 'sinatra', '4.0.0'
|
||||
|
||||
34
Gemfile.lock
34
Gemfile.lock
@ -5,6 +5,7 @@ GEM
|
||||
public_suffix (>= 2.0.2, < 6.0)
|
||||
ast (2.4.2)
|
||||
base64 (0.2.0)
|
||||
bigdecimal (3.1.8)
|
||||
chunky_png (1.4.0)
|
||||
colorator (1.1.0)
|
||||
commonmarker (0.23.10)
|
||||
@ -27,7 +28,8 @@ GEM
|
||||
eventmachine (1.2.7)
|
||||
ffi (1.16.3)
|
||||
forwardable-extended (2.6.0)
|
||||
google-protobuf (4.26.1-x86_64-linux)
|
||||
google-protobuf (4.27.0-x86_64-linux)
|
||||
bigdecimal
|
||||
rake (>= 13)
|
||||
http_parser.rb (0.8.0)
|
||||
i18n (1.14.5)
|
||||
@ -55,7 +57,7 @@ GEM
|
||||
sass-embedded (~> 1.54)
|
||||
jekyll-sitemap (1.4.0)
|
||||
jekyll (>= 3.7, < 5.0)
|
||||
jekyll-toc (0.18.0)
|
||||
jekyll-toc (0.19.0)
|
||||
jekyll (>= 3.9)
|
||||
nokogiri (~> 1.12)
|
||||
jekyll-watch (2.2.1)
|
||||
@ -82,9 +84,9 @@ GEM
|
||||
racc
|
||||
pathutil (0.16.2)
|
||||
forwardable-extended (~> 2.6)
|
||||
prism (0.27.0)
|
||||
prism (0.29.0)
|
||||
public_suffix (5.0.5)
|
||||
racc (1.7.3)
|
||||
racc (1.8.0)
|
||||
rack (3.0.11)
|
||||
rack-protection (4.0.0)
|
||||
base64 (>= 0.1.0)
|
||||
@ -97,12 +99,13 @@ GEM
|
||||
rainbow (3.1.1)
|
||||
rake (13.2.1)
|
||||
rb-fsevent (0.11.2)
|
||||
rb-inotify (0.10.1)
|
||||
rb-inotify (0.11.1)
|
||||
ffi (~> 1.0)
|
||||
regexp_parser (2.9.1)
|
||||
rexml (3.2.6)
|
||||
regexp_parser (2.9.2)
|
||||
rexml (3.2.8)
|
||||
strscan (>= 3.0.9)
|
||||
rouge (4.2.1)
|
||||
rubocop (1.63.5)
|
||||
rubocop (1.64.0)
|
||||
json (~> 2.3)
|
||||
language_server-protocol (>= 3.17.0)
|
||||
parallel (~> 1.10)
|
||||
@ -115,15 +118,15 @@ GEM
|
||||
unicode-display_width (>= 2.4.0, < 3.0)
|
||||
rubocop-ast (1.31.3)
|
||||
parser (>= 3.3.1.0)
|
||||
ruby-lsp (0.16.6)
|
||||
ruby-lsp (0.16.7)
|
||||
language_server-protocol (~> 3.17.0)
|
||||
prism (>= 0.23.0, < 0.28)
|
||||
prism (>= 0.29.0, < 0.30)
|
||||
sorbet-runtime (>= 0.5.10782)
|
||||
ruby-progressbar (1.13.0)
|
||||
ruby2_keywords (0.0.5)
|
||||
safe_yaml (1.0.5)
|
||||
sass (3.4.25)
|
||||
sass-embedded (1.77.1-x86_64-linux-gnu)
|
||||
sass-embedded (1.77.2-x86_64-linux-gnu)
|
||||
google-protobuf (>= 3.25, < 5.0)
|
||||
sass-globbing (1.1.5)
|
||||
sass (>= 3.1)
|
||||
@ -135,8 +138,9 @@ GEM
|
||||
rack-protection (= 4.0.0)
|
||||
rack-session (>= 2.0.0, < 3)
|
||||
tilt (~> 2.0)
|
||||
sorbet-runtime (0.5.11375)
|
||||
sorbet-runtime (0.5.11391)
|
||||
stringex (2.8.6)
|
||||
strscan (3.1.0)
|
||||
terminal-table (3.0.2)
|
||||
unicode-display_width (>= 1.1.1, < 3)
|
||||
tilt (2.3.0)
|
||||
@ -156,12 +160,12 @@ DEPENDENCIES
|
||||
jekyll-commonmark (= 1.4.0)
|
||||
jekyll-paginate (= 1.1.0)
|
||||
jekyll-sitemap (= 1.4.0)
|
||||
jekyll-toc (= 0.18.0)
|
||||
jekyll-toc (= 0.19.0)
|
||||
nokogiri (= 1.16.5)
|
||||
rackup (= 2.1.0)
|
||||
rake (= 13.2.1)
|
||||
rubocop (= 1.63.5)
|
||||
ruby-lsp (= 0.16.6)
|
||||
rubocop (= 1.64.0)
|
||||
ruby-lsp (= 0.16.7)
|
||||
sass-globbing (= 1.1.5)
|
||||
sassc (= 2.1.0)
|
||||
sinatra (= 4.0.0)
|
||||
|
||||
@ -110,8 +110,8 @@ social:
|
||||
# Home Assistant release details
|
||||
current_major_version: 2024
|
||||
current_minor_version: 5
|
||||
current_patch_version: 3
|
||||
date_released: 2024-05-10
|
||||
current_patch_version: 5
|
||||
date_released: 2024-05-24
|
||||
|
||||
# Either # or the anchor link to latest release notes in the blog post.
|
||||
# Must be prefixed with a # and have double quotes around it.
|
||||
|
||||
8
package-lock.json
generated
8
package-lock.json
generated
@ -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": "^5.0.0"
|
||||
"textlint-rule-terminology": "^5.0.9"
|
||||
}
|
||||
},
|
||||
"node_modules/@aashutoshrathi/word-wrap": {
|
||||
@ -6113,9 +6113,9 @@
|
||||
}
|
||||
},
|
||||
"node_modules/textlint-rule-terminology": {
|
||||
"version": "5.0.0",
|
||||
"resolved": "https://registry.npmjs.org/textlint-rule-terminology/-/textlint-rule-terminology-5.0.0.tgz",
|
||||
"integrity": "sha512-z9RFKWTkt5m0fkEFwOYHq9QaMDsLc2dnNTZ5NybfW5oyp1iITPZOepV8EQYnrQJmPVgZflIpioUqzkDb0tUB8w==",
|
||||
"version": "5.0.9",
|
||||
"resolved": "https://registry.npmjs.org/textlint-rule-terminology/-/textlint-rule-terminology-5.0.9.tgz",
|
||||
"integrity": "sha512-+6z9J8plZEtJdnaWyj0qpPtQBKEW9dq+a9mfJzOA6ZseHycnvlQzD66toyLBgm4XoGUe8ZNabS0h/eVYvY7Yyw==",
|
||||
"dev": true,
|
||||
"dependencies": {
|
||||
"lodash": "^4.17.15",
|
||||
|
||||
@ -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": "^5.0.0"
|
||||
"textlint-rule-terminology": "^5.0.9"
|
||||
},
|
||||
"resolutions": {
|
||||
"minimist": ">=1.2.5"
|
||||
|
||||
@ -24,7 +24,7 @@ Screenshot of the history graph card, when the sensor has a `unit_of_measurement
|
||||
|
||||
{% include dashboard/edit_dashboard.md %}
|
||||
|
||||
All options for this card can be configured via the user interface.
|
||||
Only the y-axis and logarithmic scale settings can be configured via the user interface. To configure the other options for this card, you need to edit the YAML configuration.
|
||||
|
||||
## YAML configuration
|
||||
|
||||
|
||||
@ -6,7 +6,7 @@ description: "The tile card gives you a quick overview of your entity. The card
|
||||
related:
|
||||
- docs: /dashboards/actions/
|
||||
title: Card actions
|
||||
- docs: /dashboards/features
|
||||
- docs: /dashboards/features/
|
||||
title: Card features
|
||||
- docs: /dashboards/cards/
|
||||
title: Dashboard cards
|
||||
@ -137,3 +137,15 @@ features:
|
||||
|
||||
You want to colorize the tile card? Choose one of the following colors: `primary`, `accent`, `disabled`, `red`, `pink`, `purple`, `deep-purple`, `indigo`, `blue`, `light-blue`, `cyan`, `teal`, `green`, `light-green`, `lime`, `yellow`, `amber`, `orange`, `deep-orange`, `brown`, `grey`, `blue-grey`, `black` and `white`.
|
||||
|
||||
## Reordering features
|
||||
|
||||
Some features of the tile card, such as the presets or the HVAC modes of a
|
||||
thermostat, can show many buttons. While you can limit the buttons you’d
|
||||
like to see, they may not be in the desired order.
|
||||
|
||||
For your thermostat, that means you can reorder the HVAC modes or presets.
|
||||
|
||||
<p class='img'>
|
||||
<img src="/images/blog/2024-05/tile-card-reorder-features.gif" alt=" Screen recording showing how you can now reorder the HVAC modes on the thermostat shown in a tile card."/>
|
||||
You can now reorder the features of the tile card.
|
||||
</p>
|
||||
|
||||
4609
source/_data/countries.yaml
Normal file
4609
source/_data/countries.yaml
Normal file
File diff suppressed because it is too large
Load Diff
@ -24,7 +24,7 @@ Home Assistant generates a secret key which is synchronized with an app on your
|
||||
|
||||
#### Setting up TOTP
|
||||
|
||||
Enable TOTP in your `configuration.yaml` like this:
|
||||
Enable TOTP in your {% term "`configuration.yaml`" %} like this:
|
||||
|
||||
```yaml
|
||||
homeassistant:
|
||||
@ -64,7 +64,7 @@ The Notify MFA module uses the [notify integration](/integrations/notify/) to se
|
||||
|
||||
#### Setting up MFA notify
|
||||
|
||||
Add Notify MFA to your `configuration.yaml` file like this:
|
||||
Add Notify MFA to your {% term "`configuration.yaml`" %} file like this:
|
||||
|
||||
```yaml
|
||||
homeassistant:
|
||||
|
||||
@ -1,6 +1,9 @@
|
||||
---
|
||||
title: "Authentication providers"
|
||||
description: "Guide on configuring different authentication providers."
|
||||
related:
|
||||
- docs: /docs/configuration/
|
||||
title: configuration.yaml file
|
||||
---
|
||||
|
||||
<div class='note warning'>
|
||||
@ -13,13 +16,13 @@ When you log in, an _auth provider_ checks your credentials to make sure you are
|
||||
|
||||
<div class='note warning'>
|
||||
|
||||
Home Assistant automatically configures the standard auth providers so you don't need to specify `auth_providers` in your `configuration.yaml` file unless you are configuring more than one. Specifying `auth_providers` will disable all auth providers that are not listed, so you could reduce your security or create difficulties logging in if it is not configured correctly.
|
||||
Home Assistant automatically configures the standard auth providers so you don't need to specify `auth_providers` in your {% term "`configuration.yaml`" %} file unless you are configuring more than one. Specifying `auth_providers` will disable all auth providers that are not listed, so you could reduce your security or create difficulties logging in if it is not configured correctly.
|
||||
|
||||
If you decide to use `trusted_networks` as your `auth_provider` there won't be a way to authenticate for a device outside of your listed trusted network. To overcome this ensure you add the default `auth_provider` with `type: homeassistant` back in manually. This will then present you with the default auth login screen when trusted network authentication fails as expected from outside your LAN.
|
||||
|
||||
</div>
|
||||
|
||||
Authentication providers are configured in your `configuration.yaml` under the `homeassistant:` block.
|
||||
Authentication providers are configured in your {% term "`configuration.yaml`" %} file under the `homeassistant:` block.
|
||||
If you are moving configuration to packages, this particular configuration must stay within 'configuration.yaml'. See Issue 16441 in the warning block at the bottom of this page.
|
||||
|
||||
|
||||
@ -44,7 +47,7 @@ User details are stored in the `[your config]/.storage` directory. All password
|
||||
|
||||
Users can be managed in Home Assistant by the owner. Go to the configuration panel and click on _{% my users %}_.
|
||||
|
||||
This is the entry in `configuration.yaml` for Home Assistant auth:
|
||||
This is the entry in {% term "`configuration.yaml`" %} for Home Assistant auth:
|
||||
|
||||
```yaml
|
||||
homeassistant:
|
||||
@ -52,7 +55,7 @@ homeassistant:
|
||||
- type: homeassistant
|
||||
```
|
||||
|
||||
If you don't specify any `auth_providers` section in the `configuration.yaml` file then this provider will be set up automatically.
|
||||
If you don't specify any `auth_providers` section in the {% term "`configuration.yaml`" %} file then this provider will be set up automatically.
|
||||
|
||||
### Trusted networks
|
||||
|
||||
@ -72,7 +75,7 @@ You cannot trust a network that you are using in any [trusted_proxies](/integrat
|
||||
|
||||
</div>
|
||||
|
||||
Here is an example in `configuration.yaml` to set up Trusted Networks:
|
||||
Here is an example in {% term "`configuration.yaml`" %} to set up Trusted Networks:
|
||||
|
||||
```yaml
|
||||
homeassistant:
|
||||
|
||||
@ -39,4 +39,4 @@ Automations created or edited via the user interface are activated immediately a
|
||||
|
||||
## Troubleshooting missing automations
|
||||
|
||||
When you're creating automations using the GUI and they don't appear in the UI, make sure that you add back `automation: !include automations.yaml` from the default configuration to your `configuration.yaml`.
|
||||
When you're creating automations using the GUI and they don't appear in the UI, make sure that you add back `automation: !include automations.yaml` from the default configuration to your {% term "`configuration.yaml`" %}.
|
||||
|
||||
@ -215,7 +215,7 @@ automation:
|
||||
|
||||
## Numeric state trigger
|
||||
|
||||
Fires when the numeric value of an entity's state (or attribute's value if using the `attribute` property, or the calculated value if using the `value_template` property) **crosses** a given threshold. On state change of a specified entity, attempts to parse the state as a number and fires if the value is changing from above to below or from below to above the given threshold.
|
||||
Fires when the numeric value of an entity's state (or attribute's value if using the `attribute` property, or the calculated value if using the `value_template` property) **crosses** a given threshold (equal excluded). On state change of a specified entity, attempts to parse the state as a number and fires if the value is changing from above to below or from below to above the given threshold (equal excluded).
|
||||
|
||||
<div class='note'>
|
||||
Crossing the threshold means that the trigger only fires if the state wasn't previously within the threshold.
|
||||
|
||||
@ -91,4 +91,4 @@ Learn more about blueprints by [reading our tutorial on creating a blueprint](/d
|
||||
|
||||
## Troubleshooting missing automations
|
||||
|
||||
When you're creating automations using blueprints and they don't appear in the UI, make sure that you add back `automation: !include automations.yaml` from the default configuration to your `configuration.yaml`.
|
||||
When you're creating automations using blueprints and they don't appear in the UI, make sure that you add back `automation: !include automations.yaml` from the default configuration to your {% term "`configuration.yaml`" %}.
|
||||
|
||||
@ -7,7 +7,7 @@ Automations are created in Home Assistant via the UI, but are stored in a YAML f
|
||||
|
||||
The UI will write your automations to `automations.yaml`. This file is managed by the UI and should not be edited manually.
|
||||
|
||||
It is also possible to write your automations directly inside `configuration.yaml` or other YAML files. You can do this by adding a labeled `automation` block to your `configuration.yaml`:
|
||||
It is also possible to write your automations directly inside {% term "`configuration.yaml`" %} or other YAML files. You can do this by adding a labeled `automation` block to your `configuration.yaml`:
|
||||
|
||||
```yaml
|
||||
# The configuration required for the UI to work
|
||||
@ -128,7 +128,7 @@ Mode | Description
|
||||
|
||||
## YAML example
|
||||
|
||||
Example of a YAML based automation that you can add to `configuration.yaml`.
|
||||
Example of a YAML based automation that you can add to {% term "`configuration.yaml`" %}.
|
||||
|
||||
{% raw %}
|
||||
|
||||
|
||||
@ -137,7 +137,7 @@ For more information on blueprint inputs, refer to the documentation of the [blu
|
||||
|
||||
With the bare minimum metadata added, your blueprint is ready to use.
|
||||
|
||||
Open your `configuration.yaml` and add the following:
|
||||
Open your {% term "`configuration.yaml`" %} and add the following:
|
||||
|
||||
```yaml
|
||||
automation tutorial:
|
||||
@ -202,7 +202,6 @@ blueprint:
|
||||
selector:
|
||||
target:
|
||||
entity:
|
||||
filter:
|
||||
- domain: light
|
||||
```
|
||||
|
||||
@ -234,7 +233,6 @@ blueprint:
|
||||
selector:
|
||||
target:
|
||||
entity:
|
||||
filter:
|
||||
- domain: light
|
||||
|
||||
trigger:
|
||||
|
||||
@ -38,23 +38,23 @@ File access depends on your [installation method](/installation/#advanced-instal
|
||||
|
||||
1. To set up file access, follow the steps for your [installation method](/installation/#advanced-installation-methods):
|
||||
|
||||
- [Configuring file access on the Operating System](/common-tasks/os/#configuring-access-to-files)
|
||||
- [Configure file access on the Operating System](/common-tasks/os/#configuring-access-to-files):
|
||||
- If you are unsure which option to choose, install the [file editor add-on](/common-tasks/os/#installing-and-using-the-file-editor-add-on).
|
||||
- Alternatively, use the [VS Code add-on](/common-tasks/os/#installing-and-using-the-visual-studio-code-vsc-add-on). This editor offers live syntax checking and auto-fill of various Home Assistant entities. But it looks more complex than the file editor.
|
||||
- If you prefer to use a file editor on your computer, use the [Samba add-on](/common-tasks/os/#installing-and-using-the-samba-add-on).
|
||||
- [Configuring file access on Supervised](/common-tasks/supervised/#configuring-access-to-files)
|
||||
- [File editor add-on](/common-tasks/supervised/#installing-and-using-the-file-editor-add-on).
|
||||
- [VS Code add-on](/common-tasks/supervised/#installing-and-using-the-visual-studio-code-vsc-add-on).
|
||||
- [Samba add-on](/common-tasks/supervised/#installing-and-using-the-samba-add-on).
|
||||
- [Configure file access on Supervised](/common-tasks/supervised/#configuring-access-to-files):
|
||||
- Using the [File editor add-on](/common-tasks/supervised/#installing-and-using-the-file-editor-add-on).
|
||||
- Using the [VS Code add-on](/common-tasks/supervised/#installing-and-using-the-visual-studio-code-vsc-add-on).
|
||||
- Using the [Samba add-on](/common-tasks/supervised/#installing-and-using-the-samba-add-on).
|
||||
|
||||
2. To look up the to your configuration directory, go to {% my system_health title="**Settings** > **System** > **Repairs**" %}.
|
||||
2. To look up the path to your configuration directory, go to {% my system_health title="**Settings** > **System** > **Repairs**" %}.
|
||||
- Select the three dots menu and select **System information**.
|
||||
|
||||
|
||||
|
||||
3. Find out the location of the **Configuration directory**.
|
||||
|
||||
|
||||
|
||||
- Unless you changed the file structure, the default is as follows: -
|
||||
- {% term "Home Assistant Operating System" %}: the `configuration.yaml` is in the `/config` folder of the installation.
|
||||
- {% term "Home Assistant Container" %}: the `configuration.yaml` is in the config folder that you mounted in your container.
|
||||
|
||||
@ -23,8 +23,8 @@ To change the general settings that were defined during onboarding, follow these
|
||||
2. To change network-related configuration, such as the network name, go to {% my network title="**Settings** > **System** > **Network**" %}.
|
||||
3. If some of the settings are not visible, you may need to enable **Advanced mode**.
|
||||
- In the bottom left, select your user name to go to your {% my profile title="**User profile**" %}, and enable **Advanced mode**.
|
||||
4. **Troubleshooting**: If any of the settings are grayed out and can't be edited, this is because they are defined in the [`configuration.yaml` file](/docs/configuration/).
|
||||
- If you prefer editing the settings in the UI, you have to delete these entries from the [`configuration.yaml` file](/docs/configuration/).
|
||||
4. **Troubleshooting**: If any of the settings are grayed out and can't be edited, this is because they are defined in the {% term "`configuration.yaml`" %} file.
|
||||
- If you prefer editing the settings in the UI, you have to delete these entries from the {% term "`configuration.yaml`" %} file.
|
||||
- For more information about the general settings in YAML, refer to the [Home Assistant Core integration documentation](/integrations/homeassistant/).
|
||||
|
||||
|
||||
|
||||
@ -4,7 +4,8 @@ description: "Simple customization for entities."
|
||||
related:
|
||||
- docs: /integrations/homeassistant/
|
||||
- docs: /docs/configuration/
|
||||
title: Home Assistant Core integration documentation
|
||||
title: configuration.yaml file
|
||||
- docs: /docs/configuration/troubleshooting/
|
||||
---
|
||||
|
||||
## Changing entity name and entity ID
|
||||
@ -19,8 +20,10 @@ To change the entity ID and friendly name of supported entities, follow these st
|
||||
|
||||
|
||||
3. Enter the new name or the new entity ID.
|
||||
- For example, the entity ID here could be `light.bedroom_ligthstrip`.
|
||||
- Do not change the domain of the entity - the part before the `.`.
|
||||
- For example, the entity ID here could be `light.bedroom_lightstrip_3`.
|
||||
- Do not change the domain of the entity - the part before the `.` (period).
|
||||
- You can use lowercase letters, numbers, and underscores.
|
||||
- The name must not start or end with an underscore.
|
||||
|
||||
|
||||
|
||||
@ -30,4 +33,4 @@ To change the entity ID and friendly name of supported entities, follow these st
|
||||
|
||||
|
||||
|
||||
If your entity is not supported, or you cannot customize what you need via this method, you need to edit the settings in your [`configuration.yaml` file](/docs/configuration/). For a detailed description of the entity configuration variables and device class information, refer to the [Home Assistant Core integration documentation](/integrations/homeassistant/).
|
||||
If your entity is not supported, or you cannot customize what you need via this method, you need to edit the settings in your {% term "`configuration.yaml`" %} file. For a detailed description of the entity configuration variables and device class information, refer to the [Home Assistant Core integration documentation](/integrations/homeassistant/).
|
||||
|
||||
@ -19,7 +19,7 @@ The package configuration can include: `switch`, `light`, `automation`, `groups`
|
||||
|
||||
It can be specified inline or in a separate YAML file using `!include`.
|
||||
|
||||
Inline example, main `configuration.yaml`:
|
||||
Inline example, main {% term "`configuration.yaml`" %}:
|
||||
|
||||
```yaml
|
||||
homeassistant:
|
||||
@ -34,7 +34,7 @@ homeassistant:
|
||||
...
|
||||
```
|
||||
|
||||
Include example, main `configuration.yaml`:
|
||||
Include example, main {% term "`configuration.yaml`" %}:
|
||||
|
||||
```yaml
|
||||
homeassistant:
|
||||
@ -74,7 +74,7 @@ Integrations inside packages can only specify platform entries using configurati
|
||||
|
||||
## Create a packages folder
|
||||
|
||||
One way to organize packages is to create a folder named "packages" in your Home Assistant configuration directory. In the packages directory, you can store any number of packages in a YAML file. This entry in your `configuration.yaml` will load all YAML-files in this _packages_ folder and its subfolders:
|
||||
One way to organize packages is to create a folder named "packages" in your Home Assistant configuration directory. In the packages directory, you can store any number of packages in a YAML file. This entry in your {% term "`configuration.yaml`" %} will load all YAML-files in this _packages_ folder and its subfolders:
|
||||
|
||||
```yaml
|
||||
homeassistant:
|
||||
|
||||
@ -1,6 +1,11 @@
|
||||
---
|
||||
title: "Remote access"
|
||||
description: "Setting up remote access for Home Assistant."
|
||||
related:
|
||||
- docs: /docs/configuration/securing/
|
||||
title: Securing your instance
|
||||
- url: https://www.nabucasa.com/config/remote/
|
||||
title: Home Assistant Cloud - remote access
|
||||
---
|
||||
|
||||
If you're interested in logging in to Home Assistant while away, you'll have to make your instance remotely accessible. Below are a few options to do this.
|
||||
|
||||
@ -6,15 +6,17 @@ related:
|
||||
title: configuration.yaml file
|
||||
- docs: /docs/configuration/splitting_configuration/
|
||||
title: Splitting the configuration
|
||||
- docs: /docs/configuration/securing/
|
||||
title: Securing your instance
|
||||
---
|
||||
|
||||
The `configuration.yaml` file is a plain-text file, thus it is readable by anyone who has access to the file. The file contains passwords and API tokens which need to be redacted if you want to share your configuration. By using `!secret` you can remove any private information from your configuration files. This separation can also help you to keep easier track of your passwords and API keys, as they are all stored at one place and no longer spread across the `configuration.yaml` file or even multiple YAML files if you [split up your configuration](/docs/configuration/splitting_configuration/).
|
||||
The {% term "`configuration.yaml`" %} file is a plain-text file, thus it is readable by anyone who has access to the file. The file contains passwords and API tokens which need to be redacted if you want to share your configuration. By using `!secret` you can remove any private information from your configuration files. This separation can also help you to keep easier track of your passwords and API keys, as they are all stored at one place and no longer spread across the {% term "`configuration.yaml`" %} file or even multiple YAML files if you [split up your configuration](/docs/configuration/splitting_configuration/).
|
||||
|
||||
## Using `secrets.yaml`
|
||||
|
||||
The workflow for moving private information to `secrets.yaml` is very similar to the [splitting of the configuration](/docs/configuration/splitting_configuration/). Create a `secrets.yaml` file in your Home Assistant [configuration directory](/docs/configuration/).
|
||||
|
||||
The entries for password and API keys in the `configuration.yaml` file usually looks like the example below.
|
||||
The entries for password and API keys in the {% term "`configuration.yaml`" %} file usually looks like the example below.
|
||||
|
||||
```yaml
|
||||
rest:
|
||||
@ -45,7 +47,7 @@ rest_password: "YOUR_PASSWORD"
|
||||
When you start splitting your configuration into multiple files, you might end up with configuration in sub folders. Secrets will be resolved in this order:
|
||||
|
||||
- A `secrets.yaml` located in the same folder as the YAML file referencing the secret,
|
||||
- next, parent folders will be searched for a `secrets.yaml` file with the secret, stopping at the folder with the main `configuration.yaml`.
|
||||
- next, parent folders will be searched for a `secrets.yaml` file with the secret, stopping at the folder with the main {% term "`configuration.yaml`" %}.
|
||||
|
||||
To see where secrets are being loaded from, you can either add an option to your `secrets.yaml` file or use the `check_config` script. The latter is only available for {% term "Home Assistant Core" %} installations given it's available through [`hass`](/docs/tools/hass/).
|
||||
|
||||
|
||||
@ -1,6 +1,15 @@
|
||||
---
|
||||
title: "Securing"
|
||||
description: "Instructions on how to secure your Home Assistant installation."
|
||||
|
||||
related:
|
||||
- docs: /docs/configuration/
|
||||
- docs: /docs/configuration/secrets/
|
||||
title: Secrets.yaml file
|
||||
- docs: /cloud/
|
||||
title: Home Assistant Cloud
|
||||
- url: https://nabucasa.com/config/
|
||||
title: Nabu Casa
|
||||
---
|
||||
|
||||
One major advantage of Home Assistant is that it is not dependent on cloud services. Even if you are only using Home Assistant on a local network, you should take steps to secure your instance.
|
||||
@ -9,9 +18,9 @@ One major advantage of Home Assistant is that it is not dependent on cloud servi
|
||||
|
||||
Here's the summary of what you *must* do to secure your Home Assistant system:
|
||||
|
||||
- Centralize sensitive data in [secrets](/docs/configuration/secrets/) (but do remember to back them up)
|
||||
- Centralize sensitive data in [secrets](/docs/configuration/secrets/) (but do remember to back them up).
|
||||
- **Note**: Storing secrets in `secrets.yaml` does not encrypt them.
|
||||
- Regularly keep the system up to date
|
||||
- Regularly keep the system up to date.
|
||||
|
||||
## Remote access
|
||||
|
||||
@ -23,9 +32,9 @@ To expose your instance to the internet, use a [VPN](https://pivpn.io), or an [S
|
||||
|
||||
### Extras for manual installations
|
||||
|
||||
Besides the above we advise that you consider the following to improve security:
|
||||
Besides the above, we advise that you consider the following to improve security:
|
||||
|
||||
- For systems that use SSH set `PermitRootLogin no` in your sshd configuration (usually `/etc/ssh/sshd_config`) and to use SSH keys for authentication instead of passwords. This is particularly important if you enable remote access to your SSH services.
|
||||
- For systems that use SSH, set `PermitRootLogin no` in your sshd configuration (usually `/etc/ssh/sshd_config`) and use SSH keys for authentication instead of passwords. This is particularly important if you enable remote access to your SSH services.
|
||||
- Lock down the host following good practice guidance, for example:
|
||||
- [Securing Debian Manual](https://www.debian.org/doc/manuals/securing-debian-manual/index.en.html) (this also applies to Raspberry Pi OS)
|
||||
- [Red Hat Enterprise Linux 7 Security Guide](https://access.redhat.com/documentation/en-us/red_hat_enterprise_linux/7/html/security_guide/index), [CIS Red Hat Enterprise Linux 7 Benchmark](https://www.cisecurity.org/cis-benchmarks/)
|
||||
|
||||
@ -10,7 +10,7 @@ related:
|
||||
title: Using packages to organize configuration files
|
||||
---
|
||||
|
||||
So you've been using Home Assistant for a while now and your `configuration.yaml` file brings people to tears because it has become so large. Or, you simply want to start off with the distributed approach. Here's how to split the `configuration.yaml` into more manageable (read: human-readable) pieces.
|
||||
So you've been using Home Assistant for a while now and your {% term "`configuration.yaml`" %} file brings people to tears because it has become so large. Or, you simply want to start off with the distributed approach. Here's how to split the {% term "`configuration.yaml`" %} into more manageable (read: human-readable) pieces.
|
||||
|
||||
## Example configuration files for inspiration
|
||||
|
||||
@ -22,7 +22,7 @@ As commenting code doesn't always happen, please read on to learn in detail how
|
||||
|
||||
In this section, we are going use some example configuration files and look at their structure and format in more detail.
|
||||
|
||||
Now you might think that the `configuration.yaml` will be replaced during the splitting process. However, it will in fact remain, albeit in a much less cluttered form.
|
||||
Now you might think that the {% term "`configuration.yaml`" %} will be replaced during the splitting process. However, it will in fact remain, albeit in a much less cluttered form.
|
||||
|
||||
### The core configuration file
|
||||
|
||||
|
||||
@ -900,7 +900,7 @@ Examples:
|
||||
|
||||
Not supported in [limited templates](#limited-templates).
|
||||
|
||||
- `distance()` will measure the distance in kilometers between home, entity, coordinates.
|
||||
- `distance()` measures the distance between home, an entity, or coordinates. The unit of measurement (kilometers or miles) depends on the system's configuration settings.
|
||||
- `closest()` will find the closest entity.
|
||||
|
||||
#### Distance examples
|
||||
|
||||
@ -1,6 +1,10 @@
|
||||
---
|
||||
title: "Troubleshooting your configuration"
|
||||
description: "Common problems with tweaking your configuration and their solutions."
|
||||
related:
|
||||
- docs: /docs/configuration/
|
||||
- docs: /docs/configuration/customizing-devices/
|
||||
title: Changing entity name and ID
|
||||
---
|
||||
|
||||
It can happen that you run into trouble while configuring Home Assistant. Perhaps an integration is not showing up or is acting strangely. This page will discuss a few of the most common problems.
|
||||
@ -17,7 +21,7 @@ If you have incorrect entries in your configuration files you can use the config
|
||||
|
||||
### Problems with the configuration
|
||||
|
||||
One of the most common problems with Home Assistant is an invalid `configuration.yaml` or other configuration file.
|
||||
One of the most common problems with Home Assistant is an invalid {% term "`configuration.yaml`" %} or other configuration file.
|
||||
|
||||
- Home Assistant provides a CLI that allows you to see how it interprets them, each installation type has its own section in the common-tasks about this:
|
||||
- [Operating System](/common-tasks/os/#configuration-check)
|
||||
@ -25,7 +29,7 @@ One of the most common problems with Home Assistant is an invalid `configuration
|
||||
- [Core](/common-tasks/core/#configuration-check)
|
||||
- [Supervised](/common-tasks/supervised/#configuration-check)
|
||||
|
||||
- The configuration files, including `configuration.yaml` must be UTF-8 encoded. If you see error like `'utf-8' codec can't decode byte`, edit the offending configuration and re-save it as UTF-8.
|
||||
- The configuration files, including {% term "`configuration.yaml`" %} must be UTF-8 encoded. If you see error like `'utf-8' codec can't decode byte`, edit the offending configuration and re-save it as UTF-8.
|
||||
- You can verify your configuration's YAML structure using [this online YAML parser](https://yaml-online-parser.appspot.com/) or [YAML Validator](https://codebeautify.org/yaml-validator/).
|
||||
- To learn more about the quirks of YAML, read [YAML IDIOSYNCRASIES](https://docs.saltproject.io/en/latest/topics/troubleshooting/yaml_idiosyncrasies.html) by SaltStack (the examples there are specific to SaltStack, but do explain YAML issues well).
|
||||
|
||||
@ -96,7 +100,9 @@ The only characters valid in entity names are:
|
||||
- Numbers
|
||||
- Underscores
|
||||
|
||||
If you create an entity with other characters then Home Assistant may not generate an error for that entity. However you will find that attempts to use that entity will generate errors (or possibly fail silently).
|
||||
The entity name must not start or end with an underscore. If you create an entity with other characters from the UI, Home Assistant validates the name. If you change the name directly in the YAML file, then Home Assistant may not generate an error for that entity. However, attempts to use that entity will generate errors (or possibly fail silently).
|
||||
|
||||
For instructions on how to change an entity name, refer to the section on [changing entity name and entity ID](/docs/configuration/customizing-devices/#changing-entity-name-and-entity-id).
|
||||
|
||||
## Debug logs and diagnostics
|
||||
|
||||
@ -126,7 +132,7 @@ After you download logs, you will also want to download the diagnostics for the
|
||||
|
||||
### Handling unexpected restarts or crashes
|
||||
|
||||
Suppose you find that Home Assistant unexpectedly restarts or crashes; it's likely that you have a misbehaving integration impacting system stability. Home Assistant has a built-in debug option that can help find implementation errors. It can also block many unsafe thread operations from crashing the system. Enabling debug has a slight performance impact on the system and is not recommended for long-term use. To enable debug, add the following to your `configuration.yaml`:
|
||||
Suppose you find that Home Assistant unexpectedly restarts or crashes; it's likely that you have a misbehaving integration impacting system stability. Home Assistant has a built-in debug option that can help find implementation errors. It can also block many unsafe thread operations from crashing the system. Enabling debug has a slight performance impact on the system and is not recommended for long-term use. To enable debug, add the following to your {% term "`configuration.yaml`" %}:
|
||||
|
||||
```yaml
|
||||
homeassistant:
|
||||
|
||||
@ -31,7 +31,7 @@ To accomplish such, you can use the [utility_meter integration](/integrations/ut
|
||||
|
||||
## The energy dashboard is not visible
|
||||
|
||||
If you do not see the Energy dashboard in the sidebar, make sure you have not removed [`default_config:`](/integrations/default_config/) from your `configuration.yaml`. If you have, you will need to add the `energy:` integration manually.
|
||||
If you do not see the Energy dashboard in the sidebar, make sure you have not removed [`default_config:`](/integrations/default_config/) from your {% term "`configuration.yaml`" %}. If you have, you will need to add the `energy:` integration manually.
|
||||
|
||||
## Troubleshooting missing entities
|
||||
|
||||
|
||||
@ -31,4 +31,4 @@ We have worked with creator [Marcel Zuidwijk](https://www.zuidwijk.com) to devel
|
||||
|
||||
#### Read the Gas Meter using a magnetometer
|
||||
|
||||
[Diaphragm/bellows gas meters](https://en.wikipedia.org/wiki/Gas_meter#Diaphragm/bellows_meters) are the most common type of gas meter, seen in almost all residential installations, and their movement can frequently be observed with a magnetometer. The [QMC5883L](https://esphome.io/components/sensor/qmc5883l.html) is a common and inexpensive option that ESPHome supports. A project that makes it easy to use this magnetometer and calibrate it is [this water-gas-meter project on GitHub](https://github.com/tronikos/esphome-magnetometer-water-gas-meter).
|
||||
[Diaphragm/bellows gas meters](https://en.wikipedia.org/wiki/Gas_meter#Diaphragm/bellows_meters) are the most common type of gas meter, seen in almost all residential installations, and their movement can frequently be observed with a magnetometer. The [QMC5883L](https://esphome.io/components/sensor/qmc5883l.html) and [HMC5883L](https://esphome.io/components/sensor/hmc5883l.html) are common and inexpensive options that ESPHome supports. A project that makes it easy to use these magnetometers and calibrate them is [this water-gas-meter project on GitHub](https://github.com/tronikos/esphome-magnetometer-water-gas-meter).
|
||||
|
||||
@ -64,7 +64,7 @@ Maybe you like to build one yourself?
|
||||
- [AI-on-the-edge-device](https://github.com/jomjol/AI-on-the-edge-device) is a project running on an ESP32-CAM and can be fully integrated into Home Assistant using the Home Assistant Discovery Functionality of MQTT. It digitalizes your gas/water/electricity meter display and provides its data in various ways.
|
||||
- [watermeter](https://github.com/nohn/watermeter) running classic OCR and statistical pattern recognition on any system supporting Docker
|
||||
- [Muino water meter reader 3-phase](https://muino.nl/product/3-phase-muino-light-sensor-encoder/) Using the 3-phase sensor technique, a battery-powered version can be possible with this sensor.
|
||||
- [Read water meter with magnetometer](https://github.com/tronikos/esphome-magnetometer-water-gas-meter) using [QMC5883L](https://esphome.io/components/sensor/qmc5883l.html), a common and inexpensive magnetometer. This should be compatible with all the water meters the Flume water sensor is compatible with, which is [compatible](https://help.flumewater.com/en/articles/1618594-is-the-flume-device-compatible-with-all-water-meters) with about 95% of water meters in the United States.
|
||||
- [Read water meter with magnetometer](https://github.com/tronikos/esphome-magnetometer-water-gas-meter) using [QMC5883L](https://esphome.io/components/sensor/qmc5883l.html) or [HMC5883L](https://esphome.io/components/sensor/hmc5883l.html), common and inexpensive magnetometers. This should be compatible with all the water meters the Flume water sensor is compatible with, which is [compatible](https://help.flumewater.com/en/articles/1618594-is-the-flume-device-compatible-with-all-water-meters) with about 95% of water meters in the United States.
|
||||
|
||||
If you manually integrate your sensors, for example, using the [MQTT](/integrations/mqtt) or [RESTful](/integrations/rest) integrations: Make sure you set and provide the `device_class`, `state_class`, and `unit_of_measurement` for those sensors.
|
||||
|
||||
|
||||
@ -56,9 +56,9 @@ Use this procedure only if the following conditions are met:
|
||||
- [Using the terminal](https://green.home-assistant.io/guides/use-terminal/)
|
||||
- If you are using another board, connect a keyboard and monitor to your device and access the terminal. The procedure is likely very similar to the one described for the Green in the step above.
|
||||
2. Once you have opened the Home Assistant command line, enter the following command:
|
||||
- Note: `existing_user` is a placeholder. Replace it with your user name.
|
||||
- Note: `existing_user` is a placeholder. Replace it with your username.
|
||||
- Note: `new_password` is a placeholder. Replace it with your new password.
|
||||
- **Command**: `auth reset --username existing_user --password new_password`
|
||||
- **Command**: `ha auth reset --username existing_user --password new_password`
|
||||
- **Troubleshooting**: If you see the message `zsh: command not found: auth`, you likely did not enter the command in the serial console connected to the device itself, but in the terminal within Home Assistant.
|
||||
3. You can now log in to Home Assistant using this new password.
|
||||
|
||||
|
||||
@ -9,7 +9,7 @@ The Integration Quality Scale scores each integration based on the code quality
|
||||
|
||||
## No score
|
||||
|
||||
This integration passes the bare minimum requirements. That's the level of most integrations when they are introduced into Home Assistant. It doesn't mean that they are bad or buggy, just that you need to configure them with an entry in your `configuration.yaml` file.
|
||||
This integration passes the bare minimum requirements. That's the level of most integrations when they are introduced into Home Assistant. It doesn't mean that they are bad or buggy, just that you need to configure them with an entry in your {% term "`configuration.yaml`" %} file.
|
||||
|
||||
## Silver 🥈
|
||||
|
||||
|
||||
@ -186,6 +186,7 @@ Delays are useful for temporarily suspending your script and start it at a later
|
||||
```yaml
|
||||
# Supports milliseconds, seconds, minutes, hours, days
|
||||
# Can be used in combination, at least one required
|
||||
# When using milliseconds, consider that delay as *at least* X milliseconds. It won´t be exact.
|
||||
# Waits 1 minute
|
||||
- delay:
|
||||
minutes: 1
|
||||
|
||||
@ -165,7 +165,7 @@ condition:
|
||||
|
||||
## Numeric state condition
|
||||
|
||||
This type of condition attempts to parse the state of the specified entity or the attribute of an entity as a number, and triggers if the value matches the thresholds.
|
||||
This type of condition attempts to parse the state of the specified entity or the attribute of an entity as a number, and triggers if the value matches the thresholds (strictly below/above, so equal excluded).
|
||||
|
||||
If both `below` and `above` are specified, both tests have to pass.
|
||||
|
||||
|
||||
@ -6,7 +6,7 @@ related:
|
||||
title: Validating the configuration
|
||||
---
|
||||
|
||||
Test any changes to your `configuration.yaml` file before launching Home Assistant. This script allows you to test changes without the need to restart Home Assistant.
|
||||
Test any changes to your {% term "`configuration.yaml`" %} file before launching Home Assistant. This script allows you to test changes without the need to restart Home Assistant.
|
||||
|
||||
```bash
|
||||
hass --script check_config
|
||||
|
||||
@ -32,7 +32,7 @@ It is almost the same as the option under **Settings** > three dot menu (top rig
|
||||
|
||||
### Reloading the YAML configuration
|
||||
|
||||
For configuration changes to become effective, the configuration must be reloaded. Most integrations in Home Assistant (that do not interact with {% term devices %} or {% term services %}) can reload changes made to their configuration in `configuration.yaml` without needing to restart Home Assistant.
|
||||
For configuration changes to become effective, the configuration must be reloaded. Most integrations in Home Assistant (that do not interact with {% term devices %} or {% term services %}) can reload changes made to their configuration in {% term "`configuration.yaml`" %} without needing to restart Home Assistant.
|
||||
|
||||
1. Go to {% my server_controls title="**Developer Tools** > **YAML**" %} and scroll down to the YAML configuration reloading section (alternatively, hit ["c"](/docs/tools/quick-bar/) anywhere in the UI and search for "reload").
|
||||
- You are presented with a list of integrations, such as **Automations** or **Conversation**.
|
||||
|
||||
@ -8,6 +8,8 @@ related:
|
||||
title: Recovery mode integration
|
||||
- docs: /docs/locked_out/
|
||||
title: Resetting your password
|
||||
- docs: /common-tasks/os/#home-assistant-via-the-command-line
|
||||
title: Home Assistant via command line
|
||||
---
|
||||
|
||||
This page provides some information about more generic troubleshooting topics.
|
||||
@ -39,6 +41,9 @@ You need to identify the issue in the configuration files and fix it there. The
|
||||
## Restarting Home Assistant in safe mode
|
||||
|
||||
If your Home Assistant is acting up and you cannot identify a root cause, you can use **Safe mode** to narrow down the number of possible causes.
|
||||
Safe mode loads Home Assistant Core, but no custom integrations, no custom cards, and no custom themes. If the issue does not persist in Safe mode, the issue is not with Home Assistant Core. Before reporting an issue, check if the issue persists in Safe mode.
|
||||
**Safe mode** loads Home Assistant Core, but no custom integrations, no custom cards, and no custom themes. If the issue does not persist in **Safe mode**, the issue is not with Home Assistant Core. Before reporting an issue, check if the issue persists in **Safe mode**.
|
||||
|
||||
- To enable Safe mode from the UI, go to **Settings** > **System** > **Restart Home Assistant** (top right) > **Restart Home Assistant in safe mode**.
|
||||
- If you cannot reach the UI, you can enable **Safe mode** from the [command line](/common-tasks/os/#home-assistant-via-the-command-line):
|
||||
- ```ha core restart --safe-mode```
|
||||
|
||||
To enable Safe mode, go to **Settings** > **System** > **Restart Home Assistant** (top right) > **Restart Home Assistant in safe mode**.
|
||||
|
||||
@ -22,6 +22,7 @@ Users should upgrade the firmware on all 700 series controllers to version 7.17.
|
||||
|
||||
- 800 series controllers (with some caveats, see notes)
|
||||
- Zooz 800 Series Z-Wave Long Range S2 Stick (ZST39 LR)
|
||||
- HomeSeer SmartStick G8
|
||||
|
||||
- 700 series controllers
|
||||
- Aeotec Z-Stick 7 USB stick (ZWA010) (the EU version is not recommended due to RF performance issues)
|
||||
|
||||
@ -75,3 +75,39 @@
|
||||
</div>
|
||||
{%- endif -%}
|
||||
</section>
|
||||
|
||||
<section class="aside-module grid__item one-whole lap-one-half">
|
||||
<div class='section'>
|
||||
<h1 class="title delta">Code owners</h1>
|
||||
{% if page.ha_codeowners %}
|
||||
{% assign ha_project = false %}
|
||||
{% for codeowner in page.ha_codeowners %}
|
||||
{% if codeowner contains "@home-assistant/" %}
|
||||
{% assign ha_project = true %}
|
||||
{% endif %}
|
||||
{% endfor %}
|
||||
|
||||
{% if ha_project %}
|
||||
<div class="section">
|
||||
This integration is being maintained by the Home Assistant project.
|
||||
</div>
|
||||
{% else %}
|
||||
<div class="section">
|
||||
We are incredibly grateful to the following contributors who currently maintain this integration:<br />
|
||||
</div>
|
||||
<div class="section">
|
||||
{%- for codeowner in page.ha_codeowners -%}
|
||||
{%- assign clean_codeowner = codeowner | replace: "@", "" -%}
|
||||
<a href="https://github.com/{{ clean_codeowner }}" target="_blank"><i class="icon-github"></i> {{ codeowner }}</a><br />
|
||||
{%- endfor -%}
|
||||
</div>
|
||||
{% endif %}
|
||||
{% else %}
|
||||
<div class="section">
|
||||
This integration is community maintained.<br />
|
||||
If you are a developer and would like to help, feel free to contribute!
|
||||
</div>
|
||||
{% endif %}
|
||||
</div>
|
||||
</section>
|
||||
|
||||
|
||||
@ -40,7 +40,7 @@ A partial backup consists of any number of the above default directories and ins
|
||||
2. `ha backups restore slugname` - restores a specific backup
|
||||
3. `ha backups new --name nameofbackup` - create a backup
|
||||
|
||||
Use `ha help` to get more information about the command line usage.
|
||||
For additional information about command line usage, use the `ha help` command or refer to the [Home Assistant Command Line documentation](/common-tasks/os/#home-assistant-via-the-command-line).
|
||||
|
||||
### Copying your backups to another location
|
||||
|
||||
|
||||
@ -1,4 +1,4 @@
|
||||
## Run a beta version
|
||||
### Running a beta version
|
||||
|
||||
If you would like to test next release before anyone else, you can install the beta version.
|
||||
|
||||
@ -9,34 +9,34 @@ If you would like to test next release before anyone else, you can install the b
|
||||
- title: From the UI
|
||||
content: |
|
||||
|
||||
1. In your Home Assistant UI navigate to {% my updates title="System > Updates" %}
|
||||
2. Click the overflow menu in the top right corner
|
||||
3. Click "Join beta"
|
||||
4. Navigate to Configuration panel
|
||||
5. Install the update that is presented to you
|
||||
1. In Home Assistant, go to {% my updates title="**System** > **Updates**" %}.
|
||||
2. In the top-right corner, select the three-dots menu.
|
||||
3. Select **Join beta**.
|
||||
4. Go to the {% my configuration title="**Configuration**" %} panel.
|
||||
5. Install the update that is presented to you.
|
||||
|
||||
- title: From the CLI
|
||||
content: |
|
||||
|
||||
1. Join the beta channel
|
||||
1. Join the beta channel.
|
||||
|
||||
```bash
|
||||
ha supervisor options --channel beta
|
||||
```
|
||||
|
||||
2. Reload the supervisor
|
||||
2. Reload Home Assistant Supervisor.
|
||||
|
||||
```bash
|
||||
ha supervisor reload
|
||||
```
|
||||
|
||||
3. Update Home Assistant core to the latest beta version
|
||||
3. Update Home Assistant Core to the latest beta version.
|
||||
|
||||
```bash
|
||||
ha core update --backup
|
||||
```
|
||||
|
||||
_The_ `--backup` _flag here ensures that you have a partial backup of your current setup incase you need to downgrade._
|
||||
_The_ `--backup` _flag here ensures that you have a partial backup of your current setup in case you need to downgrade._
|
||||
|
||||
{% endtabbed_block %}
|
||||
|
||||
@ -52,24 +52,24 @@ docker pull {{ site.installation.container }}:beta
|
||||
|
||||
1. Stop the Home Assistant service.
|
||||
|
||||
2. Switch to the user that is running Home Assistant
|
||||
2. Switch to the user that is running Home Assistant.
|
||||
|
||||
```bash
|
||||
sudo -u homeassistant -H -s
|
||||
```
|
||||
|
||||
3. Activate the virtual environment that Home Assistant is running in
|
||||
3. Activate the virtual environment that Home Assistant is running in.
|
||||
|
||||
```bash
|
||||
source /srv/homeassistant/bin/activate
|
||||
```
|
||||
|
||||
4. Download and install the beta version
|
||||
4. Download and install the beta version.
|
||||
|
||||
```bash
|
||||
pip3 install --pre --upgrade homeassistant
|
||||
```
|
||||
|
||||
5. When that is complete start the service again for it to use the new files.
|
||||
5. When that is complete, start the service again for it to use the new files.
|
||||
|
||||
{% endif %}
|
||||
|
||||
@ -1,6 +1,6 @@
|
||||
## Home Assistant via the command line
|
||||
|
||||
On the SSH command line, you can use the `ha` command to retrieve logs, check the details of connected hardware, and more.
|
||||
On the [SSH command line](/common-tasks/os/#installing-and-using-the-ssh-add-on), you can use the `ha` command to retrieve logs, check the details of connected hardware, and more.
|
||||
|
||||
### Home Assistant
|
||||
|
||||
@ -11,6 +11,7 @@ ha core logs
|
||||
ha core options
|
||||
ha core rebuild
|
||||
ha core restart
|
||||
ha core restart --safe-mode
|
||||
ha core start
|
||||
ha core stats
|
||||
ha core stop
|
||||
|
||||
@ -4,7 +4,7 @@
|
||||
|
||||
After changing configuration or automation files, check if the configuration is valid before restarting Home Assistant Core.
|
||||
|
||||
## To run a configuration check from the UI
|
||||
### Running a configuration check from the UI
|
||||
|
||||
1. Go to {% my profile title="your user profile" %} and enable **Advanced Mode**.
|
||||
2. Go to {% my server_controls title="**Developer tools** > **YAML**" %} and in the **Configuration validation** section, select the **Check configuration** button.
|
||||
@ -12,7 +12,7 @@ After changing configuration or automation files, check if the configuration is
|
||||
- It checks for valid YAML and valid config structures.
|
||||
3. If you need to do a more comprehensive configuration check, [run the check from the CLI](#to-run-a-configuration-check-from-the-cli).
|
||||
|
||||
## To run a configuration check from the CLI
|
||||
### Running a configuration check from the CLI
|
||||
|
||||
Use the following command to check if the configuration is valid. The command line configuration check validates the YAML files and checks for valid config structures, as well as some other elements.
|
||||
|
||||
|
||||
@ -1,4 +1,4 @@
|
||||
## Run a development version
|
||||
### Running a development version
|
||||
|
||||
If you want to stay on the bleeding-edge Home Assistant Core development branch, you can upgrade to `dev`.
|
||||
|
||||
@ -10,19 +10,19 @@ If you want to stay on the bleeding-edge Home Assistant Core development branch,
|
||||
|
||||
{% if page.installation == "os" or page.installation == "supervised" %}
|
||||
|
||||
1. Join the dev channel
|
||||
1. Join the dev channel.
|
||||
|
||||
```bash
|
||||
ha supervisor options --channel dev
|
||||
```
|
||||
|
||||
2. Reload the supervisor
|
||||
2. Reload the {% term "Home Assistant Supervisor" %}.
|
||||
|
||||
```bash
|
||||
ha supervisor reload
|
||||
```
|
||||
|
||||
3. Update Home Assistant core to the latest dev version
|
||||
3. Update {% term "Home Assistant Core" %} to the latest dev version.
|
||||
|
||||
```bash
|
||||
ha core update --backup
|
||||
@ -42,24 +42,24 @@ docker pull {{ site.installation.container }}:dev
|
||||
|
||||
1. Stop the Home Assistant service.
|
||||
|
||||
2. Switch to the user that is running Home Assistant
|
||||
2. Switch to the user that is running Home Assistant.
|
||||
|
||||
```bash
|
||||
sudo -u homeassistant -H -s
|
||||
```
|
||||
|
||||
3. Activate the virtual environment that Home Assistant is running in
|
||||
3. Activate the virtual environment that Home Assistant is running in.
|
||||
|
||||
```bash
|
||||
source /srv/homeassistant/bin/activate
|
||||
```
|
||||
|
||||
4. Download and install the version you want
|
||||
4. Download and install the version you want.
|
||||
|
||||
```bash
|
||||
pip3 install --upgrade git+https://github.com/home-assistant/core.git@dev
|
||||
```
|
||||
|
||||
5. When that is complete start the service again for it to use the new files.
|
||||
5. When that is complete, start the service again for it to use the new files.
|
||||
|
||||
{% endif %}
|
||||
|
||||
@ -17,31 +17,36 @@ Using any of the add-ons listed below, the following directories are made availa
|
||||
|
||||
### Installing and using the Samba add-on
|
||||
|
||||
The Samba add-on creates smb shares which can be accessed from another computer. You can also edit files using the editor of your preference from your client computer. This add-on can be installed from the add-on store's official repository.
|
||||
The **Samba** add-on allows you to share the directories on Home Assistant with other systems on your network. After installing the add-on, you can then also edit files using the editor of your preference from your client computer. This add-on can be installed from the add-on store's official repository.
|
||||
|
||||
To configure the Samba add-on, you only need to set a user and password of your choice on the configuration page, save, and then start the add-on. The add-on will not start without setting a password!
|
||||
To install the add-on, follow these steps:
|
||||
|
||||
To connect to the Samba server from another device, you will use the IP address or hostname of your server. Either of these can be found on the {% my network title="Settings > System > Network" %} page of your UI.
|
||||
1. Go to {% my supervisor_addon title="**Settings** > **Add-ons** > **Samba share**" addon="core_samba" %} and select **Install**.
|
||||
2. On the **Configuration** tab, define **Username** and **Password**, store them in a safe place, and save your changes.
|
||||
- You can specify any username and password.
|
||||
- They are not related to the login credentials you use to log in to Home Assistant or to log in to the computer from which you are accessing the files.
|
||||
- The add-on won't start if user name and password are not defined.
|
||||
3. For further configuration information, refer to the **Documentation** tab.
|
||||
4. To start the add-on, on the **Information** tab, select **Start**.
|
||||
|
||||
For connecting from Windows 10, you can enter the IP address or hostname in File Explorer's address bar with two backslashes, as shown in the example screenshot.
|
||||
To access the Home Assistant directories from the other device, follow these steps:
|
||||
|
||||
<img src='/images/hassio/screenshots/file_explorer.png' />
|
||||
1. Go to {% my network title="**Settings** > **System** > **Network**" %} and take note of the **Host name**.
|
||||
- Alternatively, you can look up the host name or IP address of your Home Assistant on your router.
|
||||
2. How you connect from another device to Home Assistant depends on your system. Use one of the following options:
|
||||
- **On Windows**: Open **File Explorer** and in the address bar, enter the IP address or hostname with two backslashes as `\\your.ha.ip.address` or `\\hostname`.
|
||||
|
||||
You should then be prompted for the credentials you entered in the Samba add-on configuration. You also have the option of having the credentials stored so that you do not need to enter them again. After that, you'll have access to the directories which you can then mount as a drive or pin to Quick Access.
|
||||
<p class='img'>
|
||||
<img src='/images/hassio/screenshots/file_explorer.png' alt='Screenshot of File Explorer displaying the navigation to a file share using an IP address'>
|
||||
Screenshot of File Explorer displaying the navigation to a file share using an IP address
|
||||
</p>
|
||||
|
||||
- **On OS X**: Open **Finder** and select **Go** > **Connect to Server...** and enter the IP address or hostname as `smb://your.ha.ip.address` or `smb://hostname`.
|
||||
- **On Ubuntu**: Open **Files** and in the address bar, enter the IP address or hostname as `smb://your.ha.ip.address` or `smb://hostname`.
|
||||
|
||||
For OS X, connecting to the shares is a matter of using the Finder menu > Go > Connect to Server...
|
||||
You would then enter the IP address or hostname of your Home Assistant OS instance as `smb://your.ha.ip.address` or `smb://homeassistant` and enter your credentials when prompted.
|
||||
|
||||
---
|
||||
|
||||
### Installing and using the SSH add-on (requires enabling advanced mode for the HA user)
|
||||
|
||||
The Terminal & SSH add-on provides access over an SSH connection, and also includes nano and vi editors. It can be installed from the add-on store's Official add-on repository after enabling advanced mode for your Home Assistant user's profile. Additionally, this add-on provides access to the Home Assistant Command Line Interface (CLI) which provides custom commands for checking logs, stopping and starting Home Assistant and add-ons, creating/restoring backups, and more. (See [Home Assistant via Command Line](https://www.home-assistant.io/hassio/commandline/) for further info). The Terminal & SSH add-on does *not* provide access to the underlying host file system.
|
||||
|
||||
To use the add-on, enter a password or public key on its configuration page, then save and start the add-on.
|
||||
|
||||
The Terminal & SSH add-on also provides a web terminal which allows you to access a terminal via the Home Assistant user interface. In order to access from an ssh client, a port needs to be entered in the network section of the add-on's configuration page.
|
||||
3. Enter the credentials you entered in the **Samba** add-on configuration.
|
||||
- You also have the option of having the credentials stored so that you do not need to enter them again.
|
||||
4. Done! You now have access to the directories which you can then mount as a drive or pin to Quick Access.
|
||||
|
||||
---
|
||||
|
||||
@ -81,3 +86,29 @@ To install and use the File Editor in Home Assistant, follow these steps:
|
||||
3. For information on other configuration settings, open the **Documentation** tab.
|
||||
4. To confirm your changes, select **Save**.
|
||||
5. To start browsing, on the **Info** tab, select **Open Web UI**.
|
||||
|
||||
---
|
||||
|
||||
### Installing and using the SSH add-on
|
||||
|
||||
If you want to use the Home Assistant command line or an SSH client, you can do this through the **Terminal & SSH** add-on.
|
||||
|
||||
The **Terminal & SSH** add-on provides the following functionalities:
|
||||
|
||||
- It provides a web terminal that you can access from the Home Assistant user interface.
|
||||
- It allows you to use the Home Assistant Command Line Interface (CLI) which provides custom commands for checking logs, stopping and starting Home Assistant and add-ons, creating/restoring backups, and more.
|
||||
- For a list of command line commands, refer to [Home Assistant via Command Line](/common-tasks/os#home-assistant-via-the-command-line).
|
||||
- It allows connecting to your system using an SSH client.
|
||||
- It also includes common tools like nano and vi editors.
|
||||
- The Terminal & SSH add-on does **not provide** access to the underlying host file system.
|
||||
|
||||
To get started with the **Terminal & SSH** add-on, follow these steps:
|
||||
|
||||
1. In the bottom left, select your user to open the {% my profile title="**Profile**" %} page. Make sure **Advanced Mode** is enabled.
|
||||
2. To install the add-on, go to the add-on store under [**Settings** > **Add-ons**](https://my.home-assistant.io/redirect/supervisor_addon/?addon=core_ssh) and install the **Terminal & SSH** add-on.
|
||||
3. To use the web terminal, **start** the add-on, then select **Open Web UI**.
|
||||
- You can now start typing your [commands](/common-tasks/os#home-assistant-via-the-command-line).
|
||||
4. If you want to access from an ssh client, you need to enter credentials:
|
||||
- Open the **Configuration** page.
|
||||
- Enter a password or authorized Keys.
|
||||
- Then save and start the add-on.
|
||||
|
||||
@ -1,4 +1,4 @@
|
||||
## Run a specific version
|
||||
### Running a specific version
|
||||
|
||||
{% assign current_version = site.current_major_version | append: "." | append: site.current_minor_version | append: "." | append: site.current_patch_version %}
|
||||
|
||||
@ -10,13 +10,15 @@ In the event that a Home Assistant Core version doesn't play well with your hard
|
||||
|
||||
{% if page.installation == "os" or page.installation == "supervised" %}
|
||||
|
||||
You can use the CLI to upgrade to a specific version (`{{current_version}}` in this example), to downgrade your installation you should do a partial restore of a [backup](#backups) instead.
|
||||
To upgrade to a specific version, you can use the CLI. The example below shows how to upgrade to `{{current_version}}`.
|
||||
|
||||
```bash
|
||||
ha core update --version {{current_version}} --backup
|
||||
```
|
||||
|
||||
_The_ `--backup` _flag here ensures that you have a partial backup of your current setup incase you need to downgrade._
|
||||
_The_ `--backup` _flag here ensures that you have a partial backup of your current setup in case you need to downgrade later._
|
||||
|
||||
To downgrade your installation, do a [partial restore of a backup](/common-tasks/os/#backups) instead.
|
||||
|
||||
{% elsif page.installation == "container" %}
|
||||
|
||||
@ -30,19 +32,19 @@ docker pull {{ site.installation.container }}:{{current_version}}
|
||||
|
||||
1. Stop the Home Assistant service.
|
||||
|
||||
2. Switch to the user that is running Home Assistant
|
||||
2. Switch to the user that is running Home Assistant.
|
||||
|
||||
```bash
|
||||
sudo -u homeassistant -H -s
|
||||
```
|
||||
|
||||
3. Activate the virtual environment that Home Assistant is running in
|
||||
3. Activate the virtual environment that Home Assistant is running in.
|
||||
|
||||
```bash
|
||||
source /srv/homeassistant/bin/activate
|
||||
```
|
||||
|
||||
4. Download and install the version you want
|
||||
4. Download and install the version you want.
|
||||
|
||||
```bash
|
||||
pip3 install homeassistant=={{current_version}}
|
||||
|
||||
@ -1,6 +1,6 @@
|
||||
{% unless page.feedback == false or page.layout == "landingpage" %}
|
||||
<div class="material-card text feedback" id="feedback_section">
|
||||
<h4><a href="#feedback_section" class="title-link"><b> Help us to improve our documentation</b></a></h4>
|
||||
<div class="material-card text feedback">
|
||||
<h4><a href="#feedback_section" class="title-link" name="feedback_section"></a><b> Help us to improve our documentation</b></h4>
|
||||
Suggest an edit to this page, or provide/view feedback for this page.
|
||||
<div class="links">
|
||||
<a
|
||||
|
||||
@ -8,8 +8,8 @@
|
||||
{% endif %}
|
||||
{%- endfor -%}
|
||||
{% if related_topics and related_topics.size != 0 %}
|
||||
<div class="text related-topics" id="related-topics">
|
||||
<h2>Related topics</h2>
|
||||
<div class="text related-topics">
|
||||
<h2><a class="title-link" href="#related-topics" name="related-topics"></a>Related topics</h2>
|
||||
<ul>
|
||||
{% assign site_part = "pages,documents" | split: "," %}
|
||||
{%- for related in related_topics -%}
|
||||
@ -33,8 +33,8 @@
|
||||
</div>
|
||||
{% endif %}
|
||||
{% if related_links and related_links.size != 0 %}
|
||||
<div class="text related-links" id="related-links">
|
||||
<h2>Related links</h2>
|
||||
<div class="text related-links">
|
||||
<h2><a class="title-link" href="#related-links" name="related-links"></a>Related links</h2>
|
||||
<ul>
|
||||
{% for link in related_links %}
|
||||
<li><a href="{{ link.url }}" class="link" target="_blank">{{ link.title | default: link.url }}</a></li>
|
||||
|
||||
@ -81,8 +81,10 @@ All {% term events %} have the fields:
|
||||
| `date` | The date of the event in the format `MM/DD/YYYY`. |
|
||||
| `time` | The time of the event in the format `HH:MM AM`. |
|
||||
|
||||
There is a unique list of known event_codes that can be found
|
||||
[here](https://github.com/MisterWil/abodepy/files/1262019/timeline_events.txt).
|
||||
There is a unique list of known event_codes are defined in
|
||||
[events.csv](https://github.com/jaraco/jaraco.abode/blob/main/jaraco/abode/helpers/events.csv)
|
||||
and the inferred groups and their ranges of event codes are defined in
|
||||
[timeline.py](https://github.com/jaraco/jaraco.abode/blob/main/jaraco/abode/helpers/timeline.py).
|
||||
|
||||
## Services
|
||||
|
||||
@ -92,7 +94,7 @@ Available {% term services %}: `change_setting`, `capture_image`, `trigger_autom
|
||||
|
||||
Change settings on your Abode system.
|
||||
For a full list of settings and valid values, consult the
|
||||
[AbodePy settings section](https://github.com/MisterWil/abodepy/blob/master/README.rst#settings).
|
||||
[`jaraco.abode` settings section](https://github.com/jaraco/jaraco.abode/blob/main/README.rst#settings).
|
||||
|
||||
| Service data attribute | Optional | Description |
|
||||
| ---------------------- | -------- | ----------- |
|
||||
|
||||
@ -549,3 +549,9 @@ cards:
|
||||
- Some devices experience disconnects every 15 seconds. This is typically resolved by rebooting the Android TV device after the initial setup of the integration.
|
||||
- If you are not able to connect to the Android TV device, or are asked to pair it again and again, try force-stopping the Android TV Remote Service and clearing its storage. On the Android TV device, go to **Settings** > **Apps** > **Show system apps**. Then, select **Android TV Remote Service** > **Storage** > **Clear storage**. You will have to pair again.
|
||||
- Some onscreen keyboards enabled by TV manufacturers do not support concurrent virtual and onscreen keyboard use. This presents whenever a text field is selected, such as "search" where a constant **use the keyboard on your mobile device** will show, preventing you from opening the onscreen keyboard to type. This can be overcome by either disabling your 3rd party keyboard and using the default Gboard keyboard or by deselecting **Enable IME** in the **Configure** page of the integration.
|
||||
- In some instances, Zeroconf will assign an incorrect IP address to a device. As a workaround, the below can be added to `configuration.yaml` to prevent Zeroconf from assigning IPs for the integration. IPs will need to be manually entered during setup, as described [above](/integrations/androidtv_remote/#configuration).
|
||||
```yaml
|
||||
zeroconf:
|
||||
ignore:
|
||||
- androidtv_remote
|
||||
```
|
||||
|
||||
@ -12,7 +12,7 @@ The `ffmpeg` platform allows you to use any video feed as a camera in Home Assis
|
||||
|
||||
## Configuration
|
||||
|
||||
To enable your FFmpeg feed in your installation you must first configure the [FFmpeg integration](/integrations/ffmpeg/), then add the following to your `configuration.yaml` file:
|
||||
To enable your FFmpeg feed in your installation you must first configure the [FFmpeg integration](/integrations/ffmpeg/), then add the following to your {% term "`configuration.yaml`" %} file:
|
||||
|
||||
```yaml
|
||||
# Example configuration.yaml entry
|
||||
|
||||
@ -85,7 +85,7 @@ Both `duration` and `lookback` options are suggestions, but should be consistent
|
||||
| `duration` | yes | Target recording length (in seconds). Default: 30 |
|
||||
| `lookback` | yes | Target lookback period (in seconds) to include in addition to duration. Only available if there is currently an active HLS stream. Default: 0 |
|
||||
|
||||
The path part of `filename` must be an entry in the `allowlist_external_dirs` in your [`homeassistant:`](/integrations/homeassistant/#allowlist_external_dirs) section of your `configuration.yaml` file.
|
||||
The path part of `filename` must be an entry in the `allowlist_external_dirs` in your [`homeassistant:`](/integrations/homeassistant/#allowlist_external_dirs) section of your {% term "`configuration.yaml`" %} file.
|
||||
|
||||
For example, the following action in an automation would take a recording from "yourcamera" and save it to /tmp with a timestamped filename.
|
||||
|
||||
@ -111,7 +111,7 @@ Take a snapshot from a camera.
|
||||
| `entity_id` | no | Name(s) of entities to create a snapshot from, e.g., `camera.living_room_camera`. |
|
||||
| `filename` | no | Template of a file name. Variable is `entity_id`, e.g., {% raw %}`/tmp/snapshot_{{ entity_id.name }}`{% endraw %}. |
|
||||
|
||||
The path part of `filename` must be an entry in the `allowlist_external_dirs` in your [`homeassistant:`](/integrations/homeassistant/) section of your `configuration.yaml` file.
|
||||
The path part of `filename` must be an entry in the `allowlist_external_dirs` in your [`homeassistant:`](/integrations/homeassistant/) section of your {% term "`configuration.yaml`" %} file.
|
||||
|
||||
For example, the following action in an automation would take a snapshot from "yourcamera" and save it to /tmp with a timestamped filename.
|
||||
|
||||
|
||||
@ -14,7 +14,7 @@ This can be used with an application or a service capable of sending images thro
|
||||
|
||||
## Configuration
|
||||
|
||||
To enable this camera in your installation, add the following to your `configuration.yaml` file:
|
||||
To enable this camera in your installation, add the following to your {% term "`configuration.yaml`" %} file:
|
||||
|
||||
```yaml
|
||||
# Example configuration.yaml entry
|
||||
|
||||
@ -15,7 +15,7 @@ The `clicksend_tts` platform uses [ClickSend](https://clicksend.com) to deliver
|
||||
|
||||
After creating your account, you should now be able to obtain your `username` and `api_key` [here](https://dashboard.clicksend.com/account/subaccounts).
|
||||
|
||||
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:
|
||||
|
||||
```yaml
|
||||
notify:
|
||||
|
||||
@ -12,7 +12,8 @@ The `mqtt` climate platform lets you control your MQTT enabled HVAC devices.
|
||||
|
||||
## Configuration
|
||||
|
||||
To enable this climate platform in your installation, first add the following to your `configuration.yaml` file:
|
||||
To enable this climate platform in your installation, first add the following to your {% term "`configuration.yaml`" %} file.
|
||||
{% include integrations/restart_ha_after_config_inclusion.md %}
|
||||
|
||||
```yaml
|
||||
# Example configuration.yaml entry
|
||||
|
||||
@ -29,7 +29,7 @@ cloud:
|
||||
|
||||
Documentation of further configuration possibilities are located at [NabuCasa](https://www.nabucasa.com/config/)
|
||||
|
||||
Once activated, go to the configuration panel in Home Assistant and create an account and log in. If you are not seeing the **Settings** panel, make sure you have the following option enabled in your `configuration.yaml` file.
|
||||
Once activated, go to the configuration panel in Home Assistant and create an account and log in. If you are not seeing the **Settings** panel, make sure you have the following option enabled in your {% term "`configuration.yaml`" %} file.
|
||||
|
||||
```yaml
|
||||
config:
|
||||
|
||||
@ -24,7 +24,8 @@ the unofficial [pycomfoconnect](https://github.com/michaelarnauts/comfoconnect)
|
||||
|
||||
The integration has a fan platform to view and control the ventilation speed, and a sensors platform to read out the outdoor temperature and humidity, the indoor temperature and humidity, and the extract and supply air flow (in m³ per hour).
|
||||
|
||||
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 %}
|
||||
|
||||
```yaml
|
||||
comfoconnect:
|
||||
@ -58,7 +59,7 @@ pin:
|
||||
type: integer
|
||||
{% endconfiguration %}
|
||||
|
||||
To register the sensors, add the following to your `configuration.yaml` file:
|
||||
To register the sensors, add the following to your {% term "`configuration.yaml`" %} file:
|
||||
|
||||
```yaml
|
||||
sensor:
|
||||
|
||||
@ -290,7 +290,7 @@ command_line:
|
||||
|
||||
## Binary sensor
|
||||
|
||||
To use your Command binary sensor in your installation, add the following to your `configuration.yaml` file:
|
||||
To use your Command binary sensor in your installation, add the following to your {% term "`configuration.yaml`" %} file:
|
||||
|
||||
{% raw %}
|
||||
```yaml
|
||||
@ -307,7 +307,7 @@ command_line:
|
||||
|
||||
A `command_line`cover platform that issues specific commands when it is moved up, down and stopped. It allows anyone to integrate any type of cover into Home Assistant that can be controlled from the command line.
|
||||
|
||||
To enable a command line cover in your installation, add the following to your `configuration.yaml` file:
|
||||
To enable a command line cover in your installation, add the following to your {% term "`configuration.yaml`" %} file:
|
||||
|
||||
{% raw %}
|
||||
```yaml
|
||||
@ -325,7 +325,7 @@ command_line:
|
||||
|
||||
The `command_line` platform allows you to use external tools for notifications from Home Assistant. The message will be passed in as STDIN.
|
||||
|
||||
To enable those notifications in your installation, add the following to your `configuration.yaml` file:
|
||||
To enable those notifications in your installation, add the following to your {% term "`configuration.yaml`" %} file:
|
||||
|
||||
{% raw %}
|
||||
```yaml
|
||||
@ -340,7 +340,7 @@ To use notifications, please see the [getting started with automation page](/get
|
||||
|
||||
## Sensor
|
||||
|
||||
To enable it, add the following lines to your `configuration.yaml`:
|
||||
To enable it, add the following lines to your {% term "`configuration.yaml`" %}:
|
||||
|
||||
{% raw %}
|
||||
```yaml
|
||||
@ -360,7 +360,7 @@ and off. This might very well become our most powerful platform as it allows
|
||||
anyone to integrate any type of switch into Home Assistant that can be
|
||||
controlled from the command line, including calling other scripts!
|
||||
|
||||
To enable it, add the following lines to your `configuration.yaml`:
|
||||
To enable it, add the following lines to your {% term "`configuration.yaml`" %}:
|
||||
|
||||
{% raw %}
|
||||
```yaml
|
||||
@ -501,7 +501,7 @@ In this section you find some real-life examples of how to use this sensor.
|
||||
|
||||
### CPU temperature
|
||||
|
||||
Thanks to the [`proc`](https://en.wikipedia.org/wiki/Procfs) file system, various details about a system can be retrieved. Here the CPU temperature is of interest. Add something similar to your `configuration.yaml` file:
|
||||
Thanks to the [`proc`](https://en.wikipedia.org/wiki/Procfs) file system, various details about a system can be retrieved. Here the CPU temperature is of interest. Add something similar to your {% term "`configuration.yaml`" %} file:
|
||||
|
||||
{% raw %}
|
||||
```yaml
|
||||
@ -518,7 +518,7 @@ command_line:
|
||||
|
||||
### Monitoring failed login attempts on Home Assistant
|
||||
|
||||
If you'd like to know how many failed login attempts are made to Home Assistant, add the following to your `configuration.yaml` file:
|
||||
If you'd like to know how many failed login attempts are made to Home Assistant, add the following to your {% term "`configuration.yaml`" %} file:
|
||||
|
||||
{% raw %}
|
||||
```yaml
|
||||
@ -572,7 +572,7 @@ command_line:
|
||||
|
||||
The example is doing the same as the [aREST sensor](/integrations/arest#sensor) but with an external Python script. It should give you an idea about interfacing with devices which are exposing a RESTful API.
|
||||
|
||||
The one-line script to retrieve a value is shown below. Of course it would be possible to use this directly in the `configuration.yaml` file but need extra care about the quotation marks.
|
||||
The one-line script to retrieve a value is shown below. Of course it would be possible to use this directly in the {% term "`configuration.yaml`" %} file but need extra care about the quotation marks.
|
||||
|
||||
{% raw %}
|
||||
```bash
|
||||
@ -592,7 +592,7 @@ print(response.json()["return_value"])
|
||||
```
|
||||
{% endraw%}
|
||||
|
||||
To use the script you need to add something like the following to your `configuration.yaml` file.
|
||||
To use the script you need to add something like the following to your {% term "`configuration.yaml`" %} file.
|
||||
|
||||
{% raw %}
|
||||
```yaml
|
||||
|
||||
@ -57,7 +57,7 @@ mode:
|
||||
|
||||
## Binary sensor
|
||||
|
||||
To enable the binary sensor platform, add the following lines to your `configuration.yaml`:
|
||||
To enable the binary sensor platform, add the following lines to your {% term "`configuration.yaml`" %}:
|
||||
|
||||
```yaml
|
||||
# Example configuration.yaml entry
|
||||
|
||||
@ -52,7 +52,7 @@ intents:
|
||||
|
||||
{% endraw %}
|
||||
|
||||
To teach Home Assistant how to handle the custom `CustomOutsideHumidity` {% term intent %}, create an `intent_script` entry in your `configuration.yaml` file:
|
||||
To teach Home Assistant how to handle the custom `CustomOutsideHumidity` {% term intent %}, create an `intent_script` entry in your {% term "`configuration.yaml`" %} file:
|
||||
|
||||
{% raw %}
|
||||
|
||||
@ -173,6 +173,6 @@ This service is able to return [response data](/docs/scripts/service-calls/#use-
|
||||
## Service `conversation.reload`
|
||||
|
||||
| Service data attribute | Optional | Description |
|
||||
|------------------------|----------|--------------------------------------------------------------------------|
|
||||
| ---------------------- | -------- | ------------------------------------------------------------------------ |
|
||||
| `language` | yes | Language to clear intent cache for. No value clears all languages |
|
||||
| `agent_id` | yes | ID of conversation agent. Defaults to the built-in Home Assistant agent. |
|
||||
|
||||
@ -21,12 +21,12 @@ The preferred way to configure counter helpers is via the user interface. To add
|
||||
next choose the **{% my config_flow_start domain=page.ha_domain title=page.title %}** option.
|
||||
|
||||
To be able to add **Helpers** via the user interface you should have
|
||||
`default_config:` in your `configuration.yaml`, it should already be there by
|
||||
`default_config:` in your {% term "`configuration.yaml`" %}, it should already be there by
|
||||
default unless you removed it. If you removed `default_config:` from your
|
||||
configuration, you must add `counter:` to your `configuration.yaml` first,
|
||||
configuration, you must add `counter:` to your {% term "`configuration.yaml`" %} first,
|
||||
then you can use the UI.
|
||||
|
||||
Counters can also be configured via `configuration.yaml`:
|
||||
Counters can also be configured via {% term "`configuration.yaml`" %}:
|
||||
|
||||
```yaml
|
||||
# Example configuration.yaml entry
|
||||
@ -92,7 +92,7 @@ Available services: `increment`, `decrement`, `reset`, and `set_value`.
|
||||
Increments the counter with 1 or the given value for the steps.
|
||||
|
||||
| Service data attribute | Optional | Description |
|
||||
| ---------------------- | -------- | ----------- |
|
||||
| ---------------------- | -------- | --------------------------------------------------------------------- |
|
||||
| `entity_id` | no | Name of the entity to take action, e.g., `counter.my_custom_counter`. |
|
||||
|
||||
### Service `counter.decrement`
|
||||
@ -100,7 +100,7 @@ Increments the counter with 1 or the given value for the steps.
|
||||
Decrements the counter with 1 or the given value for the steps.
|
||||
|
||||
| Service data attribute | Optional | Description |
|
||||
| ---------------------- | -------- | ----------- |
|
||||
| ---------------------- | -------- | --------------------------------------------------------------------- |
|
||||
| `entity_id` | no | Name of the entity to take action, e.g., `counter.my_custom_counter`. |
|
||||
|
||||
### Service `counter.reset`
|
||||
@ -108,7 +108,7 @@ Decrements the counter with 1 or the given value for the steps.
|
||||
With this service the counter is reset to its initial value.
|
||||
|
||||
| Service data attribute | Optional | Description |
|
||||
| ---------------------- | -------- | ----------- |
|
||||
| ---------------------- | -------- | --------------------------------------------------------------------- |
|
||||
| `entity_id` | no | Name of the entity to take action, e.g., `counter.my_custom_counter`. |
|
||||
|
||||
### Service `counter.set_value`
|
||||
@ -116,7 +116,7 @@ With this service the counter is reset to its initial value.
|
||||
This service allows setting the counter to a specific value.
|
||||
|
||||
| Service data attribute | Optional | Description |
|
||||
| ---------------------- | -------- | ----------- |
|
||||
| ---------------------- | -------- | --------------------------------------------------------------------- |
|
||||
| `entity_id` | no | Name of the entity to take action, e.g., `counter.my_custom_counter`. |
|
||||
| `value` | yes | Set the counter to the given value. |
|
||||
|
||||
@ -134,7 +134,7 @@ Select the **Services** tab from within **Developer Tools**. Choose **counter**
|
||||
|
||||
### Counting Home Assistant errors
|
||||
|
||||
To use a counter to count errors as caught by Home Assistant, you need to add `fire_event: true` to your `configuration.yaml`, like so:
|
||||
To use a counter to count errors as caught by Home Assistant, you need to add `fire_event: true` to your {% term "`configuration.yaml`" %}, like so:
|
||||
|
||||
```yaml
|
||||
# Example configuration.yaml entry
|
||||
|
||||
@ -27,7 +27,7 @@ Optimistic mode can be forced, even if a `state_topic` / `position_topic` is def
|
||||
|
||||
The `mqtt` cover platform optionally supports a list of `availability` topics to receive online and offline messages (birth and LWT messages) from the MQTT cover device. During normal operation, if the MQTT cover device goes offline (i.e., publishes a matching `payload_not_available` to any `availability` topic), Home Assistant will display the cover as "unavailable". If these messages are published with the `retain` flag set, the cover will receive an instant update after subscription and Home Assistant will display correct availability state of the cover when Home Assistant starts up. If the `retain` flag is not set, Home Assistant will display the cover as "unavailable" when Home Assistant starts up.
|
||||
|
||||
To use your MQTT cover in your installation, add the following to your `configuration.yaml` file:
|
||||
To use your MQTT cover in your installation, add the following to your {% term "`configuration.yaml`" %} file:
|
||||
|
||||
```yaml
|
||||
# Example configuration.yaml entry
|
||||
|
||||
@ -50,7 +50,7 @@ RTS Record: 14 Address: FFFFFF RC: FFFF
|
||||
RTS Record: 15 Address: FFFFFF RC: FFFF
|
||||
```
|
||||
|
||||
After configuring the RFLink Somfy RTS you have to add the cover to the `configuration.yaml` file like any other RFlink device.
|
||||
After configuring the RFLink Somfy RTS you have to add the cover to the {% term "`configuration.yaml`" %} file like any other RFlink device.
|
||||
|
||||
RFLink cover ID's are composed of: protocol, id, and gateway. For example: `RTS_0100F2_0`.
|
||||
|
||||
|
||||
@ -16,7 +16,7 @@ close, stop, position and tilt commands of a cover.
|
||||
## Configuration
|
||||
|
||||
To enable Template Covers in your installation,
|
||||
add the following to your `configuration.yaml` file:
|
||||
add the following to your {% term "`configuration.yaml`" %} file:
|
||||
|
||||
{% raw %}
|
||||
|
||||
@ -147,7 +147,7 @@ There is an equivalent mode for `tilt_position` that is enabled when
|
||||
If both a [`value_template`](#value_template) and a [`position_template`](#position_template) are specified only `opening` and `closing` states are set directly from the `value_template`, the `open` and `closed` states will instead be derived from the cover position.
|
||||
|
||||
| value_template output | result |
|
||||
| ------------- |-------------|
|
||||
| --------------------- | ------------------------------------ |
|
||||
| open | state defined by `position_template` |
|
||||
| closed | state defined by `position_template` |
|
||||
| true | state defined by `position_template` |
|
||||
|
||||
@ -9,6 +9,9 @@ ha_domain: decora_wifi
|
||||
ha_platforms:
|
||||
- light
|
||||
ha_integration_type: integration
|
||||
related:
|
||||
- docs: /docs/configuration/
|
||||
title: Configuration file
|
||||
---
|
||||
|
||||
Support for [Leviton Decora Wi-Fi](https://www.leviton.com/products/residential/automation-smart-home/decora-smart-all/decora-smart-with-wifi-technology) dimmers/switches via the MyLeviton API.
|
||||
@ -20,7 +23,8 @@ Supported devices (tested):
|
||||
- - [DW15S-1BZ](https://www.leviton.com/products/dw15s-1bz) (Decora Smart Wi-Fi 15A Switch)
|
||||
- [D215S-2RW](https://store.leviton.com/products/decora-smart-wi-fi-switch-2nd-gen-d215s-2rw) (Decora Smart Wi-Fi 15A Switch - 2nd Gen)
|
||||
|
||||
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
|
||||
|
||||
@ -37,7 +37,7 @@ This {% term integration %} is a meta-component and configures a default set of
|
||||
|
||||
## Configuration
|
||||
|
||||
To integrate this into Home Assistant, add the following section to your `configuration.yaml` file:
|
||||
To integrate this into Home Assistant, add the following section to your {% term "`configuration.yaml`" %} file:
|
||||
|
||||
```yaml
|
||||
# Example configuration.yaml entry
|
||||
|
||||
@ -17,7 +17,7 @@ The device tracker allows you to track devices in Home Assistant. This can happe
|
||||
|
||||
## Configuring a `device_tracker` platform
|
||||
|
||||
To get started add the following lines to your `configuration.yaml` (example for Netgear):
|
||||
To get started add the following lines to your {% term "`configuration.yaml`" %} (example for Netgear):
|
||||
|
||||
```yaml
|
||||
# Example configuration.yaml entry for Netgear device
|
||||
@ -37,7 +37,7 @@ The following optional parameters can be used with any platform:
|
||||
</div>
|
||||
|
||||
| Parameter | Default | Description |
|
||||
|----------------------|---------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
|
||||
| ------------------ | ------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
||||
| `interval_seconds` | 12 | Seconds between each scan for new devices. This only applies to local device trackers, not applications that push updates. |
|
||||
| `consider_home` | 180 | Seconds to wait till marking someone as not home after not being seen. This parameter is most useful for households with Apple iOS devices that go into sleep mode while still at home to conserve battery life. iPhones will occasionally drop off the network and then re-appear. `consider_home` helps prevent false alarms in presence detection when using IP scanners such as Nmap. `consider_home` accepts various time representations, (e.g., the following all represents 3 minutes: `180`, `0:03`, `0:03:00`) |
|
||||
|
||||
@ -90,7 +90,7 @@ In the example above, `devicename` refers to the detected name of the device. F
|
||||
</div>
|
||||
|
||||
| Parameter | Default | Description |
|
||||
|----------------|-------------------------------|---------------------------------------------------------------------------------------------------------|
|
||||
| --------------- | ----------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
||||
| `name` | Host name or "Unnamed Device" | The friendly name of the device. |
|
||||
| `mac` | None | The MAC address of the device. Add this if you are using a network device tracker like Nmap or SNMP. |
|
||||
| `picture` | None | A picture that you can use to easily identify the person or device. You can also save the image file in a folder "www" in the same location (can be obtained from developer tools) where you have your `configuration.yaml` file and just use `picture: /local/favicon-192x192.png`. The path 'local' is mapped to the 'www' folder you create. |
|
||||
@ -108,7 +108,7 @@ The state of your tracked device will be `'home'` if it is in the [home zone](/i
|
||||
The `device_tracker.see` service can be used to manually update the state of a device tracker:
|
||||
|
||||
| Service data attribute | Optional | Description |
|
||||
| ---------------------- | -------- | ----------- |
|
||||
| ---------------------- | -------- | --------------------------------------------------------------------------------------- |
|
||||
| `dev_id` | no | The `object_id`, for example `tardis` for `device_tracker.tardis` |
|
||||
| `location_name` | yes | The location, `home`, `not_home`, or the name of the zone |
|
||||
| `host_name` | yes | The hostname of the device tracker |
|
||||
|
||||
@ -6,14 +6,17 @@ ha_category:
|
||||
ha_iot_class: Configurable
|
||||
ha_release: 0.7.3
|
||||
ha_domain: mqtt
|
||||
related:
|
||||
- docs: /docs/configuration/
|
||||
title: Configuration file
|
||||
---
|
||||
|
||||
|
||||
The `mqtt` device tracker platform allows you to define new device_trackers through [manual YAML configuration](#yaml-configuration) in `configuration.yaml` and also to automatically discover device_trackers [using the MQTT Discovery protocol](#using-the-discovery-protocol).
|
||||
The `mqtt` device tracker {% term integration %} allows you to define new device_trackers through [manual YAML configuration](#yaml-configuration) in {% term "`configuration.yaml`" %} and also to automatically discover device_trackers [using the MQTT Discovery protocol](#using-the-discovery-protocol).
|
||||
|
||||
## Configuration
|
||||
|
||||
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:
|
||||
|
||||
```yaml
|
||||
# Example configuration.yaml entry
|
||||
|
||||
@ -11,7 +11,7 @@ The `xiaomi` platform offers presence detection by looking at connected devices
|
||||
|
||||
## Setup
|
||||
|
||||
To use an Xiaomi router in your installation, add the following to your `configuration.yaml` file:
|
||||
To use an Xiaomi router in your installation, add the following to your {% term "`configuration.yaml`" %} file:
|
||||
|
||||
```yaml
|
||||
# Example configuration.yaml entry
|
||||
|
||||
@ -14,7 +14,7 @@ An MQTT device trigger is a better option than a [binary sensor](/integrations/b
|
||||
|
||||
## Configuration
|
||||
|
||||
MQTT device triggers are only supported through [MQTT discovery](/integrations/mqtt/#mqtt-discovery), manual setup through `configuration.yaml` is not supported.
|
||||
MQTT device triggers are only supported through [MQTT discovery](/integrations/mqtt/#mqtt-discovery), manual setup through {% term "`configuration.yaml`" %} is not supported.
|
||||
The discovery topic needs to be: `<discovery_prefix>/device_automation/[<node_id>/]<object_id>/config`. Note that only one trigger may be defined per unique discovery topic. Also note that the combination of `type` and `subtype` should be unique for a device.
|
||||
|
||||
{% configuration %}
|
||||
|
||||
@ -54,7 +54,7 @@ The `digital_ocean` binary sensor platform allows you to monitor your Digital Oc
|
||||
|
||||
### Configuration
|
||||
|
||||
To use your Digital Ocean droplets, you first have to set up your [Digital Ocean hub](/integrations/digital_ocean/) and then add the following to your `configuration.yaml` file:
|
||||
To use your Digital Ocean droplets, you first have to set up your [Digital Ocean hub](/integrations/digital_ocean/) and then add the following to your {% term "`configuration.yaml`" %} file:
|
||||
|
||||
```yaml
|
||||
# Example configuration.yaml entry
|
||||
@ -78,7 +78,7 @@ The `digital_ocean` switch platform allows you to control (start/stop) your Digi
|
||||
|
||||
### Configuration
|
||||
|
||||
To use your Digital Ocean droplets, you first have to set up your [Digital Ocean hub](/integrations/digital_ocean/) and then add the following to your `configuration.yaml` file:
|
||||
To use your Digital Ocean droplets, you first have to set up your [Digital Ocean hub](/integrations/digital_ocean/) and then add the following to your {% term "`configuration.yaml`" %} file:
|
||||
|
||||
```yaml
|
||||
# Example configuration.yaml entry
|
||||
|
||||
@ -17,14 +17,14 @@ related:
|
||||
title: Configuration file
|
||||
---
|
||||
|
||||
The `dovado` {% term integration %} manages communication with the [Dovado](https://www.dovado.com/) router.
|
||||
The **Dovado** {% term integration %} manages communication with the [Dovado](https://www.dovado.com/) router.
|
||||
|
||||
There is currently support for the following device types within Home Assistant:
|
||||
|
||||
- [Notifications](/integrations/dovado/#notifications)
|
||||
- [Sensor](/integrations/dovado/#sensor)
|
||||
|
||||
To add a Dovado integration to your installation, add the following to your {% term "`configuration.yaml`" %} file.
|
||||
To add a Dovado {% term integration %} to your installation, add the following to your {% term "`configuration.yaml`" %} file.
|
||||
{% include integrations/restart_ha_after_config_inclusion.md %}
|
||||
|
||||
```yaml
|
||||
@ -59,7 +59,8 @@ port:
|
||||
|
||||
The `dovado` notify platform allows you to send SMS from your [Dovado](https://www.dovado.com/) router, if it supports it.
|
||||
|
||||
To add the Dovado notify platform to your installation, add the following to your `configuration.yaml` file:
|
||||
To add the Dovado {% term 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
|
||||
@ -89,7 +90,7 @@ automation:
|
||||
|
||||
The `dovado` sensor platform let you monitor your [Dovado](https://www.dovado.com/) router.
|
||||
|
||||
To add a Dovado sensor to your installation, add the following to your `configuration.yaml` file:
|
||||
To add a Dovado sensor to your installation, add the following to your {% term "`configuration.yaml`" %} file:
|
||||
|
||||
```yaml
|
||||
# Example configuration.yaml entry
|
||||
|
||||
@ -62,7 +62,7 @@ The `dweet` sensor platform allows you to get details from your devices which ar
|
||||
|
||||
### Configuration
|
||||
|
||||
To use Dweet.io sensors in your installation, add the following to your `configuration.yaml` file:
|
||||
To use Dweet.io sensors in your installation, add the following to your {% term "`configuration.yaml`" %} file:
|
||||
|
||||
{% raw %}
|
||||
|
||||
|
||||
@ -48,7 +48,7 @@ There are global setup parameters and advanced parameters that should normally b
|
||||
Maybe the most difficult thing about a Dynalite system is finding out the areas and channel mapping. If you have them or have access to the Dynalite software and your configuration files, this could be easy,
|
||||
but in the likely case that your system was installed by an integrator, you will have to discover them on your own.
|
||||
|
||||
This is where the `autodiscover` option comes handy. If it is on, the component will track the Dynet network and every time a device is used, it will be added to Home Assistant. It will initially show as "Area 123 Channel 7", but you can then add it to your `configuration.yaml` with the correct configuration.
|
||||
This is where the `autodiscover` option comes handy. If it is on, the component will track the Dynet network and every time a device is used, it will be added to Home Assistant. It will initially show as "Area 123 Channel 7", but you can then add it to your {% term "`configuration.yaml`" %} with the correct configuration.
|
||||
|
||||
For example, you would go to your kitchen light and turn it on. Now you log into Home Assistant and see what the channel was. If there was more than one discovered (e.g., someone turned off the living room lights), you can try one, turn it on and off in Home Assistant and see which light it affects.
|
||||
|
||||
@ -67,10 +67,10 @@ This does not return the area preset. It sends a network command asking the area
|
||||
</div>
|
||||
|
||||
| Service data attribute | Optional | Description |
|
||||
| ---------------------- | -------- | ----------- |
|
||||
| `host` | yes | Which gateway to send the command to. If not specified, sends to all configured gateways.
|
||||
| `area` | no | Area for the requested channel.
|
||||
| `channel` | no | Which channel to request.
|
||||
| ---------------------- | -------- | ----------------------------------------------------------------------------------------- |
|
||||
| `host` | yes | Which gateway to send the command to. If not specified, sends to all configured gateways. |
|
||||
| `area` | no | Area for the requested channel. |
|
||||
| `channel` | no | Which channel to request. |
|
||||
|
||||
### Service `dynalite.request_channel_level`
|
||||
|
||||
@ -83,10 +83,10 @@ This does not return the channel level. It sends a network command asking the ch
|
||||
</div>
|
||||
|
||||
| Service data attribute | Optional | Description |
|
||||
| ---------------------- | -------- | ----------- |
|
||||
| `host` | yes | Which gateway to send the command to. If not specified, sends to all configured gateways.
|
||||
| `area` | no | Which area to request the preset for.
|
||||
| `channel` | yes | Which channel to use. If not specified, uses the area configuration or system default.
|
||||
| ---------------------- | -------- | ----------------------------------------------------------------------------------------- |
|
||||
| `host` | yes | Which gateway to send the command to. If not specified, sends to all configured gateways. |
|
||||
| `area` | no | Which area to request the preset for. |
|
||||
| `channel` | yes | Which channel to use. If not specified, uses the area configuration or system default. |
|
||||
|
||||
## Events
|
||||
|
||||
@ -95,7 +95,7 @@ This does not return the channel level. It sends a network command asking the ch
|
||||
Event `dynalite_preset` is fired every time a preset is selected in a given Dynalite area.
|
||||
|
||||
| Field | Description |
|
||||
| ----------- | --------------------------------------------------------------------------------------------------- |
|
||||
| -------- | ------------------------------------- |
|
||||
| `host` | Host IP of the Dynalite gateway |
|
||||
| `area` | Area number where preset was selected |
|
||||
| `preset` | The specific preset that was selected |
|
||||
@ -105,6 +105,6 @@ Event `dynalite_preset` is fired every time a preset is selected in a given Dyna
|
||||
Event `dynalite_packet` is fired whenever there is a packet on the Dynalite network.
|
||||
|
||||
| Field | Description |
|
||||
| ----------- | --------------------------------------------------------------------------------------------------- |
|
||||
| -------- | ----------------------------------------------------------------------- |
|
||||
| `host` | Host IP of the Dynalite gateway |
|
||||
| `packet` | List of integers representing the 8-byte packet, including the checksum |
|
||||
|
||||
@ -108,7 +108,7 @@ There seem to be multiple versions of software running on GATE-02 devices; we ha
|
||||
1. Log in to your alarm system's control panel. You will need to access http://[IP of your control panel]. You know this already since you need it in the basic configuration from above. Log in to the control panel with your Egardia/Woonveilig username and password.
|
||||
2. Once logged in, go to *System Settings*, *Report* and change the Server Address for your primary server to the IP or hostname of your Home Assistant machine. You can leave the port number set to 52010 or change it to anything you like. **Make sure to change the settings of the primary server otherwise the messages will not come through. Note that this will limit (or fully stop) the number of alarm messages you will get through Egardia's / Woonveilig services.** Maybe, that is just what you want. Make sure to save your settings by selecting 'OK'. **If the system support XMPP, disable XMPP by invalidating the configuration in the XMPP menu (for example by changing the user name). This is required for recent firmwares of the GATE-03 system as it does not use the Reporting server at all in the case of a valid XMPP configuration.**
|
||||
3. The Egardia integration relies on capturing the status codes that your alarm emits when something happens (status change or trigger). These codes will be unique for every situation - i.e., the code emitted by the alarm when a sensor is triggered is unique to that sensor. Also, if you have multiple users or remotes, each remote has unique codes that are emitted by the alarm when status is changed using that remote or by that user. For the Egardia integration to work correctly you will need to capture the codes. To do this, on your Home Assistant machine run `$ sudo python3 egardiaserver.py`. Refer to the [python-egardia repository](https://github.com/jeroenterheerdt/python-egardia) for detailed documentation on parameters. This will receive status codes from your alarm control panel and display them. Record the codes shown as well as the status they relate to (see step 4 below). Make sure to change the status of your alarm to all states (disarm, arm, home) by all means possible (all users, remotes, web login, app) as well as trigger the alarm in all ways possible to get 100% coverage of all the codes the alarm system generates. You will need to run this script once and stop it once you have captured all the possible codes. Also, if you ever add users, remotes or sensors to your alarm system, make sure to re-run the script to capture the extra codes so you can update your configuration (see step 4 below). **For comfort, before triggering the alarm it might be good to disable the siren temporarily (can be done in Panel Settings).**
|
||||
4. Once you have the codes, update your `configuration.yaml`:
|
||||
4. Once you have the codes, update your {% term "`configuration.yaml`" %}:
|
||||
```yaml
|
||||
# Example configuration.yaml entry
|
||||
egardia:
|
||||
|
||||
@ -146,7 +146,7 @@ The complete list of trouble statuses are:
|
||||
|
||||
## Manual configuration
|
||||
|
||||
Alternatively, configuration through the `configuration.yaml` file
|
||||
Alternatively, configuration through the {% term "`configuration.yaml`" %} file
|
||||
is supported (example below).
|
||||
|
||||
Both methods of configuration support "auto configuration". This works by
|
||||
@ -561,7 +561,7 @@ Speak a word. The list of words is defined in the ElkM1 ASCII Protocol documenta
|
||||
Debug logs are often required to solve an issue. Follow the instructions on [Enabling debug logging](/docs/configuration/troubleshooting/#enabling-debug-logging).
|
||||
|
||||
Sometimes, for example, a problem can occur while starting Home Assistant. In this case, follow these instructions.
|
||||
Add the following to your `configuration.yaml` file in your Home Assistant `config` directory:
|
||||
Add the following to your {% term "`configuration.yaml`" %} file in your Home Assistant `config` directory:
|
||||
|
||||
```yaml
|
||||
logger:
|
||||
|
||||
@ -131,7 +131,7 @@ You can find the `event_data` `id` by going to {% my developer_events title="Dev
|
||||
|
||||
An EnOcean light can take many forms. Currently only one type has been tested: Eltako FUD61 dimmer.
|
||||
|
||||
To use your EnOcean device, you first have to set up your EnOcean hub and then add the following to your `configuration.yaml` file:
|
||||
To use your EnOcean device, you first have to set up your EnOcean hub and then add the following to your {% term "`configuration.yaml`" %} file:
|
||||
|
||||
```yaml
|
||||
# Example configuration.yaml entry
|
||||
@ -166,7 +166,7 @@ The EnOcean sensor platform currently supports the following device types:
|
||||
- [temperature sensor](#temperature-sensor)
|
||||
- [window handle](#window-handle)
|
||||
|
||||
To use your EnOcean device, you first have to set up your EnOcean hub and then add the following to your `configuration.yaml` file:
|
||||
To use your EnOcean device, you first have to set up your EnOcean hub and then add the following to your {% term "`configuration.yaml`" %} file:
|
||||
|
||||
```yaml
|
||||
# Example configuration.yaml entry
|
||||
@ -197,7 +197,7 @@ device_class:
|
||||
|
||||
This has been tested with a Permundo PSC234 switch, but any device sending EEP **A5-12-01** messages will work.
|
||||
|
||||
Add the following to your `configuration.yaml` file:
|
||||
Add the following to your {% term "`configuration.yaml`" %} file:
|
||||
|
||||
```yaml
|
||||
# Example configuration.yaml entry
|
||||
@ -217,7 +217,7 @@ The following [EnOcean Equipment Profiles](https://www.enocean-alliance.org/spec
|
||||
- **A5-04-02** - Temp. and Humidity Sensor, Range -20°C to +60°C and 0% to 100%
|
||||
- **A5-10-10** to **A5-10-14** - Room Operating Panels
|
||||
|
||||
Add the following to your `configuration.yaml` file:
|
||||
Add the following to your {% term "`configuration.yaml`" %} file:
|
||||
|
||||
```yaml
|
||||
# Example configuration.yaml entry
|
||||
@ -246,7 +246,7 @@ The following [EnOcean Equipment Profiles](https://www.enocean-alliance.org/spec
|
||||
Check the manual of your temperature sensor to figure out what EEP it uses.
|
||||
If you do not know, make an educated guess and check the reported values. It's easiest to validate the temperature at the boundaries of the range, so maybe put the sensor into the fridge for a while.
|
||||
|
||||
Add the following to your `configuration.yaml` file:
|
||||
Add the following to your {% term "`configuration.yaml`" %} file:
|
||||
|
||||
```yaml
|
||||
# Example configuration.yaml entry
|
||||
@ -290,7 +290,7 @@ However, some EEPs have a different, inverted range, which goes from 0 to 250. T
|
||||
- **A5-10-10** to **A5-10-14**
|
||||
- **A5-20-01** - Battery powered actuator (bi-dir)
|
||||
|
||||
Adapt the `configuration.yaml` for those sensors:
|
||||
Adapt the {% term "`configuration.yaml`" %} for those sensors:
|
||||
|
||||
```yaml
|
||||
# Example configuration.yaml entry for EEP A5-10-10
|
||||
@ -307,7 +307,7 @@ sensor:
|
||||
|
||||
As of now, the Hoppe SecuSignal window handle from Somfy has been successfully tested. However, any mechanical window handle that follows the EnOcean RPS telegram spec F6 10 00 (Hoppe AG) is supported.
|
||||
|
||||
To configure a window handle, add the following code to your `configuration.yaml`:
|
||||
To configure a window handle, add the following code to your {% term "`configuration.yaml`" %}:
|
||||
|
||||
```yaml
|
||||
# Example configuration.yaml entry for window handle EEP F6-10-00
|
||||
@ -330,7 +330,7 @@ The window handle sensor can have the following states:
|
||||
|
||||
An EnOcean switch can take many forms. Currently, only a few types have been tested: Permundo PSC234 and Nod On SIN-2-1-01.
|
||||
|
||||
To use your EnOcean device, you first have to set up your EnOcean hub and then add the following to your `configuration.yaml` file:
|
||||
To use your EnOcean device, you first have to set up your EnOcean hub and then add the following to your {% term "`configuration.yaml`" %} file:
|
||||
|
||||
```yaml
|
||||
# Example configuration.yaml entry
|
||||
|
||||
@ -11,11 +11,15 @@ ha_domain: ephember
|
||||
ha_platforms:
|
||||
- climate
|
||||
ha_integration_type: integration
|
||||
related:
|
||||
- docs: /docs/configuration/
|
||||
title: Configuration file
|
||||
---
|
||||
|
||||
The `ephember` climate platform lets you control [EPH Controls](https://emberapp.ephcontrols.com/) thermostats. The module only works if you have a Wi-Fi gateway to control your EPH system and an account on the EMBER app.
|
||||
The `ephember` {% term integration %} lets you control [EPH Controls](https://emberapp.ephcontrols.com/) thermostats. The module only works if you have a Wi-Fi gateway to control your EPH system and an account on the EMBER app.
|
||||
|
||||
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 %}
|
||||
|
||||
```yaml
|
||||
climate:
|
||||
|
||||
@ -30,3 +30,9 @@ The following calendars will be created:
|
||||
|------|-----------|
|
||||
|`epic_games_store_discount_games`|Current and upcoming discounts on games, one calendar event per game|
|
||||
|`epic_games_store_free_games`|Free games for the current and upcoming week, one calendar event per game|
|
||||
|
||||
### Video tutorial
|
||||
|
||||
This video tutorial explains how to show the two free games from the Epic Games Store on your dashboard using a custom template sensor.
|
||||
|
||||
<lite-youtube videoid="fwpdi-Ua46A" videotitle="Get FREE GAMES with Home Assistant!" posterquality="maxresdefault"></lite-youtube>
|
||||
|
||||
@ -57,7 +57,7 @@ ESPHome devices can make service calls to any [Home Assistant service](https://e
|
||||
|
||||
## Entity naming and IDs
|
||||
|
||||
ESPHome uses different naming and entity ID rules based on the configuration of the ESPHome device. It is recommended to set a `friendly_name` in the ESPHome `configuration.yaml` to take advantage of the newer naming structure, which is consistent with Home Assistant naming standards and makes it much easier to tell similar devices apart. The legacy naming rules apply when the `friendly_name` is not set in the `configuration.yaml`.
|
||||
ESPHome uses different naming and entity ID rules based on the configuration of the ESPHome device. It is recommended to set a `friendly_name` in the ESPHome {% term "`configuration.yaml`" %} to take advantage of the newer naming structure, which is consistent with Home Assistant naming standards and makes it much easier to tell similar devices apart. The legacy naming rules apply when the `friendly_name` is not set in the {% term "`configuration.yaml`" %}.
|
||||
|
||||
### Friendly naming
|
||||
|
||||
|
||||
@ -65,7 +65,7 @@ For those of us using Docker, the above tutorial may not be sufficient. The foll
|
||||
|
||||
#### Set HTTP logger
|
||||
|
||||
In your `configuration.yaml` file, add the following to the `logger` integration to ensure that Home Assistant prints failed login attempts to the log.
|
||||
In your {% term "`configuration.yaml`" %} file, add the following to the `logger` integration to ensure that Home Assistant prints failed login attempts to the log.
|
||||
|
||||
```yaml
|
||||
logger:
|
||||
@ -161,7 +161,7 @@ server {
|
||||
}
|
||||
```
|
||||
|
||||
Once that's added to the NGINX configuration, we need to modify the Home Assistant `configuration.yaml` such that the `X-Forwarded-For` header can be parsed. This is done by adding the following to the `http` integration:
|
||||
Once that's added to the NGINX configuration, we need to modify the Home Assistant {% term "`configuration.yaml`" %} such that the `X-Forwarded-For` header can be parsed. This is done by adding the following to the `http` integration:
|
||||
|
||||
```yaml
|
||||
http:
|
||||
@ -172,7 +172,7 @@ At this point, once the Let's Encrypt and Home Assistant dockers are restarted,
|
||||
|
||||
#### Add the fail2ban sensor
|
||||
|
||||
Now that we've correctly set everything up for Docker, we can add our sensors to `configuration.yaml` with the following:
|
||||
Now that we've correctly set everything up for Docker, we can add our sensors to {% term "`configuration.yaml`" %} with the following:
|
||||
|
||||
```yaml
|
||||
sensor:
|
||||
|
||||
@ -18,7 +18,8 @@ When a `state_topic` is not available, the fan will work in optimistic mode. In
|
||||
|
||||
Optimistic mode can be forced even if a `state_topic` is available. Try to enable it if you are experiencing incorrect fan operation.
|
||||
|
||||
To enable MQTT fans in your installation, add the following to your `configuration.yaml` file:
|
||||
To enable MQTT fans 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
|
||||
|
||||
@ -20,7 +20,7 @@ you have FFmpeg installed on your system.
|
||||
|
||||
## Configuration
|
||||
|
||||
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:
|
||||
|
||||
```yaml
|
||||
ffmpeg:
|
||||
|
||||
@ -215,7 +215,7 @@ This screenshot shows what a FireServiceRota dashboard can look like.
|
||||
|
||||
## Debugging
|
||||
|
||||
The FireServiceRota integration will log additional information about WebSocket incidents received, response and duty status gathered, and other messages when the log level is set to `debug`. Add the relevant lines below to the `configuration.yaml`:
|
||||
The FireServiceRota integration will log additional information about WebSocket incidents received, response and duty status gathered, and other messages when the log level is set to `debug`. Add the relevant lines below to the {% term "`configuration.yaml`" %}:
|
||||
|
||||
```yaml
|
||||
logger:
|
||||
|
||||
@ -35,7 +35,7 @@ There is currently support for the following device types within Home Assistant:
|
||||
|
||||
You will need to upload a [Firmata firmware](https://github.com/firmata/) to your board. Please upload any `StandardFirmata` sketch to your board; please refer to the [Arduino documentation](https://www.arduino.cc/en/Main/Howto) for further information for uploading sketches. Firmata is available in the Arduino Library Manager in the Arduino IDE. You may also use a [Firmata Express](https://github.com/MrYsLab/FirmataExpress).
|
||||
|
||||
To integrate Arduino boards with Home Assistant, add the following section to your `configuration.yaml` file:
|
||||
To integrate Arduino boards with Home Assistant, add the following section to your {% term "`configuration.yaml`" %} file:
|
||||
|
||||
<div class='note warning'>
|
||||
Firmata does not store the last state across power cycles. This means that with every powerup the pins are set to off/low and after every initialization, they will be set to the default that you have configured in YAML.
|
||||
|
||||
@ -17,7 +17,7 @@ The sensor exposes the number of filtered files in the folder, total size in byt
|
||||
|
||||
## Configuration
|
||||
|
||||
To enable the `folder` sensor in your installation, add the following to your `configuration.yaml` file:
|
||||
To enable the `folder` sensor in your installation, add the following to your {% term "`configuration.yaml`" %} file:
|
||||
|
||||
```yaml
|
||||
sensor:
|
||||
|
||||
@ -17,7 +17,7 @@ This sensor requires an API token. Please obtain one at [Foobot API site](https:
|
||||
|
||||
## Configuring the Platform
|
||||
|
||||
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:
|
||||
|
||||
```yaml
|
||||
sensor:
|
||||
|
||||
@ -47,7 +47,7 @@ https://foursquare.com/oauth2/authenticate?client_id=CLIENT_ID&response_type=tok
|
||||
|
||||
and change the `CLIENT_ID` and `YOUR_REGISTERED_REDIRECT_URL` to your actual values.
|
||||
You will receive an OAuth request landing page, asking you if you want to connect your Foursquare account to your newly created app. Say "Yes".
|
||||
After that, you will get redirected to your `REDIRECT_URL` with the `access_token` as an HTTP GET variable. Copy everything after the = and paste it in your `configuration.yaml` as the `access_token`.
|
||||
After that, you will get redirected to your `REDIRECT_URL` with the `access_token` as an HTTP GET variable. Copy everything after the = and paste it in your {% term "`configuration.yaml`" %} as the `access_token`.
|
||||
|
||||
### Real-Time API
|
||||
|
||||
|
||||
@ -47,7 +47,7 @@ You need to determine your update URL or your access token.
|
||||
|
||||
## Configuration (API V2)
|
||||
|
||||
To use the integration in your installation, add the following to your `configuration.yaml` file:
|
||||
To use the integration in your installation, add the following to your {% term "`configuration.yaml`" %} file:
|
||||
|
||||
```yaml
|
||||
# Example configuration.yaml entry
|
||||
|
||||
@ -36,11 +36,13 @@ This integration lets you control all [Freedompro](https://freedompro.eu/) acces
|
||||
|
||||
## Preliminary steps
|
||||
|
||||
You will need to obtain an API key from [Freedompro Cloud](https://home.freedompro.eu/) to use this integration.
|
||||
You will need to obtain an API key from Freedompro's app to use this integration.
|
||||
|
||||
1. Login to [Freedompro Cloud](https://home.freedompro.eu/).
|
||||
2. Make sure you have at least one accessory paired with the Freedompro Cloud before starting integration.
|
||||
3. Click on your photo profile.
|
||||
4. Generate the API key.
|
||||
1. Download the app on your phone: ([Android](https://play.google.com/store/apps/details?id=eu.freedompro.app&hl=en&gl=US) / [iOS](https://apps.apple.com/en/app/freedompro/id1598082027)).
|
||||
2. Register and create your first home.
|
||||
3. Make sure you have at least one accessory paired with the Freedompro Cloud before starting integration.
|
||||
4. Switch to the **Profile** tab (bottom right corner).
|
||||
5. Scroll down to the **Developper tools** and tap **Api Key**.
|
||||
6. Generate an API key.
|
||||
|
||||
{% include integrations/config_flow.md %}
|
||||
|
||||
@ -145,7 +145,7 @@ Theme `day_and_night`: This theme has both a `light` and a `dark` mode section.
|
||||
|
||||
As with all configuration, you can either:
|
||||
|
||||
- Directly specify the themes inside your `configuration.yaml` file.
|
||||
- Directly specify the themes inside your {% term "`configuration.yaml`" %} file.
|
||||
- Put them into a separate file (e.g., `themes.yaml`) and include that in your configuration (`themes: !include themes.yaml`).
|
||||
- Create a dedicated folder (e.g., `my_themes`) and include all files from within this folder (`themes: !include_dir_merge_named my_themes`).
|
||||
|
||||
@ -157,7 +157,7 @@ Check our [community forums](https://community.home-assistant.io/c/projects/them
|
||||
|
||||
There are two themes-related services:
|
||||
|
||||
- `frontend.reload_themes`: Reloads theme configuration from your `configuration.yaml` file.
|
||||
- `frontend.reload_themes`: Reloads theme configuration from your {% term "`configuration.yaml`" %} file.
|
||||
- `frontend.set_theme`: Sets backend-preferred theme name.
|
||||
|
||||
### Service `set_theme`
|
||||
@ -172,7 +172,7 @@ The backend theme settings will be saved and restored on a restart of Home Assis
|
||||
|
||||
### Manual theme selection
|
||||
|
||||
When themes are enabled in the `configuration.yaml` file, a new option will show up in the user profile page (accessed by clicking your user account initials at the bottom of the sidebar). You can then choose any installed theme from the dropdown list and it will be applied immediately.
|
||||
When themes are enabled in the {% term "`configuration.yaml`" %} file, a new option will show up in the user profile page (accessed by clicking your user account initials at the bottom of the sidebar). You can then choose any installed theme from the dropdown list and it will be applied immediately.
|
||||
This will overrule the theme settings set by the above service calls, and will only be applied to the current device.
|
||||
|
||||
<p class='img'>
|
||||
|
||||
@ -23,7 +23,7 @@ Frontier Silicon is used by many different brands of radio manufacturers.
|
||||
|
||||
Supported devices include, but are not limited to:
|
||||
|
||||
- Hama: [IR50], [IR110], [DIR3110]
|
||||
- Hama: [IR50], [IR110], [DIR3110], [DIR355BT]
|
||||
- Medion: [Medion Radios]
|
||||
- Silvercrest: [SIRD 14 C2 (archived website)]
|
||||
- Teufel: [Radio 3sixty (2019)]
|
||||
|
||||
@ -73,7 +73,7 @@ devices:
|
||||
|
||||
### Extended Configuration Sample
|
||||
|
||||
The following example `configuration.yaml` has two different FutureNow units with multiple channels:
|
||||
The following example {% term "`configuration.yaml`" %} has two different FutureNow units with multiple channels:
|
||||
|
||||
```yaml
|
||||
# Example configuration.yaml entry
|
||||
|
||||
@ -114,7 +114,7 @@ customize:
|
||||
|
||||
{% endraw %}
|
||||
|
||||
Some of the Garadget sensors can create a lot of clutter in the logbook. Use this section of code in your `configuration.yaml` to exclude those entries.
|
||||
Some of the Garadget sensors can create a lot of clutter in the logbook. Use this section of code in your{% term "`configuration.yaml`" %} to exclude those entries.
|
||||
|
||||
```yaml
|
||||
logbook:
|
||||
|
||||
@ -53,7 +53,7 @@ port:
|
||||
|
||||
## Binary sensor
|
||||
|
||||
To enable this sensor, you first have to set up [gc100](#configuration), and add the following lines to your `configuration.yaml` file:
|
||||
To enable this sensor, you first have to set up [gc100](#configuration), and add the following lines to your{% term "`configuration.yaml`" %} file:
|
||||
|
||||
```yaml
|
||||
# Example configuration.yaml entry
|
||||
|
||||
@ -179,7 +179,7 @@ value_template: "{{ state_attr('climate.genius_zone_12', 'status').occupied }}"
|
||||
|
||||
## Configuration
|
||||
|
||||
To set up this integration, add one of the following to your `configuration.yaml` file.
|
||||
To set up this integration, add one of the following to your{% term "`configuration.yaml`" %}on.yaml`" %} file.
|
||||
|
||||
If required, you can switch between one Option and the other and, as the `unique_id` remains consistent, state history will be preserved. This assumes that the correct MAC address is provided for Option 2, below. If a wrong MAC address was provided for Option 1, then the MAC address can be overridden for Option 1 to maintain these links within the entity registry.
|
||||
|
||||
|
||||
@ -82,13 +82,13 @@ To use Google Assistant, your Home Assistant configuration has to be [externally
|
||||
9. Create a private key in JSON format.
|
||||
10. This will start a download of a JSON file.
|
||||
1. Rename the file to `SERVICE_ACCOUNT.JSON`.
|
||||
2. Add this file to your config-folder. This will be the same folder as your `configuration.yaml`.
|
||||
2. Add this file to your config-folder. This will be the same folder as your{% term "`configuration.yaml`" %}.
|
||||
11. Go back to [Google Cloud Platform](https://console.cloud.google.com/) and select **Close**.
|
||||
12. Then select **Save**.
|
||||
13. Go to the **Search products and resources** and search for **Homegraph API** and select it.
|
||||
14. Enable the HomeGraph API.
|
||||
|
||||
5. Add the `google_assistant` integration configuration to your `configuration.yaml` file and restart Home Assistant following the [configuration guide](#yaml-configuration) below.
|
||||
5. Add the `google_assistant` integration configuration to your{% term "`configuration.yaml`" %} file and restart Home Assistant following the [configuration guide](#yaml-configuration) below.
|
||||
6. Add services in the Google Home App (note that app versions may be slightly different).
|
||||
1. Open the Google Home app.
|
||||
2. Select the `+` button on the top left corner, select **Set up device**. In the **Set up a device** screen, select **Works with Google**. You should have `[test] <Action Name>` listed under **Add new**. Selecting that should lead you to a browser to login your Home Assistant instance, then redirect back to a screen where you can set rooms and nicknames for your devices if you wish.
|
||||
@ -167,7 +167,7 @@ You can debug the setup by following [these instructions](https://developers.hom
|
||||
|
||||
### YAML configuration
|
||||
|
||||
Now add your setup to your `configuration.yaml` file, such as:
|
||||
Now add your setup to your {% term "`configuration.yaml`" %} file, such as:
|
||||
|
||||
```yaml
|
||||
# Example configuration.yaml entry
|
||||
|
||||
@ -17,7 +17,7 @@ The `google_cloud` platform allows you to use [Google Cloud Platform](https://cl
|
||||
|
||||
## Configuration
|
||||
|
||||
To use Google Cloud Platform, you need to provide `config` directory relative path of [`API key`](#obtaining-an-api-key) file you are going to use. Place it under `config` folder and set `key_file` parameter in `configuration.yaml`:
|
||||
To use Google Cloud Platform, you need to provide `config` directory relative path of [`API key`](#obtaining-an-api-key) file you are going to use. Place it under `config` folder and set `key_file` parameter in {% term "`configuration.yaml`" %}:
|
||||
|
||||
```yaml
|
||||
# Example configuration.yaml entry
|
||||
@ -72,7 +72,7 @@ Basic instruction for all APIs:
|
||||
The Cloud text-to-speech API is priced monthly based on the amount of characters to synthesize into audio sent to the service.
|
||||
|
||||
| Voice | Monthly free tier | Paid usage |
|
||||
| ----------------------------- | ------------------------- | --------------------------------- |
|
||||
| ------------------ | ------------------------- | --------------------------------- |
|
||||
| Neural2 | 0 to 1 million bytes | $16.00 USD / 1 million bytes |
|
||||
| Polyglot (Preview) | 0 to 1 million bytes | $16.00 USD / 1 million bytes |
|
||||
| Studio (Preview) | 0 to 100 thousand bytes | $160.00 USD / 1 million bytes |
|
||||
|
||||
@ -28,6 +28,9 @@ The Google Generative AI API key is used to authenticate requests to the Google
|
||||
|
||||
- Visit the [API Keys page](https://makersuite.google.com/app/apikey) to retrieve the API key you'll use to configure the integration.
|
||||
|
||||
On the same page, you can see your plan: *free of charge* if the associated Google Cloud project doesn't have billing, or *pay-as-you-go* if the associated Google Cloud project has billing enabled.
|
||||
Comparison of the plans is available [here](https://ai.google.dev/pricing). The big differences are: free of charge is rate limited and free prompts/responses are used for product improvement.
|
||||
|
||||
{% include integrations/option_flow.md %}
|
||||
{% configuration_basic %}
|
||||
Model:
|
||||
@ -60,6 +63,12 @@ Safety settings:
|
||||
|
||||
### Service `google_generative_ai_conversation.generate_content`
|
||||
|
||||
<div class='note info'>
|
||||
|
||||
This service isn't tied to any integration entry, so it won't use the model, prompt, or any of the other settings in your options. If you only want to pass text, you should use the `conversation.process` service.
|
||||
|
||||
</div>
|
||||
|
||||
Allows you to ask Gemini Pro or Gemini Pro Vision to generate content from a prompt consisting of text and optionally images.
|
||||
This service populates [response data](/docs/scripts/service-calls#use-templates-to-handle-response-data) with the generated content.
|
||||
|
||||
|
||||
@ -61,4 +61,4 @@ Gree devices expose multiple switches to control various features:
|
||||
|
||||
- Light Panel, turns the front panel light on/off.
|
||||
- Quiet Mode, enables/disables the quiet mode feature.
|
||||
- Xtra Fan, enables/disables extra fan mode to remove help moisture from coils.
|
||||
- Xtra Fan, enables/disables extra fan mode to help remove moisture from coils.
|
||||
|
||||
Some files were not shown because too many files have changed in this diff Show More
Loading…
x
Reference in New Issue
Block a user