spotny-sdk 0.2.2 → 0.2.4

package/ios/Frameworks/KontaktSDK.xcframework/ios-arm64/KontaktSDK.framework/Headers/KTKDeviceConnection.h

@@ -0,0 +1,379 @@
+//
+//  KontaktSDK
+//  Version: 6.2.1
+//
+//  Copyright (c) 2015 Kontakt.io. All rights reserved.
+//
+
+@import Foundation;
+@import CoreBluetooth;
+@import CoreLocation;
+
+#import "KTKNearbyDevice.h"
+#import "KTKFirmware.h"
+#import "KTKDeviceConfiguration.h"
+#import "KTKDeviceKontaktRecognitionBox.h"
+
+@class KTKOperationQueue;
+@class DeviceCCSlotStateResponse;
+@class ElementData;
+@class KTKAccelerationSample;
+@class KTKAccidentFrame;
+
+NS_ASSUME_NONNULL_BEGIN
+
+#pragma mark - Completion Blocks
+/**
+ *  A completion block object to be executed when the write operation finishes.
+ *
+ *  @param synchronized  A Boolean indicating whether the configuration was synchronized to the Cloud API.
+ *  @param configuration The configuration object containing write operation details. Please not that configuration object will be nil for devices with firmware < 4.0.
+ *                       If <code>synchronized</code> is false you have to keep copy of the configuration and synchronize it with the cloud when possible.
+ *                       When the device firmware is 4.0 or higher configuration object will contain <code>secureResponse</code> and <code>secureResponseTime</code>.
+ *  @param isTimeSynced  A Boolean indicating whether the device's time was set successfully.
+ *  @param error         An error object containing the error that indicates why the operation failed.
+ */
+typedef void (^KTKDeviceConnectionWriteCompletion)(BOOL synchronized, KTKDeviceConfiguration * _Nullable configuration, BOOL isTimeSynced, NSError * _Nullable error);
+
+/**
+ *  A completion block object to be executed when the write operation finishes.
+ *
+ *  @param synchronized   A Boolean indicating whether the configuration was synchronized to the Cloud API.
+ *  @param secureResponse Secure response returned from the device.
+ *  @param isTimeSynced   A Boolean indicating whether the device's time was set successfully.
+ *  @param error          An error object containing the error that indicates why the operation failed.
+ */
+typedef void (^KTKDeviceConnectionWriteEncryptedCompletion)(BOOL synchronized, NSData * _Nullable secureResponse, BOOL isTimeSynced, NSError * _Nullable error);
+
+/**
+ *  A completion block object to be executed when the read operation finishes.
+ *
+ *  @param configuration The configuration object. Result of the read operation.
+ *  @param error         An error object containing the error that indicates why the operation failed.
+ */
+typedef void (^KTKDeviceConnectionReadCompletion)(__kindof KTKDeviceConfiguration * _Nullable configuration, NSError * _Nullable error);
+
+/**
+ *  A completion block object to be executed when the read operation finishes.
+ *
+ *  @param configuration The configuration encrypted data. Result of the read operation.
+ *  @param error         An error object containing the error that indicates why the operation failed.
+ */
+typedef void (^KTKDeviceConnectionReadEncryptedCompletion)(__kindof NSData * _Nullable configuration, NSError * _Nullable error);
+
+/**
+ *  A completion block object to be executed when the update operation finishes.
+ *
+ *  @param synchronized A Boolean indicating whether the configuration was synchronized to the Cloud API.
+ *  @param error        An error object containing the error that indicates why the operation failed.
+ */
+typedef void (^KTKDeviceConnectionUpdateCompletion)(BOOL synchronized, NSError * _Nullable error);
+
+/**
+ *  A completion block object to be executed when temperature monitor storage data fetch operation finishes.
+ *
+ *  @param storageData           A collection of data entry structures as a result of parsing raw data.
+ *  @param storageRawData        A collection of raw data from each response.
+ *  @param storageRawDataFormat  A collection of raw data formats matching each element in `storageRawData`.
+ *  @param error                 An error object containing the error that indicates why the operation failed.
+ */
+typedef void (^KTKDeviceConnectionFetchMonitorStorageDataCompletion)(NSArray<NSArray<ElementData*>*> * _Nullable storageData, NSArray<NSData*> * _Nullable storageRawData, NSArray<NSData*> * _Nullable storageRawDataFormat, NSError * _Nullable error);
+
+/**
+ * Handler block to be executed on every accelerometer data frame.
+ *
+ * @param samples Collected samples of accelerometer reading or `nil` in case of error.
+ * @param error An object containing error details in case of error.
+ */
+typedef void (^KTKAccelerometerDataHandler)(NSArray<KTKAccelerationSample *> * _Nullable samples, NSError * _Nullable error);
+
+/**
+ * Handler block to be executed on accident event detection.
+ *
+ * @param accidentData Data object containing current accident information.
+ * @param error An object containing error details in case of error.
+ */
+typedef void (^KTKAccidentEventHandler)(KTKAccidentFrame * _Nullable accidentData, NSError * _Nullable error);
+
+
+@protocol KTKDeviceConnectionDelegate;
+
+#pragma mark - KTKDeviceConnection (Interface)
+@interface KTKDeviceConnection : NSObject
+
+#pragma mark - Connection Properties
+///--------------------------------------------------------------------
+/// @name Connection Properties
+///--------------------------------------------------------------------
+
+/**
+*  A nearby device of this connection instance.
+*/
+@property (nonatomic, strong, readonly) KTKNearbyDevice *nearbyDevice;
+
+/**
+ *  A timeout interval for the connection.
+ */
+@property (nonatomic, assign, readwrite) NSTimeInterval connectionTimeout;
+
+/**
+ *  A number of maxium connection attempts if one failed.
+ */
+@property (nonatomic, assign, readwrite) NSUInteger connectionAttempts;
+
+/**
+ *  The delegate object that will receive events.
+ */
+@property (nonatomic, weak, readwrite) id<KTKDeviceConnectionDelegate> delegate;
+
+/**
+ *  Queue used for connection operations.
+ */
+@property (nonatomic, weak, readonly) KTKOperationQueue *sharedQueue;
+
+/**
+*  Most recently read configuration from connected device.
+*/
+@property (nonatomic, strong, readonly, nullable) KTKDeviceConfiguration *lastReadConfiguration;
+
+#pragma mark - Configuration Profile Properties
+///--------------------------------------------------------------------
+/// @name Configuration Profile Properties
+///--------------------------------------------------------------------
+
+/**
+ *  Preferred method for reading and writing Secure Configuration Profile.
+ *  The actual method is selected based on device model and firmware version.
+ */
+@property (nonatomic, assign) KTKConfigProfileReadWriteMethod preferredConfigProfileReadWriteMethod;
+
+#pragma mark - Other Properties
+///--------------------------------------------------------------------
+/// @name Other Properties
+///--------------------------------------------------------------------
+
+/**
+ *  A Boolean value indicating whether the operation is currently executing.
+ */
+@property (nonatomic, readonly, getter=isExecuting) BOOL executing;
+
+/**
+ *  A Boolean value indicating whether the connection to the device should be kept alive.
+ *  
+ *  If any operation is scheduled and keepAlive flag is set to `YES` this class will keep connection alive even after scheduled operation is completed.
+ *  To close the connection you have to either call `cancel` method or change `keepalive` to NO and if no more operations are scheduled connection will be closed immediately.
+ */
+@property (nonatomic, readwrite, getter=isKeepAlive) BOOL keepAlive;
+
+/**
+ *  A Boolean value indicating whether the devices rtc time should be updated automatically. Defaults to `YES`.
+ */
+@property (nonatomic, readwrite, getter=isUpdateTimeAutomatically) BOOL updateTimeAutomatically;
+
+#pragma mark - Static Methods
+///--------------------------------------------------------------------
+/// @name Static Methods
+///--------------------------------------------------------------------
+
+/**
+ *  Returns number of all connection operations scheduled in internal connection queue.
+ *
+ *  @return Number of all connection operations scheduled.
+ */
++ (NSUInteger)connectionOperationsCount;
+
+/**
+ *  Cancels all connection operations scheduled in internal connection queue.
+ */
++ (void)cancelAllOperations;
+    
+#pragma mark - Initialization Methods
+///--------------------------------------------------------------------
+/// @name Initialization Methods
+///--------------------------------------------------------------------
+
+/**
+ *  Creates instance of KTKDeviceConnection with given KTKNearbyDevice
+ *
+ *  @param nearbyDevice KTKNearbyDevice Object
+ *
+ *  @return New instance of KTKDeviceConnection
+ */
+- (instancetype)initWithNearbyDevice:(KTKNearbyDevice*)nearbyDevice;
+
+#pragma mark - Connection Methods
+///--------------------------------------------------------------------
+/// @name Connection Methods
+///--------------------------------------------------------------------
+
+/**
+ *  Writes the specified configuration to the connection device.
+ *
+ *  @param configuration The configuration object to write.
+ *  @param completion    A block object to be executed when the write operation finishes.
+ */
+- (void)writeConfiguration:(KTKDeviceConfiguration*)configuration completion:(KTKDeviceConnectionWriteCompletion)completion;
+
+/**
+ *  Writes encrypted configuration directly to the connection device.
+ *
+ *  @param encryptedConfig  Encrypted configuration data.
+ *  @param firmware         Firmware version of the connected device.
+ *                        Can be `nil` if `nearbyDevice` reference has already firmware version set.
+ *  @param completion       A block object to be executed when the write operation finishes.
+ */
+- (void)writeEncryptedConfiguration:(NSData *)encryptedConfig
+                       withFirmware:(nullable NSString *)firmware
+                         completion:(KTKDeviceConnectionWriteEncryptedCompletion)completion;
+
+/**
+ *  Reads the configuration from the connection device.
+ *
+ *  @param completion A block object to be executed when the read operation finishes.
+ */
+- (void)readConfigurationWithCompletion:(KTKDeviceConnectionReadCompletion)completion;
+
+/**
+ *  Reads the configuration from the connection device.
+ *
+ *  @param completion A block object to be executed when the read operation finishes.
+ */
+- (void)readEncryptedConfigurationWithFirmware: (NSString *)firmware
+                                    completion: (void (^)(NSData * _Nullable, NSError * _Nullable))completion;
+
+/**
+ *  Send the current time to the connected device.
+ *  
+ *  @param completion A block object to be executed when the write operation finishes.
+ */
+- (void)syncTimeWithCompletion: (void (^)(NSError * _Nullable))completion;
+
+/**
+ *  Synchronize beacon state, including time.
+ *
+ *  @param completion A block object to be executed when the read operation finishes.
+ */
+- (void)synchronizeInternalStateWithCompletion: (void (^)(__kindof KTKDeviceConfiguration * _Nullable, NSString *firmware, BOOL isTimeSynced, NSError * _Nullable))completion;
+
+/**
+ *  Updates a device to the latest available firmware.
+ *
+ *  @param firmware   The firmware object you want to update device to. <code>Has to be equal or grater than current firmware version.</code>
+ *  @param progress   A block object to be executed when the progress of an update operation is recieved.
+ *  @param completion A block object to be executed when the update operation finishes.
+ */
+- (void)updateWithFirmware:(KTKFirmware*)firmware progress:(void (^)(double))progress completion:(KTKDeviceConnectionUpdateCompletion)completion;
+
+/**
+ *  Get image from a device.
+ *
+ *  @param type   The type object you want to update device to. <code>Has to be equal or grater than current firmware version.</code>
+ *  @param completion A block object to be executed when the update operation finishes download configuration, image and error.
+ */
+- (void)getImage:(KTKKontaktImageType)type completion:(void (^)(NSData * _Nullable, NSArray<KTKDeviceKontaktRecognitionBox *> * _Nullable, KTKDeviceConfiguration * _Nullable configuration, NSError * _Nullable))completion;
+
+/**
+ *  Blink device
+ *
+ *  @param completion A block object to be executed when the operation finishes.
+ */
+- (void)getBlinkDevice:(void (^)(NSError * _Nullable error))completion;
+
+/**
+ *  Request Temperature Monitor probes status.
+ *
+ *  @param completion A block object to be executed when the operation finishes.
+ */
+- (void)getProbesStatusWithCompletion:(void (^)(DeviceCCSlotStateResponse * _Nullable, NSError * _Nullable))completion;
+
+/**
+ *  Request Temperature Monitor storage data from the provided time period.
+ *
+ *  @param from Data will be read from this date (in seconds).
+ *  @param to Data will be read up to, but excluding, this date (in seconds).
+ *  @param completion A block object to be executed when the operation finishes.
+ */
+- (void)fetchMonitorStorageDataFrom:(NSTimeInterval)from
+                                 to:(NSTimeInterval)to
+                     withCompletion:(KTKDeviceConnectionFetchMonitorStorageDataCompletion)completion;
+
+/**
+ * Reads the latest accelerometer data from a Kontakt.io device.
+ *
+ * @note Call @c stopCurrentListeningOperation() function to stop receiving data.
+ * @param handler A block called every time data is received from the device.
+ */
+- (void)readAccelerometerDataWithHandler:(KTKAccelerometerDataHandler)handler;
+
+/**
+ * Listens to the changes of accident detection from a Kontakt.io device.
+ *
+ * @note Call @c stopCurrentListeningOperation() function to stop receiving data.
+ * @param handler A block called every time data is received from the device.
+ */
+- (void)readAccidentEventsWithHandler:(KTKAccidentEventHandler)handler;
+
+/**
+ *  Signals current listening operation to stop receiving more data.
+ */
+- (void)stopCurrentListeningOperation;
+
+/**
+ *  Cancels all operations on this connection.
+ */
+- (void)cancel;
+
+@end
+
+#pragma mark - KTKDeviceConnectionDelegate Protocol
+/**
+ *  It is possible if read and/or write operations are scheduled one after another that connection will happen only once,
+ *  so any delegate's methods would be called just once, even with few configuration operations scheduled.
+ */
+@protocol KTKDeviceConnectionDelegate <NSObject>
+
+#pragma mark - Connection Delegate Methods
+///--------------------------------------------------------------------
+/// @name Connection Delegate Methods
+///--------------------------------------------------------------------
+
+/**
+ *  Tells the delegate that a device connection was successful.
+ *
+ *  @param connection The device connection object reporting the event.
+ */
+@optional
+- (void)deviceConnectionDidConnect:(KTKDeviceConnection *)connection;
+
+/**
+ *  Tells the delegate what is the progress of a read or write operation.
+ *
+ *  @param connection The device connection object reporting the event.
+ *  @param operation  An operation type.
+ *  @param progress   An operation type.
+ */
+@optional
+- (void)deviceConnection:(KTKDeviceConnection *)connection operation:(KTKDeviceConnectionOperationType)operation progress:(double)progress;
+
+/**
+ *  Tells the delegate that a device connection error occurred.
+ *
+ *  @param connection   The device connection object reporting the event.
+ *  @param error        An error object containing the error that indicates why the connection failed.
+ *  @param attemptsLeft A number of reconnection attempts left. If <code>attemptsLeft</code> is 0, it will report final error.
+ */
+@optional
+- (void)deviceConnection:(KTKDeviceConnection *)connection didFailWithError:(NSError * _Nullable)error connectionAttemptsLeft:(NSInteger)attemptsLeft;
+
+/**
+ *  Tells the delegate that a devices connection was ended.
+ *
+ *  @param connection The device connection object reporting the event.
+ *  @param error      An error object containing the error that indicates why the device disconnected.
+ */
+@optional
+- (void)deviceConnectionDidDisconnect:(KTKDeviceConnection *)connection withError:(NSError * _Nullable)error;
+
+@end
+
+NS_ASSUME_NONNULL_END

package/ios/Frameworks/KontaktSDK.xcframework/ios-arm64/KontaktSDK.framework/Headers/KTKDeviceConnectionOperation.h

@@ -0,0 +1,65 @@
+//
+//  KontaktSDK
+//  Version: 6.2.1
+//
+//  Copyright © 2015 Kontakt.io. All rights reserved.
+//
+
+@import CoreBluetooth;
+
+#import "KTKGroupOperation.h"
+#import "KTKNearbyDevice.h"
+#import "KTKDeviceGATTOperation.h"
+
+NS_ASSUME_NONNULL_BEGIN
+
+@protocol KTKDeviceConnectionOperationDelegate;
+
+#pragma mark - KTKDeviceConnectionOperationProtocol
+@protocol KTKDeviceConnectionOperationProtocol <NSObject>
+
+@property (nonatomic, weak, readwrite) KTKNearbyDevice * _Nullable device;
+
+@end
+
+#pragma mark - KTKDeviceConfigurationOperation (Interface)
+@interface KTKDeviceConnectionOperation : KTKGroupOperation <KTKDeviceConnectionOperationProtocol, KTKDeviceGATTOperationDelegate, CBPeripheralDelegate>
+
+#pragma mark - Operation Properties
+///--------------------------------------------------------------------
+/// @name Operation Properties
+///--------------------------------------------------------------------
+
+@property (nonatomic, weak, readwrite) id<KTKDeviceConnectionOperationDelegate> _Nullable delegate;
+
+@property (nonatomic, copy, readwrite) void (^connectionCompletion)(BOOL indicator, id _Nullable, NSArray<NSError*>* _Nullable);
+
+@property (nonatomic, copy, readwrite) void (^connectionCompletionMTU)(BOOL indicator, NSInteger mtu, NSString *firmware, id _Nullable, NSArray<NSError*>* _Nullable);
+
+@property (nonatomic, weak, readwrite) __kindof KTKOperation * _Nullable GATTOperationsDependency;
+
+@property (nonatomic, assign, readwrite) KTKDeviceConnectionOperationType type;
+@property (nonatomic, assign, readwrite) BOOL syncTime;
+
+#pragma mark - Operation Methods
+///--------------------------------------------------------------------
+/// @name Operation Methods
+///--------------------------------------------------------------------
+
+- (void)createOperations;
+
+- (void)addGATTOperation:(__kindof KTKDeviceGATTOperation *)operation;
+/// Optional operation does not cancel the connection when its characteristic couldn't be discovered.
+- (void)addGATTOperation:(__kindof KTKDeviceGATTOperation *)operation asOptional:(BOOL)optional;
+- (void)registerAdHocOperation:(__kindof KTKDeviceGATTOperation *)operation;
+
+@end
+
+#pragma mark - KTKDeviceConnectionOperationDelegate
+@protocol KTKDeviceConnectionOperationDelegate <NSObject>
+
+- (void)connectionOperation:(KTKDeviceConnectionOperation *)operation progress:(double)progress;
+
+@end
+
+NS_ASSUME_NONNULL_END

package/ios/Frameworks/KontaktSDK.xcframework/ios-arm64/KontaktSDK.framework/Headers/KTKDeviceDataLoggerConnection.h

@@ -0,0 +1,56 @@
+//
+//  KontaktSDK-iOS
+//
+//  Copyright © 2018 Kontakt.io. All rights reserved.
+//
+
+#import "KTKDeviceConnection.h"
+#import "KTKDeviceDataLoggerReading.h"
+
+NS_ASSUME_NONNULL_BEGIN
+
+#pragma mark - Completion Blocks
+
+/**
+ *  A completion block object to be executed when the data logger reading operation finishes.
+ *
+ *  @param configuration    The configuration object. Result of the read operation.
+ *  @param readings         An array of data logger entries.
+ *  @param error            An error object containing the error that indicates why the operation failed.
+ */
+typedef void (^KTKDeviceDataLoggerConnectionReadBlock)(KTKDeviceConfiguration * _Nullable configuration, NSArray <KTKDeviceDataLoggerReading *> * _Nullable readings, NSError * _Nullable error);
+
+/**
+ *  A completion block object to be executed when the data logger clear operation finishes.
+ *
+ *  @param error            An error object containing the error that indicates why the operation failed.
+ */
+typedef void (^KTKDeviceDataLoggerConnectionClearBlock)(NSError * _Nullable error);
+
+#pragma mark - KTKDeviceLoggerConnection (Interface)
+@interface KTKDeviceDataLoggerConnection : KTKDeviceConnection
+
+#pragma mark - Connection Methods
+///--------------------------------------------------------------------
+/// @name Connection Methods
+///--------------------------------------------------------------------
+
+/**
+*  Reads the data from the data logger device.
+*
+*  @param date              A date until logger data will be recieved. If date is `nil` read will return all available date.
+*  @param completion        A block object to be executed when the read operation finishes.
+*/
+- (void)dataLoggerReadUntil:(NSDate * _Nullable)date completion:(KTKDeviceDataLoggerConnectionReadBlock)completion;
+
+/**
+ *  Clears the data from the data logger device.
+ *
+ *  @param completion       A block object to be executed when the clear operation finishes.
+ */
+- (void)dataLoggerClearWithCompletion:(KTKDeviceDataLoggerConnectionClearBlock)completion;
+
+
+@end
+
+NS_ASSUME_NONNULL_END

package/ios/Frameworks/KontaktSDK.xcframework/ios-arm64/KontaktSDK.framework/Headers/KTKDeviceDataLoggerReading.h

@@ -0,0 +1,49 @@
+//
+//  KontaktSDK
+//  Version: 6.2.1
+//
+//  Copyright © 2017 Kontakt.io. All rights reserved.
+//
+
+@import Foundation;
+
+#import "KTKDeviceDefinitions.h"
+
+NS_ASSUME_NONNULL_BEGIN
+
+#pragma mark - KTKDeviceDataLoggerReading (Interface)
+@interface KTKDeviceDataLoggerReading : NSObject <NSCopying>
+
+/**
+ *  Temperature in degree Celsius. (read-only)
+ */
+@property (nonatomic, strong, readonly) NSNumber * _Nullable temperature;
+
+/**
+ *  Humidity in percentage (0-100). (read-only)
+ */
+@property (nonatomic, strong, readonly) NSNumber * _Nullable humidity;
+
+/**
+ *  Light Sensor Percentage (0-100). (read-only)
+ */
+@property (nonatomic, strong, readonly) NSNumber * _Nullable lightLevel;
+
+/**
+ *  Raw Accelerometer data filtered with lowpass filter. (read-only)
+ */
+@property (nonatomic, assign, readonly) KTKDeviceAcceleration acceleration;
+
+/**
+ *  A date of the reading. (read-only)
+ */
+@property (nonatomic, strong, readonly) NSDate *date;
+
+/**
+ *  Battery Percentage (0-100). (read-only)
+ */
+@property (nonatomic, strong, readonly) NSNumber * _Nullable batteryLevel;
+
+@end
+
+NS_ASSUME_NONNULL_END