react-native-flic2 0.3.22 → 0.3.24

package/ios/flic2lib.xcframework/ios-arm64_x86_64-maccatalyst/flic2lib.framework/Versions/A/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

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

@@ -0,0 +1,315 @@
+//
+//  FLICEnums.h
+//  fliclib
+//
+//  Created by Anton Meier on 2019-04-18.
+//  Copyright © 2020 Shortcut Labs. All rights reserved.
+//
+
+#ifndef FLICEnums_h
+#define FLICEnums_h
+
+extern NSString * const FLICErrorDomain;
+extern NSString * const FLICButtonScannerErrorDomain;
+
+/*!
+ * @enum FLICManagerState
+ *
+ * @discussion      Represents the the different states that a Flic manager can be in at any given time. These states are mostly translated values of Apple's CoreBluetooth CBManagerState enums.
+ *
+ */
+typedef NS_ENUM(NSInteger, FLICManagerState)
+{
+    /**
+     * State is unknown, update imminent.
+     */
+    FLICManagerStateUnknown = 0,
+    /**
+     * The bluetooth connection with the system service was momentarily lost, update imminent.
+     */
+    FLICManagerStateResetting,
+    /**
+     * The Flic manager can not be used on this platform.
+     */
+    FLICManagerStateUnsupported,
+    /**
+     * The application is not authorized to use Bluetooth Low Energy.
+     */
+    FLICManagerStateUnauthorized,
+    /**
+     * Bluetooth is currently powered off.
+     */
+    FLICManagerStatePoweredOff,
+    /**
+     * Bluetooth is currently powered on and available to use.
+     */
+    FLICManagerStatePoweredOn
+};
+
+/*!
+ * @enum FLICButtonScannerErrorCode
+ *
+ * @discussion      Represents the different error codes that can be generated while scanning and pairing new Flics.
+ *
+*/
+typedef NS_ENUM(NSInteger, FLICButtonScannerErrorCode)
+{
+    /**
+     * The scan was unsuccessful due to an unknown reason.
+     */
+    FLICButtonScannerErrorCodeUnknown = 0,
+    /**
+     * The scan could not be started since bluetooth was not in the powered on state.
+     */
+    FLICButtonScannerErrorCodeBluetoothNotActivated,
+    /**
+     * No button was advertising in public mode within proximity.
+     */
+    FLICButtonScannerErrorCodeNoPublicButtonDiscovered,
+    /**
+     * The bluetooth pairing failed since the user already has paired this button before with this device.
+     * This is solved by removing the pairing from the iOS bluetooth pairing settings screen.
+     */
+    FLICButtonScannerErrorCodeBLEPairingFailedPreviousPairingAlreadyExisting,
+    /**
+     * The bluetooth pairing failed since the user pressed cancel on the pairing dialog.
+     */
+    FLICButtonScannerErrorCodeBLEPairingFailedUserCanceled,
+    /**
+     * The bluetooth pairing failed since iOS decided to decline the request. It is unknown why or if this can happen.
+     */
+    FLICButtonScannerErrorCodeBLEPairingFailedUnknownReason,
+    /**
+     * Indicates that the button cannot be unlocked since it belongs to a different brand.
+     */
+    FLICButtonScannerErrorCodeAppCredentialsDontMatch,
+    /**
+     * The scan was manually canceled using the stopScan method.
+     */
+    FLICButtonScannerErrorCodeUserCanceled,
+    /**
+     * The Flic's certificate belongs to a different bluetooth address.
+     */
+    FLICButtonScannerErrorCodeInvalidBluetoothAddress,
+    /**
+     * The framework was unable to pair with the Flic since it did not pass the authenticity check.
+     */
+    FLICButtonScannerErrorCodeGenuineCheckFailed,
+    /**
+     * The discovered Flic cannot be connected since it is currently connected to a different device.
+     */
+    FLICButtonScannerErrorCodeAlreadyConnectedToAnotherDevice,
+    /**
+     * The discovered Flic cannot be connected since the maximum number of simultaneous app connections has been reached.
+     */
+    FLICButtonScannerErrorCodeTooManyApps,
+    /**
+     * A bluetooth specific error. The framework was unable to establish a connection to the Flic peripheral.
+     */
+    FLICButtonScannerErrorCodeCouldNotSetBluetoothNotify,
+    /**
+     * A bluetooth specific error. The framework was unable to establish a connection to the Flic peripheral.
+     */
+    FLICButtonScannerErrorCodeCouldNotDiscoverBluetoothServices,
+    /**
+     * The bluetooth connection was dropped during the verification process.
+     */
+    FLICButtonScannerErrorCodeButtonDisconnectedDuringVerification,
+    /**
+     * The Flic peripheral connection was unexpectedly lost.
+     */
+    FLICButtonScannerErrorCodeConnectionTimeout,
+    /**
+     * The bluetooth connection failed.
+     */
+    FLICButtonScannerErrorCodeFailedToEstablish,
+    /**
+     * The iOS device reached the maximum number of allowed bluetooth peripherals.
+     */
+    FLICButtonScannerErrorCodeConnectionLimitReached,
+    /**
+     * The signature generated by the Flic button could not be verified.
+     */
+    FLICButtonScannerErrorCodeInvalidVerifier,
+    /**
+     * The Flic button was no longer in public mode when the verification process ran.
+     */
+    FLICButtonScannerErrorCodeNotInPublicMode,
+};
+
+/*!
+ * @enum FLICButtonScannerStatusEvent
+ *
+ * @discussion      While the scanner is running, it will send a status events to let you know what it is doing. These enums represents those events.
+ *
+*/
+typedef NS_ENUM(NSInteger, FLICButtonScannerStatusEvent)
+{
+    /**
+     * A public Flic has been discovered and a connection attempt will now be made.
+     */
+    FLICButtonScannerStatusEventDiscovered = 0,
+    /**
+     * The Flic was successfully bluetooth connected.
+     */
+    FLICButtonScannerStatusEventConnected,
+    /**
+     * The Flic has been verified and unlocked for this app. The Flic will soon be delivered in the assigned completion handler.
+     */
+    FLICButtonScannerStatusEventVerified,
+    /**
+     * The Flic could not be verified. The completion handler will soon run to let you know what the error was.
+     */
+    FLICButtonScannerStatusEventVerificationFailed,
+};
+
+/*!
+ *  @enum FLICError
+ *
+ *  @discussion     These enums represents the different error codes that can be sent from flic2lib, excluding the button scanner which has its own set of error codes.
+ *
+ */
+typedef NS_ENUM(NSInteger, FLICError)
+{
+    /**
+     * An unknown error has occurred.
+     */
+    FLICErrorUnknown = 0,
+    /**
+     * You are trying to use the manager while it has not been configured yet.
+     */
+    FLICErrorNotConfigured,
+    /**
+     * A bluetooth specific error code. This means that something went wrong while the phone tried to establish a connection with the Flic peripheral.
+     */
+    FLICErrorCouldNotDiscoverBluetoothServices,
+    /**
+     * The framework was unable to verify the cryptographic signature from the Flic while setting up a session.
+     */
+    FLICErrorVerificationSignatureMismatch,
+    /**
+     * The UUID of a button is not correct.
+     */
+    FLICErrorInvalidUuid,
+    /**
+     * While establishing a connection with the Flic the framework was unable to verify the authenticity of the button.
+     */
+    FLICErrorGenuineCheckFailed,
+    /**
+     * The app was unable to establish a connection with the Flic button because it already had a connection with too many apps on this particular phone.
+     */
+    FLICErrorTooManyApps,
+    /**
+     * The pairing on the Flic button has been lost so the app's pairing data is no longer valid. This typically happens if the Flic is factory reset.
+     */
+    FLICErrorUnpaired,
+    /**
+     * The manager was unable to complete the task since the device is not running on a supported iOS version.
+     */
+    FLICErrorUnsupportedOSVersion,
+    /**
+     * You are trying to use a FLICButton object that has already been forgotten by the manager. Please discard of your references to this object.
+     */
+    FLICErrorAlreadyForgotten,
+};
+
+/*!
+ *  @enum FLICButtonState
+ *
+ *  @discussion     The different states that a Flic can be in at any given time.
+ *
+ */
+typedef NS_ENUM(NSInteger, FLICButtonState)
+{
+    /**
+     * The Flic is currently disconnected and a pending connection is not set. The Flic will not connect again unless you manually call the connect method.
+     */
+    FLICButtonStateDisconnected = 0,
+    /**
+     * The Flic is currently disconnected, but a pending connection is set. The Flic will automatically connect again as soon as it becomes available.
+     */
+    FLICButtonStateConnecting,
+    /**
+     * The Flic currently has a bluetooth connection with the phone. This does not necessarily mean that it has been verified.
+     * Please listen for the isReady event, or read the isReady property, for that information
+     */
+    FLICButtonStateConnected,
+    /**
+     * The Flic is currently connected, but is attempting to disconnect. Typically this state will only occur for very short periods of time before either switching to
+     * the connecting or disconnected state again.
+     */
+    FLICButtonStateDisconnecting,
+};
+
+/*!
+ *  @enum FLICButtonTriggerMode
+ *
+ *  @discussion     The different trigger modes that you can configure the Flic button to use. Please make sure that you understand how these work.
+ *                  The choosen trigger mode will affect the latency on the press events coming from the Flic button.
+ *
+ */
+typedef NS_ENUM(NSInteger, FLICButtonTriggerMode)
+{
+    /**
+     * Used to distinguish between only click and hold.
+     *
+     * Click will be fired when the button is released if it was pressed for maximum 1 second.
+     * Otherwise, hold will be fired 1 second after the button was pressed. Click will then not be fired upon release.
+     * Since this option will only distinguish between click and hold it does not have to take double click into consideration.
+     * This means that the click event can be sent immediately on button release rather than to wait for a possible double click.
+     *
+     * Note: this will be the default behavior.
+     */
+    FLICButtonTriggerModeClickAndHold = 0,
+    /**
+     * Used to distinguish between only single click and double click.
+     *
+     * Double click will be registered if the time between two button down events was at most 0.5 seconds.
+     * The double click event will then be fired upon button release.
+     *
+     * If the time was more than 0.5 seconds, a single click event will be fired; either directly upon button release if the button was down
+     * for more than 0.5 seconds, or after 0.5 seconds if the button was down for less than 0.5 seconds.
+     */
+    FLICButtonTriggerModeClickAndDoubleClick,
+    /**
+     * Used to distinguish between single click, double click and hold.
+     *
+     * If the time between the first button down and button up event was more than 1 second, a hold event will be fired.
+     * Else, double click will be fired if the time between two button down events was at most 0.5 seconds.
+     * The double click event will then be fired upon button release.
+     *
+     * If the time was more than 0.5 seconds, a single click event will be fired; either directly upon button release if the button was down
+     * for more than 0.5 seconds, or after 0.5 seconds if the button was down for less than 0.5 seconds.
+     *
+     * Note: Three fast consecutive clicks means one double click and then one single click. Four fast consecutive clicks means two double clicks.
+     */
+    FLICButtonTriggerModeClickAndDoubleClickAndHold,
+    /**
+     * This mode will only send click and the event will be sent directly on buttonDown.
+     * This will be the same as listening for buttonDown.
+     *
+     * Note: This is optimal if your application requires the lowest latency possible.
+     */
+    FLICButtonTriggerModeClick,
+};
+
+/*!
+ *  @enum FLICButtonTriggerMode
+ *
+ *  @discussion     The different latency modes that you can configure the Flic button to use.
+ *
+ */
+typedef NS_ENUM(NSInteger, FLICLatencyMode)
+{
+    /**
+     * This is the default mode of the button. It will give you a good compromise between click latency (less than 105 ms while connected) and current consumption.
+     */
+    FLICLatencyModeNormal = 0,
+    /**
+     * Using this mode will give your button the lowest possible click latency (typicaly less than 30 ms while connected).
+     * This mode will significantly increase the current consumption.
+     */
+    FLICLatencyModeLow,
+};
+
+#endif /* FLICEnums_h */