KTKNearbyDeviceTelemetry Class Reference

Inherits from	NSObject
Conforms to	NSCopying
Declared in	KTKNearbyDeviceTelemetry.h

Identification

`uniqueID`

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

`channel`

@property (nonatomic, readonly, copy) NSNumber *channel

Basic System Health

`RSSI`

Current RSSI value for the device. (read-only)

@property (nonatomic, readonly, copy) NSNumber *RSSI

Discussion

Current RSSI value for the device. (read-only)

Declared In

KTKNearbyDeviceTelemetry.h

`date`

The current value of real time clock. (read-only)

@property (nonatomic, readonly, copy) NSDate *date

Discussion

The current value of real time clock. (read-only)

Declared In

KTKNearbyDeviceTelemetry.h

`batteryLevel`

Battery level percentage. (read-only)

@property (nonatomic, readonly, copy) NSNumber *batteryLevel

Discussion

Battery level percentage. (read-only)

Declared In

KTKNearbyDeviceTelemetry.h

More System Health

`uptime`

Uptime rounded to hours. (read-only)

@property (nonatomic, readonly, copy) NSNumber *uptime

Discussion

Uptime rounded to hours. (read-only)

Declared In

KTKNearbyDeviceTelemetry.h

`systemLoad`

Percentage of system load average over 15 min. (read-only)

@property (nonatomic, readonly, copy) NSNumber *systemLoad

Discussion

Percentage of system load average over 15 min. (read-only)

Declared In

KTKNearbyDeviceTelemetry.h

`errors`

Error Flags. (read-only)

@property (nonatomic, readonly, assign) KTKNearbyDeviceTelemetryError errors

Discussion

Error Flags. (read-only)

Declared In

KTKNearbyDeviceTelemetry.h

Accelerometer

`sensitivity`

Accelerometer sensitivity. Unit: mg/digit. (read-only)

@property (nonatomic, readonly, copy) NSNumber *sensitivity

Discussion

Accelerometer sensitivity. Unit: mg/digit. (read-only)

Declared In

KTKNearbyDeviceTelemetry.h

`acceleration`

Raw Accelerometer data filtered with lowpass filter. (read-only)

@property (nonatomic, readonly, assign) KTKDeviceAcceleration acceleration

Discussion

Raw Accelerometer data filtered with lowpass filter. (read-only)

Declared In

KTKNearbyDeviceTelemetry.h

`lastDoubleTap`

Seconds since last doubletap event. Doubletap event occurs when doubletap pattern is detected by accelerometer. (read-only)

@property (nonatomic, readonly, copy) NSNumber *lastDoubleTap

Discussion

Seconds since last doubletap event. Doubletap event occurs when doubletap pattern is detected by accelerometer. (read-only)

Saturates on 65535 (0xFFFF) value. 65535 (0xFFFF) default value when Doubletap is disabled.

Declared In

KTKNearbyDeviceTelemetry.h

`lastThreshold`

Seconds since last threshold event. Threshold event occurs when acceleration exceeds configured threshold. (read-only)

@property (nonatomic, readonly, copy) NSNumber *lastThreshold

Discussion

Seconds since last threshold event. Threshold event occurs when acceleration exceeds configured threshold. (read-only)

Saturates on 65535 (0xFFFF) value. 65535 (0xFFFF) default value when Doubletap is disabled.

Declared In

KTKNearbyDeviceTelemetry.h

`movementID`

Index of current event. Wraps around. Used to identify each threshold event

@property (nonatomic, readonly, copy) NSNumber *movementID

Discussion

Index of current event. Wraps around. Used to identify each threshold event

Declared In

KTKNearbyDeviceTelemetry.h

`moving`

A Boolean moving or not. (read-only)

@property (nonatomic, readonly, assign, getter=isMoving) BOOL moving

Discussion

A Boolean moving or not. (read-only)

Declared In

KTKNearbyDeviceTelemetry.h

Vendor

`roomNumber`

Index of current roomNumber. Detected room number via IR detector. 0xFFFF means unknown. After 60s from last detection

@property (nonatomic, readonly, copy) NSNumber *roomNumber

Discussion

Index of current roomNumber. Detected room number via IR detector. 0xFFFF means unknown. After 60s from last detection

becomes again 0xFFFF

Declared In

KTKNearbyDeviceTelemetry.h

`occupancy`

Detected number of people in the room. 0xFF means invalid / unknown

@property (nonatomic, readonly, copy) NSNumber *occupancy

Discussion

Detected number of people in the room. 0xFF means invalid / unknown

Declared In

KTKNearbyDeviceTelemetry.h

`detectionTime`

Time since last detection. Saturates at 0xFFFF

@property (nonatomic, readonly, copy) NSNumber *detectionTime

Discussion

Time since last detection. Saturates at 0xFFFF

Declared In

KTKNearbyDeviceTelemetry.h

`frameCount`

Index of the measurement/frame, starting at 0 0xFFFFFFFF means invalid / unknown

@property (nonatomic, readonly, copy) NSNumber *frameCount

Discussion

Index of the measurement/frame, starting at 0 0xFFFFFFFF means invalid / unknown

Declared In

KTKNearbyDeviceTelemetry.h

`inCount`

Detected number of people in Place the room. 0xFFFF means invalid / unknown

@property (nonatomic, readonly, copy) NSNumber *inCount

Discussion

Detected number of people in Place the room. 0xFFFF means invalid / unknown

Declared In

KTKNearbyDeviceTelemetry.h

`outCount`

Detected number of people out Place the room. 0xFFFF means invalid / unknown

@property (nonatomic, readonly, copy) NSNumber *outCount

Discussion

Detected number of people out Place the room. 0xFFFF means invalid / unknown

Declared In

KTKNearbyDeviceTelemetry.h

`occupancyPDF`

Detected number of people in the room for PDF. 0xFF means invalid / unknown

@property (nonatomic, readonly, copy) NSNumber *occupancyPDF

Discussion

Detected number of people in the room for PDF. 0xFF means invalid / unknown

Declared In

KTKNearbyDeviceTelemetry.h

`detectionTimePDF`

Time since last detection for PDF. Saturates at 0xFFFF

@property (nonatomic, readonly, copy) NSNumber *detectionTimePDF

Discussion

Time since last detection for PDF. Saturates at 0xFFFF

Declared In

KTKNearbyDeviceTelemetry.h

`personPositions`

Position in Pixels of persons. (read-only)

@property (nonatomic, readonly, copy) NSArray<KTKPersonPosition*> *personPositions

Discussion

Position in Pixels of persons. (read-only)

Declared In

KTKNearbyDeviceTelemetry.h

Button

`lastSingleClick`

Seconds since last Click event. Click event is specified in Button Specification Behavior. (read-only)

@property (nonatomic, readonly, copy) NSNumber *lastSingleClick

Discussion

Seconds since last Click event. Click event is specified in Button Specification Behavior. (read-only)

Saturates on 65535 (0xFFFF) value. 65535 (0xFFFF) default value when button click is disabled.

Declared In

KTKNearbyDeviceTelemetry.h

`singleClickCount`

A number of Click events. Click event is specified in Button Specification Behavior. (read-only)

@property (nonatomic, readonly, copy) NSNumber *singleClickCount

Discussion

A number of Click events. Click event is specified in Button Specification Behavior. (read-only)

Declared In

KTKNearbyDeviceTelemetry.h

`clickId1Count`

A number of Click events. Click event is specified in Button id 1. (read-only)

@property (nonatomic, readonly, copy) NSNumber *clickId1Count

Discussion

A number of Click events. Click event is specified in Button id 1. (read-only)

Declared In

KTKNearbyDeviceTelemetry.h

`clickId2Count`

A number of Click events. Click event is specified in Button id 2. (read-only)

@property (nonatomic, readonly, copy) NSNumber *clickId2Count

Discussion

A number of Click events. Click event is specified in Button id 2. (read-only)

Declared In

KTKNearbyDeviceTelemetry.h

Sensors

`lightSensor`

Light Sensor Percentage (0-100). (read-only)

@property (nonatomic, readonly, copy) NSNumber *lightSensor

Discussion

Light Sensor Percentage (0-100). (read-only)

Declared In

KTKNearbyDeviceTelemetry.h

`temperature`

Temperature in degree Celsius. (read-only)

@property (nonatomic, readonly, copy) NSNumber *temperature

Discussion

Temperature in degree Celsius. (read-only)

Declared In

KTKNearbyDeviceTelemetry.h

`humidity`

Relative Humidity Percentage (0-100). (read-only)

@property (nonatomic, readonly, copy) NSNumber *humidity

Discussion

Relative Humidity Percentage (0-100). (read-only)

Declared In

KTKNearbyDeviceTelemetry.h

`GPIOStates`

States of GPIOs. (read-only)

@property (nonatomic, readonly, assign) struct KTKNearbyDeviceGPIOStates GPIOStates

Discussion

States of GPIOs. (read-only)

Declared In

KTKNearbyDeviceTelemetry.h

`airPressuer`

Pressure in mBar. (read-only)

@property (nonatomic, readonly, copy) NSNumber *airPressuer

Discussion

Pressure in mBar. (read-only)

Declared In

KTKNearbyDeviceTelemetry.h

`pirDetection`

Seconds since last PIR detection. Saturates at 0xFFFF. (read-only)

@property (nonatomic, readonly, copy) NSNumber *pirDetection

Discussion

Seconds since last PIR detection. Saturates at 0xFFFF. (read-only)

Declared In

KTKNearbyDeviceTelemetry.h

`airQuality`

Air quality, 0 for good - 255 bad. (read-only)

@property (nonatomic, readonly, copy) NSNumber *airQuality

Discussion

Air quality, 0 for good - 255 bad. (read-only)

Declared In

KTKNearbyDeviceTelemetry.h

`distance`

Measured distance in [cm]. (read-only)

@property (nonatomic, readonly, copy) NSNumber *distance

Discussion

Measured distance in [cm]. (read-only)

Declared In

KTKNearbyDeviceTelemetry.h

`accuracy`

Accurancy 0-100%. (read-only)

@property (nonatomic, readonly, copy) NSNumber *accuracy

Discussion

Accurancy 0-100%. (read-only)

Declared In

KTKNearbyDeviceTelemetry.h

`gasTypeFields`

Gas type. (read-only)

@property (nonatomic, readonly, assign) KTKDeviceGasTypFields gasTypeFields

Discussion

Gas type. (read-only)

0x00 Generic ppm 0x01 Carbon Monoxide ppm 0x02 Ethanol Monoxide ppm 0x03 Volatile Organic Compounds ppm 0x04 PM 1.0 ug/m3 0x05 PM 2.5 ug/m3 0x06 PM 10.0 ug/m3 0x07 Carbon Dioxide ppm 0x08 Gas resistance kOhm

Declared In

KTKNearbyDeviceTelemetry.h

`gasPPM`

Signed, 16-bit PPM concentration, can be a positive PPM, or a difference from baseline. (read-only)

@property (nonatomic, readonly, copy) NSNumber *gasPPM

Discussion

Signed, 16-bit PPM concentration, can be a positive PPM, or a difference from baseline. (read-only)

Declared In

KTKNearbyDeviceTelemetry.h

`lightLevelLux`

Unsigned, 16-bit light level measured in lux. (read-only)

@property (nonatomic, readonly, copy) NSNumber *lightLevelLux

Discussion

Unsigned, 16-bit light level measured in lux. (read-only)

Declared In

KTKNearbyDeviceTelemetry.h

`serialNumber`

Serial number

@property (nonatomic, readonly, copy) NSNumber *serialNumber

Discussion

Serial number

Declared In

KTKNearbyDeviceTelemetry.h

`charge`

Charge

@property (nonatomic, readonly, copy) NSNumber *charge

Discussion

Charge

Declared In

KTKNearbyDeviceTelemetry.h

`activationsCount`

Activations (/1k)

@property (nonatomic, readonly, copy) NSNumber *activationsCount

Discussion

Activations (/1k)

Declared In

KTKNearbyDeviceTelemetry.h

`activationsKontakt`

Activations (kontakt)

@property (nonatomic, readonly, copy) NSNumber *activationsKontakt

Discussion

Activations (kontakt)

Declared In

KTKNearbyDeviceTelemetry.h

`refills`

Refills

@property (nonatomic, readonly, copy) NSNumber *refills

Discussion

Refills

Declared In

KTKNearbyDeviceTelemetry.h

`statusSoap`

Status

@property (nonatomic, readonly, copy) NSNumber *statusSoap

Discussion

Status

Declared In

KTKNearbyDeviceTelemetry.h

`statusSoapFields`

Status Soap Fields (read-only)

@property (nonatomic, readonly, assign) KTKDeviceStatusSoapFields statusSoapFields

Discussion

Status Soap Fields (read-only)

Declared In

KTKNearbyDeviceTelemetry.h

`configSoap`

Config

@property (nonatomic, readonly, copy) NSNumber *configSoap

Discussion

Config

Declared In

KTKNearbyDeviceTelemetry.h

`distributor`

Distributor

@property (nonatomic, readonly, copy) NSNumber *distributor

Discussion

Distributor

Declared In

KTKNearbyDeviceTelemetry.h

`bleScans`

BLE scanning statistics. Scans/s, 10 seconds average. (read-only)

@property (nonatomic, readonly, copy) NSNumber *bleScans

Discussion

BLE scanning statistics. Scans/s, 10 seconds average. (read-only)

Declared In

KTKNearbyDeviceTelemetry.h

`bleDevices`

Number of scanned BLE devices. 10 seconds average. (read-only)

@property (nonatomic, readonly, copy) NSNumber *bleDevices

Discussion

Number of scanned BLE devices. 10 seconds average. (read-only)

Declared In

KTKNearbyDeviceTelemetry.h

`wifiScans`

WiFi scanning statistics. Scans/s, 10 seconds average. (read-only)

@property (nonatomic, readonly, copy) NSNumber *wifiScans

Discussion

WiFi scanning statistics. Scans/s, 10 seconds average. (read-only)

Declared In

KTKNearbyDeviceTelemetry.h

RSSI scan

`scanID`

Scan ID - counter that identifies the current scan from the previous ones. (read-only)

@property (nonatomic, readonly, copy) NSNumber *scanID

Discussion

Scan ID - counter that identifies the current scan from the previous ones. (read-only)

Declared In

KTKNearbyDeviceTelemetry.h

`mac`

MAC address. (read-only)

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

Discussion

MAC address. (read-only)

Declared In

KTKNearbyDeviceTelemetry.h

`rssiValues`

RSSI values. Zero (0x00) if not present. The values are in chronological order, as they are scanned. Above 6 values, they are discarded.

@property (nonatomic, readonly, copy) NSArray<NSNumber*> *rssiValues

Discussion

RSSI values. Zero (0x00) if not present. The values are in chronological order, as they are scanned. Above 6 values, they are discarded.

Declared In

KTKNearbyDeviceTelemetry.h

Data Logger

`dataLoggerStatus`

A Boolean value indicating whether the data logger functionality is turned ON.

@property (nonatomic, readonly, assign) KTKDeviceDataLoggerStatus dataLoggerStatus

Discussion

A Boolean value indicating whether the data logger functionality is turned ON.

Declared In

KTKNearbyDeviceTelemetry.h