3 Star 7 Fork 10

乐鑫开源 / esp-qcloud

加入 Gitee
与超过 1200万 开发者一起发现、参与优秀开源项目,私有仓库也完全免费 :)
免费加入
克隆/下载
贡献代码
同步代码
取消
提示: 由于 Git 不支持空文件夾,创建文件夹后会生成空的 .keep 文件
Loading...
README
Apache-2.0

ESP32 设备对接腾讯云指南

目录

  1. 介绍
  2. 硬件准备
  3. IDF环境搭建
  4. 构建&烧录&运行工程
  5. 调试工具
  6. 相关资源

0. 介绍

esp-qcloud 是由 乐鑫官方 推出接入 腾讯物联网开发平台 (IoT Explorer) 的开发套件 。该套件依据 IoT Explorer 通信协议而设计,相对于 腾讯云物联 IoT C-SDK,该套件将云平台配置、配网操作封装成接口,简化了整体流程,只需完成简单的调用,即可完成配网、连云操作。同时,该套件提供了丰富的调试工具、示例代码、量产工具供你快速完成产品开发。

当前 IDF 支持情况如下表:

ESP-IDF
Release/v3.3
ESP-IDF
Release/v4.0
ESP-IDF
Release/v4.1
ESP-IDF
Release/v4.2
ESP-IDF
Release/v4.3
ESP-IDF
Release/v4.4
ESP-IDF
Master
esp-qcloud
Master
  • 配网方式

    • softap
    • airkiss
    • esp-touch v1
    • ble
    • provisioning softap
    • esp-touch v2
  • 认证方式

    • 密钥认证
    • 证书认证
    • 动态注册
  • 业务功能

    • 状态上报与下发
    • OTA升级
    • 事件上报
    • 网关
  • 调试功能

    • 日志上报云平台
    • 日志本地存储
    • 串口调试
  • 生产工具

    • 单一/批量 bin 生成
    • 加密

1.硬件准备

  • 模组

    • ESP32
    • ESP32-S2
    • ESP32-C3
    • ESP32-S3

2. IDF 环境搭建

  • 可以参考 ESP-IDF编程指南-快速入门 快速完成工具链与环境的搭建

  • 构建工程之前需将 ESP-IDF 切换到合适版本。当前支持的 IDF 版本请查阅此处

    cd  $IDF_PATH 
    
    git checkout release/v4.3 
    
    git submodule update --init --recursive

3. 构建&烧录&运行工程

  1. 提取项目文件

    你可以直接在 examples 目录下提取文件,也可以通过将 esp-qcloud 作为 git 子模块进行开发。

    1. 直接提取开发

      #Copy example
      cp -r ./examples/led_light ./examples/my_project
      
      #Delete unnecessary files
      cd ./examples/my_project
      idf.py fullclean
    2. 通过 git 管理开发

      esp-qcloud 作为 git 子模块进行开发,无需在此项目中复制或编辑任何文件,可更方便的维护和更新本项目。

      #Copy example
      cp -r ./examples/led_light ~/my_project
      cd ~/my_project
      
      #Register submodule
      git init
      mkdir -p components
      
      #Choice 1
      git submodule add https://github.com/espressif/esp-qcloud.git components/qcloud
      #Choice 2
      git submodule add https://gitee.com/espressifsystems/esp-qcloud.git components/qcloud
      
      #Delete unnecessary files
      idf.py fullclean
  2. 配置芯片

    不同的芯片会加载不同的 sdkconfig 默认文件,位于 config 目录下。默认的 sdkconfig 文件会加载 4MB分区表 (partitions) 。如果芯片 flash 小于 4MB ,需要将其更改为 2MB 的分区表。下述几个命令将帮助你快速配置芯片。

    • 查看当前芯片信息

      $IDF_PATH/components/esptool_py/esptool/esptool.py flash_id
    • 设置编译时目标芯片

      #choose esp32
      idf.py set-target esp32 
      
      #choose esp32s2
      idf.py set-target esp32s2
      
      #choose esp32c3
      idf.py set-target esp32c3
    • 更改 Partition

      1. 进入 menuconfig 配置界面

        idf.py menuconfig
      2. 选择 Partition Table

        Partition Table (Custom partition table CSV)  --->
        (${QCLOUD_PATH}/config/partition_table/partitions_4MB.csv) Custom partition CSV file
        (0xc000) Offset of partition table
        [*] Generate an MD5 checksum for the partition table
        • Custom partition CSV file 中即可编辑 CSV 文件。
  3. 烧录认证信息[可选]

    当使用云平台时,你需要在 IoT Explorer 获取认证信息,认证信息通常为 产品 ID (PRODUCT_ID)设备名称 (DEVICE_NAME)设备密钥 (DEVICE_SECRET),可参考 智能灯文档烧录认证信息IoT Explorer 官方文档 进行平台参数设置、获取。获取到认证信息时,可以选择下述任意一种方式烧录。

    • 通过 menuconfig 配置

      1. 进入 menuconfig 配置界面

        idf.py menuconfig
      2. 选择 ESP QCloud Config 选项

        [ ] ESP QCloud Mass Manufacture
        (PRODUCT_ID) Product ID
        (DEVICE_NAME) Device Name
        (DEVICE_SECRET) Device Secret
        ESP QCloud OTA Config  --->
        ESP QCloud utils  --->
        ESP QCloud Log Config  --->
        UART for console input (UART0)  --->
        • 不开启 ESP QCloud Mass Manufacture 选项。
      3. 填入你的信息

        填写 产品 ID (PRODUCT_ID)设备名称 (DEVICE_NAME)设备密钥 (DEVICE_SECRET)

    • 通过量产工具配置

      请参考量产工具目录下的 文档 ,另外需要 开启 ESP QCloud Mass Manufacture 选项。

  4. 构建项目

    当完成配置,下述命令将帮助快速构建。

    • 构建工程
    idf.py build
    • 清理工程
    idf.py fullclean
    • 性能选择

      通过在编译时传递 PERF 定义来决定开启的性能。未指定参数时将使用 defaults 配置,关于性能的说明,请参考 性能说明文档

    #high performance
    idf.py menuconfig -D PERF="hight_perf"
    
    #low performance
    idf.py menuconfig -D PERF="low_perf"
  5. 运行项目

    • 下载、运行工程
    idf.py flash monitor
    • 擦除 Flash
    idf.py erase_flash

4. 调试工具

  • 串口调试

    串口调试允许通过串口查看当前设备信息,开启方法如下:

    1. 进入 menuconfig 配置界面

      idf.py menuconfig
    2. 选择 ESP QCloud Example Configuration

      Light development board selection   --->
      Light provisioning network selection  --->
      (5) More than this number of continuous uninterrupted restarts triggers a reset of the device
      [*] The device will be in debug mode
      • 开启 The device will be in debug mode 选项。
    3. 查看调试信息

      • 下述为 led_light 中的打印信息。
      I (31091) esp_qcloud_utils: System information sta_mac: 24:6f:28:80:3f:14, channel: [10/2], rssi: -40, free_heap: 181128, minimum_heap: 161540
      • 通过 shell 输入指令可查看相关信息,例如执行 heap 指令,将打印系统运行状态,更多指令可通过 help 查询。
      esp32> heap
      I (15360) esp_qcloud_mem: (714) <esp_qcloud_log: 159> ptr: 0x3ffbd1c4, size: 16
      I (15361) esp_qcloud_mem: (716) <esp_qcloud_log_flash: 157> ptr: 0x3ffbdecc, size: 24
      I (15372) esp_qcloud_mem: (1093) <esp_qcloud_device: 85> ptr: 0x3ffbe8e4, size: 20
      I (15383) esp_qcloud_mem: (1093) <esp_qcloud_device: 218> ptr: 0x3ffc0d3c, size: 20
      I (15384) esp_qcloud_mem: (1093) <esp_qcloud_device: 218> ptr: 0x3ffc0d68, size: 20
      I (15395) esp_qcloud_mem: (1094) <esp_qcloud_device: 218> ptr: 0x3ffc0d80, size: 20
      I (15406) esp_qcloud_mem: (1094) <esp_qcloud_device: 218> ptr: 0x3ffc0da8, size: 20
      I (15417) esp_qcloud_mem: (3608) <esp_qcloud_iothub: 213> ptr: 0x3ffca3d4, size: 128
      I (15418) esp_qcloud_mem: Memory record, num: 8, size: 268
      I (15429) esp_qcloud_mem: Free heap, current: 181096, minimum: 161540
      I (15441) esp_qcloud_mem: ---------------- The State Of Tasks ----------------
      I (15441) esp_qcloud_mem: - HWM   : usage high water mark (Byte)
      I (15452) esp_qcloud_mem: - Status: blocked ('B'), ready ('R'), deleted ('D') or suspended ('S')
      
      I (15463) esp_qcloud_mem: TaskName              Status  Prio    HWM     TaskNum CoreID  RunTimeCounter  Percentage
      I (15464) esp_qcloud_mem: console_handle        R       1       1952    8       -1      26908           <1
      I (15475) esp_qcloud_mem: IDLE0                 R       0       1008    4       0       13232798        89
      I (15486) esp_qcloud_mem: mqtt_task             B       5       3472    12      -1      978102          6
      I (15487) esp_qcloud_mem: Tmr Svc               B       1       792     5       0       1851            <1
      I (15498) esp_qcloud_mem: qcloud_log_send       B       4       2580    7       0       3451            <1
      I (15509) esp_qcloud_mem: tiT                   B       18      2112    9       -1      26425           <1
      I (15510) esp_qcloud_mem: esp_timer             B       22      3348    1       0       38541           <1
      I (15521) esp_qcloud_mem: wifi                  B       23      3944    11      0       234073          1
      I (15532) esp_qcloud_mem: sys_evt               B       20      596     10      0       2884            <1
  • 保存调试日志

    该功能可将日志保存在 Flash。你需要构造 esp_qcloud_log_config_t 结构体,通过 esp_qcloud_log_init() 设置日志等级。

    esp_qcloud_log_config_t log_config = {
    .log_level_flash = ESP_LOG_INFO,
    };

5. 相关资源

Apache License Version 2.0, January 2004 http://www.apache.org/licenses/ TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION 1. Definitions. "License" shall mean the terms and conditions for use, reproduction, and distribution as defined by Sections 1 through 9 of this document. "Licensor" shall mean the copyright owner or entity authorized by the copyright owner that is granting the License. "Legal Entity" shall mean the union of the acting entity and all other entities that control, are controlled by, or are under common control with that entity. For the purposes of this definition, "control" means (i) the power, direct or indirect, to cause the direction or management of such entity, whether by contract or otherwise, or (ii) ownership of fifty percent (50%) or more of the outstanding shares, or (iii) beneficial ownership of such entity. "You" (or "Your") shall mean an individual or Legal Entity exercising permissions granted by this License. "Source" form shall mean the preferred form for making modifications, including but not limited to software source code, documentation source, and configuration files. "Object" form shall mean any form resulting from mechanical transformation or translation of a Source form, including but not limited to compiled object code, generated documentation, and conversions to other media types. "Work" shall mean the work of authorship, whether in Source or Object form, made available under the License, as indicated by a copyright notice that is included in or attached to the work (an example is provided in the Appendix below). "Derivative Works" shall mean any work, whether in Source or Object form, that is based on (or derived from) the Work and for which the editorial revisions, annotations, elaborations, or other modifications represent, as a whole, an original work of authorship. For the purposes of this License, Derivative Works shall not include works that remain separable from, or merely link (or bind by name) to the interfaces of, the Work and Derivative Works thereof. "Contribution" shall mean any work of authorship, including the original version of the Work and any modifications or additions to that Work or Derivative Works thereof, that is intentionally submitted to Licensor for inclusion in the Work by the copyright owner or by an individual or Legal Entity authorized to submit on behalf of the copyright owner. For the purposes of this definition, "submitted" means any form of electronic, verbal, or written communication sent to the Licensor or its representatives, including but not limited to communication on electronic mailing lists, source code control systems, and issue tracking systems that are managed by, or on behalf of, the Licensor for the purpose of discussing and improving the Work, but excluding communication that is conspicuously marked or otherwise designated in writing by the copyright owner as "Not a Contribution." "Contributor" shall mean Licensor and any individual or Legal Entity on behalf of whom a Contribution has been received by Licensor and subsequently incorporated within the Work. 2. Grant of Copyright License. Subject to the terms and conditions of this License, each Contributor hereby grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable copyright license to reproduce, prepare Derivative Works of, publicly display, publicly perform, sublicense, and distribute the Work and such Derivative Works in Source or Object form. 3. Grant of Patent License. Subject to the terms and conditions of this License, each Contributor hereby grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable (except as stated in this section) patent license to make, have made, use, offer to sell, sell, import, and otherwise transfer the Work, where such license applies only to those patent claims licensable by such Contributor that are necessarily infringed by their Contribution(s) alone or by combination of their Contribution(s) with the Work to which such Contribution(s) was submitted. If You institute patent litigation against any entity (including a cross-claim or counterclaim in a lawsuit) alleging that the Work or a Contribution incorporated within the Work constitutes direct or contributory patent infringement, then any patent licenses granted to You under this License for that Work shall terminate as of the date such litigation is filed. 4. Redistribution. You may reproduce and distribute copies of the Work or Derivative Works thereof in any medium, with or without modifications, and in Source or Object form, provided that You meet the following conditions: (a) You must give any other recipients of the Work or Derivative Works a copy of this License; and (b) You must cause any modified files to carry prominent notices stating that You changed the files; and (c) You must retain, in the Source form of any Derivative Works that You distribute, all copyright, patent, trademark, and attribution notices from the Source form of the Work, excluding those notices that do not pertain to any part of the Derivative Works; and (d) If the Work includes a "NOTICE" text file as part of its distribution, then any Derivative Works that You distribute must include a readable copy of the attribution notices contained within such NOTICE file, excluding those notices that do not pertain to any part of the Derivative Works, in at least one of the following places: within a NOTICE text file distributed as part of the Derivative Works; within the Source form or documentation, if provided along with the Derivative Works; or, within a display generated by the Derivative Works, if and wherever such third-party notices normally appear. The contents of the NOTICE file are for informational purposes only and do not modify the License. You may add Your own attribution notices within Derivative Works that You distribute, alongside or as an addendum to the NOTICE text from the Work, provided that such additional attribution notices cannot be construed as modifying the License. You may add Your own copyright statement to Your modifications and may provide additional or different license terms and conditions for use, reproduction, or distribution of Your modifications, or for any such Derivative Works as a whole, provided Your use, reproduction, and distribution of the Work otherwise complies with the conditions stated in this License. 5. Submission of Contributions. Unless You explicitly state otherwise, any Contribution intentionally submitted for inclusion in the Work by You to the Licensor shall be under the terms and conditions of this License, without any additional terms or conditions. Notwithstanding the above, nothing herein shall supersede or modify the terms of any separate license agreement you may have executed with Licensor regarding such Contributions. 6. Trademarks. This License does not grant permission to use the trade names, trademarks, service marks, or product names of the Licensor, except as required for reasonable and customary use in describing the origin of the Work and reproducing the content of the NOTICE file. 7. Disclaimer of Warranty. Unless required by applicable law or agreed to in writing, Licensor provides the Work (and each Contributor provides its Contributions) on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied, including, without limitation, any warranties or conditions of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A PARTICULAR PURPOSE. You are solely responsible for determining the appropriateness of using or redistributing the Work and assume any risks associated with Your exercise of permissions under this License. 8. Limitation of Liability. In no event and under no legal theory, whether in tort (including negligence), contract, or otherwise, unless required by applicable law (such as deliberate and grossly negligent acts) or agreed to in writing, shall any Contributor be liable to You for damages, including any direct, indirect, special, incidental, or consequential damages of any character arising as a result of this License or out of the use or inability to use the Work (including but not limited to damages for loss of goodwill, work stoppage, computer failure or malfunction, or any and all other commercial damages or losses), even if such Contributor has been advised of the possibility of such damages. 9. Accepting Warranty or Additional Liability. While redistributing the Work or Derivative Works thereof, You may choose to offer, and charge a fee for, acceptance of support, warranty, indemnity, or other liability obligations and/or rights consistent with this License. However, in accepting such obligations, You may act only on Your own behalf and on Your sole responsibility, not on behalf of any other Contributor, and only if You agree to indemnify, defend, and hold each Contributor harmless for any liability incurred by, or claims asserted against, such Contributor by reason of your accepting any such warranty or additional liability. END OF TERMS AND CONDITIONS APPENDIX: How to apply the Apache License to your work. To apply the Apache License to your work, attach the following boilerplate notice, with the fields enclosed by brackets "[]" replaced with your own identifying information. (Don't include the brackets!) The text should be enclosed in the appropriate comment syntax for the file format. We also recommend that a file or class name and description of purpose be included on the same "printed page" as the copyright notice for easier identification within third-party archives. Copyright [yyyy] [name of copyright owner] 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.

简介

基于 ESP-IDF 原生开发接入腾讯 IoT Explorer,支持 ESP32/ESP32S2,快速实现腾讯连连控制。 展开 收起
C 等 4 种语言
Apache-2.0
取消

发行版

暂无发行版

贡献者

全部

近期动态

加载更多
不能加载更多了
1
https://gitee.com/EspressifSystems/esp-qcloud.git
git@gitee.com:EspressifSystems/esp-qcloud.git
EspressifSystems
esp-qcloud
esp-qcloud
master

搜索帮助