Skip to content

Commit 3f8b0d8

Browse files
authored
Merge pull request #111 from Mia1234567890/main
修正NET模块相关API说明,无具体对应版本
2 parents ef028d0 + f8c39ed commit 3f8b0d8

File tree

2 files changed

+36
-32
lines changed

2 files changed

+36
-32
lines changed

en-us/api/QuecPythonClasslib.md

Lines changed: 17 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -2083,6 +2083,8 @@ This function obtains the current information in the message storage.
20832083
* `loc3` - The memory storage where the Received messages stored in;
20842084
* `current_nums` - The current number of messages in the storage.
20852085
* `max_nums` - The maximum number of messages can be stored in the storage.
2086+
2087+
* -1 Failed execution.
20862088

20872089
* Example
20882090

@@ -2364,7 +2366,7 @@ This function sets APN. After setting, you need to restart or switch to mode 0 a
23642366

23652367
* Parameter
23662368

2367-
This API is a variable parameter function in Qualcomm/ASR_1803s/ASR_1601/ASR_1606/Unisoc(excluding EG915) platform, and the number of parameters is 2 or 7. The number of parameters in other platforms is fixed at 2
2369+
This API is a variable parameter function in Qualcomm/ASR_1803s/ASR_1601/ASR_1606/Unisoc platform, and the number of parameters is 2 or 7. The number of parameters in other platforms is fixed at 7
23682370
The number of parameters is 2:net.setApn(apn, simid)
23692371
The number of parameters is 7:net.setApn(pid, iptype, apn, usrname, password, authtype, simid)
23702372

@@ -2406,7 +2408,7 @@ This function obtains the current APN.
24062408

24072409
* Parameter
24082410

2409-
This API is a variable parameter function in Qualcomm/ASR_1803s/ASR_1601/ASR_1606/Unisoc(excluding EG915) platform, and the number of parameters is 1 or 2. The number of parameters in other platforms is fixed at 1
2411+
This API is a variable parameter function in Qualcomm/ASR_1803s/ASR_1601/ASR_1606/Unisoc platform, and the number of parameters is 1 or 2. The number of parameters in other platforms is fixed at 2
24102412
The number of parameters is 2:net.setApn(pid, simid)
24112413
The number of parameters is 1:net.setApn(simid)
24122414

@@ -2481,7 +2483,7 @@ case with one Parameter:
24812483

24822484
* Parameter
24832485

2484-
This API is a variable parameter function in BC25 platform, and the number of parameters is 0 or 1. The number of parameters in other platforms is fixed at 0
2486+
This API is a variable parameter function in BC25/EIGEN platform, and the number of parameters is 0 or 1. The number of parameters in other platforms is fixed at 0
24852487
The number of parameters is 0:net.getCellInfo()
24862488
The number of parameters is 1:net.getCellInfo(sinr_enable)
24872489

@@ -2534,7 +2536,7 @@ case with one Parameter:
25342536
| tac | Tracing area code, range : 0 ~ 65535 |
25352537
| earfcn | Extended Absolute Radio Frequency Channel Number, range : 0-65535. |
25362538
| rssi | Received Signal Strength Indication. In LTE network, denotes RSRP quality (negative value), which is converted according to RSRP measurement report value, and the conversion relationship is as follows<br>RSRP quality = RSRP measurement report value - 140, unit : dBm, range : -140 ~ -44 dBm |
2537-
| sinr | Signal to Noise Ratio(supported in BC25range : -30 ~ 30) |
2539+
| sinr | Signal to Noise Ratio(supported in BC25/EIGENrange : -30 ~ 30) |
25382540

25392541
* Example
25402542

@@ -2719,7 +2721,7 @@ case with one Parameter:
27192721

27202722
* Parameter
27212723

2722-
This API is a variable parameter function in BC25 platform, and the number of parameters is 0 or 1. The number of parameters in other platforms is fixed at 0
2724+
This API is a variable parameter function except BC25 platform, and the number of parameters is 0 or 1. The number of parameters in other platforms is fixed at 0
27232725
The number of parameters is 0:net.getCellInfo()
27242726
The number of parameters is 1:net.getCellInfo(sinr_enable)
27252727

@@ -2750,7 +2752,7 @@ case with one Parameter:
27502752
`rsrp` : Reference Signal Receiving Power, range : -141 ~ -44 dBm, 99 indicates unknown or undetected signal <br/>
27512753
`rsrq` : Reference Signal Receiving Quality, range : -20 ~ -3 dBm, A larger value indicates better signal reception quality <br/>
27522754
`cqi` : Channel Quality
2753-
`sinr`: Signal to Noise Ratio(supported in 1803s/qualcomm/unisocrange : -30 ~ 30)
2755+
`sinr`: Signal to Noise Ratio(supported except RDA platformrange : -30 ~ 30)
27542756
* Example
27552757

27562758
```python
@@ -7838,7 +7840,7 @@ print(r.group(0))
78387840

78397841
#### wifiScan
78407842

7841-
Note: The BC25PA platform does not support this module function.
7843+
Note: wifiscan supports the platforms: 1603/1606(except:600MCN_LC/800MCN_GC/800MCN_LC)/8910/8850.
78427844

78437845
##### Determine whether wifiScan is supported
78447846

@@ -7946,10 +7948,10 @@ True
79467948

79477949
| Return Value | Type | Description |
79487950
| ------------- | ------------ | ------------------------------------------------------------ |
7949-
| timeout | Integer type | This parameter is the timeout of upper layer application. When the application triggers timeout, it actively reports the scanned hot spot information. The application automatically reports the hot spot information if it scans all the hop spots which have been set previously or the underlying layer scan reaches the frequency sweeping timeout before the timeout of the application. Range: 4255. Unit: second. |
7950-
| round | Integer type | This parameter is the scanning rounds of wifi. When reaching the scanning rounds, the scan stops and the scanning results are obtained. Range: 13. Unit: round. |
7951-
| max_bssid_num | Integer type | This parameter determines the maximum number of hot spots to be scanned. If the number of hot spots scanned by the underlying layer reaches the maximum, the scan stops and the scanning results are obtained. Range: 430. |
7952-
| scan_timeout | Integer type | This parameter is the wifi hot spot scanning timeout of underlying layer. If the underlying layer scan reaches the hot spot scanning timeout set previously, the scan stops and the scanning results are obtained. Range: 1255. Unit: second. |
7951+
| timeout | Integer type | This parameter is the timeout of upper layer application. When the application triggers timeout, it actively reports the scanned hot spot information. The application automatically reports the hot spot information if it scans all the hop spots which have been set previously or the underlying layer scan reaches the frequency sweeping timeout before the timeout of the application. |
7952+
| round | Integer type | This parameter is the scanning rounds of wifi. When reaching the scanning rounds, the scan stops and the scanning results are obtained. |
7953+
| max_bssid_num | Integer type | This parameter determines the maximum number of hot spots to be scanned. If the number of hot spots scanned by the underlying layer reaches the maximum, the scan stops and the scanning results are obtained. |
7954+
| scan_timeout | Integer type | This parameter is the wifi hot spot scanning timeout of underlying layer. If the underlying layer scan reaches the hot spot scanning timeout set previously, the scan stops and the scanning results are obtained. |
79537955
| priority | Integer type | This parameter is the priority setting of wifi scanning service. 0 indicates that ps is preferred; 1 indicates that wifi is preferred. When ps is preferred, the wifi scan is terminated when a data service is initiated. When wifi is preferred, RRC connection is not connected when a data service is initiated. wifi scan runs normally. The RRC connection is only established after the scan completes. |
79547956

79557957
* Example:
@@ -7973,11 +7975,11 @@ True
79737975

79747976
| Parameter | Type | Description |
79757977
| ------------- | ------------ | ------------------------------------------------------------ |
7976-
| timeout | Integer type | This parameter is the timeout of upper layer application. When the application triggers timeout, it actively reports the scanned hot spot information. The application automatically reports the hot spot information if it scans all the hop spots which have been set previously or the underlying layer scan reaches the frequency sweeping timeout before the timeout of the application. <br>Range:<br/>600S: 4255; unit: s.<br/>200U/600U: 1205000; unit: ms. |
7977-
| round | Integer type | This parameter is the scanning rounds of wifi. When reaching the scanning rounds, the scan stops and the scanning results are obtained. <br/>Range:<br/>600S: 13; unit: round<br/>200U/600U: 110; unit: round |
7978-
| max_bssid_num | Integer type | This parameter determines the maximum number of hot spots to be scanned. If the number of hot spots scanned by the underlying layer reaches the maximum, the scan stops and the scanning results are obtained. <br/>Range:<br/>600S: 430<br/>200U/600U: 1300 |
7978+
| timeout | Integer type | This parameter is the timeout of upper layer application. When the application triggers timeout, it actively reports the scanned hot spot information. The application automatically reports the hot spot information if it scans all the hop spots which have been set previously or the underlying layer scan reaches the frequency sweeping timeout before the timeout of the application. <br>Range:<br/>1603/1606 platforms: 4255; unit: s.<br/>8850/8910 platfroms: 1205000; unit: ms. |
7979+
| round | Integer type | This parameter is the scanning rounds of wifi. When reaching the scanning rounds, the scan stops and the scanning results are obtained. <br/>Range:<br/>1603/1606 platforms: 13; unit: round<br/>8850/8910 platforms: 110; unit: round |
7980+
| max_bssid_num | Integer type | This parameter determines the maximum number of hot spots to be scanned. If the number of hot spots scanned by the underlying layer reaches the maximum, the scan stops and the scanning results are obtained. <br/>Range:<br/>1603/1606 platforms: 430<br/>8850/8910 platforms: 1300 |
79797981
| scan_timeout | Integer type | This parameter is the wifi hot spot scanning timeout of underlying layer. If the underlying layer scan reaches the hot spot scanning timeout set previously, the scan stops and the scanning results are obtained. Range: 1255. |
7980-
| priority | Integer type | This parameter is the priority setting of wifi scanning service. 0 indicates that ps is preferred; 1 indicates that wifi is preferred. When ps is preferred, the wifi scan is terminated when a data service is initiated. When wifi is preferred, RRC connection is not connected when a data service is initiated. wifi scan runs normally. The RRC connection is only established after the scan completes. 200U or 600U platforms do not support this parameter. You can set this parameter to 0. |
7982+
| priority | Integer type | This parameter is the priority setting of wifi scanning service. 0 indicates that ps is preferred; 1 indicates that wifi is preferred. When ps is preferred, the wifi scan is terminated when a data service is initiated. When wifi is preferred, RRC connection is not connected when a data service is initiated. wifi scan runs normally. The RRC connection is only established after the scan completes. 8850/8910 platforms do not support this parameter. You can set this parameter to 0. |
79817983

79827984
* Return Value:
79837985

zh-cn/api/QuecPythonClasslib.md

Lines changed: 19 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -2122,6 +2122,8 @@ if __name__ == '__main__':
21222122
`current_nums` - 当前空间已有短信数量
21232123

21242124
`max_nums` - 当前空间最大短信存储数量
2125+
2126+
失败返回整形-1
21252127

21262128
* 示例
21272129

@@ -2409,7 +2411,7 @@ sms.setCallback(cb)
24092411

24102412
* 参数
24112413

2412-
该接口在Qualcomm/ASR_1803s/ASR_1601/ASR_1606/Unisoc(不包括EG915)平台为可变参函数,参数个数为27, 其他平台参数个数固定为2
2414+
该接口在Qualcomm/ASR_1803s/ASR_1601/ASR_1606/Unisoc平台为可变参函数,参数个数为27, 其他平台参数个数固定为7
24132415
参数个数为2:net.setApn(apn, simid)
24142416
参数个数为7:net.setApn(pid, iptype, apn, usrname, password, authtype, simid)
24152417

@@ -2452,7 +2454,7 @@ sms.setCallback(cb)
24522454

24532455
* 参数
24542456

2455-
该接口在Qualcomm/ASR_1803s/ASR_1601/ASR_1606/Unisoc(不包括EG915)平台为可变参函数,参数个数为12, 其他平台参数个数固定为1
2457+
该接口在Qualcomm/ASR_1803s/ASR_1601/ASR_1606/Unisoc平台为可变参函数,参数个数为12, 其他平台参数个数固定为2
24562458
参数个数为2:net.getApn(pid, simid)
24572459
参数个数为1:net.getApn(simid)
24582460

@@ -2519,7 +2521,7 @@ sms.setCallback(cb)
25192521

25202522
* 参数
25212523

2522-
该接口在BC25平台为可变参函数,参数个数为01, 其他平台参数个数固定为0
2524+
该接口在BC25平台和移芯小内存方案为可变参函数,参数个数为01, 其他平台参数个数固定为0
25232525
参数个数为0:net.getCellInfo()
25242526
参数个数为1:net.getCellInfo(sinr_enable)
25252527

@@ -2573,7 +2575,7 @@ sms.setCallback(cb)
25732575
| earfcn | 无线频道编号,范围 0 ~ 65535 |
25742576
| rssi | 接收的信号强度,在LTE网络下,表示RSRP质量(负值),是根据RSRP测量报告值换算而来,换算关系如下:<br>RSRP质量(负数)= RSRP测量报告值 - 140,单位dBm,范围 -140 ~ -44 dBm |
25752577
| rsrq |(Reference Signal Receiving Quality):LTE参考信号接收质量(仅ASR平台数据有意义,其余平台默认0),范围 -20 ~ -3 注:理论上rsrq的范围应该是-19.5 ~ -3,但由于计算方法问题,目前能给出的是-20 ~ -3|
2576-
| sinr |信噪比(目前仅BC25平台支持获取该参数,非服务小区默认写0, 范围-30 ~ 30) |
2578+
| sinr |信噪比(目前仅BC25和移芯小内存平台支持获取该参数,范围-30 ~ 30) |
25772579

25782580
* 示例
25792581

@@ -2595,7 +2597,7 @@ sms.setCallback(cb)
25952597

25962598
##### 获取网络制式及漫游配置
25972599

2598-
注意:BC25PA平台不支持此方法。EC200U/EC600U平台不支持漫游参数配置。
2600+
注意:BC25PA平台不支持此方法。展锐平台不支持漫游参数配置。移芯平台仅支持LTE ONLY.
25992601

26002602
> **net.getConfig()**
26012603

@@ -2658,7 +2660,7 @@ sms.setCallback(cb)
26582660

26592661
##### 设置网络制式及漫游配置
26602662

2661-
注意:BC25PA平台不支持此方法。展锐平台不支持漫游参数配置。
2663+
注意:BC25PA平台不支持此方法。展锐平台不支持漫游参数配置。移芯平台仅支持LTE ONLY.
26622664

26632665
> **net.setConfig(mode, roaming)**
26642666

@@ -2749,7 +2751,7 @@ sms.setCallback(cb)
27492751

27502752
* 参数
27512753

2752-
该接口在1803s/qualcomm/unisoc(不包括EG915)平台为可变参函数,参数个数为01, 其他平台参数个数固定为0
2754+
该接口在非RDA平台为可变参函数,参数个数为01, RDA平台参数个数固定为0
27532755
参数个数为0:net.getSignal()
27542756
参数个数为1:net.getSignal(sinr_enable)
27552757

@@ -2785,7 +2787,7 @@ sms.setCallback(cb)
27852787

27862788
`cqi` :信道质量
27872789

2788-
`sinr`: 信噪比(目前仅1803s/qualcomm/unisoc平台支持获取该参数)
2790+
`sinr`: 信噪比(RDA平台不支持获取该参数)
27892791

27902792
* 示例
27912793

@@ -8308,7 +8310,7 @@ print(r.group(0))
83088310

83098311
#### wifiScan - WiFi扫描
83108312

8311-
注意:BC25PA平台不支持此方法。
8313+
注意:支持wifiscan的平台: 1603/1606(不包含:600MCN_LC/800MCN_GC/800MCN_LC)/8910/8850.
83128314

83138315
##### 判断是否支持 wifiScan
83148316

@@ -8410,10 +8412,10 @@ True
84108412

84118413
| 返回值 | 类型 | 说明 |
84128414
| ------------- | ---- | ------------------------------------------------------------ |
8413-
| timeout | 整型 | 该超时时间参数是上层应用的超时,当触发超时会主动上报已扫描到的热点信息,若在超时前扫描到设置的热点个数或达到底层扫频超时时间会自动上报热点信息。该参数设置范围为4-255秒。 |
8414-
| round | 整型 | 该参数是Wi-Fi扫描轮,达到扫描轮数后,会结束扫描并获取扫描结果。该参数设置范围为1-3轮次。 |
8415-
| max_bssid_num | 整型 | 该参数是Wi-Fi扫描热点最大个,若底层扫描热点个数达到设置的最大个数,会结束扫描并获取扫描结果。该参数设置范围为4-30个。 |
8416-
| scan_timeout | 整型 | 该参数是底层Wi-Fi扫描热点超时时间,若底层扫描热点时间达到设置的超时时间,会结束扫描并获取扫描结果。该参数设置范围为1-255秒。 |
8415+
| timeout | 整型 | 该超时时间参数是上层应用的超时,当触发超时会主动上报已扫描到的热点信息,若在超时前扫描到设置的热点个数或达到底层扫频超时时间会自动上报热点信息。 |
8416+
| round | 整型 | 该参数是Wi-Fi扫描轮,达到扫描轮数后,会结束扫描并获取扫描结果。|
8417+
| max_bssid_num | 整型 | 该参数是Wi-Fi扫描热点最大个,若底层扫描热点个数达到设置的最大个数,会结束扫描并获取扫描结果。|
8418+
| scan_timeout | 整型 | 该参数是底层Wi-Fi扫描热点超时时间,若底层扫描热点时间达到设置的超时时间,会结束扫描并获取扫描结果。|
84178419
| priority | 整型 | 该参数是Wi-Fi扫描业务优先级设置,0为ps优先,1为Wi-Fi优先。ps优先时,当有数据业务发起时会中断Wi-Fi扫描。Wi-Fi优先时,当有数据业务发起时,不会建立RRC连接,保障Wi-Fi扫描正常执行,扫描结束后才会建立RRC连接。 |
84188420

84198421
* 示例:
@@ -8437,11 +8439,11 @@ True
84378439

84388440
| 参数 | 类型 | 说明 |
84398441
| ------------- | ---- | ------------------------------------------------------------ |
8440-
| timeout | 整型 | 该超时时间参数是上层应用的超时,当触发超时会主动上报已扫描到的热点信息,若在超时前扫描到设置的热点个数或达到底层扫频超时时间会自动上报热点信息。<br>参数范围:<br/>600S4-255<br/>200U/600U120-5000毫秒 |
8441-
| round | 整型 | 该参数是wifi扫描轮,达到扫描轮数后,会结束扫描并获取扫描结果。<br/>参数范围:<br/>600S1-3轮次<br/>200U/600U1-10轮次 |
8442-
| max_bssid_num | 整型 | 该参数是wifi扫描热点最大个,若底层扫描热点个数达到设置的最大个数,会结束扫描并获取扫描结果。<br/>参数范围:<br/>600S4-30<br/>200U/600U1-300 |
8442+
| timeout | 整型 | 该超时时间参数是上层应用的超时,当触发超时会主动上报已扫描到的热点信息,若在超时前扫描到设置的热点个数或达到底层扫频超时时间会自动上报热点信息。<br>参数范围:<br/>1603/1606平台4-255<br/>8850/8910平台120-5000毫秒 |
8443+
| round | 整型 | 该参数是wifi扫描轮,达到扫描轮数后,会结束扫描并获取扫描结果。<br/>参数范围:<br/>1603/1606平台1-3轮次<br/>8850/8910平台1-10轮次 |
8444+
| max_bssid_num | 整型 | 该参数是wifi扫描热点最大个,若底层扫描热点个数达到设置的最大个数,会结束扫描并获取扫描结果。<br/>参数范围:<br/>1603/1606平台4-30<br/>8850/8910平台1-30 |
84438445
| scan_timeout | 整型 | 该参数是底层wifi扫描热点超时时间,若底层扫描热点时间达到设置的超时时间,会结束扫描并获取扫描结果。该参数设置范围为1-255秒。 |
8444-
| priority | 整型 | 该参数是wifi扫描业务优先级设置,0为ps优先,1为wifi优先。ps优先时,当有数据业务发起时会中断wifi扫描。Wifi优先时,当有数据业务发起时,不会建立RRC连接,保障wifi扫描正常执行,扫描结束后才会建立RRC连接。200U/600U 平台不支持该参数,设置时写0即可。 |
8446+
| priority | 整型 | 该参数是wifi扫描业务优先级设置,0为ps优先,1为wifi优先。ps优先时,当有数据业务发起时会中断wifi扫描。Wifi优先时,当有数据业务发起时,不会建立RRC连接,保障wifi扫描正常执行,扫描结束后才会建立RRC连接。8850/8910平台不支持该参数,设置时写0即可。 |
84458447

84468448
* 返回值:
84478449

0 commit comments

Comments
 (0)