SKEddystoneProximityData

Objective-C

@interface SKEddystoneProximityData : SKSensorData

Swift

class SKEddystoneProximityData : SKSensorData

An instance of SKEddystoneProximityData encapsulates measurements related to the Eddystone™ Proximity sensor.

  • 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 SKEddystoneProximityData object, initialized with the time the data log was captured, its namespace and instance identifiers, as well as its rssi and txPower.

    Declaration

    Objective-C

    - (nonnull instancetype)initWithTimestamp:(nonnull NSDate *)timestamp
                                  namespaceId:(NSString *_Nullable)namespaceId
                                   instanceId:(NSUInteger)instanceId
                                         rssi:(NSInteger)rssi
                                      txPower:(NSInteger)txPower;

    Swift

    init(timestamp: Date, namespaceId: String?, instanceId: UInt, rssi: Int, txPower: Int)

    Parameters

    timestamp

    The time that this data log was captured.

    namespaceId

    A 10-byte (80 bit) identifier that can used to group a particular set of beacons. This value should be in Hexadecimal format, with a maximum character length of 20 characters.

    instanceId

    A 6-byte (48 bit) unsigned integer that is used to identify individual devices inside the namespace group. It ranges between 0 and 281474976710655.

    rssi

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

    txPower

    The strength of the signal measured at a distance of 1 meter.

    Return Value

    An SKEddystoneProximityData object.

  • A 10-byte (80 bit) identifier that can used to group a particular set of beacons. This value should be in Hexadecimal format, with a maximum character length of 20 characters.

    Declaration

    Objective-C

    @property (nonatomic, copy, readonly, nullable) NSString *namespaceId;

    Swift

    var namespaceId: String? { get }
  • A 6-byte (48 bit) unsigned integer that is used to identify individual devices inside the namespace group. It ranges between 0 and 281474976710655.

    Declaration

    Objective-C

    @property (nonatomic, readonly) NSUInteger instanceId;

    Swift

    var instanceId: UInt { get }
  • The strength of the signal (Received Signal Strength Indication).

    Declaration

    Objective-C

    @property (nonatomic, readonly) NSInteger rssi;

    Swift

    var rssi: Int { get }
  • The strength of the signal measured at a distance of 1 meter.

    Declaration

    Objective-C

    @property (nonatomic, readonly) NSInteger txPower;

    Swift

    var txPower: Int { get }
  • A string with a CSV formatted header that describes the data of the Eddystone™ 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.