瀏覽代碼

【完善】micropython 文档

SummerGift 6 年之前
父節點
當前提交
cde4be493e

+ 4 - 3
docs/03-Basic_Module/05-uio.md

@@ -4,12 +4,13 @@
 
 ### 函数
 
-#### **uio.open**(name, mode='r', **kwargs)  
-  打开一个文件,关联到内建函数``open()``。所有端口 (用于访问文件系统) 需要支持模式参数,但支持其他参数不同的端口。
+#### **uio.open**(name, mode='r', \*\*kwargs)
+
+打开一个文件,关联到内建函数``open()``。所有端口 (用于访问文件系统) 需要支持模式参数,但支持其他参数不同的端口。
 
 ### 类
 
-#### **class uio.FileIO**(...)  
+#### **class uio.FileIO**(...)
   这个文件类型用二进制方式打开文件,等于使用``open(name, “rb”)``。 不应直接使用这个实例。
 
 #### **class uio.TextIOWrapper**(...)  

+ 2 - 1
docs/04-Hardware_Control_Module/02-machine-Pin.md

@@ -27,7 +27,8 @@
 
 ### 方法
 
-#### **Pin.init**(mode= -1, pull= -1, *, value, drive, alt)
+#### **Pin.init**(mode= -1, pull= -1, \*, value, drive, alt)
+
 根据输入的参数重新初始化引脚。只有那些被指定的参数才会被设置,其余引脚的状态将保持不变,详细的参数可以参考上面的构造函数。
 
 #### **Pin.value**([x])

+ 5 - 5
docs/04-Hardware_Control_Module/03-machine-I2C.md

@@ -64,20 +64,20 @@
 
 一些 `I2C` 设备充当一个内存设备,可以读取和写入。在这种情况下,有两个与 `I2C` 相关的地址,从机地址和内存地址。下面的方法是与这些设备进行通信的便利函数。
 
-#### **I2C.readfrom_mem**(addr, memaddr, nbytes, *, addrsize=8)
+#### **I2C.readfrom_mem**(addr, memaddr, nbytes, \*, addrsize=8)
 从 `addr` 指定的从设备中 `memaddr` 地址开始读取 n 个字节。`addrsize` 参数指定地址的长度。返回一个存储读取数据的字节对象。
 
-#### **I2C.readfrom_mem_into**(addr, memaddr, buf, *, addrsize=8)
+#### **I2C.readfrom_mem_into**(addr, memaddr, buf, \*, addrsize=8)
 从 `addr` 指定的从设备中 `memaddr` 地址读取数据到 `buf` 中,,读取的字节数是 `buf` 的长度。  
 这个方法没有返回值。
 
-#### **I2C.writeto_mem**(addr, memaddr, buf, *, addrsize=8)
+#### **I2C.writeto_mem**(addr, memaddr, buf, \*, addrsize=8)
 将 `buf` 里的数据写入 `addr` 指定的从机的 `memaddr` 地址中。 
 这个方法没有返回值。
 
 ### 示例
 
-#### `软件模拟 I2C `
+#### 软件模拟 I2C
 ```python
 >>> from machine import Pin, I2C
 >>> clk = Pin(("clk", 29), Pin.OUT_OD)   # Select the 29 pin device as the clock
@@ -95,7 +95,7 @@ b'\x12'                               # starting at memory-address 8 in the slav
                                       # starting at address 2 in the slave
 ```
 
-#### `硬件 I2C `
+#### 硬件 I2C
 
 需要先开启 `I2C` 设备驱动,查找设备可以在 `msh` 中输入`list_device` 命令。  
 在构造函数的第一个参数传入 `0`,系统就会搜索名为 `i2c0` 的设备,找到之后使用这个设备来构建 `I2C` 对象:

+ 3 - 3
docs/04-Hardware_Control_Module/04-machine-SPI.md

@@ -20,7 +20,7 @@
 
 ### 方法
 
-#### **SPI.init**(baudrate=1000000, *, polarity=0, phase=0, bits=8, firstbit=SPI.MSB, sck=None, mosi=None, miso=None)
+#### **SPI.init**(baudrate=1000000, \*, polarity=0, phase=0, bits=8, firstbit=SPI.MSB, sck=None, mosi=None, miso=None)
 
 用给定的参数初始化`SPI`总线:
 
@@ -62,7 +62,7 @@
 
 ### 示例
 
-#### `软件模拟 SPI `
+#### 软件模拟 SPI
 ```
 >>> from machine import Pin, SPI
 >>> clk = Pin(("clk", 26), Pin.OUT_PP)
@@ -76,7 +76,7 @@ SoftSPI(baudrate=500000, polarity=0, phase=0, sck=clk, mosi=mosi, miso=miso)
 b'\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00'
 ```
 
-#### `硬件 SPI `
+#### 硬件 SPI
 
 需要先开启 `SPI` 设备驱动,查找设备可以在 `msh` 中输入`list_device` 命令。  
 在构造函数的第一个参数传入 `50`,系统就会搜索名为 `spi50` 的设备,找到之后使用这个设备来构建 `SPI` 对象:

+ 4 - 1
docs/07-Network_Module/01-usocket.md

@@ -23,7 +23,10 @@
 
 ### 函数
 
-#### **socket.socket**(socket.AF_INET, socket.SOCK_STREAM, socket.IPPROTO_TCP)  
+#### **socket.socket**
+
+`socket.socket(socket.AF_INET, socket.SOCK_STREAM, socket.IPPROTO_TCP)` 
+
 创建新的套接字,使用指定的地址、类型和协议号。
 
 #### **socket.getaddrinfo**(host, port)