jeans/home-assistant.io
jeans/home-assistant.io
1
0
Fork 0
mirror of https://github.com/home-assistant/home-assistant.io.git synced 2025-07-27 19:26:50 +00:00
Code Issues Packages Projects Releases Wiki Activity

Merge branch 'current' into next

Browse Source
This commit is contained in:
Franck Nijhof 2024-10-02 09:58:56 +02:00
commit 6e1c70d2f1
No known key found for this signature in database
GPG Key ID: D62583BA8AB11CA3
45 changed files with 359 additions and 149 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

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

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

2
Gemfile
View File

@ -11,7 +11,7 @@ group :development do
# > 2.1.0 causes slowdowns https://github.com/sass/sassc-ruby/issues/189
gem 'sassc', '2.1.0'
gem 'rubocop', '1.66.1'
gem 'ruby-lsp', '0.18.3'
gem 'ruby-lsp', '0.18.4'
gem 'rackup', '2.1.0'
end

14
Gemfile.lock
View File

@ -108,10 +108,10 @@ GEM
rb-fsevent (0.11.2)
rb-inotify (0.11.1)
ffi (~> 1.0)
rbs (3.5.3)
rbs (3.6.0)
logger
regexp_parser (2.9.2)
rexml (3.3.7)
rexml (3.3.8)
rouge (4.4.0)
rubocop (1.66.1)
json (~> 2.3)
@ -125,7 +125,7 @@ GEM
unicode-display_width (>= 2.4.0, < 3.0)
rubocop-ast (1.32.3)
parser (>= 3.3.1.0)
ruby-lsp (0.18.3)
ruby-lsp (0.18.4)
language_server-protocol (~> 3.17.0)
prism (~> 1.0)
rbs (>= 3, < 4)
@ -134,9 +134,9 @@ GEM
ruby2_keywords (0.0.5)
safe_yaml (1.0.5)
sass (3.4.25)
sass-embedded (1.79.3-arm64-darwin)
sass-embedded (1.79.4-arm64-darwin)
google-protobuf (~> 4.27)
sass-embedded (1.79.3-x86_64-linux-gnu)
sass-embedded (1.79.4-x86_64-linux-gnu)
google-protobuf (~> 4.27)
sass-globbing (1.1.5)
sass (>= 3.1)
@ -150,7 +150,7 @@ GEM
rack-protection (= 4.0.0)
rack-session (>= 2.0.0, < 3)
tilt (~> 2.0)
sorbet-runtime (0.5.11581)
sorbet-runtime (0.5.11589)
stringex (2.8.6)
terminal-table (3.0.2)
unicode-display_width (>= 1.1.1, < 3)
@ -177,7 +177,7 @@ DEPENDENCIES
rackup (= 2.1.0)
rake (= 13.2.1)
rubocop (= 1.66.1)
ruby-lsp (= 0.18.3)
ruby-lsp (= 0.18.4)
sass-globbing (= 1.1.5)
sassc (= 2.1.0)
sinatra (= 4.0.0)

2
README.md
View File

@ -40,3 +40,5 @@ When you're done working on the site, run the following command to move the post
```bash
bundle exec rake integrate
```
[![Home Assistant - A project from the Open Home Foundation](https://www.openhomefoundation.org/badges/home-assistant.png)](https://www.openhomefoundation.org/)

35
source/_dashboards/map.markdown
View File

@ -10,18 +10,42 @@ related:
title: Themes
- docs: /dashboards/cards/
title: Dashboard cards
- docs: /docs/configuration/basic/#editing-the-general-settings
title: Edit your home location
- docs: /getting-started/presence-detection/
title: Getting started tutorial on presence detection
---
The map card that allows you to display entities on a map. This card is used on the [Map dashboard](/dashboards/dashboards/#map-dashboard), which is one of the default dashboards.
The map card allows you to display your home zone, entities, and other predefined zones on a map. This card is used on the [Map dashboard](/dashboards/dashboards/#map-dashboard), which is one of the default dashboards.
<p class='img'>
<img src='/images/dashboards/map_card.png' alt='Screenshot of the map card'>
Screenshot of the map card.
</p>
{% include dashboard/edit_dashboard.md %}
## Adding the map card to your dashboard
All options for this card can be configured via the user interface.
1. In the top right of the screen, select the edit {% icon "mdi:edit" %} button.
- If this is your first time editing a dashboard, the **Edit dashboard** dialog appears.
- By editing the dashboard, you are taking over control of this dashboard.
- This means that it is no longer automatically updated when new dashboard elements become available.
- Once you've taken control, you can't set this dashboard to update automatically anymore. However, you can create a new default dashboard.
- To continue, in the dialog, select the three dots {% icon "mdi:dots-vertical" %} menu, then select **Take control**.
2. [Add the map card](/dashboards/cards/#adding-cards-to-your-dashboard) to your dashboard.
3. By default, you see the house {% icon "mdi:house" %} icon on your map. It represents your [home zone](/integrations/zone/#about-the-home-zone).
- To change the location of your home, you need to [edit your home's location in the general settings](/docs/configuration/basic/#editing-the-general-settings).
![Edit map card settings](/images/dashboards/map_card_config.png)
4. To learn how to show additional zones on your map, follow the steps on [adding a new zone](/integrations/zone/#adding-a-new-zone-or-editing-zones).
5. To show other elements on the map, either add them under **Entities**, or use the **Geolocation sources**.
- For a description of the options, refer to the [YAML configuration](#yaml-configuration) section. It also applies to the options shown in the UI.
- {% icon "mdi:info" %} **Info**: The list of entities shows the device trackers available for your home, such as a mobile phone with the companion app.
- If you want to see a trace of the past locations of your entities, you need to define a time frame under **Hours to show**.
- For more information about presence detection, refer to the [getting started tutorial on presence detection](/getting-started/presence-detection/).
## Configuration options
All options for this card can be configured via the user interface. For a detailed description of the options, refer to the [YAML configuration](#yaml-configuration) section. It also applies to the options shown in the UI.
## YAML configuration
@ -42,7 +66,7 @@ geo_location_sources:
type: list
auto_fit:
required: false
description: The map will follow moving `entities` by adjusting the viewport of the map each time an entity is updated.
description: The map will follow moving `entities` by adjusting the viewport of the map each time an entity is updated.
type: boolean
default: false
fit_zones:
@ -60,7 +84,7 @@ aspect_ratio:
type: string
default_zoom:
required: false
description: The default zoom level of the map.
description: The default zoom level of the map. Use a lower number to zoom out and a higher number to zoom in.
type: integer
default: 14 (or whatever zoom level is required to fit all visible markers)
theme_mode:
@ -139,4 +163,3 @@ entities:
focus: false
hours_to_show: 48
```

31
source/_dashboards/markdown.markdown
View File

@ -129,7 +129,6 @@ content: |
{% endraw %}
## ha-alert
You can also use our [\`ha-alert\`](https://design.home-assistant.io/#components/ha-alert) component in the Markdown card.
@ -150,3 +149,33 @@ content: |
<ha-alert alert-type="success">This is a success alert — check it out!</ha-alert>
<ha-alert title="Test alert">This is an alert with a title</ha-alert>
```
## ha-qr-code
You can also create QR-Codes in the Markdown card.
<p class='img'>
<img src='/images/dashboards/markdown_card_qr_code.png' alt='Screenshot of the markdown card with QR codes'>
Screenshot of the Markdown card with QR codes.
</p>
Available parameters:
- data: The actual data to encode in the QR-Code
- scale: A scale factor for the QR code, default is 4
- width: Width of the QR code in pixels
- margin: A margin around the QR code
- error-correction-level: low; medium; quartile; high
- center-image: An image to place on top of the qr code (might need a higher error-correction-level)
```yaml
type: markdown
content: >-
<ha-qr-code data='hallo' width="180"></ha-qr-code>
<ha-qr-code data='hallo' scale="6" margin="0"
center-image="/static/icons/favicon-192x192.png"></ha-qr-code>
<ha-qr-code data='hallo' error-correction-level="quartile" scale="6"
center-image="https://brands.home-assistant.io/_/tuya/icon@2x.png"></ha-qr-code>
```

28
source/_dashboards/sidebar.markdown
View File

@ -8,6 +8,10 @@ related:
title: Masonry view
- docs: /dashboards/panel/
title: Panel view
- docs: /dashboards/sections/
title: Sections view (experimental)
- docs: /dashboards/views/
title: About views
---
The sidebar view has 2 columns, a wide one and a smaller one on the right.
@ -17,18 +21,24 @@ The sidebar view has 2 columns, a wide one and a smaller one on the right.
Screenshot of the sidebar view used for the energy dashboard.
</p>
This view doesn't have support for badges.
You can set if a card should be placed in the main (left) column of the sidebar column (right), by selecting the arrow right or left arrow in the bar underneath the card.
To move the card from the main column into the sidebar (right) (and vice versa), select the arrow {% icon "mdi:arrow-left-bold" %} {% icon "mdi:arrow-right-bold" %} button on the card.
<p class='img'>
<img src='/images/dashboards/sidebar_view_move_card.png' alt='Screenshot showing how to move a card between sidebar and main view'>
Screenshot showing how to move a card between sidebar and main view.
<img src='/images/dashboards/sidebar_view_move_card.png' alt='Screenshot showing how to move a card'>
Screenshot showing the arrow buttons to move a card.
</p>
On mobile, all cards are rendered in 1 column and kept in the order of the cards in the config.
On mobile, all cards are rendered in 1 column and kept in the order indicated in the YAML configuration.
## View config:
1. To view the YAML configuration, on the view tab, select the {% icon "mdi:pencil" %} icon to open the edit view.
2. In the configuration dialog, select the three dots {% icon "mdi:dots-vertical" %} menu, and **Edit in YAML**.
<p class='img'>
<img src='/images/dashboards/view_edit_config.png' alt='Screenshot showing where to edit the view configuration'>
Screenshot showing where to edit the view configuration.
</p>
## View configuration
{% configuration %}
type:
@ -37,7 +47,7 @@ type:
type: string
{% endconfiguration %}
## Cards config:
## Cards configuration
{% configuration %}
view_layout.position:
@ -58,4 +68,4 @@ cards:
- media_player.lounge_room
view_layout:
position: sidebar
```
```

2
source/_data/glossary.yml
View File

@ -584,7 +584,7 @@
link: /docs/scripts/#variables
- term: Zone
definition: >-
Zones are areas that can be used for presence detection.
Zones allow you to specify certain regions on a map. They enable zone presence-detection and can be used in automations. For example, to start the vacuum after you left home or start the heating at home when you leave the office.
link: /integrations/zone/
aliases:
- zones

15
source/_docs/configuration/entities_domains.markdown
View File

@ -3,26 +3,15 @@ title: "Entities and domains"
description: "Describes what entities and domains are in Home Assistant."
related:
- docs: /docs/configuration/state_object/
title: State object, entity state
title: State object, entity state and attributes
---
Your {% term devices %} are represented in Home Assistant as entities. Entities are the basic building blocks to hold data in Home Assistant. An entity represents a {% term 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 {% term device %} or a {% term service %}. Entities have [states](/docs/configuration/state_object/) and [attributes](#entity-attributes).
Your devices are represented in Home Assistant as entities. Entities are the basic building blocks to hold data in Home Assistant. An entity represents a {% term 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 {% term device %} or a {% term service %}. Entities have [states](/docs/configuration/state_object/) and [state attributes](/docs/configuration/state_object/#about-entity-state-attributes).
All your entities are listed in the entities table, under {% my entities title="**Settings** > **Devices & services** > **Entities**" %}.
<p class='img'><img src='/images/getting-started/entities.png' style='border: 0;box-shadow: none;' alt="Screenshot showing the Entities table">Screenshot of the Entities table. Each line represents an entity.</p>
## Entity attributes
Many entities have attributes. There are a few attributes that are available on all entities, such as `friendly_name` and `icon`. In addition to those, each integration has 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 list of available attributes depends on the {% term device %}.
<p class='img'>
<img src='/images/integrations/light/state_light.png' alt='Screenshot showing three lights with different states and attributes'>
Example showing three lights with differents states and different attributes.
</p>
For more information on entity attributes, refer to the [attributes](/docs/configuration/state_object/#attributes) section on the state objects page.
## Domains
Each integration in Home Assistant has a unique identifier: a domain. All entities and actions available in Home Assistant are provided by integrations and thus belong to such a domain. The first part of the entity or action, before the `.` shows the domain they belong to. For example, `light.bed_light` is an entity in the light domain. `bed_light` is the ID of the entity.

98
source/_docs/configuration/state_object.markdown
View File

@ -1,52 +1,86 @@
---
title: "State objects"
description: "Describes all there is to know about state objects in Home Assistant."
title: "State and state object"
description: "Describes all there is to know about state and the state object in Home Assistant."
related:
- docs: /docs/configuration/entities_domains/
title: Entities and domains
---
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 %}.
Devices are represented in Home Assistant as {% term entities %}. The state of an entity (for example, if a light is on, at 50% brightness in orange) can be shown on the dashboard or be used in automations. This page looks at the concepts _state_, _state object_, and _entity state attribute_.
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.
## State versus state object
All states will always have an entity id, a state and a timestamp when last updated and last changed.
In Home Assistant, the state object is the current representation of the {% term entity %} with all its attributes at a given moment in time. This state is recorded as a _state object_. Entities constantly keep track of their state and write it into a state object, so that other entities/templates/frontend can access it. In the example&mdash;the light is on, at 50% brightness in orange&mdash;_on_ is the actual state of the light. 50% brightness and the color are entity state attributes.
| Field | Description |
| -------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| `state.state` | String representation of the current state of the entity. Example `off`. |
| `state.entity_id` | Entity ID. Format: `<domain>.<object_id>`. Example: `light.kitchen`. |
| `state.domain` | Domain of the entity. Example: `light`. |
| `state.object_id` | Object ID of entity. Example: `kitchen`. |
| `state.name` | Name of the entity. Based on `friendly_name` attribute with fall back to object ID. Example: `Kitchen Ceiling`. |
| `state.last_changed` | Time the state changed in the state machine in UTC time. This is not updated if only state attributes change. Example: `2017-10-28 08:13:36.715874+00:00`. |
| `state.last_reported`| Time the state was written to the state machine in UTC time. This timestamp is updated regardless of any change to the state or a state attribute. Example: `2017-10-28 08:13:36.715874+00:00`. |
| `state.last_updated` | Time the state or state attributes changed in the state machine in UTC time. This is not updated if neither state nor state attributes changed. Example: `2017-10-28 08:13:36.715874+00:00`. |
| `state.attributes` | A dictionary with extra attributes related to the current state. |
| `state.context` | A dictionary with extra attributes related to the context of the state. |
### About the state object
## Attributes
The state object represents the state of an entity with its attributes at a specific point in time. All state objects will always have an entity id, a state, and timestamps when last updated, last changed, and last reported.
The `state` prefix indicates that this information is part of the state object (which is related to the entity). For example, `state.state` is the state of the entity at a given time.
The attributes of an {% term entity %} are optional.There are a few attributes that are available on all entities, such as `friendly_name` and `icon`. In addition to those, each integration has 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.
| Field | Description |
| --------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `state.state` | String representation of the current state of the entity. Example `off`. |
| `state.entity_id` | Entity ID. Format: `<domain>.<object_id>`. Example: `light.kitchen`. |
| `state.domain` | Domain of the entity. Example: `light`. |
| `state.object_id` | Object ID of entity. Example: `kitchen`. |
| `state.name` | Name of the entity. Based on `friendly_name` attribute with fall back to object ID. Example: `Kitchen ceiling`. |
| `state.last_changed` | Time the state changed in the state machine in UTC time. This is not updated if only state attributes change. Example: `2013-09-17 07:32:51.715874+00:00`. |
| `state.last_reported` | Time the state was written to the state machine in UTC time. This timestamp is updated regardless of any changes to the state or state attributes. Example: `2013-09-17 07:32:51.715874+00:00`. |
| `state.last_updated` | Time the state or state attributes changed in the state machine in UTC time. This is not updated if neither state nor state attributes changed. Example: `2013-09-17 07:32:51.715874+00:00`. |
| `state.attributes` | A dictionary with extra attributes related to the current state. |
| `state.context` | A dictionary with extra attributes related to the context of the state. |
### About the state
The screenshot shows three lights in different states (the `state.state`): `on`, `off`, and `unavailable`. Each light comes with its own entity state attributes such as `supported_color_modes`, `supported_features`. These attributes have their own state: the state of `supported_color_modes` is `color_temp` and `hs`, the state of the `supported_features` attribute is `4`.
<p class='img'>
<img src='/images/integrations/light/state_light.png' alt='Screenshot showing three lights with different states: `on`, `off`, or `unavailable`'>
Three lights with different states: `on`, `off`, or `unavailable`.
</p>
The `state.state` is the heart of the [state object](#about-the-state-object). 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 state object stores 3
timestamps related to the state: `last_updated`, `last_changed`, and `last_reported`. Each
entity has exactly one state, and the state only holds one value at a time.
### About entity state attributes
The state only holds one value at a time. However, entities can store related entity state attributes in the state object. For example,
the state of a light is _on_, and the related attributes could be its
current brightness and color values. [State change events](/docs/configuration/events/#events-and-state-changes) can be used as triggers.
The current state can be used in [conditions](/docs/automation/condition/). The example below shows three lights with different entity state attributes.
<p class='img'>
<img src='/images/integrations/light/state_light.png' alt='Screenshot showing three lights with different states and attributes'>
Example showing three lights with different entity state attributes.
</p>
Entities have some attributes that are not related to its state, such as `friendly_name`. A few attributes are available on all entities, such as `friendly_name` or `icon`. In addition to those, each integration has 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. Entity attributes are optional.
When using templates, attributes will be available by their name. For example `state.attributes.assumed_state`.
| Attribute | Description |
| --------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- |
| `friendly_name` | Name of the entity. Example: `Kitchen Ceiling`. |
| `icon` | Icon to use for the entity in the frontend. Example: `mdi:home`. |
| `entity_picture` | URL to a picture that should be used instead of showing the domain icon. Example: `http://example.com/picture.jpg`. |
| `assumed_state` | Boolean if the current state is an assumption. [More info](/blog/2016/02/12/classifying-the-internet-of-things/#classifiers) Example: `True`. |
| `unit_of_measurement` | The unit of measurement the state is expressed in. Used for grouping graphs or understanding the entity. Example: `°C`. |
The table lists common state attributes that may be present, depending on the entity domain.
| Attribute | Description |
| --------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| `friendly_name` | Name of the entity. Example: `Kitchen Ceiling`. |
| `icon` | Icon to use for the entity in the frontend. Example: `mdi:home`. |
| `entity_picture` | URL to a picture that should be used instead of showing the domain icon. Example: `http://example.com/picture.jpg`. |
| `assumed_state` | Boolean if the current state is an assumption. [More info](/blog/2016/02/12/classifying-the-internet-of-things/#classifiers) Example: `True`. |
| `unit_of_measurement` | The unit of measurement the state is expressed in. Used for grouping graphs or understanding the entity. Example: `°C`. |
| `attribution` | The provider of the data. For example, "Data provided by rejseplanen.dk", "Data provided by openSenseMap" |
| `device_class` | The type of device that an entity represents. Used to display device specific information in the UI. |
| `supported_features` | The features an entity supports. For covers, for example, it might list `opening`, `closing`, `stopping`, `setting position`. For media players, it might list `play`, `pause`, `stop`, and `volume control` |
When an attribute contains spaces, you can retrieve it like this: `state_attr('sensor.livingroom', 'Battery numeric')`.
## Context
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.
Context is a property used in state objects and events. It ties {% term events %} and {% term states %} together in Home Assistant. Whenever an {% term automation %} or user interaction causes a state to change, a new context is assigned in the state object. This context will be attached to all events and states that happen as a result of the change.
| Field | Description |
| ------------ | ------------------------------------------------------------------- |
| `context_id` | Unique identifier for the context. |
| `user_id` | Unique identifier of the user that started the change. Will be `None` if the action was not started by a user (for example, started by an automation). |
| `parent_id` | Unique identifier of the parent context that started the change, if available. For example, if an automation is triggered, the context of the trigger will be set as parent. |
| Field | Description |
| ------------ | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `context_id` | Unique identifier for the context. |
| `user_id` | Unique identifier of the user that started the change. Will be `None` if the action was not started by a user (for example, started by an automation). |
| `parent_id` | Unique identifier of the parent context that started the change, if available. For example, if an automation is triggered, the context of the trigger will be set as parent. |

67
source/_docs/locked_out.md
View File

@ -15,19 +15,42 @@ or need to recover your data.
## Forgot username
If you’ve forgotten your username, ask the owner to help you.
If you are using the {% term "Home Assistant Operating System" %} and have access to the Home Assistant server, you can connect a terminal and enter the `auth list` command. This command lists all users that are registered on your Home Assistant.
### Symptom: I'm the owner and I forgot my username
You are the **owner** of the Home Assistant server and you cannot login because you forgot your username.
#### Remedy
1. Check if the following conditions are met:
- you are using the {% term "Home Assistant Operating System" %}
- you have access to the Home Assistant server.
2. Open a terminal connection to Home Assistant:
- If you are using a Home Assistant Green, follow these steps [to access the console](https://green.home-assistant.io/guides/use-terminal/).
- If you are using a Home Assistant Yellow, follow these steps:
- [to access the console from Windows](https://yellow.home-assistant.io/guides/use-serial-console-windows/)
- [to access the console from Linux or macOS](https://yellow.home-assistant.io/guides/use-serial-console-linux-macos/).
- If you are using another system, connect keyboard and monitor. The procedure might be similar the one used for Green.
- If you are using a Home Assistant OVA (virtualization image):
- Access the system console by opening the terminal through your virtualization platform's interface (for example, Proxmox, VMware, VirtualBox).
- Follow the platform-specific steps to interact with the virtual machine's console.
3. In the terminal, enter the `auth list` command.
- This command lists all users that are registered on your Home Assistant.
## Forgot password
If you are not the owner or do not have administrator rights, ask the owner to give you a new password.
### Symptom: I'm the owner and I forgot my password
- In the navigation pane on the left, check if you see the **Settings** menu listed above the **Notifications**.
- If you don't, you do not have administrator rights.
You are the owner or administrator of Home Assistant and forgot your password.
If you are the owner or have administrator, there are different methods to reset a password, depending on your setup:
### Remedy: resetting an owner's password
### To reset a password while still logged in (including Supervised)
If you are the owner or have administrator, there are different methods to reset a password, depending on your situation:
- [Reset a password while still logged in](#to-reset-a-password-while-still-logged-in-including-supervised)
- [Reset an owner's password when logged out](#to-reset-an-owners-password-via-console)
- [reset a user's password, via the container command line](#to-reset-a-users-password-via-the-container-command-line)
#### To reset a password while still logged in (including Supervised)
The method used to reset a password depends on your user rights:
@ -40,12 +63,12 @@ The method used to reset a password depends on your user rights:
2. Reset your password via this new administrator account (and then [delete this new account](/docs/locked_out/#to-delete-a-user)).
- Your configuration will remain, and you don't have to do a new onboarding process.
### To reset an owner's password, via console
#### To reset an owner's password, via console
Use this procedure only if the following conditions are met:
- You know the username.
- You can access the [Home Assistant console](/hassio/commandline/) **on the device itself** (not via the SSH terminal from the add-ons).
- You can access the Home Assistant console **on the device itself** (not via the SSH terminal from the add-ons).
1. If you are using a Home Assistant Yellow or Green, refer to their documentation.
- If you are using a Home Assistant Yellow, refer to the following procedure:
@ -63,7 +86,7 @@ Use this procedure only if the following conditions are met:
- **Troubleshooting**: If you see the message `zsh: command not found: auth`, you likely did not enter the command in the serial console connected to the device itself, but in the terminal within Home Assistant.
4. You can now log in to Home Assistant using this new password.
### To reset a user's password, via the container command line
#### To reset a user's password, via the container command line
If you are running Home Assistant in a container, you can use the command line in the container with the `hass` command to change your password. The steps below refer to a Home Assistant container in Docker named `homeassistant`. Note that while working in the container, commands will take a few moments to execute.
@ -73,7 +96,7 @@ 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 owner via the web interface
#### To reset a user's password, as an owner via the web interface
Only the owner can change other user's passwords.
@ -85,17 +108,7 @@ Only the owner can change other user's passwords.
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**.
### To delete a user
You need to be an owner or have administrator rights to delete a user.
1. Go to {% my people title="**Settings** > **People**" %} and select the person which you want to delete.
- Note: you cannot delete the owner.
2. At the bottom of the dialog box, select **Delete**.
- A confirmation dialog box will be displayed.
3. To confirm, select **OK**.
### To prepare the system to start a new onboarding process
## Preparing the system to start a new onboarding process
If you lose the password associated with the owner account and the steps above do not work to reset the password, the only way to resolve this is to start a new onboarding process.
@ -139,3 +152,13 @@ For Windows or macOS you will need third party software. Below are some options.
- Windows: <https://www.diskinternals.com/linux-reader/> (read-only access to the SD)
- macOS: <https://osxfuse.github.io/>
## Deleting a user
You need to be an owner or have administrator rights to delete a user.
1. Go to {% my people title="**Settings** > **People**" %} and select the person which you want to delete.
- Note: you cannot delete the owner.
2. At the bottom of the dialog box, select **Delete**.
- A confirmation dialog box will be displayed.
3. To confirm, select **OK**.

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

@ -41,16 +41,16 @@ Firmware can be upgraded using the below directions:
{% endwarning %}
- 800 series controllers (with some caveats, see notes)
- Z-Wave.Me Z-Station
- HomeSeer SmartStick G8
- Zooz 800 Series Z-Wave Long Range S2 Stick (ZST39 LR)
- 700 series controllers
- Aeotec Z-Stick 7 USB stick (ZWA010) (the EU version is not recommended due to RF performance issues)
- Silicon Labs UZB-7 USB Stick (Silabs SLUSB7000A / SLUSB001A)
- Zooz S2 Stick 700 (ZST10 700)
- HomeSeer SmartStick+ G3
- HomeSeer Z-NET G3
- Silicon Labs UZB-7 USB Stick (Silabs SLUSB7000A / SLUSB001A)
- Zooz S2 Stick 700 (ZST10 700)
- Z-Wave.Me Z-Station
- 500 series controllers
- Aeotec Z-Stick Gen5 (see note below)

2
source/_includes/asides/component_navigation.html
View File

@ -30,7 +30,7 @@
{%- if page.ha_brand -%}
The {{ page.title | default: page.name }} brand was introduced in Home Assistant {{ page.ha_release | default: "unknown" }}.
{%- else -%}
The {{ page.title | default: page.name }} {{ page.ha_integration_type | default: "integration" }} was introduced in Home Assistant {{ page.ha_release | default: "unknown" }}
The {{ page.title | default: page.name }} {% if page.ha_integration_type == "virtual" %} virtual integration {% else %} {{ page.ha_integration_type | default: "integration" }} {% endif %} was introduced in Home Assistant {{ page.ha_release | default: "unknown" }}
{%- if page.ha_iot_standard or page.ha_integration_type == "entity" -%}
.

2
source/_includes/asides/docs_sitemap.html
View File

@ -208,7 +208,7 @@
<li>{% active_link /docs/configuration/packages/ Packages %}</li>
<li>{% active_link /docs/configuration/secrets/ Storing secrets %}</li>
<li>{% active_link /docs/configuration/events/ Events %}</li>
<li>{% active_link /docs/configuration/state_object/ State objects %}</li>
<li>{% active_link /docs/configuration/state_object/ State and state object %}</li>
<li>{% active_link /docs/configuration/entities_domains/ Entities and domains %}</li>
<li>{% active_link /docs/configuration/templating/ Templating %}</li>
<li>{% active_link /docs/configuration/platform_options/ Entity component platform options %}</li>

1
source/_includes/dashboard/edit_dashboard.md
View File

@ -8,5 +8,6 @@ To add the {{ title | downcase }} to your user interface:
- If this is your first time editing a dashboard, the **Edit dashboard** dialog appears.
- By editing the dashboard, you are taking over control of this dashboard.
- This means that it is no longer automatically updated when new dashboard elements become available.
- Once you've taken control, you can't get this specific dashboard back to update automatically. However, you can create a new default dashboard.
- To continue, in the dialog, select the three dots {% icon "mdi:dots-vertical" %} menu, then select **Take control**.
2. [Add a card](/dashboards/cards/#adding-cards-to-your-dashboard) to your dashboard.

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

@ -16,8 +16,9 @@ The binary sensor has support for GET and POST requests.
_Tip:_ If you want to create multiple `sensors` using the same endpoint, use the [RESTful](/integrations/rest) configuration instructions.
The JSON messages can contain different values like `1`, `"1"`,
`TRUE`, `true`, `on`, or `open`. If the value is nested then use a
If the endpoint returns one of the values of these pairs: `0`/`1`,
`"0"`/`"1"`, `FALSE`/`TRUE`, `false`/`true`, `off`/`on` or `closed`/`open`
it can be used as-is. If the return value differs, use a
[template](/docs/configuration/templating/#processing-incoming-data).
If the endpoint returns XML with the `text/xml`, `application/xml`, or
`application/xhtml+xml` content type, it will automatically be converted

2
source/_integrations/cover.markdown
View File

@ -22,7 +22,7 @@ Home Assistant can give you an interface to control covers such as rollershutter
## The state of a cover
A can have the following states:
A cover can have the following states:
- **Opening**: The cover is in the process of opening to reach a set position.
- **Open**: The cover has reached the open position.

44
source/_integrations/event.markdown
View File

@ -89,6 +89,50 @@ actions:
When creating automations in the automation editor in the UI, the event types are available as a dropdown list, depending on the event entity you are using. This means you don't have to remember the different event types and can easily select them.
## Automating on a button press
This section shows a similar example to the example automation shown above in YAML. It's an automation that is triggered by an event state change, but shows how to implement it in the UI. To start an automation triggered by a button press (or a button press pattern), follow these steps.
### Prerequisites
- You have a device that takes button presses as inputs, such as a Tuo Smart Button, VTM31SN dimmer by Inovelli, or the Matter Pushbutton Module by Innovation Matters
- The device has been added to Home Assistant
### To automate on a button press
1. If you like, give your button event entity a friendly name.
- Under {% my integrations title="**Settings** > **Devices & services**" %}, select the **Matter** integration card and select the device.
- On the **Events** card, select the button entity.
![Select the button entity](/images/integrations/event/matter_button_event_entity.png)
- Under **Name**, enter the new friendly name.
![Change the entity name](/images/integrations/event/matter_button_rename.png)
2. Go to {% my automations title="**Settings** > **Automations & scenes**" %} and select **Create Automation**.
![The automation editor.](/images/getting-started/automation-editor.png)
- Then, select **Create new automation**. This brings up an empty automation page.
![The start of a new automation.](/images/getting-started/new-automation.png)
3. Define what should {% term trigger %} the automation to run.
- Select **Add trigger**, then, select **Entity** > **State**.
- Type `event` and select your button entity.
- **Important**: Leave the other fields **empty**.
![Select button event as trigger](/images/integrations/event/matter_trigger_on_button_event.png)
4. Define the condition when something should happen.
- Under **Then do**, select **Add action**.
- Type `choose` and select **Add condition**.
- Select **Entity** > **State** and select your button event entity from the list.
- Under **Attribute**, select **Event type**.
- Under **State**, select the state change you want to act as trigger, for example **Pressed once**.
- **Pressed once** is the event type. But the state of this event is the timestamp of when the button was pressed. This is why we automate on the state change so that it is triggered every time the button is pressed.
![Condition - button pressed](/images/integrations/event/matter_condition_button_pressed.png)
5. Define what should happen when your automation is triggered (when the button is pressed, for example).
- Select **Add action** and define your action.
6. Repeat these steps for each event type you want to monitor.
- In this example, we want to do something else when the button was pressed twice.
![Condition - add another option when the button is pressed twice](/images/integrations/event/matter_button_option_2.png)
7. **Save** the automation.
## Device class
{% include integrations/device_class_intro.md %}

2
source/_integrations/gtfs.markdown
View File

@ -16,7 +16,7 @@ related:
The `gtfs` {% term integration %} will give you the next departure time and associated data from your public transit station/stop. The data comes from your chosen public transit authority and is formatted as [General Transit Feed Specification](https://developers.google.com/transit/gtfs/) data, commonly known as GTFS.
You need to find a valid GTFS data set, which you can usually find just by searching the internet. Most public transit authorities have GTFS available somewhere, as Google requires public transit authorities to provide the data if they wish to appear on Google Maps. You may also be able to find data at [TransitFeeds](https://transitfeeds.com/feeds).
You need to find a valid GTFS data set, which you can usually find just by searching the internet. Most public transit authorities have GTFS available somewhere, as Google requires public transit authorities to provide the data if they wish to appear on Google Maps. You may also be able to find data at [Mobility Database](https://mobilitydatabase.org/).
Here are some examples:

20
source/_integrations/madvr.markdown
View File

@ -34,6 +34,26 @@ The command structure uses the same keywords as the [official documentation](htt
Using these commands, you can create a digital remote in the UI.
Example:
```yaml
# Command with parameters
action: remote.send_command
data:
command: KeyPress, SETTINGS
target:
entity_id: remote.madvr_envy
```
```yaml
# Single command
action: remote.send_command
data:
command: Restart
target:
entity_id: remote.madvr_envy
```
### Single Commands
These are commands that can be sent standalone, no parameters.

4
source/_integrations/matter.markdown
View File

@ -337,6 +337,10 @@ The CSA operates a Distributed Compliance Ledger (DCL) which provides metadata f
Notification of an OTA update for a Matter device
</p>
## Automate on a button press
You have a device that takes button presses as inputs (such as a Tuo Smart Button, VTM31SN dimmer by Inovelli, or the Matter Pushbutton Module by Innovation Matters) and now want to trigger an automation based on that button press. To learn how to create an automation triggered by a button press, refer to this [tutorial](/integrations/event/#automating-on-a-button-press).
## Experiment with Matter using a ESP32 dev board
You do not yet have any Matter-compatible hardware but you do like to try it out or maybe create your own DIY Matter device? We have [prepared a page for you](https://nabucasa.github.io/matter-example-apps/) where you can easily flash Matter firmware to a supported ESP32 development board. We recommend the M5 Stamp C3 device running the Lighting app.

2
source/_integrations/mikrotik.markdown
View File

@ -62,7 +62,7 @@ If everything is working fine you can disable the pure `api` service in RouterOS
## The user privileges in RouterOS
To use this device tracker you need restricted privileges only. To enhance the security of your MikroTik device create a "read only" user who is able to connect to API and perform ping test only:
To use this device tracker, you only need limited privileges. To enhance the security of your MikroTik device, create a "read only" user who can connect to API and perform ping test only:
```bash
/user group add name=homeassistant policy=read,api,test,!local,!telnet,!ssh,!ftp,!reboot,!write,!policy,!winbox,!password,!web,!sniff,!sensitive,!romon,!dude,!tikapp

4
source/_integrations/nad.markdown
View File

@ -14,14 +14,14 @@ related:
title: Configuration file
---
The `nad` {% term integration %} allows you to control a [NAD receiver](https://nadelectronics.com/) through RS232, TCP and Telnet from Home Assistant.
The `nad` {% term integration %} allows you to control an [NAD receiver](https://nadelectronics.com/) through RS232, TCP and Telnet from Home Assistant.
Please note that the RS232 interface is only tested with the NAD T748v2, but it should work with other NAD receivers.
The Telnet interface has been tested with the NAD T787 and the NAD C658.
## Configuration
To add a NAD receiver to your installation, add the following to your {% term "`configuration.yaml`" %} file.
To add an NAD receiver to your installation, add the following to your {% term "`configuration.yaml`" %} file.
{% include integrations/restart_ha_after_config_inclusion.md %}
```yaml

2
source/_integrations/recorder.markdown
View File

@ -149,7 +149,7 @@ recorder:
{% include common-tasks/filters.md %}
If you only want to hide events from your history, take a look at the [`history` integration](/integrations/history/). The same goes for the [logbook](/integrations/logbook/). But if you have privacy concerns about certain events or want them in neither the history or logbook, you should use the `exclude`/`include` options of the `recorder` integration. That way they aren't even in your database, you can reduce storage and keep the database small by excluding certain often-logged events (like `sensor.last_boot`).
If you only want to hide events from your logbook, take a look at the [logbook integration](/integrations/logbook/). But if you have privacy concerns about certain events or want them in neither the history or logbook, you should use the `exclude`/`include` options of the `recorder` integration. That way they aren't even in your database, you can reduce storage and keep the database small by excluding certain often-logged events (like `sensor.last_boot`).
#### Common filtering examples

1
source/_integrations/reolink.markdown
View File

@ -301,6 +301,7 @@ The following models have been tested and confirmed to work with a direct link t
- [RLC-823A](https://reolink.com/product/rlc-823a/)
- [RLC-830A](https://reolink.com/product/rlc-830a/)
- [RLC-833A](https://reolink.com/product/rlc-833a/)
- [RLC-843A](https://reolink.com/product/rlc-843a/)
- [RLC-1212A](https://reolink.com/product/rlc-1212a/)
- [RLC-1224A](https://reolink.com/product/rlc-1224a/)
- [RLN8-410 NVR](https://reolink.com/product/rln8-410/)

3
source/_integrations/tesla_fleet.markdown
View File

@ -45,7 +45,8 @@ You must have a [Tesla](https://tesla.com) account and a Tesla vehicle, PowerWal
{% details "Use a custom OAuth application" %}
The integration has a built-in OAuth application that will be suitable for most users. However, you can [create your own application](https://developer.tesla.com/dashboard) for the Tesla Fleet API and configure it as an [application credential](https://my.home-assistant.io/redirect/application_credentials). When creating the application, you must set `https://my.home-assistant.io/redirect/oauth` as the redirect URL.
The integration has a built-in OAuth application that will be suitable for most users. However, you can [create your own application](https://developer.tesla.com/docs/fleet-api/getting-started/what-is-fleet-api#step-2-create-an-application) for the Tesla Fleet API and configure it as an [application credential](https://my.home-assistant.io/redirect/application_credentials).
When creating the application, you must set the redirect URL to `https://my.home-assistant.io/redirect/oauth`, but the other URLs can be set as desired. You must also complete both [step 3](https://developer.tesla.com/docs/fleet-api/getting-started/what-is-fleet-api#step-3-generate-a-public-private-key-pair) and [step 4](https://developer.tesla.com/docs/fleet-api/getting-started/what-is-fleet-api#step-4-call-the-register-endpoint) before the application will be able to make API calls.
You will be prompted to pick your custom application credential when creating a Tesla Fleet config entry.

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

@ -214,7 +214,6 @@ unique_id:
mqtt:
- vacuum:
name: "MQTT Vacuum"
schema: state
supported_features:
- start
- pause
@ -227,7 +226,6 @@ mqtt:
- fan_speed
- send_command
command_topic: "vacuum/command"
state_topic: "vacuum/state"
set_fan_speed_topic: "vacuum/set_fan_speed"
fan_speed_list:
- min

32
source/_integrations/water_heater.markdown
View File

@ -38,7 +38,7 @@ A water heater entity can have the following states:
### Water heater control actions
Available actions: `water_heater.set_temperature`, `water_heater.turn_away_mode_on`, `water_heater.turn_away_mode_off`, `water_heater.set_operation_mode`
Available actions: `water_heater.set_temperature`, `water_heater.turn_away_mode_on`, `water_heater.turn_away_mode_off`, `water_heater.set_operation_mode`, `water_heater.turn_on`, `water_heater.turn_off`
{% tip %}
Not all water heater actions may be available for your platform. Be sure to check the available actions Home Assistant has enabled by checking **Developer Tools** > **Actions**.
@ -50,9 +50,9 @@ Sets target temperature of water heater device.
| Data attribute | Optional | Description |
| ---------------------- | -------- | ----------- |
| `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 {% term integration %} documentation.
| `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 {% term integration %} documentation. |
#### Automation example
@ -76,8 +76,8 @@ Set operation mode for water heater device
| Data attribute | Optional | Description |
| ---------------------- | -------- | ----------- |
| `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.
| `operation_mode` | no | New value of operation mode. For a list of possible modes, refer to the integration documentation.
| `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. |
| `operation_mode` | no | New value of operation mode. For a list of possible modes, refer to the integration documentation. |
#### Automation example
@ -100,8 +100,8 @@ Turn away mode on or off for water heater device
| Data attribute | Optional | Description |
| ---------------------- | -------- | ----------- |
| `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.
| `away_mode` | no | New value of away mode. 'on'/'off' or True/False
| `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. |
| `away_mode` | no | New value of away mode. 'on'/'off' or True/False |
#### Automation example
@ -117,3 +117,19 @@ automation:
data:
away_mode: true
```
### Action `water_heater.turn_on`
Turn water heater device on.
| Data attribute | Optional | Description |
| ---------------------- | -------- | ----------- |
| `entity_id` | yes | String or list of strings that define the entity ID(s) of water heater device(s) to control. To target all water heater devices, use `all`. |
### Action `water_heater.turn_off`
Turn water heater device off.
| Data attribute | Optional | Description |
| ---------------------- | -------- | ----------- |
| `entity_id` | yes | String or list of strings that define the entity ID(s) of water heater device(s) to control. To target all water heater devices, use `all`. |

6
source/_integrations/waze_travel_time.markdown
View File

@ -22,7 +22,7 @@ Notes:
- 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 {% 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.
- The `incl_filter`/`excl_filter` allow you to force the {% term integration %} to use a particular route or avoid a particular route in its time travel calculation. These inputs must be an exact match to the street name including casing, spaces, and special characters.
- 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.
## Action `waze_travel_time.get_travel_times`
@ -37,8 +37,8 @@ with route alternatives and travel times between two locations.
| `region` | no | The region. Controls which waze server is used. | "us" |
| `units` | yes | Which unit system to use | metric |
| `vehicle_type` | yes | Which vehicle to use | "car" |
| `incl_filter` | yes | Which street names must be part of the route | "A321" |
| `excl_filter` | yes | Which street names must not be part of the route | "A321" |
| `incl_filter` | yes | Exact streetname which must be part of the selected route | "L3482 - Wiesbadener Straße" |
| `excl_filter` | yes | Exact streetname which must NOT be part of the selected route | "L3482 - Wiesbadener Straße" |
| `realtime` | yes | Use real-time or statistical data | True |
| `avoid_toll_roads` | yes | Whether to avoid toll roads | True |
| `avoid_ferries` | yes | Whether to avoid ferries | True |

49
source/_integrations/withings.markdown
View File

@ -21,23 +21,36 @@ ha_quality_scale: platinum
The **Withings** {% term integration %} consumes data from various health products produced by [Withings](https://www.withings.com).
## Create a Withings developer account
## Prerequisites
You must have a developer account to distribute the data. [Create a free developer account](https://account.withings.com/partner/add_oauth2).
- Withings account
- Withings app installed
- Withings device setup in the app
- [Withings developer account](#create-a-withings-developer-account) to get a *ClientID* and *Secret* to connect to be able to get the data from the Withings cloud API
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 API integration
- 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.
### Creating a Withings developer account
Once saved, the *ClientID* and *Secret* fields will be populated. You will need these in the next step.
You must have a developer account to distribute the data.
{% note %}
You only need one developer account. The same account and credentials are used for each Withings configuration.
{% endnote %}
1. [Create a free developer account](https://account.withings.com/partner/add_oauth2).
2. Make sure to select **Withings public cloud** (and not Withings US medical cloud or similar).
3. Select **Create an application**.
4. Under **Application creation**, select **Public API integration**.
- Read and accept the terms and select **Next**.
5. Under **Information**:
- **Target environment**: *Development*
- **Application name**: [any name]
- **Application description**: [any description]
- **Registered URLs**: `https://my.home-assistant.io/redirect/oauth`
- Do not test this URL. It won't work at this stage. It will be setup once you install the integration in Home Assistant.
- **Change logo**: Optional
6. **Save** your changes.
- Once saved, the *ClientID* and *Secret* fields will be populated.
- Copy and store them in a save place. You will need these in the next step.
{% details "I have manually disabled My Home Assistant" %}
@ -51,14 +64,12 @@ authentication process.
Withings will validate (with HTTP HEAD) these requirements each time you save your Withings developer account. When these checks fail, the Withings UI is not always clear about why.
- Home Assistant (For create/update of Withings developer account):
- Publicly accessible.
- Running on a fully qualified domain name.
- Running over HTTPS signed by a globally recognized Certificate Authority. Let's Encrypt will work.
- Publicly accessible.
- Running on a fully qualified domain name.
- Running over HTTPS signed by a globally recognized Certificate Authority. Let's Encrypt will work.
{% enddetails %}
Note: You will only need one developer account; the same account and credentials are used for each Withings configuration.
{% include integrations/config_flow.md %}
## Data updates

2
source/_integrations/yale.markdown
View File

@ -94,7 +94,7 @@ Not all models include motion sensors and support for locks with built-in doorbe
## Camera
The `yale` camera platform allows you to view the latest camera image (triggered by motion) by your [Yale](https://yale.com/) device in Home Assistant.
The `yale` camera platform allows you to view the latest camera image (triggered by motion) by your [Yale](https://yalehome.com/) device in Home Assistant.
## Sensor

1
source/_redirects
View File

@ -255,6 +255,7 @@ layout: null
/docs/assist/voice_remote_expose_devices/ /voice_control/voice_remote_expose_devices/
/docs/assist/voice_remote_local_assistant/ /voice_control/voice_remote_local_assistant/
/skyconnect /connectzbt1#from-skyconnect
/glossary/ /docs/glossary/
# Redirect for the QR Codes on the S3 Box
/s3-box-no-wifi /voice_control/troubleshooting_the_s3_box/#error-unable-to-connect-to-wi-fi

4
source/dashboards/badges.markdown
View File

@ -75,7 +75,7 @@ show_name:
required: false
description: Show the name
type: boolean
default: "true"
default: "false"
show_icon:
required: false
description: Show the icon
@ -85,7 +85,7 @@ show_state:
required: false
description: Show the state.
type: boolean
default: "false"
default: "true"
state_content:
required: false
description: >

1
source/dashboards/dashboards.markdown
View File

@ -96,6 +96,7 @@ This will leave the default dashboard intact.
- The **Edit dashboard** dialog appears.
- By editing the dashboard, you are taking over control of this dashboard.
- This means that it is no longer automatically updated when new dashboard elements become available.
- Once you've taken control, ou can't get this specific dashboard back to update automatically. However, you can create a new default dashboard.
- To continue, in the dialog, select the three dots {% icon "mdi:dots-vertical" %} menu, then select **Take control**.
7. You can now [add a card](/dashboards/cards/#adding-cards-to-your-dashboard) or [add a view](/dashboards/views/#adding-a-view-to-a-dashboard).

12
source/getting-started/concepts-terminology.markdown
View File

@ -20,12 +20,6 @@ For a full list of compatible {% term integrations %}, refer to the [integration
Once an {% term integration %} has been added, the hardware and/or data are represented in Home Assistant as [devices and entities](#devices).
## Entities
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 %}.
<p class='img'><img src='/images/getting-started/entities.png' style='border: 0;box-shadow: none;' alt="Screenshot showing the Entities table">Screenshot of the Entities table. Each line represents an entity.</p>
## 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.
@ -40,6 +34,12 @@ Devices and entities are used throughout Home Assistant. To name a few examples:
![Home Assistant device](/images/getting-started/home-assistant-device_02.png)
## Entities
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 %}.
<p class='img'><img src='/images/getting-started/entities.png' style='border: 0;box-shadow: none;' alt="Screenshot showing the Entities table">Screenshot of the Entities table. Each line represents an entity.</p>
## Areas
An area in Home Assistant is a logical grouping of {% term devices %} and {% term entities %} that are meant to match areas (or rooms) in the physical world: your home. For example, the `living room` area groups devices and entities in your living room. Areas allow you to target service calls at an entire group of devices. For example, turning off all the lights in the living room.

1
source/getting-started/onboarding_dashboard.markdown
View File

@ -83,6 +83,7 @@ In the following steps, we will create a new dashboard and edit some card settin
- This means that it is no longer automatically updated when new dashboard elements become available.
- To continue, in the dialog, select the three dots {% icon "mdi:dots-vertical" %} menu, then select **Take control**.
- Read and accept this before continuing.
- You can't get this specific dashboard back to update automatically. However. you can create a new default dashboard.
6. Your dashboard might not have much on it yet.
- If you have smart home devices in your home, some may have been connected automatically.
- In this example, some Bluetooth temperature sensors and an AV receiver connected automatically.

BIN
source/images/dashboards/map_card_config.png Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 234 KiB

BIN
source/images/dashboards/markdown_card_qr_code.png Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 68 KiB

BIN
source/images/dashboards/sidebar_view_move_card.png
View File

Binary file not shown.
Side by Side Swipe Overlay

Before

Width:  |  Height:  |  Size: 91 KiB

After

Width:  |  Height:  |  Size: 83 KiB

BIN
source/images/dashboards/view_edit_config.png Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 31 KiB

BIN
source/images/integrations/event/matter_button_event_entity.png Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 70 KiB

BIN
source/images/integrations/event/matter_button_option_2.png Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 46 KiB

BIN
source/images/integrations/event/matter_button_rename.png Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 130 KiB

BIN
source/images/integrations/event/matter_condition_button_pressed.png Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 38 KiB

BIN
source/images/integrations/event/matter_trigger_on_button_event.png Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 36 KiB