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

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


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


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


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


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


 
* '''callback''' – опциональная функция callback(details), запускаемая вместе с возвращением информации о WiFi-соединении. Объект details – это тот же самый объект, что возвращается этой функцией напрямую


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


 
Объект details, содержащий информацию о WiFi-соединении станции (если она доступна незамедлительно).


==Описание==
==Описание==


Возвращает информацию о настройках и состоянии WiFi-соединения станции в виде объекта details, который содержит следующие свойства:
* '''status''' – здесь будет информация о состоянии WiFi-соединения: off, connecting, wrong_password, no_ap_found, connect_fail или connected. Состояния off, bad_password и connected стабильны, а все остальные могут быть изменены. Состояние connecting приведет либо к connected, либо к одному из ошибочных состояний (bad_password, no_ap_found, connect_fail), а состояния no_ap_found и connect_fail через некоторое время приведут к новой попытке подключения.
* '''rssi''' – мощность сигнала подключенной точки доступа (в дБ). Обычно варьируется в диапазоне ''от «-110» до «0»'' (любое значение выше ''«-30»'' – это очень сильный сигнал).
* '''ssid''' – [[SSID]] точки доступа.
* '''password''' – пароль, используемый для подключения к точке доступа.
* '''authMode''' – метод аутентификации: open, wpa, wpa2, wpa_wpa2 (в данный момент не поддерживается).
* '''savedSsid''' – [[SSID]] для автоматического подключения во время загрузки (null будет означать отсутствие этого [[SSID]]).


'''Примечание:''' Эта функция доступна только для плат на базе [[ESP32]] и [[ESP8266]], работающих на [[Espruino]].


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

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

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


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

Синтаксис

require("Wifi").getDetails(callback)

Параметры

  • callback – опциональная функция callback(details), запускаемая вместе с возвращением информации о WiFi-соединении. Объект details – это тот же самый объект, что возвращается этой функцией напрямую

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

Объект details, содержащий информацию о WiFi-соединении станции (если она доступна незамедлительно).

Описание

Возвращает информацию о настройках и состоянии WiFi-соединения станции в виде объекта details, который содержит следующие свойства:

  • status – здесь будет информация о состоянии WiFi-соединения: off, connecting, wrong_password, no_ap_found, connect_fail или connected. Состояния off, bad_password и connected стабильны, а все остальные могут быть изменены. Состояние connecting приведет либо к connected, либо к одному из ошибочных состояний (bad_password, no_ap_found, connect_fail), а состояния no_ap_found и connect_fail через некоторое время приведут к новой попытке подключения.
  • rssi – мощность сигнала подключенной точки доступа (в дБ). Обычно варьируется в диапазоне от «-110» до «0» (любое значение выше «-30» – это очень сильный сигнал).
  • ssidSSID точки доступа.
  • password – пароль, используемый для подключения к точке доступа.
  • authMode – метод аутентификации: open, wpa, wpa2, wpa_wpa2 (в данный момент не поддерживается).
  • savedSsidSSID для автоматического подключения во время загрузки (null будет означать отсутствие этого SSID).

Примечание: Эта функция доступна только для плат на базе ESP32 и ESP8266, работающих на Espruino.

Примеры

См.также

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