A turn-key middleware layer for Flomio's line of NFC, BLE, and UHF RFID readers.
Contributors: grundyoso, bpolania, jchuck627, jdisser, scottire
Tags: FloJackBzr, FloJackMsr, FloBle, FloMat, NFC, BLE, RFID
Requires at least: iOS 9.0
Tested up to: iOS 9.0
Stable tag: 2.1 (1)
Flomio builds hardware and software solutions in the proximity ID space. With a focus on mobile platforms, Flomio makes it easy to integrate our readers into Apps for iOS, Android, and WindowsPhone.
-
Unzip FlomioSDK.zip.
-
Create new or open your iOS project in Xcode and select the root project file from the navigator.
-
Unzip FlomioSDK folder Drag+drop the "iOS" folder on project in Xcode navigator. Make sure the "Copy items if needed" option is selected and click "Create groups" and "Finish" in dialog.
-
In Targets -> YourAppTarget -> Build Settings -> Linking -> Other Linker Flags add ‘-lc++’ and ’-ObjC’ In Targets -> YourAppTarget -> Build Options -> Enable Bitcode set to ‘No’ (optional) In Target-> Build Settings-> Apple LLVM 7.0-Preprocessing -> Preprocessor Macros add ‘DEBUGLOG’ In Targets -> YourAppTarget -> General -> Link Binary with Libraries, add MediaPlayer.Framework
-
Add a bridge header file: File -> New > File... > Header File and name it ViewController-Bridging-Header.h
-
In Targets -> YourAppTarget -> Build Obtions -> Swift Compiler - General -> Objective-C Bridging Header, add ViewController-Bridging-Header.h
-
In ViewController-Bridging-Header.h, import the FlomioSDK header file
#import "FmSessionManager.h" -
In your ViewController.swift, add FmSessionManagerDelegate
class ViewController: UIViewController, FmSessionManagerDelegate
and instantiate the FmSessionManager in viewDidLoad:
let readerManager : FmSessionManager = FmSessionManager()
readerManager.selectedDeviceType = DeviceType.floBlePlus
//flojackBzr, flojackMsr, flojack
readerManager.specificDeviceId = nil;
//"RR330-000120" use device id from back of device to only connect to specific device
// only for use when "Allow Multiconnect" = false
readerManager.delegate = self
let configurationDictionary : [String : Any] =
["Scan Sound" : 1,
"Scan Period" : 1000,
"Reader State" : ReaderStateType.readUuid.rawValue, //readData for NDEF
"Power Operation" : PowerOperation.autoPollingControl.rawValue, //bluetoothConnectionControl low power usage
"Allow Multiconnect" : false]
readerManager.setConfiguration(configurationDictionary)
readerManager.createReaders()
```
9. Observe notifications to manage reader for background/foreground in `viewDidLoad:`
```swift
NotificationCenter.default.addObserver(
self,
selector: #selector(inactive),
name: NSNotification.Name.UIApplicationDidEnterBackground,
object: nil)
NotificationCenter.default.addObserver(
self,
selector: #selector(active),
name: NSNotification.Name.UIApplicationDidBecomeActive,
object: nil)
- Create ReaderManagerDelegate methods to catch reader events
func inactive() {
print("App Inactive")
}
func active() {
print("App Activated")
}
func didFindTag(withUuid Uuid: String!, fromDevice deviceId: String!, withAtr Atr: String!, withError error: Error!) {
DispatchQueue.main.async {
if let thisUuid = Uuid, let thisDeviceId = deviceId {
print("Did find UUID: \(thisUuid) from Device: \(thisDeviceId)")
} else {
print(error)
}
}
}
func didFindTag(withData payload: [AnyHashable : Any]!, fromDevice deviceId: String!, withAtr Atr: String!, withError error: Error!) {
DispatchQueue.main.async {
let thisDeviceId = deviceId
if let thisPayload = payload["Raw Data"] {
print("Did find payload: \(thisPayload) from Device: \(thisDeviceId)")
} else if let ndef = payload["Ndef"] {
print("Did find payload: \(ndef) from Device: \(thisDeviceId)")
}
}
}
func didUpdateConnectedDevices(_ devices: [Any]!) {
//The list of connected devices was updated
}
func didChange(_ status: CardStatus, fromDevice device: String!) {
DispatchQueue.main.async {
//The card status has entered or left the scan range of the reader
// Cardstatus:
// 0:CardStatus.notPresent
// 1:CardStatus.present
// 2:CardStatus.readingData
}
}
func didReceiveReaderError(_ error: Error!) {
DispatchQueue.main.async {
print("Error: \(error)")
}
}-
For FloBLE Plus v1.16.03 firmware, to control power modes Use Power Operation to control how readerManager.startReader(deviceId); and readerManager.stopReader(deviceId); control your reader. use autoPollingControl to toggle NFC use bluetoothConnectionControl to toggle Bluetooth connection
-
That's it. Now build, run, and observe scans in the console!
Need to add management for reading of extensive data blocks. Currently limited to 16 bytes read at a time. Data throughput limitation may have an impact on user experience.
Q: Can the SDK run in the background?
A: We don't expect Apps to ever be able operate FloJacks in the background. The FloJack requires a heartbeat handshake in order to prevent it from going into sleep mode and it's not possible to handle from background. The active/inactive methods in the ViewController are meant to wake/sleep the reader during foregounding/backgrounding. The FloBLE products are able to operate from a backgrounded app state. Also several of the same FloBLE products can connect to the iOS device at once (max 7 connected FloBLEs at a time).
Q: I get *** Terminating app due to uncaught exception 'NSInvalidArgumentException', reason: '*** -[NSURL initFileURLWithPath:]: nil string parameter' when running my app. What's the problem?
A: You seem to have only partially imported the FlomioSDK. There are needed resources in the SDK package that will not allow the it to run otherwise. These include, but limmited to, ScanSound.caf, FloJackConnected150x150.png, and FloJackDisconnected150x150.png. Check to make sure those resources are in your project and added to your Build Bundle (look in Target->Build Phases->Copy Bundle Resources).
Q: My FloJack is not responding when I start the Demo App, I see a red communication indicator and no battery level. A: To troubleshoot this first check that the FloJack is fully seated in the mobile device. Push the reader into the jack firmly. Next be sure you have selected FloJack on the start menu. Next check for a green light on the reader. If 10 seconds after you've started the app there is still no green light and the communications indicator is still red try plugging the charging cable connected to a USB port into the flojack. You should see the light turn amber and the communication indicator turn green along with a battery level of 100% (indicating charging) within 45 seconds, indicating the app is running normally and communicating with the FloJack.
Q: I selected FloBLE Plus and tags are not detected. What am I doing wrong?
A: We recently added support for FloBLE readers and need to update the SDK interface to account for starting the scan engine for them. For now you can just add [sharedManager.reader startScan]; to your viewDidLoad: routine.
- Improved support for NDEF tags
- Added parsing of Smart Poster formatted NDEF tags
- Added manual configuration for each reader to either read data or UUID
- Added dedicated NdefMessage & NdefRecord objects
- Added options for configuring power usage with FloBLE Plus
- Refactored SDK.
- Simplified delegate methods.
- Improved support for multiconnectivity
- Added error management for developers
- Added ability to send APDUs with BZR
- Added Flojack BZR support.
- Communication Status report. Query to SDK provides communication status to FloJack reader.
- Battery Level report. Query to SDK provides FloJack battery level. This is most often 100% given that Lithium polymer batteries fail rapidly once the reach their capacity limits. Full charge will provide 5.25hrs (6,345 scans) while 20secs of charge will provide 4.5mins (108 scans). It's a nonlinear relationship.
- We ensured that the new Communication Status and Battery Level Events were being reported as delegate methods that are called when the events occur. These are now required for the SDK consumer to implement even if not being used:
-
- (void)ReaderManager:(Reader *)reader didSendBatteryLevel:(int)level
-
- (void)ReaderManager:(Reader *)reader isConnected:(BOOL)connected
-
- Read/Write Data Blocks now working as in v1.6. didFindDataBlocks API changed to return NSData vs NSString:
-
- (void)didFindDataBlocks:(NSData *)data fromDevice:(NSString *)deviceId
-
- Auto-reestablishment of communication between Host device and Reader
- Removes excessive debug info from console log. To regain SDK debug output add "DEBUGLOG" to preprocessor macros (step 4)
- Corrected device UUID retrieved from FloBLE Plus and EMV deviced
- UI fixes for the Flomio SDK Sample app, navigation "Back" removed and SDK cleanup implemented (invalidate timers, etc)
- SDK delegate refactoring to expose deviceID. Requires update to new delegate signature:
-
- (void)didFindATag:(Tag *)tag withOperationState:(ReaderStateType)operationState fromDevice:(NSString *)deviceId withError:(NSError *)error {
-
- Adds in support for FloBLE Plus and EMV readers.
- Support for multiconnect to FloBLE devices add for Plus and EMV types. These are not interchangeable, can only connect to groups of the same type.
- Adds multi-connect FloBLE Mini functionality such that many iOS to FloBLE connections can be made (max is 1:7)
- Adds FloBLE Mini device UUID support so that each NFC tag can be associated to a particular reader (supported in FloJack)
- Added FloBLE functionality
- Some unused frameworks (most notably Parse) were removed
- UUID Delegate method enabled
- Switches for FloJack and FloBLE ON/OFF
- Added missing Parse libraries and support frameworks
- Removed i386 libraries as I couldn't archive all Parse supporting libraries (no i386 support)
- Cleaned up the README.md to clean up some bugs introduced in last version.
- Adds instructions to properly suspend and reset the Reader from within your App.
- Inlcudes i386 and ARM libraries in the SDK bundle in order to support building for emulator.
- Note: FloJack operations won't function in the emulator.
- Fixes several bugs, most notably the issue of the app crashing after backgrounding.
- Moves all the error codes into the library and issues a standard NSError object.
- Adds device ID check for SDK licensing.
- Adds NTAG203 support to the NDEF parser.
- Some minor refactoring of the SDK APIs to make more understandable.
- Added tag type filtering
- Added Start Block configuration to Read operation state.
- Created README.md to explain how to install and build the Flomio SDK
- Cleaned up code, bundled the headers and archived source into library
- Support for NDEF messages and records.
- Adds scanPeriod support to the SDK app.
- Adds start block and block count to getNfcData method.
- Adds code to init settings from ViewController
- Adds default scan sound. Fixes Ultralight read data blocks bug.
- Support for Mifare Ultralight along with Mifare Mini, Topaz, and Felica
- Updates to add read and write capability through hard coded strings.
- SDK test app includes Settings screen with all configuration entries: scanPeriod, scanSound, readUUID, readDataBlocks, and writeDataBlocks.
- Support for Mifare Classic uuid, authenticate, and read data blocks.
- SDK and test app to work with FloJack reader. audio routing, visual notifications, and UUID read all functional