Skip to content

修正NET模块相关API说明，无具体对应版本 #111

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
guozhenh merged 2 commits into from
Nov 7, 2022
Merged

修正NET模块相关API说明，无具体对应版本 #111

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
99451aa
修正NET模块相关API说明，无具体对应版本
Mia1234567890 Nov 1, 2022
f8c39ed
【wifiscan】-修改参数范围，平台支持情况等
Mia1234567890 Nov 7, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
32 changes: 17 additions & 15 deletions en-us/api/QuecPythonClasslib.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2083,6 +2083,8 @@ This function obtains the current information in the message storage.
* `loc3` - The memory storage where the Received messages stored in;
* `current_nums` - The current number of messages in the storage.
* `max_nums` - The maximum number of messages can be stored in the storage.

* -1 Failed execution.

* Example

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

* Parameter

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 ：
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 ：
The number of parameters is 2：net.setApn(apn, simid)
The number of parameters is 7：net.setApn(pid, iptype, apn, usrname, password, authtype, simid)

Expand Down Expand Up @@ -2406,7 +2408,7 @@ This function obtains the current APN.

* Parameter

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 ：
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 ：
The number of parameters is 2：net.setApn(pid, simid)
The number of parameters is 1：net.setApn(simid)

Expand Down Expand Up @@ -2481,7 +2483,7 @@ case with one Parameter:

* Parameter

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 ：
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 ：
The number of parameters is 0：net.getCellInfo()
The number of parameters is 1：net.getCellInfo(sinr_enable)

Expand Down Expand Up @@ -2534,7 +2536,7 @@ case with one Parameter:
| tac | Tracing area code, range : 0 ~ 65535 |
| earfcn | Extended Absolute Radio Frequency Channel Number, range : 0-65535. |
| 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 |
| sinr | Signal to Noise Ratio(supported in BC25，range : -30 ~ 30) |
| sinr | Signal to Noise Ratio(supported in BC25/EIGEN，range : -30 ~ 30) |

* Example

Expand Down Expand Up @@ -2719,7 +2721,7 @@ case with one Parameter:

* Parameter

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 ：
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 ：
The number of parameters is 0：net.getCellInfo()
The number of parameters is 1：net.getCellInfo(sinr_enable)

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

```python
Expand Down Expand Up @@ -7838,7 +7840,7 @@ print(r.group(0))

#### wifiScan

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

##### Determine whether wifiScan is supported

Expand Down Expand Up @@ -7946,10 +7948,10 @@ True

| Return Value | Type | Description |
| ------------- | ------------ | ------------------------------------------------------------ |
| 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: 4–255. Unit: second. |
| 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: 1–3. Unit: round. |
| 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: 4–30. |
| 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: 1–255. Unit: second. |
| 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. |
| 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. |
| 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. |
| 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. |
| 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. |

* Example：
Expand All @@ -7973,11 +7975,11 @@ True

| Parameter | Type | Description |
| ------------- | ------------ | ------------------------------------------------------------ |
| 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: 4–255; unit: s.<br/>200U/600U: 120–5000; unit: ms. |
| 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: 1–3; unit: round<br/>200U/600U: 1–10; unit: round |
| 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: 4–30<br/>200U/600U: 1–300 |
| 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: 4–255; unit: s.<br/>8850/8910 platfroms: 120–5000; unit: ms. |
| 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: 1–3; unit: round<br/>8850/8910 platforms: 1–10; unit: round |
| 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: 4–30<br/>8850/8910 platforms: 1–300 |
| 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: 1–255. |
| 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. |
| 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. |

* Return Value：

Expand Down
36 changes: 19 additions & 17 deletions zh-cn/api/QuecPythonClasslib.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2122,6 +2122,8 @@ if __name__ == '__main__':
`current_nums` - 当前空间已有短信数量

`max_nums` - 当前空间最大短信存储数量

失败返回整形-1

* 示例

Expand Down Expand Up @@ -2409,7 +2411,7 @@ sms.setCallback(cb)

* 参数

该接口在Qualcomm/ASR_1803s/ASR_1601/ASR_1606/Unisoc(不包括EG915)平台为可变参函数,参数个数为2或7, 其他平台参数个数固定为2：
该接口在Qualcomm/ASR_1803s/ASR_1601/ASR_1606/Unisoc平台为可变参函数,参数个数为2或7, 其他平台参数个数固定为7：
参数个数为2：net.setApn(apn, simid)
参数个数为7：net.setApn(pid, iptype, apn, usrname, password, authtype, simid)

Expand Down Expand Up @@ -2452,7 +2454,7 @@ sms.setCallback(cb)

* 参数

该接口在Qualcomm/ASR_1803s/ASR_1601/ASR_1606/Unisoc(不包括EG915)平台为可变参函数,参数个数为1或2, 其他平台参数个数固定为1：
该接口在Qualcomm/ASR_1803s/ASR_1601/ASR_1606/Unisoc平台为可变参函数,参数个数为1或2, 其他平台参数个数固定为2：
参数个数为2：net.getApn(pid, simid)
参数个数为1：net.getApn(simid)

Expand Down Expand Up @@ -2519,7 +2521,7 @@ sms.setCallback(cb)

* 参数

该接口在BC25平台为可变参函数,参数个数为0或1, 其他平台参数个数固定为0：
该接口在BC25平台和移芯小内存方案为可变参函数,参数个数为0或1, 其他平台参数个数固定为0：
参数个数为0：net.getCellInfo()
参数个数为1：net.getCellInfo(sinr_enable)

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

* 示例

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

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

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

> **net.getConfig()**

Expand Down Expand Up @@ -2658,7 +2660,7 @@ sms.setCallback(cb)

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

注意：BC25PA平台不支持此方法。展锐平台不支持漫游参数配置。
注意：BC25PA平台不支持此方法。展锐平台不支持漫游参数配置。移芯平台仅支持LTE ONLY.

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

Expand Down Expand Up @@ -2749,7 +2751,7 @@ sms.setCallback(cb)

* 参数

该接口在1803s/qualcomm/unisoc(不包括EG915)平台为可变参函数,参数个数为0或1, 其他平台参数个数固定为0：
该接口在非RDA平台为可变参函数,参数个数为0或1, RDA平台参数个数固定为0：
参数个数为0：net.getSignal()
参数个数为1：net.getSignal(sinr_enable)

Expand Down Expand Up @@ -2785,7 +2787,7 @@ sms.setCallback(cb)

`cqi` ：信道质量

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

* 示例

Expand Down Expand Up @@ -8308,7 +8310,7 @@ print(r.group(0))

#### wifiScan - WiFi扫描

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

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

Expand Down Expand Up @@ -8410,10 +8412,10 @@ True

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

* 示例：
Expand All @@ -8437,11 +8439,11 @@ True

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

* 返回值：

Expand Down