From b6f8f19ed8561e566308ddc6cb8f8722d4d40cc4 Mon Sep 17 00:00:00 2001 From: "mark.zhu" Date: Mon, 10 Apr 2023 11:36:36 +0800 Subject: [PATCH 1/2] =?UTF-8?q?docs=20(gnss&quecgnss&pm&securedata):=20?= =?UTF-8?q?=E6=A0=B9=E6=8D=AE=E6=B5=8B=E8=AF=95=E4=BA=8C=E8=BD=AE=E6=A3=80?= =?UTF-8?q?=E6=9F=A5=E6=84=8F=E8=A7=81=EF=BC=8C=E4=BF=AE=E6=94=B9=E9=83=A8?= =?UTF-8?q?=E5=88=86=E8=AF=AD=E5=8F=A5=E4=B8=8D=E9=80=9A=E9=A1=BA=E5=92=8C?= =?UTF-8?q?=E6=A0=BC=E5=BC=8F=E6=9C=89=E6=BC=8F=E6=B4=9E=E7=9A=84=E5=9C=B0?= =?UTF-8?q?=E6=96=B9?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit 1、删除引用中的“说明”和“注意”等内容，因为引用本身就有强调作用 2、部分文档存在上下文中名称不统一问题，修改之 固件版本: N/A 是否需要文案翻译: 否 --- .../gnss.md" | 19 ++++++++++--------- .../QuecPython\347\261\273\345\272\223/pm.md" | 16 ++++++++-------- .../quecgnss.md" | 2 +- .../securedata.md" | 2 +- 4 files changed, 20 insertions(+), 19 deletions(-) diff --git "a/docs/API_reference/zh/QuecPython\347\261\273\345\272\223/gnss.md" "b/docs/API_reference/zh/QuecPython\347\261\273\345\272\223/gnss.md" index 4f90045d..62143181 100644 --- "a/docs/API_reference/zh/QuecPython\347\261\273\345\272\223/gnss.md" +++ "b/docs/API_reference/zh/QuecPython\347\261\273\345\272\223/gnss.md" @@ -2,7 +2,8 @@ 对L76K GPS型号（或数据类型与之类似的GPS模组）进行数据获取，可以得到模块定位是否成功，定位的经纬度数据，UTC授时时间，获取GPS模块的定位模式，获取GPS模块定位使用卫星数量，获取GPS模块定位可见卫星数量，获取定位方位角，GPS模块对地速度，模块定位大地高等数据信息。目前，该模块提供的功能接口，所获取的数据都来源于从串口读出的原始GNSS数据包中的GNGGA、GNRMC和GPGSV语句。 -注意：当前仅EC600S/EC600N/EC800N/200U/600U/600M/800M模块支持该功能。 +> 当前仅EC600S/EC600N/EC800N/200U/600U/600M/800M模块支持该功能 +> ## 创建gnss对象 @@ -16,12 +17,12 @@ gnss.GnssGetData(uartn,baudrate,databits,parity,stopbits,flowctl) **参数描述** -* `UARTn`，int类型 - UARTn范围为0-3： - `0`-UART0 - DEBUG PORT - `1`-UART1 – BT PORT - `2`-UART2 – MAIN PORT - `3`-UART3 – USB CDC PORT +* `uartn`，int类型 + uartn + `0`-uart0 - DEBUG PORT + `1`-uart1 – BT PORT + `2`-uart2 – MAIN PORT + `3`-uart3 – USB CDC PORT * `baudrate`，int类型，常用波特率都支持，如4800、9600、19200、38400、57600、115200、230400等 * `databits`，int类型，数据位（5 ~ 8），ECX00U系列平台当前仅支持8位 * `parity`，int类型，奇偶校验（0 – NONE，1 – EVEN，2 - ODD） @@ -138,7 +139,7 @@ GNSS模块提供的功能接口，所获取的数据都来源于从串口读出 **返回值描述** -返回一个元组，形式为 ` (gga_valid, rmc_valid, gsv_valid)` +返回一个列表，形式为 ` (gga_valid, rmc_valid, gsv_valid)` `gga_valid` - 表示本次读取解析，是否匹配到GNGGA数据并解析成功，0表示没有匹配到GNGGA数据或数据无效，1表示有效； @@ -311,7 +312,7 @@ gnss.getCourse() **返回值描述** -返回所有可视的GNSS卫星方位角，范围：`0 ~ 359`，以正北为参考平面。返回形式为字典，其中key表示卫星编号，value表示方位角。要注意，value的值可能是一个整型值，也可能是空，这取决于原始的GNSS数据中GPGSV语句中方位角是否有值。返回值形式如下： +返回所有可视的GNSS卫星方位角，范围：`0 ~ 359`，以正北为参考平面。返回形式为字典，其中key表示卫星编号，value表示方位角。要注意，value的值可能是一个整型值，也可能是空，这取决于原始的GNSS数据中GPGSV语句中方位角是否有值，如获取失败返回-1。返回值形式如下： `{key:value, ..., key:value}` diff --git "a/docs/API_reference/zh/QuecPython\347\261\273\345\272\223/pm.md" "b/docs/API_reference/zh/QuecPython\347\261\273\345\272\223/pm.md" index baa8f0d2..cc5d8a73 100644 --- "a/docs/API_reference/zh/QuecPython\347\261\273\345\272\223/pm.md" +++ "b/docs/API_reference/zh/QuecPython\347\261\273\345\272\223/pm.md" @@ -48,7 +48,7 @@ pm.create_wakelock(lock_name, name_size) 成功返回wakelock的标识号，否则返回 `-1`。 -> **注意**:BC25PA平台不支持此方法。 +> BC25PA平台不支持此方法。 ## 删除wake_lock锁 @@ -68,7 +68,7 @@ pm.delete_wakelock(lpm_fd) 成功返回 `0`。 -> **注意**：BC25PA平台不支持此方法。 +> BC25PA平台不支持此方法。 ## 加锁 @@ -88,7 +88,7 @@ pm.wakelock_lock(lpm_fd) 成功返回 `0`，否则返回 `-1`。 -> **注意**：BC25PA平台不支持此方法。 +> BC25PA平台不支持此方法。 ## 释放锁 @@ -108,7 +108,7 @@ pm.wakelock_unlock(lpm_fd) 成功返回 `0`，否则返回 `-1`。 -> **注意**：BC25PA平台不支持此方法。 +> BC25PA平台不支持此方法。 ## 自动休眠模式控制 @@ -142,7 +142,7 @@ pm.get_wakelock_num() int类型，返回已创建wakelock锁的数量。 -> 注意：BC25PA平台不支持此方法。 +> BC25PA平台不支持此方法。 ## 设置PSM模式的控制时间 @@ -185,7 +185,7 @@ pm.set_psm_time(mode)# 单独设置启用或禁用 <模式2> * `act_time`，act(T3324)定时器时间周期值，int类型。 -> **注意：**实际设置的tau和act，为单位值和周期值的积 +> 实际设置的tau和act，为单位值和周期值的积 **返回值描述** @@ -201,7 +201,7 @@ True >>> ``` -> **注意**：仅BC25/ECX00U/ECX00E支持 +> 仅BC25/ECX00U/ECX00E支持 ## 获取PSM模式的控制时间 @@ -235,5 +235,5 @@ pm.get_psm_time() ``` -> **注意**：仅BC25/ECX00U/ECX00E平台支持 +> 仅BC25/ECX00U/ECX00E平台支持 diff --git "a/docs/API_reference/zh/QuecPython\347\261\273\345\272\223/quecgnss.md" "b/docs/API_reference/zh/QuecPython\347\261\273\345\272\223/quecgnss.md" index 6495a78b..45415fc0 100644 --- "a/docs/API_reference/zh/QuecPython\347\261\273\345\272\223/quecgnss.md" +++ "b/docs/API_reference/zh/QuecPython\347\261\273\345\272\223/quecgnss.md" @@ -2,7 +2,7 @@ 此模块提供内置GNSS的使用接口 -> **说明**：当前仅 EC200UCNAA/EC200UCNLA/EC200UEUAA/EC800MCNGA/EC800GCNGA 型号支持该功能。 +> 当前仅 EC200UCNAA/EC200UCNLA/EC200UEUAA/EC800MCNGA/EC800GCNGA 型号支持该功能。 **使用示例** diff --git "a/docs/API_reference/zh/QuecPython\347\261\273\345\272\223/securedata.md" "b/docs/API_reference/zh/QuecPython\347\261\273\345\272\223/securedata.md" index df75ed30..6404f3c5 100644 --- "a/docs/API_reference/zh/QuecPython\347\261\273\345\272\223/securedata.md" +++ "b/docs/API_reference/zh/QuecPython\347\261\273\345\272\223/securedata.md" @@ -3,7 +3,7 @@ 模组提供一块裸flash区域及专门的读写接口供客户存贮重要信息，且信息在烧录固件后不丢失(烧录不包含此功能的固件无法保证不丢失)。提供一个存储和读取接口，不提供删除接口。 -> 目前除BC25/BG95/EC200A系列外，其余平台均支持本功能 +> 目前除BC25/BG95/EC200A系列外，其余系列均支持本功能 **示例** -- Gitee From 556efedcc4e6d60e3849f889f02789e2e3aa7c8f Mon Sep 17 00:00:00 2001 From: "mark.zhu" Date: Mon, 10 Apr 2023 14:38:52 +0800 Subject: [PATCH 2/2] =?UTF-8?q?docs=20(uos&sys&math&example):=20=E6=A0=B9?= =?UTF-8?q?=E6=8D=AE=E6=B5=8B=E8=AF=95=E4=BA=8C=E8=BD=AE=E6=B5=8B=E8=AF=95?= =?UTF-8?q?=E7=9A=84=E6=84=8F=E8=A7=81=EF=BC=8C=E4=BF=AE=E6=AD=A3=E9=83=A8?= =?UTF-8?q?=E5=88=86=E7=BB=86=E8=8A=82?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit 1.math中存在部分**表示次方的用法，导致格式异常 2.sys.implementation 在当前版本返回内容新增字段"mpy"字段的描述 3.其它格式修正 固件版本: N/A 是否需要文案翻译: 否 --- .../math.md" | 16 ++++++---- .../sys.md" | 17 +++++++++++ .../uos.md" | 29 +++++++++++++------ .../example.md" | 2 +- 4 files changed, 48 insertions(+), 16 deletions(-) diff --git "a/docs/API_reference/zh/QuecPython\346\240\207\345\207\206\345\272\223/math.md" "b/docs/API_reference/zh/QuecPython\346\240\207\345\207\206\345\272\223/math.md" index 1352ddca..a79d4dac 100644 --- "a/docs/API_reference/zh/QuecPython\346\240\207\345\207\206\345\272\223/math.md" +++ "b/docs/API_reference/zh/QuecPython\346\240\207\345\207\206\345\272\223/math.md" @@ -341,7 +341,8 @@ math.fmod(x, y) * `x`：任意实数类型 * `y`：任意实数类型 - **返回值描述** + +**返回值描述** `x`/`y`的余数，浮点数 **示例：** @@ -367,7 +368,9 @@ math.modf(x) **参数描述** * `x`：任意实数类型 - **返回值描述** + + +**返回值描述** `x`/`y`的余数，浮点数 **示例：** @@ -391,8 +394,9 @@ math.frexp(x) **参数描述** * `x`：浮点数 - **返回值描述** - 返回一个元组 `(m,e)`,其计算方式为：`x`分别除0.5和1,得到一个值的范围，`2e`的值在这个范围内，`e`取符合要求的最大整数值,然后 `x/(2e)`，得到 `m`的值。如果 `x`等于0，则 `m`和 `e`的值都为0，`m`的绝对值的范围为(0.5,1)之间，不包括0.5和1。 + +**返回值描述** +返回一个元组 `(m,e)`, 以 (m, e) 对的形式返回 x 的尾数和指数。 m 是一个浮点数， e 是一个整数，正好是 x == m * 2**e 。 如果 x 为零，则返回 (0.0, 0) ，否则返回 0.5 <= abs(m) < 1 **示例：** @@ -488,7 +492,7 @@ False math.ldexp(x, exp) ``` -**返回x*(2**i)的值 +**返回x*(2^i)的值** **参数描述** @@ -576,7 +580,7 @@ math.sin(x) **参数描述** -* `x`,浮点数 +* `x`,任意实数 **返回值描述** diff --git "a/docs/API_reference/zh/QuecPython\346\240\207\345\207\206\345\272\223/sys.md" "b/docs/API_reference/zh/QuecPython\346\240\207\345\207\206\345\272\223/sys.md" index 0ca52e50..3bb3bf88 100644 --- "a/docs/API_reference/zh/QuecPython\346\240\207\345\207\206\345\272\223/sys.md" +++ "b/docs/API_reference/zh/QuecPython\346\240\207\345\207\206\345\272\223/sys.md" @@ -24,8 +24,25 @@ except ImportError: 返回当前microPython版本信息。对于MicroPython，它具有以下属性： - name - 字符串“ micropython” + - version - 元组（主要，次要，微型），例如（1、7、0） +- _mpy - mpy文件的版本信息，解析方法如下，mpy_cross生成mpy时需要与此版本信息相适配 + +```python +import sys +sys_mpy = sys.implementation._mpy +arch = [None, 'x86', 'x64', + 'armv6', 'armv6m', 'armv7m', 'armv7em', 'armv7emsp', 'armv7emdp', + 'xtensa', 'xtensawin'][sys_mpy >> 10] +print('mpy version:', sys_mpy & 0xff) +print('mpy sub-version:', sys_mpy >> 8 & 3) +print('mpy flags:', end='') +if arch: + print(' -march=' + arch, end='') +print() +``` + 建议使用此对象来将MicroPython与其他Python实现区分开。 ### `sys.maxsize` diff --git "a/docs/API_reference/zh/QuecPython\346\240\207\345\207\206\345\272\223/uos.md" "b/docs/API_reference/zh/QuecPython\346\240\207\345\207\206\345\272\223/uos.md" index 24e38fc5..a1768a34 100644 --- "a/docs/API_reference/zh/QuecPython\346\240\207\345\207\206\345\272\223/uos.md" +++ "b/docs/API_reference/zh/QuecPython\346\240\207\345\207\206\345\272\223/uos.md" @@ -81,7 +81,7 @@ uos.mkdir(path) **参数描述** -* `path`表示准备创建的目录名。 +* `path`表示准备创建的目录名，为所在目录的相对路径。 **示例：** @@ -124,7 +124,7 @@ uos.rmdir(path) **参数描述** -* `path`，字符串，表示目录名。 +* `path`，字符串，表示目录名，为所在目录的相对路径。 **示例：** @@ -337,8 +337,13 @@ uos.VfsFat(spi_port, spimode, spiclk, spics) **参数描述** * `spi_port`，int，通道选择[0,1] -* `spimode`，int，PI 的工作模式(模式0最常用):
0 : CPOL=0, CPHA=0 1 : CPOL=0, CPHA=12: CPOL=1, CPHA=0 3: CPOL=1, CPHA=1 - +* `spimode`，int，SPI 的工作模式(模式0最常用):
+|参数|工作模式| +| ---- | ---- | +| 0 |CPOL=0, CPHA=0| +| 1 | CPOL=0, CPHA=1| +| 2 |CPOL=1, CPHA=0| +| 3 |CPOL=1, CPHA=1| > 时钟极性CPOL: 即SPI空闲时，时钟信号SCLK的电平（0:空闲时低电平; 1:空闲时高电平） * `spiclk`， int @@ -351,8 +356,6 @@ uos.VfsFat(spi_port, spimode, spiclk, spics) | 3 |6.5MHz| | 4 |13MHz| - 0 : 812.5kHz 1 : 1.625MHz 2 : 3.25MHz 3 : 6.5MHz 4 : 13MHz - * `spics`，int，指定CS片选引脚为任意GPIO，硬件CS可以接这里指定的脚，也可以接默认的SPI CS脚 > 1-n:指定Pin.GPIO1-Pin.GPIOn为CS脚 @@ -500,11 +503,19 @@ uos.VfsLfs1(readsize,progsize,lookahead,pname,spi_port,spi_clk) * `lookahead`，int类型，预留，暂未使用 * `pname`，str类型，固定为“ext_fs”。后续扩展 * `spi_port`，int类型，支持的端口参照SPI章节说明 -* `spi_clk`，int类型
时钟频率：
0：6.25M 1:12.5M 2:25M 3:50M 4:3.125M 5:1.5625M 6:781.25K - +* `spi_clk`，int类型
+|参数|时钟频率| +| ---- | ---- | +| 0 |6.25MHz| +| 1 |12.5MHz| +| 2 |25MHz| +| 3 |50MHz| +| 4 |3.125MHz| +| 5 |1.5625MHz| +| 6 |781.25KHz| **返回值描述** -成功则返回VfsLfs1 object,失败则 OSError 19。 +成功则返回VfsLfs1 object,失败则返回 OSError 19。 **示例：** diff --git "a/docs/API_reference/zh/QuecPython\347\261\273\345\272\223/example.md" "b/docs/API_reference/zh/QuecPython\347\261\273\345\272\223/example.md" index 3af86982..787e9648 100644 --- "a/docs/API_reference/zh/QuecPython\347\261\273\345\272\223/example.md" +++ "b/docs/API_reference/zh/QuecPython\347\261\273\345\272\223/example.md" @@ -1,6 +1,6 @@ # example - 执行python脚本 -模块功能：提供方法让用户可以在命令行或者代码中执行python脚本。 +提供方法让用户可以在命令行或者代码中执行python脚本。 ### `example.exec` -- Gitee