_wifi_neighbor_ap Struct Reference

structure for neighbor_ap More...

#include <wifi_common_hal.h>

Data Fields
CHAR	ap_SSID [64]
CHAR	ap_BSSID [64]
CHAR	ap_Mode [64]
UINT	ap_Channel
INT	ap_SignalStrength
CHAR	ap_SecurityModeEnabled [64]
CHAR	ap_EncryptionMode [64]
CHAR	ap_OperatingFrequencyBand [16]
CHAR	ap_SupportedStandards [64]
CHAR	ap_OperatingStandards [16]
CHAR	ap_OperatingChannelBandwidth [16]
UINT	ap_BeaconPeriod
INT	ap_Noise
CHAR	ap_BasicDataTransferRates [256]
CHAR	ap_SupportedDataTransferRates [256]
UINT	ap_DTIMPeriod
UINT	ap_ChannelUtilization [64]

Detailed Description

structure for neighbor_ap

Note

Do not edit the fields of this data structure

Field Documentation

ap_BasicDataTransferRates

CHAR ap_BasicDataTransferRates[256]

Comma-separated list (maximum list length 256) of strings each of which represents a number in the range [1-9608]. Basic data transmit rates (in Mbps) for the SSID. For example, if BasicDataTransferRates is "1,2", this indicates that the SSID is operating with basic rates of 1 Mbps and 2 Mbps

ap_BeaconPeriod

UINT ap_BeaconPeriod

Time interval (in ms) between transmitting beacons. Range is [0, 2^32 - 1]

ap_BSSID

CHAR ap_BSSID[64]

[MACAddress] The BSSID used for the neighboring WiFi SSID. MAC will be of "AA:BB:CC:DD:EE:FF" format

ap_Channel

UINT ap_Channel

The current radio channel used by the neighboring WiFi radio. Possible values {1-13, 36-64,100-165}

ap_ChannelUtilization

UINT ap_ChannelUtilization[64]

Indicates the fraction of the time AP senses that the channel is in use by the neighboring AP for transmissions. Range is [0, 100]

ap_DTIMPeriod

UINT ap_DTIMPeriod

The number of beacon intervals that elapse between transmission of Beacon frames containing a TIM element whose DTIM count field is 0. This value is transmitted in the DTIM Period field of beacon frames. [802.11-2012]. Range is [0, 2^32 - 1]

ap_EncryptionMode

CHAR ap_EncryptionMode[64]

Comma-separated list of strings. The type of encryption the neighboring WiFi SSID advertises. Possible values {"TKIP", "AES"}

ap_Mode

CHAR ap_Mode[64]

The mode the neighboring WiFi radio is operating in. Possible values {"AdHoc", "Infrastructure"}

ap_Noise

INT ap_Noise

Indicator of average noise strength (in dBm) received from the neighboring WiFi radio. Range is [-200, 0]

ap_OperatingChannelBandwidth

CHAR ap_OperatingChannelBandwidth[16]

Indicates the bandwidth at which the channel is operating. Possible values {"20MHz", "40MHz", "80MHz", "160MHz", "Auto"}

ap_OperatingFrequencyBand

CHAR ap_OperatingFrequencyBand[16]

Indicates the frequency band at which the radio this SSID instance is operating. Possible values {"2.4GHz", "5GHz"}

ap_OperatingStandards

CHAR ap_OperatingStandards[16]

Comma-separated list of strings. Each list item MUST be a member of the list reported by theSupportedStandards parameter. List items indicate which IEEE 802.11 standard that is detected for thisResult. Possible values {"a", "b", "g", "n", "ac"}

ap_SecurityModeEnabled

CHAR ap_SecurityModeEnabled[64]

The type of encryption the neighboring WiFi SSID advertises. Possible values {"None", "WEP", "WPA", "WPA2", "WPA3", "WPA-WPA2", "WPA2-WPA3", "WPA-Enterprise", "WPA2-Enterprise", "WPA-WPA2-Enterprise"}

ap_SignalStrength

INT ap_SignalStrength

An indicator of radio signal strength (RSSI) of the neighboring WiFi radio measured in dBm, as an average of the last 100 packets received. Range is [-200, 0]

ap_SSID

CHAR ap_SSID[64]

The current service set identifier in use by the neighboring WiFi SSID. The value MAY be empty for hidden SSIDs. SSID can be any string up to 32 characters in length, including 0 length

ap_SupportedDataTransferRates

CHAR ap_SupportedDataTransferRates[256]

Comma-separated list (maximum list length 256) of strings each of which represents a number in the range [1-9608]. Data transmit rates (in Mbps) for unicast frames at which the SSID will permit a station to connect. For example, if SupportedDataTransferRates is "1,2,5.5", this indicates that the SSID will only permit connections at 1 Mbps, 2 Mbps and 5.5 Mbps

ap_SupportedStandards

CHAR ap_SupportedStandards[64]

Comma-separated list of strings. List items indicate which IEEE 802.11 standards this Result instance can support simultaneously, in the frequency band specified by OperatingFrequencyBand. Possible values {"a", "b", "g", "n", "ac"}

---

The documentation for this struct was generated from the following file:

• wifi_common_hal.h