Release notes 2024.9 (#34575)
* build(deps-dev): bump sorbet-runtime from 0.5.11549 to 0.5.11551 (#34487) Bumps [sorbet-runtime](https://github.com/sorbet/sorbet) from 0.5.11549 to 0.5.11551. - [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] <support@github.com> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> * build(deps-dev): bump google-protobuf from 4.27.4 to 4.28.0 (#34488) Bumps [google-protobuf](https://github.com/protocolbuffers/protobuf) from 4.27.4 to 4.28.0. - [Release notes](https://github.com/protocolbuffers/protobuf/releases) - [Changelog](https://github.com/protocolbuffers/protobuf/blob/main/protobuf_release.bzl) - [Commits](https://github.com/protocolbuffers/protobuf/commits) --- updated-dependencies: - dependency-name: google-protobuf dependency-type: indirect update-type: version-update:semver-minor ... Signed-off-by: dependabot[bot] <support@github.com> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> * Add limitations section to Enmax integration (#34493) Enmax Energy only publishes monthly data via Opower, make a note in the documentation * build(deps-dev): bump ruby-lsp from 0.17.16 to 0.17.17 (#34496) Bumps [ruby-lsp](https://github.com/Shopify/ruby-lsp) from 0.17.16 to 0.17.17. - [Release notes](https://github.com/Shopify/ruby-lsp/releases) - [Commits](https://github.com/Shopify/ruby-lsp/compare/v0.17.16...v0.17.17) --- updated-dependencies: - dependency-name: ruby-lsp dependency-type: direct:development update-type: version-update:semver-patch ... Signed-off-by: dependabot[bot] <support@github.com> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> * build(deps-dev): bump sorbet-runtime from 0.5.11551 to 0.5.11553 (#34497) Bumps [sorbet-runtime](https://github.com/sorbet/sorbet) from 0.5.11551 to 0.5.11553. - [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] <support@github.com> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> * Locked out: add screencast of auth reset (#34499) * Locked out: add screencast of auth reset * Update steps to point to Green and Yellow reset procedures * Fix copy paste error * Update clip * Fix video to show standard port * Fix typo in "default sentences" documentation (#34528) * Add missing quote (#34519) Signed-off-by: Matthias Beyer <mail@beyermatthias.de> * Fix opentherm_gw gpio modes (#34501) * home connect: Update links for registering an app and logging out (#34508) * Update links for registering an app and logging out * Update link * Update source/_integrations/home_connect.markdown Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com> * tiny tweaks --------- Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com> Co-authored-by: c0ffeeca7 <38767475+c0ffeeca7@users.noreply.github.com> * build(deps-dev): bump rubocop from 1.65.1 to 1.66.0 (#34535) Bumps [rubocop](https://github.com/rubocop/rubocop) from 1.65.1 to 1.66.0. - [Release notes](https://github.com/rubocop/rubocop/releases) - [Changelog](https://github.com/rubocop/rubocop/blob/master/CHANGELOG.md) - [Commits](https://github.com/rubocop/rubocop/compare/v1.65.1...v1.66.0) --- updated-dependencies: - dependency-name: rubocop dependency-type: direct:development update-type: version-update:semver-minor ... Signed-off-by: dependabot[bot] <support@github.com> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> * build(deps-dev): bump logger from 1.6.0 to 1.6.1 (#34536) Bumps [logger](https://github.com/ruby/logger) from 1.6.0 to 1.6.1. - [Release notes](https://github.com/ruby/logger/releases) - [Commits](https://github.com/ruby/logger/compare/v1.6.0...v1.6.1) --- updated-dependencies: - dependency-name: logger dependency-type: indirect update-type: version-update:semver-patch ... Signed-off-by: dependabot[bot] <support@github.com> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> * home connect: Add instructions for getting the client ID and secret (#34509) * home connect: Add instructions for getting the client ID and secret * Update home_connect.markdown * Update home_connect.markdown * tiny tweak --------- Co-authored-by: c0ffeeca7 <38767475+c0ffeeca7@users.noreply.github.com> * Document prerequisites for Webmin integration (#34515) * Update webmin.markdown Add details about prerequisites (installing XML::Parser), add additional context for user account creation, update phrasing of existing content * Minor tweaks for verbiage, proper markdown * Additional readability improvements for Webmin * Fix odd wording in Webmin account benefits "allows for" might imply that a separate account is automatically more secure; switching to "can allow for" to instead imply that things can be made more granular if desired. * Update source/_integrations/webmin.markdown Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com> * Tiny style tweaks --------- Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com> Co-authored-by: c0ffeeca7 <38767475+c0ffeeca7@users.noreply.github.com> * ubus.markdown: fix JSON syntax (#34522) * Update unifiprotect.markdown with information about event for doorbell (#34537) * Update unifiprotect.markdown with information about event for doorbell Add more information about the event entity when a doorbell is rang. * Tiny tweak --------- Co-authored-by: c0ffeeca7 <38767475+c0ffeeca7@users.noreply.github.com> * Add Enphase_envoy prerequisites (#34539) * Add Enphase_envoy prerequisites * Implement review suggestions Co-authored-by: c0ffeeca7 <38767475+c0ffeeca7@users.noreply.github.com> * Remove links to custom integrations --------- Co-authored-by: c0ffeeca7 <38767475+c0ffeeca7@users.noreply.github.com> * build(deps-dev): bump rubocop-ast from 1.32.1 to 1.32.2 (#34547) Bumps [rubocop-ast](https://github.com/rubocop/rubocop-ast) from 1.32.1 to 1.32.2. - [Release notes](https://github.com/rubocop/rubocop-ast/releases) - [Changelog](https://github.com/rubocop/rubocop-ast/blob/master/CHANGELOG.md) - [Commits](https://github.com/rubocop/rubocop-ast/compare/v1.32.1...v1.32.2) --- updated-dependencies: - dependency-name: rubocop-ast dependency-type: indirect update-type: version-update:semver-patch ... Signed-off-by: dependabot[bot] <support@github.com> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> * Enable entity (#34550) * Enable a single entity from device page * Add related topic * Add term ref * Add missing step * Add some background info why entities are disabled by default * Rephrase * Fix typo * Fix typo in google_translate (#34552) * New WWHA blog upload (#34551) * New WWHA blog upload * Update source/_posts/2024-09-03-aqara-joins-works-with-home-assistant.markdown --------- Co-authored-by: Gord <31004434+googanhiem@users.noreply.github.com> * Split august and yale integrations (#33890) * Add yale integration This PR should not merge until the integration branch in https://github.com/home-assistant/core/pull/122253 is complete * Update source/_integrations/yale.markdown * Tiny tweaks * Apply suggestions from code review * review comments * Apply suggestions from code review * Update source/_integrations/yale.markdown * Update source/_integrations/yale.markdown * Apply suggestions from code review * Update source/_integrations/yale.markdown --------- Co-authored-by: c0ffeeca7 <38767475+c0ffeeca7@users.noreply.github.com> * Simple Fin - Add Problem Sensor Documentation (#33979) * Adding the problems ensor * Tweaks --------- Co-authored-by: c0ffeeca7 <38767475+c0ffeeca7@users.noreply.github.com> * Redirect virtual integration yale_home to point to yale (#34482) * Remove Yale (Assa Abloy) devices from the august integration docs (#34484) * Remove Yale (Assa Abloy) devices from the august integration docs The new yale integration should be used for these devices instead * Remove Assa Abloy note since August is now owned by FBIN * Change entity badge display type to 3 booleans : name, state and icon (#34503) * Remove KNX free-online-training paragraph (#34531) * build(deps-dev): bump sorbet-runtime from 0.5.11553 to 0.5.11554 (#34561) Bumps [sorbet-runtime](https://github.com/sorbet/sorbet) from 0.5.11553 to 0.5.11554. - [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] <support@github.com> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> * build(deps): bump mustermann from 3.0.2 to 3.0.3 (#34562) Bumps [mustermann](https://github.com/sinatra/mustermann) from 3.0.2 to 3.0.3. - [Commits](https://github.com/sinatra/mustermann/compare/v3.0.2...v3.0.3) --- updated-dependencies: - dependency-name: mustermann dependency-type: indirect update-type: version-update:semver-patch ... Signed-off-by: dependabot[bot] <support@github.com> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> * build(deps-dev): bump rexml from 3.3.6 to 3.3.7 (#34563) Bumps [rexml](https://github.com/ruby/rexml) from 3.3.6 to 3.3.7. - [Release notes](https://github.com/ruby/rexml/releases) - [Changelog](https://github.com/ruby/rexml/blob/master/NEWS.md) - [Commits](https://github.com/ruby/rexml/compare/v3.3.6...v3.3.7) --- updated-dependencies: - dependency-name: rexml dependency-type: indirect update-type: version-update:semver-patch ... Signed-off-by: dependabot[bot] <support@github.com> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> * build(deps-dev): bump sass-embedded from 1.77.8 to 1.78.0 (#34564) Bumps [sass-embedded](https://github.com/sass-contrib/sass-embedded-host-ruby) from 1.77.8 to 1.78.0. - [Commits](https://github.com/sass-contrib/sass-embedded-host-ruby/compare/v1.77.8...v1.78.0) --- updated-dependencies: - dependency-name: sass-embedded dependency-type: indirect update-type: version-update:semver-minor ... Signed-off-by: dependabot[bot] <support@github.com> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> * Event docs and integration: add related links (#34569) * State trigger: rephrase (#34571) * State trigger: rephrase * Add intro text to example * Light: add section on states (#34573) * Update release notes for 2024.9 * Update 2024-09-04-release-20249.markdown * Update 2024-09-04-release-20249.markdown * Update 2024-09-04-release-20249.markdown * Update 2024-09-04-release-20249.markdown * update images * address comments * Update 2024-09-04-release-20249.markdown * Apply suggestions from code review Co-authored-by: c0ffeeca7 <38767475+c0ffeeca7@users.noreply.github.com> * Apply suggestions from code review Co-authored-by: c0ffeeca7 <38767475+c0ffeeca7@users.noreply.github.com> * suggestions * Apply suggestions from code review Co-authored-by: c0ffeeca7 <38767475+c0ffeeca7@users.noreply.github.com> --------- Signed-off-by: dependabot[bot] <support@github.com> Signed-off-by: Matthias Beyer <mail@beyermatthias.de> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> Co-authored-by: iomartin <iomartin@users.noreply.github.com> Co-authored-by: c0ffeeca7 <38767475+c0ffeeca7@users.noreply.github.com> Co-authored-by: Stuart Holland <soulc3@gmail.com> Co-authored-by: Matthias Beyer <mail@beyermatthias.de> Co-authored-by: mvn23 <schopdiedwaas@gmail.com> Co-authored-by: Max R <mxr@users.noreply.github.com> Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com> Co-authored-by: kylehakala <kylehakala@users.noreply.github.com> Co-authored-by: René Kliment <rene@renekliment.cz> Co-authored-by: darkrain-nl <24763370+darkrain-nl@users.noreply.github.com> Co-authored-by: Arie Catsman <120491684+catsmanac@users.noreply.github.com> Co-authored-by: Luca Angemi <luca.angemi@gmail.com> Co-authored-by: Joost Lekkerkerker <joostlek@outlook.com> Co-authored-by: Gord <31004434+googanhiem@users.noreply.github.com> Co-authored-by: J. Nick Koston <nick@koston.org> Co-authored-by: Jeef <jeeftor@users.noreply.github.com> Co-authored-by: Paul Bottein <paul.bottein@gmail.com> Co-authored-by: Matthias Alphart <farmio@alphart.net>
4
Gemfile
@ -10,8 +10,8 @@ group :development do
|
||||
gem 'stringex', '2.8.6'
|
||||
# > 2.1.0 causes slowdowns https://github.com/sass/sassc-ruby/issues/189
|
||||
gem 'sassc', '2.1.0'
|
||||
gem 'rubocop', '1.65.1'
|
||||
gem 'ruby-lsp', '0.17.16'
|
||||
gem 'rubocop', '1.66.0'
|
||||
gem 'ruby-lsp', '0.17.17'
|
||||
gem 'rackup', '2.1.0'
|
||||
end
|
||||
|
||||
|
44
Gemfile.lock
@ -26,9 +26,13 @@ GEM
|
||||
eventmachine (>= 0.12.9)
|
||||
http_parser.rb (~> 0)
|
||||
eventmachine (1.2.7)
|
||||
ffi (1.17.0-arm64-darwin)
|
||||
ffi (1.17.0-x86_64-linux-gnu)
|
||||
forwardable-extended (2.6.0)
|
||||
google-protobuf (4.27.4-x86_64-linux)
|
||||
google-protobuf (4.28.0-arm64-darwin)
|
||||
bigdecimal
|
||||
rake (>= 13)
|
||||
google-protobuf (4.28.0-x86_64-linux)
|
||||
bigdecimal
|
||||
rake (>= 13)
|
||||
http_parser.rb (0.8.0)
|
||||
@ -72,11 +76,13 @@ GEM
|
||||
listen (3.9.0)
|
||||
rb-fsevent (~> 0.10, >= 0.10.3)
|
||||
rb-inotify (~> 0.9, >= 0.9.10)
|
||||
logger (1.6.0)
|
||||
logger (1.6.1)
|
||||
mercenary (0.4.0)
|
||||
multi_json (1.15.0)
|
||||
mustermann (3.0.2)
|
||||
mustermann (3.0.3)
|
||||
ruby2_keywords (~> 0.0.1)
|
||||
nokogiri (1.16.7-arm64-darwin)
|
||||
racc (~> 1.4)
|
||||
nokogiri (1.16.7-x86_64-linux)
|
||||
racc (~> 1.4)
|
||||
parallel (1.26.3)
|
||||
@ -85,7 +91,7 @@ GEM
|
||||
racc
|
||||
pathutil (0.16.2)
|
||||
forwardable-extended (~> 2.6)
|
||||
prism (0.30.0)
|
||||
prism (1.0.0)
|
||||
public_suffix (6.0.1)
|
||||
racc (1.8.1)
|
||||
rack (3.1.7)
|
||||
@ -105,35 +111,37 @@ GEM
|
||||
rbs (3.5.3)
|
||||
logger
|
||||
regexp_parser (2.9.2)
|
||||
rexml (3.3.6)
|
||||
strscan
|
||||
rexml (3.3.7)
|
||||
rouge (4.3.0)
|
||||
rubocop (1.65.1)
|
||||
rubocop (1.66.0)
|
||||
json (~> 2.3)
|
||||
language_server-protocol (>= 3.17.0)
|
||||
parallel (~> 1.10)
|
||||
parser (>= 3.3.0.2)
|
||||
rainbow (>= 2.2.2, < 4.0)
|
||||
regexp_parser (>= 2.4, < 3.0)
|
||||
rexml (>= 3.2.5, < 4.0)
|
||||
rubocop-ast (>= 1.31.1, < 2.0)
|
||||
rubocop-ast (>= 1.32.1, < 2.0)
|
||||
ruby-progressbar (~> 1.7)
|
||||
unicode-display_width (>= 2.4.0, < 3.0)
|
||||
rubocop-ast (1.32.1)
|
||||
rubocop-ast (1.32.2)
|
||||
parser (>= 3.3.1.0)
|
||||
ruby-lsp (0.17.16)
|
||||
ruby-lsp (0.17.17)
|
||||
language_server-protocol (~> 3.17.0)
|
||||
prism (>= 0.29.0, < 0.31)
|
||||
prism (~> 1.0)
|
||||
rbs (>= 3, < 4)
|
||||
sorbet-runtime (>= 0.5.10782)
|
||||
ruby-progressbar (1.13.0)
|
||||
ruby2_keywords (0.0.5)
|
||||
safe_yaml (1.0.5)
|
||||
sass (3.4.25)
|
||||
sass-embedded (1.77.8-x86_64-linux-gnu)
|
||||
google-protobuf (~> 4.26)
|
||||
sass-embedded (1.78.0-arm64-darwin)
|
||||
google-protobuf (~> 4.27)
|
||||
sass-embedded (1.78.0-x86_64-linux-gnu)
|
||||
google-protobuf (~> 4.27)
|
||||
sass-globbing (1.1.5)
|
||||
sass (>= 3.1)
|
||||
sassc (2.1.0)
|
||||
ffi (~> 1.9)
|
||||
sassc (2.1.0-x86_64-linux)
|
||||
ffi (~> 1.9)
|
||||
sinatra (4.0.0)
|
||||
@ -142,9 +150,8 @@ GEM
|
||||
rack-protection (= 4.0.0)
|
||||
rack-session (>= 2.0.0, < 3)
|
||||
tilt (~> 2.0)
|
||||
sorbet-runtime (0.5.11549)
|
||||
sorbet-runtime (0.5.11554)
|
||||
stringex (2.8.6)
|
||||
strscan (3.1.0)
|
||||
terminal-table (3.0.2)
|
||||
unicode-display_width (>= 1.1.1, < 3)
|
||||
tilt (2.4.0)
|
||||
@ -156,6 +163,7 @@ GEM
|
||||
webrick (1.8.1)
|
||||
|
||||
PLATFORMS
|
||||
arm64-darwin-23
|
||||
x86_64-linux
|
||||
|
||||
DEPENDENCIES
|
||||
@ -168,8 +176,8 @@ DEPENDENCIES
|
||||
nokogiri (= 1.16.7)
|
||||
rackup (= 2.1.0)
|
||||
rake (= 13.2.1)
|
||||
rubocop (= 1.65.1)
|
||||
ruby-lsp (= 0.17.16)
|
||||
rubocop (= 1.66.0)
|
||||
ruby-lsp (= 0.17.17)
|
||||
sass-globbing (= 1.1.5)
|
||||
sassc (= 2.1.0)
|
||||
sinatra (= 4.0.0)
|
||||
|
@ -85,7 +85,7 @@ automation:
|
||||
|
||||
## Event trigger
|
||||
|
||||
Fires when an event is being received. Events are the raw building blocks of Home Assistant. You can match events on just the event name or also require specific event data or context to be present.
|
||||
Fires when an {% term event %} is being received. Events are the raw building blocks of Home Assistant. You can match events on just the event name or also require specific event data or context to be present.
|
||||
|
||||
Events can be fired by integrations or via the API. There is no limitation to the types. A list of built-in events can be found [here](/docs/configuration/events/).
|
||||
|
||||
@ -357,12 +357,22 @@ If for your use case this is undesired, you could consider using the automation
|
||||
|
||||
## State trigger
|
||||
|
||||
Fires when the state of any of given entities changes. If only `entity_id` is given, the trigger will fire for all state changes, even if only state attributes change.
|
||||
If at least one of `from`, `to`, `not_from`, or `not_to` are given, the trigger will fire on any matching state change, but not if only attributes change. To trigger on all state changes, but not on changed attributes, set at least one of `from`, `to`, `not_from`, or `not_to` to `null`.
|
||||
In general, the state trigger fires when the state of any of given entities **changes**. The behavior is as follows:
|
||||
|
||||
{% note %}
|
||||
The values you see in your overview will often not be the same as the actual state of the entity. For instance, the overview may show `Connected` when the underlying entity is actually `on`. You should check the state of the entity by looking in the _States_ menu under _Developer tools_.
|
||||
{% endnote %}
|
||||
- If only the `entity_id` is given, the trigger fires for **all** state changes, even if only a state attribute changed.
|
||||
- If at least one of `from`, `to`, `not_from`, or `not_to` are given, the trigger fires on any matching state change, but not if only an attribute changed.
|
||||
- To trigger on all state changes, but not on changed attributes, set at least one of `from`, `to`, `not_from`, or `not_to` to `null`.
|
||||
- Use of the `for` option doesn't survive a Home Assistant restart or the reload of automations.
|
||||
- During restart or reload, automations that were awaiting `for` the trigger to pass, are reset.
|
||||
- If for your use case this is undesired, you could consider using the automation to set an [`input_datetime`](/integrations/input_datetime) to the desired time and then use that [`input_datetime`](/integrations/input_datetime) as an automation trigger to perform the desired actions at the set time.
|
||||
|
||||
{% tip %}
|
||||
The values you see in your overview will often not be the same as the actual state of the entity. For instance, the overview may show `Connected` when the underlying entity is actually `on`. You should check the state of the entity by checking the states in the developer tool, under {% my developer_states title="**Developer Tools** > **States**" %}.
|
||||
{% endtip %}
|
||||
|
||||
### Examples
|
||||
|
||||
This automation triggers if either Paulus or Anne-Therese are home for one minute.
|
||||
|
||||
```yaml
|
||||
automation:
|
||||
@ -395,7 +405,7 @@ automation:
|
||||
to: "error"
|
||||
```
|
||||
|
||||
Trigger on all state changes, but not attributes by setting `to` to `null`:
|
||||
If you want to trigger on all state changes, but not on attribute changes, you can `to` to `null` (this would also work by setting `from`, `not_from`, or `not_to` to `null`):
|
||||
|
||||
```yaml
|
||||
automation:
|
||||
@ -405,7 +415,7 @@ automation:
|
||||
to:
|
||||
```
|
||||
|
||||
The `not_from` and `not_to` options are the counter parts of `from` and `to`. They can be used to trigger on state changes that are **not** the specified state. This can be useful to trigger on all state changes, except specific ones.
|
||||
If you want to trigger on all state changes *except* specific ones, use `not_from` or `not_to` The `not_from` and `not_to` options are the counter parts of `from` and `to`. They can be used to trigger on state changes that are **not** the specified state.
|
||||
|
||||
```yaml
|
||||
automation:
|
||||
@ -423,8 +433,8 @@ You cannot use `from` and `not_from` at the same time. The same applies to `to`
|
||||
### Triggering on attribute changes
|
||||
|
||||
When the `attribute` option is specified, the trigger only fires
|
||||
when the specified attribute changes. Changes to other attributes or the
|
||||
state are ignored.
|
||||
when the specified attribute **changes**. Changes to other attributes or
|
||||
state changes are ignored.
|
||||
|
||||
For example, this trigger only fires when the boiler has been heating for 10 minutes:
|
||||
|
||||
@ -465,8 +475,8 @@ automation:
|
||||
for: "00:00:30"
|
||||
```
|
||||
|
||||
Please note, that when holding a state, changes to attributes are ignored and
|
||||
do not cancel the hold time.
|
||||
When holding a state, changes to attributes are ignored. Changes to attributes
|
||||
don't cancel the hold time.
|
||||
|
||||
You can also fire the trigger when the state value changed from a specific
|
||||
state, but hasn't returned to that state value for the specified time.
|
||||
@ -528,12 +538,6 @@ The `for` template(s) will be evaluated when an entity changes as specified.
|
||||
Use quotes around your values for `from` and `to` to avoid the YAML parser from interpreting values as booleans.
|
||||
{% endtip %}
|
||||
|
||||
{% important %}
|
||||
Use of the `for` option will not survive Home Assistant restart or the reload of automations. During restart or reload, automations that were awaiting `for` the trigger to pass, are reset.
|
||||
|
||||
If for your use case this is undesired, you could consider using the automation to set an [`input_datetime`](/integrations/input_datetime) to the desired time and then use that [`input_datetime`](/integrations/input_datetime) as an automation trigger to perform the desired actions at the set time.
|
||||
{% endimportant %}
|
||||
|
||||
## Sun trigger
|
||||
|
||||
### Sunset / Sunrise trigger
|
||||
|
@ -1,6 +1,11 @@
|
||||
---
|
||||
title: "Events"
|
||||
description: "Describes all there is to know about events in Home Assistant."
|
||||
related:
|
||||
- docs: /docs/automation/trigger/#event-trigger
|
||||
title: Event triggers
|
||||
- docs: /integrations/event/
|
||||
title: Event integration
|
||||
---
|
||||
|
||||
The core of Home Assistant is the event bus. The event bus allows any integration to fire or listen for events. It is the core of everything.
|
||||
@ -29,7 +34,7 @@ In addition, all events contain a `data` dictionary with event-specific informat
|
||||
This event is fired when an service action is performed
|
||||
|
||||
| Field | Description |
|
||||
| ----------------- | ------------------------------------------------------------------------------ |
|
||||
| ----------------- | ---------------------------------------------------------------------- |
|
||||
| `domain` | Domain of the action. Example: `light`. |
|
||||
| `service` | The service action that is performed. Example: `turn_on` |
|
||||
| `service_data` | Dictionary with the call parameters. Example: `{ 'brightness': 120 }`. |
|
||||
@ -99,7 +104,7 @@ If you want to trigger automation on a Home Assistant stop event, we recommend u
|
||||
This event is fired when a new service action has been registered within Home Assistant.
|
||||
|
||||
| Field | Description |
|
||||
| --------- | ----------------------------------------------------------------------- |
|
||||
| --------- | ------------------------------------------------------------------------ |
|
||||
| `domain` | The domain of the integration that offers this action. Example: `light`. |
|
||||
| `service` | The name of the service action. Example: `turn_on` |
|
||||
|
||||
@ -108,7 +113,7 @@ This event is fired when a new service action has been registered within Home As
|
||||
This event is fired when a service action has been removed from Home Assistant.
|
||||
|
||||
| Field | Description |
|
||||
| --------- | ----------------------------------------------------------------------- |
|
||||
| --------- | ------------------------------------------------------------------------ |
|
||||
| `domain` | The domain of the integration that offers this action. Example: `light`. |
|
||||
| `service` | The name of the service action. Example: `turn_on` |
|
||||
|
||||
|
@ -47,20 +47,21 @@ 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).
|
||||
|
||||
1. Connect to the console of the Home Assistant server:
|
||||
- If you are using a virtual machine, connect to your virtual machine console.
|
||||
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:
|
||||
- [Using the serial console on Windows](https://yellow.home-assistant.io/guides/use-serial-console-windows/)
|
||||
- [Using the serial console on macOS / Linux](https://yellow.home-assistant.io/guides/use-serial-console-linux-macos/)
|
||||
- [Resetting the owner password on Home Assistant Yellow](https://yellow.home-assistant.io/faq/#i-forgot-the-owner-password-for-home-assistant-how-can-i-reset-it)
|
||||
- If you are using a Home Assistant Green, refer to the following procedure:
|
||||
- [Using the terminal](https://green.home-assistant.io/guides/use-terminal/)
|
||||
- If you are using another board, connect a keyboard and monitor to your device and access the terminal. The procedure is likely very similar to the one described for the Green in the step above.
|
||||
2. Once you have opened the Home Assistant command line, enter the following command:
|
||||
- [Resetting the owner password on Home Assistant Green](https://green.home-assistant.io/faq/#i-forgot-the-owner-password-for-the-home-assistant-green-how-can-i-reset-it)
|
||||
2. If you are not using a Yellow or Green: Connect to the console of the Home Assistant server:
|
||||
- If you are using a virtual machine, connect to your virtual machine console.
|
||||
- If you are using another board, connect a keyboard and monitor to your device and access the terminal. The procedure is likely very similar to the one described for the Home Assistant Green.
|
||||
3. Once you have opened the Home Assistant command line, enter the following command:
|
||||
- Note: `existing_user` is a placeholder. Replace it with your username.
|
||||
- Note: `new_password` is a placeholder. Replace it with your new password.
|
||||
- **Command**: `ha auth reset --username existing_user --password new_password`
|
||||
- **Command**: `auth reset --username existing_user --password new_password`
|
||||

|
||||
- **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.
|
||||
3. You can now log in to Home Assistant using this new password.
|
||||
4. You can now log in to Home Assistant using this new password.
|
||||
|
||||
### To reset a user's password, via the container command line
|
||||
|
||||
|
@ -1,6 +1,21 @@
|
||||
## Enabling or disabling elements
|
||||
## Enabling or disabling entities
|
||||
|
||||
Some entities are disabled by default. To enable them, follow these steps:
|
||||
Some {% term entities %} are disabled by default. Whether a particular entity of a device is disable or enabled by default, depends on the integration. Diagnostic entities for example are often disabled by default so that they don't clutter Home Assistant. For example, the RSSI entity (representing the RF signal strength) provided by the ZHA integration for each Zigbee device is disabled by default.
|
||||
|
||||
There are different ways to enable {% term entities %}. You can enable a single entity in the entity settings, or you can enable multiple entities at once from the list of entities.
|
||||
|
||||
### To enable or disable a single entity
|
||||
|
||||
1. Go to {% my integrations title="**Settings** > **Devices & services**" %} and select your integration card.
|
||||
2. Select the device.
|
||||
3. To see all the entities, you may need to expand the **entity not shown** section.
|
||||
4. Select the entity of interest, select the cogwheel {% icon "mdi:cog-outline" %}, then select the toggle for **Enable**.
|
||||
5. Select **Update**.
|
||||
6. Confirm the notification stating that it will take about 30 seconds for the entity to become enabled. Select **OK**.
|
||||
|
||||

|
||||
|
||||
### To enable or disable multiple entities
|
||||
|
||||
1. In Home Assistant, open the table of interest.
|
||||
- To enable or disable entities, go to {% my entities title="**Settings** > **Devices & Services** > **Entities**" %}.
|
||||
@ -12,5 +27,6 @@ Some entities are disabled by default. To enable them, follow these steps:
|
||||
|
||||
## Related topics
|
||||
|
||||
- [Customizing entities](/docs/configuration/customizing-devices/)
|
||||
- [Grouping your assets](/docs/organizing/)
|
||||
- [Working with tables](/docs/organizing/tables)
|
||||
|
@ -29,6 +29,8 @@ ha_integration_type: integration
|
||||
|
||||
The `august` integration allows you to integrate your [August](https://august.com/) and some Yale Access devices in Home Assistant.
|
||||
|
||||
For devices that use the [Yale Home](https://yalehome.com/global) app, the [Yale](/integrations/yale) integration should be used instead.
|
||||
|
||||
{% include integrations/config_flow.md %}
|
||||
|
||||
## Known working devices
|
||||
@ -43,10 +45,6 @@ The `august` integration allows you to integrate your [August](https://august.co
|
||||
| August View | no |
|
||||
| Yale Assure Lock | yes |
|
||||
| Yale Assure Lock 2 | yes |
|
||||
| Yale Conexis L1 | yes |
|
||||
| Yale Conexis L2 | yes |
|
||||
| Yale Doorman L3 | yes |
|
||||
| Yale Linus | yes |
|
||||
| Yale Smart Safe | yes |
|
||||
|
||||
Other devices not listed above have not been tested and may not function as expected.
|
||||
@ -124,8 +122,6 @@ If you have an August Keypad, once you have enabled the August integration, you
|
||||
|
||||
## Integration with Yale Access Bluetooth
|
||||
|
||||
Following Assa Abloy, Yale's parent company, purchasing August in 2017, most newer devices use the Yale Access branding.
|
||||
|
||||
The [Yale Access Bluetooth](/integrations/yalexs_ble) integration provides local control over Bluetooth of many Yale Access locks and some August locks that use the same system.
|
||||
|
||||
For locks that support the Yale Access system, the August integration can keep your offline access keys up to date to ensure you can operate your lock over Bluetooth. The following requirements must be met for the offline key updates to work:
|
||||
|
@ -18,3 +18,7 @@ ha_iot_class: Cloud Polling
|
||||
---
|
||||
|
||||
{% include integrations/supported_brand.md %}
|
||||
|
||||
## Limitations
|
||||
|
||||
Unlike other utilities that use the [{{ page.ha_supporting_integration }}](/integrations/{{ page.ha_supporting_domain }}) integration, {{ name }} only publishes monthly data.
|
||||
|
@ -23,7 +23,16 @@ ha_platforms:
|
||||
ha_integration_type: integration
|
||||
---
|
||||
|
||||
An integration for the [Enphase Envoy](https://enphase.com/en-us/products-and-services/envoy-and-combiner) solar energy gateway. This integration works with older models that only have production metrics (ie. Envoy-C) and newer models that offer both production and consumption metrics (ie. Envoy-S). Firmware version 3.9 or newer is required.
|
||||
An integration for the [Enphase Envoy](https://enphase.com/en-us/products-and-services/envoy-and-combiner) solar energy gateway. This integration works with older models that only have production metrics (ie. Envoy-C) and newer models that offer both production and consumption metrics (ie. Envoy-S).
|
||||
|
||||
## Prerequisites
|
||||
|
||||
- The Envoy must be configured and commissioned.
|
||||
- The Envoy must be on your local network with IPV4 connectivity from Home Assistant.
|
||||
- Envoy firmware version 3.9 or newer.
|
||||
- With Envoy firmware 7 and greater
|
||||
- an Enlighten cloud username and password.
|
||||
- Home Assistant 2023.9 or newer.
|
||||
|
||||
{% include integrations/config_flow.md %}
|
||||
|
||||
|
@ -10,6 +10,8 @@ ha_codeowners:
|
||||
- '@home-assistant/core'
|
||||
ha_integration_type: entity
|
||||
related:
|
||||
- docs: /docs/automation/trigger/#event-trigger
|
||||
title: Event triggers
|
||||
- docs: /docs/configuration/customizing-devices/
|
||||
title: Customizing devices
|
||||
- docs: /dashboards/
|
||||
|
@ -115,7 +115,7 @@ You can also use supported BCP 47 tags like the below or the 2-2 digit format fo
|
||||
|
||||
## Action speak
|
||||
|
||||
The `tts.speak` actiion is the modern way to use Google translate TTS action. Add the `speak` action, select the entity for your Google translate TTS (it's named for the language you created it with), select the media player entity or group to send the TTS audio to, and enter the message to speak.
|
||||
The `tts.speak` action is the modern way to use Google translate TTS action. Add the `speak` action, select the entity for your Google translate TTS (it's named for the language you created it with), select the media player entity or group to send the TTS audio to, and enter the message to speak.
|
||||
|
||||
For more options about `speak`, see the Speak section on the main [TTS](/integrations/tts/#action-speak) building block page.
|
||||
|
||||
|
@ -37,17 +37,20 @@ Note that it depends on the appliance and on API permissions which of the featur
|
||||
|
||||
1. Visit [https://developer.home-connect.com](https://developer.home-connect.com) and sign up for a developer account.
|
||||
2. Enter the email of your login for the original Home Connect App from Bosch/Siemens under "Default Home Connect User Account for Testing" in the sign up process.
|
||||
3. Under [Applications](https://developer.home-connect.com/applications), register a new App:
|
||||
3. Go to the [Applications](https://developer.home-connect.com/applications) page and select [Register Application](https://developer.home-connect.com/application/add):
|
||||
|
||||
- Application ID: Home Assistant (or whatever name makes sense to you)
|
||||
- OAuth Flow: Authorization Code Grant Flow
|
||||
- Redirect URI: `https://my.home-assistant.io/redirect/oauth`
|
||||
- Go to `https://my.home-assistant.io/` and make sure that your Home Assistant URL is set there. For example: `http://homeassistant:8123/` or `http://homeassistant.local:8123`
|
||||
|
||||
4. On success, you will be redirected to the **Applications** page. Select **Details** for your app. Make note of the client ID and secret - you will need it for the next step. Log out of the Home Connect developer portal.
|
||||
5. In Home Assistant, find the Home Connect integration and launch it. You will be prompted to create an [Application Credential](https://www.home-assistant.io/integrations/application_credentials). You will need to provide a name (it's arbitrary) in addition to the Client ID and Secret from the previous step. Then, follow the steps in the UI to complete setup.
|
||||
|
||||
*Important*:
|
||||
- **Power on** all your appliances during the integration configuration process; otherwise appliance programs list will be empty.
|
||||
- To update the appliance programs list, you can reload the Home Connect integration when an appliance is turned on. If the re-initialization process is not triggered by reload, restart the Home Assistant when an appliance is turned on.
|
||||
- After performing the steps above **log out** of your Home Connect Developer account. If you don't do this, the configuration steps below will fail during OAuth authentication with the message `“error”: “unauthorized_client”`.
|
||||
- After performing the steps above, [log out](https://developer.home-connect.com/user/logout) of your Home Connect Developer account. If you don't do this, the configuration steps below will fail during OAuth authentication with the message `“error”: “unauthorized_client”`.
|
||||
- The provided Home Connect User Account email address **must** be all lowercase otherwise it will result in authentication failures.
|
||||
- All changes in the developer portal take 15 minutes before the change is implemented.
|
||||
|
||||
|
@ -74,10 +74,6 @@ There is currently support for the following device types within Home Assistant:
|
||||
- [Time](#time)
|
||||
- [Weather](#weather)
|
||||
|
||||
## Free KNX online training
|
||||
|
||||
As a Home Assistant KNX user, you can start a FREE KNX online training and get a discounted ETS Home license on the [KNX website](https://www.knx.org/knx-en/for-your-home/home-assistant/).
|
||||
|
||||
{% include integrations/config_flow.md %}
|
||||
|
||||
## Basic configuration
|
||||
|
@ -15,7 +15,16 @@ This integration allows you to track and control various light bulbs. Read the i
|
||||
|
||||
{% include integrations/building_block_integration.md %}
|
||||
|
||||
### Default turn-on values
|
||||
## State and attributes of a light entity
|
||||
|
||||
Light {% term entities %} can have the following {% term states %}: `on` or `off`. The list of available attributes depends on the {% term device %}. Refer to the integration documentation of your light.
|
||||
|
||||
<p class='img'>
|
||||
<img src='/images/integrations/light/state_light.png' alt='Screenshot showing three lights with differents states: `on`, `off`, or `unavailable`'>
|
||||
Three lights with differents states: `on`, `off`, or `unavailable`.
|
||||
</p>
|
||||
|
||||
## Default turn-on values
|
||||
|
||||
To set the default color, brightness and transition values when the light is turned on, create a custom `light_profiles.csv`, normally located in the default configuration folder where you find {% term "`configuration.yaml`" %}.
|
||||
|
||||
@ -33,7 +42,7 @@ The `.default` suffix should be added to the entity identifier of each light to
|
||||
If a light entity is in the `on` state, the default profile brightness will only be applied if it is called in the action data attribute `profile`, like any other named profile. The transition attribute will be applied for all `light.turn_on`, `light.toggle`, and `light.turn_off` actions, unless specified otherwise in the action data.
|
||||
{% endnote %}
|
||||
|
||||
### Action `light.turn_on`
|
||||
## Action `light.turn_on`
|
||||
|
||||
Turns one light on or multiple lights on using [groups](/integrations/group/).
|
||||
|
||||
@ -101,7 +110,7 @@ automation:
|
||||
If no data is sent, and a default profile exists, the default profile will be applied.
|
||||
{% endnote %}
|
||||
|
||||
### Action `light.turn_off`
|
||||
## Action `light.turn_off`
|
||||
|
||||
Turns one or multiple lights off.
|
||||
|
||||
@ -111,7 +120,7 @@ Turns one or multiple lights off.
|
||||
| `transition` | yes | Integer that represents the time the light should take to transition to the new state in seconds. |
|
||||
| `flash` | yes | Tell light to flash, can be either value `short` or `long`. |
|
||||
|
||||
### Action `light.toggle`
|
||||
## Action `light.toggle`
|
||||
|
||||
Toggles the state of one or multiple lights. Takes the same arguments as the [`light.turn_on`](#action-lightturn_on) action.
|
||||
|
||||
|
@ -538,14 +538,14 @@ Possible modes and their meaning for the GPIO pins are listed here:
|
||||
Bulletpoints and numbers to match the LED mode layout below.
|
||||
{% endcomment %}
|
||||
|
||||
- 1\. No function, default for both ports on a freshly flashed chip.
|
||||
- 2\. Ground - A permanently low output (0V). Could be used for a power LED.
|
||||
- 3\. Vcc - A permanently high output (5V). Can be used as a short-proof power supply for some external circuitry used by the other GPIO port.
|
||||
- 4\. LED E - An additional LED if you want to present more than 4 LED functions.
|
||||
- 5\. LED F - An additional LED if you want to present more than 5 LED functions.
|
||||
- 6\. Home - Set thermostat to setback temperature when pulled low.
|
||||
- 7\. Away - Set thermostat to setback temperature when pulled high.
|
||||
- 8\. DS1820 (GPIO port B only) - Data line for a DS18S20 or DS18B20 temperature sensor used to measure the outside temperature. A 4k7 resistor should be connected between GPIO port B and Vcc.
|
||||
- 0\. Input - default for both ports on a freshly flashed chip.
|
||||
- 1\. Ground - A permanently low output (0V). Could be used for a power LED.
|
||||
- 2\. Vcc - A permanently high output (5V). Can be used as a short-proof power supply for some external circuitry used by the other GPIO port.
|
||||
- 3\. LED E - An additional LED if you want to present more than 4 LED functions.
|
||||
- 4\. LED F - An additional LED if you want to present more than 5 LED functions.
|
||||
- 5\. Home - Set thermostat to setback temperature when pulled low.
|
||||
- 6\. Away - Set thermostat to setback temperature when pulled high.
|
||||
- 7\. DS1820 (GPIO port B only) - Data line for a DS18S20 or DS18B20 temperature sensor used to measure the outside temperature. A 4k7 resistor should be connected between GPIO port B and Vcc.
|
||||
|
||||
## LED modes
|
||||
|
||||
|
@ -32,5 +32,6 @@ Each `account` will be set up as a device in Home Assistant, and it will contain
|
||||
|
||||
|Sensor|Description|
|
||||
|-------|---------------|
|
||||
|Balance|Account balance|
|
||||
|Age| This sensor shows when the data was retrieved by the SimpleFin API |
|
||||
|Balance|Account balance|
|
||||
|Problem| Binary sensor that indicates whether the account sync may have a problem |
|
||||
|
@ -289,7 +289,7 @@ spaceapi:
|
||||
issue_report_channels:
|
||||
- email
|
||||
state:
|
||||
entity_id: binary_sensor.front_door"
|
||||
entity_id: "binary_sensor.front_door"
|
||||
icon_open: https://eastermundigen.ch/open.png
|
||||
icon_closed: https://eastermundigen.ch/close.png
|
||||
sensors:
|
||||
|
@ -49,7 +49,7 @@ Then, create an ACL file at `/usr/share/rpcd/acl.d/hass.json` for the user `hass
|
||||
"ubus": {
|
||||
"hostapd.*": ["get_clients"],
|
||||
"uci": ["get"]
|
||||
},
|
||||
}
|
||||
},
|
||||
"write": {}
|
||||
}
|
||||
|
@ -269,6 +269,8 @@ These URLs work great when trying to send notifications. Home Assistant will aut
|
||||
|
||||
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.
|
||||
|
||||
When a Doorbell rings, there is a specific event {% term entity %} that provides the `event_id`. You can use this to get the thumbnail, for example, `event.g4_doorbell_pro_doorbell`.
|
||||
|
||||
## Troubleshooting
|
||||
|
||||
### Delay in video feed
|
||||
|
@ -21,19 +21,50 @@ This {% term integration %} provides sensors for monitoring the CPU and memory u
|
||||
|
||||
## Prerequisites
|
||||
|
||||
For best security, create a specific Webmin user for Home Assistant with a strong password and only "Can accept RPC calls" permission (under "Permissions for all modules") and remove the "Can accept RPC calls" permission for all other users.
|
||||
### Authentication setup
|
||||
|
||||
{% warning %}
|
||||
Always consider your own setup and security needs before exposing services with system-level access.
|
||||
{% endwarning %}
|
||||
|
||||
As a good security practice, create a Webmin User specific to Home Assistant. A dedicated account allows for this integration to operate uninterrupted should you change your primary login for Webmin, and it can allow for more granular access so that only the necessary data and access is made available to Home Assistant.
|
||||
|
||||
#### Suggested User Setup
|
||||
|
||||
- Create the account with a strong password,
|
||||
- Only enable the _"Can accept RPC calls"_ permission (under "Permissions for all modules"),
|
||||
- Consider disabling the _"Can accept RPC calls"_ permission for other users (unless specifically required),
|
||||
- Consider limiting this account to only have access via the IP address of your Home Assistant instance (if appropriate).
|
||||
-
|
||||
|
||||
{% note %}
|
||||
Be aware that the Webmin API ignores any 2FA set up via the frontend, e.g. it is even with enabled 2FA possible to use the API with only username and password.
|
||||
The Webmin API ignores any 2FA set up via the frontend. Even with 2FA enabled, it is still possible to use the API with only a username and password.
|
||||
{% endnote %}
|
||||
|
||||
### Required Webmin Perl Module
|
||||
|
||||
Ensure the `XML::Parser` Perl module is installed via [Webmin Perl Modules](https://webmin.com/docs/modules/perl-modules/) before configuring the integration.
|
||||
|
||||
#### Installing XML::Parser Perl Module
|
||||
|
||||
1. In the Webmin UI, go to **Tools** > **Perl Modules**.
|
||||
2. Under the **Install module** tab, enter `XML::Parser` into the **From CPAN** text field.
|
||||
3. Select **Install** at the bottom of the dialog.
|
||||
4. Confirm that the installation is successful.
|
||||
- If the installation succeeds:
|
||||
- Continue with any remaining steps for Home Assistant.
|
||||
- If the installation fails:
|
||||
- Refer to [Webmin documentation for Perl Modules](https://webmin.com/docs/modules/perl-modules/) to resolve any Webmin issues.
|
||||
- Retry the module installation and confirm that `XML::Parser` is listed on the Perl Modules page under **Existing Modules**.
|
||||
{% include integrations/config_flow.md %}
|
||||
|
||||
## Sensors
|
||||
|
||||
**All entities are disabled by default, you need to enable the entities that you wish to use.**
|
||||
{% note %}
|
||||
All entities are **disabled** by default. You must enable any entities that you wish to use.
|
||||
{% endnote %}
|
||||
|
||||
Following sensors will be added:
|
||||
The following sensors are provided:
|
||||
|
||||
- Load (1m)
|
||||
- Load (5m)
|
||||
|
156
source/_integrations/yale.markdown
Normal file
@ -0,0 +1,156 @@
|
||||
---
|
||||
title: Yale
|
||||
description: Instructions on how to integrate your Yale devices into Home Assistant.
|
||||
ha_category:
|
||||
- Binary sensor
|
||||
- Button
|
||||
- Camera
|
||||
- Doorbell
|
||||
- Event
|
||||
- Lock
|
||||
- Sensor
|
||||
ha_release: 2024.9
|
||||
ha_iot_class: Cloud Push
|
||||
ha_config_flow: true
|
||||
ha_codeowners:
|
||||
- '@bdraco'
|
||||
ha_domain: yale
|
||||
ha_dhcp: true
|
||||
ha_platforms:
|
||||
- binary_sensor
|
||||
- button
|
||||
- camera
|
||||
- diagnostics
|
||||
- event
|
||||
- lock
|
||||
- sensor
|
||||
ha_integration_type: integration
|
||||
---
|
||||
|
||||
The **Yale** integration allows you to integrate your [Yale](https://www.assaabloy.com/vn/en/solutions/products/yale) devices in Home Assistant.
|
||||
|
||||
The login credentials used to authenticate the integration are the same as the ones used in the Yale Home app.
|
||||
|
||||
{% include integrations/config_flow.md %}
|
||||
|
||||
## Known working devices
|
||||
|
||||
| Device | Requires [Connect Bridge](https://www.yalehome.com/vn/en/products/yale-smart-door-lock/smart-accessories/yale-connect-wi-fi-bridge) or Doorbell |
|
||||
| --------------------------------- | ------------------------------------|
|
||||
| Yale Assure Lock | yes |
|
||||
| Yale Conexis L1 | yes |
|
||||
| Yale Conexis L2 | yes |
|
||||
| Yale Doorman L3 | yes |
|
||||
| Yale Linus | yes |
|
||||
| Yale Smart Safe | yes |
|
||||
|
||||
Other devices not listed above have not been tested and may not function as expected.
|
||||
|
||||
There is currently support for the following device types within Home Assistant:
|
||||
|
||||
- Doorbell
|
||||
- Binary sensor
|
||||
- Button
|
||||
- Sensor
|
||||
- Camera
|
||||
- Lock
|
||||
|
||||
{% note %}
|
||||
Most devices will need either a Yale Connect Bridge or a Doorbell to connect to Home Assistant.
|
||||
{% endnote %}
|
||||
|
||||
## Push updates not available for some entities
|
||||
|
||||
While most entities can be updated via the push API, Yale/Yale does not offer a push API for some data, which means these entities will update slower:
|
||||
|
||||
- Doorbell ding sensor (Doorman models only)
|
||||
- Lock Battery sensor
|
||||
- Lock Operation sensor
|
||||
|
||||
## Binary sensor
|
||||
|
||||
If you have a Yale Doorbell, once you have enabled the Yale integration, you should see the following sensors:
|
||||
|
||||
- Doorbell ding sensor
|
||||
- Doorbell motion sensor
|
||||
- Doorbell online sensor
|
||||
|
||||
If you have a Yale Smart Lock with DoorSense, once you have enabled the Yale integration, you should see the following sensors:
|
||||
|
||||
- Door sensor
|
||||
|
||||
## Button
|
||||
|
||||
Buttons are created to wake locks from a deep sleep. If your lock is not reporting a status, it may be in a deep sleep, and the button can be used to wake it. Locks are not automatically woken from deep sleep to preserve battery life.
|
||||
|
||||
## Event
|
||||
|
||||
If you have a Yale doorbell or lock that has a built-in doorbell, once you have enabled the Yale integration, you should see the following event entities:
|
||||
|
||||
- Doorbell
|
||||
- Motion
|
||||
|
||||
Not all models include motion sensors and support for locks with built-in doorbells is limited to Yale Doorman models type 7 and 10.
|
||||
|
||||
## 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.
|
||||
|
||||
## Sensor
|
||||
|
||||
If you have a Yale Doorbell with a battery, once you have enabled the Yale integration, you should see the following sensors:
|
||||
|
||||
- Doorbell Battery
|
||||
|
||||
If you have a Yale Smart Lock, once you have enabled the Yale integration, you should see the following sensors:
|
||||
|
||||
- Lock Battery
|
||||
- Lock Operation
|
||||
|
||||
If you have a Yale Keypad, once you have enabled the Yale integration, you should see the following sensors:
|
||||
|
||||
- Keypad Battery
|
||||
|
||||
## Integration with Yale Access Bluetooth
|
||||
|
||||
Following Assa Abloy, Yale's parent company, purchasing Yale in 2017, most newer devices use the Yale Home branding.
|
||||
|
||||
The [Yale Access Bluetooth](/integrations/yalexs_ble) integration provides local control over Bluetooth of many Yale Home locks that use the same system.
|
||||
|
||||
For locks that support the Yale Access system, the Yale integration can keep your offline access keys up to date to ensure you can operate your lock over Bluetooth. The following requirements must be met for the offline key updates to work:
|
||||
|
||||
- The Yale integration must support the lock.
|
||||
- The [Yale Access Bluetooth integration](/integrations/yalexs_ble) must support the lock.
|
||||
- The Bluetooth integration must be active and functional.
|
||||
- The lock must be discoverable by the [Yale Access Bluetooth integration](/integrations/yalexs_ble).
|
||||
- The account logged in with the Yale integration must have the offline keys.
|
||||
|
||||
### Troubleshooting offline key updates
|
||||
|
||||
- If you do not know which account has the offline keys, configure Yale 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
|
||||
|
||||
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 Yale locks or unlocks the door either 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 Yale.
|
||||
|
||||
{% raw %}
|
||||
|
||||
```yaml
|
||||
- id: "1583706446906"
|
||||
alias: "joe_doe_front_door_operate"
|
||||
description: John Doe locks or unlocks the Front Door
|
||||
trigger:
|
||||
- entity_id: sensor.front_door_operator
|
||||
platform: state
|
||||
to: John Doe
|
||||
condition:
|
||||
- condition: template
|
||||
value_template: "{{ not state_attr('sensor.front_door_operator', 'remote') }}"
|
||||
action:
|
||||
- data: {}
|
||||
entity_id: camera.inside
|
||||
service: camera.turn_off
|
||||
```
|
||||
|
||||
{% endraw %}
|
@ -1,6 +1,6 @@
|
||||
---
|
||||
title: Yale Home
|
||||
description: Connect and control your Yale Home devices using the August integration
|
||||
description: Connect and control your Yale Home devices using the Yale integration
|
||||
ha_category:
|
||||
- Binary sensor
|
||||
- Button
|
||||
@ -12,8 +12,8 @@ ha_category:
|
||||
ha_release: 0.64
|
||||
ha_domain: yale_home
|
||||
ha_integration_type: virtual
|
||||
ha_supporting_domain: august
|
||||
ha_supporting_integration: August
|
||||
ha_supporting_domain: yale
|
||||
ha_supporting_integration: Yale
|
||||
ha_codeowners:
|
||||
- '@bdraco'
|
||||
ha_config_flow: true
|
||||
|
@ -0,0 +1,46 @@
|
||||
---
|
||||
layout: post
|
||||
title: "Aqara joins Works with Home Assistant"
|
||||
description: "We have certified 4 Aqara devices, all of which are the first to use our Works via Matter with Home Assistant badge."
|
||||
date: 2024-09-03 00:00:01
|
||||
date_formatted: "September 3, 2024"
|
||||
author: Guy Sie
|
||||
comments: true
|
||||
categories: Announcements
|
||||
og_image: /images/blog/2024-09-aqara-wwha/art.jpg
|
||||
---
|
||||
<img src='/images/blog/2024-09-aqara-wwha/art.jpg' style='border: 0;box-shadow: none;' alt="Aqara joins Works with Home Assistant">
|
||||
|
||||
We're excited to announce that Aqara is bringing several of their devices to our [Works with Home Assistant](https://partner.home-assistant.io/) program. We know that Aqara is a brand that many in the community like to recommend for its solid options for Zigbee and Matter.
|
||||
|
||||
This will be the first partner to join since [our recent update to the program](/blog/2024/08/08/works-with-home-assistant-becomes-part-ohf/), meaning it is the first to join certifying specific devices, making it much easier to see what will give you the best experience in Home Assistant. It will also be the first partner to use our "Works via Matter with Home Assistant" badge, giving some great options to use with Home Assistant's [industry-leading Matter support](https://www.matteralpha.com/news/new-home-assistant-update-matter-1-3-ai-automation).
|
||||
|
||||
<!--more-->
|
||||
|
||||
## Matter materializes
|
||||
|
||||
Aqara has been an early adopter of Matter, and many of its new products support the standard, which is great for [connecting to Home Assistant](/blog/2024/01/25/matter-livestream-blog/). Matter allows for local control by directly connecting devices to Home Assistant, keeping your smart home data in your home. Matter is a completely local IP-based protocol that leverages your existing Ethernet and Wi-Fi networks, but it can also use [Thread](/integrations/thread/), which many Aqara devices take advantage of. Thread devices can be directly connected to Home Assistant using a [Connect ZBT-1](/connectzbt1), or can be connected to Home Assistant via an existing hub (Thread Border Router) you may already have from another [smart home ecosystem](/integrations/thread#google), including the Aqara Hub M3.
|
||||
|
||||
One superpower of Matter compared to other standards is being able to control these devices with multiple different ecosystems simultaneously. For instance, an Aqara lock could be unlocked with a Home Assistant automation and then locked with a voice command directed to an Apple Homepod.
|
||||
|
||||
## Devices joining the program
|
||||
|
||||
Aqara has had the following three devices Works with Home Assistant certified. All of which can be directly connected to Home Assistant without an account.
|
||||
|
||||
- [Motion and Light Sensor P2](https://www.aqara.com/en/product/motion-and-light-sensor-p2/) - Matter over Thread battery-powered motion and lux sensor.
|
||||
|
||||
- [Door and Window Sensor P2](https://www.aqara.com/en/product/door-and-window-sensor-p2/) - Matter over Thread battery-powered cover sensor.
|
||||
|
||||
- [Smart Lock U200](https://www.aqara.com/en/product/smart-lock-u200/) - Matter over Thread battery-powered lock.
|
||||
|
||||
We're also testing the yet-to-be-launched Smart Lock U300, which we hope to see added soon.
|
||||
|
||||
We have also certified a hub that makes it easy to connect an existing Aqara-based smart home to Home Assistant using Matter.
|
||||
|
||||
- [Hub M3](https://www.aqara.com/en/product/hub-m3/) - It has many functions, but we have certified it as a Matter Bridge. This means you can use it to bridge your existing Aqara Zigbee devices to Matter. It can also act as a Thread Border Router for Home Assistant.
|
||||
|
||||
If you have some Aqara products that are not listed above, rest assured that they will continue to work as they always have. The program is a way to clearly indicate which devices provide the best experience with Home Assistant. We've ensured this by testing these devices' compatibility ourselves. We also get assurances from the brand that they will provide responsive support and maintenance, while being a positive brand in the Home Assistant community.
|
||||
|
||||
Works with Home Assistant is now run by the non-profit [Open Home Foundation](https://www.openhomefoundation.org/), which means it is not a profit-making endeavor. It is about encouraging brands to go above and beyond in the Home Assistant community, and we're excited to have Aqara join.
|
||||
|
||||
When shopping for devices to connect to your home, we recommend first looking at our Works with Home Assistant partner's products. These products always prioritize long-term support and local control.
|
@ -1,8 +1,8 @@
|
||||
---
|
||||
layout: post
|
||||
title: "2024.9: Beta release notes"
|
||||
description: "Beta release notes for Home Assistant 2024.9"
|
||||
date: 2024-08-28 00:00:00
|
||||
title: "2024.9: Sections go BIG"
|
||||
description: "Bigger wider sections for big cards, smarter energy monitoring, a new LLM option, Works with Home Assistant Matter devices, and more open source."
|
||||
date: 2024-09-04 00:00:00
|
||||
date_formatted: "September 4, 2024"
|
||||
author: Gordon Cameron
|
||||
comments: true
|
||||
@ -14,75 +14,31 @@ og_image: /images/blog/2024-09/social.jpg
|
||||
|
||||
<lite-youtube videoid="dSbCzRhbOVA" videotitle="Home Assistant 2024.9 Release Party"></lite-youtube>
|
||||
|
||||
{% note %}
|
||||
Home Assistant 2024.9! 🎉
|
||||
|
||||
**Welcome to the beta release notes for Home Assistant 2024.9** 🎉
|
||||
Many community members based in the northern hemisphere have taken advantage of the nicer weather to take a little time off. Home Assistant releases have continued to grow for some time, and this one might not be as gargantuan in size as previous releases, but it still packs some really cool features and announcements.
|
||||
|
||||
<br />
|
||||
This release includes bigger sections, smarter energy monitoring, and a new LLM option. We've added [five](#new-integrations) new integrations, along with [one](#now-available-to-set-up-from-the-ui) existing integration being added to the UI. On top of all that, we've announced a new Works with Home Assistant partner, and the culmination of a project to ensure our project is truly open source.
|
||||
|
||||
Please note that these release notes are a work in progress. 👷♀️ We will be
|
||||
completing them over the next couple of days. Not all features might be final
|
||||
yet, and some features _**may not** make it into the final release_.
|
||||
We hope you've been able to enjoy some time in, and away, from your smart home this month as well.
|
||||
|
||||
<br />
|
||||
|
||||
**Want to help test the beta?** Awesome! ❤️ We have documented how you
|
||||
[can join our beta channel and install the beta here](/common-tasks/os/#running-a-beta-version).
|
||||
|
||||
<br />
|
||||
|
||||
While running the beta, we highly recommend joining our _#beta_ channel on
|
||||
the [Home Assistant Discord chat](/join-chat)! 💬 Most developers and beta
|
||||
testers are in this channel during the beta period to share experiences, ideas,
|
||||
and iterate over new features, fine-tuning them before the final release.
|
||||
It's a really fun place to hang out. 😎
|
||||
|
||||
<br />
|
||||
|
||||
**Reporting issues**: As this is a beta test, you might encounter unexpected
|
||||
behavior or issues. 🐞 We use the GitHub issue tracker to track beta issues.
|
||||
You can find our issue trackers and the reported issues during beta here:
|
||||
|
||||
<br />
|
||||
|
||||
- [Report(ed) beta **dashboards/UI/frontend** issues](https://github.com/home-assistant/frontend/milestone/123)
|
||||
- [Report(ed) beta **integrations/automations/backend/core** issues](https://github.com/home-assistant/core/milestone/686)
|
||||
- [Report(ed) beta **documentation** issues](https://github.com/home-assistant/home-assistant.io/milestone/130)
|
||||
|
||||
🙏 When reporting issues, **make sure to mention the exact beta version you are
|
||||
running** in the issue description. This will help us identify and track the
|
||||
issue correctly. Read more about [reporting issues here](/help/reporting_issues/).
|
||||
|
||||
<br />
|
||||
|
||||
Issues introduced in the beta are processed with priority. 🔝
|
||||
|
||||
{% endnote %}
|
||||
Enjoy the release!
|
||||
|
||||
{% tip %}
|
||||
|
||||
Don't forget to [join our release party live stream on YouTube](https://www.youtube.com/watch?v=X)
|
||||
Don't forget to [join our release party live stream on YouTube](https://www.youtube.com/watch?v=dSbCzRhbOVA)
|
||||
4 September 2024, at 20:00 GMT / 12:00 PST / 21:00 CEST!
|
||||
|
||||
{% endtip %}
|
||||
|
||||
Home Assistant 2024.9! 🎉
|
||||
|
||||
For many of us in the community based in the northern hemisphere we've been taking advantage of the nicer weather to take a little time off. Home Assistant releases have continued to grow for some time, and this one might not be as gargantuan in size as previous releases, but it still packs some really cool features and announcements.
|
||||
|
||||
This release includes bigger sections, smarter energy monitoring, and a new LLM option. We’ve added [five](#new-integrations) new integrations, along with [one](#now-available-to-set-up-from-the-ui) existing integration being added to the UI. On top of all that, we’ve announced a new Works with Home Assistant partner, and the culmination of a project to ensure our project is truly open source.
|
||||
|
||||
We hope you've been able to enjoy some time in, and away, from your smart home this month as well.
|
||||
|
||||
Enjoy the (beta) release!
|
||||
|
||||
<!--more-->
|
||||
|
||||
- [Sections go BIG](#sections-go-big)
|
||||
- [Wider sections](#wider-sections)
|
||||
- [Full span cards](#full-span-cards)
|
||||
- [Badges](#badges)
|
||||
- [Tracking your untracked energy](#tracking-your-untracked-energy)
|
||||
- [LLM agent options grow](#llm-agent-options-grow)
|
||||
- [Aqara joins Works with Home Assistant](#aqara-joins-works-with-home-assistant)
|
||||
- [Open source compliance](#open-source-compliance)
|
||||
- [Integrations](#integrations)
|
||||
- [New integrations](#new-integrations)
|
||||
@ -98,7 +54,10 @@ Enjoy the (beta) release!
|
||||
|
||||
In the drive to give our users more customization and organization options for their dashboards, we've added some new options to our Sections view that really lets us take big advantage of [resizable cards](/blog/2024/07/03/release-20247/#resize-the-cards-on-your-dashboard). These powerful customization features can affect the [predictability of where cards or sections will go](/blog/2024/03/04/dashboard-chapter-1/#drag-and-drop-rearrangement-of-cards-and-sections), especially when switching between desktop and mobile views, and we have found it works best with large cards. As always, the choice of how to use it is up to you.
|
||||
|
||||
<img src="/images/blog/2024-09/sections-go-big.png" alt="Temporary screenshot">
|
||||
<div style="display: flex;">
|
||||
<img src="/images/blog/2024-09/sections-before.png" width="50%" alt="Screenshot showing sections that are all 1 section wide, on the right showing a section that is 2 sections wide.">
|
||||
<img src="/images/blog/2024-09/sections-after.png" width="50%" alt="Screenshots showing a section that is 2 sections wide.">
|
||||
</div>
|
||||
|
||||
### Wider sections
|
||||
|
||||
@ -108,15 +67,23 @@ Cards and sections will continue to follow the [Z-Grid rules](/blog/2024/03/04/d
|
||||
|
||||
When switching to smaller screens, these larger sections will revert to one section wide (if this causes issues for certain big cards, we would recommend using our device [visibility settings](/blog/2024/06/05/release-20246/#control-visibility-of-cards)).
|
||||
|
||||
<img src="/images/blog/2024-09/section-settings.png" alt="Screenshot of the section settings">
|
||||
|
||||
### Full span cards
|
||||
|
||||
Larger sections mean larger cards. Instead of just stretching out the layout of a card, there is also a new option on cards to have them always use the full width of the section.
|
||||
|
||||
### Badges
|
||||
|
||||
Talking about dashboards, the newly styled badges we [introduced](/blog/2024/08/07/release-20248/#new-badges-for-your-dashboard) in last release, are now more configurable.
|
||||
|
||||
Instead of using display mode, you can decide for yourself what element you want to show. This allows you, for example, to hide the icon of an badge and only show the state of the device you want to show in your badge.
|
||||
|
||||
## Tracking your untracked energy
|
||||
|
||||
In April, we introduced a [new energy graph for individual devices](/blog/2024/03/06/release-20243/#new-energy-graph-for-individual-devices) in our energy dashboard. This allows you to aggregate all your energy monitoring into one graph, giving you a quick way to see your house's biggest energy-using devices. Big thanks to [@karwosts](https://github.com/karwosts), the original creator of this graph, who has now updated it.
|
||||
|
||||
<img src="/images/blog/2024-09/untracked-energy.png" alt="Temporary screenshot">
|
||||
<img src="/images/blog/2024-09/untracked-energy.png" alt="Screenshot of the individual device energy graph">
|
||||
|
||||
We can't all have energy tracking for every device, and if you have whole-home energy tracking (like a smart meter or [something more DIY](/home-energy-management)) the updated graph will calculate the difference and show your home's untracked usage. So hop onto your [energy dashboard](https://my.home-assistant.io/redirect/energy/) and start to tackle your phantom energy load.
|
||||
|
||||
@ -124,11 +91,23 @@ We can't all have energy tracking for every device, and if you have whole-home e
|
||||
|
||||
When we added the ability to use [Large Language Models (LLMs)](/blog/2024/06/05/release-20246/#dipping-our-toes-in-the-world-of-ai-using-llms) in our Voice Assistant, it began with a limited number of conversation agents. These included the cloud-based [OpenAI](/components/openai_conversation/) and [Google AI](/components/google_generative_ai_conversation/) integrations, along with the locally-run [Ollama](/integrations/ollama/) integration. All three can now control the devices in your home.
|
||||
|
||||
[@Shulyaka](https://github.com/Shulyaka) has now added another cloud option with [Anthropic](/integrations/anthropic) - thanks again for giving us another option for experimenting with AI in Home Assistant. Setting it up can be a little different than other conversation agents so take a look at the [documents](/integrations/anthropic) if you're interested.
|
||||
[@Shulyaka](https://github.com/Shulyaka) has now added another cloud option with [Anthropic](/integrations/anthropic) - thanks again for giving us another option for experimenting with AI in Home Assistant. Setting it up can be a little different than other conversation agents, so take a look at the [documentation](/integrations/anthropic).
|
||||
|
||||
We have updated our [LLM leaderboard](https://github.com/allenporter/home-assistant-datasets/tree/main/reports) to include Anthropic. Both Claude 3 Haiku and Claude 3 Sonnet score very high on our benchmarks and now rank among the top. Based on the results of the benchmark, we have set the cheaper Claude 3 Haiku as the default model for the Anthropic integration.
|
||||
|
||||
[@allenporter] added the ability to configure the context window size of the [Ollama](/integrations/ollama) integration. The default size was increased, making it perform 20% better!
|
||||
|
||||
## Aqara joins Works with Home Assistant
|
||||
|
||||
<img src="/images/blog/2024-09-aqara-wwha/art.jpg" alt="Aqara join Works via Matter with Home Assistant">
|
||||
|
||||
We [recently announced](/blog/2024/09/03/aqara-joins-works-with-home-assistant/) that four Aqara devices are joining our [Works with Home Assistant](https://partner.home-assistant.io/) program. What's really exciting is that these are all Matter devices, and Aqara will be the first partner to use our "Works via Matter with Home Assistant" badge, giving some great options to use with Home Assistant's amazing Matter integration.
|
||||
|
||||
What's more, this will be the first partner to join since [our recent update to the program](/blog/2024/08/08/works-with-home-assistant-becomes-part-ohf/), meaning device-by-device certification that we tested ourselves. This makes it really easy to see what will give you the best experience in Home Assistant.
|
||||
|
||||
## Open source compliance
|
||||
|
||||
We have put a lot of work into making sure that Home Assistance is truly open source, from top to bottom. This means ensuring that every library our integrations rely on uses the compliant license. We're now at more than 2,800 integrations, so as you can imagine, this was not a small task. Working with code owners and library developers, we have painstakingly checked that every library is now using an [OSI-approved license](https://opensource.org/license).
|
||||
We have put a lot of work into making sure that Home Assistant is truly open source, from top to bottom. This means ensuring that every library our integrations rely on uses the compliant license. We're now at more than 2,800 integrations, so as you can imagine, this was not a small task. Working with code owners and library developers, we have painstakingly checked that every library is now using an [OSI-approved license](https://opensource.org/license).
|
||||
|
||||
This might seem like a small procedural thing, but it is critical to keep integrations and Home Assistant functional far into the future. If you're not aware, libraries are what many device and service integrations rely on to function, by calling in additional protocol specific code that [purposely](https://developers.home-assistant.io/docs/api_lib_index/) sits outside of the Home Assistant project. If an individual or corporation can no longer maintain libraries, a proper open source license allows it to be picked up and continued by others.
|
||||
|
||||
@ -151,6 +130,8 @@ We welcome the following new integrations in this release:
|
||||
Manage SMLIGHT SLZB-06 adaptors from Home Assistant.
|
||||
- **[Roth Touchline SL]**, added by [@jnsgruk]<br>
|
||||
A new integration for the Roth Touchline SL underfloor heating system.
|
||||
- **[Yale]**, added by [@bdraco]<br>
|
||||
The Yale Home brand now has its own integration and will no longer be using the [August] integration. If you use a Yale Home device with the August integration, you should migrate to the new Yale integration.
|
||||
|
||||
[Anthropic Conversation]: /integrations/anthropic
|
||||
[Anthropic]: https://anthropic.com/
|
||||
@ -160,12 +141,15 @@ We welcome the following new integrations in this release:
|
||||
[Fujitsu FGLair]: /integrations/fujitsu_fglair
|
||||
[SMLIGHT]: /integrations/smlight
|
||||
[Roth Touchline SL]: /integrations/touchline_sl
|
||||
[Yale]: /integrations/yale
|
||||
[August]: /integrations/august
|
||||
|
||||
[@Shulyaka]: https://github.com/Shulyaka
|
||||
[@IceBotYT]: https://github.com/IceBotYT
|
||||
[@crevetor]: https://github.com/crevetor
|
||||
[@tl-sl]: https://github.com/tl-sl
|
||||
[@jnsgruk]: https://github.com/jnsgruk
|
||||
[@bdraco]: https://github.com/bdraco
|
||||
|
||||
This release also has a new virtual integration. Virtual integrations
|
||||
are stubs that are handled by other (existing) integrations to help with
|
||||
@ -183,13 +167,15 @@ It is not just new {% term integrations %} that have been added; existing
|
||||
integrations are also being constantly improved. Here are some of the noteworthy
|
||||
changes to existing integrations:
|
||||
|
||||
- Add apsystems diagnostic binary sensors ([@CM000n] - [#123045]) ([apsystems docs]) (new-platform)
|
||||
- Add sensor platform for Mastodon ([@andrew-codechimp] - [#123434]) ([mastodon docs]) (new-platform)
|
||||
- Add update platform to AirGradient ([@joostlek] - [#123534]) ([airgradient docs]) (new-platform)
|
||||
- Add favorite position buttons to Motion Blinds ([@starkillerOG] - [#123489]) ([motion_blinds docs]) (new-platform)
|
||||
- Add switch platform to chacon_dio integration ([@cnico] - [#122514]) ([chacon_dio docs]) (new-platform)
|
||||
- Add nest event platform ([@allenporter] - [#123042]) ([nest docs]) (new-platform)
|
||||
- Add SimpleFin binary sensor for errors ([@jeeftor] - [#122554]) ([simplefin docs]) (new-platform)
|
||||
- The Mosquitto MQTT broker add-on can now be installed and started automatically when you setup [MQTT](/integrations/mqtt). Great work [@jbouwh]!
|
||||
- In the [UI for KNX that was introduced last release](/blog/2024/08/07/release-20248/#knx-can-now-be-managed-via-the-ui), you can now also add switch and light entities! Thanks [@farmio]!
|
||||
- [@allenporter] added event entities to the [Nest](integrations/nest) integration.
|
||||
- [@bdraco] made it easier to add battery operated [Shelly](/integrations/shelly) devices, you no longer have to manually set an outbound WebSocket configuration.
|
||||
- [MotionBlinds](/integrations/motion_blinds) now has a button for your favorite position. Thanks [@starkillerOG].
|
||||
- [@joostlek] added the abilitiy to update your [AirGradient](/integrations/airgradient) devices from Home Assistant.
|
||||
- [@CM000n] added diagnostic binary sensors to the [APsystems](/integrations/apsystems) integration.
|
||||
- The [Mastodon](/integrations/mastodon) integration now shows information about your account, like how many followers you have. Thanks [@andrew-codechimp]!
|
||||
|
||||
|
||||
[@CM000n]: https://github.com/CM000n
|
||||
[@andrew-codechimp]: https://github.com/andrew-codechimp
|
||||
@ -236,22 +222,6 @@ of this release:
|
||||
deprecated and now removed. They have been using a deprecated mailbox feature
|
||||
that is no longer available.
|
||||
|
||||
## Other noteworthy changes
|
||||
|
||||
There are many more improvements in this release; here are some of the other
|
||||
noteworthy changes this release:
|
||||
|
||||
- Auto configure outbound websocket for sleepy shelly RPC devices [#124545]
|
||||
- Install and start Mosquitto MQTT broker add-on from MQTT config flow [#124106]
|
||||
- Use BIGINT SQL type for ID columns [#123973]
|
||||
- Add UI to create KNX switch and light entities [#122630]
|
||||
- Add Ollama context window size configuration [#124555]
|
||||
|
||||
[#124545]: https://github.com/home-assistant/core/pull/124545
|
||||
[#124106]: https://github.com/home-assistant/core/pull/124106
|
||||
[#123973]: https://github.com/home-assistant/core/pull/123973
|
||||
[#122630]: https://github.com/home-assistant/core/pull/122630
|
||||
[#124555]: https://github.com/home-assistant/core/pull/124555
|
||||
|
||||
## Need help? Join the community!
|
||||
|
||||
@ -278,9 +248,186 @@ it is inevitable.
|
||||
We always make sure to document these changes to make the transition as easy as
|
||||
possible for you. This release has the following backward-incompatible changes:
|
||||
|
||||
{% details "Recorder database upgrade notice" %}
|
||||
|
||||
This notice applies only if you use the recorder integration with a MySQL or
|
||||
PostgreSQL database. If you are using the default SQLite database,
|
||||
you can ignore it.
|
||||
|
||||
Last release included a database upgrade/migration that increases the size of
|
||||
the number we can store for the identifier fields.
|
||||
|
||||
Not all migrations were successful despite being marked as successful. This
|
||||
release will do the migration again, but will catch unsuccessful migrations.
|
||||
|
||||
This can cause the database upgrade to take longer than usual, depending on
|
||||
the size of your database.
|
||||
|
||||
Please be patient and let the upgrade process finish. Do not interrupt the
|
||||
upgrade process, as this can lead to a corrupted database.
|
||||
|
||||
([@emontnemery] - [#123973]) ([documentation](/integrations/recorder))
|
||||
|
||||
[@emontnemery]: https://github.com/emontnemery
|
||||
[#123973]: https://github.com/home-assistant/core/pull/123973
|
||||
|
||||
{% enddetails %}
|
||||
|
||||
{% details "Asterisk Call Detail Records" %}
|
||||
|
||||
Asterisk Call Detail Records has been deprecated in 2024.3.0 and has now been removed.
|
||||
|
||||
It was using a deprecated mailbox feature that is no longer available.
|
||||
|
||||
([@joostlek] - [#123180])
|
||||
|
||||
[#123180]: https://github.com/home-assistant/core/pull/123180
|
||||
|
||||
{% enddetails %}
|
||||
|
||||
{% details "Asterisk Voicemail" %}
|
||||
|
||||
Asterisk Voicemail has been deprecated in 2024.3.0 and has now been removed.
|
||||
|
||||
It was using a deprecated mailbox feature that is no longer available.
|
||||
|
||||
([@joostlek] - [#123180])
|
||||
|
||||
[#123180]: https://github.com/home-assistant/core/pull/123180
|
||||
|
||||
{% enddetails %}
|
||||
|
||||
{% details "August" %}
|
||||
|
||||
If you are using a Yale Home device with the [August] integration, you should migrate to the new [Yale] integration.
|
||||
|
||||
Yale Home devices will soon stop working with the August integration.
|
||||
|
||||
([@bdraco] - [#124895]) ([august documentation](/integrations/august) - [yale documentation](/integrations/yale))
|
||||
|
||||
[#124895]: https://github.com/home-assistant/core/pull/124895
|
||||
|
||||
{% enddetails %}
|
||||
|
||||
{% details "Ecovacs" %}
|
||||
|
||||
The YAML configuration for the Ecovacs integration was removed. The configuration has been moved to the UI in Home Assistant 2024.2.
|
||||
|
||||
The YAML configuration was automatically imported and should be removed from your YAML configuration.
|
||||
|
||||
[@gjohansson-ST] - [#123605] ([documentation](/integrations/ecovacs))
|
||||
|
||||
[@gjohansson-ST]: https://github.com/gjohansson-ST
|
||||
[#123605]: https://github.com/home-assistant/core/pull/123605
|
||||
|
||||
{% enddetails %}
|
||||
|
||||
{% details "GPSD" %}
|
||||
|
||||
The YAML configuration for the GPSD integration was removed. The configuration has been moved to the UI in Home Assistant 2024.2.
|
||||
|
||||
The YAML configuration was automatically imported and should be removed from your YAML configuration.
|
||||
|
||||
([@gjohansson-ST] - [#123725]) ([documentation](/integrations/gpsd))
|
||||
|
||||
[#123725]: https://github.com/home-assistant/core/pull/123725
|
||||
|
||||
{% enddetails %}
|
||||
|
||||
{% details "KNX" %}
|
||||
|
||||
The KNX Climate preset modes are renamed to match the KNX specifications.
|
||||
|
||||
| KNX specifications | Previous | Now |
|
||||
|---------------------|----------|----------------|
|
||||
| Auto | none | auto |
|
||||
| Comfort | comfort | comfort |
|
||||
| Standby | away | standby |
|
||||
| Economy | sleep | economy |
|
||||
| Building protection | eco | building_protection |
|
||||
|
||||
[@farmio] - [#123964] ([documentation](/integrations/knx))
|
||||
|
||||
[@farmio]: http://gtihub.com/farmio
|
||||
[#123964]: https://github.com/home-assistant/core/pull/123964
|
||||
|
||||
{% enddetails %}
|
||||
|
||||
{% details "Logi circle" %}
|
||||
|
||||
Logitech stopped accepting applications for access to the Logi Circle API in May 2022, and the Logi Circle integration has now been removed.
|
||||
|
||||
[@gjohansson-ST] - [#123727]
|
||||
|
||||
[#123727]: https://github.com/home-assistant/core/pull/123727
|
||||
|
||||
{% enddetails %}
|
||||
|
||||
{% details "Lupusec" %}
|
||||
|
||||
The YAML configuration for the Lupusec integration was removed. The configuration has been moved to the UI in Home Assistant 2024.2.
|
||||
|
||||
The YAML configuration was automatically imported and should be removed from your YAML configuration.
|
||||
|
||||
[@gjohansson-ST] - [#123606] ([documentation](/integrations/lupusec))
|
||||
|
||||
[#123606]: https://github.com/home-assistant/core/pull/123606
|
||||
|
||||
{% enddetails %}
|
||||
|
||||
{% details "Lutron" %}
|
||||
|
||||
In Home Assistant 2024.2, fans where converted from a light entity to a fan entity.
|
||||
The old light entities will no longer work in this release and can be removed.
|
||||
|
||||
[@gjohansson-ST] - [#123607] ([documentation](/integrations/lutron))
|
||||
|
||||
[#123607]: https://github.com/home-assistant/core/pull/123607
|
||||
|
||||
{% enddetails %}
|
||||
|
||||
{% details "Mailbox" %}
|
||||
|
||||
The Mailbox platform that was previously deprecated has been removed.
|
||||
|
||||
[@gjohansson-ST] - [#123741]
|
||||
|
||||
[#123741]: https://github.com/home-assistant/core/pull/123741
|
||||
|
||||
{% enddetails %}
|
||||
|
||||
{% details "MQTT" %}
|
||||
|
||||
The schema option was removed from the MQTT vacuum schema in Home Assistant 2024.2. You should remove this from your YAML configuration if set.
|
||||
|
||||
Manual configured MQTT vacuum entities will break if the schema option is still configured.
|
||||
When using MQTT discovery the option will be silently ignored.
|
||||
|
||||
[@jbouwh] - [#124722] ([documentation](/integrations/mqtt))
|
||||
|
||||
[@jbouwh]: https://github.com/jbouwh
|
||||
[#124722]: https://github.com/home-assistant/core/pull/124722
|
||||
|
||||
{% enddetails %}
|
||||
|
||||
{% details "Overkiz" %}
|
||||
|
||||
Atlantic CozyTouch Water Heaters will now show the Manual operation mode as Electric.
|
||||
|
||||
A binary sensor was added to indicate if the manual mode is activated.
|
||||
|
||||
Users that have automations or scripts using these entities together with the Manual mode should update the automations or scripts accordingly.
|
||||
|
||||
[@ALERTua] - [#124619] ([documentation](/integrations/overkiz))
|
||||
|
||||
[@ALERTua]: https://github.com/ALERTua
|
||||
[#124619]: https://github.com/home-assistant/core/pull/124619
|
||||
|
||||
{% enddetails %}
|
||||
|
||||
{% details "Proximity" %}
|
||||
|
||||
In [2024.2 we introduced new sensor entities](/blog/2024/02/07/release-20242/#revamped-proximity-integration)
|
||||
In 2024.2, [we introduced new sensor entities](/blog/2024/02/07/release-20242/#revamped-proximity-integration)
|
||||
to the [Proximity](/integrations/proximity) {% term integration %} and therefore deprecated the `proximity` entity.
|
||||
|
||||
Now this deprecated `proximity` entity has been removed.
|
||||
@ -292,41 +439,23 @@ Now this deprecated `proximity` entity has been removed.
|
||||
|
||||
{% enddetails %}
|
||||
|
||||
{% details "Asterisk Call Detail Records" %}
|
||||
{% details "Sensibo" %}
|
||||
|
||||
Remove deprecated asterisk_cdr integration ([@joostlek] - [#123180])
|
||||
The previous PM2.5 sensor for Pure devices was incorrectly reporting a PM2.5 value, but it's actually a number representing an AQI level. The sensor will now provide the new states of 'good', 'moderate', and 'bad'.
|
||||
|
||||
[#123180]: https://github.com/home-assistant/core/pull/123180
|
||||
[@gjohansson-ST] - [#124151] ([documentation](/integrations/sensibo))
|
||||
|
||||
{% enddetails %}
|
||||
|
||||
{% details "Asterisk Voicemail" %}
|
||||
|
||||
Remove deprecated asterisk_mbox integration ([@joostlek] - [#123180])
|
||||
|
||||
[#123180]: https://github.com/home-assistant/core/pull/123180
|
||||
|
||||
{% enddetails %}
|
||||
|
||||
{% details "Lutron" %}
|
||||
|
||||
Remove deprecated fan as light in lutron ([@gjohansson-ST] - [#123607]) ([lutron docs]) (breaking-change)
|
||||
|
||||
[#123607]: https://github.com/home-assistant/core/pull/123607
|
||||
|
||||
{% enddetails %}
|
||||
|
||||
{% details "Lupusec" %}
|
||||
|
||||
Remove deprecated yaml import from lupusec ([@gjohansson-ST] - [#123606]) ([lupusec docs]) (breaking-change)
|
||||
|
||||
[#123606]: https://github.com/home-assistant/core/pull/123606
|
||||
[#124151]: https://github.com/home-assistant/core/pull/124151
|
||||
|
||||
{% enddetails %}
|
||||
|
||||
{% details "Starline" %}
|
||||
|
||||
Remove deprecated horn switch in starline ([@gjohansson-ST] - [#123608]) ([starline docs]) (breaking-change)
|
||||
The horn switch has been deprecated since 2024.1 and is now removed.
|
||||
|
||||
Instead of a switch a horn button entity was added. Please update your automations accordingly.
|
||||
|
||||
([@gjohansson-ST] - [#123608]) ([documentation](/integrations/starline))
|
||||
|
||||
[#123608]: https://github.com/home-assistant/core/pull/123608
|
||||
|
||||
@ -334,89 +463,54 @@ Remove deprecated horn switch in starline ([@gjohansson-ST] - [#123608]) ([starl
|
||||
|
||||
{% details "System monitor" %}
|
||||
|
||||
Remove deprecated process sensor from System monitor ([@gjohansson-ST] - [#123616]) ([systemmonitor docs]) (breaking-change)
|
||||
Removes the deprecated process sensor from the System Monitor integration.
|
||||
This sensor has been provided as a binary sensor for 6 months, raising a repair issue.
|
||||
|
||||
[@gjohansson-ST] - [#123616] ([documentation](/integrations/systemmonitor))
|
||||
|
||||
[#123616]: https://github.com/home-assistant/core/pull/123616
|
||||
|
||||
{% enddetails %}
|
||||
|
||||
{% details "Ecovacs" %}
|
||||
{% details "TP-Link Smart Home" %}
|
||||
|
||||
Remove deprecated yaml import from Ecovacs ([@gjohansson-ST] - [#123605]) ([ecovacs docs]) (breaking-change)
|
||||
The binary sensor for "Update available" will no longer be provided by the TP-Link Smart Home integration.
|
||||
|
||||
[#123605]: https://github.com/home-assistant/core/pull/123605
|
||||
It will be replaced in a subsequent release with the Update entity but is disabled for now due to stability issues when calling the TP-Link cloud API to check the latest firmware version. This may cause devices to go offline. They need to be power-cycled to function again. The sensor was also unreliable and may have returned incorrect data because of rate limiting from the TP-Link cloud.
|
||||
|
||||
{% enddetails %}
|
||||
[@sdb9696] - [#124930] ([documentation](/integrations/tplink))
|
||||
|
||||
{% details "Logi circle" %}
|
||||
|
||||
Remove deprecated logi_circle integration ([@gjohansson-ST] - [#123727]) ([logi_circle docs]) (breaking-change)
|
||||
|
||||
[#123727]: https://github.com/home-assistant/core/pull/123727
|
||||
|
||||
{% enddetails %}
|
||||
|
||||
{% details "gpsd" %}
|
||||
|
||||
Remove deprecated yaml import for gpsd ([@gjohansson-ST] - [#123725]) ([gpsd docs]) (breaking-change)
|
||||
|
||||
[#123725]: https://github.com/home-assistant/core/pull/123725
|
||||
[@sdb9696]: https://github.com/sdb9696
|
||||
[#124930]: https://github.com/home-assistant/core/pull/124930
|
||||
|
||||
{% enddetails %}
|
||||
|
||||
{% details "Velux" %}
|
||||
|
||||
Remove deprecated yaml import for velux ([@gjohansson-ST] - [#123724]) ([velux docs]) (breaking-change)
|
||||
The YAML configuration for the Velux integration was removed. The configuration has been moved to the UI in Home Assistant 2024.2.
|
||||
|
||||
The YAML configuration was automatically imported and should be removed from your YAML configuration.
|
||||
|
||||
[@gjohansson-ST] - [#123724] ([documentation](/integrations/velux))
|
||||
|
||||
[#123724]: https://github.com/home-assistant/core/pull/123724
|
||||
|
||||
{% enddetails %}
|
||||
|
||||
{% details "Mailbox" %}
|
||||
{% details "Zigbee Home Automation" %}
|
||||
|
||||
Remove demo mailbox ([@gjohansson-ST] - [#123741]) ([demo docs]) (breaking-change)
|
||||
- The IKEA Starkvind fan modes have been updated. Automations that used to set the fan to 10% speed to switch it to "auto mode", should now be updated to set the preset to "auto."
|
||||
In auto mode, the actual fan speed is now properly displayed.
|
||||
|
||||
[#123741]: https://github.com/home-assistant/core/pull/123741
|
||||
For more information, see the [PR in the ZHA repo](https://github.com/zigpy/zha/pull/87).
|
||||
|
||||
{% enddetails %}
|
||||
- The firmware update entity logic has changed. A device will only be considered "up-to-date" if there is a known firmware update for it and the current firmware version is greater than the firmware update version. If there is no known firmware update, the device firmware state will be considered "unknown", as we can't tell if it's up to date or not.
|
||||
Previously, we showed "up-to-date" if there was no known firmware which misrepresented the state for many devices.
|
||||
|
||||
{% details "KNX" %}
|
||||
[@puddly] - [#124804] ([documentation](/integrations/zha))
|
||||
|
||||
Rename KNX Climate preset modes according to specification ([@farmio] - [#123964]) ([knx docs]) (breaking-change)
|
||||
|
||||
[#123964]: https://github.com/home-assistant/core/pull/123964
|
||||
|
||||
{% enddetails %}
|
||||
|
||||
{% details "Sensibo" %}
|
||||
|
||||
Fix Pure AQI value sensor in Sensibo ([@gjohansson-ST] - [#124151]) ([sensibo docs]) (breaking-change)
|
||||
|
||||
[#124151]: https://github.com/home-assistant/core/pull/124151
|
||||
|
||||
{% enddetails %}
|
||||
|
||||
{% details "Overkiz" %}
|
||||
|
||||
Update overkiz Atlantic Water Heater operation mode switching ([@ALERTua] - [#124619]) ([overkiz docs]) (breaking-change)
|
||||
|
||||
[#124619]: https://github.com/home-assistant/core/pull/124619
|
||||
|
||||
{% enddetails %}
|
||||
|
||||
{% details "Sisyphus" %}
|
||||
|
||||
Disable sisyphus integration ([@bdraco] - [#124742]) ([sisyphus docs]) (breaking-change)
|
||||
|
||||
[#124742]: https://github.com/home-assistant/core/pull/124742
|
||||
|
||||
{% enddetails %}
|
||||
|
||||
{% details "MQTT" %}
|
||||
|
||||
Cleanup removed `schema` option from mqtt vacuum platform ([@jbouwh] - [#124722]) ([mqtt docs]) (breaking-change)
|
||||
|
||||
[#124722]: https://github.com/home-assistant/core/pull/124722
|
||||
[@puddly]: https://github.com/puddly
|
||||
[#124804]: https://github.com/home-assistant/core/pull/124804
|
||||
|
||||
{% enddetails %}
|
||||
|
||||
@ -425,6 +519,9 @@ new features available for your integration: Be sure to follow our
|
||||
[developer blog][devblog]. The following are the most notable for this release:
|
||||
|
||||
- [New returning type in LawnMowerActivity](https://developers.home-assistant.io/blog/2024/08/23/lawn-mower-activity-returning)
|
||||
- [Validation of entity action schemas](https://developers.home-assistant.io/blog/2024/08/27/entity-service-schema-validation)
|
||||
- [Changes to the icon translations schema](https://developers.home-assistant.io/blog/2024/08/27/changed-icon-translations-schema)
|
||||
- [Template.hass is no longer automatically set when rendering templates](https://developers.home-assistant.io/blog/2024/09/02/template-hass-required)
|
||||
|
||||
[devblog]: https://developers.home-assistant.io/blog/
|
||||
|
||||
|
@ -71,11 +71,21 @@ show_entity_picture:
|
||||
description: If your entity has a picture, it will replace the icon.
|
||||
type: boolean
|
||||
default: false
|
||||
display_type:
|
||||
show_name:
|
||||
required: false
|
||||
description: Type of display for the badge. It can be either `minimal` (icon only), `standard` (icon and state), or `complete` (icon, state, and name).
|
||||
type: string
|
||||
default: standard
|
||||
description: Show the name
|
||||
type: boolean
|
||||
default: "true"
|
||||
show_icon:
|
||||
required: false
|
||||
description: Show the icon
|
||||
type: boolean
|
||||
default: "true"
|
||||
show_state:
|
||||
required: false
|
||||
description: Show the state.
|
||||
type: boolean
|
||||
default: "false"
|
||||
state_content:
|
||||
required: false
|
||||
description: >
|
||||
|
BIN
source/images/blog/2024-09-aqara-wwha/art.jpg
Normal file
After Width: | Height: | Size: 309 KiB |
BIN
source/images/blog/2024-09/section-settings.png
Normal file
After Width: | Height: | Size: 7.8 KiB |
BIN
source/images/blog/2024-09/sections-after.png
Normal file
After Width: | Height: | Size: 68 KiB |
BIN
source/images/blog/2024-09/sections-before.png
Normal file
After Width: | Height: | Size: 45 KiB |
Before Width: | Height: | Size: 779 KiB |
Before Width: | Height: | Size: 230 KiB After Width: | Height: | Size: 56 KiB |
Before Width: | Height: | Size: 71 KiB After Width: | Height: | Size: 20 KiB |
Before Width: | Height: | Size: 51 KiB After Width: | Height: | Size: 42 KiB |
BIN
source/images/docs/configuration/enable_entity.webp
Normal file
After Width: | Height: | Size: 1.2 MiB |
BIN
source/images/docs/troubleshooting/home-assistant-cli.webp
Normal file
After Width: | Height: | Size: 356 KiB |
BIN
source/images/integrations/light/state_light.png
Normal file
After Width: | Height: | Size: 80 KiB |
@ -48,7 +48,7 @@ These sentences allow you, for example, to:
|
||||
- **Run a script**
|
||||
- *"Run stealth mode script"*
|
||||
- **Activate a scene**
|
||||
- *"Activate dinner scence"*
|
||||
- *"Activate dinner scene"*
|
||||
- *"Turn kitchen dinner scene on"*
|
||||
- **Inquire about people (that have device tracking activated in Home Assistant)**
|
||||
- *"How many people are in the kitchen"*
|
||||
|