Rtos API example

Embed: (wiki syntax)

« Back to documentation index

WiFiAccessPoint Class Reference

WiFiAccessPoint Class Reference

WiFiAccessPoint class. More...

#include <WiFiAccessPoint.h>

Public Member Functions

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

Detailed Description

WiFiAccessPoint class.

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

Definition at line 28 of file WiFiAccessPoint.h.


Constructor & Destructor Documentation

WiFiAccessPoint lifetime.

Definition at line 3 of file WiFiAccessPoint.cpp.


Member Function Documentation

const uint8_t * get_bssid (  ) const

Get an access point's bssid.

Returns:
The bssid of the access point

Definition at line 18 of file WiFiAccessPoint.cpp.

uint8_t get_channel (  ) const

Get the access point's channel.

Returns:
The channel of the access point

Definition at line 33 of file WiFiAccessPoint.cpp.

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

Definition at line 28 of file WiFiAccessPoint.cpp.

nsapi_security_t get_security (  ) const

Get an access point's security.

Returns:
The security type of the access point

Definition at line 23 of file WiFiAccessPoint.cpp.

const char * get_ssid (  ) const

Get an access point's ssid.

Returns:
The ssid of the access point

Definition at line 13 of file WiFiAccessPoint.cpp.