From 3ade1b8d5958d4c7e45356a53f244d0c6a0d8a02 Mon Sep 17 00:00:00 2001 From: "Rich.wu" Date: Mon, 13 Mar 2023 11:43:55 +0800 Subject: [PATCH 1/2] =?UTF-8?q?docs=20(network):=20=E6=A0=B9=E6=8D=AEST?= =?UTF-8?q?=E7=9A=84=E6=A3=80=E6=9F=A5=E7=BB=93=E6=9E=9C=E4=BF=AE=E6=94=B9?= =?UTF-8?q?=E9=83=A8=E5=88=86=E9=97=AE=E9=A2=98=E3=80=82?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit 固件版本: N/A 是否需要文案翻译: 否 ######################################################################################## # # # 示例： # # # # fix (network): 重复创建并关闭socket一定次数后，无法再次创建socket。 # # # # 1. 调用select接口并在其它线程调用socket.close()时，socket引用计数没有自减， # # 由于socket总数（即引用计数）有上限，导致创建一定数量的socket无法再次创建socket。 # # # # 2. 调用socket.close()释放资源时，将引用计数自减，及时释放出被占用的资源，修复该问题。# # # # 固件版本：EC600MCNLAR02_QPY # # # # 是否需要文案翻译: 是 # # # ######################################################################################## # # # 说明： # # # # <提交类型> 用于说明提交的类型，一般有以下几种： # # - feat: 新增feature。 # # - fix: 修复bug。 # # - docs: 仅仅修改了文档，如readme.md。 # # - style: 仅仅是对格式进行修改，如逗号、缩进、空格等。不改变代码逻辑。 # # - refactor: 代码重构，没有新增功能或修复bug。 # # - perf: 优化相关，如提升性能、用户体验等。 # # - test: 测试用例，包括单元测试、集成测试。 # # - chore: 改变构建流程、或者增加依赖库、工具等。 # # - revert: 版本回滚。 # # # # <功能范围> 用于说明提交影响的功能范围。 # # # # <修改点简述> 提交目的的简短描述。 # # # # <修改点详述> 用于详细描述修改点，可选。不填写，请删除该行；若填写，请描述以下内容： # # - 为何进行修改 # # - 如何解决问题的 # # - 是否有副作用（必要时） # # # ######################################################################################## --- .../atcmd.md" | 6 +- .../cellLocator.md" | 15 +++-- .../net.md" | 53 ++++++++++++------ .../sim.md" | 55 ++++++++++--------- .../sms.md" | 35 ++++++++++-- .../voiceCall.md" | 40 +++++++------- .../wifilocator.md" | 10 +--- docs/API_reference/zh/sidebar.yaml | 10 ++-- 8 files changed, 132 insertions(+), 92 deletions(-) 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 0f4ecde9..30a5669b 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,6 +1,6 @@ # atcmd - 发送AT指令功能 -提供发送AT指令的方法，使模组能够通过Python代码发送AT指令。 +模块功能：提供发送AT指令的方法，使模组能够通过Python代码发送AT指令。 @@ -12,7 +12,7 @@ atcmd.sendSync(atcmd,resp,include_str,timeout) ``` -该方法用于对模组发送AT指令。 +该方法用于向模组发送AT指令。 **参数描述：** @@ -22,7 +22,7 @@ atcmd.sendSync(atcmd,resp,include_str,timeout) | 值 | 含义 | | ---------- | ------------------------------------------------------------ | -| `空字符串` | 获取AT指令返回的所有数据(不包含‘OK’等结果性的字符数据)放入`resp`参数中 | +| `空字符串` | 获取AT指令返回的所有数据(不包含‘OK’等结果性的字符数据)放入`resp`参数中; | | `不为空` | 筛选包含关键字的数据放入`resp`参数中。 | * `timeout` - 超时时间，整型值，单位/秒。 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 2e2966a7..d835b8ba 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,6 +1,6 @@ # cellLocator - 基站定位 -`cellLocator` 提供基站定位功能，获取模组经纬度坐标信息。 +模块功能： 提供基站定位功能，获取模组经纬度坐标信息。 @@ -20,12 +20,11 @@ cellLocator.getLocation(serverAddr, port, token, timeout [, profileIdx]) **参数描述：** -* `serverAddr` - 服务器域名，字符串类型，长度必须小于255 bytes，目前仅支持 “[www.queclocator.com”](http://www.queclocator.xn--com-9o0a/) -* `port` - 服务器端口，整型值，目前仅支持 80 端口 -* `token` - 密钥，字符串类型，16位字符组成，需要申请 -* `timeout` -设置超时时间，整型值，范围1-300s，默认300s -* `profileIdx` - PDP上下文ID，整型值，可选参数，默认为当前拨号成功的那一路，设置其他值可能需要专用apn与密码才能设置成功； -范围如下：EC600N/EC600S/EC800N，范围：1 ~ 8；EC200U/EC600U，范围：1 ~ 7。 +* `serverAddr` - 服务器域名，字符串类型，长度必须小于255 bytes，目前仅支持 “[www.queclocator.com”](http://www.queclocator.xn--com-9o0a/)。 +* `port` - 服务器端口，整型值，目前仅支持 80 端口。 +* `token` - 密钥，字符串类型，16位字符组成，需要申请。 +* `timeout` -设置超时时间，整型值，范围1-300s，默认300s。 +* `profileIdx` - PDP上下文ID，整型值，可选参数，默认为当前拨号成功的那一路，设置其他值可能需要专用apn与密码才能设置成功；
范围如下：EC600N/EC600S/EC800N，范围：1 ~ 8；EC200U/EC600U，范围：1 ~ 7。 **返回值描述：** @@ -49,7 +48,7 @@ cellLocator.getLocation(serverAddr, port, token, timeout [, profileIdx]) `5` – 指定的PDP网络未连接，请确认PDP是否正确 -`6` – 获取坐标出错； +`6` – 获取坐标出错。 **示例：** 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 8f748a3e..6a45ae38 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,10 +1,10 @@ # net - 网络相关功能 -`net`模块包含了模组网络相关的功能，提供配置和查询网络模式信息等接口，比如获取注网状态，设置搜网模式等。 +模块功能：该模块包含了模组网络相关的功能，提供配置和查询网络模式信息等接口，比如获取注网状态，设置搜网模式等。 ->注： 建议用户使用不同运营商的SIM卡时，则配置对应运营商的APN信息；如果不配置或者配置错误，可能会导致模组无法注网。用户具体如何配置APN信息，参考`dataCall.setPDPContext`方法。 +>注意： 建议用户使用不同运营商的SIM卡时，则配置对应运营商的APN信息；如果不配置或者配置错误，可能会导致模组无法注网。用户具体如何配置APN信息，参考`dataCall.setPDPContext`方法。 @@ -20,7 +20,7 @@ net.csqQueryPoll() **返回值描述：** - 成功返回整型的csq信号强度值，失败返回整型值`-1`，返回值为`99`表示异常； + 成功返回整型的csq信号强度值，失败返回整型值`-1`，返回值为`99`表示异常。 @@ -107,7 +107,7 @@ net.getCellInfo([sinrEnable]) ->注： +>注意： > >* 该接口搜小区时会一直阻塞，一般是3-5秒，在无信号的地方会更长 >* `sinrEnable`为可选参，不支持的平台可不写，不写默认不获取sinr @@ -118,6 +118,7 @@ net.getCellInfo([sinrEnable]) **示例：** ```python +>>> import net >>> net.getCellInfo() ([], [], [(0, 232301375, 1120, 17, 378, 26909, 1850, -66, -8), (3, 110110494, 1120, 17, 10, 26909, 2452, -87, -17), (3, 94542859, 1120, 1, 465, 56848, 1650, -75, -10), (3, 94472037, 1120, 1, 369, 56848, 3745, -84, -20)]) @@ -171,7 +172,7 @@ net.getConfig() ->BC25系列不支持此方法; +>注意：BC25系列不支持此方法; > >BG95-M1系列仅支持CATM制式； > @@ -184,6 +185,7 @@ net.getConfig() **示例：** ```python +>>> import net >>>net.getConfig () (8, False) ``` @@ -222,6 +224,7 @@ net.setConfig(mode [, roaming]) **示例：** ```python +>>> import net >>>net.setConfig(6) 0 @@ -247,10 +250,10 @@ net.getNetMode() | 参数 | 类型 | 参数说明 | | ---------------- | ------ | ------------------------ | -| `selection_mode` | 整型值 | 方式，0 - 自动，1 - 手动 | +| `selection_mode` | 整型 | 方式，0 - 自动，1 - 手动 | | `mcc` | 字符串 | 移动设备国家代码 | | `mnc` | 字符串 | 移动设备网络代码 | -| `act` | 整型值 | 首选网络的ACT模式 | +| `act` | 整型 | 首选网络的ACT模式 | `ACT`模式枚举值参照下表： @@ -289,6 +292,7 @@ BG95系列模组`ACT`模式枚举值参照下表： **示例：** ```python +>>> import net >>> net.getNetMode() (0, '460', '46', 7) ``` @@ -341,7 +345,7 @@ net.getSignal([sinrEnable]) ->注： +>注意： > >* `sinrEnable`为可选参，不支持的平台可不写，不写默认不获取sinr >* BC25系列不支持获取sinr，其余模组型号均支持 @@ -351,6 +355,7 @@ net.getSignal([sinrEnable]) **示例：** ```python +>>> import net >>>net.getSignal() ([99, 99, 255, 255], [-51, -76, -5, 255]) >>>net.getSignal(0) @@ -377,13 +382,14 @@ net.nitzTime() | 参数 | 类型 | 参数意义 | | ---------- | ------ | ------------------------------------------------------------ | -| `date` | 字符串 | 基站时间，其中关于时区的部分，不同系列有所区别，具体见示例。
如果需要设置和获取时区，请使用`utime`模块的`setTimeZone(offset)`和`getTimeZone()`接口，
不同平台，这两个接口的单位都是小时，具体参考`utime`模块的说明。 | +| `date` | 字符串 | 基站时间，其中关于时区的部分，不同系列有所区别，具体见示例。
如果需要设置和获取时区，请使用`utime`模块的`setTimeZone(offset)`和`getTimeZone()`接口，
不同平台，这两个接口的单位都是小时，具体参考[`utime`](../QuecPython标准库/utime.md)模块的说明。 | | `abs_time` | 整型 | 基站时间的绝对秒数表示 | | `leap_sec` | 整型 | 闰秒数 | **示例：** ```python +>>> import net >>> net.nitzTime() # EC100Y/EC200N/EC600N/EC600S/EC800N/EG912N/EG915N/EC600M/EC800M/EG810M/EC200A系列的返回值，时区单位小时，这里8即表示东八区 ('21/10/26 06:08:03 8 0', 1635228483, 0) @@ -419,6 +425,7 @@ net.operatorName() **示例：** ```python +>>> import net >>> net.operatorName() ('CHN-UNICOM', 'UNICOM', '460', '01') ``` @@ -445,7 +452,7 @@ net.getState() | -------------- | ------------------------------------------------------------ | | `state` | 网络注册状态，具体见下表 | | `lac` | 位置区码，范围 1 ~ 65534 | -| `cid` | cell id，范围 0x00000000 ~ 0x0FFFFFFF，具体见`net.getCellInfo()`中返回值 | +| `cid` | cell id，范围 0x00000000 ~ 0x0FFFFFFF，具体见上面`net.getCellInfo()`中返回值 | | ``rat`` | 接入技术，access technology，具体见后面表格 | | `reject_cause` | 注册被拒绝的原因，EC200U/EC600U/BC25系列该参数保留，不作为有效参数 | | `psc` | 主扰码，Primary Scrambling Code，EC200U/EC600U/BC25系列该参数保留，不作为有效参数 | @@ -485,7 +492,7 @@ net.getState() -> 注：BG77/BG95系列参照下表 +> 注意：BG77/BG95系列参照下表 | 值 | 说明 | | ---- | ------------------ | @@ -506,6 +513,7 @@ net.getState() **示例：** ```python +>>> import net >>> net.getState() ([11, 26909, 232301323, 7, 0, 466], [0, 26909, 232301323, 7, 0, 0]) ``` @@ -552,6 +560,7 @@ net.getServingCi() **示例：** ```python +>>> import net >>> net.getServingCi() 94938399 ``` @@ -577,6 +586,7 @@ net.getMnc() **示例：** ```python +>>> import net >>> net.getMnc() [0, 0] ``` @@ -598,6 +608,7 @@ net.getServingMnc() **示例：** ```python +>>> import net >>> net.getServingMnc() 1 ``` @@ -629,6 +640,7 @@ net.getMcc() **示例：** ```python +>>> import net >>> net.getMcc() [1120, 0] ``` @@ -656,6 +668,7 @@ net.getServingMcc() **示例：** ```python +>>> import net >>> net.getServingMcc() 1120 ``` @@ -681,6 +694,7 @@ net.getLac() **示例：** ```python +>>> import net >>> net.getLac() [21771, 0] ``` @@ -702,6 +716,7 @@ net.getServingLac() **示例：** ```python +>>> import net >>> net.getServingLac() 56848 ``` @@ -731,6 +746,7 @@ net.getModemFun() **示例：** ```python +>>> import net >>> net.getModemFun() 1 ``` @@ -767,6 +783,7 @@ net.setModemFun(fun [, rst]) **示例：** ```python +>>> import net >>> net.setModemFun(4) 0 ``` @@ -829,11 +846,11 @@ net.setBand(netRat, gsmBand, bandTuple) **返回值描述：** - 设置成功返回整型`0`，失败返回整型`-1`。 + 设置成功返回整型值`0`，失败返回整型值`-1`。 ->注: +>注意： >* 当前可支持模组型号：BG95系列/EG912NENAA >* BG95不支持设置上述模式1(LTE)下的`band` >* EG912NENAA仅支持上述模式0(GSM)和模式1(LTE) @@ -980,7 +997,7 @@ net.getBand(netRat) ->注: +>注意： >* 当前可支持模组型号：BG95系列/EG912NENAA >* BG95不支持设置上述模式1(LTE)下的`band` >* EG912NENAA仅支持上述模式0(GSM)和模式1(LTE) @@ -990,7 +1007,8 @@ net.getBand(netRat) **示例：** ```python -net.getBand(2) +>>> import net +>>> net.getBand(2) '0x10000200000000090e189f' # 这是字符串，用户如果需要int型，可通过int(data)来自行转换 ``` @@ -1006,11 +1024,11 @@ net.bandRst() **返回值描述：** -成功返回整型`0`，失败返回整型`-1`。 +成功返回整型值`0`，失败返回整型值`-1`。 ->当前可支持模组型号：EG912NENAA +>注意：当前可支持模组型号：EG912NENAA @@ -1021,6 +1039,7 @@ net.bandRst() 先设置成其他band，调用该接口，看是否成功恢复成初始值 EG912NENAA平台初始值：gsm_band:0x3(EGSM900/DCS1800 ) lte_band:0x8000000000480800D5(B1/B3/B5/B7/B8/B20/B28/B31/B72 ) ''' +>>> import net >>> net.bandRst() 0 ``` \ No newline at end of file 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 ec5e4bc0..2a316e37 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,6 +1,6 @@ -# sim - SIM卡相关功能 +# sim - SIM卡功能 -提供sim卡相关功能的接口，如查询sim卡状态、iccid、imsi、电话号码等。 +模块功能：提供sim卡相关功能的接口，如查询sim卡状态、iccid、imsi、电话号码等。 @@ -176,18 +176,12 @@ sim.enablePin(pin) **参数描述：** -- `pin` - PIN码，字符串类型，一般默认是‘1234’，最大长度不超过15字节。 +- `pin` - PIN码，字符串类型，一般默认是‘1234’，最大长度不超过15位数字。 **返回值描述：** 返回一个整型值，`0`表示成功，`-1`表示失败。 - - -> BC25系列PIN密码最大支持四位字符串。 - - - **示例：** ```python @@ -207,7 +201,7 @@ sim.disablePin(pin) **参数描述：** -- `pin` - PIN码，字符串类型，一般默认是‘1234’，最大长度不超过15字节。 +- `pin` - PIN码，字符串类型，一般默认是‘1234’，最大长度不超过15位数字。 **返回值描述：** @@ -232,7 +226,7 @@ PIN码验证：用于SIM卡开启PIN码验证后，如果需要启用SIM卡， **参数描述：** -- `pin` - PIN码，字符串类型，一般默认是‘1234’，最大长度不超过15字节。 +- `pin` - PIN码，字符串类型，一般默认是‘1234’，最大长度不超过15位数字。 **返回值描述：** @@ -257,8 +251,8 @@ sim.changePin(oldPin, newPin) **参数描述：** -- `oldPin` - 旧的PIN码，字符串类型，最大长度不超过15字节。 -- `newPin` - 新的PIN码，字符串类型，最大长度不超过15字节。 +- `oldPin` - 旧的PIN码，字符串类型，最大长度不超过15位数字。 +- `newPin` - 新的PIN码，字符串类型，最大长度不超过15位数字。 **返回值描述：** @@ -281,26 +275,21 @@ sim.changePin(oldPin, newPin) sim.unblockPin(puk, newPin) ``` -该方法用于SIM卡解锁：当多次输入PIN/PIN2码错误需要用PUK码解锁。如果PUK码输入错误10次，SIM卡将永久锁定自动报废。 +该方法用于SIM卡解锁：当多次输入PIN码错误需要用PUK码解锁。如果PUK码输入错误10次，SIM卡将永久锁定自动报废。 **参数描述：** -- `puk` - PUK码，字符串类型，长度8位数字，最大长度不超过15字节。 -- `newPin` - 新PIN码，字符串类型，最大长度不超过15字节。 +- `puk` - PUK码，字符串类型，长度8位数字，最大长度不超过15位数字。 +- `newPin` - 新PIN码，字符串类型，最大长度不超过15位数字。 **返回值描述：** 返回一个整型值，`0`表示成功，`-1`表示失败。 - - -> BC25系列PIN密码最大支持四位字符串；PUK码最大支持八位字符串。 - - - **示例：** ```python +>>> import sim >>> sim.unblockPin("12345678", "0000") 0 ``` @@ -319,7 +308,7 @@ sim.readPhonebook(storage, start, end, username) **参数描述：** -- `storage` - 需要读取电话号码记录的电话本存储位置，整型值，可选参数值如下： +- `storage` -电话号码存储位置，整型值，可选参数值如下： | 值 | 含义 | | ---- | ------------------------------------------------------------ | @@ -361,7 +350,7 @@ sim.readPhonebook(storage, start, end, username) >注意： > ->- BC25系列不支持此功能的方法。 +>- EC100Y/EC200N/EC600N/EC600S/EC800N/EG912N/EG915N/EC600MCNLE/EC600MCNLA/EC800MCNLA/EC800MCNLE/EC800MCNGA/EG810M/EC200A系列支持此方法。 > >- 按username进行匹配时，并不是按完整的单词进行匹配，只要电话簿中已有记录的name是以username开头，那么就会匹配上。 @@ -370,6 +359,7 @@ sim.readPhonebook(storage, start, end, username) **示例：** ```python +>>> import sim >>> sim.readPhonebook(9, 1, 4, "") (4,[(1,'Tom','15544272539'),(2,'Pony','15544272539'),(3,'Jay','18144786859'),(4,'Pondy','15544282538')]) >>> sim.readPhonebook(9, 0, 0, "Tom") @@ -392,7 +382,7 @@ sim.writePhonebook(storage, index, username, number) **参数描述：** -- `storage` - 需要写入电话号码记录的电话本存储位置，整型值，具体可选参数同上`sim.readPhonebook`中的`storage` ： +- `storage` - 电话号码存储位置，整型值，具体可选参数同上`sim.readPhonebook`中的`storage` ： - `index` - 需要写入电话号码记录的在电话簿中的编号，整型值，范围`1 ~ 500`。 - `username` - 电话号码的用户名，字符串类型，长度范围不超过30字节，暂不支持中文名。 @@ -402,9 +392,16 @@ sim.writePhonebook(storage, index, username, number) 返回一个整型值，`0`表示成功，`-1`表示失败。 + + +> 注意：EC100Y/EC200N/EC600N/EC600S/EC800N/EG912N/EG915N/EC600MCNLE/EC600MCNLA/EC800MCNLA/EC800MCNLE/EC800MCNGA/EG810M/EC200A系列支持此方法。 + + + **示例：** ```python +>>> import sim >>> sim.writePhonebook(9, 1, 'Tom', '18144786859') 0 ``` @@ -439,6 +436,7 @@ SIM卡热插拔开关：用于设置SIM卡热插拔相关配置。 **示例：** ```python +>>> import sim >>> sim.setSimDet(1, 0) 0 ``` @@ -474,6 +472,7 @@ sim.getSimDet() **示例：** ```python +>>> import sim >>> sim.getSimDet() (1, 0) ``` @@ -509,6 +508,7 @@ sim.getCurSimid() **示例：** ```python +>>> import sim >>> sim.getCurSimid() #获取当前卡，当前是卡1 0 ``` @@ -540,6 +540,7 @@ sim.switchCard(simId) **示例：** ```python +>>> import sim >>> sim.getCurSimid() #获取当前卡，当前是卡1 0 >>> sim.switchCard(1) #切到卡2 @@ -571,7 +572,7 @@ def usrFun(args): | 参数 | 类型 | 含义 | | ------ | ---- | --------------------------------------------------------- | -| `args` | 整形 | 当前SIM卡插拔状态：`1` 表示SIM卡插入；`2` 表示 SIM卡拔出 | +| `args` | 整型 | 当前SIM卡插拔状态：`1` 表示SIM卡插入；`2` 表示 SIM卡拔出 | **返回值描述：** @@ -616,7 +617,7 @@ def usrFun(args): | 参数 | 类型 | 含义 | | ---- | ---- | ----------------------------------------------------------- | -| args | 整形 | 切换SIM卡结果：`7` -表示切换SIM成功，`8`- 表示切换SIM卡失败 | +| args | 整型 | 切换SIM卡结果：`7` -表示切换SIM成功，`8`- 表示切换SIM卡失败 | **返回值描述：** 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 85c4e53b..bcf9a70f 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" @@ -21,7 +21,7 @@ sms.sendTextMsg(phoneNumber, msg, codeMode) **参数描述：** * `phoneNumber` - 接收方手机号码，字符串类型，最大长度不超过20字节。 -* `msg` - 待发送消息，字符串类型，长度不超过140个字节。 +* `msg` - 待发送消息，字符串类型，单条短信长度不超过140个字节。 * `codeMode` -使用的字符编码方式，字符串类型，取值范围如下： | 值 | 含义 | @@ -33,6 +33,16 @@ sms.sendTextMsg(phoneNumber, msg, codeMode) 返回一个整型值，`0`表示发送成功，`-1`表示发送失败。 + + +> 注意：仅以下系列支持长短信： +> +> EC100Y/EC200N/EC600N/EC600S/EC800N/EG912N/EG915N/EC800M/EG810M/EC200A系列支持6条正常短信长度； +> +> EC200U/EC600U/EG912U/EC600G/EC800G系列支持4条正常短信长度。 + + + **示例：** ```python @@ -57,7 +67,7 @@ sms.sendPduMsg(phoneNumber, msg, codeMode) **参数描述：** * `phoneNumber` - 接收方手机号码，字符串类型，最大长度不超过20字节。 -* `msg` - 待发送消息，字符串类型，长度不超过140个字节。 +* `msg` - 待发送消息，字符串类型，单条短信长度不超过140个字节。 * `codeMode` -使用的字符编码方式，字符串类型，取值范围如下： | 值 | 含义 | @@ -69,6 +79,16 @@ sms.sendPduMsg(phoneNumber, msg, codeMode) 返回一个整型值，`0`表示发送成功，`-1`表示发送失败。 + + +> 注意：仅以下系列支持长短信： +> +> EC100Y/EC200N/EC600N/EC600S/EC800N/EG912N/EG915N/EC600M/EC800M/EG810M/EC200A系列支持6条正常短信长度； +> +> EC200U/EC600U/EG912U/EC600G/EC800G系列支持4条正常短信长度。 + + + **示例：** ```python @@ -94,7 +114,7 @@ sms.deleteMsg(index [, delmode]) **参数描述：** -* `index` - 索引号，整型值，需要删除短信的索引号； +* `index` - 索引号，整型值，需要删除短信的索引号。 * `delmode` - 模式，整型值，可选参数，当不写时默认为0，具体如下： | 值 | 说明 | @@ -154,6 +174,8 @@ sms.setSaveLoc(mem1, mem2, mem3) +> 注意：不同系列短信默认存储空间有差异，用户根据自己的需求进行设置。 +> > EC100Y/EC200N/EC600N/EC600S/EC800N/EG912N/EG915N/EC800M/EG810M/EC200A系列如果要改变接收消息的存储位置，需要同时设定mem2 & mem3；EC200U/EC600U/EG912U/EG915U/EC600G/EC800G系列只需设定mem3即可 @@ -385,6 +407,9 @@ sms.getCenterAddr() >>> import sms >>> sms.getCenterAddr() '+8613800551500' +# 有些系列返回值中可能不带+，如EC600U系列： +>>> sms.getCenterAddr() +'8613800551500' ``` @@ -429,7 +454,7 @@ def usrFun(args): | 参数 | 类型 | 参数说明 | | --------- | ------ | -------------------- | -| `args[0]` | 整形 | 当前SIM卡卡槽的simId | +| `args[0]` | 整型 | 当前SIM卡卡槽的simId | | `args[1]` | 整型 | 短信索引 | | `args[2]` | 字符串 | 短信存储位置 | @@ -451,7 +476,7 @@ def cb(args): sms.setCallback(cb) # 示例二 -#短信回调函数新老架构的使用方法不同，如下所示，新架构参照示例一，QPY_V0004_EC600N_CNLC_FW_VOLTE(2021-09-09发布)之前发布的版本参照示例二。 +# 2021-09-09之前发布的版本使用方法不同，如下所示，参照示例二： import sms def cb(args): 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 da8f6dc5..8e3d0e1a 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,10 +1,10 @@ # voiceCall - 电话功能 -`voiceCall`模块提供电话功能相关接口。 +模块功能：该模块提供电话功能相关接口。 ->注： +>注意： >* 支持voiceCall功能的模组： > EC100Y系列：EC100YCN_AA > EC200N系列：EC200NCN_AA/EC200NCN_AC/EC200NCN_LA @@ -15,7 +15,7 @@ > EC200A系列：EC200AAU_HA/EC200ACN_DA/EC200ACN_HA/EC200ACN_LA/EC200AEU_HA > EC200U系列：EC200UAU_AB/EC200UCN_AA/EC200UEU_AA/EC200UEU_AB > EC600U系列：EC600CEU_AB/EG912UGL_AA/EG915UEU_AB -> BC25系列/EC600G系列/EC800G系列/BG95系列/BG77系列模组不支持voiceCall功能 +> BC25/EC600G/EC800G/BG95/BG77系列模组不支持voiceCall功能。 >* 其他系列模组需要定制版本才能支持voiceCall功能。 @@ -66,7 +66,7 @@ voiceCall.callStart(phonenum) 成功返回整型`0`，失败返回整型`-1`。 -**示例描述：** +**示例：** ```python >>> voiceCall.callStart("13855169092") @@ -151,7 +151,7 @@ def voicecallFun(args): | 7 | 1 | 呼出中 | | | 8 | 4 | 呼出失败 | `args[1]`：呼叫识别号码
`args[2]`：呼叫失败原因
`args[3]`：指示是否可以从网络端获得in-band tones | | 9 | 3 | 等待 | `args[1]`：呼叫识别号码
`args[2]`：电话号码 | -| 10 | 8 | 来电通知，响铃（volte通话） | `args[1]`：呼叫识别号码
`args[2]`：呼叫方向(MO/MT)
`args[3]`：通话状态
`args[4]`：业务类型(这里一般都是0，表示voice call，语音通话业务)
`args[5]`：多方通话标志，0：非多方通话 1：多方通话
`args[6]`：电话号码
`args[7]`：号码类型[129/145],129:非国际号码,145:国际号码 | +| 10 | 8 | 来电通知，响铃（volte通话） | `args[1]`：呼叫识别号码
`args[2]`：呼叫方向(MO/MT)
`args[3]`：通话状态
`args[4]`：业务类型(这里一般都是0，表示voice call，语音通话业务)
`args[5]`：多方通话标志，0：非多方通话，1：多方通话
`args[6]`：电话号码
`args[7]`：号码类型[129/145],129:非国际号码,145:国际号码 | | 11 | 8 | 通话接通（volte通话） | `args[1] ~ args[7]`：具体说明同上 | | 12 | 8 | 通话挂断（volte通话） | `args[1] ~ args[7]`：具体说明同上 | | 13 | 8 | 呼叫等待（volte通话） | `args[1] ~ args[7]`：具体说明同上 | @@ -234,7 +234,7 @@ voiceCall.setAutoCancel(enable) **参数描述：** -* `enable` - 开启或者关闭来电自动挂断功能，`1`：开启，`0`：关闭 (默认不开启) +* `enable` - 开启或者关闭来电自动挂断功能，`1`：开启，`0`：关闭 (默认不开启)。 **返回值描述：** @@ -242,7 +242,7 @@ voiceCall.setAutoCancel(enable) ->注：EC200AAU_HA/EC200ACN_DA/EC200ACN_HA/EC200ACN_LA/EC200AEU_HA系列模组支持该功能 +>注意：EC200AAU_HA/EC200ACN_DA/EC200ACN_HA/EC200ACN_LA/EC200AEU_HA系列模组支持该功能 @@ -272,9 +272,9 @@ voiceCall.getAutoCancelStatus() **返回值描述：** -`0`：来电自动挂断使能关闭，来电不会被模组自动挂断 +`0`：来电自动挂断使能关闭，来电不会被模组自动挂断。 -`1`：来电自动挂断使能开启，来电会被模组自动挂断 +`1`：来电自动挂断使能开启，来电会被模组自动挂断。 **示例：** @@ -304,7 +304,7 @@ voiceCall.startDtmf(dtmf, duration) **参数描述：** -* `dtmf` - DTMF字符串，字符串类型，最大字符数：32个，有效字符数有：`0-9、A、B、C、D、*、#` +* `dtmf` - DTMF字符串，字符串类型，最大字符数：32个，有效字符数有：`0-9、A、B、C、D、*、#`。 * `duration` - 持续时间，整型值，范围：100-1000，单位：毫秒。 **返回值描述：** @@ -313,7 +313,7 @@ voiceCall.startDtmf(dtmf, duration) ->注：该方法仅在语音通话过程中使用生效 +>注意：该方法仅在语音通话过程中使用生效 @@ -336,7 +336,7 @@ voiceCall.dtmfDetEnable(enable) **参数描述：** -* `enable` - 使能开关，整型值，取值`0/1`，`0`：不开启DTMF识别，`1`：开启DTMF识别 +* `enable` - 使能开关，整型值，取值`0/1`，`0`：不开启DTMF识别，`1`：开启DTMF识别。 **返回值描述：** @@ -344,7 +344,7 @@ voiceCall.dtmfDetEnable(enable) ->注：支持voiceCall功能的模组型号中，EC600N/EC600S/EC800N/EG912N/EG915N系列支持该方法 +>注意：支持voiceCall功能的模组型号中，EC600N/EC600S/EC800N/EG912N/EG915N系列支持该方法。 @@ -375,7 +375,7 @@ def dtmfFun(args): ->注：支持voiceCall功能的模组型号中，EC600N/EC600S/EC800N/EG912N/EG915N系列支持该方法 +>注意：支持voiceCall功能的模组型号中，EC600N/EC600S/EC800N/EG912N/EG915N系列支持该方法。 @@ -501,7 +501,7 @@ voiceCall.setVolume(volume) * `volume` - 音量等级，整型值，范围`（0 ~ 11）`，数值越大，音量越大。 -**返回值：** +**返回值描述：** 设置成功返回整型`0`，失败返回整型`-1`。 @@ -520,7 +520,7 @@ voiceCall.setAutoRecord(enable, recordType, recordMode, filename) **参数描述：** -* `enable` - 使能开关，整型值，取值0或1，`0`：关闭自动录音功能 ，`1`：开启自动录音功能 +* `enable` - 使能开关，整型值，取值0或1，`0`：关闭自动录音功能 ，`1`：开启自动录音功能。 * `recordType` - 录音文件类型，整型值，具体如下： | 值 | 说明 | @@ -582,7 +582,7 @@ voiceCall.startRecord(recordType, recordMode, filename) 设置成功返回整型`0`，设置失败返回整型`-1`，不支持该接口返回字符串`"NOT SUPPORT"`。 -**示例描述：** +**示例：** ```python >>> voiceCall.startRecord(0,2,'U:/test.amr') @@ -622,7 +622,7 @@ voiceCall.readRecordStream(readBuf, bufLen) **参数描述：** -* `readBuf` - 存储读取到的数据，用于保存读取到的数据； +* `readBuf` - 存储读取到的数据，用于保存读取到的数据。 * `bufLen` - 期望读取的字符串长度（不能超过readBuf申请的字节长度）。 @@ -632,7 +632,7 @@ voiceCall.readRecordStream(readBuf, bufLen) ->说明： +>注意： >* 录音流第一包数据均是对应格式文件的文件头 >* wav格式录音流第一包数据不包含文件大小，需结束录音后自行计算 @@ -680,7 +680,7 @@ def recordStreamCallback(args): ->说明： +>注意： >* 录音流第一包数据均是对应格式文件的文件头 >* wav格式录音流第一包数据不包含文件大小，需结束录音后自行计算 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 9ec59096..237cf877 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,6 +1,6 @@ # class wifilocator - WIFI定位 -`wifilocator`对象提供WIFI定位功能，获取模组经纬度坐标信息。 +模块功能：提供WIFI定位功能的类，获取模组经纬度坐标信息。 @@ -16,7 +16,7 @@ import wifilocator wifiloc = wifilocator.wifilocator("xxxxxxxxxxxxxxxx") # 获取模块坐标信息 wifiloc.getwifilocator() -# 返回结果 (117.1152877807617, 31.82142066955567, 100) +(117.1152877807617, 31.82142066955567, 100) # 上面使用的密钥"xxxxxxxxxxxxxxxx"指代token，具体需要向移远申请 ``` @@ -48,10 +48,6 @@ wifilocator.getwifilocator() 该方法用于获取模组经纬度坐标信息。 -**参数描述** - -无 - **返回值描述：** 成功返回模组经纬度坐标信息，元组格式：`(longtitude, latitude, accuracy)`； @@ -68,7 +64,7 @@ wifilocator.getwifilocator() `2` – 密钥长度错误，必须为16字节 -`3` – 获取坐标出错 +`3` – 获取坐标出错。 diff --git a/docs/API_reference/zh/sidebar.yaml b/docs/API_reference/zh/sidebar.yaml index cb0bb386..2d294fab 100644 --- a/docs/API_reference/zh/sidebar.yaml +++ b/docs/API_reference/zh/sidebar.yaml @@ -39,15 +39,15 @@ items: file: QuecPython类库/example.md - label: dataCall - 拨号 file: QuecPython类库/dataCall.md - - label: atcmd - 发送AT指令 + - label: atcmd - 发送AT指令功能 file: QuecPython类库/atcmd.md - - label: sim - SIM卡 + - label: sim - SIM卡功能 file: QuecPython类库/sim.md - - label: sms - 短信 + - label: sms - 短信功能 file: QuecPython类库/sms.md - - label: voiceCall - 电话 + - label: voiceCall - 电话功能 file: QuecPython类库/voiceCall.md - - label: net - 网络 + - label: net - 网络相关功能 file: QuecPython类库/net.md - label: cellLocator - 基站定位 file: QuecPython类库/cellLocator.md -- Gitee From 9f5e7e5d083a0bebdc852e5c06473dce90f17fa9 Mon Sep 17 00:00:00 2001 From: "Rich.wu" Date: Mon, 13 Mar 2023 11:59:43 +0800 Subject: [PATCH 2/2] =?UTF-8?q?docs=20(network):=20=E6=A0=B9=E6=8D=AEST?= =?UTF-8?q?=E7=9A=84=E6=A3=80=E6=9F=A5=E7=BB=93=E6=9E=9C=E4=BF=AE=E6=94=B9?= =?UTF-8?q?=E9=83=A8=E5=88=86=E9=97=AE=E9=A2=982=E3=80=82?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit 固件版本: N/A 是否需要文案翻译: 否 ######################################################################################## # # # 示例： # # # # fix (network): 重复创建并关闭socket一定次数后，无法再次创建socket。 # # # # 1. 调用select接口并在其它线程调用socket.close()时，socket引用计数没有自减， # # 由于socket总数（即引用计数）有上限，导致创建一定数量的socket无法再次创建socket。 # # # # 2. 调用socket.close()释放资源时，将引用计数自减，及时释放出被占用的资源，修复该问题。# # # # 固件版本：EC600MCNLAR02_QPY # # # # 是否需要文案翻译: 是 # # # ######################################################################################## # # # 说明： # # # # <提交类型> 用于说明提交的类型，一般有以下几种： # # - feat: 新增feature。 # # - fix: 修复bug。 # # - docs: 仅仅修改了文档，如readme.md。 # # - style: 仅仅是对格式进行修改，如逗号、缩进、空格等。不改变代码逻辑。 # # - refactor: 代码重构，没有新增功能或修复bug。 # # - perf: 优化相关，如提升性能、用户体验等。 # # - test: 测试用例，包括单元测试、集成测试。 # # - chore: 改变构建流程、或者增加依赖库、工具等。 # # - revert: 版本回滚。 # # # # <功能范围> 用于说明提交影响的功能范围。 # # # # <修改点简述> 提交目的的简短描述。 # # # # <修改点详述> 用于详细描述修改点，可选。不填写，请删除该行；若填写，请描述以下内容： # # - 为何进行修改 # # - 如何解决问题的 # # - 是否有副作用（必要时） # # # ######################################################################################## --- .../sim.md" | 32 ++++++++++--------- .../voiceCall.md" | 9 ++++++ 2 files changed, 26 insertions(+), 15 deletions(-) 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 2a316e37..15532642 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" @@ -38,6 +38,7 @@ sim.genericAccess(simId, cmd) **示例：** ```python +>>> import sim >>> sim.genericAccess(0,'80F2000016') (48, '623E8202782183027FF08410A0000000871002FF86FF9000') ``` @@ -88,6 +89,7 @@ sim.getIccid() **示例：** ```python +>>> import sim >>> sim.getIccid() '89860390845513443049' ``` @@ -110,13 +112,14 @@ sim.getPhoneNumber() ->BC25系列不支持此方法 +>注意：BC25系列不支持此方法 **示例：** ```python +>>> import sim >>> sim.getPhoneNumber() '+8618166328752' ``` @@ -210,6 +213,7 @@ sim.disablePin(pin) **示例：** ```python +>>> import sim >>> sim.disablePin("1234") 0 ``` @@ -235,6 +239,7 @@ PIN码验证：用于SIM卡开启PIN码验证后，如果需要启用SIM卡， **示例：** ```python +>>> import sim >>> sim.verifyPin("1234") 0 ``` @@ -261,6 +266,7 @@ sim.changePin(oldPin, newPin) **示例：** ```python +>>> import sim >>> sim.changePin("1234", "4321") 0 ``` @@ -429,7 +435,7 @@ SIM卡热插拔开关：用于设置SIM卡热插拔相关配置。 -> BC25系列不支持此方法。 +> 注意：BC25系列不支持此方法。 @@ -456,16 +462,16 @@ sim.getSimDet() 成功： 返回元组数据，格式`(detenable, insertlevel)`，具体说明如下： -| 参数 | 类型 | 含义 | -| ------------- | ---- | -------------------------------------------- | -| `detenable` | 整型 | 开启或者关闭SIM卡热插拔功能，0：关闭 1：打开 | -| `insertlevel` | 整型 | 高低电平配置(0/1) | +| 参数 | 类型 | 含义 | +| ------------- | ---- | ---------------------------------------------- | +| `detenable` | 整型 | 开启或者关闭SIM卡热插拔功能，0：关闭 ，1：打开 | +| `insertlevel` | 整型 | 高低电平配置(0/1) | 失败： 返回`-1`。 ->BC25系列不支持此方法。 +>注意：BC25系列不支持此方法。 @@ -489,10 +495,6 @@ sim.getCurSimid() 该方法用于获取当前卡的SIM卡卡槽编号(simId)。 -**参数描述：** - -- 无 - **返回值描述：** 成功： 返回当前`simId`(`0`或`1`，分别表示`SIM1`或者`SIM2`)。 @@ -501,7 +503,7 @@ sim.getCurSimid() ->支持该方法的模组：EC600M/EC800M系列。 +>注意：支持该方法的模组：EC600M/EC800M系列。 @@ -533,7 +535,7 @@ sim.switchCard(simId) ->支持该方法的模组：EC600M/EC800M系列。 +>注意：支持该方法的模组：EC600M/EC800M系列。 @@ -580,7 +582,7 @@ def usrFun(args): -> BC25系列不支持此方法。 +> 注意：BC25系列不支持此方法。 @@ -627,7 +629,7 @@ def usrFun(args): > 支持该方法的模组：EC600M/EC800M系列。 > -> 注意以下几点：
1、目标卡不存在或者目标卡状态异常；
2、目标卡是当前卡；
以上情况切卡方法`sim.switchCard`直接返回-1，不触发此接口设置的回调函数。 +> 注意：以下几点：
1、目标卡不存在或者目标卡状态异常；
2、目标卡是当前卡；
以上情况切卡方法`sim.switchCard`直接返回-1，不触发此接口设置的回调函数。 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 8e3d0e1a..6cceb72b 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" @@ -69,6 +69,7 @@ voiceCall.callStart(phonenum) **示例：** ```python +>>> import voiceCall >>> voiceCall.callStart("13855169092") 0 ``` @@ -115,6 +116,7 @@ voiceCall.callEnd() **示例：** ```python +>>> import voiceCall >>> voiceCall.callEnd() 0 ``` @@ -166,6 +168,7 @@ def voicecallFun(args): **示例：** ```python +>>> import voiceCall def voice_callback(args): if args[0] == 10: print('voicecall incoming call, PhoneNO: ', args[6]) @@ -209,6 +212,7 @@ def voice_callback(args): **示例：** ```python +>>> import voiceCall def voice_callback(args): if args[0] == 4106: print('voicecall is waiting') @@ -249,6 +253,7 @@ voiceCall.setAutoCancel(enable) **示例：** ```python +>>> import voiceCall #手机呼叫模块，默认不会自动挂断 >>> voiceCall.getAutoCancelStatus() 0 @@ -279,6 +284,7 @@ voiceCall.getAutoCancelStatus() **示例：** ```python +>>> import voiceCall #手机呼叫模块，默认不会自动挂断 >>> voiceCall.getAutoCancelStatus() 0 @@ -320,6 +326,7 @@ voiceCall.startDtmf(dtmf, duration) **示例：** ```python +>>> import voiceCall >>> voiceCall.startDtmf('A',100) 0 ``` @@ -382,6 +389,7 @@ def dtmfFun(args): **示例：** ```python +>>> import voiceCall >>> def cb(args): ... print(args) @@ -585,6 +593,7 @@ voiceCall.startRecord(recordType, recordMode, filename) **示例：** ```python +>>> import voiceCall >>> voiceCall.startRecord(0,2,'U:/test.amr') 0 ``` -- Gitee