ESTDeviceSettingsGeneral

@interface ESTDeviceSettingsGeneral : ESTBaseVO <NSCopying>

This Value Object represents device settings.

  • Indicates if motion detection during connection is enabled as BOOL value.

    Declaration

    Objective-C

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

    Swift

    var motionDetectionEnabled: NSNumber { get }
  • Indicates if dark-to-sleep is enabled as BOOL value.

    Declaration

    Objective-C

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

    Swift

    var darkToSleepEnabled: NSNumber { get }
  • Dark-to-sleep threshold in Lux.

    Declaration

    Objective-C

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

    Swift

    var darkToSleepThresholdInLux: NSNumber { get }
  • Flip to sleep broadcasting mode.

    Declaration

    Objective-C

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

    Swift

    var flipToSleepEnabled: NSNumber { get }
  • Temperature offset applied to sensor in celsius.

    Declaration

    Objective-C

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

    Swift

    var temperatureOffsetInCelsius: NSNumber { get }
  • Indicates if Smart Power Mode is enabled as BOOL value.

    Declaration

    Objective-C

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

    Swift

    var smartPowerModeEnabled: NSNumber { get }
  • Schedule value object for scheduled advertising.

    Declaration

    Objective-C

    @property (readonly, strong, nonatomic) ESTDeviceSchedule *_Nonnull schedule;

    Swift

    var schedule: ESTDeviceSchedule { get }
  • Indicates if Eddystone Configuration Service is enabled as BOOL value.

    Declaration

    Objective-C

    @property (readonly, nonatomic)
        NSNumber *_Nonnull eddystoneConfigurationServiceEnabled;

    Swift

    var eddystoneConfigurationServiceEnabled: NSNumber { get }
  • Indicates if Motion Only broadcasting mode is enabled.

    Declaration

    Objective-C

    @property (readonly, nonatomic) NSNumber *_Nonnull motionOnlyEnabled;

    Swift

    var motionOnlyEnabled: NSNumber { get }
  • Time in seconds after what beacons should stop broadcasting counting from the last device movement.

    Declaration

    Objective-C

    @property (readonly, nonatomic) NSNumber *_Nonnull motionOnlyDelay;

    Swift

    var motionOnlyDelay: NSNumber { get }
  • Indicates if Automatic Firmware Update is enabled.

    Declaration

    Objective-C

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

    Swift

    var automaticFirmwareUpdateEnabled: NSNumber { get }
  • Vector used for magnetometer calibration.

    Declaration

    Objective-C

    @property (readonly, strong, nonatomic)
        NSArray<NSNumber *> *_Nonnull magnetometerCalibrationData;

    Swift

    var magnetometerCalibrationData: [NSNumber] { get }
  • Designated initializer.

    Declaration

    Objective-C

    - (nonnull instancetype)initWithCloudDictionary:
        (nonnull NSDictionary *)dictionary;

    Swift

    init(cloudDictionary dictionary: [AnyHashable : Any])

    Parameters

    dictionary

    Dictionary provided by the Estimote cloud.

    Return Value

    Initialized object.

  • Method allows to update all fields of general settings using other object of the same class. When field exists settings is overwritten if nil nothing happens.

    Declaration

    Objective-C

    - (void)updateWithGeneralSettings:
        (nonnull ESTDeviceSettingsGeneral *)generalSettings;

    Swift

    func update(withGeneralSettings generalSettings: ESTDeviceSettingsGeneral)

    Parameters

    generalSettings

    Object should be used to update settings.

  • Method for returning dictionary represantation of general settings.

    Declaration

    Objective-C

    - (nonnull NSDictionary *)cloudDictionary;

    Swift

    func cloudDictionary() -> [AnyHashable : Any]