微信小程序API WIFI

2022-05-11 17:01 更新

wx.stopWifi(Object object)

基礎(chǔ)庫 1.6.0 開始支持,低版本需做兼容處理

關(guān)閉 Wi-Fi 模塊。

參數(shù)

Object object

屬性 類型 默認值 必填 說明
success function 接口調(diào)用成功的回調(diào)函數(shù)
fail function 接口調(diào)用失敗的回調(diào)函數(shù)
complete function 接口調(diào)用結(jié)束的回調(diào)函數(shù)(調(diào)用成功、失敗都會執(zhí)行)

錯誤

錯誤碼 錯誤信息 說明
0 ok 正常
12000 not init 未先調(diào)用 startWifi 接口
12001 system not support 當前系統(tǒng)不支持相關(guān)能力
12002 password error Wi-Fi 密碼錯誤
12003 connection timeout 連接超時
12004 duplicate request 重復(fù)連接 Wi-Fi
12005 wifi not turned on Android 特有,未打開 Wi-Fi 開關(guān)
12006 gps not turned on Android 特有,未打開 GPS 定位開關(guān)
12007 user denied 用戶拒絕授權(quán)鏈接 Wi-Fi
12008 invalid SSID 無效 SSID
12009 system config err 系統(tǒng)運營商配置拒絕連接 Wi-Fi
12010 system internal error 系統(tǒng)其他錯誤,需要在 errmsg 打印具體的錯誤原因
12011 weapp in background 應(yīng)用在后臺無法配置 Wi-Fi
12013 wifi config may be expired 系統(tǒng)保存的 Wi-Fi 配置過期,建議忘記 Wi-Fi 后重試

示例代碼

wx.stopWifi({
  success (res) {
    console.log(res.errMsg)
  }
})

wx.startWifi(Object object)

基礎(chǔ)庫 1.6.0 開始支持,低版本需做兼容處理。

初始化 Wi-Fi 模塊。

參數(shù)

Object object

屬性 類型 默認值 必填 說明
success function 接口調(diào)用成功的回調(diào)函數(shù)
fail function 接口調(diào)用失敗的回調(diào)函數(shù)
complete function 接口調(diào)用結(jié)束的回調(diào)函數(shù)(調(diào)用成功、失敗都會執(zhí)行)

錯誤

錯誤碼 錯誤信息 說明
0 ok 正常
12000 not init 未先調(diào)用 startWifi 接口
12001 system not support 當前系統(tǒng)不支持相關(guān)能力
12002 password error Wi-Fi 密碼錯誤
12003 connection timeout 連接超時
12004 duplicate request 重復(fù)連接 Wi-Fi
12005 wifi not turned on Android 特有,未打開 Wi-Fi 開關(guān)
12006 gps not turned on Android 特有,未打開 GPS 定位開關(guān)
12007 user denied 用戶拒絕授權(quán)鏈接 Wi-Fi
12008 invalid SSID 無效 SSID
12009 system config err 系統(tǒng)運營商配置拒絕連接 Wi-Fi
12010 system internal error 系統(tǒng)其他錯誤,需要在 errmsg 打印具體的錯誤原因
12011 weapp in background 應(yīng)用在后臺無法配置 Wi-Fi
12013 wifi config may be expired 系統(tǒng)保存的 Wi-Fi 配置過期,建議忘記 Wi-Fi 后重試

示例代碼

wx.startWifi({
  success (res) {
    console.log(res.errMsg)
  }
})

wx.setWifiList(Object object)

基礎(chǔ)庫 1.6.0 開始支持,低版本需做兼容處理。

設(shè)置 wifiList 中 AP 的相關(guān)信息。在 onGetWifiList 回調(diào)后調(diào)用,iOS特有接口。

參數(shù)

Object object

屬性 類型 默認值 必填 說明
wifiList Array.<Object> 提供預(yù)設(shè)的 Wi-Fi 信息列表
success function 接口調(diào)用成功的回調(diào)函數(shù)
fail function 接口調(diào)用失敗的回調(diào)函數(shù)
complete function 接口調(diào)用結(jié)束的回調(diào)函數(shù)(調(diào)用成功、失敗都會執(zhí)行)

object.wifiList 的結(jié)構(gòu)

屬性 類型 默認值 必填 說明
SSID string Wi-Fi 的 SSID
BSSID string Wi-Fi 的 BSSID
password string Wi-Fi 設(shè)備密碼

錯誤

錯誤碼 錯誤信息 說明
0 ok 正常
12000 not init 未先調(diào)用 startWifi 接口
12001 system not support 當前系統(tǒng)不支持相關(guān)能力
12002 password error Wi-Fi 密碼錯誤
12003 connection timeout 連接超時
12004 duplicate request 重復(fù)連接 Wi-Fi
12005 wifi not turned on Android 特有,未打開 Wi-Fi 開關(guān)
12006 gps not turned on Android 特有,未打開 GPS 定位開關(guān)
12007 user denied 用戶拒絕授權(quán)鏈接 Wi-Fi
12008 invalid SSID 無效 SSID
12009 system config err 系統(tǒng)運營商配置拒絕連接 Wi-Fi
12010 system internal error 系統(tǒng)其他錯誤,需要在 errmsg 打印具體的錯誤原因
12011 weapp in background 應(yīng)用在后臺無法配置 Wi-Fi
12013 wifi config may be expired 系統(tǒng)保存的 Wi-Fi 配置過期,建議忘記 Wi-Fi 后重試

注意

  • 該接口只能在 onGetWifiList 回調(diào)之后才能調(diào)用。
  • 此時客戶端會掛起,等待小程序設(shè)置 Wi-Fi 信息,請務(wù)必盡快調(diào)用該接口,若無數(shù)據(jù)請傳入一個空數(shù)組。
  • 有可能隨著周邊 Wi-Fi 列表的刷新,單個流程內(nèi)收到多次帶有存在重復(fù)的 Wi-Fi 列表的回調(diào)。

示例代碼

wx.onGetWifiList(function(res) {
  if (res.wifiList.length) {
    wx.setWifiList({
      wifiList: [{
        SSID: res.wifiList[0].SSID,
        BSSID: res.wifiList[0].BSSID,
        password: '123456'
      }]
    })
  } else {
    wx.setWifiList({
      wifiList: []
    })
  }
})
wx.getWifiList()


wx.onWifiConnected(function callback)

基礎(chǔ)庫 1.6.0 開始支持,低版本需做兼容處理。

監(jiān)聽連接上 Wi-Fi 的事件

參數(shù)

function callback

連接上 Wi-Fi 的事件的回調(diào)函數(shù)

參數(shù)

Object res
屬性 類型 說明
wifi WifiInfo Wi-Fi 信息

wx.onGetWifiList(function callback)

基礎(chǔ)庫 1.6.0 開始支持,低版本需做兼容處理。

監(jiān)聽獲取到 Wi-Fi 列表數(shù)據(jù)事件

參數(shù)

function callback

獲取到 Wi-Fi 列表數(shù)據(jù)事件的回調(diào)函數(shù)

參數(shù)

Object res
屬性 類型 說明
wifiList Array.<WifiInfo> Wi-Fi 列表數(shù)據(jù)

wx.offWifiConnected(function callback)

基礎(chǔ)庫 2.9.0 開始支持,低版本需做兼容處理。

取消監(jiān)聽連接上 Wi-Fi 的事件。

參數(shù)

function callback

連接上 Wi-Fi 的事件的回調(diào)函數(shù)


wx.offGetWifiList(function callback)

基礎(chǔ)庫 2.9.0 開始支持,低版本需做兼容處理。

取消監(jiān)聽獲取到 Wi-Fi 列表數(shù)據(jù)事件。

參數(shù)

function callback

獲取到 Wi-Fi 列表數(shù)據(jù)事件的回調(diào)函數(shù)


wx.getWifiList(Object object)

基礎(chǔ)庫 1.6.0 開始支持,低版本需做兼容處理。

請求獲取 Wi-Fi 列表。在 onGetWifiList 注冊的回調(diào)中返回 wifiList 數(shù)據(jù)。 Android 調(diào)用前需要 用戶授權(quán) scope.userLocation。

iOS 將跳轉(zhuǎn)到系統(tǒng)的 Wi-Fi 界面,Android 不會跳轉(zhuǎn)。 iOS 11.0 及 iOS 11.1 兩個版本因系統(tǒng)問題,該方法失效。但在 iOS 11.2 中已修復(fù)。

參數(shù)

Object object

屬性 類型 默認值 必填 說明
success function 接口調(diào)用成功的回調(diào)函數(shù)
fail function 接口調(diào)用失敗的回調(diào)函數(shù)
complete function 接口調(diào)用結(jié)束的回調(diào)函數(shù)(調(diào)用成功、失敗都會執(zhí)行)

錯誤

錯誤碼 錯誤信息 說明
0 ok 正常
12000 not init 未先調(diào)用 startWifi 接口
12001 system not support 當前系統(tǒng)不支持相關(guān)能力
12002 password error Wi-Fi 密碼錯誤
12003 connection timeout 連接超時
12004 duplicate request 重復(fù)連接 Wi-Fi
12005 wifi not turned on Android 特有,未打開 Wi-Fi 開關(guān)
12006 gps not turned on Android 特有,未打開 GPS 定位開關(guān)
12007 user denied 用戶拒絕授權(quán)鏈接 Wi-Fi
12008 invalid SSID 無效 SSID
12009 system config err 系統(tǒng)運營商配置拒絕連接 Wi-Fi
12010 system internal error 系統(tǒng)其他錯誤,需要在 errmsg 打印具體的錯誤原因
12011 weapp in background 應(yīng)用在后臺無法配置 Wi-Fi
12013 wifi config may be expired 系統(tǒng)保存的 Wi-Fi 配置過期,建議忘記 Wi-Fi 后重試

wx.getConnectedWifi(Object object)

基礎(chǔ)庫 1.6.0 開始支持,低版本需做兼容處理。

獲取已連接中的 Wi-Fi 信息。

參數(shù)

Object object

屬性 類型 默認值 必填 說明
success function 接口調(diào)用成功的回調(diào)函數(shù)
fail function 接口調(diào)用失敗的回調(diào)函數(shù)
complete function 接口調(diào)用結(jié)束的回調(diào)函數(shù)(調(diào)用成功、失敗都會執(zhí)行)

object.success 回調(diào)函數(shù)

參數(shù)
Object res
屬性 類型 說明
wifi WifiInfo Wi-Fi 信息

錯誤

錯誤碼 錯誤信息 說明
0 ok 正常
12000 not init 未先調(diào)用 startWifi 接口
12001 system not support 當前系統(tǒng)不支持相關(guān)能力
12002 password error Wi-Fi 密碼錯誤
12003 connection timeout 連接超時
12004 duplicate request 重復(fù)連接 Wi-Fi
12005 wifi not turned on Android 特有,未打開 Wi-Fi 開關(guān)
12006 gps not turned on Android 特有,未打開 GPS 定位開關(guān)
12007 user denied 用戶拒絕授權(quán)鏈接 Wi-Fi
12008 invalid SSID 無效 SSID
12009 system config err 系統(tǒng)運營商配置拒絕連接 Wi-Fi
12010 system internal error 系統(tǒng)其他錯誤,需要在 errmsg 打印具體的錯誤原因
12011 weapp in background 應(yīng)用在后臺無法配置 Wi-Fi
12013 wifi config may be expired 系統(tǒng)保存的 Wi-Fi 配置過期,建議忘記 Wi-Fi 后重試

wx.connectWifi(Object object)

基礎(chǔ)庫 1.6.0 開始支持,低版本需做兼容處理。

連接 Wi-Fi。若已知 Wi-Fi 信息,可以直接利用該接口連接。僅 Android 與 iOS 11 以上版本支持。

參數(shù)

Object object

屬性 類型 默認值 必填 說明 最低版本
SSID string Wi-Fi 設(shè)備 SSID
BSSID string Wi-Fi 設(shè)備 BSSID
password string Wi-Fi 設(shè)備密碼
maunal boolean false 跳轉(zhuǎn)到系統(tǒng)設(shè)置頁進行連接,僅安卓生效 2.12.0
success function 接口調(diào)用成功的回調(diào)函數(shù)
fail function 接口調(diào)用失敗的回調(diào)函數(shù)
complete function 接口調(diào)用結(jié)束的回調(diào)函數(shù)(調(diào)用成功、失敗都會執(zhí)行)

錯誤

錯誤碼 錯誤信息 說明
0 ok 正常
12000 not init 未先調(diào)用 startWifi 接口
12001 system not support 當前系統(tǒng)不支持相關(guān)能力
12002 password error Wi-Fi 密碼錯誤
12003 connection timeout 連接超時
12004 duplicate request 重復(fù)連接 Wi-Fi
12005 wifi not turned on Android 特有,未打開 Wi-Fi 開關(guān)
12006 gps not turned on Android 特有,未打開 GPS 定位開關(guān)
12007 user denied 用戶拒絕授權(quán)鏈接 Wi-Fi
12008 invalid SSID 無效 SSID
12009 system config err 系統(tǒng)運營商配置拒絕連接 Wi-Fi
12010 system internal error 系統(tǒng)其他錯誤,需要在 errmsg 打印具體的錯誤原因
12011 weapp in background 應(yīng)用在后臺無法配置 Wi-Fi
12013 wifi config may be expired 系統(tǒng)保存的 Wi-Fi 配置過期,建議忘記 Wi-Fi 后重試

示例代碼

wx.connectWifi({
  SSID: '',
  password: '',
  success (res) {
    console.log(res.errMsg)
  }
})

WifiInfo

Wifi 信息

屬性

string SSID

Wi-Fi 的 SSID

string BSSID

Wi-Fi 的 BSSID

boolean secure

Wi-Fi 是否安全

number signalStrength

Wi-Fi 信號強度

number frequency

基礎(chǔ)庫 2.12.0 開始支持,低版本需做兼容處理。

Wi-Fi 頻段單位 MHz


以上內(nèi)容是否對您有幫助:
在線筆記
App下載
App下載

掃描二維碼

下載編程獅App

公眾號
微信公眾號

編程獅公眾號