jeans/home-assistant.io
jeans/home-assistant.io
1
0
Fork 0
mirror of https://github.com/home-assistant/home-assistant.io.git synced 2025-07-28 03:37:06 +00:00
Code Issues Packages Projects Releases Wiki Activity

Merge branch 'current' into next

Browse Source
This commit is contained in:
Franck Nijhof 2024-04-23 22:43:52 +02:00
commit 31bd4f6d1a
No known key found for this signature in database
GPG Key ID: D62583BA8AB11CA3
186 changed files with 4161 additions and 3166 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

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

@ -18,7 +18,7 @@ jobs:
app_id: ${{ secrets.PROJECTS_APP_ID }}
private_key: ${{ secrets.PROJECTS_APP_PEM }}
- name: Add to Project
uses: actions/add-to-project@v1.0.0
uses: actions/add-to-project@v1.0.1
with:
project-url: https://github.com/orgs/home-assistant/projects/10
github-token: ${{ steps.token.outputs.token }}

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

@ -8,7 +8,7 @@ jobs:
runs-on: ubuntu-latest
steps:
- name: Check out files from GitHub
uses: actions/checkout@v4.1.2
uses: actions/checkout@v4.1.3
- 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.2
uses: actions/checkout@v4.1.3
- name: Setting up Node.js
uses: actions/setup-node@v4.0.2
with:

6
Gemfile
View File

@ -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.62.1'
gem 'ruby-lsp', '0.16.1'
gem 'rubocop', '1.63.3'
gem 'ruby-lsp', '0.16.4'
gem 'rackup', '2.1.0'
end
@ -23,7 +23,7 @@ group :jekyll_plugins do
end
gem 'sinatra', '4.0.0'
gem 'nokogiri', '1.16.3'
gem 'nokogiri', '1.16.4'
# Windows and JRuby does not include zoneinfo files, so bundle the tzinfo-data gem
# and associated library

16
Gemfile.lock
View File

@ -74,7 +74,7 @@ GEM
multi_json (1.15.0)
mustermann (3.0.0)
ruby2_keywords (~> 0.0.1)
nokogiri (1.16.3-x86_64-linux)
nokogiri (1.16.4-x86_64-linux)
racc (~> 1.4)
parallel (1.24.0)
parser (3.3.0.5)
@ -102,7 +102,7 @@ GEM
regexp_parser (2.9.0)
rexml (3.2.6)
rouge (4.2.1)
rubocop (1.62.1)
rubocop (1.63.3)
json (~> 2.3)
language_server-protocol (>= 3.17.0)
parallel (~> 1.10)
@ -115,7 +115,7 @@ GEM
unicode-display_width (>= 2.4.0, < 3.0)
rubocop-ast (1.31.2)
parser (>= 3.3.0.4)
ruby-lsp (0.16.1)
ruby-lsp (0.16.4)
language_server-protocol (~> 3.17.0)
prism (>= 0.22.0, < 0.25)
sorbet-runtime (>= 0.5.10782)
@ -123,7 +123,7 @@ GEM
ruby2_keywords (0.0.5)
safe_yaml (1.0.5)
sass (3.4.25)
sass-embedded (1.74.1-x86_64-linux-gnu)
sass-embedded (1.75.0-x86_64-linux-gnu)
google-protobuf (>= 3.25, < 5.0)
sass-globbing (1.1.5)
sass (>= 3.1)
@ -135,7 +135,7 @@ GEM
rack-protection (= 4.0.0)
rack-session (>= 2.0.0, < 3)
tilt (~> 2.0)
sorbet-runtime (0.5.11332)
sorbet-runtime (0.5.11353)
stringex (2.8.6)
terminal-table (3.0.2)
unicode-display_width (>= 1.1.1, < 3)
@ -157,11 +157,11 @@ DEPENDENCIES
jekyll-paginate (= 1.1.0)
jekyll-sitemap (= 1.4.0)
jekyll-toc (= 0.18.0)
nokogiri (= 1.16.3)
nokogiri (= 1.16.4)
rackup (= 2.1.0)
rake (= 13.2.1)
rubocop (= 1.62.1)
ruby-lsp (= 0.16.1)
rubocop (= 1.63.3)
ruby-lsp (= 0.16.4)
sass-globbing (= 1.1.5)
sassc (= 2.1.0)
sinatra (= 4.0.0)

4
_config.yml
View File

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

3512
package-lock.json generated
View File

File diff suppressed because it is too large Load Diff

16
package.json
View File

@ -5,15 +5,15 @@
"devDependencies": {
"remark-cli": "^12.0.0",
"remark-frontmatter": "^5.0.0",
"remark-lint": "^9.1.2",
"remark-lint-fenced-code-flag": "^3.1.2",
"remark-lint-heading-increment": "^3.1.2",
"remark-lint-heading-style": "^3.1.2",
"remark-lint-no-shell-dollars": "^3.1.2",
"remark-lint-ordered-list-marker-style": "^3.1.2",
"remark-lint-ordered-list-marker-value": "^3.1.2",
"remark-lint": "^10.0.0",
"remark-lint-fenced-code-flag": "^4.0.0",
"remark-lint-heading-increment": "^4.0.0",
"remark-lint-heading-style": "^4.0.0",
"remark-lint-no-shell-dollars": "^4.0.0",
"remark-lint-ordered-list-marker-style": "^4.0.0",
"remark-lint-ordered-list-marker-value": "^4.0.0",
"remark-lint-prohibited-strings": "^4.0.0",
"remark-lint-unordered-list-marker-style": "^3.1.2",
"remark-lint-unordered-list-marker-style": "^4.0.0",
"remark-stringify": "^11.0.0",
"textlint": "^14.0.4",
"textlint-filter-rule-comments": "^1.2.2",

1
plugins/terminology_tooltip.rb
View File

@ -20,6 +20,7 @@ module Jekyll
end
def render(context)
@term.gsub!(/\"/, "")
entries = context.registers[:site].data["glossary"].select do |entry|
entry.key?("term") and (@term.casecmp(entry["term"]).zero? or (entry.key?("aliases") and entry["aliases"].any?{ |s| s.casecmp(@term)==0 }))
end

10
source/_dashboards/alarm-panel.markdown
View File

@ -3,6 +3,11 @@ type: card
title: "Alarm panel card"
sidebar_label: Alarm panel
description: "The alarm panel card allows you to arm and disarm your alarm control panel integrations."
related:
- docs: /integrations/frontend/
title: Themes
- docs: /dashboards/cards/
title: Dashboard cards
---
The alarm panel card allows you to arm and disarm your [alarm control panel](/integrations/#alarm) {% term integrations %}.
@ -81,8 +86,3 @@ states:
- arm_night
- armed_custom_bypass
```
## Related topics
- [Themes](/integrations/frontend/)
- [Dashboard cards](/dashboards/cards/)

10
source/_dashboards/area.markdown
View File

@ -3,6 +3,11 @@ type: card
title: "Area card"
sidebar_label: Area
description: "The area card gives control of your entities in a specified area."
related:
- docs: /integrations/frontend/
title: Themes
- docs: /dashboards/cards/
title: Dashboard cards
---
The area card lets you control and monitor an individual {% term area %}.
@ -86,8 +91,3 @@ navigation_path: my_bedroom
show_camera: true
theme: green
```
## Related topics
- [Themes](/integrations/frontend/)
- [Dashboard cards](/dashboards/cards/)

16
source/_dashboards/button.markdown
View File

@ -3,6 +3,15 @@ type: card
title: "Button card"
sidebar_label: Button
description: "The Button card allows you to add buttons to perform tasks."
related:
- docs: /dashboards/actions/
title: Card actions
- docs: /docs/scripts/
title: Scripts
- docs: /integrations/frontend/
title: Themes
- docs: /dashboards/cards/
title: Dashboard cards
---
The button card allows you to add buttons to perform tasks.
@ -136,10 +145,3 @@ tap_action:
<img src='/images/dashboards/entity_button_complex_card.png' alt='Screenshot of the Button card with script service'>
Screenshot of the button card with script service.
</p>
## Related topics
- [Card actions](/dashboards/actions/)
- [Scripts](/docs/scripts/)
- [Themes](/integrations/frontend/)
- [Dashboard cards](/dashboards/cards/)

10
source/_dashboards/calendar.markdown
View File

@ -3,6 +3,11 @@ type: card
title: "Calendar card"
sidebar_label: Calendar
description: "The calendar card displays your calendar entities in a month, day and list view"
related:
- docs: /integrations/frontend/
title: Themes
- docs: /dashboards/cards/
title: Dashboard cards
---
The calendar card displays your [calendar](/integrations/#calendar) {% term entities %} in a month, day, and list view (7 days).
@ -52,8 +57,3 @@ entities:
- calendar.calendar_1
- calendar.calendar_2
```
## Related topics
- [Themes](/integrations/frontend/)
- [Dashboard cards](/dashboards/cards/)

6
source/_dashboards/conditional.markdown
View File

@ -3,6 +3,9 @@ type: card
title: Conditional card
sidebar_label: Conditional
description: The Conditional card displays another card based on conditions.
related:
- docs: /dashboards/cards/
title: Dashboard cards
---
The conditional card displays another card based on conditions.
@ -242,6 +245,3 @@ conditions:
{% endconfiguration %}
## Related topics
- [Dashboard cards](/dashboards/cards/)

10
source/_dashboards/energy.markdown
View File

@ -3,6 +3,11 @@ type: card
title: "Energy cards"
sidebar_label: Energy cards
description: "An overview of the energy cards that are available."
related:
- docs: /integrations/frontend/
title: Themes
- docs: /dashboards/cards/
title: Dashboard cards
---
This is a list of all the cards used in the energy dashboard. You can also place them anywhere you want in your dashboard.
@ -229,8 +234,3 @@ The following example limits the number of shown devices to 5:
type: energy-devices-detail-graph
max_devices: 5
```
## Related topics
- [Themes](/integrations/frontend/)
- [Dashboard cards](/dashboards/cards/)

13
source/_dashboards/entities.markdown
View File

@ -3,6 +3,13 @@ type: card
title: "Entities card"
sidebar_label: Entities
description: "The entities card is the most common type of card. It groups items together into lists."
related:
- docs: /dashboards/actions/
title: Card actions
- docs: /dashboards/header-footer/
title: Card header and footer
- docs: /dashboards/cards/
title: Dashboard cards
---
The entities card is the most common type of card. It groups items together into lists. It can be used to display an entity's state or attribute, but also contain buttons, web links, etc.
@ -456,9 +463,3 @@ entities:
text: Are you sure you want to restart?
service: script.libreelec_power_cycle
```
## Related topics
- [Card actions](/dashboards/actions/)
- [Card header and footer](/dashboards/header-footer/)
- [Dashboard cards](/dashboards/cards/)

13
source/_dashboards/entity.markdown
View File

@ -3,6 +3,13 @@ type: card
title: "Entity card"
sidebar_label: Entity
description: "The entity card gives you a quick overview of your entity's state"
related:
- docs: /integrations/frontend/
title: Themes
- docs: /dashboards/header-footer/
title: Card header and footer
- docs: /dashboards/cards/
title: Dashboard cards
---
The entity card gives you a quick overview of your entity's state.
@ -78,9 +85,3 @@ footer:
attribute: battery_level
unit: "%"
```
## Related topics
- [Card header and footer](/dashboards/header-footer/)
- [Themes](/integrations/frontend/)
- [Dashboard cards](/dashboards/cards/)

11
source/_dashboards/gauge.markdown
View File

@ -3,6 +3,11 @@ type: card
title: "Gauge card"
sidebar_label: Gauge
description: "The gauge card is a basic card that allows visually seeing sensor data."
related:
- docs: /integrations/frontend/
title: Themes
- docs: /dashboards/cards/
title: Dashboard cards
---
The gauge card is a basic card that allows visually seeing sensor data.
@ -181,9 +186,3 @@ segments:
- from: 65
color: var(--error-color)
```
## Related topics
- [Themes](/integrations/frontend/)
- [Dashboard cards](/dashboards/cards/)

13
source/_dashboards/glance.markdown
View File

@ -3,6 +3,13 @@ type: card
title: "Glance card"
sidebar_label: Glance
description: "The glance card is useful to group multiple sensors in a compact overview."
related:
- docs: /dashboards/actions/
title: Card actions
- docs: /integrations/frontend/
title: Themes
- docs: /dashboards/cards/
title: Dashboard cards
---
The glance card is useful to group multiple sensors in a compact overview. Keep in mind that this can be used together with [entity-filter](/dashboards/entity-filter/) cards to create dynamic cards.
@ -157,9 +164,3 @@ entities:
tap_action:
action: toggle
```
## Related topics
- [Card actions](/dashboards/actions/)
- [Themes](/integrations/frontend/)
- [Dashboard cards](/dashboards/cards/)

10
source/_dashboards/grid.markdown
View File

@ -3,6 +3,11 @@ type: card
title: "Grid card"
sidebar_label: Grid
description: "The grid card allows you to show multiple cards in a grid."
related:
- docs: /integrations/frontend/
title: Themes
- docs: /dashboards/cards/
title: Dashboard cards
---
The grid card allows you to show multiple cards in a grid. It will first fill the columns, automatically adding new rows as needed.
@ -80,8 +85,3 @@ cards:
entity: light.bed_light
image: /local/bed_2.png
```
## Related topics
- [Themes](/integrations/frontend/)
- [Dashboard cards](/dashboards/cards/)

10
source/_dashboards/history-graph.markdown
View File

@ -3,6 +3,11 @@ type: card
title: "History graph card"
sidebar_label: History graph
description: "The history graph card allows you to display a graph for each of the entities listed."
related:
- docs: /integrations/frontend/
title: Themes
- docs: /dashboards/cards/
title: Dashboard cards
---
The history graph card allows you to display a graph for each of up to eight entities.
@ -107,8 +112,3 @@ entities:
- entity: sensor.attic_temperature
name: "Attic"
```
## Related topics
- [Themes](/integrations/frontend/)
- [Dashboard cards](/dashboards/cards/)

7
source/_dashboards/horizontal-stack.markdown
View File

@ -3,6 +3,9 @@ type: card
title: "Horizontal stack card"
sidebar_label: Horizontal stack
description: "The horizontal stack card allows you to stack together multiple cards, so they always sit next to each other in the space of one column."
related:
- docs: /dashboards/cards/
title: Dashboard cards
---
The horizontal stack card allows you to stack together multiple cards, so they always sit next to each other in the space of one column.
@ -46,7 +49,3 @@ cards:
<img src='/images/dashboards/horizontal_stack.png' alt='Two picture cards in a horizontal stack card'>
Two picture cards in a horizontal stack card.
</p>
## Related topics
- [Dashboard cards](/dashboards/cards/)

9
source/_dashboards/humidifier.markdown
View File

@ -3,6 +3,11 @@ type: card
title: "Humidifier card"
sidebar_label: Humidifier
description: "The humidifier card gives control of your humidifier entity, allowing you to change the target humidity and mode of the entity."
related:
- docs: /integrations/frontend/
title: Themes
- docs: /dashboards/cards/
title: Dashboard cards
---
The humidifier card lets you control and monitor humidifiers, dehumidifiers, and hygrostat devices.
@ -57,7 +62,3 @@ entity: humidifier.bedroom
name: Bedroom Humidifier
```
## Related topics
- [Card features](/dashboards/features)
- [Themes](/integrations/frontend/)

12
source/_dashboards/iframe.markdown
View File

@ -3,10 +3,17 @@ type: card
title: "Webpage card"
sidebar_label: Webpage
description: "The webpage card allows you to embed your favorite webpage right into Home Assistant."
related:
- docs: /dashboards/dashboards/#webpage-dashboard
title: Webpage dashboard
- docs: /dashboards/cards/
title: Dashboard cards
---
The webpage card allows you to embed your favorite webpage right into Home Assistant. You can also embed files stored in your `<config-directory>/www` folder and reference them using `/local/<file>`.
The webpage card is used on the [Webpage dashboard](/dashboards/dashboards/#webpage-dashboard).
<p class='img'>
<img width="500" src='/images/dashboards/iframe.png' alt='Windy weather radar as Webpage'>
Windy weather radar as webpage.
@ -16,6 +23,7 @@ The webpage card allows you to embed your favorite webpage right into Home Assis
All options for this card can be configured via the user interface.
Note that not every webpage can be embedded due to security restrictions that some sites have in place. These restrictions are enforced by your browser and prevent embedding them into a Home Assistant dashboard.
<div class='note warning'>
You can't embed sites using HTTP if you are using HTTPS for your Home Assistant.
</div>
@ -61,7 +69,3 @@ type: iframe
url: https://www.home-assistant.io
aspect_ratio: 75%
```
## Related topics
- [Dashboard cards](/dashboards/cards/)

13
source/_dashboards/light.markdown
View File

@ -3,6 +3,13 @@ type: card
title: "Light card"
sidebar_label: Light
description: "The light card allows you to change the brightness of the light."
related:
- docs: /dashboards/actions/
title: Card actions
- docs: /integrations/frontend/
title: Themes
- docs: /dashboards/cards/
title: Dashboard cards
---
The light card allows you to change the brightness of the light.
@ -80,9 +87,3 @@ name: My Office
<img src='/images/dashboards/light_complex_card.png' alt='Screenshot of the Light card'>
Screenshot of the Light card names.
</p>
## Related topics
- [Card actions](/dashboards/actions/)
- [Themes](/integrations/frontend/)
- [Dashboard cards](/dashboards/cards/)

10
source/_dashboards/logbook.markdown
View File

@ -3,6 +3,11 @@ type: card
title: "Logbook card"
sidebar_label: Logbook
description: "The logbook card displays entries from the logbook for specific entities."
related:
- docs: /integrations/frontend/
title: Themes
- docs: /dashboards/cards/
title: Dashboard cards
---
The logbook card displays entries from the logbook for specific entities.
@ -65,8 +70,3 @@ entities:
- light.ceiling_lights
hours_to_show: 24
```
## Related topics
- [Themes](/integrations/frontend/)
- [Dashboard cards](/dashboards/cards/)

13
source/_dashboards/map.markdown
View File

@ -3,6 +3,13 @@ type: card
title: "Map card"
sidebar_label: Map
description: "The map card that allows you to display entities on a map"
related:
- docs: /dashboards/dashboards/#map-dashboard
title: Map dashboard
- docs: /integrations/frontend/
title: Themes
- docs: /dashboards/cards/
title: Dashboard cards
---
The map card that allows you to display entities on a map. This card is used on the [Map dashboard](/dashboards/dashboards/#map-dashboard), which is one of the default dashboards.
@ -134,9 +141,3 @@ entities:
focus: false
hours_to_show: 48
```
## Related topics
- [Themes](/integrations/frontend/)
- [Dashboard cards](/dashboards/cards/)
- [Map dashboard](/dashboards/dashboards/#map-dashboard)

10
source/_dashboards/markdown.markdown
View File

@ -3,6 +3,11 @@ type: card
title: "Markdown card"
sidebar_label: Markdown
description: "The Markdown card is used to render Markdown"
related:
- docs: /integrations/frontend/
title: Themes
- docs: /dashboards/cards/
title: Dashboard cards
---
The Markdown card is used to render [Markdown](https://commonmark.org/help/).
@ -140,8 +145,3 @@ content: |
<ha-alert alert-type="success">This is a success alert — check it out!</ha-alert>
<ha-alert title="Test alert">This is an alert with a title</ha-alert>
```
## Related topics
- [Themes](/integrations/frontend/)
- [Dashboard cards](/dashboards/cards/)

10
source/_dashboards/masonry.markdown
View File

@ -3,6 +3,11 @@ type: view
title: Masonry view
sidebar_label: Masonry (default)
description: "The default panel layout uses a masonry algorithm."
related:
- docs: /dashboards/panel/
title: Panel view
- docs: /dashboards/sidebar/
title: Sidebar view
---
The masonry view is the default view type.
@ -27,8 +32,3 @@ type:
description: "`masonry`"
type: string
{% endconfiguration %}
## Related topics
- [Panel view](/dashboards/panel/)
- [Sidebar view](/dashboards/sidebar/)

10
source/_dashboards/media-control.markdown
View File

@ -3,6 +3,11 @@ type: card
title: "Media control card"
sidebar_label: Media control
description: "The media control card is used to display media player entities on an interface with easy to use controls."
related:
- docs: /integrations/frontend/
title: Themes
- docs: /dashboards/cards/
title: Dashboard cards
---
The media control card is used to display [media player](/integrations/#media-player) entities on an interface with easy to use controls.
@ -46,8 +51,3 @@ Basic example:
type: media-control
entity: media_player.lounge_room
```
## Related topics
- [Themes](/integrations/frontend/)
- [Dashboard cards](/dashboards/cards/)

10
source/_dashboards/panel.markdown
View File

@ -3,6 +3,11 @@ type: view
title: Panel view
sidebar_label: Panel
description: "The panel view shows a single card in the full width of the screen."
related:
- docs: /dashboards/masonry/
title: Masonry view
- docs: /dashboards/sidebar/
title: Sidebar view
---
The panel view must have exactly one card. This card is rendered full-width.
@ -22,8 +27,3 @@ type:
description: "`panel`"
type: string
{% endconfiguration %}
## Related topics
- [Masonry view](/dashboards/masonry/)
- [Sidebar view](/dashboards/sidebar/)

13
source/_dashboards/picture-elements.markdown
View File

@ -3,6 +3,13 @@ type: card
title: "Picture elements card"
sidebar_label: Picture elements
description: "The picture elements card is one of the most versatile types of cards. The cards allow you to position icons or text and even services! On an image based on coordinates."
related:
- docs: /dashboards/actions/
title: Card actions
- docs: /integrations/frontend/
title: Themes
- docs: /dashboards/cards/
title: Dashboard cards
---
The picture elements card is one of the most versatile types of cards.
@ -573,9 +580,3 @@ elements:
top: 47%
left: 42%
```
## Related topics
- [Card actions](/dashboards/actions/)
- [Themes](/integrations/frontend/)
- [Dashboard cards](/dashboards/cards/)

12
source/_dashboards/picture-entity.markdown
View File

@ -3,6 +3,13 @@ type: card
title: Picture entity card
sidebar_label: Picture entity
description: The picture entity card displays an entity in the form of an image. Instead of images from URL, it can also show the picture of camera entities.
related:
- docs: /dashboards/actions/
title: Card actions
- docs: /integrations/frontend/
title: Themes
- docs: /dashboards/cards/
title: Dashboard cards
---
The picture entity card displays an entity in the form of an image. Instead of images from URL, it can also show the picture of `camera` entities.
@ -139,8 +146,3 @@ tap_action:
The filename needs to be a path that is writable by Home Assistant in your system. You may need to configure `allowlist_external_dirs` ([documentation](/docs/configuration/basic/)).
## Related topics
- [Card actions](/dashboards/actions/)
- [Themes](/integrations/frontend/)
- [Dashboard cards](/dashboards/cards/)

13
source/_dashboards/picture-glance.markdown
View File

@ -3,6 +3,13 @@ type: card
title: "Picture glance card"
sidebar_label: Picture glance
description: "The picture glance card shows an image and corresponding entity states as an icon. The entities on the right side allow toggle actions, others show the more information dialog."
related:
- docs: /dashboards/actions/
title: Card actions
- docs: /integrations/frontend/
title: Themes
- docs: /dashboards/cards/
title: Dashboard cards
---
The picture glance card shows an image and lets you place small icons of entity states on top of that card to control those entities from there. In the image below: the entities on the right allow toggle actions, the others show the more information dialog.
@ -267,9 +274,3 @@ state_image:
"off": /local/living_room_off.png
entity: group.living.room
```
## Related topics
- [Card actions](/dashboards/actions/)
- [Themes](/integrations/frontend/)
- [Dashboard cards](/dashboards/cards/)

13
source/_dashboards/picture.markdown
View File

@ -3,6 +3,13 @@ type: card
title: "Picture card"
sidebar_label: Picture
description: "The picture card allows you to set an image to use for navigation to various paths in your interface or to call a service."
related:
- docs: /dashboards/actions/
title: Card actions
- docs: /integrations/frontend/
title: Themes
- docs: /dashboards/cards/
title: Dashboard cards
---
The picture card allows you to set an image to use for navigation to various paths in your interface or to call a service.
@ -74,9 +81,3 @@ tap_action:
data:
entity_id: light.ceiling_lights
```
## Related topics
- [Card actions](/dashboards/actions/)
- [Themes](/integrations/frontend/)
- [Dashboard cards](/dashboards/cards/)

10
source/_dashboards/plant-status.markdown
View File

@ -3,6 +3,11 @@ type: card
title: "Plant status card"
sidebar_label: Plant status
description: "The plant status card is for all the lovely botanists out there."
related:
- docs: /integrations/frontend/
title: Themes
- docs: /dashboards/cards/
title: Dashboard cards
---
The plant status card is for all the lovely botanists out there.
@ -48,8 +53,3 @@ Basic example:
type: plant-status
entity: plant.bonsai
```
## Related topics
- [Themes](/integrations/frontend/)
- [Dashboard cards](/dashboards/cards/)

32
source/_dashboards/sections.markdown
View File

@ -3,6 +3,20 @@ type: view
title: Sections (experimental)
sidebar_label: Sections (experimental)
description: "Lets you organize your cards in sections on a grid."
description: "The panel view shows a single card in the full width of the screen."
related:
- docs: /dashboards/masonry/
title: Masonry view
- docs: /dashboards/sidebar/
title: Sidebar view
- docs: /dashboards/panel/
title: Panel view
- docs: /blog/2024/03/04/dashboard-chapter-1/
title: Dashboard chapter 1 blog post
- docs: /dashboards/cards/#adding-cards-to-your-dashboard
title: Adding cards to a view
- docs: /dashboards/views/#adding-a-view-to-a-dashboard
title: Adding a new view
---
The sections view lets you organize your cards in sections on a grid.
@ -21,15 +35,16 @@ You can group cards without using horizontal or vertical stack cards.
1. If you have multiple dashboards, in the left sidebar, select the dashboard to which you want to add the sections view.
2. [Add a new view](/dashboards/views/#adding-a-view-to-a-dashboard) and under **View type**, select **Sections**.
3. To add a card, select the **Add card** button.
3. Select the number of columns you want to see in the new view. Select **Save**.
4. To add a card, select the **Add card** button.
- Follow the [steps on adding cards](/dashboards/cards/#adding-cards-to-your-dashboard).
![Add Section button](/images/dashboards/sections_view_add-card-or-section.png)
4. To add a section, select the **Create section** button.
5. To edit the section title, select the <img height="28px" src="/images/blog/2024-03-dashboard-chapter-1/mdi-edit.png" alt="Edit icon"/> button.
5. To add a section, select the **Create section** button.
6. To edit the section title, select the <img height="28px" src="/images/blog/2024-03-dashboard-chapter-1/mdi-edit.png" alt="Edit icon"/> button.
- If you leave the section title empty, this line will be hidden.
6. To delete a section, select the <img height="28px" src="/images/blog/2024-03-dashboard-chapter-1/mdi-trash.png" alt="Delete icon"/> button.
7. To delete a section, select the <img height="28px" src="/images/blog/2024-03-dashboard-chapter-1/mdi-trash.png" alt="Delete icon"/> button.
## Rearranging sections and cards
@ -68,12 +83,3 @@ type:
description: "`sections`"
type: string
{% endconfiguration %}
## Related topics
- [Masonry view](/dashboards/masonry/)
- [Panel view](/dashboards/panel/)
- [Sidebar view](/dashboards/sidebar/)
- [Dashboard chapter 1 blog post](/blog/2024/03/04/dashboard-chapter-1/)
- [Adding cards to a view](/dashboards/cards/#adding-cards-to-your-dashboard)
- [Adding a new view](/dashboards/views/#adding-a-view-to-a-dashboard)

10
source/_dashboards/sensor.markdown
View File

@ -3,6 +3,11 @@ type: card
title: "Sensor card"
sidebar_label: Sensor
description: "The sensor card gives you a quick overview of your sensors state with an optional graph to visualize change over time."
related:
- docs: /integrations/frontend/
title: Themes
- docs: /dashboards/cards/
title: Dashboard cards
---
The sensor card gives you a quick overview of your sensors state with an optional graph to visualize change over time.
@ -83,8 +88,3 @@ type: sensor
entity: sensor.illumination
name: Illumination
```
## Related topics
- [Themes](/integrations/frontend/)
- [Dashboard cards](/dashboards/cards/)

11
source/_dashboards/shopping-list.markdown
View File

@ -1,6 +1,12 @@
---
title: "Shopping list card"
description: "The shopping list card allows you to add, edit, check-off, and clear items from your shopping list."
description: "The panel view shows a single card in the full width of the screen."
related:
- docs: /integrations/todo/
title: To-do list integration
- docs: /integrations/local_todo/
title: Local to-do integration
---
Note: the shopping list card is no longer available as a card to add from the user interface. Use the [to-do list card](/dashboards/todo-list/) instead.
@ -45,8 +51,3 @@ Title example:
type: shopping-list
title: shopping list
```
## Related topics
- [To-do list integration](/integrations/todo)
- [Local to-do integration](/integrations/local_todo/)

12
source/_dashboards/sidebar.markdown
View File

@ -3,6 +3,11 @@ type: view
title: Sidebar view
sidebar_label: Sidebar
description: "The sidebar view has 2 columns, a wide one and a smaller one on the right."
related:
- docs: /dashboards/masonry/
title: Masonry view
- docs: /dashboards/panel/
title: Panel view
---
The sidebar view has 2 columns, a wide one and a smaller one on the right.
@ -53,9 +58,4 @@ cards:
- media_player.lounge_room
view_layout:
position: sidebar
```
## Related topics
- [Panel view](/dashboards/panel/)
- [Masonry view](/dashboards/masonry/)
```

10
source/_dashboards/statistic.markdown
View File

@ -3,6 +3,11 @@ type: card
title: "Statistic card"
sidebar_label: Statistic
description: "The statistic card allows you to display a statistical value for an entity."
related:
- docs: /integrations/frontend/
title: Themes
- docs: /dashboards/cards/
title: Dashboard cards
---
The statistic card allows you to display a statistical value for an entity.
@ -172,8 +177,3 @@ period:
seconds: -10
stat_type: change
```
## Related topics
- [Themes](/integrations/frontend/)
- [Dashboard cards](/dashboards/cards/)

10
source/_dashboards/statistics-graph.markdown
View File

@ -3,6 +3,11 @@ type: card
title: "Statistics graph card"
sidebar_label: Statistics graph
description: "The statistics graph card allows you to display a graph with statistics data for each of the entities listed."
related:
- docs: /integrations/frontend/
title: Themes
- docs: /dashboards/cards/
title: Dashboard cards
---
The statistics graph card allows you to display a graph of statistics data for each of the entities listed.
@ -96,8 +101,3 @@ entities:
- entity: sensor.inside_temperature
name: Inside
```
## Related topics
- [Themes](/integrations/frontend/)
- [Dashboard cards](/dashboards/cards/)

10
source/_dashboards/thermostat.markdown
View File

@ -3,6 +3,11 @@ type: card
title: "Thermostat card"
sidebar_label: Thermostat
description: "The thermostat card gives control of your climate entity, allowing you to change the temperature and mode of the entity."
related:
- docs: /integrations/frontend/
title: Themes
- docs: /dashboards/cards/
title: Dashboard cards
---
The thermostat card gives control of your [climate](/integrations/#climate) {% term entity %}, allowing you to change the temperature and mode of the {% term entity %}.
@ -55,8 +60,3 @@ features:
type: thermostat
entity: climate.nest
```
## Related topics
- [Card features](/dashboards/features)
- [Themes](/integrations/frontend/)

14
source/_dashboards/tile.markdown
View File

@ -3,6 +3,13 @@ type: card
title: "Tile card"
sidebar_label: Tile
description: "The tile card gives you a quick overview of your entity. The card allows you to toggle the entity, show the more-info dialog, or custom actions."
related:
- docs: /dashboards/actions/
title: Card actions
- docs: /dashboards/features
title: Card features
- docs: /dashboards/cards/
title: Dashboard cards
---
The tile card gives you a quick overview of your {% term entity %}. The card allows you to toggle the {% term entity %} and show the more info dialog. A badge is shown for some {% term entities %} like the [climate](/integrations/climate) or [person](/integrations/person) {% term entities %}.
@ -33,7 +40,7 @@ icon:
type: string
color:
required: false
description: Set the color when the entity is active. By default, the color is based on `state`, `domain`, and `device_class` of your entity. It accepts [color token](/dashboards/tile/#available-color-tokens) or hex color code.
description: Set the color when the entity is active. By default, the color is based on `state`, `domain`, and `device_class` of your entity. It accepts [color token](/dashboards/tile/#available-colors) or hex color code.
type: string
default: state
show_entity_picture:
@ -130,8 +137,3 @@ 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`.
## Related topics
- [Card actions](/dashboards/actions/)
- [Card features](/dashboards/features)
- [Dashboard cards](/dashboards/cards/)

25
source/_dashboards/todo-list.markdown
View File

@ -3,6 +3,19 @@ type: card
title: "To-do list card"
sidebar_label: To-do list
description: "The to-do list card allows you to add, edit, check-off, and clear items from your to-do list."
related:
- docs: /dashboards/dashboards/
title: Dashboards
- docs: /integrations/frontend/
title: Themes
- docs: /dashboards/cards/
title: Dashboard cards
- docs: /integrations/todo
title: To-do list integration documentation
- docs: /integrations/#to-do-list
title: List of to-do list integrations
- docs: /integrations/local_todo/
title: Local to-do integration
---
The to-do list card allows you to add, edit, check-off, and clear items from your to-do list.
@ -59,15 +72,3 @@ type: todo-list
entity: todo-list
title: todo list
```
## Related topics
- [To-do list integration documentation](/integrations/todo)
- [List of to-do list integrations](/integrations/#to-do-list)
- [Local to-do integration](/integrations/local_todo/)
### Dashboards, cards, and themes
- [Dashboards](/dashboards/dashboards/)
- [Dashboard cards](/dashboards/cards/)
- [Themes](/integrations/frontend/)

6
source/_dashboards/vertical-stack.markdown
View File

@ -3,6 +3,9 @@ type: card
title: "Vertical stack card"
sidebar_label: Vertical stack
description: "The vertical stack card allows you to group multiple cards so they always sit in the same column."
related:
- docs: /dashboards/cards/
title: Dashboard cards
---
The vertical stack card allows you to group multiple cards so they always sit in the same column.
@ -72,6 +75,3 @@ cards:
Create a grid layout using vertical and horizontal stack.
</p>
## Related topics
- [Dashboard cards](/dashboards/cards/)

10
source/_dashboards/weather-forecast.markdown
View File

@ -3,6 +3,11 @@ type: card
title: "Weather forecast card"
sidebar_label: Weather forecast
description: "The weather forecast card displays the weather. Very useful to include on interfaces that people display on the wall."
related:
- docs: /integrations/frontend/
title: Themes
- docs: /dashboards/cards/
title: Dashboard cards
---
The weather forecast card displays the weather. This card is particularly useful on wall-mounted displays.
@ -153,8 +158,3 @@ Example theme configuration:
```yaml
--weather-icon-sunny: url("/local/sunny.png")
```
## Related topics
- [Themes](/integrations/frontend/)
- [Dashboard cards](/dashboards/cards/)

449
source/_data/glossary.yml
View File

@ -3,20 +3,30 @@
# Format is a list of terms, each term is a dictionary with the following keys:
# - term: The term to define (required)
# - definition: The definition of the term (required)
# - excerpt: Short excerpt of the definition, overrides definition for tooltips (optional)
# - excerpt: Short excerpt of the definition, overrides definition for tooltips
# (optional)
# - link: A URL to link to for more information (optional)
# - aliases: A list of aliases for the term (optional)
#
- term: Action
definition: |-
Actions are used in several places in Home Assistant. As part of a script or automation, actions define what is going to happen once a trigger is activated. In scripts, an action is called *sequence*.
Actions use service calls and/or scenes to interact with entities and cause these entities to do something. Actions can also include conditions and a delay. An action can call multiple services at the same time. For example, if your presence is detected in a room, an action may call one service to turn on a light and call another service to start playing music after a delay.
Actions are also used on the dashboard, for example as tap or hold action on a UI element. When triggered, the action calls a service.
Actions are used in several places in Home Assistant. As part of a script or
automation, actions define what is going to happen once a trigger is
activated. In scripts, an action is called *sequence*. Actions use service
calls and/or scenes to interact with entities and cause these entities to do
something. Actions can also include conditions and a delay. An action can
call multiple services at the same time. For example, if your presence is
detected in a room, an action may call one service to turn on a light and
call another service to start playing music after a delay. Actions are also
used on the dashboard, for example as tap or hold action on a UI element.
When triggered, the action calls a service.
aliases:
- actions
link: /docs/automation/action/
excerpt: >
Actions are used in several places in Home Assistant. As part of a script or automation, actions define what is going to happen once a trigger is activated. In scripts, an action is called *sequence*.
Actions are used in several places in Home Assistant. As part of a script or
automation, actions define what is going to happen once a trigger is
activated. In scripts, an action is called *sequence*.
- term: Add-on
definition: >-
Add-ons are additional standalone third-party software packages that can be
@ -28,23 +38,29 @@
installed on Home Assistant OS.
- term: Area
definition: >-
An area in Home Assistant is a logical grouping of devices and entities that are meant to match areas (or rooms) in the physical world: your home. For example, the `living room` area groups devices and entities in your living room. Areas allow you to target service calls at an entire group of devices. For example, turning off all the lights in the living room.
Locations within your home such as living room, dance floor, etc.
Areas can be assigned to floors.
Areas can also be used for automatically
generated cards, such as the [Area card](/dashboards/area/).
An area in Home Assistant is a logical grouping of devices and entities that
are meant to match areas (or rooms) in the physical world: your home. For
example, the `living room` area groups devices and entities in your living
room. Areas allow you to target service calls at an entire group of devices.
For example, turning off all the lights in the living room. Locations within
your home such as living room, dance floor, etc. Areas can be assigned to
floors. Areas can also be used for automatically generated cards, such as
the [Area card](/dashboards/area/).
excerpt: >-
An area in Home Assistant is a logical grouping of devices and entities that are meant to match areas (or rooms) in the physical world: your home. For example, the `living room` area groups devices and entities in your living room.
An area in Home Assistant is a logical grouping of devices and entities that
are meant to match areas (or rooms) in the physical world: your home. For
example, the `living room` area groups devices and entities in your living
room.
aliases:
- areas
- term: Automation
definition: >-
Automations connect one or more triggers to one or more actions in a
'when trigger then do action' fashion with additional optional conditions.
For example, an automation might connect the trigger 'sunset' to the action
Automations connect one or more triggers to one or more actions in a 'when
trigger then do action' fashion with additional optional conditions. For
example, an automation might connect the trigger 'sunset' to the action
'turn the lights on' but only if the condition 'someone is home' is met.
Pre-made automations for common use-cases are available via
[the blueprints feature](/docs/automation/using_blueprints/).
Pre-made automations for common use-cases are available via [the blueprints
feature](/docs/automation/using_blueprints/).
excerpt: >-
Automations in Home Assistant allow you to automatically respond to things
that happen in and around your home.
@ -53,14 +69,14 @@
- automations
- term: Backup
definition: >-
Home Assistant has built-in functionality to create files containing a copy of
your configuration. This can be used to restore your Home Assistant as well
as migrate to a new system. The backup feature is available on some installation
types.
Home Assistant has built-in functionality to create files containing a copy
of your configuration. This can be used to restore your Home Assistant as
well as migrate to a new system. The backup feature is available on some
installation types.
link: /integrations/backup/
excerpt: >-
Home Assistant has built-in functionality to create files containing a copy of
your configurations. This is available on certain installation types.
Home Assistant has built-in functionality to create files containing a copy
of your configurations. This is available on certain installation types.
aliases:
- backups
- term: Binary sensor
@ -70,54 +86,85 @@
link: /integrations/binary_sensor
- term: Blueprint
definition: >-
A blueprint is a script or automation configuration with certain parts marked as configurable. This allows users to create multiple scripts or automations based on the same blueprint, with each having its own configuration-specific settings. Blueprints are shared by the community on the [blueprints exchange](https://community.home-assistant.io/c/blueprints-exchange/53) in the forum.
A blueprint is a script or automation configuration with certain parts
marked as configurable. This allows users to create multiple scripts or
automations based on the same blueprint, with each having its own
configuration-specific settings. Blueprints are shared by the community on
the [blueprints
exchange](https://community.home-assistant.io/c/blueprints-exchange/53) in
the forum.
link: /docs/blueprint/
excerpt: >-
A blueprint is a script or automation configuration with certain parts marked as configurable. This allows users to create multiple scripts or automations based on the same blueprint, with each having its own configuration-specific settings.
A blueprint is a script or automation configuration with certain parts
marked as configurable. This allows users to create multiple scripts or
automations based on the same blueprint, with each having its own
configuration-specific settings.
aliases:
- blueprints
- term: Category
definition: >-
A category is an organization tool that allows grouping items in a table. Like labels, categories allow grouping irrespective of the items' physical location. For example, on the automations page, you can create the categories “Notifications” or “NFC tags” to view your automations grouped or filtered. Categories are unique for each table. The automations page can have different categories than the scene, scripts, or helpers settings page.
A category is an organization tool that allows grouping items in a table.
Like labels, categories allow grouping irrespective of the items' physical
location. For example, on the automations page, you can create the
categories “Notifications” or “NFC tags” to view your automations grouped or
filtered. Categories are unique for each table. The automations page can
have different categories than the scene, scripts, or helpers settings page.
aliases:
- categories
- term: Commissioning
definition: >-
In the context of Matter devices, *commissioning* is the process of adding a device to a Matter controller. It is the equivalent of pairing a device in Zigbee or Z-Wave. Commissioning is done by scanning a QR code or entering a code manually. The code is printed on the device or its packaging. The code contains information about the device, such as its type, manufacturer, and serial number. The controller uses this information to identify the device and to download the required information to control the device. For example, the controller downloads the device's capabilities, such as the supported commands and the available attributes. The controller also downloads the device's configuration, such as the device's name and location.
In the context of Matter devices, *commissioning* is the process of adding a
device to a Matter controller. It is the equivalent of pairing a device in
Zigbee or Z-Wave. Commissioning is done by scanning a QR code or entering a
code manually. The code is printed on the device or its packaging. The code
contains information about the device, such as its type, manufacturer, and
serial number. The controller uses this information to identify the device
and to download the required information to control the device. For example,
the controller downloads the device's capabilities, such as the supported
commands and the available attributes. The controller also downloads the
device's configuration, such as the device's name and location.
link: /integrations/matter/
aliases:
- commission
excerpt: >
In the context of Matter devices, *commissioning* is the process of adding a device to a Matter controller. It is the equivalent of pairing a device in Zigbee or Z-Wave.
In the context of Matter devices, *commissioning* is the process of adding a
device to a Matter controller. It is the equivalent of pairing a device in
Zigbee or Z-Wave.
- term: Component
definition: >-
Better known as: Integrations. Integrations used to be known as components.
- term: Condition
definition: >-
Conditions are an optional part of an automation that will prevent an
action from firing if they are not met.
Conditions are an optional part of an automation that will prevent an action
from firing if they are not met.
link: /docs/scripts/conditions/
aliases:
- conditions
- term: Cover
definition: >-
Covers are devices such as blinds, garage doors, etc that can be opened
and closed and optionally set to a specific position.
Covers are devices such as blinds, garage doors, etc that can be opened and
closed and optionally set to a specific position.
link: /integrations/cover
- term: Customize
definition: >-
Customization allows you to overwrite the default parameters of your
devices in the configuration.
Customization allows you to overwrite the default parameters of your devices
in the configuration.
- term: Device
definition: |-
A device is a model representing a physical or logical unit that contains entities.
**Example for a device as a physical unit**
A smart plug named 'Coffee machine' which provides 2 entities: a `switch` entity to turn power on or off ('Coffee machine power switch') and a `sensor` entity for power monitoring ('Coffee machine power sensor').
**Example for a device as a logical unit**
An ecobee thermostat with 4 room sensors. This thermostat is seen as 5 devices in Home Assistant: 1 device for the thermostat with 4 sensors, and 1 device for each room sensor. Each device can be in a different area and may have more than one input or output within that area.
Devices have properties such as ID, manufacturer, name, model, hardware version, firmware version, connections, etc.
A device is a model representing a physical or logical unit that contains
entities. **Example for a device as a physical unit** A smart plug named
'Coffee machine' which provides 2 entities: a `switch` entity to turn power
on or off ('Coffee machine power switch') and a `sensor` entity for power
monitoring ('Coffee machine power sensor'). **Example for a device as a
logical unit** An ecobee thermostat with 4 room sensors. This thermostat is
seen as 5 devices in Home Assistant: 1 device for the thermostat with 4
sensors, and 1 device for each room sensor. Each device can be in a
different area and may have more than one input or output within that area.
Devices have properties such as ID, manufacturer, name, model, hardware
version, firmware version, connections, etc.
excerpt: >
A device is a model representing a physical or logical unit that contains entities.
A device is a model representing a physical or logical unit that contains
entities.
aliases:
- devices
- term: Device tracker
@ -130,35 +177,43 @@
they are discovered.
- term: Domain
definition: >-
Each integration in Home Assistant has a unique identifier:
a domain. All of the entities and services available in Home Assistant
are provided by integrations and thus belong to such a domain. The first
part of the entity or service, before the `.` shows the domain they belong
to. For example `light.kitchen` is an entity in the `light` domain from
the [light integration](/integrations/light), while `hue.activate_scene`
is the `activate_scene` service for the `hue` domain which belongs to
the [Hue integration](/integrations/hue).
Each integration in Home Assistant has a unique identifier: a domain. All of
the entities and services available in Home Assistant are provided by
integrations and thus belong to such a domain. The first part of the entity
or service, before the `.` shows the domain they belong to. For example
`light.kitchen` is an entity in the `light` domain from the [light
integration](/integrations/light), while `hue.activate_scene` is the
`activate_scene` service for the `hue` domain which belongs to the [Hue
integration](/integrations/hue).
excerpt: >
Each integration in Home Assistant has a unique identifier: The domain.
It is often shown as the first part (before the dot) of entity IDs.
Each integration in Home Assistant has a unique identifier: The domain. It
is often shown as the first part (before the dot) of entity IDs.
aliases:
- domains
- term: Entity
definition: |-
An entity represents a sensor, actor, or function in Home Assistant. Entities are used to monitor physical properties or to control other entities. An entity is usually part of a device or a service. Entities have states.
**Example for entities as part of a device**
A combined temperature and humidity sensor device provides two sensor entities. One for temperature (e.g. `sensor.temperature` with state `21.0` and unit `°C`) and one for humidity
(e.g. `sensor.humidity` with state `65.4` and unit `%`).
**Example for entities as part of a service**
A weather service that provides 3 entities: wind speed, air pressure, and ozon level.
**Example of an entity used for control**
A fan that is turned on when the temperature exceeds 30&nbsp;°C.
There are standardized types of entities for common integrations such as light, switch, camera, sensor, fan, or vacuum.
Some entities are not part of a device or service. Examples of standalone entities are automation, script, scene entities, and helper entities (e.g. input helpers).
Most properties of entities are related to the state. Entities have optional attributes such as friendly name, unit of measurement, and an icon or picture that can be displayed in the frontend.
An entity represents a sensor, actor, or function in Home Assistant.
Entities are used to monitor physical properties or to control other
entities. An entity is usually part of a device or a service. Entities have
states. **Example for entities as part of a device** A combined temperature
and humidity sensor device provides two sensor entities. One for temperature
(e.g. `sensor.temperature` with state `21.0` and unit `°C`) and one for
humidity (e.g. `sensor.humidity` with state `65.4` and unit `%`). **Example
for entities as part of a service** A weather service that provides 3
entities: wind speed, air pressure, and ozon level. **Example of an entity
used for control** A fan that is turned on when the temperature exceeds
30&nbsp;°C. There are standardized types of entities for common integrations
such as light, switch, camera, sensor, fan, or vacuum. Some entities are not
part of a device or service. Examples of standalone entities are automation,
script, scene entities, and helper entities (e.g. input helpers). Most
properties of entities are related to the state. Entities have optional
attributes such as friendly name, unit of measurement, and an icon or
picture that can be displayed in the frontend.
link: /docs/configuration/state_object/
excerpt: >
An entity represents a sensor, actor, or function in Home Assistant. Entities are used to monitor physical properties or to control other entities. An entity is usually part of a device or a service.
An entity represents a sensor, actor, or function in Home Assistant.
Entities are used to monitor physical properties or to control other
entities. An entity is usually part of a device or a service.
aliases:
- entities
- term: Event
@ -169,16 +224,26 @@
- events
- term: Floor
definition: >-
A floor in Home Assistant is a logical grouping of areas that are meant to match the physical floors in your home. Devices & entities are not assigned to floors but to areas. A floor has properties such as: Floor ID, name, aliases (for use in assistants), an icon, and a floor level. Some of these properties are optional. The level number can be negative to reflect floors below the basement.
Floors can be used in automations and scripts as a target for actions. For example, to turn off all the lights on the downstairs floor when you go to bed.
A floor in Home Assistant is a logical grouping of areas that are meant to
match the physical floors in your home. Devices & entities are not assigned
to floors but to areas. A floor has properties such as: Floor ID, name,
aliases (for use in assistants), an icon, and a floor level. Some of these
properties are optional. The level number can be negative to reflect floors
below the basement. Floors can be used in automations and scripts as a
target for actions. For example, to turn off all the lights on the
downstairs floor when you go to bed.
excerpt: >-
A floor in Home Assistant is a logical grouping of areas that are meant to match the physical floors in your home. Devices & entities are not assigned to floors but to areas. Floors can be used in automations and scripts as a target for actions. For example, to turn off all the lights on the downstairs floor when you go to bed.
A floor in Home Assistant is a logical grouping of areas that are meant to
match the physical floors in your home. Devices & entities are not assigned
to floors but to areas. Floors can be used in automations and scripts as a
target for actions. For example, to turn off all the lights on the
downstairs floor when you go to bed.
aliases:
- floors
- term: Frontend
definition: >-
The frontend is a necessary component for the UI, it is also where you
can define your themes.
The frontend is a necessary component for the UI, it is also where you can
define your themes.
link: /integrations/frontend/
- term: Group
definition: >-
@ -188,29 +253,38 @@
- groups
- term: HASS
definition: >-
HASS or [hass](/docs/tools/hass/) is often used as an abbreviation for
Home Assistant. It is also the command-line tool.
HASS or [hass](/docs/tools/hass/) is often used as an abbreviation for Home
Assistant. It is also the command-line tool.
- term: HassOS
definition: >-
Another name for Home Assistant Operating System
link: /hassio/installation/
- term: Home Assistant Container
definition: >-
Home Assistant Container is a standalone container-based installation of
Home Assistant Core. Any [OCI](https://opencontainers.org/) compatible
runtime can be used, but the documentation focus is on Docker.
link: /installation/#advanced-installation-methods
- term: Home Assistant Core
definition: >-
Home Assistant Core is a Python program. It can be run on various operating
systems and is the basis for Home Assistant. When people are talking about
Home Assistant Core they usually refer to a standalone installation method
that can be installed using a Virtual Environment or Docker. Home Assistant
Core does not use the Home Assistant Supervisor.
Home Assistant Core is the Python program at the heart of Home Assistant. It
is part of all of the four installation types and can be run on various
operating systems. It can be installed standalone (without Home Assistant
Supervisor), using a Virtual Environment (typically referred to as Home
Assistant Core installation method) or as a container using Docker
(typically referred to as Home Assistant Container installation method).
link: /installation/#advanced-installation-methods
excerpt: >
Home Assistant Core is the hart of Home Assistant itself. It is a Python
program that powers every installation type, but can be installed standalone.
Home Assistant Core is the heart of Home Assistant itself. It is a Python
program that powers every installation type, but can be installed
standalone.
- term: Home Assistant Supervised
definition: >-
Home Assistant Supervised is a full UI managed home automation ecosystem that
runs Home Assistant, the Home Assistant Supervisor and add-ons. It comes
pre-installed on Home Assistant OS, but can be installed on any Linux system.
It leverages Docker, which is managed by the Home Assistant Supervisor.
Home Assistant Supervised is a full UI managed home automation ecosystem
that runs the Home Assistant Core program, the Home Assistant Supervisor and
add-ons. It comes pre-installed on Home Assistant OS, but can be installed
standalone on Debian Linux systems. It leverages Docker, which is managed by
the Home Assistant Supervisor.
excerpt: >
Home Assistant Supervised is the full Home Assistant ecosystem, without the
Home Assistant Operating System.
@ -219,39 +293,50 @@
definition: >-
The Home Assistant Supervisor is a program that manages a Home Assistant
installation, taking care of installing and updating Home Assistant,
add-ons, itself and, if used, updating the Home Assistant Operating System.
add-ons, itself, and, if used, updating the Home Assistant Operating System.
link: /installation/#advanced-installation-methods
- term: Home Assistant Operating System
definition: >-
Home Assistant OS, the Home Assistant Operating System, is an embedded,
minimalistic, operating system designed to run the Home Assistant ecosystem
on single board computers (like the Raspberry Pi) or Virtual Machines.
The Home Assistant Supervisor can keep it up to date, removing the need for
you to manage an operating system. Home Assistant Operating System is the recommended installation method for most users.
on single board computers (like the Raspberry Pi) or Virtual Machines. It
includes Home Assistant Core, the Home Assistant Supervisor, and supports
add-ons. Home Assistant Supervisor keeps it up to date, removing the need
for you to manage an operating system. Home Assistant Operating System is
the recommended installation method for most users.
excerpt: >
Home Assistant OS, the Home Assistant Operating System, is an embedded,
minimalistic, operating system designed to run the Home Assistant ecosystem. It is the recommended installation method for most users.
minimalistic, operating system designed to run the Home Assistant ecosystem.
It is the recommended installation method for most users.
link: /installation/#advanced-installation-methods
- term: Host
definition: >-
A device that can communicate with other devices on a network. During setup and configuration,
an input requesting a **Host** typically refers to a device's network address so that
Home Assistant can attempt to connect to it. This may be in the form of a hostname, URL,
IP address or some other type of network identifier. If you do not know the hostname or IP address of a device, you can find it in your router's webinterface. For example, if your device is connected wirelessly, somewhere there is a page listing all the devices that are connected to your network. It depends on your router, where exactly this page is. It could be under **Network** > **Wireless**.
A device that can communicate with other devices on a network. During setup
and configuration, an input requesting a **Host** typically refers to a
device's network address so that Home Assistant can attempt to connect to
it. This may be in the form of a hostname, URL, IP address or some other
type of network identifier. If you do not know the hostname or IP address of
a device, you can find it in your router's webinterface. For example, if
your device is connected wirelessly, somewhere there is a page listing all
the devices that are connected to your network. It depends on your router,
where exactly this page is. It could be under **Network** > **Wireless**.
excerpt: >-
A device that participates in your network. If asked for the host, enter either the device's IP address or host name. If you don't know those, check the list of hosts in your router.
A device that participates in your network. If asked for the host, enter
either the device's IP address or host name. If you don't know those, check
the list of hosts in your router.
link: https://en.wikipedia.org/wiki/Host_(network)
aliases:
- hosts
- term: Integration
definition: >-
Integrations connect and integrate Home Assistant with devices, services,
and more. They contain all the logic to handle
vendor- and device-specific implementations, such as authentication or
specific protocols. The integration brings such device-specific elements into Home Assistant in a standardized
way. For example, the [Hue](/integrations/hue) integration integrates
the Philips Hue bridge and its connected bulbs into Home Assistant, making
them available as Home Assistant light entities you can control.
and more. They contain all the logic to handle vendor- and device-specific
implementations, such as authentication or specific protocols. The
integration brings such device-specific elements into Home Assistant in a
standardized way. For example, the [Hue](/integrations/hue) integration
integrates the Philips Hue bridge and its connected bulbs into Home
Assistant, making them available as Home Assistant light entities you can
control.
excerpt: >
Integrations connect and integrate Home Assistant with your devices,
services, and more.
@ -260,24 +345,40 @@
- integrations
- term: Intent
definition: >-
Intent is a term used with voice assistants. The intent is what Home Assistant thinks you want it to do when it extracts a command from your voice or text utterance. Currently, the following intents are supported out of the box: HassTurnOn, HassTurnOff, HassGetState, and HassLightSet.
These intents allow you to turn things on or off, inquire about a state, or change the brightness or color of a light.
Intent is a term used with voice assistants. The intent is what Home
Assistant thinks you want it to do when it extracts a command from your
voice or text utterance. Currently, the following intents are supported out
of the box: HassTurnOn, HassTurnOff, HassGetState, and HassLightSet. These
intents allow you to turn things on or off, inquire about a state, or change
the brightness or color of a light.
excerpt: >
Intent is a term used with voice assistants. The intent is what Home Assistant thinks you want it to do when it extracts a command from your voice or text utterance.
Intent is a term used with voice assistants. The intent is what Home
Assistant thinks you want it to do when it extracts a command from your
voice or text utterance.
link: https://developers.home-assistant.io/docs/intent_builtin
aliases:
- Intents
- term: Label
definition: >-
Labels in Home Assistant allow grouping elements irrespective of their physical location or type. Labels can be assigned to areas, devices, entities, automations, scenes, scripts, and helpers. Labels can be used in automations and scripts as a target for actions and services. Labels can also be used to filter data. For example, you can filter the list of devices to show only devices with the label `heavy energy usage` or turn these devices off when there is not a lot of solar energy available.
Labels in Home Assistant allow grouping elements irrespective of their
physical location or type. Labels can be assigned to areas, devices,
entities, automations, scenes, scripts, and helpers. Labels can be used in
automations and scripts as a target for actions and services. Labels can
also be used to filter data. For example, you can filter the list of devices
to show only devices with the label `heavy energy usage` or turn these
devices off when there is not a lot of solar energy available.
excerpt: >-
Labels in Home Assistant allow grouping elements irrespective of their physical location or type. Labels can be assigned to areas, devices, entities, automations, scenes, scripts, and helpers. Labels can be used in automations and scripts as a target for actions and services. Labels can also be used to filter data.
Labels in Home Assistant allow grouping elements irrespective of their
physical location or type. Labels can be assigned to areas, devices,
entities, automations, scenes, scripts, and helpers. Labels can be used in
automations and scripts as a target for actions and services. Labels can
also be used to filter data.
aliases:
- labels
- term: Lovelace
definition: >-
Lovelace is the original code name of the UI that is now known as
[Home Assistant dashboards](/dashboards).
Lovelace is the original code name of the UI that is now known as [Home
Assistant dashboards](/dashboards).
- term: Light
definition: >-
A light has a brightness you can control, and optionally color temperature
@ -285,9 +386,17 @@
link: /integrations/light
- term: Matter
definition: >-
Matter is an open-source standard that defines how to control smart home devices on a Wi-Fi or Thread network. The aim of the standard is to improve security and to make devices interoperable across vendors, replacing proprietary protocols for smart home ecosystems. Unlike other standards, Matter allows joining the same device to multiple controllers. For example, you can add a light to Google Home, Apple Home, and Home Assistant at the same time. A bridge device can be used to connect devices running on other smart home technologies such as Zigbee or Z-Wave.
Matter is an open-source standard that defines how to control smart home
devices on a Wi-Fi or Thread network. The aim of the standard is to improve
security and to make devices interoperable across vendors, replacing
proprietary protocols for smart home ecosystems. Unlike other standards,
Matter allows joining the same device to multiple controllers. For example,
you can add a light to Google Home, Apple Home, and Home Assistant at the
same time. A bridge device can be used to connect devices running on other
smart home technologies such as Zigbee or Z-Wave.
excerpt: >
Matter is an open-source standard that defines how to control smart home devices on a Wi-Fi or Thread network.
Matter is an open-source standard that defines how to control smart home
devices on a Wi-Fi or Thread network.
link: /integrations/matter
- term: Notification
definition: >-
@ -306,8 +415,8 @@
Platforms are building blocks provided by some integrations to be used by
other integrations. For example, the [Light](/integrations/light)
integration provides the `light platform` that is utilized by all
integrations providing `light` entities such
as e.g. [Hue](/integrations/hue).
integrations providing `light` entities such as e.g.
[Hue](/integrations/hue).
excerpt: >
Platforms are building blocks provided by some integrations to be used by
other integrations.
@ -317,78 +426,97 @@
- term: Reload
definition: >-
Applies the changes made to the Home Assistant configuration files. Changes
are normally automatically updated. However, changes made outside of the front
end will not be reflected in Home Assistant and require a reload.
To perform a manual reload, go to **Settings** > **System** >
**Restart Home Assistant** (top right) > **Quick reload**. If you do not see the **Quick reload** option in the menu, you need to enable **Advanced mode** in your user settings. More granular
reload options are available in *YAML configuration reloading* section
in **Developer tools** > **YAML**.
are normally automatically updated. However, changes made outside of the
front end will not be reflected in Home Assistant and require a reload. To
perform a manual reload, go to **Settings** > **System** > **Restart Home
Assistant** (top right) > **Quick reload**. If you do not see the **Quick
reload** option in the menu, you need to enable **Advanced mode** in your
user settings. More granular reload options are available in *YAML
configuration reloading* section in **Developer tools** > **YAML**.
excerpt: >
Applies the changes made to Home Assistant configuration files. Changes are normally
automatically updated. However, changes made outside of the front
Applies the changes made to Home Assistant configuration files. Changes are
normally automatically updated. However, changes made outside of the front
end will not be reflected in Home Assistant and require a reload.
- term: Scene
definition: >-
Scenes capture the states you want certain entities to be. For example,
a scene can specify that light A should be turned on and light B should
be bright red.
Scenes capture the states you want certain entities to be. For example, a
scene can specify that light A should be turned on and light B should be
bright red.
link: /integrations/scene/
aliases:
- scenes
- term: Script
definition: >
Scripts are components that allow users to specify a sequence of actions
to be executed by Home Assistant when turned on.
Scripts are components that allow users to specify a sequence of actions to
be executed by Home Assistant when turned on.
link: /docs/scripts/
aliases:
- scripts
- term: Sensor
definition: >-
Sensors return information about a thing, for instance the level of water
in a tank.
Sensors return information about a thing, for instance the level of water in
a tank.
link: /integrations/sensor/
aliases:
- sensors
- term: Selector
definition: >-
Selectors are components for the user interface. Some selectors can,
for example, show a toggle button to turn something on or off, while another
Selectors are components for the user interface. Some selectors can, for
example, show a toggle button to turn something on or off, while another
select can filter a list of devices to show only devices that have
motion-sensing capabilities.
excerpt: >
Selectors are components for the user interface. Like toggle, dropdown,
and more.
Selectors are components for the user interface. Like toggle, dropdown, and
more.
link: /docs/blueprint/selectors/
aliases:
- selectors
- term: Service
definition: |-
The term service has 2 meanings in Home Assistant:
**The information service**
For example, the municipal waste management service that provides entities for organic, paper, and packaging waste. In terms of functionality, the information service is like a device. It is called *service* to avoid confusion, as it does not come with a piece of hardware.
**The software function that interacts with targets to make something happen**
A service carries out one specific task, for example: turning on the light in the living room or sending a notification to a mobile phone.
A service has targets and data. Service targets are: areas, devices, and entities. Service data carries the information required to define the desired state change in the target. For example, the target, together with brightness 150 and RGB color `[255,0,0]`, or the message “Your coffee is ready”.
Services can be used in, for example, automation, scripts, dashboards, or voice commands to control your home.
Home Assistant provides a series of predefined services, such as `homeassistant.turn_on`, `homeassistant.toggle`, or `homeassistant.reload`.
The term service has 2 meanings in Home Assistant: **The information
service** For example, the municipal waste management service that provides
entities for organic, paper, and packaging waste. In terms of functionality,
the information service is like a device. It is called *service* to avoid
confusion, as it does not come with a piece of hardware. **The software
function that interacts with targets to make something happen** A service
carries out one specific task, for example: turning on the light in the
living room or sending a notification to a mobile phone. A service has
targets and data. Service targets are: areas, devices, and entities. Service
data carries the information required to define the desired state change in
the target. For example, the target, together with brightness 150 and RGB
color `[255,0,0]`, or the message “Your coffee is ready”. Services can be
used in, for example, automation, scripts, dashboards, or voice commands to
control your home. Home Assistant provides a series of predefined services,
such as `homeassistant.turn_on`, `homeassistant.toggle`, or
`homeassistant.reload`.
excerpt: >
A service carries out one specific task, for example: turn on the light in the
living room. A service has targets and data and can be called by actions, a
dashboard, or via voice command.
A service carries out one specific task, for example: turn on the light in
the living room. A service has targets and data and can be called by
actions, a dashboard, or via voice command.
link: /docs/scripts/service-calls/
aliases:
- services
- term: State
definition: |-
The state holds the information of interest of an entity. For example, if a light is on or off, the current temperature, or the amount of energy used. The data type of state is `string` (a textual value). Entities store 2 timestamps related to the state: `last_updated` and `last_changed`. Each entity has exactly one state and the state only holds one value at a time. However, entities can store attributes related to that state. For example, the state of a light is _on_, and the related state attributes could be its current brightness and color values.
State changes can be used as the source of triggers. The current state can be used in conditions.
The state holds the information of interest of an entity. For example, if a
light is on or off, the current temperature, or the amount of energy used.
The data type of state is `string` (a textual value). Entities store 2
timestamps related to the state: `last_updated` and `last_changed`. Each
entity has exactly one state and the state only holds one value at a time.
However, entities can store attributes related to that state. For example,
the state of a light is _on_, and the related state attributes could be its
current brightness and color values. State changes can be used as the source
of triggers. The current state can be used in conditions.
link: /docs/configuration/state_object/
aliases:
- states
excerpt: >
The state holds the information of interest of an entity, for example, if a light is on or off. Each entity has exactly one state and the state only holds one value at a time. However, entities can store attributes related to that state such as brightness, color, or a unit of measurement.
The state holds the information of interest of an entity, for example, if a
light is on or off. Each entity has exactly one state and the state only
holds one value at a time. However, entities can store attributes related to
that state such as brightness, color, or a unit of measurement.
- term: Switch
definition: >-
Switches are things that have two states you can select between, such as
@ -405,20 +533,37 @@
- term: Thread
definition: >-
Thread is a low-power mesh networking standard that is specifically designed for smart home applications. It is a protocol that defines how devices communicate. *Mesh* topology means that the devices can communicate with each other directly, without going through a central controller first. Thread uses the same radio frequency (RF) technology as Zigbee, but provides IP connectivity similar to Wi-Fi. Unlike Zigbee, Thread does not specify how to control devices. How Thread-enabled devices are controlled is specified in a higher level protocol such as HomeKit or Matter.
Thread is a low-power mesh networking standard that is specifically designed
for smart home applications. It is a protocol that defines how devices
communicate. *Mesh* topology means that the devices can communicate with
each other directly, without going through a central controller first.
Thread uses the same radio frequency (RF) technology as Zigbee, but provides
IP connectivity similar to Wi-Fi. Unlike Zigbee, Thread does not specify how
to control devices. How Thread-enabled devices are controlled is specified
in a higher level protocol such as HomeKit or Matter.
link: /integrations/thread/
excerpt: >
Thread is a low-power mesh networking standard that is specifically designed for smart home applications. It is a protocol that defines how devices communicate.
Thread is a low-power mesh networking standard that is specifically designed
for smart home applications. It is a protocol that defines how devices
communicate.
- term: Thread border router
definition: >-
A Thread border router forwards data packets between your local network and the Thread network. This enables smart home devices within a Thread network to communicate with IPv6-capable devices in your local network. A Thread border router is connected to your network either via Wi-Fi or Ethernet and uses its radio frequency (RF) radio to communicate with the Thread mesh network. In case of Matter, the data that is forwarded is encrypted. Examples of Thread border routers are the Nest Hub (2nd gen), the HomePod mini, and the Home Assistant SkyConnect together with the OpenThread Border Router add-on.
A Thread border router forwards data packets between your local network and
the Thread network. This enables smart home devices within a Thread network
to communicate with IPv6-capable devices in your local network. A Thread
border router is connected to your network either via Wi-Fi or Ethernet and
uses its radio frequency (RF) radio to communicate with the Thread mesh
network. In case of Matter, the data that is forwarded is encrypted.
Examples of Thread border routers are the Nest Hub (2nd gen), the HomePod
mini, and the Home Assistant SkyConnect together with the OpenThread Border
Router add-on.
link: /integrations/thread/#about-thread-border-routers
aliases:
- Thread border routers
- term: Trigger
definition: >-
A trigger is a set of values or conditions of a platform that are defined
to cause an automation to run.
A trigger is a set of values or conditions of a platform that are defined to
cause an automation to run.
link: /docs/automation/trigger/
aliases:
- triggers
@ -428,21 +573,21 @@
TTS (text-to-speech) allows Home Assistant to talk to you.
link: /integrations/tts/
- term: Valve
definition: >-
Valves are devices to control the flow of liquids and gases. All valves in Home Assistant can be opened
and closed. Some valves can also be set to a specific position.
Valves are devices to control the flow of liquids and gases. All valves in
Home Assistant can be opened and closed. Some valves can also be set to a
specific position.
link: /integrations/valve
- term: Variables
definition: >-
Variables are used to store values in memory that can be processed
for example, in a script.
Variables are used to store values in memory that can be processed for
example, in a script.
link: /docs/scripts/#variables
- term: Zone
definition: >-
Zones are areas that can be used for presence detection.
link: /integrations/zone/
aliases:
- zones
- zones

5
source/_docs/authentication.markdown
View File

@ -23,12 +23,12 @@ For the moment, other user accounts will have the same access as the owner accou
</div>
<div class="note">
If you want to manage users and you're an owner but you do not see "Users" in your main configuration menu, make sure that "Advanced Mode" is enabled for your user in your profile.
If you want to manage users and you're an owner but you do not see "Users" in your main configuration menu, make sure that **Advanced Mode** is enabled for your user in your profile.
</div>
### Your account profile
Once you're logged in, you can see the details of your account at the _Profile_ page by clicking on the circular at the very bottom of the sidebar.
Once you're logged in, you can see the details of your account on the {% my profile title="**User profile**" %} page by selecting on the circular at the very bottom of the sidebar.
<img src='/images/docs/authentication/profile.png' alt='Screenshot of the profile page' style='border: 0;box-shadow: none;'>
@ -38,6 +38,7 @@ You can:
- Enable or disable [multi-factor authentication](/docs/authentication/multi-factor-auth/).
- Delete _Refresh Tokens_. These are created when you log in from a device. Delete them if you want to force the device to log out.
- Create [Long Lived Access Tokens](https://developers.home-assistant.io/docs/auth_api/#long-lived-access-token) so scripts can securely interact with Home Assistant.
- Define language and other locale settings.
- Log out of Home Assistant.
<div class="note">

3
source/_docs/automation/trigger.markdown
View File

@ -1,6 +1,9 @@
---
title: "Automation Trigger"
description: "All the different ways how automations can be triggered."
related:
- docs: /voice_control/custom_sentences/#adding-a-custom-sentence-to-trigger-an-automation
title: Adding a custom sentence to trigger an automation
---
Triggers are what starts the processing of an {% term automation %} rule. When _any_ of the automation's triggers becomes true (trigger _fires_), Home Assistant will validate the [conditions](/docs/automation/condition/), if any, and call the [action](/docs/automation/action/).

21
source/_docs/blueprint.markdown
View File

@ -1,6 +1,17 @@
---
title: "About blueprints"
description: "Introduction to blueprints."
related:
- docs: /docs/blueprint/schema/
title: About the blueprint schema
- docs: /docs/blueprint/selectors/
title: About the blueprint selectors
- docs: /docs/automation/using_blueprints/
title: Using blueprints in automations
- docs: /docs/blueprint/tutorial/
title: "Tutorial: Create an automation blueprint"
- title: "Blueprint community forum"
url: /get-blueprints
---
This section gives a high-level introduction to blueprints. To view a description of the YAML-schema used to create a valid blueprint, refer to the section [About the blueprint schema](/docs/blueprint/schema/).
@ -13,12 +24,4 @@ Imagine you want to control lights based on motion. A blueprint provides the gen
Blueprints are shared by the community in the [blueprint community forum][blueprint-forums].
### Related information
- [About the blueprint schema](/docs/blueprint/schema/)
- [About the blueprint selectors](/docs/blueprint/selectors/)
- [Using blueprints in automations](/docs/automation/using_blueprints/)
- [Tutorial: Create an automation blueprint](/docs/blueprint/tutorial/)
- [Blueprint community forum][blueprint-forums]
[blueprint-forums]: /get-blueprints
[blueprint-forums]: /get-blueprints

19
source/_docs/blueprint/schema.markdown
View File

@ -1,6 +1,17 @@
---
title: "About the blueprint schema"
description: "Introduction to the blueprint schema."
related:
- docs: /docs/blueprint/
title: About blueprints
- docs: /docs/blueprint/selectors/
title: Blueprint selectors
- docs: /docs/automation/using_blueprints/
title: Using blueprints in automations
- docs: /docs/blueprint/tutorial/
title: "Tutorial: Create an automation blueprint"
- title: "Blueprint community forum"
url: /get-blueprints
---
## The blueprint schema
@ -202,12 +213,4 @@ action:
target: !input light_target
```
### Related information
- [About blueprints](/docs/blueprint/)
- [Blueprint selectors](/docs/blueprint/selectors/)
- [Using blueprints in automations](/docs/automation/using_blueprints/)
- [Tutorial: Create an automation blueprint &raquo;](/docs/blueprint/tutorial/)
- [Blueprint community forum][blueprint-forums]
[blueprint-built-in]: https://github.com/home-assistant/core/tree/dev/homeassistant/components/automation/blueprints
[blueprint-forums]: /get-blueprints

2
source/_docs/blueprint/selectors.markdown
View File

@ -271,7 +271,7 @@ assist_pipeline:
## Backup location selector
This can only be used on an installation with a Supervisor (Operating System or
Supervised). For installations of type Home Assistant Core or Container, an error
Supervised). For installations of type {% term "Home Assistant Core" %} or {% term "Home Assistant Container" %}, an error
will be displayed.
The backup location selector shows a list of places a backup could go, depending

30
source/_docs/blueprint/tutorial.markdown
View File

@ -1,6 +1,22 @@
---
title: "Creating an automation blueprint"
description: "Tutorial on creating an automation blueprint."
related:
- docs: /docs/configuration/
title: "Editing the configuration file"
- docs: /docs/configuration/yaml/
- docs: /docs/automation/yaml/
title: "YAML used in automations"
- docs: /docs/scripts/
title: Scripts
- docs: /docs/blueprint/selectors/
title: Blueprint selectors
- docs: /docs/blueprint/schema/
title: Blueprint schema
- docs: /docs/blueprint/
title: About blueprints
- docs: /docs/automation/using_blueprints/
title: Using automation blueprints
---
<div class='note'>
@ -273,17 +289,3 @@ For this tutorial, we're going to share it on GitHub Gists. This is a good optio
### Share on the Blueprint Exchange
If you follow the [Rules and format for posting](/get-blueprints), you can share your blueprint on the Home Assistant Blueprint Exchange forum. This option is accessible to the general Home Assistant community but recommended only for your original blueprints. Please don't post this tutorial to the Blueprint Exchange, but instead, remember this as an option for releasing your real blueprints.
## Related topics
**Prerequisites**
- [Editing the configuration file](/docs/configuration/)
- [YAML](/docs/configuration/yaml/), and specifically, [YAML used in automations](/docs/automation/yaml/)
- [Scripts](/docs/scripts/)
**Blueprints**
- [Blueprint selectors](/docs/blueprint/selectors/)
- [Blueprint schema](/docs/blueprint/schema/)
- [About blueprints](/docs/blueprint/)
- [Using automation blueprints](/docs/automation/using_blueprints/)

39
source/_docs/configuration.markdown
View File

@ -1,6 +1,15 @@
---
title: "Configuration.yaml"
description: "Configuring Home Assistant via text files."
related:
- docs: /docs/configuration/yaml/
title: YAML syntax
- docs: /docs/configuration/secrets
title: Storing credentials in `secrets.yaml` file
- docs: /common-tasks/os/#backups
title: Creating and restoring backups
- docs: /integrations/backup
title: Creating backups for Home Assistant Container and Core
---
While you can configure most of Home Assistant directly from the user interface under {% my config %}, some parts need you to edit `configuration.yaml`. This file contains {% term integrations %} to be loaded along with their configurations. Throughout the documentation you will find snippets that you can add to your configuration file to enable specific functionality.
@ -20,26 +29,32 @@ The path to your configuration directory can be found in the Home Assistant {% t
Right under the version you are running, you will find what path Home Assistant has loaded the configuration from.
![Screenshot showing the top of the system information panel](/images/screenshots/System_information.png)
_If you use Home Assistant Container, you can find `configuration.yaml` in the config folder that you mounted in your container._
_If you use {% term "Home Assistant Container" %}, you can find `configuration.yaml` in the config folder that you mounted in your container._
_If you use Home Assistant Operating System, you can find `configuration.yaml` in the `/config` folder of the installation._
_If you use {% term "Home Assistant Operating System" %}, you can find `configuration.yaml` in the `/config` folder of the installation._
_If you use Home Assistant Core, you can find `configuration.yaml` in the config folder passed to the `hass` command (default is `~/.homeassistant`)._
_If you use {% term "Home Assistant Core" %} , you can find `configuration.yaml` in the config folder passed to the `hass` command (default is `~/.homeassistant`)._
## Reloading changes
## Reloading configuration changes
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`. To do this, go to {% my server_controls title="Developer Tools > YAML" %} and scroll down to the YAML configuration reloading section (alternatively, hit "c" anywhere in the UI and search for it).
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`.
If you can't see your integration listed there, you will need to restart Home Assistant for changes to take effect.
1. To reload configuration changes, go to {% my server_controls title="**Developer Tools** > **YAML**" %} and scroll down to the YAML configuration reloading section (alternatively, hit "c" anywhere in the UI and search for "reload").
- You are presented with a list of integrations, such as **Automations** or **Conversation**.
<div class='note'>
![Reload configuration changes](/images/docs/configuration/reloading_config.png)
To test any changes to your configuration files from the command line, check out the common tasks for [operating system](/common-tasks/os/#configuration-check), [supervised](/common-tasks/supervised/#configuration-check), [container](/common-tasks/container/#configuration-check), [core](/common-tasks/core/#configuration-check) for how to do that. Configuration changes can also be tested using the UI by navigating to {% my server_controls title="Developer Tools > YAML" %} and clicking "Check Configuration". For the button to be visible, you must enable "Advanced Mode" on your {% my profile title="User Profile" %}.
2. If the integration is listed, select it to reload the settings.
3. If integration is not listed, you need to restart Home Assistant for changes to take effect:
- [Validate the configuration](#validating-the-configuration). Then, select the **Restart** button.
</div>
## Validating the configuration
## Migrating to a new system
After changing configuration or automation files, check if the configuration is valid.
The preferred way of migrating to a new system is by {% my supervisor_backups title="making a backup" %}. Once you have created the backup on the old system, you can download it to the system that is running the Home Assistant frontend. When setting up the new system, you may use the backup. Alternatively, you can upload it to your new system using the _Upload backup_ menu option of the _Backups_ menu. Then, a restore of the uploaded backup on the new system concludes the migration.
The method for running a configuration check depends on your [installation type](/installation/#advanced-installation-methods). Check the common tasks for your installation type:
If you run the container or core installation methods, you will need to manually make a backup of your configuration folder. Be aware that some of the files you need start with `.`, which is hidden by default from both `ls` (in SSH), in Windows Explorer, and macOS Finder. You'll need to ensure that you're viewing all files before you copy them.
- [Configuration check on Operating System](/common-tasks/os/#configuration-check)
- [Configuration check on Supervised](/common-tasks/supervised/#configuration-check)
- [Configuration check on Container](/common-tasks/container/#configuration-check)
- [Configuration check on Core](/common-tasks/core/#configuration-check)

122
source/_docs/configuration/basic.markdown
View File

@ -1,117 +1,33 @@
---
title: "Setup basic information"
description: "Setting up the basic info of Home Assistant."
related:
- docs: /integrations/homeassistant/
- docs: /docs/configuration/
---
As part of the default onboarding process, Home Assistant can detect your location from IP address geolocation. Home Assistant will automatically select a unit system and time zone based on this location. You may adjust this during onboarding, or afterwards at {% my general title="Settings > System > General" %}, network related configuration is found under {% my network title="Settings > System > Network" %}.
As part of the default onboarding process, Home Assistant can detect your location from IP address geolocation. Home Assistant will automatically select a unit system and time zone based on this location. If you didn't adjust this directly during onboarding, you can do it later.
If you prefer YAML, you can add the following information to your `configuration.yaml`:
<p class='img'>
<img class="no-shadow" src='/images/docs/configuration/general-settings.png' alt='Screenshot showing General settings page'>
Screenshot showing the General settings page.
</p>
```yaml
homeassistant:
name: Home
latitude: 32.87336
longitude: 117.22743
elevation: 430
unit_system: metric
currency: USD
country: US
time_zone: "America/Los_Angeles"
external_url: "https://www.example.com"
internal_url: "http://homeassistant.local:8123"
allowlist_external_dirs:
- "/usr/var/dumping-ground"
- "/tmp"
allowlist_external_urls:
- "http://images.com/image1.png"
media_dirs:
media: "/media"
recordings: "/mnt/recordings"
```
## Editing the general settings
<div class='note'>
To change the general settings that were defined during onboarding, follow these steps:
You will not be able to edit anything in {% my general title="Settings > System > General" %} in the UI if you are using YAML configuration for any of the following: name, latitude, longitude, elevation, unit_system, temperature_unit, time_zone, external_url, internal_url, country, currency. Additionally, some options are only visible after "Advanced Mode" is enabled on your {% my profile title="User Profile" %}.
1. Go to {% my general title="**Settings** > **System** > **General**" %} and make your changes.
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/).
- For more information about the general settings in YAML, refer to the [Home Assistant Core integration documentation](/integrations/homeassistant/).
</div>
{% configuration %}
name:
description: Name of the location where Home Assistant is running.
required: false
type: string
latitude:
description: Latitude of your location required to calculate the time the sun rises and sets.
required: false
type: float
longitude:
description: Longitude of your location required to calculate the time the sun rises and sets.
required: false
type: float
elevation:
description: Altitude above sea level in meters. Impacts sunrise data.
required: false
type: integer
unit_system:
description: "`metric` for Metric, `us_customary` for US Customary. This also sets temperature_unit, Celsius for Metric and Fahrenheit for US Customary"
required: false
type: string
temperature_unit:
description: "Override temperature unit set by unit_system. `C` for Celsius, `F` for Fahrenheit."
required: false
type: string
time_zone:
description: "Pick your time zone from the column **TZ** of [Wikipedia's list of tz database time zones](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones)"
required: false
type: string
currency:
description: "Pick your currency code from the column **Code** of [Wikipedia's list of ISO 4217 active codes](https://en.wikipedia.org/wiki/ISO_4217#Active_codes)"
required: false
type: string
default: "EUR"
external_url:
description: "The URL that Home Assistant is available on from the internet. For example: `https://example.duckdns.org:8123`. Note that this setting may only contain a protocol, hostname and port; using a path is not supported."
required: false
type: string
internal_url:
description: "The URL that Home Assistant is available on from your local network. For example: `http://homeassistant.local:8123`. Note that this setting may only contain a protocol, hostname and port; using a path is not supported."
required: false
type: string
customize:
description: "[Customize](/docs/configuration/customizing-devices/) entities."
required: false
type: string
customize_domain:
description: "[Customize](/docs/configuration/customizing-devices/) all entities in a domain."
required: false
type: string
customize_glob:
description: "[Customize](/docs/configuration/customizing-devices/) entities matching a pattern."
required: false
type: string
allowlist_external_dirs:
description: List of folders that can be used as sources for sending files.
required: false
type: list
allowlist_external_urls:
description: List of external URLs that can be fetched. URLs can match specific resources (e.g., `http://10.10.10.12/images/image1.jpg`) or a relative path that allows access to resources within it (e.g., `http://10.10.10.12/images` would allow access to anything under that path)
required: false
type: list
media_dirs:
description: A mapping of local media sources and their paths on disk.
required: false
type: map
language:
description: "Default language used by Home Assistant. This may, for example, influence the language used by voice assistants. The language should be specified as an RFC 5646 language tag, and must be a language which Home Assistant is translated to."
required: false
type: string
default: "en"
country:
description: "Country in which Home Assistant is running. This may, for example, influence radio settings to comply with local regulations. The country should be specified as an ISO 3166.1 alpha-2 code. Pick your country from the column **Code** of [Wikipedia's list of ISO 31661 alpha-2 officially assigned code codes](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2#Officially_assigned_code_elements)"
required: false
type: string
{% endconfiguration %}
![Setting fields are grayed out because the configuration settings stored in configuration.yaml file](/images/docs/configuration/general-settings-stored-in-config-yaml.png)
## Reload core service
Home Assistant offers a service to reload the core configuration while Home Assistant is running called {% my developer_call_service service="homeassistant.reload_core_config" %}. This allows you to change any of the above sections and see it being applied without having to restart Home Assistant. To call this service, go to the "{% my developer_services %}" tab under {% my developer_services title="Developer Tools" %}, select the {% my developer_call_service service="homeassistant.reload_core_config" %} service and click the "CALL SERVICE" button. Alternatively, you can press the "Location & Customizations" button under {% my server_controls title="Developer Tools > YAML" %}.

7
source/_docs/configuration/secrets.markdown
View File

@ -1,6 +1,11 @@
---
title: "Storing secrets"
description: "Storing secrets outside of your configuration.yaml."
related:
- docs: /docs/configuration/
title: configuration.yaml file
- docs: /docs/configuration/splitting_configuration/
title: Splitting the configuration
---
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/).
@ -42,7 +47,7 @@ When you start splitting your configuration into multiple files, you might end u
- 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`.
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 Home Assistant Core installations given it's available through [`hass`](/docs/tools/hass/).
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/).
*Option 1*: Print where secrets are retrieved from to the Home Assistant log by adding the following to `secrets.yaml`:

12
source/_docs/configuration/splitting_configuration.markdown
View File

@ -1,6 +1,13 @@
---
title: "Splitting up the configuration"
description: "Splitting the configuration.yaml into several files."
related:
- docs: /docs/configuration/
title: configuration.yaml file
- docs: /examples/#example-configurationyaml
title: Example configuration files by the community
- docs: /docs/configuration/packages
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.
@ -536,8 +543,3 @@ automation ui: !include automations.yaml
```
[discord]: https://discord.gg/c5DvZ4e
## Related topics
- [Example configuration files by the community](/examples/#example-configurationyaml)
- [Using packages to organize configuration files](/docs/configuration/packages)

53
source/_docs/configuration/yaml.markdown
View File

@ -1,13 +1,30 @@
---
title: "YAML"
description: "Details about YAML to configure Home Assistant."
title: "YAML syntax"
description: "Details about the YAML syntax used to configure Home Assistant."
related:
- docs: /docs/configuration/
title: configuration.yaml file
- docs: /docs/configuration/secrets/
title: Storing private data in separate file
- docs: /docs/automation/yaml/
title: Automation.yaml
- docs: /docs/configuration/troubleshooting/
title: Troubleshooting the configuration files
- docs: /docs/configuration/#validating-the-configuration
title: Validating the configuration
- url: https://developers.home-assistant.io/docs/documenting/yaml-style-guide/
title: YAML Style Guide for Home Assistant developers
---
Home Assistant uses the [YAML](https://yaml.org/) syntax for configuration. YAML might take a while to get used to but is powerful in allowing you to express complex configurations.
Home Assistant uses the [YAML](https://yaml.org/) syntax for configuration. While most integrations can be configured through the UI, some integrations require you to edit your [`configuration.yaml`](/docs/configuration/) file to specify its settings.
While more and more integrations are configured through the UI, for some, you will add code in your [`configuration.yaml`](/docs/configuration/) file to specify its settings.
## YAML Style Guide
The following example entry assumes that you would like to set up the [notify integration](/integrations/notify) with the [pushbullet platform](/integrations/pushbullet).
This page gives a high-level introduction to the YAML syntax used in Home Assistant. For a more detailed description and more examples, refer to the [YAML Style Guide for Home Assistant developers](https://developers.home-assistant.io/docs/documenting/yaml-style-guide/).
## A first example
The following YAML example entry assumes that you would like to set up the [notify integration](/integrations/notify) with the [pushbullet platform](/integrations/pushbullet).
```yaml
notify:
@ -21,22 +38,20 @@ notify:
The basics of YAML syntax are block collections and mappings containing key-value pairs. Each item in a collection starts with a `-` while mappings have the format `key: value`. This is somewhat similar to a Hash table or more specifically a dictionary in Python. These can be nested as well. **Beware that if you specify duplicate keys, the last value for a key is used**.
## Indentation in YAML
In YAML, indentation is important for specifying relationships. Indented lines are nested inside lines that are one level higher. In the above example, `platform: pushbullet` is a property of (nested inside) the `notify` integration.
Getting the right indentation can be tricky if you're not using an editor with a fixed-width font. Tabs are not allowed to be used for indentation. The convention is to use 2 spaces for each level of indentation.
To check if your YAML syntax is correct before loading it into Home Assistant, you can use the third-party service [YAML Validator](https://codebeautify.org/yaml-validator/) (not maintained by the Home Assistant community).
## Comments
<div class='note'>
Strings of text following a `#` are comments. They are ignored by the system. Comments explain in plain language what a particular code block is supposed to do. For future-you or someone else looking at the file.
Pay attention to not storing private data (passwords, API keys, etc.) directly in your `configuration.yaml` file. Private data can be stored in either a [separate file](/docs/configuration/secrets/) or in [environmental variables](/docs/configuration/yaml/#using-environment-variables), which circumvents this security problem.
</div>
Strings of text following a `#` are comments and are ignored by the system.
### Example with comment and nesting
The next example shows an [input_select](/integrations/input_select) integration that uses a block collection for the values of options.
The other properties (like `name:`) are specified using mappings. Note that the second line just has `threat:` with no value on the same line. Here threat is the name of the input_select and the values for it are everything nested below it.
The other properties (like `name:`) are specified using mappings. Note that the second line just has `threat:` with no value on the same line. Here, `threat` is the name of the input_select. The values for it are everything nested below it.
```yaml
input_select:
@ -51,6 +66,8 @@ input_select:
initial: 0
```
### Example of nested mapping
The following example shows nesting a collection of mappings in a mapping. In Home Assistant, this would create two sensors that each use the MQTT platform but have different values for their `state_topic` (one of the properties used for MQTT sensors).
```yaml
@ -65,8 +82,8 @@ sensor:
### Environment variables
On Home Assistant Core installations, you can include values from your system's environment variables with `!env_var`.
Note that this will only work for Home Assistant Core installations, in a scenario where it is possible to specify these.
On {% term "Home Assistant Core" %} installations, you can include values from your system's environment variables with `!env_var`.
Note that this will only work for {% term "Home Assistant Core" %} installations, in a scenario where it is possible to specify these.
Regular Home Assistant users are recommended to use `!include` statements instead.
```yaml
@ -120,3 +137,9 @@ Not quoting the value may generate an error such as:
```txt
not a valid value for dictionary value @ data
```
## Validating YAML syntax
With all these indents and rules, it is easy to make a mistake. The best way to check if your YAML syntax is correct (validate) depends on the editor you use. We can't list them all here.
- If you edit the files directly in Home Assistant, refer to the section: [Validating the configuration](/docs/configuration/#validating-the-configuration)

2
source/_docs/energy/gas.markdown
View File

@ -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 gas meters](https://en.wikipedia.org/wiki/Gas_meter#Diaphragm/bellows_meters) are the most common type of gas meter, 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. Many posts on the forums of users having luck with this method, such as [this one](https://community.home-assistant.io/t/water-gas-meter-monitoring-via-magnetometer-sine-wave-to-pulse-issue/245904).
[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).

1
source/_docs/energy/water.markdown
View File

@ -64,6 +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.![Photo of the AI-on-the-edge-device Workflow](/images/docs/energy/ai-on-the-edge-device.jpg)
- [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.
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.

93
source/_docs/frontend/browsers.markdown
View File

@ -1,93 +0,0 @@
---
title: "Browsers"
description: "Browser compatibility list"
---
Home Assistant requires a web browser to show the frontend and supports all major modern browsers. We don't test the web interface against all available browsers but this page tracks different browsers on various operating systems and should help you to pick a browser which works. The "Release" column contains the release number which was tested. This doesn't mean that older or newer releases will not work.
If a browser is listed as working but you are still having problems, it is possible that some add-on or extension may be the problem. Some add-ons or extension are known to cause issue with the frontend, but it's not possible to test them all.
If you are having issues with the frontend displaying correctly, you should disable all your add-ons or extensions and enable them one at a time. At last but not least, consider restarting your browser.
We would appreciate if you help to keep this page up-to-date and add feedback.
## Microsoft Windows
| Browser | Release | State | Comments |
| :------------------------ |:---------------|:-----------|:-------------------------|
| Internet Explorer ([IE]) | 11 | Not supported | Does not support promises. |
| Microsoft [Edge] | deli. Win 10 | works | Streaming updates not working. |
| [Chrome] | 61.0.3163.100 | works | |
| [Firefox] | 62.0.3 | works | |
| [Iridium] | 48.2 | works | |
| [Opera] | 42.0.2393.351 | works | |
## macOS
| Browser | Release | State | Comments |
| :-------------------- |:---------------|:-----------|:-------------------------|
| [Safari] | | works | Not working with Safari Technology Preview 112 beta |
## Linux
| Browser | Release | State | Comments |
| :-------------------- |:---------------|:-----------|:-------------------------|
| [Firefox] | 62.0 | works | |
| [Midori] | 0.5.11 | works | |
| [Chromium] | 69.0.3497.81 | works | |
| [Conkeror] | 1.0.2 | works | |
| [Tor Browser] | 7.0.8 | works | |
| [Konqueror] | | unknown | |
| [Uzbl] | 0.9.0 | works | |
| [Opera] | 42.0.2393.351 | works | |
| [Lynx] | 2.12 | fails | loads empty page |
| [elinks] | | fails | page with manifest and import |
| [w3m] | 0.5.3 | fails | display the icon shown while loading HA |
| [Epiphany] | 3.18.5 | works | |
| [surf] | 0.7 | works | |
| [Chrome] | 71.0.3578.98 | works | |
| [Waterfox] | 56.2.6 | fails | |
## Android
| Browser | Release | State | Comments |
| :-------------------- |:---------------|:-----------|:-------------------------|
| [Chrome] | 50.0.2661.89 | works | Can also be added to desktop |
| [Firefox] | 46.0.1 | works | Can also be added to desktop |
| [Opera] | 42.0.2246.112628 | works | Can also be added to desktop |
## iOS
| Browser | Release | State | Comments |
| :-------------------- |:---------------|:-----------|:-------------------------|
| [Safari] | | works | Can also be added to desktop. Not working in iOS 14 beta 5. |
| [Chrome] | | works | Not working in iOS 14 beta 5. |
There are reports that devices running with iOS prior to iOS 10, especially old iPads, are having trouble. Devices running iOS 14 beta 5, you will not be able to interact with Home Assistant controls.
## webOS
| Browser | Release | State | Comments |
| :-------------------- |:---------------|:-----------|:-------------------------|
| [LG webOS TV Built-in]| webOS 04.80.03 | works | including magic remote |
[Chrome]: https://www.google.com/chrome/
[Chromium]: https://www.chromium.org/
[Conkeror]: http://conkeror.org/
[Edge]: https://www.microsoft.com/en-us/edge
[elinks]: http://elinks.or.cz/
[Epiphany]: https://wiki.gnome.org/Apps/Web
[Firefox]: https://www.mozilla.org/en-US/firefox/
[IE]: https://support.microsoft.com/en-us/help/17621/internet-explorer-downloads
[Iridium]: https://iridiumbrowser.de/
[Konqueror]: https://konqueror.org/
[Lynx]: https://lynx.browser.org/
[Midori]: https://astian.org/en/midori-browser/
[Opera]: https://www.opera.com/
[Safari]: https://www.apple.com/safari/
[surf]: https://surf.suckless.org/
[Tor Browser]: https://www.torproject.org/
[Uzbl]: https://www.uzbl.org/
[w3m]: https://w3m.sourceforge.net/
[Waterfox]: https://www.waterfox.net
[LG webOS TV Built-In]: https://www.lg.com/uk/support/help-library/details-on-enjoying-internet-browsing-on-your-lg-webos-tv-CT00008334-1435838149474

15
source/_docs/locked_out.md
View File

@ -1,6 +1,13 @@
---
title: "I'm locked out!"
description: "Options for regaining access"
related:
- docs: /common-tasks/os/#listing-all-users-from-the-command-line
title: Listing all user names via command line
- url: https://yellow.home-assistant.io/guides/factory-reset/
title: Reset the Yellow
- url: https://green.home-assistant.io/guides/reset/
title: Reset the Green
---
The sections below deal with recovering from a situation where you are not able to sign in,
@ -9,7 +16,7 @@ or need to recover your data.
## Forgot user name
If you’ve forgotten your username, ask the owner to help you.
If you are using the Home Assistant Operating System and have access to the Home Assistant server, you can connect a terminal and enter the `auth list` command. This command lists all users that are registered on your Home Assistant.
If you are using the {% term "Home Assistant Operating System" %} and have access to the Home Assistant server, you can connect a terminal and enter the `auth list` command. This command lists all users that are registered on your Home Assistant.
## Forgot password
@ -131,9 +138,3 @@ For Windows or macOS you will need third party software. Below are some options.
- Windows: <https://www.diskinternals.com/linux-reader/> (read-only access to the SD)
- macOS: <https://osxfuse.github.io/>
## Related topics
- [Reset the Green](https://green.home-assistant.io/guides/reset/)
- [Reset the Yellow](https://yellow.home-assistant.io/guides/factory-reset/)
- [Listing all user names via command line](/common-tasks/os/#listing-all-users-from-the-command-line)

22
source/_docs/organizing.markdown
View File

@ -1,9 +1,18 @@
---
title: "Organizing your assets"
description: "Organizing and grouping your assets makes it easier to find them and allows you to target groups in automations."
title: "Grouping your assets"
description: "Grouping your assets makes it easier to find them and allows you to target groups in automations."
related:
- docs: /docs/organizing/areas/
title: Areas
- docs: /docs/organizing/floors/
title: Floors
- docs: /docs/organizing/labels/
title: Labels
- docs: /docs/organizing/categories/
title: Categories
---
Once you have more devices, you may want to target entire groups of devices in automations. It also becomes more challenging to find items in lists. There are a few tools to organize your assets: [Areas](#areas), [floors](#floors), [labels](#labels), and [categories](#categories).
Once you have more devices, you may want to target entire groups of devices in automations. It also becomes more challenging to find items in lists. There are a few tools to group your assets: [Areas](#areas), [floors](#floors), [labels](#labels), and [categories](#categories).
| Taxonomy | Automation target | Entity can have multiple |
| -------- | ----------------- | ------------------------ |
@ -44,10 +53,3 @@ Once you have more devices, you may want to target entire groups of devices in a
- Categories are unique for each table. The automations page can have different categories than the scene, scripts, or helpers settings page.
<img class="no-shadow" src='/images/organizing/categories.png' alt='Screenshots the new categories. Automations are grouped into their categories, making it easier to get an overview or to filter them.'>
## Related topics
- [Areas](/docs/organzing/areas/)
- [Floors](/docs/organzing/floors/)
- [Labels](/docs/organzing/labels/)
- [Categories](/docs/organzing/categories/)

16
source/_docs/organizing/areas.markdown
View File

@ -1,6 +1,16 @@
---
title: "Areas"
description: "Group your devices and entities in areas and group areas in floors."
related:
- docs: /docs/organizing/areas/
title: Areas
- docs: /docs/organizing/
- docs: /docs/organizing/labels/
title: Labels
- docs: /docs/organizing/categories/
title: Categories
- docs: /docs/configuration/templating/#areas
title: Using areas in template
---
An area in Home Assistant is a logical grouping of {% term devices %} and {% term entities %} that are meant to match areas (or rooms) in the physical world of your home. For example, the "Living room" area groups devices and entities in your living room. Areas allow you to target an entire group of devices with a service call. For example, turning off all the lights in the living room.
@ -34,9 +44,3 @@ If an area has not yet been assigned to a floor, it is shown in the **Unassigned
1. Go to {% my areas title="**Settings** > **Areas, labels & zones**" %} and select **Create area**.
2. On the area card, select the pencil icon.
3. In the dialog, select the floor and add labels, if you like.
## Related topics
- [Floors](/docs/organzing/floors/)
- [Labels](/docs/organzing/labels/)
- [Using areas in templates](/docs/configuration/templating/#areas)

13
source/_docs/organizing/categories.markdown
View File

@ -1,6 +1,13 @@
---
title: "Categories"
description: "Use categories to group and filter your table items"
related:
- docs: /docs/organizing/areas/
title: Areas
- docs: /docs/organizing/floors/
title: Floors
- docs: /docs/organizing/labels/
title: Labels
---
Categories let you group and filter items in a table. Like labels, categories allow grouping irrespective of the items physical location. For example, on the automations page, you can create the categories “Notifications” or “NFC tags” to view your automations grouped or filtered. These categories group automations on the automation page, but have no effect anywhere else. Categories are unique for each table. The automations page can have different categories than the scene, scripts, or helpers settings page.
@ -31,10 +38,6 @@ Follow these steps to create a new category.
- In the top right corner, select **Move to category**.
- Then, select the category from the list.
4. Once categories are applied, the table items are grouped by those categories.
- The example shows 2 categories: Coffee and housekeeping.
- The example shows 2 categories: Coffee and housekeeping.
![Group table items by category](/images/organizing/category_02.png)
## Related topics
- [Labels](/docs/organizing/labels/)

56
source/_docs/organizing/filtering.markdown Normal file
View File

@ -0,0 +1,56 @@
---
title: "Filtering your assets"
description: "Filter for items in tables."
related:
- docs: /docs/organizing/floors/
title: Floors
- docs: /docs/organizing/labels/
title: Labels
- docs: /docs/organizing/areas/
title: Areas
- docs: /docs/organizing/categories/
title: Categories
- docs: /docs/organizing/
title: Grouping your assets
- docs: /common-tasks/general/
title: Enabling or disabling entities and automations
---
When working with tables, you can select multiple elements to apply an action on multiple items at once. If you have [grouped](/docs/organizing/) your assets by assigning them to floors, areas, labels, or directories you can also filter your data accordingly.
## Selecting multiple items in a table
1. In your table, select the <img height="28px" src="/images/organizing/multiselect_icon.png" alt="Multiselect icon"/> button.
![Screenshots point out the enable selection mode button in the toolbar of the tables in Home Assistant](/images/blog/2024-04/enable-selection-mode.png)
2. In the list, select the items of interest.
![Selecting multiple elements in a list](/images/organizing/multiselect_01.png)
3. You can now apply changes to all selected elements, such as [applying labels](/docs/organzing/labels/) or [enabling or disabling entities and automations](/common-tasks/general/).
## Filtering items in a table
You can filter a table so that only items matching certain criteria are shown.
1. In the top left corner above the table, select the **Filters** button.
![Select the filter button](/images/organizing/filters_01.png)
2. In the filters panel, select your filter criteria.
- You can filter for [floors](/docs/organizing/floors/), [areas](/docs/organizing/areas/), [labels](/docs/organizing/labels/), and [categories](/docs/organizing/categories/) if you have previously defined them.
![Screenshots showing the filter panel that tables can have, allowing you to easily find what you are looking for](/images/organizing/filter-panel.png)
## Grouping and sorting items in a table
You can group items in a table according to certain criteria. The number of shown items stays the same. No items will be hidden.
1. In the top right above the table, select the **Group by** button.
2. The items will be grouped according to the criteria you chose.
- In the example, the items are grouped by manufacturer.
![Select the Group by button](/images/organizing/table_group_01.png)
3. To sort the items, select the **Sort by** button.

16
source/_docs/organizing/floors.markdown
View File

@ -1,6 +1,16 @@
---
title: "Floors"
description: "Group your areas per floor"
related:
- docs: /docs/organizing/areas/
title: Areas
- docs: /docs/organizing/
- docs: /docs/organizing/labels/
title: Labels
- docs: /docs/configuration/templating/#floors
title: Using floors in templates
- docs: /voice_control/aliases/
title: Using floor alias for voice assistants
---
A floor in Home Assistant is a logical grouping of areas meant to match your home's physical floors. Devices and entities
@ -27,9 +37,3 @@ Follow these steps to create a new floor.
![Create floor dialog](/images/organizing/create_floor_02.png)
4. You can now [assign areas to that floor](/docs/organizing/areas/#assigning-areas-to-floors-and-add-labels).
## Related topics
- [Alias for voice assistants](/voice_control/aliases/)
- [Areas](/docs/organizing/areas/)
- [Using floors in templates](/docs/configuration/templating/#floors)

14
source/_docs/organizing/labels.markdown
View File

@ -1,6 +1,15 @@
---
title: "Labels"
description: "Label your areas, devices, entities, automations, scripts, and helpers. Then, filter by label or run an automation on all entities with that label."
related:
- docs: /docs/organizing/areas/
title: Areas
- docs: /docs/organizing/floors/
title: Floors
- docs: /docs/organizing/categories/
title: Categories
- docs: /docs/configuration/templating/#labels
title: Using labels in templates
---
Labels in Home Assistant allow grouping elements irrespective of their physical location or type. Labels can be assigned to areas, devices, entities, automations, scenes, scripts, and helpers. Labels can be used in automations and scripts as a target for actions and services. Labels can also be used to filter data. For example, you can filter the list of devices to show only devices with the label `heavy energy usage` or turn these devices off when there is not a lot of solar energy available.
@ -41,8 +50,3 @@ Follow these steps to apply a label
- Select the <img height="28px" src="/images/organizing/multiselect_icon.png" alt="Multiselect icon"/> button.
- From the list, select all the items to which you want to apply a label.
- In the top right corner, select the three dots menu, then select **Add label**. Then, select the labels from the list.
## Related topics
- [Areas](/docs/organizing/areas/)
- [Using labels in templates](/docs/configuration/templating/#labels)

5
source/_docs/tools/check_config.markdown
View File

@ -1,9 +1,12 @@
---
title: "check_config"
description: "Script to perform a check of the current configuration"
related:
- docs: /docs/configuration/#validating-the-configuration
title: Validating the configuration
---
Test any changes to your `configuration.yaml` file before launching Home Assistant. This {% term script %} allows you to test changes without the need to restart Home Assistant.
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.
```bash
hass --script check_config

15
source/_docs/troubleshooting_general.markdown
View File

@ -1,6 +1,13 @@
---
title: "General troubleshooting"
description: "General troubleshooting information"
related:
- docs: /docs/configuration/#editing-configurationyaml
title: Editing your configuration
- docs: /integrations/recovery_mode/
title: Recovery mode integration
- docs: /docs/locked_out/
title: Resetting your password
---
This page provides some information about more generic troubleshooting topics.
@ -23,7 +30,7 @@ Recovery mode loads a minimum set of integrations to allow troubleshooting the c
You need to identify the issue in the configuration files and fix it there. The issue could be caused by something as simple as an invalid YAML file.
- If you are running Home Assistant Operating System, you can install an add-on such as VS code to edit the configuration file if needed.
- If you are running {% term "Home Assistant Operating System" %}, you can install an add-on such as VS code to edit the configuration file if needed.
- If you are still logged in, you can [edit your configuration](/docs/configuration/#editing-configurationyaml).
- In the Home Assistant user interface, open the add-on you usually use and edit the configuration file.
- Restart Home Assistant.
@ -35,9 +42,3 @@ If your Home Assistant is acting up and you cannot identify a root cause, you ca
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, go to **Settings** > **System** > **Restart Home Assistant** (top right) > **Restart Home Assistant in safe mode**.
## Related topics
- [Editing your configuration](/docs/configuration/#editing-configurationyaml)
- [Recovery mode integration](/integrations/recovery_mode/)
- [Resetting your password](/docs/locked_out/)

11
source/_docs/z-wave/controllers.markdown
View File

@ -66,12 +66,7 @@ The alternative to a stick is a hub that supports Z-Wave. Home Assistant support
### 800 Series Controllers
Z-Wave JS and Z-Wave JS UI do not support the following features available on most 800 series controllers.
Unsupported:
- Long Range
- NVM Backup/Restore
Z-Wave JS does not support Z-Wave Long Range yet.
### Aeotec Z-Stick
@ -89,8 +84,8 @@ On Raspberry Pi 3 and 4, you need to disable the on-board Bluetooth since the bo
For both processes below you will need to insert your SD card into your PC and open the configuration file with your favorite text editor.
- If you are using Home Assistant Operating System, once you mounted the disk, you will see the `config.txt` directly in the root directory.
- If you are using Home Assistant Supervised, the config file is stored in the boot folder: `/boot/config.txt`.
- If you are using {% term "Home Assistant Operating System" %}, once you mounted the disk, you will see the `config.txt` directly in the root directory.
- If you are using {% term "Home Assistant Supervised" %}, the config file is stored in the boot folder: `/boot/config.txt`.
#### Raspberry Pi 5 procedure

7
source/_includes/asides/docs_navigation.html
View File

@ -31,9 +31,10 @@
</ul>
</li>
<li>
<b>{% active_link /docs/configuration/ Configuration.yaml %}</b>
<b>Configuration</b>
<ul>
<li>{% active_link /docs/configuration/yaml/ YAML %}</li>
<li>{% active_link /docs/configuration/ Configuration.yaml %}</li>
<li>{% active_link /docs/configuration/yaml/ YAML syntax%}</li>
<li>
{% active_link /docs/configuration/basic/ Basic information %}
</li>
@ -186,4 +187,4 @@
</li>
</ul>
</div>
</section>
</section>

3
source/_includes/asides/organizing_navigation.html
View File

@ -3,7 +3,8 @@
<div class="section">
<h1 class="title delta">Organizing</h1>
<ul class="divided sidebar-menu">
<li>{% active_link /docs/organizing/ Organizing your assets %}</li>
<li>{% active_link /docs/organizing/ Grouping your assets %}</li>
<li>{% active_link /docs/organizing/filtering Filtering your assets %}</li>
<li>
{% active_link /docs/organizing/areas/ Areas %}
</li>

8
source/_includes/common-tasks/backups.md
View File

@ -1,6 +1,8 @@
## Backups
Backup of your Home Assistant and add-on data and configuration. They are stored in a compressed archive file (.tar). Backups are made from the backups panel under {% my supervisor_backups title="**Settings** > **System** > **Backups**" %}. There is also a service available that allows you to trigger the creation of a backup from an automation. By default, backups are stored locally in the `/backup` directory.
Backup of your Home Assistant, add-on data, and configuration. Backups are used to [restore](#restoring-a-backup) a system or parts of it if a rollback is needed or to migrate your Home Assistant to new hardware. It is good practice to create a backup before updating.
Backups are made from the backups panel under {% my supervisor_backups title="**Settings** > **System** > **Backups**" %}. There is also a [service](/integrations/hassio/#service-hassiobackup_full) available that allows you to trigger the creation of a backup from an automation. Backups are stored in a compressed archive file (.tar) and by default, stored locally in the `/backup` directory.
A full backup includes the following directories:
@ -26,7 +28,9 @@ A partial backup consists of any number of the above default directories and ins
1. Go to {% my supervisor_backups title="**Settings** > **System** > **Backups**" %} in the UI.
2. Select the **Create backup** button in the lower right.
3. Provide a name for the backup.
4. Choose full or partial.
4. Choose **Full backup** or **Partial backup**.
- If you choose **Partial backup**, make sure to select Home Assistant and all the folders and add-ons you want to backup or migrate.
- Note that the number of add-ons increases the size of the backup as well as the time it takes to restore from that backup.
5. Optionally, enable password protection.
6. Select **Create** to begin the backup.

11
source/_includes/common-tasks/commandline.md
View File

@ -1,10 +1,5 @@
## Home Assistant via the command line
<p class='img'>
<img src='/images/hassio/screenshots/ssh-upgrade.png'>
Home Assistant upgrade process from the SSH command line
</p>
On the SSH command line, you can use the `ha` command to retrieve logs, check the details of connected hardware, and more.
### Home Assistant
@ -103,11 +98,11 @@ Use "ha [command] --help" for more information about a command.
### Console access
You can also access the Home Assistant Operating System via a directly connected keyboard and monitor, the console.
You can also access the {% term "Home Assistant Operating System" %} via a directly connected keyboard and monitor, the console.
#### Wiping the data disk wipe from the command line
In Home Assistant Operating System, the `ha os datadisk wipe` command wipes the data disk. The command deletes all user data as well as Home Assistant Core, Supervisor, and any installed add-ons.
In {% term "Home Assistant Operating System" %}, the `ha os datadisk wipe` command wipes the data disk. The command deletes all user data as well as Home Assistant Core, Supervisor, and any installed add-ons.
The command `ha os datadisk wipe` marks the data partition (either internal on the eMMC or the SD card, or on an external attached data disk) as to be cleared on the next reboot. The command automatically reboots the system. Upon reboot, the data is cleared. Then the system continues to boot and reinstalls the latest version of all Home Assistant components.
@ -117,7 +112,7 @@ Note, if you have a Home Assistant Yellow, there is a red hardware button to wip
#### Listing all users from the command line
In Home Assistant Operating System, the `ha auth list` command lists all users that are registered on your Home Assistant.
In {% term "Home Assistant Operating System" %}, the `ha auth list` command lists all users that are registered on your Home Assistant.
The `ha auth list` command can only be run from the local terminal. Connect a display and keyboard and use the terminal.

26
source/_includes/common-tasks/configuration_check.md
View File

@ -2,12 +2,28 @@
{% if page.installation == "os" or page.installation == "supervised" %}
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
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.
- This is to make sure there are no syntax errors before restarting Home Assistant.
- 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
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.
```bash
ha core check
```
{% elsif page.installation == "container" %}
After changing configuration files, check if the configuration is valid before restarting Home Assistant Core.
_If your container name is something other than `homeassistant`, change that part in the examples below._
Run the full check:
@ -42,19 +58,21 @@ docker exec homeassistant python -m homeassistant --script check_config --help
{% elsif page.installation == "core" %}
1. Switch to the user that is running Home Assistant
After changing configuration files, check if the configuration is valid before restarting Home Assistant Core.
1. Switch to the user that is running Home Assistant.
```bash
sudo -u homeassistant -H -s
```
2. Activate the virtual environment that Home Assistant is running in
2. Activate the virtual environment that Home Assistant is running in.
```bash
source /srv/homeassistant/bin/activate
```
3. Run the configuration check
3. Run the configuration check.
Run the full check:
@ -86,6 +104,6 @@ docker exec homeassistant python -m homeassistant --script check_config --help
hass --script check_config --help
```
4. When that is complete restart the service for it to use the new files.
4. When that is complete, restart the service for it to use the new files.
{% endif %}

4
source/_includes/common-tasks/data_disk.md
View File

@ -1,6 +1,6 @@
## Using external data disk
Home Assistant Operating System supports storing most data on an external storage medium, such as an USB attached SSD or HDD. This data disk contains not only user data but also most of the Home Assistant software as well (Core, Supervisor, etc.). This means a fast data disk will make the system overall much faster.
{% term "Home Assistant Operating System" %} supports storing most data on an external storage medium, such as an USB attached SSD or HDD. This data disk contains not only user data but also most of the Home Assistant software as well (Core, Supervisor, etc.). This means a fast data disk will make the system overall much faster.
![Graphics showing the architecture of the data disk feature](/images/haos/usb-data-disk.png)
@ -20,7 +20,7 @@ The data disk feature can be used on an existing installation without losing dat
<div class='note'>
If you have been using a data disk previously with Home Assistant Operating System, you need to use your host computer to delete all partitions *before* using it as a data disk again.
If you have been using a data disk previously with {% term "Home Assistant Operating System" %}, you need to use your host computer to delete all partitions *before* using it as a data disk again.
</div>

23
source/_includes/common-tasks/enable_entities.md
View File

@ -1,12 +1,17 @@
## Enabling entities
## Enabling or disabling elements
Some entities are disabled by default. To enable them, follow these steps:
1. Go to **{% my integrations title="Settings > Devices & Services" %}** and select the integration of interest.
2. Select **entities**.
3. From the list of entities, select the entity you want to enable.
![Select entity from list](/images/screenshots/enable_entities_01.png)
4. In the pop-up, select the cogwheel.
5. Toggle the **Enabled** button.
![Enable entities](/images/screenshots/enable_entities_03.png)
6. To save the changes, select **Update**.
1. In Home Assistant, open the table of interest.
- To enable or disable entities, go to {% my entities title="**Settings** > **Devices & Services** > **Entities**" %}.
- To enable or disable automations, go to {% my automations title="**Settings** > **Automations & Scenes**" %}.
2. [Enable multiselect](/docs/organizing/filtering) and select all the entities you want to enable or disable.
3. In the top right corner, select the three dots menu, then select **Enable** or **Disable**.
![Screenshot showing how to enable or disable multiple automations](/images/organizing/enable_disable.png)
## Related topics
- [Enable multiselect](/docs/organizing/filtering)
- [Grouping your assets](/docs/organizing/)
- [Filtering your assets](/docs/organizing/filtering)

6
source/_includes/common-tasks/enable_i2c.md
View File

@ -1,6 +1,6 @@
## Enable I2C
Home Assistant using the Home Assistant Operating System which is a managed environment, which means you can't use existing methods to enable the I2C bus on a Raspberry Pi. In order to use I2C devices you will have to
Home Assistant using the {% term "Home Assistant Operating System" %} which is a managed environment, which means you can't use existing methods to enable the I2C bus on a Raspberry Pi. In order to use I2C devices you will have to
- Enable I2C for the Home Assistant Operating System
- Setup I2C devices e.g. sensors
@ -10,7 +10,7 @@ Home Assistant using the Home Assistant Operating System which is a managed envi
You will need:
- SD card reader
- SD card with Home Assistant Operating System flashed on it
- SD card with {% term "Home Assistant Operating System" %} flashed on it
Shutdown/turn-off your Home Assistant installation and unplug the SD card.
Plug the SD card into an SD card reader and find a drive/file system named
@ -43,7 +43,7 @@ and make sure the first partition is available.
### Enable I2C via Home Assistant Operating System Terminal
Alternatively, by attaching a keyboard and screen to your device, you can access the physical terminal to the Home Assistant Operating System.
Alternatively, by attaching a keyboard and screen to your device, you can access the physical terminal to the {% term "Home Assistant Operating System" %}.
You can enable I2C via this terminal:

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

@ -2,7 +2,7 @@
Home Assistant can be flashed to an ODROID-M1S by connecting the device directly to your computer via the USB-OTG connection on the front of the board.
Unlike other ODROID boards, the M1S does not have a socket for an optional <abbr title="embedded MultiMediaCard">eMMC</abbr> module. It also does not have a separate flash chip that holds a dedicated bootloader.
Instead, the M1S has a build-in 64GB <abbr title="embedded MultiMediaCard">eMMC</abbr> soldered directly on the board that holds a bootloader by default. This guide will show you how to install the Home Assistant Operating System to the built-in <abbr title="embedded MultiMediaCard">eMMC</abbr>.
Instead, the M1S has a build-in 64GB <abbr title="embedded MultiMediaCard">eMMC</abbr> soldered directly on the board that holds a bootloader by default. This guide will show you how to install the {% term "Home Assistant Operating System" %} to the built-in <abbr title="embedded MultiMediaCard">eMMC</abbr>.
<ins>**Warning:</ins> Installing Home Assistant OS replaces the firmware and <abbr title="secondary program loader">SPL</abbr> on the <abbr title="embedded MultiMediaCard">eMMC</abbr> with the mainline version provided by the Home Assistant OS. As a result, it is not possible to use the SD card with the EMMC2UMS image anymore, because the mainline <abbr title="secondary program loader">SPL</abbr> is not compatible with U-Boot in the EMMC2UMS image at this time (February 2024). This does not pose any problem for standard use, just makes it more complicated in case you want to return to the Hardkernel-provided OS (see [HK Recovery](#hk-recovery)).**

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

@ -13,7 +13,7 @@ To list all your currently connected network storages, go to **{% my storage tit
<div class='note'>
You need to make sure you run a supported Home Assistant Supervised installation with the latest version of the [os-agent](https://github.com/home-assistant/os-agent). Make sure that your supervisor uses [slave bind propagation](https://docs.docker.com/storage/bind-mounts/#configure-bind-propagation) for the data volume.
You need to make sure you run a supported {% term "Home Assistant Supervised" %} installation with the latest version of the [os-agent](https://github.com/home-assistant/os-agent). Make sure that your supervisor uses [slave bind propagation](https://docs.docker.com/storage/bind-mounts/#configure-bind-propagation) for the data volume.
</div>

14
source/_includes/common-tasks/update.md
View File

@ -1,11 +1,9 @@
## Update
Best practice for updating Home Assistant Core:
Best practice for updating a Home Assistant installation:
1. Backup your installation{% if page.installation == "os" or page.installation == "supervised" %}, using the backup functionality Home Assistant offers{% endif %}.
1. Backup your installation{% if page.installation == "os" or page.installation == "supervised" %}, using the [backup functionality](/common-tasks/os/#backups) Home Assistant offers{% endif %}.
2. Check the release notes for backward-incompatible changes on [Home Assistant release notes](/blog/categories/core/). Be sure to check all release notes between the version you are running and the one you are upgrading to. Use the search function in your browser (`CTRL + f` / `CMD + f`) and search for **Backward-incompatible changes**.
{% if page.installation == "os" or page.installation == "supervised" %}
3. Select "Create backup before updating" in case you encounter an issue that requires a rollback.
3. Select **Create backup before updating** in case you encounter an issue that requires a rollback.
4. Update Home Assistant.
5. Review persistent notifications and log to see if there are any issues with your configuration that need to be addressed.
{% endif %}
@ -19,9 +17,9 @@ To update Home Assistant Core when you run Home Assistant {{ page.installation_n
- title: Using the UI
content: |
1. Open your Home Assistant UI
2. Navigate to the Settings panel
3. On the top you will be presented with an update notification
1. Open your Home Assistant UI.
2. Navigate to the **Settings** panel.
3. On the top you will be presented with an update notification.
_If you do not see that notification you can click the overflow menu in the top right and select "Check for updates"._

2
source/_includes/installation/container.md
View File

@ -1,7 +1,7 @@
## Install Home Assistant Container
{% if page.installation_type != 'alternative' %}
These below instructions are for an installation of Home Assistant Container running in your own container environment, which you manage yourself. Any [OCI](https://opencontainers.org/) compatible runtime can be used, however this guide will focus on installing it with Docker.
These below instructions are for an installation of {% term "Home Assistant Container" %} running in your own container environment, which you manage yourself. Any [OCI](https://opencontainers.org/) compatible runtime can be used, however this guide will focus on installing it with Docker.
<div class='note'>
<b>Prerequisites</b>

4
source/_includes/installation/core.md
View File

@ -3,9 +3,9 @@
{% if page.installation_type == 'windows' %}
### Install WSL
To install Home Assistant Core on Windows, you will need to use the Windows Subsystem for Linux (WSL). Follow the [WSL installation instructions](https://docs.microsoft.com/windows/wsl/install-win10) and install Ubuntu from the Windows Store.
To install {% term "Home Assistant Core" %} on Windows, you will need to use the Windows Subsystem for Linux (WSL). Follow the [WSL installation instructions](https://docs.microsoft.com/windows/wsl/install-win10) and install Ubuntu from the Windows Store.
As an alternative, Home Assistant OS can be installed in a Linux guest VM. Running Home Assistant Core directly on Windows is not supported.
As an alternative, Home Assistant OS can be installed in a Linux guest VM. Running {% term "Home Assistant Core" %} directly on Windows is not supported.
{% endif %}
<div class='note warning'>

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

@ -46,7 +46,7 @@ Variants without pre-installed Home Assistant:
<div class='note'>
<b>Prerequisites</b>
This guide assumes that you have a dedicated {{ site.installation.types[page.installation_type].board }} PC to exclusively run the Home Assistant Operating System.
This guide assumes that you have a dedicated {{ site.installation.types[page.installation_type].board }} PC to exclusively run the {% term "Home Assistant Operating System" %}.
- This is typically an Intel or AMD-based system.
- The system must be 64-bit capable and be able to boot using UEFI.
@ -55,7 +55,7 @@ This guide assumes that you have a dedicated {{ site.installation.types[page.ins
<b>Summary</b>
1. First, you will need to configure your {{ site.installation.types[page.installation_type].board }} PC to use UEFI boot mode.
2. Then, write the Home Assistant Operating System disk image to your boot medium.
2. Then, write the {% term "Home Assistant Operating System" %} disk image to your boot medium.
</div>
@ -88,7 +88,7 @@ Typically, an internal medium like S-ATA hard disk, S-ATA SSD, M.2 SSD, or a non
To write the HAOS image to the boot medium on your x86-64 hardware, there are 2 different methods:
**Method 1 (recommended)**: Boot Ubuntu from a USB flash drive and install the Home Assistant Operating System from there. It also works on laptops and PCs with internal hard disks.
**Method 1 (recommended)**: Boot Ubuntu from a USB flash drive and install the {% term "Home Assistant Operating System" %} from there. It also works on laptops and PCs with internal hard disks.
**Method 2**: With this method, you write the Home Assistant Operating disk image directly onto a boot medium from your regular computer. The steps are a bit more complex. If you have non-removable internal mediums (for example because you are using a laptop) or do not have the necessary adapter (for example an USB to S-ATA adapter) use method 1 instead.
@ -97,13 +97,13 @@ To write the HAOS image to the boot medium on your x86-64 hardware, there are 2
#### Required material
- Computer
- The target x86-64 hardware, on which you want to install the Home Assistant Operating System (HAOS)
- The target x86-64 hardware, on which you want to install the {% term "Home Assistant Operating System" %} (HAOS)
- USB flash drive (USB thumb drive is sufficient, it should be at least 4&nbsp;GB in size)
- Internet connection
#### To install HAOS via Ubuntu from a USB flash drive
1. **Notice**: This procedure will write the Home Assistant Operating System onto your device.
1. **Notice**: This procedure will write the {% term "Home Assistant Operating System" %} onto your device.
- This means you will lose all the data as well as the previously installed operating system.
- Back up your data before carrying out this procedure.
2. Create a *live operating system* on a USB flash drive:
@ -145,7 +145,7 @@ Use this method only if Method 1 does not work for you.
#### Required material
- Computer
- The target x86-64 hardware, on which you want to install the Home Assistant Operating System (HAOS)
- The target x86-64 hardware, on which you want to install the {% term "Home Assistant Operating System" %} (HAOS)
- Boot medium
- Internet connection
@ -157,16 +157,16 @@ Use this method only if Method 1 does not work for you.
{% endif %}
1. **Notice**: This procedure will write the Home Assistant Operating System onto your device.
1. **Notice**: This procedure will write the {% term "Home Assistant Operating System" %} onto your device.
- This means you will lose all the data as well as the previously installed operating system.
- Back up your data before continuing with the next step.
2. Attach the Home Assistant boot medium ({{site.installation.types[page.installation_type].installation_media}}) to your computer.
{% if page.installation_type == 'odroid' %}
If you are using ODROID-M1, note that booting from NVMe is not supported. If you want to boot from eMMC, [update the firmware](https://github.com/home-assistant/operating-system/blob/dev/Documentation/boards/hardkernel/odroid-m1.md) before installing the image.
If you are using a [Home Assistant Blue](/blue) or ODROID-N2+, you can [attach your device directly](/common-tasks/os/#flashing-an-odroid-n2).
If you are using a [Home Assistant Blue](/blue) or ODROID-N2+, you can [attach your device directly](/installation/odroid#flashing-an-odroid-n2).
If you are using an ODROID-M1S, you need to follow this guide to [boot your device into UMS mode](/common-tasks/os/#flashing-an-odroid-m1s).
If you are using an ODROID-M1S, you need to follow this guide to [boot your device into UMS mode](/installation/odroid#flashing-an-odroid-m1s).
{% endif %}
3. Download and start <a href="https://www.balena.io/etcher" target="_blank">Balena Etcher</a>. You may need to run it with administrator privileges on Windows.
4. Download the image to your computer.
@ -184,9 +184,9 @@ Use this method only if Method 1 does not work for you.
```
{% if variant.key == "odroid-n2" %}
[Guide: Flashing ODROID-N2 using OTG-USB](/hassio/flashing_n2_otg/)
[Guide: Flashing ODROID-N2 using OTG-USB](/installation/odroid#flashing-an-odroid-n2)
{% elsif variant.key == "odroid-m1s" %}
[Guide: Flashing ODROID-M1S using OTG-USB](/hassio/flashing_m1s_otg/)
[Guide: Flashing ODROID-M1S using OTG-USB](/installation/odroid#flashing-an-odroid-m1s)
{% elsif variant.key == "rpi4" or variant.key == "rpi3" %}
*(64-bit is recommended)*
{% endif %}
@ -472,6 +472,13 @@ With the Home Assistant Operating System installed and accessible, you can conti
{% include getting-started/next_step.html step="Onboarding" link="/getting-started/onboarding/" %}
{% if page.installation_type == 'odroid' %}
{% include common-tasks/flashing_n2_otg.md %}
{% include common-tasks/flashing_m1s_otg.md %}
{% endif %}
[generic-x86-64]: {{release_url}}/{{site.data.version_data.hassos['ova']}}/haos_generic-x86-64-{{site.data.version_data.hassos['generic-x86-64']}}.img.xz
[vmdk]: {{release_url}}/{{site.data.version_data.hassos['ova']}}/haos_ova-{{site.data.version_data.hassos['ova']}}.vmdk.zip
[vhdx]: {{release_url}}/{{site.data.version_data.hassos['ova']}}/haos_ova-{{site.data.version_data.hassos['ova']}}.vhdx.zip

2
source/_includes/installation/supervised.md
View File

@ -14,6 +14,6 @@ Unless you really need this installation type, you should install Home Assistant
supported). So, make sure you understand the requirements from step 1 above.
3. Then head over to <a href="https://github.com/home-assistant/supervised-installer" target="_blank">home-assistant/supervised-installer</a> to set it up.
Once the Home Assistant Supervised installation is running and Home Assistant is accessible you can continue with onboarding.
Once the {% term "Home Assistant Supervised" %} installation is running and Home Assistant is accessible you can continue with onboarding.
{% include getting-started/next_step.html step="Onboarding" link="/getting-started/onboarding/" %}

44
source/_includes/related.html Normal file
View File

@ -0,0 +1,44 @@
{% assign related_topics = "" | split: ',' %}
{% assign related_links = "" | split: ',' %}
{%- for entry in page.related -%}
{%- if entry.url -%}
{% assign related_links = related_links | push: entry %}
{% else %}
{% assign related_topics = related_topics | push: entry %}
{% endif %}
{%- endfor -%}
{% if related_topics and related_topics.size != 0 %}
<div class="text related-topics" id="related-topics">
<h2>Related topics</h2>
<ul>
{% assign site_part = "pages,documents" | split: "," %}
{%- for related in related_topics -%}
{%- for part in site_part -%}
{%- for entry in site[part] -%}
{% assign computed = related.docs | split: "#" %}
{% assign link_target = computed[1] %}
{% assign suggested_title = related.title | default: link_target | split: "-" | join: " " | capitalize %}
{%- if computed[0] == entry.url -%}
<li>
<a href="{{ entry.url | relative_url }}{% if link_target %}#{{link_target}}{% endif %}" class="topic">
{{ suggested_title | default: entry.title}}
</a>
</li>
{% break %}{% break %}
{%- endif -%}
{%- endfor -%}
{%- endfor -%}
{%- endfor -%}
</ul>
</div>
{% endif %}
{% if related_links and related_links.size != 0 %}
<div class="text related-links" id="related-links">
<h2>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>
{% endfor %}
</ul>
</div>
{% endif %}

1
source/_integrations/airzone_cloud.markdown
View File

@ -4,6 +4,7 @@ description: Instructions on how to integrate Airzone Cloud within Home Assistan
ha_release: 2023.6
ha_category:
- Binary sensor
- Climate
- Select
- Sensor
- Water heater

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

@ -105,7 +105,7 @@ Steps to Integrate an Amazon Alexa Smart Home Skill with Home Assistant:
## Requirements
- The Alexa Smart Home API requires your Home Assistant instance to be accessible from the internet via HTTPS on port 443 using an SSL/TLS certificate. A self-signed certificate will work, but a certificate signed by [an Amazon approved certificate authority](https://ccadb-public.secure.force.com/mozilla/IncludedCACertificateReport) is recommended. Read more on [our blog](/blog/2015/12/13/setup-encryption-using-lets-encrypt/) about how to set up encryption for Home Assistant. When running Home Assistant, using the [Duck DNS](/addons/duckdns/) add-on is the easiest method.
- The Alexa Smart Home API requires your Home Assistant instance to be accessible from the internet via HTTPS on port 443 using an SSL/TLS certificate. A self-signed certificate will not work, but a public trusted certificate or a certificate signed by [an Amazon approved certificate authority](https://ccadb-public.secure.force.com/mozilla/IncludedCACertificateReport) should work. Read more on [our blog](/blog/2015/12/13/setup-encryption-using-lets-encrypt/) about how to set up encryption for Home Assistant. When running Home Assistant, using the [Duck DNS](/addons/duckdns/) add-on is the easiest method.
- An Amazon Developer Account. Sign up [here](https://developer.amazon.com).
- An [Amazon Web Services (AWS)](https://aws.amazon.com/free/) account is required to host the Lambda function for your Alexa Smart Home Skill. [AWS Lambda](https://aws.amazon.com/lambda/pricing/) is free to use for up to 1-million requests and 1GB outbound data transfer per month.
@ -240,9 +240,9 @@ Alexa needs to link your Amazon account to your Home Assistant account. Therefor
- `Authorization URI`: `https://[YOUR HOME ASSISTANT URL]/auth/authorize`
- `Access Token URI`: `https://[YOUR HOME ASSISTANT URL]/auth/token`
It is also possible to use a different port by appending `:1443` or a similar port number, make sure your firewall is forwarding the correct port:
- `Authorization URI`: `https://[YOUR HOME ASSISTANT URL]:1443/auth/authorize`
- `Access Token URI`: `https://[YOUR HOME ASSISTANT URL]:1433/auth/token`
Although it is possible to assign a different port, Alexa requires you use port 443, so make sure your firewall/proxy is forwarding via port 443.
Read [more from the Alexa developer documentation](https://developer.amazon.com/en-US/docs/alexa/account-linking/requirements-account-linking.html) about requirements for account linking.
<div class="note">
Note: you must use a valid/trusted SSL certificate for account linking to work. Self signed certificates will not work, but you can use a free Let's Encrypt certificate.

5
source/_integrations/aosmith.markdown
View File

@ -33,6 +33,11 @@ Before using this integration, your water heater must be connected to a Wi-Fi ne
- HPS10-66H45DV
- HPS10-80H45DV
- HPSX-50-DHPT
- HPSX-50-DHPT 2
- HPSX-66-DHPT
- HPSX-66-DHPT 2
- HPSX-80-DHPT
- HPSX-80-DHPT 2
- HPTS-50
- HPTS-66
- HPTS-80

55
source/_integrations/backup.markdown
View File

@ -10,40 +10,34 @@ ha_codeowners:
- '@home-assistant/core'
ha_iot_class: Calculated
ha_integration_type: system
related:
- docs: /installation/#advanced-installation-methods
title: Home Assistant installation methods
- docs: /getting-started/onboarding/
title: Recover from backup during onboarding
- docs: /docs/configuration/
title: Configuration file
- docs: /common-tasks/os/#restoring-a-backup
title: Home Assistant Operating System- Restoring a backup
---
The Backup integration allow you to create and download backups for your Home Assistant Core and Home Assistant Container installations. This backup file can be used if you migrate to Home Assistant Operating System.
The **Backup** {% term integration %} allows you to create and download backups for your {% term "Home Assistant Core" %} and {% term "Home Assistant Container" %} installations. This backup file can be used if you migrate to {% term "Home Assistant Operating System" %}.
<div class="note">
If you use Home Assistant Operating System or Home Assistant Supervised, [back up functionality is already built-in](/common-tasks/os/#backups).
If you use {% term "Home Assistant Operating System" %} or {% term "Home Assistant Supervised" %} , the [back up functionality is already built-in](/common-tasks/os/#backups). This integration is for {% term "Home Assistant Core" %} and {% term "Home Assistant Container" %} installations.
</div>
## Manual configuration
The backup integration is by default enabled. If you've disabled or removed the [`default_config:`](/integrations/default_config/) line from your configuration the following example shows you how to enable this integration manually:
```yaml
# Example configuration.yaml entry
backup:
```
You need to restart Home Assistant after you add this configuration.
When it has started up again you will find a new "Backup" entry in the main menu (**{% my backup title="Settings > System > Backups" %}**).
The backup files are stored in a new "backups" subdirectory in the root of your configuration directory.
## Services
The backup integration exposes a service that can be used to automate the backup
The **Backup** integration exposes a service that can be used to automate the backup
process.
### Service {% my developer_call_service service="backup.create" %}
The {% my developer_call_service service="backup.create" %} service can be used
to create a backup for your Home Assistant instance.
to create a backup for your Home Assistant instance.
The service has no additional options or parameters.
@ -55,7 +49,6 @@ service: backup.create
### Example: Backing up every night at 3:00 AM
This is a YAML example for an automation that initiate a backup every night
at 3 AM:
@ -72,15 +65,21 @@ automation:
## Restoring a backup
<div class="note">
Backups created via the **Backup** integration are in a subdirectory `backups`, located in your [configuration directory](/docs/configuration/#editing-configurationyaml).
The {% term "Home Assistant Container" %} installation typically mounts this directory via `docker-compose.yml` or `docker run` to a directory of your choice.
If you use Home Assistant Operating System or Home Assistant Supervised, [the restore functionality is already built-in](/common-tasks/os/#restoring-a-backup).
The steps on recovering from a backup depend on the installation type and use case. Follow one of these steps:
</div>
1. If you use {% term "Home Assistant Operating System" %} or {% term "Home Assistant Supervised" %}:
- Follow the steps described in [Restoring a backup](/common-tasks/os/#restoring-a-backup).
2. If you use a {% term "Home Assistant Core" %} or {% term "Home Assistant Container" %} installation:
- A Home Assistant backup is just a tar file of the [configuration directory](/docs/configuration/#editing-configurationyaml), plus some metadata.
- To manually restore a backup, use the following command:
Backups created via the **Backup** integration are located in your `/config/backups` directory. The Home Assistant Container installation will typically mount this directory via `docker-compose.yml` or `docker run` to a directory of your choice.
For Container and Core installations, there is currently no built-in way to restore a backup. However, a Home Assistant backup is just a tar file of the `/config` directory, plus some metadata. To manually restore a backup, you can use the following:
```shell
tar -xOf <backup_tar_file> "./homeassistant.tar.gz" | tar --strip-components=1 -zxf - -C <restore_directory>
```
3. If you migrate from a {% term "Home Assistant Core" %} or {% term "Home Assistant Container" %} installation to {% term "Home Assistant Operating System" %}:
- You can use these backup files during [onboarding](/getting-started/onboarding/) to recover your installation from backup.
```shell
tar -xOf <backup_tar_file> "./homeassistant.tar.gz" | tar --strip-components=1 -zxf - -C <restore_directory>
```

16
source/_integrations/bring.markdown
View File

@ -13,6 +13,15 @@ ha_domain: bring
ha_integration_type: service
ha_platforms:
- todo
related:
- docs: /integrations/todo
title: To-do list integration documentation
- docs: /integrations/#to-do-list
title: List of to-do list integrations
- docs: /dashboards/todo-list/
title: To-do list card
- url: https://www.getbring.com/
title: Bring!
---
The **Bring!** integration allows you to interact with your [Bring!](https://www.getbring.com/) shopping lists within Home Assistant.
@ -20,10 +29,3 @@ The **Bring!** integration allows you to interact with your [Bring!](https://www
For authentication, the integration requires the `email` and `password` you used for your Bring! account. If you want to automatically receive notifications via the Bring! app when Home Assistant adds or removes an item from the list, you should use a dedicated account (such as `email: your.name+ha@gmail.com`) to connect Home Assistant with [Bring!](https://www.getbring.com/).
{% include integrations/config_flow.md %}
## Related topics
- [Bring!](https://www.getbring.com/)
- [To-do list integration documentation](/integrations/todo)
- [List of to-do list integrations](/integrations/#to-do-list)
- [To-do list card](/dashboards/todo-list/)

19
source/_integrations/caldav.markdown
View File

@ -12,6 +12,15 @@ ha_platforms:
- todo
ha_integration_type: integration
ha_config_flow: true
related:
- docs: /integrations/todo
title: To-do list integration documentation
- docs: /integrations/#to-do-list
title: List of to-do list integrations
- docs: /dashboards/todo-list/
title: To-do list card
- docs: /integrations/calendar
title: Calendar
---
The **CalDAV** integration allows you to connect your WebDAV calendar to Home Assistant
@ -203,13 +212,3 @@ to generate a new password for use by Home Assistant to avoid sharing your iClou
password.
{% enddetails %}
## Related topics
- [Calendar](/integrations/calendar)
### To-do list
- [To-do list integration documentation](/integrations/todo)
- [List of to-do list integrations](/integrations/#to-do-list)
- [To-do list card](/dashboards/todo-list/)

2
source/_integrations/denonavr.markdown
View File

@ -112,6 +112,8 @@ Known supported devices:
If your model is not on the list then give it a test, if everything works correctly then add it to the list by clicking on the **Edit** link at the bottom of this page.
If you are using VLANs, Home Assistant needs access to the following ports on the AVR: 23, 8080, and 60006 (all TCP).
<div class='note warning'>
If you have something else using the IP controller for your Denon AVR 3808CI, such as your URC controller, it will not work! There is either a bug or security issue with some models where only one device could be controlling the IP functionality.
</div>

61
source/_integrations/ezviz.markdown
View File

@ -25,6 +25,9 @@ ha_platforms:
- switch
- update
ha_integration_type: integration
related:
- docs: /dashboards/picture-glance/#creating-a-card-to-control-the-camera
title: Controlling the camera from the dashboard
---
The `ezviz` sensor platform uses the ezvizlife.com API to interact with the devices.
@ -74,61 +77,61 @@ You can also change the camera options should you need to access a high or low r
If your EZVIZ camera supports warning sounds, you can use this service to set the intensity.
| Service data attribute | Description |
| -----------------------| ----------- |
| `entity_id` | String or list of strings that point at `entity_id`s of cameras. Use `entity_id: all` to target all. |
| `level` | Set the sound level to 0 for Soft, 1 for Intensive or 2 to disable |
| Service data attribute | Description |
| ---------------------- | ---------------------------------------------------------------------------------------------------- |
| `entity_id` | String or list of strings that point at `entity_id`s of cameras. Use `entity_id: all` to target all. |
| `level` | Set the sound level to 0 for Soft, 1 for Intensive or 2 to disable |
### Service `ezviz.ptz`
If your EZVIZ camera supports <abbr title="pan, tilt, and zoom">PTZ</abbr>, you will be able to pan or tilt your camera.
| Service data attribute | Description |
| -----------------------| ----------- |
| `entity_id` | String or list of strings that point at `entity_id`s of cameras. Use `entity_id: all` to target all. |
| `direction` | Direction of the movement. Allowed values: `up`, `down`, `left`, `right` |
| `speed` | (Optional) Speed to in which to move the camera. Allowed values: int from 1 to 9. Default: 5 |
| Service data attribute | Description |
| ---------------------- | ---------------------------------------------------------------------------------------------------- |
| `entity_id` | String or list of strings that point at `entity_id`s of cameras. Use `entity_id: all` to target all. |
| `direction` | Direction of the movement. Allowed values: `up`, `down`, `left`, `right` |
| `speed` | (Optional) Speed to in which to move the camera. Allowed values: int from 1 to 9. Default: 5 |
### Service `ezviz.set_alarm_detection_sensibility`
If your EZVIZ camera supports motion detection, you will be able to set the sensitivity level using this service.
| Service data attribute | Description |
| -----------------------| ----------- |
| `entity_id` | String or list of strings that point at `entity_id`s of cameras. Use `entity_id: all` to target all. |
| `level` | Sensibility level (1-6) for type 0 (Normal camera) or (1-100) for type 3 (PIR sensor camera). |
| `type_value` | Type of detection. Options : 0 - Camera or 3 - PIR Sensor Camera. |
| Service data attribute | Description |
| ---------------------- | ---------------------------------------------------------------------------------------------------- |
| `entity_id` | String or list of strings that point at `entity_id`s of cameras. Use `entity_id: all` to target all. |
| `level` | Sensibility level (1-6) for type 0 (Normal camera) or (1-100) for type 3 (PIR sensor camera). |
| `type_value` | Type of detection. Options : 0 - Camera or 3 - PIR Sensor Camera. |
### Service `ezviz.sound_alarm`
If your EZVIZ camera has a built-in siren, you can use this service to make a noise.
| Service data attribute | Description |
| -----------------------| ----------- |
| `entity_id` | String or list of strings that point at `entity_id`s of cameras. Use `entity_id: all` to target all. |
| `enable` | Sound the alarm by setting this to 1 or stop the siren by setting this to 0. |
| Service data attribute | Description |
| ---------------------- | ---------------------------------------------------------------------------------------------------- |
| `entity_id` | String or list of strings that point at `entity_id`s of cameras. Use `entity_id: all` to target all. |
| `enable` | Sound the alarm by setting this to 1 or stop the siren by setting this to 0. |
### Service `ezviz.wake_device`
If you have "sleep" mode enabled on your camera, you can use this service to wake it. Especially useful for battery cameras.
| Service data attribute | Description |
| -----------------------| ----------- |
| `entity_id` | String or list of strings that point at `entity_id`s of cameras. Use `entity_id: all` to target all. |
| Service data attribute | Description |
| ---------------------- | ---------------------------------------------------------------------------------------------------- |
| `entity_id` | String or list of strings that point at `entity_id`s of cameras. Use `entity_id: all` to target all. |
To enable/disable motion detection, use the Home Assistant built in services.
### Service `camera.enable_motion_detection`
| Service data attribute | Description |
| -----------------------| ----------- |
| `entity_id` | String or list of strings that point at `entity_id`s of cameras. Use `entity_id: all` to target all. |
| Service data attribute | Description |
| ---------------------- | ---------------------------------------------------------------------------------------------------- |
| `entity_id` | String or list of strings that point at `entity_id`s of cameras. Use `entity_id: all` to target all. |
### Service `camera.disable_motion_detection`
| Service data attribute | Description |
| -----------------------| ----------- |
| `entity_id` | String or list of strings that point at `entity_id`s of cameras. Use `entity_id: all` to target all. |
| Service data attribute | Description |
| ---------------------- | ---------------------------------------------------------------------------------------------------- |
| `entity_id` | String or list of strings that point at `entity_id`s of cameras. Use `entity_id: all` to target all. |
### Alarm control panel entity
@ -166,7 +169,3 @@ The image entity represents the last detected event from a camera and visually r
## Troubleshooting
- `authentication failed`: The authentication requires an EZVIZ account with two-step verification disabled. Google, Facebook, TikTok, or other Oauth-based accounts will not work.
## Related topics
- [Controlling the camera from the dashboard](/dashboards/picture-glance/#creating-a-card-to-control-the-camera)

2
source/_integrations/frontend.markdown
View File

@ -94,7 +94,7 @@ Note that the variables will be used in the listed order, so if multiple match y
frontend:
themes:
my_theme:
state-cover-garage_door-open-color: "#ff0000"
state-cover-garage-open-color: "#ff0000"
state-media_player-inactive-color: "#795548"
```

2
source/_integrations/fyta.markdown
View File

@ -18,7 +18,7 @@ The **FYTA** {% term integration %} uses the open API of [FYTA](https://www.fyta
For the authentication on the FYTA server, you need your login-credentials (email and password).
The integration provides a device for all plants with a FYTA Beam sensor.
The integration provides a device for all plants with a [FYTA Beam](https://fyta.de/collections/all/products/single-beam) sensor. In order to be able to access your plant data over the API, you need a [FYTA hub](https://fyta.de/collections/all/products/single-hub) that uploads the data from the Beam sensor to the FYTA server. Alternatively, the mobile app can serve as gateaway to upload the data from the Beam to the server. No direct connection to the FYTA Beam is supported.
{% include integrations/config_flow.md %}

22
source/_integrations/google_tasks.markdown
View File

@ -12,6 +12,17 @@ ha_codeowners:
ha_integration_type: integration
ha_platforms:
- todo
related:
- docs: /integrations/todo
title: To-do list integration documentation
- docs: /integrations/#to-do-list
title: List of to-do list integrations
- docs: /dashboards/todo-list/
title: To-do list card
- url: https://support.google.com/tasks/answer/7675772
title: Google Tasks
- url: https://console.cloud.google.com/apis/library/tasks.googleapis.com
title: Google Developers Console
---
The **Google Tasks** integration allows you to connect your [Google Tasks](https://support.google.com/tasks/answer/7675772) to Home Assistant. The integration adds a [to-do list entity](/integrations/todo) for
@ -78,14 +89,3 @@ The integration setup will next give you instructions to enter the [Application
## Troubleshooting
If you have an error with your credentials, you can delete them in the [Application Credentials](/integrations/application_credentials/) user interface.
## Related topics
- [Google Tasks](https://support.google.com/tasks/answer/7675772)
- [Google Developers Console](https://console.cloud.google.com/apis/library/tasks.googleapis.com)
### To-do list
- [To-do list integration documentation](/integrations/todo)
- [List of to-do list integrations](/integrations/#to-do-list)
- [To-do list card](/dashboards/todo-list/)

1
source/_integrations/heos.markdown
View File

@ -144,6 +144,7 @@ For removing a HEOS player from a group you can use the `media_player.unjoin` se
## Notes
- Receivers with multiple zones are represented as a single media player. They will be turned on when playback is started, but cannot be turned off by the integration at this time.
- [Denon AVR](/integrations/denonar/) and HEOS media players can be combined into a [Universal Media Player](/integrations/universal/#denon-avr--heos)
## Troubleshooing

10
source/_integrations/history.markdown
View File

@ -9,6 +9,11 @@ ha_codeowners:
- '@home-assistant/core'
ha_domain: history
ha_integration_type: system
related:
- docs: /integrations/recorder/
title: Recorder integration
- url: https://data.home-assistant.io
title: Home Assistant Data Science Portal
---
The **History** integration tracks everything that is going on within Home
@ -49,8 +54,3 @@ If you select a time frame that exceeds 10 days, the data is taken from the long
The history information is also available through the
[RESTful API](/developers/rest_api/#get-apihistory).
## Related topics
- [Recorder integration](/integrations/recorder/)
- [Home Assistant Data Science Portal](https://data.home-assistant.io)

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