-
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.
feat(Matter): New Matter Endpoint - Dimmable Light (#10543)
* feat(matter): source code folder organization * feat(matter): new matter endpoint dimmable light * feat(matter): dimmable friend class and adjusts log levels * feat(matter): adds new folder and source code to cmakelists.txt * fix(matter): identation in cmakelists.txt * feat(matter): adds license disclaimer to all source code * feat(matter): example code simplification * feat(matter): make it work with rgb and analog led * feat(matter): single user callback based on lambda function * feat(matter): commentaries and code improvement. update() and callbacks added. * feat(matter): adde new keywords to arduino settings * feat(matter): example code adjustment to use improved api * fix(matter): it shuold work even when no callback is set * feat(matter): matter.h includes all possible endpoint header files * feat(matter): adjusts all examples to only include matter.h * fix(matter): double declaration of ret - var scope issue * ci(pre-commit): Apply automatic fixes --------- Co-authored-by: pre-commit-ci-lite[bot] <117423508+pre-commit-ci-lite[bot]@users.noreply.github.com>
- Loading branch information
1 parent
a80b03e
commit 69825a9
Showing
14 changed files
with
609 additions
and
35 deletions.
There are no files selected for viewing
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
15 changes: 14 additions & 1 deletion
15
libraries/Matter/examples/MatterCommissionTest/MatterCommissionTest.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
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
170 changes: 170 additions & 0 deletions
170
libraries/Matter/examples/MatterDimmableLight/MatterDimmableLight.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,170 @@ | ||
| // 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. | ||
|
|
||
| // Matter Manager | ||
| #include <Matter.h> | ||
| #include <WiFi.h> | ||
| #include <Preferences.h> | ||
|
|
||
| // List of Matter Endpoints for this Node | ||
| // Dimmable Light Endpoint | ||
| MatterDimmableLight DimmableLight; | ||
|
|
||
| // it will keep last OnOff & Brightness state stored, using Preferences | ||
| Preferences lastStatePref; | ||
|
|
||
| // set your board RGB LED pin here | ||
| #ifdef RGB_BUILTIN | ||
| const uint8_t ledPin = RGB_BUILTIN; | ||
| #else | ||
| const uint8_t ledPin = 2; // Set your pin here if your board has not defined LED_BUILTIN | ||
| #warning "Do not forget to set the RGB LED pin" | ||
| #endif | ||
|
|
||
| // set your board USER BUTTON pin here | ||
| const uint8_t buttonPin = 0; // Set your pin here. Using BOOT Button. C6/C3 use GPIO9. | ||
|
|
||
| // 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 | ||
|
|
||
| // Set the RGB LED Light based on the current state of the Dimmable Light | ||
| bool setLightState(bool state, uint8_t brightness) { | ||
| if (state) { | ||
| #ifdef RGB_BUILTIN | ||
| rgbLedWrite(ledPin, brightness, brightness, brightness); | ||
| #else | ||
| analogWrite(ledPin, brightness); | ||
| #endif | ||
| } else { | ||
| digitalWrite(ledPin, LOW); | ||
| } | ||
| // store last Brightness and OnOff state for when the Light is restarted / power goes off | ||
| lastStatePref.putUChar("lastBrightness", brightness); | ||
| lastStatePref.putBool("lastOnOffState", state); | ||
| // This callback must return the success state to Matter core | ||
| return true; | ||
| } | ||
|
|
||
| void setup() { | ||
| // Initialize the USER BUTTON (Boot button) GPIO that will act as a toggle switch | ||
| pinMode(buttonPin, INPUT_PULLUP); | ||
| // Initialize the LED (light) GPIO and Matter End Point | ||
| pinMode(ledPin, OUTPUT); | ||
|
|
||
| Serial.begin(115200); | ||
| while (!Serial) { | ||
| delay(100); | ||
| } | ||
|
|
||
| // We start by connecting to a WiFi network | ||
| Serial.print("Connecting to "); | ||
| Serial.println(ssid); | ||
| // enable IPv6 | ||
| WiFi.enableIPv6(true); | ||
| // Manually connect to WiFi | ||
| WiFi.begin(ssid, password); | ||
| // Wait for connection | ||
| while (WiFi.status() != WL_CONNECTED) { | ||
| delay(500); | ||
| Serial.print("."); | ||
| } | ||
| Serial.println("\r\nWiFi connected"); | ||
| Serial.println("IP address: "); | ||
| Serial.println(WiFi.localIP()); | ||
| delay(500); | ||
|
|
||
| // Initialize Matter EndPoint | ||
| lastStatePref.begin("matterLight", false); | ||
| // default OnOff state is ON if not stored before | ||
| bool lastOnOffState = lastStatePref.getBool("lastOnOffState", true); | ||
| // default brightness ~= 6% (15/255) | ||
| uint8_t lastBrightness = lastStatePref.getUChar("lastBrightness", 15); | ||
| DimmableLight.begin(lastOnOffState, lastBrightness); | ||
| // set the callback function to handle the Light state change | ||
| DimmableLight.onChange(setLightState); | ||
|
|
||
| // lambda functions are used to set the attribute change callbacks | ||
| DimmableLight.onChangeOnOff([](bool state) { | ||
| Serial.printf("Light OnOff changed to %s\r\n", state ? "ON" : "OFF"); | ||
| return true; | ||
| }); | ||
| DimmableLight.onChangeBrightness([](uint8_t level) { | ||
| Serial.printf("Light Brightness changed to %d\r\n", level); | ||
| return true; | ||
| }); | ||
|
|
||
| // Matter beginning - Last step, after all EndPoints are initialized | ||
| Matter.begin(); | ||
| // This may be a restart of a already commissioned Matter accessory | ||
| if (Matter.isDeviceCommissioned()) { | ||
| Serial.println("Matter Node is commissioned and connected to Wi-Fi. Ready for use."); | ||
| Serial.printf("Initial state: %s | brightness: %d\r\n", DimmableLight ? "ON" : "OFF", DimmableLight.getBrightness()); | ||
| // configure the Light based on initial on-off state and brightness | ||
| DimmableLight.updateAccessory(); | ||
| } | ||
| } | ||
| // Button control | ||
| uint32_t button_time_stamp = 0; // debouncing control | ||
| bool button_state = false; // false = released | true = pressed | ||
| const uint32_t debouceTime = 250; // button debouncing time (ms) | ||
| const uint32_t decommissioningTimeout = 10000; // keep the button pressed for 10s to decommission the light | ||
|
|
||
| void loop() { | ||
| // Check Matter Light 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 Light 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.printf("Initial state: %s | brightness: %d\r\n", DimmableLight ? "ON" : "OFF", DimmableLight.getBrightness()); | ||
| // configure the Light based on initial on-off state and brightness | ||
| DimmableLight.updateAccessory(); | ||
| Serial.println("Matter Node is commissioned and connected to Wi-Fi. Ready for use."); | ||
| } | ||
|
|
||
| // A button is also used to control the light | ||
| // 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. | ||
| } | ||
|
|
||
| // Onboard User Button is used as a Light toggle switch or to decommission it | ||
| uint32_t time_diff = millis() - button_time_stamp; | ||
| if (button_state && time_diff > debouceTime && digitalRead(buttonPin) == HIGH) { | ||
| button_state = false; // released | ||
| // Toggle button is released - toggle the light | ||
| Serial.println("User button released. Toggling Light!"); | ||
| DimmableLight.toggle(); // Matter Controller also can see the change | ||
|
|
||
| // Factory reset is triggered if the button is pressed longer than 10 seconds | ||
| if (time_diff > decommissioningTimeout) { | ||
| Serial.println("Decommissioning the Light Matter Accessory. It shall be commissioned again."); | ||
| DimmableLight = false; // turn the light off | ||
| Matter.decommission(); | ||
| } | ||
| } | ||
| } |
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
Oops, something went wrong.