Merge branch 'master' into rmt_loop_count

Author: SuGlider

.flake8

@@ -5,6 +5,6 @@
 doctests = True
 # W503 and W504 are mutually exclusive. PEP 8 recommends line break before.
 ignore = W503,E203
-max-complexity = 20
+max-complexity = 30
 max-line-length = 120
 select = E,W,F,C,N

.github/pytools/Sign-File.ps1

@@ -19,7 +19,7 @@ function FindSignTool {
     if (Test-Path -Path $SignTool -PathType Leaf) {
         return $SignTool
     }
-    $sdkVers = "10.0.22000.0", "10.0.20348.0", "10.0.19041.0", "10.0.17763.0"
+    $sdkVers = "10.0.22000.0", "10.0.20348.0", "10.0.19041.0", "10.0.17763.0", "10.0.14393.0", "10.0.15063.0", "10.0.16299.0", "10.0.17134.0", "10.0.26100.0"
     Foreach ($ver in $sdkVers)
     {
         $SignTool = "${env:ProgramFiles(x86)}\Windows Kits\10\bin\${ver}\x64\signtool.exe"

.github/scripts/get_affected.py

@@ -626,11 +626,9 @@ def find_affected_sketches(changed_files: list[str]) -> None:
     q = queue.Queue()
 
     if component_mode:
-        print(f"Affected IDF component examples:", file=sys.stderr)
         # Get all available component examples once for efficiency
         all_examples = list_idf_component_examples()
     else:
-        print(f"Affected sketches:", file=sys.stderr)
         all_examples = []
 
     for file in changed_files:
@@ -648,11 +646,9 @@ def find_affected_sketches(changed_files: list[str]) -> None:
             # Check if this file belongs to an IDF component example
             for example in all_examples:
                 if file.startswith(example + "/") and example not in affected_sketches:
-                    print(example, file=sys.stderr)
                     affected_sketches.append(example)
         else:
             if file.endswith('.ino') and file not in affected_sketches:
-                print(file, file=sys.stderr)
                 affected_sketches.append(file)
 
         # Continue with reverse dependency traversal
@@ -687,18 +683,24 @@ def find_affected_sketches(changed_files: list[str]) -> None:
                         if should_traverse:
                             q.put(dependency)
                             if dependency_example and dependency_example not in affected_sketches:
-                                print(dependency_example, file=sys.stderr)
                                 affected_sketches.append(dependency_example)
                     else:
                         q.put(dependency)
                         if dependency.endswith('.ino') and dependency not in affected_sketches:
-                            print(dependency, file=sys.stderr)
                             affected_sketches.append(dependency)
 
     if component_mode:
         print(f"Total affected IDF component examples: {len(affected_sketches)}", file=sys.stderr)
+        if affected_sketches:
+            print("Affected IDF component examples:", file=sys.stderr)
+            for example in affected_sketches:
+                print(f"  {example}", file=sys.stderr)
     else:
         print(f"Total affected sketches: {len(affected_sketches)}", file=sys.stderr)
+        if affected_sketches:
+            print("Affected sketches:", file=sys.stderr)
+            for sketch in affected_sketches:
+                print(f"  {sketch}", file=sys.stderr)
 
 def save_dependencies_as_json(output_file: str = "dependencies.json") -> None:
     """

.github/scripts/merge_packages.py

@@ -17,7 +17,8 @@
 
 
 def load_package(filename):
-    pkg = json.load(open(filename))["packages"][0]
+    with open(filename) as f:
+        pkg = json.load(f)["packages"][0]
     print("Loaded package {0} from {1}".format(pkg["name"], filename), file=sys.stderr)
     print("{0} platform(s), {1} tools".format(len(pkg["platforms"]), len(pkg["tools"])), file=sys.stderr)
     return pkg

.github/workflows/pre-commit-status.yml

@@ -9,6 +9,7 @@ on:
 
 permissions:
   statuses: write
+  pull-requests: write
 
 jobs:
   report-success:
@@ -62,3 +63,71 @@ jobs:
               target_url: 'https://github.com/${{ github.repository }}/actions/runs/${{ github.event.workflow_run.id }}'
             })).data;
             core.info(`${name} is ${state}`);
+
+  manage-labels:
+    name: Manage PR labels
+    if: github.event.workflow_run.event == 'pull_request'
+    runs-on: ubuntu-latest
+    steps:
+      - name: Download and Extract Artifacts
+        uses: dawidd6/action-download-artifact@07ab29fd4a977ae4d2b275087cf67563dfdf0295 # v9
+        continue-on-error: true
+        with:
+          run_id: ${{ github.event.workflow_run.id }}
+          name: pr-artifacts
+          path: ./pr-artifacts
+
+      - name: Get PR information
+        id: pr-info
+        run: |
+          if [ -f "./pr-artifacts/pr_number.txt" ]; then
+            pr_number=$(cat ./pr-artifacts/pr_number.txt | tr -cd '[:digit:]')
+            pre_commit_outcome=$(cat ./pr-artifacts/pre_commit_outcome.txt | tr -cd '[:alpha:]_')
+            pending_commit=$(cat ./pr-artifacts/pending_commit.txt | tr -cd '[:digit:]')
+            has_retrigger_label=$(cat ./pr-artifacts/has_retrigger_label.txt | tr -cd '[:alpha:]')
+
+            echo "pr_number=$pr_number" >> $GITHUB_OUTPUT
+            echo "pre_commit_outcome=$pre_commit_outcome" >> $GITHUB_OUTPUT
+            echo "pending_commit=$pending_commit" >> $GITHUB_OUTPUT
+            echo "has_retrigger_label=$has_retrigger_label" >> $GITHUB_OUTPUT
+            echo "artifacts_found=true" >> $GITHUB_OUTPUT
+
+            echo "PR number: $pr_number"
+            echo "Pre-commit outcome: $pre_commit_outcome"
+            echo "Pending commit: $pending_commit"
+            echo "Has retrigger label: $has_retrigger_label"
+          else
+            echo "No PR artifacts found"
+            echo "artifacts_found=false" >> $GITHUB_OUTPUT
+          fi
+
+      - name: Remove re-trigger label if it was present
+        if: |
+          steps.pr-info.outputs.artifacts_found == 'true' &&
+          steps.pr-info.outputs.has_retrigger_label == 'true'
+        continue-on-error: true
+        run: |
+          gh pr edit ${{ steps.pr-info.outputs.pr_number }} --repo ${{ github.repository }} --remove-label 'Re-trigger Pre-commit Hooks'
+        env:
+          GH_TOKEN: ${{ github.token }}
+
+      - name: Add label if pre-commit fixes are required
+        if: |
+          steps.pr-info.outputs.artifacts_found == 'true' &&
+          steps.pr-info.outputs.pre_commit_outcome == 'failure' &&
+          steps.pr-info.outputs.pending_commit == '0'
+        continue-on-error: true
+        run: |
+          gh pr edit ${{ steps.pr-info.outputs.pr_number }} --repo ${{ github.repository }} --add-label 'Status: Pre-commit fixes required ⚠️'
+        env:
+          GH_TOKEN: ${{ github.token }}
+
+      - name: Remove label if pre-commit was successful
+        if: |
+          steps.pr-info.outputs.artifacts_found == 'true' &&
+          steps.pr-info.outputs.pre_commit_outcome == 'success'
+        continue-on-error: true
+        run: |
+          gh pr edit ${{ steps.pr-info.outputs.pr_number }} --repo ${{ github.repository }} --remove-label 'Status: Pre-commit fixes required ⚠️'
+        env:
+          GH_TOKEN: ${{ github.token }}

.github/workflows/pre-commit.yml

@@ -31,13 +31,6 @@ jobs:
         with:
           fetch-depth: 2
 
-      - name: Remove Label
-        if: contains(github.event.pull_request.labels.*.name, 'Re-trigger Pre-commit Hooks')
-        run: gh pr edit ${{ github.event.number }} --remove-label 'Re-trigger Pre-commit Hooks'
-        continue-on-error: true
-        env:
-          GH_TOKEN: ${{ github.token }}
-
       - name: Set up Python 3
         uses: actions/setup-python@42375524e23c412d93fb67b49958b491fce71c38 # v5.0.4
         with:
@@ -85,19 +78,20 @@ jobs:
         with:
           msg: "ci(pre-commit): Apply automatic fixes"
 
-      - name: Add label if no commits are pending
-        if: ${{ failure() && steps.pre-commit.outcome == 'failure' && steps.pre-commit.outputs.pending_commit == '0' && github.event_name == 'pull_request' }}
-        continue-on-error: true
+      - name: Save workflow information for labeling
+        if: ${{ always() && github.event_name == 'pull_request' }}
         run: |
-          gh pr edit ${{ github.event.number }} --add-label 'Status: Pre-commit fixes required ⚠️'
-        env:
-          GH_TOKEN: ${{ github.token }}
+          mkdir -p ./pr-artifacts
+          echo "${{ github.event.number }}" > ./pr-artifacts/pr_number.txt
+          echo "${{ steps.pre-commit.outcome }}" > ./pr-artifacts/pre_commit_outcome.txt
+          echo "${{ steps.pre-commit.outputs.pending_commit }}" > ./pr-artifacts/pending_commit.txt
+          echo "${{ contains(github.event.pull_request.labels.*.name, 'Re-trigger Pre-commit Hooks') }}" > ./pr-artifacts/has_retrigger_label.txt
 
-      - name: Remove label if everything was fixed
-        if: ${{ success() && github.event_name == 'pull_request' }}
-        continue-on-error: true
-        run: |
-          gh pr edit ${{ github.event.number }} --remove-label 'Status: Pre-commit fixes required ⚠️'
-        env:
-          GH_TOKEN: ${{ github.token }}
+      - name: Upload PR artifacts
+        if: ${{ always() && github.event_name == 'pull_request' }}
+        uses: actions/upload-artifact@ea165f8d65b6e75b540449e92b4886f43607fa02 # v4.6.2
+        with:
+          name: pr-artifacts
+          path: ./pr-artifacts/
+          retention-days: 1
 

CMakeLists.txt

@@ -315,6 +315,7 @@ set(ARDUINO_LIBRARY_Zigbee_SRCS
   libraries/Zigbee/src/ep/ZigbeeBinary.cpp
   libraries/Zigbee/src/ep/ZigbeePowerOutlet.cpp
   libraries/Zigbee/src/ep/ZigbeeFanControl.cpp
+  libraries/Zigbee/src/ep/ZigbeeMultistate.cpp
   )
 
 set(ARDUINO_LIBRARY_BLE_SRCS

cores/esp32/esp32-hal-periman.c

@@ -16,7 +16,7 @@ typedef struct ATTR_PACKED {
   int8_t bus_channel;
 } peripheral_pin_item_t;
 
-static peripheral_bus_deinit_cb_t deinit_functions[ESP32_BUS_TYPE_MAX];
+static peripheral_bus_deinit_cb_t deinit_functions[ESP32_BUS_TYPE_MAX] = {NULL};
 static peripheral_pin_item_t pins[SOC_GPIO_PIN_COUNT];
 
 #define GPIO_NOT_VALID(p) ((p >= SOC_GPIO_PIN_COUNT) || ((SOC_GPIO_VALID_GPIO_MASK & (1ULL << p)) == 0))
@@ -236,6 +236,14 @@ bool perimanSetBusDeinit(peripheral_bus_type_t type, peripheral_bus_deinit_cb_t
   return true;
 }
 
+peripheral_bus_deinit_cb_t perimanGetBusDeinit(peripheral_bus_type_t type) {
+  if (type >= ESP32_BUS_TYPE_MAX || type == ESP32_BUS_TYPE_INIT) {
+    log_e("Invalid type: %s (%u)", perimanGetTypeName(type), (unsigned int)type);
+    return NULL;
+  }
+  return deinit_functions[type];
+}
+
 bool perimanPinIsValid(uint8_t pin) {
   return !(GPIO_NOT_VALID(pin));
 }

cores/esp32/esp32-hal-periman.h

@@ -134,6 +134,10 @@ int8_t perimanGetPinBusChannel(uint8_t pin);
 // Sets the peripheral destructor callback. Used to destroy bus when pin is assigned another function
 bool perimanSetBusDeinit(peripheral_bus_type_t type, peripheral_bus_deinit_cb_t cb);
 
+// Get the peripheral destructor callback. It allows changing/restoring the peripheral pin function detaching, if necessary
+// returns NULL if none is set
+peripheral_bus_deinit_cb_t perimanGetBusDeinit(peripheral_bus_type_t type);
+
 // Check if given pin is a valid GPIO number
 bool perimanPinIsValid(uint8_t pin);
 

docs/en/zigbee/ep_binary.rst

@@ -7,10 +7,7 @@ About
 
 The ``ZigbeeBinary`` class provides an endpoint for binary input/output sensors in Zigbee networks. This endpoint implements the Zigbee Home Automation (HA) standard for binary sensors, supporting various application types for HVAC, security, and general binary sensing.
 Binary Input (BI) is meant to be used for sensors that provide a binary signal, such as door/window sensors, motion detectors, etc. to be sent to the network.
-
-.. note::
-
-    Binary Output (BO) is not supported yet.
+Binary Output (BO) is used for controlling binary devices such as relays, switches, or actuators that can be turned on/off remotely.
 
 API Reference
 -------------
@@ -63,6 +60,33 @@ Security Application Types
     #define BINARY_INPUT_APPLICATION_TYPE_SECURITY_HEAT_DETECTION             0x01000008
     #define BINARY_INPUT_APPLICATION_TYPE_SECURITY_OTHER                      0x0100FFFF
 
+Binary Output Application Types
+*******************************
+
+HVAC Application Types
+^^^^^^^^^^^^^^^^^^^^^^
+
+.. code-block:: arduino
+
+    #define BINARY_OUTPUT_APPLICATION_TYPE_HVAC_BOILER        0x00000003
+    #define BINARY_OUTPUT_APPLICATION_TYPE_HVAC_CHILLER       0x0000000D
+    #define BINARY_OUTPUT_APPLICATION_TYPE_HVAC_FAN           0x00000022
+    #define BINARY_OUTPUT_APPLICATION_TYPE_HVAC_HEATING_VALVE 0x0000002C
+    #define BINARY_OUTPUT_APPLICATION_TYPE_HVAC_HUMIDIFIER    0x00000033
+    #define BINARY_OUTPUT_APPLICATION_TYPE_HVAC_PREHEAT       0x00000034
+    #define BINARY_OUTPUT_APPLICATION_TYPE_HVAC_OTHER         0x0000FFFF
+
+Security Application Types
+^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+.. code-block:: arduino
+
+    #define BINARY_OUTPUT_APPLICATION_TYPE_SECURITY_ARM_DISARM_COMMAND  0x01000000
+    #define BINARY_OUTPUT_APPLICATION_TYPE_SECURITY_OCCUPANCY_CONTROL   0x01000001
+    #define BINARY_OUTPUT_APPLICATION_TYPE_SECURITY_ENABLE_CONTROL      0x01000002
+    #define BINARY_OUTPUT_APPLICATION_TYPE_SECURITY_ACCESS_CONTROL      0x01000003
+    #define BINARY_OUTPUT_APPLICATION_TYPE_SECURITY_OTHER               0x0100FFFF
+
 API Methods
 ***********
 
@@ -127,11 +151,94 @@ Manually reports the current binary input value.
 
 This function will return ``true`` if successful, ``false`` otherwise.
 
+addBinaryOutput
+^^^^^^^^^^^^^^^
+
+Adds a binary output cluster to the endpoint.
+
+.. code-block:: arduino
+
+    bool addBinaryOutput();
+
+This function will return ``true`` if successful, ``false`` otherwise.
+
+setBinaryOutputApplication
+^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+Sets the application type for the binary output.
+
+.. code-block:: arduino
+
+    bool setBinaryOutputApplication(uint32_t application_type);
+
+* ``application_type`` - Application type constant (see Binary Output Application Types above)
+
+This function will return ``true`` if successful, ``false`` otherwise.
+
+setBinaryOutputDescription
+^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+Sets a custom description for the binary output.
+
+.. code-block:: arduino
+
+    bool setBinaryOutputDescription(const char *description);
+
+* ``description`` - Description string
+
+This function will return ``true`` if successful, ``false`` otherwise.
+
+onBinaryOutputChange
+^^^^^^^^^^^^^^^^^^^^^
+
+Sets a callback function to be called when the binary output value changes.
+
+.. code-block:: arduino
+
+    void onBinaryOutputChange(void (*callback)(bool binary_output));
+
+* ``callback`` - Function pointer to callback that receives the new binary output value
+
+setBinaryOutput
+^^^^^^^^^^^^^^^
+
+Sets the binary output value.
+
+.. code-block:: arduino
+
+    bool setBinaryOutput(bool output);
+
+* ``output`` - Binary value (true/false)
+
+This function will return ``true`` if successful, ``false`` otherwise.
+
+getBinaryOutput
+^^^^^^^^^^^^^^^
+
+Gets the current binary output value.
+
+.. code-block:: arduino
+
+    bool getBinaryOutput();
+
+This function returns the current binary output state.
+
+reportBinaryOutput
+^^^^^^^^^^^^^^^^^^
+
+Manually reports the current binary output value.
+
+.. code-block:: arduino
+
+    bool reportBinaryOutput();
+
+This function will return ``true`` if successful, ``false`` otherwise.
+
 Example
 -------
 
-Binary Input Implementation
-****************************
+Binary Input and Output Implementation
+**************************************
 
-.. literalinclude:: ../../../libraries/Zigbee/examples/Zigbee_Binary_Input/Zigbee_Binary_Input.ino
+.. literalinclude:: ../../../libraries/Zigbee/examples/Zigbee_Binary_Input_Output/Zigbee_Binary_Input_Output.ino
     :language: arduino