ilabs-flir 1.0.1 → 1.0.3

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

@@ -1,35 +1,35 @@
-//
-//  FLIRRenderer.h
-//  ThermalSDK
-//
-//  Created by FLIR on 2021-10-12.
-//  Copyright © 2021 Teledyne FLIR. All rights reserved.
-//
-
-#pragma once
-
-#import <UIKit/UIKit.h>
-
-/**
- *  Class for rendering images.
- */
-@protocol FLIRRenderer
-
-/**
- *  Get "rendered result"
- *
- *  Fetch the rendered image from the renderer. This returns a deep copy of the image.
- *  @return Returns an UIImage, or nil if update has not been called previously or no source image was available yet.
- */
-- (UIImage * _Nullable)getImage;
-
-/**
- *  Execute renderer
- *
- *  Polls image data from the source (e.g. a @ref FLIRStream or a @ref FLIRThermalImage), then performs image processing
- *  Result could be stored in a UIImage or rendered directly to screen, depending on configuration.
- *  @return true if update is succesfull, otherwise the error is set
- */
-- (BOOL)update:(out NSError * _Nullable __autoreleasing * _Nullable)error;
-
-@end
+//
+//  FLIRRenderer.h
+//  ThermalSDK
+//
+//  Created by FLIR on 2021-10-12.
+//  Copyright © 2021 Teledyne FLIR. All rights reserved.
+//
+
+#pragma once
+
+#import <UIKit/UIKit.h>
+
+/**
+ *  Class for rendering images.
+ */
+@protocol FLIRRenderer
+
+/**
+ *  Get "rendered result"
+ *
+ *  Fetch the rendered image from the renderer. This returns a deep copy of the image.
+ *  @return Returns an UIImage, or nil if update has not been called previously or no source image was available yet.
+ */
+- (UIImage * _Nullable)getImage;
+
+/**
+ *  Execute renderer
+ *
+ *  Polls image data from the source (e.g. a @ref FLIRStream or a @ref FLIRThermalImage), then performs image processing
+ *  Result could be stored in a UIImage or rendered directly to screen, depending on configuration.
+ *  @return true if update is succesfull, otherwise the error is set
+ */
+- (BOOL)update:(out NSError * _Nullable __autoreleasing * _Nullable)error;
+
+@end

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

@@ -1,17 +1,17 @@
-//
-//  FLIRRendererImpl.h
-//  ThermalSDK
-//
-//  Created by FLIR on 2021-11-01.
-//  Copyright © 2021 Teledyne FLIR. All rights reserved.
-//
-
-#import "FLIRRenderer.h"
-
-/**
- *  Class implementing FLIRRenderer, for internal use only
- */
-@interface FLIRRendererImpl : NSObject<FLIRRenderer>
-
-@end
-
+//
+//  FLIRRendererImpl.h
+//  ThermalSDK
+//
+//  Created by FLIR on 2021-11-01.
+//  Copyright © 2021 Teledyne FLIR. All rights reserved.
+//
+
+#import "FLIRRenderer.h"
+
+/**
+ *  Class implementing FLIRRenderer, for internal use only
+ */
+@interface FLIRRendererImpl : NSObject<FLIRRenderer>
+
+@end
+

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

@@ -1,99 +1,99 @@
-//
-//  FLIRScale.h
-//
-//  Copyright © 2019 Teledyne FLIR. All rights reserved.
-//
-
-#pragma once
-
-#import "FLIRThermalValue.h"
-#import "FLIRPalette.h"
-
-/**
- *  Defines an image's linear scale object and basic scale's parameters.
- *  The scale defines the way the Palette is applied to the ThermalImage.
- *  Scale is an interval of the temperature, where colors from a selected Palette is applied.
- *  The available temperature's range is defined by the ThermalImage.
- *  Scale cannot be created directly, it should always be obtained from ThermalImage.
- *  To do so, the ThermalImage.getScale() method should be called.
- */
-@interface FLIRScale : NSObject
-/**  
- *   Sets the minimum and maximum scale values.
- *
- *   @param min  The minimum scale value.
- *   @param max  The maximum scale value.
- */
-- (void)setRangeWithMin:(FLIRThermalValue * _Nonnull)min andMax:(FLIRThermalValue * _Nonnull) max;
-
-/** 
- *   Sets the scale automatically based on the min and max scale values.
- *
- *   @note This call will be removed, use FLIRColorizer.autoScale from FLIRImageColorizer (still images) or FLIRThermalStreamer (live streams) instead.
- */
-- (void)setAutoAdjustEnabled:(BOOL)enabled DEPRECATED_MSG_ATTRIBUTE("This call will be removed, use FLIRColorizer.autoScale from FLIRImageColorizer (still images) or FLIRThermalStreamer (live streams) instead");;
-
-/** 
- *  Gets the current minimum scale value.
- *  @return The min scale value.
- */
-- (FLIRThermalValue * _Nonnull)getRangeMin;
-
-/** 
- *  Gets the current maximum scale value.
- *  @return The max scale value
- */
-- (FLIRThermalValue *  _Nonnull)getRangeMax;
-
-/** 
- *  Gets the thermal scale image.
- *
- *  @return An UIImage representing the thermal scale.
- *
- *  @note This call will be removed, use FLIRColorizer.getScaleImage from FLIRImageColorizer (still images) or FLIRThermalStreamer (live streams) instead.
- */
-- (UIImage * _Nullable)getImage DEPRECATED_MSG_ATTRIBUTE("This call will be removed, use FLIRColorizer.getScaleImage from FLIRImageColorizer (still images) or FLIRThermalStreamer (live streams) instead");
-
-/**
- *  Gets the thermal scale image.
- *
- *  @param palette the pallete
- *  
- *  @return An UIImage representing the full thermal range scale.
- *
- *  @note This feature will likely be removed in upcoming release.
- */
-
-+ (UIImage * _Nullable)getFixedFullRangeScaleImage:(FLIRPalette * _Nonnull) palette DEPRECATED_MSG_ATTRIBUTE("This feature will likely be removed in upcoming release.");;
-
-/**
- *  Gets the thermal scale image from current palette.
- *
- *  @return An UIImage representing the full thermal range scale.
- *
- *  @note This feature will likely be removed in upcoming release.
- */
-
-- (UIImage * _Nullable)getFixedFullRangeScaleImage DEPRECATED_MSG_ATTRIBUTE("This feature will likely be removed in upcoming release.");
-
-
-/**
- *  Gets auto adjust setting.
- *
- *  @note This call will be removed, use FLIRColorizer.autoScale from FLIRImageColorizer (still images) or FLIRThermalStreamer (live streams) instead.
- */
-- (BOOL)isAutoAdjustEnabled DEPRECATED_MSG_ATTRIBUTE("This call will be removed, use FLIRColorizer.autoScale from FLIRImageColorizer (still images) or FLIRThermalStreamer (live streams) instead");
-
-/**
- *  Sets the maximum range, where colors defined by the Palette are applied to the ThermalImage.
- *  @Deprecated Setting max value may affect min value, use setRangeWithMin:andMax:
- */
-- (void)setRangeMax:(FLIRThermalValue * _Nonnull)max;
-
-/**
- *  Sets the minimum range, where colors defined by the Palette are applied to the ThermalImage.
- *  @Deprecated Setting min value may affect max value, use setRangeWithMin:andMax:
- */
-- (void)setRangeMin:(FLIRThermalValue * _Nonnull)min;
-
-@end
+//
+//  FLIRScale.h
+//
+//  Copyright © 2019 Teledyne FLIR. All rights reserved.
+//
+
+#pragma once
+
+#import "FLIRThermalValue.h"
+#import "FLIRPalette.h"
+
+/**
+ *  Defines an image's linear scale object and basic scale's parameters.
+ *  The scale defines the way the Palette is applied to the ThermalImage.
+ *  Scale is an interval of the temperature, where colors from a selected Palette is applied.
+ *  The available temperature's range is defined by the ThermalImage.
+ *  Scale cannot be created directly, it should always be obtained from ThermalImage.
+ *  To do so, the ThermalImage.getScale() method should be called.
+ */
+@interface FLIRScale : NSObject
+/**  
+ *   Sets the minimum and maximum scale values.
+ *
+ *   @param min  The minimum scale value.
+ *   @param max  The maximum scale value.
+ */
+- (void)setRangeWithMin:(FLIRThermalValue * _Nonnull)min andMax:(FLIRThermalValue * _Nonnull) max;
+
+/** 
+ *   Sets the scale automatically based on the min and max scale values.
+ *
+ *   @note This call will be removed, use FLIRColorizer.autoScale from FLIRImageColorizer (still images) or FLIRThermalStreamer (live streams) instead.
+ */
+- (void)setAutoAdjustEnabled:(BOOL)enabled DEPRECATED_MSG_ATTRIBUTE("This call will be removed, use FLIRColorizer.autoScale from FLIRImageColorizer (still images) or FLIRThermalStreamer (live streams) instead");;
+
+/** 
+ *  Gets the current minimum scale value.
+ *  @return The min scale value.
+ */
+- (FLIRThermalValue * _Nonnull)getRangeMin;
+
+/** 
+ *  Gets the current maximum scale value.
+ *  @return The max scale value
+ */
+- (FLIRThermalValue *  _Nonnull)getRangeMax;
+
+/** 
+ *  Gets the thermal scale image.
+ *
+ *  @return An UIImage representing the thermal scale.
+ *
+ *  @note This call will be removed, use FLIRColorizer.getScaleImage from FLIRImageColorizer (still images) or FLIRThermalStreamer (live streams) instead.
+ */
+- (UIImage * _Nullable)getImage DEPRECATED_MSG_ATTRIBUTE("This call will be removed, use FLIRColorizer.getScaleImage from FLIRImageColorizer (still images) or FLIRThermalStreamer (live streams) instead");
+
+/**
+ *  Gets the thermal scale image.
+ *
+ *  @param palette the pallete
+ *  
+ *  @return An UIImage representing the full thermal range scale.
+ *
+ *  @note This feature will likely be removed in upcoming release.
+ */
+
++ (UIImage * _Nullable)getFixedFullRangeScaleImage:(FLIRPalette * _Nonnull) palette DEPRECATED_MSG_ATTRIBUTE("This feature will likely be removed in upcoming release.");;
+
+/**
+ *  Gets the thermal scale image from current palette.
+ *
+ *  @return An UIImage representing the full thermal range scale.
+ *
+ *  @note This feature will likely be removed in upcoming release.
+ */
+
+- (UIImage * _Nullable)getFixedFullRangeScaleImage DEPRECATED_MSG_ATTRIBUTE("This feature will likely be removed in upcoming release.");
+
+
+/**
+ *  Gets auto adjust setting.
+ *
+ *  @note This call will be removed, use FLIRColorizer.autoScale from FLIRImageColorizer (still images) or FLIRThermalStreamer (live streams) instead.
+ */
+- (BOOL)isAutoAdjustEnabled DEPRECATED_MSG_ATTRIBUTE("This call will be removed, use FLIRColorizer.autoScale from FLIRImageColorizer (still images) or FLIRThermalStreamer (live streams) instead");
+
+/**
+ *  Sets the maximum range, where colors defined by the Palette are applied to the ThermalImage.
+ *  @Deprecated Setting max value may affect min value, use setRangeWithMin:andMax:
+ */
+- (void)setRangeMax:(FLIRThermalValue * _Nonnull)max;
+
+/**
+ *  Sets the minimum range, where colors defined by the Palette are applied to the ThermalImage.
+ *  @Deprecated Setting min value may affect max value, use setRangeWithMin:andMax:
+ */
+- (void)setRangeMin:(FLIRThermalValue * _Nonnull)min;
+
+@end

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

@@ -1,44 +1,44 @@
-//
-//  FLIRScaleController.h
-//  ThermalSDK
-//
-//  Created by FLIR on 2020-09-14.
-//  Copyright © 2020 Teledyne FLIR. All rights reserved.
-//
-
-#pragma once
-
-@class FLIRRange;
-
-/**
-* Camera scale controller interface.
-*/
-
-@interface FLIRScaleController : NSObject
-
-/** check if auto adjust is available */
-- (BOOL)autoAdjustAvailable;
-/**
- * Get auto adjust mode. Defines the adjust mode of the temperature scale on the live screen on the camera.
- * Auto mode (true value): In this mode, the camera is continuously auto-adjusted for the best image brightness and contrast.
- * Manual mode (false value): This mode allows manual adjustments of the temperature span and the temperature level.
- */
-- (BOOL)getAutoAdjust;
-/** Set auto adjust mode */
-- (BOOL)setAutoAdjust:(BOOL)autoAdjust error: (out NSError * _Nullable * _Nullable)error;
-/** subscribe to changes of auto adjust mode */
-- (BOOL)subscribeAutoAdjust:(out NSError * _Nullable * _Nullable)error;
-/** unsubscribe to changes of auto adjust mode */
-- (void)unsubscribeAutoAdjust;
-/** check if scale active mode is available */
-- (BOOL)activeAvailable;
-/** get active mode */
-- (BOOL)getActive;
-/** Enables/disables the scale active mode.*/
-- (BOOL)setActive:(BOOL)active error: (out NSError * _Nullable * _Nullable)error;
-/** get range for scale */
-- (FLIRRange *_Nullable)getRange;
-/** set range for scale */
-- (BOOL)setRange:(FLIRRange *_Nonnull)range error:(out NSError * _Nullable * _Nullable)error;
-
-@end
+//
+//  FLIRScaleController.h
+//  ThermalSDK
+//
+//  Created by FLIR on 2020-09-14.
+//  Copyright © 2020 Teledyne FLIR. All rights reserved.
+//
+
+#pragma once
+
+@class FLIRRange;
+
+/**
+* Camera scale controller interface.
+*/
+
+@interface FLIRScaleController : NSObject
+
+/** check if auto adjust is available */
+- (BOOL)autoAdjustAvailable;
+/**
+ * Get auto adjust mode. Defines the adjust mode of the temperature scale on the live screen on the camera.
+ * Auto mode (true value): In this mode, the camera is continuously auto-adjusted for the best image brightness and contrast.
+ * Manual mode (false value): This mode allows manual adjustments of the temperature span and the temperature level.
+ */
+- (BOOL)getAutoAdjust;
+/** Set auto adjust mode */
+- (BOOL)setAutoAdjust:(BOOL)autoAdjust error: (out NSError * _Nullable * _Nullable)error;
+/** subscribe to changes of auto adjust mode */
+- (BOOL)subscribeAutoAdjust:(out NSError * _Nullable * _Nullable)error;
+/** unsubscribe to changes of auto adjust mode */
+- (void)unsubscribeAutoAdjust;
+/** check if scale active mode is available */
+- (BOOL)activeAvailable;
+/** get active mode */
+- (BOOL)getActive;
+/** Enables/disables the scale active mode.*/
+- (BOOL)setActive:(BOOL)active error: (out NSError * _Nullable * _Nullable)error;
+/** get range for scale */
+- (FLIRRange *_Nullable)getRange;
+/** set range for scale */
+- (BOOL)setRange:(FLIRRange *_Nonnull)range error:(out NSError * _Nullable * _Nullable)error;
+
+@end

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

@@ -1,109 +1,109 @@
-//
-//  FLIRStream.h
-//  ThermalSDK
-//
-//  Created by FLIR on 2021-10-11.
-//  Copyright © 2021 Teledyne FLIR. All rights reserved.
-//
-
-#import <Foundation/Foundation.h>
-
-NS_ASSUME_NONNULL_BEGIN
-
-/**
- *  Delegate for streaming
- */
-
-@protocol FLIRStreamDelegate <NSObject>
-
-/**
- *  Called when an error occurs in streaming
- */
-- (void)onError:(NSError *)error;
-
-/**
- *  Called when an image is available on the stream
- */
-- (void)onImageReceived;
-
-@end
-
-/**
- *  Camera stream class.
- *  @note the implementation for thermal streaming for network cameras is still in experimental stage.
- */
-@interface FLIRStream : NSObject
-
-/**
- *  Delegate with callbacks
- */
-@property (nonatomic, strong, nullable) id<FLIRStreamDelegate> delegate;
-
-/**
- *  True if the stream contains both thermal and visual data
- */
-@property (nonatomic, readonly) BOOL isDual;
-
-/**
- *  Width and height of the IR data for each frame
- *  (Zero If no IR data is available)
- */
-@property (nonatomic, readonly) CGSize irSize;
-
-/**
- *  Width and height of the visual data for each frame
- *  (Zero If no visual data is available)
- */
-@property (nonatomic, readonly) CGSize visualSize;
-
-/**
- *  True if the stream contains readiometric data
- */
-@property (nonatomic, readonly) BOOL isThermal;
-
-/**
- *  True if the stream is active and streaming
- */
-@property (nonatomic, readonly) BOOL isStreaming;
-
-/**
- *  Start frame grabbing on the provided stream.
- *
- *  Starts the frame grabbing. When a new frame is available the delegate method onImageRecieved will be called.
- *  @note the implementation for thermal streaming for network cameras is still in experimental stage.
- *  @param error  The error if start returns false
- *  @return returns false if not able to start stream
- */
-- (BOOL)start:(out NSError * _Nullable __autoreleasing * _Nullable)error;
-
-/**
- *  Stop frame grabbing on the stream.
- */
-- (void)stop;
-
-/**
- * Set the camera's streamed frame rate.<br />
- * Note: Some cameras will not change frame rate while streaming.
- *
- * @param hz Frames per second, must be in between getMinFrameRate and getMaxFrameRate, inclusive
- */
-- (BOOL)setFrameRate:(double)hertz error:(out NSError * _Nullable __autoreleasing * _Nullable)error;
-
-/**
- * Get the camera's streamed frame rate. If the frame rate cannot be fetched, zero is returned.
- */
-- (double)getFrameRate;
-
-/**
- * Get the lowest possible frame rate for this camera stream.
- */
-- (double)getMinFrameRate;
-
-/**
- * Get the highest possible frame rate for this camera stream. If the frame rate cannot be fetched, zero is returned.
- */
-- (double)getMaxFrameRate;
-
-@end
-
-NS_ASSUME_NONNULL_END
+//
+//  FLIRStream.h
+//  ThermalSDK
+//
+//  Created by FLIR on 2021-10-11.
+//  Copyright © 2021 Teledyne FLIR. All rights reserved.
+//
+
+#import <Foundation/Foundation.h>
+
+NS_ASSUME_NONNULL_BEGIN
+
+/**
+ *  Delegate for streaming
+ */
+
+@protocol FLIRStreamDelegate <NSObject>
+
+/**
+ *  Called when an error occurs in streaming
+ */
+- (void)onError:(NSError *)error;
+
+/**
+ *  Called when an image is available on the stream
+ */
+- (void)onImageReceived;
+
+@end
+
+/**
+ *  Camera stream class.
+ *  @note the implementation for thermal streaming for network cameras is still in experimental stage.
+ */
+@interface FLIRStream : NSObject
+
+/**
+ *  Delegate with callbacks
+ */
+@property (nonatomic, strong, nullable) id<FLIRStreamDelegate> delegate;
+
+/**
+ *  True if the stream contains both thermal and visual data
+ */
+@property (nonatomic, readonly) BOOL isDual;
+
+/**
+ *  Width and height of the IR data for each frame
+ *  (Zero If no IR data is available)
+ */
+@property (nonatomic, readonly) CGSize irSize;
+
+/**
+ *  Width and height of the visual data for each frame
+ *  (Zero If no visual data is available)
+ */
+@property (nonatomic, readonly) CGSize visualSize;
+
+/**
+ *  True if the stream contains readiometric data
+ */
+@property (nonatomic, readonly) BOOL isThermal;
+
+/**
+ *  True if the stream is active and streaming
+ */
+@property (nonatomic, readonly) BOOL isStreaming;
+
+/**
+ *  Start frame grabbing on the provided stream.
+ *
+ *  Starts the frame grabbing. When a new frame is available the delegate method onImageRecieved will be called.
+ *  @note the implementation for thermal streaming for network cameras is still in experimental stage.
+ *  @param error  The error if start returns false
+ *  @return returns false if not able to start stream
+ */
+- (BOOL)start:(out NSError * _Nullable __autoreleasing * _Nullable)error;
+
+/**
+ *  Stop frame grabbing on the stream.
+ */
+- (void)stop;
+
+/**
+ * Set the camera's streamed frame rate.<br />
+ * Note: Some cameras will not change frame rate while streaming.
+ *
+ * @param hz Frames per second, must be in between getMinFrameRate and getMaxFrameRate, inclusive
+ */
+- (BOOL)setFrameRate:(double)hertz error:(out NSError * _Nullable __autoreleasing * _Nullable)error;
+
+/**
+ * Get the camera's streamed frame rate. If the frame rate cannot be fetched, zero is returned.
+ */
+- (double)getFrameRate;
+
+/**
+ * Get the lowest possible frame rate for this camera stream.
+ */
+- (double)getMinFrameRate;
+
+/**
+ * Get the highest possible frame rate for this camera stream. If the frame rate cannot be fetched, zero is returned.
+ */
+- (double)getMaxFrameRate;
+
+@end
+
+NS_ASSUME_NONNULL_END