ESP32中文文档（1）WiFi库-WiFiAP

ESP32中文文档（1）WiFi库-WiFiAP

本人水平有限，本文仅供参考。

头文件：WiFiAP.h

环境：Arduino-ESP32

描述：WiFi AP接入模式库，提供无线接入服务，允许其它无线设备接入，提供数据访问。

WiFiAPClass

WiFiAP类

softAP

原型

bool WiFiAPClass::softAP(const char* ssid, const char* passphrase, int channel, int ssid_hidden, int max_connection)

描述

设置接入点

参数名	类型	说明	备注
ssid	const char*	WiFi名称（SSID）	最多63个字符
passphras	const char*	WiFi密码	密码至少8个字符，NULL为无密码
channel	int	WiFi信道	可选1 - 13
ssid_hidden	int	WiFi是否隐藏	0为广播，1为隐藏
max_connection	int	最大连接终端数	可选1 - 4

返回值

类型：bool

创建成功返回true，失败返回false

softAPConfig

原型

bool WiFiAPClass::softAPConfig(IPAddress local_ip, IPAddress gateway, IPAddress subnet)

描述

配置接入点

参数名	类型	说明	备注
local_ip	IPAddress	接入点IP	IPAddress型的数据
gateway	IPAddress	网关IP地址	IPAddress型的数据
subnet	IPAddress	子网掩码	IPAddress型的数据

返回值

类型：bool

配置成功返回true，失败返回false

softAPdisconnect

原型

bool WiFiAPClass::softAPdisconnect(bool wifioff)

描述

关闭接入点模式

参数名	类型	说明	备注
wifioff	bool	是否关闭	ture为直接关闭，false为清空SSID和密码

返回值

类型：bool

成功返回true，失败返回false

softAPgetStationNum

原型

uint8_t WiFiAPClass::softAPgetStationNum()

描述

获取连接到softAP上的终端数量

返回值

类型：uint8_t

描述：终端的数量

softAPIP

原型

IPAddress WiFiAPClass::softAPIP()

描述

获取接入点的本地IP地址

返回值

类型：IPAddress

描述：IP地址

softAPBroadcastIP

原型

IPAddress WiFiAPClass::softAPBroadcastIP()

描述

获取接入点的广播IP地址

返回值

类型：IPAddress

描述：IP地址

softAPNetworkID

原型

IPAddress WiFiAPClass::softAPNetworkID()

描述

获取接入点网络ID

返回值

类型：IPAddress

描述：IP地址

softAPSubnetCIDR

原型

uint8_t WiFiAPClass::softAPSubnetCIDR()

描述

获取子网CIDR

返回值

类型：uint8_t

描述：子网CIDR

softAPmacAddress

原型

uint8_t* WiFiAPClass::softAPmacAddress(uint8_t* mac)
String WiFiAPClass::softAPmacAddress(void)

描述

获取接入点的MAC地址

参数名	类型	说明	备注
mac	uint8_t*	指向存放mac地址的变量的指针	可空，否者必须是uint8_t类型的数组

返回值

类型 1：uint8_t*

类型 2：String

描述：接入点的MAC地址

softAPgetHostname

原型

const char* WiFiAPClass::softAPgetHostname()

描述

获取接入点主机名

返回值

类型：const char*

描述：主机名

softAPsetHostname

原型

bool WiFiAPClass::softAPsetHostname(const char *hostname)

描述

设置主机名

参数名	类型	说明	备注
hostname	const char *	主机名	指向主机名的指针

返回值

类型：bool

描述：成功返回true，失败返回flase

softAPenableIpV6

原型

bool WiFiAPClass::softAPenableIpV6()

描述

在接入点上启用IPv6

返回值

类型：bool

描述：成功返回true，失败返回flase

softAPIPv6

原型

IPv6Address WiFiAPClass::softAPIPv6()

描述

获取IPv6地址

返回值

类型：IPv6Address

描述：IPv6地址