espressif/esp-matter
1
0
Fork 0
mirror of https://github.com/espressif/esp-matter.git synced 2026-04-27 19:13:13 +00:00
Code Issues Packages Projects Releases Wiki Activity

Remove app_qrcode component and do not print it in examples.

Browse Source 
Added the default QR code to the docs and pointer to generate the new
factory partition and qr code.
This commit is contained in:
Shubham Patil
2022-09-16 12:52:41 +05:30
parent 5cfb20af8a
commit 4d55e2f8d9
17 changed files with 72 additions and 249 deletions
Download Patch File Download Diff File Expand all files Collapse all files
examples/blemesh_bridge/main/CMakeLists.txt
+1 -1
View File
@@ -1,4 +1,4 @@
set(PRIV_REQUIRES_LIST device esp_matter esp_matter_console route_hook app_qrcode app_bridge)
set(PRIV_REQUIRES_LIST device esp_matter esp_matter_console route_hook app_bridge)
idf_component_register(SRC_DIRS "."
PRIV_INCLUDE_DIRS "."
examples/blemesh_bridge/main/app_main.cpp
-3
View File
@@ -14,7 +14,6 @@
#include <esp_matter_console.h>
#include <esp_matter_ota.h>
#include <app_qrcode.h>
#include <app_bridged_device.h>
#include "blemesh_bridge.h"
@@ -103,8 +102,6 @@ extern "C" void app_main()
ESP_LOGE(TAG, "Matter start failed: %d", err);
}
app_qrcode_print();
#if CONFIG_ENABLE_CHIP_SHELL
esp_matter_console_diagnostics_register_commands();
esp_matter_console_init();
examples/common/app_qrcode/CMakeLists.txt
-8
View File
@@ -1,8 +0,0 @@
set(priv_requires_list chip bt esp32_mbedtls qrcode)
if ("${IDF_TARGET}" STREQUAL "esp32h2")
list(APPEND priv_requires_list openthread)
endif()
idf_component_register(SRCS app_qrcode.cpp
INCLUDE_DIRS .
PRIV_REQUIRES ${priv_requires_list})
examples/common/app_qrcode/app_qrcode.cpp
-192
View File
@@ -1,192 +0,0 @@
/*
This example code is in the Public Domain (or CC0 licensed, at your option.)
Unless required by applicable law or agreed to in writing, this
software is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR
CONDITIONS OF ANY KIND, either express or implied.
*/
#include <string>
#include <core/CHIPError.h>
#include <esp_log.h>
#include <platform/CHIPDeviceLayer.h>
#include <platform/CommissionableDataProvider.h>
#include <platform/DeviceInstanceInfoProvider.h>
#include <setup_payload/ManualSetupPayloadGenerator.h>
#include <setup_payload/QRCodeSetupPayloadGenerator.h>
#include <setup_payload/SetupPayload.h>
#include <app_qrcode.h>
#include <qrcode.h>
using namespace ::chip;
using namespace ::chip::DeviceLayer;
#define QRCODE_BASE_URL "https://dhrishi.github.io/connectedhomeip/qrcode.html"
static const char *TAG = "app_qrcode";
esp_err_t app_qrcode_get_payload(char **qrcode_text, char **short_manual_code_text, char **long_manual_code_text)
{
CHIP_ERROR err = CHIP_NO_ERROR;
esp_err_t ret = ESP_OK;
uint16_t discriminator;
uint32_t setup_pin_code;
uint16_t vendor_id;
uint16_t product_id;
SetupPayload payload;
std::string qrcode_payload;
std::string short_manual_code_payload;
std::string long_manual_code_payload;
/* Get details */
err = GetCommissionableDataProvider()->GetSetupDiscriminator(discriminator);
if (err != CHIP_NO_ERROR) {
ESP_LOGE(TAG, "Couldn't get discriminator: %s", ErrorStr(err));
return ESP_FAIL;
}
err = GetCommissionableDataProvider()->GetSetupPasscode(setup_pin_code);
if (err != CHIP_NO_ERROR) {
ESP_LOGE(TAG, "Couldn't get setup_pin_code: %s", ErrorStr(err));
return ESP_FAIL;
}
err = GetDeviceInstanceInfoProvider()->GetVendorId(vendor_id);
if (err != CHIP_NO_ERROR) {
ESP_LOGE(TAG, "Couldn't get vendor_id: %s", ErrorStr(err));
return ESP_FAIL;
}
err = GetDeviceInstanceInfoProvider()->GetProductId(product_id);
if (err != CHIP_NO_ERROR) {
ESP_LOGE(TAG, "Couldn't get product_id: %s", ErrorStr(err));
return ESP_FAIL;
}
ESP_LOGI(TAG, "Setup discriminator: %u (0x%x)", discriminator, discriminator);
ESP_LOGI(TAG, "Setup PIN code: %u (0x%x)", setup_pin_code, setup_pin_code);
ESP_LOGI(TAG, "Vendor ID: %u (0x%x)", vendor_id, vendor_id);
ESP_LOGI(TAG, "Product ID: %u (0x%x)", product_id, product_id);
/* Set details */
payload.version = 0;
payload.discriminator.SetLongValue(discriminator);
payload.setUpPINCode = setup_pin_code;
payload.rendezvousInformation.SetValue(RendezvousInformationFlags(chip::RendezvousInformationFlag::kBLE));
payload.vendorID = vendor_id;
payload.productID = product_id;
/* Change format and alloc for qrcode */
QRCodeSetupPayloadGenerator qrcode_generator(payload);
err = qrcode_generator.payloadBase38Representation(qrcode_payload);
if (err == CHIP_NO_ERROR) {
*qrcode_text = (char *)calloc(1, qrcode_payload.length() + 1);
if (*qrcode_text) {
strcpy(*qrcode_text, qrcode_payload.c_str());
}
} else {
ESP_LOGE(TAG, "Couldn't get qrcode payload string %s", ErrorStr(err));
ret = ESP_FAIL;
}
/* Change format and alloc for short manual code. This can be used for 'non qrcode' devices. */
ManualSetupPayloadGenerator short_manual_code_generator(payload);
err = short_manual_code_generator.payloadDecimalStringRepresentation(short_manual_code_payload);
if (err == CHIP_NO_ERROR) {
*short_manual_code_text = (char *)calloc(1, short_manual_code_payload.length() + 1);
if (*short_manual_code_text) {
strcpy(*short_manual_code_text, short_manual_code_payload.c_str());
}
} else {
ESP_LOGE(TAG, "Couldn't get short manual code payload string %s", ErrorStr(err));
ret = ESP_FAIL;
}
/* Change format and alloc for long manual code. This can be used for 'non qrcode' devices. */
/* Just adding this extra commissioning flow to the payload. */
payload.commissioningFlow = CommissioningFlow::kCustom;
ManualSetupPayloadGenerator long_manual_code_generator(payload);
err = long_manual_code_generator.payloadDecimalStringRepresentation(long_manual_code_payload);
if (err == CHIP_NO_ERROR) {
*long_manual_code_text = (char *)calloc(1, long_manual_code_payload.length() + 1);
if (*long_manual_code_text) {
strcpy(*long_manual_code_text, long_manual_code_payload.c_str());
}
} else {
ESP_LOGE(TAG, "Couldn't get long manual code payload string %s", ErrorStr(err));
ret = ESP_FAIL;
}
return ret;
}
esp_err_t app_qrcode_print()
{
/* Get */
char *qrcode_text = NULL;
char *short_manual_code_text = NULL;
char *long_manual_code_text = NULL;
bool manual_code_exists = false;
esp_err_t err = app_qrcode_get_payload(&qrcode_text, &short_manual_code_text, &long_manual_code_text);
if (err != ESP_OK) {
ESP_LOGE(TAG, "Error getting payload %d", err);
}
/* Manual code */
if (short_manual_code_text || long_manual_code_text) {
/* This flag is just used for the print at the end */
manual_code_exists = true;
}
/* Short manual code */
if (short_manual_code_text) {
/* Print */
ESP_LOGI(TAG, "Short manual code: %s", short_manual_code_text);
/* Free */
free(short_manual_code_text);
} else {
ESP_LOGE(TAG, "Error getting short manual code text");
err = ESP_FAIL;
}
/* Long manual code */
if (long_manual_code_text) {
/* Print */
ESP_LOGI(TAG, "Long manual code: %s", long_manual_code_text);
/* Free */
free(long_manual_code_text);
} else {
ESP_LOGE(TAG, "Error getting long manual code text");
err = ESP_FAIL;
}
/* QR code */
if (qrcode_text) {
/* Print */
ESP_LOGI(TAG, "Scan this QR code from the Matter phone app for Commissioning.");
esp_qrcode_config_t cfg = ESP_QRCODE_CONFIG_DEFAULT();
/* Changing the error tolerance to MED. This increases the size of the qr code and makes it more detailed. The
* default is set to LOW and sometimes the qr code scanner is not able to recognize that. */
cfg.qrcode_ecc_level = ESP_QRCODE_ECC_MED;
esp_qrcode_generate(&cfg, qrcode_text);
ESP_LOGI(TAG, "If QR code is not visible, copy paste the URL in a browser: %s?data=%s", QRCODE_BASE_URL,
qrcode_text);
/* Free */
free(qrcode_text);
} else {
ESP_LOGE(TAG, "Error getting qrcode text");
err = ESP_FAIL;
}
if (manual_code_exists) {
ESP_LOGI(TAG,
"In case QR code is not supported, manual code mentioned above can be entered in the Matter phone app "
"for Commissioning");
}
return err;
}
examples/common/app_qrcode/app_qrcode.h
-29
View File
@@ -1,29 +0,0 @@
/*
This example code is in the Public Domain (or CC0 licensed, at your option.)
Unless required by applicable law or agreed to in writing, this
software is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR
CONDITIONS OF ANY KIND, either express or implied.
*/
#pragma once
#include <esp_err.h>
#ifdef __cplusplus
extern "C" {
#endif
/** Print the QR code for commissioning
*
* Fetch the QR code details for commissioning from Matter and print it on the console.
* Also print the manual code if QR code is not supported.
*
* @return ESP_OK on success.
* @return error in case of failure.
*/
esp_err_t app_qrcode_print();
#ifdef __cplusplus
}
#endif
examples/common/app_qrcode/idf_component.yml
-2
View File
@@ -1,2 +0,0 @@
dependencies:
qrcode: "^0.1.0"
examples/light/main/CMakeLists.txt
+1 -1
View File
@@ -1,4 +1,4 @@
set(PRIV_REQUIRES_LIST device esp_matter esp_matter_console route_hook app_qrcode app_reset)
set(PRIV_REQUIRES_LIST device esp_matter esp_matter_console route_hook app_reset)
idf_component_register(SRC_DIRS "."
PRIV_INCLUDE_DIRS "."
examples/light/main/app_main.cpp
-2
View File
@@ -15,7 +15,6 @@
#include <esp_matter_ota.h>
#include <app_priv.h>
#include <app_qrcode.h>
#include <app_reset.h>
static const char *TAG = "app_main";
@@ -127,7 +126,6 @@ extern "C" void app_main()
if (err != ESP_OK) {
ESP_LOGE(TAG, "Matter start failed: %d", err);
}
app_qrcode_print();
/* Starting driver with default values */
app_driver_light_set_defaults(light_endpoint_id);
examples/light_switch/main/CMakeLists.txt
+1 -1
View File
@@ -1,4 +1,4 @@
set(PRIV_REQUIRES_LIST device esp_matter esp_matter_console route_hook app_qrcode app_reset)
set(PRIV_REQUIRES_LIST device esp_matter esp_matter_console route_hook app_reset)
idf_component_register(SRC_DIRS "."
PRIV_INCLUDE_DIRS "."
examples/light_switch/main/app_main.cpp
-2
View File
@@ -15,7 +15,6 @@
#include <esp_matter_ota.h>
#include <app_priv.h>
#include <app_qrcode.h>
#include <app_reset.h>
static const char *TAG = "app_main";
@@ -113,7 +112,6 @@ extern "C" void app_main()
if (err != ESP_OK) {
ESP_LOGE(TAG, "Matter start failed: %d", err);
}
app_qrcode_print();
#if CONFIG_ENABLE_CHIP_SHELL
esp_matter_console_diagnostics_register_commands();
examples/zap_light/main/CMakeLists.txt
+1 -1
View File
@@ -1,4 +1,4 @@
set(PRIV_REQUIRES_LIST device esp_matter esp_matter_console route_hook app_qrcode app_reset)
set(PRIV_REQUIRES_LIST device esp_matter esp_matter_console route_hook app_reset)
idf_component_register(SRC_DIRS "."
PRIV_INCLUDE_DIRS "."
examples/zap_light/main/app_main.cpp
-2
View File
@@ -14,7 +14,6 @@
#include <esp_matter_console.h>
#include <app_priv.h>
#include <app_qrcode.h>
#include <app_reset.h>
using namespace esp_matter;
@@ -95,7 +94,6 @@ extern "C" void app_main()
if (err != ESP_OK) {
ESP_LOGE(TAG, "Matter start failed: %d", err);
}
app_qrcode_print();
/* Starting driver with default values */
app_driver_light_set_defaults(light_endpoint_id);
examples/zigbee_bridge/main/CMakeLists.txt
+1 -1
View File
@@ -1,4 +1,4 @@
set(PRIV_REQUIRES_LIST device esp_matter esp_matter_console route_hook app_qrcode app_bridge
set(PRIV_REQUIRES_LIST device esp_matter esp_matter_console route_hook app_bridge
esp-zboss-lib)
idf_component_register(SRC_DIRS "."
examples/zigbee_bridge/main/app_main.cpp
-3
View File
@@ -15,7 +15,6 @@
#include <esp_matter_ota.h>
#include <app_bridged_device.h>
#include <app_qrcode.h>
#include <app_zboss.h>
#include <zigbee_bridge.h>
@@ -102,8 +101,6 @@ extern "C" void app_main()
ESP_LOGE(TAG, "Matter start failed: %d", err);
}
app_qrcode_print();
#if CONFIG_ENABLE_CHIP_SHELL
esp_matter_console_diagnostics_register_commands();
esp_matter_console_init();
examples/zigbee_bridge/main/idf_component.yml
-1
View File
@@ -2,7 +2,6 @@
dependencies:
espressif/esp-zboss-lib: "~0.1.0"
espressif/esp-zigbee-lib: "~0.1.1"
qrcode: "^0.1.0"
espressif/mdns: "^1.0.3"
## Required IDF version
idf: