feat(matter): initial commit with arduino matter lib

CMakeLists.txt

@@ -93,6 +93,7 @@ set(ARDUINO_ALL_LIBRARIES
   HTTPUpdate
   Insights
   LittleFS
+  Matter
   NetBIOS
   Network
   OpenThread
@@ -164,6 +165,10 @@ set(ARDUINO_LIBRARY_OpenThread_SRCS
   libraries/OpenThread/src/OThreadCLI.cpp
   libraries/OpenThread/src/OThreadCLI_Util.cpp)
 
+set(ARDUINO_LIBRARY_Matter_SRCS
+  libraries/Matter/src/MatterOnOffLight.cpp
+  libraries/Matter/src/Matter.cpp)
+
 set(ARDUINO_LIBRARY_PPP_SRCS
   libraries/PPP/src/PPP.cpp
   libraries/PPP/src/ppp.c)

libraries/Matter/examples/MatterCommissionTest/MatterCommissionTest.ino

@@ -0,0 +1,74 @@
+#include <sdkconfig.h>
+#ifdef CONFIG_ESP_MATTER_ENABLE_DATA_MODEL
+#include <Arduino.h>
+#include <WiFi.h>
+
+// Matter Manager
+#include <Matter.h>
+
+// List of Matter Endpoints for this Node
+// On/Off Light Endpoint
+#include <MatterOnOffLight.h>
+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
+
+void setup() {
+  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 at least one Matter EndPoint
+  OnOffLight.begin();
+
+  // Matter begining - Last step, after all EndPoints are initialized
+  Matter.begin();
+}
+
+void loop() {
+  // Check Matter Commissioning state
+  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.
+    while (!Matter.isDeviceCommissioned()) {
+      delay(5000);
+      Serial.println("Matter Fabric not commissioned yet. Waiting for commissioning.");
+    }
+  }
+  Serial.println("Matter Node is commissioned and connected to Wi-Fi.");
+  Serial.println("====> Decommissioning in 30 seconds. <====");
+  delay(30000);
+  Matter.decommission();
+  Serial.println("Matter Node is decommissioned. Commsssioning widget shall start over.");
+}
+
+#else
+void setup() {}
+void loop() {}
+#endif /* CONFIG_ESP_MATTER_ENABLE_DATA_MODEL */

libraries/Matter/examples/MatterCommissionTest/ci.json

@@ -0,0 +1,8 @@
+{
+    "fqbn_append": "PartitionScheme=huge_app",
+    "requires": [
+      "CONFIG_SOC_WIFI_SUPPORTED=y",
+      "CONFIG_ESP_MATTER_ENABLE_DATA_MODEL=y"
+    ]
+}
+

libraries/Matter/examples/MatterComposedLights/MatterComposedLights.ino

@@ -0,0 +1,103 @@
+#include <sdkconfig.h>
+#ifdef CONFIG_ESP_MATTER_ENABLE_DATA_MODEL
+#include <Arduino.h>
+#include <WiFi.h>
+
+// Matter Manager
+#include <Matter.h>
+
+// List of Matter Endpoints for this Node
+// There will be 3 On/Off Light Endpoints in the same Node
+#include <MatterOnOffLight.h>
+MatterOnOffLight OnOffLight1;
+MatterOnOffLight OnOffLight2;
+MatterOnOffLight OnOffLight3;
+
+// Matter Protocol Endpoint Callback for each Light Accessory
+bool setLightOnOff1(bool state) {
+  Serial.printf("CB-Light1 changed state to: %s\r\n", state ? "ON" : "OFF");
+  return true;
+}
+
+bool setLightOnOff2(bool state) {
+  Serial.printf("CB-Light2 changed state to: %s\r\n", state ? "ON" : "OFF");
+  return true;
+}
+
+bool setLightOnOff3(bool state) {
+  Serial.printf("CB-Light3 changed state to: %s\r\n", state ? "ON" : "OFF");
+  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() {
+  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 all 3 Matter EndPoints
+  OnOffLight1.begin();
+  OnOffLight2.begin();
+  OnOffLight3.begin();
+  OnOffLight1.onChangeOnOff(setLightOnOff1);
+  OnOffLight2.onChangeOnOff(setLightOnOff2);
+  OnOffLight3.onChangeOnOff(setLightOnOff3);
+
+  // Matter begining - Last step, after all EndPoints are initialized
+  Matter.begin();
+}
+
+void loop() {
+  // Check Matter Light Commissioning state
+  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.println("Matter Node is commissioned and connected to Wi-Fi. Ready for use.");
+  }
+
+  //displays the Light state every 3 seconds
+  Serial.println("======================");
+  Serial.printf("Matter Light #1 is %s\r\n", OnOffLight1.getOnOff() ? "ON" : "OFF");
+  Serial.printf("Matter Light #2 is %s\r\n", OnOffLight2.getOnOff() ? "ON" : "OFF");
+  Serial.printf("Matter Light #3 is %s\r\n", OnOffLight3.getOnOff() ? "ON" : "OFF");
+  delay(3000);
+}
+
+#else
+void setup() {}
+void loop() {}
+#endif /* CONFIG_ESP_MATTER_ENABLE_DATA_MODEL */

libraries/Matter/examples/MatterComposedLights/ci.json

@@ -0,0 +1,8 @@
+{
+    "fqbn_append": "PartitionScheme=huge_app",
+    "requires": [
+      "CONFIG_SOC_WIFI_SUPPORTED=y",
+      "CONFIG_ESP_MATTER_ENABLE_DATA_MODEL=y"
+    ]
+}
+

libraries/Matter/examples/MatterOnOffLight/MatterOnOffLight.ino

@@ -0,0 +1,110 @@
+#include <sdkconfig.h>
+#ifdef CONFIG_ESP_MATTER_ENABLE_DATA_MODEL
+#include <Arduino.h>
+#include <WiFi.h>
+
+// Matter Manager
+#include <Matter.h>
+
+// List of Matter Endpoints for this Node
+// On/Off Light Endpoint
+#include <MatterOnOffLight.h>
+MatterOnOffLight OnOffLight;
+
+// set your board LED pin here
+#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
+#warning "Do not forget to set the LED pin"
+#endif
+
+// Matter Protocol Endpoint Callback
+bool setLightOnOff(bool state) {
+  Serial.printf("User Callback :: New Light State = %s\r\n", state ? "ON" : "OFF");
+  if (state) {
+    digitalWrite(ledPin, HIGH);
+  } else {
+    digitalWrite(ledPin, 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() {
+  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
+  OnOffLight.begin(true);
+  OnOffLight.onChangeOnOff(setLightOnOff);
+
+  // Matter begining - Last step, after all EndPoints are initialized
+  Matter.begin();
+}
+
+uint32_t lastMillis = millis();
+const uint32_t toggle_interval = 15000; // light will toggle every 15 seconds
+void loop() {
+  // Check Matter Light Commissioning state
+  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.");
+      }
+    }
+    // Initialize the LED (light) GPIO and Matter End Point
+    pinMode(ledPin, OUTPUT);
+    Serial.printf("Initial state: %s\r\n", OnOffLight.getOnOff() ? "ON" : "OFF");
+    setLightOnOff(OnOffLight.getOnOff()); // configure the Light based on initial state
+    Serial.println("Matter Node is commissioned and connected to Wi-Fi. Ready for use.");
+    delay(10000);
+  }
+
+  //displays the Light state every 3 seconds
+  Serial.printf("Matter Light is %s\r\n", OnOffLight.getOnOff() ? "ON" : "OFF");
+  delay(3000);
+  if (millis() - lastMillis > toggle_interval) {
+    Serial.println("Toggling Light!");
+    lastMillis = millis();
+    OnOffLight.toggle();  // Matter Controller also can see the change
+  }
+}
+
+#else
+void setup() {}
+void loop() {}
+#endif /* CONFIG_ESP_MATTER_ENABLE_DATA_MODEL */

libraries/Matter/examples/MatterOnOffLight/ci.json

@@ -0,0 +1,8 @@
+{
+    "fqbn_append": "PartitionScheme=huge_app",
+    "requires": [
+      "CONFIG_SOC_WIFI_SUPPORTED=y",
+      "CONFIG_ESP_MATTER_ENABLE_DATA_MODEL=y"
+    ]
+}
+

libraries/Matter/keywords.txt

@@ -0,0 +1,35 @@
+#######################################
+# Syntax Coloring Map For OpenThread
+#######################################
+
+#######################################
+# Datatypes (KEYWORD1)
+#######################################
+
+Matter	KEYWORD1
+MatterOnOffLight	KEYWORD1
+MatterEndPoint	KEYWORD1
+
+#######################################
+# Methods and Functions (KEYWORD2)
+#######################################
+
+begin	KEYWORD2
+end	KEYWORD2
+start	KEYWORD2
+getManualPairingCode	KEYWORD2
+getOnboardingQRCodeUrl	KEYWORD2
+isDeviceCommissioned	KEYWORD2
+isWiFiConnected	KEYWORD2
+isThreadConnected	KEYWORD2
+isDeviceConnected	KEYWORD2
+decommission	KEYWORD2
+attributeChangeCB	KEYWORD2
+setOnOff	KEYWORD2
+getOnOff	KEYWORD2
+toggle	KEYWORD2
+onChangeOnOff	KEYWORD2
+
+#######################################
+# Constants (LITERAL1)
+#######################################

libraries/Matter/library.properties

@@ -0,0 +1,9 @@
+name=Matter
+version=3.1.0
+author=Rodrigo Garcia | GitHub @SuGlider
+maintainer=Rodrigo Garcia <Rodrigo.Garcia@espressif.com>
+sentence=Library for supporting Matter environment on ESP32.
+paragraph=This library implements Matter accessories using WiFi network.
+category=Communication
+url=https://github.com/espressif/arduino-esp32/
+architectures=esp32