Rtos API example

Embed: (wiki syntax)

« Back to documentation index

iBeacon::Payload Union Reference

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]uuidBeacon 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]majNumBeacon major group ID. iBeacon exploitants may use this field to divide the region into subregions, their network into subnetworks.
[in]minNumIdentifier of the Beacon in its subregion.
[in]transmitPowerMeasured transmit power of the beacon at 1 meter. Scanners use this parameter to approximate the distance to the beacon.
[in]companyIDInID of the beacon manufacturer.

Definition at line 162 of file iBeacon.h.


Field Documentation

uint16_t companyID

Beacon manufacturer identifier.

Definition at line 110 of file iBeacon.h.

uint8_t ID

Packet ID; Equal to 2 for an iBeacon.

Definition at line 115 of file iBeacon.h.

uint8_t len

Length of the remaining data presents in the payload.

Definition at line 120 of file iBeacon.h.

uint16_t majorNumber

Beacon Major group ID.

Definition at line 130 of file iBeacon.h.

uint16_t minorNumber

Beacon minor ID.

Definition at line 135 of file iBeacon.h.

uint8_t proximityUUID[16]

Beacon UUID.

Definition at line 125 of file iBeacon.h.

uint8_t raw[25]

Raw data of the payload.

Definition at line 105 of file iBeacon.h.

uint8_t txPower

Tx power received at 1 meter; in dBm.

Definition at line 140 of file iBeacon.h.