Merge branch 'master' of https://gitee.com/SummerPackages/micropython

docs/01-Getting_Started_Guide.md

@@ -1,11 +1,11 @@
 # RT-Thread MicroPython 快速上手
 
-## 1. 开始使用 MicroPython
+## 开始使用 MicroPython
 
 !!! note "注意"
      RT-Thread MicroPython 需要运行在 **RT-Thread 3.0** 版本以上。
 
-### 1.1 选择合适的 BSP 平台
+### 选择合适的 BSP 平台
 
 RT-Thread MicroPython mini 版本占用资源最大不超过：
 
@@ -14,7 +14,7 @@ RT-Thread MicroPython mini 版本占用资源最大不超过：
 
 常见的许多开发板都可以运行 MicroPython，如 `stm32f10x` 、`stm32f40x` 、`stm32f429-apollo`、`imxrt1052-evk`  、`iot-camera` 等。 
 
-### 1.2 MicroPython 软件包的安装
+### MicroPython 软件包的安装
 
 - MicroPython 软件包可以通过 env 工具在线下载获得。在下载 MicroPython 软件包前，建议使用 `pkgs --upgrade` 命令更新软件包列表，并且在配置版本时勾选 `latest` 版本，如图：
 
@@ -22,11 +22,11 @@ RT-Thread MicroPython mini 版本占用资源最大不超过：
 
 - 使用 env 下载 MicroPython 软件包的方法请参考: [`RT-Thread env 工具使用手册`](https://www.rt-thread.org/document/site/rtthread-development-guide/rtthread-tool-manual/env/env-user-manual/)
 
-### 1.3 选择开发环境
+### 选择开发环境
 
 - 目前 MicroPython 支持三种开发环境，分别为 `MDK / IAR / GCC`，选择合适的开发环境，使用 env 工具将 MicroPython 软件包开启后，需重新生成工程，再进行编译、下载。
 
-### 1.4 运行 MicroPython
+### 运行 MicroPython
 
 - 在 Finsh/MSH 命令行内输入 `python` 即可进入 MicroPython 的交互命令行 REPL(Read-Evaluate-Print-Loop)，可在终端看到如下界面：
 
@@ -34,16 +34,16 @@ RT-Thread MicroPython mini 版本占用资源最大不超过：
 
 使用 `Ctrl-D` 或输入 `quit()` 以及 `exit()`  即可退出 REPL ，回到 RT-Thread Finsh/MSH。
 
-## 2. MicroPython 基本功能 
-### 2.1 Python 语法与内建函数 
+## MicroPython 基本功能 
+### Python 语法与内建函数 
 
-#### 2.1.1 使用 python 交互命令行 
+#### 使用 python 交互命令行 
 
 - MicroPython 是 Python 3 编程语言的一种精简而高效的实现，语法和 Python 3 相同，并带有丰富的内建函数，使用 MicroPython 交互命令行即可运行 Python 代码：
 
 ![elect_micropytho](./figures/python_hello.png)
 
-#### 2.1.2 交互命令行的粘贴模式
+#### 交互命令行的粘贴模式
 
 - `MicroPython`  比一般的 python 交互环境多了一个特别的**粘贴模式**，可以一次粘贴输入多行 python 代码。
 - 在命令行提示符状态下，按下 `Ctrl-E` 组合键，就会出现提示：`paste mode; Ctrl-C to cancel, Ctrl-D to finish` 。粘贴需要运行的代码后，按下 `Ctlr-D` 即可退出粘贴模式，同时输入的代码也会自动执行。
@@ -60,7 +60,7 @@ for i in range(1,10):
 
 ![elect_micropytho](./figures/python_grammer_function.png)
 
-### 2.2 MicroPython 内建模块
+### MicroPython 内建模块
 
 - MicroPython 提供丰富的内建模块用来完成相关的程序功能。同时 RT-Thread  也提供了 `rtthread` 模块用来返回系统运行相关的信息。
 - 以 `rtthread` 和 `time` 模块为例，调用方式如下：
@@ -70,13 +70,13 @@ for i in range(1,10):
 !!! tip "提示"
      默认下载的 MicroPython  软件包为 mini 版本，为 RT-Thread 推出的最小版本的 MicroPython ，如果想使用更多的 MicroPython 模块，可以在 menuconfig 配置项中打开更多的模块选项。
 
-## 3. MicroPython 例程
+## MicroPython 例程
 
 通过 MicroPython 可以用非常简单的方式来控制开发板的硬件资源，下面用两个例子来说明：
 
 以下例程运行在 `i.MX RT1050 开发板 `上，运行之前需要开启 RT-Thread  `Pin 设备`功能。
 
-### 3.1 闪烁灯
+### 闪烁灯
 
 - i.MX RT1050 开发板中: [第 52 号 pin](https://github.com/RT-Thread/rt-thread/blob/8ed3470d2a485c49ec4f5d4a5ec53e94edf7a2c8/bsp/imxrt1052-evk/drivers/drv_pin.c#L105) 为 LED D18，与 phy 复位引脚共用
 
@@ -94,7 +94,7 @@ while True:
 
 针对自己的开发板修改引脚号，将以上脚本使用 3.1.2 章节介绍的**粘贴模式**输入，即可看到 LED 灯按照指定的频率闪烁。使用 `Ctrl-C` 可以取消当前正在运行程序。
 
-### 3.2 按键灯
+### 按键灯
 
 - i.MX RT1050 开发板中: [第 125 号 pin](https://github.com/RT-Thread/rt-thread/blob/8ed3470d2a485c49ec4f5d4a5ec53e94edf7a2c8/bsp/imxrt1052-evk/drivers/drv_pin.c#L184) 为 SW8
 

docs/02-Basic_Knowledge.md

@@ -1,6 +1,6 @@
 # RT-Thread MicroPython 基础知识
 
-## 1. 运行 python 文件
+## 运行 python 文件
 
 在 MicroPython 上运行 Python文件有以下要求：
 
@@ -9,7 +9,7 @@
 
 符合以上两点，就可以使用 `msh` 命令行中的 `python` 命令加上 `*.py` 文件名来执行一个 Python文件了。
 
-## 2. 术语表
+## 术语表
 
 ### board
 

docs/03-MicroPython_libraries.md

@@ -5,7 +5,7 @@
 
     - 这些模块可以通过 env 工具的 menuconfig 功能来开启和关闭，如果你需要使用特定的模块，在 menuconfig 中选中模块名，保存退出后，重新编译运行即可。
 
-## 1. Python 标准库和微型库
+## Python 标准库和微型库
 
 Python 的标准库被 “微型化”后，就是 MicroPython 标准库，也称 MicroPython 模块。它们仅仅提供了该模块的核心功能，用来替代 Python 标准库 。一些模块使用 Python  标准库的名字，但是加上了前缀 "u"，例如``ujson``代替``json``。也就是说 MicroPython 的标准库(微型库)，只实现了一部分模块功能。通过给这些库以不同的方式命名，用户可以写一个 Python 级的模块来扩展微型库的功能，以便于兼容 CPython 的标准库（这项工作就是 [micropython-lib](https://github.com/micropython/micropython-lib) 项目的正在做的）。
 
@@ -13,9 +13,9 @@ Python 的标准库被 “微型化”后，就是 MicroPython 标准库，也
 
 例如，当``import json``时，首先会在库路径文件夹中搜索一个 ``json.py`` 文件或 ``json`` 目录进行加载。如果没有找到，它才会去加载内置 ``ujson`` 模块。
 
-## 2. RT-Thread MicroPython 模块
+## RT-Thread MicroPython 模块
 
-### 2.1 系统模块
+### 系统模块
 - [rtthread][1] – RT-Thread 系统相关函数
 - [utime][2]  – 时间相关函数
 - [sys][3]  – 系统特有功能函数
@@ -26,21 +26,21 @@ Python 的标准库被 “微型化”后，就是 MicroPython 标准库，也
 - [array][8]  – 数字数据数组
 - [gc][9]  – 控制垃圾回收
 
-### 2.2 硬件模块
+### 硬件模块
 - [machine][10] – 与硬件相关的功能
 - [machine.Pin][11]
 - [machine.I2C][12]
 - [machine.SPI][13]
 - [machine.UART][14]
 
-### 2.3 系统模块
+### 系统模块
 - [uos][15] – 基本的 “操作系统” 服务
 - [select][16] – 等待流事件
 - [uctypes][17] – 以结构化的方式访问二进制数据
 - [uerrno][18] – 系统错误码模块
 - [_thread][19] – 多线程支持
 
-### 2.4 工具模块
+### 工具模块
 - [cmath][20] – 复数的数学函数
 - [ubinascii][21] – 二进制/ ASCII转换
 - [uhashlib][22] – 哈希算法
@@ -50,7 +50,7 @@ Python 的标准库被 “微型化”后，就是 MicroPython 标准库，也
 - [uzlib][26] – zlib 解压缩
 - [urandom][27] – 随机数生成模块
 
-### 2.5 网络模块
+### 网络模块
 - [usocket][28] – 套接字模块
 
 [1]: 03-Basic_Module/01-rtthread.md

docs/README.md

@@ -5,7 +5,7 @@
 !!! abstract "摘要"
      本手册介绍了 RT-Thread MicroPython 的基础知识、常用模块，以及开发新模块的流程。带领读者了解 MicroPython ，并学会使用 MicroPython 进行开发。
      
-## 1.1 主要特性
+## 主要特性
 
 - MicroPython 是 Python 3 编程语言的一种精简而高效的实现，它包含 Python 标准库的一个子集，并被优化为在微控制器和受限环境中运行。
 
@@ -17,35 +17,35 @@
 
 - MicroPython 的目标是尽可能与普通 Python 兼容，使开发者能够轻松地将代码从桌面端转移到微控制器或嵌入式系统。程序可移植性很强，因为不需要考虑底层驱动，所以程序移植变得轻松和容易。
 
-## 1.2 MicroPython 的优势
+## MicroPython 的优势
 
 - Python 是一款容易上手的脚本语言，同时具有强大的功能，语法优雅简单。使用 MicroPython 编程可以降低嵌入式的开发门槛，让更多的人体验嵌入式的乐趣。
 - 通过 MicroPython 实现硬件底层的访问和控制，不需要了解底层寄存器、数据手册、厂家的库函数等，即可轻松控制硬件。
 - 外设与常用功能都有相应的模块，降低开发难度，使开发和移植变得容易和快速。
 
-## 1.3 MicroPython 的应用领域
+## MicroPython 的应用领域
 
 - MicroPython 在嵌入式系统上完整实现了 Python3 的核心功能，可以在产品开发的各个阶段给开发者带来便利。
 - 通过 MicroPython 提供的库和函数，开发者可以快速控制 LED、液晶、舵机、多种传感器、SD、UART、I2C 等，实现各种功能，而不用再去研究底层硬件模块的使用方法，翻看寄存器手册。这样不但降低了开发难度，而且减少了重复开发工作，可以加快开发速度，提高开发效率。以前需要较高水平的嵌入式工程师花费数天甚至数周才能完成的功能，现在普通的嵌入式开发者用几个小时就能实现类似的功能。
 - 随着半导体技术的不断发展，芯片的功能、内部的存储器容量和资源不断增加，成本不断降低，可以使用 MicroPython 来进行开发设计的应用领域也会越来越多。
 
-### 1.3.1 产品原型验证
+### 产品原型验证
 
 - 众所周知，在开发新产品时，原型设计是一个非常重要的环节，这个环节需要以最快速的方式设计出产品的大致模型，并验证业务流程或者技术点。与传统开发方法相比，使用 MicroPython 对于原型验证非常有用，让原型验证过程变得轻松，加速原型验证过程。
 - 在进行一些物联网功能开发时，网络功能也是 MicroPython 的长处，可以利用现成的众多 MicroPython 网络模块，节省开发时间。而这些功能如果使用 C/C++ 来完成，会耗费几倍的时间。
 
-### 1.3.2 硬件测试
+### 硬件测试
 
 - 嵌入式产品在开发时，一般会分为硬件开发及软件开发。硬件工程师并不一定都擅长软件开发，所以在测试新硬件时，经常需要软件工程师参与。这就导致软件工程师可能会耗费很多时间帮助硬件工程师查找设计或者焊接问题。有了 MicroPython 后，将 MicroPython 固件烧入待测试的新硬件，在检查焊接、连线等问题时，只需使用简单的 Python 命令即可测试。这样，硬件工程师一人即可搞定，再也不用麻烦别人了。
 
-### 1.3.3 教育
+### 教育
 
 - MicroPython 使用简单、方便，非常适合于编程入门。在校学生或者业余爱好者都可以通过 MicroPython 快速的开发一些好玩的项目，在开发的过程中学习编程思想，提高自己的动手能力。
 - 下面是一些 MicroPython 教育项目：
     - [从TurnipBit开始完成编程启蒙](https://www.cnblogs.com/xxosu/p/7206414.html)
     - [MicroBit 创意编程](http://microbit.org/)
 
-### 1.3.4 创客 DIY
+### 创客 DIY
 
 - MicroPython 无需复杂的设置，不需要安装特别的软件环境和额外的硬件，使用任何文本编辑器就可以进行编程。大部分硬件功能，使用一个命令就能驱动，不用了解硬件底层就能快速开发。这些特性使得 MicroPython 非常适合创客使用来开发一些有创意的项目。
 - 下面是使用 MicroPython 制作的一些 DIY 项目：
@@ -54,7 +54,7 @@
     - [手机遥控车](https://www.bilibili.com/video/av15008143?from=search&seid=16285206333541196172)
     - [搭建 MQTT 服务器](http://www.360doc.com/content/17/1218/22/8473307_714341237.shtml)
 
-# 2. MicroPython 开发资源
+# MicroPython 开发资源
 
 - [RT-Thread MicroPython 开发手册](https://www.rt-thread.org/document/site/rtthread-development-guide/micropython/docs/README/)