feat(docs): Add Zigbee library API documentation #11525

P-R-O-C-H-Y · 2025-06-27T12:03:56Z

Description of Change

This pull request adds documentation for new Zigbee library, expanding the API coverage.

Added Zigbee APIs to Table of Contents: Included a new section in libraries.rst that organizes Zigbee-related APIs under their own subsection, improving navigation and discoverability.

Tests scenarios

Related links

github-actions · 2025-06-27T12:04:34Z

	Messages
📖	This PR seems to be quite large (total lines of code: 4186), you might consider splitting it into smaller PRs

👋 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.
- 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 c00305c

pedrominatel · 2025-06-27T14:18:42Z

Thank you very much for your contribution, @P-R-O-C-H-Y. It will take some time, but I'll review ASAP.

lucasssvaz

I think there are some leftover python and temp files

P-R-O-C-H-Y · 2025-06-27T16:27:58Z

I think there are some leftover python and temp files

@lucasssvaz Removed, thanks :)

Copilot

Pull Request Overview

This PR adds comprehensive Zigbee library API documentation by introducing new RST files for core and endpoint classes and updating the main libraries index.

Added ZigbeeEP endpoint base class documentation with detailed API breakdown.
Added ZigbeeCore main class documentation covering network management and utilities.
Created individual endpoint docs (ep_*) for each Zigbee device type and updated libraries.rst TOC.

Reviewed Changes

Copilot reviewed 28 out of 28 changed files in this pull request and generated 3 comments.

Show a summary per file

File	Description
docs/en/zigbee/zigbee_ep.rst	Added base endpoint API reference
docs/en/zigbee/zigbee_core.rst	Added core library API reference
docs/en/zigbee/zigbee.rst	Added overview, topology, and toctree
docs/en/zigbee/ep_*.rst	Added specific endpoint class docs
docs/en/libraries.rst	Updated Table of Contents with Zigbee

Comments suppressed due to low confidence (2)

docs/en/zigbee/zigbee_ep.rst:346

[nitpick] The description for the callback parameter 'time' is listed under the method instead of alongside the callback signature; consider clarifying its placement under the callback details.

* ``time`` - Identify time in seconds

docs/en/zigbee/ep_door_window_handle.rst:95

The example section is marked 'To be added'. Please provide a concrete example or remove the placeholder.

*To be added*

Copilot · 2025-07-07T18:11:32Z

docs/en/zigbee/zigbee.rst

+* **Router**: Extends network range, routes messages, mains powered devices (typicaly lights, switches, etc.)
+* **End Device**: Battery-powered devices that can sleep for extended periods (typicaly sensors)


Spelling mistake: 'typicaly' should be 'typically'.

Suggested change

* **Router**: Extends network range, routes messages, mains powered devices (typicaly lights, switches, etc.)

* **End Device**: Battery-powered devices that can sleep for extended periods (typicaly sensors)

* **Router**: Extends network range, routes messages, mains powered devices (typically lights, switches, etc.)

* **End Device**: Battery-powered devices that can sleep for extended periods (typically sensors)

Copilot · 2025-07-07T18:11:32Z

docs/en/zigbee/zigbee.rst

+* **Router**: Extends network range, routes messages, mains powered devices (typicaly lights, switches, etc.)
+* **End Device**: Battery-powered devices that can sleep for extended periods (typicaly sensors)


Spelling mistake: 'typicaly' should be 'typically'.

Suggested change

* **Router**: Extends network range, routes messages, mains powered devices (typicaly lights, switches, etc.)

* **End Device**: Battery-powered devices that can sleep for extended periods (typicaly sensors)

* **Router**: Extends network range, routes messages, mains powered devices (typically lights, switches, etc.)

* **End Device**: Battery-powered devices that can sleep for extended periods (typically sensors)

Copilot · 2025-07-07T18:11:32Z

docs/en/zigbee/zigbee.rst

+**********
+
+For better debugging, you can enable debug mode to get detailed information about network operations. Call debug mode before starting Zigbee.
+Also selectiong zigbee mode with *debug* suffix is recommended.


Spelling mistake: 'selectiong' should be 'selecting'.

Suggested change

Also selectiong zigbee mode with *debug* suffix is recommended.

Also selecting zigbee mode with *debug* suffix is recommended.

P-R-O-C-H-Y self-assigned this Jun 27, 2025

P-R-O-C-H-Y requested review from pedrominatel and a team as code owners June 27, 2025 12:03

P-R-O-C-H-Y added the Type: Documentation Issue pertains to Documentation of Arduino ESP32 label Jun 27, 2025

P-R-O-C-H-Y mentioned this pull request May 16, 2025

Implement Zigbee in Arduino #10135

Open

17 tasks

P-R-O-C-H-Y marked this pull request as draft June 27, 2025 12:10

P-R-O-C-H-Y force-pushed the docs/zigbee branch from 3be3b17 to ea5da97 Compare June 27, 2025 12:17

P-R-O-C-H-Y marked this pull request as ready for review June 27, 2025 12:18

feat(docs): Add Zigbee library documentation

6b22f0e

P-R-O-C-H-Y force-pushed the docs/zigbee branch from ea5da97 to 6b22f0e Compare June 27, 2025 12:19

P-R-O-C-H-Y added Status: Review needed Issue or PR is awaiting review Area: Zigbee Issues and Feature Request about Zigbee labels Jun 27, 2025

lucasssvaz reviewed Jun 27, 2025

View reviewed changes

lucasssvaz requested review from me-no-dev, SuGlider and Copilot June 27, 2025 14:25

This comment was marked as outdated.

Sign in to view

fix: Remove helper scripts

be28c96

fix: Proper class naming for better readability

c00305c

lucasssvaz requested a review from Copilot July 7, 2025 18:09

Copilot AI reviewed Jul 7, 2025

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

feat(docs): Add Zigbee library API documentation #11525

feat(docs): Add Zigbee library API documentation #11525

P-R-O-C-H-Y commented Jun 27, 2025

Uh oh!

github-actions bot commented Jun 27, 2025 •

edited

Loading

Uh oh!

pedrominatel commented Jun 27, 2025

Uh oh!

lucasssvaz left a comment

Uh oh!

This comment was marked as outdated.

Uh oh!

P-R-O-C-H-Y commented Jun 27, 2025

Uh oh!

Copilot AI left a comment

Uh oh!

Copilot AI Jul 7, 2025

Uh oh!

Copilot AI Jul 7, 2025

Uh oh!

Copilot AI Jul 7, 2025

Uh oh!

Uh oh!

		* Router: Extends network range, routes messages, mains powered devices (typicaly lights, switches, etc.)
		* End Device: Battery-powered devices that can sleep for extended periods (typicaly sensors)

	Also selectiong zigbee mode with debug suffix is recommended.
	Also selecting zigbee mode with debug suffix is recommended.

feat(docs): Add Zigbee library API documentation #11525

Are you sure you want to change the base?

feat(docs): Add Zigbee library API documentation #11525

Conversation

P-R-O-C-H-Y commented Jun 27, 2025

Description of Change

Tests scenarios

Related links

Uh oh!

github-actions bot commented Jun 27, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

pedrominatel commented Jun 27, 2025

Uh oh!

lucasssvaz left a comment

Choose a reason for hiding this comment

Uh oh!

This comment was marked as outdated.

Uh oh!

P-R-O-C-H-Y commented Jun 27, 2025

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull Request Overview

Reviewed Changes

Uh oh!

Copilot AI Jul 7, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Jul 7, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Jul 7, 2025

Choose a reason for hiding this comment

Uh oh!

Uh oh!

github-actions bot commented Jun 27, 2025 •

edited

Loading