Bram Kragten a2dc00b435
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>
2024-09-04 17:35:42 +02:00

5.5 KiB

title, description, ha_category, ha_release, ha_iot_class, ha_config_flow, ha_codeowners, ha_domain, ha_dhcp, ha_platforms, ha_integration_type
title description ha_category ha_release ha_iot_class ha_config_flow ha_codeowners ha_domain ha_dhcp ha_platforms ha_integration_type
Yale Instructions on how to integrate your Yale devices into Home Assistant.
Binary sensor
Button
Camera
Doorbell
Event
Lock
Sensor
2024.9 Cloud Push true
@bdraco
yale true
binary_sensor
button
camera
diagnostics
event
lock
sensor
integration

The Yale integration allows you to integrate your 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 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 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 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:

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.

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 %}

- 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 %}