Migrate Aqara pet feeder ACN001 to quirks v2 by iamjoshk · Pull Request #5296 · zigpy/zha-device-handlers

iamjoshk · 2026-09-01T21:07:20Z

Proposed change

PR for the migration to quirks v2 for the Aqara Pet Feeder ACN001.
This will also allow for the feeder entities in ZHA to be removed, in PR zigpy/zha#883
Split from this PR: #5294

Additional information

This prepares for changes in ZHA mentioned here: zigpy/zha#705

Device diagnostics

{
  "node_descriptor": {
    "logical_type": 1,
    "complex_descriptor_available": 0,
    "user_descriptor_available": 0,
    "reserved": 0,
    "aps_flags": 0,
    "frequency_band": 8,
    "mac_capability_flags": 142,
    "manufacturer_code": 4447,
    "maximum_buffer_size": 82,
    "maximum_incoming_transfer_size": 255,
    "server_mask": 11264,
    "maximum_outgoing_transfer_size": 255,
    "descriptor_capability_field": 0
  },
  "endpoints": {
    "1": {
      "profile_id": "0x0104",
      "device_type": "0x0002",
      "input_clusters": [
        "0x0000",
        "0x0003",
        "0x0004",
        "0x0005",
        "0xfcc0"
      ],
      "output_clusters": [
        "0x0003",
        "0x0019"
      ]
    },
    "242": {
      "profile_id": "0xa1e0",
      "device_type": "0x0061",
      "input_clusters": [],
      "output_clusters": [
        "0x0021"
      ]
    }
  },
  "manufacturer": "Aqara",
  "model": "aqara.feeder.acn001",
  "class": "feeder_acn001_v2_base:(None / aqara.feeder.acn001)"
}

Updated with the diagnostics from the existing quirk:
zha-diagnostics-Aqara_aqara.feeder.acn001.json

Checklist

The changes are tested and work correctly
pre-commit checks pass / the code has been formatted using Black
Tests have been added to verify that the new code works
Device diagnostics data has been attached

codecov · 2026-09-01T21:09:03Z

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 92.60%. Comparing base (6a3822c) to head (8764556).

Additional details and impacted files

@@            Coverage Diff             @@
##              dev    #5296      +/-   ##
==========================================
- Coverage   92.60%   92.60%   -0.01%     
==========================================
  Files         424      424              
  Lines       14667    14665       -2     
==========================================
- Hits        13582    13580       -2     
  Misses       1085     1085

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

🚀 New features to boost your workflow:

❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

Copilot

🟡 Changes recommended

The migration drops the previously injected Time cluster behavior (and needs corresponding v2 handling), which risks a functional regression for devices relying on time sync for scheduling.

Once you've addressed the issues Copilot identified, you can request another Copilot review.

Pull request overview

This PR migrates the Aqara Pet Feeder ACN001 quirk from a legacy v1 CustomDevice implementation to a quirks v2 QuirkBuilder definition in zhaquirks, and updates the Xiaomi test suite to construct the device using the v2 quirk fixture.

Changes:

Replace the v1 AqaraFeederAcn001 device definition with a v2 QuirkBuilder registration and explicit entity exposures.
Update feeder enums to include Schedule and rename Remote → HomeAssistant.
Adjust tests to use zigpy_device_from_v2_quirk and validate the updated enum name.

File summaries

File	Description
zhaquirks/xiaomi/aqara/feeder_acn001.py	Migrates the feeder to quirks v2 and defines exposed entities via `QuirkBuilder`.
tests/test_xiaomi.py	Updates tests to instantiate the feeder via v2 quirk construction and align expected enum values.

Review details

Suppressed comments (1)

zhaquirks/xiaomi/aqara/feeder_acn001.py:273

This migration drops the previously injected Time cluster (the old v1 replacement explicitly added Time.cluster_id). If the feeder relies on the Time cluster for time sync (important for onboard scheduling), this will be a behavioral regression after migrating to v2.

    .friendly_name(manufacturer="Aqara", model="aqara.feeder.acn001")
    .removes(OnOff.cluster_id)
    .replaces(OppleCluster)
    .enum(
        attribute_name=OppleCluster.AttributeDefs.last_feeding_source.name,

Files reviewed: 2/2 changed files
Comments generated: 2
Review effort level: Lite

💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.

Copilot

🟢 Approval recommended

The v2 migration is consistent with existing quirks v2 patterns and the updated tests cover the changed behavior and API surface used by this quirk.

Review details

Files reviewed: 2/2 changed files
Comments generated: 0 new
Review effort level: Lite

Copilot

🟡 Changes recommended

The updated tests don’t currently exercise the real-world “manufacturer is missing” pairing scenario that the v2 quirk explicitly relies on.

Once you've addressed the issues Copilot identified, you can request another Copilot review.

Review details

Suppressed comments (1)

tests/test_xiaomi.py:1230

Same as above: this test uses manufacturer="Aqara", but the device/quirk pairing scenario described in the quirk is that manufacturer is missing during interview. Use None here to ensure quirk resolution continues to work in that case.

    device = zigpy_device_from_v2_quirk(
        "Aqara",
        "aqara.feeder.acn001",
        cluster_ids={

Files reviewed: 2/2 changed files
Comments generated: 1
Review effort level: Lite

… during interview

Copilot

🟡 Changes recommended

A new v2 sensor is declared with TOTAL_INCREASING but without a unit/device_class, which is inconsistent with existing usage and may cause HA statistics/validation issues.

Once you've addressed the issues Copilot identified, you can request another Copilot review.

Review details

Files reviewed: 2/2 changed files
Comments generated: 1
Review effort level: Lite

iamjoshk · 2026-09-03T15:12:31Z

+    .sensor(
+        attribute_name=OppleCluster.AttributeDefs.portions_dispensed.name,
+        cluster_id=OppleCluster.cluster_id,
+        state_class=SensorStateClass.TOTAL_INCREASING,


state_class=SensorStateClass.TOTAL_INCREASING for portions_dispensed and weight_dispensed matches the existing legacy entities in ZHA.

Thinking about this, I could add unit="portions" and keep the legacy state_class=SensorStateClass.TOTAL_INCREASING

.sensor( attribute_name=OppleCluster.AttributeDefs.portions_dispensed.name, cluster_id=OppleCluster.cluster_id, state_class=SensorStateClass.TOTAL_INCREASING, unit="portions", unique_id_suffix=f"{OppleCluster.cluster_id}-portions_dispensed", translation_key="portions_dispensed_today", fallback_name="Portions dispensed today", )

inomdzhon · 2026-09-04T22:13:42Z

Wait it 🥹 Thanks 🙏🙏🙏

Copilot

🟢 Approval recommended

The migration to quirks v2 and the corresponding test updates are coherent, self-contained, and consistent with the PR’s stated goal.

Review details

Files reviewed: 2/2 changed files
Comments generated: 0 new
Review effort level: Lite

iamjoshk added 2 commits September 1, 2026 16:30

migrate feeder_acn001 to quirk v2

622b5cc

migrate Aqara feeder_acn001 to quirk v2

770bd1b

iamjoshk mentioned this pull request Sep 1, 2026

Migrate Aqara pet feeder ACN001 to quirks v2 and add onboard scheduling #5294

Draft

4 tasks

iamjoshk marked this pull request as ready for review September 1, 2026 21:21

Copilot AI lite review requested due to automatic review settings September 1, 2026 21:21

Copilot started reviewing on behalf of iamjoshk September 1, 2026 21:22 View session

Copilot AI reviewed Sep 1, 2026

View reviewed changes

Comment thread zhaquirks/xiaomi/aqara/feeder_acn001.py

Comment thread zhaquirks/xiaomi/aqara/feeder_acn001.py Outdated

replace Time cluster in feeder_acn001

2368891

Copilot AI review requested due to automatic review settings September 1, 2026 21:41

Copilot started reviewing on behalf of iamjoshk September 1, 2026 21:41 View session

iamjoshk mentioned this pull request Sep 1, 2026

Remove Aqara Pet Feeder "legacy" quirks from ZHA zigpy/zha#883

Draft

Copilot AI reviewed Sep 1, 2026

View reviewed changes

replacing unique_id_suffix magic numbers

f0805e2

Copilot AI review requested due to automatic review settings September 3, 2026 14:08

Copilot started reviewing on behalf of iamjoshk September 3, 2026 14:09 View session

Copilot AI reviewed Sep 3, 2026

View reviewed changes

Comment thread tests/test_xiaomi.py

validate aqara.feeder.acn001 resolves since no manufacturer is passed…

86c6ee4

… during interview

Copilot AI review requested due to automatic review settings September 3, 2026 14:42

Copilot started reviewing on behalf of iamjoshk September 3, 2026 14:43 View session

Copilot AI reviewed Sep 3, 2026

View reviewed changes

adding portions units

8764556

Copilot AI review requested due to automatic review settings September 7, 2026 17:22

Copilot started reviewing on behalf of iamjoshk September 7, 2026 17:23 View session

Copilot AI reviewed Sep 7, 2026

View reviewed changes

Navigation Menu

Uh oh!

Migrate Aqara pet feeder ACN001 to quirks v2 - #5296

Migrate Aqara pet feeder ACN001 to quirks v2#5296
iamjoshk wants to merge 6 commits into
zigpy:devfrom
iamjoshk:iamjoshk-feeder_acn001-v2-migration

iamjoshk commented Sep 1, 2026 •

edited

Loading

Uh oh!

codecov Bot commented Sep 1, 2026 •

edited

Loading

Uh oh!

Copilot AI left a comment

Uh oh!

Uh oh!

Uh oh!

Copilot AI left a comment

Uh oh!

Copilot AI left a comment

Uh oh!

Uh oh!

Copilot AI left a comment

Uh oh!

iamjoshk Sep 3, 2026

Uh oh!

iamjoshk Sep 6, 2026

Uh oh!

inomdzhon commented Sep 4, 2026

Uh oh!

Copilot AI left a comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

Uh oh!

Conversation

iamjoshk commented Sep 1, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Proposed change

Additional information

Device diagnostics

Checklist

Uh oh!

codecov Bot commented Sep 1, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Codecov Report

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

🟡 Changes recommended

Suppressed comments (1)

Uh oh!

Uh oh!

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

🟢 Approval recommended

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

🟡 Changes recommended

Suppressed comments (1)

Uh oh!

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

🟡 Changes recommended

Uh oh!

iamjoshk Sep 3, 2026

Choose a reason for hiding this comment

Uh oh!

iamjoshk Sep 6, 2026

Choose a reason for hiding this comment

Uh oh!

inomdzhon commented Sep 4, 2026

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

🟢 Approval recommended

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

iamjoshk commented Sep 1, 2026 •

edited

Loading

codecov Bot commented Sep 1, 2026 •

edited

Loading