BLUBattery Class Reference

Inherits from NSObject
Declared in BLUBattery.h

Overview

BLUBattery objects represent information about the battery powering a beacon.

Each BLUSBeacon, BLUSLegacyBeacon or BLUEddystoneTLMBeacon object keeps a reference to a BLUBattery object. The battery type can only be obtained for BLUSBeacon and BLUSLegacyBeacon objects as this information needs to be read from the connected beacon. All other values don’t require a connection.

Properties

  batteryType

The battery’s type.

@property (nonatomic, readonly) BLUBatteryType batteryType

Discussion

The battery’s type.

See Also

Declared In

BLUBattery.h

  estimatedPercentRemaining

The currently estimated battery percentage. Based on the battery’s voltage.

@property (nonatomic, readonly) float estimatedPercentRemaining

Discussion

The currently estimated battery percentage. Based on the battery’s voltage.

Declared In

BLUBattery.h

  voltage

The currently measured beacon battery voltage in Volts.

@property (nonatomic, readonly) float voltage

Discussion

The currently measured beacon battery voltage in Volts.

Declared In

BLUBattery.h

Helper methods

– batteryTypeString

Requests a description string for the battery’s type.

- (NSString *)batteryTypeString

Return Value

Returns a description string for the battery’s type.

Discussion

Requests a description string for the battery’s type.

Declared In

BLUBattery.h