ESTNearable

Deprecated

Deprecated since 4.31.0.


@interface ESTNearable : NSObject <NSCopying, NSCoding>

The ESTNearable class defines the interface for interacting with a single Estimote nearable. It enables you to retrieve properties of the nearable. You do not create instances of this class directly. The <ESTNearableManager> object reports encountered beacons to its associated delegate object.

The identity of a nearable is defined by its <identifier>` property. Identifier of the device is unique among all the Estimote nearables and can not be changed.

  • Unique device identifier.

    Declaration

    Objective-C

    @property (nonatomic, strong, readonly) NSString *_Nonnull identifier;

    Swift

    var identifier: String { get }

  • Zone indicating distance from the device.

    Declaration

    Objective-C

    @property (nonatomic, assign, unsafe_unretained, readonly) ESTNearableZone zone;

  • Type of the nearable device.

    Declaration

    Objective-C

    @property (nonatomic, assign, unsafe_unretained, readonly) ESTNearableType type;

    Swift

    var type: ESTNearableType { get }

  • Color of the nearable device.

    Declaration

    Objective-C

    @property (nonatomic, assign, unsafe_unretained, readonly) ESTColor color;

    Swift

    var color: ESTColor { get }

  • Revision of nearable hardware.

    Declaration

    Objective-C

    @property (nonatomic, strong, readonly) NSString *_Nonnull hardwareVersion;

    Swift

    var hardwareVersion: String { get }

  • Version of nearable firmware.

    Declaration

    Objective-C

    @property (nonatomic, strong, readonly) NSString *_Nonnull firmwareVersion;

    Swift

    var firmwareVersion: String { get }

  • Bluetooth signal strength. It can take value from -100 to 0. 127 value means RSSI reading error.

    Declaration

    Objective-C

    @property (nonatomic, assign, unsafe_unretained, readonly) NSInteger rssi;

    Swift

    var rssi: Int { get }

  • Battery voltage when nearable is in idle state defined in Volts.

    Declaration

    Objective-C

    @property (nonatomic, strong, readonly) NSNumber *_Nullable idleBatteryVoltage;

    Swift

    var idleBatteryVoltage: NSNumber? { get }

  • Battery voltage when nearable is under stress (sending packet) defined in Volts.

    Declaration

    Objective-C

    @property (nonatomic, strong, readonly) NSNumber *_Nullable stressBatteryVoltage;

    Swift

    var stressBatteryVoltage: NSNumber? { get }

  • Time since last change of motion state (isMoving value change) returned in seconds.

    Declaration

    Objective-C

    @property (nonatomic, assign, unsafe_unretained, readonly)
    unsigned long long currentMotionStateDuration;

    Swift

    var currentMotionStateDuration: UInt64 { get }

  • Time of nearable’s previous motion state returned in seconds.

    Declaration

    Objective-C

    @property (nonatomic, assign, unsafe_unretained, readonly)
    unsigned long long previousMotionStateDuration;

    Swift

    var previousMotionStateDuration: UInt64 { get }

  • Flag indicates if nearable is moving or not.

    Declaration

    Objective-C

    @property (nonatomic, assign, unsafe_unretained, readonly) BOOL isMoving;

    Swift

    var isMoving: Bool { get }

  • Physical orientation of nearable in space.

    Declaration

    Objective-C

    @property (nonatomic, assign, unsafe_unretained, readonly)
    ESTNearableOrientation orientation;

    Swift

    var orientation: ESTNearableOrientation { get }

  • X axis acceleration data.

    Declaration

    Objective-C

    @property (nonatomic, assign, unsafe_unretained, readonly)
    NSInteger xAcceleration;

    Swift

    var xAcceleration: Int { get }

  • Y axis acceleration data.

    Declaration

    Objective-C

    @property (nonatomic, assign, unsafe_unretained, readonly)
    NSInteger yAcceleration;

    Swift

    var yAcceleration: Int { get }

  • Z axis acceleration data.

    Declaration

    Objective-C

    @property (nonatomic, assign, unsafe_unretained, readonly)
    NSInteger zAcceleration;

    Swift

    var zAcceleration: Int { get }

  • Ambient temperature of nearable.

    Declaration

    Objective-C

    @property (nonatomic, assign, unsafe_unretained, readonly) double temperature;

    Swift

    var temperature: Double { get }

  • The power of the nearable’s radio signal in dBm.

    Declaration

    Objective-C

    @property (nonatomic, strong, readonly) NSNumber *_Nonnull power;

    Swift

    var power: NSNumber { get }

  • The advertising interval of the sticker in ms.

    Declaration

    Objective-C

    @property (nonatomic, strong, readonly) NSNumber *_Nonnull advInterval;

    Swift

    var advInterval: NSNumber { get }

  • Indicates if nearable is in Boot or App state.

    Declaration

    Objective-C

    @property (nonatomic, assign, unsafe_unretained, readonly)
    ESTNearableFirmwareState firmwareState;

    Swift

    var firmwareState: ESTNearableFirmwareState { get }

  • Indicates which broadcasting mode is device currently using.

    Declaration

    Objective-C

    @property (nonatomic, assign, unsafe_unretained, readonly)
    ESTNearableBroadcastingScheme broadcastingScheme;

    Swift

    var broadcastingScheme: ESTNearableBroadcastingScheme { get }

  • The URL address of Eddystone URL packet.

    Declaration

    Objective-C

    @property (nonatomic, strong, readonly) NSString *_Nonnull eddystoneURL;

    Swift

    var eddystoneURL: String { get }

  • The proximity UUID of iBeacon packet.

    Declaration

    Objective-C

    @property (nonatomic, strong, readonly) NSString *_Nonnull proximityUUID;

    Swift

    var proximityUUID: String { get }

  • The major of iBeacon packet.

    Declaration

    Objective-C

    @property (nonatomic, strong, readonly) NSNumber *_Nonnull major;

    Swift

    var major: NSNumber { get }

  • The minor of iBeacon packet.

    Declaration

    Objective-C

    @property (nonatomic, strong, readonly) NSNumber *_Nonnull minor;

    Swift

    var minor: NSNumber { get }

  • Allows to get iBeacon region (Proximiy UUID, major, minor) broadcasted by the sticker as every third bluetooth packet.

    Declaration

    Objective-C

    - (nonnull CLBeaconRegion *)beaconRegion;

    Swift

    func beaconRegion() -> CLBeaconRegion

    Return Value

    iBeacon formated region

  • Method indicating if motion sensor is working properly.

    Declaration

    Objective-C

    - (BOOL)isMotionBroken;

    Swift

    func isMotionBroken() -> Bool

  • Method indicating if temperature sensor is working properly.

    Declaration

    Objective-C

    - (BOOL)isTemperatureBroken;

    Swift

    func isTemperatureBroken() -> Bool