Add CatGenie integration by kclif9 · Pull Request #169533 · home-assistant/core

kclif9 · 2026-04-30T07:59:09Z

Proposed change

Add the CatGenie integration to home assistant. The first platform to be added is the sensor platform as this allows users to run a fan when the CatGenie device is running.

Type of change

Dependency upgrade
Bugfix (non-breaking change which fixes an issue)
New integration (thank you!)
New feature (which adds functionality to an existing integration)
Deprecation (breaking change to happen in the future)
Breaking change (fix/feature causing existing functionality to break)
Code quality improvements to existing code or addition of tests

Additional information

This PR fixes or closes issue: fixes #
This PR is related to issue:
Link to documentation pull request: Add documentation for CatGenie integration home-assistant.io#45105
Link to developer documentation pull request:
Link to frontend pull request:
Link to brand pull request: Add CatGenie logos brands#10226

Checklist

I understand the code I am submitting and can explain how it works.
The code change is tested and works locally.
Local tests pass. Your PR cannot be merged unless tests pass
There is no commented out code in this PR.
I have followed the development checklist
I have followed the perfect PR recommendations
The code has been formatted using Ruff (ruff format homeassistant tests)
Tests have been added to verify that the new code works.
Any generated code has been carefully reviewed for correctness and compliance with project standards.

If user exposed functionality or configuration variables are added/changed:

Documentation added/updated for www.home-assistant.io

If the code communicates with devices, web services, or third-party tools:

The manifest file has all fields filled out correctly.
Updated and included derived files by running: python3 -m script.hassfest.
New or updated dependencies have been added to requirements_all.txt.
Updated by running python3 -m script.gen_requirements_all.
For the updated dependencies a diff between library versions and ideally a link to the changelog/release notes is added to the PR description.

To help with the load of incoming pull requests:

I have reviewed two other open pull requests in this repository.

Co-authored-by: Copilot <copilot@github.com>

Copilot

Pull request overview

Adds a new CatGenie integration to Home Assistant core, including config flow, runtime setup, and an initial sensor platform intended to expose device state for automations.

Changes:

Introduces homeassistant.components.catgenie with config flow, coordinator/entity base, and sensor entities.
Adds a new test suite under tests/components/catgenie/ covering config flow, setup/unload, sensors, and diagnostics.
Registers the integration in generated/metadata files and pins the catgenie dependency.

Reviewed changes

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

Show a summary per file

File	Description
`homeassistant/components/catgenie/__init__.py`	Sets up auth/client, creates per-device coordinators, forwards platforms, and unloads platforms.
`homeassistant/components/catgenie/config_flow.py`	Implements SMS-based login + reauth config flow.
`homeassistant/components/catgenie/coordinator.py`	Per-device `DataUpdateCoordinator` fetching device state and handling token refresh.
`homeassistant/components/catgenie/entity.py`	Base coordinator entity + `DeviceInfo` wiring.
`homeassistant/components/catgenie/sensor.py`	Defines sensor entity descriptions and entity implementation.
`homeassistant/components/catgenie/strings.json`	Adds config flow text, sensor names/states, and exception translations.
`homeassistant/components/catgenie/manifest.json`	Declares integration metadata and dependency pin.
`homeassistant/components/catgenie/quality_scale.yaml`	Declares quality scale rule statuses for the new integration.
`homeassistant/components/catgenie/const.py`	Adds `DOMAIN` and logger constant.
`tests/components/catgenie/conftest.py`	Provides fixtures/mocks for auth/client and sample device data.
`tests/components/catgenie/test_config_flow.py`	Tests user + reauth flows and error handling.
`tests/components/catgenie/test_init.py`	Tests setup/unload and coordinator refresh error scenarios.
`tests/components/catgenie/test_sensor.py`	Tests expected sensor entities and states.
`tests/components/catgenie/test_diagnostics.py`	Tests config entry diagnostics output contract.
`tests/components/catgenie/__init__.py`	Marks test package for the integration.
`requirements_all.txt`	Adds `catgenie==0.1.3` to runtime requirements list.
`requirements_test_all.txt`	Adds `catgenie==0.1.3` to test requirements list.
`mypy.ini`	Enables strict-ish mypy settings for `homeassistant.components.catgenie.*`.
`.strict-typing`	Registers the integration as strict-typing.
`homeassistant/generated/integrations.json`	Registers the integration metadata (generated).
`homeassistant/generated/config_flows.py`	Registers integration as having a config flow (generated).
`CODEOWNERS`	Assigns code ownership for the new integration and tests.

…device management and update entity handling Co-authored-by: Copilot <copilot@github.com>

… CatGenieException Co-authored-by: Copilot <copilot@github.com>

Copilot

Pull request overview

Copilot reviewed 19 out of 21 changed files in this pull request and generated 5 comments.

Copilot · 2026-04-30T11:50:09Z

+    CatGenieSensorDescription(
+        key="sani_solution",
+        translation_key="sani_solution",
+        state_class=SensorStateClass.TOTAL,


Use SensorStateClass.MEASUREMENT with a percentage unit (and avoid TOTAL) for a “remaining” value, since TOTAL implies a monotonically increasing counter and will produce incorrect long-term statistics.

Suggested change

state_class=SensorStateClass.TOTAL,

native_unit_of_measurement=PERCENTAGE,

state_class=SensorStateClass.MEASUREMENT,

This is not a percentage but an int decreasing as the remaining sanitiser solution is used. I.e. each cartridge has either 120 or 240 uses depending on the users' settings (automatic mode extends the life of the cartridge).

Percentage and measurement would be misleading. TOTAL appears to be the correct unit.

Co-authored-by: Copilot <copilot@github.com>

…, supported devices, and use cases

Copilot

Pull request overview

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

…ce data access Co-authored-by: Copilot <copilot@github.com>

Co-authored-by: Copilot <copilot@github.com>

Copilot

Pull request overview

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

Copilot

Pull request overview

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

Copilot · 2026-05-01T02:50:07Z

+    entry.runtime_data = CatGenieRuntimeData(
+        stack=stack,
+        coordinator=coordinator,
+    )
+
+    await hass.config_entries.async_forward_entry_setups(entry, PLATFORMS)
+


Ensure AsyncExitStack is closed if forwarding platform setups fails (e.g., async_forward_entry_setups raises), to avoid leaking open client/auth contexts; wrap the forward call in try/except (or set runtime_data only after successful forwarding) and close the stack on failure.

Suggested change

entry.runtime_data = CatGenieRuntimeData(

stack=stack,

coordinator=coordinator,

)

await hass.config_entries.async_forward_entry_setups(entry, PLATFORMS)

try:

await hass.config_entries.async_forward_entry_setups(entry, PLATFORMS)

except Exception:

await stack.aclose()

raise

entry.runtime_data = CatGenieRuntimeData(

stack=stack,

coordinator=coordinator,

)

…ity functions Co-authored-by: Copilot <copilot@github.com>

joostlek · 2026-05-04T20:33:00Z

+
+import logging
+
+DOMAIN = "catgenie"


how do they advertise it? cat_genie? catgenie? No preference, just want to throw it on the table

They advertise as "CatGenie" with the G uppercase and no space.

home-assistant · 2026-05-04T20:34:58Z

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.

Co-authored-by: Copilot <copilot@github.com>

Copilot

Pull request overview

Copilot reviewed 20 out of 22 changed files in this pull request and generated 8 comments.

+    state = hass.states.get("sensor.catgenie_litter_box_status")
+    assert state is not None
+    assert state.state == "cleaning"
+


+    state = hass.states.get("sensor.catgenie_litter_box_status")
+    assert state is not None
+    assert state.state == "unavailable"


+    state = hass.states.get("sensor.catgenie_litter_box_status")
+    assert state is not None
+    assert state.state == "unavailable"
+


+    state = hass.states.get("sensor.catgenie_litter_box_status")
+    assert state is not None
+    assert state.state == "unavailable"


feat(catgenie): add initial integration for CatGenie devices

14f768e

Co-authored-by: Copilot <copilot@github.com>

Copilot AI review requested due to automatic review settings April 30, 2026 07:59

home-assistant Bot added cla-signed has-tests new-integration integration: catgenie quality-scale labels Apr 30, 2026

Copilot started reviewing on behalf of kclif9 April 30, 2026 08:00 View session

Copilot AI reviewed Apr 30, 2026

View reviewed changes

feat(catgenie): refactor integration to use a single coordinator for …

58f6c43

…device management and update entity handling Co-authored-by: Copilot <copilot@github.com>

This was referenced Apr 30, 2026

Add CatGenie logos home-assistant/brands#10226

Open

Add cat genie documentation home-assistant/home-assistant.io#45104

Closed

Add documentation for CatGenie integration home-assistant/home-assistant.io#45105

Open

feat(catgenie): update exception handling in config flow tests to use…

52b44fa

… CatGenieException Co-authored-by: Copilot <copilot@github.com>

Copilot AI review requested due to automatic review settings April 30, 2026 11:44

Copilot started reviewing on behalf of kclif9 April 30, 2026 11:45 View session

Copilot AI reviewed Apr 30, 2026

View reviewed changes

kclif9 and others added 2 commits April 30, 2026 11:54

feat(catgenie): enhance error handling during setup and data updates

a86ae98

Co-authored-by: Copilot <copilot@github.com>

feat(catgenie): update documentation status for examples, limitations…

20e48f3

…, supported devices, and use cases

Copilot AI review requested due to automatic review settings April 30, 2026 12:30

Copilot started reviewing on behalf of kclif9 April 30, 2026 12:31 View session

Copilot AI reviewed Apr 30, 2026

View reviewed changes

Comment thread homeassistant/components/catgenie/config_flow.py Outdated

Comment thread homeassistant/components/catgenie/entity.py Outdated

kclif9 and others added 2 commits April 30, 2026 22:44

feat(catgenie): implement re-authentication handling and improve devi…

08c0f70

…ce data access Co-authored-by: Copilot <copilot@github.com>

feat(catgenie): add tests for token rotation and device removal handling

cf852f0

Co-authored-by: Copilot <copilot@github.com>

Copilot AI review requested due to automatic review settings April 30, 2026 23:43

Copilot started reviewing on behalf of kclif9 April 30, 2026 23:44 View session

Copilot AI reviewed Apr 30, 2026

View reviewed changes

Comment thread homeassistant/components/catgenie/coordinator.py

Merge branch 'dev' into Add-CatGenie-AI-Integration

fa099e3

kclif9 marked this pull request as ready for review May 1, 2026 02:45

Copilot AI review requested due to automatic review settings May 1, 2026 02:45

Copilot started reviewing on behalf of kclif9 May 1, 2026 02:46 View session

Copilot AI reviewed May 1, 2026

View reviewed changes

feat(catgenie): enhance entity and sensor descriptions with availabil…

db5b859

…ity functions Co-authored-by: Copilot <copilot@github.com>

joostlek requested changes May 4, 2026

View reviewed changes

home-assistant Bot marked this pull request as draft May 4, 2026 20:34

joostlek requested changes May 4, 2026

View reviewed changes

feat(catgenie): refactor authentication flow and improve error handling

b6adba8

Co-authored-by: Copilot <copilot@github.com>

Copilot AI review requested due to automatic review settings May 6, 2026 07:39

Copilot started reviewing on behalf of kclif9 May 6, 2026 07:39 View session

Copilot AI reviewed May 6, 2026

View reviewed changes

feat(catgenie): use DOMAIN constant for translation in error handling

cae4a7f

	state_class=SensorStateClass.TOTAL,
	native_unit_of_measurement=PERCENTAGE,
	state_class=SensorStateClass.MEASUREMENT,

Uh oh!

Conversation

kclif9 commented Apr 30, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Proposed change

Type of change

Additional information

Checklist

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Reviewed changes

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Uh oh!

Uh oh!

Uh oh!

Copilot AI Apr 30, 2026

Choose a reason for hiding this comment

Uh oh!

kclif9 Apr 30, 2026

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Uh oh!

Uh oh!

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Uh oh!

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Uh oh!

Copilot AI May 1, 2026

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

joostlek May 4, 2026

Choose a reason for hiding this comment

Uh oh!

kclif9 May 6, 2026

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

home-assistant Bot commented May 4, 2026

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Uh oh!

Uh oh!

Uh oh!

kclif9 commented Apr 30, 2026 •

edited

Loading