BLUBeaconConfiguration Class Reference

Inherits from NSObject
Declared in BLUBeaconConfiguration.h
BLUBeaconConfiguration.m

Overview

BLUBeaconConfiguration objects are used to represent and manage the configuration of the BlueBeacons.

– isConnectable

States if the beacon configuration is set to remain in connectable state after disconnection.

- (BOOL)isConnectable

Return Value

A boolean flag that represents the Eddystone Remain Connectable characteristic.

Declared In

BLUBeaconConfiguration.h

– setConnectable:

Sets the remain connectable flag of the beacon configuration.

- (void)setConnectable:(BOOL)connectable

Parameters

connectable

The remain connectable flag to set for the beacon confiuguration.

Declared In

BLUBeaconConfiguration.h

– isAnonymous

States if the beacon configuration is set for anonymous mode.

- (BOOL)isAnonymous

Return Value

A boolean flag that represents the anonymous mode flag of the beacon.

Declared In

BLUBeaconConfiguration.h

– setAnonymous:

Sets the anonymous mode flag of the beacon configuration.

- (void)setAnonymous:(BOOL)anonymous

Parameters

anonymous

The anonymous mode flag to set for the beacon confiuguration.

Declared In

BLUBeaconConfiguration.h

– getAdvertisingStartTime

<#Description#>

- (nullable NSDate *)getAdvertisingStartTime

Return Value

The advertising start time, if configured, otherwise nil.

Declared In

BLUBeaconConfiguration.h

– getAdvertisingEndTime

<#Description#>

- (nullable NSDate *)getAdvertisingEndTime

Return Value

The advertising end time, if configured, otherwise nil.

Declared In

BLUBeaconConfiguration.h

– setAdvertisingTime:duration:

Sets the timed advertising parameters.

- (nullable NSError *)setAdvertisingTime:(nullable NSDate *)advertisingStartTime duration:(NSUInteger)duration

Parameters

advertisingStartTime

The advertising start time. A nil value could be used to clear timed advertising.
duration

The duration of advertising, in seconds (ignored if advertisingStartTime is nil).

Return Value

Nil, if the parameters are correctly set, otherwise the cause of error.

Declared In

BLUBeaconConfiguration.h

– getAccelerometerConfiguration

<#Description#>

- (BLUAccelerometerMode)getAccelerometerConfiguration

Return Value

The accelerometer configuration value.

Declared In

BLUBeaconConfiguration.h

– setAccelerometerConfiguration:

Sets the accelerometer configuration mode.

- (nullable NSError *)setAccelerometerConfiguration:(BLUAccelerometerMode)accelerometerMode

Parameters

accelerometerMode

The accelerometer mode to set.

Return Value

Nil, if the accelerometer configuration is correctly set, otherwise the cause of error.

Declared In

BLUBeaconConfiguration.h

– getConfiguredSlots

Retrieves the array of the slots enabled on the beacon.

- (nonnull NSArray *)getConfiguredSlots

Return Value

The array of the configured / enabled slots.

Declared In

BLUBeaconConfiguration.h

– removeSlotAtIndex:

Removes a slot from the array of the enabled slots.

- (void)removeSlotAtIndex:(NSUInteger)index

Parameters

index

The index of the slot to remove.

Declared In

BLUBeaconConfiguration.h

– removeAllSlots

Removes all the enabled slots from the beacon configuration.

- (void)removeAllSlots

Declared In

BLUBeaconConfiguration.h

– addIBeaconSlot:major:minor:advertisingInterval:radioTxPower:

Add an iBeacon Slot to the beacon configuration.

- (nullable NSError *)addIBeaconSlot:(nonnull NSUUID *)uuid major:(uint16_t)major minor:(uint16_t)minor advertisingInterval:(uint16_t)advertisingInterval radioTxPower:(BLURadioTxPower)radioTxPower

Parameters

uuid

The iBeacon Proximity UUID.
major

The iBeacon Major number.
minor

The iBeacon Minor number
advertisingInterval

The advertising interval for this slot.
radioTxPower

The TX Power for this slot.

Return Value

Nil if the slot is correctly configured, otherwise the cause of error.

Declared In

BLUBeaconConfiguration.h

– addSensorSlot:radioTxPower:

Add a Sensor Slot to the beacon configuration.

- (nullable NSError *)addSensorSlot:(uint16_t)advertisingInterval radioTxPower:(BLURadioTxPower)radioTxPower

Parameters

advertisingInterval

The advertising interval for this slot.
radioTxPower

The TX Power for this slot.

Return Value

Nil if the slot is correctly configured, otherwise the cause of error.

Declared In

BLUBeaconConfiguration.h

– addQuuppaSlot:advertisingInterval:radioTxPower:

Add a Quuppa Slot to the beacon configuration.

- (nullable NSError *)addQuuppaSlot:(nullable NSData *)tagId advertisingInterval:(uint16_t)advertisingInterval radioTxPower:(BLURadioTxPower)radioTxPower

Parameters

tagId

The Tag Identifier (6 bytes), nil if the BLE mac address is to be used as Tag Id.
advertisingInterval

The advertising interval for this slot.
radioTxPower

The TX Power for this slot.

Return Value

Nil if the slot is correctly configured, otherwise the cause of error.

Declared In

BLUBeaconConfiguration.h

– addEddystoneUIDSlot:advertisingInterval:radioTxPower:

Add a Eddystone UID Slot to the beacon configuration.

- (nullable NSError *)addEddystoneUIDSlot:(nonnull NSUUID *)uid advertisingInterval:(uint16_t)advertisingInterval radioTxPower:(BLURadioTxPower)radioTxPower

Parameters

uid

The Eddystone UID to set, combining the 10 bytes namespace id and the 6 bytes instance id.
advertisingInterval

The advertising interval for this slot.
radioTxPower

The TX Power for this slot.

Return Value

Nil if the slot is correctly configured, otherwise the cause of error.

Declared In

BLUBeaconConfiguration.h

– addEddystoneURLSlot:advertisingInterval:radioTxPower:

Add a Eddystone URL Slot to the beacon configuration.

- (nullable NSError *)addEddystoneURLSlot:(nonnull NSString *)url advertisingInterval:(uint16_t)advertisingInterval radioTxPower:(BLURadioTxPower)radioTxPower

Parameters

url

The Eddystone URL to set.
advertisingInterval

The advertising interval for this slot.
radioTxPower

The TX Power for this slot.

Return Value

Nil if the slot is correctly configured, otherwise the cause of error.

Declared In

BLUBeaconConfiguration.h

– addEddystoneTLMSlot:radioTxPower:

Add a Eddystone TLM Slot to the beacon configuration.

- (nullable NSError *)addEddystoneTLMSlot:(uint16_t)advertisingInterval radioTxPower:(BLURadioTxPower)radioTxPower

Parameters

advertisingInterval

The advertising interval for this slot.
radioTxPower

The TX Power for this slot.

Return Value

Nil if the slot is correctly configured, otherwise the cause of error.

Declared In

BLUBeaconConfiguration.h