Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

v4.0.0 #1070

Merged
merged 44 commits into from
Oct 12, 2024
Merged

v4.0.0 #1070

merged 44 commits into from
Oct 12, 2024

Conversation

donavanbecker
Copy link
Collaborator

4.0.0 (2024-10-11)

What's Changed

⚠️ Breaking Changes

  • Added deviceType based config
    • This allows you to set a setting that will be used across the same deviceType
    • deviceType based config settings can be over written by individual device settings set by the deviceId
  • Added remoteType based config
    • This allows you to set a setting that will be used across the same IR remoteType
    • remoteType based config settings can be over written by individual device settings set by the deviceId
  • All device specific configs have been moved to the same level on the config to elimate the use of multiple of the same config and to better support the new deviceType based config.
    • ** ⚠️ If you have config set for any of the following SwitchBot device Types: Curtain, Blind Tilt, Color Bulb, Strip Light, Hub, Meter, Meter Plus, Humidifier, Contact Sensor, Motion Sensor, Water Detector, Ceiling Light, or Lock; you will need to re-setup your config for that deviceId**
    • ** ⚠️ If you have config set for any of the following IR remote Types: Fan, DIY Fan, Light, DIY Light, Air Conditioner, DIY Air Conditioner, or Others; you will need to re-setup your config for that deviceId**
  • OpenAPI is now support by Version 3.0.0 of node-switchbot, so made changes to refect that.

Other Changes

  • Add K10+ Pro deviceType Support
  • Housekeeping and updated dependencies.

Full Changelog: v3.8.3...v4.0.0

donavanbecker and others added 30 commits September 25, 2024 22:36
## ♻️ 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 <[email protected]>
donavanbecker and others added 14 commits October 5, 2024 05:43
fix light level report, which was stuck at max due to the inappropriate
assignment operator.

## ♻️ Current situation

See #1065 - ambient light level reported to HomeKit is stuck at 6000 lux
despite light level report being accurate. Debugging revealed an
accidental assignment operator ("=") where a comparison ("===") was
required.

## 💡 Proposed solution

This PR contains a one-line patch to fix the above.

## ⚙️ Release Notes

No change required.

### Testing

Not aware of any relevant tests

### Reviewer Nudging

Observe the ambient light level of a connected hub 2 in home bridge UI
before and after the patch.
## [4.0.0](https://github.com/OpenWonderLabs/homebridge-switchbot/releases/tag/v4.0.0) (2024-10-11)

### What's Changed
#### ⚠️ Breaking Changes
- Added `deviceType` based config
  - This allows you to set a setting that will be used across the same deviceType
  - `deviceType` based config settings can be over written by individual device settings set by the deviceId
- Added `remoteType` based config
  - This allows you to set a setting that will be used across the same IR remoteType
  - `remoteType` based config settings can be over written by individual device settings set by the deviceId
- All device specific configs have been moved to the same level on the config to elimate the use of multiple of the same config and to better support the new `deviceType` based config.
  - ** ⚠️ If you have config set for any of the following SwitchBot device Types: `Curtain`, `Blind Tilt`, `Color Bulb`, `Strip Light`, `Hub`, `Meter`, `Meter Plus`, `Humidifier`, `Contact Sensor`, `Motion Sensor`, `Water Detector`, `Ceiling Light`, or `Lock`; you will need to re-setup your config for that deviceId**
  - ** ⚠️ If you have config set for any of the following IR remote Types: `Fan`, `DIY Fan`, `Light`, `DIY Light`, `Air Conditioner`, `DIY Air Conditioner`, or `Others`; you will need to re-setup your config for that deviceId**
- OpenAPI is now support by Version [3.0.0](https://github.com/OpenWonderLabs/node-switchbot/releases/latest) of [`node-switchbot`](https://github.com/OpenWonderLabs/node-switchbot), so made changes to refect that.

#### Other Changes
- Add `K10+ Pro` deviceType Support
- Housekeeping and updated dependencies.

**Full Changelog**: v3.8.3...v4.0.0
@github-actions github-actions bot added enhancement New feature or request dependencies Pull requests that update a dependency file workflow docs latest labels Oct 12, 2024
@donavanbecker donavanbecker merged commit 3256ef4 into latest Oct 12, 2024
5 of 15 checks passed
@donavanbecker donavanbecker deleted the beta-4.0.0 branch October 12, 2024 04:20
@donavanbecker donavanbecker added the major major release change label Oct 12, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
dependencies Pull requests that update a dependency file docs enhancement New feature or request latest major major release change workflow
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants