-Screenshot of the Alarm Panel card.
+Screenshot of the alarm panel card.
-To add the Alarm Panel card to your user interface, click the menu (three dots at the top right of the screen) and then **Edit Dashboard**. Click the **Add Card** button in the bottom right corner and select from the card picker.
+{% include dashboard/edit_dashboard.md %}
All options for this card can be configured via the user interface.
-## YAML Configuration
+## YAML configuration
-The following YAML options are available when you use YAML mode or just prefer to use YAML in the Code Editor in the UI.
+The following YAML options are available when you use YAML mode or just prefer to use YAML in the code editor in the UI.
{% configuration %}
type:
@@ -66,7 +66,7 @@ entity: alarm_control_panel.alarm
-Screenshot of the Alarm Panel card.
+Screenshot of the alarm panel card.
Define the state list:
diff --git a/source/_dashboards/area.markdown b/source/_dashboards/area.markdown
index 2316dcb1a3c..6d9acaa9afc 100644
--- a/source/_dashboards/area.markdown
+++ b/source/_dashboards/area.markdown
@@ -1,18 +1,18 @@
---
type: card
-title: "Area Card"
+title: "Area card"
sidebar_label: Area
-description: "The Area card gives control of your entities in a specified area."
+description: "The area card gives control of your entities in a specified area."
---
-The Area card lets you control and monitor an individual area.
+The area card lets you control and monitor an individual area.
-
- Screenshot of the Area card.
+
+ Screenshot of the area card.
-To add the Area card to your user interface, click the menu (three dots at the top right of the screen) and then **Edit Dashboard**. Click the **Add Card** button in the bottom right corner and select from the card picker.
+{% include dashboard/edit_dashboard.md %}
All options for this card can be configured via the user interface.
@@ -20,9 +20,9 @@ Buttons will appear on the card for the entities in the area including fan, ligh
If a camera is added to the area you can show the camera feed instead of the area picture.
-## YAML Configuration
+## YAML configuration
-The following YAML options are available when you use YAML mode or just prefer to use YAML in the Code Editor in the UI.
+The following YAML options are available when you use YAML mode or just prefer to use YAML in the code editor in the UI.
{% configuration %}
type:
diff --git a/source/_dashboards/button.markdown b/source/_dashboards/button.markdown
index 45f1c66f3bd..88ce2c1eba7 100644
--- a/source/_dashboards/button.markdown
+++ b/source/_dashboards/button.markdown
@@ -1,22 +1,22 @@
---
type: card
-title: "Button Card"
+title: "Button card"
sidebar_label: Button
description: "The Button card allows you to add buttons to perform tasks."
---
-The Button card allows you to add buttons to perform tasks.
+The button card allows you to add buttons to perform tasks.
-
-Screenshot of three Button Cards.
+
+Screenshot of three button cards.
-To add the Button card to your user interface, click the menu (three dots at the top right of the screen) and then **Edit Dashboard**. Click the **Add Card** button in the bottom right corner and select from the card picker.
+{% include dashboard/edit_dashboard.md %}
All options for this card can be configured via the user interface.
-## Card Settings
+## Card settings
{% configuration_basic %}
Entity:
@@ -39,9 +39,9 @@ Hold Action:
description: The action taken on card tap and hold. For more information, see the [action documentation](/dashboards/actions/#hold-action).
{% endconfiguration_basic %}
-## YAML Configuration
+## YAML configuration
-The following YAML options are available when you use YAML mode or just prefer to use YAML in the Code Editor in the UI.
+The following YAML options are available when you use YAML mode or just prefer to use YAML in the code editor in the UI.
{% configuration %}
type:
@@ -119,7 +119,7 @@ type: button
entity: light.living_room
```
-Button Card with a button name and a script that runs when card is tapped:
+Button card with a button name and a script that runs when card is tapped:
```yaml
type: button
@@ -133,6 +133,6 @@ tap_action:
```
-
-Screenshot of the Button card with Script Service.
+
+Screenshot of the button card with script service.
diff --git a/source/_dashboards/calendar.markdown b/source/_dashboards/calendar.markdown
index e4ca202568d..18ae6b31661 100644
--- a/source/_dashboards/calendar.markdown
+++ b/source/_dashboards/calendar.markdown
@@ -1,23 +1,23 @@
---
type: card
-title: "Calendar Card"
+title: "Calendar card"
sidebar_label: Calendar
description: "The calendar card displays your calendar entities in a month, day and list view"
---
-The Calendar card displays your [calendar](/integrations/#calendar) entities in a month, day and list view (7 days).
+The calendar card displays your [calendar](/integrations/#calendar) entities in a month, day and list view (7 days).
- Screenshot of the Calendar card.
+ Screenshot of the calendar card.
-To add the Calendar card to your user interface, click the menu (three dots at the top right of the screen) and then **Edit Dashboard**. Click the **Add Card** button in the bottom right corner and select from the card picker.
+{% include dashboard/edit_dashboard.md %}
All options for this card can be configured via the user interface.
-## Card Settings
+## Card settings
{% configuration_basic %}
Title:
@@ -30,9 +30,9 @@ Theme:
description: Name of any loaded theme to be used for this card. For more information about themes, see the [frontend documentation](/integrations/frontend/).
{% endconfiguration_basic %}
-## YAML Configuration
+## YAML configuration
-The following YAML options are available when you use YAML mode or just prefer to use YAML in the Code Editor in the UI.
+The following YAML options are available when you use YAML mode or just prefer to use YAML in the code editor in the UI.
{% configuration %}
type:
diff --git a/source/_dashboards/conditional.markdown b/source/_dashboards/conditional.markdown
index d6349cd1e1e..ac25d30af4f 100644
--- a/source/_dashboards/conditional.markdown
+++ b/source/_dashboards/conditional.markdown
@@ -5,17 +5,18 @@ sidebar_label: Conditional
description: The Conditional card displays another card based on conditions.
---
-The Conditional card displays another card based on conditions.
+The conditional card displays another card based on conditions.
Note: if there are multiple conditions there will be treated as an 'and' condition. This means that for the card to show, _all_ conditions must be met.
-To add the Conditional card to your user interface, click the menu (three dots at the top right of the screen) and then **Edit Dashboard**. Click the **Add Card** button in the bottom right corner and select from the card picker. Note that while editing the dashboard, the card will always be shown, so be sure to exit editing mode to test the conditions.
+{% include dashboard/edit_dashboard.md %}
+Note that while editing the dashboard, the card will always be shown, so be sure to exit editing mode to test the conditions.
Most options for this card can be configured via the user interface.
-## YAML Configuration
+## YAML configuration
-The following YAML options are available when you use YAML mode or just prefer to use YAML in the Code Editor in the UI.
+The following YAML options are available when you use YAML mode or just prefer to use YAML in the code editor in the UI.
{% configuration %}
type:
@@ -95,7 +96,7 @@ state_not:
*one is required (`state` or `state_not`)
-### Numeric State
+### Numeric state
Tests if an entity state matches the thresholds.
diff --git a/source/_dashboards/entities.markdown b/source/_dashboards/entities.markdown
index 78085e5d088..69f74e67c5a 100644
--- a/source/_dashboards/entities.markdown
+++ b/source/_dashboards/entities.markdown
@@ -2,16 +2,16 @@
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."
+description: "The entities card is the most common type of card. It groups items together into lists."
---
-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.
+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.
-To add the Entities card to your user interface, click the menu (three dots at the top right of the screen) and then **Edit Dashboard**. Click the **Add Card** button in the bottom right corner and select from the card picker.
+{% include dashboard/edit_dashboard.md %}
-## YAML Configuration
+## YAML configuration
-The following YAML options are available when you use YAML mode or just prefer to use YAML in the Code Editor in the UI.
+The following YAML options are available when you use YAML mode or just prefer to use YAML in the code editor in the UI.
{% configuration %}
type:
@@ -54,7 +54,7 @@ footer:
type: map
{% endconfiguration %}
-## Options For Entities
+## Options for entities
If you define entities as objects instead of strings (by adding `entity:` before entity ID), you can add more customization and configuration.
@@ -110,9 +110,9 @@ double_tap_action:
type: map
{% endconfiguration %}
-## Special Row Elements
+## Special row elements
-Rather than only displaying an entity's state as a text output, the Entities card supports multiple special rows for buttons, attributes, web links, dividers and sections, etc.
+Rather than only displaying an entity's state as a text output, the entities card supports multiple special rows for buttons, attributes, web links, dividers and sections, etc.
### Attribute
diff --git a/source/_dashboards/entity-filter.markdown b/source/_dashboards/entity-filter.markdown
index 91e66b07afd..201e7067261 100644
--- a/source/_dashboards/entity-filter.markdown
+++ b/source/_dashboards/entity-filter.markdown
@@ -1,22 +1,22 @@
---
type: card
-title: "Entity Filter Card"
-sidebar_label: Entity Filter
-description: "The Entity Filter card allows you to define a list of entities that you want to track only when in a certain state. Very useful for showing lights that you forgot to turn off or show a list of people only when they're at home. "
+title: "Entity filter card"
+sidebar_label: Entity filter
+description: "The entity filter card allows you to define a list of entities that you want to track only when in a certain state. Very useful for showing lights that you forgot to turn off or show a list of people only when they're at home. "
---
-The Entity Filter card allows you to define a list of entities that you want to track only when in a certain state. Very useful for showing lights that you forgot to turn off or show a list of people only when they're at home.
+The entity filter card allows you to define a list of entities that you want to track only when in a certain state. Very useful for showing lights that you forgot to turn off or show a list of people only when they're at home.
-
-Screenshot of the Entity Filter card.
+
+Screenshot of the entity filter card.
This type of card can also be used together with other cards that allow multiple entities, allowing you to use [glance](/dashboards/glance/) or [picture-glance](/dashboards/picture-glance/). By default, it uses the [entities](/dashboards/entities/) card model.
-To add the Entity Filter card to your user interface, click the menu (three dots at the top right of the screen) and then **Edit Dashboard**. Click the **Add Card** button in the bottom right corner and select from the card picker.
+{% include dashboard/edit_dashboard.md %}
-## YAML Configuration
+## YAML configuration
This card can only be configured in YAML.
@@ -45,7 +45,7 @@ show_empty:
default: true
{% endconfiguration %}
-### Options For Entities
+### 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:
@@ -80,7 +80,7 @@ state_filter:
type: list
{% endconfiguration %}
-### Options For state_filter
+### Options for state filter
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:
diff --git a/source/_dashboards/entity.markdown b/source/_dashboards/entity.markdown
index 5125642d791..c095ded88c1 100644
--- a/source/_dashboards/entity.markdown
+++ b/source/_dashboards/entity.markdown
@@ -1,24 +1,24 @@
---
type: card
-title: "Entity Card"
+title: "Entity card"
sidebar_label: Entity
-description: "The Entity card gives you a quick overview of your entity's state"
+description: "The entity card gives you a quick overview of your entity's state"
---
-The Entity card gives you a quick overview of your entity's state.
+The entity card gives you a quick overview of your entity's state.
Screenshot of the Entity card.
-To add the Entity card to your user interface, click the menu (three dots at the top right of the screen) and then **Edit Dashboard**. Click the **Add Card** button in the bottom right corner and select from the card picker.
+{% include dashboard/edit_dashboard.md %}
All options for this card can be configured via the user interface.
-## YAML Configuration
+## YAML configuration
-The following YAML options are available when you use YAML mode or just prefer to use YAML in the Code Editor in the UI.
+The following YAML options are available when you use YAML mode or just prefer to use YAML in the code editor in the UI.
{% configuration %}
type:
diff --git a/source/_dashboards/gauge.markdown b/source/_dashboards/gauge.markdown
index 36078abad79..3a738f87fc8 100644
--- a/source/_dashboards/gauge.markdown
+++ b/source/_dashboards/gauge.markdown
@@ -2,28 +2,28 @@
type: card
title: "Gauge Card"
sidebar_label: Gauge
-description: "The Gauge card is a basic card that allows visually seeing sensor data."
+description: "The gauge card is a basic card that allows visually seeing sensor data."
---
-The Gauge card is a basic card that allows visually seeing sensor data.
+The gauge card is a basic card that allows visually seeing sensor data.
-Screenshot of the Gauge card.
+Screenshot of the gauge card.
-Screenshot of the Gauge card in needle mode.
+Screenshot of the gauge card in needle mode.
-To add the Gauge card to your user interface, click the menu (three dots at the top right of the screen) and then **Edit Dashboard**. Click the **Add Card** button in the bottom right corner and select from the card picker.
+{% include dashboard/edit_dashboard.md %}
All options for this card can be configured via the user interface.
-## YAML Configuration
+## YAML configuration
-The following YAML options are available when you use YAML mode or just prefer to use YAML in the Code Editor in the UI.
+The following YAML options are available when you use YAML mode or just prefer to use YAML in the code editor in the UI.
{% configuration %}
type:
diff --git a/source/_dashboards/glance.markdown b/source/_dashboards/glance.markdown
index 27f045b0060..77319525283 100644
--- a/source/_dashboards/glance.markdown
+++ b/source/_dashboards/glance.markdown
@@ -1,24 +1,24 @@
---
type: card
-title: "Glance Card"
+title: "Glance card"
sidebar_label: Glance
-description: "The Glance card is useful to group multiple sensors in a compact overview."
+description: "The glance card is useful to group multiple sensors in a compact overview."
---
-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.
+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.
-Screenshot of the Glance card.
+Screenshot of the glance card.
-To add the Glance card to your user interface, click the menu (three dots at the top right of the screen) and then **Edit Dashboard**. Click the **Add Card** button in the bottom right corner and select from the card picker.
+{% include dashboard/edit_dashboard.md %}
All options for this card can be configured via the user interface.
-## YAML Configuration
+## YAML configuration
-The following YAML options are available when you use YAML mode or just prefer to use YAML in the Code Editor in the UI.
+The following YAML options are available when you use YAML mode or just prefer to use YAML in the code editor in the UI.
{% configuration %}
type:
@@ -63,7 +63,7 @@ state_color:
default: true
{% endconfiguration %}
-### Options For Entities
+### Options for entities
If you define entities as objects instead of strings, you can add more customization and configuration:
@@ -108,7 +108,7 @@ double_tap_action:
type: map
{% endconfiguration %}
-### Options For Exemptions
+### Options for exemptions
{% configuration badges %}
user:
diff --git a/source/_dashboards/grid.markdown b/source/_dashboards/grid.markdown
index 9d4fd1c5286..bb0fee77676 100644
--- a/source/_dashboards/grid.markdown
+++ b/source/_dashboards/grid.markdown
@@ -1,24 +1,24 @@
---
type: card
-title: "Grid Card"
+title: "Grid card"
sidebar_label: Grid
-description: "The Grid card allows you to show multiple cards in a grid."
+description: "The grid card allows you to show multiple cards in a grid."
---
-The Grid card allows you to show multiple cards in a grid. It will first fill the columns, automatically adding new rows as needed.
+The grid card allows you to show multiple cards in a grid. It will first fill the columns, automatically adding new rows as needed.
- Screenshot of the Grid card.
+ Screenshot of the grid card.
-To add the Grid card to your user interface, click the menu (three dots at the top right of the screen) and then **Edit Dashboard**. Click the **Add Card** button in the bottom right corner and select from the card picker.
+{% include dashboard/edit_dashboard.md %}
All options for this card can be configured via the user interface.
-## YAML Configuration
+## YAML configuration
-The following YAML options are available when you use YAML mode or just prefer to use YAML in the Code Editor in the UI.
+The following YAML options are available when you use YAML mode or just prefer to use YAML in the code editor in the UI.
{% configuration %}
type:
diff --git a/source/_dashboards/history-graph.markdown b/source/_dashboards/history-graph.markdown
index e81cffc3099..924956d7cf2 100644
--- a/source/_dashboards/history-graph.markdown
+++ b/source/_dashboards/history-graph.markdown
@@ -1,29 +1,29 @@
---
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."
+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."
---
-The History Graph card allows you to display a graph for each of up to eight entities.
+The history graph card allows you to display a graph for each of up to eight entities.
-Screenshot of the History Graph card, when the sensor has no `unit_of_measurement` defined.
+Screenshot of the history graph card, when the sensor has no `unit_of_measurement` defined.
-Screenshot of the History Graph card, when the sensor has a `unit_of_measurement` defined.
+Screenshot of the history graph card, when the sensor has a `unit_of_measurement` defined.
-To add the History Graph card to your user interface, click the menu (three dots at the top right of the screen) and then **Edit Dashboard**. Click the **Add Card** button in the bottom right corner and select from the card picker.
+{% include dashboard/edit_dashboard.md %}
All options for this card can be configured via the user interface.
-## YAML Configuration
+## YAML configuration
-The following YAML options are available when you use YAML mode or just prefer to use YAML in the Code Editor in the UI.
+The following YAML options are available when you use YAML mode or just prefer to use YAML in the code editor in the UI.
{% configuration %}
type:
@@ -55,7 +55,7 @@ logarithmic_scale:
default: false
{% endconfiguration %}
-### Options For Entities
+### Options for entities
If you define entities as objects instead of strings, you can add more customization and configuration:
diff --git a/source/_dashboards/horizontal-stack.markdown b/source/_dashboards/horizontal-stack.markdown
index 348e5a845cf..ecf71a94c73 100644
--- a/source/_dashboards/horizontal-stack.markdown
+++ b/source/_dashboards/horizontal-stack.markdown
@@ -1,17 +1,17 @@
---
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."
+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."
---
-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.
+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.
-To add the Horizontal Stack card to your user interface, click the menu (three dots at the top right of the screen) and then **Edit Dashboard**. Click the **Add Card** button in the bottom right corner and select from the card picker.
+{% include dashboard/edit_dashboard.md %}
-## YAML Configuration
+## YAML configuration
-The following YAML options are available when you use YAML mode or just prefer to use YAML in the Code Editor in the UI.
+The following YAML options are available when you use YAML mode or just prefer to use YAML in the code editor in the UI.
{% configuration %}
type:
@@ -44,5 +44,5 @@ cards:
- Two Picture cards in a Horizontal Stack card.
+ Two picture cards in a horizontal stack card.
diff --git a/source/_dashboards/humidifier.markdown b/source/_dashboards/humidifier.markdown
index b56470935d6..3c8170af109 100644
--- a/source/_dashboards/humidifier.markdown
+++ b/source/_dashboards/humidifier.markdown
@@ -1,24 +1,24 @@
---
type: card
-title: "Humidifier 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."
+description: "The humidifier card gives control of your humidifier entity, allowing you to change the target humidity and mode of the entity."
---
-The Humidifier card lets you control and monitor humidifiers, dehumidifiers, and hygrostat devices.
+The humidifier card lets you control and monitor humidifiers, dehumidifiers, and hygrostat devices.
Screenshot of the humidifier card.
-To add the Humidifier card to your user interface, click the menu (three dots at the top right of the screen) and then **Edit Dashboard**. Click the **Add Card** button in the bottom right corner and select from the card picker.
+{% include dashboard/edit_dashboard.md %}
All options for this card can be configured via the user interface.
-## YAML Configuration
+## YAML configuration
-The following YAML options are available when you use YAML mode or just prefer to use YAML in the Code Editor in the UI.
+The following YAML options are available when you use YAML mode or just prefer to use YAML in the code editor in the UI.
{% configuration %}
type:
diff --git a/source/_dashboards/iframe.markdown b/source/_dashboards/iframe.markdown
index 60869ab9e99..fdaa049ed41 100644
--- a/source/_dashboards/iframe.markdown
+++ b/source/_dashboards/iframe.markdown
@@ -1,18 +1,18 @@
---
type: card
-title: "Webpage Card"
+title: "Webpage card"
sidebar_label: Webpage
-description: "The Webpage card allows you to embed your favorite webpage right into Home Assistant."
+description: "The webpage card allows you to embed your favorite webpage right into Home Assistant."
---
-The Webpage card allows you to embed your favorite webpage right into Home Assistant. You can also embed files stored in your `/www` folder and reference them using `/local/`.
+The webpage card allows you to embed your favorite webpage right into Home Assistant. You can also embed files stored in your `/www` folder and reference them using `/local/`.
- Windy weather radar as Webpage.
+ Windy weather radar as webpage.
-To add the Webpage card to your user interface, click the menu (three dots at the top right of the screen) and then **Edit Dashboard**. Click the **Add Card** button in the bottom right corner and select from the card picker.
+{% include dashboard/edit_dashboard.md %}
All options for this card can be configured via the user interface.
@@ -20,9 +20,9 @@ All options for this card can be configured via the user interface.
You can't embed sites using HTTP if you are using HTTPS for your Home Assistant.
-## YAML Configuration
+## YAML configuration
-The following YAML options are available when you use YAML mode or just prefer to use YAML in the Code Editor in the UI.
+The following YAML options are available when you use YAML mode or just prefer to use YAML in the code editor in the UI.
{% configuration %}
type:
@@ -53,6 +53,6 @@ title:
```yaml
type: iframe
-url: https://grafana.localhost/d/000000027/worldping-endpoint-summary?var-probe=All&panelId=2&fullscreen&orgId=3&theme=light
+url: https://www.home-assistant.io
aspect_ratio: 75%
```
diff --git a/source/_dashboards/light.markdown b/source/_dashboards/light.markdown
index 4cd5a824b25..f1cd3c965b5 100644
--- a/source/_dashboards/light.markdown
+++ b/source/_dashboards/light.markdown
@@ -1,24 +1,24 @@
---
type: card
-title: "Light Card"
+title: "Light card"
sidebar_label: Light
-description: "The Light card allows you to change the brightness of the light."
+description: "The light card allows you to change the brightness of the light."
---
-The Light card allows you to change the brightness of the light.
+The light card allows you to change the brightness of the light.
-Screenshot of the Light card.
+Screenshot of the light card.
-To add the Light card to your user interface, click the menu (three dots at the top right of the screen) and then **Edit Dashboard**. Click the **Add Card** button in the bottom right corner and select from the card picker.
+{% include dashboard/edit_dashboard.md %}
All options for this card can be configured via the user interface.
-## YAML Configuration
+## YAML configuration
-The following YAML options are available when you use YAML mode or just prefer to use YAML in the Code Editor in the UI.
+The following YAML options are available when you use YAML mode or just prefer to use YAML in the code editor in the UI.
{% configuration %}
type:
diff --git a/source/_dashboards/logbook.markdown b/source/_dashboards/logbook.markdown
index 2cb58f9b065..d4fdabb5c5e 100644
--- a/source/_dashboards/logbook.markdown
+++ b/source/_dashboards/logbook.markdown
@@ -1,20 +1,20 @@
---
type: card
-title: "Logbook Card"
+title: "Logbook card"
sidebar_label: Logbook
-description: "The Logbook card displays entries from the logbook for specific entities."
+description: "The logbook card displays entries from the logbook for specific entities."
---
-The Logbook card displays entries from the logbook for specific entities.
+The logbook card displays entries from the logbook for specific entities.
- Screenshot of the Logbook card.
+ Screenshot of the logbook card.
-To add the Logbook card to your user interface, click the menu (three dots at the top right of the screen) and then **Edit Dashboard**. Click the **Add Card** button in the bottom right corner and select from the card picker.
+{% include dashboard/edit_dashboard.md %}
-## Card Settings
+## Card settings
{% configuration_basic %}
Entities:
@@ -27,9 +27,9 @@ Theme:
description: Name of any loaded theme to be used for this card. For more information about themes, see the [frontend documentation](/integrations/frontend/).
{% endconfiguration_basic %}
-## YAML Configuration
+## YAML configuration
-The following YAML options are available when you use YAML mode or just prefer to use YAML in the Code Editor in the UI.
+The following YAML options are available when you use YAML mode or just prefer to use YAML in the code editor in the UI.
{% configuration %}
type:
diff --git a/source/_dashboards/map.markdown b/source/_dashboards/map.markdown
index 32557e1065e..203859950d3 100644
--- a/source/_dashboards/map.markdown
+++ b/source/_dashboards/map.markdown
@@ -1,24 +1,24 @@
---
type: card
-title: "Map Card"
+title: "Map card"
sidebar_label: Map
-description: "The Map card that allows you to display entities on a map"
+description: "The map card that allows you to display entities on a map"
---
-The Map card that allows you to display entities on a map
+The map card that allows you to display entities on a map
Screenshot of the map card.
-To add the Map card to your user interface, click the menu (three dots at the top right of the screen) and then **Edit Dashboard**. Click the **Add Card** button in the bottom right corner and select from the card picker.
+{% include dashboard/edit_dashboard.md %}
All options for this card can be configured via the user interface.
-## YAML Configuration
+## YAML configuration
-The following YAML options are available when you use YAML mode or just prefer to use YAML in the Code Editor in the UI.
+The following YAML options are available when you use YAML mode or just prefer to use YAML in the code editor in the UI.
{% configuration %}
type:
@@ -75,7 +75,7 @@ hours_to_show:
-## Options For Entities
+## Options for entities
If you define entities as objects instead of strings (by adding `entity:` before entity ID), you can add more customization and configuration.
diff --git a/source/_dashboards/markdown.markdown b/source/_dashboards/markdown.markdown
index 62ae632a637..f1886128004 100644
--- a/source/_dashboards/markdown.markdown
+++ b/source/_dashboards/markdown.markdown
@@ -1,6 +1,6 @@
---
type: card
-title: "Markdown Card"
+title: "Markdown card"
sidebar_label: Markdown
description: "The Markdown card is used to render Markdown"
---
@@ -14,11 +14,11 @@ Screenshot of the Markdown card.
The renderer uses [Marked.js](https://marked.js.org), which supports [several specifications of Markdown](https://marked.js.org/#specifications), including CommonMark, GitHub Flavored Markdown (GFM) and `markdown.pl`.
-To add the Markdown card to your user interface, click the menu (three dots at the top right of the screen) and then **Edit Dashboard**. Click the **Add Card** button in the bottom right corner and select from the card picker.
+{% include dashboard/edit_dashboard.md %}
-## YAML Configuration
+## YAML configuration
-The following YAML options are available when you use YAML mode or just prefer to use YAML in the Code Editor in the UI.
+The following YAML options are available when you use YAML mode or just prefer to use YAML in the code editor in the UI.
{% configuration %}
type:
diff --git a/source/_dashboards/masonry.markdown b/source/_dashboards/masonry.markdown
index 1f12a83e445..76615e5cd52 100644
--- a/source/_dashboards/masonry.markdown
+++ b/source/_dashboards/masonry.markdown
@@ -1,6 +1,6 @@
---
type: view
-title: Masonry View
+title: Masonry view
sidebar_label: Masonry (default)
description: "The default panel layout uses a masonry algorithme."
---
diff --git a/source/_dashboards/media-control.markdown b/source/_dashboards/media-control.markdown
index 0d20627e5f5..0ba077b45e7 100644
--- a/source/_dashboards/media-control.markdown
+++ b/source/_dashboards/media-control.markdown
@@ -1,22 +1,22 @@
---
type: card
-title: "Media Control Card"
-sidebar_label: Media Control
-description: "The Media Control card is used to display media player entities on an interface with easy to use controls."
+title: "Media control card"
+sidebar_label: Media control
+description: "The media control card is used to display media player entities on an interface with easy to use controls."
---
-The Media Control card is used to display [Media Player](/integrations/#media-player) entities on an interface with easy to use controls.
+The media control card is used to display [media player](/integrations/#media-player) entities on an interface with easy to use controls.
-Screenshot of the Media Control card.
+Screenshot of the media control card.
-To add the Media Control card to your user interface, click the menu (three dots at the top right of the screen) and then **Edit Dashboard**. Click the **Add Card** button in the bottom right corner and select from the card picker.
+{% include dashboard/edit_dashboard.md %}
-## YAML Configuration
+## YAML configuration
-The following YAML options are available when you use YAML mode or just prefer to use YAML in the Code Editor in the UI.
+The following YAML options are available when you use YAML mode or just prefer to use YAML in the code editor in the UI.
{% configuration %}
type:
diff --git a/source/_dashboards/panel.markdown b/source/_dashboards/panel.markdown
index 9eb981207fd..8cc91c122f0 100644
--- a/source/_dashboards/panel.markdown
+++ b/source/_dashboards/panel.markdown
@@ -1,11 +1,11 @@
---
type: view
-title: Panel View
+title: Panel view
sidebar_label: Panel
description: "The panel view shows a single card in the full width of the screen."
---
-The view must have exactly one card. This card is rendered full-width.
+The view must have exactly one card. This card is rendered full-width.
This view doesn't have support for badges.
diff --git a/source/_dashboards/picture-elements.markdown b/source/_dashboards/picture-elements.markdown
index d98b92152fb..b494e2810dc 100644
--- a/source/_dashboards/picture-elements.markdown
+++ b/source/_dashboards/picture-elements.markdown
@@ -1,11 +1,11 @@
---
type: card
-title: "Picture Elements Card"
-sidebar_label: Picture Elements
-description: "The Picture Elements card is one of the most versatile types of cards. The cards allow you to position icons or text and even services! On an image based on coordinates."
+title: "Picture elements card"
+sidebar_label: Picture elements
+description: "The picture elements card is one of the most versatile types of cards. The cards allow you to position icons or text and even services! On an image based on coordinates."
---
-The Picture Elements card is one of the most versatile types of cards.
+The picture elements card is one of the most versatile types of cards.
@@ -14,9 +14,9 @@ The Picture Elements card is one of the most versatile types of cards.
The cards allow you to position icons or text and even services on an image based on coordinates. Imagine floor plan, imagine [picture-glance](/dashboards/picture-glance/) with no restrictions!
-To add the Picture Elements card to your user interface, click the menu (three dots at the top right of the screen) and then **Edit Dashboard**. Click the **Add Card** button in the bottom right corner and select from the card picker.
+{% include dashboard/edit_dashboard.md %}
-## YAML Configuration
+## YAML configuration
This card can only be configured in YAML.
@@ -70,7 +70,7 @@ Elements are the active components (icons, badges, buttons, text, etc.) that ove
There are several different element types that can be added to a Picture Elements card:
-- [State Badge](#state-badge)
+- [State badge](#state-badge)
- [State Icon](#state-icon)
- [State Label](#state-label)
- [Service Call Button](#service-call-button)
@@ -79,7 +79,7 @@ There are several different element types that can be added to a Picture Element
- [Conditional](#conditional-element)
- [Custom](#custom-elements)
-### State Badge
+### State badge
This element creates a badge representing the state of an entity.
@@ -115,7 +115,7 @@ double_tap_action:
type: map
{% endconfiguration %}
-### State Icon
+### State icon
This element represents an entity state using an icon.
@@ -160,7 +160,7 @@ style:
default: "position: absolute, transform: translate(-50%, -50%)"
{% endconfiguration %}
-### State Label
+### State label
This element represents an entity's state via text.
@@ -208,7 +208,7 @@ style:
default: "position: absolute, transform: translate(-50%, -50%)"
{% endconfiguration %}
-### Service Call Button
+### Service call button
This entity creates a button (with arbitrary text) that can be used to call a service.
@@ -236,7 +236,7 @@ style:
default: "position: absolute, transform: translate(-50%, -50%)"
{% endconfiguration %}
-### Icon Element
+### Icon element
This element creates a static icon that is not linked to the state of an entity.
@@ -276,7 +276,7 @@ style:
default: "position: absolute, transform: translate(-50%, -50%)"
{% endconfiguration %}
-### Image Element
+### Image element
This creates an image element that overlays the background image.
@@ -342,7 +342,7 @@ style:
default: "position: absolute, transform: translate(-50%, -50%)"
{% endconfiguration %}
-### Conditional Element
+### Conditional element
Much like the Conditional card, this element will let you show its sub-elements based on entity states.
@@ -374,7 +374,7 @@ elements:
type: list
{% endconfiguration %}
-### Custom Elements
+### Custom elements
The process for creating and referencing custom elements is the same as for custom cards.
Please see the [developer documentation](https://developers.home-assistant.io/docs/frontend/custom-ui/custom-card)
@@ -392,7 +392,7 @@ style:
default: "position: absolute, transform: translate(-50%, -50%)"
{% endconfiguration %}
-## Options For Exemptions
+## Options for exemptions
{% configuration badges %}
user:
@@ -502,7 +502,7 @@ elements:
left: 10%
```
-### Images Example
+### Images example
```yaml
type: picture-elements
@@ -551,7 +551,7 @@ elements:
width: 5%
```
-### Conditional Example
+### Conditional example
```yaml
type: picture-elements
diff --git a/source/_dashboards/picture-entity.markdown b/source/_dashboards/picture-entity.markdown
index a3b2b9a6c54..e3f14b9eecc 100644
--- a/source/_dashboards/picture-entity.markdown
+++ b/source/_dashboards/picture-entity.markdown
@@ -1,22 +1,22 @@
---
type: card
-title: Picture Entity Card
-sidebar_label: Picture Entity
-description: The Picture Entity card displays an entity in the form of an image. Instead of images from URL, it can also show the picture of camera entities.
+title: Picture entity card
+sidebar_label: Picture entity
+description: The picture entity card displays an entity in the form of an image. Instead of images from URL, it can also show the picture of camera entities.
---
-The Picture Entity card displays an entity in the form of an image. Instead of images from URL, it can also show the picture of `camera` entities.
+The picture entity card displays an entity in the form of an image. Instead of images from URL, it can also show the picture of `camera` entities.
Background changes according to the entity state.
-To add the Picture Entity card to your user interface, click the menu (three dots at the top right of the screen) and then **Edit Dashboard**. Click the **Add Card** button in the bottom right corner and select from the card picker.
+{% include dashboard/edit_dashboard.md %}
-## YAML Configuration
+## YAML configuration
-The following YAML options are available when you use YAML mode or just prefer to use YAML in the Code Editor in the UI.
+The following YAML options are available when you use YAML mode or just prefer to use YAML in the code editor in the UI.
{% configuration %}
type:
diff --git a/source/_dashboards/picture-glance.markdown b/source/_dashboards/picture-glance.markdown
index 5f31ea3005a..c3a55842b14 100644
--- a/source/_dashboards/picture-glance.markdown
+++ b/source/_dashboards/picture-glance.markdown
@@ -1,22 +1,22 @@
---
type: card
-title: "Picture Glance Card"
-sidebar_label: Picture Glance
-description: "The Picture Glance card shows an image and corresponding entity states as an icon. The entities on the right side allow toggle actions, others show the more information dialog."
+title: "Picture glance card"
+sidebar_label: Picture glance
+description: "The picture glance card shows an image and corresponding entity states as an icon. The entities on the right side allow toggle actions, others show the more information dialog."
---
-The Picture Glance card shows an image and corresponding entity states as an icon. The entities on the right side allow toggle actions, others show the more information dialog.
+The picture glance card shows an image and lets you place small icons of entity states on top of that card to control those entities from there. In the image below: the entities on the right allow toggle actions, the others show the more information dialog.
Picture glance card for a living room.
-To add the Picture Glance card to your user interface, click the menu (three dots at the top right of the screen) and then **Edit Dashboard**. Click the **Add Card** button in the bottom right corner and select from the card picker.
+{% include dashboard/edit_dashboard.md %}
-## YAML Configuration
+## YAML configuration
-The following YAML options are available when you use YAML mode or just prefer to use YAML in the Code Editor in the UI.
+The following YAML options are available when you use YAML mode or just prefer to use YAML in the code editor in the UI.
{% configuration %}
type:
@@ -88,7 +88,7 @@ double_tap_action:
type: map
{% endconfiguration %}
-### Options For Entities
+### Options for entities
If you define entities as objects instead of strings, you can add more customization and configuration:
@@ -132,7 +132,7 @@ double_tap_action:
type: map
{% endconfiguration %}
-### Options For Exemptions
+### Options for exemptions
{% configuration badges %}
user:
@@ -154,6 +154,74 @@ entity: switch.decorative_lights
### Examples
+This section lists a few examples of how the picture glance card can be used.
+
+### Creating a card to control the camera
+
+If your camera supports PTZ (can be moved in different directions), you can use the picture glance card to control the camera.
+
+
+
+ Picture glance card to control the camera.
+
+
+1. Select your camera entity.
+ - **Image path** and **Image entity** are not required.
+ 
+2. If you want something to happen when you tap the card itself, define a tap action.
+ - Here, we toggle a light.
+ 
+3. Select the entities to move the camera left, right, up, or down.
+ 
+4. Select **Show code editor**.
+5. For each of the entities, specify an icon, as indicated in the YAML example.
+6. For the buttons to react on press (instead of bringing up the dialog):
+ - For each of the entities, under `tap_action`, call a `button.press` service.
+
+ ```yaml
+ camera_view: live
+ type: picture-glance
+ title: Desk
+ entities:
+ - entity: button.camera1_ptz_left
+ icon: mdi:pan-left
+ tap_action:
+ action: call-service
+ service: button.press
+ data:
+ entity_id: button.camera1_ptz_left
+ - entity: button.camera1_ptz_right
+ icon: mdi:pan-right
+ tap_action:
+ action: call-service
+ service: button.press
+ data:
+ entity_id: button.camera1_ptz_right
+ - entity: button.camera1_ptz_up
+ icon: mdi:pan-up
+ tap_action:
+ action: call-service
+ service: button.press
+ data:
+ entity_id: button.camera1_ptz_up
+ - entity: button.camera1_ptz_down
+ icon: mdi:pan-down
+ tap_action:
+ action: call-service
+ service: button.press
+ data:
+ entity_id: button.camera1_ptz_down
+ camera_image: camera.camera1_sub
+ tap_action:
+ action: call-service
+ service: light.toggle
+ target:
+ entity_id: light.philips_929003052501_01_huelight
+ ```
+7. That's it. You can now control your camera from the picture glance card on your dashboard.
+
+### More examples
+
```yaml
type: picture-glance
title: Living room
diff --git a/source/_dashboards/picture.markdown b/source/_dashboards/picture.markdown
index b7e84d23940..5a2fca27cc0 100644
--- a/source/_dashboards/picture.markdown
+++ b/source/_dashboards/picture.markdown
@@ -2,21 +2,21 @@
type: card
title: "Picture Card"
sidebar_label: Picture
-description: "The Picture card allows you to set an image to use for navigation to various paths in your interface or to call a service."
+description: "The picture card allows you to set an image to use for navigation to various paths in your interface or to call a service."
---
-The Picture card allows you to set an image to use for navigation to various paths in your interface or to call a service.
+The picture card allows you to set an image to use for navigation to various paths in your interface or to call a service.
Screenshot of the picture card.
-To add the Picture card to your user interface, click the menu (three dots at the top right of the screen) and then **Edit Dashboard**. Click the **Add Card** button in the bottom right corner and select from the card picker.
+{% include dashboard/edit_dashboard.md %}
-## YAML Configuration
+## YAML configuration
-The following YAML options are available when you use YAML mode or just prefer to use YAML in the Code Editor in the UI.
+The following YAML options are available when you use YAML mode or just prefer to use YAML in the code editor in the UI.
{% configuration %}
type:
diff --git a/source/_dashboards/plant-status.markdown b/source/_dashboards/plant-status.markdown
index f55c0820a13..031def93771 100644
--- a/source/_dashboards/plant-status.markdown
+++ b/source/_dashboards/plant-status.markdown
@@ -1,24 +1,24 @@
---
type: card
-title: "Plant Status Card"
-sidebar_label: Plant Status
-description: "The Plant Status card is for all the lovely botanists out there."
+title: "Plant status card"
+sidebar_label: Plant status
+description: "The plant status card is for all the lovely botanists out there."
---
-The Plant Status card is for all the lovely botanists out there.
+The plant status card is for all the lovely botanists out there.
Screenshot of the plant status card.
-To add the Plant Status card to your user interface, click the menu (three dots at the top right of the screen) and then **Edit Dashboard**. Click the **Add Card** button in the bottom right corner and select from the card picker.
+{% include dashboard/edit_dashboard.md %}
All options for this card can be configured via the user interface.
-## YAML Configuration
+## YAML configuration
-The following YAML options are available when you use YAML mode or just prefer to use YAML in the Code Editor in the UI.
+The following YAML options are available when you use YAML mode or just prefer to use YAML in the code editor in the UI.
{% configuration %}
type:
diff --git a/source/_dashboards/sensor.markdown b/source/_dashboards/sensor.markdown
index 6eb923fa775..5769fb7f787 100644
--- a/source/_dashboards/sensor.markdown
+++ b/source/_dashboards/sensor.markdown
@@ -1,24 +1,24 @@
---
type: card
-title: "Sensor 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."
+description: "The sensor card gives you a quick overview of your sensors state with an optional graph to visualize change over time."
---
-The Sensor card gives you a quick overview of your sensors state with an optional graph to visualize change over time.
+The sensor card gives you a quick overview of your sensors state with an optional graph to visualize change over time.
Screenshot of the sensor card.
-To add the Sensor card to your user interface, click the menu (three dots at the top right of the screen) and then **Edit Dashboard**. Click the **Add Card** button in the bottom right corner and select from the card picker.
+{% include dashboard/edit_dashboard.md %}
All options for this card can be configured via the user interface.
-## YAML Configuration
+## YAML configuration
-The following YAML options are available when you use YAML mode or just prefer to use YAML in the Code Editor in the UI.
+The following YAML options are available when you use YAML mode or just prefer to use YAML in the code editor in the UI.
{% configuration %}
type:
diff --git a/source/_dashboards/shopping-list.markdown b/source/_dashboards/shopping-list.markdown
index e6d5d7cd074..0c6e77eac83 100644
--- a/source/_dashboards/shopping-list.markdown
+++ b/source/_dashboards/shopping-list.markdown
@@ -1,26 +1,26 @@
---
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."
+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."
---
-The Shopping List card allows you to add, edit, check-off, and clear items from your shopping list.
+The shopping list card allows you to add, edit, check-off, and clear items from your shopping list.
-Screenshot of the Shopping List card.
+Screenshot of the shopping list card.
-Setup of the [Shopping List integration](/integrations/shopping_list/) is required.
+Setup of the [shopping list integration](/integrations/shopping_list/) is required.
-To add the Shopping List card to your user interface, click the menu (three dots at the top right of the screen) and then **Edit Dashboard**. Click the **Add Card** button in the bottom right corner and select from the card picker.
+{% include dashboard/edit_dashboard.md %}
All options for this card can be configured via the user interface.
-## YAML Configuration
+## YAML configuration
-The following YAML options are available when you use YAML mode or just prefer to use YAML in the Code Editor in the UI.
+The following YAML options are available when you use YAML mode or just prefer to use YAML in the code editor in the UI.
{% configuration %}
type:
@@ -43,5 +43,5 @@ Title Example:
```yaml
type: shopping-list
-title: Shopping List
+title: shopping list
```
diff --git a/source/_dashboards/sidebar.markdown b/source/_dashboards/sidebar.markdown
index 14ff2ab1205..bfa851b9392 100644
--- a/source/_dashboards/sidebar.markdown
+++ b/source/_dashboards/sidebar.markdown
@@ -1,6 +1,6 @@
---
type: view
-title: Sidebar View
+title: Sidebar view
sidebar_label: Sidebar
description: "The sidebar view has 2 columns, a wide one and a smaller one on the right."
---
diff --git a/source/_dashboards/statistic.markdown b/source/_dashboards/statistic.markdown
index 071486262b5..8e34f583fa9 100644
--- a/source/_dashboards/statistic.markdown
+++ b/source/_dashboards/statistic.markdown
@@ -1,11 +1,11 @@
---
type: card
-title: "Statistic Card"
+title: "Statistic card"
sidebar_label: Statistic
-description: "The Statistic card allows you to display a statistical value for an entity."
+description: "The statistic card allows you to display a statistical value for an entity."
---
-The Statistic card allows you to display a statistical value for an entity.
+The statistic card allows you to display a statistical value for an entity.
Statistics are gathered every 5 minutes for sensors that support it. It will either keep the `min`, `max` and `mean` of a sensors value for a specific period, or the `sum` for a metered entity.
@@ -16,7 +16,9 @@ If your sensor doesn't work with statistics, check [this](/more-info/statistics/
Screenshot of the statistic card for a temperature sensor.
-To add the Statistic card to your user interface, click the menu (three dots at the top right of the screen) and then **Edit Dashboard**. Click the "Add Card" button in the bottom right corner and select **Statistic** from the card picker. All options for this card can be configured via the user interface, but if you want more options for the period, you will have to define them in `yaml`.
+{% include dashboard/edit_dashboard.md %}
+
+All options for this card can be configured via the user interface, but if you want more options for the period, you will have to define them in `yaml`.
{% configuration %}
type:
@@ -72,7 +74,7 @@ period:
stat_type: change
```
-## Options For Period
+## Options for period
Periods can be configured in 3 different ways:
@@ -140,7 +142,7 @@ period:
stat_type: change
```
-### Rolling Window
+### Rolling window
{% configuration %}
duration:
diff --git a/source/_dashboards/statistics-graph.markdown b/source/_dashboards/statistics-graph.markdown
index 3ba392539b1..324fc602bf8 100644
--- a/source/_dashboards/statistics-graph.markdown
+++ b/source/_dashboards/statistics-graph.markdown
@@ -1,33 +1,33 @@
---
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."
+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."
---
-The Statistics Graph card allows you to display a graph of statistics data for each of the entities listed.
+The statistics graph card allows you to display a graph of statistics data for each of the entities listed.
-Screenshot of the Statistics Graph card with none metered entities and `chart_type` `line`.
+Screenshot of the statistics graph card with none metered entities and `chart_type` `line`.
-Screenshot of the Statistics Graph card with a metered entity and `chart_type` `bar`.
+Screenshot of the statistics graph card with a metered entity and `chart_type` `bar`.
Statistics are gathered every 5 minutes for sensors that support it. It will either keep the `min`, `max`, and `mean` of a sensor's value for a specific hour or the `sum` for a metered entity.
If your sensor doesn't work with statistics, check [this](/more-info/statistics/).
-To add the Statistics Graph card to your user interface, click the menu (three dots at the top right of the screen) and then **Edit Dashboard**. Click the **Add Card** button in the bottom right corner and select from the card picker.
+{% include dashboard/edit_dashboard.md %}
All options for this card can be configured via the user interface.
-## YAML Configuration
+## YAML configuration
-The following YAML options are available when you use YAML mode or just prefer to use YAML in the Code Editor in the UI.
+The following YAML options are available when you use YAML mode or just prefer to use YAML in the code editor in the UI.
{% configuration %}
type:
@@ -71,7 +71,7 @@ logarithmic_scale:
default: false
{% endconfiguration %}
-### Options For Entities
+### Options for entities
If you define entities as objects instead of strings, you can add more customization and configuration:
diff --git a/source/_dashboards/thermostat.markdown b/source/_dashboards/thermostat.markdown
index 8ec287f317c..896d647b5ae 100644
--- a/source/_dashboards/thermostat.markdown
+++ b/source/_dashboards/thermostat.markdown
@@ -1,24 +1,24 @@
---
type: card
-title: "Thermostat 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."
+description: "The thermostat card gives control of your climate entity, allowing you to change the temperature and mode of the entity."
---
-The Thermostat card gives control of your [climate](/integrations/#climate) entity, allowing you to change the temperature and mode of the entity.
+The thermostat card gives control of your [climate](/integrations/#climate) entity, allowing you to change the temperature and mode of the entity.
-
- Screenshot of the Thermostat card.
+
+ Screenshot of the thermostat card.
-To add the Thermostat card to your user interface, click the menu (three dots at the top right of the screen) and then **Edit Dashboard**. Click the **Add Card** button in the bottom right corner and select from the card picker.
+{% include dashboard/edit_dashboard.md %}
All options for this card can be configured via the user interface.
-## YAML Configuration
+## YAML configuration
-The following YAML options are available when you use YAML mode or just prefer to use YAML in the Code Editor in the UI.
+The following YAML options are available when you use YAML mode or just prefer to use YAML in the code editor in the UI.
{% configuration %}
type:
diff --git a/source/_dashboards/tile.markdown b/source/_dashboards/tile.markdown
index 88c19191ed7..bea57050072 100644
--- a/source/_dashboards/tile.markdown
+++ b/source/_dashboards/tile.markdown
@@ -1,6 +1,6 @@
---
type: card
-title: "Tile 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."
---
@@ -9,10 +9,10 @@ The tile card gives you a quick overview of your entity. The card allows you to
- Screenshot of Tile cards.
+ Screenshot of tile cards.
-To add the Tile card to your user interface, click the menu (three dots at the top right of the screen) and then **Edit Dashboard**. Click the "Add Card" button in the bottom right corner and select **Tile** from the card picker.
+{% include dashboard/edit_dashboard.md %}
{% configuration %}
type:
diff --git a/source/_dashboards/vertical-stack.markdown b/source/_dashboards/vertical-stack.markdown
index 4aedb13d089..0e13b9ce21e 100644
--- a/source/_dashboards/vertical-stack.markdown
+++ b/source/_dashboards/vertical-stack.markdown
@@ -1,17 +1,17 @@
---
type: card
-title: "Vertical Stack Card"
-sidebar_label: Vertical Stack
-description: "The Vertical Stack card allows you to group multiple cards so they always sit in the same column."
+title: "Vertical stack card"
+sidebar_label: Vertical stack
+description: "The vertical stack card allows you to group multiple cards so they always sit in the same column."
---
-The Vertical Stack card allows you to group multiple cards so they always sit in the same column.
+The vertical stack card allows you to group multiple cards so they always sit in the same column.
-To add the Vertical Stack card to your user interface, click the menu (three dots at the top right of the screen) and then **Edit Dashboard**. Click the **Add Card** button in the bottom right corner and select from the card picker.
+{% include dashboard/edit_dashboard.md %}
-## YAML Configuration
+## YAML configuration
-The following YAML options are available when you use YAML mode or just prefer to use YAML in the Code Editor in the UI.
+The following YAML options are available when you use YAML mode or just prefer to use YAML in the code editor in the UI.
{% configuration %}
type:
diff --git a/source/_dashboards/weather-forecast.markdown b/source/_dashboards/weather-forecast.markdown
index fe6a05a4709..5e6f3a4e198 100644
--- a/source/_dashboards/weather-forecast.markdown
+++ b/source/_dashboards/weather-forecast.markdown
@@ -1,20 +1,20 @@
---
type: card
-title: "Weather Forecast Card"
-sidebar_label: Weather Forecast
-description: "The Weather Forecast card displays the weather. Very useful to include on interfaces that people display on the wall."
+title: "Weather forecast card"
+sidebar_label: Weather forecast
+description: "The weather forecast card displays the weather. Very useful to include on interfaces that people display on the wall."
---
-The Weather Forecast card displays the weather. Very useful to include on interfaces that people display on the wall.
+The weather forecast card displays the weather. This card is particularly useful on wall-mounted displays.
- Screenshot of the Weather card.
+ Screenshot of the weather card.
-To add the Weather card to your user interface, click the menu (three dots at the top right of the screen) and then **Edit Dashboard**. Click the **Add Card** button in the bottom right corner and select from the card picker.
+{% include dashboard/edit_dashboard.md %}
-## Card Settings
+## Card settings
{% configuration_basic %}
Entity:
@@ -39,9 +39,9 @@ Theme:
-## YAML Configuration
+## YAML configuration
-The following YAML options are available when you use YAML mode or just prefer to use YAML in the Code Editor in the UI.
+The following YAML options are available when you use YAML mode or just prefer to use YAML in the code editor in the UI.
{% configuration %}
type:
@@ -102,7 +102,7 @@ forecast_type: daily
### Advanced
-#### Themeable Icons
+#### Themeable icons
The default weather icons are themable via a [theme](/integrations/frontend/#themes). Theme variables include:
@@ -123,7 +123,7 @@ Example theme configuration:
--weather-icon-rain-color: purple
```
-#### Personal Icons
+#### Personal icons
Weather icons can be overwritten with your own personal images via a [theme](/integrations/frontend/#themes). Theme variables include:
diff --git a/source/_data/glossary.yml b/source/_data/glossary.yml
index dbc5bc5e868..f492dab06ed 100644
--- a/source/_data/glossary.yml
+++ b/source/_data/glossary.yml
@@ -7,21 +7,16 @@
# - link: A URL to link to for more information (optional)
# - aliases: A list of aliases for the term (optional)
#
-
- term: Action
definition: |-
Actions are used in several places in Home Assistant. As part of a script or automation, actions define what is going to happen once a trigger is activated. In scripts, an action is called *sequence*.
-
Actions use service calls and/or scenes to interact with entities and cause these entities to do something. Actions can also include conditions and a delay. An action can call multiple services at the same time. For example, if your presence is detected in a room, an action may call one service to turn on a light and call another service to start playing music after a delay.
-
Actions are also used on the dashboard, for example as tap or hold action on a UI element. When triggered, the action calls a service.
-
aliases:
- actions
link: /docs/automation/action/
excerpt: >
Actions are used in several places in Home Assistant. As part of a script or automation, actions define what is going to happen once a trigger is activated. In scripts, an action is called *sequence*.
-
- term: Add-on
definition: >-
Add-ons are additional standalone third-party software packages that can be
@@ -31,7 +26,6 @@
excerpt: >
Add-ons are additional standalone third-party software packages that can be
installed on Home Assistant OS.
-
- term: Area
definition: >-
Locations within your home such as living room, dance floor, etc.
@@ -41,7 +35,6 @@
Places within your home such as rooms, spaces, etc.
aliases:
- areas
-
- term: Automation
definition: >-
Automations connect one or more triggers to one or more actions in a
@@ -56,7 +49,6 @@
link: /docs/automation/
aliases:
- automations
-
- term: Backup
definition: >-
Home Assistant has built-in functionality to create files containing a copy of
@@ -69,13 +61,11 @@
your configurations. This is available on certain installation types.
aliases:
- backups
-
- term: Binary sensor
definition: >-
A binary sensor returns information about things that only have two states -
such as on or off.
link: /integrations/binary_sensor
-
- term: Blueprint
definition: >-
A blueprint is a script or automation configuration with certain parts marked as configurable. This allows users to create multiple scripts or automations based on the same blueprint, with each having its own configuration-specific settings. Blueprints are shared by the community on the [blueprints exchange](https://community.home-assistant.io/c/blueprints-exchange/53) in the forum.
@@ -84,11 +74,9 @@
A blueprint is a script or automation configuration with certain parts marked as configurable. This allows users to create multiple scripts or automations based on the same blueprint, with each having its own configuration-specific settings.
aliases:
- blueprints
-
- term: Component
definition: >-
Better known as: Integrations. Integrations used to be known as components.
-
- term: Condition
definition: >-
Conditions are an optional part of an automation that will prevent an
@@ -96,44 +84,35 @@
link: /docs/scripts/conditions/
aliases:
- conditions
-
- term: Cover
definition: >-
Covers are devices such as blinds, garage doors, etc that can be opened
and closed and optionally set to a specific position.
link: /integrations/cover
-
- term: Customize
definition: >-
Customization allows you to overwrite the default parameters of your
devices in the configuration.
-
- term: Device
definition: |-
A device is a model representing a physical or logical unit that contains entities.
-
**Example for a device as a physical unit**
A smart plug named 'Coffee machine' which provides 2 entities: a `switch` entity to turn power on or off ('Coffee machine power switch') and a `sensor` entity for power monitoring ('Coffee machine power sensor').
-
**Example for a device as a logical unit**
An ecobee thermostat with 4 room sensors. This thermostat is seen as 5 devices in Home Assistant: 1 device for the thermostat with 4 sensors, and 1 device for each room sensor. Each device can be in a different area and may have more than one input or output within that area.
-
Devices have properties such as ID, manufacturer, name, model, hardware version, firmware version, connections, etc.
excerpt: >
A device is a model representing a physical or logical unit that contains entities.
aliases:
- devices
-
- term: Device tracker
definition: >-
Device trackers are used to track the presence, or location, of a device.
link: /integrations/device_tracker
-
- term: Discovery
definition: >
Discovery is the automatic setup of zeroconf/mDNS and uPnP devices after
they are discovered.
-
- term: Domain
definition: >-
Each integration in Home Assistant has a unique identifier:
@@ -147,60 +126,47 @@
excerpt: >
Each integration in Home Assistant has a unique identifier: The domain.
It is often shown as the first part (before the dot) of entity IDs.
-
- term: Entity
definition: |-
An entity represents a sensor, actor, or function in Home Assistant. Entities are used to monitor physical properties or to control other entities. An entity is usually part of a device or a service. Entities have states.
-
**Example for entities as part of a device**
A combined temperature and humidity sensor device provides two sensor entities. One for temperature (e.g. `sensor.temperature` with state `21.0` and unit `°C`) and one for humidity
(e.g. `sensor.humidity` with state `65.4` and unit `%`).
-
**Example for entities as part of a service**
A weather service that provides 3 entities: wind speed, air pressure, and ozon level.
-
**Example of an entity used for control**
A fan that is turned on when the temperature exceeds 30 °C.
-
There are standardized types of entities for common integrations such as light, switch, camera, sensor, fan, or vacuum.
-
Some entities are not part of a device or service. Examples of standalone entities are automation, script, scene entities, and helper entities (e.g. input helpers).
-
Most properties of entities are related to the state. Entities have optional attributes such as friendly name, unit of measurement, and an icon or picture that can be displayed in the frontend.
link: /docs/configuration/state_object/
excerpt: >
An entity represents a sensor, actor, or function in Home Assistant. Entities are used to monitor physical properties or to control other entities. An entity is usually part of a device or a service.
aliases:
- entities
-
- term: Event
definition: >-
An event is when something happens.
link: /docs/configuration/events/
aliases:
- events
-
- term: Frontend
definition: >-
The frontend is a necessary component for the UI, it is also where you
can define your themes.
link: /integrations/frontend/
-
- term: Group
definition: >-
Groups are a way to organize your entities into a single unit.
link: /integrations/group/
-
- term: HASS
definition: >-
HASS or [hass](/docs/tools/hass/) is often used as an abbreviation for
Home Assistant. It is also the command-line tool.
-
- term: HassOS
definition: >-
Another name for Home Assistant Operating System
link: /hassio/installation/
-
- term: Home Assistant Core
definition: >-
Home Assistant Core is a Python program. It can be run on various operating
@@ -211,7 +177,6 @@
excerpt: >
Home Assistant Core is the hart of Home Assistant itself. It is a Python
program that powers every installation type, but can be installed standalone.
-
- term: Home Assistant Supervised
definition: >-
Home Assistant Supervised is a full UI managed home automation ecosystem that
@@ -221,13 +186,11 @@
excerpt: >
Home Assistant Supervised is the full Home Assistant ecosystem, without the
Home Assistant Operating System.
-
- term: Home Assistant Supervisor
definition: >-
The Home Assistant Supervisor is a program that manages a Home Assistant
installation, taking care of installing and updating Home Assistant,
add-ons, itself and, if used, updating the Home Assistant Operating System.
-
- term: Home Assistant Operating System
definition: >-
Home Assistant OS, the Home Assistant Operating System, is an embedded,
@@ -238,74 +201,64 @@
excerpt: >
Home Assistant OS, the Home Assistant Operating System, is an embedded,
minimalistic, operating system designed to run the Home Assistant ecosystem.
-
- term: Host
definition: >-
A device that can communicate with other devices on a network. During setup and configuration,
an input requesting a **Host** typically refers to a device's network address so that
Home Assistant can attempt to connect to it. This may be in the form of a hostname, URL,
- IP address or some other type of network identifier.
+ IP address or some other type of network identifier. If you do not know the hostname or IP address of a device, you can find it in your router's webinterface. For example, if your device is connected wirelessly, somewhere there is a page listing all the devices that are connected to your network. It depends on your router, where exactly this page is. It could be under **Network** > **Wireless**.
excerpt: >-
- A device that can communicate with other devices on a network.
+ A device that participates in your network. If asked for the host, enter either the device's IP address or host name. If you don't know those, check the list of hosts in your router.
link: https://en.wikipedia.org/wiki/Host_(network)
aliases:
- hosts
-
- term: Integration
definition: >-
- Integrations connect and integrates Home Assistant with devices, services,
- and more. Such an integration contains all the logic that takes care of
- vendor- and device-specific implementations such as authentication or
- special protocols and brings those into Home Assistant in a standardized
+ Integrations connect and integrate Home Assistant with devices, services,
+ and more. They contain all the logic to handle
+ vendor- and device-specific implementations, such as authentication or
+ specific protocols. The integration brings such device-specific elements into Home Assistant in a standardized
way. For example, the [Hue](/integrations/hue) integration integrates
the Philips Hue bridge and its connected bulbs into Home Assistant, making
them available as Home Assistant light entities you can control.
excerpt: >
- Integrations connect and integrates Home Assistant with your devices,
+ Integrations connect and integrate Home Assistant with your devices,
services, and more.
link: /integrations/
aliases:
- integrations
-
- term: Intent
definition: >-
Intent is a term used with voice assistants. The intent is what Home Assistant thinks you want it to do when it extracts a command from your voice or text utterance. Currently, the following intents are supported out of the box: HassTurnOn, HassTurnOff, HassGetState, and HassLightSet.
-
These intents allow you to turn things on or off, inquire about a state, or change the brightness or color of a light.
excerpt: >
Intent is a term used with voice assistants. The intent is what Home Assistant thinks you want it to do when it extracts a command from your voice or text utterance.
link: https://developers.home-assistant.io/docs/intent_builtin
aliases:
- Intents
-
- term: Lovelace
definition: >-
Lovelace is the original code name of the UI that is now known as
[Home Assistant dashboards](/dashboards).
-
- term: Light
definition: >-
A light has a brightness you can control, and optionally color temperature
or RGB color control.
link: /integrations/light
-
- term: Matter
definition: >-
Matter is an open-source standard that defines how to control smart home devices on a Wi-Fi or Thread network. The aim of the standard is to improve security and to make devices interoperable across vendors, replacing proprietary protocols for smart home ecosystems. Unlike other standards, Matter allows joining the same device to multiple controllers. For example, you can add a light to Google Home, Apple Home, and Home Assistant at the same time. A bridge device can be used to connect devices running on other smart home technologies such as Zigbee or Z-Wave.
excerpt: >
Matter is an open-source standard that defines how to control smart home devices on a Wi-Fi or Thread network.
link: /integrations/matter
-
- term: Notification
definition: >-
You can use notifications to send messages, pictures, and more, to devices.
link: /integrations/#notifications
-
- term: Packages
definition: >
Packages allow you to bundle different component configurations together.
link: /docs/configuration/packages/
-
- term: Platform
definition: >-
Platforms are building blocks provided by some integrations to be used by
@@ -317,7 +270,6 @@
Platforms are building blocks provided by some integrations to be used by
other integrations.
link: /docs/configuration/platform_options/
-
- term: Reload
definition: >-
Applies the changes made to the Home Assistant configuration files. Changes
@@ -331,13 +283,14 @@
Applies the changes made to Home Assistant configuration files. Changes are normally
automatically updated. However, changes made outside of the front
end will not be reflected in Home Assistant and require a reload.
-
- term: Scene
definition: >-
Scenes capture the states you want certain entities to be. For example,
a scene can specify that light A should be turned on and light B should
be bright red.
link: /integrations/scene/
+ aliases:
+ - scenes
- term: Script
definition: >
@@ -346,7 +299,6 @@
link: /docs/scripts/
aliases:
- scripts
-
- term: Sensor
definition: >-
Sensors return information about a thing, for instance the level of water
@@ -354,7 +306,6 @@
link: /integrations/sensor/
aliases:
- sensors
-
- term: Selectors
definition: >-
Selectors are components for the user interface. Some selectors can,
@@ -365,21 +316,15 @@
Selectors are components for the user interface. Like toggle, dropdown,
and more.
link: /docs/blueprint/selectors/
-
- term: Service
definition: |-
The term service has 2 meanings in Home Assistant:
-
**The information service**
For example, the municipal waste management service that provides entities for organic, paper, and packaging waste. In terms of functionality, the information service is like a device. It is called *service* to avoid confusion, as it does not come with a piece of hardware.
-
**The software function that interacts with targets to make something happen**
A service carries out one specific task, for example: turning on the light in the living room or sending a notification to a mobile phone.
-
A service has targets and data. Service targets are: areas, devices, and entities. Service data carries the information required to define the desired state change in the target. For example, the target, together with brightness 150 and RGB color `[255,0,0]`, or the message “Your coffee is ready”.
-
Services can be used in, for example, automation, scripts, dashboards, or voice commands to control your home.
-
Home Assistant provides a series of predefined services, such as `homeassistant.turn_on`, `homeassistant.toggle`, or `homeassistant.reload`.
excerpt: >
A service carries out one specific task, for example: turn on the light in the
@@ -388,58 +333,56 @@
link: /docs/scripts/service-calls/
aliases:
- services
-
- term: State
definition: |-
The state holds the information of interest of an entity. For example, if a light is on or off, the current temperature, or the amount of energy used. The data type of state is `string` (a textual value). Entities store 2 timestamps related to the state: `last_updated` and `last_changed`. Each entity has exactly one state and the state only holds one value at a time. However, entities can store attributes related to that state. For example, the state of a light is _on_, and the related state attributes could be its current brightness and color values.
-
State changes can be used as the source of triggers. The current state can be used in conditions.
link: /docs/configuration/state_object/
+ aliases:
+ - states
excerpt: >
The state holds the information of interest of an entity, for example, if a light is on or off. Each entity has exactly one state and the state only holds one value at a time. However, entities can store attributes related to that state such as brightness, color, or a unit of measurement.
-
- term: Switch
definition: >-
Switches are things that have two states you can select between, such as
turning on or off a socket.
link: /integrations/switch/
-
- term: Template
definition: >-
A template is an automation definition that can include variables for the
service or data from the trigger values. This allows automations to generate
dynamic actions.
link: /docs/automation/templating/
+ aliases:
+ - templates
- term: Thread
definition: >-
Thread is a low-power mesh networking standard that is specifically designed for smart home applications. It is a protocol that defines how devices communicate. *Mesh* topology means that the devices can communicate with each other directly, without going through a central controller first. Thread uses the same radio frequency (RF) technology as Zigbee, but provides IP connectivity similar to Wi-Fi. Unlike Zigbee, Thread does not specify how to control devices. How Thread-enabled devices are controlled is specified in a higher level protocol such as HomeKit or Matter.
-
link: /integrations/thread/
excerpt: >
Thread is a low-power mesh networking standard that is specifically designed for smart home applications. It is a protocol that defines how devices communicate.
-
- term: Trigger
definition: >-
A trigger is a set of values or conditions of a platform that are defined
to cause an automation to run.
link: /docs/automation/trigger/
+ aliases:
+ - triggers
- term: TTS
definition: >-
TTS (text-to-speech) allows Home Assistant to talk to you.
link: /integrations/tts/
-
- term: Variables
definition: >-
Variables are used to store values in memory that can be processed
for example, in a script.
link: /docs/scripts/#variables
-
- term: Zone
definition: >-
Zones are areas that can be used for presence detection.
link: /integrations/zone/
aliases:
- - zones
+ - zones
\ No newline at end of file
diff --git a/source/_docs/asterisk_mbox.markdown b/source/_docs/asterisk_mbox.markdown
index 058d006a549..b5ed08059c5 100644
--- a/source/_docs/asterisk_mbox.markdown
+++ b/source/_docs/asterisk_mbox.markdown
@@ -1,5 +1,5 @@
---
-title: "Asterisk Voicemail Server Installation"
+title: "Asterisk Voicemail server installation"
description: "Instructions on how to integrate your existing Asterisk voicemail within Home Assistant."
---
diff --git a/source/_docs/authentication.markdown b/source/_docs/authentication.markdown
index 29c92d64752..47e2212187d 100644
--- a/source/_docs/authentication.markdown
+++ b/source/_docs/authentication.markdown
@@ -24,7 +24,7 @@ For the moment, other user accounts will have the same access as the owner accou
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
+### 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.
@@ -46,7 +46,7 @@ As an extra level of security, you can turn on [multi-factor authentication](/do
## Other authentication techniques
-Home Assistant provides several ways to authenticate. See the [Auth Providers](/docs/authentication/providers/) section.
+Home Assistant provides several ways to authenticate. See the [Auth providers](/docs/authentication/providers/) section.
## Troubleshooting
@@ -105,9 +105,9 @@ Replace `12.34.56.78` with your Home Assistant's public IP address.
This will allow you to open Home Assistant at `http://homeassistant.home:8123/`
-### Stuck on Loading data
+### Stuck on loading data
-Some ad blocking software, such as Wipr, also blocks web sockets. If you're stuck on the Loading data screen, try disabling your ad blocker.
+Some ad blocking software, such as Wipr, also blocks WebSockets. If you're stuck on the Loading data screen, try disabling your ad blocker.
### Migrating from pre 0.77
diff --git a/source/_docs/authentication/providers.markdown b/source/_docs/authentication/providers.markdown
index 5bffe0867a1..f566a41d5b7 100644
--- a/source/_docs/authentication/providers.markdown
+++ b/source/_docs/authentication/providers.markdown
@@ -1,6 +1,6 @@
---
-title: "Authentication Providers"
-description: "Guide on configuring different auth providers."
+title: "Authentication providers"
+description: "Guide on configuring different authentication providers."
---
@@ -54,9 +54,9 @@ homeassistant:
If you don't specify any `auth_providers` section in the `configuration.yaml` file then this provider will be set up automatically.
-### Trusted Networks
+### Trusted networks
-The Trusted Networks auth provider defines a range of IP addresses for which no authentication will be required (also known as "allowlisting"). For example, you can allowlist your local network so you won't be prompted for a password if you access Home Assistant from inside your home.
+The trusted networks auth provider defines a range of IP addresses for which no authentication will be required (also known as "allowlisting"). For example, you can allowlist your local network so you won't be prompted for a password if you access Home Assistant from inside your home.
When you log in from one of these networks, you will be asked which user account to use and won't need to enter a password.
@@ -104,7 +104,7 @@ allow_bypass_login:
type: boolean
{% endconfiguration %}
-#### Trusted Users Examples
+#### Trusted users examples
```yaml
homeassistant:
@@ -132,7 +132,7 @@ In above example, if user try to access Home Assistant from 192.168.0.1, they wi
Specially, you can use `group: GROUP_ID` to assign all users in certain `user group` to be available to choose. Group and users can be mix and match.
-#### Skip Login Page Examples
+#### Skip login page examples
This is a feature to allow you to bring back some of the experience before the user system was implemented. You can directly jump to the main page if you are accessing from trusted networks, the `allow_bypass_login` is on, and you have ONLY ONE available user to choose from in the login form.
@@ -153,9 +153,9 @@ homeassistant:
Assuming you have only the owner created though onboarding process, no other users ever created. The above example configuration will allow you directly access Home Assistant main page if you access from your internal network (192.168.0.0/24) or from localhost (127.0.0.1). If you get a login abort error, then you can change to use Home Assistant Authentication Provider to login, if you access your Home Assistant instance from outside network.
-### Command Line
+### Command line
-The Command Line auth provider executes a configurable shell command to perform user authentication. Two environment variables, `username` and `password`, are passed to the command. Access is granted when the command exits successfully (with exit code 0).
+The command line auth provider executes a configurable shell command to perform user authentication. Two environment variables, `username` and `password`, are passed to the command. Access is granted when the command exits successfully (with exit code 0).
This provider can be used to integrate Home Assistant with arbitrary external authentication services, from plaintext databases over LDAP to RADIUS. A compatible script for LDAP authentication is [this one](https://github.com/bob1de/ldap-auth-sh), for instance. Please note, this will only work when using the Home Assistant Core installation type.
diff --git a/source/_docs/automation.markdown b/source/_docs/automation.markdown
index 1d1df61bd3c..89cdb96143d 100644
--- a/source/_docs/automation.markdown
+++ b/source/_docs/automation.markdown
@@ -3,7 +3,7 @@ title: "Automating Home Assistant"
description: "Steps to help you get automation setup in Home Assistant."
---
-Home Assistant contains information about all your devices and services. This information is available for the user in the dashboard and it can be used to trigger automations. And that's fun!
+Home Assistant contains information about all your {% term devices %} and {% term services %}. This information is available for the user in the dashboard and it can be used to trigger {% term automations %}. And that's fun!
Automations in Home Assistant allow you to automatically respond to things that happen. You can turn the lights on at sunset or pause the music when you receive a call.
diff --git a/source/_docs/automation/action.markdown b/source/_docs/automation/action.markdown
index d1ca5057684..70086ecb2ea 100644
--- a/source/_docs/automation/action.markdown
+++ b/source/_docs/automation/action.markdown
@@ -1,11 +1,11 @@
---
-title: "Automation Actions"
+title: "Automation actions"
description: "Automations result in action."
---
-The action of an automation rule is what is being executed when a rule fires. The action part follows the [script syntax](/docs/scripts/) which can be used to interact with anything via services or events. For services you can specify the entity_id that it should apply to and optional service parameters (to specify for example the brightness).
+The action of an automation rule is what is being executed when a rule fires. The action part follows the [script syntax](/docs/scripts/) which can be used to interact with anything via services or events. For {% term services %}, you can specify the entity_id that it should apply to and optional service parameters (to specify for example the brightness).
-You can also call the service to activate [a scene](/integrations/scene/) which will allow you to define how you want your devices to be and have Home Assistant call the right services.
+You can also call the {% term service %} to activate [a scene](/integrations/scene/) which will allow you to define how you want your devices to be and have Home Assistant call the right services.
{% raw %}
diff --git a/source/_docs/automation/basics.markdown b/source/_docs/automation/basics.markdown
index 3d8b4e346a9..2815c6340e7 100644
--- a/source/_docs/automation/basics.markdown
+++ b/source/_docs/automation/basics.markdown
@@ -1,5 +1,5 @@
---
-title: "Understanding Automations"
+title: "Understanding automations"
description: "A breakdown of what an automation consists of."
---
diff --git a/source/_docs/automation/condition.markdown b/source/_docs/automation/condition.markdown
index c993f3f705c..1ecb61056d9 100644
--- a/source/_docs/automation/condition.markdown
+++ b/source/_docs/automation/condition.markdown
@@ -1,9 +1,9 @@
---
-title: "Automation Conditions"
+title: "Automation conditions"
description: "Automations can test conditions when invoked."
---
-Conditions are an optional part of an automation rule. They can be used to prevent the automation's actions from being run. After a trigger occurred, all conditions will be checked. If any of them do not return true, the automation will stop executing. Conditions look very similar to triggers, but they are very different — a trigger will look at events happening in the system, while a condition only looks at how the system looks right now. A trigger can observe that a switch is being turned on. A condition can only see if a switch is currently on or off.
+Conditions are an optional part of an automation rule. They can be used to prevent the automation's actions from being run. After a {% term trigger %} occurred, all conditions will be checked. If any of them do not return true, the automation will stop executing. Conditions look very similar to triggers, but they are very different — a trigger will look at events happening in the system, while a condition only looks at how the system looks right now. A trigger can observe that a switch is being turned on. A condition can only see if a switch is currently on or off.
The available conditions for an automation are the same as for the script syntax so see that page for a [full list of available conditions](/docs/scripts/conditions/).
diff --git a/source/_docs/automation/editor.markdown b/source/_docs/automation/editor.markdown
index 1374db5b28c..3107691e192 100644
--- a/source/_docs/automation/editor.markdown
+++ b/source/_docs/automation/editor.markdown
@@ -1,5 +1,5 @@
---
-title: "Automation Editor"
+title: "Automation editor"
description: "Instructions on how to use the automation editor."
---
diff --git a/source/_docs/automation/modes.markdown b/source/_docs/automation/modes.markdown
index 7ae86536bc7..83fc69517a6 100644
--- a/source/_docs/automation/modes.markdown
+++ b/source/_docs/automation/modes.markdown
@@ -1,11 +1,11 @@
---
-title: "Automation Modes"
+title: "Automation modes"
description: "How to use and configure automation modes."
---
-An automation can be triggered while it is already running.
+An {% term automation %} can be triggered while it is already running.
-The automation's `mode` configuration option controls what happens when the automation is triggered while the actions are still running from a previous trigger.
+The automation's `mode` configuration option controls what happens when the automation is triggered while the {% term actions %} are still running from a previous {% term trigger %}.
Mode | Description
-|-
@@ -38,7 +38,7 @@ automation:
- delay: 300 # seconds (=5 minutes)
```
-## Example Queued
+## Example queued
Sometimes an automation is doing an action on a device that does not support multiple simultaneous actions. In such cases, a queue can be used. In that case, the automation will be executed once it's current invocation and queue are done.
diff --git a/source/_docs/automation/services.markdown b/source/_docs/automation/services.markdown
index 74e3f923de8..d19403fb49a 100644
--- a/source/_docs/automation/services.markdown
+++ b/source/_docs/automation/services.markdown
@@ -1,5 +1,5 @@
---
-title: "Automation Services"
+title: "Automation services"
description: "How to use the various automation services."
---
@@ -7,7 +7,7 @@ The automation integration has services to control automations, like turning aut
## Service {% my developer_call_service service="automation.turn_on" %}
-This service enables the automation's triggers.
+This service enables the automation's {% term triggers %}.
Service data attribute | Optional | Description
-|-|-
@@ -15,7 +15,7 @@ Service data attribute | Optional | Description
## Service {% my developer_call_service service="automation.turn_off" %}
-This service disables the automation's triggers, and optionally stops any currently active actions.
+This service disables the automation's {% term triggers %}, and optionally stops any currently active {% term actions %}.
Service data attribute | Optional | Description
-|-|-
@@ -32,7 +32,7 @@ Service data attribute | Optional | Description
## Service {% my developer_call_service service="automation.trigger" %}
-This service will trigger the action of an automation. By default it bypasses any conditions, though that can be changed via the `skip_condition` attribute.
+This service will trigger the {% term action %} of an {% term automation %}. By default it bypasses any conditions, though that can be changed via the `skip_condition` attribute.
Service data attribute | Optional | Description
-|-|-
diff --git a/source/_docs/automation/templating.markdown b/source/_docs/automation/templating.markdown
index dc2c2d77723..1035738024d 100644
--- a/source/_docs/automation/templating.markdown
+++ b/source/_docs/automation/templating.markdown
@@ -1,5 +1,5 @@
---
-title: "Automation Trigger Variables"
+title: "Automation trigger variables"
description: "List all available variables made available by triggers."
---
@@ -7,13 +7,13 @@ Automations support [templating](/docs/configuration/templating/) in the same wa
The template variable `this` is also available when evaluating any `trigger_variables` declared in the configuration.
-## Available this Data
+## Available `this` data
-The variable `this` is the [state object](/docs/configuration/state_object) of the automation at the moment of triggering the actions. State objects also contain context data which can be used to identify the user that caused a script or automation to execute. Note that `this` will not change while executing the actions.
+The variable `this` is the [state object](/docs/configuration/state_object) of the automation at the moment of triggering the actions. State objects also contain context data which can be used to identify the user that caused a {% term script %} or {% term automation %} to execute. Note that `this` will not change while executing the {% term actions %}.
-## Available Trigger Data
+## Available trigger data
-The variable `trigger` is an object that contains details about which trigger triggered the automation.
+The variable `trigger` is an object that contains details about which {% term trigger %} triggered the automation.
Templates can use the data to modify the actions performed by the automation or displayed in a message. For example, you could create an automation that multiple sensors can trigger and then use the sensor's location to specify a light to activate; or you could send a notification containing the friendly name of the sensor that triggered it.
@@ -78,9 +78,9 @@ These are the properties available for a [MQTT trigger](/docs/automation/trigger
| `trigger.payload_json` | Dictionary of the JSON parsed payload.
| `trigger.qos` | QOS of payload.
-### Numeric State
+### Numeric state
-These are the properties available for a [Numeric State trigger](/docs/automation/trigger/#numeric-state-trigger).
+These are the properties available for a [numeric state trigger](/docs/automation/trigger/#numeric-state-trigger).
| Template variable | Data |
| ---- | ---- |
@@ -146,18 +146,18 @@ These are the properties available for a [Time trigger](/docs/automation/trigger
| `trigger.platform` | Hardcoded: `time`
| `trigger.now` | DateTime object that triggered the time trigger.
-### Time Pattern
+### Time pattern
-These are the properties available for a [Time Pattern trigger](/docs/automation/trigger/#time-pattern-trigger).
+These are the properties available for a [time pattern trigger](/docs/automation/trigger/#time-pattern-trigger).
| Template variable | Data |
| ---- | ---- |
| `trigger.platform` | Hardcoded: `time_pattern`
| `trigger.now` | DateTime object that triggered the time_pattern trigger.
-### Persistent Notification
+### Persistent notification
-These properties are available for a [Persistent Notification trigger](/docs/automation/trigger/#persistent-notification-trigger).
+These properties are available for a [persistent notification trigger](/docs/automation/trigger/#persistent-notification-trigger).
| Template variable | Data |
| ---- | ---- |
diff --git a/source/_docs/automation/trigger.markdown b/source/_docs/automation/trigger.markdown
index 049bc8ca85e..e3ab87af23c 100644
--- a/source/_docs/automation/trigger.markdown
+++ b/source/_docs/automation/trigger.markdown
@@ -3,9 +3,9 @@ title: "Automation Trigger"
description: "All the different ways how automations can be triggered."
---
-Triggers are what starts the processing of an 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/).
+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/).
-An automation can be triggered by an event, a certain entity state, at a given time, and more. These can be specified directly or more flexible via templates. It is also possible to specify multiple triggers for one automation.
+An {% term automation %} can be triggered by an {% term event %}, a certain {% term entity %} {% term state %}, at a given time, and more. These can be specified directly or more flexible via templates. It is also possible to specify multiple triggers for one automation.
- [Trigger ID](#trigger-id)
- [Trigger variables](#trigger-variables)
@@ -33,7 +33,8 @@ An automation can be triggered by an event, a certain entity state, at a given t
All triggers can be assigned an optional `id`. If the ID is omitted, it will instead be set to the index of the trigger. The `id` can be referenced from [trigger conditions and actions](/docs/scripts/conditions/#trigger-condition). The `id` does not have to be unique for each trigger, and it can be used to group similar triggers for use later in the automation (i.e., several triggers of different types that should all turn some entity on).
-### Video Tutorial
+### Video tutorial
+
This video tutorial explains how trigger IDs work.
@@ -673,7 +674,7 @@ If for your use case this is undesired, you could consider using the automation
The time trigger is configured to fire once a day at a specific time, or at a specific time on a specific date. There are three allowed formats:
-### Time String
+### Time string
A string that represents a time to fire on each day. Can be specified as `HH:MM` or `HH:MM:SS`. If the seconds are not specified, `:00` will be used.
@@ -685,9 +686,9 @@ automation:
at: "15:32:00"
```
-### Input Datetime
+### Input datetime
-The Entity ID of an [Input Datetime](/integrations/input_datetime/).
+The entity ID of an [input datetime](/integrations/input_datetime/).
| has_date | has_time | Description |
| -------- | -------- | ---------------------------------------- |
@@ -740,7 +741,7 @@ automation:
entity_id: light.bedroom
```
-### Multiple Times
+### Multiple times
Multiple times can be provided in a list. Both formats can be intermixed.
@@ -939,7 +940,7 @@ The sentences matched by this trigger will be:
Punctuation and casing are ignored, so "It's PARTY TIME!!!" will also match.
-### Sentence Wildcards
+### Sentence wildcards
Adding one or more `{lists}` to your trigger sentences will capture any text at that point in the sentence. A `slots` object will be [available in the trigger data](/docs/automation/templating#sentence).
This allows you to match sentences with variable parts, such as album/artist names or a description of a picture.
@@ -971,7 +972,7 @@ automation:
event: sunset
```
-## Multiple Entity IDs for the same Trigger
+## Multiple entity IDs for the same trigger
It is possible to specify multiple entities for the same trigger. To do so add multiple entities using a nested list. The trigger will fire and start, processing your automation each time the trigger is true for any entity listed.
diff --git a/source/_docs/automation/troubleshooting.markdown b/source/_docs/automation/troubleshooting.markdown
index 7ade83555c9..a41825249f6 100644
--- a/source/_docs/automation/troubleshooting.markdown
+++ b/source/_docs/automation/troubleshooting.markdown
@@ -1,9 +1,9 @@
---
-title: "Troubleshooting Automations"
+title: "Troubleshooting automations"
description: "Tips on how to troubleshoot your automations."
---
-When an automation is run, all steps are recorded and a trace is made. From the UI choose **Settings** which is located in the sidebar, then click on **Automations & Scenes** to go to the automation editor or click this button directly: {% my automations badge %}
+When an {% term automation %} is run, all steps are recorded and a trace is made. From the UI, open **Settings**, which is located in the sidebar, then select **Automations & Scenes** to go to the automation editor or click this button directly: {% my automations badge %}
Click on the clock icon next to an automation to enter the debugging screen. Alternatively, click on **Show trace** directly from a Logbook automation entry.
diff --git a/source/_docs/automation/using_blueprints.markdown b/source/_docs/automation/using_blueprints.markdown
index a340040e4c5..6eb407f497f 100644
--- a/source/_docs/automation/using_blueprints.markdown
+++ b/source/_docs/automation/using_blueprints.markdown
@@ -3,7 +3,7 @@ title: "Using automation blueprints"
description: "How to create automations based off blueprints."
---
-Automation blueprints are pre-made automations that you can easily add to your Home Assistant instance. Each blueprint can be added as many times as you want.
+Automation blueprints are pre-made {% term automations %} that you can easily add to your Home Assistant instance. Each blueprint can be added as many times as you want.
Quick links:
@@ -11,7 +11,7 @@ Quick links:
## Blueprint automations
-Automations based on a blueprint need to be configured. What needs to be configured differs on each blueprint.
+Automations based on a blueprint need to be configured. What needs to be configured differs by blueprint.
1. To create your first automation based on a blueprint, go to **{% my blueprints title="Settings > Automations & Scenes > Blueprints" %}**.
2. Find the blueprint that you want to use and select **Create Automation**.
diff --git a/source/_docs/automation/yaml.markdown b/source/_docs/automation/yaml.markdown
index c56865cbb83..2484b3b20e5 100644
--- a/source/_docs/automation/yaml.markdown
+++ b/source/_docs/automation/yaml.markdown
@@ -3,7 +3,7 @@ title: "Automation YAML"
description: "How to use the automation integration with YAML."
---
-Automations are created in Home Assistant via the UI, but are stored in a YAML format. If you want to edit the YAML of an automation, select the automation, click on the menu button in the top right then on **Edit in YAML**.
+Automations are created in Home Assistant via the UI, but are stored in a YAML format. If you want to edit the YAML of an {% term automation %}, select the automation, click on the menu button in the top right then on **Edit in YAML**.
The UI will write your automations to `automations.yaml`. This file is managed by the UI and should not be edited manually.
@@ -70,7 +70,7 @@ trigger_variables:
description: "The value of the variable. Any YAML is valid. Only [limited templates](/docs/configuration/templating/#limited-templates) can be used."
type: any
mode:
- description: "Controls what happens when the automation is invoked while it is still running from one or more previous invocations. See [Automation Modes](#automation-modes)."
+ description: "Controls what happens when the automation is invoked while it is still running from one or more previous invocations. See [Automation modes](#automation-modes)."
required: false
type: string
default: single
@@ -112,7 +112,7 @@ action:
type: list
{% endconfiguration %}
-### Automation Modes
+### Automation modes
Mode | Description
-|-
@@ -126,8 +126,7 @@ Mode | Description
-
-## YAML Example
+## YAML example
Example of a YAML based automation that you can add to `configuration.yaml`.
@@ -262,9 +261,9 @@ If you want to migrate your manual automations to use the editor, you'll have to
{% endraw %}
-### Deleting Automations
+### Deleting automations
-When automations remain visible in the Home Assistant Dashboard, even after having deleted in the YAML file, you have to delete them in the UI.
+When automations remain visible in the Home Assistant dashboard, even after having deleted in the YAML file, you have to delete them in the UI.
To delete them completely, go to UI **{% my entities title="Settings -> Devices & Services -> Entities" %}** and find the automation in the search field or by scrolling down.
diff --git a/source/_docs/backend/database.markdown b/source/_docs/backend/database.markdown
index 70a564d3561..5e53c82ea3d 100644
--- a/source/_docs/backend/database.markdown
+++ b/source/_docs/backend/database.markdown
@@ -3,7 +3,7 @@ title: "Database"
description: "Details about the database used by Home Assistant."
---
-Home Assistant uses database to store events and parameters for history and tracking. The default database used is [SQLite](https://www.sqlite.org/) and the database file is stored in your [configuration directory](/getting-started/configuration/) (e.g., `/home-assistant_v2.db`); however, other databases can be used. If you prefer to run a database server (e.g., PostgreSQL), use the [`recorder` integration](/integrations/recorder/).
+Home Assistant uses databases to store {% term events %} and parameters for history and tracking. The default database used is [SQLite](https://www.sqlite.org/) and the database file is stored in your [configuration directory](/getting-started/configuration/) (e.g., `/home-assistant_v2.db`); however, other databases can be used. If you prefer to run a database server (e.g., PostgreSQL), use the [`recorder` integration](/integrations/recorder/).
To work with SQLite database manually from the command-line, you will need an [installation](https://www.sqlitetutorial.net/download-install-sqlite/) of `sqlite3`. Alternatively [DB Browser for SQLite](https://sqlitebrowser.org/) provides a viewer for exploring the database data and an editor for executing SQL commands.
First load your database with `sqlite3`:
diff --git a/source/_docs/blueprint.markdown b/source/_docs/blueprint.markdown
index e5609824622..c0e17ab7126 100644
--- a/source/_docs/blueprint.markdown
+++ b/source/_docs/blueprint.markdown
@@ -7,9 +7,9 @@ This section gives a high-level introduction to blueprints. To view a descriptio
## What is a blueprint?
-A blueprint is a script or automation configuration with certain parts marked as configurable. This allows you to create different scripts or automations based on the same blueprint.
+A blueprint is a {% term script %} or {% term automation %} configuration with certain parts marked as configurable. This allows you to create different scripts or automations based on the same blueprint.
-Imagine you want to control lights based on motion. A blueprint provides the generic automation framework, while letting you select one specific motion sensor as a trigger, and the exact light to control. This blueprint makes it possible to create two automations. Each automation has their own configuration and act completely independently. Yet, they share some basic automation configuration so that you do not have to set this up every time.
+Imagine you want to control lights based on motion. A blueprint provides the generic {% term automation %} framework, while letting you select one specific motion sensor as a {% term trigger %}, and the exact light to control. This blueprint makes it possible to create two automations. Each automation has their own configuration and act completely independently. Yet, they share some basic automation configuration so that you do not have to set this up every time.
Blueprints are shared by the community in the [blueprint community forum][blueprint-forums].
diff --git a/source/_docs/blueprint/selectors.markdown b/source/_docs/blueprint/selectors.markdown
index ec9a164213b..6d279623167 100644
--- a/source/_docs/blueprint/selectors.markdown
+++ b/source/_docs/blueprint/selectors.markdown
@@ -76,7 +76,7 @@ action:
The output of this selector is a list of actions. For example:
```yaml
-# Example Action selector output result
+# Example action selector output result
- service: scene.turn_on
target:
entity_id: scene.watching_movies
@@ -97,7 +97,7 @@ selected add-on.
This selector does not have any other options; therefore, it only has its key.
```yaml
-# Example Add-on selector
+# Example add-on selector
addon:
```
@@ -202,10 +202,10 @@ The output of this selector is the area ID, or (in case `multiple` is set to
`true`) a list of area IDs.
```yaml
-# Example Area selector output result, when multiple is set to false
+# Example area selector output result, when multiple is set to false
living_room
-# Example Area selector output result, when multiple is set to true
+# Example area selector output result, when multiple is set to true
- living_room
- kitchen
```
@@ -347,7 +347,7 @@ condition:
The output of this selector is a list of conditions. For example:
```yaml
-# Example Condition selector output result
+# Example condition selector output result
- condition: numeric_state
entity_id: "sensor.outside_temperature"
below: 20
@@ -568,10 +568,10 @@ The output of this selector is the device ID, or (in case `multiple` is set to
`true`) a list of devices IDs.
```yaml
-# Example Device selector output result, when multiple is set to false
+# Example device selector output result, when multiple is set to false
faadde5365842003e8ca55267fe9d1f4
-# Example Device selector output result, when multiple is set to true
+# Example device selector output result, when multiple is set to true
- faadde5365842003e8ca55267fe9d1f4
- 3da77cb054352848b9544d40e19de562
```
@@ -717,7 +717,7 @@ light.living_room
An example entity selector that, will only show entities that are:
- Provided by the [ZHA](/integrations/zha) integration.
-- From the [Binary Sensor](/integrations/binary_sensor) domain.
+- From the [Binary sensor](/integrations/binary_sensor) domain.
- Have presented themselves as devices of a motion device class.
- Allows selecting one or more entities.
diff --git a/source/_docs/blueprint/tutorial.markdown b/source/_docs/blueprint/tutorial.markdown
index 512efe3d262..5dd5c86ba58 100644
--- a/source/_docs/blueprint/tutorial.markdown
+++ b/source/_docs/blueprint/tutorial.markdown
@@ -5,7 +5,7 @@ description: "Tutorial on creating an automation blueprint."
-While the tutorial only shows how to create an automation blueprint, scripts also support blueprints in the same way.
+While the tutorial only shows how to create an automation blueprint, {% term scripts %} also support blueprints in the same way.
@@ -22,7 +22,7 @@ In this tutorial, we're going to create an automation blueprint that controls a
### Creating an automation
-To create a blueprint, we first need to have a working automation.
+To create a blueprint, we first need to have a working automation.
For this tutorial, we use a simple automation. The process for converting a complex automation is no different.
The automation we're going to use in this tutorial controls a light based on a motion sensor:
@@ -248,7 +248,7 @@ Don't forget to reload automations after you make changes to your blueprint to h
-## Video Tutorial
+## Video tutorial
This video tutorial explains how to create a blueprint that toggles a light on motion when the lux value is below a certain threshold.
diff --git a/source/_docs/configuration/basic.markdown b/source/_docs/configuration/basic.markdown
index 4aa8d951a41..39600bf80a9 100644
--- a/source/_docs/configuration/basic.markdown
+++ b/source/_docs/configuration/basic.markdown
@@ -118,6 +118,6 @@ country:
type: string
{% endconfiguration %}
-## Reload Core Service
+## 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 "Reload Location & Customizations" button under {% my server_controls title="Developer Tools > YAML" %}.
+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" %}.
diff --git a/source/_docs/configuration/customizing-devices.markdown b/source/_docs/configuration/customizing-devices.markdown
index 880e5a658dc..e289cdc10e8 100644
--- a/source/_docs/configuration/customizing-devices.markdown
+++ b/source/_docs/configuration/customizing-devices.markdown
@@ -7,8 +7,8 @@ description: "Simple customization for entities."
You can use the UI to change the entity ID and friendly name of supported entities. To do this:
-1. Select the entity, either from the frontend or by clicking the info button next to the entity in the Developer Tools "States" tab.
-2. Click on the cog icon in the right corner of the entity's dialog
+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 `.`)
@@ -57,15 +57,15 @@ initial_state:
default: None
{% endconfiguration %}
-### Device Class
+### Device class
Device class is currently supported by the following platforms:
-- [Binary Sensor](/integrations/binary_sensor/)
+- [Binary sensor](/integrations/binary_sensor/)
- [Button](/integrations/button/)
- [Cover](/integrations/cover/)
- [Humidifier](/integrations/humidifier/)
-- [Media Player](/integrations/media_player/)
+- [Media player](/integrations/media_player/)
- [Number](/integrations/number/)
- [Sensor](/integrations/sensor/)
- [Switch](/integrations/switch/)
diff --git a/source/_docs/configuration/remote.markdown b/source/_docs/configuration/remote.markdown
index 010514553c8..ca8e06d94c5 100644
--- a/source/_docs/configuration/remote.markdown
+++ b/source/_docs/configuration/remote.markdown
@@ -23,7 +23,7 @@ A secure way to remotely access your Home Assistant is to use a Virtual Private
A VPN connection needs to be established before you can connect to your Home Assistant from outside your local network. The VPN makes this connection secure. When using the Home Assistant Companion app (such as on a mobile device), without this connection, your sensors will not update in Home Assistant.
-## Port Forwarding
+## Port forwarding
Set up port forwarding (for any port) from your router to port 8123 on the computer that is hosting Home Assistant. General instructions on how to do this can be found by searching ` port forwarding instructions`. You can use any free port on your router and forward that to port 8123.
diff --git a/source/_docs/configuration/securing.markdown b/source/_docs/configuration/securing.markdown
index 5b73326e0be..18e5a015e9d 100644
--- a/source/_docs/configuration/securing.markdown
+++ b/source/_docs/configuration/securing.markdown
@@ -13,9 +13,9 @@ Here's the summary of what you *must* do to secure your Home Assistant system:
- **Note**: Storing secrets in `secrets.yaml` does not encrypt them.
- Regularly keep the system up to date
-## Remote Access
+## Remote access
-If you want secure remote access, the easiest option is to use [Home Assistant cloud](/cloud/) by which you also [support](https://www.nabucasa.com/about/) the founders of Home Assistant.
+If you want secure remote access, the easiest option is to use [Home Assistant Cloud](/cloud/) by which you also [support](https://www.nabucasa.com/about/) the founders of Home Assistant.
Another option is to use TLS/SSL via the add-on [Duck DNS](/integrations/duckdns/) integrating Let's Encrypt.
diff --git a/source/_docs/configuration/splitting_configuration.markdown b/source/_docs/configuration/splitting_configuration.markdown
index e3bf2de1db3..2f3e7bd30c1 100644
--- a/source/_docs/configuration/splitting_configuration.markdown
+++ b/source/_docs/configuration/splitting_configuration.markdown
@@ -200,7 +200,7 @@ If you have many configuration files, Home Assistant provides a CLI that allows
- [Core](/common-tasks/core/#configuration-check)
- [Supervised](/common-tasks/supervised/#configuration-check)
-## Advanced Usage
+## Advanced usage
We offer four advanced options to include whole directories at once. Please note that your files must have the `.yaml` file extension; `.yml` is not supported.
diff --git a/source/_docs/configuration/state_object.markdown b/source/_docs/configuration/state_object.markdown
index 7241b0a79c2..0b33f6bf7cb 100644
--- a/source/_docs/configuration/state_object.markdown
+++ b/source/_docs/configuration/state_object.markdown
@@ -1,9 +1,9 @@
---
-title: "State Objects"
+title: "State objects"
description: "Describes all there is to know about state objects in Home Assistant."
---
-Your devices are represented in Home Assistant as entities. The entities will write their current state to the state machine for other entities/templates/frontend to access. States are a current representation of the entity.
+Your {% term devices %} are represented in Home Assistant as entities. The {% term entities %} will write their current {% term state %} to the state machine for other entities/templates/frontend to access. States are a current representation of the {% term entity %}.
If you overwrite a state via the states dev tool or the API, it will not impact the actual device. If the device state is being polled, it will overwrite the state in the state machine the next polling.
@@ -23,7 +23,7 @@ All states will always have an entity id, a state and a timestamp when last upda
## Attributes
-The attributes of an entity are optional. There are a few attributes that are used by Home Assistant for representing the entity in a specific way. Each integration will also have its own attributes to represent extra state data about the entity. For example, the light integration has attributes for the current brightness and color of the light. When an attribute is not available, Home Assistant will not write it to the state.
+The attributes of an {% term entity %} are optional. There are a few attributes that are used by Home Assistant for representing the entity in a specific way. Each integration will also have its own attributes to represent extra state data about the entity. For example, the light integration has attributes for the current brightness and color of the light. When an attribute is not available, Home Assistant will not write it to the state.
When using templates, attributes will be available by their name. For example `state.attributes.assumed_state`.
@@ -39,7 +39,7 @@ When an attribute contains spaces, you can retrieve it like this: `state_attr('s
## Context
-Context is used to tie events and states together in Home Assistant. Whenever an automation or user interaction causes states to change, a new context is assigned. This context will be attached to all events and states that happen as result of the change.
+Context is used to tie {% term events %} and {% term states %} together in Home Assistant. Whenever an {% term automation %} or user interaction causes states to change, a new context is assigned. This context will be attached to all events and states that happen as result of the change.
| Field | Description |
| ----- | ------------------------------------------------------------------- |
diff --git a/source/_docs/configuration/templating.markdown b/source/_docs/configuration/templating.markdown
index 31639b82286..574196db954 100644
--- a/source/_docs/configuration/templating.markdown
+++ b/source/_docs/configuration/templating.markdown
@@ -46,7 +46,7 @@ script:
{% endraw %}
-### Important Template Rules
+### Important template rules
There are a few very important rules to remember when adding templates to YAML:
@@ -57,7 +57,7 @@ There are a few very important rules to remember when adding templates to YAML:
Remembering these simple rules will help save you from many headaches and endless hours of frustration when using automation templates.
-### Enabled Jinja Extensions
+### Enabled Jinja extensions
Jinja supports a set of language extensions that add new functionality to the language.
To improve the experience of writing Jinja templates, we have enabled the following
@@ -65,7 +65,7 @@ extensions:
- [Loop Controls](https://jinja.palletsprojects.com/en/3.0.x/extensions/#loop-controls) (`break` and `continue`)
-### Reusing Templates
+### Reusing templates
You can write reusable Jinja templates by adding them to a `custom_templates` folder under your
configuration directory. All template files must have the `.jinja` extension and be less than 5MiB.
@@ -102,7 +102,7 @@ In your automations, you could then reuse this macro by importing it:
Extensions allow templates to access all of the Home Assistant specific states and adds other convenience functions and filters.
-### Limited Templates
+### Limited templates
Templates for some [triggers](/docs/automation/trigger/) as well as `trigger_variables` only support a subset of the Home Assistant template extensions. This subset is referred to as "Limited Templates".
@@ -325,7 +325,7 @@ List of lights that are on with a brightness of 255:
{% endraw %}
-### Working with Groups
+### Working with groups
Not supported in [limited templates](#limited-templates).
@@ -418,7 +418,7 @@ The same thing can also be expressed as a test:
{% endraw %}
-### Config Entries
+### Config entries
- `config_entry_id(entity_id)` returns the config entry ID for a given entity ID. Can also be used as a filter.
@@ -1066,7 +1066,7 @@ The following overview contains a couple of options to get the needed values:
{% endraw %}
-To evaluate a response, go to **{% my developer_template title="Developer Tools -> Template" %}**, create your output in "Template editor", and check the result.
+To evaluate a response, go to **{% my developer_template title="Developer Tools > Template" %}**, create your output in "Template editor", and check the result.
{% raw %}
diff --git a/source/_docs/configuration/troubleshooting.markdown b/source/_docs/configuration/troubleshooting.markdown
index 566ffc1eb59..1033a4859bc 100644
--- a/source/_docs/configuration/troubleshooting.markdown
+++ b/source/_docs/configuration/troubleshooting.markdown
@@ -98,11 +98,11 @@ The only characters valid in entity names are:
If you create an entity with other characters then Home Assistant may not generate an error for that entity. However you will find that attempts to use that entity will generate errors (or possibly fail silently).
-## Debug Logs and Diagnostics
+## Debug logs and diagnostics
The first thing you will need before reporting an issue online is debug logs and diagnostics (if available) for the integration giving you trouble. Getting those ahead of time will ensure someone can help resolve your issue in the fastest possible manner.
-### Enabling Debug Logging
+### Enabling debug logging
To enable debug logging for an integration, go to **Settings** > **Devices & Services** > **Integrations** and go to the detail page of the integration. Select the **Enable Debug Logging** button on the left side of the integration detail page.
@@ -111,11 +111,11 @@ To enable debug logging for an integration, go to **Settings** > **Devices & Ser
Example of Enable debug logging.
-### Disable Debug Logging and Download Logs
+### Disable debug logging and download logs
Once you enable debug logging, you ideally need to make the error happen. Run your automation, change up your device or whatever was giving you an error and then come back and disable the debug logging. Disabling the debug logging is the same as enabling, but now the button says **Disable Debug Logging**. After you disable it, you will be automatically prompted you to download your log file. Save this to a safe location to upload later.
-### Download Diagnostics
+### Download diagnostics
After you download logs, you will also want to download the diagnostics for the integration giving you trouble. If the integration provides diagnostics, it will appear in the three dot menu next to the integration configuration.
diff --git a/source/_docs/configuration/yaml.markdown b/source/_docs/configuration/yaml.markdown
index 5c37425ee0c..d3f2adda226 100644
--- a/source/_docs/configuration/yaml.markdown
+++ b/source/_docs/configuration/yaml.markdown
@@ -93,7 +93,7 @@ light: !include lights.yaml
More information about this feature can also be found at [splitting configuration](/docs/configuration/splitting_configuration/).
-## Common Issues
+## Common issues
### found character '\t'
diff --git a/source/_docs/energy/electricity-grid.markdown b/source/_docs/energy/electricity-grid.markdown
index af5b09aaada..c82d03a3e69 100644
--- a/source/_docs/energy/electricity-grid.markdown
+++ b/source/_docs/energy/electricity-grid.markdown
@@ -45,6 +45,12 @@ We have developed [Home Assistant Glow](https://github.com/klaasnicolaas/home-as
+#### Reading the meter via a IEC62056-21
+
+The IEC62056-21 is a common protocol not only for electric meters. It uses an infrared port to read data.
+[Aquaticus](https://github.com/aquaticus) has created an [ESPHome component](https://community.home-assistant.io/t/new-iec62056-21-component/555236) for reading this data. [PiggyMeter](https://aquaticus.info/meter.html) is a complete project that allows easy installation.
+
+
#### Using (Smart Message Language) interface
In countries like Germany, SML (Smart Message Language) is used typically. ESPHome's [SML (Smart Message Language)](https://esphome.io/components/sml.html) is one way to integrate it. If you prefer to integrate it via MQTT, [sml2mqtt](https://github.com/spacemanspiff2007/sml2mqtt) is another open source option.
@@ -69,7 +75,7 @@ _Attention! Installing CT clamp sensor devices requires opening your electrical
Some energy providers will provide you real-time information about your usage and have this data integrated into Home Assistant.
-### Manual Integration
+### Manual integration
If you manually integrate your sensors, for example, using the [MQTT](/integrations/mqtt) or [Template](/integrations/template) integrations: Make sure you set and provide the `device_class`, `state_class`, and `unit_of_measurement` for those sensors.
diff --git a/source/_docs/energy/faq.markdown b/source/_docs/energy/faq.markdown
index dffa7d09765..25fce51be53 100644
--- a/source/_docs/energy/faq.markdown
+++ b/source/_docs/energy/faq.markdown
@@ -29,15 +29,15 @@ If you are using a 3rd party device (e.g. not reading directly from your utility
To accomplish such, you can use the [utility_meter integration](/integrations/utility_meter/). With this integration, you define as many tariffs as required (in accordance with your utility provider contract) and HA will be able to differentiate energy consumptions in each of the tariffs. Please note that each utility provider has its own time schedules for peak and off-peak and you are required to create an automation that switches the utility_meter entity from one tariff to the other.
-## The Energy panel is not visible
+## The energy panel is not visible
If you do not see the Energy panel in the sidebar, make sure you have not removed [`default_config:`](/integrations/default_config/) from your `configuration.yaml`. If you have, you will need to add the `energy:` integration manually.
-## Troubleshooting missing entities
+## Troubleshooting missing entities
### Condition
-You are trying to add a sensor to the energy dashboard, but it does not appear in the selection list.
+You are trying to add a sensor to the energy dashboard, but it does not appear in the selection list.
### Resolution
diff --git a/source/_docs/energy/individual-devices.markdown b/source/_docs/energy/individual-devices.markdown
index 1e0f1751968..6e17a2516a5 100644
--- a/source/_docs/energy/individual-devices.markdown
+++ b/source/_docs/energy/individual-devices.markdown
@@ -13,7 +13,7 @@ Smart plugs sit between the device and the outlet and measure the energy flowing
Depending on what protocols you use at home, you can use Zigbee, Z-Wave or Wi-Fi based plugs.
-### Smart Relays
+### Smart relays
Smart relays sit behind your "normal" switches and make them smart. It allows you to control the devices via Home Assistant and via the connected buttons/switches.
diff --git a/source/_docs/frontend/browsers.markdown b/source/_docs/frontend/browsers.markdown
index 9c193cef37b..18afa58b960 100644
--- a/source/_docs/frontend/browsers.markdown
+++ b/source/_docs/frontend/browsers.markdown
@@ -1,6 +1,6 @@
---
title: "Browsers"
-description: "Browser Compatibility List"
+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.
diff --git a/source/_docs/frontend/icons.markdown b/source/_docs/frontend/icons.markdown
index 0d394792e71..7499aa6dc75 100644
--- a/source/_docs/frontend/icons.markdown
+++ b/source/_docs/frontend/icons.markdown
@@ -9,15 +9,15 @@ description: "Material Design Icons in the Home Assistant frontend"
Home Assistant utilizes the community-driven [Material Design Icons](https://pictogrammers.com/library/mdi/) (MDI) project for icons in the frontend. The icon library is a superset of the base icon library provided by Google and contains thousands of community-made icons for very specific applications, industries, and use-cases.
-## Default Icons
+## Default icons
Every entity in Home Assistant has a default icon assigned to it. There are way too many to list out here, but you'll see them in your dashboard. You can [customize any of your entities](/docs/configuration/customizing-devices/#icon) to change the icons displayed to you.
-## Finding Icons
+## Finding icons
-### Icon Picker
+### Icon picker
-The most common way you can find icons is by using the icon picker built right into Home Assistant. Click into the "Icon" field when customizing an entity and start typing. The list will filter to icons that match your search criteria. You can also scroll through all available icons when the field is empty.
+The most common way you can find icons is by using the icon picker built right into Home Assistant. Select the "Icon" field when customizing an entity and start typing. The list will filter to icons that match your search criteria. You can also scroll through all available icons when the field is empty.
@@ -29,7 +29,7 @@ The most common way you can find icons is by using the icon picker built right i
-### Material Design Icons Picker Browser Extension
+### Material design icons picker browser extension
The easiest way to browse and find icons outside of Home Assistant is with the official [Material Design Icons Picker](https://github.com/Pictogrammers/MaterialDesignIcons-Picker) browser extension. The extension is available for Chrome, Firefox, and Edge and is maintained by the MDI team.
@@ -43,19 +43,19 @@ The easiest way to browse and find icons outside of Home Assistant is with the o
-### Material Design Icons on the Pictogrammers Website
+### Material design icons on the Pictogrammers website
The last way to browse through available icons is by viewing the library on the Pictogrammers website, [https://pictogrammers.com/library/mdi/](https://pictogrammers.com/library/mdi/). Select an icon you'd like to use, then click "Home Assistant" to see an example of its usage.
- The Pictogrammers website will always show the latest release of the Material Design Icons library. However, you may find icons that may not yet be available in Home Assistant (yet!). Watch the Home Assistant release notes for announcements on upgrades of the Material Design Icons library.
+ The Pictogrammers website will always show the latest release of the material design icons library. However, you may find icons that may not yet be available in Home Assistant (yet!). Watch the Home Assistant release notes for announcements on upgrades of the Material Design Icons library.
-## Suggesting or Contributing New Icons
+## Suggesting or contributing new icons
-Being open-source like Home Assistant, the Material Design Icons library is always accepting suggestions and contributions to expand the library.
+Being open-source like Home Assistant, the material design icons library is always accepting suggestions and contributions to expand the library.
@@ -63,7 +63,7 @@ Being open-source like Home Assistant, the Material Design Icons library is alwa
-### Suggesting a New Icon
+### Suggesting a new icon
If you have an idea for an icon that isn't currently in the library, but are not interested in creating it yourself, [open a new icon suggestion](https://github.com/Templarian/MaterialDesign/issues/new?assignees=&labels=Icon+Request&template=1_icon_request.yml).
diff --git a/source/_docs/locked_out.md b/source/_docs/locked_out.md
index 1c656255364..37cedcf4adc 100644
--- a/source/_docs/locked_out.md
+++ b/source/_docs/locked_out.md
@@ -45,11 +45,12 @@ If you are running Home Assistant in a container, you can use the command line i
4. `exit` to exit the container command line
5. `docker restart homeassistant` to restart the container.
-#### To reset a user's password, as an administrator via the web interface
+#### To reset a user's password, as an owner via the web interface
1. In the bottom left, select your user to go to the {% my profile title="**Profile**" %} page and make sure **Advanced Mode** is activated.
2. Go to {% my people title="**Settings** > **People**" %} and select the person for which you want to change the password.
3. At the bottom of the dialog box, select **Change Password**.
+ - Note: this is available as the owner, not administrator.
4. Enter the new password, and select **OK**.
5. Confirm the new password by entering it again, and select **OK** again.
6. A confirmation box will be displayed with the text **Password was changed successfully**.
@@ -78,7 +79,7 @@ If you lose the password associated with the owner account and the steps above d
- `hassio`
- `cloud`
-## Recovering Data for Home Assistant (including Supervised)
+## Recovering data for Home Assistant (including Supervised)
Unless your SD card/data is corrupted, you can still get to your files or troubleshoot further.
There are a few routes:
@@ -101,7 +102,7 @@ You will then be at the Home Assistant CLI, where you can run the custom command
- `dns logs` for checking DNS
- etc (typing `help` will show more)
-## Accessing Files from the SD/HDD
+## Accessing files from the SD/HDD
### Remove the SD and access the files from another computer
diff --git a/source/_docs/scene/editor.markdown b/source/_docs/scene/editor.markdown
index 931110b9998..cf9ff0fc4f4 100644
--- a/source/_docs/scene/editor.markdown
+++ b/source/_docs/scene/editor.markdown
@@ -1,5 +1,5 @@
---
-title: "Scenes Editor"
+title: "Scenes editor"
description: "Instructions on how to use the scenes editor."
---
diff --git a/source/_docs/scripts.markdown b/source/_docs/scripts.markdown
index 804849270f1..a8988e68b8f 100644
--- a/source/_docs/scripts.markdown
+++ b/source/_docs/scripts.markdown
@@ -241,7 +241,7 @@ This action can use the same triggers that are available in an automation's `tri
{% endraw %}
-### Wait Timeout
+### Wait timeout
With both types of waits it is possible to set a timeout after which the script will continue its execution if the condition/event is not satisfied. Timeout has the same syntax as `delay`, and like `delay`, also accepts templates.
@@ -275,7 +275,7 @@ You can also get the script to abort after the timeout by using optional `contin
Without `continue_on_timeout: false` the script will always continue since the default for `continue_on_timeout` is `true`.
-### Wait Variable
+### Wait variable
After each time a wait completes, either because the condition was met, the event happened, or the timeout expired, the variable `wait` will be created/updated to indicate the result.
@@ -387,12 +387,12 @@ The following automation example shows how to capture the custom event `event_li
{% endraw %}
-## Repeat a Group of Actions
+## Repeat a group of actions
This action allows you to repeat a sequence of other actions. Nesting is fully supported.
There are three ways to control how many times the sequence will be run.
-### Counted Repeat
+### Counted repeat
This form accepts a count value. The value may be specified by a template, in which case
the template is rendered when the repeat step is reached.
@@ -473,7 +473,7 @@ repeat:
{% endraw %}
-### While Loop
+### While loop
This form accepts a list of conditions (see [conditions page] for available options) that are evaluated _before_ each time the sequence
is run. The sequence will be run _as long as_ the condition(s) evaluate to true.
@@ -514,7 +514,7 @@ For example:
{% endraw %}
-### Repeat Until
+### Repeat until
This form accepts a list of conditions that are evaluated _after_ each time the sequence
is run. Therefore the sequence will always run at least once. The sequence will be run
@@ -564,7 +564,7 @@ For example:
```
{% endraw %}
-### Repeat Loop Variable
+### Repeat loop variable
A variable named `repeat` is defined within the repeat action (i.e., it is available inside `sequence`, `while` & `until`.)
It contains the following fields:
diff --git a/source/_docs/scripts/conditions.markdown b/source/_docs/scripts/conditions.markdown
index ea078cc68a7..71529b270f5 100644
--- a/source/_docs/scripts/conditions.markdown
+++ b/source/_docs/scripts/conditions.markdown
@@ -5,9 +5,9 @@ toc: true
no_toc: true
---
-Conditions can be used within a script or automation to prevent further execution. When a condition evaluates true, the script or automation will be executed. If any other value is returned, the script or automation stops executing. A condition will look at the system at that moment. For example, a condition can test if a switch is currently turned on or off.
+Conditions can be used within a {% term script %} or {% term automation %} to prevent further execution. When a condition evaluates true, the script or automation will be executed. If any other value is returned, the script or automation stops executing. A condition will look at the system at that moment. For example, a condition can test if a switch is currently turned on or off.
-Unlike a trigger, which is always `or`, conditions are `and` by default - all conditions have to be true.
+Unlike a {% term trigger %}, which is always `or`, conditions are `and` by default - all conditions have to be true.
All conditions support an optional `alias`.
diff --git a/source/_docs/scripts/service-calls.markdown b/source/_docs/scripts/service-calls.markdown
index c492e9ad3de..d153233b4ca 100644
--- a/source/_docs/scripts/service-calls.markdown
+++ b/source/_docs/scripts/service-calls.markdown
@@ -1,9 +1,9 @@
---
-title: "Service Calls"
+title: "Service calls"
description: "Instructions on how to call services in Home Assistant."
---
-Various integrations allow calling services when a certain event occurs. The most common one is calling a service when an automation trigger happens. But a service can also be called from a script, a dashboard or via voice command devices such as Amazon Echo.
+Various integrations allow calling {% term services %} when a certain event occurs. The most common one is calling a service when an automation {% term trigger %} happens. But a service can also be called from a {% term script %}, a dashboard or via voice command devices such as Amazon Echo.
The configuration options to call a configuration are the same between all integrations and are described on this page.
@@ -15,7 +15,7 @@ Use the "Services" tab under Developer Tools to discover available services.
### The basics
-Call the service `homeassistant.turn_on` on the entity `group.living_room`. This will turn all members of `group.living_room` on. You can also use `entity_id: all` and it will turn on all possible entities.
+Call the service `homeassistant.turn_on` on the {% term entity %} `group.living_room`. This will turn all members of `group.living_room` on. You can also use `entity_id: all` and it will turn on all possible entities.
```yaml
service: homeassistant.turn_on
@@ -24,7 +24,7 @@ entity_id: group.living_room
### Targeting areas and devices
-Instead of targeting an entity, you can also target an area or device. Or a combination of these.
+Instead of targeting an entity, you can also target an {% term area %} or {% term device %}. Or a combination of these.
This is done with the `target` key.
A `target` is a map that contains at least one of the following: `area_id`, `device_id`, `entity_id`.
diff --git a/source/_docs/tools/check_config.markdown b/source/_docs/tools/check_config.markdown
index 4da8a0933d7..24592293913 100644
--- a/source/_docs/tools/check_config.markdown
+++ b/source/_docs/tools/check_config.markdown
@@ -3,7 +3,7 @@ title: "check_config"
description: "Script to perform a check of the current configuration"
---
-Test any changes to your `configuration.yaml` file before launching Home Assistant. This script allows you to test changes without the need to restart Home Assistant.
+Test any changes to your `configuration.yaml` file before launching Home Assistant. This {% term 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 3852cdf4a53..627fac764f4 100644
--- a/source/_docs/tools/dev-tools.markdown
+++ b/source/_docs/tools/dev-tools.markdown
@@ -1,13 +1,13 @@
---
-title: "Developer Tools"
-description: "Description of the Developer Tools."
+title: "Developer tools"
+description: "Description of the developer tools."
---
-The frontend contains a section called **Developer Tools**.
+The dashboard contains a section called **Developer tools**.
-Screenshot of Home Assistant's Developer Tools.
+Screenshot of Home Assistant's developer tools.
| Section |Description |
@@ -58,9 +58,9 @@ brightness: 255
rgb_color: [255, 0, 0]
```
-## Template Editor
+## Template editor
-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.
+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.
By default, this will contain sample code that illustrates how templates can be written and tested. This sample code can be removed and replaced with your own. You can restore the default example by pressing the "Reset to Demo Template" button beneath the code editor.
diff --git a/source/_docs/tools/quick-bar.markdown b/source/_docs/tools/quick-bar.markdown
index 603f7444809..ba73ba75a75 100644
--- a/source/_docs/tools/quick-bar.markdown
+++ b/source/_docs/tools/quick-bar.markdown
@@ -1,9 +1,9 @@
---
-title: "Quick Bar"
+title: "Quick bar"
description: "Dialog for quickly accessing entities or running commands."
---
-The "Quick Bar" allows you to quickly look up entities or run commands without needing to navigate away from your current view (Similar to the "quick open" feature in VS Code, Chrome Developer Tools, etc).
+The **Quick bar** allows you to quickly look up entities or run commands without needing to navigate away from your current view (Similar to the "quick open" feature in VS Code, Chrome Developer Tools, etc).
It can be launched from anywhere in the frontend using [hotkeys](#hotkeys).
@@ -26,7 +26,7 @@ Type these from anywhere in the application to launch the dialog.
The application must have focus for the hotkey to register. If the dialog doesn't launch, try clicking into an empty part of the main content area of Home Assistant and type it again.
-## Entity Filter
+## Entity filter
*Hotkey: `e`*
@@ -41,7 +41,7 @@ Once launched, start typing your entity id (or ["bits and pieces" of your entity
This is helpful when, say, you are in the middle of writing an automation and need some quick insight about an entity but don't want to navigate away to Developer Tools.
-## Command Palette
+## Command palette
*Hotkey: `c`*
@@ -66,7 +66,7 @@ Type | Available |
Create [`my`](/integrations/my) links from any supported page in the user interface, when invoked on a supported page it will open a new tab that will allow you to share the link in different formats.
-## Disabling Shortcuts
+## Disabling shortcuts
You can enable or disable all of Home Assistant's keyboard shortcuts by going to your User Profile and clicking the "Keyboard Shortcuts" toggle button.
diff --git a/source/_docs/z-wave/controllers.markdown b/source/_docs/z-wave/controllers.markdown
index 0479530b7ac..edcf56f9401 100644
--- a/source/_docs/z-wave/controllers.markdown
+++ b/source/_docs/z-wave/controllers.markdown
@@ -52,7 +52,7 @@ If you are just starting out, we recommend that you purchase a 700 series contro
If you're using Home Assistant OS, Supervised, or Container, it's recommended to use a USB stick, not a module. Passing a module through Docker is more complicated than passing a USB stick through.
-## Stick Alternatives
+## Stick alternatives
The alternative to a stick is a hub that supports Z-Wave. Home Assistant supports the following hubs with Z-Wave support:
@@ -61,7 +61,7 @@ The alternative to a stick is a hub that supports Z-Wave. Home Assistant support
- [SmartThings](/integrations/smartthings/)
- [Z-Wave.Me Z-Way](/integrations/zwave_me)
-## Controller Notes
+## Controller notes
### 800 Series Controllers
diff --git a/source/_includes/asides/common_tasks_navigation.html b/source/_includes/asides/common_tasks_navigation.html
index 16792dda2a6..c3f5fd67dd0 100644
--- a/source/_includes/asides/common_tasks_navigation.html
+++ b/source/_includes/asides/common_tasks_navigation.html
@@ -1,6 +1,6 @@
-
Common Tasks
+
Common tasks
{% active_link /common-tasks/os/ Home Assistant Operating System %}
{% active_link /common-tasks/container/ Home Assistant Container %}
@@ -273,7 +333,7 @@ _All these can be extended if your usage calls for more resources._
3. Make sure under **Settings** > **VM manager**, **Enable VMs** is enabled.
4. Create a new virtual machine: **VMS** > **Add VM**.
5. Select type **Linux** and give the VM a name and a description.
- 6. Select the CPU cores you want to let the VM use and give it some memory.
+ 6. Select the CPU cores you want to let the VM use and give it some memory.
7. Under **Primary vDisk Location**, select **Manual** and then select the qcow2 image.
8. Select your keyboard language under **VM Console Keyboard**.
9. Select **br0** under **Network Source**.
@@ -284,8 +344,8 @@ _All these can be extended if your usage calls for more resources._
14. Select the name of your new VM and select the capacity number for your disk. Here, you can expand the disk to whatever your needs are. The default is 32 GB.
15. Select the icon of your new VM and select **start with console (VNC)**.
+{% unless page.installation_type == 'macOS' %}
-{% unless page.installation_type == 'macos' %}
- title: KVM (virt-manager)
content: |
1. Create a new virtual machine in `virt-manager`.
@@ -301,9 +361,11 @@ _All these can be extended if your usage calls for more resources._
- title: KVM (virt-install)
content: |
+
```bash
virt-install --name hass --description "Home Assistant OS" --os-variant=generic --ram=2048 --vcpus=2 --disk ,bus=sata --import --graphics none --boot uefi
```
+
If you have a USB dongle to attach, you need to add the option `--hostdev busID.deviceId`. You can discover these IDs via the `lsusb` command.
As example, if `lsusb` output is:
@@ -324,12 +386,14 @@ _All these can be extended if your usage calls for more resources._
```bash
virt-install --name hass --description "Home Assistant OS" --os-variant=generic --ram=2048 --vcpus=2 --disk ,bus=sata --import --graphics none --boot uefi --hostdev 003.003
```
- Note that this configuration (bus 003, device 003) is just an example, your dongle could be on another bus and/or with another device ID.
+
+ Note that this configuration (bus 003, device 003) is just an example, your dongle could be on another bus and/or with another device ID.
Please check the correct IDs of your USB dongle with `lsusb`.
+
{% endunless %}
-{% if page.installation_type == 'windows' or page.installation_type == 'linux' %}
+{% if page.installation_type == 'windows' or page.installation_type == 'Linux' %}
- title: Vmware Workstation
content: |
diff --git a/source/_includes/installation_survey.html b/source/_includes/installation_survey.html
index e7d9065798c..aee02cbc9c1 100644
--- a/source/_includes/installation_survey.html
+++ b/source/_includes/installation_survey.html
@@ -1,11 +1,15 @@
diff --git a/source/_includes/integrations/google_client_secret.md b/source/_includes/integrations/google_client_secret.md
index 594c3b93d57..71daa330a5d 100644
--- a/source/_includes/integrations/google_client_secret.md
+++ b/source/_includes/integrations/google_client_secret.md
@@ -23,7 +23,7 @@ This section explains how to generate a client ID and client secret on
1. First, go to the Google Developers Console to enable [{{ api }}]({{ api_link }}) {% if page.api2 %} and [{{ page.api2 }}]({{ page.api2_link }}) {% endif %}.
2. Select **Create project**, enter a project name and select **Create**.
-3. **Enable** the {{ api }} and select **Create credentials**.
+3. **Enable** the {{ api }}.
4. Navigate to **APIs & Services** (left sidebar) > [Credentials](https://console.cloud.google.com/apis/credentials).
5. In the left sidebar, select **OAuth consent screen**.
- Select **External** and **Create**.
@@ -32,7 +32,7 @@ This section explains how to generate a client ID and client secret on
- From the dropdown menu, select your email address.
7. Under **Developer contact information**, enter your email address (the same as above is fine).
8. Scroll to the bottom and select **Save and continue**.
- - You don't have to fill out anything else, or it may enable additional review.
+ - You don't have to fill out anything else here. Adding other information to this page (like an app logo) may trigger an additional review process from Google and delay setup by days.
9. You will then be automatically taken to the **Scopes** page.
- You do not need to add any scopes here. Select **Save and continue** to move to the **Test users** page.
- You do not need to add anything to the **Test users** page. Select **Save and continue**, which will take you to the **Summary** page.
@@ -51,4 +51,4 @@ This section explains how to generate a client ID and client secret on
- To view both the **Client ID** and **Client secret**, select the pencil icon. This will take you to the settings page for these credentials, and the information will be on the right-hand side of the page.
16. Congratulations! You are now the keeper of a client secret. Guard it in your treasure box.
-{% enddetails %}
\ No newline at end of file
+{% enddetails %}
diff --git a/source/_integrations/abode.markdown b/source/_integrations/abode.markdown
index 7d6e6195dcf..2429faf9e48 100644
--- a/source/_integrations/abode.markdown
+++ b/source/_integrations/abode.markdown
@@ -3,7 +3,7 @@ title: Abode
description: Instructions on integrating Abode home security with Home Assistant.
ha_category:
- Alarm
- - Binary Sensor
+ - Binary sensor
- Camera
- Cover
- Hub
@@ -30,15 +30,15 @@ ha_platforms:
ha_integration_type: integration
---
-The `abode` integration will allow users to integrate their Abode Home Security systems into Home Assistant and use its alarm system and sensors to automate their homes.
+The **Abode** {% term integration %} will allow users to integrate their Abode Home Security systems into Home Assistant and use its alarm system and sensors to automate their homes.
Please visit the [Abode website](https://goabode.com/) for further information about Abode Security.
-There is currently support for the following device types within Home Assistant:
+There is currently support for the following {% term device %} types within Home Assistant:
-- **Alarm Control Panel**: Reports on the current alarm status and can be used to arm and disarm the system.
-- **Binary Sensor**: Reports on `Quick Actions`, `Door Contacts`, `Connectivity` sensors (remotes, keypads, and status indicators), `Moisture` sensors, and `Motion` or `Occupancy` sensors.
-- **Camera**: Reports on `Camera` devices and will download and show the latest captured still image. Can be turned off and on using the [`camera.turn_off`](/integrations/camera/#service-turn_off) and [`camera.turn_on`](/integrations/camera/#service-turn_on) services.
+- **Alarm control panel**: Reports on the current alarm status and can be used to arm and disarm the system.
+- **Binary sensor**: Reports on `Quick Actions`, `Door Contacts`, `Connectivity` {% term sensors %} (remotes, keypads, and status indicators), `Moisture` sensors, and `Motion` or `Occupancy` sensors.
+- **Camera**: Reports on `Camera` devices and will download and show the latest captured still image. Can be turned off and on using the [`camera.turn_off`](/integrations/camera/#service-turn_off) and [`camera.turn_on`](/integrations/camera/#service-turn_on) {% term services %}.
- **Cover**: Reports on `Secure Barriers` and can be used to open and close the cover.
- **Lock**: Reports on `Door Locks` and can be used to lock and unlock the door.
- **Light**: Reports on `Dimmer` lights and can be used to dim or turn the light on and off.
@@ -49,7 +49,7 @@ There is currently support for the following device types within Home Assistant:
## Events
-There are a number of events that can be triggered from Abode.
+There are a number of {% term events %} that can be triggered from Abode.
They are grouped into the below events:
- **abode_alarm**: Fired when an alarm event is triggered from Abode. This includes Smoke, CO, Panic, and Burglar alarms.
@@ -64,7 +64,7 @@ They are grouped into the below events:
- **abode_capture**: Fired when an image is captured.
- **abode_device**: Fired for device changes/additions/deletions.
-All events have the fields:
+All {% term events %} have the fields:
Field | Description
----- | -----------
@@ -84,7 +84,7 @@ Field | Description
There is a unique list of known event_codes that can be found
[here](https://github.com/MisterWil/abodepy/files/1262019/timeline_events.txt).
-## Services
+## {% term Services %}
### Service `change_setting`
diff --git a/source/_integrations/accuweather.markdown b/source/_integrations/accuweather.markdown
index e04f810ab04..fcbaea8ce11 100644
--- a/source/_integrations/accuweather.markdown
+++ b/source/_integrations/accuweather.markdown
@@ -17,7 +17,7 @@ ha_platforms:
ha_integration_type: service
---
-The AccuWeather integration uses the [AccuWeather](https://accuweather.com/) web service as a source for weather data for your location.
+The **AccuWeather** {% term integration %} uses the [AccuWeather](https://accuweather.com/) web service as a source for weather data for your location.
## Setup
diff --git a/source/_integrations/acmeda.markdown b/source/_integrations/acmeda.markdown
index 1224f4059d2..f4c9e365720 100644
--- a/source/_integrations/acmeda.markdown
+++ b/source/_integrations/acmeda.markdown
@@ -16,7 +16,7 @@ ha_platforms:
ha_integration_type: integration
---
-The Rollease Acmeda Automate integration allows you to control and monitor covers via your Rollease Acmeda Automate hub. The integrations communicates directly with hubs on the local network, rather than connecting via the cloud or via RS-485. Devices are represented as a cover for monitoring and control as well as a sensor for monitoring battery condition.
+The **Rollease Acmeda Automate** {% term integration %} allows you to control and monitor covers via your Rollease Acmeda Automate hub. The integrations communicates directly with hubs on the local network, rather than connecting via the cloud or via RS-485. Devices are represented as a cover for monitoring and control as well as a sensor for monitoring battery condition.
## Supported devices
diff --git a/source/_integrations/actiontec.markdown b/source/_integrations/actiontec.markdown
index 0a7cb56e73a..3db8925a0fc 100644
--- a/source/_integrations/actiontec.markdown
+++ b/source/_integrations/actiontec.markdown
@@ -2,7 +2,7 @@
title: Actiontec
description: Instructions on how to integrate Actiontec routers into Home Assistant.
ha_category:
- - Presence Detection
+ - Presence detection
ha_iot_class: Local Polling
ha_release: 0.7
ha_domain: actiontec
@@ -11,7 +11,7 @@ ha_platforms:
ha_integration_type: integration
---
-This platform allows you to detect presence by looking at connected devices to an [Actiontec](https://www.actiontec.com/) device.
+The **Actiontec** {% term integration %} allows you to detect presence by looking at connected devices to an [Actiontec](https://www.actiontec.com/) device.
Supported devices (tested):
diff --git a/source/_integrations/adax.markdown b/source/_integrations/adax.markdown
index 03d77c6fe26..7bac67e956c 100644
--- a/source/_integrations/adax.markdown
+++ b/source/_integrations/adax.markdown
@@ -14,7 +14,7 @@ ha_platforms:
ha_integration_type: integration
---
-Integrates Adax heater into Home Assistant.
+The **Adax** {% term integration %} integrates Adax heater into Home Assistant.
You can configure the heaters to use a local or cloud interface.
diff --git a/source/_integrations/adguard.markdown b/source/_integrations/adguard.markdown
index 6006bbab057..982ce5280d5 100644
--- a/source/_integrations/adguard.markdown
+++ b/source/_integrations/adguard.markdown
@@ -18,14 +18,14 @@ ha_integration_type: service
---
AdGuard Home is a network-wide ad- and tracker-blocking DNS server with parental
-control (adult content blocking) capabilities. The AdGuard integration allows
+control (adult content blocking) capabilities. The **AdGuard** integration allows
you to control and monitor your AdGuard Home instance in Home Assistant.
{% include integrations/config_flow.md %}
## Sensors
-This integration provides sensors for the following information from AdGuard Home:
+This integration provides {% term sensors %} for the following information from AdGuard Home:
- Number of DNS queries.
- Number of blocked DNS queries.
@@ -60,7 +60,7 @@ AdGuard relies on Query Log to provide stats.
## Services
-These services allow one to manage filter subscriptions in AdGuard Home.
+These {% term services %} allow one to manage filter subscriptions in AdGuard Home.
Using these services in automations could be helpful to block certain
sites/domains at certain times.
diff --git a/source/_integrations/ads.markdown b/source/_integrations/ads.markdown
index 3fe52996f48..c1b2d3ae2c4 100644
--- a/source/_integrations/ads.markdown
+++ b/source/_integrations/ads.markdown
@@ -2,7 +2,7 @@
title: ADS
description: Connect Home Assistant to TwinCAT devices via the ADS interface
ha_category:
- - Binary Sensor
+ - Binary sensor
- Cover
- Hub
- Light
@@ -24,7 +24,7 @@ The ADS (automation device specification) describes a device-independent and fie
There is currently support for the following device types within Home Assistant:
-- [Binary Sensor](#binary-sensor)
+- [Binary sensor](#binary-sensor)
- [Light](#light)
- [Sensor](#sensor)
- [Switch](#switch)
@@ -74,7 +74,7 @@ Service parameters:
- **adstype**: Specify the type of the variable. Use one of the following: `int`, `byte`, `uint`, `bool`
- **value**: The value that will be written in the variable.
-## Binary Sensor
+## Binary sensor
The `ads` binary sensor platform can be used to monitor a boolean value on your ADS device.
diff --git a/source/_integrations/advantage_air.markdown b/source/_integrations/advantage_air.markdown
index d05c6e9a52b..90d3309d682 100644
--- a/source/_integrations/advantage_air.markdown
+++ b/source/_integrations/advantage_air.markdown
@@ -2,7 +2,13 @@
title: Advantage Air
description: Instructions on how to integrate Advantage Air A/C controller into Home Assistant.
ha_category:
+ - Binary switch
- Climate
+ - Cover
+ - Light
+ - Sensor
+ - Switch
+ - Update
- Update
ha_release: 0.117
ha_iot_class: Local Polling
@@ -24,7 +30,7 @@ ha_platforms:
ha_integration_type: integration
---
-The Advantage Air integration allows you to control [Advantage Air](https://www.advantageair.com.au/) Air Conditioning controllers into Home Assistant.
+The **Advantage Air** {% term integration %} allows you to control [Advantage Air](https://www.advantageair.com.au/) Air Conditioning controllers into Home Assistant.
## Prerequisites
@@ -59,7 +65,7 @@ The integration will create sensor entities for a variety of aspects:
- Each zone that is temperature-controlled will have a sensor to show the temperature (disabled by default), and how open the damper is.
- Each zone with a wireless temperature or motion sensor will have a sensor that reports its wireless RSSI.
-### Binary Sensor
+### Binary sensor
The integration will create a binary sensor for each zone that has a motion sensor.
diff --git a/source/_integrations/aftership.markdown b/source/_integrations/aftership.markdown
index daecab16041..6a1c935dca8 100644
--- a/source/_integrations/aftership.markdown
+++ b/source/_integrations/aftership.markdown
@@ -2,7 +2,7 @@
title: AfterShip
description: Instructions on how to set up AfterShip sensors within Home Assistant.
ha_category:
- - Postal Service
+ - Postal service
ha_release: 0.85
ha_iot_class: Cloud Polling
ha_domain: aftership
diff --git a/source/_integrations/agent_dvr.markdown b/source/_integrations/agent_dvr.markdown
index 170eeac0e89..2661385a858 100644
--- a/source/_integrations/agent_dvr.markdown
+++ b/source/_integrations/agent_dvr.markdown
@@ -26,7 +26,7 @@ You can add Agent DVR via integrations using the IP address and port of the serv
Please ensure you are using Agent DVR v2.6.1.0 +
-## Alarm Control Panel
+## Alarm control panel
Reports on the current alarm status and can be used to arm and disarm the system.
diff --git a/source/_integrations/airly.markdown b/source/_integrations/airly.markdown
index ed003690be9..016e66c0b5f 100644
--- a/source/_integrations/airly.markdown
+++ b/source/_integrations/airly.markdown
@@ -16,7 +16,7 @@ ha_platforms:
ha_integration_type: service
---
-The Airly integration uses the [Airly](https://airly.eu/) web service as a source for air quality data for your location.
+The **Airly** {% term integration %} uses the [Airly](https://airly.eu/) web service as a source for air quality data for your location.
## Setup
diff --git a/source/_integrations/airnow.markdown b/source/_integrations/airnow.markdown
index e29e9cdaa72..137c2a247d3 100644
--- a/source/_integrations/airnow.markdown
+++ b/source/_integrations/airnow.markdown
@@ -15,7 +15,7 @@ ha_platforms:
ha_integration_type: integration
---
-The `airnow` integration uses the [AirNow](https://www.airnow.gov/) web service
+The **AirNow** {% term integration %} uses the [AirNow](https://www.airnow.gov/) web service
as a source for air quality data for your location.
## Setup
diff --git a/source/_integrations/airq.markdown b/source/_integrations/airq.markdown
index 4480f0dbabe..5031b17571f 100644
--- a/source/_integrations/airq.markdown
+++ b/source/_integrations/airq.markdown
@@ -17,15 +17,15 @@ ha_platforms:
ha_integration_type: hub
---
-This integration allows integrating the sensors, provided by your [air-Q](https://www.air-q.com/) device, into Home Assistant.
+The **air-Q** {% term integration %} allows integrating the sensors, provided by your [air-Q](https://www.air-q.com/) device, into Home Assistant.
{% include integrations/config_flow.md %}
-During the configuration, the user is prompted for the IP address of the device or the first 5 characters of the serial number, as well as the device password.
+During the configuration, the user is prompted for the IP address of the {% term device %} or the first 5 characters of the serial number, as well as the device password.
For this integration to communicate with the device, both must be connected to the same Wi-Fi network.
-After the setup, separate entities will be created for each of the sensors, found in your device.
+After the setup, separate {% term entities %} will be created for each of the {% term sensors %}, found in your {% term device %}.
## Sensors
diff --git a/source/_integrations/airthings_ble.markdown b/source/_integrations/airthings_ble.markdown
index a3ab479ed66..3252edb6846 100644
--- a/source/_integrations/airthings_ble.markdown
+++ b/source/_integrations/airthings_ble.markdown
@@ -17,9 +17,9 @@ ha_config_flow: true
ha_integration_type: integration
---
-Integrates Airthings BLE sensors into Home Assistant.
+Integrates Airthings BLE {% term sensors %} into Home Assistant.
-[Airthings](https://www.airthings.com/) provide different devices for measuring the air quality. Initially focusing on radon gas sensors, each device provides a number of different sensors to monitor typical contaminants that's presence contributes to bad air quality in the home.
+[Airthings](https://www.airthings.com/) provide different {% term devices %} for measuring the air quality. Initially focusing on radon gas sensors, each device provides a number of different sensors to monitor typical contaminants that's presence contributes to bad air quality in the home.
Requires Airthings hardware and a compatible Bluetooth dongle.
@@ -33,7 +33,7 @@ There are two ways of retrieving the 10-digit serial number of a Wave device:
This integration uses the last 6 digits of the serial number.
-## Supported Devices
+## Supported devices
- Wave gen. 1
- Wave Radon
diff --git a/source/_integrations/airtouch4.markdown b/source/_integrations/airtouch4.markdown
index f11355c9548..0fc0d0b9497 100644
--- a/source/_integrations/airtouch4.markdown
+++ b/source/_integrations/airtouch4.markdown
@@ -14,7 +14,7 @@ ha_codeowners:
- '@samsinnamon'
---
-The AirTouch 4 integration allows you to control Ducted Air Conditioning Systems that are using the [AirTouch 4](https://www.airtouch.net.au/airtouch/airtouch-4/) Controller. Currently, this integration only supports AirTouch 4 controllers with the Individual Temperature Control (ITC) modules.
+The **AirTouch 4** {% term integration %} allows you to control Ducted Air Conditioning Systems that are using the [AirTouch 4](https://www.airtouch.net.au/airtouch/airtouch-4/) controller. Currently, this integration only supports AirTouch 4 controllers with the Individual Temperature Control (ITC) modules.
{% include integrations/config_flow.md %}
@@ -22,4 +22,4 @@ The AirTouch 4 integration allows you to control Ducted Air Conditioning Systems
### Climate
-The integration will create a climate entity for each zone that is temperature-controlled.
+The {% term integration %} will create a climate {% term entity %} for each {% term zone %} that is temperature-controlled.
diff --git a/source/_integrations/airvisual.markdown b/source/_integrations/airvisual.markdown
index 1241574a70f..66ee7f1d915 100644
--- a/source/_integrations/airvisual.markdown
+++ b/source/_integrations/airvisual.markdown
@@ -47,11 +47,11 @@ For example, Sao Paulo, Brazil shows a breadcrumb title of `Brazil > Sao Paulo >
- State: `Sao Paulo`
- Country: `Brazil`
-## Sensor Types
+## Sensor types
When configured, the platform will create three sensors for each air quality standard:
-### Air Quality Index
+### Air quality index
- **Description:** This sensor displays a numeric air quality index (AQI), a metric for the overall "health" of the air.
- **Example Sensor Name:** `sensor.chinese_air_quality_index`
@@ -67,13 +67,13 @@ AQI | Status | Description
201 - 300 | **Very unhealthy** | Health warnings of emergency conditions. The entire population is more likely to be affected
301+ | **Hazardous** | Health alert: everyone may experience more serious health effects
-### Air Pollution Level
+### Air pollution level
- **Description:** This sensor displays the associated `Status` (from the above table) for the current AQI.
- **Sample Sensor Name:** `sensor.us_air_pollution_level`
- **Example Sensor Value:** `Moderate`
-### Main Pollutant
+### Main pollutant
- **Description:** This sensor displays the pollutant whose value is currently highest.
- **Sample Sensor Name:** `sensor.us_main_pollutant`
diff --git a/source/_integrations/airvisual_pro.markdown b/source/_integrations/airvisual_pro.markdown
index 25a66d75ad3..9cf6532056a 100644
--- a/source/_integrations/airvisual_pro.markdown
+++ b/source/_integrations/airvisual_pro.markdown
@@ -15,7 +15,7 @@ ha_platforms:
ha_integration_type: device
---
-The AirVisual Pro integration allows users to retrieve data from an [AirVisual Node/Pro unit](https://www.iqair.com/air-quality-monitors/airvisual-pro). Communication with the device occurs over the local network.
+The **AirVisual Pro** {% term integration %} allows users to retrieve data from an [AirVisual Node/Pro unit](https://www.iqair.com/air-quality-monitors/airvisual-pro). Communication with the device occurs over the local network.
## Determining the Password
@@ -23,9 +23,9 @@ You will need the device's Samba password, which [can be found on the unit](http
{% include integrations/config_flow.md %}
-## Sensor Types
+## Sensor types
-AirVisual Pro devices create a variety of sensors:
+AirVisual Pro {% term devices %} create a variety of {% term sensors %}:
- Air Quality Index (AQI)
- Battery Level
diff --git a/source/_integrations/airzone.markdown b/source/_integrations/airzone.markdown
index 50d0ace7272..de16ab9bfb3 100644
--- a/source/_integrations/airzone.markdown
+++ b/source/_integrations/airzone.markdown
@@ -3,11 +3,11 @@ title: Airzone
description: Instructions on how to integrate Airzone within Home Assistant.
ha_release: 2022.4
ha_category:
- - Binary Sensor
+ - Binary sensor
- Climate
- Select
- Sensor
- - Water Heater
+ - Water heater
ha_iot_class: Local Polling
ha_config_flow: true
ha_domain: airzone
@@ -41,7 +41,7 @@ ID:
description: "Airzone System ID (only needed if System ID 0 is not supported on your device)"
{% endconfiguration_basic %}
-## Binary Sensors
+## Binary sensors
For each Airzone system (HVAC machine), the following *binary sensors* are created:
@@ -49,7 +49,7 @@ For each Airzone system (HVAC machine), the following *binary sensors* are creat
| :------------------ | :--------------------------------- |
| problems | System has errors or warnings. |
-For each Airzone zone (Thermostat), the following *binary sensors* are created:
+For each Airzone zone (thermostat), the following *binary sensors* are created:
| Condition | Description |
| :------------------ | :--------------------------------- |
@@ -60,7 +60,7 @@ For each Airzone zone (Thermostat), the following *binary sensors* are created:
## Climate
-For each Airzone zone (Thermostat) a *climate entity* is created.
+For each Airzone zone (thermostat) a *climate entity* is created.
**HVAC mode can only be changed on a *parent zone*.**
@@ -68,7 +68,7 @@ For each Airzone zone (Thermostat) a *climate entity* is created.
## Select
-For each Airzone zone (Thermostat), the following *selects* are created:
+For each Airzone zone (thermostat), the following *selects* are created:
| Condition | Description |
| :------------------ | :--------------------------------- |
@@ -90,13 +90,13 @@ For the Airzone WebServer, the following *sensors* are created:
| :------------------ | :--------------------------------- |
| rssi | WiFi RSSI. |
-For each Airzone zone (Thermostat), the following *sensors* are created:
+For each Airzone zone (thermostat), the following *sensors* are created:
| Condition | Description |
| :------------------ | :--------------------------------- |
| humidity | Current zone relative humidity. |
| temperature | Current zone temperature. |
-## Water Heater
+## Water heater
For each Airzone device a *water heater entity* is created if supported.
diff --git a/source/_integrations/airzone_cloud.markdown b/source/_integrations/airzone_cloud.markdown
index a4f4145f8d9..f0ea4164fb5 100644
--- a/source/_integrations/airzone_cloud.markdown
+++ b/source/_integrations/airzone_cloud.markdown
@@ -3,7 +3,7 @@ title: Airzone Cloud
description: Instructions on how to integrate Airzone Cloud within Home Assistant.
ha_release: 2023.6
ha_category:
- - Binary Sensor
+ - Binary sensor
- Sensor
ha_iot_class: Cloud Polling
ha_config_flow: true
@@ -45,7 +45,7 @@ Password:
description: "Cloud API password"
{% endconfiguration_basic %}
-## Binary Sensors
+## Binary sensors
For each Airzone system (HVAC machine), the following *binary sensors* are created:
diff --git a/source/_integrations/aladdin_connect.markdown b/source/_integrations/aladdin_connect.markdown
index 1c2b01eb3ec..ce995ea79ff 100644
--- a/source/_integrations/aladdin_connect.markdown
+++ b/source/_integrations/aladdin_connect.markdown
@@ -16,7 +16,7 @@ ha_codeowners:
ha_config_flow: true
---
-The `aladdin_connect` cover platform lets you control Genie Aladdin Connect garage doors through Home Assistant.
+The Aladdin Connect integration lets you control Genie Aladdin Connect garage doors through Home Assistant.
Only doors that are owned by your Aladdin Connect account will be available. Doors that your account has been granted shared access to are not yet supported.
diff --git a/source/_integrations/alarm_control_panel.ifttt.markdown b/source/_integrations/alarm_control_panel.ifttt.markdown
index f7eab602254..f058f4c4b33 100644
--- a/source/_integrations/alarm_control_panel.ifttt.markdown
+++ b/source/_integrations/alarm_control_panel.ifttt.markdown
@@ -1,5 +1,5 @@
---
-title: "IFTTT Alarm Control Panel"
+title: "IFTTT Alarm control panel"
description: "Instructions on how to integrate IFTTT-controlled security systems into Home Assistant."
ha_category:
- Alarm
diff --git a/source/_integrations/alarm_control_panel.markdown b/source/_integrations/alarm_control_panel.markdown
index c61e5d01576..93c83687121 100644
--- a/source/_integrations/alarm_control_panel.markdown
+++ b/source/_integrations/alarm_control_panel.markdown
@@ -1,6 +1,6 @@
---
-title: Alarm Control Panel
-description: Instructions on how to integrate Alarm Control Panels into Home Assistant.
+title: Alarm control panel
+description: Instructions on how to integrate Alarm control panels into Home Assistant.
ha_category:
- Alarm
ha_release: 0.7.3
diff --git a/source/_integrations/alarm_control_panel.mqtt.markdown b/source/_integrations/alarm_control_panel.mqtt.markdown
index 8233242327d..2cf9458ed65 100644
--- a/source/_integrations/alarm_control_panel.mqtt.markdown
+++ b/source/_integrations/alarm_control_panel.mqtt.markdown
@@ -1,6 +1,6 @@
---
-title: "MQTT Alarm Control Panel"
-description: "Instructions on how to integrate MQTT capable Alarm Panels into Home Assistant."
+title: "MQTT Alarm control panel"
+description: "Instructions on how to integrate MQTT capable alarm panels into Home Assistant."
ha_category:
- Alarm
ha_release: 0.7.4
diff --git a/source/_integrations/alarm_control_panel.template.markdown b/source/_integrations/alarm_control_panel.template.markdown
index 6f2743256e4..431204ddb7b 100644
--- a/source/_integrations/alarm_control_panel.template.markdown
+++ b/source/_integrations/alarm_control_panel.template.markdown
@@ -1,6 +1,6 @@
---
-title: "Template Alarm Control Panel"
-description: "Instructions on how to integrate Template Alarm Control Panels into Home Assistant."
+title: "Template Alarm control panel"
+description: "Instructions on how to integrate template alarm control panels into Home Assistant."
ha_category:
- Alarm
ha_release: 0.105
@@ -23,7 +23,7 @@ In optimistic mode, the alarm control panel will immediately change state after
## Configuration
-To enable a Template Alarm Control Panel in your installation, add the following to your `configuration.yaml` file:
+To enable a template alarm control panel in your installation, add the following to your `configuration.yaml` file:
{% raw %}
@@ -129,6 +129,6 @@ State-based template entities have the special template variable `this` availabl
## Considerations
-If you are using the state of an integration that takes extra time to load, the Template Alarm Control Panel may get an `unknown` state during startup. This results in error messages in your log file until that integration has completed loading. If you use `is_state()` function in your template, you can avoid this situation.
+If you are using the state of an integration that takes extra time to load, the template alarm control panel may get an `unknown` state during startup. This results in error messages in your log file until that integration has completed loading. If you use `is_state()` function in your template, you can avoid this situation.
For example, you would replace {% raw %}`{{ states.switch.source.state == 'on' }}`{% endraw %} with this equivalent that returns `true`/`false` and never gives an unknown result: {% raw %}`{{ is_state('switch.source', 'on') }}`{% endraw %}
diff --git a/source/_integrations/alarmdecoder.markdown b/source/_integrations/alarmdecoder.markdown
index 8f0b97ecb77..1d88191a2fb 100644
--- a/source/_integrations/alarmdecoder.markdown
+++ b/source/_integrations/alarmdecoder.markdown
@@ -3,7 +3,7 @@ title: AlarmDecoder
description: Instructions on how to integrate a DSC/Honeywell alarm panel with Home Assistant using an AlarmDecoder device.
ha_category:
- Alarm
- - Binary Sensor
+ - Binary sensor
- Sensor
ha_release: 0.43
ha_iot_class: Local Push
@@ -16,34 +16,34 @@ ha_platforms:
ha_integration_type: integration
---
-The `alarmdecoder` integration will allow Home Assistant users who own either a DSC or Honeywell alarm panel to leverage their alarm system and its sensors to provide Home Assistant with rich information about their homes. Connectivity between Home Assistant and the alarm panel is accomplished through a device produced by Nu Tech Software Solutions, known as the AlarmDecoder. The AlarmDecoder devices provide a serial, TCP/IP socket or USB interface to the alarm panel, where it emulates an alarm keypad.
+The **AlarmDecoder** {% term integration %} will allow Home Assistant users who own either a DSC or Honeywell alarm panel to leverage their alarm system and its sensors to provide Home Assistant with rich information about their homes. Connectivity between Home Assistant and the alarm panel is accomplished through a device produced by Nu Tech Software Solutions, known as the AlarmDecoder. The AlarmDecoder devices provide a serial, TCP/IP socket or USB interface to the alarm panel, where it emulates an alarm keypad.
Please visit the [AlarmDecoder website](https://www.alarmdecoder.com/) for further information about the AlarmDecoder devices.
-There is currently support for the following device types within Home Assistant:
+There is currently support for the following {% term device %} types within Home Assistant:
-- [Alarm Control Panel](#alarm-control-panel): Reports on alarm status, and can be used to arm/disarm the system
+- [Alarm control panel](#alarm-control-panel): Reports on alarm status, and can be used to arm/disarm the system
- Sensor: Emulates a keypad display
-- Binary Sensor: Reports on zone status
+- Binary sensor: Reports on zone status
-This is a fully event-based integration. Any event sent by the AlarmDecoder device will be immediately reflected within Home Assistant.
+This is a fully event-based integration. Any {% term event %} sent by the AlarmDecoder device will be immediately reflected within Home Assistant.
{% include integrations/config_flow.md %}
You will be prompted to select a protocol (i.e. `socket` or `serial`). Depending on your selection, you will be asked for the following connection information:
- **socket**:
- - **host** - the hostname or IP address of the machine connected to the AlarmDecoder device
- - **port** - the port that AlarmDecoder is accessible on (i.e. `10000`)
+ - **host** - The hostname or IP address of AlarDecoder device that is connected to your alarm panel.
+ - **port** - The port that AlarmDecoder is accessible on (i.e. `10000`).
- **serial**:
- - **path** - the path to the AlarmDecoder device (i.e. `/dev/ttyUSB0`)
- - **baud rate** - the baud rate of the AlarmDecoder device (i.e. `115200`)
+ - **path** - The path to the AlarmDecoder device (i.e. `/dev/ttyUSB0`).
+ - **baud rate** - The baud rate of the AlarmDecoder device (i.e. `115200`).
## Settings
-Once AlarmDecoder has been set up according to the instructions above, the arming settings and zones can be configured by selecting _Options_ on the _AlarmDecoder_ card on the **{% my integrations title="Settings -> Devices & Services" %}** page.
+Once AlarmDecoder has been set up according to the instructions above, the arming settings and zones can be configured by selecting _Options_ on the _AlarmDecoder_ card on the **{% my integrations title="Settings > Devices & services" %}** page.
-### Arming Settings
+### Arming settings
There are currently 3 arming settings for AlarmDecoder (shown below).
@@ -55,25 +55,25 @@ There are currently 3 arming settings for AlarmDecoder (shown below).
Zones can be added, edited, and removed through the option forms.
-Each zone that's added to AlarmDecoder will have its own [binary sensor](https://www.home-assistant.io/integrations/binary_sensor/) created.
+Each {% term zone %} that's added to AlarmDecoder will have its own [binary sensor](https://www.home-assistant.io/integrations/binary_sensor/) created.
-#### Adding a New Zone
+#### Adding a new zone
-When prompted, enter the number of the zone you'd like to add. Press _Submit_ to move to the next screen where you'll be prompted for the [zone settings](#zone-settings). Press _Submit_ again to save.
+When prompted, enter the number of the {% term zone %} you'd like to add. Select _Submit_ to move to the next screen, where you'll be prompted for the [zone settings](#zone-settings). Select _Submit_ again to save.
**Note:** The zone number that was entered will appear as an attribute on the binary sensor entity that's created in order to easily edit the zone settings at a later time.
-#### Editing an Existing Zone
+#### Editing an existing zone
-When prompted, enter the number of the zone you'd like to edit. Press _Submit_ to move to the next screen where the existing zone settings will be pre-filled. Edit the zone settings and press _Submit_ to save the changes.
+When prompted, enter the number of the {% term zone %} you'd like to edit. Select _Submit_ to move to the next screen, where the existing zone settings will be pre-filled. Edit the zone settings and select _Submit_ to save the changes.
-#### Removing an Existing Zone
+#### Removing an existing zone
-When prompted, enter the number of the zone you'd like to remove. Press _Submit_ to move to the next screen where the existing zone settings will be pre-filled. Clear the _Zone Name_ field and press _Submit_.
+When prompted, enter the number of the {% term zone %} you'd like to remove. Select _Submit_ to move to the next screen, where the existing zone settings will be pre-filled. Clear the _Zone Name_ field and select _Submit_.
-#### Zone Settings
+#### Zone settings
-The settings for zones are described below:
+The settings for {% term zone %} are described below:
- **Zone Name** - a name for the zone
- **Zone Type** - the type of sensor (see [Device Classes](https://www.home-assistant.io/integrations/binary_sensor/#device-class))
@@ -82,7 +82,7 @@ The settings for zones are described below:
- **Relay Address** - (optional) Address of the relay or zone expander board to associate with the zone. (ex: 12, 13, 14, or 15). Typically used in cases where a panel will not send bypassed zones such as motion during an armed home state, the Vista 20P is an example of this. AlarmDecoder can emulate a zone expander board and the panel can be programmed to push zone events to this virtual expander. This allows the bypassed zone binary sensors to be utilized. One example is using bypassed motion sensors at night for motion-based automated lights while the system is armed with the motion sensor bypassed.
- **Relay Channel** - (optional) Channel of the relay or zone expander board to associate with the zone. (ex: 1, 2, 3, or 4 for relay expander boards, 1 - 8 for zone expander boards)
-## Alarm Control Panel
+## Alarm control panel
There are several attributes available on the alarm panel to give you more information about your alarm.
@@ -100,7 +100,7 @@ There are several attributes available on the alarm panel to give you more infor
## Services
-The Alarm Decoder integration gives you access to several services for you to control your alarm with.
+The **Alarm Decoder** {% term integration %} gives you access to several {% term services %} for you to control your alarm with.
- `alarm_arm_away`: Arms the alarm in away mode; all faults will trigger the alarm.
- `alarm_arm_home`: Arms the alarm in stay mode; faults to the doors or windows will trigger the alarm.
@@ -117,9 +117,9 @@ The Alarm Decoder integration gives you access to several services for you to co
### Examples
-Using a combination of the available services and attributes, you can create switch templates.
+Using a combination of the available {% term services %} and attributes, you can create switch templates.
-### Chime Status and Control
+### Chime status and control
{% raw %}
@@ -159,7 +159,7 @@ Using a combination of the available services and attributes, you can create swi
{% endraw %}
-## Arming Key Sequences
+## Arming key sequences
The tables below show the key press sequences used for arming for the different panel brands and configuration setting combinations. They are taken from the [adext](https://pypi.org/project/adext/) PyPI package.
diff --git a/source/_integrations/alert.markdown b/source/_integrations/alert.markdown
index c3671c4a0f8..2733e4cb7a5 100644
--- a/source/_integrations/alert.markdown
+++ b/source/_integrations/alert.markdown
@@ -29,7 +29,7 @@ State | Description
`on` | The condition for the alert is true.
`off` | The condition for the alert is true but it was acknowledged.
-### Basic Example
+### Basic example
The `alert` integration makes use of any of the `notification` integrations. To
setup the `alert` integration, first, you must setup a `notification` integration.
@@ -149,7 +149,7 @@ alert:
- john_phone_sms
```
-### Complex Alert Criteria
+### Complex alert criteria
By design, the `alert` integration only handles very simple criteria for firing.
That is, it only checks if a single entity's state is equal to a value. At some
@@ -184,7 +184,7 @@ This example will begin firing as soon as the entity `sensor.motion`'s `battery`
attribute falls below 15. It will continue to fire until the battery attribute
raises above 15 or the alert is acknowledged on the frontend.
-### Dynamic Notification Delay Times
+### Dynamic notification delay times
It may be desirable to have the delays between alert notifications dynamically
change as the alert continues to fire. This can be done by setting the `repeat`
@@ -215,7 +215,7 @@ following notification.
For example, if the garage door opens at 2:00, a notification will be
sent at 2:15, 2:45, 3:45, 4:45, etc., continuing every 60 minutes.
-### Message Templates
+### Message templates
It may be desirable to have the alert notifications include information
about the state of the entity. [Templates][template]
diff --git a/source/_integrations/alexa.intent.markdown b/source/_integrations/alexa.intent.markdown
index 06a160ff05f..8312e935bc4 100644
--- a/source/_integrations/alexa.intent.markdown
+++ b/source/_integrations/alexa.intent.markdown
@@ -80,7 +80,7 @@ Next you need to create a Lambda function.
- Go back to your Alexa skill and go to the Custom->Endpoint menu option on the left.
- Paste the ARN value in the "Default Region". Note: you will not be able to do this until you have completed the step above adding the Alexa Skills Kit trigger (done in the previous step) to the AWS Lambda Function.
-### Account Linking
+### Account linking
Alexa can link your Amazon account to your Home Assistant account. Therefore Home Assistant can make sure only authenticated Alexa requests are actioned. In order to link the account, you have to make sure your Home Assistant instance can be accessed from the Internet.
@@ -232,7 +232,7 @@ Here we are using [templates] to take the name we gave to Alexa e.g., `downstair
Now say `Alexa ask Home Assistant to activate ` and Alexa will activate that scene for you.
-### Adding Scripts
+### Adding scripts
We can easily extend the above idea to work with scripts as well. As before, add an intent for scripts:
@@ -395,6 +395,16 @@ text: !include alexa_confirm.yaml
Alexa will now respond with a random phrase each time. You can use the include for as many different intents as you like so you only need to create the list once.
+## Workaround for having to say the skill's name
+
+Sometimes, you want to run script or scene intents without using the skill's name. For example, 'Alexa ``' instead of 'Alexa ask Home Assistant to run ``' because it is shorter.
+
+You can do this by using Alexa routines.
+1. Configure a routine in the Alexa app that responds to the command you want to use:
+ - For example, 'Alexa, turn on the dryer'.
+2. Make sure this routine includes a customized action that contains the full phrase you configured in your skill:
+ - For example, 'Alexa, ask Home Assistant to run the dryer on script'.
+
[amazon-dev-console]: https://developer.amazon.com
[large-icon]: /images/integrations/alexa/alexa-512x512.png
[small-icon]: /images/integrations/alexa/alexa-108x108.png
diff --git a/source/_integrations/alexa.smart_home.markdown b/source/_integrations/alexa.smart_home.markdown
index 1298c50d3ff..51ecabf6073 100644
--- a/source/_integrations/alexa.smart_home.markdown
+++ b/source/_integrations/alexa.smart_home.markdown
@@ -41,7 +41,7 @@ Steps to Integrate an Amazon Alexa Smart Home Skill with Home Assistant:
- [Account Linking](#account-linking)
- [Alexa Smart Home Integration Configuration](#alexa-smart-home-integration-configuration)
- [Supported Platforms](#supported-platforms)
- - [Alarm Control Panel](#alarm-control-panel)
+ - [Alarm control panel](#alarm-control-panel)
- [Arming](#arming)
- [Disarming](#disarming)
- [Alert, Automation, Group](#alert-automation-group)
@@ -221,7 +221,7 @@ Now remove the long-lived access token (if you want), copy the ARN of your Lambd
- Click `SMART HOME` in the left navigation bar of build page.
- Fill in `Default endpoint` under `2. Smart Home service endpoint` using the `ARN` you copied from your Lambda function configuration.
-## Account Linking
+## Account linking
Alexa needs to link your Amazon account to your Home Assistant account. Therefore Home Assistant can make sure only authenticated Alexa requests are able to access your home's devices. In order to link the account, you have to make sure your Home Assistant can be accessed from Internet at port 443.
@@ -383,7 +383,7 @@ alexa:
type: string
{% endconfiguration %}
-### Alexa Locale
+### Alexa locale
The `locale` should match the location and language used for your Amazon echo devices.
@@ -407,7 +407,7 @@ The supported locales are:
See [List of Capability Interfaces and Supported Locales][alexa-supported-locales].
-### Proactive Events
+### Proactive events
The `endpoint`, `client_id` and `client_secret` are optional, and are only required if you want to enable Alexa's proactive mode (i.e., "Send Alexa Events" enabled). Please note the following if you want to enable proactive mode:
@@ -415,7 +415,7 @@ The `endpoint`, `client_id` and `client_secret` are optional, and are only requi
- The `client_id` and `client_secret` are not the ones used by the skill that have been set up using "Login with Amazon" (in the [Alexa Developer Console][alexa-dev-console]: Build > Account Linking), but rather from the "Alexa Skill Messaging" (in the Alexa Developer Console: Build > Permissions > Alexa Skill Messaging). To get them, you need to enable the "Send Alexa Events" permission.
- If the "Send Alexa Events" permission was not enabled previously, you need to unlink and relink the skill using the Alexa App, or else Home Assistant will show the following error: "Token invalid and no refresh token available. Also, you need to restart your Home Assistant after each disabling/enabling the skill in Alexa."
-### Configure Filter
+### Configure filter
By default, no entity will be excluded. To limit which entities are being exposed to Alexa, you can use the `filter` parameter. Keep in mind that only [supported platforms](#supported-platforms) can be added.
@@ -452,13 +452,13 @@ Devices such as cameras, garage doors, and alarm control panels require specific
See [Alexa Display Categories][alexa-display-categories] for a complete list
-## Supported Platforms
+## Supported platforms
Home Assistant supports the following integrations through Alexa using a Smart Home Skill. For Home Assistant Cloud Users, documentation can be found [here](https://www.nabucasa.com/config/amazon_alexa/).
The following platforms are currently supported:
-- [Alarm Control Panel](#alarm-control-panel)
+- [Alarm control panel](#alarm-control-panel)
- [Arming](#arming)
- [Disarming](#disarming)
- [Alert, Automation, Group](#alert-automation-group)
@@ -510,9 +510,9 @@ The following platforms are currently supported:
- [Timer](#timer)
- [Vacuum](#vacuum)
-### Alarm Control Panel
+### Alarm control panel
-Arm and disarm Alarm Control Panel entities. Ask Alexa for the state of the Alarm Control Panel entity.
+Arm and disarm Alarm control panel entities. Ask Alexa for the state of the alarm control panel entity.
- _"Alexa, arm my home in away mode."_
- _"Alexa, arm my home."_
@@ -521,27 +521,27 @@ Arm and disarm Alarm Control Panel entities. Ask Alexa for the state of the Alar
#### Arming
-The Alarm Control Panel state must be in the `disarmed` state before arming. Alexa does not support switching from an armed state without first disarming, e.g., switching from `armed_home` to `armed_night`.
+The alarm control panel state must be in the `disarmed` state before arming. Alexa does not support switching from an armed state without first disarming, e.g., switching from `armed_home` to `armed_night`.
-The Alarm Control Panel state `armed_custom_bypass` isn't supported by Alexa and is treated as `armed_home`.
+The alarm control panel state `armed_custom_bypass` isn't supported by Alexa and is treated as `armed_home`.
-Alexa does not support arming with voice PIN at this time. Therefore if the Alarm Control Panel requires a `code` for arming or the `code_arm_required` attribute is `true`, the entity will not be exposed during discovery.
-The Alarm Control Panel may default the `code_arm_required` attribute to `true` even if the platform does not support or require it. Use the [Entity Customization Tool](/docs/configuration/customizing-devices/#customization-using-the-ui) to override `code_arm_required` to `false` and expose the Alarm Control Panel during discovery.
+Alexa does not support arming with voice PIN at this time. Therefore if the alarm control panel requires a `code` for arming or the `code_arm_required` attribute is `true`, the entity will not be exposed during discovery.
+The alarm control panel may default the `code_arm_required` attribute to `true` even if the platform does not support or require it. Use the [entity customization tool](/docs/configuration/customizing-devices/#customization-using-the-ui) to override `code_arm_required` to `false` and expose the alarm control panel during discovery.
#### Disarming
-Users must opt-in to the disarm by voice feature in the Alexa App. Alexa will require a 4 digit voice personal identification number (PIN) for disarming. Configure a 4 digit PIN in the Alexa app, or use an existing 4 digit PIN code configured for the Alarm Control Panel.
+Users must opt-in to the disarm by voice feature in the Alexa App. Alexa will require a 4 digit voice personal identification number (PIN) for disarming. Configure a 4 digit PIN in the Alexa app, or use an existing 4 digit PIN code configured for the alarm control panel.
-To use the existing code configured for the Alarm Control Panel the `code` must be 4 digits and the `code_format` attribute must be `number`. After discovery, the Alexa app will offer the ability to use the existing `code`, or create an additional 4 digit PIN to use with Alexa.
+To use the existing code configured for the alarm control panel the `code` must be 4 digits and the `code_format` attribute must be `number`. After discovery, the Alexa app will offer the ability to use the existing `code`, or create an additional 4 digit PIN to use with Alexa.
The existing code is never communicated to Alexa from Home Assistant. During disarming, Alexa will ask for a PIN. The PIN spoken to Alexa is relayed to Home Assistant and passed to the `alarm_control_panel.alarm_disarm` service. If the `alarm_control_panel.alarm_disarm` service fails for any reason, it is assumed the PIN was incorrect and reported to Alexa as an invalid PIN.
@@ -553,7 +553,7 @@ Turn on and off Alert, Automation, and Group entities as switches.
- _"Alexa, turn off energy saving automations."_
- _"Alexa, Downstairs to on."_
-### Binary Sensor
+### Binary sensor
Requires [Proactive Events](#proactive-events) enabled.
@@ -600,7 +600,7 @@ In order to enable this, buttons will appear to have "presence detection" capabi
-#### Doorbell Announcement with binary_sensor
+#### Doorbell announcement with binary_sensor
Requires [Proactive Events](#proactive-events) enabled.
@@ -755,7 +755,7 @@ Covers that support tilt position can be controlled using percentages.
Currently, Alexa only supports friendly name synonyms for the `en-US` locale.
-#### Garage Doors
+#### Garage doors
Covers with a `device_class` of `garage` support the Open by Voice PIN feature in the Alexa app. Configure a 4 digit PIN code to open the garage door in the Alexa app.
@@ -768,7 +768,7 @@ Covers with a `device_class` of `garage` support the Open by Voice PIN feature i
Requires [Proactive Events](#proactive-events) enabled.
-#### Doorbell Events
+#### Doorbell events
Home Assistant `event` entities can trigger a doorbell announcement in Alexa if the `device_class` of the `event` entity is set to `doorbell`.
Alexa will announce on all echo devices _"Someone is at the [entity name]"_ when an `event` entity has received an updated.
@@ -786,7 +786,7 @@ Each Amazon Echo device will need the communication and announcements setting en
Control fan speed, direction, and oscillation.
-#### Fan Speed
+#### Fan speed
The fan device must support percentage based speeds with the `percentage` attribute.
diff --git a/source/_integrations/alpha_vantage.markdown b/source/_integrations/alpha_vantage.markdown
index 940f0aadddf..5f837f1c9ec 100644
--- a/source/_integrations/alpha_vantage.markdown
+++ b/source/_integrations/alpha_vantage.markdown
@@ -73,7 +73,7 @@ foreign_exchange:
type: string
{% endconfiguration %}
-## API Information
+## API information
Alpha Vantage offers two tiers of the API key, one free and one paid for. If you are using the free version you will be limited to five queries per minute. This means that you'll likely only be able to have one or two ticker entries. The paid version starts at thirty queries per minute increasing ticker quantity quite a bit.
diff --git a/source/_integrations/amberelectric.markdown b/source/_integrations/amberelectric.markdown
index e1bb24d075e..b74b52d5f4c 100644
--- a/source/_integrations/amberelectric.markdown
+++ b/source/_integrations/amberelectric.markdown
@@ -18,11 +18,11 @@ ha_integration_type: integration
[Amber](https://www.amber.com.au/) is an Australian electricity retailer that provides access to wholesale electricity prices. Customers monitor the wholesale price and shift their energy usage to cheaper, greener times. This saves them money and supports the shift to a more renewably-powered Australia.
-Using this integration, customers can go a step further - setting up devices to automatically shift energy usage to cheaper and greener times, based on real-time electricity prices and forecasts
+Using the **Amber Electric** {% term integration %}, customers can go a step further - setting up devices to automatically shift energy usage to cheaper and greener times, based on real-time electricity prices and forecasts
## Getting an API Key
-To use this integration, you will need to generate an API key.
+To use this {% term integration %}, you will need to generate an API key.
1. Login to your Amber account at:
2. Click _Settings_
@@ -41,7 +41,7 @@ Prices are split up into three channel types:
- **Controlled Load** - A special channel that is only activated during off-peak times. Often electric hot water systems are connected to the controlled load channel.
- **Feed In** - A channel that records exported power from solar panels and batteries.
-It exposes the following sensors for each channel type:
+It exposes the following {% term sensors %} for each channel type:
- **Price** - Your current electricity price in $/kWh
- **Forecast** - The forecasted prices for the next 12 hours
diff --git a/source/_integrations/ambiclimate.markdown b/source/_integrations/ambiclimate.markdown
index bb9d9292603..be06f490186 100644
--- a/source/_integrations/ambiclimate.markdown
+++ b/source/_integrations/ambiclimate.markdown
@@ -45,7 +45,7 @@ Note that you have to select manual mode from the Ambiclimate app to be able to
{% include integrations/config_flow.md %}
-## Integration services
+## Integration {% term services %}
Enable comfort mode on your AC:
diff --git a/source/_integrations/ambient_station.markdown b/source/_integrations/ambient_station.markdown
index a9a3f3865a5..4d47a8ddee0 100644
--- a/source/_integrations/ambient_station.markdown
+++ b/source/_integrations/ambient_station.markdown
@@ -16,12 +16,12 @@ ha_platforms:
ha_integration_type: hub
---
-The `Ambient Weather Station` integration retrieves local weather information
+The **Ambient Weather Station** {% term integration %} retrieves local weather information
via personal weather stations from [Ambient Weather](https://ambientweather.net).
## Prerequisites
-Using this integration requires both an Application Key and an API Key. To
+Using this {% term integration %} requires both an Application Key and an API Key. To
generate both, simply utilize the profile section of
[your Ambient Weather dashboard](https://dashboard.ambientweather.net).
diff --git a/source/_integrations/amcrest.markdown b/source/_integrations/amcrest.markdown
index 4a011bd7f24..b9e93737f43 100644
--- a/source/_integrations/amcrest.markdown
+++ b/source/_integrations/amcrest.markdown
@@ -2,7 +2,7 @@
title: Amcrest
description: Instructions on how to integrate Amcrest (or Dahua) IP cameras within Home Assistant.
ha_category:
- - Binary Sensor
+ - Binary sensor
- Camera
- Hub
- Sensor
@@ -21,9 +21,9 @@ ha_integration_type: integration
The `amcrest` camera platform allows you to integrate your [Amcrest](https://amcrest.com/) or Dahua IP camera or doorbell in Home Assistant.
-There is currently support for the following device types within Home Assistant:
+There is currently support for the following {% term device %} types within Home Assistant:
-- Binary Sensor
+- Binary sensor
- Camera
- Sensor
@@ -167,13 +167,13 @@ Newer Amcrest firmware may not work, then `rtsp` is recommended instead.
make sure to follow the steps mentioned at [FFmpeg](/integrations/ffmpeg/)
documentation to install the `ffmpeg`.
-### Streaming vs Polled Binary Sensors
+### Streaming vs polled binary sensors
Some binary sensors provide two choices for method of operation: streaming or polled. Streaming is more responsive and causes less network traffic because the camera will tell Home Assistant when the sensor's state has changed. Polled mode queries the camera periodically (every five seconds) to check the state of the sensor. Therefore streaming is the better option. However, some camera models and versions of camera firmware do not seem to implement the streaming method properly. Therefore the polled mode is also available. It is recommended to use the streaming mode (e.g., `motion_detected`) first, and if that doesn't work (e.g., results in constant errors), then try the polled mode instead (e.g., `motion_detected_polled`.)
## Events
-Once loaded, the Amcrest integration will generate (Home Assistant) events when it receives event notifications in the stream sent by the camera. This is only possible if the camera model and firmware implement the streaming method (see [above](#streaming-vs-polled-binary-sensors)). The event type is `amcrest` and the data is as follows:
+Once loaded, the Amcrest integration will generate (Home Assistant) {% term events %} when it receives event notifications in the stream sent by the camera. This is only possible if the camera model and firmware implement the streaming method (see [above](#streaming-vs-polled-binary-sensors)). The event type is `amcrest` and the data is as follows:
```json
{
@@ -190,9 +190,9 @@ The event code is sent by Amcrest or Dahua devices in the payload as a "Code" me
## Services
-Once loaded, the `amcrest` integration will expose services that can be called to perform various actions. The `entity_id` service attribute can specify one or more specific cameras, or `all` can be used to specify all configured Amcrest cameras.
+Once loaded, the `amcrest` integration will expose {% term services %} that can be called to perform various actions. The `entity_id` service attribute can specify one or more specific cameras, or `all` can be used to specify all configured Amcrest cameras.
-Available services:
+Available {% term services %}:
`enable_audio`, `disable_audio`,
`enable_motion_recording`, `disable_motion_recording`,
`enable_recording`, `disable_recording`,
@@ -202,7 +202,7 @@ Available services:
### Service `enable_audio`/`disable_audio`
-These services enable or disable the camera's audio stream.
+These {% term services %} enable or disable the camera's audio stream.
Service data attribute | Optional | Description
-|-|-
@@ -210,7 +210,7 @@ Service data attribute | Optional | Description
### Service `enable_motion_recording`/`disable_motion_recording`
-These services enable or disable the camera to record a clip to its configured storage location when motion is detected.
+These {% term services %} enable or disable the camera to record a clip to its configured storage location when motion is detected.
Service data attribute | Optional | Description
-|-|-
@@ -226,7 +226,7 @@ Service data attribute | Optional | Description
### Service `goto_preset`
-This service will cause the camera to move to one of the PTZ locations configured within the camera.
+This service will cause the camera to move to one of the PTZ locations configured within the camera.
Service data attribute | Optional | Description
-|-|-
@@ -244,7 +244,7 @@ Service data attribute | Optional | Description
### Service `start_tour`/`stop_tour`
-These services start or stop the camera's PTZ tour function.
+These services start or stop the camera's PTZ tour function.
Service data attribute | Optional | Description
-|-|-
@@ -252,7 +252,7 @@ Service data attribute | Optional | Description
### Service `ptz_control`
-If your Amcrest or Dahua camera supports PTZ, you will be able to pan, tilt or zoom your camera.
+If your Amcrest or Dahua camera supports PTZ, you will be able to pan, tilt or zoom your camera.
Service data attribute | Optional | Description
-|-|-
@@ -396,7 +396,7 @@ elements:
movement: zoom_out
```
-## Advanced Configuration
+## Advanced configuration
You can also use this more advanced configuration example:
@@ -424,9 +424,9 @@ amcrest:
- ptz_preset
```
-## Example Automation to Detect Button Presses on AD110 and AD410 Doorbells
+## Example automation to detect button presses on AD110 and AD410 doorbells
-Using this trigger in an automation will allow you to detect the press of the doorbell call button and create automations based upon it.
+Using this {% term trigger %} in an {% term automation %} will allow you to detect the press of the doorbell call button and create automations based upon it.
```yaml
# Example automations.yaml entry
diff --git a/source/_integrations/ampio.markdown b/source/_integrations/ampio.markdown
index 9ea9aa968c8..5527cb9a22e 100644
--- a/source/_integrations/ampio.markdown
+++ b/source/_integrations/ampio.markdown
@@ -18,7 +18,7 @@ The `ampio` air quality platform will query the open data API of [ampio.pl](http
To get the ID of a station you need to contact Ampio directly.
-## Manual Configuration
+## Manual configuration
To enable this platform, add the following lines to your `configuration.yaml` file:
diff --git a/source/_integrations/analytics.markdown b/source/_integrations/analytics.markdown
index 29da513a91e..af84d7ec1cf 100644
--- a/source/_integrations/analytics.markdown
+++ b/source/_integrations/analytics.markdown
@@ -17,7 +17,7 @@ ha_integration_type: system
Home Assistant allows users to share their usage data via the analytics integration. The aggregated data is available at . It is used to influence Home Assistant development priorities and to convince manufacturers to add local control and privacy-focused features.
-## Data Collection
+## Data collection
The information sent depends on what options you opt-in to. You can opt-in during onboarding and by going to **{% my analytics title="Settings > System > Analytics" %}** .
diff --git a/source/_integrations/android_ip_webcam.markdown b/source/_integrations/android_ip_webcam.markdown
index 92c6473c18e..9932dece87e 100644
--- a/source/_integrations/android_ip_webcam.markdown
+++ b/source/_integrations/android_ip_webcam.markdown
@@ -2,7 +2,7 @@
title: Android IP Webcam
description: Connect Android devices as an IP webcam to Home Assistant
ha_category:
- - Binary Sensor
+ - Binary sensor
- Camera
- Hub
- Sensor
@@ -21,13 +21,13 @@ ha_codeowners:
- '@engrbm87'
---
-The Android IP Webcam integration connects with Android IP Webcam to turn any Android phone or tablet into a network camera with multiple viewing options.
+The **Android IP Webcam** {% term integration %} connects with Android IP Webcam to turn any Android phone or tablet into a network camera with multiple viewing options.
-The integration is setup as an MJPEG camera with all settings as switches inside Home Assistant. You can also integrate the sensors exposed by the app. If you have multiple phones, you can use all options inside a list.
+The {% term integration %} is setup as an MJPEG camera with all settings as switches inside Home Assistant. You can also integrate the sensors exposed by the app. If you have multiple phones, you can use all options inside a list.
-There is currently support for the following device types within Home Assistant:
+There is currently support for the following {% term device %} types within Home Assistant:
-- Binary Sensor
+- Binary sensor
- Camera
- Sensor
- Switch
@@ -40,6 +40,6 @@ Download [Android IP Webcam app](https://play.google.com/store/apps/details?id=c
-You need to enable logging in the Android app (`Data logging` > `Enable data logging`) if you wish to see the sensor states in Home Assistant. The sensor states stay as `unknown`, until this is enabled.
+You need to enable logging in the Android app (`Data logging` > `Enable data logging`) if you wish to see the sensor states in Home Assistant. The {% term sensor %} {% term states %} stay as `unknown`, until this is enabled.
diff --git a/source/_integrations/androidtv.markdown b/source/_integrations/androidtv.markdown
index a24c394984d..294f9011212 100644
--- a/source/_integrations/androidtv.markdown
+++ b/source/_integrations/androidtv.markdown
@@ -2,7 +2,7 @@
title: Android Debug Bridge
description: Instructions on how to integrate Android and Fire TV devices into Home Assistant.
ha_category:
- - Media Player
+ - Media player
ha_release: 0.7.6
ha_config_flow: true
ha_iot_class: Local Polling
@@ -16,11 +16,11 @@ ha_platforms:
ha_integration_type: device
---
-The Android Debug Bridge integration allows you to control an Android device or [Amazon Fire TV](https://www.amazon.com/b/?node=8521791011) device.
+The **Android Debug Bridge** {% term integration %} allows you to control an Android device or [Amazon Fire TV](https://www.amazon.com/b/?node=8521791011) device.
-When setting up this integration, it is recommended that you do NOT use an ADB server and instead use the built-in Python ADB implementation. This simplifies the setup and makes it easier to troubleshoot issues. If there are stability issues with this approach, then you may wish to try using an ADB server. See the [ADB Setup](#adb-setup) section for more information.
+When setting up this {% term integration %}, it is recommended that you do NOT use an ADB server and instead use the built-in Python ADB implementation. This simplifies the setup and makes it easier to troubleshoot issues. If there are stability issues with this approach, then you may wish to try using an ADB server. See the [ADB Setup](#adb-setup) section for more information.
@@ -60,7 +60,7 @@ Configure State Detection Rules:
description: Here you can configure a list of rules where the rule key is the app IDs and whose values are lists of state detection rules. As example a valid value for a detection rule is `["standby", {"playing":{"media_session_state":4}}, {"paused":{"media_session_state":3, "wake_lock_size":4}}]`. Note that rule values must be always inside square bracket (`[...]`). See the section [Custom State Detection](#custom-state-detection) for more info.
{% endconfiguration_basic %}
-## ADB Setup
+## ADB setup
This integration works by sending ADB commands to your Android / Fire TV device. There are two ways to accomplish this.
@@ -94,7 +94,7 @@ To configure ADB server on integration setup, you need to enable [advanced mode]
Using this approach, Home Assistant will send the ADB commands to the server, which will then send them to the Android / Fire TV device and report back to Home Assistant. To use this option, add the `adb_server_ip` option to your configuration. If you are running the server on the same machine as Home Assistant, you can use `127.0.0.1` for this value.
-## ADB Troubleshooting
+## ADB troubleshooting
If the setup for your Android or Fire TV device fails, then there is probably an issue with your ADB connection. Here are some possible causes.
@@ -108,7 +108,7 @@ If the setup for your Android or Fire TV device fails, then there is probably an
5. Some Android devices (e.g., Philips TVs running Android TV) only accept the initial ADB connection request over their Wi-Fi interface. If you have the TV wired, you need to connect it to Wi-Fi and try the initial connection again. Once the authentication has been granted via Wi-Fi, you can connect to the TV over the wired interface as well.
-6. If your device drops off WiFi, breaking the ADB connection and causing the entity to become unavailable in Home Assistant, you could install a wake lock utility (such as [Wakelock](https://github.com/d4rken/wakelock-revamp)) to prevent this from happening. Some users have reported this problem with Xiaomi Mi Box devices.
+6. If your device drops off WiFi, breaking the ADB connection and causing the {% term entity %} to become unavailable in Home Assistant, you could install a wake lock utility (such as [Wakelock](https://github.com/d4rken/wakelock-revamp)) to prevent this from happening. Some users have reported this problem with Xiaomi Mi Box devices.
7. If you are using the [Python ADB implementation](#1-python-adb-implementation) approach, as mentioned above, there may be some issues with newer devices. In this case, you should use the [ADB server](#2-adb-server) approach instead.
@@ -227,9 +227,9 @@ Similarly, you can use the `androidtv.upload` service to upload a file from Home
| `device_path` | no | The filepath on the Android / Fire TV device.
| `local_path` | no | The filepath on your Home Assistant instance.
-## Custom State Detection
+## Custom state detection
-The Android Debug Bridge integration works by polling the Android / Fire TV device at a regular interval and collecting a handful of properties. Unfortunately, there is no standard API for determining the state of the device to which all apps adhere. Instead, the backend `androidtv` package uses three of the properties that it collects to determine the state: `audio_state`, `media_session_state`, and `wake_lock_size`. The correct logic for determining the state differs depending on the current app, and the backend `androidtv` package implements app-specific state detection logic for a handful of apps. Of course, it is not feasible to implement custom logic for each and every app in the `androidtv` package. Moreover, the correct state detection logic may differ across devices and device configurations.
+The Android Debug Bridge {% term integration %} works by polling the Android / Fire TV device at a regular interval and collecting a handful of properties. Unfortunately, there is no standard API for determining the state of the device to which all apps adhere. Instead, the backend `androidtv` package uses three of the properties that it collects to determine the state: `audio_state`, `media_session_state`, and `wake_lock_size`. The correct logic for determining the state differs depending on the current app, and the backend `androidtv` package implements app-specific state detection logic for a handful of apps. Of course, it is not feasible to implement custom logic for each and every app in the `androidtv` package. Moreover, the correct state detection logic may differ across devices and device configurations.
The solution to this problem is the `state_detection_rules` configuration parameter, which allows you to provide your own rules for state detection. The keys are app IDs, and the values are lists of rules that are evaluated in order. Valid rules are:
diff --git a/source/_integrations/androidtv_remote.markdown b/source/_integrations/androidtv_remote.markdown
index 2acdbd4de4e..b96bc17d90b 100644
--- a/source/_integrations/androidtv_remote.markdown
+++ b/source/_integrations/androidtv_remote.markdown
@@ -2,7 +2,7 @@
title: Android TV Remote
description: Instructions on how to integrate Android TV Remote into Home Assistant.
ha_category:
- - Media Player
+ - Media player
- Remote
ha_release: 2023.5
ha_iot_class: Local Push
@@ -20,7 +20,7 @@ ha_platforms:
ha_integration_type: device
---
-The Android TV Remote integration allows you to control an Android TV and launching apps. For this to work the Android TV device needs to have [Android TV Remote Service](https://play.google.com/store/apps/details?id=com.google.android.tv.remote.service) which is pre-installed on most devices (Fire TV devices are a notable exception).
+The **Android TV Remote** {% term integration %} allows you to control an Android TV and launching apps. For this to work, the Android TV device needs to have [Android TV Remote Service](https://play.google.com/store/apps/details?id=com.google.android.tv.remote.service) which is pre-installed on most devices (Fire TV devices are a notable exception).
For a quick introduction on how to get started with Android TV Remote, check out this video:
@@ -30,7 +30,7 @@ For a quick introduction on how to get started with Android TV Remote, check out
## Media player
-This integration adds a `media_player` with basic playback and volume controls. The media player provides volume information and display name of current active app on the Android TV. Due to API limitations, the integration will not display the playback status. It is recommended to use this integration together with [Google Cast integration](/integrations/cast/). Two media players can be combined into one using the [Universal Media Player](/integrations/universal/) integration. See [Using with Google Cast](#using-with-google-cast) section for more details.
+This {% term integration %} adds a `media_player` with basic playback and volume controls. The media player provides volume information and display name of current active app on the Android TV. Due to API limitations, the integration will not display the playback status. It is recommended to use this integration together with [Google Cast integration](/integrations/cast/). Two media players can be combined into one using the [Universal Media Player](/integrations/universal/) integration. See [Using with Google Cast](#using-with-google-cast) section for more details.
Using the `media_player.play_media` service, you can launch applications via `Deep Links` and switch channels. Only `url` and `channel` media types are supported.
@@ -88,7 +88,7 @@ target:
### Using with Google Cast
-Android TV Remote integration provides information about the power status of the device and gives you the ability to control playback. However, it does not provide information about the currently playing content (media title, duration, play/pause state, etc.). In turn, [Google Cast](/integrations/cast/) integration does not provide reliable information about the power status of the device (e.g. on Android TV Home Screen) and does not allow to control playback in Android apps without [MediaSession](https://developer.android.com/reference/android/media/session/MediaSession) support. However, it can display full information about the content being played in supported apps. For convenience, you can combine two media players into one using [Universal Media Player](/integrations/universal/) integration. Universal Media Player will automatically select the appropriate active media player entity.
+Android TV Remote {% term integration %} provides information about the power status of the device and gives you the ability to control playback. However, it does not provide information about the currently playing content (media title, duration, play/pause state, etc.). In turn, [Google Cast](/integrations/cast/) integration does not provide reliable information about the power status of the device (e.g. on Android TV Home Screen) and does not allow to control playback in Android apps without [MediaSession](https://developer.android.com/reference/android/media/session/MediaSession) support. However, it can display full information about the content being played in supported apps. For convenience, you can combine two media players into one using [Universal Media Player](/integrations/universal/) integration. Universal Media Player will automatically select the appropriate active media player entity.
{% details "Example YAML configuration" %}
diff --git a/source/_integrations/anthemav.markdown b/source/_integrations/anthemav.markdown
index 9c652c92d3f..6d08d0b0515 100644
--- a/source/_integrations/anthemav.markdown
+++ b/source/_integrations/anthemav.markdown
@@ -2,7 +2,7 @@
title: Anthem A/V Receivers
description: Instructions on how to integrate Anthem A/V Receivers into Home Assistant.
ha_category:
- - Media Player
+ - Media player
ha_iot_class: Local Push
ha_release: 0.37
ha_domain: anthemav
@@ -14,9 +14,9 @@ ha_platforms:
ha_integration_type: integration
---
-Both [Anthem]'s current and last generation of A/V Receivers and Processors support IP-based, network control. This Home Assistant platform adds proper "local push" support for any of these receivers on your network.
+Both [Anthem]'s current and last generation of A/V receivers and processors support IP-based network control. This Home Assistant {% term integration %} adds proper "local push" support for any of these receivers on your network.
-## Supported Models
+## Supported models
### A/V Receiver
@@ -28,12 +28,12 @@ Both [Anthem]'s current and last generation of A/V Receivers and Processors supp
- [AVM 60](https://www.anthemav.com/products-current/model=avm-60/page=overview)
-### Distribution Solution
+### Distribution solution
- [MDX 8](https://www.anthemav.com/products-current/type=distribution/model=mdx-8/page=overview), [MDX 16](https://www.anthemav.com/products-current/type=distribution/model=mdx-16/page=overview)
- Martin Logan [MDA 8](https://www.martinlogan.com/en/product/mda8), [MDA 16](https://www.martinlogan.com/en/product/mda16)
-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 this page on GitHub** link above.
+If your model is not on the list, please give it a test. If everything works correctly, then add it to the list by selecting the **Edit this page on GitHub** link above.
Support is provided through the Python [anthemav] module. Older, RS-232 serial-based units like the [D2v series](https://www.anthemav.com/products-archived/model=d2v/page=overview) use a different protocol entirely and are not currently supported.
@@ -49,15 +49,14 @@ port:
description: The port number of the device.
{% endconfiguration_basic %}
-## Notes and Limitations
+## Notes and limitations
- The tuner is currently unsupported as are the `media_player` play, pause, prev, and next controls.
-- Enabling this platform will set and enforce "Standby IP Control On" in your Anthem device. You almost certainly want this. If you disable it on the device, it will just get re-enabled by Home Assistant.
+- Enabling this platform will set and enforce **Standby IP Control On** on your Anthem device. You almost certainly want this. If you disable it on the device, it will just get re-enabled by Home Assistant.
-This platform will maintain a persistent connection to the network control port which will prevent any other application from communicating with the receiver. This includes the Anthem iOS and Android remote control apps as well as the ARC-2 Anthem Room Calibration software. You will need to disable this platform and restart Home Assistant if you want to use another
-application that makes use of the network control port.
+The {% term integration %} will maintain a persistent connection to the network control port which will prevent any other application from communicating with the receiver. This includes the Anthem iOS and Android remote control apps as well as the ARC-2 Anthem Room Calibration software. If you want to use another application that makes use of the network control port, disable this {% term integration %} and restart Home Assistant.
*The underlying Python module has hooks for halting and resuming the network connection but those functions are currently unsupported by the Home Assistant platform.*
diff --git a/source/_integrations/apache_kafka.markdown b/source/_integrations/apache_kafka.markdown
index b6b4fd676ed..e8bfe7eb58e 100644
--- a/source/_integrations/apache_kafka.markdown
+++ b/source/_integrations/apache_kafka.markdown
@@ -11,13 +11,13 @@ ha_iot_class: Local Push
ha_integration_type: integration
---
-The `apache_kafka` integration sends all state changes to a
+The **Apache Kafka** {% term integration %} sends all state changes to a
[Apache Kafka](https://kafka.apache.org/) topic.
Apache Kafka is a real-time data pipeline that can read and write streams of data. It
stores its data safely in a distributed, replicated, fault-tolerant cluster.
-To use the `apache_kafka` integration in your installation, add the following to your
+To use the **Apache Kafka** {% term integration %} in your installation, add the following to your
`configuration.yaml` file:
```yaml
@@ -84,7 +84,7 @@ filter:
type: list
{% endconfiguration %}
-## Configure Filter
+## Configure filter
By default, no entity will be excluded. To limit which entities are being exposed to `Apache Kafka`, you can use the `filter` parameter.
diff --git a/source/_integrations/apcupsd.markdown b/source/_integrations/apcupsd.markdown
index 1d7aabe1b7a..da69c54853a 100644
--- a/source/_integrations/apcupsd.markdown
+++ b/source/_integrations/apcupsd.markdown
@@ -2,9 +2,9 @@
title: APC UPS Daemon
description: Instructions on how to integrate apcupsd status with Home Assistant.
ha_category:
- - Binary Sensor
+ - Binary sensor
- Sensor
- - System Monitor
+ - System monitor
ha_release: 0.13
ha_iot_class: Local Polling
ha_domain: apcupsd
@@ -21,7 +21,7 @@ ha_integration_type: integration
There is currently support for the following device types within Home Assistant:
-- [Binary Sensor](#binary-sensor)
+- [Binary sensor](#binary-sensor)
- [Sensor](#sensors)
## Home Assistant add-on installation
diff --git a/source/_integrations/apple_tv.markdown b/source/_integrations/apple_tv.markdown
index ca254f12ac4..2d8a9fc65c7 100644
--- a/source/_integrations/apple_tv.markdown
+++ b/source/_integrations/apple_tv.markdown
@@ -2,7 +2,7 @@
title: Apple TV
description: Instructions on how to integrate Apple TV devices into Home Assistant.
ha_category:
- - Media Player
+ - Media player
- Multimedia
- Remote
ha_iot_class: Local Push
@@ -27,7 +27,7 @@ There is currently support for the following entities within the Apple TV device
{% include integrations/config_flow.md %}
-## Media Player
+## Media player
The Apple TV media player platform will create a Media Player entity for each
Apple TV discovered on your network.
diff --git a/source/_integrations/application_credentials.markdown b/source/_integrations/application_credentials.markdown
index d0e8dd07a75..83aff2d5e50 100644
--- a/source/_integrations/application_credentials.markdown
+++ b/source/_integrations/application_credentials.markdown
@@ -12,7 +12,7 @@ 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.
-## Automatic Setup
+## Automatic setup
Some integrations like [Google Calendar](/integrations/google/) will automatically create application credentials as part of adding an integration. To view any entries:
1. Go to **{% my integrations title="Settings -> Devices & Services" %}**
@@ -22,7 +22,7 @@ Some integrations like [Google Calendar](/integrations/google/) will automatical
-## Manual Setup
+## Manual setup
Note that integrations that do not support cloud linking will prompt to setup Application Credentials
when setting up for the first time. You may also manually enter credentials with the following steps:
diff --git a/source/_integrations/aprs.markdown b/source/_integrations/aprs.markdown
index ca3de51bb64..5ea9e6b79b3 100644
--- a/source/_integrations/aprs.markdown
+++ b/source/_integrations/aprs.markdown
@@ -3,7 +3,7 @@ title: APRS
description: Instructions on how to use APRS to track devices in Home Assistant.
ha_release: 0.95
ha_category:
- - Presence Detection
+ - Presence detection
ha_iot_class: Cloud Push
ha_codeowners:
- '@PhilRW'
diff --git a/source/_integrations/aquostv.markdown b/source/_integrations/aquostv.markdown
index f0752cb1a4d..6432a827a54 100644
--- a/source/_integrations/aquostv.markdown
+++ b/source/_integrations/aquostv.markdown
@@ -2,7 +2,7 @@
title: Sharp Aquos TV
description: Instructions on how to integrate a Sharp Aquos TV into Home Assistant.
ha_category:
- - Media Player
+ - Media player
ha_release: 0.35
ha_iot_class: Local Polling
ha_domain: aquostv
diff --git a/source/_integrations/arcam_fmj.markdown b/source/_integrations/arcam_fmj.markdown
index d9bb30c4b86..417a60369e7 100644
--- a/source/_integrations/arcam_fmj.markdown
+++ b/source/_integrations/arcam_fmj.markdown
@@ -2,7 +2,7 @@
title: Arcam FMJ Receivers
description: Instructions on how to integrate Arcam FMJ Receivers into Home Assistant.
ha_category:
- - Media Player
+ - Media player
ha_release: 0.96
ha_iot_class: Local Polling
ha_config_flow: true
@@ -73,7 +73,7 @@ To trigger this IR command add an automation on the event `arcam.turn_on` filter
the `entity_id` of the `media_player` zone entity. This can be added using device automations
or manually using normal automations.
-### Serial Port to network gateway
+### Serial port to network gateway
Use a network to a serial port gateway to connect to the serial port of the
receiver. The serial port is always available and can power on the device.
diff --git a/source/_integrations/arest.markdown b/source/_integrations/arest.markdown
index 6a6acc2fbff..860d6b00afc 100644
--- a/source/_integrations/arest.markdown
+++ b/source/_integrations/arest.markdown
@@ -2,7 +2,7 @@
title: aREST
description: Instructions on how to integrate aREST within Home Assistant.
ha_category:
- - Binary Sensor
+ - Binary sensor
- DIY
- Sensor
- Switch
@@ -18,11 +18,11 @@ ha_integration_type: integration
There is currently support for the following device types within Home Assistant:
-- [Binary Sensor](#binary-sensor)
+- [Binary sensor](#binary-sensor)
- [Sensor](#sensor)
- [Switch](#switch)
-## Binary Sensor
+## Binary sensor
The `arest` binary sensor platform allows you to get all data from your devices (like Arduinos with an ethernet/Wi-Fi connection, the ESP8266, and the Raspberry Pi) running the [aREST](https://arest.io/) RESTful framework.
diff --git a/source/_integrations/arris_tg2492lg.markdown b/source/_integrations/arris_tg2492lg.markdown
index ded7ade0daf..d391a3433b9 100644
--- a/source/_integrations/arris_tg2492lg.markdown
+++ b/source/_integrations/arris_tg2492lg.markdown
@@ -2,7 +2,7 @@
title: Arris TG2492LG
description: Instructions on how to integrate Arris TG2492LG routers into Home Assistant.
ha_category:
- - Presence Detection
+ - Presence detection
ha_release: 0.109
ha_domain: arris_tg2492lg
ha_codeowners:
diff --git a/source/_integrations/aruba.markdown b/source/_integrations/aruba.markdown
index 15957cad246..0778e577d8a 100644
--- a/source/_integrations/aruba.markdown
+++ b/source/_integrations/aruba.markdown
@@ -2,7 +2,7 @@
title: Aruba
description: Instructions on how to integrate Aruba routers into Home Assistant.
ha_category:
- - Presence Detection
+ - Presence detection
ha_release: 0.7
ha_iot_class: Local Polling
ha_domain: aruba
diff --git a/source/_integrations/asuswrt.markdown b/source/_integrations/asuswrt.markdown
index 5bea3d5c2f8..ab57fc8c518 100644
--- a/source/_integrations/asuswrt.markdown
+++ b/source/_integrations/asuswrt.markdown
@@ -3,7 +3,7 @@ title: ASUSWRT
description: Instructions on how to integrate ASUSWRT into Home Assistant.
ha_category:
- Hub
- - Presence Detection
+ - Presence detection
- Sensor
ha_release: 0.83
ha_config_flow: true
@@ -34,7 +34,7 @@ You need to enable telnet on your router if you choose to use `protocol: telnet`
-### Sensors Configuration
+### Sensors configuration
These sensors are automatically created and associated to the router device:
diff --git a/source/_integrations/atag.markdown b/source/_integrations/atag.markdown
index 6803246f92f..09ea8ad0b2b 100644
--- a/source/_integrations/atag.markdown
+++ b/source/_integrations/atag.markdown
@@ -4,7 +4,7 @@ description: Instructions on how to setup Atag integration.
ha_category:
- Climate
- Sensor
- - Water Heater
+ - Water heater
ha_release: 0.109
ha_iot_class: Local Polling
ha_domain: atag
@@ -22,7 +22,7 @@ The `Atag` integration allows Home Assistant to connect to [Atag One](https://ww
The integration implements the following platforms:
- Climate
-- Water Heater
+- Water heater
- Sensor
{% include integrations/config_flow.md %}
@@ -62,9 +62,9 @@ This integration supports the following services (see [Climate](/integrations/cl
Currently selection of custom timeframes in Extend, Away and boost modes is not supported. The default settings can be changed on the device.
-## Water Heater
+## Water heater
-The Water Heater reports current and target temperature for Domestic Hot Water demand, as well as boiler status (heating or idle). This can be used to detect hot water demand, such as a running shower or tap water.
+The water heater reports current and target temperature for Domestic Hot Water demand, as well as boiler status (heating or idle). This can be used to detect hot water demand, such as a running shower or tap water.
Setting target values is currently not supported.
## Sensor
diff --git a/source/_integrations/august.markdown b/source/_integrations/august.markdown
index 83ea2502195..855ee3fda90 100644
--- a/source/_integrations/august.markdown
+++ b/source/_integrations/august.markdown
@@ -2,7 +2,7 @@
title: August
description: Instructions on how to integrate your August devices into Home Assistant.
ha_category:
- - Binary Sensor
+ - Binary sensor
- Button
- Camera
- Doorbell
@@ -29,7 +29,7 @@ The `august` integration allows you to integrate your [August](https://august.co
{% include integrations/config_flow.md %}
-## Known Working Devices
+## Known working devices
| Device | Requires [Connect Bridge](https://august.com/products/august-connect/) or Doorbell |
| --------------------------------- | ------------------------------------|
@@ -52,7 +52,7 @@ Other devices not listed above have not been tested and may not function as expe
There is currently support for the following device types within Home Assistant:
- Doorbell
-- Binary Sensor
+- Binary sensor
- Button
- Sensor
- Camera
@@ -62,7 +62,7 @@ There is currently support for the following device types within Home Assistant:
Most devices will need either August Connect Bridge or Doorbell to connect to Home Assistant.
-## Known Issues with battery reporting
+## Known issues with battery reporting
The August Wi-Fi Smart Lock (Gen 4) uses different battery technology (lithium-ion) than the other locks. The battery charge value reported by the lock detail API has frequently been reported as incorrect for these models.
@@ -76,7 +76,7 @@ While most entities can be updated via the push API, August/Yale does not offer
- Lock Battery sensor
- Lock Operation sensor
-## Binary Sensor
+## Binary sensor
If you have an August Doorbell, once you have enabled the August integration, you should see following sensors:
@@ -130,7 +130,7 @@ For locks that support the Yale Access system, the August integration can keep y
- If you do not know which account has the offline keys, configure August integration with each different Owner account until you find the one that holds the keys. You may need to make a new owner account and grant the account access to your lock to force the keys to synchronize with the cloud service.
- Ensure the lock is in range and discoverable by the [Yale Access Bluetooth integration](/integrations/yalexs_ble).
-## Presence Detection with Lock Operation
+## Presence detection with lock operation
Using the lock operation sensors, you can detect when a user operates a lock and is physically present (not remote). The below automation example (added to `automations.yaml`) will trigger when the user named “John Doe” in August locks or unlocks the door from the keypad (if present), via Bluetooth from their phone, or by auto-unlock. The state of the sensor will be the name of the party operating the lock as returned by August.
diff --git a/source/_integrations/august_ble.markdown b/source/_integrations/august_ble.markdown
index 23917be0013..4e86b17fe3e 100644
--- a/source/_integrations/august_ble.markdown
+++ b/source/_integrations/august_ble.markdown
@@ -2,7 +2,7 @@
title: August Bluetooth
description: Connect and control your August Bluetooth devices using the Yale Access Bluetooth integration
ha_category:
- - Binary Sensor
+ - Binary sensor
- Lock
- Sensor
ha_release: 2022.9
diff --git a/source/_integrations/aussie_broadband.markdown b/source/_integrations/aussie_broadband.markdown
index 6fa2d00d91d..715b27232a1 100644
--- a/source/_integrations/aussie_broadband.markdown
+++ b/source/_integrations/aussie_broadband.markdown
@@ -38,7 +38,7 @@ The integration will create sensor entities for a variety of metrics that relate
- Billing Cycle Length
- Billing Cycle Remaining
-#### Mobile Phone
+#### Mobile phone
- Data Usage
- National Calls
- Mobile Calls
diff --git a/source/_integrations/awair.markdown b/source/_integrations/awair.markdown
index ad7487f40eb..e8f0bb6d188 100644
--- a/source/_integrations/awair.markdown
+++ b/source/_integrations/awair.markdown
@@ -33,7 +33,7 @@ This integration refreshes once every 5 minutes, based on the [default per-devic
{% include integrations/config_flow.md %}
-## Available Sensors
+## Available sensors
The integration will fetch data from each device. The following sensors are supported:
diff --git a/source/_integrations/aws.markdown b/source/_integrations/aws.markdown
index bf4fa4d7a85..8eeb822529f 100644
--- a/source/_integrations/aws.markdown
+++ b/source/_integrations/aws.markdown
@@ -102,7 +102,7 @@ context:
type: string
{% endconfiguration %}
-## Lambda Notify Usage
+## Lambda notify usage
AWS Lambda is a notification platform and thus can be controlled by calling the `notify` service [as described here](/integrations/notify/). It will invoke a Lambda for all targets given in the notification payload. A target can be formatted as a function name, an entire ARN ([Amazon Resource Name](https://docs.aws.amazon.com/IAM/latest/UserGuide/reference-arns.html)) or a partial ARN. For more information, please see the [botocore documentation](https://botocore.amazonaws.com/v1/documentation/api/latest/reference/services/lambda/client/invoke.html).
@@ -130,7 +130,7 @@ The context will look like this:
}
```
-## SNS Notify Usage
+## SNS notify usage
AWS SNS is a notification platform and thus can be controlled by calling the `notify` service [as described here](/integrations/notify/). It will publish a message to all targets given in the notification payload. A target must be a SNS topic or endpoint ARN ([Amazon Resource Name](https://docs.aws.amazon.com/IAM/latest/UserGuide/reference-arns.html)). For more information, please see the [botocore documentation](https://botocore.amazonaws.com/v1/documentation/api/latest/reference/services/sns/client/publish.html).
diff --git a/source/_integrations/axis.markdown b/source/_integrations/axis.markdown
index b5bdd506078..6baa58ecc34 100644
--- a/source/_integrations/axis.markdown
+++ b/source/_integrations/axis.markdown
@@ -2,7 +2,7 @@
title: Axis
description: Integration between network devices from Axis Communications with Home Assistant.
ha_category:
- - Binary Sensor
+ - Binary sensor
- Camera
- Light
- Switch
@@ -58,7 +58,7 @@ If your device is not discovered. On your camera, go to **System Options** -> **
When creating an issue detailing a problem related to the integration make sure to share the device model and firmware as well as prepare logs. Logs might contain sensitive information so make sure to look through it before sharing.
-## Binary Sensor
+## Binary sensor
The following sensor types are supported:
diff --git a/source/_integrations/azure_event_hub.markdown b/source/_integrations/azure_event_hub.markdown
index 2d253115cdb..0db74eeca38 100644
--- a/source/_integrations/azure_event_hub.markdown
+++ b/source/_integrations/azure_event_hub.markdown
@@ -40,7 +40,7 @@ Not filtering domains or entities will send every event to Azure Event Hub, thus
Event Hubs have a retention time of at most 7 days, if you do not capture or use the events they are deleted automatically from the Event Hub, the default retention is 1 day.
-### Filter Configuration
+### Filter configuration
By default, no entity will be excluded. To limit which entities are being exposed to `Azure Event Hub`, you can use the `filter` parameter.
diff --git a/source/_integrations/baf.markdown b/source/_integrations/baf.markdown
index 3bcc4e2cab4..fda65b81485 100644
--- a/source/_integrations/baf.markdown
+++ b/source/_integrations/baf.markdown
@@ -2,7 +2,7 @@
title: Big Ass Fans
description: Instructions on how to integrate BAF devices into Home Assistant.
ha_category:
- - Binary Sensor
+ - Binary sensor
- Climate
- Fan
- Light
@@ -38,13 +38,13 @@ Integrates [Big Ass Fans](https://www.bigassfans.com/) devices into Home Assista
## Platforms
-### Binary Sensor
+### Binary sensor
-For devices that support Auto Comfort and are running firmware 3.1 or later, an occupancy sensor entity is available. The sensor has a hold time of about 5 minutes and pushes state updates.
+For devices that support Auto Comfort and are running firmware 3.1 or later, an occupancy sensor {% term entity %} is available. The sensor has a hold time of about 5 minutes and pushes state updates.
### Climate
-For devices that support Auto Comfort, a climate entity allows adjusting the target temperature.
+For devices that support Auto Comfort, a climate {% term entity %} allows adjusting the target temperature.
### Number
diff --git a/source/_integrations/balboa.markdown b/source/_integrations/balboa.markdown
index a933376bce3..588b785b520 100644
--- a/source/_integrations/balboa.markdown
+++ b/source/_integrations/balboa.markdown
@@ -2,7 +2,7 @@
title: Balboa Spa Client
description: Instructions on how to integrate Balboa Spa WiFi within Home Assistant.
ha_category:
- - Binary Sensor
+ - Binary sensor
- Climate
ha_release: 2021.12
ha_iot_class: Local Push
@@ -17,11 +17,11 @@ ha_config_flow: true
ha_integration_type: integration
---
-This integration adds support for [Balboa](https://www.balboawatergroup.com/) Spa WiFi Modules to be used within Home Assistant.
+The **Balboa Spa Client** {% term integration %} adds support for [Balboa](https://www.balboawatergroup.com/) Spa WiFi Modules to be used within Home Assistant.
There is currently support for the following device types within Home Assistant:
-- Binary Sensor (Filter cycles and circulation pumps)
+- Binary sensor (Filter cycles and circulation pumps)
- Climate
## Compatible hardware
diff --git a/source/_integrations/bayesian.markdown b/source/_integrations/bayesian.markdown
index 788f3897bdc..187aca26a54 100644
--- a/source/_integrations/bayesian.markdown
+++ b/source/_integrations/bayesian.markdown
@@ -2,7 +2,7 @@
title: Bayesian
description: Instructions on how to integrate threshold Bayesian sensors into Home Assistant.
ha_category:
- - Binary Sensor
+ - Binary sensor
- Utility
ha_iot_class: Local Polling
ha_release: 0.53
diff --git a/source/_integrations/bbox.markdown b/source/_integrations/bbox.markdown
index 05528fcb171..d060b9fcc8c 100644
--- a/source/_integrations/bbox.markdown
+++ b/source/_integrations/bbox.markdown
@@ -3,7 +3,7 @@ title: Bbox
description: Instructions on how to integrate Bouygues Bbox routers into Home Assistant.
ha_category:
- Network
- - Presence Detection
+ - Presence detection
- Sensor
ha_release: 0.31
ha_iot_class: Local Polling
@@ -25,7 +25,7 @@ There is currently support for the following device types within Home Assistant:
Due to third party limitation, the sensors will only be available if Home Assistant and the Bbox are on the same local area network. You can check this by going to 192.168.1.254 with your web browser.
-## Presence Detection
+## Presence detection
The `bbox` platform offers presence detection by looking at connected devices to a [Bbox](https://www.bouyguestelecom.fr/offres-internet/bbox-fit) based router from [Bouygues](https://www.bouyguestelecom.fr/), which is one of the main Internet provider in France.
diff --git a/source/_integrations/binary_sensor.markdown b/source/_integrations/binary_sensor.markdown
index 1b859ad3f91..38182471eb7 100644
--- a/source/_integrations/binary_sensor.markdown
+++ b/source/_integrations/binary_sensor.markdown
@@ -1,8 +1,8 @@
---
-title: Binary Sensor
+title: Binary sensor
description: Instructions on how-to setup binary sensors with Home Assistant.
ha_category:
- - Binary Sensor
+ - Binary sensor
ha_release: 0.9
ha_quality_scale: internal
ha_domain: binary_sensor
@@ -30,7 +30,7 @@ or using an [input boolean helper](/integrations/input_boolean).
{% include integrations/building_block_integration.md %}
-### Device Class
+### Device class
Knowing a sensor is binary impacts how the sensor's current state may be
represented in Home Assistant's UI (see [Dashboards](/dashboards/)). Opposing states
diff --git a/source/_integrations/binary_sensor.mqtt.markdown b/source/_integrations/binary_sensor.mqtt.markdown
index eaf7bffa4ca..4666b311bc0 100644
--- a/source/_integrations/binary_sensor.mqtt.markdown
+++ b/source/_integrations/binary_sensor.mqtt.markdown
@@ -1,8 +1,8 @@
---
-title: "MQTT Binary Sensor"
+title: "MQTT binary sensor"
description: "Instructions on how to integrate MQTT binary sensors within Home Assistant."
ha_category:
- - Binary Sensor
+ - Binary sensor
ha_release: 0.9
ha_iot_class: Configurable
ha_domain: mqtt
@@ -158,7 +158,7 @@ name:
description: The name of the binary sensor. Can be set to `null` if only the device name is relevant.
required: false
type: string
- default: MQTT Binary Sensor
+ default: MQTT binary sensor
object_id:
description: Used instead of `name` for automatic generation of `entity_id`
required: false
diff --git a/source/_integrations/binary_sensor.rest.markdown b/source/_integrations/binary_sensor.rest.markdown
index cf45239ef58..10e9f358dd3 100644
--- a/source/_integrations/binary_sensor.rest.markdown
+++ b/source/_integrations/binary_sensor.rest.markdown
@@ -1,8 +1,8 @@
---
-title: "RESTful Binary Sensor"
+title: "RESTful binary sensor"
description: "Instructions on how to integrate REST binary sensors into Home Assistant."
ha_category:
- - Binary Sensor
+ - Binary sensor
ha_release: "0.10"
ha_iot_class: Local Polling
ha_domain: rest
diff --git a/source/_integrations/binary_sensor.rflink.markdown b/source/_integrations/binary_sensor.rflink.markdown
index 9861e92944a..d7fe8e07747 100644
--- a/source/_integrations/binary_sensor.rflink.markdown
+++ b/source/_integrations/binary_sensor.rflink.markdown
@@ -1,8 +1,8 @@
---
-title: "RFLink Binary Sensor"
+title: "RFLink binary sensor"
description: "Instructions on how to integrate RFLink binary sensors into Home Assistant."
ha_category:
- - Binary Sensor
+ - Binary sensor
ha_iot_class: Local Push
ha_release: 0.81
ha_domain: rflink
diff --git a/source/_integrations/binary_sensor.xiaomi_aqara.markdown b/source/_integrations/binary_sensor.xiaomi_aqara.markdown
index 5f77aac02d1..af8af3e34ac 100644
--- a/source/_integrations/binary_sensor.xiaomi_aqara.markdown
+++ b/source/_integrations/binary_sensor.xiaomi_aqara.markdown
@@ -1,8 +1,8 @@
---
-title: "Xiaomi Binary Sensor"
+title: "Xiaomi binary sensor"
description: "Instructions on how to setup the Xiaomi binary sensors within Home Assistant."
ha_category:
- - Binary Sensor
+ - Binary sensor
ha_release: "0.50"
ha_iot_class: Local Push
ha_domain: xiaomi_aqara
@@ -342,7 +342,7 @@ The Aqara Wireless Switch is available as single-key and double-key version. Eac
{% endraw %}
-#### Vibration Sensor
+#### Vibration sensor
This automation toggles the living room lamp on vibration/tilt.
diff --git a/source/_integrations/blackbird.markdown b/source/_integrations/blackbird.markdown
index 5e5dc1e4808..aaef4de7f68 100644
--- a/source/_integrations/blackbird.markdown
+++ b/source/_integrations/blackbird.markdown
@@ -2,7 +2,7 @@
title: Monoprice Blackbird Matrix Switch
description: Instructions on how to integrate Monoprice Blackbird 4k 8x8 HDBaseT Matrix Switch into Home Assistant.
ha_category:
- - Media Player
+ - Media player
ha_release: 0.68
ha_iot_class: Local Polling
ha_domain: blackbird
diff --git a/source/_integrations/blink.markdown b/source/_integrations/blink.markdown
index ffaecc4066f..9b657aa9214 100644
--- a/source/_integrations/blink.markdown
+++ b/source/_integrations/blink.markdown
@@ -3,7 +3,7 @@ title: Blink
description: Instructions for how to integrate Blink camera/security system within Home Assistant.
ha_category:
- Alarm
- - Binary Sensor
+ - Binary sensor
- Camera
- Hub
- Sensor
@@ -22,7 +22,7 @@ ha_dhcp: true
ha_integration_type: integration
---
-The `blink` integration lets you view camera images and motion events from [Blink](https://blinkforhome.com/) camera and security systems.
+The **Blink** {% term integration %} lets you view camera images and motion events from [Blink](https://blinkforhome.com/) camera and security systems.
## Setup
@@ -51,7 +51,7 @@ Please note that each camera reports two different states: one as `sensor.blink_
## Services
-Any sequential calls to services relating to blink should have a minimum of a 5 second delay in between them to prevent the calls from being throttled and ignored.
+Any sequential calls to {% term services %} relating to blink should have a minimum of a 5 second delay in between them to prevent the calls from being throttled and ignored.
### `blink.blink_update`
@@ -89,7 +89,7 @@ Send a new pin to blink. Since Blink's 2FA implementation is new and changing,
| ---------------------- | -------- | ---------------------------- |
| `pin` | no | 2FA Pin received from blink. |
-### Other Services
+### Other services
In addition to the services mentioned above, there are generic `camera` and `alarm_control_panel` services available for use as well. The `camera.enable_motion_detection` and `camera.disable_motion_detection` services allow for individual cameras to be enabled and disabled, respectively, within the Blink system. The `alarm_control_panel.alarm_arm_away` and `alarm_control_panel.alarm_disarm` services allow for the whole system to be armed and disarmed, respectively. Blink Mini cameras linked to an existing sync module cannot be armed/disarmed individually via Home Assistant.
@@ -97,7 +97,7 @@ In addition to the services mentioned above, there are generic `camera` and `ala
The following are some examples showing how to correctly make service calls using Blink:
-### Snap Picture and Save Locally
+### Snap picture and save locally
This example script shows how to take a picture with your camera, named `My Camera` in your Blink app (this is **not necessarily** the friendly name in Home Assistant). After snapping a picture, the image will then be saved to a local directory called `/tmp/my_image.jpg`. Note that this example makes use of services found in the [camera integration](/integrations/camera#service-snapshot)
@@ -116,7 +116,7 @@ sequence:
filename: /tmp/my_image.jpg
```
-### Arm Blink When Away
+### Arm Blink when away
This example automation will arm your blink sync module to detect motion on any of your blink cameras that have motion detection enabled. By default, Blink enables motion detection on all cameras so, unless you've changed anything in your app, you're all set. If you want to manually enable motion detection for individual cameras, you can utilize the [appropriate camera service](/integrations/camera#service-enable_motion_detection) but please note that motion will only be captured if the sync module is armed.
@@ -135,7 +135,7 @@ Here, this example assumes your blink module is named `My Sync Module` and that
entity_id: alarm_control_panel.blink_my_sync_module
```
-### Disarm Blink When Home
+### Disarm Blink when home
Similar to the previous example, this automation will disarm blink when arriving home.
@@ -152,7 +152,7 @@ Similar to the previous example, this automation will disarm blink when arriving
entity_id: alarm_control_panel.blink_my_sync_module
```
-### Save Most Recent Video Locally When Motion Detected
+### Save most recent video locally when motion detected
When motion is detected, you can use the Blink Home Assistant integration to save the last recorded video locally, rather than relying on Blink's servers to save your data.
@@ -176,7 +176,7 @@ The following example assumes your camera's name (in the Blink app) is `My Camer
{% endraw %}
-### Save All Recent Clips Locally on a Schedule
+### Save all recent clips locally on a schedule
A list of all the recent video clips is updated at each refresh of the Blink system.
The video clips are available in a download list (per camera) for up to an hour,
diff --git a/source/_integrations/bloomsky.markdown b/source/_integrations/bloomsky.markdown
index 45701b51b28..a56e6e01b6b 100644
--- a/source/_integrations/bloomsky.markdown
+++ b/source/_integrations/bloomsky.markdown
@@ -2,7 +2,7 @@
title: BloomSky
description: Instructions on how to integrate the BloomSky within Home Assistant.
ha_category:
- - Binary Sensor
+ - Binary sensor
- Camera
- Environment
- Sensor
@@ -17,11 +17,11 @@ ha_platforms:
ha_integration_type: integration
---
-The `bloomsky` integration allows you to access your [BloomSky](https://www.bloomsky.com/) weather station's.
+The **BloomSky** {% term integration %} allows you to access your [BloomSky](https://www.bloomsky.com/) weather station's.
There is currently support for the following device types within Home Assistant:
-- [Binary Sensor](#binary-sensor)
+- [Binary sensor](#binary-sensor)
- [Camera](#camera)
- [Sensor](#sensor)
@@ -46,7 +46,7 @@ api_key:
type: string
{% endconfiguration %}
-## Binary Sensor
+## Binary sensor
The `bloomsky` binary sensor platform allows you to get data from your BloomSky device.
diff --git a/source/_integrations/bluemaestro.markdown b/source/_integrations/bluemaestro.markdown
index 9727498058d..b4fe97c95ff 100644
--- a/source/_integrations/bluemaestro.markdown
+++ b/source/_integrations/bluemaestro.markdown
@@ -22,6 +22,6 @@ Integrates [BlueMaestro](https://www.sigmawit.com/) devices into Home Assistant.
- Tempo Disc THD
- Tempo Disc THPD
-The BlueMaestro integration will automatically discover devices once the [Bluetooth](/integrations/bluetooth) integration is enabled and functional.
+The **BlueMaestro** {% term integration %} will automatically discover devices once the [Bluetooth](/integrations/bluetooth) integration is enabled and functional.
{% include integrations/config_flow.md %}
diff --git a/source/_integrations/bluesound.markdown b/source/_integrations/bluesound.markdown
index 2c68c631955..7f96c63b25e 100644
--- a/source/_integrations/bluesound.markdown
+++ b/source/_integrations/bluesound.markdown
@@ -2,7 +2,7 @@
title: Bluesound
description: Instructions on how to integrate Bluesound devices into Home Assistant.
ha_category:
- - Media Player
+ - Media player
ha_release: 0.51
ha_iot_class: Local Polling
ha_domain: bluesound
diff --git a/source/_integrations/bluetooth.markdown b/source/_integrations/bluetooth.markdown
index 22c823ddb4b..60e052700e1 100644
--- a/source/_integrations/bluetooth.markdown
+++ b/source/_integrations/bluetooth.markdown
@@ -15,7 +15,7 @@ ha_platforms:
- diagnostics
---
-The Bluetooth integration will detect nearby Bluetooth devices. Discovered devices will show up in the discovered section on the integrations page in the configuration panel.
+The **Bluetooth** {% term integration %} will detect nearby Bluetooth devices. Discovered devices will show up in the discovered section on the integrations page in the configuration panel.
{% include integrations/config_flow.md %}
@@ -77,7 +77,7 @@ On Debian based host systems, the `sudo apt-get -y install bluez` command will i
{% enddetails %}
-## Installing a USB Bluetooth Adapter
+## Installing a USB Bluetooth adapter
Some systems may not come with Bluetooth and require a USB adapter. Installing an adapter for the first time may require multiple restarts for the device to be fully recognized.
@@ -85,7 +85,7 @@ If you experience an unreliable Bluetooth connection, installing a short USB ext
### Known working high-performance adapters
-#### Cambridge Silicon Radio (CSR) Based adapters
+#### Cambridge Silicon Radio (CSR) -based adapters
- ANNE PRO CSR 4.0 (CSR8510A10)
- Avantree BTDG-40S (CSR8510A10)
@@ -234,7 +234,7 @@ The following methods are known to work to add multiple adapters:
Integrations that have followed the [Best practices for library authors](https://developers.home-assistant.io/docs/bluetooth/?_highlight=Best+practices#best-practices-for-library-authors) will automatically connect via the adapter with the best signal and failover to an active adapter if one becomes unavailable.
-## Passive Scanning
+## Passive scanning
Passive Scanning on Linux can be enabled in the options flow per adapter if the host system runs BlueZ 5.63 or later with experimental features enabled. This functionality is available with Home Assistant Operating System 9.4 and later.
diff --git a/source/_integrations/bluetooth_le_tracker.markdown b/source/_integrations/bluetooth_le_tracker.markdown
index 8983980fff5..bdd5fef0122 100644
--- a/source/_integrations/bluetooth_le_tracker.markdown
+++ b/source/_integrations/bluetooth_le_tracker.markdown
@@ -2,7 +2,7 @@
title: Bluetooth LE Tracker
description: Instructions for integrating bluetooth low-energy tracking within Home Assistant.
ha_category:
- - Presence Detection
+ - Presence detection
ha_iot_class: Local Push
ha_release: 0.27
ha_domain: bluetooth_le_tracker
@@ -17,7 +17,7 @@ Devices discovered are stored with 'BLE_' as the prefix for device mac addresses
## Setup
-This integration requires the [Bluetooth](/integrations/bluetooth) integration to be enabled and functional.
+This {% term integration %} requires the [Bluetooth](/integrations/bluetooth) integration to be enabled and functional.
## Configuration
diff --git a/source/_integrations/bluetooth_tracker.markdown b/source/_integrations/bluetooth_tracker.markdown
index 1cd221f3f00..8be816b65f0 100644
--- a/source/_integrations/bluetooth_tracker.markdown
+++ b/source/_integrations/bluetooth_tracker.markdown
@@ -2,7 +2,7 @@
title: Bluetooth Tracker
description: Instructions for integrating Bluetooth tracking within Home Assistant.
ha_category:
- - Presence Detection
+ - Presence detection
ha_iot_class: Local Polling
ha_release: 0.18
ha_domain: bluetooth_tracker
diff --git a/source/_integrations/bmw_connected_drive.markdown b/source/_integrations/bmw_connected_drive.markdown
index 6387acd88e3..06a9f7ae834 100644
--- a/source/_integrations/bmw_connected_drive.markdown
+++ b/source/_integrations/bmw_connected_drive.markdown
@@ -2,13 +2,13 @@
title: BMW Connected Drive
description: Instructions on how to setup your BMW Connected Drive account with Home Assistant.
ha_category:
- - Binary Sensor
+ - Binary sensor
- Button
- Car
- Lock
- Notifications
- Number
- - Presence Detection
+ - Presence detection
- Select
- Sensor
- Switch
@@ -33,19 +33,19 @@ ha_platforms:
ha_integration_type: integration
---
-The `bmw_connected_drive` integration lets you retrieve data of your BMW vehicle from the BMW Connected Drive portal. You need to have a working BMW Connected Drive account and a Connected Drive enabled vehicle for this to work.
+The **BMW Connected Drive** {% term integration %} lets you retrieve data of your BMW vehicle from the BMW Connected Drive portal. You need to have a working BMW Connected Drive account and a Connected Drive enabled vehicle for this to work.
-The `bmw_connected_drive` integration also works with (recent) Mini vehicles. You need to have a working Mini Connected account, and a Mini Connected enabled vehicle for this to work.
+The **BMW Connected Drive** {% term integration %} also works with (recent) Mini vehicles. You need to have a working Mini Connected account, and a Mini Connected enabled vehicle for this to work.
-The entities available in Home Assistant heavily depend on your vehicle's capabilities (model year, headunit, etc.). The integration will make sure all available car attributes are added as entities.
+The {% term entities %} available in Home Assistant heavily depend on your vehicle's capabilities (model year, headunit, etc.). The integration will make sure all available car attributes are added as entities.
For compatibility with your BMW vehicle check the [bimmer_connected page](https://github.com/bimmerconnected/bimmer_connected) on GitHub.
This integration provides the following platforms:
-- Binary Sensors: Doors, windows, condition based services, check control messages, parking lights, door lock state, charging status (electric cars) and connections status (electric cars).
+- Binary sensors: Doors, windows, condition based services, check control messages, parking lights, door lock state, charging status (electric cars) and connections status (electric cars).
- Device tracker: The location of your car.
- [Lock](/integrations/bmw_connected_drive/#lock): Control the lock of your car.
- Sensors: Mileage, remaining range, remaining fuel, charging time remaining (electric cars), charging status (electric cars), remaining range electric (electric cars).
diff --git a/source/_integrations/bond.markdown b/source/_integrations/bond.markdown
index 878b453cab9..6ccff2d525c 100644
--- a/source/_integrations/bond.markdown
+++ b/source/_integrations/bond.markdown
@@ -29,7 +29,7 @@ ha_platforms:
ha_integration_type: integration
---
-The Bond integration allows you to control appliances through your [Bond Bridge](https://bondhome.io/). Duplicates your RF remote control.
+The **Bond** {% term integration %} allows you to control appliances through your [Bond Bridge](https://bondhome.io/). Duplicates your RF remote control.
Supported devices (see Requirements section below):
@@ -37,7 +37,7 @@ Supported devices (see Requirements section below):
- Shades
- Fireplaces
-## Tested Bond Devices
+## Tested Bond devices
The following devices have been tested with Home Assistant and confirmed to be working:
@@ -58,7 +58,7 @@ This integration supports Bond bridges with firmware v2.10.x and up.
Bond bridges with firmware v2.9.x and lower will **not** work correctly. Please
upgrade your firmware from Bond app before adding this integration.
-## BPUP Support (Push updates)
+## BPUP support (Push updates)
Firmware version 2.10.8 or newer is required for push updates. The integration
will fallback to polling for 2.10.x versions lower than .8
@@ -86,7 +86,7 @@ Calling this service will change the tracked power state of any bond switch but
### Service `bond.set_light_power_tracked_state`
Sets the tracked power state of a bond light.
-Calling this service will change the tracked power state of any bond light but not transmit any signal to make the device change its state.
+Calling this {% term service %} will change the tracked power state of any bond light but not transmit any signal to make the device change its state.
| Service data attribute | Optional | Description |
| ---------------------- | -------- | ----------- |
@@ -96,7 +96,7 @@ Calling this service will change the tracked power state of any bond light but n
### Service `bond.set_light_brightness_tracked_state`
Sets the tracked brightness state of a bond light
-Calling this service will change the tracked brightness state of any bond light but not transmit any signal to make the device change its state.
+Calling this {% term service %} will change the tracked brightness state of any bond light but not transmit any signal to make the device change its state.
| Service data attribute | Optional | Description |
| ---------------------- | -------- | ----------- |
diff --git a/source/_integrations/bosch_shc.markdown b/source/_integrations/bosch_shc.markdown
index 24beebe546b..1cb71ba0546 100644
--- a/source/_integrations/bosch_shc.markdown
+++ b/source/_integrations/bosch_shc.markdown
@@ -2,7 +2,7 @@
title: Bosch SHC
description: Integrate Bosch SHC.
ha_category:
- - Binary Sensor
+ - Binary sensor
- Cover
- Hub
- Sensor
@@ -22,18 +22,18 @@ ha_zeroconf: true
ha_integration_type: integration
---
-The Bosch SHC integration allows you to connect your [Bosch Smart Home Controller](https://www.bosch-smarthome.com) to Home Assistant in order to control and monitor your Bosch Smart Home devices.
+The **Bosch SHC** {% term integration %} allows you to connect your [Bosch Smart Home Controller](https://www.bosch-smarthome.com) to Home Assistant in order to control and monitor your Bosch Smart Home devices.
There is currently support for the following device types within Home Assistant:
-- [Binary Sensor](#binary-sensor)
+- [Binary sensor](#binary-sensor)
- [Cover](#cover)
- [Sensor](#sensor)
- [Switch](#switch)
{% include integrations/config_flow.md %}
-### Binary Sensor
+### Binary sensor
The binary sensor platform allows you to monitor the states of your shutter contact and battery sensors. Binary sensor devices are added for each of the following devices:
diff --git a/source/_integrations/brandt.markdown b/source/_integrations/brandt.markdown
index 5da28dfad11..039ff5c6386 100644
--- a/source/_integrations/brandt.markdown
+++ b/source/_integrations/brandt.markdown
@@ -3,7 +3,7 @@ title: Brandt Smart Control
description: Connect and control your Brandt Smart Control devices using the Overkiz integration
ha_category:
- Alarm
- - Binary Sensor
+ - Binary sensor
- Button
- Climate
- Cover
@@ -16,7 +16,7 @@ ha_category:
- Sensor
- Siren
- Switch
- - Water Heater
+ - Water heater
ha_domain: brandt
ha_integration_type: virtual
ha_supporting_domain: overkiz
diff --git a/source/_integrations/braviatv.markdown b/source/_integrations/braviatv.markdown
index b57e18efa82..5688534a7d8 100644
--- a/source/_integrations/braviatv.markdown
+++ b/source/_integrations/braviatv.markdown
@@ -3,7 +3,7 @@ title: Sony Bravia TV
description: Instructions on how to integrate a Sony Bravia TV into Home Assistant.
ha_category:
- Button
- - Media Player
+ - Media player
- Remote
ha_release: 0.23
ha_iot_class: Local Polling
@@ -20,7 +20,7 @@ ha_ssdp: true
ha_integration_type: device
---
-The Bravia TV integration allows you to control a [Sony Bravia TV](https://www.sony.com/).
+The **Bravia TV** {% term integration %} allows you to control a [Sony Bravia TV](https://www.sony.com/).
Almost all [Sony Bravia TV 2013 and newer](https://info.tvsideview.sony.net/en_ww/home_device.html#bravia) are supported. For older TVs see more generic methods to control your device [below](#for-tvs-older-than-2013).
@@ -35,22 +35,22 @@ The Bravia TV integration supports two types of authentication:
For more information, see [IP Control Authentication](https://pro-bravia.sony.net/develop/integrate/ip-control/index.html#ip-control-authentication).
-## Common Issues
+## Common issues
### TV does not generate new pin
If you have previously set up your TV with any Home Assistant instances via PIN code, you must remove Home Assistant from your TV in order for your TV to generate a new pin. To do this, you must do **one** of the following:
-- On your TV, go to: **Settings** -> **Network** -> **Remote device settings** -> **Deregister remote device**. Disable and re-enable the **Control remotely** after. Menu titles may differ slightly between models. If needed, refer to your specific model's [manual](https://www.sony.com/electronics/support/manuals) for additional guidance.
+- On your TV, go to: **Settings** > **Network** > **Remote device settings** > **Deregister remote device**. Disable and re-enable the **Control remotely** after. Menu titles may differ slightly between models. If needed, refer to your specific model's [manual](https://www.sony.com/electronics/support/manuals) for additional guidance.
- Reset your TV to factory condition.
-## Media Browser
+## Media browser
-Using the Media Browser, you can view a list of all installed applications and TV channels and launch them.
+Using the media browser, you can view a list of all installed applications and TV channels and launch them.
-## Play Media service
+## Play media service
-The `play_media` service can be used in a automation or script to switch to a specified application or TV channel. It selects the best matching application or channel according to the `media_content_id`:
+The `play_media` {% term service %} can be used in a automation or script to switch to a specified application or TV channel. It selects the best matching application or channel according to the `media_content_id`:
1. Channel number *(i.e., '1' or '6')*
2. Exact app or channel name *(i.e., 'Google Play' or 'CNN')*
diff --git a/source/_integrations/broadlink.markdown b/source/_integrations/broadlink.markdown
index bbeae98c9d8..30f80f575f7 100644
--- a/source/_integrations/broadlink.markdown
+++ b/source/_integrations/broadlink.markdown
@@ -25,7 +25,7 @@ ha_dhcp: true
ha_integration_type: integration
---
-The Broadlink integration allows you to control and monitor Broadlink universal remotes, smart plugs, power strips, switches and sensors. The following devices are supported:
+The **Broadlink** {% term integration %} allows you to control and monitor Broadlink universal remotes, smart plugs, power strips, switches and sensors. The following devices are supported:
- Thermostats: `Hysen HY02B05H` and `Floureon HY03WE`
- Power Strips: `MP1-1K3S2U` and `MP1-1K4S`
@@ -41,9 +41,9 @@ The Broadlink integration allows you to control and monitor Broadlink universal
There is no more need to set up platforms, except for custom IR/RF switches. Once the device is configured, all entities will be created automatically.
-The entities have the same name as the device by default. To change the name, icon or entity id, click the entity on the frontend and click the settings icon in the upper right. You can also disable the entity there if you don't think it is useful. Don't forget to click _Update_ to save your changes when you're done.
+The {% term entities %} have the same name as the device by default. To change the name, icon or entity id, select the entity on the frontend and select the settings icon in the upper right. You can also disable the entity there if you don't think it is useful. Don't forget to select **Update** to save your changes when you're done.
-The entities are divided into four subdomains:
+The {% term entities %} are divided into four subdomains:
- [Climate](#climate)
- [Remote](#remote)
@@ -57,7 +57,7 @@ The `climate` entities allow you to monitor and control Broadlink thermostats.
## Remote
-The `remote` entities allow you to learn and send codes with universal remotes. They are created automatically when you configure devices with IR/RF capabilities.
+The `remote` {% term entities %} allow you to learn and send codes with universal remotes. They are created automatically when you configure devices with IR/RF capabilities.
### Learning commands
@@ -335,15 +335,15 @@ script:
## Sensor
-The `sensor` entities allow you to monitor Broadlink sensors. These entities are created automatically when you configure a device that has sensors.
+The `sensor` {% term entities %} allow you to monitor Broadlink sensors. These entities are created automatically when you configure a device that has sensors.
## Light
-The `light` entities allow you to control Broadlink lights. You can turn them on and off, change brightness, adjust the color or set a color temperature. These entities are created automatically when you configure a device that has lights.
+The `light` {% term entities %} allow you to control Broadlink lights. You can turn them on and off, change brightness, adjust the color or set a color temperature. These entities are created automatically when you configure a device that has lights.
## Switch
-The `switch` entities allow you to control and monitor Broadlink smart plugs, power strips and switches. You can turn them on and off, and you can monitor their state and power consumption, when available. These entities are created automatically when you configure a device that has switches.
+The `switch` {% term entities %} allow you to control and monitor Broadlink smart plugs, power strips and switches. You can turn them on and off, and you can monitor their state and power consumption, when available. These entities are created automatically when you configure a device that has switches.
You can also define custom IR/RF switches to be controlled with universal remote devices.
@@ -560,7 +560,7 @@ First get or learn all the remotes you want to add to Home Assistant in e-Contro
This is the code we need to transmit again to replicate the same remote function.
-### Using Node red to Transmit Codes
+### Using Node-RED to transmit codes
1. Drag another RM node on the same flow we created earlier. The RM node should be configured to the RM device created earlier by default.
2. In the Action field, select - Set from msg.payload -.
diff --git a/source/_integrations/brother.markdown b/source/_integrations/brother.markdown
index 1f243077999..b8222e49034 100644
--- a/source/_integrations/brother.markdown
+++ b/source/_integrations/brother.markdown
@@ -2,7 +2,7 @@
title: Brother Printer
description: Instructions on how to integrate a Brother printer into Home Assistant.
ha_category:
- - System Monitor
+ - System monitor
ha_release: 0.104
ha_iot_class: Local Polling
ha_config_flow: true
@@ -17,7 +17,7 @@ ha_platforms:
ha_integration_type: device
---
-The `Brother Printer` integration allows you to read current data from your local Brother printer.
+The **Brother Printer** {% term integration %} allows you to read current data from your local Brother printer.
It usually provides information about the device's state, the left amount of ink or toner and the remaining lifetime of the drum or other parts of the printer.
The integration monitors every supported part.
@@ -37,7 +37,7 @@ For some Brother devices, `SNMPv3 read-write access and v1/v2c read-only access`
-## Sensor Example
+## Sensor example
You can configure Home Assistant to alert you when the printer jams or runs out of paper as follows. First, add the following to `configuration.yaml` under the `template:` section (Note: replace `sensor.hl_l2340d_status` with the actual name of your sensor):
diff --git a/source/_integrations/browser.markdown b/source/_integrations/browser.markdown
index 25bd63985ff..5f9da4012d2 100644
--- a/source/_integrations/browser.markdown
+++ b/source/_integrations/browser.markdown
@@ -10,7 +10,7 @@ ha_domain: browser
ha_integration_type: integration
---
-The `browser` integration provides a service to open URLs in the default browser on the host machine.
+The **Browser** {% term integration %} provides a service to open URLs in the default browser on the host machine.
## Configuration
@@ -23,7 +23,7 @@ browser:
### Services
-Once loaded, the `browser` platform will expose services that can be called to perform various actions.
+Once loaded, the `browser` platform will expose {% term services %} that can be called to perform various {% term actions %}.
Available services: `browser/browse_url`.
@@ -33,7 +33,7 @@ Available services: `browser/browse_url`.
### Usage
-To use this service, choose **Call Service** from the **Developer Tools**. Choose the service *browser/browse_url* from the list of **Available services:** and enter the URL into the **Service Data** field and hit **CALL SERVICE**.
+To use this {% term service %}, choose **Call Service** from the **Developer Tools**. Choose the service *browser/browse_url* from the list of **Available services:** and enter the URL into the **Service Data** field and hit **CALL SERVICE**.
```json
{"url": "http://www.google.com"}
diff --git a/source/_integrations/brunt.markdown b/source/_integrations/brunt.markdown
index a9ac16d5499..c83d6ddb51b 100644
--- a/source/_integrations/brunt.markdown
+++ b/source/_integrations/brunt.markdown
@@ -14,7 +14,7 @@ ha_config_flow: true
ha_integration_type: integration
---
-The `brunt` integration allows one to control Blind Engines by [Brunt](https://www.brunt.co). To use it, you need a Brunt App Account. All Brunt Blind devices registered to your account are automatically added to your Home Assistant with the names given them through the Brunt app.
+The **Brunt Blind Energy** {% term integration %} allows one to control Blind Engines by [Brunt](https://www.brunt.co). To use it, you need a Brunt App Account. All Brunt Blind devices registered to your account are automatically added to your Home Assistant with the names given them through the Brunt app.
This integration is not affiliated with Brunt and retrieves data from the endpoints of the mobile application. Use at your own risk.
diff --git a/source/_integrations/bsblan.markdown b/source/_integrations/bsblan.markdown
index aa425834b42..dfee654e41a 100644
--- a/source/_integrations/bsblan.markdown
+++ b/source/_integrations/bsblan.markdown
@@ -15,7 +15,7 @@ ha_platforms:
ha_integration_type: device
---
-This integration integrates [BSBLan](https://github.com/fredlcore/BSB-LAN) devices into Home Assistant.
+The **BSB-Lan** {% term integration %} integrates [BSBLan](https://github.com/fredlcore/BSB-LAN) devices into Home Assistant.
BSBLan is a device that is made by `Frederik Holst` and `Ulf Dieckmann` for documentation and with
the help of many other contributors.
diff --git a/source/_integrations/bt_home_hub_5.markdown b/source/_integrations/bt_home_hub_5.markdown
index ecb96312ee2..9d4182854dd 100644
--- a/source/_integrations/bt_home_hub_5.markdown
+++ b/source/_integrations/bt_home_hub_5.markdown
@@ -2,7 +2,7 @@
title: BT Home Hub 5
description: Instructions on how to integrate BT Home Hub 5 router into Home Assistant.
ha_category:
- - Presence Detection
+ - Presence detection
ha_release: 0.22
ha_domain: bt_home_hub_5
ha_iot_class: Local Polling
diff --git a/source/_integrations/bt_smarthub.markdown b/source/_integrations/bt_smarthub.markdown
index d8a0c40fa78..7374ab438fd 100644
--- a/source/_integrations/bt_smarthub.markdown
+++ b/source/_integrations/bt_smarthub.markdown
@@ -2,7 +2,7 @@
title: BT Smart Hub
description: Instructions on how to integrate BT Smart Hub router into Home Assistant.
ha_category:
- - Presence Detection
+ - Presence detection
ha_release: 0.82
ha_iot_class: Local Polling
ha_codeowners:
diff --git a/source/_integrations/bthome.markdown b/source/_integrations/bthome.markdown
index f93d10b4f00..21b1978d97b 100644
--- a/source/_integrations/bthome.markdown
+++ b/source/_integrations/bthome.markdown
@@ -26,4 +26,4 @@ BTHome is an energy effective but flexible BLE format to broadcast data with Blu
## Bindkey
-When using encryption for your BTHome sensor, you will prompted to enter your 32 character hexadecimal (16 bytes) encryption key. This key is called the bindkey. More information about the bindkey can be found in the [specifications](https://bthome.io/#encryption).
+When using encryption for your BTHome sensor, you will be prompted to enter your 32 character hexadecimal (16 bytes) encryption key. This key is called the bindkey. More information about the bindkey can be found in the [specifications](https://bthome.io/#encryption).
diff --git a/source/_integrations/bticino.markdown b/source/_integrations/bticino.markdown
index bf7a40d9b19..aa09269ca12 100644
--- a/source/_integrations/bticino.markdown
+++ b/source/_integrations/bticino.markdown
@@ -8,7 +8,7 @@ ha_category:
- Environment
- Hub
- Light
- - Media Source
+ - Media source
- Sensor
- Switch
- Weather
diff --git a/source/_integrations/bubendorff.markdown b/source/_integrations/bubendorff.markdown
index a3daffbc186..37b8690edac 100644
--- a/source/_integrations/bubendorff.markdown
+++ b/source/_integrations/bubendorff.markdown
@@ -8,7 +8,7 @@ ha_category:
- Environment
- Hub
- Light
- - Media Source
+ - Media source
- Sensor
- Switch
- Weather
diff --git a/source/_integrations/buienradar.markdown b/source/_integrations/buienradar.markdown
index e909169eabd..0adae5b4083 100644
--- a/source/_integrations/buienradar.markdown
+++ b/source/_integrations/buienradar.markdown
@@ -19,9 +19,9 @@ ha_platforms:
ha_integration_type: integration
---
-The Buienradar integration uses [buienradar.nl](https://buienradar.nl/) as a source for current meteorological data for your location. The weather forecast is delivered by Buienradar, who provides a web service that provides detailed weather information for users in The Netherlands.
+The **Buienradar** {% term integration %} uses [buienradar.nl](https://buienradar.nl/) as a source for current meteorological data for your location. The weather forecast is delivered by Buienradar, who provides a web service that provides detailed weather information for users in The Netherlands.
-The relevant weather station used will be automatically selected based on the location specified in the Home Assistant configuration (or in the Buienradar weather/sensor integration). A map of all available weather stations can be found [here](https://www.google.com/maps/d/embed?mid=1NivHkTGQUOs0dwQTnTMZi8Uatj0).
+The relevant weather station used will be automatically selected based on the location specified in the Home Assistant configuration (or in the Buienradar weather/sensor integration). A map of all available weather stations can be found [here](https://www.google.com/maps/d/embed?mid=1NivHkTGQUOs0dwQTnTMZi8Uatj0).
Besides the weather platform, there is currently support for the following additional device types:
@@ -37,13 +37,13 @@ The `buienradar` camera platform uses [buienradar.nl](https://buienradar.nl/) as
Internally, this integration uses the radar map image as [documented](https://www.buienradar.nl/overbuienradar/gratis-weerdata) on buienradar.nl.
The downloaded image is cached to prevent Home Assistant from making a new request to buienradar.nl multiple times a minute when Home Assistant checks for new stills from the camera.
-The camera entity is disabled by default and should be [enabled](/common-tasks/general/#enabling-entities) before it reads the camera images.
+The camera {% term entity %} is disabled by default and should be [enabled](/common-tasks/general/#enabling-entities) before it reads the camera images.
## Sensor
-The Buienradar integration will set up separate sensor entities with more detailed weather data. The selected weather station will provide all-weather data, with the exception of the forecasted precipitation. The forecasted precipitation data will be retrieved from Buienradar using your actual GPS location (and not the location of the nearest weather station). The sensor entities are disabled by default and should be enabled before they will be updated with data.
+The **Buienradar** {% term integration %} will set up separate sensor {% term entities %} with more detailed weather data. The selected weather station will provide all-weather data, with the exception of the forecasted precipitation. The forecasted precipitation data will be retrieved from Buienradar using your actual GPS location (and not the location of the nearest weather station). The sensor entities are disabled by default and should be enabled before they will be updated with data.
-The following entities will be created:
+The following {% term entities %} will be created:
- **Station name**: The name of the selected meteo-station
- **Barometer forecast**: A numeric barometric forecast (1 to 7)
diff --git a/source/_integrations/button.markdown b/source/_integrations/button.markdown
index f9b5e71408a..d6c43368b19 100644
--- a/source/_integrations/button.markdown
+++ b/source/_integrations/button.markdown
@@ -11,8 +11,8 @@ ha_codeowners:
ha_integration_type: entity
---
-A button entity is an entity that can fire an event / trigger an action towards
-a device or service but remains stateless from the Home Assistant perspective.
+A button {% term entity %} is an entity that can fire an {% term event %} / trigger an {% term action %} towards
+a {% term device %} or {% term service %} but remains stateless from the Home Assistant perspective.
It can be compared to a real live momentary switch, push-button, or some other
form of a stateless switch.
@@ -21,14 +21,14 @@ form of a stateless switch.
## The state of a button
-The button entity is stateless, as in, it cannot have a state like the `on` or
+The button {% term entity %} is stateless, as in, it cannot have a state like the `on` or
`off` state that, for example, a normal switch entity has.
Every button entity does keep track of the timestamp of when the last time
the button entity has been pressed in the Home Assistant UI or pressed via
a service call.
-Because the state of a button entity in Home Assistant is a timestamp, it
+Because the {% term state %} of a button entity in Home Assistant is a timestamp, it
means we can use it in our automations. For example:
```yaml
@@ -43,7 +43,7 @@ action:
## Services
-The button entities exposes a single service: {% my developer_call_service service="button.press" %}
+The button entities exposes a single {% term service %}: {% my developer_call_service service="button.press" %}
This service can be called to trigger a button press for that entity.
@@ -53,7 +53,7 @@ This service can be called to trigger a button press for that entity.
entity_id: button.my_button
```
-## Device Class
+## Device class
The way these buttons are displayed in the frontend can be modified in the [customize section](/docs/configuration/customizing-devices/).
The following device classes are supported for buttons:
diff --git a/source/_integrations/button.mqtt.markdown b/source/_integrations/button.mqtt.markdown
index 36498b26bad..1821dafe2aa 100644
--- a/source/_integrations/button.mqtt.markdown
+++ b/source/_integrations/button.mqtt.markdown
@@ -1,5 +1,5 @@
---
-title: "MQTT Button"
+title: "MQTT button"
description: "Instructions on how to integrate MQTT buttons into Home Assistant."
ha_category:
- Button
diff --git a/source/_integrations/caldav.markdown b/source/_integrations/caldav.markdown
index f50c982f6c4..3a889b1a119 100644
--- a/source/_integrations/caldav.markdown
+++ b/source/_integrations/caldav.markdown
@@ -29,7 +29,7 @@ for it. An example CalDAV URL is `https://caldav.icloud.com/`.
This integration was tested against [iCloud Calendar](https://www.icloud.com/calendar/), [Nextcloud](https://nextcloud.com/), [Owncloud](https://owncloud.org/), [Baikal](https://sabre.io/baikal/). Any integration complying with the RFC4791 should work.
-## Manual Configuration
+## Manual configuration
You may also manually add a WebDAV calendar in Home Assistant by adding the following section to your `configuration.yaml` file. This method does not support to-do lists.
diff --git a/source/_integrations/calendar.markdown b/source/_integrations/calendar.markdown
index 7f22f6acb03..de20cd1328d 100644
--- a/source/_integrations/calendar.markdown
+++ b/source/_integrations/calendar.markdown
@@ -10,7 +10,7 @@ ha_codeowners:
ha_integration_type: entity
---
-The calendar integration provides calendar entities, allowing other integrations
+The **Calendar** {% term integration %} provides calendar {% term entities %}, allowing other integrations
to integrate calendars into Home Assistant. Calendars are shown on the calendar
dashboard and can be used with automations.
@@ -20,25 +20,25 @@ integrations page to find integration offering calendar entities.
{% include integrations/building_block_integration.md %}
-A calendar entity has a state and attributes representing the next event (only).
-A calendar trigger is much more flexible, has fewer limitations, and is
+A calendar {% term entity %} has a {% term state %} and attributes representing the next event (only).
+A calendar {% term trigger %} is much more flexible, has fewer limitations, and is
recommended for automations instead of using the entity state.
## Viewing and managing calendars
-Each calendar is represented as its own entity in Home Assistant and can be
+Each calendar is represented as its own {% term entity %} in Home Assistant and can be
viewed and managed on a calendar dashboard. You can find the calendar dashboard
in the main sidebar of your Home Assistant instance.
Some calendar integrations allow Home Assistant to manage your calendars
-directly from Home Assistant. In this case, you can add new events by clicking
-the “Add event” button in the lower right corner of the calendar dashboard.
+directly from Home Assistant. In this case, you can add new events by selecting
+the **Add event** button in the lower right corner of the calendar dashboard.
Also see [Services](#services) below.
## Automation
-Calendar [Triggers](/docs/automation/trigger) enable automation based on an
+Calendar [Triggers](/docs/automation/trigger) enable {% term automation %} based on an
event's start or end. Review the [Automating Home Assistant](/getting-started/automation/)
getting started guide on automations or the [Automation](/docs/automation/)
documentation for full details.
@@ -47,7 +47,7 @@ documentation for full details.
-An example of a calendar trigger in YAML:
+An example of a calendar {% term trigger %} in YAML:
```yaml
automation:
@@ -65,12 +65,12 @@ Calendar triggers should not generally use automation mode `single` to ensure
the trigger can fire when multiple events start at the same time (e.g., use
`queued` or `parallel` instead). Note that calendars are read once every 15
minutes. When testing, make sure you do not plan events less than 15 minutes
-away from the current time, or your trigger might not fire.
+away from the current time, or your {% term trigger %} might not fire.
See [Automation Trigger Variables: Calendar](/docs/automation/templating/#calendar)
for additional trigger data available for conditions or actions.
-### Automation Recipes
+### Automation recipes
Below are a few example ways you can use Calendar triggers.
@@ -140,8 +140,8 @@ automation:
## Services
-Some calendar integrations allow Home Assistant to manage your calendars
-directly using services. The services provided by some calendar entities are described below or you can read more about [Service Calls](/docs/scripts/service-calls/).
+Some calendar {% term integrations %} allow Home Assistant to manage your calendars
+directly using {% term services %}. The services provided by some calendar {% term entity %} are described below or you can read more about [Service Calls](/docs/scripts/service-calls/).
### Service `calendar.create_event`
@@ -165,7 +165,7 @@ You either use `start_date_time` and `end_date_time`, or `start_date` and `end_d
-This is a full example of service call in YAML:
+This is a full example of a {% term service %} call in YAML:
```yaml
service: calendar.create_event
@@ -200,8 +200,8 @@ with calendar events within a date range.
| Service data attribute | Optional | Description | Example |
| ---------------------- | -------- | ----------- | --------|
| `start_date_time` | yes | Return active events after this time (exclusive). When not set, defaults to now. | 2019-03-10 20:00:00
-| `end_date_time` | yes | Return active events before this time (exclusive). Cannot be used with 'duration'. | 2019-03-10 23:00:00
-| `duration` | yes | Return active events from start_date_time until the specified duration. | `days: 2`
+| `end_date_time` | yes | Return active events before this time (exclusive). Cannot be used with `duration`. You must specify either `end_date_time` or `duration`.| 2019-03-10 23:00:00
+| `duration` | yes | Return active events from `start_date_time` until the specified duration. Cannot be used with `end_date_time`. You must specify either `duration` or `end_date_time`. | `days: 2`
diff --git a/source/_integrations/camera.markdown b/source/_integrations/camera.markdown
index 156d6a6a0c5..89d840ce5d9 100644
--- a/source/_integrations/camera.markdown
+++ b/source/_integrations/camera.markdown
@@ -3,7 +3,7 @@ title: Camera
description: Instructions on how to integrate cameras within Home Assistant.
ha_category:
- Camera
- - Media Source
+ - Media source
ha_release: 0.7
ha_quality_scale: internal
ha_domain: camera
@@ -18,7 +18,7 @@ The camera integration allows you to use IP cameras with Home Assistant.
{% include integrations/building_block_integration.md %}
-### Streaming Video
+### Streaming video
If your camera supports it, and the [`stream`](/integrations/stream) integration is setup, you will be able to stream your cameras in the frontend and on supported media players.
diff --git a/source/_integrations/canary.markdown b/source/_integrations/canary.markdown
index bed58247a96..892151f981e 100644
--- a/source/_integrations/canary.markdown
+++ b/source/_integrations/canary.markdown
@@ -16,7 +16,7 @@ ha_platforms:
ha_integration_type: integration
---
-The `canary` integration allows you to integrate your [Canary](https://canary.is) devices in Home Assistant.
+The **Canary** {% term integration %} allows you to integrate your [Canary](https://canary.is) devices in Home Assistant.
There is currently support for the following device types within Home Assistant:
diff --git a/source/_integrations/cast.markdown b/source/_integrations/cast.markdown
index c8d454db261..a49ad572abb 100644
--- a/source/_integrations/cast.markdown
+++ b/source/_integrations/cast.markdown
@@ -2,7 +2,7 @@
title: Google Cast
description: Instructions on how to integrate Google Cast into Home Assistant.
ha_category:
- - Media Player
+ - Media player
featured: true
ha_release: pre 0.7
ha_iot_class: Local Polling
diff --git a/source/_integrations/cert_expiry.markdown b/source/_integrations/cert_expiry.markdown
index 726395db2f9..0c0a8c86d06 100644
--- a/source/_integrations/cert_expiry.markdown
+++ b/source/_integrations/cert_expiry.markdown
@@ -14,14 +14,14 @@ ha_platforms:
ha_integration_type: integration
---
-The Certificate Expiry integration fetches the certificate from a configured host and displays its expiration in a timestamp sensor.
+The **Certificate Expiry** {% term integration %} fetches the certificate from a configured host and displays its expiration in a timestamp sensor.
The sensor checks and updates the certificate information for the configured host every 12 hours.
{% include integrations/config_flow.md %}
## Attributes
-The Certificate Expiry entities provide extra attributes to represent the state of the certificate.
+The Certificate Expiry {% term entities %} provide extra attributes to represent the state of the certificate.
| Name | Description |
| ---- | ----------- |
diff --git a/source/_integrations/channels.markdown b/source/_integrations/channels.markdown
index 52c45d13c81..a8fe9cf0a3c 100644
--- a/source/_integrations/channels.markdown
+++ b/source/_integrations/channels.markdown
@@ -2,7 +2,7 @@
title: Channels
description: Instructions on how to integrate Channels into Home Assistant.
ha_category:
- - Media Player
+ - Media player
ha_release: 0.65
ha_iot_class: Local Polling
ha_domain: channels
diff --git a/source/_integrations/cisco_ios.markdown b/source/_integrations/cisco_ios.markdown
index 8d9d564d252..9aab1516d08 100644
--- a/source/_integrations/cisco_ios.markdown
+++ b/source/_integrations/cisco_ios.markdown
@@ -2,7 +2,7 @@
title: Cisco IOS
description: Instructions on how to integrate Cisco IOS routers into Home Assistant.
ha_category:
- - Presence Detection
+ - Presence detection
ha_release: 0.33
ha_iot_class: Local Polling
ha_codeowners:
diff --git a/source/_integrations/cisco_mobility_express.markdown b/source/_integrations/cisco_mobility_express.markdown
index e9dcada64ad..7cf7859e5db 100644
--- a/source/_integrations/cisco_mobility_express.markdown
+++ b/source/_integrations/cisco_mobility_express.markdown
@@ -2,7 +2,7 @@
title: Cisco Mobility Express
description: Instructions on how to integrate Cisco Mobility Express wireless controllers into Home Assistant.
ha_category:
- - Presence Detection
+ - Presence detection
ha_release: '0.90'
ha_iot_class: Local Polling
ha_codeowners:
diff --git a/source/_integrations/clementine.markdown b/source/_integrations/clementine.markdown
index 70580a38f92..b20820f032c 100644
--- a/source/_integrations/clementine.markdown
+++ b/source/_integrations/clementine.markdown
@@ -2,7 +2,7 @@
title: Clementine Music Player
description: Instructions on how to integrate Clementine Music Player within Home Assistant.
ha_category:
- - Media Player
+ - Media player
ha_release: 0.39
ha_iot_class: Local Polling
ha_domain: clementine
diff --git a/source/_integrations/clicksend.markdown b/source/_integrations/clicksend.markdown
index cd74ef3ef2d..229b8c7312a 100644
--- a/source/_integrations/clicksend.markdown
+++ b/source/_integrations/clicksend.markdown
@@ -60,7 +60,7 @@ sender:
description: The name or number of the sender. (Limited to 11 characters.)
required: false
type: string
- default: "hass"
+ default: "`hass`"
{% endconfiguration %}
To use notifications, please see the [getting started with automation page](/getting-started/automation/).
diff --git a/source/_integrations/climate.markdown b/source/_integrations/climate.markdown
index b03e1d1f93c..35b5164d305 100644
--- a/source/_integrations/climate.markdown
+++ b/source/_integrations/climate.markdown
@@ -11,7 +11,7 @@ ha_codeowners:
ha_integration_type: entity
---
-The climate integration allows you to control and monitor HVAC (heating, ventilating, and air conditioning) devices and thermostats.
+The **Climate** {% term integration %} allows you to control and monitor HVAC (heating, ventilating, and air conditioning) devices and thermostats.
{% include integrations/building_block_integration.md %}
@@ -23,7 +23,7 @@ Available services: `climate.set_aux_heat`, `climate.set_preset_mode`, `climate.
-Not all climate services may be available for your platform. You can check which climate services are available under **Developer Tools** -> **Services**.
+Not all climate {% term services %} may be available for your platform. You can check which climate services are available under **Developer Tools** -> **Services**.
diff --git a/source/_integrations/climate.mqtt.markdown b/source/_integrations/climate.mqtt.markdown
index c5afdd7b057..94d91a0d3f2 100644
--- a/source/_integrations/climate.mqtt.markdown
+++ b/source/_integrations/climate.mqtt.markdown
@@ -409,7 +409,7 @@ value_template:
If a property works in *optimistic mode* (when the corresponding state topic is not set), Home Assistant will assume that any state changes published to the command topics did work and change the internal state of the entity immediately after publishing to the command topic. If it does not work in optimistic mode, the internal state of the entity is only updated when the requested update is confirmed by the device through the state topic. You can enforce optimistic mode by setting the `optimistic` option to `true`. When set, the internal state will always be updated, even when a state topic is defined.
-## Using Templates
+## Using templates
For all `*_state_topic`s, a template can be specified that will be used to render the incoming payloads on these topics. Also, a default template that applies to all state topics can be specified as `value_template`. This can be useful if you received payloads are e.g., in JSON format. Since in JSON, a quoted string (e.g., `"foo"`) is just a string, this can also be used for unquoting.
diff --git a/source/_integrations/cloud.markdown b/source/_integrations/cloud.markdown
index 25f64ba07a0..de106cb42ec 100644
--- a/source/_integrations/cloud.markdown
+++ b/source/_integrations/cloud.markdown
@@ -20,7 +20,7 @@ The Home Assistant Cloud allows you to quickly integrate your local Home Assista
## Configuration
-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:
+This {% term 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 to enable the cloud component
diff --git a/source/_integrations/cloudflare.markdown b/source/_integrations/cloudflare.markdown
index 3a15802a7bd..af4dcde4d4f 100644
--- a/source/_integrations/cloudflare.markdown
+++ b/source/_integrations/cloudflare.markdown
@@ -13,7 +13,7 @@ ha_config_flow: true
ha_integration_type: integration
---
-With the Cloudflare integration, you can keep your Cloudflare DNS records up to date.
+With the **Cloudflare** {% term integration %}, you can keep your Cloudflare DNS records up to date.
The integration runs every hour, but can also be triggered by running the {% my developer_services title="`cloudflare.update_records` service" service="cloudflare.update_records" %}.
diff --git a/source/_integrations/cmus.markdown b/source/_integrations/cmus.markdown
index 384ea126216..0069c91d0e1 100644
--- a/source/_integrations/cmus.markdown
+++ b/source/_integrations/cmus.markdown
@@ -2,7 +2,7 @@
title: cmus
description: Instructions on how to integrate cmus Music Player into Home Assistant.
ha_category:
- - Media Player
+ - Media player
ha_iot_class: Local Polling
ha_release: 0.23
ha_domain: cmus
diff --git a/source/_integrations/co2signal.markdown b/source/_integrations/co2signal.markdown
index cb805740ad8..dafd88f8ff1 100644
--- a/source/_integrations/co2signal.markdown
+++ b/source/_integrations/co2signal.markdown
@@ -25,6 +25,6 @@ To configure and use this integration, you need to obtain a free API key from El
{% include integrations/config_flow.md %}
-## Sensor Types
+## Sensor types
When configured, the platform will create two sensors for each configured location: the carbon intensity expressed in `gCO2eq/kWh` and a percentage of how much the grid relies on fossil fuels for production.
diff --git a/source/_integrations/color_extractor.markdown b/source/_integrations/color_extractor.markdown
index 172ca2b77da..4a338de3faf 100644
--- a/source/_integrations/color_extractor.markdown
+++ b/source/_integrations/color_extractor.markdown
@@ -3,7 +3,7 @@ title: ColorExtractor
description: Instructions how to integrate the Color Extractor into Home Assistant.
ha_release: 0.118
ha_category:
- - Image Processing
+ - Image processing
ha_domain: color_extractor
ha_codeowners:
- '@GenericStudent'
@@ -11,8 +11,8 @@ ha_config_flow: true
ha_integration_type: integration
---
-The color extractor integration will extract the predominant color from a given image and apply that color to a target light.
-Useful as part of an automation.
+The **ColorExtractor** {% term integration %} will extract the predominant color from a given image and apply that color to a target light.
+Useful as part of an {% term automation %}.
{% include integrations/config_flow.md %}
@@ -20,7 +20,7 @@ Useful as part of an automation.
Because `color_extractor.turn_on` will then call `light.turn_on`, you can pass any valid [`light.turn_on`](/integrations/light#service-lightturn_on) parameters (`rgb_color` will be set for you though) as those will be passed along.
-Passing the key `color_extract_url` to the 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.
+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 |
|---------------------|---------------------------------------|-------------------------------------------------------------------------------|
@@ -30,7 +30,7 @@ Passing the key `color_extract_url` to the service call will download the linked
- 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 integration is not allowed access to these external resources.
+ 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.
@@ -38,17 +38,17 @@ Passing the key `color_extract_url` to the service call will download the linked
Add the parameter key `color_extract_url` to the service call.
-This service allows you to pass in the URL of an image, have it downloaded, get the predominant color from it, and then set a light's RGB value to it.
+This {% term service %} allows you to pass in the URL of an image, have it downloaded, get the predominant color from it, and then set a light's RGB value to it.
### File Service Call
Add the parameter key `color_extract_path` to the service call.
-This service is very similar to the URL service above, except it processes a file from the local file storage.
+This {% term service %} is very similar to the URL service above, except it processes a file from the local file storage.
## Example Automations
-Example usage in an automation, taking the album art present on a Chromecast and supplying it to `light.shelf_leds` whenever it changes:
+Example usage in an {% term automation %}, taking the album art present on a Chromecast and supplying it to `light.shelf_leds` whenever it changes:
{% raw %}
diff --git a/source/_integrations/command_line.markdown b/source/_integrations/command_line.markdown
index f522ebead35..91862c9c7f6 100644
--- a/source/_integrations/command_line.markdown
+++ b/source/_integrations/command_line.markdown
@@ -2,7 +2,7 @@
title: Command Line
description: Instructions on how to integrate the Command Line utility within Home Assistant.
ha_category:
- - Binary Sensor
+ - Binary sensor
- Cover
- Notifications
- Sensor
@@ -690,7 +690,7 @@ command_line:
```
{% endraw%}
-### Control Foscam Motion Sensor
+### Control Foscam motion sensor
This switch will control the motion sensor of Foscam Webcams which Support CGI
Commands ([Source](https://www.iltucci.com/blog/wp-content/uploads/2018/12/Foscam-IPCamera-CGI-User-Guide-V1.0.4.pdf)).
diff --git a/source/_integrations/compensation.markdown b/source/_integrations/compensation.markdown
index 20a73f3f66c..d4ac6ed4b9e 100644
--- a/source/_integrations/compensation.markdown
+++ b/source/_integrations/compensation.markdown
@@ -14,7 +14,7 @@ ha_platforms:
ha_integration_type: integration
---
-The Compensation {% term integration %} consumes the {% term state %} from other {% term sensors %}. It exports the compensated value as state in a separate {% term entity %} and the following values as attributes: `entity_id` and `coefficients`. A single polynomial, linear by default, is fit to all data points provided.
+The **Compensation** {% term integration %} consumes the {% term state %} from other {% term sensors %}. It exports the compensated value as state in a separate {% term entity %} and the following values as attributes: `entity_id` and `coefficients`. A single polynomial, linear by default, is fit to all data points provided.
## Configuration
diff --git a/source/_integrations/concord232.markdown b/source/_integrations/concord232.markdown
index d37e10cac99..1aef7c46065 100644
--- a/source/_integrations/concord232.markdown
+++ b/source/_integrations/concord232.markdown
@@ -3,7 +3,7 @@ title: Concord232
description: Instructions on how to integrate Interlogix/GE Concord4 into Home Assistant.
ha_category:
- Alarm
- - Binary Sensor
+ - Binary sensor
ha_iot_class: Local Polling
ha_release: 0.31
ha_domain: concord232
@@ -20,9 +20,9 @@ To use this platform, you will need to have the external concord232 client and s
There is currently support for the following device types within Home Assistant:
- [Alarm](#alarm-control-panel)
-- [Binary Sensor](#binary-sensor)
+- [Binary sensor](#binary-sensor)
-## Alarm Control Panel
+## Alarm control panel
To enable the alarm control panel platform, add the following lines to your `configuration.yaml`:
@@ -54,7 +54,7 @@ mode:
default: audible
{% endconfiguration %}
-## Binary Sensor
+## Binary sensor
To enable the binary sensor platform, add the following lines to your `configuration.yaml`:
diff --git a/source/_integrations/config.markdown b/source/_integrations/config.markdown
index 20806a279d0..02c8dcd4a9c 100644
--- a/source/_integrations/config.markdown
+++ b/source/_integrations/config.markdown
@@ -2,7 +2,7 @@
title: Configuration
description: Instructions on how to setup the configuration panel for Home Assistant.
ha_category:
- - Front End
+ - Front end
ha_release: 0.39
ha_quality_scale: internal
ha_codeowners:
@@ -34,7 +34,7 @@ This section enables you to manage your Home Assistant users.
This section enables you to manage the name, location, and unit system of your Home Assistant installation.
-### Server Control
+### Server control
This section enables you to control Home Assistant from within Home Assistant. Check your configuration, reload the core, groups, scripts, automations, and the Home Assistant process itself with a single mouse click.
diff --git a/source/_integrations/configurator.markdown b/source/_integrations/configurator.markdown
index 423e4a3d53d..216a8cc85cb 100644
--- a/source/_integrations/configurator.markdown
+++ b/source/_integrations/configurator.markdown
@@ -15,11 +15,11 @@ ha_integration_type: system
This integration is intended for developers.
-The configurator integration allows integrations to request information from the user. It is currently implemented as the minimum viable product:
+The **Configurator** {% term integration %} allows integrations to request information from the user. It is currently implemented as the minimum viable product:
-- It supports showing a text, image and button to the user
-- Input fields can be defined with a description, and optional type
-- It will trigger a callback when the button is pressed
+- It supports showing a text, image, and a button to the user.
+- Input fields can be defined with a description, and optional type.
+- It will trigger a callback when the button is pressed.
The Hue integration in [the demo](https://demo.home-assistant.io/) and Plex are implemented using the configurator. See [the source of the demo integration](https://github.com/home-assistant/home-assistant/tree/dev/homeassistant/components/demo) for a simple example.
diff --git a/source/_integrations/control4.markdown b/source/_integrations/control4.markdown
index 3be1a943158..a90dca89a9b 100644
--- a/source/_integrations/control4.markdown
+++ b/source/_integrations/control4.markdown
@@ -15,7 +15,7 @@ ha_platforms:
ha_integration_type: integration
---
-The Control4 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 from your local Control4 system. Your Control4 controller must be running OS 3.0+.
## Prerequisites
@@ -25,7 +25,7 @@ Before setting up, you should assign a static IP address/DHCP reservation on you
## Options
-The Control4 integration offers additional options in **Settings** -> **Devices & Services** -> **Control4** -> **Options**:
+The Control4 {% term integration %} offers additional options in {% my integrations title="**Settings** > **Devices & Services**" %} > **Control4** > **Options**:
{% configuration %}
Seconds between updates:
diff --git a/source/_integrations/conversation.markdown b/source/_integrations/conversation.markdown
index d2904982f6c..86cc5fc7f3a 100644
--- a/source/_integrations/conversation.markdown
+++ b/source/_integrations/conversation.markdown
@@ -13,7 +13,7 @@ ha_domain: conversation
ha_integration_type: system
---
-The conversation integration allows you to converse with Home Assistant. You can either converse by pressing the microphone in the frontend (supported browsers only (no iOS)) or by calling the `conversation/process` service with the transcribed text.
+The **Conversation** {% term integration %} allows you to converse with Home Assistant. You can either converse by pressing the microphone in the frontend (supported browsers only (no iOS)) or by calling the `conversation/process` service with the transcribed text.
diff --git a/source/_integrations/cover.markdown b/source/_integrations/cover.markdown
index e4755285473..bc167863554 100644
--- a/source/_integrations/cover.markdown
+++ b/source/_integrations/cover.markdown
@@ -15,7 +15,7 @@ Home Assistant can give you an interface to control covers such as rollershutter
{% include integrations/building_block_integration.md %}
-## Device Class
+## Device class
The way these {% term sensors %} are displayed in the {% term frontend %} can be modified in the [customize section](/docs/configuration/customizing-devices/). The following device classes are supported for covers:
diff --git a/source/_integrations/cover.template.markdown b/source/_integrations/cover.template.markdown
index 51a03e33f8a..7c6ca4cba10 100644
--- a/source/_integrations/cover.template.markdown
+++ b/source/_integrations/cover.template.markdown
@@ -1,6 +1,6 @@
---
-title: "Template Cover"
-description: "Instructions on how to integrate Template Covers into Home Assistant."
+title: "Template cover"
+description: "Instructions on how to integrate template covers into Home Assistant."
ha_category:
- Cover
ha_release: 0.48
@@ -91,11 +91,11 @@ cover:
required: false
type: action
set_cover_position:
- description: Defines an action to set to a cover position (between `0` and `100`).
+ description: Defines an action to set to a cover position (between `0` and `100`). The variable `position` will contain the entity's set position.
required: false
type: action
set_cover_tilt_position:
- description: Defines an action to set the tilt of a cover (between `0` and `100`).
+ description: Defines an action to set the tilt of a cover (between `0` and `100`). The variable `tilt` will contain the entity's set tilt position.
required: false
type: action
optimistic:
@@ -130,7 +130,7 @@ with this equivalent that returns `true`/`false` and never gives an unknown
result:
{% raw %}`{{ is_state('cover.source', 'open') }}`{% endraw %}
-## Optimistic Mode
+## Optimistic mode
In optimistic mode, the cover position state is maintained internally. This mode
is automatically enabled if neither [`value_template`](#value_template) or
@@ -160,7 +160,7 @@ If both a [`value_template`](#value_template) and a [`position_template`](#posit
In this section you will find some real-life examples of how to use this cover.
-### Garage Door
+### Garage door
This example converts a garage door with a controllable switch and position
sensor into a cover. The condition check is optional, but suggested if you
@@ -204,7 +204,7 @@ cover:
{% endraw %}
-### Multiple Covers
+### Multiple covers
This example allows you to control two or more covers at once.
@@ -296,7 +296,7 @@ automation:
{% endraw %}
-### Change The Icon
+### Change the icon
This example shows how to change the icon based on the cover state.
@@ -331,7 +331,7 @@ cover:
{% endraw %}
-### Change The Entity Picture
+### Change the entity picture
This example shows how to change the entity picture based on the cover state.
diff --git a/source/_integrations/cozytouch.markdown b/source/_integrations/cozytouch.markdown
index fa39dbc744c..3df1696c140 100644
--- a/source/_integrations/cozytouch.markdown
+++ b/source/_integrations/cozytouch.markdown
@@ -3,7 +3,7 @@ title: Atlantic Cozytouch
description: Connect and control your Atlantic Cozytouch devices using the Overkiz integration
ha_category:
- Alarm
- - Binary Sensor
+ - Binary sensor
- Button
- Climate
- Cover
@@ -16,7 +16,7 @@ ha_category:
- Sensor
- Siren
- Switch
- - Water Heater
+ - Water heater
ha_domain: cozytouch
ha_integration_type: virtual
ha_supporting_domain: overkiz
diff --git a/source/_integrations/cpuspeed.markdown b/source/_integrations/cpuspeed.markdown
index f1e8b7ee5c2..9073b38aea7 100644
--- a/source/_integrations/cpuspeed.markdown
+++ b/source/_integrations/cpuspeed.markdown
@@ -2,7 +2,7 @@
title: CPU Speed
description: Instructions on how to integrate CPU speed within Home Assistant.
ha_category:
- - System Monitor
+ - System monitor
ha_release: pre 0.7
ha_iot_class: Local Push
ha_codeowners:
diff --git a/source/_integrations/cups.markdown b/source/_integrations/cups.markdown
index 1b7352a687b..34e9ee24ef6 100644
--- a/source/_integrations/cups.markdown
+++ b/source/_integrations/cups.markdown
@@ -2,7 +2,7 @@
title: CUPS
description: Instructions on how to integrate CUPS sensors into Home Assistant.
ha_category:
- - System Monitor
+ - System monitor
ha_iot_class: Local Polling
ha_release: 0.32
ha_codeowners:
diff --git a/source/_integrations/dacia.markdown b/source/_integrations/dacia.markdown
index fe6358422b0..5ce1d6475ad 100644
--- a/source/_integrations/dacia.markdown
+++ b/source/_integrations/dacia.markdown
@@ -2,9 +2,9 @@
title: Dacia
description: Connect and control your Dacia devices using the Renault integration
ha_category:
- - Binary Sensor
+ - Binary sensor
- Car
- - Presence Detection
+ - Presence detection
- Select
- Sensor
ha_domain: dacia
diff --git a/source/_integrations/daikin.markdown b/source/_integrations/daikin.markdown
index e3bfd4a30f3..057ebb290fd 100644
--- a/source/_integrations/daikin.markdown
+++ b/source/_integrations/daikin.markdown
@@ -25,7 +25,7 @@ ha_integration_type: integration
Daikin has removed their local API in newer products. They offer a cloud API accessible only under NDA, which is incompatible with open source. This affects units fitted with the BRP069C4x wifi adapter. Units listed under Supported Hardware below continue to have access to local control. Additionally the older but commonly available BRP072A42 adapter can be fitted to most if not all newer units for access to local control.
-The `daikin` integration integrates Daikin air conditioning systems into Home Assistant.
+The **Daikin** {% term integration %} integrates Daikin air conditioning systems into Home Assistant.
There is currently support for the following device types within Home Assistant:
@@ -145,7 +145,7 @@ A switch is created for each device that will toggle the unit on/off. This will
Additionally the Daikin Streamer (air purifier) function can be toggled on supported devices using a switch. Note that it isn't currently possible to reliably detect whether a specific device has streamer support, so the switch may appear in the UI even if the functionality isn't actually supported.
-## Region Changing
+## Region changing
The European and United States controllers (Most likely the Australian controllers too) have an HTTP API endpoint that allows you to change the controllers region so that other regional apps can be used. (Sometimes these controllers get exported to regions that can not download the app for the controllers region.)
diff --git a/source/_integrations/danfoss_air.markdown b/source/_integrations/danfoss_air.markdown
index fdd3216b42d..64351c5b79b 100644
--- a/source/_integrations/danfoss_air.markdown
+++ b/source/_integrations/danfoss_air.markdown
@@ -2,7 +2,7 @@
title: Danfoss Air
description: How to integrate Danfoss Air HRV in Home Assistant.
ha_category:
- - Binary Sensor
+ - Binary sensor
- Climate
- Sensor
- Switch
@@ -16,7 +16,7 @@ ha_platforms:
ha_integration_type: integration
---
-The `danfoss_air` integration allows you to access information from your Danfoss Air HRV unit.
+The **Danfoss Air** {% term integration %} allows you to access information from your Danfoss Air HRV unit.
*Note*: Danfoss Air CCM only accepts one TCP connection at a time. Due to this the integration will not work while you have the HRV PC-Tool open.
diff --git a/source/_integrations/datadog.markdown b/source/_integrations/datadog.markdown
index 22bfbf6d6d6..0b25132591d 100644
--- a/source/_integrations/datadog.markdown
+++ b/source/_integrations/datadog.markdown
@@ -9,7 +9,7 @@ ha_domain: datadog
ha_integration_type: integration
---
-The `datadog` integration sends all state changes to [Datadog](https://www.datadoghq.com/) using a [Datadog Agent](https://docs.datadoghq.com/guides/basic_agent_usage/).
+The **Datadog** {% term integration %} sends all state changes to [Datadog](https://www.datadoghq.com/) using a [Datadog Agent](https://docs.datadoghq.com/guides/basic_agent_usage/).
Datadog allows you to analyze, monitor, cross-reference and alert upon your data. You can use it to detect statistical anomalies, see graphs across multiple sources in real-time, send critical alerts to Slack, etc.
@@ -44,7 +44,7 @@ port:
prefix:
description: Prefix to use.
required: false
- default: hass
+ default: "`hass`"
type: string
rate:
description: The sample rate of UDP packets sent to Datadog.
diff --git a/source/_integrations/date.markdown b/source/_integrations/date.markdown
index c5df8ac46ff..b9b64e7dd8e 100644
--- a/source/_integrations/date.markdown
+++ b/source/_integrations/date.markdown
@@ -11,7 +11,7 @@ ha_codeowners:
ha_integration_type: entity
---
-The date integration is built for the controlling and monitoring of dates on devices.
+The **Date** {% term integration %} is built for the controlling and monitoring of dates on devices.
{% include integrations/building_block_integration.md %}
@@ -19,13 +19,13 @@ If you are looking for a way to create a similar entity, please take a look at t
## Services
-### date services
+### Date services
-Available services: `date.set_value`
+Available {% term services %}: `date.set_value`
### Service `date.set_value`
-Set a new value for the date entity.
+Set a new value for the date {% term entity %}.
| Service data attribute | Optional | Description |
| ---------------------- | -------- | ----------- |
diff --git a/source/_integrations/datetime.markdown b/source/_integrations/datetime.markdown
index 4511c5a3287..5b836e368a7 100644
--- a/source/_integrations/datetime.markdown
+++ b/source/_integrations/datetime.markdown
@@ -11,7 +11,7 @@ ha_codeowners:
ha_integration_type: entity
---
-The Date/Time integration is built for the controlling and monitoring of timestamps on devices.
+The **Date/Time** {% term integration %} is built for the controlling and monitoring of timestamps on devices.
{% include integrations/building_block_integration.md %}
@@ -21,11 +21,11 @@ If you are looking for a way to create a Date/Time entity, please take a look at
### datetime services
-Available services: `datetime.set_value`
+Available {% term services %}: `datetime.set_value`
### Service `datetime.set_value`
-Set a new value for the datetime entity.
+Set a new value for the datetime {% term entity %}.
| Service data attribute | Optional | Description |
| ---------------------- | -------- | ------------------------------------------------------------------------------------------------------------ |
diff --git a/source/_integrations/ddwrt.markdown b/source/_integrations/ddwrt.markdown
index 95bb72da391..e284fc78ff3 100644
--- a/source/_integrations/ddwrt.markdown
+++ b/source/_integrations/ddwrt.markdown
@@ -2,7 +2,7 @@
title: DD-WRT
description: Instructions on how to integrate DD-WRT based routers into Home Assistant.
ha_category:
- - Presence Detection
+ - Presence detection
ha_iot_class: Local Polling
ha_release: pre 0.7
ha_domain: ddwrt
diff --git a/source/_integrations/debugpy.markdown b/source/_integrations/debugpy.markdown
index edceb4421f2..96b71089ce0 100644
--- a/source/_integrations/debugpy.markdown
+++ b/source/_integrations/debugpy.markdown
@@ -1,6 +1,6 @@
---
-title: Remote Python Debugger
-description: Remote Python Debugger (debugpy) for Visual Studio Code
+title: Remote Python debugger
+description: Remote Python debugger (debugpy) for Visual Studio Code
ha_category:
- Utility
ha_release: 0.112
@@ -12,7 +12,7 @@ ha_iot_class: Local Push
ha_integration_type: service
---
-The remote Python debugger integration allows you to use the Visual Studio Code
+The **Remote Python debugger** {% term integration %} allows you to use the Visual Studio Code
Python debug tooling with a remote Home Assistant instance.
It uses Microsoft's `debugpy` library which is the successor of `ptvsd`, and
@@ -69,7 +69,7 @@ Home Assistant instance, which is very unsafe.
If the Home Assistant instance is behind your firewall with only the http(s) port
exposed, then this is safe from outside connections.
-## Performance and Memory Use
+## Performance and memory use
Using the debugger (even when not attached), increases memory usage and
decreases performance. It is not recommended to configure the debugger on a
diff --git a/source/_integrations/deconz.markdown b/source/_integrations/deconz.markdown
index 2a52a5afe5f..de99bdbe696 100644
--- a/source/_integrations/deconz.markdown
+++ b/source/_integrations/deconz.markdown
@@ -3,7 +3,7 @@ title: deCONZ
description: Instructions on how to setup ConBee/RaspBee devices with deCONZ from dresden elektronik within Home Assistant.
ha_category:
- Alarm
- - Binary Sensor
+ - Binary sensor
- Cover
- Fan
- Hub
@@ -45,8 +45,8 @@ ha_integration_type: hub
There is currently support for the following device types within Home Assistant:
-- [Alarm Control Panel](#alarm-control-panel)
-- [Binary Sensor](#binary-sensor)
+- [Alarm control panel](#alarm-control-panel)
+- [Binary sensor](#binary-sensor)
- [Climate](#climate)
- [Cover](#cover)
- [Light](#light)
@@ -67,7 +67,7 @@ See [deCONZ wiki](https://github.com/dresden-elektronik/deconz-rest-plugin/wiki/
{% include integrations/config_flow.md %}
-Running a stand-alone instance of deCONZ (non add-on installation) requires a pairing between the deCONZ gateway and Home Assistant. To allow Home Assistant to connect with deCONZ go to the Phoscon **UI click Settings -> Gateway -> Advanced** and press the "Authenticate app" button. This same information is also shown during the config flow of the deCONZ integration.
+Running a stand-alone instance of deCONZ (non add-on installation) requires a pairing between the deCONZ gateway and Home Assistant. To allow Home Assistant to connect with deCONZ go to the Phoscon UI select **Settings** > **Gateway** > **Advanced** and select the **Authenticate app** button. This same information is also shown during the config flow of the deCONZ integration.
## Debugging integration
@@ -87,7 +87,7 @@ If you are having issues and want to report a problem, always start with making
### No state updates
-If the state of entities are only reflected in Home Assistant when the integration is loaded (during restart, reload, setup) you probably have an issue with the WebSocket configuration where your deCONZ instance is running. The deCONZ integration uses the WebSocket port provided by the deCONZ REST API. If you're running the deCONZ Docker container make sure that it properly configures the WebSocket port so deCONZ can report what port is exposed outside of the containerized environment. Also, make sure to review firewall rules that might block communication over certain ports.
+If the state of {% term entities %} are only reflected in Home Assistant when the {% term integration %} is loaded (during restart, reload, setup) you probably have an issue with the WebSocket configuration where your deCONZ instance is running. The deCONZ integration uses the WebSocket port provided by the deCONZ REST API. If you're running the deCONZ Docker container make sure that it properly configures the WebSocket port so deCONZ can report what port is exposed outside of the containerized environment. Also, make sure to review firewall rules that might block communication over certain ports.
## Device services
@@ -125,13 +125,13 @@ Either `entity` or `field` must be provided. If both are present, `field` will b
Refresh with devices added to deCONZ after Home Assistants latest restart.
-Note: deCONZ automatically signals Home Assistant when new sensors are added, but other devices must at this point in time (deCONZ v2.05.35) be added manually using this service or a restart of Home Assistant.
+Note: deCONZ automatically signals Home Assistant when new {% term sensors %} are added, but other devices must at this point in time (deCONZ v2.05.35) be added manually using this service or a restart of Home Assistant.
### Service `deconz.remove_orphaned_entries`
-Remove entries from entity and device registry which are no longer provided by deCONZ.
+Remove entries from {% term entity %} and device registry which are no longer provided by deCONZ.
-Note: it is recommended to use this service after a restart of Home Assistant Core in order to have deCONZ integration properly mirrored to deCONZ.
+Note: it is recommended to use this {% term service %} after a restart of Home Assistant Core in order to have deCONZ integration properly mirrored to deCONZ.
## Remote control devices
@@ -312,14 +312,14 @@ automation:
The `entity_id` name will be `platform.device_name`, where `device_name` is defined in deCONZ.
-### Alarm Control Panel
+### Alarm control panel
The entity of a physical keypad. Can be in 4 different modes (`arm_away`, `arm_home`, `arm_night` or `disarmed`). Changing the state will do an audible notification from the keypad.
-The Device also exposes a new event type `deconz_alarm_event` which reflects signals not supported within the Alarm Control Panel platform.
+The Device also exposes a new event type `deconz_alarm_event` which reflects signals not supported within the alarm control panel platform.
The Payload consists of an event (`emergency`, `fire`, `invalid_code` or `panic`).
-### Binary Sensor
+### Binary sensor
The following sensor types are supported:
@@ -362,7 +362,7 @@ The `entity_id` name will be `scene.group_scene_name`, where `group` is which gr
The following sensor types are supported:
-- Air Quality sensor
+- Air quality sensor
- Battery sensor
- Consumption sensor
- Daylight
diff --git a/source/_integrations/decora_wifi.markdown b/source/_integrations/decora_wifi.markdown
index 1b1fd29a021..50abc84bc18 100644
--- a/source/_integrations/decora_wifi.markdown
+++ b/source/_integrations/decora_wifi.markdown
@@ -16,8 +16,9 @@ Support for [Leviton Decora Wi-Fi](https://www.leviton.com/products/residential/
Supported devices (tested):
- [DW6HD1-BZ](https://www.leviton.com/products/dw6hd-1bz) (Decora Smart Wi-Fi 600W Dimmer)
-- [DW15S-1BZ](https://www.leviton.com/products/dw15s-1bz) (Decora Smart Wi-Fi 15A Switch)
- [DW15P-1BW](https://www.leviton.com/products/dw15p-1bw) (Decora Smart Wi-Fi Plug-in Outlet)
+- - [DW15S-1BZ](https://www.leviton.com/products/dw15s-1bz) (Decora Smart Wi-Fi 15A Switch)
+- [D215S-2RW](https://store.leviton.com/products/decora-smart-wi-fi-switch-2nd-gen-d215s-2rw) (Decora Smart Wi-Fi 15A Switch - 2nd Gen)
To enable these lights, add the following lines to your `configuration.yaml` file:
@@ -39,3 +40,4 @@ password:
required: true
type: string
{% endconfiguration %}
+
diff --git a/source/_integrations/default_config.markdown b/source/_integrations/default_config.markdown
index 1d4042a4081..de570a8ba27 100644
--- a/source/_integrations/default_config.markdown
+++ b/source/_integrations/default_config.markdown
@@ -11,7 +11,7 @@ ha_codeowners:
ha_integration_type: system
---
-This integration is a meta-component and configures a default set of integrations for Home Assistant to load. The integrations that will be loaded are:
+This {% term integration %} is a meta-component and configures a default set of integrations for Home Assistant to load. The integrations that will be loaded are:
- [Automation](/integrations/automation/) (`automation`)
- [Assist pipeline](/integrations/assist_pipeline/) (`assist_pipeline`)
@@ -20,7 +20,7 @@ This integration is a meta-component and configures a default set of integration
- [Configuration](/integrations/config/) (`config`)
- [Conversation](/integrations/conversation/) (`conversation`)
- [Counter](/integrations/counter/) (`counter`)
-- [DHCP Discovery](/integrations/dhcp/) (`dhcp`)
+- [DHCP discovery](/integrations/dhcp/) (`dhcp`)
- [Energy](/integrations/energy/) (`energy`)
- [Frontend](/integrations/frontend/) (`frontend`)
- [Hardware](/integrations/hardware/) (`hardware`)
@@ -37,8 +37,8 @@ This integration is a meta-component and configures a default set of integration
- [Logbook](/integrations/logbook/) (`logbook`)
- [Logger](/integrations/logger/) (`logger`)
- [Map](/integrations/map/) (`map`)
-- [Media Source](/integrations/media_source/) (`media_source`)
-- [Mobile App Support](/integrations/mobile_app/) (`mobile_app`)
+- [Media source](/integrations/media_source/) (`media_source`)
+- [Mobile app support](/integrations/mobile_app/) (`mobile_app`)
- [My Home Assistant](/integrations/my/) (`my`)
- [Network](/integrations/network/) (`network`)
- [Person](/integrations/person/) (`person`)
@@ -48,7 +48,7 @@ This integration is a meta-component and configures a default set of integration
- [Simple Service Discovery Protocol (SSDP)](/integrations/ssdp/) (`ssdp`)
- [Stream](/integrations/stream/) (`stream`)
- [Sun](/integrations/sun/) (`sun`)
-- [System Health](/integrations/system_health/) (`system_health`)
+- [System health](/integrations/system_health/) (`system_health`)
- [Tag](/integrations/tag/) (`tag`)
- [Timer](/integrations/timer/) (`timer`)
- [USB](/integrations/usb/) (`usb`)
diff --git a/source/_integrations/demo.markdown b/source/_integrations/demo.markdown
index 9e003a7bff7..bc9a0712c0a 100644
--- a/source/_integrations/demo.markdown
+++ b/source/_integrations/demo.markdown
@@ -50,7 +50,7 @@ The `demo` platform allows you to use integrations which are providing a demo of
Available demo platforms:
-- [Air Quality](/integrations/air_quality/) (`air_quality`)
+- [Air quality](/integrations/air_quality/) (`air_quality`)
- [Alarm control panel](/integrations/alarm_control_panel/) (`alarm_control_panel`)
- [Binary sensor](/integrations/binary_sensor/) (`binary_sensor`)
- [Button](/integrations/button/) (`button`)
@@ -58,15 +58,15 @@ Available demo platforms:
- [Camera](/integrations/camera/) (`camera`)
- [Climate](/integrations/climate/) (`climate`)
- [Cover](/integrations/cover/) (`cover`)
-- [Device Tracker](/integrations/device_tracker/) (`device_tracker`)
+- [Device tracker](/integrations/device_tracker/) (`device_tracker`)
- [Fan](/integrations/fan/) (`fan`)
- [Geolocation](/integrations/geo_location/) (`geo_location`)
- [Humidifier](/integrations/humidifier/) (`humidifier`)
-- [Image Processing](/integrations/image_processing/) (`image_processing`)
+- [Image processing](/integrations/image_processing/) (`image_processing`)
- [Light](/integrations/light/) (`light`)
- [Lock](/integrations/lock/) (`lock`)
- [Mailbox](/integrations/mailbox/) (`mailbox`)
-- [Media Player](/integrations/media_player/) (`media_player`)
+- [Media player](/integrations/media_player/) (`media_player`)
- [Notification](/integrations/notify/) (`notify`)
- [Number](/integrations/number/) (`number`)
- [Remote](/integrations/remote/) (`remote`)
@@ -78,7 +78,7 @@ Available demo platforms:
- [Text-to-speech](/integrations/tts/) (`tts`)
- [Update](/integrations/update/) (`update`)
- [Vacuum](/integrations/vacuum/) (`vacuum`)
-- [Water Heater](/integrations/water_heater/) (`water_heater`)
+- [Water heater](/integrations/water_heater/) (`water_heater`)
- [Weather](/integrations/weather/) (`weather`)
To integrate a demo platform in Home Assistant, add the following section to your `configuration.yaml` file:
diff --git a/source/_integrations/denon.markdown b/source/_integrations/denon.markdown
index e94722f3d4a..6ee852040d0 100644
--- a/source/_integrations/denon.markdown
+++ b/source/_integrations/denon.markdown
@@ -2,7 +2,7 @@
title: Denon Network Receivers
description: Instructions on how to integrate Denon Network Receivers into Home Assistant.
ha_category:
- - Media Player
+ - Media player
ha_iot_class: Local Polling
ha_release: 0.7.2
ha_domain: denon
diff --git a/source/_integrations/denonavr.markdown b/source/_integrations/denonavr.markdown
index 674d0b68a62..83addea1135 100644
--- a/source/_integrations/denonavr.markdown
+++ b/source/_integrations/denonavr.markdown
@@ -2,7 +2,7 @@
title: Denon AVR Network Receivers
description: Instructions on how to integrate Denon AVR Network Receivers into Home Assistant.
ha_category:
- - Media Player
+ - Media player
ha_iot_class: Local Push
ha_release: 0.7.2
ha_domain: denonavr
@@ -36,6 +36,7 @@ Known supported devices:
- Denon AVR-X2500H
- Denon AVR-X2600H
- Denon AVR-X2700H
+- Denon AVR-X2800H
- Denon AVR-X3000
- Denon AVR-X3200W
- Denon AVR-X3300W
diff --git a/source/_integrations/derivative.markdown b/source/_integrations/derivative.markdown
index 6ad0f161a48..38675da77c2 100644
--- a/source/_integrations/derivative.markdown
+++ b/source/_integrations/derivative.markdown
@@ -39,7 +39,7 @@ Time unit:
description: SI unit of time of the derivative. If this parameter is set, the unit of measurement will be set to **x/y** where **x** is the unit of the source sensor and **y** is the value of this parameter.
{% endconfiguration_basic %}
-## YAML Configuration
+## YAML configuration
Alternatively, this integration can be configured and set up manually via YAML
instead. To enable the Derivative sensor in your installation, add the
diff --git a/source/_integrations/device_sun_light_trigger.markdown b/source/_integrations/device_sun_light_trigger.markdown
index 0230b3678f0..11d15d9b8d0 100644
--- a/source/_integrations/device_sun_light_trigger.markdown
+++ b/source/_integrations/device_sun_light_trigger.markdown
@@ -1,10 +1,10 @@
---
-title: Presence-based Lights
+title: Presence-based lights
description: Instructions on how to automate your lights with Home Assistant.
ha_category:
- Automation
- Light
- - Presence Detection
+ - Presence detection
ha_iot_class: Calculated
ha_release: pre 0.7
ha_quality_scale: internal
diff --git a/source/_integrations/device_tracker.markdown b/source/_integrations/device_tracker.markdown
index deda639a96f..1e09e41f4ec 100644
--- a/source/_integrations/device_tracker.markdown
+++ b/source/_integrations/device_tracker.markdown
@@ -1,8 +1,8 @@
---
-title: Device Tracker
+title: Device tracker
description: Instructions on how to setup device tracking within Home Assistant.
ha_category:
- - Presence Detection
+ - Presence detection
ha_release: 0.7
ha_quality_scale: internal
ha_domain: device_tracker
diff --git a/source/_integrations/device_tracker.mqtt.markdown b/source/_integrations/device_tracker.mqtt.markdown
index c9fd4343893..a198427b6f3 100644
--- a/source/_integrations/device_tracker.mqtt.markdown
+++ b/source/_integrations/device_tracker.mqtt.markdown
@@ -1,8 +1,8 @@
---
-title: "MQTT Device Tracker"
+title: "MQTT device tracker"
description: "Instructions on how to use MQTT to track devices in Home Assistant."
ha_category:
- - Presence Detection
+ - Presence detection
ha_iot_class: Configurable
ha_release: 0.7.3
ha_domain: mqtt
diff --git a/source/_integrations/device_tracker.xiaomi.markdown b/source/_integrations/device_tracker.xiaomi.markdown
index f61f8dd6470..fb558ad8116 100644
--- a/source/_integrations/device_tracker.xiaomi.markdown
+++ b/source/_integrations/device_tracker.xiaomi.markdown
@@ -1,8 +1,8 @@
---
-title: "Xiaomi Router"
+title: "Xiaomi router"
description: "Instructions on how to integrate Xiaomi routers into Home Assistant."
ha_category:
- - Presence Detection
+ - Presence detection
ha_release: 0.36
ha_domain: xiaomi
---
diff --git a/source/_integrations/device_trigger.mqtt.markdown b/source/_integrations/device_trigger.mqtt.markdown
index e10b26b56d5..c14cf884a27 100644
--- a/source/_integrations/device_trigger.mqtt.markdown
+++ b/source/_integrations/device_trigger.mqtt.markdown
@@ -1,8 +1,8 @@
---
-title: "MQTT Device Trigger"
+title: "MQTT Device trigger"
description: "Instructions on how to integrate MQTT device triggers within Home Assistant."
ha_category:
- - Device Automation
+ - Device automation
ha_release: 0.106
ha_iot_class: Configurable
ha_domain: mqtt
diff --git a/source/_integrations/devolo_home_control.markdown b/source/_integrations/devolo_home_control.markdown
index b6b238b114d..7f15a6ada03 100755
--- a/source/_integrations/devolo_home_control.markdown
+++ b/source/_integrations/devolo_home_control.markdown
@@ -2,7 +2,7 @@
title: devolo Home Control
description: Instructions on how to integrate devolo Home Control with Home Assistant.
ha_category:
- - Binary Sensor
+ - Binary sensor
- Climate
- Cover
- Light
@@ -48,7 +48,7 @@ The integration provides support for the following Z-Wave devices:
- Fibaro Wall Plug
- Fibaro Double Relay Switch
-## Binary Sensors
+## Binary sensors
The integration provides support for the following Z-Wave devices:
diff --git a/source/_integrations/devolo_home_network.markdown b/source/_integrations/devolo_home_network.markdown
index 10826a4e1a2..759e503b2b6 100755
--- a/source/_integrations/devolo_home_network.markdown
+++ b/source/_integrations/devolo_home_network.markdown
@@ -2,10 +2,10 @@
title: devolo Home Network
description: Instructions on how to integrate devolo Home Network devices with Home Assistant.
ha_category:
- - Binary Sensor
+ - Binary sensor
- Button
- Image
- - Presence Detection
+ - Presence detection
- Sensor
- Switch
- Update
@@ -34,11 +34,11 @@ The devolo Home Network integration allows you to monitor your PLC network.
{% include integrations/config_flow.md %}
-## Device Types
+## Device types
Currently the following device types within Home Assistant are supported.
-### Binary Sensors
+### Binary sensors
- Device attached to the router
- Updates every 5 minutes
@@ -57,7 +57,7 @@ Currently the following device types within Home Assistant are supported.
- Updates every 15 seconds if changes are detected
- Is enabled by default
-### Presence Detection
+### Presence detection
- Detect presence of devices connected to the main or the guest wifi
- Updates every 15 seconds
@@ -82,7 +82,7 @@ Currently the following device types within Home Assistant are supported.
- Turn on/off the device LEDs
- Is enabled by default
-## Update
+### Update
- Update the firmware of a device.
- Is enabled by default but will only give a result if regular checks are enabled on the device.
diff --git a/source/_integrations/dexcom.markdown b/source/_integrations/dexcom.markdown
index a7c638db8be..132e5c2e9d6 100644
--- a/source/_integrations/dexcom.markdown
+++ b/source/_integrations/dexcom.markdown
@@ -41,7 +41,7 @@ If you have a sensor session running, and once you have enabled the Dexcom integ
- Blood glucose value sensor
- Blood glucose trend sensor
-## Example Automation
+## Example automation
```yaml
- id: '1234567890123'
diff --git a/source/_integrations/dhcp.markdown b/source/_integrations/dhcp.markdown
index 672b46e183b..3aeed381890 100644
--- a/source/_integrations/dhcp.markdown
+++ b/source/_integrations/dhcp.markdown
@@ -1,5 +1,5 @@
---
-title: DHCP Discovery
+title: DHCP discovery
description: Discover integrations on the network using DHCP protocol.
ha_category:
- Network
@@ -12,11 +12,11 @@ ha_codeowners:
ha_integration_type: system
---
-The `dhcp` "DHCP Discovery" integration will watch the network for DHCP requests for supported devices and services. Discovered integrations will show up in the discovered section on the integrations page in the configuration panel.
+The **DHCP discovery** {% term integration %} will watch the network for DHCP requests for supported devices and services. Discovered integrations will show up in the discovered section on the integrations page in the configuration panel.
## Configuration
-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:
+This {% term 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
diff --git a/source/_integrations/diagnostics.markdown b/source/_integrations/diagnostics.markdown
index 6f66df09c17..aa210798f7f 100644
--- a/source/_integrations/diagnostics.markdown
+++ b/source/_integrations/diagnostics.markdown
@@ -11,14 +11,14 @@ ha_codeowners:
ha_integration_type: system
---
-The diagnostics integration provides a way to download diagnostic data from
-a device or integration, that can be shared in issue reports. Sharing
+The diagnostics {% term integration %} provides a way to download diagnostic data from
+a {% term device %} or {% term integration %}, that can be shared in issue reports. Sharing
diagnostics data when reporting an issue allows developers to diagnose
and fix your reported problem quicker.
-Screenshot of the Download Diagnostics button on the device page
+Screenshot of the download diagnostics button on the device page
Diagnostics data is provided by an integration, and can be downloaded
diff --git a/source/_integrations/dialogflow.markdown b/source/_integrations/dialogflow.markdown
index 73f8e27c307..1558b5e9427 100644
--- a/source/_integrations/dialogflow.markdown
+++ b/source/_integrations/dialogflow.markdown
@@ -10,7 +10,7 @@ ha_domain: dialogflow
ha_integration_type: integration
---
-The `dialogflow` 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/). When a conversation ends with a user, Dialogflow sends an action and parameters to the webhook.
+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/). When a conversation ends with a user, 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).
diff --git a/source/_integrations/digital_loggers.markdown b/source/_integrations/digital_loggers.markdown
index 2ec329dc28a..6e32a740e10 100644
--- a/source/_integrations/digital_loggers.markdown
+++ b/source/_integrations/digital_loggers.markdown
@@ -2,7 +2,7 @@
title: Digital Loggers
description: Connect and control your Digital Loggers devices using the Belkin WeMo integration
ha_category:
- - Binary Sensor
+ - Binary sensor
- Fan
- Hub
- Light
diff --git a/source/_integrations/digital_ocean.markdown b/source/_integrations/digital_ocean.markdown
index 4ccbac81c3c..b16ceb74c7c 100644
--- a/source/_integrations/digital_ocean.markdown
+++ b/source/_integrations/digital_ocean.markdown
@@ -2,9 +2,9 @@
title: Digital Ocean
description: Instructions on how to integrate the Digital Ocean within Home Assistant.
ha_category:
- - Binary Sensor
+ - Binary sensor
- Switch
- - System Monitor
+ - System monitor
ha_release: '0.30'
ha_iot_class: Local Polling
ha_codeowners:
@@ -16,11 +16,11 @@ ha_platforms:
ha_integration_type: integration
---
-The `digital_ocean` integration allows you to access the information about your [Digital Ocean](https://www.digitalocean.com/) droplets from Home Assistant.
+The **Digital Ocean** {% term integration %} allows you to access the information about your [Digital Ocean](https://www.digitalocean.com/) droplets from Home Assistant.
There is currently support for the following device types within Home Assistant:
-- [Binary Sensor](/integrations/digital_ocean/#binary-sensor)
+- [Binary sensor](/integrations/digital_ocean/#binary-sensor)
- [Switch](/integrations/digital_ocean/#switch)
## Setup
@@ -44,7 +44,7 @@ access_token:
type: string
{% endconfiguration %}
-## Binary Sensor
+## Binary sensor
The `digital_ocean` binary sensor platform allows you to monitor your Digital Ocean droplets.
diff --git a/source/_integrations/directv.markdown b/source/_integrations/directv.markdown
index c69177a701b..14a62d21e9c 100644
--- a/source/_integrations/directv.markdown
+++ b/source/_integrations/directv.markdown
@@ -2,7 +2,7 @@
title: DirecTV
description: Instructions on how to integrate DirecTV receivers into Home Assistant.
ha_category:
- - Media Player
+ - Media player
- Remote
ha_release: 0.25
ha_iot_class: Local Polling
@@ -22,7 +22,7 @@ The DirecTV platform allows you to control a [DirecTV](https://www.directv.com)
For proper integration with Home Assistant, your DirecTV device settings should allow "External Access".
-This is done via series of settings found via "Menu > Settings & Help > Settings > Whole Home > External Device":
+This is done via series of settings found via **Menu** > **Settings & Help** > **Settings** > **Whole Home** > **External Device**:
- External Access: Allow
- Current Program: Allow
@@ -34,7 +34,7 @@ This is done via series of settings found via "Menu > Settings & Help > Settings
### Media control services
-Available services: turn_on, turn_off, media_play, media_pause, media_stop, media_next_track, media_previous_track, play_media
+Available {% term services %}: turn_on, turn_off, media_play, media_pause, media_stop, media_next_track, media_previous_track, play_media
#### Service `media_player.play_media`
diff --git a/source/_integrations/discord.markdown b/source/_integrations/discord.markdown
index f164f2362bf..a5edbf69e38 100644
--- a/source/_integrations/discord.markdown
+++ b/source/_integrations/discord.markdown
@@ -65,7 +65,7 @@ This channel or a user ID has to be used as the target when calling the notifica
When adding the Discord integration you will be asked for an API Key. Enter the hidden **Token** of your bot to link your Discord integration to the bot you created and allow Home Assistant to send messages as that bot.
-## Discord Service Data
+## Discord service data
The following attributes can be placed inside the `data` key of the service call for extended functionality:
diff --git a/source/_integrations/discovergy.markdown b/source/_integrations/discovergy.markdown
index 605d80b19da..80c55ce75e5 100644
--- a/source/_integrations/discovergy.markdown
+++ b/source/_integrations/discovergy.markdown
@@ -16,7 +16,7 @@ ha_platforms:
ha_integration_type: service
---
-The `discovergy` integration allows users to integrate their [Discovergy](https://discovergy.com/) smart meters into Home Assistant.
+The **Discovergy** {% term integration %} allows users to integrate their [Discovergy](https://discovergy.com/) smart meters into Home Assistant.
The integration is using the [official REST API](https://api.discovergy.com/docs/#/) by Discovergy.
The integration supports the following meters within Home Assistant:
@@ -26,17 +26,17 @@ The integration supports the following meters within Home Assistant:
## Prerequisites
-For this integration, you need a Discovergy smart meter, a [Discovergy account](https://my.discovergy.com/) and your credentials.
+For this {% term integration %}, you need a Discovergy smart meter, a [Discovergy account](https://my.discovergy.com/) and your credentials.
{% include integrations/config_flow.md %}
## Electricity meter
-Sensor entities are being added for current active power usage and the all-time total consumption.
+Sensor {% term entities %} are being added for current active power usage and the all-time total consumption.
By default, the sensors for phase-specific current active power usage are disabled.
In case you have a combined meter for consumption and production, the all-time total production is added as well.
## Gas meter
-A Sensor entity is being added for total gas consumption.
+A Sensor {% term entity %} is being added for total gas consumption.
diff --git a/source/_integrations/dlib_face_detect.markdown b/source/_integrations/dlib_face_detect.markdown
index eedff1e2ead..c32345bb643 100644
--- a/source/_integrations/dlib_face_detect.markdown
+++ b/source/_integrations/dlib_face_detect.markdown
@@ -2,7 +2,7 @@
title: Dlib Face Detect
description: Instructions on how to integrate Dlib Face Detect into Home Assistant.
ha_category:
- - Image Processing
+ - Image processing
ha_iot_class: Local Push
ha_release: 0.44
ha_domain: dlib_face_detect
diff --git a/source/_integrations/dlib_face_identify.markdown b/source/_integrations/dlib_face_identify.markdown
index b54acb1bcad..257e238cc30 100644
--- a/source/_integrations/dlib_face_identify.markdown
+++ b/source/_integrations/dlib_face_identify.markdown
@@ -2,7 +2,7 @@
title: Dlib Face Identify
description: Instructions on how to integrate Dlib Face Identify into Home Assistant.
ha_category:
- - Image Processing
+ - Image processing
ha_iot_class: Local Push
ha_release: 0.44
ha_domain: dlib_face_identify
diff --git a/source/_integrations/dlink.markdown b/source/_integrations/dlink.markdown
index 9f36c0b88b6..5f275cf3e67 100644
--- a/source/_integrations/dlink.markdown
+++ b/source/_integrations/dlink.markdown
@@ -15,7 +15,7 @@ ha_codeowners:
ha_integration_type: device
---
-The D-Link Wi-Fi Smart Plugs integration allows you to control the state of your [D-Link Wi-Fi Smart Plugs](https://us.dlink.com/en/consumer/smart-home).
+The **D-Link Wi-Fi Smart Plugs** {% term integration %} allows you to control the state of your [D-Link Wi-Fi Smart Plugs](https://us.dlink.com/en/consumer/smart-home).
{% include integrations/config_flow.md %}
@@ -26,4 +26,4 @@ Supported devices (tested):
Password: The default password is the PIN included on the configuration card or on the back of the unit.
-Use the legacy protocol in case the integration does not work. This enables limited support for legacy firmware protocols (Tested with v1.24, v1.26). Data such as power consumption will not be available. The temperature will also show a freezing level.
+Use the legacy protocol in case the D-Link Wi-Fi Smart Plugs does not work. This enables limited support for legacy firmware protocols (Tested with v1.24, v1.26). Data such as power consumption will not be available. The temperature will also show a freezing level.
diff --git a/source/_integrations/dlna_dmr.markdown b/source/_integrations/dlna_dmr.markdown
index 8ce50d0a221..a915098ab80 100644
--- a/source/_integrations/dlna_dmr.markdown
+++ b/source/_integrations/dlna_dmr.markdown
@@ -2,7 +2,7 @@
title: DLNA Digital Media Renderer
description: Instructions on how to integrate a DLNA DMR device into Home Assistant.
ha_category:
- - Media Player
+ - Media player
ha_release: 0.76
ha_iot_class: Local Push
ha_config_flow: true
@@ -16,7 +16,7 @@ ha_ssdp: true
ha_integration_type: integration
---
-The `dlna_dmr` platform allows you to control a [DLNA Digital Media Renderer](https://www.dlna.org/), such as DLNA enabled TVs or radios.
+The **DLNA Digital Media Renderer** {% term integration %} allows you to control a [DLNA Digital Media Renderer](https://www.dlna.org/), such as DLNA enabled TVs or radios.
Please note that some devices, such as Samsung TVs, are rather picky about the source used to play from. The TTS service might not work in combination with these devices. If the play_media service does not work, please try playing from a DLNA/DMS (such as [MiniDLNA](https://sourceforge.net/projects/minidlna/)).
@@ -24,7 +24,7 @@ Please note that some devices, such as Samsung TVs, are rather picky about the s
## Options
-Options for DLNA DMR devices can be set going to **Settings** -> **Devices & Services** -> **DLNA Digital Media Renderer** -> **Configuration**.
+Options for DLNA DMR devices can be set going to **Settings** > **Devices & Services** > **DLNA Digital Media Renderer** > **Configuration**.
{% configuration_basic %}
Event listener port:
@@ -59,4 +59,4 @@ Most DLNA DMR devices can play media from local HTTP servers. For best results,
### Media sources
-The DLNA Digital Media Renderer integration can browse any configured [Media Source](/integrations/media_source/). Displayed media will be filtered based on the capabilities of the DLNA DMR device.
+The DLNA Digital Media Renderer integration can browse any configured [media source](/integrations/media_source/). Displayed media will be filtered based on the capabilities of the DLNA DMR device.
diff --git a/source/_integrations/dlna_dms.markdown b/source/_integrations/dlna_dms.markdown
index 3325febb17b..7b487ba6f92 100644
--- a/source/_integrations/dlna_dms.markdown
+++ b/source/_integrations/dlna_dms.markdown
@@ -2,7 +2,7 @@
title: DLNA Digital Media Server
description: Instructions on how to access media stored on a DLNA DMS device with Home Assistant.
ha_category:
- - Media Source
+ - Media source
ha_release: 2022.3
ha_iot_class: Local Polling
ha_config_flow: true
diff --git a/source/_integrations/dnsip.markdown b/source/_integrations/dnsip.markdown
index c17f06b4dff..f99bf6f57a5 100644
--- a/source/_integrations/dnsip.markdown
+++ b/source/_integrations/dnsip.markdown
@@ -14,9 +14,9 @@ ha_codeowners:
ha_integration_type: integration
---
-The DNS IP integration will expose an IP address, fetched via DNS resolution (every 2 minutes), as its value. It provides both IPv4 and IPv6 lookup as separate sensors depending on accessibility to resolvers.
+The **DNS IP** {% term integration %} will expose an IP address, fetched via DNS resolution (every 2 minutes), as its value. It provides both IPv4 and IPv6 lookup as separate sensors depending on accessibility to resolvers.
-1. When you enable the integration with the default value, it will query the [OpenDNS](https://www.opendns.com/) nameservers with the hostname `myip.opendns.com`, which will resolve to your external/public IP address.
+1. When you enable the {% term integration %} with the default value, it will query the [OpenDNS](https://www.opendns.com/) nameservers with the hostname `myip.opendns.com`, which will resolve to your external/public IP address.
2. If you specify a `hostname`, a regular DNS lookup will be performed, providing you the IP the hostname resolves to.
{% include integrations/config_flow.md %}
diff --git a/source/_integrations/dominos.markdown b/source/_integrations/dominos.markdown
index eb4adb7ab54..e1634168866 100644
--- a/source/_integrations/dominos.markdown
+++ b/source/_integrations/dominos.markdown
@@ -9,17 +9,17 @@ ha_domain: dominos
ha_integration_type: integration
---
-The `dominos` integration allows you to order Dominos Pizza from within your Home Assistant scripts and automations.
+The **Dominos Pizza** {% term integration %} allows you to order Dominos Pizza from within your Home Assistant scripts and automations.
At present, this integration only supports ordering within Canada and the US.
## Configuration
-To enable the integration, you need to set up your customer information and define some orders.
+To enable the {% term integration %}, you need to set up your customer information and define some orders.
Orders are a group of product codes. You can get these product codes by inspecting an order request from the Dominos web app, or you can [add this custom panel by following this readme](https://github.com/craigjmidwinter/hass-dominos-panel) to see the available product codes in a separate panel in your install.
-Currently, there is no support in this integration for toppings, coupons or order tracking.
+Currently, there is no support in this integration for toppings, coupons, or order tracking.
```yaml
dominos:
@@ -35,7 +35,7 @@ dominos:
- P12IPAZA
```
-Now you can use the Dominos service to order pizza within your automations:
+Now you can use the Dominos {% term service %} to order pizza within your automations:
```yaml
- service: dominos.order
diff --git a/source/_integrations/doods.markdown b/source/_integrations/doods.markdown
index ff48113c176..9160920a513 100644
--- a/source/_integrations/doods.markdown
+++ b/source/_integrations/doods.markdown
@@ -2,7 +2,7 @@
title: DOODS - Dedicated Open Object Detection Service
description: Detect and recognize objects with DOODS.
ha_category:
- - Image Processing
+ - Image processing
ha_iot_class: Local Polling
ha_release: '0.100'
ha_domain: doods
diff --git a/source/_integrations/doorbird.markdown b/source/_integrations/doorbird.markdown
index a9530b6f9c3..d8a190a446b 100644
--- a/source/_integrations/doorbird.markdown
+++ b/source/_integrations/doorbird.markdown
@@ -20,7 +20,7 @@ ha_platforms:
ha_integration_type: integration
---
-The `doorbird` implementation allows you to integrate your [DoorBird](https://www.doorbird.com/) device in Home Assistant.
+The **DoorBird** {% term integration %} allows you to integrate your [DoorBird](https://www.doorbird.com/) device in Home Assistant.
There is currently support for the following device types within Home Assistant:
@@ -54,7 +54,8 @@ See [Automation Example](#automation-example) section below for details on how t
Events will not be received in Home Assistant until a schedule is defined via the DoorBird app.
-### Clearing Registered Events
+### Clearing registered events
+
Events can be cleared from DoorBird devices by visiting a special URL.
Simply open a new browser window and navigate to `{Home Assistant URL}/api/doorbird/clear?token={DEVICE_TOKEN}`. Replace `{Home Assistant URL}` with the full path to your running instance, such as `
@@ -64,7 +65,7 @@ Please note that clearing device events will require configuration steps above t
If DoorBird was setup using UI prompts, a token can be discovered through DoorBird App by clicking settings (cog icon) -> Administration-> LOGIN (using your App Administration details). Under the "FAVORITES" section, choose "HTTP(S) Calls". This displays all events and the associated HTTP URL. In that URL field, you will be able to see the token that was auto-generated by Home Assistant.
-### Event Data
+### Event data
Each event will include live image and video URLs for the DoorBird device that triggered the event. These URLs can be found on the event data and are helpful in automation actions. For example, you could use `html5_viewer_url` on a notification to be linked directly to the live view of the device that triggered the automation.
@@ -98,7 +99,7 @@ On the desired event, you should be able to specify blocks of time for when you
Note: Remember to complete the schedule assignment steps above for each event type you registered. If you are configuring HTTP Call(s) schedules for registered RFID tags, please note that you will have to enable/configure the schedule for each RFID tag.
-## Automation Example
+## Automation example
The example automation below shows how to turn on a light when somebody presses the DoorBird call button:
@@ -119,7 +120,6 @@ You can also create automation actions based on the DoorBird RFID scanner being
The `doorbird` implementation allows you to view the live video, the last doorbell ring image, and the last motion sensor image from your [DoorBird](https://www.doorbird.com/) device in Home Assistant.
-
## Button
The `doorbird` button platform allows you to power connected relays and trigger the low-light/dark Infra-Red (IR) array on your [DoorBird](https://www.doorbird.com/) video doorbell device.
diff --git a/source/_integrations/dovado.markdown b/source/_integrations/dovado.markdown
index f8a3b4c803f..d71294f8838 100644
--- a/source/_integrations/dovado.markdown
+++ b/source/_integrations/dovado.markdown
@@ -4,7 +4,7 @@ description: How to integrate Dovado within Home Assistant.
ha_category:
- Notifications
- Sensor
- - System Monitor
+ - System monitor
ha_release: 0.87
ha_iot_class: Local Polling
ha_domain: dovado
diff --git a/source/_integrations/downloader.markdown b/source/_integrations/downloader.markdown
index 4a301f880c6..34f25bbd291 100644
--- a/source/_integrations/downloader.markdown
+++ b/source/_integrations/downloader.markdown
@@ -43,7 +43,7 @@ This will download the file from the given URL.
| `filename` | yes | Determine the filename. |
| `overwrite` | yes | Whether to overwrite the file or not, defaults to `false`. |
-### Download Status Events
+### Download status events
When a download finished successfully, Home Assistant will emit a `downloader_download_completed` event to the event bus which you can use to write automations against.
In case download failed another event `downloader_download_failed` is emitted to indicate that the download did not complete successfully.
@@ -55,7 +55,7 @@ Along with the event the following payload parameters are available:
| `url` | The `url` that was requested.|
| `filename` | The `name` of the file that was being downloaded.|
-#### Example Automation:
+#### Example automation:
```yaml
- alias: "Download Failed Notification"
diff --git a/source/_integrations/dremel_3d_printer.markdown b/source/_integrations/dremel_3d_printer.markdown
index 2ccd3f5598c..3c5b08b3f5c 100644
--- a/source/_integrations/dremel_3d_printer.markdown
+++ b/source/_integrations/dremel_3d_printer.markdown
@@ -2,7 +2,7 @@
title: Dremel 3D Printer
description: Instructions on how to integrate a Dremel 3D Printer into Home Assistant.
ha_category:
- - 3D Printing
+ - 3D printing
- Sensor
ha_iot_class: Local Polling
ha_release: 2023.7
diff --git a/source/_integrations/dsmr_reader.markdown b/source/_integrations/dsmr_reader.markdown
index f016a67e3bb..f355a282af1 100644
--- a/source/_integrations/dsmr_reader.markdown
+++ b/source/_integrations/dsmr_reader.markdown
@@ -34,7 +34,7 @@ To use this DSMR Reader sensor integration, you need to have a DSMR Reader insta
{% include integrations/config_flow.md %}
-## Configuring the Energy Dashboard
+## Configuring the energy dashboard
It is most advisable to not use the "total" and "daily" sources. The regular "reading" sensors provide the most stable source of data for Home Assistant to use. These MQTT values are part of the "Telegram: Split topic" MQTT values within DSMR Reader, so make sure to enable them.
diff --git a/source/_integrations/dunehd.markdown b/source/_integrations/dunehd.markdown
index dd259068844..aac14475cd6 100644
--- a/source/_integrations/dunehd.markdown
+++ b/source/_integrations/dunehd.markdown
@@ -2,7 +2,7 @@
title: Dune HD
description: Instructions on how to integrate Dune HD media players into Home Assistant.
ha_category:
- - Media Player
+ - Media player
ha_iot_class: Local Polling
ha_release: 0.34
ha_domain: dunehd
@@ -12,7 +12,7 @@ ha_platforms:
ha_integration_type: integration
---
-The `Dune HD` integration allows you to control a [Dune HD media player](https://dune-hd.com/eng/products/full_hd_media_players) from Home Assistant. Support is based on the official [IP protocol](https://dune-hd.com/support/ip_control/dune_ip_control_overview.txt) published by Dune.
+The **Dune HD** {% term integration %} allows you to control a [Dune HD media player](https://dune-hd.com/eng/products/full_hd_media_players) from Home Assistant. Support is based on the official [IP protocol](https://dune-hd.com/support/ip_control/dune_ip_control_overview.txt) published by Dune.
Devices with firmware 110127_2105_beta or above are supported. Some functions may depend on the version of the protocol (volume / mute control is only available with version 2 onwards).
diff --git a/source/_integrations/duotecno.markdown b/source/_integrations/duotecno.markdown
index af222d79c52..8a3c7e8792e 100644
--- a/source/_integrations/duotecno.markdown
+++ b/source/_integrations/duotecno.markdown
@@ -22,7 +22,7 @@ ha_integration_type: integration
ha_quality_scale: silver
---
-The Duotecno integration can be used to control [Duotecno](https://www.duotecno.be/) nodes in Home Assistant.
+The **Duotecno** {% term integration %} can be used to control [Duotecno](https://www.duotecno.be/) nodes in Home Assistant.
There is currently support for the following device types within Home Assistant:
diff --git a/source/_integrations/dwd_weather_warnings.markdown b/source/_integrations/dwd_weather_warnings.markdown
index c31d6a1dc17..ce7aaefcf18 100644
--- a/source/_integrations/dwd_weather_warnings.markdown
+++ b/source/_integrations/dwd_weather_warnings.markdown
@@ -16,7 +16,7 @@ ha_platforms:
ha_integration_type: integration
---
-The Deutscher Wetterdienst Weather Warnings integration uses the [Deutscher Wetterdienst (DWD)](https://www.dwd.de) as a source for current and advance weather warnings. The configured sensor checks for data every 15 minutes.
+The **Deutscher Wetterdienst Weather Warnings** {% term integration %} uses the [Deutscher Wetterdienst (DWD)](https://www.dwd.de) as a source for current and advance weather warnings. The configured sensor checks for data every 15 minutes.
{% include integrations/config_flow.md %}
diff --git a/source/_integrations/dynalite.markdown b/source/_integrations/dynalite.markdown
index 9d8a4dd80d1..8e8b23052b4 100755
--- a/source/_integrations/dynalite.markdown
+++ b/source/_integrations/dynalite.markdown
@@ -43,7 +43,7 @@ Since Philips Dynalite has virtually no auto-discover capabilities, once it is a
There are global setup parameters and advanced parameters that should normally be left as is. The most important part is defining the areas. Each area normally corresponds to a room or function. They have to be added manually via the UI and match the setup of the existing dynalite installation.
-## Initial Configuration and Discovery
+## Initial configuration and discovery
Maybe the most difficult thing about a Dynalite system is finding out the areas and channel mapping. If you have them or have access to the Dynalite software and your configuration files, this could be easy,
but in the likely case that your system was installed by an integrator, you will have to discover them on your own.
diff --git a/source/_integrations/ecoal_boiler.markdown b/source/_integrations/ecoal_boiler.markdown
index 7d224a0708b..7c9d0e57e75 100644
--- a/source/_integrations/ecoal_boiler.markdown
+++ b/source/_integrations/ecoal_boiler.markdown
@@ -2,7 +2,7 @@
title: eSterownik eCoal.pl Boiler
description: Instructions on how to integrate eSterownik.pl eCoal.pl controller into Home Assistant.
ha_category:
- - Water Heater
+ - Water heater
ha_release: 0.87
ha_iot_class: Local Polling
ha_domain: ecoal_boiler
diff --git a/source/_integrations/ecobee.markdown b/source/_integrations/ecobee.markdown
index 08cfc362536..4accedf96bb 100644
--- a/source/_integrations/ecobee.markdown
+++ b/source/_integrations/ecobee.markdown
@@ -2,7 +2,7 @@
title: ecobee
description: Instructions for how to integrate ecobee thermostats and sensors within Home Assistant.
ha_category:
- - Binary Sensor
+ - Binary sensor
- Climate
- Humidifier
- Notifications
@@ -30,9 +30,9 @@ ha_homekit: true
ha_integration_type: integration
---
-The `ecobee` integration lets you control and view sensor data from [ecobee](https://ecobee.com) thermostats.
+The **ecobee** {% term integration %} lets you control and view sensor data from [ecobee](https://ecobee.com) thermostats.
-## Preliminary Steps
+## Preliminary steps
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.
@@ -61,7 +61,7 @@ Your new application will now appear on the left. Upon clicking on the applicati
3. In the next pop-up box, you will be presented with a unique 8 character code separated by a dash (format: XXXX-XXXX), which you will need to authorize in the [ecobee consumer portal](https://www.ecobee.com/consumerportal/index.html). You can do this by logging in, selecting **My Apps** from the hamburger menu, clicking **Add Application** on the left, entering the PIN code from Home Assistant, clicking **Validate** and then **Add Application** in the bottom right.
4. After authorizing the app with ecobee, return to Home Assistant and click **Submit**. If the authorization was successful, a configuration entry will be created and your thermostats, ventilators and sensors will be available in Home Assistant.
-## Manual Configuration
+## Manual configuration
If you prefer to set up the integration in [`configuration.yaml`](/docs/configuration/), add your API key (and optional parameters) as follows (however, you must still complete authorization via the **Integrations** panel):
diff --git a/source/_integrations/econet.markdown b/source/_integrations/econet.markdown
index 9020cb1298f..6307339546d 100644
--- a/source/_integrations/econet.markdown
+++ b/source/_integrations/econet.markdown
@@ -2,10 +2,10 @@
title: Rheem EcoNet Products
description: Instructions on how to integrate Rheem EcoNet water heaters into Home Assistant.
ha_category:
- - Binary Sensor
+ - Binary sensor
- Climate
- Sensor
- - Water Heater
+ - Water heater
ha_release: 0.61
ha_iot_class: Cloud Push
ha_domain: econet
@@ -21,7 +21,7 @@ ha_platforms:
ha_integration_type: integration
---
-The EcoNet integration is consuming the information provided by a [EcoNet enabled Rheem water heater or thermostat](https://www.rheem.com/econet).
+The **EcoNet** {% term integration %} is consuming the information provided by a [EcoNet enabled Rheem water heater or thermostat](https://www.rheem.com/econet).
{% include integrations/config_flow.md %}
@@ -29,14 +29,14 @@ The EcoNet integration is consuming the information provided by a [EcoNet enable
EcoNet devices may be represented by one or more platforms.
-- [Binary Sensor](#binary-sensor)
+- [Binary sensor](#binary-sensor)
- [Climate](#climate)
- [Sensor](#sensor)
-- [Water Heater](#water-heater)
+- [Water heater](#water-heater)
-### Binary Sensor
+### Binary sensor
-The EcoNet Binary Sensor platform lets you view binary states of sensors associated with your EcoNet thermostat or water heater. For example, if the device is currently running.
+The EcoNet Binary sensor platform lets you view binary states of sensors associated with your EcoNet thermostat or water heater. For example, if the device is currently running.
### Climate
@@ -46,6 +46,6 @@ The EcoNet Climate platform lets you control your EcoNet thermostat. Multi-zone
The EcoNet Sensor platform lets you view sensors associated with your EcoNet thermostat or water heater. For example, alert count or available hot water.
-### Water Heater
+### Water heater
-The EcoNet Water Heater platform lets you control your EcoNet water heater. Water Heaters do not report the current water temperature.
+The EcoNet water heater platform lets you control your EcoNet water heater. Water heaters do not report the current water temperature.
diff --git a/source/_integrations/ecovacs.markdown b/source/_integrations/ecovacs.markdown
index 048db114bcd..b514bf842d0 100644
--- a/source/_integrations/ecovacs.markdown
+++ b/source/_integrations/ecovacs.markdown
@@ -170,7 +170,7 @@ template:
{% endraw %}
-### Handling Errors
+### Handling errors
The vacuum entity has an `error` attribute that will contain the _most recent_ error message that came from the vacuum. There is not a comprehensive list of all error messages, so you may need to do some experimentation to determine the error messages that your vacuum can send.
diff --git a/source/_integrations/ecowitt.markdown b/source/_integrations/ecowitt.markdown
index 474ea3045d1..d56a1c778c1 100644
--- a/source/_integrations/ecowitt.markdown
+++ b/source/_integrations/ecowitt.markdown
@@ -2,7 +2,7 @@
title: Ecowitt
description: Instructions on how to integrate Ecowitt Weather Station within Home Assistant.
ha_category:
- - Binary Sensor
+ - Binary sensor
- Sensor
ha_release: 2022.9
ha_iot_class: Local Push
diff --git a/source/_integrations/efergy.markdown b/source/_integrations/efergy.markdown
index 5f79797811a..3c68767f8eb 100644
--- a/source/_integrations/efergy.markdown
+++ b/source/_integrations/efergy.markdown
@@ -27,7 +27,7 @@ To get an app token:
3. Click on App tokens
4. Click "Add token"
-## Integration Entities
+## Integration entities
The following sensors will be created:
diff --git a/source/_integrations/egardia.markdown b/source/_integrations/egardia.markdown
index b93faed3d97..024185e55a0 100644
--- a/source/_integrations/egardia.markdown
+++ b/source/_integrations/egardia.markdown
@@ -3,7 +3,7 @@ title: Egardia
description: Instructions on how to setup Egardia / Woonveilig within Home Assistant.
ha_category:
- Alarm
- - Binary Sensor
+ - Binary sensor
- Hub
ha_release: 0.65
ha_iot_class: Local Polling
@@ -16,13 +16,13 @@ ha_platforms:
ha_integration_type: integration
---
-The `egardia` platform enables the ability to control an [Egardia](https://egardia.com/)/[Woonveilig](https://woonveilig.nl) control panel. These alarm panels are known under different brand names across the world, including Woonveilig in the Netherlands. This was tested on the WL-1716, GATE-01, GATE-02 and GATE-03 versions of the Egardia/Woonveilig platform. Not only will you integrate your alarm control panel, supported sensors (door contacts at this moment) will be added automatically.
+The **Egardia** {% term integration %} enables the ability to control an [Egardia](https://egardia.com/)/[Woonveilig](https://woonveilig.nl) control panel. These alarm panels are known under different brand names across the world, including Woonveilig in the Netherlands. This was tested on the WL-1716, GATE-01, GATE-02 and GATE-03 versions of the Egardia/Woonveilig platform. Not only will you integrate your alarm control panel, supported sensors (door contacts at this moment) will be added automatically.
You will need to know the IP of your alarm panel on your local network. Test if you can login to the panel by browsing to the IP address and log in using your Egardia/Woonveilig account.
## Basic configuration
-To enable the integration with your alarm panel, add the following lines to your `configuration.yaml` file:
+To enable the {% term integration %} with your alarm panel, add the following lines to your `configuration.yaml` file:
```yaml
# Example configuration.yaml entry
@@ -123,7 +123,7 @@ There seem to be multiple versions of software running on GATE-02 devices; we ha
Note that for all code groups (*arm*,*disarm*, etc) multiple codes can be entered since each sensor triggers with a different code and each user of the system has its own arm and disarm codes. Also note that your system will do regular system checks which will be reported as well. Since Home Assistant provides no way of handling them properly, you can enter those codes as *ignore* (again, multiple codes can be used here). The egardia integration will ignore these codes and continue returning the old status if it receives any of the codes that are listed as ignore. This is useful for example when you have armed your alarm at night: normally a system check will occur at least once during the night and if that code is not specified anywhere Home Assistant will set the status of the alarm to its default, which is unarmed. This is in fact wrong. Listing the code as ignore changes this behavior and Home Assistant will continue to show the status the alarm is in (disarm, arm, home, triggered) even when system checks occur.
5. Test your setup and enjoy. The integration will update if the alarm status changes, including triggers. You can use this to build your own automations and send notifications as you wish. *Note*: previous versions required a separate egardiaserver to be set up. This is no longer necessary and corresponding system services can be removed (using systemctl).
-## Binary Sensor
+## Binary sensor
The `egardia` platform allows you to get data from your [Egardia](https://www.egardia.com)/[Woonveilig](https://www.woonveilig.nl) binary sensors from within Home Assistant.
Currently only door contacts are supported. IR sensors are not supported and will probably never be since their status cannot be read outside of the alarm control panel. Smoke sensors and others might be added but currently are not supported.
diff --git a/source/_integrations/elkm1.markdown b/source/_integrations/elkm1.markdown
index 77eeffa6292..7f648909bbf 100644
--- a/source/_integrations/elkm1.markdown
+++ b/source/_integrations/elkm1.markdown
@@ -4,7 +4,7 @@ description: Instructions to setup the Elk-M1 controller.
ha_release: 0.81
ha_category:
- Alarm
- - Binary Sensor
+ - Binary sensor
- Climate
- Hub
- Light
@@ -36,7 +36,7 @@ The Elk-M1 controller is manufactured by [Elk Products](https://www.elkproducts.
There is currently support for the following device types within Home Assistant:
- **Alarm** - An ElkM1 area (also known as partition) is represented as an `alarm_control_panel`.
-- **Binary Sensor** - ElkM1 zones that have 4 states (i.e.: are not analog zones) are represented as `binary_sensor` entities. `Normal` is `off` and any of the other values is `on`.
+- **Binary sensor** - ElkM1 zones that have 4 states (i.e.: are not analog zones) are represented as `binary_sensor` entities. `Normal` is `off` and any of the other values is `on`.
- **Climate** - An ElkM1 thermostat is represented as a `climate` entity.
- **Light** - An ElkM1 light (which can be X10, Insteon, UPB) is represented as a `light`.
- **Scene** - ElkM1 tasks are represented as `scene` entities.
@@ -46,13 +46,13 @@ There is currently support for the following device types within Home Assistant:
The implementation follows the Elk Products ElkM1 "ASCII Protocol & Interface
Specification, Revision 1.84" document. This document can be found on the Internet.
-## ElkM1 Configuration and Version
+## ElkM1 configuration and version
In order for the ElkM1 integration to work to its fullest with Home Assistant the
ElkM1 panel must be configured correctly. This section describes the configuration
required on the ElkM1 panel.
-### ElkM1 Version
+### ElkM1 version
ElkM1 should be running:
@@ -63,7 +63,7 @@ Force arm away and stay are available in 5.3.0 or higher.
Many features will work with lower versions of the ElkM1. Check the "ElkM1 RS232 Protocol" manual for details.
-### ELK-M1XEP Version
+### ELK-M1XEP version
The ELK-M1XEP is the Ethernet controller board for the ElkM1. If connecting the integration
in secure mode the version of the ELK-M1XEP determines which secure protocol is supported.
@@ -440,7 +440,7 @@ The `event_data` contains the following:
## Services
-Besides the standard Home Assistant services for Alarm Control Panel, Climate, Light, Scene, Sensor,
+Besides the standard Home Assistant services for Alarm control panel, Climate, Light, Scene, Sensor,
and Switch the ElkM1 integration offers these additional services:
- `elkm1.alarm_arm_home_instant`
diff --git a/source/_integrations/emby.markdown b/source/_integrations/emby.markdown
index 6bc07de106a..2ac6a08e309 100644
--- a/source/_integrations/emby.markdown
+++ b/source/_integrations/emby.markdown
@@ -2,7 +2,7 @@
title: Emby
description: Instructions on how to integrate Emby into Home Assistant.
ha_category:
- - Media Player
+ - Media player
ha_release: 0.32
ha_iot_class: Local Push
ha_codeowners:
@@ -13,7 +13,7 @@ ha_platforms:
ha_integration_type: integration
---
-The `emby` platform allows you to control a [Emby](https://emby.media/) multimedia system from Home Assistant.
+The **Emby** {% term integration %} allows you to control a [Emby](https://emby.media/) multimedia system from Home Assistant.
To add Emby to your installation, add the following to your `configuration.yaml` file:
diff --git a/source/_integrations/enigma2.markdown b/source/_integrations/enigma2.markdown
index 577c5e230d6..372fb9f703e 100644
--- a/source/_integrations/enigma2.markdown
+++ b/source/_integrations/enigma2.markdown
@@ -2,7 +2,7 @@
title: Enigma2 (OpenWebif)
description: Instructions on how to integrate an Enigma2 based box running OpenWebif into Home Assistant.
ha_category:
- - Media Player
+ - Media player
ha_release: '0.90'
ha_iot_class: Local Polling
ha_codeowners:
diff --git a/source/_integrations/enocean.markdown b/source/_integrations/enocean.markdown
index ea70d9b8e4d..acf996f1936 100644
--- a/source/_integrations/enocean.markdown
+++ b/source/_integrations/enocean.markdown
@@ -2,7 +2,7 @@
title: EnOcean
description: Connect EnOcean devices to Home Assistant
ha_category:
- - Binary Sensor
+ - Binary sensor
- Hub
- Light
- Sensor
@@ -27,7 +27,7 @@ The EnOcean integration adds support for some of these devices. You will need a
There is currently support for the following device types within Home Assistant:
-- [Binary Sensor](#binary-sensor) - Wall switches
+- [Binary sensor](#binary-sensor) - Wall switches
- [Sensor](#sensor) - Power meters, temperature sensors, humidity sensors and window handles
- [Light](#light) - Dimmers
- [Switch](#switch)
@@ -51,7 +51,7 @@ Support for tech-in messages is not implemented.
Despite the UI-based configuration of the hub, the entities are still configured using YAML see next chapters).
-## Binary Sensor
+## Binary sensor
This can typically be one of those batteryless wall switches.
Tested with:
diff --git a/source/_integrations/enphase_envoy.markdown b/source/_integrations/enphase_envoy.markdown
index bf9fe4a7c5d..51ff02646d0 100644
--- a/source/_integrations/enphase_envoy.markdown
+++ b/source/_integrations/enphase_envoy.markdown
@@ -52,15 +52,15 @@ For newer models running firmware 7 and greater, you will need your Enlighten cl
For models running firmware 5 and older, use `installer` for the username. No password is required. The integration will automatically detect the `installer` password.
-## Enpower Load Shedding Relays
+## Enpower load shedding relays
The Enphase Enpower has 4 load shedding relays that can be used to control non-essential loads in your home. These have two main modes of operation:
### Standard
When the mode entity is set to standard, you can simply set the state of the relay to be powered or not powered for each mode of operation: on grid, off grid, and on generator.
-### Battery Level
+### Battery level
When the relay mode is set to battery level, the relays will turn on and off based on the remaining battery level of your Encharge batteries. Two number entities are available to control the cutoff and restore levels for the relays. When the battery level drops below the cutoff level, the relays will turn off. When the battery level rises above the restore level, the relays will turn back on.
-## Polling Interval
+## Polling interval
The default polling interval is 60 seconds. To customize the polling interval, refer to [defining a custom polling interval](/common-tasks/general/#defining-a-custom-polling-interval). Specify the envoy device as a target of the service using the `+ choose device` button. Updating the envoy will also update the related devices like the inverters; there is no need to split them into separate entities or add all inverter devices. When using multiple Envoys, add them as targets or create separate custom polling intervals as needed.
diff --git a/source/_integrations/environment_canada.markdown b/source/_integrations/environment_canada.markdown
index 41bb5efce2b..db6bcc9614e 100644
--- a/source/_integrations/environment_canada.markdown
+++ b/source/_integrations/environment_canada.markdown
@@ -20,11 +20,11 @@ ha_config_flow: true
ha_integration_type: integration
---
-The Environment Canada integration provides meteorological data for Canadian locations from [Environment and Climate Change Canada](https://weather.gc.ca/index_e.html).
+The **Environment Canada** {% term integration %} provides meteorological data for Canadian locations from [Environment and Climate Change Canada](https://weather.gc.ca/index_e.html).
{% include integrations/config_flow.md %}
-## Location Selection
+## Location selection
The integration automatically determines the closest weather station based on the latitude and longitude specified. If integration-specific coordinates are not provided, the coordinates configured for Home Assistant are used.
@@ -45,7 +45,7 @@ The integration will create the entities listed below. Some of the entities are
### Sensors
-#### Conditions and Forecasts
+#### Conditions and forecasts
- Current condition
- Forecast summary
@@ -55,7 +55,7 @@ The integration will create the entities listed below. Some of the entities are
- Humidity
- Visibility
- UV index
-- Air Quality (AQHI)
+- Air quality (AQHI)
#### Temperature
@@ -88,11 +88,11 @@ The integration will create the entities listed below. Some of the entities are
The alert sensors use the number of current alerts as their state, with an attribute containing the title of each alert.
-## Solving Problems
+## Solving problems
The Environment Canada service is very stable and provides high-quality data. Here are some steps that you can take before opening a problem report or posting on the forum.
-### Service Interruptions
+### Service interruptions
Although infrequent, there have been some outages and instabilities of the Environment Canada service. If you see error messages in your logs similar to the one below, it is very unlikely to be a problem with this integration and is likely a problem with the Environment Canada service.
@@ -106,7 +106,7 @@ The first course of action should be to check if there are known problems with t
Not all weather stations provide a complete set of weather/sensor data. The data that is retrieved by this integration can be found [here](https://dd.weather.gc.ca/citypage_weather/xml/). Browsing the XML data for your station will help you to understand what data is (un)available.
-## Template Sensors
+## Template sensors
The configuration snippet below adds a useful [template sensors](/integrations/template/) showing the current "feels like" temperature among air temperature, humidex, and wind chill.
diff --git a/source/_integrations/envisalink.markdown b/source/_integrations/envisalink.markdown
index 0cba7ef0b4a..b216a6a6e5f 100644
--- a/source/_integrations/envisalink.markdown
+++ b/source/_integrations/envisalink.markdown
@@ -3,7 +3,7 @@ title: Envisalink
description: Instructions on how to integrate a DSC/Honeywell alarm panel with Home Assistant using an envisalink evl3/evl4 board.
ha_category:
- Alarm
- - Binary Sensor
+ - Binary sensor
- Sensor
ha_release: 0.23
ha_iot_class: Local Push
@@ -18,15 +18,15 @@ ha_codeowners:
ha_integration_type: integration
---
-The `envisalink` integration will allow Home Assistant users who own either a DSC or Honeywell alarm panel to leverage their alarm system and its sensors to provide Home Assistant with rich information about their homes. Connectivity between Home Assistant and the alarm panel is accomplished through a device produced by Eyez On, known as the Envisalink. The Envisalink evl3 and evl4 boards provide a TCP/IP interface to the alarm panel, where it emulates an alarm keypad. This board also exposes a raw TCP/IP based API, upon which this integration is built. Currently, the Envisalink version 4 is the latest model. This integration supports both the evl3 and the evl4.
+The **Envisalink** {% term integration %} will allow Home Assistant users who own either a DSC or Honeywell alarm panel to leverage their alarm system and its sensors to provide Home Assistant with rich information about their homes. Connectivity between Home Assistant and the alarm panel is accomplished through a device produced by Eyez On, known as the Envisalink. The Envisalink evl3 and evl4 boards provide a TCP/IP interface to the alarm panel, where it emulates an alarm keypad. This board also exposes a raw TCP/IP based API, upon which this integration is built. Currently, the Envisalink version 4 is the latest model. This integration supports both the evl3 and the evl4.
Please visit the [eyezon website](https://www.eyezon.com/) for further information about the evl3 and evl4 boards.
There is currently support for the following device types within Home Assistant:
-- Binary Sensor: Reports on zone status (Check the [type/class](/integrations/binary_sensor/#device-class) list for a possible visualization of your zone.)
+- Binary sensor: Reports on zone status (Check the [type/class](/integrations/binary_sensor/#device-class) list for a possible visualization of your zone.)
- Sensor: Emulates an alphanumeric keypad attached to the alarm panel
-- Alarm Control Panel: Reports on partition status, and can be used to arm/disarm the system
+- Alarm control panel: Reports on partition status, and can be used to arm/disarm the system
This is a fully event-based integration. Any event sent by the Envisalink device will be immediately reflected within Home Assistant.
@@ -112,7 +112,7 @@ panic_type:
default: Police
type: string
zones:
- description: "Envisalink boards have no way to tell us which zones are actually in use, so each zone must be configured in Home Assistant. Zone numbers correspond to the zone numbers configured on your alarm system and must be in the range of 1 to 64. For each zone, at least a name must be given. For more information about the visual representation of a zone, take a look at the [Binary Sensor](/integrations/binary_sensor/#device-class) documentation. *Note: If no zones are specified, Home Assistant will not load any binary_sensor integrations.*"
+ description: "Envisalink boards have no way to tell us which zones are actually in use, so each zone must be configured in Home Assistant. Zone numbers correspond to the zone numbers configured on your alarm system and must be in the range of 1 to 64. For each zone, at least a name must be given. For more information about the visual representation of a zone, take a look at the [binary sensor](/integrations/binary_sensor/#device-class) documentation. *Note: If no zones are specified, Home Assistant will not load any binary_sensor integrations.*"
required: false
type: integer
keys:
diff --git a/source/_integrations/epson.markdown b/source/_integrations/epson.markdown
index 86cd3d8120a..7237026bd94 100644
--- a/source/_integrations/epson.markdown
+++ b/source/_integrations/epson.markdown
@@ -2,7 +2,7 @@
title: Epson
description: Instructions on how to integrate Epson projector into Home Assistant.
ha_category:
- - Media Player
+ - Media player
ha_release: 0.72
ha_iot_class: Local Polling
ha_domain: epson
@@ -14,8 +14,8 @@ ha_platforms:
ha_integration_type: integration
---
-The `epson` platform allows you to control a Epson projector from Home Assistant.
-**Device has to be turned on during initial configuration.**
+The **Epson** {% term integration %} allows you to control a Epson projector from Home Assistant.
+**The device has to be turned on during initial configuration.**
When you want to add a device for the first time, turn it on before following the integration steps.
{% include integrations/config_flow.md %}
diff --git a/source/_integrations/esphome.markdown b/source/_integrations/esphome.markdown
index dc0734346ea..84f5e1a1b26 100644
--- a/source/_integrations/esphome.markdown
+++ b/source/_integrations/esphome.markdown
@@ -57,8 +57,7 @@ ESPHome uses different naming and entity ID rules based on the configuration of
### Friendly naming
- Entity name is a combination of the friendly name and component name
-- Device name is prepended to the entity ID
-- Entity ID uses the ESPHome ID
+- Entity ID is derived from the entity name with the device name prepended
Example:
@@ -69,7 +68,6 @@ esphome:
sensor:
name: "Temperature"
- id: "temperature"
```
The entity will be named `Living room desk Temperature` and will default to having an entity ID of `sensor.livingroomdesk_temperature`.
@@ -88,7 +86,6 @@ esphome:
sensor:
name: "Temperature"
- id: "temperature"
```
The entity will be named `Temperature` and will default to having an entity_id of `sensor.temperature`.
diff --git a/source/_integrations/event.mqtt.markdown b/source/_integrations/event.mqtt.markdown
index 3642a0e8cf2..34c2b7b83fb 100644
--- a/source/_integrations/event.mqtt.markdown
+++ b/source/_integrations/event.mqtt.markdown
@@ -8,7 +8,7 @@ ha_iot_class: Configurable
ha_domain: mqtt
---
-The `mqtt` event platform allows you to process event info from an MQTT message. Events are signals that are emitted when something happens, for example, when a user presses a physical button like a doorbell or when a button on a remote control is pressed. With the event some event attributes can be sent te become available as an attribute on the entity. MQTT events are stateless. For example, a doorbell does not have a state like being "on" or "off" but instead is momentarily pressed.
+The `mqtt` event platform allows you to process event info from an MQTT message. Events are signals that are emitted when something happens, for example, when a user presses a physical button like a doorbell or when a button on a remote control is pressed. With the event some event attributes can be sent to become available as an attribute on the entity. MQTT events are stateless. For example, a doorbell does not have a state like being "on" or "off" but instead is momentarily pressed.
## Configuration
diff --git a/source/_integrations/everlights.markdown b/source/_integrations/everlights.markdown
index 9e6dc1e4be3..3a15032e8f9 100644
--- a/source/_integrations/everlights.markdown
+++ b/source/_integrations/everlights.markdown
@@ -13,7 +13,7 @@ ha_integration_type: integration
[EverLights](https://myeverlights.com/) are permanent Christmas lights installed on a home's gutters or flashing. This integration can change all LEDs in a zone to a single color or activate a pattern that was previously saved to the control box.
-### Configuration Details
+### Configuration details
To enable EverLights, add the following lines to your `configuration.yaml` file:
diff --git a/source/_integrations/evohome.markdown b/source/_integrations/evohome.markdown
index d963e60571f..e555aed6c0c 100644
--- a/source/_integrations/evohome.markdown
+++ b/source/_integrations/evohome.markdown
@@ -4,7 +4,7 @@ description: Instructions on how to integrate a Honeywell Evohome/TCC system wit
ha_category:
- Climate
- Hub
- - Water Heater
+ - Water heater
ha_release: '0.80'
ha_iot_class: Cloud Polling
ha_codeowners:
@@ -16,7 +16,7 @@ ha_platforms:
ha_integration_type: integration
---
-The `evohome` integration links Home Assistant with all _non-US_ [Honeywell Total Connect Comfort (TCC)](https://international.mytotalconnectcomfort.com/Account/Login) CH/DHW systems, such as:
+The **Evohome** {% term integration %} links Home Assistant with all _non-US_ [Honeywell Total Connect Comfort (TCC)](https://international.mytotalconnectcomfort.com/Account/Login) CH/DHW systems, such as:
- the Honeywell Evohome CH/DHW system, and
- the Honeywell Mobile Access Kit with a Round Thermostat
@@ -61,7 +61,7 @@ scan_interval:
This is an IoT cloud-polling integration and the recommended minimum `scan_interval` is 180 seconds. Testing has indicated that this is a safe interval that - by itself - shouldn't cause you to be rate-limited by the vendor. There is little value in shorter intervals, as this integration will automatically force a refresh shortly after any configuration changes.
-## Locations and Zones
+## Locations and zones
TCC systems are implemented as a _location_, which consist of 1-12 _zones_ and, optionally, a DHW controller:
@@ -78,17 +78,17 @@ The DHW controller is represented as a **WaterHeater** entity which will report
Note that there is limited support for schedules: they cannot be changed and there is no facility to backup/restore that data (see [here](https://evohome.readthedocs.io/en/latest/) for such functionality).
-### Round Thermostat
+### Round thermostat
These systems use an internet gateway rather than an Evohome controller. They usually have only one Round Thermostat, although they can have two. Systems with one such thermostat will still appear as two **Climate** entities, one for location mode (away, economy, etc.), and another for the zone setpoint.
-## Temperature Precision
+## Temperature precision
Note that TCC devices may well measure temperatures with very high precision, but the vendor API will report temperatures rounded _towards_ the setpoint (i.e., either up or down) with a precision of 0.5 °C; this a proxy for the deadband as used by other climate systems. Where possible, this integration will leverage an older vendor API to obtain current temperatures with a precision of 0.01 °C.
Therefore, depending upon the above, Home Assistant will display/record current temperatures with a precision of either 0.5 °C or 0.1 °C (it's highest supported precision).
-## System modes, Zone overrides and Inheritance
+## System modes, zone overrides and inheritance
TCC locations can support up to six distinct operating modes: **Auto**, **AutoWithEco**, **Away**, **DayOff**, **HeatingOff**, and **Custom**. Not all systems support all modes.
@@ -112,7 +112,7 @@ Some locations have a hidden mode, **AutoWithReset**, that will behave as **Auto
In the Home Assistant schema, all this is done via a combination of `HVAC_MODE` and `PRESET_MODE` (but also see the state attributes `system_mode_status` and `setpoint_status`, below).
-## Service Calls
+## Service calls
This integration provides its own service calls to expose the full functionality of TCC systems beyond the limitations of Home Assistant's standardized schema. Mostly, this relates to specifying the duration of mode changes, after which time the entities revert to **Auto** or **FollowSchedule** (for locations and zones, respectively).
@@ -181,7 +181,7 @@ The `duration` can be up to 24 hours, after which the zone mode will revert to s
This service call is used to set a zone, as identified by its `entity_id`, to **FollowSchedule**.
-## Useful Jinja Templates
+## Useful Jinja templates
The actual operating mode of Evohome entities can be tracked via their state attributes, which includes a JSON data structure for the current state called `status`.
diff --git a/source/_integrations/ezviz.markdown b/source/_integrations/ezviz.markdown
index 62eb20d27bc..19e0e176f62 100644
--- a/source/_integrations/ezviz.markdown
+++ b/source/_integrations/ezviz.markdown
@@ -48,7 +48,7 @@ Your cameras will now show under integration options as "discovered devices". Pl
You can also change the camera options should you need to access a high or low res stream. Generally, though it will just work without any modification to options.
-### Integration Entity Options
+### Integration entity options
`Request Timeout (seconds)`:
@@ -81,7 +81,7 @@ If your EZVIZ camera supports warning sounds, you can use this service to set th
### Service `ezviz.ptz`
-If your EZVIZ camera supports PTZ, you will be able to pan or tilt your camera.
+If your EZVIZ camera supports PTZ, you will be able to pan or tilt your camera.
| Service data attribute | Description |
| -----------------------| ----------- |
@@ -130,15 +130,15 @@ To enable/disable motion detection, use the Home Assistant built in services.
| -----------------------| ----------- |
| `entity_id` | String or list of strings that point at `entity_id`s of cameras. Use `entity_id: all` to target all. |
-### Alarm Control Panel Entity
+### Alarm control panel entity
-The Alarm Control Panel entity in the EZVIZ platform allows users to manage and control the armed status of all their EZVIZ devices. With this entity, users can choose between three options: **Arm Away**, **Arm Sleep**, and **Disarm**.
+The Alarm control panel entity in the EZVIZ platform allows users to manage and control the armed status of all their EZVIZ devices. With this entity, users can choose between three options: **Arm Away**, **Arm Sleep**, and **Disarm**.
### OTA update
Trigger device OTA firmware update process for latest stable version.
-### Motion Detection Sensitivity
+### Motion detection sensitivity
The motion detection sensitivity can be adjusted using the "Detection sensitivity" Number entity. It's important to note that this entity fetches information from the device and will not update if your battery-powered camera is in sleep mode, as this measure is implemented to preserve battery life and prevent excessive drainage.
@@ -149,7 +149,7 @@ Once triggered, the siren will automatically deactivate after 60 seconds (EZVIZ
### PTZ
-PTZ up/down/left/right buttons are available on supported PTZ cameras for pan and tilt control.
+PTZ up/down/left/right buttons are available on supported PTZ cameras for pan and tilt control.
### Warning sound
@@ -159,10 +159,14 @@ If your camera supports motion detection warning sounds, you can use this entity
A light entity will be added to cameras + light combos. You can turn it on/off and set the brightness.
-### Image Entity
+### Image entity
The image entity represents the last detected event from a camera and visually represents the event within Home Assistant.
## Troubleshooting
- `authentication failed`: The authentication requires an EZVIZ account with two-step verification disabled. Google, Facebook, TikTok, or other Oauth-based accounts will not work.
+
+## Related topics
+
+- [Controlling the camera from the dashboard](/dashboards/picture-glance/#creating-a-card-to-control-the-camera)
\ No newline at end of file
diff --git a/source/_integrations/faa_delays.markdown b/source/_integrations/faa_delays.markdown
index 9f6ad2804ca..2a1edf69c7f 100644
--- a/source/_integrations/faa_delays.markdown
+++ b/source/_integrations/faa_delays.markdown
@@ -14,7 +14,7 @@ ha_platforms:
ha_integration_type: integration
---
-The FAA Delays integration collects and displays information about delays at US Airports based on the
+The **FAA Delays** {% term integration %} collects and displays information about delays at US Airports based on the
[FAA's National Airspace System Status](https://nasstatus.faa.gov/).
Data measured includes:
@@ -26,13 +26,13 @@ Data measured includes:
{% include integrations/config_flow.md %}
-## Supported Airports
+## Supported airports
The airport entered must be a valid IATA
airport code for an airport in the US. You can find this by looking up the
FAA Identifier at [Airnav](https://airnav.com/airports/).
-## Additional Delay Information
+## Additional delay information
Each airport added will expose 5 binary sensors, one for each type of delay. Within each sensor there is additional
information listed as attributes, which depends on the type of delay it is. Each delay type has the attributes
diff --git a/source/_integrations/facebox.markdown b/source/_integrations/facebox.markdown
index 2c2186da2a3..4caec280353 100644
--- a/source/_integrations/facebox.markdown
+++ b/source/_integrations/facebox.markdown
@@ -2,14 +2,14 @@
title: Facebox
description: Detect and recognize faces with Facebox.
ha_category:
- - Image Processing
+ - Image processing
ha_iot_class: Local Push
ha_release: 0.7
ha_domain: facebox
ha_integration_type: integration
---
-The `facebox` image processing platform allows you to detect and recognize faces in a camera image using [Facebox](https://machinebox.io/docs/facebox). The state of the entity is the number of faces detected, and recognized faces are listed in the `matched_faces` attribute. An `image_processing.detect_face` event is fired for each recognized face, and the event `data` provides the `confidence` of recognition, the `name` of the person, the `image_id` of the image associated with the match, the `bounding_box` that contains the face in the image, and the `entity_id` that processing was performed on.
+The **Facebox** image processing {% term integration %} allows you to detect and recognize faces in a camera image using [Facebox](https://machinebox.io/docs/facebox). The state of the entity is the number of faces detected, and recognized faces are listed in the `matched_faces` attribute. An `image_processing.detect_face` event is fired for each recognized face, and the event `data` provides the `confidence` of recognition, the `name` of the person, the `image_id` of the image associated with the match, the `bounding_box` that contains the face in the image, and the `entity_id` that processing was performed on.
## Setup
diff --git a/source/_integrations/fan.template.markdown b/source/_integrations/fan.template.markdown
index f707beb020a..e526bd82c4a 100644
--- a/source/_integrations/fan.template.markdown
+++ b/source/_integrations/fan.template.markdown
@@ -1,6 +1,6 @@
---
-title: "Template Fan"
-description: "Instructions how to setup the Template fans within Home Assistant."
+title: "Template fan"
+description: "Instructions how to setup the template fans within Home Assistant."
ha_category:
- Fan
ha_release: 0.69
@@ -9,13 +9,13 @@ ha_quality_scale: internal
ha_domain: template
---
-The `template` platform creates fans that combine integrations and provides the
+The **Template** {% term integration %} creates fans that combine integrations and provides the
ability to run scripts or invoke services for each of the `turn_on`, `turn_off`, `set_percentage`,
`set_preset_mode`, `set_oscillating`, and `set_direction` commands of a fan.
## Configuration
-To enable Template Fans in your installation, add the following to your
+To enable template fans in your installation, add the following to your
`configuration.yaml` file:
{% raw %}
@@ -151,7 +151,7 @@ When converting a fan with 3 speeds from the old fan entity model, the following
## Examples
-### Helper Fan
+### Helper fan
This example uses an input_boolean and an input_number to mimic a fan, and
the example shows multiple service calls for set_percentage.
@@ -189,7 +189,7 @@ fan:
{% endraw %}
-### Preset Modes Fan
+### Preset modes fan
This example uses an existing fan with only a percentage. It extends the
percentage value into useable preset modes without a helper entity.
diff --git a/source/_integrations/fastdotcom.markdown b/source/_integrations/fastdotcom.markdown
index ee0d00b23ba..89101da1386 100644
--- a/source/_integrations/fastdotcom.markdown
+++ b/source/_integrations/fastdotcom.markdown
@@ -3,7 +3,7 @@ title: Fast.com
description: How to integrate Fast.com within Home Assistant.
ha_category:
- Sensor
- - System Monitor
+ - System monitor
ha_release: 0.88
ha_iot_class: Cloud Polling
ha_config_flow: true
diff --git a/source/_integrations/feedreader.markdown b/source/_integrations/feedreader.markdown
index 982e23b3a41..7206614dd49 100644
--- a/source/_integrations/feedreader.markdown
+++ b/source/_integrations/feedreader.markdown
@@ -89,7 +89,7 @@ automation:
Any field under the `` tag in the feed can be used for example `trigger.event.data.content` will get the body of the feed entry.
-### Video Tutorial
+### Video tutorial
This video tutorial explains how to set up the feedreader and show the latest news feed item on your dashboard in Home Assistant.
diff --git a/source/_integrations/ffmpeg.markdown b/source/_integrations/ffmpeg.markdown
index 17017c1e4ce..fc1b56c5551 100644
--- a/source/_integrations/ffmpeg.markdown
+++ b/source/_integrations/ffmpeg.markdown
@@ -2,7 +2,7 @@
title: FFmpeg
description: Instructions on how to integrate FFmpeg within Home Assistant.
ha_category:
- - Image Processing
+ - Image processing
ha_release: 0.29
ha_domain: ffmpeg
ha_platforms:
@@ -30,7 +30,7 @@ ffmpeg:
ffmpeg_bin:
description: The name or path to the `ffmpeg` binary.
required: false
- default: ffmpeg
+ default: "`ffmpeg`"
type: string
{% endconfiguration %}
diff --git a/source/_integrations/ffmpeg_motion.markdown b/source/_integrations/ffmpeg_motion.markdown
index eab1a423529..dda89f33cc3 100644
--- a/source/_integrations/ffmpeg_motion.markdown
+++ b/source/_integrations/ffmpeg_motion.markdown
@@ -2,7 +2,7 @@
title: FFmpeg Motion
description: Instructions on how to integrate an FFmpeg-based motion binary sensor
ha_category:
- - Image Processing
+ - Image processing
ha_iot_class: Calculated
ha_release: 0.27
ha_domain: ffmpeg_motion
diff --git a/source/_integrations/ffmpeg_noise.markdown b/source/_integrations/ffmpeg_noise.markdown
index 49b1f8402d0..92d7ea2808a 100644
--- a/source/_integrations/ffmpeg_noise.markdown
+++ b/source/_integrations/ffmpeg_noise.markdown
@@ -2,7 +2,7 @@
title: FFmpeg Noise
description: Instructions on how to integrate an FFmpeg-based noise binary sensor
ha_category:
- - Image Processing
+ - Image processing
ha_iot_class: Calculated
ha_release: 0.27
ha_domain: ffmpeg_noise
@@ -40,7 +40,7 @@ name:
required: false
type: string
initial_state:
- description: Start FFmpeg with home-assistant.
+ description: Start FFmpeg with Home Assistant.
required: false
type: boolean
default: true
diff --git a/source/_integrations/fibaro.markdown b/source/_integrations/fibaro.markdown
index 72af5f0806a..4910d87e8d1 100644
--- a/source/_integrations/fibaro.markdown
+++ b/source/_integrations/fibaro.markdown
@@ -2,7 +2,7 @@
title: Fibaro
description: Instructions on how to setup Fibaro Home Center and Yubii Home within Home Assistant.
ha_category:
- - Binary Sensor
+ - Binary sensor
- Climate
- Cover
- Event
@@ -55,7 +55,7 @@ It is recommended to assign a static IP address to your Fibaro controller. This
## Supported platforms
-- Binary Sensor
+- Binary sensor
- Climate
- Cover
- Event
diff --git a/source/_integrations/filter.markdown b/source/_integrations/filter.markdown
index 17be61f7942..92a67a0362f 100644
--- a/source/_integrations/filter.markdown
+++ b/source/_integrations/filter.markdown
@@ -158,7 +158,7 @@ To adjust the rate you need to set the window_size. To throttle a sensor down to
This filter is relevant when you have a sensor which produces states at a very high-rate, which you might want to throttle down for storing or visualization purposes.
-### Time Throttle
+### Time throttle
The Time Throttle filter (`time_throttle`) will only update the state of the sensor for the first state in the window. This means the filter will skip all other values.
diff --git a/source/_integrations/fire_tv.markdown b/source/_integrations/fire_tv.markdown
index 0cf63f26c65..acd2d505b57 100644
--- a/source/_integrations/fire_tv.markdown
+++ b/source/_integrations/fire_tv.markdown
@@ -2,7 +2,7 @@
title: Amazon Fire TV
description: Connect and control your Amazon Fire TV devices using the Android Debug Bridge integration
ha_category:
- - Media Player
+ - Media player
ha_domain: fire_tv
ha_integration_type: virtual
ha_supporting_domain: androidtv
diff --git a/source/_integrations/fireservicerota.markdown b/source/_integrations/fireservicerota.markdown
index 28639f708bd..fd7566f722a 100644
--- a/source/_integrations/fireservicerota.markdown
+++ b/source/_integrations/fireservicerota.markdown
@@ -2,7 +2,7 @@
title: FireServiceRota
description: Instructions on how to configure the FireServiceRota integration for Home Assistant.
ha_category:
- - Binary Sensor
+ - Binary sensor
- Sensor
- Switch
ha_iot_class: Cloud Polling
@@ -34,7 +34,7 @@ A word of caution: Do not solely rely on this integration for your emergency cal
This integration provides the following platforms:
- Sensor: Incoming emergency calls. Metadata contains _among other data_ the location of the incident and a text-to-speech URL. The integration uses a WebSocket client connection with the service to ensure a minimum delay.
-- Binary Sensor: Your current duty status (as scheduled via the FireServiceRota mobile app and/or website).
+- Binary sensor: Your current duty status (as scheduled via the FireServiceRota mobile app and/or website).
- Switch: Enabled for 30 minutes after an emergency call. ‘on’ represents a confirmed response. Use this to automate your emergency call response and save valuable seconds.
On how to write automations using these platform read the 'Advanced Configuration' section below.
@@ -45,7 +45,7 @@ On how to write automations using these platform read the 'Advanced Configuratio
The following entity types are created:
-### Incidents Sensor
+### Incidents sensor
This is the main entity of the integration containing the incident message as its `value`, it has several attributes which are described below.
@@ -65,7 +65,7 @@ This is the main entity of the integration containing the incident message as it
| `formatted_address` | Address in string format. |
| `task_ids` | ID(s) of appliance(s) or task(s). |
-### Duty Binary Sensor
+### Duty binary sensor
This entity reflects the duty you have scheduled, the value can be `on` = on duty, `off` = no duty. When you have no duty the response switch is disabled which means you cannot respond to a call.
@@ -80,7 +80,7 @@ This entity reflects the duty you have scheduled, the value can be `on` = on dut
| `type` | Type, e.g. `standby_duty`. |
| `assigned function` | Assigned function, e.g. `Chauffeur`. |
-### Incident Response Switch
+### Incident response switch
With this switch you can respond to an incident, either by manually controlling the switch via the GUI, or by using an automation action.
It gets reset to `unknown` value with every incident received. Switching it to `on` means you send a response acknowledgement, switching it back `off` sends a response rejected.
@@ -99,7 +99,7 @@ The following attributes are available:
| `available_at_incident_creation` | `true` or `false`. |
| `active_duty_function_ids` | Active function ID's, e.g., `540`. |
-## Advanced Configuration
+## Advanced configuration
With Automation you can configure one or more of the following useful actions:
@@ -110,7 +110,7 @@ With Automation you can configure one or more of the following useful actions:
These are documented below.
-### Example Automation
+### Example automation
{% raw %}
@@ -166,7 +166,7 @@ automation:
```
-### Example Dashboard
+### Example dashboard
```yaml
panel: true
diff --git a/source/_integrations/firmata.markdown b/source/_integrations/firmata.markdown
index 38f0582c18d..0716af3d7cc 100644
--- a/source/_integrations/firmata.markdown
+++ b/source/_integrations/firmata.markdown
@@ -2,7 +2,7 @@
title: Firmata
description: Connect Arduino-compatible boards within Home Assistant
ha_category:
- - Binary Sensor
+ - Binary sensor
- DIY
- Light
- Sensor
@@ -26,7 +26,7 @@ The Firmata protocol is a standard protocol for microcontrollers. Most of these
There is currently support for the following device types within Home Assistant:
-- [Binary Sensor](#binary_sensor)
+- [Binary sensor](#binary_sensor)
- [Light](#lights)
- [Sensor](#sensors)
- [Switch](#switches)
diff --git a/source/_integrations/fitbit.markdown b/source/_integrations/fitbit.markdown
index 1e8ad6d03a8..a3c757df4ed 100644
--- a/source/_integrations/fitbit.markdown
+++ b/source/_integrations/fitbit.markdown
@@ -49,7 +49,7 @@ The integration setup will next give you instructions to enter the [Application
{% enddetails %}
-## Additional Information
+## Additional information
Please be aware that Fitbit has very low rate limits, 150 per user per hour. The clock resets at the _top_ of the hour (meaning it is not a rolling 60 minutes). There is no way around the limits. Due to the rate limits, the sensor only updates every 30 minutes. You can manually trigger an update by restarting Home Assistant. Keep in mind that 1 request is used for every sensor.
diff --git a/source/_integrations/fivem.markdown b/source/_integrations/fivem.markdown
index 92dc8f9003e..15c8aa38e1d 100644
--- a/source/_integrations/fivem.markdown
+++ b/source/_integrations/fivem.markdown
@@ -3,7 +3,7 @@ title: FiveM
description: Instructions on how to integrate a FiveM server into Home Assistant.
ha_release: 2022.3
ha_category:
- - Binary Sensor
+ - Binary sensor
- Sensor
ha_iot_class: Local Polling
ha_config_flow: true
diff --git a/source/_integrations/fjaraskupan.markdown b/source/_integrations/fjaraskupan.markdown
index 490da1b9fa9..29d26fe4926 100644
--- a/source/_integrations/fjaraskupan.markdown
+++ b/source/_integrations/fjaraskupan.markdown
@@ -2,7 +2,7 @@
title: Fjäråskupan
description: Instructions on how to configure fjäråskupan integration.
ha_category:
- - Binary Sensor
+ - Binary sensor
- Fan
- Light
ha_release: 2021.9
@@ -24,7 +24,7 @@ ha_integration_type: integration
There is currently support for the following device types within Home Assistant:
-- Binary Sensor
+- Binary sensor
- Fan
- Light
diff --git a/source/_integrations/flexom.markdown b/source/_integrations/flexom.markdown
index fcd18294c98..922025b7c4f 100644
--- a/source/_integrations/flexom.markdown
+++ b/source/_integrations/flexom.markdown
@@ -3,7 +3,7 @@ title: Bouygues Flexom
description: Connect and control your Bouygues Flexom devices using the Overkiz integration
ha_category:
- Alarm
- - Binary Sensor
+ - Binary sensor
- Button
- Climate
- Cover
@@ -16,7 +16,7 @@ ha_category:
- Sensor
- Siren
- Switch
- - Water Heater
+ - Water heater
ha_domain: flexom
ha_integration_type: virtual
ha_supporting_domain: overkiz
diff --git a/source/_integrations/flic.markdown b/source/_integrations/flic.markdown
index cbff9f1abb5..a7fe1f436d2 100644
--- a/source/_integrations/flic.markdown
+++ b/source/_integrations/flic.markdown
@@ -2,7 +2,7 @@
title: Flic
description: Instructions on how to integrate flic buttons within Home Assistant.
ha_category:
- - Binary Sensor
+ - Binary sensor
ha_iot_class: Local Push
ha_release: 0.35
ha_domain: flic
@@ -112,6 +112,6 @@ automation:
{% endraw %}
-### Ignoring Click Types
+### Ignoring click types
-For some purposes it might make sense to exclude a specific click type from triggering click events. For example when ignoring double clicks, pressing the button twice fast results in two `single` instead of a `double` click event. This is very useful for applications where you want to click fast.
+For some purposes it might make sense to exclude a specific click type from triggering click events. For example, when ignoring double clicks, pressing the button twice fast results in two `single` instead of a `double` click event. This is very useful for applications where you want to click fast.
diff --git a/source/_integrations/flo.markdown b/source/_integrations/flo.markdown
index b6b6d9da206..6df10b9b7e3 100644
--- a/source/_integrations/flo.markdown
+++ b/source/_integrations/flo.markdown
@@ -2,7 +2,7 @@
title: Flo
description: Instructions on how to integrate Flo by Moen into Home Assistant.
ha_category:
- - Binary Sensor
+ - Binary sensor
- Sensor
- Switch
ha_config_flow: true
@@ -23,7 +23,7 @@ The `flo` integration integrates
There is currently support for the following device types within Home Assistant:
-- **Binary Sensor**: reports whether or not there are any alerts.
+- **Binary sensor**: reports whether or not there are any alerts.
- **Sensor**: reports on the device's system mode, water flow rate, temperature, water pressure, and daily water consumption.
- **Switch**: allows the user to open and close the valve on the water shutoff device.
diff --git a/source/_integrations/flume.markdown b/source/_integrations/flume.markdown
index 68dd08572cc..56216c0b645 100644
--- a/source/_integrations/flume.markdown
+++ b/source/_integrations/flume.markdown
@@ -2,7 +2,7 @@
title: Flume
description: Documentation about the flume sensor.
ha_category:
- - Binary Sensor
+ - Binary sensor
- Sensor
ha_iot_class: Cloud Polling
ha_release: 0.103
@@ -76,7 +76,7 @@ action:
{% endraw %}
-## Configuration for Binary Sensor
+## Configuration for binary sensor
The following YAML creates a binary sensor. This requires the default sensor to be configured successfully.
diff --git a/source/_integrations/flux_led.markdown b/source/_integrations/flux_led.markdown
index faa7176ef6a..ce08c447df2 100644
--- a/source/_integrations/flux_led.markdown
+++ b/source/_integrations/flux_led.markdown
@@ -136,9 +136,9 @@ After the devices have been added they can be configured with different effects
A list of RGB colors can be entered to create an effect. The effect speed can be adjusted using the slider underneath.
**Custom Effect Type**\
-This determines the transition between each color.
+This determines the transition between each color.
-### Supported Models
+### Supported models
The following models have been tested.
@@ -178,7 +178,7 @@ The following models have been tested.
| 0xE1 | Ceiling Light CCT | no | |
| 0xE2 | Ceiling Light Assist | no | Auxiliary Switch not supported |
-### Untested Models
+### Untested models
The following models have not been tested but may work.
@@ -222,7 +222,7 @@ The Magic Home light offers a number of effects which are not included in other
| `random` | Chooses a random color by selecting random values for R, G, and B. |
-### Custom Effects - Service `flux_led.set_custom_effect`
+### Custom effects - service `flux_led.set_custom_effect`
The integration offers a custom service to enable you to set the lights to a custom light effect.
@@ -244,7 +244,7 @@ speed_pct: 80
transition: "jump"
```
-### Set Zones - Service `flux_led.set_zones`
+### Set zones - service `flux_led.set_zones`
The Addressable v3 (0xA3) models allow setting a color effect per zone. The length of each zone is the number of pixels per segment divided by the number of colors. If the device is turned off, setting the zones will not turn it on. A separate call to `light.turn_on` is needed to turn on the device.
@@ -256,7 +256,7 @@ The Addressable v3 (0xA3) models allow setting a color effect per zone. The leng
| `effect` | The effect you would like. Valid options are `static`, `running_water`, `strobe`, `jump`, or `breathing`. (Default `static`) |
```yaml
-#Example Service Call
+#Example service call
service: flux_led.set_zones
target:
entity_id:
diff --git a/source/_integrations/folder_watcher.markdown b/source/_integrations/folder_watcher.markdown
index f09826cd10f..e5b9b01aa0f 100644
--- a/source/_integrations/folder_watcher.markdown
+++ b/source/_integrations/folder_watcher.markdown
@@ -2,7 +2,7 @@
title: Folder Watcher
description: Integration for monitoring changes within the filesystem.
ha_category:
- - System Monitor
+ - System monitor
ha_iot_class: Local Polling
ha_release: 0.67
ha_quality_scale: internal
diff --git a/source/_integrations/foobot.markdown b/source/_integrations/foobot.markdown
index 692d0c9a5aa..baf75ce54b8 100644
--- a/source/_integrations/foobot.markdown
+++ b/source/_integrations/foobot.markdown
@@ -37,7 +37,7 @@ sensor:
type: string
{% endconfiguration %}
-## Available Metrics
+## Available metrics
Every ten minutes, it'll fetch the last ten minutes average of the following measurements:
diff --git a/source/_integrations/forked_daapd.markdown b/source/_integrations/forked_daapd.markdown
index 1bb0f498415..c7ce59ce278 100644
--- a/source/_integrations/forked_daapd.markdown
+++ b/source/_integrations/forked_daapd.markdown
@@ -2,7 +2,7 @@
title: OwnTone
description: Instructions on how to integrate an OwnTone server into Home Assistant.
ha_category:
- - Media Player
+ - Media player
ha_release: '0.110'
ha_iot_class: Local Push
ha_domain: forked_daapd
diff --git a/source/_integrations/fortios.markdown b/source/_integrations/fortios.markdown
index 5726627fb39..1e4d66b4b47 100644
--- a/source/_integrations/fortios.markdown
+++ b/source/_integrations/fortios.markdown
@@ -2,7 +2,7 @@
title: FortiOS
description: Instructions on how to use Fortinet FortiOS to track devices in Home Assistant.
ha_category:
- - Presence Detection
+ - Presence detection
ha_iot_class: Local Polling
ha_release: 0.97
ha_domain: fortios
@@ -22,7 +22,7 @@ All devices with a MAC address identified by FortiGate would be tracked, this co
The integration is based on the Home Assistant `device_tracker` platform.
-### Example Configuration:
+### Example configuration:
This example uses the FortiOS integration as a device tracker, with an API token and does not verify the SSL certificate.
diff --git a/source/_integrations/foscam.markdown b/source/_integrations/foscam.markdown
index b5de6621db3..51eaecbe76f 100644
--- a/source/_integrations/foscam.markdown
+++ b/source/_integrations/foscam.markdown
@@ -28,7 +28,7 @@ Most Foscam IP Cameras supports two video streams, by default the `Main` stream
### Service `foscam.ptz`
-If your Foscam camera supports PTZ, you will be able to pan or tilt your camera.
+If your Foscam camera supports PTZ, you will be able to pan or tilt your camera.
| Service data attribute | Description |
| -----------------------| ----------- |
@@ -38,7 +38,7 @@ If your Foscam camera supports PTZ, you will be able to pan or tilt your camera.
### Service `foscam.ptz_preset`
-If your Foscam camera supports PTZ presets, you will be able to move the camera to a predefined preset using the preset name.
+If your Foscam camera supports PTZ presets, you will be able to move the camera to a predefined preset using the preset name.
| Service data attribute | Description |
| -----------------------| ----------- |
diff --git a/source/_integrations/freebox.markdown b/source/_integrations/freebox.markdown
index 9181ced46b3..e7b33483dd6 100644
--- a/source/_integrations/freebox.markdown
+++ b/source/_integrations/freebox.markdown
@@ -4,7 +4,7 @@ description: Instructions on how to integrate Freebox routers into Home Assistan
ha_category:
- Camera
- Network
- - Presence Detection
+ - Presence detection
- Sensor
- Switch
- Alarm Control Panel
@@ -99,7 +99,7 @@ Only the routers with Freebox OS are supported:
- Freebox V6 also known as Freebox Revolution
- Freebox mini 4k
-## Presence Detection
+## Presence detection
This platform offers presence detection by keeping track of the devices connected to a [Freebox](https://www.free.fr/freebox/) router.
diff --git a/source/_integrations/freedompro.markdown b/source/_integrations/freedompro.markdown
index 4f605ed8ace..e5469560f01 100644
--- a/source/_integrations/freedompro.markdown
+++ b/source/_integrations/freedompro.markdown
@@ -2,7 +2,7 @@
title: Freedompro
description: Instructions for how to integrate Freedompro accessories within Home Assistant.
ha_category:
- - Binary Sensor
+ - Binary sensor
- Climate
- Cover
- Fan
@@ -34,7 +34,7 @@ Freedompro with its products installed on the electrical system, allows you to c
This integration lets you control all [Freedompro](https://freedompro.eu/) accessories.
-## Preliminary Steps
+## Preliminary steps
You will need to obtain an API key from [Freedompro Cloud](https://home.freedompro.eu/) to use this integration.
diff --git a/source/_integrations/fritz.markdown b/source/_integrations/fritz.markdown
index d57609c4b64..c1908c95259 100644
--- a/source/_integrations/fritz.markdown
+++ b/source/_integrations/fritz.markdown
@@ -2,9 +2,9 @@
title: AVM FRITZ!Box Tools
description: Instructions on how to integrate AVM FRITZ!Box based routers into Home Assistant.
ha_category:
- - Binary Sensor
+ - Binary sensor
- Image
- - Presence Detection
+ - Presence detection
- Sensor
- Update
ha_release: '0.10'
@@ -56,7 +56,7 @@ Currently supported services are Platform specific:
- `fritz.cleanup`
-### Platform Services
+### Platform services
#### Service `fritz.cleanup`
@@ -95,11 +95,11 @@ Parental control switches can be used to enable and disable internet access of i
Parental control switches are designed for advanced users, thus they are disabled by default. You need to enable the wanted entities manually.
-### Device Tracker
+### Device tracker
**Note**: If you don't want to automatically track newly detected devices, disable the integration system option `Enable new added entities`.
-### Port Forward
+### Port forward
Due to security reasons, AVM implemented the ability to enable/disable a port forward rule only from the host involved in the rule.
As a result, this integration will create entities only for rules that have your Home Assistant host as a destination.
diff --git a/source/_integrations/fritzbox.markdown b/source/_integrations/fritzbox.markdown
index 66c69425b68..142e1c154a3 100644
--- a/source/_integrations/fritzbox.markdown
+++ b/source/_integrations/fritzbox.markdown
@@ -2,7 +2,7 @@
title: AVM FRITZ!SmartHome
description: Instructions on how to integrate AVM Fritz!DECT components into Home Assistant.
ha_category:
- - Binary Sensor
+ - Binary sensor
- Button
- Climate
- Light
@@ -33,7 +33,7 @@ The AVM FRITZ!SmartHome integration for Home Assistant allows you to integrate [
There is currently support for the following device types within Home Assistant:
-- Binary Sensor
+- Binary sensor
- Climate
- Cover
- Light
@@ -42,17 +42,19 @@ There is currently support for the following device types within Home Assistant:
Additionally, we also support to trigger smarthome templates.
-#### Tested Devices
+#### Tested devices
- [FRITZ!Box 5590 Fiber](https://en.avm.de/products/fritzbox/fritzbox-5590-fiber/)
- FRITZ!Box 6490 Cable
- [FRITZ!Box 6591 Cable](https://en.avm.de/products/fritzbox/fritzbox-6591-cable/)
- [FRITZ!Box 7590](https://en.avm.de/products/fritzbox/fritzbox-7590/)
+- [FRITZ!Box 7590 AX](https://en.avm.de/products/fritzbox/fritzbox-7590-ax/)
- FRITZ!Box 7490
- FRITZ!Box 7430
- [FRITZ!DECT 200](https://en.avm.de/products/fritzdect/fritzdect-200/)
- [FRITZ!DECT 210](https://en.avm.de/products/fritzdect/fritzdect-210/)
- [FRITZ!DECT 301](https://en.avm.de/products/fritzdect/fritzdect-301/)
+- [FRITZ!DECT 302](https://en.avm.de/products/fritzdect/fritzdect-302/)
- [FRITZ!DECT 500](https://en.avm.de/products/fritzdect/fritzdect-500/)
- [Eurotronic Comet DECT](https://eurotronic.org/produkte/dect-ule-heizkoerperthermostat/comet-dect/)
- [Magenta SmartHome LED E27 Color](https://www.smarthome.de/geraete/smarthome-led-lampe-e27-farbig-weiss)
@@ -65,7 +67,7 @@ Additionally, we also support to trigger smarthome templates.
The configuration in the UI asks for a username. Starting from FRITZ!OS 7.24 the FRITZ!Box creates a random username for the admin user if you didn't set one yourself. This can be found after logging into the FRITZ!Box and visiting System -> FRITZ!Box Users -> Users. The username starts with "fritz" followed by four random numbers. Under properties on the right it says "created automatically". Prior to FRITZ!OS 7.24 the default username was "admin".
-## Switches & Thermostats
+## Switches & thermostats
To get AVM FRITZ!DECT switches (e.g. FRITZ!DECT 400/440) or thermostats (e.g. FRITZ!DECT 301) follow the [configuration instructions](#configuration) above.
diff --git a/source/_integrations/fritzbox_callmonitor.markdown b/source/_integrations/fritzbox_callmonitor.markdown
index eeea5b06f85..8ec896f9825 100644
--- a/source/_integrations/fritzbox_callmonitor.markdown
+++ b/source/_integrations/fritzbox_callmonitor.markdown
@@ -2,7 +2,7 @@
title: AVM FRITZ!Box Call Monitor
description: Instructions on how to integrate a phone call monitor for AVM FRITZ!Box routers into Home Assistant.
ha_category:
- - System Monitor
+ - System monitor
ha_release: 0.27
ha_iot_class: Local Polling
ha_domain: fritzbox_callmonitor
diff --git a/source/_integrations/fronius.markdown b/source/_integrations/fronius.markdown
index b798c1afb0a..b88b13f87ef 100644
--- a/source/_integrations/fronius.markdown
+++ b/source/_integrations/fronius.markdown
@@ -93,7 +93,7 @@ Recommended energy dashboard configuration for meter location in feed in path:
Recommended energy dashboard configuration for meter location in consumption path:
-- The `Power grid` entity provided by the Fronius API is positive on import and negative on export. Split it up into import- and export-power entities by using helpers with templates `max(states(sensor.solarnet_power_grid) | float, 0)` and `max(0 - states(sensor.solarnet_power_grid) | float, 0)`.
+- The `Power grid` entity provided by the Fronius API is positive on import and negative on export. Split it up into import- and export-power entities by using helpers with templates `max(states('sensor.solarnet_power_grid') | float, 0)` and `max(0 - states('sensor.solarnet_power_grid') | float, 0)`.
- Then use [Riemann sum](/integrations/integration/) to integrate these import-/export-power entities into energy values (kWh).
- Use these energy entities for `Grid consumption` and `Return to grid` in the energy dashboard configuration.
diff --git a/source/_integrations/frontend.markdown b/source/_integrations/frontend.markdown
index 54b9d7e3cf9..93240873532 100644
--- a/source/_integrations/frontend.markdown
+++ b/source/_integrations/frontend.markdown
@@ -1,5 +1,5 @@
---
-title: Home Assistant Frontend
+title: Home Assistant frontend
description: Offers a frontend to Home Assistant.
ha_category:
- Other
@@ -47,7 +47,7 @@ frontend:
type: string
{% endconfiguration %}
-## Defining Themes
+## Defining themes
### Theme format
@@ -153,7 +153,7 @@ For more details about splitting up the configuration into multiple files, see [
Check our [community forums](https://community.home-assistant.io/c/projects/themes) to find themes to use.
-## Setting Themes
+## Setting themes
There are two themes-related services:
@@ -170,7 +170,7 @@ There are two themes-related services:
If no dark mode backend theme is set, the light mode theme will also be used in dark mode.
The backend theme settings will be saved and restored on a restart of Home Assistant.
-### Manual Theme Selection
+### Manual theme selection
When themes are enabled in the `configuration.yaml` file, a new option will show up in the user profile page (accessed by clicking your user account initials at the bottom of the sidebar). You can then choose any installed theme from the dropdown list and it will be applied immediately.
This will overrule the theme settings set by the above service calls, and will only be applied to the current device.
@@ -200,7 +200,7 @@ For other devices (`es5` mode) you can use `extra_js_url_es5`, this will be load
The ES5 and module version will never both be loaded, depending on if the device supports `import` the module of ES5 version will be loaded.
-### Manual Language Selection
+### Manual language selection
The browser language is automatically detected. To use a different language, go to the user profile page (accessed by clicking your user account initials at the bottom of the sidebar) and select one. It will be applied immediately.
diff --git a/source/_integrations/frontier_silicon.markdown b/source/_integrations/frontier_silicon.markdown
index a44dcc3d92f..77e2aeb7fbb 100644
--- a/source/_integrations/frontier_silicon.markdown
+++ b/source/_integrations/frontier_silicon.markdown
@@ -2,7 +2,7 @@
title: Frontier Silicon
description: Instructions on how to integrate Frontier Silicon Internet Radios into Home Assistant.
ha_category:
- - Media Player
+ - Media player
ha_iot_class: Local Polling
ha_release: '0.40'
ha_domain: frontier_silicon
@@ -17,7 +17,7 @@ ha_config_flow: true
This integration provides support for Internet Radios based on the [Frontier Silicon chipset]. Some of the manufacturers which offer products based on these chips include: Hama, Medion, Slivercrest, Auna, Technisat, Revo, Pinnel, etc. These devices will be usually controlled by the UNDOK app.
-## Supported Models
+## Supported models
Frontier Silicon is used by many different brands of radio manufacturers.
diff --git a/source/_integrations/fully_kiosk.markdown b/source/_integrations/fully_kiosk.markdown
index 4e4f50e55e0..5617ead7990 100644
--- a/source/_integrations/fully_kiosk.markdown
+++ b/source/_integrations/fully_kiosk.markdown
@@ -2,7 +2,7 @@
title: Fully Kiosk Browser
description: Instructions on how to integrate Fully Kiosk Browser with Home Assistant
ha_category:
- - Binary Sensor
+ - Binary sensor
- Sensor
- Switch
ha_release: 2022.9
diff --git a/source/_integrations/garadget.markdown b/source/_integrations/garadget.markdown
index 235fff1a5a4..c0eb9c43ff4 100644
--- a/source/_integrations/garadget.markdown
+++ b/source/_integrations/garadget.markdown
@@ -125,14 +125,25 @@ As of firmware release 1.17 the garadget device has native support for MQTT. The
For configuration of the garadget as a MQTT cover:
```yaml
-cover:
- - platform: mqtt
- name: "Garage Door"
- command_topic: "garadget/device_name/command"
- state_topic: "garadget/device_name/status"
- payload_open: "open"
- payload_close: "close"
- value_template: "{{ value_json.status }}"
+mqtt:
+ cover:
+ - name: "Garage Door"
+ command_topic: "garadget/device_name/command"
+ state_topic: "garadget/device_name/status"
+ payload_open: "open"
+ payload_close: "close"
+ payload_stop: "stop"
+ value_template: "{{ value_json.status }}"
+ sensor:
+ - name: "Garage Door Since"
+ state_topic: "garadget/device_name/status"
+ value_template: '{{ value_json.time }}'
+
+ - name: "Large Garage Door Brightness"
+ state_topic: "garadget/device_name/status"
+ unit_of_measurement: '%'
+ value_template: '{{ value_json.bright }}'
+
```
Replace device_name with the name of the device provided when configuring garadget.
diff --git a/source/_integrations/garages_amsterdam.markdown b/source/_integrations/garages_amsterdam.markdown
index 931aa405e49..785f0864dd8 100644
--- a/source/_integrations/garages_amsterdam.markdown
+++ b/source/_integrations/garages_amsterdam.markdown
@@ -2,7 +2,7 @@
title: Garages Amsterdam
description: Instructions on how to integrate Garages Amsterdam within Home Assistant.
ha_category:
- - Binary Sensor
+ - Binary sensor
- Sensor
ha_release: 2021.6
ha_codeowners:
@@ -35,6 +35,6 @@ When you add a parking garage, 4 sensors are created in your configuration by de
-### Binary Sensor
+### Binary sensor
Each parking garage also has a binary sensor, which indicates whether there are problems in the data provision from the API. When it indicates `ok` everything is fine. If the state changes to `problem`, the upstream data might not be up to date or reliable and will remain in this state until new data is coming in.
diff --git a/source/_integrations/gardena_bluetooth.markdown b/source/_integrations/gardena_bluetooth.markdown
index 80b7de5c9ad..5d06922b28a 100644
--- a/source/_integrations/gardena_bluetooth.markdown
+++ b/source/_integrations/gardena_bluetooth.markdown
@@ -2,7 +2,7 @@
title: Gardena Bluetooth
description: Instructions on how to integrate Gardena Bluetooth devices within Home Assistant.
ha_category:
- - Binary Sensor
+ - Binary sensor
- Number
- Sensor
- Switch
@@ -23,29 +23,29 @@ ha_integration_type: integration
The Gardena Bluetooth integration allows users to integrate their Gardena Bluetooth devices into Home Assistant.
-See device section for support information: [Water Control](#water-control), [Irrigation Valves](#irrigation-valves), [Lawn Mowers](#lawn-mowers), [Garden Pumps](#gard-pumps)
+See device section for support information: [water control](#water-control), [irrigation valves](#irrigation-valves), [lawn mowers](#lawn-mowers), [garden pumps](#gard-pumps)
{% include integrations/config_flow.md %}
-## Water Control
+## Water control
- Water Control Bluetooth ([01889-20](https://www.gardena.com/int/products/watering/water-controls/water-control-bluetooth))
- Soil Moisture Sensors ([1867-20](https://www.gardena.com/int/products/watering/water-controls/soil-moisture-sensor/))
-The paring of the device may require a [Factory Reset](#factory-reset) before it allows a connection.
+The paring of the device may require a [factory reset](#factory-reset) before it allows a connection.
### Limitations
- Control of offline scheduling settings is not supported.
-- Use of the official Android application, sometimes locks out access to device until [Factory Reset](#factory-reset) is performed or Bluetooth is disabled in the Android device.
+- Use of the official Android application, sometimes locks out access to device until [factory reset](#factory-reset) is performed or Bluetooth is disabled in the Android device.
-### Factory Reset
+### Factory reset
1. Remove the battery.
2. Push and hold Man. button and reinsert the battery.
3. Hold the button for approx. 10 seconds.
-## Irrigation Valves
+## Irrigation valves
- Irrigation Valve 9 V Bluetooth ([1285-20](https://www.gardena.com/int/products/watering/sprinklersystem/irrigation-valve-9-v-bluetooth/970480401/))
@@ -53,7 +53,7 @@ The paring of the device may require a [Factory Reset](#factory-reset) before it
Irrigation valves are currently untested, but expected to work.
-## Lawn Mowers
+## Lawn mowers
### Limitations
diff --git a/source/_integrations/gc100.markdown b/source/_integrations/gc100.markdown
index 23f46fe0b23..82d9ef4aece 100644
--- a/source/_integrations/gc100.markdown
+++ b/source/_integrations/gc100.markdown
@@ -2,7 +2,7 @@
title: Global Caché GC-100
description: Instructions on how to integrate gc100 with Home Assistant.
ha_category:
- - Binary Sensor
+ - Binary sensor
- Hub
- Switch
ha_release: 0.57
@@ -20,7 +20,7 @@ hardware device which has an array of relays, RS232 serial ports, and flexible p
There is currently support for the following device types within Home Assistant:
- [Configuration](#configuration)
-- [Binary Sensor](#binary-sensor)
+- [Binary sensor](#binary-sensor)
- [Switch](#switch)
Currently, only relays and ports configured to be digital inputs are supported in Home Assistant. For IR support, please use the [iTach remote platform](/integrations/itach), but note that it will likely not function concurrently on the same GC100 due to limitations in the TCP socket server implementation used by Global Caché.
@@ -47,7 +47,7 @@ port:
type: integer
{% endconfiguration %}
-## Binary Sensor
+## Binary sensor
To enable this sensor, you first have to set up [gc100](#configuration), and add the following lines to your `configuration.yaml` file:
diff --git a/source/_integrations/gdacs.markdown b/source/_integrations/gdacs.markdown
index 7251f7d9db1..c6d1e4bba14 100644
--- a/source/_integrations/gdacs.markdown
+++ b/source/_integrations/gdacs.markdown
@@ -38,7 +38,7 @@ Please refer to the [creator's disclaimer and terms of use notice](https://www.g
{% include integrations/config_flow.md %}
-## State Attributes
+## State attributes
The following state attributes are available for each entity in addition to the standard ones:
@@ -84,7 +84,7 @@ from the feed.
| updated | Number of entities that were updated during last update (optional). |
| removed | Number of entities that were removed during last update (optional). |
-## Full Configuration
+## Full configuration
```yaml
# Example configuration.yaml entry
diff --git a/source/_integrations/generic_thermostat.markdown b/source/_integrations/generic_thermostat.markdown
index d3c7f701e9d..0fa443246d2 100644
--- a/source/_integrations/generic_thermostat.markdown
+++ b/source/_integrations/generic_thermostat.markdown
@@ -1,5 +1,5 @@
---
-title: Generic Thermostat
+title: Generic thermostat
description: Turn Home Assistant into a thermostat
ha_category:
- Climate
diff --git a/source/_integrations/geniushub.markdown b/source/_integrations/geniushub.markdown
index adb1779bfc5..b6ad825d9c5 100644
--- a/source/_integrations/geniushub.markdown
+++ b/source/_integrations/geniushub.markdown
@@ -2,11 +2,11 @@
title: Genius Hub
description: Instructions on how to integrate a Genius Hub with Home Assistant.
ha_category:
- - Binary Sensor
+ - Binary sensor
- Climate
- Sensor
- Switch
- - Water Heater
+ - Water heater
ha_release: 0.92
ha_iot_class: Local Polling
ha_codeowners:
@@ -30,7 +30,7 @@ It uses the [geniushub](https://pypi.org/project/geniushub-client/) client libra
Each zone controlled by your Genius Hub will be exposed as either a:
- `Climate` entity, for **Radiator** and **Wet Underfloor** zones, and
-- `Water Heater` entity, for **Hot Water Temperature** zones and
+- `Water heater` entity, for **Hot Water Temperature** zones and
- `Switch` entity, for **On/Off** zones
**Group** zones are not supported.
@@ -39,7 +39,7 @@ Currently, there is no support for altering zone schedules, although entities ca
There are limitations due to the differences between the Genius Hub and Home Assistant schemas (e.g., HA has no **Footprint** mode) - use the service handlers, below, for this functionality.
-### Service Handlers
+### Service handlers
Home Assistant is obligated to place restrictions upon integrations such as **geniushub** to maintain compatibility with other ecosystems (e.g., Google Home) and so not all of the **geniushub** functionality is available via the web UI. Some of this missing functionality is exposed via integration-specific service handlers:
@@ -47,9 +47,9 @@ Home Assistant is obligated to place restrictions upon integrations such as **ge
- `set_zone_override`: change the zone's setpoint _for a specified duration_ (up to 24h), and
- `set_zone_mode`: change the zone's mode to one of `off`, `timer` or (if supported by the zone) `footprint`
-### Climate and Water Heater Entities
+### Climate and water heater entities
-Climate and Water Heater entities will report their current temperature, setpoint and mode; other properties (e.g., occupied state) are available via their state attributes (see examples below). The Genius Hub mode will be reported as/set to:
+Climate and water heater entities will report their current temperature, setpoint and mode; other properties (e.g., occupied state) are available via their state attributes (see examples below). The Genius Hub mode will be reported as/set to:
| GH mode | HA Operation | HA Preset |
| :-----------: | :----------: | :-------: |
@@ -60,7 +60,7 @@ Climate and Water Heater entities will report their current temperature, setpoin
**Footprint** mode is only available to **Radiator** zones that have room sensors.
-### Switch Entities
+### Switch entities
Switch entities will report back their state; other properties are available via their state attributes. Currently, HA switches do not have modes/presets, so the Home Assistant `state` will be *reported* as:
@@ -73,10 +73,10 @@ Individual smart plugs are not yet exposed as switches - you can create one zone
### Devices
-Each Device controlled by your Genius Hub will be exposed as either a:
+Each device controlled by your Genius Hub will be exposed as either a:
- `Sensor` entity with a % battery, for any Device with a battery (e.g., a Genius Valve), or
-- `Binary Sensor` entity with on/off state for any Device that is a switch (e.g., Smart Plugs, DCRs)
+- `Binary sensor` entity with on/off state for any Device that is a switch (e.g., Smart Plugs, DCRs)
Such entities will report back their primary state and `assigned_zone`. If the Hub is directly polled using Option 1 (see below), then some additional state attributes such as `last_comms` (last communications time) are also available.
@@ -125,7 +125,7 @@ This alert may be useful to see if the CH is being turned on whilst you're on a
{% endraw %}
-## State Attributes
+## State attributes
Many zone/device properties are available via the corresponding entity's state attributes. For example, in the case of **Radiator**-derived `Climate` entities (note 'status'):
diff --git a/source/_integrations/geo_json_events.markdown b/source/_integrations/geo_json_events.markdown
index a3fdbcc4314..b5bcfd14f89 100644
--- a/source/_integrations/geo_json_events.markdown
+++ b/source/_integrations/geo_json_events.markdown
@@ -23,7 +23,7 @@ The data is updated every 5 minutes.
{% include integrations/config_flow.md %}
-## State Attributes
+## State attributes
The following state attributes are available for each entity in addition to the standard ones:
diff --git a/source/_integrations/geofency.markdown b/source/_integrations/geofency.markdown
index 4b61198552d..f8216feb53f 100644
--- a/source/_integrations/geofency.markdown
+++ b/source/_integrations/geofency.markdown
@@ -2,7 +2,7 @@
title: Geofency
description: Instructions for how to use Geofency to track devices in Home Assistant.
ha_category:
- - Presence Detection
+ - Presence detection
ha_release: 0.53
ha_iot_class: Cloud Push
ha_config_flow: true
diff --git a/source/_integrations/geonetnz_quakes.markdown b/source/_integrations/geonetnz_quakes.markdown
index 12a19294be0..add8f164408 100644
--- a/source/_integrations/geonetnz_quakes.markdown
+++ b/source/_integrations/geonetnz_quakes.markdown
@@ -47,7 +47,7 @@ We acknowledge the New Zealand GeoNet project and its sponsors EQC, GNS Science
{% include integrations/config_flow.md %}
-## State Attributes
+## State attributes
The following state attributes are available for each entity in addition to
the standard ones:
@@ -91,7 +91,7 @@ from the feed.
| updated | Number of entities that were updated during last update (optional). |
| removed | Number of entities that were removed during last update (optional). |
-## Full Configuration
+## Full configuration
```yaml
# Example configuration.yaml entry
diff --git a/source/_integrations/geonetnz_volcano.markdown b/source/_integrations/geonetnz_volcano.markdown
index d8578ef3256..5ca5b209bca 100644
--- a/source/_integrations/geonetnz_volcano.markdown
+++ b/source/_integrations/geonetnz_volcano.markdown
@@ -47,7 +47,7 @@ We acknowledge the New Zealand GeoNet project and its sponsors EQC, GNS Science
{% include integrations/config_flow.md %}
-## State Attributes
+## State attributes
The following state attributes are available for each entity in addition to
the standard ones:
@@ -63,7 +63,7 @@ the standard ones:
| last update | Timestamp of the last update from the feed. |
| last update successful | Timestamp of the last successful update from the feed. |
-## Full Configuration
+## Full configuration
```yaml
# Example configuration.yaml entry
diff --git a/source/_integrations/gitter.markdown b/source/_integrations/gitter.markdown
index 9675f778c9b..6222dc77709 100644
--- a/source/_integrations/gitter.markdown
+++ b/source/_integrations/gitter.markdown
@@ -35,5 +35,5 @@ room:
description: Gitter room to monitor.
required: false
type: string
- default: home-assistant/home-assistant
+ default: "`home-assistant/home-assistant`"
{% endconfiguration %}
diff --git a/source/_integrations/glances.markdown b/source/_integrations/glances.markdown
index 53f37a6e4e2..2b8d753e1f1 100644
--- a/source/_integrations/glances.markdown
+++ b/source/_integrations/glances.markdown
@@ -2,7 +2,7 @@
title: Glances
description: Instructions on how to integrate Glances sensors into Home Assistant.
ha_category:
- - System Monitor
+ - System monitor
ha_iot_class: Local Polling
ha_release: 0.7.3
ha_config_flow: true
@@ -41,7 +41,7 @@ For details about auto-starting `glances`, please refer to [Start Glances throug
{% include integrations/config_flow.md %}
-## Integration Entities
+## Integration entities
Glances integration will add the following sensors if available in the platform:
diff --git a/source/_integrations/goalzero.markdown b/source/_integrations/goalzero.markdown
index 0ff80c98d68..468dad832bd 100644
--- a/source/_integrations/goalzero.markdown
+++ b/source/_integrations/goalzero.markdown
@@ -22,7 +22,7 @@ This Goal Zero Yeti integration pulls data from a Wifi-enabled [Goal Zero Yeti](
{% include integrations/config_flow.md %}
-## Integration Entities
+## Integration entities
Each added configuration entry will create the following binary sensors:
diff --git a/source/_integrations/gogogate2.markdown b/source/_integrations/gogogate2.markdown
index deb5778a315..abd3d79ba08 100644
--- a/source/_integrations/gogogate2.markdown
+++ b/source/_integrations/gogogate2.markdown
@@ -21,7 +21,7 @@ The `gogogate2` cover platform lets you control Gogogate2 and iSmartGate enabled
{% include integrations/config_flow.md %}
-### Supported Devices
+### Supported devices
- Gogogate 2
- ismartgate PRO
diff --git a/source/_integrations/google.markdown b/source/_integrations/google.markdown
index e2256d42604..841f1d69e89 100644
--- a/source/_integrations/google.markdown
+++ b/source/_integrations/google.markdown
@@ -37,20 +37,20 @@ credentials but they will only work with Google Calendar.
If the setup process fails and you see an error message such as *Authentication code expired, please try again* you may want to try the flow again. You may also check the logs for additional error messages that may indicate a misconfiguration such as an invalid client id or secret.
-If you have an error with your credentials, you can delete them in the [Application Credentials](/integrations/application_credentials/) user interface.
+If you have an error with your credentials, you can delete them in the [application credentials](/integrations/application_credentials/) user interface.
-### Video Tutorial
+### Video tutorial
This video tutorial explains how to set up Google Calendar in Home Assistant and how you can trigger an automation based on a calendar event.
-## Calendar Entities
+## Calendar entities
Each Google Calendar from *My Calendars* ([more info](https://support.google.com/calendar/answer/37095)) is represented as a [calendar](/integrations/calendar) entity in Home Assistant.
For example, your calendar named *Personal* is created as entity `calendar.personal`. You may rename an entity, or disable any entities which you don't need.
-## Calendar Event Automations
+## Calendar event automations
Individual Calendar *Events* are what powering automations such as:
@@ -58,9 +58,9 @@ Individual Calendar *Events* are what powering automations such as:
- Send a notification *5 minutes before the start of any event*
- Stop the media player *30 minutes after* the *end* of the event named *Exercise*.
-See [Calendar Automations](/integrations/calendar#automation) for an overview, and read more about [Calendar Trigger Variables](/docs/automation/templating/#calendar) for the available information you can use in a condition or action such as the event `summary`, `description`, `location` and more.
+See [calendar automations](/integrations/calendar#automation) for an overview, and read more about [calendar trigger variables](/docs/automation/templating/#calendar) for the available information you can use in a condition or action such as the event `summary`, `description`, `location` and more.
-## Calendar Entity Attributes
+## Calendar entity attributes
The calendar entity has additional attributes related to a single next upcoming event.
@@ -127,7 +127,7 @@ data:
{% enddetails %}
-## More Configuration
+## More configuration
{% details "More Configuration" %}
diff --git a/source/_integrations/google_assistant.markdown b/source/_integrations/google_assistant.markdown
index cffbc8e198a..4ebe54b3828 100644
--- a/source/_integrations/google_assistant.markdown
+++ b/source/_integrations/google_assistant.markdown
@@ -302,7 +302,7 @@ Certain devices are considered secure. This includes devices in the `lock` domai
By default, secure devices cannot be opened by Google Assistant unless a `secure_devices_pin` code is set up. To allow opening, set the `secure_devices_pin` to something. You will then be prompted to speak the pin when opening the device. Closing or locking these devices does not require a pin.
-If a code is set for the Alarm Control Panel, it must be the same as the `secure_devices_pin`. If `code_arm_required` is set to `false`, the system will arm without prompting for the pin.
+If a code is set for the Alarm control panel, it must be the same as the `secure_devices_pin`. If `code_arm_required` is set to `false`, the system will arm without prompting for the pin.
### Room/Area support
diff --git a/source/_integrations/google_mail.markdown b/source/_integrations/google_mail.markdown
index 97875818225..b4dbf38860b 100644
--- a/source/_integrations/google_mail.markdown
+++ b/source/_integrations/google_mail.markdown
@@ -57,7 +57,7 @@ You can use the service `google_mail.set_vacation` to set vacation options.
The added `notify` service will be named after the email address you chose on the consent screen. For example, an email address named "example@gmail.com" wil display as `notify.example_gmail_com`.
-### Google Mail Notify Service Data
+### Google Mail notify service data
The following attributes can be placed inside the `data` key of the service call for extended functionality:
@@ -87,7 +87,8 @@ data:
from: "example@gmail.com"
```
-### Video Tutorial
+### Video tutorial
+
This video tutorial explains how to set up Gmail in Home Assistant and how you can create a dashboard and automations to send e-mail and toggle your out-of-office notice.
diff --git a/source/_integrations/google_maps.markdown b/source/_integrations/google_maps.markdown
index f238da4f348..f2e63f1bc4e 100644
--- a/source/_integrations/google_maps.markdown
+++ b/source/_integrations/google_maps.markdown
@@ -3,7 +3,7 @@ title: Google Maps
description: Instructions how to use Google Maps Location Sharing to track devices in Home Assistant.
ha_release: 0.67
ha_category:
- - Presence Detection
+ - Presence detection
ha_iot_class: Cloud Polling
ha_domain: google_maps
ha_platforms:
diff --git a/source/_integrations/google_pubsub.markdown b/source/_integrations/google_pubsub.markdown
index eb122bda972..bfa0c55f7c3 100644
--- a/source/_integrations/google_pubsub.markdown
+++ b/source/_integrations/google_pubsub.markdown
@@ -84,7 +84,7 @@ filter:
Not filtering domains or entities will send every event to Google PubSub, thus hitting the free tier limit very fast. Be sure to fill in this configuration parameter or have a paid subscription for Google Cloud.
-### Configure Filter
+### Configure filter
By default, no entity will be excluded. To limit which entities are being exposed to `Google Pub/Sub`, you can use the `filter` parameter.
diff --git a/source/_integrations/google_tasks.markdown b/source/_integrations/google_tasks.markdown
index 60bfce638d4..1ae24fd95f2 100644
--- a/source/_integrations/google_tasks.markdown
+++ b/source/_integrations/google_tasks.markdown
@@ -2,7 +2,7 @@
title: Google Tasks
description: Instructions on how to use Google Tasks in Home Assistant.
ha_category:
- - To-do List
+ - To-do list
ha_iot_class: Cloud Polling
ha_release: 2023.11
ha_config_flow: true
diff --git a/source/_integrations/google_wifi.markdown b/source/_integrations/google_wifi.markdown
index 84514d908ff..0f1027e273d 100644
--- a/source/_integrations/google_wifi.markdown
+++ b/source/_integrations/google_wifi.markdown
@@ -2,7 +2,7 @@
title: Google Wifi
description: Instructions on how to integrate Google Wifi/OnHub routers into Home Assistant.
ha_category:
- - System Monitor
+ - System monitor
ha_iot_class: Local Polling
ha_release: '0.50'
ha_domain: google_wifi
diff --git a/source/_integrations/gpslogger.markdown b/source/_integrations/gpslogger.markdown
index 004ac512d89..f746a7bf97a 100644
--- a/source/_integrations/gpslogger.markdown
+++ b/source/_integrations/gpslogger.markdown
@@ -2,7 +2,7 @@
title: GPSLogger
description: Instructions on how to use GPSLogger to track devices in Home Assistant.
ha_category:
- - Presence Detection
+ - Presence detection
ha_release: 0.34
ha_iot_class: Cloud Push
ha_config_flow: true
diff --git a/source/_integrations/group.markdown b/source/_integrations/group.markdown
index 2c774e3008a..2970a679fc1 100644
--- a/source/_integrations/group.markdown
+++ b/source/_integrations/group.markdown
@@ -2,14 +2,14 @@
title: Group
description: Instructions on how to setup groups within Home Assistant.
ha_category:
- - Binary Sensor
+ - Binary sensor
- Cover
- Event
- Fan
- Helper
- Light
- Lock
- - Media Player
+ - Media player
- Notifications
- Organization
- Sensor
@@ -126,7 +126,7 @@ To add or remove entities from an existing group, click on `Group options`, all
-## YAML Configuration
+## YAML configuration
Alternatively, this integration can be configured and set up manually via YAML
instead. Here are example of how to configure groups when using the `configuration.yaml` file.
@@ -284,7 +284,7 @@ state_class:
required: false
{% endconfiguration %}
-## Notify Groups
+## Notify groups
This group is a special case of groups currently only available via YAML configuration.
diff --git a/source/_integrations/gstreamer.markdown b/source/_integrations/gstreamer.markdown
index 0f28c5fa3b2..6f15cabbb1b 100644
--- a/source/_integrations/gstreamer.markdown
+++ b/source/_integrations/gstreamer.markdown
@@ -1,8 +1,8 @@
---
title: GStreamer
-description: Instructions on how to integrate Gstreamer into Home Assistant.
+description: Instructions on how to integrate GStreamer into Home Assistant.
ha_category:
- - Media Player
+ - Media player
ha_release: 0.39
ha_iot_class: Local Push
ha_domain: gstreamer
@@ -68,7 +68,7 @@ On a Raspberry Pi, you may need to add the Home Assistant user to the `audio` gr
sudo usermod -a -G audio
```
-## Example Usage
+## Example usage
### Using with TTS
diff --git a/source/_integrations/guardian.markdown b/source/_integrations/guardian.markdown
index 74be90a680d..4350549a98f 100644
--- a/source/_integrations/guardian.markdown
+++ b/source/_integrations/guardian.markdown
@@ -4,7 +4,7 @@ description: Instructions on how to integrate Guardian into Home Assistant.
ha_iot_class: Local Polling
ha_release: '0.111'
ha_category:
- - Binary Sensor
+ - Binary sensor
- Button
- Sensor
- Switch
@@ -28,7 +28,7 @@ The `guardian` integration integrates
There is currently support for the following device types within Home Assistant:
-- **Binary Sensor**: reports the status of the onboard leak detector and access point
+- **Binary sensor**: reports the status of the onboard leak detector and access point
- **Button**: add various configuration controls
- **Sensor**: reports on the device's detected temperature and uptime
- **Switch**: allows the user to open and close the valve
diff --git a/source/_integrations/harman_kardon_avr.markdown b/source/_integrations/harman_kardon_avr.markdown
index fb9b26078fc..f4c3077e287 100644
--- a/source/_integrations/harman_kardon_avr.markdown
+++ b/source/_integrations/harman_kardon_avr.markdown
@@ -2,7 +2,7 @@
title: Harman Kardon AVR
description: Instructions on how to integrate Harman Kardon AVR Network Receivers into Home Assistant.
ha_category:
- - Media Player
+ - Media player
ha_iot_class: Local Polling
ha_release: 0.85
ha_domain: harman_kardon_avr
diff --git a/source/_integrations/hassio.markdown b/source/_integrations/hassio.markdown
index 41dfb29538f..9d1107739b9 100644
--- a/source/_integrations/hassio.markdown
+++ b/source/_integrations/hassio.markdown
@@ -2,7 +2,7 @@
title: Home Assistant Supervisor
description: Control Supervisor Add-ons and OS from Home Assistant
ha_category:
- - Binary Sensor
+ - Binary sensor
- Sensor
- Update
ha_iot_class: Local Polling
@@ -20,7 +20,8 @@ ha_integration_type: integration
---
Supervisor integration allows you to monitor and control Supervisor add-ons and operating system from Home Assistant.
-This integration is already installed if you run Home Assistant OS or Supervised.
+This integration is already installed if you run Home Assistant OS or Supervised. Please note that this integration
+cannot be installed on Home Assistant Container or Core (Python venv) installation types.
## Sensor entities
@@ -64,7 +65,7 @@ For Home Assistant Host, the following sensors are available:
| Disk Total | no | Total space (in GB) on the device
| Disk Used | no | Used space (in GB) on the device
-## Binary Sensor entities
+## Binary sensor entities
For each installed add-on Supervisor provides following binary sensors:
@@ -121,7 +122,7 @@ Write data to add-on stdin.
### Service hassio.addon_update
-Update add-on. This service should be used with caution since add-on updates can contain breaking changes. It is highly recommended that you review release notes/change logs before updating an add-on.
+Update add-on. This service should be used with caution since add-on updates can contain backward-incompatible changes. It is highly recommended that you review release notes/change logs before updating an add-on.
| Service Data Attribute | Optional | Description |
| ---------------------- | -------- | ----------- |
diff --git a/source/_integrations/hddtemp.markdown b/source/_integrations/hddtemp.markdown
index fa2a1851805..4f6bc851ef0 100644
--- a/source/_integrations/hddtemp.markdown
+++ b/source/_integrations/hddtemp.markdown
@@ -2,7 +2,7 @@
title: hddtemp
description: Instructions on how to integrate hard drive temperature information into Home Assistant.
ha_category:
- - System Monitor
+ - System monitor
ha_release: 0.32
ha_iot_class: Local Polling
ha_domain: hddtemp
diff --git a/source/_integrations/heos.markdown b/source/_integrations/heos.markdown
index a31ba2a51cd..cb12ee09b6a 100644
--- a/source/_integrations/heos.markdown
+++ b/source/_integrations/heos.markdown
@@ -2,7 +2,7 @@
title: Denon HEOS
description: Instructions on how to integrate Denon HEOS into Home Assistant.
ha_category:
- - Media Player
+ - Media player
ha_release: 0.92
ha_iot_class: Local Push
ha_config_flow: true
@@ -52,7 +52,7 @@ Use the sign-out service to sign the connected controller out of a HEOS account.
### Service `media_player.play_media`
-#### Play Favorite
+#### Play favorite
You can play a HEOS favorite by number or name with the `media_player.play_media` service. Example service data payload:
@@ -68,7 +68,7 @@ media_content_id: "1"
| `media_content_type` | no | Set to the value `favorite`
| `media_content_id` | no | (i.e., `1`) or name (i.e., `Thumbprint Radio`) of the HEOS favorite
-#### Play Playlist
+#### Play playlist
You can play a HEOS playlist with the `media_player.play_media` service. Example service data payload:
diff --git a/source/_integrations/here_travel_time.markdown b/source/_integrations/here_travel_time.markdown
index 5e646d5795f..afd618da87c 100644
--- a/source/_integrations/here_travel_time.markdown
+++ b/source/_integrations/here_travel_time.markdown
@@ -30,7 +30,7 @@ Notes:
{% include integrations/option_flow.md %}
-## Dynamic Configuration
+## Dynamic configuration
Tracking can be set up to track entities of type `device_tracker`, `zone`, `sensor`, `input_select`, `input_text` and `person`. If an entity is placed in the origin or destination then each time the platform updates, it will use the latest location of that entity. This means it will directly use its location if possible or try to resolve entity values until it finds a valid set of coordinates. You can put several destinations as options of an `input_select` and define that as the destination.
diff --git a/source/_integrations/hexaom.markdown b/source/_integrations/hexaom.markdown
index f8dc82274b1..91774307654 100644
--- a/source/_integrations/hexaom.markdown
+++ b/source/_integrations/hexaom.markdown
@@ -3,7 +3,7 @@ title: Hexaom Hexaconnect
description: Connect and control your Hexaom Hexaconnect devices using the Overkiz integration
ha_category:
- Alarm
- - Binary Sensor
+ - Binary sensor
- Button
- Climate
- Cover
@@ -16,7 +16,7 @@ ha_category:
- Sensor
- Siren
- Switch
- - Water Heater
+ - Water heater
ha_domain: hexaom
ha_integration_type: virtual
ha_supporting_domain: overkiz
diff --git a/source/_integrations/hi_kumo.markdown b/source/_integrations/hi_kumo.markdown
index e30c1cb547c..e7f1f05863b 100644
--- a/source/_integrations/hi_kumo.markdown
+++ b/source/_integrations/hi_kumo.markdown
@@ -3,7 +3,7 @@ title: Hitachi Hi Kumo
description: Connect and control your Hitachi Hi Kumo devices using the Overkiz integration
ha_category:
- Alarm
- - Binary Sensor
+ - Binary sensor
- Button
- Climate
- Cover
@@ -16,7 +16,7 @@ ha_category:
- Sensor
- Siren
- Switch
- - Water Heater
+ - Water heater
ha_domain: hi_kumo
ha_integration_type: virtual
ha_supporting_domain: overkiz
diff --git a/source/_integrations/hikvision.markdown b/source/_integrations/hikvision.markdown
index 73b267730d2..3740c932370 100644
--- a/source/_integrations/hikvision.markdown
+++ b/source/_integrations/hikvision.markdown
@@ -2,7 +2,7 @@
title: Hikvision
description: Instructions on how to set up Hikvision camera binary sensors within Home Assistant.
ha_category:
- - Binary Sensor
+ - Binary sensor
ha_release: 0.35
ha_iot_class: Local Push
ha_codeowners:
diff --git a/source/_integrations/history_stats.markdown b/source/_integrations/history_stats.markdown
index b535e1d5aec..83d836cbfa0 100644
--- a/source/_integrations/history_stats.markdown
+++ b/source/_integrations/history_stats.markdown
@@ -133,7 +133,7 @@ duration:
-### Video Tutorial
+### Video tutorial
This video tutorial explains how you can use history stats. It also shows how you can create a daily bar chart graph to visualize things such as occupancy, or how long the lights are on in a particular room.
diff --git a/source/_integrations/hitron_coda.markdown b/source/_integrations/hitron_coda.markdown
index 58e0518b8d3..e205d8dc511 100644
--- a/source/_integrations/hitron_coda.markdown
+++ b/source/_integrations/hitron_coda.markdown
@@ -2,7 +2,7 @@
title: Rogers Hitron CODA
description: Instructions on how to integrate Hitron CODA Routers into Home Assistant.
ha_category:
- - Presence Detection
+ - Presence detection
ha_release: 0.58
ha_domain: hitron_coda
ha_iot_class: Local Polling
diff --git a/source/_integrations/hive.markdown b/source/_integrations/hive.markdown
index 0ee2da5df69..1835055ce6d 100644
--- a/source/_integrations/hive.markdown
+++ b/source/_integrations/hive.markdown
@@ -3,13 +3,13 @@ title: Hive
description: Instructions on how to integrate Hive devices with Home Assistant.
ha_category:
- Alarm
- - Binary Sensor
+ - Binary sensor
- Climate
- Hub
- Light
- Sensor
- Switch
- - Water Heater
+ - Water heater
ha_release: 0.59
ha_iot_class: Cloud Polling
ha_codeowners:
@@ -123,7 +123,7 @@ script:
## Platforms
-### Alarm Control Panel
+### Alarm control panel
The `hive` alarm control panel integration integrates your Hive alarm into Home Assistant.
@@ -131,7 +131,7 @@ The platform supports the following Hive devices:
- Hive Home Shield
-### Binary Sensor
+### Binary sensor
The `hive` binary sensor integration integrates your Hive sensors into Home Assistant.
@@ -185,7 +185,7 @@ The platform supports the following Hive products:
- Hive Active Plug
- Hive Heat on Demand
-### Water Heater
+### Water heater
The `hive` water heater platform integrates your Hive hot water into Home Assistant, enabling control of setting the **mode**.
diff --git a/source/_integrations/home_connect.markdown b/source/_integrations/home_connect.markdown
index 21cc2ee5d53..9bd0c1e78df 100644
--- a/source/_integrations/home_connect.markdown
+++ b/source/_integrations/home_connect.markdown
@@ -2,7 +2,7 @@
title: Home Connect
description: Instructions on how to set up the Home Connect integration within Home Assistant.
ha_category:
- - Binary Sensor
+ - Binary sensor
- Hub
- Light
- Sensor
diff --git a/source/_integrations/home_plus_control.markdown b/source/_integrations/home_plus_control.markdown
index 25e0bec1062..e71e1b18a00 100644
--- a/source/_integrations/home_plus_control.markdown
+++ b/source/_integrations/home_plus_control.markdown
@@ -82,7 +82,7 @@ Restart Home Assistant after changing the YAML configuration. At this point, you
{% include integrations/config_flow.md %}
-## API Nomenclature
+## API nomenclature
Within the context of the Home+ Control API you may come across the following terms:
@@ -93,7 +93,7 @@ Within the context of the Home+ Control API you may come across the following te
Other devices that are mentioned in the API, but that are not currently supported by this integration are: *remotes* (wireless switches), *heaters* and *automations*.
-## API Limitations
+## API limitations
As described in the [authentication](#authentication) section, this integration requires you to set up a subscription in the *Works with Legrand* platform.
diff --git a/source/_integrations/homekit.markdown b/source/_integrations/homekit.markdown
index 7a6dba3ec20..de40cf9a7c7 100644
--- a/source/_integrations/homekit.markdown
+++ b/source/_integrations/homekit.markdown
@@ -423,7 +423,7 @@ The following integrations are currently supported:
| water_heater | WaterHeater | All `water_heater` devices. |
| device_automation | DeviceTriggerAccessory | All devices that support triggers. |
-# Device Triggers
+# Device triggers
Devices that support triggers can be added to the bridge by accessing options for the bridge in **{% my integrations title="Settings > Devices & Services" %}**. To use this feature, Advanced Mode must be enabled in your user profile.
diff --git a/source/_integrations/homekit_controller.markdown b/source/_integrations/homekit_controller.markdown
index f3c3363ea55..911968d75b5 100644
--- a/source/_integrations/homekit_controller.markdown
+++ b/source/_integrations/homekit_controller.markdown
@@ -3,7 +3,7 @@ title: HomeKit Device
description: Instructions for how to integrate your HomeKit devices within Home Assistant.
ha_category:
- Alarm
- - Binary Sensor
+ - Binary sensor
- Climate
- Cover
- Fan
@@ -185,18 +185,18 @@ This section describes how to add a HomeKit [compatible device](#supported-devic
There is currently support for the following device types (also called *domains*) within Home Assistant. They are listed with their default types.
-- Alarm Control Panel (HomeKit security system)
+- Alarm control panel (HomeKit security system)
- Climate (HomeKit thermostats and air conditioners)
- Cover (HomeKit garage door openers, windows, or window coverings)
- Light (HomeKit lights)
- Lock (HomeKit lock)
- Switch (HomeKit switches, outlets and valves)
-- Binary Sensor (HomeKit motion, contact, occupancy, carbon monoxide and smoke sensors)
+- Binary sensor (HomeKit motion, contact, occupancy, carbon monoxide and smoke sensors)
- Sensor (HomeKit humidity, temperature, co2 and light level sensors)
- Fan
-- Air Quality
+- Air quality
- Humidifier (HomeKit humidifiers and dehumidifiers)
-- Automation Triggers (HomeKit 'stateless' accessories like buttons, remotes and doorbells)
+- Automation triggers (HomeKit 'stateless' accessories like buttons, remotes and doorbells)
diff --git a/source/_integrations/homematic.markdown b/source/_integrations/homematic.markdown
index f1dd050a153..bcc2948f65c 100644
--- a/source/_integrations/homematic.markdown
+++ b/source/_integrations/homematic.markdown
@@ -2,7 +2,7 @@
title: Homematic
description: Instructions for integrating Homematic into Home Assistant.
ha_category:
- - Binary Sensor
+ - Binary sensor
- Climate
- Cover
- Hub
@@ -34,7 +34,7 @@ If you are using Homegear with paired [Intertechno](https://intertechno.at/) dev
There is currently support for the following device types within Home Assistant:
-- Binary Sensor
+- Binary sensor
- Climate
- Cover
- Light
diff --git a/source/_integrations/homematicip_cloud.markdown b/source/_integrations/homematicip_cloud.markdown
index 3e349c200dc..5da3de12d45 100644
--- a/source/_integrations/homematicip_cloud.markdown
+++ b/source/_integrations/homematicip_cloud.markdown
@@ -3,7 +3,7 @@ title: HomematicIP Cloud
description: Instructions for integrating HomematicIP into Home Assistant.
ha_category:
- Alarm
- - Binary Sensor
+ - Binary sensor
- Button
- Climate
- Cover
@@ -36,7 +36,7 @@ The [HomematicIP](https://www.homematic-ip.com/) integration platform is used as
There is currently support for the following device types within Home Assistant:
- Alarm
-- Binary Sensor
+- Binary sensor
- Button
- Climate
- Cover
@@ -222,7 +222,7 @@ Executable by administrators or within the context of an automation:
- `homematicip_cloud.dump_hap_config`: Dump the configuration of the Homematic IP Access Point(s).
- `homematicip_cloud.reset_energy_counter`: Reset energy counter of measuring actuators.
-### Service Examples
+### Service examples
`accesspoint_id` (SGTIN) is optional for all services and only relevant if you have multiple Homematic IP Accesspoints connected to HA. If empty, service will be called for all configured Homematic IP Access Points.
The `accesspoint_id` (SGTIN) can be found on top of the integration page, or on the back of your Homematic IP Accesspoint.
diff --git a/source/_integrations/homeseer.markdown b/source/_integrations/homeseer.markdown
index 4f772f83a56..9d999eddcaa 100644
--- a/source/_integrations/homeseer.markdown
+++ b/source/_integrations/homeseer.markdown
@@ -4,7 +4,7 @@ description: Connect and control your HomeSeer Z-Wave devices using the Z-Wave i
ha_release: '2023.4'
ha_iot_class: Local Push
ha_category:
- - Binary Sensor
+ - Binary sensor
- Light
- Sensor
- Switch
diff --git a/source/_integrations/honeywell.markdown b/source/_integrations/honeywell.markdown
index 7d5d147de2a..c92b6d576af 100644
--- a/source/_integrations/honeywell.markdown
+++ b/source/_integrations/honeywell.markdown
@@ -48,6 +48,8 @@ The climate platform integrates Honeywell US-based thermostats into Home Assista
All [climate services](/integrations/climate) are supported except set_swing_mode.
+There is a "known" issue related to setting the temperature from Home Assistant with some thermostats. If your instance receives errors when setting the temperature above or below some value, go to the Honeywell web page and set the temperature to the max or min for the mode you are using, then adjust from Home Assistant.
+
## Sensor
The sensor platform integrates inside and outside temperature and humidity into Home Assistant as sensors for each device. Not every supported thermostat will support all sensors.
diff --git a/source/_integrations/horizon.markdown b/source/_integrations/horizon.markdown
index 351edd23674..ca43d588fdd 100644
--- a/source/_integrations/horizon.markdown
+++ b/source/_integrations/horizon.markdown
@@ -2,7 +2,7 @@
title: Unitymedia Horizon HD Recorder
description: Instructions how to integrate the Unitymedia Horizon HD Recorder into Home Assistant.
ha_category:
- - Media Player
+ - Media player
ha_iot_class: Local Polling
ha_release: 0.72
ha_domain: horizon
diff --git a/source/_integrations/hp_ilo.markdown b/source/_integrations/hp_ilo.markdown
index 1f0cbe9c013..d25414cb672 100644
--- a/source/_integrations/hp_ilo.markdown
+++ b/source/_integrations/hp_ilo.markdown
@@ -2,7 +2,7 @@
title: HP Integrated Lights-Out (ILO)
description: How to integrate HP ILO (Integrated Lights-Out) sensors within Home Assistant.
ha_category:
- - System Monitor
+ - System monitor
ha_release: 0.27
ha_iot_class: Local Polling
ha_domain: hp_ilo
diff --git a/source/_integrations/http.markdown b/source/_integrations/http.markdown
index 868622030f1..dcaff9ba899 100644
--- a/source/_integrations/http.markdown
+++ b/source/_integrations/http.markdown
@@ -16,7 +16,7 @@ The `http` integration serves all files and data required for the Home Assistant
There is currently support for the following device types within Home Assistant:
-- [Binary Sensor](#binary-sensor)
+- [Binary sensor](#binary-sensor)
- [Sensor](#sensor)
@@ -162,7 +162,7 @@ If you want to use Home Assistant to host or serve static files then create a di
-## Binary Sensor
+## Binary sensor
The HTTP binary sensor is dynamically created with the first request that is made to its URL. You don't have to define it in the configuration first.
@@ -289,4 +289,4 @@ $ curl -X GET -H "Authorization: Bearer LONG_LIVED_ACCESS_TOKEN" \
}
```
-For more examples please visit the [HTTP Binary Sensor](#examples) page.
+For more examples please visit the [HTTP binary sensor](#examples) page.
diff --git a/source/_integrations/huawei_lte.markdown b/source/_integrations/huawei_lte.markdown
index b28968d48b0..876a955fff4 100644
--- a/source/_integrations/huawei_lte.markdown
+++ b/source/_integrations/huawei_lte.markdown
@@ -2,10 +2,10 @@
title: Huawei LTE
description: Instructions on how to integrate Huawei LTE router and modem devices with Home Assistant.
ha_category:
- - Binary Sensor
+ - Binary sensor
- Network
- Notifications
- - Presence Detection
+ - Presence detection
- Sensor
- Switch
ha_release: 0.79
diff --git a/source/_integrations/hydrawise.markdown b/source/_integrations/hydrawise.markdown
index 07a8e338a42..1485c4ce9d6 100644
--- a/source/_integrations/hydrawise.markdown
+++ b/source/_integrations/hydrawise.markdown
@@ -2,7 +2,7 @@
title: Hunter Hydrawise
description: Instructions on how to integrate your Hunter Hydrawise Wi-Fi irrigation control system within Home Assistant.
ha_category:
- - Binary Sensor
+ - Binary sensor
- Irrigation
- Sensor
- Switch
@@ -24,7 +24,7 @@ The `hydrawise` integration allows you to integrate your [Hunter Hydrawise](http
There is currently support for the following device types within Home Assistant:
-- [Binary Sensor](#binary-sensor)
+- [Binary sensor](#binary-sensor)
- [Sensor](#sensor)
- [Switch](#switch)
@@ -39,7 +39,7 @@ To set up the Hydrawise integration, you must first obtain an API Key.
{% include integrations/config_flow.md %}
-## Binary Sensor
+## Binary sensor
Binary sensor entities are created for the controller:
@@ -67,7 +67,7 @@ Switches are added for each zone, controlling:
- Smart watering features
- Manual watering
-### Switch Operation
+### Switch operation
When `auto_watering` is `on` the irrigation zone will follow the Smart Watering schedule set through the Hydrawise [mobile or web app](https://www.hydrawise.com). When the `auto_watering` switch is `off` the zone's Smart Watering schedule is suspended for 1 year.
diff --git a/source/_integrations/hyperion.markdown b/source/_integrations/hyperion.markdown
index 0156bd9c8ad..7b984db6861 100644
--- a/source/_integrations/hyperion.markdown
+++ b/source/_integrations/hyperion.markdown
@@ -41,13 +41,13 @@ Options supported:
- **Effects to hide**: An optional selection of effects to hide from the light effects
list. New effects added to the Hyperion server will be shown by default.
-## Hyperion Instances
+## Hyperion instances
This integration supports multiple Hyperion instances running on a single Hyperion
server. As instances are added/removed on the Hyperion UI, they will automatically be
added/removed from Home Assistant.
-## Light Entity
+## Light entity
The default light entity will send data to Hyperion on the priority you have configured
during integration setup. When turned off, it will clear the configured priority again.
@@ -61,7 +61,7 @@ a global switch (see Advanced Entities).
The effect list is dynamically pulled from the Hyperion server. Additionally, there
will be a 'Solid' effect to switch (back) to showing a solid color only.
-## Hyperion Camera
+## Hyperion camera
A Hyperion camera entity is created that shows a stream of the input to Hyperion (e.g., a
USB Capture device). This could be used to show a small "preview window" next to TV
@@ -71,7 +71,7 @@ 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).
-## Advanced Entities
+## Advanced entities
The Hyperion integration comes with a series of disabled-by-default entities for
advanced usecases. These entities expose 'raw' underlying Hyperion API components for
diff --git a/source/_integrations/iammeter.markdown b/source/_integrations/iammeter.markdown
index 1d1f929c40f..16fd1779eb7 100644
--- a/source/_integrations/iammeter.markdown
+++ b/source/_integrations/iammeter.markdown
@@ -15,6 +15,11 @@ ha_integration_type: integration
---
[IAMMETER](https://www.iammeter.com/) provides both a bi-directional single-phase energy meter([WEM3080](https://www.iammeter.com/products/single-phase-meter)) and a bi-directional three-phase energy monitor ([WEM3080T](https://www.iammeter.com/products/three-phase-meter)). Both of them can be integrated into Home Assistant.
+The [WEM3050T](https://www.iammeter.com/products/3phase-meter-3050t) is the latest three-phase/split-phase meter, released by IAMMETER on Nov 2023.
+The WEM3050T provides nearly all of the features the WEM3080T provides, with the exception of the cloud service.
+The WEM3050T can be integrated into Home Assistant by [all of the methods](https://community.home-assistant.io/t/four-ways-to-integrate-the-electricity-usage-monitor-iammeter-into-the-home-assistant/485520/) that WEM3080T supports.
+Because there is no cloud service by default, the WEM3050T is much cheaper than the WEM3080T.
+
## Configuration
diff --git a/source/_integrations/iaqualink.markdown b/source/_integrations/iaqualink.markdown
index db0b459dfc2..9a832875b36 100644
--- a/source/_integrations/iaqualink.markdown
+++ b/source/_integrations/iaqualink.markdown
@@ -2,7 +2,7 @@
title: Jandy iAqualink
description: Instructions on how to configure Jandy iAqualink integration.
ha_category:
- - Binary Sensor
+ - Binary sensor
- Climate
- Light
- Sensor
@@ -26,7 +26,7 @@ ha_integration_type: integration
There is currently support for the following device types within Home Assistant:
-- Binary Sensor
+- Binary sensor
- Climate
- Light
- Sensor
diff --git a/source/_integrations/ibeacon.markdown b/source/_integrations/ibeacon.markdown
index 0ad3e5ec633..dc3f54b77e0 100644
--- a/source/_integrations/ibeacon.markdown
+++ b/source/_integrations/ibeacon.markdown
@@ -2,8 +2,8 @@
title: iBeacon Tracker
description: Instructions on how to integrate iBeacon devices into Home Assistant.
ha_category:
- - Device Tracker
- - Presence Detection
+ - Device tracker
+ - Presence detection
- Sensor
ha_release: '2022.10'
ha_iot_class: Local Push
diff --git a/source/_integrations/icloud.markdown b/source/_integrations/icloud.markdown
index aeb9bd5b80b..5dfe2d2cd89 100644
--- a/source/_integrations/icloud.markdown
+++ b/source/_integrations/icloud.markdown
@@ -2,7 +2,7 @@
title: Apple iCloud
description: Instructions on how to use iCloud to track devices in Home Assistant.
ha_category:
- - Presence Detection
+ - Presence detection
- Sensor
ha_iot_class: Cloud Polling
ha_release: '0.10'
@@ -21,7 +21,7 @@ The `icloud` integration allows you to detect presence using the [iCloud](https:
There is currently support for the following platforms within Home Assistant:
-- [Device Tracker](#device-tracker)
+- [Device tracker](#device-tracker)
- [Sensor](#sensor)
It does require that your devices are registered with the [Find My](https://www.apple.com/icloud/find-my/) service.
@@ -46,7 +46,7 @@ Go into your Home Assistant configuration `.storage` folder and delete the `iclo
## Platforms
-### Device Tracker
+### Device tracker
The iCloud integration will track available devices on your iCloud account.
diff --git a/source/_integrations/idasen_desk.markdown b/source/_integrations/idasen_desk.markdown
index 86137dc67ff..53d5e2340f8 100644
--- a/source/_integrations/idasen_desk.markdown
+++ b/source/_integrations/idasen_desk.markdown
@@ -24,6 +24,8 @@ The recommended way to connect the desk to Home Assistant is by using an [ESPHom
If you are not using an ESPHome Bluetooth Proxy, you need to keep `bluetoothctl` (or any other Bluetooth Agent) open during the integration setup, or it will fail to authenticate with the desk. The connection process is also less reliable than with ESPHome, so you may need to retry a few times until it succeeds. This is due to a limitation in the third-party Bluetooth implementation used by Home Assistant.
+Also, if not using an ESPHome Bluetooth Proxy, you may experience the desk becoming unavailable and needing re-pairing after a restart of Home Assistant or a reload of the integration. To pair it permanently, [access the host over SSH](https://developers.home-assistant.io/docs/operating-system/debugging/#ssh-access-to-the-host), pair the desk with `bluetoothctl pair `, and validate it being listed by `bluetoothctl devices Paired`. If the desk is not listed as paired, repeat the command several times while entering pairing mode on the desk.
+
{% include integrations/config_flow.md %}
diff --git a/source/_integrations/ihc.markdown b/source/_integrations/ihc.markdown
index 87ecd0b16f2..c4f0a6eb05d 100644
--- a/source/_integrations/ihc.markdown
+++ b/source/_integrations/ihc.markdown
@@ -2,7 +2,7 @@
title: IHC Controller
description: Instructions on how to integrate the IHC integrations with Home Assistant
ha_category:
- - Binary Sensor
+ - Binary sensor
- Hub
- Light
- Sensor
@@ -22,7 +22,7 @@ IHC Controller integration for Home Assistant allows you to connect the LK IHC c
There is currently support for the following device types within Home Assistant:
-- [Binary Sensor](#binary-sensor)
+- [Binary sensor](#binary-sensor)
- [Sensor](#sensor)
- [Light](#light)
- [Switch](#switch)
@@ -83,7 +83,7 @@ If you want an easier way to get the IHC resource ids, you can download the [Alt
See the manual of each device type for configuration options.
-## Binary Sensor
+## Binary sensor
Before you can use the IHC Binary Sensor platform, you must setup the IHC integration.
diff --git a/source/_integrations/image_processing.markdown b/source/_integrations/image_processing.markdown
index fb4a055e030..6c5a31e50bf 100644
--- a/source/_integrations/image_processing.markdown
+++ b/source/_integrations/image_processing.markdown
@@ -1,8 +1,8 @@
---
-title: Image Processing
+title: Image processing
description: Instructions on how to setup image processing with Home Assistant.
ha_category:
- - Image Processing
+ - Image processing
ha_release: 0.36
ha_domain: image_processing
ha_quality_scale: internal
diff --git a/source/_integrations/imap.markdown b/source/_integrations/imap.markdown
index 5e4d18312ae..9d63daba3ef 100644
--- a/source/_integrations/imap.markdown
+++ b/source/_integrations/imap.markdown
@@ -67,12 +67,12 @@ Yahoo also requires the character set `US-ASCII`.
-### Selecting an alternate SSL cipher list or disable SSL verification (advanced mode)
+### Selecting an alternate SSL cipher list or disabling SSL verification (advanced mode)
-If the default IMAP server settings do not work, you might try to set an alternate SLL cipher list.
-The SSL cipher list option allows to select the list of SSL ciphers to be accepted from this endpoint. `default` (_system default_), `modern` or `intermediate` (_inspired by [Mozilla Security/Server Side TLS](https://wiki.mozilla.org/Security/Server_Side_TLS)_)
+If the default IMAP server settings do not work, you might try to set an alternate SSL cipher list.
+The SSL cipher list option allows you to select the list of SSL ciphers to be accepted from this endpoint: `default` (_system default_), `modern` or `intermediate` (_inspired by [Mozilla Security/Server Side TLS](https://wiki.mozilla.org/Security/Server_Side_TLS)_).
-If you are using self signed certificates can can turn of SSL verification.
+If you are using self signed certificates, you can turn off SSL verification.
diff --git a/source/_integrations/incomfort.markdown b/source/_integrations/incomfort.markdown
index 8c5077094ad..8eb1cff3fb8 100644
--- a/source/_integrations/incomfort.markdown
+++ b/source/_integrations/incomfort.markdown
@@ -2,10 +2,10 @@
title: Intergas InComfort/Intouch Lan2RF gateway
description: Instructions on how to integrate an Intergas Lan2RF gateway with Home Assistant.
ha_category:
- - Binary Sensor
+ - Binary sensor
- Climate
- Sensor
- - Water Heater
+ - Water heater
ha_release: 0.93
ha_iot_class: Local Polling
ha_codeowners:
@@ -25,11 +25,11 @@ It uses the [incomfort](https://pypi.org/project/incomfort-client/) client libra
### Boiler
-The boiler is represented as a **Water Heater** device. It will report the boiler's `state` and `current_temperature`. The gateway does not expose any means to directly control the boiler or change its configuration.
+The boiler is represented as a **Water heater** device. It will report the boiler's `state` and `current_temperature`. The gateway does not expose any means to directly control the boiler or change its configuration.
Note that the `current_temperature` will switch between the CV (circulating volume) and Tap temperatures according to the current operating mode of the boiler. If the boiler is neither pumping nor tapping, it will be reported as the higher of the two.
-In addition, there is a **Sensor** for each of CV pressure, CV temperature, and Tap temperature, and a **Binary Sensor** that will be `on` if there is a fault with the boiler (the fault code will be a state attribute).
+In addition, there is a **Sensor** for each of CV pressure, CV temperature, and Tap temperature, and a **Binary sensor** that will be `on` if there is a fault with the boiler (the fault code will be a state attribute).
### Rooms
diff --git a/source/_integrations/influxdb.markdown b/source/_integrations/influxdb.markdown
index 9c20f787987..f16c8e25cfc 100644
--- a/source/_integrations/influxdb.markdown
+++ b/source/_integrations/influxdb.markdown
@@ -211,7 +211,7 @@ component_config_glob:
required: false
{% endconfiguration %}
-## Configure Filter
+## Configure filter
By default, no entity will be excluded. To limit which entities are being exposed to `InfluxDB`, you can use the `include` and `exclude` parameters.
diff --git a/source/_integrations/input_boolean.markdown b/source/_integrations/input_boolean.markdown
index 273ceefae19..afd4e7064a5 100644
--- a/source/_integrations/input_boolean.markdown
+++ b/source/_integrations/input_boolean.markdown
@@ -74,13 +74,13 @@ Home Assistant itself.
| `toggle` | `entity_id(s)` `area_id(s)` | Toggle the value of specific `input_boolean` entities
| `reload` | | Reload `input_boolean` configuration |
-### Restore State
+### Restore state
If you set a valid value for `initial` this integration will start with the state
set to that value. Otherwise, it will restore the state it had prior to
Home Assistant stopping.
-## Automation Examples
+## Automation examples
Here's an example of an automation using the above `input_boolean`. This action
will only occur if the `input_boolean` is on.
diff --git a/source/_integrations/input_button.markdown b/source/_integrations/input_button.markdown
index 06390ac7f20..2e130827e4a 100644
--- a/source/_integrations/input_button.markdown
+++ b/source/_integrations/input_button.markdown
@@ -54,7 +54,7 @@ input_button:
type: icon
{% endconfiguration %}
-## Automation Examples
+## Automation examples
The `input_button` entity is stateless, as in, it cannot have a state like the
`on` or `off` state that, for example, a normal switch entity has.
diff --git a/source/_integrations/input_datetime.markdown b/source/_integrations/input_datetime.markdown
index c28991115ca..b17c1a4dd99 100644
--- a/source/_integrations/input_datetime.markdown
+++ b/source/_integrations/input_datetime.markdown
@@ -85,7 +85,7 @@ automations and templates.
| `year` `month` `day` | The year, month and day of the date. (only available if `has_date: true`)
| `timestamp` | A timestamp representing the time held in the input. (only available if `has_time: true`)
-### Restore State
+### Restore state
If you set a valid value for `initial`, this integration will start with the state set to that value. Otherwise, it will restore the state it had prior to Home Assistant stopping.
diff --git a/source/_integrations/input_number.markdown b/source/_integrations/input_number.markdown
index 9a92150dd7f..2b34c9d0a24 100644
--- a/source/_integrations/input_number.markdown
+++ b/source/_integrations/input_number.markdown
@@ -94,7 +94,7 @@ configuration without restarting Home Assistant itself.
| `reload` | | Reload `input_number` configuration |
| `set_value` | `value` `entity_id(s)` `area_id(s)` | Set the value of specific `input_number` entities
-### Restore State
+### Restore state
If you set a valid value for `initial` this integration will start with the state set to that value. Otherwise, it will restore the state it had prior to Home Assistant stopping. Please note that `initial` is only available in a YAML configuration and not via the Home Assistant user interface.
@@ -110,7 +110,7 @@ scene:
input_number.example_number: 13
```
-## Automation Examples
+## Automation examples
Here's an example of `input_number` being used as a trigger in an automation.
diff --git a/source/_integrations/input_select.markdown b/source/_integrations/input_select.markdown
index 0962cc439d6..c7303e07e22 100644
--- a/source/_integrations/input_select.markdown
+++ b/source/_integrations/input_select.markdown
@@ -69,7 +69,7 @@ Because YAML defines [booleans](https://yaml.org/type/bool.html) as equivalent,
-### Restore State
+### Restore state
If you set a valid value for `initial` this integration will start with the state set to that value. Otherwise, it will restore the state it had prior to Home Assistant stopping.
@@ -129,7 +129,7 @@ scene:
```
-## Automation Examples
+## Automation examples
The following example shows the usage of the `input_select.select_option` service in an automation:
diff --git a/source/_integrations/input_text.markdown b/source/_integrations/input_text.markdown
index 2ee5e5814e1..ad7fde93350 100644
--- a/source/_integrations/input_text.markdown
+++ b/source/_integrations/input_text.markdown
@@ -88,7 +88,7 @@ This integration provides a service to modify the state of the `input_text` and
| `set_value` | `value` `entity_id(s)` | Set the value for specific `input_text` entities.
| `reload` | | Reload `input_text` configuration |
-### Restore State
+### Restore state
If you set a valid value for `initial` this integration will start with state set to that value. Otherwise, it will restore the state it had prior to Home Assistant stopping.
@@ -104,7 +104,7 @@ scene:
input_text.example: Hello!
```
-## Automation Examples
+## Automation examples
Here's an example using `input_text` in an action in an automation.
diff --git a/source/_integrations/insteon.markdown b/source/_integrations/insteon.markdown
index ce459b1eea8..b815aba3616 100644
--- a/source/_integrations/insteon.markdown
+++ b/source/_integrations/insteon.markdown
@@ -2,7 +2,7 @@
title: Insteon
description: Instructions on how to set up an Insteon Modem (PLM or Hub) locally within Home Assistant.
ha_category:
- - Binary Sensor
+ - Binary sensor
- Cover
- Fan
- Hub
diff --git a/source/_integrations/integration.markdown b/source/_integrations/integration.markdown
index 456122bd216..4a07d90bc17 100644
--- a/source/_integrations/integration.markdown
+++ b/source/_integrations/integration.markdown
@@ -44,7 +44,7 @@ Integration time:
{% endconfiguration_basic %}
-## YAML Configuration
+## YAML configuration
Alternatively, this integration can be configured and set up manually via YAML
as well. To enable the Integration sensor in your installation, add the
diff --git a/source/_integrations/intellifire.markdown b/source/_integrations/intellifire.markdown
index f1cdd9e5e4a..a8e4a5a5c5e 100644
--- a/source/_integrations/intellifire.markdown
+++ b/source/_integrations/intellifire.markdown
@@ -2,7 +2,7 @@
title: IntelliFire
description: Instructions on the IntelliFire Fireplace integration for Home Assistant.
ha_category:
- - Binary Sensor
+ - Binary sensor
- Climate
- Fan
- Light
@@ -70,9 +70,9 @@ The integration uses a Number entity to control flame height. Valid flame height
### Sensor Types
-The following sensors are available as either a **Binary Sensor** when dealing with on/off.
+The following sensors are available as a **binary sensor** when dealing with on/off.
-### Binary Sensors
+### Binary sensors
- **Flame Sensor**: Whether the fire is on.
- **Pilot Light Sensor**: Whether the pilot light is turned on.
diff --git a/source/_integrations/iperf3.markdown b/source/_integrations/iperf3.markdown
index 09eceab51ad..026f3e972c4 100644
--- a/source/_integrations/iperf3.markdown
+++ b/source/_integrations/iperf3.markdown
@@ -3,7 +3,7 @@ title: Iperf3
description: How to use Iperf3 within Home Assistant to measure your network bandwidth.
ha_category:
- Sensor
- - System Monitor
+ - System monitor
ha_release: 0.71
ha_iot_class: Local Polling
ha_codeowners:
diff --git a/source/_integrations/ipp.md b/source/_integrations/ipp.md
index 034db3750fe..ffbcdb21318 100644
--- a/source/_integrations/ipp.md
+++ b/source/_integrations/ipp.md
@@ -2,7 +2,7 @@
title: Internet Printing Protocol (IPP)
description: Instructions on how to integrate printers that support the Internet Printing Protocol (IPP) into Home Assistant.
ha_category:
- - System Monitor
+ - System monitor
ha_release: 0.108
ha_iot_class: Local Polling
ha_config_flow: true
diff --git a/source/_integrations/isy994.markdown b/source/_integrations/isy994.markdown
index 8a7b5a1c9cb..cf244056372 100644
--- a/source/_integrations/isy994.markdown
+++ b/source/_integrations/isy994.markdown
@@ -2,7 +2,7 @@
title: Universal Devices ISY/IoX
description: Instructions on how to setup an ISY controller within Home Assistant.
ha_category:
- - Binary Sensor
+ - Binary sensor
- Button
- Climate
- Cover
@@ -44,7 +44,7 @@ This integration supports the legacy ISY994 hardware family, as well as current
There is currently support for the following platforms within Home Assistant:
-- Binary Sensor
+- Binary sensor
- Button
- Climate
- Cover
@@ -75,9 +75,9 @@ There are several options available to further customize what is imported from t
### Sensors
-An Insteon door/window sensor will show up as a single Binary Sensor rather than two discrete devices like it does in the ISY Admin Console. Note that when in "Two Nodes" mode, the sensor will have an UNKNOWN state until the sensor changes for the first time since the last Home Assistant reboot. If you do not use Insteon scenes that are controlled directly from the door sensor, you may prefer to set the sensor to "One Node" mode using the ISY Admin Panel.
+An Insteon door/window sensor will show up as a single binary sensor rather than two discrete devices like it does in the ISY Admin Console. Note that when in "Two Nodes" mode, the sensor will have an UNKNOWN state until the sensor changes for the first time since the last Home Assistant reboot. If you do not use Insteon scenes that are controlled directly from the door sensor, you may prefer to set the sensor to "One Node" mode using the ISY Admin Panel.
-Each Insteon leak sensor will also show up as a single Binary Sensor as opposed to the two nodes seen in the ISY Admin Console. The name of the device will be based on what the parent node is named in the ISY, which is typically the one with "-Dry" at the end of the name. This may be confusing, because "On" means wet in Home Assistant. You can rename this node in Home Assistant to be more clear, see the [Customization section](/docs/configuration/customizing-devices/) of your configuration.
+Each Insteon leak sensor will also show up as a single binary sensor as opposed to the two nodes seen in the ISY Admin Console. The name of the device will be based on what the parent node is named in the ISY, which is typically the one with "-Dry" at the end of the name. This may be confusing, because "On" means wet in Home Assistant. You can rename this node in Home Assistant to be more clear, see the [Customization section](/docs/configuration/customizing-devices/) of your configuration.
If your leak or door/window sensor supports heartbeats, a new binary_sensor device will be added to Home Assistant to represent the battery state. The sensor will stay "Off" so long as the daily heartbeats occur. If a heartbeat is missed, the sensor will flip to "On". The name of this device will be based on the heartbeat node in the ISY.
diff --git a/source/_integrations/itunes.markdown b/source/_integrations/itunes.markdown
index 3da8a0addd0..c3713cbf822 100644
--- a/source/_integrations/itunes.markdown
+++ b/source/_integrations/itunes.markdown
@@ -2,7 +2,7 @@
title: Apple iTunes
description: Instructions on how to integrate iTunes into Home Assistant.
ha_category:
- - Media Player
+ - Media player
ha_release: 0.7.3
ha_iot_class: Local Polling
ha_domain: itunes
diff --git a/source/_integrations/jellyfin.markdown b/source/_integrations/jellyfin.markdown
index c005d05ca52..c28a2fd8fc5 100644
--- a/source/_integrations/jellyfin.markdown
+++ b/source/_integrations/jellyfin.markdown
@@ -2,8 +2,8 @@
title: Jellyfin
description: Instructions on how to integrate the Jellyfin integration into Home Assistant.
ha_category:
- - Media Player
- - Media Source
+ - Media player
+ - Media source
- Sensor
ha_release: '2021.12'
ha_iot_class: Local Polling
@@ -19,8 +19,8 @@ ha_platforms:
ha_integration_type: service
---
-The Jellyfin integration exposes a [Jellyfin](https://jellyfin.org/) server as a Media Source in Home Assistant.
-Support is currently limited to music, movie and tvshow libraries only. Other libraries will not appear in the Media Browser. This integration has been tested with Jellyfin server version 10.6.4 and later.
+The Jellyfin integration exposes a [Jellyfin](https://jellyfin.org/) server as a media source in Home Assistant.
+Support is currently limited to music, movie and TV show libraries only. Other libraries will not appear in the media browser. This integration has been tested with Jellyfin server version 10.6.4 and later.
Additionally, this integration sets up every media session connected to the Jellyfin
server as a media player in Home Assistant to provide media controls for each session.
diff --git a/source/_integrations/justnimbus.markdown b/source/_integrations/justnimbus.markdown
index 0a1624401c4..fa2194ee128 100644
--- a/source/_integrations/justnimbus.markdown
+++ b/source/_integrations/justnimbus.markdown
@@ -27,7 +27,7 @@ client ID from the URL. For example: `https://dashboard.justnimbus.com/my-instal
{% include integrations/config_flow.md %}
-## Sensor Types
+## Sensor types
When configured, the integration will create twelve sensors for each configured client ID:
diff --git a/source/_integrations/jvc_projector.markdown b/source/_integrations/jvc_projector.markdown
index c905e68fb8a..40458b33c3c 100644
--- a/source/_integrations/jvc_projector.markdown
+++ b/source/_integrations/jvc_projector.markdown
@@ -16,7 +16,7 @@ ha_integration_type: device
The JVC Projector integration allows for the automation of [JVC Projectors](https://www.jvc.com/usa/projectors/).
-## Supported Models
+## Supported models
This integration is intended for the automation of any modern JVC Projector with a LAN network port.
diff --git a/source/_integrations/kaleidescape.markdown b/source/_integrations/kaleidescape.markdown
index 739fd538733..f0919231401 100644
--- a/source/_integrations/kaleidescape.markdown
+++ b/source/_integrations/kaleidescape.markdown
@@ -2,7 +2,7 @@
title: Kaleidescape
description: Instructions on how to integrate Kaleidescape into Home Assistant.
ha_category:
- - Media Player
+ - Media player
- Remote
- Sensor
ha_release: '2022.4'
@@ -34,9 +34,9 @@ This integration is intended for the automation of Kaleidescape players with a m
{% include integrations/config_flow.md %}
-## Media Player
+## Media player
-The Kaleidescape media player platform will create a [Media Player](/integrations/media_player/) entity for the device. This entity will display the currently playing media and playback controls.
+The Kaleidescape media player platform will create a [media player](/integrations/media_player/) entity for the device. This entity will display the currently playing media and playback controls.
## Remote
diff --git a/source/_integrations/keba.markdown b/source/_integrations/keba.markdown
index 2cde4e5dad6..02128a9cb18 100644
--- a/source/_integrations/keba.markdown
+++ b/source/_integrations/keba.markdown
@@ -2,7 +2,7 @@
title: Keba Charging Station
description: Instructions on how to setup your Keba charging station with Home Assistant.
ha_category:
- - Binary Sensor
+ - Binary sensor
- Lock
- Notifications
- Sensor
@@ -23,7 +23,7 @@ The `keba` integrates your Keba charging station/BMW Wallbox into your Home Assi
This integration provides the following platforms:
-- Binary Sensors: Online state, plug state, Charging state and failsafe mode state.
+- Binary sensors: Online state, plug state, charging state and failsafe mode state.
- Lock: Authorization (like with the RFID card).
- Sensors: current set by the user, target energy set by the user, charging power, charged energy of the current session and total energy charged.
- Services: authorize, deauthorize, set energy target, set the maximum allowed current and manually update the states. More details can be found [here](/integrations/keba/#services).
diff --git a/source/_integrations/keenetic_ndms2.markdown b/source/_integrations/keenetic_ndms2.markdown
index 643fcad6ada..87c00786a4f 100644
--- a/source/_integrations/keenetic_ndms2.markdown
+++ b/source/_integrations/keenetic_ndms2.markdown
@@ -2,7 +2,7 @@
title: Keenetic NDMS2 Router
description: Instructions on how to integrate Keenetic NDMS2 Routers into Home Assistant.
ha_category:
- - Presence Detection
+ - Presence detection
ha_iot_class: Local Polling
ha_release: 0.54
ha_codeowners:
diff --git a/source/_integrations/kef.markdown b/source/_integrations/kef.markdown
index 53b3360e082..27644471ecf 100644
--- a/source/_integrations/kef.markdown
+++ b/source/_integrations/kef.markdown
@@ -2,7 +2,7 @@
title: KEF
description: Instructions on how to integrate KEF Speakers into Home Assistant.
ha_category:
- - Media Player
+ - Media player
ha_iot_class: Local Polling
ha_release: 0.104
ha_codeowners:
diff --git a/source/_integrations/keymitt_ble.markdown b/source/_integrations/keymitt_ble.markdown
index 51a855adf22..29645cf787b 100644
--- a/source/_integrations/keymitt_ble.markdown
+++ b/source/_integrations/keymitt_ble.markdown
@@ -29,7 +29,7 @@ Please note, that the devices cannot remain paired to the MicroBot application f
{% include integrations/config_flow.md %}
-### Supported Devices
+### Supported devices
This Integration is for the MicroBot Push only. The Keymitt lock is not supported.
diff --git a/source/_integrations/kira.markdown b/source/_integrations/kira.markdown
index 853dc4db943..faa9296929c 100644
--- a/source/_integrations/kira.markdown
+++ b/source/_integrations/kira.markdown
@@ -34,7 +34,7 @@ kira:
Kira modules have no built-in mechanism for auto-discovery, so will need to be configured to send packets to Home Assistant. The process varies according to the module type. The documentation for each can be found on the [manufacturer's website](https://www.info.keene-electronics.co.uk).
-### Configuration Options
+### Configuration options
```yaml
# Example configuration.yaml entry
@@ -99,7 +99,7 @@ Restart Home Assistant and you should now have an entity called `kira_remote` (o
-### IR Codes
+### IR codes
The first time the Kira integration is loaded, `kira_codes.yaml` will be created in the Home Assistant configuration directory.
@@ -236,7 +236,7 @@ Example automation using these IR codes to toggle a Sonoff plug.
type: turn_off
```
-### Code Types
+### Code types
When creating an entry in `kira_codes.yaml`, a few different kinds of codes can be used.
diff --git a/source/_integrations/knx.markdown b/source/_integrations/knx.markdown
index ff5d693127d..8a801597ec4 100644
--- a/source/_integrations/knx.markdown
+++ b/source/_integrations/knx.markdown
@@ -3,7 +3,7 @@ title: KNX
description: Instructions on how to integrate KNX components with Home Assistant.
featured: true
ha_category:
- - Binary Sensor
+ - Binary sensor
- Button
- Climate
- Cover
@@ -56,7 +56,7 @@ The integration requires a local KNX/IP interface or router. Through this, it wi
There is currently support for the following device types within Home Assistant:
-- [Binary Sensor](#binary-sensor)
+- [Binary sensor](#binary-sensor)
- [Button](#button)
- [Climate](#climate)
- [Cover](#cover)
@@ -79,7 +79,7 @@ As a Home Assistant KNX user, you can start a FREE KNX online training and get a
{% include integrations/config_flow.md %}
-## Basic Configuration
+## Basic configuration
In order to make use of the various platforms that KNX offers you will need to add the relevant configuration sections to your setup. This could either all be in the Home Assistant main `configuration.yaml` file, or in a separate YAML file that you include in the main file or even be split into multiple dedicated files. See [Splitting up the configuration](/docs/configuration/splitting_configuration/).
@@ -264,7 +264,7 @@ automation:
address: "0/4/21"
```
-### Register Event
+### Register event
The `knx.event_register` service can be used to register (or unregister) group addresses to fire `knx_event` Events. Events for group addresses configured in the `event` key in `configuration.yaml` cannot be unregistered. See [knx_event](#events)
@@ -284,7 +284,7 @@ type:
required: false
{% endconfiguration %}
-### Register Exposure
+### Register exposure
The `knx.exposure_register` service can be used to register (or unregister) exposures to the KNX bus. Exposures defined in `configuration.yaml` can not be unregistered. Per address only one exposure can be registered. See [expose](#exposing-entity-states-entity-attributes-or-time-to-knx-bus)
@@ -373,7 +373,7 @@ respond_to_read:
default: true
{% endconfiguration %}
-## Binary Sensor
+## Binary sensor
The KNX binary sensor platform allows you to monitor [KNX](https://www.knx.org/) binary sensors.
@@ -1664,7 +1664,7 @@ device_class:
type: string
{% endconfiguration %}
-### Value Types
+### Value types
| KNX DPT | type | size in byte | range | unit |
| ------: | ----------------------------- | -----------: | :------------------------: | -------------- |
@@ -1729,7 +1729,7 @@ device_class:
| 12.001 | pulse_4_ucount | 4 | 0 ... 4294967295 | counter pulses |
| 12.100 | long_time_period_sec | 4 | 0 ... 4294967295 | s |
| 12.101 | long_time_period_min | 4 | 0 ... 4294967295 | min |
-| 12.100 | long_time_period_hrs | 4 | 0 ... 4294967295 | h |
+| 12.102 | long_time_period_hrs | 4 | 0 ... 4294967295 | h |
| 12.1200 | volume_liquid_litre | 4 | 0 ... 4294967295 | l |
| 12.1201 | volume_m3 | 4 | 0 ... 4294967295 | m³ |
| 13 | 4byte_signed | 4 | -2147483648 ... 2147483647 | |
diff --git a/source/_integrations/kodi.markdown b/source/_integrations/kodi.markdown
index 5276b49996b..2998e7e6120 100644
--- a/source/_integrations/kodi.markdown
+++ b/source/_integrations/kodi.markdown
@@ -2,8 +2,8 @@
title: Kodi
description: Instructions on how to integrate Kodi into Home Assistant.
ha_category:
- - Media Player
- - Media Source
+ - Media player
+ - Media source
- Notifications
ha_release: pre 0.7
ha_iot_class: Local Push
@@ -24,7 +24,7 @@ The preferred way to set up the Kodi platform is through discovery, which requir
There is currently support for the following device types within Home Assistant:
-- [Media Player](#configuration)
+- [Media player](#configuration)
- [Notifications](#notifications)
{% include integrations/config_flow.md %}
@@ -39,7 +39,7 @@ If you do not remove it, your configuration will be imported with the following
You can customize your turn on and off actions through automations. Simply use the relevant Kodi device triggers and your automation will be called to perform the `turn_on` or `turn_off` sequence; see the [Kodi turn on/off samples](#kodi-turn-onoff-samples) section for scripts that can be used.
-These automations can be configured through the UI (see [Device Triggers](/docs/automation/trigger/#device-triggers) for automations). If you prefer YAML, you'll need to get the device ID from the UI automation editor. Automations would be of the form:
+These automations can be configured through the UI (see [device triggers](/docs/automation/trigger/#device-triggers) for automations). If you prefer YAML, you'll need to get the device ID from the UI automation editor. Automations would be of the form:
```yaml
automation:
diff --git a/source/_integrations/konnected.markdown b/source/_integrations/konnected.markdown
index eea8ec363ef..717107ad37d 100644
--- a/source/_integrations/konnected.markdown
+++ b/source/_integrations/konnected.markdown
@@ -3,7 +3,7 @@ title: Konnected.io
description: Connect wired alarm sensors and siren using the NodeMCU based Konnected Alarm Panel
ha_category:
- Alarm
- - Binary Sensor
+ - Binary sensor
- Sensor
- Switch
ha_iot_class: Local Push
@@ -22,6 +22,12 @@ ha_integration_type: integration
The `konnected` integration lets you connect wired sensors and switches to a Konnected Alarm Panel, or NodeMCU ESP8226 based device running the [open source Konnected software](https://github.com/konnected-io/konnected-security). Reuse the wired sensors and siren from an old or pre-wired alarm system installation and integrate them directly into Home Assistant.
+
+
+This integration is deprecated in favor of [Konnected's ESPHome firmware](https://support.konnected.io/add-a-konnected-device-to-home-assistant-with-esphome) and will not receive updates. ESPHome connects locally and natively to Home Assistant and doesn't need this custom integration. If you are getting started with a Konnected device, do not use this integration. Instead, flash your device with ESPHome-based firmware for the [Konnected Alarm Panel](https://install.konnected.io/esphome) and [Garage Door Opener](https://support.konnected.io/installing-the-garage-door-opener-with-home-assistant).
+
+
+
Visit the [Konnected.io website](https://konnected.io) for more information about the Konnected Alarm Panel board and compatible hardware.
@@ -32,7 +38,7 @@ Always ensure your panel is running the [latest firmware](https://help.konnected
The integration currently supports the following device types in Home Assistant:
-- Binary Sensor: Wired door and window sensors, motion detectors, glass-break detectors, leak sensors, smoke & CO detectors or any open/close switch.
+- Binary sensor: Wired door and window sensors, motion detectors, glass-break detectors, leak sensors, smoke & CO detectors or any open/close switch.
- Switch: Actuate a siren, strobe, buzzer or relay module.
- Sensor: Periodic measurements from DHT temperature/humidity sensors and DS18B20 temperature sensors.
@@ -69,9 +75,9 @@ The settings for each panel can be accessed by selecting the entry in **Settings
The settings UI starts by having you configure the general behavior of each zone. You need to specify `Disabled`, `Binary Sensor`, `Digital Sensor`, or `Switchable Output` for each zone. After that, you'll be prompted, for each zone that is not disabled, to configure details of the zones' behavior. All zones will allow entry of a Name. Additional fields depend on how you configured the general behavior of the zone.
**Note some zones do not support all behaviors. The UI will reflect specific options available to each zone.**
-##### Binary Sensor:
+##### Binary sensor:
-**Binary Sensor Type:** The type of sensor connected to the zone.
+**Binary sensor type:** The type of sensor connected to the zone.
**Name (optional)** The friendly name for the entity associated with the zone.
@@ -109,7 +115,7 @@ Once all zones are configured you'll be presented with the configuration for add
**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.
-### YAML Configuration
+### YAML configuration
If you prefer you can utilize a `konnected` section in the `configuration.yaml` file that specifies the Konnected devices on the network and the sensors or actuators attached to them. If using `configuration.yaml` the configuration will be one-time imported when going through the Configuration Flow for the panel. **Note that you must still complete the UI based setup before the integration will be configured and entities created/accessible.**
diff --git a/source/_integrations/kulersky.markdown b/source/_integrations/kulersky.markdown
index 74aa300dcd6..b35e4510c86 100644
--- a/source/_integrations/kulersky.markdown
+++ b/source/_integrations/kulersky.markdown
@@ -30,7 +30,7 @@ Before you get started with this integration, please note that:
- Requires access to the Bluetooth stack, see [Rootless Setup section](#rootless-setup) for further information
-## Rootless Setup
+## Rootless setup
Normally accessing the Bluetooth stack is reserved for `root`, but running programs that are networked as `root` is a bad security wise. To allow non-root access to the Bluetooth stack we can give Python 3 and `hcitool` the missing capabilities to access the Bluetooth stack. Quite like setting the setuid bit (see [Stack Exchange](https://unix.stackexchange.com/questions/96106/bluetooth-le-scan-as-non-root) for more information).
diff --git a/source/_integrations/lacrosse.markdown b/source/_integrations/lacrosse.markdown
index c8cdb7642d1..aaccacfad33 100644
--- a/source/_integrations/lacrosse.markdown
+++ b/source/_integrations/lacrosse.markdown
@@ -13,7 +13,7 @@ ha_integration_type: integration
The `lacrosse` sensor platform is using the data provided by a [Jeelink](https://www.digitalsmarties.net/products/jeelink) USB dongle or this [Arduino sketch](https://svn.fhem.de/trac/browser/trunk/fhem/contrib/arduino/36_LaCrosse-LaCrosseITPlusReader.zip).
-## Tested Devices
+## Tested devices
- Technoline TX 29 IT (temperature only)
- Technoline TX 29 DTH-IT (including humidity)
diff --git a/source/_integrations/landisgyr_heat_meter.markdown b/source/_integrations/landisgyr_heat_meter.markdown
index 9ff5be4c6b6..f0101cda990 100644
--- a/source/_integrations/landisgyr_heat_meter.markdown
+++ b/source/_integrations/landisgyr_heat_meter.markdown
@@ -60,7 +60,7 @@ Further data that is read from the device is added as diagnostic entities:
- Settings and firmware
- Flow hours
-## Energy Dashboard
+## Energy dashboard
Either heat usage or volume usage can be used as "Gas" on the energy dashboard. If you want to supply a price per MWh, make sure to apply the conversion factor first.
diff --git a/source/_integrations/laundrify.markdown b/source/_integrations/laundrify.markdown
index 17efc18d679..ed0637eed1a 100644
--- a/source/_integrations/laundrify.markdown
+++ b/source/_integrations/laundrify.markdown
@@ -2,7 +2,7 @@
title: laundrify
description: Instructions on how to integrate laundrify within Home Assistant.
ha_category:
- - Binary Sensor
+ - Binary sensor
ha_release: 2022.6
ha_iot_class: Cloud Polling
ha_domain: laundrify
@@ -18,7 +18,7 @@ Monitor the status of your washing machine or dryer within Home Assistant using
The following device types are currently supported by the integration:
-- Binary Sensor
+- Binary sensor
## Generate an Auth Code
diff --git a/source/_integrations/lawn_mower.markdown b/source/_integrations/lawn_mower.markdown
index 3148f38b080..42e870ace45 100644
--- a/source/_integrations/lawn_mower.markdown
+++ b/source/_integrations/lawn_mower.markdown
@@ -1,11 +1,11 @@
---
-title: Lawn Mower
+title: Lawn mower
description: Instructions on how to setup and use lawn mowers in Home Assistant.
ha_release: 2023.9
ha_domain: lawn_mower
ha_quality_scale: internal
ha_category:
- - Lawn Mower
+ - Lawn mower
ha_codeowners:
- '@home-assistant/core'
ha_integration_type: entity
diff --git a/source/_integrations/lawn_mower.mqtt.markdown b/source/_integrations/lawn_mower.mqtt.markdown
index fee2619b7ee..efbc6eda481 100644
--- a/source/_integrations/lawn_mower.mqtt.markdown
+++ b/source/_integrations/lawn_mower.mqtt.markdown
@@ -1,8 +1,8 @@
---
-title: "MQTT Lawn Mower"
+title: "MQTT lawn mower"
description: "Instructions on how to integrate MQTT lawn mowers into Home Assistant."
ha_category:
- - Lawn Mower
+ - Lawn mower
ha_release: 2023.9
ha_iot_class: Configurable
ha_domain: mqtt
@@ -12,7 +12,7 @@ The `mqtt` `lawn_mower` platform allows controlling a lawn mower over MQTT.
## Configuration
-To enable MQTT Lawn Mower in your installation, add the following to your `configuration.yaml` file:
+To enable MQTT lawn mower in your installation, add the following to your `configuration.yaml` file:
```yaml
# Example configuration.yaml entry
diff --git a/source/_integrations/lcn.markdown b/source/_integrations/lcn.markdown
index 93feb8439c6..499f22f59c6 100644
--- a/source/_integrations/lcn.markdown
+++ b/source/_integrations/lcn.markdown
@@ -2,7 +2,7 @@
title: LCN
description: Instructions on how to integrate LCN components with Home Assistant.
ha_category:
- - Binary Sensor
+ - Binary sensor
- Climate
- Cover
- Hub
@@ -33,7 +33,7 @@ With this setup sending and receiving commands to and from LCN modules is possib
There is currently support for the following device types within Home Assistant:
-- [Binary Sensor](#binary-sensor)
+- [Binary sensor](#binary-sensor)
- [Climate](#climate)
- [Cover](#cover)
- [Light](#light)
@@ -332,7 +332,7 @@ switches:
type: string
{% endconfiguration %}
-## LCN Addresses
+## LCN addresses
LCN hardware devices connected to the LCN bus are called _modules_. LCN modules are addressed by their numeric id in the range (5..254).
@@ -364,7 +364,7 @@ s0.g7
Leading zeroes in the segment id or module/group id can be omitted. If the `connection_id` is omitted, the first connection defined in the [configuration](#configuration) will be used.
-## LCN Constants
+## LCN constants
The platforms and service calls use several predefined constants as parameters.
@@ -421,7 +421,7 @@ Examples: `a1`, `a5`, `d8`.
## Platforms
-### Binary Sensor
+### Binary sensor
The `lcn` binary sensor platform allows the monitoring of the following [LCN](https://www.lcn.eu/) binary data sources:
@@ -497,7 +497,7 @@ The `lcn` switch platform allows the control of the following [LCN](https://www.
- Output ports
- Relays
-## Additional Features
+## Additional features
### Transponder, fingerprint sensor and code lock
diff --git a/source/_integrations/ld2410_ble.markdown b/source/_integrations/ld2410_ble.markdown
index 01f3c751053..b72511848d7 100644
--- a/source/_integrations/ld2410_ble.markdown
+++ b/source/_integrations/ld2410_ble.markdown
@@ -2,7 +2,7 @@
title: LD2410 BLE
description: Instructions on how to integrate LD2410 BLE devices into Home Assistant.
ha_category:
- - Presence Detection
+ - Presence detection
- Sensor
ha_bluetooth: true
ha_release: 2023.2
@@ -25,7 +25,7 @@ You can currently configure the settings for motion/static triggers by USB with
(This integration may not work if you reconfigure the default password or the number of gates.)
-## Sensors Provided
+## Sensors provided
The following sensors are provided:
diff --git a/source/_integrations/legrand.markdown b/source/_integrations/legrand.markdown
index 4676b3c62ef..a2d56087012 100644
--- a/source/_integrations/legrand.markdown
+++ b/source/_integrations/legrand.markdown
@@ -8,7 +8,7 @@ ha_category:
- Environment
- Hub
- Light
- - Media Source
+ - Media source
- Sensor
- Switch
- Weather
diff --git a/source/_integrations/leviton_z_wave.markdown b/source/_integrations/leviton_z_wave.markdown
index 9089eae67a7..f166b500e8f 100644
--- a/source/_integrations/leviton_z_wave.markdown
+++ b/source/_integrations/leviton_z_wave.markdown
@@ -7,7 +7,7 @@ ha_iot_class: Local Push
ha_codeowners:
- '@home-assistant/z-wave'
ha_category:
- - Binary Sensor
+ - Binary sensor
- Button
- Climate
- Cover
diff --git a/source/_integrations/lg_netcast.markdown b/source/_integrations/lg_netcast.markdown
index ecbf7264662..bf1dfe8f381 100644
--- a/source/_integrations/lg_netcast.markdown
+++ b/source/_integrations/lg_netcast.markdown
@@ -2,7 +2,7 @@
title: LG Netcast
description: Instructions on how to integrate a LG TV (Netcast 3.0 & 4.0) within Home Assistant.
ha_category:
- - Media Player
+ - Media player
ha_iot_class: Local Polling
ha_release: '0.20'
ha_domain: lg_netcast
diff --git a/source/_integrations/lg_soundbar.markdown b/source/_integrations/lg_soundbar.markdown
index 79477b0bf88..c19b9a46cb4 100644
--- a/source/_integrations/lg_soundbar.markdown
+++ b/source/_integrations/lg_soundbar.markdown
@@ -2,7 +2,7 @@
title: LG Soundbars
description: Instructions on how to integrate LG Soundbars into Home Assistant.
ha_category:
- - Media Player
+ - Media player
ha_iot_class: Local Polling
ha_release: 0.81
ha_domain: lg_soundbar
diff --git a/source/_integrations/life360.markdown b/source/_integrations/life360.markdown
index f7f5c29e309..04fdab8a16e 100644
--- a/source/_integrations/life360.markdown
+++ b/source/_integrations/life360.markdown
@@ -4,7 +4,7 @@ description: Instructions how to use Life360 to track devices in Home Assistant.
ha_release: 0.95
ha_config_flow: true
ha_category:
- - Presence Detection
+ - Presence detection
ha_iot_class: Cloud Polling
ha_codeowners:
- '@pnbruckner'
diff --git a/source/_integrations/lifx.markdown b/source/_integrations/lifx.markdown
index 2f99c8c79f8..2057e82519c 100644
--- a/source/_integrations/lifx.markdown
+++ b/source/_integrations/lifx.markdown
@@ -235,7 +235,7 @@ The LIFX integration currently has to poll the device every few seconds, as oppo
Discoveries from control protocols that are not desired can be ignored in the UI. LIFX devices that support HAP will be discovered by both methods if they have not been added to native HomeKit using an Apple iOS or macOS device. It is possible to set up control of the device in Home Assistant using both protocols simultaneously by configuring both the LIFX integration and the HomeKit Controller integration for the same device.
-## LIFX Switch
+## LIFX switch
The LIFX integration does not support the LIFX Switch. However, the [HomeKit Controller](/integrations/homekit_controller) integration can be used instead for
[LIFX Switch running firmware 3.90](https://support.lifx.com/en_us/switch-3-90-update-rk4zYiXVq) or higher. Follow the LIFX
@@ -245,7 +245,7 @@ When using the [HomeKit Controller](/integrations/homekit_controller) integratio
[stateless switch](/integrations/homekit_controller#stateless-switches-and-sensors) and will not appear as an entity in Home Assistant.
Relays that are configured as wired to non-LIFX devices will appear as normal switches in Home Assistant.
-## Troubleshooting Discovery
+## Troubleshooting discovery
### Lights
diff --git a/source/_integrations/light.mqtt.markdown b/source/_integrations/light.mqtt.markdown
index 0cd31f78e74..067f6799edb 100644
--- a/source/_integrations/light.mqtt.markdown
+++ b/source/_integrations/light.mqtt.markdown
@@ -775,7 +775,7 @@ mqtt:
supported_color_modes: ["brightness"]
```
-### Brightness Scaled
+### Brightness scaled
To enable a light using a brightness scale other than 8bit the `brightness_scale` option may be added to denote the "fully on" value:
@@ -802,7 +802,7 @@ Home Assistant will then convert its 8bit value in the message to and from the d
}
```
-### HS Color
+### HS color
To use a light with hue+saturation as the color model, set `supported_color_modes` to `["hs"]` in the platform configuration:
diff --git a/source/_integrations/light.template.markdown b/source/_integrations/light.template.markdown
index 01403ea1883..d1ef7e539f5 100644
--- a/source/_integrations/light.template.markdown
+++ b/source/_integrations/light.template.markdown
@@ -220,7 +220,7 @@ In this section you will find some real-life examples of how to use this light.
This example shows a light that is actually a home theater's volume. This
integration gives you the flexibility to provide whatever you'd like to send as
the payload to the consumer including any scale conversions you may need to
-make; the [Media Player integration](/integrations/media_player/) needs a floating
+make; the [media player integration](/integrations/media_player/) needs a floating
point percentage value from `0.0` to `1.0`.
{% raw %}
diff --git a/source/_integrations/limitlessled.markdown b/source/_integrations/limitlessled.markdown
index a765f02fc96..d42505259e9 100644
--- a/source/_integrations/limitlessled.markdown
+++ b/source/_integrations/limitlessled.markdown
@@ -98,7 +98,7 @@ bridges:
type: boolean
{% endconfiguration %}
-### Night Effect
+### Night effect
LimitlessLED has a `night` effect that can be used to dim the lights below `brightness: 1`. This night mode is meant to temporarily turn the lights into a nightlight. This mode can be especially helpful when wall switches are also being used. For example, when a light is using the `night` effect one way to return it to its previous brightness level (other than using Home Assistant) is to switch the lights off and then back on from the wall switch.
diff --git a/source/_integrations/linksys_smart.markdown b/source/_integrations/linksys_smart.markdown
index e2795a7fb04..465069da04f 100644
--- a/source/_integrations/linksys_smart.markdown
+++ b/source/_integrations/linksys_smart.markdown
@@ -2,7 +2,7 @@
title: Linksys Smart Wi-Fi
description: Instructions on how to integrate Linksys Smart Wi-Fi Router into Home Assistant.
ha_category:
- - Presence Detection
+ - Presence detection
ha_iot_class: Local Polling
ha_release: 0.48
ha_domain: linksys_smart
diff --git a/source/_integrations/linode.markdown b/source/_integrations/linode.markdown
index 419386f449f..0ff266fe5bc 100644
--- a/source/_integrations/linode.markdown
+++ b/source/_integrations/linode.markdown
@@ -2,9 +2,9 @@
title: Linode
description: Instructions on how to set up Linode within Home Assistant.
ha_category:
- - Binary Sensor
+ - Binary sensor
- Switch
- - System Monitor
+ - System monitor
ha_release: 0.57
ha_iot_class: Cloud Polling
ha_domain: linode
@@ -18,7 +18,7 @@ The `linode` integration allows you to access the information about your [Linode
There is currently support for the following device types within Home Assistant:
-- [Binary Sensor](#binary-sensor)
+- [Binary sensor](#binary-sensor)
- [Switch](#switch)
## Setup
@@ -48,7 +48,7 @@ linode:
type: string
{% endconfiguration %}
-## Binary Sensor
+## Binary sensor
The `linode` binary sensor platform allows you to monitor your Linode nodes.
diff --git a/source/_integrations/linux_battery.markdown b/source/_integrations/linux_battery.markdown
index fc43900fdaf..a14d1133f54 100644
--- a/source/_integrations/linux_battery.markdown
+++ b/source/_integrations/linux_battery.markdown
@@ -2,7 +2,7 @@
title: Linux Battery
description: Instructions on how to integrate Linux Battery information into Home Assistant.
ha_category:
- - System Monitor
+ - System monitor
ha_release: 0.28
ha_iot_class: Local Polling
ha_codeowners:
@@ -37,6 +37,6 @@ battery:
system:
description: "The local system type. Support `linux` and `android`."
required: false
- default: linux
+ default: "`linux`"
type: string
{% endconfiguration %}
diff --git a/source/_integrations/livisi.markdown b/source/_integrations/livisi.markdown
index aab54aef6a9..6ec35438dd4 100644
--- a/source/_integrations/livisi.markdown
+++ b/source/_integrations/livisi.markdown
@@ -2,7 +2,7 @@
title: LIVISI Smart Home
description: Access and control your LIVISI Smart Home Controller (SHC) and its connected RWE/innogy devices.
ha_category:
- - Binary Sensor
+ - Binary sensor
- Climate
- Switch
ha_iot_class: Local Polling
@@ -40,10 +40,10 @@ Please visit [LIVISI Community](https://community.livisi.de) for more informatio
{% include integrations/config_flow.md %}
-### Extra Configuration
+### Extra configuration
The current integration will not find your SHC automatically and needs to be configured manually. You will need to provide the IP address and the local password for the controller.
-## Device Discovery
+## Device discovery
All devices are automatically discovered and included by the integration. If you include a new device in LIVISI SmartHome, the device will automatically appear in Home Assistant after a few minutes.
diff --git a/source/_integrations/local_todo.markdown b/source/_integrations/local_todo.markdown
index 2096d34721a..3786fe8e9a6 100644
--- a/source/_integrations/local_todo.markdown
+++ b/source/_integrations/local_todo.markdown
@@ -2,7 +2,7 @@
title: Local To-do
description: Instructions on how to use local to-do lists in Home Assistant.
ha_category:
- - To-do List
+ - To-do list
ha_iot_class: Local Polling
ha_release: 2023.11
ha_config_flow: true
diff --git a/source/_integrations/locative.md b/source/_integrations/locative.md
index f68023d902f..3f28d27707d 100644
--- a/source/_integrations/locative.md
+++ b/source/_integrations/locative.md
@@ -2,7 +2,7 @@
title: "Locative"
description: "Instructions on how to use Locative to track devices in Home Assistant."
ha_category:
- - Presence Detection
+ - Presence detection
ha_release: 0.86
ha_iot_class: Cloud Push
ha_domain: locative
diff --git a/source/_integrations/lock.mqtt.markdown b/source/_integrations/lock.mqtt.markdown
index 341980e0efe..2e513f451c5 100644
--- a/source/_integrations/lock.mqtt.markdown
+++ b/source/_integrations/lock.mqtt.markdown
@@ -191,7 +191,6 @@ payload_open:
description: The payload sent to the lock to open it.
required: false
type: string
- default: OPEN
payload_reset:
description: A special payload that resets the state to `unknown` when received on the `state_topic`.
required: false
diff --git a/source/_integrations/lock.template.markdown b/source/_integrations/lock.template.markdown
index 624c94ec506..341c8680440 100644
--- a/source/_integrations/lock.template.markdown
+++ b/source/_integrations/lock.template.markdown
@@ -110,7 +110,7 @@ lock:
{% endraw %}
-### Optimistic Mode
+### Optimistic mode
This example shows a lock in optimistic mode. This lock will immediately change state after command and will not wait for state update from the sensor.
diff --git a/source/_integrations/logbook.markdown b/source/_integrations/logbook.markdown
index d1b54d2c2d6..9a35e87bf2b 100644
--- a/source/_integrations/logbook.markdown
+++ b/source/_integrations/logbook.markdown
@@ -65,7 +65,7 @@ include:
type: list
{% endconfiguration %}
-## Configure Filter
+## Configure filter
By default, the logbook will use the same filter as the recorder. To limit which entities are being exposed to `Logbook`, you can use the `include` and `exclude` parameters.
@@ -136,7 +136,7 @@ logbook:
- sensor.weather_*
```
-### Exclude Events
+### Exclude events
If you have `sensor.date` to show the current date in the UI,
but you do not want a logbook entry for that sensor every day it can be excluded.
@@ -151,7 +151,7 @@ for sun rise and sun set.
Excluded entities still take up space in the database. It may be advisable to
exclude them in `recorder` instead.
-### Custom Entries
+### Custom entries
It is possible to add custom entries to the logbook by using the script
integration to fire an event.
diff --git a/source/_integrations/logger.markdown b/source/_integrations/logger.markdown
index 6186d807cda..b55a9093d5d 100644
--- a/source/_integrations/logger.markdown
+++ b/source/_integrations/logger.markdown
@@ -104,7 +104,7 @@ If you want to know the namespaces in your own environment then check your log f
You will see INFO log messages from homeassistant.loader stating `loaded from `.
Those are the namespaces available for you to set a `log level` against.
-### Log Levels
+### Log levels
Possible log severity levels, listed in order from most severe to least severe, are:
@@ -117,7 +117,7 @@ Possible log severity levels, listed in order from most severe to least severe,
- debug
- notset
-### Log Filters
+### Log filters
Service-specific Regular Expression filters for logs. A message is omitted if it matches the Regular Expression.
diff --git a/source/_integrations/lookin.markdown b/source/_integrations/lookin.markdown
index 5d222568e1e..935c0bbf21c 100644
--- a/source/_integrations/lookin.markdown
+++ b/source/_integrations/lookin.markdown
@@ -4,7 +4,7 @@ description: Instructions on how to integrate LOOKin devices into Home Assistant
ha_category:
- Climate
- Light
- - Media Player
+ - Media player
- Sensor
ha_release: 2021.11
ha_iot_class: Local Push
diff --git a/source/_integrations/luci.markdown b/source/_integrations/luci.markdown
index d90afe8498c..2de65aa84f1 100644
--- a/source/_integrations/luci.markdown
+++ b/source/_integrations/luci.markdown
@@ -2,7 +2,7 @@
title: OpenWrt (luci)
description: Instructions on how to integrate OpenWrt routers into Home Assistant.
ha_category:
- - Presence Detection
+ - Presence detection
ha_iot_class: Local Polling
ha_release: pre 0.7
ha_codeowners:
diff --git a/source/_integrations/lupusec.markdown b/source/_integrations/lupusec.markdown
index 437b88db01e..b74930d7723 100644
--- a/source/_integrations/lupusec.markdown
+++ b/source/_integrations/lupusec.markdown
@@ -3,7 +3,7 @@ title: Lupus Electronics LUPUSEC
description: Instructions on integrating Lupusec home security with Home Assistant.
ha_category:
- Alarm
- - Binary Sensor
+ - Binary sensor
- Hub
- Switch
ha_release: 0.83
@@ -27,8 +27,8 @@ Supported units:
The following devices are supported by the underlying `lupupy` Python library and integrated into Home Assistant.
-- **Alarm Control Panel**: Displays the alarm status and controls arming, disarming and home modus.
-- **Binary Sensor**: Displays the status of binary sensors. Door, window, water, and smoke sensors are supported.
+- **Alarm control panel**: Displays the alarm status and controls arming, disarming and home modus.
+- **Binary sensor**: Displays the status of binary sensors. Door, window, water, and smoke sensors are supported.
- **Switch**: Turn off and on your Lupus power switches.
## Configuration
diff --git a/source/_integrations/lutron.markdown b/source/_integrations/lutron.markdown
index 2cad4ca6e1a..6ea72c24757 100644
--- a/source/_integrations/lutron.markdown
+++ b/source/_integrations/lutron.markdown
@@ -93,11 +93,11 @@ The Lutron scene platform allows you to control scenes programmed into your SeeT
After setup, scenes will appear in Home Assistant using the area, keypad and button name.
-## Occupancy Sensors
+## Occupancy sensors
Any configured Powr Savr occupancy sensors will be added as occupancy binary sensors. Lutron reports occupancy for an area, rather than reporting individual sensors. Sensitivity and timeouts are controlled on the sensors themselves, not in software.
-## Example Automations
+## Example automations
``` yaml
- alias: "keypad button pressed notification"
diff --git a/source/_integrations/lutron_caseta.markdown b/source/_integrations/lutron_caseta.markdown
index 5e23df3a031..edd51b03d78 100644
--- a/source/_integrations/lutron_caseta.markdown
+++ b/source/_integrations/lutron_caseta.markdown
@@ -3,7 +3,7 @@ title: Lutron Caséta
description: Instructions on how to use Lutron Caseta devices with Home Assistant.
featured: true
ha_category:
- - Binary Sensor
+ - Binary sensor
- Button
- Cover
- Fan
@@ -179,7 +179,7 @@ For more information on working with buttons in Home Assistant, see the [Buttons
Pico and Shade remotes are supported on the Smart Bridge (L-BDG2-WH), Smart Bridge PRO (L-BDGPRO2-WH), and RA2 Select (RR-SEL-REP2-BL) models.
-Device Triggers are implemented for `press` and `release` of each button on the remotes via watching for `lutron_caseta_button_event` events in the format:
+Device triggers are implemented for `press` and `release` of each button on the remotes via watching for `lutron_caseta_button_event` events in the format:
{% raw %}
diff --git a/source/_integrations/manual.markdown b/source/_integrations/manual.markdown
index 397bbe797f5..391339a8d81 100644
--- a/source/_integrations/manual.markdown
+++ b/source/_integrations/manual.markdown
@@ -1,5 +1,5 @@
---
-title: Manual Alarm Control Panel
+title: Manual Alarm control panel
description: Instructions on how to integrate manual alarms into Home Assistant.
ha_category:
- Alarm
diff --git a/source/_integrations/manual_mqtt.markdown b/source/_integrations/manual_mqtt.markdown
index 201500c9664..daebb429e3a 100644
--- a/source/_integrations/manual_mqtt.markdown
+++ b/source/_integrations/manual_mqtt.markdown
@@ -1,5 +1,5 @@
---
-title: Manual MQTT Alarm Control Panel
+title: Manual MQTT Alarm control panel
description: Instructions on how to integrate manual alarms into Home Assistant with MQTT support.
ha_category:
- Alarm
@@ -193,7 +193,7 @@ alarm_control_panel:
Refer to the [Manual Alarm Control page](/integrations/manual#examples) for more real-life examples on how to use this panel.
-## MQTT Control
+## MQTT control
The state of this alarm can be controlled using [MQTT](/integrations/mqtt/). Ensure you've configured that before adding this component.
diff --git a/source/_integrations/marantz.markdown b/source/_integrations/marantz.markdown
index 473504e74b4..de11c4a13b5 100644
--- a/source/_integrations/marantz.markdown
+++ b/source/_integrations/marantz.markdown
@@ -2,7 +2,7 @@
title: Marantz
description: Connect and control your Marantz devices using the Denon AVR Network Receivers integration
ha_category:
- - Media Player
+ - Media player
ha_domain: marantz
ha_integration_type: virtual
ha_supporting_domain: denonavr
diff --git a/source/_integrations/matrix.markdown b/source/_integrations/matrix.markdown
index 5afc3e2c370..5b8ad02b746 100644
--- a/source/_integrations/matrix.markdown
+++ b/source/_integrations/matrix.markdown
@@ -89,7 +89,7 @@ In order to prevent infinite loops when reacting to commands, you have to use a
-### Event Data
+### Event data
If a command is triggered, a `matrix_command` event is fired. The event contains the name of the command in the `name` field.
diff --git a/source/_integrations/matter.markdown b/source/_integrations/matter.markdown
index d207c79eb19..9e64752a34c 100644
--- a/source/_integrations/matter.markdown
+++ b/source/_integrations/matter.markdown
@@ -2,7 +2,7 @@
title: Matter (BETA)
description: Instructions on how to integrate Matter with Home Assistant.
ha_category:
- - Binary Sensor
+ - Binary sensor
- Climate
- Cover
- Light
@@ -34,13 +34,17 @@ The Matter integration allows you to control Matter devices on your local Wi-Fi
The integration is marked BETA: Both the Matter standard itself and its implementation within Home Assistant are in a early stage. You may run into compatibility issues and/or other bugs.
-# What is Matter?
+# Introduction- What is Matter?
-Matter is [the new standard for home automation](), which has been released recently. It is in the process of being adopted by the tech industry. Matter is a local protocol. Device control is done without the need of any cloud. From a technical perspective, you can use a Matter-compatible device with Home Assistant without connecting to a vendor-specific cloud. However, some vendors may require you to set up an account before you can enable Matter.
+Matter is a new smart home connectivity standard for home automation products and IoT (Internet of Things) devices, see its [Wikipedia article](https://en.wikipedia.org/wiki/Matter_(standard)).
-Unlike the radio based protocols we're already familiar with in the IoT landscape, like Zigbee and Z-Wave, Matter uses standard IP-based communication. Matter is not a radio protocol, but a control protocol that runs on top of the existing network infrastructure, using your existing Wi-Fi/Ethernet routers and Thread.
+The initial version 1.0 release of Matter was published in October of 2022. Matter is still in the process of being adopted in the smart home market. It has gotten much publicity because of its promise of interoperability across all ecosystems. The largest tech companies like Google, Apple and Amazon teamed up to develop this new smart home connectivity standard under the roof of the CSA ([Connectivity Standards Alliance](https://csa-iot.org/)). The largest tech companies that are already active in the home automation market have announced that they are or will be working on Matter-compatible products and also joined the development effort.
-Home Assistant is a so-called _controller_, it can control Matter based devices. Other examples of Matter controllers are the Google Nest speakers, Apple HomePods, and a SmartThings Station.
+Matter products run locally and always allow local control, with device control done without the need for any internet connection or cloud services. From a technical perspective, you can use a Matter-compatible device with Home Assistant without connecting to a vendor-specific cloud. However, some vendors may require you to set up an account before you can enable Matter support for some products, (especially for commercial manufacturer's own branded gateways/bridges/hubs/controllers sold as appliances).
+
+Unlike other common radio-based protocols for IoT, (like Zigbee, Z-Wave, and Bluetooth), the Matter standard specification itself does not contain its own proprietary radio protocol or network transport protocol, but instead, it is a service control protocol that runs **on top** of the existing network infrastructure at the application level, with all Matter devices communicating using standard IP-based (IPv6) communication over your existing [local area network (i.e. LAN networks like Wi-Fi and Ethernet)](https://en.wikipedia.org/wiki/Local_area_network) or [Thread (Low-Power Wireless Personal Area Network)](https://en.wikipedia.org/wiki/Thread_(network_protocol)) depending on the type of device.
+
+Home Assistant is a so-called "_controller_" in a Matter ecosystem, meaning that it can control Matter-based devices. Other examples of Matter controllers are the Google Nest products, Apple HomePod speakers, Samsung SmartThings Station, and some newer Amazon Echo devices.
## Bridge devices
@@ -170,67 +174,6 @@ NOTE for Android users: You need to follow the instructions at the bottom of the
10. To add the device, we need the QR code. In the console, type in `matter onboardingcodes ble` and copy/paste the URL into your browser.
11. Use the QR code to add the device using one of the above instructions on your phone, e.g. using the Home Assistant Companion app.
-## Known working devices
-
-Because the availability of actual Matter devices (and their documentation) is sparse, we provide a list of all known working devices that are tested by the Home Assistant Matter developers and/or the community to help you find the device you need. Note: The list below is ordered alphabetically, and some links contain affiliate links.
-
-Did you test a device that is not listed below? It would be greatly appreciated if you share your experience either on the Matter discord channel or contribute a PR (or suggestion) to this documentation page so you can help others, thanks in advance!
-
-### Aqara M2 Hub
-
-- Bridges Aqara (Zigbee) devices connected to the hub to Matter.
-- You need to enable Matter support/firmware in the Aqara app.
-- You will need an Aqara (cloud) account and the app before you can use Matter.
-- See [this Aqara landingpage](https://www.aqara.com/en/article-1583275073188196352.html) for more information, including what devices are bridged.
-- Device events, for example for the wall rockers and Cube, are not supported.
-
-### Eve Energy (power plug), Eve Door & Window (contact sensor), Eve Motion (motion sensor)
-
-- If you see a Matter logo on the box, the device runs Matter already and you can add it to HA immediately.
-- If there is a Thread logo, you need to install the Matter firmware using the Eve app.
-- No Matter logo and no Thread logo on the box? The device is not Matter compatible.
-- The energy metering feature of the Eve plug will not work in Home Assistant (Apple only feature).
-- Eve has just released official Matter support so ignore any documentation about the beta program.
-
-[Eve Energy on Amazon](https://amzn.to/3YuO62P)
-[Eve Door & Window on Amazon](https://amzn.to/3RIU6ml)
-[Eve Motion on Amazon](https://amzn.to/3jDujiP)
-
-### Nanoleaf (Essentials) Matter bulbs and Lightstrips
-
-- Although the products work great once commissioned, multiple users have reported that commissioning them can be a bit difficult and requires some patience and multiple resets or optimizations to your home network.
-- Check the [Nanoleaf Matter infopage](https://nanoleaf.me/en-EU/integration/matter/) for all supported products and instructions.
-
-### Philips Hue (V2) Bridge
-
-The Philips Hue V2 bridge supports Matter. You can enable Matter support in the Hue app. You can then commission it to Home Assistant and other fabrics.
-
-- Binding the Hue bridge to Home Assistant does not make sense because you will lose functionality over the default Hue integration in Home Assistant, such as button press events and (dynamic) scenes.
-- You will need a Hue/Signify (cloud) account and the app before you can use Matter.
-- Device events for example for dimmer remotes are not supported.
-- Only basic control of lights is supported, no scenes, events, effects etc.
-
-### SwitchBot Hub 2
-
-SwitchBot has released a (beta) firmware update to enable Matter support on their Hub 2. The SwitchBot Hub 2 is a Matter bridge device. It is bridging some of the devices, such as curtain motors, into Matter.
-
-- To use Matter, in the SwitchBot app, enable Matter bridge support. Then, copy the code and use that to commission the Hub to Home Assistant. Another option is to use a second device to scan the QR code.
-- Device support is limited. You bridge specific devices to Matter by adding them as **Secondary device** in the app. Note that not all SwitchBot devices can be bridged.
-- Enabling Matter support does not convert the actual SwitchBot devices into matter devices. Those still need to be within the Bluetooth range of the hub.
-- Bridged SwitchBot devices appear with a rather technical name in Home Assistant. This is a known issue.
-
-
-### Tasmota
-
-Tasmota supports Matter over IP on all ESP32 based devices (in experimental phase). Follow the [instructions](https://tasmota.github.io/docs/Matter/).
-
-### TP-Link Tapo P125M (power plug)
-
-- Look for the _M_ addition in the model name. A device without the M (regular P125) is not Matter compliant.
-- This device is available in the US only.
-
-[TP-Link Tapo P125M on Amazon](https://amzn.to/3RILJah)
-
## Troubleshooting
### General recommendations
diff --git a/source/_integrations/maxcube.markdown b/source/_integrations/maxcube.markdown
index 56fca751fcc..7628a1d6753 100644
--- a/source/_integrations/maxcube.markdown
+++ b/source/_integrations/maxcube.markdown
@@ -2,7 +2,7 @@
title: eQ-3 MAX!
description: Instructions on how to integrate eQ-3 MAX! components with Home Assistant via eQ-3 MAX! Cube.
ha_category:
- - Binary Sensor
+ - Binary sensor
- Climate
ha_release: '0.40'
ha_iot_class: Local Polling
@@ -17,7 +17,7 @@ ha_integration_type: integration
There is currently support for the following device types within Home Assistant:
-- Binary Sensor
+- Binary sensor
- Climate
Limitations:
@@ -32,7 +32,7 @@ Supported Devices:
- MAX! Window Sensor (tested)
- MAX! Wall Thermostat (tested)
-### One Gateway
+### One gateway
A `maxcube` section must be present in the `configuration.yaml` file and contain the following options as required:
@@ -43,7 +43,7 @@ maxcube:
- host: 192.168.0.20
```
-### Multiple Gateways
+### Multiple gateways
```yaml
# Example configuration.yaml entry
diff --git a/source/_integrations/medcom_ble.markdown b/source/_integrations/medcom_ble.markdown
index 4d40e870f9a..a5e98d69947 100644
--- a/source/_integrations/medcom_ble.markdown
+++ b/source/_integrations/medcom_ble.markdown
@@ -28,7 +28,7 @@ The Medcom Bluetooth integration will automatically discover devices once the [B
To limit the load on the Bluetooth radio on the Home Assistant side, the integration only polls for a reading every 5 minutes, which should be adequate for ongoing background monitoring. An Inspector BLE battery should last several months with continuous use before needing replacement.
-## Supported Devices
+## Supported devices
- Medcom Inspector BLE
diff --git a/source/_integrations/media_extractor.markdown b/source/_integrations/media_extractor.markdown
index 007abdd3326..9a0952f9f30 100644
--- a/source/_integrations/media_extractor.markdown
+++ b/source/_integrations/media_extractor.markdown
@@ -1,8 +1,8 @@
---
-title: Media Extractor
-description: Instructions on how to integrate the Media Extractor into Home Assistant.
+title: Media extractor
+description: Instructions on how to integrate the Media extractor into Home Assistant.
ha_category:
- - Media Player
+ - Media player
ha_iot_class: Calculated
ha_release: 0.49
ha_quality_scale: internal
diff --git a/source/_integrations/media_player.markdown b/source/_integrations/media_player.markdown
index 26eae82ea90..937ab1f023e 100644
--- a/source/_integrations/media_player.markdown
+++ b/source/_integrations/media_player.markdown
@@ -1,8 +1,8 @@
---
-title: Media Player
+title: Media player
description: Instructions on how to setup your media players with Home Assistant.
ha_category:
- - Media Player
+ - Media player
ha_release: 0.7
ha_quality_scale: internal
ha_domain: media_player
@@ -178,7 +178,7 @@ Allows to group media players together for synchronous playback. Only works on s
| ---------------------- | -------- | ---------------------------------------------------- |
| `entity_id` | yes | Unjoin this media player from any player groups. |
-### Device Class
+### Device class
The way media players are displayed in the frontend can be modified in the [customize section](/getting-started/customizing-devices/). The following device classes are supported for media players:
diff --git a/source/_integrations/media_source.markdown b/source/_integrations/media_source.markdown
index b12f6ef72b2..5da8c87175d 100644
--- a/source/_integrations/media_source.markdown
+++ b/source/_integrations/media_source.markdown
@@ -1,8 +1,8 @@
---
-title: Media Source
+title: Media source
description: Instructions on how to access your media with Home Assistant.
ha_category:
- - Media Source
+ - Media source
ha_release: 0.115
ha_domain: media_source
ha_codeowners:
@@ -11,7 +11,7 @@ ha_quality_scale: internal
ha_integration_type: system
---
-The Media Source integration platform allows integrations to expose media for
+The Media source integration platform allows integrations to expose media for
use inside Home Assistant through the Media Browser panel or through supported
media players like Google Cast.
@@ -28,7 +28,7 @@ to your configuration file:
media_source:
```
-## Local Media
+## Local media
By default, the integration looks for media in a specified folder.
If other `media_dirs` are not declared you need to use `/media/local` path for
@@ -70,7 +70,7 @@ homeassistant:
-## Playing media from a Media Source
+## Playing media from a media source
To play media from a media source via a service call, use the uri
scheme `media-source://media_source//`.
@@ -78,7 +78,7 @@ Default `media_dir` is `local`.
Web browsers and Google Cast media players have very limited video container
-and codec support. The Media Source integration does not do any transcoding of
+and codec support. The media source integration does not do any transcoding of
media, meaning media files must be natively supported by your media player or
web browser (for playing in the frontend).
diff --git a/source/_integrations/mediaroom.markdown b/source/_integrations/mediaroom.markdown
index f3505828a41..eb619086176 100644
--- a/source/_integrations/mediaroom.markdown
+++ b/source/_integrations/mediaroom.markdown
@@ -2,7 +2,7 @@
title: Mediaroom
description: Instructions on how to integrate Mediaroom Set-Top Boxes into Home Assistant.
ha_category:
- - Media Player
+ - Media player
ha_iot_class: Local Polling
ha_release: 0.63
ha_codeowners:
diff --git a/source/_integrations/meraki.markdown b/source/_integrations/meraki.markdown
index 26f5224d80e..33c82c4891e 100644
--- a/source/_integrations/meraki.markdown
+++ b/source/_integrations/meraki.markdown
@@ -2,7 +2,7 @@
title: Meraki
description: Instructions on how to integrate Meraki-based presence detection into Home Assistant.
ha_category:
- - Presence Detection
+ - Presence detection
ha_iot_class: Cloud Polling
ha_release: '0.60'
ha_domain: meraki
diff --git a/source/_integrations/met_eireann.markdown b/source/_integrations/met_eireann.markdown
index 98e99a69cc8..fe28adcb9ae 100644
--- a/source/_integrations/met_eireann.markdown
+++ b/source/_integrations/met_eireann.markdown
@@ -24,10 +24,10 @@ The Met Éireann API will only provide data for Ireland, the UK and a small part
{% include integrations/config_flow.md %}
-## Data License
+## Data license
The data provided by Met Éireann is licensed under the Met Éireann Open Data Custom License (similar to a Creative Commons CC BY 4.0 license). A license summary and the full license are available [here](https://data.gov.ie/dataset/met-eireann-weather-forecast-api/resource/027da6d5-d819-48d1-9b16-331dba169bd1). In short, if you distribute, broadcast or make Met Éireann data available on the public internet you must give credit to Met Éireann and display their weather warnings.
-## Data Changes
+## Data changes
The only changes made to the data gathered from the API are the condition descriptions which are mapped to the weather conditions supported by Home Assistant.
diff --git a/source/_integrations/meteoalarm.markdown b/source/_integrations/meteoalarm.markdown
index f333dea30f9..d2fd72d55f7 100644
--- a/source/_integrations/meteoalarm.markdown
+++ b/source/_integrations/meteoalarm.markdown
@@ -2,7 +2,7 @@
title: MeteoAlarm
description: Instructions on how to set up MeteoAlarm binary sensors within Home Assistant.
ha_category:
- - Binary Sensor
+ - Binary sensor
ha_release: 0.93
ha_iot_class: Cloud Polling
ha_codeowners:
diff --git a/source/_integrations/microsoft_face.markdown b/source/_integrations/microsoft_face.markdown
index 95d9412e8e0..b2bd4ea5ef2 100644
--- a/source/_integrations/microsoft_face.markdown
+++ b/source/_integrations/microsoft_face.markdown
@@ -2,7 +2,7 @@
title: Microsoft Face
description: Instructions on how to integrate Microsoft Face integration into Home Assistant.
ha_category:
- - Image Processing
+ - Image processing
ha_iot_class: Cloud Push
ha_release: 0.37
ha_domain: microsoft_face
diff --git a/source/_integrations/microsoft_face_detect.markdown b/source/_integrations/microsoft_face_detect.markdown
index 04fa1ef6675..0e2132c1fbe 100644
--- a/source/_integrations/microsoft_face_detect.markdown
+++ b/source/_integrations/microsoft_face_detect.markdown
@@ -2,7 +2,7 @@
title: Microsoft Face Detect
description: Instructions on how to integrate Microsoft Face Detect into Home Assistant.
ha_category:
- - Image Processing
+ - Image processing
ha_iot_class: Cloud Push
ha_release: 0.38
ha_domain: microsoft_face_detect
diff --git a/source/_integrations/microsoft_face_identify.markdown b/source/_integrations/microsoft_face_identify.markdown
index 66646455ca3..12fe03f3e0d 100644
--- a/source/_integrations/microsoft_face_identify.markdown
+++ b/source/_integrations/microsoft_face_identify.markdown
@@ -2,7 +2,7 @@
title: Microsoft Face Identify
description: Instructions on how to integrate Microsoft Face Identify into Home Assistant.
ha_category:
- - Image Processing
+ - Image processing
ha_iot_class: Cloud Push
ha_release: 0.37
ha_domain: microsoft_face_identify
diff --git a/source/_integrations/mikrotik.markdown b/source/_integrations/mikrotik.markdown
index a8ada83e5f2..d19daebe337 100644
--- a/source/_integrations/mikrotik.markdown
+++ b/source/_integrations/mikrotik.markdown
@@ -3,7 +3,7 @@ title: Mikrotik
description: Instructions on how to integrate MikroTik/RouterOS based devices into Home Assistant.
ha_category:
- Hub
- - Presence Detection
+ - Presence detection
ha_release: 0.44
ha_codeowners:
- '@engrbm87'
@@ -19,7 +19,7 @@ The `mikrotik` platform offers presence detection by looking at connected device
There is currently support for the following device types within Home Assistant:
-- Presence Detection
+- Presence detection
## Prerequisites
diff --git a/source/_integrations/min_max.markdown b/source/_integrations/min_max.markdown
index 2bc92e4fd29..01fbed157ca 100644
--- a/source/_integrations/min_max.markdown
+++ b/source/_integrations/min_max.markdown
@@ -35,7 +35,7 @@ Precision:
description: Round the calculated mean, median or sum value to at most N decimal places.
{% endconfiguration_basic %}
-## YAML Configuration
+## YAML configuration
Alternatively, this integration can be configured and set up manually via YAML
instead. To enable the Integration sensor in your installation, add the
diff --git a/source/_integrations/minecraft_server.markdown b/source/_integrations/minecraft_server.markdown
index 9963d0f2a45..26299e28b12 100644
--- a/source/_integrations/minecraft_server.markdown
+++ b/source/_integrations/minecraft_server.markdown
@@ -3,7 +3,7 @@ title: Minecraft Server
description: Instructions on how to integrate a Minecraft server into Home Assistant.
ha_release: 0.106
ha_category:
- - Binary Sensor
+ - Binary sensor
- Sensor
ha_iot_class: Local Polling
ha_quality_scale: gold
diff --git a/source/_integrations/minio.markdown b/source/_integrations/minio.markdown
index 1ffd46f0725..7ac507c7580 100644
--- a/source/_integrations/minio.markdown
+++ b/source/_integrations/minio.markdown
@@ -121,7 +121,7 @@ automation:
{% endraw %}
-## Platform Services
+## Platform services
These services are provided:
diff --git a/source/_integrations/modern_forms.markdown b/source/_integrations/modern_forms.markdown
index 37c1c0ccdd6..162d4080aa0 100644
--- a/source/_integrations/modern_forms.markdown
+++ b/source/_integrations/modern_forms.markdown
@@ -2,7 +2,7 @@
title: Modern Forms
description: Instructions on how to integrate a Modern Forms Smart Fan with Home Assistant.
ha_category:
- - Binary Sensor
+ - Binary sensor
- Fan
- Light
- Sensor
diff --git a/source/_integrations/monessen.markdown b/source/_integrations/monessen.markdown
index 943c3424635..743ee2af5c7 100644
--- a/source/_integrations/monessen.markdown
+++ b/source/_integrations/monessen.markdown
@@ -2,7 +2,7 @@
title: Monessen
description: Connect and control your Monessen devices using the IntelliFire integration
ha_category:
- - Binary Sensor
+ - Binary sensor
- Climate
- Fan
- Light
diff --git a/source/_integrations/monoprice.markdown b/source/_integrations/monoprice.markdown
index 702cbbf19c4..6567f0ba2e9 100644
--- a/source/_integrations/monoprice.markdown
+++ b/source/_integrations/monoprice.markdown
@@ -2,7 +2,7 @@
title: Monoprice 6-Zone Amplifier
description: Instructions on how to integrate Monoprice 6-Zone Home Audio Controller into Home Assistant.
ha_category:
- - Media Player
+ - Media player
ha_release: 0.56
ha_config_flow: true
ha_iot_class: Local Polling
@@ -26,7 +26,7 @@ If you are using an IP232 module instead of a direct serial connection, then use
Sources can also be later edited from the integration options (gear icon in the top right when selecting the integration). Note that editing sources will remove the snapshot you may have saved.
-## Zone Management
+## Zone management
Devices and entities are created for each of the possible 18 zones, and can be enabled, disabled and renamed through regular Home Assistant methods.
By default, the first 6 zones (11..16) are enabled, and there's an attempt to automatically detect the 12 extension zones (21..26, and 31..36) on the first run.
diff --git a/source/_integrations/motion_blinds.markdown b/source/_integrations/motion_blinds.markdown
index 446ebab98ef..f848ec71cf6 100644
--- a/source/_integrations/motion_blinds.markdown
+++ b/source/_integrations/motion_blinds.markdown
@@ -32,6 +32,7 @@ Additionally the following brands have been reported to also work with this inte
- [Hurrican Shutters Wholesale](https://www.hurricaneshutterswholesale.com/)
- [Inspired Shades](https://www.inspired-shades.com/)
- [iSmartWindow](https://www.ismartwindow.co.nz/)
+- [Madeco](https://www.madeco.fr/)
- [Martec](https://www.martec.co.nz/)
- [Motion Blinds](https://motionblinds.com/)
- [Raven Rock MFG](https://www.ravenrockmfg.com/)
@@ -57,7 +58,7 @@ The following bridges are reported to work with this integration:
The 16 character API key needed to setup the Home Assistant integration needs to be retrieved by first connecting the blind/bridge to the official app of its respective brand.
In that app the key can often be found by clicking multiple times on specific places on the "About" page.
-### Motion Blinds app
+### Motion blinds app
The Motion Blinds API uses a 16 character key that can be retrieved from the official "Motion Blinds" app for [IOS](https://apps.apple.com/us/app/motion-blinds/id1437234324) or [Android](https://play.google.com/store/apps/details?id=com.coulisse.motion).
diff --git a/source/_integrations/motioneye.markdown b/source/_integrations/motioneye.markdown
index 777817d6d05..52a32384196 100644
--- a/source/_integrations/motioneye.markdown
+++ b/source/_integrations/motioneye.markdown
@@ -3,7 +3,7 @@ title: motionEye
description: Instructions on how to integrate motionEye into Home Assistant.
ha_category:
- Camera
- - Media Source
+ - Media source
ha_release: 2021.5
ha_iot_class: Local Polling
ha_domain: motioneye
diff --git a/source/_integrations/mpd.markdown b/source/_integrations/mpd.markdown
index 4c08d421c14..ae2caa11e23 100644
--- a/source/_integrations/mpd.markdown
+++ b/source/_integrations/mpd.markdown
@@ -2,7 +2,7 @@
title: Music Player Daemon (MPD)
description: Instructions on how to integrate Music Player Daemon into Home Assistant.
ha_category:
- - Media Player
+ - Media player
ha_release: pre 0.7
ha_iot_class: Local Polling
ha_domain: mpd
diff --git a/source/_integrations/mqtt.markdown b/source/_integrations/mqtt.markdown
index 58b488c966e..c1bee54563e 100644
--- a/source/_integrations/mqtt.markdown
+++ b/source/_integrations/mqtt.markdown
@@ -220,14 +220,14 @@ The discovery of MQTT devices will enable one to use MQTT devices with only mini
- [Button](/integrations/button.mqtt/)
- [Camera](/integrations/camera.mqtt/)
- [Cover](/integrations/cover.mqtt/)
-- [Device Tracker](/integrations/device_tracker.mqtt/)
-- [Device Trigger](/integrations/device_trigger.mqtt/)
+- [Device tracker](/integrations/device_tracker.mqtt/)
+- [Device trigger](/integrations/device_trigger.mqtt/)
- [Event](/integrations/event.mqtt/)
- [Fan](/integrations/fan.mqtt/)
- [Humidifier](/integrations/humidifier.mqtt/)
- [Image](/integrations/image.mqtt/)
- [Climate/HVAC](/integrations/climate.mqtt/)
-- [Lawn Mower](/integrations/lawn_mower.mqtt/)
+- [Lawn mower](/integrations/lawn_mower.mqtt/)
- [Light](/integrations/light.mqtt/)
- [Lock](/integrations/lock.mqtt/)
- [Number](/integrations/number.mqtt/)
@@ -237,10 +237,10 @@ The discovery of MQTT devices will enable one to use MQTT devices with only mini
- [Siren](/integrations/siren.mqtt/)
- [Switch](/integrations/switch.mqtt/)
- [Update](/integrations/update.mqtt/)
-- [Tag Scanner](/integrations/tag.mqtt/)
+- [Tag scanner](/integrations/tag.mqtt/)
- [Text](/integrations/text.mqtt/)
- [Vacuum](/integrations/vacuum.mqtt/)
-- [Water Heater](/integrations/water_heater.mqtt/)
+- [Water heater](/integrations/water_heater.mqtt/)
{% enddetails %}
@@ -578,6 +578,102 @@ support_url:
```
{% enddetails %}
+### How to use discovery messages
+
+When MQTT discovery is set up, and a device or service sends a discovery message,
+an MQTT entity, tag, or device automation will be set up directly after receiving the message.
+When Home Assistant is restarting, discovered MQTT items with a unique ID will be unavailable until a new
+discovery message is received. MQTT items without a unique ID will not be added at startup.
+So a device or service using MQTT discovery must make sure a configuration message is offered
+after the **MQTT** integration has been (re)started. There are 2 common approaches to make sure the
+discovered items are set up at startup:
+
+1. Using Birth and Will messages to trigger setup
+2. Using retained messages
+
+Finally, it is a best practice to publish your device or service availability status.
+
+#### Use the Birth and Will messages to trigger discovery
+
+When the **MQTT** integration starts, a birth message is published at `homeassistant/status` by default.
+A device or service connected to the shared `mqtt` broker can subscribe to this topic and use an `online` message
+to trigger discovery messages. See also the [birth and last will messages](/integrations/mqtt/#birth-and-last-will-messages)
+section. After the configs have been published, the state topics will need an update, so they need to be republished.
+
+#### Using retained config messages
+
+An alternative method for a device or service is to publish discovery messages with a `retain` flag. This will make sure
+discovery messages are replayed when the **MQTT** integration connects to the broker.
+After the configs have been published, the state topics will need an update.
+
+#### Using retained state messages
+
+State updates also need to be re-published after a config as been processed.
+This can also be done by publishing `retained` messages. As soon as a config is received (or replayed from a retained message),
+the setup will subscribe any state topics. If a retained message is available at a state topic,
+ this message will be replayed so that the state can be restored for this topic.
+
+
+
+A disadvantage of using retained messages is that these messages retain at the broker,
+even when the device or service stops working. They are retained even after the system or broker has been restarted.
+Retained messages can create ghost entities that keep coming back.
+
+Especially when you have many entities, (unneeded) discovery messages can cause excessive system load. For this reason, use discovery messages with caution.
+
+
+
+### Using Availability topics
+
+A device or service can announce its availability by publishing a Birth message and set a Will message at the broker.
+When the device or service loses connection to the broker, the broker will publish the Will message.
+This allows the **MQTT** integration to make an entity unavailable.
+
+Platform specific availability settings are available for `mqtt` entity platforms only.
+
+{% details "Platform specific availability settings" %}
+
+{% configuration %}
+availability:
+ description: A list of MQTT topics subscribed to receive availability (online/offline) updates. Must not be used together with `availability_topic`.
+ required: false
+ type: list
+ keys:
+ payload_available:
+ description: The payload that represents the available state.
+ required: false
+ type: string
+ default: online
+ payload_not_available:
+ description: The payload that represents the unavailable state.
+ required: false
+ type: string
+ default: offline
+ topic:
+ description: An MQTT topic subscribed to receive availability (online/offline) updates.
+ required: true
+ type: string
+ value_template:
+ description: "Defines a [template](/docs/configuration/templating/#using-templates-with-the-mqtt-integration) to extract a device's availability from the `topic`. To determine the device's availability, the result of this template will be compared to `payload_available` and `payload_not_available`."
+ required: false
+ type: template
+availability_topic:
+ description: The MQTT topic subscribed to receive availability (online/offline) updates. Must not be used together with `availability`.
+ required: false
+ type: string
+availability_mode:
+ description: When `availability` is configured, this controls the conditions needed to set the entity to `available`. Valid entries are `all`, `any`, and `latest`. If set to `all`, `payload_available` must be received on all configured availability topics before the entity is marked as online. If set to `any`, `payload_available` must be received on at least one configured availability topic before the entity is marked as online. If set to `latest`, the last `payload_available` or `payload_not_available` received on any configured availability topic controls the availability.
+ required: false
+ type: string
+ default: latest
+availability_template:
+ description: "Defines a [template](/docs/configuration/templating/#using-templates-with-the-mqtt-integration) to extract device's availability from the `availability_topic`. To determine the devices's availability result of this template will be compared to `payload_available` and `payload_not_available`."
+ required: false
+ type: template
+{% endconfiguration %}
+
+{% enddetails %}
+
### Support by third-party tools
The following software has built-in support for MQTT discovery:
@@ -609,7 +705,6 @@ 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)
-- [Zwave2Mqtt](https://github.com/OpenZWave/Zwave2Mqtt) (starting with 2.0.1)
### Discovery examples
@@ -879,13 +974,13 @@ mqtt:
- [Button](/integrations/button.mqtt/)
- [Camera](/integrations/camera.mqtt/)
- [Cover](/integrations/cover.mqtt/)
-- [Device Tracker](/integrations/device_tracker.mqtt/)
+- [Device tracker](/integrations/device_tracker.mqtt/)
- [Event](/integrations/event.mqtt/)
- [Fan](/integrations/fan.mqtt/)
- [Humidifier](/integrations/humidifier.mqtt/)
- [Image](/integrations/image.mqtt/)
- [Climate/HVACs](/integrations/climate.mqtt/)
-- [Lawn Mower](/integrations/lawn_mower.mqtt/)
+- [Lawn mower](/integrations/lawn_mower.mqtt/)
- [Light](/integrations/light.mqtt/)
- [Lock](/integrations/lock.mqtt/)
- [Number](/integrations/number.mqtt/)
@@ -897,7 +992,7 @@ mqtt:
- [Text](/integrations/text.mqtt/)
- [Update](/integrations/update.mqtt/)
- [Vacuum](/integrations/vacuum.mqtt/)
-- [Water Heater](/integrations/water_heater.mqtt/)
+- [Water heater](/integrations/water_heater.mqtt/)
{% enddetails %}
@@ -1082,7 +1177,7 @@ Listen to the specified topic matcher and dumps all received messages within a s
| `duration` | yes | Duration in seconds that we will listen for messages. Default is 5 seconds. |
```yaml
-topic: openzwave/#
+topic: zigbee2mqtt/#
```
## Logging
diff --git a/source/_integrations/mqtt_eventstream.markdown b/source/_integrations/mqtt_eventstream.markdown
index 1e0a2f6c39c..15351a9fd6b 100644
--- a/source/_integrations/mqtt_eventstream.markdown
+++ b/source/_integrations/mqtt_eventstream.markdown
@@ -32,12 +32,12 @@ subscribe_topic:
required: false
type: string
ignore_event:
- description: List of [events](/docs/configuration/events/) which will not be sent over mqtt.
+ description: List of [events](/docs/configuration/events/) which will not be sent over MQTT.
required: false
type: list
{% endconfiguration %}
-## Multiple Instances
+## Multiple instances
Events from multiple instances can be aggregated to a single parent instance by subscribing to a wildcard topic from the parent instance.
diff --git a/source/_integrations/mqtt_json.markdown b/source/_integrations/mqtt_json.markdown
index 934a255e2f3..76d65a7e442 100644
--- a/source/_integrations/mqtt_json.markdown
+++ b/source/_integrations/mqtt_json.markdown
@@ -1,8 +1,8 @@
---
title: MQTT JSON
-description: Instructions on how to use JSON MQTT to track devices in Home Assistant.
+description: Instructions on how to use MQTT JSON to track devices in Home Assistant.
ha_category:
- - Presence Detection
+ - Presence detection
ha_iot_class: Local Push
ha_release: 0.44
ha_domain: mqtt_json
diff --git a/source/_integrations/mqtt_room.markdown b/source/_integrations/mqtt_room.markdown
index 7c215a48fc8..c55e6f23eb0 100644
--- a/source/_integrations/mqtt_room.markdown
+++ b/source/_integrations/mqtt_room.markdown
@@ -1,8 +1,8 @@
---
-title: MQTT Room Presence
+title: MQTT room presence
description: Instructions on how to track room presence within Home Assistant.
ha_category:
- - Presence Detection
+ - Presence detection
ha_release: 0.27
ha_iot_class: Local Push
ha_domain: mqtt_room
@@ -22,7 +22,7 @@ To use this device tracker in your installation, add the following to your `conf
sensor:
- platform: mqtt_room
device_id: 123testid
- state_topic: "espresense/rooms"
+ state_topic: "espresense/devices/123testid"
```
{% configuration %}
diff --git a/source/_integrations/mqtt_statestream.markdown b/source/_integrations/mqtt_statestream.markdown
index d44cc95321d..ab11c4e16f2 100644
--- a/source/_integrations/mqtt_statestream.markdown
+++ b/source/_integrations/mqtt_statestream.markdown
@@ -74,7 +74,7 @@ include:
type: list
{% endconfiguration %}
-### Configure Filter
+### Configure filter
By default, no entity will be excluded. To limit which entities are being exposed to `MQTT Statestream`, you can use the `include` and `exclude` parameters.
diff --git a/source/_integrations/msteams.markdown b/source/_integrations/msteams.markdown
index 83af0d261c5..db46b193c49 100644
--- a/source/_integrations/msteams.markdown
+++ b/source/_integrations/msteams.markdown
@@ -50,6 +50,8 @@ The following attributes can be placed inside `data` for extended functionality.
| ---------------------- | -------- | ----------- |
| `image_url` | yes | Attach an image to the message.
+The image must be an HTTPS URL, and as outlined by Microsoft in the [Documentation](https://learn.microsoft.com/en-us/microsoftteams/platform/task-modules-and-cards/cards/cards-reference#common-properties-for-all-cards), the picture must be on a publicly available location.
+
Example for posting file from URL:
```yaml
diff --git a/source/_integrations/mullvad.markdown b/source/_integrations/mullvad.markdown
index 2dd5d87830d..a4b41d42631 100644
--- a/source/_integrations/mullvad.markdown
+++ b/source/_integrations/mullvad.markdown
@@ -2,7 +2,7 @@
title: Mullvad VPN
description: Instructions on how to integrate Mullvad VPN api data into Home Assistant.
ha_category:
- - Binary Sensor
+ - Binary sensor
- Network
ha_iot_class: Cloud Polling
ha_release: 2021.3
diff --git a/source/_integrations/mutesync.markdown b/source/_integrations/mutesync.markdown
index 3f078380d91..9421b558bd1 100644
--- a/source/_integrations/mutesync.markdown
+++ b/source/_integrations/mutesync.markdown
@@ -2,7 +2,7 @@
title: mutesync
description: Instructions on how to integrate Mutesync button with Home Assistant.
ha_category:
- - Presence Detection
+ - Presence detection
ha_release: 2021.5
ha_iot_class: Local Polling
ha_config_flow: true
diff --git a/source/_integrations/mysensors.markdown b/source/_integrations/mysensors.markdown
index 4b570f6f400..b1c36cbe4ab 100644
--- a/source/_integrations/mysensors.markdown
+++ b/source/_integrations/mysensors.markdown
@@ -185,7 +185,7 @@ Visit the [library API][MySensors library api] of MySensors for more information
[MySensors library API]: https://www.mysensors.org/download
-## Binary Sensor
+## Binary sensor
The following binary sensor types are supported:
@@ -207,7 +207,7 @@ The following binary sensor types are supported:
| S_VIBRATION | V_TRIPPED |
| S_MOISTURE | V_TRIPPED |
-### Binary Sensor example sketch
+### Binary sensor example sketch
```cpp
/**
@@ -604,7 +604,7 @@ This sketch is ideally for star topology wiring. You can run up to 12 covers wit
[Check out the code on GitHub.](https://github.com/gryzli133/RollerShutterSplit)
-## Device Tracker
+## Device tracker
The following sensor types are supported:
@@ -614,7 +614,7 @@ The following sensor types are supported:
| ------ | ---------- |
| S_GPS | V_POSITION |
-### Device Tracker example sketch for MySensors 2.x
+### Device tracker example sketch for MySensors 2.x
```cpp
/**
diff --git a/source/_integrations/mystrom.markdown b/source/_integrations/mystrom.markdown
index 62e8dc2e903..47a18f9533a 100644
--- a/source/_integrations/mystrom.markdown
+++ b/source/_integrations/mystrom.markdown
@@ -2,7 +2,7 @@
title: myStrom
description: Instructions on how to integrate myStrom WiFi Switches and Bulbs into Home Assistant.
ha_category:
- - Binary Sensor
+ - Binary sensor
- Light
- Switch
ha_release: 0.43
@@ -22,8 +22,7 @@ ha_integration_type: integration
There is currently support for the following device types within Home Assistant:
- [Lights and switches](#lights-and-switches)
-- [Binary Sensor](#binary-sensor)
- - [Setup of myStrom Buttons](#setup-of-mystrom-buttons)
+- [Binary sensor](#binary-sensor)
## Lights and switches
@@ -66,7 +65,7 @@ $ curl http://[IP_ADDRESS]/api/v1/device/[MAC_ADDRESS]
}
```
-## Binary Sensor
+## Binary sensor
The `mystrom` binary sensor platform allows you to use [myStrom Wifi Buttons](https://mystrom.ch/wifi-button/) with Home Assistant. The myStrom Wifi Buttons support three and the myStrom WiFi Button + four different push pattern:
@@ -93,54 +92,3 @@ binary_sensor:
The firmware version 2.56 doesn't support TLS/SSL. This means that you are only able to use the WiFi Buttons if you are using plain-text communication between Home Assistant and the clients/entities.
-
-### Setup of myStrom Buttons
-
-You need to configure every button to make it work with Home Assistant. First connect the Wifi Buttons to your wireless network. Once a button is connected you have three minutes to set the actions for the push patterns if the button is not charging. The fastest way is to use `curl`. Check the [documentation](https://mystrom.ch/wp-content/uploads/REST_API_WBP.txt) of the WiFi Button for further details about the implementation (`http://` is replaced by `get://` or `post://`). `action` is the name of the corresponding push pattern (see above).
-
-The endpoint that is receiving the data is `http://[IP address Home Assistant]:8123/api/mystrom`. If you have set an [`api_password`](/integrations/http/) then this needs to be included in the URL.
-
-With `api_password:`
-
-```bash
-curl -d "[action]=get://[IP address Home Assistant]:8123/api/mystrom?api_password%3D[api_password]%26[action]%3D[ID of the button]" \
- http://[IP address of the button]/api/v1/device/[MAC address of the button]
-```
-
-Without `api_password`:
-
-```bash
-$ curl -d "[action]=get://[IP address Home Assistant]:8123/api/mystrom?[action]%3D[ID of the button]" \
- http://[IP address of the button]/api/v1/device/[MAC address of the button]
-{
- "[MAC address of the button]": {
- "type": "button",
- "battery": true,
- "reachable": true,
- "meshroot": false,
- "charge": true,
- "voltage": 4.292,
- "fw_version": "2.56",
- "single": "get://[IP address Home Assistant]:8123/api/mystrom?single=[id of the button]",
- "double": "",
- "long": "",
- "touch": ""
- }
-}
-```
-
-A complete command to set the URL for a double click could look like the example below:
-
-```bash
-curl -d "double=get://192.168.1.3:8123/api/mystrom?double%3DButton1" http://192.168.1.12/api/v1/device/4D5F5D5CD553
-```
-
-With an `api_password`:
-
-```bash
-curl -d "double=get://192.168.1.3:8123/api/mystrom?api_password%3Dapi_password%26double%3DButton1" http://192.168.1.12/api/v1/device/4D5F5D5CD553
-```
-
-The command-line tool [`mystrom`](https://github.com/fabaff/python-mystrom) is a helper to configure myStrom buttons.
-
-If you have set [`login_attempts_threshold`](/integrations/http/) and forget to include the `api_password` for an action and that action is triggered then after the threshold is reached will the button no longer work because it is banned. See [IP filtering and banning](/integrations/http/#ip-filtering-and-banning) about how to revert the banning.
diff --git a/source/_integrations/nad.markdown b/source/_integrations/nad.markdown
index 0873b8ecc48..cb8e68f5935 100644
--- a/source/_integrations/nad.markdown
+++ b/source/_integrations/nad.markdown
@@ -2,7 +2,7 @@
title: NAD
description: Instructions on how to integrate NAD receivers into Home Assistant.
ha_category:
- - Media Player
+ - Media player
ha_release: 0.36
ha_iot_class: Local Polling
ha_domain: nad
diff --git a/source/_integrations/neato.markdown b/source/_integrations/neato.markdown
index 1bbd0860d1b..1332da1336c 100644
--- a/source/_integrations/neato.markdown
+++ b/source/_integrations/neato.markdown
@@ -100,7 +100,7 @@ And a specific Platform Service:
- `neato.custom_cleaning`
-### Platform Services
+### Platform services
#### Service `neato.custom_cleaning`
diff --git a/source/_integrations/ness_alarm.markdown b/source/_integrations/ness_alarm.markdown
index ddd35b8dd6a..2f2845432eb 100644
--- a/source/_integrations/ness_alarm.markdown
+++ b/source/_integrations/ness_alarm.markdown
@@ -3,7 +3,7 @@ title: Ness Alarm
description: Instructions on how to integrate a Ness D8x/D16x alarm system with Home Assistant.
ha_category:
- Alarm
- - Binary Sensor
+ - Binary sensor
ha_release: 0.85
ha_iot_class: Local Push
ha_codeowners:
@@ -19,8 +19,8 @@ The `ness_alarm` integration will allow Home Assistant users who own a Ness D8x/
There is currently support for the following device types within Home Assistant:
-- Binary Sensor: Reports on zone statuses
-- Alarm Control Panel: Reports on alarm status, and can be used to arm/disarm the system
+- Binary sensor: Reports on zone statuses
+- Alarm control panel: Reports on alarm status, and can be used to arm/disarm the system
The module communicates via the [Ness D8x/D16x ASCII protocol](https://ia802202.us.archive.org/16/items/ness-d-8x-d-16x-serial-interface.-ascii-protocol/Ness%20D8x%20D16x%20Serial%20Interface.%20ASCII%20Protocol.pdf).
diff --git a/source/_integrations/nest.markdown b/source/_integrations/nest.markdown
index e2ce891c18b..f50b7417eec 100644
--- a/source/_integrations/nest.markdown
+++ b/source/_integrations/nest.markdown
@@ -6,7 +6,7 @@ ha_category:
- Climate
- Doorbell
- Hub
- - Media Source
+ - Media source
- Sensor
ha_iot_class: Cloud Push
ha_release: 0.7
@@ -32,7 +32,7 @@ There is currently support for the following device types within Home Assistant:
- [Sensor](#sensor)
- [Camera](#camera)
-Cameras and Doorbells use [Automation and Device Triggers](#automation-and-device-triggers) for events and a [Media Source](#media-source) for capturing media images on supported devices. Other device types like Smoke and CO Alarms or Security systems are not currently supported by the SDM API.
+Cameras and doorbells use [Automation and device triggers](#automation-and-device-triggers) for events and a [media source](#media-source) for capturing media images on supported devices. Other device types like Smoke and CO Alarms or Security systems are not currently supported by the SDM API.
You are in control of the information and capabilities exposed to Home Assistant. You can authorize a single device, multiple devices, or different levels of functionality such as motion events, live streams, for any particular device. The integration is flexible enough to adapt based on what you allow.
@@ -283,7 +283,7 @@ All cameras have motion and person triggers, however only some support capturing
Given a camera named `Front Yard` then the camera is created with a name such as `camera.front_yard`.
-## Automation and Device Triggers
+## Automation and device triggers
The Nest integration provides [device triggers](/docs/automation/trigger/#device-triggers) to enable automation in Home Assistant. You should review the [Automating Home Assistant](/getting-started/automation/) getting started guide on automations or the [Automation](/docs/automation/) documentation for full details.
@@ -356,9 +356,9 @@ If you are still not getting notifications, you can read this [troubleshooting g
{% enddetails %}
-## Media Source
+## Media source
-The Nest [Media Source](/integrations/media_source) platform allows you to browse clips for recent camera events. Home Assistant is not intended to be a Network Video Recorder (NVR) platform, however, basic support for capturing recent events is supported.
+The Nest [media source](/integrations/media_source) platform allows you to browse clips for recent camera events. Home Assistant is not intended to be a Network Video Recorder (NVR) platform, however, basic support for capturing recent events is supported.
The table above describes which devices support event image snapshots or 10-frame mp4 video clips for recent events.
diff --git a/source/_integrations/netatmo.markdown b/source/_integrations/netatmo.markdown
index 170778df247..b381f2b1264 100644
--- a/source/_integrations/netatmo.markdown
+++ b/source/_integrations/netatmo.markdown
@@ -8,7 +8,7 @@ ha_category:
- Environment
- Hub
- Light
- - Media Source
+ - Media source
- Sensor
- Switch
- Weather
diff --git a/source/_integrations/netdata.markdown b/source/_integrations/netdata.markdown
index 0c79ff959ab..02fc40b2d6d 100644
--- a/source/_integrations/netdata.markdown
+++ b/source/_integrations/netdata.markdown
@@ -2,7 +2,7 @@
title: Netdata
description: Instructions on how to integrate Netdata within Home Assistant.
ha_category:
- - System Monitor
+ - System monitor
ha_release: 0.35
ha_iot_class: Local Polling
ha_codeowners:
@@ -131,7 +131,7 @@ resources:
default: false
{% endconfiguration %}
-### Full Example
+### Full example
```yaml
# Example configuration.yaml entry
diff --git a/source/_integrations/netgear.markdown b/source/_integrations/netgear.markdown
index 57a8fb44675..d494f47f273 100644
--- a/source/_integrations/netgear.markdown
+++ b/source/_integrations/netgear.markdown
@@ -2,7 +2,7 @@
title: NETGEAR
description: Instructions on how to integrate NETGEAR routers into Home Assistant.
ha_category:
- - Presence Detection
+ - Presence detection
- Update
ha_iot_class: Local Polling
ha_release: pre 0.7
diff --git a/source/_integrations/netgear_lte.markdown b/source/_integrations/netgear_lte.markdown
index c09241104f0..4d59675795f 100644
--- a/source/_integrations/netgear_lte.markdown
+++ b/source/_integrations/netgear_lte.markdown
@@ -3,7 +3,7 @@ title: NETGEAR LTE
description: Instructions on how to integrate your NETGEAR LTE modem within Home Assistant.
ha_release: 0.72
ha_category:
- - Binary Sensor
+ - Binary sensor
- Network
- Notifications
- Sensor
@@ -24,7 +24,7 @@ There is currently support for the following device types within Home Assistant:
- Notifications
- Sensors
-- Binary Sensors
+- Binary sensors
The integration supports sending notifications with SMS, reporting incoming SMS with events and reporting the modem and connection state in a number of sensors and binary sensors.
diff --git a/source/_integrations/nexia.markdown b/source/_integrations/nexia.markdown
index 4457a65e9cc..fe26f6a4bf6 100644
--- a/source/_integrations/nexia.markdown
+++ b/source/_integrations/nexia.markdown
@@ -2,7 +2,7 @@
title: Nexia/American Standard/Trane
description: Instructions on how to integrate Trane and American Standard thermostats into Home Assistant.
ha_category:
- - Binary Sensor
+ - Binary sensor
- Climate
- Scene
- Sensor
@@ -29,7 +29,7 @@ The `nexia` integration allows you to integrate your [Nexia](https://mynexia.com
There is currently support for the following device types within Home Assistant:
-- [Binary Sensor](#binary-sensor)
+- [Binary sensor](#binary-sensor)
- [Climate](#climate)
- [Sensor](#sensor)
- [Scene](#scene)
@@ -37,7 +37,7 @@ There is currently support for the following device types within Home Assistant:
{% include integrations/config_flow.md %}
-### Binary Sensor
+### Binary sensor
The following binary sensors are added for each thermostat:
diff --git a/source/_integrations/nexity.markdown b/source/_integrations/nexity.markdown
index 411bb153502..12259170936 100644
--- a/source/_integrations/nexity.markdown
+++ b/source/_integrations/nexity.markdown
@@ -3,7 +3,7 @@ title: Nexity Eugénie
description: Connect and control your Nexity Eugénie devices using the Overkiz integration
ha_category:
- Alarm
- - Binary Sensor
+ - Binary sensor
- Button
- Climate
- Cover
@@ -16,7 +16,7 @@ ha_category:
- Sensor
- Siren
- Switch
- - Water Heater
+ - Water heater
ha_domain: nexity
ha_integration_type: virtual
ha_supporting_domain: overkiz
diff --git a/source/_integrations/nextcloud.markdown b/source/_integrations/nextcloud.markdown
index 9589b82a639..67c30e4f5fe 100644
--- a/source/_integrations/nextcloud.markdown
+++ b/source/_integrations/nextcloud.markdown
@@ -2,7 +2,7 @@
title: Nextcloud
description: Instructions on how to integrate Nextcloud monitor api data into Home Assistant.
ha_category:
- - Binary Sensor
+ - Binary sensor
- Sensor
ha_iot_class: Cloud Polling
ha_release: 0.108
diff --git a/source/_integrations/nfandroidtv.markdown b/source/_integrations/nfandroidtv.markdown
index 77aeb16eafe..9cdc365c46a 100644
--- a/source/_integrations/nfandroidtv.markdown
+++ b/source/_integrations/nfandroidtv.markdown
@@ -43,7 +43,7 @@ position:
type: string
color:
description: "Has to be one of: `grey`, `black`, `indigo`, `green`, `red`, `cyan`, `teal`, `amber` or `pink`."
- default: grey
+ default: "`grey`"
type: string
transparency:
description: "Has to be one of: `0%`, `25%`, `50%`, `75%` or `100%`."
diff --git a/source/_integrations/nibe_heatpump.markdown b/source/_integrations/nibe_heatpump.markdown
index 3144a7b7ea9..e9a814c6b35 100644
--- a/source/_integrations/nibe_heatpump.markdown
+++ b/source/_integrations/nibe_heatpump.markdown
@@ -93,7 +93,7 @@ Home Assistant support connecting to Nibe heat pumps over Modbus over either TCP
#### TCP/IP
-The newer S-series pump exposes a built-in TCP Modbus server that can be used to communicate with the pump. To enable support for this integration, the pump must be connected to your local network and network (5.2 - Network settings) and Modbus (7.5.9 - Modbus TCP/IP) must be enabled. More details on the Modbus support in the pump can be found in Nibe document [M12676EN](https://partner.nibe.eu/nibedocuments/29795/M12676EN.pdf).
+The newer S-series pump exposes a built-in TCP Modbus server that can be used to communicate with the pump. To enable support for this integration, the pump must be connected to your local network and network (5.2 - Network settings) and Modbus (7.5.9 - Modbus TCP/IP) must be enabled. More details on the Modbus support in the pump can be found in Nibe document [M12676EN](https://assetstore.nibe.se/hcms/v2.4/entity/document/34499/storage/MDM0NDk5LzAvbWFzdGVy).
- `tcp://[IP OR HOSTNAME]`
- `tcp://[IP OR HOSTNAME]:502`
diff --git a/source/_integrations/nightscout.markdown b/source/_integrations/nightscout.markdown
index 93a942f0042..676473b9b9d 100644
--- a/source/_integrations/nightscout.markdown
+++ b/source/_integrations/nightscout.markdown
@@ -28,7 +28,7 @@ If you have a sensor session running, and you have enabled the Nightscout integr
The icon changes to indicate the direction or trend, of the glucose readings.
The state is the last reading from Nightscout, and you can see other information about the reading in the sensor's attributes.
-### Example Automation
+### Example automation
```yaml
- id: "1234567890123"
diff --git a/source/_integrations/nina.markdown b/source/_integrations/nina.markdown
index a027c4ed896..c2664f49113 100644
--- a/source/_integrations/nina.markdown
+++ b/source/_integrations/nina.markdown
@@ -2,7 +2,7 @@
title: NINA
description: Instructions on how to set up NINA warnings in Home Assistant.
ha_category:
- - Binary Sensor
+ - Binary sensor
ha_release: 2022.2
ha_iot_class: Cloud Polling
ha_config_flow: true
diff --git a/source/_integrations/nmap_tracker.markdown b/source/_integrations/nmap_tracker.markdown
index 4f85693756d..6e39547ea46 100644
--- a/source/_integrations/nmap_tracker.markdown
+++ b/source/_integrations/nmap_tracker.markdown
@@ -2,7 +2,7 @@
title: Nmap Tracker
description: Instructions on how to integrate Nmap into Home Assistant.
ha_category:
- - Presence Detection
+ - Presence detection
ha_release: 0.7
ha_iot_class: Local Polling
ha_domain: nmap_tracker
diff --git a/source/_integrations/notion.markdown b/source/_integrations/notion.markdown
index 7b6181a7a7b..3d8d584dc47 100644
--- a/source/_integrations/notion.markdown
+++ b/source/_integrations/notion.markdown
@@ -2,7 +2,7 @@
title: Notion
description: How to integrate Notion kits within Home Assistant.
ha_category:
- - Binary Sensor
+ - Binary sensor
- Hub
- Sensor
ha_release: 0.96
diff --git a/source/_integrations/numato.markdown b/source/_integrations/numato.markdown
index 5613fc79edc..d69384cf8da 100644
--- a/source/_integrations/numato.markdown
+++ b/source/_integrations/numato.markdown
@@ -2,7 +2,7 @@
title: Numato USB GPIO Expander
description: Instructions on how to integrate a Numato GPIO expander into Home Assistant.
ha_category:
- - Binary Sensor
+ - Binary sensor
- DIY
- Sensor
- Switch
@@ -21,7 +21,7 @@ ha_integration_type: integration
The `numato` integration is the base for all related GPIO platforms of the
[Numato 32 Port USB GPIO expander](https://numato.com/product/32-channel-usb-gpio-module-with-analog-inputs):
-- [Binary Sensor](#binary-sensor)
+- [Binary sensor](#binary-sensor)
- [Sensor](#sensor)
- [Switch](#switch)
@@ -135,7 +135,7 @@ devices:
type: string
{% endconfiguration %}
-## Binary Sensor
+## Binary sensor
The `numato` binary_sensor platform allows you to operate the GPIOs of your
[Numato](https://numato.com) 32 port USB GPIO expander in binary input mode.
@@ -168,7 +168,7 @@ state.
The `numato` switch platform allows you to operate the GPIOs of your
[Numato](https://numato.com) 32 port USB GPIO expander in output mode.
-## IO Ports
+## IO ports
The IO port numbers used in this configuration refer to the port numbers
printed on the PCB. Note that the Sensor platform can be configured on ports
diff --git a/source/_integrations/number.markdown b/source/_integrations/number.markdown
index 6e8aaad1a58..7306d5601d3 100644
--- a/source/_integrations/number.markdown
+++ b/source/_integrations/number.markdown
@@ -18,7 +18,7 @@ Keeps track on `number` entities in your environment, their state, and allows yo
If you are looking for a way to create a number entity, please take a look at the [Number helper](/integrations/input_number).
-## Device Class
+## Device class
The type of data a number represents impacts how it is displayed in the frontend. This is controlled by the number's device class designation. Built-in numbers and many created from an integration will have this designation predefined. Those can be modified in the [customize section](/docs/configuration/customizing-devices/). When manually creating a new number the device class may be optionally assigned. A full list of available number device classes is below:
diff --git a/source/_integrations/nut.markdown b/source/_integrations/nut.markdown
index fbf9b3d6460..76620d555b6 100644
--- a/source/_integrations/nut.markdown
+++ b/source/_integrations/nut.markdown
@@ -2,7 +2,7 @@
title: Network UPS Tools (NUT)
description: Instructions on how to set up NUT sensors within Home Assistant.
ha_category:
- - System Monitor
+ - System monitor
ha_iot_class: Local Polling
ha_release: 0.34
ha_domain: nut
diff --git a/source/_integrations/nx584.markdown b/source/_integrations/nx584.markdown
index 1a21c1bc277..3c5574a3bef 100644
--- a/source/_integrations/nx584.markdown
+++ b/source/_integrations/nx584.markdown
@@ -3,7 +3,7 @@ title: NX584
description: Instructions on how to integrate NX584 into Home Assistant.
ha_category:
- Alarm
- - Binary Sensor
+ - Binary sensor
ha_release: 0.13
ha_iot_class: Local Push
ha_domain: nx584
@@ -18,9 +18,9 @@ The `nx584` platform provides integration with GE, Caddx, Interlogix (and other
There is currently support for the following device types within Home Assistant:
- [Alarm](#alarm-control-panel)
-- [Binary Sensor](#binary-sensor)
+- [Binary sensor](#binary-sensor)
-## Alarm Control Panel
+## Alarm control panel
To enable this, add the following lines to your `configuration.yaml`:
@@ -42,13 +42,13 @@ name:
type: string
default: NX584
port:
- description: The port where the Alarm panel is listening.
+ description: The port where the alarm panel is listening.
required: false
type: integer
default: 5007
{% endconfiguration %}
-## Binary Sensor
+## Binary sensor
Enabling this binary sensor platform exposes all of your zones as binary sensors, which provides visibility through the UI as well as the ability to trigger automation actions instantly when something happens like a door opening, or a motion sensor trigger.
diff --git a/source/_integrations/nzbget.markdown b/source/_integrations/nzbget.markdown
index d2625a08014..015bd1762bb 100644
--- a/source/_integrations/nzbget.markdown
+++ b/source/_integrations/nzbget.markdown
@@ -35,7 +35,7 @@ This integration will create these sensors:
- `nzbget_size`: Amount of data downloaded since server start in MB.
- `nzbget_speed_limit`: Download queue speed limit in MB/s.
-## Event Automation
+## Event automation
The NZBGet integration continuously monitors nzbget's download history. When a download completes, an event usable for automation is triggered on the Home Assistant Bus.
diff --git a/source/_integrations/octoprint.markdown b/source/_integrations/octoprint.markdown
index 37c5e4c78ee..0d756a69aad 100644
--- a/source/_integrations/octoprint.markdown
+++ b/source/_integrations/octoprint.markdown
@@ -2,8 +2,8 @@
title: OctoPrint
description: Integration between OctoPrint and Home Assistant.
ha_category:
- - 3D Printing
- - Binary Sensor
+ - 3D printing
+ - Binary sensor
- Button
- Sensor
ha_config_flow: true
@@ -57,11 +57,11 @@ verify ssl:
default: false
{% endconfiguration_basic %}
-### API Key
+### API key
For the integration to work, please check that in Octoprint, the plugin Discovery is enabled and in the settings -> printer notifications menu pop-ups are enabled.
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.
-## Binary Sensor
+## Binary sensor
The OctoPrint integration provides the following binary sensors:
diff --git a/source/_integrations/oncue.markdown b/source/_integrations/oncue.markdown
index 2437fd14983..0ffd3db6ab2 100644
--- a/source/_integrations/oncue.markdown
+++ b/source/_integrations/oncue.markdown
@@ -2,7 +2,7 @@
title: Oncue by Kohler
description: Documentation about the oncue sensors.
ha_category:
- - Binary Sensor
+ - Binary sensor
- Sensor
ha_iot_class: Cloud Polling
ha_release: 2022.2
@@ -20,7 +20,7 @@ ha_integration_type: integration
The Oncue by Kohler integration will allow you to monitor the state of your [Oncue enabled Kohler generator](https://api.kohler.com/oncueplus/#/auth).
-## Tested Devices
+## Tested devices
- 20RESA
- [24RCL](https://kohlerpower.com/en/residential/generators/product/24rcl)
diff --git a/source/_integrations/onkyo.markdown b/source/_integrations/onkyo.markdown
index 0993e07d25f..c6613f9fba5 100644
--- a/source/_integrations/onkyo.markdown
+++ b/source/_integrations/onkyo.markdown
@@ -2,7 +2,7 @@
title: Onkyo
description: Instructions on how to integrate Onkyo and some Pioneer receivers into Home Assistant.
ha_category:
- - Media Player
+ - Media player
ha_release: 0.17
ha_iot_class: Local Polling
ha_domain: onkyo
diff --git a/source/_integrations/onvif.markdown b/source/_integrations/onvif.markdown
index 909c7fdca62..807735dc891 100644
--- a/source/_integrations/onvif.markdown
+++ b/source/_integrations/onvif.markdown
@@ -33,7 +33,7 @@ The ONVIF camera integration allows you to use an [ONVIF](https://www.onvif.org/
If running Home assistant Core in a venv, ensure that libxml2 and libxslt python interfaces are installed via your package manager.
-### Configuration Notes
+### Configuration notes
Most of the ONVIF devices support more than one audio/video profile. Each profile provides different image quality, or in the case of an NVR, separate connected cameras. This integration will add entities for all compatible profiles with the video encoding set to H.264. Usually, the first profile has the highest quality and it is the profile used by default. However, you may want to use a lower quality image. You may disable unwanted entities through the Home Assistant UI.
@@ -55,7 +55,7 @@ By default, the integration will only enable the camera entity for the first H26
- If additional camera entities are available for other profiles, try enabling those entities.
- Set the `Extra FFmpeg arguments` to `-pred 1 -ss 00:00:05 -frames:v 1` to cause the snapshot to be taken 5 seconds into the stream.
-### Supported Sensors
+### Supported sensors
This integration uses the ONVIF pullpoint subscription API to process events into sensors that will be automatically added to Home Assistant. Below is a list of currently supported event topics along with the entities they create.
@@ -63,23 +63,23 @@ To help with development of this integration, enable `info` level logging for `h
| Topic(s) | Entity Type | Device Class | Description |
|----------|-------------|--------------|-------------|
-| Motion Alarm | Binary Sensor | Motion | Generic motion alarm. |
-| Field Detection | Binary Sensor | Motion | Polygonal field detection determines if each object in the scene is inside or outside the polygon. |
-| Cell Motion Detection | Binary Sensor | Motion | Cell based motion detection determined by placing a grid over the video source and determining changes. |
-| Motion Region Detector | Binary Sensor | Motion | Detects any motion against the specified motion region. The rule is configured for an area defined by a polygon. |
-| Detected Sound | Binary Sensor | Sound | Device detected sound. |
-| Digital Input | Binary Sensor | None | A digital input was triggered on the device. Amcrest is known to use this as a doorbell button press on the AD410. |
-| Relay Triggered | Binary Sensor | None | Device relay output was triggered. |
-| Image Too Blurry | Binary Sensor | Problem | Device reports blurry image. |
-| Image Too Dark | Binary Sensor | Problem | Device reports dark image. |
-| Image Too Bright | Binary Sensor | Problem | Device reports bright image. |
-| Global Scene Change | Binary Sensor | Problem | Device reports a large portion of the video content changing. The cause can be tamper actions like camera movement or coverage. |
-| Tamper Detector | Binary Sensor | Problem | Detects any kind of tampering to the image sensor. |
-| Storage Failure | Binary Sensor | Problem | Storage failure on device. |
-| Recording Job State | Binary Sensor | None | Whether or not the device is actively recording. |
-| Processor Usage | Sensor | Percent | Device processor usage. |
-| Last Reboot | Sensor | Timestamp | When the device was last rebooted. |
-| Last Reset | Sensor | Timestamp | When the device was last reset. |
+| Motion alarm | Binary sensor | Motion | Generic motion alarm. |
+| Field detection | Binary sensor | Motion | Polygonal field detection determines if each object in the scene is inside or outside the polygon. |
+| Cell motion detection | Binary sensor | Motion | Cell based motion detection determined by placing a grid over the video source and determining changes. |
+| Motion region detector | Binary sensor | Motion | Detects any motion against the specified motion region. The rule is configured for an area defined by a polygon. |
+| Detected sound | Binary sensor | Sound | Device detected sound. |
+| Digital input | Binary sensor | None | A digital input was triggered on the device. Amcrest is known to use this as a doorbell button press on the AD410. |
+| Relay triggered | Binary sensor | None | Device relay output was triggered. |
+| Image too blurry | Binary sensor | Problem | Device reports blurry image. |
+| Image too dark | Binary sensor | Problem | Device reports dark image. |
+| Image too bright | Binary sensor | Problem | Device reports bright image. |
+| Global scene change | Binary sensor | Problem | Device reports a large portion of the video content changing. The cause can be tamper actions like camera movement or coverage. |
+| Tamper detector | Binary sensor | Problem | Detects any kind of tampering to the image sensor. |
+| Storage failure | Binary sensor | Problem | Storage failure on device. |
+| Recording job state | Binary sensor | None | Whether or not the device is actively recording. |
+| Processor usage | Sensor | Percent | Device processor usage. |
+| Last reboot | Sensor | Timestamp | When the device was last rebooted. |
+| Last reset | Sensor | Timestamp | When the device was last reset. |
| Last Clock Synchronization | Sensor | Timestamp | When the device clock was last synchronized. |
| Last Backup | Sensor | Timestamp | When the last backup of the device configuration has been retrieved. |
@@ -87,7 +87,7 @@ If you are running into trouble with this sensor, please refer to the [Troublesh
### Service `onvif.ptz`
-If your ONVIF camera supports PTZ, you will be able to pan, tilt or zoom your camera.
+If your ONVIF camera supports PTZ, you will be able to pan, tilt or zoom your camera.
| Service data attribute | Description |
| -----------------------| ----------- |
@@ -95,13 +95,13 @@ If your ONVIF camera supports PTZ, you will be able to pan, tilt or zoom your ca
| `tilt` | Tilt direction. Allowed values: `UP`, `DOWN`, `NONE` |
| `pan` | Pan direction. Allowed values: `RIGHT`, `LEFT`, `NONE` |
| `zoom` | Zoom. Allowed values: `ZOOM_IN`, `ZOOM_OUT`, `NONE` |
-| `distance` | Distance coefficient. Sets how much PTZ should be executed in one request. Allowed values: floating point numbers, 0 to 1. Default : 0.1 |
+| `distance` | Distance coefficient. Sets how much PTZ should be executed in one request. Allowed values: floating point numbers, 0 to 1. Default : 0.1 |
| `speed` | Speed coefficient. Sets how fast PTZ will be executed. Allowed values: floating point numbers, 0 to 1. Default : 0.5 |
| `preset` | PTZ preset profile token. Sets the preset profile token which is executed with GotoPreset. |
| `move_mode` | PTZ moving mode. Allowed values: `ContinuousMove`, `RelativeMove`, `AbsoluteMove`, `GotoPreset`, `Stop`. Default :`RelativeMove` |
| `continuous_duration` | Set ContinuousMove delay in seconds before stopping the move. Allowed values: floating point numbers or integer. Default : 0.5 |
-### Supported Switches
+### Supported switches
This integration uses the ONVIF auxiliary command and imaging service to send certain settings and information to the camera via switch entities. Below is a list of currently supported switches.
diff --git a/source/_integrations/openalpr_cloud.markdown b/source/_integrations/openalpr_cloud.markdown
index c7b6989a2a3..0ee6bde7b8a 100644
--- a/source/_integrations/openalpr_cloud.markdown
+++ b/source/_integrations/openalpr_cloud.markdown
@@ -2,7 +2,7 @@
title: OpenALPR Cloud
description: Instructions on how to integrate licences plates with OpenALPR cloud into Home Assistant.
ha_category:
- - Image Processing
+ - Image processing
ha_iot_class: Cloud Push
ha_release: 0.36
ha_domain: openalpr_cloud
diff --git a/source/_integrations/opencv.markdown b/source/_integrations/opencv.markdown
index a603434cbb2..cf75af09353 100644
--- a/source/_integrations/opencv.markdown
+++ b/source/_integrations/opencv.markdown
@@ -2,7 +2,7 @@
title: OpenCV
description: Instructions on how to integrate OpenCV image processing into Home Assistant.
ha_category:
- - Image Processing
+ - Image processing
ha_iot_class: Local Push
ha_release: 0.47
ha_domain: opencv
diff --git a/source/_integrations/openhardwaremonitor.markdown b/source/_integrations/openhardwaremonitor.markdown
index b01a8d237d4..939770b1c45 100644
--- a/source/_integrations/openhardwaremonitor.markdown
+++ b/source/_integrations/openhardwaremonitor.markdown
@@ -2,7 +2,7 @@
title: Open Hardware Monitor
description: Instructions on how to integrate Open Hardware Monitor within Home Assistant.
ha_category:
- - System Monitor
+ - System monitor
ha_release: 0.48
ha_iot_class: Local Polling
ha_domain: openhardwaremonitor
diff --git a/source/_integrations/openhome.markdown b/source/_integrations/openhome.markdown
index d193136a0c7..9290e03e9a7 100644
--- a/source/_integrations/openhome.markdown
+++ b/source/_integrations/openhome.markdown
@@ -2,7 +2,7 @@
title: Linn / OpenHome
description: Instructions on how to integrate Linn Ds and Openhome renderers into Home Assistant.
ha_category:
- - Media Player
+ - Media player
- Update
ha_release: 0.39
ha_iot_class: Local Polling
diff --git a/source/_integrations/opensensemap.markdown b/source/_integrations/opensensemap.markdown
index a24626598e1..338f1ef458d 100644
--- a/source/_integrations/opensensemap.markdown
+++ b/source/_integrations/opensensemap.markdown
@@ -17,7 +17,7 @@ The `opensensemap` air quality platform will query the open data API of [openSen
To get the ID of a station you need to select it on the [openSense map](https://opensensemap.org/) and find it in the addressbar of your browser. It's the last part of the URL, e.g., `5b450e565dc1ec001bf7cd1d` [https://opensensemap.org/explore/5b450e565dc1ec001bf7cd1d](https://opensensemap.org/explore/5b450e565dc1ec001bf7cd1d).
-## Manual Configuration
+## Manual configuration
To enable this platform, add the following lines to your `configuration.yaml` file:
diff --git a/source/_integrations/opentherm_gw.markdown b/source/_integrations/opentherm_gw.markdown
index 5f50a069c03..80e4f954bed 100644
--- a/source/_integrations/opentherm_gw.markdown
+++ b/source/_integrations/opentherm_gw.markdown
@@ -2,7 +2,7 @@
title: OpenTherm Gateway
description: Control your OpenTherm Gateway from Home Assistant.
ha_category:
- - Binary Sensor
+ - Binary sensor
- Climate
- Hub
- Sensor
@@ -23,7 +23,7 @@ The `opentherm_gw` integration is used to control the [OpenTherm Gateway](https:
The following device types are currently supported within Home Assistant:
-- Binary Sensor
+- Binary sensor
- Climate
- Sensor
@@ -414,7 +414,7 @@ Not all boilers and thermostats properly support all OpenTherm features, so not
Solar storage unit temperature.
-## Binary Sensors
+## Binary sensors
The following `binary_sensor` entities will be created for each configured gateway. The `entity_id` of every sensor will have a suffix containing the data source (`boiler`, `gateway` or `thermostat`) and the `gateway_id` of the gateway to which it belongs. All `binary_sensor` entities are disabled by default.
diff --git a/source/_integrations/openuv.markdown b/source/_integrations/openuv.markdown
index d80562b6892..8c2d737d2a0 100644
--- a/source/_integrations/openuv.markdown
+++ b/source/_integrations/openuv.markdown
@@ -2,7 +2,7 @@
title: OpenUV
description: Instructions on how to integrate OpenUV within Home Assistant.
ha_category:
- - Binary Sensor
+ - Binary sensor
- Health
- Sensor
ha_release: 0.76
@@ -40,7 +40,7 @@ To generate an API key, log in at [the OpenUV website](https://www.openuv.io/).
| Current UV Index | Sensor | UV Index (numerical value) |
| Current UV Level | Sensor | UV Level (as literal) |
| Max UV Index | Sensor | max UV Index for the day (at solar noon) |
-| Protection Window | Binary Sensor | whether sunblock protection should be used |
+| Protection window | Binary sensor | whether sunblock protection should be used |
| Skin Type 1 Safe Exposure Time | Sensor | the amount of time [Fitzpatrick skin type 1](https://en.wikipedia.org/wiki/Fitzpatrick_scale) can be in the sun unprotected |
| Skin Type 2 Safe Exposure Time | Sensor | the amount of time [Fitzpatrick skin type 2](https://en.wikipedia.org/wiki/Fitzpatrick_scale) can be in the sun unprotected |
| Skin Type 3 Safe Exposure Time | Sensor | the amount of time [Fitzpatrick skin type 3](https://en.wikipedia.org/wiki/Fitzpatrick_scale) can be in the sun unprotected |
@@ -48,7 +48,7 @@ To generate an API key, log in at [the OpenUV website](https://www.openuv.io/).
| Skin Type 5 Safe Exposure Time | Sensor | the amount of time [Fitzpatrick skin type 5](https://en.wikipedia.org/wiki/Fitzpatrick_scale) can be in the sun unprotected |
| Skin Type 6 Safe Exposure Time | Sensor | the amount of time [Fitzpatrick skin type 6](https://en.wikipedia.org/wiki/Fitzpatrick_scale) can be in the sun unprotected |
-## Updating Data
+## Updating data
OpenUV does _not_ automatically update data for its entities! Users must manually
@@ -80,7 +80,7 @@ _all_ of these entities.
To protect against possible API call waste, all calls to `homeassistant.update_entity`
that reference an OpenUV entity are throttled to a minimum of 15 minutes between calls.
-### Protection Window
+### Protection window
The Protection Window binary sensor will be `on` when sunblock protection should be used.
diff --git a/source/_integrations/opnsense.markdown b/source/_integrations/opnsense.markdown
index 4633e4535c7..06df9f5645a 100644
--- a/source/_integrations/opnsense.markdown
+++ b/source/_integrations/opnsense.markdown
@@ -3,7 +3,7 @@ title: OPNSense
description: Instructions on how to configure OPNsense integration
ha_category:
- Hub
- - Presence Detection
+ - Presence detection
ha_release: 0.105
ha_codeowners:
- '@mtreinish'
@@ -18,7 +18,7 @@ ha_integration_type: integration
and routing platform. There is currently support for the following device types
within Home Assistant:
-- [Presence Detection](#presence-detection)
+- [Presence detection](#presence-detection)
## Configuration
diff --git a/source/_integrations/oralb.markdown b/source/_integrations/oralb.markdown
index b482724c5da..523c86c6a9d 100644
--- a/source/_integrations/oralb.markdown
+++ b/source/_integrations/oralb.markdown
@@ -48,3 +48,7 @@ The integration can discover most Bluetooth-enabled Oral-B toothbrushes. Brushes
- Time - total brushing time in seconds.
- Toothbrush state - whether the toothbrush is running, idle.
- Battery - toothbrush battery percentage.
+
+
+Updates of the battery sensor require an active Bluetooth connection and relatively close proximity. If you use a Bluetooth proxy, please ensure it supports active connections. All the other sensors update with active or passive connections.
+
diff --git a/source/_integrations/overkiz.markdown b/source/_integrations/overkiz.markdown
index 80ca20ac30c..060c188e947 100644
--- a/source/_integrations/overkiz.markdown
+++ b/source/_integrations/overkiz.markdown
@@ -3,7 +3,7 @@ title: Overkiz
description: Instructions on how to integrate hubs whom use the Overkiz platform with Home Assistant.
ha_category:
- Alarm
- - Binary Sensor
+ - Binary sensor
- Button
- Climate
- Cover
@@ -16,7 +16,7 @@ ha_category:
- Sensor
- Siren
- Switch
- - Water Heater
+ - Water heater
ha_release: 2022.2
ha_config_flow: true
ha_iot_class: Local Polling
@@ -70,9 +70,36 @@ Over 6000 devices from 60 brands are compatible with the Overkiz platform. This
## Known limitations
-### Z-Wave, Hue and Sonos not supported
+### Zigbee, Z-Wave, Hue, and Sonos devices not supported
-Even though most Overkiz hubs support adding Z-Wave, Hue, and Sonos devices, this isn't supported in the Overkiz integration. All these platforms have native integrations in Home Assistant which are more stable and feature-rich.
+Even though most Overkiz hubs support adding Zigbee, Z-Wave, Hue, and Sonos devices, this isn't supported in the Overkiz integration. All these platforms have native integrations in Home Assistant which are more stable and feature-rich.
+
+### Stateless RTS covers
+
+Covers that use the RTS protocol are stateless and do not report their state back to the hub. This means that Home Assistant will not know the state of the device after it has been controlled.
+
+If you only control your RTS cover from Home Assistant, you can use the [template cover](/integrations/cover.template/) to create a stateful cover entity. This will allow you to keep track of the current state (open or closed) and use the cover in automations and scenes.
+
+```yaml
+cover:
+ - platform: template
+ covers:
+ stateful_rts_test_shutter: # unique ID
+ friendly_name: "Stateful RTS Test Shutter" # your name
+ optimistic: true # default when no state is available
+ open_cover:
+ - service: cover.open_cover
+ target:
+ entity_id: cover.rts_test_shutter # change to your device id
+ close_cover:
+ - service: cover.close_cover
+ target:
+ entity_id: cover.rts_test_shutter # change to your device id
+ stop_cover:
+ - service: cover.stop_cover
+ target:
+ entity_id: cover.rts_test_shutter # change to your device id
+```
### Overkiz API limits
@@ -80,6 +107,10 @@ Even though most Overkiz hubs support adding Z-Wave, Hue, and Sonos devices, thi
During peak hours, it could happen that the Overkiz platform is unable to execute your command. The integration will try to retry this command, however, this is not guaranteed to succeed.
+**Execution queue is full on gateway**
+
+The Overkiz API only supports 10 requests in its execution queue. If you try to command more devices at the same time, for example with a group, this will fail with `EXEC_QUEUE_FULL`. To work around this, you can create a scenario in the corresponding application and call that scenario instead after syncing it in the integration.
+
### Internet connectivity required
This integration communicates via the cloud-based Overkiz API in most cases. Depending on your hub and devices, there are options which communicate over your local network.
diff --git a/source/_integrations/owntracks.markdown b/source/_integrations/owntracks.markdown
index f82e0bda988..a4b97ae3578 100644
--- a/source/_integrations/owntracks.markdown
+++ b/source/_integrations/owntracks.markdown
@@ -2,7 +2,7 @@
title: OwnTracks
description: Instructions on how to use OwnTracks to track devices in Home Assistant.
ha_category:
- - Presence Detection
+ - Presence detection
ha_iot_class: Local Push
ha_release: 0.7.4
ha_config_flow: true
@@ -16,8 +16,6 @@ ha_integration_type: integration
By default, the integration listens for incoming messages from OwnTracks via HTTP. If Home Assistant is configured to use MQTT instead, it listens for MQTT messages. When a location is submitted via HTTP, Home Assistant returns all [Persons](/integrations/person/)' last known locations. Their location will be displayed within the OwnTracks app.
-
-
## Configuration
1. To set up OwnTracks in Home Assistant, go to **{% my integrations title="Settings > Devices & Services" %}**.
diff --git a/source/_integrations/panasonic_bluray.markdown b/source/_integrations/panasonic_bluray.markdown
index 45b1dccd1ce..e6e870c8223 100644
--- a/source/_integrations/panasonic_bluray.markdown
+++ b/source/_integrations/panasonic_bluray.markdown
@@ -2,7 +2,7 @@
title: Panasonic Blu-Ray Player
description: Instructions on how to integrate a Panasonic Blu-Ray player into Home Assistant.
ha_category:
- - Media Player
+ - Media player
ha_iot_class: Local Polling
ha_release: 0.83
ha_domain: panasonic_bluray
diff --git a/source/_integrations/panasonic_viera.markdown b/source/_integrations/panasonic_viera.markdown
index ec56d51f75c..c6bbd9e5357 100644
--- a/source/_integrations/panasonic_viera.markdown
+++ b/source/_integrations/panasonic_viera.markdown
@@ -2,7 +2,7 @@
title: Panasonic Viera
description: Instructions on how to integrate a Panasonic Viera TV with Home Assistant.
ha_category:
- - Media Player
+ - Media player
- Remote
ha_release: 0.17
ha_iot_class: Local Polling
@@ -18,7 +18,7 @@ The Panasonic Viera integration allows you to control a Panasonic Viera TV.
There is currently support for the following device types within Home Assistant:
-- Media Player
+- Media player
- [Remote](#remote)
{% include integrations/config_flow.md %}
diff --git a/source/_integrations/pandora.markdown b/source/_integrations/pandora.markdown
index a282f93168b..5dced5c6e7e 100644
--- a/source/_integrations/pandora.markdown
+++ b/source/_integrations/pandora.markdown
@@ -2,7 +2,7 @@
title: Pandora
description: Instructions on how to integrate Pandora radio into Home Assistant.
ha_category:
- - Media Player
+ - Media player
ha_release: 0.22
ha_iot_class: Local Polling
ha_domain: pandora
diff --git a/source/_integrations/panel_custom.markdown b/source/_integrations/panel_custom.markdown
index 95074a308d7..bd3270a9b65 100644
--- a/source/_integrations/panel_custom.markdown
+++ b/source/_integrations/panel_custom.markdown
@@ -1,8 +1,8 @@
---
-title: Custom Panel
-description: Instructions on how to add customized panels to the frontend of Home Assistant.
+title: Custom panel
+description: Instructions on how to add customized panels to the front end of Home Assistant.
ha_category:
- - Front End
+ - Front end
ha_release: 0.26
ha_quality_scale: internal
ha_codeowners:
diff --git a/source/_integrations/panel_iframe.markdown b/source/_integrations/panel_iframe.markdown
index e286e6324c3..2ab32f0e0a1 100644
--- a/source/_integrations/panel_iframe.markdown
+++ b/source/_integrations/panel_iframe.markdown
@@ -1,8 +1,8 @@
---
-title: iframe Panel
-description: Instructions on how to add iFrames in the frontend of Home Assistant.
+title: iFrame panel
+description: Instructions on how to add iFrames in the front end of Home Assistant.
ha_category:
- - Front End
+ - Front end
ha_release: 0.25
ha_quality_scale: internal
ha_codeowners:
diff --git a/source/_integrations/person.markdown b/source/_integrations/person.markdown
index 939e123147b..d098505ed26 100644
--- a/source/_integrations/person.markdown
+++ b/source/_integrations/person.markdown
@@ -2,7 +2,7 @@
title: Person
description: Instructions on how to set up people tracking within Home Assistant.
ha_category:
- - Presence Detection
+ - Presence detection
ha_release: 0.88
ha_quality_scale: internal
ha_domain: person
diff --git a/source/_integrations/philips_js.markdown b/source/_integrations/philips_js.markdown
index 870ce735868..fbba06a5e05 100644
--- a/source/_integrations/philips_js.markdown
+++ b/source/_integrations/philips_js.markdown
@@ -3,7 +3,7 @@ title: Philips TV
description: Instructions on how to add Philips TVs to Home Assistant.
ha_category:
- Light
- - Media Player
+ - Media player
- Remote
- Binary sensor
ha_iot_class: Local Polling
diff --git a/source/_integrations/pi_hole.markdown b/source/_integrations/pi_hole.markdown
index 67c2e9c0b6a..73638e9ee4b 100644
--- a/source/_integrations/pi_hole.markdown
+++ b/source/_integrations/pi_hole.markdown
@@ -4,7 +4,7 @@ description: Instructions on how to integrate Pi-hole with Home Assistant.
ha_category:
- Sensor
- Switch
- - System Monitor
+ - System monitor
- Update
ha_iot_class: Local Polling
ha_config_flow: true
diff --git a/source/_integrations/pilight.markdown b/source/_integrations/pilight.markdown
index 73451081f02..2056e1992a4 100644
--- a/source/_integrations/pilight.markdown
+++ b/source/_integrations/pilight.markdown
@@ -2,7 +2,7 @@
title: Pilight
description: Instructions on how to setup Pilight within Home Assistant.
ha_category:
- - Binary Sensor
+ - Binary sensor
- DIY
- Sensor
- Switch
@@ -27,7 +27,7 @@ The received and supported RF codes are put on the event bus of Home Assistant a
There is currently support for the following device types within Home Assistant:
-- [Binary Sensor](#binary-sensor)
+- [Binary sensor](#binary-sensor)
- [Sensor](#sensor)
- [Switch](#switch)
- [Light](#light)
@@ -81,7 +81,7 @@ pilight:
- 42
```
-## Binary Sensor
+## Binary sensor
The `pilight` binary sensor platform implements the [pilight hub](#configuration) binary sensor functionality. There are two types of Pilight binary sensor configuration: a normal sensor which sends the on and off cyclical state and a trigger sensor which sends only a trigger when an event happened (for example lots of cheap PIR motion detectors).
diff --git a/source/_integrations/ping.markdown b/source/_integrations/ping.markdown
index 45dc9e4ddc4..3c21787e4a0 100644
--- a/source/_integrations/ping.markdown
+++ b/source/_integrations/ping.markdown
@@ -2,9 +2,9 @@
title: Ping (ICMP)
description: Instructions on how to integrate Ping (ICMP)-based into Home Assistant.
ha_category:
- - Binary Sensor
+ - Binary sensor
- Network
- - Presence Detection
+ - Presence detection
ha_release: 0.43
ha_iot_class: Local Polling
ha_quality_scale: internal
@@ -20,12 +20,12 @@ ha_codeowners:
There is currently support for the following device types within Home Assistant:
-- [Binary Sensor](#binary-sensor)
-- [Presence Detection](#presence-detection)
+- [Binary sensor](#binary-sensor)
+- [Presence detection](#presence-detection)
{% include integrations/config_flow.md %}
-## Binary Sensor
+## Binary sensor
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 5 minutes.
@@ -41,7 +41,7 @@ The sensor exposes the different round trip times in milliseconds measured by `p
When run on Windows systems, the round trip time attributes are rounded to the nearest millisecond and the mdev value is unavailable.
-## Presence Detection
+## Presence detection
The `ping` device tracker platform offers presence detection by using `ping` to send ICMP echo requests. This can be useful when devices are running a firewall and are blocking UDP or TCP packets but responding to ICMP requests (like Android phones). This tracker doesn't need to know the MAC address since the host can be on a different subnet. This makes this an option to detect hosts on a different subnet when `nmap` or other solutions don't work since `arp` doesn't work.
diff --git a/source/_integrations/pioneer.markdown b/source/_integrations/pioneer.markdown
index 89fbd711a7a..6b68b469619 100644
--- a/source/_integrations/pioneer.markdown
+++ b/source/_integrations/pioneer.markdown
@@ -2,7 +2,7 @@
title: Pioneer
description: Instructions on how to integrate a Pioneer Network Receivers into Home Assistant.
ha_category:
- - Media Player
+ - Media player
ha_release: 0.19
ha_iot_class: Local Polling
ha_domain: pioneer
diff --git a/source/_integrations/pjlink.markdown b/source/_integrations/pjlink.markdown
index e79afdc9f1e..00948dda491 100644
--- a/source/_integrations/pjlink.markdown
+++ b/source/_integrations/pjlink.markdown
@@ -2,7 +2,7 @@
title: PJLink
description: Instructions on how to integrate PJLink enabled projectors into Home Assistant.
ha_category:
- - Media Player
+ - Media player
ha_release: 0.76
ha_iot_class: Local Polling
ha_domain: pjlink
diff --git a/source/_integrations/plaato.markdown b/source/_integrations/plaato.markdown
index 093a25fd407..5846ecbbf7d 100644
--- a/source/_integrations/plaato.markdown
+++ b/source/_integrations/plaato.markdown
@@ -36,7 +36,7 @@ To configure a Plaato device, you must set it up via the integrations panel in t
You have two options to choose from: webhook and `auth_token.` The webhook is only available for the Airlock at the moment.
-### Auth Token
+### Auth token
To be able to query the API an `auth_token` is required which can be obtained by following [these](https://intercom.help/plaato/en/articles/5004720-auth_token) instructions.
diff --git a/source/_integrations/plant.markdown b/source/_integrations/plant.markdown
index 047eeaa44d2..67c0d1d88f3 100644
--- a/source/_integrations/plant.markdown
+++ b/source/_integrations/plant.markdown
@@ -114,7 +114,7 @@ Another good source of this data would be the [Mi Flora](/integrations/miflora)
If the sensor data is within the min/max values the status will be `ok`, if not the status will be `problem`. You can use this to trigger a notification, if there is a problem with your plant. Of course you can only monitor attributes of your plant, where the sensor is configured and is providing the data.
-## Data Source
+## Data source
The main sources of the data will usually be a [MiFlora sensor](/integrations/miflora) or a [MQTT sensor](/integrations/sensor.mqtt/) receiving the data from a [PlantGateway](https://github.com/ChristianKuehnel/plantgateway).
diff --git a/source/_integrations/plex.markdown b/source/_integrations/plex.markdown
index 75246028c11..42404f73b92 100644
--- a/source/_integrations/plex.markdown
+++ b/source/_integrations/plex.markdown
@@ -3,7 +3,7 @@ title: Plex Media Server
description: Instructions on how to integrate Plex into Home Assistant.
ha_category:
- Button
- - Media Player
+ - Media player
- Sensor
- Update
featured: true
@@ -22,16 +22,16 @@ ha_zeroconf: true
ha_integration_type: integration
---
-The Plex integration allows you to connect Home Assistant to a [Plex Media Server](https://plex.tv). Once configured, actively streaming [Plex Clients](https://www.plex.tv/apps-devices/) show up as [Media Players](/integrations/media_player/) and report playback status and library sizes via [Sensors](/integrations/sensor/) in Home Assistant. Media Players will allow you to control media playback and see the current playing item.
+The Plex integration allows you to connect Home Assistant to a [Plex Media Server](https://plex.tv). Once configured, actively streaming [Plex Clients](https://www.plex.tv/apps-devices/) show up as [media players](/integrations/media_player/) and report playback status and library sizes via [sensors](/integrations/sensor/) in Home Assistant. Media players will allow you to control media playback and see the current playing item.
-Support for playing music directly on linked [Sonos](/integrations/sonos/) speakers is available [here](#sonos-playback).
+Support for playing music directly on linked [Sonos](/integrations/sonos/) speakers is available in the [Sonos playback](#sonos-playback) section.
There is currently support for the following device types within Home Assistant:
- [Sensor](#sensor)
- [Button](#button)
- [Update](#update)
-- [Media Player](#media-player)
+- [Media player](#media-player)
If a Plex server has been claimed by a Plex account via the [claim interface](https://plex.tv/claim), Home Assistant will require authentication to connect.
@@ -41,7 +41,7 @@ During setup, you will need to log in as a server administrator. The integration
If your router enforces DNS rebind protection, connections to the local `plex.direct` hostname may fail (see [Plex documentation](https://support.plex.tv/articles/206225077-how-to-use-secure-server-connections/#dnsrebinding)). To avoid this, configure your router to allow DNS rebinding for `plex.direct` by following the instructions in the documentation link.
-### Integration Options
+### Integration options
Several options are provided to adjust the behavior of `media_player` entities. These can be changed at **Plex** -> **Options** on the Integrations page.
@@ -53,7 +53,7 @@ Several options are provided to adjust the behavior of `media_player` entities.
**Ignore Plex Web clients**: Do not create `media_player` entities for Plex Web clients.
-### Manual Configuration
+### Manual configuration
Alternatively, you can manually configure a Plex server connection by selecting the "Configure Plex server manually" when configuring a Plex integration. This option is only available to users in "Advanced Mode". This will allow you to specify the server connection options which will be validated before setup is completed. The available options are described below:
@@ -146,11 +146,11 @@ Notifications of new releases of Plex Media Server are shown using an Update ent
Automatic upgrades of Plex Media Server can be triggered for some installation types, such as Windows and certain NAS devices.
-## Media Player
+## Media player
-The Plex media player platform will create Media Player entities for each connected client device. These entities will display media information, playback progress, and playback controls (if supported by the streaming device).
+The Plex media player platform will create media player entities for each connected client device. These entities will display media information, playback progress, and playback controls (if supported by the streaming device).
-By default, the Plex integration will create Media Player entities for all local, managed, and shared users on the Plex server. To customize which users or client types to monitor, adjust the "*Monitored users*", "*Ignore new managed/shared users*", and "*Ignore Plex Web clients*" options described under [Integration Options](#integration-options).
+By default, the Plex integration will create media player entities for all local, managed, and shared users on the Plex server. To customize which users or client types to monitor, adjust the "*Monitored users*", "*Ignore new managed/shared users*", and "*Ignore Plex Web clients*" options described under [Integration Options](#integration-options).
### Service `media_player.play_media`
@@ -224,7 +224,7 @@ media_content_type: PLAYLIST
media_content_id: '{ "playlist_name": "The Best of Disco", "shuffle": "1" }'
```
-#### TV Episode
+#### TV episode
| Service data attribute | Description |
| ---------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
@@ -276,7 +276,7 @@ media_content_type: movie
media_content_id: '{ "library_name": "Adult Movies", "title": "Blade" }'
```
-#### Advanced Searches
+#### Advanced searches
Instead of searching for a specific known piece of media, many additional parameters are available to run more powerful searches. This can also be used when a simple search for a title has multiple matches, such as with movie remakes.
@@ -344,7 +344,7 @@ The search will attempt to guess the type of media based on the search parameter
| Plex Desktop & Web | Controls are unavailable (as of June 2022) |
| Plex HTPC | None |
-## Sonos Playback
+## Sonos playback
To play Plex music directly to Sonos speakers, the following requirements must be met:
@@ -372,7 +372,7 @@ media_content_type: playlist
media_content_id: 'plex://{ "playlist_name": "Party Mix" }'
```
-## Additional Services
+## Additional services
### Service `plex.refresh_library`
diff --git a/source/_integrations/plugwise.markdown b/source/_integrations/plugwise.markdown
index fe29ff6a6f9..2806419855e 100644
--- a/source/_integrations/plugwise.markdown
+++ b/source/_integrations/plugwise.markdown
@@ -2,7 +2,7 @@
title: Plugwise
description: Plugwise Smile platform integration.
ha_category:
- - Binary Sensor
+ - Binary sensor
- Climate
- Number
- Select
diff --git a/source/_integrations/point.markdown b/source/_integrations/point.markdown
index b8a40163ee2..7b91a0fe8cb 100644
--- a/source/_integrations/point.markdown
+++ b/source/_integrations/point.markdown
@@ -3,7 +3,7 @@ title: Minut Point
description: Instructions on how to integrate Minut Point into Home Assistant.
ha_category:
- Alarm
- - Binary Sensor
+ - Binary sensor
- Hub
- Sensor
ha_release: 0.83
@@ -27,7 +27,7 @@ Once Home Assistant is started, a configurator will pop up asking you to Authent
There is currently support for the following device types within Home Assistant:
- [Alarm](#alarm)
-- [Binary Sensor](#binary-sensor)
+- [Binary sensor](#binary-sensor)
- [Sensor](#sensor)
### Configuration
@@ -54,12 +54,12 @@ client_secret:
The integration supports the following device types within Home Assistant:
- [Alarm](#alarm)
- - [Binary Sensor](#binary-sensor)
+ - [Binary sensor](#binary-sensor)
- [Sensor](#sensor)
-The Point is just active occasionally so the [Sensors](#sensor) are only updated every hour or so. The [Binary Sensors](#binary-sensor) are however updated via [Cloud Push](/blog/2016/02/12/classifying-the-internet-of-things/#cloud-pushing-new-state), making the changes close to instant.
+The Point is just active occasionally so the [sensors](#sensor) are only updated every hour or so. The [binary sensors](#binary-sensor) are however updated via [Cloud Push](/blog/2016/02/12/classifying-the-internet-of-things/#cloud-pushing-new-state), making the changes close to instant.
@@ -73,7 +73,7 @@ The Point only supports a Arm/Disarm action, so it is only `Arm Away` that is im
-## Binary Sensor
+## Binary sensor
Each Point exposes the following binary sensors:
diff --git a/source/_integrations/powerwall.markdown b/source/_integrations/powerwall.markdown
index ef1de6b5501..3dddd9ae741 100644
--- a/source/_integrations/powerwall.markdown
+++ b/source/_integrations/powerwall.markdown
@@ -2,7 +2,7 @@
title: Tesla Powerwall
description: Instructions on how to integrate Tesla Power Walls into Home Assistant.
ha_category:
- - Binary Sensor
+ - Binary sensor
- Energy
- Sensor
- Switch
@@ -26,13 +26,13 @@ The `powerwall` integration allows you to integrate your [Tesla Powerwall](https
There is currently support for the following device types within Home Assistant:
-- [Binary Sensor](#binary-sensor)
+- [Binary sensor](#binary-sensor)
- [Sensor](#sensor)
- [Switch](#switch)
{% include integrations/config_flow.md %}
-### Binary Sensor
+### Binary sensor
The following binary sensors are added for each Powerwall:
@@ -75,7 +75,7 @@ The following switches are added for each Powerwall:
- Off-Grid operation - Take your Powerwall off-grid (simulate a grid outage)
-### Device Info
+### Device info
- Model Number
- Firmware Revision
diff --git a/source/_integrations/private_ble_device.markdown b/source/_integrations/private_ble_device.markdown
index aa159b24d78..2bd002e0bfc 100644
--- a/source/_integrations/private_ble_device.markdown
+++ b/source/_integrations/private_ble_device.markdown
@@ -2,7 +2,7 @@
title: Private BLE Device
description: Instructions on how to integrate private BLE devices into Home Assistant.
ha_category:
- - Device Tracker
+ - Device tracker
ha_release: '2023.10'
ha_iot_class: Local Push
ha_domain: private_ble_device
diff --git a/source/_integrations/progettihwsw.markdown b/source/_integrations/progettihwsw.markdown
index 6d5fb6aa2bb..89a1e1df7d5 100644
--- a/source/_integrations/progettihwsw.markdown
+++ b/source/_integrations/progettihwsw.markdown
@@ -2,7 +2,7 @@
title: ProgettiHWSW Automation
description: Instructions on how to integrate the ProgettiHWSW remote relay boards into Home Assistant.
ha_category:
- - Binary Sensor
+ - Binary sensor
- DIY
- Switch
ha_release: 0.115
@@ -21,7 +21,7 @@ The `progettihwsw` integration brings the automation experience with ProgettiHWS
{% include integrations/config_flow.md %}
-## Binary Sensor
+## Binary sensor
The `progettihwsw` binary sensor platform allows you to read the input values of a [ProgettiHWSW Board](http://www.progetti-hw-sw.it/).
diff --git a/source/_integrations/proximity.markdown b/source/_integrations/proximity.markdown
index 083e7a79101..a2d4f4178f7 100644
--- a/source/_integrations/proximity.markdown
+++ b/source/_integrations/proximity.markdown
@@ -3,7 +3,7 @@ title: Proximity
description: Instructions on how to setup Proximity monitoring within Home Assistant.
ha_category:
- Automation
- - Presence Detection
+ - Presence detection
ha_release: 0.13
ha_quality_scale: internal
ha_domain: proximity
@@ -52,7 +52,7 @@ proximity:
unit_of_measurement: mi
```
-### Video Tutorial
+### Video tutorial
This video tutorial explains how to set up geofencing in Home Assistant using the proximity integration.
diff --git a/source/_integrations/proxmoxve.markdown b/source/_integrations/proxmoxve.markdown
index a662ac5b4ab..98545d12adc 100644
--- a/source/_integrations/proxmoxve.markdown
+++ b/source/_integrations/proxmoxve.markdown
@@ -2,7 +2,7 @@
title: Proxmox VE
description: Access your ProxmoxVE instance in Home Assistant.
ha_category:
- - Binary Sensor
+ - Binary sensor
ha_release: 0.103
ha_iot_class: Local Polling
ha_codeowners:
@@ -103,7 +103,7 @@ proxmoxve:
- VM_ID_2
```
-## Binary Sensor
+## Binary sensor
The integration will automatically create a binary sensor for each tracked virtual machine or container. The binary sensor will either be on if the VM's state is running or off if the VM's state is different.
diff --git a/source/_integrations/prusalink.markdown b/source/_integrations/prusalink.markdown
index f9c090fd6c8..d4453e1bd3c 100644
--- a/source/_integrations/prusalink.markdown
+++ b/source/_integrations/prusalink.markdown
@@ -2,7 +2,7 @@
title: PrusaLink
description: Instructions on monitoring Prusa 3D printers using PrusaLink.
ha_category:
- - 3D Printing
+ - 3D printing
ha_iot_class: Local Polling
ha_release: '2022.9'
ha_config_flow: true
@@ -20,8 +20,16 @@ ha_dhcp: true
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 and Prusa MK4.
This integration requires PrusaLink v2. If you have the Prusa MINI, you need to run firmware 4.4.0 or later.
-To obtain the API key:
- - On your printer, navigate to **Settings** > **Network** > **PrusaLink**.
- - The API key is shown at the bottom of the screen.
+When adding the integration, you will be asked to provide a {% term host %} and an API key. These are the credentials you set up when setting up PrusaLink on your printer.
+
+To obtain the host name and API key/password:
+
+ - 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.
+ - Depending on your model, the entry may not be called **API key**, but **Password**.
{% include integrations/config_flow.md %}
+
+## Related topics
+
+- [PrusaLink documentation](https://help.prusa3d.com/article/prusa-connect-and-prusalink-explained_302608)
\ No newline at end of file
diff --git a/source/_integrations/ps4.markdown b/source/_integrations/ps4.markdown
index 2b49e2da2a5..935361aef43 100644
--- a/source/_integrations/ps4.markdown
+++ b/source/_integrations/ps4.markdown
@@ -2,7 +2,7 @@
title: Sony PlayStation 4
description: Instructions on how to integrate a Sony PlayStation 4 into Home Assistant.
ha_category:
- - Media Player
+ - Media player
ha_release: 0.89
ha_config_flow: true
ha_iot_class: Local Polling
diff --git a/source/_integrations/python_script.markdown b/source/_integrations/python_script.markdown
index 351d5c40f21..0ccc00e16a2 100644
--- a/source/_integrations/python_script.markdown
+++ b/source/_integrations/python_script.markdown
@@ -105,7 +105,7 @@ context:
user_id: null
```
-## Calling Services
+## Calling services
The following example shows how to call a service from `python_script`. This script takes two parameters: `entity_id` (required), `rgb_color` (optional) and calls `light.turn_on` service by setting the brightness value to `255`.
diff --git a/source/_integrations/qingping.markdown b/source/_integrations/qingping.markdown
index 7a502ec9dd4..cf2854f69a6 100644
--- a/source/_integrations/qingping.markdown
+++ b/source/_integrations/qingping.markdown
@@ -2,7 +2,7 @@
title: Qingping
description: Instructions on how to integrate Qingping devices into Home Assistant.
ha_category:
- - Binary Sensor
+ - Binary sensor
- Sensor
ha_bluetooth: true
ha_release: 2022.9
diff --git a/source/_integrations/qld_bushfire.markdown b/source/_integrations/qld_bushfire.markdown
index 392337c7fa3..38b9843c281 100644
--- a/source/_integrations/qld_bushfire.markdown
+++ b/source/_integrations/qld_bushfire.markdown
@@ -72,7 +72,7 @@ longitude:
{% endconfiguration %}
-## State Attributes
+## State attributes
The following state attributes are available for each entity in addition to
the standard ones:
@@ -88,7 +88,7 @@ the standard ones:
| updated_date | Date and time when this alert was last updated. |
| status | Status of the alert, for example, "Patrolled", "Going", "Contained" |
-## Full Configuration
+## Full configuration
```yaml
# Example configuration.yaml entry
diff --git a/source/_integrations/qnap.markdown b/source/_integrations/qnap.markdown
index aab6e2b1030..13cea2e3faf 100644
--- a/source/_integrations/qnap.markdown
+++ b/source/_integrations/qnap.markdown
@@ -2,7 +2,7 @@
title: QNAP
description: Instructions on how to integrate the QNAP sensor within Home Assistant.
ha_category:
- - System Monitor
+ - System monitor
ha_release: 0.38
ha_iot_class: Local Polling
ha_domain: qnap
diff --git a/source/_integrations/qnap_qsw.markdown b/source/_integrations/qnap_qsw.markdown
index e5d2c43d4e5..325e82eb61e 100644
--- a/source/_integrations/qnap_qsw.markdown
+++ b/source/_integrations/qnap_qsw.markdown
@@ -3,7 +3,7 @@ title: QNAP QSW
description: Instructions on how to integrate QNAP QSW within Home Assistant.
ha_release: 2022.5
ha_category:
- - Binary Sensor
+ - Binary sensor
- Button
- Sensor
- Update
@@ -35,17 +35,17 @@ Password:
description: "Password"
{% endconfiguration_basic %}
-## Binary Sensors
+## Binary sensors
The following *binary sensors* are created:
-| Binary Sensor | Description |
+| Binary sensor | Description |
| :------------------ | :--------------------------------- |
| anomaly | Device anomaly. |
The following *binary sensors* are created for each port (or LACP):
-| Binary Sensor | Description |
+| Binary sensor | Description |
| :------------------ | :--------------------------------- |
| link | Link status. |
diff --git a/source/_integrations/qrcode.markdown b/source/_integrations/qrcode.markdown
index 5e8f4bf0ec3..1067d3d0063 100644
--- a/source/_integrations/qrcode.markdown
+++ b/source/_integrations/qrcode.markdown
@@ -2,7 +2,7 @@
title: QR Code
description: Instructions on how to integrate QR Code Recognition into Home Assistant.
ha_category:
- - Image Processing
+ - Image processing
ha_iot_class: Calculated
ha_release: 0.87
ha_domain: qrcode
diff --git a/source/_integrations/quadrafire.markdown b/source/_integrations/quadrafire.markdown
index 34629ce95c1..54b545e185a 100644
--- a/source/_integrations/quadrafire.markdown
+++ b/source/_integrations/quadrafire.markdown
@@ -2,7 +2,7 @@
title: Quadra-Fire
description: Connect and control your Quadra-Fire devices using the IntelliFire integration
ha_category:
- - Binary Sensor
+ - Binary sensor
- Climate
- Fan
- Light
diff --git a/source/_integrations/quantum_gateway.markdown b/source/_integrations/quantum_gateway.markdown
index 0dbf6170293..83f2c46a026 100644
--- a/source/_integrations/quantum_gateway.markdown
+++ b/source/_integrations/quantum_gateway.markdown
@@ -2,7 +2,7 @@
title: Quantum Gateway
description: Instructions on how to integrate Quantum Gateways into Home Assistant.
ha_category:
- - Presence Detection
+ - Presence detection
ha_iot_class: Local Polling
ha_release: 0.81
ha_codeowners:
diff --git a/source/_integrations/qwikswitch.markdown b/source/_integrations/qwikswitch.markdown
index 8a05e5e815c..3bc81b8c019 100644
--- a/source/_integrations/qwikswitch.markdown
+++ b/source/_integrations/qwikswitch.markdown
@@ -2,7 +2,7 @@
title: QwikSwitch QSUSB
description: Instructions on how to integrate the QwikSwitch QSUSB Hub into Home Assistant.
ha_category:
- - Binary Sensor
+ - Binary sensor
- Hub
- Light
- Sensor
@@ -24,7 +24,7 @@ The `qwikswitch` integration is the main integration to integrate various [QwikS
There is currently support for the following device types within Home Assistant:
-- Binary Sensor
+- Binary sensor
- Light
- [Sensor](#qwikswitch-sensors)
- [Switch](#switch)
@@ -121,7 +121,7 @@ The list of recognized commands can be extended for Keyfobs, door sensors, and P
On some QS Mobile servers button events are only generated for switches added to the QS Mobile application, so it might be best to test button presses through the `/&listen` API
-### Qwikswitch Sensors
+### Qwikswitch sensors
The sensor configuration is a list of sensors. Depending on the type of sensor, it will be a sensor or binary_sensor.
diff --git a/source/_integrations/rachio.markdown b/source/_integrations/rachio.markdown
index 02a085af7f2..0f33473fcc8 100644
--- a/source/_integrations/rachio.markdown
+++ b/source/_integrations/rachio.markdown
@@ -2,7 +2,7 @@
title: Rachio
description: Instructions on how to use Rachio with Home Assistant.
ha_category:
- - Binary Sensor
+ - Binary sensor
- Irrigation
- Switch
ha_iot_class: Cloud Push
@@ -24,7 +24,7 @@ The `rachio` platform allows you to control your [Rachio irrigation system](http
There is currently support for the following device types within Home Assistant:
-- **Binary Sensor** - Allows you to view the status of your [Rachio irrigation system](https://rachio.com/).
+- **Binary sensor** - Allows you to view the status of your [Rachio irrigation system](https://rachio.com/).
- [**Switch**](#switch)
They will be automatically added if the Rachio integration is loaded.
diff --git a/source/_integrations/radarr.markdown b/source/_integrations/radarr.markdown
index 0ce5e788127..9d1ddd1ec05 100644
--- a/source/_integrations/radarr.markdown
+++ b/source/_integrations/radarr.markdown
@@ -20,7 +20,7 @@ Your API key can be found in Settings > General in the Radarr Web UI.
{% include integrations/config_flow.md %}
-## Integration Entities
+## Integration entities
Each added configuration entry will create the following binary sensor:
diff --git a/source/_integrations/radio_browser.markdown b/source/_integrations/radio_browser.markdown
index 57c8216387c..ed98de91712 100644
--- a/source/_integrations/radio_browser.markdown
+++ b/source/_integrations/radio_browser.markdown
@@ -2,7 +2,7 @@
title: Radio Browser
description: Instructions on how to integrate Radio Browser into Home Assistant.
ha_category:
- - Media Source
+ - Media source
- Multimedia
ha_release: 2022.3
ha_iot_class: Cloud Polling
diff --git a/source/_integrations/rainbird.markdown b/source/_integrations/rainbird.markdown
index f4cefff0abd..1b7878599e2 100644
--- a/source/_integrations/rainbird.markdown
+++ b/source/_integrations/rainbird.markdown
@@ -2,7 +2,7 @@
title: Rain Bird
description: Instructions on how to integrate your Rain Bird LNK WiFi Module within Home Assistant.
ha_category:
- - Binary Sensor
+ - Binary sensor
- Calendar
- Irrigation
- Sensor
@@ -27,19 +27,19 @@ This `rainbird` integration allows interacting with [LNK WiFi](https://www.rainb
There is currently support for the following device types within Home Assistant:
-- [Binary Sensor](#binary-sensor)
+- [Binary sensor](#binary-sensor)
- [Calendar](#calendar)
- [Number](#number)
- [Switch](#switch)
{% include integrations/config_flow.md %}
-## Configuration Options
+## Configuration options
The integration has a configuration option to change the default amount of time that the irrigation
will run when turning on a zone switch (default is 6 minutes). This can be overridden with a service call (see below).
-## Binary Sensor
+## Binary sensor
The `rainsensor` sensor will tell if you if the device has detected rain.
diff --git a/source/_integrations/raincloud.markdown b/source/_integrations/raincloud.markdown
index 0659514399e..599f559785d 100644
--- a/source/_integrations/raincloud.markdown
+++ b/source/_integrations/raincloud.markdown
@@ -2,7 +2,7 @@
title: Melnor RainCloud
description: Instructions on how to integrate your Melnor Raincloud sprinkler system within Home Assistant.
ha_category:
- - Binary Sensor
+ - Binary sensor
- Irrigation
- Sensor
- Switch
@@ -22,7 +22,7 @@ The `raincloud` integration allows you to integrate your [Melnor RainCloud](http
There is currently support for the following device types within Home Assistant:
-- [Binary Sensor](#binary-sensor)
+- [Binary sensor](#binary-sensor)
- [Sensor](#sensor)
- [Switch](#switch)
@@ -48,7 +48,7 @@ password:
type: string
{% endconfiguration %}
-## Binary Sensor
+## Binary sensor
Once you have enabled the [Raincloud integration](#configuration), add the following to your `configuration.yaml` file:
diff --git a/source/_integrations/rainmachine.markdown b/source/_integrations/rainmachine.markdown
index ac2170dbf04..0352f24fc38 100644
--- a/source/_integrations/rainmachine.markdown
+++ b/source/_integrations/rainmachine.markdown
@@ -2,7 +2,7 @@
title: RainMachine
description: Instructions on how to integrate RainMachine units within Home Assistant.
ha_category:
- - Binary Sensor
+ - Binary sensor
- Irrigation
- Sensor
- Switch
@@ -30,7 +30,7 @@ The RainMachine integration is the main integration to integrate all platforms r
There is currently support for the following device types within Home Assistant:
-- Binary Sensor
+- Binary sensor
- Button
- Sensor
- [Switch](#switch)
diff --git a/source/_integrations/random.markdown b/source/_integrations/random.markdown
index 5760ee0cae4..d823cb77c16 100644
--- a/source/_integrations/random.markdown
+++ b/source/_integrations/random.markdown
@@ -2,7 +2,7 @@
title: Random
description: Instructions on how to integrate random numbers into Home Assistant.
ha_category:
- - Binary Sensor
+ - Binary sensor
- Helper
- Sensor
- Utility
diff --git a/source/_integrations/rdw.markdown b/source/_integrations/rdw.markdown
index 20883675d87..5669f9c7f17 100644
--- a/source/_integrations/rdw.markdown
+++ b/source/_integrations/rdw.markdown
@@ -2,7 +2,7 @@
title: RDW
description: Instructions on how to integrate RDW vehicle information with Home Assistant.
ha_category:
- - Binary Sensor
+ - Binary sensor
- Car
- Sensor
ha_release: 2021.12
diff --git a/source/_integrations/recorder.markdown b/source/_integrations/recorder.markdown
index 9df854590ff..c562b77522f 100644
--- a/source/_integrations/recorder.markdown
+++ b/source/_integrations/recorder.markdown
@@ -32,6 +32,12 @@ Although SQLAlchemy supports database solutions in addition to the ones supporte
The default, and recommended, database engine is [SQLite](https://www.sqlite.org/) which does not require any configuration. The database is stored in your Home Assistant configuration directory ('/config/') and is named `home-assistant_v2.db`.
+
+
+Changing database used by the recorder may result in losing your existing history. Migrating data is not supported.
+
+
+
To change the defaults for the `recorder` integration in your installation, add the following to your `configuration.yaml` file:
```yaml
@@ -119,7 +125,7 @@ recorder:
type: list
{% endconfiguration %}
-## Configure Filter
+## Configure filter
By default, no entity will be excluded. To limit which entities are being exposed to `recorder`, you can use the `include` and `exclude` parameters.
diff --git a/source/_integrations/remote_rpi_gpio.markdown b/source/_integrations/remote_rpi_gpio.markdown
index e43f9f3ed71..942e228a565 100644
--- a/source/_integrations/remote_rpi_gpio.markdown
+++ b/source/_integrations/remote_rpi_gpio.markdown
@@ -2,7 +2,7 @@
title: Raspberry Pi Remote GPIO
description: Instructions on how to integrate the GPIO capability of a remote Raspberry Pi into Home Assistant.
ha_category:
- - Binary Sensor
+ - Binary sensor
- DIY
- Switch
ha_release: 0.94
@@ -22,7 +22,7 @@ Note that for virtual environments, you may need to set an environment variable
`Environment = GPIOZERO_PIN_FACTORY=pigpio PIGPIO_ADDR=YOUR_RPi_IP_ADDRESS`
-## Binary Sensor
+## Binary sensor
The `remote_rpi_gpio` binary sensor platform allows you to read sensor values of the GPIOs of a remote [Raspberry Pi](https://www.raspberrypi.org/).
diff --git a/source/_integrations/renault.markdown b/source/_integrations/renault.markdown
index 015f8e45e20..97e0dce72c8 100644
--- a/source/_integrations/renault.markdown
+++ b/source/_integrations/renault.markdown
@@ -2,9 +2,9 @@
title: Renault
description: Instructions on how to integrate Renault car into Home Assistant.
ha_category:
- - Binary Sensor
+ - Binary sensor
- Car
- - Presence Detection
+ - Presence detection
- Select
- Sensor
ha_release: 2021.8
diff --git a/source/_integrations/renson.markdown b/source/_integrations/renson.markdown
index 02574e6e9a5..7ddb7384c16 100644
--- a/source/_integrations/renson.markdown
+++ b/source/_integrations/renson.markdown
@@ -2,7 +2,7 @@
title: Renson
description: Instructions on how to integrate Renson Endura Delta sensors into Home Assistant.
ha_category:
- - Binary Sensor
+ - Binary sensor
- Button
- Fan
- Number
diff --git a/source/_integrations/reolink.markdown b/source/_integrations/reolink.markdown
index 32854378bd5..0303c750e27 100644
--- a/source/_integrations/reolink.markdown
+++ b/source/_integrations/reolink.markdown
@@ -29,7 +29,7 @@ The integration allows you to control [Reolink](https://reolink.com/) NVRs or ca
{% include integrations/config_flow.md %}
-A Reolink user account with admin privileges is needed for the proper operation of this integration.
+On the Reolink device, a user account with admin privileges is needed for the proper operation of this integration.
{% include integrations/option_flow.md %}
{% configuration_basic %}
@@ -94,13 +94,13 @@ Depending on the supported features of the camera, number entities are added for
- Auto track stop time
- Day night switch threshold*
-"Floodlight turn on brightness" controls the brightness of the floodlight when it is turned on internally by the camera (see "Floodlight mode" select entity) or when using the "Floodlight" light entity.
+**Floodlight turn on brightness** controls the brightness of the floodlight when it is turned on internally by the camera (see **Floodlight mode** select entity) or when using the **Floodlight** light entity.
-When the camera is not moved and no person/pet/animal/vehicle is detected for the "Guard return time" in seconds, and the "Guard return" switch is ON, the camera will move back to the guard position.
+When the camera is not moved and no person/pet/animal/vehicle is detected for the **Guard return time** in seconds, and the **Guard return** switch is ON, the camera will move back to the guard position.
-When a Reolink doorbell is pressed the quick reply message from the "Auto quick reply message" select entity will be played after "Auto quick reply time" seconds, unless the "Auto quick reply message" is set to off.
+When a Reolink doorbell is pressed the quick reply message from the **Auto quick reply message** select entity will be played after **Auto quick reply time** seconds, unless the **Auto quick reply message** is set to off.
-If the "Auto tracking" switch entity is enabled, and a object disappears from view OR stops moving for the "Auto track disappear time"/"Auto track stop time", the camera goes back to its original position.
+If the **Auto tracking** switch entity is enabled, and a object disappears from view OR stops moving for the **Auto track disappear time**/**Auto track stop time**, the camera goes back to its original position.
**Day night switch threshold** determines at which light level the camera switches from **Color** to **Black & white**. This value only applies if the **Day night mode** select is on **Auto**.
@@ -108,7 +108,7 @@ If the "Auto tracking" switch entity is enabled, and a object disappears from vi
Depending on the supported features of the camera, button entities are added for:
-- PTZ stop
+- PTZ stop
- PTZ left
- PTZ right
- PTZ up
@@ -120,9 +120,9 @@ Depending on the supported features of the camera, button entities are added for
- Guard set current position
- Restart*
-PTZ left, right, up, down, zoom in and zoom out will continually move the camera in the respective position until the PTZ stop is called or the hardware limit is reached.
+**PTZ left**, **right**, **up**, **down**, **zoom in** and **zoom out** will continually move the camera in the respective position until the **PTZ stop** is called or the hardware limit is reached.
-"Guard set current position" will set the current position as the new guard position.
+**Guard set current position** will set the current position as the new guard position.
### Service reolink.ptz_move
@@ -139,14 +139,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
+- PTZ preset
- 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.
+**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.
+**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.
## Siren entities
@@ -172,7 +172,7 @@ Depending on the supported features of the camera, switch entities are added for
- FTP upload
- HDR*
-For NVRs, a global switch for Record, Push, Buzzer, Email, and FTP will be available under the NVR device as well as a switch per channel of the NVR under the camera device. The respective feature will only be active for a given channel if both the global and that channel switch are enabled (as is also the case in the Reolink app/client).
+For NVRs, a global switch for **Record**, **Push**, **Buzzer**, **Email**, and **FTP** will be available under the NVR device as well as a switch per channel of the NVR under the camera device. The respective feature will only be active for a given channel if both the global and that channel switch are enabled (as is also the case in the Reolink app/client).
## Light entities
@@ -182,9 +182,9 @@ Depending on the supported features of the camera, light entities are added for:
- Infra red lights in night mode
- Status LED
-When the floodlight entity is ON always ON, when OFF controlled based on the internal camera floodlight mode (Off, Auto, Schedule), see the "Floodlight mode" select entity.
+When the **floodlight** entity is ON always ON, when OFF controlled based on the internal camera floodlight mode (Off, Auto, Schedule), see the **Floodlight mode** select entity.
-When IR light entity is OFF always OFF, when ON IR LEDs will be on when the camera is in night vision mode, see the "Day night mode" select entity.
+When **IR light** entity is OFF always OFF, when ON IR LEDs will be on when the camera is in night vision mode, see the **Day night mode** select entity.
## Sensor entities
@@ -257,22 +257,30 @@ However, these cameras can work with this integration through an NVR in which th
- E1
- Reolink Lumus
-## Initial Setup
+## Initial setup
A brand new Reolink camera first needs to be connected to the network and initialized. During initialization, the credentials for the camera need to be set.
-There are serveral ways to achieve this.
+There are several ways to achieve this.
-### Reolink app/client
+### Connecting Reolink via app/client
-The recommended way is to use the [Reolink mobile app, Windows, or Mac client](https://reolink.com/software-and-manual/). Follow the on-screen instructions. In Home Assistant, use the credentials you just configured in the Reolink app/client.
+The recommended way is to use the [Reolink mobile app, Windows, or Mac client](https://reolink.com/software-and-manual/).
-### Web browser
+1. Follow the on-screen instructions.
+2. In Home Assistant, use the credentials you just configured in the Reolink app/client.
-When your camera has a LAN port (most Wi-Fi cameras also have a LAN port), first connect the camera to your network using a LAN cable.
-Find the IP address of the camera (for example by checking in your router) and go to the IP address in a web browser.
-Follow the on-screen instructions to first setup the credentials (use the same credentials in Home Assistant).
-If it is a Wi-Fi camera, go to **settings** (gear icon) > **Network** and fill in your Wi-Fi SSID and password. After that you can disconnect the LAN cable and the camera will automatically switch to the Wi-Fi connection.
-Now set up the Reolink Home Assistant integration using the credentials you just specified.
+### Connecting Reolink via a web browser
+
+When your camera has a LAN port (most Wi-Fi cameras also have a LAN port):
+
+ 1. First connect the camera to your network using a LAN cable.
+ 2. Find the IP address of the camera (for example by checking in your router) and go to the IP address in a web browser.
+ 3. Follow the on-screen instructions to first setup the credentials (use the same credentials in Home Assistant).
+ 4. If it is a Wi-Fi camera:
+ - Go to **settings** (gear icon) > **Network** and fill in your Wi-Fi SSID and password.
+ - If you have both a 2.4 GHz and 5 GHz network, check your camera's user guide to see which operating frequency is supported.
+ - After that you can disconnect the LAN cable and the camera will automatically switch to the Wi-Fi connection.
+ 5. Now set up the Reolink Home Assistant integration using the credentials you just specified.
### QR code
@@ -287,10 +295,15 @@ Normally, the digits are printed directly under the QR code. Alternatively, you
Then power up the camera while pointing it at the QR code. It takes about a minute to initialize, read the QR code, and connect to your Wi-Fi.
+## Showing the camera in the dashboard
+
+1. One way to show the camera in the dashboard is by using the picture glance card.
+2. For example, you can place arrow buttons on the card to [control the camera](/dashboards/picture-glance/#creating-a-card-to-control-the-camera).
+
## Troubleshooting
- Older firmware versions do not expose the necessary information the integration needs to function. Ensure the camera is updated to the [latest firmware](https://reolink.com/download-center/) prior to setting up the integration. Note that Reolink auto update and check for update functions in the app/windows/web client often do not show the latest available firmware version. Therefore check the version in the [Reolink download center](https://reolink.com/download-center/) online.
-- Ensure at least one of the HTTP/HTTPS ports is enabled in the [windows](https://reolink.com/software-and-manual/)/web client under `Settings`->`Network`->`Advanced`->`Port Settings`, see [additional instructions](https://support.reolink.com/hc/en-us/articles/900004435763-How-to-Set-up-Reolink-Ports-Settings-via-Reolink-Client-New-Client-) on the Reolink site.
+- Ensure at least one of the HTTP/HTTPS ports is enabled in the [windows](https://reolink.com/software-and-manual/)/web client under **Settings** > **Network** > **Advanced** > **Port Settings**, see [additional instructions](https://support.reolink.com/hc/en-us/articles/900004435763-How-to-Set-up-Reolink-Ports-Settings-via-Reolink-Client-New-Client-) on the Reolink site.
- On some camera models, the RTMP port needs to be enabled in order for the HTTP(S) port to function properly. Make sure this port is also enabled if you get a `Cannot connect to host` error while one of the HTTP/HTTPS ports is already enabled.
- Setting a static IP address for Reolink cameras/NVRs in your router is advisable to prevent (temporal) connectivity issues when the IP address changes.
- Do not set a static IP in the Reolink device itself, but leave the **Connection Type** on **DHCP** under **Settings** > **Network** > **Network Information** > **Set Up**. If you set it to **static** on the Reolink device itself, this is known to cause incorrect DHCP requests on the network. The incorrect DHCP request causes Home Assistant to use the wrong IP address for the camera, resulting in connection issues. The issue originates from the Reolink firmware, which keeps sending DCHP requests even when you set a static IP address in the Reolink device.
@@ -304,10 +317,15 @@ However, ONVIF push has some additional network configuration requirements:
- Reolink products can not push motion events to an HTTPS address (SSL).
Therefore, make sure a (local) HTTP address at which HA is reachable is configured under **Home Assistant URL** in the {% my network title="network settings" %}.
-A valid address could, for example, be `http://192.168.1.10:8123` where `192.168.1.10` is the IP of the Home Assistant device".
+A valid address could, for example, be `http://192.168.1.10:8123` where `192.168.1.10` is the IP of the Home Assistant device.
- Since a HTTP address is needed, Reolink push is incompatible with a global SSL certificate.
Therefore, ensure no Global SSL certificate is configured in the [`configuration.yaml` under HTTP](/integrations/http/#ssl_certificate).
An SSL certificate can still be enforced for external connections, by, for instance, using the [NGINX add-on](https://github.com/home-assistant/addons/tree/master/nginx_proxy) or [NGINX Proxy Manager add-on](https://github.com/hassio-addons/addon-nginx-proxy-manager) instead of a globally enforced SSL certificate.
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/rest.markdown b/source/_integrations/rest.markdown
index 9b2711d8747..418ae085524 100644
--- a/source/_integrations/rest.markdown
+++ b/source/_integrations/rest.markdown
@@ -2,7 +2,7 @@
title: RESTful
description: Instructions on how to integrate REST sensors and binary sensors into Home Assistant.
ha_category:
- - Binary Sensor
+ - Binary sensor
- Sensor
ha_release: 0.7.4
ha_iot_class: Local Polling
diff --git a/source/_integrations/rexel.markdown b/source/_integrations/rexel.markdown
index 540f84a8277..6eb06749944 100644
--- a/source/_integrations/rexel.markdown
+++ b/source/_integrations/rexel.markdown
@@ -3,7 +3,7 @@ title: Rexel Energeasy Connect
description: Connect and control your Rexel Energeasy Connect devices using the Overkiz integration
ha_category:
- Alarm
- - Binary Sensor
+ - Binary sensor
- Button
- Climate
- Cover
@@ -16,7 +16,7 @@ ha_category:
- Sensor
- Siren
- Switch
- - Water Heater
+ - Water heater
ha_domain: rexel
ha_integration_type: virtual
ha_supporting_domain: overkiz
diff --git a/source/_integrations/rfxtrx.markdown b/source/_integrations/rfxtrx.markdown
index a0f82ccb5ac..dee985fed74 100644
--- a/source/_integrations/rfxtrx.markdown
+++ b/source/_integrations/rfxtrx.markdown
@@ -2,7 +2,7 @@
title: RFXCOM RFXtrx
description: Instructions on how to integrate RFXtrx into Home Assistant.
ha_category:
- - Binary Sensor
+ - Binary sensor
- Cover
- Hub
- Light
@@ -36,7 +36,7 @@ There is currently support for the following device types within Home Assistant:
- [Light](#lights)
- [Switch](#switches)
- [Sensor](#sensors)
-- [Binary Sensor](#binary-sensors)
+- [Binary sensor](#binary-sensors)
- [Siren](#sirens)
{% include integrations/config_flow.md %}
@@ -116,7 +116,7 @@ The RFXtrx integration support sensors that communicate in the frequency range o
Also, several switches and other devices will also expose sensor entities with battery status as well as the signal level.
-#### Binary Sensors
+#### Binary sensors
The RFXtrx integration support binary sensors that communicate in the frequency range of 433.92 MHz. The RFXtrx binary sensor integration provides support for them. Many cheap sensors available on the web today are based on a particular RF chip called *PT-2262*. Depending on the running firmware on the RFXcom box, some of them may be recognized under the X10 protocol, but most of them are recognized under the *Lighting4* protocol. The RFXtrx binary sensor integration provides some special options for them, while other RFXtrx protocols should work too.
@@ -174,7 +174,7 @@ To configure device options, select a device from the list under *Select device
If a device is missing from the list, close the options window and either make sure the device sents a command or manually re-add the device by event code.
-#### Off Delay
+#### Off delay
Binary sensors have only two states - "on" and "off". Many door or window opening sensors will send a signal each time the door/window is open or closed. However, depending on their hardware or on their purpose, some sensors are only able to signal their "on" state:
diff --git a/source/_integrations/ridwell.markdown b/source/_integrations/ridwell.markdown
index 4f07405fb97..8a726b2d396 100644
--- a/source/_integrations/ridwell.markdown
+++ b/source/_integrations/ridwell.markdown
@@ -21,7 +21,7 @@ The Ridwell integration allows users to track waste recycling pickups scheduled
{% include integrations/config_flow.md %}
-## Pickup Types
+## Pickup types
The pickup sensor contains a `pickup_types` state attribute, which contains:
diff --git a/source/_integrations/ring.markdown b/source/_integrations/ring.markdown
index 3558c13a40b..1a0874e0b33 100644
--- a/source/_integrations/ring.markdown
+++ b/source/_integrations/ring.markdown
@@ -2,7 +2,7 @@
title: Ring
description: Instructions on how to integrate your Ring.com devices within Home Assistant.
ha_category:
- - Binary Sensor
+ - Binary sensor
- Camera
- Doorbell
- Light
@@ -27,7 +27,7 @@ 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)
+- [Binary sensor](#binary-sensor)
- [Camera](#camera)
- [Sensor](#sensor)
- [Switch](#switch)
@@ -38,7 +38,7 @@ This integration does NOT allow for live viewing of your Ring camera within Home
{% include integrations/config_flow.md %}
-## Binary Sensor
+## Binary sensor
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.
diff --git a/source/_integrations/risco.markdown b/source/_integrations/risco.markdown
index b94f8735bdb..87cee3d8391 100644
--- a/source/_integrations/risco.markdown
+++ b/source/_integrations/risco.markdown
@@ -3,7 +3,7 @@ title: Risco
description: Instructions on how to integrate Risco alarms into HA using Risco Cloud.
ha_category:
- Alarm
- - Binary Sensor
+ - Binary sensor
- Switch
ha_release: '0.115'
ha_iot_class: Local Push
@@ -22,7 +22,7 @@ ha_integration_type: integration
This integration connects with Risco Alarms, in one of two ways:
-## Risco Cloud (recommended)
+## Risco cloud (recommended)
The integration will connect with your alarm over [Risco Cloud](https://riscocloud.com/).
This is easiest to configure, and is widely supported, but is cloud based, and requires polling.
@@ -89,9 +89,9 @@ And in the reverse direction:
| Arm Away | Arm |
| Arm Home | Partial Arm |
-## Supported Platforms:
+## Supported platforms:
-- [Alarm Control Panel](/integrations/alarm_control_panel/)
-- [Binary Sensor](/integrations/binary_sensor/)
+- [Alarm control panel](/integrations/alarm_control_panel/)
+- [Binary sensor](/integrations/binary_sensor/)
- [Sensor](/integrations/sensor/)
- [Switch](/integrations/switch/)
diff --git a/source/_integrations/rituals_perfume_genie.markdown b/source/_integrations/rituals_perfume_genie.markdown
index 9197c2bf208..d5ac16b5233 100644
--- a/source/_integrations/rituals_perfume_genie.markdown
+++ b/source/_integrations/rituals_perfume_genie.markdown
@@ -5,7 +5,7 @@ ha_iot_class: Cloud Polling
ha_config_flow: true
ha_release: 2021.3
ha_category:
- - Binary Sensor
+ - Binary sensor
- Number
- Select
- Sensor
diff --git a/source/_integrations/roborock.markdown b/source/_integrations/roborock.markdown
index 47b7a366939..f224ff86816 100644
--- a/source/_integrations/roborock.markdown
+++ b/source/_integrations/roborock.markdown
@@ -2,7 +2,7 @@
title: Roborock
description: Instructions on how to integrate Roborock vacuums into Home Assistant
ha_category:
- - Binary Sensor
+ - Binary sensor
- Button
- Image
- Number
@@ -159,10 +159,11 @@ We plan to make the process simpler in the future, but for now, it is a multi-st
2. [Enable debug logging](/docs/configuration/troubleshooting/#enabling-debug-logging) for this integration and reload it.
3. Search your logs for 'Got home data' and find the attribute rooms.
4. Write the rooms down; they have a name and 6 digit ID.
-5. Go to {% my developer_call_service service="vacuum.send_command" title="**Developer Tools** > **Services** > **Vacuum: Send Command**" %}. Select your vacuum as the entity and `get_room_mapping` as the command.
-6. Go back to your logs and look at the response to `get_room_mapping`. This is a list of the 6-digit IDs you saw earlier to 2-digit IDs (use the first number, for instance `16` in `[16, '14000663', 12]` ([internal room id, unique room id, room type])). In your original list of room names and 6-digit IDs, replace the 6-digit ID with its pairing 2-digit ID.
-7. Now, you have the 2-digit ID that your vacuum uses to describe a room.
-8. Go back to {% my developer_call_service service="vacuum.send_command" title="**Developer Tools** > **Services** > **Vacuum: Send Command**" %} then type `app_segment_clean` as your command and `segments` with a list of the 2-digit IDs you want to clean. Then, add `repeat` with a number (ranging from 1 to 3) to determine how many times you want to clean these areas.
+5. Make sure the map you want the room IDs for is selected in your app. Room IDs are non-unique and will repeat if you have multiple maps.
+6. Go to {% my developer_call_service service="vacuum.send_command" title="**Developer Tools** > **Services** > **Vacuum: Send Command**" %}. Select your vacuum as the entity and `get_room_mapping` as the command.
+7. Go back to your logs and look at the response to `get_room_mapping`. This is a list of the 6-digit IDs you saw earlier to 2-digit IDs (use the first number, for instance `16` in `[16, '14000663', 12]` ([internal room id, unique room id, room type])). In your original list of room names and 6-digit IDs, replace the 6-digit ID with its pairing 2-digit ID.
+8. Now, you have the 2-digit ID that your vacuum uses to describe a room.
+9. Go back to {% my developer_call_service service="vacuum.send_command" title="**Developer Tools** > **Services** > **Vacuum: Send Command**" %} then type `app_segment_clean` as your command and `segments` with a list of the 2-digit IDs you want to clean. Then, add `repeat` with a number (ranging from 1 to 3) to determine how many times you want to clean these areas.
Example:
```yaml
diff --git a/source/_integrations/roku.markdown b/source/_integrations/roku.markdown
index d92b31ac29c..b00890dd64e 100644
--- a/source/_integrations/roku.markdown
+++ b/source/_integrations/roku.markdown
@@ -2,9 +2,9 @@
title: Roku
description: Instructions how to integrate Roku devices into Home Assistant.
ha_category:
- - Binary Sensor
+ - Binary sensor
- Hub
- - Media Player
+ - Media player
- Remote
- Select
- Sensor
@@ -31,9 +31,11 @@ The Roku integration allows you to control a [Roku](https://www.roku.com/) devic
{% include integrations/config_flow.md %}
+When adding the integration, you will be asked to provide a {% term host %}. Unless you changed the hostname, this refers to the IP address of your Roku device. You can find the IP address or hostname in the network settings of your Roku device, by checking your router, or by using a network scanning tool.
+
There is currently support for the following device types within Home Assistant:
-- Media Player
+- Media player
- Remote
## Remote
@@ -85,7 +87,7 @@ data:
- select
```
-## Media Player
+## Media player
When the Home Assistant Roku integration is enabled and a Roku device has been configured, in the Home Assistant UI the Roku media player will show a listing of the installed channels, or apps, under “source”. Select one and it will attempt to launch the channel on your Roku device.
diff --git a/source/_integrations/roomba.markdown b/source/_integrations/roomba.markdown
index 10b5a00cba1..89b2b539083 100644
--- a/source/_integrations/roomba.markdown
+++ b/source/_integrations/roomba.markdown
@@ -22,7 +22,7 @@ ha_integration_type: integration
ha_zeroconf: true
---
-The `roomba` integration allows you to control your [iRobot Roomba](https://www.irobot.com/roomba) vacuum or [iRobot Braava](https://www.irobot.com/braava) m-series mop.
+The **Roomba** {% term integrations %} allows you to control your [iRobot Roomba](https://www.irobot.com/roomba) vacuum or [iRobot Braava](https://www.irobot.com/braava) m-series mop.
@@ -30,7 +30,7 @@ The `roomba` integration allows you to control your [iRobot Roomba](https://www.
-This integration has been tested and confirmed to be working with the iRobot Roomba s9+, Roomba 980, Roomba 960, Roomba 890, and Braava jet m6 models, but should also work fine with any Wi-Fi enabled Roomba or Braava like the 690. For auto-discovery, you will need to initiate a Roomba reboot. For example, by holding the clean button for up to 20 seconds on an i7 or 980. [More information about rebooting your robot](https://homesupport.irobot.com/s/article/9087).
+This {% term integrations %} has been tested and confirmed to be working with the iRobot Roomba s9+, Roomba 980, Roomba 960, Roomba 890, and Braava jet m6 models, but should also work fine with any Wi-Fi enabled Roomba or Braava like the 690. For auto-discovery, you will need to initiate a Roomba reboot. For example, by holding the clean button for up to 20 seconds on an i7 or 980. [More information about rebooting your robot](https://homesupport.irobot.com/s/article/9087).
@@ -38,27 +38,34 @@ This integration has been tested and confirmed to be working with the iRobot Roo
-The Roomba's MQTT server only allows a single connection. Enabling continuous mode will force the App to connect via the cloud to your Roomba. [More info here](https://github.com/NickWaterton/Roomba980-Python#firmware-2xx-notes)
+The Roomba's MQTT server only allows a single connection. Enabling continuous mode will force the App to connect via the cloud to your Roomba. For more information, refer to the [Roomba 980 repository](https://github.com/NickWaterton/Roomba980-Python#firmware-2xx-notes).
-## Integration Entities
+## Integration entities
-The Roomba Integration will add the following sensors.
+The **Roomba** {% term integrations %} will add the following sensors.
Sensors:
-- roomba_battery_level : The status of your battery
-- roomba_bin_full (if Roomba has the capacity to do) : Bin Full status
-- roomba_missions_cancelled: Total missions that have been canceled
-- roomba_missions_failed: Total missions that have failed
-- roomba_missions_successful: Total successful missions
-- roomba_missions_total: All total missions together
-- roomba_scrubs_count: Total amount of how often the robot has executed "scrub"
-- roomba_total_cleaning_time: How long the robot has spend cleaning (total) (in hours)
-### Manually retrieving your credentials
+- **Battery**: The status of your battery
+- **Bin full** (if Roomba has the capacity to do): If the bin is full
+- **Canceled missions**: Total number of missions that have been canceled
+- **Failed missions**: Total number of missions that have failed
+- **Successful missions**: Total number of successful missions
+- **Average mission time**: The amount of time a mission took on average
+- **Total missions**: The total number of all missions
+- **Scrubs**: Total number of times the robot has executed a "scrub"
+- **Total cleaning time**: How many hours the robot has spent cleaning in total
-Please refer to [here](https://github.com/NickWaterton/Roomba980-Python#how-to-get-your-usernameblid-and-password) or [here](https://github.com/koalazak/dorita980#how-to-get-your-usernameblid-and-password) to retrieve both the BLID (username) and the password.
+### Retrieving your credentials
+
+Check if the credentials can be retrieved directly from your device:
+
+1. Make sure the Roomba app is closed on all of your devices.
+2. Follow the instructions in Home Assistant to retrieve the credentials.
+
+If automatic retrieval does not work, you can retrieve the credentials manually. To manually retrieve both the BLID (username) and the password, refer to the instructions in the [Roomba 980](https://github.com/NickWaterton/Roomba980-Python#how-to-get-your-usernameblid-and-password) or [dority 980](https://github.com/koalazak/dorita980#how-to-get-your-usernameblid-and-password) repository.
For Home Assistant Container, the following command retrieves the BLID (username) and password:
@@ -74,7 +81,7 @@ The command to retrieve the credentials does not need any additional software to
#### Retrieving credentials from the cloud with dorita980
-The underlying Python library is currently unable to retrieve the credentials from some newer models (e.g. J7). See [this issue](https://github.com/pschmitt/roombapy/issues/97) for details. Luckily, the password can be retrieved from the cloud using a tool provided by the [dorita980](https://github.com/koalazak/dorita980) library. Follow [these instructions](https://github.com/koalazak/dorita980#how-to-get-your-usernameblid-and-password) to do this, you should receive output of the form:
+The underlying Python library is currently unable to retrieve the credentials from some newer models (for example, the J7). See [this issue](https://github.com/pschmitt/roombapy/issues/97) for details. Luckily, the password can be retrieved from the cloud using a tool provided by the [dorita980](https://github.com/koalazak/dorita980) library. Follow [these instructions](https://github.com/koalazak/dorita980#how-to-get-your-usernameblid-and-password) to do this, you should receive output of the form:
```shell
Found 1 robot(s)!
diff --git a/source/_integrations/roon.markdown b/source/_integrations/roon.markdown
index 0621bc3f4ab..c4e28814e5b 100644
--- a/source/_integrations/roon.markdown
+++ b/source/_integrations/roon.markdown
@@ -2,7 +2,7 @@
title: RoonLabs music player
description: Instructions on how to integrate a RoonLabs multi room player into Home Assistant.
ha_category:
- - Media Player
+ - Media player
ha_release: 0.115
ha_iot_class: Local Push
ha_config_flow: true
diff --git a/source/_integrations/rpi_power.markdown b/source/_integrations/rpi_power.markdown
index 95d66988603..f23a835aabd 100644
--- a/source/_integrations/rpi_power.markdown
+++ b/source/_integrations/rpi_power.markdown
@@ -2,7 +2,7 @@
title: Raspberry Pi Power Supply Checker
description: Instructions on how to integrate Raspberry Pi Power Supply Checker within Home Assistant.
ha_category:
- - System Monitor
+ - System monitor
ha_iot_class: Local Polling
ha_release: 0.116
ha_domain: rpi_power
diff --git a/source/_integrations/rss_feed_template.markdown b/source/_integrations/rss_feed_template.markdown
index 5db2cffe80f..5e7a04bfa47 100644
--- a/source/_integrations/rss_feed_template.markdown
+++ b/source/_integrations/rss_feed_template.markdown
@@ -1,8 +1,8 @@
---
-title: RSS Feed Template
+title: RSS feed template
description: Use this integration to generate RSS feeds showing your latest data.
ha_category:
- - Front End
+ - Front end
ha_iot_class: Local Push
ha_release: 0.44
ha_quality_scale: internal
diff --git a/source/_integrations/rtsp_to_webrtc.markdown b/source/_integrations/rtsp_to_webrtc.markdown
index 97425e9f234..f56826b7ccf 100644
--- a/source/_integrations/rtsp_to_webrtc.markdown
+++ b/source/_integrations/rtsp_to_webrtc.markdown
@@ -22,7 +22,7 @@ The integration configuration requires the URL to your server (e.g. `http://exam
{% include integrations/config_flow.md %}
-## Technical Details
+## Technical details
RTSPtoWebRTC registers with the camera integration to override the camera attribute `frontend_stream_type` of `STREAM_TYPE_WEBRTC` to instruct the frontend to use WebRTC streams.
diff --git a/source/_integrations/ruckus_unleashed.markdown b/source/_integrations/ruckus_unleashed.markdown
index 970bf2232fa..225742c2f53 100644
--- a/source/_integrations/ruckus_unleashed.markdown
+++ b/source/_integrations/ruckus_unleashed.markdown
@@ -2,7 +2,7 @@
title: Ruckus Unleashed
description: Instructions on how to integrate your Ruckus Unleashed device into Home Assistant.
ha_category:
- - Presence Detection
+ - Presence detection
ha_release: 0.117
ha_iot_class: Local Polling
ha_config_flow: true
@@ -20,7 +20,7 @@ This platform allows you to connect to a [Ruckus Unleashed](https://support.ruck
There is currently support for the following device types within Home Assistant:
-- **Presence Detection** - The platform will look at devices connected to the access point and will create a `device_tracker` for each discovered device.
+- **Presence detection** - The platform will look at devices connected to the access point and will create a `device_tracker` for each discovered device.
## Configuration
diff --git a/source/_integrations/russound_rio.markdown b/source/_integrations/russound_rio.markdown
index 2d83de854de..83380f7c5ad 100644
--- a/source/_integrations/russound_rio.markdown
+++ b/source/_integrations/russound_rio.markdown
@@ -2,7 +2,7 @@
title: Russound RIO
description: Instructions on how to integrate Russound RIO devices into Home Assistant.
ha_category:
- - Media Player
+ - Media player
ha_release: 0.49
ha_iot_class: Local Push
ha_domain: russound_rio
diff --git a/source/_integrations/russound_rnet.markdown b/source/_integrations/russound_rnet.markdown
index 85031cab5ae..3cfb07d47ec 100644
--- a/source/_integrations/russound_rnet.markdown
+++ b/source/_integrations/russound_rnet.markdown
@@ -2,7 +2,7 @@
title: Russound RNET
description: Instructions on how to integrate Russound RNET devices into Home Assistant.
ha_category:
- - Media Player
+ - Media player
ha_release: 0.25
ha_iot_class: Local Polling
ha_domain: russound_rnet
diff --git a/source/_integrations/rympro.markdown b/source/_integrations/rympro.markdown
index 8f2fe200bd8..ba7855798a0 100644
--- a/source/_integrations/rympro.markdown
+++ b/source/_integrations/rympro.markdown
@@ -20,6 +20,6 @@ This integration connects with a [Read Your Meter Pro](https://rym-pro.com/) acc
{% include integrations/config_flow.md %}
-## Supported Platforms:
+## Supported platforms:
- [Sensor](/integrations/sensor/)
diff --git a/source/_integrations/samsungtv.markdown b/source/_integrations/samsungtv.markdown
index a4138699ae7..6727a1cb1a5 100644
--- a/source/_integrations/samsungtv.markdown
+++ b/source/_integrations/samsungtv.markdown
@@ -2,7 +2,7 @@
title: Samsung Smart TV
description: Instructions on how to integrate a Samsung Smart TV into Home Assistant.
ha_category:
- - Media Player
+ - Media player
- Remote
ha_release: 0.13
ha_iot_class: Local Push
diff --git a/source/_integrations/satel_integra.markdown b/source/_integrations/satel_integra.markdown
index 4935ea269f0..38e8dcc2ad8 100644
--- a/source/_integrations/satel_integra.markdown
+++ b/source/_integrations/satel_integra.markdown
@@ -3,7 +3,7 @@ title: Satel Integra
description: Instructions on how to integrate a Satel Integra alarm panel with Home Assistant using an ETHM network extension from Satel.
ha_category:
- Alarm
- - Binary Sensor
+ - Binary sensor
- Hub
- Switch
ha_release: 0.54
@@ -20,9 +20,9 @@ The `satel_integra` integration will allow Home Assistant users who own a Satel
There is currently support for the following device types within Home Assistant:
-- Binary Sensor: Reports on zone or output statuses
+- Binary sensor: Reports on zone or output statuses
- Switch: allows for setting states of selected outputs
-- Alarm Control Panel: represents the zones (in Polish: "strefa"). Reports its status, and can be used to arm/disarm the partition
+- Alarm control panel: represents the zones (in Polish: "strefa"). Reports its status, and can be used to arm/disarm the partition
The module communicates via Satel's open TCP protocol published on their website. It subscribes for new events coming from alarm system and reacts to them immediately.
@@ -34,7 +34,7 @@ The library currently doesn't support encrypted connection to your alarm, so you
A list of all partition, zone and output IDs can be acquired by running DloadX program and connecting to your alarm.
-For the Binary Sensor, check the [type/class](/integrations/binary_sensor/) list for a possible visualization of your zones. Note: If no zones or outputs are specified, Home Assistant will not load any binary_sensor integrations."
+For the binary sensor, check the [type/class](/integrations/binary_sensor/) list for a possible visualization of your zones. Note: If no zones or outputs are specified, Home Assistant will not load any binary_sensor integrations."
## Configuration
diff --git a/source/_integrations/scene.markdown b/source/_integrations/scene.markdown
index 9c8582bb122..2edbb771e48 100644
--- a/source/_integrations/scene.markdown
+++ b/source/_integrations/scene.markdown
@@ -167,7 +167,7 @@ You need to pass a `scene_id` in lowercase and with underscores instead of space
If the scene was previously created by `scene.create`, it will be overwritten. If the scene was created by YAML, nothing happens but a warning in your log files.
-### Video Tutorial
+### Video tutorial
This video tutorial explains how scenes work and how you can utilize scenes on the fly.
diff --git a/source/_integrations/schluter.markdown b/source/_integrations/schluter.markdown
index 6334efa2b7e..3d06174a6a0 100644
--- a/source/_integrations/schluter.markdown
+++ b/source/_integrations/schluter.markdown
@@ -45,7 +45,7 @@ password:
Once Home Assistant is started, you will have access to any thermostats registered with your account.
-### Supported Features
+### Supported features
Currently, this integration supports the following features:
diff --git a/source/_integrations/screenlogic.markdown b/source/_integrations/screenlogic.markdown
index 47baf691aeb..e80695c9037 100644
--- a/source/_integrations/screenlogic.markdown
+++ b/source/_integrations/screenlogic.markdown
@@ -3,7 +3,7 @@ title: Pentair ScreenLogic
description: Instructions on how to integrate a ScreenLogic gateway within Home Assistant.
ha_release: '2021.4'
ha_category:
- - Binary Sensor
+ - Binary sensor
- Climate
- Hub
- Sensor
@@ -49,7 +49,7 @@ Sets the operation of any connected color-capable lights.
## Reference
-### Color Modes
+### Color modes
| color_mode | Name | Description |
| ------------ | ------------ | --------------------------------------------------------------------------------------------------------- |
diff --git a/source/_integrations/script.markdown b/source/_integrations/script.markdown
index 3d6b4a0a457..25cadcca9ee 100644
--- a/source/_integrations/script.markdown
+++ b/source/_integrations/script.markdown
@@ -122,7 +122,12 @@ sequence:
type: list
{% endconfiguration %}
-### Script Modes
+### Video tutorial
+This video tutorial explains how scripts work, how to use fields in scripts, and how to use response variables in scripts.
+
+
+
+### Script modes
Mode | Description
-|-
@@ -135,7 +140,7 @@ Mode | Description
-### Full Configuration
+### Full configuration
{% raw %}
diff --git a/source/_integrations/sense.markdown b/source/_integrations/sense.markdown
index 5264e1e1036..a622c5f10ac 100644
--- a/source/_integrations/sense.markdown
+++ b/source/_integrations/sense.markdown
@@ -2,7 +2,7 @@
title: Sense
description: Instructions on how to integrate Sense within Home Assistant.
ha_category:
- - Binary Sensor
+ - Binary sensor
- Energy
- Sensor
ha_iot_class: Cloud Polling
@@ -22,7 +22,7 @@ Integrate your [Sense](https://sense.com) meter information into Home Assistant.
There is currently support for the following device types within Home Assistant:
-- Binary Sensor
+- Binary sensor
- Sensor
{% include integrations/config_flow.md %}
diff --git a/source/_integrations/sensibo.markdown b/source/_integrations/sensibo.markdown
index 75119f39ca9..c62f885ba02 100644
--- a/source/_integrations/sensibo.markdown
+++ b/source/_integrations/sensibo.markdown
@@ -2,7 +2,7 @@
title: Sensibo
description: Instructions on how to integrate Sensibo A/C controller into Home Assistant.
ha_category:
- - Binary Sensor
+ - Binary sensor
- Button
- Climate
- Fan
@@ -76,20 +76,20 @@ You can reset your filter check by using the button available on climate devices
By pressing the button, you tell your device that you have cleaned or replaced the filter.
-## Number Entities
+## Number entities
By using the number entities you can calibrate the temperature and hunmidity of your device.
These entities are disabled by default.
-## Select Entities
+## Select entities
For supported devices, this integration provides support to set the following modes by the select entity:
- Horizontal swing
- Light
-## Sensor Entities
+## Sensor entities
For all devices, these sensors are available:
@@ -130,7 +130,7 @@ For climate devices, these sensors are available:
- Climate React low temperature threshold
- Climate React high temperature threshold
-## Switch Entities
+## Switch entities
For climate devices, these switches are available:
@@ -146,7 +146,7 @@ For Pure devices, this integration provides support to enable/disable Pure Boost
To customize the settings of Pure Boost, you can use the custom `sensibo.enable_pure_boost` service. See [Pure Boost](#pure-boost)
-## Custom Services
+## Custom services
### Full state
diff --git a/source/_integrations/sensor.markdown b/source/_integrations/sensor.markdown
index 5a34766fe85..3579223d514 100644
--- a/source/_integrations/sensor.markdown
+++ b/source/_integrations/sensor.markdown
@@ -15,7 +15,7 @@ Sensors are a basic integration in Home Assistant. They monitor the states and c
Some of these sensors are built-in to Home Assistant, some are created automatically when you add an integration (see this [list](/integrations/#sensor)), and some can be created manually. The [Statistics](/integrations/statistics) and [Template](/integrations/template) sensors are two examples of the last case.
-## Device Class
+## Device class
The type of data a sensor returns impacts how it is displayed in the frontend. This is controlled by the sensor's device class designation. Built-in sensors and many created from an integration will have this designation predefined. Those can be modified in the [customize section](/docs/configuration/customizing-devices/). When manually creating a new sensor the device class may be optionally assigned. A full list of available sensor device classes is below:
diff --git a/source/_integrations/sensor.mqtt.markdown b/source/_integrations/sensor.mqtt.markdown
index bacf9269945..9c8d3222844 100644
--- a/source/_integrations/sensor.mqtt.markdown
+++ b/source/_integrations/sensor.mqtt.markdown
@@ -19,7 +19,8 @@ To use your MQTT sensor in your installation, add the following to your `configu
```yaml
# Example configuration.yaml entry
mqtt:
- - sensor:
+ sensor:
+ - name: "Bedroom Temperature"
state_topic: "home/bedroom/temperature"
```
@@ -233,8 +234,8 @@ Extra attributes will be displayed in the frontend and can also be extracted in
```yaml
# Example configuration.yaml entry
mqtt:
- - sensor:
- name: "RSSI"
+ sensor:
+ - name: "RSSI"
state_topic: "home/sensor1/infojson"
unit_of_measurement: "dBm"
value_template: "{{ value_json.RSSI }}"
@@ -273,14 +274,14 @@ Extra attributes will be displayed in the frontend and can also be extracted in
```yaml
# Example configuration.yaml entry
mqtt:
- - sensor:
- name: "Timer 1"
+ sensor:
+ - name: "Timer 1"
state_topic: "tele/sonoff/sensor"
value_template: "{{ value_json.Timer1.Arm }}"
json_attributes_topic: "tele/sonoff/sensor"
json_attributes_template: "{{ value_json.Timer1 | tojson }}"
- - sensor:
- name: "Timer 2"
+
+ - name: "Timer 2"
state_topic: "tele/sonoff/sensor"
value_template: "{{ value_json.Timer2.Arm }}"
json_attributes_topic: "tele/sonoff/sensor"
@@ -300,8 +301,8 @@ The example below shows how a simple filter, that calculates the value by adding
```yaml
# Example configuration.yaml entry
mqtt:
- - sensor:
- name: "Temp 1"
+ sensor:
+ - name: "Temp 1"
state_topic: "sensor/temperature"
value_template: |-
{% if states(entity_id) == None %}
@@ -338,8 +339,8 @@ Thus the trick is extracting the battery level from the payload.
```yaml
# Example configuration.yaml entry
mqtt:
- - sensor:
- name: "Battery Tablet"
+ sensor:
+ - name: "Battery Tablet"
state_topic: "owntracks/tablet/tablet"
unit_of_measurement: "%"
value_template: "{{ value_json.batt }}"
@@ -366,14 +367,13 @@ Then use this configuration example to extract the data from the payload:
```yaml
# Example configuration.yaml entry
mqtt:
- - sensor:
- name: "Temperature"
+ sensor:
+ - name: "Temperature"
state_topic: "office/sensor1"
suggested_display_precision: 1
unit_of_measurement: "°C"
- value_template: "{{ value_json.temperature }}"
- - sensor:
- name: "Humidity"
+ value_template: "{{ value_json.temperature }}
+ - name: "Humidity"
state_topic: "office/sensor1"
unit_of_measurement: "%"
value_template: "{{ value_json.humidity }}"
@@ -403,7 +403,7 @@ The configuration will look like the example below:
```yaml
# Example configuration.yaml entry
mqtt:
- - sensor:
- name: "Brightness"
+ sensor:
+ - name: "Brightness"
state_topic: "home/bathroom/analog/brightness"
```
diff --git a/source/_integrations/sentry.markdown b/source/_integrations/sentry.markdown
index cf0f2d044f7..5370225c8e7 100644
--- a/source/_integrations/sentry.markdown
+++ b/source/_integrations/sentry.markdown
@@ -2,7 +2,7 @@
title: Sentry
description: Record errors to Sentry.
ha_category:
- - System Monitor
+ - System monitor
ha_iot_class: Cloud Polling
ha_release: 0.104
ha_config_flow: true
diff --git a/source/_integrations/seven_segments.markdown b/source/_integrations/seven_segments.markdown
index 8e16c75f322..65f340eb6aa 100644
--- a/source/_integrations/seven_segments.markdown
+++ b/source/_integrations/seven_segments.markdown
@@ -2,7 +2,7 @@
title: Seven Segments OCR
description: Instructions on how to use OCR for seven segments displays into Home Assistant.
ha_category:
- - Image Processing
+ - Image processing
ha_release: 0.45
og_image: /images/screenshots/ssocr.png
ha_iot_class: Local Polling
diff --git a/source/_integrations/sfr_box.markdown b/source/_integrations/sfr_box.markdown
index 09ca3788f71..9460349ce11 100644
--- a/source/_integrations/sfr_box.markdown
+++ b/source/_integrations/sfr_box.markdown
@@ -21,7 +21,7 @@ The SFR Box integration offers integration with the **SFR** broadband router.
This integration provides the following platforms:
-- Binary Sensors - such as ADSL status.
+- Binary sensors - such as ADSL status.
- Buttons - such as reboot.
- Sensors - such as ADSL line status, attenuation, noise and data rate.
diff --git a/source/_integrations/shelly.markdown b/source/_integrations/shelly.markdown
index 550737d97dc..2459f5b9302 100644
--- a/source/_integrations/shelly.markdown
+++ b/source/_integrations/shelly.markdown
@@ -2,7 +2,7 @@
title: Shelly
description: Integrate Shelly devices
ha_category:
- - Binary Sensor
+ - Binary sensor
- Cover
- Energy
- Light
diff --git a/source/_integrations/shopping_list.markdown b/source/_integrations/shopping_list.markdown
index 83687f56cb3..957202089ed 100644
--- a/source/_integrations/shopping_list.markdown
+++ b/source/_integrations/shopping_list.markdown
@@ -1,9 +1,9 @@
---
-title: Shopping List
+title: Shopping list
description: Instructions on how to integrate a Shopping list into Home Assistant using Intent.
ha_category:
- Intent
- - To-do List
+ - To-do list
ha_release: '0.50'
ha_config_flow: true
ha_quality_scale: internal
@@ -16,7 +16,7 @@ ha_platforms:
The `shopping_list` 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 [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."
{% include integrations/config_flow.md %}
@@ -76,7 +76,7 @@ Sort all items by name in the shopping list.
|------------------------|----------|---------------------------------------------------------------------|
| `reverse` | yes | Whether to sort in reverse (_descending_) order. (default: `False`) |
-## Using in Automations
+## 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.
diff --git a/source/_integrations/sighthound.markdown b/source/_integrations/sighthound.markdown
index 5b4a776870c..c3f3152e11d 100644
--- a/source/_integrations/sighthound.markdown
+++ b/source/_integrations/sighthound.markdown
@@ -2,7 +2,7 @@
title: Sighthound
description: Detect people with Sighthound Cloud.
ha_category:
- - Image Processing
+ - Image processing
ha_release: 0.105
ha_iot_class: Cloud Polling
ha_codeowners:
diff --git a/source/_integrations/simplisafe.markdown b/source/_integrations/simplisafe.markdown
index 8e62a198107..b4c39a37a14 100644
--- a/source/_integrations/simplisafe.markdown
+++ b/source/_integrations/simplisafe.markdown
@@ -26,10 +26,10 @@ The `simplisafe` integration integrates [SimpliSafe home security](https://simpl
There is currently support for the following device types within Home Assistant:
-- **Alarm Control Panel**: reports on the current alarm status and can be used to arm and disarm the system.
-- **CO Detector**: reports on the carbon monoxide sensor status*.
-- **Entry Sensor**: reports on the current entry sensor status*.
-- **Freeze Sensor**: reports on the freeze sensor temperature*.
+- **Alarm control panel**: reports on the current alarm status and can be used to arm and disarm the system.
+- **CO detector**: reports on the carbon monoxide sensor status*.
+- **Entry sensor**: reports on the current entry sensor status*.
+- **Freeze sensor**: reports on the freeze sensor temperature*.
- **Glass Break Sensor**: reports on the glass breakage sensor status*.
- **Lock**: reports on `Door Locks` and can be used to lock and unlock a lock.
- **Motion Sensor**: reports on motion detected*.
diff --git a/source/_integrations/simu.markdown b/source/_integrations/simu.markdown
index 573da357f0a..7d1312feb20 100644
--- a/source/_integrations/simu.markdown
+++ b/source/_integrations/simu.markdown
@@ -3,7 +3,7 @@ title: SIMU LiveIn2
description: Connect and control your SIMU LiveIn2 devices using the Overkiz integration
ha_category:
- Alarm
- - Binary Sensor
+ - Binary sensor
- Button
- Climate
- Cover
@@ -16,7 +16,7 @@ ha_category:
- Sensor
- Siren
- Switch
- - Water Heater
+ - Water heater
ha_domain: simu
ha_integration_type: virtual
ha_supporting_domain: overkiz
diff --git a/source/_integrations/sisyphus.markdown b/source/_integrations/sisyphus.markdown
index 21ef39cb4cd..e7c7cba1954 100644
--- a/source/_integrations/sisyphus.markdown
+++ b/source/_integrations/sisyphus.markdown
@@ -4,7 +4,7 @@ description: Instructions on how to integrate your Sisyphus Kinetic Art Table wi
ha_category:
- Hub
- Light
- - Media Player
+ - Media player
ha_release: 0.75
ha_iot_class: Local Push
ha_codeowners:
@@ -21,9 +21,9 @@ The [Sisyphus](https://sisyphus-industries.com/) integration for Home Assistant
There is currently support for the following device types within Home Assistant:
- **Light** - Can be used to sleep/wake the table or adjust the brightness of the table light.
-- **Media Player** - Can be used to sleep/wake the table, play/pause, move between tracks, or toggle shuffle on and off. The "volume" control adjusts the table's speed.
+- **Media player** - Can be used to sleep/wake the table, play/pause, move between tracks, or toggle shuffle on and off. The "volume" control adjusts the table's speed.
-The Light and Media players will be automatically added for each of your Sisyphus tables, if the Sisyphus integration is configured.
+The light and media players will be automatically added for each of your Sisyphus tables, if the Sisyphus integration is configured.
There are two ways to configure this integration. For the automatic discovery of your table(s), add the following to your `configuration.yaml`:
diff --git a/source/_integrations/sky_hub.markdown b/source/_integrations/sky_hub.markdown
index 3dbde3dd773..aa172202ba5 100644
--- a/source/_integrations/sky_hub.markdown
+++ b/source/_integrations/sky_hub.markdown
@@ -2,7 +2,7 @@
title: Sky Hub
description: Instructions on how to integrate Sky Hub routers into Home Assistant.
ha_category:
- - Presence Detection
+ - Presence detection
ha_release: 0.37
ha_domain: sky_hub
ha_codeowners:
diff --git a/source/_integrations/skybell.markdown b/source/_integrations/skybell.markdown
index 7f4d9b639ee..ce57096cd42 100644
--- a/source/_integrations/skybell.markdown
+++ b/source/_integrations/skybell.markdown
@@ -2,7 +2,7 @@
title: SkyBell
description: Instructions on how to integrate your Skybell HD devices within Home Assistant.
ha_category:
- - Binary Sensor
+ - Binary sensor
- Camera
- Doorbell
- Light
@@ -27,7 +27,7 @@ The `skybell` implementation allows you to integrate your [Skybell.com](http://w
There is currently support for the following device types within Home Assistant:
-- [Binary Sensor](/integrations/skybell/#binary-sensor)
+- [Binary sensor](/integrations/skybell/#binary-sensor)
- [Camera](/integrations/skybell/#camera)
- [Light](/integrations/skybell/#light)
- [Sensor](/integrations/skybell/#sensor)
@@ -37,9 +37,9 @@ Currently only the SkyBell HD is supported by this platform.
{% include integrations/config_flow.md %}
-## Integration Entities
+## Integration entities
-### Binary Sensor
+### Binary sensor
Each added configuration entry will create the following binary sensors:
diff --git a/source/_integrations/slack.markdown b/source/_integrations/slack.markdown
index d9f0a4c719d..8ad84e6e844 100644
--- a/source/_integrations/slack.markdown
+++ b/source/_integrations/slack.markdown
@@ -43,10 +43,11 @@ In `Features/OAuth and Permissions/OAuth Tokens for Your Workspace`:
+6. Ensure that the bot user is added to the channel in which you want it to post. This can be completed in several ways:
-Ensure that the bot user is added to the channel in which you want it to post.
-In Slack, tag the bot user in a message, then add it to the channel.
-
+- Using `/invite @bot` from the channel
+- Tagging the bot user in a message, then adding it to the channel via the Slackbot prompt.
+- Channel settings -> `Integrations` -> `Add apps`
#### Sample App Manifest
diff --git a/source/_integrations/sleepiq.markdown b/source/_integrations/sleepiq.markdown
index 0960d687605..13a2a55faed 100644
--- a/source/_integrations/sleepiq.markdown
+++ b/source/_integrations/sleepiq.markdown
@@ -2,7 +2,7 @@
title: SleepIQ
description: Instructions for how to integrate SleepIQ beds within Home Assistant.
ha_category:
- - Binary Sensor
+ - Binary sensor
- Button
- Health
- Light
@@ -33,7 +33,7 @@ The SleepIQ integration lets you integrate your SleepNumber Bed via [SleepIQ by
There is currently support for the following platforms within Home Assistant:
-- Binary Sensor - View occupancy of each side
+- Binary sensor - View occupancy of each side
- Button - Calibrate the bed
- Button - Stop the pump
- Light - Control lights on supported models
diff --git a/source/_integrations/slimproto.markdown b/source/_integrations/slimproto.markdown
index 1ece1666b79..797e259a1d2 100644
--- a/source/_integrations/slimproto.markdown
+++ b/source/_integrations/slimproto.markdown
@@ -2,7 +2,7 @@
title: SlimProto (Squeezebox players)
description: Instructions on how to integrate a SlimProto-based player (e.g., Squeezebox) into Home Assistant without the need for a media server.
ha_category:
- - Media Player
+ - Media player
ha_release: 2022.5
ha_iot_class: Local Push
ha_domain: slimproto
diff --git a/source/_integrations/smappee.markdown b/source/_integrations/smappee.markdown
index 8674ea52933..6a05c7831d9 100644
--- a/source/_integrations/smappee.markdown
+++ b/source/_integrations/smappee.markdown
@@ -2,7 +2,7 @@
title: Smappee
description: Instructions on how to setup Smappee within Home Assistant.
ha_category:
- - Binary Sensor
+ - Binary sensor
- Energy
- Hub
- Sensor
diff --git a/source/_integrations/smarther.markdown b/source/_integrations/smarther.markdown
index db9ec1a3223..27d4fd83124 100644
--- a/source/_integrations/smarther.markdown
+++ b/source/_integrations/smarther.markdown
@@ -8,7 +8,7 @@ ha_category:
- Environment
- Hub
- Light
- - Media Source
+ - Media source
- Sensor
- Switch
- Weather
diff --git a/source/_integrations/smartthings.markdown b/source/_integrations/smartthings.markdown
index acc12a69753..0df60e43ffd 100644
--- a/source/_integrations/smartthings.markdown
+++ b/source/_integrations/smartthings.markdown
@@ -3,7 +3,7 @@ title: SmartThings
description: Instructions on setting up SmartThings within Home Assistant.
featured: true
ha_category:
- - Binary Sensor
+ - Binary sensor
- Climate
- Cover
- Fan
@@ -124,7 +124,7 @@ Event data payloads are logged at the debug level, see [debugging](#debugging) f
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.
-- [Binary Sensor](#binary-sensor)
+- [Binary sensor](#binary-sensor)
- [Climate](#climate)
- [Cover](#cover)
- [Fan](#fan)
@@ -136,9 +136,9 @@ SmartThings represents devices as a set of [capabilities](https://developer-prev
Support for additional platforms will be added in the future.
-### Binary Sensor
+### Binary sensor
-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.
+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 |
| ------------------------------------------------------------------------------------------------------------------------------------- | -------------- | ---------- |
diff --git a/source/_integrations/smarttub.markdown b/source/_integrations/smarttub.markdown
index c231ff323bd..35e1af34b58 100644
--- a/source/_integrations/smarttub.markdown
+++ b/source/_integrations/smarttub.markdown
@@ -2,7 +2,7 @@
title: SmartTub
description: Instructions on how to integrate SmartTub into Home Assistant.
ha_category:
- - Binary Sensor
+ - Binary sensor
- Climate
- Light
- Sensor
diff --git a/source/_integrations/sms.markdown b/source/_integrations/sms.markdown
index 918722c2301..cb88a588fe7 100644
--- a/source/_integrations/sms.markdown
+++ b/source/_integrations/sms.markdown
@@ -110,7 +110,7 @@ notify_sms_user1:
{% endraw %}
-## Required Hardware
+## Required hardware
You will need a USB GSM stick modem or device like SIM800L v2 connected via USB UART.
diff --git a/source/_integrations/snapcast.markdown b/source/_integrations/snapcast.markdown
index ccb63f7006c..d0d9f38ba0a 100644
--- a/source/_integrations/snapcast.markdown
+++ b/source/_integrations/snapcast.markdown
@@ -2,7 +2,7 @@
title: Snapcast
description: Instructions on how to integrate Snapcast into Home Assistant.
ha_category:
- - Media Player
+ - Media player
ha_release: 0.13
ha_iot_class: Local Push
ha_domain: snapcast
diff --git a/source/_integrations/snmp.markdown b/source/_integrations/snmp.markdown
index 19eb14ff199..530e1eed838 100644
--- a/source/_integrations/snmp.markdown
+++ b/source/_integrations/snmp.markdown
@@ -3,7 +3,7 @@ title: SNMP
description: Instructions on how to integrate SNMP into Home Assistant.
ha_category:
- Network
- - Presence Detection
+ - Presence detection
- Sensor
- Switch
ha_iot_class: Local Polling
@@ -20,7 +20,7 @@ A lot of Wi-Fi access points and Wi-Fi routers support the Simple Network Manage
There is currently support for the following device types within Home Assistant:
-- [Presence Detection](#presence-detection)
+- [Presence detection](#presence-detection)
- [Sensor](#sensor)
- [Switch](#switch)
@@ -28,7 +28,7 @@ There is currently support for the following device types within Home Assistant:
This device tracker needs SNMP to be enabled on the router. It could be that you need to install the SNMP support manually.
-## Presence Detection
+## Presence detection
The following OID examples pull the current MAC Address table from a router. This reflects all recent devices seen on the network. However, since devices are not removed until they time out, this is less effective for [device tracker integration page](/integrations/device_tracker/) than desirable. It is recommended to use [Ping](/integrations/ping) or [Nmap](/integrations/nmap_tracker) instead.
diff --git a/source/_integrations/somfy.markdown b/source/_integrations/somfy.markdown
index 631dae8101d..f21952807b2 100644
--- a/source/_integrations/somfy.markdown
+++ b/source/_integrations/somfy.markdown
@@ -3,7 +3,7 @@ title: Somfy
description: Connect and control your Somfy devices using the Overkiz integration
ha_category:
- Alarm
- - Binary Sensor
+ - Binary sensor
- Button
- Climate
- Cover
@@ -16,7 +16,7 @@ ha_category:
- Sensor
- Siren
- Switch
- - Water Heater
+ - Water heater
ha_domain: somfy
ha_integration_type: virtual
ha_supporting_domain: overkiz
diff --git a/source/_integrations/songpal.markdown b/source/_integrations/songpal.markdown
index 598b353c208..93667c4c949 100644
--- a/source/_integrations/songpal.markdown
+++ b/source/_integrations/songpal.markdown
@@ -2,7 +2,7 @@
title: Sony Songpal
description: Instructions on how to integrate Sony Songpal devices into Home Assistant.
ha_category:
- - Media Player
+ - Media player
ha_iot_class: Local Push
ha_release: 0.65
ha_config_flow: true
diff --git a/source/_integrations/sonos.markdown b/source/_integrations/sonos.markdown
index 2c4de99263b..2f434ffb9ff 100644
--- a/source/_integrations/sonos.markdown
+++ b/source/_integrations/sonos.markdown
@@ -2,7 +2,7 @@
title: Sonos
description: Instructions on how to integrate Sonos devices into Home Assistant.
ha_category:
- - Media Player
+ - Media player
- Sensor
featured: true
ha_release: 0.7.3
@@ -187,7 +187,7 @@ data:
## Services
-The Sonos integration makes various custom services available in addition to the [standard Media Player services](/integrations/media_player/#services).
+The Sonos integration makes various custom services available in addition to the [standard media player services](/integrations/media_player/#services).
### Service `sonos.snapshot`
diff --git a/source/_integrations/soundtouch.markdown b/source/_integrations/soundtouch.markdown
index 7b60eb7bed9..3bef62deaa5 100644
--- a/source/_integrations/soundtouch.markdown
+++ b/source/_integrations/soundtouch.markdown
@@ -2,7 +2,7 @@
title: Bose SoundTouch
description: Instructions on how to integrate Bose SoundTouch devices into Home Assistant.
ha_category:
- - Media Player
+ - Media player
ha_release: 0.34
ha_iot_class: Local Polling
ha_domain: soundtouch
diff --git a/source/_integrations/spc.markdown b/source/_integrations/spc.markdown
index 439ef80f94f..008d13ddb69 100644
--- a/source/_integrations/spc.markdown
+++ b/source/_integrations/spc.markdown
@@ -3,7 +3,7 @@ title: Vanderbilt SPC
description: Instructions on how to setup Vanderbilt SPC devices within Home Assistant.
ha_category:
- Alarm
- - Binary Sensor
+ - Binary sensor
- Hub
ha_release: 0.47
ha_iot_class: Local Push
@@ -21,7 +21,7 @@ Integration with SPC is done through a third-party API gateway called [SPC Web G
There is currently support for the following device types within Home Assistant:
- [Alarm](#alarm)
-- [Binary Sensor](#binary-sensor)
+- [Binary sensor](#binary-sensor)
Home Assistant needs to know where to find the SPC Web Gateway API endpoints, to configure this add the following section to your `configuration.yaml` file:
@@ -69,7 +69,7 @@ automation:
{% endraw %}
-## Binary Sensor
+## Binary sensor
The `spc` platform allows you to get data from your [Vanderbilt SPC](https://www.spcsupportinfo.com/SPCConnectPro/) binary sensors from within Home Assistant.
diff --git a/source/_integrations/speedtestdotnet.markdown b/source/_integrations/speedtestdotnet.markdown
index b22769ebd72..f624baddf6d 100644
--- a/source/_integrations/speedtestdotnet.markdown
+++ b/source/_integrations/speedtestdotnet.markdown
@@ -3,7 +3,7 @@ title: Speedtest.net
description: How to integrate Speedtest.net within Home Assistant.
ha_category:
- Sensor
- - System Monitor
+ - System monitor
ha_release: 0.13
ha_iot_class: Cloud Polling
ha_config_flow: true
@@ -26,7 +26,7 @@ By default, a speed test will be run every hour. You can disable polling using s
{% include common-tasks/define_custom_polling.md %}
-## Integration Sensors
+## Integration sensors
The following sensors are added by the integration:
diff --git a/source/_integrations/splunk.markdown b/source/_integrations/splunk.markdown
index a5d0a7965d4..456c7fdd11d 100644
--- a/source/_integrations/splunk.markdown
+++ b/source/_integrations/splunk.markdown
@@ -51,7 +51,7 @@ verify_ssl:
name:
description: This parameter allows you to specify a friendly name to send to Splunk as the host, instead of using the name of the HEC.
required: false
- default: HASS
+ default: "`HASS`"
type: string
filter:
description: Filters for entities to be included/excluded from Splunk. Default is to include all entities. ([Configure Filter](#configure-filter))
@@ -84,7 +84,7 @@ filter:
type: list
{% endconfiguration %}
-### Configure Filter
+### Configure filter
By default, no entity will be excluded. To limit which entities are being exposed to `Splunk`, you can use the `filter` parameter.
diff --git a/source/_integrations/spotify.markdown b/source/_integrations/spotify.markdown
index ddd213ae8f3..a86c1b6ef12 100644
--- a/source/_integrations/spotify.markdown
+++ b/source/_integrations/spotify.markdown
@@ -2,7 +2,7 @@
title: Spotify
description: Instructions on how to integrate Spotify into Home Assistant.
ha_category:
- - Media Player
+ - Media player
ha_release: 0.43
ha_iot_class: Cloud Polling
ha_config_flow: true
@@ -146,6 +146,6 @@ script:
The `media_content_id` value can be obtained from the Spotify desktop app by clicking on the more options ("...") next to the album art picture, selecting "Share" and then "Copy Spotify URI" or "Copy Playlist Link" (also available in the Spotify phone and web app). Alternatively a Spotify URI string (e.g. `spotify:playlist:5xddIVAtLrZKtt4YGLM1SQ`) can be supplied for the `media_content_id`.
-## Unsupported Devices
+## Unsupported devices
- **Sonos**: Although Sonos is a Spotify Connect device, it is not supported by the official Spotify API.
diff --git a/source/_integrations/squeezebox.markdown b/source/_integrations/squeezebox.markdown
index a4ebd192d32..b902bd3cf67 100644
--- a/source/_integrations/squeezebox.markdown
+++ b/source/_integrations/squeezebox.markdown
@@ -2,7 +2,7 @@
title: Squeezebox (Logitech Media Server)
description: Instructions on how to integrate a Logitech Squeezebox player into Home Assistant.
ha_category:
- - Media Player
+ - Media player
ha_release: pre 0.7
ha_iot_class: Local Polling
ha_domain: squeezebox
diff --git a/source/_integrations/ssdp.markdown b/source/_integrations/ssdp.markdown
index 6c019bf0896..d1a2b498c51 100644
--- a/source/_integrations/ssdp.markdown
+++ b/source/_integrations/ssdp.markdown
@@ -23,7 +23,7 @@ This integration is by default enabled, unless you've disabled or removed the [`
ssdp:
```
-## Discovered Integrations
+## Discovered integrations
The following integrations are automatically discovered by the SSDP integration:
diff --git a/source/_integrations/starline.markdown b/source/_integrations/starline.markdown
index 08fcb80bed0..15cb24d1f73 100644
--- a/source/_integrations/starline.markdown
+++ b/source/_integrations/starline.markdown
@@ -2,10 +2,10 @@
title: StarLine
description: Instructions on how to setup your StarLine account with Home Assistant.
ha_category:
- - Binary Sensor
+ - Binary sensor
- Car
- Lock
- - Presence Detection
+ - Presence detection
- Sensor
- Switch
ha_release: 0.103
@@ -27,10 +27,10 @@ The `starline` integration lets you retrieve data of your [StarLine](https://www
This integration provides the following platforms:
-- Binary Sensors: Hand brake, hood, trunk, alarm status and doors lock state.
+- Binary sensors: Hand brake, hood, trunk, alarm status and doors lock state.
- Device tracker: The location of your car.
- Lock: Control the lock of your car.
-- Sensors: Battery level, SIM card balance, GSM signal level, Fuel Volume, Mileage, OBD Errors, interior temperature and engine temperature.
+- Sensors: Battery level, SIM card balance, GSM signal level, fuel volume, mileage, OBD errors, interior temperature and engine temperature.
- Switches: Start/stop engine, heater (webasto), additional channel and sound the horn.
- Services: Update the state, set update frequency. More details can be found [here](#services).
diff --git a/source/_integrations/starlingbank.markdown b/source/_integrations/starlingbank.markdown
index 173aa1ceb4b..2559e3fe442 100644
--- a/source/_integrations/starlingbank.markdown
+++ b/source/_integrations/starlingbank.markdown
@@ -19,7 +19,7 @@ The Starling Bank sensor platform allows you to monitor your account balance dat
You can find more information about Starling Bank at [their website](https://www.starlingbank.com/). Information on their API can be found on their [developers site](https://developer.starlingbank.com/).
-## Access Token
+## Access token
Once you have your own Starling bank account you will need to sign up for a Starling developer account [here](https://developer.starlingbank.com/signup). You won't need to do any development but you will need to get a "Personal Access Token" that will allow the integration to access your account balance.
diff --git a/source/_integrations/starlink.markdown b/source/_integrations/starlink.markdown
index bfc9f99e4ad..b3f71ab6026 100644
--- a/source/_integrations/starlink.markdown
+++ b/source/_integrations/starlink.markdown
@@ -2,9 +2,9 @@
title: Starlink
description: Instructions on how to integrate Starlink into Home Assistant.
ha_category:
- - Binary Sensor
+ - Binary sensor
- Button
- - Device Tracker
+ - Device tracker
- Network
- Sensor
- Switch
@@ -41,7 +41,7 @@ The Starlink integration allows you to integrate your [Starlink](https://www.sta
- Downlink throughput - The amount of data being downloaded through Starlink
- Last boot time - The time Starlink was last turned on
-### Binary Sensor
+### Binary sensor
- Update available - Whether there is an update pending install
- Obstructed - Whether Dishy is currently obstructed
@@ -62,6 +62,6 @@ The Starlink integration allows you to integrate your [Starlink](https://www.sta
- Stowed - Controls whether Dishy is stowed
-### Device Tracker
+### 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.
diff --git a/source/_integrations/statistics.markdown b/source/_integrations/statistics.markdown
index 635e6010fd0..b1de8075ae0 100644
--- a/source/_integrations/statistics.markdown
+++ b/source/_integrations/statistics.markdown
@@ -158,6 +158,6 @@ unique_id:
### An important note on `max_age` and `sampling_size`
-If both `max_age` and `sampling_size` are given, the considered samples are those within the `max_age` time window but limited to the number of `sample_size` newest samples. Specify a wide-enough `sampling_size` if using an extended `max_age` (e.g., when looking for `max_age` 1 hour, a sensor that produces one measurement per minute should have at least a `sampling_size` of 60 to use all samples within the `max_age` timeframe.)
+If both `max_age` and `sampling_size` are given, the considered samples are those within the `max_age` time window but limited to the number of `sampling_size` newest samples. Specify a wide-enough `sampling_size` if using an extended `max_age` (e.g., when looking for `max_age` 1 hour, a sensor that produces one measurement per minute should have at least a `sampling_size` of 60 to use all samples within the `max_age` timeframe.)
-If only `sample_size` is given there is no time limit. If only `max_age` is given the considered number of samples is unlimited.
+If only `sampling_size` is given there is no time limit. If only `max_age` is given the considered number of samples is unlimited.
diff --git a/source/_integrations/statsd.markdown b/source/_integrations/statsd.markdown
index ec5babec77e..fa8a133762a 100644
--- a/source/_integrations/statsd.markdown
+++ b/source/_integrations/statsd.markdown
@@ -32,7 +32,7 @@ port:
prefix:
description: Prefix to use.
required: false
- default: hass
+ default: "`hass`"
type: string
rate:
description: The sample rate.
diff --git a/source/_integrations/steamist.markdown b/source/_integrations/steamist.markdown
index 4679e6f4ec0..e799f5b8119 100644
--- a/source/_integrations/steamist.markdown
+++ b/source/_integrations/steamist.markdown
@@ -19,7 +19,7 @@ ha_integration_type: integration
The Steamist will allow you to monitor the state of your [Steamist](https://steamist.com/digital-controls/) steam shower and turn on and off the steam generator.
-## Supported Devices
+## Supported devices
- 450 Digital Control
- 550 Digital Control
diff --git a/source/_integrations/stookalert.markdown b/source/_integrations/stookalert.markdown
index 3b509e6f748..661a28ed48a 100644
--- a/source/_integrations/stookalert.markdown
+++ b/source/_integrations/stookalert.markdown
@@ -2,7 +2,7 @@
title: RIVM Stookalert
description: Instructions on how to use Stookalert data within Home Assistant
ha_category:
- - Binary Sensor
+ - Binary sensor
- Environment
ha_release: 0.104
ha_iot_class: Cloud Polling
diff --git a/source/_integrations/stream.markdown b/source/_integrations/stream.markdown
index 7130b2cb7bc..fe21afef397 100644
--- a/source/_integrations/stream.markdown
+++ b/source/_integrations/stream.markdown
@@ -57,7 +57,7 @@ stream:
```
-## Technical Details
+## Technical details
The integration currently supports proxying H.264 and H.265 source streams to the HLS (and LL-HLS) protocol.
diff --git a/source/_integrations/streamlabswater.markdown b/source/_integrations/streamlabswater.markdown
index 27279cb41cf..54261c6b35d 100644
--- a/source/_integrations/streamlabswater.markdown
+++ b/source/_integrations/streamlabswater.markdown
@@ -2,7 +2,7 @@
title: StreamLabs
description: Instructions on how to integrate Streamlabs Water devices with Home Assistant.
ha_category:
- - Binary Sensor
+ - Binary sensor
- Sensor
ha_release: '0.95'
ha_iot_class: Cloud Polling
@@ -23,7 +23,7 @@ Access to the StreamLabs Water API is not free, you must have a StreamPlus™ su
There is currently support for the following device types within Home Assistant:
-- Binary Sensor
+- Binary sensor
- Sensor
In preparation for using this integration you will need to request an API key following the instructions in the [StreamLabs API Getting Started Section](https://developer.streamlabswater.com/docs/getting-started.html). Be sure to request an API key and not an OAuth token.
diff --git a/source/_integrations/subaru.markdown b/source/_integrations/subaru.markdown
index 444e7d3dbb5..60c91c162ad 100644
--- a/source/_integrations/subaru.markdown
+++ b/source/_integrations/subaru.markdown
@@ -4,7 +4,7 @@ description: Instructions on how to setup your Subaru account with Home Assistan
ha_category:
- Car
- Lock
- - Presence Detection
+ - Presence detection
- Sensor
ha_release: 2021.3
ha_iot_class: Cloud Polling
@@ -24,17 +24,18 @@ This integration retrieves vehicle information and actuates remote services prov
This integration requires a telematics equipped Subaru and an active vehicle subscription to the Subaru STARLINK service. Before using this integration, you must first register and have login credentials to [MySubaru](https://www.mysubaru.com).
-Subaru has deployed two generations of telematics, Gen 1 and Gen 2. The latter offers more vehicle sensor information and additional remote capabilities. Use the table below to determine your vehicle's telematics generation and capabilities.
+Subaru has deployed three generations of telematics with different feature sets. Use the table below to determine your vehicle's telematics generation and capabilities. This table is a best guess based upon what Subaru [lists as available features](https://www.subaru.com/vehicle-info/subaru-starlink/starlink-safety-and-security/compare-packages.html?model=&year=).
-| Model | Gen 1 | Gen 2 |
-|-----------|-----------|-------|
-| Ascent | | 2019+ |
-| Crosstrek | 2016-2018 | 2019+ |
-| Forester | 2016-2018 | 2019+ |
-| Impreza | 2016-2018 | 2019+ |
-| Legacy | 2016-2019 | 2020+ |
-| Outback | 2016-2019 | 2020+ |
-| WRX | 2017+ | |
+| Model | Gen 1 | Gen 2 | Gen 3 |
+|-----------|-----------|-----------|-------|
+| Ascent | --- | 2019-2023 | 2024+ |
+| BRZ | --- | 2022-2023 | --- |
+| Crosstrek | 2016-2018 | 2019+ | --- |
+| Forester | 2016-2018 | 2019+ | --- |
+| Impreza | 2016-2018 | 2019-2022 | 2023+ |
+| Legacy | 2016-2019 | 2020-2022 | 2023+ |
+| Outback | 2016-2019 | 2020-2022 | 2023+ |
+| WRX | 2017-2021 | 2022-2023 | --- |
In addition to the telematics generational differences, there are two levels of STARLINK subscriptions, "Safety Plus" and "Security Plus". All remote services (such as locks and location tracking) require a "Security Plus" level subscription.
@@ -48,31 +49,38 @@ If your account includes multiple vehicles, the same PIN will be used for all ve
Available sensors will vary by model, year, and subscription type. The integration will add all supported sensors for your vehicle. Sensor data is usually only updated when the vehicle is turned off unless the [polling option](#options) is enabled.
-| Sensor | Gen 1 | Gen 2 |
-|--------------------------|---------|---------|
-| 12V battery voltage | | ✓ |
-| Average fuel consumption | | ✓ |
-| Distance to empty | | ✓ |
-| EV battery level | | ✓ |
-| EV range | | ✓ |
-| EV time to full charge | | ✓ |
-| External temperature | | ✓ |
-| Odometer | ✓*| ✓ |
-| Tire pressures | | ✓ |
+| Sensor | Gen 1 | Gen 2 | Gen 3 |
+|--------------------------|---------|---------|---------|
+| Average fuel consumption | | ✓ | ✓ |
+| Distance to empty | | ✓ | ✓ |
+| EV battery level | | ✓ | ✓ |
+| EV range | | ✓ | ✓ |
+| EV time to full charge | | ✓ | ✓ |
+| Odometer | ✓*| ✓ | ✓ |
+| Tire pressures | | ✓ | ✓ |
\* Gen 1 odometer only updates every 500 miles
## Lock
-This integration supports remote locking and unlocking of vehicle doors.
+This integration supports remote locking and unlocking of vehicle doors. If doors are remotely unlocked, they will automatically relock if a door is not opened within a minute. There is no remote notification of this automatic relock.
The current lock status is always unknown due to the fact that the Subaru API does not report this data.
-## Device Tracker
+### Unlock specific door
-Tracks the most recently reported location of the vehicle. The vehicle reports its location when it is turned off.
+In addition to the standard services built into the lock entity, this integration also provides a `subaru.unlock_specific_door` service to specify a door to unlock.
+The service requires the `door` parameter which may be set to one of the following:
+
+- `all`: unlocks all doors
+- `driver`: unlocks only the driver's door
+- `tailgate`: unlocks only the tailgate (not all vehicles support this option)
+
+## Device tracker
+
+Tracks the most recently reported location of the vehicle. The vehicle reports its location when it is turned off. If enabled, the [polling option](#options) will also update the vehicle location.
## Options
@@ -80,7 +88,7 @@ Subaru integration options are set via:
**Settings** -> **Devices & Services** -> **Subaru** -> **Options**.
-- **Enable vehicle polling *[Default: off]*:** When enabled, vehicle polling will send a remote command to your vehicle every 2 hours to obtain new sensor data. This involves "waking" your vehicle and requesting that it send new data to Subaru servers. Without vehicle polling, new sensor data is only received when the vehicle automatically pushes data (normally after engine shutdown). This option only applies to Gen 2 vehicles with Security Plus subscriptions because it uses a "locate" command to request the data.
+- **Enable vehicle polling *[Default: off]*:** When enabled, vehicle polling will send a remote command to your vehicle every 2 hours to obtain new sensor data. This involves "waking" your vehicle and requesting that it send new data to Subaru servers. Without vehicle polling, new sensor data is only received when the vehicle automatically pushes data (normally after engine shutdown). This option only applies to vehicles with Security Plus subscriptions because it uses a "locate" command to request the data.
Vehicle polling draws power from the 12V battery. Long term use without driving may drain the battery resulting in the inability to start.
@@ -96,7 +104,7 @@ Vehicle polling draws power from the 12V battery. Long term use without driving
**Q:** Will remote start ever be supported?
-**A:** Yes, Gen 2 remote start and climate settings are supported by the underlying [subarulink](https://github.com/G-Two/subarulink) Python package, and will be integrated into Home Assistant soon.
+**A:** Yes, Gen 2/3 remote start and climate settings are supported by the underlying [subarulink](https://github.com/G-Two/subarulink) Python package, and will be integrated into Home Assistant soon.
---
**Q:** Why do I need to enter my PIN during configuration?
@@ -113,10 +121,10 @@ Vehicle polling draws power from the 12V battery. Long term use without driving
**Q:** Why don't my sensor readings appear to change in "real-time"?
-**A:** Gen 2 telematics vehicles will send updated data when the vehicle is shutdown. After about 5 minutes, the data should be reflected in Home Assistant. In addition, some data, such as tire pressures, are only measured while the vehicle is in motion. The pressures reported are the last reading when the vehicle is shutdown.
+**A:** Gen 2/3 telematics vehicles will send updated data when the vehicle is shutdown. After about 5 minutes, the data should be reflected in Home Assistant. In addition, some data, such as tire pressures, are only measured while the vehicle is in motion. The pressures reported are the last reading when the vehicle is shutdown.
---
**Q:** Should I enable the vehicle polling option?
-**A:** Probably not. One use case is if you have a PHEV and want to monitor your charging progress. Another use case is if you want to use your vehicle as a temperature sensor. Otherwise, the data isn't going to change much after you've shutdown your vehicle. A future revision will expose vehicle polling as a service to enable incorporation into automations.
+**A:** Probably not. One use case is if you have a PHEV and want to monitor your charging progress. Otherwise, the data isn't going to change much after you've shutdown your vehicle (tire pressures are only updated when the vehicle is in motion). A future revision will expose vehicle polling as a service to enable incorporation into automations.
diff --git a/source/_integrations/sun.markdown b/source/_integrations/sun.markdown
index 92a09903256..743179bd17e 100644
--- a/source/_integrations/sun.markdown
+++ b/source/_integrations/sun.markdown
@@ -36,7 +36,7 @@ If that is the case, you can configure it as described in the next paragraphs.
{% include integrations/config_flow.md %}
-## YAML Configuration
+## YAML configuration
Alternatively, this integration can be configured and set up manually via YAML
instead. To enable the sun integration in your installation, add the
diff --git a/source/_integrations/supervisord.markdown b/source/_integrations/supervisord.markdown
index c5a798b5ca5..1270b34152d 100644
--- a/source/_integrations/supervisord.markdown
+++ b/source/_integrations/supervisord.markdown
@@ -2,7 +2,7 @@
title: Supervisord
description: Instructions on how to integrate Supervisord within Home Assistant.
ha_category:
- - System Monitor
+ - System monitor
ha_release: '0.20'
ha_iot_class: Local Polling
ha_domain: supervisord
diff --git a/source/_integrations/surepetcare.markdown b/source/_integrations/surepetcare.markdown
index 7b25d8f5f85..459af80e85a 100644
--- a/source/_integrations/surepetcare.markdown
+++ b/source/_integrations/surepetcare.markdown
@@ -2,7 +2,7 @@
title: Sure Petcare
description: Instructions on how to integrate the Sure Petcare cat and pet flaps into Home Assistant.
ha_category:
- - Binary Sensor
+ - Binary sensor
- Lock
- Sensor
ha_release: 0.104
diff --git a/source/_integrations/swisscom.markdown b/source/_integrations/swisscom.markdown
index 502f6472f0b..948eaee8b47 100644
--- a/source/_integrations/swisscom.markdown
+++ b/source/_integrations/swisscom.markdown
@@ -2,7 +2,7 @@
title: Swisscom Internet-Box
description: Instructions on how to integrate Swisscom Internet-Box into Home Assistant.
ha_category:
- - Presence Detection
+ - Presence detection
ha_release: 0.32
ha_domain: swisscom
ha_iot_class: Local Polling
diff --git a/source/_integrations/switch.markdown b/source/_integrations/switch.markdown
index ba6ceba41f2..b6a3a3513c4 100644
--- a/source/_integrations/switch.markdown
+++ b/source/_integrations/switch.markdown
@@ -20,7 +20,7 @@ Keeps track which switches are in your environment, their state and allows you t
{% include integrations/building_block_integration.md %}
-## Device Class
+## Device class
The way these switches are displayed in the frontend can be modified in the [customize section](/docs/configuration/customizing-devices/). The following device classes are supported for switches:
diff --git a/source/_integrations/switchbot.markdown b/source/_integrations/switchbot.markdown
index b086f75d11f..9176f454e18 100644
--- a/source/_integrations/switchbot.markdown
+++ b/source/_integrations/switchbot.markdown
@@ -2,7 +2,7 @@
title: SwitchBot Bluetooth
description: Instructions on how to set up SwitchBot Devices.
ha_category:
- - Binary Sensor
+ - Binary sensor
- Cover
- Light
- Lock
@@ -47,7 +47,7 @@ Please note, device names configured in the SwitchBot app are not transferred in
{% include integrations/config_flow.md %}
-## Supported Devices
+## Supported devices
- [Color Bulb (WoBulb)](https://switch-bot.com/pages/switchbot-color-bulb)
- [Bot (WoHand)](https://switch-bot.com/pages/switchbot-bot)
diff --git a/source/_integrations/symfonisk.markdown b/source/_integrations/symfonisk.markdown
index 327c1d06567..8599c3e9b8a 100644
--- a/source/_integrations/symfonisk.markdown
+++ b/source/_integrations/symfonisk.markdown
@@ -2,7 +2,7 @@
title: IKEA SYMFONISK
description: Connect and control your IKEA SYMFONISK devices using the Sonos integration
ha_category:
- - Media Player
+ - Media player
- Sensor
ha_domain: symfonisk
ha_release: 0.7.3
diff --git a/source/_integrations/syncthing.markdown b/source/_integrations/syncthing.markdown
index 60ff8af7c72..295560a1aa5 100644
--- a/source/_integrations/syncthing.markdown
+++ b/source/_integrations/syncthing.markdown
@@ -29,7 +29,7 @@ the key on the right of the settings dialog.
{% include integrations/config_flow.md %}
-## Integration Entities
+## Integration entities
The Syncthing integration adds one sensor per syncing folder:
diff --git a/source/_integrations/syncthru.markdown b/source/_integrations/syncthru.markdown
index 4e964684a17..8282af23a5c 100644
--- a/source/_integrations/syncthru.markdown
+++ b/source/_integrations/syncthru.markdown
@@ -2,7 +2,7 @@
title: Samsung SyncThru Printer
description: Instructions on how to integrate a Samsung printer providing SyncThru within Home Assistant.
ha_category:
- - System Monitor
+ - System monitor
ha_iot_class: Local Polling
ha_release: 0.66
ha_config_flow: true
diff --git a/source/_integrations/synology_dsm.markdown b/source/_integrations/synology_dsm.markdown
index 38ff74584e8..7e9153cb4fa 100644
--- a/source/_integrations/synology_dsm.markdown
+++ b/source/_integrations/synology_dsm.markdown
@@ -3,8 +3,8 @@ title: Synology DSM
description: Instructions on how to integrate the Synology DSM sensor within Home Assistant.
ha_category:
- Camera
- - Media Source
- - System Monitor
+ - Media source
+ - System monitor
- Update
ha_release: 0.32
ha_iot_class: Local Polling
@@ -128,7 +128,7 @@ Reboot the NAS.
Shutdown the NAS.
-## Media Source
+## Media source
A media source is provided for your [Synology Photos](https://www.synology.com/en-global/dsm/feature/photos).
diff --git a/source/_integrations/synology_srm.markdown b/source/_integrations/synology_srm.markdown
index 7149a8f4259..801023e4fd8 100644
--- a/source/_integrations/synology_srm.markdown
+++ b/source/_integrations/synology_srm.markdown
@@ -2,7 +2,7 @@
title: Synology SRM
description: Instructions on how to integrate Synology SRM routers into Home Assistant.
ha_category:
- - Presence Detection
+ - Presence detection
ha_iot_class: Local Polling
ha_release: 0.87
ha_codeowners:
diff --git a/source/_integrations/system_bridge.markdown b/source/_integrations/system_bridge.markdown
index 10bfcf69934..de66f82144d 100644
--- a/source/_integrations/system_bridge.markdown
+++ b/source/_integrations/system_bridge.markdown
@@ -3,7 +3,7 @@ title: System Bridge
description: How to integrate the System Bridge integration into Home Assistant.
ha_category:
- Sensor
- - System Monitor
+ - System monitor
ha_release: 2021.6
ha_iot_class: Local Push
ha_config_flow: true
@@ -25,10 +25,10 @@ ha_integration_type: device
## Prerequisites
### Version
This integration requires System Bridge 3.1.1 and above. Any older version will not work.
-### API Key
+### API key
You will need your API key. This can be found following the documentation [here](https://system-bridge.timmo.dev/docs/running).
{% include integrations/config_flow.md %}
-## Binary Sensors
+## Binary sensors
This integration provides the following binary sensors:
| Name | Description |
| --------------------- | ---------------------------------- |
@@ -80,7 +80,7 @@ The integration also provides a media player. This allows you control the curren
> This is currently only supported devices running System Bridge on Windows.
-## Media Source
+## Media source
This integration is available as a media source to use with the media browser integration. You can browse and view media from your system to media players such as your web browser and other supported media players.
diff --git a/source/_integrations/systemmonitor.markdown b/source/_integrations/systemmonitor.markdown
index 22fa1b3ef55..e0b12b7c057 100644
--- a/source/_integrations/systemmonitor.markdown
+++ b/source/_integrations/systemmonitor.markdown
@@ -1,8 +1,8 @@
---
-title: System Monitor
+title: System monitor
description: Instructions on how to monitor the Home Assistant host.
ha_category:
- - System Monitor
+ - System monitor
ha_release: pre 0.7
ha_iot_class: Local Push
ha_domain: systemmonitor
diff --git a/source/_integrations/tado.markdown b/source/_integrations/tado.markdown
index 43f55c7d0fd..8f7b487c2a9 100644
--- a/source/_integrations/tado.markdown
+++ b/source/_integrations/tado.markdown
@@ -2,12 +2,12 @@
title: Tado
description: Instructions on how to integrate Tado devices with Home Assistant.
ha_category:
- - Binary Sensor
+ - Binary sensor
- Climate
- Hub
- - Presence Detection
+ - Presence detection
- Sensor
- - Water Heater
+ - Water heater
- Weather
ha_release: 0.41
ha_iot_class: Cloud Polling
@@ -31,10 +31,10 @@ The Tado integration platform is used as an interface to the [my.tado.com](https
There is currently support for the following device types within Home Assistant:
-- Binary Sensor - for some additional information of the zones.
+- Binary sensor - for some additional information of the zones.
- Climate - for every Tado zone.
-- Water Heater - for water heater zones.
-- [Presence Detection](#presence-detection)
+- Water heater - for water heater zones.
+- [Presence detection](#presence-detection)
- Sensor - for some additional information of the zones.
- Weather - for information about the current weather at the location of your Tado home.
@@ -44,7 +44,7 @@ The Tado thermostats are internet connected thermostats. There exists an unoffic
It currently supports presenting the current temperature, the setting temperature and the current operation mode. The operation mode can be set to manual, auto and off. If no user is at home anymore, all Tado zones show the away-state (Only with Tado assist mode). Manually switching between home-mode and away-mode is also supported. Manually switching to auto-mode is only supported with Tado assist mode. Any Tado climate card can be switched between these presence modes, this changes the setting for the entire home.
-## Presence Detection
+## Presence detection
The `tado` device tracker is using the [Tado Smart Thermostat](https://www.tado.com/) and its support for person presence detection based on smartphone location by geofencing.
diff --git a/source/_integrations/tag.markdown b/source/_integrations/tag.markdown
index 2e60cec3123..7c86d1477e0 100644
--- a/source/_integrations/tag.markdown
+++ b/source/_integrations/tag.markdown
@@ -106,7 +106,7 @@ Happy printing!
-## Tag Scanned events
+## Tag scanned events
When a tag is scanned, the `tag_scanned` event is fired. This event contains the values:
diff --git a/source/_integrations/tag.mqtt.markdown b/source/_integrations/tag.mqtt.markdown
index 7a4c45db2c2..eda4f07dc55 100644
--- a/source/_integrations/tag.mqtt.markdown
+++ b/source/_integrations/tag.mqtt.markdown
@@ -1,8 +1,8 @@
---
-title: "MQTT Tag Scanner"
+title: "MQTT tag scanner"
description: "Instructions on how to integrate MQTT scanner within Home Assistant."
ha_category:
- - Tag Scanner
+ - Tag scanner
ha_release: 0.116
ha_iot_class: Configurable
ha_domain: mqtt
diff --git a/source/_integrations/tailscale.markdown b/source/_integrations/tailscale.markdown
index 387852e8a39..b1fa85a9ffd 100644
--- a/source/_integrations/tailscale.markdown
+++ b/source/_integrations/tailscale.markdown
@@ -2,7 +2,7 @@
title: Tailscale
description: Instructions on how to integrate Tailscale within Home Assistant.
ha_category:
- - Binary Sensor
+ - Binary sensor
- Network
- Sensor
ha_release: 2021.12
diff --git a/source/_integrations/tasmota.markdown b/source/_integrations/tasmota.markdown
index 4c6a0faae74..185dcf63f94 100644
--- a/source/_integrations/tasmota.markdown
+++ b/source/_integrations/tasmota.markdown
@@ -2,7 +2,7 @@
title: Tasmota
description: Instructions on how to integrate Tasmota with Home Assistant.
ha_category:
- - Binary Sensor
+ - Binary sensor
- Cover
- Fan
- Light
@@ -34,7 +34,7 @@ This integration allows you to control [Tasmota](https://tasmota.github.io/docs/
- Tasmota devices configured for native discovery (`SetOption19 0`).
- Although the Tasmota integration supports custom fulltopic it is strongly suggested to leave fulltopic at its default, Tasmota does not prevent setting an invalid or non-unique fulltopic, for example a fulltopic without the `%prefix%` or `%topic%` tokens.
-## Supported Features
+## Supported features
Tasmota Buttons, Fans, Lights, Relays, Sensors, Shutters and Switches are supported.
diff --git a/source/_integrations/tcp.markdown b/source/_integrations/tcp.markdown
index 3d53e86cd8e..410221856d6 100644
--- a/source/_integrations/tcp.markdown
+++ b/source/_integrations/tcp.markdown
@@ -2,7 +2,7 @@
title: TCP
description: Instructions on how to set up TCP within Home Assistant.
ha_category:
- - Binary Sensor
+ - Binary sensor
- Sensor
ha_release: 0.14
ha_iot_class: Local Polling
@@ -17,7 +17,7 @@ The TCP integration allows the integration of some services for which a specific
There is currently support for the following device types within Home Assistant:
-- [Binary Sensor](#binary-sensor)
+- [Binary sensor](#binary-sensor)
- [Sensor](#sensor)
## Sensor
@@ -151,7 +151,7 @@ sensor:
{% endraw %}
-## Binary Sensor
+## Binary sensor
The TCP Binary Sensor is a type of [TCP Sensor](#sensor) which is either "off" or "on". In order to use this sensor type, in addition to the configuration for the TCP Sensor, you must supply a `value_on` value to represent what is returned when the device is turned on.
diff --git a/source/_integrations/telegram_webhooks.markdown b/source/_integrations/telegram_webhooks.markdown
index 4d9857f35aa..3116b7162ab 100644
--- a/source/_integrations/telegram_webhooks.markdown
+++ b/source/_integrations/telegram_webhooks.markdown
@@ -41,7 +41,7 @@ api_key:
parse_mode:
description: Default parser for messages if not explicit in message data, either `html` or `markdown`.
required: false
- default: markdown
+ default: "`markdown`"
type: string
proxy_url:
description: Proxy URL if working behind one (`socks5://proxy_ip:proxy_port`).
diff --git a/source/_integrations/tellduslive.markdown b/source/_integrations/tellduslive.markdown
index 260d0c25b83..2b4b1a99ea4 100644
--- a/source/_integrations/tellduslive.markdown
+++ b/source/_integrations/tellduslive.markdown
@@ -2,7 +2,7 @@
title: Telldus Live
description: Instructions on how to integrate Telldus Live into Home Assistant.
ha_category:
- - Binary Sensor
+ - Binary sensor
- Cover
- Hub
- Light
diff --git a/source/_integrations/template.markdown b/source/_integrations/template.markdown
index 7c1eb7684e1..41cbeada74b 100644
--- a/source/_integrations/template.markdown
+++ b/source/_integrations/template.markdown
@@ -2,7 +2,7 @@
title: Template
description: Instructions on how to integrate Template Sensors into Home Assistant.
ha_category:
- - Binary Sensor
+ - Binary sensor
- Button
- Helper
- Image
@@ -40,7 +40,7 @@ The `template` integration allows creating entities which derive their values fr
Sensors, binary (on/off) sensors, buttons, images, numbers and selects are covered on this page. For other types, please see the specific pages:
-- [Alarm Control Panel](/integrations/alarm_control_panel.template/)
+- [Alarm control panel](/integrations/alarm_control_panel.template/)
- [Cover](/integrations/cover.template/)
- [Fan](/integrations/fan.template/)
- [Light](/integrations/light.template/)
@@ -400,7 +400,7 @@ template:
[trigger-doc]: /docs/automation/trigger
-### Video Tutorial
+### Video tutorial
This video tutorial explains how to set up a Trigger based template that makes use of an action to retrieve the weather forecast (precipitation).
@@ -648,7 +648,7 @@ template:
{% endraw %}
-### State based binary sensor - Device Tracker sensor with Latitude and Longitude Attributes
+### State based binary sensor - device tracker sensor with latitude and longitude attributes
This example shows how to combine a non-GPS (e.g., NMAP) and GPS device tracker while still including latitude and longitude attributes
diff --git a/source/_integrations/tensorflow.markdown b/source/_integrations/tensorflow.markdown
index 7e436148fe5..3a2079de56f 100644
--- a/source/_integrations/tensorflow.markdown
+++ b/source/_integrations/tensorflow.markdown
@@ -2,7 +2,7 @@
title: TensorFlow
description: Detect and recognize objects with TensorFlow.
ha_category:
- - Image Processing
+ - Image processing
ha_iot_class: Local Polling
ha_release: 0.82
ha_domain: tensorflow
diff --git a/source/_integrations/tesla_wall_connector.markdown b/source/_integrations/tesla_wall_connector.markdown
index 337c870df0e..a4c7aa17cf0 100644
--- a/source/_integrations/tesla_wall_connector.markdown
+++ b/source/_integrations/tesla_wall_connector.markdown
@@ -2,7 +2,7 @@
title: Tesla Wall Connector
description: Instructions on how to integrate Tesla Wall Connector (Gen 3) into Home Assistant.
ha_category:
- - Binary Sensor
+ - Binary sensor
- Energy
- Sensor
ha_release: 2021.12
diff --git a/source/_integrations/third_reality.markdown b/source/_integrations/third_reality.markdown
index 8e890369d6d..29d4db226a1 100644
--- a/source/_integrations/third_reality.markdown
+++ b/source/_integrations/third_reality.markdown
@@ -6,7 +6,7 @@ ha_iot_class: Local Push
ha_category:
- Cover
- Switch
- - Binary Sensor
+ - Binary sensor
- Sensor
- Button
ha_domain: third_reality
diff --git a/source/_integrations/thomson.markdown b/source/_integrations/thomson.markdown
index 89875796fa8..85305376800 100644
--- a/source/_integrations/thomson.markdown
+++ b/source/_integrations/thomson.markdown
@@ -2,7 +2,7 @@
title: Thomson
description: Instructions on how to integrate Thomson routers into Home Assistant.
ha_category:
- - Presence Detection
+ - Presence detection
ha_release: 0.7
ha_domain: thomson
ha_iot_class: Local Polling
diff --git a/source/_integrations/threshold.markdown b/source/_integrations/threshold.markdown
index 997fb974043..5e880d62806 100644
--- a/source/_integrations/threshold.markdown
+++ b/source/_integrations/threshold.markdown
@@ -2,7 +2,7 @@
title: Threshold
description: Instructions on how to integrate threshold binary sensors into Home Assistant.
ha_category:
- - Binary Sensor
+ - Binary sensor
- Helper
- Utility
ha_iot_class: Local Polling
@@ -33,7 +33,7 @@ Upper limit:
description: The upper threshold which the observed value is compared against.
{% endconfiguration_basic %}
-## YAML Configuration
+## YAML configuration
Alternatively, this integration can be configured and set up manually via YAML
instead. To enable the Integration sensor in your installation, add the
diff --git a/source/_integrations/tibber.markdown b/source/_integrations/tibber.markdown
index dc6dc514d38..30b25c479b2 100644
--- a/source/_integrations/tibber.markdown
+++ b/source/_integrations/tibber.markdown
@@ -55,7 +55,7 @@ The `tibber` sensor provides the current electricity price if you are a [Tibber]
You also get sensors for monthly consumption, monthly cost, and monthly peak hour
If you have a Tibber Pulse it will also show the electricity consumption in real time.
-## Available Sensors
+## Available sensors
- Accumulated cost since midnight (requires active Tibber power deal)
- kWh consumed since midnight
diff --git a/source/_integrations/tile.markdown b/source/_integrations/tile.markdown
index 186a32d6cd7..fa5ef0adc15 100644
--- a/source/_integrations/tile.markdown
+++ b/source/_integrations/tile.markdown
@@ -3,7 +3,7 @@ title: Tile
description: Instructions on how to use Tile to track devices in Home Assistant.
ha_release: 0.58
ha_category:
- - Presence Detection
+ - Presence detection
ha_iot_class: Cloud Polling
ha_codeowners:
- '@bachya'
diff --git a/source/_integrations/timer.markdown b/source/_integrations/timer.markdown
index bfc2e5905e3..041e4e4f2d2 100644
--- a/source/_integrations/timer.markdown
+++ b/source/_integrations/timer.markdown
@@ -66,7 +66,7 @@ timer:
Pick an icon from [Material Design Icons](https://pictogrammers.com/library/mdi/) to use for your timer and prefix the name with `mdi:`. For example `mdi:car`, `mdi:ambulance`, or `mdi:motorbike`.
-## Possible States
+## Possible states
| State | Description |
| ----- | ----------- |
diff --git a/source/_integrations/tod.markdown b/source/_integrations/tod.markdown
index dee8bf1ef87..caa1cee5830 100644
--- a/source/_integrations/tod.markdown
+++ b/source/_integrations/tod.markdown
@@ -2,7 +2,7 @@
title: Times of the Day
description: Instructions on how to integrate Times of the Day binary sensors within Home Assistant.
ha_category:
- - Binary Sensor
+ - Binary sensor
- Helper
ha_release: 0.89
ha_iot_class: Calculated
@@ -26,7 +26,7 @@ Off time:
description: The time when the sensor should turn off.
{% endconfiguration_basic %}
-## YAML Configuration
+## YAML configuration
Alternatlively, this integration can be configured and set up manually via YAML instead. This has some additional functionality over the UI version.
diff --git a/source/_integrations/todo.markdown b/source/_integrations/todo.markdown
index a34e62d2400..4de30a98f67 100644
--- a/source/_integrations/todo.markdown
+++ b/source/_integrations/todo.markdown
@@ -1,38 +1,37 @@
---
-title: To-do
-description: Instructions on how to use To-do Lists within Home Assistant.
+title: To-do list
+description: Instructions on how to use to-do lists within Home Assistant.
ha_domain: todo
ha_release: 2023.11
ha_category:
- - To-do List
+ - To-do list
ha_quality_scale: internal
ha_codeowners:
- '@home-assistant/core'
ha_integration_type: entity
---
-The To-do List integration provides todo list entities, allowing other integrations
-to integrate To-do Lists into Home Assistant. To-do lists are shown on the To-do list
+The to-do list integration provides to-do list entities, allowing other integrations
+to integrate to-do lists into Home Assistant. To-do lists are shown on the to-do list
dashboard for tracking items and whether or not they have been completed.
{% include integrations/building_block_integration.md %}
-## Viewing and managing To-do lists
+## Viewing and managing to-do lists
-Each To-do list is represented as its own entity in Home Assistant and can be
+Each to-do list is represented as its own entity in Home Assistant and can be
viewed and managed on a to-do list dashboard. You can find the to-do list dashboard
in the main sidebar of your Home Assistant instance.
-## The state of a To-do List entity
+## The state of a to-do list entity
-The state of a To-do List entity is a number, which represents the number of
+The state of a to-do list entity is a number, which represents the number of
incomplete items in the list.
-
## Services
-Some To-do List integrations allow Home Assistant to manage the To-do Items in the list. The
-services provided by some To-do List entities are described below or you can read more about [Service Calls](/docs/scripts/service-calls/).
+Some to-do list integrations allow Home Assistant to manage the to-do items in the list. The
+services provided by some to-do list entities are described below or you can read more about [Service Calls](/docs/scripts/service-calls/).
### Service `todo.get_items`
@@ -56,7 +55,7 @@ data:
### Service `todo.add_item`
-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:
+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 |
| ---------------------- | -------- | ----------- | --------|
@@ -69,21 +68,21 @@ service: todo.add_item
target:
entity_id: todo.personal_tasks
data:
- item: "Submit Income Tax Return"
+ item: "Submit income tax return"
```
### Service `todo.update_item`
-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:
+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`
+| `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`
At least one of `rename` or `status` is required. This is a full example of
-a service call that updates the status and the name of a to-do Item.
+a service call that updates the status and the name of a to-do item.
```yaml
service: todo.update_item
@@ -97,7 +96,7 @@ data:
### Service `todo.remove_item`
-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:
+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 |
| ---------------------- | -------- | ----------- | --------|
@@ -106,7 +105,7 @@ Removing a To-do Item. A to-do list `target` is selected with a [Target Selector
This is a full example of a service call that deletes a to-do Item with the specified name.
```yaml
-service: todo.delete_item
+service: todo.remove_item
target:
entity_id: todo.personal_tasks
data:
diff --git a/source/_integrations/todoist.markdown b/source/_integrations/todoist.markdown
index 4f1404904ba..a76b775331f 100644
--- a/source/_integrations/todoist.markdown
+++ b/source/_integrations/todoist.markdown
@@ -3,7 +3,7 @@ title: Todoist
description: Instructions on how to integrate Todoist into Home Assistant.
ha_category:
- Calendar
- - To-do List
+ - To-do list
ha_iot_class: Cloud Polling
ha_release: 0.54
ha_codeowners:
diff --git a/source/_integrations/tomato.markdown b/source/_integrations/tomato.markdown
index 0abfb1f163e..81582046bbc 100644
--- a/source/_integrations/tomato.markdown
+++ b/source/_integrations/tomato.markdown
@@ -2,7 +2,7 @@
title: Tomato
description: Instructions on how to integrate Tomato routers into Home Assistant.
ha_category:
- - Presence Detection
+ - Presence detection
ha_release: pre 0.7
ha_domain: tomato
ha_iot_class: Local Polling
diff --git a/source/_integrations/toon.markdown b/source/_integrations/toon.markdown
index 0d1b8118c21..57d91555332 100644
--- a/source/_integrations/toon.markdown
+++ b/source/_integrations/toon.markdown
@@ -2,7 +2,7 @@
title: Toon
description: Instructions on how to integrate Eneco Toon/Engie Electrabel Boxx/Viesgo within Home Assistant.
ha_category:
- - Binary Sensor
+ - Binary sensor
- Climate
- Energy
- Sensor
@@ -39,7 +39,7 @@ and a Toon API developer account.
There is currently support for the following device types within Home Assistant:
-- [Binary Sensor](#binary-sensor)
+- [Binary sensor](#binary-sensor)
- [Climate](#climate)
- [Sensor](#sensor)
- [Switch](#switch)
@@ -91,7 +91,7 @@ Internal examples: `http://192.168.0.2:8123/auth/external/callback`, `http://hom
{% enddetails %}
-## Binary Sensor
+## Binary sensor
The Toon integration provides the following binary sensors:
diff --git a/source/_integrations/totalconnect.markdown b/source/_integrations/totalconnect.markdown
index 75a76442822..4c1f859116c 100644
--- a/source/_integrations/totalconnect.markdown
+++ b/source/_integrations/totalconnect.markdown
@@ -3,7 +3,7 @@ title: Total Connect
description: Integrate Resideo Total Connect 2.0-enabled alarm systems into Home Assistant.
ha_category:
- Alarm
- - Binary Sensor
+ - Binary sensor
ha_release: 0.42
ha_iot_class: Cloud Polling
ha_config_flow: true
@@ -76,9 +76,9 @@ sudo apt install libxml2-dev libxmlsec1-dev
{% enddetails %}
-## Alarm Control Panel
+## Alarm control panel
-The integration provides an Alarm Control Panel for each Total Connect location. It uses the name of your location from Total Connect. For example, if your location name in Total Connect is "Home", Home Assistant will use `alarm_control_panel.home`.
+The integration provides an alarm control panel for each Total Connect location. It uses the name of your location from Total Connect. For example, if your location name in Total Connect is "Home", Home Assistant will use `alarm_control_panel.home`.
The alarm control panel supports the following services: `alarm_arm_away`, `alarm_arm_home`, `alarm_arm_night`, and `alarm_disarm`. The integration also provides unique services for `totalconnect.arm_home_instant` and `totalconnect.arm_away_instant` which arms the system with zero entry delay, triggering the alarm instantly if an entry/exit zone is faulted.
@@ -88,9 +88,9 @@ The `triggered` state also provides a state attribute called `triggered_source`
- `Fire/Smoke` is when fire or smoke is detected, and/or the Fire button was pressed
- `Carbon Monoxide` is when carbon monoxide is detected
-## Binary Sensor
+## Binary sensor
-The integration provides a Binary Sensor for each Total Connect zone. To see faulted zones in Home Assistant, your Total Connect account must have "Sensor Activities" enabled. Your alarm monitoring company may charge an extra fee to enable this. If available, these can be found in the Total Connect 2 web portal at **Notifications** -> **Sensor Activities**. Alternately, they can be found in the Total Connect mobile app at **More** -> **Settings** -> **Notifications** -> **Sensor Activities**. Enable each zone you want to monitor. Unmonitored zones will display as `Closed` in Home Assistant.
+The integration provides a binary sensor for each Total Connect zone. To see faulted zones in Home Assistant, your Total Connect account must have "Sensor Activities" enabled. Your alarm monitoring company may charge an extra fee to enable this. If available, these can be found in the Total Connect 2 web portal at **Notifications** -> **Sensor Activities**. Alternately, they can be found in the Total Connect mobile app at **More** -> **Settings** -> **Notifications** -> **Sensor Activities**. Enable each zone you want to monitor. Unmonitored zones will display as `Closed` in Home Assistant.
The Total Connect API has limited zone type information. Home Assistant device class `door` is assigned to Total Connect entry/exit, perimeter, and motion zones; along with most alarm panel buttons. The sensor will appear as `True` if the zone is opened (either fault or triggered in Total Connect) and `False` if closed. Device class `smoke` is assigned to Total Connect smoke detectors and alarm panel buttons set to a "Fire No Verification" response type. The sensor will appear as `True` if smoke is detected or the respective button is pressed. Device class `gas` is assigned to Total Connect carbon monoxide detectors. The sensor will appear as `True` if carbon monoxide is detected.
diff --git a/source/_integrations/tplink_omada.markdown b/source/_integrations/tplink_omada.markdown
index def34f540a7..5c8bb88ea64 100644
--- a/source/_integrations/tplink_omada.markdown
+++ b/source/_integrations/tplink_omada.markdown
@@ -57,6 +57,6 @@ Controller versions 5.1.0 and later are supported.
- Firmware Update entities.
- WAN/LAN Port connectivity sensor entities.
-## Device Trackers
+## Device trackers
- Not currently supported.
diff --git a/source/_integrations/traccar.markdown b/source/_integrations/traccar.markdown
index f09b7b78931..829318c8b42 100644
--- a/source/_integrations/traccar.markdown
+++ b/source/_integrations/traccar.markdown
@@ -4,7 +4,7 @@ description: Instructions how to use Traccar GPS tracker to track devices in Hom
ha_release: 0.83
ha_category:
- Car
- - Presence Detection
+ - Presence detection
ha_iot_class: Local Polling
ha_config_flow: true
ha_codeowners:
@@ -17,11 +17,11 @@ ha_integration_type: integration
`Traccar` uses GPS for tracking and has support for over 1500 different types of devices. One option is to track the [Traccar Client](https://www.traccar.org/client/) app on a smartphone via `webhook`. The other option is to connect to an existing [Traccar Server](https://www.traccar.org/server/) installation which is also available as Home Assistant add-on.
-## Traccar Client
+## Traccar client
To configure Traccar Client, you must set it up via the integrations panel in the configuration screen. This will give you the webhook URL to use during mobile device configuration. This URL has to be set in the Traccar app.
-## Traccar Server
+## Traccar server
To integrate Traccar Server in Home Assistant, add the following section to your `configuration.yaml` file:
diff --git a/source/_integrations/tractive.markdown b/source/_integrations/tractive.markdown
index 82e454491f5..93b41dc1a02 100644
--- a/source/_integrations/tractive.markdown
+++ b/source/_integrations/tractive.markdown
@@ -2,7 +2,7 @@
title: Tractive
description: Instructions on how to integrate Tractive within Home Assistant.
ha_category:
- - Presence Detection
+ - Presence detection
ha_release: 2021.9
ha_iot_class: Cloud Push
ha_config_flow: true
@@ -30,7 +30,7 @@ To use the integration you must be a premium tractive client.
{% include integrations/config_flow.md %}
-## Integration Entities
+## Integration entities
The Tractive integration adds one device tracker and several sensors and switches per registered pet:
diff --git a/source/_integrations/trafikverket_camera.markdown b/source/_integrations/trafikverket_camera.markdown
index 3898babd366..17f9b4a3af8 100644
--- a/source/_integrations/trafikverket_camera.markdown
+++ b/source/_integrations/trafikverket_camera.markdown
@@ -2,7 +2,7 @@
title: Trafikverket Camera
description: Instructions how to integrate Trafikverket Camera within Home Assistant.
ha_category:
- - Binary Sensor
+ - Binary sensor
- Camera
- Sensor
ha_release: 2023.9
diff --git a/source/_integrations/transmission.markdown b/source/_integrations/transmission.markdown
index 9d24b856d80..81cfaa1d6ae 100644
--- a/source/_integrations/transmission.markdown
+++ b/source/_integrations/transmission.markdown
@@ -26,7 +26,7 @@ Your Transmission client must first be configured to allow remote access. In you
{% include integrations/config_flow.md %}
-## Integration Entities
+## Integration entities
The Transmission integration will add the following sensors and switches.
@@ -44,7 +44,7 @@ The Transmission integration will add the following sensors and switches.
- `switch.transmission_switch`: A switch to start/stop all torrents.
- `switch.transmission_turtle_mode`: A switch to enable turtle mode (a.k.a. alternative speed limits).
-## Event Automation
+## Event automation
The Transmission integration is continuously monitoring the status of torrents in the target client. Once a torrent is started or completed, an event is triggered on the Home Assistant Bus containing the torrent name and ID, which can be used with automations.
diff --git a/source/_integrations/trend.markdown b/source/_integrations/trend.markdown
index 55372e82287..25de2e0aad7 100644
--- a/source/_integrations/trend.markdown
+++ b/source/_integrations/trend.markdown
@@ -2,7 +2,7 @@
title: Trend
description: Instructions on how to integrate Trend binary sensors into Home Assistant.
ha_category:
- - Binary Sensor
+ - Binary sensor
- Utility
ha_release: 0.28
ha_iot_class: Calculated
diff --git a/source/_integrations/tts.markdown b/source/_integrations/tts.markdown
index d8b6f33cea9..38094e944f5 100644
--- a/source/_integrations/tts.markdown
+++ b/source/_integrations/tts.markdown
@@ -2,7 +2,7 @@
title: Text-to-speech (TTS)
description: Instructions on how to set up text-to-speech (TTS) with Home Assistant.
ha_category:
- - Media Source
+ - Media source
- Text-to-speech
ha_release: 0.35
ha_codeowners:
@@ -29,7 +29,8 @@ The `tts.speak` service supports `language` and on some platforms also `options`
```yaml
service: tts.speak
-target: tts.example
+target:
+ entity_id: tts.example
data:
media_player_entity_id: media_player.kitchen
message: "May the force be with you."
diff --git a/source/_integrations/tuya.markdown b/source/_integrations/tuya.markdown
index 06c37a739f9..ea359545ff3 100644
--- a/source/_integrations/tuya.markdown
+++ b/source/_integrations/tuya.markdown
@@ -2,7 +2,7 @@
title: Tuya
description: Instructions on how to set up the Tuya hub within Home Assistant.
ha_category:
- - Binary Sensor
+ - Binary sensor
- Camera
- Climate
- Cover
@@ -174,7 +174,7 @@ If no devices show up in Home Assistant:
Tuya supports scenes in their app. These allow triggering some of the more complex modes of various devices such as light changing effects. Scenes created in the Tuya app will automatically appear in the Scenes list in Home Assistant the next time the integration updates.
-## Related Documents
+## Related documents
- [Tuya Integration Documentation Page](https://github.com/tuya/tuya-home-assistant)
- [Supported Tuya Device Category](https://github.com/tuya/tuya-home-assistant/blob/main/docs/supported_devices.md)
diff --git a/source/_integrations/ubiwizz.markdown b/source/_integrations/ubiwizz.markdown
index 9eee961b09a..538bfcf2282 100644
--- a/source/_integrations/ubiwizz.markdown
+++ b/source/_integrations/ubiwizz.markdown
@@ -3,7 +3,7 @@ title: Ubiwizz
description: Connect and control your Ubiwizz devices using the Overkiz integration
ha_category:
- Alarm
- - Binary Sensor
+ - Binary sensor
- Button
- Climate
- Cover
@@ -16,7 +16,7 @@ ha_category:
- Sensor
- Siren
- Switch
- - Water Heater
+ - Water heater
ha_domain: ubiwizz
ha_integration_type: virtual
ha_supporting_domain: overkiz
diff --git a/source/_integrations/ubus.markdown b/source/_integrations/ubus.markdown
index 01240032804..a5f1549a946 100644
--- a/source/_integrations/ubus.markdown
+++ b/source/_integrations/ubus.markdown
@@ -2,7 +2,7 @@
title: OpenWrt (ubus)
description: Instructions on how to integrate OpenWRT routers into Home Assistant.
ha_category:
- - Presence Detection
+ - Presence detection
ha_release: 0.7.6
ha_iot_class: Local Polling
ha_domain: ubus
@@ -87,7 +87,7 @@ See the [device tracker integration page](/integrations/device_tracker/) for ins
If you find that this never creates `known_devices.yaml`, or if you need more information on the communication chain between Home Assistant and OpenWrt, follow these steps to grab the packet stream and gain insight into what's happening.
-### Increase Log Level
+### Increase log level
1. On your Home Assistant device, stop Home Assistant
2. Adjust `configuration.yaml` to log more detail for the `device_tracker` integration.
@@ -128,7 +128,7 @@ If you find that this never creates `known_devices.yaml`, or if you need more in
17-04-28 10:50:34 INFO (Thread-7) [homeassistant.components.device_tracker.ubus] Checking ARP
```
-### Inspect Packets With TCPDump
+### Inspect packets with TCPDump
_These steps require that `tcpdump` is installed on your Home Assistant device, and that you have a utility such as [Wireshark](https://www.wireshark.org) for viewing the packets. It also assumes that Home Assistant is communicating with your router over HTTP and not HTTPS._
diff --git a/source/_integrations/ue_smart_radio.markdown b/source/_integrations/ue_smart_radio.markdown
index 1ef36a30999..da0cc8d87ce 100644
--- a/source/_integrations/ue_smart_radio.markdown
+++ b/source/_integrations/ue_smart_radio.markdown
@@ -2,7 +2,7 @@
title: Logitech UE Smart Radio
description: Instructions on how to integrate a Logitech UE Smart Radio player into Home Assistant.
ha_category:
- - Media Player
+ - Media player
ha_release: '0.60'
ha_iot_class: Cloud Polling
ha_domain: ue_smart_radio
diff --git a/source/_integrations/uk_transport.markdown b/source/_integrations/uk_transport.markdown
index 0519fb0e7f0..df549398783 100644
--- a/source/_integrations/uk_transport.markdown
+++ b/source/_integrations/uk_transport.markdown
@@ -153,6 +153,6 @@ template:
## Managing API requests
-If you wish to manage the rate of API requests (e.g., to disable requests when you aren't interested in travel, so that you can request updates more frequently when you do travel) set a really long `scan_interval` in the configuration options, and use the service `homeassistant.update_entity` to request the update of an entity, rather than waiting for the next scheduled update.
+If you wish to manage the rate of API requests (e.g., to disable requests when you aren't interested in travel, so that you can request updates more frequently when you do travel) set a really long `scan_interval` in the configuration options, and use the service `homeassistant.update_entity` to request the update of an {% term entity %}, rather than waiting for the next scheduled update.
Powered by [transportAPI](https://www.transportapi.com/)
diff --git a/source/_integrations/ukraine_alarm.markdown b/source/_integrations/ukraine_alarm.markdown
index e0300b5398b..6d6aa674a8b 100644
--- a/source/_integrations/ukraine_alarm.markdown
+++ b/source/_integrations/ukraine_alarm.markdown
@@ -14,7 +14,7 @@ ha_platforms:
ha_integration_type: integration
---
-The Ukraine Alarm integration uses the siren.pp.ua API - public wrapper for [Ukraine Alarm](https://www.ukrainealarm.com/) web service to offer air-raid siren notifications. The integration will create 6 binary sensors for your selected region in Ukraine:
+The **Ukraine Alarm** {% term integration %} uses the siren.pp.ua API - public wrapper for [Ukraine Alarm](https://www.ukrainealarm.com/) web service to offer air-raid siren notifications. The {% term integration %} will create 6 binary sensors for your selected region in Ukraine:
- Air
- Artillery
diff --git a/source/_integrations/ultraloq.markdown b/source/_integrations/ultraloq.markdown
index 11c2a37a5cb..c846c14d8d5 100644
--- a/source/_integrations/ultraloq.markdown
+++ b/source/_integrations/ultraloq.markdown
@@ -13,7 +13,7 @@ ha_iot_standard: zwave
Ultraloq smart locks allow users to enter their homes without a key. The lock can be controlled remotely using the Ultraloq app or by using Home Assistant. U-tec, their parent company, is a member of the Works with Home Assistant partner program. This means they are committed to making sure the Ultraloq Z-Wave products are up-to-date and ready to use with Home Assistant.
-Ultraloq Z-Wave Series smart locks work locally and integrate seamlessly with the Z-Wave integration in Home Assistant (Z-Wave stick required).
+Ultraloq Z-Wave Series smart locks work locally and integrate seamlessly with the **Z-Wave** {% term integration %} in Home Assistant (Z-Wave stick required).
To add Ultraloq Z-Wave products, pair them as Z-Wave devices:
diff --git a/source/_integrations/unifi.markdown b/source/_integrations/unifi.markdown
index af0fc86acae..10b4fa283b7 100644
--- a/source/_integrations/unifi.markdown
+++ b/source/_integrations/unifi.markdown
@@ -4,7 +4,7 @@ description: Instructions on how to configure UniFi Network integration with Uni
ha_category:
- Hub
- Image
- - Presence Detection
+ - Presence detection
- Sensor
- Switch
- Update
@@ -33,7 +33,7 @@ There is currently support for the following device types within Home Assistant:
- [Button](#button)
- [Image](#image)
-- [Presence Detection](#presence-detection)
+- [Presence detection](#presence-detection)
- [Switch](#switch)
- [Sensor](#sensor)
- [Firmware updates](#firmware-updates)
@@ -44,7 +44,7 @@ The user needs administrator privileges in order to control switches.
### Extra configuration of the integration
-All configuration options are offered from the front end. Enter what UniFi Network integration you want to change options on and press the cog wheel. Some advanced options are available when "Advanced Mode" is enabled on your user profile page.
+All configuration options are offered from the front end. Enter what UniFi Network {% term integration %} you want to change options on and press the cog wheel. Some advanced options are available when "Advanced Mode" is enabled on your user profile page.
### Configuring Users
@@ -56,7 +56,7 @@ For UniFi OS a local-only user needs to be created. A user who uses the Ubiquiti
### Conflicts with MQTT
-The UniFi Network application can either be a UniFi OS console device (like the Cloud Key), or as software on any Linux system. If you run the UniFi Network application on the same operating system as Home Assistant there may be conflicts in ports if you have the MQTT integration as well.
+The UniFi Network application can either be a UniFi OS console device (like the Cloud Key), or as software on any Linux system. If you run the UniFi Network application on the same operating system as Home Assistant there may be conflicts in ports if you have the MQTT {% term integration %} as well.
It is recommended that you run the UniFi Network application in a dedicated virtual machine to avoid that situation.
@@ -98,7 +98,7 @@ Try to get a wireless client to reconnect to the network.
| Service data attribute | Optional | Description |
| ---------------------- | -------- | --------------------------------------------------------------------------- |
-| `device_id` | No | String representing a device ID related to a UniFi Network integration. |
+| `device_id` | No | String representing a device ID related to a UniFi Network {% term integration %} . |
### Service unifi.remove_clients
@@ -108,7 +108,7 @@ Clean up clients on the UniFi Network application that has only been associated
### Block network access for clients
-Allow control of network access to clients configured in the integration options by adding MAC addresses. Items in this list will have a Home Assistant switch created, using the UniFi Device name, allowing for blocking and unblocking.
+Allow control of network access to clients configured in the {% term integration %} options by adding MAC addresses. Items in this list will have a Home Assistant switch created, using the UniFi Device name, allowing for blocking and unblocking.
### PoE port control
@@ -116,7 +116,7 @@ Provides per-port PoE control. Entities are disabled by default. This feature re
### Control DPI Traffic Restrictions
-Entities appear automatically for each restriction group. If there are no restrictions in a group, no entity will be visible. Toggling the switch in Home Assistant will enable or disable all restrictions inside a group.
+Entities appear automatically for each restriction group. If there are no restrictions in a group, no {% term entity %} will be visible. Toggling the switch in Home Assistant will enable or disable all restrictions inside a group.
### Control Port forward functonality
@@ -154,7 +154,7 @@ This will show if there are firmware updates available for the UniFi network dev
## Debugging integration
-If you have problems with the UniFi Network application or integration you can add debug prints to the log.
+If you have problems with the UniFi Network application or {% term integration %} you can add debug prints to the log.
```yaml
logger:
diff --git a/source/_integrations/unifi_direct.markdown b/source/_integrations/unifi_direct.markdown
index 4ebb2c14ffd..ce42a8a3b38 100644
--- a/source/_integrations/unifi_direct.markdown
+++ b/source/_integrations/unifi_direct.markdown
@@ -2,7 +2,7 @@
title: UniFi AP
description: Instructions on how to use a Unifi WAP as a device tracker.
ha_category:
- - Presence Detection
+ - Presence detection
ha_iot_class: Local Polling
ha_release: 0.59
ha_domain: unifi_direct
diff --git a/source/_integrations/unifiprotect.markdown b/source/_integrations/unifiprotect.markdown
index 1f768506ed6..cfcbb8bf313 100644
--- a/source/_integrations/unifiprotect.markdown
+++ b/source/_integrations/unifiprotect.markdown
@@ -2,15 +2,15 @@
title: UniFi Protect
description: Instructions on how to configure the Ubiquiti UniFi Protect integration.
ha_category:
- - Binary Sensor
+ - Binary sensor
- Button
- Camera
- Doorbell
- Hub
- Light
- Lock
- - Media Player
- - Media Source
+ - Media player
+ - Media source
- Number
- Select
- Sensor
@@ -41,13 +41,13 @@ ha_platforms:
ha_integration_type: hub
---
-The UniFi Protect integration adds support for retrieving Camera feeds and Sensor data from a [UniFi Protect application](https://ui.com/camera-security) by [Ubiquiti Networks, inc.](https://www.ui.com/) that is running on a UniFi OS Console.
+The **UniFi Protect** {% term integration %} adds support for retrieving camera feeds and sensor data from a [UniFi Protect application](https://ui.com/camera-security) by [Ubiquiti Networks, inc.](https://www.ui.com/) that is running on a UniFi OS Console.
## Prerequisites
-### Hardware Support
+### Hardware support
-This Integration supports all UniFi OS Consoles that can run UniFi Protect. Currently, this includes:
+This {% term integration %} supports all UniFi OS Consoles that can run UniFi Protect. Currently, this includes:
- Any UniFi Protect Network Video Recorder (**[UNVR](https://store.ui.com/collections/unifi-protect-nvr/products/unvr)** or **[UNVRPRO](https://store.ui.com/collections/unifi-protect-nvr/products/unvr-pro)**)
- Any UniFi "Dream" device (**[UDMPRO](https://store.ui.com/collections/unifi-network-unifi-os-consoles/products/udm-pro)**, **[UDR](https://store.ui.com/collections/unifi-network-unifi-os-consoles/products/dream-router)**, or **[UDMSE](https://store.ui.com/collections/unifi-network-unifi-os-consoles/products/dream-machine-se)**), _except the base UniFi Dream Machine/UDM_
@@ -55,7 +55,7 @@ This Integration supports all UniFi OS Consoles that can run UniFi Protect. Curr
UCKP with Firmware v1.x **do NOT run UniFi OS**, you must upgrade to firmware `[v2.0.24](https://community.ui.com/releases/UniFi-Cloud-Key-Firmware-2-0-24/b6684f1e-8542-4660-bc0b-74e0634448e8)` or newer.
-### Software Support
+### Software support
The absolute **minimal** software version is `[v1.20.0](https://community.ui.com/releases/UniFi-Protect-Application-1-20-0/d43c0905-3fb4-456b-a7ca-73aa830cb011)` for UniFi Protect. If you have an older version, you will get errors trying to set up the integration. However, the general advice is the latest 2 minor versions of UniFi Protect and hardware supported by those are supported.
@@ -65,15 +65,15 @@ The absolute **minimal** software version is `[v1.20.0](https://community.ui.com
**Early Access releases are not supported by Home Assistant.**
-Using Early Access versions will likely cause your UniFi Protect integration to break unexpectedly.
+Using Early Access versions will likely cause your UniFi Protect {% term integration %} to break unexpectedly.
#### Downgrading UniFi Protect
-In the event you accidentally upgrade to an Early Access version of UniFi Protect you can downgrade to a stable version by either [restoring a backup](https://help.ui.com/hc/articles/360008976393) or by manually downgrading your UniFi Protect.
+In the event you accidentally upgrade to an Early Access version of UniFi Protect, you can downgrade to a stable version by either [restoring a backup](https://help.ui.com/hc/articles/360008976393) or by manually downgrading your UniFi Protect.
-##### Manually Downgrade
+##### Manually downgrade
Manually downgrading comes with its own risks and it is not recommended unless you do not have a backup available. Some Protect versions cannot be downgraded from (like `v2.0` to `v1.21`). To downgrade, you can access your [UniFi OS Console via SSH](https://help.ui.com/hc/articles/204909374) and then do the following:
@@ -95,7 +95,7 @@ If you want to downgrade to another Early Access version, you must have [Remote
-### Local User
+### Local user
You will need a local user created in your UniFi OS Console to log in with. Ubiquiti SSO Cloud Users will **not** work.
It is recommended you use the Administrator or a user with full read/write access to get the most out of the integration,
@@ -112,7 +112,7 @@ use has.
-### Camera Streams
+### Camera streams
The integration uses the RTSP(S) Streams as the Live Feed source, so this needs to be enabled on each camera to ensure
you can stream your camera in Home Assistant. This may already be enabled by default, but it is recommended to just
@@ -126,20 +126,20 @@ check that this is done. To check and enable the feature:
{% include integrations/config_flow.md %}
-## Device Support
+## Device support
All known UniFi Protect devices should be supported. Each UniFi Protect device will get a variety of entities added for
-each of the different entity platforms.
+each of the different {% term entity %} platforms.
**Permissions**: The below sections on the features available to your Home Assistant instance assume you have full
write access to each device. If the user you are using has limited access to some devices, you will get fewer entities
-and in many cases, get a read-only sensor instead of an editable switch/select/number entity.
+and in many cases, get a read-only sensor instead of an editable switch/select/number {% term entity %}.
@@ -154,9 +154,9 @@ G3 Series cameras do _not_ have Smart detections.
Each UniFi Protect camera will get a device in Home Assistant with the following:
-- **Camera** - A camera for each camera channel and RTSP(S) combination found for each camera (up to 7). Only the highest resolution RTSPS camera entity will be enabled by default.
- - If your camera is a G4 Doorbell Pro, an additional camera entity will be added for the Package Camera. The Package Camera entity will _not_ have streaming capabilities regardless of whether RTSPS is enabled on the channel or not. This is due to the Package Camera having a very low FPS that does not make it compatible with HLS streaming.
-- **Media Player** - If your camera has a speaker, you will get a media player entity that allows you to play audio to your camera's speaker. Any audio file URI that is playable by FFmpeg will be able to be played to your speaker, including via the [TTS Say Service](/integrations/tts/#service-say).
+- **Camera** - A camera for each camera channel and RTSP(S) combination found for each camera (up to 7). Only the highest resolution RTSPS camera {% term entity %} will be enabled by default.
+ - If your camera is a G4 Doorbell Pro, an additional camera {% term entity %} will be added for the Package Camera. The Package Camera {% term entity %} will _not_ have streaming capabilities regardless of whether RTSPS is enabled on the channel or not. This is due to the Package Camera having a very low FPS that does not make it compatible with HLS streaming.
+- **Media Player** - If your camera has a speaker, you will get a media player {% term entity %} that allows you to play audio to your camera's speaker. Any audio file URI that is playable by FFmpeg will be able to be played to your speaker, including via the [TTS Say Service](/integrations/tts/#service-say).
- **Privacy Mode** - If your camera allows for Privacy Masks, there will be a configuration switch to toggle a "Privacy Mode" that disables recording, microphone, and a black privacy zone over the whole camera.
- **Sensors** - Sensors include "Is Dark", "Motion Detected", detected object sensors (if the camera supports smart detections), and "Doorbell Chime" (if the camera has a chime). Several diagnostics sensors are added including sensors on uptime, network connection stats, and storage stats. Doorbells will also have a "Voltage" sensor for troubleshooting electrical issues.
- There is one detected object sensor per Smart Detection supported by the camera and a combined sensor for if _any_ object is detected.
@@ -166,16 +166,16 @@ Each UniFi Protect camera will get a device in Home Assistant with the following
- configuration text and select for LCD Screen for doorbells to either set custom messages or use predefined messages
- **Button** - A disabled by default button is added for each camera device. The button will let you reboot your camera device.
-### UniFi Protect Floodlights
+### UniFi Protect floodlights
Each UniFi Protect floodlight will get a device in Home Assistant with the following:
-- **Light** - A light entity will be added for each floodlight device. The light entity will let you control turning on or off your light as well as adjust the brightness of your floodlight.
+- **Light** - A light {% term entity %} will be added for each floodlight device. The light {% term entity %} will let you control turning on or off your light as well as adjust the brightness of your floodlight.
- **Sensors** - Sensors are provided for data provided from floodlight devices. Sensors include "Is Dark" and "Motion Detected".
- **Device Configuration** - Floodlights will get configuration controls for the PIR Motion Sensitivity, the Auto-shutoff Duration after detected motion, and Status Light switch
- **Button** - A disabled by default button is added for each floodlight device. The button will let you reboot your floodlight device.
-### UniFi Protect Smart Sensors
+### UniFi Protect smart sensors
UniFi Protect smart sensors are a bit different than normal sensors. They are a multi-sensor that can act as a contact sensor (door/window), a motion detector, a light level detector, a humidity sensor, a temperature level sensor, an alarm sound sensor, and/or a leak detector. Each sensor function can be enabled or disabled dynamically. Disabled sensors will be marked as "unavailable".
@@ -190,11 +190,11 @@ UniFi Protect smart sensors are a bit different than normal sensors. They are a
- **Device Configuration** - Smart sensors will get configuration controls for the Status Light, enabling/disabling all of the main sensors, selecting the Paired Camera, and changing the Mount Type of the sensor.
- **Button** - A button to clear the tampered state as well as a disabled by default button to restart the device.
-#### Tamper Sensor
+#### Tamper sensor
-Once the tamper sensor is triggered, it stays active until manually cleared. A button entity is available to clear the tampered state.
+Once the tamper sensor is triggered, it stays active until manually cleared. A button {% term entity %} is available to clear the tampered state.
-### UniFi Protect Viewers
+### UniFi Protect viewers
Each UniFi Protect viewer will get a device in Home Assistant with the following:
@@ -223,11 +223,11 @@ Your main UniFi Protect NVR device also gets a number of diagnostics sensors tha
- **Disk Health**: Each disk installed in your NVR will have a disk health sensor. These are simple good/bad sensors and the order is not promised to match the order in UniFi OS. Disk model number is provided as a state attribute though to help map sensor to disk.
- **Utilization and Storage Sensors**: Several other sensors are also added for uptime, hardware utilization, and distribution details of the video on disk.
-## Media Source
+## Media source
A media source is provided for your UniFi Protect cameras so you can fetch video clips and event thumbnails.
-### Media Browser
+### Media browser
The media source is split into 5 folders/levels:
@@ -243,9 +243,9 @@ The media source is split into 5 folders/levels:
Since the media browser does not have any pagination or filtering, all of the events must be loaded into memory. As a result, the number of events loaded at once is truncated to 10,000 by default. The number of events will be listed at "10000 (TRUNCATED)" if the event count was truncated. You can raise or lower the limit of the number of events that can be loaded using the Config Entry Options.
-### Media Identifiers
+### Media identifiers
-Below are the accepted identifiers to resolve media. Since events do not necessarily map to any Home Assistant entity, all IDs are in reference to the UniFi Protect IDs, not Home Assistant ones.
+Below are the accepted identifiers to resolve media. Since events do not necessarily map to any Home Assistant {% term entity %}, all IDs are in reference to the UniFi Protect IDs, not Home Assistant ones.
| Identifier Format | Description |
| -------------------------------- | ---------------------------------- |
@@ -292,32 +292,32 @@ Use to set the paired doorbell(s) with a smart chime.
## Views
-The integration 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 integration.
+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 %}.
-These URLs work great when trying to send notifications. Home Assistant will automatically sign the URLs and make them safe for external consumption if used in an automation or [notify service](/integrations/notify/).
+These URLs work great when trying to send notifications. Home Assistant will automatically sign the URLs and make them safe for external consumption if used in an {% term automation %} or [notify service](/integrations/notify/).
| View URL | Description |
| ------------------------------------------------------------ | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `/api/unifiprotect/thumbnail/{nvr_id}/{event_id}` | Proxies a JPEG event thumbnail from UniFi Protect. |
| `/api/unifiprotect/video/{nvr_id}/{camera_id}/{start}/{end}` | Proxies a MP4 video clip from UniFi Protect for a specific camera. Start and end must be in [ISO 8601 format](https://www.iso.org/iso-8601-date-and-time-format.html). |
-`nvr_id` can either be the UniFi Protect ID of your NVR or the config entry ID for your UniFi Protect integration. `camera_id` can either be the UniFi Protect ID of your camera or an entity ID of any entity provided by the UniFi Protect integration that can be reversed to a UniFi Protect camera (i.e., an entity ID of a detected object sensor).
+`nvr_id` can either be the UniFi Protect ID of your NVR or the config entry ID for your UniFi Protect {% term integrations %}. `camera_id` can either be the UniFi Protect ID of your camera or an entity ID of any {% term entity %} provided by the UniFi Protect {% term integrations %} that can be reversed to a UniFi Protect camera (i.e., an entity ID of a detected object sensor).
The easiest way to find the `nvr_id`, `camera_id`, `start`, and `end` times is by viewing one of the videos from UniFi Protect in the Media browser. If you open the video in a new browser tab, you will see all these values in the URL. The `start` time is the last_changed timestamp of the event when the sensor started detecting motion. The `end` time is the last_changed timestamp of the event when the sensor stopped detecting motion. Similarly, to see the `event_id` of the image, go to {% my developer_states title="**Developer Tools** > **States**" %} and find the event when the sensor started detecting motion.
## Troubleshooting
-### Delay in Video Feed
+### Delay in video feed
The default settings on the stream integration will give you a 5-15+ second delay. You can reduce this delay to 1-3 seconds, by enabling [LL-HLS in the stream integration](/integrations/stream/#ll-hls). You will also want to put an HTTP/2 reserve proxy in front of Home Assistant so you can have connection pooling. If you do not add a reverse proxy, you may start to get "Waiting for WebSocket..." messages while trying to view too many camera streams at once. One way to do this is using the official NGINX Proxy Add-on:
{% my supervisor_addon addon="core_nginx_proxy" badge %}
-### Cannot Play Audio to Speakers
+### Cannot play audio to speakers
Unlike with many other things, playing audio to your speakers requires your Home Assistant to be able to reach your camera directly. Specifically via port `tcp/7004`. You can [enable debug logging](#enabling-debug-logging) and it will output the full FFmpeg command that will be run and the output from FFmpeg to help you troubleshoot why audio is not playing to the device.
-### Liveview Options for Viewer Missing Options or Out of Date
+### Liveview options for viewer missing options or out of date
Main control selects currently cannot have dynamic options since the options are exported out to voice assistants. After you add/remove/change a Liveview in UniFi Protect, you must restart Home Assistant to get the new options for your Viewer.
diff --git a/source/_integrations/universal.markdown b/source/_integrations/universal.markdown
index a0de226dce1..5838f0199e3 100644
--- a/source/_integrations/universal.markdown
+++ b/source/_integrations/universal.markdown
@@ -1,8 +1,8 @@
---
-title: Universal Media Player
+title: Universal media player
description: Instructions on how to create a universal media player in Home Assistant.
ha_category:
- - Media Player
+ - Media player
ha_iot_class: Calculated
ha_release: 0.11
ha_quality_scale: internal
@@ -12,11 +12,11 @@ ha_platforms:
ha_integration_type: integration
---
-A Universal Media Player can combine multiple existing entities in Home Assistant into a single media player entity. This is used to create a single media player entity that can control an entire media center.
+A universal media player can combine multiple existing entities in Home Assistant into a single media player {% term entity %}. This is used to create a single media player {% term entity %} that can control an entire media center.
-Multiple media player entities may be controlled from a Universal Media Player. Additionally, the Universal Media Player can enable volume and power commands to be directed to other Home Assistant entities. This enables the media player power and volume commands to control devices like a television, amplifier or audio receiver, for example.
+Multiple media player entities may be controlled from a universal media player. Additionally, the universal media player can enable volume and power commands to be directed to other Home Assistant entities. This enables the media player power and volume commands to control devices like a television, amplifier or audio receiver, for example.
-A Universal Media Player is created in `configuration.yaml` as follows.
+A universal media player is created in `configuration.yaml` as follows.
```yaml
# Example configuration.yaml entry
@@ -101,13 +101,13 @@ unique_id:
type: string
{% endconfiguration %}
-The Universal Media Player will primarily imitate one of its `children`. The Universal Media Player will control the first child on the list that is active (not idle/off). The Universal Media Player will also inherit its state from the first active child if a `state_template` is not provided. Entities in the `children:` list must be media players, but the state template can contain any entity.
+The universal media player will primarily imitate one of its `children`. The universal media player will control the first child on the list that is active (not idle/off). The universal media player will also inherit its state from the first active child if a `state_template` is not provided. Entities in the `children:` list must be media players, but the state template can contain any {% term entity %}.
-Using `active_child_template` will allow you to specify an active entity if the default behavior is unsuitable for your task. The template must return the `entity_id` of the child that will be selected as active or `None` to return the default behavior.
+Using `active_child_template` will allow you to specify an active {% term entity %} if the default behavior is unsuitable for your task. The template must return the `entity_id` of the child that will be selected as active or `None` to return the default behavior.
It is recommended that the command `turn_on`, the command `turn_off`, and the attribute `state` all be provided together. The `state` attribute indicates if the media player is on or off. If `state` indicates the media player is off, this status will take precedence over the states of the children. If all the children are idle/off and `state` is on, the Universal Media Player's state will be on. If not provided, the `toggle` command will delegate to `turn_on` or `turn_off` based on the `state`.
-It is also recommended that the command `volume_up`, the command `volume_down`, the command `volume_mute`, and the attribute `is_volume_muted` all be provided together. The attribute `is_volume_muted` should return either True or the on state when the volume is muted. The `volume_mute` service should toggle the mute setting.
+It is also recommended that the command `volume_up`, the command `volume_down`, the command `volume_mute`, and the attribute `is_volume_muted` all be provided together. The attribute `is_volume_muted` should return either True or the on state when the volume is muted. The `volume_mute` {% term service %} should toggle the mute setting.
When providing `select_source` as a command, it is recommended to also provide the attributes `source`, and `source_list`. The `source` attribute is the currently select source, while the `source_list` attribute is a list of all available sources.
@@ -119,7 +119,7 @@ The `browse_media_entity` parameter allows you to specify which media player wil
### Chromecast & Kodi control with switches
-In this example, a switch is available to control the power to the television. Switches are also available to turn the volume up, turn the volume down, and mute the audio. These could be command line switches or any other entity in Home Assistant. The `turn_on` and `turn_off` commands will be redirected to the television, and the volume commands will be redirected to an audio receiver. The `select_source` command will be passed directly to an A/V receiver.
+In this example, a switch is available to control the power to the television. Switches are also available to turn the volume up, turn the volume down, and mute the audio. These could be command line switches or any other {% term entity %} in Home Assistant. The `turn_on` and `turn_off` commands will be redirected to the television, and the volume commands will be redirected to an audio receiver. The `select_source` command will be passed directly to an A/V receiver.
The children are a Chromecast and a Kodi player. If the Chromecast is playing, the Universal Media Player will reflect its status. If the Chromecast is idle and Kodi is playing, the universal media player will change to reflect its status.
@@ -278,7 +278,7 @@ automation:
{% endraw %}
-### Harmony Remote Example
+### Harmony remote example
The complete configuration is:
diff --git a/source/_integrations/upb.markdown b/source/_integrations/upb.markdown
index 3d03682d88e..b87d4828a5d 100644
--- a/source/_integrations/upb.markdown
+++ b/source/_integrations/upb.markdown
@@ -16,7 +16,8 @@ ha_platforms:
ha_integration_type: integration
---
-The UPB integration allows Home Assistant to connect to a Universal Powerline Bus Powerline Interface Module (UPB PIM) to get status and control UPB devices and UPB links. The UPB PIM may be connected either to a serial port or over TCP. The integration implements the following platforms:
+The ***Universal Powerline Bus (UPB)** {% term integration %} allows Home Assistant to connect to a Universal Powerline Bus Powerline Interface Module (UPB PIM) to get status and control UPB devices and UPB links. The UPB PIM may be connected either to a serial port or over TCP. The integration implements the following platforms:
+
- Light
- Scene
@@ -26,7 +27,7 @@ The UPB integration requires that an export from the `UPStart` UPB configuration
{% include integrations/config_flow.md %}
-## Device Configuration
+## Device configuration
Using UPStart, configure each UPB dimmer-switch to report its state when it is manually operated. If you omit this step, manual changes to a dimmer-switch's state (on/off/brightness) will *not* be reported to Home Assistant.
@@ -70,7 +71,7 @@ Besides the standard services provided by the Home Assistant [Light](/integratio
- `upb.scene_fade_stop`
- `upb.scene_blink`
-### Rate Transition Time
+### Rate transition time
Both standard and custom services that take a `transition` or a `rate` for changing brightness levels take time in seconds. The UPB
system only offers a discrete set of transition times. As such, the transition time requested is changed to the closest time based on
@@ -233,6 +234,7 @@ kitchen_fade_on:
- Alterations to your UPB configuration with UpStart must be re-exported. The exported UPE file must have the same filename in the Home Assistant `config` directory.
## Debugging
+
Debug logs are often required to solve an issue. To enable UPB debug logs add the following to your `configuration.yaml` file in your Home Assistant `config` directory:
```yaml
diff --git a/source/_integrations/upc_connect.markdown b/source/_integrations/upc_connect.markdown
index 50f85b55c08..d53eb8e69aa 100644
--- a/source/_integrations/upc_connect.markdown
+++ b/source/_integrations/upc_connect.markdown
@@ -2,7 +2,7 @@
title: UPC Connect Box
description: Instructions on how to integrate UPC ConnectBox into Home Assistant.
ha_category:
- - Presence Detection
+ - Presence detection
ha_release: 0.36
ha_codeowners:
- '@pvizeli'
diff --git a/source/_integrations/upcloud.markdown b/source/_integrations/upcloud.markdown
index 22475321557..a2a6bc91dee 100644
--- a/source/_integrations/upcloud.markdown
+++ b/source/_integrations/upcloud.markdown
@@ -2,9 +2,9 @@
title: UpCloud
description: Instructions on how to integrate UpCloud within Home Assistant.
ha_category:
- - Binary Sensor
+ - Binary sensor
- Switch
- - System Monitor
+ - System monitor
ha_release: 0.65
ha_config_flow: true
ha_iot_class: Cloud Polling
@@ -17,11 +17,11 @@ ha_platforms:
ha_integration_type: integration
---
-The `upcloud` integration allows you to access the information about your [UpCloud](https://upcloud.com/) servers from Home Assistant.
+The **Upcloud** {% term integration %} allows you to access the information about your [UpCloud](https://upcloud.com/) servers from Home Assistant.
There is currently support for the following device types within Home Assistant:
-- [Binary Sensor](#binary-sensor)
+- [Binary sensor](#binary-sensor)
- [Switch](#switch)
## Setup
@@ -30,10 +30,10 @@ Set up your API user credentials in your [UpCloud control panel](https://hub.upc
{% include integrations/config_flow.md %}
-## Binary Sensor
+## Binary sensor
-A binary sensor entity is set up for all discovered servers.
+A binary sensor {% term entity %} is set up for all discovered servers.
## Switch
-A switch entity is set up for all discovered servers. You can use the switch to control (start/stop) them.
+A switch {% term entity %} is set up for all discovered servers. You can use the switch to control (start/stop) them.
diff --git a/source/_integrations/update.markdown b/source/_integrations/update.markdown
index 5d243ff470d..f0b0368af33 100644
--- a/source/_integrations/update.markdown
+++ b/source/_integrations/update.markdown
@@ -10,29 +10,29 @@ ha_codeowners:
ha_integration_type: entity
---
-An update entity is an entity that indicates if an update is available for a
+An update {% term entity %} is an entity that indicates if an update is available for a
device or service. This can be any update, including update of a firmware
for a device like a light bulb or router, or software updates for things like
add-ons or containers.
-The state of the update entity indicates if there is an update pending or not,
+The state of the update {% term entity %} indicates if there is an update pending or not,
and if there is an update available, more information on that update can be
-provided by an integration to the entity. For example, the version that is
+provided by an integration to the {% term entity %}. For example, the version that is
available, a summary of the release notes, and even links that provide more
information on the available update.
-Lastly, there are two services available for the update entity. If possible and
-made available by the integration providing the update entity, triggering
+Lastly, there are two services available for the update {% term entity %}. If possible and
+made available by the integration providing the update {% term entity %}, triggering
the actual update from Home Assistant. The other service exposed allows for
skipping the offered update.
{% include integrations/building_block_integration.md %}
-For a list of integrations offering update entities, on the integrations page, select the ["Update" category](/integrations/#update).
+For a list of {% term integrations %} offering update entities, on the integrations page, select the ["Update" category](/integrations/#update).
## The state of an update entity
-The state of an update entity reflects whether an update is available or not.
+The state of an update {% term entity %} reflects whether an update is available or not.
When the state is `on`, it means there is an update available; when everything
is up-to-date, the state is `off`.
@@ -49,18 +49,18 @@ information on the update state:
- `release_summary`: A summary of the release notes for the update available.
- `release_url`: A link to the full release announcement for the update available.
-## Device Classes
+## Device classes
The way these update entities are displayed in the frontend depend on their
device classes. The following device classes are supported for switches:
- **`None`**: A generic software update. This is the default and doesn't need
to be set.
-- **`firmware`**: This update integration provides firmwares.
+- **`firmware`**: This update {% term integration %} provides firmwares.
## Services
-The update entity exposes two services that can be used to install or skip
+The update {% term entity %} exposes two services that can be used to install or skip
an offered software update.
### Service {% my developer_call_service service="update.install" %}
@@ -68,16 +68,16 @@ an offered software update.
The {% my developer_call_service service="update.install" %} service can be used
to install an offered update to the device or service.
-This service is only available for an update entity if an integration provides
-this capability. Additionally, if allowed by the integration, the service
+This service is only available for an update {% term entity %} if an {% term integration %} provides
+this capability. Additionally, if allowed by the {% term integration %}, the service
provides for installing a specific version and even could make a
backup before installing the update.
| Service data attribute | Optional | Description |
| ---------------------- | -------- | ----------- |
| `entity_id` | no | String or list of strings that point at `entity_id`s of updates. To target all updates, set `entity_id` to `all`.
-| `version` | yes | A specific update version to install, if not provided, the latest available update will be installed. Availability of this atrribute is dependent on the integration.
-| `backup` | yes | If set to `true`, a backup will be made before installing the update. Availability of this attribute is dependent on the integration.
+| `version` | yes | A specific update version to install, if not provided, the latest available update will be installed. Availability of this atrribute is dependent on the {% term integration %}.
+| `backup` | yes | If set to `true`, a backup will be made before installing the update. Availability of this attribute is dependent on the {% term integration %}.
Example service call:
@@ -93,7 +93,7 @@ target:
The {% my developer_call_service service="update.skip" %} service can be used
to skip an offered update to the device or service.
-After skipping an offered update, the entity will return to the `off` state,
+After skipping an offered update, the {% term entity %} will return to the `off` state,
which means there is no update available.
```yaml
@@ -113,7 +113,7 @@ The {% my developer_call_service service="update.clear_skipped" %} service can
be used to remove skipped version marker of a previously skipped an offered
update to the device or service.
-After skipping an offered update, the entity will return to the `off` state,
+After skipping an offered update, the {% term entity %} will return to the `off` state,
but will not return to it until a newer version becomes available again.
Using the `update.clear_skipped` service, the skipped version marker can be
diff --git a/source/_integrations/upnp.markdown b/source/_integrations/upnp.markdown
index 14470896409..1f22c24f001 100644
--- a/source/_integrations/upnp.markdown
+++ b/source/_integrations/upnp.markdown
@@ -2,7 +2,7 @@
title: UPnP/IGD
description: Internet Gateway Device (IGD) Protocol for Home Assistant.
ha_category:
- - Binary Sensor
+ - Binary sensor
- Network
- Sensor
ha_release: 0.18
@@ -18,20 +18,20 @@ ha_platforms:
ha_integration_type: device
---
-The `upnp` integration enables you to collect network statistics from your router such as bytes in/out and packets in/out, uptime, WAN IP address, and WAN connectivity status. This information is provided by the [UPnP](https://en.wikipedia.org/wiki/Universal_Plug_and_Play)/[Internet Gateway Device (IGD) Protocol](https://en.wikipedia.org/wiki/Internet_Gateway_Device_Protocol) if enabled on your router.
+The **UPnP/IGD** {% term integration %} enables you to collect network statistics from your router such as bytes in/out and packets in/out, uptime, WAN IP address, and WAN connectivity status. This information is provided by the [UPnP](https://en.wikipedia.org/wiki/Universal_Plug_and_Play)/[Internet Gateway Device (IGD) Protocol](https://en.wikipedia.org/wiki/Internet_Gateway_Device_Protocol) if enabled on your router.
There is currently support for the following device types within Home Assistant:
- **Binary Sensor** - If router is connected to the WAN.
- **Sensor** - Allows to get the network statistics from your router such as bytes in/out and packets in/out, uptime, status, and IP. Sensor for uptime will only be there if supported by the router.
-Please note that UPnP or NAT-PMP needs to be enabled on your router for this integration to work.
+Please note that UPnP or NAT-PMP needs to be enabled on your router for this {% term integration %} to work.
{% include integrations/config_flow.md %}
## Debugging integration
-If you have problems with this integration you can add debug prints to the log.
+If you have problems with this {% term integration %} you can add debug prints to the log.
```yaml
logger:
diff --git a/source/_integrations/uptime.markdown b/source/_integrations/uptime.markdown
index a526d04479b..56f57f17df3 100644
--- a/source/_integrations/uptime.markdown
+++ b/source/_integrations/uptime.markdown
@@ -16,7 +16,7 @@ ha_codeowners:
ha_integration_type: service
---
-The uptime integration provides a sensor that stores the timestamp
+The **Uptime** {% term integration %} provides a sensor that stores the timestamp
(date and time) when Home Assistant was last started.
{% include integrations/config_flow.md %}
diff --git a/source/_integrations/uptimerobot.markdown b/source/_integrations/uptimerobot.markdown
index bf108415b42..adf8edc4b22 100644
--- a/source/_integrations/uptimerobot.markdown
+++ b/source/_integrations/uptimerobot.markdown
@@ -1,8 +1,8 @@
---
title: UptimeRobot
-description: Instructions on how to set up Uptime Robot within Home Assistant.
+description: Instructions on how to set up UptimeRobot within Home Assistant.
ha_category:
- - System Monitor
+ - System monitor
ha_release: 0.72
ha_iot_class: Cloud Polling
ha_codeowners:
@@ -19,7 +19,7 @@ ha_config_flow: true
ha_integration_type: integration
---
-The `uptimerobot` integration provides entities to get the status for all of your monitors from your account on [UptimeRobot]( https://uptimerobot.com).
+The **UptimeRobot** {% term integration %} provides entities to get the status for all of your monitors from your account on [UptimeRobot]( https://uptimerobot.com).
{% include integrations/config_flow.md %}
diff --git a/source/_integrations/usb.markdown b/source/_integrations/usb.markdown
index 1b1afc1e5c6..1345f1d282d 100644
--- a/source/_integrations/usb.markdown
+++ b/source/_integrations/usb.markdown
@@ -12,7 +12,7 @@ ha_codeowners:
ha_integration_type: system
---
-The USB Discovery integration will detect newly connected USB devices. Discovered devices will show up in the discovered section on the integrations page in the configuration panel.
+The **USB Discovery** {% term integration %} will detect newly connected USB devices. Discovered devices will show up in the discovered section on the integrations page in the configuration panel.
- On all supported systems, devices are detected during startup.
- On Linux systems that have functional `udev` support, including Home Assistant Operating System, devices are detected as soon as they are plugged in.
@@ -20,7 +20,7 @@ The USB Discovery integration will detect newly connected USB devices. Discovere
## Configuration
-This integration is part of [`default_config:`](/integrations/default_config/) if you have opted to not use [`default_config:`](/integrations/default_config/)you can add this integration by adding the following lines to your `configuration.yaml`
+This {% term integration %} is part of [`default_config:`](/integrations/default_config/) if you have opted to not use [`default_config:`](/integrations/default_config/)you can add this {% term integration %} by adding the following lines to your `configuration.yaml`
```yaml
# Example configuration.yaml entry
diff --git a/source/_integrations/usgs_earthquakes_feed.markdown b/source/_integrations/usgs_earthquakes_feed.markdown
index ec401cf9335..825a7376bae 100644
--- a/source/_integrations/usgs_earthquakes_feed.markdown
+++ b/source/_integrations/usgs_earthquakes_feed.markdown
@@ -19,7 +19,7 @@ The `usgs_earthquakes_feed` platform lets you integrate a GeoJSON feed provided
-Entities are generated, updated and removed automatically with each update from the feed. Each entity defines latitude and longitude and will be shown on the map automatically. The distance in kilometers is available as the state of each entity.
+Entities are generated, updated and removed automatically with each update from the feed. Each {% term entity %} defines latitude and longitude and will be shown on the map automatically. The distance in kilometers is available as the state of each {% term entity %}.
@@ -65,7 +65,7 @@ longitude:
default: Longitude defined in your `configuration.yaml`
{% endconfiguration %}
-### Supported Feed Types
+### Supported feed types
| Description | Feed Type |
|----------------------------------------|--------------------------------------|
@@ -91,9 +91,9 @@ longitude:
| Past 30 Days - All Earthquakes | `past_month_all_earthquakes` |
-## State Attributes
+## State attributes
-The following state attributes are available for each entity in addition to the standard ones:
+The following state attributes are available for each {% term entity %} in addition to the standard ones:
| Attribute | Description |
|--------------------|-------------|
@@ -109,7 +109,7 @@ The following state attributes are available for each entity in addition to the
| type | Type of seismic event: "earthquake" or "quarry". |
-## Full Configuration
+## Full configuration
```yaml
# Example configuration.yaml entry
@@ -121,7 +121,7 @@ geo_location:
latitude: 35.899722
longitude: -120.432778
```
-## Card Example
+## Card example
Assuming you configure this service using `feed_type: past_week_all_earthquakes`, you can create a corresponding map card in a dashboard with the following card:
```yaml
diff --git a/source/_integrations/utility_meter.markdown b/source/_integrations/utility_meter.markdown
index 0853b40ffae..12fbb5cf385 100644
--- a/source/_integrations/utility_meter.markdown
+++ b/source/_integrations/utility_meter.markdown
@@ -18,14 +18,14 @@ ha_config_flow: true
ha_integration_type: helper
---
-The Utility Meter integration provides functionality to track consumptions of various utilities (e.g., energy, gas, water, heating).
+The **Utility Meter** {% term integration %} provides functionality to track consumptions of various utilities (e.g., energy, gas, water, heating).
From a user perspective, utility meters operate in cycles (usually monthly) for billing purposes. This sensor will track a source sensor values, automatically resetting the meter based on the configured cycle. On reset an attribute will store the previous meter value, providing the means for comparison operations (e.g., "did I spend more or less this month?") or billing estimation (e.g., through a sensor template that multiplies the metered value per the charged unit amount).
-Some utility providers have different tariffs according to time/resource availability/etc. The utility meter enables you to define the various tariffs supported by your utility provider and accounts your consumptions in accordance. When tariffs are defined a new entity will show up indicating the current tariff. In order to change the tariff, the user must call a service, usually through an automation that can be based in time or other external source (eg. a REST sensor).
+Some utility providers have different tariffs according to time/resource availability/etc. The utility meter enables you to define the various tariffs supported by your utility provider and accounts your consumptions in accordance. When tariffs are defined a new {% term entity %} will show up indicating the current tariff. In order to change the tariff, the user must call a service, usually through an automation that can be based in time or other external source (eg. a REST sensor).
-Sensors created with this integration are persistent, so values are retained across restarts of Home Assistant. The first cycle for each sensor will be incomplete; a sensor tracking daily usage will start to be accurate the next day after the integration was activated. A sensor tracking monthly usage will present accurate data starting the first of the next month after being added to Home Assistant.
+Sensors created with this {% term integration %} are persistent, so values are retained across restarts of Home Assistant. The first cycle for each sensor will be incomplete; a sensor tracking daily usage will start to be accurate the next day after the {% term integration %} was activated. A sensor tracking monthly usage will present accurate data starting the first of the next month after being added to Home Assistant.
{% include integrations/config_flow.md %}
@@ -65,9 +65,9 @@ If the meter reset cycle and reset offsets are to limited for your use case,
consider using the YAML configuration below, which support CRON-style patterns
that provide a greater flexibility.
-## YAML Configuration
+## YAML configuration
-Alternatively, this integration can be configured and set up manually via YAML
+Alternatively, this {% term integration %} can be configured and set up manually via YAML
instead. To enable the Integration sensor in your installation, add the
following to your `configuration.yaml` file:
@@ -163,7 +163,7 @@ Calibrate the Utility Meter. Change the value of a given sensor.
| `entity_id` | no | String or list of strings that point at `entity_id`s of utility_meters.
| `value` | no | Number | Value to calibrate the sensor with |
-## Advanced Configuration
+## Advanced configuration
The following configuration shows an example where 2 utility_meters (`daily_energy` and `monthly_energy`) track daily and monthly energy consumptions.
@@ -241,9 +241,9 @@ utility_meter:
cron: "0 17 L * *"
```
-## Advanced Configuration for DSMR users
+## Advanced configuration for DSMR users
-When using the [DSMR integration](/integrations/dsmr) to get data from the utility meter, each tariff (peak and off-peak) has a separate sensor. Additionally, there is a separate sensor for gas consumption. The meter switches automatically between tariffs, so an automation is not necessary in this case. But, you do have to setup a few more instances of the `utility_meter` integration.
+When using the [DSMR integration](/integrations/dsmr) to get data from the utility meter, each tariff (peak and off-peak) has a separate sensor. Additionally, there is a separate sensor for gas consumption. The meter switches automatically between tariffs, so an automation is not necessary in this case. But, you do have to setup a few more instances of the `utility_meter` {% term integration %}.
If you want to create a daily and monthly sensor for each tariff, you have to track separate sensors:
@@ -251,7 +251,7 @@ If you want to create a daily and monthly sensor for each tariff, you have to tr
- `sensor.energy_consumption_tarif_2` for tarif 2 power (for example peak)
- `sensor.gas_consumption` for gas consumption
-So, tracking daily and monthly consumption for each sensor, will require setting up 6 entries under the `utility_meter` integration.
+So, tracking daily and monthly consumption for each sensor, will require setting up 6 entries under the `utility_meter` {% term integration %}.
```yaml
utility_meter:
diff --git a/source/_integrations/vacuum.markdown b/source/_integrations/vacuum.markdown
index 82ba32360fe..98910b52b04 100644
--- a/source/_integrations/vacuum.markdown
+++ b/source/_integrations/vacuum.markdown
@@ -11,7 +11,7 @@ ha_codeowners:
ha_integration_type: entity
---
-The `vacuum` integration enables the ability to control home cleaning robots within Home Assistant.
+The **Vacuum** {% term integration %} enables the ability to control home cleaning robots within Home Assistant.
{% include integrations/building_block_integration.md %}
diff --git a/source/_integrations/vacuum.mqtt.markdown b/source/_integrations/vacuum.mqtt.markdown
index efa7145963e..32a665054fa 100644
--- a/source/_integrations/vacuum.mqtt.markdown
+++ b/source/_integrations/vacuum.mqtt.markdown
@@ -7,8 +7,8 @@ ha_release: 0.54
ha_domain: mqtt
---
-The `mqtt` vacuum integration allows you to control your MQTT-enabled vacuum.
-The initial state of the MQTT vacuum entity will set to `unknown` and can be reset by a device by sending a `null` payload as state.
+The `mqtt` vacuum {% term integration %} allows you to control your MQTT-enabled vacuum.
+The initial state of the MQTT vacuum {% term entity %} will set to `unknown` and can be reset by a device by sending a `null` payload as state.
## Configuration
@@ -251,7 +251,7 @@ Possible MQTT payloads:
- `clean_spot` - Initialize a spot cleaning cycle
- `locate` - Locate the vacuum (typically by playing a song)
-### Send Custom Command
+### Send custom command
Vacuum send_command allows three parameters:
diff --git a/source/_integrations/vacuum.template.markdown b/source/_integrations/vacuum.template.markdown
index 5dd93a77d8b..da603774744 100644
--- a/source/_integrations/vacuum.template.markdown
+++ b/source/_integrations/vacuum.template.markdown
@@ -1,6 +1,6 @@
---
-title: "Template Vacuum"
-description: "Instructions how to setup Template vacuums within Home Assistant."
+title: "Template vacuum"
+description: "Instructions how to setup template vacuums within Home Assistant."
ha_category:
- Vacuum
ha_release: 0.96
@@ -106,7 +106,7 @@ vacuum:
### Template and action variables
-State-based template entities have the special template variable `this` available in their templates and actions. The `this` variable aids [self-referencing](/integrations/template#self-referencing) of an entity's state and attribute in templates and actions.
+State-based template entities have the special template variable `this` available in their templates and actions. The `this` variable aids [self-referencing](/integrations/template#self-referencing) of an {% term entity %}'s state and attribute in templates and actions.
## Examples
@@ -180,7 +180,7 @@ vacuum:
{% endraw %}
-### Add Custom Attributes
+### Add custom attributes
This example shows how to add custom attributes.
diff --git a/source/_integrations/vallox.markdown b/source/_integrations/vallox.markdown
index dfeae5ee1c7..3e76075e3ec 100644
--- a/source/_integrations/vallox.markdown
+++ b/source/_integrations/vallox.markdown
@@ -22,9 +22,9 @@ ha_codeowners:
ha_integration_type: integration
---
-The `vallox` integration lets you control any Vallox ventilation unit that is supported by the [vallox_websocket_api](https://github.com/yozik04/vallox_websocket_api) (follow the link for a list of supported units).
+The **Vallox** {% term integration %} lets you control any Vallox ventilation unit that is supported by the [vallox_websocket_api](https://github.com/yozik04/vallox_websocket_api) (follow the link for a list of supported units).
-The **fan** platform of this integration allows you to turn on/off the complete unit via the toggle switch, control fan speed and select a ventilation profile.
+The **fan** platform of this {% term integration %} allows you to turn on/off the complete unit via the toggle switch, control fan speed and select a ventilation profile.
The **sensor** platform exposes a number of relevant metrics like fan speed, various air temperatures, and humidity.
@@ -34,9 +34,9 @@ The **number** platform allows to control supply air temperatures.
{% include integrations/config_flow.md %}
-## Profile Switching
+## Profile switching
-For convenient switching of ventilation profiles in the GUI, just click on the `Vallox` fan entity to get a drop-down menu to select from. Alternatively, the service `fan/set_preset_mode` can be used.
+For convenient switching of ventilation profiles in the GUI, just click on the `Vallox` fan {% term entity %} to get a drop-down menu to select from. Alternatively, the service `fan/set_preset_mode` can be used.
The four standard Vallox profiles are supported:
@@ -45,7 +45,7 @@ The four standard Vallox profiles are supported:
- `Boost`
- `Fireplace`
-## Fan Services
+## Fan services
### Service `vallox.set_profile_fan_speed_home`
diff --git a/source/_integrations/velbus.markdown b/source/_integrations/velbus.markdown
index f101e0a4ebd..6e3ca159b32 100644
--- a/source/_integrations/velbus.markdown
+++ b/source/_integrations/velbus.markdown
@@ -2,7 +2,7 @@
title: Velbus
description: Access and control your Velbus devices.
ha_category:
- - Binary Sensor
+ - Binary sensor
- Button
- Climate
- Hub
@@ -29,7 +29,7 @@ ha_platforms:
ha_integration_type: hub
---
-The `velbus` integration is used to control [Velbus](https://www.velbus.eu/?lang=en) modules. It supports the Velbus USB, Velbus serial and a TCP/IP gateway.
+The **Velbus** {% term integration %} is used to control [Velbus](https://www.velbus.eu/?lang=en) modules. It supports the Velbus USB, Velbus serial and a TCP/IP gateway.
The pushbutton LEDs of input modules are disabled by default. These can be enabled from the `Devices` panel in the `Configuration` page of the web interface.
@@ -99,10 +99,26 @@ Use this service when you make changes to your configuration via velbuslink.
| `interface` | no | The port used to connect to the bus (the same one used during configuration). |
| `address` | no | The module address in decimal format, which is displayed on the device list on the integration page, if provided the service will only clear the cache for this model, without an address, the full velbuscache will be cleared. |
+## VMB7IN and the Energy dashboard
+
+In some cases, the VMB7IN sensor does not report what the counter is counting. If the counter is related to an energy device, everything will work out of the box.
+But if the VMB7IN sensor is a water or gas counter, you will need to specify this in your configuration.yaml file.
+
+```yaml
+homeassistant:
+ customize:
+ sensor.eau_counter:
+ device_class: water
+```
+
+The device_class attribute can have 2 values:
+- gas: if the counter represents a gas meter
+- water: if the counter represents a water meter
+
## Example automation
-The Velbus integration allows you to link a Velbus button (i.e., a button of a [VMBGPOD](https://www.velbus.eu/products/view/?id=416302&lang=en) module) to a controllable entity of Home Assistant.
-The actual linking can be realized by two automation rules. One rule to control the device using the push button and a second rule to update the LED state of the push button as soon as the entity state changes.
+The Velbus {% term integration %} allows you to link a Velbus button (i.e., a button of a [VMBGPOD](https://www.velbus.eu/products/view/?id=416302&lang=en) module) to a controllable {% term entity %} of Home Assistant.
+The actual linking can be realized by two automation rules. One rule to control the device using the push button and a second rule to update the LED state of the push button as soon as the {% term entity %} state changes.
```yaml
# Control light living from Velbus push_button_10
diff --git a/source/_integrations/velux.markdown b/source/_integrations/velux.markdown
index 226f93a1399..dbec481400f 100644
--- a/source/_integrations/velux.markdown
+++ b/source/_integrations/velux.markdown
@@ -16,7 +16,7 @@ ha_platforms:
ha_integration_type: integration
---
-[Velux](https://www.velux.com/) integration for Home Assistant allows you to connect to a Velux KLF 200 interface, to control [io-homecontrol](http://www.io-homecontrol.com) devices like windows and blinds. The module allows you to start scenes configured within KLF 200.
+[Velux](https://www.velux.com/) {% term integration %} for Home Assistant allows you to connect to a Velux KLF 200 interface, to control [io-homecontrol](http://www.io-homecontrol.com) devices like windows and blinds. The module allows you to start scenes configured within KLF 200.
At least firmware version > 2.0.0.0 is required on the KLF 200 device. The firmware images may be obtained [here](https://www.velux.com/klf200) and may be imported via the webinterface of your KLF 200.
@@ -70,6 +70,6 @@ automation:
## Velux Active (KIX 300)
-The Velux Active (KIX 300) set is not supported by this integration. To integrate Velux Active (KIX 300) with Home Assistant, you can use the [HomeKit Controller](/integrations/homekit_controller) integration and get full control over your windows, curtains, covers, the air quality sensor KLA 300, etc.
+The Velux Active (KIX 300) set is not supported by this {% term integration %}. To integrate Velux Active (KIX 300) with Home Assistant, you can use the [HomeKit Controller](/integrations/homekit_controller) {% term integration %} and get full control over your windows, curtains, covers, the air quality sensor KLA 300, etc.
Add the Velux Active gateway using HomeKit pairing (with the pairing code on the sticker at the bottom of the Velux Active gateway) and the devices connected to the gateway - including sensors - will be automatically discovered and added to Home Assistant.
diff --git a/source/_integrations/venstar.markdown b/source/_integrations/venstar.markdown
index 5774e108376..f65443755f8 100644
--- a/source/_integrations/venstar.markdown
+++ b/source/_integrations/venstar.markdown
@@ -2,7 +2,7 @@
title: Venstar
description: Instructions for how to integrate Venstar WiFi thermostats within Home Assistant.
ha_category:
- - Binary Sensor
+ - Binary sensor
- Climate
- Sensor
ha_release: 0.62
@@ -19,7 +19,7 @@ ha_config_flow: true
ha_integration_type: integration
---
-The `venstar` climate platform allows you to control [Venstar](https://www.venstar.com/) thermostats from Home Assistant.
+The **Venstar** climate {% term integration %} allows you to control [Venstar](https://www.venstar.com/) thermostats from Home Assistant.
Venstar thermostats feature a local API that allows for automation without the need for their Skyport cloud service.
Currently supported and tested thermostats:
@@ -50,7 +50,8 @@ The following values are supported for the preset_mode state attribute:
Note - Please ensure that you update your thermostat to the latest firmware. Initially tested on firmware 5.10 and currently VH6.79.
-### Enabling Local API
+### Enabling local API
+
Local API mode needs to be enabled on the thermostat itself. It cannot be enabled using the Venstar mobile apps or Skyport cloud service. Exact steps vary across different [series](https://venstar.com/thermostats/) of thermostats:
- [ColorTouch](https://venstar.com/thermostats/colortouch/)
diff --git a/source/_integrations/vera.markdown b/source/_integrations/vera.markdown
index d6c8fd6f9f7..e14368dc786 100644
--- a/source/_integrations/vera.markdown
+++ b/source/_integrations/vera.markdown
@@ -2,7 +2,7 @@
title: Vera
description: Instructions on how to setup Vera Z-Wave hubs and configure devices within Home Assistant.
ha_category:
- - Binary Sensor
+ - Binary sensor
- Climate
- Cover
- Hub
@@ -31,13 +31,13 @@ The [Vera](https://getvera.com/) hub is a controller mainly for connecting to Z-
The supported Vera hubs (Edge, Plus and Secure) are no longer available and the firmware is not being actively enhanced by the vendor. New Z-Wave devices are not directly supported and so are not easy to add to the platform.
-The newer Ezlo hubs use a different firmware and are not supported by this integration.
+The newer Ezlo hubs use a different firmware and are not supported by this {% term integration %}.
[Z-Wave JS](/integrations/zwave_js/) is a better choice for new Z-Wave users or for users wanting support for new Z-Wave devices.
There is currently support for the following device types within Home Assistant:
-- Binary Sensor
+- Binary sensor
- Cover
- Light
- Lock
@@ -57,7 +57,8 @@ and will be automatically added when HA connects to your Vera controller.
## Options
-Once the Vera integration is configured, you can set additional options in the integration, click the gear icon.
+
+Once the Vera {% term integration %} is configured, you can set additional options in the {% term integration %}, click the gear icon.
- Vera switch device - By default your switches will be added to Home Assistant as switches, however, if some of them are light switches, you can tell Home Assistant this by providing a list of light ids.
- Vera device ids to exclude - Vera imports detailed Z-Wave devices into Home Assistant. This can include system devices and other devices that you don't use; you can tell Home Assistant not to load these devices by providing a list of device ids.
@@ -66,7 +67,7 @@ You can find the Vera device id either via the advanced properties of the device
### Using Z-Wave devices in automation
-If you want to use a Z-Wave device from the Vera controller in Home Assistant automation, you'll need the entity id. In the Home Assistant UI you'll find all entities listed under **Developer Tools** -> **States**. Look for entities that contain 'Vera Device Id' in their attributes, and you'll find the entity id on the left.
+If you want to use a Z-Wave device from the Vera controller in Home Assistant automation, you'll need the {% term entity %} id. In the Home Assistant UI you'll find all entities listed under **Developer Tools** -> **States**. Look for entities that contain 'Vera Device Id' in their attributes, and you'll find the {% term entity %} id on the left.
### Sensor
diff --git a/source/_integrations/verisure.markdown b/source/_integrations/verisure.markdown
index d3fa2ed9664..3554e9e6902 100644
--- a/source/_integrations/verisure.markdown
+++ b/source/_integrations/verisure.markdown
@@ -3,7 +3,7 @@ title: Verisure
description: Instructions on how to setup Verisure devices within Home Assistant.
ha_category:
- Alarm
- - Binary Sensor
+ - Binary sensor
- Camera
- Hub
- Lock
@@ -36,11 +36,11 @@ There is currently support for the following device types within Home Assistant:
- Switch (Smartplug)
- Sensor (Thermometers and Hygrometers)
- Lock
-- Binary Sensor (Door & Window)
+- Binary sensor (Door & Window)
{% include integrations/config_flow.md %}
-## Alarm Control Panel
+## Alarm control panel
The Verisure alarm control panel platform allows you to control your [Verisure](https://www.verisure.com/) Alarms.
diff --git a/source/_integrations/vermont_castings.markdown b/source/_integrations/vermont_castings.markdown
index 1379e291f13..9982c06babb 100644
--- a/source/_integrations/vermont_castings.markdown
+++ b/source/_integrations/vermont_castings.markdown
@@ -2,7 +2,7 @@
title: Vermont Castings
description: Connect and control your Vermont Castings devices using the IntelliFire integration
ha_category:
- - Binary Sensor
+ - Binary sensor
- Climate
- Fan
- Light
diff --git a/source/_integrations/versasense.markdown b/source/_integrations/versasense.markdown
index 6703b7cf3a3..839dcf2c11f 100644
--- a/source/_integrations/versasense.markdown
+++ b/source/_integrations/versasense.markdown
@@ -17,7 +17,7 @@ ha_platforms:
ha_integration_type: integration
---
-The `VersaSense` integration supports the VersaSense Edge Gateway. The gateway is able to control hubs and their peripherals (sensors and actuators) in the mesh network.
+The **VersaSense** {% term integration %} supports the VersaSense Edge Gateway. The gateway is able to control hubs and their peripherals (sensors and actuators) in the mesh network.
## Configuration
@@ -38,7 +38,7 @@ host:
All VersaSense gateways with software version >= 1.0.2.10
-The integration is tested with following peripherals and devices:
+The {% term integration %} is tested with following peripherals and devices:
- S03 S04: Temperature and Humidity sensor
- S06: Barometric Pressure sensor
diff --git a/source/_integrations/version.markdown b/source/_integrations/version.markdown
index db6b36af93b..2c150d61478 100644
--- a/source/_integrations/version.markdown
+++ b/source/_integrations/version.markdown
@@ -18,13 +18,13 @@ ha_config_flow: true
ha_integration_type: integration
---
-The Version integration can display the current Home Assistant Core versions.
+The **Version** {% term integration %} can display the current Home Assistant Core versions.
{% include integrations/config_flow.md %}
## Version sources
-With this integration you can select various sources to get a version from.
+With this {% term integration %} you can select various sources to get a version from.
{% configuration_basic %}
"Local installation":
@@ -46,12 +46,12 @@ With this integration you can select various sources to get a version from.
## Entities
-The entities created by this integration depends on which source you set it up with (you can also set up the integration multiple times to use more sources).
+The entities created by this {% term integration %} depends on which source you set it up with (you can also set up the {% term integration %} multiple times to use more sources).
### Sensor
-For all sources the integration will create a [sensor](/integrations/sensor) entity that displays the newest version published to that source.
+For all sources the {% term integration %} will create a [sensor](/integrations/sensor) {% term entity %} that displays the newest version published to that source.
### Binary Sensor
-For all sources (except for the ["Local installation"](#local-installation) source) the integration will create a [binary_sensor](/integrations/binary_sensor) entity that show if there is a newer version than the one you are currently running published to that source.
+For all sources (except for the ["Local installation"](#local-installation) source) the {% term integration %} will create a [binary_sensor](/integrations/binary_sensor) {% term entity %} that show if there is a newer version than the one you are currently running published to that source.
diff --git a/source/_integrations/vesync.markdown b/source/_integrations/vesync.markdown
index 2fb4c2f9b83..20cbc05459e 100644
--- a/source/_integrations/vesync.markdown
+++ b/source/_integrations/vesync.markdown
@@ -22,9 +22,9 @@ ha_platforms:
ha_integration_type: integration
---
-The `vesync` integration enables you to control smart switches and outlets connected to the VeSync App.
+The `**VeSync** {% term integration %} enables you to control smart switches and outlets connected to the VeSync App.
-The devices must be added to the VeSync App before this integration can discover them.
+The devices must be added to the VeSync App before this {% term integration %} can discover them.
The following platforms are supported:
@@ -33,21 +33,21 @@ The following platforms are supported:
- **fan**
- **sensor**
-## Supported Devices
+## Supported devices
-This integration supports devices controllable by the VeSync App. The following devices are supported by this integration:
+This {% term integration %} supports devices controllable by the VeSync App. The following devices are supported by this {% term integration %}:
### Bulbs
- Etekcity WiFi Dimmable LED Bulb (ESL100)
- Etekcity WiFi Dimmable and Tunable White LED Bulb (ESL100CW)
-### Wall Switches
+### Wall switches
- Etekcity In Wall Smart Switch (EWSL01-USA)
- Etekcity Wifi Dimmer Switch (ESD16)
- Etekcity Wifi Dimmer Switch (ESWD16)
-### Outlet Plugs
+### Outlet plugs
- Etekcity 7 Amp US outlet - ESW01-USA (Round)
- Etekcity 10 Amp US outlet - ESW10-USA (Round)
@@ -65,7 +65,7 @@ This integration supports devices controllable by the VeSync App. The following
## Prerequisite
-Before you can use this integration, all devices must be registered with the
+Before you can use this {% term integration %}, all devices must be registered with the
VeSync App. Once registration is complete, continue with the steps described in
the configuration section below.
@@ -77,10 +77,10 @@ the configuration section below.
|---------|-------------|
| `update_devices` | Poll Vesync server to find and add any new devices |
-## Power & Energy Sensors
+## Power & energy sensors
Many VeSync outlets support power & energy monitoring. This data is exposed as sensor entities alongside the outlet
-itself. Note that prior versions of the integration exposed these as state attributes on the outlet switch entity.
+itself. Note that prior versions of the {% term integration %} exposed these as state attributes on the outlet switch {% term entity %}.
| Sensor | Description | Example |
| ------------------------------------------|-------------------------------------------------------------------------|---------|
@@ -91,7 +91,7 @@ itself. Note that prior versions of the integration exposed these as state attri
| `sensor._energy_use_monthly` | Total energy usage for month starting from 12:01AM on the first in kWh | 52.30 |
| `sensor._energy_use_yearly` | Total energy usage for year start from 12:01AM on Jan 1 in kWh | 105.25 |
-## Fan & Air Quality Sensors
+## Fan & air quality sensors
All VeSync air purifiers expose the remaining filter lifetime, and some also expose air quality measurements.
| Sensor | Description | Example |
@@ -100,7 +100,7 @@ All VeSync air purifiers expose the remaining filter lifetime, and some also exp
| `air_quality` | The current air quality reading. (LV-PUR131S, Core300s/400s/600s) | excellent |
| `pm2_5` | The current air quality reading. (Core300s/400s/600s) | 8 |
-## Fan Exposed Attributes
+## Fan exposed attributes
VeSync air purifiers will expose the following details depending on the features supported by the model:
@@ -114,7 +114,7 @@ VeSync air purifiers will expose the following details depending on the features
| `night_light` | The current status of the night light (Core200S/Core400s) | off |
| `child_lock` | The current status of the child lock (Core200S/300s/400s) | off |
-## Extracting Attribute data
+## Extracting attribute data
In order to get the attributes readings from supported devices, such as voltage from outlets or fan attributes, you'll have to create a [template sensor](/integrations/template#state-based-template-sensors/).
@@ -131,4 +131,5 @@ template:
state: "{{ state_attr('switch.vesync_switch', 'voltage') | float(default=0) }}"
unit_of_measurement: "V"
```
+
{% endraw %}
diff --git a/source/_integrations/viaggiatreno.markdown b/source/_integrations/viaggiatreno.markdown
index 5ef2b67817f..dc1dd88b9a0 100644
--- a/source/_integrations/viaggiatreno.markdown
+++ b/source/_integrations/viaggiatreno.markdown
@@ -11,7 +11,7 @@ ha_platforms:
ha_integration_type: integration
---
-The `viaggiatreno` sensor will give you information about configured train ids and stations using the public [ViaggiaTreno](http://viaggiatreno.it) API.
+The **Trenitalia ViaggiaTreno** {% term integration %} will give you information about configured train ids and stations using the public [ViaggiaTreno](http://viaggiatreno.it) API.
To activate the sensor you need at least two parameters: the `train_id` and the `station_id`.
diff --git a/source/_integrations/vicare.markdown b/source/_integrations/vicare.markdown
index ae4ee5d6a87..5bc5638d412 100644
--- a/source/_integrations/vicare.markdown
+++ b/source/_integrations/vicare.markdown
@@ -19,13 +19,13 @@ ha_dhcp: true
ha_integration_type: integration
---
-The `ViCare` integration lets you control [Viessmann](https://www.viessmann.com) devices via the Viessmann ViCare (REST) API.
+The **Viessmann ViCare** {% term integration %} lets you control [Viessmann](https://www.viessmann.com) devices via the Viessmann ViCare (REST) API.
Most recent network-connected Viessmann heating devices (e.g., gas boilers) should be supported.
There is currently support for the following device types within Home Assistant:
- [Climate](#climate) (Heating)
-- [Water Heater](#water-heater) (Domestic Hot Water)
+- [Water heater](#water-heater) (Domestic hot water)
- [Sensor](#sensor) (Sensor)
- [Button](#button) (Button)
- [Number](#number)
@@ -46,7 +46,7 @@ The required Client ID can be obtained as follows:
The `heating_type` can either be `auto` to automatically find the most suitable type for your device or one of `gas`, `oil`, `pellets`, `heatpump`, `fuelcell`, `hybrid`.
-Important: the redirect URI that you configure requires that you perform the initial setup on a device that has the ViCare application installed. If your device does not know how to handle the `vicare://` URL, you will receive an **Invalid credentials** notification and the setup procedure will fail. This means: install the ViCare app on your phone and set up the integration from your phone.
+Important: the redirect URI that you configure requires that you perform the initial setup on a device that has the ViCare application installed. If your device does not know how to handle the `vicare://` URL, you will receive an **Invalid credentials** notification and the setup procedure will fail. This means: install the ViCare app on your phone and set up the {% term integration %} from your phone.
Multiple device instances might be generated depending on the number of burners and/or circuits of your installation. If there is more than a single instance all devices are suffixed with the circuit or burner ID.
@@ -57,7 +57,7 @@ The Viessmann API is rate-limited. If you exceed one of the limits below you wil
- Limit 1: 120 calls for a time window of 10 minutes
- Limit 2: 1450 calls for a time window of 24 hours
-The integration polls the Viessmann API every 60 seconds and will work within these limits. Note however that any additional requests to the API, e.g., by setting the temperature via the integration but also by interacting with the ViCare app also counts into those limits.
+The {% term integration %} polls the Viessmann API every 60 seconds and will work within these limits. Note however that any additional requests to the API, e.g., by setting the temperature via the {% term integration %} but also by interacting with the ViCare app also counts into those limits.
## Climate
@@ -65,7 +65,7 @@ A note about the current temperature attribute: Viessmann devices with room temp
### Supported services `climate.vicare_heating`
-The following services of the [Climate integration](/integrations/climate/) are provided by the ViCare integration: `set_temperature`, `set_hvac_mode`, `set_preset_mode`
+The following services of the [Climate integration](/integrations/climate/) are provided by the ViCare {% term integration %}: `set_temperature`, `set_hvac_mode`, `set_preset_mode`
#### Service `set_temperature`
@@ -82,7 +82,7 @@ Note that `set_temperature` will always affect the current normal temperature or
Set HVAC mode for the climate device. The following modes are supported:
-The `climate.vicare_heating` integration has the following mapping of HVAC modes to Viessmann operation modes:
+The `climate.vicare_heating` {% term integration %} has the following mapping of HVAC modes to Viessmann operation modes:
| HVAC mode | Viessmann mode | Description |
| ---------------------- | -------- | ----------- |
@@ -102,7 +102,7 @@ Set the mode for the climate device as defined by Viessmann (see [set_hvac_mode]
| Service data attribute | Optional | Description |
| ---------------------- | -------- | ----------- |
| `entity_id` | yes | String or list of strings that point at `entity_id`'s of climate devices to control. To target all entities, use `all` keyword instead of entity_id.
-| `vicare_mode` | no | New value of ViCare mode. For supported values see the `vicare_modes` attribute of the climate entity.
+| `vicare_mode` | no | New value of ViCare mode. For supported values see the `vicare_modes` attribute of the climate {% term entity %}.
#### Service `set_preset_mode`
@@ -114,13 +114,13 @@ Eco mode reduces the target temperature by 3°C, whereas Comfort mode sets the t
| `entity_id` | yes | String or list of strings that point at `entity_id`'s of climate devices to control. To target all entities, use `all` keyword instead of entity_id.
| `preset_mode` | no | New value of preset mode.
-## Water Heater
+## Water heater
-It is not possible to turn on/off water heating via the Water Heater integration since this would conflict with the operation modes of the heating integration. Therefore the operation mode of that integration is just available as an attribute and cannot be modified.
+It is not possible to turn on/off water heating via the water heater {% term integration %} since this would conflict with the operation modes of the heating {% term integration %}. Therefore the operation mode of that {% term integration %} is just available as an attribute and cannot be modified.
### Supported services `water_heater.vicare_water`
-The following services of the [Water Heater integration](/integrations/water_heater/) are provided by the ViCare integration: `set_temperature`
+The following services of the [water heater integration](/integrations/water_heater/) are provided by the ViCare {% term integration %}: `set_temperature`
#### Service `set_temperature`
diff --git a/source/_integrations/vilfo.markdown b/source/_integrations/vilfo.markdown
index eb08f664c39..ef9daff5aaa 100644
--- a/source/_integrations/vilfo.markdown
+++ b/source/_integrations/vilfo.markdown
@@ -5,7 +5,7 @@ ha_release: '0.106'
ha_category:
- Network
- Sensor
- - System Monitor
+ - System monitor
ha_iot_class: Local Polling
ha_config_flow: true
ha_codeowners:
@@ -16,7 +16,7 @@ ha_platforms:
ha_integration_type: integration
---
-The `Vilfo Router` integration allows you to observe the state of your [Vilfo Router](https://www.vilfo.com) from Home Assistant.
+The **Vilfo Router** {% term integration %} allows you to observe the state of your [Vilfo Router](https://www.vilfo.com) from Home Assistant.
It currently supports reporting the current load of the device in percent and the current uptime measured in minutes.
diff --git a/source/_integrations/vivotek.markdown b/source/_integrations/vivotek.markdown
index 163ac1f8471..f1eb47af9be 100644
--- a/source/_integrations/vivotek.markdown
+++ b/source/_integrations/vivotek.markdown
@@ -13,7 +13,7 @@ ha_platforms:
ha_integration_type: integration
---
-The `vivotek` camera platform allows you to integrate a VIVOTEK IP camera into Home Assistant.
+The **VIVOTEK** camera {% term integration %} allows you to integrate a VIVOTEK IP camera into Home Assistant.
Home Assistant will serve the images via its server, making it possible to view your IP cameras while outside of your network. The endpoint is `/api/camera_proxy/camera.[name]`.
@@ -106,13 +106,13 @@ Available services: `enable_motion_detection`, `disable_motion_detection`, `snap
#### Service `play_stream`
-Play a live stream from a camera to selected media player(s). Requires [`stream`](/integrations/stream) integration to be set up.
+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 entity to fetch stream from, e.g., `camera.front_door_camera`. |
+| `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` integration and selected `media_player`. Default: `hls` |
+| `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.
diff --git a/source/_integrations/vizio.markdown b/source/_integrations/vizio.markdown
index 85006324140..558f48de7c5 100644
--- a/source/_integrations/vizio.markdown
+++ b/source/_integrations/vizio.markdown
@@ -1,8 +1,8 @@
---
title: VIZIO SmartCast
-description: Instructions on how to integrate Vizio SmartCast TVs and sound bars into Home Assistant.
+description: Instructions on how to integrate VIZIO SmartCast TVs and sound bars into Home Assistant.
ha_category:
- - Media Player
+ - Media player
ha_release: 0.49
ha_iot_class: Local Polling
ha_config_flow: true
@@ -16,7 +16,7 @@ ha_platforms:
ha_integration_type: device
---
-The `vizio` integration allows you to control [SmartCast](https://www.vizio.com/smartcast-app)-compatible TVs and sound bars (2016+ models).
+The **VIZIO SmartCast** {% term integration %} allows you to control [SmartCast](https://www.vizio.com/smartcast-app)-compatible TVs and sound bars (2016+ models).
## Find your device
@@ -45,11 +45,11 @@ Write down its IP address and port number. If you have trouble finding a device
## Pairing
-This integration requires an access token in order to communicate with TVs (speakers do not need an access token). An access token can be obtained by going through a pairing process, either manually, or through the Home Assistant frontend.
+This {% term integration %} requires an access token in order to communicate with TVs (speakers do not need an access token). An access token can be obtained by going through a pairing process, either manually, or through the Home Assistant frontend.
### Pair using the Home Assistant frontend
- - **Using `configuration.yaml`:** If you have a `vizio` entry in `configuration.yaml` but don't provide an access token value in your configuration, after you initialize Home Assistant, you will see a Vizio SmartCast device ready to be configured. When you open the configuration window, you will be guided through the pairing process. While Home Assistant will store the access token for the life of your `vizio` entity, it is a good idea to note the access token value displayed in the window and add it to your `configuration.yaml`. This will ensure that you will not have to go through the pairing process again in the future if you decide to rebuild your Home Assistant instance.
+ - **Using `configuration.yaml`:** If you have a `vizio` entry in `configuration.yaml` but don't provide an access token value in your configuration, after you initialize Home Assistant, you will see a VIZIO SmartCast device ready to be configured. When you open the configuration window, you will be guided through the pairing process. While Home Assistant will store the access token for the life of your `vizio` {% term entity %}, it is a good idea to note the access token value displayed in the window and add it to your `configuration.yaml`. This will ensure that you will not have to go through the pairing process again in the future if you decide to rebuild your Home Assistant instance.
- **Using discovery or manual setup through the Integrations menu:** To initiate the pairing process, submit your initial configuration with an empty Access Token value.
### Pair manually using the CLI
@@ -104,7 +104,7 @@ You will need the authentication token returned by this command to configure Hom
## Configuration
-To add your Vizio TV to your installation, add the following to your `configuration.yaml` file:
+To add your VIZIO TV to your installation, add the following to your `configuration.yaml` file:
```yaml
# Example configuration.yaml entry
@@ -119,10 +119,10 @@ host:
required: true
type: string
name:
- description: Nickname for your device that will be used to generate the device's entity ID. If multiple Vizio devices are configured, the value must be unique for each entry.
+ description: Nickname for your device that will be used to generate the device's entity ID. If multiple VIZIO devices are configured, the value must be unique for each entry.
required: false
type: string
- default: Vizio SmartCast
+ default: VIZIO SmartCast
access_token:
description: Authentication token you received in the last step of the pairing process. This token is only needed if your device is a TV, and you can opt not to provide it in your configuration and instead go through the pairing process via the Home Assistant frontend.
required: false
@@ -131,14 +131,14 @@ device_class:
description: The class of your device. Valid options are `tv` or `speaker`.
required: false
type: string
- default: tv
+ default: "`tv`"
volume_step:
description: The number of steps that the volume will be increased or decreased by at a time.
required: false
type: integer
default: 1
apps:
- description: Use this section to define app specific settings (only applicable for Vizio Smart TVs).
+ description: Use this section to define app specific settings (only applicable for VIZIO Smart TVs).
required: false
type: map
keys:
@@ -207,7 +207,8 @@ vizio:
If there is an app you want to be able to launch from Home Assistant that isn't detected by default, you will need to specify the app configuration in `configuration.yaml`. This configuration can be obtained from the `app_id` state attribute when an unknown app is running on your device.
### Obtaining a list of valid apps to include or exclude
-The list of apps that are provided by default is statically defined [here](https://github.com/vkorn/pyvizio/blob/master/pyvizio/const.py#L23). If you'd prefer a more concise list, you can either view the source list of a Vizio Smart TV in the Home Assistant frontend, or run the following command (requires `pyvizio` to be installed locally):
+
+The list of apps that are provided by default is statically defined [here](https://github.com/vkorn/pyvizio/blob/master/pyvizio/const.py#L23). If you'd prefer a more concise list, you can either view the source list of a VIZIO Smart TV in the Home Assistant frontend, or run the following command (requires `pyvizio` to be installed locally):
```bash
pyvizio --ip=0 get-apps-list
@@ -215,7 +216,7 @@ pyvizio --ip=0 get-apps-list
## Service `vizio.update_setting`
-This service allows you to update a setting on a given Vizio device. You will need to know the type of setting and the name of the setting to call this service. You can determine this by using the SmartCast app and going to device settings for your target device. The setting type is the lowercase version of the first menu item you'd select (e.g., display, audio, system), and the setting name is what you see in the app, but spaces are replaced with underscores and it is also all lowercase (e.g., AV delay would be called `av_delay`).
+This service allows you to update a setting on a given VIZIO device. You will need to know the type of setting and the name of the setting to call this service. You can determine this by using the SmartCast app and going to device settings for your target device. The setting type is the lowercase version of the first menu item you'd select (e.g., display, audio, system), and the setting name is what you see in the app, but spaces are replaced with underscores and it is also all lowercase (e.g., AV delay would be called `av_delay`).
| Service data attribute | Optional | Description | Example |
| ---------------------- | -------- | ----------- | ------- |
diff --git a/source/_integrations/vlc.markdown b/source/_integrations/vlc.markdown
index 931a93394c1..5d9dbef2310 100644
--- a/source/_integrations/vlc.markdown
+++ b/source/_integrations/vlc.markdown
@@ -2,7 +2,7 @@
title: VLC media player
description: Instructions on how to integrate VLC media player into Home Assistant.
ha_category:
- - Media Player
+ - Media player
ha_release: 0.35
ha_iot_class: Local Polling
ha_domain: vlc
@@ -15,7 +15,7 @@ The `vlc` platform allows you to control [VLC media player](https://www.videolan
-The VLC media player integration, is currently only available for installations that are based on the Home Assistant Core in a Python virtual environment.
+The **VLC media player** {% term integration %}, is currently only available for installations that are based on the Home Assistant Core in a Python virtual environment.
diff --git a/source/_integrations/vlc_telnet.markdown b/source/_integrations/vlc_telnet.markdown
index 3981a859a45..babb8d34bb7 100644
--- a/source/_integrations/vlc_telnet.markdown
+++ b/source/_integrations/vlc_telnet.markdown
@@ -2,7 +2,7 @@
title: VLC media player via Telnet
description: Instructions on how to integrate VLC media player into Home Assistant using the telnet interface.
ha_category:
- - Media Player
+ - Media player
ha_release: 0.95
ha_iot_class: Local Polling
ha_codeowners:
@@ -15,7 +15,7 @@ ha_platforms:
ha_integration_type: integration
---
-The `vlc_telnet` platform allows you to control a [VLC media player](https://www.videolan.org/vlc/index.html) using the built in telnet interface.
+The **VLC media player via Telnet** {% term integration %} allows you to control a [VLC media player](https://www.videolan.org/vlc/index.html) using the built in telnet interface.
This service will control any instance of VLC player on the network with the telnet interface activated.
To activate the telnet interface on your VLC Player please read the [official VLC documentation](https://wiki.videolan.org/Documentation:Modules/telnet/). Also remember to add a firewall rule allowing inbound connections for the port used in the device running VLC.
@@ -30,7 +30,7 @@ Consider to set the locale to `en_US` before starting VLC.
When using the `media_player.play_media` service, only the "music" media type is supported for now.
-## Home Assistant Add-on
+## Home Assistant add-on
You can run a VLC Media Player on your Home Assistant installation using the official [VLC add-on](https://github.com/home-assistant/addons/blob/master/vlc/DOCS.md).
Using it you can play files on the local network, Internet or files and playlist locally saved to the `/share` and `/media` folder of your Home Assistant installation.
diff --git a/source/_integrations/vodafone_station.markdown b/source/_integrations/vodafone_station.markdown
index 7020d34ab4e..a727c383501 100644
--- a/source/_integrations/vodafone_station.markdown
+++ b/source/_integrations/vodafone_station.markdown
@@ -2,7 +2,7 @@
title: Vodafone Station
description: Instructions on how to integrate Vodafone Station routers into Home Assistant.
ha_category:
- - Presence Detection
+ - Presence detection
ha_release: 2023.9
ha_domain: vodafone_station
ha_config_flow: true
@@ -17,7 +17,7 @@ ha_platforms:
ha_integration_type: integration
---
-The Vodafone Station integration allows you to control your [Vodafone Station](https://www.vodafone.it/privati/area-supporto/assistenza-dispositivi/vodafone-station.html) based router.
+The **Vodafone Station** {% term integration %} allows you to control your [Vodafone Station](https://www.vodafone.it/privati/area-supporto/assistenza-dispositivi/vodafone-station.html) based router.
The integration supports only Sercomm models so far.
@@ -28,24 +28,26 @@ There is support for the following platform types within Home Assistant:
- **Device tracker** - presence detection by looking at connected devices.
- **Sensor** - external IP address, uptime, firmware, resources and network monitors.
- **Button** - restart router, dsl/fiber/internet key connections.
+
{% include integrations/config_flow.md %}
## Integration options
-It is possible to change some behaviors through the integration options.
+It is possible to change some behaviors through the {% term integration %} options.
To change the settings, go to {% my integrations title="**Settings** > **Devices & Services**" %}. On the **Vodafone Station** integration, select the cogwheel. Then select **Configure**.
- **Consider home**: Number of seconds that must elapse before considering a disconnected device "not at home".
## Additional info
-### Device Tracker
+### Device tracker
-**Note**: If you don't want to automatically track newly detected devices, disable the integration system option `Enable new added entities`.
+**Note**: If you don't want to automatically track newly detected devices, disable the {% term integration %} system option `Enable new added entities`.
### Tested models
-This integration was tested against the following models from Sercomm:
+This {% term integration %} was tested against the following models from Sercomm:
- Vodafone Power Station (SHG3000)
- Vodafone WiFi 6 Station (RHG3006)
+- Vodafone Gigabox (SHG3000) - supplied by [Vodafone Ireland](https://deviceguides.vodafone.ie/vodafone/gigabox-windows-10/)
diff --git a/source/_integrations/voicerss.markdown b/source/_integrations/voicerss.markdown
index dbb4b07b045..59fdadb6c9b 100644
--- a/source/_integrations/voicerss.markdown
+++ b/source/_integrations/voicerss.markdown
@@ -11,7 +11,7 @@ ha_platforms:
ha_integration_type: integration
---
-The `voicerss` text-to-speech platform uses [VoiceRSS](http://www.voicerss.org/) text-to-speech engine to read a text with natural sounding voices.
+The **VoiceRSS** text-to-speech {% term integration %} uses [VoiceRSS](http://www.voicerss.org/) text-to-speech engine to read a text with natural sounding voices.
## Configuration
diff --git a/source/_integrations/voip.markdown b/source/_integrations/voip.markdown
index 240aef15ba0..2c4af8077ec 100644
--- a/source/_integrations/voip.markdown
+++ b/source/_integrations/voip.markdown
@@ -18,7 +18,7 @@ ha_platforms:
ha_config_flow: true
---
-The VoIP integration enables users to talk to [Assist](/voice_control/) using an analog phone and a VoIP adapter. Currently, the system works with the [Grandstream HT801](https://amzn.to/40k7mRa). See [the tutorial](/voice_control/worlds-most-private-voice-assistant) for detailed instructions.
+The **VoIP** {% term integration %} enables users to talk to [Assist](/voice_control/) using an analog phone and a VoIP adapter. Currently, the system works with the [Grandstream HT801](https://amzn.to/40k7mRa). See [the tutorial](/voice_control/worlds-most-private-voice-assistant) for detailed instructions.
As an alternative, the [Grandstream HT802](https://www.amazon.com/Grandstream-GS-HT802-Analog-Telephone-Adapter/dp/B01JH7MYKA/) can be used, which is basically the same as the previously mentioned HT801, but has two phone ports, of which Home Assistant currently support using only one of them.
diff --git a/source/_integrations/volkszaehler.markdown b/source/_integrations/volkszaehler.markdown
index b9d5d046277..852f41acdb7 100644
--- a/source/_integrations/volkszaehler.markdown
+++ b/source/_integrations/volkszaehler.markdown
@@ -2,7 +2,7 @@
title: Volkszaehler
description: Instructions on how to integrate Volkszaehler sensors into Home Assistant.
ha_category:
- - System Monitor
+ - System monitor
ha_iot_class: Local Polling
ha_release: 0.78
ha_domain: volkszaehler
@@ -11,7 +11,7 @@ ha_platforms:
ha_integration_type: integration
---
-The `volkszaehler` sensor platform is consuming the system information provided by the [Volkszaehler](https://wiki.volkszaehler.org/) API.
+The **Volkszaehler** {% term integration %} is consuming the system information provided by the [Volkszaehler](https://wiki.volkszaehler.org/) API.
## Configuration
diff --git a/source/_integrations/volumio.markdown b/source/_integrations/volumio.markdown
index 4b989b84dd5..909c7b4b839 100644
--- a/source/_integrations/volumio.markdown
+++ b/source/_integrations/volumio.markdown
@@ -2,7 +2,7 @@
title: Volumio
description: How to set up the Volumio media player integration
ha_category:
- - Media Player
+ - Media player
ha_release: 0.41
ha_iot_class: Local Polling
ha_config_flow: true
@@ -15,10 +15,10 @@ ha_platforms:
ha_integration_type: integration
---
-The `Volumio` platform allows you to control a [Volumio](https://volumio.org/) media player from Home Assistant.
+The **Volumio** {% term integration %} allows you to control a [Volumio](https://volumio.org/) media player from Home Assistant.
{% include integrations/config_flow.md %}
-Volumio versions 2.799 and below do not have a unique id when manually configured, so you will not be able to rename your entity or add your device to an area. If discovery does not work for you, it is advised to upgrade Volumio before configuring.
+Volumio versions 2.799 and below do not have a unique id when manually configured, so you will not be able to rename your {% term entity %} or add your device to an area. If discovery does not work for you, it is advised to upgrade Volumio before configuring.
diff --git a/source/_integrations/volvooncall.markdown b/source/_integrations/volvooncall.markdown
index 3f80ba1bd83..666cae8d4c6 100644
--- a/source/_integrations/volvooncall.markdown
+++ b/source/_integrations/volvooncall.markdown
@@ -18,11 +18,11 @@ ha_integration_type: integration
ha_config_flow: true
---
-The `volvooncall` integration offers integration with the [Volvo Cars App](https://www.volvocars.com/intl/v/volvo-cars-app) (former Volvo On Call) cloud service and offers presence detection as well as sensors such as odometer and fuel level.
+The **Volvo On Call** {% term integration %} offers integration with the [Volvo Cars App](https://www.volvocars.com/intl/v/volvo-cars-app) (former Volvo On Call) cloud service and offers presence detection as well as sensors such as odometer and fuel level.
{% include integrations/config_flow.md %}
-### Available Resources
+### Available resources
The list of currently available resources:
diff --git a/source/_integrations/vulcan.markdown b/source/_integrations/vulcan.markdown
index 5c8caf826b4..3d4a4183747 100644
--- a/source/_integrations/vulcan.markdown
+++ b/source/_integrations/vulcan.markdown
@@ -15,7 +15,7 @@ ha_platforms:
ha_integration_type: integration
---
-The Uonet+ Vulcan integration allows you to view timetable from your e-register.
+The **Uonet+ Vulcan** {% term integration %} allows you to view timetable from your e-register.
Supported informations:
@@ -23,6 +23,6 @@ Supported informations:
## Prerequisites
-To use Uonet+ Vulcan integration in Home Assistant you must obtain `token`, `symbol` and `pin` from your Vulcan account. You can find them in the student/parent panel in `Mobile access`/`Dostęp mobilny` tab.
+To use **Uonet+ Vulcan** {% term integration %} in Home Assistant you must obtain `token`, `symbol` and `pin` from your Vulcan account. You can find them in the student/parent panel in `Mobile access`/`Dostęp mobilny` tab.
{% include integrations/config_flow.md %}
diff --git a/source/_integrations/vultr.markdown b/source/_integrations/vultr.markdown
index c0ea0883855..aee506b0242 100644
--- a/source/_integrations/vultr.markdown
+++ b/source/_integrations/vultr.markdown
@@ -2,10 +2,10 @@
title: Vultr
description: Instructions on how to integrate Vultr within Home Assistant.
ha_category:
- - Binary Sensor
+ - Binary sensor
- Sensor
- Switch
- - System Monitor
+ - System monitor
ha_release: 0.58
ha_iot_class: Cloud Polling
ha_domain: vultr
@@ -16,11 +16,11 @@ ha_platforms:
ha_integration_type: integration
---
-The `vultr` integration allows you to access information about and interact with your [Vultr](https://www.vultr.com) subscriptions (Virtual Private Servers) from Home Assistant.
+The **Vultr** {% term integration %} allows you to access information about and interact with your [Vultr](https://www.vultr.com) subscriptions (Virtual Private Servers) from Home Assistant.
There is currently support for the following device types within Home Assistant:
-- [Binary Sensor](#binary-sensor)
+- [Binary sensor](#binary-sensor)
- [Sensor](#sensor)
- [Switch](#switch)
@@ -187,7 +187,7 @@ name:
type: string
{% endconfiguration %}
-### Additional Examples
+### Additional examples
Full example that produces `switch.amazing_server`, assuming a subscription that has an ID of `123456` and a label of `Web Server`:
diff --git a/source/_integrations/w800rf32.markdown b/source/_integrations/w800rf32.markdown
index d89b3a4de64..2dee4eb4651 100644
--- a/source/_integrations/w800rf32.markdown
+++ b/source/_integrations/w800rf32.markdown
@@ -2,7 +2,7 @@
title: WGL Designs W800RF32
description: Instructions on how to integrate a W800rf32(a) into Home Assistant.
ha_category:
- - Binary Sensor
+ - Binary sensor
- Hub
ha_release: 0.83
ha_iot_class: Local Push
@@ -12,7 +12,7 @@ ha_platforms:
ha_integration_type: integration
---
-The `w800rf32` integration supports W800RF32 devices by WGL Designs which
+The **WGL Designs W800RF32** {% term integration %} supports W800RF32 devices by WGL Designs which
communicate in the frequency range of 310MHz or if you are outside Canada or the U.S., 433.92 MHz.
The W800 family of RF receivers are designed to receive X10 RF signals generated from X10 products: Palm Pad
@@ -33,7 +33,7 @@ device:
type: string
{% endconfiguration %}
-## Binary Sensor
+## Binary sensor
The `w800rf32` platform supports X10 RF binary sensors such as Palm Pad remotes, key chain remotes, Hawkeye motion detectors, and many, many other X10 RF devices. Some that have specifically been used with this are the KR19A keychain, MS16A motion detector and the RSS18 four button wall mount keypad.
diff --git a/source/_integrations/wake_on_lan.markdown b/source/_integrations/wake_on_lan.markdown
index 9c1db398cb8..65d8aef8d3e 100644
--- a/source/_integrations/wake_on_lan.markdown
+++ b/source/_integrations/wake_on_lan.markdown
@@ -14,7 +14,7 @@ ha_codeowners:
ha_integration_type: integration
---
-The `wake_on_lan` integration enables the ability to send _magic packets_ to [Wake on LAN](https://en.wikipedia.org/wiki/Wake-on-LAN) capable devices to turn them on.
+The **Wake on LAN** {% term integration %} enables the ability to send _magic packets_ to [Wake on LAN](https://en.wikipedia.org/wiki/Wake-on-LAN) capable devices to turn them on.
There is currently support for the following device types within Home Assistant:
@@ -22,7 +22,7 @@ There is currently support for the following device types within Home Assistant:
## Configuration
-To use this integration in your installation, add the following to your `configuration.yaml` file:
+To use this {% term integration %} in your installation, add the following to your `configuration.yaml` file:
```yaml
# Example configuration.yaml entry
@@ -58,7 +58,7 @@ The service to route the packet is most likely named "IP Helper". It may support
## Switch
-The `wake_on_lan` (WOL) switch integration allows you to turn on a [WOL](https://en.wikipedia.org/wiki/Wake-on-LAN) enabled computer.
+The `wake_on_lan` (WOL) switch {% term integration %} allows you to turn on a [WOL](https://en.wikipedia.org/wiki/Wake-on-LAN) enabled computer.
### Switch configuration
diff --git a/source/_integrations/wake_word.markdown b/source/_integrations/wake_word.markdown
index bddcab487bc..53a9b4197e9 100644
--- a/source/_integrations/wake_word.markdown
+++ b/source/_integrations/wake_word.markdown
@@ -12,7 +12,7 @@ ha_integration_type: entity
ha_quality_scale: internal
---
-A wake-word-detection entity allows other integrations or applications to detect wake words in streaming audio.
+A wake-word-detection {% term entity %} allows other {% term integrations %} or applications to detect wake words in streaming audio.
The wake-word-detection entities cannot be implemented manually, but can be provided by integrations such as [Wyoming](/integrations/wyoming). The API in [Assist Pipelines](https://developers.home-assistant.io/docs/voice/pipelines/) enables wake-word-detection as part of [Assist](/voice_control/).
diff --git a/source/_integrations/wallbox.markdown b/source/_integrations/wallbox.markdown
index a3b852505ee..592d21c333c 100644
--- a/source/_integrations/wallbox.markdown
+++ b/source/_integrations/wallbox.markdown
@@ -17,41 +17,41 @@ ha_codeowners:
ha_integration_type: integration
---
-The Wallbox integration pulls data from the [MyWallbox Portal](https://my.wallbox.com) for your Wallbox charging station.
+The **Wallbox** {% term integration %} pulls data from the [MyWallbox Portal](https://my.wallbox.com) for your Wallbox charging station.
{% include integrations/config_flow.md %}
## Sensors
-The integration adds the following sensors:
+The {% term integration %} adds the following sensors:
-- Added Energy
-- Added Range
-- Charging Power
-- Charging Speed
-- Charging Time
+- Added energy
+- Added range
+- Charging power
+- Charging speed
+- Charging time
- Cost
-- Current Mode
-- Depot Price
-- Energy Price
-- Max Available Power
-- State of Charge
-- Status Description
-- Max Charging Current
+- Current mode
+- Depot price
+- Energy price
+- Max available power
+- State of charge
+- Status description
+- Max charging current
## Number
-The integration adds the following number entities:
+The {% term integration %} adds the following number entities:
-- Max Charging Current
-- Energy Price
+- Max charging current
+- Energy price
-The number entity is only loaded if the supplied username has sufficient rights to change the Max. Charging Current.
+The number {% term entity %} is only loaded if the supplied username has sufficient rights to change the Max. Charging Current.
## Lock
-The integration adds a lock entity, allowing you to lock the charger. Please note, this only works with a user with admin rights.
+The {% term integration %} adds a lock {% term entity %}, allowing you to lock the charger. Please note, this only works with a user with admin rights.
## Switch
-The integration adds a switch entity, allowing you to pause/resume the charging process.
+The {% term integration %} adds a switch {% term entity %}, allowing you to pause/resume the charging process.
diff --git a/source/_integrations/waqi.markdown b/source/_integrations/waqi.markdown
index ed6c7d7ed37..25f515aaca9 100644
--- a/source/_integrations/waqi.markdown
+++ b/source/_integrations/waqi.markdown
@@ -14,7 +14,7 @@ ha_integration_type: integration
ha_config_flow: true
---
-The `waqi` sensor platform will query [World Air Quality Index](https://aqicn.org/city/beijing/) service to check AQI value for a specific set of locations. The resulting indexes will be added to the Home Assistant as sensor outputs.
+The **World Air Quality Index (WAQI)** {% term integration %} will query [World Air Quality Index](https://aqicn.org/city/beijing/) service to check AQI value for a specific set of locations. The resulting indexes will be added to the Home Assistant as sensor outputs.
## Setup
diff --git a/source/_integrations/water_heater.markdown b/source/_integrations/water_heater.markdown
index f74ed77e1b3..98ac0686bab 100644
--- a/source/_integrations/water_heater.markdown
+++ b/source/_integrations/water_heater.markdown
@@ -1,5 +1,5 @@
---
-title: Water Heater
+title: Water heater
description: Instructions on how to setup water heater devices within Home Assistant.
ha_release: 0.81
ha_domain: water_heater
@@ -10,9 +10,9 @@ ha_codeowners:
ha_integration_type: entity
---
-The `water_heater` integration is built for the controlling and monitoring of hot water heaters.
+The **Water heater** {% term integration %} is built for the controlling and monitoring of hot water heaters.
-To enable this integration, pick one of the platforms, and add it to your `configuration.yaml`:
+To enable this {% term integration %}, pick one of the platforms, and add it to your `configuration.yaml`:
```yaml
# Example configuration.yaml entry
@@ -40,9 +40,9 @@ Sets target temperature of water heater device.
| ---------------------- | -------- | ----------- |
| `entity_id` | yes | String or list of strings that point at the `entity_id` of water heater devices to control. Use `entity_id: all` to target all.
| `temperature` | no | New target temperature for water heater
-| `operation_mode` | yes | Operation mode to set the temperature to. This defaults to current_operation mode if not set, or set incorrectly. For a list of possible modes, refer to the integration documentation.
+| `operation_mode` | yes | Operation mode to set the temperature to. This defaults to current_operation mode if not set, or set incorrectly. For a list of possible modes, refer to the {% term integration %} documentation.
-#### Automation example
+#### Automation example
```yaml
automation:
diff --git a/source/_integrations/water_heater.mqtt.markdown b/source/_integrations/water_heater.mqtt.markdown
index d68e9a0521f..f22ec09bba5 100644
--- a/source/_integrations/water_heater.mqtt.markdown
+++ b/source/_integrations/water_heater.mqtt.markdown
@@ -1,14 +1,14 @@
---
-title: "MQTT Water Heater"
-description: "Instructions on how to integrate MQTT Water Heater into Home Assistant."
+title: "MQTT water heater"
+description: "Instructions on how to integrate MQTT water heater into Home Assistant."
ha_category:
- - Water Heater
+ - Water heater
ha_release: 2023.7
ha_iot_class: Local Polling
ha_domain: mqtt
---
-The `mqtt` water heater platform lets you control your MQTT enabled Water Heater devices.
+The `mqtt` water heater platform lets you control your MQTT enabled water heater devices.
## Configuration
@@ -70,7 +70,7 @@ current_temperature_topic:
required: false
type: string
device:
- description: 'Information about the device this Water Heater device is a part of to tie it into the [device registry](https://developers.home-assistant.io/docs/en/device_registry_index.html). Only works through [MQTT discovery](/integrations/mqtt/#mqtt-discovery) and when [`unique_id`](#unique_id) is set. At least one of identifiers or connections must be present to identify the device.'
+ description: 'Information about the device this water heater device is a part of to tie it into the [device registry](https://developers.home-assistant.io/docs/en/device_registry_index.html). Only works through [MQTT discovery](/integrations/mqtt/#mqtt-discovery) and when [`unique_id`](#unique_id) is set. At least one of identifiers or connections must be present to identify the device.'
required: false
type: map
keys:
@@ -158,7 +158,7 @@ mode_command_template:
required: false
type: template
mode_command_topic:
- description: The MQTT topic to publish commands to change the Water Heater operation mode.
+ description: The MQTT topic to publish commands to change the water heater operation mode.
required: false
type: string
mode_state_template:
@@ -166,7 +166,7 @@ mode_state_template:
required: false
type: template
mode_state_topic:
- description: The MQTT topic to subscribe for changes of the Water Heater operation mode. If this is not set, the operation mode works in optimistic mode (see below).
+ description: The MQTT topic to subscribe for changes of the water heater operation mode. If this is not set, the operation mode works in optimistic mode (see below).
required: false
type: string
modes:
@@ -175,10 +175,10 @@ modes:
default: ['off', 'eco', 'electric', 'gas', 'heat_pump', 'high_demand', 'performance']
type: list
name:
- description: The name of the Water Heater. Can be set to `null` if only the device name is relevant.
+ description: The name of the water heater. Can be set to `null` if only the device name is relevant.
required: false
type: string
- default: MQTT Water Heater
+ default: MQTT water heater
object_id:
description: Used instead of `name` for automatic generation of `entity_id`
required: false
@@ -252,7 +252,7 @@ temperature_unit:
required: false
type: string
unique_id:
- description: An ID that uniquely identifies this Water Heater device. If two Water Heater devices have the same unique ID, Home Assistant will raise an exception.
+ description: An ID that uniquely identifies this water heater device. If two water heater devices have the same unique ID, Home Assistant will raise an exception.
required: false
type: string
value_template:
@@ -263,9 +263,9 @@ value_template:
## Optimistic mode
-If a property works in *optimistic mode* (when the corresponding state topic is not set), Home Assistant will assume that any state changes published to the command topics did work and change the internal state of the entity immediately after publishing to the command topic. If it does not work in optimistic mode, the internal state of the entity is only updated when the requested update is confirmed by the device through the state topic. You can enforce optimistic mode by setting the `optimistic` option to `true`. When set, the internal state will always be updated, even when a state topic is defined.
+If a property works in *optimistic mode* (when the corresponding state topic is not set), Home Assistant will assume that any state changes published to the command topics did work and change the internal state of the {% term entity %} immediately after publishing to the command topic. If it does not work in optimistic mode, the internal state of the {% term entity %} is only updated when the requested update is confirmed by the device through the state topic. You can enforce optimistic mode by setting the `optimistic` option to `true`. When set, the internal state will always be updated, even when a state topic is defined.
-## Using Templates
+## Using templates
For all `*_state_topic`s, a template can be specified that will be used to render the incoming payloads on these topics. Also, a default template that applies to all state topics can be specified as `value_template`. This can be useful if you received payloads are e.g., in JSON format. Since in JSON, a quoted string (e.g., `"foo"`) is just a string, this can also be used for unquoting.
diff --git a/source/_integrations/waterfurnace.markdown b/source/_integrations/waterfurnace.markdown
index 9e02295ca67..57e91ce39e2 100644
--- a/source/_integrations/waterfurnace.markdown
+++ b/source/_integrations/waterfurnace.markdown
@@ -11,7 +11,7 @@ ha_platforms:
ha_integration_type: integration
---
-The `waterfurnace` integration communicates with the WaterFurnace Symphony website's WebSocket to show you many of the sensors in your system. While not an official API, this is the same backend the Symphony website is based on, and should be reasonably stable.
+The **WaterFurnace** {% term integration %} communicates with the WaterFurnace Symphony website's WebSocket to show you many of the sensors in your system. While not an official API, this is the same backend the Symphony website is based on, and should be reasonably stable.
The sensors provided include:
diff --git a/source/_integrations/watson_iot.markdown b/source/_integrations/watson_iot.markdown
index bbac6c9a4c2..d5d2827025a 100644
--- a/source/_integrations/watson_iot.markdown
+++ b/source/_integrations/watson_iot.markdown
@@ -9,12 +9,12 @@ ha_iot_class: Cloud Push
ha_integration_type: integration
---
-The `watson_iot` integration enables you to link the devices in Home Assistant
+The **IBM Watson IoT Platform** {% term integration %} enables you to link the devices in Home Assistant
with an [IBM Watson IoT Platform instance](https://www.ibm.com/us-en/marketplace/internet-of-things-cloud).
## Configuration
-To use this integration, you first need to register a gateway device type and then
+To use this {% term integration %}, you first need to register a gateway device type and then
a gateway device in your IoT platform instance. For instructions on how to do
this check the [official documentation](https://cloud.ibm.com/docs/services/IoT?topic=iot-platform-getting-started#IoT_connectGateway)
which provides the details on doing this. After you register the gateway device
@@ -25,7 +25,7 @@ for your Home Assistant instance you'll need four pieces of information:
- Gateway device ID
- Authentication Token
-With this basic information you can configure the integration:
+With this basic information you can configure the {% term integration %}:
```yaml
# Example configuration.yaml entry:
diff --git a/source/_integrations/watttime.markdown b/source/_integrations/watttime.markdown
index 44b7dd1f809..a3b545eb8fc 100644
--- a/source/_integrations/watttime.markdown
+++ b/source/_integrations/watttime.markdown
@@ -15,9 +15,9 @@ ha_platforms:
ha_integration_type: service
---
-The WattTime integration allows users to get real-time emissions data for a latitude/longitude from [WattTime](https://www.watttime.org).
+The **WattTime** {% term integration %} allows users to get real-time emissions data for a latitude/longitude from [WattTime](https://www.watttime.org).
-## Registering an Account
+## Registering an account
WattTime account registration is accomplished [via the REST API itself](https://www.watttime.org/api-documentation/#register-new-user). The simplest way to do this is by using cURL on the command line:
diff --git a/source/_integrations/waze_travel_time.markdown b/source/_integrations/waze_travel_time.markdown
index 7166acb8659..df54f323576 100644
--- a/source/_integrations/waze_travel_time.markdown
+++ b/source/_integrations/waze_travel_time.markdown
@@ -14,15 +14,15 @@ ha_codeowners:
ha_integration_type: integration
---
-The `waze_travel_time` sensor provides travel time from the [Waze](https://www.waze.com/).
+The **Waze Travel Time** {% term integration %} provides travel time from the [Waze](https://www.waze.com/).
{% include integrations/config_flow.md %}
Notes:
-- If a unit system is not specified, the integration will use the unit system configured on your Home Assistant instance.
+- If a unit system is not specified, the {% term integration %} will use the unit system configured on your Home Assistant instance.
- **Origin** and **Destination** can be the address or the GPS coordinates of the location. For coordinates, use the following format: `52.5200, 13.4050`. Make sure the coordinates are separated by a comma. They must not include letters. You can also enter an entity id which provides this information in its state, an entity id with latitude and longitude attributes, or zone friendly name (case sensitive).
-- The string inputs for `Substring *` allow you to force the integration to use a particular route or avoid a particular route in its time travel calculation. These inputs are case insensitive and matched against the description of the route.
+- The string inputs for `Substring *` allow you to force the {% term integration %} to use a particular route or avoid a particular route in its time travel calculation. These inputs are case insensitive and matched against the description of the route.
- When using the `Avoid Toll Roads?`, `Avoid Subscription Roads?` and `Avoid Ferries?` options, be aware that Waze will sometimes still route you over toll roads or ferries if a valid vignette/subscription is assumed. Default behavior is that Waze will route you over roads having subscription options. It is therefor best is to set both `Avoid Toll Roads?` and `Avoid Subscription Roads?` or `Avoid Ferries?` if needed and experiment to ensure the desired outcome.
## Defining a custom polling interval
@@ -31,7 +31,7 @@ Notes:
## Example using dynamic destination
-Using the flexible option to set a sensor value to the `Destination`, you can setup a single Waze integration that will calculate travel time to multiple optional locations on demand.
+Using the flexible option to set a sensor value to the `Destination`, you can setup a single Waze {% term integration %} that will calculate travel time to multiple optional locations on demand.
In the following example, the `Input Select` is converted into an address which is used to modify the destination for the Waze route calculation from the `device_tracker.myphone` location. It takes a few minutes for the value to update due to the interval of Waze data fetching.
@@ -84,7 +84,7 @@ In this example we are using the entity ID of a zone as the origin and the frien
- Destination: "Eddies House"
- Region: "US"
-#### Tracking entity in Imperial Units
+#### Tracking entity in imperial units
- Name: "Somewhere in New York"
- Origin: `person.paulus`
diff --git a/source/_integrations/weather.markdown b/source/_integrations/weather.markdown
index 38f14ef19de..5c9fff4f434 100644
--- a/source/_integrations/weather.markdown
+++ b/source/_integrations/weather.markdown
@@ -11,22 +11,23 @@ ha_domain: weather
ha_integration_type: entity
---
-The `weather` platforms gather meteorological information from web services and display the conditions and other details about the weather at the given location.
+The `weather` platforms gather meteorological information from web services and display the conditions and other details about the weather at the given location.
{% include integrations/building_block_integration.md %}
For a list of weather integrations, on the integrations page, select the [weather category](/integrations/#weather).
-Read the integration documentation for your particular weather provider to learn how to set it up.
+Read the {% term integration %} documentation for your particular weather provider to learn how to set it up.
Home Assistant currently supports free web services some of which require registration.
## State and state attributes
-A weather entity's state is used to indicate the current overall conditions, e.g. 'cloudy' or 'sunny'.
+A weather {% term entity %}'s state is used to indicate the current overall conditions, e.g. 'cloudy' or 'sunny'.
+
### Condition mapping
-The `weather` platform only knows the below listed conditions. The reason for this is that for these conditions is an icon from [Material Design Icons](https://pictogrammers.com/library/mdi/) available and mapped in the frontend.
+The `weather` {% term entity %} can provide the conditions listed below as its state:
- 'clear-night'
- 'cloudy'
@@ -46,7 +47,7 @@ The `weather` platform only knows the below listed conditions. The reason for th
### State attributes
-Detailed weather conditions as well as the unit of measurements used for the conditions are indicated by state attributes. A weather entity may not support all the state attributes.
+Detailed weather conditions as well as the unit of measurements used for the conditions are indicated by state attributes. A weather {% term entity %} may not support all the state attributes.
{% raw %}
```yaml
diff --git a/source/_integrations/weather.template.markdown b/source/_integrations/weather.template.markdown
index 9918f2ae0b8..a320bd28b07 100644
--- a/source/_integrations/weather.template.markdown
+++ b/source/_integrations/weather.template.markdown
@@ -11,11 +11,11 @@ ha_domain: template
The `template` integrations creates weather provider that combines integrations and an existing weather provider into a fused weather provider.
-There are several powerful ways to use this integration, including localizing your weather provider information with local information from temperature, humidity, pressure sensors that you own.
+There are several powerful ways to use this {% term integration %}, including localizing your weather provider information with local information from temperature, humidity, pressure sensors that you own.
Another use case could be using temperature and humidity from one weather platform, with forecasts from a different one.
-Output will be converted according to the user's unit system or entity override, see [documentation](https://developers.home-assistant.io/docs/core/entity/weather/#unit-conversion).
+Output will be converted according to the user's unit system or {% term entity %} override, see [documentation](https://developers.home-assistant.io/docs/core/entity/weather/#unit-conversion).
## Configuration
@@ -136,4 +136,4 @@ precipitation_unit:
### Template variables
-State-based template entities have the special template variable `this` available in their templates. The `this` variable aids [self-referencing](/integrations/template#self-referencing) of an entity's state and attribute in templates.
+State-based template entities have the special template variable `this` available in their templates. The `this` variable aids [self-referencing](/integrations/template#self-referencing) of an {% term entity %}'s state and attribute in templates.
diff --git a/source/_integrations/weatherflow.markdown b/source/_integrations/weatherflow.markdown
index 2e80a180855..4c264a34466 100644
--- a/source/_integrations/weatherflow.markdown
+++ b/source/_integrations/weatherflow.markdown
@@ -16,17 +16,17 @@ ha_domain: weatherflow
ha_integration_type: hub
---
-This integration is a local-only WeatherFlow integration that reads weather data from all [WeatherFlow Tempest](https://weatherflow.com/tempest-weather-system/) compatible weather station on the local network.
+The **WeatherFlow** {% term integration %} is a local-only {% term integration %} that reads weather data from all [WeatherFlow Tempest](https://weatherflow.com/tempest-weather-system/) compatible weather station on the local network.
-You may see slight deviations between the values reported in Home Assistant and the values in the WeatherFlow App. This is because the WeatherFlow app considers both forecasts and neighboring weather stations in addition to the local data used in this integration.
+You may see slight deviations between the values reported in Home Assistant and the values in the WeatherFlow App. This is because the WeatherFlow app considers both forecasts and neighboring weather stations in addition to the local data used in this {% term integration %}.
{% include integrations/config_flow.md %}
## Sensors
-This integration will expose the following sensors:
+This {% term integration %} will expose the following sensors:
- Air density
- Air pressure
@@ -60,4 +60,4 @@ Additionally the following diagnostic sensors are available:
## Networking notes
-This integration relies on the ability of Home Assistant to receive `UDP` traffic on port `50222`. You may run into trouble if you have a more complex network setup utilizing either VLANs or multiple subnets.
+This {% term integration %} relies on the ability of Home Assistant to receive `UDP` traffic on port `50222`. You may run into trouble if you have a more complex network setup utilizing either VLANs or multiple subnets.
diff --git a/source/_integrations/weatherkit.markdown b/source/_integrations/weatherkit.markdown
index 7ca6bf4ece8..39c27ad1277 100644
--- a/source/_integrations/weatherkit.markdown
+++ b/source/_integrations/weatherkit.markdown
@@ -15,7 +15,7 @@ ha_platforms:
- weather
---
-The Apple WeatherKit integration obtains current weather and forecasts (hourly and daily) from Apple Weather. It is the most direct replacement for those coming from the Dark Sky API since Apple bought Dark Sky and implemented its technology into their weather service.
+The **Apple WeatherKit** {% term integration %} obtains current weather and forecasts (hourly and daily) from Apple Weather. It is the most direct replacement for those coming from the Dark Sky API since Apple bought Dark Sky and implemented its technology into their weather service.
There is currently support for the following device types within Home Assistant:
@@ -24,7 +24,7 @@ There is currently support for the following device types within Home Assistant:
## Requirements
-You will need a [paid Apple Developer Program account](https://developer.apple.com/support/compare-memberships/) to use this integration.
+You will need a [paid Apple Developer Program account](https://developer.apple.com/support/compare-memberships/) to use this {% term integration %}.
{% include integrations/config_flow.md %}
@@ -44,7 +44,7 @@ You will need to obtain the appropriate credentials which you will use to connec
3. For the identifier, Apple recommends using a reverse-DNS style name, like `com.example.homeassistant`.
4. Save the identifier you used. This is your **Service ID**.
-You can add a new WeatherKit integration entry now that you have all the credentials. Using the details from earlier, it should look something like this:
+You can add a new WeatherKit {% term integration %} entry now that you have all the credentials. Using the details from earlier, it should look something like this:
- **Key ID**: `ABC123DEFG`
- **Service ID**: `com.example.homeassistant`
@@ -55,7 +55,7 @@ You can add a new WeatherKit integration entry now that you have all the credent
### Troubleshooting
-If you are having issues setting up the integration, please make sure the following are true:
+If you are having issues setting up the {% term integration %}, please make sure the following are true:
- You are entering the key exactly as it appears in the `.p8` file, including the header and footer.
- There are no leading or trailing spaces in other configuration values.
diff --git a/source/_integrations/webostv.markdown b/source/_integrations/webostv.markdown
index a91c59c1c6f..347450df746 100644
--- a/source/_integrations/webostv.markdown
+++ b/source/_integrations/webostv.markdown
@@ -2,7 +2,7 @@
title: LG webOS Smart TV
description: Instructions on how to integrate a LG webOS Smart TV within Home Assistant.
ha_category:
- - Media Player
+ - Media player
- Notifications
ha_iot_class: Local Push
ha_release: 0.18
@@ -23,7 +23,7 @@ The `webostv` platform allows you to control a [LG](https://www.lg.com/) webOS S
There is currently support for the following device types within Home Assistant:
-- [Media Player](/integrations/media_player/)
+- [Media player](/integrations/media_player/)
- [Notifications](/integrations/notify/)
To begin with enable *LG Connect Apps* feature in *Network* settings of the TV.
@@ -32,7 +32,7 @@ To begin with enable *LG Connect Apps* feature in *Network* settings of the TV.
## Turn on action
-Home Assistant is able to turn on an LG webOS Smart TV if you specify an action, provided by an integration like [HDMI-CEC](/integrations/hdmi_cec/) or [WakeOnLan](/integrations/wake_on_lan/).
+Home Assistant is able to turn on an LG webOS Smart TV if you specify an action, provided by an {% term integration %} like [HDMI-CEC](/integrations/hdmi_cec/) or [WakeOnLan](/integrations/wake_on_lan/).
Common for webOS 3.0 and higher would be to use WakeOnLan feature. To use this feature your TV should be connected to your network via Ethernet rather than Wireless and you should enable the *LG Connect Apps* feature in *Network* settings of the TV (or *Mobile App* in *General* settings for older models) (*may vary by version).
@@ -64,7 +64,7 @@ Any other [actions](/docs/automation/action/) to power on the device can be conf
## Sources
-It is possible to select which sources will be available to the media player. When the TV is powered on press the **CONFIGURE** button in the integration card and select the sources to enable. If you don't select any source the media player will offer all of the sources of the TV.
+It is possible to select which sources will be available to the media player. When the TV is powered on press the **CONFIGURE** button in the {% term integration %} card and select the sources to enable. If you don't select any source the media player will offer all of the sources of the TV.
## Change channel through play_media service
diff --git a/source/_integrations/wemo.markdown b/source/_integrations/wemo.markdown
index 4f37e7d534c..20642c35cbd 100644
--- a/source/_integrations/wemo.markdown
+++ b/source/_integrations/wemo.markdown
@@ -2,7 +2,7 @@
title: Belkin WeMo
description: Instructions on how to integrate Belkin WeMo devices into Home Assistant.
ha_category:
- - Binary Sensor
+ - Binary sensor
- Fan
- Hub
- Light
@@ -24,11 +24,11 @@ ha_codeowners:
ha_integration_type: integration
---
-The `wemo` integration is the main integration to integrate various [Belkin WeMo](https://www.belkin.com/products/wemo-smart-home/) devices with Home Assistant.
+The **Belkin WeMo** {% term integration %} is the main {% term integration %} to integrate various [Belkin WeMo](https://www.belkin.com/products/wemo-smart-home/) devices with Home Assistant.
There is currently support for the following device types within Home Assistant:
-- Binary Sensor (Belkin WeMo Motion Sensor)
+- Binary sensor (Belkin WeMo Motion Sensor)
- Fan (Belkin WeMo (Holmes) Smart Humidifier)
- Light (Belkin WeMo LED lights and Smart Dimmer Switch)
- Switch ([Belkin WeMo Switches](https://www.belkin.com/products/wemo-smart-home/) and includes support for WeMo enabled [Mr. Coffee](https://www.mrcoffee.com/) smart coffee makers.)
@@ -73,9 +73,9 @@ Note that if you use static device entries, you may want to set up your router (
If the device doesn't seem to work and all you see is the state "unavailable" on your dashboard, check that your firewall doesn't block incoming requests on port 8989, since this is the port to which the WeMo devices send their updates.
-### Device Options
+### Device options
-Clicking the **Configure** button on the WeMo integration will bring up some additional options that can be configured for WeMo devices.
+Selecting the **Configure** button on the WeMo {% term integration %} will bring up some additional options that can be configured for WeMo devices.
@@ -107,7 +107,7 @@ wemo:
The `wemo` platform allows you to control your Belkin WeMo humidifiers from within Home Assistant. This includes support for the Holmes Smart Humidifier.
-WeMo devices are automatically discovered if the `discovery` integration is enabled.
+WeMo devices are automatically discovered if the `discovery` {% term integration %} is enabled.
### Attributes
@@ -135,7 +135,7 @@ There are several services which can be used for automations and control of the
| `wemo.set_humidity` | Calling this service will set the desired relative humidity setting on the device (entity_id is a required list of 1 or more entities to set humidity on, and target_humidity is a required float value between 0 and 100 (this value will be rounded down and mapped to one of the valid desired humidity settings of 45, 50, 55, 60, or 100 that are supported by the WeMo humidifier)).
| `wemo.reset_filter_life` | Calling this service will reset the humdifier's filter lifetime back to 100% (entity_id is a required list of 1 or more entities to reset the filter lifetime on). Call this service when you change the filter on your humidifier.
-## Long Press Events and Triggers
+## Long press events and triggers
For WeMo Light Switches and Dimmers, pressing the button on the device for two seconds will activate a long press event. The long-press can trigger an automation
either by using an `event` trigger or a `device` trigger. For an `event` trigger the `event_type` will be `wemo_subscription_event`. The event data will have a `type` parameter
diff --git a/source/_integrations/whirlpool.markdown b/source/_integrations/whirlpool.markdown
index 18423811f09..5629b5f13f7 100644
--- a/source/_integrations/whirlpool.markdown
+++ b/source/_integrations/whirlpool.markdown
@@ -17,7 +17,7 @@ ha_platforms:
ha_integration_type: hub
---
-The `whirlpool` integration integrates Whirlpool 6th Sense Live, and Whirlpool/Maytag Washer and Dryer appliances into Home Assistant.
+The **Whirlpool Appliances** {% term integration %} integrates Whirlpool 6th Sense Live, and Whirlpool/Maytag Washer and Dryer appliances into Home Assistant.
There is currently support for the following device types within Home Assistant:
diff --git a/source/_integrations/whois.markdown b/source/_integrations/whois.markdown
index 4c3c533564d..90dc9146e6f 100644
--- a/source/_integrations/whois.markdown
+++ b/source/_integrations/whois.markdown
@@ -15,7 +15,6 @@ ha_platforms:
ha_integration_type: service
---
-The Whois integration allows you to perform daily WHOIS lookups against your owned domains. This provides you with information such as `expiration_date`, `name_servers` and `registrar` details.
-
+The **Whois** {% term integration %} allows you to perform daily WHOIS lookups against your owned domains. This provides you with information such as `expiration_date`, `name_servers` and `registrar` details.
{% include integrations/config_flow.md %}
diff --git a/source/_integrations/wiffi.markdown b/source/_integrations/wiffi.markdown
index 50f91440b19..e000f4279a7 100644
--- a/source/_integrations/wiffi.markdown
+++ b/source/_integrations/wiffi.markdown
@@ -15,7 +15,7 @@ ha_platforms:
ha_integration_type: integration
---
-This integration allows you to connect your [STALL WIFFI](https://stall.biz) devices directly to Home Assistant.
+This **Wiffi** {% term integration %} allows you to connect your [STALL WIFFI](https://stall.biz) devices directly to Home Assistant.
{% include integrations/config_flow.md %}
diff --git a/source/_integrations/wilight.markdown b/source/_integrations/wilight.markdown
index bf5cfc7f39a..eff11b3a57b 100644
--- a/source/_integrations/wilight.markdown
+++ b/source/_integrations/wilight.markdown
@@ -23,7 +23,7 @@ ha_platforms:
ha_integration_type: integration
---
-The `wilight` integration is to integrate [WiLight](http://www.wilight.com.br) devices with Home Assistant.
+The **WiLight** {% term integration %} is to integrate [WiLight](http://www.wilight.com.br) devices with Home Assistant.
There is currently support for the following device types within Home Assistant:
@@ -36,9 +36,9 @@ There is currently support for the following device types within Home Assistant:
## Fan
-The `wilight` integration allows you to control your Fans from within Home Assistant.
+The **WiLight** {% term integration %} allows you to control your Fans from within Home Assistant.
-### Fan Services
+### Fan services
There are several services which can be used for automations and control of the fan:
@@ -52,12 +52,12 @@ There are several services which can be used for automations and control of the
## Irrigation
-The `wilight` integration allows you to control your Irrigation from within Home Assistant. This is exposed via switches in Home Assistant.
+The **WiLight** {% term integration %} allows you to control your Irrigation from within Home Assistant. This is exposed via switches in Home Assistant.
There are two switch types for Irrigation: `watering switch` and `pause switch`.
A `watering switch` can turn on and off the irrigation valve, while the `pause switch` can disable / enable the action of a `watering switch`.
`Triggers` activate (turn on) the `watering switch` (irrigation valve) at the programmed time. The trigger can be set to run on a day of the week or only once (today).
-### Irrigation Services
+### Irrigation services
There are several services which can be used for automations and control of the Irrigation:
diff --git a/source/_integrations/wirelesstag.markdown b/source/_integrations/wirelesstag.markdown
index dae45b50606..481a5339742 100644
--- a/source/_integrations/wirelesstag.markdown
+++ b/source/_integrations/wirelesstag.markdown
@@ -2,7 +2,7 @@
title: Wireless Sensor Tags
description: Instructions on how to integrate your Wireless Tags sensors within Home Assistant.
ha_category:
- - Binary Sensor
+ - Binary sensor
- Hub
- Sensor
- Switch
@@ -18,11 +18,11 @@ ha_codeowners:
ha_integration_type: integration
---
-The `wirelesstag` implementation allows you to integrate your [wirelesstag.net](https://wirelesstag.net/) sensors tags in Home Assistant.
+The **Wireless Sensor Tags** {% term integration %} allows you to integrate your [wirelesstag.net](https://wirelesstag.net/) sensors tags in Home Assistant.
There is currently support for the following device types within Home Assistant:
-- [Binary Sensor](#binary-sensor)
+- [Binary sensor](#binary-sensor)
- [Sensor](#sensor)
- [Switch](#switch)
@@ -48,7 +48,7 @@ password:
type: string
{% endconfiguration %}
-## Binary Sensor
+## Binary sensor
To enable the binary sensor platform for your tags, set up with your [wirelesstag.net](https://wirelesstag.net/) account. Add the following to your `configuration.yaml` file:
diff --git a/source/_integrations/withings.markdown b/source/_integrations/withings.markdown
index 848a7a4d9e2..71a945be412 100644
--- a/source/_integrations/withings.markdown
+++ b/source/_integrations/withings.markdown
@@ -19,21 +19,25 @@ ha_integration_type: integration
ha_quality_scale: platinum
---
-The Withings integration consumes data from various health products produced by [Withings](https://www.withings.com).
+The **Withings** {% term integration %} consumes data from various health products produced by [Withings](https://www.withings.com).
## Create a Withings developer account
You must have a developer account to distribute the data. [Create a free developer account](https://account.withings.com/partner/add_oauth2).
-Values for your account:
+Create an application:
+1. Ensure you have selected *Withings public cloud* (instead of Withings US medical cloud)
+2. Create an application
+3. Application creation: Public creation.
+ - Read and accept the terms if you're happy by pressing **Next**
+4. Information:
+ - Target environment: *Development*
+ - Application name: [any name]
+ - Application description: [any description]
+ - Registered URLs: `https://my.home-assistant.io/redirect/oauth`
+ - Change logo: Optional.
-- Logo: Any reasonable picture will do.
-- Description: Personal app for collecting my data.
-- Contact Email: Your email address
-- Callback Uri: `https://my.home-assistant.io/redirect/oauth`.
-- Company: Home Assistant
-
-Once saved, the "Client Id" and "Consumer Secret" fields will be populated. You will need these in the next step.
+Once saved, the *ClientID* and *Secret* fields will be populated. You will need these in the next step.
{% details "I have manually disabled My Home Assistant" %}
@@ -57,15 +61,15 @@ Withings will validate (with HTTP HEAD) these requirements each time you save yo
## Data updates
-The integration automatically detects if you can use webhooks. This enables the integration only to update when there is new data.
-The binary sensor for sleep will only work if the integration can establish webhooks with Withings.
+The {% term integration %} automatically detects if you can use webhooks. This enables the {% term integration %} only to update when there is new data.
+The binary sensor for sleep will only work if the {% term integration %} can establish webhooks with Withings.
## Available data
-The integration provides several entities, some of which are dynamically enabled if data is available.
+The {% term integration %} provides several entities, some of which are dynamically enabled if data is available.
For example, measurement sensors like weight only work when data has been registered in the last 14 days. So if you start using a new device, for example, to measure your temperature or you manually update a value in the app, the sensor automatically appears.
-Sleep sensors are only created if the integration can find sleep data for you within the last day.
+Sleep sensors are only created if the {% term integration %} can find sleep data for you within the last day.
Workout calendar and the workout and activity sensors show if the latest available data point is no older than 14 days.
diff --git a/source/_integrations/wiz.markdown b/source/_integrations/wiz.markdown
index 310903f511e..dcf913eb4b7 100644
--- a/source/_integrations/wiz.markdown
+++ b/source/_integrations/wiz.markdown
@@ -2,7 +2,7 @@
title: WiZ
description: Instructions on setting up WiZ within Home Assistant.
ha_category:
- - Binary Sensor
+ - Binary sensor
- Light
- Number
- Sensor
@@ -25,7 +25,7 @@ ha_platforms:
ha_integration_type: integration
---
-The WiZ integration allows you to control your WiZ lights and smart sockets.
+The **WiZ** {% term integration %} allows you to control your WiZ lights and smart sockets.
The devices are set up through your Wi-Fi network and don't need any additional bridge or gateway.
These devices have been sold under at least the following brands:
@@ -55,7 +55,7 @@ These devices have been sold under at least the following brands:
- [Trio](https://wiz.trio-lighting.com/)
- [Wofi](https://wofi-wiz.com/)
-The integration can report the state of occupancy sensors that have been linked to a device.
+The {% term integration %} can report the state of occupancy sensors that have been linked to a device.
{% include integrations/config_flow.md %}
@@ -66,7 +66,7 @@ If you have further questions, please have a look at the [WiZ Support Page](http
### Enable local connectivity
-The integration needs to communicate locally with the WiZ device. This setting **Allow local communication** can be disabled or enabled in WiZ app.
+The {% term integration %} needs to communicate locally with the WiZ device. This setting **Allow local communication** can be disabled or enabled in WiZ app.
This setting should be enabled by default.
Steps to enable:
@@ -76,7 +76,7 @@ Steps to enable:
3. Scroll down to the security settings.
4. Enable the switch **Allow local communication**.
-### Occupancy Sensors
+### Occupancy sensors
The occupancy sensors will only be added once a motion event is detected. Home Assistant can detect the sensors if they turn on at least one device when the room is occupied, and turn off at least one device when the room is not occupied. Sensors that are not linked to a device cannot be detected.
@@ -84,7 +84,7 @@ When a device is linked to an occupancy sensor, by default, the sensor will be d
Devices linked to the occupancy sensor that was last controlled manually will show an unknown at startup. The state will be known the next time the light is controlled by the sensor.
-### Power Monitoring Sensors
+### Power monitoring sensors
A power monitoring sensor is available on devices with the following hardware modules:
@@ -93,6 +93,6 @@ A power monitoring sensor is available on devices with the following hardware mo
- ESP20_SHRGB_31R
- ESP20_SHTW_31R
-### Effect Speed
+### Effect speed
-The speed of an effect can be controlled via a `number` entity. The entity will only be available when an effect has been set that allows the speed to be adjusted.
+The speed of an effect can be controlled via a `number` {% term entity %}. The {% term entity %} will only be available when an effect has been set that allows the speed to be adjusted.
diff --git a/source/_integrations/wled.markdown b/source/_integrations/wled.markdown
index 4100974eb3d..513f700efaa 100644
--- a/source/_integrations/wled.markdown
+++ b/source/_integrations/wled.markdown
@@ -38,9 +38,9 @@ newer is recommended to get the optimal experience.
## Lights
-This integration adds the WLED device as a light in Home Assistant.
+This {% term integration %} adds the WLED device as a light in Home Assistant.
Home Assistant treats every segment of the LED strip as a separate light
-entity.
+{% term entity %}.
Only native supported features of a light in Home Assistant are supported
(which includes effects).
@@ -53,33 +53,33 @@ well. The fully-featured segment control has been introduced in WLED 0.10
but has been partly around via APIs since WLED 0.8.6.
If WLED has 1 segment defined (the default), that one segment controls the whole
-LED strip. Home Assistant creates a single light entity to control the
+LED strip. Home Assistant creates a single light {% term entity %} to control the
strip.
-If WLED has 2 or more segments, each segment gets its own light entity in
-Home Assistant. Additionally, a master light entity is created. This master
-entity controls the strip power and overall brightness applied to all segments.
+If WLED has 2 or more segments, each segment gets its own light {% term entity %} in
+Home Assistant. Additionally, a master light {% term entity %} is created. This master
+{% term entity %} controls the strip power and overall brightness applied to all segments.
Additionally, select and number entities described below will be created for each segment.
-## Select Entities
+## Select entities
-This integration provides selects for the following information from WLED:
+This {% term integration %} provides selects for the following information from WLED:
- Playlist
- Preset
- Color palette (per segment, disabled by default).
-## Number Entities
+## Number entities
-This integration provides `number` entities to control the following, segment-specific settings:
+This {% term integration %} provides `number` entities to control the following, segment-specific settings:
- Intensity
- Speed
-## Sensor Entities
+## Sensor entities
-This integration provides sensors for the following information from WLED:
+This {% term integration %} provides sensors for the following information from WLED:
- Estimated current (in mA).
- Uptime (disabled by default)
@@ -92,31 +92,31 @@ This integration provides sensors for the following information from WLED:
## Switches
-The integration will create a number of switches:
+The {% term integration %} will create a number of switches:
### Nightlight
Toggles the WLED Timer.
Can be configured on the WLED itself under settings > LED Preferences > Timed light.
-### Sync Receive and Sync Send
+### Sync receive and sync send
Toggles the synchronization between multiple WLED devices.
Can be configured on the WLED itself under settings > Sync Interfaces > WLED Broadcast.
[WLED Sync documentation](https://kno.wled.ge/interfaces/udp-realtime/)
-## Firmware Updates
+## Firmware updates
-The integration has an [update entity](/integrations/update/) that provides
+The {% term integration %} has an [update entity](/integrations/update/) that provides
information on the latest available version of WLED and indicates if a
firmware update is available for installation.
The firmware update can be triggered and installed onto your WLED device
directly from Home Assistant.
-The update entity will only provide updates to stable versions, unless you are
-using a beta version of WLED. In that case, the update entity will also provide
+The update {% term entity %} will only provide updates to stable versions, unless you are
+using a beta version of WLED. In that case, the update {% term entity %} will also provide
updates to newer beta versions.
{% include integrations/option_flow.md %}
@@ -125,9 +125,10 @@ updates to newer beta versions.
Keep Master Light:
description: Keep the master light, even if there is only 1 segment. This ensures the master light is always there, in case you are automating segments to appear and remove dynamically.
{% endconfiguration_basic %}
-## Example Automations
-### Activating Random Effect
+## Example automations
+
+### Activating random effect
You can automate changing the effect using a service call like this:
@@ -143,11 +144,11 @@ data:
{% endraw %}
-### Activating Random Palette
+### Activating random palette
Activating a random palette is very similar to the above random effect,
and can be done by selecting a random one from the available palette select
-entity.
+{% term entity %}.
{% raw %}
@@ -178,7 +179,7 @@ to a preset called My Preset:
option: "My Preset"
```
-### Automation Using Specific Palette Name
+### Automation using specific palette name
An automation to turn on a WLED light and select a specific palette and
set intensity, and speed can be created by first calling the `light.turn_on`
diff --git a/source/_integrations/wolflink.markdown b/source/_integrations/wolflink.markdown
index ad33b2bb6d3..1f3c1c8ac23 100644
--- a/source/_integrations/wolflink.markdown
+++ b/source/_integrations/wolflink.markdown
@@ -14,13 +14,13 @@ ha_platforms:
ha_integration_type: integration
---
-The `wolflink` integration uses the [Wolf Smart-Set](https://www.wolf-smartset.com/) web service as a source to fetch your heating system status.
+The **Wolf SmartSet Service** {% term integration %} uses the [Wolf Smart-Set](https://www.wolf-smartset.com/) web service as a source to fetch your heating system status.
-Currently, integration can collect information such as temperature, pressure and heating state.
+Currently, {% term integration %} can collect information such as temperature, pressure and heating state.
Remember that to integrate your heating device with Home Assistant, you need to have a WOLF LinkHome device connected to your heating device.
-The integration fetches all data based on parameters, that are exposed by your heating device.
+The {% term integration %} fetches all data based on parameters, that are exposed by your heating device.
## Tested devices
diff --git a/source/_integrations/workday.markdown b/source/_integrations/workday.markdown
index 4fa91f506e0..e8efc10c510 100644
--- a/source/_integrations/workday.markdown
+++ b/source/_integrations/workday.markdown
@@ -2,7 +2,7 @@
title: Workday
description: Steps to configure the binary workday sensor.
ha_category:
- - Binary Sensor
+ - Binary sensor
- Utility
ha_iot_class: Local Polling
ha_release: 0.41
diff --git a/source/_integrations/ws66i.markdown b/source/_integrations/ws66i.markdown
index 7974e329f19..5ad20a83d8c 100644
--- a/source/_integrations/ws66i.markdown
+++ b/source/_integrations/ws66i.markdown
@@ -2,7 +2,7 @@
title: Soundavo WS66i 6-Zone Amplifier
description: Instructions on how to integrate WS66i 6-Zone Home Audio Controller into Home Assistant.
ha_category:
- - Media Player
+ - Media player
ha_release: 2022.6
ha_config_flow: true
ha_iot_class: Local Polling
@@ -15,13 +15,13 @@ ha_platforms:
ha_integration_type: integration
---
-The Soundavo WS66i 6-Zone Amplifier integration allows you to control the [Soundavo Whole-Home Audio Amplifier](https://www.soundavo.com/products/ws-66i) via the local network. This amplifier is an upgrade of the amplifier sold by [Monoprice](https://www.monoprice.com/product?p_id=10761) that adds 2 built-in wireless streamers and an Ethernet port for control over LAN.
+The **Soundavo WS66i 6-Zone Amplifier** {% term integration %} allows you to control the [Soundavo Whole-Home Audio Amplifier](https://www.soundavo.com/products/ws-66i) via the local network. This amplifier is an upgrade of the amplifier sold by [Monoprice](https://www.monoprice.com/product?p_id=10761) that adds 2 built-in wireless streamers and an Ethernet port for control over LAN.
{% include integrations/config_flow.md %}
-## Configuration Notes
+## Configuration notes
-Enter the IP Address of the WS66i amplifier when prompted to connect to the device and hit submit. It will detect the number of connected amplifiers and present each zone as an entity.
+Enter the IP address of the WS66i amplifier when prompted to connect to the device and hit submit. It will detect the number of connected amplifiers and present each zone as an {% term entity %}.
- 1 Amplifier: Zones 11..16
- 2 Amplifiers: Zones 11..16, Zones 21..26
@@ -29,6 +29,6 @@ Enter the IP Address of the WS66i amplifier when prompted to connect to the devi
Once detected, you can add them to an area.
-## Source Management
+## Source management
You can configure source names by hitting the **CONFIGURE** button in the integration card.
diff --git a/source/_integrations/wsdot.markdown b/source/_integrations/wsdot.markdown
index 3d8e80bbcb0..61810227e8e 100644
--- a/source/_integrations/wsdot.markdown
+++ b/source/_integrations/wsdot.markdown
@@ -11,7 +11,7 @@ ha_platforms:
ha_integration_type: integration
---
-The `wsdot` sensor will give you travel time information from the [Washington State Department of Transportation (WSDOT)](https://wsdot.com/).
+The **Washington State Department of Transportation (WSDOT)** {% term integration %} will give you travel time information from the [Washington State Department of Transportation (WSDOT)](https://wsdot.com/).
## Setup
diff --git a/source/_integrations/wyoming.markdown b/source/_integrations/wyoming.markdown
index 74cfc9d8e74..8ea85e82c8d 100644
--- a/source/_integrations/wyoming.markdown
+++ b/source/_integrations/wyoming.markdown
@@ -17,7 +17,7 @@ ha_platforms:
ha_config_flow: true
---
-The Wyoming integration connects external voice services to Home Assistant using a [small protocol](https://github.com/rhasspy/rhasspy3/blob/master/docs/wyoming.md). This enables [Assist](/voice_control/) to use a variety of local [speech-to-text](/integrations/stt/), [text-to-speech](/integrations/tts/), and [wake-word-detection](/integrations/wake_word/) systems, such as:
+The **Wyoming** {% term integration %} connects external voice services to Home Assistant using a [small protocol](https://github.com/rhasspy/rhasspy3/blob/master/docs/wyoming.md). This enables [Assist](/voice_control/) to use a variety of local [speech-to-text](/integrations/stt/), [text-to-speech](/integrations/tts/), and [wake-word-detection](/integrations/wake_word/) systems, such as:
- Whisper {% my supervisor_addon badge addon="core_whisper" %}
- Piper {% my supervisor_addon badge addon="core_piper" %}
diff --git a/source/_integrations/xbox.markdown b/source/_integrations/xbox.markdown
index 1ae4ed00702..efdc87dda0d 100644
--- a/source/_integrations/xbox.markdown
+++ b/source/_integrations/xbox.markdown
@@ -2,9 +2,9 @@
title: Xbox
description: Instructions on how to set up Xbox devices in Home Assistant.
ha_category:
- - Binary Sensor
- - Media Player
- - Media Source
+ - Binary sensor
+ - Media player
+ - Media source
- Remote
ha_iot_class: Cloud Polling
ha_release: 0.117
@@ -20,7 +20,7 @@ ha_platforms:
ha_integration_type: integration
---
-The Xbox integration allows you to control Xbox One (or newer) consoles from Home Assistant.
+The **Xbox** {% term integration %} allows you to control Xbox One (or newer) consoles from Home Assistant.
Home Assistant authenticates with Xbox Live through OAuth2 using the Home Assistant Cloud account linking service.
@@ -34,9 +34,9 @@ Because it uses the Home Assistant Cloud account linking service you **must** ha
-## Media Player
+## Media player
-The Xbox media player platform will create Media Player entities for each console linked to your Microsoft account. These entities will display the active app and playback controls as well as a media browser implementation, allowing you to launch any installed application.
+The Xbox media player platform will create media player entities for each console linked to your Microsoft account. These entities will display the active app and playback controls as well as a media browser implementation, allowing you to launch any installed application.
### Service `play_media`
@@ -99,7 +99,7 @@ command:
delay_sec: 0.1
```
-### Picture Elements Card
+### Picture elements card
Below is a picture elements card that can be added to a dashboard to provide an Xbox controller interface in your frontend. It utilizes the services detailed above. Replace `remote.xboxone_remote` and `media_player.xboxone` with the names of your entities and enjoy! Courtesy of [@SeanPM5](https://github.com/SeanPM5) and [@hunterjm](https://github.com/hunterjm).
@@ -241,7 +241,7 @@ elements:
overflow: hidden
```
-## Binary Sensor
+## Binary sensor
The Xbox binary sensor platform automatically keeps track of your "**Favorite** friends". In your friends list, select **Change friendship -> Favorite** to have that person automatically pulled into Home Assistant.
@@ -267,15 +267,15 @@ Just like the binary sensors, the Xbox sensor platform automatically keeps track
| `sensor.{gamertag}_account_tier` | Disabled | Shows your friend's Xbox Live account tier (Gold or Silver). |
| `sensor.{gamertag}_gold_tenure` | Disabled | Shows how long your friend has had Xbox Live Gold. |
-## Media Source
+## Media source
-The Xbox media source platform allows you to use the Media Browser panel to view both your own, and community, gameclips or screenshots for games that you have installed on any of your consoles. As with any other media source integration, you are also able to send these clips to supported media players like Chromecast.
+The Xbox media source platform allows you to use the Media Browser panel to view both your own, and community, gameclips or screenshots for games that you have installed on any of your consoles. As with any other media source {% term integration %}, you are also able to send these clips to supported media players like Chromecast.
It can take up to a couple of days for newly installed applications to appear in the media browser.
-## Manual Configuration
+## Manual configuration
These steps are not required, nor will they be supported if issues are encountered.
@@ -291,7 +291,7 @@ If you prefer not to use the Home Assistant account linking service, you may man
- On the App Page, navigate to "Certificates & secrets"
- Generate a new client secret and save for later use
-You may then add the credentials to [Application Credentials](/integrations/application_credentials/) and then setup the integration.
+You may then add the credentials to [Application Credentials](/integrations/application_credentials/) and then setup the {% term integration %}.
{% details "I have manually disabled My Home Assistant" %}
diff --git a/source/_integrations/xiaomi.markdown b/source/_integrations/xiaomi.markdown
index f47b8c49807..7737c0efdb3 100644
--- a/source/_integrations/xiaomi.markdown
+++ b/source/_integrations/xiaomi.markdown
@@ -16,7 +16,7 @@ The `Xiaomi` camera platform allows you to utilize Xiaomi Cameras within Home As
To successfully implement this platform, the Home Assistant host should be capable of multiple simultaneous reads. For every concurrent Home Assistant user, a connection will be made to the camera every 10 seconds. This should normally not be a problem.
-## Preparing the Device
+## Preparing the device
In order to integrate the camera with Home Assistant, it is necessary to install a custom firmware on the device. Instructions for doing so can be found for each models.
@@ -47,7 +47,7 @@ The live stream writing by the camera is not a supported format when the hass re
If you enabled RTSP server, you can connect to your camera via other Home Assistant camera platforms. However, this RTSP server disables the ability to use the supremely-useful Mi Home app. In order to maintain both Home Assistant compatibility _and_ the native app, this platform retrieves videos via FTP.
-## Configuring the Platform
+## Configuring the platform
To enable the platform, add the following lines to your`configuration.yaml` file:
@@ -117,7 +117,7 @@ camera:
```
## Hostname template
-The hostname/IP address can be provided either a value or from the existing entity attributes.
+The hostname/IP address can be provided either a value or from the existing {% term entity %} attributes.
```yaml
camera:
diff --git a/source/_integrations/xiaomi_aqara.markdown b/source/_integrations/xiaomi_aqara.markdown
index c32acde7777..f21ca6dbd27 100644
--- a/source/_integrations/xiaomi_aqara.markdown
+++ b/source/_integrations/xiaomi_aqara.markdown
@@ -21,11 +21,11 @@ ha_platforms:
ha_integration_type: integration
---
-The `xiaomi_aqara` integration allows you to integrate [Xiaomi](https://www.mi.com/en/) Aqara-compatible devices into Home Assistant.
+The **Xiaomi Gateway (Aqara)** {% term integration %} allows you to integrate [Xiaomi](https://www.mi.com/en/) Aqara-compatible devices into Home Assistant.
Please note, there are two versions of the hub: v1 and v2. v1 can be used with Home Assistant without any problems, however, v2 might be less straight forward when it comes to enabling the local API, and might even require you to open up your device in order to do so. Xiaomi has suggested this is in the pipeline.
-## Supported Devices
+## Supported devices
- Aqara Air Conditioning Companion (lumi.acpartner.v3)
- Aqara Intelligent Door Lock (lock.aq1)
@@ -52,7 +52,7 @@ Please note, there are two versions of the hub: v1 and v2. v1 can be used with H
- Water Leak Sensor
- Xiaomi Mijia Gateway (lumi.gateway.v2, lumi.gateway.v3)
-## Unsupported Devices
+## Unsupported devices
- Xiaomi Aqara Gateway (lumi.gateway.aqhm01), as it is not possible to activate dev mode in the Mi Home App.
- Gateway Radio
@@ -155,7 +155,7 @@ Removes a specific device. The removal is required if a device shall be paired w
## Examples
-### Long Press on Smart Button 1st Generation
+### Long press on smart button 1st generation
This example plays the sound of a dog barking when the button is held down and stops the sound when the button is pressed once. Only works for the round button of the 1st generation.
@@ -189,7 +189,7 @@ This example plays the sound of a dog barking when the button is held down and s
gw_mac: xxxxxxxxxxxx
```
-### Double Click on Smart Button
+### Double click on smart button
This example toggles the living room lamp on a double click of the button.
diff --git a/source/_integrations/xiaomi_ble.markdown b/source/_integrations/xiaomi_ble.markdown
index d3bf2c56280..a7a470ccaef 100644
--- a/source/_integrations/xiaomi_ble.markdown
+++ b/source/_integrations/xiaomi_ble.markdown
@@ -2,7 +2,7 @@
title: Xiaomi BLE
description: Instructions on how to integrate Xiaomi BLE devices into Home Assistant.
ha_category:
- - Binary Sensor
+ - Binary sensor
- Sensor
ha_bluetooth: true
ha_release: 2022.8
diff --git a/source/_integrations/xiaomi_miio.markdown b/source/_integrations/xiaomi_miio.markdown
index dbcd1b9023d..ea1b227c08d 100644
--- a/source/_integrations/xiaomi_miio.markdown
+++ b/source/_integrations/xiaomi_miio.markdown
@@ -7,7 +7,7 @@ ha_category:
- Health
- Hub
- Light
- - Presence Detection
+ - Presence detection
- Remote
- Vacuum
ha_iot_class: Local Polling
@@ -38,7 +38,7 @@ ha_platforms:
ha_integration_type: integration
---
-The Xiaomi Miio integration supports the following devices:
+The **Xiaomi Miio** {% term integration %} supports the following devices:
- [Xiaomi Gateway](#xiaomi-gateway)
- [Xiaomi device tracker (Xiaomi Mi WiFi Repeater 2)](#xiaomi-device-tracker-xiaomi-mi-wifi-repeater-2)
@@ -82,7 +82,7 @@ The most common problems are:
## Xiaomi Gateway
-The `xiaomi_miio` gateway integration allows you to control the gateway and its connected subdevices.
+The `xiaomi_miio` gateway {% term integration %} allows you to control the gateway and its connected subdevices.
### Supported Xiaomi gateway models:
@@ -96,9 +96,9 @@ The `xiaomi_miio` gateway integration allows you to control the gateway and its
| Mi AC Companion | lumi.acpartner.v2 | KTBL02LM | untested |
| Aqara AC Companion | lumi.acpartner.v3 | KTBL11LM | yes |
-Some gateways (lumi.gateway.mieu01) do not support getting the connected subdevices locally. For those gateways, cloud credentials can be specified during the config flow and the "Use cloud to get connected subdevices" can be enabled in the options flow (after setting up the integration, click Configuration in the sidebar, then click Integrations and then click Options on the already set up Xiaomi Miio Gateway integration). The connected subdevices will then be retrieved from the Xiaomi Miio cloud (internet), control and status updates of those subdevices will then further take place over local network connection. A re-authentication flow may be triggered when no cloud credentials are provided yet and are needed for that particular gateway model.
+Some gateways (lumi.gateway.mieu01) do not support getting the connected subdevices locally. For those gateways, cloud credentials can be specified during the config flow and the "Use cloud to get connected subdevices" can be enabled in the options flow (after setting up the {% term integration %}, click Configuration in the sidebar, then click Integrations and then click Options on the already set up Xiaomi Miio Gateway {% term integration %}). The connected subdevices will then be retrieved from the Xiaomi Miio cloud (internet), control and status updates of those subdevices will then further take place over local network connection. A re-authentication flow may be triggered when no cloud credentials are provided yet and are needed for that particular gateway model.
-### Gateway Features
+### Gateway features
- Gateway alarm control (Turn on/off; see status `armed_away`, `disarmed`, `arming`)
- Gateway light control (Turn on/off; change brightness; change color; see status)
@@ -1432,7 +1432,7 @@ Currently supported services are:
### Platform Services
-In addition to all of the services provided by the `vacuum` integration (`start`, `pause`, `stop`, `return_to_base`, `locate`, `set_fan_speed` and `send_command`), the `xiaomi_miio` platform introduces specific services to access the remote control mode of the robot. These are:
+In addition to all of the services provided by the `vacuum` {% term integration %} (`start`, `pause`, `stop`, `return_to_base`, `locate`, `set_fan_speed` and `send_command`), the `xiaomi_miio` platform introduces specific services to access the remote control mode of the robot. These are:
- `xiaomi_miio.vacuum_clean_zone`
- `xiaomi_miio.vacuum_clean_segment`
@@ -1688,7 +1688,7 @@ Water Shortage\*\*:
{% endconfiguration_basic %}
-* Needs to be manually enabled once the integration has been added.
+* Needs to be manually enabled once the {% term integration %} has been added.
** Only enabled if the vacuum has a mop.
diff --git a/source/_integrations/xiaomi_tv.markdown b/source/_integrations/xiaomi_tv.markdown
index 54f5e2bd581..ce5fe0c560a 100644
--- a/source/_integrations/xiaomi_tv.markdown
+++ b/source/_integrations/xiaomi_tv.markdown
@@ -2,7 +2,7 @@
title: Xiaomi TV
description: Instructions on how to integrate a Xiaomi TV into Home Assistant.
ha_category:
- - Media Player
+ - Media player
ha_release: 0.64
ha_iot_class: Assumed State
ha_codeowners:
diff --git a/source/_integrations/xmpp.markdown b/source/_integrations/xmpp.markdown
index 758afee0704..8244b3ac2f4 100644
--- a/source/_integrations/xmpp.markdown
+++ b/source/_integrations/xmpp.markdown
@@ -46,7 +46,7 @@ resource:
description: "Resource part of JID, e.g., your_name@jabber.org/`HA-cabin`."
required: false
type: string
- default: home-assistant
+ default: "`home-assistant`"
password:
description: The password for your given Jabber account.
required: true
@@ -83,7 +83,7 @@ All Jabber IDs (JID) must include the domain. Make sure that the password matche
You can send text messages and images as well as other files through Jabber.
-### Jabber Text Message
+### Jabber text message
Here are some examples on how to set up a script, that can be run from an automation.
@@ -101,7 +101,7 @@ Number 1 shows a classical, text-only message. The Title is optional, although i
message: "My funny or witty message"
```
-### Jabber Image Message
+### Jabber image message
You can send images or files from locally stored files or remote web locations via Jabber's HTTP Upload feature.
To send files and images, your jabber server must support [XEP_0363](https://xmpp.org/extensions/xep-0363.html).
@@ -145,7 +145,7 @@ Number 3 sends an image from a local path.
path: "/home/homeassistant/super_view.jpg"
```
-### Jabber File Message
+### Jabber file message
Number 4 sends a text-file, retrieved from GitHub, renamed to `Hass_Cheatsheet.txt` to be viewable on a mobile Android device, as most don't offer any application to view `.md` files. Optionally you can add a timeout for the HTTP upload in seconds.
diff --git a/source/_integrations/xs1.markdown b/source/_integrations/xs1.markdown
index 8f4c4f59a82..85d655ec848 100644
--- a/source/_integrations/xs1.markdown
+++ b/source/_integrations/xs1.markdown
@@ -16,7 +16,7 @@ ha_platforms:
ha_integration_type: integration
---
-The [EZcontrol XS1](http://www.ezcontrol.de/content/view/36/28/) integration for Home Assistant allows you to observe and control devices configured on the XS1 Gateway. Please have a look at the official documentation for using this gateway [Bedienungsanleitung v3.0.0.0](http://www.ezcontrol.de/support/downloads/XS1/xs1manual/Bedienungsanleitung_EZcontrol_XS1_3.0.0.0-2.pdf).
+The [EZcontrol XS1](http://www.ezcontrol.de/content/view/36/28/) {% term integration %} for Home Assistant allows you to observe and control devices configured on the XS1 Gateway. Please have a look at the official documentation for using this gateway [Bedienungsanleitung v3.0.0.0](http://www.ezcontrol.de/support/downloads/XS1/xs1manual/Bedienungsanleitung_EZcontrol_XS1_3.0.0.0-2.pdf).
## Configuration
@@ -28,7 +28,7 @@ xs1:
host: "192.168.2.100"
```
-The integration will automatically detect the configuration of the XS1 Gateway only **on initialization** which currently means when Home Assistant boots. When you change the configuration of the XS1 you (currently) have to restart Home Assistant to see the effects.
+The {% term integration %} will automatically detect the configuration of the XS1 Gateway only **on initialization** which currently means when Home Assistant boots. When you change the configuration of the XS1 you (currently) have to restart Home Assistant to see the effects.
{% configuration %}
host:
@@ -55,10 +55,10 @@ password:
type: string
{% endconfiguration %}
-## Supported Device Types
+## Supported device types
-This integration currently only covers part of the device types supported by the XS1 gateway, unsupported types are simply ignored.
+This {% term integration %} currently only covers part of the device types supported by the XS1 gateway, unsupported types are simply ignored.
### Sensors
@@ -77,7 +77,7 @@ If you are using climate devices the "current temp" sensor will be automatically
| `dimmer` | Partly | Dimmers are currently handled like switches so actual dimming is not supported :(|
| `temperature` | Yes | |
-### Climate Actuator/Sensor
+### Climate actuator/sensor
Home Assistant can combine temperature sensors and climate actuators into a single device. The XS1 gateway does not allow this, but a sensor and actuator can be configured separately. To make Home Assistant register them in the same climate device just prefix the **sensor** name with the actuator name on the XS1 gateway configuration, f.ex:
@@ -86,7 +86,7 @@ Home Assistant can combine temperature sensors and climate actuators into a sing
## Examples
-In this section, you find some real-life examples of how to use this integration.
+In this section, you find some real-life examples of how to use this {% term integration %}.
### Full configuration
diff --git a/source/_integrations/yale_home.markdown b/source/_integrations/yale_home.markdown
index 71a1b5ab8ce..69ea687dd91 100644
--- a/source/_integrations/yale_home.markdown
+++ b/source/_integrations/yale_home.markdown
@@ -2,7 +2,7 @@
title: Yale Home
description: Connect and control your Yale Home devices using the August integration
ha_category:
- - Binary Sensor
+ - Binary sensor
- Button
- Camera
- Doorbell
diff --git a/source/_integrations/yale_smart_alarm.markdown b/source/_integrations/yale_smart_alarm.markdown
index 1c36db8f593..6d4f401f0ff 100644
--- a/source/_integrations/yale_smart_alarm.markdown
+++ b/source/_integrations/yale_smart_alarm.markdown
@@ -3,7 +3,7 @@ title: Yale Smart Living
description: Instructions on how to integrate Yale Smart Alarms into Home Assistant.
ha_category:
- Alarm
- - Binary Sensor
+ - Binary sensor
- Button
- Lock
ha_release: 0.78
@@ -21,24 +21,24 @@ ha_platforms:
ha_integration_type: integration
---
-The Yale Smart Living integration provides connectivity with the Yale Smart Alarm systems and Smart Hub through Yale's API.
+The **Yale Smart Living** {% term integration %} provides connectivity with the Yale Smart Alarm systems and Smart Hub through Yale's API.
There is currently support for the following device types within Home Assistant:
- Alarm
-- Binary Sensor
+- Binary sensor
- Button
- Lock
{% include integrations/config_flow.md %}
-## Alarm Control Panel
+## Alarm control panel
Services provided are `armed_away`, `armed_home`, and `disarmed`.
No code is required to operate the alarm.
-## Binary Sensors
+## Binary sensors
Provides support for contact sensors for doors showing if door is open or closed.
@@ -50,4 +50,4 @@ Provides support for pressing the panic button to trigger the alarm. Be careful
The lock platform requires a code for unlocking but no code for locking.
-The integration can be configured to provide a default code that is used if no code is supplied and the number of digits required.
+The {% term integration %} can be configured to provide a default code that is used if no code is supplied and the number of digits required.
diff --git a/source/_integrations/yalexs_ble.markdown b/source/_integrations/yalexs_ble.markdown
index 0245fb2c14c..c4e1702ad36 100644
--- a/source/_integrations/yalexs_ble.markdown
+++ b/source/_integrations/yalexs_ble.markdown
@@ -2,7 +2,7 @@
title: Yale Access Bluetooth
description: Instructions on how to integrate Yale Access Bluetooth devices into Home Assistant.
ha_category:
- - Binary Sensor
+ - Binary sensor
- Lock
- Sensor
ha_bluetooth: true
@@ -23,9 +23,9 @@ Integrates [Yale Access](https://www.yalehome.com/us/en/products/smart-technolog
{% include integrations/config_flow.md %}
-The Yale Access Bluetooth integration will automatically discover devices once the [Bluetooth](/integrations/bluetooth) integration is enabled and functional.
+The **Yale Access Bluetooth** {% term integration %} will automatically discover devices once the [Bluetooth](/integrations/bluetooth) integration is enabled and functional.
-Devices must have a Yale Access module installed to function with this integration if one is not already built-in.
+Devices must have a Yale Access module installed to function with this {% term integration %} if one is not already built-in.
## Supported devices
@@ -56,17 +56,17 @@ Lock operation requires setting up an encrypted connection highly sensitive to l
## Push updates
-Some locks only send push updates when they have an active HomeKit pairing. If your lock is not sending push updates, ensure it's paired with a HomeKit using an iOS device or the HomeKit controller integration. The lock cannot be paired via HomeKit Controller and the Yale Access Bluetooth integration on the same Home Assistant instance as they will both try to access the lock simultaneously and fail.
+Some locks only send push updates when they have an active HomeKit pairing. If your lock is not sending push updates, ensure it's paired with a HomeKit using an iOS device or the HomeKit controller {% term integration %}. The lock cannot be paired via HomeKit Controller and the Yale Access Bluetooth {% term integration %} on the same Home Assistant instance as they will both try to access the lock simultaneously and fail.
One easy way to fix this is to create a new/second home in the Apple Home app and add the lock to that new home. Push updates should occur as intended after the lock is added.
-Alternatively, call the `homeassistant.update_entity` service to force the integration to update the lock state, or enable the always connected option.
+Alternatively, call the `homeassistant.update_entity` service to force the {% term integration %} to update the lock state, or enable the always connected option.
{% include integrations/option_flow.md %}
If the lock does not support push updates via advertisements or you want lock operation to be more responsive, you can enable always connected mode. Always connected will cause the lock to stay connected to Home Assistant via Bluetooth, which will use more battery.
-## Door Sensors
+## Door sensors
The lock must be calibrated in the Yale Access App for the door sensors to function correctly. If the door sensor has an unknown state or is not updating, try recalibrating the lock in the app.
@@ -76,9 +76,9 @@ The offline key and slot number are required to operate the lock. These credenti
### Yale Access, Yale Home, or August Cloud
-The [August](/integrations/august) integration can automatically provision the offline key if the configured account has the key loaded. You may need to create or use a non-primary existing account with owner-level access to the lock, as not all accounts will have the key loaded. If the lock was not discovered by Home Assistant when the cloud integration was loaded, reload the cloud integration once the lock has been discovered.
+The [August](/integrations/august) {% term integration %} can automatically provision the offline key if the configured account has the key loaded. You may need to create or use a non-primary existing account with owner-level access to the lock, as not all accounts will have the key loaded. If the lock was not discovered by Home Assistant when the cloud {% term integration %} was loaded, reload the cloud {% term integration %} once the lock has been discovered.
-If the offline key can automatically be provisioned, you will not be asked to enter it and the integration should be automatically added, configured and running.
+If the offline key can automatically be provisioned, you will not be asked to enter it and the {% term integration %} should be automatically added, configured and running.
Most Yale branded locks can use the August cloud to obtain the keys. Accessing the August cloud to receive the key may not work unless the lock was purchased in a market that sells under both brands.
diff --git a/source/_integrations/yamaha.markdown b/source/_integrations/yamaha.markdown
index a7fc7d1f0db..fd2655f9e07 100644
--- a/source/_integrations/yamaha.markdown
+++ b/source/_integrations/yamaha.markdown
@@ -2,7 +2,7 @@
title: Yamaha Network Receivers
description: Instructions on how to integrate Yamaha Network Receivers into Home Assistant.
ha_category:
- - Media Player
+ - Media player
ha_release: 0.16
ha_iot_class: Local Polling
ha_domain: yamaha
diff --git a/source/_integrations/yamaha_musiccast.markdown b/source/_integrations/yamaha_musiccast.markdown
index 4e584020741..796363c7516 100644
--- a/source/_integrations/yamaha_musiccast.markdown
+++ b/source/_integrations/yamaha_musiccast.markdown
@@ -2,7 +2,7 @@
title: MusicCast
description: Instructions on how to integrate Yamaha MusicCast Receivers into Home Assistant.
ha_category:
- - Media Player
+ - Media player
ha_release: 0.53
ha_codeowners:
- '@vigonotion'
@@ -19,7 +19,7 @@ ha_platforms:
ha_integration_type: integration
---
-The Yamaha MusicCast integration allows you to control [Yamaha MusicCast Receivers](https://usa.yamaha.com/products/audio_visual/musiccast/index.html) from Home Assistant.
+The Yamaha **MusicCast** {% term integration %} allows you to control [Yamaha MusicCast Receivers](https://usa.yamaha.com/products/audio_visual/musiccast/index.html) from Home Assistant.
Supported devices are listed on their [site](https://usa.yamaha.com/products/contents/audio_visual/musiccast/musiccast-compatiblity.html).
@@ -27,14 +27,14 @@ Supported devices are listed on their [site](https://usa.yamaha.com/products/con
## Grouping functionality
-The Yamaha MusicCast integration implements the grouping services. There are some limitations in the MusicCast system for grouping:
+The Yamaha MusicCast {% term integration %} implements the grouping services. There are some limitations in the MusicCast system for grouping:
- It is not possible to let mediaplayer entities of the same device (e.g., different zones) be in distinct groups.
- If a non-main zone is the master of a group, it is not possible to let other mediaplayers of the same device join this group.
-## Play Media functionality
+## Play media functionality
-The MusicCast integration supports the Home Assistant media browser for all streaming services, your device supports. For services such as Deezer, you have to log in using the official MusicCast app. In addition, local HTTP URLs can be played back using this service. This includes the Home Assistant text-to-speech services.
+The MusicCast {% term integration %} supports the Home Assistant media browser for all streaming services, your device supports. For services such as Deezer, you have to log in using the official MusicCast app. In addition, local HTTP URLs can be played back using this service. This includes the Home Assistant text-to-speech services.
It is also possible to recall NetUSB presets using the play media service. To do so "presets:" has to be used as `media_content_id` in the service call.
@@ -62,17 +62,17 @@ data:
media_content_type: "music"
```
-## Configuration/Diagnostic Entities
+## Configuration / diagnostic entities
Depending on the features supported by the device, several entities will be added for every MusicCast Device. Some of the entities are related to the MusicCast device and some are related to a zone of the device. All device and main zone related entities will be assigned to the Home Assistant device of the main zone. Entities related to other zones will be assigned to the Home Assistant device of the corresponding zone.
-### Number Entities
+### Number entities
The following entities will be added, if they are supported by the MusicCast device:
- Equalizer (configuration, zone level)
- - One number entity each is added for high, mid and low
+ - One number {% term entity %} each is added for high, mid and low
- Tone Control (configuration, zone level)
- - One number entity each is added for bass and treble
+ - One number {% term entity %} each is added for bass and treble
- Dialogue Level (configuration, zone level)
- Set the volume of dialogues in relation to the general volume
- Dialogue Lift (configuration, zone level)
@@ -80,7 +80,8 @@ The following entities will be added, if they are supported by the MusicCast dev
- DTS Dialogue Control (configuration, zone level)
- Control the volume of dialogues for DTS:X content
-### Select Entities
+### Select entities
+
The following entities will be added, if they are supported by the MusicCast device:
- Dimmer (configuration, device level)
- Set the display brightness
@@ -99,7 +100,8 @@ The following entities will be added, if they are supported by the MusicCast dev
- Link Audio Quality (configuration, zone level)
- Set the audio quality for grouped speakers
-### Switch Entities
+### Switch entities
+
The following entities will be added, if they are supported by the MusicCast device:
- Speaker A (configuration, device level)
- A switch to turn on the speaker set A
@@ -124,7 +126,7 @@ In this section known problems and their resolution are documented.
### Errors on handling UDP messages
-The Yamaha MusicCast integration is working with updates sent from the device to Home Assistant instead of pulling all information every few seconds. There is no error correction mechanism in these messages, so that only 100% correct messages can be processed. Whenever there is a corrupt message the Yamaha MusicCast integration will update all device information and log an error message like these:
+The Yamaha MusicCast {% term integration %} is working with updates sent from the device to Home Assistant instead of pulling all information every few seconds. There is no error correction mechanism in these messages, so that only 100% correct messages can be processed. Whenever there is a corrupt message the Yamaha MusicCast integration will update all device information and log an error message like these:
- `Received invalid message: `
- `Received non UTF-8 compliant message: b''`
diff --git a/source/_integrations/yandex_transport.markdown b/source/_integrations/yandex_transport.markdown
index 78a2ab15fc4..b5e2374b5ce 100644
--- a/source/_integrations/yandex_transport.markdown
+++ b/source/_integrations/yandex_transport.markdown
@@ -71,7 +71,7 @@ sensor:
- 677к
```
-## Options For Entities
+## Options for entities
You can configure view information about the next bus using dashboard card.
To enable displaying the relative time in your `default_view` add the following lines:
diff --git a/source/_integrations/yardian.markdown b/source/_integrations/yardian.markdown
index 7f481273e0a..fd987dff22a 100644
--- a/source/_integrations/yardian.markdown
+++ b/source/_integrations/yardian.markdown
@@ -15,7 +15,7 @@ ha_platforms:
ha_integration_type: integration
---
-The Yardian integration allows you to control your [Yardian Smart Sprinkler Controller](https://yardian.com/products/yardian-pro-smart-sprinkler-controller/).
+The **Yardian** {% term integration %} allows you to control your [Yardian Smart Sprinkler Controller](https://yardian.com/products/yardian-pro-smart-sprinkler-controller/).
There is currently support for the following platform within Home Assistant:
@@ -31,7 +31,7 @@ During the configuration, you will have to manually set the **Host** and the **A
### yardian.start_irrigation
-Start a zone for a given number of minutes. This service accepts an Yardian Zone switch entity and allows a given duration.
+Start a zone for a given number of minutes. This service accepts an Yardian Zone switch {% term entity %} and allows a given duration.
| Service Data Attribute | Optional | Description |
| ---------------------- | -------- | ----------------------------------------------------- |
diff --git a/source/_integrations/yeelight.markdown b/source/_integrations/yeelight.markdown
index b4f87e2c4f2..c434ee99fc7 100644
--- a/source/_integrations/yeelight.markdown
+++ b/source/_integrations/yeelight.markdown
@@ -22,12 +22,12 @@ ha_zeroconf: true
ha_integration_type: integration
---
-The Yeelight integration allows you to control your Yeelight Wi-Fi bulbs with Home Assistant.
+The **Yeelight** {% term integration %} allows you to control your Yeelight Wi-Fi bulbs with Home Assistant.
There is support for the following device types within Home Assistant:
- **Light** - The Yeelight platform for supporting lights.
-- **Binary Sensor** - The Yeelight platform for supporting binary sensors. Currently, only nightlight mode sensor for ceiling lights.
+- **Binary sensor** - The Yeelight platform for supporting binary sensors. Currently, only nightlight mode sensor for ceiling lights.
{% include integrations/config_flow.md %}
@@ -151,7 +151,7 @@ custom_effects:
### Music mode
-Per default, the bulb limits the number of requests per minute to 60, a limitation that can be bypassed by enabling the music mode. In music mode, the bulb is commanded to connect back to a socket provided by the integration and it tries to keep the connection open, which may not be wanted in all use-cases.
+Per default, the bulb limits the number of requests per minute to 60, a limitation that can be bypassed by enabling the music mode. In music mode, the bulb is commanded to connect back to a socket provided by the {% term integration %} and it tries to keep the connection open, which may not be wanted in all use-cases.
**Also note that bulbs in music mode will not update their state to "unavailable" if they are disconnected, which can cause delays in Home Assistant. Bulbs in music mode may also not react to commands from Home Assistant the first time if the connection is dropped. If you experience this issue, turn the light off and back on again in the frontend and everything will return to normal.**
### Initial setup
@@ -168,7 +168,7 @@ Information on how to enable "LAN Control" can be found [here](https://www.yeeli
### Supported models
-This integration is tested to work with the following models. If you have a different model and it is working, please let us know.
+This {% term integration %} is tested to work with the following models. If you have a different model and it is working, please let us know.
| Model ID | Model number | Product name |
diff --git a/source/_integrations/yi.markdown b/source/_integrations/yi.markdown
index 4fd04caf2ea..74542d108b5 100644
--- a/source/_integrations/yi.markdown
+++ b/source/_integrations/yi.markdown
@@ -22,9 +22,9 @@ The `yi` camera platform allows you to utilize [Yi Home Cameras](https://www.yit
To successfully implement this platform, the Home Assistant host should be capable of multiple simultaneous reads. For every concurrent Home Assistant user, a connection will be made to the camera every 10 seconds. This should normally not be a problem.
-## Preparing the Device
+## Preparing the device
-### Installing Alternative Firmware
+### Installing alternative firmware
In order to integrate the camera with Home Assistant, it is necessary to install a custom firmware on the device. Instructions for doing so can be found via the [yi-hack-v3 GitHub project](https://github.com/shadow-1/yi-hack-v3).
If you have a 2019/2020 version camera use [yi-hack-MStar GitHub project](https://github.com/roleoroleo/yi-hack-MStar) or [yi-hack-Allwinner GitHub project](https://github.com/roleoroleo/yi-hack-Allwinner). In this case configure the cam as ONVIF and read the wiki for further details.
@@ -53,7 +53,7 @@ Some alternative Yi firmwares enable an experimental RTSP server, which will all
-### Changing the FTP Password
+### Changing the FTP password
Once the custom firmware is installed, a password must be added to the FTP
server. To do so:
@@ -64,7 +64,7 @@ server. To do so:
4. Enter your new password twice.
5. Log out of Telnet.
-## Configuring the Platform
+## Configuring the platform
To enable the platform, add the following lines to your`configuration.yaml` file:
diff --git a/source/_integrations/yolink.markdown b/source/_integrations/yolink.markdown
index a88cda30240..23f18be8520 100644
--- a/source/_integrations/yolink.markdown
+++ b/source/_integrations/yolink.markdown
@@ -2,7 +2,7 @@
title: YoLink
description: Instructions on how to integrate YoLink Devices into Home Assistant.
ha_category:
- - Binary Sensor
+ - Binary sensor
- Climate
- Cover
- Light
diff --git a/source/_integrations/youless.markdown b/source/_integrations/youless.markdown
index 0551d51eebf..0c62c858ebd 100644
--- a/source/_integrations/youless.markdown
+++ b/source/_integrations/youless.markdown
@@ -15,9 +15,9 @@ ha_platforms:
ha_integration_type: integration
---
-The YouLess integration for Home Assistant allows you to read the meter values from sensors created by [YouLess](https://www.youless.nl/home.html).
+The **YouLess** {% term integration %} for Home Assistant allows you to read the meter values from sensors created by [YouLess](https://www.youless.nl/home.html).
-The integration is tested and verified for the following devices from YouLess:
+The {% term integration %} is tested and verified for the following devices from YouLess:
- LS110
- LS120 running PVOutput firmware
@@ -25,7 +25,7 @@ The integration is tested and verified for the following devices from YouLess:
{% include integrations/config_flow.md %}
-The integration will create sensors for you to display:
+The {% term integration %} will create sensors for you to display:
- The current power usage
- The gas meter
diff --git a/source/_integrations/youtube.markdown b/source/_integrations/youtube.markdown
index e6fa9358edc..5e6ab93aba3 100644
--- a/source/_integrations/youtube.markdown
+++ b/source/_integrations/youtube.markdown
@@ -18,14 +18,14 @@ api: YouTube Data API v3
api_link: https://console.cloud.google.com/apis/library/youtube.googleapis.com?project=home-assistant-17698
---
-The YouTube integration allows you to connect YouTube channels to Home Assistant.
+The **YouTube** {% term integration %} allows you to connect YouTube channels to Home Assistant.
For every channel you add, it will create sensors for:
- Subscriber count
- The latest uploaded video
## Prerequisites
-To be able to configure the integration, you need to have a YouTube channel.
+To be able to configure the {% term integration %}, you need to have a YouTube channel.
To learn how to create one, refer to the [YouTube documentation](https://support.google.com/youtube/answer/1646861).
You need to configure developer credentials to allow Home Assistant to access your Google Account.
diff --git a/source/_integrations/zabbix.markdown b/source/_integrations/zabbix.markdown
index 55b0ac62bbc..75e5bb10b27 100644
--- a/source/_integrations/zabbix.markdown
+++ b/source/_integrations/zabbix.markdown
@@ -3,7 +3,7 @@ title: Zabbix
description: Instructions on how to integrate Zabbix into Home Assistant.
ha_category:
- Sensor
- - System Monitor
+ - System monitor
ha_release: 0.37
ha_iot_class: Local Polling
ha_domain: zabbix
@@ -12,7 +12,7 @@ ha_platforms:
ha_integration_type: integration
---
-The `zabbix` integration is the main integration to connect to a [Zabbix](https://www.zabbix.com/) monitoring instance via the Zabbix API.
+The **Zabbix** {% term integration %} is the main {% term integration %} to connect to a [Zabbix](https://www.zabbix.com/) monitoring instance via the Zabbix API.
It is possible to publish Home Assistant state changes to Zabbix. In Zabbix a host has to be created which will contain the Home Assistant states as individual items. These items are automatically created using Zabbix Low-Level Discovery (LLD). In order to make setup in Zabbix easy, you can use this [template](/assets/integrations/zabbix/zbx_template_home_assistant.xml) for the host.
@@ -22,7 +22,7 @@ There is currently also support for the following device types within Home Assis
## Configuration
-To set the Zabbix integration up, add the following information to your `configuration.yaml` file:
+To set the Zabbix {% term integration %} up, add the following information to your `configuration.yaml` file:
```yaml
# Example configuration.yaml entry
@@ -112,7 +112,7 @@ zabbix:
- sensor.time
```
-## Configure Filter
+## Configure filter
By default, no entity will be excluded. To limit which entities are being published to Zabbix, you can use the `include` and `exclude` parameters.
diff --git a/source/_integrations/zerproc.markdown b/source/_integrations/zerproc.markdown
index 820793942e7..87c072e0b6a 100644
--- a/source/_integrations/zerproc.markdown
+++ b/source/_integrations/zerproc.markdown
@@ -14,12 +14,12 @@ ha_platforms:
ha_integration_type: integration
---
-This integration discovers nearby Zerproc lights and adds them to Home Assistant.
+This {% term integration %} discovers nearby Zerproc lights and adds them to Home Assistant.
{% include integrations/config_flow.md %}
-The integration will scan for nearby devices, and is completed if any are found. No additional configuration is required. The integration will perform a BLE scan every 60 seconds to search for new devices.
+The {% term integration %} will scan for nearby devices, and is completed if any are found. No additional configuration is required. The integration will perform a BLE scan every 60 seconds to search for new devices.
## Additional information for Home Assistant Core on Python environments
-This integration requires a working Bluetooth stack. Please refer to the [requirements of the underlying bleak library](https://bleak.readthedocs.io/en/latest/backends/index.html) for the operating system requirements.
+This {% term integration %} requires a working Bluetooth stack. Please refer to the [requirements of the underlying bleak library](https://bleak.readthedocs.io/en/latest/backends/index.html) for the operating system requirements.
diff --git a/source/_integrations/zestimate.markdown b/source/_integrations/zestimate.markdown
index 493c4ae71c6..345614f771b 100644
--- a/source/_integrations/zestimate.markdown
+++ b/source/_integrations/zestimate.markdown
@@ -43,7 +43,7 @@ zpid:
type: list
{% endconfiguration %}
-### Additional Attributes
+### Additional attributes
The following additional attributes are also available via the sensor.
diff --git a/source/_integrations/zeversolar.markdown b/source/_integrations/zeversolar.markdown
index e738e2bc642..8a8ca34b17f 100644
--- a/source/_integrations/zeversolar.markdown
+++ b/source/_integrations/zeversolar.markdown
@@ -14,9 +14,9 @@ ha_codeowners:
- '@kvanzuijlen'
---
-The Zeversolar integration uses the local device IP to get information like the current power and
+The **Zeversolar** {% term integration %} uses the local device IP to get information like the current power and
today's total energy production.
-This integration allows you to collect and save data providig a historical overview of your Zeversolar
+This {% term integration %} allows you to collect and save data providing a historical overview of your Zeversolar
production.
## Prerequisites
@@ -26,9 +26,9 @@ get the Zeversolar IP address.
{% include integrations/config_flow.md %}
-## Sensor Types
+## Sensor types
-When configured, the integration will create two sensors for each configured inverter:
+When configured, the {% term integration %} will create two sensors for each configured inverter:
- Energy today, in `kWh` (Kilowatt-hour)
- Current power, in `W` (Watts)
diff --git a/source/_integrations/zha.markdown b/source/_integrations/zha.markdown
index ccf031b34d4..ec34851e7ab 100644
--- a/source/_integrations/zha.markdown
+++ b/source/_integrations/zha.markdown
@@ -3,7 +3,7 @@ title: Zigbee Home Automation
description: Instructions on how to integrate your Zigbee Home Automation (ZHA) devices within Home Assistant.
ha_category:
- Alarm
- - Binary Sensor
+ - Binary sensor
- Button
- Climate
- Cover
@@ -45,14 +45,14 @@ ha_zeroconf: true
ha_integration_type: integration
---
-The ZHA (Zigbee Home Automation) integration allows you to connect many off-the-shelf [Zigbee based devices](https://csa-iot.org/) directly to Home Assistant, using one of the many available Zigbee coordinators.
+The ZHA (Zigbee Home Automation) {% term integration %} allows you to wirelessly connect many off-the-shelf [Zigbee-based devices](https://csa-iot.org/csa-iot_products/) directly to Home Assistant, using one of the many available Zigbee coordinators.
ZHA uses an open-source Python library implementing a hardware-independent Zigbee stack called [zigpy](https://github.com/zigpy/zigpy). All coordinators compatible with zigpy can be used with ZHA.
-There is currently support for the following device types within Home Assistant:
+This {% term integration %} currently supports the following device types within Home Assistant:
-- [Alarm Control Panel](/integrations/alarm_control_panel/)
-- [Binary Sensor](/integrations/binary_sensor/)
+- [Alarm control panel](/integrations/alarm_control_panel/)
+- [Binary sensor](/integrations/binary_sensor/)
- [Button](/integrations/button/)
- [Climate](/integrations/climate/) (beta)
- [Cover](/integrations/cover/)
@@ -65,23 +65,23 @@ There is currently support for the following device types within Home Assistant:
- [Siren](/integrations/siren/)
- [Switch](/integrations/switch/)
-There is also support for Zigbee grouping of lights, switches, and fans (i.e. support for commanding device groups as entities). At least two entities must be added to a Zigbee group in the ZHA integration before the group entity is created. As well as support for [binding and unbinding (i.e. bind a remote to a lightbulb or group)](#binding-and-unbinding).
+In addition, it has support for "Zigbee groups" that enable native on-device grouping of multiple Zigbee lights, switches, and fans that enable controlling all entities for those devices in those groups with one command. At least two entities must be added to a Zigbee group inside the ZHA {% term integration %} before a group entity is created. There is also support for native on-device Zigbee [binding and unbinding (i.e. bind a remote to a lightbulb or group)](#binding-and-unbinding).
## Introduction
-ZHA integration is a Zigbee gateway implementation that follows the standard Zigbee 3.0 specification (and earlier revisions). In Zigbee, there are three different device types: Zigbee Coordinator (ZC), Zigbee Router (ZR), and Zigbee End Device (ZED). A Zigbee network always has one (and no more) Zigbee Coordinator, however, a Zigbee network can have multiple Zigbee Routers and multiple Zigbee End Devices.
+ZHA {% term integration %} is a Zigbee gateway implementation that follows the standard Zigbee 3.0 specification (and earlier revisions). In Zigbee, there are three different device types: Zigbee Coordinator (ZC), Zigbee Router (ZR), and Zigbee End Device (ZED). A Zigbee network always has one (and no more) Zigbee Coordinator, however, a Zigbee network can have multiple Zigbee Routers and multiple Zigbee End Devices.
A Zigbee Coordinator is the central device in a Zigbee network that manages and controls the network. It acts as a physical interface for the Zigbee wireless protocol, as well as being responsible for maintaining the Zigbee network topology and ensuring secure and efficient communication between Zigbee devices. Zigbee Router devices are mains-powered and will act as Zigbee signal repeaters within the Zigbee network mesh to extend its range and improve coverage, while Zigbee End Device devices are usually battery-operated sensors that will not act as Zigbee signal repeaters.
-In the case of ZHA, the Zigbee Coordinator is a radio adapter or hardware module, that contains a microcontroller that runs the Zigbee protocol stack which the ZHA integration uses to manage and communicate with a Zigbee network and its devices.
+In the case of ZHA, the Zigbee Coordinator is a radio adapter or hardware module, that contains a microcontroller that runs the Zigbee protocol stack which the ZHA {% term integration %} uses to manage and communicate with a Zigbee network and its devices.
-Before installing the ZHA integration, you will need to buy and connect a Zigbee Coordinator radio adapter or hardware module, those usually come in the form of a USB dongle that plugs directly into the computer that is running the Home Assistant installation. The ZHA integration can work with many different "Zigbee Coordinator" adapters, however, be sure to read the respective sections below about compatible Zigbee radio adapters and hardware modules.
+Before installing the ZHA {% term integration %}, you will need to buy and connect a Zigbee Coordinator radio adapter or hardware module, those usually come in the form of a USB dongle that plugs directly into the computer that is running the Home Assistant installation. The ZHA {% term integration %} can work with many different "Zigbee Coordinator" adapters, however, be sure to read the respective sections below about compatible Zigbee radio adapters and hardware modules.
Once ZHA has been set up and the Zigbee Coordinator radio adapter or module is configured, you will be able to directly join/pair any Zigbee device to the Zigbee network; regardless of the manufacturer and brand of that Zigbee-based product. Note, that while it is generally recommended to buy Zigbee 3.0 compliant devices as those should, in theory, offer greater interoperability, be sure of the sections about which devices are supported and exception handling.
## Compatible hardware
-ZHA integration uses a hardware independent Zigbee stack implementation with modular design, which means that it can support any one of the many Zigbee coordinator radio modules/adapters available from different manufacturers, as long as that module/adapter is compatible with [zigpy](https://github.com/zigpy/zigpy).
+ZHA {% term integration %} uses a hardware independent Zigbee stack implementation with modular design, which means that it can support any one of the many Zigbee coordinator radio modules/adapters available from different manufacturers, as long as that module/adapter is compatible with [zigpy](https://github.com/zigpy/zigpy).
Note! Zigbee 3.0 support or not in zigpy, depends primarily on your Zigbee coordinator hardware and its firmware. Some Zigbee coordinator hardware supports Zigbee 3.0 but might be shipped with an older firmware which does not. In such a case you may want to upgrade the firmware manually yourself.
@@ -127,6 +127,7 @@ Some other Zigbee coordinator hardware may not support a firmware that is capabl
- [PiZiGate (ZiGate Raspberry Pi module)](https://zigate.fr/produit/pizigatev2/)
- [ZiGate-Ethernet (Ethernet gateway board for PiZiGate)](https://zigate.fr/produit/zigate-ethernet/)
- [ZiGate + WiFi Pack](https://zigate.fr/produit/zigatev2-pack-wifi/)
+
#### Warning about Wi-Fi-based Zigbee-to-Serial bridges/gateways
@@ -142,7 +143,7 @@ Connect your radio module and restart Home Assistant.
From the Home Assistant front page go to **Configuration** and then select **Integrations** from the list.
-Use the plus button in the bottom right to add a new integration called **ZHA**.
+Use the plus button in the bottom right to add a new {% term integration %} called **ZHA**.
In the popup:
@@ -150,7 +151,7 @@ In the popup:
radio is connected
- Submit
-Press `Submit` and the integration will try to detect radio type automatically. If unsuccessful, you will get
+Press `Submit` and the {% term integration %} will try to detect radio type automatically. If unsuccessful, you will get
a new pop-up asking for a radio type. In the pop-up:
- Radio Type
@@ -179,7 +180,7 @@ A list of available device paths can be found in {% my hardware title="Settings
Press `Submit`. The success dialog will appear or an error will be displayed in the popup. An error is likely if Home Assistant can't access the USB device or your device is not up to date. Refer to [Troubleshooting](#troubleshooting) below for more information.
-### ZiGate or Sonoff ZBBridge Devices
+### ZiGate or Sonoff ZBBridge devices
If you are use ZiGate or Sonoff ZBBridge you have to use some special usb_path configuration:
@@ -234,11 +235,11 @@ custom_quirks_path:
### OTA firmware updates
-The ZHA integration has the ability to automatically download and perform OTA (Over-The-Air) firmware updates of Zigbee devices if the OTA firmware provider source URL for updates is available. OTA firmware updating is set to disabled (`false`) in the configuration by default.
+The ZHA {% term integration %} has the ability to automatically download and perform OTA (Over-The-Air) firmware updates of Zigbee devices if the OTA firmware provider source URL for updates is available. OTA firmware updating is set to disabled (`false`) in the configuration by default.
Online OTA providers for firmware updates are currently only available for IKEA, LEDVANCE/OSRAM, SALUS/Computime, and INOVELLI devices. Support for OTA updates from other manufacturers could be supported in the future if they publish their firmware images publicly.
-To enable OTA firmware updates for the ZHA integration you need to add the following configuration to your `configuration.yaml` and restart Home Assistant:
+To enable OTA firmware updates for the ZHA {% term integration %} you need to add the following configuration to your `configuration.yaml` and restart Home Assistant:
```yaml
zha:
@@ -390,7 +391,7 @@ Tip! It is highly recommended that you read through the two segments under the t
**To add a new Zigbee device:**
1. Go to {% my integrations title="**Settings** > **Devices & Services**" %}.
-2. Select the **Zigbee Home Automation** integration. Then, select **Configure**.
+2. Select the **Zigbee Home Automation** {% term integration %}. Then, select **Configure**.
3. To start a scan for new devices, on the bottom right corner of the screen, select **Add device**.
4. Reset your Zigbee devices to factory default settings according to the device instructions provided by the manufacturer (e.g., turn on/off lights up to 10 times; switches usually have a reset button/pin). It might take a few seconds for the devices to appear. You can click on **Show logs** for more verbose output.
5. Once the device is found, it will appear on that page and will be automatically added to your devices. You can optionally change its name and add it to an area (you can change this later). You can search again to add another device, or you can go back to the list of added devices.
@@ -403,7 +404,7 @@ Because Zigbee should use a [wireless mesh network](https://en.wikipedia.org/wik
All Zigbee coordinator firmware will only allow you to directly connect a certain amount of devices. That limit is set for two reasons; firstly, to not overload the Zigbee coordinator, and secondly, to encourage your Zigbee network to quickly begin to utilize a "[mesh networking](https://en.wikipedia.org/wiki/Mesh_networking)" topology instead of only a "[star network](https://en.wikipedia.org/wiki/Star_network)" topology.
-The total number of Zigbee devices that you can have on a Zigbee network depends on a few things. The Zigbee coordinator hardware and its firmware only play a larger role in Zigbee networks with a lot of devices. More important is the number of directly connected devices ("direct children") versus the number of routers that are connected to your Zigbee coordinator. The Zigpy library, which the ZHA integration depends on, has an upper limit that is 32 direct children, but you can still have hundreds of Zigbee devices in total connected indirectly through routes via Zigbee router devices.
+The total number of Zigbee devices that you can have on a Zigbee network depends on a few things. The Zigbee coordinator hardware and its firmware only play a larger role in Zigbee networks with a lot of devices. More important is the number of directly connected devices ("direct children") versus the number of routers that are connected to your Zigbee coordinator. The Zigpy library, which the ZHA {% term integration %} depends on, has an upper limit that is 32 direct children, but you can still have hundreds of Zigbee devices in total connected indirectly through routes via Zigbee router devices.
In this theoretical example, a CC2652-based Zigbee coordinator has three CC2530 Zigbee router devices for a total limit of 77 devices:
@@ -428,7 +429,7 @@ Binding a remote directly to a bulb or group has the benefit of faster response
## Zigbee backup and restore in ZHA
-Zigbee Home Automation (ZHA) integration now features Zigbee network backup, restore/recovery, and migrating between Zigbee coordinators. Backups are taken automatically however, a single backup to a file for easy download can also be manually created from the configuration page under Network Settings.
+Zigbee Home Automation (ZHA) {% term integration %} now features Zigbee network backup, restore/recovery, and migrating between Zigbee coordinators. Backups are taken automatically however, a single backup to a file for easy download can also be manually created from the configuration page under Network Settings.
After restoring a Home Assistant backup, you can re-configure ZHA and migrate to a new Zigbee Coordinator adapter without any loss of your settings or devices that were connected. This is helpful if your current radio fails or a new radio adapter type and model comes out that you may want to migrate to.
@@ -440,13 +441,13 @@ Follow this guide if you have a Zigbee Home Assistant (ZHA) network running and
### Prerequisites
-- Your old Zigbee Coordinator radio adapter is used in the ZHA integration (not in deCONZ or MQTT).
+- Your old Zigbee Coordinator radio adapter is used in the ZHA {% term integration %} (not in deCONZ or MQTT).
- It is of radio type ezsp (Silicon Labs EmberZnet), znp (Texas Instruments Z-Stack ZNP), or deCONZ (ConBee/RaspBee from dresden elektronik).
- If your old Zigbee coordinator is a deCONZ (ConBee/RaspBee) radio adapter, make sure it is running [firmware 0x26700700 (from 2021-08-18)](https://github.com/dresden-elektronik/deconz-rest-plugin/wiki/Firmware-Changelog) or later.
### To migrate to a new Zigbee coordinator radio inside ZHA
-1. Go to **{% my integrations title="Settings > Devices & Services" %}** and select the ZHA integration. Then select **Configure**.
+1. Go to **{% my integrations title="Settings > Devices & Services" %}** and select the ZHA {% term integration %}. Then select **Configure**.
2. Under **Network settings**, select **Migrate radio**.
3. Reconfiguration of ZHA will start. Select **Submit**.
4. Under **Migrate or re-configure**, select **Migrate to a new radio**.
@@ -488,11 +489,10 @@ ZHA does not currently support devices that can only use the ZSE ("Zigbee Smart
### Knowing which devices are supported
-Home Assistant's ZHA integration supports all standard Zigbee device types. It should be compatible with most Zigbee devices as long as they fully conform to the official ZCL (Zigbee Cluster Library) specifications defined by the [CSA (Connectivity Standards Alliance, formerly the Zigbee Alliance)](https://csa-iot.org/all-solutions/zigbee/). There is therefore no official compatibility list of devices that will work out-of-the-box with the ZHA integration.
+Home Assistant's ZHA {% term integration %} supports all standard Zigbee device types. It should be compatible with most Zigbee devices as long as they fully conform to the official ZCL (Zigbee Cluster Library) specifications defined by the [CSA (Connectivity Standards Alliance, formerly the Zigbee Alliance)](https://csa-iot.org/all-solutions/zigbee/). There is therefore no official compatibility list of devices that will work out-of-the-box with the ZHA {% term integration %}
+Not all hardware manufacturers always fully comply with the standard specifications. Sometimes, they may also implement unique features. For this reason, some Zigbee devices pair/join fine with ZHA but then only show none or only a few entities in the {% term integration %}. Developers can work around most such interoperability issues by adding conversion/translation code in custom device handlers. For more information, refer to the section below on _How to add support for new and unsupported devices_.
-Not all hardware manufacturers always fully comply with the standard specifications. Sometimes, they may also implement unique features. For this reason, some Zigbee devices pair/join fine with ZHA but then only show none or only a few entities in the integration. Developers can work around most such interoperability issues by adding conversion/translation code in custom device handlers. For more information, refer to the section below on _How to add support for new and unsupported devices_.
-
-For clarification, normally only devices that do not fully conform to CSA's ZCL specifications that will not present all standard attributes as entities for configuration in the ZHA integration. Zigbee devices that only use the standard clusters and attributes that are Zigbee specifications set by the Connectivity Standards Alliance should not need custom device handlers.
+For clarification, normally only devices that do not fully conform to CSA's ZCL specifications that will not present all standard attributes as entities for configuration in the ZHA {% term integration %}. Zigbee devices that only use the standard clusters and attributes that are Zigbee specifications set by the Connectivity Standards Alliance should not need custom device handlers.
Before continuing with this section: If a device does not join/pair at all, read the troubleshooting sections about how to avoid pairing/connection difficulties, interference avoidance, and network range/coverage optimization.
@@ -500,12 +500,12 @@ Tip to new Zigbee users: Checkout [blakadder's unofficial Zigbee Device Compatib
### How to add support for new and unsupported devices
-If your Zigbee device pairs/joins successfully with the ZHA integration but does not show all of the expected entities:
+If your Zigbee device pairs/joins successfully with the ZHA {% term integration %} but does not show all of the expected entities:
1. Try to re-pair/re-join the device several times.
2. Checkout the troubleshooting section.
3. Still not working? You may need a custom device handler. This handler will have exception handling code to work around device-specific issues.
-For devices that do not follow the standard defined in the CSA's ZCL (Zigbee Cluster Library), the ZHA integration relies on a project called "[ZHA Device Handlers (also known as "zha-quirk")](https://github.com/zigpy/zha-device-handlers)". It contains device-specific Python scripts called "quirks". These scripts can resolve compliance and interoperability issues by implementing on-the-fly conversion of custom Zigbee configurations or by implementing manufacturer-specific features for specific devices.
+For devices that do not follow the standard defined in the CSA's ZCL (Zigbee Cluster Library), the ZHA {% term integration %} relies on a project called "[ZHA Device Handlers (also known as "zha-quirk")](https://github.com/zigpy/zha-device-handlers)". It contains device-specific Python scripts called "quirks". These scripts can resolve compliance and interoperability issues by implementing on-the-fly conversion of custom Zigbee configurations or by implementing manufacturer-specific features for specific devices.
People familiar with other Zigbee gateway solutions for home automation may know similar concepts of using custom Zigbee device handlers/converters for non-standard devices. For example, [Zigbee2MQTT (and IoBroker) uses zigbee-herdsman converters](https://www.zigbee2mqtt.io/advanced/support-new-devices/01_support_new_devices.html) and [SmartThings Classics (Legacy) platform has Hub Connected Device Handlers](https://developer.smartthings.com/docs/devices/hub-connected/legacy).
@@ -618,7 +618,7 @@ When reporting issues, please provide the following information in addition to i
### Debug logging
-To enable debug logging for the ZHA integration and radio libraries, add the following [logger](/integrations/logger/) configuration to `configuration.yaml`:
+To enable debug logging for the ZHA {% term integration %} and radio libraries, add the following [logger](/integrations/logger/) configuration to `configuration.yaml`:
```yaml
logger:
@@ -642,7 +642,9 @@ logger:
Philips Hue bulbs/lights that have previously been paired/added to another bridge/gateway will not show up during search in ZHA to pair/add a Zigbee device. That is because you have to first manually restore your bulbs/lights back to their factory default settings first, and just removing them from your old bridge/gateway is not enough to do so. Instead to achieve a proper device factory reset you can use one of these methods below.
-Using a Philips Hue Dimmer Switch or Lutron Connected Bulb Remote is probably the easiest way to factory-reset your bulbs. For this to work, the remote does not have to be paired with your previous bridge. Also, make sure there are no other Hue bulbs nearby that have just been turned on when using this method as you otherwise risk resetting them too.
+You can use a Philips Hue Dimmer Switch or Lutron Connected Bulb Remote to factory-reset your bulbs. For this to work, the remote does not have to be paired with your previous bridge. Also, make sure there are no other Hue bulbs nearby that have just been turned on when using this method. Otherwise, you risk resetting them too.
+
+Newer Philips Hue bulbs you can reset via Bluetooth. The official Android app can connect to one of these bulbs even if it is already paired to a bridge. Then, you can reset the bulb in the app.
#### Philips Hue Dimmer Switch
diff --git a/source/_integrations/ziggo_mediabox_xl.markdown b/source/_integrations/ziggo_mediabox_xl.markdown
index 01f40ffd61d..a7285bdf6cf 100644
--- a/source/_integrations/ziggo_mediabox_xl.markdown
+++ b/source/_integrations/ziggo_mediabox_xl.markdown
@@ -2,7 +2,7 @@
title: Ziggo Mediabox XL
description: Instructions on how to integrate the Ziggo Mediabox XL into Home Assistant.
ha_category:
- - Media Player
+ - Media player
ha_iot_class: Local Polling
ha_release: '0.60'
ha_domain: ziggo_mediabox_xl
@@ -11,7 +11,7 @@ ha_platforms:
ha_integration_type: integration
---
-The `ziggo_mediabox_xl` integration allows you to control a [Ziggo](https://www.ziggo.nl/) Mediabox XL from Home Assistant.
+The **Ziggo Mediabox XL** {% term integration %} allows you to control a [Ziggo](https://www.ziggo.nl/) Mediabox XL from Home Assistant.
To add a Ziggo Mediabox XL to your installation, add the following to your `configuration.yaml` file:
@@ -38,4 +38,4 @@ The channel information (numbers and names) are downloaded from ziggo.nl on star
#### Preparation of the Mediabox
-Makes sure to enable the Home Network ("mijn thuisnetwerk") service in the settings menu of the media box. Once you have set up the Media Library ("mediabiblotheek"), we can determine whether the device is turned on or off. Without this, the integration will fail to start.
+Makes sure to enable the Home Network ("mijn thuisnetwerk") service in the settings menu of the media box. Once you have set up the Media Library ("mediabiblotheek"), we can determine whether the device is turned on or off. Without this, the {% term integration %} will fail to start.
diff --git a/source/_integrations/zodiac.markdown b/source/_integrations/zodiac.markdown
index b5c3ae6a3b6..f4d25ab7edd 100644
--- a/source/_integrations/zodiac.markdown
+++ b/source/_integrations/zodiac.markdown
@@ -15,7 +15,7 @@ ha_integration_type: integration
ha_config_flow: true
---
-The Zodiac integration tracks the current zodiac sign.
+The **Zodiac** {% term integration %} tracks the current zodiac sign.
{% include integrations/config_flow.md %}
diff --git a/source/_integrations/zone.markdown b/source/_integrations/zone.markdown
index 99edea158ee..10e7575af73 100644
--- a/source/_integrations/zone.markdown
+++ b/source/_integrations/zone.markdown
@@ -3,7 +3,7 @@ title: Zone
description: Instructions on how to set up zones within Home Assistant.
ha_category:
- Organization
- - Presence Detection
+ - Presence detection
ha_release: 0.69
ha_quality_scale: internal
ha_codeowners:
diff --git a/source/_integrations/zoneminder.markdown b/source/_integrations/zoneminder.markdown
index a9d2309723b..79f3debcd5a 100644
--- a/source/_integrations/zoneminder.markdown
+++ b/source/_integrations/zoneminder.markdown
@@ -2,7 +2,7 @@
title: ZoneMinder
description: How to integrate ZoneMinder into Home Assistant.
ha_category:
- - Binary Sensor
+ - Binary sensor
- Camera
- Hub
- Sensor
@@ -24,7 +24,7 @@ The `zoneminder` integration sets up Home Assistant with your [ZoneMinder](https
There is currently support for the following device types within Home Assistant:
-- [Binary Sensor](#binary-sensor)
+- [Binary sensor](#binary-sensor)
- [Camera](#camera)
- [Sensor](#sensor)
- [Switch](#switch)
@@ -105,7 +105,7 @@ action:
name: Home
```
-## Binary Sensor
+## Binary sensor
The `zoneminder` binary sensor platform lets you monitor the availability of your [ZoneMinder](https://www.zoneminder.com) install.
diff --git a/source/_integrations/zwave_js.markdown b/source/_integrations/zwave_js.markdown
index e3b9c1dc03d..5adf9da8776 100644
--- a/source/_integrations/zwave_js.markdown
+++ b/source/_integrations/zwave_js.markdown
@@ -3,7 +3,7 @@ title: Z-Wave
description: Instructions on how to integrate Z-Wave with Home Assistant via Z-Wave JS.
featured: true
ha_category:
- - Binary Sensor
+ - Binary sensor
- Button
- Climate
- Cover
diff --git a/source/_integrations/zwave_me.markdown b/source/_integrations/zwave_me.markdown
index fc6d958ec15..66f9d3e3495 100644
--- a/source/_integrations/zwave_me.markdown
+++ b/source/_integrations/zwave_me.markdown
@@ -2,7 +2,7 @@
title: Z-Wave.Me
description: Instructions on how to integrate Z-Wave with Home Assistant via Z-Wave.Me Z-Way.
ha_category:
- - Binary Sensor
+ - Binary sensor
- Button
- Climate
- Cover
diff --git a/source/_layouts/landingpage.html b/source/_layouts/landingpage.html
index abcb83c9cb8..eed40b67172 100644
--- a/source/_layouts/landingpage.html
+++ b/source/_layouts/landingpage.html
@@ -48,7 +48,7 @@ layout: page
-
+
{{entry.title}}
{{entry.description}}
{% if entry.read_more %}
diff --git a/source/_posts/2015-10-26-firetv-and-radiotherm-now-supported.markdown b/source/_posts/2015-10-26-firetv-and-radiotherm-now-supported.markdown
index fdf28128f95..c8ab182aac0 100644
--- a/source/_posts/2015-10-26-firetv-and-radiotherm-now-supported.markdown
+++ b/source/_posts/2015-10-26-firetv-and-radiotherm-now-supported.markdown
@@ -35,7 +35,7 @@ After two weeks of hard work I'm proud to announce the release of Home Assistant
-#### Breaking changes
+#### Backward-incompatible changes
As part of this release we did some cleanup which introduced backwards incompatible changes:
diff --git a/source/_posts/2015-11-16-zwave-switches-lights-and-honeywell-thermostats-now-supported.markdown b/source/_posts/2015-11-16-zwave-switches-lights-and-honeywell-thermostats-now-supported.markdown
index 31b87fe756a..cbf656b7e81 100644
--- a/source/_posts/2015-11-16-zwave-switches-lights-and-honeywell-thermostats-now-supported.markdown
+++ b/source/_posts/2015-11-16-zwave-switches-lights-and-honeywell-thermostats-now-supported.markdown
@@ -19,7 +19,7 @@ homeassistant:
icon: "mdi:air-conditioner"
```
-#### Breaking changes
+#### Backward-incompatible changes
- Any existing zone icon will have to be replaced with one from [Material Design Icons].
- LimitlessLED light services require colors to be specified in RGB instead of XY.
diff --git a/source/_posts/2015-12-20-amazon-echo-icloud-and-templates.markdown b/source/_posts/2015-12-20-amazon-echo-icloud-and-templates.markdown
index 894568c0b82..17d2888f831 100644
--- a/source/_posts/2015-12-20-amazon-echo-icloud-and-templates.markdown
+++ b/source/_posts/2015-12-20-amazon-echo-icloud-and-templates.markdown
@@ -71,7 +71,7 @@ The temperature at home is {{ states('sensor.temperature') }}.
More information and examples can be found in the [template documentation][Template].
-### Breaking changes
+### Backward-incompatible changes
Templates will now be the only way to extract data from 'raw' sources like REST, CommandSensor or MQTT. This will replace any specific option that used to do this before. This means that `precision`, `factor`, `attribute` or `json_path` etc will no longer work.
diff --git a/source/_posts/2016-03-12-z-wave-pep257-templated-service-calls.markdown b/source/_posts/2016-03-12-z-wave-pep257-templated-service-calls.markdown
index 29e77e54a18..b27fddc7d27 100644
--- a/source/_posts/2016-03-12-z-wave-pep257-templated-service-calls.markdown
+++ b/source/_posts/2016-03-12-z-wave-pep257-templated-service-calls.markdown
@@ -49,7 +49,7 @@ automation:
{% endraw %}
-### Breaking Changes
+### Backward-incompatible changes
- Media Player: Attributes to call service play_media has been renamed to
`media_content_type` and `media_content_id`, to match the corresponding media
diff --git a/source/_posts/2016-03-26-embedded-mqtt-broker-uber-yamaha-growl.markdown b/source/_posts/2016-03-26-embedded-mqtt-broker-uber-yamaha-growl.markdown
index 56a14e10d3e..8835c966c9f 100644
--- a/source/_posts/2016-03-26-embedded-mqtt-broker-uber-yamaha-growl.markdown
+++ b/source/_posts/2016-03-26-embedded-mqtt-broker-uber-yamaha-growl.markdown
@@ -12,7 +12,7 @@ categories:
Party people, 0.16 is here! The big thing with this release is that we have completely removed the barrier to get started by MQTT by being able to launch an embedded MQTT server: [hbMQTT]. Just add `mqtt:` to your config and a broker is launched and connected with Home Assistant.
-Further in this release a bunch of cool new stuff, bug fixes and rewrites for the Vera and Tellstick component (see breaking changes section at bottom for this!).
+Further in this release a bunch of cool new stuff, bug fixes and rewrites for the Vera and Tellstick component (see backward-incompatible changes section at bottom for this!).
Rock on.
@@ -65,7 +65,7 @@ Rock on.
[Z-Wave]: /integrations/zwave/#services
[Yamaha receivers]: /integrations/yamaha
-### Breaking changes
+### Backward-incompatible changes
- Automation: support for old deprecated config has been removed
- Tellstick configuration has changed
diff --git a/source/_posts/2016-04-09-onkyo-panasonic-gtfs-and-config-validation.markdown b/source/_posts/2016-04-09-onkyo-panasonic-gtfs-and-config-validation.markdown
index d2e8266285e..f72c3c43995 100644
--- a/source/_posts/2016-04-09-onkyo-panasonic-gtfs-and-config-validation.markdown
+++ b/source/_posts/2016-04-09-onkyo-panasonic-gtfs-and-config-validation.markdown
@@ -51,6 +51,6 @@ Another big thing is the addition of GTFS support. You probably don't know it, b
[Raspberry PI]: /integrations/rpi_camera
[Z-Wave]: /integrations/zwave/#climate
-### Breaking changes
+### Backward-incompatible changes
-As of now we are not aware of any breaking changes. However, it might be that Home Assistant will not start for you because of an invalid configuration. A common mistake that people are making is that they are still referring to `execute_service` in their script configs. This should be `service`.
+As of now we are not aware of any backward-incompatible changes. However, it might be that Home Assistant will not start for you because of an invalid configuration. A common mistake that people are making is that they are still referring to `execute_service` in their script configs. This should be `service`.
diff --git a/source/_posts/2016-04-21-bluetooth-lg-webos-tvs-and-roombas.markdown b/source/_posts/2016-04-21-bluetooth-lg-webos-tvs-and-roombas.markdown
index 87af021138a..e38f8152536 100644
--- a/source/_posts/2016-04-21-bluetooth-lg-webos-tvs-and-roombas.markdown
+++ b/source/_posts/2016-04-21-bluetooth-lg-webos-tvs-and-roombas.markdown
@@ -13,7 +13,7 @@ og_image: /images/blog/2016-04-release-18/social.png
It's time for 0.18. This release cycle is 2 days shorter than usual as I'll be traveling to Europe. This also means that it can take some more time before you get feedback on PRs.
-Since the last release we have moved all Home Assistant source code etc into its own [organization on GitHub](https://github.com/home-assistant). We're growing up! This sadly did cause us to have to move all Docker images. Check the breaking changes section for more info.
+Since the last release we have moved all Home Assistant source code etc into its own [organization on GitHub](https://github.com/home-assistant). We're growing up! This sadly did cause us to have to move all Docker images. Check the backward-incompatible changes section for more info.
@@ -76,7 +76,7 @@ Since the last release we have moved all Home Assistant source code etc into its
[Wink]: /integrations/wink#light
[Zeroconf]: /integrations/zeroconf/
-### Breaking changes
+### Backward-incompatible changes
- We have migrated our datetime format to be iso8601. This will only impact you if you are consuming the date times from the API directly. You can ignore this if you are just using Home Assistant via configuration and the frontend.
- The constant `TEMP_CELCIUS` is now correctly called `TEMP_CELSIUS`. Old one is deprecated and will eventually be removed.
- The location of the Docker image has changed. There was no possibility for us to keep maintaining the old image (as it was bound to the GitHub repo under my name) or to make a redirect. So if you are using the Home Assistant Docker image, change it to run `homeassistant/home-assistant:latest` for the latest release and `homeassistant/home-assistant:dev` for the latest dev version.
diff --git a/source/_posts/2016-05-21-release-020.markdown b/source/_posts/2016-05-21-release-020.markdown
index 4c02157bf94..e93fdc16a55 100644
--- a/source/_posts/2016-05-21-release-020.markdown
+++ b/source/_posts/2016-05-21-release-020.markdown
@@ -37,7 +37,7 @@ Tons of new supported things in 0.20.
- Export to [Logentries] support added ([@omgapuppy])
- Group more info dialog allows control of group domain if available (@fignuts)
-### Breaking changes
+### Backward-incompatible changes
- Asus WRT will now default to SSH with Telnet being an option
diff --git a/source/_posts/2016-06-08-super-fast-web-enocean-lirc.markdown b/source/_posts/2016-06-08-super-fast-web-enocean-lirc.markdown
index ea4314df5d3..07760cc74b6 100644
--- a/source/_posts/2016-06-08-super-fast-web-enocean-lirc.markdown
+++ b/source/_posts/2016-06-08-super-fast-web-enocean-lirc.markdown
@@ -37,7 +37,7 @@ Alright, time for the changes:
- Sensor: [DTE Energy Bridge] now supported ([@kylehendricks])
- Media Player: [Kodi] now supports different turn off commands ([@armills])
-### Breaking Changes
+### Backward-incompatible changes
- Our work in the WSGI stack is not fully done yet. We still have a minor issues where retrieving the error log in the about screen can raise an encoding error
- The API used to incorrectly accept a JSON body with form-url-encoded headers. Our cURL examples on the website used to be wrong and have [been updated].
diff --git a/source/_posts/2016-07-01-envisalink-homematic-hdmi-cec-and-sony-bravia-tv.markdown b/source/_posts/2016-07-01-envisalink-homematic-hdmi-cec-and-sony-bravia-tv.markdown
index fc78c91175f..82265807377 100644
--- a/source/_posts/2016-07-01-envisalink-homematic-hdmi-cec-and-sony-bravia-tv.markdown
+++ b/source/_posts/2016-07-01-envisalink-homematic-hdmi-cec-and-sony-bravia-tv.markdown
@@ -44,7 +44,7 @@ On the config side, you can now [store your passwords][secrets] in your OS keyri
- Lock: [Vera] now supported ([@rhooper])
- HTTP: Migrate to CherryPy WSGI server to fix install and runtime problems ([@balloob])
-### Breaking changes
+### Backward-incompatible changes
- Homematic thermostat configuration has changed and now depends on the new [Homematic] component.
diff --git a/source/_posts/2016-07-16-sqlalchemy-knx-join-simplisafe.markdown b/source/_posts/2016-07-16-sqlalchemy-knx-join-simplisafe.markdown
index 2a6eaf58e59..e8afd729c63 100644
--- a/source/_posts/2016-07-16-sqlalchemy-knx-join-simplisafe.markdown
+++ b/source/_posts/2016-07-16-sqlalchemy-knx-join-simplisafe.markdown
@@ -51,7 +51,7 @@ You can omit the `--config` option if you use the default configuration director
Quick hot fix after we found a bug in the migrator where it wouldn't work with a database in a non-standard location. Thanks to [@n8henrie] and [@AlucardZero].
-### Breaking changes
+### Backward-incompatible changes
- Migrating existing databases (see above).
- The [APCUPSd Sensor][apcupsd-sensor] was updated. This will need that you modify your `configuration.yaml` file.
diff --git a/source/_posts/2016-07-30-custom-frontend-panels--jupyter-notebooks--directv.markdown b/source/_posts/2016-07-30-custom-frontend-panels--jupyter-notebooks--directv.markdown
index 682a060920e..3f06ef46985 100644
--- a/source/_posts/2016-07-30-custom-frontend-panels--jupyter-notebooks--directv.markdown
+++ b/source/_posts/2016-07-30-custom-frontend-panels--jupyter-notebooks--directv.markdown
@@ -68,7 +68,7 @@ I would like to do a shoutout to [@fabianhjr]. He has started adding [typing] da
- Hotfix to make sure Z-Wave locks work again. Thanks to @tobiebooth for the quick fix.
-### Breaking changes
+### Backward-incompatible changes
- Google Voice SMS notification support was removed.
diff --git a/source/_posts/2016-08-13-foursquare-fast-com-ffmpeg-gpsd.markdown b/source/_posts/2016-08-13-foursquare-fast-com-ffmpeg-gpsd.markdown
index d611d24a84c..4043c3b2c8a 100644
--- a/source/_posts/2016-08-13-foursquare-fast-com-ffmpeg-gpsd.markdown
+++ b/source/_posts/2016-08-13-foursquare-fast-com-ffmpeg-gpsd.markdown
@@ -58,7 +58,7 @@ This release includes code contributed by 31 different people. The biggest chang
- Media Player cover art would not work when an API password was set. Thanks to [@maddox] for reporting it and [@balloob] for the fix.
-### Breaking changes
+### Backward-incompatible changes
- A new unit system has superseded the temperature unit option in the core configuration. For now it is backwards compatible, but you should update soon:
diff --git a/source/_posts/2016-08-27-notifications-hue-fake-unification.markdown b/source/_posts/2016-08-27-notifications-hue-fake-unification.markdown
index 05d7dd5cc0a..b4c2667ec4e 100644
--- a/source/_posts/2016-08-27-notifications-hue-fake-unification.markdown
+++ b/source/_posts/2016-08-27-notifications-hue-fake-unification.markdown
@@ -46,7 +46,7 @@ Now that we have that great news out of the way, onto this week's release which
## 0.27
-While this release is **#Amazing**, we had to break a few eggs (now you understand the title reference!) to make a beautiful omelette (using home automation obviously) so some platforms and components have needed to introduce breaking changes. Please make sure to read the [Breaking Changes](#breaking-changes) section below.
+While this release is **#Amazing**, we had to break a few eggs (now you understand the title reference!) to make a beautiful omelette (using home automation obviously) so some platforms and components have needed to introduce backward-incompatible changes. Please make sure to read the [Backward-incompatible changes](#backward-incompatible-changes) section below.
### Hue Bridge Emulation
@@ -137,7 +137,7 @@ Along with the new `climate` component, [@Teagan42] and I ([@robbiet480]) decide
- Allow emulating a [Hue] bridge to control entities ([@mgbowen])
- New [Fan][fan] component ([@Teagan42], [@robbiet480])
-### Breaking changes
+### Backward-incompatible changes
- Ecobee3 occupancy sensors have moved from sensor platform to binary sensor platform.
- Forecast.io entity IDs are now like `sensor.forecastio_temperature`. Previously they were like `sensor.weather_temperature`. Apologies for this change, but we needed to make Forecast.io more generic now that we have many weather platforms.
- The [Loop Energy][Loop] sensor configuration format changed slightly, please reformat based on the revised documentation.
diff --git a/source/_posts/2016-09-10-notify-group-reload-api-pihole.markdown b/source/_posts/2016-09-10-notify-group-reload-api-pihole.markdown
index 636c0aefd8b..2f9a10a816d 100644
--- a/source/_posts/2016-09-10-notify-group-reload-api-pihole.markdown
+++ b/source/_posts/2016-09-10-notify-group-reload-api-pihole.markdown
@@ -30,7 +30,7 @@ There are countless bugfixes included in this release which will make your exper
The [Home Assistant API Documentation](https://dev-docs.home-assistant.io/en/dev/) is a great addition to the already existing user documentation. The focus is not end-users but developers who want to get details about the code without actually browsing the code on Github.
### Configuration validation
-The validation of the configuration is still on-going. Approximately 80 % is done. This means that we will propably talk about this topic in the next release notes again. To align the configuration of components and platforms we needed to break some. Please refer to the Breaking changes section to check if you need to update your configuration or simple check your log for configuration validation errors. Thanks to [@kellerza], [@fabaff], [@Teagan42], and [@pvizeli] for your effort!
+The validation of the configuration is still on-going. Approximately 80 % is done. This means that we will propably talk about this topic in the next release notes again. To align the configuration of components and platforms we needed to break some. Please refer to the Backward-incompatible changes section to check if you need to update your configuration or simple check your log for configuration validation errors. Thanks to [@kellerza], [@fabaff], [@Teagan42], and [@pvizeli] for your effort!
### All changes
@@ -87,7 +87,7 @@ The validation of the configuration is still on-going. Approximately 80 % is don
- Allow changing covers using scenes ([@nvella])
- Device tracker - Automatic: Fix polling ([@teagan42])
-### Breaking changes
+### Backward-incompatible changes
- [OpenweatherMap] entity IDs are now like `sensor.owm_temperature`. Previously they were like `sensor.weather_temperature`. Apologies for this change, but we needed to make OpenWeatherMap more generic now that we have many weather platforms.
- Updates of configuration variables due to configuration check or alignment with other platforms. Please update your configuration entries according to the documentation:
diff --git a/source/_posts/2016-09-29-async-sleepiq-emoncms-stocks.markdown b/source/_posts/2016-09-29-async-sleepiq-emoncms-stocks.markdown
index ef115522a8b..4c775aa5db7 100644
--- a/source/_posts/2016-09-29-async-sleepiq-emoncms-stocks.markdown
+++ b/source/_posts/2016-09-29-async-sleepiq-emoncms-stocks.markdown
@@ -22,7 +22,7 @@ There now is support for two new super cool things: Beds and license plates. [@t
### Configuration validation
-On the voluptuous front we have also made great progress. We were able to fully remove the legacy config helpers and have migrated 323 of the 346 components and platforms that needed migrating! This does mean that for some components the configuration has slightly changed, make sure to check out the breaking changes section at the bottom for more info. Thanks everybody for reviewing the Pull requests, testing the changes, and reporting issues.
+On the voluptuous front we have also made great progress. We were able to fully remove the legacy config helpers and have migrated 323 of the 346 components and platforms that needed migrating! This does mean that for some components the configuration has slightly changed, make sure to check out the backward-incompatible changes section at the bottom for more info. Thanks everybody for reviewing the Pull requests, testing the changes, and reporting issues.
### Delayed Release
@@ -100,7 +100,7 @@ Since 0.28 [automation rules](/blog/2016/09/10/notify-group-reload-api-pihole/#r
- Fix handling SIGTERM and SIGHUP signals (fixes Systemd restart issues) ([@pvizeli])
-### Breaking changes
+### Backward-incompatible changes
- The template methods `now` and `utcnow` have been changed from variables to methods. To get the current time replace `now` with `now()`.
- `yahooweather` default name is now `yweather`. Also min and max temperature are now correctly called `Temperature Min` and `Temperature Max`.
diff --git a/source/_posts/2016-10-08-hassbian-rest-digital-ocean.markdown b/source/_posts/2016-10-08-hassbian-rest-digital-ocean.markdown
index 877dd431139..7efa10f7fb9 100644
--- a/source/_posts/2016-10-08-hassbian-rest-digital-ocean.markdown
+++ b/source/_posts/2016-10-08-hassbian-rest-digital-ocean.markdown
@@ -40,7 +40,7 @@ As the results are processed on-the-fly you still need to use the data from your
### REST! We don't...
-There was a lot of work done on our implementation which are working with RESTful APIs. [@w1ll1am23] extended the [aREST] platforms to display if an aREST unit is available or not. The aREST implementations are now covered by the configuration check as well. Please check the Breaking changes section for more details.
+There was a lot of work done on our implementation which are working with RESTful APIs. [@w1ll1am23] extended the [aREST] platforms to display if an aREST unit is available or not. The aREST implementations are now covered by the configuration check as well. Please check the Backward-incompatible changes section for more details.
The [REST sensor][rest-sensor] supports now HTTP authentication (basic and digest) and custom headers. This will allow you to access resources which are protected. This sample sensor will access GitHub and retrieve the latest release number while by-passing the rate limit for non-authenticated requests.
@@ -117,7 +117,7 @@ sensor
- Fix for Slack targets ([@fabaff])
- Fix for Pushover targets ([@Nixon506E])
-### Breaking changes
+### Backward-incompatible changes
- All deprecated condition options from `automation` have been removed (deprecated since May and have printed warnings to your console):
- `use_trigger_values` is gone. You have to copy your triggers to conditions and adjust for the correct config.
diff --git a/source/_posts/2016-10-22-flash-briefing-updater-hacktoberfest.markdown b/source/_posts/2016-10-22-flash-briefing-updater-hacktoberfest.markdown
index ebd3f2d1b18..222038bf868 100644
--- a/source/_posts/2016-10-22-flash-briefing-updater-hacktoberfest.markdown
+++ b/source/_posts/2016-10-22-flash-briefing-updater-hacktoberfest.markdown
@@ -200,7 +200,7 @@ This is super annoying, I know, especially since we had said in [0.12][zero-one-
- Fix a spelling problem on user-facing error ([@robbiet480])
- YAML includes will ignore dirs/files prefixed with . ([@lwis])
-## Breaking changes
+## Backward-incompatible changes
- The [HTTP] component now takes a different format for authenticating IPs
- Configuration format has changed for [Proximity]
diff --git a/source/_posts/2016-11-05-hacktoberfest-influxdb-weather.markdown b/source/_posts/2016-11-05-hacktoberfest-influxdb-weather.markdown
index 22ee28145b1..ba3027379bd 100644
--- a/source/_posts/2016-11-05-hacktoberfest-influxdb-weather.markdown
+++ b/source/_posts/2016-11-05-hacktoberfest-influxdb-weather.markdown
@@ -108,7 +108,7 @@ Our website has now an additional category called "Ecosystem". This will become
- [iOS](/ecosystem/ios/)
- SceneGen
-### Breaking changes
+### Backward-incompatible changes
- The Yahoo Finance platform supports now multiple stock. Please adjust your configuration.
- Deprecated components `garage_door`, `rollershutter`, `thermostat`, and `hvac` have been removed.
diff --git a/source/_posts/2016-11-20-calendar--wink-thermostats--cisco-ios.markdown b/source/_posts/2016-11-20-calendar--wink-thermostats--cisco-ios.markdown
index f91a8ac7438..a8afe6a8226 100644
--- a/source/_posts/2016-11-20-calendar--wink-thermostats--cisco-ios.markdown
+++ b/source/_posts/2016-11-20-calendar--wink-thermostats--cisco-ios.markdown
@@ -64,7 +64,7 @@ But a new release wouldn't be awesome if it didn't had some new goodies and this
This should fix occasional performance problems that some people have reported.
-### Breaking changes
+### Backward-incompatible changes
- We have included a fix that impacts how we generate entity ids. This only impacts devices with accented characters. Instead of being stripped out, they are now replaced with the non-accented version. So now `Tèst Mörê` will become `test_more` instead of `tst_mr`.
- Command line switches will now use the specified object ID for their entity ID instead of basing it off the name.
diff --git a/source/_posts/2016-12-03-remote-websockets-sonarr.markdown b/source/_posts/2016-12-03-remote-websockets-sonarr.markdown
index 6fbf5663fec..1eb4a4269d2 100644
--- a/source/_posts/2016-12-03-remote-websockets-sonarr.markdown
+++ b/source/_posts/2016-12-03-remote-websockets-sonarr.markdown
@@ -127,7 +127,7 @@ We are working on a better solution for 0.35.
- Fix Nest cameras without activity zones ([@technicalpickles])
- Fix Plex doing I/O inside event loop ([@balloob])
-### Breaking changes
+### Backward-incompatible changes
- The [HomeMatic][homematic] component now uses a different syntax for hosts and the `set_value` service has been renamed.
- All [RFXtrx][rfxtrx] sensors will get a new entity ID.
diff --git a/source/_posts/2017-01-14-iss-usps-images-packages.markdown b/source/_posts/2017-01-14-iss-usps-images-packages.markdown
index 334acc223bf..f05bf240cd0 100644
--- a/source/_posts/2017-01-14-iss-usps-images-packages.markdown
+++ b/source/_posts/2017-01-14-iss-usps-images-packages.markdown
@@ -85,7 +85,7 @@ The new [image processing component][image] currently works with [number plates]
- Fix Bluetooth and Volvo trackers ([@pvizeli])
- Fix lannouncer notify platform ([@mKeRix])
-### Breaking changes
+### Backward-incompatible changes
- [APNS][apns] service was moved to the `notify` domain. Use `notify.apns_NOTIFIER_NAME` instead of `apns.NOTIFIER_NAME`.
- [InfluxDB][influx] component has a new [schema](/integrations/influxdb/#data-migration) to store values in the InfluxDB database. You may require to run the [`influxdb_migrator`](/integrations/influxdb/#migration-script) script.
diff --git a/source/_posts/2017-01-28-face-coffee-wink.markdown b/source/_posts/2017-01-28-face-coffee-wink.markdown
index 82f48cf4ccd..51e37497ad2 100644
--- a/source/_posts/2017-01-28-face-coffee-wink.markdown
+++ b/source/_posts/2017-01-28-face-coffee-wink.markdown
@@ -12,7 +12,7 @@ og_image: /images/blog/2017-01-0.37/social.png
---
-No stats, no numbers, and alike this time. Ok, just one number: 0.37. We are back on track with our bi-weekly release cycle. Beside some organizational changes is this release shipping again cool features and new integrations. Please keep an eye on the "Breaking changes" section because there are also massive improvements for some platforms and components.
+No stats, no numbers, and alike this time. Ok, just one number: 0.37. We are back on track with our bi-weekly release cycle. Beside some organizational changes is this release shipping again cool features and new integrations. Please keep an eye on the "Backward-incompatible changes" section because there are also massive improvements for some platforms and components.
### Governance
As announced, the new [Governance][gov] requires for developers to sign the CLA. [Code of Conduct][coc], [Contributor License Agreement][cla], and proper [Licensing][license] will to protect all involved parties in the Home Assistant eco-system from users and community members to contributors.
@@ -144,7 +144,7 @@ Bugfix: [@balloob], [@fabaff], [@freol35241], [@pvizeli], [@Danielhiversen], [@t
- Prevent infinite loop in crossconfigured mqtt event streams ([@aequitas])
- Fix Hue lightgroups failing on startup (@tboyce1)
-### Breaking changes
+### Backward-incompatible changes
- A **major** breaking change in the [`emulated_hue`][emul-hue] component means that unless you set `type: alexa` before starting up the newer Home Assistant version you will lose all devices that Alexa has discovered and will need to re-add them as well as create new groups.
- The platform of the [ISS][iss] integration was change to `binary_sensor`. Please check the platform documentation.
- The [Roku][roku] media uses now a new format for the entity IDs.
diff --git a/source/_posts/2017-02-11-alert-appletv-mqtt-yeelight.markdown b/source/_posts/2017-02-11-alert-appletv-mqtt-yeelight.markdown
index c16f604155f..80515377bea 100644
--- a/source/_posts/2017-02-11-alert-appletv-mqtt-yeelight.markdown
+++ b/source/_posts/2017-02-11-alert-appletv-mqtt-yeelight.markdown
@@ -131,7 +131,7 @@ Bugfixes: [@balloob], [@fabaff], [@pvizeli], [@mnoorenberghe] [@Danielhiversen],
- Hidden devices are no longer visible on views ([@balloob])
-### Breaking changes
+### Backward-incompatible changes
- The support for [LG webOS Smart TVs][webostv] was improved. This requires you to move `$HOME/.pylgtv` to `$HASS_CONFIG_DIR/webostv.conf` or Home Assistant will need to be paired with the TV again.
- Image processing events have been renamed: `identify_face` has become `image_processing.detect_face`, `found_plate` has become `image_processing.found_plate`
- The [FFmpeg binary sensor][ffmpeg-bin] change the platform name from `ffmpeg` to `ffmpeg_noise` and `ffmpeg_motion`. Also all FFmpeg-related services are moved from a platform implementation to a the [FFmpeg components][ffmpeg] and were rename from `binary_sensor.ffmpeg_xy` to `ffmpeg.xy`.
diff --git a/source/_posts/2017-02-25-config-panel-and-state-restoration.markdown b/source/_posts/2017-02-25-config-panel-and-state-restoration.markdown
index de06529836d..24dfbdad6e0 100644
--- a/source/_posts/2017-02-25-config-panel-and-state-restoration.markdown
+++ b/source/_posts/2017-02-25-config-panel-and-state-restoration.markdown
@@ -61,13 +61,13 @@ Thanks to [Fabian][@fabaff] we have a great re-organized documentation. Is it pe
Ever have some input components or integrations and get annoyed with the fact that their state is lost after a restart? Don't worry any longer. [Johann][@kellerza] has added the foundation for state restoration to Home Assistant. For the initial release support has been added to `input_select` and `input_boolean` components. We will be adding this to more integrations in the future.
-## Breaking changes to customize and Z-Wave "customize"
+## Backward-incompatible changes to customize and Z-Wave "customize"
A couple of releases ago we introduced a new way of doing `customize`. It became a list that allowed different ways of matching the config to the entity.
We realized that this was leading into a rabbit hole that we had to get out off. Besides making it unnecessarily complicated it also blocked the road to config panels. And who doesn't like config panels?
-So starting this release, we had to make some breaking changes to right the wrong. We will be releasing an online tool to help you convert your config to the new format later today.
+So starting this release, we had to make some backward-incompatible changes to right the wrong. We will be releasing an online tool to help you convert your config to the new format later today.
[**Update: the online tool can be found here.**](https://jsfiddle.net/balloob/d2e56q6f/74/)
@@ -207,7 +207,7 @@ And a final shout out to [Pascal][@pvizeli]. He keeps improving the performance
- Prevent discovered services and devices to be handled twice (@colinodell)
-#### Breaking changes
+#### Backward-incompatible changes
- VolvoOnCall has been extended with more features and had to be converted to a component
- Limitlessled support for Bridge v6 and RGBWW bulbs require users to specify `version` and `port
diff --git a/source/_posts/2017-03-11-repurpose-any-android-phone-as-ip-camera.markdown b/source/_posts/2017-03-11-repurpose-any-android-phone-as-ip-camera.markdown
index 775cb18dd4a..1edcaf9bc96 100644
--- a/source/_posts/2017-03-11-repurpose-any-android-phone-as-ip-camera.markdown
+++ b/source/_posts/2017-03-11-repurpose-any-android-phone-as-ip-camera.markdown
@@ -50,7 +50,7 @@ Screenshot of all the different functionality the IP webcam integration offers.
- Blink Home Security Camera support added ([@fronzbot])
- AppleTV has been converted to push data to Home Assistant instead of us having to poll ([@postlund])
-## Breaking changes
+## Backward-incompatible changes
- Vera entity ids have changed. This is a one time change to migrate to a model that will prevent future conflicts.
- The Twilio notify platforms now have to be configured via the twilio component.
diff --git a/source/_posts/2017-03-25-todo-volumio-workday.markdown b/source/_posts/2017-03-25-todo-volumio-workday.markdown
index 0db2868983d..dbdfb25429b 100644
--- a/source/_posts/2017-03-25-todo-volumio-workday.markdown
+++ b/source/_posts/2017-03-25-todo-volumio-workday.markdown
@@ -28,7 +28,7 @@ The new format of the changelog which was introduced with 0.40 will provide a li
- [Volumio][volumio] media player added ([@jslove])
- [Workday][workday] sensor ([@BastianPoe])
-## Breaking changes
+## Backward-incompatible changes
- The [Kodi notifier][kodi] platform was migrated to async and the configuration synced with the Kodi media player platform ([#6497]).
- For the [Music Player Daemon][mpd] (MPD) platform was `location` replaced with `name` ([#6553]).
diff --git a/source/_posts/2017-04-08-eddystone-beacons--lockitron-locks--total-connect.markdown b/source/_posts/2017-04-08-eddystone-beacons--lockitron-locks--total-connect.markdown
index 5d4cacfbbd2..4605bbf2248 100644
--- a/source/_posts/2017-04-08-eddystone-beacons--lockitron-locks--total-connect.markdown
+++ b/source/_posts/2017-04-08-eddystone-beacons--lockitron-locks--total-connect.markdown
@@ -34,7 +34,7 @@ Also want to take a moment to thank Austin Andrews aka [Templarian] for his [Mat
- The Ring doorbell has been integrated further with the inclusion of binary sensors ([@tchellomello] - [#6520])
-## Breaking changes
+## Backward-incompatible changes
- We were incorrectly treating groups named `default_view` as default views. Make sure you set `view: true` in the config for these groups. [#251 (frontend)](https://github.com/home-assistant/home-assistant-polymer/pull/251)
- The last release introduced a revamped LIFX platform. We only realized after deploy that this version does not work on Windows. We have added the old LIFX implementation back as `lifx_legacy`.
diff --git a/source/_posts/2017-04-22-ikea-tradfri--spotify.markdown b/source/_posts/2017-04-22-ikea-tradfri--spotify.markdown
index b138a700429..bbe0367fe74 100644
--- a/source/_posts/2017-04-22-ikea-tradfri--spotify.markdown
+++ b/source/_posts/2017-04-22-ikea-tradfri--spotify.markdown
@@ -49,7 +49,7 @@ Also note that you have till the end of the weekend to [submit an application][a
- myStrom Wifi Bulbs ([@fabaff] - [#7161]) ([light.mystrom docs]) (new-platform)
-## Breaking changes
+## Backward-incompatible changes
- Remove deprecated classes from `homeassistant.remote` ([@balloob] - [#7011])
- min_max sensor has a different default name and will ignore states that are unknown ([@micw] - [#6786])
diff --git a/source/_posts/2017-05-06-zigbee-opencv-dlib.markdown b/source/_posts/2017-05-06-zigbee-opencv-dlib.markdown
index 1a993fe3ab8..f4494996a64 100644
--- a/source/_posts/2017-05-06-zigbee-opencv-dlib.markdown
+++ b/source/_posts/2017-05-06-zigbee-opencv-dlib.markdown
@@ -60,7 +60,7 @@ Experiencing issues introduced by this release? Please report them in our [issue
- MQTT Cover: Fixed status reporting for range with non-zero base ([@cribbstechnologies])
-## Breaking changes
+## Backward-incompatible changes
- Python Open Z-Wave made a release that fixed string processing. This was backwards incompatible. We have updated our code so you'll have to update to the latest Python Open Z-Wave with this release. You can also wait one release, as next release we'll introduce automatic installing of Python Open Z-Wave. ([@keatontaylor] - [#7266]) ([climate.zwave docs]) (breaking change)
- InfluxDB configuration to blacklist domains has been updated to allow more features. ([@janLo] - [#7264]) (breaking change)
diff --git a/source/_posts/2017-05-20-automation-editor-zwave-panel-ocr.markdown b/source/_posts/2017-05-20-automation-editor-zwave-panel-ocr.markdown
index b4ff294ea2c..1a6d7b85b81 100644
--- a/source/_posts/2017-05-20-automation-editor-zwave-panel-ocr.markdown
+++ b/source/_posts/2017-05-20-automation-editor-zwave-panel-ocr.markdown
@@ -85,7 +85,7 @@ If you are using our [experimental Hass.io image][hass.io], we made a breaking c
## Reporting Issues
Experiencing issues introduced by this release? Please report them in our [issue tracker][issue]. Make sure to fill in all fields of the issue template.
-## Breaking changes
+## Backward-incompatible changes
- PyPI Openzwave ([@JshWright] - [#7415]) ([zwave docs]) (breaking change)
- Remove listening to `homeassistant_start` with event automation ([@balloob] - [#7474]) ([automation.event docs]) (breaking change)
diff --git a/source/_posts/2017-06-04-release-46.markdown b/source/_posts/2017-06-04-release-46.markdown
index d85a067dde1..88c2ec3ace3 100644
--- a/source/_posts/2017-06-04-release-46.markdown
+++ b/source/_posts/2017-06-04-release-46.markdown
@@ -32,7 +32,7 @@ It's time for 0.46! This release does not have too many new integrations, instea
- Sensor - MetOffice: Fix last updated date ([@cyberjacob] - [#7965]) ([metoffice docs])
- Prevent Roku doing I/O in event loop ([@balloob] - [#7969]) ([media_player.roku docs])
-## Breaking changes
+## Backward-incompatible changes
- The USPS sensor entity names have changed as there are now two. One for packages and one for mail. Config will now also use `scan_interval` instead of `update_interval` ([@happyleavesaoc] - [#7655]) (breaking change)
- Automation state trigger: From/to checks will now ignore state changes that are just attribute changess ([@amelchio] - [#7651]) ([automation.state docs]) (breaking change)
diff --git a/source/_posts/2017-06-15-zwave-entity-ids.markdown b/source/_posts/2017-06-15-zwave-entity-ids.markdown
index 740a82a1083..94765c1344f 100644
--- a/source/_posts/2017-06-15-zwave-entity-ids.markdown
+++ b/source/_posts/2017-06-15-zwave-entity-ids.markdown
@@ -15,6 +15,6 @@ Now that users are able to control these names, we will be making changes to how
With the release of 0.47, this feature will be opt-in. Setting `new_entity_ids: true` under `zwave:` in your configuration.yaml will enable the new generation. After 0.48 this feature will become opt-out. From 0.48 onward, unless you’ve declared `new_entity_ids: false` you will switch to the new entity_id generation. At an undecided point in the future, the old entity_id generation will be removed completely.
-I’m sure all ZWave users understand that the current entity_ids aren’t easy to use. They’re annoying to type in configuration.yaml, and break if a node needs to be re-included to the network. We know that breaking changes are painful, and so we’re doing what we can to roll this change out as smoothly as possible. The end result should be a dramatic simplification of most ZWave configurations. We hope that this change will ultimately make ZWave much easier to work with, and bring ZWave configuration just a little closer to the rest of the Home Assistant platforms.
+I’m sure all ZWave users understand that the current entity_ids aren’t easy to use. They’re annoying to type in configuration.yaml, and break if a node needs to be re-included to the network. We know that backward-incompatible changes are painful, and so we’re doing what we can to roll this change out as smoothly as possible. The end result should be a dramatic simplification of most ZWave configurations. We hope that this change will ultimately make ZWave much easier to work with, and bring ZWave configuration just a little closer to the rest of the Home Assistant platforms.
[@turbokongen]: https://github.com/turbokongen
diff --git a/source/_posts/2017-06-17-release-47.markdown b/source/_posts/2017-06-17-release-47.markdown
index 739b2ae7f7e..fd878d17000 100644
--- a/source/_posts/2017-06-17-release-47.markdown
+++ b/source/_posts/2017-06-17-release-47.markdown
@@ -91,7 +91,7 @@ To run without the monkey patch, start Home Assistant with `HASS_NO_MONKEY=1 has
Experiencing issues introduced by this release? Please report them in our [issue tracker][issue]. Make sure to fill in all fields of the issue template.
-## Breaking changes
+## Backward-incompatible changes
- Update opencv config to match other image processors ([@Teagan42] - [#7864]) ([image_processing.opencv docs]) (breaking change)
diff --git a/source/_posts/2017-07-02-release-48.markdown b/source/_posts/2017-07-02-release-48.markdown
index 44269d43f68..f7172896c64 100644
--- a/source/_posts/2017-07-02-release-48.markdown
+++ b/source/_posts/2017-07-02-release-48.markdown
@@ -75,7 +75,7 @@ Experiencing issues introduced by this release? Please report them in our [issue
-## Breaking Changes
+## Backward-incompatible changes
- We have added a new option to whitelist folders that can be used as sources for sending files. You will need to use this option if you are using files with the telegram component. ([@pvizeli] - [#8189]) (breaking change)
diff --git a/source/_posts/2017-07-16-release-49.markdown b/source/_posts/2017-07-16-release-49.markdown
index b8d8ae6c28c..9e8977ff526 100644
--- a/source/_posts/2017-07-16-release-49.markdown
+++ b/source/_posts/2017-07-16-release-49.markdown
@@ -83,7 +83,7 @@ This feature has also been brought to you by [@Andrey-git]! Big shout out to him
Experiencing issues introduced by this release? Please report them in our [issue tracker][issue]. Make sure to fill in all fields of the issue template.
-## Breaking Changes
+## Backward-incompatible changes
- UPC Connect component no longer needs a password passed into the configuration. ([@Flavien] - [#8335]) ([device_tracker.upc_connect docs]) (breaking change)
- The Apple TV platform has been upgraded to a component and a remote platform has been added. This requires your Apple TV configuration to be moved to the new `apple_tv` component. ([@postlund] - [#8122]) ([media_player.apple_tv docs]) (breaking change)
diff --git a/source/_posts/2017-07-29-release-50.markdown b/source/_posts/2017-07-29-release-50.markdown
index 9a9c8125d26..76fa9788b91 100644
--- a/source/_posts/2017-07-29-release-50.markdown
+++ b/source/_posts/2017-07-29-release-50.markdown
@@ -89,7 +89,7 @@ Straight to 0.50.2. We released 0.50 as 0.50.1 due to an upload error to PyPi.
Experiencing issues introduced by this release? Please report them in our [issue tracker][issue]. Make sure to fill in all fields of the issue template.
-## Breaking Changes
+## Backward-incompatible changes
- Automations: The state trigger keyword `state` and the time trigger keyword `after` were deprecated in 0.46. They have now been removed. Use `to` and `at` instead. ([@amelchio] - [#8510]) ([automation.state docs]) ([automation.time docs]) (breaking change)
- Wink: the component is no longer supporting the `access_token` in the config. Use the new OAuth authentication or add your username and password to the config. ([@w1ll1am23] - [#8208]) ([wink docs]) (breaking change)
diff --git a/source/_posts/2017-08-12-release-51.markdown b/source/_posts/2017-08-12-release-51.markdown
index d970b4d8232..699d239dede 100644
--- a/source/_posts/2017-08-12-release-51.markdown
+++ b/source/_posts/2017-08-12-release-51.markdown
@@ -80,7 +80,7 @@ As we have seen more vacuum cleaners land in Home Assistant, it was time to crea
Experiencing issues introduced by this release? Please report them in our [issue tracker][issue]. Make sure to fill in all fields of the issue template.
-## Breaking Changes
+## Backward-incompatible changes
- Efergy sensors: change units from KW to W ([@emlt] - [#8761]) ([sensor.efergy docs]) (breaking change)
- Xiaomi vacuum is now a platform of new `vacuum` component derived from ToggleEntity, and services ([@azogue] - [#8623]) (breaking change) (new-platform)
diff --git a/source/_posts/2017-08-26-release-0-52.markdown b/source/_posts/2017-08-26-release-0-52.markdown
index e9f434c746b..ab41a7e1058 100644
--- a/source/_posts/2017-08-26-release-0-52.markdown
+++ b/source/_posts/2017-08-26-release-0-52.markdown
@@ -66,7 +66,7 @@ script: !include scripts.yaml
Experiencing issues introduced by this release? Please report them in our [issue tracker][issue]. Make sure to fill in all fields of the issue template.
-## Breaking Changes
+## Backward-incompatible changes
- Remove spaces from Xiami switch attributes ([@syssi] - [#8952]) ([switch.xiaomi docs]) (breaking change)
- MQTT Switch: command and availability payload are now no longer linked. Command and availability payload default to ON/OFF and must be configured individually if custom values are required. ([@timstanley1985] - [#8934]) ([switch.mqtt docs]) (breaking change)
diff --git a/source/_posts/2017-09-09-release-53.markdown b/source/_posts/2017-09-09-release-53.markdown
index 1386f2fc92a..1bed70cb95d 100644
--- a/source/_posts/2017-09-09-release-53.markdown
+++ b/source/_posts/2017-09-09-release-53.markdown
@@ -87,7 +87,7 @@ Experiencing issues introduced by this release? Please report them in our [issue
-## Breaking Changes
+## Backward-incompatible changes
- The new customize editor is using the file `customize.yaml` in your config folder. If you are using this file today for other config, make sure to rename it before using the new customize UI editor. ([@andrey-git] - [#9134]) ([config docs]) (breaking change) (new-platform)
- The frontend component now supports loading custom html files when Home Assistant front end starts ([@andrey-git] - [#9150]) (breaking change). It could be Javascript, CSS or custom Web Components. Along there was a breaking change in the way Custom UI is used:
diff --git a/source/_posts/2017-09-23-release-54.markdown b/source/_posts/2017-09-23-release-54.markdown
index 350360dde36..1176fe1dbbc 100644
--- a/source/_posts/2017-09-23-release-54.markdown
+++ b/source/_posts/2017-09-23-release-54.markdown
@@ -39,7 +39,7 @@ Experiencing issues introduced by this release? Please report them in our [issue
-## Breaking Changes
+## Backward-incompatible changes
- Sensor - OneWire: This update changes the names of the sensors from `` to `` ([@tcastberg] - [#9404]) ([sensor.onewire docs]) (breaking change)
- Renamed Xiaomi platforms to include their protocol names. xiaomi -> xiaomi_aqara, xiaomi_aqara.switch, xiaomi_aqara.light, xiaomi_aqara.binary_sensor, ... and vacuum.xiaomi, xiaomi_philipslight -> xiaomi_miio, vacuum.xiaomi_miio, light.xiaomi_miio ([@danielhiversen] - [#9426]) (breaking change)
diff --git a/source/_posts/2017-10-07-release-55.markdown b/source/_posts/2017-10-07-release-55.markdown
index cfc382dfbcd..30e587f2724 100644
--- a/source/_posts/2017-10-07-release-55.markdown
+++ b/source/_posts/2017-10-07-release-55.markdown
@@ -61,7 +61,7 @@ Experiencing issues introduced by this release? Please report them in our [issue
-## Breaking Changes
+## Backward-incompatible changes
- history_graph component: If your component used `history.get_significant_states` function then you need to adjust the string `entity_id` parameter has been changed to a list of strings `entity_ids` parameter. ([@andrey-git] - [#9472]) (breaking change)
- UPNP component: The `external_port` configuration option was removed. ([@balloob] - [#9560]) ([upnp docs]) (breaking change)
diff --git a/source/_posts/2017-10-21-release-56.markdown b/source/_posts/2017-10-21-release-56.markdown
index 6948285677b..fbd6031e561 100644
--- a/source/_posts/2017-10-21-release-56.markdown
+++ b/source/_posts/2017-10-21-release-56.markdown
@@ -75,7 +75,7 @@ Experiencing issues introduced by this release? Please report them in our [issue
-## Breaking Changes
+## Backward-incompatible changes
- Simplify track_same_state ([@balloob] - [#9795]) ([automation.numeric_state docs]) ([automation.state docs]) ([binary_sensor.template docs]) (breaking change)
- Split map panel out into its own component ([@cgarwood] - [#9814]) ([map docs]) (breaking change) (new-platform)
diff --git a/source/_posts/2017-11-04-release-57.markdown b/source/_posts/2017-11-04-release-57.markdown
index 354d200ea8c..85916a2291f 100644
--- a/source/_posts/2017-11-04-release-57.markdown
+++ b/source/_posts/2017-11-04-release-57.markdown
@@ -44,7 +44,7 @@ This means that we processed over 20 Pull requests per day. The result was alrea
## IKEA TRÅDFRI
-Good news and bad news on this front. The bad news is that IKEA changed the internal API for TRÅDFRI with a firmware update, breaking the Home Assistant integration. The good news is that they were nice enough to [email us with instructions on the breaking changes][ikea email].
+Good news and bad news on this front. The bad news is that IKEA changed the internal API for TRÅDFRI with a firmware update, breaking the Home Assistant integration. The good news is that they were nice enough to [email us with instructions on the backward-incompatible changes][ikea email].
Long time contributor [@lwis] jumped on the case and managed to migrate our integration in Home Assistant in time for this release. Great work!
@@ -107,7 +107,7 @@ Experiencing issues introduced by this release? Please report them in our [issue
-## Breaking Changes
+## Backward-incompatible changes
- IKEA TRÅDFRI: We no longer support entering the key in the configuration. ([@lwis] - [#10282]) ([tradfri docs]) (breaking change)
- API.AI was renamed to [Dialogflow](/integrations/dialogflow/). This requires to rename the entry in your `configuration.yaml` file from `apiai:` to `dialogflow`. ([@fabaff] - [#10006]) ([dialogflow docs]) (breaking change)
diff --git a/source/_posts/2017-11-18-release-58.markdown b/source/_posts/2017-11-18-release-58.markdown
index 40d5d984013..aed37c86d4c 100644
--- a/source/_posts/2017-11-18-release-58.markdown
+++ b/source/_posts/2017-11-18-release-58.markdown
@@ -80,7 +80,7 @@ Experiencing issues introduced by this release? Please report them in our [issue
-## Breaking Changes
+## Backward-incompatible changes
- `hass.states.is_state_attr(entity_id, attribute, value)` has been removed. The template version still exists. Unused method parameter `wait` has been removed from `hass.bus.async_fire` ([@balloob] - [#10305]) (breaking change)
- Refactor Neato botvac components as a vacuum ([@jabesq] - [#9946]) ([neato docs]) ([switch.neato docs]) ([vacuum.neato docs]) (breaking change) (new-platform)
diff --git a/source/_posts/2017-12-03-release-59.markdown b/source/_posts/2017-12-03-release-59.markdown
index 192070bf791..d6edfa2d112 100644
--- a/source/_posts/2017-12-03-release-59.markdown
+++ b/source/_posts/2017-12-03-release-59.markdown
@@ -79,7 +79,7 @@ Experiencing issues introduced by this release? Please report them in our [issue
-## Breaking Changes
+## Backward-incompatible changes
- Added cycles config option to LaMetric notifications ([@frittes] - [#10656]) ([notify.lametric docs]) (breaking change)
- Fix name collision when using multiple Hue bridges ([@zBart] - [#10486]) ([light.hue docs]) (breaking change)
diff --git a/source/_posts/2017-12-17-release-60.markdown b/source/_posts/2017-12-17-release-60.markdown
index 938566f2908..fa6eaa61bca 100644
--- a/source/_posts/2017-12-17-release-60.markdown
+++ b/source/_posts/2017-12-17-release-60.markdown
@@ -71,7 +71,7 @@ Experiencing issues introduced by this release? Please report them in our [issue
-## Breaking Changes
+## Backward-incompatible changes
- Update snips to listen on new mqtt topic and utilize rawValue ([@tschmidty69] - [#11020]) ([snips docs]) (breaking change)
- Refactor hue to split bridge support from light platform ([@andreacampi] - [#10691]) ([hue docs]) ([light.hue docs]) (breaking change) (new-platform)
diff --git a/source/_posts/2018-01-14-release-61.markdown b/source/_posts/2018-01-14-release-61.markdown
index 67d16f56e6a..557e22dc121 100644
--- a/source/_posts/2018-01-14-release-61.markdown
+++ b/source/_posts/2018-01-14-release-61.markdown
@@ -1,6 +1,6 @@
---
title: "0.61: Coinbase, Discogs, iGlo, Sochain"
-description: "New crypto currency sensors and other new stuff including breaking changes."
+description: "New crypto currency sensors and other new stuff including backward-incompatible changes."
date: 2018-01-14 18:00:00
date_formatted: "January 14, 2018"
author: Fabian Affolter
@@ -15,11 +15,11 @@ og_image: /images/blog/2018-01-0.61/components.png
Almost a 100 contributors to this release 🎉 That's what you get when you skip a release. It's a little late but "Happy New Year" and welcome to 0.61 the first release 2018.
-This release contain some breaking changes. Please make sure that you check the section below if you are running into trouble.
+This release contain some backward-incompatible changes. Please make sure that you check the section below if you are running into trouble.
## Assistant configs
-We made a mistake in the foundation of both the Google Assistant and Alexa integrations: they were storing their config inside customize. This is not the right place and we moved them to be under the components itself. See the breaking changes section on how to migrate.
+We made a mistake in the foundation of both the Google Assistant and Alexa integrations: they were storing their config inside customize. This is not the right place and we moved them to be under the components itself. See the backward-incompatible changes section on how to migrate.
## Hass.io updates
@@ -73,7 +73,7 @@ Experiencing issues introduced by this release? Please report them in our [issue
-## Breaking Changes
+## Backward-incompatible changes
- Extend Threshold binary sensor to support ranges. This means that you can now set `up` and `lower`. ([@DanNixon] - [#11110]) ([binary_sensor.threshold docs]) (breaking change)
- The Steam game platform contains changes:
diff --git a/source/_posts/2018-01-27-release-62.markdown b/source/_posts/2018-01-27-release-62.markdown
index 732354d8b05..2fbfb309c41 100644
--- a/source/_posts/2018-01-27-release-62.markdown
+++ b/source/_posts/2018-01-27-release-62.markdown
@@ -49,7 +49,7 @@ Experiencing issues introduced by this release? Please report them in our [issue
-## Breaking Changes
+## Backward-incompatible changes
- Tahoma platform will get new entity IDs ([@glpatcern] - [#11547]) ([tahoma docs]) ([cover.tahoma docs]) (breaking change)
- Mold indicator: attribute names no longer include spaces or periods ([@olskar] - [#11694]) ([sensor.mold_indicator docs]) (breaking change)
diff --git a/source/_posts/2018-02-10-release-63.markdown b/source/_posts/2018-02-10-release-63.markdown
index 62df63beed1..084839fce2f 100644
--- a/source/_posts/2018-02-10-release-63.markdown
+++ b/source/_posts/2018-02-10-release-63.markdown
@@ -79,7 +79,7 @@ Experiencing issues introduced by this release? Please report them in our [issue
-## Breaking Changes
+## Backward-incompatible changes
- updated sensor name ([@philklei] - [#12084]) ([sensor.tahoma docs]) (breaking change)
- Originally Canary camera is added per location and only displays an image that was captured due to motion. Now it is per device (each location can have multiple devices) with live stream support. ([@snjoetw] - [#11949]) ([canary docs]) ([camera.canary docs]) (breaking change)
diff --git a/source/_posts/2018-02-26-release-64.markdown b/source/_posts/2018-02-26-release-64.markdown
index 96d9929ce26..b6f0fe85d49 100644
--- a/source/_posts/2018-02-26-release-64.markdown
+++ b/source/_posts/2018-02-26-release-64.markdown
@@ -111,7 +111,7 @@ Experiencing issues introduced by this release? Please report them in our [issue
-## Breaking Changes
+## Backward-incompatible changes
- Home Assistant now defaults to purge recorded history that is older than 10 days. If you want to keep your recorded data for longer than that, you must configure the number of days to retain _before starting 0.64 for the first time_, for example:
```yaml
diff --git a/source/_posts/2018-03-09-release-65.markdown b/source/_posts/2018-03-09-release-65.markdown
index d35c4727f4e..e630f4e2fec 100644
--- a/source/_posts/2018-03-09-release-65.markdown
+++ b/source/_posts/2018-03-09-release-65.markdown
@@ -178,7 +178,7 @@ intent_script:
Experiencing issues introduced by this release? Please report them in our [issue tracker](https://github.com/home-assistant/home-assistant/issues). Make sure to fill in all fields of the issue template.
-## Breaking Changes
+## Backward-incompatible changes
- Insteon PLM: If you have created platform overrides in your configuration.yaml file to change a your INSTEON device to map to a different Home Assistant platform, that mapping will no longer be in effect. Please see the new device override capabilities in the [insteon_plm documentation](/integrations/insteon/). ([@teharris1] - [#12534]) ([insteon_plm docs]) ([binary_sensor.insteon_plm docs]) ([fan.insteon_plm docs]) ([light.insteon_plm docs]) ([sensor.insteon_plm docs]) ([switch.insteon_plm docs]) (breaking change)
- AirVisual's air index unit is AQI (Air Quality Index), not PSI (Pressure per Square Inch). ([@chilicheech] - [#12730]) ([sensor.airvisual docs]) (breaking change)
diff --git a/source/_posts/2018-03-30-release-66.markdown b/source/_posts/2018-03-30-release-66.markdown
index d75c9b6c9bc..28c1a6f5974 100644
--- a/source/_posts/2018-03-30-release-66.markdown
+++ b/source/_posts/2018-03-30-release-66.markdown
@@ -52,7 +52,7 @@ A quick note if you are using Philips Hue and a Hue custom component: it will no
Experiencing issues introduced by this release? Please report them in our [issue tracker](https://github.com/home-assistant/home-assistant/issues). Make sure to fill in all fields of the issue template.
-## Breaking Changes
+## Backward-incompatible changes
- Refactor Hue: If you specify a bridge in your config, the `host` key is now required and needs to be a valid IP address. Option `allow_in_emulated_hue` has been removed. Exclude the lights via the emulated hue config. Due to the internal changes of how the Hue integration works, any Hue custom component will no longer work. ([@balloob] - [#13043]) ([hue docs]) ([light.hue docs]) (breaking change)
- Z-Wave: In version 0.47, the opt-in `new_entity_ids` configuration was added to Z-Wave to smooth the transition through the change. Support for old entity IDs is now removed, and the configuration is no longer necessary. If you are migrating from 0.63 or higher, your entity IDs will already be stored in the Entity Registry and no changes are required. If not, entity IDs can now be manually configured using the Entity Registry if necessary. ([@armills] - [#12652]) ([zwave docs]) (breaking change)
diff --git a/source/_posts/2018-04-14-release-67.markdown b/source/_posts/2018-04-14-release-67.markdown
index d7c5b9475c5..a895c7b4354 100644
--- a/source/_posts/2018-04-14-release-67.markdown
+++ b/source/_posts/2018-04-14-release-67.markdown
@@ -54,7 +54,7 @@ This release includes a security fix. The error log was accessible via the API w
Experiencing issues introduced by this release? Please report them in our [issue tracker](https://github.com/home-assistant/home-assistant/issues). Make sure to fill in all fields of the issue template.
-## Breaking Changes
+## Backward-incompatible changes
- Updates default Pilight port number ([@frenck] - [#13419]) ([pilight docs]) (breaking change)
- Update to new "b2vapi" of BMW ConnectedDrive ([@ChristianKuehnel] - [#13305]) ([bmw_connected_drive docs]) ([binary_sensor.bmw_connected_drive docs]) ([lock.bmw_connected_drive docs]) ([sensor.bmw_connected_drive docs]) (breaking change)
diff --git a/source/_posts/2018-04-27-release-68.markdown b/source/_posts/2018-04-27-release-68.markdown
index 3b69521fd92..b5c2065f4e6 100644
--- a/source/_posts/2018-04-27-release-68.markdown
+++ b/source/_posts/2018-04-27-release-68.markdown
@@ -60,7 +60,7 @@ Another cool new platform, also by [@mjg59], is support for Eufy devices. Eufy i
Experiencing issues introduced by this release? Please report them in our [issue tracker](https://github.com/home-assistant/home-assistant/issues). Make sure to fill in all fields of the issue template.
-## Breaking Changes
+## Backward-incompatible changes
- Icons! Material Design Icons has implemented some naming guidelines and this caused 9 icons to change names, 3 of which are home automation icons: `roomba` -> `robot-vacuum`, `nest-protect` -> `smoke-detector`, `nest-thermostat` -> `thermostat` ([see all changes](http://templarian.com/2018/04/18/material-design-icons-v2-3-54/)).
- Support for multiple MAX!Cube LAN gateways caused a slight change to the configuration schema. Make sure to check the docs for the new one. ([@syssi] - [#13517]) ([maxcube docs]) ([binary_sensor.maxcube docs]) ([climate.maxcube docs]) (breaking change)
diff --git a/source/_posts/2018-05-11-release-69.markdown b/source/_posts/2018-05-11-release-69.markdown
index 5662a627290..4ea6e908804 100644
--- a/source/_posts/2018-05-11-release-69.markdown
+++ b/source/_posts/2018-05-11-release-69.markdown
@@ -37,7 +37,7 @@ Not much time to write a great intro this time as we're hanging out at PyCon! So
Experiencing issues introduced by this release? Please report them in our [issue tracker](https://github.com/home-assistant/home-assistant/issues). Make sure to fill in all fields of the issue template.
-## Breaking Changes
+## Backward-incompatible changes
- Pollen.com: Added attributes on top 3 allergens. This caused attribute names `primary_allergen_genus`, `primary_allergen_name` and `primary_allergen_type` to be suffixed with `_1` ([@bachya] - [#14018]) ([sensor.pollen docs]) (breaking change)
- Add Sonos device attribute with grouping information. The `media_player.sonos` attribute `is_coordinator` has been removed; the new attribute `sonos_group` (listing all group members, coordinator first) can be used instead. ([@amelchio] - [#13553]) ([media_player.sonos docs]) (breaking change)
diff --git a/source/_posts/2018-05-18-release-70.markdown b/source/_posts/2018-05-18-release-70.markdown
index 8301630902f..073ba53c045 100644
--- a/source/_posts/2018-05-18-release-70.markdown
+++ b/source/_posts/2018-05-18-release-70.markdown
@@ -53,7 +53,7 @@ Another cool one this release is [Facebox][image_processing.facebox docs]. It wi
Experiencing issues introduced by this release? Please report them in our [issue tracker](https://github.com/home-assistant/home-assistant/issues). Make sure to fill in all fields of the issue template.
-## Breaking Changes
+## Backward-incompatible changes
- Converted SABnzbd to a component. Set it up using the new config:
```yaml
diff --git a/source/_posts/2018-06-10-release-71.markdown b/source/_posts/2018-06-10-release-71.markdown
index 07605e0045e..aedc981684c 100644
--- a/source/_posts/2018-06-10-release-71.markdown
+++ b/source/_posts/2018-06-10-release-71.markdown
@@ -53,7 +53,7 @@ Have a good weekend everyone!
Experiencing issues introduced by this release? Please report them in our [issue tracker](https://github.com/home-assistant/home-assistant/issues). Make sure to fill in all fields of the issue template.
-## Breaking Changes
+## Backward-incompatible changes
- BOM sensor: `'Wind Direction kt'` to `'Wind Speed kt'` (fixes #14535) ([@fabaff] - [#14541]) (breaking change)
- Removed attribute current_time from Raincloudy sensors to avoid being triggered by recorder component ([@tchellomello] - [#14584]) ([raincloud docs]) ([switch.raincloud docs]) (breaking change)
diff --git a/source/_posts/2018-06-22-release-72.markdown b/source/_posts/2018-06-22-release-72.markdown
index d9452c98eeb..783fb10bdfa 100644
--- a/source/_posts/2018-06-22-release-72.markdown
+++ b/source/_posts/2018-06-22-release-72.markdown
@@ -73,7 +73,7 @@ Enjoy this release and have a good weekend all!
Experiencing issues introduced by this release? Please report them in our [issue tracker](https://github.com/home-assistant/home-assistant/issues). Make sure to fill in all fields of the issue template.
-## Breaking Changes
+## Backward-incompatible changes
- For developers of custom panel: Remove ability to register panels directly with the frontend component. Register with custom panel component instead. ([@balloob] - [#14805]) ([frontend docs]) (breaking change)
- Rename Hive hub friendly name to include "Hive" name ([@SteveEdson] - [#14747]) ([sensor.hive docs]) (breaking change)
diff --git a/source/_posts/2018-07-06-release-73.markdown b/source/_posts/2018-07-06-release-73.markdown
index 7f8e8a8e05e..b61e02d66e2 100644
--- a/source/_posts/2018-07-06-release-73.markdown
+++ b/source/_posts/2018-07-06-release-73.markdown
@@ -40,7 +40,7 @@ And last but not least, [@Klikini] has upgraded Rachio support from cloud pollin
Experiencing issues introduced by this release? Please report them in our [issue tracker](https://github.com/home-assistant/home-assistant/issues). Make sure to fill in all fields of the issue template.
-## Breaking Changes
+## Backward-incompatible changes
- The `pi_hole` sensor is now limited to `ads_blocked_today` by default and will no longer show all available data. Use [`monitored_conditions`](/integrations/pi_hole#monitored_conditions) to list the sensors you want. ([@fabaff] - [#15014]) ([sensor.pi_hole docs]) (breaking change)
- Update PostNL unit of measure to `packages` to align with UPS ([@keesschollaart81] - [#15023]) (breaking change)
diff --git a/source/_posts/2018-07-21-release-74.markdown b/source/_posts/2018-07-21-release-74.markdown
index 6fa4184516e..4a95a4a7086 100644
--- a/source/_posts/2018-07-21-release-74.markdown
+++ b/source/_posts/2018-07-21-release-74.markdown
@@ -63,7 +63,7 @@ I'm happy to announce that this release introduces support for Tuya thanks to [@
Experiencing issues introduced by this release? Please report them in our [issue tracker](https://github.com/home-assistant/home-assistant/issues). Make sure to fill in all fields of the issue template.
-## Breaking Changes
+## Backward-incompatible changes
- Fixer.io has changed their API and now requires an API key. (fixes #14911) ([@fabaff] - [#15279]) ([sensor.fixer docs]) (breaking change)
- Add support to use HTTPS URLs to SynologyDSM and make it the default ([@tchellomello] - [#15270]) ([sensor.synologydsm docs]) (breaking change)
diff --git a/source/_posts/2018-08-03-release-75.markdown b/source/_posts/2018-08-03-release-75.markdown
index c766bc82135..2695488c6f6 100644
--- a/source/_posts/2018-08-03-release-75.markdown
+++ b/source/_posts/2018-08-03-release-75.markdown
@@ -66,7 +66,7 @@ This release also includes a bunch more Tuya integrations thanks to [@huangyupen
Experiencing issues introduced by this release? Please report them in our [issue tracker](https://github.com/home-assistant/home-assistant/issues). Make sure to fill in all fields of the issue template.
-## Breaking Changes
+## Backward-incompatible changes
- Moon sensor states are now lowercase with underscores instead of spaces, allowing it to be translated in the frontend. ([@pvizeli] - [#15498]) ([sensor.moon docs]) (breaking change)
- Insteon Mini-Remote now emit events instead of show as a binary sensor ([@teharris1] - [#15523]) ([insteon_plm docs]) ([binary_sensor.insteon_plm docs]) ([switch.insteon_plm docs]) (breaking change)
diff --git a/source/_posts/2018-08-17-release-76.markdown b/source/_posts/2018-08-17-release-76.markdown
index 2d8803b283e..b4ea6741b8a 100644
--- a/source/_posts/2018-08-17-release-76.markdown
+++ b/source/_posts/2018-08-17-release-76.markdown
@@ -88,14 +88,14 @@ Experiencing issues introduced by this release? Please report them in our [issue
-## Breaking Changes
+## Backward-incompatible changes
- Keenetic NDMS: user needs to have access to the TelNet interface ([@foxel] - [#15511]) ([device_tracker docs]) (breaking change)
- openweathermap: wind speed is now correctly in km/h (fixes #15710) ([@fabaff] - [#15740]) ([weather.openweathermap docs]) (breaking change)
- Remove Telstra notifiy component: This API has been decommissioned on the 31st of May 2018 by Telstra ([@dgomes] - [#15757]) ([notify docs]) (breaking change)
- deCONZ - support for power plugs. Power plugs that are of type "On/Off plug-in unit" and "Smart plug" (Osram and Innr among others) will now be switches instead of lights. Entities will be found as switch.entity_id instead of light.entity_id. ([@Kane610] - [#15752]) ([deconz docs]) ([light.deconz docs]) ([switch.deconz docs]) (breaking change) (new-platform)
- HTTP: Make sure use_x_forward_for and trusted_proxies must be configured together ([@awarecan] - [#15804]) ([http docs]) (breaking change)
-- Velbus: Breaking changes include auto-discovery support so that you don't need to specify modules manually anymore in the configuration file, but just load the velbus component which will automatically load the switch and binary_sensor platforms. In addition, the fan and light platforms are removed since these should be modeled with template platform based on velbus switches. ([@thomasdelaet] - [#13742]) ([velbus docs]) ([binary_sensor.velbus docs]) ([switch.velbus docs]) (breaking change)
+- Velbus: Backward-incompatible changes include auto-discovery support so that you don't need to specify modules manually anymore in the configuration file, but just load the velbus component which will automatically load the switch and binary_sensor platforms. In addition, the fan and light platforms are removed since these should be modeled with template platform based on velbus switches. ([@thomasdelaet] - [#13742]) ([velbus docs]) ([binary_sensor.velbus docs]) ([switch.velbus docs]) (breaking change)
- Facebox: Events are no longer fired when a face is taught, as these are unnecessary and the info they convey is already in the logs. ([@robmarkcole] - [#15439]) ([image_processing.facebox docs]) (breaking change)
- AMCrest switch: Fix for multiple camera switches naming of entity. May change switch entity_id. Please check your automation and update the identity-id if you have previously assigned a name to your camera as it appends the name of the camera to the switch id. ([@rafale77] - [#14028]) ([switch.amcrest docs]) (breaking change)
- MQTT embedded broker will no longer rely on HTTP API password to automatically configure itself. You need to set own password. ([@awarecan] - [#15929]) ([mqtt docs]) (breaking change) (beta fix)
diff --git a/source/_posts/2018-08-29-release-77.markdown b/source/_posts/2018-08-29-release-77.markdown
index 1645ebb8e06..c3f429e4c6a 100644
--- a/source/_posts/2018-08-29-release-77.markdown
+++ b/source/_posts/2018-08-29-release-77.markdown
@@ -103,7 +103,7 @@ Experiencing issues introduced by this release? Please report them in our [issue
-## Breaking Changes
+## Backward-incompatible changes
- Enable auth by default 🙈. It is no longer possible to access Home Assistant without authentication ([@balloob] - [#16107]) (breaking change)
- It's no longer possible to use a trusted network to connect to the websocket API. You need to get a token and use that to connect. ([@awarecan] - [#15812]) ([auth docs]) ([http docs]) ([websocket_api docs]) (breaking change)
diff --git a/source/_posts/2018-09-15-release-78.markdown b/source/_posts/2018-09-15-release-78.markdown
index ccb1ef46375..fd6b7605b2e 100644
--- a/source/_posts/2018-09-15-release-78.markdown
+++ b/source/_posts/2018-09-15-release-78.markdown
@@ -72,7 +72,7 @@ Experiencing issues introduced by this release? Please report them in our [issue
-## Breaking Changes
+## Backward-incompatible changes
- Trafikverket weather: Instead of having multiple sensor configurations per station, add only one configuration per station and select the type of measurement data to subscribe to using monitored_conditions.
The configuration value type should no longer be used. ([@endor-force] - [#15935]) ([sensor.trafikverket_weatherstation docs]) (breaking change)
diff --git a/source/_posts/2018-10-01-release-79.markdown b/source/_posts/2018-10-01-release-79.markdown
index 16630f1077a..c3674ae3a92 100644
--- a/source/_posts/2018-10-01-release-79.markdown
+++ b/source/_posts/2018-10-01-release-79.markdown
@@ -111,7 +111,7 @@ Experiencing issues introduced by this release? Please report them in our [issue
-## Breaking Changes
+## Backward-incompatible changes
- Netdata configuration change: Allows multiple elements per group. Specify the `data_group` as part of the sensor description. See docs for details. ([@reefab] - [#16656]) ([sensor.netdata docs]) (breaking change)
- The Dyson sensor Air Quality Index is now named AQI following Dyson's mobile app ([@glpatcern] - [#14550]) ([sensor.dyson docs]) (breaking change)
diff --git a/source/_posts/2018-10-12-release-80.markdown b/source/_posts/2018-10-12-release-80.markdown
index 333b0e7e0de..119d27ccd18 100644
--- a/source/_posts/2018-10-12-release-80.markdown
+++ b/source/_posts/2018-10-12-release-80.markdown
@@ -117,7 +117,7 @@ Experiencing issues introduced by this release? Please report them in our [issue
-## Breaking Changes
+## Backward-incompatible changes
- Add additional Netatmo public data sensors ([@GP8x] - [#16671]) ([netatmo docs]) ([sensor.netatmo_public docs]) (breaking change)
- Developers only: we have removed all service helpers (like turn_on method in light coponent), as they werent used. ([@cdce8p] - [#16832], [#16879], [#16863], [#16892], [#16920], [#17038], [#17055], [#16917])
diff --git a/source/_posts/2018-10-29-release-81.markdown b/source/_posts/2018-10-29-release-81.markdown
index edcf6d16646..1ab96fe6a52 100644
--- a/source/_posts/2018-10-29-release-81.markdown
+++ b/source/_posts/2018-10-29-release-81.markdown
@@ -141,7 +141,7 @@ Experiencing issues introduced by this release? Please report them in our [issue
-## Breaking Changes
+## Backward-incompatible changes
- LIFX can now be configured from the integrations page in the config panel and advanced configuration is available through the `lifx:` component configuration. Configuring LIFX via light platform config no longer works. ([@amelchio] - [#17201]) ([lifx docs]) ([light.lifx docs]) (breaking change)
- Daikin Climate now follows the official operating modes, making it compatible with Google Assistant, Alexa and HomeKit. ([@MatteGary] - [#16913]) ([climate.daikin docs]) (breaking change)
diff --git a/source/_posts/2018-11-08-release-82.markdown b/source/_posts/2018-11-08-release-82.markdown
index f216d52dcb1..25847df39a4 100644
--- a/source/_posts/2018-11-08-release-82.markdown
+++ b/source/_posts/2018-11-08-release-82.markdown
@@ -89,7 +89,7 @@ Experiencing issues introduced by this release? Please report them in our [issue
-## Breaking Changes
+## Backward-incompatible changes
- Migrate Mailgun to use the webhook component ([@rohankapoorcom] - [#17464]) ([ifttt docs]) ([mailgun docs]) ([notify docs]) ([automation.webhook docs]) (breaking change)
- Migrate twilio webhooks to the webhook component ([@rohankapoorcom] - [#17715]) ([twilio docs]) (breaking change)
diff --git a/source/_posts/2018-11-28-release-83.markdown b/source/_posts/2018-11-28-release-83.markdown
index 0265e82807a..afda0777521 100644
--- a/source/_posts/2018-11-28-release-83.markdown
+++ b/source/_posts/2018-11-28-release-83.markdown
@@ -159,7 +159,7 @@ Experiencing issues introduced by this release? Please report them in our [issue
-## Breaking Changes
+## Backward-incompatible changes
- OwnTracks is now using config entries. To set it up, go to the configuration panel and configure it there. When configured and MQTT is available, will automatically listen there too. **You must remove the old device tracker before upgrading** ([@kirichkov] - [#17034]) ([@balloob] - [#18759]) ([owntracks docs]) (breaking change)
- Removes melissa sensors (they should be state attributes as implemented in #18201) ([@kennedyshead] - [#18214]) ([melissa docs]) (breaking change)
diff --git a/source/_posts/2018-12-12-release-84.markdown b/source/_posts/2018-12-12-release-84.markdown
index 042ad8a851a..047b612fe88 100644
--- a/source/_posts/2018-12-12-release-84.markdown
+++ b/source/_posts/2018-12-12-release-84.markdown
@@ -47,7 +47,7 @@ So if you were using Lovelace before 0.84, you now have two options. Option one
If you want to continue managing a YAML file, [check here how to enable the YAML mode](/dashboards/yaml-mode/). The file `ui-lovelace.yaml` will now follow the same options as `configuration.yaml`. This means that the Lovelace YAML config is now parsed with YAML 1.1 instead of YAML 1.2. Major change is that you need to make sure that you wrap `on` and `off` with quotes in your configs!
-We have also aligned the configuration of all the cards, causing breaking changes. Changes are especially focused around how we define actions for short and long presses. See [the docs](/dashboards/changelog/) for more info.
+We have also aligned the configuration of all the cards, causing backward-incompatible changes. Changes are especially focused around how we define actions for short and long presses. See [the docs](/dashboards/changelog/) for more info.
Editor UI is now further processed. You can manage your Lovelace UI without leaving your browser! It is possible to add, edit and delete views. It is possible to add, edit, move and delete cards, including custom cards!
@@ -177,7 +177,7 @@ Experiencing issues introduced by this release? Please report them in our [issue
-## Breaking Changes
+## Backward-incompatible changes
- State restoration will not work the first time you start 0.84. ([@armills] - [#17270]) ([history docs])
- Support for multiple IHC controllers added. Manual IHC device configuration must be moved from platform sections to controller configuration section under the ihc component section. ([@mopolus] - [#18058]) ([ihc docs]) ([binary_sensor.ihc docs]) ([light.ihc docs]) ([switch.ihc docs]) (breaking change)
diff --git a/source/_posts/2019-01-09-release-85.markdown b/source/_posts/2019-01-09-release-85.markdown
index 5df201fa22f..2711923ffd3 100644
--- a/source/_posts/2019-01-09-release-85.markdown
+++ b/source/_posts/2019-01-09-release-85.markdown
@@ -78,7 +78,7 @@ Experiencing issues introduced by this release? Please report them in our [issue
-## Breaking Changes
+## Backward-incompatible changes
- Targeting all entities in a domain by not sending an entity_id to a service is now deprecated. Instead, send `entity_id: all` if you want to target all. The old method will work for a couple of releases more, but will print a warning. Please migrate. ([@balloob] - [#19006]) (breaking change)
- The default interval of the weather component was aligned with the sensor component and is now 30 seconds instead of 15 seconds. ([@fabaff] - [#19186]) ([weather docs]) (breaking change)
diff --git a/source/_posts/2019-01-23-release-86.markdown b/source/_posts/2019-01-23-release-86.markdown
index 6c414d78bea..cf27f6fb05f 100644
--- a/source/_posts/2019-01-23-release-86.markdown
+++ b/source/_posts/2019-01-23-release-86.markdown
@@ -36,11 +36,11 @@ The Zigbee team is also planning a bunch of cool things for 2019. Direct device
Screenshot of the Zigbee management panel.
-## Noteworthy breaking changes
+## Noteworthy backward-incompatible changes
Update: the entity ID one was too harsh, it's now a warning.
-This release also includes two noteworthy breaking changes. One is a follow-up on the slugify breaking change from last release. We did not update the validation check for config options that need to be valid slugs. This means that some of your config values might be invalid. Keep an eye at the console as we have a new message to tell you which ones are wrong.
+This release also includes two noteworthy backward-incompatible changes. One is a follow-up on the slugify breaking change from last release. We did not update the validation check for config options that need to be valid slugs. This means that some of your config values might be invalid. Keep an eye at the console as we have a new message to tell you which ones are wrong.
The following things are not allowed in entity IDs:
@@ -126,7 +126,7 @@ Experiencing issues introduced by this release? Please report them in our [issue
-## Breaking Changes
+## Backward-incompatible changes
- Automation: Split time_pattern triggers from time trigger ([@armills] - [#19825]) ([automation.interval docs]) ([automation.time docs]) (breaking change)
- Each instance of Home Assistant will now generate it's own unique webhook url for Geofencyto use. One will need to be generated and provided to the iOS app to replace the existing url: `https://myhome.duckdns.org/api/geofency?api_password=HA_PASSWORD` ([@rohankapoorcom] - [#18951]) ([geofency docs]) (breaking change)
diff --git a/source/_posts/2019-02-06-release-87.markdown b/source/_posts/2019-02-06-release-87.markdown
index d7c307ab935..10f719db655 100644
--- a/source/_posts/2019-02-06-release-87.markdown
+++ b/source/_posts/2019-02-06-release-87.markdown
@@ -92,7 +92,7 @@ Experiencing issues introduced by this release? Please report them in our [issue
-## Breaking Changes
+## Backward-incompatible changes
- SolarEdge sensors: This PR changes the **entity names** of this sensor and the **monitoring condition keys** in the configuration: `sensor.solaredge_current_power` -> `sensor.solaredge_current_power`, `sensor.solaredge_last_day_data` -> `sensor.solaredge_energy_today`, `sensor.solaredge_last_month_data` -> `sensor.solaredge_energy_this_month`, `sensor.solaredge_last_year_data` -> `sensor.solaredge_energy_this_year`, `sensor.solaredge_life_time_data` -> `sensor.solaredge_lifetime_energy`, ([@LouisMT] - [#20109]) ([sensor.solaredge docs]) (breaking change)
- Geolocation is no longer creating a default group. ([@exxamalte] - [#20338]) ([geo_location docs]) (breaking change)
diff --git a/source/_posts/2019-02-20-release-88.markdown b/source/_posts/2019-02-20-release-88.markdown
index ba64fbbf19f..dfa6773624c 100644
--- a/source/_posts/2019-02-20-release-88.markdown
+++ b/source/_posts/2019-02-20-release-88.markdown
@@ -25,7 +25,7 @@ We also have a new command line auth provider. This will allow you to use a shel
[@andrewsayre] has been working hard on extending the SmartThings support. This release brings sensors and climate devices into the mix. Awesome!
-## Noteworthy breaking changes
+## Noteworthy backward-incompatible changes
We have tightened config validation, so expect a couple of new warnings. Platform configuration will no longer allow to contain keys that are not supported. This should help with finding typos in your current and future YAML configs. This will currently fallback to a warning and will become a full error in the future.
@@ -130,7 +130,7 @@ Experiencing issues introduced by this release? Please report them in our [issue
-## Breaking Changes
+## Backward-incompatible changes
- Split googlehome to a component with device tracker platform ([@ludeeus] - [#19971]) ([device_tracker docs]) ([googlehome docs]) (breaking change) (new-platform)
- Support for new velux api, added cover.velux ([@Julius2342] - [#18738]) ([velux docs]) ([cover.velux docs]) (breaking change) (new-feature) (new-platform)
diff --git a/source/_posts/2019-03-13-release-89.markdown b/source/_posts/2019-03-13-release-89.markdown
index 110d3b1cf53..42fa6a5d75c 100644
--- a/source/_posts/2019-03-13-release-89.markdown
+++ b/source/_posts/2019-03-13-release-89.markdown
@@ -17,7 +17,7 @@ It's time for release 0.89. It's another great new release with some cool new fe
This release introduces a new mobile app component. [@robbiet480], who also works on the iOS app, has taken the best parts of the Home Assistant iOS app component and turned it into a standardized API that any mobile app can build upon. This will allow any mobile apps to integrate with Home Assistant with a great user experience. If you are a mobile app developer, please check the updated [app integration docs](https://developers.home-assistant.io/docs/api/native-app-integration/). We will be fine tuning the API in upcoming releases. Feedback is welcome.
-## Noteworthy Breaking Changes
+## Noteworthy backward-incompatible changes
__Custom Components file structure change:__ A significant change in how the "under the hood" of Home Assistant works has led to forcing platforms to be resolved based off the component path, if it exists.
@@ -121,7 +121,7 @@ Experiencing issues introduced by this release? Please report them in our [issue
-## Breaking Changes
+## Backward-incompatible changes
- __HomeMatic component's wireless actors__ are having two RSSI values. The way the component was programmed one of them was being overwritten. With this new change, the __`rssi` attribute of HomeMatic entities has been removed.__ As a replacement the attributes rssi_device and rssi_peer have been added. The attribute of `rssi` will no longer be available, you'll need to __update to `rssi_device`,__ and you can add `rssi_peer` now as well! (fixes #20900) ([@dagobert] - [#20902]) ([homematic docs]) (breaking change)
- You can now specifiy an action when calling the __yeelight_start_flow service__ on your yeelights. The __default action will be 'recover'__ if you do not specify something else. This action will be taken after the flow stops. ([@zewelor] - [#21195]) ([light.yeelight docs]) (breaking change)
@@ -133,7 +133,7 @@ Experiencing issues introduced by this release? Please report them in our [issue
- Add ADB server functionality to __Fire TV.__ This change __removes the `get_source`__ configuration option. ([@JeffLIrion] - [#21221]) ([media_player.firetv docs]) (breaking change)
- With the addition of the __SmartThings Cover__ platform, the SmartThings __Sensor platform will no longer represent Door, Garage Door and Window Share attributes.__ Additionally, if the cover device reports battery status, the value will be present as a __state attribute__ (battery_level) and not a discrete sensor. ([@andrewsayre] - [#21192]) ([cover docs]) ([smartthings docs]) (breaking change) (new-platform)
- The __Toon component__ was broken some time ago, so now requires a Toon API developer account and __can be configured using the Home Assistant integrations.__ Support for Switches & Smoke detectors has been removed. ([@frenck] - [#21186]) ([toon docs]) (breaking change) (new-platform)
-- Addition of config for __trusted networks auth provider.__ It is a breaking changes for users who __manually configured__ trusted network auth provider. An invalid config error will be thrown and HA won't be able to fully started. (It is NOT a breaking changes for user who didn't manual configured trusted network auth provider.) ([@awarecan] - [#21111]) (breaking change)
+- Addition of config for __trusted networks auth provider.__ It is a backward-incompatible changes for users who __manually configured__ trusted network auth provider. An invalid config error will be thrown and HA won't be able to fully started. (It is NOT a backward-incompatible changes for user who didn't manual configured trusted network auth provider.) ([@awarecan] - [#21111]) (breaking change)
- For some __HomeMatic devices the `sabotage` attribute is replaced by `error`.__ The value (if not 0) is a device specific error code. ([@dagobert] - [#21009]) ([homematic docs]) (breaking change)
## Beta Fixes
diff --git a/source/_posts/2019-03-20-release-90.markdown b/source/_posts/2019-03-20-release-90.markdown
index 08d177cda57..69242aeefb5 100644
--- a/source/_posts/2019-03-20-release-90.markdown
+++ b/source/_posts/2019-03-20-release-90.markdown
@@ -138,7 +138,7 @@ Experiencing issues introduced by this release? Please report them in our [issue
-## Breaking Changes
+## Backward-incompatible changes
- __http.api_password__ - __Deprecated__ - Users who are still using api_password for authentication will need to move its configuration under auth_providers. Please see the [updated documentation](/docs/authentication/providers/#legacy-api-password) for further details. Those who don't make this change will see an INFO level reminder in the Home Assistant logs until the fix is made for a time, but please note, __api_password authentication will eventually be removed completely__ and we advise users to change to use one of the [other authentication methods](/docs/authentication/providers/#available-auth-providers). If you manually specify auth providers in your `configuration.yaml`, you will need to migrate your API Password from the http section to the auth provider section to continue using it. ([@awarecan] - [#21884]) ([api docs]) ([frontend docs]) ([hassio docs]) ([http docs]) ([mqtt docs]) ([websocket_api docs]) ([zeroconf docs]) ([camera.proxy docs])
- __Default Config__ - Default config no longer contains the discovery component. That is now part of the initial written configuration.yaml. If you rely on default config and want to use discovery, add `discovery:` back to your configuration.yaml.
diff --git a/source/_posts/2019-04-03-release-91.markdown b/source/_posts/2019-04-03-release-91.markdown
index 4af3430ae19..e7888a2fbbd 100644
--- a/source/_posts/2019-04-03-release-91.markdown
+++ b/source/_posts/2019-04-03-release-91.markdown
@@ -196,7 +196,7 @@ Experiencing issues introduced by this release? Please report them in our [issue
-## Breaking Changes
+## Backward-incompatible changes
- __Z-Wave__ - The usb_path in configuration.yaml now overrides config entry usb_path. This is potentially a breaking change if people have a stale usb_path setting in configuration.yaml that's no longer accurate. This should help reduce the number of people that need to manually edit the storage/core.config_entries file if their usb_path changes. ([@cgarwood] - [#22038]) ([zwave docs])
diff --git a/source/_posts/2019-04-24-release-92.markdown b/source/_posts/2019-04-24-release-92.markdown
index d4d21167a27..0f129b1f3ce 100644
--- a/source/_posts/2019-04-24-release-92.markdown
+++ b/source/_posts/2019-04-24-release-92.markdown
@@ -167,7 +167,7 @@ Experiencing issues introduced by this release? Please report them in our [issue
-## Breaking Changes
+## Backward-incompatible changes
- __Google Assistant__ - You will now have to say a pin code before being able to control locks, doors and garage doors. You can set this pin in configuration -> cloud or, for manual installs, add `secure_devices_pin` to your config. ([@balloob] - [#23223]) ([cloud docs]) ([google_assistant docs]) (breaking change) (beta fix)
- __Google Assistant__ - Migrate light setting trait to use HSV color spectrum. If you have lights with colors, please run a Google Assistant SYNC after you update to this version. It will result in improved color representation. ([@balloob] - [#22980]) ([google_assistant docs])
diff --git a/source/_posts/2019-05-16-release-93.markdown b/source/_posts/2019-05-16-release-93.markdown
index 4624a7f75b8..7ce45b7359c 100644
--- a/source/_posts/2019-05-16-release-93.markdown
+++ b/source/_posts/2019-05-16-release-93.markdown
@@ -153,7 +153,7 @@ Experiencing issues introduced by this release? Please report them in our [issue
-## Breaking Changes
+## Backward-incompatible changes
- __Homematic IP Cloud__ - Adds homematicip cloud temperature sensor from thermostats. Entity IDs of HmIP-SLO (Light Sensor Outdoor) will change and stale entities will need to be removed from the entity registry. ([@SukramJ] - [#23263]) ([homematicip_cloud docs])
- __Pollen.com__
@@ -368,7 +368,7 @@ Experiencing issues introduced by this release? Please report them in our [issue
- Update docstrings ([@fabaff] - [#23624]) ([panasonic_bluray docs])
- Order imports ([@fabaff] - [#23623]) ([opple docs])
- Polling is default ([@fabaff] - [#23622]) ([serial_pm docs])
-- Loosen discovery config validation to avoid breaking changes ([@Jc2k] - [#23625]) ([discovery docs])
+- Loosen discovery config validation to avoid backward-incompatible changes ([@Jc2k] - [#23625]) ([discovery docs])
- Clean up redundant same-package ..package imports ([@scop] - [#23587]) ([greeneye_monitor docs]) ([huawei_lte docs]) ([tplink_lte docs])
- Upgrade pytest to 4.4.1 ([@scop] - [#23584])
- Upgrade mypy ([@scop] - [#23586])
diff --git a/source/_posts/2019-06-05-release-94.markdown b/source/_posts/2019-06-05-release-94.markdown
index f958180dba9..14049a6b421 100644
--- a/source/_posts/2019-06-05-release-94.markdown
+++ b/source/_posts/2019-06-05-release-94.markdown
@@ -184,7 +184,7 @@ Because of this, we changed how packages are installed when running Home Assista
Experiencing issues introduced by this release? Please report them in our [issue tracker](https://github.com/home-assistant/home-assistant/issues). Make sure to fill in all fields of the issue template.
-## Breaking Changes
+## Backward-incompatible changes
- __Sun__ - Inspired by a [reddit](https://www.reddit.com/r/homeassistant/comments/bm62hl/sunsun_chatty_sensor_psa/) report, the sun.sun sensor has been tuned so that it doesn't update nearly as frequently. Previously the sun.sun sensor was updating every 30 seconds, day and night. Now it updates dependent on the solar elevation. This could possibly be a breaking change for some users as it updates less frequently. ([@Swamp-Ig] - [#23832]) ([sun docs])
- __Doorbird__ -_Refactored_- This change cleans up the code for the component quite a bit. Schedule manipulation has been removed and HTTP views have been consolidated. The configuration changes should result in an overall easier experience for setting up a Doorbird in HA and allow for new Doorbird events to be utilized without having to update the component as often. No changes for switches or camera integrations of this component. ([@oblogic7] - [#23892]) ([doorbird docs])
diff --git a/source/_posts/2019-06-26-release-95.markdown b/source/_posts/2019-06-26-release-95.markdown
index 01632d16924..fee029afbdd 100644
--- a/source/_posts/2019-06-26-release-95.markdown
+++ b/source/_posts/2019-06-26-release-95.markdown
@@ -66,7 +66,7 @@ However, we didn't stop there. The [manual installations of Alexa](/integrations
-## Noteworthy breaking changes
+## Noteworthy backward-incompatible changes
For the last couple of releases, we've been printing warnings if your configuration contained invalid slugs or extra keys. Starting with this release, these warnings are now errors. No procrastination anymore, you'll need to fix it now.
@@ -167,7 +167,7 @@ Experiencing issues introduced by this release? Please report them in our [issue
-## Breaking Changes
+## Backward-incompatible changes
- No longer allow invalid slugs or extra keys ([@balloob] - [#24176]) (breaking change)
- Add service for adding event to google component ([@isabellaalstrom] - [#22473]) ([google docs]) (breaking change)
diff --git a/source/_posts/2019-07-17-release-96.markdown b/source/_posts/2019-07-17-release-96.markdown
index e51d050a1c9..711b3669d03 100644
--- a/source/_posts/2019-07-17-release-96.markdown
+++ b/source/_posts/2019-07-17-release-96.markdown
@@ -272,7 +272,7 @@ Experiencing issues introduced by this release? Please report them in our [issue
-## Breaking Changes
+## Backward-incompatible changes
- __OpenTherm__ - Adds support for more than one OpenTherm Gateway device which changes the configuration structure. ([@mvn23] - [#22932]) ([opentherm_gw docs])
diff --git a/source/_posts/2019-08-07-release-97.markdown b/source/_posts/2019-08-07-release-97.markdown
index 212e1ed25d7..dbb27cc06c9 100644
--- a/source/_posts/2019-08-07-release-97.markdown
+++ b/source/_posts/2019-08-07-release-97.markdown
@@ -145,7 +145,7 @@ Experiencing issues introduced by this release? Please report them in our [issue
-## Breaking Changes
+## Backward-incompatible changes
- **Python** - Bump Python support to min Python 3.6.0 ([@balloob] - [#25582])
- **Z-Wave** - Improve handling of Z-Wave config entry vs yaml config. If a Z-Wave `network_key` is specified in configuration.yaml it will override a `network_key` specified in the Z-Wave config entry. ([@cgarwood] - [#25112]) ([zwave docs])
diff --git a/source/_posts/2019-08-28-release-98.markdown b/source/_posts/2019-08-28-release-98.markdown
index 410fce47315..f88ad47bdfb 100644
--- a/source/_posts/2019-08-28-release-98.markdown
+++ b/source/_posts/2019-08-28-release-98.markdown
@@ -38,7 +38,7 @@ Screenshot of integration system options
## Config Entry Options
-We introduced config entries last year as our way as a generic way for integrations to store authentication and configuration. By allowing integrations to define the storage format, there are no more breaking changes for anything stored inside config entries!
+We introduced config entries last year as our way as a generic way for integrations to store authentication and configuration. By allowing integrations to define the storage format, there are no more backward-incompatible changes for anything stored inside config entries!
Config entries also work great with people who prefer configuration.yaml. At startup a config entry is created/updated with the configuration.
@@ -215,7 +215,7 @@ Experiencing issues introduced by this release? Please report them in our [issue
-## Breaking Changes
+## Backward-incompatible changes
- **Deprecated**
diff --git a/source/_posts/2019-09-18-release-99.markdown b/source/_posts/2019-09-18-release-99.markdown
index b623adfd537..bc0d80edda7 100644
--- a/source/_posts/2019-09-18-release-99.markdown
+++ b/source/_posts/2019-09-18-release-99.markdown
@@ -116,7 +116,7 @@ We also had some great drinks in the evenings with companies that integrate with
[@timmo] has released version 2.0 of his Home Panel. This is an alternative user interface for Home Assistant.
-
It's finally here. 🎉
Home Panel v2.0.0 is now released and has been completely rewritten in #React with #TypeScript
[@cogneato]: https://github.com/cogneato
@@ -191,7 +191,7 @@ Experiencing issues introduced by this release? Please report them in our [issue
-## Breaking Changes
+## Backward-incompatible changes
- **Unifi** - Removes support of directly configuring the UniFi platform for device trackers. Use `unifi:` instead. Extra configuration through config entry options from the GUI (see release notes 0.98 for example) and through unifi configuration in configuration.yaml will continue to work.- ([@Kane610] - [#26587]) ([unifi docs])
diff --git a/source/_posts/2019-10-10-release-100.markdown b/source/_posts/2019-10-10-release-100.markdown
index d090b5c9f92..547522673d7 100644
--- a/source/_posts/2019-10-10-release-100.markdown
+++ b/source/_posts/2019-10-10-release-100.markdown
@@ -196,7 +196,7 @@ Experiencing issues introduced by this release? Please report them in our [issue
-## Breaking Changes
+## Backward-incompatible changes
- **Removed** - The following integrations which were marked in .98 for pending removal have now been removed (ADR-0004):
- **UPS** - ([@frenck] - [#26824])
diff --git a/source/_posts/2019-10-30-release-101.markdown b/source/_posts/2019-10-30-release-101.markdown
index 9c16373a7f7..8847cf619d9 100644
--- a/source/_posts/2019-10-30-release-101.markdown
+++ b/source/_posts/2019-10-30-release-101.markdown
@@ -220,7 +220,7 @@ Experiencing issues introduced by this release? Please report them in our [issue
-## Breaking Changes
+## Backward-incompatible changes
- __Removed__ - The following integrations have been removed:
- __Direct authentication via trusted networks or API password__ - It is no longer possible to make authenticated requests using trusted networks or by appending ?api_password=X to the URL. You will now first need to get an authentication token and use that token to make requests. Auth providers for trusted networks and API passwords are still available. - ([@balloob] - [#27656]) ([auth docs]) ([http docs]) ([websocket_api docs])
diff --git a/source/_posts/2019-11-20-release-102.markdown b/source/_posts/2019-11-20-release-102.markdown
index a5b3a656fd9..b758b513953 100644
--- a/source/_posts/2019-11-20-release-102.markdown
+++ b/source/_posts/2019-11-20-release-102.markdown
@@ -134,7 +134,7 @@ Users of Xiaomi Vacuum cleaners can now use this great custom Lovelace card:
Experiencing issues introduced by this release? Please report them in our [issue tracker](https://github.com/home-assistant/home-assistant/issues). Make sure to fill in all fields of the issue template.
-## Breaking Changes
+## Backward-incompatible changes
- **Huawei LTE** - Configuration has been consolidated below `huawei_lte`. Device tracker no longer uses known_devices.yaml but entity registry. - ([@scop] - [#26675]) ([huawei_lte docs])
diff --git a/source/_posts/2019-12-11-release-103.markdown b/source/_posts/2019-12-11-release-103.markdown
index cab03b97767..efb70428ab3 100644
--- a/source/_posts/2019-12-11-release-103.markdown
+++ b/source/_posts/2019-12-11-release-103.markdown
@@ -176,7 +176,7 @@ The following platforms have been added to existing integrations:
- Add Huawei LTE binary sensor support, mobile connection sensor ([@scop] - [#28226]) ([huawei_lte docs]) (new-platform)
- Broadlink remote ([@felipediel] - [#26528]) ([broadlink docs]) (new-platform)
-## Breaking Changes
+## Backward-incompatible changes
If you are an existing user, make sure to read the this section **before** upgrading,
this helps you understand the changes and avoids having issues during an upgrade.
@@ -217,7 +217,7 @@ All services for use in Home Assistant are moved to their integration naming spa
- **Xiaomi Miio**: `*.xiaomi_*` -> `xiaomi_miio.*` ([#29134])
- **Yamaha**: `media_player.yamaha_*` -> `yamaha.*` ([#29142])
-### Other Breaking Changes
+### Other backward-incompatible changes
- **Mobile App** - Loading the Mobile App no longer causes the Cloud integration to be loaded. If you relied on this, add `cloud:` to your configuration.yaml. - ([@balloob] - [#29373]) ([mobile_app docs])
- **Samsung TV** - The behavior for next and previous track commands for Samsung TVs has changed. Before the change, the Samsung TV integration reacted to the two above commands sending the KEY_FF and KEY_REWIND commands. While watching TV programs, those two commands do nothing. After the change, the entity sends the KEY_CHUP and KEY_CHDOWN commands instead, thus allowing the user to change the channel using the media player standard Lovelace interface. The user doesn't need to change anything in the configuration. - ([@tulindo] - [#28213]) ([samsungtv docs])
diff --git a/source/_posts/2020-01-15-release-104.markdown b/source/_posts/2020-01-15-release-104.markdown
index 93686e3b782..f155bb05138 100644
--- a/source/_posts/2020-01-15-release-104.markdown
+++ b/source/_posts/2020-01-15-release-104.markdown
@@ -29,7 +29,7 @@ We are starting this new year with a packed release! So let us dive in!
- [In other news](/blog/2020/01/15/release-104/#in-other-news)
- [New Integrations](/blog/2020/01/15/release-104/#new-integrations)
- [New Platforms](/blog/2020/01/15/release-104/#new-platforms)
-- [Breaking Changes](/blog/2020/01/15/release-104/#breaking-changes)
+- [Backward-incompatible changes](/blog/2020/01/15/release-104/#backward-incompatible-changes)
- [Beta Fixes](/blog/2020/01/15/release-104/#beta-fixes)
- [All changes](/blog/2020/01/15/release-104/#all-changes)
@@ -89,7 +89,7 @@ Furthermore, time to say bye-bye, to all generated entity groups
(`group.all_*`). Chances are, you have never heard of those because they were
hidden. However, if you rely on those groups for your automations, you
need to adjust those automations.
-Check out the [breaking changes section](#breaking-changes) for more information.
+Check out the [backward-incompatible changes section](#backward-incompatible-changes) for more information.
## Add a device to Lovelace
@@ -215,7 +215,7 @@ Make sure to fill in all fields of the issue template, that is helping us a lot!
-## Breaking Changes
+## Backward-incompatible changes
- __Default groups__ - Entity integrations will no longer automatically maintain the hidden groups with all of their entities. The following groups are no longer automatically created and maintained:
diff --git a/source/_posts/2020-02-05-release-105.markdown b/source/_posts/2020-02-05-release-105.markdown
index 9e18d1b5fb3..d0e87c89c07 100644
--- a/source/_posts/2020-02-05-release-105.markdown
+++ b/source/_posts/2020-02-05-release-105.markdown
@@ -27,7 +27,7 @@ This means, it is now over a year ago that Lovelace was officially introduced as
If you are not using Lovelace yet, we advise you to switch to it today. Lovelace is, by default, almost the same as old states UI with the bonus of a lot of flexibility, if you want it.
-In addition to this, all configuration options for the States UI are deprecated as well. Please be sure to read the [breaking changes](#breaking-changes) to see if you have options that need to be removed from your configuration.
+In addition to this, all configuration options for the States UI are deprecated as well. Please be sure to read the [backward-incompatible changes](#backward-incompatible-changes) to see if you have options that need to be removed from your configuration.
## Safe mode
@@ -107,7 +107,7 @@ Screen recording of the zones editor.
The new editor will only work for zones that are created in the UI, zones that are set up in `configuration.yaml` are read-only.
-Additionally, if you define zones in your YAML configuration, please be aware that setting a [`name` is now required](#breaking-changes).
+Additionally, if you define zones in your YAML configuration, please be aware that setting a [`name` is now required](#backward-incompatible-changes).
As an extra added bonus, a new service was added: `zone.reload`. This service allows you to reload your zone configuration without restarting Home Assistant.
@@ -184,7 +184,7 @@ Experiencing issues introduced by this release? Please report them in our [issue
-## Breaking Changes
+## Backward-incompatible changes
- __Safe Mode__ - `--demo-mode` has been removed. A new safe mode has now been introduced, which loads the bare minimum necessary to load the Home Assistant frontend and allows for managing the configuration. This is not yet perfect. An invalid core configuration can still cause Home Assistant to refuse to start up. ([@balloob] - [#30723]) ([frontend docs]) ([http docs]) ([safe_mode docs])
diff --git a/source/_posts/2020-02-26-release-106.markdown b/source/_posts/2020-02-26-release-106.markdown
index 907c36289c2..7c6a28de150 100644
--- a/source/_posts/2020-02-26-release-106.markdown
+++ b/source/_posts/2020-02-26-release-106.markdown
@@ -145,7 +145,7 @@ Experiencing issues introduced by this release? Please report them in our [issue
-## Breaking Changes
+## Backward-incompatible changes
- **Tesla** - Tesla default scan interval has been raised to 660 seconds from 300 seconds. This is the result of new testing showing the prior default would not allow Tesla vehicles to fall asleep. You should reevaluate your scan interval if you have changed it, to avoid battery drain. The scan interval has had the minimum lowered to 60. - ([@alandtse] - [#31194]) ([tesla docs])
diff --git a/source/_posts/2020-03-18-release-107.markdown b/source/_posts/2020-03-18-release-107.markdown
index 6d4e29abf94..d87303da76f 100644
--- a/source/_posts/2020-03-18-release-107.markdown
+++ b/source/_posts/2020-03-18-release-107.markdown
@@ -162,7 +162,7 @@ Experiencing issues introduced by this release? Please report them in our [issue
-## Breaking Changes
+## Backward-incompatible changes
- **Xfinity Gateway** *(Deprecated)* - The Xfinity Gateway integration relies on web scraping and is deprecated, to be removed in Home Assistant Core 0.109. (ADR-0004) - ([@frenck] - [#32017])
diff --git a/source/_posts/2020-04-08-release-108.markdown b/source/_posts/2020-04-08-release-108.markdown
index fa4f4c8a5d2..3dec2e93b26 100644
--- a/source/_posts/2020-04-08-release-108.markdown
+++ b/source/_posts/2020-04-08-release-108.markdown
@@ -201,7 +201,7 @@ Experiencing issues introduced by this release? Please report them in our [issue
-## Breaking Changes
+## Backward-incompatible changes
- **Lovelace themes** - We discovered our theme logic was wrong, when you didn't specify a theme for a Lovelace card or view. It would default to the backend selected theme, even when your local theme was different, or your view had a different theme. To fix this we removed the options `default` and `Backend selected` from the Lovelace theme selection, and when there is not theme selected it will not set a theme. This will make sure the element has the same theme as its parent.
diff --git a/source/_posts/2020-04-14-the-future-of-yaml.markdown b/source/_posts/2020-04-14-the-future-of-yaml.markdown
index 588a354e1a5..f5689b82280 100644
--- a/source/_posts/2020-04-14-the-future-of-yaml.markdown
+++ b/source/_posts/2020-04-14-the-future-of-yaml.markdown
@@ -57,9 +57,9 @@ Goal: _**Making things easier.**_
The goal of making it easier is currently the main focus.
-## Breaking changes
+## Backward-incompatible changes
-We all dislike them, those breaking changes when a new release is published.
+We all dislike them, those backward-incompatible changes when a new release is published.
We all scan the release notes hoping you are not affected by any of them in
that release.
@@ -129,7 +129,7 @@ maintenance and support burden. The amount of energy that needs to be put in
understand and accept that. If we do not do that, a contributor could simply
stop contributing.
-Unfortunately, such a move creates breaking changes and often leads to a few
+Unfortunately, such a move creates backward-incompatible changes and often leads to a few
pretty de-motivating comments, towards the contributor and the project in
general. This is harmful to everybody, as the contributors get demotivated or,
even worse, don’t want to implement new features or create a breaking change.
diff --git a/source/_posts/2020-04-29-release-109.markdown b/source/_posts/2020-04-29-release-109.markdown
index 12f7c254802..44cd623f8bb 100644
--- a/source/_posts/2020-04-29-release-109.markdown
+++ b/source/_posts/2020-04-29-release-109.markdown
@@ -189,7 +189,7 @@ Experiencing issues introduced by this release? Please report them in our [issue
-## Breaking Changes
+## Backward-incompatible changes
- **Flu Near You** - This integration is now available to be added from the UI.
The `monitored_conditions` setting has been removed. You will need to
diff --git a/source/_posts/2020-05-20-release-110.markdown b/source/_posts/2020-05-20-release-110.markdown
index e608767b0ef..ab428079abc 100644
--- a/source/_posts/2020-05-20-release-110.markdown
+++ b/source/_posts/2020-05-20-release-110.markdown
@@ -299,7 +299,7 @@ you've enabled advanced mode on your user profile.
happens, it will be prevented and write an error message to your log,
similar to how the I/O detection does it (released in [0.109](/blog/2020/04/29/release-109/#detection-of-blocking-io-in-the-event-loop)).
-- The ISY994 got a major upgrade! While it has quite a few breaking changes, it
+- The ISY994 got a major upgrade! While it has quite a few backward-incompatible changes, it
is now available via the UI and many bug are squashed. Thanks [@shbatm]!
## New Integrations
@@ -353,7 +353,7 @@ Experiencing issues introduced by this release? Please report them in our [issue
-## Breaking Changes
+## Backward-incompatible changes
- **Manual Alarm Panel** - When going from state `disarmed` to any other (armed)
state such as `armed_away`, the state will be `arming` instead of `pending` during
@@ -512,10 +512,10 @@ Experiencing issues introduced by this release? Please report them in our [issue
significant update to the original module used to communicate with the ISY.
([@shbatm] - [#35212], [#35338], [#35413], [#35391] ) ([isy994 docs])
- As part of the update and many bug fixes, some breaking changes were introduced:
+ As part of the update and many bug fixes, some backward-incompatible changes were introduced:
- Click see all breaking changes for ISY994
+ Click see all backward-incompatible changes for ISY994
- Remove ISY Climate Module support: the ISY Climate Module was retired by
UDI on 3/30/2020: UDI Announcement, support has been removed from the module,
diff --git a/source/_posts/2020-06-10-release-111.markdown b/source/_posts/2020-06-10-release-111.markdown
index 47185392745..1a44b073180 100644
--- a/source/_posts/2020-06-10-release-111.markdown
+++ b/source/_posts/2020-06-10-release-111.markdown
@@ -154,7 +154,7 @@ Experiencing issues introduced by this release? Please report them in our [issue
-## Breaking Changes
+## Backward-incompatible changes
- **Frontend**
diff --git a/source/_posts/2020-07-01-release-112.markdown b/source/_posts/2020-07-01-release-112.markdown
index dd83010e610..37311c10488 100644
--- a/source/_posts/2020-07-01-release-112.markdown
+++ b/source/_posts/2020-07-01-release-112.markdown
@@ -288,7 +288,7 @@ Experiencing issues introduced by this release? Please report them in our [issue
-## Breaking Changes
+## Backward-incompatible changes
- **Tile**
@@ -322,7 +322,7 @@ Experiencing issues introduced by this release? Please report them in our [issue
- **Xiaomi Miio**
- Due to general code updates to the xiaomi_miio vacuum component there are breaking changes to the following services:
+ Due to general code updates to the xiaomi_miio vacuum component there are backward-incompatible changes to the following services:
- `xiaomi_miio.vacuum_remote_control_start`
- `xiaomi_miio.vacuum_remote_control_stop`
@@ -514,7 +514,7 @@ Previously the `autobypass` configuration option only worked for `home` and `awa
- **Hunter Hydrawise**
- Hydrawise made an API change that removed rain sensor status, changed the behavior of the automatic watering switches, and the way in which the watering schedule is reported. As a result, the following breaking changes were made.
+ Hydrawise made an API change that removed rain sensor status, changed the behavior of the automatic watering switches, and the way in which the watering schedule is reported. As a result, the following backward-incompatible changes were made.
- The rain sensor is no longer available.
- The `auto_watering` switch state now reports `off` when the corresponding watering zone is actively watering. If `auto_watering` is enabled the switch status will report `off` when watering starts and will return to `on` when watering stops in that zone.
diff --git a/source/_posts/2020-07-01-release-113.markdown b/source/_posts/2020-07-01-release-113.markdown
index 39f4da2d98f..098cb7aa996 100644
--- a/source/_posts/2020-07-01-release-113.markdown
+++ b/source/_posts/2020-07-01-release-113.markdown
@@ -330,7 +330,7 @@ every 10 seconds. This is ideal for things like a doorbell.
It has taken some time for us to upgrade to the newest version of
[Material Design Icons][mdi], 5.3.45, there was a reason for that,
-version [5.0.45][mdi-upgrade] contains a lot of breaking changes.
+version [5.0.45][mdi-upgrade] contains a lot of backward-incompatible changes.
We wanted to handle these well, so it took some time.
@@ -444,7 +444,7 @@ Experiencing issues introduced by this release? Please report them in our [issue
-## Breaking Changes
+## Backward-incompatible changes
Below is a listing of the breaking change for this release, per subject or
integration. Click on one of those to read more about the breaking change
diff --git a/source/_posts/2020-08-12-release-114.markdown b/source/_posts/2020-08-12-release-114.markdown
index 321cb768781..d72e013ba52 100644
--- a/source/_posts/2020-08-12-release-114.markdown
+++ b/source/_posts/2020-08-12-release-114.markdown
@@ -231,7 +231,7 @@ Experiencing issues introduced by this release? Please report them in our [issue
-## Breaking Changes
+## Backward-incompatible changes
Below is a listing of the breaking change for this release, per subject or
integration. Click on one of those to read more about the breaking change
diff --git a/source/_posts/2020-09-12-android-240-release.markdown b/source/_posts/2020-09-12-android-240-release.markdown
index be03d5af208..0fa2c690766 100644
--- a/source/_posts/2020-09-12-android-240-release.markdown
+++ b/source/_posts/2020-09-12-android-240-release.markdown
@@ -13,7 +13,7 @@ og_image: /images/blog/2020-09-12-android-240-release/Companion.png
Hey there, I hope everyone has been enjoying the last release of the Android app. We have another update coming up where we felt it's time to give everyone a heads up before release. There are several new changes done that you will immediately notice after installing the update to 2.4.0, so we wanted to cover what's new. You can expect this release to be available in the Google Play Store tomorrow.
-## Current and Future Breaking Changes
+## Current and Future Backward-incompatible changes
Sometimes when we move really fast, we may move a bit too fast. While we had fun adding all the new sensors, we didn't stop to think about the new user experience and how we are making a burden on them by having non-static attributes for some of the sensors. In reality, these attributes are a state and we need to treat them as such. If we don't, there will be a need to use templates that are not user-friendly. We wanted to fix this issue and be courteous to our current users, so we have made a few changes. Some of which take place in this release and some in the following release after 2.4.0.
diff --git a/source/_posts/2020-09-17-release-115.markdown b/source/_posts/2020-09-17-release-115.markdown
index e3a011ea887..1ebe82b3838 100644
--- a/source/_posts/2020-09-17-release-115.markdown
+++ b/source/_posts/2020-09-17-release-115.markdown
@@ -104,7 +104,7 @@ navigating you around this release.
- [New Platforms](#new-platforms)
- [Integrations now available to set up from the UI](#integrations-now-available-to-set-up-from-the-ui)
- [If you need help...](#if-you-need-help)
-- [Breaking Changes](#breaking-changes)
+- [Backward-incompatible changes](#backward-incompatible-changes)
- [Farewell to the following](#farewell-to-the-following)
- [Release 0.115.1 - September 18](#release-01151---september-18)
- [Release 0.115.2 - September 19](#release-01152---september-19)
@@ -879,7 +879,7 @@ Experiencing issues introduced by this release? Please report them in our [issue
-## Breaking Changes
+## Backward-incompatible changes
Below is a listing of the breaking change for this release, per subject or
integration. Click on one of those to read more about the breaking change
diff --git a/source/_posts/2020-10-07-release-116.markdown b/source/_posts/2020-10-07-release-116.markdown
index cbca00ad9d6..ff7467325ce 100644
--- a/source/_posts/2020-10-07-release-116.markdown
+++ b/source/_posts/2020-10-07-release-116.markdown
@@ -50,7 +50,7 @@ As always, enjoy the release!
- [Release 0.116.3 - October 15](#release-01163---october-15)
- [Release 0.116.4 - October 15](#release-01164---october-15)
- [If you need help...](#if-you-need-help)
-- [Breaking Changes](#breaking-changes)
+- [Backward-incompatible changes](#backward-incompatible-changes)
- [All changes](#all-changes)
## Entities card editor
@@ -317,7 +317,7 @@ Experiencing issues introduced by this release? Please report them in our [issue
-## Breaking Changes
+## Backward-incompatible changes
Below is a listing of the breaking change for this release, per subject or
integration. Click on one of those to read more about the breaking change
@@ -327,7 +327,7 @@ for that specific item.
Custom Lovelace Cards
-This release contains breaking changes for custom card developers, check the
+This release contains backward-incompatible changes for custom card developers, check the
[developers blog](https://developers.home-assistant.io/blog/2020/10/02/lazyMoreInfo)
for more information.
diff --git a/source/_posts/2020-10-28-release-117.markdown b/source/_posts/2020-10-28-release-117.markdown
index 4dc04c06bee..a361faa5820 100644
--- a/source/_posts/2020-10-28-release-117.markdown
+++ b/source/_posts/2020-10-28-release-117.markdown
@@ -64,7 +64,7 @@ So, keep an eye on our social media for the announcement.
- [Release 0.117.5 - November 5](#release-01175---november-5)
- [Release 0.117.6 - November 11](#release-01176---november-11)
- [If you need help...](#if-you-need-help)
-- [Breaking Changes](#breaking-changes)
+- [Backward-incompatible changes](#backward-incompatible-changes)
- [Farewell to the following](#farewell-to-the-following)
- [All changes](#all-changes)
@@ -231,7 +231,7 @@ more advanced future additions and can significantly reduce the complexity of
existing templates in your set up.
It should be mostly compatible with your existing templates, however, if you
-enable this feature, please be sure to check the breaking changes section.
+enable this feature, please be sure to check the backward-incompatible changes section.
We'd love to hear you experience with using this feature! And, if you run into,
problems, [please let us know][problem].
@@ -511,7 +511,7 @@ Experiencing issues introduced by this release? Please report them in our [issue
-## Breaking Changes
+## Backward-incompatible changes
Below is a listing of the breaking change for this release, per subject or
integration. Click on one of those to read more about the breaking change
@@ -823,7 +823,7 @@ homeassistant:
legacy_templates: false
```
-**This feature will be opt-in for this release, the breaking changes below
+**This feature will be opt-in for this release, the backward-incompatible changes below
only apply if you explicitly enable this new feature.**
A template would always result in a string (text). This made it hard
diff --git a/source/_posts/2020-11-06-android-300-release.markdown b/source/_posts/2020-11-06-android-300-release.markdown
index 009eba74352..ef34635734f 100644
--- a/source/_posts/2020-11-06-android-300-release.markdown
+++ b/source/_posts/2020-11-06-android-300-release.markdown
@@ -13,9 +13,9 @@ Hey everyone it's been a little while since we last spoke. We have a brand new H
Before we get into the release details I'd like to mention that this month marks the [1 year anniversary](https://youtu.be/tc17q1Zn0Xs?t=3487) of the Home Assistant Companion app being offered in the Google Play Store! Just to think how far along the entire app has come from its initial alpha state to what is currently being offered in today's release. Can you believe it's already been a year?
-It has been pretty busy over on the Android side of things during Hacktoberfest! We have seen a total of 84 pull requests from a wide range of contributors that we are thankful for, so thank you for all of your efforts! In case you missed it we actually had a release shortly after version 2.4.0 but as we did not have an accompanying blog post, we'll cover whats new since we last spoke in this post. All of the features listed below are already documented on the [Companion](https://companion.home-assistant.io/) site, please be sure to check in there for greater details. Before we continue with what's new lets go over the breaking changes for this release.
+It has been pretty busy over on the Android side of things during Hacktoberfest! We have seen a total of 84 pull requests from a wide range of contributors that we are thankful for, so thank you for all of your efforts! In case you missed it we actually had a release shortly after version 2.4.0 but as we did not have an accompanying blog post, we'll cover whats new since we last spoke in this post. All of the features listed below are already documented on the [Companion](https://companion.home-assistant.io/) site, please be sure to check in there for greater details. Before we continue with what's new lets go over the backward-incompatible changes for this release.
-## Breaking Changes
+## Backward-incompatible changes
In our [last blog post](https://www.home-assistant.io/blog/2020/09/12/android-240-release/) we mentioned that we were going to be breaking up some sensors and their attributes. As of 3.0.0 we have completed this task and no longer have non-static attributes as part of any sensor. If you are missing any data please check the Manage Sensors screen under App Configuration and enable the sensor you were previously using as an attribute.
@@ -107,7 +107,7 @@ Screenshot of settings.
- App language can now be overridden to match a user's profile, this will impact the name of entities that get added as well as the App Configuration appearance. By default your device will use your phones language however, we noticed some users actually prefer Home Assistant to always be in a different language on their device. With this feature you can now set the language to be one of any that are supported by the app. You can also help us translate the app on [Lokalise](https://lokalise.com/public/145814835dd655bc5ab0d0.36753359/).
- History of recently received notifications, along with all data that was sent
- Notification rate limit information to help you understand if you are about to go over the daily limit.
-- Editable widgets, with the ability to delete missing widgets as mentioned in the [breaking changes](#breaking-changes). This is really helpful if you ever created a widget and realized you needed to make one more adjustment.
+- Editable widgets, with the ability to delete missing widgets as mentioned in the [backward-incompatible changes](#backward-incompatible-changes). This is really helpful if you ever created a widget and realized you needed to make one more adjustment.
- Widgets now update when the screen turns on to provide faster updates
- A new widget to control any [media player](https://companion.home-assistant.io/docs/integrations/android-widgets#media-player)
diff --git a/source/_posts/2020-11-18-release-118.markdown b/source/_posts/2020-11-18-release-118.markdown
index 6cb80b39a50..94015a22f03 100644
--- a/source/_posts/2020-11-18-release-118.markdown
+++ b/source/_posts/2020-11-18-release-118.markdown
@@ -54,7 +54,7 @@ All in all, a fine release, with an exciting one ahead of us.
- [Release 0.118.4 - November 26](#release-01184---november-26)
- [Release 0.118.5 - December 5](#release-01185---december-5)
- [If you need help...](#if-you-need-help)
-- [Breaking Changes](#breaking-changes)
+- [Backward-incompatible changes](#backward-incompatible-changes)
- [Farewell to the following](#farewell-to-the-following)
- [All changes](#all-changes)
@@ -170,7 +170,7 @@ more advanced future additions and can significantly reduce the complexity of
existing templates in your set up.
It should be mostly compatible with your existing templates; However, be sure
-to check the breaking changes section for known possible breaking scenarios.
+to check the backward-incompatible changes section for known possible breaking scenarios.
## Logbook Card
@@ -398,7 +398,7 @@ Experiencing issues introduced by this release? Please report them in our [issue
-## Breaking Changes
+## Backward-incompatible changes
Below is a listing of the breaking change for this release, per subject or
integration. Click on one of those to read more about the breaking change
diff --git a/source/_posts/2020-12-13-release-202012.markdown b/source/_posts/2020-12-13-release-202012.markdown
index 3b90e473eb0..84d50e5ab04 100644
--- a/source/_posts/2020-12-13-release-202012.markdown
+++ b/source/_posts/2020-12-13-release-202012.markdown
@@ -52,7 +52,7 @@ Happy holidays, stay safe and for the last time this year: Enjoy the release!
- [Release 2020.12.1 - December 16](#release-2020121---december-16)
- [Release 2020.12.2 - December 30](#release-2020122---december-30)
- [If you need help...](#if-you-need-help)
-- [Breaking Changes](#breaking-changes)
+- [Backward-incompatible changes](#backward-incompatible-changes)
- [Farewell to the following](#farewell-to-the-following)
- [All changes](#all-changes)
@@ -373,7 +373,7 @@ Experiencing issues introduced by this release? Please report them in our [issue
-## Breaking Changes
+## Backward-incompatible changes
Below is a listing of the breaking change for this release, per subject or
integration. Click on one of those to read more about the breaking change
diff --git a/source/_posts/2021-01-06-release-20211.markdown b/source/_posts/2021-01-06-release-20211.markdown
index 273b73b19dd..8805d284eb9 100644
--- a/source/_posts/2021-01-06-release-20211.markdown
+++ b/source/_posts/2021-01-06-release-20211.markdown
@@ -54,7 +54,7 @@ Enjoy the release!
- [Release 2021.1.4 - January 16](#release-202114---january-16)
- [Release 2021.1.5 - January 23](#release-202115---january-23)
- [If you need help...](#if-you-need-help)
-- [Breaking Changes](#breaking-changes)
+- [Backward-incompatible changes](#backward-incompatible-changes)
- [Farewell to the following](#farewell-to-the-following)
- [All changes](#all-changes)
@@ -267,7 +267,7 @@ Experiencing issues introduced by this release? Please report them in our [issue
-## Breaking Changes
+## Backward-incompatible changes
Below is a listing of the breaking change for this release, per subject or
integration. Click on one of those to read more about the breaking change
@@ -494,7 +494,7 @@ Avri has changed their API and it seems not possible to use the new one.
- Revert "Change http to auto for cast media image url" ([@emontnemery] - [#44327]) ([cast docs])
- Refactor Airly config flow ([@bieniu] - [#44330]) ([airly docs])
- Update ReCollect docs to use proper name ([@bachya] - [#44291]) ([recollect_waste docs])
-- Upgrade Telegram lib, refactor component for breaking changes ([@ofalvai] - [#44147]) ([telegram_bot docs])
+- Upgrade Telegram lib, refactor component for backward-incompatible changes ([@ofalvai] - [#44147]) ([telegram_bot docs])
- Add new sensors to meteo_france ([@mbo18] - [#44150]) ([meteo_france docs])
- Convert filter tests to use pytest style ([@chrisgramberg678] - [#41743]) ([filter docs])
- Alphabetize hyperion const.py ([@dermotduffy] - [#44343]) ([hyperion docs])
diff --git a/source/_posts/2021-02-03-release-20212.markdown b/source/_posts/2021-02-03-release-20212.markdown
index 744cad17bec..55ac3a10b1c 100644
--- a/source/_posts/2021-02-03-release-20212.markdown
+++ b/source/_posts/2021-02-03-release-20212.markdown
@@ -55,7 +55,7 @@ Enjoy the release!
- [Release 2021.2.2 - February 9](#release-202122---february-9)
- [Release 2021.2.3 - February 11](#release-202123---february-11)
- [If you need help...](#if-you-need-help)
-- [Breaking Changes](#breaking-changes)
+- [Backward-incompatible changes](#backward-incompatible-changes)
- [Farewell to the following](#farewell-to-the-following)
- [All changes](#all-changes)
@@ -505,7 +505,7 @@ Experiencing issues introduced by this release? Please report them in our [issue
-## Breaking Changes
+## Backward-incompatible changes
Below is a listing of the breaking change for this release, per subject or
integration. Click on one of those to read more about the breaking change
diff --git a/source/_posts/2021-03-03-release-20213.markdown b/source/_posts/2021-03-03-release-20213.markdown
index 0a0de4f0841..f29da97cde8 100644
--- a/source/_posts/2021-03-03-release-20213.markdown
+++ b/source/_posts/2021-03-03-release-20213.markdown
@@ -45,7 +45,7 @@ My oh my, enjoy this release!
- [Release 2021.3.3 - March 8](#release-202133---march-8)
- [Release 2021.3.4 - March 12](#release-202134---march-12)
- [If you need help...](#if-you-need-help)
-- [Breaking Changes](#breaking-changes)
+- [Backward-incompatible changes](#backward-incompatible-changes)
- [Farewell to the following](#farewell-to-the-following)
- [All changes](#all-changes)
@@ -522,7 +522,7 @@ Experiencing issues introduced by this release? Please report them in our [issue
-## Breaking Changes
+## Backward-incompatible changes
Below is a listing of the breaking change for this release, per subject or
integration. Click on one of those to read more about the breaking change
diff --git a/source/_posts/2021-04-07-release-20214.markdown b/source/_posts/2021-04-07-release-20214.markdown
index 9c65e839a4d..a741ec825fc 100644
--- a/source/_posts/2021-04-07-release-20214.markdown
+++ b/source/_posts/2021-04-07-release-20214.markdown
@@ -50,7 +50,7 @@ Enjoy the release!
- [Release 2021.4.5 - April 16](#release-202145---april-16)
- [Release 2021.4.6 - April 19](#release-202146---april-19)
- [If you need help...](#if-you-need-help)
-- [Breaking Changes](#breaking-changes)
+- [Backward-incompatible changes](#backward-incompatible-changes)
- [Farewell to the following](#farewell-to-the-following)
- [All changes](#all-changes)
@@ -218,7 +218,7 @@ filter the automation list with just the ones that touch your thermostat.
So before we talk about The nice new things in Z-Wave JS, there are breaking
changes in this release for the Z-Wave JS integration that could affect your
-existing automations. Be sure to read the [breaking changes](#breaking-changes)
+existing automations. Be sure to read the [backward-incompatible changes](#backward-incompatible-changes)
section for more info.
Alright, now the fun stuff! You can now configure each Z-Wave device straight
@@ -619,7 +619,7 @@ Experiencing issues introduced by this release? Please report them in our [issue
-## Breaking Changes
+## Backward-incompatible changes
Below is a listing of the breaking change for this release, per subject or
integration. Click on one of those to read more about the breaking change
diff --git a/source/_posts/2021-05-05-release-20215.markdown b/source/_posts/2021-05-05-release-20215.markdown
index bda25e8d924..b56b61a740e 100644
--- a/source/_posts/2021-05-05-release-20215.markdown
+++ b/source/_posts/2021-05-05-release-20215.markdown
@@ -24,7 +24,7 @@ release (which was epic, in my opinion!). But it is not a bad thing!
Some really good stability improvements have been introduced this release! Not
the hot new items you want to explore immediately, but these fundamental things
will really help our systems now and in the future. Making this release an
-upgrade that would be a smooth sail for most of us (check the breaking changes).
+upgrade that would be a smooth sail for most of us (check the backward-incompatible changes).
The most visual part changed this release can be found in the facelift that the
integrations dashboard got. Oh, and the new color modes for lights is an amazing
@@ -59,7 +59,7 @@ want to tell me who it is...)
- [Release 2021.5.4 - May 14](#release-202154---may-14)
- [Release 2021.5.5 - May 19](#release-202155---may-19)
- [If you need help...](#if-you-need-help)
-- [Breaking Changes](#breaking-changes)
+- [Backward-incompatible changes](#backward-incompatible-changes)
- [Farewell to the following](#farewell-to-the-following)
- [All changes](#all-changes)
@@ -543,7 +543,7 @@ Experiencing issues introduced by this release? Please report them in our [issue
-## Breaking Changes
+## Backward-incompatible changes
Below is a listing of the breaking change for this release, per subject or
integration. Click on one of those to read more about the breaking change
diff --git a/source/_posts/2021-06-02-release-20216.markdown b/source/_posts/2021-06-02-release-20216.markdown
index 243946f16dd..3a8acdbd75b 100644
--- a/source/_posts/2021-06-02-release-20216.markdown
+++ b/source/_posts/2021-06-02-release-20216.markdown
@@ -44,10 +44,10 @@ worth scanning the all changes section for your favorite integrations.
- [Release 2021.6.5 - June 15](#release-202165---june-15)
- [Release 2021.6.6 - June 20](#release-202166---june-20)
- [If you need help...](#if-you-need-help)
-- [Breaking Changes](#breaking-changes)
+- [Backward-incompatible changes](#backward-incompatible-changes)
- [Integrations that removed deprecated YAML import](#integrations-that-removed-deprecated-yaml-import)
- [Integrations that deprecated YAML import](#integrations-that-deprecated-yaml-import)
- - [Other breaking changes](#other-breaking-changes)
+ - [Other backward-incompatible changes](#other-breaking-changes)
- [Farewell to the following](#farewell-to-the-following)
- [All changes](#all-changes)
@@ -471,9 +471,9 @@ Experiencing issues introduced by this release? Please report them in our [issue
-## Breaking Changes
+## Backward-incompatible changes
-This release has an unusual amount of breaking changes to report. Don't worry,
+This release has an unusual amount of backward-incompatible changes to report. Don't worry,
most won't have a noticeable impact and are part of a cleanup effort.
However, we do want to report them all, just to be complete and transparent.
@@ -535,7 +535,7 @@ deprecation period.
- [Transmission][transmission docs]
- [VeSync][vesync docs]
-### Other breaking changes
+### Other backward-incompatible changes
Below is a listing of the other breaking change for this release, per subject or
integration. Click on one of those to read more about the breaking change
diff --git a/source/_posts/2021-07-07-release-20217.markdown b/source/_posts/2021-07-07-release-20217.markdown
index 275d5449836..b10ca2ec7ce 100644
--- a/source/_posts/2021-07-07-release-20217.markdown
+++ b/source/_posts/2021-07-07-release-20217.markdown
@@ -54,7 +54,7 @@ Alright, that's it! Enjoy the release!
- [Release 2021.7.3 - July 16](#release-202173---july-16)
- [Release 2021.7.4 - July 21](#release-202174---july-21)
- [If you need help...](#if-you-need-help)
-- [Breaking Changes](#breaking-changes)
+- [Backward-incompatible changes](#backward-incompatible-changes)
- [All changes](#all-changes)
## New entity: Select
@@ -580,7 +580,7 @@ Experiencing issues introduced by this release? Please report them in our [issue
-## Breaking Changes
+## Backward-incompatible changes
Below is a listing of the breaking change for this release, per subject or
integration. Click on one of those to read more about the breaking change
@@ -690,7 +690,7 @@ In this release, the content of this table is reset. This does not impact
any state history and this data isn't used by Home Assistant as of yet.
If you have no idea what this message is about, you can safely ignore it.
-We have merely listed this to be complete in our breaking changes report.
+We have merely listed this to be complete in our backward-incompatible changes report.
([@emontnemery] - [#52331]) ([history docs])
diff --git a/source/_posts/2021-08-04-release-20218.markdown b/source/_posts/2021-08-04-release-20218.markdown
index e7dfcb3cdc7..03cb2a00cc5 100644
--- a/source/_posts/2021-08-04-release-20218.markdown
+++ b/source/_posts/2021-08-04-release-20218.markdown
@@ -68,7 +68,7 @@ later today (9:00 PM CET).
- [Release 2021.8.7 - August 15](#release-202187---august-15)
- [Release 2021.8.8 - August 18](#release-202188---august-18)
- [If you need help...](#if-you-need-help)
-- [Breaking Changes](#breaking-changes)
+- [Backward-incompatible changes](#backward-incompatible-changes)
- [Farewell to the following](#farewell-to-the-following)
- [All changes](#all-changes)
@@ -650,7 +650,7 @@ Experiencing issues introduced by this release? Please report them in our [issue
-## Breaking Changes
+## Backward-incompatible changes
Below is a listing of the breaking change for this release, per subject or
integration. Click on one of those to read more about the breaking change
diff --git a/source/_posts/2021-09-01-release-20219.markdown b/source/_posts/2021-09-01-release-20219.markdown
index 0cdd2496ff3..74be0966289 100644
--- a/source/_posts/2021-09-01-release-20219.markdown
+++ b/source/_posts/2021-09-01-release-20219.markdown
@@ -43,7 +43,7 @@ Enjoy another great release! Be sure to tune into [the 2021.9 Release Party on Y
- [Release 2021.9.6 - September 11](#release-202196---september-11)
- [Release 2021.9.7 - September 18](#release-202197---september-18)
- [If you need help...](#if-you-need-help)
-- [Breaking Changes](#breaking-changes)
+- [Backward-incompatible changes](#backward-incompatible-changes)
- [All changes](#all-changes)
## Home Energy Management updates
@@ -629,7 +629,7 @@ Experiencing issues introduced by this release? Please report them in our [issue
-## Breaking Changes
+## Backward-incompatible changes
Below is a listing of the breaking change for this release, per subject or
integration. Click on one of those to read more about the breaking change
@@ -1440,7 +1440,7 @@ developer blog about it:
- Add Gas device class to DSMR Reader ([@frenck] - [#54748]) ([dsmr_reader docs])
- Tibber data coordinator ([@Danielhiversen] - [#53619]) ([tibber docs])
- Add select platform for Xiaomi Miio fans ([@bieniu] - [#54702]) ([xiaomi_miio docs]) (breaking-change)
-- Bump async-upnp-client to 0.20.0, adapt to breaking changes ([@bdraco] - [#54782]) ([upnp docs]) ([dlna_dmr docs]) ([ssdp docs])
+- Bump async-upnp-client to 0.20.0, adapt to backward-incompatible changes ([@bdraco] - [#54782]) ([upnp docs]) ([dlna_dmr docs]) ([ssdp docs])
- Remove unused last_reset from Toon ([@emontnemery] - [#54798]) ([toon docs])
- Remove last_reset and update state class for Atome energy ([@emontnemery] - [#54801]) ([atome docs])
- Remove distro from updater requirements ([@ludeeus] - [#54804]) ([updater docs])
diff --git a/source/_posts/2021-10-06-release-202110.markdown b/source/_posts/2021-10-06-release-202110.markdown
index 9c8603aedbf..8bf7d130004 100644
--- a/source/_posts/2021-10-06-release-202110.markdown
+++ b/source/_posts/2021-10-06-release-202110.markdown
@@ -65,7 +65,7 @@ Enjoy the release!
- [Release 2021.10.6 - October 18](#release-2021106---october-18)
- [Release 2021.10.7 - November 1](#release-2021107---november-1)
- [If you need help...](#if-you-need-help)
-- [Breaking Changes](#breaking-changes)
+- [Backward-incompatible changes](#backward-incompatible-changes)
- [Farewell to the following](#farewell-to-the-following)
- [All changes](#all-changes)
@@ -160,7 +160,7 @@ Some really useful new MDI icons have been added in this release!
Several icons have been removed or renamed in v6, but we have ensured
they will keep working for the upcoming two releases. Home Assistant will
write warnings in the logs in case you are using one of the affected icons.
-The breaking changes section has more information about this.
+The backward-incompatible changes section has more information about this.
[mdi]: https://pictogrammers.com/library/mdi/
@@ -527,7 +527,7 @@ Experiencing issues introduced by this release? Please report them in our [issue
-## Breaking Changes
+## Backward-incompatible changes
Below is a listing of the breaking change for this release, per subject or
integration. Click on one of those to read more about the breaking change
diff --git a/source/_posts/2021-11-03-release-202111.markdown b/source/_posts/2021-11-03-release-202111.markdown
index 4ceb2d3322f..3282d9e360a 100644
--- a/source/_posts/2021-11-03-release-202111.markdown
+++ b/source/_posts/2021-11-03-release-202111.markdown
@@ -67,7 +67,7 @@ Enjoy the release!
- [Release 2021.11.4 - November 15](#release-2021114---november-15)
- [Release 2021.11.5 - November 19](#release-2021115---november-19)
- [If you need help...](#if-you-need-help)
-- [Breaking Changes](#breaking-changes)
+- [Backward-incompatible changes](#backward-incompatible-changes)
- [Farewell to the following](#farewell-to-the-following)
- [All changes](#all-changes)
@@ -167,8 +167,8 @@ diagnostic entities), we now do the following:
or area the device is in. They are only called if explicitly called by their
entity ID.
-Please note, the above-listed points are breaking changes, also listed in
-the breaking changes section of these release notes.
+Please note, the above-listed points are backward-incompatible changes, also listed in
+the backward-incompatible changes section of these release notes.
Like the previous visit device or service feature, this new organization
capability has been adopted by many of our maintainers: 60+ integrations!
@@ -613,7 +613,7 @@ Experiencing issues introduced by this release? Please report them in our [issue
-## Breaking Changes
+## Backward-incompatible changes
Below is a listing of the breaking change for this release, per subject or
integration. Click on one of those to read more about the breaking change
diff --git a/source/_posts/2021-12-11-release-202112.markdown b/source/_posts/2021-12-11-release-202112.markdown
index c83da3a4ecf..950bf9282a6 100644
--- a/source/_posts/2021-12-11-release-202112.markdown
+++ b/source/_posts/2021-12-11-release-202112.markdown
@@ -61,7 +61,7 @@ holidays. So, the first release in 2022, will be Wednesday, 2 February 2022._
- [Release 2021.12.9 - January 10](#release-2021129---january-10)
- [Release 2021.12.10 - January 17](#release-20211210---january-17)
- [If you need help...](#if-you-need-help)
-- [Breaking Changes](#breaking-changes)
+- [Backward-incompatible changes](#backward-incompatible-changes)
- [Updates for custom integration developers](#updates-for-custom-integration-developers)
- [Farewell to the following](#farewell-to-the-following)
- [All changes](#all-changes)
@@ -1059,7 +1059,7 @@ Experiencing issues introduced by this release? Please report them in our [issue
-## Breaking Changes
+## Backward-incompatible changes
Below is a listing of the breaking change for this release, per subject or
integration. Click on one of those to read more about the breaking change
diff --git a/source/_posts/2022-02-02-release-20222.markdown b/source/_posts/2022-02-02-release-20222.markdown
index 9a0cb6c6f67..661c59ad4fc 100644
--- a/source/_posts/2022-02-02-release-20222.markdown
+++ b/source/_posts/2022-02-02-release-20222.markdown
@@ -25,7 +25,7 @@ Over 2,500 contributions make this release the largest one we have ever
shipped! Including 15 brand-new integrations and 13 existing integrations,
which are now available to set up via the user interface.
-Now don't be scared when you look at the breaking changes section. It is a lot,
+Now don't be scared when you look at the backward-incompatible changes section. It is a lot,
however, most of those are cleanup of old deprecations, or caused by things
moving to the UI. No better way to start a fresh year, than by cleaning up 🧹
@@ -65,7 +65,7 @@ Enjoy the release!
- [Release 2022.2.8 - February 16](#release-202228---february-16)
- [Release 2022.2.9 - February 18](#release-202229---february-18)
- [If you need help...](#if-you-need-help)
-- [Breaking Changes](#breaking-changes)
+- [Backward-incompatible changes](#backward-incompatible-changes)
- [Farewell to the following](#farewell-to-the-following)
- [All changes](#all-changes)
@@ -1021,7 +1021,7 @@ Experiencing issues introduced by this release? Please report them in our [issue
-## Breaking Changes
+## Backward-incompatible changes
Below is a listing of the breaking change for this release, per subject or
integration. Click on one of those to read more about the breaking change
diff --git a/source/_posts/2022-02-08-android-february.markdown b/source/_posts/2022-02-08-android-february.markdown
index 66f9644eef2..b685bf0956c 100644
--- a/source/_posts/2022-02-08-android-february.markdown
+++ b/source/_posts/2022-02-08-android-february.markdown
@@ -14,7 +14,7 @@ og_image: /images/blog/2022-02-android/Companion.png
Hey Everyone! It's time for the next Android release and we are really excited to get this one out. Lots of changes for all versions of the app, including Wear OS and Quest devices.
-## Breaking Changes
+## Backward-incompatible changes
We have a pretty big release this month with a lot of changes going on. Some of these changes are noticeable as soon as you update the app, so let's cover those first.
@@ -42,7 +42,7 @@ A big thank you to [JBassett] for kicking off this feature and working hard to s
### Sensor Changes
-The remaining breaking changes in this release are related to 2 sensors offered by all versions of the app.
+The remaining backward-incompatible changes in this release are related to 2 sensors offered by all versions of the app.
- [Do Not Disturb Sensor] - No longer available on devices running Android 5 or lower. This sensor, which was previously offered to all supported Android versions, has been updated to use the official Android API instead of the undocumented one. The Android API is only available on devices running Android 6+. Older devices will no longer see this sensor in the Manage Sensors screen.
- [Last Used App Sensor] - This sensor previously reported its state as the application label. We realized that this is not always unique, multiple apps can have the exact same name. The state has changed to report the package id which is guaranteed to be unique. The application name is now available as an attribute.
@@ -53,7 +53,7 @@ This next feature of the release is also going to be immediately noticeable upon
-The changelog prompt will be maintained by contributors of the app as we do not think it will be user friendly to show GitHub commit messages. This allows us to highlight the above breaking changes to all users so they no longer have surprises going forward. Thank you to [dshokouhi] for adding this feature.
+The changelog prompt will be maintained by contributors of the app as we do not think it will be user friendly to show GitHub commit messages. This allows us to highlight the above backward-incompatible changes to all users so they no longer have surprises going forward. Thank you to [dshokouhi] for adding this feature.
## Wear OS Updates
diff --git a/source/_posts/2022-03-02-release-20223.markdown b/source/_posts/2022-03-02-release-20223.markdown
index c22892dd417..ae8e1f551ca 100644
--- a/source/_posts/2022-03-02-release-20223.markdown
+++ b/source/_posts/2022-03-02-release-20223.markdown
@@ -59,7 +59,7 @@ Enjoy the release!
- [Release 2022.3.7 - March 23](#release-202237---march-23)
- [Release 2022.3.8 - March 29](#release-202238---march-29)
- [Need help? Join the community!](#need-help-join-the-community)
-- [Breaking Changes](#breaking-changes)
+- [Backward-incompatible changes](#backward-incompatible-changes)
- [Updates for custom integration developers](#updates-for-custom-integration-developers)
- [Farewell to the following](#farewell-to-the-following)
- [All changes](#all-changes)
@@ -692,7 +692,7 @@ into your inbox.
-## Breaking Changes
+## Backward-incompatible changes
Below is a listing of the breaking change for this release, per subject or
integration. Click on one of those to read more about the breaking change
@@ -1277,7 +1277,7 @@ You can find more information on the new dependency resolver in Python pip here:
{% details "async_timeout()" %}
We now use version 3.8+ of `aiohttp`, which requires `async_timeout` 4.0+
-which has multiple breaking changes:
+which has multiple backward-incompatible changes:
- `async_timeout.timeout` drops the `loop=` keyword arg.
- `async_timeout.current_task` has been removed.
diff --git a/source/_posts/2022-04-06-release-20224.markdown b/source/_posts/2022-04-06-release-20224.markdown
index 7aacb4300e5..c521c2fb998 100644
--- a/source/_posts/2022-04-06-release-20224.markdown
+++ b/source/_posts/2022-04-06-release-20224.markdown
@@ -65,7 +65,7 @@ Enjoy the release!
- [Release 2022.4.6 - April 20](#release-202246---april-20)
- [Release 2022.4.7 - April 24](#release-202247---april-24)
- [Need help? Join the community!](#need-help-join-the-community)
-- [Breaking Changes](#breaking-changes)
+- [Backward-incompatible changes](#backward-incompatible-changes)
- [Farewell to the following](#farewell-to-the-following)
- [All changes](#all-changes)
@@ -1052,7 +1052,7 @@ other news about the Open Home; straight into your inbox.
-## Breaking Changes
+## Backward-incompatible changes
Below is a listing of the breaking change for this release, per subject or
integration. Click on one of those to read more about the breaking change
diff --git a/source/_posts/2022-05-04-release-20225.markdown b/source/_posts/2022-05-04-release-20225.markdown
index ec992e35922..c0f20cd1bc2 100644
--- a/source/_posts/2022-05-04-release-20225.markdown
+++ b/source/_posts/2022-05-04-release-20225.markdown
@@ -67,7 +67,7 @@ Enjoy the release!
- [Release 2022.5.4 - May 12](#release-202254---may-12)
- [Release 2022.5.5 - May 18](#release-202255---may-18)
- [Need help? Join the community!](#need-help-join-the-community)
-- [Breaking Changes](#breaking-changes)
+- [Backward-incompatible changes](#backward-incompatible-changes)
- [Farewell to the following](#farewell-to-the-following)
- [All changes](#all-changes)
@@ -99,7 +99,7 @@ logical place for YAML configuration checks and reloading.
You might notice some of the new menu items are fairly empty. For those menus,
like "Storage" and "Hardware", we have more content planned soon!
-Just to be sure, we have added a list of changes to the breaking changes section;
+Just to be sure, we have added a list of changes to the backward-incompatible changes section;
please check those out in case you are missing something.
## Find entities even quicker than before
@@ -956,7 +956,7 @@ Are you more into email? [Sign-up for our Building the Open Home Newsletter](/ne
to get the latest news about features, things happening in our community and
other news about building an Open Home; straight into your inbox.
-## Breaking Changes
+## Backward-incompatible changes
Below is a listing of the breaking change for this release, per subject or
integration. Click on one of those to read more about the breaking change
diff --git a/source/_posts/2022-06-01-release-20226.markdown b/source/_posts/2022-06-01-release-20226.markdown
index 78f589c1019..dab203dcdce 100644
--- a/source/_posts/2022-06-01-release-20226.markdown
+++ b/source/_posts/2022-06-01-release-20226.markdown
@@ -67,7 +67,7 @@ Enjoy the release (and upcoming events)!
- [Release 2022.6.6 - June 14](#release-202266---june-14)
- [Release 2022.6.7 - June 22](#release-202267---june-22)
- [Need help? Join the community!](#need-help-join-the-community)
-- [Breaking Changes](#breaking-changes)
+- [Backward-incompatible changes](#backward-incompatible-changes)
- [Farewell to the following](#farewell-to-the-following)
- [All changes](#all-changes)
@@ -727,9 +727,9 @@ Are you more into email? [Sign-up for our Building the Open Home Newsletter](/ne
to get the latest news about features, things happening in our community and
other news about building an Open Home; straight into your inbox.
-## Breaking Changes
+## Backward-incompatible changes
-Below is a listing of the breaking changes for this release, per subject or
+Below is a listing of the backward-incompatible changes for this release, per subject or
integration. Click on one of those to read more about the breaking change
for that specific item.
diff --git a/source/_posts/2022-07-06-release-20227.markdown b/source/_posts/2022-07-06-release-20227.markdown
index d36947aca16..2a8b436c1ef 100644
--- a/source/_posts/2022-07-06-release-20227.markdown
+++ b/source/_posts/2022-07-06-release-20227.markdown
@@ -59,7 +59,7 @@ like. So without further due: Enjoy the release!
- [Release 2022.7.6 - July 20](#release-202276---july-20)
- [Release 2022.7.7 - July 26](#release-202277---july-26)
- [Need help? Join the community!](#need-help-join-the-community)
-- [Breaking Changes](#breaking-changes)
+- [Backward-incompatible changes](#backward-incompatible-changes)
- [Farewell to the following](#farewell-to-the-following)
- [All changes](#all-changes)
@@ -767,7 +767,7 @@ Are you more into email? [Sign-up for our Building the Open Home Newsletter](/ne
to get the latest news about features, things happening in our community and
[](https://github.com/home-assistant/core/pull/58768)other news about building an Open Home; straight into your inbox.
-## Breaking Changes
+## Backward-incompatible changes
Below is a listing of the breaking change for this release, per subject or
integration. Click on one of those to read more about the breaking change
diff --git a/source/_posts/2022-08-03-release-20228.markdown b/source/_posts/2022-08-03-release-20228.markdown
index 07c2f87b754..9142c524102 100644
--- a/source/_posts/2022-08-03-release-20228.markdown
+++ b/source/_posts/2022-08-03-release-20228.markdown
@@ -51,7 +51,7 @@ Enjoy the release!
- [Release 2022.8.6 - August 17](#release-202286---august-17)
- [Release 2022.8.7 - August 25](#release-202287---august-25)
- [Need help? Join the community!](#need-help-join-the-community)
-- [Breaking Changes](#breaking-changes)
+- [Backward-incompatible changes](#backward-incompatible-changes)
- [Farewell to the following](#farewell-to-the-following)
- [All changes](#all-changes)
@@ -673,7 +673,7 @@ Are you more into email? [Sign-up for our Building the Open Home Newsletter](/ne
to get the latest news about features, things happening in our community and
other news about building an Open Home; straight into your inbox.
-## Breaking Changes
+## Backward-incompatible changes
Below is a listing of the breaking change for this release, per subject or
integration. Click on one of those to read more about the breaking change
diff --git a/source/_posts/2022-09-07-release-20229.markdown b/source/_posts/2022-09-07-release-20229.markdown
index 29acdc552e9..0a82f25b608 100644
--- a/source/_posts/2022-09-07-release-20229.markdown
+++ b/source/_posts/2022-09-07-release-20229.markdown
@@ -45,7 +45,7 @@ Now I know that everyone usually expects [@frenck] to be writing these release n
- [Release 2022.9.6 - September 22](#release-202296---september-22)
- [Release 2022.9.7 - September 26](#release-202297---september-26)
- [Need help? Join the community](#need-help-join-the-community)
-- [Breaking Changes](#breaking-changes)
+- [Backward-incompatible changes](#backward-incompatible-changes)
- [All changes](#all-changes)
Don't forget to [join our release party live stream on YouTube](https://www.youtube.com/watch?v=UTltO1-d56s) today at 12:00 PDT / 21:00 CET!
@@ -764,7 +764,7 @@ Are you more into email? [Sign-up for our Building the Open Home Newsletter](/ne
to get the latest news about features, things happening in our community and
other news about building an Open Home; straight into your inbox.
-## Breaking Changes
+## Backward-incompatible changes
Below is a listing of the breaking change for this release, per subject or
integration. Click on one of those to read more about the breaking change
diff --git a/source/_posts/2022-10-05-release-202210.markdown b/source/_posts/2022-10-05-release-202210.markdown
index 046618d70d4..d515087c53e 100644
--- a/source/_posts/2022-10-05-release-202210.markdown
+++ b/source/_posts/2022-10-05-release-202210.markdown
@@ -57,7 +57,7 @@ PS: I noticed the [Home Assistant SkyConnect is now available for pre-order](/sk
- [Release 2022.10.4 - October 14](#release-2022104---october-14)
- [Release 2022.10.5 - October 20](#release-2022105---october-20)
- [Need help? Join the community!](#need-help-join-the-community)
-- [Breaking Changes](#breaking-changes)
+- [Backward-incompatible changes](#backward-incompatible-changes)
- [Farewell to the following](#farewell-to-the-following)
- [All changes](#all-changes)
@@ -672,7 +672,7 @@ Are you more into email? [Sign-up for our Building the Open Home Newsletter](/ne
to get the latest news about features, things happening in our community and
other news about building an Open Home; straight into your inbox.
-## Breaking Changes
+## Backward-incompatible changes
Below is a listing of the breaking change for this release, per subject or
integration. Click on one of those to read more about the breaking change
@@ -821,7 +821,7 @@ the state no longer reports as "ok" but instead reports as "on".
{% details "Radarr" %}
-Some breaking changes have been made in disabling the Movies count sensor out
+Some backward-incompatible changes have been made in disabling the Movies count sensor out
of caution. This sensor can cause problems with massive databases.
If you still wish to use it, you may do so.
diff --git a/source/_posts/2022-11-02-release-202211.markdown b/source/_posts/2022-11-02-release-202211.markdown
index f79b263eb05..4d7f1bd320a 100644
--- a/source/_posts/2022-11-02-release-202211.markdown
+++ b/source/_posts/2022-11-02-release-202211.markdown
@@ -58,7 +58,7 @@ Sunday, November 13, 2022 (11:00 AM PST / 20:00 CET).
- [Release 2022.11.4 - November 20](#release-2022114---november-20)
- [Release 2022.11.5 - November 30](#release-2022115---november-30)
- [Need help? Join the community!](#need-help-join-the-community)
-- [Breaking Changes](#breaking-changes)
+- [Backward-incompatible changes](#backward-incompatible-changes)
- [All changes](#all-changes)
## Tile card
@@ -794,7 +794,7 @@ Are you more into email? [Sign-up for our Building the Open Home Newsletter](/ne
to get the latest news about features, things happening in our community and
other news about building an Open Home; straight into your inbox.
-## Breaking Changes
+## Backward-incompatible changes
Below is a listing of the breaking change for this release, per subject or
integration. Click on one of those to read more about the breaking change
diff --git a/source/_posts/2022-12-07-release-202212.markdown b/source/_posts/2022-12-07-release-202212.markdown
index e0811c200ff..e71242d0a74 100644
--- a/source/_posts/2022-12-07-release-202212.markdown
+++ b/source/_posts/2022-12-07-release-202212.markdown
@@ -70,7 +70,7 @@ Happy holidays and for the last time in 2022: Enjoy the release!
- [Release 2022.12.8 - December 21](#release-2022128---december-21)
- [Release 2022.12.9 - January, 2](#release-2022129---january-2)
- [Need help? Join the community!](#need-help-join-the-community)
-- [Breaking Changes](#breaking-changes)
+- [Backward-incompatible changes](#backward-incompatible-changes)
- [Farewell to the following](#farewell-to-the-following)
- [All changes](#all-changes)
@@ -708,7 +708,7 @@ Are you more into email? [Sign-up for our Building the Open Home Newsletter](/ne
to get the latest news about features, things happening in our community and
other news about building an Open Home; straight into your inbox.
-## Breaking Changes
+## Backward-incompatible changes
{% details "Cloudflare" %}
@@ -1096,7 +1096,7 @@ each PoE-capable port without mapping it to a client.
{% enddetails %}
If you are a custom integration or theme developer and want to learn about
-breaking changes and new features available for your integration: Be sure to
+backward-incompatible 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:
diff --git a/source/_posts/2023-01-04-release-20231.markdown b/source/_posts/2023-01-04-release-20231.markdown
index 2fdf83ebd1c..b0626a93511 100644
--- a/source/_posts/2023-01-04-release-20231.markdown
+++ b/source/_posts/2023-01-04-release-20231.markdown
@@ -56,7 +56,7 @@ PS: Did you know [Home Assistant is now on Mastodon](https://fosstodon.org/@home
- [Release 2023.1.6 - January 19](#release-202316---january-19)
- [Release 2023.1.7 - January 22](#release-202317---january-22)
- [Need help? Join the community!](#need-help-join-the-community)
-- [Breaking Changes](#breaking-changes)
+- [Backward-incompatible changes](#backward-incompatible-changes)
- [Farewell to the following](#farewell-to-the-following)
- [All changes](#all-changes)
@@ -637,7 +637,7 @@ Are you more into email? [Sign-up for our Building the Open Home Newsletter](/ne
to get the latest news about features, things happening in our community and
other news about building an Open Home; straight into your inbox.
-## Breaking Changes
+## Backward-incompatible changes
{% details "Image Upload / Default Config" %}
diff --git a/source/_posts/2023-02-01-release-20232.markdown b/source/_posts/2023-02-01-release-20232.markdown
index 99ee1998b6e..db5e7606d37 100644
--- a/source/_posts/2023-02-01-release-20232.markdown
+++ b/source/_posts/2023-02-01-release-20232.markdown
@@ -54,7 +54,7 @@ _PS: Just a reminder that valentine's day is coming up. Be sure to share the lov
- [Release 2023.2.4 - February 13](#release-202324---february-13)
- [Release 2023.2.5 - February 15](#release-202325---february-15)
- [Need help? Join the community!](#need-help-join-the-community)
-- [Breaking Changes](#breaking-changes)
+- [Backward-incompatible changes](#backward-incompatible-changes)
- [Farewell to the following](#farewell-to-the-following)
- [All changes](#all-changes)
@@ -733,7 +733,7 @@ Are you more into email? [Sign-up for our Building the Open Home Newsletter](/ne
to get the latest news about features, things happening in our community and
other news about building an Open Home; straight into your inbox.
-## Breaking Changes
+## Backward-incompatible changes
{% details "Python 3.9 support has been removed" %}
diff --git a/source/_posts/2023-03-01-release-20233.markdown b/source/_posts/2023-03-01-release-20233.markdown
index 33f28c9dada..6a6242eb22c 100644
--- a/source/_posts/2023-03-01-release-20233.markdown
+++ b/source/_posts/2023-03-01-release-20233.markdown
@@ -55,7 +55,7 @@ Enjoy the release!
- [Release 2023.3.5 - March 16](#release-202335---march-16)
- [Release 2023.3.6 - March 22](#release-202336---march-22)
- [Need help? Join the community!](#need-help-join-the-community)
-- [Breaking Changes](#breaking-changes)
+- [Backward-incompatible changes](#backward-incompatible-changes)
- [All changes](#all-changes)
Don't forget to [join our release party live stream on YouTube](https://www.youtube.com/watch?v=3UaLAhG9Brc) 1 March 2023, at 12:00 PST / 21:00 CET!
@@ -699,7 +699,7 @@ Are you more into email? [Sign-up for our Building the Open Home Newsletter](/ne
to get the latest news about features, things happening in our community and
other news about building an Open Home; straight into your inbox.
-## Breaking Changes
+## Backward-incompatible changes
{% details "Assist / Conversation" %}
diff --git a/source/_posts/2023-04-05-release-20234.markdown b/source/_posts/2023-04-05-release-20234.markdown
index 8aefff9d92e..b58cf74e2a2 100644
--- a/source/_posts/2023-04-05-release-20234.markdown
+++ b/source/_posts/2023-04-05-release-20234.markdown
@@ -51,7 +51,7 @@ Happy Easter! 🐣 and enjoy the release!
- [Release 2023.4.5 - April 17](#release-202345---april-17)
- [Release 2023.4.6 - April 21](#release-202346---april-21)
- [Need help? Join the community!](#need-help-join-the-community)
-- [Breaking Changes](#breaking-changes)
+- [Backward-incompatible changes](#backward-incompatible-changes)
- [Farewell to the following](#farewell-to-the-following)
- [All changes](#all-changes)
@@ -950,7 +950,7 @@ Are you more into email? [Sign-up for our Building the Open Home Newsletter](/ne
to get the latest news about features, things happening in our community and
other news about building an Open Home; straight into your inbox.
-## Breaking Changes
+## Backward-incompatible changes
{% details "Aladdin Connect" %}
diff --git a/source/_posts/2023-05-03-release-20235.markdown b/source/_posts/2023-05-03-release-20235.markdown
index 33efa5c1459..aeab18b4d8e 100644
--- a/source/_posts/2023-05-03-release-20235.markdown
+++ b/source/_posts/2023-05-03-release-20235.markdown
@@ -52,7 +52,7 @@ Enjoy the release!
- [Release 2023.5.3 - May 14](#release-202353---may-14)
- [Release 2023.5.4 - May 23](#release-202354---may-23)
- [Need help? Join the community!](#need-help-join-the-community)
-- [Breaking Changes](#breaking-changes)
+- [Backward-incompatible changes](#backward-incompatible-changes)
- [Farewell to the following](#farewell-to-the-following)
- [All changes](#all-changes)
@@ -657,7 +657,7 @@ Are you more into email? [Sign-up for our Building the Open Home Newsletter](/ne
to get the latest news about features, things happening in our community and
other news about building an Open Home; straight into your inbox.
-## Breaking Changes
+## Backward-incompatible changes
{% details "Accuweather" %}
diff --git a/source/_posts/2023-06-07-release-20236.markdown b/source/_posts/2023-06-07-release-20236.markdown
index e29efd98bbb..c46258ed413 100644
--- a/source/_posts/2023-06-07-release-20236.markdown
+++ b/source/_posts/2023-06-07-release-20236.markdown
@@ -52,7 +52,7 @@ Enjoy the release!
- [Release 2023.6.2 - June 14](#release-202362---june-14)
- [Release 2023.6.3 - June 23](#release-202363---june-23)
- [Need help? Join the community!](#need-help-join-the-community)
-- [Breaking Changes](#breaking-changes)
+- [Backward-incompatible changes](#backward-incompatible-changes)
- [Farewell to the following](#farewell-to-the-following)
- [All changes](#all-changes)
@@ -725,7 +725,7 @@ Are you more into email? [Sign-up for our Building the Open Home Newsletter](/ne
to get the latest news about features, things happening in our community and
other news about building an Open Home; straight into your inbox.
-## Breaking Changes
+## Backward-incompatible changes
{% details "Python" %}
diff --git a/source/_posts/2023-07-05-release-20237.markdown b/source/_posts/2023-07-05-release-20237.markdown
index d9249f8b687..9ec31648cc3 100644
--- a/source/_posts/2023-07-05-release-20237.markdown
+++ b/source/_posts/2023-07-05-release-20237.markdown
@@ -1,7 +1,7 @@
---
layout: post
title: "2023.7: Responding services"
-description: "Services can now respond with data, a new dialog for lock, sentence triggers, fewer breaking changes, Bluetooth proxies are now the fastest option, copy 'n paste in dashboards, brand new image entities, a dashboard action to open assist, climate support for Matter, and more!"
+description: "Services can now respond with data, a new dialog for lock, sentence triggers, fewer backward-incompatible changes, Bluetooth proxies are now the fastest option, copy 'n paste in dashboards, brand new image entities, a dashboard action to open assist, climate support for Matter, and more!"
date: 2023-07-05 00:00:00
date_formatted: "July 5, 2023"
author: Franck Nijhof
@@ -53,7 +53,7 @@ Enjoy the release!
- [New script dialog](#new-script-dialog)
- [Lightning fast Bluetooth proxies](#lightning-fast-bluetooth-proxies)
- [Matter updates](#matter-updates)
-- [Reducing the risk of running into breaking changes](#reducing-the-risk-of-running-into-breaking-changes)
+- [Reducing the risk of running into backward-incompatible changes](#reducing-the-risk-of-running-into-breaking-changes)
- [Other noteworthy changes](#other-noteworthy-changes)
- [New integrations](#new-integrations)
- [Release 2023.7.1 - July 6](#release-202371---july-6)
@@ -61,7 +61,7 @@ Enjoy the release!
- [Release 2023.7.3 - July 21](#release-202373---july-21)
- [Integrations now available to set up from the UI](#integrations-now-available-to-set-up-from-the-ui)
- [Need help? Join the community!](#need-help-join-the-community)
-- [Breaking changes](#breaking-changes)
+- [Backward-incompatible changes](#backward-incompatible-changes)
- [Farewell to the following](#farewell-to-the-following)
- [All changes](#all-changes)
@@ -332,9 +332,9 @@ This means if you have a [Nest Thermostat](https://support.google.com/googlenest
(not the E or learning ones) with the latest firmware, you can now use it
directly with Home Assistant, entirely local without clouds!
-## Reducing the risk of running into breaking changes
+## Reducing the risk of running into backward-incompatible changes
-Breaking changes, nobody loves them, but they are sometimes necessary to move
+Backward-incompatible changes, nobody loves them, but they are sometimes necessary to move
forward. We try to keep them to an absolute minimum, but sometimes they are
inevitable.
@@ -795,7 +795,7 @@ Are you more into email? [Sign-up for our Building the Open Home Newsletter](/ne
to get the latest news about features, things happening in our community and
other news about building an Open Home; straight into your inbox.
-## Breaking changes
+## Backward-incompatible changes
{% details "Home Assistant Container (Docker)" %}
diff --git a/source/_posts/2023-08-02-release-20238.markdown b/source/_posts/2023-08-02-release-20238.markdown
index 6c17dd73be6..7740bf94110 100644
--- a/source/_posts/2023-08-02-release-20238.markdown
+++ b/source/_posts/2023-08-02-release-20238.markdown
@@ -57,7 +57,7 @@ Enjoy the release!
- [Release 2023.8.3 - August 18](#release-202383---august-18)
- [Release 2023.8.4 - August 24](#release-202384---august-24)
- [Need help? Join the community!](#need-help-join-the-community)
-- [Breaking changes](#breaking-changes)
+- [Backward-incompatible changes](#backward-incompatible-changes)
- [Farewell to the following](#farewell-to-the-following)
- [All changes](#all-changes)
@@ -737,7 +737,7 @@ Are you more into email? [Sign-up for our Building the Open Home Newsletter](/ne
to get the latest news about features, things happening in our community and
other news about building an Open Home; straight into your inbox.
-## Breaking changes
+## Backward-incompatible changes
{% details "Python 3.10 support has been removed" %}
@@ -926,7 +926,7 @@ changes and new features available for your integration: Be sure to follow our
The following integrations are also no longer available as of this release:
- **Discovery** has been removed. This is the old legacy discovery integration.
- See the breaking changes above for more information.
+ See the backward-incompatible changes above for more information.
([@frenck] - [#96856])
- **Mi Flora** has been removed. This integration was replaced by the
[Xiaomi BLE] integration a long time ago and was in a non-functional state.
diff --git a/source/_posts/2023-09-06-release-20239.markdown b/source/_posts/2023-09-06-release-20239.markdown
index 53834330ba8..d6d4d7e042c 100644
--- a/source/_posts/2023-09-06-release-20239.markdown
+++ b/source/_posts/2023-09-06-release-20239.markdown
@@ -48,7 +48,7 @@ Bram
- [Release 2023.9.2 - September 12](#release-202392---september-12)
- [Release 2023.9.3 - September 24](#release-202393---september-24)
- [Need help? Join the community!](#need-help-join-the-community)
-- [Breaking changes](#breaking-changes)
+- [Backward-incompatible changes](#backward-incompatible-changes)
- [All changes](#all-changes)
Don't forget to [join our release party live stream on YouTube](https://www.youtube.com/watch?v=JSNRrWk9IHs)
@@ -644,7 +644,7 @@ Are you more into email? [Sign-up for our Building the Open Home Newsletter](/ne
to get the latest news about features, things happening in our community and
other news about building an Open Home; straight into your inbox.
-## Breaking changes
+## Backward-incompatible changes
{% details "BMW Connected Drive" %}
diff --git a/source/_posts/2023-10-04-release-202310.markdown b/source/_posts/2023-10-04-release-202310.markdown
index e59747a8641..b39049ce58e 100644
--- a/source/_posts/2023-10-04-release-202310.markdown
+++ b/source/_posts/2023-10-04-release-202310.markdown
@@ -45,7 +45,7 @@ Enjoy the release!
- [Release 2023.10.4 - October 21](#release-2023104---october-21)
- [Release 2023.10.5 - October 22](#release-2023105---october-22)
- [Need help? Join the community!](#need-help-join-the-community)
-- [Breaking changes](#breaking-changes)
+- [Backward-incompatible changes](#backward-incompatible-changes)
- [All changes](#all-changes)
Don't forget to [join our release party live stream on YouTube](https://www.youtube.com/watch?v=-GDonruFfKc)
@@ -588,7 +588,7 @@ Are you more into email? [Sign-up for our Building the Open Home Newsletter](/ne
to get the latest news about features, things happening in our community and
other news about building an Open Home; straight into your inbox.
-## Breaking changes
+## Backward-incompatible changes
{% details "HomeKit Bridge" %}
diff --git a/source/_posts/2023-11-01-release-202311.markdown b/source/_posts/2023-11-01-release-202311.markdown
index f6877cc8345..1c22ba226e2 100644
--- a/source/_posts/2023-11-01-release-202311.markdown
+++ b/source/_posts/2023-11-01-release-202311.markdown
@@ -57,8 +57,11 @@ Enjoy the release!
- [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 2023.11.1 - November 4](#release-2023111---november-4)
+- [Release 2023.11.2 - November 10](#release-2023112---november-10)
+- [Release 2023.11.3 - November 22](#release-2023113---november-22)
- [Need help? Join the community!](#need-help-join-the-community)
-- [Breaking changes](#breaking-changes)
+- [Backward-incompatible changes](#backward-incompatible-changes)
- [Farewell to the following](#farewell-to-the-following)
- [All changes](#all-changes)
@@ -70,11 +73,11 @@ Don't forget to [join our release party live stream on YouTube](https://www.yout
## There is a lot to-do!
There are many things to do in our lives, which is what
-[@allenporter] realized too! We now have a new entity type
+[@allenporter] realized, too! We now have a new entity type
in Home Assistant: [To-do list entities](/integrations/todo)!
A to-do list entity represents a list of tasks, and its state is the amount of
-uncompleted tasks that are still open. You can create one or more (fully local)
+uncompleted tasks that are still open. You can create one or more
to-do lists and view and manage them by selecting the new **To-do lists**
item in the sidebar.
@@ -347,15 +350,15 @@ noteworthy changes this release:
We welcome the following new integrations in this release:
- **[Google Tasks]**, added by [@allenporter]
- Access your Google Tasks to-do list from the new todo dashboard.
+ Access your Google Tasks to-do list from the new to-do dashboard.
- **[Improv BLE]**, added by [@emontnemery]
Get your Improv Wi-Fi enabled devices onboarding onto your Wi-Fi network with ease.
- **[Local to-do list]**, added by [@allenporter]
- Create and manage your own, Home Assistant, local todo list.
+ Create and manage your own, Home Assistant, local to-do list.
- **[Tami4 Edge / Edge+]**, added by [@Guy293]
Integrate your Tami water bar, boil water and get filter sensors.
- **[To-do list]**, added by [@allenporter]
- New entity type that provides todo list capabilties for other integrations to use.
+ New entity type that provides to-do list capabilties for other integrations to use.
[@allenporter]: https://github.com/allenporter
[@emonemery]: https://github.com/emontnemery
@@ -391,6 +394,294 @@ The following integrations are now available via the Home Assistant UI:
[Fitbit]: /integrations/fitbit
[Random]: /integrations/random
+## Release 2023.11.1 - November 4
+
+- Bump python-holidays to 0.35 ([@gjohansson-ST] - [#103092])
+- Bump aiowaqi to 3.0.0 ([@joostlek] - [#103166])
+- Catch unexpected response in Honeywell ([@mkmer] - [#103169])
+- Fix roomba translation key mismatch ([@Xitee1] - [#103191])
+- Fix roomba error if battery stats are not available ([@Xitee1] - [#103196])
+- Fix mqtt config validation error handling ([@jbouwh] - [#103210])
+- Fix Fronius entity initialisation ([@farmio] - [#103211])
+- Bump pyenphase to 1.14.1 ([@cgarwood] - [#103239])
+- Remove measurement flag from timestamp in gardena bluetooth ([@elupus] - [#103245])
+- Fix Plugwise Schedule selection ([@CoMPaTech] - [#103262])
+- Bump yalexs-ble to 2.3.2 ([@bdraco] - [#103267])
+- add library logger info on ecoforest integration manifest ([@pjanuario] - [#103274])
+- Fix Matter 1.2 locks with specific unlatch/unbolt support ([@marcelveldt] - [#103275])
+- Fix firmware update failure ([@raman325] - [#103277])
+- Bump opower to 0.0.39 ([@tronikos] - [#103292])
+- Bump reolink-aio to 0.7.14 and improve typing of Reolink ([@starkillerOG] - [#103129])
+- Bump py_nextbusnext to v1.0.2 to fix TypeError ([@ViViDboarder] - [#103214])
+- Add script to convert zwave_js device diagnostics to fixture ([@raman325] - [#102799])
+- Fix typo in Todoist config flow ([@jpbede] - [#103317])
+- Remove extra from traccar webhook ([@ludeeus] - [#103319])
+- Report correct weather condition at night for Met ([@jrieger] - [#103334])
+- Handle UniFi traffic rules not supported on older versions ([@Kane610] - [#103346])
+- Fix sensor unique id in Islamic prayer times ([@engrbm87] - [#103356])
+- Fix zwave_js cover bug for Window Covering CC values ([@raman325] - [#103289])
+
+[#102799]: https://github.com/home-assistant/core/pull/102799
+[#103092]: https://github.com/home-assistant/core/pull/103092
+[#103129]: https://github.com/home-assistant/core/pull/103129
+[#103164]: https://github.com/home-assistant/core/pull/103164
+[#103166]: https://github.com/home-assistant/core/pull/103166
+[#103169]: https://github.com/home-assistant/core/pull/103169
+[#103191]: https://github.com/home-assistant/core/pull/103191
+[#103196]: https://github.com/home-assistant/core/pull/103196
+[#103210]: https://github.com/home-assistant/core/pull/103210
+[#103211]: https://github.com/home-assistant/core/pull/103211
+[#103214]: https://github.com/home-assistant/core/pull/103214
+[#103239]: https://github.com/home-assistant/core/pull/103239
+[#103245]: https://github.com/home-assistant/core/pull/103245
+[#103262]: https://github.com/home-assistant/core/pull/103262
+[#103267]: https://github.com/home-assistant/core/pull/103267
+[#103274]: https://github.com/home-assistant/core/pull/103274
+[#103275]: https://github.com/home-assistant/core/pull/103275
+[#103277]: https://github.com/home-assistant/core/pull/103277
+[#103289]: https://github.com/home-assistant/core/pull/103289
+[#103292]: https://github.com/home-assistant/core/pull/103292
+[#103317]: https://github.com/home-assistant/core/pull/103317
+[#103319]: https://github.com/home-assistant/core/pull/103319
+[#103334]: https://github.com/home-assistant/core/pull/103334
+[#103346]: https://github.com/home-assistant/core/pull/103346
+[#103356]: https://github.com/home-assistant/core/pull/103356
+[@CoMPaTech]: https://github.com/CoMPaTech
+[@Kane610]: https://github.com/Kane610
+[@ViViDboarder]: https://github.com/ViViDboarder
+[@Xitee1]: https://github.com/Xitee1
+[@bdraco]: https://github.com/bdraco
+[@cgarwood]: https://github.com/cgarwood
+[@elupus]: https://github.com/elupus
+[@engrbm87]: https://github.com/engrbm87
+[@farmio]: https://github.com/farmio
+[@frenck]: https://github.com/frenck
+[@gjohansson-ST]: https://github.com/gjohansson-ST
+[@jbouwh]: https://github.com/jbouwh
+[@joostlek]: https://github.com/joostlek
+[@jpbede]: https://github.com/jpbede
+[@jrieger]: https://github.com/jrieger
+[@ludeeus]: https://github.com/ludeeus
+[@marcelveldt]: https://github.com/marcelveldt
+[@mkmer]: https://github.com/mkmer
+[@pjanuario]: https://github.com/pjanuario
+[@raman325]: https://github.com/raman325
+[@starkillerOG]: https://github.com/starkillerOG
+[@tronikos]: https://github.com/tronikos
+
+## Release 2023.11.2 - November 10
+
+- Don't assume that the `sleep` value is a dictionary in Tractive integration ([@bieniu] - [#103138])
+- Update aioairzone-cloud to v0.3.2 ([@Noltari] - [#103258])
+- Update aioairzone-cloud to v0.3.5 ([@Noltari] - [#103315])
+- Handle null data in WeatherFlow sensors ([@natekspencer] - [#103349])
+- Handle smarttub sensor values being None ([@mdz] - [#103385])
+- Pin jaraco.functools to fix builds and CI ([@bdraco] - [#103406])
+- Update tailscale to 0.6.0 ([@frenck] - [#103409])
+- Bump pyatmo to v7.6.0 ([@cgtobi] - [#103410])
+- Fix serial in Flo device information ([@mib1185] - [#103427])
+- modbus Allow swap: byte for datatype: string. ([@janiversen] - [#103441])
+- Modbus set device_class in slaves ([@janiversen] - [#103442])
+- Fix KNX expose default value when attribute is `None` ([@farmio] - [#103446])
+- Sort Withings sleep data on end date ([@joostlek] - [#103454])
+- Use right equipment identifier in DSMR setup ([@dupondje] - [#103494])
+- Fix litterrobot test failure due to time zone dependence ([@mdz] - [#103444])
+- Revert binary_sensor part of #103210 ([@edenhaus] - [#103499])
+- ESPHome: Add suggested_area from device info ([@jesserockz] - [#102834])
+- Bump aioesphomeapi to 18.2.1 ([@bdraco] - [#103156])
+- Bump bluetooth-data-tools to 0.14.0 ([@bdraco] - [#103413])
+- Bump blinkpy to 0.22.3 ([@mkmer] - [#103438])
+- Fix 5B Gas meter in dsmr ([@dupondje] - [#103506])
+- Fix invalid MAC in samsungtv ([@epenet] - [#103512])
+- Bump aioesphomeapi to 18.2.4 ([@bdraco] - [#103552])
+- Bump pyenphase to 1.14.2 ([@cgarwood] - [#103553])
+- Update dsmr-parser to 1.3.1 to fix parsing issues ([@dupondje] - [#103572])
+- fix: get_devices only checks for the first type ([@suaveolent] - [#103583])
+- Raise exception when data can't be fetched in Opensky ([@joostlek] - [#103596])
+- Bump yt-dlp to 2023.10.13 ([@joostlek] - [#103616])
+- Fix Reolink DHCP IP update ([@starkillerOG] - [#103654])
+- Incease tplink setup timeout ([@bdraco] - [#103671])
+- Add name to Withings coordinator ([@joostlek] - [#103692])
+- Update frontend to 20231030.2 ([@bramkragten] - [#103706])
+
+[#102834]: https://github.com/home-assistant/core/pull/102834
+[#103138]: https://github.com/home-assistant/core/pull/103138
+[#103156]: https://github.com/home-assistant/core/pull/103156
+[#103164]: https://github.com/home-assistant/core/pull/103164
+[#103258]: https://github.com/home-assistant/core/pull/103258
+[#103301]: https://github.com/home-assistant/core/pull/103301
+[#103315]: https://github.com/home-assistant/core/pull/103315
+[#103349]: https://github.com/home-assistant/core/pull/103349
+[#103385]: https://github.com/home-assistant/core/pull/103385
+[#103406]: https://github.com/home-assistant/core/pull/103406
+[#103409]: https://github.com/home-assistant/core/pull/103409
+[#103410]: https://github.com/home-assistant/core/pull/103410
+[#103413]: https://github.com/home-assistant/core/pull/103413
+[#103427]: https://github.com/home-assistant/core/pull/103427
+[#103438]: https://github.com/home-assistant/core/pull/103438
+[#103441]: https://github.com/home-assistant/core/pull/103441
+[#103442]: https://github.com/home-assistant/core/pull/103442
+[#103444]: https://github.com/home-assistant/core/pull/103444
+[#103446]: https://github.com/home-assistant/core/pull/103446
+[#103454]: https://github.com/home-assistant/core/pull/103454
+[#103494]: https://github.com/home-assistant/core/pull/103494
+[#103499]: https://github.com/home-assistant/core/pull/103499
+[#103506]: https://github.com/home-assistant/core/pull/103506
+[#103512]: https://github.com/home-assistant/core/pull/103512
+[#103552]: https://github.com/home-assistant/core/pull/103552
+[#103553]: https://github.com/home-assistant/core/pull/103553
+[#103572]: https://github.com/home-assistant/core/pull/103572
+[#103583]: https://github.com/home-assistant/core/pull/103583
+[#103596]: https://github.com/home-assistant/core/pull/103596
+[#103616]: https://github.com/home-assistant/core/pull/103616
+[#103654]: https://github.com/home-assistant/core/pull/103654
+[#103671]: https://github.com/home-assistant/core/pull/103671
+[#103692]: https://github.com/home-assistant/core/pull/103692
+[#103706]: https://github.com/home-assistant/core/pull/103706
+[@bieniu]: https://github.com/bieniu
+[@Noltari]: https://github.com/Noltari
+[@mdz]: https://github.com/mdz
+[@cgtobi]: https://github.com/cgtobi
+[@mib1185]: https://github.com/mib1185
+[@janiversen]: https://github.com/janiversen
+[@dupondje]: https://github.com/dupondje
+[@edenhaus]: https://github.com/edenhaus
+[@jesserockz]: https://github.com/jesserockz
+[@epenet]: https://github.com/epenet
+[@suaveolent]: https://github.com/suaveolent
+
+## Release 2023.11.3 - November 22
+
+- Bump accuweather to version 2.0.1 ([@bieniu] - [#103532])
+- Remove rainbird yaml config test fixtures ([@allenporter] - [#103607])
+- Lock Withings token refresh ([@joostlek] - [#103688])
+- Bump accuweather to version 2.1.0 ([@bieniu] - [#103744])
+- Bump python-matter-server to 4.0.2 ([@bdraco] - [#103760])
+- Bump subarulink to 0.7.9 ([@G-Two] - [#103761])
+- Fix discovery schema for Matter switches ([@marcelveldt] - [#103762])
+- Fix raising vol.Invalid during mqtt config validation instead of ValueError ([@jbouwh] - [#103764])
+- Fix race condition in Matter unsubscribe method ([@marcelveldt] - [#103770])
+- Fix typo in calendar translation ([@jrieger] - [#103789])
+- Fix Rainbird unique to use a more reliable source (mac address) ([@allenporter] - [#101603])
+- Bump pyOverkiz to 1.13.0 ([@iMicknl] - [#103582])
+- Bump pyOverkiz to 1.13.2 ([@iMicknl] - [#103790])
+- Bump aiocomelit to 0.5.2 ([@chemelli74] - [#103791])
+- Bump velbusaio to 2023.11.0 ([@Cereal2nd] - [#103798])
+- Bump pyunifiprotect to 4.21.0 ([@bdraco] - [#103832])
+- Bump lupupy to 0.3.1 ([@suaveolent] - [#103835])
+- Bump gcal_sync to 6.0.1 ([@allenporter] - [#103861])
+- Fix bug in Fitbit config flow, and switch to prefer display name ([@allenporter] - [#103869])
+- Fix for Google Calendar API returning invalid RRULE:DATE rules ([@allenporter] - [#103870])
+- Update Fitbit to avoid a KeyError when `restingHeartRate` is not present ([@allenporter] - [#103872])
+- fix Comelit cover stop ([@chemelli74] - [#103911])
+- Fix Coinbase for new API Structure ([@TomBrien] - [#103930])
+- Bump zwave-js-server-python to 0.54.0 ([@raman325] - [#103943])
+- Update smarttub to 0.0.36 ([@mdz] - [#103948])
+- Fix duplicate Ban file entries ([@fosterchuck] - [#103953])
+- Fix openexchangerates form data description ([@MartinHjelmare] - [#103974])
+- Fix emulated_hue with None values ([@bdraco] - [#104020])
+- Fix netatmo authentication when using cloud authentication credentials ([@deosrc] - [#104021])
+- Fix device tracker see gps accuracy selector ([@MartinHjelmare] - [#104022])
+- Bump pyenphase to 1.14.3 ([@catsmanac] - [#104101])
+- Fix ESPHome BLE client raising confusing error when not connected ([@bdraco] - [#104146])
+- Fix memory leak in ESPHome disconnect callbacks ([@bdraco] - [#104149])
+- Add debug logging for which adapter is used to connect bluetooth devices ([@bdraco] - [#103264])
+- Prevent Bluetooth reconnects from blocking shutdown ([@bdraco] - [#104150])
+- Bump boschshcpy to 0.2.75 ([@tschamm] - [#104159])
+- Fix Local To-do list bug renaming items ([@allenporter] - [#104182])
+- Bump aiosomecomfort to 0.0.22 ([@mkmer] - [#104202])
+- Increase Tomato request timeout ([@ertechdesign] - [#104203])
+- Fix imap does not decode text body correctly ([@jbouwh] - [#104217])
+- Fix mqtt json light allows to set brightness value >255 ([@jbouwh] - [#104220])
+- Handle attributes set to None in prometheus ([@knyar] - [#104247])
+- Catch ClientOSError in renault integration ([@epenet] - [#104248])
+- Restore removed guard for non-string inputs in Alexa ([@jbouwh] - [#104263])
+- Bump bimmer_connected to 0.14.3 ([@rikroe] - [#104282])
+- Bump pyrainbird to 4.0.1 ([@allenporter] - [#104293])
+- Bump pychromecast to 13.0.8 ([@emontnemery] - [#104320])
+- Bump ical to 6.0.0 ([@allenporter] - [#103482])
+- Bump ical to 6.1.0 ([@allenporter] - [#103759])
+
+[#101603]: https://github.com/home-assistant/core/pull/101603
+[#103164]: https://github.com/home-assistant/core/pull/103164
+[#103264]: https://github.com/home-assistant/core/pull/103264
+[#103301]: https://github.com/home-assistant/core/pull/103301
+[#103482]: https://github.com/home-assistant/core/pull/103482
+[#103532]: https://github.com/home-assistant/core/pull/103532
+[#103582]: https://github.com/home-assistant/core/pull/103582
+[#103607]: https://github.com/home-assistant/core/pull/103607
+[#103688]: https://github.com/home-assistant/core/pull/103688
+[#103737]: https://github.com/home-assistant/core/pull/103737
+[#103744]: https://github.com/home-assistant/core/pull/103744
+[#103759]: https://github.com/home-assistant/core/pull/103759
+[#103760]: https://github.com/home-assistant/core/pull/103760
+[#103761]: https://github.com/home-assistant/core/pull/103761
+[#103762]: https://github.com/home-assistant/core/pull/103762
+[#103764]: https://github.com/home-assistant/core/pull/103764
+[#103770]: https://github.com/home-assistant/core/pull/103770
+[#103789]: https://github.com/home-assistant/core/pull/103789
+[#103790]: https://github.com/home-assistant/core/pull/103790
+[#103791]: https://github.com/home-assistant/core/pull/103791
+[#103798]: https://github.com/home-assistant/core/pull/103798
+[#103832]: https://github.com/home-assistant/core/pull/103832
+[#103835]: https://github.com/home-assistant/core/pull/103835
+[#103861]: https://github.com/home-assistant/core/pull/103861
+[#103869]: https://github.com/home-assistant/core/pull/103869
+[#103870]: https://github.com/home-assistant/core/pull/103870
+[#103872]: https://github.com/home-assistant/core/pull/103872
+[#103911]: https://github.com/home-assistant/core/pull/103911
+[#103930]: https://github.com/home-assistant/core/pull/103930
+[#103943]: https://github.com/home-assistant/core/pull/103943
+[#103948]: https://github.com/home-assistant/core/pull/103948
+[#103953]: https://github.com/home-assistant/core/pull/103953
+[#103974]: https://github.com/home-assistant/core/pull/103974
+[#104020]: https://github.com/home-assistant/core/pull/104020
+[#104021]: https://github.com/home-assistant/core/pull/104021
+[#104022]: https://github.com/home-assistant/core/pull/104022
+[#104101]: https://github.com/home-assistant/core/pull/104101
+[#104146]: https://github.com/home-assistant/core/pull/104146
+[#104149]: https://github.com/home-assistant/core/pull/104149
+[#104150]: https://github.com/home-assistant/core/pull/104150
+[#104159]: https://github.com/home-assistant/core/pull/104159
+[#104182]: https://github.com/home-assistant/core/pull/104182
+[#104202]: https://github.com/home-assistant/core/pull/104202
+[#104203]: https://github.com/home-assistant/core/pull/104203
+[#104217]: https://github.com/home-assistant/core/pull/104217
+[#104220]: https://github.com/home-assistant/core/pull/104220
+[#104247]: https://github.com/home-assistant/core/pull/104247
+[#104248]: https://github.com/home-assistant/core/pull/104248
+[#104263]: https://github.com/home-assistant/core/pull/104263
+[#104282]: https://github.com/home-assistant/core/pull/104282
+[#104293]: https://github.com/home-assistant/core/pull/104293
+[#104320]: https://github.com/home-assistant/core/pull/104320
+[@Cereal2nd]: https://github.com/Cereal2nd
+[@G-Two]: https://github.com/G-Two
+[@MartinHjelmare]: https://github.com/MartinHjelmare
+[@TomBrien]: https://github.com/TomBrien
+[@allenporter]: https://github.com/allenporter
+[@bdraco]: https://github.com/bdraco
+[@bieniu]: https://github.com/bieniu
+[@catsmanac]: https://github.com/catsmanac
+[@chemelli74]: https://github.com/chemelli74
+[@deosrc]: https://github.com/deosrc
+[@emontnemery]: https://github.com/emontnemery
+[@epenet]: https://github.com/epenet
+[@ertechdesign]: https://github.com/ertechdesign
+[@fosterchuck]: https://github.com/fosterchuck
+[@frenck]: https://github.com/frenck
+[@iMicknl]: https://github.com/iMicknl
+[@jbouwh]: https://github.com/jbouwh
+[@joostlek]: https://github.com/joostlek
+[@jrieger]: https://github.com/jrieger
+[@knyar]: https://github.com/knyar
+[@marcelveldt]: https://github.com/marcelveldt
+[@mdz]: https://github.com/mdz
+[@mkmer]: https://github.com/mkmer
+[@raman325]: https://github.com/raman325
+[@rikroe]: https://github.com/rikroe
+[@suaveolent]: https://github.com/suaveolent
+[@tschamm]: https://github.com/tschamm
+
## Need help? Join the community!
Home Assistant has a great community of users who are all more than willing
@@ -407,7 +698,7 @@ Are you more into email? [Sign-up for our Building the Open Home Newsletter](/ne
to get the latest news about features, things happening in our community and
other news about building an Open Home; straight into your inbox.
-## Breaking changes
+## Backward-incompatible changes
{% details "Demo" %}
diff --git a/source/_posts/2023-11-06-removal-of-myq-integration.markdown b/source/_posts/2023-11-06-removal-of-myq-integration.markdown
new file mode 100644
index 00000000000..db495d89344
--- /dev/null
+++ b/source/_posts/2023-11-06-removal-of-myq-integration.markdown
@@ -0,0 +1,37 @@
+---
+layout: post
+title: "Removal of MyQ integration"
+description: "Why the MyQ integration will be removed in Home Assistant 2023.12"
+date: 2023-11-06 00:00:00
+date_formatted: "November 6, 2023"
+author: Paulus Schoutsen
+comments: true
+categories: Public-Service-Announcement
+---
+
+**TL;DR:** The MyQ integration will be removed from Home Assistant in release 2023.12 on December 6, 2023. Chamberlain Group, the owners of MyQ, have released a public statement saying they will continue blocking access to third-party apps, like the MyQ integration. For current MyQ users we recommend [ratgdo], a device that physically connects to your MyQ garage door opener and allows you to control it locally.
+
+If you own a garage door opener from Chamberlain or Liftmaster, you are probably familiar with MyQ. It’s a cloud-based smart home brand owned by Chamberlain Group, best known for its smart garage devices. MyQ is also currently one of the most problematic integrations for Home Assistant users. The MyQ garage door opener integration has, for the past months, been in a state of [constant repair](https://community.home-assistant.io/t/the-current-state-of-myq-from-the-codeowner/630623) as the integration breaks, is fixed, and then breaks again. This is a direct result of actions taken by MyQ to block access from third parties.
+
+
+Last month, Chamberlain Group put out a [statement](https://chamberlaingroup.com/press/a-message-about-our-decision-to-prevent-unauthorized-usage-of-myq) by their CTO, Dan Phillips, on this matter:
+
+> Chamberlain Group recently made the decision to prevent unauthorized usage of our myQ ecosystem through third-party apps. This decision was made so that we can continue to provide the best possible experience for our 10 million+ users, as well as our authorized partners who put their trust in us. We understand that this impacts a small percentage of users, but ultimately this will improve the performance and reliability of myQ, benefiting all of our users.
+
+This _‘unauthorized usage’_ appears to refer to the MyQ integration for Home Assistant which was added to Home Assistant in February, 2017. We have reached out to Chamberlain Group in several ways to see if we can come to an understanding, but we have not received an official response. We can only assume that this means Chamberlain Group has made its decision and will force customers to use only the MyQ app or those of their authorized partners.
+
+You may wonder if Home Assistant could become an authorized partner. In their partner program, the partner companies pay Chamberlain Group for the privilege of letting MyQ owners control their own garage doors. We are open to working together with Chamberlain Group, but as Home Assistant is an open-source project, we cannot pay a partnership fee. Not only is this financially not viable, it also goes against our values. MyQ users should be able to access the devices they paid for and the data they own in any way they want, without a third party having to pay an additional fee.
+
+So, to quote the maintainer of the MyQ integration, [Lash-L](https://github.com/Lash-L):
+
+> We are playing a game of cat and mouse with MyQ and right now it looks like the cat is winning.
+
+Once a company decides to be hostile to its customers, the only way we can win is by not playing their game at all. Do not buy products or services from companies that treat their customers this way. Tell your friends not to deal with companies that treat their customers this way. Buy products that work locally and won’t stop functioning when management wants an additional revenue stream.
+
+Because we cannot continue to work around Chamberlain Group if they keep blocking access to third parties, the MyQ integration will be removed from Home Assistant in the upcoming 2023.12 release on December 6, 2023. We are very disappointed that it has come to this and sincerely hope that Chamberlain Group is willing to reconsider its position. We would happily welcome this integration back if Chamberlain Group would work with us for the good of their customers.
+
+For now, if you are a MyQ owner, we’re afraid you are in the ‘small percentage of users’ Chamberlain Group refuses to serve. We recommend buying [ratgdo].
+
+Ratgdo is a fully local, ESPHome-based, solution that is compatible with MyQ’s security+ protocol and can be installed on an existing MyQ system by connecting three wires. It offers the same garage door controls that MyQ does and even adds features that MyQ does not have, like motion events, controlling the light, and locking out wired remotes.
+
+[ratgdo]: https://paulwieland.github.io/ratgdo/
diff --git a/source/_posts/2023-11-16-home-assistant-green-now-available.markdown b/source/_posts/2023-11-16-home-assistant-green-now-available.markdown
new file mode 100644
index 00000000000..8ee13a99681
--- /dev/null
+++ b/source/_posts/2023-11-16-home-assistant-green-now-available.markdown
@@ -0,0 +1,25 @@
+---
+layout: post
+title: "Home Assistant Green is now available"
+description: "Our global distributor network has Home Assistant Green back in stock."
+date: 2023-11-16 00:00:02
+date_formatted: "November 16, 2023"
+author: Guy Sie
+comments: true
+categories: Announcements
+og_image: /images/blog/2023-11-green-release/green-image.jpg
+---
+
+We're happy to tell you that Home Assistant Green is now available from most of the distributors in our global network. If you were waiting for a store closer to your location to sell Home Assistant Green, check out our distributor list now to find one near you:
+
+Buy Home Assistant Green
+
+
+
+When we launched Home Assistant Green during our [10-year birthday stream](/blog/2023/09/17/10-years-home-assistant/), we had an anniversary batch of 1000 units, which sold out very quickly. If you missed out on that anniversary batch, you've either been waiting for new stock to arrive or you have already pre-ordered from one of our distributors. The good news is that many of our distributors now have stock, and your pre-order should be shipped out soon! For those who have been waiting for new stock, now is your chance to order a Home Assistant Green. We have distributors shipping from the United States, the European Union, the United Kingdom, Australia, and China.
+
+For more information about Home Assistant Green, visit our [product page](/green) or watch the team at Nabu Casa talk about Home Assistant Green's development and features in our anniversary video.
+
+
+Watch on YouTube: Home Assistant 10th Anniversary Event #HA10
+
diff --git a/source/changelogs/core-2022.8.markdown b/source/changelogs/core-2022.8.markdown
index 9be7269e7fa..683d9502260 100644
--- a/source/changelogs/core-2022.8.markdown
+++ b/source/changelogs/core-2022.8.markdown
@@ -435,7 +435,7 @@ For a summary in a more readable format:
- Bump pymazda to 0.3.7 ([@bdr99] - [#75546]) ([mazda docs]) (dependency)
- Hide inactive repairs issues ([@emontnemery] - [#75556]) ([repairs docs])
- Add sync methods for create/deleting issues in repairs ([@frenck] - [#75557]) ([repairs docs])
-- Update icons for breaking changes in MDI 7.0.96 ([@bramkragten] - [#75560]) ([huawei_lte docs]) ([icloud docs]) ([netgear docs]) (breaking-change) (noteworthy)
+- Update icons for backward-incompatible changes in MDI 7.0.96 ([@bramkragten] - [#75560]) ([huawei_lte docs]) ([icloud docs]) ([netgear docs]) (breaking-change) (noteworthy)
- Add websocket command recorder/import_statistics ([@titilambert] - [#73937]) ([recorder docs]) (noteworthy)
- Improve http decorator typing ([@cdce8p] - [#75541]) ([http docs]) ([auth docs]) ([repairs docs])
- Deprecate U.S. Citizenship and Immigration Services (USCIS) integration ([@frenck] - [#75562]) ([uscis docs]) (deprecation)
diff --git a/source/changelogs/core-2023.5.markdown b/source/changelogs/core-2023.5.markdown
index 7b584236156..bdbe61e16b5 100644
--- a/source/changelogs/core-2023.5.markdown
+++ b/source/changelogs/core-2023.5.markdown
@@ -599,7 +599,7 @@ For a summary in a more readable format:
- Fix unknown/unavailable source sensor in Filter entities ([@frenck] - [#92241])
- Bump plugwise to v0.31.1 ([@bouwew] - [#92249])
- Bump pyunifiprotect to 4.8.3 ([@bdraco] - [#92251])
-- Pin `pyasn1` and `pysnmplib` since `pyasn1` 0.5.0 has breaking changes and `pysnmp-pyasn1` and `pyasn1` are both using the `pyasn1` namespace ([@bdraco] - [#92254])
+- Pin `pyasn1` and `pysnmplib` since `pyasn1` 0.5.0 has backward-incompatible changes and `pysnmp-pyasn1` and `pyasn1` are both using the `pyasn1` namespace ([@bdraco] - [#92254])
- Handle onvif errors when detail is returned as bytes ([@bdraco] - [#92259])
- Add VoIP error tone ([@synesthesiam] - [#92260])
- Fix Google Mail Sensor key error ([@tkdrob] - [#92262])
diff --git a/source/common-tasks/container.markdown b/source/common-tasks/container.markdown
index 1419aa72931..18464daa94c 100644
--- a/source/common-tasks/container.markdown
+++ b/source/common-tasks/container.markdown
@@ -1,5 +1,5 @@
---
-title: "Common Tasks - Container"
+title: "Common tasks - Container"
description: "Common tasks for Home Assistant Container"
installation: container
---
diff --git a/source/common-tasks/core.markdown b/source/common-tasks/core.markdown
index 21403eaf930..04066e649f2 100644
--- a/source/common-tasks/core.markdown
+++ b/source/common-tasks/core.markdown
@@ -1,5 +1,5 @@
---
-title: "Common Tasks - Core"
+title: "Common tasks - Core"
description: "Common tasks for Home Assistant Core"
installation: core
---
diff --git a/source/common-tasks/os.markdown b/source/common-tasks/os.markdown
index 550a6b6345c..73be58794e5 100644
--- a/source/common-tasks/os.markdown
+++ b/source/common-tasks/os.markdown
@@ -1,5 +1,5 @@
---
-title: "Common Tasks - Operating System"
+title: "Common tasks - Operating System"
description: "Common tasks for Home Assistant Operating System"
installation: os
installation_name: "Operating System"
diff --git a/source/common-tasks/supervised.markdown b/source/common-tasks/supervised.markdown
index f5f816d19eb..23adfe85603 100644
--- a/source/common-tasks/supervised.markdown
+++ b/source/common-tasks/supervised.markdown
@@ -1,5 +1,5 @@
---
-title: "Common Tasks - Supervised"
+title: "Common tasks - Supervised"
description: "Common tasks for Home Assistant Supervised"
installation: supervised
installation_name: Supervised
diff --git a/source/dashboards/actions.markdown b/source/dashboards/actions.markdown
index 25bfa59cae0..31de1e1b0aa 100644
--- a/source/dashboards/actions.markdown
+++ b/source/dashboards/actions.markdown
@@ -12,9 +12,9 @@ Actions can be enabled on:
- [Glance](/dashboards/glance/)
- [Light](/dashboards/light/)
- [Picture](/dashboards/picture/)
-- [Picture Element](/dashboards/picture-elements/)
-- [Picture Entity](/dashboards/picture-entity/)
-- [Picture Glance](/dashboards/picture-glance/)
+- [Picture element](/dashboards/picture-elements/)
+- [Picture entity](/dashboards/picture-entity/)
+- [Picture glance](/dashboards/picture-glance/)
## Tap-Action
@@ -202,7 +202,7 @@ double_tap_action:
default: none
{% endconfiguration %}
-## Options For Confirmation
+## Options for confirmation
If you define confirmation as an object instead of boolean, you can add more customization and configurations.
@@ -229,7 +229,7 @@ exemptions:
type: list
{% endconfiguration %}
-## Options For Exemptions
+## Options for exemptions
{% configuration exemptions %}
user:
diff --git a/source/dashboards/badges.markdown b/source/dashboards/badges.markdown
index e64048c79ed..0a32b826a5e 100644
--- a/source/dashboards/badges.markdown
+++ b/source/dashboards/badges.markdown
@@ -63,7 +63,7 @@ state_filter:
type: list
{% endconfiguration %}
-### Options For Entities
+### 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:
@@ -94,7 +94,7 @@ state_filter:
type: list
{% endconfiguration %}
-### Options For state_filter
+### Options for state filter
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:
diff --git a/source/dashboards/views.markdown b/source/dashboards/views.markdown
index 77d9efb8614..27423182592 100644
--- a/source/dashboards/views.markdown
+++ b/source/dashboards/views.markdown
@@ -73,7 +73,7 @@ views:
...
```
-### Options For Visible
+### Options for visible objects
If you define `visible` as objects instead of a boolean to specify conditions for displaying the view tab:
diff --git a/source/getting-started/concepts-terminology.markdown b/source/getting-started/concepts-terminology.markdown
index 056d9df83a3..6c1a71dc11c 100644
--- a/source/getting-started/concepts-terminology.markdown
+++ b/source/getting-started/concepts-terminology.markdown
@@ -1,67 +1,72 @@
---
title: "Concepts and terminology"
-description: "User explanation of Home Assistant basics"
+description: "Explaining some Home Assistant basics"
---
-Now you're in Home Assistant, let's go over important parts of Home Assistant and what they do.
+Now you're in Home Assistant, let's look at the most important concepts.
## Dashboards
-Dashboards are customizable pages to display information in Home Assistant. By default there are two Dashboards: **Overview** and **Energy**. The **Overview** dashboard is the first thing you see after the [onboarding process](/getting-started/onboarding). The image below shows a customized example of the **Overview** dashboard. If you just onboarded, yours will be nearly empty. To learn how to customize your dashboards, refer to the [dashboard](/dashboards) documentation.
+The **Overview** dashboard is the first page you see after the [onboarding process](/getting-started/onboarding). Dashboards are customizable pages to display information in Home Assistant. By default, there are two dashboards: **Overview** and **Energy**. The image below shows a customized example of the **Overview** dashboard. If you just onboarded, your dashboard will be nearly empty. To learn how to customize your dashboards, refer to the [dashboard](/dashboards) documentation.
## Integrations
-Integrations are pieces of software that allow Home Assistant to connect to other software and platforms. For example, a product by Philips called Hue would use the Philips Hue integration and allow Home Assistant to talk to the hardware controller Hue Bridge. Any Home Assistant compatible devices connected to the Hue Bridge would appear in Home Assistant as [devices](#devices--entities).
+Integrations are pieces of software that allow Home Assistant to connect to other software and platforms. For example, a product by Philips called Hue would use the Philips Hue {% term integration %} and allow Home Assistant to talk to the hardware controller Hue Bridge. Any Home Assistant compatible {% term devices %} connected to the Hue Bridge would appear in Home Assistant as [devices](#devices--entities).
-For a full list of compatible integrations, refer to the [integrations](/integrations) documentation.
+For a full list of compatible {% term integrations %}, refer to the [integrations](/integrations) documentation.
-Once an integration has been added, the hardware and/or data are represented in Home Assistant as [devices and entities](#devices--entities).
+Once an {% term integration %} has been added, the hardware and/or data are represented in Home Assistant as [devices and entities](#devices--entities).
-## Devices & entities
+## Entities
-Devices are a logical grouping for one or more entities. A {% term device %} may represent a physical device which can have one or more sensors. The sensors appear as entities associated to the device. For example, a motion sensor is represented as a device. It may provide motion detection, temperature, and light levels as entities. Entities have states such as *detected* when motion is detected and *clear* when there is no motion.
+Entities are the basic building blocks to hold data in Home Assistant. An {% term entity %} represents a {% term sensor %}, actor, or function in Home Assistant. Entities are used to monitor physical properties or to control other {% term entities %}. An {% term entity %} is usually part of a {% term device %} or a {% term service %}. Entities have {% term states %}.
-
+## Devices
+
+Devices are a logical grouping for one or more {% term entities %}. A {% term device %} may represent a physical {% term device %}, which can have one or more sensors. The sensors appear as entities associated with the {% term device %}. For example, a motion sensor is represented as a {% term device %}. It may provide motion detection, temperature, and light levels as {% term entities %}. Entities have states such as *detected* when motion is detected and *clear* when there is no motion.
+
+
Devices and entities are used throughout Home Assistant. To name a few examples:
-- [Dashboards](#dashboards) can show a state of an entity. For example, if a light is on or off.
-- An [automation](#automations) can be triggered from a state change on an entity. For example, a motion sensor detects motion and triggers a light to turn on.
+- [Dashboards](#dashboards) can show a state of an {% term entity %}. For example, if a light is on or off.
+- An [automation](#automations) can be triggered from a state change on an {% term entity %}. For example, a motion sensor entity detects motion and triggers a light to turn on.
- A predefined color and brightness setting for a light saved as a [scene](#scenes).
-
+
## Automations
-A set of repeatable actions that can be set up to run automatically. Automations are made of three key components:
-1. Triggers - event(s) that start an automation like when the sun sets.
-2. Conditions - optional tests that must be met before continuing to running actions. For example, if someone is home.
-3. Actions - interact with devices such as turn on a light.
+A set of repeatable {% term actions %} that can be set up to run automatically. Automations are made of three key components:
-To learn the basics about automations, refer to the [automation basics](/docs/automation/basics/) page or try [creating an automation](/getting-started/automation) yourself.
+1. Triggers - events that start an {% term automation %}. For example, when the sun sets or a motion sensor is activated.
+2. Conditions - optional tests that must be met an {% term action %} can be run. For example, if someone is home.
+3. Actions - interact with {% term devices %} such as turn on a light.
+
+To learn the basics about {% term automations %}, refer to the [automation basics](/docs/automation/basics/) page or try [creating an automation](/getting-started/automation) yourself.
## Scripts
-Similar to automations, repeatable actions that can be run. The difference between scripts and automations is that scripts do not have triggers like automations. This means that scripts cannot automatically run unless they are used in an automation. Scripts are particularly useful if you perform the same actions in different automations or trigger them from a dashboard. For information on how to create scripts, refer to the [scripts](/integrations/script/) documentation.
+Similar to {% term automations %}, scripts are repeatable {% term actions %} that can be run. The difference between {% term scripts %} and {% term automations %} is that {% term scripts %} do not have triggers. This means that {% term scripts %} cannot automatically run unless they are used in an {% term automations %}. Scripts are particularly useful if you perform the same {% term actions %} in different {% term automations %} or trigger them from a dashboard. For information on how to create {% term scripts %}, refer to the [scripts](/integrations/script/) documentation.
## Scenes
-Scenes allow you to create predefined settings for your devices. Similar to a driving mode on phones, or driver profiles in cars, it can change an environment to suit you. For example, your *watching films* scene may dim the lighting, switch on the TV and increase its volume. This can be saved as a scene and used without having to set individual devices every time.
+Scenes allow you to create predefined settings for your {% term devices %}. Similar to a driving mode on phones, or driver profiles in cars, it can change an environment to suit you. For example, your *watching films* {% term scene %} may dim the lighting, switch on the TV and increase its volume. This can be saved as a {% term scene %} and used without having to set individual {% term devices %} every time.
-To learn how to use scenes, refer to the [scene](/integrations/scene/) documentation.
+To learn how to use {% term scenes %}, refer to the [scene](/integrations/scene/) documentation.
## Add-ons
-Depending on your [installation type](/installation), you can install third party add-ons. Add-ons are usually apps that can be run with Home Assistant but provide a quick and easy way to install, configure, and run within Home Assistant. Add-ons provide additional functionality whereas integrations connect Home Assistant to other apps.
+Depending on your [installation type](/installation), you can install third party add-ons. Add-ons are usually apps that can be run with Home Assistant but provide a quick and easy way to install, configure, and run within Home Assistant. Add-ons provide additional functionality whereas {% term integrations %} connect Home Assistant to other apps.
diff --git a/source/getting-started/onboarding_dashboard.markdown b/source/getting-started/onboarding_dashboard.markdown
index 7ee492894c1..bef7cd9eeb5 100644
--- a/source/getting-started/onboarding_dashboard.markdown
+++ b/source/getting-started/onboarding_dashboard.markdown
@@ -27,6 +27,7 @@ The procedure below is optional. The idea is to learn some basics on changing th
4. To change the type of dashboard card, select the three-dots, then **Device info**.
+ - You may be asked to *Take control of your dashboard*. Read and accept this before continuing.
- Under **Sensors**, select **Add to dashboard**, then **Pick different card**.
diff --git a/source/green/index.html b/source/green/index.html
index 066edd0899f..f32ebbe2820 100644
--- a/source/green/index.html
+++ b/source/green/index.html
@@ -2309,12 +2309,27 @@ frontpage_image: /images/frontpage/green-frontpage.png
-Screenshot of the Alarm Panel card.
+Screenshot of the alarm panel card.
-Screenshot of the Alarm Panel card.
+Screenshot of the alarm panel card.
- Screenshot of the Area card.
+ 
-Screenshot of three Button Cards.
+
-Screenshot of the Button card with Script Service.
+
- Screenshot of the Calendar card.
+ Screenshot of the calendar card.
-Screenshot of the Entity Filter card.
+
Screenshot of the Entity card.
-Screenshot of the Gauge card.
+Screenshot of the gauge card.
-Screenshot of the Gauge card in needle mode.
+Screenshot of the gauge card in needle mode.
-Screenshot of the Glance card.
+Screenshot of the glance card.
- Screenshot of the Grid card.
+ Screenshot of the grid card.
-Screenshot of the History Graph card, when the sensor has no `unit_of_measurement` defined.
+Screenshot of the history graph card, when the sensor has no `unit_of_measurement` defined.
-Screenshot of the History Graph card, when the sensor has a `unit_of_measurement` defined.
+Screenshot of the history graph card, when the sensor has a `unit_of_measurement` defined.
- Two Picture cards in a Horizontal Stack card.
+ Two picture cards in a horizontal stack card.
Screenshot of the humidifier card.
- Windy weather radar as Webpage.
+ Windy weather radar as webpage.
-Screenshot of the Light card.
+Screenshot of the light card.
- Screenshot of the Logbook card.
+ Screenshot of the logbook card.
Screenshot of the map card.
-Screenshot of the Media Control card.
+Screenshot of the media control card.
@@ -14,9 +14,9 @@ The Picture Elements card is one of the most versatile types of cards.
The cards allow you to position icons or text and even services on an image based on coordinates. Imagine floor plan, imagine [picture-glance](/dashboards/picture-glance/) with no restrictions!
-To add the Picture Elements card to your user interface, click the menu (three dots at the top right of the screen) and then **Edit Dashboard**. Click the **Add Card** button in the bottom right corner and select from the card picker.
+{% include dashboard/edit_dashboard.md %}
-## YAML Configuration
+## YAML configuration
This card can only be configured in YAML.
@@ -70,7 +70,7 @@ Elements are the active components (icons, badges, buttons, text, etc.) that ove
There are several different element types that can be added to a Picture Elements card:
-- [State Badge](#state-badge)
+- [State badge](#state-badge)
- [State Icon](#state-icon)
- [State Label](#state-label)
- [Service Call Button](#service-call-button)
@@ -79,7 +79,7 @@ There are several different element types that can be added to a Picture Element
- [Conditional](#conditional-element)
- [Custom](#custom-elements)
-### State Badge
+### State badge
This element creates a badge representing the state of an entity.
@@ -115,7 +115,7 @@ double_tap_action:
type: map
{% endconfiguration %}
-### State Icon
+### State icon
This element represents an entity state using an icon.
@@ -160,7 +160,7 @@ style:
default: "position: absolute, transform: translate(-50%, -50%)"
{% endconfiguration %}
-### State Label
+### State label
This element represents an entity's state via text.
@@ -208,7 +208,7 @@ style:
default: "position: absolute, transform: translate(-50%, -50%)"
{% endconfiguration %}
-### Service Call Button
+### Service call button
This entity creates a button (with arbitrary text) that can be used to call a service.
@@ -236,7 +236,7 @@ style:
default: "position: absolute, transform: translate(-50%, -50%)"
{% endconfiguration %}
-### Icon Element
+### Icon element
This element creates a static icon that is not linked to the state of an entity.
@@ -276,7 +276,7 @@ style:
default: "position: absolute, transform: translate(-50%, -50%)"
{% endconfiguration %}
-### Image Element
+### Image element
This creates an image element that overlays the background image.
@@ -342,7 +342,7 @@ style:
default: "position: absolute, transform: translate(-50%, -50%)"
{% endconfiguration %}
-### Conditional Element
+### Conditional element
Much like the Conditional card, this element will let you show its sub-elements based on entity states.
@@ -374,7 +374,7 @@ elements:
type: list
{% endconfiguration %}
-### Custom Elements
+### Custom elements
The process for creating and referencing custom elements is the same as for custom cards.
Please see the [developer documentation](https://developers.home-assistant.io/docs/frontend/custom-ui/custom-card)
@@ -392,7 +392,7 @@ style:
default: "position: absolute, transform: translate(-50%, -50%)"
{% endconfiguration %}
-## Options For Exemptions
+## Options for exemptions
{% configuration badges %}
user:
@@ -502,7 +502,7 @@ elements:
left: 10%
```
-### Images Example
+### Images example
```yaml
type: picture-elements
@@ -551,7 +551,7 @@ elements:
width: 5%
```
-### Conditional Example
+### Conditional example
```yaml
type: picture-elements
diff --git a/source/_dashboards/picture-entity.markdown b/source/_dashboards/picture-entity.markdown
index a3b2b9a6c54..e3f14b9eecc 100644
--- a/source/_dashboards/picture-entity.markdown
+++ b/source/_dashboards/picture-entity.markdown
@@ -1,22 +1,22 @@
---
type: card
-title: Picture Entity Card
-sidebar_label: Picture Entity
-description: The Picture Entity card displays an entity in the form of an image. Instead of images from URL, it can also show the picture of camera entities.
+title: Picture entity card
+sidebar_label: Picture entity
+description: The picture entity card displays an entity in the form of an image. Instead of images from URL, it can also show the picture of camera entities.
---
-The Picture Entity card displays an entity in the form of an image. Instead of images from URL, it can also show the picture of `camera` entities.
+The picture entity card displays an entity in the form of an image. Instead of images from URL, it can also show the picture of `camera` entities.
Background changes according to the entity state.
Picture glance card for a living room.
+ Picture glance card to control the camera.
+
Screenshot of the picture card.
Screenshot of the plant status card.
Screenshot of the sensor card.
-Screenshot of the Shopping List card.
+Screenshot of the shopping list card.
-Screenshot of the Statistics Graph card with none metered entities and `chart_type` `line`.
+Screenshot of the statistics graph card with none metered entities and `chart_type` `line`.
-Screenshot of the Statistics Graph card with a metered entity and `chart_type` `bar`.
+Screenshot of the statistics graph card with a metered entity and `chart_type` `bar`.
- Screenshot of the Thermostat card.
+ 
+ Screenshot of the thermostat card.
- Screenshot of Tile cards.
+ Screenshot of tile cards.
- Screenshot of the Weather card.
+ Screenshot of the weather card.
@@ -29,7 +29,7 @@ The most common way you can find icons is by using the icon picker built right i
-Screenshot of Home Assistant's Developer Tools.
+Screenshot of Home Assistant's developer tools.
-#### Doorbell Announcement with binary_sensor
+#### Doorbell announcement with binary_sensor
Requires [Proactive Events](#proactive-events) enabled.
@@ -755,7 +755,7 @@ Covers that support tilt position can be controlled using percentages.
Currently, Alexa only supports friendly name synonyms for the `en-US` locale.
-#### Garage Doors
+#### Garage doors
Covers with a `device_class` of `garage` support the Open by Voice PIN feature in the Alexa app. Configure a 4 digit PIN code to open the garage door in the Alexa app.
@@ -768,7 +768,7 @@ Covers with a `device_class` of `garage` support the Open by Voice PIN feature i
Requires [Proactive Events](#proactive-events) enabled.
-#### Doorbell Events
+#### Doorbell events
Home Assistant `event` entities can trigger a doorbell announcement in Alexa if the `device_class` of the `event` entity is set to `doorbell`.
Alexa will announce on all echo devices _"Someone is at the [entity name]"_ when an `event` entity has received an updated.
@@ -786,7 +786,7 @@ Each Amazon Echo device will need the communication and announcements setting en
Control fan speed, direction, and oscillation.
-#### Fan Speed
+#### Fan speed
The fan device must support percentage based speeds with the `percentage` attribute.
diff --git a/source/_integrations/alpha_vantage.markdown b/source/_integrations/alpha_vantage.markdown
index 940f0aadddf..5f837f1c9ec 100644
--- a/source/_integrations/alpha_vantage.markdown
+++ b/source/_integrations/alpha_vantage.markdown
@@ -73,7 +73,7 @@ foreign_exchange:
type: string
{% endconfiguration %}
-## API Information
+## API information
Alpha Vantage offers two tiers of the API key, one free and one paid for. If you are using the free version you will be limited to five queries per minute. This means that you'll likely only be able to have one or two ticker entries. The paid version starts at thirty queries per minute increasing ticker quantity quite a bit.
diff --git a/source/_integrations/amberelectric.markdown b/source/_integrations/amberelectric.markdown
index e1bb24d075e..b74b52d5f4c 100644
--- a/source/_integrations/amberelectric.markdown
+++ b/source/_integrations/amberelectric.markdown
@@ -18,11 +18,11 @@ ha_integration_type: integration
[Amber](https://www.amber.com.au/) is an Australian electricity retailer that provides access to wholesale electricity prices. Customers monitor the wholesale price and shift their energy usage to cheaper, greener times. This saves them money and supports the shift to a more renewably-powered Australia.
-Using this integration, customers can go a step further - setting up devices to automatically shift energy usage to cheaper and greener times, based on real-time electricity prices and forecasts
+Using the **Amber Electric** {% term integration %}, customers can go a step further - setting up devices to automatically shift energy usage to cheaper and greener times, based on real-time electricity prices and forecasts
## Getting an API Key
-To use this integration, you will need to generate an API key.
+To use this {% term integration %}, you will need to generate an API key.
1. Login to your Amber account at: 
diff --git a/source/_integrations/cover.markdown b/source/_integrations/cover.markdown
index e4755285473..bc167863554 100644
--- a/source/_integrations/cover.markdown
+++ b/source/_integrations/cover.markdown
@@ -15,7 +15,7 @@ Home Assistant can give you an interface to control covers such as rollershutter
{% include integrations/building_block_integration.md %}
-## Device Class
+## Device class
The way these {% term sensors %} are displayed in the {% term frontend %} can be modified in the [customize section](/docs/configuration/customizing-devices/). The following device classes are supported for covers:
diff --git a/source/_integrations/cover.template.markdown b/source/_integrations/cover.template.markdown
index 51a03e33f8a..7c6ca4cba10 100644
--- a/source/_integrations/cover.template.markdown
+++ b/source/_integrations/cover.template.markdown
@@ -1,6 +1,6 @@
---
-title: "Template Cover"
-description: "Instructions on how to integrate Template Covers into Home Assistant."
+title: "Template cover"
+description: "Instructions on how to integrate template covers into Home Assistant."
ha_category:
- Cover
ha_release: 0.48
@@ -91,11 +91,11 @@ cover:
required: false
type: action
set_cover_position:
- description: Defines an action to set to a cover position (between `0` and `100`).
+ description: Defines an action to set to a cover position (between `0` and `100`). The variable `position` will contain the entity's set position.
required: false
type: action
set_cover_tilt_position:
- description: Defines an action to set the tilt of a cover (between `0` and `100`).
+ description: Defines an action to set the tilt of a cover (between `0` and `100`). The variable `tilt` will contain the entity's set tilt position.
required: false
type: action
optimistic:
@@ -130,7 +130,7 @@ with this equivalent that returns `true`/`false` and never gives an unknown
result:
{% raw %}`{{ is_state('cover.source', 'open') }}`{% endraw %}
-## Optimistic Mode
+## Optimistic mode
In optimistic mode, the cover position state is maintained internally. This mode
is automatically enabled if neither [`value_template`](#value_template) or
@@ -160,7 +160,7 @@ If both a [`value_template`](#value_template) and a [`position_template`](#posit
In this section you will find some real-life examples of how to use this cover.
-### Garage Door
+### Garage door
This example converts a garage door with a controllable switch and position
sensor into a cover. The condition check is optional, but suggested if you
@@ -204,7 +204,7 @@ cover:
{% endraw %}
-### Multiple Covers
+### Multiple covers
This example allows you to control two or more covers at once.
@@ -296,7 +296,7 @@ automation:
{% endraw %}
-### Change The Icon
+### Change the icon
This example shows how to change the icon based on the cover state.
@@ -331,7 +331,7 @@ cover:
{% endraw %}
-### Change The Entity Picture
+### Change the entity picture
This example shows how to change the entity picture based on the cover state.
diff --git a/source/_integrations/cozytouch.markdown b/source/_integrations/cozytouch.markdown
index fa39dbc744c..3df1696c140 100644
--- a/source/_integrations/cozytouch.markdown
+++ b/source/_integrations/cozytouch.markdown
@@ -3,7 +3,7 @@ title: Atlantic Cozytouch
description: Connect and control your Atlantic Cozytouch devices using the Overkiz integration
ha_category:
- Alarm
- - Binary Sensor
+ - Binary sensor
- Button
- Climate
- Cover
@@ -16,7 +16,7 @@ ha_category:
- Sensor
- Siren
- Switch
- - Water Heater
+ - Water heater
ha_domain: cozytouch
ha_integration_type: virtual
ha_supporting_domain: overkiz
diff --git a/source/_integrations/cpuspeed.markdown b/source/_integrations/cpuspeed.markdown
index f1e8b7ee5c2..9073b38aea7 100644
--- a/source/_integrations/cpuspeed.markdown
+++ b/source/_integrations/cpuspeed.markdown
@@ -2,7 +2,7 @@
title: CPU Speed
description: Instructions on how to integrate CPU speed within Home Assistant.
ha_category:
- - System Monitor
+ - System monitor
ha_release: pre 0.7
ha_iot_class: Local Push
ha_codeowners:
diff --git a/source/_integrations/cups.markdown b/source/_integrations/cups.markdown
index 1b7352a687b..34e9ee24ef6 100644
--- a/source/_integrations/cups.markdown
+++ b/source/_integrations/cups.markdown
@@ -2,7 +2,7 @@
title: CUPS
description: Instructions on how to integrate CUPS sensors into Home Assistant.
ha_category:
- - System Monitor
+ - System monitor
ha_iot_class: Local Polling
ha_release: 0.32
ha_codeowners:
diff --git a/source/_integrations/dacia.markdown b/source/_integrations/dacia.markdown
index fe6358422b0..5ce1d6475ad 100644
--- a/source/_integrations/dacia.markdown
+++ b/source/_integrations/dacia.markdown
@@ -2,9 +2,9 @@
title: Dacia
description: Connect and control your Dacia devices using the Renault integration
ha_category:
- - Binary Sensor
+ - Binary sensor
- Car
- - Presence Detection
+ - Presence detection
- Select
- Sensor
ha_domain: dacia
diff --git a/source/_integrations/daikin.markdown b/source/_integrations/daikin.markdown
index e3bfd4a30f3..057ebb290fd 100644
--- a/source/_integrations/daikin.markdown
+++ b/source/_integrations/daikin.markdown
@@ -25,7 +25,7 @@ ha_integration_type: integration
Daikin has removed their local API in newer products. They offer a cloud API accessible only under NDA, which is incompatible with open source. This affects units fitted with the BRP069C4x wifi adapter. Units listed under Supported Hardware below continue to have access to local control. Additionally the older but commonly available BRP072A42 adapter can be fitted to most if not all newer units for access to local control.
-Screenshot of the Download Diagnostics button on the device page
+Screenshot of the download diagnostics button on the device page
-### IR Codes
+### IR codes
The first time the Kira integration is loaded, `kira_codes.yaml` will be created in the Home Assistant configuration directory.
@@ -236,7 +236,7 @@ Example automation using these IR codes to toggle a Sonoff plug.
type: turn_off
```
-### Code Types
+### Code types
When creating an entry in `kira_codes.yaml`, a few different kinds of codes can be used.
diff --git a/source/_integrations/knx.markdown b/source/_integrations/knx.markdown
index ff5d693127d..8a801597ec4 100644
--- a/source/_integrations/knx.markdown
+++ b/source/_integrations/knx.markdown
@@ -3,7 +3,7 @@ title: KNX
description: Instructions on how to integrate KNX components with Home Assistant.
featured: true
ha_category:
- - Binary Sensor
+ - Binary sensor
- Button
- Climate
- Cover
@@ -56,7 +56,7 @@ The integration requires a local KNX/IP interface or router. Through this, it wi
There is currently support for the following device types within Home Assistant:
-- [Binary Sensor](#binary-sensor)
+- [Binary sensor](#binary-sensor)
- [Button](#button)
- [Climate](#climate)
- [Cover](#cover)
@@ -79,7 +79,7 @@ As a Home Assistant KNX user, you can start a FREE KNX online training and get a
{% include integrations/config_flow.md %}
-## Basic Configuration
+## Basic configuration
In order to make use of the various platforms that KNX offers you will need to add the relevant configuration sections to your setup. This could either all be in the Home Assistant main `configuration.yaml` file, or in a separate YAML file that you include in the main file or even be split into multiple dedicated files. See [Splitting up the configuration](/docs/configuration/splitting_configuration/).
@@ -264,7 +264,7 @@ automation:
address: "0/4/21"
```
-### Register Event
+### Register event
The `knx.event_register` service can be used to register (or unregister) group addresses to fire `knx_event` Events. Events for group addresses configured in the `event` key in `configuration.yaml` cannot be unregistered. See [knx_event](#events)
@@ -284,7 +284,7 @@ type:
required: false
{% endconfiguration %}
-### Register Exposure
+### Register exposure
The `knx.exposure_register` service can be used to register (or unregister) exposures to the KNX bus. Exposures defined in `configuration.yaml` can not be unregistered. Per address only one exposure can be registered. See [expose](#exposing-entity-states-entity-attributes-or-time-to-knx-bus)
@@ -373,7 +373,7 @@ respond_to_read:
default: true
{% endconfiguration %}
-## Binary Sensor
+## Binary sensor
The KNX binary sensor platform allows you to monitor [KNX](https://www.knx.org/) binary sensors.
@@ -1664,7 +1664,7 @@ device_class:
type: string
{% endconfiguration %}
-### Value Types
+### Value types
| KNX DPT | type | size in byte | range | unit |
| ------: | ----------------------------- | -----------: | :------------------------: | -------------- |
@@ -1729,7 +1729,7 @@ device_class:
| 12.001 | pulse_4_ucount | 4 | 0 ... 4294967295 | counter pulses |
| 12.100 | long_time_period_sec | 4 | 0 ... 4294967295 | s |
| 12.101 | long_time_period_min | 4 | 0 ... 4294967295 | min |
-| 12.100 | long_time_period_hrs | 4 | 0 ... 4294967295 | h |
+| 12.102 | long_time_period_hrs | 4 | 0 ... 4294967295 | h |
| 12.1200 | volume_liquid_litre | 4 | 0 ... 4294967295 | l |
| 12.1201 | volume_m3 | 4 | 0 ... 4294967295 | m³ |
| 13 | 4byte_signed | 4 | -2147483648 ... 2147483647 | |
diff --git a/source/_integrations/kodi.markdown b/source/_integrations/kodi.markdown
index 5276b49996b..2998e7e6120 100644
--- a/source/_integrations/kodi.markdown
+++ b/source/_integrations/kodi.markdown
@@ -2,8 +2,8 @@
title: Kodi
description: Instructions on how to integrate Kodi into Home Assistant.
ha_category:
- - Media Player
- - Media Source
+ - Media player
+ - Media source
- Notifications
ha_release: pre 0.7
ha_iot_class: Local Push
@@ -24,7 +24,7 @@ The preferred way to set up the Kodi platform is through discovery, which requir
There is currently support for the following device types within Home Assistant:
-- [Media Player](#configuration)
+- [Media player](#configuration)
- [Notifications](#notifications)
{% include integrations/config_flow.md %}
@@ -39,7 +39,7 @@ If you do not remove it, your configuration will be imported with the following
You can customize your turn on and off actions through automations. Simply use the relevant Kodi device triggers and your automation will be called to perform the `turn_on` or `turn_off` sequence; see the [Kodi turn on/off samples](#kodi-turn-onoff-samples) section for scripts that can be used.
-These automations can be configured through the UI (see [Device Triggers](/docs/automation/trigger/#device-triggers) for automations). If you prefer YAML, you'll need to get the device ID from the UI automation editor. Automations would be of the form:
+These automations can be configured through the UI (see [device triggers](/docs/automation/trigger/#device-triggers) for automations). If you prefer YAML, you'll need to get the device ID from the UI automation editor. Automations would be of the form:
```yaml
automation:
diff --git a/source/_integrations/konnected.markdown b/source/_integrations/konnected.markdown
index eea8ec363ef..717107ad37d 100644
--- a/source/_integrations/konnected.markdown
+++ b/source/_integrations/konnected.markdown
@@ -3,7 +3,7 @@ title: Konnected.io
description: Connect wired alarm sensors and siren using the NodeMCU based Konnected Alarm Panel
ha_category:
- Alarm
- - Binary Sensor
+ - Binary sensor
- Sensor
- Switch
ha_iot_class: Local Push
@@ -22,6 +22,12 @@ ha_integration_type: integration
The `konnected` integration lets you connect wired sensors and switches to a Konnected Alarm Panel, or NodeMCU ESP8226 based device running the [open source Konnected software](https://github.com/konnected-io/konnected-security). Reuse the wired sensors and siren from an old or pre-wired alarm system installation and integrate them directly into Home Assistant.
+
@@ -30,7 +30,7 @@ The `roomba` integration allows you to control your [iRobot Roomba](https://www.
-### Full Configuration
+### Full configuration
{% raw %}
diff --git a/source/_integrations/sense.markdown b/source/_integrations/sense.markdown
index 5264e1e1036..a622c5f10ac 100644
--- a/source/_integrations/sense.markdown
+++ b/source/_integrations/sense.markdown
@@ -2,7 +2,7 @@
title: Sense
description: Instructions on how to integrate Sense within Home Assistant.
ha_category:
- - Binary Sensor
+ - Binary sensor
- Energy
- Sensor
ha_iot_class: Cloud Polling
@@ -22,7 +22,7 @@ Integrate your [Sense](https://sense.com) meter information into Home Assistant.
There is currently support for the following device types within Home Assistant:
-- Binary Sensor
+- Binary sensor
- Sensor
{% include integrations/config_flow.md %}
diff --git a/source/_integrations/sensibo.markdown b/source/_integrations/sensibo.markdown
index 75119f39ca9..c62f885ba02 100644
--- a/source/_integrations/sensibo.markdown
+++ b/source/_integrations/sensibo.markdown
@@ -2,7 +2,7 @@
title: Sensibo
description: Instructions on how to integrate Sensibo A/C controller into Home Assistant.
ha_category:
- - Binary Sensor
+ - Binary sensor
- Button
- Climate
- Fan
@@ -76,20 +76,20 @@ You can reset your filter check by using the button available on climate devices
By pressing the button, you tell your device that you have cleaned or replaced the filter.
-## Number Entities
+## Number entities
By using the number entities you can calibrate the temperature and hunmidity of your device.
These entities are disabled by default.
-## Select Entities
+## Select entities
For supported devices, this integration provides support to set the following modes by the select entity:
- Horizontal swing
- Light
-## Sensor Entities
+## Sensor entities
For all devices, these sensors are available:
@@ -130,7 +130,7 @@ For climate devices, these sensors are available:
- Climate React low temperature threshold
- Climate React high temperature threshold
-## Switch Entities
+## Switch entities
For climate devices, these switches are available:
@@ -146,7 +146,7 @@ For Pure devices, this integration provides support to enable/disable Pure Boost
To customize the settings of Pure Boost, you can use the custom `sensibo.enable_pure_boost` service. See [Pure Boost](#pure-boost)
-## Custom Services
+## Custom services
### Full state
diff --git a/source/_integrations/sensor.markdown b/source/_integrations/sensor.markdown
index 5a34766fe85..3579223d514 100644
--- a/source/_integrations/sensor.markdown
+++ b/source/_integrations/sensor.markdown
@@ -15,7 +15,7 @@ Sensors are a basic integration in Home Assistant. They monitor the states and c
Some of these sensors are built-in to Home Assistant, some are created automatically when you add an integration (see this [list](/integrations/#sensor)), and some can be created manually. The [Statistics](/integrations/statistics) and [Template](/integrations/template) sensors are two examples of the last case.
-## Device Class
+## Device class
The type of data a sensor returns impacts how it is displayed in the frontend. This is controlled by the sensor's device class designation. Built-in sensors and many created from an integration will have this designation predefined. Those can be modified in the [customize section](/docs/configuration/customizing-devices/). When manually creating a new sensor the device class may be optionally assigned. A full list of available sensor device classes is below:
diff --git a/source/_integrations/sensor.mqtt.markdown b/source/_integrations/sensor.mqtt.markdown
index bacf9269945..9c8d3222844 100644
--- a/source/_integrations/sensor.mqtt.markdown
+++ b/source/_integrations/sensor.mqtt.markdown
@@ -19,7 +19,8 @@ To use your MQTT sensor in your installation, add the following to your `configu
```yaml
# Example configuration.yaml entry
mqtt:
- - sensor:
+ sensor:
+ - name: "Bedroom Temperature"
state_topic: "home/bedroom/temperature"
```
@@ -233,8 +234,8 @@ Extra attributes will be displayed in the frontend and can also be extracted in
```yaml
# Example configuration.yaml entry
mqtt:
- - sensor:
- name: "RSSI"
+ sensor:
+ - name: "RSSI"
state_topic: "home/sensor1/infojson"
unit_of_measurement: "dBm"
value_template: "{{ value_json.RSSI }}"
@@ -273,14 +274,14 @@ Extra attributes will be displayed in the frontend and can also be extracted in
```yaml
# Example configuration.yaml entry
mqtt:
- - sensor:
- name: "Timer 1"
+ sensor:
+ - name: "Timer 1"
state_topic: "tele/sonoff/sensor"
value_template: "{{ value_json.Timer1.Arm }}"
json_attributes_topic: "tele/sonoff/sensor"
json_attributes_template: "{{ value_json.Timer1 | tojson }}"
- - sensor:
- name: "Timer 2"
+
+ - name: "Timer 2"
state_topic: "tele/sonoff/sensor"
value_template: "{{ value_json.Timer2.Arm }}"
json_attributes_topic: "tele/sonoff/sensor"
@@ -300,8 +301,8 @@ The example below shows how a simple filter, that calculates the value by adding
```yaml
# Example configuration.yaml entry
mqtt:
- - sensor:
- name: "Temp 1"
+ sensor:
+ - name: "Temp 1"
state_topic: "sensor/temperature"
value_template: |-
{% if states(entity_id) == None %}
@@ -338,8 +339,8 @@ Thus the trick is extracting the battery level from the payload.
```yaml
# Example configuration.yaml entry
mqtt:
- - sensor:
- name: "Battery Tablet"
+ sensor:
+ - name: "Battery Tablet"
state_topic: "owntracks/tablet/tablet"
unit_of_measurement: "%"
value_template: "{{ value_json.batt }}"
@@ -366,14 +367,13 @@ Then use this configuration example to extract the data from the payload:
```yaml
# Example configuration.yaml entry
mqtt:
- - sensor:
- name: "Temperature"
+ sensor:
+ - name: "Temperature"
state_topic: "office/sensor1"
suggested_display_precision: 1
unit_of_measurement: "°C"
- value_template: "{{ value_json.temperature }}"
- - sensor:
- name: "Humidity"
+ value_template: "{{ value_json.temperature }}
+ - name: "Humidity"
state_topic: "office/sensor1"
unit_of_measurement: "%"
value_template: "{{ value_json.humidity }}"
@@ -403,7 +403,7 @@ The configuration will look like the example below:
```yaml
# Example configuration.yaml entry
mqtt:
- - sensor:
- name: "Brightness"
+ sensor:
+ - name: "Brightness"
state_topic: "home/bathroom/analog/brightness"
```
diff --git a/source/_integrations/sentry.markdown b/source/_integrations/sentry.markdown
index cf0f2d044f7..5370225c8e7 100644
--- a/source/_integrations/sentry.markdown
+++ b/source/_integrations/sentry.markdown
@@ -2,7 +2,7 @@
title: Sentry
description: Record errors to Sentry.
ha_category:
- - System Monitor
+ - System monitor
ha_iot_class: Cloud Polling
ha_release: 0.104
ha_config_flow: true
diff --git a/source/_integrations/seven_segments.markdown b/source/_integrations/seven_segments.markdown
index 8e16c75f322..65f340eb6aa 100644
--- a/source/_integrations/seven_segments.markdown
+++ b/source/_integrations/seven_segments.markdown
@@ -2,7 +2,7 @@
title: Seven Segments OCR
description: Instructions on how to use OCR for seven segments displays into Home Assistant.
ha_category:
- - Image Processing
+ - Image processing
ha_release: 0.45
og_image: /images/screenshots/ssocr.png
ha_iot_class: Local Polling
diff --git a/source/_integrations/sfr_box.markdown b/source/_integrations/sfr_box.markdown
index 09ca3788f71..9460349ce11 100644
--- a/source/_integrations/sfr_box.markdown
+++ b/source/_integrations/sfr_box.markdown
@@ -21,7 +21,7 @@ The SFR Box integration offers integration with the **SFR** broadband router.
This integration provides the following platforms:
-- Binary Sensors - such as ADSL status.
+- Binary sensors - such as ADSL status.
- Buttons - such as reboot.
- Sensors - such as ADSL line status, attenuation, noise and data rate.
diff --git a/source/_integrations/shelly.markdown b/source/_integrations/shelly.markdown
index 550737d97dc..2459f5b9302 100644
--- a/source/_integrations/shelly.markdown
+++ b/source/_integrations/shelly.markdown
@@ -2,7 +2,7 @@
title: Shelly
description: Integrate Shelly devices
ha_category:
- - Binary Sensor
+ - Binary sensor
- Cover
- Energy
- Light
diff --git a/source/_integrations/shopping_list.markdown b/source/_integrations/shopping_list.markdown
index 83687f56cb3..957202089ed 100644
--- a/source/_integrations/shopping_list.markdown
+++ b/source/_integrations/shopping_list.markdown
@@ -1,9 +1,9 @@
---
-title: Shopping List
+title: Shopping list
description: Instructions on how to integrate a Shopping list into Home Assistant using Intent.
ha_category:
- Intent
- - To-do List
+ - To-do list
ha_release: '0.50'
ha_config_flow: true
ha_quality_scale: internal
@@ -16,7 +16,7 @@ ha_platforms:
The `shopping_list` 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 [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."
{% include integrations/config_flow.md %}
@@ -76,7 +76,7 @@ Sort all items by name in the shopping list.
|------------------------|----------|---------------------------------------------------------------------|
| `reverse` | yes | Whether to sort in reverse (_descending_) order. (default: `False`) |
-## Using in Automations
+## 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.
diff --git a/source/_integrations/sighthound.markdown b/source/_integrations/sighthound.markdown
index 5b4a776870c..c3f3152e11d 100644
--- a/source/_integrations/sighthound.markdown
+++ b/source/_integrations/sighthound.markdown
@@ -2,7 +2,7 @@
title: Sighthound
description: Detect people with Sighthound Cloud.
ha_category:
- - Image Processing
+ - Image processing
ha_release: 0.105
ha_iot_class: Cloud Polling
ha_codeowners:
diff --git a/source/_integrations/simplisafe.markdown b/source/_integrations/simplisafe.markdown
index 8e62a198107..b4c39a37a14 100644
--- a/source/_integrations/simplisafe.markdown
+++ b/source/_integrations/simplisafe.markdown
@@ -26,10 +26,10 @@ The `simplisafe` integration integrates [SimpliSafe home security](https://simpl
There is currently support for the following device types within Home Assistant:
-- **Alarm Control Panel**: reports on the current alarm status and can be used to arm and disarm the system.
-- **CO Detector**: reports on the carbon monoxide sensor status*.
-- **Entry Sensor**: reports on the current entry sensor status*.
-- **Freeze Sensor**: reports on the freeze sensor temperature*.
+- **Alarm control panel**: reports on the current alarm status and can be used to arm and disarm the system.
+- **CO detector**: reports on the carbon monoxide sensor status*.
+- **Entry sensor**: reports on the current entry sensor status*.
+- **Freeze sensor**: reports on the freeze sensor temperature*.
- **Glass Break Sensor**: reports on the glass breakage sensor status*.
- **Lock**: reports on `Door Locks` and can be used to lock and unlock a lock.
- **Motion Sensor**: reports on motion detected*.
diff --git a/source/_integrations/simu.markdown b/source/_integrations/simu.markdown
index 573da357f0a..7d1312feb20 100644
--- a/source/_integrations/simu.markdown
+++ b/source/_integrations/simu.markdown
@@ -3,7 +3,7 @@ title: SIMU LiveIn2
description: Connect and control your SIMU LiveIn2 devices using the Overkiz integration
ha_category:
- Alarm
- - Binary Sensor
+ - Binary sensor
- Button
- Climate
- Cover
@@ -16,7 +16,7 @@ ha_category:
- Sensor
- Siren
- Switch
- - Water Heater
+ - Water heater
ha_domain: simu
ha_integration_type: virtual
ha_supporting_domain: overkiz
diff --git a/source/_integrations/sisyphus.markdown b/source/_integrations/sisyphus.markdown
index 21ef39cb4cd..e7c7cba1954 100644
--- a/source/_integrations/sisyphus.markdown
+++ b/source/_integrations/sisyphus.markdown
@@ -4,7 +4,7 @@ description: Instructions on how to integrate your Sisyphus Kinetic Art Table wi
ha_category:
- Hub
- Light
- - Media Player
+ - Media player
ha_release: 0.75
ha_iot_class: Local Push
ha_codeowners:
@@ -21,9 +21,9 @@ The [Sisyphus](https://sisyphus-industries.com/) integration for Home Assistant
There is currently support for the following device types within Home Assistant:
- **Light** - Can be used to sleep/wake the table or adjust the brightness of the table light.
-- **Media Player** - Can be used to sleep/wake the table, play/pause, move between tracks, or toggle shuffle on and off. The "volume" control adjusts the table's speed.
+- **Media player** - Can be used to sleep/wake the table, play/pause, move between tracks, or toggle shuffle on and off. The "volume" control adjusts the table's speed.
-The Light and Media players will be automatically added for each of your Sisyphus tables, if the Sisyphus integration is configured.
+The light and media players will be automatically added for each of your Sisyphus tables, if the Sisyphus integration is configured.
There are two ways to configure this integration. For the automatic discovery of your table(s), add the following to your `configuration.yaml`:
diff --git a/source/_integrations/sky_hub.markdown b/source/_integrations/sky_hub.markdown
index 3dbde3dd773..aa172202ba5 100644
--- a/source/_integrations/sky_hub.markdown
+++ b/source/_integrations/sky_hub.markdown
@@ -2,7 +2,7 @@
title: Sky Hub
description: Instructions on how to integrate Sky Hub routers into Home Assistant.
ha_category:
- - Presence Detection
+ - Presence detection
ha_release: 0.37
ha_domain: sky_hub
ha_codeowners:
diff --git a/source/_integrations/skybell.markdown b/source/_integrations/skybell.markdown
index 7f4d9b639ee..ce57096cd42 100644
--- a/source/_integrations/skybell.markdown
+++ b/source/_integrations/skybell.markdown
@@ -2,7 +2,7 @@
title: SkyBell
description: Instructions on how to integrate your Skybell HD devices within Home Assistant.
ha_category:
- - Binary Sensor
+ - Binary sensor
- Camera
- Doorbell
- Light
@@ -27,7 +27,7 @@ The `skybell` implementation allows you to integrate your [Skybell.com](http://w
There is currently support for the following device types within Home Assistant:
-- [Binary Sensor](/integrations/skybell/#binary-sensor)
+- [Binary sensor](/integrations/skybell/#binary-sensor)
- [Camera](/integrations/skybell/#camera)
- [Light](/integrations/skybell/#light)
- [Sensor](/integrations/skybell/#sensor)
@@ -37,9 +37,9 @@ Currently only the SkyBell HD is supported by this platform.
{% include integrations/config_flow.md %}
-## Integration Entities
+## Integration entities
-### Binary Sensor
+### Binary sensor
Each added configuration entry will create the following binary sensors:
diff --git a/source/_integrations/slack.markdown b/source/_integrations/slack.markdown
index d9f0a4c719d..8ad84e6e844 100644
--- a/source/_integrations/slack.markdown
+++ b/source/_integrations/slack.markdown
@@ -43,10 +43,11 @@ In `Features/OAuth and Permissions/OAuth Tokens for Your Workspace`:
+6. Ensure that the bot user is added to the channel in which you want it to post. This can be completed in several ways:
-Ensure that the bot user is added to the channel in which you want it to post.
-In Slack, tag the bot user in a message, then add it to the channel.
-
+- Using `/invite @bot` from the channel
+- Tagging the bot user in a message, then adding it to the channel via the Slackbot prompt.
+- Channel settings -> `Integrations` -> `Add apps`
#### Sample App Manifest
diff --git a/source/_integrations/sleepiq.markdown b/source/_integrations/sleepiq.markdown
index 0960d687605..13a2a55faed 100644
--- a/source/_integrations/sleepiq.markdown
+++ b/source/_integrations/sleepiq.markdown
@@ -2,7 +2,7 @@
title: SleepIQ
description: Instructions for how to integrate SleepIQ beds within Home Assistant.
ha_category:
- - Binary Sensor
+ - Binary sensor
- Button
- Health
- Light
@@ -33,7 +33,7 @@ The SleepIQ integration lets you integrate your SleepNumber Bed via [SleepIQ by
There is currently support for the following platforms within Home Assistant:
-- Binary Sensor - View occupancy of each side
+- Binary sensor - View occupancy of each side
- Button - Calibrate the bed
- Button - Stop the pump
- Light - Control lights on supported models
diff --git a/source/_integrations/slimproto.markdown b/source/_integrations/slimproto.markdown
index 1ece1666b79..797e259a1d2 100644
--- a/source/_integrations/slimproto.markdown
+++ b/source/_integrations/slimproto.markdown
@@ -2,7 +2,7 @@
title: SlimProto (Squeezebox players)
description: Instructions on how to integrate a SlimProto-based player (e.g., Squeezebox) into Home Assistant without the need for a media server.
ha_category:
- - Media Player
+ - Media player
ha_release: 2022.5
ha_iot_class: Local Push
ha_domain: slimproto
diff --git a/source/_integrations/smappee.markdown b/source/_integrations/smappee.markdown
index 8674ea52933..6a05c7831d9 100644
--- a/source/_integrations/smappee.markdown
+++ b/source/_integrations/smappee.markdown
@@ -2,7 +2,7 @@
title: Smappee
description: Instructions on how to setup Smappee within Home Assistant.
ha_category:
- - Binary Sensor
+ - Binary sensor
- Energy
- Hub
- Sensor
diff --git a/source/_integrations/smarther.markdown b/source/_integrations/smarther.markdown
index db9ec1a3223..27d4fd83124 100644
--- a/source/_integrations/smarther.markdown
+++ b/source/_integrations/smarther.markdown
@@ -8,7 +8,7 @@ ha_category:
- Environment
- Hub
- Light
- - Media Source
+ - Media source
- Sensor
- Switch
- Weather
diff --git a/source/_integrations/smartthings.markdown b/source/_integrations/smartthings.markdown
index acc12a69753..0df60e43ffd 100644
--- a/source/_integrations/smartthings.markdown
+++ b/source/_integrations/smartthings.markdown
@@ -3,7 +3,7 @@ title: SmartThings
description: Instructions on setting up SmartThings within Home Assistant.
featured: true
ha_category:
- - Binary Sensor
+ - Binary sensor
- Climate
- Cover
- Fan
@@ -124,7 +124,7 @@ Event data payloads are logged at the debug level, see [debugging](#debugging) f
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.
-- [Binary Sensor](#binary-sensor)
+- [Binary sensor](#binary-sensor)
- [Climate](#climate)
- [Cover](#cover)
- [Fan](#fan)
@@ -136,9 +136,9 @@ SmartThings represents devices as a set of [capabilities](https://developer-prev
Support for additional platforms will be added in the future.
-### Binary Sensor
+### Binary sensor
-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.
+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 |
| ------------------------------------------------------------------------------------------------------------------------------------- | -------------- | ---------- |
diff --git a/source/_integrations/smarttub.markdown b/source/_integrations/smarttub.markdown
index c231ff323bd..35e1af34b58 100644
--- a/source/_integrations/smarttub.markdown
+++ b/source/_integrations/smarttub.markdown
@@ -2,7 +2,7 @@
title: SmartTub
description: Instructions on how to integrate SmartTub into Home Assistant.
ha_category:
- - Binary Sensor
+ - Binary sensor
- Climate
- Light
- Sensor
diff --git a/source/_integrations/sms.markdown b/source/_integrations/sms.markdown
index 918722c2301..cb88a588fe7 100644
--- a/source/_integrations/sms.markdown
+++ b/source/_integrations/sms.markdown
@@ -110,7 +110,7 @@ notify_sms_user1:
{% endraw %}
-## Required Hardware
+## Required hardware
You will need a USB GSM stick modem or device like SIM800L v2 connected via USB UART.
diff --git a/source/_integrations/snapcast.markdown b/source/_integrations/snapcast.markdown
index ccb63f7006c..d0d9f38ba0a 100644
--- a/source/_integrations/snapcast.markdown
+++ b/source/_integrations/snapcast.markdown
@@ -2,7 +2,7 @@
title: Snapcast
description: Instructions on how to integrate Snapcast into Home Assistant.
ha_category:
- - Media Player
+ - Media player
ha_release: 0.13
ha_iot_class: Local Push
ha_domain: snapcast
diff --git a/source/_integrations/snmp.markdown b/source/_integrations/snmp.markdown
index 19eb14ff199..530e1eed838 100644
--- a/source/_integrations/snmp.markdown
+++ b/source/_integrations/snmp.markdown
@@ -3,7 +3,7 @@ title: SNMP
description: Instructions on how to integrate SNMP into Home Assistant.
ha_category:
- Network
- - Presence Detection
+ - Presence detection
- Sensor
- Switch
ha_iot_class: Local Polling
@@ -20,7 +20,7 @@ A lot of Wi-Fi access points and Wi-Fi routers support the Simple Network Manage
There is currently support for the following device types within Home Assistant:
-- [Presence Detection](#presence-detection)
+- [Presence detection](#presence-detection)
- [Sensor](#sensor)
- [Switch](#switch)
@@ -28,7 +28,7 @@ There is currently support for the following device types within Home Assistant:
This device tracker needs SNMP to be enabled on the router. It could be that you need to install the SNMP support manually.
-## Presence Detection
+## Presence detection
The following OID examples pull the current MAC Address table from a router. This reflects all recent devices seen on the network. However, since devices are not removed until they time out, this is less effective for [device tracker integration page](/integrations/device_tracker/) than desirable. It is recommended to use [Ping](/integrations/ping) or [Nmap](/integrations/nmap_tracker) instead.
diff --git a/source/_integrations/somfy.markdown b/source/_integrations/somfy.markdown
index 631dae8101d..f21952807b2 100644
--- a/source/_integrations/somfy.markdown
+++ b/source/_integrations/somfy.markdown
@@ -3,7 +3,7 @@ title: Somfy
description: Connect and control your Somfy devices using the Overkiz integration
ha_category:
- Alarm
- - Binary Sensor
+ - Binary sensor
- Button
- Climate
- Cover
@@ -16,7 +16,7 @@ ha_category:
- Sensor
- Siren
- Switch
- - Water Heater
+ - Water heater
ha_domain: somfy
ha_integration_type: virtual
ha_supporting_domain: overkiz
diff --git a/source/_integrations/songpal.markdown b/source/_integrations/songpal.markdown
index 598b353c208..93667c4c949 100644
--- a/source/_integrations/songpal.markdown
+++ b/source/_integrations/songpal.markdown
@@ -2,7 +2,7 @@
title: Sony Songpal
description: Instructions on how to integrate Sony Songpal devices into Home Assistant.
ha_category:
- - Media Player
+ - Media player
ha_iot_class: Local Push
ha_release: 0.65
ha_config_flow: true
diff --git a/source/_integrations/sonos.markdown b/source/_integrations/sonos.markdown
index 2c4de99263b..2f434ffb9ff 100644
--- a/source/_integrations/sonos.markdown
+++ b/source/_integrations/sonos.markdown
@@ -2,7 +2,7 @@
title: Sonos
description: Instructions on how to integrate Sonos devices into Home Assistant.
ha_category:
- - Media Player
+ - Media player
- Sensor
featured: true
ha_release: 0.7.3
@@ -187,7 +187,7 @@ data:
## Services
-The Sonos integration makes various custom services available in addition to the [standard Media Player services](/integrations/media_player/#services).
+The Sonos integration makes various custom services available in addition to the [standard media player services](/integrations/media_player/#services).
### Service `sonos.snapshot`
diff --git a/source/_integrations/soundtouch.markdown b/source/_integrations/soundtouch.markdown
index 7b60eb7bed9..3bef62deaa5 100644
--- a/source/_integrations/soundtouch.markdown
+++ b/source/_integrations/soundtouch.markdown
@@ -2,7 +2,7 @@
title: Bose SoundTouch
description: Instructions on how to integrate Bose SoundTouch devices into Home Assistant.
ha_category:
- - Media Player
+ - Media player
ha_release: 0.34
ha_iot_class: Local Polling
ha_domain: soundtouch
diff --git a/source/_integrations/spc.markdown b/source/_integrations/spc.markdown
index 439ef80f94f..008d13ddb69 100644
--- a/source/_integrations/spc.markdown
+++ b/source/_integrations/spc.markdown
@@ -3,7 +3,7 @@ title: Vanderbilt SPC
description: Instructions on how to setup Vanderbilt SPC devices within Home Assistant.
ha_category:
- Alarm
- - Binary Sensor
+ - Binary sensor
- Hub
ha_release: 0.47
ha_iot_class: Local Push
@@ -21,7 +21,7 @@ Integration with SPC is done through a third-party API gateway called [SPC Web G
There is currently support for the following device types within Home Assistant:
- [Alarm](#alarm)
-- [Binary Sensor](#binary-sensor)
+- [Binary sensor](#binary-sensor)
Home Assistant needs to know where to find the SPC Web Gateway API endpoints, to configure this add the following section to your `configuration.yaml` file:
@@ -69,7 +69,7 @@ automation:
{% endraw %}
-## Binary Sensor
+## Binary sensor
The `spc` platform allows you to get data from your [Vanderbilt SPC](https://www.spcsupportinfo.com/SPCConnectPro/) binary sensors from within Home Assistant.
diff --git a/source/_integrations/speedtestdotnet.markdown b/source/_integrations/speedtestdotnet.markdown
index b22769ebd72..f624baddf6d 100644
--- a/source/_integrations/speedtestdotnet.markdown
+++ b/source/_integrations/speedtestdotnet.markdown
@@ -3,7 +3,7 @@ title: Speedtest.net
description: How to integrate Speedtest.net within Home Assistant.
ha_category:
- Sensor
- - System Monitor
+ - System monitor
ha_release: 0.13
ha_iot_class: Cloud Polling
ha_config_flow: true
@@ -26,7 +26,7 @@ By default, a speed test will be run every hour. You can disable polling using s
{% include common-tasks/define_custom_polling.md %}
-## Integration Sensors
+## Integration sensors
The following sensors are added by the integration:
diff --git a/source/_integrations/splunk.markdown b/source/_integrations/splunk.markdown
index a5d0a7965d4..456c7fdd11d 100644
--- a/source/_integrations/splunk.markdown
+++ b/source/_integrations/splunk.markdown
@@ -51,7 +51,7 @@ verify_ssl:
name:
description: This parameter allows you to specify a friendly name to send to Splunk as the host, instead of using the name of the HEC.
required: false
- default: HASS
+ default: "`HASS`"
type: string
filter:
description: Filters for entities to be included/excluded from Splunk. Default is to include all entities. ([Configure Filter](#configure-filter))
@@ -84,7 +84,7 @@ filter:
type: list
{% endconfiguration %}
-### Configure Filter
+### Configure filter
By default, no entity will be excluded. To limit which entities are being exposed to `Splunk`, you can use the `filter` parameter.
diff --git a/source/_integrations/spotify.markdown b/source/_integrations/spotify.markdown
index ddd213ae8f3..a86c1b6ef12 100644
--- a/source/_integrations/spotify.markdown
+++ b/source/_integrations/spotify.markdown
@@ -2,7 +2,7 @@
title: Spotify
description: Instructions on how to integrate Spotify into Home Assistant.
ha_category:
- - Media Player
+ - Media player
ha_release: 0.43
ha_iot_class: Cloud Polling
ha_config_flow: true
@@ -146,6 +146,6 @@ script:
The `media_content_id` value can be obtained from the Spotify desktop app by clicking on the more options ("...") next to the album art picture, selecting "Share" and then "Copy Spotify URI" or "Copy Playlist Link" (also available in the Spotify phone and web app). Alternatively a Spotify URI string (e.g. `spotify:playlist:5xddIVAtLrZKtt4YGLM1SQ`) can be supplied for the `media_content_id`.
-## Unsupported Devices
+## Unsupported devices
- **Sonos**: Although Sonos is a Spotify Connect device, it is not supported by the official Spotify API.
diff --git a/source/_integrations/squeezebox.markdown b/source/_integrations/squeezebox.markdown
index a4ebd192d32..b902bd3cf67 100644
--- a/source/_integrations/squeezebox.markdown
+++ b/source/_integrations/squeezebox.markdown
@@ -2,7 +2,7 @@
title: Squeezebox (Logitech Media Server)
description: Instructions on how to integrate a Logitech Squeezebox player into Home Assistant.
ha_category:
- - Media Player
+ - Media player
ha_release: pre 0.7
ha_iot_class: Local Polling
ha_domain: squeezebox
diff --git a/source/_integrations/ssdp.markdown b/source/_integrations/ssdp.markdown
index 6c019bf0896..d1a2b498c51 100644
--- a/source/_integrations/ssdp.markdown
+++ b/source/_integrations/ssdp.markdown
@@ -23,7 +23,7 @@ This integration is by default enabled, unless you've disabled or removed the [`
ssdp:
```
-## Discovered Integrations
+## Discovered integrations
The following integrations are automatically discovered by the SSDP integration:
diff --git a/source/_integrations/starline.markdown b/source/_integrations/starline.markdown
index 08fcb80bed0..15cb24d1f73 100644
--- a/source/_integrations/starline.markdown
+++ b/source/_integrations/starline.markdown
@@ -2,10 +2,10 @@
title: StarLine
description: Instructions on how to setup your StarLine account with Home Assistant.
ha_category:
- - Binary Sensor
+ - Binary sensor
- Car
- Lock
- - Presence Detection
+ - Presence detection
- Sensor
- Switch
ha_release: 0.103
@@ -27,10 +27,10 @@ The `starline` integration lets you retrieve data of your [StarLine](https://www
This integration provides the following platforms:
-- Binary Sensors: Hand brake, hood, trunk, alarm status and doors lock state.
+- Binary sensors: Hand brake, hood, trunk, alarm status and doors lock state.
- Device tracker: The location of your car.
- Lock: Control the lock of your car.
-- Sensors: Battery level, SIM card balance, GSM signal level, Fuel Volume, Mileage, OBD Errors, interior temperature and engine temperature.
+- Sensors: Battery level, SIM card balance, GSM signal level, fuel volume, mileage, OBD errors, interior temperature and engine temperature.
- Switches: Start/stop engine, heater (webasto), additional channel and sound the horn.
- Services: Update the state, set update frequency. More details can be found [here](#services).
diff --git a/source/_integrations/starlingbank.markdown b/source/_integrations/starlingbank.markdown
index 173aa1ceb4b..2559e3fe442 100644
--- a/source/_integrations/starlingbank.markdown
+++ b/source/_integrations/starlingbank.markdown
@@ -19,7 +19,7 @@ The Starling Bank sensor platform allows you to monitor your account balance dat
You can find more information about Starling Bank at [their website](https://www.starlingbank.com/). Information on their API can be found on their [developers site](https://developer.starlingbank.com/).
-## Access Token
+## Access token
Once you have your own Starling bank account you will need to sign up for a Starling developer account [here](https://developer.starlingbank.com/signup). You won't need to do any development but you will need to get a "Personal Access Token" that will allow the integration to access your account balance.
diff --git a/source/_integrations/starlink.markdown b/source/_integrations/starlink.markdown
index bfc9f99e4ad..b3f71ab6026 100644
--- a/source/_integrations/starlink.markdown
+++ b/source/_integrations/starlink.markdown
@@ -2,9 +2,9 @@
title: Starlink
description: Instructions on how to integrate Starlink into Home Assistant.
ha_category:
- - Binary Sensor
+ - Binary sensor
- Button
- - Device Tracker
+ - Device tracker
- Network
- Sensor
- Switch
@@ -41,7 +41,7 @@ The Starlink integration allows you to integrate your [Starlink](https://www.sta
- Downlink throughput - The amount of data being downloaded through Starlink
- Last boot time - The time Starlink was last turned on
-### Binary Sensor
+### Binary sensor
- Update available - Whether there is an update pending install
- Obstructed - Whether Dishy is currently obstructed
@@ -62,6 +62,6 @@ The Starlink integration allows you to integrate your [Starlink](https://www.sta
- Stowed - Controls whether Dishy is stowed
-### Device Tracker
+### 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.
diff --git a/source/_integrations/statistics.markdown b/source/_integrations/statistics.markdown
index 635e6010fd0..b1de8075ae0 100644
--- a/source/_integrations/statistics.markdown
+++ b/source/_integrations/statistics.markdown
@@ -158,6 +158,6 @@ unique_id:
### An important note on `max_age` and `sampling_size`
-If both `max_age` and `sampling_size` are given, the considered samples are those within the `max_age` time window but limited to the number of `sample_size` newest samples. Specify a wide-enough `sampling_size` if using an extended `max_age` (e.g., when looking for `max_age` 1 hour, a sensor that produces one measurement per minute should have at least a `sampling_size` of 60 to use all samples within the `max_age` timeframe.)
+If both `max_age` and `sampling_size` are given, the considered samples are those within the `max_age` time window but limited to the number of `sampling_size` newest samples. Specify a wide-enough `sampling_size` if using an extended `max_age` (e.g., when looking for `max_age` 1 hour, a sensor that produces one measurement per minute should have at least a `sampling_size` of 60 to use all samples within the `max_age` timeframe.)
-If only `sample_size` is given there is no time limit. If only `max_age` is given the considered number of samples is unlimited.
+If only `sampling_size` is given there is no time limit. If only `max_age` is given the considered number of samples is unlimited.
diff --git a/source/_integrations/statsd.markdown b/source/_integrations/statsd.markdown
index ec5babec77e..fa8a133762a 100644
--- a/source/_integrations/statsd.markdown
+++ b/source/_integrations/statsd.markdown
@@ -32,7 +32,7 @@ port:
prefix:
description: Prefix to use.
required: false
- default: hass
+ default: "`hass`"
type: string
rate:
description: The sample rate.
diff --git a/source/_integrations/steamist.markdown b/source/_integrations/steamist.markdown
index 4679e6f4ec0..e799f5b8119 100644
--- a/source/_integrations/steamist.markdown
+++ b/source/_integrations/steamist.markdown
@@ -19,7 +19,7 @@ ha_integration_type: integration
The Steamist will allow you to monitor the state of your [Steamist](https://steamist.com/digital-controls/) steam shower and turn on and off the steam generator.
-## Supported Devices
+## Supported devices
- 450 Digital Control
- 550 Digital Control
diff --git a/source/_integrations/stookalert.markdown b/source/_integrations/stookalert.markdown
index 3b509e6f748..661a28ed48a 100644
--- a/source/_integrations/stookalert.markdown
+++ b/source/_integrations/stookalert.markdown
@@ -2,7 +2,7 @@
title: RIVM Stookalert
description: Instructions on how to use Stookalert data within Home Assistant
ha_category:
- - Binary Sensor
+ - Binary sensor
- Environment
ha_release: 0.104
ha_iot_class: Cloud Polling
diff --git a/source/_integrations/stream.markdown b/source/_integrations/stream.markdown
index 7130b2cb7bc..fe21afef397 100644
--- a/source/_integrations/stream.markdown
+++ b/source/_integrations/stream.markdown
@@ -57,7 +57,7 @@ stream:
```
-## Technical Details
+## Technical details
The integration currently supports proxying H.264 and H.265 source streams to the HLS (and LL-HLS) protocol.
diff --git a/source/_integrations/streamlabswater.markdown b/source/_integrations/streamlabswater.markdown
index 27279cb41cf..54261c6b35d 100644
--- a/source/_integrations/streamlabswater.markdown
+++ b/source/_integrations/streamlabswater.markdown
@@ -2,7 +2,7 @@
title: StreamLabs
description: Instructions on how to integrate Streamlabs Water devices with Home Assistant.
ha_category:
- - Binary Sensor
+ - Binary sensor
- Sensor
ha_release: '0.95'
ha_iot_class: Cloud Polling
@@ -23,7 +23,7 @@ Access to the StreamLabs Water API is not free, you must have a StreamPlus™ su
There is currently support for the following device types within Home Assistant:
-- Binary Sensor
+- Binary sensor
- Sensor
In preparation for using this integration you will need to request an API key following the instructions in the [StreamLabs API Getting Started Section](https://developer.streamlabswater.com/docs/getting-started.html). Be sure to request an API key and not an OAuth token.
diff --git a/source/_integrations/subaru.markdown b/source/_integrations/subaru.markdown
index 444e7d3dbb5..60c91c162ad 100644
--- a/source/_integrations/subaru.markdown
+++ b/source/_integrations/subaru.markdown
@@ -4,7 +4,7 @@ description: Instructions on how to setup your Subaru account with Home Assistan
ha_category:
- Car
- Lock
- - Presence Detection
+ - Presence detection
- Sensor
ha_release: 2021.3
ha_iot_class: Cloud Polling
@@ -24,17 +24,18 @@ This integration retrieves vehicle information and actuates remote services prov
This integration requires a telematics equipped Subaru and an active vehicle subscription to the Subaru STARLINK service. Before using this integration, you must first register and have login credentials to [MySubaru](https://www.mysubaru.com).
-Subaru has deployed two generations of telematics, Gen 1 and Gen 2. The latter offers more vehicle sensor information and additional remote capabilities. Use the table below to determine your vehicle's telematics generation and capabilities.
+Subaru has deployed three generations of telematics with different feature sets. Use the table below to determine your vehicle's telematics generation and capabilities. This table is a best guess based upon what Subaru [lists as available features](https://www.subaru.com/vehicle-info/subaru-starlink/starlink-safety-and-security/compare-packages.html?model=&year=).
-| Model | Gen 1 | Gen 2 |
-|-----------|-----------|-------|
-| Ascent | | 2019+ |
-| Crosstrek | 2016-2018 | 2019+ |
-| Forester | 2016-2018 | 2019+ |
-| Impreza | 2016-2018 | 2019+ |
-| Legacy | 2016-2019 | 2020+ |
-| Outback | 2016-2019 | 2020+ |
-| WRX | 2017+ | |
+| Model | Gen 1 | Gen 2 | Gen 3 |
+|-----------|-----------|-----------|-------|
+| Ascent | --- | 2019-2023 | 2024+ |
+| BRZ | --- | 2022-2023 | --- |
+| Crosstrek | 2016-2018 | 2019+ | --- |
+| Forester | 2016-2018 | 2019+ | --- |
+| Impreza | 2016-2018 | 2019-2022 | 2023+ |
+| Legacy | 2016-2019 | 2020-2022 | 2023+ |
+| Outback | 2016-2019 | 2020-2022 | 2023+ |
+| WRX | 2017-2021 | 2022-2023 | --- |
In addition to the telematics generational differences, there are two levels of STARLINK subscriptions, "Safety Plus" and "Security Plus". All remote services (such as locks and location tracking) require a "Security Plus" level subscription.
@@ -48,31 +49,38 @@ If your account includes multiple vehicles, the same PIN will be used for all ve
Available sensors will vary by model, year, and subscription type. The integration will add all supported sensors for your vehicle. Sensor data is usually only updated when the vehicle is turned off unless the [polling option](#options) is enabled.
-| Sensor | Gen 1 | Gen 2 |
-|--------------------------|---------|---------|
-| 12V battery voltage | | ✓ |
-| Average fuel consumption | | ✓ |
-| Distance to empty | | ✓ |
-| EV battery level | | ✓ |
-| EV range | | ✓ |
-| EV time to full charge | | ✓ |
-| External temperature | | ✓ |
-| Odometer | ✓*| ✓ |
-| Tire pressures | | ✓ |
+| Sensor | Gen 1 | Gen 2 | Gen 3 |
+|--------------------------|---------|---------|---------|
+| Average fuel consumption | | ✓ | ✓ |
+| Distance to empty | | ✓ | ✓ |
+| EV battery level | | ✓ | ✓ |
+| EV range | | ✓ | ✓ |
+| EV time to full charge | | ✓ | ✓ |
+| Odometer | ✓*| ✓ | ✓ |
+| Tire pressures | | ✓ | ✓ |
\* Gen 1 odometer only updates every 500 miles 
-Entities are generated, updated and removed automatically with each update from the feed. Each entity defines latitude and longitude and will be shown on the map automatically. The distance in kilometers is available as the state of each entity.
+Entities are generated, updated and removed automatically with each update from the feed. Each {% term entity %} defines latitude and longitude and will be shown on the map automatically. The distance in kilometers is available as the state of each {% term entity %}.
@@ -65,7 +65,7 @@ longitude:
default: Longitude defined in your `configuration.yaml`
{% endconfiguration %}
-### Supported Feed Types
+### Supported feed types
| Description | Feed Type |
|----------------------------------------|--------------------------------------|
@@ -91,9 +91,9 @@ longitude:
| Past 30 Days - All Earthquakes | `past_month_all_earthquakes` |
-## State Attributes
+## State attributes
-The following state attributes are available for each entity in addition to the standard ones:
+The following state attributes are available for each {% term entity %} in addition to the standard ones:
| Attribute | Description |
|--------------------|-------------|
@@ -109,7 +109,7 @@ The following state attributes are available for each entity in addition to the
| type | Type of seismic event: "earthquake" or "quarry". |
-## Full Configuration
+## Full configuration
```yaml
# Example configuration.yaml entry
@@ -121,7 +121,7 @@ geo_location:
latitude: 35.899722
longitude: -120.432778
```
-## Card Example
+## Card example
Assuming you configure this service using `feed_type: past_week_all_earthquakes`, you can create a corresponding map card in a dashboard with the following card:
```yaml
diff --git a/source/_integrations/utility_meter.markdown b/source/_integrations/utility_meter.markdown
index 0853b40ffae..12fbb5cf385 100644
--- a/source/_integrations/utility_meter.markdown
+++ b/source/_integrations/utility_meter.markdown
@@ -18,14 +18,14 @@ ha_config_flow: true
ha_integration_type: helper
---
-The Utility Meter integration provides functionality to track consumptions of various utilities (e.g., energy, gas, water, heating).
+The **Utility Meter** {% term integration %} provides functionality to track consumptions of various utilities (e.g., energy, gas, water, heating).
From a user perspective, utility meters operate in cycles (usually monthly) for billing purposes. This sensor will track a source sensor values, automatically resetting the meter based on the configured cycle. On reset an attribute will store the previous meter value, providing the means for comparison operations (e.g., "did I spend more or less this month?") or billing estimation (e.g., through a sensor template that multiplies the metered value per the charged unit amount).
-Some utility providers have different tariffs according to time/resource availability/etc. The utility meter enables you to define the various tariffs supported by your utility provider and accounts your consumptions in accordance. When tariffs are defined a new entity will show up indicating the current tariff. In order to change the tariff, the user must call a service, usually through an automation that can be based in time or other external source (eg. a REST sensor).
+Some utility providers have different tariffs according to time/resource availability/etc. The utility meter enables you to define the various tariffs supported by your utility provider and accounts your consumptions in accordance. When tariffs are defined a new {% term entity %} will show up indicating the current tariff. In order to change the tariff, the user must call a service, usually through an automation that can be based in time or other external source (eg. a REST sensor).
@@ -76,7 +76,7 @@ Since the last release we have moved all Home Assistant source code etc into its
[Wink]: /integrations/wink#light
[Zeroconf]: /integrations/zeroconf/
-### Breaking changes
+### Backward-incompatible changes
- We have migrated our datetime format to be iso8601. This will only impact you if you are consuming the date times from the API directly. You can ignore this if you are just using Home Assistant via configuration and the frontend.
- The constant `TEMP_CELCIUS` is now correctly called `TEMP_CELSIUS`. Old one is deprecated and will eventually be removed.
- The location of the Docker image has changed. There was no possibility for us to keep maintaining the old image (as it was bound to the GitHub repo under my name) or to make a redirect. So if you are using the Home Assistant Docker image, change it to run `homeassistant/home-assistant:latest` for the latest release and `homeassistant/home-assistant:dev` for the latest dev version.
diff --git a/source/_posts/2016-05-21-release-020.markdown b/source/_posts/2016-05-21-release-020.markdown
index 4c02157bf94..e93fdc16a55 100644
--- a/source/_posts/2016-05-21-release-020.markdown
+++ b/source/_posts/2016-05-21-release-020.markdown
@@ -37,7 +37,7 @@ Tons of new supported things in 0.20.
- Export to [Logentries] support added ([@omgapuppy])
- Group more info dialog allows control of group domain if available (@fignuts)
-### Breaking changes
+### Backward-incompatible changes
- Asus WRT will now default to SSH with Telnet being an option
diff --git a/source/_posts/2016-06-08-super-fast-web-enocean-lirc.markdown b/source/_posts/2016-06-08-super-fast-web-enocean-lirc.markdown
index ea4314df5d3..07760cc74b6 100644
--- a/source/_posts/2016-06-08-super-fast-web-enocean-lirc.markdown
+++ b/source/_posts/2016-06-08-super-fast-web-enocean-lirc.markdown
@@ -37,7 +37,7 @@ Alright, time for the changes:
- Sensor: [DTE Energy Bridge] now supported ([@kylehendricks])
- Media Player: [Kodi] now supports different turn off commands ([@armills])
-### Breaking Changes
+### Backward-incompatible changes
- Our work in the WSGI stack is not fully done yet. We still have a minor issues where retrieving the error log in the about screen can raise an encoding error
- The API used to incorrectly accept a JSON body with form-url-encoded headers. Our cURL examples on the website used to be wrong and have [been updated].
diff --git a/source/_posts/2016-07-01-envisalink-homematic-hdmi-cec-and-sony-bravia-tv.markdown b/source/_posts/2016-07-01-envisalink-homematic-hdmi-cec-and-sony-bravia-tv.markdown
index fc78c91175f..82265807377 100644
--- a/source/_posts/2016-07-01-envisalink-homematic-hdmi-cec-and-sony-bravia-tv.markdown
+++ b/source/_posts/2016-07-01-envisalink-homematic-hdmi-cec-and-sony-bravia-tv.markdown
@@ -44,7 +44,7 @@ On the config side, you can now [store your passwords][secrets] in your OS keyri
- Lock: [Vera] now supported ([@rhooper])
- HTTP: Migrate to CherryPy WSGI server to fix install and runtime problems ([@balloob])
-### Breaking changes
+### Backward-incompatible changes
- Homematic thermostat configuration has changed and now depends on the new [Homematic] component.
diff --git a/source/_posts/2016-07-16-sqlalchemy-knx-join-simplisafe.markdown b/source/_posts/2016-07-16-sqlalchemy-knx-join-simplisafe.markdown
index 2a6eaf58e59..e8afd729c63 100644
--- a/source/_posts/2016-07-16-sqlalchemy-knx-join-simplisafe.markdown
+++ b/source/_posts/2016-07-16-sqlalchemy-knx-join-simplisafe.markdown
@@ -51,7 +51,7 @@ You can omit the `--config` option if you use the default configuration director
Quick hot fix after we found a bug in the migrator where it wouldn't work with a database in a non-standard location. Thanks to [@n8henrie] and [@AlucardZero].
-### Breaking changes
+### Backward-incompatible changes
- Migrating existing databases (see above).
- The [APCUPSd Sensor][apcupsd-sensor] was updated. This will need that you modify your `configuration.yaml` file.
diff --git a/source/_posts/2016-07-30-custom-frontend-panels--jupyter-notebooks--directv.markdown b/source/_posts/2016-07-30-custom-frontend-panels--jupyter-notebooks--directv.markdown
index 682a060920e..3f06ef46985 100644
--- a/source/_posts/2016-07-30-custom-frontend-panels--jupyter-notebooks--directv.markdown
+++ b/source/_posts/2016-07-30-custom-frontend-panels--jupyter-notebooks--directv.markdown
@@ -68,7 +68,7 @@ I would like to do a shoutout to [@fabianhjr]. He has started adding [typing] da
- Hotfix to make sure Z-Wave locks work again. Thanks to @tobiebooth for the quick fix.
-### Breaking changes
+### Backward-incompatible changes
- Google Voice SMS notification support was removed.
diff --git a/source/_posts/2016-08-13-foursquare-fast-com-ffmpeg-gpsd.markdown b/source/_posts/2016-08-13-foursquare-fast-com-ffmpeg-gpsd.markdown
index d611d24a84c..4043c3b2c8a 100644
--- a/source/_posts/2016-08-13-foursquare-fast-com-ffmpeg-gpsd.markdown
+++ b/source/_posts/2016-08-13-foursquare-fast-com-ffmpeg-gpsd.markdown
@@ -58,7 +58,7 @@ This release includes code contributed by 31 different people. The biggest chang
- Media Player cover art would not work when an API password was set. Thanks to [@maddox] for reporting it and [@balloob] for the fix.
-### Breaking changes
+### Backward-incompatible changes
- A new unit system has superseded the temperature unit option in the core configuration. For now it is backwards compatible, but you should update soon:
diff --git a/source/_posts/2016-08-27-notifications-hue-fake-unification.markdown b/source/_posts/2016-08-27-notifications-hue-fake-unification.markdown
index 05d7dd5cc0a..b4c2667ec4e 100644
--- a/source/_posts/2016-08-27-notifications-hue-fake-unification.markdown
+++ b/source/_posts/2016-08-27-notifications-hue-fake-unification.markdown
@@ -46,7 +46,7 @@ Now that we have that great news out of the way, onto this week's release which
## 0.27
-While this release is **#Amazing**, we had to break a few eggs (now you understand the title reference!) to make a beautiful omelette (using home automation obviously) so some platforms and components have needed to introduce breaking changes. Please make sure to read the [Breaking Changes](#breaking-changes) section below.
+While this release is **#Amazing**, we had to break a few eggs (now you understand the title reference!) to make a beautiful omelette (using home automation obviously) so some platforms and components have needed to introduce backward-incompatible changes. Please make sure to read the [Backward-incompatible changes](#backward-incompatible-changes) section below.
### Hue Bridge Emulation
@@ -137,7 +137,7 @@ Along with the new `climate` component, [@Teagan42] and I ([@robbiet480]) decide
- Allow emulating a [Hue] bridge to control entities ([@mgbowen])
- New [Fan][fan] component ([@Teagan42], [@robbiet480])
-### Breaking changes
+### Backward-incompatible changes
- Ecobee3 occupancy sensors have moved from sensor platform to binary sensor platform.
- Forecast.io entity IDs are now like `sensor.forecastio_temperature`. Previously they were like `sensor.weather_temperature`. Apologies for this change, but we needed to make Forecast.io more generic now that we have many weather platforms.
- The [Loop Energy][Loop] sensor configuration format changed slightly, please reformat based on the revised documentation.
diff --git a/source/_posts/2016-09-10-notify-group-reload-api-pihole.markdown b/source/_posts/2016-09-10-notify-group-reload-api-pihole.markdown
index 636c0aefd8b..2f9a10a816d 100644
--- a/source/_posts/2016-09-10-notify-group-reload-api-pihole.markdown
+++ b/source/_posts/2016-09-10-notify-group-reload-api-pihole.markdown
@@ -30,7 +30,7 @@ There are countless bugfixes included in this release which will make your exper
The [Home Assistant API Documentation](https://dev-docs.home-assistant.io/en/dev/) is a great addition to the already existing user documentation. The focus is not end-users but developers who want to get details about the code without actually browsing the code on Github.
### Configuration validation
-The validation of the configuration is still on-going. Approximately 80 % is done. This means that we will propably talk about this topic in the next release notes again. To align the configuration of components and platforms we needed to break some. Please refer to the Breaking changes section to check if you need to update your configuration or simple check your log for configuration validation errors. Thanks to [@kellerza], [@fabaff], [@Teagan42], and [@pvizeli] for your effort!
+The validation of the configuration is still on-going. Approximately 80 % is done. This means that we will propably talk about this topic in the next release notes again. To align the configuration of components and platforms we needed to break some. Please refer to the Backward-incompatible changes section to check if you need to update your configuration or simple check your log for configuration validation errors. Thanks to [@kellerza], [@fabaff], [@Teagan42], and [@pvizeli] for your effort!
### All changes
@@ -87,7 +87,7 @@ The validation of the configuration is still on-going. Approximately 80 % is don
- Allow changing covers using scenes ([@nvella])
- Device tracker - Automatic: Fix polling ([@teagan42])
-### Breaking changes
+### Backward-incompatible changes
- [OpenweatherMap] entity IDs are now like `sensor.owm_temperature`. Previously they were like `sensor.weather_temperature`. Apologies for this change, but we needed to make OpenWeatherMap more generic now that we have many weather platforms.
- Updates of configuration variables due to configuration check or alignment with other platforms. Please update your configuration entries according to the documentation:
diff --git a/source/_posts/2016-09-29-async-sleepiq-emoncms-stocks.markdown b/source/_posts/2016-09-29-async-sleepiq-emoncms-stocks.markdown
index ef115522a8b..4c775aa5db7 100644
--- a/source/_posts/2016-09-29-async-sleepiq-emoncms-stocks.markdown
+++ b/source/_posts/2016-09-29-async-sleepiq-emoncms-stocks.markdown
@@ -22,7 +22,7 @@ There now is support for two new super cool things: Beds and license plates. [@t
### Configuration validation
-On the voluptuous front we have also made great progress. We were able to fully remove the legacy config helpers and have migrated 323 of the 346 components and platforms that needed migrating! This does mean that for some components the configuration has slightly changed, make sure to check out the breaking changes section at the bottom for more info. Thanks everybody for reviewing the Pull requests, testing the changes, and reporting issues.
+On the voluptuous front we have also made great progress. We were able to fully remove the legacy config helpers and have migrated 323 of the 346 components and platforms that needed migrating! This does mean that for some components the configuration has slightly changed, make sure to check out the backward-incompatible changes section at the bottom for more info. Thanks everybody for reviewing the Pull requests, testing the changes, and reporting issues.
### Delayed Release
@@ -100,7 +100,7 @@ Since 0.28 [automation rules](/blog/2016/09/10/notify-group-reload-api-pihole/#r
- Fix handling SIGTERM and SIGHUP signals (fixes Systemd restart issues) ([@pvizeli])
-### Breaking changes
+### Backward-incompatible changes
- The template methods `now` and `utcnow` have been changed from variables to methods. To get the current time replace `now` with `now()`.
- `yahooweather` default name is now `yweather`. Also min and max temperature are now correctly called `Temperature Min` and `Temperature Max`.
diff --git a/source/_posts/2016-10-08-hassbian-rest-digital-ocean.markdown b/source/_posts/2016-10-08-hassbian-rest-digital-ocean.markdown
index 877dd431139..7efa10f7fb9 100644
--- a/source/_posts/2016-10-08-hassbian-rest-digital-ocean.markdown
+++ b/source/_posts/2016-10-08-hassbian-rest-digital-ocean.markdown
@@ -40,7 +40,7 @@ As the results are processed on-the-fly you still need to use the data from your
### REST! We don't...
-There was a lot of work done on our implementation which are working with RESTful APIs. [@w1ll1am23] extended the [aREST] platforms to display if an aREST unit is available or not. The aREST implementations are now covered by the configuration check as well. Please check the Breaking changes section for more details.
+There was a lot of work done on our implementation which are working with RESTful APIs. [@w1ll1am23] extended the [aREST] platforms to display if an aREST unit is available or not. The aREST implementations are now covered by the configuration check as well. Please check the Backward-incompatible changes section for more details.
The [REST sensor][rest-sensor] supports now HTTP authentication (basic and digest) and custom headers. This will allow you to access resources which are protected. This sample sensor will access GitHub and retrieve the latest release number while by-passing the rate limit for non-authenticated requests.
@@ -117,7 +117,7 @@ sensor
- Fix for Slack targets ([@fabaff])
- Fix for Pushover targets ([@Nixon506E])
-### Breaking changes
+### Backward-incompatible changes
- All deprecated condition options from `automation` have been removed (deprecated since May and have printed warnings to your console):
- `use_trigger_values` is gone. You have to copy your triggers to conditions and adjust for the correct config.
diff --git a/source/_posts/2016-10-22-flash-briefing-updater-hacktoberfest.markdown b/source/_posts/2016-10-22-flash-briefing-updater-hacktoberfest.markdown
index ebd3f2d1b18..222038bf868 100644
--- a/source/_posts/2016-10-22-flash-briefing-updater-hacktoberfest.markdown
+++ b/source/_posts/2016-10-22-flash-briefing-updater-hacktoberfest.markdown
@@ -200,7 +200,7 @@ This is super annoying, I know, especially since we had said in [0.12][zero-one-
- Fix a spelling problem on user-facing error ([@robbiet480])
- YAML includes will ignore dirs/files prefixed with . ([@lwis])
-## Breaking changes
+## Backward-incompatible changes
- The [HTTP] component now takes a different format for authenticating IPs
- Configuration format has changed for [Proximity]
diff --git a/source/_posts/2016-11-05-hacktoberfest-influxdb-weather.markdown b/source/_posts/2016-11-05-hacktoberfest-influxdb-weather.markdown
index 22ee28145b1..ba3027379bd 100644
--- a/source/_posts/2016-11-05-hacktoberfest-influxdb-weather.markdown
+++ b/source/_posts/2016-11-05-hacktoberfest-influxdb-weather.markdown
@@ -108,7 +108,7 @@ Our website has now an additional category called "Ecosystem". This will become
- [iOS](/ecosystem/ios/)
- SceneGen
-### Breaking changes
+### Backward-incompatible changes
- The Yahoo Finance platform supports now multiple stock. Please adjust your configuration.
- Deprecated components `garage_door`, `rollershutter`, `thermostat`, and `hvac` have been removed.
diff --git a/source/_posts/2016-11-20-calendar--wink-thermostats--cisco-ios.markdown b/source/_posts/2016-11-20-calendar--wink-thermostats--cisco-ios.markdown
index f91a8ac7438..a8afe6a8226 100644
--- a/source/_posts/2016-11-20-calendar--wink-thermostats--cisco-ios.markdown
+++ b/source/_posts/2016-11-20-calendar--wink-thermostats--cisco-ios.markdown
@@ -64,7 +64,7 @@ But a new release wouldn't be awesome if it didn't had some new goodies and this
This should fix occasional performance problems that some people have reported.
-### Breaking changes
+### Backward-incompatible changes
- We have included a fix that impacts how we generate entity ids. This only impacts devices with accented characters. Instead of being stripped out, they are now replaced with the non-accented version. So now `Tèst Mörê` will become `test_more` instead of `tst_mr`.
- Command line switches will now use the specified object ID for their entity ID instead of basing it off the name.
diff --git a/source/_posts/2016-12-03-remote-websockets-sonarr.markdown b/source/_posts/2016-12-03-remote-websockets-sonarr.markdown
index 6fbf5663fec..1eb4a4269d2 100644
--- a/source/_posts/2016-12-03-remote-websockets-sonarr.markdown
+++ b/source/_posts/2016-12-03-remote-websockets-sonarr.markdown
@@ -127,7 +127,7 @@ We are working on a better solution for 0.35.
- Fix Nest cameras without activity zones ([@technicalpickles])
- Fix Plex doing I/O inside event loop ([@balloob])
-### Breaking changes
+### Backward-incompatible changes
- The [HomeMatic][homematic] component now uses a different syntax for hosts and the `set_value` service has been renamed.
- All [RFXtrx][rfxtrx] sensors will get a new entity ID.
diff --git a/source/_posts/2017-01-14-iss-usps-images-packages.markdown b/source/_posts/2017-01-14-iss-usps-images-packages.markdown
index 334acc223bf..f05bf240cd0 100644
--- a/source/_posts/2017-01-14-iss-usps-images-packages.markdown
+++ b/source/_posts/2017-01-14-iss-usps-images-packages.markdown
@@ -85,7 +85,7 @@ The new [image processing component][image] currently works with [number plates]
- Fix Bluetooth and Volvo trackers ([@pvizeli])
- Fix lannouncer notify platform ([@mKeRix])
-### Breaking changes
+### Backward-incompatible changes
- [APNS][apns] service was moved to the `notify` domain. Use `notify.apns_NOTIFIER_NAME` instead of `apns.NOTIFIER_NAME`.
- [InfluxDB][influx] component has a new [schema](/integrations/influxdb/#data-migration) to store values in the InfluxDB database. You may require to run the [`influxdb_migrator`](/integrations/influxdb/#migration-script) script.
diff --git a/source/_posts/2017-01-28-face-coffee-wink.markdown b/source/_posts/2017-01-28-face-coffee-wink.markdown
index 82f48cf4ccd..51e37497ad2 100644
--- a/source/_posts/2017-01-28-face-coffee-wink.markdown
+++ b/source/_posts/2017-01-28-face-coffee-wink.markdown
@@ -12,7 +12,7 @@ og_image: /images/blog/2017-01-0.37/social.png
---
-No stats, no numbers, and alike this time. Ok, just one number: 0.37. We are back on track with our bi-weekly release cycle. Beside some organizational changes is this release shipping again cool features and new integrations. Please keep an eye on the "Breaking changes" section because there are also massive improvements for some platforms and components.
+No stats, no numbers, and alike this time. Ok, just one number: 0.37. We are back on track with our bi-weekly release cycle. Beside some organizational changes is this release shipping again cool features and new integrations. Please keep an eye on the "Backward-incompatible changes" section because there are also massive improvements for some platforms and components.
### Governance
As announced, the new [Governance][gov] requires for developers to sign the CLA. [Code of Conduct][coc], [Contributor License Agreement][cla], and proper [Licensing][license] will to protect all involved parties in the Home Assistant eco-system from users and community members to contributors.
@@ -144,7 +144,7 @@ Bugfix: [@balloob], [@fabaff], [@freol35241], [@pvizeli], [@Danielhiversen], [@t
- Prevent infinite loop in crossconfigured mqtt event streams ([@aequitas])
- Fix Hue lightgroups failing on startup (@tboyce1)
-### Breaking changes
+### Backward-incompatible changes
- A **major** breaking change in the [`emulated_hue`][emul-hue] component means that unless you set `type: alexa` before starting up the newer Home Assistant version you will lose all devices that Alexa has discovered and will need to re-add them as well as create new groups.
- The platform of the [ISS][iss] integration was change to `binary_sensor`. Please check the platform documentation.
- The [Roku][roku] media uses now a new format for the entity IDs.
diff --git a/source/_posts/2017-02-11-alert-appletv-mqtt-yeelight.markdown b/source/_posts/2017-02-11-alert-appletv-mqtt-yeelight.markdown
index c16f604155f..80515377bea 100644
--- a/source/_posts/2017-02-11-alert-appletv-mqtt-yeelight.markdown
+++ b/source/_posts/2017-02-11-alert-appletv-mqtt-yeelight.markdown
@@ -131,7 +131,7 @@ Bugfixes: [@balloob], [@fabaff], [@pvizeli], [@mnoorenberghe] [@Danielhiversen],
- Hidden devices are no longer visible on views ([@balloob])
-### Breaking changes
+### Backward-incompatible changes
- The support for [LG webOS Smart TVs][webostv] was improved. This requires you to move `$HOME/.pylgtv` to `$HASS_CONFIG_DIR/webostv.conf` or Home Assistant will need to be paired with the TV again.
- Image processing events have been renamed: `identify_face` has become `image_processing.detect_face`, `found_plate` has become `image_processing.found_plate`
- The [FFmpeg binary sensor][ffmpeg-bin] change the platform name from `ffmpeg` to `ffmpeg_noise` and `ffmpeg_motion`. Also all FFmpeg-related services are moved from a platform implementation to a the [FFmpeg components][ffmpeg] and were rename from `binary_sensor.ffmpeg_xy` to `ffmpeg.xy`.
diff --git a/source/_posts/2017-02-25-config-panel-and-state-restoration.markdown b/source/_posts/2017-02-25-config-panel-and-state-restoration.markdown
index de06529836d..24dfbdad6e0 100644
--- a/source/_posts/2017-02-25-config-panel-and-state-restoration.markdown
+++ b/source/_posts/2017-02-25-config-panel-and-state-restoration.markdown
@@ -61,13 +61,13 @@ Thanks to [Fabian][@fabaff] we have a great re-organized documentation. Is it pe
Ever have some input components or integrations and get annoyed with the fact that their state is lost after a restart? Don't worry any longer. [Johann][@kellerza] has added the foundation for state restoration to Home Assistant. For the initial release support has been added to `input_select` and `input_boolean` components. We will be adding this to more integrations in the future.
-## Breaking changes to customize and Z-Wave "customize"
+## Backward-incompatible changes to customize and Z-Wave "customize"
A couple of releases ago we introduced a new way of doing `customize`. It became a list that allowed different ways of matching the config to the entity.
We realized that this was leading into a rabbit hole that we had to get out off. Besides making it unnecessarily complicated it also blocked the road to config panels. And who doesn't like config panels?
-So starting this release, we had to make some breaking changes to right the wrong. We will be releasing an online tool to help you convert your config to the new format later today.
+So starting this release, we had to make some backward-incompatible changes to right the wrong. We will be releasing an online tool to help you convert your config to the new format later today.
[**Update: the online tool can be found here.**](https://jsfiddle.net/balloob/d2e56q6f/74/)
@@ -207,7 +207,7 @@ And a final shout out to [Pascal][@pvizeli]. He keeps improving the performance
- Prevent discovered services and devices to be handled twice (@colinodell)
-#### Breaking changes
+#### Backward-incompatible changes
- VolvoOnCall has been extended with more features and had to be converted to a component
- Limitlessled support for Bridge v6 and RGBWW bulbs require users to specify `version` and `port
diff --git a/source/_posts/2017-03-11-repurpose-any-android-phone-as-ip-camera.markdown b/source/_posts/2017-03-11-repurpose-any-android-phone-as-ip-camera.markdown
index 775cb18dd4a..1edcaf9bc96 100644
--- a/source/_posts/2017-03-11-repurpose-any-android-phone-as-ip-camera.markdown
+++ b/source/_posts/2017-03-11-repurpose-any-android-phone-as-ip-camera.markdown
@@ -50,7 +50,7 @@ Screenshot of all the different functionality the IP webcam integration offers.
- Blink Home Security Camera support added ([@fronzbot])
- AppleTV has been converted to push data to Home Assistant instead of us having to poll ([@postlund])
-## Breaking changes
+## Backward-incompatible changes
- Vera entity ids have changed. This is a one time change to migrate to a model that will prevent future conflicts.
- The Twilio notify platforms now have to be configured via the twilio component.
diff --git a/source/_posts/2017-03-25-todo-volumio-workday.markdown b/source/_posts/2017-03-25-todo-volumio-workday.markdown
index 0db2868983d..dbdfb25429b 100644
--- a/source/_posts/2017-03-25-todo-volumio-workday.markdown
+++ b/source/_posts/2017-03-25-todo-volumio-workday.markdown
@@ -28,7 +28,7 @@ The new format of the changelog which was introduced with 0.40 will provide a li
- [Volumio][volumio] media player added ([@jslove])
- [Workday][workday] sensor ([@BastianPoe])
-## Breaking changes
+## Backward-incompatible changes
- The [Kodi notifier][kodi] platform was migrated to async and the configuration synced with the Kodi media player platform ([#6497]).
- For the [Music Player Daemon][mpd] (MPD) platform was `location` replaced with `name` ([#6553]).
diff --git a/source/_posts/2017-04-08-eddystone-beacons--lockitron-locks--total-connect.markdown b/source/_posts/2017-04-08-eddystone-beacons--lockitron-locks--total-connect.markdown
index 5d4cacfbbd2..4605bbf2248 100644
--- a/source/_posts/2017-04-08-eddystone-beacons--lockitron-locks--total-connect.markdown
+++ b/source/_posts/2017-04-08-eddystone-beacons--lockitron-locks--total-connect.markdown
@@ -34,7 +34,7 @@ Also want to take a moment to thank Austin Andrews aka [Templarian] for his [Mat
- The Ring doorbell has been integrated further with the inclusion of binary sensors ([@tchellomello] - [#6520])
-## Breaking changes
+## Backward-incompatible changes
- We were incorrectly treating groups named `default_view` as default views. Make sure you set `view: true` in the config for these groups. [#251 (frontend)](https://github.com/home-assistant/home-assistant-polymer/pull/251)
- The last release introduced a revamped LIFX platform. We only realized after deploy that this version does not work on Windows. We have added the old LIFX implementation back as `lifx_legacy`.
diff --git a/source/_posts/2017-04-22-ikea-tradfri--spotify.markdown b/source/_posts/2017-04-22-ikea-tradfri--spotify.markdown
index b138a700429..bbe0367fe74 100644
--- a/source/_posts/2017-04-22-ikea-tradfri--spotify.markdown
+++ b/source/_posts/2017-04-22-ikea-tradfri--spotify.markdown
@@ -49,7 +49,7 @@ Also note that you have till the end of the weekend to [submit an application][a
- myStrom Wifi Bulbs ([@fabaff] - [#7161]) ([light.mystrom docs]) (new-platform)
-## Breaking changes
+## Backward-incompatible changes
- Remove deprecated classes from `homeassistant.remote` ([@balloob] - [#7011])
- min_max sensor has a different default name and will ignore states that are unknown ([@micw] - [#6786])
diff --git a/source/_posts/2017-05-06-zigbee-opencv-dlib.markdown b/source/_posts/2017-05-06-zigbee-opencv-dlib.markdown
index 1a993fe3ab8..f4494996a64 100644
--- a/source/_posts/2017-05-06-zigbee-opencv-dlib.markdown
+++ b/source/_posts/2017-05-06-zigbee-opencv-dlib.markdown
@@ -60,7 +60,7 @@ Experiencing issues introduced by this release? Please report them in our [issue
- MQTT Cover: Fixed status reporting for range with non-zero base ([@cribbstechnologies])
-## Breaking changes
+## Backward-incompatible changes
- Python Open Z-Wave made a release that fixed string processing. This was backwards incompatible. We have updated our code so you'll have to update to the latest Python Open Z-Wave with this release. You can also wait one release, as next release we'll introduce automatic installing of Python Open Z-Wave. ([@keatontaylor] - [#7266]) ([climate.zwave docs]) (breaking change)
- InfluxDB configuration to blacklist domains has been updated to allow more features. ([@janLo] - [#7264]) (breaking change)
diff --git a/source/_posts/2017-05-20-automation-editor-zwave-panel-ocr.markdown b/source/_posts/2017-05-20-automation-editor-zwave-panel-ocr.markdown
index b4ff294ea2c..1a6d7b85b81 100644
--- a/source/_posts/2017-05-20-automation-editor-zwave-panel-ocr.markdown
+++ b/source/_posts/2017-05-20-automation-editor-zwave-panel-ocr.markdown
@@ -85,7 +85,7 @@ If you are using our [experimental Hass.io image][hass.io], we made a breaking c
## Reporting Issues
Experiencing issues introduced by this release? Please report them in our [issue tracker][issue]. Make sure to fill in all fields of the issue template.
-## Breaking changes
+## Backward-incompatible changes
- PyPI Openzwave ([@JshWright] - [#7415]) ([zwave docs]) (breaking change)
- Remove listening to `homeassistant_start` with event automation ([@balloob] - [#7474]) ([automation.event docs]) (breaking change)
diff --git a/source/_posts/2017-06-04-release-46.markdown b/source/_posts/2017-06-04-release-46.markdown
index d85a067dde1..88c2ec3ace3 100644
--- a/source/_posts/2017-06-04-release-46.markdown
+++ b/source/_posts/2017-06-04-release-46.markdown
@@ -32,7 +32,7 @@ It's time for 0.46! This release does not have too many new integrations, instea
- Sensor - MetOffice: Fix last updated date ([@cyberjacob] - [#7965]) ([metoffice docs])
- Prevent Roku doing I/O in event loop ([@balloob] - [#7969]) ([media_player.roku docs])
-## Breaking changes
+## Backward-incompatible changes
- The USPS sensor entity names have changed as there are now two. One for packages and one for mail. Config will now also use `scan_interval` instead of `update_interval` ([@happyleavesaoc] - [#7655]) (breaking change)
- Automation state trigger: From/to checks will now ignore state changes that are just attribute changess ([@amelchio] - [#7651]) ([automation.state docs]) (breaking change)
diff --git a/source/_posts/2017-06-15-zwave-entity-ids.markdown b/source/_posts/2017-06-15-zwave-entity-ids.markdown
index 740a82a1083..94765c1344f 100644
--- a/source/_posts/2017-06-15-zwave-entity-ids.markdown
+++ b/source/_posts/2017-06-15-zwave-entity-ids.markdown
@@ -15,6 +15,6 @@ Now that users are able to control these names, we will be making changes to how
With the release of 0.47, this feature will be opt-in. Setting `new_entity_ids: true` under `zwave:` in your configuration.yaml will enable the new generation. After 0.48 this feature will become opt-out. From 0.48 onward, unless you’ve declared `new_entity_ids: false` you will switch to the new entity_id generation. At an undecided point in the future, the old entity_id generation will be removed completely.
-I’m sure all ZWave users understand that the current entity_ids aren’t easy to use. They’re annoying to type in configuration.yaml, and break if a node needs to be re-included to the network. We know that breaking changes are painful, and so we’re doing what we can to roll this change out as smoothly as possible. The end result should be a dramatic simplification of most ZWave configurations. We hope that this change will ultimately make ZWave much easier to work with, and bring ZWave configuration just a little closer to the rest of the Home Assistant platforms.
+I’m sure all ZWave users understand that the current entity_ids aren’t easy to use. They’re annoying to type in configuration.yaml, and break if a node needs to be re-included to the network. We know that backward-incompatible changes are painful, and so we’re doing what we can to roll this change out as smoothly as possible. The end result should be a dramatic simplification of most ZWave configurations. We hope that this change will ultimately make ZWave much easier to work with, and bring ZWave configuration just a little closer to the rest of the Home Assistant platforms.
[@turbokongen]: https://github.com/turbokongen
diff --git a/source/_posts/2017-06-17-release-47.markdown b/source/_posts/2017-06-17-release-47.markdown
index 739b2ae7f7e..fd878d17000 100644
--- a/source/_posts/2017-06-17-release-47.markdown
+++ b/source/_posts/2017-06-17-release-47.markdown
@@ -91,7 +91,7 @@ To run without the monkey patch, start Home Assistant with `HASS_NO_MONKEY=1 has
Experiencing issues introduced by this release? Please report them in our [issue tracker][issue]. Make sure to fill in all fields of the issue template.
-## Breaking changes
+## Backward-incompatible changes
- Update opencv config to match other image processors ([@Teagan42] - [#7864]) ([image_processing.opencv docs]) (breaking change)
diff --git a/source/_posts/2017-07-02-release-48.markdown b/source/_posts/2017-07-02-release-48.markdown
index 44269d43f68..f7172896c64 100644
--- a/source/_posts/2017-07-02-release-48.markdown
+++ b/source/_posts/2017-07-02-release-48.markdown
@@ -75,7 +75,7 @@ Experiencing issues introduced by this release? Please report them in our [issue
-## Breaking Changes
+## Backward-incompatible changes
- We have added a new option to whitelist folders that can be used as sources for sending files. You will need to use this option if you are using files with the telegram component. ([@pvizeli] - [#8189]) (breaking change)
diff --git a/source/_posts/2017-07-16-release-49.markdown b/source/_posts/2017-07-16-release-49.markdown
index b8d8ae6c28c..9e8977ff526 100644
--- a/source/_posts/2017-07-16-release-49.markdown
+++ b/source/_posts/2017-07-16-release-49.markdown
@@ -83,7 +83,7 @@ This feature has also been brought to you by [@Andrey-git]! Big shout out to him
Experiencing issues introduced by this release? Please report them in our [issue tracker][issue]. Make sure to fill in all fields of the issue template.
-## Breaking Changes
+## Backward-incompatible changes
- UPC Connect component no longer needs a password passed into the configuration. ([@Flavien] - [#8335]) ([device_tracker.upc_connect docs]) (breaking change)
- The Apple TV platform has been upgraded to a component and a remote platform has been added. This requires your Apple TV configuration to be moved to the new `apple_tv` component. ([@postlund] - [#8122]) ([media_player.apple_tv docs]) (breaking change)
diff --git a/source/_posts/2017-07-29-release-50.markdown b/source/_posts/2017-07-29-release-50.markdown
index 9a9c8125d26..76fa9788b91 100644
--- a/source/_posts/2017-07-29-release-50.markdown
+++ b/source/_posts/2017-07-29-release-50.markdown
@@ -89,7 +89,7 @@ Straight to 0.50.2. We released 0.50 as 0.50.1 due to an upload error to PyPi.
Experiencing issues introduced by this release? Please report them in our [issue tracker][issue]. Make sure to fill in all fields of the issue template.
-## Breaking Changes
+## Backward-incompatible changes
- Automations: The state trigger keyword `state` and the time trigger keyword `after` were deprecated in 0.46. They have now been removed. Use `to` and `at` instead. ([@amelchio] - [#8510]) ([automation.state docs]) ([automation.time docs]) (breaking change)
- Wink: the component is no longer supporting the `access_token` in the config. Use the new OAuth authentication or add your username and password to the config. ([@w1ll1am23] - [#8208]) ([wink docs]) (breaking change)
diff --git a/source/_posts/2017-08-12-release-51.markdown b/source/_posts/2017-08-12-release-51.markdown
index d970b4d8232..699d239dede 100644
--- a/source/_posts/2017-08-12-release-51.markdown
+++ b/source/_posts/2017-08-12-release-51.markdown
@@ -80,7 +80,7 @@ As we have seen more vacuum cleaners land in Home Assistant, it was time to crea
Experiencing issues introduced by this release? Please report them in our [issue tracker][issue]. Make sure to fill in all fields of the issue template.
-## Breaking Changes
+## Backward-incompatible changes
- Efergy sensors: change units from KW to W ([@emlt] - [#8761]) ([sensor.efergy docs]) (breaking change)
- Xiaomi vacuum is now a platform of new `vacuum` component derived from ToggleEntity, and services ([@azogue] - [#8623]) (breaking change) (new-platform)
diff --git a/source/_posts/2017-08-26-release-0-52.markdown b/source/_posts/2017-08-26-release-0-52.markdown
index e9f434c746b..ab41a7e1058 100644
--- a/source/_posts/2017-08-26-release-0-52.markdown
+++ b/source/_posts/2017-08-26-release-0-52.markdown
@@ -66,7 +66,7 @@ script: !include scripts.yaml
Experiencing issues introduced by this release? Please report them in our [issue tracker][issue]. Make sure to fill in all fields of the issue template.
-## Breaking Changes
+## Backward-incompatible changes
- Remove spaces from Xiami switch attributes ([@syssi] - [#8952]) ([switch.xiaomi docs]) (breaking change)
- MQTT Switch: command and availability payload are now no longer linked. Command and availability payload default to ON/OFF and must be configured individually if custom values are required. ([@timstanley1985] - [#8934]) ([switch.mqtt docs]) (breaking change)
diff --git a/source/_posts/2017-09-09-release-53.markdown b/source/_posts/2017-09-09-release-53.markdown
index 1386f2fc92a..1bed70cb95d 100644
--- a/source/_posts/2017-09-09-release-53.markdown
+++ b/source/_posts/2017-09-09-release-53.markdown
@@ -87,7 +87,7 @@ Experiencing issues introduced by this release? Please report them in our [issue
-## Breaking Changes
+## Backward-incompatible changes
- The new customize editor is using the file `customize.yaml` in your config folder. If you are using this file today for other config, make sure to rename it before using the new customize UI editor. ([@andrey-git] - [#9134]) ([config docs]) (breaking change) (new-platform)
- The frontend component now supports loading custom html files when Home Assistant front end starts ([@andrey-git] - [#9150]) (breaking change). It could be Javascript, CSS or custom Web Components. Along there was a breaking change in the way Custom UI is used:
diff --git a/source/_posts/2017-09-23-release-54.markdown b/source/_posts/2017-09-23-release-54.markdown
index 350360dde36..1176fe1dbbc 100644
--- a/source/_posts/2017-09-23-release-54.markdown
+++ b/source/_posts/2017-09-23-release-54.markdown
@@ -39,7 +39,7 @@ Experiencing issues introduced by this release? Please report them in our [issue
-## Breaking Changes
+## Backward-incompatible changes
- Sensor - OneWire: This update changes the names of the sensors from `