Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat(zigbee): Add Analog endpoint device (input, output, value clusters) #10950

Merged
merged 8 commits into from
Feb 20, 2025

Conversation

pwclay
Copy link
Contributor

@pwclay pwclay commented Feb 9, 2025


Description of Change

Adds analog sensor type to the zigbee library

Tests scenarios

Tested on ESP32-C6 & H2 using Arduino 2.3.4 & espressif 3.1.1. Device is visible to Home Assistant using ZHA

The code does not allow the description or units of the sensor to be set. From my limited understanding, it seems this would require a change in esp_zigbee_type.h buried deep in the board specific directories. Assistance improving this would be appreciated.

Related links

N/A

@CLAassistant
Copy link

CLAassistant commented Feb 9, 2025

CLA assistant check
All committers have signed the CLA.

Copy link
Contributor

github-actions bot commented Feb 9, 2025

Warnings
⚠️

Some issues found for the commit messages in this PR:

  • the commit message "add analog sensor modules":
    • summary looks empty
    • type/action looks empty

Please fix these commit messages - here are some basic tips:

  • follow Conventional Commits style
  • correct format of commit message should be: <type/action>(<scope/component>): <summary>, for example fix(esp32): Fixed startup timeout issue
  • allowed types are: change,ci,docs,feat,fix,refactor,remove,revert,test
  • sufficiently descriptive message summary should be between 10 to 72 characters and start with upper case letter
  • avoid Jira references in commit messages (unavailable/irrelevant for our customers)

TIP: Install pre-commit hooks and run this check when committing (uses the Conventional Precommit Linter).

👋 Hello pwclay, we appreciate your contribution to this project!


📘 Please review the project's Contributions Guide for key guidelines on code, documentation, testing, and more.

🖊️ Please also make sure you have read and signed the Contributor License Agreement for this project.

Click to see more instructions ...


This automated output is generated by the PR linter DangerJS, which checks if your Pull Request meets the project's requirements and helps you fix potential issues.

DangerJS is triggered with each push event to a Pull Request and modify the contents of this comment.

Please consider the following:
- Danger mainly focuses on the PR structure and formatting and can't understand the meaning behind your code or changes.
- Danger is not a substitute for human code reviews; it's still important to request a code review from your colleagues.
- Resolve all warnings (⚠️ ) before requesting a review from human reviewers - they will appreciate it.
- To manually retry these Danger checks, please navigate to the Actions tab and re-run last Danger workflow.

Review and merge process you can expect ...


We do welcome contributions in the form of bug reports, feature requests and pull requests.

1. An internal issue has been created for the PR, we assign it to the relevant engineer.
2. They review the PR and either approve it or ask you for changes or clarifications.
3. Once the GitHub PR is approved we do the final review, collect approvals from core owners and make sure all the automated tests are passing.
- At this point we may do some adjustments to the proposed change, or extend it by adding tests or documentation.
4. If the change is approved and passes the tests it is merged into the default branch.

Generated by 🚫 dangerJS against 21a840f

@P-R-O-C-H-Y P-R-O-C-H-Y added the Area: Zigbee Issues and Feature Request about Zigbee label Feb 10, 2025
@P-R-O-C-H-Y P-R-O-C-H-Y self-requested a review February 10, 2025 08:16
Copy link
Contributor

github-actions bot commented Feb 10, 2025

Test Results

 80 files   80 suites   12m 53s ⏱️
 37 tests  35 ✅ 0 💤 2 ❌
215 runs  212 ✅ 0 💤 3 ❌

For more details on these failures, see this check.

Results for commit 21a840f.

♻️ This comment has been updated with latest results.

@P-R-O-C-H-Y
Copy link
Member

Hi @pwclay, I can help with this PR. Can I take over to finish it and also to fix the CI error?

@pwclay
Copy link
Contributor Author

pwclay commented Feb 12, 2025

Hi @P-R-O-C-H-Y thanks for your help in getting to this point. If you would take over it would be appreciated, I am not sure of what is needed to proceed.

Cheers
Pat

@P-R-O-C-H-Y P-R-O-C-H-Y changed the title add analog sensor modules to zigbee feat(zigbee): Add Analog endpoint device (input, output, value clusters) Feb 17, 2025
Copy link
Contributor

github-actions bot commented Feb 17, 2025

Memory usage test (comparing PR against master branch)

The table below shows the summary of memory usage change (decrease - increase) in bytes and percentage for each target.

MemoryFLASH [bytes]FLASH [%]RAM [bytes]RAM [%]
TargetDECINCDECINCDECINCDECINC
ESP32C6000.000.00000.000.00
ESP32H2000.000.00000.000.00
Click to expand the detailed deltas report [usage change in BYTES]
TargetESP32C6ESP32H2
ExampleFLASHRAMFLASHRAM
Zigbee/examples/Zigbee_Analog_Input_Output----
Zigbee/examples/Zigbee_CarbonDioxide_Sensor0000
Zigbee/examples/Zigbee_Color_Dimmable_Light0000
Zigbee/examples/Zigbee_Color_Dimmer_Switch0000
Zigbee/examples/Zigbee_Contact_Switch0000
Zigbee/examples/Zigbee_Dimmable_Light0000
Zigbee/examples/Zigbee_OTA_Client0000
Zigbee/examples/Zigbee_Occupancy_Sensor0000
Zigbee/examples/Zigbee_On_Off_Light0000
Zigbee/examples/Zigbee_On_Off_Switch0000
Zigbee/examples/Zigbee_Pressure_Flow_Sensor0000
Zigbee/examples/Zigbee_Range_Extender0000
Zigbee/examples/Zigbee_Scan_Networks0000
Zigbee/examples/Zigbee_Temp_Hum_Sensor_Sleepy0000
Zigbee/examples/Zigbee_Temperature_Sensor0000
Zigbee/examples/Zigbee_Thermostat0000
Zigbee/examples/Zigbee_Vibration_Sensor0000
Zigbee/examples/Zigbee_Window_Covering0000

@P-R-O-C-H-Y
Copy link
Member

@pwclay Hi, can you take a look? I have added also an Input/Output clusters and fixed some stuff, as reporting analog value attribute is not supported.

@P-R-O-C-H-Y P-R-O-C-H-Y added the Status: Review needed Issue or PR is awaiting review label Feb 19, 2025
@P-R-O-C-H-Y P-R-O-C-H-Y self-assigned this Feb 19, 2025
@P-R-O-C-H-Y P-R-O-C-H-Y removed their request for review February 19, 2025 07:56
Copy link
Collaborator

@SuGlider SuGlider left a comment

Choose a reason for hiding this comment

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

LGTM

@me-no-dev me-no-dev added Status: Pending Merge Pull Request is ready to be merged and removed Status: Review needed Issue or PR is awaiting review labels Feb 19, 2025
@me-no-dev me-no-dev merged commit 9a783a5 into espressif:master Feb 20, 2025
51 of 56 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Area: Zigbee Issues and Feature Request about Zigbee Status: Pending Merge Pull Request is ready to be merged
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants