Mbed OS Reference
Loading...
Searching...
No Matches
WiFiAccessPoint Class Reference

WiFiAccessPoint class. More...

#include <WiFiAccessPoint.h>

Public Member Functions

 WiFiAccessPoint ()
 WiFiAccessPoint lifetime. More...
 
const char * get_ssid () const
 Get an access point's ssid. More...
 
const uint8_t * get_bssid () const
 Get an access point's bssid. More...
 
nsapi_security_t get_security () const
 Get an access point's security. More...
 
int8_t get_rssi () const
 Gets the radio signal strength for the access point. More...
 
uint8_t get_channel () const
 Get the access point's channel. More...
 

Detailed Description

WiFiAccessPoint class.

Class that represents a WiFi Access Point Common interface that is shared between WiFi devices

Definition at line 29 of file WiFiAccessPoint.h.

Constructor & Destructor Documentation

◆ WiFiAccessPoint()

Member Function Documentation

◆ get_ssid()

const char * get_ssid ( ) const

Get an access point's ssid.

Returns
The ssid of the access point

◆ get_bssid()

const uint8_t * get_bssid ( ) const

Get an access point's bssid.

Returns
The bssid of the access point

◆ get_security()

nsapi_security_t get_security ( ) const

Get an access point's security.

Returns
The security type of the access point

◆ get_rssi()

int8_t get_rssi ( ) const

Gets the radio signal strength for the access point.

Returns
Connection strength in dBm (negative value), or 0 if measurement impossible

◆ get_channel()

uint8_t get_channel ( ) const

Get the access point's channel.

Returns
The channel of the access point