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.

Sign up for GitHub

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

Jump to bottom

feat(Zigbee): Support for sleepy device + Power Source and battery level + Humidity sensor cluster #10551

Merged
merged 10 commits into from
Nov 6, 2024
Merged

feat(Zigbee): Support for sleepy device + Power Source and battery level + Humidity sensor cluster #10551

merged 10 commits into from
Nov 6, 2024

Conversation

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

@P-R-O-C-H-Y P-R-O-C-H-Y commented Nov 1, 2024 •
edited
Loading

Description of Change

This PR includes:

  • Support for sleepy device (only deep-sleep is currently possible).
  • Support for selecting power source for the device. If battery is selected, the remaining percentage can be updated.
  • Support for Humidity cluster, which was added as optional for the Temperature sensor as there is no HA Device type for humidity sensor.
  • New example Zigbee_Temp_Hum_Sensor_Sleepy, which demonstrates all the new functionalities
  • Mirror fixes and improvements

Tests scenarios

Tested with the example Zigbee_Temp_Hum_Sensor_Sleepy on both C6/H2 which connects to the Zigbee network.
Coordinator used - SONOFF ZBDongle-E which is configured in the Home Assistant which runs on VM.

Related links

Closes #10405
Closes #10430

@P-R-O-C-H-Y P-R-O-C-H-Y added the Area: Libraries Issue is related to Library support. label Nov 1, 2024
@P-R-O-C-H-Y P-R-O-C-H-Y self-assigned this Nov 1, 2024
@github-actions GitHub Actions
Copy link
Contributor

github-actions bot commented Nov 1, 2024 •
edited
Loading

Warnings
⚠️

Some issues found for the commit messages in this PR:

  • the commit message "feat(zigbee) Add humidity optional cluster + fixes":
    • 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 20 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).
⚠️ Please consider squashing your 10 commits (simplifying branch history).

👋 Hello P-R-O-C-H-Y, we appreciate your contribution to 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 5cb991f

@P-R-O-C-H-Y P-R-O-C-H-Y mentioned this pull request Nov 1, 2024
Open
17 tasks
@github-actions GitHub Actions
Copy link
Contributor

github-actions bot commented Nov 1, 2024

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
ESP32C60⚠️ +740.00⚠️ +0.020⚠️ +160.00⚠️ +0.05
ESP32H20⚠️ +740.00⚠️ +0.010⚠️ +160.00⚠️ +0.05
Click to expand the detailed deltas report [usage change in BYTES]
TargetESP32C6ESP32H2
ExampleFLASHRAMFLASHRAM
Zigbee/examples/Zigbee_Color_Dimmable_Light⚠️ +66⚠️ +16⚠️ +68⚠️ +16
Zigbee/examples/Zigbee_Color_Dimmer_Switch⚠️ +680⚠️ +680
Zigbee/examples/Zigbee_On_Off_Light⚠️ +720⚠️ +720
Zigbee/examples/Zigbee_On_Off_Switch⚠️ +66⚠️ +16⚠️ +640
Zigbee/examples/Zigbee_Scan_Networks⚠️ +740⚠️ +740
Zigbee/examples/Zigbee_Temp_Hum_Sensor_Sleepy----
Zigbee/examples/Zigbee_Temperature_Sensor⚠️ +72⚠️ +16⚠️ +720
Zigbee/examples/Zigbee_Thermostat⚠️ +64⚠️ +16⚠️ +640

@github-actions GitHub Actions
Copy link
Contributor

github-actions bot commented Nov 1, 2024 •
edited
Loading

Test Results

 56 files   56 suites   4m 18s ⏱️
 21 tests  21 ✅ 0 💤 0 ❌
134 runs  134 ✅ 0 💤 0 ❌

Results for commit 5cb991f.

♻️ This comment has been updated with latest results.

@P-R-O-C-H-Y P-R-O-C-H-Y added the Status: Review needed Issue or PR is awaiting review label Nov 1, 2024
@me-no-dev
Copy link
Member

Please create a Zigbee.h header that includes all other headers and would be the only required header to include

SuGlider
SuGlider reviewed Nov 5, 2024
View reviewed changes
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. Just a few suggestion.

lucasssvaz
lucasssvaz approved these changes Nov 5, 2024
View reviewed changes
Copy link
Collaborator

@lucasssvaz lucasssvaz left a comment

Choose a reason for hiding this comment

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

LGTM

@SuGlider SuGlider self-requested a review November 6, 2024 00:04
@P-R-O-C-H-Y P-R-O-C-H-Y added Status: Pending Merge Pull Request is ready to be merged and removed Status: Review needed Issue or PR is awaiting review labels Nov 6, 2024
@me-no-dev me-no-dev merged commit d1df696 into espressif:master Nov 6, 2024
45 of 47 checks passed
@P-R-O-C-H-Y P-R-O-C-H-Y mentioned this pull request Nov 14, 2024
Closed
1 task
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@me-no-dev me-no-dev me-no-dev left review comments

@SuGlider SuGlider SuGlider approved these changes

@lucasssvaz lucasssvaz lucasssvaz approved these changes

Assignees

@P-R-O-C-H-Y P-R-O-C-H-Y

Labels
Area: Libraries Issue is related to Library support. Status: Pending Merge Pull Request is ready to be merged
Projects
None yet
Milestone
No milestone
4 participants
@P-R-O-C-H-Y @me-no-dev @lucasssvaz @SuGlider