diff --git "a/docs/advanced_tutorial/zh/QuecPython\345\272\224\347\224\250\346\241\206\346\236\266/QuecPython\345\272\224\347\224\250\346\241\206\346\236\266.md" b/docs/advanced_tutorial/zh/HeliosSDK/README.md similarity index 100% rename from "docs/advanced_tutorial/zh/QuecPython\345\272\224\347\224\250\346\241\206\346\236\266/QuecPython\345\272\224\347\224\250\346\241\206\346\236\266.md" rename to docs/advanced_tutorial/zh/HeliosSDK/README.md diff --git "a/docs/advanced_tutorial/zh/\344\272\221\345\271\263\345\217\260\345\257\271\346\216\245/\344\272\221\345\271\263\345\217\260\345\257\271\346\216\245-AWS.md" "b/docs/advanced_tutorial/zh/QuecPython\345\272\224\347\224\250\346\241\206\346\236\266/README.md" similarity index 100% rename from "docs/advanced_tutorial/zh/\344\272\221\345\271\263\345\217\260\345\257\271\346\216\245/\344\272\221\345\271\263\345\217\260\345\257\271\346\216\245-AWS.md" rename to "docs/advanced_tutorial/zh/QuecPython\345\272\224\347\224\250\346\241\206\346\236\266/README.md" diff --git a/docs/advanced_tutorial/zh/README.md b/docs/advanced_tutorial/zh/README.md index e69de29bb2d1d6434b8b29ae775ad8c2e48c5391..a5d261f627a43980bca5f9c9d963844d63f257ec 100644 --- a/docs/advanced_tutorial/zh/README.md +++ b/docs/advanced_tutorial/zh/README.md @@ -0,0 +1,13 @@ +# 高级教程 + +高级教程主要介绍QuecPython开发中复杂度偏高的内容,期望可以通过这些文档让用户的项目开发更加简单方便。 + +# 高级教程文档目录 + +- [QuecPython应用框架](QuecPython应用框架/README.md) +- [蓝牙开发](蓝牙开发/README.md) +- [图形化界面开发](图形化界面开发/README.md) +- [云平台对接](云平台对接/README.md) +- [HeliosSDK](HeliosSDK/README.md) +- [定位应用开发](定位应用开发/README.md) +- [低功耗应用开发](低功耗应用开发/README.md) \ No newline at end of file diff --git a/docs/advanced_tutorial/zh/sidebar.yaml b/docs/advanced_tutorial/zh/sidebar.yaml index 6a330da5f19f6301a210c36bfed31c923789a592..261db4c25845f8c91c82664c15ea8c1e7f2a3ef8 100644 --- a/docs/advanced_tutorial/zh/sidebar.yaml +++ b/docs/advanced_tutorial/zh/sidebar.yaml @@ -1,83 +1,86 @@ items: -- label: teedoc 简介 - file: README.md -- label: 使用了 teedoc 的网站 - file: usage/sites.md -- label: 基本使用 -- label: 快速开始 - file: usage/quick_start.md -- label: 安装 teedoc - file: install/README.md -- label: 文档结构和配置 - file: usage/start.md -- label: 编写文档内容(语法) - collapsed: false +- label: QuecPython应用框架 + file: QuecPython应用框架/README.md + items: - - label: markdown 语法 - file: syntax/syntax_markdown.md - - label: Jupyter 语法 - file: syntax/syntax_jupyter.ipynb - - label: HTML 语法 - file: syntax/syntax_html.html -- label: 写文档时需注意 - file: usage/write_attention.md -- label: 博客 - file: usage/blog.md -- label: 部署 - file: usage/deploy.md - items: - - label: 部署到 github - file: usage/deploy_github_pages.md - - label: 使用 nginx 部署到服务器 - file: usage/deploy_nginx.md - - label: 部署到云服务商 - file: usage/deploy_cloud.md - - label: 使用 CDN 加速网站 - file: usage/deploy_cdn.md -- label: 常见问题 - file: usage/problems.md -- label: 进阶使用 -- label: 插件 - file: plugins/README.md - items: - - label: 主题插件 - file: plugins/themes.md - - label: 其它插件 - file: plugins/others.md -- label: SEO(为搜索引擎优化) - file: usage/seo.md -- label: 自定义页面模板 - file: usage/layout_template.md -- label: 国际化(i18n/翻译) - file: usage/i18n.md -- label: 自定义404页面 - file: usage/404.md -- label: 从 gitbook 转换为 teedoc - file: usage/gitbook2teedoc.md -- label: 查找大文件 - file: usage/list_files_by_size.md -- label: 找出两目录的不同文件 - file: usage/compare_dirs.md -- label: 更多 -- label: 更新历史 - file: more/history.md -- label: 更多样例(目录默认展开) - collapsed: false - items: - - label: 二级子目录 - items: - - label: 三级子目录样例 - items: - - label: 文章1 - file: more/example_docs/doc1.md - - label: 文章2 - file: more/example_docs/doc2.md - - label: 文章标题自动编号 - items: - - label: 页面有多个一级标题 - file: more/example_docs/multi_h1.md - - label: 标题不自动编号 - file: more/example_docs/heading_no_counter.md - - label: 这是一个外部链接 - url: https://github.com/teedoc/teedoc - target: _blank + + - label: QuecPython应用框架-EventMesh + file: QuecPython应用框架/QuecPython应用框架-EventMesh.md + - label: QuecPython应用框架-HeliosService + file: QuecPython应用框架/QuecPython应用框架-HeliosService.md + +- label: 蓝牙开发 + file: 蓝牙开发/README.md + + items: + + - label: 蓝牙开发-低功耗蓝牙开发 + file: 蓝牙开发/低功耗蓝牙开发.md + - label: 蓝牙开发-经典蓝牙开发 + file: 蓝牙开发/经典蓝牙开发.md + +- label: 图形化界面开发 + file: 图形化界面开发/README.md + + items: + + - label: 图形化界面开发-LVGL概述 + file: 图形化界面开发/LVGL概述.md + - label: 图形化界面开发-LVGL基础控件应用 + file: 图形化界面开发/LVGL基础控件应用.md + - label: 图形化界面开发-Demo-手表 + file: 图形化界面开发/Demo-手表.md + - label: 图形化界面开发-Demo-贪吃蛇 + file: 图形化界面开发/Demo-贪吃蛇.md + +- label: 云平台对接 + file: 云平台对接/README.md + + items: + + - label: 云平台对接-移远云 + file: 云平台对接/云平台对接-移远云.md + - label: 云平台对接-阿里云 + file: 云平台对接/云平台对接-阿里云.md + - label: 云平台对接-腾讯云 + file: 云平台对接/云平台对接-腾讯云.md + - label: 云平台对接-华为云 + file: 云平台对接/云平台对接-华为云.md + - label: 云平台对接-移动OneNET + file: 云平台对接/云平台对接-移动OneNET.md + - label: 云平台对接-电信CTWing + file: 云平台对接/云平台对接-电信CTWing.md + - label: 云平台对接-MQTT私有云 + file: 云平台对接/云平台对接-MQTT私有云.md + +- label: HeliosSDK + file: HeliosSDK/README.md + + items: + + - label: HeliosSDK + file: HeliosSDK/初级教程.md + - label: HeliosSDK + file: HeliosSDK/中级教程.md + - label: HeliosSDK + file: HeliosSDK/高级教程.md + +- label: 定位应用开发 + file: 定位应用开发/README.md + + items: + + - label: 基站定位-WiFi定位-GNSS定位 + file: 定位应用开发/基站定位-WiFi定位-GNSS定位.md + - label: RTK高精度厘米级定位 + file: 定位应用开发/RTK高精度厘米级定位.md + +- label: 低功耗应用开发 + file: 低功耗应用开发/README.md + + items: + + - label: 低功耗应用开发-休眠 + file: 低功耗应用开发/低功耗应用开发-休眠.md + - label: 低功耗应用开发-PSM + file: 低功耗应用开发/低功耗应用开发-PSM.md \ No newline at end of file diff --git "a/docs/advanced_tutorial/zh/\344\272\221\345\271\263\345\217\260\345\257\271\346\216\245/\344\272\221\345\271\263\345\217\260\345\257\271\346\216\245.md" "b/docs/advanced_tutorial/zh/\344\272\221\345\271\263\345\217\260\345\257\271\346\216\245/README.md" similarity index 100% rename from "docs/advanced_tutorial/zh/\344\272\221\345\271\263\345\217\260\345\257\271\346\216\245/\344\272\221\345\271\263\345\217\260\345\257\271\346\216\245.md" rename to "docs/advanced_tutorial/zh/\344\272\221\345\271\263\345\217\260\345\257\271\346\216\245/README.md" diff --git "a/docs/advanced_tutorial/zh/\345\233\276\345\275\242\345\214\226\347\225\214\351\235\242\345\274\200\345\217\221/\345\233\276\345\275\242\345\214\226\347\225\214\351\235\242\345\274\200\345\217\221-\345\237\272\347\241\200\346\216\247\344\273\266\345\272\224\347\224\250.md" "b/docs/advanced_tutorial/zh/\344\275\216\345\212\237\350\200\227\345\272\224\347\224\250\345\274\200\345\217\221/README.md" similarity index 100% rename from "docs/advanced_tutorial/zh/\345\233\276\345\275\242\345\214\226\347\225\214\351\235\242\345\274\200\345\217\221/\345\233\276\345\275\242\345\214\226\347\225\214\351\235\242\345\274\200\345\217\221-\345\237\272\347\241\200\346\216\247\344\273\266\345\272\224\347\224\250.md" rename to "docs/advanced_tutorial/zh/\344\275\216\345\212\237\350\200\227\345\272\224\347\224\250\345\274\200\345\217\221/README.md" diff --git "a/docs/advanced_tutorial/zh/\345\233\276\345\275\242\345\214\226\347\225\214\351\235\242\345\274\200\345\217\221/\345\233\276\345\275\242\345\214\226\347\225\214\351\235\242\345\274\200\345\217\221.md" "b/docs/advanced_tutorial/zh/\345\233\276\345\275\242\345\214\226\347\225\214\351\235\242\345\274\200\345\217\221/README.md" similarity index 100% rename from "docs/advanced_tutorial/zh/\345\233\276\345\275\242\345\214\226\347\225\214\351\235\242\345\274\200\345\217\221/\345\233\276\345\275\242\345\214\226\347\225\214\351\235\242\345\274\200\345\217\221.md" rename to "docs/advanced_tutorial/zh/\345\233\276\345\275\242\345\214\226\347\225\214\351\235\242\345\274\200\345\217\221/README.md" diff --git "a/docs/advanced_tutorial/zh/\350\223\235\347\211\231\345\274\200\345\217\221/\350\223\235\347\211\231\345\274\200\345\217\221.md" "b/docs/advanced_tutorial/zh/\345\233\276\345\275\242\345\214\226\347\225\214\351\235\242\345\274\200\345\217\221/\345\233\276\345\275\242\345\214\226\347\225\214\351\235\242\345\274\200\345\217\221-LVGL\345\237\272\347\241\200\346\216\247\344\273\266\345\272\224\347\224\250.md" similarity index 100% rename from "docs/advanced_tutorial/zh/\350\223\235\347\211\231\345\274\200\345\217\221/\350\223\235\347\211\231\345\274\200\345\217\221.md" rename to "docs/advanced_tutorial/zh/\345\233\276\345\275\242\345\214\226\347\225\214\351\235\242\345\274\200\345\217\221/\345\233\276\345\275\242\345\214\226\347\225\214\351\235\242\345\274\200\345\217\221-LVGL\345\237\272\347\241\200\346\216\247\344\273\266\345\272\224\347\224\250.md" diff --git "a/docs/advanced_tutorial/zh/\345\256\232\344\275\215\345\272\224\347\224\250\345\274\200\345\217\221/README.md" "b/docs/advanced_tutorial/zh/\345\256\232\344\275\215\345\272\224\347\224\250\345\274\200\345\217\221/README.md" new file mode 100644 index 0000000000000000000000000000000000000000..e69de29bb2d1d6434b8b29ae775ad8c2e48c5391 diff --git "a/docs/advanced_tutorial/zh/\350\223\235\347\211\231\345\274\200\345\217\221/README.md" "b/docs/advanced_tutorial/zh/\350\223\235\347\211\231\345\274\200\345\217\221/README.md" new file mode 100644 index 0000000000000000000000000000000000000000..e69de29bb2d1d6434b8b29ae775ad8c2e48c5391 diff --git "a/docs/development_guide/zh/BSP\345\272\224\347\224\250\345\274\200\345\217\221/BSP-ADC\345\272\224\347\224\250\345\274\200\345\217\221.md" "b/docs/development_guide/zh/BSP\345\272\224\347\224\250\345\274\200\345\217\221/BSP-ADC\345\272\224\347\224\250\345\274\200\345\217\221.md" new file mode 100644 index 0000000000000000000000000000000000000000..f6be4ff1d67141e189d09295a56fae4262fcef05 --- /dev/null +++ "b/docs/development_guide/zh/BSP\345\272\224\347\224\250\345\274\200\345\217\221/BSP-ADC\345\272\224\347\224\250\345\274\200\345\217\221.md" @@ -0,0 +1,38 @@ +# BSP-ADC应用开发 + +## 什么是ADC + +ADC(Analog to Digital Converter)即模拟数字转换器即[A/D转换器](https://baike.baidu.com/item/A%2FD转换器/4883848?fromModule=lemma_inlink),对于嵌入式应用开发来说,可以简单理解为:在单片机或我们的模组上有一个引脚可以读取电路中的电压值。一般软件开发人员主要关注如何读出ADC引脚的电压值,并将电压值做一些运算从而间接得出外部传感器当前所测量的环境值,如温度值、亮度值等。 + +## 怎么使用ADC + +### 硬件设计 + +对于嵌入式产品开发来说,可靠的硬件电路是软件开发的前提条件。 + +ADC相关电路设计需要参考每个型号模组的硬件设计手册和参考设计手册,可以在主页的[下载区](/download/)检索下载,但具体功能引脚仍需以QuecPython的[ADC功能API](/../../API_reference/zh/QuecPython类库/machine.ADC.html)介绍的引脚号为准。关于ADC功能常见的应用电路也可以通过搜素引擎了解更多信息。简单应用电路也可参考QuecPython的学习开发板,开发板可以通过天猫旗舰店、京东旗舰店等移远通信官方销售渠道获取,开发板的硬件设计同样是参考的上述硬件文档,开发板的原理图也可以在主页的[下载区](/download/)检索下载。 + +### 软件应用 + +使用QuecPython开发的模组,想要读取ADC引脚的电压需要先完成QuecPython开发环境的搭建,再参考[ADC功能的API介绍文档](/../../API_reference/zh/QuecPython类库/machine.ADC.html)进行如下命令行测试即可打印出ADC通道0引脚当前的电压值,单位为毫安(mA)。 + +```python +from misc import ADC +adc = ADC() +adc.open() +voltage = adc.read(ADC.ADC0) +print("ADC channel 0 voltage = {}mA".format(voltage)) +``` + +## ADC功能测试 + +使用QPYcom工具和模组进行交互,下面实例是基于ADC0。 + +![](../media/BSP应用开发/BSP_ADC_0.png) + +## ADC功能应用实例 + +[读取环境光照强度](../外设应用开发/外设-亮度传感器应用开发.html) + +[读取环境温度值](../外设应用开发/外设-温度传感器应用开发.html) + diff --git "a/docs/development_guide/zh/BSP\345\272\224\347\224\250\345\274\200\345\217\221/README.md" "b/docs/development_guide/zh/BSP\345\272\224\347\224\250\345\274\200\345\217\221/README.md" index e69de29bb2d1d6434b8b29ae775ad8c2e48c5391..128017ca9eab0d0d3c68d2166423030ad918c784 100644 --- "a/docs/development_guide/zh/BSP\345\272\224\347\224\250\345\274\200\345\217\221/README.md" +++ "b/docs/development_guide/zh/BSP\345\272\224\347\224\250\345\274\200\345\217\221/README.md" @@ -0,0 +1,17 @@ +# BSP应用开发 + +BSP应用开发主要介绍模组自带外设功能的基础知识及入门测试操作,例如GPIO、UART等。部分测试需要依赖外设设备,本部分内容主要介绍基本概念和理论,实际操作验证通过文章最后的链接跳转到外设应用文档部分。 + +# BSP应用开发文档目录 + +- [BSP-Audio应用开发](BSP-Audio应用开发.md) +- [BSP-GPIO应用开发](BSP-GPIO应用开发.md) +- [BSP-ExtInt引脚中断应用开发](BSP-ExtInt引脚中断应用开发.md) +- [BSP-UART应用开发](BSP-UART应用开发.md) +- [BSP-IIC(I2C)应用开发](BSP-IIC(I2C)应用开发.md) +- [BSP-SPI应用开发](BSP-SPI应用开发.md) +- [BSP-ADC应用开发](BSP-ADC应用开发.md) +- [BSP-PWM应用开发](BSP-PWM应用开发.md) +- [BSP-Timer应用开发](BSP-Timer应用开发.md) +- [BSP-RTC应用开发](BSP-RTC应用开发.md) +- [BSP-WDT看门狗应用开发](BSP-WDT看门狗应用开发.md) \ No newline at end of file diff --git "a/docs/development_guide/zh/QuecPython\345\277\253\351\200\237\345\205\245\351\227\250/QuecPython\345\205\245\351\227\250\345\255\246\344\271\240\350\267\257\347\272\277.md" "b/docs/development_guide/zh/QuecPython\345\277\253\351\200\237\345\205\245\351\227\250/QuecPython\345\205\245\351\227\250\345\255\246\344\271\240\350\267\257\347\272\277.md" new file mode 100644 index 0000000000000000000000000000000000000000..e69de29bb2d1d6434b8b29ae775ad8c2e48c5391 diff --git "a/docs/development_guide/zh/QuecPython\345\277\253\351\200\237\345\205\245\351\227\250/README.md" "b/docs/development_guide/zh/QuecPython\345\277\253\351\200\237\345\205\245\351\227\250/README.md" new file mode 100644 index 0000000000000000000000000000000000000000..264592ff2d6bc53c1ed7bf6566b206aad5bbb544 --- /dev/null +++ "b/docs/development_guide/zh/QuecPython\345\277\253\351\200\237\345\205\245\351\227\250/README.md" @@ -0,0 +1,9 @@ +# QuecPython快速入门 + +QuecPython快速入门是每一位开发者拿到每一块新的模组或者开发板都必须看的一篇文档,在这里你可以快速的学习到如何搭建好QuecPython的开发环境,测试刚到手的模组。 + +# QuecPython快速入门文档目录 + +- [QuecPython入门学习路线](QuecPython入门学习路线.html) +- [从Python到MicroPython](从Python到MicroPython.html) +- [从AT命令到QuecPython](从AT命令到QuecPython.html) \ No newline at end of file diff --git "a/docs/development_guide/zh/QuecPython\345\277\253\351\200\237\345\205\245\351\227\250/\344\273\216AT\345\221\275\344\273\244\345\210\260QuecPython.md" "b/docs/development_guide/zh/QuecPython\345\277\253\351\200\237\345\205\245\351\227\250/\344\273\216AT\345\221\275\344\273\244\345\210\260QuecPython.md" new file mode 100644 index 0000000000000000000000000000000000000000..e69de29bb2d1d6434b8b29ae775ad8c2e48c5391 diff --git "a/docs/development_guide/zh/QuecPython\345\277\253\351\200\237\345\205\245\351\227\250/\344\273\216Python\345\210\260MicroPython.md" "b/docs/development_guide/zh/QuecPython\345\277\253\351\200\237\345\205\245\351\227\250/\344\273\216Python\345\210\260MicroPython.md" new file mode 100644 index 0000000000000000000000000000000000000000..e69de29bb2d1d6434b8b29ae775ad8c2e48c5391 diff --git a/docs/development_guide/zh/README.md b/docs/development_guide/zh/README.md index e69de29bb2d1d6434b8b29ae775ad8c2e48c5391..558b86529c37057bc31140346083276d7ff68ab2 100644 --- a/docs/development_guide/zh/README.md +++ b/docs/development_guide/zh/README.md @@ -0,0 +1,14 @@ +# 开发指南 + +开发指南主要包括QuecPython的入门操作和一些功能使用案例、测试方法等。 + +# 开发指南文档目录 + +- [QuecPython快速入门](./QuecPython快速入门/README.md) +- [BSP应用开发](./BSP应用开发/README.md) +- [OTA升级](./OTA升级/README.md) +- [多线程应用开发](./多线程应用开发/README.md) +- [外设应用开发](./外设应用开发/README.md) +- [网络通信应用开发](./网络通信应用开发/README.md) +- ... + diff --git "a/docs/development_guide/zh/media/BSP\345\272\224\347\224\250\345\274\200\345\217\221/BSP_ADC_0.png" "b/docs/development_guide/zh/media/BSP\345\272\224\347\224\250\345\274\200\345\217\221/BSP_ADC_0.png" new file mode 100644 index 0000000000000000000000000000000000000000..eab7de3c56bdb2b09dc6f78604018e54902ac5cc Binary files /dev/null and "b/docs/development_guide/zh/media/BSP\345\272\224\347\224\250\345\274\200\345\217\221/BSP_ADC_0.png" differ diff --git a/docs/development_guide/zh/sidebar.yaml b/docs/development_guide/zh/sidebar.yaml index 6a330da5f19f6301a210c36bfed31c923789a592..4bf99ba4e36c44fb39a271cad5eb1c0e540b6c83 100644 --- a/docs/development_guide/zh/sidebar.yaml +++ b/docs/development_guide/zh/sidebar.yaml @@ -1,83 +1,87 @@ items: -- label: teedoc 简介 - file: README.md -- label: 使用了 teedoc 的网站 - file: usage/sites.md -- label: 基本使用 -- label: 快速开始 - file: usage/quick_start.md -- label: 安装 teedoc - file: install/README.md -- label: 文档结构和配置 - file: usage/start.md -- label: 编写文档内容(语法) - collapsed: false +- label: QuecPython快速入门 + file: QuecPython快速入门/README.md items: - - label: markdown 语法 - file: syntax/syntax_markdown.md - - label: Jupyter 语法 - file: syntax/syntax_jupyter.ipynb - - label: HTML 语法 - file: syntax/syntax_html.html -- label: 写文档时需注意 - file: usage/write_attention.md -- label: 博客 - file: usage/blog.md -- label: 部署 - file: usage/deploy.md + + - label: QuecPython入门学习路线 + file: QuecPython快速入门/QuecPython入门学习路线.md + - label: 从Python到MicroPython + file: QuecPython快速入门/从Python到MicroPython.md + - label: 从AT命令到QuecPython + file: QuecPython快速入门/从AT命令到QuecPython.md +- label: BSP应用开发 + file: BSP应用开发/README.md items: - - label: 部署到 github - file: usage/deploy_github_pages.md - - label: 使用 nginx 部署到服务器 - file: usage/deploy_nginx.md - - label: 部署到云服务商 - file: usage/deploy_cloud.md - - label: 使用 CDN 加速网站 - file: usage/deploy_cdn.md -- label: 常见问题 - file: usage/problems.md -- label: 进阶使用 -- label: 插件 - file: plugins/README.md + - label: BSP-Audio应用开发 + file: BSP应用开发/BSP-Audio应用开发.md + - label: BSP-GPIO应用开发 + file: BSP应用开发/BSP-GPIO应用开发.md + - label: BSP-ExtInt引脚中断应用开发 + file: BSP应用开发/BSP-ExtInt引脚中断应用开发.md + - label: BSP-UART应用开发 + file: BSP应用开发/BSP-UART应用开发.md + - label: BSP-IIC(I2C)应用开发 + file: BSP应用开发/BSP-IIC(I2C)应用开发.md + - label: BSP-SPI应用开发 + file: BSP应用开发/BSP-SPI应用开发.md + - label: BSP-ADC应用开发 + file: BSP应用开发/BSP-ADC应用开发.md + - label: BSP-PWM应用开发 + file: BSP应用开发/BSP-PWM应用开发.md + - label: BSP-Timer定时器应用开发 + file: BSP应用开发/BSP-Timer定时器应用开发.md + - label: BSP-RTC应用开发 + file: BSP应用开发/BSP-RTC应用开发.md + - label: BSP-WDT看门狗应用开发 + file: BSP应用开发/BSP-WDT看门狗应用开发.md +- label: OTA升级 + file: OTA升级/README.md items: - - label: 主题插件 - file: plugins/themes.md - - label: 其它插件 - file: plugins/others.md -- label: SEO(为搜索引擎优化) - file: usage/seo.md -- label: 自定义页面模板 - file: usage/layout_template.md -- label: 国际化(i18n/翻译) - file: usage/i18n.md -- label: 自定义404页面 - file: usage/404.md -- label: 从 gitbook 转换为 teedoc - file: usage/gitbook2teedoc.md -- label: 查找大文件 - file: usage/list_files_by_size.md -- label: 找出两目录的不同文件 - file: usage/compare_dirs.md -- label: 更多 -- label: 更新历史 - file: more/history.md -- label: 更多样例(目录默认展开) - collapsed: false + - label: OTA升级-固件 + file: OTA升级/OTA升级-固件.md + - label: OTA升级-文件 + file: OTA升级/OTA升级-文件.md +- label: 多线程应用开发 + file: 多线程应用开发/README.md items: - - label: 二级子目录 - items: - - label: 三级子目录样例 - items: - - label: 文章1 - file: more/example_docs/doc1.md - - label: 文章2 - file: more/example_docs/doc2.md - - label: 文章标题自动编号 - items: - - label: 页面有多个一级标题 - file: more/example_docs/multi_h1.md - - label: 标题不自动编号 - file: more/example_docs/heading_no_counter.md - - label: 这是一个外部链接 - url: https://github.com/teedoc/teedoc - target: _blank + - label: 多线程-创建线程 + file: 多线程应用开发/多线程-创建线程.md + - label: 多线程-互斥锁应用 + file: 多线程应用开发/多线程-互斥锁应用.md + - label: 多线程-消息队列应用 + file: 多线程应用开发/多线程-消息队列应用.md +- label: 外设应用开发 + file: 外设应用开发/README.md + items: + - label: 外设-摄像头应用开发 + file: 外设应用开发/外设-摄像头应用开发.md + - label: 外设-外扩存储应用开发 + file: 外设应用开发/外设-外扩存储应用开发.md + - label: 外设-矩阵键盘应用开发 + file: 外设应用开发/外设-矩阵键盘应用开发.md + - label: 外设-外挂以太网芯片应用开发 + file: 外设应用开发/外设-外挂以太网芯片应用开发.md + - label: 外设-外挂WiFi应用开发 + file: 外设应用开发/外设-外挂WiFi应用开发.md + - label: 外设-亮度传感器应用开发 + file: 外设应用开发/外设-亮度传感器应用开发.md + - label: 外设-温度传感器应用开发 + file: 外设应用开发/外设-温度传感器应用开发.md +- label: 网络通信应用开发 + file: 网络通信应用开发/README.md + items: + - label: 网络通信应用开发-数据拨号 + file: 网络通信应用开发/网络通信应用开发-数据拨号.md + - label: 网络通信应用开发-TCP与UDP通信 + file: 网络通信应用开发/网络通信应用开发-TCP与UDP通信.md + - label: 网络通信应用开发-HTTP通信 + file: 网络通信应用开发/网络通信应用开发-HTTP通信.md + - label: 网络通信应用开发-MQTT通信 + file: 网络通信应用开发/网络通信应用开发-MQTT通信.md + - label: 网络通信应用开发-SNMP通信 + file: 网络通信应用开发/网络通信应用开发-SNMP通信.md + - label: 网络通信应用开发-WebSocket通信 + file: 网络通信应用开发/网络通信应用开发-WebSocket通信.md + - label: 网络通信应用开发-通信异常处理 + file: 网络通信应用开发/网络通信应用开发-通信异常处理.md + diff --git "a/docs/development_guide/zh/\345\244\226\350\256\276\345\272\224\347\224\250\345\274\200\345\217\221/\345\244\226\350\256\276-\344\272\256\345\272\246\344\274\240\346\204\237\345\231\250\345\272\224\347\224\250\345\274\200\345\217\221.md" "b/docs/development_guide/zh/\345\244\226\350\256\276\345\272\224\347\224\250\345\274\200\345\217\221/\345\244\226\350\256\276-\344\272\256\345\272\246\344\274\240\346\204\237\345\231\250\345\272\224\347\224\250\345\274\200\345\217\221.md" new file mode 100644 index 0000000000000000000000000000000000000000..e69de29bb2d1d6434b8b29ae775ad8c2e48c5391 diff --git a/docs/development_tool_tutorial/zh/README.md b/docs/development_tool_tutorial/zh/README.md index e69de29bb2d1d6434b8b29ae775ad8c2e48c5391..df786694301ca43bb5b7e94df47aa7a356db4105 100644 --- a/docs/development_tool_tutorial/zh/README.md +++ b/docs/development_tool_tutorial/zh/README.md @@ -0,0 +1,11 @@ +# 开发工具使用教程 + +开发工具使用教程主要介绍QuecPython项目开发时需要从移远通信获取的各种工具。 + +# 开发工具使用教程文档目录 + +- [模组驱动下载安装教程](./模组驱动下载安装教程/README.md) +- [QPYcom使用教程](./QPYcom使用教程/README.md) +- [量产工具使用教程](./量产工具使用教程/README.md) +- [产测工具使用教程](./产测工具使用教程/README.md) +- [其他工具使用教程](./其他工具使用教程/README.md) \ No newline at end of file diff --git a/docs/development_tool_tutorial/zh/sidebar.yaml b/docs/development_tool_tutorial/zh/sidebar.yaml index 6a330da5f19f6301a210c36bfed31c923789a592..6da6caf6474590c906c17fdd55a01d14e1c40d9e 100644 --- a/docs/development_tool_tutorial/zh/sidebar.yaml +++ b/docs/development_tool_tutorial/zh/sidebar.yaml @@ -1,83 +1,68 @@ items: -- label: teedoc 简介 - file: README.md -- label: 使用了 teedoc 的网站 - file: usage/sites.md -- label: 基本使用 -- label: 快速开始 - file: usage/quick_start.md -- label: 安装 teedoc - file: install/README.md -- label: 文档结构和配置 - file: usage/start.md -- label: 编写文档内容(语法) - collapsed: false +- label: 模组驱动下载安装教程 + file: 模组驱动下载安装教程/README.md + + items: + + - label: LTE系列模组 + file: LTE系列模组/README.md + items: - - label: markdown 语法 - file: syntax/syntax_markdown.md - - label: Jupyter 语法 - file: syntax/syntax_jupyter.ipynb - - label: HTML 语法 - file: syntax/syntax_html.html -- label: 写文档时需注意 - file: usage/write_attention.md -- label: 博客 - file: usage/blog.md -- label: 部署 - file: usage/deploy.md + + - label: ASR系列模组 + file: ASR系列模组/README.md + - abel: Unisoc系列模组 + file: Unisoc系列模组/README.md + - abel: Qualcomm系列模组 + file: Qualcomm系列模组/README.md + - abel: Eigecomm系列模组 + file: Eigecomm系列模组/README.md + + - label: LPWA系列模组 + file: LPWA系列模组/README.md + items: - - label: 部署到 github - file: usage/deploy_github_pages.md - - label: 使用 nginx 部署到服务器 - file: usage/deploy_nginx.md - - label: 部署到云服务商 - file: usage/deploy_cloud.md - - label: 使用 CDN 加速网站 - file: usage/deploy_cdn.md -- label: 常见问题 - file: usage/problems.md -- label: 进阶使用 -- label: 插件 - file: plugins/README.md - items: - - label: 主题插件 - file: plugins/themes.md - - label: 其它插件 - file: plugins/others.md -- label: SEO(为搜索引擎优化) - file: usage/seo.md -- label: 自定义页面模板 - file: usage/layout_template.md -- label: 国际化(i18n/翻译) - file: usage/i18n.md -- label: 自定义404页面 - file: usage/404.md -- label: 从 gitbook 转换为 teedoc - file: usage/gitbook2teedoc.md -- label: 查找大文件 - file: usage/list_files_by_size.md -- label: 找出两目录的不同文件 - file: usage/compare_dirs.md -- label: 更多 -- label: 更新历史 - file: more/history.md -- label: 更多样例(目录默认展开) - collapsed: false - items: - - label: 二级子目录 - items: - - label: 三级子目录样例 - items: - - label: 文章1 - file: more/example_docs/doc1.md - - label: 文章2 - file: more/example_docs/doc2.md - - label: 文章标题自动编号 - items: - - label: 页面有多个一级标题 - file: more/example_docs/multi_h1.md - - label: 标题不自动编号 - file: more/example_docs/heading_no_counter.md - - label: 这是一个外部链接 - url: https://github.com/teedoc/teedoc - target: _blank + + - label: NB-IOT系列模组 + file: NB-IOT系列模组/README.md + - label: CAT-M系列模组 + file: CAT-M系列模组/README.md + + - label: WiFi系列模组 + file: WiFi系列模组/README.md + +- label: QPYcom使用教程 + file: QPYcom使用教程/README.md + + items: + + - label: QPYcom使用教程-REPL交互 + file: QPYcom使用教程-REPL交互.md + - label: QPYcom使用教程-文件传输 + file: QPYcom使用教程-文件传输.md + - label: QPYcom使用教程-固件合成与烧录 + file: QPYcom使用教程-固件合成与烧录.md + +- label: 量产工具使用教程 + file: 量产工具使用教程/README.md + + items: + + - label: QMulti_DL使用教程 + file: 量产工具使用教程/QMulti_DL使用教程.md + - label: Quectel_Customer_FW_Download_Tool使用教程 + file: 量产工具使用教程/Quectel_Customer_FW_Download_Tool使用教程.md + +- label: 产测工具使用教程 + file: 产测工具使用教程/README.md + +- label: 其他工具使用教程 + file: 其他工具使用教程/README.md + + items: + + - label: QCOM使用教程 + file: 其他工具使用教程/QCOM使用教程.md + - label: Qflash使用教程 + file: 其他工具使用教程/Qflash使用教程.md + diff --git "a/docs/development_tool_tutorial/zh/\345\205\266\344\273\226\345\267\245\345\205\267\344\275\277\347\224\250\346\225\231\347\250\213/QCOM\344\275\277\347\224\250\346\225\231\347\250\213.md" "b/docs/development_tool_tutorial/zh/\345\205\266\344\273\226\345\267\245\345\205\267\344\275\277\347\224\250\346\225\231\347\250\213/QCOM\344\275\277\347\224\250\346\225\231\347\250\213.md" new file mode 100644 index 0000000000000000000000000000000000000000..e69de29bb2d1d6434b8b29ae775ad8c2e48c5391 diff --git "a/docs/development_tool_tutorial/zh/\345\205\266\344\273\226\345\267\245\345\205\267\344\275\277\347\224\250\346\225\231\347\250\213/Qflash\344\275\277\347\224\250\346\225\231\347\250\213.md" "b/docs/development_tool_tutorial/zh/\345\205\266\344\273\226\345\267\245\345\205\267\344\275\277\347\224\250\346\225\231\347\250\213/Qflash\344\275\277\347\224\250\346\225\231\347\250\213.md" new file mode 100644 index 0000000000000000000000000000000000000000..e69de29bb2d1d6434b8b29ae775ad8c2e48c5391 diff --git "a/docs/development_tool_tutorial/zh/\345\205\266\344\273\226\345\267\245\345\205\267\344\275\277\347\224\250\346\225\231\347\250\213/README.md" "b/docs/development_tool_tutorial/zh/\345\205\266\344\273\226\345\267\245\345\205\267\344\275\277\347\224\250\346\225\231\347\250\213/README.md" new file mode 100644 index 0000000000000000000000000000000000000000..e69de29bb2d1d6434b8b29ae775ad8c2e48c5391 diff --git "a/docs/development_tool_tutorial/zh/\346\250\241\347\273\204\351\251\261\345\212\250\344\270\213\350\275\275\345\256\211\350\243\205\346\225\231\347\250\213/LPWA\347\263\273\345\210\227\346\250\241\347\273\204/CAT-M\347\263\273\345\210\227\346\250\241\347\273\204/README.md" "b/docs/development_tool_tutorial/zh/\346\250\241\347\273\204\351\251\261\345\212\250\344\270\213\350\275\275\345\256\211\350\243\205\346\225\231\347\250\213/LPWA\347\263\273\345\210\227\346\250\241\347\273\204/CAT-M\347\263\273\345\210\227\346\250\241\347\273\204/README.md" new file mode 100644 index 0000000000000000000000000000000000000000..e69de29bb2d1d6434b8b29ae775ad8c2e48c5391 diff --git "a/docs/development_tool_tutorial/zh/\346\250\241\347\273\204\351\251\261\345\212\250\344\270\213\350\275\275\345\256\211\350\243\205\346\225\231\347\250\213/LPWA\347\263\273\345\210\227\346\250\241\347\273\204/NB-IOT\347\263\273\345\210\227\346\250\241\347\273\204/README.md" "b/docs/development_tool_tutorial/zh/\346\250\241\347\273\204\351\251\261\345\212\250\344\270\213\350\275\275\345\256\211\350\243\205\346\225\231\347\250\213/LPWA\347\263\273\345\210\227\346\250\241\347\273\204/NB-IOT\347\263\273\345\210\227\346\250\241\347\273\204/README.md" new file mode 100644 index 0000000000000000000000000000000000000000..e69de29bb2d1d6434b8b29ae775ad8c2e48c5391 diff --git "a/docs/development_tool_tutorial/zh/\346\250\241\347\273\204\351\251\261\345\212\250\344\270\213\350\275\275\345\256\211\350\243\205\346\225\231\347\250\213/LPWA\347\263\273\345\210\227\346\250\241\347\273\204/README.md" "b/docs/development_tool_tutorial/zh/\346\250\241\347\273\204\351\251\261\345\212\250\344\270\213\350\275\275\345\256\211\350\243\205\346\225\231\347\250\213/LPWA\347\263\273\345\210\227\346\250\241\347\273\204/README.md" new file mode 100644 index 0000000000000000000000000000000000000000..e69de29bb2d1d6434b8b29ae775ad8c2e48c5391 diff --git "a/docs/development_tool_tutorial/zh/\346\250\241\347\273\204\351\251\261\345\212\250\344\270\213\350\275\275\345\256\211\350\243\205\346\225\231\347\250\213/LTE\347\263\273\345\210\227\346\250\241\347\273\204/ASR\347\263\273\345\210\227\346\250\241\347\273\204/README.md" "b/docs/development_tool_tutorial/zh/\346\250\241\347\273\204\351\251\261\345\212\250\344\270\213\350\275\275\345\256\211\350\243\205\346\225\231\347\250\213/LTE\347\263\273\345\210\227\346\250\241\347\273\204/ASR\347\263\273\345\210\227\346\250\241\347\273\204/README.md" new file mode 100644 index 0000000000000000000000000000000000000000..e69de29bb2d1d6434b8b29ae775ad8c2e48c5391 diff --git "a/docs/development_tool_tutorial/zh/\346\250\241\347\273\204\351\251\261\345\212\250\344\270\213\350\275\275\345\256\211\350\243\205\346\225\231\347\250\213/LTE\347\263\273\345\210\227\346\250\241\347\273\204/Eigecomm\347\263\273\345\210\227\346\250\241\347\273\204/README.md" "b/docs/development_tool_tutorial/zh/\346\250\241\347\273\204\351\251\261\345\212\250\344\270\213\350\275\275\345\256\211\350\243\205\346\225\231\347\250\213/LTE\347\263\273\345\210\227\346\250\241\347\273\204/Eigecomm\347\263\273\345\210\227\346\250\241\347\273\204/README.md" new file mode 100644 index 0000000000000000000000000000000000000000..e69de29bb2d1d6434b8b29ae775ad8c2e48c5391 diff --git "a/docs/development_tool_tutorial/zh/\346\250\241\347\273\204\351\251\261\345\212\250\344\270\213\350\275\275\345\256\211\350\243\205\346\225\231\347\250\213/LTE\347\263\273\345\210\227\346\250\241\347\273\204/Qualcomm\347\263\273\345\210\227\346\250\241\347\273\204/README.md" "b/docs/development_tool_tutorial/zh/\346\250\241\347\273\204\351\251\261\345\212\250\344\270\213\350\275\275\345\256\211\350\243\205\346\225\231\347\250\213/LTE\347\263\273\345\210\227\346\250\241\347\273\204/Qualcomm\347\263\273\345\210\227\346\250\241\347\273\204/README.md" new file mode 100644 index 0000000000000000000000000000000000000000..e69de29bb2d1d6434b8b29ae775ad8c2e48c5391 diff --git "a/docs/development_tool_tutorial/zh/\346\250\241\347\273\204\351\251\261\345\212\250\344\270\213\350\275\275\345\256\211\350\243\205\346\225\231\347\250\213/LTE\347\263\273\345\210\227\346\250\241\347\273\204/README.md" "b/docs/development_tool_tutorial/zh/\346\250\241\347\273\204\351\251\261\345\212\250\344\270\213\350\275\275\345\256\211\350\243\205\346\225\231\347\250\213/LTE\347\263\273\345\210\227\346\250\241\347\273\204/README.md" new file mode 100644 index 0000000000000000000000000000000000000000..e69de29bb2d1d6434b8b29ae775ad8c2e48c5391 diff --git "a/docs/development_tool_tutorial/zh/\346\250\241\347\273\204\351\251\261\345\212\250\344\270\213\350\275\275\345\256\211\350\243\205\346\225\231\347\250\213/LTE\347\263\273\345\210\227\346\250\241\347\273\204/Unisoc\347\263\273\345\210\227\346\250\241\347\273\204/README.md" "b/docs/development_tool_tutorial/zh/\346\250\241\347\273\204\351\251\261\345\212\250\344\270\213\350\275\275\345\256\211\350\243\205\346\225\231\347\250\213/LTE\347\263\273\345\210\227\346\250\241\347\273\204/Unisoc\347\263\273\345\210\227\346\250\241\347\273\204/README.md" new file mode 100644 index 0000000000000000000000000000000000000000..e69de29bb2d1d6434b8b29ae775ad8c2e48c5391 diff --git "a/docs/development_tool_tutorial/zh/\346\250\241\347\273\204\351\251\261\345\212\250\344\270\213\350\275\275\345\256\211\350\243\205\346\225\231\347\250\213/README.md" "b/docs/development_tool_tutorial/zh/\346\250\241\347\273\204\351\251\261\345\212\250\344\270\213\350\275\275\345\256\211\350\243\205\346\225\231\347\250\213/README.md" new file mode 100644 index 0000000000000000000000000000000000000000..e69de29bb2d1d6434b8b29ae775ad8c2e48c5391 diff --git "a/docs/development_tool_tutorial/zh/\346\250\241\347\273\204\351\251\261\345\212\250\344\270\213\350\275\275\345\256\211\350\243\205\346\225\231\347\250\213/WiFi\347\263\273\345\210\227\346\250\241\347\273\204/README.md" "b/docs/development_tool_tutorial/zh/\346\250\241\347\273\204\351\251\261\345\212\250\344\270\213\350\275\275\345\256\211\350\243\205\346\225\231\347\250\213/WiFi\347\263\273\345\210\227\346\250\241\347\273\204/README.md" new file mode 100644 index 0000000000000000000000000000000000000000..e69de29bb2d1d6434b8b29ae775ad8c2e48c5391 diff --git "a/docs/development_tool_tutorial/zh/\351\207\217\344\272\247\345\267\245\345\205\267\344\275\277\347\224\250\346\225\231\347\250\213/QMulti_DL\344\275\277\347\224\250\346\225\231\347\250\213.md" "b/docs/development_tool_tutorial/zh/\351\207\217\344\272\247\345\267\245\345\205\267\344\275\277\347\224\250\346\225\231\347\250\213/QMulti_DL\344\275\277\347\224\250\346\225\231\347\250\213.md" new file mode 100644 index 0000000000000000000000000000000000000000..e69de29bb2d1d6434b8b29ae775ad8c2e48c5391 diff --git "a/docs/development_tool_tutorial/zh/\351\207\217\344\272\247\345\267\245\345\205\267\344\275\277\347\224\250\346\225\231\347\250\213/Quectel_Customer_FW_Download_Tool\344\275\277\347\224\250\346\225\231\347\250\213.md" "b/docs/development_tool_tutorial/zh/\351\207\217\344\272\247\345\267\245\345\205\267\344\275\277\347\224\250\346\225\231\347\250\213/Quectel_Customer_FW_Download_Tool\344\275\277\347\224\250\346\225\231\347\250\213.md" new file mode 100644 index 0000000000000000000000000000000000000000..e69de29bb2d1d6434b8b29ae775ad8c2e48c5391 diff --git "a/docs/development_tool_tutorial/zh/\351\207\217\344\272\247\345\267\245\345\205\267\344\275\277\347\224\250\346\225\231\347\250\213/README.md" "b/docs/development_tool_tutorial/zh/\351\207\217\344\272\247\345\267\245\345\205\267\344\275\277\347\224\250\346\225\231\347\250\213/README.md" new file mode 100644 index 0000000000000000000000000000000000000000..e69de29bb2d1d6434b8b29ae775ad8c2e48c5391