Important changes to repositories hosted on mbed.com
Mbed hosted mercurial repositories are deprecated and are due to be permanently deleted in July 2026.
To keep a copy of this software download the repository Zip archive or clone locally using Mercurial.
It is also possible to export all your personal repositories from the account settings page.
iBeacon::Payload Union Reference
iBeacon payload builder. More...
#include <iBeacon.h>
Public Member Functions | |
Payload (LocationUUID_t uuid, uint16_t majNum, uint16_t minNum, uint8_t transmitPower, uint16_t companyIDIn) | |
Assemble an iBeacon payload. | |
Data Fields | |
uint8_t | raw [25] |
Raw data of the payload. | |
uint16_t | companyID |
Beacon manufacturer identifier. | |
uint8_t | ID |
Packet ID; Equal to 2 for an iBeacon. | |
uint8_t | len |
Length of the remaining data presents in the payload. | |
uint8_t | proximityUUID [16] |
Beacon UUID. | |
uint16_t | majorNumber |
Beacon Major group ID. | |
uint16_t | minorNumber |
Beacon minor ID. | |
uint8_t | txPower |
Tx power received at 1 meter; in dBm. |
Detailed Description
iBeacon payload builder.
This data structure contains the payload of an iBeacon. The payload is built at construction time and application code can set up an iBeacon by injecting the raw field into the GAP advertising payload as a GapAdvertisingData::MANUFACTURER_SPECIFIC_DATA.
Definition at line 101 of file iBeacon.h.
Constructor & Destructor Documentation
Payload | ( | LocationUUID_t | uuid, |
uint16_t | majNum, | ||
uint16_t | minNum, | ||
uint8_t | transmitPower, | ||
uint16_t | companyIDIn | ||
) |
Assemble an iBeacon payload.
- Parameters:
-
[in] uuid Beacon network ID. iBeacon operators use this value to group their iBeacons into a single network, a single region and identify their organization among others. [in] majNum Beacon major group ID. iBeacon exploitants may use this field to divide the region into subregions, their network into subnetworks. [in] minNum Identifier of the Beacon in its subregion. [in] transmitPower Measured transmit power of the beacon at 1 meter. Scanners use this parameter to approximate the distance to the beacon. [in] companyIDIn ID of the beacon manufacturer.
Field Documentation
uint8_t len |
uint16_t majorNumber |
uint16_t minorNumber |
uint8_t proximityUUID[16] |
Generated on Tue Jul 12 2022 12:22:44 by
