名称

WiFiScanClass::scanNetworks()

説明

WiFiネットワークをスキャンし、利用可能なネットワーク(アクセスポイント)を取得する。

書式

#include <WiFi.h>

int16_t WiFiScanClass::scanNetworks(bool async, bool show_hidden, bool passive, uint32_t max_ms_per_chan, uint8_t channel, const char * ssid, const uint8_t * bssid);

int16_t WiFiScanClass::scanNetworks(bool async, bool show_hidden, bool passive, uint32_t max_ms_per_chan, uint8_t channel);

引数

trueを指定した場合、非同期モードで動作する。非同期モードの場合は、この関数呼び出し後、WiFiScan.scanComplete()を呼び出し、結果を取得する。省略時はfalse。

trueを指定した場合、ステルスネットワークを表示する。省略時はfalse。

trueを指定した場合、パッシブスキャン、falseの場合、アクティブスキャン。省略時はfalse。

スキャン時に、各チャネルをスキャンする時間(ミリ秒)。省略時は300。

参考: https://esp-idf.readthedocs.io/en/latest/api-guides/wifi.html

戻り値

同期モードの場合、見つけたネットワーク(アクセスポイント)数。スキャンに失敗した場合は、WiFi_SCAN_FAILED。

非同期モードの場合、WIFI_SCAN_RUNNING。

注意

WiFiというWiFiClassのオブジェクトが事前に定義されており、このオブジェクトを利用して操作する。

WiFiClassは、WiFiGenericClass、WiFiSTAClass、WiFiScanClass、WiFiAPClassWiFiを継承したクラスである。

使用例

• WiFiScan

バージョン

最終更新日

September 4, 2022