From dc20f949babcf1548519bff3015665b49a33abcc Mon Sep 17 00:00:00 2001 From: "mark.zhu" Date: Tue, 28 Feb 2023 10:39:46 +0800 Subject: [PATCH] =?UTF-8?q?=20(Classlib&Stdlib&yaml):=20=E6=B7=BB?= =?UTF-8?q?=E5=8A=A0=E9=85=8D=E7=BD=AE=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.添加yaml，并进行渲染确认 2.根据渲染效果，做出以下细节调整：将引用中的表格调整至引用外、取消一级标题中的代码块格式、修正部分错误的加粗格式 固件版本: N/A 是否需要文案翻译: 是 --- .../math.md" | 2 +- .../sys.md" | 2 +- .../uos.md" | 2 +- .../urandom.md" | 2 +- .../example.md" | 2 +- .../QuecPython\347\261\273\345\272\223/gnss.md" | 2 +- .../QuecPython\347\261\273\345\272\223/modem.md" | 6 +++--- .../zh/QuecPython\347\261\273\345\272\223/pm.md" | 2 +- .../quecgnss.md" | 2 +- .../securedata.md" | 15 ++++++++------- docs/API_reference/zh/sidebar.yaml | 12 ++++++++++++ 11 files changed, 31 insertions(+), 18 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 a24c1fed..61e22885 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" @@ -1,4 +1,4 @@ -# `math` - 数学运算 +# math - 数学运算 math 模块提供数学运算函数。该模块实现相应CPython模块的子集。更多信息请参阅阅CPython文档：[math](https://docs.python.org/3.5/library/math.html#module-math) 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 29975116..bca15578 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" @@ -1,4 +1,4 @@ -# `sys` - 系统相关功能 +# sys - 系统相关功能 > 新架构代码升级了MPY的版本，sys变更为usys。导入模块时建议使用以下方式进行导入 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 4f5c55dd..04e47079 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" @@ -1,4 +1,4 @@ -# `uos` - 基本系统服务 +# uos - 基本系统服务 `uos`模块包含文件系统访问和挂载构建，该模块实现了CPython模块相应模块的子集。更多信息请参阅阅CPython文档：[os](https://docs.python.org/3.5/library/os.html#module-os) diff --git "a/docs/API_reference/zh/QuecPython\346\240\207\345\207\206\345\272\223/urandom.md" "b/docs/API_reference/zh/QuecPython\346\240\207\345\207\206\345\272\223/urandom.md" index c7625bf8..f6c3ba72 100644 --- "a/docs/API_reference/zh/QuecPython\346\240\207\345\207\206\345\272\223/urandom.md" +++ "b/docs/API_reference/zh/QuecPython\346\240\207\345\207\206\345\272\223/urandom.md" @@ -1,4 +1,4 @@ -# `urandom` - 生成随机数 +# urandom - 生成随机数 urandom 模块提供了生成随机数的工具。 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 373fb4b4..3af86982 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,4 +1,4 @@ -# `example` - 执行python脚本 +# example - 执行python脚本 模块功能：提供方法让用户可以在命令行或者代码中执行python脚本。 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 dee1a610..2170f82e 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" @@ -1,4 +1,4 @@ -# `gnss` - 外置GNSS +# gnss - 外置GNSS 对L76K GPS型号（或数据类型与之类似的GPS模组）进行数据获取，可以得到模块定位是否成功，定位的经纬度数据，UTC授时时间，获取GPS模块的定位模式，获取GPS模块定位使用卫星数量，获取GPS模块定位可见卫星数量，获取定位方位角，GPS模块对地速度，模块定位大地高等数据信息。目前，该模块提供的功能接口，所获取的数据都来源于从串口读出的原始GNSS数据包中的GNGGA、GNRMC和GPGSV语句。 diff --git "a/docs/API_reference/zh/QuecPython\347\261\273\345\272\223/modem.md" "b/docs/API_reference/zh/QuecPython\347\261\273\345\272\223/modem.md" index b53d30ba..7e2b4adc 100644 --- "a/docs/API_reference/zh/QuecPython\347\261\273\345\272\223/modem.md" +++ "b/docs/API_reference/zh/QuecPython\347\261\273\345\272\223/modem.md" @@ -1,4 +1,4 @@ -# `modem` - 设备相关 +# modem - 设备相关 modem模块提供读取设备信息的方法 @@ -34,7 +34,7 @@ modem.getDevModel() 获取设备型号。 -****返回值描述**** +**返回值描述** 成功返回string类型设备型号，失败返回整型值 `-1`。 @@ -76,7 +76,7 @@ modem.getDevFwVersion() 获取设备固件版本号。 -****返回值描述**** +**返回值描述** 成功返回string类型固件版本号，失败返回整型值 `-1`。 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 9cf1268f..d3f06f6e 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" @@ -1,4 +1,4 @@ -# `pm` - 低功耗 +# pm - 低功耗 在无业务处理时使系统进入休眠状态，进入低功耗模式。 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 5561732e..a404cc66 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" @@ -1,4 +1,4 @@ -# `quecgnss` - 内置GNSS +# quecgnss - 内置GNSS 此模块提供内置GNSS的使用接口 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 e7771e95..167cc42a 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" @@ -1,4 +1,4 @@ -# `SecureData` - 安全数据区 +# SecureData - 安全数据区 模组提供一块裸flash区域及专门的读写接口供客户存贮重要信息，且信息在烧录固件后不丢失(烧录不包含此功能的固件无法保证不丢失)。提供一个存储和读取接口，不提供删除接口。 @@ -15,12 +15,13 @@ SecureData.Store(index,databuf,len) **参数描述** * `index`，int类型 - | index序号 | 最大存储量 | - | --------- | ---------- | - | 1 - 8 | 52字节 | - | 9 - 12 | 100字节 | - | 13 - 14 | 500字节 | - | 15 - 16 | 1000字节 | + +| index序号 | 最大存储量 | +| --------- | ---------- | +| 1 - 8 | 52字节 | +| 9 - 12 | 100字节 | +| 13 - 14 | 500字节 | +| 15 - 16 | 1000字节 | * `databuf`，待存储的数据数组，bytearray类型 * `len`，要写入数据的长度，int类型 diff --git a/docs/API_reference/zh/sidebar.yaml b/docs/API_reference/zh/sidebar.yaml index d77bb05f..cb0bb386 100644 --- a/docs/API_reference/zh/sidebar.yaml +++ b/docs/API_reference/zh/sidebar.yaml @@ -35,6 +35,8 @@ items: - label: QuecPython类库 file: QuecPython类库/README.md items: + - label: example - 执行python脚本 + file: QuecPython类库/example.md - label: dataCall - 拨号 file: QuecPython类库/dataCall.md - label: atcmd - 发送AT指令 @@ -66,10 +68,20 @@ items: file: QuecPython类库/misc.USBNET.md - label: Power - 关机和重启 file: QuecPython类库/misc.Power.md + - label: modem - 设备相关 + file: QuecPython类库/modem.md - label: machine - 硬件相关功能 file: QuecPython类库/machine.md - label: qrcode - 二维码显示 file: QuecPython类库/qrcode.md + - label: pm - 低功耗 + file: QuecPython类库/pm.md + - label: gnss - 外置GNSS + file: QuecPython类库/gnss.md + - label: quecgnss - 内置GNSS + file: QuecPython类库/quecgnss.md + - label: securedata - 安全数据区 + file: QuecPython类库/securedata.md - label: QuecPython组件库 file: QuecPython组件库/README.md items: -- Gitee