diff --git "a/docs/API_reference/zh/QuecPython\347\261\273\345\272\223/checkNet.md" "b/docs/API_reference/zh/QuecPython\347\261\273\345\272\223/checkNet.md" index e371c40dae896325722d0086370a7e34d045955e..95241b2d8457ab173d4a4ce23bba4030c20dda8e 100644 --- "a/docs/API_reference/zh/QuecPython\347\261\273\345\272\223/checkNet.md" +++ "b/docs/API_reference/zh/QuecPython\347\261\273\345\272\223/checkNet.md" @@ -1,6 +1,6 @@ # checkNet - 网络检测 -checkNet模块提供了方法来检测模组的网络状态是否已经就绪，同时提供了网络异常的排查方法与步骤。 +`checkNet`模块提供了方法来检测模组的网络状态是否已经就绪，同时提供了网络异常的排查方法与步骤。 @@ -24,8 +24,8 @@ checkNet.waitNetworkReady(timeout) | 参数 | 类型 | 含义 | | ----- | ---- | ------------------------------------------------------------ | -| stage | 整形 | 表示当前正在检测什么状态：
1 - 正在检测SIM卡状态
2 - 正在检测网络注册状态
3 - 正在检测PDP Context激活状态 | -| state | 整形 | 根据stage值，来表示不同的状态，具体如下：
stage = 1时，state表示 SIM卡的状态，范围0~21，每个值的详细说明，请参考`sim.getStatus()`方法的返回值说明；
stage = 2时，state表示网络注册状态，范围0~11，每个状态值的详细说明，请参考`net.getState()`方法的返回值说明；
stage = 3时，state表示PDP Context激活状态，0表示没有激活成功，1表示激活成功。 | +| stage | 整型 | 表示当前正在检测什么状态：
1 - 正在检测SIM卡状态；
2 - 正在检测网络注册状态；
3 - 正在检测PDP Context激活状态。 | +| state | 整型 | 根据stage值，来表示不同的状态，具体如下：
stage = 1时，state表示 SIM卡的状态，范围0~21，每个状态值的详细说明，请参考`sim.getStatus()`方法的返回值说明；
stage = 2时，state表示网络注册状态，范围0~11，每个状态值的详细说明，请参考`net.getState()`方法的返回值说明；
stage = 3时，state表示PDP Context激活状态，0表示没有激活成功，1表示激活成功。 | 如果网络已经就绪，则返回`(3,1)`，否则可参考如下说明来排查定位问题： @@ -38,24 +38,24 @@ checkNet.waitNetworkReady(timeout) 1 0 - 说明没插卡，或者卡槽松动，需要用户去检查确认； + 说明没插卡，或者卡槽松动，需要用户去检查确认。 其他值 - 请参考官方wiki文档中关于sim卡状态值的描述，确认sim卡当前是哪种状态； + 请参考官方wiki文档中关于sim卡状态值的描述，确认sim卡当前是哪种状态。 2 -1 - 这种情况说明在超时时间内，获取模组网络注册状态的API一直执行失败，在确认SIM卡可正常使用且能正常被模组识别的前提下，可联系我们的FAE反馈问题； + 这种情况说明在超时时间内，获取模组网络注册状态的API一直执行失败，在确认SIM卡可正常使用且能正常被模组识别的前提下，可联系我们的FAE反馈问题。 0或2 - 这种情况说明在超时时间内，模组一直没有注网成功，这时请按如下步骤排查问题：
（1）首先确认SIM卡状态是正常的，通过 sim 模块的 sim.getState() 接口获取，为1说明正常；
（2）如果SIM卡状态正常，确认当前信号强度，通过net模块的 net.csqQueryPoll() 接口获取，如果信号强度比较弱，那么可能是因为当前信号强度较弱导致短时间内注网不成功，可以增加超时时间或者换个信号比较好的位置再尝试；
（3）如果SIM卡状态正常，信号强度也较好，请确认使用的SIM卡是否已经欠费或流量不足；
（4）如果SIM卡没有欠费也没有流量不足，请确认使用的是否是物联网卡，如果是，请确认该SIM卡是否存在机卡绑定的情况；
（5）如果按照前述步骤依然没有发现解决问题，请联系我们的FAE反馈问题；最好将相应SIM卡信息，比如哪个运营商的卡、什么类型的卡、卡的IMSI等信息也一并提供，必要时可以将SIM卡寄给我们来排查问题； + 这种情况说明在超时时间内，模组一直没有注网成功，这时请按如下步骤排查问题：
（1）首先确认SIM卡状态是正常的，通过 sim 模块的 sim.getState() 接口获取，为1说明正常；
（2）如果SIM卡状态正常，确认当前信号强度，通过net模块的 net.csqQueryPoll() 接口获取，如果信号强度比较弱，那么可能是因为当前信号强度较弱导致短时间内注网不成功，可以增加超时时间或者换个信号比较好的位置再尝试；
（3）如果SIM卡状态正常，信号强度也较好，请确认使用的SIM卡是否已经欠费或流量不足；
（4）如果SIM卡没有欠费也没有流量不足，请确认使用的是否是物联网卡，如果是，请确认该SIM卡是否存在机卡绑定的情况；
（5）如果按照前述步骤依然没有发现解决问题，请联系我们的FAE反馈问题；最好将相应SIM卡信息，比如哪个运营商的卡、什么类型的卡、卡的IMSI等信息也一并提供，必要时可以将SIM卡寄给我们来排查问题。 其他值 - 请参考官方Wiki文档中 net.getState() 接口的返回值说明，确认注网失败原因； + 请参考官方Wiki文档中 net.getState() 接口的返回值说明，确认注网失败原因。 3 @@ -72,6 +72,7 @@ checkNet.waitNetworkReady(timeout) + **示例：** ```python @@ -79,7 +80,7 @@ import checkNet if __name__ == '__main__': stage, state = checkNet.waitNetworkReady(30) - if state == 3 and state == 1: + if stage == 3 and state == 1: print('Network connection successful.') else: print('Network connection failed, stage={}, state={}'.format(stage, state)) diff --git "a/docs/API_reference/zh/QuecPython\347\261\273\345\272\223/dataCall.md" "b/docs/API_reference/zh/QuecPython\347\261\273\345\272\223/dataCall.md" index db3b421f1e91b14816ad3c20afc9223b948555d0..1cf22945fafa919da4d0a6b9421d4cb680a28468 100644 --- "a/docs/API_reference/zh/QuecPython\347\261\273\345\272\223/dataCall.md" +++ "b/docs/API_reference/zh/QuecPython\347\261\273\345\272\223/dataCall.md" @@ -6,7 +6,7 @@ -> 强烈建议用户使用不同运营商的SIM卡时，配置对应运营商的APN信息；如果不配置或者配置错误，可能会导致模组注网失败或拨号失败，模组获取不到IP地址，无法上网。配置APN的方式，参考`dataCall.setPDPContext`方法。 +> 用户使用不同运营商的SIM卡时，应配置对应运营商的APN信息；如果不配置或者配置错误，可能会导致模组注网失败或拨号失败，模组获取不到IP地址，无法上网。配置APN的方式，参考`dataCall.setPDPContext`方法。 @@ -66,7 +66,7 @@ dataCall.setPDPContext(profileID, ipType, apn, username, password, authType) - `password` - 密码，字符串类型，可为空，为空直接写`''`，范围0~64字节。 -- `authType` - APN鉴权方式，整形值，取值范围见下表枚举： +- `authType` - APN鉴权方式，整型值，取值范围见下表枚举： | 值 | 含义 | | ---- | --------- | @@ -267,8 +267,8 @@ def netCallback(args): | 参数 | 类型 | 含义 | | ------- | ---- | ------------------------------------------------ | -| args[0] | 整形 | PDP上下文ID，表示当前是哪一路PDP网络状态发生变化 | -| args[1] | 整形 | 网络状态，0表示网络断开，1表示网络连接成功 | +| args[0] | 整型 | PDP上下文ID，表示当前是哪一路PDP网络状态发生变化 | +| args[1] | 整型 | 网络状态，0表示网络断开，1表示网络连接成功 | **返回值描述：** @@ -392,10 +392,10 @@ dataCall.getInfo(profileID, ipType) | 参数 | 类型 | 含义 | | --------- | ------ | ------------------------------------------------------------ | -| profileID | 整形 | PDP上下文ID | -| ipType | 整形 | IP协议类型，有如下几个值：
0表示IPv4
1表示IPv6
2表示IPv4和IPv6 | -| state | 整形 | IPv4或IPv6的拨号状态
0表示未拨号或拨号失败
1表示拨号成功 | -| reconnect | 整形 | 拨号重连标志，保留参数，暂未使用 | +| profileID | 整型 | PDP上下文ID | +| ipType | 整型 | IP协议类型，有如下几个值：
0表示IPv4
1表示IPv6
2表示IPv4和IPv6 | +| state | 整型 | IPv4或IPv6的拨号状态
0表示未拨号或拨号失败
1表示拨号成功 | +| reconnect | 整型 | 拨号重连标志，保留参数，暂未使用 | | addr | 字符串 | IPv4或IPv6的地址，具体取决于输入参数ipType的值：
ipType为0，addr为IPv4地址
ipType为1，addr为IPv6地址 | | priDNS | 字符串 | 主要DNS服务器地址 | | secDNS | 字符串 | 辅助DNS服务器地址 | diff --git "a/docs/API_reference/zh/QuecPython\347\261\273\345\272\223/wifiScan.md" "b/docs/API_reference/zh/QuecPython\347\261\273\345\272\223/wifiScan.md" index 90db7130a223568a281167a9acb99bfeb5965af3..bb916973486d120ae75d3779c58ca1494b0f070a 100644 --- "a/docs/API_reference/zh/QuecPython\347\261\273\345\272\223/wifiScan.md" +++ "b/docs/API_reference/zh/QuecPython\347\261\273\345\272\223/wifiScan.md" @@ -70,7 +70,7 @@ wifiScan.setCfgParam(timeout, round, maxNums[, priority]) **参数描述：** -* `timeout` - 超时时间，整形值；当触发超时会主动上报已扫描到的热点信息，若在超时前扫描到设置的热点个数会结束扫描并返回扫描结果。参数范围：4~60s。 +* `timeout` - 超时时间，整型值；当触发超时会主动上报已扫描到的热点信息，若在超时前扫描到设置的热点个数会结束扫描并返回扫描结果。参数范围：4~60s。 * `round` - 扫描轮数，整型值，达到扫描轮数后，会结束扫描并返回扫描结果。参数范围：1~3次。 * `maxNums` - 最大扫描数量，整型值，当扫描热点数量达到设置的最大个数，会结束扫描并返回扫描结果。参数范围：4~30个。 * `priority` - 扫描业务的优先级，整型值，可选参数，范围0~1。`0`表示网络业务优先，`1`表示WiFi扫描业务优先。网络业务优先时，当有数据业务发起时会中断WiFi扫描。WiFi扫描业务优先时，当有数据业务发起时，不会建立RRC连接，保障WiFi扫描正常执行，扫描结束后才会建立RRC连接。