Skip to content

Add Home Assistant Platinum readiness work items - #36

Merged
cabberley merged 2 commits into
mainfrom
copilot/create-custom-repository
Oct 9, 2026
Merged

cabberley merged 2 commits into
mainfrom
copilot/create-custom-repository

Conversation

Copilot AI commented Oct 9, 2026 •

Copy link
Copy Markdown
Contributor

The repository needs a concrete plan to progress toward the Home Assistant Platinum Integration Quality Scale. Its existing TODOs do not cover the quality and reliability work required.

  • Readiness backlog: Add seven scoped work items with acceptance criteria, covering tests, API resilience, config-entry lifecycle, diagnostics, entity and service conventions, documentation, and final checklist review.
  • Existing feature ideas: Preserve and separate the current feature backlog.
  • README: Link to the new Platinum readiness roadmap.

Summary by Sourcery

Establish a concrete, acceptance-driven roadmap for improving Home Assistant Platinum integration readiness while preserving the existing feature backlog.

New Features:

  • Add a documented roadmap of seven scoped work items for progressing toward Home Assistant Platinum Integration Quality Scale readiness.

Enhancements:

  • Separate the existing feature ideas from the quality-scale readiness backlog.
  • Define acceptance criteria covering integration tests, API resilience, config-entry lifecycle, diagnostics, entity and service conventions, documentation, and final checklist verification.

Documentation:

  • Link the README TODO section to the new Platinum readiness roadmap and feature backlog.

Copilot AI linked an issue Oct 9, 2026 that may be closed by this pull request
Co-authored-by: cabberley <26394346+cabberley@users.noreply.github.com>
Copilot AI changed the title [WIP] Add additional work items for Platinum standard HA integration Add Home Assistant Platinum readiness work items Oct 9, 2026
Copilot AI requested a review from cabberley October 9, 2026 02:17
@cabberley
cabberley marked this pull request as ready for review October 9, 2026 02:27
@cabberley
cabberley merged commit d82baa9 into main Oct 9, 2026
6 checks passed
@sourcery-ai

sourcery-ai Bot commented Oct 9, 2026

Copy link
Copy Markdown

Reviewer's Guide

This PR introduces a documented, acceptance-criteria-driven backlog for progressing toward Home Assistant Platinum quality, while preserving the existing feature ideas and linking the new roadmap from the README.

File-Level Changes

Change Details Files
Added a structured Platinum readiness roadmap with scoped implementation work and acceptance criteria.
  • Defined seven work items spanning automated tests, API resilience, config-entry lifecycle, diagnostics, conventions, documentation, and final checklist verification.
  • Specified coverage for offline testing, malformed data, authentication failures, cleanup, credential redaction, translations, and evidence tracking.
  • Clarified that the roadmap is a proposed backlog rather than a current quality-tier claim.
PLATINUM_ROADMAP.md
Separated existing feature ideas from the quality-scale backlog and exposed the roadmap from the README.
  • Preserved the three existing feature ideas in a dedicated backlog section.
  • Replaced the inline TODO list with a link to the Platinum readiness roadmap and feature backlog.
README.md

Assessment against linked issues

Issue Objective Addressed Explanation
#35 Create a concrete, comprehensive set of work items needed to move the integration toward Home Assistant Platinum quality, including actionable scope and acceptance criteria. ✅
#35 Preserve the repository's existing feature backlog separately from the Platinum readiness work. ✅
#35 Make the new Platinum readiness plan discoverable from the repository documentation. ✅

Possibly linked issues

  • Platinum standard HA #35: The PR directly implements the issue by adding seven Platinum readiness work items and preserving existing feature ideas.

Tips and commands

Interacting with Sourcery

  • Trigger a new review: Comment @sourcery-ai review on the pull request.
  • Continue discussions: Reply directly to Sourcery's review comments.
  • Generate a GitHub issue from a review comment: Ask Sourcery to create an
    issue from a review comment by replying to it. You can also reply to a
    review comment with @sourcery-ai issue to create an issue from it.
  • Generate a pull request title: Write @sourcery-ai anywhere in the pull
    request title to generate a title at any time. You can also comment
    @sourcery-ai title on the pull request to (re-)generate the title at any time.
  • Generate a pull request summary: Write @sourcery-ai summary anywhere in
    the pull request body to generate a PR summary at any time exactly where you
    want it. You can also comment @sourcery-ai summary on the pull request to
    (re-)generate the summary at any time.
  • Generate reviewer's guide: Comment @sourcery-ai guide on the pull
    request to (re-)generate the reviewer's guide at any time.
  • Resolve all Sourcery comments: Comment @sourcery-ai resolve on the
    pull request to resolve all Sourcery comments. Useful if you've already
    addressed all the comments and don't want to see them anymore.
  • Dismiss all Sourcery reviews: Comment @sourcery-ai dismiss on the pull
    request to dismiss all existing Sourcery reviews. Especially useful if you
    want to start fresh with a new review - don't forget to comment
    @sourcery-ai review to trigger a new review!

Customizing Your Experience

Access your dashboard to:

  • Enable or disable review features such as the Sourcery-generated pull request
    summary, the reviewer's guide, and others.
  • Change the review language.
  • Add, remove or edit custom review instructions.
  • Adjust other review settings.

Getting Help

@sourcery-ai sourcery-ai Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

Hey - I've found 2 issues

Prompt for AI Agents
Please address the comments from this code review:

## Individual Comments

### Comment 1
<location path="PLATINUM_ROADMAP.md" line_range="77-80" />
<code_context>
+
+- Entity identifiers remain stable and entities expose correct device
+  association, availability, units, and state metadata where applicable.
+- Service schemas and descriptions match the accepted inputs and are covered
+  by tests; user-facing service and flow strings are translated.
+- Unsupported hardware capabilities and invalid control requests fail safely
+  with useful feedback.
+
+### 6. Complete user and maintainer documentation
</code_context>
<issue_to_address>
**Broken device triggers stay unplanned**

When a user selects either advertised device trigger, the roadmap’s audit criteria test service schemas but not device triggers. `async_get_triggers` advertises lowercase `offline` and `fault`, while `async_attach_trigger` checks title-case values, leaving `to_state` unset and causing trigger setup to fail.

Add an explicit device-trigger work item or acceptance criterion to correct the type handling and test trigger setup.
</issue_to_address>

### Comment 2
<location path="PLATINUM_ROADMAP.md" line_range="111-112" />
<code_context>
+readiness work:
+
+- Add control for the relays on SI model inverters.
+- Evaluate moving API authentication to Home Assistant-managed OAuth
+  credentials.
+- Add a service for bulk multi-day schedule and envelope creation.
</code_context>
<issue_to_address>
**OAuth migration loses implementation scope**

When the preserved feature backlog is read as work intended for delivery, the roadmap makes evaluating a move to Home Assistant-managed OAuth the backlog item, rather than implementing the migration, so the existing feature is no longer planned for delivery.

Keep conversion to Home Assistant-managed OAuth as the backlog item, with evaluation as a step if needed.
</issue_to_address>

Sourcery assessment

Approval pending. 1 finding to address first.

Blocking findings: PLATINUM_ROADMAP.md:80


Sourcery is free for open source - if you like our reviews please consider sharing them ✨

Comment thread PLATINUM_ROADMAP.md
Comment on lines +77 to +80
- Service schemas and descriptions match the accepted inputs and are covered
by tests; user-facing service and flow strings are translated.
- Unsupported hardware capabilities and invalid control requests fail safely
with useful feedback.

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

🟡 Medium · Broken device triggers stay unplanned

When a user selects either advertised device trigger, the roadmap’s audit criteria test service schemas but not device triggers. async_get_triggers advertises lowercase offline and fault, while async_attach_trigger checks title-case values, leaving to_state unset and causing trigger setup to fail.

Add an explicit device-trigger work item or acceptance criterion to correct the type handling and test trigger setup.

Prompt for AI agents
In `PLATINUM_ROADMAP.md` at lines 77-80:

**Broken device triggers stay unplanned**

When a user selects either advertised device trigger, the roadmap’s audit criteria test service schemas but not device triggers. `async_get_triggers` advertises lowercase `offline` and `fault`, while `async_attach_trigger` checks title-case values, leaving `to_state` unset and causing trigger setup to fail.

Add an explicit device-trigger work item or acceptance criterion to correct the type handling and test trigger setup.

Comment thread PLATINUM_ROADMAP.md
Comment on lines +111 to +112
- Evaluate moving API authentication to Home Assistant-managed OAuth
credentials.

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

⚪ Low · OAuth migration loses implementation scope

When the preserved feature backlog is read as work intended for delivery, the roadmap makes evaluating a move to Home Assistant-managed OAuth the backlog item, rather than implementing the migration, so the existing feature is no longer planned for delivery.

Keep conversion to Home Assistant-managed OAuth as the backlog item, with evaluation as a step if needed.

Prompt for AI agents
In `PLATINUM_ROADMAP.md` at lines 111-112:

**OAuth migration loses implementation scope**

When the preserved feature backlog is read as work intended for delivery, the roadmap makes evaluating a move to Home Assistant-managed OAuth the backlog item, rather than implementing the migration, so the existing feature is no longer planned for delivery.

Keep conversion to Home Assistant-managed OAuth as the backlog item, with evaluation as a step if needed.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Platinum standard HA

2 participants