BLUBeaconConfiguration Class Reference

Inherits from NSObject
Conforms to NSCopying
NSSecureCoding
Declared in BLUBeaconConfiguration.h

Overview

BLUBeaconConfiguration objects define all settings of a configurable beacon object.

The settings included in a BLUBeaconConfiguration object can represent the current settings of a configurable beacon. A configuration object can also be used to schedule a change of settings on a configurable beacon. Beacon configurations consist of three parts: A beacon object for each configurable beacon type. iBeacon, EddystoneUIDBeacon, EddystoneURLBeacon and sBeacon. An advanced settings object for each advertisement type the configurable beacon can be setup with. A global settings object that keeps general beacon settings.

Beacon configurations

  iBeacon

The current iBeacon setup of the configuration.

@property (nonatomic, copy) BLUIBeacon *iBeacon

Discussion

The current iBeacon setup of the configuration.

See Also

Declared In

BLUBeaconConfiguration.h

  eddystoneUIDBeacon

The current EddystoneUIDBeacon setup of the configuration.

@property (nonatomic, copy) BLUEddystoneUIDBeacon *eddystoneUIDBeacon

Discussion

The current EddystoneUIDBeacon setup of the configuration.

Declared In

BLUBeaconConfiguration.h

  eddystoneURLBeacon

The current EddystoneURLBeacon setup of the configuration.

@property (nonatomic, copy) BLUEddystoneURLBeacon *eddystoneURLBeacon

Discussion

The current EddystoneURLBeacon setup of the configuration.

Declared In

BLUBeaconConfiguration.h

  sLegacyBeacon

The current sBeacon legacy setup of the configuration.

@property (nonatomic, copy) BLUSLegacyBeacon *sLegacyBeacon

Discussion

The current sBeacon legacy setup of the configuration.

See Also

Declared In

BLUBeaconConfiguration.h

  sBeacon

The current sBeacon setup of the configuration.

@property (nonatomic, copy) BLUSBeacon *sBeacon

Discussion

The current sBeacon setup of the configuration.

See Also

Declared In

BLUBeaconConfiguration.h

Global settings

  globalSettings

The current global settings of the configuration.

@property (nonatomic, copy) BLUBeaconGlobalSettings *globalSettings

Discussion

The current global settings of the configuration.

Declared In

BLUBeaconConfiguration.h

  pairingRSSI

Sets the device’s pairing RSSI, default is set to -60dB. A lower value will allow connections at greater distances

@property (nonatomic, copy) NSNumber *pairingRSSI

Discussion

Sets the device’s pairing RSSI, default is set to -60dB. A lower value will allow connections at greater distances

Declared In

BLUBeaconConfiguration.h

  sleepTimeout

Sets the device’s sleep timeout in seconds. Once this timeout has passed the beacon will enter deep sleep mode If set to 0, deep sleep mode will be permanently disabled Deep sleep is not supported by all device types and will be ignored on unsupported platforms

@property (nonatomic, copy) NSNumber *sleepTimeout

Discussion

Sets the device’s sleep timeout in seconds. Once this timeout has passed the beacon will enter deep sleep mode If set to 0, deep sleep mode will be permanently disabled Deep sleep is not supported by all device types and will be ignored on unsupported platforms

Declared In

BLUBeaconConfiguration.h

Advanced settings

  iBeaconAdvancedSettings

The current advanced settings for iBeacon advertisements of the configuration.

@property (nonatomic, copy) BLUBeaconAdvancedSettings *iBeaconAdvancedSettings

Discussion

The current advanced settings for iBeacon advertisements of the configuration.

Declared In

BLUBeaconConfiguration.h

  eddystoneBeaconUIDAdvancedSettings

The current advanced settings for EddystoneBeacon UID advertisements of the configuration.

@property (nonatomic, copy) BLUEddystoneBeaconAdvancedSettings *eddystoneBeaconUIDAdvancedSettings

Discussion

The current advanced settings for EddystoneBeacon UID advertisements of the configuration.

Declared In

BLUBeaconConfiguration.h

  eddystoneBeaconURLAdvancedSettings

The current advanced settings for EddystoneBeacon URL advertisements of the configuration.

@property (nonatomic, copy) BLUEddystoneBeaconAdvancedSettings *eddystoneBeaconURLAdvancedSettings

Discussion

The current advanced settings for EddystoneBeacon URL advertisements of the configuration.

Declared In

BLUBeaconConfiguration.h

  eddystoneBeaconTLMAdvancedSettings

The current advanced settings for EddystoneBeacon TLM advertisements of the configuration.

@property (nonatomic, copy) BLUEddystoneBeaconAdvancedSettings *eddystoneBeaconTLMAdvancedSettings

Discussion

The current advanced settings for EddystoneBeacon TLM advertisements of the configuration.

Declared In

BLUBeaconConfiguration.h

  sBeaconV2AdvancedSettings

The current advanced settings for sBeacon v2 advertisements of the configuration.

@property (nonatomic, copy) BLUBeaconAdvancedSettings *sBeaconV2AdvancedSettings

Discussion

The current advanced settings for sBeacon v2 advertisements of the configuration.

Declared In

BLUBeaconConfiguration.h

  sBeaconV1AdvancedSettings

The current advanced settings for sBeacon v1 advertisements of the configuration.

@property (nonatomic, copy) BLUBeaconAdvancedSettings *sBeaconV1AdvancedSettings

Discussion

The current advanced settings for sBeacon v1 advertisements of the configuration.

Declared In

BLUBeaconConfiguration.h

Optional advanced settings

  motionBeaconAdvancedSettings

The current optional advanced settings for motion beacon advertisements of the configuration.

@property (nonatomic, copy) BLUBeaconOptionalAdvancedSettings *motionBeaconAdvancedSettings

Discussion

The current optional advanced settings for motion beacon advertisements of the configuration.

Declared In

BLUBeaconConfiguration.h

  lightSensorBeaconAdvancedSettings

The current optional advanced settings for light sensor beacon advertisements of the configuration.

@property (nonatomic, copy) BLUBeaconOptionalAdvancedSettings *lightSensorBeaconAdvancedSettings

Discussion

The current optional advanced settings for light sensor beacon advertisements of the configuration.

Declared In

BLUBeaconConfiguration.h

Encryption settings

  encryptionSettings

The current advertisement encryption settings of the configuration.

@property (nonatomic, copy) BLUBeaconEncryptionSettings *encryptionSettings

Discussion

The current advertisement encryption settings of the configuration.

See Also

  • BLUBeaconEncryptionSettings

    If the configuration has been read from a beacon the encryption settings will be set to disabled values. For security reasons these settings can not be read back from a beacon.

    If you want to use beacon advertisement encryption, please remember to manually setup the right encryption settings each time before you write the configuration to a beacon. By default, advertisement encryption will be disabled.

Declared In

BLUBeaconConfiguration.h

Initialization

+ defaultConfiguration

Initializes a BLUBeaconConfiguration instance with default values. This configuration can be written to a configurable beacon.

+ (BLUBeaconConfiguration *)defaultConfiguration

Return Value

Returns a newly initialized configuration instance with default values.

Discussion

Initializes a BLUBeaconConfiguration instance with default values. This configuration can be written to a configurable beacon.

Declared In

BLUBeaconConfiguration.h