Screenshot of the button card with script service.
-
-## Related topics
-
-- [Card actions](/dashboards/actions/)
-- [Scripts](/docs/scripts/)
-- [Themes](/integrations/frontend/)
-- [Dashboard cards](/dashboards/cards/)
\ No newline at end of file
diff --git a/source/_dashboards/calendar.markdown b/source/_dashboards/calendar.markdown
index 3705e87e1203..940a45c7fe69 100644
--- a/source/_dashboards/calendar.markdown
+++ b/source/_dashboards/calendar.markdown
@@ -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/)
\ No newline at end of file
diff --git a/source/_dashboards/conditional.markdown b/source/_dashboards/conditional.markdown
index 3cf505e9a5e4..ead8ea37a11b 100644
--- a/source/_dashboards/conditional.markdown
+++ b/source/_dashboards/conditional.markdown
@@ -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.
@@ -25,7 +28,7 @@ type:
type: string
conditions:
required: true
- description: List of conditions to check. See [available conditions](/dashboards/conditional/#card-conditions).
+ description: List of conditions to check. See [available conditions](#conditions-options).
type: list
card:
required: true
@@ -79,24 +82,24 @@ card:
- binary_sensor.rookmelder
```
-## Card conditions
+## Conditions options
### State
+Tests if an entity has a specified state.
+
```yaml
-condition: "state"
+condition: state
entity: climate.thermostat
state: heat
```
```yaml
-condition: "state"
+condition: state
entity: climate.thermostat
state_not: "off"
```
-Tests if an entity has a specified state.
-
{% configuration %}
condition:
required: true
@@ -108,11 +111,11 @@ entity:
type: string
state:
required: false
- description: Entity state is equal to this value. Can contain an array of states.*
+ description: Entity state or ID to be equal to this value. Can contain an array of states.*
type: [list, string]
state_not:
required: false
- description: Entity state is unequal to this value. Can contain an array of states.*
+ description: Entity state or ID to not be equal to this value. Can contain an array of states.*
type: [list, string]
{% endconfiguration %}
@@ -123,7 +126,7 @@ state_not:
Tests if an entity state matches the thresholds.
```yaml
-condition: "numeric_state"
+condition: numeric_state
entity: sensor.outside_temperature
above: 10
below: 20
@@ -140,15 +143,15 @@ entity:
type: string
above:
required: false
- description: Entity state is above this value.*
+ description: Entity state or ID to be above this value.*
type: string
below:
required: false
- description: Entity state is below to this value.*
+ description: Entity state or ID to be below this value.*
type: string
{% endconfiguration %}
-*at least one is required (`above` or `below`)
+*at least one is required (`above` or `below`), both are also possible for values between.
### Screen
@@ -175,7 +178,7 @@ media_query:
Specify the visibility of the card per user.
```yaml
-condition: "user"
+condition: user
users:
- 581fca7fdc014b8b894519cc531f9a04
```
@@ -191,6 +194,54 @@ users:
type: list
{% endconfiguration %}
-## Related topics
+### And
+
+Specify that both conditions must be met.
+
+```yaml
+condition: and
+conditions:
+ - condition: numeric_state
+ above: 0
+ - condition: user
+ users:
+ - 581fca7fdc014b8b894519cc531f9a04
+```
+
+{% configuration %}
+condition:
+ required: true
+ description: "`and`"
+ type: string
+conditions:
+ required: false
+ description: List of conditions to check. See [available conditions](#conditions-options).
+ type: list
+{% endconfiguration %}
+
+### Or
+
+Specify that at least one of the conditions must be met.
+
+```yaml
+condition: or
+conditions:
+ - condition: numeric_state
+ above: 0
+ - condition: user
+ users:
+ - 581fca7fdc014b8b894519cc531f9a04
+```
+
+{% configuration %}
+condition:
+ required: true
+ description: "`or`"
+ type: string
+conditions:
+ required: false
+ description: List of conditions to check. See [available conditions](#conditions-options).
+ type: list
+{% endconfiguration %}
+
-- [Dashboard cards](/dashboards/cards/)
\ No newline at end of file
diff --git a/source/_dashboards/energy.markdown b/source/_dashboards/energy.markdown
index f09f2a4fa3bd..d0101d4d697d 100644
--- a/source/_dashboards/energy.markdown
+++ b/source/_dashboards/energy.markdown
@@ -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/)
\ No newline at end of file
diff --git a/source/_dashboards/entities.markdown b/source/_dashboards/entities.markdown
index 9710311a5915..98cc7056db55 100644
--- a/source/_dashboards/entities.markdown
+++ b/source/_dashboards/entities.markdown
@@ -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/)
\ No newline at end of file
diff --git a/source/_dashboards/entity-filter.markdown b/source/_dashboards/entity-filter.markdown
index 201e7067261d..64b575458292 100644
--- a/source/_dashboards/entity-filter.markdown
+++ b/source/_dashboards/entity-filter.markdown
@@ -29,9 +29,13 @@ entities:
required: true
description: A list of entity IDs or `entity` objects, see below.
type: list
+conditions:
+ required: false
+ description: List of conditions to check. See [available conditions](#conditions-options).*
+ type: list
state_filter:
- required: true
- description: List of strings representing states or `filter` objects, see below.
+ required: false
+ description: (legacy) List of strings representing states or filters to check. See [available legacy filters](#legacy-state-filters).*
type: list
card:
required: false
@@ -45,6 +49,8 @@ show_empty:
default: true
{% endconfiguration %}
+*one is required (`conditions` or `state_filter`)
+
### Options for entities
If you define entities as objects instead of strings (by adding `entity:` before entity ID), you can add more customization and configurations:
@@ -64,8 +70,9 @@ name:
type: string
icon:
required: false
- description: Overwrites icon or entity picture.
+ description: Overwrites icon or entity picture. You can use any icon from [Material Design Icons](https://pictogrammers.com/library/mdi/). Prefix the icon name with `mdi:`, ie `mdi:home`.
type: string
+ default: Entity domain icon
secondary_info:
required: false
description: "Show additional info. Values: `entity-id`, `last-changed`."
@@ -74,32 +81,225 @@ format:
required: false
description: "How the state should be formatted. Currently only used for timestamp sensors. Valid values are: `relative`, `total`, `date`, `time` and `datetime`."
type: string
+conditions:
+ required: false
+ description: List of conditions to check. See [available conditions](#conditions-options).*
+ type: list
state_filter:
required: false
- description: List of strings representing states or `filter` objects, see below.
+ description: (legacy) List of strings representing states or filters to check. See [available legacy filters](#legacy-state-filters).*
type: list
{% endconfiguration %}
-### Options for state filter
+*only one filter will be applied: `conditions` or `state_filter` if `conditions` is not present
-If you define `state_filter` as objects instead of strings (by adding `value:` before your state value), you can add more customization to your filter:
+## Conditions options
-{% configuration %}
-value:
+You can specify multiple `conditions`, in which case the entity will be displayed if it matches any condition.
+
+### State
+
+Tests if an entity has a specified state.
+
+```yaml
+type: entity-filter
+entities:
+ - climate.thermostat_living_room
+ - climate.thermostat_bed_room
+conditions:
+ - condition: state
+ state: heat
+```
+
+```yaml
+type: entity-filter
+entities:
+ - climate.thermostat_living_room
+ - climate.thermostat_bed_room
+conditions:
+ - condition: state
+ state_not: "off"
+```
+
+```yaml
+type: entity-filter
+entities:
+ - sensor.gas_station_1
+ - sensor.gas_station_2
+ - sensor.gas_station_3
+conditions:
+ - condition: state
+ state: sensor.gas_station_lowest_price
+```
+
+{% configuration condition_state %}
+condition:
required: true
- description: String representing the state.
+ description: "`state`"
type: string
-operator:
+state:
required: false
- description: Operator to use in the comparison. Can be `==`, `<=`, `<`, `>=`, `>`, `!=`, `in`, `not in`, or `regex`.
+ description: Entity state or ID to be equal to this value. Can contain an array of states.*
+ type: [list, string]
+state_not:
+ required: false
+ description: Entity state or ID to not be equal to this value. Can contain an array of states.*
+ type: [list, string]
+{% endconfiguration %}
+
+*one is required (`state` or `state_not`)
+
+### Numeric state
+
+Tests if an entity state matches the thresholds.
+
+```yaml
+type: entity-filter
+entities:
+ - sensor.outside_temperature
+ - sensor.living_room_temperature
+ - sensor.bed_room_temperature
+conditions:
+ - condition: numeric_state
+ above: 10
+ below: 20
+```
+
+{% configuration condition_numeric_state %}
+condition:
+ required: true
+ description: "`numeric_state`"
type: string
-attribute:
+above:
required: false
- description: Attribute of the entity to use instead of the state.
+ description: Entity state or ID to be above this value.*
+ type: string
+below:
+ required: false
+ description: Entity state or ID to be below this value.*
+ type: string
+{% endconfiguration %}
+
+*at least one is required (`above` or `below`), both are also possible for values between.
+
+### Screen
+
+Specify the visibility of the entity per screen size. Some screen size presets are available in the UI but you can use any CSS media query you want in YAML.
+
+```yaml
+type: entity-filter
+entities:
+ - sensor.outside_temperature
+ - sensor.living_room_temperature
+ - sensor.bed_room_temperature
+conditions:
+ - condition: screen
+ media_query: "(min-width: 1280px)"
+```
+
+{% configuration condition_screen %}
+condition:
+ required: true
+ description: "`screen`"
+ type: string
+media_query:
+ required: true
+ description: Media query to check which screen size are allowed to display the entity.
+ type: string
+{% endconfiguration %}
+
+### User
+
+Specify the visibility of the entity per user.
+
+```yaml
+type: entity-filter
+entities:
+ - sensor.outside_temperature
+ - sensor.living_room_temperature
+ - sensor.bed_room_temperature
+conditions:
+ - condition: user
+ users:
+ - 581fca7fdc014b8b894519cc531f9a04
+```
+
+{% configuration condition_user %}
+condition:
+ required: true
+ description: "`user`"
+ type: string
+users:
+ required: true
+ description: User ID that can see the entity (unique hex value found on the Users configuration page).
+ type: list
+{% endconfiguration %}
+
+### And
+
+Specify that both conditions must be met.
+
+```yaml
+type: entity-filter
+entities:
+ - sensor.outside_temperature
+ - sensor.living_room_temperature
+ - sensor.bed_room_temperature
+conditions:
+ - condition: and
+ conditions:
+ - condition: numeric_state
+ above: 0
+ - condition: user
+ users:
+ - 581fca7fdc014b8b894519cc531f9a04
+```
+
+{% configuration condition_and %}
+condition:
+ required: true
+ description: "`and`"
+ type: string
+conditions:
+ required: false
+ description: List of conditions to check. See [available conditions](#conditions-options).
+ type: list
+{% endconfiguration %}
+
+### Or
+
+Specify that at least one of the conditions must be met.
+
+```yaml
+type: entity-filter
+entities:
+ - sensor.outside_temperature
+ - sensor.living_room_temperature
+ - sensor.bed_room_temperature
+conditions:
+ - condition: or
+ conditions:
+ - condition: numeric_state
+ above: 0
+ - condition: user
+ users:
+ - 581fca7fdc014b8b894519cc531f9a04
+```
+
+{% configuration condition_or %}
+condition:
+ required: true
+ description: "`or`"
type: string
+conditions:
+ required: false
+ description: List of conditions to check. See [available conditions](#conditions-options).
+ type: list
{% endconfiguration %}
-## Examples
+## Legacy state filters
+
+### String filter
Show only active switches or lights in the house.
@@ -134,7 +334,32 @@ card:
Entity filter combined with glance card.
-You can also specify multiple `state_filter` conditions, in which case the entity will be displayed if it matches any condition. This example will display everyone who is at home or at work.
+You can also specify multiple `state_filter` conditions, in which case the entity will be displayed if it matches any condition.
+
+If you define `state_filter` as objects instead of strings, you can add more customization to your filter, as described below.
+
+### Operator filter
+
+Tests if an entity state correspond to the applied `operator`.
+
+{% configuration condition_operator %}
+value:
+ required: true
+ description: String representing the state.
+ type: string
+operator:
+ required: true
+ description: Operator to use in the comparison. Can be `==`, `<=`, `<`, `>=`, `>`, `!=`, `in`, `not in`, or `regex`.
+ type: string
+attribute:
+ required: false
+ description: Attribute of the entity to use instead of the state.
+ type: string
+{% endconfiguration %}
+
+#### Examples
+
+Displays everyone who is at home or at work.
```yaml
type: entity-filter
@@ -146,7 +371,7 @@ state_filter:
- operator: "=="
value: home
- operator: "=="
- value: work
+ value: work
card:
type: glance
title: Who's at work or home
@@ -173,19 +398,19 @@ entities:
Use a regex filter against entity attributes. This regex filter below looks for expressions that are 1 digit in length and where the number is between 0-7 (so show holidays today or in the next 7 days) and displays those holidays as entities in the Entity Filter card.
```yaml
- - type: entity-filter
- card:
- title: "Upcoming Holidays In Next 7 Days"
- show_header_toggle: false
- state_filter:
- - operator: regex
- value: "^([0-7]{1})$"
- attribute: eta
- entities:
- - entity: sensor.upcoming_ical_holidays_0
- - entity: sensor.upcoming_ical_holidays_1
- - entity: sensor.upcoming_ical_holidays_2
- - entity: sensor.upcoming_ical_holidays_3
- - entity: sensor.upcoming_ical_holidays_4
- show_empty: false
+type: entity-filter
+card:
+ title: "Upcoming Holidays In Next 7 Days"
+ show_header_toggle: false
+state_filter:
+ - operator: regex
+ value: "^([0-7]{1})$"
+ attribute: eta
+entities:
+ - entity: sensor.upcoming_ical_holidays_0
+ - entity: sensor.upcoming_ical_holidays_1
+ - entity: sensor.upcoming_ical_holidays_2
+ - entity: sensor.upcoming_ical_holidays_3
+ - entity: sensor.upcoming_ical_holidays_4
+show_empty: false
```
diff --git a/source/_dashboards/entity.markdown b/source/_dashboards/entity.markdown
index 4fabc9180938..12e77a61dacb 100644
--- a/source/_dashboards/entity.markdown
+++ b/source/_dashboards/entity.markdown
@@ -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/)
\ No newline at end of file
diff --git a/source/_dashboards/gauge.markdown b/source/_dashboards/gauge.markdown
index 6bacac009d5c..8ede3f1de0a6 100644
--- a/source/_dashboards/gauge.markdown
+++ b/source/_dashboards/gauge.markdown
@@ -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/)
\ No newline at end of file
diff --git a/source/_dashboards/glance.markdown b/source/_dashboards/glance.markdown
index 10c5b911e7c6..bdf2f0aa8c0d 100644
--- a/source/_dashboards/glance.markdown
+++ b/source/_dashboards/glance.markdown
@@ -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/)
\ No newline at end of file
diff --git a/source/_dashboards/grid.markdown b/source/_dashboards/grid.markdown
index b5a6229730bc..706f93d0a13b 100644
--- a/source/_dashboards/grid.markdown
+++ b/source/_dashboards/grid.markdown
@@ -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/)
\ No newline at end of file
diff --git a/source/_dashboards/history-graph.markdown b/source/_dashboards/history-graph.markdown
index df079a0d80b2..1ab062ad1386 100644
--- a/source/_dashboards/history-graph.markdown
+++ b/source/_dashboards/history-graph.markdown
@@ -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/)
\ No newline at end of file
diff --git a/source/_dashboards/horizontal-stack.markdown b/source/_dashboards/horizontal-stack.markdown
index eddc32f69d24..ed211f7782db 100644
--- a/source/_dashboards/horizontal-stack.markdown
+++ b/source/_dashboards/horizontal-stack.markdown
@@ -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:
Two picture cards in a horizontal stack card.
-
-## Related topics
-
-- [Dashboard cards](/dashboards/cards/)
\ No newline at end of file
diff --git a/source/_dashboards/humidifier.markdown b/source/_dashboards/humidifier.markdown
index 93b721febf93..759f74b357e1 100644
--- a/source/_dashboards/humidifier.markdown
+++ b/source/_dashboards/humidifier.markdown
@@ -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/)
diff --git a/source/_dashboards/iframe.markdown b/source/_dashboards/iframe.markdown
index d8a544e80b67..cec7c97b2e5d 100644
--- a/source/_dashboards/iframe.markdown
+++ b/source/_dashboards/iframe.markdown
@@ -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 `
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.
You can't embed sites using HTTP if you are using HTTPS for your Home Assistant.
@@ -56,7 +64,3 @@ type: iframe
url: https://www.home-assistant.io
aspect_ratio: 75%
```
-
-## Related topics
-
-- [Dashboard cards](/dashboards/cards/)
\ No newline at end of file
diff --git a/source/_dashboards/light.markdown b/source/_dashboards/light.markdown
index 7023f9def8d6..006bb3ccc827 100644
--- a/source/_dashboards/light.markdown
+++ b/source/_dashboards/light.markdown
@@ -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
Screenshot of the Light card names.
-
-## Related topics
-
-- [Card actions](/dashboards/actions/)
-- [Themes](/integrations/frontend/)
-- [Dashboard cards](/dashboards/cards/)
\ No newline at end of file
diff --git a/source/_dashboards/logbook.markdown b/source/_dashboards/logbook.markdown
index 2ae88343fac7..8f86938ebd3a 100644
--- a/source/_dashboards/logbook.markdown
+++ b/source/_dashboards/logbook.markdown
@@ -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/)
\ No newline at end of file
diff --git a/source/_dashboards/map.markdown b/source/_dashboards/map.markdown
index 9370e83431f9..dbb024b29799 100644
--- a/source/_dashboards/map.markdown
+++ b/source/_dashboards/map.markdown
@@ -3,9 +3,16 @@ 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
+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,8 +141,3 @@ entities:
focus: false
hours_to_show: 48
```
-
-## Related topics
-
-- [Themes](/integrations/frontend/)
-- [Dashboard cards](/dashboards/cards/)
\ No newline at end of file
diff --git a/source/_dashboards/markdown.markdown b/source/_dashboards/markdown.markdown
index bcac319e7c95..d6145a082b24 100644
--- a/source/_dashboards/markdown.markdown
+++ b/source/_dashboards/markdown.markdown
@@ -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: |
button.
+5. To add a section, select the **Create section** button.
+6. To edit the section title, select the button.
- If you leave the section title empty, this line will be hidden.
-6. To delete a section, select the 
button.
+7. To delete a section, select the 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)
\ No newline at end of file
diff --git a/source/_dashboards/sensor.markdown b/source/_dashboards/sensor.markdown
index c4196828d7e8..ae181701ce75 100644
--- a/source/_dashboards/sensor.markdown
+++ b/source/_dashboards/sensor.markdown
@@ -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/)
\ No newline at end of file
diff --git a/source/_dashboards/shopping-list.markdown b/source/_dashboards/shopping-list.markdown
index 882fed36a8a8..fd4061f68380 100644
--- a/source/_dashboards/shopping-list.markdown
+++ b/source/_dashboards/shopping-list.markdown
@@ -1,10 +1,16 @@
---
-type: card
title: "Shopping list card"
-sidebar_label: Shopping list
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.
+
The shopping list card allows you to add, edit, check-off, and clear items from your shopping list.
@@ -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/) \ No newline at end of file diff --git a/source/_dashboards/sidebar.markdown b/source/_dashboards/sidebar.markdown index 3c55ccccd4a7..47815a9e52d6 100644 --- a/source/_dashboards/sidebar.markdown +++ b/source/_dashboards/sidebar.markdown @@ -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/) \ No newline at end of file +``` \ No newline at end of file diff --git a/source/_dashboards/statistic.markdown b/source/_dashboards/statistic.markdown index e39895bae59c..e7d03df5ebf2 100644 --- a/source/_dashboards/statistic.markdown +++ b/source/_dashboards/statistic.markdown @@ -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/) \ No newline at end of file diff --git a/source/_dashboards/statistics-graph.markdown b/source/_dashboards/statistics-graph.markdown index 940059e3a207..52a69b301be9 100644 --- a/source/_dashboards/statistics-graph.markdown +++ b/source/_dashboards/statistics-graph.markdown @@ -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/) \ No newline at end of file diff --git a/source/_dashboards/thermostat.markdown b/source/_dashboards/thermostat.markdown index 5ca865065d83..240a89bbc80e 100644 --- a/source/_dashboards/thermostat.markdown +++ b/source/_dashboards/thermostat.markdown @@ -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/) diff --git a/source/_dashboards/tile.markdown b/source/_dashboards/tile.markdown index 514cfc144967..7dba42385ef7 100644 --- a/source/_dashboards/tile.markdown +++ b/source/_dashboards/tile.markdown @@ -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/) \ No newline at end of file diff --git a/source/_dashboards/todo-list.markdown b/source/_dashboards/todo-list.markdown new file mode 100644 index 000000000000..846d6cfd7f28 --- /dev/null +++ b/source/_dashboards/todo-list.markdown @@ -0,0 +1,74 @@ +--- +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. + +
+
+Screenshot of the to-do list card.
+
-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.
### 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.
@@ -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.
diff --git a/source/_docs/automation/trigger.markdown b/source/_docs/automation/trigger.markdown
index ae76aad53d6a..9f7dc28a1f19 100644
--- a/source/_docs/automation/trigger.markdown
+++ b/source/_docs/automation/trigger.markdown
@@ -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/).
@@ -294,8 +297,8 @@ Listing above and below together means the numeric_state has to be between the t
In the example above, the trigger would fire a single time if a numeric_state goes into the 17.1-24.9 range (above 17 and below 25). It will only fire again, once it has left the defined range and enters it again.
-Number helpers (`input_number` entities), `number` and `sensor` entities that
-contain a numeric value, can be used in the `above` and `below` thresholds,
+Number helpers (`input_number` entities), `number`, `sensor`, and `zone` entities
+that contain a numeric value, can be used in the `above` and `below` thresholds,
making the trigger more dynamic, like:
```yaml
diff --git a/source/_docs/blueprint.markdown b/source/_docs/blueprint.markdown
index c0e17ab71264..eb07e05191cc 100644
--- a/source/_docs/blueprint.markdown
+++ b/source/_docs/blueprint.markdown
@@ -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
\ No newline at end of file
+[blueprint-forums]: /get-blueprints
diff --git a/source/_docs/blueprint/schema.markdown b/source/_docs/blueprint/schema.markdown
index 3ff7baf3e278..c615423da5b8 100644
--- a/source/_docs/blueprint/schema.markdown
+++ b/source/_docs/blueprint/schema.markdown
@@ -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 »](/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
diff --git a/source/_docs/blueprint/selectors.markdown b/source/_docs/blueprint/selectors.markdown
index 4a9c030b790c..fb7419dc58e0 100644
--- a/source/_docs/blueprint/selectors.markdown
+++ b/source/_docs/blueprint/selectors.markdown
@@ -18,7 +18,6 @@ The following selectors are currently available:
- [Action selector](#action-selector)
- [Add-on selector](#add-on-selector)
- [Area selector](#area-selector)
- - [Example area selectors](#example-area-selectors)
- [Attribute selector](#attribute-selector)
- [Assist pipeline selector](#assist-pipeline-selector)
- [Backup location selector](#backup-location-selector)
@@ -32,23 +31,21 @@ The following selectors are currently available:
- [Date selector](#date-selector)
- [Date \& time selector](#date--time-selector)
- [Device selector](#device-selector)
- - [Example device selector](#example-device-selector)
- [Duration selector](#duration-selector)
- [Entity selector](#entity-selector)
- - [Example entity selector](#example-entity-selector)
+- [Floor selector](#floor-selector)
- [Icon selector](#icon-selector)
+- [Label selector](#label-selector)
- [Language selector](#language-selector)
- [Location selector](#location-selector)
- [Media selector](#media-selector)
- [Number selector](#number-selector)
- - [Example number selectors](#example-number-selectors)
- [Object selector](#object-selector)
- [QR code selector](#qr-code-selector)
- [RGB color selector](#rgb-color-selector)
- [Select selector](#select-selector)
- [State selector](#state-selector)
- [Target selector](#target-selector)
- - [Example target selectors](#example-target-selectors)
- [Template selector](#template-selector)
- [Text selector](#text-selector)
- [Theme selector](#theme-selector)
@@ -211,7 +208,7 @@ living_room
- kitchen
```
-### Example area selectors
+### Example area selectors
An example area selector only shows areas that provide one or more lights or
switches provided by the [ZHA](/integrations/zha) integration.
@@ -274,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
@@ -581,7 +578,7 @@ faadde5365842003e8ca55267fe9d1f4
- 3da77cb054352848b9544d40e19de562
```
-### Example device selector
+### Example device selector
An example entity selector that, will only show devices that are:
@@ -717,7 +714,7 @@ light.living_room
- light.kitchen
```
-### Example entity selector
+### Example entity selector
An example entity selector that, will only show entities that are:
@@ -737,6 +734,141 @@ entity:
device_class: motion
```
+## Floor selector
+
+The floor selector shows a floor finder that can pick
+floors based on the selector configuration. The value of the input will be the
+floor ID. If `multiple` is set to `true`, the value is a list of floor IDs.
+
+A floor selector can filter the list of floors based on the properties of the
+devices and entities assigned to the areas on those floors.
+For example, the floor list could be limited to floors with entities
+provided by the [ZHA](/integrations/zha) integration, based on the areas they are in.
+
+In its most basic form, this selector doesn't require any options.
+It will show all floors.
+
+
+
+```yaml
+floor:
+```
+
+{% configuration floor %}
+device:
+ description: >
+ When device options are provided, the list of floors is filtered by floors
+ that have at least one device matching the given conditions. Can be
+ either an object or a list of objects.
+ type: list
+ required: false
+ keys:
+ integration:
+ description: >
+ Can be set to an integration domain. Limits the list of floors that
+ have devices by this integration domain. For example,
+ [`zha`](/integrations/zha).
+ type: string
+ required: false
+ manufacturer:
+ description: >
+ When set, the list only includes floors that have devices by the set
+ manufacturer name.
+ type: string
+ required: false
+ model:
+ description: >
+ When set, the list only includes floors that have devices which have
+ the set model.
+ type: string
+ required: false
+entity:
+ description: >
+ When entity options are provided, the list only includes floors
+ that at least have one entity that matches the given conditions. Can be
+ either an object or a list of objects.
+ type: list
+ required: false
+ keys:
+ integration:
+ description: >
+ Can be set to an integration domain. Limits the list of floors that
+ have entities by the set integration domain. For example,
+ [`zha`](/integrations/zha).
+ type: string
+ required: false
+ domain:
+ description: >
+ When set, the list only includes floors that have entities of certain domains,
+ for example, [`light`](/integrations/light) or
+ [`binary_sensor`](/integrations/binary_sensor). Can be either a string
+ with a single domain, or a list of string domains to limit the selection to.
+ type: [string, list]
+ required: false
+ device_class:
+ description: >
+ When set, the list only includes floors that have entities with a certain
+ device class, for example, `motion` or `window`. Can be either a string
+ with a single device_class, or a list of string device_class to limit
+ the selection.
+ type: [device_class, list]
+ required: false
+ supported_features:
+ description: >
+ When set, the list only includes floors that have entities with a certain
+ supported feature, for example, `light.LightEntityFeature.TRANSITION`
+ or `climate.ClimateEntityFeature.TARGET_TEMPERATURE`. Should be a list
+ of features.
+ type: list
+ required: false
+multiple:
+ description: >
+ Allows selecting multiple floors. If set to `true`, the resulting value of
+ this selector will be a list instead of a single string value.
+ type: boolean
+ default: false
+ required: false
+{% endconfiguration %}
+
+The output of this selector is the floor ID, or (in case `multiple` is set to
+`true`) a list of floor IDs.
+
+```yaml
+# Example floor selector output result, when multiple is set to false
+first_floor
+
+# Example floor selector output result, when multiple is set to true
+- first_floor
+- second_floor
+```
+
+### Example floor selectors
+
+An example floor selector only shows floors that have one or more lights or
+switches provided by the [ZHA](/integrations/zha) integration.
+
+```yaml
+floor:
+ entity:
+ integration: zha
+ domain:
+ - light
+ - switch
+```
+
+Another example using the floor selector, which only shows floors that
+have one or more remote controls provided by the [deCONZ](/integrations/deconz)
+integration. Multiple floors can be selected.
+
+```yaml
+floor:
+ multiple: true
+ device:
+ - integration: deconz
+ manufacturer: IKEA of Sweden
+ model: TRADFRI remote control
+```
+
## Icon selector
The icon selector shows an icon picker that allows the user to select an icon.
@@ -755,6 +887,43 @@ placeholder:
The output of this selector is a string containing the selected icon,
for example: `mdi:bell`.
+## Label selector
+
+The label selector shows a label finder that can pick labels. The value of the
+input is the label ID. If `multiple` is set to `true`, the value is a list
+of label IDs.
+
+
+
+In its most basic form, this selector doesn't require any options.
+It will show all labels.
+
+```yaml
+label:
+```
+
+{% configuration text %}
+multiple:
+ description: >
+ Allows selecting multiple labels. If set to `true`, the resulting value of
+ this selector will be a list instead of a single string value.
+ type: boolean
+ default: false
+ required: false
+{% endconfiguration %}
+
+The output of this selector is the label ID, or (in case `multiple` is set to
+`true`) a list of label IDs.
+
+```yaml
+# Example label selector output result, when multiple is set to false
+energy_saving
+
+# Example label selector output result, when multiple is set to true
+- energy_saving
+- christmas_decorations
+```
+
## Language selector
The language selector allows a user to pick a language from a list of languages.
@@ -910,7 +1079,7 @@ mode:
The output of this selector is a number, for example: `42`
-### Example number selectors
+### Example number selectors
An example number selector that allows a user a percentage, directly in a
regular number input box.
@@ -1209,7 +1378,7 @@ action:
-### Example target selectors
+### Example target selectors
An example target selector that only shows targets that at least provide one
or more lights, provided by the [ZHA](/integrations/zha) integration.
diff --git a/source/_docs/blueprint/tutorial.markdown b/source/_docs/blueprint/tutorial.markdown
index 5dd5c86ba584..98908e5f51ec 100644
--- a/source/_docs/blueprint/tutorial.markdown
+++ b/source/_docs/blueprint/tutorial.markdown
@@ -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
---
@@ -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/)
diff --git a/source/_docs/configuration.markdown b/source/_docs/configuration.markdown
index b02e1a6e379c..ade0f779d0a9 100644
--- a/source/_docs/configuration.markdown
+++ b/source/_docs/configuration.markdown
@@ -1,45 +1,90 @@
---
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/docs/tools/dev-tools/#reloading-the-yaml-configuration
+ title: Creating backups for Home Assistant Container and Core
+ - docs: /docs/tools/dev-tools/#reloading-the-yaml-configuration
+ title: Reloading the YAML configuration from developer tools
+ - docs: /common-tasks/os/#configuring-access-to-files
+ title: Configuring file access on the Operating System
+ - docs: /common-tasks/supervised/#configuring-access-to-files
+ title: Configuring file access on Supervised
+ - docs: docs/configuration/troubleshooting/
+ title: Troubleshooting the configuration
---
-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.
+While you can configure most of Home Assistant from the user interface, for some integrations, you need to edit the `configuration.yaml` file. 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.
-If you run into trouble while configuring Home Assistant, refer to the [configuration troubleshooting page](/docs/configuration/troubleshooting/) and the [`configuration.yaml` examples](/examples/#example-configurationyaml).
+
+
+## Labels
+
+- Can be assigned to areas, devices, entities, automations, scenes, scripts, and helpers.
+- Can be used in automations and scripts as a target for actions and services.
+- Labels can also be used to filter data in tables. 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.
+
+
+
+## Category
+
+- Groups items in a table.
+- Categories are unique for each table. The automations page can have different categories than the scene, scripts, or helpers settings page.
+
+
diff --git a/source/_docs/organizing/areas.markdown b/source/_docs/organizing/areas.markdown
new file mode 100644
index 000000000000..9b132256f525
--- /dev/null
+++ b/source/_docs/organizing/areas.markdown
@@ -0,0 +1,46 @@
+---
+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.
+Areas can be assigned to floors. Areas can also be used to automatically generate cards, such as the [Area card](/dashboards/area/).
+
+## Creating an area
+
+Follow these steps to create a new area from the **Areas** view.
+
+1. Go to {% my areas title="**Settings** > **Areas, labels & zones**" %} and select **Create area**.
+2. In the dialog, enter the area details:
+ - Give the area a **Name** (required).
+ - Add an icon (We use [Material icons](https://pictogrammers.com/library/mdi/)).
+ - Assign the area to a floor.
+ - If you have not created floors yet, you can [create a new one](/docs/organizing/floors/#creating-a-floor).
+ - The number can be negative. For example for underground floors.
+ - This number can later be used for sorting.
+ - Add an image representing that area.
+ - Add an **Alias**.
+ - Aliases are alternative names used in [voice assistants](/voice_control/aliases/) to refer to an area, entity, or floor.
+
+ 
+3. Select **Add**.
+
+ **Result**: A new area is created.
+
+## Assigning areas to floors and add labels
+
+If an area has not yet been assigned to a floor, it is shown in the **Unassigned areas** section. Follow these steps to assign an area to a floor.
+
+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.
diff --git a/source/_docs/organizing/categories.markdown b/source/_docs/organizing/categories.markdown
new file mode 100644
index 000000000000..261332fbc02c
--- /dev/null
+++ b/source/_docs/organizing/categories.markdown
@@ -0,0 +1,56 @@
+---
+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.
+
+## Creating a category
+
+Follow these steps to create a new category.
+
+1. Go to {% my automations title="**Settings** > **Automations & Scenes**" %} and open the respective tab.
+2. In the top left, select the **Filters** button.
+
+ 
+3. Select **Category**, then **Add category**.
+4. Enter a name, select an icon and select **Add**.
+
+ **Result**: A new category is created.
+
+## Assigning a category
+
+1. Go to {% my automations title="**Settings** > **Automations & Scenes**" %} and open the respective tab.
+2. To assign a category to a single item:
+ - Find the item in the list and select the three dots menu.
+ - Select **Assign category** and select the category from the list.
+ - If the category is not in the list, select **Add new category** and make a new one.
+3. To assign a category to multiple items:
+ - Select the 
button.
+ - From the list, select all the items to which you want to apply a 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.
+
+ 
+
+## Editing or deleting a category
+
+To rename or delete a category, follow these steps:
+
+1. Go to {% my automations title="**Settings** > **Automations & Scenes**" %} and open the respective tab.
+2. In the top left, select the **Filters** button.
+
+ 
+3. In the list, find the category you want to edit and select the three dot menu next to it.
+4. Select **Edit category** or **Delete category**.
+
+ 
diff --git a/source/_docs/organizing/filtering.markdown b/source/_docs/organizing/filtering.markdown
new file mode 100644
index 000000000000..97aea10bfbfe
--- /dev/null
+++ b/source/_docs/organizing/filtering.markdown
@@ -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 button.
+
+ 
+
+2. In the list, select the items of interest.
+
+ 
+
+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.
+
+ 
+
+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.
+
+ 
+
+## 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.
+
+ 
+
+3. To sort the items, select the **Sort by** button.
diff --git a/source/_docs/organizing/floors.markdown b/source/_docs/organizing/floors.markdown
new file mode 100644
index 000000000000..d4db0cb84cf8
--- /dev/null
+++ b/source/_docs/organizing/floors.markdown
@@ -0,0 +1,39 @@
+---
+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
+cannot be assigned to floors directly 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.
+
+## Creating a floor
+
+Follow these steps to create a new floor.
+
+1. Go to {% my areas title="**Settings** > **Areas, labels & zones**" %} and select **Create floor**.
+2. In the dialog, enter the floor details:
+ - Give the floor a **Name** (required).
+ - Add a floor **Level**.
+ - The number can be negative. For example for underground floors.
+ - This number can later be used for sorting.
+ - Add an icon (We use [Material icons](https://pictogrammers.com/library/mdi/)).
+ - Add an **Alias**.
+ - Aliases are alternative names used in [voice assistants](/voice_control/aliases/) to refer to an entity, area, or floor.
+
+ 
+3. Select **Add**.
+
+ **Result**: A new floor is created.
+
+ 
+4. You can now [assign areas to that floor](/docs/organizing/areas/#assigning-areas-to-floors-and-add-labels).
diff --git a/source/_docs/organizing/labels.markdown b/source/_docs/organizing/labels.markdown
new file mode 100644
index 000000000000..0e95e8dc515b
--- /dev/null
+++ b/source/_docs/organizing/labels.markdown
@@ -0,0 +1,73 @@
+---
+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.
+
+## Creating a label
+
+Follow these steps to create a new label from the **Labels** view.
+
+1. Go to {% my labels title="**Settings** > **Areas, labels & zones**" %} and on top, select the **Labels** tab.
+2. Select the **Create label** button.
+3. In the dialog, enter the label details:
+ - Give the label a **Name** (required).
+ - Add an icon (We use [Material icons](https://pictogrammers.com/library/mdi/)).
+ - Add a **Color**.
+
+ 
+4. Select **Create**.
+
+ **Result**: A new label is created.
+
+## Applying labels
+
+Follow these steps to apply a label
+
+1. To apply a label to an area:
+ - Go to {% my areas title="**Settings** > **Areas, labels & zones**" %}.
+ - On the area card, select the pencil icon.
+ - Select one or more labels or select **Add new label** to create a new one.
+2. To apply a label to a device, entity, or helper:
+ - Go to **{% my integrations title="Settings > Devices & Services" %}** and open the respective tab.
+ - Select the button.
+ - From the list, select all the list entries to which you want to apply a label.
+ - In the top right corner, select **Add label**. Then, select the labels from the list.
+
+ 
+3. To apply a label to an automation, scene, or script:
+ - Go to {% my automations title="**Settings** > **Automations & Scenes**" %} and open the respective tab.
+ - Select the button.
+ - From the list, select all the list entries 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.
+
+## Deleting a label
+
+Follow these steps to delete a label. It will be removed from all the list entries it was applied to.
+If you used this label in automations or script as targets, you need to adjust those.
+
+1. Go to {% my labels title="**Settings** > **Areas, labels & zones**" %} and on top, select the **Labels** tab.
+2. In the list of labels, find the label you want to delete and select the three dots menu.
+3. Select **Delete**.
+4. If you used this label in automations or script as targets, you need to adjust those.
+
+## Removing labels
+
+1. Go to the data table that contains the element from which you want to remove the label:
+ - Go to **{% my integrations title="Settings > Devices & Services" %}** and open the respective tab.
+ - Or, go to {% my automations title="**Settings** > **Automations & Scenes**" %} and open the respective tab.
+2. Select the button.
+ - From the list, select all the items from which you want to remove a label.
+ - In the top right corner, select the three dots menu, then select **Add label**.
+ - Then, deselect the checkbox for the label you want to remove.
+
diff --git a/source/_docs/scripts/conditions.markdown b/source/_docs/scripts/conditions.markdown
index 71529b270f58..2860510c95a3 100644
--- a/source/_docs/scripts/conditions.markdown
+++ b/source/_docs/scripts/conditions.markdown
@@ -218,8 +218,8 @@ condition:
below: 25
```
-Number helpers (`input_number` entities), `number` and `sensor` entities that
-contain a numeric value, can be used in the `above` and `below`
+Number helpers (`input_number` entities), `number`, `sensor`, and `zone` entities
+that contain a numeric value, can be used in the `above` and `below`
options to make the condition more dynamic.
```yaml
diff --git a/source/_docs/scripts/service-calls.markdown b/source/_docs/scripts/service-calls.markdown
index d94130181ee9..ccd734c536cf 100644
--- a/source/_docs/scripts/service-calls.markdown
+++ b/source/_docs/scripts/service-calls.markdown
@@ -80,7 +80,7 @@ entity_id: switch.ac
### Using the Services Developer Tool
You can use the Services Developer Tool to test data to pass in a service call.
-For example, you may test turning on or off a 'group' (See [groups] for more info)
+For example, you may test turning on or off a 'group' (See [groups](/integrations/group/) for more info)
To turn a group on or off, pass the following info:
diff --git a/source/_docs/tools/check_config.markdown b/source/_docs/tools/check_config.markdown
index 245922939132..4a805d672cd0 100644
--- a/source/_docs/tools/check_config.markdown
+++ b/source/_docs/tools/check_config.markdown
@@ -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
diff --git a/source/_docs/tools/dev-tools.markdown b/source/_docs/tools/dev-tools.markdown
index 627fac764f47..f33111825d3e 100644
--- a/source/_docs/tools/dev-tools.markdown
+++ b/source/_docs/tools/dev-tools.markdown
@@ -10,8 +10,8 @@ The dashboard contains a section called **Developer tools**.
Screenshot of Home Assistant's developer tools.
-| Section |Description |
-| ---------- |---------------------------------------------------------------------|
+| Section | Description |
+| ---------- | ------------------------------------------------------------------- |
| YAML | Lets you validate the configuration and trigger a reload or restart |
| States | Sets the representation of an entity |
| Services | Calls services from integrations |
@@ -24,7 +24,27 @@ Screenshot of Home Assistant's developer tools.
The Developer Tools is meant for **all** (not just for the developers) to quickly try out things - like calling services, updating states, raising events, and publishing messages in MQTT). It is also a necessary tool for those who write custom automations and scripts by hand. The following describes each of the sections in detail.
-## States
+## YAML tab
+
+The YAML tab provides buttons to trigger a check of configuration files and to reload the configuration. Reloading is needed to apply changes that you've made to the configuration.
+
+It is almost the same as the option under **Settings** > three dot menu (top right) > **Restart Home Assistant** > **Quick reload**. The only difference is that **Quick reload** reloads all the configuration, whereas this YAML tab allows you to only reload one specific configuration at a time.
+
+### Reloading the YAML configuration
+
+For configuration changes to become effective, the configuration must be reloaded. Most integrations in Home Assistant (that do not interact with {% term devices %} or {% term services %}) can reload changes made to their configuration in `configuration.yaml` without needing to restart Home Assistant.
+
+1. Go to {% my server_controls title="**Developer Tools** > **YAML**" %} and scroll down to the YAML configuration reloading section (alternatively, hit ["c"](/docs/tools/quick-bar/) anywhere in the UI and search for "reload").
+ - You are presented with a list of integrations, such as **Automations** or **Conversation**.
+
+ 
+
+2. Depending on what you find in the list, you can proceed with either reloading or you need to restart Home Assistant:
+ - If the integration is listed, select it to reload the settings.
+ - For example, if you've changed the [General settings](/docs/configuration/basic/), you can select **Location & customizations** to apply those changes.
+ - If the integration is not listed, you need to **Restart** Home Assistant for changes to take effect.
+
+## States tab
This section shows all the available entities, their corresponding state and the attribute values. The state and the attribute information is what Home Assistant sees at run time. To update the entity with a new state, or a new attribute value, click on the entity, scroll to the top, and modify the values, and click on “SET STATE” button.
@@ -35,7 +55,7 @@ For example, changing the `light.bedroom` state from `off` to `on` does not turn
The table containing all entities can be filtered for each column. The used search is a wildcard search meaning that if you input "office" in the entity column filter, every entity whose ID matches "\*office\*" will be shown. You can also add your own wildcards in the search input (e.g., "office\*light").
The attribute filter supports separate filters for attribute names and values, separated by a colon ":". So the filter "location:3" will result in the table showing all entities that have an attribute name that contains "location" and whose attribute value contains "3".
-## Services
+## Services tab
This section is used to call Services that are available in the ServiceRegistry.
@@ -48,6 +68,7 @@ A Service may also require additional input to be passed. It is commonly referre
When an entity is selected from the Entity dropdown, it automatically populates service data with the corresponding `entity_id`. The service data YAML can then be modified to pass additional \[optional\] parameters. The following is an illustration on how to call a `light.turn_on` service.
To turn on a light bulb, use the following steps:
+
1. Select `light.turn_on` from the Service dropdown
2. Select the entity (typically the light bulb) from the Entity dropdown (if no entity_id is selected, it turns on ALL lights)
3. If an entity is selected, the service data is populated with basic YAML that will be passed to the service. Additional data can also be passed by updating the YAML as below.
@@ -58,7 +79,7 @@ brightness: 255
rgb_color: [255, 0, 0]
```
-## Template editor
+## Template editor tab
The template editor provides a way to quickly test templates prior to placing them into automations and scripts. A code editor is on the left side and your real-time output is displayed in the preview on the right side.
@@ -66,7 +87,7 @@ By default, this will contain sample code that illustrates how templates can be
For more information about Jinja2, visit [Jinja2 documentation](https://jinja.palletsprojects.com/en/latest/templates/), and also read templating document [here](/docs/configuration/templating).
-## Events
+## Events tab
In the Events section, you can either fire an event on the event bus or subscribe to an event type in order to view the event data JSON.
@@ -118,7 +139,7 @@ Event 0 fired 9:53 AM:
}
```
-## Statistics
+## Statistics tab
The **Statistics** tab shows a list of long-term statistic entities. If the long term statistics is not working for an entity, a **Fix Issue** link is shown. Select it to view a description of the issue. There might also be an option to fix the issue.
@@ -130,15 +151,16 @@ icon. Use date & time to search for the incorrect data point and adjust the valu
-## Assist
+## Assist tab
The **Assist** tab lets you see how Home Assistant's Assist processes a sentence.
If no matching intent is found, then Assist is unable to interpret the sentence. If a matching intent was found, information is provided on the action that will be performed on which entities. The example below shows how the following sentence was parsed: *what lights are on in the office*.
+
- Assist found a matching intent: *HassGetState*.
- It found entities matching the domain: *lights*.
- The lights have the state *on*.
-- The lights are in the area *office*.
+- The lights are in the area *office*.
- The targets are the narrowed-down entities in scope.
diff --git a/source/_docs/troubleshooting_general.markdown b/source/_docs/troubleshooting_general.markdown
index e50d69b8245f..9180465edbd0 100644
--- a/source/_docs/troubleshooting_general.markdown
+++ b/source/_docs/troubleshooting_general.markdown
@@ -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/)
\ No newline at end of file
diff --git a/source/_docs/z-wave/controllers.markdown b/source/_docs/z-wave/controllers.markdown
index 6f38d7184bae..b5f007108087 100644
--- a/source/_docs/z-wave/controllers.markdown
+++ b/source/_docs/z-wave/controllers.markdown
@@ -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
diff --git a/source/_includes/asides/docs_navigation.html b/source/_includes/asides/docs_navigation.html
index ab4d2de18439..5e7aa5c9a9f2 100644
--- a/source/_includes/asides/docs_navigation.html
+++ b/source/_includes/asides/docs_navigation.html
@@ -24,9 +24,17 @@
- {% active_link /docs/configuration/ Configuration.yaml %}
+ {% active_link /docs/frontend/ Frontend %}
+
+ Configuration
+
-
- {% active_link /docs/frontend/ Frontend %}
-
{% active_link /docs/backend/ Backend %}
-
+
\ No newline at end of file
diff --git a/source/_includes/asides/organizing_navigation.html b/source/_includes/asides/organizing_navigation.html
new file mode 100644
index 000000000000..1b6b2225de3b
--- /dev/null
+++ b/source/_includes/asides/organizing_navigation.html
@@ -0,0 +1,21 @@
+
+
+Example of a configuration.yaml file, accessed using the File editor add-on on a Home Assistant Operating System installation.
+
+The method for running a configuration check depends on your [installation type](/installation/#advanced-installation-methods). Check the common tasks for your installation type:
- 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" %}.
+- [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)
-
+## Reloading the configuration to apply changes
-## Migrating to a new system
+For configuration changes to become effective, the configuration must be reloaded. Most integrations in Home Assistant (that do not interact with {% term devices %} or {% term services %}) can reload changes made to their configuration in `configuration.yaml` without needing to restart Home Assistant.
-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.
+1. Under **Settings**, select the three dots menu (top right), select **Restart Home Assistant** > **Quick reload**.
-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.
+ 
+
+2. If you find that your changes were not applied, you need to restart.
+ - Select **Restart Home Assistant**.
+ - Note: This interrupts automations and scripts.
+
+ 
+
+## Troubleshooting the configuration
+
+If you run into trouble while configuring Home Assistant, refer to the [configuration troubleshooting page](/docs/configuration/troubleshooting/) and the [`configuration.yaml` examples](/examples/#example-configurationyaml).
\ No newline at end of file
diff --git a/source/_docs/configuration/basic.markdown b/source/_docs/configuration/basic.markdown
index 5fc503984b87..afac72742f32 100644
--- a/source/_docs/configuration/basic.markdown
+++ b/source/_docs/configuration/basic.markdown
@@ -1,117 +1,32 @@
---
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`:
+
+ 
+ Screenshot showing the General settings page.
+
+## Editing the general settings
- 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" %}.
+To change the general settings that were defined during onboarding, follow these steps:
-
+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/).
-{% 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 %}
+ 
-## 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" %}.
+5. To apply the changes, follow the steps on [reloading the configuration](/docs/configuration/#reloading-configuration-changes).
diff --git a/source/_docs/configuration/customizing-devices.markdown b/source/_docs/configuration/customizing-devices.markdown
index e289cdc10e8a..6a2d8e64db82 100644
--- a/source/_docs/configuration/customizing-devices.markdown
+++ b/source/_docs/configuration/customizing-devices.markdown
@@ -1,129 +1,33 @@
---
title: "Customizing entities"
description: "Simple customization for entities."
+related:
+ - docs: /integrations/homeassistant/
+ - docs: /docs/configuration/
+ title: Home Assistant Core integration documentation
---
-## Changing the entity ID
+## Changing entity name and entity ID
-You can use the UI to change the entity ID and friendly name of supported entities. To do this:
+After adding a new device, the entity may not have a name and the automatically assigned entity ID might look very technical. If you like, you can use your own naming concept for devices.
-1. Select the {% term entity %}, either from the frontend or by selecting the info button next to the entity in the Developer Tools "States" tab.
-2. Select the cog icon in the right corner of the entity's dialog
-
-3. Enter the new name or the new entity ID (remember not to change the domain of the entity - the part before the `.`)
-
-4. Select *Update*
+To change the entity ID and friendly name of supported entities, follow these steps:
-If your entity is not supported, or you cannot customize what you need via this method, please see below for more options.
+1. Go to {% my entities title="**Settings** > **Devices & services** > **Entities**" %} and select the entity from the list.
+2. In the top right corner, select the cog icon.
-## Customizing entities
+ 
-By default, all of your devices will be visible and have a default icon determined by their domain. You can customize the look and feel of your front page by altering some of these parameters. This can be done by overriding attributes of specific entities.
+3. Enter the new name or the new entity ID.
+ - For example, the entity ID here could be `light.bedroom_ligthstrip`.
+ - Do not change the domain of the entity - the part before the `.`.
-### Possible values
+ 
-{% configuration customize %}
-friendly_name:
- description: Name of the entity as displayed in the UI.
- required: false
- type: string
-entity_picture:
- description: URL to use as picture for entity.
- required: false
- type: string
-icon:
- description: "Any icon from [Material Design Icons](https://pictogrammers.com/library/mdi/). Prefix name with `mdi:`, ie `mdi:home`. Note: Newer icons may not yet be available in the current Home Assistant release."
- required: false
- type: string
-assumed_state:
- description: For switches with an assumed state two buttons are shown (turn off, turn on) instead of a switch. By setting `assumed_state` to `false` you will get the default switch icon.
- required: false
- type: boolean
- default: true
-device_class:
- description: Sets the class of the device, changing the device state and icon that is displayed on the UI (see below). It does not set the `unit_of_measurement`.
- required: false
- type: device_class
- default: None
-unit_of_measurement:
- description: Defines the units of measurement, if any. This will also influence the graphical presentation in the history visualization as continuous value. Sensors with missing `unit_of_measurement` are showing as discrete values.
- required: false
- type: string
- default: None
-initial_state:
- description: Sets the initial state for automations, `on` or `off`.
- required: false
- type: boolean
- default: None
-{% endconfiguration %}
+4. Select **Update**.
+5. If you have used this entity in automations and scripts, you need to rename the entity ID there, too.
+ - Go to {% my automations title="**Settings** > **Automations & Scenes**" %} open the respective tab and find your automation or script.
-### Device class
+ 
-Device class is currently supported by the following platforms:
-
-- [Binary sensor](/integrations/binary_sensor/)
-- [Button](/integrations/button/)
-- [Cover](/integrations/cover/)
-- [Humidifier](/integrations/humidifier/)
-- [Media player](/integrations/media_player/)
-- [Number](/integrations/number/)
-- [Sensor](/integrations/sensor/)
-- [Switch](/integrations/switch/)
-
-### Manual customization
-
-
-
-If you implement `customize`, `customize_domain`, or `customize_glob` you must make sure it is done inside of `homeassistant:` or it will fail.
-
-
-
-```yaml
-homeassistant:
- name: Home
- unit_system: metric
- # etc
-
- customize:
- # Add an entry for each entity that you want to overwrite.
- thermostat.family_room:
- entity_picture: https://example.com/images/nest.jpg
- friendly_name: Nest
- switch.wemo_switch_1:
- friendly_name: Toaster
- entity_picture: /local/toaster.jpg
- switch.wemo_switch_2:
- friendly_name: Kitchen kettle
- icon: mdi:kettle
- switch.rfxtrx_switch:
- assumed_state: false
- media_player.my_media_player:
- source_list:
- - Channel/input from my available sources
- # Customize all entities in a domain
- customize_domain:
- light:
- icon: mdi:home
- automation:
- initial_state: "on"
- # Customize entities matching a pattern
- customize_glob:
- "light.kitchen_*":
- icon: mdi:description
- "scene.month_*_colors":
- icon: mdi:other
-```
-
-### Reloading customize
-
-Home Assistant offers a service to reload the core configuration while Home Assistant is running. This allows you to change your customize section and see your changes being applied without having to restart Home Assistant.
-
-To reload customizations, navigate to Developer Tools > YAML and then press the "Reload Location & Customizations" button. If you don't see this, enable Advanced Mode on your user profile page first.
-
-You can also use the [Quick bar](/docs/tools/quick-bar/#command-palette), and choose "Reload Location & Customizations".
-
-Alternatively, you can reload via service call. Navigate to Developer Tools > Services tab, select `homeassistant.reload_core_config` from the dropdown and press the "Call Service" button.
-
-
-New customize information will be applied the next time the state of the entity gets updated.
-
+If your entity is not supported, or you cannot customize what you need via this method, you need to edit the settings in your [`configuration.yaml` file](/docs/configuration/). For a detailed description of the entity configuration variables and device class information, refer to the [Home Assistant Core integration documentation](/integrations/homeassistant/).
diff --git a/source/_docs/configuration/secrets.markdown b/source/_docs/configuration/secrets.markdown
index df67cfd84302..559f1ff4dc20 100644
--- a/source/_docs/configuration/secrets.markdown
+++ b/source/_docs/configuration/secrets.markdown
@@ -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`:
diff --git a/source/_docs/configuration/splitting_configuration.markdown b/source/_docs/configuration/splitting_configuration.markdown
index 59cf7fec3c0d..c4f459b03dd6 100644
--- a/source/_docs/configuration/splitting_configuration.markdown
+++ b/source/_docs/configuration/splitting_configuration.markdown
@@ -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)
\ No newline at end of file
diff --git a/source/_docs/configuration/state_object.markdown b/source/_docs/configuration/state_object.markdown
index 346d98224aad..4736c0da719d 100644
--- a/source/_docs/configuration/state_object.markdown
+++ b/source/_docs/configuration/state_object.markdown
@@ -16,8 +16,9 @@ All states will always have an entity id, a state and a timestamp when last upda
| `state.domain` | Domain of the entity. Example: `light`. |
| `state.object_id` | Object ID of entity. Example: `kitchen`. |
| `state.name` | Name of the entity. Based on `friendly_name` attribute with fall back to object ID. Example: `Kitchen Ceiling`. |
-| `state.last_updated` | Time the state was written to the state machine in UTC time. Note that writing the exact same state including attributes will not result in this field being updated. Example: `2017-10-28 08:13:36.715874+00:00`. |
-| `state.last_changed` | Time the state changed in the state machine in UTC time. This is not updated when there are only updated attributes. Example: `2017-10-28 08:13:36.715874+00:00`. |
+| `state.last_changed` | Time the state changed in the state machine in UTC time. This is not updated if only state attributes change. Example: `2017-10-28 08:13:36.715874+00:00`. |
+| `state.last_reported`| Time the state was written to the state machine in UTC time. This timestamp is updated regardless of any change to the state or a state attribute. Example: `2017-10-28 08:13:36.715874+00:00`. |
+| `state.last_updated` | Time the state or state attributes changed in the state machine in UTC time. This is not updated if neither state nor state attributes changed. Example: `2017-10-28 08:13:36.715874+00:00`. |
| `state.attributes` | A dictionary with extra attributes related to the current state. |
| `state.context` | A dictionary with extra attributes related to the context of the state. |
diff --git a/source/_docs/configuration/templating.markdown b/source/_docs/configuration/templating.markdown
index 21e11ffcdee2..ec6c535fe9cf 100644
--- a/source/_docs/configuration/templating.markdown
+++ b/source/_docs/configuration/templating.markdown
@@ -458,6 +458,51 @@ The same thing can also be expressed as a test:
{% endraw %}
+### Floors
+
+- `floors()` returns the full list of floor IDs.
+- `floor_id(lookup_value)` returns the floor ID for a given device ID, entity ID, area ID, or area name. Can also be used as a filter.
+- `floor_name(lookup_value)` returns the floor name for a given device ID, entity ID, area ID, or floor ID. Can also be used as a filter.
+- `floor_areas(floor_name_or_id)` returns the list of area IDs tied to a given floor ID or name. Can also be used as a filter.
+
+#### Floors examples
+
+{% raw %}
+
+```text
+{{ floors() }} # ['floor_id']
+```
+
+```text
+{{ floor_id('First floor') }} # 'first_floor'
+```
+
+```text
+{{ floor_id('my_device_id') }} # 'second_floor'
+```
+
+```text
+{{ floor_id('sensor.sony') }} # 'first_floor'
+```
+
+```text
+{{ floor_name('first_floor') }} # 'First floor'
+```
+
+```text
+{{ floor_name('my_device_id') }} # 'Second floor'
+```
+
+```text
+{{ floor_name('sensor.sony') }} # 'First floor'
+```
+
+```text
+{{ floor_areas('first_floor') }} # ['living_room', 'kitchen']
+```
+
+{% endraw %}
+
### Areas
- `areas()` returns the full list of area IDs
@@ -508,10 +553,12 @@ The same thing can also be expressed as a test:
{% endraw %}
-### Integrations
+### Entities for an integration
- `integration_entities(integration)` returns a list of entities that are associated with a given integration, such as `hue` or `zwave_js`.
-- `integration_entities(title)` if you have multiple instances set-up for an integration, you can also use the title you've set for the integration in case you only want to target a specific device bridge.
+- `integration_entities(config_entry_title)` if you have multiple entries set-up for an integration, you can also use the title you've set for the integration in case you only want to target a specific entry.
+
+If there is more than one entry with the same title, the entities for all the matching entries will be returned, even if the entries are for different integrations. It's not possible to search for entities of an untitled integration.
#### Integrations examples
@@ -527,6 +574,78 @@ The same thing can also be expressed as a test:
{% endraw %}
+### Labels
+
+- `labels()` returns the full list of label IDs, or those for a given area ID, device ID, or entity ID.
+- `label_id(lookup_value)` returns the label ID for a given label name.
+- `label_name(lookup_value)` returns the label name for a given label ID.
+- `label_areas(label_name_or_id)` returns the list of area IDs tied to a given label ID or name.
+- `label_devices(label_name_or_id)` returns the list of device IDs tied to a given label ID or name.
+- `label_entities(label_name_or_id)` returns the list of entity IDs tied to a given label ID or name.
+
+Each of the label template functions can also be used as a filter.
+
+#### Labels examples
+
+{% raw %}
+
+```text
+{{ labels() }} # ['christmas_decorations', 'energy_saver', 'security']
+```
+
+```text
+{{ labels("living_room") }} # ['christmas_decorations', 'energy_saver']
+```
+
+```text
+{{ labels("my_device_id") }} # ['security']
+```
+
+```text
+{{ labels("light.christmas_tree") }} # ['christmas_decorations']
+```
+
+```text
+{{ label_id('Energy saver') }} # 'energy_saver'
+```
+
+```text
+{{ label_name('energy_saver') }} # 'Energy saver'
+```
+
+```text
+{{ label_areas('security') }} # ['driveway', 'garden', 'porch']
+```
+
+```text
+{{ label_devices('energy_saver') }} # ['deadbeefdeadbeefdeadbeefdeadbeef']
+```
+
+```text
+{{ label_entities('security') }} # ['camera.driveway', 'binary_sensor.motion_garden', 'camera.porch']
+```
+
+{% endraw %}
+
+### Issues
+
+- `issues()` returns all open issues as a mapping of (domain, issue_id) tuples to the issue object.
+- `issue(domain, issue_id)` returns a specific issue for the provided domain and issue_id.
+
+#### Issues examples
+
+{% raw %}
+
+```text
+{{ issues() }} # { ("homeassistant", "deprecated_yaml_ping"): {...}, ("cloud", "legacy_subscription"): {...} }
+```
+
+```text
+{{ issue('homeassistant', 'python_version') }} # {"breaks_in_ha_version": "2024.4", "domain": "homeassistant", "issue_id": "python_version", "is_persistent": False, ...}
+```
+
+{% endraw %}
+
### Immediate if (iif)
A common case is to conditionally return a value based on another value.
diff --git a/source/_docs/configuration/yaml.markdown b/source/_docs/configuration/yaml.markdown
index 6cd475272897..bbc31bf9c0cc 100644
--- a/source/_docs/configuration/yaml.markdown
+++ b/source/_docs/configuration/yaml.markdown
@@ -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).
-
-
-
-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.
+## Comments
-
+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.
-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)
diff --git a/source/_docs/energy/gas.markdown b/source/_docs/energy/gas.markdown
index ae0f109e8345..ec9b6ebbf106 100644
--- a/source/_docs/energy/gas.markdown
+++ b/source/_docs/energy/gas.markdown
@@ -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).
diff --git a/source/_docs/energy/water.markdown b/source/_docs/energy/water.markdown
index 699530796bae..a37d5ab79144 100644
--- a/source/_docs/energy/water.markdown
+++ b/source/_docs/energy/water.markdown
@@ -44,6 +44,10 @@ If your water meter lacks a rotary disk, magnetic disk, or coil. There are alter
- [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., `Gallons Per Minute` (gal/min), and `Gallons to Recharge` (gal):
+
+- [cullAssistant](https://github.com/LelandSindt/cullAssistant) (ESPHome)
+
Alternatively, the following shops sell ESPHome-based devices that use a 3-phase light sensor to detect a rotating disk in your water meter and convert this to the amount of water used in milliliters (ml):
- [Muino water meter reader](https://watermeter.muino.nl/) (ESPHome)
@@ -60,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.
- [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.
diff --git a/source/_docs/frontend/browsers.markdown b/source/_docs/frontend/browsers.markdown
deleted file mode 100644
index 18afa58b9606..000000000000
--- a/source/_docs/frontend/browsers.markdown
+++ /dev/null
@@ -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
diff --git a/source/_docs/locked_out.md b/source/_docs/locked_out.md
index c1ab8a227675..d8935e29b31c 100644
--- a/source/_docs/locked_out.md
+++ b/source/_docs/locked_out.md
@@ -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:
+
+## Labels
+
+- Can be assigned to areas, devices, entities, automations, scenes, scripts, and helpers.
+- Can be used in automations and scripts as a target for actions and services.
+- Labels can also be used to filter data in tables. 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.
+
+
+
+## Category
+
+- Groups items in a table.
+- Categories are unique for each table. The automations page can have different categories than the scene, scripts, or helpers settings page.
+
+
diff --git a/source/_docs/organizing/areas.markdown b/source/_docs/organizing/areas.markdown
new file mode 100644
index 000000000000..9b132256f525
--- /dev/null
+++ b/source/_docs/organizing/areas.markdown
@@ -0,0 +1,46 @@
+---
+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.
+Areas can be assigned to floors. Areas can also be used to automatically generate cards, such as the [Area card](/dashboards/area/).
+
+## Creating an area
+
+Follow these steps to create a new area from the **Areas** view.
+
+1. Go to {% my areas title="**Settings** > **Areas, labels & zones**" %} and select **Create area**.
+2. In the dialog, enter the area details:
+ - Give the area a **Name** (required).
+ - Add an icon (We use [Material icons](https://pictogrammers.com/library/mdi/)).
+ - Assign the area to a floor.
+ - If you have not created floors yet, you can [create a new one](/docs/organizing/floors/#creating-a-floor).
+ - The number can be negative. For example for underground floors.
+ - This number can later be used for sorting.
+ - Add an image representing that area.
+ - Add an **Alias**.
+ - Aliases are alternative names used in [voice assistants](/voice_control/aliases/) to refer to an area, entity, or floor.
+
+ 
+3. Select **Add**.
+
+ **Result**: A new area is created.
+
+## Assigning areas to floors and add labels
+
+If an area has not yet been assigned to a floor, it is shown in the **Unassigned areas** section. Follow these steps to assign an area to a floor.
+
+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.
diff --git a/source/_docs/organizing/categories.markdown b/source/_docs/organizing/categories.markdown
new file mode 100644
index 000000000000..261332fbc02c
--- /dev/null
+++ b/source/_docs/organizing/categories.markdown
@@ -0,0 +1,56 @@
+---
+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.
+
+## Creating a category
+
+Follow these steps to create a new category.
+
+1. Go to {% my automations title="**Settings** > **Automations & Scenes**" %} and open the respective tab.
+2. In the top left, select the **Filters** button.
+
+ 
+3. Select **Category**, then **Add category**.
+4. Enter a name, select an icon and select **Add**.
+
+ **Result**: A new category is created.
+
+## Assigning a category
+
+1. Go to {% my automations title="**Settings** > **Automations & Scenes**" %} and open the respective tab.
+2. To assign a category to a single item:
+ - Find the item in the list and select the three dots menu.
+ - Select **Assign category** and select the category from the list.
+ - If the category is not in the list, select **Add new category** and make a new one.
+3. To assign a category to multiple items:
+ - Select the button.
+ - From the list, select all the items to which you want to apply a 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.
+
+ 
+
+## Editing or deleting a category
+
+To rename or delete a category, follow these steps:
+
+1. Go to {% my automations title="**Settings** > **Automations & Scenes**" %} and open the respective tab.
+2. In the top left, select the **Filters** button.
+
+ 
+3. In the list, find the category you want to edit and select the three dot menu next to it.
+4. Select **Edit category** or **Delete category**.
+
+ 
diff --git a/source/_docs/organizing/filtering.markdown b/source/_docs/organizing/filtering.markdown
new file mode 100644
index 000000000000..97aea10bfbfe
--- /dev/null
+++ b/source/_docs/organizing/filtering.markdown
@@ -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 button.
+
+ 
+
+2. In the list, select the items of interest.
+
+ 
+
+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.
+
+ 
+
+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.
+
+ 
+
+## 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.
+
+ 
+
+3. To sort the items, select the **Sort by** button.
diff --git a/source/_docs/organizing/floors.markdown b/source/_docs/organizing/floors.markdown
new file mode 100644
index 000000000000..d4db0cb84cf8
--- /dev/null
+++ b/source/_docs/organizing/floors.markdown
@@ -0,0 +1,39 @@
+---
+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
+cannot be assigned to floors directly 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.
+
+## Creating a floor
+
+Follow these steps to create a new floor.
+
+1. Go to {% my areas title="**Settings** > **Areas, labels & zones**" %} and select **Create floor**.
+2. In the dialog, enter the floor details:
+ - Give the floor a **Name** (required).
+ - Add a floor **Level**.
+ - The number can be negative. For example for underground floors.
+ - This number can later be used for sorting.
+ - Add an icon (We use [Material icons](https://pictogrammers.com/library/mdi/)).
+ - Add an **Alias**.
+ - Aliases are alternative names used in [voice assistants](/voice_control/aliases/) to refer to an entity, area, or floor.
+
+ 
+3. Select **Add**.
+
+ **Result**: A new floor is created.
+
+ 
+4. You can now [assign areas to that floor](/docs/organizing/areas/#assigning-areas-to-floors-and-add-labels).
diff --git a/source/_docs/organizing/labels.markdown b/source/_docs/organizing/labels.markdown
new file mode 100644
index 000000000000..0e95e8dc515b
--- /dev/null
+++ b/source/_docs/organizing/labels.markdown
@@ -0,0 +1,73 @@
+---
+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.
+
+## Creating a label
+
+Follow these steps to create a new label from the **Labels** view.
+
+1. Go to {% my labels title="**Settings** > **Areas, labels & zones**" %} and on top, select the **Labels** tab.
+2. Select the **Create label** button.
+3. In the dialog, enter the label details:
+ - Give the label a **Name** (required).
+ - Add an icon (We use [Material icons](https://pictogrammers.com/library/mdi/)).
+ - Add a **Color**.
+
+ 
+4. Select **Create**.
+
+ **Result**: A new label is created.
+
+## Applying labels
+
+Follow these steps to apply a label
+
+1. To apply a label to an area:
+ - Go to {% my areas title="**Settings** > **Areas, labels & zones**" %}.
+ - On the area card, select the pencil icon.
+ - Select one or more labels or select **Add new label** to create a new one.
+2. To apply a label to a device, entity, or helper:
+ - Go to **{% my integrations title="Settings > Devices & Services" %}** and open the respective tab.
+ - Select the button.
+ - From the list, select all the list entries to which you want to apply a label.
+ - In the top right corner, select **Add label**. Then, select the labels from the list.
+
+ 
+3. To apply a label to an automation, scene, or script:
+ - Go to {% my automations title="**Settings** > **Automations & Scenes**" %} and open the respective tab.
+ - Select the button.
+ - From the list, select all the list entries 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.
+
+## Deleting a label
+
+Follow these steps to delete a label. It will be removed from all the list entries it was applied to.
+If you used this label in automations or script as targets, you need to adjust those.
+
+1. Go to {% my labels title="**Settings** > **Areas, labels & zones**" %} and on top, select the **Labels** tab.
+2. In the list of labels, find the label you want to delete and select the three dots menu.
+3. Select **Delete**.
+4. If you used this label in automations or script as targets, you need to adjust those.
+
+## Removing labels
+
+1. Go to the data table that contains the element from which you want to remove the label:
+ - Go to **{% my integrations title="Settings > Devices & Services" %}** and open the respective tab.
+ - Or, go to {% my automations title="**Settings** > **Automations & Scenes**" %} and open the respective tab.
+2. Select the button.
+ - From the list, select all the items from which you want to remove a label.
+ - In the top right corner, select the three dots menu, then select **Add label**.
+ - Then, deselect the checkbox for the label you want to remove.
+
diff --git a/source/_docs/scripts/conditions.markdown b/source/_docs/scripts/conditions.markdown
index 71529b270f58..2860510c95a3 100644
--- a/source/_docs/scripts/conditions.markdown
+++ b/source/_docs/scripts/conditions.markdown
@@ -218,8 +218,8 @@ condition:
below: 25
```
-Number helpers (`input_number` entities), `number` and `sensor` entities that
-contain a numeric value, can be used in the `above` and `below`
+Number helpers (`input_number` entities), `number`, `sensor`, and `zone` entities
+that contain a numeric value, can be used in the `above` and `below`
options to make the condition more dynamic.
```yaml
diff --git a/source/_docs/scripts/service-calls.markdown b/source/_docs/scripts/service-calls.markdown
index d94130181ee9..ccd734c536cf 100644
--- a/source/_docs/scripts/service-calls.markdown
+++ b/source/_docs/scripts/service-calls.markdown
@@ -80,7 +80,7 @@ entity_id: switch.ac
### Using the Services Developer Tool
You can use the Services Developer Tool to test data to pass in a service call.
-For example, you may test turning on or off a 'group' (See [groups] for more info)
+For example, you may test turning on or off a 'group' (See [groups](/integrations/group/) for more info)
To turn a group on or off, pass the following info:
diff --git a/source/_docs/tools/check_config.markdown b/source/_docs/tools/check_config.markdown
index 245922939132..4a805d672cd0 100644
--- a/source/_docs/tools/check_config.markdown
+++ b/source/_docs/tools/check_config.markdown
@@ -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
diff --git a/source/_docs/tools/dev-tools.markdown b/source/_docs/tools/dev-tools.markdown
index 627fac764f47..f33111825d3e 100644
--- a/source/_docs/tools/dev-tools.markdown
+++ b/source/_docs/tools/dev-tools.markdown
@@ -10,8 +10,8 @@ The dashboard contains a section called **Developer tools**.
Screenshot of Home Assistant's developer tools.
-| Section |Description |
-| ---------- |---------------------------------------------------------------------|
+| Section | Description |
+| ---------- | ------------------------------------------------------------------- |
| YAML | Lets you validate the configuration and trigger a reload or restart |
| States | Sets the representation of an entity |
| Services | Calls services from integrations |
@@ -24,7 +24,27 @@ Screenshot of Home Assistant's developer tools.
The Developer Tools is meant for **all** (not just for the developers) to quickly try out things - like calling services, updating states, raising events, and publishing messages in MQTT). It is also a necessary tool for those who write custom automations and scripts by hand. The following describes each of the sections in detail.
-## States
+## YAML tab
+
+The YAML tab provides buttons to trigger a check of configuration files and to reload the configuration. Reloading is needed to apply changes that you've made to the configuration.
+
+It is almost the same as the option under **Settings** > three dot menu (top right) > **Restart Home Assistant** > **Quick reload**. The only difference is that **Quick reload** reloads all the configuration, whereas this YAML tab allows you to only reload one specific configuration at a time.
+
+### Reloading the YAML configuration
+
+For configuration changes to become effective, the configuration must be reloaded. Most integrations in Home Assistant (that do not interact with {% term devices %} or {% term services %}) can reload changes made to their configuration in `configuration.yaml` without needing to restart Home Assistant.
+
+1. Go to {% my server_controls title="**Developer Tools** > **YAML**" %} and scroll down to the YAML configuration reloading section (alternatively, hit ["c"](/docs/tools/quick-bar/) anywhere in the UI and search for "reload").
+ - You are presented with a list of integrations, such as **Automations** or **Conversation**.
+
+ 
+
+2. Depending on what you find in the list, you can proceed with either reloading or you need to restart Home Assistant:
+ - If the integration is listed, select it to reload the settings.
+ - For example, if you've changed the [General settings](/docs/configuration/basic/), you can select **Location & customizations** to apply those changes.
+ - If the integration is not listed, you need to **Restart** Home Assistant for changes to take effect.
+
+## States tab
This section shows all the available entities, their corresponding state and the attribute values. The state and the attribute information is what Home Assistant sees at run time. To update the entity with a new state, or a new attribute value, click on the entity, scroll to the top, and modify the values, and click on “SET STATE” button.
@@ -35,7 +55,7 @@ For example, changing the `light.bedroom` state from `off` to `on` does not turn
The table containing all entities can be filtered for each column. The used search is a wildcard search meaning that if you input "office" in the entity column filter, every entity whose ID matches "\*office\*" will be shown. You can also add your own wildcards in the search input (e.g., "office\*light").
The attribute filter supports separate filters for attribute names and values, separated by a colon ":". So the filter "location:3" will result in the table showing all entities that have an attribute name that contains "location" and whose attribute value contains "3".
-## Services
+## Services tab
This section is used to call Services that are available in the ServiceRegistry.
@@ -48,6 +68,7 @@ A Service may also require additional input to be passed. It is commonly referre
When an entity is selected from the Entity dropdown, it automatically populates service data with the corresponding `entity_id`. The service data YAML can then be modified to pass additional \[optional\] parameters. The following is an illustration on how to call a `light.turn_on` service.
To turn on a light bulb, use the following steps:
+
1. Select `light.turn_on` from the Service dropdown
2. Select the entity (typically the light bulb) from the Entity dropdown (if no entity_id is selected, it turns on ALL lights)
3. If an entity is selected, the service data is populated with basic YAML that will be passed to the service. Additional data can also be passed by updating the YAML as below.
@@ -58,7 +79,7 @@ brightness: 255
rgb_color: [255, 0, 0]
```
-## Template editor
+## Template editor tab
The template editor provides a way to quickly test templates prior to placing them into automations and scripts. A code editor is on the left side and your real-time output is displayed in the preview on the right side.
@@ -66,7 +87,7 @@ By default, this will contain sample code that illustrates how templates can be
For more information about Jinja2, visit [Jinja2 documentation](https://jinja.palletsprojects.com/en/latest/templates/), and also read templating document [here](/docs/configuration/templating).
-## Events
+## Events tab
In the Events section, you can either fire an event on the event bus or subscribe to an event type in order to view the event data JSON.
@@ -118,7 +139,7 @@ Event 0 fired 9:53 AM:
}
```
-## Statistics
+## Statistics tab
The **Statistics** tab shows a list of long-term statistic entities. If the long term statistics is not working for an entity, a **Fix Issue** link is shown. Select it to view a description of the issue. There might also be an option to fix the issue.
@@ -130,15 +151,16 @@ icon. Use date & time to search for the incorrect data point and adjust the valu
-## Assist
+## Assist tab
The **Assist** tab lets you see how Home Assistant's Assist processes a sentence.
If no matching intent is found, then Assist is unable to interpret the sentence. If a matching intent was found, information is provided on the action that will be performed on which entities. The example below shows how the following sentence was parsed: *what lights are on in the office*.
+
- Assist found a matching intent: *HassGetState*.
- It found entities matching the domain: *lights*.
- The lights have the state *on*.
-- The lights are in the area *office*.
+- The lights are in the area *office*.
- The targets are the narrowed-down entities in scope.
diff --git a/source/_docs/troubleshooting_general.markdown b/source/_docs/troubleshooting_general.markdown
index e50d69b8245f..9180465edbd0 100644
--- a/source/_docs/troubleshooting_general.markdown
+++ b/source/_docs/troubleshooting_general.markdown
@@ -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/)
\ No newline at end of file
diff --git a/source/_docs/z-wave/controllers.markdown b/source/_docs/z-wave/controllers.markdown
index 6f38d7184bae..b5f007108087 100644
--- a/source/_docs/z-wave/controllers.markdown
+++ b/source/_docs/z-wave/controllers.markdown
@@ -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
diff --git a/source/_includes/asides/docs_navigation.html b/source/_includes/asides/docs_navigation.html
index ab4d2de18439..5e7aa5c9a9f2 100644
--- a/source/_includes/asides/docs_navigation.html
+++ b/source/_includes/asides/docs_navigation.html
@@ -24,9 +24,17 @@ Topics
-
-
- {% active_link /docs/configuration/yaml/ YAML %} +
- {% active_link /docs/organizing/ Organizing %} +
- {% active_link /docs/frontend/icons/ Icons%} +
-
+
- {% active_link /docs/configuration/ Configuration.yaml %} +
- {% active_link /docs/configuration/yaml/ YAML syntax%}
- {% active_link /docs/configuration/basic/ Basic information %} @@ -121,16 +129,6 @@
- {% active_link /docs/blueprint/selectors/ Selectors %}
Topics
-
-
- - {% active_link /docs/frontend/browsers/ Browser compatibility list %} - -
- {% active_link /dashboards Dashboards %} -
- {% active_link /docs/frontend/icons/ Icons%} -
-
@@ -189,4 +187,4 @@
Topics
+
diff --git a/source/_includes/common-tasks/backups.md b/source/_includes/common-tasks/backups.md
index d5d2c4b121ae..b8e89b4352bd 100644
--- a/source/_includes/common-tasks/backups.md
+++ b/source/_includes/common-tasks/backups.md
@@ -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.
@@ -55,7 +59,7 @@ There are multiple ways to store the backup on another device:
- [Add a network storage location](/common-tasks/{{page.installation}}/#network-storage) for backups.
- [Change the default location](/common-tasks/{{page.installation}}/#change-default-backup-location) for backups.
-- **Option 4**: Or even better, create an automation to handle that.
+- **Option 4**: Or even better, create an automation to handle that, using one of the [backup services](/integrations/hassio/#service-hassiobackup_full).
- **Option 5**: Make use of a third-party add-on:
- [Google Drive Backup](https://github.com/sabeechen/hassio-google-drive-backup)
- [Dropbox Sync](https://github.com/danielwelch/hassio-dropbox-sync)
diff --git a/source/_includes/common-tasks/commandline.md b/source/_includes/common-tasks/commandline.md
index 455bb86d9da4..8505c66f962a 100644
--- a/source/_includes/common-tasks/commandline.md
+++ b/source/_includes/common-tasks/commandline.md
@@ -1,10 +1,5 @@
## Home Assistant via the command line
-Organizing
+ +
-
-Home Assistant upgrade process from the SSH command line
-
- 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.
diff --git a/source/_includes/common-tasks/enable_entities.md b/source/_includes/common-tasks/enable_entities.md
index 25981da8629c..4b05c795dd79 100644
--- a/source/_includes/common-tasks/enable_entities.md
+++ b/source/_includes/common-tasks/enable_entities.md
@@ -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.
- 
-4. In the pop-up, select the cogwheel.
-5. Toggle the **Enabled** button.
- 
-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**.
+
+ 
+
+## Related topics
+
+- [Enable multiselect](/docs/organizing/filtering)
+- [Grouping your assets](/docs/organizing/)
+- [Filtering your assets](/docs/organizing/filtering)
diff --git a/source/_includes/common-tasks/enable_i2c.md b/source/_includes/common-tasks/enable_i2c.md
index 27877fd75f6d..8e89d4b89cd7 100644
--- a/source/_includes/common-tasks/enable_i2c.md
+++ b/source/_includes/common-tasks/enable_i2c.md
@@ -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:
diff --git a/source/_includes/common-tasks/file_access.md b/source/_includes/common-tasks/file_access.md
index d84f669c218b..f5d13a7c62f7 100644
--- a/source/_includes/common-tasks/file_access.md
+++ b/source/_includes/common-tasks/file_access.md
@@ -4,7 +4,7 @@ Your Home Assistant Operating server includes two repositories by default: The o
One of the first things to take care of after installing Home Assistant OS is to provide yourself access to files. There are several add-ons commonly used for this, and most users employ a mix of various add-ons. Default directories on the host are mapped to the add-ons so that they can be accessed by the services any particular add-on might provide. On the host system these directories exist on the `/data` partition at `/mnt/data/supervisor/`.
-Using any of the add-ons listed below,the following directories are made available for access:
+Using any of the add-ons listed below, the following directories are made available for access:
- `addons`
- `backup`
@@ -47,15 +47,32 @@ The Terminal & SSH add-on also provides a web terminal which allows you to acces
### Installing and using the Visual Studio Code (VSC) add-on
-The Visual Studio Code add-on provides access through a feature packed web-based version of the Visual Studio Code editor and currently only supports AMD64 and aarch64/ARM64 machines. This add-on can be installed in the add-on store from the Community add-on repository. The add-on also provides access to the Home Assistant Command Line Interface (CLI) using VSC's built in terminal, which allows for checking logs, stopping and starting Home Assistant and add-ons, creating/restoring backups, and more. (See [Home Assistant via Command Line](https://www.home-assistant.io/hassio/commandline/) for further info).
+The **Studio Code Server** add-on provides access through a feature-packed web-based version of the Visual Studio Code editor. It currently only supports AMD64 and aarch64/ARM64 machines. The add-on also provides access to the Home Assistant Command Line Interface (CLI) using VSC's built-in terminal, which allows for checking logs, stopping, and starting Home Assistant and add-ons, creating/restoring backups, and more. (See [Home Assistant via Command Line](/hassio/commandline/) for further info).
-There is no configuration required for editing files within your `/config` directory. In order to enable access to other directories, it is necessary to edit the add-on's configuration from its configuration tab. See the add-on documentation for details.
+
+
+Example of a configuration.yaml file, accessed using the Studio Code Server add-on on a Home Assistant Operating System installation.
+
+
+Example of a configuration.yaml file, accessed using the File editor add-on on a Home Assistant Operating System installation.
+
- 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.
diff --git a/source/_includes/common-tasks/update.md b/source/_includes/common-tasks/update.md
index e4f924d70083..00498602479b 100644
--- a/source/_includes/common-tasks/update.md
+++ b/source/_includes/common-tasks/update.md
@@ -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"._
diff --git a/source/_includes/installation/container.md b/source/_includes/installation/container.md
index 8d73f43d35fe..6dbf16734afd 100644
--- a/source/_includes/installation/container.md
+++ b/source/_includes/installation/container.md
@@ -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.
Prerequisites
diff --git a/source/_includes/installation/core.md b/source/_includes/installation/core.md
index 045241c23f80..7e06ce3b64c8 100644
--- a/source/_includes/installation/core.md
+++ b/source/_includes/installation/core.md
@@ -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 %}
diff --git a/source/_includes/installation/operating_system.md b/source/_includes/installation/operating_system.md
index 73f64578b7eb..53503a6e9c02 100644
--- a/source/_includes/installation/operating_system.md
+++ b/source/_includes/installation/operating_system.md
@@ -46,7 +46,7 @@ Variants without pre-installed Home Assistant:
Prerequisites
-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
Summary
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.
@@ -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 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 Balena Etcher. 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
diff --git a/source/_includes/installation/supervised.md b/source/_includes/installation/supervised.md
index decb6cde8697..c3806b199c7b 100644
--- a/source/_includes/installation/supervised.md
+++ b/source/_includes/installation/supervised.md
@@ -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 home-assistant/supervised-installer 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/" %}
diff --git a/source/_includes/related.html b/source/_includes/related.html
new file mode 100644
index 000000000000..ec7bf0e18a30
--- /dev/null
+++ b/source/_includes/related.html
@@ -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 %}
+
+{% endif %}
+{% if related_links and related_links.size != 0 %}
+
+{% endif %}
\ No newline at end of file
diff --git a/source/_includes/site/sidebar.html b/source/_includes/site/sidebar.html
index 21ca613da48a..410c1daad25c 100644
--- a/source/_includes/site/sidebar.html
+++ b/source/_includes/site/sidebar.html
@@ -9,6 +9,8 @@
{% include asides/common_tasks_navigation.html %}
{% elsif root == 'dashboards' %}
{% include asides/dashboards_navigation.html %}
+ {% elsif root == 'docs' and url_parts[2] == "organizing" %}
+ {% include asides/organizing_navigation.html %}
{% elsif root == 'developers' or root == 'help' %}
{% include asides/help_navigation.html %}
{% elsif root == 'getting-started' %}
diff --git a/source/_integrations/advantage_air.markdown b/source/_integrations/advantage_air.markdown
index 57681532b3a4..32c056c2bb2c 100644
--- a/source/_integrations/advantage_air.markdown
+++ b/source/_integrations/advantage_air.markdown
@@ -42,14 +42,12 @@ The wall-mounted Android tablet running the [MyPlace](https://play.google.com/st
### Climate
-The integration will create a climate entity for each air conditioning system found and for each zone that is temperature-controlled. The main climate entity will change its supported features and modes based on the [MyComfort](https://www.advantageair.com.au/wp-content/uploads/2019/10/MyComfort.pdf) temperature mode currently set.
+The integration will create a climate entity for each air conditioning system found and for each zone that is temperature-controlled. The main climate entity will have a preset for each [MyComfort](https://www.advantageair.com.au/wp-content/uploads/2019/10/MyComfort.pdf) temperature mode it supports.
- MyZone (default) - Use the MyZone select platform to pick which zone will be used for temperature control. Setting this to "Inactive" will use the return air vent temperature. e-zone systems do not support any MyComfort temperature modes, so will always be in the MyZone preset with MyZone set as "Inactive".
- MyTemp - Use the main climate entity to change between cool, heat, and off. Use the zone climate entities to set the desired temperature in each zone.
- MyAuto - Uses the average temperature of all zones for temperature control. When set to the Heat/Cool mode, you can adjust the heating and cooling target temperatures separately, and the MyAir system will automatically switch between heating and cooling as required.
-If you change MyComfort mode, you will need to restart Home Assistant or reload the integration.
-
### Cover
The integration will create a cover entity for each air conditioning zone that is not temperature controlled, allowing you to adjust the opening level manually from 0% to 100% in 5% increments.
diff --git a/source/_integrations/air_quality.markdown b/source/_integrations/air_quality.markdown
index 370e6f6c187e..0fc8d32f0a3f 100644
--- a/source/_integrations/air_quality.markdown
+++ b/source/_integrations/air_quality.markdown
@@ -1,5 +1,5 @@
---
-title: Air Quality
+title: Air quality
description: Instructions on how to add air quality sensors with Home Assistant
ha_release: 0.85
ha_domain: air_quality
@@ -10,7 +10,7 @@ ha_codeowners:
ha_integration_type: entity
---
-The `air_quality` base platform allows other integrations to process information about air quality and pollution details. It is used by integrations that provide an `air_quality` sensor - you can find those under the `health` [integrations](/integrations/#health).
+The **Air quality** {% term integration %} allows other integrations to process information about air quality and pollution details. It is used by integrations that provide an `air_quality` sensor - you can find those under the `health` [integrations](/integrations/#health).
The platforms cover the following levels (if they are available):
diff --git a/source/_integrations/airzone_cloud.markdown b/source/_integrations/airzone_cloud.markdown
index f0ea4164fb5e..502cc5870e2a 100644
--- a/source/_integrations/airzone_cloud.markdown
+++ b/source/_integrations/airzone_cloud.markdown
@@ -4,8 +4,9 @@ description: Instructions on how to integrate Airzone Cloud within Home Assistan
ha_release: 2023.6
ha_category:
- Binary sensor
+ - Climate
- Sensor
-ha_iot_class: Cloud Polling
+ha_iot_class: Cloud Push
ha_config_flow: true
ha_domain: airzone_cloud
ha_platforms:
@@ -57,6 +58,7 @@ For each Airzone zone (thermostat), the following *binary sensors* are created:
| Condition | Description |
| :------------------ | :------------------------------------------------------ |
+| air_quality_active | Indicates that the air quality control is running. |
| problems | Indicates that the current zone has errors or warnings. |
## Climate
@@ -79,10 +81,14 @@ For each Airzone Aidoo (HVAC Wi-Fi controller), the following *sensors* are crea
For each Airzone zone (thermostat), the following *sensors* are created:
-| Condition | Description |
-| :------------------ | :-------------------------------------------------- |
-| humidity | Measures the relative humidity in the current zone. |
-| temperature | Measures the temperature in the current zone. |
+| Condition | Description |
+| :------------------ | :-------------------------------------------------------- |
+| air_quality_index | Indicates the Air Quality Index in the current zone. |
+| humidity | Measures the relative humidity in the current zone. |
+| pm1 | Concentration of particles with a diameter of less than 1 µm. |
+| pm2_5 | Concentration of particles with a diameter of less than 2.5 µm. |
+| pm10 | Concentration of particles with a diameter of less than 10 µm. |
+| temperature | Measures the temperature in the current zone. |
For each Airzone WebServer (HVAC Wi-Fi controller), the following *sensors* are created:
diff --git a/source/_integrations/alexa.smart_home.markdown b/source/_integrations/alexa.smart_home.markdown
index e9bf2312a676..39bd72964a9e 100644
--- a/source/_integrations/alexa.smart_home.markdown
+++ b/source/_integrations/alexa.smart_home.markdown
@@ -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.
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.
diff --git a/source/_integrations/aosmith.markdown b/source/_integrations/aosmith.markdown
index ebbb212fe288..1ca9c57b7015 100644
--- a/source/_integrations/aosmith.markdown
+++ b/source/_integrations/aosmith.markdown
@@ -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
diff --git a/source/_integrations/apcupsd.markdown b/source/_integrations/apcupsd.markdown
index 722ff93b33aa..409a7ec2a6d9 100644
--- a/source/_integrations/apcupsd.markdown
+++ b/source/_integrations/apcupsd.markdown
@@ -13,6 +13,7 @@ ha_codeowners:
- '@yuxincs'
ha_platforms:
- binary_sensor
+ - diagnostics
- sensor
ha_integration_type: integration
ha_quality_scale: silver
diff --git a/source/_integrations/application_credentials.markdown b/source/_integrations/application_credentials.markdown
index 83aff2d5e50c..0e50f4cbf0e1 100644
--- a/source/_integrations/application_credentials.markdown
+++ b/source/_integrations/application_credentials.markdown
@@ -1,5 +1,5 @@
---
-title: Application Credentials
+title: Application credentials
description: Allows users to link accounts with integrations that support OAuth2
ha_release: 2022.6
ha_domain: application_credentials
@@ -10,7 +10,7 @@ ha_codeowners:
ha_integration_type: system
---
-The Application Credentials integration is used by integrations that use OAuth2 to link your account to Home Assistant. The most common and preferred approach is using account linking with Home Assistant Cloud, however not all cloud providers support that and integrations can use Application Credentials instead. Additionally, users may use Application Credentials if preferred instead of Home Assistant Cloud Account Linking.
+The **Application credentials** {% term integration %} is used by integrations that use OAuth2 to link your account to Home Assistant. The most common and preferred approach is using account linking with Home Assistant Cloud, however not all cloud providers support that and integrations can use Application Credentials instead. Additionally, users may use Application Credentials if preferred instead of Home Assistant Cloud Account Linking.
## Automatic setup
diff --git a/source/_integrations/backup.markdown b/source/_integrations/backup.markdown
index 95e302d99391..2bef3e153d8a 100644
--- a/source/_integrations/backup.markdown
+++ b/source/_integrations/backup.markdown
@@ -10,40 +10,30 @@ 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 %} is used for {% term "Home Assistant Core" %} and {% term "Home Assistant Container" %} installations to create and download backups. This backup file can be used if you migrate to {% term "Home Assistant Operating System" %}.
- "./homeassistant.tar.gz" | tar --strip-components=1 -zxf - -C
+ ```
+
+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 "./homeassistant.tar.gz" | tar --strip-components=1 -zxf - -C
-```
diff --git a/source/_integrations/bring.markdown b/source/_integrations/bring.markdown
index 91e64bb628d9..062b6804f430 100644
--- a/source/_integrations/bring.markdown
+++ b/source/_integrations/bring.markdown
@@ -13,9 +13,18 @@ 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.
+The **Bring!** integration allows you to interact with your [Bring!](https://www.getbring.com/) shopping lists within Home Assistant.
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/).
diff --git a/source/_integrations/button.mqtt.markdown b/source/_integrations/button.mqtt.markdown
index 3d67931de4db..e3393dc32296 100644
--- a/source/_integrations/button.mqtt.markdown
+++ b/source/_integrations/button.mqtt.markdown
@@ -62,7 +62,7 @@ command_template:
type: template
command_topic:
description: The MQTT topic to publish commands to trigger the button.
- required: false
+ required: true
type: string
device:
description: "Information about the device this button is a part of to tie it into the [device registry](https://developers.home-assistant.io/docs/en/device_registry_index.html). Only works when [`unique_id`](#unique_id) is set. At least one of identifiers or connections must be present to identify the device."
diff --git a/source/_integrations/caldav.markdown b/source/_integrations/caldav.markdown
index e1e0c2f7ec98..3031fee40ae0 100644
--- a/source/_integrations/caldav.markdown
+++ b/source/_integrations/caldav.markdown
@@ -12,9 +12,18 @@ 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
+The **CalDAV** integration allows you to connect your WebDAV calendar to Home Assistant
as one of these entity types:
- A [calendar](/integrations/calendar) entity which can be used to trigger automations based on the start or end of an event using criteria such as the event name or description.
diff --git a/source/_integrations/camera.markdown b/source/_integrations/camera.markdown
index 89d840ce5d93..d7e0c7bb9a0d 100644
--- a/source/_integrations/camera.markdown
+++ b/source/_integrations/camera.markdown
@@ -39,27 +39,27 @@ Available services: `enable_motion_detection`, `disable_motion_detection`, `play
Enable the motion detection in a camera.
-| Service data attribute | Optional | Description |
-| ---------------------- | -------- | ----------- |
-| `entity_id` | yes | Name(s) of entities to enable motion detection, e.g., `camera.living_room_camera`. |
+| Service data attribute | Optional | Description |
+| ---------------------- | -------- | ---------------------------------------------------------------------------------- |
+| `entity_id` | yes | Name(s) of entities to enable motion detection, e.g., `camera.living_room_camera`. |
#### Service `disable_motion_detection`
Disable the motion detection in a camera.
-| Service data attribute | Optional | Description |
-| ---------------------- | -------- | ----------- |
-| `entity_id` | yes | Name(s) of entities to disable motion detection, e.g., `camera.living_room_camera`. |
+| Service data attribute | Optional | Description |
+| ---------------------- | -------- | ----------------------------------------------------------------------------------- |
+| `entity_id` | yes | Name(s) of entities to disable motion detection, e.g., `camera.living_room_camera`. |
#### Service `play_stream`
Play a live stream from a camera to selected media player(s). Requires [`stream`](/integrations/stream) integration to be set up.
-| Service data attribute | Optional | Description |
-| ---------------------- | -------- | ----------- |
-| `entity_id` | no | Name of entity to fetch stream from, e.g., `camera.living_room_camera`. |
-| `media_player` | no | Name of media player to play stream on, e.g., `media_player.living_room_tv`. |
-| `format` | yes | Stream format supported by `stream` integration and selected `media_player`. Default: `hls` |
+| Service data attribute | Optional | Description |
+| ---------------------- | -------- | ------------------------------------------------------------------------------------------- |
+| `entity_id` | no | Name of entity to fetch stream from, e.g., `camera.living_room_camera`. |
+| `media_player` | no | Name of media player to play stream on, e.g., `media_player.living_room_tv`. |
+| `format` | yes | Stream format supported by `stream` integration and selected `media_player`. Default: `hls` |
For example, the following action in an automation would send an `hls` live stream to your chromecast.
@@ -78,14 +78,14 @@ Make a `.mp4` recording from a camera stream. Requires `stream` integration to b
Both `duration` and `lookback` options are suggestions, but should be consistent per camera. The actual length of the recording may vary. It is suggested that you tweak these settings to fit your needs.
-| Service data attribute | Optional | Description |
-| ---------------------- | -------- | ----------- |
-| `entity_id` | no | Name(s) of entities to create a snapshot from, e.g., `camera.living_room_camera`. |
-| `filename` | no | Template of a file name. Variable is `entity_id`, e.g., {% raw %}`/tmp/{{ entity_id.name }}.mp4`{% endraw %}. |
-| `duration` | yes | Target recording length (in seconds). Default: 30 |
-| `lookback` | yes | Target lookback period (in seconds) to include in addition to duration. Only available if there is currently an active HLS stream. Default: 0 |
+| Service data attribute | Optional | Description |
+| ---------------------- | -------- | ---------------------------------------------------------------------------------------------------------------------------------------------- |
+| `entity_id` | no | Name(s) of entities to create a snapshot from, e.g., `camera.living_room_camera`. |
+| `filename` | no | Template of a file name. Variable is `entity_id`, e.g., {% raw %}`/tmp/{{ entity_id.name }}.mp4`{% endraw %}. |
+| `duration` | yes | Target recording length (in seconds). Default: 30 |
+| `lookback` | yes | Target lookback period (in seconds) to include in addition to duration. Only available if there is currently an active HLS stream. Default: 0 |
-The path part of `filename` must be an entry in the `allowlist_external_dirs` in your [`homeassistant:`](/docs/configuration/basic/) section of your `configuration.yaml` file.
+The path part of `filename` must be an entry in the `allowlist_external_dirs` in your [`homeassistant:`](/integrations/homeassistant/#allowlist_external_dirs) section of your `configuration.yaml` file.
For example, the following action in an automation would take a recording from "yourcamera" and save it to /tmp with a timestamped filename.
@@ -106,12 +106,12 @@ action:
Take a snapshot from a camera.
-| Service data attribute | Optional | Description |
-| ---------------------- | -------- | ----------- |
-| `entity_id` | no | Name(s) of entities to create a snapshot from, e.g., `camera.living_room_camera`. |
-| `filename` | no | Template of a file name. Variable is `entity_id`, e.g., {% raw %}`/tmp/snapshot_{{ entity_id.name }}`{% endraw %}. |
+| Service data attribute | Optional | Description |
+| ---------------------- | -------- | ------------------------------------------------------------------------------------------------------------------ |
+| `entity_id` | no | Name(s) of entities to create a snapshot from, e.g., `camera.living_room_camera`. |
+| `filename` | no | Template of a file name. Variable is `entity_id`, e.g., {% raw %}`/tmp/snapshot_{{ entity_id.name }}`{% endraw %}. |
-The path part of `filename` must be an entry in the `allowlist_external_dirs` in your [`homeassistant:`](/docs/configuration/basic/) section of your `configuration.yaml` file.
+The path part of `filename` must be an entry in the `allowlist_external_dirs` in your [`homeassistant:`](/integrations/homeassistant/) section of your `configuration.yaml` file.
For example, the following action in an automation would take a snapshot from "yourcamera" and save it to /tmp with a timestamped filename.
@@ -132,17 +132,17 @@ action:
Turn off camera. Not all camera models support this service, please consult individual camera page.
-| Service data attribute | Optional | Description |
-| ---------------------- | -------- | ----------- |
-| `entity_id` | yes | Name(s) of entities to turn off, e.g., `camera.living_room_camera`. |
+| Service data attribute | Optional | Description |
+| ---------------------- | -------- | ------------------------------------------------------------------- |
+| `entity_id` | yes | Name(s) of entities to turn off, e.g., `camera.living_room_camera`. |
#### Service `turn_on`
Turn on camera. Not all camera models support this service, please consult individual camera page.
-| Service data attribute | Optional | Description |
-| ---------------------- | -------- | ----------- |
-| `entity_id` | yes | Name(s) of entities to turn on, e.g., `camera.living_room_camera`. |
+| Service data attribute | Optional | Description |
+| ---------------------- | -------- | ------------------------------------------------------------------ |
+| `entity_id` | yes | Name(s) of entities to turn on, e.g., `camera.living_room_camera`. |
### Test if it works
diff --git a/source/_integrations/cast.markdown b/source/_integrations/cast.markdown
index 6fe08fdac805..2a880e2b4abf 100644
--- a/source/_integrations/cast.markdown
+++ b/source/_integrations/cast.markdown
@@ -48,7 +48,7 @@ cast_downstairs_on_kitchen:
@@ -138,10 +138,10 @@ This app doesn't retrieve its own metadata, so if you want the cast interface or
Note: Media ID is NOT the 8 digit alphanumeric in the URL, it can be found by right-clicking the playing video. E.g., [this episode](https://www.bbc.co.uk/iplayer/episode/b09w7fd9/bitz-bob-series-1-1-castle-makeover) shows:
-| | |
-| --- | --- |
+| | |
+| -------- | ------------------------------- |
| 2908kbps | dash (mf_cloudfront_dash_https) |
-| b09w70r2 | 960x540 |
+| b09w70r2 | 960x540 |
With b09w70r2 being the `media_id`
@@ -343,10 +343,10 @@ To cast media directly from a configured Plex server, set the fields [as documen
Note: Media ID is NOT the 8 digit alphanumeric in the URL, it can be found by right-clicking the playing audio clip. E.g., [this episode](https://www.bbc.co.uk/sounds/play/p009ycqy) shows:
-| | |
-| --- | --- |
-| 128bps | dash (mf_cloudfront_nonbidi_dash_https) |
-| p009ycqz | |
+| | |
+| -------- | --------------------------------------- |
+| 128bps | dash (mf_cloudfront_nonbidi_dash_https) |
+| p009ycqz | |
With p009ycqz being the `media_id`
diff --git a/source/_integrations/climate.mqtt.markdown b/source/_integrations/climate.mqtt.markdown
index 6cfb2dd3b58d..89151e889342 100644
--- a/source/_integrations/climate.mqtt.markdown
+++ b/source/_integrations/climate.mqtt.markdown
@@ -188,7 +188,7 @@ json_attributes_topic:
max_humidity:
description: The minimum target humidity percentage that can be set.
required: false
- type: integer
+ type: float
default: 99
max_temp:
description: Maximum set point available. The default value depends on the temperature unit, and will be 35°C or 95°F.
@@ -197,7 +197,7 @@ max_temp:
min_humidity:
description: The maximum target humidity percentage that can be set.
required: false
- type: integer
+ type: float
default: 30
min_temp:
description: Minimum set point available. The default value depends on the temperature unit, and will be 7°C or 44.6°F.
diff --git a/source/_integrations/color_extractor.markdown b/source/_integrations/color_extractor.markdown
index 4a338de3faf1..211fa90d800b 100644
--- a/source/_integrations/color_extractor.markdown
+++ b/source/_integrations/color_extractor.markdown
@@ -22,15 +22,15 @@ Because `color_extractor.turn_on` will then call `light.turn_on`, you can pass a
Passing the key `color_extract_url` to the {% term service %} call will download the linked image and extract the predominant color from it. Passing the key `color_extract_path` to the service call will process the image file from local storage instead. `color_extract_url` and `color_extract_path` are exclusive and cannot be used together.
-|Key | Example | Description |
-|---------------------|---------------------------------------|-------------------------------------------------------------------------------|
-|`color_extract_url` | `https://example.com/images/logo.png` | The full URL (including schema, `http://`, `https://`) of the image to process|
-|`color_extract_path` | `/tmp/album.png` | The full path to the image file on local storage we'll process |
-|`entity_id` | `light.shelf_leds` | The RGB capable light we'll set the color of |
+| Key | Example | Description |
+| -------------------- | ------------------------------------- | ------------------------------------------------------------------------------ |
+| `color_extract_url` | `https://example.com/images/logo.png` | The full URL (including schema, `http://`, `https://`) of the image to process |
+| `color_extract_path` | `/tmp/album.png` | The full path to the image file on local storage we'll process |
+| `entity_id` | `light.shelf_leds` | The RGB capable light we'll set the color of |
-
-If you use Home Assistant Operating System or Home Assistant Supervised, [back up functionality is already built-in](/common-tasks/os/#backups).
-
-
-
-
-## 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.
+Note: If you use {% term "Home Assistant Operating System" %} or {% term "Home Assistant Supervised" %} installation, this page is not for you. Instead, refer to the documentation on using the [built-in back up](/common-tasks/os/#backups).
## 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 +45,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 +61,21 @@ automation:
## Restoring a backup
-
+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:
-
+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
-Home Assistant Cast requires your Home Assistant installation to be accessible via `https://`. If you're using Home Assistant Cloud, you don't need to do anything. Otherwise you must make sure that you have configured the `external_url` in your [configuration](/docs/configuration/basic).
+Home Assistant Cast requires your Home Assistant installation to be accessible via `https://`. If you're using Home Assistant Cloud, you don't need to do anything. Otherwise you must make sure that you have configured the `external_url` in your [configuration](/integrations/homeassistant/#configuration-variables).
@@ -58,7 +58,7 @@ Home Assistant Cast requires your Home Assistant installation to be accessible v
Chromecasts generally ignore DNS servers from DHCP and will instead use Google's DNS servers, 8.8.8.8 and 8.8.4.4. This means media URLs must either be specifying the IP-address of the server directly, e.g. `http://192.168.1.1:8123/movie.mp4`, or be publicly resolvable, e.g. `http://homeassistant.internal.mydomain.com:8123/movie.mp4` where `homeassistant.internal.mydomain.com` resolves to `192.168.1.1`. A hostname which can't be publicly resolved, e.g. `http://homeassistant.local:8123/movie.mp4` will fail to play.
-This is important when casting TTS or local media sources; the cast integration will cast such media from the `external_url` if [configured](/docs/configuration/basic), otherwise from the Home Assistant Cloud if configured, otherwise from the [`internal_url`](/docs/configuration/basic). Note that the Home Assistant Cloud will not be used if an `external_url` is configured.
+This is important when casting TTS or local media sources; the cast integration will cast such media from the `external_url` if [configured](/integrations/homeassistant/#editing-the-general-settings-in-yaml), otherwise from the Home Assistant Cloud if configured, otherwise from the [`internal_url`](/integrations/homeassistant/#editing-the-general-settings-in-yaml). Note that the Home Assistant Cloud will not be used if an `external_url` is configured.
- Please ensure any [external URLs](/docs/configuration/basic/#allowlist_external_urls) or [external files](/docs/configuration/basic/#allowlist_external_dirs) are authorized for use. You will receive error messages if this {% term integration %} is not allowed access to these external resources.
+ Please ensure any [external URLs](/integrations/homeassistant/#allowlist_external_urls) or [external files](/docs/integrations/homeassistant/#allowlist_external_dirs) are authorized for use. You will receive error messages if this {% term integration %} is not allowed access to these external resources.
diff --git a/source/_integrations/comelit.markdown b/source/_integrations/comelit.markdown
index fac72dc7ed6e..26ecc7201be9 100644
--- a/source/_integrations/comelit.markdown
+++ b/source/_integrations/comelit.markdown
@@ -30,7 +30,7 @@ The Comelit SimpleHome integration allows you to control your [Comelit home auto
There is support for the following platform types within Home Assistant:
-- **Comelit Serial Bridge** - allows local control for light, cover, irrigation, climate and "other" devices; creates power sensors.
+- **Comelit Serial Bridge** - allows local control for light, cover, irrigation, climate, humidifier/dehumidifier and "other" devices; creates power sensors.
- **Comelit VEDO System** - allows local control of the alarm system.
{% include integrations/config_flow.md %}
diff --git a/source/_integrations/command_line.markdown b/source/_integrations/command_line.markdown
index 4deb3a59c4b1..0fa8215ef892 100644
--- a/source/_integrations/command_line.markdown
+++ b/source/_integrations/command_line.markdown
@@ -1,6 +1,6 @@
---
-title: Command Line
-description: Instructions on how to integrate the Command Line utility within Home Assistant.
+title: Command line
+description: Instructions on how to integrate the command line utility within Home Assistant.
ha_category:
- Binary sensor
- Cover
@@ -21,7 +21,7 @@ ha_codeowners:
- '@gjohansson-ST'
---
-The `command_line` offers functionality that issues specific commands to get data or to control a device.
+The **Command line** {% term integration %} offers functionality that issues specific commands to get data or to control a device.
@@ -43,7 +43,7 @@ command_line:
command:
description: The action to take to get the value.
required: true
- type: string
+ type: template
command_timeout:
description: Defines number of seconds for command timeout.
required: false
@@ -168,7 +168,7 @@ command_line:
command:
description: The action to take to get the value.
required: true
- type: string
+ type: template
command_timeout:
description: Defines number of seconds for command timeout
required: false
diff --git a/source/_integrations/control4.markdown b/source/_integrations/control4.markdown
index a90dca89a9b2..89d82cf9a333 100644
--- a/source/_integrations/control4.markdown
+++ b/source/_integrations/control4.markdown
@@ -4,6 +4,7 @@ description: Instructions on adding a Control4 system to Home Assistant.
ha_release: '0.114'
ha_category:
- Light
+ - Media Player
ha_iot_class: Local Polling
ha_config_flow: true
ha_codeowners:
@@ -12,10 +13,11 @@ ha_domain: control4
ha_ssdp: true
ha_platforms:
- light
+ - media_player
ha_integration_type: integration
---
-The **Control4** {% term integration %} allows you to control and monitor lights from your local Control4 system. Your Control4 controller must be running OS 3.0+.
+The **Control4** {% term integration %} allows you to control and monitor lights and Room Media from your local Control4 system. Your Control4 controller must be running OS 3.0+.
## Prerequisites
diff --git a/source/_integrations/default_config.markdown b/source/_integrations/default_config.markdown
index 61be61b50be6..c579916b7d70 100644
--- a/source/_integrations/default_config.markdown
+++ b/source/_integrations/default_config.markdown
@@ -25,7 +25,6 @@ This {% term integration %} is a meta-component and configures a default set of
- [Home Assistant Cloud](/integrations/cloud/) (`cloud`)
- [Image upload](/integrations/image_upload/) (`image_upload`)
- [Logbook](/integrations/logbook/) (`logbook`)
-- [Map](/integrations/map/) (`map`)
- [Media source](/integrations/media_source/) (`media_source`)
- [Mobile app support](/integrations/mobile_app/) (`mobile_app`)
- [My Home Assistant](/integrations/my/) (`my`)
diff --git a/source/_integrations/denonavr.markdown b/source/_integrations/denonavr.markdown
index 832015de2ad0..8c7c893d980b 100644
--- a/source/_integrations/denonavr.markdown
+++ b/source/_integrations/denonavr.markdown
@@ -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).
+
+
+The `host` (ex: xxxxxxxx.fbxos.fr) and `port` given by refers to your Freebox public IP address and may not work if your Home Assistant server is located inside your local LAN. For local API access, you can alternatively use `host` = *mafreebox.freebox.fr* and `port` = *443*.
+
+
+
### Initial setup
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.
diff --git a/source/_integrations/device_automation.markdown b/source/_integrations/device_automation.markdown
index 1036db1e3907..cab524a1b2d5 100644
--- a/source/_integrations/device_automation.markdown
+++ b/source/_integrations/device_automation.markdown
@@ -1,6 +1,6 @@
---
-title: Device Automation
-description: Information about the Device Automation plugin.
+title: Device automation
+description: Information about the device automation plugin.
ha_category:
- Automation
ha_release: 0.7
@@ -11,7 +11,7 @@ ha_domain: device_automation
ha_integration_type: system
---
-Device Automations is a plugin for the automation integration to allow other integrations to provide device specific triggers, conditions and actions.
+**Device automation** is a plugin for the automation integration to allow other integrations to provide device specific triggers, conditions and actions.
There is no device automation specific configuration. Instead, it is configured as part of the normal automations.
diff --git a/source/_integrations/dialogflow.markdown b/source/_integrations/dialogflow.markdown
index b7f9570249ad..87dd2c606065 100644
--- a/source/_integrations/dialogflow.markdown
+++ b/source/_integrations/dialogflow.markdown
@@ -12,7 +12,7 @@ ha_integration_type: integration
The **Dialogflow** {% term integration %} is designed to be used with the [webhook](https://cloud.google.com/dialogflow/es/docs/fulfillment-webhook) integration of [Dialogflow](https://cloud.google.com/dialogflow/docs/). After each phrase a user says, Dialogflow sends an action and parameters to the webhook.
-To be able to receive messages from Dialogflow, your Home Assistant instance needs to be accessible from the web and you need to have the external URL [configured](/docs/configuration/basic). Dialogflow will return fallback answers if your server does not answer or takes too long (more than 5 seconds).
+To be able to receive messages from Dialogflow, your Home Assistant instance needs to be accessible from the web and you need to have the external URL [configured](/integrations/homeassistant/#editing-the-general-settings-in-yaml). Dialogflow will return fallback answers if your server does not answer or takes too long (more than 5 seconds).
Dialogflow could be [integrated](https://cloud.google.com/dialogflow/es/docs/integrations) with many popular messaging, virtual assistant and IoT platforms.
diff --git a/source/_integrations/discord.markdown b/source/_integrations/discord.markdown
index 71a5e39f72e6..5c7d7cdbc408 100644
--- a/source/_integrations/discord.markdown
+++ b/source/_integrations/discord.markdown
@@ -69,26 +69,26 @@ When adding the Discord integration you will be asked for an API Key. Enter the
The following attributes can be placed inside the `data` key of the service call for extended functionality:
-| Attribute | Optional | Description |
-| ---------------------- | -------- | ----------- |
-| `images` | yes | The file(s) to attach to message.
-| `urls` | yes | The file(s) to download from a remote URL and attach to message.
-| `verify_ssl` | yes | A boolean to determine if SSL certs should be verified when calling the remote URLs in the `url` attribute. Defaults to `True`.
-| `embed` | yes | Array of [Discord embeds](https://discordpy.readthedocs.io/en/latest/api.html#embed). *NOTE*: if using `embed`, `message` is still required.
+| Attribute | Optional | Description |
+| ------------ | -------- | -------------------------------------------------------------------------------------------------------------------------------------------- |
+| `images` | yes | The file(s) to attach to message. |
+| `urls` | yes | The file(s) to download from a remote URL and attach to message. |
+| `verify_ssl` | yes | A boolean to determine if SSL certs should be verified when calling the remote URLs in the `url` attribute. Defaults to `True`. |
+| `embed` | yes | Array of [Discord embeds](https://discordpy.readthedocs.io/en/latest/api.html#embed). *NOTE*: if using `embed`, `message` is still required. |
To include messages with embedding, use these attributes underneath the `embed` key:
-| Attribute | Optional | Description |
-| ---------------------- | -------- | ----------- |
-| `title` | yes | Title of the embed.
-| `description` | yes | Description of the embed.
-| `color` | yes | Color code of the embed. This value is an *int*.
-| `url` | yes | URL of the embed.
-| `author` | yes | Sets the footer for the embed content.
-| `footer` | yes | Sets the footer for the embed content.
-| `thumbnail` | yes | Sets the thumbnail for the embed content.
-| `image` | yes | Sets the image for the embed content.
-| `fields` | yes | Adds a field to the embed object. `name` and `value` are *required*, `inline` is *true* by default.
+| Attribute | Optional | Description |
+| ------------- | -------- | ---------------------------------------------------------------------------------------------------- |
+| `title` | yes | Title of the embed. |
+| `description` | yes | Description of the embed. |
+| `color` | yes | Color code of the embed. This value is an *int*. |
+| `url` | yes | URL of the embed. |
+| `author` | yes | Sets the footer for the embed content. |
+| `footer` | yes | Sets the footer for the embed content. |
+| `thumbnail` | yes | Sets the thumbnail for the embed content. |
+| `image` | yes | Sets the image for the embed content. |
+| `fields` | yes | Adds a field to the embed object. `name` and `value` are *required*, `inline` is *true* by default. |
### Example service call
@@ -117,7 +117,7 @@ To include messages with embedding, use these attributes underneath the `embed`
- "https://example.com/video.mp4"
```
-Note that `verify_ssl` defaults to `True`, and that any remote hosts will need to be in your [`allowlist_external_urls`](/docs/configuration/basic/#allowlist_external_urls) list. Discord limits attachment size to 8MB, so anything exceeding this will be skipped and noted in the error log.
+Note that `verify_ssl` defaults to `True`, and that any remote hosts will need to be in your [`allowlist_external_urls`](/integrations/homeassistant/#allowlist_external_urls) list. Discord limits attachment size to 8MB, so anything exceeding this will be skipped and noted in the error log.
### Example embed service call
diff --git a/source/_integrations/downloader.markdown b/source/_integrations/downloader.markdown
index 34f25bbd2911..1155ea8a033f 100644
--- a/source/_integrations/downloader.markdown
+++ b/source/_integrations/downloader.markdown
@@ -6,25 +6,17 @@ ha_category:
ha_release: pre 0.7
ha_quality_scale: internal
ha_domain: downloader
+ha_codeowners:
+ - '@erwindouna'
ha_integration_type: integration
+ha_config_flow: true
---
-The `downloader` integration provides a service to download files. It will raise an error and not continue to set itself up when the download directory does not exist. The directory needs to be writable for the user that is running Home Assistant.
+The **Downloader** {% term integration %} provides a service to download files. It will raise an error and not continue to set itself up when the download directory does not exist. The directory needs to be writable for the user that is running Home Assistant.
-To enable it, add the following lines to your `configuration.yaml` file:
+{% include integrations/config_flow.md %}
-```yaml
-# Example configuration.yaml entry
-downloader:
- download_dir: downloads
-```
-
-{% configuration %}
-download_dir:
- description: "If the path is not absolute, it's assumed to be relative to the Home Assistant configuration directory (eg. `.homeassistant/downloads`)."
- required: true
- type: string
-{% endconfiguration %}
+If the path is not absolute, it’s assumed to be relative to the Home Assistant configuration directory (for example, .homeassistant/downloads).
### Use the service
diff --git a/source/_integrations/dsmr_reader.markdown b/source/_integrations/dsmr_reader.markdown
index f355a282af1a..ce1253c1946e 100644
--- a/source/_integrations/dsmr_reader.markdown
+++ b/source/_integrations/dsmr_reader.markdown
@@ -9,7 +9,7 @@ ha_config_flow: true
ha_mqtt: true
ha_release: 0.103
ha_codeowners:
- - '@depl0y'
+ - '@sorted-bits'
- '@glodenox'
ha_domain: dsmr_reader
ha_platforms:
diff --git a/source/_integrations/dte_energy_bridge.markdown b/source/_integrations/dte_energy_bridge.markdown
index c6a74c171dfb..f8b4ab1e4d77 100644
--- a/source/_integrations/dte_energy_bridge.markdown
+++ b/source/_integrations/dte_energy_bridge.markdown
@@ -1,5 +1,5 @@
---
-title: DTE Energy Bridge (2020 and older hardware only)
+title: DTE Energy Bridge
description: Setup early-model DTE Energy Bridge with Home Assistant.
ha_category:
- Energy
diff --git a/source/_integrations/ecobee.markdown b/source/_integrations/ecobee.markdown
index 081a0fe89a93..0bb796622abf 100644
--- a/source/_integrations/ecobee.markdown
+++ b/source/_integrations/ecobee.markdown
@@ -33,6 +33,10 @@ The **ecobee** {% term integration %} lets you control and view sensor data from
You will need to obtain an API key from ecobee's [developer site](https://www.ecobee.com/developers/) to use this integration. To get the key, your thermostat must be registered on ecobee's website (which you likely would have already done while installing your thermostat). Once you have done that, perform the following steps.
+
+As of March 28th, 2024, ecobee is no longer accepting new developer subscriptions, and there is no ETA for when they will be allowed again. Existing developers are not affected.
+
+
1. Click on the **Become a developer** link on the [developer site](https://www.ecobee.com/home/developer/loginDeveloper.jsp).
2. Log in with your ecobee credentials. (Make sure multifactor authentication is disabled to meet the developer login form's limits. If you've already enabled MFA, the web portal doesn't support disabling it. The iOS and Android apps do under Account > Account Security. You can re-enable MFA after becoming a developer.)
3. Accept the SDK agreement.
diff --git a/source/_integrations/ecovacs.markdown b/source/_integrations/ecovacs.markdown
index 547b03ca821d..b54caba1fa5b 100644
--- a/source/_integrations/ecovacs.markdown
+++ b/source/_integrations/ecovacs.markdown
@@ -18,6 +18,7 @@ ha_platforms:
- binary_sensor
- button
- diagnostics
+ - event
- image
- number
- select
@@ -48,6 +49,8 @@ Additionally, **depending on your model**, the integration provides the followin
- **Button**:
- `Reset lifespan`: For each supported component, a button entity to reset the lifespan will be created. All disabled by default.
- `Relocate`: Button entity to trigger manual relocation.
+- **Event**:
+ - `Last job`: Provides the stop reason as event_type
- **Image**:
- `Map`: The floorplan/map as an image in SVG format.
- **Number**:
@@ -72,8 +75,13 @@ Additionally, **depending on your model**, the integration provides the followin
- `Time`: The total cleaning time
- **Switch**:
- `Advanced mode`: Enable advanced mode. Disabled by default.
+ - `Border switch`: Enable border switch. Disabled by default.
- `Carpet auto fan speed boost`: Enable maximum fan speed if a carpet is detected. Disabled by default.
+ - `Child lock`: Enable child lock. Disabled by default.
+ - `Move up warning`: Enable device move up warning. Disabled by default.
+ - `Cross map border warning`: Enable warning for crossing the map border. Disabled by default.
- `Continuous cleaning`: Enable continuous cleaning, which means the bot resumes the cleaning job if he needs to charge in between. Disabled by default.
+ - `Safe protect`: Enable "Safe protect" feature. Disabled by default.
- `True detect`: Enable "True detect" feature. Disabled by default.
## Vacuum
diff --git a/source/_integrations/elmax.markdown b/source/_integrations/elmax.markdown
index be38b91e26b2..6b8ca3fb2e81 100644
--- a/source/_integrations/elmax.markdown
+++ b/source/_integrations/elmax.markdown
@@ -15,6 +15,7 @@ ha_platforms:
- cover
- switch
ha_integration_type: integration
+ha_zeroconf: true
---
The Elmax integration enables Home Assistant integration with
diff --git a/source/_integrations/emulated_roku.markdown b/source/_integrations/emulated_roku.markdown
index 4cc1ca53a370..b7df1de04c48 100644
--- a/source/_integrations/emulated_roku.markdown
+++ b/source/_integrations/emulated_roku.markdown
@@ -124,6 +124,12 @@ The following is an example implementation of an automation:
entity_id: media_player.amplifier
```
+### Video tutorial
+
+This comprehensive video tutorial explains how events work in Home Assistant and how you can set up Emulated Roku to control a media player using a physical remote control.
+
+
-File paths must also be added to [allowlist_external_dirs](/docs/configuration/basic/) in your `configuration.yaml`.
+File paths must also be added to [allowlist_external_dirs](/integrations/homeassistant/#allowlist_external_dirs) in your `configuration.yaml`.
+
+File paths should be absolute paths. For example: `/config/home-assistant_v2.db` to monitor the size of the default database.
diff --git a/source/_integrations/filter.markdown b/source/_integrations/filter.markdown
index 92a67a0362f4..70e9650adef7 100644
--- a/source/_integrations/filter.markdown
+++ b/source/_integrations/filter.markdown
@@ -117,7 +117,7 @@ filters:
-When configuring a `window_size` that is not a time and with a value larger than the default of `1`, the database must examine nearly every stored state for that entity during Home Assistant startup. If you have modified the [Recorder `purge_keep_days`](/integrations/recorder/#purge_keep_days) value or have many states stored in the database for the filtered entity, this can cause your Home Assistant instance can to respond poorly during startup.
+When configuring a `window_size` that is not a time and with a value larger than the default of `1`, the database must examine nearly every stored state for that entity during Home Assistant startup. If you have modified the [Recorder `purge_keep_days`](/integrations/recorder/#purge_keep_days) value or have many states stored in the database for the filtered entity, this can cause your Home Assistant instance to respond poorly during startup.
diff --git a/source/_integrations/folder.markdown b/source/_integrations/folder.markdown
index bd435c5dc3ba..b9a1763969e9 100644
--- a/source/_integrations/folder.markdown
+++ b/source/_integrations/folder.markdown
@@ -12,7 +12,7 @@ ha_platforms:
ha_integration_type: integration
---
-Sensor for monitoring the contents of a folder. Note that folder paths must be added to [allowlist_external_dirs](/docs/configuration/basic/). Optionally a [wildcard filter](https://docs.python.org/3.6/library/fnmatch.html) can be applied to the files considered within the folder. The state of the sensor is the size in MB of files within the folder that meet the filter criteria.
+Sensor for monitoring the contents of a folder. Note that folder paths must be added to [allowlist_external_dirs](/integrations/homeassistant/#allowlist_external_dirs). Optionally a [wildcard filter](https://docs.python.org/3.6/library/fnmatch.html) can be applied to the files considered within the folder. The state of the sensor is the size in MB of files within the folder that meet the filter criteria.
The sensor exposes the number of filtered files in the folder, total size in bytes of those files and a comma separated list of the file paths as attributes.
## Configuration
diff --git a/source/_integrations/folder_watcher.markdown b/source/_integrations/folder_watcher.markdown
index e5b9b01aa0fe..4d3718b47a66 100644
--- a/source/_integrations/folder_watcher.markdown
+++ b/source/_integrations/folder_watcher.markdown
@@ -1,5 +1,5 @@
---
-title: Folder Watcher
+title: Folder watcher
description: Integration for monitoring changes within the filesystem.
ha_category:
- System monitor
@@ -10,7 +10,7 @@ ha_domain: folder_watcher
ha_integration_type: integration
---
-This integration adds [Watchdog](https://pythonhosted.org/watchdog/) file system monitoring, publishing events on the Home Assistant bus on the creation/deletion/modification of files within configured folders. The monitored `event_type` are:
+The **Folder watcher** {% term integration %} adds [Watchdog](https://pythonhosted.org/watchdog/) file system monitoring, publishing events on the Home Assistant bus on the creation/deletion/modification of files within configured folders. The monitored `event_type` are:
- `closed`
- `created`
@@ -18,11 +18,11 @@ This integration adds [Watchdog](https://pythonhosted.org/watchdog/) file system
- `modified`
- `moved`
-Configured folders must be added to [allowlist_external_dirs](/docs/configuration/basic/). Note that by default folder monitoring is recursive, meaning that the contents of sub-folders are also monitored.
+Configured folders must be added to [allowlist_external_dirs](/integrations/homeassistant/#allowlist_external_dirs). Note that by default folder monitoring is recursive, meaning that the contents of sub-folders are also monitored.
## Configuration
-To enable the Folder Watcher integration in your installation, add the following to your `configuration.yaml` file:
+To enable the **Folder watcher** {% term integration %} in your installation, add the following to your `configuration.yaml` file:
```yaml
folder_watcher:
diff --git a/source/_integrations/freebox.markdown b/source/_integrations/freebox.markdown
index a6e53b60d852..12263bcceca1 100644
--- a/source/_integrations/freebox.markdown
+++ b/source/_integrations/freebox.markdown
@@ -45,6 +45,12 @@ You can find out your Freebox host and port by opening this address
diff --git a/source/_integrations/frontend.markdown b/source/_integrations/frontend.markdown
index c7db8fb08cc5..cdb056af35b4 100644
--- a/source/_integrations/frontend.markdown
+++ b/source/_integrations/frontend.markdown
@@ -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"
```
diff --git a/source/_integrations/fyta.markdown b/source/_integrations/fyta.markdown
new file mode 100644
index 000000000000..74eaa15c24ae
--- /dev/null
+++ b/source/_integrations/fyta.markdown
@@ -0,0 +1,41 @@
+---
+title: FYTA
+description: Instructions on how to integrate FYTA sensors within Home Assistant.
+ha_category:
+ - Sensor
+ha_release: 2024.4
+ha_iot_class: Cloud Polling
+ha_config_flow: true
+ha_codeowners:
+ - '@dontinelli'
+ha_domain: fyta
+ha_platforms:
+ - sensor
+ha_integration_type: hub
+---
+
+The **FYTA** {% term integration %} uses the open API of [FYTA](https://www.fyta.de) to obtain the data from your plant sensors and integrate these into Home Assistant.
+
+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](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 %}
+
+## Sensors
+
+The following sensors are currently available per plant:
+
+| name | Unit | Description |
+|-----------------------|--------|:-------------------------------------------|
+| scientific_name | | Scientific name of the plant |
+| plant_status | | FYTA-Status (number 1 to 5) |
+| temperature_status | | FYTA-Status (number 1 to 5) |
+| light_status | | FYTA-Status (number 1 to 5) |
+| moisture_status | | FYTA-Status (number 1 to 5) |
+| salinity_status | | FYTA-Status (number 1 to 5) |
+| temperature | °C | Temperature measured by sensor |
+| light | μmol/h | Light measured by sensor (hourly photosynthetically active radiation PAR)|
+| moisture | % | Moisture measured by sensor |
+| salinity | mS/cm | Salinity measured by sensor (measured as conductivity)|
+| battery_level | % | Battery level of the sensor |
diff --git a/source/_integrations/generic_hygrostat.markdown b/source/_integrations/generic_hygrostat.markdown
index 6746fbd064a1..3eab325e82eb 100644
--- a/source/_integrations/generic_hygrostat.markdown
+++ b/source/_integrations/generic_hygrostat.markdown
@@ -46,16 +46,16 @@ min_humidity:
description: Set minimum set point available.
required: false
default: 0
- type: integer
+ type: float
max_humidity:
description: Set maximum set point available.
required: false
default: 100
- type: integer
+ type: float
target_humidity:
description: Set initial target humidity. This value will be used as a fallback when the previous setpoint is not available.
required: false
- type: integer
+ type: float
device_class:
description: Whether the switch specified in the *humidifier* option to be treated as a humidifier or a dehumidifier device. Must be either "humidifier" or "dehumidifier"
required: false
diff --git a/source/_integrations/google_tasks.markdown b/source/_integrations/google_tasks.markdown
index 30eee6edad2f..02ccff1f7616 100644
--- a/source/_integrations/google_tasks.markdown
+++ b/source/_integrations/google_tasks.markdown
@@ -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
@@ -19,7 +30,7 @@ each task list, allowing you to create, update, or delete items on the list from
`area_id(s)` | Set the value of specific `input_boolean` entities to `on` -| `turn_off` | `entity_id(s)`
`area_id(s)` | Set the value of specific `input_boolean` entities to `off` -| `toggle` | `entity_id(s)`
`area_id(s)` | Toggle the value of specific `input_boolean` entities -| `reload` | | Reload `input_boolean` configuration | +| Service | Data | Description | +| ---------- | ------------------------------ | ----------------------------------------------------------- | +| `turn_on` | `entity_id(s)`
`area_id(s)` | Set the value of specific `input_boolean` entities to `on` | +| `turn_off` | `entity_id(s)`
`area_id(s)` | Set the value of specific `input_boolean` entities to `off` | +| `toggle` | `entity_id(s)`
`area_id(s)` | Toggle the value of specific `input_boolean` entities | +| `reload` | | Reload `input_boolean` configuration | ### Restore state diff --git a/source/_integrations/input_button.markdown b/source/_integrations/input_button.markdown index 2e130827e4a0..36ccde149016 100644 --- a/source/_integrations/input_button.markdown +++ b/source/_integrations/input_button.markdown @@ -1,6 +1,6 @@ --- -title: Input Button -description: Instructions on how to use the Input Button helper with Home Assistant. +title: Input button +description: Instructions on how to use the input button helper with Home Assistant. ha_category: - Automation - Helper @@ -12,7 +12,7 @@ ha_domain: input_button ha_integration_type: helper --- -The Input Button helper integration allows you to define buttons that +The **Input button** helper integration allows you to define buttons that can be pressed via the user interface, and can be used to trigger things, like an automation. diff --git a/source/_integrations/input_number.markdown b/source/_integrations/input_number.markdown index 2b34c9d0a24f..cc9252568f53 100644 --- a/source/_integrations/input_number.markdown +++ b/source/_integrations/input_number.markdown @@ -1,6 +1,6 @@ --- -title: Input Number -description: Instructions on how to integrate the Input Number integration into Home Assistant. +title: Input number +description: Instructions on how to integrate the input number integration into Home Assistant. ha_category: - Automation - Helper @@ -12,7 +12,7 @@ ha_domain: input_number ha_integration_type: helper --- -The `input_number` integration allows the user to define values that can be controlled via the frontend and can be used within conditions of automation. The frontend can display a slider, or a numeric input box. Changes to the slider or numeric input box generate state events. These state events can be utilized as `automation` triggers as well. +The **Input number** {% term integration %} allows the user to define values that can be controlled via the frontend and can be used within conditions of automation. The frontend can display a slider, or a numeric input box. Changes to the slider or numeric input box generate state events. These state events can be utilized as `automation` triggers as well. The preferred way to configure an input number is via the user interface at **{% my helpers title="Settings > Devices & Services > Helpers" %}**. Click the add button and then choose the **{% my config_flow_start domain="input_number" title="Number" %}** option. @@ -87,12 +87,12 @@ input_number: This integration provides the following services to modify the state of the `input_number` and a service to reload the configuration without restarting Home Assistant itself. -| Service | Data | Description | -| ------- | ---- | ----------- | -| `decrement` | `entity_id(s)`
`area_id(s)` | Decrement the value of specific `input_number` entities by `step` -| `increment` | `entity_id(s)`
`area_id(s)` | Increment the value of specific `input_number` entities by `step` -| `reload` | | Reload `input_number` configuration | -| `set_value` | `value`
`entity_id(s)`
`area_id(s)` | Set the value of specific `input_number` entities +| Service | Data | Description | +| ----------- | ----------------------------------------- | ----------------------------------------------------------------- | +| `decrement` | `entity_id(s)`
`area_id(s)` | Decrement the value of specific `input_number` entities by `step` | +| `increment` | `entity_id(s)`
`area_id(s)` | Increment the value of specific `input_number` entities by `step` | +| `reload` | | Reload `input_number` configuration | +| `set_value` | `value`
`entity_id(s)`
`area_id(s)` | Set the value of specific `input_number` entities | ### Restore state diff --git a/source/_integrations/input_select.markdown b/source/_integrations/input_select.markdown index c7303e07e227..72900456e387 100644 --- a/source/_integrations/input_select.markdown +++ b/source/_integrations/input_select.markdown @@ -1,6 +1,6 @@ --- -title: Input Select -description: Instructions on how to integrate the Input Select integration into Home Assistant. +title: Input select +description: Instructions on how to integrate the input select integration into Home Assistant. ha_category: - Automation - Helper @@ -12,7 +12,7 @@ ha_domain: input_select ha_integration_type: helper --- -The `input_select` integration allows the user to define a list of values that can be selected via the frontend and can be used within conditions of an automation. When a user selects a new item, a state transition event is generated. This state event can be used in an `automation` trigger. +The **Input select** {% term integration %} allows the user to define a list of values that can be selected via the frontend and can be used within conditions of an automation. When a user selects a new item, a state transition event is generated. This state event can be used in an `automation` trigger. The preferred way to configure an input select is via the user interface at **{% my helpers title="Settings > Devices & Services > Helpers" %}**. Click the add button and then choose the **{% my config_flow_start domain="input_select" title="Dropdown" %}** option. @@ -77,29 +77,29 @@ If you set a valid value for `initial` this integration will start with the stat This integration provides three services to modify the state of the `input_select`. -| Service | Data | Description | -| ------- | ---- | ----------- | -| `select_option` | `option` | This can be used to select a specific option. -| `set_options` | `options`
`entity_id(s)` | Set the options for specific `input_select` entities. -| `select_first` | | Select the first option. -| `select_last` | | Select the last option. -| `reload` | | Reload `input_select` configuration | +| Service | Data | Description | +| --------------- | --------------------------- | ----------------------------------------------------- | +| `select_option` | `option` | This can be used to select a specific option. | +| `set_options` | `options`
`entity_id(s)` | Set the options for specific `input_select` entities. | +| `select_first` | | Select the first option. | +| `select_last` | | Select the last option. | +| `reload` | | Reload `input_select` configuration | #### Service `input_select.select_next` Select the next option. -| Service data attribute | Optional | Description | -| ---------------------- | -------- | ----------- | -| `cycle` | yes | Whether to cycle to the first value after the last. Default: `true` +| Service data attribute | Optional | Description | +| ---------------------- | -------- | ------------------------------------------------------------------- | +| `cycle` | yes | Whether to cycle to the first value after the last. Default: `true` | #### Service `input_select.select_previous` Select the previous option. -| Service data attribute | Optional | Description | -| ---------------------- | -------- | ----------- | -| `cycle` | yes | Whether to cycle to the last value before the first. Default: `true` +| Service data attribute | Optional | Description | +| ---------------------- | -------- | -------------------------------------------------------------------- | +| `cycle` | yes | Whether to cycle to the last value before the first. Default: `true` | ### Scenes diff --git a/source/_integrations/input_text.markdown b/source/_integrations/input_text.markdown index ad7fde933508..8a57b8309877 100644 --- a/source/_integrations/input_text.markdown +++ b/source/_integrations/input_text.markdown @@ -1,6 +1,6 @@ --- -title: Input Text -description: Instructions on how to integrate the Input Text integration into Home Assistant. +title: Input text +description: Instructions on how to integrate the Input text integration into Home Assistant. ha_category: - Automation - Helper @@ -12,7 +12,7 @@ ha_domain: input_text ha_integration_type: helper --- -The `input_text` integration allows the user to define values that can be controlled via the frontend and can be used within conditions of automation. Changes to the value stored in the text box generate state events. These state events can be utilized as `automation` triggers as well. It can also be configured in password mode (obscured text). +The **Input text** {% term integration %} allows the user to define values that can be controlled via the frontend and can be used within conditions of automation. Changes to the value stored in the text box generate state events. These state events can be utilized as `automation` triggers as well. It can also be configured in password mode (obscured text). The preferred way to configure an input text is via the user interface at **{% my helpers title="Settings > Devices & Services > Helpers" %}**. Click the add button and then choose the **{% my config_flow_start domain="input_text" title="Text" %}** option. @@ -83,10 +83,10 @@ input_text: This integration provides a service to modify the state of the `input_text` and a service to reload the `input_text` configuration without restarting Home Assistant itself. -| Service | Data | Description | -| ------- | ---- | ----------- | -| `set_value` | `value`
`entity_id(s)` | Set the value for specific `input_text` entities. -| `reload` | | Reload `input_text` configuration | +| Service | Data | Description | +| ----------- | ------------------------- | ------------------------------------------------- | +| `set_value` | `value`
`entity_id(s)` | Set the value for specific `input_text` entities. | +| `reload` | | Reload `input_text` configuration | ### Restore state diff --git a/source/_integrations/ipma.markdown b/source/_integrations/ipma.markdown index 85351853890a..378c143b06e4 100644 --- a/source/_integrations/ipma.markdown +++ b/source/_integrations/ipma.markdown @@ -10,6 +10,7 @@ ha_codeowners: - '@dgomes' ha_domain: ipma ha_platforms: + - diagnostics - sensor - weather ha_integration_type: integration diff --git a/source/_integrations/juicenet.markdown b/source/_integrations/juicenet.markdown new file mode 100644 index 000000000000..e4add243f456 --- /dev/null +++ b/source/_integrations/juicenet.markdown @@ -0,0 +1,49 @@ +--- +title: JuiceNet +description: Instructions on how to setup WiFi-equipped JuiceNet/JuiceBox charging stations with Home Assistant. +ha_category: + - Car + - Energy + - Number + - Sensor + - Switch +ha_iot_class: Cloud Polling +ha_release: 0.47 +ha_codeowners: + - '@jesserockz' +ha_domain: juicenet +ha_config_flow: true +ha_platforms: + - number + - sensor + - switch +ha_integration_type: integration +--- + +The `juicenet` platform pulls data from a [JuiceNet](https://evcharging.enelx.com/products/juicebox) charging station equipped with a Wi-Fi connection. It will access and make available all of the devices attached to your account. It also exposes a switch allowing you to charge your car now instead of waiting for the pre-set schedule. + +{% include integrations/config_flow.md %} + +## Sensor + +The `juicenet` sensor platform allows you to get data from your [JuiceNet](https://evcharging.enelx.com/products/juicebox) charger. + +### Added sensors + +These sensors will be added for each JuiceNet device in your account: + +- Status +- Temperature (inside the device) +- Voltage +- Amps +- Watts +- Charge time of session +- Energy added this session + +## Switch + +The `juicenet` switch platform allows you to override the charging schedule for your JuiceNet device. + +## Number + +The `juicenet` number platform allows you to control the charging amperage limit. diff --git a/source/_integrations/jvc_projector.markdown b/source/_integrations/jvc_projector.markdown index 2d1b72df5913..47f4948cb4e6 100644 --- a/source/_integrations/jvc_projector.markdown +++ b/source/_integrations/jvc_projector.markdown @@ -13,6 +13,7 @@ ha_domain: jvc_projector ha_platforms: - binary_sensor - remote + - sensor ha_integration_type: device --- @@ -61,5 +62,25 @@ The JVC Projector remote platform will create a [Remote](/integrations/remote/) ### Binary sensor -The status reported is: -- **Power on** is **True** when the projector is either in status **on** or **warming**. +The following sensor types are supported: + +- Power on is True when projector is in status "on", "warming" + +### Sensor + +Introduces two sensors to detect Power Status and HDMI Input. + +Detailed Power Status values: + +- `standby` +- `on` +- `warming` +- `cooling` +- `error` + +Please note that if the projector is off, it will not respond to remote polling and will show as *unavailable*. + +Detailed HDMI Input values: + +- `hdmi1` +- `hdmi2` diff --git a/source/_integrations/kitchen_sink.markdown b/source/_integrations/kitchen_sink.markdown index ef190583c5bc..9e0c80ccfe3a 100644 --- a/source/_integrations/kitchen_sink.markdown +++ b/source/_integrations/kitchen_sink.markdown @@ -12,6 +12,7 @@ ha_iot_class: Calculated ha_platforms: - button - image + - lawn_mower - lock - sensor - switch diff --git a/source/_integrations/konnected.markdown b/source/_integrations/konnected.markdown index 717107ad37d9..36df0a6f4ed8 100644 --- a/source/_integrations/konnected.markdown +++ b/source/_integrations/konnected.markdown @@ -111,7 +111,7 @@ Once all zones are configured you'll be presented with the configuration for add **Blink panel LED on when sending state change:** The desired LED behavior for the panel. -**Override default Home Assistant API host panel URL:** The Konnected Alarm Panel post sensor states back to the Home Assistant API. If this value is unchecked the panel will default postbacks using the URL [configured](/docs/configuration/basic) in Home Assistant. By default, the integration will use the internal URL. However, if you check this field and set the **Override API host URL** to your _local_ IP address and port (e.g., `http://192.168.1.101:8123`), it will be used instead of the internal URL. +**Override default Home Assistant API host panel URL:** The Konnected Alarm Panel post sensor states back to the Home Assistant API. If this value is unchecked the panel will default postbacks using the URL [configured](/integrations/homeassistant/#allowlist_external_urls) in Home Assistant. By default, the integration will use the internal URL. However, if you check this field and set the **Override API host URL** to your _local_ IP address and port (e.g., `http://192.168.1.101:8123`), it will be used instead of the internal URL. **Override API host URL (optional):** The host info to use if you checked **Override default Home Assistant API host panel URL** in the step above. This is ignored if **Override default Home Assistant API host panel URL** is unchecked. diff --git a/source/_integrations/lamarzocco.markdown b/source/_integrations/lamarzocco.markdown index d762df7a9ff8..4dfa142916f8 100644 --- a/source/_integrations/lamarzocco.markdown +++ b/source/_integrations/lamarzocco.markdown @@ -18,15 +18,18 @@ ha_platforms: - sensor - switch - update +ha_bluetooth: true ha_codeowners: - '@zweckj' ha_integration_type: device --- -This integration interacts with [La Marzocco coffee machines](https://lamarzocco.com/it/en/) through calls to the LaMarzocco cloud API and (optionally) local API calls, which include a WebSocket connection for (near) real-time updates. +This integration interacts with [La Marzocco coffee machines](https://lamarzocco.com/it/en/) through calls to the LaMarzocco cloud API. Optionally, local API calls, which include a WebSocket connection for (near) real-time updates and a Bluetooth connection, can be utilized for local connections. To be able to configure your machine in Home Assistant, your machine needs to be added to your account using the official La Marzocco app first. Currently, only login with username & password is supported. If you are currently using a social login, you need to create a new LaMarzocco account and transfer your machine to it to be able to use this integration. +If your machine is in Bluetooth range to your Home Assistant host and the [Bluetooth](/integrations/bluetooth) integration is fully loaded, the machine will be discovered automatically. + {% include integrations/config_flow.md %} diff --git a/source/_integrations/lawn_mower.mqtt.markdown b/source/_integrations/lawn_mower.mqtt.markdown index 3260c3ba0234..d8c58a267422 100644 --- a/source/_integrations/lawn_mower.mqtt.markdown +++ b/source/_integrations/lawn_mower.mqtt.markdown @@ -177,7 +177,7 @@ qos: type: integer default: 0 start_mowing_template: - description: Defines a [template](/docs/configuration/templating/#using-templates-with-the-mqtt-integration) to generate the payload to send to `dock_command_topic`. The `value` parameter in the template will be set to `dock`. + description: Defines a [template](/docs/configuration/templating/#using-templates-with-the-mqtt-integration) to generate the payload to send to `start_mowing_command_topic`. The `value` parameter in the template will be set to `start_mowing`. required: false type: template start_mowing_command_topic: @@ -210,7 +210,7 @@ The example below shows how to use a single command topic with a command templat ```yaml # Example configuration.yaml entry mqtt: - - alarm_control_panel: + - lawn_mower: name: "Lawn Mower Plus" activity_state_topic: "lawn_mower_plus/state" activity_value_template: "{{ value_json.activity }}" diff --git a/source/_integrations/light.mqtt.markdown b/source/_integrations/light.mqtt.markdown index 9bc7cbbde59b..31ee29164a18 100644 --- a/source/_integrations/light.mqtt.markdown +++ b/source/_integrations/light.mqtt.markdown @@ -40,7 +40,7 @@ When a state topic is not available, the light will work in optimistic mode. In Optimistic mode can be forced, even if the `state_topic` is available. Try to enable it, if experiencing incorrect light operation. Home Assistant internally assumes that a light's state corresponds to a defined `color_mode`. -The state of MQTT lights with default schema and support for both color and color temperature will set the `color_mode` according to the last received valid color or color temperature. Optionally, a `color_mode_state_topic` can be configured for explicit control of the `color_mode` +The state of MQTT lights with default schema and support for both color and color temperature will set the `color_mode` according to the last received valid color or color temperature. Optionally, a `color_mode_state_topic` can be configured for explicit control of the `color_mode`. ```yaml # Example configuration.yaml entry @@ -563,7 +563,7 @@ availability_topic: required: false type: string brightness: - description: Flag that defines if the light supports brightness. + description: Flag that defines if light supports brightness when the `rgb`, `rgbw`, or `rgbww` color mode is supported. required: false type: boolean default: false @@ -572,11 +572,6 @@ brightness_scale: required: false type: integer default: 255 -color_mode: - description: Flag that defines if the light supports color modes. - required: false - type: boolean - default: false command_topic: description: The MQTT topic to publish commands to change the light’s state. required: true @@ -715,7 +710,7 @@ state_topic: required: false type: string supported_color_modes: - description: A list of color modes supported by the list. This is required if `color_mode` is `True`. Possible color modes are `onoff`, `brightness`, `color_temp`, `hs`, `xy`, `rgb`, `rgbw`, `rgbww`, `white`. Note that if `onoff` **or** `brightness` are used, that must be the _only_ value in the list. + description: A list of color modes supported by the list. Possible color modes are `onoff`, `brightness`, `color_temp`, `hs`, `xy`, `rgb`, `rgbw`, `rgbww`, `white`. Note that if `onoff` **or** `brightness` are used, that must be the _only_ value in the list. required: false type: list unique_id: @@ -758,7 +753,6 @@ mqtt: state_topic: "home/rgb1" command_topic: "home/rgb1/set" brightness: true - color_mode: true supported_color_modes: ["rgb"] ``` @@ -775,7 +769,6 @@ mqtt: state_topic: "home/rgb1" command_topic: "home/rgb1/set" brightness: true - color_mode: true supported_color_modes: ["brightness"] ``` @@ -793,7 +786,6 @@ mqtt: command_topic: "home/light/set" brightness: true brightness_scale: 4095 - color_mode: true supported_color_modes: ["brightness"] ``` @@ -817,7 +809,6 @@ mqtt: name: mqtt_json_hs_light state_topic: "home/light" command_topic: "home/light/set" - color_mode: true supported_color_modes: ["hs"] ``` @@ -847,7 +838,6 @@ mqtt: state_topic: "home/rgbw1" command_topic: "home/rgbw1/set" brightness: true - color_mode: true supported_color_modes: ["rgbw"] ``` diff --git a/source/_integrations/local_calendar.markdown b/source/_integrations/local_calendar.markdown index d0ad2e59ed05..e2cd8c251da0 100644 --- a/source/_integrations/local_calendar.markdown +++ b/source/_integrations/local_calendar.markdown @@ -1,6 +1,6 @@ --- -title: Local Calendar -description: Instructions on how to use Local Calendars in Home Assistant. +title: Local calendar +description: Instructions on how to use local calendars in Home Assistant. ha_category: - Calendar ha_iot_class: Local Polling @@ -15,7 +15,7 @@ ha_codeowners: ha_integration_type: integration --- -The local calendar integration allows you to create a calendar of events in Home Assistant for powering automations. +The **Local calendar** {% term integration %} allows you to create a calendar of events in Home Assistant for powering automations. A calendar entity has a state and attributes that represent the next upcoming event (only). A calendar trigger is a much more flexible way to power automations with fewer limitations than using the entity state. diff --git a/source/_integrations/local_file.markdown b/source/_integrations/local_file.markdown index a1594b19d2d6..ca49a1ded323 100644 --- a/source/_integrations/local_file.markdown +++ b/source/_integrations/local_file.markdown @@ -1,6 +1,6 @@ --- -title: Local File -description: Instructions how to use Local File as a Camera within Home Assistant. +title: Local file +description: Instructions how to use local file as a camera within Home Assistant. ha_category: - Camera ha_iot_class: Local Polling @@ -11,7 +11,7 @@ ha_platforms: ha_integration_type: integration --- -The `local_file` camera platform allows you to integrate an image file from disk into Home Assistant as a camera. If the image is updated on the file system the image displayed in Home Assistant will also be updated. The service `local_file.update_file_path` can be used to update the image using an automation. +The **Local file** camera {% term integration %} allows you to integrate an image file from disk into Home Assistant as a camera. If the image is updated on the file system the image displayed in Home Assistant will also be updated. The service `local_file.update_file_path` can be used to update the image using an automation. The `local_file` camera can for example be used with various camera platforms that save a temporary images locally. It can also be used to display a graph that you render periodically and will then be displayed in Home Assistant. @@ -41,7 +41,7 @@ name: Use this service to change the file displayed by the camera. -| Service data attribute | Description | -| -----------------------| ----------- | -| `entity_id` | String of the `entity_id` of the camera to update. | -| `file_path` | The full path to the new image file to be displayed. | +| Service data attribute | Description | +| ---------------------- | ---------------------------------------------------- | +| `entity_id` | String of the `entity_id` of the camera to update. | +| `file_path` | The full path to the new image file to be displayed. | diff --git a/source/_integrations/local_todo.markdown b/source/_integrations/local_todo.markdown index 19aadb9bb15f..f7602092bcbc 100644 --- a/source/_integrations/local_todo.markdown +++ b/source/_integrations/local_todo.markdown @@ -12,9 +12,14 @@ ha_codeowners: ha_integration_type: integration ha_platforms: - todo +related: + - docs: /integrations/todo/ + title: To-do list integration documentation + - docs: /dashboards/todo-list/ + title: To-do list card --- -The **Local to-do list** integration allows you to create to-do lists in Home Assistant. +The **Local to-do list** {% term integration %} allows you to create to-do lists in Home Assistant. To-do lists are shown on the **To-do list** dashboard for tracking items and whether or not they have been completed. @@ -22,8 +27,3 @@ See the [**To-do list** integration](/integrations/todo) for additional details about to-do list entities. {% include integrations/config_flow.md %} - -## Related topics - -- [**To-do list** integration](/integrations/todo) -- [Shopping list card](/dashboards/shopping-list/) \ No newline at end of file diff --git a/source/_integrations/lutron_caseta.markdown b/source/_integrations/lutron_caseta.markdown index 6c64992f5499..ca13682b775c 100644 --- a/source/_integrations/lutron_caseta.markdown +++ b/source/_integrations/lutron_caseta.markdown @@ -113,7 +113,7 @@ Use a DHCP reservation on your router to reserve the address or in the PRO model
-To get Lutron Caseta roller, honeycomb shades, lights, scene and switch working with Home Assistant. First follow the instructions for the general Lutron Caseta integration above.
+To get Lutron Caseta roller, honeycomb shades, wood blinds, lights, scene and switch working with Home Assistant, first follow the instructions for the general Lutron Caseta integration above.
## Cover
@@ -123,6 +123,8 @@ For more information on working with shades in Home Assistant, see the [Covers i
Available services: `cover.open_cover`, `cover.close_cover`, `cover.stop_cover` and `cover.set_cover_position`. Cover `position` ranges from `0` for fully closed to `100` for fully open.
+Available services for tilt-only wood blinds: `cover.open_cover_tilt`, `cover.close_cover_tilt`, `cover.stop_cover_tilt`, `cover.toggle_tilt`. Cover `position` is `0` or `100` for fully closed and `50` for fully open.
+
## Light
After setup, dimmable lights including wall and plug-in dimmers will appear in Home Assistant using an `entity_id` based on the name used in the Lutron mobile app. For example, a light called 'Bedroom Lamp' will appear in Home Assistant as `light.bedroom_lamp`.
diff --git a/source/_integrations/mailgun.markdown b/source/_integrations/mailgun.markdown
index 654fd8562a26..5c5f4def3f82 100644
--- a/source/_integrations/mailgun.markdown
+++ b/source/_integrations/mailgun.markdown
@@ -12,7 +12,7 @@ ha_platforms:
ha_integration_type: integration
---
-To be able to receive webhooks from Mailgun, your Home Assistant instance needs to be accessible from the web and you need to have the external URL [configured](/docs/configuration/basic)).
+To be able to receive webhooks from Mailgun, your Home Assistant instance needs to be accessible from the web and you need to have the external URL [configured](/integrations/homeassistant/#allowlist_external_urls).
To set it up, go to the integrations page in the configuration screen and find Mailgun. Click on configure. Follow the instructions on the screen to configure Mailgun.
diff --git a/source/_integrations/map.markdown b/source/_integrations/map.markdown
deleted file mode 100644
index 3702fe90909a..000000000000
--- a/source/_integrations/map.markdown
+++ /dev/null
@@ -1,27 +0,0 @@
----
-title: Map
-description: Offers a map to show tracked devices.
-ha_category:
- - Other
-ha_release: 0.56
-ha_quality_scale: internal
-ha_domain: map
-ha_integration_type: system
----
-
-This offers a map on the frontend to display the location of tracked devices. To set up tracked devices, look at the [device tracker](/integrations/device_tracker/) documentation. This integration is by default enabled, unless you've disabled or removed the [`default_config:`](/integrations/default_config/) line from your configuration. If that is the case, the following example shows you how to enable this integration manually:
-
-```yaml
-# Example configuration.yaml entry
-map:
-```
-
-
-The Google Tasks public API does not support viewing or setting the due time of tasks, only the due date.
+The Google Tasks public API does not support viewing or setting the due time of tasks, only the due date.
diff --git a/source/_integrations/heos.markdown b/source/_integrations/heos.markdown
index cb12ee09b6a6..8fba4803b746 100644
--- a/source/_integrations/heos.markdown
+++ b/source/_integrations/heos.markdown
@@ -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
diff --git a/source/_integrations/history.markdown b/source/_integrations/history.markdown
index a18c10f14b1f..87603d666a4f 100644
--- a/source/_integrations/history.markdown
+++ b/source/_integrations/history.markdown
@@ -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)
diff --git a/source/_integrations/history_stats.markdown b/source/_integrations/history_stats.markdown
index 3b018340db8a..5cabd7d3e59e 100644
--- a/source/_integrations/history_stats.markdown
+++ b/source/_integrations/history_stats.markdown
@@ -1,5 +1,5 @@
---
-title: History Stats
+title: History stats
description: Instructions about how to integrate historical statistics into Home Assistant.
ha_category:
- Sensor
@@ -13,7 +13,7 @@ ha_platforms:
ha_integration_type: integration
---
-The `history_stats` sensor platform provides quick statistics about another integration or platforms, using data from the [`history`](/integrations/history/) integration.
+The **History stats** {% term integration %} provides quick statistics about another integration or platforms, using data from the [`history`](/integrations/history/) integration.
It can track how long the integration has been in a specific state, in a custom time period.
diff --git a/source/_integrations/homeassistant.markdown b/source/_integrations/homeassistant.markdown
index 503b57909434..23ac3458982c 100644
--- a/source/_integrations/homeassistant.markdown
+++ b/source/_integrations/homeassistant.markdown
@@ -11,9 +11,234 @@ ha_domain: homeassistant
ha_platforms:
- scene
ha_integration_type: system
+related:
+ - docs: /docs/configuration/basic/
+ title: Basic information
+ - docs: /docs/configuration/
+ - docs: /docs/configuration/customizing-devices/
---
-The Home Assistant integration provides generic implementations like the generic `homeassistant.turn_on`.
+The **Home Assistant Core** {% term integration %} provides generic implementations like the generic `homeassistant.turn_on`.
+
+## Editing the general settings in YAML
+
+The Home Assistant Core integration is also responsible for the general settings. These settings are defined during onboarding, but you can change them later under {% my general title="**Settings** > **System** > **General**" %}. For the detailed steps, refer to [Basic settings](/docs/configuration/basic/).
+
+If you prefer editing in YAML, you can define your general settings in the [`configuration.yaml` file](/docs/configuration/).
+Note that for some of the settings, these can't be edited from the UI if they were defined in YAML. They will be grayed out or inaccessible.
+
+
+ 
+ Screenshot showing coordinates cannot be edited because they are defined in configuration.yaml file.
+
+
+If you implement `customize`, `customize_domain`, or `customize_glob` you must make sure it is done inside of `homeassistant:` or it will fail.
+
+
+
+```yaml
+homeassistant:
+ name: Home
+ unit_system: metric
+ # etc
+
+ customize:
+ # Add an entry for each entity that you want to overwrite.
+ thermostat.family_room:
+ entity_picture: https://example.com/images/nest.jpg
+ friendly_name: Nest
+ switch.wemo_switch_1:
+ friendly_name: Toaster
+ entity_picture: /local/toaster.jpg
+ switch.wemo_switch_2:
+ friendly_name: Kitchen kettle
+ icon: mdi:kettle
+ switch.rfxtrx_switch:
+ assumed_state: false
+ media_player.my_media_player:
+ source_list:
+ - Channel/input from my available sources
+ # Customize all entities in a domain
+ customize_domain:
+ light:
+ icon: mdi:home
+ automation:
+ initial_state: "on"
+ # Customize entities matching a pattern
+ customize_glob:
+ "light.kitchen_*":
+ icon: mdi:description
+ "scene.month_*_colors":
+ icon: mdi:other
+```
## Services
@@ -43,12 +268,12 @@ will take effect the next time an importing template is rendered.
Reloads an integration config entry.
-| Service data attribute | Description |
-|---------------------------|-------------------------------------------------------------|
-| `entity_id` | List of entity ids used to reference a config entry. |
-| `area_id` | List of area ids used to reference a config entry. |
-| `device_id` | List of device ids used to reference a config entry. |
-| `entry_id` | A single config entry id used to reference a config entry. |
+| Service data attribute | Description |
+| ---------------------- | ---------------------------------------------------------- |
+| `entity_id` | List of entity ids used to reference a config entry. |
+| `area_id` | List of area ids used to reference a config entry. |
+| `device_id` | List of device ids used to reference a config entry. |
+| `entry_id` | A single config entry id used to reference a config entry. |
### Service `homeassistant.reload_core_config`
@@ -68,11 +293,11 @@ Stops the Home Assistant instance. Home Assistant must be restarted from the Hos
Update the location of the Home Assistant default zone (usually "Home").
-| Service data attribute | Optional | Description |
-|---------------------------|----------|-------------------------------------------------------|
-| `latitude` | no | Latitude of your location. |
-| `longitude` | no | Longitude of your location. |
-| `elevation` | yes | Elevation of your location. |
+| Service data attribute | Optional | Description |
+| ---------------------- | -------- | --------------------------- |
+| `latitude` | no | Latitude of your location. |
+| `longitude` | no | Longitude of your location. |
+| `elevation` | yes | Elevation of your location. |
#### Example
@@ -92,9 +317,9 @@ Generic service to toggle devices on/off. Same usage as the
service compared the others, is that is can be used to mix different domains,
for example, a light and a switch can be toggled in a single service call.
-| Service data attribute | Optional | Description |
-|---------------------------|----------|-------------------------------------------------------|
-| `entity_id` | yes | The entity_id of the device to toggle on/off. |
+| Service data attribute | Optional | Description |
+| ---------------------- | -------- | --------------------------------------------- |
+| `entity_id` | yes | The entity_id of the device to toggle on/off. |
#### Example
@@ -114,9 +339,9 @@ Generic service to toggle devices on. Same usage as the
service compared the others, is that is can be used to mix different domains,
for example, a light and a switch can be turned on in a single service call.
-| Service data attribute | Optional | Description |
-|---------------------------|----------|-------------------------------------------------------|
-| `entity_id` | yes | The entity_id of the device to turn on. |
+| Service data attribute | Optional | Description |
+| ---------------------- | -------- | --------------------------------------- |
+| `entity_id` | yes | The entity_id of the device to turn on. |
#### Example
@@ -136,9 +361,9 @@ Generic service to toggle devices off. Same usage as the
service compared the others, is that is can be used to mix different domains,
for example, a light and a switch can be turned off in a single service call.
-| Service data attribute | Optional | Description |
-|---------------------------|----------|-------------------------------------------------------|
-| `entity_id` | yes | The entity_id of the device to turn off. |
+| Service data attribute | Optional | Description |
+| ---------------------- | -------- | ---------------------------------------- |
+| `entity_id` | yes | The entity_id of the device to turn off. |
#### Example
@@ -155,9 +380,9 @@ action:
Force one or more entities to update its data rather than wait for the next scheduled update.
-| Service data attribute | Optional | Description |
-|---------------------------|----------|-------------------------------------------------------|
-| `entity_id` | no | One or multiple entity_ids to update. It can be a list. |
+| Service data attribute | Optional | Description |
+| ---------------------- | -------- | ------------------------------------------------------- |
+| `entity_id` | no | One or multiple entity_ids to update. It can be a list. |
#### Example
diff --git a/source/_integrations/homematic.markdown b/source/_integrations/homematic.markdown
index bcc2948f65c7..10d27e1bb93e 100644
--- a/source/_integrations/homematic.markdown
+++ b/source/_integrations/homematic.markdown
@@ -15,7 +15,6 @@ ha_iot_class: Local Push
ha_release: 0.23
ha_codeowners:
- '@pvizeli'
- - '@danielperna84'
ha_domain: homematic
ha_platforms:
- binary_sensor
diff --git a/source/_integrations/homewizard.markdown b/source/_integrations/homewizard.markdown
index 952d7f1785ce..9bda71324123 100644
--- a/source/_integrations/homewizard.markdown
+++ b/source/_integrations/homewizard.markdown
@@ -66,7 +66,7 @@ Sensors for P1 meter, only available when smart meter exposes these values:
- **Power failures**: Two sensors that indicate the number of power failures that have been detected by the smart meter. One for all power failures and another for 'long' power failures.
- **Peak demand**: Belgium users are starting to get charged for the peak usage per month (see [capaciteitstarief](https://www.fluvius.be/thema/factuur-en-tarieven/capaciteitstarief)). Two sensors are available: One that shows the current quarterly average and another that shows the peak measured this month. Both these sensors are provided directly from the smart meter and can be used to keep the peak as low as possible.
-Sensors for kWh meter:
+Sensors for Energy Socket and kWh meter:
- **Voltage (V)**: Active voltage that is measured on each phase.
- **Current (A)**: Active current that is measured on each phase.
- **Frequency (Hz)**: Net frequency.
@@ -90,10 +90,10 @@ You can also control the green status light brightness with **Status light brigh
## Identify
The identify button can be pressed to let the status light blink for a few seconds.
-This feature is currently only available for the P1 meter and the Energy Socket.
+_This feature not available for the kWh Meter._
## Cloud communication
-The HomeWizard Energy devices are designed to work with the HomeWizard Energy app and require communication with the HomeWizard cloud to make them function with the app. The "Cloud connection" configuration toggle can be used to turn off all communication with the HomeWizard cloud, making the device fully local. The device cannot communicate with the app, and the device won't receive any future firmware updates. This feature is currently not available for the Water meter.
+The HomeWizard Energy devices are designed to work with the HomeWizard Energy app and require communication with the HomeWizard cloud to make them function with the app. The "Cloud connection" configuration toggle can be used to turn off all communication with the HomeWizard cloud, making the device fully local. The device cannot communicate with the app, and the device won't receive any future firmware updates.
Cloud communication is restored when the switch is turned on again. Cloud communications are also restored after a factory reset, or when the device is put in pairing mode.
diff --git a/source/_integrations/homeworks.markdown b/source/_integrations/homeworks.markdown
index 5ca1291f0027..962854f71017 100644
--- a/source/_integrations/homeworks.markdown
+++ b/source/_integrations/homeworks.markdown
@@ -2,14 +2,19 @@
title: Lutron Homeworks
description: How to use Lutron Homeworks Series 4 & 8 with Home Assistant.
ha_category:
+ - Binary sensor
+ - Button
- Hub
- Light
ha_release: 0.85
ha_iot_class: Local Push
ha_domain: homeworks
ha_platforms:
+ - binary_sensor
+ - button
- light
ha_integration_type: integration
+ha_config_flow: true
---
[Lutron](https://www.lutron.com/) is an American lighting control company. The Lutron Homeworks Series 4 & 8 systems are relatively old (~2003), and use RS-232 connections to communicate with home automation systems. The `homeworks` integration in Home Assistant is responsible for communicating with the main controller for these systems. Communication is through an ethernet to serial converter (NPort, for example).
@@ -18,67 +23,8 @@ Only a subset of the Homeworks system is supported - lights and keypads.
Lutron has created many systems over the years, each with their own unique interfacing protocol. There are three Homeworks systems - QS, Series 4 & 8, and original. This platform is only for Series 4 & 8. There is another integration [lutron](/integrations/lutron/) which handles Lutron RadioRA 2 systems.
-Homeworks keypad buttons are momentary switches. The button is pressed and released, meaning that there is no "state". Buttons generate `homeworks_button_press` and `homeworks_button_release` events. These events contain the "id", "name", and "button" of the button that was pressed. "id" is derived from "name", and "button" is the number of the button on the keypad (starting at 1).
+Homeworks keypad buttons are momentary switches. The button is pressed and released, meaning that there is no "state". Buttons generate `homeworks_button_press` and `homeworks_button_release` events. These events contain the "id", "name", and "button" of the button that was pressed. "id" is derived from "name", and "button" is the number of the button on the keypad (starting at 1). It's also possible to add binary sensor entities which indicate if a keypad LED is lit and button entities which can be used to trigger the actions bound to a keypad button.
-## Configuration
+{% include integrations/config_flow.md %}
-The protocol for automatically extracting device information from the controller isn't documented, so the `homeworks` integration must be configured manually. To use Lutron Homeworks devices in your installation, add the following to your `configuration.yaml` file:
-
-``` yaml
-# Example configuration.yaml entry
-homeworks:
- host: IP_ADDRESS
- port: 4001
- dimmers:
- - addr: "[02:08:01:01]"
- name: "Foyer Sconces"
- - addr: "[02:08:01:02]"
- name: "Foyer Downlights"
- rate: 2
-
- keypads:
- - addr: "[02:08:02:01]"
- name: "Foyer Keypad"
-```
-
-{% configuration %}
-host:
- description: The IP address of the ethernet to serial adapter. It is assumed that the adapter has been preconfigured.
- required: true
- type: string
-port:
- description: The port of the ethernet to serial adapter.
- required: true
- type: integer
-dimmers:
- description: List of dimmers.
- required: false
- type: list
- keys:
- addr:
- description: The unique address of the dimmer on the controller. The quotes, brackets, and number formatting must be of the form `"[##:##:##:##]"`.
- required: true
- type: string
- name:
- description: The name of the sensor will be the title of the button +`"_"` + the name of the keypad/
- required: true
- type: string
- rate:
- description: The amount of time (in seconds) for the light to transition to a new brightness level.
- required: false
- type: float
- default: 1
-keypads:
- description: List of keypads.
- required: false
- type: list
- keys:
- addr:
- description: The unique address of the keypad on the controller. The quotes, brackets, and number formatting must be of the form `"[##:##:##:##]"`.
- required: true
- type: string
- name:
- description: The name of the keypad.
- required: true
- type: string
-{% endconfiguration %}
+The protocol for automatically extracting device information from the controller isn't documented. Lights and keypads need to be added manually. This is done by configuring the integration after it has been added.
diff --git a/source/_integrations/http.markdown b/source/_integrations/http.markdown
index dcaff9ba8996..9c634d6ea02a 100644
--- a/source/_integrations/http.markdown
+++ b/source/_integrations/http.markdown
@@ -131,7 +131,7 @@ The `http` platforms are not real platforms within the meaning of the terminolog
To use those kind of [sensors](#sensor) or [binary sensors](#binary-sensor) in your installation no configuration in Home Assistant is needed. All configuration is done on the devices themselves. This means that you must be able to edit the target URL or endpoint and the payload. The entity will be created after the first message has arrived.
-Create a [Long-Lived Access Tokens](https://developers.home-assistant.io/docs/auth_api/#long-lived-access-token) in the Home Assistant UI at the bottom of your profile if you want to use HTTP sensors.
+If you want to use HTTP sensors, create a [Long-Lived Access Tokens](https://developers.home-assistant.io/docs/auth_api/#long-lived-access-token) in the Home Assistant UI in the **Security** section of your {% my profile title="**User profile**" %} page.
All [requests](https://developers.home-assistant.io/docs/api/rest#post-apistatesentity_id) need to be sent to the endpoint of the device and must be **POST**.
diff --git a/source/_integrations/humidifier.mqtt.markdown b/source/_integrations/humidifier.mqtt.markdown
index 2bb3bdb46245..4f5a4e5a8a76 100644
--- a/source/_integrations/humidifier.mqtt.markdown
+++ b/source/_integrations/humidifier.mqtt.markdown
@@ -174,12 +174,12 @@ json_attributes_topic:
max_humidity:
description: The minimum target humidity percentage that can be set.
required: false
- type: integer
+ type: float
default: 100
min_humidity:
description: The maximum target humidity percentage that can be set.
required: false
- type: integer
+ type: float
default: 0
name:
description: The name of the humidifier. Can be set to `null` if only the device name is relevant.
diff --git a/source/_integrations/husqvarna_automower.markdown b/source/_integrations/husqvarna_automower.markdown
index 5f4ee71af2a6..281c87a375eb 100644
--- a/source/_integrations/husqvarna_automower.markdown
+++ b/source/_integrations/husqvarna_automower.markdown
@@ -2,7 +2,10 @@
title: Husqvarna Automower
description: Instructions on how to integrate Husqvarna Automower lawn mowers into Home Assistant.
ha_category:
+ - Binary sensor
+ - Device tracker
- Lawn Mower
+ - Select
- Sensor
- Switch
ha_release: 2024.3
@@ -11,7 +14,11 @@ ha_config_flow: true
ha_codeowners:
- '@Thomas55555'
ha_platforms:
+ - binary_sensor
+ - device_tracker
+ - diagnostics
- lawn_mower
+ - select
- sensor
- switch
ha_integration_type: integration
@@ -75,12 +82,26 @@ The My Home Assistant redirect feature needs to be setup to redirect to your Hom
{% include integrations/config_flow.md %}
-
## Entities
Once you have enabled the Husqvarna Automower integration, you should see the following entities:
-### Lawn Mower
+### Binary sensor
+
+The integration will create the following binary sensors:
+
+- Battery charging
+ *The mower is currently charging. It reports this state if it autonomously returned to the dock due to low battery and if it leaves the dock for mowing after being fully charged.*
+- Leaving dock
+ *The mower is currently leaving the charging station and heading out to a starting point.*
+- Returning to dock
+ *The mower is on its way home to the charging station.*
+
+### Device tracker (if available)
+
+The integration will create a device tracker entity to show the position of the mower.
+
+### Lawn mower
The integration will create a lawn mower entity to control the mower. This entity can:
@@ -88,6 +109,10 @@ The integration will create a lawn mower entity to control the mower. This entit
- Pause mowing
- Park until next schedule
+### Select (if available)
+
+The integration will create a select entity for selecting the headlight mode of the mower.
+
### Sensor
The integration will create the following sensors:
diff --git a/source/_integrations/hyperion.markdown b/source/_integrations/hyperion.markdown
index 7b984db68619..69523f81b61a 100644
--- a/source/_integrations/hyperion.markdown
+++ b/source/_integrations/hyperion.markdown
@@ -14,6 +14,7 @@ ha_ssdp: true
ha_platforms:
- camera
- light
+ - sensor
- switch
ha_integration_type: integration
---
@@ -71,6 +72,10 @@ Please note that only the currently live Hyperion priority can be streamed, and
streamable sources will actually stream content (e.g., USB Capture Devices will work, but
static colors will not).
+## Sensors
+
+A sensor (Visible Priority) provides the effect currently displayed by the Hyperion server for the selected instance. Attributes of this sensor provide more details on the nature of the effect. For a detailed description, refer to the [Hyperion API](https://docs.hyperion-project.org/en/json/ServerInfo.html#priorities).
+
## Advanced entities
The Hyperion integration comes with a series of disabled-by-default entities for
diff --git a/source/_integrations/ifttt.markdown b/source/_integrations/ifttt.markdown
index 41cceed9735f..d73d606003d8 100644
--- a/source/_integrations/ifttt.markdown
+++ b/source/_integrations/ifttt.markdown
@@ -12,11 +12,11 @@ ha_platforms:
ha_integration_type: integration
---
-[IFTTT](https://ifttt.com) is a web service that allows users to create chains of simple conditional statements, so-called "Applets". With the IFTTT integration, you can trigger applets through the **"Webhooks"** service (which was previously the **"Maker"** channel).
+[IFTTT](https://ifttt.com) is a web service that allows users to create chains of simple conditional statements, so-called "Applets". With the IFTTT integration, you can trigger applets through the **"Webhooks"** service (which was previously the **"Maker"** channel). This requires the [Pro plan](https://ifttt.com/plans) or higher.
## Prerequisites
-To be able to receive events from IFTTT, your Home Assistant instance needs to be accessible from the web and you need to have the external URL [configured](/docs/configuration/basic), or use your Nabu Casa account's webhook URL from the IFTTT integration.
+To be able to receive events from IFTTT, your Home Assistant instance needs to be accessible from the web and you need to have the external URL [configured](/integrations/homeassistant/#allowlist_external_urls), or use your Nabu Casa account's webhook URL from the IFTTT integration.
{% include integrations/config_flow.md %}
@@ -111,11 +111,11 @@ When your screen looks like this, click the 'call service' button.
By default, the trigger is sent to all the API keys from `configuration.yaml`. If you
want to send the trigger to a specific key use the `target` field:
-Field | Value
------ | -----
-domain | `ifttt`
-service | `trigger`
-Service Data | `{"event": "EventName", "value1": "Hello World", "target": "YOUR_KEY_NAME1"}`
+| Field | Value |
+| ------------ | ----------------------------------------------------------------------------- |
+| domain | `ifttt` |
+| service | `trigger` |
+| Service Data | `{"event": "EventName", "value1": "Hello World", "target": "YOUR_KEY_NAME1"}` |
The `target` field can contain a single key name or a list of key names.
diff --git a/source/_integrations/image_upload.markdown b/source/_integrations/image_upload.markdown
index f45e0a852629..7bb4d2124672 100644
--- a/source/_integrations/image_upload.markdown
+++ b/source/_integrations/image_upload.markdown
@@ -1,5 +1,5 @@
---
-title: Image Upload
+title: Image upload
description: The image upload integration handle image assets in Home Assistant.
ha_category:
- Other
@@ -11,7 +11,7 @@ ha_quality_scale: internal
ha_integration_type: system
---
-The Image Upload integration allows Home Assistant to handle image assets in
+The **Image upload** {% term integration %} allows Home Assistant to handle image assets in
Home Assistant, for example, the profile photos of your systems account.
## Configuration
diff --git a/source/_integrations/input_boolean.markdown b/source/_integrations/input_boolean.markdown
index afd4e7064a50..3ea219ddc1af 100644
--- a/source/_integrations/input_boolean.markdown
+++ b/source/_integrations/input_boolean.markdown
@@ -1,6 +1,6 @@
---
-title: Input Boolean
-description: Instructions on how to use the Input Boolean helper with Home Assistant.
+title: Input boolean
+description: Instructions on how to use the input boolean helper with Home Assistant.
ha_category:
- Automation
- Helper
@@ -12,7 +12,7 @@ ha_domain: input_boolean
ha_integration_type: helper
---
-The Input Boolean helper integration allows you to define boolean values that
+The **Input boolean** helper integration allows you to define boolean values that
can be controlled via the user interface and can be used within conditions of
an {% term automation %}. This can for example be used to disable or enable certain
automations by using them in their {% term conditions %}.
@@ -67,12 +67,12 @@ This integration provides the following {% term services %} to modify the state
`input_boolean` and a service to reload the configuration without restarting
Home Assistant itself.
-| Service | Data | Description |
-| ------- | ---- | ----------- |
-| `turn_on` | `entity_id(s)``area_id(s)` | Set the value of specific `input_boolean` entities to `on` -| `turn_off` | `entity_id(s)`
`area_id(s)` | Set the value of specific `input_boolean` entities to `off` -| `toggle` | `entity_id(s)`
`area_id(s)` | Toggle the value of specific `input_boolean` entities -| `reload` | | Reload `input_boolean` configuration | +| Service | Data | Description | +| ---------- | ------------------------------ | ----------------------------------------------------------- | +| `turn_on` | `entity_id(s)`
`area_id(s)` | Set the value of specific `input_boolean` entities to `on` | +| `turn_off` | `entity_id(s)`
`area_id(s)` | Set the value of specific `input_boolean` entities to `off` | +| `toggle` | `entity_id(s)`
`area_id(s)` | Toggle the value of specific `input_boolean` entities | +| `reload` | | Reload `input_boolean` configuration | ### Restore state diff --git a/source/_integrations/input_button.markdown b/source/_integrations/input_button.markdown index 2e130827e4a0..36ccde149016 100644 --- a/source/_integrations/input_button.markdown +++ b/source/_integrations/input_button.markdown @@ -1,6 +1,6 @@ --- -title: Input Button -description: Instructions on how to use the Input Button helper with Home Assistant. +title: Input button +description: Instructions on how to use the input button helper with Home Assistant. ha_category: - Automation - Helper @@ -12,7 +12,7 @@ ha_domain: input_button ha_integration_type: helper --- -The Input Button helper integration allows you to define buttons that +The **Input button** helper integration allows you to define buttons that can be pressed via the user interface, and can be used to trigger things, like an automation. diff --git a/source/_integrations/input_number.markdown b/source/_integrations/input_number.markdown index 2b34c9d0a24f..cc9252568f53 100644 --- a/source/_integrations/input_number.markdown +++ b/source/_integrations/input_number.markdown @@ -1,6 +1,6 @@ --- -title: Input Number -description: Instructions on how to integrate the Input Number integration into Home Assistant. +title: Input number +description: Instructions on how to integrate the input number integration into Home Assistant. ha_category: - Automation - Helper @@ -12,7 +12,7 @@ ha_domain: input_number ha_integration_type: helper --- -The `input_number` integration allows the user to define values that can be controlled via the frontend and can be used within conditions of automation. The frontend can display a slider, or a numeric input box. Changes to the slider or numeric input box generate state events. These state events can be utilized as `automation` triggers as well. +The **Input number** {% term integration %} allows the user to define values that can be controlled via the frontend and can be used within conditions of automation. The frontend can display a slider, or a numeric input box. Changes to the slider or numeric input box generate state events. These state events can be utilized as `automation` triggers as well. The preferred way to configure an input number is via the user interface at **{% my helpers title="Settings > Devices & Services > Helpers" %}**. Click the add button and then choose the **{% my config_flow_start domain="input_number" title="Number" %}** option. @@ -87,12 +87,12 @@ input_number: This integration provides the following services to modify the state of the `input_number` and a service to reload the configuration without restarting Home Assistant itself. -| Service | Data | Description | -| ------- | ---- | ----------- | -| `decrement` | `entity_id(s)`
`area_id(s)` | Decrement the value of specific `input_number` entities by `step` -| `increment` | `entity_id(s)`
`area_id(s)` | Increment the value of specific `input_number` entities by `step` -| `reload` | | Reload `input_number` configuration | -| `set_value` | `value`
`entity_id(s)`
`area_id(s)` | Set the value of specific `input_number` entities +| Service | Data | Description | +| ----------- | ----------------------------------------- | ----------------------------------------------------------------- | +| `decrement` | `entity_id(s)`
`area_id(s)` | Decrement the value of specific `input_number` entities by `step` | +| `increment` | `entity_id(s)`
`area_id(s)` | Increment the value of specific `input_number` entities by `step` | +| `reload` | | Reload `input_number` configuration | +| `set_value` | `value`
`entity_id(s)`
`area_id(s)` | Set the value of specific `input_number` entities | ### Restore state diff --git a/source/_integrations/input_select.markdown b/source/_integrations/input_select.markdown index c7303e07e227..72900456e387 100644 --- a/source/_integrations/input_select.markdown +++ b/source/_integrations/input_select.markdown @@ -1,6 +1,6 @@ --- -title: Input Select -description: Instructions on how to integrate the Input Select integration into Home Assistant. +title: Input select +description: Instructions on how to integrate the input select integration into Home Assistant. ha_category: - Automation - Helper @@ -12,7 +12,7 @@ ha_domain: input_select ha_integration_type: helper --- -The `input_select` integration allows the user to define a list of values that can be selected via the frontend and can be used within conditions of an automation. When a user selects a new item, a state transition event is generated. This state event can be used in an `automation` trigger. +The **Input select** {% term integration %} allows the user to define a list of values that can be selected via the frontend and can be used within conditions of an automation. When a user selects a new item, a state transition event is generated. This state event can be used in an `automation` trigger. The preferred way to configure an input select is via the user interface at **{% my helpers title="Settings > Devices & Services > Helpers" %}**. Click the add button and then choose the **{% my config_flow_start domain="input_select" title="Dropdown" %}** option. @@ -77,29 +77,29 @@ If you set a valid value for `initial` this integration will start with the stat This integration provides three services to modify the state of the `input_select`. -| Service | Data | Description | -| ------- | ---- | ----------- | -| `select_option` | `option` | This can be used to select a specific option. -| `set_options` | `options`
`entity_id(s)` | Set the options for specific `input_select` entities. -| `select_first` | | Select the first option. -| `select_last` | | Select the last option. -| `reload` | | Reload `input_select` configuration | +| Service | Data | Description | +| --------------- | --------------------------- | ----------------------------------------------------- | +| `select_option` | `option` | This can be used to select a specific option. | +| `set_options` | `options`
`entity_id(s)` | Set the options for specific `input_select` entities. | +| `select_first` | | Select the first option. | +| `select_last` | | Select the last option. | +| `reload` | | Reload `input_select` configuration | #### Service `input_select.select_next` Select the next option. -| Service data attribute | Optional | Description | -| ---------------------- | -------- | ----------- | -| `cycle` | yes | Whether to cycle to the first value after the last. Default: `true` +| Service data attribute | Optional | Description | +| ---------------------- | -------- | ------------------------------------------------------------------- | +| `cycle` | yes | Whether to cycle to the first value after the last. Default: `true` | #### Service `input_select.select_previous` Select the previous option. -| Service data attribute | Optional | Description | -| ---------------------- | -------- | ----------- | -| `cycle` | yes | Whether to cycle to the last value before the first. Default: `true` +| Service data attribute | Optional | Description | +| ---------------------- | -------- | -------------------------------------------------------------------- | +| `cycle` | yes | Whether to cycle to the last value before the first. Default: `true` | ### Scenes diff --git a/source/_integrations/input_text.markdown b/source/_integrations/input_text.markdown index ad7fde933508..8a57b8309877 100644 --- a/source/_integrations/input_text.markdown +++ b/source/_integrations/input_text.markdown @@ -1,6 +1,6 @@ --- -title: Input Text -description: Instructions on how to integrate the Input Text integration into Home Assistant. +title: Input text +description: Instructions on how to integrate the Input text integration into Home Assistant. ha_category: - Automation - Helper @@ -12,7 +12,7 @@ ha_domain: input_text ha_integration_type: helper --- -The `input_text` integration allows the user to define values that can be controlled via the frontend and can be used within conditions of automation. Changes to the value stored in the text box generate state events. These state events can be utilized as `automation` triggers as well. It can also be configured in password mode (obscured text). +The **Input text** {% term integration %} allows the user to define values that can be controlled via the frontend and can be used within conditions of automation. Changes to the value stored in the text box generate state events. These state events can be utilized as `automation` triggers as well. It can also be configured in password mode (obscured text). The preferred way to configure an input text is via the user interface at **{% my helpers title="Settings > Devices & Services > Helpers" %}**. Click the add button and then choose the **{% my config_flow_start domain="input_text" title="Text" %}** option. @@ -83,10 +83,10 @@ input_text: This integration provides a service to modify the state of the `input_text` and a service to reload the `input_text` configuration without restarting Home Assistant itself. -| Service | Data | Description | -| ------- | ---- | ----------- | -| `set_value` | `value`
`entity_id(s)` | Set the value for specific `input_text` entities. -| `reload` | | Reload `input_text` configuration | +| Service | Data | Description | +| ----------- | ------------------------- | ------------------------------------------------- | +| `set_value` | `value`
`entity_id(s)` | Set the value for specific `input_text` entities. | +| `reload` | | Reload `input_text` configuration | ### Restore state diff --git a/source/_integrations/ipma.markdown b/source/_integrations/ipma.markdown index 85351853890a..378c143b06e4 100644 --- a/source/_integrations/ipma.markdown +++ b/source/_integrations/ipma.markdown @@ -10,6 +10,7 @@ ha_codeowners: - '@dgomes' ha_domain: ipma ha_platforms: + - diagnostics - sensor - weather ha_integration_type: integration diff --git a/source/_integrations/juicenet.markdown b/source/_integrations/juicenet.markdown new file mode 100644 index 000000000000..e4add243f456 --- /dev/null +++ b/source/_integrations/juicenet.markdown @@ -0,0 +1,49 @@ +--- +title: JuiceNet +description: Instructions on how to setup WiFi-equipped JuiceNet/JuiceBox charging stations with Home Assistant. +ha_category: + - Car + - Energy + - Number + - Sensor + - Switch +ha_iot_class: Cloud Polling +ha_release: 0.47 +ha_codeowners: + - '@jesserockz' +ha_domain: juicenet +ha_config_flow: true +ha_platforms: + - number + - sensor + - switch +ha_integration_type: integration +--- + +The `juicenet` platform pulls data from a [JuiceNet](https://evcharging.enelx.com/products/juicebox) charging station equipped with a Wi-Fi connection. It will access and make available all of the devices attached to your account. It also exposes a switch allowing you to charge your car now instead of waiting for the pre-set schedule. + +{% include integrations/config_flow.md %} + +## Sensor + +The `juicenet` sensor platform allows you to get data from your [JuiceNet](https://evcharging.enelx.com/products/juicebox) charger. + +### Added sensors + +These sensors will be added for each JuiceNet device in your account: + +- Status +- Temperature (inside the device) +- Voltage +- Amps +- Watts +- Charge time of session +- Energy added this session + +## Switch + +The `juicenet` switch platform allows you to override the charging schedule for your JuiceNet device. + +## Number + +The `juicenet` number platform allows you to control the charging amperage limit. diff --git a/source/_integrations/jvc_projector.markdown b/source/_integrations/jvc_projector.markdown index 2d1b72df5913..47f4948cb4e6 100644 --- a/source/_integrations/jvc_projector.markdown +++ b/source/_integrations/jvc_projector.markdown @@ -13,6 +13,7 @@ ha_domain: jvc_projector ha_platforms: - binary_sensor - remote + - sensor ha_integration_type: device --- @@ -61,5 +62,25 @@ The JVC Projector remote platform will create a [Remote](/integrations/remote/) ### Binary sensor -The status reported is: -- **Power on** is **True** when the projector is either in status **on** or **warming**. +The following sensor types are supported: + +- Power on is True when projector is in status "on", "warming" + +### Sensor + +Introduces two sensors to detect Power Status and HDMI Input. + +Detailed Power Status values: + +- `standby` +- `on` +- `warming` +- `cooling` +- `error` + +Please note that if the projector is off, it will not respond to remote polling and will show as *unavailable*. + +Detailed HDMI Input values: + +- `hdmi1` +- `hdmi2` diff --git a/source/_integrations/kitchen_sink.markdown b/source/_integrations/kitchen_sink.markdown index ef190583c5bc..9e0c80ccfe3a 100644 --- a/source/_integrations/kitchen_sink.markdown +++ b/source/_integrations/kitchen_sink.markdown @@ -12,6 +12,7 @@ ha_iot_class: Calculated ha_platforms: - button - image + - lawn_mower - lock - sensor - switch diff --git a/source/_integrations/konnected.markdown b/source/_integrations/konnected.markdown index 717107ad37d9..36df0a6f4ed8 100644 --- a/source/_integrations/konnected.markdown +++ b/source/_integrations/konnected.markdown @@ -111,7 +111,7 @@ Once all zones are configured you'll be presented with the configuration for add **Blink panel LED on when sending state change:** The desired LED behavior for the panel. -**Override default Home Assistant API host panel URL:** The Konnected Alarm Panel post sensor states back to the Home Assistant API. If this value is unchecked the panel will default postbacks using the URL [configured](/docs/configuration/basic) in Home Assistant. By default, the integration will use the internal URL. However, if you check this field and set the **Override API host URL** to your _local_ IP address and port (e.g., `http://192.168.1.101:8123`), it will be used instead of the internal URL. +**Override default Home Assistant API host panel URL:** The Konnected Alarm Panel post sensor states back to the Home Assistant API. If this value is unchecked the panel will default postbacks using the URL [configured](/integrations/homeassistant/#allowlist_external_urls) in Home Assistant. By default, the integration will use the internal URL. However, if you check this field and set the **Override API host URL** to your _local_ IP address and port (e.g., `http://192.168.1.101:8123`), it will be used instead of the internal URL. **Override API host URL (optional):** The host info to use if you checked **Override default Home Assistant API host panel URL** in the step above. This is ignored if **Override default Home Assistant API host panel URL** is unchecked. diff --git a/source/_integrations/lamarzocco.markdown b/source/_integrations/lamarzocco.markdown index d762df7a9ff8..4dfa142916f8 100644 --- a/source/_integrations/lamarzocco.markdown +++ b/source/_integrations/lamarzocco.markdown @@ -18,15 +18,18 @@ ha_platforms: - sensor - switch - update +ha_bluetooth: true ha_codeowners: - '@zweckj' ha_integration_type: device --- -This integration interacts with [La Marzocco coffee machines](https://lamarzocco.com/it/en/) through calls to the LaMarzocco cloud API and (optionally) local API calls, which include a WebSocket connection for (near) real-time updates. +This integration interacts with [La Marzocco coffee machines](https://lamarzocco.com/it/en/) through calls to the LaMarzocco cloud API. Optionally, local API calls, which include a WebSocket connection for (near) real-time updates and a Bluetooth connection, can be utilized for local connections. To be able to configure your machine in Home Assistant, your machine needs to be added to your account using the official La Marzocco app first. Currently, only login with username & password is supported. If you are currently using a social login, you need to create a new LaMarzocco account and transfer your machine to it to be able to use this integration. +If your machine is in Bluetooth range to your Home Assistant host and the [Bluetooth](/integrations/bluetooth) integration is fully loaded, the machine will be discovered automatically. + {% include integrations/config_flow.md %} diff --git a/source/_integrations/lawn_mower.mqtt.markdown b/source/_integrations/lawn_mower.mqtt.markdown index 3260c3ba0234..d8c58a267422 100644 --- a/source/_integrations/lawn_mower.mqtt.markdown +++ b/source/_integrations/lawn_mower.mqtt.markdown @@ -177,7 +177,7 @@ qos: type: integer default: 0 start_mowing_template: - description: Defines a [template](/docs/configuration/templating/#using-templates-with-the-mqtt-integration) to generate the payload to send to `dock_command_topic`. The `value` parameter in the template will be set to `dock`. + description: Defines a [template](/docs/configuration/templating/#using-templates-with-the-mqtt-integration) to generate the payload to send to `start_mowing_command_topic`. The `value` parameter in the template will be set to `start_mowing`. required: false type: template start_mowing_command_topic: @@ -210,7 +210,7 @@ The example below shows how to use a single command topic with a command templat ```yaml # Example configuration.yaml entry mqtt: - - alarm_control_panel: + - lawn_mower: name: "Lawn Mower Plus" activity_state_topic: "lawn_mower_plus/state" activity_value_template: "{{ value_json.activity }}" diff --git a/source/_integrations/light.mqtt.markdown b/source/_integrations/light.mqtt.markdown index 9bc7cbbde59b..31ee29164a18 100644 --- a/source/_integrations/light.mqtt.markdown +++ b/source/_integrations/light.mqtt.markdown @@ -40,7 +40,7 @@ When a state topic is not available, the light will work in optimistic mode. In Optimistic mode can be forced, even if the `state_topic` is available. Try to enable it, if experiencing incorrect light operation. Home Assistant internally assumes that a light's state corresponds to a defined `color_mode`. -The state of MQTT lights with default schema and support for both color and color temperature will set the `color_mode` according to the last received valid color or color temperature. Optionally, a `color_mode_state_topic` can be configured for explicit control of the `color_mode` +The state of MQTT lights with default schema and support for both color and color temperature will set the `color_mode` according to the last received valid color or color temperature. Optionally, a `color_mode_state_topic` can be configured for explicit control of the `color_mode`. ```yaml # Example configuration.yaml entry @@ -563,7 +563,7 @@ availability_topic: required: false type: string brightness: - description: Flag that defines if the light supports brightness. + description: Flag that defines if light supports brightness when the `rgb`, `rgbw`, or `rgbww` color mode is supported. required: false type: boolean default: false @@ -572,11 +572,6 @@ brightness_scale: required: false type: integer default: 255 -color_mode: - description: Flag that defines if the light supports color modes. - required: false - type: boolean - default: false command_topic: description: The MQTT topic to publish commands to change the light’s state. required: true @@ -715,7 +710,7 @@ state_topic: required: false type: string supported_color_modes: - description: A list of color modes supported by the list. This is required if `color_mode` is `True`. Possible color modes are `onoff`, `brightness`, `color_temp`, `hs`, `xy`, `rgb`, `rgbw`, `rgbww`, `white`. Note that if `onoff` **or** `brightness` are used, that must be the _only_ value in the list. + description: A list of color modes supported by the list. Possible color modes are `onoff`, `brightness`, `color_temp`, `hs`, `xy`, `rgb`, `rgbw`, `rgbww`, `white`. Note that if `onoff` **or** `brightness` are used, that must be the _only_ value in the list. required: false type: list unique_id: @@ -758,7 +753,6 @@ mqtt: state_topic: "home/rgb1" command_topic: "home/rgb1/set" brightness: true - color_mode: true supported_color_modes: ["rgb"] ``` @@ -775,7 +769,6 @@ mqtt: state_topic: "home/rgb1" command_topic: "home/rgb1/set" brightness: true - color_mode: true supported_color_modes: ["brightness"] ``` @@ -793,7 +786,6 @@ mqtt: command_topic: "home/light/set" brightness: true brightness_scale: 4095 - color_mode: true supported_color_modes: ["brightness"] ``` @@ -817,7 +809,6 @@ mqtt: name: mqtt_json_hs_light state_topic: "home/light" command_topic: "home/light/set" - color_mode: true supported_color_modes: ["hs"] ``` @@ -847,7 +838,6 @@ mqtt: state_topic: "home/rgbw1" command_topic: "home/rgbw1/set" brightness: true - color_mode: true supported_color_modes: ["rgbw"] ``` diff --git a/source/_integrations/local_calendar.markdown b/source/_integrations/local_calendar.markdown index d0ad2e59ed05..e2cd8c251da0 100644 --- a/source/_integrations/local_calendar.markdown +++ b/source/_integrations/local_calendar.markdown @@ -1,6 +1,6 @@ --- -title: Local Calendar -description: Instructions on how to use Local Calendars in Home Assistant. +title: Local calendar +description: Instructions on how to use local calendars in Home Assistant. ha_category: - Calendar ha_iot_class: Local Polling @@ -15,7 +15,7 @@ ha_codeowners: ha_integration_type: integration --- -The local calendar integration allows you to create a calendar of events in Home Assistant for powering automations. +The **Local calendar** {% term integration %} allows you to create a calendar of events in Home Assistant for powering automations. A calendar entity has a state and attributes that represent the next upcoming event (only). A calendar trigger is a much more flexible way to power automations with fewer limitations than using the entity state. diff --git a/source/_integrations/local_file.markdown b/source/_integrations/local_file.markdown index a1594b19d2d6..ca49a1ded323 100644 --- a/source/_integrations/local_file.markdown +++ b/source/_integrations/local_file.markdown @@ -1,6 +1,6 @@ --- -title: Local File -description: Instructions how to use Local File as a Camera within Home Assistant. +title: Local file +description: Instructions how to use local file as a camera within Home Assistant. ha_category: - Camera ha_iot_class: Local Polling @@ -11,7 +11,7 @@ ha_platforms: ha_integration_type: integration --- -The `local_file` camera platform allows you to integrate an image file from disk into Home Assistant as a camera. If the image is updated on the file system the image displayed in Home Assistant will also be updated. The service `local_file.update_file_path` can be used to update the image using an automation. +The **Local file** camera {% term integration %} allows you to integrate an image file from disk into Home Assistant as a camera. If the image is updated on the file system the image displayed in Home Assistant will also be updated. The service `local_file.update_file_path` can be used to update the image using an automation. The `local_file` camera can for example be used with various camera platforms that save a temporary images locally. It can also be used to display a graph that you render periodically and will then be displayed in Home Assistant. @@ -41,7 +41,7 @@ name: Use this service to change the file displayed by the camera. -| Service data attribute | Description | -| -----------------------| ----------- | -| `entity_id` | String of the `entity_id` of the camera to update. | -| `file_path` | The full path to the new image file to be displayed. | +| Service data attribute | Description | +| ---------------------- | ---------------------------------------------------- | +| `entity_id` | String of the `entity_id` of the camera to update. | +| `file_path` | The full path to the new image file to be displayed. | diff --git a/source/_integrations/local_todo.markdown b/source/_integrations/local_todo.markdown index 19aadb9bb15f..f7602092bcbc 100644 --- a/source/_integrations/local_todo.markdown +++ b/source/_integrations/local_todo.markdown @@ -12,9 +12,14 @@ ha_codeowners: ha_integration_type: integration ha_platforms: - todo +related: + - docs: /integrations/todo/ + title: To-do list integration documentation + - docs: /dashboards/todo-list/ + title: To-do list card --- -The **Local to-do list** integration allows you to create to-do lists in Home Assistant. +The **Local to-do list** {% term integration %} allows you to create to-do lists in Home Assistant. To-do lists are shown on the **To-do list** dashboard for tracking items and whether or not they have been completed. @@ -22,8 +27,3 @@ See the [**To-do list** integration](/integrations/todo) for additional details about to-do list entities. {% include integrations/config_flow.md %} - -## Related topics - -- [**To-do list** integration](/integrations/todo) -- [Shopping list card](/dashboards/shopping-list/) \ No newline at end of file diff --git a/source/_integrations/lutron_caseta.markdown b/source/_integrations/lutron_caseta.markdown index 6c64992f5499..ca13682b775c 100644 --- a/source/_integrations/lutron_caseta.markdown +++ b/source/_integrations/lutron_caseta.markdown @@ -113,7 +113,7 @@ Use a DHCP reservation on your router to reserve the address or in the PRO model
-Devices that are currently at home won't show on the map.
-
-
-
-
-This map always shows the location of all tracked devices. If you want to hide certain entities, you should look into the [Map Card](/dashboards/map/).
-
-
diff --git a/source/_integrations/matrix.markdown b/source/_integrations/matrix.markdown
index 5b8ad02b746a..48cfb641a394 100644
--- a/source/_integrations/matrix.markdown
+++ b/source/_integrations/matrix.markdown
@@ -218,7 +218,7 @@ action:
-If you need to include a file from an external folder in your notifications, you will have to [list the source folder as allowed](/docs/configuration/basic/).
+If you need to include a file from an external folder in your notifications, you will have to [list the source folder as allowed](/integrations/homeassistant/#allowlist_external_dirs).
```yaml
configuration.yaml
diff --git a/source/_integrations/matter.markdown b/source/_integrations/matter.markdown
index 01e786283bf7..7e070a96b225 100644
--- a/source/_integrations/matter.markdown
+++ b/source/_integrations/matter.markdown
@@ -26,6 +26,13 @@ ha_platforms:
- sensor
- switch
ha_integration_type: integration
+related:
+ - docs: /integrations/thread/
+ title: Thread
+ - docs: /integrations/homekit_controller/
+ title: HomeKit
+ - docs: /integrations/homekit_controller/#adding-a-homekit-device-through-thread
+ title: Adding an Apple HomeKit device through Thread
---
The Matter integration allows you to control Matter devices on your local Wi-Fi or {% term Thread %} network.
@@ -138,8 +145,8 @@ This guide describes how to add a new device. This will use the Bluetooth connec
1. Open The Home Assistant app on your phone.
2. Go to {% my integrations title="**Settings** > **Devices & services**" %}.
-3. On the **Devices** tab, select the **Add device** button.
-4. Select **Add Matter device**.
+3. On the **Devices** tab, select the **Add device** button, and select **Add Matter device**.
+4. In the dialog, select **No, it's new.**.
5. Scan the QR-code of the Matter device with your phone camera or select **More options...** to manually enter the Commission code.
6. Select **Add to Home Assistant**.
- This starts the commissioning process which may take a few minutes.
@@ -151,8 +158,6 @@ This guide describes how to add a new device. This will use the Bluetooth connec
9. Once the process is complete, select **Done**.
- You are now redirected to the device page within Home Assistant. It is ready for use.
-
+ 
+ Screencast showing how to add a new Matter device to Home Assistant.
+
+ 
+ Screencast showing how to share a Matter device from Apple Home.
+
- If you want to use media from a network storage, the network storage must first be connected first. Refer to [these instructions on how to connect network storage](/common-tasks/os/#network-storage).
+ If you want to use media from a network storage, the network storage must be connected first. Refer to [these instructions on how to connect network storage](/common-tasks/os/#network-storage).
The media from the network storage is then automatically added to the local media browser.
@@ -99,4 +99,4 @@ data:
media_content_id: "media-source://media_source/local/videos/favourites/Epic Sax Guy 10 Hours.mp4"
```
-[basic-configuration]: /docs/configuration/basic/#media_dirs
+[basic-configuration]: /integrations/homeassistant/#media_dirs
\ No newline at end of file
diff --git a/source/_integrations/microbees.markdown b/source/_integrations/microbees.markdown
index 054e73879e66..28f0763db0e3 100644
--- a/source/_integrations/microbees.markdown
+++ b/source/_integrations/microbees.markdown
@@ -3,6 +3,7 @@ title: microBees
description: Instructions on how to integrate microBees devices into Home Assistant.
ha_category:
- Button
+ - Cover
- Light
- Sensor
- Switch
@@ -13,7 +14,9 @@ ha_config_flow: true
ha_domain: microbees
ha_iot_class: Cloud Polling
ha_platforms:
+ - binary_sensor
- button
+ - cover
- light
- sensor
- switch
@@ -27,8 +30,12 @@ To retrieve the OAuth2 Client ID and Client Secret go to [microBees Developer Da
There is currently support for the following device types within Home Assistant:
- **Switch**
+- **Cover**
+- **Binary sensors**
- **Button**
- **Light**
- **Sensor**
-
+
+Note: The cover status will be unknown
+
{% include integrations/config_flow.md %}
diff --git a/source/_integrations/minio.markdown b/source/_integrations/minio.markdown
index 7ac507c75803..20ae31afb3f1 100644
--- a/source/_integrations/minio.markdown
+++ b/source/_integrations/minio.markdown
@@ -14,7 +14,7 @@ ha_integration_type: integration
This integration adds interaction with [Minio](https://min.io).
It also enables listening for bucket notifications: [see documentation](https://docs.min.io/docs/minio-client-complete-guide.html#watch)
-To download or upload files, folders must be added to [allowlist_external_dirs](/docs/configuration/basic/).
+To download or upload files, folders must be added to [allowlist_external_dirs](/integrations/homeassistant/#allowlist_external_dirs).
## Configuration
@@ -133,27 +133,27 @@ These services are provided:
Download file.
-| Service data attribute | Required | Description |
-|---------------------------|----------|---------------------------------------------------|
-| `bucket` | yes | Bucket to use |
-| `key` | yes | Object key of the file |
-| `file_path` | yes | File path on the local file system |
+| Service data attribute | Required | Description |
+| ---------------------- | -------- | ---------------------------------- |
+| `bucket` | yes | Bucket to use |
+| `key` | yes | Object key of the file |
+| `file_path` | yes | File path on the local file system |
### Service `minio.put`
Upload file.
-| Service data attribute | Required | Description |
-|---------------------------|----------|---------------------------------------------------|
-| `bucket` | yes | Bucket to use |
-| `key` | yes | Object key of the file |
-| `file_path` | yes | File path on the local file system |
+| Service data attribute | Required | Description |
+| ---------------------- | -------- | ---------------------------------- |
+| `bucket` | yes | Bucket to use |
+| `key` | yes | Object key of the file |
+| `file_path` | yes | File path on the local file system |
### Service `minio.remove`
Delete file.
-| Service data attribute | Required | Description |
-|---------------------------|----------|---------------------------------------------------|
-| `bucket` | yes | Bucket to use |
-| `key` | yes | Object key of the file |
+| Service data attribute | Required | Description |
+| ---------------------- | -------- | ---------------------- |
+| `bucket` | yes | Bucket to use |
+| `key` | yes | Object key of the file |
diff --git a/source/_integrations/modbus.markdown b/source/_integrations/modbus.markdown
index e1d04a81fd43..db98da4c3dc1 100644
--- a/source/_integrations/modbus.markdown
+++ b/source/_integrations/modbus.markdown
@@ -16,7 +16,7 @@ ha_platforms:
- light
- sensor
- switch
-ha_quality_scale: gold
+ha_quality_scale: platinum
ha_integration_type: integration
---
@@ -339,10 +339,12 @@ modbus:
modbus entities are grouped below each modbus communication entry.
-All modbus entities have the following parameters:
+**REMARK** Each modbus device must have at least 1 entity defined, otherwise the integration will not be loaded.
Please refer to [Parameter usage](#parameters-usage-matrix) for conflicting parameters.
+All modbus entities have the following parameters:
+
{% configuration %}
address:
description: "Address of coil/register."
@@ -735,9 +737,9 @@ climates:
word_byte:
description: "Swap word ABCD -> DCBA, **not valid with data types: `int16`, `uint16`**"
target_temp_register:
- description: "Register address for target temperature (Setpoint)."
+ description: "Register address for target temperature (Setpoint). Using a list, it is possible to define one register for each of the available HVAC Modes. The list has to have a fixed size of 7 registers corresponding to the 7 available HVAC Modes, as follows: Register **1: HVAC AUTO mode**; Register **2: HVAC Cool mode**; Register **3: HVAC Dry mode**; Register **4: HVAC Fan only mode**; Register **5: HVAC Heat mode**; Register **6: HVAC Heat Cool mode**; Register **7: HVAC OFF mode**. It is possible to set duplicated values for the modes where the devices has not a related register."
required: true
- type: integer
+ type: [integer, list]
target_temp_write_registers:
description: "If `true` use `write_registers` for target temperature."
required: false
diff --git a/source/_integrations/motionblinds_ble.markdown b/source/_integrations/motionblinds_ble.markdown
new file mode 100644
index 000000000000..aee84394c9f6
--- /dev/null
+++ b/source/_integrations/motionblinds_ble.markdown
@@ -0,0 +1,66 @@
+---
+title: Motionblinds Bluetooth
+description: Instructions on how to integrate Motionblinds Bluetooth motors into Home Assistant.
+ha_category:
+ - Cover
+ha_iot_class: Assumed State
+ha_release: 2024.4
+ha_domain: motionblinds_ble
+ha_codeowners:
+ - '@LennP'
+ - '@jerrybboy'
+ha_config_flow: true
+ha_platforms:
+ - button
+ - cover
+ - select
+ha_integration_type: device
+---
+
+This {% term integration %} adds support for [Motionblinds](https://motionblinds.com/) Bluetooth motors. Want to motorize your existing blinds? This can be done with Motionblinds motor CMD-03. Made-to-measure window coverings with Motionblinds are available through a worldwide reseller network.
+Beware that this integration does not work with Eve Motionblinds motors. Eve Motionblinds can be added to Home Assistant using the [HomeKit Device](https://www.home-assistant.io/integrations/homekit_controller/) integration or the [Matter](https://www.home-assistant.io/integrations/matter/) integration.
+
+{% include integrations/config_flow.md %}
+
+## Setup
+
+During the setup of a Motionblinds Bluetooth motor, you will be asked what kind of blind you have. There are 8 different blind types:
+
+- **Roller blind**: has the ability to change position and speed.
+- **Honeycomb blind**: has the ability to change position and speed.
+- **Roman blind**: has the ability to change position and speed.
+- **Venetian blind**: has the ability to change position, tilt, and speed.
+- **Venetian blind (tilt-only)**: has the ability to change tilt and speed.
+- **Double Roller blind**: has the ability to change position, tilt, and speed.
+- **Curtain blind**: has the ability to change position. May need to be calibrated if the end positions are lost, which can be done by using the open/close cover button or the set cover position slider. This will trigger a calibration which will first make the curtain find the end positions after which it will run to the position as indicated by the command that was given.
+- **Vertical blind**: has the ability to change position and tilt. May need to be calibrated if the end positions are lost, which must be done using the Motionblinds Bluetooth app.
+
+## Entities
+
+The following entities are available for a Motionblinds Bluetooth device:
+
+- [Cover](https://www.home-assistant.io/integrations/cover/) entity: depending on the blind that was chosen during the setup, this entity has a slider that makes it possible to change position and tilt, and buttons that allow you to open the blind, close the blind, tilt it open, tilt it closed and stop it.
+- [Button](https://www.home-assistant.io/integrations/button/) entities:
+ - Connect button: allows you to connect to the blind.
+ - Disconnect button: allows you to disconnect the blind.
+ - Favorite button: allows you to move the blind to the favorite position.
+- [Select](https://www.home-assistant.io/integrations/select/) entities:
+ - Speed select: allows you to change the speed of the motor to low, medium, or high. Available for all blinds except curtain blinds and vertical blinds.
+
+## Services
+
+Since Motionblinds Bluetooth motors require a Bluetooth connection to control them, Home Assistant does not get automatic updates of the motor's state by default. Therefore, you can use the [homeassistant.update_entity](https://www.home-assistant.io/docs/scripts/service-calls/#homeassistant-services) service on any entity belonging to a Motionblinds Bluetooth device, which will connect to your Motionblinds Bluetooth motor and update the state of all entities belong to that device. However, be aware that doing so may impact battery life.
+
+This can also be automated using a YAML automation. For instance, the following automation connects to your Motionblind every 24 hours to update its state in Home Assistant:
+
+```yaml
+alias: Motionblinds Bluetooth polling automation
+mode: single
+trigger:
+ - platform: time_pattern
+ hours: "/24"
+action:
+ - service: homeassistant.update_entity
+ target:
+ entity_id: cover.motion_shade
+```
diff --git a/source/_integrations/mqtt.markdown b/source/_integrations/mqtt.markdown
index 158f329f35a8..9542dcaa3d46 100644
--- a/source/_integrations/mqtt.markdown
+++ b/source/_integrations/mqtt.markdown
@@ -25,6 +25,7 @@ ha_platforms:
- fan
- humidifier
- image
+ - lawn_mower
- light
- lock
- number
@@ -111,14 +112,11 @@ MQTT (aka MQ Telemetry Transport) is a machine-to-machine or "Internet of Things
{% enddetails %}
-
Your first step to get MQTT and Home Assistant working is to choose a broker.
-## Choose an MQTT broker
-
-### Run your own
+## Setting up a broker
-The most private option is running your own MQTT broker.
+While public MQTT brokers are available, the easiest and most private option is running your own.
The recommended setup method is to use the [Mosquitto MQTT broker add-on](https://github.com/home-assistant/hassio-addons/blob/master/mosquitto/DOCS.md).
@@ -129,10 +127,6 @@ There are [at least two](https://issues.apache.org/jira/browse/AMQ-6360) [issues
-### Use a public broker
-
-The Mosquitto project runs a [public broker](https://test.mosquitto.org). This is the easiest to set up, but there is no privacy as all messages are public. Use this only for testing purposes and not for real tracking of your devices or controlling your home. To use the public mosquitto broker, configure the MQTT integration to connect to broker `test.mosquitto.org` on port 1883 or 8883.
-
## Broker configuration
MQTT broker settings are configured when the MQTT integration is first set up and can be changed later if needed.
@@ -144,7 +138,12 @@ Add the MQTT integration, then provide your broker's hostname (or IP address) an
3. Select **Configure**, then **Re-configure MQTT**.
+
### Advanced broker configuration
@@ -174,14 +173,14 @@ If the server certificate does not match the hostname then validation will fail.
The MQTT protocol setting defaults to version `3.1.1`. If your MQTT broker supports MQTT version 5 you can set the protocol setting to `5`.
-#### Securing the the connection
+#### Securing the connection
With a secure broker connection it is possible to use a client certificate for authentication. To set the client certificate and private key turn on the option `Use a client certificate` and click "Next" to show the controls to upload the files. Only a PEM encoded client certificates together with a PEM encoded private key can be uploaded. Make sure the private key has no password set.
#### Using WebSockets as transport
You can select `websockets` as transport method if your MQTT broker supports it. When you select `websockets` and click `NEXT`, you will be able to add a WebSockets path (default = `/`) and WebSockets headers (optional). The target WebSockets URI: `ws://{broker}:{port}{WebSockets path}` is built with `broker`, `port` and `ws_path` (WebSocket path) settings.
-To configure the WebSocketS headers supply a valid JSON dictionary string. E.g. `{ "Authorization": "token" , "x-header": "some header"}`. The default transport method is `tcp`. The WebSockets transport can be secured using TLS and optionally using user credentials or a client certificate.
+To configure the WebSocket's headers supply a valid JSON dictionary string. E.g. `{ "Authorization": "token" , "x-header": "some header"}`. The default transport method is `tcp`. The WebSockets transport can be secured using TLS and optionally using user credentials or a client certificate.
+ If you experience an error message like `Failed to connect due to exception: [SSL: CERTIFICATE_VERIFY_FAILED] certificate verify failed`, then turn on `Advanced options` and set [Broker certificate validation](/integrations/mqtt/#broker-certificate-validation) to `Auto`. + + +
@@ -327,7 +326,6 @@ support_url:
description: Support URL of the application that supplies the discovered MQTT item.
{% endconfiguration_basic %}
-
{% details "Supported abbreviations" %}
```txt
@@ -599,7 +597,9 @@ support_url:
'sa': 'suggested_area',
'sn': 'serial_number',
```
+
{% enddetails %}
+
{% details "Supported abbreviations for origin info" %}
```txt
@@ -607,6 +607,7 @@ support_url:
'sw': 'sw_version',
'url': 'support_url',
```
+
{% enddetails %}
### How to use discovery messages
@@ -739,6 +740,7 @@ The following software has built-in support for MQTT discovery:
- [Xiaomi DaFang Hacks](https://github.com/EliasKotlyar/Xiaomi-Dafang-Hacks)
- [Zehnder Comfoair RS232 MQTT](https://github.com/adorobis/hacomfoairmqtt)
- [Zigbee2MQTT](https://github.com/koenkk/zigbee2mqtt)
+- [OTGateway](https://github.com/Laxilef/OTGateway)
### Discovery examples
@@ -1053,16 +1055,15 @@ The MQTT notification support is different than for the other [notification](/in
```
-To be able to receive events from [Netatmo](https://www.netatmo.com/), your Home Assistant instance needs to be accessible from the web over port `443`. To achieve this you can either use your Nabu Casa account or for example Duck DNS ([Home Assistant instructions](/addons/duckdns/)). You also need to have the external URL configured in the Home Assistant [configuration](/docs/configuration/basic).
+To be able to receive events from [Netatmo](https://www.netatmo.com/), your Home Assistant instance needs to be accessible from the web over port `443`. To achieve this you can either use your Nabu Casa account or for example Duck DNS ([Home Assistant instructions](/addons/duckdns/)). You also need to have the external URL configured in the Home Assistant [configuration](/integrations/homeassistant/#allowlist_external_urls).
Events coming in from Netatmo will be available as an event in Home Assistant and are fired as `netatmo_event`, along with their data. You can use these events to trigger automations.
@@ -297,7 +297,7 @@ Sign in using your username and password from your regular Netatmo account.
- 
+
- 
+
+ +
+
+
```yaml
topic: homeassistant/light/1/command
diff --git a/source/_integrations/neato.markdown b/source/_integrations/neato.markdown
index 1332da1336c7..8afdb03c7054 100644
--- a/source/_integrations/neato.markdown
+++ b/source/_integrations/neato.markdown
@@ -11,7 +11,6 @@ ha_iot_class: Cloud Polling
ha_release: 0.33
ha_config_flow: true
ha_codeowners:
- - '@dshokouhi'
- '@Santobert'
ha_domain: neato
ha_platforms:
diff --git a/source/_integrations/netatmo.markdown b/source/_integrations/netatmo.markdown
index 1623dd5568cd..e55a6fd515b2 100644
--- a/source/_integrations/netatmo.markdown
+++ b/source/_integrations/netatmo.markdown
@@ -116,10 +116,10 @@ Set the heating schedule.
Set the preset mode for a Netatmo climate device. The preset mode must match a preset mode configured at Netatmo.
-| Service data attribute | Required | Description |
-| ---------------------- | -------- | ---------------------------------------------------------- |
+| Service data attribute | Required | Description |
+| ---------------------- | -------- | ----------------------------------------------------------- |
| `preset_mode` | Yes | Climate preset mode such as Schedule, Away, or Frost Guard. |
-| `end_datetime` | Yes | Date & time until which the preset will be active. |
+| `end_datetime` | Yes | Date & time until which the preset will be active. |
### Set temperature with end date & time
@@ -138,9 +138,9 @@ Sets the target temperature for a Netatmo climate device with an end date & time
Sets the target temperature for a Netatmo climate device as well as the time period during which this target temperature applies.
-| Service data attribute | Required | Description |
-| ---------------------- | -------- | ------------------------------------------------------ |
-| `target_temperature` | Yes | The target temperature for the device. |
+| Service data attribute | Required | Description |
+| ---------------------- | -------- | ----------------------------------------------------------- |
+| `target_temperature` | Yes | The target temperature for the device. |
| `time_period` | Yes | Time period during which the target temperature is applied. |
### Clear temperature setting
@@ -187,7 +187,7 @@ It is therefore recommended to use [an individual development account](#developm
+ You must include either `topic` or `topic_template`, but not both. If providing a payload, you need to include either `payload` or `payload_template`, but not both. + +
+
-In your Netatmo Application configuration, do not enter a 'redirect URI' or a 'webhook URI'. The 'webhook URI' is automatically registered by this integration based on the external URL configured in the Home Assistant [configuration](/docs/configuration/basic).
+In your Netatmo Application configuration, do not enter a 'redirect URI' or a 'webhook URI'. The 'webhook URI' is automatically registered by this integration based on the external URL configured in the Home Assistant [configuration](/integrations/homeassistant/#editing-the-general-settings-in-yaml).
diff --git a/source/_integrations/network.markdown b/source/_integrations/network.markdown
index 5b072d062464..038d58736c65 100644
--- a/source/_integrations/network.markdown
+++ b/source/_integrations/network.markdown
@@ -1,6 +1,6 @@
---
-title: Network Configuration
-description: Network Configuration for Home Assistant
+title: Network configuration
+description: Network configuration for Home Assistant
ha_category:
- Other
ha_release: 2021.6
@@ -12,7 +12,7 @@ ha_codeowners:
ha_integration_type: system
---
-This integration provides network configuration for integrations such as [Zeroconf](/integrations/zeroconf/). It is managed by going to **{% my network title="Settings > System > Network" %}** and is only available to users that have "Advanced Mode" enabled on their {% my profile title="user profile" %}.
+The **Network configuration** {% term integration %} provides network configuration for integrations such as [Zeroconf](/integrations/zeroconf/). It is managed by going to **{% my network title="Settings > System > Network" %}** and is only available to users that have "Advanced Mode" enabled on their {% my profile title="user profile" %}.
**{% my general badge %}**
diff --git a/source/_integrations/notify.markdown b/source/_integrations/notify.markdown
index b1e8e4f120b7..7361b5524616 100644
--- a/source/_integrations/notify.markdown
+++ b/source/_integrations/notify.markdown
@@ -87,5 +87,3 @@ action:
```
{% endraw %}
-
-
diff --git a/source/_integrations/numato.markdown b/source/_integrations/numato.markdown
index d69384cf8da5..eaa005503a07 100644
--- a/source/_integrations/numato.markdown
+++ b/source/_integrations/numato.markdown
@@ -15,7 +15,7 @@ ha_platforms:
- binary_sensor
- sensor
- switch
-ha_integration_type: integration
+ha_integration_type: hub
---
The `numato` integration is the base for all related GPIO platforms of the
diff --git a/source/_integrations/nws.markdown b/source/_integrations/nws.markdown
index 8fdf756d46bf..cbf9d44fec9b 100644
--- a/source/_integrations/nws.markdown
+++ b/source/_integrations/nws.markdown
@@ -25,6 +25,8 @@ According to the [API documentation](https://www.weather.gov/documentation/servi
Providing a METAR station code is optional, and if not supplied, the closest station to the latitude and longitude will be chosen. A list of nearby stations is printed to the log with level `DEBUG` if no station is supplied. Stations can also be found on the [NOAA website](https://www.cnrfc.noaa.gov/metar.php). Codes with only three characters, for example, `ADW` should be prefixed with the letter K, `KADW`.
-Two weather entities are created for each entry in the configuration: one for day and night forecasts and one for hourly forecasts. The hourly forecast entity is disabled after configuration but can be enabled by the user. The time supplied for each forecast is the start time for the forecast. Sensors are also created as disabled entities after configuration and can be enabled by the user.
+One weather entity is created for each entry in the configuration. Hourly and day/night forecasts are provided through the `weather.get_forecasts` service. The time supplied for each forecast is the start time for the forecast. Sensors are also created as disabled entities after configuration and can be enabled by the user.
Details about the API are available in the [NWS API documentation](https://www.weather.gov/documentation/services-web-api). The [pynws](https://github.com/MatthewFlamm/pynws) library is used to retrieve data.
+
+Details about the `weather.get_forecasts` service are available in the [`weather` documentation](/integrations/weather/).
diff --git a/source/_integrations/octoprint.markdown b/source/_integrations/octoprint.markdown
index 60a28cdb2d60..e86b350425d4 100644
--- a/source/_integrations/octoprint.markdown
+++ b/source/_integrations/octoprint.markdown
@@ -59,7 +59,7 @@ verify ssl:
### API key
For the integration to work, please check that in Octoprint, the [Discovery Plugin](https://docs.octoprint.org/en/master/bundledplugins/discovery.html) is enabled and in the **Settings** -> **Printer Notifications** menu that **Enable popups** is checked.
-The Octoprint integration will attempt to register itself via the [Application Keys Plugin](https://docs.octoprint.org/en/master/bundledplugins/appkeys.html). After submitting the configuration UI in Home Assistant, open the Octoprint UI and click allow on the prompt.
+The Octoprint integration will attempt to register itself via the [Application Keys Plugin](https://docs.octoprint.org/en/master/bundledplugins/appkeys.html). After submitting the configuration UI in Home Assistant, open the Octoprint UI and select **Allow** on the prompt. NOTE: You must be logged into Octoprint as the user which you are adding Home Assistant. Otherwise, the popup access prompt does not appear.
## Binary sensor
@@ -90,6 +90,9 @@ The OctoPrint integration provides the following buttons:
- Pause Job
- Resume Job
- Stop Job
+- Shutdown System
+- Reboot System
+- Restart Octoprint
## Troubleshooting
diff --git a/source/_integrations/ollama.markdown b/source/_integrations/ollama.markdown
new file mode 100644
index 000000000000..bbb3bbc70801
--- /dev/null
+++ b/source/_integrations/ollama.markdown
@@ -0,0 +1,42 @@
+---
+title: Ollama
+description: Instructions on how to integrate Ollama
+ha_category:
+ - Voice
+ha_release: 2024.4
+ha_iot_class: Local Polling
+ha_config_flow: true
+ha_codeowners:
+ - '@synesthesiam'
+ha_domain: ollama
+ha_integration_type: service
+related:
+ - docs: /docs/configuration/templating/
+ title: Home Assistant Templating
+ - docs: /docs/automation/trigger/#sentence-trigger
+ title: Sentence trigger
+---
+
+The **Ollama** {% term integration %} adds a conversation agent in Home Assistant powered by a local [Ollama](https://ollama.com/) server.
+
+This conversation agent is unable to control your house. The Ollama conversation agent can be used in automations, but not as a [sentence trigger](/docs/automation/trigger/#sentence-trigger). It can only query information that has been provided by Home Assistant. To be able to answer questions about your house, Home Assistant will need to provide Ollama with the details of your house, which include areas, devices, and their states.
+
+This integration requires an external Ollama server, which is available for macOS, Linux, and Windows. Follow the [download instructions](https://ollama.com/download) to install the server. Once installed, configure Ollama to be [accessible over the network](https://github.com/ollama/ollama/blob/main/docs/faq.md#how-can-i-expose-ollama-on-my-network).
+
+{% include integrations/config_flow.md %}
+
+{% include integrations/option_flow.md %}
+{% configuration_basic %}
+URL:
+ description: The URL of the external Ollama server, such as `http://localhost:11434`.
+
+Model:
+ description: Name of the [Ollama model](https://ollama.com/library) to use, such as `mistral` or `llama2:13b`. Models will be automatically downloaded during setup.
+
+Prompt template:
+ description: The starting text for the AI language model to generate new text from. This text can include information about your Home Assistant instance, devices, and areas and is written using [Home Assistant Templating](/docs/configuration/templating/).
+
+Max history messages:
+ description: Maximum number of messages to keep for each conversation (0 = no limit). Limiting this value will cause older messages in a conversation to be dropped.
+
+{% endconfiguration_basic %}
diff --git a/source/_integrations/onewire.markdown b/source/_integrations/onewire.markdown
index a21cb464c6db..7cb270953060 100644
--- a/source/_integrations/onewire.markdown
+++ b/source/_integrations/onewire.markdown
@@ -52,6 +52,7 @@ Each 1-wire component data sheet describes the different properties the componen
| 3B | [DS1825](https://datasheets.maximintegrated.com/en/ds/DS1825.pdf) | Temperature |
| 42 | [DS28EA00](https://datasheets.maximintegrated.com/en/ds/DS28EA00.pdf) | Temperature |
| 7E | [EDS00xx](https://www.embeddeddatasystems.com/assets/images/supportFiles/manuals/EN-UserMan%20%20OW-ENV%20Sensor%20v13.pdf) | Temperature/Humidity/Barometric pressure/Light [6](#note_6)|
+| A6 | Secondary family code for [DS2438](https://datasheets.maximintegrated.com/en/ds/DS2438.pdf) | Temperature, Voltage, Current (pressure when using B1-R1-A, illuminance when using S2-R1-A, humidity when using compatible Honeywell or Humirel sensor) [2](#note_2) |
| EF | [HobbyBoard](https://hobbyboards.com/) | Temperature, Humidity, Moisture, Wetness [3](#note_3) |
#### Switches:
diff --git a/source/_integrations/opencv.markdown b/source/_integrations/opencv.markdown
deleted file mode 100644
index cf75af093537..000000000000
--- a/source/_integrations/opencv.markdown
+++ /dev/null
@@ -1,47 +0,0 @@
----
-title: OpenCV
-description: Instructions on how to integrate OpenCV image processing into Home Assistant.
-ha_category:
- - Image processing
-ha_iot_class: Local Push
-ha_release: 0.47
-ha_domain: opencv
-ha_integration_type: integration
----
-
-[OpenCV](https://www.opencv.org/) is an open source computer vision image and video processing library.
-
-Some pre-defined classifiers can be found [here](https://github.com/opencv/opencv/tree/master/data).
-
-## Configuration
-
-To setup OpenCV with Home Assistant, add the following section to your `configuration.yaml` file:
-
-```yaml
-# Example configuration.yaml entry
-image_processing:
- - platform: opencv
- source:
- - entity_id: camera.front_door
- classifier:
- mom: /path/to/classifier.xml
-```
-
-- **source** array (*Required*): List of image sources.
- - **entity_id** (*Required*): A camera entity id to get picture from.
- - **name** (*Optional*): This parameter allows you to override the name of your `image_processing` entity.
-- **classifier** (*Optional*): Dictionary of name to path to the classifier XML file. If this field is not provided, a face classifier will be downloaded from OpenCV's GitHub repository.
-
-**classifier** may also be defined as a dictionary of names to classifier configurations:
-
-```yaml
- mom:
- file: /path/to/classifier/xml
- neighbors: 4
- min_size: (40, 40)
- scale: 1.1f
-```
-
-- **file** (*Required*): The path to the classifier XML file.
-- **scale** (*Optional*): The scale to perform when processing, this is a `float` value that must be greater than or equal to `1.0`, default is `1.1`.
-- **neighbors** (*Optional*): The minimum number of neighbors required for a match, default is `4`. The higher this number, the more picky the matching will be; lower the number, the more false positives you may experience.
diff --git a/source/_integrations/opower.markdown b/source/_integrations/opower.markdown
index 4c24f8f3c212..663b5bfc7ab1 100644
--- a/source/_integrations/opower.markdown
+++ b/source/_integrations/opower.markdown
@@ -43,7 +43,8 @@ More than 175 utilities use Opower. Currently only the following utilities are s
- Pacific Gas & Electric (PG&E)
- Portland General Electric (PGE)
- Puget Sound Energy (PSE)
-- Seattle City Light (SCL) - *provides consumption data, but no cost data*
+- Sacramento Municipal Utility District (SMUD)
+- Seattle City Light (SCL)
When you add the Opower integration to Home Assistant, you will need to provide your utility account's authentication details to enable retrieving your energy data.
This is typically the same information needed to access your utility's website.
diff --git a/source/_integrations/ourgroceries.markdown b/source/_integrations/ourgroceries.markdown
index 8887fe86e44d..9fb27b4a781a 100644
--- a/source/_integrations/ourgroceries.markdown
+++ b/source/_integrations/ourgroceries.markdown
@@ -12,6 +12,15 @@ ha_domain: ourgroceries
ha_platforms:
- todo
ha_integration_type: integration
+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.ourgroceries.com/
+ title: OurGroceries
---
This integration connects with an [OurGroceries](https://www.ourgroceries.com/) account and integrates your shopping lists into Home Assistant.
diff --git a/source/_integrations/panel_iframe.markdown b/source/_integrations/panel_iframe.markdown
deleted file mode 100644
index 2ab32f0e0a17..000000000000
--- a/source/_integrations/panel_iframe.markdown
+++ /dev/null
@@ -1,72 +0,0 @@
----
-title: iFrame panel
-description: Instructions on how to add iFrames in the front end of Home Assistant.
-ha_category:
- - Front end
-ha_release: 0.25
-ha_quality_scale: internal
-ha_codeowners:
- - '@home-assistant/frontend'
-ha_domain: panel_iframe
-ha_integration_type: integration
----
-
-The `panel_iframe` support allows you to add additional panels to your Home Assistant frontend. The panels are listed in the sidebar and can contain external resources like the web frontend of your router, your monitoring system, or your media server.
-
-
-If you are accessing Home Assistant over HTTPS using SSL, you cannot access HTTP sites through an iframe panel.
-
-
-To enable Panel iFrames in your installation, add the following to your `configuration.yaml` file:
-
-```yaml
-# Example configuration.yaml entry
-panel_iframe:
- router:
- title: "Router"
- url: "http://192.168.1.1"
- fridge:
- title: "Fridge"
- url: "http://192.168.1.5"
- icon: mdi:fridge
- otherapp:
- title: "Other App"
- url: "/otherapp"
- require_admin: true
-```
-
-{% configuration %}
-panel_iframe:
- description: Enables the panel_iframe integration. Only allowed once.
- required: true
- type: map
- keys:
- panel_name:
- description: Name of the panel. Only allowed once.
- required: true
- type: map
- keys:
- title:
- description: Friendly title for the panel. Will be used in the sidebar.
- required: true
- type: string
- url:
- description: The absolute URL or relative URL with an absolute path to open.
- required: true
- type: string
- icon:
- description: Icon for entry.
- required: false
- type: icon
- require_admin:
- description: If admin access is required to see this iframe.
- required: false
- type: boolean
- default: false
-{% endconfiguration %}
-
-
-
-Do **not** create one that is named `lovelace` it will overwrite existing Dashboards, causing it to never load.
-
-
diff --git a/source/_integrations/permobil.markdown b/source/_integrations/permobil.markdown
index c9c25edf4edf..30b8a219b001 100644
--- a/source/_integrations/permobil.markdown
+++ b/source/_integrations/permobil.markdown
@@ -10,6 +10,7 @@ ha_codeowners:
- '@IsakNyberg'
ha_config_flow: true
ha_platforms:
+ - binary_sensor
- sensor
ha_integration_type: integration
---
@@ -20,7 +21,7 @@ The **MyPermobil** integration allows you to view various sensors with informati
## Sensors
-A total of 12 sensors are available:
+A total of 13 sensors are available:
- **Battery charge**
The current battery state of the wheelchair as a percentage.
@@ -46,3 +47,5 @@ A total of 12 sensors are available:
The highest number of adjustments ever recorded in a single day.
- **Longest distance traveled**
The largest distance traveled ever recorded in a single day.
+- **Is charging**
+ Binary sensor that is true when the Permobil wheelchair is charging.
diff --git a/source/_integrations/ping.markdown b/source/_integrations/ping.markdown
index 3760b5ccd81b..741931d29cc6 100644
--- a/source/_integrations/ping.markdown
+++ b/source/_integrations/ping.markdown
@@ -12,6 +12,7 @@ ha_domain: ping
ha_platforms:
- binary_sensor
- device_tracker
+ - sensor
ha_integration_type: integration
ha_config_flow: true
ha_codeowners:
@@ -21,6 +22,7 @@ ha_codeowners:
There is currently support for the following device types within Home Assistant:
- [Binary sensor](#binary-sensor)
+- [Sensors](#sensors)
- [Presence detection](#presence-detection)
{% include integrations/config_flow.md %}
@@ -49,12 +51,16 @@ To change the settings, go to {% my integrations title="**Settings** > **Devices
The `ping` binary sensor platform allows you to use `ping` to send ICMP echo requests. This way you can check if a given host is online and determine the round trip times from your Home Assistant instance to that system.
This sensor is enabled by default. The default polling interval is 30 seconds.
-The sensor exposes the different round trip times in milliseconds measured by `ping` as attributes:
+## Sensors
-- `round_trip_time_mdev` - the standard deviation
-- `round_trip_time_avg` - the average round trip time
-- `round_trip_time_min` - the shortest round trip time
-- `round_trip_time_max` - the longest round trip time
+The integration exposes the different round trip times milliseconds as entities:
+
+- `Round Trip Time Mean Deviation` - the standard deviation
+- `Round Trip Time Average` - the average round trip time
+- `Round Trip Time Minimum` - the shortest round trip time
+- `Round Trip Time Maximum` - the longest round trip time
+
+**These entities are disabled by default and can be enabled in the UI if needed.**
When run on Windows systems, the round trip time attributes are rounded to the nearest millisecond and the mdev value is unavailable.
diff --git a/source/_integrations/piper.markdown b/source/_integrations/piper.markdown
index 51c54fdc06d7..c5b5997631fd 100644
--- a/source/_integrations/piper.markdown
+++ b/source/_integrations/piper.markdown
@@ -19,6 +19,7 @@ ha_platforms:
- stt
- switch
- tts
+ - wake_word
ha_iot_class: Local Push
ha_zeroconf: true
---
diff --git a/source/_integrations/profiler.markdown b/source/_integrations/profiler.markdown
index 1c78faa4a868..e52cd8e04396 100644
--- a/source/_integrations/profiler.markdown
+++ b/source/_integrations/profiler.markdown
@@ -85,6 +85,8 @@ Start logging the growth of objects in memory.
Periodically log the growth of new objects in memory. This service's primary use case is finding memory leaks. This service can be run for long periods to find slow leaks. For finding fast leaks, `profiler.start_log_object_sources` is preferred; however, it is much more CPU intensive.
+See the [corresponding documentation for `growth()`](https://mg.pov.lt/objgraph/objgraph.html#objgraph.growth) regarding the format in which this data is logged.
+
### Service profiler.stop_log_objects
{% my developer_call_service badge service="profiler.stop_log_objects" %}
@@ -187,3 +189,13 @@ Each upcoming scheduled item is logged similar to the below example:
{% my developer_call_service badge service="profiler.lru_stats" %}
Logs statistics from [lru_cache](https://docs.python.org/3/library/functools.html#functools.lru_cache) and [lru-dict](https://pypi.org/project/lru-dict/) to help tune Home Assistant and locate memory leaks.
+
+### Service profiler.set_asyncio_debug
+
+{% my developer_call_service badge service="profiler.set_asyncio_debug" %}
+
+| Service data attribute | Optional | Description |
+| ---------------------- | -------- | -------------------------------------- |
+| `enabled` | yes | Boolean to enable asyncio debug. |
+
+When `set_asyncio_debug` is enabled, `asyncio` will run in [debug mode](https://docs.python.org/3/library/asyncio-dev.html#debug-mode). Use this service to help identify an integration that is blocking the event loop.
diff --git a/source/_integrations/prusalink.markdown b/source/_integrations/prusalink.markdown
index 2134255988c1..aa899f6d980f 100644
--- a/source/_integrations/prusalink.markdown
+++ b/source/_integrations/prusalink.markdown
@@ -16,26 +16,38 @@ ha_platforms:
- camera
- sensor
ha_dhcp: true
+related:
+ - url: https://help.prusa3d.com/article/prusa-connect-and-prusalink-explained_302608
+ title: PrusaLink documentation
+ - url: https://help.prusa3d.com/guide/prusalink-and-prusa-connect-setup-mk3-s-_221744
+ title: PrusaLink installation guide for Prusa MK3 with Raspberry Pi Zero W
+ - url: https://help.prusa3d.com/guide/prusalink-prusa-connect-with-rpi-3-4-usb-mk2-5-s-mk3-s-_469341
+ title: Sentence trigger
---
-The PrusaLink integration allows you to monitor your [Prusa 3D printer](https://www.prusa3d.com) and its progress with your Home Assistant installation. This integration works with Prusa MINI/MINI+, Prusa MK3.9/MK4 and Prusa XL. It does not work with the older Raspberry Pi based Prusa Link printers.
+The **PrusaLink** {% term integration %} allows you to monitor your [Prusa 3D printer](https://www.prusa3d.com) and its progress with your Home Assistant installation. This integration works with Prusa MINI/MINI+, Prusa MK3.9/MK4, Prusa XL, and with the older Raspberry Pi-based Prusa MK2.5/MK3.
-This integration has been updated to utilize the latest v1 API endpoints, which require firmware version 4.7.0 or later. If you own a Prusa MINI/MINI+, please make sure your printer is running firmware 5.1.0 or a more recent version. Firmware versions 4.7.x and 5.0.x are not available for this model.
+This integration has been updated to utilize the latest v1 API endpoints, which require firmware version 4.7.0 or later. If you own a Prusa MINI/MINI+, please make sure your printer is running firmware 5.1.0 or a more recent version. Firmware versions 4.7.x and 5.0.x are not available for this model. For Prusa MK2.5/MK3, this integration requires PrusaLink version 0.7.2 or later.
Firmware update guides can be found here:
- [Prusa MINI/MINI+](https://help.prusa3d.com/article/firmware-updating-mini-mini_124784)
- [Prusa MK3.9/MK4/XL](https://help.prusa3d.com/article/how-to-update-firmware-mk4-xl_453086)
+ - [Prusa MK2.5/MK3](https://help.prusa3d.com/guide/how-to-update-prusalink-mk2-5-s-mk3-s-_650837)
-To obtain the hostname, username, and password:
+## Obtaining hostname, username, and password
+
+### Prusa MINI/MINI+/MK3.9/MK4/XL
- On your printer, navigate to **Settings** > **Network** > **PrusaLink**.
- Find the device's **IP address**. Alternatively, you can look for the printer's IP address or hostname on your router.
- Note that for some models, the username may not be visible, as it is hardcoded to `maker`.
- Depending on your model, the password entry may not be called **Password**, but **API key**.
-{% include integrations/config_flow.md %}
+### Prusa MK2.5/MK3
-## Related topics
+ - The device's **IP address** is displayed on the printer LCD after PrusaLink starts up. Alternatively, you can look for the printer's IP address or hostname on your router.
+ - Use the **username** and **password** you entered during the initial PrusaLink setup (not the API key).
+
+{% include integrations/config_flow.md %}
-- [PrusaLink documentation](https://help.prusa3d.com/article/prusa-connect-and-prusalink-explained_302608)
diff --git a/source/_integrations/pushbullet.markdown b/source/_integrations/pushbullet.markdown
index aa792d149670..97339a83a2ef 100644
--- a/source/_integrations/pushbullet.markdown
+++ b/source/_integrations/pushbullet.markdown
@@ -60,12 +60,12 @@ The Pushbullet notification platform sends messages to [Pushbullet](https://www.
Pushbullet is a notify platform and thus can be controlled by calling the notify service [as described here](/integrations/notify/). It will send a notification to all devices registered in the Pushbullet account. An optional **target** parameter can be given to Pushbullet to specify specific account's devices, contacts or channels.
-Type | Prefix | Suffix | Example
----- | ------ | ------ | -------
-Device | `device/` | Device nickname | `device/iphone`
-Channel | `channel/` | Channel tag | `channel/my_home`
-Email | `email/` | Contact's email address | `email/email@example.com`
-SMS | `sms/` | Contact's phone number | `sms/0612345678`
+| Type | Prefix | Suffix | Example |
+| ------- | ---------- | ----------------------- | ------------------------- |
+| Device | `device/` | Device nickname | `device/iphone` |
+| Channel | `channel/` | Channel tag | `channel/my_home` |
+| Email | `email/` | Contact's email address | `email/email@example.com` |
+| SMS | `sms/` | Contact's phone number | `sms/0612345678` |
If using targets, your own account's email address functions as 'send to all devices'. All targets are verified (if exists) before sending, except email.
@@ -141,6 +141,6 @@ action:
+### Smart hose timers
+
+The Rachio smart hose timers are not currently capable of receiving real-time updates. Instead, they rely on polling. Because of this, the current state of valves started from a schedule or the physical button will not show up immediately. Polling occurs every 2 minutes when one base station is used, with an additional minute added for every additional base station to remain with the API rate limit. Up to 4 valves can be paired to a single base station.
+
### iFrame
If you would like to see and control more detailed zone information, create an [iFrame](/integrations/panel_iframe/) that renders the Rachio web app.
@@ -64,12 +68,25 @@ panel_iframe:
## Switch
-The `rachio` switch platform allows you to toggle zones and schedules connected to your [Rachio irrigation system](https://rachio.com/) on and off.
+The `rachio` switch platform allows you to toggle zones, valves, and schedules connected to your [Rachio irrigation system](https://rachio.com/) on and off.
-Once configured, a switch will be added for every zone that is enabled on every controller in the account provided and a switch to start or stop every schedule on a controller. There will also be a switch to toggle each controller's standby mode, as well as to activate a 24 hour rain delay on the device.
+Once configured, a switch will be added for every zone that is enabled on every controller in the account provided, as well as a switch for each smart hose timer valve and a switch to start or stop every schedule on a controller. There will also be a switch to toggle each controller's standby mode, as well as to activate a 24-hour rain delay on the device.
## Services
+### Service `rachio.start_watering`
+
+Allows starting one zone on a sprinkler controller, any number of smart hose timer valves, or a schedule. To sequentially start multiple zones on a sprinkler controller, use the `start_multiple_zone_schedule` service below.
+
+Service data attribute | Optional | Description |
+| ---------------------- | -------- | ----------- |
+| `entity_id` | no | Individual zone, schedule, or multiple smart hose timer valves to run. A smart hose timer base station device can also be selected to run all valves on the given base.
+| `duration` | yes | Duration in minutes to run the zone or valves. Leave empty for schedules.
+
+
-Don't forget to [allowlist external directories](/docs/configuration/basic/), so Home Assistant has access to them.
+Don't forget to [allowlist external directories](/integrations/homeassistant/#allowlist_external_dirs), so Home Assistant has access to them.
diff --git a/source/_integrations/rachio.markdown b/source/_integrations/rachio.markdown
index 3898de7b15b0..f58ecddc2ca3 100644
--- a/source/_integrations/rachio.markdown
+++ b/source/_integrations/rachio.markdown
@@ -39,7 +39,7 @@ They will be automatically added if the Rachio integration is loaded.
-In order for Rachio switches and sensors to update, your Home Assistant instance must be accessible from the internet, either via Home Assistant Cloud or another method. See the [Remote Access documentation](/docs/configuration/remote/) for more information.
+In order for Rachio switches and sensors to update, your Home Assistant instance must be accessible from the internet, either via Home Assistant Cloud or another method. See the [Remote Access documentation](/docs/configuration/remote/) for more information. The smart hose timers use polling and don't require external access to be setup.
@@ -50,6 +50,10 @@ After setting up the integration, change the options to set the duration in minu
+The services below only apply to sprinkler controllers and will not be shown if only smart hose timers are on the account.
+
+
### Service `rachio.start_multiple_zone_schedule`
Allows a list of zones to be passed with a corresponding list of durations to create a custom schedule directly from Home Assistant.
@@ -86,7 +103,7 @@ It is not currently possible to have zones from multiple controllers in the same
### Examples
```yaml
-#Example sctipt to start multiple zones with individual duration for each zone.
+#Example script to start multiple zones with individual duration for each zone.
script:
run_grass_zones:
sequence:
@@ -101,7 +118,7 @@ script:
```
```yaml
-#Example sctipt to start multiple zones with one duration for all zones.
+#Example script to start multiple zones with one duration for all zones.
script:
run_grass_zones:
sequence:
@@ -114,6 +131,7 @@ script:
data:
duration: 20
```
+
### Service `rachio.set_zone_moisture_percent`
Set the zone moisture percentage for a zone or group of zones.
diff --git a/source/_integrations/recovery_mode.markdown b/source/_integrations/recovery_mode.markdown
index 475e34e34385..4df332b4ee59 100644
--- a/source/_integrations/recovery_mode.markdown
+++ b/source/_integrations/recovery_mode.markdown
@@ -1,5 +1,5 @@
---
-title: Recovery Mode
+title: Recovery mode
description: Allows Home Assistant to start up in recovery mode.
ha_category: []
ha_release: 0.105
@@ -8,9 +8,12 @@ ha_codeowners:
ha_domain: recovery_mode
ha_quality_scale: internal
ha_integration_type: system
+related:
+ - docs: /docs/troubleshooting_general/
+ title: General troubleshooting
---
-The **Recovery mode** integration is an internal integration used by the
+The **Recovery mode** {% term integration %} is an internal integration used by the
Home Assistant Core.
You don't have to configure it since it is automatically always
@@ -26,7 +29,3 @@ the Home Assistant frontend, settings and add-ons.
This gives you the possibility to correct the issue and restart Home Assistant
to re-try.
-
-## Related topics
-
-- [General troubleshooting](/docs/troubleshooting_general/)
diff --git a/source/_integrations/rejseplanen.markdown b/source/_integrations/rejseplanen.markdown
index f58e6e7953a9..75a3e8c25160 100644
--- a/source/_integrations/rejseplanen.markdown
+++ b/source/_integrations/rejseplanen.markdown
@@ -6,8 +6,6 @@ ha_category:
ha_iot_class: Cloud Polling
ha_release: 0.88
ha_domain: rejseplanen
-ha_codeowners:
- - '@DarkFox'
ha_platforms:
- sensor
ha_integration_type: integration
diff --git a/source/_integrations/reolink.markdown b/source/_integrations/reolink.markdown
index 807c42df3a45..c0f29e084d4a 100644
--- a/source/_integrations/reolink.markdown
+++ b/source/_integrations/reolink.markdown
@@ -24,6 +24,11 @@ ha_platforms:
- update
ha_integration_type: integration
ha_dhcp: true
+related:
+ - docs: /dashboards/picture-glance/#creating-a-card-to-control-the-camera
+ title: Controlling the camera from the dashboard
+ - url: https://reolink.com/
+ title: Reolink product page
---
The integration allows you to control [Reolink](https://reolink.com/) NVRs or cameras.
@@ -67,6 +72,7 @@ Depending on the supported features of the camera, binary sensors are added for:
- AI pet detection
- AI animal detection
- AI face detection
+- AI package detection
These sensors receive events using 3 methods in order: ONVIF push, ONVIF long polling or fast polling (every 5 seconds).
The latency for receiving the events is the best for ONVIF push and the worst for fast polling, the fastest available method that is detected to work will be used, and slower methods will not be used.
@@ -88,11 +94,13 @@ Depending on the supported features of the camera, number entities are added for
- AI face sensitivity
- AI person sensitivity
- AI vehicle sensitivity
+- AI package sensitivity
- AI pet sensitivity
- AI animal sensitivity
- AI face delay*
- AI person delay*
- AI vehicle delay*
+- AI package delay*
- AI pet delay*
- AI animal delay*
- Auto quick reply time
@@ -141,10 +149,10 @@ Depending on the supported features of the camera, button entities are added for
Some Reolink PTZ cameras can move at different speeds. For those cameras, the `reolink.ptz_move` service can be used in combination with the **PTZ left**, **right**, **up**, **down**, **zoom in**, or **zoom out** entity which allows specifying the speed attribute. If the PTZ button entities for a specific camera are not shown under **Choose entity** under **targets** of the `reolink.ptz_move` service, it means that this camera does not support custom PTZ speeds.
-| Service data attribute | Optional | Description |
-| ---------------------- | -------- | -----------------------------------------------------------------------------------------|
-| `entity_id` | no | Name of the Reolink PTZ button entity to control. For example, `button.trackmix_ptz_left`. |
-| `speed` | no | PTZ move speed. For example `10`. |
+| Service data attribute | Optional | Description |
+| ---------------------- | -------- | ----------------------------------------------------------------------------------------------------------------------------------- |
+| `entity_id` | no | Name of the Reolink PTZ button entity to control. For example, `button.trackmix_ptz_left`. |
+| `speed` | no | PTZ move speed. For example `10`. |
## Select entities
@@ -153,13 +161,14 @@ Depending on the supported features of the camera, select entities are added for
- Floodlight mode (Off, Auto, Schedule)
- Day night mode (Auto, Color, Black&White)
- PTZ preset
+- Play quick reply message
- Auto quick reply message
- Auto track method (Digital, Digital first, Pan/Tilt first)
- Status LED (Doorbell only: Stay off, Auto, Auto & always on at night)
**PTZ preset** positions can be set in the Reolink app/windows/web client, the names of the presets will be loaded into Home Assistant at the start of the integration. When adding new preset positions, please restart the Reolink integration.
-**Auto quick reply messages** can be recorded in the Reolink app where a name is also supplied. New or updated quick reply messages will be loaded into Home Assistant at the start of the integration. When adding new quick reply messages, please restart the Reolink integration.
+**Play quick reply messages**/**Auto quick reply messages** can be recorded in the Reolink phone app where a name is also supplied. New or updated quick reply messages will be loaded into Home Assistant at the start of the integration. When adding new quick reply messages, please restart the Reolink integration.
## Siren entities
@@ -178,6 +187,7 @@ Depending on the supported features of the camera, switch entities are added for
- Auto tracking
- Auto focus
- Guard return
+- PTZ patrol (start/stop)
- Doorbell button sound
- Record
- Push notifications
@@ -197,6 +207,8 @@ For NVRs, a global switch for **Record**, **Push**, **Buzzer**, **Email**, and *
The Push-notification in the Reolink app is independent of the Home Assistant setting. It is also independent of the settings on other phones connected to the same camera. Reolink does this so you have an independent way of turning off push notifications per phone.
+The **PTZ patrol** positions first need to be configured using the Reolink [app](https://support.reolink.com/hc/en-us/articles/360008746833/)/[windows](https://support.reolink.com/hc/en-us/articles/900003738126/)/web client. When no positions are configured, the PTZ patrol entity will not be added. When adding patrol positions for the first time, you need to restart the Reolink integration.
+
## Light entities
Depending on the supported features of the camera, light entities are added for:
@@ -212,6 +224,7 @@ Depending on the supported features of the camera, the following sensor entities
- PTZ pan position
- Wi-Fi signal*
+- HDD/SD storage*
## Update entity
@@ -258,6 +271,7 @@ The following models have been tested and confirmed to work:
- [RLC-822A](https://reolink.com/product/rlc-822a/)
- [RLC-823A](https://reolink.com/product/rlc-823a/)
- [RLC-833A](https://reolink.com/product/rlc-833a/)
+- [RLC-1212A](https://reolink.com/product/rlc-1212a/)
- [RLC-1224A](https://reolink.com/product/rlc-1224a/)
- [RLN8-410 NVR](https://reolink.com/product/rln8-410/)
- [RLN16-410 NVR](https://reolink.com/product/rln16-410/)
@@ -351,7 +365,3 @@ An SSL certificate can still be enforced for external connections, by, for insta
To see if a Reolink integration is currently using `ONVIF push`, `ONVIF long polling` or `Fast polling`, [download the diagnostics text file](/docs/configuration/troubleshooting/#download-diagnostics) and find the `"event connection": "ONVIF push"\"ONVIF long polling"\"Fast polling"` in the txt file.
-## Related topics
-
-- [Controlling the camera from the dashboard](/dashboards/picture-glance/#creating-a-card-to-control-the-camera)
-- [Reolink product page](https://reolink.com/)
diff --git a/source/_integrations/rfxtrx.markdown b/source/_integrations/rfxtrx.markdown
index dee985fed74c..d9d3a68b6d8e 100644
--- a/source/_integrations/rfxtrx.markdown
+++ b/source/_integrations/rfxtrx.markdown
@@ -4,6 +4,7 @@ description: Instructions on how to integrate RFXtrx into Home Assistant.
ha_category:
- Binary sensor
- Cover
+ - Event
- Hub
- Light
- Sensor
@@ -21,6 +22,7 @@ ha_platforms:
- binary_sensor
- cover
- diagnostics
+ - event
- light
- sensor
- siren
@@ -33,6 +35,7 @@ The RFXtrx integration supports RFXtrx devices by [RFXCOM](http://www.rfxcom.com
There is currently support for the following device types within Home Assistant:
- [Cover](#covers)
+- [Event](#events)
- [Light](#lights)
- [Switch](#switches)
- [Sensor](#sensors)
@@ -100,6 +103,10 @@ In the options menu, select *Enable automatic add* to enable automatic addition
The RFXtrx integration supports Siemens/LightwaveRF and Somfy RTS roller shutters that communicate in the frequency range of 433.92 MHz.
+#### Events
+
+The RFXtrx integration will expose event entities for remotes controlling lights as well as security devices.
+
#### Lights
The RFXtrx integration support lights that communicate in the frequency range of 433.92 MHz.
diff --git a/source/_integrations/ring.markdown b/source/_integrations/ring.markdown
index 8bcd79fce2e8..3a855f56024b 100644
--- a/source/_integrations/ring.markdown
+++ b/source/_integrations/ring.markdown
@@ -3,6 +3,7 @@ title: Ring
description: Instructions on how to integrate your Ring.com devices within Home Assistant.
ha_category:
- Binary sensor
+ - Button
- Camera
- Doorbell
- Light
@@ -15,6 +16,7 @@ ha_domain: ring
ha_dhcp: true
ha_platforms:
- binary_sensor
+ - button
- camera
- diagnostics
- light
@@ -31,9 +33,12 @@ The Ring integration allows you to integrate your [Ring.com](https://ring.com/)
There is currently support for the following device types within Home Assistant:
- [Binary sensor](#binary-sensor)
+- [Button](#button)
- [Camera](#camera)
+ - [Saving the videos captured by your Ring Door Bell](#saving-the-videos-captured-by-your-ring-door-bell)
- [Sensor](#sensor)
- [Switch](#switch)
+- [Light](#light)
This integration does NOT allow for live viewing of your Ring camera within Home Assistant. @@ -45,6 +50,10 @@ This integration does NOT allow for live viewing of your Ring camera within Home Once you have enabled the [Ring integration](/integrations/ring), you can start using a binary sensor. Currently, it supports doorbell, external chimes and stickup cameras. +## Button + +Once you have enabled the [Ring integration](/integrations/ring), you can start using the button platform. Currently, it supports intercom to open the door. + ## Camera
@@ -53,7 +62,7 @@ Please note that downloading and playing Ring video will require a Ring Protect
Once you have enabled the [Ring integration](/integrations/ring), you can start using the camera platform. Currently, it supports doorbell and stickup cameras.
-## Saving the videos captured by your Ring Door Bell
+### Saving the videos captured by your Ring Door Bell
You can save locally the latest video captured by your Ring Door Bell using the [downloader](/integrations/downloader) along with either an [automation](/integrations/automation) or [python_script](/integrations/python_script). First, enable the [downloader](/integrations/downloader) integration in your configuration by adding the following to your `configuration.yaml`.
diff --git a/source/_integrations/rova.markdown b/source/_integrations/rova.markdown
index a140881e5e1c..024645f53ce0 100644
--- a/source/_integrations/rova.markdown
+++ b/source/_integrations/rova.markdown
@@ -5,105 +5,13 @@ ha_category:
- Sensor
ha_release: 0.87
ha_iot_class: Cloud Polling
+ha_config_flow: true
ha_domain: rova
ha_platforms:
- sensor
ha_integration_type: integration
---
-[ROVA](https://rova.nl) is a waste collection company that operates in the center and east of the Netherlands. The `rova` platform uses an unofficial [ROVA](https://rova.nl) API to allow you to get your waste collection schedule and integrate this in your Home Assistant installation.
+[ROVA](https://rova.nl) is a waste collection company that operates in the center and east of the Netherlands. This **ROVA** integration uses an unofficial [ROVA](https://rova.nl) API to allow you to get your waste collection schedule and integrate this into your Home Assistant installation.
-## Configuration
-
-To use the ROVA sensor in your installation, add the following to your `configuration.yaml` file:
-
-```yaml
-# Example configuration.yaml entry
-sensor:
- - platform: rova
- zip_code: ZIP_CODE
- house_number: HOUSE_NUMBER
-```
-
-{% configuration %}
-zip_code:
- description: Your zip code.
- required: true
- type: string
-house_number:
- description: Your house number.
- required: true
- type: string
-house_number_suffix:
- description: A suffix for your house number.
- required: false
- type: string
-name:
- description: Let you overwrite the name of the device in the frontend.
- required: false
- default: Rova
- type: string
-monitored_conditions:
- description: ROVA information to be monitored. The following collection dates can be monitored.
- required: false
- type: list
- keys:
- bio:
- description: Upcoming collection date of your biodegradable waste
- paper:
- description: Upcoming collection date of your paper waste
- plastic:
- description: upcoming collection date of your plastic waste
- residual:
- description: Upcoming collection date of your general waste
-{% endconfiguration %}
-
-If no **monitored_conditions** are specified, only **bio** will be enabled.
-
-### Full configuration sample
-
-A full configuration entry would look like the sample below.
-
-```yaml
-# Example configuration.yaml entry
-sensor:
- - platform: rova
- zip_code: ZIP_CODE
- house_number: HOUSE_NUMBER
- house_number_suffix: HOUSE_NUMBER_SUFFIX
- name: Rova
- monitored_conditions:
- - bio
- - paper
- - plastic
- - residual
-```
-
-To have your Home Assistant installation remind you of upcoming waste collections, combine the `rova` platform with some [Automations](/docs/automation/) and a [notification platform](/integrations/notify/).
-
-{% raw %}
-
-```yaml
-# Example configuration.yaml entry for Rova waste collection reminder
-automation:
- - id: rova-garbage-bio-reminder
- alias: "Send Rova Bio waste collection reminder"
- trigger:
- - platform: time
- at: "19:00:00"
- condition:
- - condition: template
- value_template: "{% if (as_timestamp(states('sensor.rova_garbage_gft')) - as_timestamp(now())) < 43200 %}true{% endif %}"
- - condition: template
- value_template: "{% if (as_timestamp(states('sensor.rova_garbage_gft')) - as_timestamp(now())) > 0 %}true{% endif %}"
- action:
- - service: NOTIFICATION_SERVICE
- data:
- message: "Reminder: put out biowaste bin"
-```
-
-{% endraw %}
-
-
-This integration is not affiliated with Rova and retrieves data from the endpoints of their website. Use at your own risk.
-
+{% include integrations/config_flow.md %}
diff --git a/source/_integrations/rpi_camera.markdown b/source/_integrations/rpi_camera.markdown
index 972b3dec5921..db98923c9bb0 100644
--- a/source/_integrations/rpi_camera.markdown
+++ b/source/_integrations/rpi_camera.markdown
@@ -87,4 +87,4 @@ file_path:
default: A temporary file is used.
{% endconfiguration %}
-The given **file_path** must be an existing file because the camera platform setup performs a writeable check on it. Also, keep in mind that the path should be [whitelisted](/docs/configuration/basic/).
+The given **file_path** must be an existing file because the camera platform setup performs a writeable check on it. Also, keep in mind that the path should be [whitelisted](/integrations/homeassistant/#allowlist_external_dirs).
diff --git a/source/_integrations/samsungtv.markdown b/source/_integrations/samsungtv.markdown
index 6727a1cb1a58..a344ed2c84dc 100644
--- a/source/_integrations/samsungtv.markdown
+++ b/source/_integrations/samsungtv.markdown
@@ -451,6 +451,6 @@ Some televisions from the H and J series use an encrypted protocol and require m
#### Samsung TV keeps asking for permission
-The default setting on newer televisions is to ask for permission on ever connection attempt.
+The default setting on newer televisions is to ask for permission on every connection attempt.
To avoid this behavior, please ensure that you adjust this to `First time only` in the `Device connection manager > Access notification` settings of your television.
It is also recommended to cleanup the previous attempts in `Device connection manager > Device list`
diff --git a/source/_integrations/schedule.markdown b/source/_integrations/schedule.markdown
index b4db6426991c..5108df962dfb 100644
--- a/source/_integrations/schedule.markdown
+++ b/source/_integrations/schedule.markdown
@@ -1,6 +1,6 @@
---
title: Schedule
-description: Instructions on how use make weekly schedule in Home Assistant.
+description: Instructions on how to make a weekly schedule in Home Assistant.
ha_category:
- Automation
- Helper
diff --git a/source/_integrations/sensor.markdown b/source/_integrations/sensor.markdown
index c8a31290d64b..5eab32ce77fb 100644
--- a/source/_integrations/sensor.markdown
+++ b/source/_integrations/sensor.markdown
@@ -70,7 +70,7 @@ The type of data a sensor returns impacts how it is displayed in the frontend. T
- **volume_storage**: Generic stored volume in L, mL, gal, fl. oz., m³, ft³, or CCF
- **water**: Water consumption in L, gal, m³, ft³, or CCF
- **weight**: Generic mass in kg, g, mg, µg, oz, lb, or st
-- **wind_speed**: Wind speed in ft/s, km/h, kn, m/s, or mph
+- **wind_speed**: Wind speed in Beaufort, ft/s, km/h, kn, m/s, or mph
diff --git a/source/_integrations/sensor.mqtt.markdown b/source/_integrations/sensor.mqtt.markdown
index 6f2f904380c4..416a43eec31d 100644
--- a/source/_integrations/sensor.mqtt.markdown
+++ b/source/_integrations/sensor.mqtt.markdown
@@ -149,7 +149,7 @@ json_attributes_topic:
required: false
type: string
last_reset_value_template:
- description: "Defines a [template](/docs/configuration/templating/#using-templates-with-the-mqtt-integration) to extract the last_reset. Available variables: `entity_id`. The `entity_id` can be used to reference the entity's attributes."
+ description: "Defines a [template](/docs/configuration/templating/#using-templates-with-the-mqtt-integration) to extract the last_reset. When `last_reset_value_template` is set, the `state_class` option must be `total`. Available variables: `entity_id`. The `entity_id` can be used to reference the entity's attributes."
required: false
type: template
name:
diff --git a/source/_integrations/seventeentrack.markdown b/source/_integrations/seventeentrack.markdown
index 20b65ad595c7..a4ed5831e407 100644
--- a/source/_integrations/seventeentrack.markdown
+++ b/source/_integrations/seventeentrack.markdown
@@ -4,14 +4,17 @@ description: Instructions on how to use 17track.net data within Home Assistant
ha_category:
- Postal Service
ha_release: 0.83
+ha_config_flow: true
ha_iot_class: Cloud Polling
+ha_codeowners:
+ - '@shaiu'
ha_domain: seventeentrack
ha_platforms:
- sensor
-ha_integration_type: integration
+ha_integration_type: service
---
-The `seventeentrack` sensor platform allows users to get package data tied to their [17track.net](https://www.17track.net/) account. The platform creates both summary sensors, which show the number of packages in a current state (e.g., "In Transit"), as well as individual sensors for each package within the account.
+The seventeentrack {% term integration %} allows users to get package data tied to their [17track.net](https://www.17track.net) account. The integration creates both summary sensors, which show the number of packages in a current state (e.g., "In Transit"), as well as individual sensors for each package within the account.
@@ -19,38 +22,7 @@ Although the 17track.net website states that account passwords cannot be longer
-## Configuration
-
-To enable the platform, add the following lines to your `configuration.yaml`
-file:
-
-```yaml
-sensor:
- - platform: seventeentrack
- username: EMAIL_ADDRESS
- password: YOUR_PASSWORD
-```
-
-{% configuration %}
-username:
- description: The email address associated with your 17track.net account.
- required: true
- type: string
-password:
- description: The password associated with your 17track.net account.
- required: true
- type: string
-show_archived:
- description: Whether sensors should be created for archived packages.
- required: false
- type: boolean
- default: false
-show_delivered:
- description: Whether sensors should be created for delivered packages.
- required: false
- type: boolean
- default: false
-{% endconfiguration %}
+{% include integrations/config_flow.md %}
## Package statuses
diff --git a/source/_integrations/sfr_box.markdown b/source/_integrations/sfr_box.markdown
index 9460349ce11b..9a1dbeec6f90 100644
--- a/source/_integrations/sfr_box.markdown
+++ b/source/_integrations/sfr_box.markdown
@@ -26,3 +26,9 @@ This integration provides the following platforms:
- Sensors - such as ADSL line status, attenuation, noise and data rate.
{% include integrations/config_flow.md %}
+
+## Compatibility
+
+The integration uses the REST API, which is known to be available on models `NB4`, `NB5`, `NB6`, `NB6V`, and `NB6VAC`.
+
+However, `NCC` models do not appear to expose this REST API, and are therefore unsupported by the integration.
diff --git a/source/_integrations/shelly.markdown b/source/_integrations/shelly.markdown
index 73bb6b1837df..d9728a665040 100644
--- a/source/_integrations/shelly.markdown
+++ b/source/_integrations/shelly.markdown
@@ -5,8 +5,8 @@ ha_category:
- Binary sensor
- Climate
- Cover
- - Event
- Energy
+ - Event
- Light
- Number
- Sensor
@@ -84,6 +84,12 @@ Shelly generation 2 and 3 devices not battery-powered can act as a Bluetooth pro
{% include integrations/option_flow.md %}
+## Range Extender Support
+
+Shelly generation 2 and 3 devices that are not battery-powered can act as a Range Extender.
+Devices of the same generations can be configured via those Range Extenders specifying a custom TCP port during the configuration flow.
+Currently, only static IP or DHCP reserved IP are supported for the main device.
+
## Entity naming (generation 1)
The integration uses `Device Name` to name its entities if the device has only one relay or no relays at all.
diff --git a/source/_integrations/shopping_list.markdown b/source/_integrations/shopping_list.markdown
index 957202089ede..533e88d4f92a 100644
--- a/source/_integrations/shopping_list.markdown
+++ b/source/_integrations/shopping_list.markdown
@@ -14,9 +14,9 @@ ha_platforms:
- todo
---
-The `shopping_list` integration allows you to keep track of shopping list items.
+The **Shopping list** {% term integration %} allows you to keep track of shopping list items.
-Your shopping list will be accessible from the sidebar, and you can optionally add the [shopping list card](/dashboards/shopping-list/) to your dashboard. With the [conversation integration](/integrations/conversation/) you can add items to your shopping list using voice commands like "Add eggs to my shopping list."
+Your shopping list will be accessible from the sidebar, and you can optionally add the [To-do list card](/dashboards/todo-list/) to your dashboard. With the [conversation integration](/integrations/conversation/), you can add items to your shopping list using voice commands like "Add eggs to my shopping list."
{% include integrations/config_flow.md %}
@@ -28,33 +28,33 @@ You can add or remove items from your shopping list by using the following servi
Add an item to the shopping list.
-| Service data attribute | Optional | Description |
-|------------------------|----------|--------------------------------------------------------|
-| `name` | no | Name of the item to add. Example: "Milk" |
+| Service data attribute | Optional | Description |
+| ---------------------- | -------- | ---------------------------------------- |
+| `name` | no | Name of the item to add. Example: "Milk" |
### Service `shopping_list.remove_item`
Remove the first item with matching name from the shopping list.
-| Service data attribute | Optional | Description |
-|------------------------|----------|--------------------------------------------------------|
-| `name` | no | Name of the item to remove. Example: "Milk" |
+| Service data attribute | Optional | Description |
+| ---------------------- | -------- | ------------------------------------------- |
+| `name` | no | Name of the item to remove. Example: "Milk" |
### Service `shopping_list.complete_item`
Mark the first item with matching name as completed in the shopping list. It does not remove the item.
| Service data attribute | Optional | Description |
-|------------------------|----------|--------------------------------------------------------|
-| `name` | no | Name of the item to mark as completed. Example: "Milk" |
+| ---------------------- | -------- | ------------------------------------------------------ |
+| `name` | no | Name of the item to mark as completed. Example: "Milk" |
### Service `shopping_list.incomplete_item`
Mark the first item with matching name as incomplete in the shopping list.
-| Service data attribute | Optional | Description |
-|------------------------|----------|--------------------------------------------------------|
-| `name` | no | Name of the item to mark as incomplete. Example: "Milk" |
+| Service data attribute | Optional | Description |
+| ---------------------- | -------- | ------------------------------------------------------- |
+| `name` | no | Name of the item to mark as incomplete. Example: "Milk" |
### Service `shopping_list.complete_all`
@@ -73,15 +73,15 @@ Clear completed items from the shopping list.
Sort all items by name in the shopping list.
| Service data attribute | Optional | Description |
-|------------------------|----------|---------------------------------------------------------------------|
-| `reverse` | yes | Whether to sort in reverse (_descending_) order. (default: `False`) |
+| ---------------------- | -------- | ------------------------------------------------------------------- |
+| `reverse` | yes | Whether to sort in reverse (_descending_) order. (default: `False`) |
## Using in automations
A `shopping_list_updated` event is triggered when items in the list are modified, with the following data payload attached to it. This can be used to trigger automations such as sending a push notification when someone adds an item to the shopping list, which when clicked, will open the list.
| Data payload attribute | Description |
-|------------------------|--------------------------------------------------------------------------------------------------------------------|
+| ---------------------- | ------------------------------------------------------------------------------------------------------------------ |
| `action` | What action was taken on the item. Either `add` for a new item being added, or `update` for an item being updated. |
| `item` | A dictionary containing details of the item that was updated. |
| `item.id` | A unique ID for this item |
diff --git a/source/_integrations/signal_messenger.markdown b/source/_integrations/signal_messenger.markdown
index d835fb91ae3f..2a3645954290 100644
--- a/source/_integrations/signal_messenger.markdown
+++ b/source/_integrations/signal_messenger.markdown
@@ -131,7 +131,7 @@ action:
### Text message with an attachment from a URL
-To attach files from outside of Home Assistant, the URLs must be added to the [`allowlist_external_urls`](/docs/configuration/basic/#allowlist_external_urls) list.
+To attach files from outside of Home Assistant, the URLs must be added to the [`allowlist_external_urls`](/integrations/homeassistant/#allowlist_external_urls) list.
Note there is a 50MB size limit for attachments retrieved via URLs. You can also set `verify_ssl` to `false` to ignore SSL errors (default `true`).
diff --git a/source/_integrations/slack.markdown b/source/_integrations/slack.markdown
index 67d966f0b8e5..e8f50dc093fd 100644
--- a/source/_integrations/slack.markdown
+++ b/source/_integrations/slack.markdown
@@ -137,30 +137,30 @@ One sensor entity will be created:
The following attributes can be placed inside the `data` key of the service call for extended functionality:
-| Attribute | Optional | Description |
-| ---------------------- | -------- | ----------- |
-| `username` | yes | The username of the Slack bot.
-| `icon` | yes | The icon of the Slack bot.
-| `file` | yes | A file to include with the message; see below.
-| `blocks` | yes | Array of [Slack blocks](https://api.slack.com/messaging/composing/layouts). *NOTE*: if using `blocks`, they are shown **in place of** the `message` within Slack apps. The message field will be used as notification text and anywhere else Slack is unable to display blocks. `message` is required regardless of whether this field is used.
-| `blocks_template` | yes | The same as `blocks`, but able to support [templates](https://www.home-assistant.io/docs/configuration/templating).
-| `thread_ts` | yes | Sends the message as a reply to a specified parent message.
+| Attribute | Optional | Description |
+| ----------------- | -------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| `username` | yes | The username of the Slack bot. |
+| `icon` | yes | The icon of the Slack bot. |
+| `file` | yes | A file to include with the message; see below. |
+| `blocks` | yes | Array of [Slack blocks](https://api.slack.com/messaging/composing/layouts). *NOTE*: if using `blocks`, they are shown **in place of** the `message` within Slack apps. The message field will be used as notification text and anywhere else Slack is unable to display blocks. `message` is required regardless of whether this field is used. |
+| `blocks_template` | yes | The same as `blocks`, but able to support [templates](https://www.home-assistant.io/docs/configuration/templating). |
+| `thread_ts` | yes | Sends the message as a reply to a specified parent message. |
Note that using `file` will ignore all usage of `blocks` and `blocks_template` (as Slack does not support those frameworks in messages that accompany uploaded files).
To include a local file with the Slack message, use these attributes underneath the `file` key:
-| Attribute | Optional | Description |
-| ---------------------- | -------- | ----------- |
-| `path` | no | A local filepath that has been [whitelisted](/docs/configuration/basic/#allowlist_external_dirs).
+| Attribute | Optional | Description |
+| --------- | -------- | --------------------------------------------------------------------------------------------------- |
+| `path` | no | A local filepath that has been [whitelisted](/integrations/homeassistant/#allowlist_external_dirs). |
To include a remote file with the Slack message, use these attributes underneath the `file` key:
-| Attribute | Optional | Description |
-| ---------------------- | -------- | ----------- |
-| `url` | no | A URL that has been [whitelisted](/docs/configuration/basic/#allowlist_external_urls).
-| `username` | yes | An optional username if the URL is protected by HTTP Basic Auth.
-| `password` | yes | An optional password if the URL is protected by HTTP Basic Auth.
+| Attribute | Optional | Description |
+| ---------- | -------- | ---------------------------------------------------------------------------------------- |
+| `url` | no | A URL that has been [whitelisted](/integrations/homeassistant/#allowlist_external_urls). |
+| `username` | yes | An optional username if the URL is protected by HTTP Basic Auth. |
+| `password` | yes | An optional password if the URL is protected by HTTP Basic Auth. |
### Obtaining a member ID
diff --git a/source/_integrations/smartthings.markdown b/source/_integrations/smartthings.markdown
index 268b6ef67b4e..ae88c313e48f 100644
--- a/source/_integrations/smartthings.markdown
+++ b/source/_integrations/smartthings.markdown
@@ -64,7 +64,7 @@ The PAT is used to create a Home Assistant SmartApp in your SmartThings account
This integration requires an internet accessible incoming webhook to receive push updates from SmartThings. The preferred approach is to subscribe to [Home Assistant Cloud (Nabu Casa)](https://www.nabucasa.com/) and the integration will configure and use a cloudhook automatically. Alternatively, you will have to configure and setup an internet accessible webhook in Home Assistant as described below:
1. Setup [remote access](/docs/configuration/remote/) via a domain name secured with SSL. *Self-signed SSL certificates are not supported by the SmartThings Cloud API.*
-2. Set the external URL in the Home Assistant [configuration](/docs/configuration/basic) to the URL that Home Assistant is available on the internet (this must start with `https://`). If you do not use Nabu Casa you must configure your network to allow TCP traffic from the internet to reach the IP address and port of the device running Home Assistant.
+2. Set the external URL in the Home Assistant [configuration](/integrations/homeassistant/#external_url) to the URL that Home Assistant is available on the internet (this must start with `https://`). If you do not use Nabu Casa you must configure your network to allow TCP traffic from the internet to reach the IP address and port of the device running Home Assistant.
## Setup instructions
@@ -98,7 +98,7 @@ The SmartThings integration triggers events for select device capabilities.
### smartthings.button
-The integration will trigger an event when a device with the [button](https://developer-preview.smartthings.com/docs/devices/capabilities/capabilities-reference#button) capability is actuated and can be used to trigger automations within Home Assistant. Below is an example of the data payload:
+The integration will trigger an event when a device with the [button](https://developer.smartthings.com/docs/devices/capabilities/capabilities-reference#button) capability is actuated and can be used to trigger automations within Home Assistant. Below is an example of the data payload:
```json
{
@@ -115,14 +115,14 @@ The integration will trigger an event when a device with the [button](https://de
| `component_id` | Describes which integration of the device triggered the event. `main` represents the parent device. For devices with child-devices, this attribute identifies the child that raised the event. For multi-button devices, the current SmartThings API will no longer pass the ButtonNumber but use a child component_id for each button. The device handler installed on SmartThings must be able to create those child components. |
| `device_id` | The unique id of the device in SmartThings. This can be located in the Home Assistant device registry or in the [SmartThings Developer Workspace](https://smartthings.developer.samsung.com/workspace/). |
| `location_id` | The unique id of the location the device is part of. This can be found in the configuration entry registry or in the [SmartThings Developer Workspace](https://smartthings.developer.samsung.com/workspace/). |
-| `value` | Describes the action taken on the button. See the [button](https://developer-preview.smartthings.com/docs/devices/capabilities/capabilities-reference#button) capability reference for a list of possible values (not all are supported by every device). |
+| `value` | Describes the action taken on the button. See the [button](https://developer.smartthings.com/docs/devices/capabilities/capabilities-reference#button) capability reference for a list of possible values (not all are supported by every device). |
| `name` | The name given to the device in SmartThings. |
Event data payloads are logged at the debug level, see [debugging](#debugging) for more information.
## Platforms
-SmartThings represents devices as a set of [capabilities](https://developer-preview.smartthings.com/docs/devices/capabilities/capabilities) and the SmartThings integration maps those to entity platforms in Home Assistant. A single device may be represented by one or more platforms.
+SmartThings represents devices as a set of [capabilities](https://developer.smartthings.com/docs/devices/capabilities/capabilities-reference) and the SmartThings integration maps those to entity platforms in Home Assistant. A single device may be represented by one or more platforms.
- [Binary sensor](#binary-sensor)
- [Climate](#climate)
@@ -140,16 +140,16 @@ Support for additional platforms will be added in the future.
The SmartThings binary sensor platform lets you view devices that have binary sensor-related capabilities. A binary sensor entity will be created for each attribute (below) supported by the device.
-| Capability | Attribute | On-Value |
-| ------------------------------------------------------------------------------------------------------------------------------------- | -------------- | ---------- |
-| [`accelerationSensor`](https://developer-preview.smartthings.com/docs/devices/capabilities/capabilities-reference#accelerationSensor) | `acceleration` | `active` |
-| [`contactSensor`](https://developer-preview.smartthings.com/docs/devices/capabilities/capabilities-reference#contactSensor) | `contact` | `open` |
-| [`filterStatus`](https://developer-preview.smartthings.com/docs/devices/capabilities/proposed#filterStatus) | `filterStatus` | `replace` |
-| [`motionSensor`](https://developer-preview.smartthings.com/docs/devices/capabilities/capabilities-reference#motionSensor) | `motion` | `active` |
-| [`presenceSensor`](https://developer-preview.smartthings.com/docs/devices/capabilities/capabilities-reference#presenceSensor) | `presence` | `present` |
-| [`tamperAlert`](https://developer-preview.smartthings.com/docs/devices/capabilities/capabilities-reference#tamperAlert) | `tamper` | `detected` |
-| [`valve`](https://developer-preview.smartthings.com/docs/devices/capabilities/capabilities-reference#valve) | `valve` | `open` |
-| [`waterSensor`](https://developer-preview.smartthings.com/docs/devices/capabilities/capabilities-reference#waterSensor) | `water` | `wet` |
+| Capability | Attribute | On-Value |
+| ----------------------------------------------------------------------------------------------------------------------------- | -------------- | ---------- |
+| [`accelerationSensor`](https://developer.smartthings.com/docs/devices/capabilities/capabilities-reference#accelerationSensor) | `acceleration` | `active` |
+| [`contactSensor`](https://developer.smartthings.com/docs/devices/capabilities/capabilities-reference#contactSensor) | `contact` | `open` |
+| [`filterStatus`](https://developer.smartthings.com/docs/devices/capabilities/proposed#filterStatus) | `filterStatus` | `replace` |
+| [`motionSensor`](https://developer.smartthings.com/docs/devices/capabilities/capabilities-reference#motionSensor) | `motion` | `active` |
+| [`presenceSensor`](https://developer.smartthings.com/docs/devices/capabilities/capabilities-reference#presenceSensor) | `presence` | `present` |
+| [`tamperAlert`](https://developer.smartthings.com/docs/devices/capabilities/capabilities-reference#tamperAlert) | `tamper` | `detected` |
+| [`valve`](https://developer.smartthings.com/docs/devices/capabilities/capabilities-reference#valve) | `valve` | `open` |
+| [`waterSensor`](https://developer.smartthings.com/docs/devices/capabilities/capabilities-reference#waterSensor) | `water` | `wet` |
### Climate
@@ -159,124 +159,124 @@ The SmartThings Climate platform lets you control devices that have air conditio
For a SmartThings Air Conditioner to be represented by the climate platform, it must have all of the following required capabilities:
-| Capability | Climate Features |
-| -------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------- |
-| [`airConditionerMode`](https://developer-preview.smartthings.com/docs/devices/capabilities/proposed#airConditionerMode) (required) | `hvac mode`, `hvac action` |
-| [`airConditionerFanMode`](https://developer-preview.smartthings.com/docs/devices/capabilities/proposed#airConditionerFanMode) (required) | `fan mode` |
-| [`temperatureMeasurement`](https://developer-preview.smartthings.com/docs/devices/capabilities/capabilities-reference#temperatureMeasurement) (required) | `temperature` |
-| [`thermostatCoolingSetpoint`](https://developer-preview.smartthings.com/docs/devices/capabilities/capabilities-reference#thermostatCoolingSetpoint) (required) | `target temp` |
-| [`demandResponseLoadControl`](https://developer-preview.smartthings.com/docs/devices/capabilities/proposed#demandResponseLoadControl) | `drlc_status_duration` (state attribute), `drlc_status_level` (state attribute), `drlc_status_override` (state attribute), `drlc_status_start` (state attribute) |
+| Capability | Climate Features |
+| ------------------------------------------------------------------------------------------------------------------------------------------------------ | ---------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| [`airConditionerMode`](https://developer.smartthings.com/docs/devices/capabilities/proposed#airConditionerMode) (required) | `hvac mode`, `hvac action` |
+| [`airConditionerFanMode`](https://developer.smartthings.com/docs/devices/capabilities/proposed#airConditionerFanMode) (required) | `fan mode` |
+| [`temperatureMeasurement`](https://developer.smartthings.com/docs/devices/capabilities/capabilities-reference#temperatureMeasurement) (required) | `temperature` |
+| [`thermostatCoolingSetpoint`](https://developer.smartthings.com/docs/devices/capabilities/capabilities-reference#thermostatCoolingSetpoint) (required) | `target temp` |
+| [`demandResponseLoadControl`](https://developer.smartthings.com/docs/devices/capabilities/proposed#demandResponseLoadControl) | `drlc_status_duration` (state attribute), `drlc_status_level` (state attribute), `drlc_status_override` (state attribute), `drlc_status_start` (state attribute) |
#### Thermostats
For a SmartThings thermostat to be represented by the climate platform, it must have all the capabilities from either "set a" _or_ "set b":
-| Capability | Climate Features |
-| ----------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- |
-| [`thermostat`](https://developer-preview.smartthings.com/docs/devices/capabilities/deprecated#thermostat) (set a) | `hvac mode`, `hvac action`, `target temp high`, `target temp low` and `fan mode` |
-| [`thermostatMode`](https://developer-preview.smartthings.com/docs/devices/capabilities/capabilities-reference#thermostatMode) (set b) | `hvac mode` |
-| [`thermostatCoolingSetpoint`](https://developer-preview.smartthings.com/docs/devices/capabilities/capabilities-reference#thermostatCoolingSetpoint) (seb b) | `target temp low` |
-| [`thermostatHeatingSetpoint`](https://developer-preview.smartthings.com/docs/devices/capabilities/capabilities-reference#thermostatHeatingSetpoint) (set b) | `target temp high` |
-| [`temperatureMeasurement`](https://developer-preview.smartthings.com/docs/devices/capabilities/capabilities-reference#temperatureMeasurement) (set b) |
-| [`thermostatOperatingState`](https://developer-preview.smartthings.com/docs/devices/capabilities/capabilities-reference#thermostatOperatingState) | `hvac action` |
-| [`thermostatFanMode`](https://developer-preview.smartthings.com/docs/devices/capabilities/capabilities-reference#thermostatFanMode) | `fan mode` |
-| [`relativeHumidityMeasurement`](https://developer-preview.smartthings.com/docs/devices/capabilities/capabilities-reference#relativeHumidityMeasurement) | `humidity` (state attribute) |
+| Capability | Climate Features |
+| --------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- |
+| [`thermostat`](https://developer.smartthings.com/docs/devices/capabilities/deprecated#thermostat) (set a) | `hvac mode`, `hvac action`, `target temp high`, `target temp low` and `fan mode` |
+| [`thermostatMode`](https://developer.smartthings.com/docs/devices/capabilities/capabilities-reference#thermostatMode) (set b) | `hvac mode` |
+| [`thermostatCoolingSetpoint`](https://developer.smartthings.com/docs/devices/capabilities/capabilities-reference#thermostatCoolingSetpoint) (seb b) | `target temp low` |
+| [`thermostatHeatingSetpoint`](https://developer.smartthings.com/docs/devices/capabilities/capabilities-reference#thermostatHeatingSetpoint) (set b) | `target temp high` |
+| [`temperatureMeasurement`](https://developer.smartthings.com/docs/devices/capabilities/capabilities-reference#temperatureMeasurement) (set b) |
+| [`thermostatOperatingState`](https://developer.smartthings.com/docs/devices/capabilities/capabilities-reference#thermostatOperatingState) | `hvac action` |
+| [`thermostatFanMode`](https://developer.smartthings.com/docs/devices/capabilities/capabilities-reference#thermostatFanMode) | `fan mode` |
+| [`relativeHumidityMeasurement`](https://developer.smartthings.com/docs/devices/capabilities/capabilities-reference#relativeHumidityMeasurement) | `humidity` (state attribute) |
### Cover
The SmartThings Cover platform lets you control devices that have open/close related capabilities. For a device to be represented by the cover platform, it must have one of the capabilities from "set a" below.
-| Capability | Cover Features |
-| ------------------------------------------------------------------------------------------------------------------------------- | --------------------------------- |
-| [`doorControl`](https://developer-preview.smartthings.com/docs/devices/capabilities/capabilities-reference#doorControl) (set a) | `open` and `close` |
-| [`garageDoorControl`](https://developer-preview.smartthings.com/docs/devices/capabilities/deprecated#garageDoorControl) (seb a) | `open` and `close` |
-| [`windowShade`](https://developer-preview.smartthings.com/docs/devices/capabilities/capabilities-reference#windowShade) (set a) | `open` and `close` |
-| [`switchLevel`](https://developer-preview.smartthings.com/docs/devices/capabilities/capabilities-reference#switchLevel) | `position` |
-| [`windowShadeLevel`](https://developer.smartthings.com/docs/devices/capabilities/capabilities-reference/#windowShadeLevel) | `position` |
-| [`battery`](https://developer-preview.smartthings.com/docs/devices/capabilities/capabilities-reference#battery) | `battery_level` (state attribute) |
+| Capability | Cover Features |
+| -------------------------------------------------------------------------------------------------------------------------- | --------------------------------- |
+| [`doorControl`](https://developer.smartthings.com/docs/devices/capabilities/capabilities-reference#doorControl) (set a) | `open` and `close` |
+| [`garageDoorControl`](https://developer.smartthings.com/docs/devices/capabilities/deprecated#garageDoorControl) (seb a) | `open` and `close` |
+| [`windowShade`](https://developer.smartthings.com/docs/devices/capabilities/capabilities-reference#windowShade) (set a) | `open` and `close` |
+| [`switchLevel`](https://developer.smartthings.com/docs/devices/capabilities/capabilities-reference#switchLevel) | `position` |
+| [`windowShadeLevel`](https://developer.smartthings.com/docs/devices/capabilities/capabilities-reference/#windowShadeLevel) | `position` |
+| [`battery`](https://developer.smartthings.com/docs/devices/capabilities/capabilities-reference#battery) | `battery_level` (state attribute) |
### Fan
The SmartThings Fan platform lets you control devices that have fan-related capabilities. For a SmartThings device to be represented by the fan platform, it must have one or more of the capabilities below in addition to the [`switch`](https://smartthings.developer.samsung.com/develop/api-ref/capabilities.html#Switch) capability.
-| Capability | Fan Features |
-| ----------------------------------------------------------------------------------------------------------------- | -------------------------------------------- |
-| [`fanSpeed`](https://developer-preview.smartthings.com/docs/devices/capabilities/capabilities-reference#fanSpeed) | `speed` (`off`, `low`, `medium`, and `high`) |
+| Capability | Fan Features |
+| --------------------------------------------------------------------------------------------------------- | -------------------------------------------- |
+| [`fanSpeed`](https://developer.smartthings.com/docs/devices/capabilities/capabilities-reference#fanSpeed) | `speed` (`off`, `low`, `medium`, and `high`) |
### Light
The SmartThings Light platform lets you control devices that have light-related capabilities. For a SmartThings device to be represented by the light platform, it must have one or more of the capabilities below in addition to the [`switch`](https://smartthings.developer.samsung.com/develop/api-ref/capabilities.html#Switch) capability.
-| Capability | Light Features |
-| --------------------------------------------------------------------------------------------------------------------------------- | ----------------------------- |
-| [`switchLevel`](https://developer-preview.smartthings.com/docs/devices/capabilities/capabilities-reference#switchLevel) | `brightness` and `transition` |
-| [`colorControl`](https://developer-preview.smartthings.com/docs/devices/capabilities/capabilities-reference#colorControl) | `color` |
-| [`colorTemperature`](https://developer-preview.smartthings.com/docs/devices/capabilities/capabilities-reference#colorTemperature) | `color_temp` |
+| Capability | Light Features |
+| ------------------------------------------------------------------------------------------------------------------------- | ----------------------------- |
+| [`switchLevel`](https://developer.smartthings.com/docs/devices/capabilities/capabilities-reference#switchLevel) | `brightness` and `transition` |
+| [`colorControl`](https://developer.smartthings.com/docs/devices/capabilities/capabilities-reference#colorControl) | `color` |
+| [`colorTemperature`](https://developer.smartthings.com/docs/devices/capabilities/capabilities-reference#colorTemperature) | `color_temp` |
### Lock
-The SmartThings Lock platform lets you control devices that have the [`lock`](https://developer-preview.smartthings.com/docs/devices/capabilities/capabilities-reference#lock) capability, showing current lock status and supporting lock and unlock commands.
+The SmartThings Lock platform lets you control devices that have the [`lock`](https://developer.smartthings.com/docs/devices/capabilities/capabilities-reference#lock) capability, showing current lock status and supporting lock and unlock commands.
### Sensor
The SmartThings Sensor platform lets your view devices that have sensor-related capabilities. A Sensor entity is created for each attribute (below) supported by the device.
-| Capability | Attributes |
-| --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------- |
-| [`activityLightingMode`](https://developer-preview.smartthings.com/docs/devices/capabilities/proposed#activityLightingMode) | `lightingMode` |
-| [`airConditionerMode`](https://developer-preview.smartthings.com/docs/devices/capabilities/proposed#airConditionerMode) | `airConditionerMode` |
-| [`airQualitySensor`](https://developer-preview.smartthings.com/docs/devices/capabilities/capabilities-reference#airQualitySensor) | `airQuality` |
-| [`alarm`](https://developer-preview.smartthings.com/docs/devices/capabilities/capabilities-reference#alarm) | `alarm` |
-| [`audioVolume`](https://developer-preview.smartthings.com/docs/devices/capabilities/capabilities-reference#audioVolume) | `volume` |
-| [`battery`](https://developer-preview.smartthings.com/docs/devices/capabilities/capabilities-reference#battery) | `battery` |
-| [`bodyMassIndexMeasurement`](https://developer-preview.smartthings.com/docs/devices/capabilities/proposed#bodyMassIndexMeasurement) | `bmiMeasurement` |
-| [`bodyWeightMeasurement`](https://developer-preview.smartthings.com/docs/devices/capabilities/proposed#bodyWeightMeasurement) | `bodyWeightMeasurement` |
-| [`carbonDioxideMeasurement`](https://developer-preview.smartthings.com/docs/devices/capabilities/capabilities-reference#carbonDioxideMeasurement) | `carbonDioxide` |
-| [`carbonMonoxideDetector`](https://developer-preview.smartthings.com/docs/devices/capabilities/capabilities-reference#carbonMonoxideDetector) | `carbonMonoxide` |
-| [`carbonMonoxideMeasurement`](https://developer-preview.smartthings.com/docs/devices/capabilities/proposed#carbonMonoxideMeasurement) | `carbonMonoxideLevel` |
-| [`dishwasherOperatingState`](https://developer-preview.smartthings.com/docs/devices/capabilities/proposed#dishwasherOperatingState) | `machineState`, `dishwasherJobState` and `completionTime` |
-| [`dryerMode`](https://developer-preview.smartthings.com/docs/devices/capabilities/proposed#dryerMode) | `dryerMode` |
-| [`dryerOperatingState`](https://developer-preview.smartthings.com/docs/devices/capabilities/proposed#dryerOperatingState) | `machineState`, `dryerJobState` and `completionTime` |
-| [`dustSensor`](https://developer-preview.smartthings.com/docs/devices/capabilities/capabilities-reference#dustSensor) | `fineDustLevel` and `dustLevel` |
-| [`energyMeter`](https://developer-preview.smartthings.com/docs/devices/capabilities/capabilities-reference#energyMeter) | `energy` |
-| [`equivalentCarbonDioxideMeasurement`](https://developer-preview.smartthings.com/docs/devices/capabilities/capabilities-reference#equivalentCarbonDioxideMeasurement) | `equivalentCarbonDioxideMeasurement` |
-| [`formaldehydeMeasurement`](https://developer-preview.smartthings.com/docs/devices/capabilities/capabilities-reference#formaldehydeMeasurement) | `formaldehydeLevel` |
-| [`gasMeter`](https://developer-preview.smartthings.com/docs/devices/capabilities/proposed#gasMeter) | `gasMeter`, `meterCalorific`, `meterTime`, and `meterVolume` |
-| [`illuminanceMeasurement`](https://developer-preview.smartthings.com/docs/devices/capabilities/capabilities-reference#illuminanceMeasurement) | `illuminance` |
-| [`infraredLevel`](https://developer-preview.smartthings.com/docs/devices/capabilities/capabilities-reference#infraredLevel) | `infraredLevel` |
-| [`lock`](https://developer-preview.smartthings.com/docs/devices/capabilities/capabilities-reference#lock) | `lock` |
-| [`mediaInputSource`](https://developer-preview.smartthings.com/docs/devices/capabilities/proposed#mediaInputSource) | `inputSource` |
-| [`mediaPlaybackRepeat`](https://developer-preview.smartthings.com/docs/devices/capabilities/proposed#mediaPlaybackRepeat) | `playbackRepeatMode` |
-| [`mediaPlaybackShuffle`](https://developer-preview.smartthings.com/docs/devices/capabilities/proposed#mediaPlaybackShuffle) | `playbackShuffle` |
-| [`mediaPlayback`](https://developer-preview.smartthings.com/docs/devices/capabilities/proposed#mediaPlayback) | `playbackStatus` |
-| [`odorSensor`](https://developer-preview.smartthings.com/docs/devices/capabilities/proposed#odorSensor) | `odorLevel` |
-| [`ovenMode`](https://developer-preview.smartthings.com/docs/devices/capabilities/proposed#ovenMode) | `ovenMode` |
-| [`ovenOperatingState`](https://developer-preview.smartthings.com/docs/devices/capabilities/proposed#ovenOperatingState) | `machineState`, `ovenJobState` and `completionTime` |
-| [`ovenSetpoint`](https://developer-preview.smartthings.com/docs/devices/capabilities/proposed#ovenSetpoint) | `ovenSetpoint` |
-| [`powerConsumptionReport`](https://developer-preview.smartthings.com/docs/devices/capabilities/proposed#powerConsumptionReport) | `deltaEnergy`, `energy`, `energySaved`, `power`, `powerEnergy` |
-| [`powerMeter`](https://developer-preview.smartthings.com/docs/devices/capabilities/capabilities-reference#powerMeter) | `power` |
-| [`powerSource`](https://developer-preview.smartthings.com/docs/devices/capabilities/capabilities-reference#powerSource) | `powerSource` |
-| [`refrigerationSetpoint`](https://developer-preview.smartthings.com/docs/devices/capabilities/proposed#refrigerationSetpoint) | `refrigerationSetpoint` |
-| [`relativeHumidityMeasurement`](https://developer-preview.smartthings.com/docs/devices/capabilities/capabilities-reference#relativeHumidityMeasurement) | `humidity` |
-| [`robotCleanerCleaningMode`](https://developer-preview.smartthings.com/docs/devices/capabilities/proposed#robotCleanerCleaningMode) | `robotCleanerCleaningMode` |
-| [`robotCleanerMovement`](https://developer-preview.smartthings.com/docs/devices/capabilities/proposed#robotCleanerMovement) | `robotCleanerMovement` |
-| [`robotCleanerTurboMode`](https://developer-preview.smartthings.com/docs/devices/capabilities/proposed#robotCleanerTurboMode) | `robotCleanerTurboMode` |
-| [`signalStrength`](https://developer-preview.smartthings.com/docs/devices/capabilities/capabilities-reference#signalStrength) | `lqi` and `rssi` |
-| [`smokeDetector`](https://developer-preview.smartthings.com/docs/devices/capabilities/capabilities-reference#smokeDetector) | `smoke` |
-| [`temperatureMeasurement`](https://developer-preview.smartthings.com/docs/devices/capabilities/capabilities-reference#temperatureMeasurement) | `temperature` |
-| [`thermostatCoolingSetpoint`](https://developer-preview.smartthings.com/docs/devices/capabilities/capabilities-reference#thermostatCoolingSetpoint) | `coolingSetpoint` |
-| [`thermostatFanMode`](https://developer-preview.smartthings.com/docs/devices/capabilities/capabilities-reference#thermostatFanMode) | `thermostatFanMode` |
-| [`thermostatHeatingSetpoint`](https://developer-preview.smartthings.com/docs/devices/capabilities/capabilities-reference#thermostatHeatingSetpoint) | `heatingSetpoint` |
-| [`thermostatMode`](https://developer-preview.smartthings.com/docs/devices/capabilities/capabilities-reference#thermostatMode) | `thermostatMode` |
-| [`thermostatOperatingState`](https://developer-preview.smartthings.com/docs/devices/capabilities/capabilities-reference#thermostatOperatingState) | `thermostatOperatingState` |
-| [`thermostatSetpoint`](https://developer-preview.smartthings.com/docs/devices/capabilities/deprecated#thermostatSetpoint) | `thermostatSetpoint` |
-| [`threeAxis`](https://developer-preview.smartthings.com/docs/devices/capabilities/capabilities-reference#threeAxis) | `threeAxis` (as discrete sensors `X`, `Y` and `Z`) |
-| [`tvChannel`](https://developer-preview.smartthings.com/docs/devices/capabilities/proposed#tvChannel) | `tvChannel` and `tvChannelName` |
-| [`tvocMeasurement`](https://developer-preview.smartthings.com/docs/devices/capabilities/capabilities-reference#tvocMeasurement) | `tvocLevel` |
-| [`ultravioletIndex`](https://developer-preview.smartthings.com/docs/devices/capabilities/capabilities-reference#ultravioletIndex) | `ultravioletIndex` |
-| [`voltageMeasurement`](https://developer-preview.smartthings.com/docs/devices/capabilities/capabilities-reference#voltageMeasurement) | `voltage` |
-| [`washerMode`](https://developer-preview.smartthings.com/docs/devices/capabilities/proposed#washerMode) | `washerMode` |
-| [`washerOperatingState`](https://developer-preview.smartthings.com/docs/devices/capabilities/proposed#washerOperatingState) | `machineState`, `washerJobState` and `completionTime` |
+| Capability | Attributes |
+| ------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------- |
+| [`activityLightingMode`](https://developer.smartthings.com/docs/devices/capabilities/proposed#activityLightingMode) | `lightingMode` |
+| [`airConditionerMode`](https://developer.smartthings.com/docs/devices/capabilities/proposed#airConditionerMode) | `airConditionerMode` |
+| [`airQualitySensor`](https://developer.smartthings.com/docs/devices/capabilities/capabilities-reference#airQualitySensor) | `airQuality` |
+| [`alarm`](https://developer.smartthings.com/docs/devices/capabilities/capabilities-reference#alarm) | `alarm` |
+| [`audioVolume`](https://developer.smartthings.com/docs/devices/capabilities/capabilities-reference#audioVolume) | `volume` |
+| [`battery`](https://developer.smartthings.com/docs/devices/capabilities/capabilities-reference#battery) | `battery` |
+| [`bodyMassIndexMeasurement`](https://developer.smartthings.com/docs/devices/capabilities/proposed#bodyMassIndexMeasurement) | `bmiMeasurement` |
+| [`bodyWeightMeasurement`](https://developer.smartthings.com/docs/devices/capabilities/proposed#bodyWeightMeasurement) | `bodyWeightMeasurement` |
+| [`carbonDioxideMeasurement`](https://developer.smartthings.com/docs/devices/capabilities/capabilities-reference#carbonDioxideMeasurement) | `carbonDioxide` |
+| [`carbonMonoxideDetector`](https://developer.smartthings.com/docs/devices/capabilities/capabilities-reference#carbonMonoxideDetector) | `carbonMonoxide` |
+| [`carbonMonoxideMeasurement`](https://developer.smartthings.com/docs/devices/capabilities/proposed#carbonMonoxideMeasurement) | `carbonMonoxideLevel` |
+| [`dishwasherOperatingState`](https://developer.smartthings.com/docs/devices/capabilities/proposed#dishwasherOperatingState) | `machineState`, `dishwasherJobState` and `completionTime` |
+| [`dryerMode`](https://developer.smartthings.com/docs/devices/capabilities/proposed#dryerMode) | `dryerMode` |
+| [`dryerOperatingState`](https://developer.smartthings.com/docs/devices/capabilities/proposed#dryerOperatingState) | `machineState`, `dryerJobState` and `completionTime` |
+| [`dustSensor`](https://developer.smartthings.com/docs/devices/capabilities/capabilities-reference#dustSensor) | `fineDustLevel` and `dustLevel` |
+| [`energyMeter`](https://developer.smartthings.com/docs/devices/capabilities/capabilities-reference#energyMeter) | `energy` |
+| [`equivalentCarbonDioxideMeasurement`](https://developer.smartthings.com/docs/devices/capabilities/capabilities-reference#equivalentCarbonDioxideMeasurement) | `equivalentCarbonDioxideMeasurement` |
+| [`formaldehydeMeasurement`](https://developer.smartthings.com/docs/devices/capabilities/capabilities-reference#formaldehydeMeasurement) | `formaldehydeLevel` |
+| [`gasMeter`](https://developer.smartthings.com/docs/devices/capabilities/proposed#gasMeter) | `gasMeter`, `meterCalorific`, `meterTime`, and `meterVolume` |
+| [`illuminanceMeasurement`](https://developer.smartthings.com/docs/devices/capabilities/capabilities-reference#illuminanceMeasurement) | `illuminance` |
+| [`infraredLevel`](https://developer.smartthings.com/docs/devices/capabilities/capabilities-reference#infraredLevel) | `infraredLevel` |
+| [`lock`](https://developer.smartthings.com/docs/devices/capabilities/capabilities-reference#lock) | `lock` |
+| [`mediaInputSource`](https://developer.smartthings.com/docs/devices/capabilities/proposed#mediaInputSource) | `inputSource` |
+| [`mediaPlaybackRepeat`](https://developer.smartthings.com/docs/devices/capabilities/proposed#mediaPlaybackRepeat) | `playbackRepeatMode` |
+| [`mediaPlaybackShuffle`](https://developer.smartthings.com/docs/devices/capabilities/proposed#mediaPlaybackShuffle) | `playbackShuffle` |
+| [`mediaPlayback`](https://developer.smartthings.com/docs/devices/capabilities/proposed#mediaPlayback) | `playbackStatus` |
+| [`odorSensor`](https://developer.smartthings.com/docs/devices/capabilities/proposed#odorSensor) | `odorLevel` |
+| [`ovenMode`](https://developer.smartthings.com/docs/devices/capabilities/proposed#ovenMode) | `ovenMode` |
+| [`ovenOperatingState`](https://developer.smartthings.com/docs/devices/capabilities/proposed#ovenOperatingState) | `machineState`, `ovenJobState` and `completionTime` |
+| [`ovenSetpoint`](https://developer.smartthings.com/docs/devices/capabilities/proposed#ovenSetpoint) | `ovenSetpoint` |
+| [`powerConsumptionReport`](https://developer.smartthings.com/docs/devices/capabilities/proposed#powerConsumptionReport) | `deltaEnergy`, `energy`, `energySaved`, `power`, `powerEnergy` |
+| [`powerMeter`](https://developer.smartthings.com/docs/devices/capabilities/capabilities-reference#powerMeter) | `power` |
+| [`powerSource`](https://developer.smartthings.com/docs/devices/capabilities/capabilities-reference#powerSource) | `powerSource` |
+| [`refrigerationSetpoint`](https://developer.smartthings.com/docs/devices/capabilities/proposed#refrigerationSetpoint) | `refrigerationSetpoint` |
+| [`relativeHumidityMeasurement`](https://developer.smartthings.com/docs/devices/capabilities/capabilities-reference#relativeHumidityMeasurement) | `humidity` |
+| [`robotCleanerCleaningMode`](https://developer.smartthings.com/docs/devices/capabilities/proposed#robotCleanerCleaningMode) | `robotCleanerCleaningMode` |
+| [`robotCleanerMovement`](https://developer.smartthings.com/docs/devices/capabilities/proposed#robotCleanerMovement) | `robotCleanerMovement` |
+| [`robotCleanerTurboMode`](https://developer.smartthings.com/docs/devices/capabilities/proposed#robotCleanerTurboMode) | `robotCleanerTurboMode` |
+| [`signalStrength`](https://developer.smartthings.com/docs/devices/capabilities/capabilities-reference#signalStrength) | `lqi` and `rssi` |
+| [`smokeDetector`](https://developer.smartthings.com/docs/devices/capabilities/capabilities-reference#smokeDetector) | `smoke` |
+| [`temperatureMeasurement`](https://developer.smartthings.com/docs/devices/capabilities/capabilities-reference#temperatureMeasurement) | `temperature` |
+| [`thermostatCoolingSetpoint`](https://developer.smartthings.com/docs/devices/capabilities/capabilities-reference#thermostatCoolingSetpoint) | `coolingSetpoint` |
+| [`thermostatFanMode`](https://developer.smartthings.com/docs/devices/capabilities/capabilities-reference#thermostatFanMode) | `thermostatFanMode` |
+| [`thermostatHeatingSetpoint`](https://developer.smartthings.com/docs/devices/capabilities/capabilities-reference#thermostatHeatingSetpoint) | `heatingSetpoint` |
+| [`thermostatMode`](https://developer.smartthings.com/docs/devices/capabilities/capabilities-reference#thermostatMode) | `thermostatMode` |
+| [`thermostatOperatingState`](https://developer.smartthings.com/docs/devices/capabilities/capabilities-reference#thermostatOperatingState) | `thermostatOperatingState` |
+| [`thermostatSetpoint`](https://developer.smartthings.com/docs/devices/capabilities/deprecated#thermostatSetpoint) | `thermostatSetpoint` |
+| [`threeAxis`](https://developer.smartthings.com/docs/devices/capabilities/capabilities-reference#threeAxis) | `threeAxis` (as discrete sensors `X`, `Y` and `Z`) |
+| [`tvChannel`](https://developer.smartthings.com/docs/devices/capabilities/proposed#tvChannel) | `tvChannel` and `tvChannelName` |
+| [`tvocMeasurement`](https://developer.smartthings.com/docs/devices/capabilities/capabilities-reference#tvocMeasurement) | `tvocLevel` |
+| [`ultravioletIndex`](https://developer.smartthings.com/docs/devices/capabilities/capabilities-reference#ultravioletIndex) | `ultravioletIndex` |
+| [`voltageMeasurement`](https://developer.smartthings.com/docs/devices/capabilities/capabilities-reference#voltageMeasurement) | `voltage` |
+| [`washerMode`](https://developer.smartthings.com/docs/devices/capabilities/proposed#washerMode) | `washerMode` |
+| [`washerOperatingState`](https://developer.smartthings.com/docs/devices/capabilities/proposed#washerOperatingState) | `machineState`, `washerJobState` and `completionTime` |
### Scene
@@ -284,12 +284,12 @@ The SmartThings Scene platform lets you activate scenes defined in SmartThings w
### Switch
-The SmartThings Switch platform lets you control devices that have the [`switch`](https://developer-preview.smartthings.com/docs/devices/capabilities/capabilities-reference#switch) capability that are not already represented by a more specific platform. The following optional capabilities will provide energy and power utilization information:
+The SmartThings Switch platform lets you control devices that have the [`switch`](https://developer.smartthings.com/docs/devices/capabilities/capabilities-reference#switch) capability that are not already represented by a more specific platform. The following optional capabilities will provide energy and power utilization information:
-| Capability | Switch Features |
-| ----------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------- |
-| [`energyMeter`](https://developer-preview.smartthings.com/docs/devices/capabilities/capabilities-reference#energyMeter) | energy consumption (`today_energy_kwh` state attribute) |
-| [`powerMeter`](https://developer-preview.smartthings.com/docs/devices/capabilities/capabilities-reference#powerMeter) | power consumption (`current_power_w` state attribute) |
+| Capability | Switch Features |
+| --------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------- |
+| [`energyMeter`](https://developer.smartthings.com/docs/devices/capabilities/capabilities-reference#energyMeter) | energy consumption (`today_energy_kwh` state attribute) |
+| [`powerMeter`](https://developer.smartthings.com/docs/devices/capabilities/capabilities-reference#powerMeter) | power consumption (`current_power_w` state attribute) |
## Troubleshooting
diff --git a/source/_integrations/smtp.markdown b/source/_integrations/smtp.markdown
index d7defba2304f..a6eec4e2f51b 100644
--- a/source/_integrations/smtp.markdown
+++ b/source/_integrations/smtp.markdown
@@ -24,7 +24,7 @@ notify:
recipient: "YOUR_RECIPIENT"
```
-Check your email provider configuration or help pages to get the correct SMTP settings.
+Check your email provider configuration or help pages to get the correct SMTP settings. A restart of Home Assistant is required to pick up the configuration changes.
{% configuration %}
name:
@@ -86,7 +86,28 @@ verify_ssl:
### Usage
-To use the SMTP notification, refer to it in an automation or script like in this example:
+A notify integration will be created using the name without spaces. In the above example, it will be called `notify.NOTIFIER_NAME`. To use the SMTP notification, refer to it in an automation or script like in this example:
+
+```yaml
+- alias: "Send E-Mail Every Morning"
+ description: ""
+ trigger:
+ - platform: time
+ at: "08:00:00"
+ condition: []
+ action:
+ - service: notify.NOTIFIER_NAME
+ data:
+ title: "Good Morning"
+ message: "Rise and shine"
+ target:
+ - "morning@example.com"
+ mode: single
+```
+
+The optional `target` field is used to specify recipient(s) for this specific service call. When `target` field is not used, this message will be sent to default recipient(s), in this example, morning@example.com.
+
+Another example attaching images stored locally in a script:
```yaml
burglar:
@@ -107,15 +128,13 @@ burglar:
- /home/pi/snapshot2.jpg
```
-The optional `target` field is used to specify recipient(s) for this specific service call. When `target` field is not used, this message will be sent to default recipient(s), in this example, my_intruder_alert@example.com.
-
The optional `html` field makes a custom text/HTML multi-part message, allowing total freedom for sending rich HTML emails by defining the HTML content. In them, if you need to include images, you can pass both arguments (`html` and `images`). The images will be attached with the basename of the images, so they can be included in the html page with `src="cid:image_name.ext"`.
The optional `images` field adds image attachments to the email. If `html` is defined, the images need to be added to the message in-line as described above (and as shown in the example below). If `html` is not defined, images will be added as separate attachments.
-When adding images, make sure the folders containing the attachments are added to `allowlist_external_dirs`.
See: [Setup basic documentation](/docs/configuration/basic/) +When adding images, make sure the folders containing the attachments are added to `allowlist_external_dirs`.
See: [Setup basic documentation](/integrations/homeassistant/#allowlist_external_dirs)
diff --git a/source/_integrations/smud.markdown b/source/_integrations/smud.markdown
new file mode 100644
index 000000000000..a321ea4cb827
--- /dev/null
+++ b/source/_integrations/smud.markdown
@@ -0,0 +1,20 @@
+---
+title: Sacramento Municipal Utility District (SMUD)
+description: Get energy usage from Sacramento Municipal Utility District (SMUD) using the Opower integration
+ha_category:
+ - Energy
+ - Sensor
+ha_release: 2023.8
+ha_domain: smud
+ha_integration_type: virtual
+ha_supporting_domain: opower
+ha_supporting_integration: Opower
+ha_codeowners:
+ - '@tronikos'
+ha_config_flow: true
+ha_platforms:
+ - sensor
+ha_iot_class: Cloud Polling
+---
+
+{% include integrations/supported_brand.md %}
diff --git a/source/_integrations/sql.markdown b/source/_integrations/sql.markdown
index 3a2706fde7e5..48f001e33e39 100644
--- a/source/_integrations/sql.markdown
+++ b/source/_integrations/sql.markdown
@@ -222,6 +222,18 @@ Use `state` as column for value.
Keep in mind that, depending on the update frequency of your sensor and other factors, this may not be a 100% accurate reflection of the actual situation you are measuring. Since your database won’t necessarily have a value saved exactly 24 hours ago, use “>=” or “<=” to get one of the closest values.
+#### MariaDB
+
+On MariaDB the following where clause can be used to compare the timestamp:
+
+```sql
+...
+ AND last_updated_ts <= UNIX_TIMESTAMP(NOW() - INTERVAL 1 DAY)
+...
+```
+
+Replace `- INTERVAL 1 DAY` with the target offset, for example, `- INTERVAL 1 HOUR`.
+
### Database size
#### Postgres
diff --git a/source/_integrations/starlink.markdown b/source/_integrations/starlink.markdown
index b3f71ab60261..b2f3a251ac2f 100644
--- a/source/_integrations/starlink.markdown
+++ b/source/_integrations/starlink.markdown
@@ -8,6 +8,7 @@ ha_category:
- Network
- Sensor
- Switch
+ - Time
ha_release: 2023.2
ha_iot_class: Local Polling
ha_config_flow: true
@@ -21,6 +22,7 @@ ha_platforms:
- diagnostics
- sensor
- switch
+ - time
ha_integration_type: integration
ha_quality_scale: silver
---
@@ -61,7 +63,13 @@ The Starlink integration allows you to integrate your [Starlink](https://www.sta
### Switch
- Stowed - Controls whether Dishy is stowed
+- Sleep schedule - Controls whether Starlink will enter a power-saving sleep mode at a predefined schedule
### Device tracker
- Device location - Tracks the location of Dishy. Note you need to allow location access on the local network via the Starlink app for this to work. This is disabled by default in the Starlink app and is thus disabled by default in Home Assistant.
+
+### Time
+
+- Sleep start - The time at which Starlink will enter sleep mode, if "Sleep Schedule" is enabled
+- Sleep end - The time at which Starlink will exit sleep mode, if "Sleep Schedule" is enabled
diff --git a/source/_integrations/statistics.markdown b/source/_integrations/statistics.markdown
index b1de8075ae03..1de46f9a0419 100644
--- a/source/_integrations/statistics.markdown
+++ b/source/_integrations/statistics.markdown
@@ -140,6 +140,11 @@ max_age:
description: Maximum age of source sensor measurements stored. Setting this to a time period will cause older values to be discarded. If omitted, the number of considered source sensor measurements is limited by `sampling_size` only. Set both parameters appropriately to create suited limits for your use case. The sensor value will become `unknown` if the source sensor is not updated within the time period. A statistics sensor requires `sampling_size`, `max_age`, or both to be defined.
required: false
type: time
+keep_last_sample:
+ description: Defines whether the most recent sampled value should be preserved regardless of the `max_age` setting.
+ required: false
+ default: false
+ type: boolean
percentile:
description: Only relevant in combination with the `percentile` characteristic. Must be a value between 1 and 99. The value defines the percentile value to consider. The 25th percentile is also known as the first quartile, the 50th percentile as the median.
required: false
diff --git a/source/_integrations/supervisord.markdown b/source/_integrations/supervisord.markdown
index 1270b34152d9..838eda1ad433 100644
--- a/source/_integrations/supervisord.markdown
+++ b/source/_integrations/supervisord.markdown
@@ -20,7 +20,7 @@ It required that you enable the HTTP feature in the `/etc/supervisord.conf` conf
port=127.0.0.1:9001
```
-After a restart of `supervisord` you should be able to access the web interface. If needed then this could be added as an [iFrame panel](/integrations/panel_iframe/).
+After a restart of `supervisord` you should be able to access the web interface. If needed then this could be added as an [webpage dashboard](/dashboards/dashboards/#webpage-dashboard).
See: [Setup basic documentation](/docs/configuration/basic/) +When adding images, make sure the folders containing the attachments are added to `allowlist_external_dirs`.
See: [Setup basic documentation](/integrations/homeassistant/#allowlist_external_dirs)
diff --git a/source/_integrations/switchbot.markdown b/source/_integrations/switchbot.markdown
index 35f23a9debb3..4308417ac8bb 100644
--- a/source/_integrations/switchbot.markdown
+++ b/source/_integrations/switchbot.markdown
@@ -62,7 +62,7 @@ Some SwitchBot devices need to be configured within the app before being control
- [Indoor/Outdoor Meter](https://switch-bot.com/pages/switchbot-indoor-outdoor-thermo-hygrometer) (WoIOSensorTH)
- [Motion Sensor (WoPresence)](https://switch-bot.com/pages/switchbot-motion-sensor)
- Plug Mini (WoPlug), both the original (model W1901400) and HomeKit-enabled (model W1901401)
-- [Lock (WoLock)](https://switch-bot.com/pages/switchbot-lock)
+- [Lock (WoLock)](https://switch-bot.com/pages/switchbot-lock) (currently the Pro model is not supported)
- [Blind Tilt (WoBlindTilt)](https://switch-bot.com/pages/switchbot-blind-tilt)
## SwitchBot Entity
diff --git a/source/_integrations/synology_srm.markdown b/source/_integrations/synology_srm.markdown
index 801023e4fd8b..9d7456d2f26a 100644
--- a/source/_integrations/synology_srm.markdown
+++ b/source/_integrations/synology_srm.markdown
@@ -58,7 +58,7 @@ verify_ssl:
type: boolean
{% endconfiguration %}
-It's not possible to create another account in SRM with admin permissions. You'll need to use your admin account (or the one you renamed at creation) for this connection.
+For instructions on creating multiple administrators on SRM, please refer to the [Synology Knowledge Center](https://kb.synology.com/en-id/SRM/tutorial/Create_multiple_administrator_accounts_on_Synology_Router).
List of models known to be supported:
diff --git a/source/_integrations/system_bridge.markdown b/source/_integrations/system_bridge.markdown
index e8bf158277d2..3a5ada8f4dbf 100644
--- a/source/_integrations/system_bridge.markdown
+++ b/source/_integrations/system_bridge.markdown
@@ -23,18 +23,30 @@ ha_integration_type: device
---
[System Bridge](https://system-bridge.timmo.dev) is an application that runs on your local machine to share system information via its API/WebSocket. You can also send commands to the device such as opening a URL or sending keyboard keypresses.
+
## Prerequisites
+
### Version
-This integration requires System Bridge 3.1.1 and above. Any older version will not work.
-### API key
-You will need your API key. This can be found following the documentation [here](https://system-bridge.timmo.dev/docs/running).
+
+This integration requires System Bridge 4.0.2 and above. Any older version will not work.
+
+### Token
+
+You will need your token. For instructions on finding your token, follow the steps in the [System Bridge documentation](https://system-bridge.timmo.dev/docs/running).
+
{% include integrations/config_flow.md %}
+
## Binary sensors
+
This integration provides the following binary sensors:
-| Name | Description |
-| --------------------- | ---------------------------------- |
-| Battery Is Charging | Whether the battery is charging |
-| New Version Available | Whether a new version is available |
+
+| Name | Description |
+| --------------------- | ----------------------------------- |
+| Battery Is Charging | Whether the battery is charging |
+| Camera In Use | Whether the camera/webcam is in use |
+| Pending Reboot | Whether a reboot is pending |
+| New Version Available | Whether a new version is available |
+
## Sensors
This integration provides the following sensors:
@@ -151,37 +163,137 @@ Here is an example action that will open a URL in the device's browser:
This is an object containing the `source` and `volume` (0-100). The source must be a URL to a playable audio file (an MP3 for example).
+### Service `system_bridge.get_process_by_id`
+
+Returns a process by its pid.
+
+{% my developer_call_service service="system_bridge.get_process_by_id" title="Show service in your Home Assistant instance." %}
+
+```yaml
+service: system_bridge.get_process_by_id
+data:
+ bridge: "deviceid"
+ id: 17752
+```
+
+This returns [Response Data](https://www.home-assistant.io/docs/scripts/service-calls#use-templates-to-handle-response-data) like the following:
+
+```yaml
+id: 17752
+name: steam.exe
+cpu_usage: 0.9
+created: 1698951361.6117153
+memory_usage: 0.23782578821487121
+path: C:\Program Files (x86)\Steam\steam.exe
+status: running
+username: hostname\user
+working_directory: null
+```
+
+### Service `system_bridge.get_processes_by_name`
+
+Returns a count and a list of processes matching the name provided.
+
+{% my developer_call_service service="system_bridge.get_processes_by_name" title="Show service in your Home Assistant instance." %}
+
+```yaml
+service: system_bridge.get_processes_by_name
+data:
+ bridge: "deviceid"
+ name: discord
+```
+
+This returns [Response Data](https://www.home-assistant.io/docs/scripts/service-calls#use-templates-to-handle-response-data) like the following:
+
+```yaml
+count: 1
+processes:
+ - id: 11196
+ name: Discord.exe
+ cpu_usage: 0.3
+ created: 1698951365.770648
+ memory_usage: 0.07285296297215042
+ path: C:\Users\user\AppData\Local\Discord\app\Discord.exe
+ status: running
+ username: hostname\user
+ working_directory: null
+```
+
### Service `system_bridge.open_path`
Open a URL or file on the server using the default application.
+
{% my developer_call_service service="system_bridge.open_path" title="Show service in your Home Assistant instance." %}
+
```yaml
service: system_bridge.open_path
data:
bridge: "deviceid"
path: "C:\\image.jpg"
```
+
+This returns [Response Data](https://www.home-assistant.io/docs/scripts/service-calls#use-templates-to-handle-response-data) like the following:
+
+```yaml
+id: abc123
+type: OPENED
+data:
+ path: C:\image.jpg
+message: Path opened
+```
+
### Service `system_bridge.open_url`
+
Open a URL or file on the server using the default application.
+
{% my developer_call_service service="system_bridge.open_url" title="Show service in your Home Assistant instance." %}
+
```yaml
service: system_bridge.open_url
data:
bridge: "deviceid"
url: "https://home-assistant.io"
```
-### Service `system_bridge.send_keypress`
+
+This returns [Response Data](https://www.home-assistant.io/docs/scripts/service-calls#use-templates-to-handle-response-data) like the following:
+
+```yaml
+id: abc123
+type: OPENED
+data:
+ url: https://home-assistant.io
+message: URL opened
+```
+
+### Service`system_bridge.send_keypress`
+
Send a keypress to the server.
+
{% my developer_call_service service="system_bridge.send_keypress" title="Show service in your Home Assistant instance." %}
+
```yaml
service: system_bridge.send_keypress
data:
bridge: "deviceid"
key: "a"
```
+
+This returns [Response Data](https://www.home-assistant.io/docs/scripts/service-calls#use-templates-to-handle-response-data) like the following:
+
+```yaml
+id: abc123
+type: KEYBOARD_KEY_PRESSED
+data:
+ key: a
+message: Key pressed
+```
+
### Service `system_bridge.send_text`
+
Sends text for the server to type.
+
{% my developer_call_service service="system_bridge.send_text" title="Show service in your Home Assistant instance." %}
+
```yaml
service: system_bridge.send_text
data:
@@ -189,12 +301,30 @@ data:
text: "Hello"
```
+This returns [Response Data](https://www.home-assistant.io/docs/scripts/service-calls#use-templates-to-handle-response-data) like the following:
+
+```yaml
+id: abc123
+type: KEYBOARD_TEXT_SENT
+data:
+ text: Hello
+message: Text entered
+```
+
### Service `system_bridge.power_command`
Sends power command to the system.
-{% my developer_call_service service="system_bridge.power_command" title="Show service in your Home Assistant instance." %}
+Supported commands are:
+- `hibernate`
+- `lock`
+- `logout`
+- `restart`
+- `shutdown`
+- `sleep`
+
+{% my developer_call_service service="system_bridge.power_command" title="Show service in your Home Assistant instance." %}
```yaml
service: system_bridge.power_command
@@ -203,11 +333,11 @@ data:
command: "sleep"
```
-Supported commands are:
+This returns [Response Data](https://www.home-assistant.io/docs/scripts/service-calls#use-templates-to-handle-response-data) like the following:
-- `hibernate`
-- `lock`
-- `logout`
-- `restart`
-- `shutdown`
-- `sleep`
+```yaml
+id: abc123
+type: POWER_SLEEPING
+data: {}
+message: Sleeping
+```
diff --git a/source/_integrations/telegram.markdown b/source/_integrations/telegram.markdown
index 1006f7d95b14..f4c16d70e2ed 100644
--- a/source/_integrations/telegram.markdown
+++ b/source/_integrations/telegram.markdown
@@ -265,7 +265,7 @@ inline_keyboard:
-Since Home Assistant version 0.48 you have to [whitelist the source folder](/docs/configuration/basic/) of the file you want to include in the notification.
+Since Home Assistant version 0.48 you have to [whitelist the source folder](/integrations/homeassistant/#allowlist_external_dirs) of the file you want to include in the notification.
```yaml
configuration.yaml
diff --git a/source/_integrations/telegram_broadcast.markdown b/source/_integrations/telegram_broadcast.markdown
index a73824f85ccd..5b62eeffd2a7 100644
--- a/source/_integrations/telegram_broadcast.markdown
+++ b/source/_integrations/telegram_broadcast.markdown
@@ -40,11 +40,7 @@ parse_mode:
type: string
default: "`markdown`"
proxy_url:
- description: Proxy URL if working behind one (`socks5://proxy_ip:proxy_port`).
- required: false
- type: string
-proxy_params:
- description: Proxy configuration parameters, as dict, if working behind a proxy (`username`, `password`, etc.).
+ description: Proxy URL if working behind one, optionally including username and password. (`socks5://username:password@proxy_ip:proxy_port`).
required: false
type: string
{% endconfiguration %}
diff --git a/source/_integrations/telegram_polling.markdown b/source/_integrations/telegram_polling.markdown
index befcd63fd031..cd847e40a465 100644
--- a/source/_integrations/telegram_polling.markdown
+++ b/source/_integrations/telegram_polling.markdown
@@ -42,11 +42,7 @@ parse_mode:
type: string
default: "`markdown`"
proxy_url:
- description: Proxy URL if working behind one (`socks5://proxy_ip:proxy_port`).
- required: false
- type: string
-proxy_params:
- description: Proxy configuration parameters, as dict, if working behind a proxy (`username`, `password`, etc.).
+ description: Proxy URL if working behind one, optionally including username and password. (`socks5://username:password@proxy_ip:proxy_port`).
required: false
type: string
{% endconfiguration %}
diff --git a/source/_integrations/telegram_webhooks.markdown b/source/_integrations/telegram_webhooks.markdown
index 3116b7162ab7..befeaa8a0b89 100644
--- a/source/_integrations/telegram_webhooks.markdown
+++ b/source/_integrations/telegram_webhooks.markdown
@@ -10,7 +10,7 @@ ha_domain: telegram_bot
Telegram chatbot webhooks implementation as described in the Telegram [documentation](https://core.telegram.org/bots/webhooks).
-By default this integration sets your bot's webhook URL automatically to `https:///api/telegram_webhooks` with the external_url of your Home Assistant [configuration](/docs/configuration/basic/) using Telegrams `setWebhook` method.
+By default this integration sets your bot's webhook URL automatically to `https:///api/telegram_webhooks` with the external_url of your Home Assistant [configuration](/integrations/homeassistant/#external_url) using Telegrams `setWebhook` method.
This is one of two bot implementations supported by Telegram. Described by Telegram as the preferred implementation but requires your Home Assistant instance to be exposed to the internet.
The other implementation method is [Telegram polling](/integrations/telegram_polling/), for which your Home Assistant instance does not have to be exposed to the internet.
@@ -44,15 +44,11 @@ parse_mode:
default: "`markdown`"
type: string
proxy_url:
- description: Proxy URL if working behind one (`socks5://proxy_ip:proxy_port`).
- required: false
- type: string
-proxy_params:
- description: Proxy configuration parameters, as dict, if working behind a proxy (`username`, `password`, etc.).
+ description: Proxy URL if working behind one, optionally including username and password. (`socks5://username:password@proxy_ip:proxy_port`).
required: false
type: string
url:
- description: Allow to overwrite the external URL from the Home Assistant [configuration](/docs/configuration/basic/) for different setups (`https://:`).
+ description: Allow to overwrite the external URL from the Home Assistant [configuration](/integrations/homeassistant/#editing-the-general-settings-in-yaml) for different setups (`https://:`).
required: false
type: string
trusted_networks:
diff --git a/source/_integrations/teslemetry.markdown b/source/_integrations/teslemetry.markdown
index cc976baae99c..5822a1e15438 100644
--- a/source/_integrations/teslemetry.markdown
+++ b/source/_integrations/teslemetry.markdown
@@ -3,6 +3,7 @@ title: Teslemetry
description: Instructions on how to integrate Teslemetry within Home Assistant.
ha_category:
- Climate
+ - Sensor
ha_release: 2024.2
ha_iot_class: Cloud Polling
ha_config_flow: true
@@ -11,6 +12,7 @@ ha_codeowners:
ha_domain: teslemetry
ha_platforms:
- climate
+ - sensor
ha_integration_type: integration
---
@@ -30,4 +32,60 @@ The integration will create a climate entity to control the vehicle's climate co
- Turn on and off
- Change the set temperature
-- Change to one of the four modes: Off, Keep mode, Dog mode, and Camp mode
+- Change to one of the four modes: Off, Keep mode, Dog mode, and Camp mode
+
+### Sensor
+
+The integration will create sensor entities for a variety of metrics that relate to your vehicles, energy sites, and Wall Connectors:
+
+#### Energy sites
+- Battery power
+- Energy left
+- Generator power (disabled by default)
+- Grid power
+- Grid services power
+- Load power
+- Percentage charged
+- Solar power
+- Total pack energy (disabled by default)
+
+#### Vehicles
+- Battery level
+- Battery power
+- Battery range
+- Charge cable
+- Charge energy added
+- Charge rate (disabled by default)
+- Charging
+- Charger power
+- Charger voltage
+- Charger current
+- Destination
+- Distance to arrival
+- Driver temperature setting (disabled by default)
+- Estimate battery range (disabled by default)
+- Fast charger type
+- Ideal battery range (disabled by default)
+- Inside temperature
+- Odometer (disabled by default)
+- Online
+- Outside temperature
+- Passenger temperature setting (disabled by default)
+- Power (disabled by default)
+- Shift state (disabled by default)
+- Speed (disabled by default)
+- State of charge at arrival (disabled by default)
+- Time to arrival
+- Time to full charge
+- Tire pressure front left (disabled by default)
+- Tire pressure front right (disabled by default)
+- Tire pressure rear left (disabled by default)
+- Tire pressure rear right (disabled by default)
+- Traffic delay (disabled by default)
+- Usable battery level (disabled by default)
+
+#### Wall connectors
+- Fault state code (disabled by default)
+- Power
+- State code (disabled by default)
+- Vehicle
diff --git a/source/_integrations/tessie.markdown b/source/_integrations/tessie.markdown
index 765da0f72ea7..c0a63aa8c6a3 100644
--- a/source/_integrations/tessie.markdown
+++ b/source/_integrations/tessie.markdown
@@ -151,8 +151,11 @@ The integration will create sensor entities for a variety of metrics related to
#### Charge state
+- Battery charging
- Battery level
- Battery range
+- Battery range estimate (disabled)
+- Battery range ideal (disabled)
- Charge energy added
- Charge rate
- Charger current
diff --git a/source/_integrations/thread.markdown b/source/_integrations/thread.markdown
index 8b1b637c701c..4793c54d4f23 100644
--- a/source/_integrations/thread.markdown
+++ b/source/_integrations/thread.markdown
@@ -12,6 +12,23 @@ ha_config_flow: true
ha_platforms:
- diagnostics
ha_zeroconf: true
+related:
+ - docs: /yellow/
+ title: Home Assistant Yellow - hub
+ - docs: /skyconnect/
+ title: Home Assistant SkyConnect - Zigbee/Thread USB stick
+ - docs: /integrations/matter/
+ title: Matter
+ - docs: /integrations/homekit_controller/
+ title: HomeKit
+ - docs: /integrations/matter/#adding-a-matter-device-to-home-assistant
+ title: Adding a Matter device to Home Assistant
+ - docs: /integrations/homekit_controller/#adding-a-homekit-device-through-thread
+ title: Adding an Apple HomeKit device through Thread
+ - url: https://skyconnect.home-assistant.io/procedures/enable-thread/
+ title: Enabling Thread on SkyConnect
+ - url: https://yellow.home-assistant.io/procedures/enable-thread/
+ title: Enabling Thread on Yellow
---
The Thread integration helps you track the different Thread networks in your home and store the Thread network credentials (similar to a Wi-Fi password). The Thread integration in Home Assistant is currently still a work in progress.
@@ -226,21 +243,3 @@ You can only set a Thread network as preferred if the credentials are known.
In the current implementation, having multiple TBRs from different vendors results in separate networks using different credentials. This prevents devices from roaming between the Thread networks. In theory, it would be better to join all Thread networks into a single network to increase the size of the mesh network. A dense mesh network should lead to better RF coverage and better link quality, which lowers transmission latencies, making communication faster.
-## Related topics
-
-### Related hardware
-
-- [Home Assistant Yellow](/yellow/) hub
-- [Home Assistant SkyConnect](/skyconnect/) Zigbee/Thread USB stick
-
-### Related integrations for smart home standards
-
-- [Matter](/integrations/matter/)
-- [HomeKit](/integrations/homekit_controller/)
-
-### Related guides
-
-- [Adding a Matter device to Home Assistant](/integrations/matter/#adding-a-matter-device-to-home-assistant)
-- [Adding an Apple HomeKit device through Thread](/integrations/homekit_controller/#adding-a-homekit-device-through-thread)
-- [Enabling Thread on SkyConnect](https://skyconnect.home-assistant.io/procedures/enable-thread/)
-- [Enabling Thread on Yellow](https://yellow.home-assistant.io/procedures/enable-thread/)
diff --git a/source/_integrations/todo.markdown b/source/_integrations/todo.markdown
index c7b62ea55af3..8799cfc8e9af 100644
--- a/source/_integrations/todo.markdown
+++ b/source/_integrations/todo.markdown
@@ -9,6 +9,11 @@ ha_quality_scale: internal
ha_codeowners:
- '@home-assistant/core'
ha_integration_type: entity
+related:
+ - docs: /integrations/local_todo
+ title: Local to-do list integration documentation
+ - docs: /dashboards/todo-list/
+ title: To-do list card
---
The **To-do list** {% term integration %} provides to-do list {% term entities %}, allowing other integrations
@@ -46,9 +51,9 @@ services provided by some to-do list entities are described below or you can rea
Get to-do items from a to-do list. A to-do list `target` is selected with a [target selector](/docs/blueprint/selectors/#target-selector). The `data` payload supports the following fields:
-| Service data attribute | Optional | Description | Example |
-| ---------------------- | -------- | ----------- | --------|
-| `status` | yes | Only return to-do items with this status. | `needs_action`, `completed`
+| Service data attribute | Optional | Description | Example |
+| ---------------------- | -------- | ----------------------------------------- | --------------------------- |
+| `status` | yes | Only return to-do items with this status. | `needs_action`, `completed` |
This is a full example that returns all to-do items that have not been completed:
@@ -65,12 +70,12 @@ data:
Add a new to-do item. A to-do list `target` is selected with a [Target Selector](/docs/blueprint/selectors/#target-selector) and the `data` payload supports the following fields:
-| Service data attribute | Optional | Description | Example |
-| ---------------------- | -------- | ----------- | --------|
-| `item` | no | the name of the to-do Item. | Submit income tax return
-| `due_date` | yes | The date the to-do item is expected to be completed. | 2024-04-10
-| `due_datetime` | yes | The date and time the to-do item is expected to be completed. | 2024-04-10 23:00:00
-| `description` | yes | A more complete description than the one provided by the summary | Collect all necessary documents and submit the final return.
+| Service data attribute | Optional | Description | Example |
+| ---------------------- | -------- | ---------------------------------------------------------------- | ------------------------------------------------------------ |
+| `item` | no | the name of the to-do Item. | Submit income tax return |
+| `due_date` | yes | The date the to-do item is expected to be completed. | 2024-04-10 |
+| `due_datetime` | yes | The date and time the to-do item is expected to be completed. | 2024-04-10 23:00:00 |
+| `description` | yes | A more complete description than the one provided by the summary | Collect all necessary documents and submit the final return. |
Only one of `due_date` or `due_datetime` may be specified.
@@ -90,14 +95,14 @@ data:
Update a to-do item. A to-do list `target` is selected with a [Target Selector](/docs/blueprint/selectors/#target-selector) and the `data` payload supports the following fields:
-| Service data attribute | Optional | Description | Example |
-| ---------------------- | -------- | ----------- | --------|
-| `item` | no | The name of the to-do Item to update. | Submit income tax return
-| `rename` | yes | The new name of the to-do Item. | Something else
-| `status` | yes | The overall status of the To-do Item. | `needs_action` or `completed`
-| `due_date` | yes | The date the to-do item is expected to be completed. | 2024-04-10
-| `due_datetime` | yes | The date and time the to-do item is expected to be completed. | 2024-04-10 23:00:00
-| `description` | yes | A more complete description than the one provided by the summary. | Collect all necessary documents and submit the final return.
+| Service data attribute | Optional | Description | Example |
+| ---------------------- | -------- | ----------------------------------------------------------------- | ------------------------------------------------------------ |
+| `item` | no | The name of the to-do Item to update. | Submit income tax return |
+| `rename` | yes | The new name of the to-do Item. | Something else |
+| `status` | yes | The overall status of the To-do Item. | `needs_action` or `completed` |
+| `due_date` | yes | The date the to-do item is expected to be completed. | 2024-04-10 |
+| `due_datetime` | yes | The date and time the to-do item is expected to be completed. | 2024-04-10 23:00:00 |
+| `description` | yes | A more complete description than the one provided by the summary. | Collect all necessary documents and submit the final return. |
At least one of `rename` or `status` is required. Only one of `due_date` or `due_datetime` may be specified. This is a full example of a service call that updates the status and the name of a to-do item.
@@ -115,9 +120,9 @@ data:
Removing a to-do item. A to-do list `target` is selected with a [Target Selector](/docs/blueprint/selectors/#target-selector), and the `data` payload supports the following fields:
-| Service data attribute | Optional | Description | Example |
-| ---------------------- | -------- | ----------- | --------|
-| `item` | no | The name of the to-do item. | Submit income tax return
+| Service data attribute | Optional | Description | Example |
+| ---------------------- | -------- | --------------------------- | ------------------------ |
+| `item` | no | The name of the to-do item. | Submit income tax return |
This is a full example of a service call that deletes a to-do Item with the specified name.
@@ -140,8 +145,3 @@ service: todo.remove_completed_items
target:
entity_id: todo.personal_tasks
```
-
-## Related topics
-
-- [Local to-do integration](/integrations/local_todo/)
-- [Shopping list card](/dashboards/shopping-list/)
\ No newline at end of file
diff --git a/source/_integrations/todoist.markdown b/source/_integrations/todoist.markdown
index a76b775331fd..127d94013289 100644
--- a/source/_integrations/todoist.markdown
+++ b/source/_integrations/todoist.markdown
@@ -14,12 +14,25 @@ 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: /dashboards/dashboards/
+ title: Dashboards
+ - docs: /integrations/calendar/
+ title: Calendar
+ - url: https://todoist.com
+ title: Todoist projects
---
This platform allows you to connect to your [Todoist projects](https://todoist.com) as [todo](/integrations/todo/) or [calendar](/integrations/calendar/) entities. All tasks get updated roughly every 15 minutes.
-A calendar entity will be `on` if you have a task due in that project. It will be `off` if all the tasks in the project are completed or if the project doesn't have any tasks at all.
+A calendar entity will be `on` if you have a task due in that project. It will be `off` if all the tasks in the project are completed or if the project doesn't have any tasks at all.
## Prerequisites
diff --git a/source/_integrations/tolo.markdown b/source/_integrations/tolo.markdown
index 530775b786da..9c46d58439d0 100644
--- a/source/_integrations/tolo.markdown
+++ b/source/_integrations/tolo.markdown
@@ -1,6 +1,6 @@
---
title: TOLO Sauna
-description: Control your TOLO Sauna and TOLO Steam Bath with Home Assistant.
+description: Control your TOLO Sauna and Steam Bath with Home Assistant.
ha_release: '2021.12'
ha_category:
- Climate
@@ -20,19 +20,111 @@ ha_platforms:
- number
- select
- sensor
+ - switch
ha_dhcp: true
ha_integration_type: integration
---
-The TOLO Sauna integration allows you to control your [TOLO Sauna and TOLO Steam Bath](https://www.tolosauna.com/) with Home Assistant.
+The TOLO integration allows to control [Steamtec TOLO](https://www.tolosauna.com/) devices with Home Assistant.
-The integration allows for:
-- Turning the sauna on and off
-- Setting the target temperature and target humidity
-- Controlling the fan (used for drying and cooling down the sauna)
-- Controlling the sauna lights (on/off, mode selection)
-- Configuring timers for automatic power shutdown, automatic fan shutdown and salt spray activation interval
-- Checking diagnostic information (water level, tank temperature, water in/out valves)
+## Prerequisites
+
+To be able to connect to your TOLO system via Home Assistant, you need to have the TOLO App Control Box, which is also required to be able to control your TOLO system using your mobile phone.
+Connect the TOLO App Control Box to your network.
+For auto detection, your Home Assistant instance needs to be connected to the same network broadcast domain as your TOLO App Control Box (which is usually true for normal home networks).
+However, you can also manually define the IP to which the Home Assistant TOLO integration should connect to.
+Please use your router to find out the IP address of your TOLO App Control Box.
+
+
+## Features
+
+**General notice:**
+A TOLO system can be equipped with many optional accessoires, such as [lights](#light-control), [fans](#fan-control), [aroma oil injectors](#aroma-therapy), [sole nebulizer](#salt-bath) and [descaling pump](#sweeping-and-descaling).
+The TOLO system does not report back which optional accessories are attached. Therefore, the TOLO integration always provides all possible entities even if the features are not available due to missing optional accessories.
+
+
+### Sauna operating mode
+
+The TOLO integration offers a climate entity to control the general operating mode of your TOLO system.
+This can either be *Off*, *Heat*, or *Dry*.
+
+ - *Off*: Energy is shut down, the water boiler is empty (or will be emptied soon, see [Sweeping and Descaling](#sweeping-and-descaling)).
+ - *Heat*: This is the normal operating mode for enjoying your sauna or steam bath.
+ If *Power timer* is set to a value greater than zero, the TOLO system will automatically turn off after the amount of minutes configured in the *Power timer* setting.
+ If *Power timer* is set to zero, the TOLO system will run indefinitely, until it is turned off manually.
+ - *Dry*: In this mode, everything is turned off except the fan.
+ This mode can be used when shutting down the TOLO system to reduce humidity in the room.
+ After the time configured in *Fan timer* (see [Fan Control](#fan-control)) has passed, the fan and the TOLO system will automatically turn to *Off*.
+
+
+### Temperature and humidity
+
+The TOLO system allows setting a target temperature between 35°C and 60°C.
+The TOLO system will heat and continue to produce steam until the room temperature sensor reaches the configured target temperature.
+
+Target humidity can be set between 60% and 99%.
+Once the configured humidity is reached, the steam generator will stop producing steam.
+If then the humidity is below 6% (this value is hardcoded by TOLO systems and cannot be changed by the TOLO integration), the TOLO system will start to produce steam again.
+This setting is only recognized if the TOLO system is equipped with a humidity sensor (not part of the default configuration).
+If no humidity sensor is present, steam production will only depend on the temperature.
+
+
+### Light control
+
+The TOLO system allows to connect RGB LEDs, which can be controlled by the TOLO integration.
+The TOLO system provides two modes for LED operation, *manual* and *automatic*.
+
+ - *Manual*: When turned on, the RGB LEDs will stick to the same color until it is manually changed by pressing the *Next color* button.
+ - *Automatic*: When turned on, the RGB LEDs will slowly fade from one color to another.
+
+
+### Fan control
+
+The TOLO system allows to connect a fan, which can be used to reduce the humidity after the steam generation has been turned off.
+Once activated, the fan will automatically turn off between 1 and 60 minutes, depending on the *Fan timer* setting.
+
+
+### Aroma therapy
+
+The TOLO system allows to connect an aroma oil injector with slots for either one or two aroma flavors.
+When enabled, the aroma pump will work every 5 minutes for 5 seconds each.
+Unfortunately, the TOLO system does not allow to change these intervals.
+For shorter intervals between pump activations, the TOLO manual suggests to manually disable and enable *Aroma therapy*.
+
+
+### Salt bath
+
+The TOLO system allows to connect a sole nebulizer, which can be used to inject salt spray in your sauna or steam bath room to allow for a salt bath.
+Using the *Salt bath timer*, the salt bath feature can be configured to run indefinitely (set *Salt bath timer* to 0) or for a pre-defined time between 1 and 60 minutes.
+
+
+### Sweeping and descaling
+
+The TOLO system has a built-in system for sweeping and descaling.
+This feature is currently not supported by the TOLO integration and will be added in an upcoming release.
+
+
+### Diagnostic information
+
+Beside the controls described above, the TOLO integration provides following diagnostic information:
+ - *Power timer*:
+ The remaining time the TOLO system will produce steam after it has been turned on.
+ - *Fan timer*:
+ The remaining time the fan will be on after it has been turned on.
+ - *Salt bath timer*:
+ The remaining time the salt bath will be active after it has been turned on.
+ - *Tank temperature*:
+ Current temperature of the water in the water tank.
+ Should be close to 100°C when in *Heat* mode.
+ - *Water level*:
+ The current water level in the water tank.
+ This should be 0% when off and 100% when in *Heat* mode.
+ - *Water in/out valves*:
+ Indicates if the TOLO system currently lets water run in or out.
+ When starting up, *Water in valve* should be open while *Water out valve* should be closed.
+ During *Heat* operation, both valves should be normally closed except short moments where consumed water needs to be refilled.
+ When off, the *Water out valve* should remain open.
+
{% include integrations/config_flow.md %}
diff --git a/source/_integrations/tplink.markdown b/source/_integrations/tplink.markdown
index 767e1e9f710a..6ec871c023e2 100644
--- a/source/_integrations/tplink.markdown
+++ b/source/_integrations/tplink.markdown
@@ -116,7 +116,8 @@ Devices not listed below may work but if you encounter issues submit a bug repor
- L510B
- L530E
-
+- TL135E
+
#### Light strips
- L900-5
diff --git a/source/_integrations/tplink_omada.markdown b/source/_integrations/tplink_omada.markdown
index 5c8bb88ea64e..d81801236fc1 100644
--- a/source/_integrations/tplink_omada.markdown
+++ b/source/_integrations/tplink_omada.markdown
@@ -37,7 +37,7 @@ TP-Link Omada Controller:
- OC200
- OC300
-- Software Controller.
+- Software Controller
Controller versions 5.1.0 and later are supported.
@@ -45,18 +45,17 @@ Controller versions 5.1.0 and later are supported.
### Network Switches
-- Support for enabling/disabling Power over Ethernet on a per-port basis.
-- Firmware Update entities.
+- Support for enabling/disabling Power over Ethernet on a per-port basis
+- Firmware Update
### Access Points
-- Firmware Update entities.
+- Firmware Update
### Internet Gateways
-- Firmware Update entities.
-- WAN/LAN Port connectivity sensor entities.
-
-## Device trackers
-
-- Not currently supported.
+- WAN/LAN Port connectivity sensors
+- WAN Port Online detection sensors
+- WAN Port Connect/Disconnect switches
+- LAN Port PoE activity sensor
+- Firmware Update
diff --git a/source/_integrations/transmission.markdown b/source/_integrations/transmission.markdown
index 71551d120a65..f2b88eef5bf4 100644
--- a/source/_integrations/transmission.markdown
+++ b/source/_integrations/transmission.markdown
@@ -84,40 +84,40 @@ All Transmission services require integration `entry_id`. To find it, go to Deve
### Service `add_torrent`
-Adds a new torrent to download. It can either be a URL (HTTP, HTTPS or FTP), magnet link or a local file (make sure that the path is [white listed](/docs/configuration/basic/#allowlist_external_dirs)).
+Adds a new torrent to download. It can either be a URL (HTTP, HTTPS or FTP), magnet link or a local file (make sure that the path is [white listed](/integrations/homeassistant/#allowlist_external_dirs)).
-| Service data attribute | Optional | Description |
-| ---------------------- | -------- | ----------- |
-| `entry_id` | no | The integration entry_id
-| `torrent` | no | Torrent to download
+| Service data attribute | Optional | Description |
+| ---------------------- | -------- | ------------------------ |
+| `entry_id` | no | The integration entry_id |
+| `torrent` | no | Torrent to download |
### Service `remove_torrent`
Removes a torrent from the client.
-| Service data attribute | Optional | Description |
-| ---------------------- | -------- | ----------- |
-| `entry_id` | no | The integration entry_id
-| `id` | no | ID of the torrent, can be found in the `torrent_info` attribute of the `*_torrents` sensors
-| `delete_data` | yes | Delete torrent data (Default: false)
+| Service data attribute | Optional | Description |
+| ---------------------- | -------- | ------------------------------------------------------------------------------------------- |
+| `entry_id` | no | The integration entry_id |
+| `id` | no | ID of the torrent, can be found in the `torrent_info` attribute of the `*_torrents` sensors |
+| `delete_data` | yes | Delete torrent data (Default: false) |
### Service `start_torrent`
Starts a torrent.
-| Service data attribute | Optional | Description |
-| ---------------------- | -------- | ----------- |
-| `entry_id` | no | The integration entry_id
-| `id` | no | ID of the torrent, can be found in the `torrent_info` attribute of the `*_torrents` sensors
+| Service data attribute | Optional | Description |
+| ---------------------- | -------- | ------------------------------------------------------------------------------------------- |
+| `entry_id` | no | The integration entry_id |
+| `id` | no | ID of the torrent, can be found in the `torrent_info` attribute of the `*_torrents` sensors |
### Service `stop_torrent`
Stops a torrent.
-| Service data attribute | Optional | Description |
-| ---------------------- | -------- | ----------- |
-| `entry_id` | no | The integration entry_id
-| `id` | no | ID of the torrent, can be found in the `torrent_info` attribute of the `*_torrents` sensors
+| Service data attribute | Optional | Description |
+| ---------------------- | -------- | ------------------------------------------------------------------------------------------- |
+| `entry_id` | no | The integration entry_id |
+| `id` | no | ID of the torrent, can be found in the `torrent_info` attribute of the `*_torrents` sensors |
## Templating
diff --git a/source/_integrations/tts.markdown b/source/_integrations/tts.markdown
index c3f4e8bc0004..e0258a107865 100644
--- a/source/_integrations/tts.markdown
+++ b/source/_integrations/tts.markdown
@@ -12,6 +12,17 @@ ha_quality_scale: internal
ha_platforms:
- notify
ha_integration_type: entity
+related:
+ - url: https://www.home-assistant.io/integrations/#text-to-speech
+ title: List of integrations using the TTS integration
+ - url: https://www.nabucasa.com/config/tts/
+ title: TTS with Home Assistant Cloud
+ - url: https://www.home-assistant.io/integrations/google_translate/
+ title: Google Translate TTS
+ - url: https://www.home-assistant.io/integrations/microsoft/
+ title: Microsoft TTS
+ - url: https://www.home-assistant.io/voice_control/
+ title: Home Assistant Assist
---
Text-to-speech (TTS) enables Home Assistant to speak to you.
@@ -122,7 +133,7 @@ $ curl -X POST -H "Authorization: Bearer " \
{% endif %}
{{ content }}
+ {% include related.html %}
{% include feedback.html %}
diff --git a/source/_posts/2024-04-03-release-20244.markdown b/source/_posts/2024-04-03-release-20244.markdown
new file mode 100644
index 000000000000..64d6213de5b8
--- /dev/null
+++ b/source/_posts/2024-04-03-release-20244.markdown
@@ -0,0 +1,1052 @@
+---
+layout: post
+title: "2024.4: Organize all the things!"
+description: "Time for spring cleaning 🧹 Introducing new ways to organize your automations (and more) with floors, labels, and categories. Easily add Matter devices from other controllers, and two brand new map and webpage dashboards."
+date: 2024-04-03 00:00:00
+date_formatted: "April 3, 2024"
+author: Franck Nijhof
+author_twitter: frenck
+comments: true
+categories:
+ - Release-Notes
+ - Core
+og_image: /images/blog/2024-04/social.png
+---
+
+
+
+We also introduced multiple new filter types for each table. For example,
+{% term automations %} can now be filtered not only by {% term areas %},
+{% term entities %} , or {% term devices %}, but also by used
+{% term blueprints %}, labels, and categories (more on these later!).
+
+We didn’t stop at just that page! The devices and entities pages now also have
+a way to filter not only by state but also by integrations and areas. Almost all
+tables now have useful new filters to help you find what you are looking for.
+
+### Item grouping
+
+Browsing a list of hundreds of {% term automations %} or thousands of
+{% term entities %} can be overwhelming. While filters can help narrow the list,
+visually grouping the items into smaller chunks makes browsing easier.
+
+With the item grouping feature, we introduced a new dropdown menu to pick
+how you’d like the items on the table to be grouped. On the automations page,
+you can group automations by their {% term state %} - whether enabled
+or not - and custom categories (more on that later!). On the {% term devices %}
+page, you can even group them by manufacturers, {% term areas %},
+or {% term integrations %}, which is really cool because it makes the page much
+easier to browse. It gives you a new perspective on organizing your vast
+network of devices.
+
+
+
+### Selection mode and batch actions
+
+We removed the clutter of displaying a column of checkboxes by introducing
+a new selection mode. When it is toggled on, checkboxes will appear, and you
+can apply actions to all your selections with one click on the toolbar.
+
+
+
+## Three new ways to organize
+
+Upon reading through and ideating on the feature request thread on
+[“Automation Grouping”](https://community.home-assistant.io/t/grouping-automations-on-frontend-for-organization/102771),
+we realized that organization can be done in multiple ways for different purposes.
+
+We learned that users who are proficient in making {% term automations %} have
+hundreds of them, which makes locating a particular automation hard. They often
+had to resort to using "hacks" such as emojis, bracketed “tags”, or numbering
+each automation to get the sort order they wanted. They needed a way to easily
+filter down and break down the giant list into more manageable chunks.
+
+We also noticed that users are stretching our areas feature beyond its
+intended purpose. For example, some users would create “{% term areas %}” such
+as “3D printer”, “Christmas decorations”, or even “Left side of my office desk”,
+to group different {% term devices %} and {% term entities %} together under
+one umbrella for dashboards or {% term automations %}.
+
+As we are developing our new dashboards and voice commands, this poses a
+big problem: We would be unable to provide specialized solutions if a dashboard
+{% term blueprint %} or automation blueprint cannot confidently assume the context of
+how it would be used. We need something more specialized.
+
+Therefore, to balance the basic goal of providing a more digestible UI for
+all users, the need for flexibility for our power users, and the future vision
+of Home Assistant, we are introducing 3 new organization structures to
+Home Assistant:
+
+**[Floors](#floors-help-home-assistant-understand-your-house)**,
+**[Labels](#labels-tag-everything-any-way-you-want)**,
+and **[Categories](#categories-make-each-settings-page-easier-to-browse)**
+
+### Floors: Help Home Assistant understand your house
+
+Let's talk about the new organizational structures, starting with **floors**.
+
+To become a truly intelligent home automation platform, Home Assistant needs
+to understand the context: Where exactly is a {% term device%}? How does one
+{%term area %} relate to another? What is the space used for?
+
+Currently, Home Assistant has {% term areas %}. Areas specify the physical
+location or vicinity of your devices per living space in your home
+(like the living room or kitchen). However, some users living in standalone
+houses might have multiple floors with their own areas.
+
+{% term Floors %} are a new way to organize your areas per level of floors in
+your home. The better Home Assistant knows your home and how it is spatially
+structured, the better it can help you. Especially when it comes to future
+features like generating dashboards, voice commands, and maybe even
+AI-related features.
+
+
+
+You can use floors in your {% term automations %} and {% term scripts %} as a
+target for your actions or control them with your voice. For example, you can
+turn off all the lights on the downstairs floor when you go to bed or ask
+[Assist](/voice_control/) to turn on the lights upstairs.
+
+For our power users, you can even use [floors in your templates](/docs/configuration/templating/#floors)
+to create the most advanced and creative automations.
+
+{% my areas badge %}
+
+### Labels: Tag everything any way you want
+
+{% term Floors %} and {% term areas %} are great for representing your actual
+home, but as everyone has their own ways of organizing their home, everyone
+has their own ways of organizing their Home Assistant, too!
+This is where **labels** 🏷️ come in!
+
+Labels is an organizational structure that is completely up to you. You can
+make as many labels with any naming structure, in any color 🌈 you want, and
+assign them to basically anything in Home Assistant. You assign labels to
+anything: {% term areas %}, {% term devices %}, {% term entities %},
+{% term automations %}, {% term scripts %}, helpers, you name it!
+You can even assign multiple labels to the same thing.
+
+
+
+Just like with floors, you can use labels in your automations and scripts as
+a target for your {% term actions %}. This gives you a lot of flexibility,
+not just in organizing your Home Assistant, but also in automating your home! 🤯
+
+For example, you could create a label "🎄 Christmas" to label all your
+Christmas decorations during the holiday season. You can then use this label to
+automate all of those decorations at once or to filter them in the new tables.
+
+More examples? You could create a label "🔒 Security" to label and control all
+your security-related devices and automations. Or, "🛌 Bedrooms" to label all
+your bedroom areas and simultaneously control all the devices in those areas.
+
+Do you have solar panels or home batteries? Create a label "⚡️ Heavy energy usage"
+to label devices that consume a lot of energy. You could switch them off when
+there is not enough battery or solar energy available.
+
+You decide how to use labels, and the possibilities are endless! And for our
+power users, you guessed it, you can use [labels in your templates](/docs/configuration/templating/#labels).
+
+{% my labels badge %}
+
+### Categories: Make each settings page easier to browse
+
+Last but not least, we are introducing **categories**. Categories are designed
+to be paired with the aforementioned [item grouping feature](#item-grouping),
+and it can be used to group things visually specific to a certain table
+in Home Assistant.
+
+This is great for those who have a particular way of displaying their
+{% term entities %} by separating them into multiple sections on a specific page.
+For example, on the {% term automations %} page, you can create categories only
+used for visually grouping automations but nowhere else, like "Notifications"
+or “NFC tags”. You can then view your automations grouped or filtered by
+those categories.
+
+
+
+As these categories are unique for each dashboard, you can have different
+sets of categories depending on the place you are organizing. This means
+you can have different categories on the automations page than the
+{% term scene %}, {% term scripts %}, or helpers settings page.
+
+### Time to clean up your Home Assistant!
+
+In summary, there are a total of 4 taxonomies for organizing your entities.
+It sounds like a lot, but they all serve a distinct purpose. We are extending
+and clarifying {% term areas %} with {% term floors %}, and we are introducing
+{% term labels %} and {% term categories %} to make your {% term automations %}
+and many other tables look more organized and be more manageable.
+
+What’s next? Time to dig in! Here are a few steps we recommend you take
+action on to organize your Home Assistant better:
+
+- **Migrate to labels**:
+ - If you have been grouping automations with emojis and bracketed text,
+ you can now create labels for each. Labels can have icons to replace the
+ emojis you had before.
+ - For areas that aren’t really physical spaces, switching them to labels will
+ provide you more flexibility in organizing your entities.
+- **Start using categories**:
+ If you have a favorite way of organizing a particular page, create those
+ categories and group the table by them. For example, you could create a
+ notification category for all your notification automations and put all
+ notification automations in that category.
+- **Group your areas into floors**:
+ If you live in a multi-story home, grouping areas into floors help with
+ organizing the areas as well as making them more compatible with future
+ features.
+
+Last of all, to help us to help you to perfect the design of these new features,
+we would love to hear your feedback and see how you use them! Please feel free
+to share them in the comments below and discuss them in our community.
+
+## Map dashboard
+
+Introducing a new dashboard this release: The **map**! 🗺️
+
+You might think, "Hey, we already have a map dashboard in Home Assistant!"
+and you are right! However, the map was an integration that was always there
+and didn't provide the flexibility and features that were wanted.
+
+With the map dashboard's introduction, you can now add multiple map dashboards
+with different entities and configuration settings. For example, create a
+dashboard to show the location of your family members, another to track your
+car, and another to show the location of your pets. 🐶
+
+
+
+On upgrade, Home Assistant will automatically migrate your existing map
+integration to a map dashboard.
+
+You don't like having the map in your sidebar? Well, that is no longer a
+problem. Since it is now a dashboard it means you can remove it in the dashboard
+settings.
+
+## Webpage dashboard
+
+Another new dashboard for this release is the **webpage**! 🌐
+
+The webpage dashboard allows you to add and embed a webpage to your dashboard.
+This could be a web page from the internet or a local web page from a local
+machine or device like your router or NAS.
+
+
+
+This dashboard replaces the old iFrame panel (`iframe_panel`). If you have
+existing panels configured in your YAML configuration, Home Assistant will
+automatically migrate them to the new webpage dashboard on upgrade.
+
+
+
+Note that not every webpage can be embedded due to security restrictions that
+some sites or pages have in place, enforced by your browser, that prevent
+embedding them into a Home Assistant dashboard.
+
+## Define the columns in the section view
+
+In the last release, we [introduced the section view](/blog/2024/03/06/release-20243/#a-new-experimental-sections-view)
+with drag and drop support. We are absolutely thrilled to see how many of you
+loved it! 🥰
+
+Many thanks for all the feedback and suggestions! We are prioritizing them and
+are working on making the section view even better in the upcoming releases.
+
+In this release, based on your feedback, we have added the ability for you to
+define the maximum number of columns that the section view uses. This allows you
+to limit the number of columns, regardless of the screen width on which you
+are viewing your dashboard.
+
+
+
+## Adding Matter devices from other controllers
+
+In the [February release](/blog/2024/02/07/release-20242/#matter-diagnostics-and-actions),
+we added support for sharing Matter devices tied to Home Assistant with other
+Matter controllers. This release, we are making the other way around easier.
+
+We have improved how you can add Matter devices from other controllers to
+Home Assistant. When you add a Matter device to Home Assistant, it will now
+ask you if you want to add a new Matter device or if you want to add a device
+that is already added to another controller (like Google Home or Apple Home).
+
+
+
+Suppose you choose to add a device that has already been added to another
+controller. In that case, Home Assistant will guide you through how to
+achieve this step by step.
+
+
+
+## Lock behavior improvements
+
+Some smart locks have an open (or unlatching) mechanism that can be triggered
+remotely. The door either pops out of the lock or can be opened by pushing
+against the door.
+
+We want to ensure you don't accidentally open the door when you miss-clicked
+the button (for example, while not at home 😬). Therefore, we have improved
+the behavior of locks in our user interface by requiring you to confirm the
+action.
+
+
+
+## Even more performance!
+
+Remember how we wrote last release that [Home Assistant now boots twice as fast](/blog/2024/03/06/release-20243/#home-assistant-boots-twice-as-fast)?
+Well, [@bdraco] wasn't done yet and teamed up with [@balloob]. If you thought
+the previous release was fast, you are in for a treat! 🚀 The difference is,
+yet again, very noticeable.
+
+Besides streamlining what is loaded at startup (and doing less loading), we
+have adjusted the startup time tracking. It used to be that one integration
+could push other integrations to be slow too; that should no longer be the case,
+making this a more accurate representation of the actual startup time.
+
+Want to learn about the individual startup times of your integrations? You can
+find them in the {% my repairs title="**Settings** -> **System** -> **Repairs**" %}
+page by selecting the three-dotted menu in the top right and selecting the
+**Integration startup time** item.
+
+{% my repairs badge %}
+
+[@bdraco]: https://github.com/bdraco
+[@balloob]: https://github.com/balloob
+
+## Other noteworthy changes
+
+There are many more improvements in this release; here are some of the other
+noteworthy changes this release:
+
+- [@karwosts] has improved your Home Assistant {% my profile title="user profile" %}
+ page, making navigating and finding the settings you are looking for easier.
+ Nice work!
+- If you use a [sentence trigger] in your automation to trigger it using
+ [Assist]. The trigger will now include the `device_id` in its trigger data
+ you can automate with. Thanks, [@synesthesiam]!
+- The [HomeWizard Energy] integration now supports the newest generation of
+ HomeWizard Energy Sockets! Thanks, [@DCSBL]!
+- We can now ship new releases of Home Assistant in waaay less time.
+ Building and shipping Home Assistant for you, went down from 1.5-2 hours to
+ just 20 minutes! 🚀 Thanks [@edenhaus]!
+ [Learn more about it in our developer blog](https://developers.home-assistant.io/blog/2024/04/03/build-images-with-uv/).
+- [Reolink] now supports PTZ patrol start/stop, package detection and controls
+ for playing quick reply messages. Thanks, [@starkillerOG]!
+- We have brand new template functions available to list [all the issues] in
+ your repairs dashboard. Thanks, [@RoboMagus]!
+- If you prefer your wind speed sensors to be in Beaufort, you are in luck!
+ You can now change the unit of measurement to Beaufort. Thanks, [@fwestenberg]!
+- The [Husqvarna Automower] integration development continues and has additional
+ new entities, including sensors, select entities, and a device tracker.
+ Thanks, [@Thomas55555]!
+- [@catsmanac] has added a sensor to monitor the battery storage attached
+ to your [Enphase Envoy]; it works with the energy dashboard! Nice!
+- The [Xiaomi BLE] integration now supports locks and fingerprint readers!
+ Awesome, [@Ernst79]!
+
+[@catsmanac]: https://github.com/catsmanac
+[@DCSBL]: https://github.com/DCSBL
+[@edenhaus]: https://github.com/edenhaus
+[@Ernst79]: https://github.com/Ernst79
+[@fwestenberg]: https://github.com/fwestenberg
+[@karwosts]: https://github.com/karwosts
+[@RoboMagus]: https://github.com/RoboMagus
+[@starkillerOG]: https://github.com/starkillerOG
+[@synesthesiam]: https://github.com/synesthesiam
+[@Thomas55555]: https://github.com/Thomas55555
+[all the issues]: /docs/configuration/templating/#issues
+[Assist]: /voice_control/
+[Enphase Envoy]: /integrations/enphase_envoy
+[HomeWizard Energy]: /integrations/homewizard
+[Husqvarna Automower]: /integrations/husqvarna_automower
+[Reolink]: /integrations/reolink
+[sentence trigger]: /docs/automation/trigger/#sentence-trigger
+[Xiaomi BLE]: /integrations/xiaomi_ble
+
+## New integrations
+
+We welcome the following new integrations in this release:
+
+- **[Fyta]**, added by [@dontinelli]
+ Monitor your plants with Fyta, a smart plant sensor that measures light, + temperature, humidity, and soil moisture. +- **[Motionblinds Bluetooth]**, added by [@LennP]
+ Control your Bluetooth Low Energy Motionblinds motorized window coverings. +- **[Ollama]**, added by [@synesthesiam]
+ Ollama a fully local AI conversation platform that can be used to create + custom voice assistants. + +[@dontinelli]: https://github.com/dontinelli +[@LennP]: https://github.com/LennP +[@synesthesiam]: https://github.com/synesthesiam +[Fyta]: /integrations/fyta +[Motionblinds Bluetooth]: /integrations/motionblinds_ble +[Ollama]: /integrations/ollama + +This release also has new virtual integration. Virtual integrations are stubs +that are handled by other (existing) integrations to help with findability. +The following virtual integration have been added: + +- **[Sacramento Municipal Utility District (SMUD)]**, provided by [Opower] + +[Sacramento Municipal Utility District (SMUD)]: /integrations/smud +[Opower]: /integrations/opower + +## Integrations now available to set up from the UI + +The following integrations are now available via the Home Assistant UI: + +- **[Lutron Homeworks]**, done by [@emontnemery] +- **[17TRACK]**, done by [@shaiu] +- **[Downloader]**, done by [@erwindouna] +- **[ROVA]**, done by [@GidoHakvoort] + +[@emontnemery]: https://github.com/emontnemery +[@erwindouna]: https://github.com/erwindouna +[@GidoHakvoort]: https://github.com/GidoHakvoort +[@shaiu]: https://github.com/shaiu +[17TRACK]: /integrations/seventeentrack +[Downloader]: /integrations/downloader +[Lutron Homeworks]: /integrations/homeworks +[ROVA]: /integrations/rova + +## Release 2024.4.1 - April 5 + +- Update aioairzone-cloud to v0.4.7 ([@Noltari] - [#114761]) +- Bump myuplink dependency to 0.6.0 ([@astrandb] - [#114767]) +- Update romy to 0.0.9 ([@cdce8p] - [#114360]) +- Update romy to 0.0.10 ([@xeniter] - [#114785]) +- Fix unhandled `KeyError` during Notion setup ([@bachya] - [#114787]) +- Fix Lutron light brightness values ([@cdheiser] - [#114794]) +- Fix type cast in snmp ([@lextm] - [#114795]) +- Handle ambiguous script actions by using action map order ([@bdraco] - [#114825]) +- Bump opower to 0.4.3 ([@tronikos] - [#114826]) +- Refactor ConfigStore to avoid needing to pass config_dir ([@bdraco] - [#114827]) +- Avoid blocking IO in downloader initialization ([@joostlek] - [#114841]) +- Fix Downloader YAML import ([@joostlek] - [#114844]) +- Update frontend to 20240404.0 ([@bramkragten] - [#114859]) +- Fix Axis camera platform support HTTPS ([@Kane610] - [#114886]) +- Bump weatherflow4py to 0.2.20 ([@jeeftor] - [#114888]) +- Fix Axis reconfigure step not providing protocols as alternatives but as string ([@Kane610] - [#114889]) +- Update frontend to 20240404.1 ([@bramkragten] - [#114890]) +- Ensure all tables have the default table args in the db_schema ([@bdraco] - [#114895]) +- Reduce august polling frequency ([@bdraco] - [#114904]) +- Show correct model string in myuplink ([@astrandb] - [#114921]) +- Create right import issues in Downloader ([@joostlek] - [#114922]) +- Fix cast dashboard in media browser ([@joostlek] - [#114924]) +- Pin systembridgemodels to 4.0.4 ([@timmo001] - [#114842]) +- Fix ROVA validation ([@joostlek] - [#114938]) + +[#114360]: https://github.com/home-assistant/core/pull/114360 +[#114761]: https://github.com/home-assistant/core/pull/114761 +[#114764]: https://github.com/home-assistant/core/pull/114764 +[#114767]: https://github.com/home-assistant/core/pull/114767 +[#114785]: https://github.com/home-assistant/core/pull/114785 +[#114787]: https://github.com/home-assistant/core/pull/114787 +[#114794]: https://github.com/home-assistant/core/pull/114794 +[#114795]: https://github.com/home-assistant/core/pull/114795 +[#114825]: https://github.com/home-assistant/core/pull/114825 +[#114826]: https://github.com/home-assistant/core/pull/114826 +[#114827]: https://github.com/home-assistant/core/pull/114827 +[#114841]: https://github.com/home-assistant/core/pull/114841 +[#114842]: https://github.com/home-assistant/core/pull/114842 +[#114844]: https://github.com/home-assistant/core/pull/114844 +[#114859]: https://github.com/home-assistant/core/pull/114859 +[#114886]: https://github.com/home-assistant/core/pull/114886 +[#114888]: https://github.com/home-assistant/core/pull/114888 +[#114889]: https://github.com/home-assistant/core/pull/114889 +[#114890]: https://github.com/home-assistant/core/pull/114890 +[#114895]: https://github.com/home-assistant/core/pull/114895 +[#114904]: https://github.com/home-assistant/core/pull/114904 +[#114921]: https://github.com/home-assistant/core/pull/114921 +[#114922]: https://github.com/home-assistant/core/pull/114922 +[#114924]: https://github.com/home-assistant/core/pull/114924 +[#114938]: https://github.com/home-assistant/core/pull/114938 +[@Kane610]: https://github.com/Kane610 +[@Noltari]: https://github.com/Noltari +[@astrandb]: https://github.com/astrandb +[@bachya]: https://github.com/bachya +[@bdraco]: https://github.com/bdraco +[@bramkragten]: https://github.com/bramkragten +[@cdce8p]: https://github.com/cdce8p +[@cdheiser]: https://github.com/cdheiser +[@frenck]: https://github.com/frenck +[@jeeftor]: https://github.com/jeeftor +[@joostlek]: https://github.com/joostlek +[@lextm]: https://github.com/lextm +[@timmo001]: https://github.com/timmo001 +[@tronikos]: https://github.com/tronikos +[@xeniter]: https://github.com/xeniter + +## Release 2024.4.2 - April 8 + +- Fix hang in SNMP device_tracker implementation ([@nmaggioni] - [#112815]) +- Fix missing if statement in homematic ([@bbr111] - [#114832]) +- Bump pylitterbot to 2023.4.11 ([@natekspencer] - [#114918]) +- Fix Snapcast Config flow ([@joostlek] - [#114952]) +- Bump axis to v61 ([@Kane610] - [#114964]) +- Filter out fuzzy translations from Lokalise ([@joostlek] - [#114968]) +- Upgrade to pynobo 1.8.1 ([@oyvindwe] - [#114982]) +- Fix dictionary changed size during iteration in prometheus ([@bdraco] - [#115005]) +- Bump `brother` to version 4.1.0 ([@bieniu] - [#115021]) +- Bump yolink-api to 0.4.2 ([@matrixd2] - [#115026]) +- Update xknxproject to 3.7.1 ([@farmio] - [#115053]) +- Fix synology_dsm availablity ([@bdraco] - [#115073]) +- Downgrade hass-nabucasa from 0.80.0 to 0.78.0 ([@ludeeus] - [#115078]) +- Bump velbus-aio to 2024.4.1 ([@Cereal2nd] - [#115109]) +- Terminate scripts with until and while conditions that execute more than 10000 times ([@bdraco] - [#115110]) +- improve handling of incorrect values in fyta integration ([@dontinelli] - [#115134]) +- Bump fyta_cli to 0.3.5 ([@dontinelli] - [#115143]) +- Fix fibaro sensor additional sensor lookup ([@rappenze] - [#115148]) +- Write timer entity state before firing events ([@bdraco] - [#115151]) +- Avoid checking for polling if an entity fails to add ([@bdraco] - [#115159]) +- Only reset requested utility meter with no tariff ([@gibwar] - [#115170]) + +[#112815]: https://github.com/home-assistant/core/pull/112815 +[#114764]: https://github.com/home-assistant/core/pull/114764 +[#114832]: https://github.com/home-assistant/core/pull/114832 +[#114918]: https://github.com/home-assistant/core/pull/114918 +[#114934]: https://github.com/home-assistant/core/pull/114934 +[#114952]: https://github.com/home-assistant/core/pull/114952 +[#114964]: https://github.com/home-assistant/core/pull/114964 +[#114968]: https://github.com/home-assistant/core/pull/114968 +[#114982]: https://github.com/home-assistant/core/pull/114982 +[#115005]: https://github.com/home-assistant/core/pull/115005 +[#115021]: https://github.com/home-assistant/core/pull/115021 +[#115026]: https://github.com/home-assistant/core/pull/115026 +[#115053]: https://github.com/home-assistant/core/pull/115053 +[#115073]: https://github.com/home-assistant/core/pull/115073 +[#115078]: https://github.com/home-assistant/core/pull/115078 +[#115109]: https://github.com/home-assistant/core/pull/115109 +[#115110]: https://github.com/home-assistant/core/pull/115110 +[#115134]: https://github.com/home-assistant/core/pull/115134 +[#115143]: https://github.com/home-assistant/core/pull/115143 +[#115148]: https://github.com/home-assistant/core/pull/115148 +[#115151]: https://github.com/home-assistant/core/pull/115151 +[#115159]: https://github.com/home-assistant/core/pull/115159 +[#115170]: https://github.com/home-assistant/core/pull/115170 +[@Cereal2nd]: https://github.com/Cereal2nd +[@Kane610]: https://github.com/Kane610 +[@bbr111]: https://github.com/bbr111 +[@bdraco]: https://github.com/bdraco +[@bieniu]: https://github.com/bieniu +[@dontinelli]: https://github.com/dontinelli +[@farmio]: https://github.com/farmio +[@frenck]: https://github.com/frenck +[@gibwar]: https://github.com/gibwar +[@joostlek]: https://github.com/joostlek +[@ludeeus]: https://github.com/ludeeus +[@matrixd2]: https://github.com/matrixd2 +[@natekspencer]: https://github.com/natekspencer +[@nmaggioni]: https://github.com/nmaggioni +[@oyvindwe]: https://github.com/oyvindwe +[@rappenze]: https://github.com/rappenze + +## Release 2024.4.3 - April 12 + +- Bump aiohttp to 3.9.4 ([@bdraco] - [#110730]) +- Add support for adopt data disk repair ([@mdegat01] - [#114891]) +- Improve Risco exception logging ([@OnFreund] - [#115232]) +- Configurable maximum concurrency in Risco local ([@OnFreund] - [#115226]) +- Fix misssing timeout in caldav ([@bdraco] - [#115247]) +- Fix Google Tasks parsing of remove responses ([@allenporter] - [#115258]) +- Bump forecast-solar lib to v3.1.0 ([@klaasnicolaas] - [#115272]) +- Support backup of add-ons with hyphens ([@agners] - [#115274]) +- Bump pymodbus v3.6.7 ([@janiversen] - [#115279]) +- Bump yt-dlp to 2024.04.09 ([@joostlek] - [#115295]) +- Fix Aranet failure when the Bluetooth proxy is not providing a device name ([@thecode] - [#115298]) +- Bump zha-quirks to 0.0.114 ([@TheJulianJES] - [#115299]) +- Ensure automations do not execute from a trigger if they are disabled ([@bdraco] - [#115305]) +- Bump bleak-retry-connector 3.5.0 ([@bdraco] - [#115328]) +- Secure against resetting a non active modbus ([@janiversen] - [#115364]) +- Solve modbus test problem ([@janiversen] - [#115376]) +- Fix deadlock in holidays dynamic loading ([@bdraco] - [#115385]) +- Bump whirlpool-sixth-sense to 0.18.8 ([@NodeJSmith] - [#115393]) +- Fix bug in rainbird switch when turning off a switch that is already off ([@allenporter] - [#115421]) +- Bump pybotvac to 0.0.25 ([@Santobert] - [#115435]) +- Update frontend to 20240404.2 ([@bramkragten] - [#115460]) + +[#110730]: https://github.com/home-assistant/core/pull/110730 +[#114764]: https://github.com/home-assistant/core/pull/114764 +[#114891]: https://github.com/home-assistant/core/pull/114891 +[#114934]: https://github.com/home-assistant/core/pull/114934 +[#115186]: https://github.com/home-assistant/core/pull/115186 +[#115226]: https://github.com/home-assistant/core/pull/115226 +[#115232]: https://github.com/home-assistant/core/pull/115232 +[#115247]: https://github.com/home-assistant/core/pull/115247 +[#115258]: https://github.com/home-assistant/core/pull/115258 +[#115272]: https://github.com/home-assistant/core/pull/115272 +[#115274]: https://github.com/home-assistant/core/pull/115274 +[#115279]: https://github.com/home-assistant/core/pull/115279 +[#115295]: https://github.com/home-assistant/core/pull/115295 +[#115298]: https://github.com/home-assistant/core/pull/115298 +[#115299]: https://github.com/home-assistant/core/pull/115299 +[#115305]: https://github.com/home-assistant/core/pull/115305 +[#115328]: https://github.com/home-assistant/core/pull/115328 +[#115364]: https://github.com/home-assistant/core/pull/115364 +[#115376]: https://github.com/home-assistant/core/pull/115376 +[#115385]: https://github.com/home-assistant/core/pull/115385 +[#115393]: https://github.com/home-assistant/core/pull/115393 +[#115421]: https://github.com/home-assistant/core/pull/115421 +[#115435]: https://github.com/home-assistant/core/pull/115435 +[#115460]: https://github.com/home-assistant/core/pull/115460 +[@NodeJSmith]: https://github.com/NodeJSmith +[@OnFreund]: https://github.com/OnFreund +[@Santobert]: https://github.com/Santobert +[@TheJulianJES]: https://github.com/TheJulianJES +[@agners]: https://github.com/agners +[@allenporter]: https://github.com/allenporter +[@bdraco]: https://github.com/bdraco +[@bramkragten]: https://github.com/bramkragten +[@frenck]: https://github.com/frenck +[@janiversen]: https://github.com/janiversen +[@joostlek]: https://github.com/joostlek +[@klaasnicolaas]: https://github.com/klaasnicolaas +[@mdegat01]: https://github.com/mdegat01 +[@thecode]: https://github.com/thecode + +## Release 2024.4.4 - April 23 + +- Bump slixmpp version to 1.8.5 ([@ravermeister] - [#114448]) +- Make Withings recoverable after internet outage ([@joostlek] - [#115124]) +- Fix Hyperion light not updating state ([@avee87] - [#115389]) +- Add scheduled mode to renault charge mode ([@slyoldfox] - [#115427]) +- Bump zeroconf to 0.132.1 ([@bdraco] - [#115501]) +- Bump zeroconf to 0.132.2 ([@bdraco] - [#115505]) +- Update pillow to 10.3.0 ([@cdce8p] - [#115524]) +- Fix race in TimestampDataUpdateCoordinator ([@bdraco] - [#115542]) +- Fix Teslemetry sensor values ([@Bre77] - [#115571]) +- Modbus: Bump pymodbus v3.6.8 ([@janiversen] - [#115574]) +- Fix sensor entity description in Teslemetry ([@Bre77] - [#115614]) +- Bump httpcore to 1.0.5 ([@bdraco] - [#115672]) +- Bump sqlparse to 0.5.0 ([@bdraco] - [#115681]) +- Bump aiohttp to 3.9.5 ([@bdraco] - [#115727]) +- Bump renault-api to 0.2.2 ([@epenet] - [#115738]) +- Fix homeworks import flow ([@emontnemery] - [#115761]) +- Allow [##:##:##] type keypad address in homeworks ([@emontnemery] - [#115762]) +- Add missing media_player features to Samsung TV ([@chemelli74] - [#115788]) +- Bump aiounifi to v75 ([@Kane610] - [#115819]) +- Ensure scripts with timeouts of zero timeout immediately ([@bdraco] - [#115830]) +- Fix KeyError error when fetching sensors (Airthings) ([@LaStrada] - [#115844]) +- Bump plexapi to 4.15.12 ([@jjlawren] - [#115872]) +- Bump ical to 8.0.0 ([@allenporter] - [#115907]) +- Fix geo location attributes of Tankerkoenig sensors ([@mib1185] - [#115914]) +- Use start helper in squeezebox for server discovery ([@rajlaud] - [#115978]) + +[#114448]: https://github.com/home-assistant/core/pull/114448 +[#114764]: https://github.com/home-assistant/core/pull/114764 +[#114934]: https://github.com/home-assistant/core/pull/114934 +[#115124]: https://github.com/home-assistant/core/pull/115124 +[#115186]: https://github.com/home-assistant/core/pull/115186 +[#115389]: https://github.com/home-assistant/core/pull/115389 +[#115427]: https://github.com/home-assistant/core/pull/115427 +[#115463]: https://github.com/home-assistant/core/pull/115463 +[#115501]: https://github.com/home-assistant/core/pull/115501 +[#115505]: https://github.com/home-assistant/core/pull/115505 +[#115524]: https://github.com/home-assistant/core/pull/115524 +[#115542]: https://github.com/home-assistant/core/pull/115542 +[#115571]: https://github.com/home-assistant/core/pull/115571 +[#115574]: https://github.com/home-assistant/core/pull/115574 +[#115614]: https://github.com/home-assistant/core/pull/115614 +[#115672]: https://github.com/home-assistant/core/pull/115672 +[#115681]: https://github.com/home-assistant/core/pull/115681 +[#115727]: https://github.com/home-assistant/core/pull/115727 +[#115738]: https://github.com/home-assistant/core/pull/115738 +[#115761]: https://github.com/home-assistant/core/pull/115761 +[#115762]: https://github.com/home-assistant/core/pull/115762 +[#115788]: https://github.com/home-assistant/core/pull/115788 +[#115819]: https://github.com/home-assistant/core/pull/115819 +[#115830]: https://github.com/home-assistant/core/pull/115830 +[#115844]: https://github.com/home-assistant/core/pull/115844 +[#115872]: https://github.com/home-assistant/core/pull/115872 +[#115907]: https://github.com/home-assistant/core/pull/115907 +[#115914]: https://github.com/home-assistant/core/pull/115914 +[#115978]: https://github.com/home-assistant/core/pull/115978 +[@Bre77]: https://github.com/Bre77 +[@Kane610]: https://github.com/Kane610 +[@LaStrada]: https://github.com/LaStrada +[@allenporter]: https://github.com/allenporter +[@avee87]: https://github.com/avee87 +[@bdraco]: https://github.com/bdraco +[@cdce8p]: https://github.com/cdce8p +[@chemelli74]: https://github.com/chemelli74 +[@emontnemery]: https://github.com/emontnemery +[@epenet]: https://github.com/epenet +[@frenck]: https://github.com/frenck +[@janiversen]: https://github.com/janiversen +[@jjlawren]: https://github.com/jjlawren +[@joostlek]: https://github.com/joostlek +[@mib1185]: https://github.com/mib1185 +[@rajlaud]: https://github.com/rajlaud +[@ravermeister]: https://github.com/ravermeister +[@slyoldfox]: https://github.com/slyoldfox + +## Need help? Join the community! + +Home Assistant has a great community of users who are all more than willing +to help each other out. So, join us! + +Our very active [Discord chat server](/join-chat) is an excellent place to be +at, and don't forget to join our amazing [forums](https://community.home-assistant.io/). + +Found a bug or issue? Please report it in our [issue tracker](https://github.com/home-assistant/core/issues), +to get it fixed! Or, check [our help page](/help) for guidance for more +places you can go. + +Are you more into email? [Sign-up for our Building the Open Home Newsletter](/newsletter) +to get the latest news about features, things happening in our community and +other news about building an Open Home; straight into your inbox. + +## Backward-incompatible changes + +{% details "Python 3.11 support has been removed" %} + +Python 3.11 support has previously been deprecated and has now been removed. +Home Assistant now requires Python 3.12 to run. + +You don’t have to do anything if you are using the Home Assistant Operating +System, Home Assistant Container, or Home Assistant Supervised installation +method. In those cases, we handle all of this for you. Your system has been +using Python 3.12 for quite some time already. + +([@frenck] - [#114220]) + +[@frenck]: https://github.com/frenck +[#114220]: https://github.com/home-assistant/core/pull/114220 + +{% enddetails %} + +{% details "AEMET OpenData" %} + +The AEMET OpenData integration previously created two entities for each +configured location: one provided daily weather forecasts and the other hourly +forecasts. + +The AEMET OpenData integration now only creates a single entity that provides +both daily and hourly weather forecasts. + +([@gjohansson-ST] - [#110764]) ([documentation](/integrations/aemet)) + +[@gjohansson-ST]: https://github.com/gjohansson-ST +[#110764]: https://github.com/home-assistant/core/pull/110764 + +{% enddetails %} + +{% details "Dexcom" %} + +The trend sensor now uses values that are using snake_case instead of a space +in the middle: + +- `rising quickly` -> `rising_quickly` +- `rising slightly` -> `rising_slightly` +- `falling slightly` -> `falling_slightly` +- `falling quickly` -> `falling_quickly` + +Please update your automations and scripts accordingly. + +([@joostlek] - [#112423]) ([documentation](/integrations/dexcom)) + +[@joostlek]: https://github.com/joostlek +[#112423]: https://github.com/home-assistant/core/pull/112423 + +{% enddetails %} + +{% details "ecobee" %} + +The non-functional `away` preset mode has been replaced with the correct +`away_indefinitely` preset mode. + +If any automation or script depends on the `away` preset mode, +it needs to be updated. + +([@alexsydell] - [#108636]) ([documentation](/integrations/ecobee)) + +[@alexsydell]: https://github.com/alexsydell +[#108636]: https://github.com/home-assistant/core/pull/108636 + +{% enddetails %} + +{% details "Environment Canada" %} + +The Environment Canada integration previously created two entities for each +configured location: one provided daily weather forecasts and the other hourly +forecasts. + +The Environment Canada integration now only creates a single entity that +provides both daily and hourly weather forecasts. + +([@gjohansson-ST] - [#112447]) ([documentation](/integrations/environment_canada)) + +[@gjohansson-ST]: https://github.com/gjohansson-ST +[#112447]: https://github.com/home-assistant/core/pull/112447 + +{% enddetails %} + +{% details "National Weather Service (NWS)" %} + +The National Weather Service integration previously created two entities for each +configured location: one provided daily weather forecasts and the other hourly +forecasts. + +The National Weather Service integration now only creates a single entity that +provides both daily and hourly weather forecasts. + +([@gjohansson-ST] - [#112503]) ([documentation](/integrations/nws)) + +[@gjohansson-ST]: https://github.com/gjohansson-ST +[#112503]: https://github.com/home-assistant/core/pull/112503 + +{% enddetails %} + +{% details "Met Éireann" %} + +The Met Éireann integration previously created two entities for each configured +location: one provided daily weather forecasts and the other hourly forecasts. + +The Met Éireann integration now only creates a single entity that provides both +daily and hourly weather forecasts. + +([@gjohansson-ST] - [#112449]) ([documentation](/integrations/met_eireann)) + +[@gjohansson-ST]: https://github.com/gjohansson-ST +[#112449]: https://github.com/home-assistant/core/pull/112449 + +{% enddetails %} + +{% details "Met Office" %} + +The Met Office integration previously created two entities for each configured +location: one provided daily weather forecasts and the other hourly forecasts. + +The Met Office integration now only creates a single entity that provides both +daily and hourly weather forecasts. + +([@gjohansson-ST] - [#112452]) ([documentation](/integrations/metoffice)) + +[@gjohansson-ST]: https://github.com/gjohansson-ST +[#112452]: https://github.com/home-assistant/core/pull/112452 + +{% enddetails %} + +{% details "Modbus" %} + +The Modbus integration does not allow a configuration with the device only +(no entities); this will create an issue, and the entry will not be loaded. + +For the special cases (like some custom_components) where it is wanted, +please add a dummy entity. + +([@janiversen] - [#113516]) ([documentation](/integrations/modbus)) + +[@janiversen]: https://github.com/janiversen +[#113516]: https://github.com/home-assistant/core/pull/113516 + +{% enddetails %} + +{% details "MQTT" %} + +Support for `brightness` is now assumed for `mqtt` lights with the `json` schema +unless only color modes `rgb`, `rgbw`, or `rgbww` are supported. + +For lights which only support color modes `rgb`, `rgbw`, or `rgbww`, +the `brightness` option flag can still be set to `false` if brightness is not +supported. In this case brightness support is emulated in Home Assistant by +scaling the RGBx-values. + +For all other color modes except `ColorMode.ONOFF`, it is assumed brightness is +supported, and the `brightness` attribute will be included in the MQTT payload +when the `brightness` attribute is supplied to the `light.turn_on` service. + +([@jbouwh] - [#111676]) ([documentation](/integrations/mqtt)) + +[@jbouwh]: https://github.com/jbouwh +[#111676]: https://github.com/home-assistant/core/pull/111676 + +{% enddetails %} + +{% details "myUplink" %} + +If you have a Nibe SMO 20 in your account, you will notice that some 550 +entities are no longer provided by the integration. + +You can safely remove these entities as the integration does not use them. + +([@astrandb] - [#113493]) ([documentation](/integrations/myuplink)) + +[@astrandb]: https://github.com/astrandb +[#113493]: https://github.com/home-assistant/core/pull/113493 + +{% enddetails %} + +{% details "Waze Travel Time" %} + +The options `excl_filter` and `incl_filter` now filter for exact matches to +street names in the route. Previously, they only filtered on the short +description of the route. + +([@eifinger] - [#108613]) ([documentation](/integrations/waze_travel_time)) + +[@eifinger]: https://github.com/eifinger +[#108613]: https://github.com/home-assistant/core/pull/108613 + +{% enddetails %} + +{% details "Weather" %} + +The previously deprecated `forecast` attribute of weather entities, has now been +removed. Use the [`weather.get_forecasts`](/integrations/weather#service-weatherget_forecasts) +service to get the forecast data instead. + +([@gjohansson-ST] - [#110761]) ([documentation](/integrations/metoffice)) + +[@gjohansson-ST]: https://github.com/gjohansson-ST +[#110761]: https://github.com/home-assistant/core/pull/110761 + +{% enddetails %} + +If you are a custom integration developer and want to learn about breaking +changes and new features available for your integration: Be sure to follow our +[developer blog][devblog]. The following are the most notable for this release: + +- [Climate entity auxiliary heater is deprecated](https://developers.home-assistant.io/blog/2024/03/10/climate-aux-heater-deprecated) +- [Config Entries can now provide a reconfigure step](https://developers.home-assistant.io/blog/2024/03/21/config-entry-reconfigure-step) +- [Deprecate hass.helpers usage](https://developers.home-assistant.io/blog/2024/03/30/deprecate-hass-helpers/) +- [Deprecating `async_run_job` and `async_add_job`](https://developers.home-assistant.io/blog/2024/03/13/deprecate_add_run_job) +- [How uv saves Home Assistant 215 compute hours per month](https://developers.home-assistant.io/blog/2024/04/03/build-images-with-uv/) +- [Integrations import in the executor to avoid blocking the event loop](https://developers.home-assistant.io/blog/2024/03/09/import_executor_default) +- [New state timestamp State.last_reported](https://developers.home-assistant.io/blog/2024/03/20/state_reported_timestamp) +- [Raising exceptions with translations](https://developers.home-assistant.io/blog/2024/03/15/exception-translations) + +[devblog]: https://developers.home-assistant.io/blog/ + +## Farewell to the following + +The following integrations are also no longer available as of this release: + +- **OpenCV** has been removed. The integration has been in a broken state + for over a year and currently has no path forward. + ([@thecode] - [#113455]) + +[@thecode]: https://github.com/thecode +[#113455]: https://github.com/home-assistant/core/pull/113455 + +## All changes + +Of course, there is a lot more in this release. You can find a list of +all changes made here: [Full changelog for Home Assistant Core 2024.4](/changelogs/core-2024.4) diff --git a/source/_posts/2024-04-24-state-of-the-open-home-2024.markdown b/source/_posts/2024-04-24-state-of-the-open-home-2024.markdown new file mode 100644 index 000000000000..7b2359930ee2 --- /dev/null +++ b/source/_posts/2024-04-24-state-of-the-open-home-2024.markdown @@ -0,0 +1,33 @@ +--- +layout: post +title: "Thinking Bigger: State of the Open Home 2024" +description: "The State of the Open Home 2024 stream includes a deep dive into the evolution of Home Assistant, and how it has now reached an estimated 1 million installations." +date: 2024-04-24 00:00:01 +date_formatted: "April 24, 2024" +author: Gordon Cameron +comments: true +categories: Announcements +og_image: /images/blog/2024-04-24-state-of-the-open-home-2024/banner.jpg +--- + +We recently held our [State of the Open Home 2024 live stream](https://www.youtube.com/live/oa__fLArsFk?si=PzlfiHLUYE6uAEq3), where we revealed how we are thinking [even bigger](/blog/2018/09/17/thinking-big/) about securing the future of the smart home. During this stream we launched the [Open Home Foundation](https://www.openhomefoundation.org/), a new non-profit organization created to fight for the fundamental principles of the smart home — privacy, choice, and sustainability — focused on serving everyone that lives in one. To learn more about the Open Home Foundation read the full [announcement](https://www.openhomefoundation.org/blog/announcing-the-open-home-foundation/). + +The stream includes a deep dive into the evolution of Home Assistant and how it has now reached an estimated 1 million installations. There were other substantial updates on voice and hardware, including teasing our upcoming Z-Wave and voice assistant hardware. The first panel discussion featured the founders of Open Home Foundation collaborating projects WLED, Zigbee2MQTT, Rhasspy, and Z-Wave JS. A second panel gave a comprehensive overview of the state of open standards, featuring key open-source developers working on Zigbee, Z-Wave, Matter, and Bluetooth. The stream caps off with a look into the future of the open home, including the announcement of a roadmap full of exciting new features. + +
@@ -62,15 +81,3 @@ Use the [built-in sentences](/voice_control/builtin_sentences) to control entiti
Did Assist not understand your sentence? [Contribute them](https://developers.home-assistant.io/docs/voice/intent-recognition/).
_Assist was introduced in Home Assistant 2023.2._
-
-## Related topics
-
-- [Home Assistant Cloud](https://www.nabucasa.com/config/)
-- [Assist on Android](/voice_control/android)
-- [Assist on Wear OS](/voice_control/android/#assist-on-wear-os)
-- [Siri and Assist shortcuts](/voice_control/apple)
-- [Assist dashboard button](/voice_control/start_assist_from_dashboard/)
-- [Build a 13$ voice remote using an ESPHome device](/voice_control/thirteen-usd-voice-remote/)
-- [Enable a wake word](/voice_control/install_wake_word_add_on)
-- [Create your own wake words](/voice_control/create_wake_word/)
-- [Built-in sentences](/voice_control/builtin_sentences)
diff --git a/source/voice_control/s3-box-customize.markdown b/source/voice_control/s3-box-customize.markdown
index a800d3c266db..d873af398cb2 100644
--- a/source/voice_control/s3-box-customize.markdown
+++ b/source/voice_control/s3-box-customize.markdown
@@ -2,6 +2,23 @@
title: "Customize the S3-BOX-3"
product_name: ESP32-S3-BOX-3
device_name_entry: ESP32-S3-BOX-3
+related:
+ - docs: /voice_control/voice_remote_cloud_assistant/
+ title: Home Assistant Cloud
+ - docs: /voice_control/voice_remote_local_assistant
+ title: Assist Pipeline
+ - docs: /voice_control/s3_box_voice_assistant/
+ title: ESP32-S3-BOX-3 voice assistant
+ - docs: /voice_control/troubleshooting/
+ title: General troubleshooting section for Assist
+ - docs: /voice_control/troubleshooting_the_s3_box/
+ title: Troubleshooting the ESP32-S3-BOX-3
+ - docs: /common-tasks/os/#configuring-access-to-files
+ title: Access to your configuration files
+ - url: https://github.com/jlpouffier/home-assistant-s3-box-community-illustrations/tree/main
+ title: Community image repository
+ - url: https://github.com/kahrendt/microWakeWord
+ title: microWakeWord
---
## Customize the S3-BOX-3 with your own illustrations
@@ -222,16 +239,5 @@ You can change the on-device wake word (microWakeWord) that is used on your S3-B
7. Now, speak a command to test the new setting. For example, *Hey Jarvis, turn on the light*.
-## Related topics
-
-- [Community image repository](https://github.com/jlpouffier/home-assistant-s3-box-community-illustrations/tree/main)
-- [Home Assistant Cloud](/voice_control/voice_remote_cloud_assistant/)
-- [Assist Pipeline](/voice_control/voice_remote_local_assistant)
-- [ESP32-S3-BOX-3 voice assistant](/voice_control/s3_box_voice_assistant/)
-- [General troubleshooting section for Assist](/voice_control/troubleshooting/)
-- [Troubleshooting the ESP32-S3-BOX-3](/voice_control/troubleshooting_the_s3_box/)
-- [Access to your configuration files](/common-tasks/os/#configuring-access-to-files)
-- [microWakeWord](https://github.com/kahrendt/microWakeWord)
-
[microWakeWord]: https://github.com/kahrendt/microWakeWord
[Kevin Ahrendt]: https://www.kevinahrendt.com/
\ No newline at end of file
diff --git a/source/voice_control/s3_box_voice_assistant.markdown b/source/voice_control/s3_box_voice_assistant.markdown
index 07865fb59307..9e76a272b29e 100644
--- a/source/voice_control/s3_box_voice_assistant.markdown
+++ b/source/voice_control/s3_box_voice_assistant.markdown
@@ -3,6 +3,17 @@ title: "ESP32-S3-BOX voice assistant"
product_name: ESP32-S3-BOX
device_name_entry: ESP32-S3-BOX
config_link: /voice_control/s3_box_voice_assistant/#to-delete-the-configuration-from-esphome
+related:
+ - docs: /voice_control/troubleshooting/
+ title: General troubleshooting section for Assist
+ - docs: /voice_control/troubleshooting_the_s3_box/
+ title: Troubleshooting the ESP32-S3-BOX-3
+ - docs: /common-tasks/os/#configuring-access-to-files
+ title: Access to your configuration files
+ - docs: /voice_control/s3-box-customize/#customizing-on-device-wake-words-microwakeword
+ title: Customizing the S3-BOX with on-device wake words
+ - url: https://esphome.io/projects/index.html
+ title: ESPHome projects page
---
This tutorial will guide you to turn an ESP32-S3-BOX, ESP32-S3-BOX-3, or an ESP32-S3-BOX-Light into a Home Assistant voice assistant. Note, the term ESP32-S3-BOX is used to refer to any of the 3 product variants.
@@ -84,11 +95,3 @@ Before you can use this device with Home Assistant, you need to install a bit of
- Disable **LCD Backlight**.
-
-## Related topics
-
-- [General troubleshooting section for Assist](/voice_control/troubleshooting/)
-- [Troubleshooting the ESP32-S3-BOX-3](/voice_control/troubleshooting_the_s3_box/)
-- [ESPHome projects page](https://esphome.io/projects/index.html)
-- [Access to your configuration files](/common-tasks/os/#configuring-access-to-files)
-- [Customizing the S3-BOX with on-device wake words](/voice_control/s3-box-customize/#customizing-on-device-wake-words-microwakeword)
diff --git a/source/voice_control/start_assist_from_dashboard.markdown b/source/voice_control/start_assist_from_dashboard.markdown
index ec79fbe26f2a..92db86f84426 100644
--- a/source/voice_control/start_assist_from_dashboard.markdown
+++ b/source/voice_control/start_assist_from_dashboard.markdown
@@ -1,5 +1,14 @@
---
title: "Starting Assist from your dashboard"
+related:
+ - docs: /voice_control/android/
+ title: Assist for Android
+ - docs: /voice_control/voice_remote_local_assistant/
+ title: Creating a local assistant
+ - docs: /voice_control/voice_remote_cloud_assistant/
+ title: Creating a Cloud assistant
+ - docs: /voice_control/voice_remote_expose_devices/
+ title: Exposing devices to Assist
---
If you are using Home Assistant in kiosk mode, for example if you have a tablet mounted on the wall, the Assist icon in the top right corner is not accessible. In this case, use a dashboard button to start Assist.
@@ -21,10 +30,3 @@ If you are using Home Assistant in kiosk mode, for example if you have a tablet
6. If you are using Assist with your voice, enable **Start listening**.
- If you don't want to use voice but just want to type, you do not need to enable listening.
7. **Save** your new button card.
-
-## Related topics
-
-- [Assist for Android](/voice_control/android/)
-- [Creating a local assistant](/voice_control/voice_remote_local_assistant/)
-- [Creating a Cloud assistant](/voice_control/voice_remote_cloud_assistant/)
-- [Exposing devices to Assist](/voice_control/voice_remote_expose_devices/)
diff --git a/source/voice_control/thirteen-usd-voice-remote.markdown b/source/voice_control/thirteen-usd-voice-remote.markdown
index 2d090c30a248..51dd02077192 100644
--- a/source/voice_control/thirteen-usd-voice-remote.markdown
+++ b/source/voice_control/thirteen-usd-voice-remote.markdown
@@ -3,6 +3,21 @@ title: "$13 voice assistant for Home Assistant"
product_name: ATOM Echo
device_name_entry: M5Stack Atom Echo a61920
config_link: /voice_control/thirteen-usd-voice-remote/#to-delete-the-atom-echo-configuration-from-esphome
+related:
+ - docs: /voice_control/install_wake_word_add_on/
+ title: Enable a wake word
+ - docs: /voice_control/create_wake_word/
+ title: Create your own wake words
+ - docs: /voice_control/voice_remote_cloud_assistant/
+ title: Creating a Cloud assistant
+ - docs: /voice_control/troubleshooting/
+ title: General troubleshooting section for Assist
+ - docs: /voice_control/voice_remote_local_assistant
+ title: Manually configured Assist pipeline
+ - docs: /voice_control/custom_sentences/
+ title: Using a sentence trigger
+ - docs: /common-tasks/os/#configuring-access-to-files
+ title: Access to your configuration files
---
This tutorial will guide you to turn an ATOM Echo into the
@@ -76,13 +91,3 @@ Before you can use this device with Home Assistant, you need to install a bit of
Are things not working as expected?
- Checkout the [general troubleshooting section for Assist](/voice_control/troubleshooting/).
-
-## Related topics
-
-- [Enable a wake word](/voice_control/install_wake_word_add_on/)
-- [Create your own wake words](/voice_control/create_wake_word/)
-- [General troubleshooting section for Assist](/voice_control/troubleshooting/)
-- [Access to your configuration files](/common-tasks/os/#configuring-access-to-files)
-- [Using a sentence trigger](/voice_control/custom_sentences/)
-- [Home Assistant Cloud](/voice_control/voice_remote_cloud_assistant/)
-- [Manually configured Assist pipeline](/voice_control/voice_remote_local_assistant)
diff --git a/source/voice_control/troubleshooting_the_s3_box.markdown b/source/voice_control/troubleshooting_the_s3_box.markdown
index 2c3b59e061f5..470be2efe391 100644
--- a/source/voice_control/troubleshooting_the_s3_box.markdown
+++ b/source/voice_control/troubleshooting_the_s3_box.markdown
@@ -1,5 +1,10 @@
---
title: "Troubleshooting the ESP32-S3-BOX-3"
+related:
+ - docs: /voice_control/s3_box_voice_assistant/
+ title: Creating a ESP32-S3-BOX-3 voice assistant
+ - url: https://esphome.io/projects/index.html
+ title: ESPHome projects website
---
This section provides troubleshooting steps for the ESP32-S3-BOX-3 by Espressif.
@@ -77,8 +82,3 @@ This message indicates that the device could connect to the Wi-Fi, but is unable
- Go to your router, find the IP address or hostname of your device, and enter it.
-
-## Related topics
-
-- [Creating a ESP32-S3-BOX-3 voice assistant](/voice_control/s3_box_voice_assistant/)
-- [ESPHome projects website](https://esphome.io/projects/index.html)
\ No newline at end of file
diff --git a/source/voice_control/voice_remote_cloud_assistant.markdown b/source/voice_control/voice_remote_cloud_assistant.markdown
index 8b3691e29cf1..0a5f4b76bf9e 100644
--- a/source/voice_control/voice_remote_cloud_assistant.markdown
+++ b/source/voice_control/voice_remote_cloud_assistant.markdown
@@ -1,5 +1,14 @@
---
title: "Creating a cloud Assist pipeline"
+related:
+ - docs: /voice_control/install_wake_word_add_on/
+ title: Enabling a wake word
+ - docs: /voice_control/create_wake_word/
+ title: Create your own wake word
+ - docs: /voice_control/voice_remote_cloud_assistant/
+ title: Creating a Cloud assistant
+ - docs: /voice_control/voice_remote_expose_devices/
+ title: Exposing devices to Assist
---
In Home Assistant, the Assist pipelines are made up of various components that together form a voice assistant.
@@ -42,10 +51,3 @@ To have the fastest processing voice assistant experience, follow these steps:
6. That's it. You can now speak to your device, and the device can answer in the language you defined.
7. If you haven't done so yet, [expose your devices to Assist](/voice_control/voice_remote_expose_devices/#exposing-your-devices).
- Otherwise you won't be able to control them by voice.
-
-## Related topics
-
-- [Enable Home Assistant Cloud](https://www.nabucasa.com/config/)
-- [Enabling a wake word](/voice_control/install_wake_word_add_on/)
-- [Create your own wake word](/voice_control/create_wake_word/)
-- [Expose your devices to Assist](/voice_control/voice_remote_expose_devices/#exposing-your-devices)
diff --git a/source/voice_control/voice_remote_expose_devices.markdown b/source/voice_control/voice_remote_expose_devices.markdown
index 41c7db07351e..30b9b3b38ffc 100644
--- a/source/voice_control/voice_remote_expose_devices.markdown
+++ b/source/voice_control/voice_remote_expose_devices.markdown
@@ -1,5 +1,10 @@
---
title: "Exposing devices"
+related:
+ - docs: /voice_control/voice_remote_cloud_assistant/
+ title: Creating a Cloud assistant
+ - docs: /voice_control/voice_remote_local_assistant/
+ title: Creating a local assistant
---
To be able to control your devices over a voice command, you must expose your entities to Assist.
@@ -13,9 +18,3 @@ This is to avoid that sensitive devices, such as locks and garage doors, can ina
3. Select **Expose entities**.
1. Select all entities you want to be able to control by voice.
-
-
-## Related topics
-
-- [Local assistant pipeline](/voice_control/voice_remote_local_assistant/)
-- [Cloud assistant pipeline](/voice_control/voice_remote_cloud_assistant/)
\ No newline at end of file
diff --git a/source/voice_control/voice_remote_local_assistant.markdown b/source/voice_control/voice_remote_local_assistant.markdown
index caadd0f74a42..8112568c8b26 100644
--- a/source/voice_control/voice_remote_local_assistant.markdown
+++ b/source/voice_control/voice_remote_local_assistant.markdown
@@ -1,5 +1,14 @@
---
title: "Installing a local Assist pipeline"
+related:
+ - docs: /voice_control/voice_remote_expose_devices/#exposing-your-devices
+ title: Expose your devices to Assist
+ - docs: /voice_control/create_wake_word/
+ title: Create your own wake words
+ - url: https://github.com/openai/whisper
+ title: Whisper for speech-to-text
+ - url: https://github.com/rhasspy/piper
+ title: Piper for text-to-speech
---
In Home Assistant, the Assist pipelines are made up of various components that together form a voice assistant.
@@ -69,9 +78,3 @@ View some of the options in the video below. Explained by Mike Hansen, creator o
The options are also documented in the add-on itself. Go to the {% my supervisor_addon addon="core_whisper" title="**Whisper**" %} or the {% my supervisor_addon addon="core_piper" title="**Piper**" %} add-on and open the **Documentation** page.
-## Related topics
-
-- [Create your own wake word](/voice_control/create_wake_word/)
-- [Expose your devices to Assist](/voice_control/voice_remote_expose_devices/#exposing-your-devices)
-- [Whisper for speech-to-text](https://github.com/openai/whisper)
-- [Piper for text-to-speech](https://github.com/rhasspy/piper)
diff --git a/source/voice_control/worlds-most-private-voice-assistant.markdown b/source/voice_control/worlds-most-private-voice-assistant.markdown
index ac77ccc0b669..a98b79de126f 100644
--- a/source/voice_control/worlds-most-private-voice-assistant.markdown
+++ b/source/voice_control/worlds-most-private-voice-assistant.markdown
@@ -1,5 +1,14 @@
---
title: "World's most private voice assistant"
+related:
+ - docs: /voice_control/voice_remote_cloud_assistant/
+ title: Creating a Cloud assistant
+ - docs: /voice_control/voice_remote_local_assistant/
+ title: Creating a local assistant
+ - url: https://amzn.to/40k7mRa
+ title: Grandstream HT801
+ - url: https://www.nabucasa.com
+ title: Home Assistant Cloud
---
This tutorial will guide you to turn your old landline phone into the
@@ -125,10 +134,3 @@ The phone shown in the video by TheFes is a *Heemaf type 1955*, which was used b
The phone used during creation of this tutorial is a 1953 [*Tischstation Mod.29 HF-TR* by Autophon AG](https://www.radiomuseum.org/r/autophon_tischstation_mod29_hf_tr.html).
-
-## Related topics
-
-- [Grandstream HT801](https://amzn.to/40k7mRa)
-- [Home Assistant Cloud](https://www.nabucasa.com)
-- [Cloud assistant pipeline](/voice_control/voice_remote_cloud_assistant/)
-- [Local assistant pipeline](/voice_control/voice_remote_local_assistant/)
\ No newline at end of file
-Depending on your setup, you might need to set an external URL (`external_url`) inside the [configuration](/docs/configuration/basic/).
+Depending on your setup, you might need to set an external URL (`external_url`) inside the [configuration](/integrations/homeassistant/#external_url).
@@ -143,11 +154,3 @@ The Google cast devices (Google Home, Chromecast, etc.) present the following pr
- They do not work with URLs that contain hostnames established by local naming means. Let's say your Home Assistant instance is running on a machine made known locally as `ha`. All your machines on your local network are able to access it as `ha`. However, try as you may, your cast device won't download the media files from your `ha` machine. That's because your cast device ignores your local naming setup. In this example, the `say` service creates a URL like `http://ha/path/to/media.mp3` (or `https://...` if you are using SSL). If you are _not_ using SSL then setting an internal URL that contains the IP address of your server works around this issue. By using an IP address, the cast device does not have to resolve the hostname.
- If you are using SSL (e.g., `https://yourhost.example.org/...`) then you _must_ use the hostname in the certificate (e.g., `external_url: https://yourhost.example.org`). You cannot use an IP address since the certificate won't be valid for the IP address, and the cast device will refuse the connection.
-
-### Related topics
-
-- [List of integrations using the TTS integration](https://www.home-assistant.io/integrations/#text-to-speech)
-- [TTS with Home Assistant Cloud](https://www.nabucasa.com/config/tts/)
-- [Google Translate TTS](https://www.home-assistant.io/integrations/google_translate/)
-- [Microsoft TTS](https://www.home-assistant.io/integrations/microsoft/)
-- [Home Assistant Assist](https://www.home-assistant.io/voice_control/)
diff --git a/source/_integrations/twilio.markdown b/source/_integrations/twilio.markdown
index 9a9f7e706ad5..22e8cdf8afef 100644
--- a/source/_integrations/twilio.markdown
+++ b/source/_integrations/twilio.markdown
@@ -41,7 +41,7 @@ auth_token:
After configuring the base Twilio integration, add and configure either or both of the [Twilio SMS](/integrations/twilio_sms) and [Twilio Phone](/integrations/twilio_call) integrations to utilize the notification functionality.
-To be able to receive events from Twilio, your Home Assistant instance needs to be accessible from the web and you need to have the external URL [configured](/docs/configuration/basic) in Home Assistant.
+To be able to receive events from Twilio, your Home Assistant instance needs to be accessible from the web and you need to have the external URL [configured](/integrations/homeassistant/#external_url) in Home Assistant.
To set it up, go to the integrations page in the configuration screen and find Twilio. Click on configure. Follow the instructions on the screen to configure Twilio.
diff --git a/source/_integrations/twitch.markdown b/source/_integrations/twitch.markdown
index 2e07e18c2f48..f6dcd84459ba 100644
--- a/source/_integrations/twitch.markdown
+++ b/source/_integrations/twitch.markdown
@@ -18,6 +18,10 @@ The Twitch integration will allow you to monitor [Twitch](https://www.twitch.tv/
## Get Twitch application credentials
-Create a new app at **Register Your Application** in the [Twitch developer portal](https://dev.twitch.tv/console/apps). Enter `https://my.home-assistant.io/redirect/oauth` in the **OAuth Redirect URL** field. Then, get the **Client ID** and **Client secret** from the new application.
+Create a new app at **Register Your Application** in the [Twitch developer portal](https://dev.twitch.tv/console/apps):
+
+- Enter a **Name** for your app. Note that it needs to be unique all over Twitch.
+- Enter `https://my.home-assistant.io/redirect/oauth` in the **OAuth Redirect URL** field.
+- Get the **Client ID** and **Client secret** from the new application, you need them to complete the integration setup in Home Assistant.
{% include integrations/config_flow.md %}
diff --git a/source/_integrations/unifi.markdown b/source/_integrations/unifi.markdown
index 64bbe58f4a79..e19dcac1b961 100644
--- a/source/_integrations/unifi.markdown
+++ b/source/_integrations/unifi.markdown
@@ -34,6 +34,7 @@ There is currently support for the following device types within Home Assistant:
- [Button](#button)
- [Image](#image)
- [Presence detection](#presence-detection)
+- [Services](#services)
- [Switch](#switch)
- [Sensor](#sensor)
- [Firmware updates](#firmware-updates)
diff --git a/source/_integrations/unifiprotect.markdown b/source/_integrations/unifiprotect.markdown
index 664685f6c99b..93dfad061be0 100644
--- a/source/_integrations/unifiprotect.markdown
+++ b/source/_integrations/unifiprotect.markdown
@@ -262,6 +262,15 @@ Use to set the paired doorbell(s) with a smart chime.
| `device_id` | No | The device ID of the Chime you want to pair or unpair doorbells to. |
| `doorbells` | Yes | A target selector for any number of doorbells you want to pair to the chime. No value means unpair all. |
+### Service unifiprotect.remove_privacy_zone
+
+Use to remove a privacy zone from a camera.
+
+| Service data attribute | Optional | Description |
+| ---------------------- | -------- | ------------------------------------------------------------------------------------------------------- |
+| `device_id` | No | Camera you want to remove privacy zone from. |
+| `name` | No | The name of the zone to remove. |
+
## Views
The {% term integrations %} provides two proxy views to proxy media content from your Home Assistant instance so you can access thumbnails and video clips from within the context of Home Assistant without having to expose your UniFi Protect NVR Console. As with the media identifiers, all IDs are UniFi Protect IDs as they may not map to specific Home Assistant entities depending on how you have configured your {% term integrations %}.
diff --git a/source/_integrations/universal.markdown b/source/_integrations/universal.markdown
index 5838f0199e36..b2fb1e6959d1 100644
--- a/source/_integrations/universal.markdown
+++ b/source/_integrations/universal.markdown
@@ -327,6 +327,61 @@ media_player:
{% endraw %}
+### Denon AVR & HEOS
+
+This media player combines the media players provided by the [Denon AVR](/integrations/denonavr/) and [HEOS](/integrations/heos/) integrations.
+
+Features:
+- Volume control via Denon entity (might be more fine-granular than HEOS volume control)
+- ON/OFF button via Denon entity (not provided by HEOS media player)
+- Sound mode selector via Denon entity (not provided by HEOS media player)
+- Album art & Metadata via HEOS entity (not provided by Denon media player)
+
+The complete configuration is:
+
+{% raw %}
+
+```yaml
+media_player:
+ - platform: universal
+ name: Denon
+ unique_id: denon_universal_remote
+ device_class: receiver
+ children:
+ - media_player.denon_avr_x2700h # Denon AVR Integration entity
+ - media_player.denon_avr_x2700h_heos # Denon HEOS Integration entity
+ browse_media_entity: media_player.denon_avr_x2700h_heos
+ commands:
+ turn_off:
+ service: media_player.turn_off
+ data:
+ entity_id: media_player.denon_avr_x2700h
+ turn_on:
+ service: media_player.turn_on
+ data:
+ entity_id: media_player.denon_avr_x2700h
+ volume_up:
+ service: media_player.volume_up
+ data:
+ entity_id: media_player.denon_avr_x2700h
+ volume_down:
+ service: media_player.volume_down
+ data:
+ entity_id: media_player.denon_avr_x2700h
+ select_sound_mode:
+ service: media_player.select_sound_mode
+ target:
+ entity_id: media_player.denon_avr_x2700h
+ data:
+ sound_mode: "{{ sound_mode }}"
+ attributes:
+ sound_mode: media_player.denon_avr_x2700h|sound_mode
+ sound_mode_raw: media_player.denon_avr_x2700h|sound_mode_raw
+ sound_mode_list: media_player.denon_avr_x2700h|sound_mode_list
+```
+
+{% endraw %}
+
### Override active children
This example shows how you can use `active_child_template`:
diff --git a/source/_integrations/vallox.markdown b/source/_integrations/vallox.markdown
index 9f6ca5306bf3..66479c717028 100644
--- a/source/_integrations/vallox.markdown
+++ b/source/_integrations/vallox.markdown
@@ -11,6 +11,7 @@ ha_iot_class: Local Polling
ha_domain: vallox
ha_platforms:
- binary_sensor
+ - date
- fan
- number
- sensor
diff --git a/source/_integrations/velux.markdown b/source/_integrations/velux.markdown
index 227140ccba9b..430906870ca8 100644
--- a/source/_integrations/velux.markdown
+++ b/source/_integrations/velux.markdown
@@ -30,6 +30,13 @@ There is currently support for the following device types within Home Assistant:
{% include integrations/config_flow.md %}
+During configuration, you will be asked for a hostname and password:
+
+- Hostname: enter the IP address of the KLF 200 gateway.
+- Password: enter the password of the gateway's wireless access point (printed on the underside - **not** the web login password).
+
+You must complete the configuration within 5 minutes of rebooting the KLF 200 gateway while the access point is still available.
+
## Services
### Service `velux.reboot_gateway`
diff --git a/source/_integrations/vivotek.markdown b/source/_integrations/vivotek.markdown
index f1eb47af9be4..1fade9eb67fc 100644
--- a/source/_integrations/vivotek.markdown
+++ b/source/_integrations/vivotek.markdown
@@ -108,11 +108,11 @@ Available services: `enable_motion_detection`, `disable_motion_detection`, `snap
Play a live stream from a camera to selected media player(s). Requires [`stream`](/integrations/stream) {% term integration %} to be set up.
-| Service data attribute | Optional | Description |
-| ---------------------- | -------- | ----------- |
-| `entity_id` | no | Name of {% term entity %} to fetch stream from, e.g., `camera.front_door_camera`. |
-| `media_player` | no | Name of media player to play stream on, e.g., `media_player.living_room_tv`. |
-| `format` | yes | Stream format supported by `stream` {% term integration %} and selected `media_player`. Default: `hls` |
+| Service data attribute | Optional | Description |
+| ---------------------- | -------- | ------------------------------------------------------------------------------------------------------ |
+| `entity_id` | no | Name of {% term entity %} to fetch stream from, e.g., `camera.front_door_camera`. |
+| `media_player` | no | Name of media player to play stream on, e.g., `media_player.living_room_tv`. |
+| `format` | yes | Stream format supported by `stream` {% term integration %} and selected `media_player`. Default: `hls` |
For example, the following action in an automation would send an `hls` live stream to your chromecast.
@@ -129,28 +129,28 @@ action:
Enable motion detection in a camera. Currently, this will enable the first event configured on the camera.
-| Service data attribute | Optional | Description |
-| ---------------------- | -------- | ----------- |
-| `entity_id` | yes | Name(s) of entities to enable motion detection, e.g., `camera.front_door_camera`. |
+| Service data attribute | Optional | Description |
+| ---------------------- | -------- | --------------------------------------------------------------------------------- |
+| `entity_id` | yes | Name(s) of entities to enable motion detection, e.g., `camera.front_door_camera`. |
#### Service `disable_motion_detection`
Disable the motion detection in a camera. Currently, this will disable the first event configured on the camera.
-| Service data attribute | Optional | Description |
-| ---------------------- | -------- | ----------- |
-| `entity_id` | yes | Name(s) of entities to disable motion detection, e.g., `camera.front_door_camera`. |
+| Service data attribute | Optional | Description |
+| ---------------------- | -------- | ---------------------------------------------------------------------------------- |
+| `entity_id` | yes | Name(s) of entities to disable motion detection, e.g., `camera.front_door_camera`. |
#### Service `snapshot`
Take a snapshot from a camera.
-| Service data attribute | Optional | Description |
-| ---------------------- | -------- | ----------- |
-| `entity_id` | no | Name(s) of entities to create a snapshot from, e.g., `camera.front_door_camera`. |
-| `filename` | no | Template of a file name. Variable is `entity_id`, e.g., {% raw %}`/tmp/snapshot_{{ entity_id }}`{% endraw %}. |
+| Service data attribute | Optional | Description |
+| ---------------------- | -------- | ------------------------------------------------------------------------------------------------------------- |
+| `entity_id` | no | Name(s) of entities to create a snapshot from, e.g., `camera.front_door_camera`. |
+| `filename` | no | Template of a file name. Variable is `entity_id`, e.g., {% raw %}`/tmp/snapshot_{{ entity_id }}`{% endraw %}. |
-The path part of `filename` must be an entry in the `allowlist_external_dirs` in your [`homeassistant:`](/docs/configuration/basic/) section of your `configuration.yaml` file.
+The path part of `filename` must be an entry in the `allowlist_external_dirs` in your [`homeassistant:`](/integrations/homeassistant/#allowlist_external_dirs) section of your `configuration.yaml` file.
For example, the following action is an automation that would take a snapshot from "front_door_camera" and save it to /tmp with a timestamped filename.
diff --git a/source/_integrations/weather.template.markdown b/source/_integrations/weather.template.markdown
index 3787862b5f1c..b5c8c7cb6551 100644
--- a/source/_integrations/weather.template.markdown
+++ b/source/_integrations/weather.template.markdown
@@ -34,7 +34,7 @@ weather:
temperature_template: "{{ states('sensor.temperature') | float }}"
temperature_unit: "°C"
humidity_template: "{{ states('sensor.humidity') | float }}"
- forecast_daily_template: "{{ state_attr('weather.my_region', 'forecast') }}"
+ forecast_daily_template: "{{ state_attr('weather.my_region', 'forecast_data') }}"
```
{% endraw %}
@@ -116,10 +116,6 @@ visibility_unit:
description: Unit for visibility_template output. Valid options are km, mi, ft, m, cm, mm, in, yd.
required: false
type: string
-forecast_template:
- description: Forecast data.
- required: false
- type: template
forecast_daily_template:
description: Daily forecast data.
required: false
diff --git a/source/_integrations/webmin.markdown b/source/_integrations/webmin.markdown
index f37204eca78b..24ac6e982dc1 100644
--- a/source/_integrations/webmin.markdown
+++ b/source/_integrations/webmin.markdown
@@ -11,6 +11,7 @@ ha_codeowners:
ha_domain: webmin
ha_integration_type: device
ha_platforms:
+ - diagnostics
- sensor
---
diff --git a/source/_integrations/whirlpool.markdown b/source/_integrations/whirlpool.markdown
index 5629b5f13f77..7ef99e50b5dd 100644
--- a/source/_integrations/whirlpool.markdown
+++ b/source/_integrations/whirlpool.markdown
@@ -13,6 +13,7 @@ ha_codeowners:
ha_domain: whirlpool
ha_platforms:
- climate
+ - diagnostics
- sensor
ha_integration_type: hub
---
@@ -27,7 +28,7 @@ There is currently support for the following device types within Home Assistant:
## Supported hardware
-The following air conditioners are confirmed to be working, but other models that use the 6th Sense Live application may also work:
+The following appliances are confirmed to be working, but other models that use the 6th Sense Live application may also work:
Climate:
@@ -37,6 +38,7 @@ Climate:
Washer:
- WTW6120HW2
+- MHW8630HW0
Dryer:
diff --git a/source/_integrations/whisper.markdown b/source/_integrations/whisper.markdown
index 9298b2de6db4..d60b91aa302e 100644
--- a/source/_integrations/whisper.markdown
+++ b/source/_integrations/whisper.markdown
@@ -19,6 +19,7 @@ ha_platforms:
- stt
- switch
- tts
+ - wake_word
ha_iot_class: Local Push
ha_zeroconf: true
---
diff --git a/source/_integrations/withings.markdown b/source/_integrations/withings.markdown
index 9fbc0ee4abe6..2bbf743b617b 100644
--- a/source/_integrations/withings.markdown
+++ b/source/_integrations/withings.markdown
@@ -57,6 +57,8 @@ Withings will validate (with HTTP HEAD) these requirements each time you save yo
{% enddetails %}
+Note: You will only need one developer account; the same account and credentials are used for each Withings configuration.
+
{% include integrations/config_flow.md %}
## Data updates
diff --git a/source/_integrations/xiaomi_ble.markdown b/source/_integrations/xiaomi_ble.markdown
index d65c92aa52fc..43a3c6fe7b85 100644
--- a/source/_integrations/xiaomi_ble.markdown
+++ b/source/_integrations/xiaomi_ble.markdown
@@ -20,16 +20,12 @@ ha_platforms:
ha_integration_type: integration
---
-Integrates devices that implement the Xiaomi Mijia BLE MiBeacon protocol and the BLE protocols implemented in the MiScales and the MiFora plant sensor. The integration listens to Bluetooth broadcasts that the device makes by itself, allowing it to track the latest sensor values or events without waking the device up for polling. This method conserves battery lifetime.
+Integrates devices that use the Xiaomi Mijia BLE MiBeacon protocol and the BLE protocols implemented in the MiScales and the MiFora plant sensor. This integration does not support Xiaomi BLE Mesh devices. The integration listens to Bluetooth broadcasts that the device makes by itself, allowing it to track the latest sensor values or events without waking the device up for polling (except HHCCJCY01, see note below). This method conserves battery lifetime.
The integration automatically discovers devices once the [Bluetooth](/integrations/bluetooth) integration is enabled and functional. The entities are added after the values are first received. This means that entities might show up later if the corresponding values are broadcasted at a lower interval (for example, battery).
{% include integrations/config_flow.md %}
-## Supported devices
-
-From the devices that support the Xiaomi Mijia BLE MiBeacon protocol, currently locks are not implemented yet. This integration also does not support Xiaomi BLE Mesh devices.
-
## Encryption
Some devices use AES encryption to protect the sensor values they are broadcasting.
@@ -63,3 +59,5 @@ Flower Care firmware update steps:
- Wait for the synchronization of the sensor to finish, and a dialog asking for a firmware update should appear (this might take a few minutes)
- The installed and latest firmware version can be verified by selecting the plant -> three-dot menu -> Hardware settings -> Hardware update
- The Flower Care account and app are not required any further for this integration to work
+
+Also note that the battery level of the plant sensor can only be retrieved by connecting to the device (reading characteristics), while the other sensor data is broadcasted passively. To prevent battery drainage, a connection is made only once a day. Connecting to the device also requires that the device has a good signal strength.
diff --git a/source/_integrations/yolink.markdown b/source/_integrations/yolink.markdown
index 5640db460ed0..e84ad1c4a671 100644
--- a/source/_integrations/yolink.markdown
+++ b/source/_integrations/yolink.markdown
@@ -27,6 +27,7 @@ ha_platforms:
- sensor
- siren
- switch
+ - valve
ha_integration_type: integration
---
@@ -78,6 +79,7 @@ The integration is tested and verified for the following devices from YoLink:
- YS6704-UC (In-wall Outlet)
- YS6801-UC (Smart Power Strip)
- YS6802-UC (Smart Outdoor Power Strip)
+- YS6803-UC (Outdoor Energy Plug)
- YS7103-UC (Siren Alarm)
- YS7104-UC (Outdoor Alarm Controller)
- YS7105-UC (X3 Outdoor Alarm Controller)
@@ -95,6 +97,7 @@ The integration is tested and verified for the following devices from YoLink:
- YS7904-UC (Water Leak Sensor 2)
- YS7906-UC (Water Leak Sensor 4)
- YS7916-UC (Water Leak Sensor 4 MoveAlert)
+- YS7905-UC (WaterDepthSensor)
- YS7A01-UC (Smart Smoke/CO Alarm)
- YS8003-UC (Temperature Humidity Sensor)
- YS8004-UC (Weatherproof Temperature Sensor)
@@ -102,3 +105,6 @@ The integration is tested and verified for the following devices from YoLink:
- YS8006-UC (X3 Temperature & Humidity Sensor)
- YS8014-UC (X3 Outdoor Temperature Sensor)
- YS8015-UC (X3 Outdoor Temperature & Humidity Sensor)
+- YS5006-UC (FlowSmart Control)
+- YS5007-UC (FlowSmart Meter)
+- YS5008-UC (FlowSmart All-in-One)
diff --git a/source/_integrations/zha.markdown b/source/_integrations/zha.markdown
index 29eb3f8e7b2d..d12151c816d7 100644
--- a/source/_integrations/zha.markdown
+++ b/source/_integrations/zha.markdown
@@ -106,6 +106,7 @@ Some other Zigbee coordinator hardware may not support a firmware that is capabl
- [CC2652P/CC2652R/CC2652RB USB stick, module, or dev board hardware flashed with Z-Stack coordinator firmware](https://www.zigbee2mqtt.io/guide/adapters/)
- [CC1352P/CC1352R USB stick, module, or dev board hardware flashed with Z-Stack coordinator firmware](https://www.zigbee2mqtt.io/guide/adapters/)
- dresden elektronik deCONZ based Zigbee radios (via the [zigpy-deconz](https://github.com/zigpy/zigpy-deconz) library for zigpy)
+ - [ConBee III (a.k.a. ConBee 3) USB adapter from dresden elektronik](https://phoscon.de/conbee3)
- [ConBee II (a.k.a. ConBee 2) USB adapter from dresden elektronik](https://phoscon.de/conbee2)
- [RaspBee II (a.k.a. RaspBee 2) Raspberry Pi Shield from dresden elektronik](https://phoscon.de/raspbee2)
diff --git a/source/_integrations/zwave_js.markdown b/source/_integrations/zwave_js.markdown
index 9e8e9e6f046c..307c8723d895 100644
--- a/source/_integrations/zwave_js.markdown
+++ b/source/_integrations/zwave_js.markdown
@@ -59,7 +59,7 @@ To run a Z-Wave network, you need the following elements:
### Setting up a Z-Wave JS server
-If you are running Home Assistant Operating System or Home Assistant Supervised, the easiest way to get started is by using the built-in Z-Wave JS add-on in Home Assistant.
+If you are running {% term "Home Assistant Operating System" %} or {% term "Home Assistant Supervised" %}, the easiest way to get started is by using the built-in Z-Wave JS add-on in Home Assistant.
For other ways to setup a Z-Wave server, refer to the [advanced installation instructions](#advanced-installation-instructions).
@@ -726,13 +726,13 @@ The chart below illustrates Options 1 and 2, which are available for Home Assist
**Option 1: The official Z-Wave JS add-on, as described above**
-_This option is only available for Home Assistant OS (the recommended installation type) and Home Assistant Supervised installations._
+_This option is only available for {% term "Home Assistant Operating System" %} (the recommended installation type) and {% term "Home Assistant Supervised" %} installations._
This add-on can only be configured via the built-in Z-Wave control panel in Home Assistant. If you followed the standard [installation procedure](#setting-up-a-z-wave-js-server), this is how you are running the Z-Wave JS server.
**Option 2: The Z-Wave JS UI add-on installed from the community add-on store**
-_This option is only available for Home Assistant OS (the recommended installation type) and Home Assistant Supervised installations._
+_This option is only available for {% term "Home Assistant Operating System" %} (the recommended installation type) and {% term "Home Assistant Supervised" %} installations._
This add-on includes the Z-Wave JS Server as part of the Z-Wave JS UI application. The Z-Wave network can be configured via the built-in Z-Wave control panel in Home Assistant and alternatively via the Z-Wave control panel built into Z-Wave JS UI. It provides you with a full-fledged, attractive, and feature-complete UI to manage your Z-Wave nodes and settings, which may support more advanced use cases as development continues on the Z-Wave control panel.
diff --git a/source/_layouts/page.html b/source/_layouts/page.html
index 7d320b83a069..fb1122d4cff6 100644
--- a/source/_layouts/page.html
+++ b/source/_layouts/page.html
@@ -35,5 +35,6 @@
{% endif %}
{{ content }}
+ {% include related.html %}
{% include feedback.html %}
diff --git a/source/_posts/2024-04-03-release-20244.markdown b/source/_posts/2024-04-03-release-20244.markdown
new file mode 100644
index 000000000000..64d6213de5b8
--- /dev/null
+++ b/source/_posts/2024-04-03-release-20244.markdown
@@ -0,0 +1,1052 @@
+---
+layout: post
+title: "2024.4: Organize all the things!"
+description: "Time for spring cleaning 🧹 Introducing new ways to organize your automations (and more) with floors, labels, and categories. Easily add Matter devices from other controllers, and two brand new map and webpage dashboards."
+date: 2024-04-03 00:00:00
+date_formatted: "April 3, 2024"
+author: Franck Nijhof
+author_twitter: frenck
+comments: true
+categories:
+ - Release-Notes
+ - Core
+og_image: /images/blog/2024-04/social.png
+---
+
+
+
+Home Assistant Core 2024.4! 🌱 🌻
+
+Are you ready for another massive release? This release addresses the most
+requested feature in Home Assistant history: grouping automations! 🎉
+
+But why stop there?
+
+This release brings excellent new features to our user interface that house not
+one, not two, but three! new ways to organize your Home Assistant setup!
+The best part is that it is not just for automations, but for everything! 🤯
+
+Perfect timing: spring is here! Time to spring clean your Home Assistant
+setup by adding some organization to your configuration! 🧹
+
+Enjoy the release! 🌞
+
+../Frenck
+
+
+
+- [Home Assistant spring cleaning! 🧹 New ways to get your automations (and more) organized](#home-assistant-spring-cleaning--new-ways-to-get-your-automations-and-more-organized)
+- [Upgraded tables!](#upgraded-tables)
+ - [A new toolbar](#a-new-toolbar)
+ - [Filter panel](#filter-panel)
+ - [Item grouping](#item-grouping)
+ - [Selection mode and batch actions](#selection-mode-and-batch-actions)
+- [Three new ways to organize](#three-new-ways-to-organize)
+ - [Floors: Help Home Assistant understand your house](#floors-help-home-assistant-understand-your-house)
+ - [Labels: Tag everything any way you want](#labels-tag-everything-any-way-you-want)
+ - [Categories: Make each settings page easier to browse](#categories-make-each-settings-page-easier-to-browse)
+ - [Time to clean up your Home Assistant!](#time-to-clean-up-your-home-assistant)
+- [Map dashboard](#map-dashboard)
+- [Webpage dashboard](#webpage-dashboard)
+- [Define the columns in the section view](#define-the-columns-in-the-section-view)
+- [Adding Matter devices from other controllers](#adding-matter-devices-from-other-controllers)
+- [Lock behavior improvements](#lock-behavior-improvements)
+- [Even more performance!](#even-more-performance)
+- [Other noteworthy changes](#other-noteworthy-changes)
+- [New integrations](#new-integrations)
+- [Integrations now available to set up from the UI](#integrations-now-available-to-set-up-from-the-ui)
+- [Release 2024.4.1 - April 5](#release-202441---april-5)
+- [Release 2024.4.2 - April 8](#release-202442---april-8)
+- [Release 2024.4.3 - April 12](#release-202443---april-12)
+- [Release 2024.4.4 - April 23](#release-202444---april-23)
+- [Need help? Join the community!](#need-help-join-the-community)
+- [Backward-incompatible changes](#backward-incompatible-changes)
+- [Farewell to the following](#farewell-to-the-following)
+- [All changes](#all-changes)
+
+Don't forget to [join our release party live stream on YouTube](https://www.youtube.com/watch?v=Q1yHfqsVidw)
+3 April 2024, at 20:00 GMT / 12:00 PST / 21:00 CEST!
+
+
+ 
+ The new toolbar that is now on every table in Home Assistant.
+
+
+We also introduced multiple new filter types for each table. For example,
+{% term automations %} can now be filtered not only by {% term areas %},
+{% term entities %} , or {% term devices %}, but also by used
+{% term blueprints %}, labels, and categories (more on these later!).
+
+We didn’t stop at just that page! The devices and entities pages now also have
+a way to filter not only by state but also by integrations and areas. Almost all
+tables now have useful new filters to help you find what you are looking for.
+
+### Item grouping
+
+Browsing a list of hundreds of {% term automations %} or thousands of
+{% term entities %} can be overwhelming. While filters can help narrow the list,
+visually grouping the items into smaller chunks makes browsing easier.
+
+With the item grouping feature, we introduced a new dropdown menu to pick
+how you’d like the items on the table to be grouped. On the automations page,
+you can group automations by their {% term state %} - whether enabled
+or not - and custom categories (more on that later!). On the {% term devices %}
+page, you can even group them by manufacturers, {% term areas %},
+or {% term integrations %}, which is really cool because it makes the page much
+easier to browse. It gives you a new perspective on organizing your vast
+network of devices.
+
+
+
+### Selection mode and batch actions
+
+We removed the clutter of displaying a column of checkboxes by introducing
+a new selection mode. When it is toggled on, checkboxes will appear, and you
+can apply actions to all your selections with one click on the toolbar.
+
+
+ 
+ This button enables selection mode in the new tables.
+
+
+## Three new ways to organize
+
+Upon reading through and ideating on the feature request thread on
+[“Automation Grouping”](https://community.home-assistant.io/t/grouping-automations-on-frontend-for-organization/102771),
+we realized that organization can be done in multiple ways for different purposes.
+
+We learned that users who are proficient in making {% term automations %} have
+hundreds of them, which makes locating a particular automation hard. They often
+had to resort to using "hacks" such as emojis, bracketed “tags”, or numbering
+each automation to get the sort order they wanted. They needed a way to easily
+filter down and break down the giant list into more manageable chunks.
+
+We also noticed that users are stretching our areas feature beyond its
+intended purpose. For example, some users would create “{% term areas %}” such
+as “3D printer”, “Christmas decorations”, or even “Left side of my office desk”,
+to group different {% term devices %} and {% term entities %} together under
+one umbrella for dashboards or {% term automations %}.
+
+As we are developing our new dashboards and voice commands, this poses a
+big problem: We would be unable to provide specialized solutions if a dashboard
+{% term blueprint %} or automation blueprint cannot confidently assume the context of
+how it would be used. We need something more specialized.
+
+Therefore, to balance the basic goal of providing a more digestible UI for
+all users, the need for flexibility for our power users, and the future vision
+of Home Assistant, we are introducing 3 new organization structures to
+Home Assistant:
+
+**[Floors](#floors-help-home-assistant-understand-your-house)**,
+**[Labels](#labels-tag-everything-any-way-you-want)**,
+and **[Categories](#categories-make-each-settings-page-easier-to-browse)**
+
+### Floors: Help Home Assistant understand your house
+
+Let's talk about the new organizational structures, starting with **floors**.
+
+To become a truly intelligent home automation platform, Home Assistant needs
+to understand the context: Where exactly is a {% term device%}? How does one
+{%term area %} relate to another? What is the space used for?
+
+Currently, Home Assistant has {% term areas %}. Areas specify the physical
+location or vicinity of your devices per living space in your home
+(like the living room or kitchen). However, some users living in standalone
+houses might have multiple floors with their own areas.
+
+{% term Floors %} are a new way to organize your areas per level of floors in
+your home. The better Home Assistant knows your home and how it is spatially
+structured, the better it can help you. Especially when it comes to future
+features like generating dashboards, voice commands, and maybe even
+AI-related features.
+
+
+
+You can use floors in your {% term automations %} and {% term scripts %} as a
+target for your actions or control them with your voice. For example, you can
+turn off all the lights on the downstairs floor when you go to bed or ask
+[Assist](/voice_control/) to turn on the lights upstairs.
+
+For our power users, you can even use [floors in your templates](/docs/configuration/templating/#floors)
+to create the most advanced and creative automations.
+
+{% my areas badge %}
+
+### Labels: Tag everything any way you want
+
+{% term Floors %} and {% term areas %} are great for representing your actual
+home, but as everyone has their own ways of organizing their home, everyone
+has their own ways of organizing their Home Assistant, too!
+This is where **labels** 🏷️ come in!
+
+Labels is an organizational structure that is completely up to you. You can
+make as many labels with any naming structure, in any color 🌈 you want, and
+assign them to basically anything in Home Assistant. You assign labels to
+anything: {% term areas %}, {% term devices %}, {% term entities %},
+{% term automations %}, {% term scripts %}, helpers, you name it!
+You can even assign multiple labels to the same thing.
+
+
+
+Just like with floors, you can use labels in your automations and scripts as
+a target for your {% term actions %}. This gives you a lot of flexibility,
+not just in organizing your Home Assistant, but also in automating your home! 🤯
+
+For example, you could create a label "🎄 Christmas" to label all your
+Christmas decorations during the holiday season. You can then use this label to
+automate all of those decorations at once or to filter them in the new tables.
+
+More examples? You could create a label "🔒 Security" to label and control all
+your security-related devices and automations. Or, "🛌 Bedrooms" to label all
+your bedroom areas and simultaneously control all the devices in those areas.
+
+Do you have solar panels or home batteries? Create a label "⚡️ Heavy energy usage"
+to label devices that consume a lot of energy. You could switch them off when
+there is not enough battery or solar energy available.
+
+You decide how to use labels, and the possibilities are endless! And for our
+power users, you guessed it, you can use [labels in your templates](/docs/configuration/templating/#labels).
+
+{% my labels badge %}
+
+### Categories: Make each settings page easier to browse
+
+Last but not least, we are introducing **categories**. Categories are designed
+to be paired with the aforementioned [item grouping feature](#item-grouping),
+and it can be used to group things visually specific to a certain table
+in Home Assistant.
+
+This is great for those who have a particular way of displaying their
+{% term entities %} by separating them into multiple sections on a specific page.
+For example, on the {% term automations %} page, you can create categories only
+used for visually grouping automations but nowhere else, like "Notifications"
+or “NFC tags”. You can then view your automations grouped or filtered by
+those categories.
+
+
+
+As these categories are unique for each dashboard, you can have different
+sets of categories depending on the place you are organizing. This means
+you can have different categories on the automations page than the
+{% term scene %}, {% term scripts %}, or helpers settings page.
+
+### Time to clean up your Home Assistant!
+
+In summary, there are a total of 4 taxonomies for organizing your entities.
+It sounds like a lot, but they all serve a distinct purpose. We are extending
+and clarifying {% term areas %} with {% term floors %}, and we are introducing
+{% term labels %} and {% term categories %} to make your {% term automations %}
+and many other tables look more organized and be more manageable.
+
+What’s next? Time to dig in! Here are a few steps we recommend you take
+action on to organize your Home Assistant better:
+
+- **Migrate to labels**:
+ - If you have been grouping automations with emojis and bracketed text,
+ you can now create labels for each. Labels can have icons to replace the
+ emojis you had before.
+ - For areas that aren’t really physical spaces, switching them to labels will
+ provide you more flexibility in organizing your entities.
+- **Start using categories**:
+ If you have a favorite way of organizing a particular page, create those
+ categories and group the table by them. For example, you could create a
+ notification category for all your notification automations and put all
+ notification automations in that category.
+- **Group your areas into floors**:
+ If you live in a multi-story home, grouping areas into floors help with
+ organizing the areas as well as making them more compatible with future
+ features.
+
+Last of all, to help us to help you to perfect the design of these new features,
+we would love to hear your feedback and see how you use them! Please feel free
+to share them in the comments below and discuss them in our community.
+
+## Map dashboard
+
+Introducing a new dashboard this release: The **map**! 🗺️
+
+You might think, "Hey, we already have a map dashboard in Home Assistant!"
+and you are right! However, the map was an integration that was always there
+and didn't provide the flexibility and features that were wanted.
+
+With the map dashboard's introduction, you can now add multiple map dashboards
+with different entities and configuration settings. For example, create a
+dashboard to show the location of your family members, another to track your
+car, and another to show the location of your pets. 🐶
+
+
+
+On upgrade, Home Assistant will automatically migrate your existing map
+integration to a map dashboard.
+
+You don't like having the map in your sidebar? Well, that is no longer a
+problem. Since it is now a dashboard it means you can remove it in the dashboard
+settings.
+
+## Webpage dashboard
+
+Another new dashboard for this release is the **webpage**! 🌐
+
+The webpage dashboard allows you to add and embed a webpage to your dashboard.
+This could be a web page from the internet or a local web page from a local
+machine or device like your router or NAS.
+
+
+
+This dashboard replaces the old iFrame panel (`iframe_panel`). If you have
+existing panels configured in your YAML configuration, Home Assistant will
+automatically migrate them to the new webpage dashboard on upgrade.
+
+
+
+Note that not every webpage can be embedded due to security restrictions that
+some sites or pages have in place, enforced by your browser, that prevent
+embedding them into a Home Assistant dashboard.
+
+## Define the columns in the section view
+
+In the last release, we [introduced the section view](/blog/2024/03/06/release-20243/#a-new-experimental-sections-view)
+with drag and drop support. We are absolutely thrilled to see how many of you
+loved it! 🥰
+
+Many thanks for all the feedback and suggestions! We are prioritizing them and
+are working on making the section view even better in the upcoming releases.
+
+In this release, based on your feedback, we have added the ability for you to
+define the maximum number of columns that the section view uses. This allows you
+to limit the number of columns, regardless of the screen width on which you
+are viewing your dashboard.
+
+
+
+## Adding Matter devices from other controllers
+
+In the [February release](/blog/2024/02/07/release-20242/#matter-diagnostics-and-actions),
+we added support for sharing Matter devices tied to Home Assistant with other
+Matter controllers. This release, we are making the other way around easier.
+
+We have improved how you can add Matter devices from other controllers to
+Home Assistant. When you add a Matter device to Home Assistant, it will now
+ask you if you want to add a new Matter device or if you want to add a device
+that is already added to another controller (like Google Home or Apple Home).
+
+
+
+Suppose you choose to add a device that has already been added to another
+controller. In that case, Home Assistant will guide you through how to
+achieve this step by step.
+
+
+
+## Lock behavior improvements
+
+Some smart locks have an open (or unlatching) mechanism that can be triggered
+remotely. The door either pops out of the lock or can be opened by pushing
+against the door.
+
+We want to ensure you don't accidentally open the door when you miss-clicked
+the button (for example, while not at home 😬). Therefore, we have improved
+the behavior of locks in our user interface by requiring you to confirm the
+action.
+
+
+
+## Even more performance!
+
+Remember how we wrote last release that [Home Assistant now boots twice as fast](/blog/2024/03/06/release-20243/#home-assistant-boots-twice-as-fast)?
+Well, [@bdraco] wasn't done yet and teamed up with [@balloob]. If you thought
+the previous release was fast, you are in for a treat! 🚀 The difference is,
+yet again, very noticeable.
+
+Besides streamlining what is loaded at startup (and doing less loading), we
+have adjusted the startup time tracking. It used to be that one integration
+could push other integrations to be slow too; that should no longer be the case,
+making this a more accurate representation of the actual startup time.
+
+Want to learn about the individual startup times of your integrations? You can
+find them in the {% my repairs title="**Settings** -> **System** -> **Repairs**" %}
+page by selecting the three-dotted menu in the top right and selecting the
+**Integration startup time** item.
+
+{% my repairs badge %}
+
+[@bdraco]: https://github.com/bdraco
+[@balloob]: https://github.com/balloob
+
+## Other noteworthy changes
+
+There are many more improvements in this release; here are some of the other
+noteworthy changes this release:
+
+- [@karwosts] has improved your Home Assistant {% my profile title="user profile" %}
+ page, making navigating and finding the settings you are looking for easier.
+ Nice work!
+- If you use a [sentence trigger] in your automation to trigger it using
+ [Assist]. The trigger will now include the `device_id` in its trigger data
+ you can automate with. Thanks, [@synesthesiam]!
+- The [HomeWizard Energy] integration now supports the newest generation of
+ HomeWizard Energy Sockets! Thanks, [@DCSBL]!
+- We can now ship new releases of Home Assistant in waaay less time.
+ Building and shipping Home Assistant for you, went down from 1.5-2 hours to
+ just 20 minutes! 🚀 Thanks [@edenhaus]!
+ [Learn more about it in our developer blog](https://developers.home-assistant.io/blog/2024/04/03/build-images-with-uv/).
+- [Reolink] now supports PTZ patrol start/stop, package detection and controls
+ for playing quick reply messages. Thanks, [@starkillerOG]!
+- We have brand new template functions available to list [all the issues] in
+ your repairs dashboard. Thanks, [@RoboMagus]!
+- If you prefer your wind speed sensors to be in Beaufort, you are in luck!
+ You can now change the unit of measurement to Beaufort. Thanks, [@fwestenberg]!
+- The [Husqvarna Automower] integration development continues and has additional
+ new entities, including sensors, select entities, and a device tracker.
+ Thanks, [@Thomas55555]!
+- [@catsmanac] has added a sensor to monitor the battery storage attached
+ to your [Enphase Envoy]; it works with the energy dashboard! Nice!
+- The [Xiaomi BLE] integration now supports locks and fingerprint readers!
+ Awesome, [@Ernst79]!
+
+[@catsmanac]: https://github.com/catsmanac
+[@DCSBL]: https://github.com/DCSBL
+[@edenhaus]: https://github.com/edenhaus
+[@Ernst79]: https://github.com/Ernst79
+[@fwestenberg]: https://github.com/fwestenberg
+[@karwosts]: https://github.com/karwosts
+[@RoboMagus]: https://github.com/RoboMagus
+[@starkillerOG]: https://github.com/starkillerOG
+[@synesthesiam]: https://github.com/synesthesiam
+[@Thomas55555]: https://github.com/Thomas55555
+[all the issues]: /docs/configuration/templating/#issues
+[Assist]: /voice_control/
+[Enphase Envoy]: /integrations/enphase_envoy
+[HomeWizard Energy]: /integrations/homewizard
+[Husqvarna Automower]: /integrations/husqvarna_automower
+[Reolink]: /integrations/reolink
+[sentence trigger]: /docs/automation/trigger/#sentence-trigger
+[Xiaomi BLE]: /integrations/xiaomi_ble
+
+## New integrations
+
+We welcome the following new integrations in this release:
+
+- **[Fyta]**, added by [@dontinelli]+ Monitor your plants with Fyta, a smart plant sensor that measures light, + temperature, humidity, and soil moisture. +- **[Motionblinds Bluetooth]**, added by [@LennP]
+ Control your Bluetooth Low Energy Motionblinds motorized window coverings. +- **[Ollama]**, added by [@synesthesiam]
+ Ollama a fully local AI conversation platform that can be used to create + custom voice assistants. + +[@dontinelli]: https://github.com/dontinelli +[@LennP]: https://github.com/LennP +[@synesthesiam]: https://github.com/synesthesiam +[Fyta]: /integrations/fyta +[Motionblinds Bluetooth]: /integrations/motionblinds_ble +[Ollama]: /integrations/ollama + +This release also has new virtual integration. Virtual integrations are stubs +that are handled by other (existing) integrations to help with findability. +The following virtual integration have been added: + +- **[Sacramento Municipal Utility District (SMUD)]**, provided by [Opower] + +[Sacramento Municipal Utility District (SMUD)]: /integrations/smud +[Opower]: /integrations/opower + +## Integrations now available to set up from the UI + +The following integrations are now available via the Home Assistant UI: + +- **[Lutron Homeworks]**, done by [@emontnemery] +- **[17TRACK]**, done by [@shaiu] +- **[Downloader]**, done by [@erwindouna] +- **[ROVA]**, done by [@GidoHakvoort] + +[@emontnemery]: https://github.com/emontnemery +[@erwindouna]: https://github.com/erwindouna +[@GidoHakvoort]: https://github.com/GidoHakvoort +[@shaiu]: https://github.com/shaiu +[17TRACK]: /integrations/seventeentrack +[Downloader]: /integrations/downloader +[Lutron Homeworks]: /integrations/homeworks +[ROVA]: /integrations/rova + +## Release 2024.4.1 - April 5 + +- Update aioairzone-cloud to v0.4.7 ([@Noltari] - [#114761]) +- Bump myuplink dependency to 0.6.0 ([@astrandb] - [#114767]) +- Update romy to 0.0.9 ([@cdce8p] - [#114360]) +- Update romy to 0.0.10 ([@xeniter] - [#114785]) +- Fix unhandled `KeyError` during Notion setup ([@bachya] - [#114787]) +- Fix Lutron light brightness values ([@cdheiser] - [#114794]) +- Fix type cast in snmp ([@lextm] - [#114795]) +- Handle ambiguous script actions by using action map order ([@bdraco] - [#114825]) +- Bump opower to 0.4.3 ([@tronikos] - [#114826]) +- Refactor ConfigStore to avoid needing to pass config_dir ([@bdraco] - [#114827]) +- Avoid blocking IO in downloader initialization ([@joostlek] - [#114841]) +- Fix Downloader YAML import ([@joostlek] - [#114844]) +- Update frontend to 20240404.0 ([@bramkragten] - [#114859]) +- Fix Axis camera platform support HTTPS ([@Kane610] - [#114886]) +- Bump weatherflow4py to 0.2.20 ([@jeeftor] - [#114888]) +- Fix Axis reconfigure step not providing protocols as alternatives but as string ([@Kane610] - [#114889]) +- Update frontend to 20240404.1 ([@bramkragten] - [#114890]) +- Ensure all tables have the default table args in the db_schema ([@bdraco] - [#114895]) +- Reduce august polling frequency ([@bdraco] - [#114904]) +- Show correct model string in myuplink ([@astrandb] - [#114921]) +- Create right import issues in Downloader ([@joostlek] - [#114922]) +- Fix cast dashboard in media browser ([@joostlek] - [#114924]) +- Pin systembridgemodels to 4.0.4 ([@timmo001] - [#114842]) +- Fix ROVA validation ([@joostlek] - [#114938]) + +[#114360]: https://github.com/home-assistant/core/pull/114360 +[#114761]: https://github.com/home-assistant/core/pull/114761 +[#114764]: https://github.com/home-assistant/core/pull/114764 +[#114767]: https://github.com/home-assistant/core/pull/114767 +[#114785]: https://github.com/home-assistant/core/pull/114785 +[#114787]: https://github.com/home-assistant/core/pull/114787 +[#114794]: https://github.com/home-assistant/core/pull/114794 +[#114795]: https://github.com/home-assistant/core/pull/114795 +[#114825]: https://github.com/home-assistant/core/pull/114825 +[#114826]: https://github.com/home-assistant/core/pull/114826 +[#114827]: https://github.com/home-assistant/core/pull/114827 +[#114841]: https://github.com/home-assistant/core/pull/114841 +[#114842]: https://github.com/home-assistant/core/pull/114842 +[#114844]: https://github.com/home-assistant/core/pull/114844 +[#114859]: https://github.com/home-assistant/core/pull/114859 +[#114886]: https://github.com/home-assistant/core/pull/114886 +[#114888]: https://github.com/home-assistant/core/pull/114888 +[#114889]: https://github.com/home-assistant/core/pull/114889 +[#114890]: https://github.com/home-assistant/core/pull/114890 +[#114895]: https://github.com/home-assistant/core/pull/114895 +[#114904]: https://github.com/home-assistant/core/pull/114904 +[#114921]: https://github.com/home-assistant/core/pull/114921 +[#114922]: https://github.com/home-assistant/core/pull/114922 +[#114924]: https://github.com/home-assistant/core/pull/114924 +[#114938]: https://github.com/home-assistant/core/pull/114938 +[@Kane610]: https://github.com/Kane610 +[@Noltari]: https://github.com/Noltari +[@astrandb]: https://github.com/astrandb +[@bachya]: https://github.com/bachya +[@bdraco]: https://github.com/bdraco +[@bramkragten]: https://github.com/bramkragten +[@cdce8p]: https://github.com/cdce8p +[@cdheiser]: https://github.com/cdheiser +[@frenck]: https://github.com/frenck +[@jeeftor]: https://github.com/jeeftor +[@joostlek]: https://github.com/joostlek +[@lextm]: https://github.com/lextm +[@timmo001]: https://github.com/timmo001 +[@tronikos]: https://github.com/tronikos +[@xeniter]: https://github.com/xeniter + +## Release 2024.4.2 - April 8 + +- Fix hang in SNMP device_tracker implementation ([@nmaggioni] - [#112815]) +- Fix missing if statement in homematic ([@bbr111] - [#114832]) +- Bump pylitterbot to 2023.4.11 ([@natekspencer] - [#114918]) +- Fix Snapcast Config flow ([@joostlek] - [#114952]) +- Bump axis to v61 ([@Kane610] - [#114964]) +- Filter out fuzzy translations from Lokalise ([@joostlek] - [#114968]) +- Upgrade to pynobo 1.8.1 ([@oyvindwe] - [#114982]) +- Fix dictionary changed size during iteration in prometheus ([@bdraco] - [#115005]) +- Bump `brother` to version 4.1.0 ([@bieniu] - [#115021]) +- Bump yolink-api to 0.4.2 ([@matrixd2] - [#115026]) +- Update xknxproject to 3.7.1 ([@farmio] - [#115053]) +- Fix synology_dsm availablity ([@bdraco] - [#115073]) +- Downgrade hass-nabucasa from 0.80.0 to 0.78.0 ([@ludeeus] - [#115078]) +- Bump velbus-aio to 2024.4.1 ([@Cereal2nd] - [#115109]) +- Terminate scripts with until and while conditions that execute more than 10000 times ([@bdraco] - [#115110]) +- improve handling of incorrect values in fyta integration ([@dontinelli] - [#115134]) +- Bump fyta_cli to 0.3.5 ([@dontinelli] - [#115143]) +- Fix fibaro sensor additional sensor lookup ([@rappenze] - [#115148]) +- Write timer entity state before firing events ([@bdraco] - [#115151]) +- Avoid checking for polling if an entity fails to add ([@bdraco] - [#115159]) +- Only reset requested utility meter with no tariff ([@gibwar] - [#115170]) + +[#112815]: https://github.com/home-assistant/core/pull/112815 +[#114764]: https://github.com/home-assistant/core/pull/114764 +[#114832]: https://github.com/home-assistant/core/pull/114832 +[#114918]: https://github.com/home-assistant/core/pull/114918 +[#114934]: https://github.com/home-assistant/core/pull/114934 +[#114952]: https://github.com/home-assistant/core/pull/114952 +[#114964]: https://github.com/home-assistant/core/pull/114964 +[#114968]: https://github.com/home-assistant/core/pull/114968 +[#114982]: https://github.com/home-assistant/core/pull/114982 +[#115005]: https://github.com/home-assistant/core/pull/115005 +[#115021]: https://github.com/home-assistant/core/pull/115021 +[#115026]: https://github.com/home-assistant/core/pull/115026 +[#115053]: https://github.com/home-assistant/core/pull/115053 +[#115073]: https://github.com/home-assistant/core/pull/115073 +[#115078]: https://github.com/home-assistant/core/pull/115078 +[#115109]: https://github.com/home-assistant/core/pull/115109 +[#115110]: https://github.com/home-assistant/core/pull/115110 +[#115134]: https://github.com/home-assistant/core/pull/115134 +[#115143]: https://github.com/home-assistant/core/pull/115143 +[#115148]: https://github.com/home-assistant/core/pull/115148 +[#115151]: https://github.com/home-assistant/core/pull/115151 +[#115159]: https://github.com/home-assistant/core/pull/115159 +[#115170]: https://github.com/home-assistant/core/pull/115170 +[@Cereal2nd]: https://github.com/Cereal2nd +[@Kane610]: https://github.com/Kane610 +[@bbr111]: https://github.com/bbr111 +[@bdraco]: https://github.com/bdraco +[@bieniu]: https://github.com/bieniu +[@dontinelli]: https://github.com/dontinelli +[@farmio]: https://github.com/farmio +[@frenck]: https://github.com/frenck +[@gibwar]: https://github.com/gibwar +[@joostlek]: https://github.com/joostlek +[@ludeeus]: https://github.com/ludeeus +[@matrixd2]: https://github.com/matrixd2 +[@natekspencer]: https://github.com/natekspencer +[@nmaggioni]: https://github.com/nmaggioni +[@oyvindwe]: https://github.com/oyvindwe +[@rappenze]: https://github.com/rappenze + +## Release 2024.4.3 - April 12 + +- Bump aiohttp to 3.9.4 ([@bdraco] - [#110730]) +- Add support for adopt data disk repair ([@mdegat01] - [#114891]) +- Improve Risco exception logging ([@OnFreund] - [#115232]) +- Configurable maximum concurrency in Risco local ([@OnFreund] - [#115226]) +- Fix misssing timeout in caldav ([@bdraco] - [#115247]) +- Fix Google Tasks parsing of remove responses ([@allenporter] - [#115258]) +- Bump forecast-solar lib to v3.1.0 ([@klaasnicolaas] - [#115272]) +- Support backup of add-ons with hyphens ([@agners] - [#115274]) +- Bump pymodbus v3.6.7 ([@janiversen] - [#115279]) +- Bump yt-dlp to 2024.04.09 ([@joostlek] - [#115295]) +- Fix Aranet failure when the Bluetooth proxy is not providing a device name ([@thecode] - [#115298]) +- Bump zha-quirks to 0.0.114 ([@TheJulianJES] - [#115299]) +- Ensure automations do not execute from a trigger if they are disabled ([@bdraco] - [#115305]) +- Bump bleak-retry-connector 3.5.0 ([@bdraco] - [#115328]) +- Secure against resetting a non active modbus ([@janiversen] - [#115364]) +- Solve modbus test problem ([@janiversen] - [#115376]) +- Fix deadlock in holidays dynamic loading ([@bdraco] - [#115385]) +- Bump whirlpool-sixth-sense to 0.18.8 ([@NodeJSmith] - [#115393]) +- Fix bug in rainbird switch when turning off a switch that is already off ([@allenporter] - [#115421]) +- Bump pybotvac to 0.0.25 ([@Santobert] - [#115435]) +- Update frontend to 20240404.2 ([@bramkragten] - [#115460]) + +[#110730]: https://github.com/home-assistant/core/pull/110730 +[#114764]: https://github.com/home-assistant/core/pull/114764 +[#114891]: https://github.com/home-assistant/core/pull/114891 +[#114934]: https://github.com/home-assistant/core/pull/114934 +[#115186]: https://github.com/home-assistant/core/pull/115186 +[#115226]: https://github.com/home-assistant/core/pull/115226 +[#115232]: https://github.com/home-assistant/core/pull/115232 +[#115247]: https://github.com/home-assistant/core/pull/115247 +[#115258]: https://github.com/home-assistant/core/pull/115258 +[#115272]: https://github.com/home-assistant/core/pull/115272 +[#115274]: https://github.com/home-assistant/core/pull/115274 +[#115279]: https://github.com/home-assistant/core/pull/115279 +[#115295]: https://github.com/home-assistant/core/pull/115295 +[#115298]: https://github.com/home-assistant/core/pull/115298 +[#115299]: https://github.com/home-assistant/core/pull/115299 +[#115305]: https://github.com/home-assistant/core/pull/115305 +[#115328]: https://github.com/home-assistant/core/pull/115328 +[#115364]: https://github.com/home-assistant/core/pull/115364 +[#115376]: https://github.com/home-assistant/core/pull/115376 +[#115385]: https://github.com/home-assistant/core/pull/115385 +[#115393]: https://github.com/home-assistant/core/pull/115393 +[#115421]: https://github.com/home-assistant/core/pull/115421 +[#115435]: https://github.com/home-assistant/core/pull/115435 +[#115460]: https://github.com/home-assistant/core/pull/115460 +[@NodeJSmith]: https://github.com/NodeJSmith +[@OnFreund]: https://github.com/OnFreund +[@Santobert]: https://github.com/Santobert +[@TheJulianJES]: https://github.com/TheJulianJES +[@agners]: https://github.com/agners +[@allenporter]: https://github.com/allenporter +[@bdraco]: https://github.com/bdraco +[@bramkragten]: https://github.com/bramkragten +[@frenck]: https://github.com/frenck +[@janiversen]: https://github.com/janiversen +[@joostlek]: https://github.com/joostlek +[@klaasnicolaas]: https://github.com/klaasnicolaas +[@mdegat01]: https://github.com/mdegat01 +[@thecode]: https://github.com/thecode + +## Release 2024.4.4 - April 23 + +- Bump slixmpp version to 1.8.5 ([@ravermeister] - [#114448]) +- Make Withings recoverable after internet outage ([@joostlek] - [#115124]) +- Fix Hyperion light not updating state ([@avee87] - [#115389]) +- Add scheduled mode to renault charge mode ([@slyoldfox] - [#115427]) +- Bump zeroconf to 0.132.1 ([@bdraco] - [#115501]) +- Bump zeroconf to 0.132.2 ([@bdraco] - [#115505]) +- Update pillow to 10.3.0 ([@cdce8p] - [#115524]) +- Fix race in TimestampDataUpdateCoordinator ([@bdraco] - [#115542]) +- Fix Teslemetry sensor values ([@Bre77] - [#115571]) +- Modbus: Bump pymodbus v3.6.8 ([@janiversen] - [#115574]) +- Fix sensor entity description in Teslemetry ([@Bre77] - [#115614]) +- Bump httpcore to 1.0.5 ([@bdraco] - [#115672]) +- Bump sqlparse to 0.5.0 ([@bdraco] - [#115681]) +- Bump aiohttp to 3.9.5 ([@bdraco] - [#115727]) +- Bump renault-api to 0.2.2 ([@epenet] - [#115738]) +- Fix homeworks import flow ([@emontnemery] - [#115761]) +- Allow [##:##:##] type keypad address in homeworks ([@emontnemery] - [#115762]) +- Add missing media_player features to Samsung TV ([@chemelli74] - [#115788]) +- Bump aiounifi to v75 ([@Kane610] - [#115819]) +- Ensure scripts with timeouts of zero timeout immediately ([@bdraco] - [#115830]) +- Fix KeyError error when fetching sensors (Airthings) ([@LaStrada] - [#115844]) +- Bump plexapi to 4.15.12 ([@jjlawren] - [#115872]) +- Bump ical to 8.0.0 ([@allenporter] - [#115907]) +- Fix geo location attributes of Tankerkoenig sensors ([@mib1185] - [#115914]) +- Use start helper in squeezebox for server discovery ([@rajlaud] - [#115978]) + +[#114448]: https://github.com/home-assistant/core/pull/114448 +[#114764]: https://github.com/home-assistant/core/pull/114764 +[#114934]: https://github.com/home-assistant/core/pull/114934 +[#115124]: https://github.com/home-assistant/core/pull/115124 +[#115186]: https://github.com/home-assistant/core/pull/115186 +[#115389]: https://github.com/home-assistant/core/pull/115389 +[#115427]: https://github.com/home-assistant/core/pull/115427 +[#115463]: https://github.com/home-assistant/core/pull/115463 +[#115501]: https://github.com/home-assistant/core/pull/115501 +[#115505]: https://github.com/home-assistant/core/pull/115505 +[#115524]: https://github.com/home-assistant/core/pull/115524 +[#115542]: https://github.com/home-assistant/core/pull/115542 +[#115571]: https://github.com/home-assistant/core/pull/115571 +[#115574]: https://github.com/home-assistant/core/pull/115574 +[#115614]: https://github.com/home-assistant/core/pull/115614 +[#115672]: https://github.com/home-assistant/core/pull/115672 +[#115681]: https://github.com/home-assistant/core/pull/115681 +[#115727]: https://github.com/home-assistant/core/pull/115727 +[#115738]: https://github.com/home-assistant/core/pull/115738 +[#115761]: https://github.com/home-assistant/core/pull/115761 +[#115762]: https://github.com/home-assistant/core/pull/115762 +[#115788]: https://github.com/home-assistant/core/pull/115788 +[#115819]: https://github.com/home-assistant/core/pull/115819 +[#115830]: https://github.com/home-assistant/core/pull/115830 +[#115844]: https://github.com/home-assistant/core/pull/115844 +[#115872]: https://github.com/home-assistant/core/pull/115872 +[#115907]: https://github.com/home-assistant/core/pull/115907 +[#115914]: https://github.com/home-assistant/core/pull/115914 +[#115978]: https://github.com/home-assistant/core/pull/115978 +[@Bre77]: https://github.com/Bre77 +[@Kane610]: https://github.com/Kane610 +[@LaStrada]: https://github.com/LaStrada +[@allenporter]: https://github.com/allenporter +[@avee87]: https://github.com/avee87 +[@bdraco]: https://github.com/bdraco +[@cdce8p]: https://github.com/cdce8p +[@chemelli74]: https://github.com/chemelli74 +[@emontnemery]: https://github.com/emontnemery +[@epenet]: https://github.com/epenet +[@frenck]: https://github.com/frenck +[@janiversen]: https://github.com/janiversen +[@jjlawren]: https://github.com/jjlawren +[@joostlek]: https://github.com/joostlek +[@mib1185]: https://github.com/mib1185 +[@rajlaud]: https://github.com/rajlaud +[@ravermeister]: https://github.com/ravermeister +[@slyoldfox]: https://github.com/slyoldfox + +## Need help? Join the community! + +Home Assistant has a great community of users who are all more than willing +to help each other out. So, join us! + +Our very active [Discord chat server](/join-chat) is an excellent place to be +at, and don't forget to join our amazing [forums](https://community.home-assistant.io/). + +Found a bug or issue? Please report it in our [issue tracker](https://github.com/home-assistant/core/issues), +to get it fixed! Or, check [our help page](/help) for guidance for more +places you can go. + +Are you more into email? [Sign-up for our Building the Open Home Newsletter](/newsletter) +to get the latest news about features, things happening in our community and +other news about building an Open Home; straight into your inbox. + +## Backward-incompatible changes + +{% details "Python 3.11 support has been removed" %} + +Python 3.11 support has previously been deprecated and has now been removed. +Home Assistant now requires Python 3.12 to run. + +You don’t have to do anything if you are using the Home Assistant Operating +System, Home Assistant Container, or Home Assistant Supervised installation +method. In those cases, we handle all of this for you. Your system has been +using Python 3.12 for quite some time already. + +([@frenck] - [#114220]) + +[@frenck]: https://github.com/frenck +[#114220]: https://github.com/home-assistant/core/pull/114220 + +{% enddetails %} + +{% details "AEMET OpenData" %} + +The AEMET OpenData integration previously created two entities for each +configured location: one provided daily weather forecasts and the other hourly +forecasts. + +The AEMET OpenData integration now only creates a single entity that provides +both daily and hourly weather forecasts. + +([@gjohansson-ST] - [#110764]) ([documentation](/integrations/aemet)) + +[@gjohansson-ST]: https://github.com/gjohansson-ST +[#110764]: https://github.com/home-assistant/core/pull/110764 + +{% enddetails %} + +{% details "Dexcom" %} + +The trend sensor now uses values that are using snake_case instead of a space +in the middle: + +- `rising quickly` -> `rising_quickly` +- `rising slightly` -> `rising_slightly` +- `falling slightly` -> `falling_slightly` +- `falling quickly` -> `falling_quickly` + +Please update your automations and scripts accordingly. + +([@joostlek] - [#112423]) ([documentation](/integrations/dexcom)) + +[@joostlek]: https://github.com/joostlek +[#112423]: https://github.com/home-assistant/core/pull/112423 + +{% enddetails %} + +{% details "ecobee" %} + +The non-functional `away` preset mode has been replaced with the correct +`away_indefinitely` preset mode. + +If any automation or script depends on the `away` preset mode, +it needs to be updated. + +([@alexsydell] - [#108636]) ([documentation](/integrations/ecobee)) + +[@alexsydell]: https://github.com/alexsydell +[#108636]: https://github.com/home-assistant/core/pull/108636 + +{% enddetails %} + +{% details "Environment Canada" %} + +The Environment Canada integration previously created two entities for each +configured location: one provided daily weather forecasts and the other hourly +forecasts. + +The Environment Canada integration now only creates a single entity that +provides both daily and hourly weather forecasts. + +([@gjohansson-ST] - [#112447]) ([documentation](/integrations/environment_canada)) + +[@gjohansson-ST]: https://github.com/gjohansson-ST +[#112447]: https://github.com/home-assistant/core/pull/112447 + +{% enddetails %} + +{% details "National Weather Service (NWS)" %} + +The National Weather Service integration previously created two entities for each +configured location: one provided daily weather forecasts and the other hourly +forecasts. + +The National Weather Service integration now only creates a single entity that +provides both daily and hourly weather forecasts. + +([@gjohansson-ST] - [#112503]) ([documentation](/integrations/nws)) + +[@gjohansson-ST]: https://github.com/gjohansson-ST +[#112503]: https://github.com/home-assistant/core/pull/112503 + +{% enddetails %} + +{% details "Met Éireann" %} + +The Met Éireann integration previously created two entities for each configured +location: one provided daily weather forecasts and the other hourly forecasts. + +The Met Éireann integration now only creates a single entity that provides both +daily and hourly weather forecasts. + +([@gjohansson-ST] - [#112449]) ([documentation](/integrations/met_eireann)) + +[@gjohansson-ST]: https://github.com/gjohansson-ST +[#112449]: https://github.com/home-assistant/core/pull/112449 + +{% enddetails %} + +{% details "Met Office" %} + +The Met Office integration previously created two entities for each configured +location: one provided daily weather forecasts and the other hourly forecasts. + +The Met Office integration now only creates a single entity that provides both +daily and hourly weather forecasts. + +([@gjohansson-ST] - [#112452]) ([documentation](/integrations/metoffice)) + +[@gjohansson-ST]: https://github.com/gjohansson-ST +[#112452]: https://github.com/home-assistant/core/pull/112452 + +{% enddetails %} + +{% details "Modbus" %} + +The Modbus integration does not allow a configuration with the device only +(no entities); this will create an issue, and the entry will not be loaded. + +For the special cases (like some custom_components) where it is wanted, +please add a dummy entity. + +([@janiversen] - [#113516]) ([documentation](/integrations/modbus)) + +[@janiversen]: https://github.com/janiversen +[#113516]: https://github.com/home-assistant/core/pull/113516 + +{% enddetails %} + +{% details "MQTT" %} + +Support for `brightness` is now assumed for `mqtt` lights with the `json` schema +unless only color modes `rgb`, `rgbw`, or `rgbww` are supported. + +For lights which only support color modes `rgb`, `rgbw`, or `rgbww`, +the `brightness` option flag can still be set to `false` if brightness is not +supported. In this case brightness support is emulated in Home Assistant by +scaling the RGBx-values. + +For all other color modes except `ColorMode.ONOFF`, it is assumed brightness is +supported, and the `brightness` attribute will be included in the MQTT payload +when the `brightness` attribute is supplied to the `light.turn_on` service. + +([@jbouwh] - [#111676]) ([documentation](/integrations/mqtt)) + +[@jbouwh]: https://github.com/jbouwh +[#111676]: https://github.com/home-assistant/core/pull/111676 + +{% enddetails %} + +{% details "myUplink" %} + +If you have a Nibe SMO 20 in your account, you will notice that some 550 +entities are no longer provided by the integration. + +You can safely remove these entities as the integration does not use them. + +([@astrandb] - [#113493]) ([documentation](/integrations/myuplink)) + +[@astrandb]: https://github.com/astrandb +[#113493]: https://github.com/home-assistant/core/pull/113493 + +{% enddetails %} + +{% details "Waze Travel Time" %} + +The options `excl_filter` and `incl_filter` now filter for exact matches to +street names in the route. Previously, they only filtered on the short +description of the route. + +([@eifinger] - [#108613]) ([documentation](/integrations/waze_travel_time)) + +[@eifinger]: https://github.com/eifinger +[#108613]: https://github.com/home-assistant/core/pull/108613 + +{% enddetails %} + +{% details "Weather" %} + +The previously deprecated `forecast` attribute of weather entities, has now been +removed. Use the [`weather.get_forecasts`](/integrations/weather#service-weatherget_forecasts) +service to get the forecast data instead. + +([@gjohansson-ST] - [#110761]) ([documentation](/integrations/metoffice)) + +[@gjohansson-ST]: https://github.com/gjohansson-ST +[#110761]: https://github.com/home-assistant/core/pull/110761 + +{% enddetails %} + +If you are a custom integration developer and want to learn about breaking +changes and new features available for your integration: Be sure to follow our +[developer blog][devblog]. The following are the most notable for this release: + +- [Climate entity auxiliary heater is deprecated](https://developers.home-assistant.io/blog/2024/03/10/climate-aux-heater-deprecated) +- [Config Entries can now provide a reconfigure step](https://developers.home-assistant.io/blog/2024/03/21/config-entry-reconfigure-step) +- [Deprecate hass.helpers usage](https://developers.home-assistant.io/blog/2024/03/30/deprecate-hass-helpers/) +- [Deprecating `async_run_job` and `async_add_job`](https://developers.home-assistant.io/blog/2024/03/13/deprecate_add_run_job) +- [How uv saves Home Assistant 215 compute hours per month](https://developers.home-assistant.io/blog/2024/04/03/build-images-with-uv/) +- [Integrations import in the executor to avoid blocking the event loop](https://developers.home-assistant.io/blog/2024/03/09/import_executor_default) +- [New state timestamp State.last_reported](https://developers.home-assistant.io/blog/2024/03/20/state_reported_timestamp) +- [Raising exceptions with translations](https://developers.home-assistant.io/blog/2024/03/15/exception-translations) + +[devblog]: https://developers.home-assistant.io/blog/ + +## Farewell to the following + +The following integrations are also no longer available as of this release: + +- **OpenCV** has been removed. The integration has been in a broken state + for over a year and currently has no path forward. + ([@thecode] - [#113455]) + +[@thecode]: https://github.com/thecode +[#113455]: https://github.com/home-assistant/core/pull/113455 + +## All changes + +Of course, there is a lot more in this release. You can find a list of +all changes made here: [Full changelog for Home Assistant Core 2024.4](/changelogs/core-2024.4) diff --git a/source/_posts/2024-04-24-state-of-the-open-home-2024.markdown b/source/_posts/2024-04-24-state-of-the-open-home-2024.markdown new file mode 100644 index 000000000000..7b2359930ee2 --- /dev/null +++ b/source/_posts/2024-04-24-state-of-the-open-home-2024.markdown @@ -0,0 +1,33 @@ +--- +layout: post +title: "Thinking Bigger: State of the Open Home 2024" +description: "The State of the Open Home 2024 stream includes a deep dive into the evolution of Home Assistant, and how it has now reached an estimated 1 million installations." +date: 2024-04-24 00:00:01 +date_formatted: "April 24, 2024" +author: Gordon Cameron +comments: true +categories: Announcements +og_image: /images/blog/2024-04-24-state-of-the-open-home-2024/banner.jpg +--- + +We recently held our [State of the Open Home 2024 live stream](https://www.youtube.com/live/oa__fLArsFk?si=PzlfiHLUYE6uAEq3), where we revealed how we are thinking [even bigger](/blog/2018/09/17/thinking-big/) about securing the future of the smart home. During this stream we launched the [Open Home Foundation](https://www.openhomefoundation.org/), a new non-profit organization created to fight for the fundamental principles of the smart home — privacy, choice, and sustainability — focused on serving everyone that lives in one. To learn more about the Open Home Foundation read the full [announcement](https://www.openhomefoundation.org/blog/announcing-the-open-home-foundation/). + +The stream includes a deep dive into the evolution of Home Assistant and how it has now reached an estimated 1 million installations. There were other substantial updates on voice and hardware, including teasing our upcoming Z-Wave and voice assistant hardware. The first panel discussion featured the founders of Open Home Foundation collaborating projects WLED, Zigbee2MQTT, Rhasspy, and Z-Wave JS. A second panel gave a comprehensive overview of the state of open standards, featuring key open-source developers working on Zigbee, Z-Wave, Matter, and Bluetooth. The stream caps off with a look into the future of the open home, including the announcement of a roadmap full of exciting new features. + +
Screenshot of tile cards with features.
@@ -75,16 +88,3 @@ Another way to add entities to a dashboard is to use the **Device** page.
{% enddetails %}
-
-## Related topics
-
-- [Views](/dashboards/views/)
-- [Introduction to dashboards](/dashboards/)
-- [Take control of the default dashboard](/dashboards/#get-started-with-your-own-dashboard)
-
-### Cards
-
-- For a list of available card types and more detailed documentation, refer to the **Card types** section in the side navigation.
-- [Card tap actions](/dashboards/actions/)
-- [Card features](/dashboards/actions/)
-- [Card header and footer widgets](/dashboards/header-footer/)
\ No newline at end of file
diff --git a/source/dashboards/dashboards.markdown b/source/dashboards/dashboards.markdown
index abcb82ff328a..bb40bb191abc 100644
--- a/source/dashboards/dashboards.markdown
+++ b/source/dashboards/dashboards.markdown
@@ -1,6 +1,17 @@
---
title: "Multiple dashboards"
description: "Multiple powerful and configurable dashboards in Home Assistant."
+related:
+ - docs: /integrations/logbook/
+ title: Logbook integration
+ - docs: /integrations/history/
+ title: History integration
+ - docs: /integrations/todo/
+ title: To-do list integration
+ - docs: /dashboards/views/
+ title: Views
+ - docs: /dashboards/iframe/
+ title: Webpage card
---
You can define multiple dashboards in Home Assistant. Each dashboard can be added to the sidebar. This makes it possible to create separate control dashboards for each individual part of your house.
@@ -18,16 +29,20 @@ Home Assistant ships with some dashboards out of the box:
- Overview
- Energy
-- Map
+- [Map](#map-dashboard)
- Logbook
- History
- To-do lists
-Not all of the predefined dashboards are listed under {% my lovelace_dashboards title="**Settings** > **Dashboards**" %}. **Map**, **Logbook**, and **History**, are powered by their respective integrations.
+Not all of the predefined dashboards are listed under {% my lovelace_dashboards title="**Settings** > **Dashboards**" %}. The **Logbook** and **History** dashboards are powered by their respective integrations.
### Map dashboard
-The predefined **Map** dashboard is powered by the [Map integration](/integrations/map/). If you see a [person](/integrations/person/) on the map, it means you have connected a device that allows [presence detection](/integrations/#presence-detection). This is the case for example if you have the [Home Assistant Companion App](https://companion.home-assistant.io/) on your phone and allowed location tracking.
+The predefined **Map** dashboard is populated by the [Map card](/dashboards/map/). You can edit this dashboard like any other dashboard. For example, you can edit the [view](/dashboards/views/) to use the **Sidebar** instead of the default **Panel** view type if you like.
+
+#### Maps and presence detection
+
+If you see a [person](/integrations/person/) on the map, it means you have connected a device that allows [presence detection](/integrations/#presence-detection). This is the case for example if you have the [Home Assistant Companion App](https://companion.home-assistant.io/) on your phone and allowed location tracking.
### Logbook dashboard
@@ -41,6 +56,24 @@ The predefined **History** dashboard is powered by the [History integration](/in
The predefined **To-do lists** dashboard is powered by the [To-do integration](/integrations/todo/). To learn how to use to-do and shopping lists, refer to the documentation of the to-do list integration.
+## Webpage dashboard
+
+Another available (but not default) dashboard is the webpage dashboard. The webpage dashboard allows you to add and embed a webpage to your dashboard.
+This could be a web page from the internet or a local web page from a local
+machine or device like your router or NAS. The webpage dashboard uses the [webpage card](/dashboards/iframe/).
+
+
+
+This dashboard replaces the old iFrame panel (`iframe_panel`). If you have
+existing panels configured in your YAML configuration, Home Assistant will
+automatically migrate them to the new webpage dashboard on upgrade.
+
+
+
+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.
+
## Creating a new dashboard
The default **Overview** dashboard updates itself when you add new devices, as long as you do not edit the default dashboard. If you want a customized dashboard, it is recommended not to change the **Overview** dashboard, but to create a new dashboard instead.
@@ -66,6 +99,15 @@ This will leave the default dashboard intact.
- To continue, in the dialog, select the three dots menu, then select **Take control**.
7. You can now [add a card](/dashboards/cards/#adding-cards-to-your-dashboard) or [add a view](/dashboards/views/#adding-a-view-to-a-dashboard).
+## Deleting a dashboard
+
+If you do not use one of the predefined dashboards, or created a dashboard you no longer need, you can delete that dashboard. It will then no longer show in the sidebar.
+
+1. Go to {% my lovelace_dashboards title="**Settings** > **Dashboards**" %}.
+2. From the list of dashboards, select the dashboard you want to delete.
+3. In the dialog, select **Delete**.
+ 
+
## Using YAML for the Overview dashboard
To change the **Overview** dashboard, create a new file `ui-lovelace.yaml` in your configuration directory and add the following section to your `configuration.yaml` and restart Home Assistant:
@@ -251,10 +293,3 @@ views:
content: >
Welcome to your **dashboard**.
```
-
-## Related topics
-
-- [Logbook integration](/integrations/logbook/)
-- [Map integration](/integrations/map/)
-- [History integration](/integrations/history/)
-- [To-do list integration](/integrations/todo/)
\ No newline at end of file
diff --git a/source/dashboards/features.markdown b/source/dashboards/features.markdown
index fcdcf3826b12..b61bfcfbc83f 100644
--- a/source/dashboards/features.markdown
+++ b/source/dashboards/features.markdown
@@ -1,6 +1,13 @@
---
title: "Features for dashboard cards"
description: "Decorate your dashboard cards with quick controls."
+related:
+ - docs: /dashboards/humidifier/
+ title: Humidifier card
+ - docs: /dashboards/thermostat/
+ title: Thermostat card
+ - docs: /dashboards/tile/
+ title: Tile card
---
Some dashboard cards have support for features. These widgets add quick controls to the card. Supported features depend on the card and entity capabilities. Multiple features can be added to a single card.
@@ -239,6 +246,42 @@ type:
type: string
{% endconfiguration %}
+## Fan preset modes
+
+Widget that displays buttons or icons to control the preset mode for a [fan](/integrations/fan).
+
+
+ 
+ Screenshot of the tile card with the fan preset modes feature
+
-The map view will hide all devices that are home.
+The map dashboard will hide all devices that are home.
[routers]: /integrations/#presence-detection
@@ -40,7 +40,6 @@ The map view will hide all devices that are home.
[zone]: /integrations/zone/
[trigger]: /getting-started/automation-trigger/#zone-trigger
[condition]: /getting-started/automation-condition/#zone-condition
-[ha-map]: /integrations/map/
[companion]: https://companion.home-assistant.io/
{% include getting-started/next_step.html step="Join the Community" link="/getting-started/join-the-community/" %}
diff --git a/source/images/blog/2024-04-24-state-of-the-open-home-2024/banner.jpg b/source/images/blog/2024-04-24-state-of-the-open-home-2024/banner.jpg
new file mode 100644
index 000000000000..3102c8cc76a1
Binary files /dev/null and b/source/images/blog/2024-04-24-state-of-the-open-home-2024/banner.jpg differ
diff --git a/source/images/blog/2024-04/add-matter-device-from-another-controller.png b/source/images/blog/2024-04/add-matter-device-from-another-controller.png
new file mode 100644
index 000000000000..3e7714d90505
Binary files /dev/null and b/source/images/blog/2024-04/add-matter-device-from-another-controller.png differ
diff --git a/source/images/blog/2024-04/add-matter-device.png b/source/images/blog/2024-04/add-matter-device.png
new file mode 100644
index 000000000000..bfa816101b98
Binary files /dev/null and b/source/images/blog/2024-04/add-matter-device.png differ
diff --git a/source/images/blog/2024-04/bulk-actions.png b/source/images/blog/2024-04/bulk-actions.png
new file mode 100644
index 000000000000..db5dc131710e
Binary files /dev/null and b/source/images/blog/2024-04/bulk-actions.png differ
diff --git a/source/images/blog/2024-04/categories.png b/source/images/blog/2024-04/categories.png
new file mode 100644
index 000000000000..aab4aa74bf5c
Binary files /dev/null and b/source/images/blog/2024-04/categories.png differ
diff --git a/source/images/blog/2024-04/dashboard-map.png b/source/images/blog/2024-04/dashboard-map.png
new file mode 100644
index 000000000000..1de5d9c8322f
Binary files /dev/null and b/source/images/blog/2024-04/dashboard-map.png differ
diff --git a/source/images/blog/2024-04/dashboard-webpage.png b/source/images/blog/2024-04/dashboard-webpage.png
new file mode 100644
index 000000000000..3aa75c5f225b
Binary files /dev/null and b/source/images/blog/2024-04/dashboard-webpage.png differ
diff --git a/source/images/blog/2024-04/embedded-home-assistant-website.png b/source/images/blog/2024-04/embedded-home-assistant-website.png
new file mode 100644
index 000000000000..02fb5eae2dbe
Binary files /dev/null and b/source/images/blog/2024-04/embedded-home-assistant-website.png differ
diff --git a/source/images/blog/2024-04/enable-selection-mode.png b/source/images/blog/2024-04/enable-selection-mode.png
new file mode 100644
index 000000000000..2665d48a7441
Binary files /dev/null and b/source/images/blog/2024-04/enable-selection-mode.png differ
diff --git a/source/images/blog/2024-04/filter-panel.png b/source/images/blog/2024-04/filter-panel.png
new file mode 100644
index 000000000000..849df41edbf1
Binary files /dev/null and b/source/images/blog/2024-04/filter-panel.png differ
diff --git a/source/images/blog/2024-04/floors.png b/source/images/blog/2024-04/floors.png
new file mode 100644
index 000000000000..749ceb77a667
Binary files /dev/null and b/source/images/blog/2024-04/floors.png differ
diff --git a/source/images/blog/2024-04/group-items-by-manufacturer.png b/source/images/blog/2024-04/group-items-by-manufacturer.png
new file mode 100644
index 000000000000..e161047d213a
Binary files /dev/null and b/source/images/blog/2024-04/group-items-by-manufacturer.png differ
diff --git a/source/images/blog/2024-04/item-grouping.png b/source/images/blog/2024-04/item-grouping.png
new file mode 100644
index 000000000000..9d30d4ef3db3
Binary files /dev/null and b/source/images/blog/2024-04/item-grouping.png differ
diff --git a/source/images/blog/2024-04/labels.png b/source/images/blog/2024-04/labels.png
new file mode 100644
index 000000000000..e6dd867ec0e5
Binary files /dev/null and b/source/images/blog/2024-04/labels.png differ
diff --git a/source/images/blog/2024-04/lock-unlatch-confirmation.gif b/source/images/blog/2024-04/lock-unlatch-confirmation.gif
new file mode 100644
index 000000000000..93fdb2252983
Binary files /dev/null and b/source/images/blog/2024-04/lock-unlatch-confirmation.gif differ
diff --git a/source/images/blog/2024-04/new-toolbar.png b/source/images/blog/2024-04/new-toolbar.png
new file mode 100644
index 000000000000..9b3992d606c6
Binary files /dev/null and b/source/images/blog/2024-04/new-toolbar.png differ
diff --git a/source/images/blog/2024-04/sections-dashboard-limit-columns.png b/source/images/blog/2024-04/sections-dashboard-limit-columns.png
new file mode 100644
index 000000000000..5a1f5567bd36
Binary files /dev/null and b/source/images/blog/2024-04/sections-dashboard-limit-columns.png differ
diff --git a/source/images/blog/2024-04/social.png b/source/images/blog/2024-04/social.png
new file mode 100644
index 000000000000..ddd0a5cbc46a
Binary files /dev/null and b/source/images/blog/2024-04/social.png differ
diff --git a/source/images/blueprints/selector-floor.png b/source/images/blueprints/selector-floor.png
new file mode 100644
index 000000000000..7c345440b0df
Binary files /dev/null and b/source/images/blueprints/selector-floor.png differ
diff --git a/source/images/blueprints/selector-label.png b/source/images/blueprints/selector-label.png
new file mode 100644
index 000000000000..9c4e255e8856
Binary files /dev/null and b/source/images/blueprints/selector-label.png differ
diff --git a/source/images/dashboards/cards-todo.png b/source/images/dashboards/cards-todo.png
new file mode 100644
index 000000000000..b7d40840db80
Binary files /dev/null and b/source/images/dashboards/cards-todo.png differ
diff --git a/source/images/dashboards/dashboard-manage-01.png b/source/images/dashboards/dashboard-manage-01.png
index bfd486c364fa..55f693582c48 100644
Binary files a/source/images/dashboards/dashboard-manage-01.png and b/source/images/dashboards/dashboard-manage-01.png differ
diff --git a/source/images/dashboards/delete_dashboard.png b/source/images/dashboards/delete_dashboard.png
new file mode 100644
index 000000000000..9b05ffc4e2e4
Binary files /dev/null and b/source/images/dashboards/delete_dashboard.png differ
diff --git a/source/images/dashboards/features/fan_preset_modes.png b/source/images/dashboards/features/fan_preset_modes.png
new file mode 100644
index 000000000000..25179dd76178
Binary files /dev/null and b/source/images/dashboards/features/fan_preset_modes.png differ
diff --git a/source/images/dashboards/shopping_list_card.gif b/source/images/dashboards/shopping_list_card.gif
deleted file mode 100644
index 34e221758d84..000000000000
Binary files a/source/images/dashboards/shopping_list_card.gif and /dev/null differ
diff --git a/source/images/dashboards/todo-list_card_shopping-list.png b/source/images/dashboards/todo-list_card_shopping-list.png
new file mode 100644
index 000000000000..041014783b76
Binary files /dev/null and b/source/images/dashboards/todo-list_card_shopping-list.png differ
diff --git a/source/images/docs/authentication/profile.png b/source/images/docs/authentication/profile.png
index a6b88e17cbc7..deac23c20c79 100644
Binary files a/source/images/docs/authentication/profile.png and b/source/images/docs/authentication/profile.png differ
diff --git a/source/images/docs/configuration/config-yaml_via-file-editor.png b/source/images/docs/configuration/config-yaml_via-file-editor.png
new file mode 100644
index 000000000000..4591106da7d5
Binary files /dev/null and b/source/images/docs/configuration/config-yaml_via-file-editor.png differ
diff --git a/source/images/docs/configuration/config-yaml_via-vscode.png b/source/images/docs/configuration/config-yaml_via-vscode.png
new file mode 100644
index 000000000000..cf85a40a014d
Binary files /dev/null and b/source/images/docs/configuration/config-yaml_via-vscode.png differ
diff --git a/source/images/docs/configuration/coordinates-defined-in-yaml.png b/source/images/docs/configuration/coordinates-defined-in-yaml.png
new file mode 100644
index 000000000000..f0dbffe8a578
Binary files /dev/null and b/source/images/docs/configuration/coordinates-defined-in-yaml.png differ
diff --git a/source/images/docs/configuration/customizing-entity-dialog.png b/source/images/docs/configuration/customizing-entity-dialog.png
index 0526735d7c82..5dda10ee232e 100644
Binary files a/source/images/docs/configuration/customizing-entity-dialog.png and b/source/images/docs/configuration/customizing-entity-dialog.png differ
diff --git a/source/images/docs/configuration/customizing-entity.png b/source/images/docs/configuration/customizing-entity.png
index 85244081353d..e1ccaa269cce 100644
Binary files a/source/images/docs/configuration/customizing-entity.png and b/source/images/docs/configuration/customizing-entity.png differ
diff --git a/source/images/docs/configuration/edit_entity-id_in_automation.png b/source/images/docs/configuration/edit_entity-id_in_automation.png
new file mode 100644
index 000000000000..1b20b856cf9e
Binary files /dev/null and b/source/images/docs/configuration/edit_entity-id_in_automation.png differ
diff --git a/source/images/docs/configuration/general-settings-stored-in-config-yaml.png b/source/images/docs/configuration/general-settings-stored-in-config-yaml.png
new file mode 100644
index 000000000000..f3c5eee1c51c
Binary files /dev/null and b/source/images/docs/configuration/general-settings-stored-in-config-yaml.png differ
diff --git a/source/images/docs/configuration/general-settings.png b/source/images/docs/configuration/general-settings.png
new file mode 100644
index 000000000000..ed0a5fd75f42
Binary files /dev/null and b/source/images/docs/configuration/general-settings.png differ
diff --git a/source/images/docs/configuration/reload_restart.png b/source/images/docs/configuration/reload_restart.png
new file mode 100644
index 000000000000..662ed31d2612
Binary files /dev/null and b/source/images/docs/configuration/reload_restart.png differ
diff --git a/source/images/docs/configuration/reloading_config.png b/source/images/docs/configuration/reloading_config.png
new file mode 100644
index 000000000000..11aba2afd900
Binary files /dev/null and b/source/images/docs/configuration/reloading_config.png differ
diff --git a/source/images/docs/configuration/settings_restart_ha.png b/source/images/docs/configuration/settings_restart_ha.png
new file mode 100644
index 000000000000..693773950c57
Binary files /dev/null and b/source/images/docs/configuration/settings_restart_ha.png differ
diff --git a/source/images/hassio/screenshots/ssh-upgrade.png b/source/images/hassio/screenshots/ssh-upgrade.png
deleted file mode 100644
index 64d80f9943b8..000000000000
Binary files a/source/images/hassio/screenshots/ssh-upgrade.png and /dev/null differ
diff --git a/source/images/integrations/matter/matter_android_connect_new.webp b/source/images/integrations/matter/matter_android_connect_new.webp
new file mode 100644
index 000000000000..154d6d0e80f2
Binary files /dev/null and b/source/images/integrations/matter/matter_android_connect_new.webp differ
diff --git a/source/images/integrations/matter/matter_share_from_apple.webp b/source/images/integrations/matter/matter_share_from_apple.webp
new file mode 100644
index 000000000000..3ddf4e294585
Binary files /dev/null and b/source/images/integrations/matter/matter_share_from_apple.webp differ
diff --git a/source/images/organizing/categories.png b/source/images/organizing/categories.png
new file mode 100644
index 000000000000..aab4aa74bf5c
Binary files /dev/null and b/source/images/organizing/categories.png differ
diff --git a/source/images/organizing/category_02.png b/source/images/organizing/category_02.png
new file mode 100644
index 000000000000..80bb66aa8453
Binary files /dev/null and b/source/images/organizing/category_02.png differ
diff --git a/source/images/organizing/create_area_01.png b/source/images/organizing/create_area_01.png
new file mode 100644
index 000000000000..f7a6748a53f3
Binary files /dev/null and b/source/images/organizing/create_area_01.png differ
diff --git a/source/images/organizing/create_floor_01.png b/source/images/organizing/create_floor_01.png
new file mode 100644
index 000000000000..32ac564f27c5
Binary files /dev/null and b/source/images/organizing/create_floor_01.png differ
diff --git a/source/images/organizing/create_floor_02.png b/source/images/organizing/create_floor_02.png
new file mode 100644
index 000000000000..63ccb7aef96e
Binary files /dev/null and b/source/images/organizing/create_floor_02.png differ
diff --git a/source/images/organizing/create_label_01.png b/source/images/organizing/create_label_01.png
new file mode 100644
index 000000000000..ccefd7712fa2
Binary files /dev/null and b/source/images/organizing/create_label_01.png differ
diff --git a/source/images/organizing/edit-delete-category.png b/source/images/organizing/edit-delete-category.png
new file mode 100644
index 000000000000..9de0b6111de1
Binary files /dev/null and b/source/images/organizing/edit-delete-category.png differ
diff --git a/source/images/organizing/enable_disable.png b/source/images/organizing/enable_disable.png
new file mode 100644
index 000000000000..ed4ed655f54a
Binary files /dev/null and b/source/images/organizing/enable_disable.png differ
diff --git a/source/images/organizing/filter-panel.png b/source/images/organizing/filter-panel.png
new file mode 100644
index 000000000000..67e69d67d942
Binary files /dev/null and b/source/images/organizing/filter-panel.png differ
diff --git a/source/images/organizing/filters_01.png b/source/images/organizing/filters_01.png
new file mode 100644
index 000000000000..952318d7e4e2
Binary files /dev/null and b/source/images/organizing/filters_01.png differ
diff --git a/source/images/organizing/floors.png b/source/images/organizing/floors.png
new file mode 100644
index 000000000000..749ceb77a667
Binary files /dev/null and b/source/images/organizing/floors.png differ
diff --git a/source/images/organizing/labels.png b/source/images/organizing/labels.png
new file mode 100644
index 000000000000..e6dd867ec0e5
Binary files /dev/null and b/source/images/organizing/labels.png differ
diff --git a/source/images/organizing/labels_add_05.png b/source/images/organizing/labels_add_05.png
new file mode 100644
index 000000000000..ba04319eaa26
Binary files /dev/null and b/source/images/organizing/labels_add_05.png differ
diff --git a/source/images/organizing/multiselect_01.png b/source/images/organizing/multiselect_01.png
new file mode 100644
index 000000000000..415c83778f23
Binary files /dev/null and b/source/images/organizing/multiselect_01.png differ
diff --git a/source/images/organizing/multiselect_icon.png b/source/images/organizing/multiselect_icon.png
new file mode 100644
index 000000000000..09497d7c6a7c
Binary files /dev/null and b/source/images/organizing/multiselect_icon.png differ
diff --git a/source/images/organizing/table_group_01.png b/source/images/organizing/table_group_01.png
new file mode 100644
index 000000000000..616be9ccd41f
Binary files /dev/null and b/source/images/organizing/table_group_01.png differ
diff --git a/source/images/screenshots/System_information.png b/source/images/screenshots/System_information.png
deleted file mode 100644
index bb35d602f277..000000000000
Binary files a/source/images/screenshots/System_information.png and /dev/null differ
diff --git a/source/images/screenshots/system_information.png b/source/images/screenshots/system_information.png
new file mode 100644
index 000000000000..d972ee831ca0
Binary files /dev/null and b/source/images/screenshots/system_information.png differ
diff --git a/source/index.html b/source/index.html
index 7d6cec1c915e..89ebda6e4e17 100644
--- a/source/index.html
+++ b/source/index.html
@@ -107,7 +107,7 @@ Ok Google, turn on the AC
+{% include common-tasks/enable_i2c.md %} \ No newline at end of file diff --git a/source/more-info/unsupported/systemd_journal.markdown b/source/more-info/unsupported/systemd_journal.markdown index 137d880ec35c..b53ed907949c 100644 --- a/source/more-info/unsupported/systemd_journal.markdown +++ b/source/more-info/unsupported/systemd_journal.markdown @@ -5,9 +5,9 @@ description: "More information on why systemd journal marks the installation as ## The issue -The Supervisor needs access to the systemd journal for logging features -such as the `/host/logs` API. These features don't work if the journal -is not accessible. +The Supervisor needs access to the systemd journal to access logs of +individual system components and add-ons. These logs are limited or +not available at all if the journal is not accessible. ## The solution diff --git a/source/more-info/unsupported/virtualization_image.markdown b/source/more-info/unsupported/virtualization_image.markdown new file mode 100644 index 000000000000..8a88c2cb81f5 --- /dev/null +++ b/source/more-info/unsupported/virtualization_image.markdown @@ -0,0 +1,18 @@ +--- +title: "Incorrect image for virtualization" +description: "More information on why virtualization image marks the installation as unsupported." +--- + +## The issue + +Your Home Assistant OS installation appears to run in a virtualized environment using +a disk image which is not meant to run in a virtualized environment. + +Home Assistant OS publishes specific images which support being run on a virtualized +system. These are optimized to run in virtual environments, e.g. have guest tools installed +and para-virtualization drivers enabled. + +## The solution + +You need to reinstall Home Assistant OS using an image which supports being run +on a virtualized system, [see instructions here](/installation/alternative). diff --git a/source/voice_control/about_wake_word.markdown b/source/voice_control/about_wake_word.markdown index 4a15afc98164..687faacc6f4a 100644 --- a/source/voice_control/about_wake_word.markdown +++ b/source/voice_control/about_wake_word.markdown @@ -1,5 +1,14 @@ --- title: "About wake words" +related: + - docs: /voice_control/thirteen-usd-voice-remote/ + title: Create a $13 voice assistant + - docs: /voice_control/install_wake_word_add_on/ + title: Enable wake words + - docs: /voice_control/create_wake_word/ + title: Create your own wake words + - docs: /voice_control/voice_remote_cloud_assistant/) + title: Create a cloud assistant --- Wake words are special words or phrases that tell a voice assistant that a command is about to be spoken. The device then switches from passive to active listening. Examples are: *Hey Google*, *Hey Siri*, or *Alexa*. Home Assistant supports its own wake words, such as *Hey Nabu*. @@ -101,13 +110,6 @@ Right now, there are two easy options to get started with wake words: - Follow the guide to the [$13 voice assistant][13-tutorial]. This tutorial is using the tiny ATOM Echo, detecting wake words with openWakeWord. - Follow the guide to set up an [ESP32-S3-BOX-3 voice assistant](/voice_control/s3_box_voice_assistant/). This tutorial is using the bigger S3-BOX-3 device which features a display. It can detect wake words using openWakeWord. But it can also do on-device wake word detection using microWakeWord. -## Related topics - -- [Create a $13 voice assistant](/voice_control/thirteen-usd-voice-remote/) -- [Enable wake words](/voice_control/install_wake_word_add_on/) -- [Create your own wake words](/voice_control/create_wake_word/) -- [Create a cloud assistant](/voice_control/voice_remote_cloud_assistant/) - [13-tutorial]: /voice_control/thirteen-usd-voice-remote/ [openWakeWord]: https://github.com/dscripka/openWakeWord [own-wake-word]: /voice_control/create_wake_word/ diff --git a/source/voice_control/aliases.markdown b/source/voice_control/aliases.markdown index 73d8bface7d8..813f430e2816 100644 --- a/source/voice_control/aliases.markdown +++ b/source/voice_control/aliases.markdown @@ -1,8 +1,15 @@ --- -title: "Assist - entity and area aliases" +title: "Assist - entity, area, and floor aliases" +related: + - docs: /docs/organizing/areas/ + title: Areas + - docs: /docs/organizing/floors/ + title: Floors + - docs: /voice_control/custom_sentences/ + title: Assist - custom sentences --- -Assist will use the names of your entities and areas, as well as any aliases you've configured. The configured aliases are not only used by Assist, but can also be used by Google Assistant, if you have set that up. +Assist will use the names of your entities, areas and floors, as well as any aliases you've configured. The configured aliases are not only used by Assist, but can also be used by Google Assistant, if you have set that up. These aliases are helpful in case you call the same device by multiple names or when using a voice assistant in multiple languages at the same time. @@ -18,7 +25,14 @@ There are multliple ways to add an alias of an entity: ## Adding an alias of an area -1. To add an alias for an area, go to **Settings** > **Areas & zones**. -2. Select the area of interest. -3. In the three-dot menu, select **Area settings**. -4. Select **Add alias** and enter the alias you want to use for that area. \ No newline at end of file +1. To add an alias for an area, go to **Settings** > **Areas, labels & zones**. +2. On the area card of interest, select the pencil button. +3. Select **Add alias** and enter the alias you want to use for that area. +4. **Save** your changes. + +## Adding an alias of a floor + +1. To add an alias for a floor, go to **Settings** > **Areas, labels & zones**. +2. Next to the floor of interest, select the three-dot menu, then select **Edit floor**. +3. Select **Add alias** and enter the alias you want to use for that floor. +4. **Save** your changes. diff --git a/source/voice_control/android.markdown b/source/voice_control/android.markdown index 5bf8e6753973..d5b7e7039eec 100644 --- a/source/voice_control/android.markdown +++ b/source/voice_control/android.markdown @@ -1,5 +1,12 @@ --- title: "Assist on Android" +related: + - docs: /voice_control/voice_remote_expose_devices/ + title: Exposing devices to Assist + - docs: /voice_control/start_assist_from_dashboard/ + title: Starting Assist from your dashboard + - url: https://companion.home-assistant.io/docs/getting_started/ + title: Home Assistant Companion App --- ## Assist on Android phones @@ -134,9 +141,3 @@ Depending on your watch, you can assign Assist to a button so that you can start  3. Now, use your key and speak a command. - -## Related topics - -- [Home Assistant Companion App](https://companion.home-assistant.io/docs/getting_started/) -- [Exposing devices to Assist](/voice_control/voice_remote_expose_devices/) -- [Starting Assist from your dashboard](/voice_control/start_assist_from_dashboard/) diff --git a/source/voice_control/assist_create_open_ai_personality.markdown b/source/voice_control/assist_create_open_ai_personality.markdown index 685e06f084b7..348392cc1616 100644 --- a/source/voice_control/assist_create_open_ai_personality.markdown +++ b/source/voice_control/assist_create_open_ai_personality.markdown @@ -1,5 +1,12 @@ --- title: "Create a personality with OpenAI" +related: + - docs: /voice_control/voice_remote_cloud_assistant/ + title: Cloud assistant pipeline + - docs: /voice_control/voice_remote_local_assistant/ + title: Local assistant pipeline + - url: https://www.nabucasa.com + title: Home Assistant Cloud --- You can give your voice assistant personality by using OpenAI. This requires an OpenAI account. For what we do in this tutorial, the free trial option is sufficient. No need to leave your credit card information. @@ -36,9 +43,3 @@ Using OpenAI requires an OpenAI account. For this tutorial, the free trial optio - Leave the other settings unchanged and select **Create**. 4. You can repeat this with other OpenAI personalities. You can add as many OpenAI Conversation integrations as you would like. - To add a new personality, you need to create a new API key. Then, add a new OpenAI Conversation integration with that API key. - -## Related topics - -- [Home Assistant Cloud](https://www.nabucasa.com) -- [Cloud assistant pipeline](/voice_control/voice_remote_cloud_assistant/) -- [Local assistant pipeline](/voice_control/voice_remote_local_assistant/) diff --git a/source/voice_control/assist_daily_summary.markdown b/source/voice_control/assist_daily_summary.markdown index 6a11c2036697..b63a6c20e1fa 100644 --- a/source/voice_control/assist_daily_summary.markdown +++ b/source/voice_control/assist_daily_summary.markdown @@ -1,5 +1,16 @@ --- title: "Daily summary by Assist" +related: + - docs: /voice_control/voice_remote_local_assistant/ + title: Local assistant pipeline + - docs: /integrations/local_calendar/ + title: Local calendar + - docs: /integrations/telegram/#setup-example + title: Telegram notification + - docs: /voice_control/assist_create_open_ai_personality/ + title: Telegram notification + - url: https://www.nabucasa.com + title: Home Assistant Cloud --- In this tutorial, we are creating an automation that has Assist send you a daily summary. Assist will tell you about the weather and your calendar events today. It will also send you the summary to your messenger. @@ -84,11 +95,3 @@ We are using a blueprint (courtesy of [@allenporter]) that polls calendar events - You should now receive a notification from Assist in your messenger app. [@allenporter]: https://github.com/allenporter - -## Related topics - -- [Home Assistant Cloud](https://www.nabucasa.com) -- [Local assistant pipeline](/voice_control/voice_remote_local_assistant/) -- [Local calendar](/integrations/local_calendar/) -- [Telegram notification](/integrations/telegram/#setup-example) -- [Create a Mario personality](/voice_control/assist_create_open_ai_personality/) \ No newline at end of file diff --git a/source/voice_control/builtin_sentences.markdown b/source/voice_control/builtin_sentences.markdown index 695115b9fad6..c7fc58551652 100644 --- a/source/voice_control/builtin_sentences.markdown +++ b/source/voice_control/builtin_sentences.markdown @@ -1,5 +1,20 @@ --- title: "Assist - default sentences" +related: + - docs: /voice_control/aliases/ + title: Create aliases + - docs: /voice_control/custom_sentences/ + title: Create your own sentences + - docs: /voice_control/troubleshooting/ + title: Sentence troubleshooting + - url: https://github.com/home-assistant/intents/tree/main/sentences + title: Built-in sentence definitions + - url: https://github.com/home-assistant/intents/tree/main/responses + title: Built-in response definitions + - url: https://developers.home-assistant.io/docs/voice/intent-recognition/template-sentence-syntax/ + title: Template sentence syntax documentation + - url: https://github.com/home-assistant/intents/tree/main/sentences + title: Sentence test cases --- Home Assistant comes with [built-in sentences](https://github.com/home-assistant/intents/tree/main/sentences) contributed by the community for [dozens of languages](https://developers.home-assistant.io/docs/voice/intent-recognition/supported-languages). @@ -103,12 +118,3 @@ The list of supported sentences is constantly being updated for each language. T 3. View the [sentence definition](https://github.com/home-assistant/intents/tree/main/sentences) for your language. 4. View the [response definition](https://github.com/home-assistant/intents/tree/main/responses) -## Related topics - -- [Create aliases](/voice_control/aliases/) -- [Create your own sentences](/voice_control/custom_sentences/) -- [Built-in sentence definitions](https://github.com/home-assistant/intents/tree/main/sentences) -- [Built-in response definitions](https://github.com/home-assistant/intents/tree/main/responses) -- [Template sentence syntax documentation](https://developers.home-assistant.io/docs/voice/intent-recognition/template-sentence-syntax/) -- [Sentence test cases](https://github.com/home-assistant/intents/tree/main/sentences) -- [Sentence troubleshooting](/voice_control/troubleshooting/) diff --git a/source/voice_control/create_wake_word.markdown b/source/voice_control/create_wake_word.markdown index 1655e89847aa..cd04b3bf05ae 100644 --- a/source/voice_control/create_wake_word.markdown +++ b/source/voice_control/create_wake_word.markdown @@ -1,5 +1,16 @@ --- title: "Create your own wake word" +related: + - docs: /voice_control/thirteen-usd-voice-remote/ + title: $13 voice assistant for Home Assistant + - docs: /voice_control/custom_sentences/ + title: Installing the Samba add-on + - docs: /voice_control/about_wake_word/ + title: About wake words + - url: https://colab.research.google.com/drive/1q1oe2zOyZp7UsB3jJiQ1IFn8z5YfjwEb?usp=sharing#scrollTo=1cbqBebHXjFD + title: Wake word training environment + - url: https://github.com/dscripka/openWakeWord + title: Wake word training environment --- You can now create your own wake word to use with Home Assistant. The procedure below will guide you to train a model. The model is trained using voice clips generated by our local neural text-to-speech system [Piper](https://github.com/rhasspy/piper). @@ -93,11 +104,3 @@ Things you can try if the execution is very slow: - Select the link to **Upgrade to Colab Pro**. - Select your price plan and follow the instructions on screen.  - -## Related topics - -- [$13 voice assistant for Home Assistant](/voice_control/thirteen-usd-voice-remote/) -- [Wake word training environment](https://colab.research.google.com/drive/1q1oe2zOyZp7UsB3jJiQ1IFn8z5YfjwEb?usp=sharing#scrollTo=1cbqBebHXjFD) -- [Installing the Samba add-on](/common-tasks/os/#configuring-access-to-files) -- [openWakeWord add-on](https://github.com/dscripka/openWakeWord) -- [About wake words](/voice_control/about_wake_word/) diff --git a/source/voice_control/custom_sentences.markdown b/source/voice_control/custom_sentences.markdown index 2b4755384460..e348a65b27b0 100644 --- a/source/voice_control/custom_sentences.markdown +++ b/source/voice_control/custom_sentences.markdown @@ -1,5 +1,16 @@ --- title: "Assist - custom sentences" +related: + - docs: /voice_control/aliases/ + title: Create aliases + - docs: /docs/scripts/#respond-to-a-conversation/ + title: Conversation response script action + - docs: /docs/automation/trigger/#sentence-trigger + title: Sentence triggers + - docs: /docs/automation/trigger/#sentence-wildcards + title: Sentence wildcards + - url: https://developers.home-assistant.io/docs/intent_builtin/ + title: View existing intents --- You may add your own sentences to the intent recognizer by either extending an [existing intent](https://developers.home-assistant.io/docs/intent_builtin/) or creating a new one. You may also [customize responses](#customizing-responses) for existing intents. @@ -165,15 +176,7 @@ responses: {% endraw %} -## Related topics - -- [View existing intents](https://developers.home-assistant.io/docs/intent_builtin/) -- [Create aliases](/voice_control/aliases/) -- [Conversation response script action](/docs/scripts/#respond-to-a-conversation) -- [Sentence triggers](/docs/automation/trigger/#sentence-trigger) -- [Sentence wildcards](/docs/automation/trigger/#sentence-wildcards) - -### Related devices and installation tutorials +## Related devices and installation tutorials - [$13 voice assistant for Home Assistant](/voice_control/thirteen-usd-voice-remote/) - [S3-BOX-3 voice assistant](/voice_control/s3_box_voice_assistant/) diff --git a/source/voice_control/index.markdown b/source/voice_control/index.markdown index 46de3a826fc3..fb41ac16f9e1 100644 --- a/source/voice_control/index.markdown +++ b/source/voice_control/index.markdown @@ -1,5 +1,24 @@ --- title: Assist - Talking to Home Assistant +related: + - docs: /voice_control/android + title: Assist on Android + - docs: /voice_control/android/#assist-on-wear-os + title: Assist on Wear OS + - docs: /voice_control/apple + title: Siri and Assist shortcuts + - docs: /voice_control/start_assist_from_dashboard/ + title: Assist dashboard button + - docs: /voice_control/thirteen-usd-voice-remote/ + title: Build a 13$ voice remote using an ESPHome device + - docs: /voice_control/install_wake_word_add_on + title: Enable a wake word + - docs: /voice_control/create_wake_word/ + title: Create your own wake words + - docs: /voice_control/builtin_sentences + title: Built-in sentences + - url: https://www.nabucasa.com/config/ + title: Home Assistant Cloud ---
@@ -62,15 +81,3 @@ Use the [built-in sentences](/voice_control/builtin_sentences) to control entiti
Did Assist not understand your sentence? [Contribute them](https://developers.home-assistant.io/docs/voice/intent-recognition/).
_Assist was introduced in Home Assistant 2023.2._
-
-## Related topics
-
-- [Home Assistant Cloud](https://www.nabucasa.com/config/)
-- [Assist on Android](/voice_control/android)
-- [Assist on Wear OS](/voice_control/android/#assist-on-wear-os)
-- [Siri and Assist shortcuts](/voice_control/apple)
-- [Assist dashboard button](/voice_control/start_assist_from_dashboard/)
-- [Build a 13$ voice remote using an ESPHome device](/voice_control/thirteen-usd-voice-remote/)
-- [Enable a wake word](/voice_control/install_wake_word_add_on)
-- [Create your own wake words](/voice_control/create_wake_word/)
-- [Built-in sentences](/voice_control/builtin_sentences)
diff --git a/source/voice_control/s3-box-customize.markdown b/source/voice_control/s3-box-customize.markdown
index a800d3c266db..d873af398cb2 100644
--- a/source/voice_control/s3-box-customize.markdown
+++ b/source/voice_control/s3-box-customize.markdown
@@ -2,6 +2,23 @@
title: "Customize the S3-BOX-3"
product_name: ESP32-S3-BOX-3
device_name_entry: ESP32-S3-BOX-3
+related:
+ - docs: /voice_control/voice_remote_cloud_assistant/
+ title: Home Assistant Cloud
+ - docs: /voice_control/voice_remote_local_assistant
+ title: Assist Pipeline
+ - docs: /voice_control/s3_box_voice_assistant/
+ title: ESP32-S3-BOX-3 voice assistant
+ - docs: /voice_control/troubleshooting/
+ title: General troubleshooting section for Assist
+ - docs: /voice_control/troubleshooting_the_s3_box/
+ title: Troubleshooting the ESP32-S3-BOX-3
+ - docs: /common-tasks/os/#configuring-access-to-files
+ title: Access to your configuration files
+ - url: https://github.com/jlpouffier/home-assistant-s3-box-community-illustrations/tree/main
+ title: Community image repository
+ - url: https://github.com/kahrendt/microWakeWord
+ title: microWakeWord
---
## Customize the S3-BOX-3 with your own illustrations
@@ -222,16 +239,5 @@ You can change the on-device wake word (microWakeWord) that is used on your S3-B
7. Now, speak a command to test the new setting. For example, *Hey Jarvis, turn on the light*.
-## Related topics
-
-- [Community image repository](https://github.com/jlpouffier/home-assistant-s3-box-community-illustrations/tree/main)
-- [Home Assistant Cloud](/voice_control/voice_remote_cloud_assistant/)
-- [Assist Pipeline](/voice_control/voice_remote_local_assistant)
-- [ESP32-S3-BOX-3 voice assistant](/voice_control/s3_box_voice_assistant/)
-- [General troubleshooting section for Assist](/voice_control/troubleshooting/)
-- [Troubleshooting the ESP32-S3-BOX-3](/voice_control/troubleshooting_the_s3_box/)
-- [Access to your configuration files](/common-tasks/os/#configuring-access-to-files)
-- [microWakeWord](https://github.com/kahrendt/microWakeWord)
-
[microWakeWord]: https://github.com/kahrendt/microWakeWord
[Kevin Ahrendt]: https://www.kevinahrendt.com/
\ No newline at end of file
diff --git a/source/voice_control/s3_box_voice_assistant.markdown b/source/voice_control/s3_box_voice_assistant.markdown
index 07865fb59307..9e76a272b29e 100644
--- a/source/voice_control/s3_box_voice_assistant.markdown
+++ b/source/voice_control/s3_box_voice_assistant.markdown
@@ -3,6 +3,17 @@ title: "ESP32-S3-BOX voice assistant"
product_name: ESP32-S3-BOX
device_name_entry: ESP32-S3-BOX
config_link: /voice_control/s3_box_voice_assistant/#to-delete-the-configuration-from-esphome
+related:
+ - docs: /voice_control/troubleshooting/
+ title: General troubleshooting section for Assist
+ - docs: /voice_control/troubleshooting_the_s3_box/
+ title: Troubleshooting the ESP32-S3-BOX-3
+ - docs: /common-tasks/os/#configuring-access-to-files
+ title: Access to your configuration files
+ - docs: /voice_control/s3-box-customize/#customizing-on-device-wake-words-microwakeword
+ title: Customizing the S3-BOX with on-device wake words
+ - url: https://esphome.io/projects/index.html
+ title: ESPHome projects page
---
This tutorial will guide you to turn an ESP32-S3-BOX, ESP32-S3-BOX-3, or an ESP32-S3-BOX-Light into a Home Assistant voice assistant. Note, the term ESP32-S3-BOX is used to refer to any of the 3 product variants.
@@ -84,11 +95,3 @@ Before you can use this device with Home Assistant, you need to install a bit of
- Disable **LCD Backlight**.
-
-## Related topics
-
-- [General troubleshooting section for Assist](/voice_control/troubleshooting/)
-- [Troubleshooting the ESP32-S3-BOX-3](/voice_control/troubleshooting_the_s3_box/)
-- [ESPHome projects page](https://esphome.io/projects/index.html)
-- [Access to your configuration files](/common-tasks/os/#configuring-access-to-files)
-- [Customizing the S3-BOX with on-device wake words](/voice_control/s3-box-customize/#customizing-on-device-wake-words-microwakeword)
diff --git a/source/voice_control/start_assist_from_dashboard.markdown b/source/voice_control/start_assist_from_dashboard.markdown
index ec79fbe26f2a..92db86f84426 100644
--- a/source/voice_control/start_assist_from_dashboard.markdown
+++ b/source/voice_control/start_assist_from_dashboard.markdown
@@ -1,5 +1,14 @@
---
title: "Starting Assist from your dashboard"
+related:
+ - docs: /voice_control/android/
+ title: Assist for Android
+ - docs: /voice_control/voice_remote_local_assistant/
+ title: Creating a local assistant
+ - docs: /voice_control/voice_remote_cloud_assistant/
+ title: Creating a Cloud assistant
+ - docs: /voice_control/voice_remote_expose_devices/
+ title: Exposing devices to Assist
---
If you are using Home Assistant in kiosk mode, for example if you have a tablet mounted on the wall, the Assist icon in the top right corner is not accessible. In this case, use a dashboard button to start Assist.
@@ -21,10 +30,3 @@ If you are using Home Assistant in kiosk mode, for example if you have a tablet
6. If you are using Assist with your voice, enable **Start listening**.
- If you don't want to use voice but just want to type, you do not need to enable listening.
7. **Save** your new button card.
-
-## Related topics
-
-- [Assist for Android](/voice_control/android/)
-- [Creating a local assistant](/voice_control/voice_remote_local_assistant/)
-- [Creating a Cloud assistant](/voice_control/voice_remote_cloud_assistant/)
-- [Exposing devices to Assist](/voice_control/voice_remote_expose_devices/)
diff --git a/source/voice_control/thirteen-usd-voice-remote.markdown b/source/voice_control/thirteen-usd-voice-remote.markdown
index 2d090c30a248..51dd02077192 100644
--- a/source/voice_control/thirteen-usd-voice-remote.markdown
+++ b/source/voice_control/thirteen-usd-voice-remote.markdown
@@ -3,6 +3,21 @@ title: "$13 voice assistant for Home Assistant"
product_name: ATOM Echo
device_name_entry: M5Stack Atom Echo a61920
config_link: /voice_control/thirteen-usd-voice-remote/#to-delete-the-atom-echo-configuration-from-esphome
+related:
+ - docs: /voice_control/install_wake_word_add_on/
+ title: Enable a wake word
+ - docs: /voice_control/create_wake_word/
+ title: Create your own wake words
+ - docs: /voice_control/voice_remote_cloud_assistant/
+ title: Creating a Cloud assistant
+ - docs: /voice_control/troubleshooting/
+ title: General troubleshooting section for Assist
+ - docs: /voice_control/voice_remote_local_assistant
+ title: Manually configured Assist pipeline
+ - docs: /voice_control/custom_sentences/
+ title: Using a sentence trigger
+ - docs: /common-tasks/os/#configuring-access-to-files
+ title: Access to your configuration files
---
This tutorial will guide you to turn an ATOM Echo into the
@@ -76,13 +91,3 @@ Before you can use this device with Home Assistant, you need to install a bit of
Are things not working as expected?
- Checkout the [general troubleshooting section for Assist](/voice_control/troubleshooting/).
-
-## Related topics
-
-- [Enable a wake word](/voice_control/install_wake_word_add_on/)
-- [Create your own wake words](/voice_control/create_wake_word/)
-- [General troubleshooting section for Assist](/voice_control/troubleshooting/)
-- [Access to your configuration files](/common-tasks/os/#configuring-access-to-files)
-- [Using a sentence trigger](/voice_control/custom_sentences/)
-- [Home Assistant Cloud](/voice_control/voice_remote_cloud_assistant/)
-- [Manually configured Assist pipeline](/voice_control/voice_remote_local_assistant)
diff --git a/source/voice_control/troubleshooting_the_s3_box.markdown b/source/voice_control/troubleshooting_the_s3_box.markdown
index 2c3b59e061f5..470be2efe391 100644
--- a/source/voice_control/troubleshooting_the_s3_box.markdown
+++ b/source/voice_control/troubleshooting_the_s3_box.markdown
@@ -1,5 +1,10 @@
---
title: "Troubleshooting the ESP32-S3-BOX-3"
+related:
+ - docs: /voice_control/s3_box_voice_assistant/
+ title: Creating a ESP32-S3-BOX-3 voice assistant
+ - url: https://esphome.io/projects/index.html
+ title: ESPHome projects website
---
This section provides troubleshooting steps for the ESP32-S3-BOX-3 by Espressif.
@@ -77,8 +82,3 @@ This message indicates that the device could connect to the Wi-Fi, but is unable
- Go to your router, find the IP address or hostname of your device, and enter it.
-
-## Related topics
-
-- [Creating a ESP32-S3-BOX-3 voice assistant](/voice_control/s3_box_voice_assistant/)
-- [ESPHome projects website](https://esphome.io/projects/index.html)
\ No newline at end of file
diff --git a/source/voice_control/voice_remote_cloud_assistant.markdown b/source/voice_control/voice_remote_cloud_assistant.markdown
index 8b3691e29cf1..0a5f4b76bf9e 100644
--- a/source/voice_control/voice_remote_cloud_assistant.markdown
+++ b/source/voice_control/voice_remote_cloud_assistant.markdown
@@ -1,5 +1,14 @@
---
title: "Creating a cloud Assist pipeline"
+related:
+ - docs: /voice_control/install_wake_word_add_on/
+ title: Enabling a wake word
+ - docs: /voice_control/create_wake_word/
+ title: Create your own wake word
+ - docs: /voice_control/voice_remote_cloud_assistant/
+ title: Creating a Cloud assistant
+ - docs: /voice_control/voice_remote_expose_devices/
+ title: Exposing devices to Assist
---
In Home Assistant, the Assist pipelines are made up of various components that together form a voice assistant.
@@ -42,10 +51,3 @@ To have the fastest processing voice assistant experience, follow these steps:
6. That's it. You can now speak to your device, and the device can answer in the language you defined.
7. If you haven't done so yet, [expose your devices to Assist](/voice_control/voice_remote_expose_devices/#exposing-your-devices).
- Otherwise you won't be able to control them by voice.
-
-## Related topics
-
-- [Enable Home Assistant Cloud](https://www.nabucasa.com/config/)
-- [Enabling a wake word](/voice_control/install_wake_word_add_on/)
-- [Create your own wake word](/voice_control/create_wake_word/)
-- [Expose your devices to Assist](/voice_control/voice_remote_expose_devices/#exposing-your-devices)
diff --git a/source/voice_control/voice_remote_expose_devices.markdown b/source/voice_control/voice_remote_expose_devices.markdown
index 41c7db07351e..30b9b3b38ffc 100644
--- a/source/voice_control/voice_remote_expose_devices.markdown
+++ b/source/voice_control/voice_remote_expose_devices.markdown
@@ -1,5 +1,10 @@
---
title: "Exposing devices"
+related:
+ - docs: /voice_control/voice_remote_cloud_assistant/
+ title: Creating a Cloud assistant
+ - docs: /voice_control/voice_remote_local_assistant/
+ title: Creating a local assistant
---
To be able to control your devices over a voice command, you must expose your entities to Assist.
@@ -13,9 +18,3 @@ This is to avoid that sensitive devices, such as locks and garage doors, can ina
3. Select **Expose entities**.
1. Select all entities you want to be able to control by voice.
-
-
-## Related topics
-
-- [Local assistant pipeline](/voice_control/voice_remote_local_assistant/)
-- [Cloud assistant pipeline](/voice_control/voice_remote_cloud_assistant/)
\ No newline at end of file
diff --git a/source/voice_control/voice_remote_local_assistant.markdown b/source/voice_control/voice_remote_local_assistant.markdown
index caadd0f74a42..8112568c8b26 100644
--- a/source/voice_control/voice_remote_local_assistant.markdown
+++ b/source/voice_control/voice_remote_local_assistant.markdown
@@ -1,5 +1,14 @@
---
title: "Installing a local Assist pipeline"
+related:
+ - docs: /voice_control/voice_remote_expose_devices/#exposing-your-devices
+ title: Expose your devices to Assist
+ - docs: /voice_control/create_wake_word/
+ title: Create your own wake words
+ - url: https://github.com/openai/whisper
+ title: Whisper for speech-to-text
+ - url: https://github.com/rhasspy/piper
+ title: Piper for text-to-speech
---
In Home Assistant, the Assist pipelines are made up of various components that together form a voice assistant.
@@ -69,9 +78,3 @@ View some of the options in the video below. Explained by Mike Hansen, creator o
The options are also documented in the add-on itself. Go to the {% my supervisor_addon addon="core_whisper" title="**Whisper**" %} or the {% my supervisor_addon addon="core_piper" title="**Piper**" %} add-on and open the **Documentation** page.
-## Related topics
-
-- [Create your own wake word](/voice_control/create_wake_word/)
-- [Expose your devices to Assist](/voice_control/voice_remote_expose_devices/#exposing-your-devices)
-- [Whisper for speech-to-text](https://github.com/openai/whisper)
-- [Piper for text-to-speech](https://github.com/rhasspy/piper)
diff --git a/source/voice_control/worlds-most-private-voice-assistant.markdown b/source/voice_control/worlds-most-private-voice-assistant.markdown
index ac77ccc0b669..a98b79de126f 100644
--- a/source/voice_control/worlds-most-private-voice-assistant.markdown
+++ b/source/voice_control/worlds-most-private-voice-assistant.markdown
@@ -1,5 +1,14 @@
---
title: "World's most private voice assistant"
+related:
+ - docs: /voice_control/voice_remote_cloud_assistant/
+ title: Creating a Cloud assistant
+ - docs: /voice_control/voice_remote_local_assistant/
+ title: Creating a local assistant
+ - url: https://amzn.to/40k7mRa
+ title: Grandstream HT801
+ - url: https://www.nabucasa.com
+ title: Home Assistant Cloud
---
This tutorial will guide you to turn your old landline phone into the
@@ -125,10 +134,3 @@ The phone shown in the video by TheFes is a *Heemaf type 1955*, which was used b
The phone used during creation of this tutorial is a 1953 [*Tischstation Mod.29 HF-TR* by Autophon AG](https://www.radiomuseum.org/r/autophon_tischstation_mod29_hf_tr.html).
-
-## Related topics
-
-- [Grandstream HT801](https://amzn.to/40k7mRa)
-- [Home Assistant Cloud](https://www.nabucasa.com)
-- [Cloud assistant pipeline](/voice_control/voice_remote_cloud_assistant/)
-- [Local assistant pipeline](/voice_control/voice_remote_local_assistant/)
\ No newline at end of file