Skip to content

Commit

Permalink
Commit of version 0.7.1 - Please see changelog for more info.
Browse files Browse the repository at this point in the history
  • Loading branch information
AntonMeier committed Oct 7, 2015
1 parent 63bca81 commit 25a1adb
Show file tree
Hide file tree
Showing 5 changed files with 30 additions and 35 deletions.
8 changes: 8 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,11 @@
#fliclib-ios 0.7.1

**Changes**

* Stability improvements.
* Passive mode removed, use ActiveKeepAlive for those use-cases instead.
* Updated Documentation.

#fliclib-ios 0.6.7

**Changes**
Expand Down
40 changes: 14 additions & 26 deletions fliclib.framework/Headers/SCLFlicButton.h
Original file line number Diff line number Diff line change
Expand Up @@ -59,8 +59,8 @@ typedef NS_ENUM(NSInteger, SCLFlicButtonMode) {
* This mode is very similar to Active mode with the difference that the connection will re-establish whenever flic is brought back within
* range of the iOS device after being away for a longer period of time. This will be the case on all scenarios except when the button has
* been manually disconnected using the <code>disconnect</code> method. This mode is particularily useful when you want to have a seamless
* persistent user experience with lower latency than on the passive mode (described below). This mode will unfortunately consume more energy
* since it requires that flic advertises during longer periods of time. Keep this in mind when developing your app.
* persistent user experience with reasonably low latency. This mode will unfortunately consume more energy since it requires that flic
* advertises during longer periods of time. Keep this in mind when developing your app.
*/
SCLFlicButtonModeActiveKeepAlive = 1,
/**
Expand All @@ -69,13 +69,6 @@ typedef NS_ENUM(NSInteger, SCLFlicButtonMode) {
* any other mode so use with caution.
*/
SCLFlicButtonModeSuperActive = 2,
/**
* Flic will be in a passive state for most of the time. It will only connect to the iOS device and send data whenever a button press
* has been made. This is the most energy conservative mode, but may have a negative effect on response time. This is the recommended mode
* for all applications where latency is not an issue.
*
*/
SCLFlicButtonModePassive = 3,
};

/*!
Expand Down Expand Up @@ -307,8 +300,8 @@ typedef NS_ENUM(NSInteger, SCLFlicError) {
/*!
* @method connect:
*
* @discussion Attempts to connect the flic. If the flic is not available, due to either being out of range or being in passive
* mode, then the flic will be connected once it becomes available since this call will not time out, also called a
* @discussion Attempts to connect the flic. If the flic is not available, due to either being out of range or not advertising,
* then the flic will be connected once it becomes available since this call will not time out, also called a
* pending connection. It can be canceled by calling the <code>disconnect</code> method.
*
*/
Expand Down Expand Up @@ -336,12 +329,12 @@ typedef NS_ENUM(NSInteger, SCLFlicError) {
* @method setMode:
*
* @discussion This method is the method to call when you wish to switch between the different available modes for the flic.
* If the flic is not available, meaning that it is not connected to the iOS device, due to either being in a passive
* mode or out of proximity then the mode will not change instantly. The mode will instead change once the flic becomes
* If the flic is not available, meaning that it is not connected to the iOS device, due to either being manually disconnected
* or being out of proximity, then the mode will not change instantly. The mode will instead change once the flic becomes
* available the next time and only then will the mode property be updated accordingly. However, if you change the mode
* while the flic is disconnected and not having a pending connection to it, then you need to actively call the
* <code>connect:</code> method in order for it to connect. This is unless you are using a <i>KeepAlive</i> or <i>Passive</i>
* mode, in which case a <code>connect</code> will be sent automatically.
* <code>connect:</code> method in order for it to connect. This is unless you are using the <i>KeepAlive</i> mode,
* in which case a <code>connect</code> will be sent automatically.
*
* @param mode The mode that you wish to switch to.
*
Expand Down Expand Up @@ -378,8 +371,7 @@ typedef NS_ENUM(NSInteger, SCLFlicError) {
*
* @param button The SCLFlicButton object that the event came from.
* @param queued This lets you know if the event is a queued event that happened before the flic connected or if it is a real time
* event. Keep in mind that this parameter will most likely be <code>YES</code> if the flic is in passive mode since
* the flic will in that mode connect and disconnect on every button press.
* event.
* @param age The age of the trigger event in seconds. This is particularily important when receiving events that might have been
* queued up on flic while it was out of range. The units is in seconds and will be rounded to the nearest second.
*
Expand All @@ -393,8 +385,7 @@ typedef NS_ENUM(NSInteger, SCLFlicError) {
*
* @param button The SCLFlicButton object that the event came from.
* @param queued This lets you know if the event is a queued event that happened before the flic connected or if it is a real time
* event. Keep in mind that this parameter will most likely be <code>YES</code> if the flic is in passive mode since
* the flic will in that mode connect and disconnect on every button press.
* event.
* @param age The age of the trigger event in seconds. This is particularily important when receiving events that might have been
* queued up on flic while it was out of range. The units is in seconds and will be rounded to the nearest second.
*
Expand All @@ -408,8 +399,7 @@ typedef NS_ENUM(NSInteger, SCLFlicError) {
*
* @param button The SCLFlicButton object that the event came from.
* @param queued This lets you know if the event is a queued event that happened before the flic connected or if it is a real time
* event. Keep in mind that this parameter will most likely be <code>YES</code> if the flic is in passive mode since
* the flic will in that mode connect and disconnect on every button press.
* event.
* @param age The age of the trigger event in seconds. This is particularily important when receiving events that might have been
* queued up on flic while it was out of range. The units is in seconds and will be rounded to the nearest second.
*
Expand All @@ -424,8 +414,7 @@ typedef NS_ENUM(NSInteger, SCLFlicError) {
*
* @param button The SCLFlicButton object that the event came from.
* @param queued This lets you know if the event is a queued event that happened before the flic connected or if it is a real time
* event. Keep in mind that this parameter will most likely be <code>YES</code> if the flic is in passive mode since
* the flic will in that mode connect and disconnect on every button press.
* event.
* @param age The age of the trigger event in seconds. This is particularily important when receiving events that might have been
* queued up on flic while it was out of range. The units is in seconds and will be rounded to the nearest second.
*
Expand All @@ -440,8 +429,7 @@ typedef NS_ENUM(NSInteger, SCLFlicError) {
*
* @param button The SCLFlicButton object that the event came from.
* @param queued This lets you know if the event is a queued event that happened before the flic connected or if it is a real time
* event. Keep in mind that this parameter will most likely be <code>YES</code> if the flic is in passive mode since
* the flic will in that mode connect and disconnect on every button press.
* event.
* @param age The age of the trigger event in seconds. This is particularily important when receiving events that might have been
* queued up on flic while it was out of range. The units is in seconds and will be rounded to the nearest second.
*
Expand Down Expand Up @@ -497,7 +485,7 @@ typedef NS_ENUM(NSInteger, SCLFlicError) {
* @discussion The requested connection failed. Please note that depending on at what point in the connection process the connection
* failed you might also receive a regular flicButtonDidDisconnect: as well. If the connection fails and this callback is
* made then the flic will always cancel the pending connection, regardless of what mode the flic happens to be in.
* This means that if you get a <code>flicButton:didFailToConnectWithError:</code> event and the flic is in passive mode then you
* This means that if you get a <code>flicButton:didFailToConnectWithError:</code> event and the flic is in KeepAlive mode then you
* need to call the <code>connect:</code> yourself to activate the pending connection once again.
*
*/
Expand Down
9 changes: 4 additions & 5 deletions fliclib.framework/Headers/SCLFlicManager.h
Original file line number Diff line number Diff line change
Expand Up @@ -156,8 +156,8 @@ typedef NS_ENUM(NSInteger, SCLFlicManagerBluetoothState) {
* @method enable
*
* @discussion This will enable the bluetooth communication after it has previously been disabled. It will not however reconnect any buttons,
* that will have to be handled manually. This is unless you have the flic(s) configured to be in either <i>Passive</i> mode or
* <i>KeepAlive</i> mode, in which case the connect will automatically be sent.
* that will have to be handled manually. This is unless you have the flic(s) configured to be in <i>KeepAlive</i> mode,
* in which case the connect will automatically be sent.
*
*/
- (void) enable;
Expand Down Expand Up @@ -189,9 +189,8 @@ typedef NS_ENUM(NSInteger, SCLFlicManagerBluetoothState) {
/*!
* @protocol SCLFlicManagerDelegate
*
* @discussion The delegate of a SCLFlicManager instance must adopt the <code>SCLFlicManagerDelegate</code> protocol. There is one
* required delegate methods, flicManager:DidDiscoverButton:withRSSI: and flicManagerDidChangeBluetoothState, and two
* optional flicManagerDidRestoreState (highly recommended) and flicManager:didForgetButton:error.
* @discussion The delegate of a SCLFlicManager instance must adopt the <code>SCLFlicManagerDelegate</code> protocol. There are no
* required delegate methods, but flicManagerDidChangeBluetoothState is highly recommended.
*
*/
@protocol SCLFlicManagerDelegate <NSObject>
Expand Down
8 changes: 4 additions & 4 deletions fliclib.framework/_CodeSignature/CodeResources
Original file line number Diff line number Diff line change
Expand Up @@ -6,11 +6,11 @@
<dict>
<key>Headers/SCLFlicButton.h</key>
<data>
27Oc/wutVc0JJ4XB9lttupVgjXM=
GWePKBynFOqJMKDStNalSGAN3Dg=
</data>
<key>Headers/SCLFlicManager.h</key>
<data>
QnS8dgMVi0vdWRi8E8LaWxpwWY0=
TBtNKEHR6zNa/OI2YZi8HqCgSQo=
</data>
<key>Headers/fliclib.h</key>
<data>
Expand All @@ -29,11 +29,11 @@
<dict>
<key>Headers/SCLFlicButton.h</key>
<data>
27Oc/wutVc0JJ4XB9lttupVgjXM=
GWePKBynFOqJMKDStNalSGAN3Dg=
</data>
<key>Headers/SCLFlicManager.h</key>
<data>
QnS8dgMVi0vdWRi8E8LaWxpwWY0=
TBtNKEHR6zNa/OI2YZi8HqCgSQo=
</data>
<key>Headers/fliclib.h</key>
<data>
Expand Down
Binary file modified fliclib.framework/fliclib
Binary file not shown.

0 comments on commit 25a1adb

Please sign in to comment.