react-native-flic2 0.3.23 → 0.3.24

package/ios/flic2lib.xcframework/ios-arm64_x86_64-maccatalyst/flic2lib.framework/Versions/A/Headers/FLICManager.h

@@ -0,0 +1,171 @@
+//
+//  FLICManager.h
+//  flic2lib
+//
+//  Created by Anton Meier on 2019-04-11.
+//  Copyright © 2020 Shortcut Labs. All rights reserved.
+//
+
+#import <Foundation/Foundation.h>
+#import <CoreBluetooth/CoreBluetooth.h>
+#import "FLICButton.h"
+
+NS_ASSUME_NONNULL_BEGIN
+
+@protocol FLICManagerDelegate;
+
+/*!
+ *  @class FLICManager
+ *
+ *  @discussion     This interface is intended to be used as a singleton. It keeps track of all the buttons that have been paired with this particular app and restores them on each
+ *                  application launch.
+ *
+ */
+@interface FLICManager : NSObject
+
+/*!
+ *  @property delegate
+ *
+ *  @discussion     The delegate that all the FLICManagerDelegate events will be sent to. Usually this is configured only once when the application is first launched, using the
+ *                  configureWithDelegate:buttonDelegate:background: method.
+ *
+ */
+@property(weak, nonatomic, nullable) id<FLICManagerDelegate> delegate;
+
+/*!
+ *  @property buttonDelegate
+ *
+ *  @discussion     Once set, this delegate will automatically be set to every button instance on each application launch. This will also be assigned to new buttons that are discovered
+ *                  using the scanForButtonsWithStateChangeHandler:completionHandler method. Using this delegate also ensures that the click events are delivered as fast as possible
+ *                  when an application is restored in the background.
+ *
+ */
+@property(weak, nonatomic, nullable) id<FLICButtonDelegate> buttonDelegate;
+
+/*!
+ *  @property state
+ *
+ *  @discussion     This is the state of the Flic manager. This state closely resembles the CBManager state of Apple's CoreBluetooth framework. You will only be able to communicate with
+ *                  Flic buttons while the manager is in the FlicManagerStatePoweredOn state.
+ *
+ */
+@property(readonly) FLICManagerState state;
+
+/*!
+ *  @property scanning
+ *
+ *  @discussion     Let's you know if a scan is currently running or not. Reading this value will not affect a scan.
+ *
+ */
+@property(nonatomic, readonly) BOOL isScanning;
+
+/*!
+ *  @method sharedManager
+ *
+ *  @discussion     This class method return the singleton manager, assuming that it has been configured first using the configureWithDelegate:buttonDelegate:background: method first,
+ *                  otherwise nil is returned.
+ *
+ */
++ (instancetype _Nullable)sharedManager;
+
+/*!
+ *  @method
+ *
+ *  @param delegate                 The delegate to be used with the manager singleton.
+ *  @param buttonDelegate    The delegate to be automatically assigned to each FLICButton instance.
+ *  @param background             Whether or not you intend to use this application in the background.
+ *
+ *  @discussion     This configuration method must be called before the manager can be used. It is recommended that this is done as soon as possible after your application has launched
+ *                  in order to minimize the delay of any pending click events. The flic2lib officially only support iOS 12 and up, however, to make it easier for the developer, the framework
+ *                  is built with a target of iOS 9 and contains slices for both arm64 and armv7. This means that you will be able to include, and load, the framework in apps that support iOS 9.
+ *                  However, if you try to configure the manager on a device running iOS 11, or below, then the manager state will switch to FLICManagerStateUnsupported. A good place
+ *                  to handle this would be in the manager:didUpdateSate: method.
+ *
+ */
++ (instancetype _Nullable)configureWithDelegate:(id<FLICManagerDelegate> _Nullable)delegate
+                                 buttonDelegate:(id<FLICButtonDelegate> _Nullable)buttonDelegate
+                                     background:(BOOL)background;
+
+/*!
+ *  @method buttons
+ *
+ *  @discussion     This array will contain every button that is currently paired with this application. Each button will be added to the list after a call to
+ *                  scanForButtonsWithStateChangeHandler:completionHandler: has completed without error. It is important to know that you may not try to access this list until after the
+ *                  managerDidRestoreState: method has been sent to the manager delegate.
+ *
+ */
+- (NSArray<FLICButton *> *)buttons;
+
+/*!
+ *  @method forgetButton:
+ *
+ *  @param button            The button that you wish to delete from the manager.
+ *  @param completion   This returns the identifier of the button instance that was just removed along with an error, if needed.
+ *
+ *  @discussion     This will delete this button from the manager. After a successful call to this method you will no longer be able to communicate with the associated Flic button unless you
+ *                  pair it again using the scanForButtonsWithStateChangeHandler:completionHandler:. On completion, the button will no longer be included in the manager's buttons array.
+ *                  After a successful call to this method, you should discard of any references to that particular Flic button object. If you try to forget a button that is already forgotten, then
+ *                  you will get an error with the FLICErrorAlreadyForgotten code.
+ *
+ */
+- (void)forgetButton:(FLICButton *)button completion:(void (^)(NSUUID *uuid, NSError * _Nullable error))completion;
+
+/*!
+ *  @method
+ *
+ *  @param stateHandler      This handler returns status events that lets you know what the scanner is currently doing. The purpose of this handler is to provide a predefined states where
+ *                        you may update your application UI.
+ *  @param completion           The completion handler will always run and if successful it will return a new FLICButton instance, otherwise it will provide you with an error.
+ *
+ *  @discussion     This method lets you add new Flic buttons to the manager. The scan flow is automated and the stateHandler will let you know what information you should provide to
+ *                  your application end user. If you try to scan for buttons while running on an iOS version below the mimimun requirement, then you will get an error with the
+ *                  FLICErrorUnsupportedOSVersion error code.
+ *
+ */
+- (void)scanForButtonsWithStateChangeHandler:(void (^)(FLICButtonScannerStatusEvent event))stateHandler
+                                  completion:(void (^)(FLICButton * _Nullable button, NSError * _Nullable error))completion;
+
+/*!
+ *  @method stopScan
+ *
+ *  @discussion     Cancel an ongoing button scan. This will result in a scan completion with an error.
+ *
+ */
+- (void)stopScan;
+
+@end
+
+/*!
+ *  @protocol FLICManagerDelegate
+ *
+ *  @discussion     The delegate of a FLICManager instance must adopt the FLICManagerDelegate protocol. All calls to the delegate methods will be on the main dispatch queue.
+ *
+ */
+@protocol FLICManagerDelegate <NSObject>
+
+/*!
+ *  @method managerDidRestoreState:
+ *
+ *  @param manager      The manager instance that the event originates from. Since this is intended to be used as a singleton, there should only ever be one manager instance.
+ *
+ *  @discussion     This is called once the manager has been restored. This means that all the FLICButton instances from your previous session are restored as well. After this method
+ *                  has been called you may start using the manager and communicate with the Flic buttons. This method will only be called once on each application launch.
+ *
+ */
+- (void)managerDidRestoreState:(FLICManager *)manager;
+
+/*!
+ *  @method manager:didUpdateState:
+ *
+ *  @param manager      The manager instance that the event originates from. Since this is intended to be used as a singleton, there should only ever be one manager instance.
+ *  @param state           The state of the Flic manager singleton.
+ *
+ *  @discussion     Each time the state of the Flic manager changes, you will get this callback. Usually this is related to bluetooth state changes on the iOS device. It is also guaranteed to
+ *                  be called at least once after the manager has been configured.
+ *
+ */
+- (void)manager:(FLICManager *)manager didUpdateState:(FLICManagerState)state;
+
+@end
+
+NS_ASSUME_NONNULL_END

package/ios/flic2lib.xcframework/ios-arm64_x86_64-maccatalyst/flic2lib.framework/Versions/A/Headers/flic2lib.h

@@ -0,0 +1,19 @@
+//
+//  flic2lib.h
+//  flic2lib
+//
+//  Created by Anton Meier on 2019-04-10.
+//  Copyright © 2020 Shortcut Labs. All rights reserved.
+//
+
+#import <UIKit/UIKit.h>
+
+#import <flic2lib/FLICEnums.h>
+#import <flic2lib/FLICManager.h>
+#import <flic2lib/FLICButton.h>
+
+//! Project version number for flic2lib.
+FOUNDATION_EXPORT double flic2libVersionNumber;
+
+//! Project version string for flic2lib.
+FOUNDATION_EXPORT const unsigned char flic2libVersionString[];

package/ios/flic2lib.xcframework/ios-arm64_x86_64-maccatalyst/flic2lib.framework/Versions/A/Modules/module.modulemap

@@ -0,0 +1,6 @@
+framework module flic2lib {
+  umbrella header "flic2lib.h"
+
+  export *
+  module * { export * }
+}

package/ios/flic2lib.xcframework/ios-arm64_x86_64-maccatalyst/flic2lib.framework/Versions/A/Resources/Info.plist

@@ -0,0 +1,50 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!DOCTYPE plist PUBLIC "-//Apple//DTD PLIST 1.0//EN" "http://www.apple.com/DTDs/PropertyList-1.0.dtd">
+<plist version="1.0">
+<dict>
+	<key>BuildMachineOSBuild</key>
+	<string>20C69</string>
+	<key>CFBundleDevelopmentRegion</key>
+	<string>English</string>
+	<key>CFBundleExecutable</key>
+	<string>flic2lib</string>
+	<key>CFBundleIdentifier</key>
+	<string>com.shortcutlabs.flic2lib</string>
+	<key>CFBundleInfoDictionaryVersion</key>
+	<string>6.0</string>
+	<key>CFBundleName</key>
+	<string>flic2lib</string>
+	<key>CFBundlePackageType</key>
+	<string>FMWK</string>
+	<key>CFBundleShortVersionString</key>
+	<string>1.2.0</string>
+	<key>CFBundleSupportedPlatforms</key>
+	<array>
+		<string>MacOSX</string>
+	</array>
+	<key>CFBundleVersion</key>
+	<string>1</string>
+	<key>DTCompiler</key>
+	<string>com.apple.compilers.llvm.clang.1_0</string>
+	<key>DTPlatformBuild</key>
+	<string>12E262</string>
+	<key>DTPlatformName</key>
+	<string>macosx</string>
+	<key>DTPlatformVersion</key>
+	<string>11.3</string>
+	<key>DTSDKBuild</key>
+	<string>20E214</string>
+	<key>DTSDKName</key>
+	<string>macosx11.3</string>
+	<key>DTXcode</key>
+	<string>1250</string>
+	<key>DTXcodeBuild</key>
+	<string>12E262</string>
+	<key>LSMinimumSystemVersion</key>
+	<string>10.15</string>
+	<key>UIDeviceFamily</key>
+	<array>
+		<integer>2</integer>
+	</array>
+</dict>
+</plist>

package/ios/flic2lib.xcframework/ios-arm64_x86_64-simulator/flic2lib.framework/Headers/FLICButton.h

@@ -0,0 +1,335 @@
+//
+//  FLICButton.h
+//  flic2lib
+//
+//  Created by Anton Meier on 2019-04-11.
+//  Copyright © 2020 Shortcut Labs. All rights reserved.
+//
+
+#import <Foundation/Foundation.h>
+#import "FLICEnums.h"
+
+NS_ASSUME_NONNULL_BEGIN
+
+@protocol FLICButtonDelegate;
+
+/*!
+ *  @class FLICButton
+ *
+ *  @discussion     An instance of this class represents a physical Flic.
+ *
+ */
+@interface FLICButton : NSObject
+
+/*!
+ *  @property identifier
+ *
+ *  @discussion     This identifier is guaranteed to be the same for each Flic paired to a particular iOS device. Thus it can be used to identify a Flic within an app.
+ *                  However, If you need to identify Flics cross different apps on different iOS devices, then you should have look at the either uuid, serialNumber, or bluetoothAddress.
+ *
+ */
+@property(readonly, nonatomic, strong, nonnull) NSUUID *identifier;
+
+/*!
+ *  @property delegate
+ *
+ *  @discussion     The delegate that will receive events related to this particular Flic.
+ *                  You can either set this delegate manually for each button, or let the manager do so automatically using the buttonDelegate as default.
+ *
+ */
+@property(weak, nonatomic, nullable) id<FLICButtonDelegate> delegate;
+
+/*!
+ *  @property name
+ *
+ *  @discussion     The bluetooth advertisement name of the Flic. This will be the same name that is shown by iOS it its bluetooth settings.
+ *
+ */
+@property(nonatomic, readonly, strong, nullable) NSString *name;
+
+/*!
+ *  @property nickname
+ *
+ *  @discussion     With this property you can read out the display name that the user may change in for example the Flic app. This value can also be changed from third party apps
+ *                  integrating this framework (including your app). The purpose of this is to provide more human readable name that the user can use to identify its Flic's across apps.
+ *                  For example "Kitchen Flic" or "Bedroom Lights". The nickname has a maximum length limit of 23 bytes. Keep in mind that this is the length in bytes, and not the
+ *                  number of UTF8 characters (which may be up to 4 bytes long). If you write anything longer than 23 bytes then the nickname will automatically be truncated to at
+ *                  most 23 bytes. When truncating the string, the framework will always cut between UTF8 character, so you don't have to worry about writing half an emoji, for example.
+ *
+ */
+@property(nonatomic, readwrite, strong, nullable) NSString *nickname;
+
+/*!
+ *  @property bluetoothAddress
+ *
+ *  @discussion     The bluetooth address of the Flic. This will be a string representation of a 49 bit long address. Example: "00:80:e4:da:12:34:56"
+ *
+ */
+@property(nonatomic, readonly, strong, nonnull) NSString *bluetoothAddress;
+
+/*!
+ *  @property uuid
+ *
+ *  @discussion     This is a unique identifier string that best used to identify a Flic. This is for example used to identify Flics on all our API endpoints.
+ *
+ */
+@property(nonatomic, readonly, strong, nonnull) NSString *uuid;
+
+/*!
+ *  @property serialNumber
+ *
+ *  @discussion     The serial number is a production identifier that is printed on the backside of the Flic inside the battery hatch.
+ *                  This serves no other purpose than allowing a user to identify a button by manually looking at it. Can be useful in some cases.
+ *
+ */
+@property(nonatomic, readonly, strong, nonnull) NSString *serialNumber;
+
+/*!
+ *  @property triggerMode
+ *
+ *  @discussion     Use this property to let the flic2lib know what type of click events you are interested it. By default you will get Click, Double Click and Hold events.
+ *                  However, if you for example are only interested in Click events then you can set this property to FLICButtonTriggerModeClick. Doing so will allow the flic2lib to
+ *                  deliver the events quicker since it can now ignore Double Click and Hold.
+ *
+ */
+@property(nonatomic, readwrite) FLICButtonTriggerMode triggerMode;
+
+/*!
+ *  @property state
+ *
+ *  @discussion     Lets you know if the Flic is Connected, Disconnected, Connecting, or Disconnecting.
+ *
+ */
+@property(nonatomic, readonly) FLICButtonState state;
+
+/*!
+ *  @property pressCount
+ *
+ *  @discussion     The number of times the Flic has been clicked since last time it booted.
+ *
+ */
+@property(nonatomic, readonly) uint32_t pressCount;
+
+/*!
+ *  @property firmwareRevision
+ *
+ *  @discussion     The revision of the firmware currently running on the Flic.
+ *
+ */
+@property(nonatomic, readonly) uint32_t firmwareRevision;
+
+/*!
+ *  @property isReady
+ *
+ *  @discussion     When a Flic connects it will go through a quick cryptographic verification to ensure that it is both a genuine Flic and that it is the correct Flic.
+ *                  Once this is completed this property will be set to YES and it is not until after that that you will start receiving click events (if any). As soon as the button disconnects
+ *                  this will be set to NO again.
+ *
+ */
+@property(nonatomic, readonly) BOOL isReady;
+
+/*!
+ *  @property batteryVoltage
+ *
+ *  @discussion     This will be the last know battery sample taken on the Flic. If this value is 0 then you should assume that no sample has yet been taken. It is important to know that
+ *                  the voltage may fluctuate depending on many different factors, such as temperature and workload. For example, heavy usage of the LED will temporarily lower the voltage,
+ *                  but it is likely to recover shortly after. Therefore we do not recomend to exactly translate this value into a battery percentage, instead consider showing a
+ *                  "change the battery soon"-status in your app once the voltage goes below 2.65V.
+ *
+ */
+@property(nonatomic, readonly) float batteryVoltage;
+
+/*!
+ *  @property isUnpaired
+ *
+ *  @discussion     If this property is YES, then it means that this app's pairing with this specific Flic is no longer valid. This can for example occur if the Flic has been factory reset,
+ *                  or if the maximum number of pairings have been reached. In this case you will need to delete the button from the manager and then scan for it again.
+ *
+ */
+@property(nonatomic, readonly) BOOL isUnpaired;
+
+/*!
+ *  @property latencyMode
+ *
+ *  @discussion     Lets you switch between two different latency modes. For most use-cases it is recommend to keep the default FLICLatencyModeNormal.
+ *                  FLICLatencyModeLow should ideally only be used for foreground applications, such as games, where low latency is needed. Keep in mind that the
+ *                  energy consumption will be significantly higher in the low latency mode.
+ *
+ */
+@property(nonatomic, readwrite) FLICLatencyMode latencyMode;
+
+/*!
+ *  @method connect
+ *
+ *  @discussion     Attempts to connect the Flic. If the Flic is not available, due to either being out of range or not advertising, then it will be connected once it becomes
+ *                  available as this call does not time out. This is often called a pending connection. It can be canceled by calling disconnect.
+ *
+ */
+- (void)connect;
+
+/*!
+ *  @method disconnect
+ *
+ *  @discussion     Disconnect a currently connected Flic or cancel a pending connection.
+ *
+ */
+- (void)disconnect;
+
+@end
+
+/*!
+ *  @protocol FLICButtonDelegate
+ *
+ *  @discussion     The delegate of a FLICButton instance must adopt the FLICButtonDelegate protocol. All calls to the delegate methods will be on the main dispatch queue.
+ *
+ */
+@protocol FLICButtonDelegate <NSObject>
+
+/*!
+ *  @method buttonDidConnect:
+ *
+ *  @param button   The FLICButton instance that the event originated from.
+ *
+ *  @discussion     This method is called every time the Flic establishes a new bluetooth connection. Keep in mind that you also have to wait for the buttonIsReady: before
+ *                  the Flic is ready to be used.
+ *
+ */
+- (void)buttonDidConnect:(FLICButton *)button;
+
+/*!
+ *  @method buttonIsReady:
+ *
+ *  @param button   The FLICButton instance that the event originated from.
+ *
+ *  @discussion     This method is called after each connection once the Flic has been cryptographically verified. You will not receive any click events before this is called.
+ *
+ */
+- (void)buttonIsReady:(FLICButton *)button;
+
+/*!
+ *  @method button:didDisconnectWithError:
+ *
+ *  @param button       The FLICButton instance that the event originated from.
+ *  @param error         This error lets you know the reason for the disconnect. An error does not necessarily mean that something went wrong.
+ *
+ *  @discussion     This method is called every time the bluetooth link with the Flic is lost. This can occur for several different reasons. The most common would be that
+ *                  the iOS device and the Flic is no longer within range of each other.
+ *
+ */
+- (void)button:(FLICButton *)button didDisconnectWithError:(NSError * _Nullable)error;
+
+/*!
+ *  @method button:didFailToConnectWithError:
+ *
+ *  @param button       The FLICButton instance that the event originated from.
+ *  @param error         This error lets you know why the connection attempt failed.
+ *
+ *  @discussion     This method is called when a connection attempt to a button fails. This indicates that something has gone wrong and that the pending connection will not be reset.
+ *
+ */
+- (void)button:(FLICButton *)button didFailToConnectWithError:(NSError * _Nullable)error;
+
+@optional
+
+/*!
+ *  @method button:didReceiveButtonDown:age:
+ *
+ *  @param button        The FLICButton instance that the event originated from.
+ *  @param queued        Whether the event is a queued event that happened before the Flic connected or if it is a real time event.
+ *  @param age               If the event was queued, then this will let you know the age of the event rounded to the nearest second.
+ *
+ *  @discussion     The Flic registered a button down event.
+ *
+ */
+- (void)button:(FLICButton *)button didReceiveButtonDown:(BOOL)queued age:(NSInteger)age;
+
+/*!
+ *  @method button:didReceiveButtonUp:age:
+ *
+ *  @param button       The FLICButton instance that the event originated from.
+ *  @param queued       Whether the event is a queued event that happened before the Flic connected or if it is a real time event.
+ *  @param age              If the event was queued, then this will let you know the age of the event rounded to the nearest second.
+ *
+ *  @discussion     The Flic registered a button up event.
+ *
+ */
+- (void)button:(FLICButton *)button didReceiveButtonUp:(BOOL)queued age:(NSInteger)age;
+
+/*!
+ *  @method button:didReceiveButtonClick:age:
+ *
+ *  @param button       The FLICButton instance that the event originated from.
+ *  @param queued       Whether the event is a queued event that happened before the Flic connected or if it is a real time event.
+ *  @param age              If the event was queued, then this will let you know the age of the event rounded to the nearest second.
+ *
+ *  @discussion     The Flic registered a button click event.
+ *
+ */
+- (void)button:(FLICButton *)button didReceiveButtonClick:(BOOL)queued age:(NSInteger)age;
+
+/*!
+ *  @method button:didReceiveButtonDoubleClick:age:
+ *
+ *  @param button       The FLICButton instance that the event originated from.
+ *  @param queued       Whether the event is a queued event that happened before the Flic connected or if it is a real time event.
+ *  @param age              If the event was queued, then this will let you know the age of the event rounded to the nearest second.
+ *
+ *  @discussion     The Flic registered a double click event.
+ *
+ */
+- (void)button:(FLICButton *)button didReceiveButtonDoubleClick:(BOOL)queued age:(NSInteger)age;
+
+/*!
+ *  @method button:didReceiveButtonHold:age:
+ *
+ *  @param button       The FLICButton instance that the event originated from.
+ *  @param queued       Whether the event is a queued event that happened before the Flic connected or if it is a real time event.
+ *  @param age              If the event was queued, then this will let you know the age of the event rounded to the nearest second.
+ *
+ *  @discussion     The Flic registered a button hold event.
+ *
+ */
+- (void)button:(FLICButton *)button didReceiveButtonHold:(BOOL)queued age:(NSInteger)age;
+
+/*!
+ *  @method button:didUnpairWithError:
+ *
+ *  @param button       The FLICButton instance that the event originated from.
+ *  @param error         This will always be nil at this time.
+ *
+ *  @discussion     The app no longer has a valid pairing with the Flic button. The isUnpaired property will now be YES and all connection
+ *                  attempts made will immediately fail. To fix this you need to delete the button from the manager and then re-scan it again.
+ *
+ */
+- (void)button:(FLICButton *)button didUnpairWithError:(NSError * _Nullable)error;
+
+/*!
+ *  @method button:didUpdateBatteryVoltage:
+ *
+ *  @param button       The FLICButton instance that the event originated from.
+ *  @param voltage     Float representation of the latest battery voltage sample.
+ *
+ *  @discussion     This callback will be sent once the Flic button updates its battery voltage with a new value. Typically this will occurs a few seconds
+ *                  after the button connects. If you show a battery indicator in you app, then this would be a good place to refresh your UI. Please
+ *                  see the description for the batteryVoltage property for more information.
+ *
+ */
+- (void)button:(FLICButton *)button didUpdateBatteryVoltage:(float)voltage;
+
+/*!
+ *  @method button:didUpdateNickname:
+ *
+ *  @param button       The FLICButton instance that the event originated from.
+ *  @param nickname   The new nickname that was sent from the Flic.
+ *
+ *  @discussion     If the nickname is updated by another app (including the official Flic app), then you will get this callback letting you know that the
+ *                  name has changed. This may either be in real time (if multiple apps are connected at the same time), or a deayed event that
+ *                  occurs after the button connects (if the nickname was changed while your app was not active). If your app displays this nickname,
+ *                  then this would be a good place to refresh your UI.
+ *
+ */
+- (void)button:(FLICButton *)button didUpdateNickname:(NSString *)nickname;
+
+@end
+
+NS_ASSUME_NONNULL_END