feat(zigbee): Add Zigbee library #10265

P-R-O-C-H-Y · 2024-08-30T12:48:20Z

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

…brary

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

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.

…brary

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

Implemented easy transfer from device it to Device type (0x0000 = ESP_ZB_HA_ON_OFF_SWITCH_DEVICE_ID -> "General On/Off switch".

Implemeted color dimmable light and color dimmer switch HA devices + examples. Removed unnecessary stored attribute cluster Renamed on/off light and switch examples

Implemented Zigbee network scanning (async) to mostly match WiFi scan APIs. Added Zigbee_Scan_Networks example

Implemeted thermostat and temperature sensor HA devices + examples. Implemented configure report handler. Updated READMEs and description of examples. Minor code updates

…brary

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

github-actions · 2024-08-30T12:48:56Z

	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 `"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 `"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 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 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 33 commits (simplifying branch history).

	Messages
📖	This PR seems to be quite large (total lines of code: 5254), 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 9a354ae

github-actions · 2024-08-30T12:55:34Z

Test Results

56 files - 83 56 suites - 83 4m 40s ⏱️ - 1h 37m 48s
21 tests - 9 21 ✅ - 9 0 💤 ±0 0 ❌ ±0
135 runs - 168 135 ✅ - 168 0 💤 ±0 0 ❌ ±0

Results for commit 9a354ae. ± Comparison against base commit cbe0f2f.

This pull request removes 9 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
test_touch_errors
test_touch_interrtupt
test_touch_read
validation.periman.test_periman ‑ test_periman

♻️ This comment has been updated with latest results.

libraries/Zigbee/src/Zigbee_core.h

Jason2866 · 2024-08-30T15:48:54Z

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?

…-Y/arduino-esp32 into feature/zigbee-library

me-no-dev · 2024-09-16T09:39:23Z

libraries/Zigbee/examples/Zigbee_Color_Dimmable_Light/Zigbee_Color_Dimmable_Light.ino

+      if((millis() - startTime) > 3000) {
+        // If key pressed for more than 3secs, factory reset Zigbee and reboot
+        Serial.printf("Reseting Zigbee to factory settings, reboot.\n");
+        Zigbee.factoryReset();


maybe break here?

No need, the Zigbee.factoryReset(); will reboot the device.

me-no-dev · 2024-09-16T09:47:14Z

libraries/Zigbee/examples/Zigbee_On_Off_Light/Zigbee_On_Off_Light.ino

+      if((millis() - startTime) > 3000) {
+        // If key pressed for more than 3secs, factory reset Zigbee and reboot
+        Serial.printf("Reseting Zigbee to factory settings, reboot.\n");
+        Zigbee.factoryReset();


or wait for the button to be released

No need, the Zigbee.factoryReset(); will reboot the device.

me-no-dev · 2024-09-16T09:49:37Z

libraries/Zigbee/examples/Zigbee_On_Off_Switch/Zigbee_On_Off_Switch.ino

+      //Do what you want with the model string
+      Serial.printf("Model: %s\n", model);
+    }
+};


is this class required here, if it's only to read manufacturer and model?

It's not required there, I just wanted to have it implemented in some example so users can see how to use it if they want to. I can remove it if you prefer, as its not necessary for the example.

libraries/Zigbee/examples/Zigbee_On_Off_Switch/Zigbee_On_Off_Switch.ino

me-no-dev · 2024-09-16T10:03:04Z

Overall I like it, but take action to format the examples properly as I noted on one of them.

P-R-O-C-H-Y added 18 commits June 28, 2024 16:28

Initial commit - light bulb + switch working

94cc558

Merge remote-tracking branch 'upstream/master' into feature/zigbee-li…

3764810

…brary

Add Thermostat + fix enum

7776aa5

Merge remote-tracking branch 'upstream/master' into feature/zigbee-li…

194693a

…brary

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".

Implement cmd default response handler

a83f695

Remove unused _identify_cluster

06b0700

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

Implement Network Scanning

ef1cc89

Implemented Zigbee network scanning (async) to mostly match WiFi scan APIs. Added Zigbee_Scan_Networks example

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

Merge remote-tracking branch 'upstream/master' into feature/zigbee-li…

459e4df

…brary

fix(): Replace deprecated function

fa716f0

Remove ported IDF examples

db01086

Update Zigbee examples with new APIs

4d18a8c

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 added the Area: Libraries Issue is related to Library support. label Aug 30, 2024

P-R-O-C-H-Y self-assigned this Aug 30, 2024

Remove EP template + add lib to CMakeLists

7693a16

me-no-dev reviewed Aug 30, 2024

View reviewed changes

libraries/Zigbee/src/Zigbee_core.h Outdated Show resolved Hide resolved

lucasssvaz changed the title ~~feat(): Zigbee library~~ feat(zigbee): Add Zigbee library Aug 30, 2024

lucasssvaz force-pushed the feature/zigbee-library branch from e6f2769 to 7693a16 Compare August 30, 2024 15:49

lucasssvaz mentioned this pull request Aug 30, 2024

ci(push): Use FQBN from ci.json #10267

Merged

P-R-O-C-H-Y added 2 commits September 2, 2024 06:35

Merge branch 'master' into feature/zigbee-library

7312de3

Rename classes to have proper naming

95ff61b

Fill keyworkds.txt, remove unnecessary defines

4edfb8c

Hedda mentioned this pull request Sep 6, 2024

Look into if could make use of new Zigbee Wrapper library and API for Arduino? luar123/zigbee_esphome#9

Open

P-R-O-C-H-Y added 3 commits September 10, 2024 14:41

Rename methods, variables + make private/protected

6e220ec

Remove unnecesary defaults defines

4eb37aa

Merge branch 'master' into feature/zigbee-library

39633f1

P-R-O-C-H-Y added Status: Review needed Issue or PR is awaiting review and removed Status: In Progress Issue is in progress labels Sep 10, 2024

P-R-O-C-H-Y requested review from me-no-dev, SuGlider and lucasssvaz September 10, 2024 12:52

P-R-O-C-H-Y added 3 commits September 10, 2024 14:57

Remove outdated comments

59335bb

Merge branch 'feature/zigbee-library' of https://github.com/P-R-O-C-H…

9a771b8

…-Y/arduino-esp32 into feature/zigbee-library

Update Scan networks Readme

2fdeef7

P-R-O-C-H-Y mentioned this pull request Sep 12, 2024

Implement Zigbee in Arduino #10135

Open

17 tasks

me-no-dev reviewed Sep 16, 2024

View reviewed changes