Fix incorrect handling of openState in Contact Sensor #1061
+9
−7
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
nzws
commented
Sep 26, 2024
donavanbecker
added a commit
that referenced
this pull request
Oct 9, 2024
## ♻️ Current situation The Contact Sensor has three states: `open`, `close`, and `timeOutNotClose`[^1]. `timeOutNotClose` indicating that the door/window has been open for an extended period. However, in the current implementation, the `timeOutNotClose` state is not handled correctly, causing the state to be incorrectly updated to `close`. ## 💡 Proposed solution I modified the handling so that `timeOutNotClose` behaves the same as `open` state, and I created a private function for shared handling to prevent future bugs. ## ⚙️ Release Notes - Fix incorrect handling of openState in Contact Sensor ## ➕ Additional Information ### Testing ### Reviewer Nudging [^1]: https://github.com/OpenWonderLabs/SwitchBotAPI/tree/main?tab=readme-ov-file#contact-sensor-1 Co-authored-by: Donavan Becker <beckersmarthome@icloud.com>
donavanbecker
added a commit
that referenced
this pull request
Oct 9, 2024
- Fix incorrect handling of openState in Contact Sensor [#1061](#1061), Thanks [@nzws](https://github.com/nzws) - Fix light level stuck at ma [#1066](#1066), Thanks [@4gra](https://github.com/4gra) - Housekeeping and updated dependencies. **Full Changelog**: v3.8.2...v3.8.3 Co-Authored-By: Donavan Becker <beckersmarthome@icloud.com>
donavanbecker
added a commit
that referenced
this pull request
Oct 9, 2024
- Fix incorrect handling of openState in Contact Sensor [#1061](#1061), Thanks [@nzws](https://github.com/nzws) - Fix light level stuck at ma [#1066](#1066), Thanks [@4gra](https://github.com/4gra) - Housekeeping and updated dependencies. **Full Changelog**: v3.8.2...v3.8.3
Merged
donavanbecker
added a commit
that referenced
this pull request
Oct 9, 2024
## [3.8.3](https://github.com/OpenWonderLabs/homebridge-switchbot/releases/tag/v3.8.3) (2024-10-09) ### What's Changed - Fix incorrect handling of openState in Contact Sensor [#1061](#1061), Thanks [@nzws](https://github.com/nzws) - Fix light level stuck at ma [#1066](#1066), Thanks [@4gra](https://github.com/4gra) - Housekeeping and updated dependencies. **Full Changelog**: v3.8.2...v3.8.3 --------- Co-authored-by: Yuzuki Aida <i@yuzu.sh> Co-authored-by: Graham <4gra@users.noreply.github.com>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
♻️ Current situation
The Contact Sensor has three states:
open,close, andtimeOutNotClose1.timeOutNotCloseindicating that the door/window has been open for an extended period. However, in the current implementation, thetimeOutNotClosestate is not handled correctly, causing the state to be incorrectly updated toclose.💡 Proposed solution
I modified the handling so that
timeOutNotClosebehaves the same asopenstate, and I created a private function for shared handling to prevent future bugs.⚙️ Release Notes
➕ Additional Information
Testing
Reviewer Nudging
Footnotes
https://github.com/OpenWonderLabs/SwitchBotAPI/tree/main?tab=readme-ov-file#contact-sensor-1 ↩