diff --git "a/docs/API_reference/zh/QuecPython\347\261\273\345\272\223/README.md" "b/docs/API_reference/zh/QuecPython\347\261\273\345\272\223/README.md"
index 1b56bc3c6153679d02f322afacb3012490342ee4..7d3da9472188f4bbf657bf2f51f57e39c6c57ecc 100644
--- "a/docs/API_reference/zh/QuecPython\347\261\273\345\272\223/README.md"
+++ "b/docs/API_reference/zh/QuecPython\347\261\273\345\272\223/README.md"
@@ -8,9 +8,13 @@
- [example - 执行Python脚本](./example.md)
- [dataCall - 数据拨号](./dataCall.md)
+- [atcmd - 发送AT指令](./atcmd.md)
+- [sim - SIM卡相关功能](./sim.md)
+- [sms - 短信功能](./sms.md)
+- [voiceCall - 电话功能](./voiceCall.md)
+- [net - 网络相关功能](./net.md)
- [cellLocator - 基站定位](./cellLocator.md)
- [wifilocator - WiFi定位](./wifilocator.md)
-- [atcmd - 发送AT指令](./atcmd.md)
- [machine - 硬件相关功能](./machine.md)
- [ethernet - 以太网相关功能](./ethernet.md)
- [...](./....md)
diff --git "a/docs/API_reference/zh/QuecPython\347\261\273\345\272\223/atcmd.md" "b/docs/API_reference/zh/QuecPython\347\261\273\345\272\223/atcmd.md"
index 8fd57d7bf71952f68a18ccd1a00acb262e3f7bba..39da8cd9d750b396c951d4b4ea9b7a25c4753982 100644
--- "a/docs/API_reference/zh/QuecPython\347\261\273\345\272\223/atcmd.md"
+++ "b/docs/API_reference/zh/QuecPython\347\261\273\345\272\223/atcmd.md"
@@ -1,4 +1,4 @@
-# `atcmd` - 发送AT指令功能
+# atcmd - 发送AT指令功能
提供发送AT指令的方法,使模组能够通过Python代码发送AT指令。
diff --git "a/docs/API_reference/zh/QuecPython\347\261\273\345\272\223/cellLocator.md" "b/docs/API_reference/zh/QuecPython\347\261\273\345\272\223/cellLocator.md"
index a969b4408138dc65617580f09aed2c4475cdabad..2642287831c19405ba5e558af8c5f4b8c43a232c 100644
--- "a/docs/API_reference/zh/QuecPython\347\261\273\345\272\223/cellLocator.md"
+++ "b/docs/API_reference/zh/QuecPython\347\261\273\345\272\223/cellLocator.md"
@@ -1,4 +1,4 @@
-# `cellLocator` - 基站定位
+# cellLocator - 基站定位
`cellLocator` 提供基站定位功能,获取模组经纬度坐标信息。
@@ -20,7 +20,8 @@ cellLocator.getLocation(serverAddr, port, token, timeout, profileIdx)
* `port` - 服务器端口,整型值,目前仅支持 80 端口
* `token` - 密钥,字符串类型,16位字符组成,需要申请
* `timeout` -设置超时时间,整型值,范围1-300s,默认300s
-* `profileIdx` - PDP上下文ID,整型值,一般设置为1,设置其他值可能需要专用apn与密码才能设置成功;范围如下:
EC600N/EC600S/EC800N,范围:1~8
EC200U/EC600U,范围:1~7
+* `profileIdx` - PDP上下文ID,整型值,一般设置为1,设置其他值可能需要专用apn与密码才能设置成功;
+范围如下:EC600N/EC600S/EC800N,范围:1 ~ 8;EC200U/EC600U,范围:1 ~ 7。
**返回值描述:**
diff --git "a/docs/API_reference/zh/QuecPython\347\261\273\345\272\223/net.md" "b/docs/API_reference/zh/QuecPython\347\261\273\345\272\223/net.md"
index 554fb1226afd348521e04cdd2d441d6a2fc3c44d..2ad89e546d0ee67f0963cdfc403e647579952959 100644
--- "a/docs/API_reference/zh/QuecPython\347\261\273\345\272\223/net.md"
+++ "b/docs/API_reference/zh/QuecPython\347\261\273\345\272\223/net.md"
@@ -1,9 +1,8 @@
-# `net` - 网络相关功能
+# net - 网络相关功能
`net`模块包含了模组网络相关的功能,提供配置和查询网络模式信息等接口,比如获取注网状态,设置搜网模式等。
->注:
->建议用户使用不同运营商的SIM卡时,则配置对应运营商的APN信息;如果不配置或者配置错误,可能会导致模组无法注网。用户具体如何配置APN信息,参考`dataCall.setApn`方法。
+>注: 建议用户使用不同运营商的SIM卡时,则配置对应运营商的APN信息;如果不配置或者配置错误,可能会导致模组无法注网。用户具体如何配置APN信息,参考`dataCall.setApn`方法。
## 方法
@@ -103,6 +102,7 @@ net.getCellInfo([sinrEnable])
>注:
>
+>* 该接口搜小区时会一直阻塞,一般是3-5秒,在无信号的地方会更长
>* `sinrEnable`为可选参,不支持的平台可不写,不写默认不获取sinr
>
>* 仅BC25/EC600E/EC800E系列支持获取sinr,其余模组型号均不支持
@@ -143,41 +143,25 @@ net.getConfig()
* 网络制式
-| 值 | 网络制式 |
-| ---- | ------------------------------------------------------------ |
-| 0 | GSM |
-| 1 | UMTS |
-| 2 | GSM_UMTS(auto) |
-| 3 | GSM_UMTS(GSM preferred) |
-| 4 | GSM_UMTS(UMTS preferred) |
-| 5 | LTE |
-| 6 | GSM_LTE(auto) |
-| 7 | GSM_LTE(GSM preferred) |
-| 8 | GSM_LTE(LTE preferred) |
-| 9 | UMTS_LTE(auto) |
-| 10 | UMTS_LTE(UMTS preferred) |
-| 11 | UMTS_LTE(LTE preferred) |
-| 12 | GSM_UMTS_LTE(auto) |
-| 13 | GSM_UMTS_LTE(GSM preferred) |
-| 14 | GSM_UMTS_LTE(UMTS preferred) |
-| 15 | GSM_UMTS_LTE(LTE preferred) |
-| 16 | GSM_LTE(dual link) |
-| 17 | UMTS_LTE(dual link) |
-| 18 | GSM_UMTS_LTE(dual link) |
-| 19 | CATM, BG95 supported |
-| 20 | GSM_CATM, BG95 supported |
-| 21 | CATNB, BG95 supported |
-| 22 | GSM_CATNB, BG95 supported |
-| 23 | CATM_CATNB, BG95 supported |
-| 24 | GSM_CATM_CATNB, BG95 supported |
-| 25 | CATM_GSM, BG95 supported |
-| 26 | CATNB_GSM, BG95 supported |
-| 27 | CATNB_CATM, BG95 supported |
-| 28 | GSM_CATNB_CATM, BG95 supported |
-| 29 | CATM_GSM_CATNB, BG95 supported |
-| 30 | CATM_CATNB_GSM, BG95 supported |
-| 31 | CATNB_GSM_CATM, BG95 supported |
-| 32 | CATNB_CATM_GSM, BG95 supported |
+| 值 | 网络制式 | | 值 | 网络制式 |
+| ---- | :----------------------------- | ---- | ---- | -------------------------------- |
+| 0 | GSM | | 17 | UMTS_LTE(dual link) |
+| 1 | UMTS | | 18 | GSM_UMTS_LTE(dual link) |
+| 2 | GSM_UMTS(auto) | | 19 | CATM, BG95 supported |
+| 3 | GSM_UMTS(GSM preferred) | | 20 | GSM_CATM, BG95 supported |
+| 4 | GSM_UMTS(UMTS preferred) | | 21 | CATNB, BG95 supported |
+| 5 | LTE | | 22 | GSM_CATNB, BG95 supported |
+| 6 | GSM_LTE(auto) | | 23 | CATM_CATNB, BG95 supported |
+| 7 | GSM_LTE(GSM preferred) | | 24 | GSM_CATM_CATNB, BG95 supported |
+| 8 | GSM_LTE(LTE preferred) | | 25 | CATM_GSM, BG95 supported |
+| 9 | UMTS_LTE(auto) | | 26 | CATNB_GSM, BG95 supported |
+| 10 | UMTS_LTE(UMTS preferred) | | 27 | CATNB_CATM, BG95 supported |
+| 11 | UMTS_LTE(LTE preferred) | | 28 | GSM_CATNB_CATM, BG95 supported |
+| 12 | GSM_UMTS_LTE(auto) | | 29 | CATM_GSM_CATNB, BG95 supported |
+| 13 | GSM_UMTS_LTE(GSM preferred) | | 30 | CATM_CATNB_GSM, BG95 supported |
+| 14 | GSM_UMTS_LTE(UMTS preferred) | | 31 | CATNB_GSM_CATM, BG95 supported |
+| 15 | GSM_UMTS_LTE(LTE preferred) | | 32 | CATNB_CATM_GSM, BG95 supported |
+| 16 | GSM_LTE(dual link) | | | |
>BC25系列不支持此方法
@@ -254,6 +238,7 @@ net.getNetMode()
| `act` | 整型值 | 首选网络的ACT模式 |
`ACT`模式枚举值参照下表:
+
| 值 | ACT模式 |
| ---- | ------------------ |
| 0 | GSM |
@@ -269,6 +254,7 @@ net.getNetMode()
| 10 | NONE |
BG95系列模组`ACT`模式枚举值参照下表:
+
| 值 | ACT模式 |
| ---- | ------------------ |
| 0 | GSM |
@@ -441,16 +427,17 @@ net.getState()
* 返回值参数说明:
- | 参数 | 参数说明 |
- | -------------- | ------------------------------------------------------------ |
- | `state` | 网络注册状态,具体见下表 |
- | `lac` | 位置区码,范围 1 ~ 65534 |
- | `cid` | cell id,范围 0x00000000 ~ 0x0FFFFFFF,具体见`net.csqQueryPoll()`中返回值 |
- | ``rat`` | 接入技术,access technology,具体见后面表格 |
- | `reject_cause` | 注册被拒绝的原因,EC200U/EC600U/BC25系列该参数保留,不作为有效参数 |
- | `psc` | 主扰码,Primary Scrambling Code,EC200U/EC600U/BC25系列该参数保留,不作为有效参数 |
+| 参数 | 参数说明 |
+| -------------- | ------------------------------------------------------------ |
+| `state` | 网络注册状态,具体见下表 |
+| `lac` | 位置区码,范围 1 ~ 65534 |
+| `cid` | cell id,范围 0x00000000 ~ 0x0FFFFFFF,具体见`net.csqQueryPoll()`中返回值 |
+| ``rat`` | 接入技术,access technology,具体见后面表格 |
+| `reject_cause` | 注册被拒绝的原因,EC200U/EC600U/BC25系列该参数保留,不作为有效参数 |
+| `psc` | 主扰码,Primary Scrambling Code,EC200U/EC600U/BC25系列该参数保留,不作为有效参数 |
* 网络注册状态`state`枚举值见下表:
+
| 值 | 状态说明 |
| ---- | ------------------------------------------------------------ |
| 0 | not registered, MT is not currently searching an operator to register to |
@@ -467,6 +454,7 @@ net.getState()
| 11 | emergency bearer services only |
* 接入技术`access technology`
+
| 值 | 说明 |
| ---- | ------------------ |
| 0 | GSM |
@@ -482,22 +470,22 @@ net.getState()
| 10 | NONE |
> 注:BG77/BG95系列参照下表
->
-> | 值 | 说明 |
-> | ---- | ------------------ |
-> | 0 | GSM |
-> | 1 | GSM COMPACT |
-> | 2 | UTRAN |
-> | 3 | GSM wEGPRS |
-> | 4 | UTRAN wHSDPA |
-> | 5 | UTRAN wHSUPA |
-> | 6 | UTRAN wHSDPA HSUPA |
-> | 7 | E_UTRAN |
-> | 8 | UTRAN HSPAP |
-> | 9 | E_UTRAN_CA |
-> | 10 | E_UTRAN_NBIOT |
-> | 11 | E_UTRAN_EMTC |
-> | 12 | NONE |
+
+| 值 | 说明 |
+| ---- | ------------------ |
+| 0 | GSM |
+| 1 | GSM COMPACT |
+| 2 | UTRAN |
+| 3 | GSM wEGPRS |
+| 4 | UTRAN wHSDPA |
+| 5 | UTRAN wHSUPA |
+| 6 | UTRAN wHSDPA HSUPA |
+| 7 | E_UTRAN |
+| 8 | UTRAN HSPAP |
+| 9 | E_UTRAN_CA |
+| 10 | E_UTRAN_NBIOT |
+| 11 | E_UTRAN_EMTC |
+| 12 | NONE |
diff --git "a/docs/API_reference/zh/QuecPython\347\261\273\345\272\223/sim.md" "b/docs/API_reference/zh/QuecPython\347\261\273\345\272\223/sim.md"
index b13331e4c47fb2610325fda37e1bdd96248733a5..7d9b4af985d5c9ba2e0d20cf8596671006d6f432 100644
--- "a/docs/API_reference/zh/QuecPython\347\261\273\345\272\223/sim.md"
+++ "b/docs/API_reference/zh/QuecPython\347\261\273\345\272\223/sim.md"
@@ -1,4 +1,4 @@
-# `sim` - SIM卡相关功能
+# sim - SIM卡相关功能
提供sim卡相关功能的接口,如查询sim卡状态、iccid、imsi、电话号码等。
@@ -334,7 +334,8 @@ sim.readPhonebook(storage, start, end, username)
- `start` - 需要读取电话号码记录的起始编号,整型值,`start`为 `0` 表示不使用编号获取电话号码记,`start`应小于等于`end`。
- `end` - 需要读取电话号码记录的结束编号,整型值,必须满足:`end - start <= 20`。
-- `username` - 电话号码中的用户名,字符串类型,当 start为 0 时有效,暂不支持中文,最大长度不超过30字节。
注意:按username进行匹配时,并不是按完整的单词进行匹配,只要电话簿中已有记录的name是以username开头,那么就会匹配上。
+- `username` - 电话号码中的用户名,字符串类型,当 start为 0 时有效,暂不支持中文,最大长度不超过30字节。
+>注意:按username进行匹配时,并不是按完整的单词进行匹配,只要电话簿中已有记录的name是以username开头,那么就会匹配上。
**返回值描述:**
diff --git "a/docs/API_reference/zh/QuecPython\347\261\273\345\272\223/sms.md" "b/docs/API_reference/zh/QuecPython\347\261\273\345\272\223/sms.md"
index d3070ac6d0ced98a1e73eb73bd11b2395669cdd2..1910e4ca35c7fd967bf259a943ca7f66b91eafd1 100644
--- "a/docs/API_reference/zh/QuecPython\347\261\273\345\272\223/sms.md"
+++ "b/docs/API_reference/zh/QuecPython\347\261\273\345\272\223/sms.md"
@@ -1,4 +1,4 @@
-# `sms` - 短信功能
+# sms - 短信功能
模块功能:该模块提供短信功能相关方法,包括读取、发送、删除短信等方法。
@@ -118,11 +118,11 @@ sms.setSaveLoc(mem1, mem2, mem3)
* `mem1` - 读取和删除消息所在的位置,字符串类型,支持如下参数:
- | 值 | 含义 |
- | ------ | --------------------- |
- | `"SM"` | SIM消息存储
|
- | `"ME"` | 移动设备信息存储
|
- | `"MT"` | 暂不支持 |
+| 值 | 含义 |
+| ------ | --------------------- |
+| `"SM"` | SIM消息存储
|
+| `"ME"` | 移动设备信息存储
|
+| `"MT"` | 暂不支持 |
* `mem2` - 写入和发送消息所在的位置,字符串类型,支持参数同上`mem1`的值。
diff --git "a/docs/API_reference/zh/QuecPython\347\261\273\345\272\223/voiceCall.md" "b/docs/API_reference/zh/QuecPython\347\261\273\345\272\223/voiceCall.md"
index 48e49e6457bf1522c3c5e85683992d3a21e50422..8c851ce36510972e7173ba8c0012ecdec919e942 100644
--- "a/docs/API_reference/zh/QuecPython\347\261\273\345\272\223/voiceCall.md"
+++ "b/docs/API_reference/zh/QuecPython\347\261\273\345\272\223/voiceCall.md"
@@ -1,4 +1,4 @@
-# `voiceCall` - 电话功能
+# voiceCall - 电话功能
`voiceCall`模块提供电话功能相关接口。
@@ -387,22 +387,22 @@ voiceCall.setFw(reason, fwmode, phonenum)
* `reason` - 呼叫转移的条件,整型值,具体如下说明:
-| `reason`值 | 参数说明 |
-| ------- | ------------- |
-| 0 | 无条件的 |
-| 1 | 用户忙 |
-| 2 | 用户无响应 |
-| 3 | 用户不可达 |
+| 值 | 参数说明 |
+| -- | ------------- |
+| 0 | 无条件的 |
+| 1 | 用户忙 |
+| 2 | 用户无响应 |
+| 3 | 用户不可达 |
* `fwMode` - 对呼叫转移的控制,整型值,具体如下说明:
-| `fwMode`值 | 参数说明 |
-| ------- | ------------- |
-| 0 | 禁用 |
-| 1 | 启用 |
-| 2 | 查询状态 |
-| 3 | 注册 |
-| 4 | 擦除 |
+| 值 | 参数说明 |
+| -- | ------------- |
+| 0 | 禁用 |
+| 1 | 启用 |
+| 2 | 查询状态 |
+| 3 | 注册 |
+| 4 | 擦除 |
* `phonenum` - 呼叫转移的目标电话,字符串类型
@@ -424,11 +424,11 @@ voiceCall.setChannel(device)
* `device` - 输出通道,整型值,具体如下说明:
-| `device`值 | 参数说明 |
-| ------- | ------------- |
-| 0 | 听筒 |
-| 1 | 耳机 |
-| 2 | 喇叭 |
+| 值 | 参数说明 |
+| -- | ------------- |
+| 0 | 听筒 |
+| 1 | 耳机 |
+| 2 | 喇叭 |
**返回值:**
@@ -492,17 +492,19 @@ voiceCall.setAutoRecord(enable, recordType, recordMode, filename)
* `enable` - 使能开关,整型值,取值`【0/1】`,`0`:关闭自动录音功能 ,`1`:开启自动录音功能
* `recordType` - 录音文件类型,整型值,具体如下:
-| `recordType`值 | 说明 |
+
+| 值 | 说明 |
| -------------- | ---- |
| 0 | AMR |
| 1 | WAV |
* `recordMode` - 模式,整型值,具体如下:
-|`recordMode`值|说明 |
-|----------|--------|
-| 0 | RX |
-| 1 | TX |
-| 2 | MIX |
+
+| 值 |说明 |
+|-----|--------|
+| 0 | RX |
+| 1 | TX |
+| 2 | MIX |
* `filename` - 期望存储的文件名,字符串类型,需包含完整路径。
@@ -530,17 +532,19 @@ voiceCall.startRecord(recordType, recordMode, filename)
**参数:**
* `recordType` - 录音文件类型,整型值,具体如下:
-| `recordType`值 | 说明 |
-| -------------- | ---- |
-| 0 | AMR |
-| 1 | WAV |
+
+| 值 | 说明 |
+|-----| ---- |
+| 0 | AMR |
+| 1 | WAV |
* `recordMode` - 模式,整型值,具体如下:
-|`recordMode`值|说明 |
-|----------|--------|
-| 0 | RX |
-| 1 | TX |
-| 2 | MIX |
+
+| 值 |说明 |
+|------|--------|
+| 0 | RX |
+| 1 | TX |
+| 2 | MIX |
* `filename` - 期望存储的文件名,字符串类型,需包含完整路径。
@@ -621,17 +625,19 @@ voiceCall.startRecordStream(recordType, recordMode, callbackFun)
**参数:**
* `recordType` - 录音文件类型,整型值,具体如下:
-| `recordType`值 | 说明 |
-| -------------- | ---- |
-| 0 | AMR |
-| 1 | WAV |
+
+| 值 | 说明 |
+|-------| ---- |
+| 0 | AMR |
+| 1 | WAV |
* `recordMode` - 模式,整型值,具体如下:
-|`recordMode`值|说明 |
-|----------|--------|
-| 0 | RX |
-| 1 | TX |
-| 2 | MIX |
+
+| 值 |说明 |
+|------|--------|
+| 0 | RX |
+| 1 | TX |
+| 2 | MIX |
* `callbackFun` - 回调函数名,回调函数格式以及回调函数的参数说明如下:
```python
diff --git "a/docs/API_reference/zh/QuecPython\347\261\273\345\272\223/wifilocator.md" "b/docs/API_reference/zh/QuecPython\347\261\273\345\272\223/wifilocator.md"
index 1e467d3d5cf1e0827904f143e7df27465d615f52..04a8dcdc7beb8035b13599c290125dc25e124d8b 100644
--- "a/docs/API_reference/zh/QuecPython\347\261\273\345\272\223/wifilocator.md"
+++ "b/docs/API_reference/zh/QuecPython\347\261\273\345\272\223/wifilocator.md"
@@ -1,4 +1,4 @@
-# `class wifilocator` - WIFI定位
+# class wifilocator - WIFI定位
`wifilocator`对象提供WIFI定位功能,获取模组经纬度坐标信息。
diff --git a/docs/API_reference/zh/sidebar.yaml b/docs/API_reference/zh/sidebar.yaml
index 82161c27a3daccae9a48684d9bf2b3fbd07861e6..610348dc52257ed9df629d82b65f9d7e3342833e 100644
--- a/docs/API_reference/zh/sidebar.yaml
+++ b/docs/API_reference/zh/sidebar.yaml
@@ -37,6 +37,20 @@ items:
items:
- label: dataCall - 拨号
file: QuecPython类库/dataCall.md
+ - label: atcmd - 发送AT指令
+ file: QuecPython类库/atcmd.md
+ - label: sim - SIM卡
+ file: QuecPython类库/sim.md
+ - label: sms - 短信
+ file: QuecPython类库/sms.md
+ - label: voiceCall - 电话
+ file: QuecPython类库/voiceCall.md
+ - label: net - 网络
+ file: QuecPython类库/net.md
+ - label: cellLocator - 基站定位
+ file: QuecPython类库/cellLocator.md
+ - label: wifilocator - WIFI定位
+ file: QuecPython类库/wifilocator.md
- label: checkNet - 网络就绪检测
file: QuecPython类库/checkNet.md
- label: wifiScan - WiFi扫描