BLUEddystoneData Class Reference

Inherits from NSObject
Declared in BLUEddystoneData.h
BLUEddystoneData.m

Overview

BLUEddystoneData objects are used to represent the data of the BlueBeacon Eddystone slot.

  frameType

The Eddystone frame type for the slot.

@property (nonatomic, readonly) EddystoneFrameType frameType

Declared In

BLUEddystoneData.h

  uidData

The Eddystone UID data for the slot (nil if the frame type of the slot is not EddystoneFrameTypeUid).

@property (nullable, nonatomic, readonly) BLUEddystoneUidData *uidData

Declared In

BLUEddystoneData.h

  urlData

The Eddystone URL data for the slot (nil if the frame type of the slot is not EddystoneFrameTypeUrl).

@property (nullable, nonatomic, readonly) BLUEddystoneUrlData *urlData

Declared In

BLUEddystoneData.h

  tlmData

The Eddystone TLM data for the slot (nil if the frame type of the slot is not EddystoneFrameTypeTlm).

@property (nullable, nonatomic, readonly) BLUEddystoneTlmData *tlmData

Declared In

BLUEddystoneData.h

  eidData

The Eddystone EID data for the slot (nil if the frame type of the slot is not EddystoneFrameTypeEid).

@property (nullable, nonatomic, readonly) BLUEddystoneEidData *eidData

Declared In

BLUEddystoneData.h

– initWithUid:advertisedTxPower:

Initializes the Eddystone UID slot with a specified UID value.

- (nonnull instancetype)initWithUid:(nonnull NSUUID *)uid advertisedTxPower:(nullable NSNumber *)advertisedTxPower

Parameters

uid

The Eddystone UID, composed from 10 bytes Namespace Id and 6 bytes Instance Id.

advertisedTxPower

The Tx power in dBm emitted by the beacon at 0 meters (nil if default value is to be used).

Return Value

Returns a newly initialized Eddystone slot data object.

Declared In

BLUEddystoneData.h

– initWithUrl:advertisedTxPower:

Initializes the Eddystone URL slot with a specified URL string.

- (nonnull instancetype)initWithUrl:(nonnull NSString *)url advertisedTxPower:(nullable NSNumber *)advertisedTxPower

Parameters

url

The URL.

advertisedTxPower

The Tx power in dBm emitted by the beacon at 0 meters (nil if default value is to be used).

Return Value

Returns a newly initialized Eddystone slot data object.

Declared In

BLUEddystoneData.h

– initWithTlmBatteryVoltage:temperature:secondsCounter:packetsCounter:

Initializes the Eddystone TLM slot with specified values.

- (nonnull instancetype)initWithTlmBatteryVoltage:(nullable NSNumber *)batteryVoltage temperature:(nullable NSNumber *)temperature secondsCounter:(nullable NSNumber *)secondsCounter packetsCounter:(nullable NSNumber *)packetsCounter

Parameters

batteryVoltage

The battery voltage in millivolts.

temperature

The temperature, in Celsius degree.

secondsCounter

The uptime seconds counter.

packetsCounter

The packets counter.

Return Value

Returns a newly initialized Eddystone slot data object.

Declared In

BLUEddystoneData.h

– initWithEid:advertisedTxPower:

Initializes the Eddystone EID slot with specified values.

- (nonnull instancetype)initWithEid:(nullable NSData *)eid advertisedTxPower:(nullable NSNumber *)advertisedTxPower

Parameters

eid

The Eddystone EID.

advertisedTxPower

The Tx power in dBm emitted by the beacon at 0 meters (nil if default value is to be used).

Return Value

Returns a newly initialized Eddystone slot data object.

Declared In

BLUEddystoneData.h

– initWithEidExponent:eidClock:eid:

Initializes the Eddystone EID slot with specified values.

- (nonnull instancetype)initWithEidExponent:(nullable NSNumber *)eidExponent eidClock:(nullable NSNumber *)eidClock eid:(nullable NSData *)eid

Parameters

eidExponent

The Eddystone EID exponent.

eidClock

The Eddystone EID clock.

eid

The Eddystone EID.

Return Value

Returns a newly initialized Eddystone slot data object.

Declared In

BLUEddystoneData.h

– initWithEidKey:eidExponent:

Initializes the Eddystone EID slot with specified values.

- (nonnull instancetype)initWithEidKey:(nullable NSData *)eidKey eidExponent:(nullable NSNumber *)eidExponent

Parameters

eidKey

The Eddystone EID key.

eidExponent

The Eddystone EID exponent.

Return Value

Returns a newly initialized Eddystone slot data object.

Declared In

BLUEddystoneData.h