Преглед изворни кода

[add] new docs for micropython package

SummerGift пре 6 година
родитељ
комит
46656ab8c7
49 измењених фајлова са 2964 додато и 0 уклоњено
  1. BIN
      docs/figures/IoT_Board.png
  2. BIN
      docs/figures/add_main_stack.png
  3. BIN
      docs/figures/check_memory.png
  4. BIN
      docs/figures/config_runtime.png
  5. BIN
      docs/figures/mount_fs.png
  6. BIN
      docs/figures/select_mpy_package.png
  7. 97 0
      docs/firmware-develop.md
  8. 49 0
      docs/introduction.md
  9. 47 0
      docs/micropython-librarys.md
  10. 60 0
      docs/spec-librarys/machine.md
  11. 44 0
      docs/spec-librarys/machine/ADC.md
  12. 111 0
      docs/spec-librarys/machine/I2C.md
  13. 76 0
      docs/spec-librarys/machine/LCD.md
  14. 57 0
      docs/spec-librarys/machine/PWM.md
  15. 110 0
      docs/spec-librarys/machine/Pin.md
  16. 56 0
      docs/spec-librarys/machine/RTC.md
  17. 99 0
      docs/spec-librarys/machine/SPI.md
  18. 73 0
      docs/spec-librarys/machine/Timer.md
  19. 60 0
      docs/spec-librarys/machine/UART.md
  20. 42 0
      docs/spec-librarys/machine/WDT.md
  21. 72 0
      docs/spec-librarys/micropython.md
  22. 10 0
      docs/spec-librarys/network.md
  23. 109 0
      docs/spec-librarys/network/wlan.md
  24. 34 0
      docs/spec-librarys/rtthread.md
  25. 28 0
      docs/std-librarys/_thread.md
  26. 104 0
      docs/std-librarys/builtins.md
  27. 42 0
      docs/std-librarys/cmath.md
  28. 22 0
      docs/std-librarys/gc.md
  29. 283 0
      docs/std-librarys/math.md
  30. 34 0
      docs/std-librarys/rtthread.md
  31. 69 0
      docs/std-librarys/sys.md
  32. 56 0
      docs/std-librarys/uarray.md
  33. 47 0
      docs/std-librarys/ubinascii.md
  34. 44 0
      docs/std-librarys/ucollections.md
  35. 82 0
      docs/std-librarys/uctypes.md
  36. 20 0
      docs/std-librarys/uerrno.md
  37. 36 0
      docs/std-librarys/uhashlib.md
  38. 16 0
      docs/std-librarys/uheapq.md
  39. 27 0
      docs/std-librarys/uio.md
  40. 42 0
      docs/std-librarys/ujson.md
  41. 56 0
      docs/std-librarys/uos.md
  42. 174 0
      docs/std-librarys/urandom.md
  43. 52 0
      docs/std-librarys/ure.md
  44. 102 0
      docs/std-librarys/uselect.md
  45. 195 0
      docs/std-librarys/usocket.md
  46. 28 0
      docs/std-librarys/ussl.md
  47. 82 0
      docs/std-librarys/ustruct.md
  48. 107 0
      docs/std-librarys/utime.md
  49. 10 0
      docs/std-librarys/uzlib.md

BIN
docs/figures/IoT_Board.png


BIN
docs/figures/add_main_stack.png


BIN
docs/figures/check_memory.png


BIN
docs/figures/config_runtime.png


BIN
docs/figures/mount_fs.png


BIN
docs/figures/select_mpy_package.png


+ 97 - 0
docs/firmware-develop.md

@@ -0,0 +1,97 @@
+## MicroPython 固件开发指南
+
+如果手上没有官方支持固件的开发板,就需要自己来动手制作 MicroPython 固件了。由于 RT-Thread 官方提供了 MicroPython 软件包,并且 MicroPython 底层和硬件绑定时对接了 RT-Thread 驱动框架,所以我们可以很方便地在运行了 RT-Thread 的板卡上将  MicroPython 跑起来。
+
+接下来我们以 `rt-thread\bsp\stm32\stm32f407-atk-explorer` 上的 MDK 工程为例,讲解如何在 BSP 的基础上制作 MicroPython 固件。
+
+### 获取 MicroPython 软件包
+
+先使用 `pkgs --upgrade` 命令更新软件包列表,然后通过 env 工具选中 MicroPython 软件包,最后使用 `pkgs -update` 命令将软件包拉取到本地。
+
+![select_mpy_package](figures/select_mpy_package.png)
+
+### 增大 main 线程栈
+
+为了能后续在 main 线程中启动 MicroPython 运行时环境,需要增大 main 线程的栈大小,这里我们将栈大小增加到 8k。
+
+![add_main_stack](figures/add_main_stack.png)
+
+### 配置 MicroPython 运行环境堆大小
+
+接下来根据板卡内存实际剩余情况来给 MicroPython 运行环境分配内存,这里填写的数值越大,就能运行更大代码量的 Python 程序。但是如果这里填写的数值超过了实际可分配内存,就可能会出现无法分配内存而报错。因此在配置此项目之前,需要对系统 RAM 资源的分配情况有一定了解。
+
+#### 查看系统剩余内存
+
+重新生成工程,编译下载后通过 `msh` 的 `free` 命令来查看内存使用情况。
+
+![check_memory](figures/check_memory.png)
+
+#### 配置系统
+
+通过上一步查询的内存分配情况,对系统 RAM 资源有了一定的了解。在本次示例中,我们分配 20k 内存用于 MicroPython 运行时环境。后续如果想要运行更多 MicroPython 代码,可以将更多空余内存分配给 MicroPython 运行时环境,配置如下图所示:
+
+![config_runtime](figures/config_runtime.png)
+
+### 在根目录挂载文件系统
+
+最后要确保系统中 `/` 目录挂载了文件系统。有了文件系统,后续才能使用 [**MicroPython 开发环境**](https://marketplace.visualstudio.com/items?itemName=RT-Thread.rt-thread-micropython) 将 Python 代码文件同步到板卡中来运行,本次示例中将使用 elm-fat 文件系统,需要对系统进行如下配置:
+
+![mount_fs](figures/mount_fs.png)
+
+配置完成后,记得要使用 `scons --target=mkd5` 重新生成工程,使配置在工程中生效。
+
+### 在 main 线程中启动 MicroPython 
+
+最后要在 main 线程中启动 MicroPython,需要完成的功能如下:
+
+1. 挂载文件系统到 `/` 目录
+2. 启动 MicroPython
+
+上述功能可以通过修改 main 函数来实现,修改 main 代码如下所示:
+
+```c
+#include <rtthread.h>
+#include <rtdevice.h>
+#include <board.h>
+#include <dfs_fs.h>
+#include <rtdevice.h>
+
+#define FS_PARTITION_NAME     "W25Q128"
+
+/* defined the LED0 pin: PF9 */
+#define LED0_PIN    GET_PIN(F, 9)
+
+int main(void)
+{
+    /* 挂载 elm 文件系统到 / 目录 */
+    if (dfs_mount(FS_PARTITION_NAME, "/", "elm", 0, 0) == 0) 
+    {
+        rt_kprintf("Filesystem initialized!");
+    }
+    else
+    {
+        rt_kprintf("Filesystem initialization failed!");
+    }
+
+    rt_thread_mdelay(100);
+
+    /* 运行 MicroPython 启动函数 */
+    extern void mpy_main(const char *filename);
+    mpy_main(NULL);
+
+    rt_kprintf("You can enter repl mode by typing python commands.");
+
+    /* 如果想要在 REPL 环境按下 CTRL+D 重启系统可以加上下面这一句 */
+    /* rt_hw_cpu_reset(); */    
+}
+```
+
+重新编译工程下载到板卡中,就会在 main 线程中自动进入 MicroPython 的交互环境 REPL。此时如果先前没有在存储器上创建相应的文件系统,可能会导致文件系统挂载失败。此时可以使用如下两种方法在存储设备上创建文件系统:
+
+- 按下 `CTRL + D` 进入 msh 使用 `mkfs -t elm W25Q128` 命令创建文件系统
+- 在 REPL 交互环境中输入 `import os`,`os.mkfs("elm", "W25Q128")` 命令来创建文件系统
+
+注意: **W25Q128** 是本次示例中将要创建文件系统的块设备名称,并不是固定填写该名称。因此在使用上述命令创建文件系统前,需要确定当前系统中块设备的实际名称。
+
+成功创建文件系统后,就可以使用 [ **MicroPython 开发环境**](https://marketplace.visualstudio.com/items?itemName=RT-Thread.rt-thread-micropython) 来进行应用开发了。
+

+ 49 - 0
docs/introduction.md

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

+ 47 - 0
docs/micropython-librarys.md

@@ -0,0 +1,47 @@
+# MicroPython 库
+
+### MicroPython 标准库
+
+- [`Builtin functions and exceptions`](std-librarys/builtins.md) – 内置函数与异常
+- [`cmath`](std-librarys/cmath.md)  – 复数运算函数功能
+- [`gc`](std-librarys/gc.md) – 控制垃圾收集器
+- [`math`](std-librarys/math.md) – 数学函数功能
+- [`sys`](std-librarys/sys.md) – 系统特定功能
+- [`uarray`](std-librarys/uarray.md) – 数组存储功能
+- [`ubinascii`](std-librarys/ubinascii.md) – 二进制与 ASCII 码转换功能
+- [`ucollections`](std-librarys/ucollections.md) – 集合与容器类型
+- [`uerrno`](std-librarys/uerrno.md) – 系统错误码
+- [`uhashlib`](std-librarys/uhashlib.md) – 哈希算法
+- [`uheapq`](std-librarys/uheapq.md) – 堆队列算法
+- [`uio`](std-librarys/uio.md) – 输入输出流
+- [`ujson`](std-librarys/ujson.md) – JSON 编解码
+- [`uos`](std-librarys/uos.md) – 基本的操作系统服务
+- [`ure`](std-librarys/ure.md) – 正则表达式
+- [`uselect`](std-librarys/uselect.md) – 在一组 streams 上等待事件
+- [`usocket`](std-librarys/usocket.md) – socket 模块
+- [`ussl`](std-librarys/ussl.md) – SSL/TLS 模块
+- [`ustruct`](std-librarys/ustruct.md) – 原生数据类型的打包和解包
+- [`utime`](std-librarys/utime.md) – 时间相关功能
+- [`uzlib`](std-librarys/uzlib.md) – zlib 解压
+- [`_thread`](std-librarys/_thread.md) – 多线程支持
+
+### RT-Thread MicroPython 特定库
+
+在 RT-Thread 移植的 MicroPython 版本中,实现了如下特定功能库:
+
+- [`micropython`](spec-librarys/micropython.md) – 实现 MicroPython 内部功能访问与控制
+- [`rtthread`](spec-librarys/rtthread.md) – RT-Thread 系统功能模块
+- [`machine`](spec-librarys/machine.md) – 硬件控制模块
+    - [Pin](spec-librarys/machine/Pin.md) 
+    - [I2C ](spec-librarys/machine/I2C.md)
+    - [SPI](spec-librarys/machine/SPI.md)
+    - [UART](spec-librarys/machine/UART.md)
+    - [LCD](spec-librarys/machine/LCD.md)
+    - [RTC](spec-librarys/machine/RTC.md)
+    - [PWM](spec-librarys/machine/PWM.md)
+    - [ADC](spec-librarys/machine/Pin.md)
+    - [WDT](spec-librarys/machine/WDT.md)
+    - [TIMER](spec-librarys/machine/Timer.md)
+
+- [`network`](spec-librarys/network.md) – 网络功能配置模块
+    - [wlan](spec-librarys/network/wlan.md) 

+ 60 - 0
docs/spec-librarys/machine.md

@@ -0,0 +1,60 @@
+## **machine** – 与硬件相关的功能
+
+**machine** 模块包含与特定开发板上的硬件相关的特定函数。 在这个模块中的大多数功能允许实现直接和不受限制地访问和控制系统上的硬件块(如CPU,定时器,总线等)。如果使用不当,会导致故障,死机,崩溃,在极端的情况下,硬件会损坏。
+
+需要注意的是,由于不同开发板的硬件资源不同,MicroPython 移植所能控制的硬件也是不一样的。因此对于控制硬件的例程来说,在使用前需要修改相关的配置参数来适配不同的开发板,或者直接运行已经对某一开发板适配好的 MicroPython 示例程序。本文档中的例程都是基于 RT-Thread IoT Board 潘多拉开发板而讲解的。
+
+### 函数
+
+#### 复位相关函数
+
+##### **machine.info**()  
+  显示关于系统介绍和内存占用等信息。
+
+##### **machine.rest**()  
+  重启设备,类似于按下复位按钮。
+
+##### **machine.reset_cause**()  
+  获得复位的原因,查看可能的返回值的常量。
+
+#### 中断相关函数
+
+##### **machine.disable_irq**()  
+  禁用中断请求。返回先前的 `IRQ` 状态,该状态应该被认为是一个未知的值。这个返回值应该在 `disable_irq` 函数被调用之前被传给 `enable_irq` 函数来重置中断到初始状态。
+
+##### **machine.enable_irq**(state)  
+  重新使能中断请求。状态参数应该是从最近一次禁用功能的调用中返回的值。
+
+#### 功耗相关函数
+
+##### **machine.freq**()  
+  返回 `CPU` 的运行频率。
+
+##### **machine.idle**()  
+  阻断给 `CPU` 的时钟信号,在较短或者较长的周期里减少功耗。当中断发生时,外设将继续工作。
+
+##### **machine.sleep**()  
+  停止 `CPU` 并禁止除了 `WLAN` 之外的所有外设。系统会从睡眠请求的地方重新恢复工作。为了确保唤醒一定会发生,应当首先配置中断源。
+
+##### **machine.deepsleep**()  
+  停止 `CPU` 和所有外设(包括网络接口)。执行从主函数中恢复,就像被复位一样。复位的原因可以检查 `machine.DEEPSLEEP` 参数获得。为了确保唤醒一定会发生,应该首先配置中断源,比如一个引脚的变换或者 `RTC` 的超时。
+
+### 常数
+
+- `IRQ` 唤醒值
+#### **machine.IDLE**
+#### **machine.SLEEP**
+#### **machine.DEEPSLEEP**
+
+- 复位
+#### **machine.PWRON_RESET **
+#### **machine.HARD_RESET **
+#### **machine.WDT_RESET **
+#### **machine.DEEPSLEEP_RESET **
+#### **machine.SOFT_RESET**
+
+- 唤醒
+#### **machine.WLAN_WAKE**
+#### **machine.PIN_WAKE**
+#### **machine.RTC_WAKE**
+

+ 44 - 0
docs/spec-librarys/machine/ADC.md

@@ -0,0 +1,44 @@
+## machine.ADC
+
+**machine.ADC** 类是 machine 模块下的一个硬件类,用于指定 ADC 设备的配置和控制,提供对 ADC 设备的操作方法。
+
+- ADC(Analog-to-Digital Converter,模数转换器),用于将连续变化的模拟信号转化为离散的数字信号。
+- ADC 设备两个重要参数:采样值、分辨率;
+  - 采样值:当前时间由模拟信号转化的数值信号的数值;
+  - 分辨率:以二进制(或十进制)数的位数来表示,一般有 8 位、10 位、12 位、16 位等,它说明模数转换器对输入信号的分辨能力,位数越多,表示分辨率越高,采样值会更精确。 
+
+### 构造函数
+
+在 RT-Thread MicroPython 中 `ADC` 对象的构造函数如下:
+
+#### **class machine.ADC**(id, channel)
+
+- **id**:使用的 ADC 设备编号,`id = 1` 表示编号为 1 的 ADC 设备,或者表示使用的 ADC 设备名,如 `id = "adc"` 表示设备名为 `adc` 的 ADC 设备;
+- **channel**:使用的 ADC 设备通道号,每个 ADC 设备对应多个通道;
+
+例如:`ADC(1,4)` 表示当前使用编号为 1 的 ADC 设备的 4 通道。
+
+### 方法
+
+#### **ADC.init**(channel)
+
+根据输入的层参数初始化 ADC 对象,入参为使用的 ADC 对象通道号;
+
+#### **ADC.deinit**()
+
+用于关闭 ADC 对象,ADC 对象 deinit 之后需要重新 init 才能使用。
+
+#### **ADC.read**()
+
+用于获取并返回当前 ADC 对象的采样值。例如当前采样值为 2048,对应设备的分辨率为 12位,当前设备参考电压为 3.3V ,则该 ADC 对象通道上实际电压值的计算公式为:**采样值 * 参考电压  /  (1 <<  分辨率位数)**,即 `vol = 2048 / 4096 * 3.3 V = 1.15V`。
+
+### 示例
+
+``` python
+>>> from machine import ADC      # 从 machine 导入 ADC 类
+>>> adc = ADC(1, 13)             # 创建 ADC 对象,当前使用编号为 1 的 ADC 设备的 13 通道
+>>> adc.read()                   # 获取 ADC 对象采样值
+4095
+>>> adc.deinit()                 # 关闭 ADC 对象
+>>> adc.init(13)                 # 开启并重新配置 ADC 对象
+```

+ 111 - 0
docs/spec-librarys/machine/I2C.md

@@ -0,0 +1,111 @@
+## machine.I2C
+
+**machine.I2C** 类是 `machine` 模块下面的一个硬件类,用于对 `I2C` 的配置和控制,提供对 `I2C` 设备的操作方法。
+
+- `I2C` 是一种用于设备间通信的两线协议。在物理层上,它由两根线组成:`SCL`  和 `SDA` ,即时钟和数据线。
+- `I2C` 对象被创建到一个特定的总线上,它们可以在创建时被初始化,也可以之后再来初始化。
+- 打印 `I2C` 对象会打印出配置时的信息。
+
+### 构造函数
+
+在 RT-Thread MicroPython 中 `I2C` 对象的构造函数如下:
+
+#### **class machine.I2C**(id= -1,  scl, sda, freq=400000)
+使用下面的参数构造并返回一个新的 `I2C` 对象:
+
+- **id** :标识特定的 `I2C`  外设。如果填入 id = -1,即选择软件模拟的方式实现 `I2C`,这时可以使用任意引脚来模拟 `I2C` 总线 ,这样在初始化时就必须指定 `scl` 和 `sda` 。  
+软件 I2C 的初始化方式可参考 [软件 I2C 示例](#i2c_2)。  
+硬件 I2C 的初始化方式可参考 [硬件 I2C 示例](#i2c_3)。
+
+- **scl** : 应该是一个 `Pin` 对象,指定为一个用于 `scl` 的 `Pin` 对象。
+- **sda** : 应该是一个 `Pin` 对象,指定为一个用于 `sda` 的 `Pin` 对象。
+- **freq** :应该是为 `scl` 设置的最大频率。
+
+### 方法
+
+#### **I2C.init**(scl, sda, freq=400000)
+初始化 `I2C` 总线,参数介绍可以参考构造函数中的参数。
+
+#### **I2C.deinit**()
+关闭 `I2C` 总线。
+
+#### **I2C.scan**()
+扫描所有 0x08 和 0x77 之间的 `I2C` 地址,然后返回一个有响应地址的列表。如果一个设备在总线上收到了他的地址,就会通过拉低 `SDA` 的方式来响应。
+
+### I2C 基础方法
+下面的方法实现了基本的 `I2C` 总线操作,可以组合成任何的 `I2C` 通信操作,如果需要对总线进行更多的控制,可以可以使用他们,否则可以使用后面介绍的标准使用方法。
+
+#### **I2C.start**()
+在总线上产生一个启动信号。(`SCL` 为高时,`SDA` 转换为低)
+
+#### **I2C.stop**()
+在总线上产生一个停止信号。(`SCL` 为高时,`SDA` 转换为高)
+
+#### **I2C.readinto**(buf, nack=True)
+从总线上读取字节并将他们存储到 `buf` 中,读取的字节数时 `buf` 的长度。在收到最后一个字节以外的所有内容后,将在总线上发送 `ACK`。在收到最后一个字节之后,如果 `NACK` 是正确的,那么就会发送一个 `NACK`,否则将会发送 `ACK`。
+
+####  **I2C.write**(buf)
+将 `buf` 中的数据接入到总线,检查每个字节之后是否收到 `ACK`,并在收到 `NACK` 时停止传输剩余的字节。这个函数返回接收到的 `ACK` 的数量。
+
+### I2C 标准总线操作
+下面的方法实现了标准 `I2C` 主设备对一个给定从设备的读写操作。
+
+#### **I2C.readfrom**(addr, nbytes, stop=True)
+从 `addr` 指定的从设备中读取 n 个字节,如果 `stop = True`,那么在传输结束时会产生一个停止信号。函数会返回一个存储着读到数据的字节对象。
+
+#### **I2C.readfrom_into**(addr, buf, stop=True)
+从 `addr` 指定的从设备中读取数据存储到 `buf` 中,读取的字节数将是 `buf` 的长度,如果 `stop = True`,那么在传输结束时会产生一个停止信号。  
+这个方法没有返回值。
+
+#### **I2C.writeto**(addr, buf, stop=True)
+将 `buf` 中的数据写入到 `addr` 指定的的从设备中,如果在写的过程中收到了 `NACK` 信号,那么就不会发送剩余的字节。如果 `stop = True`,那么在传输结束时会产生一个停止信号,即使收到一个 `NACK`。这个函数返回接收到的 `ACK` 的数量。
+
+### 内存操作
+
+一些 `I2C` 设备充当一个内存设备,可以读取和写入。在这种情况下,有两个与 `I2C` 相关的地址,从机地址和内存地址。下面的方法是与这些设备进行通信的便利函数。
+
+#### **I2C.readfrom_mem**(addr, memaddr, nbytes, \*, addrsize=8)
+从 `addr` 指定的从设备中 `memaddr` 地址开始读取 n 个字节。`addrsize` 参数指定地址的长度。返回一个存储读取数据的字节对象。
+
+#### **I2C.readfrom_mem_into**(addr, memaddr, buf, \*, addrsize=8)
+从 `addr` 指定的从设备中 `memaddr` 地址读取数据到 `buf` 中,,读取的字节数是 `buf` 的长度。  
+这个方法没有返回值。
+
+#### **I2C.writeto_mem**(addr, memaddr, buf, \*, addrsize=8)
+将 `buf` 里的数据写入 `addr` 指定的从机的 `memaddr` 地址中。 
+这个方法没有返回值。
+
+### 示例
+
+#### 软件模拟 I2C
+```python
+>>> from machine import Pin, I2C
+>>> clk = Pin(("clk", 29), Pin.OUT_OD)   # Select the 29 pin device as the clock
+>>> sda = Pin(("sda", 30), Pin.OUT_OD)   # Select the 30 pin device as the data line
+>>> i2c = I2C(-1, clk, sda, freq=100000) # create I2C peripheral at frequency of 100kHz
+>>> i2c.scan()                        # scan for slaves, returning a list of 7-bit addresses
+[81]                                  # Decimal representation
+>>> i2c.writeto(0x51, b'123')         # write 3 bytes to slave with 7-bit address 42
+3
+>>> i2c.readfrom(0x51, 4)             # read 4 bytes from slave with 7-bit address 42
+b'\xf8\xc0\xc0\xc0'
+>>> i2c.readfrom_mem(0x51, 0x02, 1)   # read 1 bytes from memory of slave 0x51(7-bit),
+b'\x12'                               # starting at memory-address 8 in the slave
+>>> i2c.writeto_mem(0x51, 2, b'\x10') # write 1 byte to memory of slave 42,
+                                      # starting at address 2 in the slave
+```
+
+#### 硬件 I2C
+
+需要先开启 `I2C` 设备驱动,查找设备可以在 `msh` 中输入`list_device` 命令。  
+在构造函数的第一个参数传入 `0`,系统就会搜索名为 `i2c0` 的设备,找到之后使用这个设备来构建 `I2C` 对象:
+
+```python
+>>> from machine import Pin, I2C
+>>> i2c = I2C(0)                      # create I2C peripheral at frequency of 100kHz
+>>> i2c.scan()                        # scan for slaves, returning a list of 7-bit addresses
+[81]                                  # Decimal representation
+```
+
+  更多内容可参考 [machine.I2C](http://docs.micropython.org/en/latest/pyboard/library/machine.I2C.html) 。
+

+ 76 - 0
docs/spec-librarys/machine/LCD.md

@@ -0,0 +1,76 @@
+## machine.LCD
+
+**machine.LCD** 类是 machine 模块下面的一个硬件类,用于对 LCD 的配置和控制,提供对 LCD 设备的操作方法。
+
+IoT board 板载一块 1.3 寸,分辨率为 `240*240` 的 LCD 显示屏,因此对该屏幕操作时,(x, y)  坐标的范围是 `0 - 239`。
+
+### 构造函数
+
+在 RT-Thread MicroPython 中 `LCD` 对象的构造函数如下:
+
+#### **class machine.LCD**()
+在给定总线上构造一个 `LCD` 对象,无入参,初始化的对象取决于特定硬件,初始化方式可参考 [示例](#_3)。
+
+### 方法
+
+#### **LCD.light**(value)
+
+控制是否开启 LCD 背光,入参为 True 则打开 LCD 背光,入参为 False 则关闭 LCD 背光。
+
+#### **LCD.fill**(color)
+
+根据给定的颜色填充整个屏幕,支持多种颜色,可以传入的参数有:
+
+```
+WHITE BLACK BLUE BRED GRED GBLUE RED MAGENTA GREEN CYAN YELLOW BROWN BRRED GRAY GRAY175 GRAY151 GRAY240
+```
+
+详细的使用方法可参考[示例](#_3)。
+
+#### **LCD.pixel**(x, y, color)
+
+向指定的位置(x, y)画点,点的颜色为 color 指定的颜色,可指定的颜色和上一个功能相同。
+
+注意:(x, y)  坐标的范围是 0 - 239,使用下面的方法对坐标进行操作时同样需要遵循此限制。
+
+#### **LCD.text**(str, x, y, size)
+
+在指定的位置(x,y)写入字符串,字符串由 str 指定,字体的大小由 size 指定,size 的大小可为 16,24,32。
+
+#### **LCD.line**(x1, y1, x2, y2)
+
+在 LCD 上画一条直线,起始地址为 (x1, y1),终点为(x2, y2)。
+
+#### **LCD.rectangle**(x1, y1, x2, y2)
+
+在 LCD 上画一个矩形,左上角的位置为(x1, y1),右下角的位置为(x2, y2)。
+
+#### **LCD.circle**(x1, y1, r)
+
+在 LCD 上画一个圆形,圆心的位置为(x1, y1),半径长度为 r。
+
+#### **LCD.show_bmp**( x,  y, pathname)
+
+在 LCD 指定位置上显示 32-bit bmp 格式的图片信息,注意显示 bmp 图片时,(x, y) 坐标是图片的左下角。
+
+### 示例
+
+```python
+from machine import LCD     # 从 machine 导入 LCD 类
+lcd = LCD()                 # 创建一个 lcd 对象
+lcd.light(False)            # 关闭背光
+lcd.light(True)             # 打开背光
+lcd.fill(lcd.BLACK)         # 将整个 LCD 填充为黑色
+lcd.fill(lcd.RED)           # 将整个 LCD 填充为红色
+lcd.fill(lcd.GRAY)          # 将整个 LCD 填充为灰色
+lcd.fill(lcd.WHITE)         # 将整个 LCD 填充为白色
+lcd.pixel(50, 50, lcd.BLUE) # 将(50,50)位置的像素填充为蓝色
+lcd.text("hello RT-Thread", 0, 0, 16)   # 在(0, 0) 位置以 16 字号打印字符串
+lcd.text("hello RT-Thread", 0, 16, 24)  # 在(0, 16)位置以 24 字号打印字符串
+lcd.text("hello RT-Thread", 0, 48, 32)  # 在(0, 48)位置以 32 字号打印字符串
+lcd.line(0, 50, 239, 50)    # 以起点(0,50),终点(239,50)画一条线
+lcd.line(0, 50, 239, 50)    # 以起点(0,50),终点(239,50)画一条线
+lcd.rectangle(100, 100, 200, 200) # 以左上角为(100,100),右下角(200,200)画矩形
+lcd.circle(150, 150, 80)    # 以圆心位置(150,150),半径为 80 画圆
+lcd.show_bmp(180, 50, "sun.bmp")  # 以位置(180,50)为图片左下角坐标显示文件系统中的 bmp 图片 "sun.bmp"
+```

+ 57 - 0
docs/spec-librarys/machine/PWM.md

@@ -0,0 +1,57 @@
+## machine.PWM
+
+**machine.PWM** 类是 machine 模块下的一个硬件类,用于指定 PWM 设备的配置和控制,提供对 PWM 设备的操作方法。
+
+- PWM (Pulse Width Modulation,脉冲宽度调制)  是一种对模拟信号电平进行数字编码的方式;
+- PWM 设备可以通过调节有效电平在一个周期信号中的比例时间来操作设备;
+- PWM 设备两个重要的参数:频率(freq)和占空比(duty);
+  - 频率:从一个上升沿(下降沿)到下一个上升沿(下降沿)的时间周期,单位为 Hz;
+  - 占空比:有效电平(通常为电平)在一个周期内的时间比例;
+
+### 构造函数
+
+在 RT-Thread MicroPython 中 `PWM` 对象的构造函数如下:
+
+#### **class machine.PWM**(id, channel, freq, duty)
+
+在给定的总线上构建一个 `PWM` 对象,参数介绍如下:
+
+- **id**:使用的 PWM 设备编号,如  `id = 1` 表示编号为 1 的 PWM 设备,或者表示使用的 PWM 设备名,如 `id = "pwm"` 表示设备名为 `pwm` 的 PWM 设备;
+- **channel**:使用的 PWM 设备通道号,每个 PWM 设备包含多个通道,范围为 [0, 4];
+- **freq**:初始化频率,范围 [1, 156250];
+- **duty**:初始化占空比数值,范围 [0 255];
+
+例如:`PWM(1,4,100,100)` 表示当前使用 编号为 1 的 PWM 设备的 4 通道,初始化频率为 1000 Hz,初始化占空比的数值为 100。
+
+### 方法
+
+#### **PWM.init**(channel, freq, duty)
+
+根据输入的参数初始化 PWM 对象,参数说明同上。
+
+#### **PWM.deinit**()
+
+用于关闭 PWM 对象,对象 deinit 之后需要重新 init 才能使用。
+
+#### **PWM.freq**(freq)
+
+用于获取或者设置 PWM 对象的频率,频率的范围为 [1, 156250]。如果参数为空,返回当前 PWM 对象的频率;如果参数非空,则使用该参数设置当前 PWM 对象的频率。
+
+#### **PWM.duty**(duty)
+
+用于获取或者设置 PWM 对象的占空比数值,占空比数值的范围为 [0, 255],例如 `duty = 100`,表示当前设备占空比为 `100/255 = 39.22%` 。如果参数为空,返回当前 PWM 对象的占空比数值;如果参数非空,则使用该参数设置当前 PWM 对象的占空比数值。
+
+### 示例
+
+``` python
+>>> from machine import PWM     # 从 machine 导入 PWM 类
+>>> pwm = PWM(3, 3, 1000, 100)  # 创建 PWM 对象,当前使用编号为 1 的 PWM 设备的 4 通道,初始化的频率为 1000Hz,占空比数值为 100(占空比为 100/255 = 39.22%)
+>>> pwm.freq(2000)              # 设置 PWM 对象频率
+>>> pwm.freq()                  # 获取 PWM 对象频率
+2000
+>>> pwm.duty(200)               # 设置 PWM 对象占空比数值
+>>> pwm.duty()                  # 获取 PWM 对象占空比数值
+200
+>>> pwm.deinit()                # 关闭 PWM 对象
+>>> pwm.init(3, 1000, 100)      # 开启并重新配置 PWM 对象
+```

+ 110 - 0
docs/spec-librarys/machine/Pin.md

@@ -0,0 +1,110 @@
+## machine.Pin
+
+**machine.Pin** 类是 machine 模块下面的一个硬件类,用于对引脚的配置和控制,提供对 `Pin` 设备的操作方法。
+
+`Pin` 对象用于控制输入/输出引脚(也称为 `GPIO`)。`Pin` 对象通常与一个物理引脚相关联,他可以驱动输出电压和读取输入电压。Pin 类中有设置引脚模式(输入/输出)的方法,也有获取和设置数字逻辑(`0` 或 `1`)的方法。
+
+一个 `Pin` 对象是通过一个标识符来构造的,它明确地指定了一个特定的输入输出。标识符的形式和物理引脚的映射是特定于一次移植的。标识符可以是整数,字符串或者是一个带有端口和引脚号码的元组。在 RT-Thread MicroPython 中,引脚标识符是一个由代号和引脚号组成的元组,如 `Pin(("PB15", 31), Pin.OUT_PP)` 中的` ("PB15", 31)`。
+
+### 构造函数
+
+在 RT-Thread MicroPython 中 `Pin` 对象的构造函数如下:
+
+#### **class machine.Pin**( id, mode = -1, pull = -1,value)
+- **id** :由用户自定义的引脚名和 `Pin`  设备引脚号组成,如 ("PB15", 31),"PB15" 为用户自定义的引脚名,`31` 为 `RT-Thread Pin` 设备驱动在本次移植中的引脚号。
+
+- **mode** : 指定引脚模式,可以是以下几种:
+    - **Pin.IN** :输入模式
+    - **Pin.OUT** :输出模式
+    - **Pin.OPEN_DRAIN** :开漏模式
+
+- **pull** : 如果指定的引脚连接了上拉下拉电阻,那么可以配置成下面的状态:
+    - **None** :没有上拉或者下拉电阻。
+    - **Pin.PULL_UP** :使能上拉电阻。
+    - **Pin.PULL_DOWN** :使能下拉电阻。
+
+- **value** : `value` 的值只对输出模式和开漏输出模式有效,用来设置初始输出值。
+
+### 方法
+
+#### **Pin.init**(mode= -1, pull= -1, \*, value, drive, alt)
+
+根据输入的参数重新初始化引脚。只有那些被指定的参数才会被设置,其余引脚的状态将保持不变,详细的参数可以参考上面的构造函数。
+
+#### **Pin.value**([x])
+如果没有给定参数 `x` ,这个方法可以获得引脚的值。  
+如果给定参数 `x` ,如 `0` 或 `1`,那么设置引脚的值为 逻辑 `0` 或 逻辑 `1`。
+
+#### **Pin.name**()
+返回引脚对象在构造时用户自定义的引脚名。
+
+#### **Pin.irq**(handler=None, trigger=(Pin.IRQ_RISING))
+
+配置在引脚的触发源处于活动状态时调用的中断处理程序。如果引脚模式是, `Pin.IN` 则触发源是引脚上的外部值。 如果引脚模式是, `Pin.OUT` 则触发源是引脚的输出缓冲器。 否则,如果引脚模式是, `Pin.OPEN_DRAIN` 那么触发源是状态'0'的输出缓冲器和状态'1'的外部引脚值。
+
+参数:
+
+- `handler` 是一个可选的函数,在中断触发时调用
+- `trigger` 配置可以触发中断的事件。可能的值是:
+    - `Pin.IRQ_FALLING` 下降沿中断
+    - `Pin.IRQ_RISING` 上升沿中断
+    - `Pin.IRQ_RISING_FALLING` 上升沿或下降沿中断
+    - `Pin.IRQ_LOW_LEVEL` 低电平中断
+    - `Pin.IRQ_HIGH_LEVEL` 高电平中断
+
+### 常量
+
+下面的常量用来配置 `Pin` 对象。 
+
+#### 选择引脚模式:
+##### **Pin.IN**
+##### **Pin.OUT**
+##### **Pin.OPEN_DRAIN**
+
+#### 选择上/下拉模式:
+##### **Pin.PULL_UP**
+##### **Pin.PULL_DOWN**
+##### **None**  
+使用值 `None` 代表不进行上下拉。
+
+#### 选择中断触发模式:
+##### **Pin.IRQ_FALLING**
+##### **Pin.IRQ_RISING**
+##### **Pin.IRQ_RISING_FALLING**
+##### **Pin.IRQ_LOW_LEVEL** 
+##### **Pin.IRQ_HIGH_LEVEL** 
+
+### 示例一
+
+控制引脚输出高低电平信号,并读取按键引脚电平信号。
+
+```
+from machine import Pin
+
+PIN_OUT = 31
+PIN_IN  = 58
+
+p_out = Pin(("PB15", PIN_OUT), Pin.OUT_PP)
+p_out.value(1)                 # set io high
+p_out.value(0)                 # set io low
+
+p_in = Pin(("key_0", PIN_IN), Pin.IN, Pin.PULL_UP)
+print(p_in.value() )           # get value, 0 or 1
+```
+
+### 示例二
+
+上升沿信号触发引脚中断后执行中断处理函数。
+
+```
+from machine import Pin
+
+PIN_KEY0 = 58    # PD10
+key_0 = Pin(("key_0", PIN_KEY0), Pin.IN, Pin.PULL_UP)
+
+def func(v):
+    print("Hello rt-thread!")
+
+key_0.irq(trigger=Pin.IRQ_RISING, handler=func)
+```
+更多内容可参考 [machine.Pin](http://docs.micropython.org/en/latest/pyboard/library/machine.Pin.html)  。

+ 56 - 0
docs/spec-librarys/machine/RTC.md

@@ -0,0 +1,56 @@
+## machine.RTC
+
+**machine.RTC** 类是 machine 模块下面的一个硬件类,用于对指定 RTC 设备的配置和控制,提供对 RTC 设备的操作方法。
+
+- RTC(Real-Time Clock )实时时钟可以提供精确的实时时间,它可以用于产生年、月、日、时、分、秒等信息。
+
+### 构造函数
+
+在 RT-Thread MicroPython 中 `RTC` 对象的构造函数如下:
+
+#### **class machine.RTC**()
+
+所以在给定的总线上构造一个 `RTC` 对象,无入参对象,使用方式可参考 [示例](#_3)。 
+
+### 方法
+
+#### **RTC.init**(datetime)
+
+根据传入的参数初始化 RTC 设备起始时间。入参 `datetime` 为一个时间元组,格式如下:
+
+```
+(year, month, day, wday, hour, minute, second, yday)
+```
+参数介绍如下所示:
+
+- **year**:年份;
+- **month**:月份,范围 [1, 12];
+- **day**:日期,范围 [1, 31];
+- **wday**:星期,范围 [0, 6],0 表示星期一,以此类推;
+- **hour**:小时,范围 [0, 23];
+- **minute**:分钟,范围[0, 59];
+- **second**:秒,范围[0, 59];
+- **yday**:从当前年份 1 月 1 日开始的天数,范围 [0, 365],一般置位 0 未实现。
+
+使用的方式可参考 [示例](#_3)。
+
+#### **RTC.deinit**()
+
+重置 RTC 设备时间到 2015 年 1 月 1日,重新运行 RTC 设备。
+
+#### **RTC.now**()
+
+获取当前时间,返回值为上述 `datetime` 时间元组格式。
+
+### 示例
+
+```python
+>>> from machine import RTC
+>>> rtc = RTC()                        # 创建 RTC 设备对象
+>>> rtc.init((2019,6,5,2,10,22,30,0))  # 设置初始化时间
+>>> rtc.now()                          # 获取当前时间
+(2019, 6, 5, 2, 10, 22, 40, 0)
+>>> rtc.deinit()                       # 重置时间到2015年1月1日
+>>> rtc.now()                          # 获取当前时间
+(2015, 1, 1, 3, 0, 0, 1, 0)
+```

+ 99 - 0
docs/spec-librarys/machine/SPI.md

@@ -0,0 +1,99 @@
+## machine.SPI
+
+**machine.SPI** 类是 machine 模块下面的一个硬件类,用于对 SPI 的配置和控制,提供对 SPI 设备的操作方法。
+
+- `SPI` 是一个由主机驱动的同步串行协议。在物理层,总线有三根:`SCK`、`MOSI`、`MISO`。多个设备可以共享同一总线,每个设备都由一个单独的信号 `SS` 来选中,也称片选信号。
+- 主机通过片选信号选定一个设备进行通信。`SS` 信号的管理应该由用户代码负责。(通过 [machine.Pin](02-machine-Pin.md))
+
+### 构造函数
+
+在 RT-Thread MicroPython 中 `SPI` 对象的构造函数如下:
+
+#### **class machine.SPI**(id, ...)
+在给定总线上构造一个 `SPI` 对象,`id` 取决于特定的移植。
+
+如果想要使用软件 `SPI` , 即使用引脚模拟 `SPI` 总线,那么初始化的第一个参数需要设置为 `-1` ,可参考 [软件 SPI 示例](#spi) 。
+
+使用硬件 `SPI` 在初始化时只需传入 `SPI` 设备的编号即可,如 '50' 表示 `SPI5` 总线上的第 0 个设备。初始化方式可参考 [硬件 SPI 示例](#spi_1)。
+
+如果没有额外的参数,`SPI` 对象会被创建,但是不会被初始化,如果给出额外的参数,那么总线将被初始化,初始化参数可以参考下面的 `SPI.init` 方法。
+
+### 方法
+
+#### **SPI.init**(baudrate=1000000, \*, polarity=0, phase=0, bits=8, firstbit=SPI.MSB, sck=None, mosi=None, miso=None)
+
+用给定的参数初始化`SPI`总线:
+
+- **baudrate** :`SCK` 时钟频率。
+- **polarity** :极性可以是 `0` 或 `1`,是时钟空闲时所处的电平。
+- **phase** :相位可以是 `0` 或 `1`,分别在第一个或者第二个时钟边缘采集数据。
+- **bits** :每次传输的数据长度,一般是 8 位。
+- **firstbit** :传输数据从高位开始还是从低位开始,可以是 `SPI.MSB` 或者 `SPI.LSB`。
+- **sck** :用于 `sck` 的 `machine.Pin` 对象。
+- **mosi** :用于 `mosi` 的 `machine.Pin` 对象。
+- **miso** :用于`miso` 的 `machine.Pin` 对象。
+
+#### **SPI.deinit**()
+关闭 `SPI` 总线。
+
+#### **SPI.read**(nbytes, write=0x00)
+读出 n 字节的同时不断的写入 `write` 给定的单字节。返回一个存放着读出数据的字节对象。
+
+#### **SPI.readinto**(buf, write=0x00)
+读出 n 字节到 `buf` 的同时不断地写入 `write` 给定的单字节。  
+这个方法返回读入的字节数。
+
+#### **SPI.write**(buf)
+写入 `buf` 中包含的字节。返回`None`。
+
+#### **SPI.write_readinto**(write_buf, read_buf)
+在读出数据到 `readbuf` 时,从 `writebuf` 中写入数据。缓冲区可以是相同的或不同,但是两个缓冲区必须具有相同的长度。返回 `None`。
+
+### 常量
+
+#### **SPI.MASTER**
+用于初始化 `SPI` 总线为主机。
+
+#### **SPI.MSB**
+设置从高位开始传输数据。
+
+#### **SPI.LSB**
+设置从低位开始传输数据。
+
+### 示例
+
+#### 软件模拟 SPI
+```
+>>> from machine import Pin, SPI
+>>> clk = Pin(("clk", 26), Pin.OUT_PP)
+>>> mosi = Pin(("mosi", 27), Pin.OUT_PP)
+>>> miso = Pin(("miso", 28), Pin.IN)
+>>> spi = SPI(-1, 500000, polarity = 0, phase = 0, bits = 8, firstbit = 0, sck = clk, mosi = mosi, miso = miso)
+>>> print(spi)
+SoftSPI(baudrate=500000, polarity=0, phase=0, sck=clk, mosi=mosi, miso=miso)
+>>> spi.write("hello rt-thread!")
+>>> spi.read(10)
+b'\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00'
+```
+
+#### 硬件 SPI
+
+需要先开启 `SPI` 设备驱动,查找设备可以在 `msh` 中输入`list_device` 命令。  
+在构造函数的第一个参数传入 `50`,系统就会搜索名为 `spi50` 的设备,找到之后使用这个设备来构建 `SPI` 对象:
+
+```
+>>> from machine import SPI
+>>> spi = SPI(50)
+>>> print(spi)
+SPI(device port : spi50)
+>>> spi.write(b'\x9f')
+>>> spi.read(5)
+b'\xff\xff\xff\xff\xff'
+>>> buf = bytearray(1)
+>>> spi.write_readinto(b"\x9f",buf)
+>>> buf
+bytearray(b'\xef')
+>>> spi.init(100000,0,0,8,1)     # Resetting SPI parameter
+```
+
+  更多内容可参考 [machine.SPI](http://docs.micropython.org/en/latest/pyboard/library/machine.SPI.html) 。

+ 73 - 0
docs/spec-librarys/machine/Timer.md

@@ -0,0 +1,73 @@
+## machine.Timer
+
+**machine.Timer** 类是 machine 模块下的一个硬件类,用于 Timer 设备的配置和控制,提供对 Timer 设备的操作方法。
+
+- Timer(硬件定时器),是一种用于处理周期性和定时性事件的设备。
+- Timer 硬件定时器主要通过内部计数器模块对脉冲信号进行计数,实现周期性设备控制的功能。
+- Timer 硬件定时器可以自定义**超时时间**和**超时回调函数**,并且提供两种**定时器模式**:
+  - `ONE_SHOT`:定时器只执行一次设置的回调函数;
+  - `PERIOD`:定时器会周期性执行设置的回调函数;
+- 打印 Timer 对象会打印出配置的信息。
+
+### 构造函数
+
+在 RT-Thread MicroPython 中 `Timer` 对象的构造函数如下:
+
+#### **class machine.Timer**(id)
+
+- **id**:使用的 Timer 设备编号,`id = 1` 表示编号为 1 的 Timer 设备,或者表示使用的 timer 设备名,如 `id = "timer"` 表示设备名为 `timer` 的 Timer 设备;
+
+该函数主要用于通过设备编号创建 Timer 设备对象。
+
+### 方法
+
+#### **Timer.init**(mode = Timer.PERIODIC, period = 0, callback = None)
+
+- **mode**:设置 Timer 定时器模式,可以设置两种模式:`ONE_SHOT`(执行一次)、`PERIOD`(周期性执行),默认设置的模式为 `PERIOD` 模式;
+
+- **period**:设置 Timer 定时器定时周期,单位:毫秒(ms)
+
+- **callback**:设置 Timer 定义器超时回调函数,默认设置的函数为 None 空函数,设置的函数格式如下所示:
+
+```python
+def callback_test(device):         # 回调函数有且只有一个入参,为创建的 Timer 对象
+    print("Timer callback test")
+    print(device)                  # 打印 Timer 对象配置信息
+```
+
+该函数使用方式如下示例所示:
+
+```python
+timer.init(wdt.PERIOD, 5000, callback_test)   # 设置定时器模式为周期性执行,超时时间为 5 秒, 超时函数为 callback_test
+```
+#### **Timer.deinit**()
+
+该函数用于停止并关闭 Timer 设备。
+
+### 常量
+
+下面的常量用来配置 `Timer` 对象。
+
+#### 选择定时器模式:
+##### **Timer.PERIODIC**
+##### **Timer.ONE_SHOT**
+
+### 示例
+
+```python
+>>> from machine import Timer                       # 从 machine 导入 Timer 类
+>>> timer = Timer(15)                               # 创建 Timer 对象,当前设备编号为 11
+>>>                                                 # 进入粘贴模式
+paste mode; Ctrl-C to cancel, Ctrl-D to finish
+=== def callback_test(device):                      # 定义超时回调函数 
+===     print("Timer callback test")
+>>> timer.init(timer.PERIODIC, 5000, callback_test) # 初始化 Timer 对象,设置定时器模式为循环执行,超时时间为 5 秒,超时回调函数 callback_test
+>>> Timer callback test                             # 5 秒超时循环执行回调函数,打印日志
+>>> Timer callback test
+>>> Timer callback test
+>>> timer.init(timer.ONE_SHOT, 5000, callback_test) # 设置定时器模式为只执行一次,超时时间为 5 秒,超时回调函数为 callback_test
+>>> Timer callback test                             # 5 秒超时后执行一次回调函数,打印日志
+>>> timer.deinit()                                  # 停止并关闭 Timer 定时器
+```
+
+更多内容可参考 [machine.Timer](http://docs.micropython.org/en/latest/library/machine.Timer.html)。

+ 60 - 0
docs/spec-librarys/machine/UART.md

@@ -0,0 +1,60 @@
+## machine.UART
+
+**machine.UART** 类是 machine 模块下面的一个硬件类,用于对 UART 的配置和控制,提供对 UART 设备的操作方法。
+
+`UART` 实现了标准的 `uart/usart` 双工串行通信协议,在物理层上,他由两根数据线组成:`RX` 和 `TX`。通信单元是一个字符,它可以是 8 或 9 位宽。
+
+### 构造函数
+
+在 RT-Thread MicroPython 中 `UART` 对象的构造函数如下:
+
+#### **class machine.UART**(id, ...)
+在给定总线上构造一个 `UART` 对象,`id` 取决于特定的移植。  
+初始化参数可以参考下面的 `UART.init` 方法。 
+
+使用硬件 UART 在初始化时只需传入 `UART` 设备的编号即可,如传入 `1` 表示 `uart1` 设备。   
+初始化方式可参考 [示例](#_3)。
+
+### 方法
+
+#### **UART.init**(baudrate = 9600, bits=8, parity=None, stop=1)
+- **baudrate** :`SCK` 时钟频率。
+- **bits** :每次发送数据的长度。
+- **parity** :校验方式。
+- **stop** :停止位的长度。
+
+#### **UART.deinit**()
+关闭串口总线。
+
+#### **UART.read**([nbytes])
+读取字符,如果指定读 n 个字节,那么最多读取 n 个字节,否则就会读取尽可能多的数据。
+返回值:一个包含读入数据的字节对象。如果如果超时则返回 `None`。
+
+#### **UART.readinto**(buf[, nbytes])
+读取字符到 `buf` 中,如果指定读 n 个字节,那么最多读取 n 个字节,否则就读取尽可能多的数据。另外读取数据的长度不超过 `buf` 的长度。
+返回值:读取和存储到 `buf` 中的字节数。如果超时则返回 `None`。
+
+#### **UART.readline**()
+读一行数据,以换行符结尾。
+返回值:读入的行数,如果超时则返回 `None`。
+
+#### **UART.write**(buf)
+将 `buf` 中的数据写入总线。
+返回值:写入的字节数,如果超时则返回 `None`。
+
+### 示例
+
+在构造函数的第一个参数传入`1`,系统就会搜索名为 `uart1` 的设备,找到之后使用这个设备来构建 `UART` 对象:
+
+```python
+from machine import UART
+uart = UART(1, 115200)                         # init with given baudrate
+uart.init(115200, bits=8, parity=None, stop=1) # init with given parameters
+uart.read(10)       # read 10 characters, returns a bytes object
+uart.read()         # read all available characters
+uart.readline()     # read a line
+uart.readinto(buf)  # read and store into the given buffer
+uart.write('abc')   # write the 3 characters
+```
+
+  更多内容可参考 [machine.UART](http://docs.micropython.org/en/latest/pyboard/library/machine.UART.html) 。

+ 42 - 0
docs/spec-librarys/machine/WDT.md

@@ -0,0 +1,42 @@
+## machine.WDT
+
+**machine.WDT** 类是 machine 模块下的一个硬件类,用于 WDT 设备的配置和控制,提供对 WDT 设备的操作方法。
+
+如下为 WDT 设备基本介绍:
+
+- WDT(WatchDog Timer,硬件看门狗),是一个定时器设备,用于系统程序结束或出错导致系统进入不可恢复状态时重启系统。
+
+- WDT 启动之后,计数器开始计数,在计数器溢出前没有被复位,会对 CPU 产生一个复位信号使设备重启(简称 “被狗咬”);
+
+- 系统正常运行时,需要在 WDT 设备允许的时间间隔内对看门狗计数清零(简称“喂狗”),WDT 设备一旦启动,需要定时“喂狗”以确保设备正常运行。
+
+### 构造函数
+
+在 RT-Thread MicroPython 中 `WDT` 对象的构造函数如下:
+
+#### **class machine.WDT**(id = "wdt", timeout=5)
+
+- **id**: 使用的 WDT 设备编号,`id = 1` 表示编号为 1 的 WDT 设备,或者表示使用的 WDT 设备名,如 `id = "wdt"` 表示设备名为 `wdt` 的 WDT 设备;
+
+- **timeout**:设置看门狗超时时间,单位:秒(s);
+
+用于创建一个 WDT 对象并且启动 WDT 功能。一旦启动,设置的超时时间无法改动,WDT 功能无法停止。
+
+如果该函数入参为空,则设置超时时间为 5 秒;如果入参非空,则使用该入参设置 WDT 超时时间,超时时间最小设置为 1 秒。
+
+### 方法
+
+#### **WDT.feed**()
+
+用于执行“喂狗”操作,清空看门狗设备计数。应用程序应该合理的周期性调用该函数,以防止系统重启。
+
+### 示例
+
+``` python
+>>> from machine import WDT     # 从 machine 导入 WDT 类
+>>> wdt = WDT()                 # 创建 WDT 对象,默认超时时间为 5 秒
+>>> wdt = WDT(10)               # 创建 WDT 对象,设置超时时间为 10 秒
+>>> wdt.feed()                  # 在 10 秒超时时间内需要执行“喂狗”操作,清空看门狗设备计数,否则系统将重启
+```
+
+更多内容可参考 [machine.WDT](http://docs.micropython.org/en/latest/library/machine.WDT.html) 。

+ 72 - 0
docs/spec-librarys/micropython.md

@@ -0,0 +1,72 @@
+
+# micropython – 内部功能访问与控制模块
+
+## Functions
+
+### micropython.const(expr)
+Used to declare that the expression is a constant so that the compile can optimise it. The use of this function should be as follows:
+
+
+```python
+from micropython import const
+CONST_X = const(123)
+CONST_Y = const(2 * CONST_X + 1)
+```
+
+Constants declared this way are still accessible as global variables from outside the module they are declared in. On the other hand, if a constant begins with an underscore then it is hidden, it is not available as a global variable, and does not take up any memory during execution.
+
+This const function is recognised directly by the MicroPython parser and is provided as part of the micropython module mainly so that scripts can be written which run under both CPython and MicroPython, by following the above pattern.
+
+### micropython.opt_level([level])
+
+If level is given then this function sets the optimisation level for subsequent compilation of scripts, and returns None. Otherwise it returns the current optimisation level.
+
+- The optimisation level controls the following compilation features:
+- Assertions: at level 0 assertion statements are enabled and compiled into the bytecode; at levels 1 and higher assertions are not compiled.
+- Built-in __debug__ variable: at level 0 this variable expands to True; at levels 1 and higher it expands to False.
+  Source-code line numbers: at levels 0, 1 and 2 source-code line number are stored along with the bytecode so that exceptions can report the line number they occurred at; at levels 3 and higher line numbers are not stored.
+- The default optimisation level is usually level 0.
+
+### micropython.alloc_emergency_exception_buf(size)
+Allocate size bytes of RAM for the emergency exception buffer (a good size is around 100 bytes). The buffer is used to create exceptions in cases when normal RAM allocation would fail (eg within an interrupt handler) and therefore give useful traceback information in these situations.
+
+A good way to use this function is to put it at the start of your main script (eg boot.py or main.py) and then the emergency exception buffer will be active for all the code following it.
+
+### micropython.mem_info([verbose])
+
+Print information about currently used memory. If the verbose argument is given then extra information is printed.
+
+The information that is printed is implementation dependent, but currently includes the amount of stack and heap used. In verbose mode it prints out the entire heap indicating which blocks are used and which are free.
+
+### micropython.qstr_info([verbose])
+Print information about currently interned strings. If the verbose argument is given then extra information is printed.
+
+The information that is printed is implementation dependent, but currently includes the number of interned strings and the amount of RAM they use. In verbose mode it prints out the names of all RAM-interned strings.
+
+### micropython.stack_use()
+  Return an integer representing the current amount of stack that is being used. The absolute value of this is not particularly useful, rather it should be used to compute differences in stack usage at different points.
+
+### micropython.heap_lock()
+### micropython.heap_unlock()
+  Lock or unlock the heap. When locked no memory allocation can occur and a MemoryError will be raised if any heap allocation is attempted.
+
+These functions can be nested, ie heap_lock() can be called multiple times in a row and the lock-depth will increase, and then heap_unlock() must be called the same number of times to make the heap available again.
+
+If the REPL becomes active with the heap locked then it will be forcefully unlocked.
+
+### micropython.kbd_intr(chr)
+Set the character that will raise a KeyboardInterrupt exception. By default this is set to 3 during script execution, corresponding to Ctrl-C. Passing -1 to this function will disable capture of Ctrl-C, and passing 3 will restore it.
+
+This function can be used to prevent the capturing of Ctrl-C on the incoming stream of characters that is usually used for the REPL, in case that stream is used for other purposes.
+
+### micropython.schedule(func, arg)
+  Schedule the function func to be executed “very soon”. The function is passed the value arg as its single argument. “Very soon” means that the MicroPython runtime will do its best to execute the function at the earliest possible time, given that it is also trying to be efficient, and that the following conditions hold:
+
+- A scheduled function will never preempt another scheduled function.
+- Scheduled functions are always executed “between opcodes” which means that all fundamental Python operations (such as appending to a list) are guaranteed to be atomic.
+- A given port may define “critical regions” within which scheduled functions will never be executed. Functions may be scheduled within a critical region but they will not be executed until that region is exited. An example of a critical region is a preempting interrupt handler (an IRQ).
+  A use for this function is to schedule a callback from a preempting IRQ. Such an IRQ puts restrictions on the code that runs in the IRQ (for example the heap may be locked) and scheduling a function to call later will lift those restrictions.
+
+Note: If schedule() is called from a preempting IRQ, when memory allocation is not allowed and the callback to be passed to schedule() is a bound method, passing this directly will fail. This is because creating a reference to a bound method causes memory allocation. A solution is to create a reference to the method in the class constructor and to pass that reference to schedule(). This is discussed in detail here reference documentation under “Creation of Python objects”.
+
+There is a finite queue to hold the scheduled functions and schedule() will raise a RuntimeError if the queue is full.

+ 10 - 0
docs/spec-librarys/network.md

@@ -0,0 +1,10 @@
+## network – 网络配置
+
+此模块提供网络驱动程序和路由配置。特定硬件的网络驱动程序在此模块中可用,用于配置硬件网络接口。然后,配置接口提供的网络服务可以通过 `usocket` 模块使用。
+
+### 专用的网络类配置
+
+下面具体的类实现了抽象网卡的接口,并提供了一种控制各种网络接口的方法。
+
+- [class WLAN – control built-in WiFi interfaces](network/wlan.md)
+

+ 109 - 0
docs/spec-librarys/network/wlan.md

@@ -0,0 +1,109 @@
+## class WLAN – 控制内置的 WiFi 网络接口
+
+该类为 WiFi 网络处理器提供一个驱动程序。使用示例:
+
+```python
+import network
+# enable station interface and connect to WiFi access point
+nic = network.WLAN(network.STA_IF)
+nic.active(True)
+nic.connect('your-ssid', 'your-password')
+# now use sockets as usual
+```
+
+### 构造函数
+
+在 RT-Thread MicroPython 中 `WLAN` 对象的构造函数如下:
+
+#### class network.WLAN(interface_id)
+
+创建一个 WLAN 网络接口对象。支持的接口是 ` network.STA_IF`(STA 模式,可以连接到上游的 WiFi 热点上) 和 `network.AP_IF`(AP 模式,允许其他 WiFi 客户端连接到自身的热点)。下面方法的可用性取决于接口的类型。例如,只有STA 接口可以使用 `WLAN.connect()`  方法连接到 AP 热点上。
+
+### 方法
+
+#### **WLAN.active**([is_active])
+
+如果向该方法传入布尔数值,传入 True 则使能卡,传入 False 则禁止网卡。否则,如果不传入参数,则查询当前网卡的状态。
+
+#### **WLAN.connect**(ssid, password)
+使用指定的账号和密码链接指定的无线热点。
+
+#### **WLAN.disconnect**()
+从当前链接的无线网络中断开。
+
+#### **WLAN.scan**()
+
+扫描当前可以连接的无线网络。
+
+只能在 STA 模式下进行扫描,使用元组列表的形式返回 WiFi 接入点的相关信息。
+
+(ssid, bssid, channel, rssi, authmode, hidden)
+
+#### **WLAN.status**([param])
+
+返回当前无线连接的状态。
+
+当调用该方法时没有附带参数,就会返回值描述当前网络连接的状态。如果还没有从热点连接中获得 IP 地址,此时的状态为 `STATION_IDLE`。如果已经从连接的无线网络中获得 IP 地址,此时的状态为 `STAT_GOT_IP`。
+
+当调用该函数使用的参数为 `rssi` 时,则返回 `rssi` 的值,该函数目前只支持这一个参数。
+
+#### **WLAN.isconnected**()
+
+在 STA 模式时,如果已经连接到 WiFi 网络,并且获得了 IP 地址,则返回 True。如果处在 AP 模式,此时已经与客户端建立连接,则返回 True。其他情况下都返回 False。
+
+#### WLAN.ifconfig([(ip, subnet, gateway, dns)])
+
+获取或者设置网络接口的参数,IP 地址,子网掩码,网关,DNS 服务器。当调用该方法不附带参数时,该方法会返回一个包含四个元素的元组来描述上面的信息。想要设置上面的值,传入一个包含上述四个元素的元组,例如:
+
+```python
+nic.ifconfig(('192.168.0.4', '255.255.255.0', '192.168.0.1', '8.8.8.8'))
+```
+
+#### **WLAN.config**('param')
+
+#### WLAN.config(param=value, ...)
+
+获取或者设置一般网络接口参数,这些方法允许处理标准的 ip 配置之外的其他参数,如 `WLAN. ifconfig()` 函数处理的参数。这些参数包括特定网络和特定硬件的参数。对于参数的设置,应该使用关键字的语法,可以一次性设置多个参数。
+
+当查询参数时,参数名称的引用应该为字符串,且每次只能查询一个参数。
+
+```python
+# Set WiFi access point name (formally known as ESSID) and WiFi password
+ap.config(essid='My_AP', password="88888888")
+# Query params one by one
+print(ap.config('essid'))
+print(ap.config('channel'))
+```
+下面是目前支持的参数:
+
+| Parameter | Description                       |
+| --------- | --------------------------------- |
+| mac       | MAC address (bytes)               |
+| essid     | WiFi access point name (string)   |
+| channel   | WiFi channel (integer)            |
+| hidden    | Whether ESSID is hidden (boolean) |
+| password  | Access password (string)          |
+
+
+### 示例
+
+STA 模式下:
+
+```python
+import network
+wlan = network.WLAN(network.STA_IF)
+wlan.scan()
+wlan.connect("rtthread","02188888888")
+wlan.isconnected()
+```
+
+AP 模式下:
+
+```python
+import network
+ap = network.WLAN(network.AP_IF)
+ap.config(essid="hello_rt-thread", password="88888888")
+ap.active(True)
+ap.config("essid")
+```
+

+ 34 - 0
docs/spec-librarys/rtthread.md

@@ -0,0 +1,34 @@
+## **rtthread** – 系统相关函数
+
+**rtthread** 模块提供了与 RT-Thread 操作系统相关的功能,如查看栈使用情况等。
+
+### 函数
+
+#### rtthread.current_tid()  
+返回当前线程的 id 。
+
+#### rtthread.is_preempt_thread()  
+返回是否是可抢占线程。
+
+#### rtthread.stacks_analyze()  
+返回当前系统线程和栈使用信息。
+
+### 示例
+
+```
+>>> import rtthread
+>>> 
+>>> rtthread.is_preempt_thread()       # determine if code is running in a preemptible thread
+True
+>>> rtthread.current_tid()             # current thread id
+268464956
+>>> rtthread.stacks_analyze()          # show thread information
+thread     pri  status      sp     stack size max used left tick  error
+---------- ---  ------- ---------- ----------  ------  ---------- ---
+elog_async  31  suspend 0x000000a8 0x00000400    26%   0x00000003 000
+tshell      20  ready   0x00000260 0x00001000    39%   0x00000003 000
+tidle       31  ready   0x00000070 0x00000100    51%   0x0000000f 000
+SysMonitor  30  suspend 0x000000a4 0x00000200    32%   0x00000005 000
+timer        4  suspend 0x00000080 0x00000200    25%   0x00000009 000
+>>> 
+```

+ 28 - 0
docs/std-librarys/_thread.md

@@ -0,0 +1,28 @@
+## _thread – 多线程支持
+
+`_thread` 模块提供了用于处理多线程的基本方法——多个控制线程共享它们的全局数据空间。为了实现同步,提供了简单的锁(也称为互斥锁或二进制信号量)。
+
+### 示例
+
+```python
+import _thread
+import time
+def testThread():
+    while True:
+        print("Hello from thread")
+        time.sleep(2)
+
+_thread.start_new_thread(testThread, ())
+while True:
+    pass
+```
+
+输出结果(启动新的线程,每隔两秒打印字符):
+
+Hello from thread
+Hello from thread
+Hello from thread
+Hello from thread
+Hello from thread
+
+更多内容可参考 [_thread](http://docs.micropython.org/en/latest/pyboard/library/_thread.html)  。

+ 104 - 0
docs/std-librarys/builtins.md

@@ -0,0 +1,104 @@
+# Builtin functions and exceptions
+
+所有的内饰函数和异常类型都在下面描述。
+
+## 函数和类型
+
+- abs()
+- all()
+- any()
+- bin()
+- **class** bool
+- **class** bytearray
+- **class** bytes
+- callable()
+- chr()
+- classmethod()
+- compile()
+- **class** complex
+- delattr(obj, name)
+
+- **class** dict
+- dir()
+
+- divmod()
+- enumerate()
+- eval()
+- exec()
+- filter()
+- **class** float
+- **class** frozenset
+- getattr()
+- globals()
+- hasattr()
+- hash()
+- hex()
+- id()
+- input()
+- **class** int
+  - classmethod from_bytes(bytes, byteorder)
+    In MicroPython, byteorder parameter must be positional (this is compatible with CPython).
+  - to_bytes(size, byteorder)
+    In MicroPython, byteorder parameter must be positional (this is compatible with CPython).
+
+- isinstance()
+- issubclass()
+- iter()
+- len()
+- class list
+- locals()
+- map()
+- max()
+- **class** memoryview
+- min()
+- next()
+- **class** object
+- oct()
+- open()
+- ord()
+- pow()
+- print()
+- property()
+- range()
+- repr()
+- reversed()
+- round()
+- class set
+- setattr()
+- **class** slice
+  - The slice builtin is the type that slice objects have.
+- sorted()
+- staticmethod()
+- **class** str
+- sum()
+- super()
+- **class** tuple
+- type()
+- zip()
+
+## 异常类型
+- **exception** AssertionError
+- **exception** AttributeError
+- **exception** Exception
+- **exception** ImportError
+- **exception** IndexError
+- **exception** KeyboardInterrupt
+- **exception** KeyError
+- **exception** MemoryError
+- **exception** NameError
+- **exception** NotImplementedError
+- **exception** OSError
+  - See CPython documentation: OSError. MicroPython doesn’t implement errno attribute, instead use the standard way to access exception arguments: exc.args[0].
+
+- **exception** RuntimeError
+- **exception** StopIteration
+- **exception** SyntaxError
+- **exception** SystemExit
+  - See CPython documentation: SystemExit.
+
+- **exception** TypeError
+  - See CPython documentation: TypeError.
+
+- **exception** ValueError
+- **exception** ZeroDivisionError
+

+ 42 - 0
docs/std-librarys/cmath.md

@@ -0,0 +1,42 @@
+## **cmath** – 复数运算函数功能
+
+`cmath` 模块提供了一些用于复数运算的函数。这个模块中的函数接受整数、浮点数或复数作为参数。他们还将接受任何有复数或浮点方法的 Python 对象:这些方法分别用于将对象转换成复数或浮点数,然后将该函数应用到转换的结果中。
+
+### 函数
+
+#### **cmath.cos**(z)  
+返回``z``的余弦。
+
+#### **cmath.exp**(z)  
+返回``z``的指数。
+
+#### **cmath.log**(z)  
+返回``z``的对数。
+
+#### **cmath.log10**(z)  
+返回``z``的常用对数。
+
+#### **cmath.phase**(z)  
+返回``z``的相位, 范围是(-pi, +pi],以弧度表示。
+
+#### **cmath.polar**(z)  
+返回``z``的极坐标。
+
+#### **cmath.rect**(r, phi)  
+返回`模量r`和相位``phi``的复数。
+
+#### **cmath.sin**(z)  
+返回``z``的正弦。
+
+#### **cmath.sqrt**(z)  
+返回``z``的平方根。
+
+### 常数
+
+#### **cmath.e**  
+自然对数的指数。
+
+#### **cmath.pi**  
+圆周率。
+
+更多内容可参考 [cmath](http://docs.micropython.org/en/latest/pyboard/library/cmath.html)  。

+ 22 - 0
docs/std-librarys/gc.md

@@ -0,0 +1,22 @@
+## **gc** – 控制垃圾回收
+
+**gc** 模块提供了垃圾收集器的控制接口。
+
+### 函数
+
+#### **gc.enable**()  
+允许自动回收内存碎片。 
+
+#### **gc.disable**()  
+禁止自动回收,但可以通过collect()函数进行手动回收内存碎片。 
+
+#### **gc.collect**()  
+运行一次垃圾回收。
+
+#### **gc.mem_alloc**()  
+返回已分配的内存数量。 
+
+#### **gc.mem_free**()  
+返回剩余的内存数量。 
+
+更多内容可参考  [gc](http://docs.micropython.org/en/latest/pyboard/library/gc.html) 。

+ 283 - 0
docs/std-librarys/math.md

@@ -0,0 +1,283 @@
+## **math** – 数学函数
+
+**math** 模块提供了对 C 标准定义的数学函数的访问。
+
+> 注意:本模块需要带有硬件 FPU,精度是32位,这个模块需要浮点功能支持。
+
+### 常数
+
+#### **math.e**  
+自然对数的底数。
+
+示例:
+```
+>>>import math
+>>>print(math.e)
+2.718282
+```
+#### **math.pi**  
+圆周长与直径的比值。
+
+示例:
+
+```
+>>> print(math.pi)
+3.141593
+```
+
+### 函数
+
+#### **math.acos(x)**
+传入弧度值,计算cos(x)的反三角函数。 
+
+#### **math.acosh(x)** 
+  返回 ``x`` 的逆双曲余弦。
+
+#### **math.asin(x)**
+传入弧度值,计算sin(x)的反三角函数。 
+示例:
+
+```
+>>> x = math.asin(0.5)
+>>> print(x)
+0.5235988
+```
+
+#### **math.asinh(x)**
+  返回``x`` 的逆双曲正弦。
+
+#### **math.atan(x)**
+  返回 ``x`` 的逆切线。
+
+#### **math.atan2(y, x)**
+  Return the principal value of the inverse tangent of y/x.
+
+#### **math.atanh(x)**
+  Return the inverse hyperbolic tangent of x.
+
+#### **math.ceil(x)**
+向上取整。 
+示例:
+
+```
+>>> x = math.ceil(5.6454)
+>>> print(x)
+6
+```
+
+#### **math.copysign(x, y)** 
+  Return x with the sign of y.
+
+#### **math.cos(x)**  
+传入弧度值,计算余弦。 
+示例:计算cos60°
+
+```
+>>> math.cos(math.radians(60))
+0.5
+```
+
+#### **math.cosh(x)**  
+  Return the hyperbolic cosine of x.
+
+#### **math.degrees(x)**  
+弧度转化为角度。 
+示例:
+
+```
+>>> x = math.degrees(1.047198)
+>>> print(x)
+60.00002
+```
+
+#### **math.erf(x)**  
+  Return the error function of x.
+
+#### **math.erfc(x)**  
+  Return the complementary error function of x.
+
+#### **math.exp(x)**  
+计算e的x次方(幂)。 
+示例:
+
+```
+>>> x = math.exp(2)
+>>> print(x)
+7.389056
+```
+
+#### **math.expm1(x)**  
+计算 math.exp(x) - 1。 
+
+#### **math.fabs(x)**  
+计算绝对值。 
+示例:
+
+```
+>>> x = math.fabs(-5)
+>>> print(x)
+5.0
+>>> y = math.fabs(5.0)
+>>> print(y)
+5.0
+```
+
+#### **math.floor(x)**  
+向下取整。 
+示例:
+
+```
+>>> x = math.floor(2.99)
+>>> print(x)
+2
+>>> y = math.floor(-2.34)
+>>> print(y)
+-3
+```
+
+#### **math.fmod(x, y)**  
+取x除以y的模。 
+示例:
+
+```
+>>> x = math.fmod(4, 5)
+>>> print(x)
+4.0
+```
+
+#### **math.frexp(x)**  
+  Decomposes a floating-point number into its mantissa and exponent. The returned value is the tuple (m, e) such that x == m * 2**e exactly. If x == 0 then the function returns (0.0, 0), otherwise the relation 0.5 <= abs(m) < 1 holds.
+
+#### **math.gamma(x)**  
+返回伽马函数。 
+示例:
+
+```
+>>> x = math.gamma(5.21)
+>>> print(x)
+33.08715
+```
+
+#### **math.isfinite(x)**  
+  Return True if x is finite.
+
+#### **math.isinf(x)**  
+  Return True if x is infinite.
+
+#### **math.isnan(x)**  
+  Return True if x is not-a-number
+
+#### **math.ldexp(x, exp)**  
+  Return x * (2**exp).
+
+#### **math.lgamma(x)**  
+返回伽马函数的自然对数。 
+示例:
+
+```
+>>> x = math.lgamma(5.21)
+>>> print(x)
+3.499145
+```
+
+#### **math.log(x)**  
+计算以e为底的x的对数。 
+示例:
+
+```
+>>> x = math.log(10)
+>>> print(x)
+2.302585
+```
+
+#### **math.log10(x)**  
+计算以10为底的x的对数。 
+示例:
+
+```
+>>> x = math.log10(10)
+>>> print(x)
+1.0
+```
+
+#### **math.log2(x)**  
+ 计算以2为底的x的对数。 
+示例:
+
+```
+>>> x = math.log2(8)
+>>> print(x)
+3.0
+```
+
+#### **math.modf(x)**  
+  Return a tuple of two floats, being the fractional and integral parts of x. Both return values have the same sign as x.
+
+#### **math.pow(x, y)**  
+计算 x 的 y 次方(幂)。 
+示例:
+
+```
+>>> x = math.pow(2, 3)
+>>> print(x)
+8.0
+```
+
+#### **math.radians(x)**  
+角度转化为弧度。 
+示例:
+
+```
+>>> x = math.radians(60)
+>>> print(x)
+1.047198
+```
+
+#### **math.sin(x)**  
+传入弧度值,计算正弦。 
+示例:计算sin90°
+
+```
+>>> math.sin(math.radians(90))
+1.0
+```
+
+#### **math.sinh(x)**  
+  Return the hyperbolic sine of x.
+
+#### **math.sqrt(x)**  
+计算平方根。 
+示例:
+
+```
+>>> x = math.sqrt(9)
+>>> print(x)
+3.0
+```
+
+#### **math.tan(x)**  
+传入弧度值,计算正切。 
+示例:计算tan60°
+
+```
+>>> math.tan(math.radians(60))
+1.732051
+```
+
+#### **math.tanh(x)**  
+  Return the hyperbolic tangent of x.
+
+#### **math.trunc(x)**  
+取整。 
+示例:
+
+```
+>>> x = math.trunc(5.12)
+>>> print(x)
+5
+>>> y = math.trunc(-6.8)
+>>> print(y)
+-6
+```
+
+更多内容可参考  [math](http://docs.micropython.org/en/latest/pyboard/library/math.html) 。

+ 34 - 0
docs/std-librarys/rtthread.md

@@ -0,0 +1,34 @@
+## **rtthread** – 系统相关函数
+
+**rtthread** 模块提供了与 RT-Thread 操作系统相关的功能,如查看栈使用情况等。
+
+### 函数
+
+#### rtthread.current_tid()  
+返回当前线程的 id 。
+
+#### rtthread.is_preempt_thread()  
+返回是否是可抢占线程。
+
+#### rtthread.stacks_analyze()  
+返回当前系统线程和栈使用信息。
+
+### 示例
+
+```
+>>> import rtthread
+>>> 
+>>> rtthread.is_preempt_thread()       # determine if code is running in a preemptible thread
+True
+>>> rtthread.current_tid()             # current thread id
+268464956
+>>> rtthread.stacks_analyze()          # show thread information
+thread     pri  status      sp     stack size max used left tick  error
+---------- ---  ------- ---------- ----------  ------  ---------- ---
+elog_async  31  suspend 0x000000a8 0x00000400    26%   0x00000003 000
+tshell      20  ready   0x00000260 0x00001000    39%   0x00000003 000
+tidle       31  ready   0x00000070 0x00000100    51%   0x0000000f 000
+SysMonitor  30  suspend 0x000000a4 0x00000200    32%   0x00000005 000
+timer        4  suspend 0x00000080 0x00000200    25%   0x00000009 000
+>>> 
+```

+ 69 - 0
docs/std-librarys/sys.md

@@ -0,0 +1,69 @@
+## **sys** – 系统特有功能函数
+
+**sys** 模块提供系统特有的功能。
+
+### 函数
+
+#### **sys.exit**(retval=0)  
+  终止当前程序给定的退出代码。 函数会抛出 `SystemExit` 异常。
+#### **sys.print_exception**(exc, file=sys.stdout)  
+  打印异常与追踪到一个类似文件的对象 file (或者缺省 `sys.stdout` ).
+
+> 提示:这是 CPython 中回溯模块的简化版本。不同于 `traceback.print_exception()`,这个函数用异常值代替了异常类型、异常参数和回溯对象。文件参数在对应位置,不支持更多参数。CPython 兼容回溯模块在 `micropython-lib`。  
+
+### 常数
+
+#### **sys.argv**  
+  当前程序启动时参数的可变列表。
+
+#### **sys.byteorder**  
+  系统字节顺序 (“little” or “big”).
+
+#### **sys.implementation**  
+  关于当前 Python 实现的信息,对于 MicroPython 来说,有以下属性:  
+  - 名称 -  ‘’micropython“  
+  - 版本 - 元组(主要,次要,小),比如(1,9,3) 
+
+#### **sys.modules**  
+  已加载模块的字典。在一部分移植中,它可能不包含内置模块。
+
+#### **sys.path**  
+  用来搜索导入模块地址的列表。
+
+#### **sys.platform**  
+  返回当前平台的信息。
+
+#### **sys.stderr**  
+  标准错误流。
+
+#### **sys.stdin**  
+  标准输入流。
+
+#### **sys.stdout**  
+  标准输出流。
+
+#### **sys.version**  
+  符合的 Python 语言版本,如字符串。
+
+#### **sys.version_info**  
+  本次实现使用的 Python 语言版本,用一个元组的方式表示。
+
+### 示例 
+
+```
+>>> import sys
+>>> sys.version
+'3.4.0'
+>>> sys.version_info
+(3, 4, 0)
+>>> sys.path
+['', '/libs/mpy/']
+>>> sys.__name__
+'sys'
+>>> sys.platform
+'rt-thread'
+>>> sys.byteorder
+'little'
+```
+
+更多内容可参考 [sys](http://docs.micropython.org/en/latest/pyboard/library/sys.html) 。

+ 56 - 0
docs/std-librarys/uarray.md

@@ -0,0 +1,56 @@
+## **array** – 数字数据数组
+
+**array**  模块定义了一个对象类型,它可以简洁地表示基本值的数组:字符、整数、浮点数。支持代码格式: b, B, h, H, i, I, l, L, q, Q, f, d (最后2个需要支持浮点数)。
+
+### 构造函数
+
+#### **class array.array**(typecode[, iterable])  
+用给定类型的元素创建数组。数组的初始内容由 iterable 提供,如果没有提供,则创建一个空数组。
+
+```
+typecode:数组的类型
+iterable:数组初始内容
+```
+
+示例:
+
+```python
+>>> import array
+>>> a = array.array('i', [2, 4, 1, 5])
+>>> b = array.array('f')
+>>> print(a)
+array('i', [2, 4, 1, 5])
+>>> print(b)
+array('f')
+```
+
+### 方法
+
+#### **array.append**(val)  
+将一个新元素追加到数组的末尾。 
+
+示例:
+
+```python
+>>> a = array.array('f', [3, 6])
+>>> print(a)
+array('f', [3.0, 6.0])
+>>> a.append(7.0)
+>>> print(a)
+array('f', [3.0, 6.0, 7.0])
+```
+
+#### **array.extend**(iterable)  
+将一个新的数组追加到数组的末尾,注意追加的数组和原来数组的数据类型要保持一致。 
+
+示例:
+
+```python
+>>> a = array.array('i', [1, 2, 3])
+>>> b = array.array('i', [4, 5])
+>>> a.extend(b)
+>>> print(a)
+array('i', [1, 2, 3, 4, 5])
+```
+
+更多内容可参考  [array](http://docs.micropython.org/en/latest/pyboard/library/array.html) 。

+ 47 - 0
docs/std-librarys/ubinascii.md

@@ -0,0 +1,47 @@
+## **ubinascii** – 二进制/ ASCII转换
+
+`ubinascii` 模块包含许多在二进制和各种 ascii 编码的二进制表示之间转换的方法。
+
+### 函数
+
+#### **ubinascii.hexlify**(data[, sep])  
+将字符串转换为十六进制表示的字符串。 
+
+示例:
+
+```
+>>> ubinascii.hexlify('hello RT-Thread')
+b'68656c6c6f2052542d546872656164'
+>>> ubinascii.hexlify('summer')
+b'73756d6d6572'
+```
+如果指定了第二个参数sep,它将用于分隔两个十六进制数。 
+
+示例:
+
+```
+如果指定了第二个参数sep,它将用于分隔两个十六进制数。 
+示例:
+>>> ubinascii.hexlify('hello RT-Thread'," ")
+b'68 65 6c 6c 6f 20 52 54 2d 54 68 72 65 61 64'
+>>> ubinascii.hexlify('hello RT-Thread',",")
+b'68,65,6c,6c,6f,20,52,54,2d,54,68,72,65,61,64'
+```
+
+#### **ubinascii.unhexlify**(data)  
+转换十六进制字符串为二进制字符串,功能和 hexlify 相反。 
+
+示例:
+
+```
+>>> ubinascii.unhexlify('73756d6d6572')
+b'summer'
+```
+
+#### **ubinascii.a2b_base64**(data)  
+Base64编码的数据转换为二进制表示。返回字节串。
+
+#### **ubinascii.b2a_base64**(data)  
+编码base64格式的二进制数据。返回的字符串。
+
+更多内容可参考 [ubinascii](http://docs.micropython.org/en/latest/pyboard/library/ubinascii.html)  。

+ 44 - 0
docs/std-librarys/ucollections.md

@@ -0,0 +1,44 @@
+## **ucollections** – 集合与容器类型
+
+**ucollections** 模块实现了专门的容器数据类型,它提供了 Python 的通用内置容器的替代方案,包括了字典、列表、集合和元组。
+
+### 类
+
+#### **ucollections.namedtuple**(name, fields)  
+这是工厂函数创建一个新的 `namedtuple` 型与一个特定的字段名称和集合。`namedtuple` 是元组允许子类要访问它的字段不仅是数字索引,而且还具有属性使用符号字段名访问语法。 字段是字符串序列指定字段名称。为了兼容的实现也可以用空间分隔的字符串命名的字段(但效率较低) 。
+
+代码示例:
+```python
+from ucollections import namedtuple
+
+MyTuple = namedtuple("MyTuple", ("id", "name"))
+t1 = MyTuple(1, "foo")
+t2 = MyTuple(2, "bar")
+print(t1.name)
+assert t2.name == t2[1]
+ucollections.OrderedDict(...)
+```
+
+#### **ucollections.OrderedDict**(...)  
+字典类型的子类,会记住并保留键/值的追加顺序。当有序的字典被迭代输出时,键/值 会按照他们被添加的顺序返回 :
+
+```python
+from ucollections import OrderedDict
+
+# To make benefit of ordered keys, OrderedDict should be initialized
+# from sequence of (key, value) pairs.
+d = OrderedDict([("z", 1), ("a", 2)])
+# More items can be added as usual
+d["w"] = 5
+d["b"] = 3
+for k, v in d.items():
+    print(k, v)
+```
+输出:
+
+z 1
+a 2
+w 5
+b 3
+
+更多的内容可参考 [ucollections](http://docs.micropython.org/en/latest/pyboard/library/ucollections.html) 。

+ 82 - 0
docs/std-librarys/uctypes.md

@@ -0,0 +1,82 @@
+## **uctypes** – 以结构化的方式访问二进制数据
+
+uctypes 模块用来访问二进制数据结构,它提供 C 兼容的数据类型。
+
+### 常量
+- uctypes.LITTLE_ENDIAN — 小端压缩结构。
+- uctypes.BIG_ENDIAN — 大端压缩结构类型。
+- NATIVE —  mricopython 本地的存储类型
+
+
+### 构造函数
+
+#### class uctypes.struct(addr, descriptor, type)
+将内存中以 c 形式打包的结构体或联合体转换为字典,并返回该字典。
+```
+addr:开始转换的地址
+descriptor:转换描述符
+格式:"field_name":offset|uctypes.UINT32
+offset:偏移量,
+单位:字节、VOID、UINT8、INT8、UINT16、INT16、UINT32、INT32、UINT64、INT64、BFUINT8、BFINT8、BFUINT16、BFINT16、BFUINT32、BFINT32、BF_POS、BF_LEN、FLOAT32、FLOAT64、PTR、ARRAY
+type:c 结构体或联合体存储类型,默认为本地存储类型
+```
+
+示例:
+
+```python
+>>> a = b"0123"
+>>> s = uctypes.struct(uctypes.addressof(a), {"a": uctypes.UINT8 | 0, "b": uctypes.UINT16 | 1}, uctypes.LITTLE_ENDIAN)
+>>> print(s)
+<struct STRUCT 3ffc7360>
+>>> print(s.a)
+48
+>>> s.a = 49
+>>> print(a)
+b'1123'
+```
+
+### 方法
+
+#### **uctypes.sizeof**(struct)  
+按字节返回数据的大小。参数可以是类或者数据对象 (或集合)。 
+示例:
+```python
+>>> a = b"0123"
+>>>b = uctypes.struct(uctypes.addressof(a), {"a": uctypes.UINT8 | 0, "b": uctypes.UINT16 | 1}, uctypes.LITTLE_ENDIAN)
+>>> b.a
+48
+>>> print(uctypes.sizeof(b))
+3
+```
+
+#### **uctypes.addressof**(obj)  
+返回对象地址。参数需要是 bytes, bytearray 。 
+示例:
+
+```python
+>>> a = b"0123"
+>>> print(uctypes.addressof(a))
+1073504048
+```
+
+#### **uctypes.bytes_at**(addr, size)  
+捕捉从 addr 开始到 size 个地址偏移量结束的内存数据为 bytearray 对象并返回。 
+示例:
+
+```python
+>>> a = b"0123"
+>>>print( uctypes.bytes_at(uctypes.addressof(a), 4))
+b'0123'
+```
+
+#### **uctypes.bytearray_at**(addr, size)  
+捕捉给定大小和地址内存为 bytearray 对象。与 bytes_at() 函数不同的是,它可以被再次写入,可以访问给定地址的参数。 
+示例:
+
+```python
+>>> a = b"0123"
+>>> print(uctypes.bytearray_at(uctypes.addressof(a), 2))
+bytearray(b'01')
+```
+
+更多内容可参考 [uctypes](http://docs.micropython.org/en/latest/pyboard/library/uctypes.html) 。

+ 20 - 0
docs/std-librarys/uerrno.md

@@ -0,0 +1,20 @@
+## **uerrno** – 系统错误码模块
+
+`uerrno` 模块提供了标准的 errno 系统符号,每个符号都有对应的整数值。
+
+### 示例
+
+```python
+try:
+    uos.mkdir("my_dir")
+except OSError as exc:
+    if exc.args[0] == uerrno.EEXIST:
+        print("Directory already exists")
+uerrno.errorcode
+Dictionary mapping numeric error codes to strings with symbolic error code (see above):
+
+>>> print(uerrno.errorcode[uerrno.EEXIST])
+EEXIST
+```
+
+更多内容可参考 [uerrno](http://docs.micropython.org/en/latest/pyboard/library/uerrno.html) 。

+ 36 - 0
docs/std-librarys/uhashlib.md

@@ -0,0 +1,36 @@
+## **uhashlib** – 哈希算法
+
+`uhashlib` 模块实现了二进制数据哈希算法。
+
+### 算法功能
+
+#### **SHA256** 
+当代的散列算法(SHA2系列),它适用于密码安全的目的。被包含在 MicroPython 内核中,除非有特定的代码大小限制,否则推荐任何开发板都支持这个功能。
+
+#### **SHA1**
+上一代的算法,不推荐新的应用使用这种算法,但是 SHA1 算法是互联网标准和现有应用程序的一部分,所以针对网络连接便利的开发板会提供这种功能。
+
+#### **MD5** 
+一种遗留下来的算法,作为密码使用被认为是不安全的。只有特定的开发板,为了兼容老的应用才会提供这种算法。
+
+### 函数
+
+#### **class uhashlib.sha256**([data])  
+创建一个SHA256哈希对象并提供 data 赋值。
+
+#### **class uhashlib.sha1**([data])  
+创建一个SHA1哈希对象并提供 data 赋值。
+
+#### **class uhashlib.md5**([data])  
+创建一个MD5哈希对象并提供 data 赋值。
+
+#### **hash.update**(data)  
+将更多二进制数据放入哈希表中。
+
+#### **hash.digest**()  
+返回字节对象哈希的所有数据。调用此方法后,将无法将更多数据送入哈希。
+
+#### **hash.hexdigest**()  
+此方法没有实现, 使用 ubinascii.hexlify(hash.digest()) 达到类似效果。
+
+更多内容可参考 [uhashlib](http://docs.micropython.org/en/latest/pyboard/library/uhashlib.html)  。

+ 16 - 0
docs/std-librarys/uheapq.md

@@ -0,0 +1,16 @@
+## **uheapq** – 堆排序算法
+
+`uheapq` 模块提供了堆排序相关算法,堆队列是一个列表,它的元素以特定的方式存储。
+
+### 函数
+
+#### **uheapq.heappush**(heap, item)  
+将对象压入堆中。
+
+#### **uheapq.heappop**(heap)  
+从 heap 弹出第一个元素并返回。 如果是堆时空的会抛出 IndexError。
+
+#### **uheapq.heapify**(x)  
+将列表 x 转换成堆。
+
+更多内容可参考 [uheapq](http://docs.micropython.org/en/latest/pyboard/library/uheapq.html)  。

+ 27 - 0
docs/std-librarys/uio.md

@@ -0,0 +1,27 @@
+## **uio** – 输入/输出流
+
+**uio** 模块包含流类型 (类似文件) 对象和帮助函数。
+
+### 函数
+
+#### **uio.open**(name, mode='r', \*\*kwargs)
+
+打开一个文件,关联到内建函数``open()``。所有端口 (用于访问文件系统) 需要支持模式参数,但支持其他参数不同的端口。
+
+### 类
+
+#### **class uio.FileIO**(...)
+  这个文件类型用二进制方式打开文件,等于使用``open(name, “rb”)``。 不应直接使用这个实例。
+
+#### **class uio.TextIOWrapper**(...)  
+  这个类型以文本方式打开文件,等同于使用``open(name, “rt”)``不应直接使用这个实例。
+
+#### **class uio.StringIO**([string])  
+
+#### **class uio.BytesIO**([string])  
+  内存文件对象。`StringIO` 用于文本模式 I/O (用 “t” 打开文件),`BytesIO` 用于二进制方式 (用 “b” 方式)。文件对象的初始内容可以用字符串参数指定(`stringio`用普通字符串,`bytesio`用`bytes`对象)。所有的文件方法,如 `read(), write(), seek(), flush(), close()` 都可以用在这些对象上,包括下面方法:
+
+#### **getvalue**()  
+  获取缓存区内容。
+
+更多内容可参考  [uio](http://docs.micropython.org/en/latest/pyboard/library/uio.html) 。

+ 42 - 0
docs/std-librarys/ujson.md

@@ -0,0 +1,42 @@
+## **ujson** – JSON编码与解码
+
+`ujson` 模块提供 Python 对象到 JSON(JavaScript Object Notation) 数据格式的转换。
+
+### 函数
+
+#### **ujson.dumps**(obj)  
+
+将 dict 类型转换成 str。
+
+```
+obj:要转换的对象
+```
+
+示例:
+
+```
+>>> obj = {1:2, 3:4, "a":6}
+>>> print(type(obj), obj) #原来为dict类型
+<class 'dict'> {3: 4, 1: 2, 'a': 6}
+>>> jsObj = json.dumps(obj) #将dict类型转换成str
+>>> print(type(jsObj), jsObj)
+<class 'str'> {3: 4, 1: 2, "a": 6}
+```
+
+#### **ujson.loads**(str)  
+解析 JSON 字符串并返回对象。如果字符串格式错误将引发 ValueError 异常。 
+示例:
+
+```
+>>> obj = {1:2, 3:4, "a":6}
+>>> jsDumps = json.dumps(obj)
+>>> jsLoads = json.loads(jsDumps)
+>>> print(type(obj), obj)
+<class 'dict'> {3: 4, 1: 2, 'a': 6}
+>>> print(type(jsDumps), jsDumps)
+<class 'str'> {3: 4, 1: 2, "a": 6}
+>>> print(type(jsLoads), jsLoads)
+<class 'dict'> {'a': 6, 1: 2, 3: 4}
+```
+
+更多内容可参考 [ujson](http://docs.micropython.org/en/latest/pyboard/library/ujson.html)  。

+ 56 - 0
docs/std-librarys/uos.md

@@ -0,0 +1,56 @@
+## **uos** – 基本的操作系统服务
+
+`uos` 模块包含了对文件系统的访问操作,是对应 CPython 模块的一个子集。
+
+### 函数
+
+#### **uos.chdir**(path)  
+更改当前目录。
+
+#### **uos.getcwd**()  
+获取当前目录。
+
+#### **uos.listdir**([dir])
+没有参数就列出当前目录,否则列出给定目录。
+
+#### **uos.mkdir**(path)  
+创建一个目录。
+
+#### **uos.remove**(path)  
+删除文件。
+
+#### **uos.rmdir**(path)  
+删除目录。
+
+#### **uos.rename**(old_path, new_path)  
+重命名文件或者文件夹。
+
+#### **uos.stat**(path)  
+获取文件或目录的状态。
+
+#### **uos.sync**()  
+同步所有的文件系统。
+
+### 示例
+
+```
+>>> import uos
+>>> uos.                        # Tab 
+__name__        uname           chdir           getcwd
+listdir         mkdir           remove          rmdir
+stat            unlink          mount           umount
+>>> uos.mkdir("rtthread")
+>>> uos.getcwd()
+'/'
+>>> uos.chdir("rtthread")
+>>> uos.getcwd()
+'/rtthread'
+>>> uos.listdir()
+['web_root', 'rtthread', '11']
+>>> uos.rmdir("11")
+>>> uos.listdir()
+['web_root', 'rtthread']
+>>> 
+```
+
+更多内容可参考 [uos](http://docs.micropython.org/en/latest/pyboard/library/uos.html) 。

+ 174 - 0
docs/std-librarys/urandom.md

@@ -0,0 +1,174 @@
+## **urandom** - 随机数生成模块
+
+`urandom` 模块实现了伪随机数生成器。
+
+### 函数 
+
+#### **urandom.choice**(obj)  
+
+随机生成对象 obj 中的元数。
+
+```
+obj:元数列表
+```
+
+示例:
+
+```python
+>>> print(random.choice("DFRobot"))
+R
+>>> print(random.choice("DFRobot"))
+D
+>>> print(random.choice([0, 2, 4, 3]))
+3
+>>> print(random.choice([0, 2, 4, 3]))
+3
+>>> print(random.choice([0, 2, 4, 3]))
+2
+```
+
+#### **urandom.getrandbits**(size)  
+
+随机生成 0 到 size 个位二进制数范围内的正整数。 比如 :
+
+- size = 4,那么便是从 0 到0b1111中随机一个正整数。 
+- size = 8,那么便是从 0 到 0b11111111中随机一个正整数。
+
+```python
+size:位大小
+```
+
+示例:
+
+```python
+>>> print( random.getrandbits(1))  #1位二进制位,范围为0~1(十进制:0~1)
+1
+>>> print(random.getrandbits(1))
+0
+>>> print(random.getrandbits(8))  #8位二进制位,范围为0000 0000~1111 11111(十进制:0~255)
+224
+>>> print(random.getrandbits(8))
+155
+```
+
+#### **urandom.randint**(start, end)  
+
+随机生成一个 start 到 end 之间的整数。 
+
+```
+start:指定范围内的开始值,包含在范围内
+end:指定范围内的结束值,包含在范围内
+```
+
+示例:
+
+```python
+>>> import random
+>>> print(random.randint(1, 4))
+4
+>>> print(random.randint(1, 4))
+2
+```
+
+#### **urandom.random**()  
+随机生成一个 0 到 1 之间的浮点数。 
+示例:
+
+```python
+>>> print(random.random())
+0.7111824
+>>> print(random.random())
+0.3168149
+```
+
+#### **urandom.randrange**(start, end, step)  
+
+随机生成 start 到 end 并且递增为 step 的范围内的正整数。例如,randrange(0, 8, 2)中,随机生成的数为 0、2、4、6 中任一个。
+
+```
+start:指定范围内的开始值,包含在范围内
+end:指定范围内的结束值,包含在范围内
+step:递增基数
+```
+
+示例:
+
+```python
+>>> print(random.randrange(2, 8, 2))
+4
+>>> print(random.randrange(2, 8, 2))
+6
+>>> print(random.randrange(2, 8, 2))
+2
+```
+
+#### **urandom.seed**(sed)  
+
+指定随机数种子,通常和其他随机数生成函数搭配使用。 
+**注意:** 
+   MicroPython 中的随机数其实是一个稳定算法得出的稳定结果序列,而不是一个随机序列。sed 就是这个算法开始计算的第一个值。所以就会出现只要 sed 是一样的,那么后续所有“随机”结果和顺序也都完全一致。
+
+```
+sed:随机数种子
+```
+
+示例:
+
+```python
+import random
+
+for j in range(0, 2):
+  random.seed(13)  #指定随机数种子
+  for i in range(0, 10):  #生成0到10范围内的随机序列
+    print(random.randint(1, 10))
+  print("end")
+```
+
+运行结果:
+
+```
+5
+2
+3
+2
+3
+4
+2
+5
+8
+2
+end
+5
+2
+3
+2
+3
+4
+2
+5
+8
+2
+end
+```
+
+   从上面可以看到生成两个随机数列表是一样的,你也可以多生成几个随机数列表查看结果。
+
+#### **urandom.uniform**(start, end)  
+
+随机生成start到end之间的浮点数。
+
+```
+start:指定范围内的开始值,包含在范围内
+stop:指定范围内的结束值,包含在范围内
+```
+
+示例:
+
+```python
+>>> print(random.uniform(2, 4))
+2.021441
+>>> print(random.uniform(2, 4))
+3.998012
+```
+
+更多内容可参考 [urandom](https://docs.python.org/3/library/random.html?highlight=random#module-random) 。

+ 52 - 0
docs/std-librarys/ure.md

@@ -0,0 +1,52 @@
+## **ure** – 正则表达式
+
+`ure` 模块用于测试字符串的某个模式,执行正则表达式操作。
+
+### 匹配字符集
+
+
+#### 匹配任意字符
+  ``'.'``
+
+#### 匹配字符集合,支持单个字符和一个范围
+  ``'[]'``
+
+#### 支持多种匹配元字符
+  ``'^'``
+  ``'$'``
+  ``'?'``
+  ``'*'``
+  ``'+'``
+  ``'??'``
+  ``'*?'``
+  ``'+?'``
+  ``'{m,n}'``
+
+### 函数
+
+#### **ure.compile**(regex)  
+编译正则表达式,返回 regex 对象。
+
+#### **ure.match**(regex, string)  
+用 string 匹配 regex,匹配总是从字符串的开始匹配。
+
+#### **ure.search**(regex, string)  
+在 string 中搜索 regex。不同于匹配,它搜索第一个匹配位置的正则表达式字符串 (结果可能会是0)。
+
+#### **ure.DEBUG**  
+标志值,显示表达式的调试信息。
+
+### **正则表达式对象**:
+编译正则表达式,使用 `ure.compile()` 创建实例。
+
+#### **regex.match**(string)  
+#### **regex.search**(string)  
+#### **regex.split**(string, max_split=-1)  
+
+### **匹配对象** :
+匹配对象是 match() 和 search() 方法的返回值。
+
+#### **match.group**([index])  
+只支持数字组。
+
+更多内容可参考 [ure](http://docs.micropython.org/en/latest/pyboard/library/ure.html)  。

+ 102 - 0
docs/std-librarys/uselect.md

@@ -0,0 +1,102 @@
+## **uselect** – 等待流事件
+
+`uselect` 模块提供了等待数据流的事件功能。
+
+### 常数
+
+#### **select.POLLIN** - 读取可用数据  
+
+#### **select.POLLOUT** - 写入更多数据  
+
+#### **select.POLLERR** - 发生错误  
+
+#### **select.POLLHUP** - 流结束/连接终止检测  
+
+### 函数
+
+#### **select.select**(rlist, wlist, xlist[, timeout])  
+监控对象何时可读或可写,一旦监控的对象状态改变,返回结果(阻塞线程)。这个函数是为了兼容,效率不高,推荐用 `poll` 函数 。
+
+```
+rlist:等待读就绪的文件描述符数组
+wlist:等待写就绪的文件描述符数组
+xlist:等待异常的数组
+timeout:等待时间(单位:秒)
+```
+示例:
+
+```python
+def selectTest():
+  global s
+  rs, ws, es = select.select([s,], [], [])
+  #程序会在此等待直到对象s可读
+  print(rs)
+  for i in rs:
+    if i == s:
+      print("s can read now")
+      data,addr=s.recvfrom(1024)
+      print('received:',data,'from',addr)
+```
+
+### Poll 类
+
+#### **select.poll**()  
+创建 poll 实例。
+
+示例:
+
+```
+>>>poller = select.poll()
+>>>print(poller)
+<poll>
+```
+
+#### **poll.register**(obj[, eventmask])  
+注册一个用以监控的对象,并设置被监控对象的监控标志位 flag。 
+
+```
+obj:被监控的对象
+flag:被监控的标志
+    select.POLLIN — 可读
+    select.POLLHUP — 已挂断
+    select.POLLERR — 出错
+    select.POLLOUT — 可写
+```
+
+#### **poll.unregister**(obj)  
+解除监控的对象的注册。 
+
+```
+obj:注册过的对象
+```
+
+示例:
+
+```
+>>>READ_ONLY = select.POLLIN | select.POLLHUP | select.POLLERR
+>>>READ_WRITE = select.POLLOUT | READ_ONLY
+>>>poller.register(s, READ_WRITE)
+>>>poller.unregister(s)
+```
+
+#### **poll.modify**(obj, eventmask)  
+修改已注册的对象监控标志。 
+
+```
+obj:已注册的被监控对象
+flag:修改为的监控标志
+```
+
+示例:
+
+```
+>>>READ_ONLY = select.POLLIN | select.POLLHUP | select.POLLERR
+>>>READ_WRITE = select.POLLOUT | READ_ONLY
+>>>poller.register(s, READ_WRITE)
+>>>poller.modify(s, READ_ONLY)
+```
+
+#### **poll.poll**([timeout])  
+等待至少一个已注册的对象准备就绪。返回 (obj, event, ...) 元组, event 元素指定了一个流发生的事件,是上面所描述的 `select.POLL*`常量组合。 根据平台和版本的不同,在元组中可能有其他元素,所以不要假定元组的大小是 2 。如果超时,则返回空列表。
+
+更多内容可参考 [uselect](http://docs.micropython.org/en/latest/pyboard/library/uselect.html) 。

+ 195 - 0
docs/std-librarys/usocket.md

@@ -0,0 +1,195 @@
+## **usocket** – 套接字模块
+
+`usocket` 模块提供对BSD套接字接口的访问。 
+
+### 常数
+
+#### 地址簇
+- socket.AF_INET =2 — TCP/IP – IPv4
+- socket.AF_INET6 =10 — TCP/IP – IPv6
+
+#### 套接字类型
+- socket.SOCK_STREAM =1 — TCP流
+- socket.SOCK_DGRAM =2 — UDP数据报
+- socket.SOCK_RAW =3 — 原始套接字
+- socket.SO_REUSEADDR =4 — socket可重用
+
+#### IP协议号
+- socket.IPPROTO_TCP =16
+- socket.IPPROTO_UDP =17
+
+#### 套接字选项级别
+- socket.SOL_SOCKET =4095
+
+### 函数
+
+#### **socket.socket**
+
+`socket.socket(socket.AF_INET, socket.SOCK_STREAM, socket.IPPROTO_TCP)` 
+
+创建新的套接字,使用指定的地址、类型和协议号。
+
+#### **socket.getaddrinfo**(host, port) 
+将主机域名(host)和端口(port)转换为用于创建套接字的5元组序列。元组列表的结构如下:
+
+```
+(family, type, proto, canonname, sockaddr)
+```
+
+示例:
+
+```
+>>> info = socket.getaddrinfo("rt-thread.org", 10000)
+>>> print(info)
+[(2, 1, 0, '', ('118.31.15.152', 10000))]
+```
+
+#### **socket.close**()  
+关闭套接字。一旦关闭后,套接字所有的功能都将失效。远端将接收不到任何数据 (清理队列数据后)。 虽然在垃圾回收时套接字会自动关闭,但还是推荐在必要时用 close() 去关闭。
+
+#### **socket.bind**(address)  
+将套接字绑定到地址,套接字不能是已经绑定的。
+
+#### **socket.listen**([backlog])  
+监听套接字,使服务器能够接收连接。
+```
+backlog:接受套接字的最大个数,至少为0,如果没有指定,则默认一个合理值。
+```
+
+#### **socket.accept**()  
+接收连接请求。 
+**注意:** 
+   只能在绑定地址端口号和监听后调用,返回 conn 和 address。
+
+```
+conn:新的套接字对象,可以用来收发消息
+address:连接到服务器的客户端地址
+```
+
+#### **socket.connect**(address)  
+连接服务器。
+
+```
+address:服务器地址和端口号的元组或列表
+```
+
+#### **socket.send**(bytes)  
+发送数据,并返回成功发送的字节数,返回字节数可能比发送的数据长度少。
+
+```
+bytes:bytes类型数据
+```
+
+#### **socket.recv**(bufsize)  
+接收数据,返回接收到的数据对象。
+
+```
+bufsize:指定一次接收的最大数据量
+```
+
+示例:
+
+```
+data = conn.recv(1024)
+```
+
+#### **socket.sendto**(bytes, address)  
+发送数据,目标由address决定,常用于UDP通信,返回发送的数据大小。
+
+```
+bytes:bytes类型数据
+address:目标地址和端口号的元组
+```
+
+示例:
+
+```
+data = sendto("hello RT-Thread", ("192.168.10.110", 100))
+```
+
+#### **socket.recvfrom**(bufsize)  
+接收数据,常用于UDP通信,并返回接收到的数据对象和对象的地址。
+
+```
+bufsize:指定一次接收的最大数据量
+```
+
+示例:
+
+```
+data,addr=fd.recvfrom(1024)
+```
+
+#### **socket.setsockopt**(level, optname, value)  
+根据选项值设置套接字。
+
+```
+level:套接字选项级别
+optname:套接字的选项
+value:可以是一个整数,也可以是一个表示缓冲区的bytes类对象。
+```
+
+示例:
+
+```
+s.setsockopt(socket.SOL_SOCKET, socket.SO_REUSEADDR, 1)
+```
+
+#### **socket.settimeout**(value)  
+设置超时时间,单位:秒。 
+示例:
+
+```
+s.settimeout(2)
+```
+
+#### **socket.setblocking**(flag)  
+设置阻塞或非阻塞模式: 如果 flag 是 false,设置非阻塞模式。
+
+#### **socket.read**([size])  
+Read up to size bytes from the socket. Return a bytes object. If size is not given, it reads all data available from the socket until EOF; as such the method will not return until the socket is closed. This function tries to read as much data as requested (no “short reads”). This may be not possible with non-blocking socket though, and then less data will be returned.
+
+#### **socket.readinto**(buf[, nbytes])  
+Read bytes into the buf. If nbytes is specified then read at most that many bytes. Otherwise, read at most len(buf) bytes. Just as read(), this method follows “no short reads” policy.
+Return value: number of bytes read and stored into buf.
+
+#### **socket.readline**()  
+接收一行数据,遇换行符结束,并返回接收数据的对象 。 
+
+#### **socket.write**(buf)  
+将字节类型数据写入套接字,并返回写入成功的数据大小。 
+
+### 示例
+
+#### TCP Server example
+
+```
+>>> import usocket 
+>>> s = usocket.socket(usocket.AF_INET,usocket.SOCK_STREAM)  # Create STREAM TCP socket
+>>> s.bind(('192.168.12.32', 6001))   
+>>> s.listen(5)
+>>> s.setblocking(True)
+>>> sock,addr=s.accept()              
+>>> sock.recv(10)                    
+b'rt-thread\r'
+>>> s.close()
+```
+
+#### TCP Client example
+
+```
+>>> import usocket 
+>>> s = usocket.socket(usocket.AF_INET,usocket.SOCK_STREAM)
+>>> s.connect(("192.168.10.110",6000))  
+>>> s.send("micropython")               
+11
+>>> s.close()
+```
+
+`connect to a web site example`:
+```
+s = socket.socket()
+s.connect(socket.getaddrinfo('www.micropython.org', 80)[0][-1])
+```
+
+更多的内容可参考 [usocket](http://docs.micropython.org/en/latest/pyboard/library/usocket.html) 。

+ 28 - 0
docs/std-librarys/ussl.md

@@ -0,0 +1,28 @@
+# ussl – SSL/TLS module
+
+This module implements a subset of the corresponding* [`CPython`](http://docs.micropython.org/en/latest/reference/glossary.html#term-cpython) *module, as described below. For more information, refer to the original CPython documentation: [`ssl`](https://docs.python.org/3.5/library/ssl.html#module-ssl).
+
+This module provides access to Transport Layer Security (previously and widely known as “Secure Sockets Layer”) encryption and peer authentication facilities for network sockets, both client-side and server-side.
+
+## Functions
+
+- `ussl.``wrap_socket`(sock, server_side=False, keyfile=None, certfile=None, cert_reqs=CERT_NONE, ca_certs=None)
+
+  Takes a [`stream`](http://docs.micropython.org/en/latest/reference/glossary.html#term-stream) *sock* (usually usocket.socket instance of `SOCK_STREAM` type), and returns an instance of ssl.SSLSocket, which wraps the underlying stream in an SSL context. Returned object has the usual [`stream`](http://docs.micropython.org/en/latest/reference/glossary.html#term-stream) interface methods like `read()`, `write()`, etc. In MicroPython, the returned object does not expose socket interface and methods like `recv()`, `send()`. In particular, a server-side SSL socket should be created from a normal socket returned from[`accept()`](http://docs.micropython.org/en/latest/library/usocket.html#usocket.socket.accept) on a non-SSL listening server socket.Depending on the underlying module implementation in a particular [`MicroPython port`](http://docs.micropython.org/en/latest/reference/glossary.html#term-micropython-port), some or all keyword arguments above may be not supported.
+
+Warning: Some implementations of `ussl` module do NOT validate server certificates, which makes an SSL connection established prone to man-in-the-middle attacks.
+
+## 异常类型
+
+- `ssl.SSLError`
+
+  This exception does NOT exist. Instead its base class, OSError, is used.
+
+## 常量
+
+- `ussl.CERT_NONE`
+
+- `ussl.CERT_OPTIONAL`
+
+- `ussl.CERT_REQUIRED`
+- Supported values for **cert_reqs** parameter.

+ 82 - 0
docs/std-librarys/ustruct.md

@@ -0,0 +1,82 @@
+## **ustruct** – 打包和解包原始数据类型
+
+**ustruct** 模块在 Python 值和以 Python 字节对象表示的 C 结构之间执行转换。
+
+- 支持 size/byte 的前缀: @, <, >, !.
+- 支持的格式代码: b, B, h, H, i, I, l, L, q, Q, s, P, f, d (最后2个需要支持浮点数).
+
+### 函数
+
+#### **ustruct.calcsize**(fmt)  
+返回存放某一类型数据 fmt 需要的字节数。
+
+```
+fmt:数据类型
+    b — 字节型
+    B — 无符号字节型
+    h — 短整型
+    H — 无符号短整型
+    i — 整型
+    I — 无符号整型
+    l — 整型
+    L — 无符号整型
+    q — 长整型
+    Q — 无符号长整型
+    f — 浮点型
+    d — 双精度浮点型
+    P — 无符号型
+```
+
+示例:
+
+```python
+>>> print(struct.calcsize("i"))
+4
+>>> print(struct.calcsize("B"))
+1
+```
+
+#### **ustruct.pack**(fmt, v1, v2, ...)  
+按照格式字符串 fmt 打包参数 v1, v2, ... 。返回值是参数打包后的字节对象。
+
+```
+fmt:同上
+```
+
+示例:
+
+```python
+>>> struct.pack("ii", 3, 2)
+b'\x03\x00\x00\x00\x02\x00\x00\x00'
+```
+
+#### **ustruct.unpack**(fmt, data)  
+从 fmt 中解包数据。返回值是解包后参数的元组。
+
+```
+data:要解压的字节对象
+```
+
+示例:
+
+```python
+>>> buf = struct.pack("bb", 1, 2)
+>>> print(buf)
+b'\x01\x02'
+>>> print(struct.unpack("bb", buf))
+(1, 2)
+```
+
+#### **ustruct.pack_into**(fmt, buffer, offset, v1, v2, ...)  
+按照格式字符串 fmt 压缩参数 v1, v2, ... 到缓冲区 buffer,开始位置是 offset。当offset 为负数时,从缓冲区末尾开始计数。 
+
+#### **ustruct.unpack_from**(fmt, data, offset=0)  
+以 fmt 作为规则从 data 的 offset 位置开始解包数据,如果 offset 是负数就是从缓冲区末尾开始计算。返回值是解包后的参数元组。
+```python
+>>> buf = struct.pack("bb", 1, 2)
+>>> print(struct.unpack("bb", buf))
+(1, 2)
+>>> print(struct.unpack_from("b", buf, 1))
+(2,)
+```
+更多的内容可参考  [ustruct](http://docs.micropython.org/en/latest/pyboard/library/ustruct.html) 。

+ 107 - 0
docs/std-librarys/utime.md

@@ -0,0 +1,107 @@
+## **utime** – 时间相关函数
+
+**utime** 模块提供获取当前时间和日期、测量时间间隔和延迟的功能。
+
+**初始时刻**: `Unix` 使用 `POSIX` 系统标准,从 1970-01-01 00:00:00 `UTC` 开始。
+嵌入式程序从 2000-01-01 00:00:00 `UTC` 开始。
+
+**保持实际日历日期/时间**:需要一个实时时钟 `(RTC)`。在底层系统 (包括一些 `RTOS` 中),`RTC` 已经包含在其中。设置时间是通过 `OS/RTOS` 而不是 MicroPython 完成,查询日期/时间也需要通过系统 `API`。对于裸板系统时钟依赖于 ``machine.RTC()`` 对象。设置时间通过 ``machine.RTC().datetime(tuple)`` 函数,并通过下面方式维持:
+
+* 后备电池 (可能是选件、扩展板等)。
+* 使用网络时间协议 (需要用户设置)。
+* 每次上电时手工设置 (大部分只是在硬复位时需要设置,少部分每次复位都需要设置)。
+
+如果实际时间不是通过系统 / MicroPython RTC 维持,那么下面函数结果可能不是和预期的相同。
+
+### 函数
+
+#### **utime.localtime**([secs])  
+   从初始时间的秒转换为元组: (年, 月, 日, 时, 分, 秒, 星期, ``yearday``) 。如果 ``secs`` 是空或者 ``None``,那么使用当前时间。  
+
+- `year ` 年份包括世纪(例如2014)。 
+- `month`  范围 1-12     
+- `day`    范围 1-31  
+- `hour`    范围 0-23  
+- `minute` 范围 0-59  
+- `second`  范围 0-59  
+- `weekday` 范围 0-6 对应周一到周日  
+- `yearday` 范围 1-366  
+
+#### **utime.mktime**()  
+   时间的反函数,它的参数是完整8参数的元组,返回值一个整数自2000年1月1日以来的秒数。
+
+#### **utime.sleep**(seconds)  
+  休眠指定的时间(秒),``Seconds`` 可以是浮点数。注意有些版本的 MicroPython不支持浮点数,为了兼容可以使用 ``sleep_ms()`` 和 ``sleep_us()``函数。
+
+#### **utime.sleep_ms**(ms)  
+  延时指定毫秒,参数不能小于0。
+
+#### **utime.sleep_us**(us)  
+  延时指定微秒,参数不能小于0。
+
+#### **utime.ticks_ms**()  
+  返回不断递增的毫秒计数器,在某些值后会重新计数(未指定)。计数值本身无特定意义,只适合用在``ticks_diff()``。  
+  注: 直接在这些值上执行标准数学运算(+,-)或关系运算符(<,>,>,> =)会导致无效结果。执行数学运算然后传递结果作为参数给`ticks_diff()` 或 ` ticks_add() ` 也将导致函数产生无效结果。
+
+#### **utime.ticks_us**()  
+  和上面 `ticks_ms()` 类似,只是返回微秒。
+
+#### **utime.ticks_cpu**()  
+  与 ``ticks_ms()`` 和 ``ticks_us()`` 类似,具有更高精度 (使用 CPU 时钟),并非每个端口都实现此功能。
+
+#### **utime.ticks_add**(ticks, delta)
+  给定一个数字作为节拍的偏移值 `delta`,这个数字的值是正数或者负数都可以。
+  给定一个 `ticks` 节拍值,本函数允许根据节拍值的模算数定义来计算给定节拍值之前或者之后 `delta` 个节拍的节拍值 。
+  `ticks` 参数必须是 `ticks_ms()`, `ticks_us()`, or `ticks_cpu()` 函数的直接返回值。然而,`delta` 可以是一个任意整数或者是数字表达式。`ticks_add` 函数对计算事件/任务的截至时间很有用。(注意:必须使用 `ticksdiff()` 函数来处理
+最后期限)。
+
+代码示例:
+```python
+## 查找 100ms 之前的节拍值
+print(utime.ticks_add(utime.ticks_ms(), -100))
+
+## 计算操作的截止时间然后进行测试
+deadline = utime.ticks_add(utime.ticks_ms(), 200)
+while utime.ticks_diff(deadline, utime.ticks_ms()) > 0:
+    do_a_little_of_something()
+
+## 找出本次移植节拍值的最大值
+print(utime.ticks_add(0, -1))
+```
+
+#### **utime.ticks_diff**(ticks1, ticks2)
+   计算两次调用 `ticksms()`, `ticks_us()`, 或 `ticks_cpu()`之间的时间。因为这些函数的计数值可能会回绕,所以不能直接相减,需要使用 `ticks_diff()` 函数。“旧” 时间需要在 “新” 时间之前,否则结果无法确定。这个函数不要用在计算很长的时间 (因为 `ticks*()` 函数会回绕,通常周期不是很长)。通常用法是在带超时的轮询事件中调用:
+
+代码示例:
+```python
+## 等待 GPIO 引脚有效,但是最多等待500微秒
+start = time.ticks_us()
+while pin.value() == 0:
+    if time.ticks_diff(time.ticks_us(), start) > 500:
+        raise TimeoutError
+```
+
+#### **utime.time**()
+  返回从开始时间的秒数(整数),假设 `RTC` 已经按照前面方法设置好。如果 `RTC` 没有设置,函数将返回参考点开始计算的秒数 (对于 `RTC` 没有后备电池的板子,上电或复位后的情况)。如果你开发便携版的 MicroPython 应用程序,你不要依赖函数来提供超过秒级的精度。如果需要高精度,使用 `ticks_ms()` 和 `ticks_us()` 函数。如果需要日历时间,使用不带参数的 `localtime()` 是更好选择。
+
+!!! tip "与 CPython 的区别"
+    在 `CPython` 中,这个函数用浮点数返回从 `Unix` 开始时间(1970-01-01 00:00 `UTC`)的秒数,通常是毫秒级的精度。在 MicroPython 中,只有 `Unix` 版才使用相同开始时间,如果允许浮点精度,将返回亚秒精度。嵌入式硬件通常没有用浮点数表示长时间访问和亚秒精度,所以返回值是整数。一些嵌入式系统硬件不支持 `RTC` 电池供电方式,所以返回的秒数是从最后上电、或相对某个时间、以及特定硬件时间 (如复位)。
+
+###   示例 
+
+```
+>>> import utime
+>>> utime.sleep(1)           # sleep for 1 second
+>>> utime.sleep_ms(500)      # sleep for 500 milliseconds
+>>> utime.sleep_us(10)       # sleep for 10 microseconds
+>>> start = utime.ticks_ms() # get value of millisecond counter
+>>> delta = utime.ticks_diff(utime.ticks_ms(), start) # compute time difference
+>>> delta
+6928
+>>> print(utime.ticks_add(utime.ticks_ms(), -100))
+1140718
+>>> print(utime.ticks_add(0, -1))
+1073741823
+```
+
+更多内容可参考 [`utime`](http://docs.micropython.org/en/latest/pyboard/library/utime.html#module-utime)  。

+ 10 - 0
docs/std-librarys/uzlib.md

@@ -0,0 +1,10 @@
+## **uzlib** – zlib 解压缩
+
+`uzlib` 模块实现了使用 DEFLATE 算法解压缩二进制数据 (常用的 zlib 库和 gzip 文档)。目前不支持压缩。
+
+### 函数
+
+#### **uzlib.decompress**(data)  
+返回解压后的 bytes 数据。
+
+更多内容可参考 [uzlib](http://docs.micropython.org/en/latest/pyboard/library/uzlib.html) 。