KTKDeviceConfiguration Class Reference

Inherits from NSObject
Conforms to KTKCloudModel
Declared in KTKDeviceConfiguration.h

General Properties

  uniqueID

Kontakt unique identifier. (read-only)

@property (nonatomic, copy, readonly) NSString *uniqueID

Discussion

Kontakt unique identifier. (read-only)

Declared In

KTKDeviceConfiguration.h

  name

Kontakt device local name.

@property (nonatomic, copy, readwrite) NSString *name

Discussion

Kontakt device local name.

Declared In

KTKDeviceConfiguration.h

  password

Kontakt device’s password.

@property (nonatomic, copy, readwrite) NSString *password

Discussion

Kontakt device’s password.

Please note pasword property is nil when accessing it through configuration on KTKDevice. You should only use it to change the device’s password.

Declared In

KTKDeviceConfiguration.h

  shuffleStatus

A status indicating whether device is in shuffle mode.

@property (nonatomic, assign, readwrite) KTKDeviceShuffleStatus shuffleStatus

Discussion

A status indicating whether device is in shuffle mode.

Declared In

KTKDeviceConfiguration.h

  transmissionPower

Transmission power.

@property (nonatomic, assign, readwrite) KTKDeviceTransmissionPower transmissionPower

Discussion

Transmission power.

See Also

Declared In

KTKDeviceConfiguration.h

  profile

Advertising profile.

@property (nonatomic, assign, readwrite) KTKDeviceAdvertisingProfile profile

Discussion

Advertising profile.

See Also

Declared In

KTKDeviceConfiguration.h

  packets

Advertising packets.

@property (nonatomic, assign, readwrite) KTKDeviceAdvertisingPackets packets

Discussion

Advertising packets.

Declared In

KTKDeviceConfiguration.h

  advertisingInterval

Advertising interval in milliseconds.

@property (nonatomic, strong, readwrite) NSNumber *advertisingInterval

Discussion

Advertising interval in milliseconds.

See Also

Declared In

KTKDeviceConfiguration.h

  powerSaving

Device’s power saving configuration.

@property (nonatomic, copy, readwrite) KTKDevicePowerSaving *powerSaving

Discussion

Device’s power saving configuration.

See Also

Declared In

KTKDeviceConfiguration.h

  forceOverwrite

A Boolean indicating whether any other pending configuration should be overwritten when posting to the cloud API.

@property (nonatomic, assign, readwrite) BOOL forceOverwrite

Discussion

A Boolean indicating whether any other pending configuration should be overwritten when posting to the cloud API.

Declared In

KTKDeviceConfiguration.h

  telemetryFields

Telemetry fields flags.

@property (nonatomic, assign, readwrite) KTKDeviceTelemetryFields telemetryFields

Discussion

Telemetry fields flags.

See Also

Declared In

KTKDeviceConfiguration.h

iBeacon Properties

  proximityUUID

An iBeacon proximity UUID.

@property (nonatomic, copy, readwrite) NSUUID *proximityUUID

Discussion

An iBeacon proximity UUID.

Declared In

KTKDeviceConfiguration.h

  major

An iBeacon major value.

@property (nonatomic, strong, readwrite) NSNumber *major

Discussion

An iBeacon major value.

Declared In

KTKDeviceConfiguration.h

  minor

An iBeacon minor value.

@property (nonatomic, strong, readwrite) NSNumber *minor

Discussion

An iBeacon minor value.

Declared In

KTKDeviceConfiguration.h

  rssiAt1Meter

A reference transmission power values for iBeacon advertising (measured at 1 meter).

@property (nonatomic, strong, readwrite) NSArray<NSNumber*> *rssiAt1Meter

Discussion

A reference transmission power values for iBeacon advertising (measured at 1 meter).

Declared In

KTKDeviceConfiguration.h

Eddystone Properties

  namespaceID

An Eddystone namespace ID.

@property (nonatomic, copy, readwrite) NSString *namespaceID

Discussion

An Eddystone namespace ID.

Declared In

KTKDeviceConfiguration.h

  instanceID

An Eddystone instance ID.

@property (nonatomic, copy, readwrite) NSString *instanceID

Discussion

An Eddystone instance ID.

Declared In

KTKDeviceConfiguration.h

  URL

An Eddystone URL object.

@property (nonatomic, copy, readwrite) NSURL *URL

Discussion

An Eddystone URL object.

Declared In

KTKDeviceConfiguration.h

  rssiAt0Meter

A reference transmission power values for Eddystone advertising (measured at 0 meters).

@property (nonatomic, strong, readwrite) NSArray<NSNumber*> *rssiAt0Meter

Discussion

A reference transmission power values for Eddystone advertising (measured at 0 meters).

Declared In

KTKDeviceConfiguration.h

Telemetry Properties

  temperatureOffset

Telemetry temperature offset value. This property is currently available only on NRF52 chipset devices.

@property (nonatomic, strong, readwrite) NSNumber *temperatureOffset

Discussion

Telemetry temperature offset value. This property is currently available only on NRF52 chipset devices.

This property can be used to calibrate temperature readings.

Declared In

KTKDeviceConfiguration.h

Sensors Properties

  footfallLine

This property can be used to set line for footfall.

@property (nonatomic, copy, readwrite) NSString *footfallLine

Discussion

This property can be used to set line for footfall.

Declared In

KTKDeviceConfiguration.h

  blinkInterval

Bluetooth blink Interval value.

@property (nonatomic, strong, readwrite) NSNumber *blinkInterval

Discussion

Bluetooth blink Interval value.

This property can be used Blink time for IR emitter, in seconds. 0 - disabled. Default: 2 (s)

Declared In

KTKDeviceConfiguration.h

  irDetectionInterval

Bluetooth ir detection interval value.

@property (nonatomic, strong, readwrite) NSNumber *irDetectionInterval

Discussion

Bluetooth ir detection interval value.

This property can be used to set seconds to sleep between detection attempts. Default: 5 (s)

Declared In

KTKDeviceConfiguration.h

  irDetectionDuration

Bluetooth ir detection duration value.

@property (nonatomic, strong, readwrite) NSNumber *irDetectionDuration

Discussion

Bluetooth ir detection duration value.

This property can be used to set seconds to try and detect the IR signal, before going to sleep again. Default: 2 (s)

Declared In

KTKDeviceConfiguration.h

  irDetectionSleep

Bluetooth ir detection sleep value.

@property (nonatomic, strong, readwrite) NSNumber *irDetectionSleep

Discussion

Bluetooth ir detection sleep value.

This property can be used to set seconds 0: disabled, 1: enabled. Default: 1

Declared In

KTKDeviceConfiguration.h

  bleScanInterval

Bluetooth Scan interval value.

@property (nonatomic, strong, readwrite) NSNumber *bleScanInterval

Discussion

Bluetooth Scan interval value.

This property can be used to set seconds between scans. 0: disabled. Default: 23 (h), 82800 seconds

Declared In

KTKDeviceConfiguration.h

  bleScanDuration

Bluetooth Scan duration value.

@property (nonatomic, strong, readwrite) NSNumber *bleScanDuration

Discussion

Bluetooth Scan duration value.

This property can be used to set milliseconds to scan for. Default: 10000 ms (10s)

Declared In

KTKDeviceConfiguration.h

  irRoomNumber

Room number ir value.

@property (nonatomic, strong, readwrite) NSNumber *irRoomNumber

Discussion

Room number ir value.

This property can be used to set room number.

Declared In

KTKDeviceConfiguration.h

  occupancyModel

Occupancy mode.

@property (nonatomic, strong, readwrite) NSNumber *occupancyModel

Discussion

Occupancy mode.

See Also

Declared In

KTKDeviceConfiguration.h

  exclusions

Exclusions.

@property (nonatomic, strong, readwrite) NSArray<NSDictionary*> *exclusions

Discussion

Exclusions.

See Also

Declared In

KTKDeviceConfiguration.h

  inclusions

Inclusions.

@property (nonatomic, strong, readwrite) NSArray<NSDictionary*> *inclusions

Discussion

Inclusions.

See Also

Declared In

KTKDeviceConfiguration.h

Data Logger Properties

  dataLoggerSamplingInterval

@property (nonatomic, strong, readwrite) NSNumber *dataLoggerSamplingInterval

  dataLoggerFields

@property (nonatomic, assign, readwrite) KTKDeviceDataLoggerFields dataLoggerFields

Features Properties

  rtcDate

The current value of real time clock. This property is currently available only on NRF52 chipset devices.

@property (nonatomic, strong, readwrite) NSDate *rtcDate

Discussion

The current value of real time clock. This property is currently available only on NRF52 chipset devices.

Declared In

KTKDeviceConfiguration.h

  GPIOStates

@property (nonatomic, strong, readwrite) NSArray<KTKDeviceConfigurationGPIO*> *GPIOStates

Secure Configuration

  rawProperties

Raw properties dictionary.

@property (nonatomic, strong, readwrite) NSDictionary<NSString*NSData*> *rawProperties

Discussion

Raw properties dictionary.

Raw Secure Configuration Key Value storage. This is represented in the Cloud API as customConfiguration.

Declared In

KTKDeviceConfiguration.h

  secureRequest

A response data object.

@property (nonatomic, strong, readonly) NSData *secureRequest

Discussion

A response data object.

Response object contains data recieved from the device after configuration.

Declared In

KTKDeviceConfiguration.h

  secureResponse

A response data object.

@property (nonatomic, strong, readonly) NSData *secureResponse

Discussion

A response data object.

Response object contains data recieved from the device after configuration.

Declared In

KTKDeviceConfiguration.h

  secureResponseTime

A response date object.

@property (nonatomic, strong, readonly) NSDate *secureResponseTime

Discussion

A response date object.

A date and time of when the response was recieved.

Declared In

KTKDeviceConfiguration.h

Initialization Methods

– initWithUniqueID:

Initializes and returns a device configuration object for device with the specified unique identifier.

- (instancetype)initWithUniqueID:(NSString *)uniqueID

Parameters

uniqueID

The unique identifier.

Return Value

An initialized device configuration object.

Discussion

Initializes and returns a device configuration object for device with the specified unique identifier.

Declared In

KTKDeviceConfiguration.h

Additional Methods

– modifiedKeysComparedTo:

Returns a set of property keys modified when compared with given configuration object.

- (NSSet<NSString*> *)modifiedKeysComparedTo:(KTKDeviceConfiguration *)config

Parameters

config

The config object being compared with this object.

Return Value

A set of property keys.

Discussion

Returns a set of property keys modified when compared with given configuration object.

Declared In

KTKDeviceConfiguration.h