Skip to content

feat(zigbee): Add support for Binary input EP + Analog EP extension #11339

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

Open
wants to merge 3 commits into
base: master
Choose a base branch
from

Conversation

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

@P-R-O-C-H-Y P-R-O-C-H-Y commented May 5, 2025

Description of Change

This PR adds support for Zigbee Binary Input EP + example.
Also adds description and application_type attributes for Analog EP class. Those 2 new attributes are mandatory for ZHA for the device to be shown correctly.

Tests scenarios

Tested using included examples and HA with a ZHA dev branch as the AnalogInput+BinaryInput changes are pending for the 2025.5.0 version or later.

Related links

@P-R-O-C-H-Y P-R-O-C-H-Y added the Area: Zigbee Issues and Feature Request about Zigbee label May 5, 2025
@P-R-O-C-H-Y P-R-O-C-H-Y added this to the 3.3.0 milestone May 5, 2025
@P-R-O-C-H-Y P-R-O-C-H-Y self-assigned this May 5, 2025
@P-R-O-C-H-Y P-R-O-C-H-Y moved this from Done to In Review in Arduino ESP32 Core Project Roadmap May 5, 2025
Copy link
Contributor

github-actions bot commented May 5, 2025

Warnings
⚠️

Some issues found for the commit messages in this PR:

  • the commit message "Apply suggestions from code review":
    • 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 P-R-O-C-H-Y, 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 6392dd3

@P-R-O-C-H-Y P-R-O-C-H-Y added the Status: Review needed Issue or PR is awaiting review label May 5, 2025
Copy link
Contributor

github-actions bot commented May 5, 2025

Test Results

 76 files   76 suites   12m 44s ⏱️
 38 tests  38 ✅ 0 💤 0 ❌
241 runs  241 ✅ 0 💤 0 ❌

Results for commit 6392dd3.

♻️ This comment has been updated with latest results.

Copy link
Contributor

@Copilot Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull Request Overview

This PR extends the Zigbee library by adding a new Zigbee Binary Endpoint and enhancing the Analog Endpoint with mandatory attributes needed by ZHA. Key changes include the implementation of binary input support, the addition of application type, description, and resolution attributes for analog clusters, and corresponding updates to examples and documentation.

Reviewed Changes

Copilot reviewed 8 out of 10 changed files in this pull request and generated 2 comments.

Show a summary per file
File Description
libraries/Zigbee/src/ep/ZigbeeBinary.h Introduces the Binary Endpoint header (note: update internal comment to correctly refer to a binary sensor).
libraries/Zigbee/src/ep/ZigbeeBinary.cpp Implements binary cluster functions; error message text inconsistency observed in setBinaryInputApplication.
libraries/Zigbee/src/ep/ZigbeeAnalog.h Adds new API prototypes for setting analog application type, description, and resolution.
libraries/Zigbee/src/ep/ZigbeeAnalog.cpp Updates Analog Endpoint functionality by adding extra mandatory attributes and cluster handling.
libraries/Zigbee/src/Zigbee.h Updates include list to add the new Zigbee Binary Endpoint.
libraries/Zigbee/examples/Zigbee_Binary_Input/*.ino and README.md Demonstrates usage of the new binary endpoint.
libraries/Zigbee/examples/Zigbee_Analog_Input_Output/*.ino Shows extended analog input/output examples with new attribute settings.
Files not reviewed (2)
  • CMakeLists.txt: Language not supported
  • libraries/Zigbee/examples/Zigbee_Binary_Input/ci.json: Language not supported

P-R-O-C-H-Y and others added 2 commits May 5, 2025 17:11
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
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: Review needed Issue or PR is awaiting review
Projects
Status: In Review
Development

Successfully merging this pull request may close these issues.

2 participants