Add includeAlerts to thermostat API selection - #90
Merged
nkgilley merged 1 commit intoSep 22, 2026
Merged
Conversation
Include the alerts array in the thermostat API response so consumers
can read active maintenance reminders (furnace filter, UV lamp, AC
maintenance, etc.) from thermostat.get("alerts", []).
This is needed by Home Assistant's ecobee integration to power
alert binary_sensor entities.
Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
Contributor
Author
|
@nkgilley Could you review this when you get a chance? Thanks! |
zackwag
added a commit
to zackwag/core
that referenced
this pull request
Sep 22, 2026
Picks up nkgilley/python-ecobee-api#90, which adds includeAlerts to the thermostat API selection so alert data is available for the new equipment maintenance binary sensors. Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>
This file contains hidden or 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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
Summary
"includeAlerts": "true"to the selection dict inget_thermostats()so the ecobee API response includes each thermostat'salertsarrayWhy
The ecobee API's Selection Object supports an
includeAlertsboolean that causes the response to include active alerts (maintenance reminders like furnace filter, UV lamp, AC maintenance, etc.) on each thermostat. Currently this library doesn't request it, sothermostat["alerts"]is never populated.This is needed by Home Assistant's ecobee integration to support alert binary sensors (see home-assistant/core#182913).
Ramifications
alertsarray to each thermostat in the response. For most users this is a small array (0-5 items). The ecobee API already includes much larger payloads (weather forecasts, programs, events) unconditionally, so this is negligible.thermostat["alerts"]are unaffected — it's additive data.includeAlertsfollows the same pattern asincludeEvents,includeWeather, etc. which are already unconditionally enabled.