23. nqWiFi
nqWiFiオブジェクトは、WiFi接続情報を取得するための組み込みオブジェクトです。
機能概要:
- WiFi接続情報を取得する機能を提供します。
- WiFiモジュールの固有情報を取得する機能を提供します。
- システムLEDを使用してアンテナレベル状態を表示する機能を提供します。
制限事項:
- NEQTO Bridge Wi-Fiモジュールのみ使用可能です。
nqWiFi Global Object
| Methods()/Properties | Summary | Version | Note |
|---|---|---|---|
| nqWiFi.getIDs() | WiFiモジュールの固有情報を取得します。 | 00.00.16+ | |
| nqWiFi.getSignalQuality() | 接続しているWiFi-AP情報を取得します。 | 00.00.16+ | |
| nqWiFi.getScanList() | 周辺WiFi-AP情報を取得します。 | 00.00.16+ | |
| nqWiFi.setAntennaLed() | アンテナレベル表示を設定します。 | 00.00.28+ | |
| nqWiFi.isConnected() | WiFi通信状態を取得します。 | 02.00.00+ |
Details
nqWiFi.getIDs(callback)
WiFiモジュールの固有情報を取得します。
| Name | Type | M/O | Summary | Note |
|---|---|---|---|---|
| callback(id) | function | mandatory | 情報取得完了時にコールバック処理を実行します。 id : {WifiID} WiFiモジュールの固有情報 | |
| return | undefined | - | - |
{WifiID}
| Name | Type | M/O | Note |
|---|---|---|---|
| .macAddr | string | WiFi MACアドレス | 未取得時は00:00:00:00:00:00となります。 |
nqWiFi.getSignalQuality(callback)
接続しているWiFi-AP情報を取得します。
| Name | Type | M/O | Summary | Note |
|---|---|---|---|---|
| callback(sq) | function | mandatory | 情報取得完了時にコールバック処理を実行します。 sq : {SignalQuality} 接続しているWiFi-AP情報 | |
| return | undefined | - | - |
{SignalQuality}
| Name | Type | Summary | Note |
|---|---|---|---|
| .macAddr | string | WiFi MACアドレス 未接続時は00:00:00:00:00:00となります。 | |
| .ssid | string | WiFi-APのSSID 未接続時は空白となります。 | |
| .rssi | number | 現在の受信信号強度[dBm] 未接続時は-255となります。(Version 02.00.00+) 未接続時は-32768となります。(旧バージョン) |
nqWiFi.getScanList(callback[,option])
周辺WiFi-AP情報を取得します。
| Name | Type | M/O | Summary | Note |
|---|---|---|---|---|
| callback(apList) | function | mandatory | 情報取得完了時にコールバック処理を実行します。 apList : {ApList} 周辺WiFi-AP情報 | |
| option | string | optional | オプション 'stealth'を指定した場合、ステルスAPもリストアップします。 | Version 00.00.18+ |
| return | undefined | - | - |
{ApList}
| Name | Type | Summary | Note |
|---|---|---|---|
| .result | boolean | 取得結果 取得に失敗した場合、falseとなります。 | |
| [ ] | {ApInfo} | {ApInfo}の配列({array})です。 最大10件の周辺WiFi-AP情報を取得します。 |
{ApInfo}
| Name | Type | Summary | Note |
|---|---|---|---|
| .macAddr | string | WiFi MACアドレス | |
| .ssid | string | WiFi-APのSSID | |
| .rssi | number | 受信信号強度[dBm] |
nqWiFi.setAntennaLed(ctl)
アンテナレベル表示を設定します。
システムLEDを使用してアンテナレベル状態を表示します。
| Name | Type | M/O | Summary | Note |
|---|---|---|---|---|
| ctl | boolean | mandatory | LEDアンテナレベル表示設定 true: LEDでアンテナレベルを示します。 false: 通常動作 デフォルト値はfalseとなります。 LEDの表示パターンはシステムLED動作を参照してください。 | |
| return | undefined | - | - |
nqWiFi.isConnected()
WiFi通信状態を取得します。
| Name | Type | M/O | Summary | Note |
|---|---|---|---|---|
| return | boolean | - | WiFi通信状態 true: 通信可能 false: 通信不可 |
オブジェクトの使用例
Sample 1
自身のWiFi MACアドレスを取得して表示するサンプルです。
nqWiFi.getIDs(function(id){
print(id.macAddr);
});
Sample 2
接続しているWiFi-AP情報を取得して表示するサンプルです。
nqWiFi.getSignalQuality(function(sq){
print("MAC --> " + sq.macAddr);
print("SSID --> " + sq.ssid);
print("RSSI --> " + sq.rssi);
});
Sample 3
周辺WiFi-AP情報を取得して表示するサンプルです。
nqWiFi.getScanList(function(aplist){
if (false != aplist.result) {
for(n = 0; n < aplist.length; n++) {
print("-----");
print("MAC --> " + aplist[n].macAddr);
print("SSID --> " + aplist[n].ssid);
print("RSSI --> " + aplist[n].rssi);
}
}
});
Updated: 2022-06-24