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

Support vacation mode for WG4-series thermostats #217

Merged
merged 1 commit into from
Feb 14, 2024

Conversation

adamjernst
Copy link
Contributor

I mistakenly believed that vacation mode was not actually used for WG4-series thermostats. It is!

This PR correctly parses vacation fields. It still does not support scheduling vacation mode (just like WD5-series thermostats).

I mistakenly believed that vacation mode was not actually used for WG4-series thermostats. It is!

This PR correctly parses vacation fields. It still does not support scheduling vacation mode (just like WD5-series thermostats).
@@ -51,6 +51,10 @@ This object represents the current state of a thermostat.
| `manual_temperature` | integer | If the regulation mode is set to manual mode, the thermostat will target this temperature. |
| `comfort_temperature` | integer | If the regulation mode is set to comfort mode, the thermostat will target this temperature. |
| `comfort_end_time` | datetime | If the regulation mode is set to comfort mode, it will end at this time. |
| `vacation_mode` | boolean | If true then the thermostat is set to `vacation_temperature` from `vacation_begin_time` to `vacation_end_time`. If false, then no vacation is in progress or scheduled. |
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

vacation_mode is a confusing name since we also have regulation_mode. The API calls this VacationEnabled which is more accurate.

This boolean does not indicate whether we are currently in the vacation regulation mode. It indicates whether a vacation is currently scheduled, regardless of whether it begins in the past or future.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

(I tried to update this documentation to make it a bit clearer.)

Copy link
Owner

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

If you want to change it to vacation_enabled thats fine with me, makes more sense :-)

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nah, that's a backwards incompatible change so I figure we should leave it for the next major version bump.

Copy link

codecov bot commented Feb 12, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Comparison is base (09c02d4) 100.00% compared to head (b897729) 100.00%.
Report is 5 commits behind head on main.

Additional details and impacted files
@@            Coverage Diff            @@
##              main      #217   +/-   ##
=========================================
  Coverage   100.00%   100.00%           
=========================================
  Files            9         9           
  Lines          352       353    +1     
  Branches        55        55           
=========================================
+ Hits           352       353    +1     

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@robbinjanssen robbinjanssen added enhancement Enhancement of the code, not introducing new features. new-feature New features or options. and removed enhancement Enhancement of the code, not introducing new features. labels Feb 13, 2024
@robbinjanssen robbinjanssen merged commit 35d5dfc into robbinjanssen:main Feb 14, 2024
16 of 17 checks passed
@robbinjanssen
Copy link
Owner

Tagged as v3.1.0!

@adamjernst adamjernst deleted the vacation-wg4 branch February 14, 2024 21:37
@github-actions github-actions bot locked and limited conversation to collaborators Feb 16, 2024
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
new-feature New features or options.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants