Class WiFiClass

ClassList > WiFiClass

Public Attributes

Type	Name
void *	data
WiFiScanData *	scan = = NULL

Public Functions

Type	Name
uint8_t *	BSSID ()
uint8_t *	BSSID (uint8_t networkItem)
String	BSSIDstr ()
String	BSSIDstr (uint8_t networkItem)
int8_t	RSSI ()
int32_t	RSSI (uint8_t networkItem)
const String	SSID ()
String	SSID (uint8_t networkItem)
	WiFiClass ()
std::vector< IPv6Address >	allLocalIPv6 ()
WiFiStatus	begin (const char * ssid, const char * passphrase=NULL, int32_t channel=0, const uint8_t * bssid=NULL, bool connect=true)
WiFiStatus	begin (char * ssid, char * passphrase=NULL, int32_t channel=0, const uint8_t * bssid=NULL, bool connect=true)
IPAddress	broadcastIP ()
int32_t	channel ()
int32_t	channel (uint8_t networkItem)
bool	config (IPAddress localIP, IPAddress gateway, IPAddress subnet, IPAddress dns1=(uint32_t) 0x00000000, IPAddress dns2=(uint32_t) 0x00000000)
void	dataFree ()
void	dataInitialize ()
bool	disconnect (bool wifiOff=false)
IPAddress	dnsIP (uint8_t dns_no=0)
bool	enableAP (bool enable)
bool	enableIpV6 ()
bool	enableSTA (bool enable)
WiFiAuthMode	encryptionType (uint8_t networkItem)
IPAddress	gatewayIP ()
bool	getAutoReconnect ()
WiFiAuthMode	getEncryption ()
const char *	getHostname ()
WiFiMode	getMode ()
bool	getNetworkInfo (uint8_t networkItem, String & ssid, WiFiAuthMode & encryptionType, int32_t & RSSI, uint8_t *& BSSID, int32_t & channel)
bool	getSleep ()
int	getTxPower ()
int	hostByName (const char * hostname, IPAddress & aResult)
IPAddress	hostByName (const char * hostname)
bool	hostname (const String & aHostname)
bool	isConnected ()
IPAddress	localIP ()
IPv6Address	localIPv6 ()
uint8_t *	macAddress (uint8_t * mac)
String	macAddress ()
bool	mode (WiFiMode mode)
bool	modePriv (WiFiMode mode, WiFiModeAction sta, WiFiModeAction ap)
IPAddress	networkID ()
uint16_t	onEvent (EventCb callback, EventId eventId=ARDUINO_EVENT_MAX)
uint16_t	onEvent (EventFuncCb callback, EventId eventId=ARDUINO_EVENT_MAX)
uint16_t	onEvent (EventSysCb callback, EventId eventId=ARDUINO_EVENT_MAX)
void	printDiag (Print & dest)
const String	psk ()
bool	reconnect (const uint8_t * bssid=NULL)
void	removeEvent (EventCb callback, EventId eventId)
void	removeEvent (EventSysCb callback, EventId eventId)
void	removeEvent (uint16_t id)
uint8_t	scanAlloc (uint8_t count)
int16_t	scanComplete ()
void	scanDelete ()
void	scanInit ()
int16_t	scanNetworks (bool async=false, bool showHidden=false, bool passive=false, uint32_t maxMsPerChannel=300, uint8_t channel=0)
bool	setAutoReconnect (bool autoReconnect)
bool	setHostname (const char * hostname)
bool	setMacAddress (const uint8_t * mac)
bool	setSleep (bool enable)
bool	setTxPower (int power)
bool	softAP (const char * ssid, const char * passphrase=NULL, int channel=1, bool ssidHidden=false, int maxClients=4)
IPAddress	softAPBroadcastIP ()
bool	softAPConfig (IPAddress localIP, IPAddress gateway, IPAddress subnet)
IPAddress	softAPIP ()
IPv6Address	softAPIPv6 ()
IPAddress	softAPNetworkID ()
const String	softAPSSID (void)
uint8_t	softAPSubnetCIDR ()
IPAddress	softAPSubnetMask ()
bool	softAPdisconnect (bool wifiOff=false)
bool	softAPenableIpV6 ()
const char *	softAPgetHostname ()
uint8_t	softAPgetStationNum ()
uint8_t *	softAPmacAddress (uint8_t * mac)
String	softAPmacAddress (void)
bool	softAPsetHostname (const char * hostname)
WiFiStatus	status ()
uint8_t	subnetCIDR ()
IPAddress	subnetMask ()
bool	validate (const char * ssid, const char * passphrase)
WiFiStatus	waitForConnectResult (unsigned long timeout)
	~WiFiClass ()

Public Static Functions

Type	Name
IPAddress	calculateBroadcast (IPAddress ip, IPAddress subnet)
IPAddress	calculateNetworkID (IPAddress ip, IPAddress subnet)
uint8_t	calculateSubnetCIDR (IPAddress subnetMask)
String	macToString (uint8_t * mac)
void	postEvent (EventId eventId, EventInfo eventInfo)
void	resetNetworkInfo (WiFiNetworkInfo & info)

Protected Static Attributes

Type	Name
std::vector< EventHandler >	handlers

Public Attributes Documentation

variable data

void* WiFiClass::data;

variable scan

WiFiScanData* WiFiClass::scan;

Public Functions Documentation

function BSSID [1/2]

uint8_t * WiFiClass::BSSID () 

function BSSID [2/2]

uint8_t * WiFiClass::BSSID (
    uint8_t networkItem
) 

function BSSIDstr [1/2]

String WiFiClass::BSSIDstr () 

function BSSIDstr [2/2]

String WiFiClass::BSSIDstr (
    uint8_t networkItem
) 

function RSSI [1/2]

int8_t WiFiClass::RSSI () 

function RSSI [2/2]

int32_t WiFiClass::RSSI (
    uint8_t networkItem
) 

function SSID [1/2]

const String WiFiClass::SSID () 

function SSID [2/2]

String WiFiClass::SSID (
    uint8_t networkItem
) 

function WiFiClass

WiFiClass::WiFiClass () 

function allLocalIPv6

std::vector< IPv6Address > WiFiClass::allLocalIPv6 () 

function begin [1/2]

WiFiStatus WiFiClass::begin (
    const char * ssid,
    const char * passphrase=NULL,
    int32_t channel=0,
    const uint8_t * bssid=NULL,
    bool connect=true
) 

function begin [2/2]

WiFiStatus WiFiClass::begin (
    char * ssid,
    char * passphrase=NULL,
    int32_t channel=0,
    const uint8_t * bssid=NULL,
    bool connect=true
) 

function broadcastIP

IPAddress WiFiClass::broadcastIP () 

function channel [1/2]

int32_t WiFiClass::channel () 

function channel [2/2]

int32_t WiFiClass::channel (
    uint8_t networkItem
) 

function config

bool WiFiClass::config (
    IPAddress localIP,
    IPAddress gateway,
    IPAddress subnet,
    IPAddress dns1=(uint32_t) 0x00000000,
    IPAddress dns2=(uint32_t) 0x00000000
) 

function dataFree

void WiFiClass::dataFree () 

function dataInitialize

void WiFiClass::dataInitialize () 

function disconnect

bool WiFiClass::disconnect (
    bool wifiOff=false
) 

function dnsIP

IPAddress WiFiClass::dnsIP (
    uint8_t dns_no=0
) 

function enableAP

bool WiFiClass::enableAP (
    bool enable
) 

function enableIpV6

bool WiFiClass::enableIpV6 () 

function enableSTA

bool WiFiClass::enableSTA (
    bool enable
) 

function encryptionType

WiFiAuthMode WiFiClass::encryptionType (
    uint8_t networkItem
) 

function gatewayIP

IPAddress WiFiClass::gatewayIP () 

function getAutoReconnect

bool WiFiClass::getAutoReconnect () 

function getEncryption

WiFiAuthMode WiFiClass::getEncryption () 

function getHostname

const char * WiFiClass::getHostname () 

function getMode

WiFiMode WiFiClass::getMode () 

function getNetworkInfo

bool WiFiClass::getNetworkInfo (
    uint8_t networkItem,
    String & ssid,
    WiFiAuthMode & encryptionType,
    int32_t & RSSI,
    uint8_t *& BSSID,
    int32_t & channel
) 

function getSleep

bool WiFiClass::getSleep () 

function getTxPower

int WiFiClass::getTxPower () 

function hostByName [1/2]

int WiFiClass::hostByName (
    const char * hostname,
    IPAddress & aResult
) 

function hostByName [2/2]

IPAddress WiFiClass::hostByName (
    const char * hostname
) 

function hostname

inline bool WiFiClass::hostname (
    const String & aHostname
) 

function isConnected

bool WiFiClass::isConnected () 

function localIP

IPAddress WiFiClass::localIP () 

function localIPv6

IPv6Address WiFiClass::localIPv6 () 

function macAddress [1/2]

uint8_t * WiFiClass::macAddress (
    uint8_t * mac
) 

function macAddress [2/2]

String WiFiClass::macAddress () 

function mode

bool WiFiClass::mode (
    WiFiMode mode
) 

function modePriv

bool WiFiClass::modePriv (
    WiFiMode mode,
    WiFiModeAction sta,
    WiFiModeAction ap
) 

function networkID

IPAddress WiFiClass::networkID () 

function onEvent [1/3]

uint16_t WiFiClass::onEvent (
    EventCb callback,
    EventId eventId=ARDUINO_EVENT_MAX
) 

function onEvent [2/3]

uint16_t WiFiClass::onEvent (
    EventFuncCb callback,
    EventId eventId=ARDUINO_EVENT_MAX
) 

function onEvent [3/3]

uint16_t WiFiClass::onEvent (
    EventSysCb callback,
    EventId eventId=ARDUINO_EVENT_MAX
) 

function printDiag

void WiFiClass::printDiag (
    Print & dest
) 

function psk

const String WiFiClass::psk () 

function reconnect

bool WiFiClass::reconnect (
    const uint8_t * bssid=NULL
) 

function removeEvent [1/3]

void WiFiClass::removeEvent (
    EventCb callback,
    EventId eventId
) 

function removeEvent [2/3]

void WiFiClass::removeEvent (
    EventSysCb callback,
    EventId eventId
) 

function removeEvent [3/3]

void WiFiClass::removeEvent (
    uint16_t id
) 

function scanAlloc

uint8_t WiFiClass::scanAlloc (
    uint8_t count
) 

function scanComplete

int16_t WiFiClass::scanComplete () 

function scanDelete

void WiFiClass::scanDelete () 

function scanInit

void WiFiClass::scanInit () 

function scanNetworks

int16_t WiFiClass::scanNetworks (
    bool async=false,
    bool showHidden=false,
    bool passive=false,
    uint32_t maxMsPerChannel=300,
    uint8_t channel=0
) 

function setAutoReconnect

bool WiFiClass::setAutoReconnect (
    bool autoReconnect
) 

function setHostname

bool WiFiClass::setHostname (
    const char * hostname
) 

function setMacAddress

bool WiFiClass::setMacAddress (
    const uint8_t * mac
) 

function setSleep

bool WiFiClass::setSleep (
    bool enable
) 

function setTxPower

bool WiFiClass::setTxPower (
    int power
) 

function softAP

bool WiFiClass::softAP (
    const char * ssid,
    const char * passphrase=NULL,
    int channel=1,
    bool ssidHidden=false,
    int maxClients=4
) 

function softAPBroadcastIP

IPAddress WiFiClass::softAPBroadcastIP () 

function softAPConfig

bool WiFiClass::softAPConfig (
    IPAddress localIP,
    IPAddress gateway,
    IPAddress subnet
) 

function softAPIP

IPAddress WiFiClass::softAPIP () 

function softAPIPv6

IPv6Address WiFiClass::softAPIPv6 () 

function softAPNetworkID

IPAddress WiFiClass::softAPNetworkID () 

function softAPSSID

const String WiFiClass::softAPSSID (
    void
) 

function softAPSubnetCIDR

uint8_t WiFiClass::softAPSubnetCIDR () 

function softAPSubnetMask

IPAddress WiFiClass::softAPSubnetMask () 

function softAPdisconnect

bool WiFiClass::softAPdisconnect (
    bool wifiOff=false
) 

function softAPenableIpV6

bool WiFiClass::softAPenableIpV6 () 

function softAPgetHostname

const char * WiFiClass::softAPgetHostname () 

function softAPgetStationNum

uint8_t WiFiClass::softAPgetStationNum () 

function softAPmacAddress [1/2]

uint8_t * WiFiClass::softAPmacAddress (
    uint8_t * mac
) 

function softAPmacAddress [2/2]

String WiFiClass::softAPmacAddress (
    void
) 

function softAPsetHostname

bool WiFiClass::softAPsetHostname (
    const char * hostname
) 

function status

WiFiStatus WiFiClass::status () 

function subnetCIDR

uint8_t WiFiClass::subnetCIDR () 

function subnetMask

IPAddress WiFiClass::subnetMask () 

function validate

bool WiFiClass::validate (
    const char * ssid,
    const char * passphrase
) 

function waitForConnectResult

WiFiStatus WiFiClass::waitForConnectResult (
    unsigned long timeout
) 

function ~WiFiClass

WiFiClass::~WiFiClass () 

Public Static Functions Documentation

function calculateBroadcast

static IPAddress WiFiClass::calculateBroadcast (
    IPAddress ip,
    IPAddress subnet
) 

function calculateNetworkID

static IPAddress WiFiClass::calculateNetworkID (
    IPAddress ip,
    IPAddress subnet
) 

function calculateSubnetCIDR

static uint8_t WiFiClass::calculateSubnetCIDR (
    IPAddress subnetMask
) 

function macToString

static String WiFiClass::macToString (
    uint8_t * mac
) 

function postEvent

static void WiFiClass::postEvent (
    EventId eventId,
    EventInfo eventInfo
) 

function resetNetworkInfo

static void WiFiClass::resetNetworkInfo (
    WiFiNetworkInfo & info
) 

Protected Static Attributes Documentation

variable handlers

std::vector< EventHandler > WiFiClass::handlers;

---

The documentation for this class was generated from the following file cores/common/arduino/libraries/api/WiFi/WiFi.h