CHANGELOG.md

Changelog

v2.5.7 (2025-02-04)

Fix

• Update poetry to v2 (#196) (7c422e8)

v2.5.6 (2024-12-19)

Fix

• Downgrade BleakNotFoundError while updating to debug (#189) (26a4392)

v2.5.5 (2024-12-14)

Fix

• Battery workaround for models with removal L-Ion battery (#187) (a937a48)

v2.5.4 (2024-12-13)

Fix

• Add lock info debug logging to help troubleshoot specific locks (#186) (3661e41)

v2.5.3 (2024-12-13)

Fix

• Add Yale Smart Code Handle to battery exclude list (#185) (ddd708b)

v2.5.2 (2024-12-07)

Fix

• Add battery workaround for the SL-103 model aka Yale Linus 2 (#183) (282800d)

v2.5.1 (2024-11-23)

Fix

• Ensure disconnect still happens when connect gets cancellation (#180) (c26b18f)

v2.5.0 (2024-10-06)

Feature

• Add support for Python 3.13 (#178) (807eb53)

v2.4.3 (2024-06-25)

Fix

• Fix license classifier (#163) (86a4ad8)

v2.4.2 (2024-02-23)

Fix

• Only try to connect once at startup (#158) (c7ad2ef)

v2.4.1 (2024-02-04)

Fix

• Handle YaleXSBLEError while shutting down the lock connection (#154) (787efa4)
• Add running guards to ensure cancel does not get suppressed (#153) (f14fbee)

v2.4.0 (2024-01-01)

Feature

• Make close_stale_connections_by_address available (#150) (3baf07f)

v2.3.2 (2023-11-02)

Fix

• Ensure keep alives are disabled after stop (#146) (f4ec54d)

v2.3.1 (2023-10-21)

Fix

• Avoid state callbacks when nothing has changed (#136) (c4d3bc8)

v2.3.0 (2023-09-09)

Feature

• Switch to asyncio.timeout on py3.11+ (#134) (bce9605)

v2.2.3 (2023-07-20)

Fix

• Use async-interrupt to avoid race in write (#133) (436f57b)

v2.2.2 (2023-07-20)

Fix

• Ensure task is uncancelled when catching CancelledError and re-raising as different exception (#132) (a4dc7ed)

v2.2.1 (2023-07-18)

Fix

• Ensure cancellation is propagated during write if it is not from a disconnect (#131) (dd65807)

v2.2.0 (2023-07-13)

Feature

• Refactor to avoid asyncio.wait and task creation during write (#129) (ae0ea36)

v2.1.18 (2023-06-13)

Fix

• Reduce battery drain when advertisement changes frequently (#128) (7f3fdfd)

v2.1.17 (2023-05-16)

Fix

• Guard against reconnecting after shutdown (#127) (1499acb)

v2.1.16 (2023-04-25)

Fix

• Handle flakey authentication with 1.3.4 firmware (#125) (21d20c9)

v2.1.15 (2023-04-25)

Fix

• Handling of cancellation of first update (#124) (a850330)

v2.1.14 (2023-03-29)

Fix

• Skip status for door/battery/lock if an update came over unsolicited notify (#123) (b41d579)

v2.1.13 (2023-03-29)

Fix

• Seperate door and lock status (#121) (36abe23)

v2.1.12 (2023-03-27)

Fix

• Always stop notify before shutting down the session (#122) (fa7354d)

v2.1.11 (2023-03-27)

Fix

• Implement a cooldown between commands (#120) (fd81a67)

v2.1.10 (2023-03-27)

Fix

• Allow cancelation during update to raise (#118) (b1456d5)

v2.1.9 (2023-03-26)

Fix

• Add some more debug logging for command execution (#117) (17b58f7)

v2.1.8 (2023-03-26)

Fix

• Delay disconnect after initial sync if another sync is pending (#116) (1dfdf2a)

v2.1.7 (2023-03-26)

Fix

• Handle bad gatt cache during sessions setup (#115) (9032049)

v2.1.6 (2023-03-26)

Fix

• Force a reconnect when the lock is in a bad state (#114) (ab40867)

v2.1.5 (2023-03-25)

Fix

• Increase stale state debounce to 6.1s (#113) (25b6c09)

v2.1.4 (2023-03-25)

Fix

• Increase stale state debounce delay to 4.0s (#112) (bb7081c)

v2.1.3 (2023-03-25)

Fix

• Avoid updating state until 3 seconds after a lock operation to avoid stale state (#111) (c4ce2a1)

v2.1.2 (2023-03-23)

Fix

• Handle missing characteristic when reading lock info (#110) (1bc667d)

v2.1.1 (2023-03-21)

Fix

• Hold a reference to the deferred update task to avoid GC (#109) (ddb5539)

v2.1.0 (2023-03-16)

Feature

• Switch to using cryptography (#108) (8acc73c)

v2.0.4 (2023-02-26)

Fix

• Handle transient auth failures (#107) (d7f8e14)

v2.0.3 (2023-02-23)

Fix

• Ensure first update bluetooth errors are converted to YaleXSBLEError (#106) (ab96193)

v2.0.2 (2023-02-20)

Fix

• Always request disconnect even if we think we are connected to fix race (#105) (265fe8c)

v2.0.1 (2023-02-17)

Fix

• Handle the key changing after first connection (#104) (f8c2b91)

v2.0.0 (2023-02-08)

Feature

• Add wait_for_first_update to improve authentication error handling (#103) (6af1ec8)

Breaking

• wait_for_first_update needs to be called after calling start before using the lock (6af1ec8)

v1.12.12 (2023-02-08)

Fix

• Raise AuthFailed when lock drops connection due to bad key with esphome proxies (#102) (c41cda5)

v1.12.11 (2023-02-07)

Fix

• Raise AuthError when lock drops connection due to invalid key (#101) (7afffc5)

v1.12.10 (2023-02-07)

Fix

• Ensure ble connection is cleaned up if connection setup fails (#98) (d5b34a6)

v1.12.9 (2023-02-07)

Fix

• Update isort to fix ci (#99) (10f174b)

v1.12.8 (2023-01-23)

Fix

• Wrap the disconnect waiter for py311 asyncio.wait requirements (#97) (ccb7f50)

v1.12.7 (2023-01-22)

Fix

• Improve unexpected disconnect handling (#95) (7a5ee06)

v1.12.6 (2023-01-22)

Fix

• Handle null bytes in the model/manufacturer data (#94) (6f04e4b)

v1.12.5 (2022-12-23)

Fix

• Ensure locked_writes raise after 3 failures (#93) (aac8b72)

v1.12.4 (2022-12-23)

Fix

• Ensure we still disconnect if the write times out (#92) (71655df)

v1.12.3 (2022-12-22)

Fix

• Tell the device we are disconnecting (#91) (be60b5d)

v1.12.2 (2022-12-17)

Fix

• Check if disconnected before writing (#90) (4096eef)
• Do not force a resync if previous state was unknown (#89) (84d82a7)

v1.12.1 (2022-12-17)

Fix

• Free up the connection faster after first update (#88) (5dfc984)

v1.12.0 (2022-12-14)

Feature

• Refactor to use a timed disconnect to improve reliablity (#87) (99323d8)

v1.11.4 (2022-12-10)

Fix

• First update was scheduled being scheduled too late (#86) (eeb0ad4)

v1.11.3 (2022-12-09)

Fix

• Adjust battery percentage based on cliff calc (#85) (3e23368)

v1.11.2 (2022-12-09)

Fix

• Adjust battery based on real world data (#84) (b1db44f)

v1.11.1 (2022-12-09)

Fix

• Adjust battery curve to better fit august values (#83) (0c5b888)

v1.11.0 (2022-12-09)

Feature

• Add battery support (#82) (aeebae4)

v1.10.3 (2022-12-04)

Fix

• Command execution tried to raise due to bad indent (#81) (99b9c4b)

v1.10.2 (2022-12-03)

Fix

• Task leak on destruction (#80) (900673c)

v1.10.1 (2022-12-03)

Fix

• Detect missing characteristics and clear the cache (#78) (e921bf0)

v1.10.0 (2022-12-01)

Feature

• Add YaleXSBLEDiscovery class to be able to get discovery data from august cloud (#77) (28da7da)

v1.9.8 (2022-11-30)

Fix

• Improve operation reliability (#76) (91f403f)

v1.9.7 (2022-11-29)

Fix

• Drop connection instead of executing shutdown (#75) (6d85edf)

v1.9.6 (2022-11-27)

Fix

• Un-retrieved future exceptions when canceled (#74) (9c704dc)

v1.9.5 (2022-10-31)

Fix

• Lock advertisement state needs to be reset after going unavailable to ensure it becomes available again (#73) (cc1a252)

v1.9.4 (2022-10-16)

Fix

• Avoid logging failure when lock is already disconnected (#72) (08f562b)

v1.9.2 (2022-09-15)

Fix

• Incorrect bleak-retry-connector version (#70) (d9c2708)

v1.9.1 (2022-09-15)

Fix

• Handle additional bleak exceptions (#69) (bff64fc)

v1.9.0 (2022-09-13)

Feature

• Update for bleak 0.17 (#67) (78e00a0)

v1.8.1 (2022-09-11)

Fix

• Correct bleak-retry-connector version (#66) (704b7b1)

v1.8.0 (2022-09-11)

Feature

• Implement smart back off (#65) (a3e9c0a)

v1.7.1 (2022-09-10)

Fix

• Handle dbus already having the lock connected at startup (#63) (b47b132)

v1.7.0 (2022-09-10)

Feature

• Expose get_device api (#62) (f49ca9f)

v1.6.4 (2022-08-20)

Fix

• Raise max attempts to 4 (#61) (362b664)

v1.6.3 (2022-08-20)

Fix

• Make sure the ble connection is disconnected if the operation is canceled (#60) (62510ef)

v1.6.2 (2022-08-20)

Fix

• Bump bleak-retry-connector (#59) (309c1d7)

v1.6.1 (2022-08-20)

Fix

• Implement 250ms backoff on dbus error (#58) (33d9954)

v1.6.0 (2022-08-19)

Feature

• Add support for roaming between adapters while establishing the ble connection (#56) (a8885a1)

v1.5.0 (2022-08-19)

Feature

• Add support for roaming between adapters while establishing the ble connection (#55) (1a01c74)

v1.4.0 (2022-08-13)

Feature

• Add support for the gen2 august locks (#54) (47fbc46)

v1.3.2 (2022-08-12)

Fix

• Bump bleak-retry-connector (#53) (194ff6b)

v1.3.1 (2022-08-12)

Fix

• Bleak retry disconnect race fix (#52) (3e2163c)

v1.2.0 (2022-08-11)

Feature

• Implement service caching (#45) (b5ce3ca)

v1.1.3 (2022-08-11)

Fix

• Battery drain when using dbus-broker (#49) (7060e0f)

v1.1.2 (2022-08-10)

Fix

• Battery drain for locks that broadcast adv of 255 (#48) (188052b)

v1.1.1 (2022-08-07)

Fix

• Number of arguments to secure session debug log (#47) (3a6f211)

v1.1.0 (2022-08-07)

Feature

• Improve debug logging (#46) (526407c)

v1.0.1 (2022-08-06)

Fix

• Format strings for debug logging (#44) (2295773)

v1.0.0 (2022-08-06)

Feature

• Add support for gen2 locks (#43) (40d2b65)

Breaking

• The arguments for PushLock are now all keyword. Either a unique local_name or an address must be provided (40d2b65)

v0.21.0 (2022-08-06)

Feature

• Tweak debounce to see door close/open faster (#42) (ee78cdb)

v0.20.0 (2022-08-05)

Feature

• Cancel an update in progress on lock/unlock (#41) (d1905ae)

v0.19.0 (2022-08-05)

Feature

• Cancel previous lock/unlock requests when a new one comes in (#40) (4b670d5)

v0.18.1 (2022-08-04)

Fix

• Only validate callback_state if there are callbacks (#39) (c368456)

v0.18.0 (2022-08-04)

Feature

• Small cleanups (#38) (26c6c79)

v0.17.1 (2022-08-04)

Fix

• Wrap BleakError as DisconnectedError on disconnect from write (#37) (30d0a7e)

v0.17.0 (2022-08-03)

Feature

• Expose bledevice (#36) (476abea)

v0.16.0 (2022-08-03)

Feature

• Throw disconnected error if lock disconnects us (#35) (c1bcf62)

v0.15.1 (2022-08-03)

Fix

• Do not keep retrying 10x more time if the lock cannot be found (#34) (704f7bb)

v0.15.0 (2022-08-03)

Feature

• Add validate function to check creds (#33) (aadfc76)

v0.14.0 (2022-08-03)

Feature

• Improve error reporting (#32) (d81121d)

v0.13.0 (2022-08-03)

Feature

• Tweak update times to improve responsiveness (be2278c)
• Tweak update times to improve responsiveness (b47121c)

v0.12.1 (2022-08-02)

Fix

• Double update when adv and homekit update at the same time (#31) (760e429)

v0.12.0 (2022-08-02)

Feature

• Add manual update request (#30) (26c49a7)

v0.11.0 (2022-08-02)

Feature

• Speed up first update (#29) (764894b)

v0.10.0 (2022-08-02)

Feature

• Add connection information (#28) (36ff430)

v0.9.5 (2022-08-02)

Fix

• Debounced updates (#27) (a9ce949)

v0.9.4 (2022-08-02)

Fix

• Race in the operation locking (#26) (ccb3653)

v0.9.3 (2022-08-02)

Fix

• Ensure adv updates are processed (#25) (b655379)

v0.9.2 (2022-08-02)

Fix

• Schedule race (#24) (6a5d4cd)

v0.9.1 (2022-08-02)

Fix

• Ensure homekit updates take precedence (#23) (6897092)

v0.9.0 (2022-08-02)

Feature

• Add lock_info property (#22) (ac7f956)

v0.8.0 (2022-08-02)

Feature

• Add lock info (#21) (6bd635d)

v0.7.1 (2022-08-02)

Fix

• Defer updates for 10s when there is an update storm (#20) (142a5c8)

v0.7.0 (2022-07-28)

Feature

• Coalesce updates (#19) (9f5fe74)

v0.6.1 (2022-07-28)

Fix

• Handle disconnect race (#18) (ecd6916)

v0.6.0 (2022-07-28)

Feature

• Speed up init (#17) (61f3fbc)

v0.5.1 (2022-07-27)

Fix

• Error handling for d-bus (#16) (a4c92a0)

v0.5.0 (2022-07-27)

Feature

• Expose lock state (#15) (2384592)

v0.4.3 (2022-07-27)

Fix

• Add dbus error handler (#14) (2046a95)

v0.4.2 (2022-07-27)

Fix

• Error reporting (#13) (e7822cf)

v0.4.1 (2022-07-27)

Fix

• Cancel lock status update when unlocking/locking (#12) (1c08fb6)

v0.4.0 (2022-07-27)

Feature

• Start now return a cancel callable (#11) (5ff3a36)

v0.3.1 (2022-07-27)

Fix

• Add missing imports (#10) (4a76d51)

v0.3.0 (2022-07-27)

Feature

• Add serial number helpers (#9) (3d532dc)

v0.2.0 (2022-07-27)

Feature

• Change example to use serial number (#8) (696cd0e)

v0.1.2 (2022-07-27)

Fix

• Unlock and lock calls without force (#7) (c660cbb)

v0.1.1 (2022-07-27)

Fix

• Fix release process (#6) (551ebc6)
• Ci (#5) (9f721c2)

v0.1.0 (2022-07-27)

Feature

• First release (#4) (234e06d)