Espruino:Справочник по API/Библиотека WiFi/scan(): различия между версиями

Материал из Онлайн справочника
Перейти к навигацииПерейти к поиску
Нет описания правки
Нет описания правки
Строка 3: Строка 3:
{{Myagkij-редактор}}
{{Myagkij-редактор}}


=<ref>[https://www.espruino.com/Reference#l_Wifi_scan www.espruino.com - require("Wifi").scan(callback)]</ref>=
=Функция Wifi.scan()<ref>[https://www.espruino.com/Reference#l_Wifi_scan www.espruino.com - require("Wifi").scan(callback)]</ref>=


==Синтаксис==
==Синтаксис==


<syntaxhighlight lang="javascript" enclose="div">
<syntaxhighlight lang="javascript" enclose="div">
 
require("Wifi").scan(callback)
</syntaxhighlight>
</syntaxhighlight>


==Параметры==
==Параметры==


 
* '''callback''' – функция callback(err, ap_list), вызываемая после завершения сканирования. При успешном выполнении в err будет null, а в ap_list – массив, а при неуспешном в err будет строка с ошибкой, а в ap_list – undefined.


==Возвращаемое значение==
==Возвращаемое значение==
Строка 21: Строка 21:
==Описание==
==Описание==


Выполняет сканирование точек доступа. Это включит режим станции (если он еще не включен). После завершения сканирования будет запущена функция обратного вызова, в аргументе ap_list которой будет массив с найденными точками доступа, и каждая точка доступа будет объектом, содержащим следующее:
* '''ssid''' – строка с [[SSID]].
* '''mac''' – [[MAC-адрес]] точки доступа в формате «00:00:00:00:00:00».
* '''authMode''' – режим аутентификации: open, wep, wpa, wpa2 или wpa_wpa2.
* '''channel''' – WiFi-канал (1-13).
* '''hidden''' – если [[SSID]] скрыт, здесь будет стоять true (только для [[ESP32]]/[[ESP8266]]).
* '''rssi''' – мощность сигнала (в дБ) в диапазоне от «-110» до «0».


'''Примечания:'''
* Чтобы выполнить сканирование, будет включен режим станции, который в итоге останется включенным. Чтобы снова выключить его, воспользуйтесь Wifi.disconnect().
* Одновременно можно выполнять только одно сканирование.


== Примеры ==
== Примеры ==

Версия от 17:43, 28 февраля 2021

Перевод: Максим Кузьмин
Проверка/Оформление/Редактирование: Мякишев Е.А.


Функция Wifi.scan()[1]

Синтаксис

require("Wifi").scan(callback)

Параметры

  • callback – функция callback(err, ap_list), вызываемая после завершения сканирования. При успешном выполнении в err будет null, а в ap_list – массив, а при неуспешном в err будет строка с ошибкой, а в ap_list – undefined.

Возвращаемое значение

Описание

Выполняет сканирование точек доступа. Это включит режим станции (если он еще не включен). После завершения сканирования будет запущена функция обратного вызова, в аргументе ap_list которой будет массив с найденными точками доступа, и каждая точка доступа будет объектом, содержащим следующее:

  • ssid – строка с SSID.
  • macMAC-адрес точки доступа в формате «00:00:00:00:00:00».
  • authMode – режим аутентификации: open, wep, wpa, wpa2 или wpa_wpa2.
  • channel – WiFi-канал (1-13).
  • hidden – если SSID скрыт, здесь будет стоять true (только для ESP32/ESP8266).
  • rssi – мощность сигнала (в дБ) в диапазоне от «-110» до «0».

Примечания:

  • Чтобы выполнить сканирование, будет включен режим станции, который в итоге останется включенным. Чтобы снова выключить его, воспользуйтесь Wifi.disconnect().
  • Одновременно можно выполнять только одно сканирование.

Примеры

См.также

Внешние ссылки