ilabs-flir 1.0.2 → 1.0.4

package/ios/Flir/Framework/ThermalSDK/FLIRCamera.h

@@ -1,156 +1,156 @@
-//
-//  FLIRCamera.h
-//  FLIR Thermal SDK
-//
-//  Created on 2018-05-07.
-//  Copyright © 2019 Teledyne FLIR. All rights reserved.
-//
-//  Manages any FLIR camera.
-//
-
-#pragma once
-
-#import <Foundation/Foundation.h>
-#import <CoreGraphics/CoreGraphics.h>
-
-#import "FLIRIdentity.h"
-#import "FLIRRemoteControl.h"
-#import "FLIRThermalImage.h"
-
-@class FLIRStream;
-
-/** Streaming options */
-typedef NS_OPTIONS(NSUInteger, StreamingOptions) {
-    STREAMING_NO_OPENGL = 1
-};
-
-/**
- *  Block to accept a thermal image from a live stream.
- */
-typedef void (^ FLIRThermalImageBlock)(FLIRThermalImage * _Nonnull);
-
-/**
- ChargingState
- */
-typedef NS_ENUM(NSUInteger, FLIRAuthenticationStatus)
-{
-    pending, //will encapsulate both success upload and waiting to be approved
-    approved,
-    unknown
-};
-
-@class FLIRCamera;
-
-/**
- *  Delegate to return events from a connectad camera.
- */
-@protocol FLIRDataReceivedDelegate <NSObject>
-
-#pragma mark - Required event handlers
-/**
- *  This event is raised when the camera is disconnected unexpectedly, if this method is
- *  implemented in the app, and if the delegate has been initialised.
- *
- *  @param  camera  The camera.
- *  @param  error   An error code.
- */
--(void)onDisconnected:(FLIRCamera *_Nonnull) camera withError:(nullable NSError *)error;
-
-@optional
-#pragma mark - Optional event handlers
-
-@end
-
-@class FLIRCameraImport;
-
-/**
- *  The interface to a FLIR camera of any kind.
- *
- *  Note: This class is not guaranteed to be thread-safe, so calls must be synchronized if a Camera object is accessed from multiple threads.
- *
- */
-@interface FLIRCamera : NSObject
-
-+ (NSString* _Nonnull)getFrom:(FLIRIdentity * _Nonnull)identity code:(NSUInteger)code;
-
-/**
- *  A delegate to handle the events in FLIRDataReceivedDelegate.
- */
-@property (weak, nullable) id<FLIRDataReceivedDelegate> delegate;
-
-/**
- *  Initialize a camera instance with specified identity.
- *
- *  Important
- *  During development do not call `-[FLIRCamera authenticate:trustedConnectionName:]`
- *  with the same "trustedConnectionName" between two application installs.
- *  During the call to `-[FLIRCamera authenticate:trustedConnectionName:]` authentication files are create and
- *  uploaded with the "trustedConnectionName" as the "key" to the camera,
- *  new authentication files can't be used with the same "trustedConnectionName"
- *  to connect to the camera.
- *  We recommended generate a trustedConnectionName and store it as `Preferences`
- *
- * @param identity the identity of the camera instance to be initialized.
- */
--(FLIRAuthenticationStatus) authenticate:(FLIRIdentity *_Nonnull)identity trustedConnectionName:(NSString *_Nullable) name;
-/**
- *  Connect with the camera. This function is blocking.
- *
- *  @param identity the identity of the camera instance to connect to.
- */
--(BOOL)connect:(FLIRIdentity * _Nonnull)identity error:(out NSError * _Nullable * _Nonnull)error;
-
-/**
- *  Connect with the camera. This function is blocking.
- *
- *  @param identity the identity of the camera instance to connect to.
- *  @param code a code that can be present in some cameras when connecting.
- */
-- (BOOL)connect:(FLIRIdentity * _Nonnull)identity code: (NSUInteger)code error:(out NSError * _Nullable * _Nonnull)error;
-
-/**
- *  Disconnect from the camera.  This function is blocking.
- *  Disconnecting from a Flir One Edge will also disconnect from the camera's WiFi hotspot
- */
--(void)disconnect;
-
-/**
- *  Get the connection status.
- */
--(BOOL)isConnected;
-
-/**
- *  Get the connected camera identity.
- *
- *  @return The identity of the currently connected camera or null if no camera is connected.
- */
--(nullable FLIRIdentity *)getIdentity;
-
-/**
- *  Get camera remote controller.
- *
- *  @return nullptr returned if the camera isn't in connected state
- */
--(nullable FLIRRemoteControl *)getRemoteControl;
-
--(nullable FLIRCameraImport *) getImport;
-
-/**
- *  Return all streams availbable on this camera, see @ref FLIRStream.
- *  @note the implementation for thermal streaming for network cameras is still in experimental stage.
- */
-- (NSArray<FLIRStream *> * _Nonnull)getStreams;
-
-/**
- *  Check if we're in frame grabbing state.
- */
--(BOOL)isGrabbing;
-
-/**
- *  Get license information for software used in camera, if available
- *  The returned data is utf8 encoded text
- */
-
-- (NSData* _Nullable)getLicenseDataData;
-
-@end
+//
+//  FLIRCamera.h
+//  FLIR Thermal SDK
+//
+//  Created on 2018-05-07.
+//  Copyright © 2019 Teledyne FLIR. All rights reserved.
+//
+//  Manages any FLIR camera.
+//
+
+#pragma once
+
+#import <Foundation/Foundation.h>
+#import <CoreGraphics/CoreGraphics.h>
+
+#import "FLIRIdentity.h"
+#import "FLIRRemoteControl.h"
+#import "FLIRThermalImage.h"
+
+@class FLIRStream;
+
+/** Streaming options */
+typedef NS_OPTIONS(NSUInteger, StreamingOptions) {
+    STREAMING_NO_OPENGL = 1
+};
+
+/**
+ *  Block to accept a thermal image from a live stream.
+ */
+typedef void (^ FLIRThermalImageBlock)(FLIRThermalImage * _Nonnull);
+
+/**
+ ChargingState
+ */
+typedef NS_ENUM(NSUInteger, FLIRAuthenticationStatus)
+{
+    pending, //will encapsulate both success upload and waiting to be approved
+    approved,
+    unknown
+};
+
+@class FLIRCamera;
+
+/**
+ *  Delegate to return events from a connectad camera.
+ */
+@protocol FLIRDataReceivedDelegate <NSObject>
+
+#pragma mark - Required event handlers
+/**
+ *  This event is raised when the camera is disconnected unexpectedly, if this method is
+ *  implemented in the app, and if the delegate has been initialised.
+ *
+ *  @param  camera  The camera.
+ *  @param  error   An error code.
+ */
+-(void)onDisconnected:(FLIRCamera *_Nonnull) camera withError:(nullable NSError *)error;
+
+@optional
+#pragma mark - Optional event handlers
+
+@end
+
+@class FLIRCameraImport;
+
+/**
+ *  The interface to a FLIR camera of any kind.
+ *
+ *  Note: This class is not guaranteed to be thread-safe, so calls must be synchronized if a Camera object is accessed from multiple threads.
+ *
+ */
+@interface FLIRCamera : NSObject
+
++ (NSString* _Nonnull)getFrom:(FLIRIdentity * _Nonnull)identity code:(NSUInteger)code;
+
+/**
+ *  A delegate to handle the events in FLIRDataReceivedDelegate.
+ */
+@property (weak, nullable) id<FLIRDataReceivedDelegate> delegate;
+
+/**
+ *  Initialize a camera instance with specified identity.
+ *
+ *  Important
+ *  During development do not call `-[FLIRCamera authenticate:trustedConnectionName:]`
+ *  with the same "trustedConnectionName" between two application installs.
+ *  During the call to `-[FLIRCamera authenticate:trustedConnectionName:]` authentication files are create and
+ *  uploaded with the "trustedConnectionName" as the "key" to the camera,
+ *  new authentication files can't be used with the same "trustedConnectionName"
+ *  to connect to the camera.
+ *  We recommended generate a trustedConnectionName and store it as `Preferences`
+ *
+ * @param identity the identity of the camera instance to be initialized.
+ */
+-(FLIRAuthenticationStatus) authenticate:(FLIRIdentity *_Nonnull)identity trustedConnectionName:(NSString *_Nullable) name;
+/**
+ *  Connect with the camera. This function is blocking.
+ *
+ *  @param identity the identity of the camera instance to connect to.
+ */
+-(BOOL)connect:(FLIRIdentity * _Nonnull)identity error:(out NSError * _Nullable * _Nonnull)error;
+
+/**
+ *  Connect with the camera. This function is blocking.
+ *
+ *  @param identity the identity of the camera instance to connect to.
+ *  @param code a code that can be present in some cameras when connecting.
+ */
+- (BOOL)connect:(FLIRIdentity * _Nonnull)identity code: (NSUInteger)code error:(out NSError * _Nullable * _Nonnull)error;
+
+/**
+ *  Disconnect from the camera.  This function is blocking.
+ *  Disconnecting from a Flir One Edge will also disconnect from the camera's WiFi hotspot
+ */
+-(void)disconnect;
+
+/**
+ *  Get the connection status.
+ */
+-(BOOL)isConnected;
+
+/**
+ *  Get the connected camera identity.
+ *
+ *  @return The identity of the currently connected camera or null if no camera is connected.
+ */
+-(nullable FLIRIdentity *)getIdentity;
+
+/**
+ *  Get camera remote controller.
+ *
+ *  @return nullptr returned if the camera isn't in connected state
+ */
+-(nullable FLIRRemoteControl *)getRemoteControl;
+
+-(nullable FLIRCameraImport *) getImport;
+
+/**
+ *  Return all streams availbable on this camera, see @ref FLIRStream.
+ *  @note the implementation for thermal streaming for network cameras is still in experimental stage.
+ */
+- (NSArray<FLIRStream *> * _Nonnull)getStreams;
+
+/**
+ *  Check if we're in frame grabbing state.
+ */
+-(BOOL)isGrabbing;
+
+/**
+ *  Get license information for software used in camera, if available
+ *  The returned data is utf8 encoded text
+ */
+
+- (NSData* _Nullable)getLicenseDataData;
+
+@end

package/ios/Flir/Framework/ThermalSDK/FLIRCameraDeviceInfo.h

@@ -1,53 +1,53 @@
-//
-//  FLIRCameraDeviceInfo.h
-//
-//  Copyright © 2019 Teledyne FLIR. All rights reserved.
-//
-
-#pragma once
-
-#import <Foundation/Foundation.h>
-
-/**
- *  Camera device information.
- */
-@interface FLIRCameraDeviceInfo : NSObject
-
-/**
- *  @property hostName
- */
-@property (readonly) NSString *hostName;
-
-/**
- *  @property productName
- */
-@property (readonly) NSString *productName;
-
-/**
- *   @property ipAddress
- */
-@property (readonly) NSString *ipAddress;
-
-/**
- *   @property imageWidth
- */
-@property (readonly) NSNumber *imageWidth;
-
-/**
- *   @property imageHeight
- */
-@property (readonly) NSNumber *imageHeight;
-
-/**
- *   @property netService
- */
-@property (readonly) NSNetService* netService;
-
-/**
- *   Create a new FLIRCameraDeviceInfo from a NSNetService
- *
- *  @param source netService
- */
--(void) create:(id)source;
-
-@end
+//
+//  FLIRCameraDeviceInfo.h
+//
+//  Copyright © 2019 Teledyne FLIR. All rights reserved.
+//
+
+#pragma once
+
+#import <Foundation/Foundation.h>
+
+/**
+ *  Camera device information.
+ */
+@interface FLIRCameraDeviceInfo : NSObject
+
+/**
+ *  @property hostName
+ */
+@property (readonly) NSString *hostName;
+
+/**
+ *  @property productName
+ */
+@property (readonly) NSString *productName;
+
+/**
+ *   @property ipAddress
+ */
+@property (readonly) NSString *ipAddress;
+
+/**
+ *   @property imageWidth
+ */
+@property (readonly) NSNumber *imageWidth;
+
+/**
+ *   @property imageHeight
+ */
+@property (readonly) NSNumber *imageHeight;
+
+/**
+ *   @property netService
+ */
+@property (readonly) NSNetService* netService;
+
+/**
+ *   Create a new FLIRCameraDeviceInfo from a NSNetService
+ *
+ *  @param source netService
+ */
+-(void) create:(id)source;
+
+@end

package/ios/Flir/Framework/ThermalSDK/FLIRCameraEvent.h

@@ -1,132 +1,132 @@
-//
-//  FLIRCameraEvent.h
-//  FLIR Thermal SDK
-//
-//  Copyright © 2019 Teledyne FLIR. All rights reserved.
-//
-
-#import <Foundation/Foundation.h>
-#import "FLIRCameraDeviceInfo.h"
-#import "FLIRIdentity.h"
-
-/**
- *
- * Camera event.
- *
- * Handles events from a remotely connected camera
- *
- */
-
-@interface FLIRCameraEvent : NSObject
-
-/**
- Event
-
- - ImageSavedInCamera: the event
- */
-typedef NS_ENUM(NSInteger, CameraEvent) {
-    /** Image was saved in the camera */
-    ImageSavedInCamera = 0,
-    /** Connection was lost */
-    CameraConnectionLost = 1, // Always on
-};
-
-/**
- * Event
- * CameraConnectionLost
- *
- * CameraConnectionLost event will be posted to NSNotificationCenter defaultCenter when camera is lost
- * This event is always enabled when listening for ImageSavedInCamera
- * event is separated from the discovery events
- * object param always nil
- *
- *    [[NSNotificationCenter defaultCenter] addObserver:self
- *                                             selector:@selector(CameraConnectionLost:)
- *                                                 name:@"CameraConnectionLost"
- *                                               object:nil];
- *
- */
-
-/**
- *  Create a camera event object
- *
- *  @param cameraDeviceInfo the camera device to listen for events from
- *
- *  @return FLIRCameraEvent object
- */
-- (instancetype) initWithCameraDeviceInfo:(FLIRCameraDeviceInfo *) cameraDeviceInfo;
-
-/**
- *  Create a camera event object
- *
- *  @param ipAddress the camera ipAddress to listen for events from
- *
- *  @return FLIRCameraEvent object
- */
-- (instancetype) initWithCameraIpAddress:(NSString *) ipAddress;
-
-/**
- *  Create a camera event object
- *
- *  @param identity the camera identity to listen for events from
- *
- *  @return FLIRCameraEvent object
- */
-- (instancetype) initWithIdentity:(FLIRIdentity *) identity;
-
-/**
- * start listen for events
- *
- * posts the event to NSNotificationCenter defaultCenter
- *
- * event with id ImageSavedInCamera will post a named event "ImageSavedInCamera" to the notification center
- *
- * the notification object is a `FLIRFileReference` instance containing the full path to the image that was saved
- *
- * this image can be downloaded from the camera via FTP
- *
- *
- * typedef NS_ENUM(NSInteger, CameraEvent) {
- *
- * - ImageSavedInCamera = 0,
- * - CameraConnectionLost = 1, // Always on
- *
- *};
- *
- *	[[NSNotificationCenter defaultCenter] addObserver:self
- *											 selector:@selector(imageSavedInCamera:)
- *												 name:@"ImageSavedInCamera"
- *											   object:nil];
- *
- *	self.cameraEvent = [[FLIRCameraEvent alloc] initWithCameraDeviceInfo:self.cameraDeviceInfo];
- *	[self.cameraEvent listenForEvent:ImageSavedInCamera];
- *
- * Event
- * CameraConnectionLost Always on when listening for ImageSavedInCamera
- *
- * CameraConnectionLost event will be posted to NSNotificationCenter defaultCenter when camera is lost
- *
- * This event is always enabled when listening for ImageSavedInCamera
- *
- * event is separated from the discovery events
- *
- * object param always nil
- *
- *  [[NSNotificationCenter defaultCenter] addObserver:self
- *                                           selector:@selector(CameraConnectionLost:)
- *                                               name:@"CameraConnectionLost"
- *                                             object:nil];
- *
- *  @param eventID the event to listen for
- *
- *  @return true if succesful
- */
-
-- (BOOL) listenForEvent:(CameraEvent) eventID;
-
-/**
- *  stop listen for events
- */
-- (void) stopListening;
-
-@end
+//
+//  FLIRCameraEvent.h
+//  FLIR Thermal SDK
+//
+//  Copyright © 2019 Teledyne FLIR. All rights reserved.
+//
+
+#import <Foundation/Foundation.h>
+#import "FLIRCameraDeviceInfo.h"
+#import "FLIRIdentity.h"
+
+/**
+ *
+ * Camera event.
+ *
+ * Handles events from a remotely connected camera
+ *
+ */
+
+@interface FLIRCameraEvent : NSObject
+
+/**
+ Event
+
+ - ImageSavedInCamera: the event
+ */
+typedef NS_ENUM(NSInteger, CameraEvent) {
+    /** Image was saved in the camera */
+    ImageSavedInCamera = 0,
+    /** Connection was lost */
+    CameraConnectionLost = 1, // Always on
+};
+
+/**
+ * Event
+ * CameraConnectionLost
+ *
+ * CameraConnectionLost event will be posted to NSNotificationCenter defaultCenter when camera is lost
+ * This event is always enabled when listening for ImageSavedInCamera
+ * event is separated from the discovery events
+ * object param always nil
+ *
+ *    [[NSNotificationCenter defaultCenter] addObserver:self
+ *                                             selector:@selector(CameraConnectionLost:)
+ *                                                 name:@"CameraConnectionLost"
+ *                                               object:nil];
+ *
+ */
+
+/**
+ *  Create a camera event object
+ *
+ *  @param cameraDeviceInfo the camera device to listen for events from
+ *
+ *  @return FLIRCameraEvent object
+ */
+- (instancetype) initWithCameraDeviceInfo:(FLIRCameraDeviceInfo *) cameraDeviceInfo;
+
+/**
+ *  Create a camera event object
+ *
+ *  @param ipAddress the camera ipAddress to listen for events from
+ *
+ *  @return FLIRCameraEvent object
+ */
+- (instancetype) initWithCameraIpAddress:(NSString *) ipAddress;
+
+/**
+ *  Create a camera event object
+ *
+ *  @param identity the camera identity to listen for events from
+ *
+ *  @return FLIRCameraEvent object
+ */
+- (instancetype) initWithIdentity:(FLIRIdentity *) identity;
+
+/**
+ * start listen for events
+ *
+ * posts the event to NSNotificationCenter defaultCenter
+ *
+ * event with id ImageSavedInCamera will post a named event "ImageSavedInCamera" to the notification center
+ *
+ * the notification object is a `FLIRFileReference` instance containing the full path to the image that was saved
+ *
+ * this image can be downloaded from the camera via FTP
+ *
+ *
+ * typedef NS_ENUM(NSInteger, CameraEvent) {
+ *
+ * - ImageSavedInCamera = 0,
+ * - CameraConnectionLost = 1, // Always on
+ *
+ *};
+ *
+ *	[[NSNotificationCenter defaultCenter] addObserver:self
+ *											 selector:@selector(imageSavedInCamera:)
+ *												 name:@"ImageSavedInCamera"
+ *											   object:nil];
+ *
+ *	self.cameraEvent = [[FLIRCameraEvent alloc] initWithCameraDeviceInfo:self.cameraDeviceInfo];
+ *	[self.cameraEvent listenForEvent:ImageSavedInCamera];
+ *
+ * Event
+ * CameraConnectionLost Always on when listening for ImageSavedInCamera
+ *
+ * CameraConnectionLost event will be posted to NSNotificationCenter defaultCenter when camera is lost
+ *
+ * This event is always enabled when listening for ImageSavedInCamera
+ *
+ * event is separated from the discovery events
+ *
+ * object param always nil
+ *
+ *  [[NSNotificationCenter defaultCenter] addObserver:self
+ *                                           selector:@selector(CameraConnectionLost:)
+ *                                               name:@"CameraConnectionLost"
+ *                                             object:nil];
+ *
+ *  @param eventID the event to listen for
+ *
+ *  @return true if succesful
+ */
+
+- (BOOL) listenForEvent:(CameraEvent) eventID;
+
+/**
+ *  stop listen for events
+ */
+- (void) stopListening;
+
+@end