From bde81adb632e2adf3ab8fcc6be782698c21f4aff Mon Sep 17 00:00:00 2001 From: Paulus Schoutsen Date: Tue, 5 Nov 2024 13:06:51 -0500 Subject: [PATCH 1/9] Document device_id for sentence trigger (#35586) --- source/_docs/automation/templating.markdown | 1 + 1 file changed, 1 insertion(+) diff --git a/source/_docs/automation/templating.markdown b/source/_docs/automation/templating.markdown index bd18fa79125..ce3529e1342 100644 --- a/source/_docs/automation/templating.markdown +++ b/source/_docs/automation/templating.markdown @@ -102,6 +102,7 @@ These are the properties available for a [Sentence trigger](/docs/automation/tri | `trigger.sentence` | Text of the sentence that was matched | `trigger.slots` | Object with matched slot values | `trigger.details` | Object with matched slot details by name, such as [wildcards](/docs/automation/trigger/#sentence-wildcards). Each detail contains: +| `trigger.device_id` | The device ID that captured the command, if any. ### State From 931fee1280bbb729a7da5fc9c6a3dbaaaa5f1622 Mon Sep 17 00:00:00 2001 From: jgatto1 Date: Wed, 6 Nov 2024 03:34:21 -0300 Subject: [PATCH 2/9] updating Knocki docs (#34654) * Knocki docs * fix: removed troubleshooting from this PR * Remove automtion steps, move some of the steps into prereqs * Apply suggestions from code review * feat: automation example and troubleshooting section * fix: coderabbit suggestions * fix: remove troubleshooting --------- Co-authored-by: c0ffeeca7 <38767475+c0ffeeca7@users.noreply.github.com> --- source/_integrations/knocki.markdown | 24 +++++++++++++++++++++--- 1 file changed, 21 insertions(+), 3 deletions(-) diff --git a/source/_integrations/knocki.markdown b/source/_integrations/knocki.markdown index 37516e56db0..a10add6610f 100644 --- a/source/_integrations/knocki.markdown +++ b/source/_integrations/knocki.markdown @@ -16,12 +16,30 @@ ha_platforms: ha_integration_type: hub --- -The **Knocki** {% term integration %} can receive events for the triggers set up from your [Knocki devices](https://knocki.com/). +The **Knocki** {% term integration %} allows you to trigger your favorite automations simply by tapping custom patterns (such as triple taps) on ordinary surfaces. ## Prerequisites -To use the Knocki integration, you need a Knocki account. +- You must have a [Knocki device](http://knocki.com). -Once you set a trigger in the app, it will show up in Home Assistant to use. +- Completed the setup process in the **Knocki** mobile app, as described in steps 1-7 below. + +1. Open the Knocki Mobile App. It’s a free download on [iOS](https://apps.apple.com/us/app/knocki/id1238395440) and [Android](https://play.google.com/store/apps/details?id=com.knocki.mobileapp). +2. Using the app, log-in or create a new Knocki account. +3. From the app’s home screen, select a Knocki or [add a Knocki](https://support.knocki.com/hc/en-us/articles/12769368448659-How-Do-Add-a-Knocki-to-My-Account). +4. On the app’s device screen, select a gesture or [add a gesture](https://support.knocki.com/hc/en-us/articles/360013333634-Creating-a-Gesture). +5. Next, select the [add a task](https://support.knocki.com/hc/en-us/articles/12920956118291-How-do-I-Add-Tasks-to-a-Knocki) option. +6. Scroll down the task menu and select Home Assistant. +7. Follow the in-app instructions to add the Home Assistant task. {% include integrations/config_flow.md %} + +## Automation example + +1. Go to {% my automations title="**Settings** > **Automations & scenes**" %} and in the lower right corner, select **Create Automation**. +2. Select **Create new automation**. +3. Select **Add Trigger**, select **Entity** as the trigger type. + - Search for the name of the task (as you named it in the Knocki app). Select the entity with that name appended to it. + - Select **State** as the type of entity change. +4. Select **Add action** and choose whatever action(s) you’d like the automation to trigger. +5. Finally, test the action by tapping the associated gesture pattern. From 47961aad776ea40f5346128bf270c3563d280bea Mon Sep 17 00:00:00 2001 From: "dependabot[bot]" <49699333+dependabot[bot]@users.noreply.github.com> Date: Wed, 6 Nov 2024 07:43:16 +0100 Subject: [PATCH 3/9] build(deps-dev): bump ruby-lsp from 0.21.2 to 0.21.3 (#35591) Bumps [ruby-lsp](https://github.com/Shopify/ruby-lsp) from 0.21.2 to 0.21.3. - [Release notes](https://github.com/Shopify/ruby-lsp/releases) - [Commits](https://github.com/Shopify/ruby-lsp/compare/v0.21.2...v0.21.3) --- updated-dependencies: - dependency-name: ruby-lsp dependency-type: direct:development update-type: version-update:semver-patch ... Signed-off-by: dependabot[bot] Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> --- Gemfile | 2 +- Gemfile.lock | 6 +++--- 2 files changed, 4 insertions(+), 4 deletions(-) diff --git a/Gemfile b/Gemfile index da22cadd07a..14098399bc0 100644 --- a/Gemfile +++ b/Gemfile @@ -13,7 +13,7 @@ group :development do # 1.80.5 breaks the build gem 'sass-embedded', '1.80.6' gem 'rubocop', '1.68.0' - gem 'ruby-lsp', '0.21.2' + gem 'ruby-lsp', '0.21.3' gem 'rackup', '2.2.0' end diff --git a/Gemfile.lock b/Gemfile.lock index 1b47856107b..a08521b51f3 100644 --- a/Gemfile.lock +++ b/Gemfile.lock @@ -124,7 +124,7 @@ GEM unicode-display_width (>= 2.4.0, < 3.0) rubocop-ast (1.34.0) parser (>= 3.3.1.0) - ruby-lsp (0.21.2) + ruby-lsp (0.21.3) language_server-protocol (~> 3.17.0) prism (>= 1.2, < 2.0) rbs (>= 3, < 4) @@ -149,7 +149,7 @@ GEM rack-protection (= 4.0.0) rack-session (>= 2.0.0, < 3) tilt (~> 2.0) - sorbet-runtime (0.5.11633) + sorbet-runtime (0.5.11635) stringex (2.8.6) terminal-table (3.0.2) unicode-display_width (>= 1.1.1, < 3) @@ -176,7 +176,7 @@ DEPENDENCIES rackup (= 2.2.0) rake (= 13.2.1) rubocop (= 1.68.0) - ruby-lsp (= 0.21.2) + ruby-lsp (= 0.21.3) sass-embedded (= 1.80.6) sass-globbing (= 1.1.5) sassc (= 2.1.0) From 70a631f7a5ca865a60b4bc256c561251c53d4c11 Mon Sep 17 00:00:00 2001 From: "dependabot[bot]" <49699333+dependabot[bot]@users.noreply.github.com> Date: Wed, 6 Nov 2024 07:43:40 +0100 Subject: [PATCH 4/9] build(deps-dev): bump parser from 3.3.5.1 to 3.3.6.0 (#35592) Bumps [parser](https://github.com/whitequark/parser) from 3.3.5.1 to 3.3.6.0. - [Changelog](https://github.com/whitequark/parser/blob/master/CHANGELOG.md) - [Commits](https://github.com/whitequark/parser/compare/v3.3.5.1...v3.3.6.0) --- updated-dependencies: - dependency-name: parser dependency-type: indirect update-type: version-update:semver-patch ... Signed-off-by: dependabot[bot] Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> --- Gemfile.lock | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/Gemfile.lock b/Gemfile.lock index a08521b51f3..1f9a036f9ef 100644 --- a/Gemfile.lock +++ b/Gemfile.lock @@ -86,7 +86,7 @@ GEM nokogiri (1.16.7-x86_64-linux) racc (~> 1.4) parallel (1.26.3) - parser (3.3.5.1) + parser (3.3.6.0) ast (~> 2.4.1) racc pathutil (0.16.2) From cb86f67a14a9998712e47c8ec2aa202e7095f44a Mon Sep 17 00:00:00 2001 From: "dependabot[bot]" <49699333+dependabot[bot]@users.noreply.github.com> Date: Wed, 6 Nov 2024 07:44:01 +0100 Subject: [PATCH 5/9] build(deps-dev): bump sorbet-runtime from 0.5.11633 to 0.5.11635 (#35593) Bumps [sorbet-runtime](https://github.com/sorbet/sorbet) from 0.5.11633 to 0.5.11635. - [Release notes](https://github.com/sorbet/sorbet/releases) - [Commits](https://github.com/sorbet/sorbet/commits) --- updated-dependencies: - dependency-name: sorbet-runtime dependency-type: indirect update-type: version-update:semver-patch ... Signed-off-by: dependabot[bot] Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> From 12683d075fc3254b8d077dcc30f6ef5105ecad29 Mon Sep 17 00:00:00 2001 From: "dependabot[bot]" <49699333+dependabot[bot]@users.noreply.github.com> Date: Wed, 6 Nov 2024 07:49:26 +0100 Subject: [PATCH 6/9] build(deps-dev): bump sorbet-runtime from 0.5.11635 to 0.5.11637 (#35594) Bumps [sorbet-runtime](https://github.com/sorbet/sorbet) from 0.5.11635 to 0.5.11637. - [Release notes](https://github.com/sorbet/sorbet/releases) - [Commits](https://github.com/sorbet/sorbet/commits) --- updated-dependencies: - dependency-name: sorbet-runtime dependency-type: indirect update-type: version-update:semver-patch ... Signed-off-by: dependabot[bot] Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> --- Gemfile.lock | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/Gemfile.lock b/Gemfile.lock index 1f9a036f9ef..60870d1955e 100644 --- a/Gemfile.lock +++ b/Gemfile.lock @@ -149,7 +149,7 @@ GEM rack-protection (= 4.0.0) rack-session (>= 2.0.0, < 3) tilt (~> 2.0) - sorbet-runtime (0.5.11635) + sorbet-runtime (0.5.11637) stringex (2.8.6) terminal-table (3.0.2) unicode-display_width (>= 1.1.1, < 3) From b10adcbff2e33022fee9e45c31fe7c54e503d465 Mon Sep 17 00:00:00 2001 From: c0ffeeca7 <38767475+c0ffeeca7@users.noreply.github.com> Date: Wed, 6 Nov 2024 11:25:32 +0100 Subject: [PATCH 7/9] Auth providers: fix path to user configuration page (#35597) --- source/_docs/authentication/providers.markdown | 11 ++++++++--- 1 file changed, 8 insertions(+), 3 deletions(-) diff --git a/source/_docs/authentication/providers.markdown b/source/_docs/authentication/providers.markdown index 872f488cc53..a2bf1ede505 100644 --- a/source/_docs/authentication/providers.markdown +++ b/source/_docs/authentication/providers.markdown @@ -123,11 +123,16 @@ homeassistant: - group: system-users ``` -First note, for `trusted_users` configuration you need to use `user id`, which you can find through {% my users title="Settings -> People" %} -> View User Detail. The `trusted_users` configuration will not validate the existence of the user, so please make sure you have put in the correct user id by yourself. +First note, for `trusted_users` configuration you need to use `user id`. -Second note, a trusted user with an IPv6 address must put the IPv6 address in quotes as shown. +1. To find the user ID, in your browser, make sure the URL of your Home Assistant ends in `config/users/`. + - For example: `homeassistant:8123/config/users`. +2. Select the user from the list, and copy the ID. + - For example: `acbbff56461748718f3650fb914b88c9`. +3. The `trusted_users` configuration will not validate the existence of the user, so please make sure you have put in the correct user id. +4. A trusted user with an IPv6 address must put the IPv6 address in quotes as shown. -In above example, if user try to access Home Assistant from 192.168.0.1, they will have only one user available to choose. They will have two users available if access from 192.168.0.38 (from 192.168.0.0/24 network). If they access from 192.168.10.0/24 network, they can choose from all available users (non-system and active users). +In the above example, if user try to access Home Assistant from 192.168.0.1, they will have only one user available to choose. They will have two users available if access from 192.168.0.38 (from 192.168.0.0/24 network). If they access from 192.168.10.0/24 network, they can choose from all available users (non-system and active users). 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. From 109a7b2e2ea6d16522466371cb29399ce7d1afad Mon Sep 17 00:00:00 2001 From: c0ffeeca7 <38767475+c0ffeeca7@users.noreply.github.com> Date: Wed, 6 Nov 2024 11:26:26 +0100 Subject: [PATCH 8/9] Streamline username spelling. lowercase, no spaces (#35599) --- source/_docs/authentication.markdown | 6 +++--- source/_docs/configuration/basic.markdown | 9 +++++---- source/_integrations/person.markdown | 3 ++- 3 files changed, 10 insertions(+), 8 deletions(-) diff --git a/source/_docs/authentication.markdown b/source/_docs/authentication.markdown index 8a83d5cc374..2e929a4f4f7 100644 --- a/source/_docs/authentication.markdown +++ b/source/_docs/authentication.markdown @@ -7,7 +7,7 @@ The authentication system secures access to Home Assistant. ## Login screen -You are greeted with a log in screen, asking you for user name and password. +You are greeted with a log in screen, asking you for username and password. Screenshot of the login screen, when logging in from within the local network @@ -55,9 +55,9 @@ As an extra level of security, you can turn on [multi-factor authentication](/do If you have administrator rights, you can [add a person to Home Assistant](/integrations/person/#adding-a-person-to-home-assistant) and create them a user account. -## Changing display or user name +## Changing display or username -To learn how to change a display or user name, refer to [setting up basic information](/docs/configuration/basic/). +To learn how to change a display or username, refer to [setting up basic information](/docs/configuration/basic/). ## Other authentication techniques diff --git a/source/_docs/configuration/basic.markdown b/source/_docs/configuration/basic.markdown index 016a622a5d1..97c3a71e623 100644 --- a/source/_docs/configuration/basic.markdown +++ b/source/_docs/configuration/basic.markdown @@ -39,7 +39,7 @@ To change the general settings that were defined during onboarding, follow these ## Changing a person's display name -The display name is the name that is shown in Home Assistant. It can differ from the user name, which is the name used to log in. +The display name is the name that is shown in Home Assistant. It can differ from the username, which is the name used to log in. ### Prerequisites @@ -50,18 +50,19 @@ The display name is the name that is shown in Home Assistant. It can differ from 1. To edit the display name of a person using Home Assistant, go to {% my people title="**Settings** > **People**" %} and select the person for which you want to change the display name. 2. Change the display name and select **Update** to save the change. -## Changing a user name +## Changing a username -The user name is the name that is used to log in. It can differ from the display name. +The username is the name that is used to log in. It can differ from the display name. ### Prerequisites -- You need owner rights to change a user name. +- You need owner rights to change a username. ### To change a username 1. To edit the username of a person using Home Assistant, go to {% my people title="**Settings** > **People**" %} and select the person for which you want to change the display name. 2. Change the username and select **Update** to save the change. + - It must be lowercase and contain no spaces. - The log in is case-sensitive. ## Changing authentication settings diff --git a/source/_integrations/person.markdown b/source/_integrations/person.markdown index d773e7a2923..b00ea83ef27 100644 --- a/source/_integrations/person.markdown +++ b/source/_integrations/person.markdown @@ -44,7 +44,8 @@ If you have administrator rights, you can add other persons to Home Assistant an - They cannot have their own dashboard, for example. - But they can still be used for device tracking and show up on a map and be used in automations. 5. If they are able to log in, fill in the user information. - - Check if the user name is correct. A suggestion is made based on the person name. But they do not have to be identical. + - Check if the username is correct. A suggestion is made based on the person name. But they do not have to be identical. + - The username must be lowercase and contain no spaces. - The username is required to log in. - The person name is the name displayed in the UI. - Enter a password and store it in a safe location. From 3b184f61b213801a3c4285df8ccb06b367546cc6 Mon Sep 17 00:00:00 2001 From: Paulus Schoutsen Date: Wed, 6 Nov 2024 10:53:07 -0500 Subject: [PATCH 9/9] Fix youtube video in built-in sentences (#35607) --- source/voice_control/builtin_sentences.markdown | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/source/voice_control/builtin_sentences.markdown b/source/voice_control/builtin_sentences.markdown index 6e53be0421c..7da1a505724 100644 --- a/source/voice_control/builtin_sentences.markdown +++ b/source/voice_control/builtin_sentences.markdown @@ -131,7 +131,7 @@ Home Assistant comes with [built-in sentences](https://github.com/home-assistant - *how much time is left on kitchen timer?* - *how much time is left on 5 minute timer?* -"p class='img'""lite-youtube videoid=v3mNdTsX4J0 videotitle=Voice timers with countdown text and loading bar""/lite-youtube"Timers running on an S3-Box-3B, with countdown text and a loading bar!"/p" +

Timers running on an S3-Box-3B, with countdown text and a loading bar!

To learn how to set this up, refer to the [ESP32-S3-Box-3B tutorial](/voice_control/s3_box_voice_assistant/).