Show a QRCode and status on the M5Stack's display (project-chip#890)

* Add display support for the ESP32

* Attempt to use real payload

* Restyled by clang-format

* Leave the DevKit-C as the default device

* Fix the ESP build in CI

* Update docs

* Restyled by prettier-markdown

* Minor tweak to docs

* Restyled by prettier-markdown

* Fix missing word in doc

Co-authored-by: Restyled.io <commits@restyled.io>

Author: sagar-apple

.gitignore

@@ -27,6 +27,8 @@ third_party/nlfaultinjection/
 third_party/nlio/
 third_party/nlunit-test/
 third_party/mbedtls/
+examples/common/m5stack-tft/
+examples/common/QRCode/repo
 
 # Example specific rules
 examples/**/sdkconfig

config/esp32/components/chip/component.mk

@@ -142,7 +142,8 @@ COMPONENT_ADD_INCLUDEDIRS 	 = project-config \
                                $(REL_CHIP_ROOT)/src/lib \
                                $(REL_CHIP_ROOT)/src/ \
                                $(REL_CHIP_ROOT)/src/system \
-                               $(IDF_PATH)/components/mbedtls/mbedtls/include
+                               $(IDF_PATH)/components/mbedtls/mbedtls/include \
+                               $(REL_CHIP_ROOT)/src/app \
 
 
 # Linker flags to be included when building other components that use CHIP.
@@ -151,7 +152,8 @@ COMPONENT_ADD_LDFLAGS        = -L$(OUTPUT_DIR)/lib/ \
                                -lInetLayer \
                                -lSystemLayer \
                                -lDeviceLayer \
-                               -lChipCrypto
+                               -lChipCrypto \
+                               -lSetupPayload
 
 # Tell the ESP-IDF build system that the CHIP component defines its own build
 # and clean targets.

examples/common/QRCode/component.mk

@@ -0,0 +1,27 @@
+#
+#    Copyright (c) 2020 Project CHIP Authors
+#    Copyright (c) 2018 Nest Labs, Inc.
+#    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.
+#
+#    Description:
+#      Component makefile for the QRCode component used by the CHIP
+#      ESP32 demo applications.
+#
+
+CFLAGS += -Wno-unknown-pragmas
+
+COMPONENT_ADD_INCLUDEDIRS := repo/c
+COMPONENT_SRCDIRS := repo/c
+COMPONENT_OBJS := repo/c/qrcodegen.o

examples/wifi-echo/server/esp32/Makefile

@@ -1,10 +1,28 @@
+#
+#    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
+EXTRA_COMPONENT_DIRS += $(PROJECT_PATH)/third_party/connectedhomeip/config/esp32/components \
+                        $(PROJECT_PATH)/../../../common/m5stack-tft/repo/components \
+                        $(PROJECT_PATH)/../../../common/QRCode \
 
 include $(IDF_PATH)/make/project.mk

examples/wifi-echo/server/esp32/README.md

@@ -18,8 +18,9 @@ messaging is supported in CHIP.
 The CHIP demo application is intended to work on two categories of ESP32
 devices: the
 [ESP32-DevKitC](https://www.espressif.com/en/products/hardware/esp32-devkitc/overview),
-and the [M5Stack](http://m5stack.com). Support for the
-[M5Stack](http://m5stack.com) is still a Work in Progress.
+and the [M5Stack](http://m5stack.com). On the [M5Stack](http://m5stack.com) this
+example displays a CHIP QRCode with the device's Soft-AP SSID encoded in the TLV
+section.
 
 ## Building the Example Application
 
@@ -45,13 +46,25 @@ step. To install these components manually, follow these steps:
 Currently building in VSCode _and_ deploying from native is not supported, so
 make sure the IDF_PATH has been exported(See the manual setup steps above).
 
--   In the root of the example directory, source `idf.sh` and use the
-    `defconfig` make target to configure the application with defaults.
+-   In the root of the example directory, sync the dependencies and source
+    `idf.sh`. Note: This does not have to be repeated for incremental builds.
 
+          $ make -C third_party/connectedhomeip -f Makefile-bootstrap repos
           $ source idf.sh
+
+-   Next, if you want to use the M5Stack with its display and show a QRCode run
+    `menuconfig`.
+
+          $ idf make menuconfig
+
+    While in the configurator, navigate to `WiFi Echo Demo`->`Device Type` and
+    select `M5Stack`.
+
+    Otherwise, run the default config.
+
           $ idf make defconfig
 
--   Run make to build the demo application
+-   Run make to build the demo application.
 
           $ idf make
 
@@ -105,6 +118,10 @@ There are two ways to use the Echo Server running on the device.
                 I (5524) chip[DL]: SYSTEM_EVENT_STA_GOT_IP
                 I (5524) chip[DL]: IPv4 address changed on WiFi station interface: <IP_ADDRESS>...
 
+    Note: If you are using the M5Stack, the screen will display the server's IP
+    Address and Port if it successfully conencts to the configured 2.4GHz
+    Network.
+
 5.  Then running the following command will ping the ESP32 and cause it to echo.
     If necessary replace the `<IP_ADDRESS>` with the address printed by the
     device in the monitor.
@@ -120,9 +137,10 @@ your network configuration. To erase it, simply run.
 
 Alternatively, you can connect to the ESP32's Soft-AP directly.
 
-1.  After the application has been flashed, connect the ESP32's Soft-AP. It's
-    usually something like `CHIP_DEMO-XXXX` where the last 4 digits are from the
-    device's MAC address.
+1.  After the application has been flashed, connect the ESP32's Soft-AP. If you
+    use the M5Stack, the Soft-AP's SSID is encoded in the TLV section of the
+    QRCode on screen. It's usually something like `CHIP_DEMO-XXXX` where the
+    last 4 digits are from the device's MAC address.
 
 2.  Once you're connected, the server's IP can be found at the gateway address
     and at the listed port number(Default: `8000`).

examples/wifi-echo/server/esp32/main/Button.cpp

@@ -0,0 +1,74 @@
+/*
+ *
+ *    Copyright (c) 2020 Project CHIP Authors
+ *    Copyright (c) 2018 Nest Labs, Inc.
+ *    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.
+ */
+
+#include "driver/gpio.h"
+#include "esp_log.h"
+#include "esp_system.h"
+
+#include "Button.h"
+#include <platform/CHIPDeviceLayer.h>
+#include <support/CodeUtils.h>
+
+extern const char * TAG;
+
+esp_err_t Button::Init(gpio_num_t gpioNum, uint16_t debouncePeriod)
+{
+    esp_err_t err;
+
+    mGPIONum        = gpioNum;
+    mDebouncePeriod = debouncePeriod / portTICK_PERIOD_MS;
+    mState          = false;
+    mLastState      = false;
+
+    err = gpio_set_direction(gpioNum, GPIO_MODE_INPUT);
+    SuccessOrExit(err);
+
+    Poll();
+
+exit:
+    return err;
+}
+
+bool Button::Poll()
+{
+    uint32_t now = xTaskGetTickCount();
+
+    bool newState = gpio_get_level(mGPIONum) == 0;
+
+    if (newState != mLastState)
+    {
+        mLastState    = newState;
+        mLastReadTime = now;
+    }
+
+    else if (newState != mState && (now - mLastReadTime) >= mDebouncePeriod)
+    {
+        mState          = newState;
+        mPrevStateDur   = now - mStateStartTime;
+        mStateStartTime = now;
+        return true;
+    }
+
+    return false;
+}
+
+uint32_t Button::GetStateDuration()
+{
+    return (xTaskGetTickCount() - mStateStartTime) * portTICK_PERIOD_MS;
+}