From 9c29837a814b72ac273a61bc2bae27c7859dd63d 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: Thu, 27 Apr 2023 16:17:44 +0800 Subject: [PATCH] =?UTF-8?q?docs=20(misc/qrcode):=20=E6=A0=B9=E6=8D=AEST?= =?UTF-8?q?=E7=AC=AC=E4=B8=89=E8=BD=AE=E4=BF=AE=E6=94=B9=E6=84=8F=E8=A7=81?= =?UTF-8?q?=E4=BF=AE=E6=94=B9=E6=96=87=E6=A1=A3?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit 1.文档中的标点符号改为中文。 2.misc.ADC.md ADC.close 方法字体加粗，把管脚对应表放到ADC.close方法后面。 3.删除文档中的“注意”字眼。 4.qrcode.md中增加支持的型号。 固件版本: N/A 是否需要文案翻译: 是 --- .../misc.ADC.md" | 20 +++++++++---------- .../misc.PWM.md" | 13 ++++++------ .../misc.PowerKey.md" | 4 ++-- .../misc.USB.md" | 8 ++++---- .../misc.USBNET.md" | 2 +- .../misc.md" | 2 +- .../qrcode.md" | 2 ++ 7 files changed, 27 insertions(+), 24 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 51d97a16..32684ba7 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" @@ -56,6 +56,16 @@ ADC.read(ADCn) 605 ``` +### `ADC.close` + +```python +ADC.close() +``` + +**返回值描述：** + +`0`表示关闭成功，`-1`表示关闭失败。 + **ADC通道与物理引脚的映射关系：** | 系列 | 引脚对应 | @@ -71,16 +81,6 @@ ADC.read(ADCn) | EC800M | ADC0 – 引脚号9
ADC1 – 引脚号96 | | EG912N | ADC0 – 引脚号24
ADC1 – 引脚号2 | -### ADC.close - -```python -ADC.close() -``` - -**返回值描述：** - -`0`表示关闭成功，`-1`表示关闭失败。 - ## 常量 | 常量 | 说明 | 适用平台 | 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 73e52703..85309808 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" @@ -14,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类型,说明如下： - 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 @@ -93,4 +93,5 @@ if __name__ == '__main__': | PWM.PWM0 | PWM0 | EC600S / EC600N / EC100Y/EC600U/EC200U/EC800N/EC600M/EG915U/EC800M/EG912N | | PWM.PWM1 | PWM1 | EC600S / EC600N / EC100Y/EC800N/EC600M/EC800M/EG912N | | PWM.PWM2 | PWM2 | EC600S / EC600N / EC100Y/EC800N/EC600M/EC800M/EG912N | -| PWM.PWM3 | PWM3 | EC600S / EC600N / EC100Y/EC800N/EC600M/EC800M/EG912N | \ No newline at end of file +| PWM.PWM3 | PWM3 | EC600S / EC600N / EC100Y/EC800N/EC600M/EC800M/EG912N | + 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 2529c9a9..c0abd870 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" @@ -33,7 +33,7 @@ PowerKey.powerKeyEventRegister(usrFun) **参数描述：** -- `usrfun`-回调函数,原型usrfun(status),参数status，int类型:`0`表示松开,`1`表示按下;按下或松开powerkey按键时触发回调。 +- `usrfun`-回调函数，原型usrfun(status)，参数status，int类型：`0`表示松开，`1`表示按下；按下或松开powerkey按键时触发回调。 **返回值描述：** @@ -41,7 +41,7 @@ PowerKey.powerKeyEventRegister(usrFun) > ECX00S/ECX00N/ECX00M/ECX00E系列，对于powerkey，按下和松开时，都会触发用户注册的回调函数； > -> ECX00U/ECX00G系列，对于powerkey，只在按键松开时才会触发回调函数，并且按键按下的时间需要维持500ms以上; +> ECX00U/ECX00G系列，对于powerkey，只在按键松开时才会触发回调函数，并且按键按下的时间需要维持500ms以上； > > 上述所有平台在注册用户的回调函数后，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 968953f3..91b61922 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" @@ -31,7 +31,7 @@ USB.getStatus() **返回值描述：** -`-1` 表示 获取状态失败,`0 `表示USB当前没有连接,`1 `表示 USB已连接。 +`-1` 表示 获取状态失败，`0 `表示USB当前没有连接，`1 `表示 USB已连接。 ### `usb.setCallback` @@ -39,17 +39,17 @@ USB.getStatus() usb.setCallback(usrFun) ``` -该方法用于注册USB插拔回调函数,当USB插入或者拔出时,会触发回调来通知用户当前USB状态。 +该方法用于注册USB插拔回调函数，当USB插入或者拔出时，会触发回调来通知用户当前USB状态。 **参数描述：** -- `usrFun` -回调函数,原型usrFun (conn_status),参数conn_status:`0`表示未连接,`1`表示连接。 +- `usrFun` -回调函数，原型usrFun (conn_status)，参数conn_status：`0`表示未连接，`1`表示连接。 **返回值描述：** `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 9b18bf31..96f02d9f 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" @@ -20,7 +20,7 @@ USBNET.set_worktype(type) `0`表示设置成功，`-1`表示设置失败。 -> 注意：重启生效 +> 重启生效 ## 获取USB网卡工作类型 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 add3c86b..76416353 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" @@ -22,7 +22,7 @@ misc.antennaSecRXOffCtrl(*args) **返回值描述：** -查询：成功返回分集天线配置，失败返回整形值`-1`； +查询：成功返回分集天线配置，失败返回整型值`-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 fbeaa9eb..a53384ca 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" @@ -2,6 +2,8 @@ 根据输入的内容，生成对应的二维码。 +> 当前支持的型号：EC600N/EC200NCNLA/EC800N/EC600MCNLA/EC600MCNLE/EC800MCNLA/EC800MCNGA/EC800MCNLE系列。 + ## 二维码显示功能 ### `qrcode.show` -- Gitee