ilabs-flir 1.0.1 → 1.0.3

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

@@ -1,124 +1,124 @@
-//
-//  FLIRStreamer.h
-//  ThermalSDK
-//
-//  Created by FLIR on 2021-10-12.
-//  Copyright © 2021 Teledyne FLIR. All rights reserved.
-//
-
-#import <Foundation/Foundation.h>
-
-#import "FLIRRendererImpl.h"
-#import "FLIRColorizer.h"
-#import "FLIRCamera.h"
-
-@class FLIRStream;
-@class FLIRThermalImage;
-
-NS_ASSUME_NONNULL_BEGIN
-
-@class FLIRVividIRParameters;
-
-/**
- * Vivid IR upscale methods
- * chaning this will give faster response, but lower quality
- */
-typedef NS_ENUM(NSInteger, FLIRVividIRUpscale) {
-    /// Use superResolution for scaling (only available on FLIR One Pro models)
-    /// this is the default setting for FLIR One Pro
-    FLIRSuperResolution,
-    /// use trilateral scaling
-    /// this is default setting for FLIR One
-    FLIRTrilateral
-};
-
-/**
- * Vivid IR latency mode
- * chaning this will give faster response, but lower quality
- */
-typedef NS_ENUM(NSInteger, FLIRVividIRLatency) {
-    /// Use a latency of 2 frames for denoise
-    /// this is the default setting for FLIR One
-    FLIRLatencyHigh,
-    /// Use a latency of 0 frames for denoise (fastest)
-    FLIRLatencyLow
-};
-
-/**
- *  Streamer class
- */
-@interface FLIRStreamer : FLIRRendererImpl
-
-/**
- *  Get parameters for the VividIR filter
- *  Returns nil if this streamer doesn't use VividIR
- */
-@property (nonatomic, nullable, readonly) FLIRVividIRParameters* vividIRParameters;
-
-@end
-
-/**
- *  Streamer class for thermal data
- */
-@interface FLIRThermalStreamer : FLIRStreamer<FLIRColorizer>
-
-/**
- *  Create a thermal streamer on a stream
- *
- *  @param stream the stream to be streamed
- *
- *  The stream should contain thermal data. This will also contain a colorizer to provide a visual image
- *  from the thermal stream.
- */
-- (instancetype)initWithStream:(FLIRStream *)stream;
-
-/**
- *  Create a thermal streamer on a stream
- *
- *  @param stream the stream to be streamed
- *  @param streamingOptions options for streaming, currently the only option is STREAMING_NO_OPENGL
- *     which creates a pipeline using only CPU filters, avoiding openGL rendering
- *
- *  The stream should contain thermal data. This will also contain a colorizer to provide a visual image
- *  from the thermal stream.
- */
-- (instancetype)initWithStream:(FLIRStream *)stream options: (StreamingOptions)streamingOptions;
-
-/**
- *  call a function with a @ref FLIRThermalImage from the stream
- *
- *  @param imageBlock a block with an image parameter
- */
-- (void)withThermalImage:(void (^)(FLIRThermalImage *))imageBlock;
-
-
-@end
-
-@interface FLIRVividIRParameters : NSObject
-
-
-/// Upscale method used, superresolution is only available on FLIR One Pro models
-@property (nonatomic, assign) FLIRVividIRUpscale upscale;
-/// Latency for denoise
-@property (nonatomic, assign) FLIRVividIRLatency latency;
-/// Denoise filters enabled
-@property (nonatomic, assign) BOOL useDenoise;
-
-@end
-
-/**
- *  Streamer class for visual data
- */
-@interface FLIRVisualStreamer : FLIRStreamer
-/**
- *  Create a visual streamer on a stream
- *
- *  @param stream the stream to be streamed
- *
- *  The stream should contain visual data.
- */
-- (instancetype)initWithStream:(FLIRStream *)stream;
-
-@end
-
-NS_ASSUME_NONNULL_END
+//
+//  FLIRStreamer.h
+//  ThermalSDK
+//
+//  Created by FLIR on 2021-10-12.
+//  Copyright © 2021 Teledyne FLIR. All rights reserved.
+//
+
+#import <Foundation/Foundation.h>
+
+#import "FLIRRendererImpl.h"
+#import "FLIRColorizer.h"
+#import "FLIRCamera.h"
+
+@class FLIRStream;
+@class FLIRThermalImage;
+
+NS_ASSUME_NONNULL_BEGIN
+
+@class FLIRVividIRParameters;
+
+/**
+ * Vivid IR upscale methods
+ * chaning this will give faster response, but lower quality
+ */
+typedef NS_ENUM(NSInteger, FLIRVividIRUpscale) {
+    /// Use superResolution for scaling (only available on FLIR One Pro models)
+    /// this is the default setting for FLIR One Pro
+    FLIRSuperResolution,
+    /// use trilateral scaling
+    /// this is default setting for FLIR One
+    FLIRTrilateral
+};
+
+/**
+ * Vivid IR latency mode
+ * chaning this will give faster response, but lower quality
+ */
+typedef NS_ENUM(NSInteger, FLIRVividIRLatency) {
+    /// Use a latency of 2 frames for denoise
+    /// this is the default setting for FLIR One
+    FLIRLatencyHigh,
+    /// Use a latency of 0 frames for denoise (fastest)
+    FLIRLatencyLow
+};
+
+/**
+ *  Streamer class
+ */
+@interface FLIRStreamer : FLIRRendererImpl
+
+/**
+ *  Get parameters for the VividIR filter
+ *  Returns nil if this streamer doesn't use VividIR
+ */
+@property (nonatomic, nullable, readonly) FLIRVividIRParameters* vividIRParameters;
+
+@end
+
+/**
+ *  Streamer class for thermal data
+ */
+@interface FLIRThermalStreamer : FLIRStreamer<FLIRColorizer>
+
+/**
+ *  Create a thermal streamer on a stream
+ *
+ *  @param stream the stream to be streamed
+ *
+ *  The stream should contain thermal data. This will also contain a colorizer to provide a visual image
+ *  from the thermal stream.
+ */
+- (instancetype)initWithStream:(FLIRStream *)stream;
+
+/**
+ *  Create a thermal streamer on a stream
+ *
+ *  @param stream the stream to be streamed
+ *  @param streamingOptions options for streaming, currently the only option is STREAMING_NO_OPENGL
+ *     which creates a pipeline using only CPU filters, avoiding openGL rendering
+ *
+ *  The stream should contain thermal data. This will also contain a colorizer to provide a visual image
+ *  from the thermal stream.
+ */
+- (instancetype)initWithStream:(FLIRStream *)stream options: (StreamingOptions)streamingOptions;
+
+/**
+ *  call a function with a @ref FLIRThermalImage from the stream
+ *
+ *  @param imageBlock a block with an image parameter
+ */
+- (void)withThermalImage:(void (^)(FLIRThermalImage *))imageBlock;
+
+
+@end
+
+@interface FLIRVividIRParameters : NSObject
+
+
+/// Upscale method used, superresolution is only available on FLIR One Pro models
+@property (nonatomic, assign) FLIRVividIRUpscale upscale;
+/// Latency for denoise
+@property (nonatomic, assign) FLIRVividIRLatency latency;
+/// Denoise filters enabled
+@property (nonatomic, assign) BOOL useDenoise;
+
+@end
+
+/**
+ *  Streamer class for visual data
+ */
+@interface FLIRVisualStreamer : FLIRStreamer
+/**
+ *  Create a visual streamer on a stream
+ *
+ *  @param stream the stream to be streamed
+ *
+ *  The stream should contain visual data.
+ */
+- (instancetype)initWithStream:(FLIRStream *)stream;
+
+@end
+
+NS_ASSUME_NONNULL_END

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

@@ -1,40 +1,40 @@
-//
-//  FLIRSystem.h
-//  ThermalSDK
-//
-//  Created by FLIR on 2020-07-02.
-//  Copyright © 2020 Teledyne FLIR. All rights reserved.
-//
-
-#import <Foundation/Foundation.h>
-
-/** system parameters for the camera */
-@interface FLIRSystem : NSObject
-
-/** get the a flag indicating the system is running */
-- (BOOL) getSystemUp;
-/** get the date and time for the camera */
-- (NSDateComponents* _Nullable)getTime;
-/** get the time zone name for the camera */
-- (NSString* _Nullable)getTimeZoneName;
-/// Set the date and time for the camera.
-/// - Parameter dateComponents: Required components: year, month, day, hour, minute, second and calendar.
-///
-/// The given components are used to set the camera's date and time.
-/// > Note: Timezone is ignored; it's set by ``setTimeZoneName:error:``.  Some cameras set seconds to 0.
-- (BOOL)setTime:(NSDateComponents* _Nonnull)dateComponents error:(out NSError * _Nullable *_Nullable)error;
-/// Set the time zone name for the camera.
-/// > Note: not all cameras support this.
-- (BOOL)setTimeZoneName:(NSString* _Nonnull)timeZoneName error:(out NSError * _Nullable *_Nullable)error;
-/// Get a list of available time zones
-- (NSArray<NSString *>* _Nullable)getAvailableTimeZones:(out NSError * _Nullable *_Nullable)error;
-
-- (BOOL)setWiFiSSID:(NSString * _Nonnull)ssid;
-
-@property (nonatomic, readonly) NSUInteger capacityKBytes;
-@property (nonatomic, readonly) NSUInteger freeKBytes;
-@property (nonatomic) BOOL isTorchOn;
-
-- (void) reboot;
-
-@end
+//
+//  FLIRSystem.h
+//  ThermalSDK
+//
+//  Created by FLIR on 2020-07-02.
+//  Copyright © 2020 Teledyne FLIR. All rights reserved.
+//
+
+#import <Foundation/Foundation.h>
+
+/** system parameters for the camera */
+@interface FLIRSystem : NSObject
+
+/** get the a flag indicating the system is running */
+- (BOOL) getSystemUp;
+/** get the date and time for the camera */
+- (NSDateComponents* _Nullable)getTime;
+/** get the time zone name for the camera */
+- (NSString* _Nullable)getTimeZoneName;
+/// Set the date and time for the camera.
+/// - Parameter dateComponents: Required components: year, month, day, hour, minute, second and calendar.
+///
+/// The given components are used to set the camera's date and time.
+/// > Note: Timezone is ignored; it's set by ``setTimeZoneName:error:``.  Some cameras set seconds to 0.
+- (BOOL)setTime:(NSDateComponents* _Nonnull)dateComponents error:(out NSError * _Nullable *_Nullable)error;
+/// Set the time zone name for the camera.
+/// > Note: not all cameras support this.
+- (BOOL)setTimeZoneName:(NSString* _Nonnull)timeZoneName error:(out NSError * _Nullable *_Nullable)error;
+/// Get a list of available time zones
+- (NSArray<NSString *>* _Nullable)getAvailableTimeZones:(out NSError * _Nullable *_Nullable)error;
+
+- (BOOL)setWiFiSSID:(NSString * _Nonnull)ssid;
+
+@property (nonatomic, readonly) NSUInteger capacityKBytes;
+@property (nonatomic, readonly) NSUInteger freeKBytes;
+@property (nonatomic) BOOL isTorchOn;
+
+- (void) reboot;
+
+@end

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

@@ -1,43 +1,43 @@
-//
-//  FLIRTemperatureRange.h
-//  ThermalSDK
-//
-//  Created by FLIR on 2020-07-02.
-//  Copyright © 2020 Teledyne FLIR. All rights reserved.
-//
-
-@class FLIRThermalValue;
-
-/** a temperature range for a camera */
-@interface FLIRRange : NSObject
-
-/** lowest thermal value */
-@property (nonatomic, retain) FLIRThermalValue* _Nonnull min;
-/** highest thermal value */
-@property (nonatomic, retain) FLIRThermalValue* _Nonnull max;
-
-@end
-
-
-@interface FLIRTemperatureRange : NSObject
-
-/** get all available ranges */
-- (NSArray<FLIRRange*>* _Nullable) getRanges;
-/** get the range used */
-- (int)getSelectedIndex;
-/** 
- * Set the range used.
- * When 'selectedIndex' is being set on the network camera, the camera responds with a success, but it asynchronously sets itself up.
- * In consequence, the success response doesn't necessarily mean the camera is done with changing the setting.
- * This means that reading the 'selectedIndex' will return the old value for a short while, until the camera sets everything up internally.
- * It is up to the developer to subscribe if it is required.
- * When 'selectedIndex' is being set on the FLIR ONE camera, in order to properly reflect new value in 'image.CameraInformation'
- * the streaming must be started prior to setting the value and also 'FLIRThermalImage.getImage()' needs to be called.
- */
-- (BOOL)setSelectedIndex: (int)selectedIndex error: (out NSError * _Nullable *_Nullable)error;
-/** Subscribes for selected temperature range notifications. */
-- (BOOL)subscribeSelectedIndex: (out NSError * _Nullable *_Nullable) error;
-/** Revokes subscription for selected temperature range. */
-- (void)unsubscribeSelectedIndex;
-
-@end
+//
+//  FLIRTemperatureRange.h
+//  ThermalSDK
+//
+//  Created by FLIR on 2020-07-02.
+//  Copyright © 2020 Teledyne FLIR. All rights reserved.
+//
+
+@class FLIRThermalValue;
+
+/** a temperature range for a camera */
+@interface FLIRRange : NSObject
+
+/** lowest thermal value */
+@property (nonatomic, retain) FLIRThermalValue* _Nonnull min;
+/** highest thermal value */
+@property (nonatomic, retain) FLIRThermalValue* _Nonnull max;
+
+@end
+
+
+@interface FLIRTemperatureRange : NSObject
+
+/** get all available ranges */
+- (NSArray<FLIRRange*>* _Nullable) getRanges;
+/** get the range used */
+- (int)getSelectedIndex;
+/** 
+ * Set the range used.
+ * When 'selectedIndex' is being set on the network camera, the camera responds with a success, but it asynchronously sets itself up.
+ * In consequence, the success response doesn't necessarily mean the camera is done with changing the setting.
+ * This means that reading the 'selectedIndex' will return the old value for a short while, until the camera sets everything up internally.
+ * It is up to the developer to subscribe if it is required.
+ * When 'selectedIndex' is being set on the FLIR ONE camera, in order to properly reflect new value in 'image.CameraInformation'
+ * the streaming must be started prior to setting the value and also 'FLIRThermalImage.getImage()' needs to be called.
+ */
+- (BOOL)setSelectedIndex: (int)selectedIndex error: (out NSError * _Nullable *_Nullable)error;
+/** Subscribes for selected temperature range notifications. */
+- (BOOL)subscribeSelectedIndex: (out NSError * _Nullable *_Nullable) error;
+/** Revokes subscription for selected temperature range. */
+- (void)unsubscribeSelectedIndex;
+
+@end

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

@@ -1,77 +1,77 @@
-//
-//  FLIRThermalDelta.h
-//  FLIR Thermal SDK
-//
-//  Copyright © 2020 Teledyne FLIR. All rights reserved.
-//
-
-#pragma once
-#import <Foundation/Foundation.h>
-#import "FLIRThermalValue.h"
-
-// should match atlas::image::measurements::DeltaMemberValueType
-
-/**
- *  Defines delta member value type.
- */
-typedef NS_ENUM(NSUInteger, DeltaMemberValueType) {
-    /**  Min marker value for the specified member type.
-     *   Valid for member types: rectangle, ellipse, line.
-     */
-    typeMin,
-    /**  Max marker value for the specified member type.
-     *   Valid for member types: rectangle, ellipse, line.
-     */
-    typeMax,
-    /**  Average value for the specified member type.
-     *   Valid for member types: rectangle, ellipse, line.
-     */
-    typeAvg,
-    /**  Arbitrary value.
-     *   Valid for member types: spot, reference temperature.
-     */
-    typeValue
-};
-
-/**
- * Represents an Thermal delta with additional state information. It is used to obtain Thermal data
- * from a ThermalImage or any MeasurementShape added to the image.
- */
-@interface FLIRThermalDelta : NSObject
-
-/**
- * Initialize a thermal delta value with specified temperature difference and unit (useful for tests)
- *
- * @param value Temperature difference.
- * @param unit Temperature unit.
- */
-- (instancetype)initWithValue:(double) value andUnit:(TemperatureUnit) unit;
-
-/**
- *  Gets the difference/delta value.
- */
-@property (readonly, nonatomic) double value;
-
-/**
- *  Gets the temperature unit.
- */
-@property (readonly, nonatomic) TemperatureUnit unit;
-
-/**
- *  Gets the state of the value.
- */
-@property (readonly, nonatomic) ThermalValueState state;
-
-/**
- *  Gets a formatted string representing the value.
- */
-- (NSString *)description;
-
-/**
- *  Convenience function to test if two FLIRThermalDelta have the same temperature difference with imprecise floating-point comparison.
- *  @param other The second (right hand side) value to compare.
- *  @param absError The margin of error in degrees Kelvin.
- */
-- (BOOL)areNear:(id)other absError: (double)absError;
-
-@end
+//
+//  FLIRThermalDelta.h
+//  FLIR Thermal SDK
+//
+//  Copyright © 2020 Teledyne FLIR. All rights reserved.
+//
+
+#pragma once
+#import <Foundation/Foundation.h>
+#import "FLIRThermalValue.h"
+
+// should match atlas::image::measurements::DeltaMemberValueType
+
+/**
+ *  Defines delta member value type.
+ */
+typedef NS_ENUM(NSUInteger, DeltaMemberValueType) {
+    /**  Min marker value for the specified member type.
+     *   Valid for member types: rectangle, ellipse, line.
+     */
+    typeMin,
+    /**  Max marker value for the specified member type.
+     *   Valid for member types: rectangle, ellipse, line.
+     */
+    typeMax,
+    /**  Average value for the specified member type.
+     *   Valid for member types: rectangle, ellipse, line.
+     */
+    typeAvg,
+    /**  Arbitrary value.
+     *   Valid for member types: spot, reference temperature.
+     */
+    typeValue
+};
+
+/**
+ * Represents an Thermal delta with additional state information. It is used to obtain Thermal data
+ * from a ThermalImage or any MeasurementShape added to the image.
+ */
+@interface FLIRThermalDelta : NSObject
+
+/**
+ * Initialize a thermal delta value with specified temperature difference and unit (useful for tests)
+ *
+ * @param value Temperature difference.
+ * @param unit Temperature unit.
+ */
+- (instancetype)initWithValue:(double) value andUnit:(TemperatureUnit) unit;
+
+/**
+ *  Gets the difference/delta value.
+ */
+@property (readonly, nonatomic) double value;
+
+/**
+ *  Gets the temperature unit.
+ */
+@property (readonly, nonatomic) TemperatureUnit unit;
+
+/**
+ *  Gets the state of the value.
+ */
+@property (readonly, nonatomic) ThermalValueState state;
+
+/**
+ *  Gets a formatted string representing the value.
+ */
+- (NSString *)description;
+
+/**
+ *  Convenience function to test if two FLIRThermalDelta have the same temperature difference with imprecise floating-point comparison.
+ *  @param other The second (right hand side) value to compare.
+ *  @param absError The margin of error in degrees Kelvin.
+ */
+- (BOOL)areNear:(id)other absError: (double)absError;
+
+@end