From f3e1eff643cb0a04784a075573bc7eeceaa7d417 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Jimmy=20Luo=28=E7=BD=97=E6=9D=A8=E6=9D=A8=29?= Date: Tue, 11 Apr 2023 22:49:18 +0800 Subject: [PATCH] =?UTF-8?q?docs=20(misc/=E4=BA=8C=E7=BB=B4=E7=A0=81):=20?= =?UTF-8?q?=E6=A0=B9=E6=8D=AEst=E4=BF=AE=E6=94=B9=E5=BB=BA=E8=AE=AE?= =?UTF-8?q?=E4=BF=AE=E6=94=B9=E6=8F=8F=E8=BF=B0=E3=80=81=E6=A0=BC=E5=BC=8F?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit 1.修改PWM、ADC的管脚描述为表格形式。 2.删除模块开头的 “模块功能：”，删除注意框中的“注意：”描述。 3.添加PWM ADC PowerKey USB 到二级目录。 固件版本: N/A 是否需要文案翻译: 是 --- .../misc.ADC.md" | 13 ++++++++++++- .../misc.PWM.md" | 11 ++++++++++- .../misc.Power.md" | 4 ++-- .../misc.PowerKey.md" | 2 +- .../misc.USB.md" | 2 +- .../misc.USBNET.md" | 8 ++++---- .../zh/QuecPython\347\261\273\345\272\223/misc.md" | 2 +- .../QuecPython\347\261\273\345\272\223/qrcode.md" | 14 +++++++------- docs/API_reference/zh/sidebar.yaml | 12 ++++++++++-- 9 files changed, 48 insertions(+), 20 deletions(-) diff --git "a/docs/API_reference/zh/QuecPython\347\261\273\345\272\223/misc.ADC.md" "b/docs/API_reference/zh/QuecPython\347\261\273\345\272\223/misc.ADC.md" index 5ddc0148..d0ae12cd 100644 --- "a/docs/API_reference/zh/QuecPython\347\261\273\345\272\223/misc.ADC.md" +++ "b/docs/API_reference/zh/QuecPython\347\261\273\345\272\223/misc.ADC.md" @@ -58,7 +58,18 @@ ADC.read(ADCn) **ADC通道与物理引脚的映射关系：** -EC100Y系列对应引脚如下
ADC0 – 引脚号39
ADC1 – 引脚号81
EC600S/EC600N系列对应引脚如下
ADC0 – 引脚号19
EC600M系列对应引脚如下
ADC0 – 引脚号19
ADC1 – 引脚号20
EC800N系列对应引脚如下
ADC0 – 引脚号9
EC600U系列对应引脚如下
ADC0 – 引脚号19
ADC1 – 引脚号20
ADC2 – 引脚号113
ADC3 – 引脚号114
EC200U系列对应引脚如下
ADC0 – 引脚号45
ADC1 – 引脚号44
ADC2 – 引脚号43
EC200A系列对应引脚如下
ADC0 – 引脚号45
ADC1 – 引脚号44
BG95系列对应引脚如下
ADC0 – 引脚号24
EG915U系列对应引脚如下
ADC0 – 引脚号24
ADC1 – 引脚号2
EC800M系列对应引脚如下
ADC0 – 引脚号9
ADC1 – 引脚号96
EG912N系列对应引脚如下
ADC0 – 引脚号24
ADC1 – 引脚号2 +| 系列 | 引脚对应 | +| ------ | ------------------------------------------------------------ | +| EC600N | ADC0 – 引脚号19 | +| EC600M | ADC0 – 引脚号19
ADC1 – 引脚号20 | +| EC800N | ADC0 – 引脚号9 | +| EC600U | ADC0 – 引脚号19
ADC1 – 引脚号20
ADC2 – 引脚号113
ADC3 – 引脚号114 | +| EC200U | ADC0 – 引脚号45
ADC1 – 引脚号44
ADC2 – 引脚号43 | +| EC200A | ADC0 – 引脚号45
ADC1 – 引脚号44 | +| BG95 | ADC0 – 引脚号24 | +| EG915U | ADC0 – 引脚号24
ADC1 – 引脚号2 | +| EC800M | ADC0 – 引脚号9
ADC1 – 引脚号96 | +| EG912N | ADC0 – 引脚号24
ADC1 – 引脚号2 | ### ADC.close diff --git "a/docs/API_reference/zh/QuecPython\347\261\273\345\272\223/misc.PWM.md" "b/docs/API_reference/zh/QuecPython\347\261\273\345\272\223/misc.PWM.md" index be6d95fb..d6d7f601 100644 --- "a/docs/API_reference/zh/QuecPython\347\261\273\345\272\223/misc.PWM.md" +++ "b/docs/API_reference/zh/QuecPython\347\261\273\345\272\223/misc.PWM.md" @@ -37,7 +37,16 @@ class misc.PWM(PWM.PWMn,PWM.ABOVE_xx, highTime, cycleTime) **PWM通道与物理引脚的映射关系：** -EC100Y系列，支持PWM0-PWM3，对应引脚如下：
PWM0 – 引脚号19
PWM1 – 引脚号18
PWM2 – 引脚号23
PWM3 – 引脚号22
EC600SCN/EC600N系列，支持PWM0-PWM3，对应引脚如下：
PWM0 – 引脚号52
PWM1 – 引脚号53
PWM2 – 引脚号70
PWM3 – 引脚号69
EC800N系列，支持PWM0-PWM3，对应引脚如下：
PWM0 – 引脚号79
PWM1 – 引脚号78
PWM2 – 引脚号16
PWM3 – 引脚号49
EC200U系列，支持PWM0，对应引脚如下：
PWM0 – 引脚号135
EC600U系列，支持PWM0，对应引脚如下：
PWM0 – 引脚号70
EC600M系列，支持PWM0-PWM3，对应引脚如下：
PWM0 – 引脚号57
PWM1 – 引脚号56
PWM2 – 引脚号70
PWM3 – 引脚号69
EG915U系列，支持PWM0，对应引脚如下：
PWM0 – 引脚号20
EC800M系列，支持PWM0-PWM3，对应引脚如下：
PWM0 – 引脚号83
PWM1 – 引脚号78
PWM2 – 引脚号16
PWM3 – 引脚号49
EG912N系列，支持PWM0-PWM3，对应引脚如下：
PWM0 – 引脚号21
PWM1 – 引脚号116
PWM2 – 引脚号107
PWM3 – 引脚号92 +| 系列 | 对应引脚 | +| ------ | ------------------------------------------------------------ | +| EC600N | PWM0 – 引脚号52
PWM1 – 引脚号53
PWM2 – 引脚号70
PWM3 – 引脚号69 | +| EC800N | PWM0 – 引脚号79
PWM1 – 引脚号78
PWM2 – 引脚号16
PWM3 – 引脚号49 | +| EC200U | PWM0 – 引脚号135 | +| EC600U | PWM0 – 引脚号70 | +| EC600M | PWM0 – 引脚号57
PWM1 – 引脚号56
PWM2 – 引脚号70
PWM3 – 引脚号69 | +| EG915U | PWM0 – 引脚号20 | +| EC800M | PWM0 – 引脚号83
PWM1 – 引脚号78
PWM2 – 引脚号16
PWM3 – 引脚号49 | +| EG912N | PWM0 – 引脚号21
PWM1 – 引脚号116
PWM2 – 引脚号107
PWM3 – 引脚号92 | ## 方法 diff --git "a/docs/API_reference/zh/QuecPython\347\261\273\345\272\223/misc.Power.md" "b/docs/API_reference/zh/QuecPython\347\261\273\345\272\223/misc.Power.md" index 59ed7565..ceb3326c 100644 --- "a/docs/API_reference/zh/QuecPython\347\261\273\345\272\223/misc.Power.md" +++ "b/docs/API_reference/zh/QuecPython\347\261\273\345\272\223/misc.Power.md" @@ -1,6 +1,6 @@ # power - 关机以及软件重启 -模块功能: 提供关机、软件重启、获取开机原因、获取上次关机原因、获取电池电压功能。 +提供关机、软件重启、获取开机原因、获取上次关机原因、获取电池电压功能。 ## 关机功能 @@ -77,7 +77,7 @@ Power.powerDownReason() | 5 | 看门狗触发的关机 | | 6 | VRTC 电压过低触发关机 | -> 注意：BC25PA平台和EC200U/EC600U平台不支持此方法。 +> BC25PA系列和EC200U/EC600U系列不支持此方法。 ## 获取电池电压 diff --git "a/docs/API_reference/zh/QuecPython\347\261\273\345\272\223/misc.PowerKey.md" "b/docs/API_reference/zh/QuecPython\347\261\273\345\272\223/misc.PowerKey.md" index 7f445ac8..ef5c1807 100644 --- "a/docs/API_reference/zh/QuecPython\347\261\273\345\272\223/misc.PowerKey.md" +++ "b/docs/API_reference/zh/QuecPython\347\261\273\345\272\223/misc.PowerKey.md" @@ -39,7 +39,7 @@ PowerKey.powerKeyEventRegister(usrFun) `0`表示注册成功，`-1`表示注册失败。 -> 注意:EC600S/EC600N系列，对于powerkey，按下和松开时，都会触发用户注册的回调函数； +> EC600S/EC600N系列，对于powerkey，按下和松开时，都会触发用户注册的回调函数； > > EC200U/EC600U系列，对于powerkey，只在按键松开时才会触发回调函数，并且按键按下的时间需要维持500ms以上。 diff --git "a/docs/API_reference/zh/QuecPython\347\261\273\345\272\223/misc.USB.md" "b/docs/API_reference/zh/QuecPython\347\261\273\345\272\223/misc.USB.md" index 19e0ecae..968953f3 100644 --- "a/docs/API_reference/zh/QuecPython\347\261\273\345\272\223/misc.USB.md" +++ "b/docs/API_reference/zh/QuecPython\347\261\273\345\272\223/misc.USB.md" @@ -2,7 +2,7 @@ 提供USB插拔检测功能。 -> 注意：EC600S/EC600N/EC800N/EG912N/EC200U/EC600U/EG915U/EC600M/EC800M/EC200A系列支持该功能。 +> EC600S/EC600N/EC800N/EG912N/EC200U/EC600U/EG915U/EC600M/EC800M/EC200A系列支持该功能。 ## 构造函数 diff --git "a/docs/API_reference/zh/QuecPython\347\261\273\345\272\223/misc.USBNET.md" "b/docs/API_reference/zh/QuecPython\347\261\273\345\272\223/misc.USBNET.md" index ee22eed4..9b18bf31 100644 --- "a/docs/API_reference/zh/QuecPython\347\261\273\345\272\223/misc.USBNET.md" +++ "b/docs/API_reference/zh/QuecPython\347\261\273\345\272\223/misc.USBNET.md" @@ -1,8 +1,8 @@ # USBNET - USB网卡功能 -模块功能: 提供USB网卡功能。 + 提供USB网卡功能。 -> 注意：EC600S/EC600N/EC800N/EC200U/EC600U/EC600M系列支持该功能。 +> EC600S/EC600N/EC800N/EC200U/EC600U/EC600M系列支持该功能。 ## 设置USB网卡工作类型 @@ -102,7 +102,7 @@ USBNET.getNat(simid, pid) 获取某一路网卡的NAT使能情况（是否支持ipv6拨号）。 -> 注意:（仅在EC200U/EC600U系列支持） +> 仅在EC200U/EC600U系列支持 **参数描述：** @@ -133,7 +133,7 @@ USBNET.setNat(simid, pid, nat) NAT设置，设置成功后重启生效（USBNET.set_worktype()接口调用的时候会使对应的nat值变为1，使得该pid无法IPV6拨号，所以在close USBnet后，可以使用该接口关闭NAT，使IPV6功能正常）。 -> 注意:仅在EC200U/EC600U系列支持 +> 仅在EC200U/EC600U系列支持 **参数描述：** diff --git "a/docs/API_reference/zh/QuecPython\347\261\273\345\272\223/misc.md" "b/docs/API_reference/zh/QuecPython\347\261\273\345\272\223/misc.md" index 3915ad3f..add3c86b 100644 --- "a/docs/API_reference/zh/QuecPython\347\261\273\345\272\223/misc.md" +++ "b/docs/API_reference/zh/QuecPython\347\261\273\345\272\223/misc.md" @@ -1,6 +1,6 @@ # misc- 其他 -模块功能: 提供关机、软件重启、PWM以及ADC相关功能。 + 提供关机、软件重启、PWM以及ADC相关功能。 ## 分集天线配置接口功能 diff --git "a/docs/API_reference/zh/QuecPython\347\261\273\345\272\223/qrcode.md" "b/docs/API_reference/zh/QuecPython\347\261\273\345\272\223/qrcode.md" index fb40a27e..fbeaa9eb 100644 --- "a/docs/API_reference/zh/QuecPython\347\261\273\345\272\223/qrcode.md" +++ "b/docs/API_reference/zh/QuecPython\347\261\273\345\272\223/qrcode.md" @@ -1,6 +1,6 @@ # qrcode- 二维码显示 -模块功能：根据输入的内容，生成对应的二维码。 +根据输入的内容，生成对应的二维码。 ## 二维码显示功能 @@ -14,13 +14,13 @@ qrcode.show(qrcode_str,magnification,start_x,start_y,Background_color,Foreground **参数描述：** -- `qrcode_str`-string类型,二维码内容; -- `magnification`-int类型,放大倍数[1,6]; -- `start_x`-int类型,二维码显示起始x坐标; -- `start_y`-int类型,二维码显示起始y坐标; +- `qrcode_str`-string类型，二维码内容; +- `magnification`-int类型，放大倍数[1,6]; +- `start_x`-int类型，二维码显示起始x坐标; +- `start_y`-int类型，二维码显示起始y坐标; - `Background_color`-int类型,前景色（不设置即默认为0xffff）; -- `Foreground_color`,int类型,背景色（不设置即默认为0x0000）。 +- `Foreground_color`-int类型,背景色（不设置即默认为0x0000）。 **返回值描述：** -`0`表示成功,`-1`表示生成二维码失败,`-2`表示放大失败,`-3`表示显示失败。 +`0`表示成功，`-1`表示生成二维码失败，`-2`表示放大失败，`-3`表示显示失败。 diff --git a/docs/API_reference/zh/sidebar.yaml b/docs/API_reference/zh/sidebar.yaml index 89974b69..a74d2238 100644 --- a/docs/API_reference/zh/sidebar.yaml +++ b/docs/API_reference/zh/sidebar.yaml @@ -95,10 +95,18 @@ items: - label: misc - 其他 file: QuecPython类库/misc.md items: - - label: USBNET - USB网卡 - file: QuecPython类库/misc.USBNET.md - label: Power - 关机和重启 file: QuecPython类库/misc.Power.md + - label: PowerKey - PowerKey按键回调注册 + file: QuecPython类库/misc.PowerKey.md + - label: PWM - 脉宽调制 + file: QuecPython类库/misc.PWM.md + - label: ADC - 模数转换 + file: QuecPython类库/misc.ADC.md + - label: USB - USB插拔检测 + file: QuecPython类库/misc.USBNET.md + - label: USBNET - USB网卡 + file: QuecPython类库/misc.USB.md - label: modem - 设备相关 file: QuecPython类库/modem.md - label: machine - 硬件相关功能 -- Gitee