From f9397b1a433972e23a1a2bc37d7194d3df5b220a Mon Sep 17 00:00:00 2001 From: zengyawen Date: Thu, 11 Nov 2021 17:16:01 +0800 Subject: [PATCH] add the js reference of wifi Signed-off-by: zengyawen --- .../application-dev/js-reference/Readme-CN.md | 2 + .../js-reference/apis/js-apis-connectivity.md | 7 + .../js-reference/apis/js-apis-wifi.md | 295 ++++++++++++++++++ .../js-reference/apis/js-apis.md | 10 +- 4 files changed, 305 insertions(+), 9 deletions(-) create mode 100644 zh-cn/application-dev/js-reference/apis/js-apis-connectivity.md create mode 100644 zh-cn/application-dev/js-reference/apis/js-apis-wifi.md diff --git a/zh-cn/application-dev/js-reference/Readme-CN.md b/zh-cn/application-dev/js-reference/Readme-CN.md index a66445a669..600769b95a 100755 --- a/zh-cn/application-dev/js-reference/Readme-CN.md +++ b/zh-cn/application-dev/js-reference/Readme-CN.md @@ -333,6 +333,8 @@ - [短信服务](apis/js-apis-sms.md) - [SIM卡管理](apis/js-apis-sim.md) - [网络搜索](apis/js-apis-radio.md) + - [网络与连接](apis/js-apis-connectivity.md) + - [WLAN](apis/js-apis-wifi.md) - [设备管理](apis/js-apis-device-mgmt.md) - [传感器](apis/js-apis-sensor.md) - [振动](apis/js-apis-vibrator.md) diff --git a/zh-cn/application-dev/js-reference/apis/js-apis-connectivity.md b/zh-cn/application-dev/js-reference/apis/js-apis-connectivity.md new file mode 100644 index 0000000000..564f742a68 --- /dev/null +++ b/zh-cn/application-dev/js-reference/apis/js-apis-connectivity.md @@ -0,0 +1,7 @@ +# 网络与连接 + +- 网络与连接 + - [WLAN](js-apis-wifi.md) + + + diff --git a/zh-cn/application-dev/js-reference/apis/js-apis-wifi.md b/zh-cn/application-dev/js-reference/apis/js-apis-wifi.md new file mode 100644 index 0000000000..ac1bcc7fc7 --- /dev/null +++ b/zh-cn/application-dev/js-reference/apis/js-apis-wifi.md @@ -0,0 +1,295 @@ +# WLAN + +>**说明：** +>从 API Version 6 开始支持。 + + +## 导入模块 + +``` +import wifi from '@ohos.wifi_native_js'; +``` + + +## wifi.isWifiActive + +isWifiActive\(\): boolean + +查询WLAN是否已激活。 + +- 返回值： + + + + + + + + + + +

类型

+

说明

+

boolean

+

true:已激活， false:未激活。

+
+ + +## wifi.getSignalLevel + +getSignalLevel\(rssi: number, band: number\): number + +查询WLAN信号强度。 + +- 参数： + + + + + + + + + + + + + + + + + + + +

参数名

+

类型

+

必填

+

说明

+

rssi

+

number

+

是

+

热点的信号强度(dBm)。

+

band

+

number

+

是

+

WLAN接入点的频段。

+
+ + +- 返回值： + + + + + + + + + + +

类型

+

说明

+

number

+

信号强度，取值范围为[0, 4]。

+
+ + +## wifi.scan + +scan\(\): boolean + +启动WLAN扫描。 + +- 返回值： + + + + + + + + + + +

类型

+

说明

+

boolean

+

true:扫描操作成功， false:扫描操作执行失败。

+
+ + +## wifi.getScanInfos + +getScanInfos\(\): Promise\> + +获取扫描结果，使用promise方式作为异步方法。 + +- 返回值： + + + + + + + + + + +

类型

+

说明

+

Promise< Array<WifiScanInfo> >

+

返回扫描到的热点列表。

+
+ + +## wifi.getScanInfos + +getScanInfos\(callback: AsyncCallback\>\): void + +获取扫描结果，使用callback方式作为异步方法。 + +- 参数 + + + + + + + + + + + + + + + +

参数名

+

类型

+

必填

+

说明

+

callback

+

AsyncCallback< Array<WifiScanInfo>>

+

是

+

扫描到的热点列表结果回调函数。

+
+ + +- 示例 + + ``` + import wifi from '@ohos.wifi_native_js'; + + + wifi.getScanInfos(result => { + var len = Object.keys(result).length; + console.log("received scan info size: " + len); + for (var i = 0; i < len; ++j) { + console.info("ssid: " + result[i].ssid); + console.info("bssid: " + result[i].bssid); + console.info("securityType: " + result[i].securityType); + console.info("rssi: " + result[i].rssi); + console.info("band: " + result[i].band); + console.info("frequency: " + result[i].frequency); + console.info("timestamp: " + result[i].timestamp); + } + }); + + wifi.getScanInfos().then(result => { + var len = Object.keys(result).length; + console.log("received scan info size: " + len); + for (var i = 0; i < len; ++i) { + console.info("ssid: " + result[i].ssid); + console.info("bssid: " + result[i].bssid); + console.info("securityType: " + result[i].securityType); + console.info("rssi: " + result[i].rssi); + console.info("band: " + result[i].band); + console.info("frequency: " + result[i].frequency); + console.info("timestamp: " + result[i].timestamp); + } + }); + ``` + + +## WifiScanInfo + +WLAN热点信息。 + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

参数名

+

类型

+

读写属性

+

说明

+

ssid

+

string

+

只读

+

热点的SSID，编码格式为UTF-8。

+

bssid

+

string

+

只读

+

热点的BSSID。

+

securityType

+

WifiSecurityType

+

只读

+

WLAN加密类型。

+

rssi

+

number

+

只读

+

热点的信号强度(dBm)。

+

band

+

number

+

只读

+

WLAN接入点的频段。

+

frequency

+

number

+

只读

+

WLAN接入点的频率。

+

timestamp

+

number

+

只读

+

时间戳。

+
+ + diff --git a/zh-cn/application-dev/js-reference/apis/js-apis.md b/zh-cn/application-dev/js-reference/apis/js-apis.md index 19750b9bb5..391ecba4f9 100644 --- a/zh-cn/application-dev/js-reference/apis/js-apis.md +++ b/zh-cn/application-dev/js-reference/apis/js-apis.md @@ -1,21 +1,13 @@ # 接口 - **[Ability框架](js-apis-ability.md)** - - **[资源管理](js-apis-resource.md)** - - **[媒体](js-apis-multmedia.md)** - - **[数据管理](js-apis-data.md)** - - **[账号管理](js-apis-account.md)** - - **[电话服务](js-apis-telephony.md)** - +- **[网络与连接](js-apis-connectivity.md)** - **[设备管理](js-apis-device-mgmt.md)** - - **[基本功能](js-apis-basic-features.md)** - - **[语言基础类库](js-apis-base-library.md)** - -- GitLab