Add page count sensors to IPP integration

[brianegge]

Summary

• Adds page count sensors to the IPP integration by fetching additional printer attributes via a separate Get-Printer-Attributes IPP request
• Supports both simple integer attributes (printer-impressions-completed, printer-pages-completed, printer-media-sheets-completed) and collection-based attributes (printer-impressions-completed-col with monochrome/full-color sub-values used by HP printers)
• Sensors are only created when the printer exposes the corresponding attributes, so existing setups are unaffected

Details

The pyipp library doesn't currently request or parse page count attributes. This PR works around that by using ipp.execute() directly to request these attributes in a separate call. An upstream PR to add native support in pyipp has been opened: ctalkington/python-ipp#715

Tested on an HP Color LaserJet Pro MFP 3301 which exposes printer-impressions-completed-col with monochrome and full-color sub-values.

Test plan

• All 29 existing IPP tests pass
• Snapshot tests updated to include new page count sensors
• Tested on live HP Color LaserJet Pro MFP 3301 - monochrome and color impression sensors created and reporting correctly
• Verified printers not exposing page counts create no new entities

🤖 Generated with Claude Code

[home-assistant]

Hey there @ctalkington, mind taking a look at this pull request as it has been labeled with an integration (ipp) you are listed as a code owner for? Thanks!

Code owner commands

Code owners of ipp can trigger bot actions by commenting:

• @home-assistant close Closes the pull request.
• @home-assistant rename Awesome new title Renames the pull request.
• @home-assistant reopen Reopen the pull request.
• @home-assistant unassign ipp Removes the current integration label and assignees on the pull request, add the integration domain after the command.
• @home-assistant add-label needs-more-information Add a label (needs-more-information, problem in dependency, problem in custom component, problem in config, problem in device, feature-request) to the pull request.
• @home-assistant remove-label needs-more-information Remove a label (needs-more-information, problem in dependency, problem in custom component, problem in config, problem in device, feature-request) on the pull request.

[Copilot]

Pull request overview

Adds page-count diagnostic sensors to the IPP integration by issuing an additional Get-Printer-Attributes request and exposing relevant counters as Home Assistant sensor entities.

Changes:

• Fetch page count attributes via a separate IPP GET_PRINTER_ATTRIBUTES request and parse both integer and collection-based counter attributes.
• Add new diagnostic sensors for pages/impressions/media sheets completed (including monochrome/full-color impressions where available).
• Update fixtures and snapshots to include the new entities, plus add translation strings and icons.

Reviewed changes

Copilot reviewed 6 out of 6 changed files in this pull request and generated 2 comments.

Show a summary per file

File	Description
homeassistant/components/ipp/coordinator.py	Adds page count attribute fetch + parsing and stores results on the coordinator.
homeassistant/components/ipp/sensor.py	Defines page count sensor descriptions and entities; conditionally adds them based on fetched attributes.
homeassistant/components/ipp/strings.json	Adds names for new sensor translation keys.
homeassistant/components/ipp/icons.json	Adds default icons for the new sensors.
tests/components/ipp/conftest.py	Extends mocked IPP client to return page-count attributes for tests.
tests/components/ipp/snapshots/test_sensor.ambr	Updates sensor snapshots to include the newly created page-count entities.

---

You can also share your feedback on Copilot code review. Take the survey.

[Copilot]

Pull request overview

Adds optional page count sensors to the IPP integration by issuing an additional Get-Printer-Attributes request and exposing any supported counter attributes as diagnostic sensors.

Changes:

• Extend the IPP coordinator to fetch and parse page count attributes (including collection-based HP counters) into coordinator.page_counts.
• Add new sensor entities that are only created when the corresponding IPP attributes are present.
• Update/extend test fixtures, snapshots, and add a regression test ensuring no new sensors are created when unsupported.

Reviewed changes

Copilot reviewed 7 out of 7 changed files in this pull request and generated no comments.

Show a summary per file

File	Description
homeassistant/components/ipp/coordinator.py	Adds a second IPP request to fetch page-count-related attributes and parses them into page_counts.
homeassistant/components/ipp/sensor.py	Introduces page count sensor descriptions/entities and conditionally sets them up based on available attributes.
homeassistant/components/ipp/strings.json	Adds translation strings for new page count sensors.
homeassistant/components/ipp/icons.json	Adds default icons for the new page count sensors.
tests/components/ipp/conftest.py	Extends the mocked IPP client to return page count attributes for snapshot tests.
tests/components/ipp/test_sensor.py	Adds a test ensuring no page count sensors/entities are created when attributes are absent.
tests/components/ipp/snapshots/test_sensor.ambr	Updates snapshots to include the newly added page count sensors.

---

You can also share your feedback on Copilot code review. Take the survey.

[Copilot]

Pull request overview

Adds page count sensors to the IPP integration by issuing an additional Get-Printer-Attributes request to retrieve page/impression counters (including HP-style collection attributes) and exposing them as diagnostic sensors.

Changes:

• Extend the IPP coordinator to fetch and parse page count attributes via ipp.execute(...).
• Add new diagnostic sensor entities for page/impression/media-sheet counters (including monochrome/full-color breakdown).
• Update translations/icons and test snapshots; add a test ensuring no sensors are created when counters aren’t exposed.

Reviewed changes

Copilot reviewed 7 out of 7 changed files in this pull request and generated 2 comments.

Show a summary per file

File	Description
homeassistant/components/ipp/coordinator.py	Adds a second IPP request to fetch page-count attributes and stores parsed results on the coordinator.
homeassistant/components/ipp/sensor.py	Defines page-count sensor descriptions/entities and conditionally adds them based on fetched attributes.
homeassistant/components/ipp/strings.json	Adds translation keys/names for the new sensors.
homeassistant/components/ipp/icons.json	Adds default icons for the new sensors.
tests/components/ipp/conftest.py	Extends the IPP mock to return page-count attributes for tests.
tests/components/ipp/test_sensor.py	Adds coverage for the “unsupported page counts” case.
tests/components/ipp/snapshots/test_sensor.ambr	Updates snapshots to include new entities and states.

---

You can also share your feedback on Copilot code review. Take the survey.

[Copilot]

Pull request overview

Adds page count (lifetime counter) sensors to the IPP integration by performing an additional IPP Get-Printer-Attributes request and exposing supported attributes as diagnostic sensors.

Changes:

• Fetch and cache page-count-related IPP attributes via a separate GET_PRINTER_ATTRIBUTES call in the coordinator.
• Add new diagnostic sensors for total page/impression/media-sheet counts, including HP “collection” counters (mono/color).
• Extend tests/fixtures and snapshots, plus add a negative test to ensure no entities are created when counters are unsupported.

Reviewed changes

Copilot reviewed 7 out of 7 changed files in this pull request and generated 1 comment.

Show a summary per file

File	Description
homeassistant/components/ipp/coordinator.py	Adds periodic page-count attribute fetch via ipp.execute(...) and caches parsed counters.
homeassistant/components/ipp/sensor.py	Introduces page-count sensor descriptions and conditionally creates entities based on discovered counters.
homeassistant/components/ipp/strings.json	Adds translation names for the new page-count sensors.
homeassistant/components/ipp/icons.json	Adds default icons for the new page-count sensors.
tests/components/ipp/conftest.py	Extends the IPP client mock to return page-count attributes from execute().
tests/components/ipp/test_sensor.py	Makes disabled-by-default test more robust and adds coverage for “unsupported counters” case.
tests/components/ipp/snapshots/test_sensor.ambr	Updates snapshots to include the new page-count sensors.

[brianegge]

Triage request: this PR is blocked by the required-labels check. Could a maintainer apply the new-feature label? CI is green, code-owner approval is in, and the bot's add-label command doesn't accept new-feature. Thanks!

[home-assistant]

Please take a look at the requested changes, and use the Ready for review button when you are done, thanks 👍

Learn more about our pull request process.

[Copilot]

Pull request overview

Copilot reviewed 10 out of 10 changed files in this pull request and generated 2 comments.

[Copilot]

Pull request overview

Copilot reviewed 10 out of 10 changed files in this pull request and generated no new comments.

Comments suppressed due to low confidence (3)

homeassistant/components/ipp/coordinator.py:84

• Move the page-counter request and parsing into pyipp before adding the Home Assistant entities. Home Assistant integrations are expected to remain thin wrappers and not carry workarounds for client-library limitations; this comment explicitly identifies the raw request as such a workaround, while the referenced upstream PR is still open and the manifest remains pinned to pyipp==0.17.0. Merge/release the upstream support, bump the dependency, and consume its typed counter model here instead.

        # Page counts are fetched via a separate request for now. Once pyipp PR #715
        # (https://github.com/ctalkington/python-ipp/pull/715) is merged, page
        # counters will be included in printer.counters by default and this extra
        # request can be removed.

tests/components/ipp/test_sensor.py:110

• Cover successful empty or partial responses in the retention test. This test only exercises the exception path, so it does not detect the separate successful-response path that currently rebuilds the counter dictionary and drops previously known values; adding a case such as {"printers": []} would have caught that regression.

    mock_ipp.execute.side_effect = IPPError("boom")
    await init_integration.runtime_data.async_refresh()

homeassistant/components/ipp/coordinator.py:110

• Preserve previously fetched counters when a successful response is partial. page_counts is rebuilt from {}, so an empty or partial printers payload drops existing keys and makes already-created sensors become unknown; this also contradicts the stated fix in the prior review reply. Start from a copy of previous_page_counts and overwrite only values present in this response.

        parsed: dict[str, Any] = next(iter(response.get("printers") or []), {})
        page_counts: dict[str, int] = {}

[brianegge]

@copilot Fix the code for all comments in this review thread.

When a review comment includes a suggested change, apply the suggestion exactly.

Do not make changes beyond what is described in the linked review thread.

[Copilot]

Pull request overview

Copilot reviewed 10 out of 10 changed files in this pull request and generated no new comments.

Suppressed comments (2)

homeassistant/components/ipp/coordinator.py:85

• Move the page-counter request and parsing into pyipp, then consume a released library API here. Home Assistant integrations must remain thin wrappers and must not implement protocol parsing or workarounds for library limitations; upstream PR #715 is still open/blocked and the latest release, 0.17.2, does not provide this API, so this change should wait for the upstream release and update the dependency instead of calling execute() directly.

        # Page counts are fetched via a separate request for now. Once pyipp PR #715
        # (https://github.com/ctalkington/python-ipp/pull/715) is merged, page
        # counters will be included in printer.counters by default and this extra
        # request can be removed.

homeassistant/components/ipp/coordinator.py:82

• Restore the complete Home Assistant pull request template in the PR description. The current Summary/Details/Test plan text omits the required Proposed change, Type of change, Additional information, full Checklist, documentation/dependency checklists, and review-two-PRs checklist; required sections and unchecked boxes must remain present.

        # Page counts are fetched via a separate request for now. Once pyipp PR #715