From 3a10de4276a2f24a8e9f1c9d3f5bcc5d7ff45f2b Mon Sep 17 00:00:00 2001 From: "jimmy.luo" Date: Sat, 18 Mar 2023 19:36:06 +0800 Subject: [PATCH] =?UTF-8?q?docs=20(adc/pwm/usb/power/powerkey/qrcode):=20?= =?UTF-8?q?=E9=92=88=E5=AF=B9st=E5=AF=B9=E5=88=9D=E7=89=88=E7=9A=84?= =?UTF-8?q?=E4=BF=AE=E6=94=B9=E5=BB=BA=E8=AE=AE=E5=92=8C=E6=A0=BC=E5=BC=8F?= =?UTF-8?q?=E8=BF=9B=E8=A1=8C=E4=BF=AE=E6=94=B9?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit 1.修改文档中设计的平台厂家的描述（如展锐平台）为模组型号（如EC600U系列）。 2.删除pwm初始化参数限制的描述中 ASR平台的限制，保留展锐平台的参数限制描述。 3.usbnet支持的型号删除EC800G。 4.USB功能增加EC600M/EC800M/EC200A/EG912N/EG915U系列。 5.qrcode描述删除BC25平台不支持描述。 6.其他描述用词和格式优化。 固件版本: N/A 是否需要文案翻译: 是 --- .../misc.ADC.md" | 6 +-- .../misc.PWM.md" | 16 +++---- .../misc.Power.md" | 10 +--- .../misc.PowerKey.md" | 14 +++--- .../misc.USB.md" | 6 +-- .../misc.USBNET.md" | 48 +++++++++---------- .../misc.md" | 12 ++--- .../qrcode.md" | 22 ++++----- 8 files changed, 52 insertions(+), 82 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 8da21abc..5ddc0148 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" @@ -1,5 +1,3 @@ - 本文阐述了QuecPython的misc.ADC类的用法，描述了misc.ADC类最新版本的特性。 - # class ADC - 电压采集功能 用于采集电压信号。 @@ -43,7 +41,7 @@ ADC.read(ADCn) **参数描述：** -- ADCn-ADC通道,int类型,点此查看支持的通道与对应引脚 +- `ADCn`-ADC通道,int类型,点此查看支持的通道与对应引脚 **返回值描述：** @@ -60,7 +58,7 @@ 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
BG95M3平台对应引脚如下
ADC0 – 引脚号24
EG915U平台对应引脚如下
ADC0 – 引脚号24
ADC1 – 引脚号2
EC800M平台对应引脚如下
ADC0 – 引脚号9
ADC1 – 引脚号96
EG912N平台对应引脚如下
ADC0 – 引脚号24
ADC1 – 引脚号2 +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 ### 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 f2f9e34a..be6d95fb 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" @@ -1,10 +1,8 @@ - 本文阐述了QuecPython的misc.PWM类的用法，描述了misc.PWM类最新版本的特性。 - # class PWM - 脉宽调制 提供脉宽调制输出功能。 -> 注意：BC25PA平台不支持此模块。 +> 注意：BC25系列不支持此模块。 ## 构造函数 @@ -16,17 +14,17 @@ class misc.PWM(PWM.PWMn,PWM.ABOVE_xx, highTime, cycleTime) **参数描述：** -- PWM.PWMn-PWM通道,int类型,点此查看支持的通道与对应引脚; +- `PWM.PWMn`-PWM通道,int类型,点此查看支持的通道与对应引脚; -- PWM.ABOVE_xx-时间取值范围,int类型,说明如下: +- `PWM.ABOVE_xx`-时间取值范围,int类型,说明如下: - EC600SCN/EC600N/EC800N/EC600M/EC800M/EG912N平台:
PWM.ABOVE_MS ms级取值范围：(0,1023]
PWM.ABOVE_1US us级取值范围：(0,157]
PWM.ABOVE_10US us级取值范围：(1,1575]
PWM.ABOVE_BELOW_US ns级 取值(0,1024]
EC200U/EC600U/EG915U平台:
PWM.ABOVE_MS ms级取值范围：(0,10]
PWM.ABOVE_1US us级取值范围：(0,10000]
PWM.ABOVE_10US us级取值范围：(1,10000]
PWM.ABOVE_BELOW_US ns级 取值[100,65535] + EC200U/EC600U/EG915U系列:
PWM.ABOVE_MS ms级取值范围：(0,10]
PWM.ABOVE_1US us级取值范围：(0,10000]
PWM.ABOVE_10US us级取值范围：(1,10000]
PWM.ABOVE_BELOW_US ns级 取值[100,65535] -- highTime-高电平时间,int类型,说明如下: +- `highTime`-高电平时间,int类型,说明如下: ms级时，单位为ms
us级时，单位为us
ns级别：需要使用者计算
频率 = 13Mhz / cycleTime
占空比 = highTime/ cycleTime -- cycleTime-周期时间,int类型,说明如下: +- `cycleTime`-周期时间,int类型,说明如下: ms级时，单位为ms
us级时，单位为us
ns级别：需要使用者计算
频率 = 13Mhz / cycleTime
占空比 = highTime/ cycleTime @@ -39,7 +37,7 @@ class misc.PWM(PWM.PWMn,PWM.ABOVE_xx, highTime, cycleTime) **PWM通道与物理引脚的映射关系：** -EC100YCN平台，支持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
EC200UCN平台，支持PWM0，对应引脚如下：
PWM0 – 引脚号135
EC600UCN平台，支持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 +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 ## 方法 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 42f6ccce..59ed7565 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,12 +1,6 @@ -``` -本文阐述了QuecPython的misc模块的power子模块的用法，描述了power模块最新版本的特性。 -``` - - - # power - 关机以及软件重启 -模块功能: 提供关机、软件重启、开机原因、上次关机原因、获取电池电压功能。 +模块功能: 提供关机、软件重启、获取开机原因、获取上次关机原因、获取电池电压功能。 ## 关机功能 @@ -97,7 +91,7 @@ Power.getVbatt() **返回值描述：** -返回整形电压值。 +返回整型电压值。 **示例：** 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 86e3dd91..7f445ac8 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" @@ -1,5 +1,3 @@ - 本文阐述了QuecPython的misc.PowerKey类的用法，描述了misc.PowerKey类最新版本的特性。 - # class PowerKey - power key按键回调注册功能 提供power key按键注册回调功能接口。 @@ -14,7 +12,7 @@ class misc.PowerKey() **返回值描述：** -返回创建的对象 +返回创建的对象。 **示例：** @@ -35,19 +33,19 @@ PowerKey.powerKeyEventRegister(usrFun) **参数描述：** -- usrfun-回调函数,原型usrfun(status),参数status:`0`表示松开,`1`表示按下;按下或松开powerkey按键时触发回调。 +- `usrfun`-回调函数,原型usrfun(status),参数status:`0`表示松开,`1`表示按下;按下或松开powerkey按键时触发回调。 **返回值描述：** `0`表示注册成功，`-1`表示注册失败。 -> 注意:EC600S/EC600N等ASR平台，对于powerkey，按下和松开时，都会触发用户注册的回调函数； +> 注意:EC600S/EC600N系列，对于powerkey，按下和松开时，都会触发用户注册的回调函数； > -> EC200U/EC600U等展锐平台，对于powerkey，只在按键松开时才会触发回调函数，并且按键按下的时间需要维持500ms以上。 +> EC200U/EC600U系列，对于powerkey，只在按键松开时才会触发回调函数，并且按键按下的时间需要维持500ms以上。 **示例：** -EC600S/EC600N平台： +EC600S/EC600N系列： ```python from misc import PowerKey @@ -63,7 +61,7 @@ def pwk_callback(status): pk.powerKeyEventRegister(pwk_callback) ``` -EC200U/EC600U平台： +EC200U/EC600U系列： ```python from misc import PowerKey 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 df516290..19e0ecae 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" @@ -1,10 +1,8 @@ - 本文阐述了QuecPython的misc.USB类的用法，描述了misc.USB类最新版本的特性。 - # class USB - USB插拔检测 提供USB插拔检测功能。 -> 注意：当前仅EC600S/EC600N/EC800N/EC200U/EC600U平台支持该功能。 +> 注意：EC600S/EC600N/EC800N/EG912N/EC200U/EC600U/EG915U/EC600M/EC800M/EC200A系列支持该功能。 ## 构造函数 @@ -45,7 +43,7 @@ usb.setCallback(usrFun) **参数描述：** -- usrFun -回调函数,原型usrFun (conn_status),参数conn_status:`0`表示未连接,`1`表示连接。 +- `usrFun` -回调函数,原型usrFun (conn_status),参数conn_status:`0`表示未连接,`1`表示连接。 **返回值描述：** 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 482a89a4..ee22eed4 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,16 +1,10 @@ -``` -本文阐述了QuecPython的misc模块的USBNET子模块的用法，描述了USBNET模块最新版本的特性。 -``` - - - # USBNET - USB网卡功能 模块功能: 提供USB网卡功能。 -> 注意：当前仅EC600S/EC600N/EC800N/EC200U/EC600U/EC800G平台支持该功能。 +> 注意：EC600S/EC600N/EC800N/EC200U/EC600U/EC600M系列支持该功能。 -## 设置USB网卡工作类型（重启生效） +## 设置USB网卡工作类型 ### `USBNET.set_worktype` @@ -20,13 +14,15 @@ USBNET.set_worktype(type) **参数描述：** -- type-USBNET 工作类型, int类型，Type_ECM:ECM模式, Type_RNDIS:RNDIS模式。 +- `type`-USBNET 工作类型，int类型，Type_ECM：ECM模式, Type_RNDIS：RNDIS模式。 **返回值描述：** `0`表示设置成功，`-1`表示设置失败。 -## 获取USB网卡工作类型（重启生效） +> 注意：重启生效 + +## 获取USB网卡工作类型 ### `USBNET.get_worktype` @@ -36,7 +32,7 @@ USBNET.get_worktype() **返回值描述：** -成功返回USBNET当前工作类型，失败返回整型`-1`;`1`表示ECM模式,`3 `表示 RNDIS模式。 +成功返回USBNET当前工作类型，失败返回整型`-1`；`1`表示ECM模式,`3 `表示 RNDIS模式。 ## 获取USBNET当前状态 @@ -48,7 +44,7 @@ USBNET.get_status() **返回值描述：** -成功返回USBNET当前状态，失败返回整型`-1`;`0`表示未连接,`1`表示连接成功。 +成功返回USBNET当前状态，失败返回整型`-1`；`0`表示未连接,`1`表示连接成功。 ## 打开USB网卡 @@ -96,7 +92,7 @@ from misc import USBNET USBNET.open() ``` -## 获取Nat使能情况 +## 获取NAT使能情况 ### `USBNET.getNat` @@ -104,18 +100,18 @@ USBNET.open() USBNET.getNat(simid, pid) ``` -获取某一路网卡的Nat使能情况（是否支持ipv6拨号）。 +获取某一路网卡的NAT使能情况（是否支持ipv6拨号）。 -> 注意:（仅在EC200U/EC600U平台支持） +> 注意:（仅在EC200U/EC600U系列支持） **参数描述：** -- simid-int类型,范围0/1,目前仅支持`0`； -- pid-PDP索引, int类型,展锐平台范围`1-7`。 +- `simid`-int类型,范围0/1，目前仅支持`0`； +- `pid`-PDP索引，int类型,范围`1-7`。 **返回值描述：** -成功：返回Nat使能情况，整型0/1，`0`：使能，支持ipv6拨号；`1`：未使能，不支持ipv6拨号。 +成功：返回NAT使能情况，整型0/1，`0`：使能，支持ipv6拨号；`1`：未使能，不支持ipv6拨号。 失败：返回整型`-1`。 @@ -127,27 +123,27 @@ USBNET.getNat(0, 1) 0 ``` -## Nat设置 +## NAT设置 ### `USBNET.setNat` ```python -USBNET.setNat(simid, pid, Nat) +USBNET.setNat(simid, pid, nat) ``` -Nat设置，设置成功后重启生效（USBNET.set_worktype()接口调用的时候会使对应的Nat值变为1，使得该pid无法IPV6拨号，所以在close USBnet后，可以使用该接口关闭NAT,使IPV6功能正常）。 +NAT设置，设置成功后重启生效（USBNET.set_worktype()接口调用的时候会使对应的nat值变为1，使得该pid无法IPV6拨号，所以在close USBnet后，可以使用该接口关闭NAT，使IPV6功能正常）。 -> 注意:仅在EC200U/EC600U平台支持 +> 注意:仅在EC200U/EC600U系列支持 **参数描述：** -- simid-int类型,范围0/1,目前仅支持`0`； -- pid-PDP索引, int类型,展锐平台范围`1-7`； -- Nat-int类型,范围：0/1,`0`：支持ipv6拨号；`1`：不支持ipv6拨号。 +- `simid`-int类型,范围0/1,目前仅支持`0`； +- `pid`-PDP索引, int类型,范围`1-7`； +- `Nat`-int类型,范围：0/1,`0`：支持ipv6拨号；`1`：不支持ipv6拨号。 **返回值描述：** -`0`表示设置成功,`-1`表示设置失败。 +`0`表示设置成功，`-1`表示设置失败。 **示例：** 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 c3250103..3915ad3f 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,9 +1,3 @@ -``` -本文阐述了QuecPython的misc模块的用法，描述了misc模块最新版本的特性。 -``` - - - # misc- 其他 模块功能: 提供关机、软件重启、PWM以及ADC相关功能。 @@ -16,7 +10,7 @@ misc.antennaSecRXOffCtrl(*args) ``` -分集天线配置、查询接口。（仅1803S平台支持该接口）。 +分集天线配置、查询接口(EC200A系列支持该接口)。 **参数描述：** @@ -24,13 +18,13 @@ misc.antennaSecRXOffCtrl(*args) 参数个数为0，查询：misc.antennaSecRXOffCtrl()； 参数个数为1，配置：misc.antennaSecRXOffCtrl(SecRXOff_set)。 -- SecRXOff_set-int类型，范围0/1, `0`:不关闭分集天线 `1`:关闭分集天线。 +- `SecRXOff_set`-int类型，范围0/1, `0`:不关闭分集天线 `1`:关闭分集天线。 **返回值描述：** 查询：成功返回分集天线配置，失败返回整形值`-1`； -设置：成功返回整形0,失败返回整型值`-1`。 +设置：成功返回整形`0`,失败返回整型值`-1`。 **示例：** 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 66c8b548..fb40a27e 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,15 +1,7 @@ -``` -本文阐述了QuecPython的qrcode模块的用法，描述了qrcode模块最新版本的特性。 -``` - - - # qrcode- 二维码显示 模块功能：根据输入的内容，生成对应的二维码。 -> 注意:BC25PA平台不支持此模块功能;使用该功能前，需要初始化LCD。 - ## 二维码显示功能 ### `qrcode.show` @@ -18,14 +10,16 @@ qrcode.show(qrcode_str,magnification,start_x,start_y,Background_color,Foreground_color) ``` +显示二维码到LCD。 + **参数描述：** -- qrcode_str-string类型,二维码内容; -- magnification-int类型,放大倍数[1,6]; -- start_x-int类型,二维码显示起始x坐标; -- start_y-int类型,二维码显示起始y坐标; -- Background_color-int类型,前景色（不设置即默认为0xffff）; -- Foreground_color,int类型,背景色（不设置即默认为0x0000）。 +- `qrcode_str`-string类型,二维码内容; +- `magnification`-int类型,放大倍数[1,6]; +- `start_x`-int类型,二维码显示起始x坐标; +- `start_y`-int类型,二维码显示起始y坐标; +- `Background_color`-int类型,前景色（不设置即默认为0xffff）; +- `Foreground_color`,int类型,背景色（不设置即默认为0x0000）。 **返回值描述：** -- Gitee