Add support for Aqara external temperature sensor #3974

Antoninj · 2025-03-23T19:23:24Z

Proposed change

Support for external temperature sensor.

Additional information

This is a copy of #2802 + the missing unit tests

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

codecov · 2025-03-23T19:24:51Z

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 91.33%. Comparing base (2fd3586) to head (c75465e).
Report is 49 commits behind head on dev.

Additional details and impacted files

@@            Coverage Diff             @@
##              dev    #3974      +/-   ##
==========================================
+ Coverage   91.04%   91.33%   +0.28%     
==========================================
  Files         331      339       +8     
  Lines       10698    11029     +331     
==========================================
+ Hits         9740    10073     +333     
+ Misses        958      956       -2

☔ View full report in Codecov by Sentry.
📢 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.

…r' into aqara_external_temperature_sensor

TheJulianJES

Thanks for adding the tests. I think this looks pretty good already.

TheJulianJES · 2025-03-26T05:49:38Z

zhaquirks/xiaomi/aqara/thermostat_agl001.py

+            SENSOR_TEMP: ("sensor_temp", t.uint32_t, True),
+            SENSOR_ATTR: (SENSOR_ATTR_NAME, t.LVBytes, True),


All these attributes should really be converted to the new zigpy AttributeDefs style. Search AttributeDefs in this repo or the zigpy repo for examples.
You don't have to do it in this PR, but it would be nice.

We can also access the name and id then: AqaraThermostatSpecificCluster.AttributeDefs.sensor_temp.name or .id.

I hear you but I honestly don't have much time to spend on this PR atm and multiple people have been emailing me to track progress on this change since it's a highly requested feature for the quirk.

This is quite some time ago. I would like to help in this case.

I found that this PR is not up to date with the upstream.
In the upstream I see that the AttributeDefs are already defined.
So it is, I believe, straight forward to do this change.

Unfortunately, I don't know how I can collaborate on this PR.

@Antoninj - I believe you can do that quite easily by doing the following:

Sync the fork (dev branch) with your the upstream (on GitHub you can do that easily)

Pull the updated dev branch to your local machine (e.g. git checkout dev and then git pull)

Now you can rebase the branch aqara_external_temperature_sensor onto dev branch (or merge dev branch into your branch)

You will have merge conflicts, which are easily resolved:

The test file is new and is not affected

The file thermostat_agl001.py is already in the new style and you should keep the code of your branch, except the changes of the attributes. These are already in the new style and you need to add those two lines I believe:

sensor_temp: Final = ZCLAttributeDef( id=SENSOR_TEMP, type=t.uint32_t, is_manufacturer_specific=True ) sensor_attr: Final = ZCLAttributeDef( id=SENSOR_ATTR, type=t.LVBytes, is_manufacturer_specific=True )

The tests run fine when I tried it.

However, there is the comment of NJLangley, which needs to be addressed. I am trying to look into that. As I am still quite "new" I try to learn und understand what is meant by the comment.

If you feel that you do not have time, I could replicate this PR and do the changes.
Let me know if that is ok for you.

zhaquirks/xiaomi/aqara/thermostat_agl001.py

TheJulianJES · 2025-03-26T06:26:26Z

zhaquirks/xiaomi/aqara/thermostat_agl001.py

+                    attrs1 = {}
+                    attrs1[SENSOR_ATTR_NAME] = (
+                        self.aqaraHeader(0x12, params1, 0x04) + params1
+                    )
+                    attrs[SENSOR_ATTR_NAME] = (
+                        self.aqaraHeader(0x13, params2, 0x04) + params2
+                    )
+
+                    await super().write_attributes(attrs1, manufacturer)


So these need to be written in separate calls?

I honestly have no idea, I bootstrapped this PR from existing work from someone else and mostly focused on addding unit tests tbh

They need to be in separate calls otherwise its starts to misbehave

My guess is that two separate calls is necessary, otherwise it would not work correctly.
I conclude that there is nothing to do then.

README.md

…nsor - Move SENSOR_ID constant outside write_attributes method for efficiency - Use bytes(12) instead of long lists of zeros for cleaner code - Improve attribute handling with find_attribute for better robustness - Add proper type annotations for better code clarity - Update README.md to reference requirements_test_all.txt - Run ruff formatting

…e review suggestion)

Antoninj · 2025-06-29T15:34:31Z

@TheJulianJES thanks for the detailed code review, I've addressed most of the remarks.

NJLangley · 2025-09-15T15:18:46Z

zhaquirks/xiaomi/aqara/thermostat_agl001.py

+                    self._float_to_hex(round(float(value)))[2:]
+                )
+
+                params = SENSOR_ID


This seems to break the quirk for me. I can set the TRV into external sensor mode once and set the temp, but all subsequent calls fail and it seems that the max size of the constructed message is exceeded.

It's because the SENSOR_ID variable is not copied, so appending more bytes to the params variable is modifying SENSOR_ID, which means it's then bigger to start with the next time it's run. Changing the line to

params = bytearray(SENSOR_ID)

seems to fix it for me. Might want the tests to check the length of the message args for two subsequent calls to verify this?

I tried the suggestion you mentioned and wrote a test for this to avoid regression.

I hope to revceive an answer from @Antoninj in regard to collaborate on this PR or if I re-create the PR with the changes.

NJLangley · 2025-09-15T15:23:27Z

I was having some issues with this, as it worked for the first call to set the mode to external sensor and then set the temp, but for all subsequent calls until the ZHA integrations was reloaded then failed. Digging through the stack trace for the error suggests the message exceeded the size of the window used for Zigbee comms.

The original quirk from #2802 does work, and I've left a comment on the line that needs fixing. Looks like it's not copying the byte array before building the message from it, so it's them broken when it builds the next message

Elyasin · 2025-11-03T20:53:17Z

I created a new PR that continues Antonin's work with the review comments taken into account. I added two test cases and did little refactoring, which I believe helps read the code better.

#4463

Antoninj and others added 7 commits March 16, 2025 23:09

update existing quirk based on zigpy#2802

99a74e8

add test

2533f72

fix README.md

95d6a84

fix tests

b575481

Merge branch 'dev' into aqara_external_temperature_sensor

d86ae42

fix tests

c71e416

Apply pre-commit auto fixes

bff88ba

Antoninj changed the title ~~Aqara external temperature sensor~~ Add support for Aqara external temperature sensor Mar 23, 2025

Antoninj mentioned this pull request Mar 23, 2025

Aqara E1 thermostat external temperature sensor #2802

Open

3 tasks

Antoninj added 3 commits March 23, 2025 20:54

fix linting issues

2f10430

Merge remote-tracking branch 'origin/aqara_external_temperature_senso…

86584c6

…r' into aqara_external_temperature_sensor

renaming

930eb02

TheJulianJES added Xiaomi Request/PR regarding a Xiaomi or Aqara device needs review This PR should be reviewed soon, as it generally looks good. labels Mar 26, 2025

TheJulianJES reviewed Mar 26, 2025

View reviewed changes

TheJulianJES added waiting for changes Waiting for changes to the PR and removed needs review This PR should be reviewed soon, as it generally looks good. labels Apr 29, 2025

Antoninj added 2 commits June 29, 2025 17:13

Rename aqaraHeader to aqara_header for Python naming conventions (cod…

c75465e

…e review suggestion)

Antoninj requested a review from TheJulianJES June 29, 2025 15:34

NJLangley reviewed Sep 15, 2025

View reviewed changes

Elyasin mentioned this pull request Nov 3, 2025

Supports external temp sensor for Aqara E1 TRV (continues PR#3974) #4463

Open

3 tasks

		SENSOR_TEMP: ("sensor_temp", t.uint32_t, True),
		SENSOR_ATTR: (SENSOR_ATTR_NAME, t.LVBytes, True),

Add support for Aqara external temperature sensor #3974

Are you sure you want to change the base?

Add support for Aqara external temperature sensor #3974

Uh oh!

Conversation

Antoninj commented Mar 23, 2025

Proposed change

Additional information

Checklist

Uh oh!

codecov bot commented Mar 23, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Codecov Report

Uh oh!

TheJulianJES left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Antoninj commented Jun 29, 2025

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

NJLangley commented Sep 15, 2025

Uh oh!

Elyasin commented Nov 3, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants

codecov bot commented Mar 23, 2025 •

edited

Loading

Elyasin commented Nov 3, 2025 •

edited

Loading