spotny-sdk 0.2.2 → 0.2.4

package/ios/Frameworks/KontaktSDK.xcframework/ios-arm64_x86_64-simulator/KontaktSDK.framework/Headers/KTKDevice.h

@@ -0,0 +1,179 @@
+//
+//  KontaktSDK
+//  Version: 6.2.1
+//
+//  Copyright (c) 2015 Kontakt.io. All rights reserved.
+//
+
+#import "KTKCloudModel.h"
+#import "KTKDeviceDefinitions.h"
+#import "KTKDeviceConfiguration.h"
+
+NS_ASSUME_NONNULL_BEGIN
+
+extern KTKDeviceModel KTKDeviceModelFromString(NSString *string);
+
+#pragma mark - KTKDevice (Interface)
+@interface KTKDevice : NSObject <KTKCloudModel>
+
+#pragma mark - Device Object Properties
+///--------------------------------------------------------------------
+/// @name Device Object Properties
+///--------------------------------------------------------------------
+
+/**
+ *  Kontakt unique identifier. (read-only)
+ */
+@property (nonatomic, strong, readonly) NSString *uniqueID;
+
+/**
+ *  Mac Address of the device. (read-only)
+ */
+@property (nonatomic, strong, readonly) NSString *macAddress;
+
+/**
+ *  Battery level percentage. (read-only)
+ */
+@property (nonatomic, readonly, assign) NSUInteger batteryLevel;
+
+/**
+ *  Last Seen of the device. (read-only)
+ */
+@property (nonatomic, assign, readonly) NSTimeInterval lastSeen;
+
+
+/**
+ *  Secure iBeacon proximity UUID. (read-only)
+ */
+@property (nonatomic, strong, readonly) NSUUID *secureProximity;
+
+/**
+ *  Secure Eddystone namespace ID. (read-only)
+ */
+@property (nonatomic, strong, readonly) NSString *secureNamespace;
+
+/**
+ *  The device configuration object.
+ */
+@property (nonatomic, strong, readwrite) KTKDeviceConfiguration *configuration;
+
+/**
+ *  An alias of the device.
+ */
+@property (nonatomic, strong, readwrite) NSString * _Nullable alias;
+
+/**
+ *  An array of device tags.
+ */
+@property (nonatomic, strong, readwrite) NSArray <NSString *>* _Nullable tags;
+
+/**
+ *  Meta dictionary object.
+ */
+@property (nonatomic, strong, readwrite) NSDictionary * _Nullable meta;
+
+/**
+ *  The firmware version.
+ */
+@property (nonatomic, strong, readwrite) NSString *firmwareVersion;
+
+/**
+ *  Kontakt order ID. (read-only)
+ */
+@property (nonatomic, strong, readonly) NSString *orderID;
+
+/**
+ *  Filtration Mask of the device. (read-only)
+ */
+@property (nonatomic, assign, readonly) KTKDeviceFilteringClass filtrationMask;
+
+/**
+ *  Ble Scan Channel of the device. (read-only)
+ */
+@property (nonatomic, assign, readonly) KTKDeviceBLEChannel bleScanChannel;
+
+/**
+ *  WIFI SSID of the device. (read-only)
+ */
+@property (nonatomic, strong, readonly) NSString *wifiSSID;
+
+/**
+ *  Device type. (read-only)
+ *
+ *  @see KTKDeviceType
+ */
+@property (nonatomic, assign, readonly) KTKDeviceType type;
+
+/**
+ *  Device specification. (read-only)
+ *
+ *  @see KTKDeviceSpecification
+ */
+@property (nonatomic, assign, readonly) KTKDeviceSpecification specification;
+
+/**
+ *  Device model. (read-only)
+ *
+ *  @see KTKDeviceModel
+ */
+@property (nonatomic, assign, readonly) KTKDeviceModel model;
+
+/**
+ *  Device manager's ID. (read-only)
+ */
+@property (nonatomic, strong, readonly) NSUUID *managerID;
+
+/**
+ *  Device venue ID. (read-only)
+ */
+@property (nonatomic, strong, readonly) NSUUID * _Nullable venueID;
+
+/**
+ *  The number of actions assigned to the device.
+ */
+@property (nonatomic, strong, readonly) NSNumber * _Nullable actionsCount;
+
+/**
+ *  Device access rights. (read-only)
+ *
+ *  @see KTKDeviceAccess
+ */
+@property (nonatomic, assign, readonly) KTKDeviceAccess access;
+
+/**
+ *  The latitude of the device.
+ */
+@property (nonatomic, strong, readwrite) NSNumber * _Nullable latitude;
+
+/**
+ *  The longitude of the device.
+ */
+@property (nonatomic, strong, readwrite) NSNumber * _Nullable longitude;
+
+#pragma mark - Initialization Methods
+///--------------------------------------------------------------------
+/// @name Initialization Methods
+///--------------------------------------------------------------------
+
+/**
+ *  Initializes and returns a device with the specified unique identifier.
+ *
+ *  @param uniqueID The unique identifier.
+ *
+ *  @return An initialized device object.
+ */
+- (instancetype)initWithUniqueID:(NSString *)uniqueID;
+
+/**
+ *  Initializes and returns a device with the specified unique identifier and type.
+ *
+ *  @param uniqueID The unique identifier.
+ *  @param deviceType The device type.
+ *
+ *  @return An initialized device object.
+ */
+- (instancetype)initWithUniqueID:(NSString *)uniqueID deviceType:(NSInteger)type;
+
+@end
+
+NS_ASSUME_NONNULL_END

package/ios/Frameworks/KontaktSDK.xcframework/ios-arm64_x86_64-simulator/KontaktSDK.framework/Headers/KTKDeviceCCOperationDelegate.h

@@ -0,0 +1,13 @@
+//  Copyright © 2024 Kontakt.io
+
+@import Foundation;
+
+@protocol KTKDeviceCCOperationDelegate <NSObject>
+
+@property (nonatomic, assign, readonly) BOOL shouldStopReceivingCCData;
+
+- (void)deviceDidStartReceivingCCData;
+- (void)deviceDidFinishReceivingCCData:(NSArray<NSError*>* _Nullable)errors;
+- (void)deviceDidReceiveCCLogs:(NSString * _Nonnull)message;
+
+@end

package/ios/Frameworks/KontaktSDK.xcframework/ios-arm64_x86_64-simulator/KontaktSDK.framework/Headers/KTKDeviceConfiguration.h

@@ -0,0 +1,329 @@
+//
+//  KontaktSDK
+//  Version: 6.2.1
+//
+//  Copyright (c) 2015 Kontakt.io. All rights reserved.
+//
+
+#import "KTKDeviceDefinitions.h"
+#import "KTKCloudModel.h"
+#import "KTKDevicePowerSaving.h"
+#import "KTKDeviceConfigurationGPIO.h"
+#import "KTKDeviceGatewayConfigurationType.h"
+
+NS_ASSUME_NONNULL_BEGIN
+
+#pragma mark - KTKDeviceConfiguration (Interface)
+@interface KTKDeviceConfiguration : NSObject <KTKCloudModel, KTKDeviceGatewayConfigurationType>
+
+#pragma mark - General Properties
+///--------------------------------------------------------------------
+/// @name General Properties
+///--------------------------------------------------------------------
+
+/**
+ *  Kontakt unique identifier. (read-only)
+ */
+@property (nonatomic, copy, readonly) NSString * _Nullable uniqueID;
+
+/**
+ *  Kontakt device local name.
+ */
+@property (nonatomic, copy, readwrite) NSString * _Nullable name;
+
+/**
+ *  Kontakt device's password.
+ *
+ *  Please note pasword property is nil when accessing it through <code>configuration</code> on <KTKDevice>.
+ *  You should only use it to change the device's password.
+ */
+@property (nonatomic, copy, readwrite) NSString * _Nullable password;
+
+/**
+ *  A status indicating whether device is in shuffle mode.
+ */
+@property (nonatomic, assign, readwrite) KTKDeviceShuffleStatus shuffleStatus;
+
+/**
+ *  Transmission power.
+ *
+ *  @see KTKDeviceTransmissionPower
+ */
+@property (nonatomic, assign, readwrite) KTKDeviceTransmissionPower transmissionPower;
+
+/**
+ *  Advertising profile.
+ *
+ *  @see KTKDeviceAdvertisingProfile
+ */
+@property (nonatomic, assign, readwrite) KTKDeviceAdvertisingProfile profile
+__attribute__((deprecated("Please use `packets` property instead")));
+
+/**
+ *  Advertising packets.
+ *
+ *  @see KTKDeviceAdvertisingPacket
+ */
+@property (nonatomic, assign, readwrite) KTKDeviceAdvertisingPackets packets;
+
+/**
+ *  Advertising interval in milliseconds.
+ *
+ *  @see https://support.kontakt.io/hc/en-gb/articles/201567802-Advertising-Interval-best-practise
+ */
+@property (nonatomic, strong, readwrite) NSNumber * _Nullable advertisingInterval;
+
+/**
+ *  Device's power saving configuration.
+ *
+ *  @see KTKDevicePowerSaving
+ */
+@property (nonatomic, copy, readwrite) KTKDevicePowerSaving * _Nullable powerSaving;
+
+/**
+ *  A Boolean indicating whether any other pending configuration should be overwritten when posting to the cloud API.
+ */
+@property (nonatomic, assign, readwrite) BOOL forceOverwrite;
+
+/**
+ *  Telemetry fields flags.
+ *
+ *  @see KTKDeviceTelemetryFields
+ */
+@property (nonatomic, assign, readwrite) KTKDeviceTelemetryFields telemetryFields;
+
+
+#pragma mark - iBeacon Properties
+///--------------------------------------------------------------------
+/// @name iBeacon Properties
+///--------------------------------------------------------------------
+
+/**
+ *  An iBeacon proximity UUID.
+ */
+@property (nonatomic, copy, readwrite) NSUUID * _Nullable proximityUUID;
+
+/**
+ *  An iBeacon major value.
+ */
+@property (nonatomic, strong, readwrite) NSNumber * _Nullable major;
+
+/**
+ *  An iBeacon minor value.
+ */
+@property (nonatomic, strong, readwrite) NSNumber * _Nullable minor;
+
+/**
+ *  A reference transmission power values for iBeacon advertising (measured at 1 meter).
+ */
+@property (nonatomic, strong, readwrite) NSArray <NSNumber *>* _Nullable rssiAt1Meter;
+
+#pragma mark - Eddystone Properties
+///--------------------------------------------------------------------
+/// @name Eddystone Properties
+///--------------------------------------------------------------------
+
+/**
+ *  An Eddystone namespace ID.
+ */
+@property (nonatomic, copy, readwrite) NSString * _Nullable namespaceID;
+
+/**
+ *  An Eddystone instance ID.
+ */
+@property (nonatomic, copy, readwrite) NSString * _Nullable instanceID;
+
+/**
+ *  An Eddystone URL object.
+ */
+@property (nonatomic, copy, readwrite) NSURL * _Nullable URL;
+
+/**
+ *  A reference transmission power values for Eddystone advertising (measured at 0 meters).
+ */
+@property (nonatomic, strong, readwrite) NSArray <NSNumber *>* _Nullable rssiAt0Meter;
+
+#pragma mark - Telemetry Properties
+///--------------------------------------------------------------------
+/// @name Telemetry Properties
+///--------------------------------------------------------------------
+
+/**
+ *  Telemetry temperature offset value. This property is currently available only on NRF52 chipset devices.
+ *
+ *  This property can be used to calibrate temperature readings.
+ */
+@property (nonatomic, strong, readwrite) NSNumber * _Nullable temperatureOffset;
+
+#pragma mark - Sensors Config Properties
+///--------------------------------------------------------------------
+/// @name Sensors Properties
+///--------------------------------------------------------------------
+
+/**
+ *  This property can be used to set line for footfall.
+ */
+//@property (nonatomic, strong, readwrite) NSArray <NSNumber *>* _Nullable footfallLine;
+@property (nonatomic, copy, readwrite) NSString * _Nullable footfallLine;
+
+
+/**
+ *  Bluetooth blink Interval value.
+ *
+ *  This property can be used Blink time for IR emitter, in seconds. 0 - disabled. Default: 2 (s)
+ */
+@property (nonatomic, strong, readwrite) NSNumber * _Nullable blinkInterval;
+
+/**
+ *  Bluetooth ir detection interval value.
+ *
+ *  This property can be used to set seconds to sleep between detection attempts. Default: 5 (s)
+ */
+@property (nonatomic, strong, readwrite) NSNumber * _Nullable irDetectionInterval;
+
+/**
+ *  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)
+ */
+@property (nonatomic, strong, readwrite) NSNumber * _Nullable irDetectionDuration;
+
+/**
+ *  Bluetooth  ir detection sleep value.
+ *
+ *  This property can be used to set seconds 0: disabled, 1: enabled. Default: 1
+ */
+@property (nonatomic, strong, readwrite) NSNumber * _Nullable irDetectionSleep;
+
+/**
+ *  Bluetooth Scan interval value.
+ *
+ *  This property can be used to set seconds between scans. 0: disabled. Default: 23 (h), 82800 seconds
+ */
+@property (nonatomic, strong, readwrite) NSNumber * _Nullable bleScanInterval;
+
+/**
+ *  Bluetooth Scan duration value.
+ *
+ *  This property can be used to set milliseconds to scan for. Default: 10000 ms (10s)
+ */
+@property (nonatomic, strong, readwrite) NSNumber * _Nullable bleScanDuration;
+
+/**
+ *  Room number ir value.
+ *
+ *  This property can be used to set room number.
+ */
+@property (nonatomic, strong, readwrite) NSNumber * _Nullable irRoomNumber;
+
+/**
+ *  Occupancy mode.
+ *
+ *  @see KTKDeviceOccupancyModel
+ */
+
+@property (nonatomic, strong, readwrite) NSNumber * _Nullable occupancyModel;
+
+
+/**
+ *  Exclusions.
+ *
+ *  @see KTKDeviceOccupancyModel
+ */
+
+@property (nonatomic, strong, readwrite) NSArray <NSDictionary *>*  _Nullable exclusions;
+
+/**
+ *  Inclusions.
+ *
+ *  @see KTKDeviceOccupancyModel
+ */
+
+@property (nonatomic, strong, readwrite) NSArray <NSDictionary *>*  _Nullable inclusions;
+
+#pragma mark - Data Logger Properties
+///--------------------------------------------------------------------
+/// @name Data Logger Properties
+///--------------------------------------------------------------------
+
+@property (nonatomic, strong, readwrite) NSNumber *dataLoggerSamplingInterval;
+
+@property (nonatomic, assign, readwrite) KTKDeviceDataLoggerFields dataLoggerFields;
+    
+#pragma mark - Features Properties
+///--------------------------------------------------------------------
+/// @name Features Properties
+///--------------------------------------------------------------------
+
+/**
+ *  The current value of real time clock. This property is currently available only on NRF52 chipset devices.
+ */
+@property (nonatomic, strong, readwrite) NSDate * _Nullable rtcDate;
+
+@property (nonatomic, strong, readwrite) NSArray<KTKDeviceConfigurationGPIO *> * _Nullable GPIOStates;
+
+#pragma mark - Secure Configuration
+///--------------------------------------------------------------------
+/// @name Secure Configuration
+///--------------------------------------------------------------------
+
+/**
+ *  Raw properties dictionary.
+ *
+ *  Raw Secure Configuration Key Value storage.
+ *  This is represented in the Cloud API as `customConfiguration`.
+ */
+@property (nonatomic, strong, readwrite) NSDictionary<NSString *, NSData *> * _Nullable rawProperties;
+
+/**
+ *  A request data object.
+ *
+ *  Request object contains data sent to the device during configuration.
+ */
+@property (nonatomic, strong, readwrite) NSData * _Nullable secureRequest;
+
+/**
+ *  A response data object.
+ *
+ *  Response object contains data recieved from the device after configuration.
+ */
+@property (nonatomic, strong, readonly) NSData * _Nullable secureResponse;
+
+/**
+ *  A response date object.
+ *
+ *  A date and time of when the response was recieved.
+ */
+@property (nonatomic, strong, readonly) NSDate * _Nullable secureResponseTime;
+
+#pragma mark - Initialization Methods
+///--------------------------------------------------------------------
+/// @name Initialization Methods
+///--------------------------------------------------------------------
+
+/**
+ *  Initializes and returns a device configuration object for device with the specified unique identifier.
+ *
+ *  @param uniqueID The unique identifier.
+ *
+ *  @return An initialized device configuration object.
+ */
+- (instancetype)initWithUniqueID:(NSString *)uniqueID;
+
+#pragma mark - Additional Methods
+///--------------------------------------------------------------------
+/// @name Additional Methods
+///--------------------------------------------------------------------
+
+/**
+ *  Returns a set of property keys modified when compared with given configuration object.
+ *
+ *  @param config The config object being compared with this object.
+ *
+ *  @return A set of property keys.
+ */
+- (NSSet <NSString *>*)modifiedKeysComparedTo:(KTKDeviceConfiguration *)config;
+
+@end
+
+NS_ASSUME_NONNULL_END

package/ios/Frameworks/KontaktSDK.xcframework/ios-arm64_x86_64-simulator/KontaktSDK.framework/Headers/KTKDeviceConfigurationGPIO.h

@@ -0,0 +1,24 @@
+//
+//  KontaktSDK
+//  Version: 6.2.1
+//
+//  Copyright © 2018 Kontakt.io. All rights reserved.
+//
+
+@import Foundation;
+
+#import "KTKDeviceDefinitions.h"
+
+NS_ASSUME_NONNULL_BEGIN
+
+#pragma mark - KTKDeviceConfigurationGPIO (Interface)
+@interface KTKDeviceConfigurationGPIO : NSObject
+
++ (instancetype)pin:(int8_t)pin state:(KTKGPIOState)state;
+
+@property (nonatomic, readwrite, assign) int8_t pin;
+@property (nonatomic, readwrite, assign) KTKGPIOState state;
+
+@end
+
+NS_ASSUME_NONNULL_END