Skip to content

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

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

Merged
merged 7 commits into from
Jul 21, 2025
+4,185 −0
Merged

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

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
6b22f0e
feat(docs): Add Zigbee library documentation
P-R-O-C-H-Y Jun 23, 2025
be28c96
fix: Remove helper scripts
P-R-O-C-H-Y Jun 27, 2025
c00305c
fix: Proper class naming for better readability
P-R-O-C-H-Y Jun 27, 2025
dbb76e2
fix(docs): Fix typos
P-R-O-C-H-Y Jul 16, 2025
6cd90ca
ci(pre-commit): Apply automatic fixes
pre-commit-ci-lite[bot] Jul 21, 2025
c127922
fix(docs): Precommit fixes
P-R-O-C-H-Y Jul 21, 2025
5cdb10f
fix(docs): Precommit fixes
P-R-O-C-H-Y Jul 21, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
fix(docs): Precommit fixes
  • Loading branch information
@P-R-O-C-H-Y
P-R-O-C-H-Y committed Jul 21, 2025
commit c12792278a985d792debff5895be08bba112b14d
3 changes: 1 addition & 2 deletions docs/en/zigbee/ep_electrical_measurement.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,9 +18,8 @@ The ``ZigbeeElectricalMeasurement`` class provides an endpoint for electrical me
* Zigbee HA standard compliance

**Use Cases:**
* Smart power meters
* Smart power monitoring
* Energy monitoring systems
* Industrial power monitoring
* Solar panel monitoring
* Battery monitoring systems
* Electrical load monitoring
Expand Down
2 changes: 1 addition & 1 deletion docs/en/zigbee/ep_gateway.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ About
-----

The ``ZigbeeGateway`` class provides a gateway endpoint for Zigbee networks. This endpoint implements the Zigbee Home Automation (HA) standard for network coordination and gateway functionality.
Gateway is a device that can be used to bridge Zigbee network to other networks (e.g. WiFi, Ethernet, etc.).
Gateway is a device that can be used to bridge Zigbee network to other networks (e.g. Wi-Fi, Ethernet, etc.).

API Reference
-------------
Expand Down
4 changes: 2 additions & 2 deletions docs/en/zigbee/ep_window_covering.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -49,13 +49,13 @@ Position Control
setLiftPosition
^^^^^^^^^^^^^^^

Sets the window covering lift position in centimeters.
Sets the window covering lift position in cm.

.. code-block:: arduino

bool setLiftPosition(uint16_t lift_position);

* ``lift_position`` - Lift position in centimeters
* ``lift_position`` - Lift position in cm

This function will return ``true`` if successful, ``false`` otherwise.

Expand Down
2 changes: 1 addition & 1 deletion docs/en/zigbee/zigbee.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -135,7 +135,7 @@ Common Issues
**Network connectivity problems**
* Check that devices are within range
* Verify that routers are properly configured
* Check for interference from other 2.4GHz devices
* Check for interference from other 2.4 GHz devices

Factory Reset
*************
Expand Down
2 changes: 1 addition & 1 deletion docs/en/zigbee/zigbee_core.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -173,7 +173,7 @@ Sets the timeout for network operations.

void setTimeout(uint32_t timeout);

* ``timeout`` - Timeout in milliseconds (default: 30000ms)
* ``timeout`` - Timeout in milliseconds (default: 30000 ms)

Network Discovery
*****************
Expand Down
4 changes: 2 additions & 2 deletions docs/en/zigbee/zigbee_ep.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -152,7 +152,7 @@ Sets the power source type for the endpoint.

* ``source`` - Power source type (``ZB_POWER_SOURCE_MAINS``, ``ZB_POWER_SOURCE_BATTERY``, etc.)
* ``percentage`` - Battery percentage (0-100, default: 0xff)
* ``voltage`` - Battery voltage in 100mV units (default: 0xff)
* ``voltage`` - Battery voltage in 100 mV units (default: 0xff)

This function will return ``true`` if set successfully, ``false`` otherwise.

Expand All @@ -178,7 +178,7 @@ Sets the battery voltage.

bool setBatteryVoltage(uint8_t voltage);

* ``voltage`` - Battery voltage in 100mV units (e.g., 35 for 3.5V)
* ``voltage`` - Battery voltage in 100 mV units (e.g., 35 for 3.5 V)

This function will return ``true`` if set successfully, ``false`` otherwise.

Expand Down
Loading