ESP32 example app with basic and temperature cluster (#3053)

* ESP32 example app with basic and temperature cluster

* Review feedback

* Merge copyrights

* Renamed QifiEcho file

* fix crash loop

* restyle

* Remove duplicate copyright and license notices.  Silicon Labs is among CHIP Authors

Co-authored-by: Rob Walker <[email protected]>

examples/temperature-measurement-app/esp32/.gitignore

@@ -0,0 +1 @@
+*.vscode

examples/temperature-measurement-app/esp32/Makefile

@@ -0,0 +1,39 @@
+#
+#    Copyright (c) 2020 Project CHIP Authors
+#    All rights reserved.
+#
+#    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 is a project Makefile. It is assumed the directory this Makefile resides in is a
+# project subdirectory.
+#
+
+PROJECT_NAME := chip-wifi-echo
+
+EXTRA_COMPONENT_DIRS += $(PROJECT_PATH)/third_party/connectedhomeip/config/esp32/components \
+                        $(PROJECT_PATH)/../../common/m5stack-tft/repo/components \
+                        $(PROJECT_PATH)/../../common/QRCode \
+                        $(PROJECT_PATH)/../../common/screen-framework \
+
+CXXFLAGS += -std=c++11 -Os -DLWIP_IPV6_SCOPES=0
+CPPFLAGS += -Os -DLWIP_IPV6_SCOPES=0
+CFLAGS += -Os -DLWIP_IPV6_SCOPES=0
+
+CHIP_BUILD_WITH_GN ?= ""
+
+ifneq ($(CHIP_BUILD_WITH_GN),n)
+CPPFLAGS += -DCHIP_SEPARATE_CONFIG_H
+endif
+export CHIP_BUILD_WITH_GN
+include $(IDF_PATH)/make/project.mk

examples/temperature-measurement-app/esp32/README.md

@@ -0,0 +1,3 @@
+# Temperature Sensor Example
+
+// TODO Fill this out

examples/temperature-measurement-app/esp32/idf.sh

@@ -0,0 +1,46 @@
+#!/usr/bin/env bash
+#
+#   Copyright (c) 2020 Project CHIP Authors
+#   All rights reserved.
+#
+#   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.
+
+# If this file is sourced, it exports a function called "idf" that initializes
+# the espressif environment via the espressive export.sh script and runs
+# a command presented as arguments
+#
+# This file can also be used as an executable
+
+error() {
+    echo "$me: *** ERROR: " "${*}"
+}
+
+idf() {
+    [[ -d $IDF_PATH && -r $IDF_PATH/export.sh ]] || {
+        error "can't find IDF's export.sh, please set IDF_PATH"
+        return 1
+    }
+    (
+        # shellcheck source=/dev/null
+        . "$IDF_PATH/export.sh"
+        export IDF_PATH
+        "$@"
+    )
+}
+if [[ ${0} == "${BASH_SOURCE[0]}" ]]; then
+    me=${0##*/}
+    idf "${@}"
+else
+    me=idf
+    [[ $PS1 =~ \[idf\].* ]] || PS1="[idf]$PS1"
+fi

examples/temperature-measurement-app/esp32/main/CHIPDeviceManager.cpp

@@ -0,0 +1,109 @@
+/*
+ *
+ *    Copyright (c) 2020 Project CHIP Authors
+ *
+ *    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.
+ */
+
+/**
+ *    @file
+ *      This file implements the CHIP Device Interface that is used by
+ *      applications to interact with the CHIP stack
+ *
+ */
+
+#include <stdlib.h>
+
+#include "CHIPDeviceManager.h"
+#include <setup_payload/SetupPayload.h>
+#include <support/CHIPMem.h>
+#include <support/CodeUtils.h>
+#include <support/ErrorStr.h>
+
+namespace chip {
+
+namespace DeviceManager {
+
+using namespace ::chip::DeviceLayer;
+
+void CHIPDeviceManager::CommonDeviceEventHandler(const ChipDeviceEvent * event, intptr_t arg)
+{
+    CHIPDeviceManagerCallbacks * cb = reinterpret_cast<CHIPDeviceManagerCallbacks *>(arg);
+    if (cb != nullptr)
+    {
+        cb->DeviceEventCallback(event, reinterpret_cast<intptr_t>(cb));
+    }
+}
+
+/**
+ *
+ */
+CHIP_ERROR CHIPDeviceManager::Init(CHIPDeviceManagerCallbacks * cb)
+{
+    CHIP_ERROR err;
+    mCB = cb;
+
+    // Initialize the CHIP stack.
+    err = PlatformMgr().InitChipStack();
+    SuccessOrExit(err);
+
+    switch (static_cast<RendezvousInformationFlags>(CONFIG_RENDEZVOUS_MODE))
+    {
+    case RendezvousInformationFlags::kBLE:
+        ConnectivityMgr().SetBLEAdvertisingEnabled(ConnectivityManager::kCHIPoBLEServiceMode_Enabled);
+        break;
+
+    case RendezvousInformationFlags::kWiFi:
+        ConnectivityMgr().SetBLEAdvertisingEnabled(ConnectivityManager::kCHIPoBLEServiceMode_Disabled);
+        ConnectivityMgr().SetWiFiAPMode(ConnectivityManager::kWiFiAPMode_Enabled);
+        break;
+
+    case RendezvousInformationFlags::kNone:
+        // If rendezvous is bypassed, enable SoftAP so that the device can still
+        // be communicated with via its SoftAP as needed.
+        ConnectivityMgr().SetWiFiAPMode(ConnectivityManager::kWiFiAPMode_Enabled);
+        break;
+
+    default:
+        break;
+    }
+
+    err = Platform::MemoryInit();
+    SuccessOrExit(err);
+
+    // Register a function to receive events from the CHIP device layer.  Note that calls to
+    // this function will happen on the CHIP event loop thread, not the app_main thread.
+    PlatformMgr().AddEventHandler(CHIPDeviceManager::CommonDeviceEventHandler, reinterpret_cast<intptr_t>(cb));
+
+    // Start a task to run the CHIP Device event loop.
+    err = PlatformMgr().StartEventLoopTask();
+    SuccessOrExit(err);
+
+exit:
+    return err;
+}
+
+extern "C" {
+void emberAfPostAttributeChangeCallback(uint8_t endpoint, EmberAfClusterId clusterId, EmberAfAttributeId attributeId, uint8_t mask,
+                                        uint16_t manufacturerCode, uint8_t type, uint8_t size, uint8_t * value)
+{
+    CHIPDeviceManagerCallbacks * cb = CHIPDeviceManager::GetInstance().GetCHIPDeviceManagerCallbacks();
+    if (cb != nullptr)
+    {
+        cb->PostAttributeChangeCallback(endpoint, clusterId, attributeId, mask, manufacturerCode, type, size, value);
+    }
+}
+} // extern "C"
+
+} // namespace DeviceManager
+} // namespace chip

examples/temperature-measurement-app/esp32/main/DataModelHandler.cpp

@@ -0,0 +1,79 @@
+/*
+ *
+ *    Copyright (c) 2020 Project CHIP Authors
+ *
+ *    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.
+ */
+
+/**
+ * @file
+ *   This file implements the handler for data model messages.
+ */
+
+#include "esp_log.h"
+#include <system/SystemPacketBuffer.h>
+#include <transport/raw/MessageHeader.h>
+
+#include "DataModelHandler.h"
+
+#include "attribute-storage.h"
+#include "gen/attribute-id.h"
+#include "gen/cluster-id.h"
+#include "gen/znet-bookkeeping.h"
+#include "util.h"
+#include <app/chip-zcl-zpro-codec.h>
+
+using namespace ::chip;
+
+static const char * TAG = "data_model_server";
+
+void InitDataModelHandler()
+{
+    emberAfEndpointConfigure();
+    emAfInit();
+}
+
+void HandleDataModelMessage(const PacketHeader & header, System::PacketBuffer * buffer, SecureSessionMgrBase * mgr)
+{
+    EmberApsFrame frame;
+    bool ok = extractApsFrame(buffer->Start(), buffer->DataLength(), &frame) > 0;
+    if (ok)
+    {
+        ESP_LOGI(TAG, "APS frame processing success!");
+    }
+    else
+    {
+        ESP_LOGI(TAG, "APS frame processing failure");
+        System::PacketBuffer::Free(buffer);
+        return;
+    }
+
+    uint8_t * message;
+    uint16_t messageLen = extractMessage(buffer->Start(), buffer->DataLength(), &message);
+    ok                  = emberAfProcessMessage(&frame,
+                               0, // type
+                               message, messageLen,
+                               header.GetSourceNodeId().Value(), // source identifier
+                               nullptr);
+
+    System::PacketBuffer::Free(buffer);
+
+    if (ok)
+    {
+        ESP_LOGI(TAG, "Data model processing success!");
+    }
+    else
+    {
+        ESP_LOGI(TAG, "Data model processing failure");
+    }
+}

examples/temperature-measurement-app/esp32/main/DeviceCallbacks.cpp

@@ -0,0 +1,97 @@
+/*
+ *
+ *    Copyright (c) 2020 Project CHIP Authors
+ *    All rights reserved.
+ *
+ *    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.
+ */
+
+/**
+ * @file DeviceCallbacks.cpp
+ *
+ * Implements all the callbacks to the application from the CHIP Stack
+ *
+ **/
+#include "DeviceCallbacks.h"
+
+#include "esp_heap_caps.h"
+#include "esp_log.h"
+#include <support/CodeUtils.h>
+
+extern "C" {
+#include "../gen/attribute-id.h"
+#include "../gen/cluster-id.h"
+} // extern "C"
+
+static const char * TAG = "echo-devicecallbacks";
+
+using namespace ::chip::Inet;
+using namespace ::chip::System;
+using namespace ::chip::DeviceLayer;
+
+void DeviceCallbacks::DeviceEventCallback(const ChipDeviceEvent * event, intptr_t arg)
+{
+    switch (event->Type)
+    {
+    case DeviceEventType::kInternetConnectivityChange:
+        OnInternetConnectivityChange(event);
+        break;
+
+    case DeviceEventType::kSessionEstablished:
+        OnSessionEstablished(event);
+        break;
+    }
+
+    ESP_LOGI(TAG, "Current free heap: %d\n", heap_caps_get_free_size(MALLOC_CAP_8BIT));
+}
+
+void DeviceCallbacks::PostAttributeChangeCallback(uint8_t endpointId, EmberAfClusterId clusterId, EmberAfAttributeId attributeId,
+                                                  uint8_t mask, uint16_t manufacturerCode, uint8_t type, uint8_t size,
+                                                  uint8_t * value)
+{
+    ESP_LOGI(TAG, "PostAttributeChangeCallback - Cluster ID: '0x%04x', EndPoint ID: '0x%02x', Attribute ID: '0x%04x'", clusterId,
+             endpointId, attributeId);
+
+    // TODO handle this callback in switch statement
+    ESP_LOGI(TAG, "Unhandled cluster ID: %d", clusterId);
+
+    ESP_LOGI(TAG, "Current free heap: %d\n", heap_caps_get_free_size(MALLOC_CAP_8BIT));
+}
+
+void DeviceCallbacks::OnInternetConnectivityChange(const ChipDeviceEvent * event)
+{
+    if (event->InternetConnectivityChange.IPv4 == kConnectivity_Established)
+    {
+        ESP_LOGI(TAG, "Server ready at: %s:%d", event->InternetConnectivityChange.address, CHIP_PORT);
+    }
+    else if (event->InternetConnectivityChange.IPv4 == kConnectivity_Lost)
+    {
+        ESP_LOGE(TAG, "Lost IPv4 connectivity...");
+    }
+    if (event->InternetConnectivityChange.IPv6 == kConnectivity_Established)
+    {
+        ESP_LOGI(TAG, "IPv6 Server ready...");
+    }
+    else if (event->InternetConnectivityChange.IPv6 == kConnectivity_Lost)
+    {
+        ESP_LOGE(TAG, "Lost IPv6 connectivity...");
+    }
+}
+
+void DeviceCallbacks::OnSessionEstablished(const ChipDeviceEvent * event)
+{
+    if (event->SessionEstablished.IsCommissioner)
+    {
+        ESP_LOGI(TAG, "Commissioner detected!");
+    }
+}