-
Notifications
You must be signed in to change notification settings - Fork 7.5k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #10734 from SuGlider/matter_identify_callback
feat(matter) adds Identification callback to all matter endpoints
- Loading branch information
Showing
17 changed files
with
288 additions
and
25 deletions.
There are no files selected for viewing
164 changes: 164 additions & 0 deletions
164
libraries/Matter/examples/MatterOnIdentify/MatterOnIdentify.ino
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,164 @@ | ||
// Copyright 2024 Espressif Systems (Shanghai) PTE LTD | ||
// | ||
// Licensed under the Apache License, Version 2.0 (the "License"); | ||
// you may not use this file except in compliance with the License. | ||
// You may obtain a copy of the License at | ||
|
||
// http://www.apache.org/licenses/LICENSE-2.0 | ||
// | ||
// Unless required by applicable law or agreed to in writing, software | ||
// distributed under the License is distributed on an "AS IS" BASIS, | ||
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
// See the License for the specific language governing permissions and | ||
// limitations under the License. | ||
|
||
/* | ||
* This example is the smallest code that will create a Matter Device which can be | ||
* commissioned and controlled from a Matter Environment APP. | ||
* It controls a GPIO that could be attached to a LED for visualization. | ||
* Additionally the ESP32 will send debug messages indicating the Matter activity. | ||
* Turning DEBUG Level ON may be useful to following Matter Accessory and Controller messages. | ||
* | ||
* This example is a simple Matter On/Off Light that can be controlled by a Matter Controller. | ||
* It demonstrates how to use On Identify callback when the Identify Cluster is called. | ||
* The Matter user APP can be used to request the device to identify itself by blinking the LED. | ||
*/ | ||
|
||
// Matter Manager | ||
#include <Matter.h> | ||
#include <WiFi.h> | ||
|
||
// List of Matter Endpoints for this Node | ||
// Single On/Off Light Endpoint - at least one per node | ||
MatterOnOffLight OnOffLight; | ||
|
||
// WiFi is manually set and started | ||
const char *ssid = "your-ssid"; // Change this to your WiFi SSID | ||
const char *password = "your-password"; // Change this to your WiFi password | ||
|
||
// Light GPIO that can be controlled by Matter APP | ||
#ifdef LED_BUILTIN | ||
const uint8_t ledPin = LED_BUILTIN; | ||
#else | ||
const uint8_t ledPin = 2; // Set your pin here if your board has not defined LED_BUILTIN | ||
#endif | ||
|
||
// set your board USER BUTTON pin here - decommissioning button | ||
const uint8_t buttonPin = BOOT_PIN; // Set your pin here. Using BOOT Button. | ||
|
||
// Button control - decommision the Matter Node | ||
uint32_t button_time_stamp = 0; // debouncing control | ||
bool button_state = false; // false = released | true = pressed | ||
const uint32_t decommissioningTimeout = 5000; // keep the button pressed for 5s, or longer, to decommission | ||
|
||
// Identify Flag and blink time - Blink the LED | ||
const uint8_t identifyLedPin = ledPin; // uses the same LED as the Light - change if needed | ||
volatile bool identifyFlag = false; // Flag to start the Blink when in Identify state | ||
bool identifyBlink = false; // Blink state when in Identify state | ||
|
||
// Matter Protocol Endpoint (On/OFF Light) Callback | ||
bool onOffLightCallback(bool state) { | ||
digitalWrite(ledPin, state ? HIGH : LOW); | ||
// This callback must return the success state to Matter core | ||
return true; | ||
} | ||
|
||
// Identification shall be done by Blink in Red or just the GPIO when no LED_BUILTIN is not defined | ||
bool onIdentifyLightCallback(bool identifyIsActive) { | ||
Serial.printf("Identify Cluster is %s\r\n", identifyIsActive ? "Active" : "Inactive"); | ||
if (identifyIsActive) { | ||
// Start Blinking the light in loop() | ||
identifyFlag = true; | ||
identifyBlink = !OnOffLight; // Start with the inverted light state | ||
} else { | ||
// Stop Blinking and restore the light to the its last state | ||
identifyFlag = false; | ||
// force returning to the original state by toggling the light twice | ||
OnOffLight.toggle(); | ||
OnOffLight.toggle(); | ||
} | ||
return true; | ||
} | ||
|
||
void setup() { | ||
// Initialize the USER BUTTON (Boot button) that will be used to decommission the Matter Node | ||
pinMode(buttonPin, INPUT_PULLUP); | ||
// Initialize the LED GPIO | ||
pinMode(ledPin, OUTPUT); | ||
|
||
Serial.begin(115200); | ||
|
||
// Manually connect to WiFi | ||
WiFi.begin(ssid, password); | ||
// Wait for connection | ||
while (WiFi.status() != WL_CONNECTED) { | ||
delay(500); | ||
Serial.print("."); | ||
} | ||
Serial.println(); | ||
|
||
// Initialize at least one Matter EndPoint | ||
OnOffLight.begin(); | ||
|
||
// On Identify Callback - Blink the LED | ||
OnOffLight.onIdentify(onIdentifyLightCallback); | ||
|
||
// Associate a callback to the Matter Controller | ||
OnOffLight.onChange(onOffLightCallback); | ||
|
||
// Matter beginning - Last step, after all EndPoints are initialized | ||
Matter.begin(); | ||
|
||
// Check Matter Accessory Commissioning state, which may change during execution of loop() | ||
if (!Matter.isDeviceCommissioned()) { | ||
Serial.println(""); | ||
Serial.println("Matter Node is not commissioned yet."); | ||
Serial.println("Initiate the device discovery in your Matter environment."); | ||
Serial.println("Commission it to your Matter hub with the manual pairing code or QR code"); | ||
Serial.printf("Manual pairing code: %s\r\n", Matter.getManualPairingCode().c_str()); | ||
Serial.printf("QR code URL: %s\r\n", Matter.getOnboardingQRCodeUrl().c_str()); | ||
// waits for Matter Occupancy Sensor Commissioning. | ||
uint32_t timeCount = 0; | ||
while (!Matter.isDeviceCommissioned()) { | ||
delay(100); | ||
if ((timeCount++ % 50) == 0) { // 50*100ms = 5 sec | ||
Serial.println("Matter Node not commissioned yet. Waiting for commissioning."); | ||
} | ||
} | ||
Serial.println("Matter Node is commissioned and connected to Wi-Fi. Ready for use."); | ||
} | ||
} | ||
|
||
void loop() { | ||
// check if the Light is in identify state and blink it every 500ms (delay loop time) | ||
if (identifyFlag) { | ||
#ifdef LED_BUILTIN | ||
uint8_t brightness = 32 * identifyBlink; | ||
rgbLedWrite(identifyLedPin, brightness, 0, 0); | ||
#else | ||
digitalWrite(identifyLedPin, identifyBlink ? HIGH : LOW); | ||
#endif | ||
identifyBlink = !identifyBlink; | ||
} | ||
|
||
// Check if the button has been pressed | ||
if (digitalRead(buttonPin) == LOW && !button_state) { | ||
// deals with button debouncing | ||
button_time_stamp = millis(); // record the time while the button is pressed. | ||
button_state = true; // pressed. | ||
} | ||
|
||
if (digitalRead(buttonPin) == HIGH && button_state) { | ||
button_state = false; // released | ||
} | ||
|
||
// Onboard User Button is kept pressed for longer than 5 seconds in order to decommission matter node | ||
uint32_t time_diff = millis() - button_time_stamp; | ||
if (button_state && time_diff > decommissioningTimeout) { | ||
Serial.println("Decommissioning the Light Matter Accessory. It shall be commissioned again."); | ||
Matter.decommission(); | ||
button_time_stamp = millis(); // avoid running decommissining again, reboot takes a second or so | ||
} | ||
|
||
delay(500); // works as a debounce for the button and also for the LED blink | ||
} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,7 @@ | ||
{ | ||
"fqbn_append": "PartitionScheme=huge_app", | ||
"requires": [ | ||
"CONFIG_SOC_WIFI_SUPPORTED=y", | ||
"CONFIG_ESP_MATTER_ENABLE_DATA_MODEL=y" | ||
] | ||
} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.