Mistake on this page?
Report an issue in GitHub or email us
Public Member Functions | Data Fields
Gap::AdvertisementCallbackParams_t Struct Reference

Representation of a scanned advertising packet. More...

#include <Gap.h>

Public Member Functions

 AdvertisementCallbackParams_t ()
 Default constructor. More...
 

Data Fields

BLEProtocol::AddressBytes_t peerAddr
 BLE address of the device that has advertised the packet. More...
 
int8_t rssi
 RSSI value of the packet. More...
 
bool isScanResponse
 Flag indicating if the packet is a response to a scan request. More...
 
GapAdvertisingParams::AdvertisingType_t type
 Type of advertisement. More...
 
uint8_t advertisingDataLen
 Length of the advertisement data. More...
 
const uint8_t * advertisingData
 Pointer to the advertisement packet's data. More...
 
AddressType_t addressType
 Type of the address received. More...
 
PeerAddressType_t peerAddrType
 Type of the address received. More...
 

Detailed Description

Representation of a scanned advertising packet.

Instances of this type are passed to the callback registered in startScan().

Definition at line 392 of file Gap.h.

Constructor & Destructor Documentation

Default constructor.

Field Documentation

AddressType_t addressType

Type of the address received.

Deprecated:
AddressType_t do not carry enough information to be used when privacy is enabled. Use peerAddressType instead.
Note
This value should be used in the connect function to establish a connection with the peer that has sent this advertisement packet.

Definition at line 442 of file Gap.h.

const uint8_t* advertisingData

Pointer to the advertisement packet's data.

Definition at line 426 of file Gap.h.

uint8_t advertisingDataLen

Length of the advertisement data.

Definition at line 421 of file Gap.h.

bool isScanResponse

Flag indicating if the packet is a response to a scan request.

Definition at line 411 of file Gap.h.

BLE address of the device that has advertised the packet.

Definition at line 401 of file Gap.h.

PeerAddressType_t peerAddrType

Type of the address received.

Note
This value should be used in the connect function to establish a connection with the peer that has sent this advertisement packet.

Definition at line 450 of file Gap.h.

int8_t rssi

RSSI value of the packet.

Definition at line 406 of file Gap.h.

Type of advertisement.

Definition at line 416 of file Gap.h.

Important Information for this Arm website

This site uses cookies to store information on your computer. By continuing to use our site, you consent to our cookies. If you are not happy with the use of these cookies, please review our Cookie Policy to learn how they can be disabled. By disabling cookies, some features of the site will not work.