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

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


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


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


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


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


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


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


 
Объект с информацией о текущей точке доступа (если эти данные доступны незамедлительно).


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


Возвращает информацию о настройках и состоянии текущей точки доступа. В объекте '''details''' содержится следующее:
* '''status''' – текущее состояние точки доступа ('''enabled''' или '''disabled''').
* '''stations''' – массив с информацией о станциях, подключенных к точке доступа. Этот массив может быть пуст. Каждый элемент в массиве – это объект, описывающий станцию. Он будет содержать как минимум поле '''ip''', обозначающее [[IP-адрес]] станции.
* '''ssid''' – рассылаемый [[SSID]].
* '''password''' – пароль для аутентификации.
* '''authMode''' – метод аутентификации, требуемый от станций: open, wpa, wpa2, wpa_wpa2.
* '''hidden''' – если [[SSID]] скрыт, здесь будет true, а если нет, то false.
* '''maxConn''' – максимальное количество поддерживаемых подключений к станциям.
* '''savedSsid''' – [[SSID]], который будет автоматически рассылаться во время загрузки, или null, если точка доступа во время загрузки будет отключена.


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


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

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

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


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

Синтаксис

require("Wifi").getAPDetails(callback)

Параметры

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

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

Объект с информацией о текущей точке доступа (если эти данные доступны незамедлительно).

Описание

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

  • status – текущее состояние точки доступа (enabled или disabled).
  • stations – массив с информацией о станциях, подключенных к точке доступа. Этот массив может быть пуст. Каждый элемент в массиве – это объект, описывающий станцию. Он будет содержать как минимум поле ip, обозначающее IP-адрес станции.
  • ssid – рассылаемый SSID.
  • password – пароль для аутентификации.
  • authMode – метод аутентификации, требуемый от станций: open, wpa, wpa2, wpa_wpa2.
  • hidden – если SSID скрыт, здесь будет true, а если нет, то false.
  • maxConn – максимальное количество поддерживаемых подключений к станциям.
  • savedSsidSSID, который будет автоматически рассылаться во время загрузки, или null, если точка доступа во время загрузки будет отключена.

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

Примеры

См.также

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