From a012d21ca80e1ff355a213f34fddcab881f0c087 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Arno=20Ding=28=E4=B8=81=E5=B5=A9=29?= Date: Wed, 30 Aug 2023 16:16:51 +0800 Subject: [PATCH 1/3] =?UTF-8?q?=E5=A2=9E=E5=8A=A0API=E8=B7=B3=E8=BD=AC?= =?UTF-8?q?=E5=8A=9F=E8=83=BD?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- docs/API_reference/zh/gnsslib/gnss.md | 2 +- docs/API_reference/zh/iotlib/checkNet.md | 8 +++---- docs/API_reference/zh/iotlib/dataCall.md | 8 +++---- docs/API_reference/zh/iotlib/net.md | 22 +++++++++---------- docs/API_reference/zh/iotlib/sim.md | 4 ++-- docs/API_reference/zh/iotlib/sms.md | 8 +++---- docs/API_reference/zh/medialib/audio.Audio.md | 2 +- docs/FAQ/zh/network/net.md | 2 +- docs/FAQ/zh/software/fs.md | 16 +++++++------- docs/FAQ/zh/software/threads.md | 2 +- 10 files changed, 37 insertions(+), 37 deletions(-) diff --git a/docs/API_reference/zh/gnsslib/gnss.md b/docs/API_reference/zh/gnsslib/gnss.md index 62143181..55e8cdf4 100644 --- a/docs/API_reference/zh/gnsslib/gnss.md +++ b/docs/API_reference/zh/gnsslib/gnss.md @@ -99,7 +99,7 @@ total_sen_num = 3, total_sat_num = 12 # 输出一组完整GPGSV语句总条数 gnss.getOriginalData() ``` -该接口用于返回从串口读取的原始GNSS数据，如果用户希望拿到原始GNSS数据，自己进行处理或者进行一些数据确认，可以通过该接口来获取。该接口在每次调用 `gnss.read_gnss_data(max_retry=1, debug=0)`接口后，返回的即本次读取的原始数据。 +该接口用于返回从串口读取的原始GNSS数据，如果用户希望拿到原始GNSS数据，自己进行处理或者进行一些数据确认，可以通过该接口来获取。该接口在每次调用 [`gnss.read_gnss_data(max_retry=1, debug=0)`](https://python.quectel.com/doc/API_reference/zh/gnsslib/gnss.html#%3Ccode%3Egnss.read_gnss_data%3C/code%3E)接口后，返回的即本次读取的原始数据。 **返回值描述** diff --git a/docs/API_reference/zh/iotlib/checkNet.md b/docs/API_reference/zh/iotlib/checkNet.md index 3df46b52..2731238e 100644 --- a/docs/API_reference/zh/iotlib/checkNet.md +++ b/docs/API_reference/zh/iotlib/checkNet.md @@ -25,7 +25,7 @@ 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表示激活成功。 | +| state | 整型 | 根据stage值，来表示不同的状态，具体如下：
stage = 1时，state表示 SIM卡的状态，范围0~21，每个状态值的详细说明，请参考[`sim.getStatus()`](https://python.quectel.com/doc/API_reference/zh/iotlib/sim.html#%3Ccode%3Esim.getStatus%3C/code%3E)方法的返回值说明；
stage = 2时，state表示网络注册状态，范围0~11，每个状态值的详细说明，请参考[`net.getState()`](https://python.quectel.com/doc/API_reference/zh/iotlib/net.html#%3Ccode%3Enet.getState%3C/code%3E)方法的返回值说明；
stage = 3时，state表示PDP Context激活状态，0表示没有激活成功，1表示激活成功。 | 如果网络已经就绪，则返回`(3,1)`，否则可参考如下说明来排查定位问题： @@ -51,16 +51,16 @@ checkNet.waitNetworkReady(timeout) 0或2 - 这种情况说明在超时时间内，模组一直没有注网成功，这时请按如下步骤排查问题：
（1）首先确认SIM卡状态是正常的，通过 sim 模块的sim.getStatus()接口获取，为1说明正常；
（2）如果SIM卡状态正常，确认当前信号强度，通过net模块的net.csqQueryPoll()接口获取，如果信号强度比较弱，那么可能是因为当前信号强度较弱导致短时间内注网不成功，可以增加超时时间或者换个信号比较好的位置再尝试；
（3）如果SIM卡状态正常，信号强度也较好，请确认使用的SIM卡是否已经欠费或流量不足；
（4）如果SIM卡没有欠费也没有流量不足，请确认使用的是否是物联网卡，如果是，请确认该SIM卡是否存在机卡绑定的情况；
（5）如果按照前述步骤依然没有发现解决问题，请联系我们的FAE反馈问题；最好将相应SIM卡信息，比如哪个运营商的卡、什么类型的卡、卡的IMSI等信息也一并提供，必要时可以将SIM卡寄给我们来排查问题。 + 这种情况说明在超时时间内，模组一直没有注网成功，这时请按如下步骤排查问题：
（1）首先确认SIM卡状态是正常的，通过 sim 模块的[sim.getStatus()](https://python.quectel.com/doc/API_reference/zh/iotlib/sim.html#%3Ccode%3Esim.getStatus%3C/code%3E)接口获取，为1说明正常；
（2）如果SIM卡状态正常，确认当前信号强度，通过net模块的[net.csqQueryPoll()](https://python.quectel.com/doc/API_reference/zh/iotlib/net.html#%3Ccode%3Enet.csqQueryPoll%3C/code%3E)接口获取，如果信号强度比较弱，那么可能是因为当前信号强度较弱导致短时间内注网不成功，可以增加超时时间或者换个信号比较好的位置再尝试；
（3）如果SIM卡状态正常，信号强度也较好，请确认使用的SIM卡是否已经欠费或流量不足；
（4）如果SIM卡没有欠费也没有流量不足，请确认使用的是否是物联网卡，如果是，请确认该SIM卡是否存在机卡绑定的情况；
（5）如果按照前述步骤依然没有发现解决问题，请联系我们的FAE反馈问题；最好将相应SIM卡信息，比如哪个运营商的卡、什么类型的卡、卡的IMSI等信息也一并提供，必要时可以将SIM卡寄给我们来排查问题。 其他值 - 请参考官方Wiki文档中net.getState()接口的返回值说明，确认注网失败原因。 + 请参考官方Wiki文档中[net.getState()](https://python.quectel.com/doc/API_reference/zh/iotlib/net.html#%3Ccode%3Enet.getState%3C/code%3E)接口的返回值说明，确认注网失败原因。 3 0 - 这种情况说明在超时时间内，PDP Context一直没有激活成功，请按如下步骤尝试：
（1）通过 sim 模块的sim.getState()接口获取sim卡状态，为1表示正常；
（2）通过 net 模块的net.getState()接口获取注网状态，为1表示正常；
（3）手动调用dataCall.activate(profileID)接口尝试激活，看看能否激活成功；
（4）如果手动激活成功了，但是开机自动激活失败，可联系我司相关人员协助分析。 + 这种情况说明在超时时间内，PDP Context一直没有激活成功，请按如下步骤尝试：
（1）通过 sim 模块的[sim.getStatus()](https://python.quectel.com/doc/API_reference/zh/iotlib/sim.html#%3Ccode%3Esim.getStatus%3C/code%3E)接口获取sim卡状态，为1表示正常；
（2）通过 net 模块的[net.getState()](https://python.quectel.com/doc/API_reference/zh/iotlib/net.html#%3Ccode%3Enet.getState%3C/code%3E)接口获取注网状态，为1表示正常；
（3）手动调用[dataCall.activate(profileID)](https://python.quectel.com/doc/API_reference/zh/iotlib/dataCall.html#%3Ccode%3EdataCall.activate%3C/code%3E)接口尝试激活，看看能否激活成功；
（4）如果手动激活成功了，但是开机自动激活失败，可联系我司相关人员协助分析。 1 diff --git a/docs/API_reference/zh/iotlib/dataCall.md b/docs/API_reference/zh/iotlib/dataCall.md index 054af6ee..2b136c2a 100644 --- a/docs/API_reference/zh/iotlib/dataCall.md +++ b/docs/API_reference/zh/iotlib/dataCall.md @@ -6,7 +6,7 @@ -> 用户使用不同运营商的SIM卡时，应配置对应运营商的APN信息；如果不配置或者配置错误，可能会导致模组注网失败或拨号失败，模组获取不到IP地址，无法上网。配置APN的方式，参考`dataCall.setPDPContext`方法。 +> 用户使用不同运营商的SIM卡时，应配置对应运营商的APN信息；如果不配置或者配置错误，可能会导致模组注网失败或拨号失败，模组获取不到IP地址，无法上网。配置APN的方式，参考[`dataCall.setPDPContext`](https://python.quectel.com/doc/API_reference/zh/iotlib/dataCall.html#%3Ccode%3EdataCall.setPDPContext%3C/code%3E)方法。 @@ -118,7 +118,7 @@ dataCall.getPDPContext(profileID) `(ipType, apn, username, password, authType)` -元组参数描述见`dataCall.setPDPContext`方法的参数描述。 +元组参数描述见[`dataCall.setPDPContext`](https://python.quectel.com/doc/API_reference/zh/iotlib/dataCall.html#%3Ccode%3EdataCall.setPDPContext%3C/code%3E)方法的参数描述。 @@ -154,7 +154,7 @@ dataCall.setAutoActivate(profileID, enable) ->如果用户没有使用`dataCall.setAutoActivate`方法和`dataCall.setAutoConnect`配置过，则默认开机对profileID为1的那一路进行自动激活和使能重连；否则按照用户的配置执行。 +>如果用户没有使用[`dataCall.setAutoActivate`](https://python.quectel.com/doc/API_reference/zh/iotlib/dataCall.html#%3Ccode%3EdataCall.setAutoActivate%3C/code%3E)方法和[`dataCall.setAutoConnect`](https://python.quectel.com/doc/API_reference/zh/iotlib/dataCall.html#%3Ccode%3EdataCall.setAutoConnect%3C/code%3E)配置过，则默认开机对profileID为1的那一路进行自动激活和使能重连；否则按照用户的配置执行。 > >支持该方法的模组：EC100Y/EC200N/EC600N/EC600S/EC800N/EG912N/EG915N/EC600M/EC800M/EG810M/EC200A/EC200U/EC600U/EG912U/EG915U/EC600G/EC800G/EC600E/EC800E/BG95系列。 @@ -188,7 +188,7 @@ dataCall.setAutoConnect(profileID, enable) -> 如果用户没有使用`dataCall.setAutoActivate`方法和`dataCall.setAutoConnect`配置过，则默认开机对profileID为1的那一路进行自动激活和使能重连；否则按照用户的配置执行。 +> 如果用户没有使用[`dataCall.setAutoActivate`](https://python.quectel.com/doc/API_reference/zh/iotlib/dataCall.html#%3Ccode%3EdataCall.setAutoActivate%3C/code%3E)方法和[`dataCall.setAutoConnect`](https://python.quectel.com/doc/API_reference/zh/iotlib/dataCall.html#%3Ccode%3EdataCall.setAutoConnect%3C/code%3E)配置过，则默认开机对profileID为1的那一路进行自动激活和使能重连；否则按照用户的配置执行。 > > 支持该方法的模组：EC100Y/EC200N/EC600N/EC600S/EC800N/EG912N/EG915N/EC600M/EC800M/EG810M/EC200A/EC200U/EC600U/EG912U/EG915U/EC600G/EC800G/EC600E/EC800E/BG95系列。 diff --git a/docs/API_reference/zh/iotlib/net.md b/docs/API_reference/zh/iotlib/net.md index 15118198..cfaa6ac8 100644 --- a/docs/API_reference/zh/iotlib/net.md +++ b/docs/API_reference/zh/iotlib/net.md @@ -4,7 +4,7 @@ ->建议用户使用不同运营商的SIM卡时，则配置对应运营商的APN信息；如果不配置或者配置错误，可能会导致模组无法注网。用户具体如何配置APN信息，参考`dataCall.setPDPContext`方法。 +>建议用户使用不同运营商的SIM卡时，则配置对应运营商的APN信息；如果不配置或者配置错误，可能会导致模组无法注网。用户具体如何配置APN信息，参考[`dataCall.setPDPContext`](https://python.quectel.com/doc/API_reference/zh/iotlib/dataCall.html#%3Ccode%3EdataCall.setPDPContext%3C/code%3E)方法。 @@ -360,7 +360,7 @@ net.nitzTime() | 参数 | 类型 | 参数意义 | | ---------- | ------ |-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| `date` | 字符串 | 基站时间，其中关于时区的部分，不同系列有所区别，具体见示例。
如果需要设置和获取时区，请使用`utime`模块的`setTimeZone(offset)`和`getTimeZone()`接口，
不同平台，这两个接口的单位都是小时，具体参考[`utime`](../QuecPython_classlib/utime.md)模块的说明。 | +| `date` | 字符串 | 基站时间，其中关于时区的部分，不同系列有所区别，具体见示例。
如果需要设置和获取时区，请使用`utime`模块的[`setTimeZone(offset)`](https://python.quectel.com/doc/API_reference/zh/stdlib/utime.html#%3Ccode%3Eutime.setTimeZone%3C/code%3E)和[`getTimeZone()`](https://python.quectel.com/doc/API_reference/zh/stdlib/utime.html#%3Ccode%3Eutime.getTimeZone%3C/code%3E)接口，
不同平台，这两个接口的单位都是小时，具体参考[`utime`](../QuecPython_classlib/utime.md)模块的说明。 | | `abs_time` | 整型 | 基站时间的绝对秒数表示 | | `leap_sec` | 整型 | 闰秒数 | @@ -430,7 +430,7 @@ net.getState() | -------------- | ------------------------------------------------------------ | | `state` | 网络注册状态，具体见下表 | | `lac` | 位置区码，范围 1 ~ 65534 | -| `cid` | cell id，范围 0x00000000 ~ 0x0FFFFFFF，具体见上面`net.getCellInfo()`中返回值 | +| `cid` | cell id，范围 0x00000000 ~ 0x0FFFFFFF，具体见上面[`net.getCellInfo()`](https://python.quectel.com/doc/API_reference/zh/iotlib/net.html#%3Ccode%3Enet.getCellInfo%3C/code%3E)中返回值 | | ``rat`` | 接入技术，access technology，具体见后面表格 | | `reject_cause` | 注册被拒绝的原因，EC200U/EC600U/EG915U/BC25系列该参数保留，不作为有效参数 | | `psc` | 主扰码，Primary Scrambling Code，EC200U/EC600U/EG915U/BC25系列该参数保留，不作为有效参数 | @@ -506,7 +506,7 @@ net.getState() net.getCi() ``` -该方法用于获取附近小区ID。该接口获取结果即为`net.getCellInfo()`接口获取结果中的cid集合。 +该方法用于获取附近小区ID。该接口获取结果即为[`net.getCellInfo()`](https://python.quectel.com/doc/API_reference/zh/iotlib/net.html#%3Ccode%3Enet.getCellInfo%3C/code%3E)接口获取结果中的cid集合。 **返回值描述：** @@ -529,7 +529,7 @@ net.getCi() net.getServingCi() ``` -该方法用于获取服务小区ID。该接口获取结果即为`net.getCellInfo()`接口获取结果中的cid集合。 +该方法用于获取服务小区ID。该接口获取结果即为[`net.getCellInfo()`](https://python.quectel.com/doc/API_reference/zh/iotlib/net.html#%3Ccode%3Enet.getCellInfo%3C/code%3E)接口获取结果中的cid集合。 **返回值描述：** @@ -553,7 +553,7 @@ net.getServingCi() net.getMnc() ``` -该方法用于获取附近小区的mnc。该接口获取结果即为`net.getCellInfo()`接口获取结果中的mnc集合。 +该方法用于获取附近小区的mnc。该接口获取结果即为[`net.getCellInfo()`](https://python.quectel.com/doc/API_reference/zh/iotlib/net.html#%3Ccode%3Enet.getCellInfo%3C/code%3E)接口获取结果中的mnc集合。 **返回值描述：** @@ -577,7 +577,7 @@ net.getMnc() net.getServingMnc() ``` -该方法用于获取服务小区的mnc。该接口获取结果即为`net.getCellInfo()`接口获取结果中的mnc集合。 +该方法用于获取服务小区的mnc。该接口获取结果即为[`net.getCellInfo()`](https://python.quectel.com/doc/API_reference/zh/iotlib/net.html#%3Ccode%3Enet.getCellInfo%3C/code%3E)接口获取结果中的mnc集合。 **返回值描述：** @@ -601,7 +601,7 @@ net.getServingMnc() net.getMcc() ``` -该方法用于获取附近小区的mcc。该接口获取结果即为`net.getCellInfo()`接口获取结果中的mcc集合。 +该方法用于获取附近小区的mcc。该接口获取结果即为[`net.getCellInfo()`](https://python.quectel.com/doc/API_reference/zh/iotlib/net.html#%3Ccode%3Enet.getCellInfo%3C/code%3E)接口获取结果中的mcc集合。 **返回值描述：** @@ -631,7 +631,7 @@ net.getMcc() net.getServingMcc() ``` -该方法用于获取服务小区的mcc。该接口获取结果即为`net.getCellInfo()`接口获取结果中的mcc集合。 +该方法用于获取服务小区的mcc。该接口获取结果即为[`net.getCellInfo()`](https://python.quectel.com/doc/API_reference/zh/iotlib/net.html#%3Ccode%3Enet.getCellInfo%3C/code%3E)接口获取结果中的mcc集合。 **返回值描述：** @@ -661,7 +661,7 @@ net.getServingMcc() net.getLac() ``` -该方法用于获取附近小区的Lac。该接口获取结果即为`net.getCellInfo()`接口获取结果中的lac集合。 +该方法用于获取附近小区的Lac。该接口获取结果即为[`net.getCellInfo()`](https://python.quectel.com/doc/API_reference/zh/iotlib/net.html#%3Ccode%3Enet.getCellInfo%3C/code%3E)接口获取结果中的lac集合。 **返回值描述：** @@ -685,7 +685,7 @@ net.getLac() net.getServingLac() ``` -该方法用于获取服务小区的Lac。该接口获取结果即为`net.getCellInfo()`接口获取结果中的lac集合。 +该方法用于获取服务小区的Lac。该接口获取结果即为[`net.getCellInfo()`](https://python.quectel.com/doc/API_reference/zh/iotlib/net.html#%3Ccode%3Enet.getCellInfo%3C/code%3E)接口获取结果中的lac集合。 **返回值描述：** diff --git a/docs/API_reference/zh/iotlib/sim.md b/docs/API_reference/zh/iotlib/sim.md index 7c045ea3..3fbf8aa4 100644 --- a/docs/API_reference/zh/iotlib/sim.md +++ b/docs/API_reference/zh/iotlib/sim.md @@ -386,7 +386,7 @@ sim.writePhonebook(storage, index, username, number) **参数描述：** -- `storage` - 电话号码存储位置，整型值，具体可选参数同上`sim.readPhonebook`中的`storage` ： +- `storage` - 电话号码存储位置，整型值，具体可选参数同上[`sim.readPhonebook`](https://python.quectel.com/doc/API_reference/zh/iotlib/sim.html#%3Ccode%3Esim.readPhonebook%3C/code%3E)中的`storage` ： - `index` - 需要写入电话号码记录的在电话簿中的编号，整型值，范围`1 ~ 500`。 - `username` - 电话号码的用户名，字符串类型，长度范围不超过30字节，暂不支持中文名。 @@ -665,7 +665,7 @@ def usrFun(args): > > EC600MCN_CC/EC600MCN_LA/EC600MCN_LC/EC600MCN_LE/EC600MCN_LF/EC800MCN_LA/EC800MCN_LC/EC800MCN_LE/EC600ECN_LD/EC800ECN_LD/EG912UGL_AA > -> 注意以下几点：
1、目标卡不存在或者目标卡状态异常；
2、目标卡是当前卡；
以上情况切卡方法`sim.switchCard`直接返回-1，不触发此接口设置的回调函数。 +> 注意以下几点：
1、目标卡不存在或者目标卡状态异常；
2、目标卡是当前卡；
以上情况切卡方法[`sim.switchCard`](https://python.quectel.com/doc/API_reference/zh/iotlib/sim.html#%3Ccode%3Esim.switchCard%3C/code%3E)直接返回-1，不触发此接口设置的回调函数。 diff --git a/docs/API_reference/zh/iotlib/sms.md b/docs/API_reference/zh/iotlib/sms.md index 81b9e38e..587d4fa6 100644 --- a/docs/API_reference/zh/iotlib/sms.md +++ b/docs/API_reference/zh/iotlib/sms.md @@ -204,9 +204,9 @@ sms.getSaveLoc() | 参数 | 类型 | 含义 | | -------------- | ------ | ------------------------------------------------------------ | -| `loc1` | 字符串 | 读取和删除消息所在的位置，具体含义同`sms.setSaveLoc`中`mem1`的值 | -| `loc2` | 字符串 | 写入和发送消息所在的位置，具体含义同`sms.setSaveLoc`中`mem1`的值 | -| `loc3` | 字符串 | 接收消息的存储位置，具体含义同`sms.setSaveLoc`中`mem1`的值 | +| `loc1` | 字符串 | 读取和删除消息所在的位置，具体含义同[`sms.setSaveLoc`](https://python.quectel.com/doc/API_reference/zh/iotlib/sms.html#%3Ccode%3Esms.setSaveLoc%3C/code%3E)中`mem1`的值 | +| `loc2` | 字符串 | 写入和发送消息所在的位置，具体含义同[`sms.setSaveLoc`](https://python.quectel.com/doc/API_reference/zh/iotlib/sms.html#%3Ccode%3Esms.setSaveLoc%3C/code%3E)中`mem1`的值 | +| `loc3` | 字符串 | 接收消息的存储位置，具体含义同[`sms.setSaveLoc`](https://python.quectel.com/doc/API_reference/zh/iotlib/sms.html#%3Ccode%3Esms.setSaveLoc%3C/code%3E)中`mem1`的值 | | `current_nums` | 整型 | 当前空间已有短信数量 | | `max_nums` | 整型 | 当前空间最大短信存储数量 | @@ -353,7 +353,7 @@ sms.getPduLength(pduMsg) sms.decodePdu(pduMsg, pduLen) ``` -该方法用于PDU解码，解析`sms.searchPduMsg()`接口读取到的PDU数据。 +该方法用于PDU解码，解析[`sms.searchPduMsg()`](https://python.quectel.com/doc/API_reference/zh/iotlib/sms.html#%3Ccode%3Esms.searchPduMsg%3C/code%3E)接口读取到的PDU数据。 **参数描述：** diff --git a/docs/API_reference/zh/medialib/audio.Audio.md b/docs/API_reference/zh/medialib/audio.Audio.md index bf00f58e..b524c936 100644 --- a/docs/API_reference/zh/medialib/audio.Audio.md +++ b/docs/API_reference/zh/medialib/audio.Audio.md @@ -103,7 +103,7 @@ Audio.stop() Audio.stopAll() ``` -该方法用于停止整个队列的播放。即当前如果正在播放Audio或者音频，并且队列中还有其他待播放内容，调用该方法后，不仅会停止当前播放的内容，还会清除这个队列的内容，不再播放任何内容。如果当前正在播放，且播放队列为空，那么调用该方法效果等同与stop()接口。 +该方法用于停止整个队列的播放。即当前如果正在播放Audio或者音频，并且队列中还有其他待播放内容，调用该方法后，不仅会停止当前播放的内容，还会清除这个队列的内容，不再播放任何内容。如果当前正在播放，且播放队列为空，那么调用该方法效果等同与[stop()](https://python.quectel.com/doc/API_reference/zh/medialib/audio.Audio.html#%3Ccode%3EAudio.stop%3C/code%3E)接口。 **返回值描述：** diff --git a/docs/FAQ/zh/network/net.md b/docs/FAQ/zh/network/net.md index 28b86634..8eda028d 100644 --- a/docs/FAQ/zh/network/net.md +++ b/docs/FAQ/zh/network/net.md @@ -60,7 +60,7 @@ ### **无法注册网络、注册网络慢、无法附着网络、附着网络慢的原因排查** -- 调用`sim.getStatus()`方法检查SIM卡是否识别。 +- 调用[`sim.getStatus()`](https://python.quectel.com/doc/API_reference/zh/iotlib/sim.html#%3Ccode%3Esim.getStatus%3C/code%3E)方法检查SIM卡是否识别。 - 检查下sim卡是否欠费，流量是否用完【4G模块有一种欠费表现：无法注册4G网络，可以注册2G网络】。【其他情况可以咨询卡商】 diff --git a/docs/FAQ/zh/software/fs.md b/docs/FAQ/zh/software/fs.md index 3cb43966..b2c6a69c 100644 --- a/docs/FAQ/zh/software/fs.md +++ b/docs/FAQ/zh/software/fs.md @@ -2,21 +2,21 @@ ### **ql_fs模块的作用是什么** -- 提供`path_exists`方法，判断文件是否存在。 +- 提供[`path_exists`](https://python.quectel.com/doc/API_reference/zh/syslib/ql_fs.html#%3Ccode%3Eql_fs.path_exists%3C/code%3E)方法，判断文件是否存在。 -- 提供`file_copy`方法，快速拷贝文件。 +- 提供[`file_copy`](https://python.quectel.com/doc/API_reference/zh/syslib/ql_fs.html#%3Ccode%3Eql_fs.file_copy%3C/code%3E)方法，快速拷贝文件。 -- 提供`path_dirname`方法，获取最后一级路径的前缀路径名。 +- 提供[`path_dirname`](https://python.quectel.com/doc/API_reference/zh/syslib/ql_fs.html#%3Ccode%3Eql_fs.path_dirname%3C/code%3E)方法，获取最后一级路径的前缀路径名。 -- 提供`path_getsize`方法，获取文件大小。 +- 提供[`path_getsize`](https://python.quectel.com/doc/API_reference/zh/syslib/ql_fs.html#%3Ccode%3Eql_fs.path_getsize%3C/code%3E)方法，获取文件大小。 -- 提供`mkdirs`方法，创建嵌套文件夹。 +- 提供[`mkdirs`](https://python.quectel.com/doc/API_reference/zh/syslib/ql_fs.html#%3Ccode%3Eql_fs.mkdirs%3C/code%3E)方法，创建嵌套文件夹。 -- 提供`rmdirs`方法，删除嵌套文件夹。 +- 提供[`rmdirs`](https://python.quectel.com/doc/API_reference/zh/syslib/ql_fs.html#%3Ccode%3Eql_fs.rmdirs%3C/code%3E)方法，删除嵌套文件夹。 -- 提供`touch`方法，快速创建文件。 +- 提供[`touch`](https://python.quectel.com/doc/API_reference/zh/syslib/ql_fs.html#%3Ccode%3Eql_fs.touch%3C/code%3E)方法，快速创建文件。 -- 提供`write_json`和`read_json`方法，快速读写json文件。 +- 提供`write_json`和[`read_json`](https://python.quectel.com/doc/API_reference/zh/syslib/ql_fs.html?highlight=read_json#%3Ccode%3Eql_fs.read_json%3C/code%3E)方法，快速读写json文件。 ### **为什么用uos.remove()删除不了文件？** diff --git a/docs/FAQ/zh/software/threads.md b/docs/FAQ/zh/software/threads.md index 387814f9..a06d8293 100644 --- a/docs/FAQ/zh/software/threads.md +++ b/docs/FAQ/zh/software/threads.md @@ -16,7 +16,7 @@ QuecPython 的多线程模块的实现继承于标准 Python 的_thread，没有提供信号量相关接口。 -如果想实现类似信号量的功能，可使用 互斥锁（`_thread.allocate_lock`方法）或消息队列（`Queue.queue`方法）。 +如果想实现类似信号量的功能，可使用 互斥锁（[`_thread.allocate_lock`](https://python.quectel.com/doc/API_reference/zh/stdlib/_thread.html#%3Ccode%3E_thread.allocate_lock%3C/code%3E)方法）或消息队列（[`queue.Queue`](https://python.quectel.com/doc/API_reference/zh/syslib/Queue.html#%3Ccode%3Equeue.Queue%3C/code%3E)方法）。 如果信号量的最大值只有1，可使用互斥锁或消息队列实现信号量的功能；如果信号量的值大于1，可使用消息队列实现信号量的功能。 -- Gitee From 903b5c9fb739d5cdb21426bc174736c5095014fa Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Arno=20Ding=28=E4=B8=81=E5=B5=A9=29?= Date: Wed, 30 Aug 2023 19:54:09 +0800 Subject: [PATCH 2/3] =?UTF-8?q?=E4=BF=AE=E6=AD=A3=E4=BC=A0=E6=84=9F?= =?UTF-8?q?=E5=99=A8=E7=9B=B8=E5=85=B3=E6=96=87=E6=A1=A3?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- docs/API_reference/zh/iotlib/checkNet.md | 6 +++--- docs/API_reference/zh/iotlib/net.md | 2 +- 2 files changed, 4 insertions(+), 4 deletions(-) diff --git a/docs/API_reference/zh/iotlib/checkNet.md b/docs/API_reference/zh/iotlib/checkNet.md index 2731238e..7591c93b 100644 --- a/docs/API_reference/zh/iotlib/checkNet.md +++ b/docs/API_reference/zh/iotlib/checkNet.md @@ -51,16 +51,16 @@ checkNet.waitNetworkReady(timeout) 0或2 - 这种情况说明在超时时间内，模组一直没有注网成功，这时请按如下步骤排查问题：
（1）首先确认SIM卡状态是正常的，通过 sim 模块的[sim.getStatus()](https://python.quectel.com/doc/API_reference/zh/iotlib/sim.html#%3Ccode%3Esim.getStatus%3C/code%3E)接口获取，为1说明正常；
（2）如果SIM卡状态正常，确认当前信号强度，通过net模块的[net.csqQueryPoll()](https://python.quectel.com/doc/API_reference/zh/iotlib/net.html#%3Ccode%3Enet.csqQueryPoll%3C/code%3E)接口获取，如果信号强度比较弱，那么可能是因为当前信号强度较弱导致短时间内注网不成功，可以增加超时时间或者换个信号比较好的位置再尝试；
（3）如果SIM卡状态正常，信号强度也较好，请确认使用的SIM卡是否已经欠费或流量不足；
（4）如果SIM卡没有欠费也没有流量不足，请确认使用的是否是物联网卡，如果是，请确认该SIM卡是否存在机卡绑定的情况；
（5）如果按照前述步骤依然没有发现解决问题，请联系我们的FAE反馈问题；最好将相应SIM卡信息，比如哪个运营商的卡、什么类型的卡、卡的IMSI等信息也一并提供，必要时可以将SIM卡寄给我们来排查问题。 + 这种情况说明在超时时间内，模组一直没有注网成功，这时请按如下步骤排查问题：
（1）首先确认SIM卡状态是正常的，通过 sim 模块的sim.getStatus()接口获取，为1说明正常；
（2）如果SIM卡状态正常，确认当前信号强度，通过net模块的net.csqQueryPoll()接口获取，如果信号强度比较弱，那么可能是因为当前信号强度较弱导致短时间内注网不成功，可以增加超时时间或者换个信号比较好的位置再尝试；
（3）如果SIM卡状态正常，信号强度也较好，请确认使用的SIM卡是否已经欠费或流量不足；
（4）如果SIM卡没有欠费也没有流量不足，请确认使用的是否是物联网卡，如果是，请确认该SIM卡是否存在机卡绑定的情况；
（5）如果按照前述步骤依然没有发现解决问题，请联系我们的FAE反馈问题；最好将相应SIM卡信息，比如哪个运营商的卡、什么类型的卡、卡的IMSI等信息也一并提供，必要时可以将SIM卡寄给我们来排查问题。 其他值 - 请参考官方Wiki文档中[net.getState()](https://python.quectel.com/doc/API_reference/zh/iotlib/net.html#%3Ccode%3Enet.getState%3C/code%3E)接口的返回值说明，确认注网失败原因。 + 请参考官方Wiki文档中net.getState()接口的返回值说明，确认注网失败原因。 3 0 - 这种情况说明在超时时间内，PDP Context一直没有激活成功，请按如下步骤尝试：
（1）通过 sim 模块的[sim.getStatus()](https://python.quectel.com/doc/API_reference/zh/iotlib/sim.html#%3Ccode%3Esim.getStatus%3C/code%3E)接口获取sim卡状态，为1表示正常；
（2）通过 net 模块的[net.getState()](https://python.quectel.com/doc/API_reference/zh/iotlib/net.html#%3Ccode%3Enet.getState%3C/code%3E)接口获取注网状态，为1表示正常；
（3）手动调用[dataCall.activate(profileID)](https://python.quectel.com/doc/API_reference/zh/iotlib/dataCall.html#%3Ccode%3EdataCall.activate%3C/code%3E)接口尝试激活，看看能否激活成功；
（4）如果手动激活成功了，但是开机自动激活失败，可联系我司相关人员协助分析。 + 这种情况说明在超时时间内，PDP Context一直没有激活成功，请按如下步骤尝试：
（1）通过 sim 模块的sim.getStatus()接口获取sim卡状态，为1表示正常；
（2）通过 net 模块的net.getState()接口获取注网状态，为1表示正常；
（3）手动调用dataCall.activate(profileID)接口尝试激活，看看能否激活成功；
（4）如果手动激活成功了，但是开机自动激活失败，可联系我司相关人员协助分析。 1 diff --git a/docs/API_reference/zh/iotlib/net.md b/docs/API_reference/zh/iotlib/net.md index cfaa6ac8..04fdab0b 100644 --- a/docs/API_reference/zh/iotlib/net.md +++ b/docs/API_reference/zh/iotlib/net.md @@ -360,7 +360,7 @@ net.nitzTime() | 参数 | 类型 | 参数意义 | | ---------- | ------ |-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| `date` | 字符串 | 基站时间，其中关于时区的部分，不同系列有所区别，具体见示例。
如果需要设置和获取时区，请使用`utime`模块的[`setTimeZone(offset)`](https://python.quectel.com/doc/API_reference/zh/stdlib/utime.html#%3Ccode%3Eutime.setTimeZone%3C/code%3E)和[`getTimeZone()`](https://python.quectel.com/doc/API_reference/zh/stdlib/utime.html#%3Ccode%3Eutime.getTimeZone%3C/code%3E)接口，
不同平台，这两个接口的单位都是小时，具体参考[`utime`](../QuecPython_classlib/utime.md)模块的说明。 | +| `date` | 字符串 | 基站时间，其中关于时区的部分，不同系列有所区别，具体见示例。
如果需要设置和获取时区，请使用`utime`模块的[`setTimeZone(offset)`](https://python.quectel.com/doc/API_reference/zh/stdlib/utime.html#%3Ccode%3Eutime.setTimeZone%3C/code%3E)和[`getTimeZone()`](https://python.quectel.com/doc/API_reference/zh/stdlib/utime.html#%3Ccode%3Eutime.getTimeZone%3C/code%3E)接口，
不同平台，这两个接口的单位都是小时，具体参考[`utime`](https://python.quectel.com/doc/API_reference/zh/stdlib/utime.html)模块的说明。 | | `abs_time` | 整型 | 基站时间的绝对秒数表示 | | `leap_sec` | 整型 | 闰秒数 | -- Gitee From 80d1c5c582fd4acd36eee8eb103d97388eb5c6fe Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Arno=20Ding=28=E4=B8=81=E5=B5=A9=29?= Date: Wed, 30 Aug 2023 20:53:01 +0800 Subject: [PATCH 3/3] =?UTF-8?q?=E6=B7=BB=E5=8A=A0API=E8=B7=B3=E8=BD=AC?= =?UTF-8?q?=E5=8A=9F=E8=83=BD=E8=A1=A5=E5=85=85?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- docs/API_reference/zh/iotlib/checkNet.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/API_reference/zh/iotlib/checkNet.md b/docs/API_reference/zh/iotlib/checkNet.md index 7591c93b..f9607e72 100644 --- a/docs/API_reference/zh/iotlib/checkNet.md +++ b/docs/API_reference/zh/iotlib/checkNet.md @@ -60,7 +60,7 @@ checkNet.waitNetworkReady(timeout) 3 0 - 这种情况说明在超时时间内，PDP Context一直没有激活成功，请按如下步骤尝试：
（1）通过 sim 模块的sim.getStatus()接口获取sim卡状态，为1表示正常；
（2）通过 net 模块的net.getState()接口获取注网状态，为1表示正常；
（3）手动调用dataCall.activate(profileID)接口尝试激活，看看能否激活成功；
（4）如果手动激活成功了，但是开机自动激活失败，可联系我司相关人员协助分析。 + 这种情况说明在超时时间内，PDP Context一直没有激活成功，请按如下步骤尝试：
（1）通过 sim 模块的sim.getStatus()接口获取sim卡状态，为1表示正常；
（2）通过 net 模块的net.getState()接口获取注网状态，为1表示正常；
（3）手动调用dataCall.activate(profileID)接口尝试激活，看看能否激活成功；
（4）如果手动激活成功了，但是开机自动激活失败，可联系我司相关人员协助分析。 1 -- Gitee