Skip to content

Commit 9e216d2

Browse files
authored
Merge pull request #92 from SummerGGift/update_doc
【完善】micropython 文档
2 parents 928fde9 + cde4be4 commit 9e216d2

File tree

5 files changed

+18
-13
lines changed

5 files changed

+18
-13
lines changed

docs/03-Basic_Module/05-uio.md

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -4,12 +4,13 @@
44

55
### 函数
66

7-
#### **uio.open**(name, mode='r', **kwargs)
8-
打开一个文件,关联到内建函数``open()``。所有端口 (用于访问文件系统) 需要支持模式参数,但支持其他参数不同的端口。
7+
#### **uio.open**(name, mode='r', \*\*kwargs)
8+
9+
打开一个文件,关联到内建函数``open()``。所有端口 (用于访问文件系统) 需要支持模式参数,但支持其他参数不同的端口。
910

1011
###
1112

12-
#### **class uio.FileIO**(...)
13+
#### **class uio.FileIO**(...)
1314
这个文件类型用二进制方式打开文件,等于使用``open(name, “rb”)``。 不应直接使用这个实例。
1415

1516
#### **class uio.TextIOWrapper**(...)

docs/04-Hardware_Control_Module/02-machine-Pin.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,8 @@
2727

2828
### 方法
2929

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

3334
#### **Pin.value**([x])

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

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -64,20 +64,20 @@
6464

6565
一些 `I2C` 设备充当一个内存设备,可以读取和写入。在这种情况下,有两个与 `I2C` 相关的地址,从机地址和内存地址。下面的方法是与这些设备进行通信的便利函数。
6666

67-
#### **I2C.readfrom_mem**(addr, memaddr, nbytes, *, addrsize=8)
67+
#### **I2C.readfrom_mem**(addr, memaddr, nbytes, \*, addrsize=8)
6868
`addr` 指定的从设备中 `memaddr` 地址开始读取 n 个字节。`addrsize` 参数指定地址的长度。返回一个存储读取数据的字节对象。
6969

70-
#### **I2C.readfrom_mem_into**(addr, memaddr, buf, *, addrsize=8)
70+
#### **I2C.readfrom_mem_into**(addr, memaddr, buf, \*, addrsize=8)
7171
`addr` 指定的从设备中 `memaddr` 地址读取数据到 `buf` 中,,读取的字节数是 `buf` 的长度。
7272
这个方法没有返回值。
7373

74-
#### **I2C.writeto_mem**(addr, memaddr, buf, *, addrsize=8)
74+
#### **I2C.writeto_mem**(addr, memaddr, buf, \*, addrsize=8)
7575
`buf` 里的数据写入 `addr` 指定的从机的 `memaddr` 地址中。
7676
这个方法没有返回值。
7777

7878
### 示例
7979

80-
#### `软件模拟 I2C `
80+
#### 软件模拟 I2C
8181
```python
8282
>>> from machine import Pin, I2C
8383
>>> 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
9595
# starting at address 2 in the slave
9696
```
9797

98-
#### `硬件 I2C `
98+
#### 硬件 I2C
9999

100100
需要先开启 `I2C` 设备驱动,查找设备可以在 `msh` 中输入`list_device` 命令。
101101
在构造函数的第一个参数传入 `0`,系统就会搜索名为 `i2c0` 的设备,找到之后使用这个设备来构建 `I2C` 对象:

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

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@
2020

2121
### 方法
2222

23-
#### **SPI.init**(baudrate=1000000, *, polarity=0, phase=0, bits=8, firstbit=SPI.MSB, sck=None, mosi=None, miso=None)
23+
#### **SPI.init**(baudrate=1000000, \*, polarity=0, phase=0, bits=8, firstbit=SPI.MSB, sck=None, mosi=None, miso=None)
2424

2525
用给定的参数初始化`SPI`总线:
2626

@@ -62,7 +62,7 @@
6262

6363
### 示例
6464

65-
#### `软件模拟 SPI `
65+
#### 软件模拟 SPI
6666
```
6767
>>> from machine import Pin, SPI
6868
>>> clk = Pin(("clk", 26), Pin.OUT_PP)
@@ -76,7 +76,7 @@ SoftSPI(baudrate=500000, polarity=0, phase=0, sck=clk, mosi=mosi, miso=miso)
7676
b'\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00'
7777
```
7878

79-
#### `硬件 SPI `
79+
#### 硬件 SPI
8080

8181
需要先开启 `SPI` 设备驱动,查找设备可以在 `msh` 中输入`list_device` 命令。
8282
在构造函数的第一个参数传入 `50`,系统就会搜索名为 `spi50` 的设备,找到之后使用这个设备来构建 `SPI` 对象:

docs/07-Network_Module/01-usocket.md

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,10 @@
2323

2424
### 函数
2525

26-
#### **socket.socket**(socket.AF_INET, socket.SOCK_STREAM, socket.IPPROTO_TCP)
26+
#### **socket.socket**
27+
28+
`socket.socket(socket.AF_INET, socket.SOCK_STREAM, socket.IPPROTO_TCP)`
29+
2730
创建新的套接字,使用指定的地址、类型和协议号。
2831

2932
#### **socket.getaddrinfo**(host, port)

0 commit comments

Comments
 (0)