Wifi softap ssid password

Soft Access Point Class¶

Section below is ESP8266 specific as Arduino WiFi library documentation does not cover soft access point. The API description is broken down into three short chapters. They cover how to setup soft-AP, manage connection, and obtain information on soft-AP interface configuration.

Table of Contents¶

Set up Network¶

This section describes functions to set up and configure ESP8266 in the soft access point (soft-AP) mode.

softAP¶

Set up a soft access point to establish a Wi-Fi network.

The simplest version (an overload in C++ terms) of this function requires only one parameter and is used to set up an open Wi-Fi network.

To set up pre-shared key protected network, or to configure additional network parameters, use the following overload:

WiFi.softAP(ssid, psk, channel, hidden, max_connection) 

The first parameter of this function is required, remaining four are optional.

Meaning of all parameters is as follows:

• ssid — character string containing network SSID (max. 32 characters)
• psk — optional character string with a pre-shared key. For WPA2-PSK network it should be minimum 8 characters long and not longer than 64 characters. If not specified, the access point will be open for anybody to connect.
• channel — optional parameter to set Wi-Fi channel, from 1 to 13. Default channel = 1.
• hidden — optional parameter, if set to true will hide SSID.
• max_connection — optional parameter to set max simultaneous connected stations, from 0 to 8. Defaults to 4. Once the max number has been reached, any other station that wants to connect will be forced to wait until an already connected station disconnects.

Function will return true or false depending on result of setting the soft-AP.

• The network established by softAP will have default IP address of 192.168.4.1. This address may be changed using softAPConfig (see below).
• Even though ESP8266 can operate in soft-AP + station mode, it actually has only one hardware channel. Therefore in soft-AP + station mode, the soft-AP channel will default to the number used by station. For more information how this may affect operation of stations connected to ESP8266’s soft-AP, please check this FAQ entry on Espressif forum.

softAPConfig¶

Configure the soft access point’s network interface.

softAPConfig (local_ip, gateway, subnet) 

All parameters are the type of IPAddress and defined as follows:

• local_ip — IP address of the soft access point
• gateway — gateway IP address
• subnet — subnet mask

Function will return true or false depending on result of changing the configuration.

#include IPAddress local_IP(192,168,4,22); IPAddress gateway(192,168,4,9); IPAddress subnet(255,255,255,0); void setup()  Serial.begin(115200); Serial.println(); Serial.print("Setting soft-AP configuration . "); Serial.println(WiFi.softAPConfig(local_IP, gateway, subnet) ? "Ready" : "Failed!"); Serial.print("Setting soft-AP . "); Serial.println(WiFi.softAP("ESPsoftAP_01") ? "Ready" : "Failed!"); Serial.print("Soft-AP IP address = "); Serial.println(WiFi.softAPIP()); > void loop() <> 

Setting soft-AP configuration . Ready Setting soft-AP . Ready Soft-AP IP address = 192.168.4.22 

Manage Network¶

Once soft-AP is established you may check the number of stations connected, or shut it down, using the following functions.

softAPgetStationNum¶

Get the count of the stations that are connected to the soft-AP interface.

Serial.printf("Stations connected to soft-AP = %d\n", WiFi.softAPgetStationNum()); 

Stations connected to soft-AP = 2 

Note: the maximum number of stations that may be connected to ESP8266 soft-AP is 4 by default. This can be changed from 0 to 8 via the max_connection argument of the softAP method.

softAPdisconnect¶

Disconnect stations from the network established by the soft-AP.

WiFi.softAPdisconnect(wifioff) 

Function will set currently configured SSID and pre-shared key of the soft-AP to null values. The parameter wifioff is optional. If set to true it will switch the soft-AP mode off.

Function will return true if operation was successful or false if otherwise.

Network Configuration¶

Functions below provide IP and MAC address of ESP8266’s soft-AP.

softAPIP¶

Return IP address of the soft access point’s network interface.

Returned value is of IPAddress type.

Serial.print("Soft-AP IP address = "); Serial.println(WiFi.softAPIP()); 

Soft-AP IP address = 192.168.4.1 

softAPmacAddress¶

Return MAC address of soft access point. This function comes in two versions, which differ in type of returned values. First returns a pointer, the second a String .

Pointer to MAC¶

Function accepts one parameter mac that is a pointer to memory location (an uint8_t array the size of 6 elements) to save the mac address. The same pointer value is returned by the function itself.

uint8_t macAddr[6]; WiFi.softAPmacAddress(macAddr); Serial.printf("MAC address = %02x:%02x:%02x:%02x:%02x:%02x\n", macAddr[0], macAddr[1], macAddr[2], macAddr[3], macAddr[4], macAddr[5]); 

MAC address = 5e:cf:7f:8b:10:13 

MAC as a String¶

Optionally you can use function without any parameters that returns a String type value.

Serial.printf("MAC address = %s\n", WiFi.softAPmacAddress().c_str()); 

MAC address = 5E:CF:7F:8B:10:13 

For code samples please refer to separate section with examples dedicated specifically to the Soft Access Point Class.

© Copyright 2017, Ivan Grokhotkov Revision 521ae60a .

Источник

Класс точки доступа в библиотеке ESP8266WiFi [1]

Описание класса точки доступа будет разбито на три части. Первая – о функциях для настройки программной точки доступа, вторая – для управлении подключением, третья – для извлечения информации о настройках программной точки доступа.

Настройка программной точки доступа

Этот радел описывает функции для настройки ESP8266 в режим программной точки доступа.

softAP()

Задает режим программной точки доступа для установления WiFi-сети.

Самой простой версии этой функции нужен только один параметр. Она используется для настройки открытой WiFi-сети.

Чтобы задать сеть, защищенную паролем, или задать дополнительные параметры сети, используйте следующий вариант:

WiFi.softAP(ssid, password, channel, hidden) 

Первый параметр обязателен, все остальные – опциональны. Параметры значат следующее:

• ssid – символьная строка, содержащая SSID сети (не более 63 символов)
• password – опциональная символьная строка для пароля. Для сети WPA-PSK ее размер должен быть не более 8 символов. Если пароля не указать, к сети сможет подключиться кто угодно
• channel – опциональный параметр для настройки WiFi-канала (от «1» до «13»). Канал по умолчанию – «1»
• hidden – опциональный параметр. Если задать true, это спрячет SSID

В зависимости от результата (т.е. от того, будет ли настроена точка доступа или нет) функция вернет true или false.

• По умолчанию IP-адресом настроенной программной точки доступа будет «192.168.4.1». Его можно поменять при помощи функции softAPConfig(). Подробней о ней читайте ниже.
• Хотя ESP8266 может работать в комбинированном режиме (станция + точка доступа), у него только один аппаратный канал. Следовательно, по умолчанию в комбинированном режиме номер канала точки доступа будет таким же, как и у станции. Более подробно о том, как это может повлиять на станции, подключенные к программной точке доступа ESP8266, читайте в этом FAQ на форуме Espressif

softAPConfig()

Настраивает сетевой интерфейс программной точки доступа.

softAPConfig (local_ip, gateway, subnet) 

Все аргументы имеют тип данных IPAddress и нужны для следующих целей:

• local_ip – IP-адрес программной точки доступа
• gateway – IP-адрес шлюза
• subnet – маска подсети

В зависимости от результата (т.е. от того, удалось ли задать настройки) функция вернет true или false.

#include IPAddress local_IP(192,168,4,22); IPAddress gateway(192,168,4,9); IPAddress subnet(255,255,255,0); void setup()  Serial.begin(115200); Serial.println(); Serial.print("Setting soft-AP configuration . "); // "Задаем настройки программной точки доступа . " Serial.println(WiFi.softAPConfig(local_IP, gateway, subnet) ? "Ready" : "Failed!"); // "Готово" : "Задать настройки не удалось" Serial.print("Setting soft-AP . "); // "Настройка программной точки доступа . " Serial.println(WiFi.softAP("ESPsoftAP_01") ? "Ready" : "Failed!"); // "Готово" : "Настройка не удалась" Serial.print("Soft-AP IP address = "); // "IP-адрес программной точки доступа = " Serial.println(WiFi.softAPIP()); > void loop() <> 

Пример данных, которые могут быть показаны в мониторе порта:

Setting soft-AP configuration . Ready Setting soft-AP . Ready Soft-AP IP address = 192.168.4.22

Управление сетью

Настроив программную точку доступа, вы можете, к примеру, выключить ее или проверить количество станций, подключенных к ней.

softAPgetStationNum()

Извлекает информацию о количестве станций, подключенных к точке доступа.

Serial.printf("Stations connected to soft-AP = %d\n", WiFi.softAPgetStationNum()); // "Станции подключенные к точке доступа = " 

Пример данных, которые могут быть показаны в мониторе порта:

Stations connected to soft-AP = 2 

Примечание: Максимальное число станций, которые можно подключить к программной точке доступа на базе ESP8266, равняется пяти.

softAPdisconnect()

Отключает станции от сети, установленной программной точкой доступа.

WiFi.softAPdisconnect(wifioff) 

Эта функция выставляет текущие SSID и пароль на нулевые значения. Параметр wifioff – опциональный. Если поставить в нем true, это выключит режим программной точки доступа.

Если задача будет выполнена успешно, функция вернет true, а если нет – false.

Извлечение данных о настройках сети

Функции ниже извлекают информацию о IP-адресе и MAC-адресе программной точки доступа ESP8266.

softIP()

Возвращает IP-адрес сетевого интерфейса программной точки доступа.

Возвращаемое значение имеет тип данных IPAddress.

Serial.print("Soft-AP IP address = "); // "IP-адрес программной точки доступа = " Serial.println(WiFi.softAPIP()); 

Пример данных, которые могут быть показаны в мониторе порта:

Soft-AP IP address = 192.168.4.1 

softAPmacAddress()

Возвращает MAC-адрес программной точки доступа. Эта функция имеет две версии, которые отличаются по типу возвращаемого значения.

Первая версия возвращает указатель:

Параметр mac – это указатель к месту памяти (массив uint8_t размером в 6 элементов), в котором хранится MAC-адрес. Сама функция тоже возвращает указатель.

uint8_t macAddr[6]; WiFi.softAPmacAddress(macAddr); Serial.printf("MAC address = %02x:%02x:%02x:%02x:%02x:%02x\n", macAddr[0], macAddr[1], macAddr[2], macAddr[3], macAddr[4], macAddr[5]); // "MAC-адрес = " 

Пример данных, которые могут быть показаны в мониторе порта:

MAC address = 5e:cf:7f:8b:10:13

Вторая версия возвращает строку (тип данных String):

Это опциональный вариант, которому не нужны никакие параметры.

Serial.printf("MAC address = %s\n", WiFi.softAPmacAddress().c_str()); // "MAC-адрес = " 

Пример данных, которые могут быть показаны в мониторе порта:

MAC address = 5E:CF:7F:8B:10:13

Другие примеры использования функций, входящих в класс точки доступа, ищите по [ссылка этой ссылке].

См.также

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

Источник