BluIDSDK

Declaration

Swift

public func login(credentials: UserCredentials, onResponse callback: @escaping (BluIDSDKError?, UserData?) -> Void)

Parameters

`credentials`	`UserCredentials` Crendentials are username and password
`onResponse`	This callback is triggered when the BluSKY server responds to login Request.


                    
                    
                    refreshLogin(onResponse:)

refreshLogin function is used to keep the session alive for current logged in user.

Return:

Returns response with either error with BluIDSDKError or success with UserData.

Usage Example:

m_bluIDSDKClient.refreshLogin(onResponse: { (error, data) in
   print(error ?? "", data ?? "")
})

Possible Errors:

Declaration

Swift

public func refreshLogin(onResponse callback: @escaping (BluIDSDKError?, UserData?) -> Void)

Parameters


                                onResponse

This callback is triggered when the BluSKY server responds to login Request.


                    
                    
                    refreshIntegrator(integrator:)

Declaration

Swift

public func refreshIntegrator(integrator: String) -> BluIDSDKError?


                    
                    
                    registerUserDevice(firebaseToken:onResponse:)

When user is signing-in for the first time on their device, this function needs to be invoke, so that user’s device is registered with BluSKY server. This will enable BluB0X to send important updates to the user device via notification

firebaseToken : firebase token of the device on which SDK is running
onResponse : This callback is triggered when the BluSKY server responds to registerUserDevice Request.

Return:

Returns response with either error withBluIDSDKError or success response with MobileDeviceObject.

Usage Example:

m_bluIDSDKClient.registerUserDevice(firebaseToken: "firebaseToken",onResponse: { (error, data) in
   print(error ?? "", data ?? "")
 })

Possible Errors:

BluIDSDKError.serverUnauthorized

BluIDSDKError.error(error:)

Declaration

Swift

public func registerUserDevice(firebaseToken: String, onResponse callback: @escaping (BluIDSDKError?, MobileDeviceObject?) -> Void)


                    
                    
                    logout()

This function signs off the user from the their device and erases all the user cached content from their device.

Usage Example:

m_bluIDSDKClient.logout()

Declaration

Swift

public func logout()


                    
                    
                    startDeviceDiscovery(filter:onDeviceDiscovered:)

This function scans and returns nearby BluPOINT devices.

Return:

Returns a list of Device_Information for nearby BluPOINT devices.

Usage Example:

do{
   try? m_bluIDSDKClient.startDeviceDiscovery(filter:ScanFilter(signalStrength:-80,successiveCallbackFrequencyInMillis:3000),onDeviceDiscovered: { (data) in
   print(data)
   })
}

Possible Errors:

BluIDSDKError.bluetoothPowerOff

BluIDSDKError.bluetoothUnAuthorized

Declaration

Swift

public func startDeviceDiscovery(filter: ScanFilter?, onDeviceDiscovered callback: @escaping onDevicesDicovered) throws

Parameters

`filter`	This is a filter for scan callbacks, in terms for restricting successive callbacks and based on signal strength.
`onDeviceDiscovered`	This callback is triggered once the device is discovered.


                    
                    
                    startGestureBasedAuthentication()

This function allows SDK to start auto-detection of gesture and once user performs a gesture, SDK authenticates the closest nearby BluPOINT enabled door to unlock, based on PersonCard availablity with the user.

Note: This function has dependency on syncPersonCards API

Usage Example:

m_bluIDSDKClient.startGestureBasedAuthentication()

Declaration

Swift

public func startGestureBasedAuthentication()


                    
                    
                    stopGestureBasedAuthentication()

This function stops auto-detection of gesture.

Usage Example:

m_bluIDSDKClient.stopGestureBasedAuthentication()

Declaration

Swift

public func stopGestureBasedAuthentication()


                    
                    
                    saveUserPreference(setting:)

This function update user preferences for gesture based authentication

Usage Example:

let gestureSettings = UserPreferences(allowAccess: AllowAccessType.foreground , enableVibrate : false, enableTap:true, enableTwist:true, enableAppSpecific:false,
                      enableWave:false, enableRange: true, enableAI: false, enableAppleWatch: false, enableBluREMOTE:false, enhancedTap: true)

m_bluIDSDKClient.saveUserPreference(setting:gestureSettings)

Declaration

Swift

public func saveUserPreference(setting: UserPreferences)

Parameters


                                setting

Gesture Settings of type UserPreferences . Allow users to choose access type(Foreground,Background or Always) and enable any gesture based authentication.


                    
                    
                    getUserPreference()

This function update user preferences for gesture based authentication.

Return:

Returns gesture settings of typeUserPreferences which provides the setting for different gestures. If no setting is done by the user the default values are returned.

Usage Example:


let gestureSettings = m_bluIDSDKClient.getUserPreference()
print(gestureSettings)

Declaration

Swift

public func getUserPreference() -> UserPreferences


                    
                    
                    stopDeviceDiscovery()

This function stops ongoing device discovery

Usage Example:

m_bluIDSDKClient.stopDeviceDiscovery()

Declaration

Swift

public func stopDeviceDiscovery()


                    
                    
                    identifyDevice(withLED:onResponse:)

This function allow user to blink LED near by BluPOINT devices

Note: Device should be unlock before calling this function

Return:

Returns response with BluIDSDKError if any.

Usage Example:

let deviceLED = Device_LED(color: Device_LED_Color(red: 0, green: 0xff, blue: 0),onTimeInSeconds: UInt8(5))

m_bluIDSDKClient.identifyDevice(withLED:deviceLED,onResponse:{ (error)  in
   print(error ?? "")
})

Possible Errors:

Declaration

Swift

public func identifyDevice(withLED: Device_LED, onResponse: @escaping (BluIDSDKError?) -> Void)

Parameters

`withLED`	`Device_LED` is the colour and time to which the LED of the unlocked device is set.
`onResponse`	This callback is triggered when the device responds to the glow LED request.


                    
                    
                    identifyDevice(withBuzzerONInSeconds:onResponse:)

This function allow user to beep BluPONT device for given seconds

Note: Device should be unlock before calling this function

Return:

Returns response with BluIDSDKError if any.

Usage Example:

let buzzerONInSeconds = UInt8(5)
m_bluIDSDKClient.identifyDevice(withBuzzerONInSeconds:UInt8(buzzerONInSeconds),onResponse:{ (error)  in
   print(error ?? "")
})

Possible Errors:

Declaration

Swift

public func identifyDevice(withBuzzerONInSeconds: UInt8, onResponse: @escaping (BluIDSDKError?) -> Void)

Parameters

`withBuzzerOnInSeconds`	Time for which the buzzer is set ON.
`onResponse`	This callback is triggered when the device responds to the ring buzzer request.


                    
                    
                    identifyDevice(withBothLEDnBuzzerONInSeconds:onResponse:)

This function allows both blinking LED and beeping device for given seconds

Note: Device should be unlock before calling this function

Return:

Returns response with BluIDSDKError if any.

Usage Example:

let bothLEDnBuzzerONInSeconds = Device_LED(color: Device_LED_Color(red: 0, green: 0xff, blue: 0),onTimeInSeconds: UInt8(5))

m_bluIDSDKClient.identifyDevice(withBothLEDnBuzzerONInSeconds:bothLEDnBuzzerONInSeconds,onResponse:{ (error)  in
   print(error ?? "")
})

Possible Errors:

Declaration

Swift

public func identifyDevice(withBothLEDnBuzzerONInSeconds: Device_LED, onResponse: @escaping (BluIDSDKError?) -> Void)

Parameters

`timeInSeconds`	The time for which the LED of the unlocked device glows.
`callback`	This callback is triggered when the device responds to the glow LED and ring buzzer request.


                    
                    
                    lockDeviceAccess()

Disconnect and Locks the access of connected BluPOINT device

m_bluIDSDKClient.lockDeviceAccess()

Declaration

Swift

public func lockDeviceAccess()


                    
                    
                    getDeviceInformation(deviceID:callback:)

Gets firmware Version, Name, MAC address, Stack version and KeySet Id of the conncted BluPOINT device.

Return:

Returns response with either error withBluIDSDKError or success with device details of type Device_Details.

Usage Example:

let deviceID = "aaaa1111-bb22-cc33-dd44-eee555fff666"

m_bluIDSDKClient.getDeviceInformation(deviceID:deviceID,callback:{ (error,data)  in
   print(error ?? "", data ?? "")
})

Possible Errors:

Declaration

Swift

public func getDeviceInformation(deviceID: String, callback: @escaping (BluIDSDKError?, Device_Details?) -> Void)

Parameters

`deviceID`	Device ID of BluPOINT device to get the device information
`callback`	This callback is triggered when the device responds to the getDeviceInformation request.


                    
                    
                    getDeviceInformation(callback:)

Gets firmware Version, Name, MAC address, Stack version and KeySet Id of the conncted BluPOINT device.

Return:

Returns response with either error withBluIDSDKError or success with device details of type Device_Details.

Usage Example:

m_bluIDSDKClient.getDeviceInformation(callback:{ (error,data)  in
   print(error ?? "", data ?? "")
})

Possible Errors:

Declaration

Swift

public func getDeviceInformation(callback: @escaping (BluIDSDKError?, Device_Details?) -> Void)

Parameters


                                callback

This callback is triggered when the device responds to the getDeviceInformation request.


                    
                    
                    getDeviceFirmwareVersion(callback:)

Gets current firmware version of the connected BluPOINT device

Note: Device should be unlock before calling this function

Return:

Returns response with either BluIDSDKError or success with firmware version of type String.

Usage Example:


m_bluIDSDKClient.getDeviceFirmwareVersion(callback:{ (error,data)  in
   print(error ?? "", data ?? "")
})

Possible Errors:

BluIDSDKError.deleteFailed

Declaration

Swift

public func getDeviceFirmwareVersion(callback: @escaping (BluIDSDKError?, String?) -> Void)

Parameters


                                callback

This callback is triggered when the device responds to the get the device firmware version request.


                    
                    
                    listAvailableFirmwareVersions(onResponse:)

Returns list of available firmware version in BluSKY Server.

Note: It has dependency on login API

Return:

Returns response with list of available firmwares in BluSKY server of type Device_Firmware.

Usage Example:


m_bluIDSDKClient.listAvailableFirmwareVersions(onResponse:{ (data)  in
   print(data ?? "")
})

Declaration

Swift

public func listAvailableFirmwareVersions(onResponse callback: @escaping (([Device_Firmware]?) -> Void))

Parameters


                                onResponse

This callback is triggered when the BluSKY server responds to get list of available firmware request.


                    
                    
                    removeFirmwareFromUserDevice(versions:)

Deletes firmware list from user device.

Return:

Returns response with a array of version with it’s corresponding error if any.

Usage Example:

var versions = ["0.00.35","0.00.36"]
let response = m_bluIDSDKClient.removeFirmwareFromUserDevice(versions:versions)
print(response)

Possible Errors:

Declaration

Swift

public func removeFirmwareFromUserDevice(versions: [String]) -> [String : BluIDSDKError?]

Parameters


                                versions

A list of firmware versions to be deleted.


                    
                    
                    transferCredential(deviceID:onResponse:)

The function is used to authenticate whether the user is allowed at that BluPOINT device.

Return:

Returns response with either BluIDSDKError if any.

Usage Example:

m_bluIDSDKClient.transferCredential(deviceID:"aaaa1111-bb22-cc33-dd44-eee555fff666",onResponse:{ (error)  in
  print(error ?? "")
})

Possible Errors:

Declaration

Swift

public func transferCredential(deviceID: String, onResponse callback: @escaping (BluIDSDKError?) -> Void)

Parameters

`deviceID`	Device ID of unlocked BluPOINT device.
`onResponse`	This callback is triggered when the device responds to the transfer credentials request.


                    
                    
                    syncPersonCards(onComplete:)

Gets person cards from BluSKY Server and saves it to user device

Note: It has dependency on login API

Return:

Returns response with either BluIDSDKError or success response with list of PersonCardDetails.

Usage Example:

m_bluIDSDKClient.syncPersonCards(onComplete:{ (error,data)  in
   print(error ?? "",data ?? "")
})

Possible Errors:

Declaration

Swift

public func syncPersonCards(onComplete callback: @escaping (BluIDSDKError?, [PersonCardDetails]?) -> Void)

Parameters


                                onComplete

This callback is triggered when the BluSKY server responds to the syncPersonCards Request.


                    
                    
                    syncPersonCardsByID(userID:filter:onComplete:)

Gets person cards for given User ID from BluSKY Server and saves it to user device

Note: It has dependency on login API

Return:

Returns response with either BluIDSDKError or success response with list of PersonCardDetails.

Usage Example:

var userID = "1234abcd-5678-910e-80f3-d6712de9a4db"

m_bluIDSDKClient.syncPersonCardsByID(userID : userID,filter: .BluB0XMobile,onComplete:{ (error,data)  in
   print(error ?? "",data ?? "")
})

Possible Errors:

BluIDSDKError.serverUnauthorized

Declaration

Swift

public func syncPersonCardsByID(userID: String, filter: CredentialType?, onComplete callback: @escaping (BluIDSDKError?, [PersonCardDetails]?) -> Void)

Parameters

`userID`	Unique identifier of a user assigned by BluB0x.
`filter`	`CredentialType`
`onComplete`	This callback is triggered when the BluSKY server responds to the syncPersonCardsByID Request.


                    
                    
                    getPersonCardsOffline()

Returns all person cards available in user device.

Return:

Returns response with list of PersonCardDetails.

Usage Example:

let response = m_bluIDSDKClient.getPersonCardsOffline()
print(response)

Declaration

Swift

public func getPersonCardsOffline() -> [PersonCardDetails]


                    
                    
                    downloadFirmware(versions:onResponse:)

Downloads given firmware versions from BluSKY server.

Note: It has dependency on login API

Return:

Returns response with array of firmware version and its corresponsing BluIDSDKError if any.

Usage Example:

do{
   try? m_bluIDSDKClient.downloadFirmware(versions:["0.00.36","0.00.35"],onResponse:{ (data)  in
       print(data)
   })
}

Possible Errors:

BluIDSDKError.downloadFailed(message:)

BluIDSDKError.error(error:)

Declaration

Swift

public func downloadFirmware(versions: [String], onResponse callback: @escaping ([String : BluIDSDKError?]) -> Void) throws

Parameters

`versions`	A list of firmware Versions that are to be downloaded
`onComplete`	This callback is triggered when the BluSKY server responds to the download firmware request.


                    
                    
                    downloadFirmware(version:onComplete:)

Downloads given firmware version from BluSKY server

Note: It has dependency on login API

Return:

Returns response with BluIDSDKError if any.

Usage Example:

m_bluIDSDKClient.downloadFirmware(version:"0.00.36",onComplete:{ (error)  in
       print(error ?? "")
   })

Possible Errors:

BluIDSDKError.serverUnauthorized

BluIDSDKError.downloadFailed(message:)

BluIDSDKError.error(error: error)

Declaration

Swift

public func downloadFirmware(version: String, onComplete callback: @escaping ((BluIDSDKError?) -> Void))

Parameters

`version`	Version denotes the firmware version that is to be downloaded
`onComplete`	This callback is triggered when the BluSKY server responds to the download firmware request.


                    
                    
                    rebootDevice(afterSeconds:onDisconnect:)

Reboots connectd BluPOINT device after given seconds.

Note: Device should be unlock before calling this function

Return:

Returns response with either BluIDSDKError or success response with String set to nil.

Usage Example:

let afterSeconds: UInt8 = 3
m_bluIDSDKClient.rebootDevice(afterSeconds:afterSeconds,onDisconnect:{ (error,data)  in
   print(error ?? "",data ?? "")
})

Possible Errors:

Declaration

Swift

public func rebootDevice(afterSeconds: UInt8?, onDisconnect callback: @escaping (BluIDSDKError?, String?) -> Void)

Parameters

`afterSeconds`	Delay in seconds to perform reboot of BluPOINT device
`onDisconnect`	This callback is triggered when the device gets disconnected.


                    
                    
                    updateSingleDeviceFirmware(version:onUpdateComplete:progressHandler:)

This function update’s device firmware.

Note: Device should be unlock before calling this function

Return:

Returns response with either BluIDSDKError or success response with Boolean which denotes whether the device is connected or not.

Usage Example:

m_bluIDSDKClient.updateSingleDeviceFirmware(version:"0.00.36",onUpdateComplete:{ (error,data)  in
   print(error ?? "",data ?? "")
}, progressHandler : {(percent) in
       print(percent)
})

Possible Errors:

BluIDSDKError.firmwareUpdateFailed(errorMessage)

Declaration

Swift

public func updateSingleDeviceFirmware(version: String, onUpdateComplete callback: @escaping ((BluIDSDKError?, Bool?) -> Void), progressHandler: @escaping ((Int) -> Void))

Parameters

`version`	Firmware version to which the firmware needs to be upgraded.
`onUpdateComplete`	This callback is triggered when the firmware upgrade is complete.
`progressHandler`	The callback which checks the progress of the upgrade process and takes actions accordingly


                    
                    
                    updateMultipleDeviceFirmware(deviceIDs:firmwareVersion:onUpdateComplete:progressHandler:)

This function update’s multiple BluPOINT device’s firmware to a given firmware version.

Return:

Returns response with a array of deviceId of type String and its corresponding BluIDSDKError if any.

Usage Example:

m_bluIDSDKClient.updateMultipleDeviceFirmware(deviceIDs:["aaaa1111-bb22-cc33-dd44-eee555fff666","aaaa1111-bb22-cc33-dd44-eee555fff777"],firmwareVersion: "0.00.36",onUpdateComplete:{ (data)  in
       print(data)
}, progressHandler : {(deviceID,percent,error) in
    print(deviceID , percent ?? "" , error ?? "")
})

Possible Errors:

BluIDSDKError.firmwareUpdateFailed(errorMessage)

Declaration

Swift

public func updateMultipleDeviceFirmware(deviceIDs: [String], firmwareVersion: String, onUpdateComplete callback: @escaping (([String : BluIDSDKError?]) -> Void), progressHandler: @escaping (String, Int?, BluIDSDKError?) -> Void)

Parameters

`deviceList`	List of device IDs of BluPOINT devices whose firmware are to be upgraded.
`version`	The firmware version to which the devices will be upgraded.
`onUpdateComplete`	This callback is triggered when the upgradation process is completed.
`progressHandler`	The callback which checks the progress of the upgrade process and takes actions accordingly. It returns the deviceID with its progress percent Int and `BluIDSDKError` if any.


                    
                    
                    getDeviceMode()

Returns device mode of a selected BluPOINT device, device modes are BluPOINT and BluBOOT

Return:

Returns response with DeviceMode giving whether the device is in BluPOINTMode or blubootMode.

Usage Example:

let response = m_bluIDSDKClient.getDeviceMode()
print(response)

Declaration

Swift

public func getDeviceMode() -> DeviceMode


                    
                    
                    getBLETxPowerLevel(callback:)

Return BLE Tx power of connected BluPOINT device.

Note: Device should be unlock before calling this function.

Return:

Returns response with either BluIDSDKError or transmission power UInt8.

Usage Example:

m_bluIDSDKClient.getBLETxPowerLevel(callback:{ (error,data)  in
   print(error ?? "",data ?? "")
})

Possible Errors:

Declaration

Swift

public func getBLETxPowerLevel(callback: @escaping (BluIDSDKError?, UInt8?) -> Void)

Parameters


                                callback

This callback is triggered when the device responds to getBLETxPowerLevel request.


                    
                    
                    updateDeviceBLETxPowerLevel(strength:callback:)

Sets BLE Tx power of connected BluPOINT device, this will advertis all packets and data packets with this power level

Note: Device should be unlock before calling this function

Return:

Returns response with either BluIDSDKError or success with transmission power UInt8.

Usage Example:

let strength: UInt8 = 3
m_bluIDSDKClient.updateDeviceBLETxPowerLevel(strength: strength,callback:{ (error,data)  in
   print(error ?? "",data ?? "")
})

Possible Errors:

BluIDSDKError.deviceInBluboot

Declaration

Swift

public func updateDeviceBLETxPowerLevel(strength: UInt8, callback: @escaping (BluIDSDKError?, UInt8?) -> Void)

Parameters

`strength`	The strength to be set for the BluPOINT device.
`callback`	This callback is triggered when the device responds to updateDeviceBLETxPowerLevel request.


                    
                    
                    unlockDeviceAccess(deviceID:onResponse:onDisconnect:)

This function will unlock restricted access to BluPOINT device and allow user to tweak BluPOINT device settings such as, name, LED color, Tx Power, Gesture Settings etc and Upgrade device firmware.

Note: It has dependency on login API

Return:

Returns response with either BluIDSDKError or success with unlock validity time of type Int64.

Usage Example:

m_bluIDSDKClient.unlockDeviceAccess(deviceID: "aaaa1111-bb22-cc33-dd44-eee555fff666",onResponse:{ (error,data)  in
   print(error ?? "",data ?? "")
   }, onDisconnect: { (data1) in
       print(data1)
   })

Possible Errors:

Declaration

Swift

public func unlockDeviceAccess(deviceID: String, onResponse callback: @escaping (BluIDSDKError?, Int64?) -> Void, onDisconnect disconnectCb: ((String) -> Void)?)

Parameters

`deviceID`	Device ID of BluPOINT device to unlock.
`onResponse`	This callback is triggered once the device responds to the unlock request.
`onDisconnect`	This callback is triggered when the device gets disconnected.


                    
                    
                    updateDeviceKeys(key:callback:)

Set encryption keys of the connected device, encryption key is use to validate the credentials.

Return:

Returns response with BluIDSDKError if any else with nil.

Usage Example:

m_bluIDSDKClient.updateDeviceKeys(key: "144 bytes key",callback:{ (error)  in
   print(error ?? "")
})

Possible Errors:

Declaration

Swift

public func updateDeviceKeys(key: String, callback: @escaping (BluIDSDKError?) -> Void)

Parameters

`key`	The value of the new device keys for the BluPOINT device.
`onResponse`	This callback is triggered when the device responds to updateDeviceKeys request.


                    
                    
                    getAccessLogs()

Gets list of all requests to BluPONT device to access door.

Return:

Returns response with list of access logs of type AccessLogItem.

Usage Example:

let response = m_bluIDSDKClient.getAccessLogs()
   print(response)

Declaration

Swift

public func getAccessLogs() -> [AccessLogItem]?


                    
                    
                    getDiagnosticInfo(callback:)

Gets user device (Phone) information and logs to diagnostic any issue

Return:

Returns response with diagnostic logs of type DiagnosticLog.

Usage Example:

let response = m_bluIDSDKClient.getDiagnosticInfo()
print(response)

Declaration

Swift

public func getDiagnosticInfo(callback: @escaping (DiagnosticLog) -> Void)

Parameters


                                callback

This callback is triggered when the SDK responds to getDiagnosticInfo request.


                    
                    
                    clearDiagnosticLogs()

Declaration

Swift

public func clearDiagnosticLogs()


                    
                    
                    updateDeviceName(name:onResponse:)

Updates name of connected BluPOINT device.

Return:

Returns response with BluIDSDKError if any else with nil.

Usage Example:

m_bluIDSDKClient.updateDeviceName(name: "device1",onResponse:{ (error)  in
   print(error ?? "")
})

Possible Errors:

Declaration

Swift

public func updateDeviceName(name: String, onResponse callback: @escaping (BluIDSDKError?) -> Void)

Parameters

`name`	The value of the new device name for the BluPOINT device
`onResponse`	This callback is triggered when the device responds to the updateDeviceName request.


                    
                    
                    updateDeviceMacAddress(macAddress:onResponse:)

Updates MAC address of connected BluPOINT device.

Return:

Returns response with BluIDSDKError if any else with nil.

Usage Example:

m_bluIDSDKClient.updateDeviceMacAddress(macAddress: "1a2b3c4d5e6f",onResponse:{ (error)  in
   print(error ?? "")
})

Possible Errors:

Declaration

Swift

public func updateDeviceMacAddress(macAddress: String, onResponse callback: @escaping (BluIDSDKError?) -> Void)

Parameters

`mac`	The value of the new device MAC for the BluPOINT device
`onResponse`	This callback is triggered when the device responds to the updateDeviceMacAddress request.


                    
                    
                    getDeviceAccessKey(onResponse:)

Gets Access key of connected BluPOINT device, AccessKey is key used by BluPOINT device to communicate with SDK.

Return:

Returns response with either BluIDSDKErroror success response with device key of type String.

Usage Example:

m_bluIDSDKClient.getDeviceAccessKey(onResponse:{ (error,data)  in
   print(error ?? "",data ?? "")
})

Possible Errors:

Declaration

Swift

public func getDeviceAccessKey(onResponse callback: @escaping (BluIDSDKError?, String?) -> Void)

Parameters


                                onResponse

This callback is triggered when the device responds to the getDeviceAccessKey request.


                    
                    
                    updateDeviceSettings(enhanceTapSetting:callback:)

The function is used to set range and enable or disable Enhanced Tap operation for the connected BluPOINT device .

Return:

Returns response with BluIDSDKError or with success with nil.

Usage Example:

let enhancedTapSettings = EnhancedTapSettings(enabled: true,iosBackgroundPower: -65,iosForegroundPower: -60,androidPower: -55)

m_bluIDSDKClient.updateDeviceSettings(enhanceTapSetting: enhancedTapSettings,callback:{ (error)  in
   print(error ?? "")
})

Possible Errors:

Declaration

Swift

public func updateDeviceSettings(enhanceTapSetting: EnhancedTapSettings, callback: @escaping (BluIDSDKError?) -> Void)

Parameters

`enhanceTapSettings`	The new enhance Tap settings for the BluPOINT device.
`onResponse`	This callback is triggered when the device responds to the updateDeviceSettings request.


                    
                    
                    updateDeviceSettings(enableWiegand:callback:)

This function allow user to enable or disable wiegend based communication between BluPOINT device and SDK.

Note: Device should be unlock before calling this function

Return:

Returns response with BluIDSDKError or with success with nil.

Usage Example:

m_bluIDSDKClient.updateDeviceSettings(enableWiegand: true,callback:{ (error)  in
   print(error ?? "")
})

Possible Errors:

Declaration

Swift

public func updateDeviceSettings(enableWiegand: Bool, callback: @escaping (BluIDSDKError?) -> Void)

Parameters

`enableWiegand`	The new Wiegand settings for the BluPOINT device
`onResponse`	{requestCallback} cb - The callback that handles the response.


                    
                    
                    setDeviceReaderID(readerID:callback:)

The function is used to set the readerID for the connected BluPOINT device.

Return:

Returns response with BluIDSDKError or with success with nil.

Usage Example:

let readerID: UInt32 = 843621
m_bluIDSDKClient.setDeviceReaderID(readerID: readerID,callback:{ (error)  in
   print(error ?? "")
})

Possible Errors:

Declaration

Swift

public func setDeviceReaderID(readerID: UInt32, callback: @escaping (BluIDSDKError?) -> Void)

Parameters

`readerID`	The new reader ID for the BluPOINT device
`onResponse`	This callback is triggered when the device responds to the setDeviceReaderID request.


                    
                    
                    startBLELogging(deviceName:gestureType:)

Declaration

Swift

public func startBLELogging(deviceName: String, gestureType: String) throws


                    
                    
                    stopBLELogging()

Declaration

Swift

public func stopBLELogging() throws


                    
                    
                    setDeviceStateLEDColor(forDeviceState:color:onResponse:)

This function update BluPOINT LED color for different state i.e, (inUse,idle)

Note: Device should be unlock before calling this function

Return:

Returns response with BluIDSDKError or with success with nil.

Usage Example:


let deviceState : DeviceState = .in_use
let ledColor = Device_LED_Color(red:0,green:0xff,blue:0)

m_bluIDSDKClient.setDeviceStateLEDColor(forDeviceState: deviceState,color:ledColor,onResponse:{ (error)  in
   print(error ?? "")
})

Possible Errors:

Declaration

Swift

public func setDeviceStateLEDColor(forDeviceState deviceState: DeviceState, color ledColor: Device_LED_Color, onResponse callback: @escaping ((BluIDSDKError?) -> Void))

Parameters

`deviceState`	The state of BluPOINT device for which the color needs to be changed
`ledColor`	The color which needs to be set
`onResponse`	This callback is triggered when the device responds to the setDeviceStateLEDColor request.


                    
                    
                    getDeviceStateLEDColor(forDeviceState:onResponse:)

This function return the BluPOINT LED color for different state i.e, (inUse,idle)

Note: Device should be unlock before calling this function

Return:

Returns response with either BluIDSDKError or success response with led colour of type BluPOINT_LED_Color.

Usage Example:

m_bluIDSDKClient.getDeviceStateLEDColor(forDeviceState: .idle,onResponse:{ (error,data)  in
   print(error ?? "",data ?? "")
})

Possible Errors:

Declaration

Swift

public func getDeviceStateLEDColor(forDeviceState deviceState: DeviceState, onResponse callback: @escaping ((BluIDSDKError?, Device_LED_Color?) -> Void))

Parameters

`deviceState`	The state of BluPOINT device for which the color needs to be changed
`onResponse`	This callback is triggered when the device responds to the getDeviceStateLEDColor request.


                    
                    
                    deleteAllPersonCardsFromUserDevice()

This function removes all Person Cards from user Phone.

 m_bluIDSDKClient.deleteAllPersonCardsFromUserDevice()

Declaration

Swift

public func deleteAllPersonCardsFromUserDevice()


                    
                    
                    deletePersonCardsFromUserDevice(cardIDs:)

This function removes, list of Person Cards provided by user.

Declaration

Swift

public func deletePersonCardsFromUserDevice(cardIDs: [String])

Parameters


                                cardIDs

List of card IDs to be deleted. let cardIDs = ["4","6"] m_bluIDSDKClient.deletePersonCardsFromUserDevice(cardIDs:cardIDs)


                    
                    
                    factoryResetDevice(onComplete:)

This function erase all user setting and bring device to factory setting.

This function reset’s BluPOINT device to it’s factory state.

Return:

Returns response with either BluIDSDKError or success response with nil.

Usage Example:

m_bluIDSDKClient.factoryResetDevice(onComplete:{ (error)  in
   print(error ?? "")
})

Possible Errors:

Declaration

Swift

public func factoryResetDevice(onComplete callback: @escaping ((BluIDSDKError?) -> Void))

Parameters


                                onComplete

This callback is triggered when the device gets reset.


                    
                    
                    updateDeviceSettings(gesture:setting:callback:)

Update Gesture based authentication setting of connected BluPOINT device, settings include the minimum power required for a gesture and enabling and disabling gesture for the device.

Return:

Returns response with BluIDSDKError or with success with nil.

Usage Example:

let tapSettings = GestureSetting(enabled: true, power: -50)
let gestureType = GestureType.tap

m_bluIDSDKClient.updateDeviceSettings(gesture: gestureType,setting: tapSettings,callback:{ (error)  in
   print(error ?? "")
})

Possible Errors: