BLUBeacon Class Reference

Inherits from	NSObject
Declared in	BLUBeacon.h BLUBeacon.m

Overview

The BLUBeacon class represents remote BlueBeacon devices that your app—by means of a central manager (an instance of BLUCentralManager)—has discovered advertising or is currently connected to. BlueBeacon are identified by a model number and a serial number.

`delegate`

The delegate object specified to receive beacon events.

@property (nonatomic, nullable) id<BLUBeaconDelegate> delegate

Declared In

BLUBeacon.h

`– modelNumber`

The BlueUp model number of the beacon.

- (NSInteger)modelNumber

Return Value

An integer value representing the model number of the beacon.

Declared In

BLUBeacon.h

`– modelName`

The BlueUp model name of the beacon.

- (nonnull NSString *)modelName

Return Value

A string with the model name of the beacon.

Declared In

BLUBeacon.h

`– serialNumber`

The BlueUp serial number of the beacon.

- (NSInteger)serialNumber

Return Value

An integer value representing the serial number of the beacon.

Declared In

BLUBeacon.h

`– batteryLevel`

The estimated battery level in percent.

- (NSInteger)batteryLevel

Return Value

An integer value representing the battery level.

Declared In

BLUBeacon.h

`– RSSI`

The RSSI, in decibels, of the beacon.

- (NSInteger)RSSI

Return Value

An integer value representing the RSSI of the beacon.

Declared In

BLUBeacon.h

`– connectable`

The connectable state of the beacon

- (BOOL)connectable

Return Value

A boolean value representing the connectable state of the beacon.

Declared In

BLUBeacon.h

`– reset`

Perform a factory reset of the beacon. A connection must be established with the beacon to perform the factory reset.

- (void)reset

Declared In

BLUBeacon.h

`– readDeviceInformations`

Retrieves the informations about the beacon (i.e. Manufacturer Name, Model Number, Serial Number, Hardware Revision, Firmware Revision, Software Revision). A connection must be established with the beacon to read these informations.

- (void)readDeviceInformations

Declared In

BLUBeacon.h

`– readBatteryLevel`

Retrieves the current battery level of the beacon. A connection must be established with the beacon to read the battery level.

- (void)readBatteryLevel

Declared In

BLUBeacon.h

`– readConfiguration`

Retrieves the current configuration of the beacon. A connection must be established with the beacon to read the configuration.

- (void)readConfiguration

Declared In

BLUBeacon.h

`– writeConfiguration:`

Writes a configuration to the beacon. A connection must be established with the beacon to write the configuration.

- (void)writeConfiguration:(nonnull BLUBeaconConfiguration *)configuration

Parameters

`configuration`	The new configuration to be written.

Declared In

BLUBeacon.h

`– changePassword:withNewPassword:`

Change the current beacon password. A connection must be established with the beacon to change the password.

- (void)changePassword:(nullable NSString *)oldPassword withNewPassword:(nonnull NSString *)newPassword

Parameters

`oldPassword`	The current beacon password.
`newPassword`	The new beacon password.

Declared In

BLUBeacon.h

`– disablePassword`

Disables the beacon password protection. A connection must be established with the beacon to disable the password.

- (void)disablePassword

Declared In

BLUBeacon.h