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): Add Zigbee library #10265

Merged
merged 42 commits into from
Oct 2, 2024
Merged

feat(zigbee): Add Zigbee library #10265

merged 42 commits into from
Oct 2, 2024

Conversation

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

@P-R-O-C-H-Y P-R-O-C-H-Y commented Aug 30, 2024 •
edited by VojtechBartoska
Loading

Description of Change

Introducing Zigbee Arduino library (wrapper for esp-zigbee-sdk).

Tests scenarios

Locally with all included examples.

Related links

Relates to issue #10135
ZB_STRUCT warnings fix espressif/esp-zigbee-sdk#416

@P-R-O-C-H-Y
Initial commit - light bulb + switch working
94cc558
@P-R-O-C-H-Y
Merge remote-tracking branch 'upstream/master' into feature/zigbee-li…
3764810 
…brary
@P-R-O-C-H-Y
Add Thermostat + fix enum
7776aa5
@P-R-O-C-H-Y
Dev update: roles, cb removal, handlers
8ce22e1 
Fixed ep_thermostat to compile successfully
Removed cb from all EP, as it have been removed, virtual methods will be used instead.
Moved zigbee handlers out of Zigbee_core to Zigbee_handlers for better readability.
Fixed zigbeeInit to be bool and return status of initialization for begin function.
Updated examples with edited roles and custom method for on_off light
@P-R-O-C-H-Y
Dev update: implement on/off light and switch methods
3078306 
Implemented basic function calls of switch commands to on/off light:
  lightToggle, lightOn, lightOff, ...
Implemented virtual methods for on/off light that have to be override in user code:
  setOnOff, sceneControl, setOnOffTime, setOffWaitTime
APIs can be changed, still early development.
@P-R-O-C-H-Y
Merge remote-tracking branch 'upstream/master' into feature/zigbee-li…
194693a 
…brary
@P-R-O-C-H-Y
Dev update: Factory reset, names, multiple EPs
14b99db 
Implemented Factory reset of Zigbee device, in order to connect to new network without reflashing/erasing flash
Implemented optional setting for Manufacturer and Model names
Added option to allow endpoint to have multiple endpoint connected -> switch - 2 lights (tested)
Minor sketches update
@P-R-O-C-H-Y
Dev update: Device ID to string
54488a4 
Implemented easy transfer from device it to Device type (0x0000 = ESP_ZB_HA_ON_OFF_SWITCH_DEVICE_ID  -> "General On/Off switch".
@P-R-O-C-H-Y
Implement cmd default response handler
a83f695
@P-R-O-C-H-Y
Remove unused _identify_cluster
06b0700
@P-R-O-C-H-Y
Dev Update: Color DImmable light + switch implemented
ec60ed4 
Implemeted color dimmable light and color dimmer switch HA devices + examples.
Removed unnecessary stored attribute cluster
Renamed on/off light and switch examples
@P-R-O-C-H-Y
Implement Network Scanning
ef1cc89 
Implemented Zigbee network scanning (async) to mostly match WiFi scan APIs.
Added Zigbee_Scan_Networks example
@P-R-O-C-H-Y
Dev Update: Thermostat and Temperature sensor EP
97920df 
Implemeted thermostat and temperature sensor HA devices + examples.
Implemented configure report handler.
Updated READMEs and description of examples.
Minor code updates
@P-R-O-C-H-Y
Merge remote-tracking branch 'upstream/master' into feature/zigbee-li…
459e4df 
…brary
@P-R-O-C-H-Y
fix(): Replace deprecated function
fa716f0
@P-R-O-C-H-Y
Remove ported IDF examples
db01086
@P-R-O-C-H-Y
Update Zigbee examples with new APIs
4d18a8c
@P-R-O-C-H-Y
Dev Update: Version setting, Thermostat fix, ...
fa6267a 
Simplified bounded device print as the structure is common for any EP type
Allowed setting custom app version for EP, default is 0
Small fixes and code updates
@P-R-O-C-H-Y P-R-O-C-H-Y added the Area: Libraries Issue is related to Library support. label Aug 30, 2024
@P-R-O-C-H-Y P-R-O-C-H-Y self-assigned this Aug 30, 2024
@github-actions GitHub Actions
Copy link
Contributor

github-actions bot commented Aug 30, 2024 •
edited
Loading

Warnings
⚠️

Some issues found for the commit messages in this PR:

  • the commit message "Add Thermostat + fix enum":
    • summary looks empty
    • type/action looks empty
  • the commit message "Add check for SOC_IEEE802154_SUPPORTED":
    • summary looks empty
    • type/action looks empty
  • the commit message "Apply suggestions from code review by @lucasssvaz":
    • summary looks empty
    • type/action looks empty
  • the commit message "Change virtual methods to callbacks (TODO)":
    • summary looks empty
    • type/action looks empty
  • the commit message "Dev Update: Color DImmable light + switch implemented":
    • summary looks empty
    • type/action looks empty
  • the commit message "Dev Update: Thermostat and Temperature sensor EP":
    • summary looks empty
    • type/action looks empty
  • the commit message "Dev Update: Version setting, Thermostat fix, ...":
    • summary should not end with a period (full stop)
    • summary looks empty
    • type/action looks empty
  • the commit message "Dev update: Device ID to string":
    • body's lines must not be longer than 100 characters
    • summary looks empty
    • type/action looks empty
  • the commit message "Dev update: Factory reset, names, multiple EPs":
    • body's lines must not be longer than 100 characters
    • summary looks empty
    • type/action looks empty
  • the commit message "Dev update: implement on/off light and switch methods":
    • summary looks empty
    • type/action looks empty
  • the commit message "Dev update: roles, cb removal, handlers":
    • summary looks empty
    • type/action looks empty
  • the commit message "Fill keyworkds.txt, remove unnecessary defines":
    • summary looks empty
    • type/action looks empty
  • the commit message "Fix compilation errors in examples":
    • summary looks empty
    • type/action looks empty
  • the commit message "Ignore false positive unused variable/function":
    • summary looks empty
    • type/action looks empty
  • the commit message "Implement Network Scanning":
    • summary looks empty
    • type/action looks empty
  • the commit message "Implement cmd default response handler":
    • summary looks empty
    • type/action looks empty
  • the commit message "Initial commit - light bulb + switch working":
    • summary looks empty
    • type/action looks empty
  • the commit message "Refactor classes methods + implement Identify command":
    • summary looks empty
    • type/action looks empty
  • the commit message "Remove EP template + add lib to CMakeLists":
    • summary looks empty
    • type/action looks empty
  • the commit message "Remove outdated comments":
    • summary looks empty
    • type/action looks empty
  • the commit message "Remove ported IDF examples":
    • summary looks empty
    • type/action looks empty
  • the commit message "Remove unnecesary defaults defines":
    • summary looks empty
    • type/action looks empty
  • the commit message "Remove unused _identify_cluster":
    • summary looks empty
    • type/action looks empty
  • the commit message "Rename classes to have proper naming":
    • summary looks empty
    • type/action looks empty
  • the commit message "Rename methods, variables + make private/protected":
    • summary looks empty
    • type/action looks empty
  • the commit message "Update READMEs + add openNetwork fucntion":
    • summary looks empty
    • type/action looks empty
  • the commit message "Update Scan networks Readme":
    • summary looks empty
    • type/action looks empty
  • the commit message "Update Zigbee examples with new APIs":
    • summary looks empty
    • type/action looks empty
  • the commit message "Use [[maybe_unused]] instead of #pragma":
    • summary looks empty
    • type/action looks empty
  • the commit message "Use gpio calls for OnOff Light example":
    • summary looks empty
    • type/action looks empty
  • the commit message "fix(): Codespell issues":
    • summary looks too short

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 42 commits (simplifying branch history).
Messages
📖 This PR seems to be quite large (total lines of code: 5267), you might consider splitting it into smaller PRs

👋 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.
- Addressing info messages (📖) is strongly recommended; they're less critical but valuable.
- 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 44f5522

@github-actions GitHub Actions
Copy link
Contributor

github-actions bot commented Aug 30, 2024 •
edited
Loading

Test Results

 41 files   -  74   41 suites   - 74   3m 13s ⏱️ - 1h 33m 7s
 19 tests  -   6   19 ✅  -   5  0 💤 ±0  0 ❌  - 1 
120 runs   - 153  120 ✅  - 152  0 💤 ±0  0 ❌  - 1 

Results for commit 44f5522. ± Comparison against base commit 84ddf0a.

This pull request removes 6 tests. 
performance.coremark.test_coremark ‑ test_coremark
performance.fibonacci.test_fibonacci ‑ test_fibonacci
performance.psramspeed.test_psramspeed ‑ test_psramspeed
performance.ramspeed.test_ramspeed ‑ test_ramspeed
performance.superpi.test_superpi ‑ test_superpi
validation.periman.test_periman ‑ test_periman

♻️ This comment has been updated with latest results.

@lucasssvaz lucasssvaz changed the title feat(): Zigbee library feat(zigbee): Add Zigbee library Aug 30, 2024
@Jason2866
Copy link
Collaborator

First like the great work you are doing!
But adding "everything" possible to the Arduino core? It is a library. It is not a lib every esp32 MCU can use. Imho it should be considered not to add to the core. Arduino has the possibility to use librarys. Maybe an option to use the Espressif registry?

@lucasssvaz lucasssvaz mentioned this pull request Aug 30, 2024
Merged
lucasssvaz
lucasssvaz approved these changes Sep 26, 2024
View reviewed changes
Copy link
Collaborator

@lucasssvaz lucasssvaz left a comment •
edited
Loading

Choose a reason for hiding this comment

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

Very nice. Looks very intuitive to use. Just some small suggestions. BTW. Shouldn't this target branch release/v3.1.x according to what was presented in the community meeting ?

@me-no-dev
Copy link
Member

much cleaner now :) just one small nitpick for the on/off light

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

Very nice. Looks very intuitive to use. Just some small suggestions. BTW. Shouldn't this target branch release/v3.1.x according to what was presented in the community meeting ?

@me-no-dev Should I change the target branch to 3.1?

@me-no-dev
Copy link
Member

Should I change the target branch to 3.1?

I see no reason why not to have it in the 3.0 if we decide to publish another version

@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 Oct 1, 2024
@P-R-O-C-H-Y P-R-O-C-H-Y force-pushed the feature/zigbee-library branch 2 times, most recently from 8c15603 to 172dd0f Compare October 2, 2024 11:02
@me-no-dev me-no-dev merged commit 473b851 into espressif:master Oct 2, 2024
48 checks passed
@Hedda Hedda mentioned this pull request Oct 8, 2024
Open
@HamzaHajeir HamzaHajeir mentioned this pull request Nov 5, 2024
Closed
3 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@elgerg elgerg elgerg left review comments

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

@lucasssvaz lucasssvaz lucasssvaz approved these changes

@SuGlider SuGlider Awaiting requested review from SuGlider

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
Development

Successfully merging this pull request may close these issues.
6 participants
@P-R-O-C-H-Y @Jason2866 @me-no-dev @elgerg @lucasssvaz @VojtechBartoska