SKiBeaconDeviceData

Objective-C

@interface SKiBeaconDeviceData : SKSensorData

Swift

class SKiBeaconDeviceData : SKSensorData

An instance of SKiBeaconDeviceData encapsulates measurements related to the iBeacon™ Proximity sensor. For more information about iBeacon™ technology, please refer to Apple’s Getting Started with iBeacon documentation.

  • Unavailable

    Undocumented

    Declaration

    Objective-C

    - (instancetype)init NS_UNAVAILABLE;

  • Unavailable

    Undocumented

    Declaration

    Objective-C

    - (nonnull instancetype)initWithSensorType:(SKSensorType)sensorType
                                 timestamp:
                                     (nonnull SKSensorTimestamp *)timestamp;

  • Returns an SKiBeaconDeviceData object, initialized with the time the device was found, its major and minor identifiers, as well as its accuracy, proximity and RSSI.

    Declaration

    Objective-C

    - (nonnull instancetype)initWithTimestamp:(nonnull NSDate *)timestamp
                                    major:(uint16_t)major
                                    minor:(uint16_t)minor
                                 accuracy:(CLLocationAccuracy)accuracy
                                proximity:(CLProximity)proximity
                                     rssi:(NSInteger)rssi;

    Swift

    init(timestamp: Date, major: UInt16, minor: UInt16, accuracy: CLLocationAccuracy, proximity: CLProximity, rssi: Int)

    Parameters

    timestamp

    The time that this data log was captured.
    major

    A 16-bit unsigned integer identifier used to identify each device uniquelly. It ranges between 0 and 65535.
    minor

    A 16-bit unsigned integer identifier used to identify each device uniquelly. It ranges between 0 and 65535.
    accuracy

    A double value that represents the accuracy of the device’s proximity in meters.
    proximity

    The proximity of the device classified as Immediate, Near, Far or Unknown.
    rssi

    The strength of the signal (Received Signal Strength Indication).

    Return Value

    An SKiBeaconDeviceData object.

  • A 16-bit unsigned integer identifier used to identify each device uniquelly. It ranges between 0 and 65535. This identifier can be used in combination with the minor identifier.

    Declaration

    Objective-C

    @property (nonatomic, readonly) uint16_t major;

    Swift

    var major: UInt16 { get }

  • A 16-bit unsigned integer identifier used to identify each device uniquelly. It ranges between 0 and 65535. This identifier can be used in combination with the major identifier.

    Declaration

    Objective-C

    @property (nonatomic, readonly) uint16_t minor;

    Swift

    var minor: UInt16 { get }

  • A double value that represents the accuracy of the device’s proximity in meters.

    Declaration

    Objective-C

    @property (nonatomic, readonly) CLLocationAccuracy accuracy;

    Swift

    var accuracy: CLLocationAccuracy { get }

  • The proximity of the device classified as Immediate, Near, Far or Unknown.

    Declaration

    Objective-C

    @property (nonatomic, readonly) CLProximity proximity;

    Swift

    var proximity: CLProximity { get }

  • A string representation of the proximity, classified as Immediate, Near, Far or Unknown.

    Declaration

    Objective-C

    @property (nonatomic, copy, readonly) NSString *_Nonnull proximityString;

    Swift

    var proximityString: String { get }

  • The strength of the signal (Received Signal Strength Indication).

    Declaration

    Objective-C

    @property (nonatomic, readonly) NSInteger rssi;

    Swift

    var rssi: Int { get }

  • A string with a CSV formatted header that describes the data of the iBeacon™ Proximity sensor. This method is useful in combination with the csvString instance method of an SKSensorData object.

    Declaration

    Objective-C

    + (nonnull NSString *)csvHeader;

    Swift

    class func csvHeader() -> String

    Return Value

    A string with a CSV header.