-
Notifications
You must be signed in to change notification settings - Fork 7.6k
Adds a Minimum Code Matter Example #10639
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.
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
Changes from 8 commits
Commits
Show all changes
11 commits
Select commit
Hold shift + click to select a range
c3866bb
feat(matter): add a new example for a minimum matter device
SuGlider 86a02c5
feat(matter): create ci.json necessary for ci testing
SuGlider b0bbf2a
feat(matter): simple type correction in commentary
SuGlider 4eece9b
feat(matter): add minimum matter ednpoint action to example
SuGlider 584b485
fix(matter): commentaty update based on code change
SuGlider 54c01fa
feat(matter): simple correction in commentary based on code change
SuGlider 157b784
feat(matter): better commentary about the GPIO.
SuGlider 453d406
feat(matter): clearer commentary and formatting.
SuGlider ab28c4c
feat(matter): commentary change based on code change
SuGlider 3c2fd00
ci(pre-commit): Apply automatic fixes
pre-commit-ci-lite[bot] 73ffd5e
fix(matter): codespell ci commentary fixed
SuGlider File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or 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,81 @@ | ||
// 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 may be useful to follow Matter Accessory and Controller messages. | ||
*/ | ||
|
||
// 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; | ||
|
||
// 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 | ||
|
||
// Matter Protocol Endpoint (On/OFF Light) Callback | ||
bool matterCB(bool state) { | ||
digitalWrite(ledPin, state ? HIGH : LOW); | ||
// This callback must return the success state to Matter core | ||
return true; | ||
} | ||
|
||
// 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 | ||
|
||
void setup() { | ||
// Initialise the LED GPIO | ||
pinMode(ledPin, OUTPUT); | ||
|
||
WiFi.enableIPv6(true); | ||
// Manually connect to WiFi | ||
WiFi.begin(ssid, password); | ||
// Wait for connection | ||
while (WiFi.status() != WL_CONNECTED) { | ||
delay(500); | ||
} | ||
|
||
// Initialize at least one Matter EndPoint | ||
OnOffLight.begin(); | ||
|
||
// Associate a callback to the Matter Controller | ||
OnOffLight.onChange(matterCB); | ||
|
||
// Matter beginning - Last step, after all EndPoints are initialized | ||
Matter.begin(); | ||
|
||
if (!Matter.isDeviceCommissioned()) { | ||
log_i("Matter Node is not commissioned yet."); | ||
log_i("Initiate the device discovery in your Matter environment."); | ||
log_i("Commission it to your Matter hub with the manual pairing code or QR code"); | ||
log_i("Manual pairing code: %s\r\n", Matter.getManualPairingCode().c_str()); | ||
log_i("QR code URL: %s\r\n", Matter.getOnboardingQRCodeUrl().c_str()); | ||
} | ||
} | ||
|
||
void loop() { | ||
delay(500); | ||
} |
This file contains hidden or 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" | ||
] | ||
} |
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.