DeviceManager

Summary

Inner class of the CodiscanSDK class. Used to pair with a CODiScan device, request CODiScan device data, and trigger the findMe function.

Functions

Function	Description
triggerPairingObject	Trigger the CODiScan service to send a pairing code to connect a CODiScan device by invoking any registered PairingCodeListener's onPairingCode callback.
triggerDisconnect	Disconnect the connected CODiScan device. Will invoke any registered DisconnectListeners.
triggerBatteryStatus	Trigger the connected CODiScan device to send battery data by invoking any registered BatteryStatusListener's onBatteryStatus callback.
triggerDeviceDetails	Trigger the connected CODiScan device to send device data by invoking any registered DeviceDetailsListener's onDeviceDetails callback.
findMyDevice	Send the "Find My Device" command to the connected CODiScan. Causes the devices to flash and beep.
registerConnectListener	Register a given ConnectListener to receive onConnect callbacks when a CODiScan device pairs with the mobile device.
removeConnectListener	Remove a given ConnectListener to stop receiving onConnect callbacks.
registerDisconnectListener	Register a given DisconnectListener to receive onDisconnect callbacks when a CODiScan device disconnects from the mobile device.
removeDisconnectListener	Remove a given DisconnectListener to stop receiving onDisconnect callbacks.
registerPairingCodeListener	Register a given PairingCodeListener to receive onPairingCode callbacks when a new pairing code is sent from the CODiScan service.
removePairingCodeListener	Remove a given PairingCodeListener to stop receiving onPairingCode callbacks.
registerScanListener	Register a given ScanListener to receive onScan callbacks when a barcode is scanned by the connected CODiScan device.
removeScanListener	Remove a given ScanListener to stop receiving onScan callbacks.
registerBatteryStatusListener	Register a given BatteryStatusListener to receive onBatteryStatus callbacks when battery data is received from the connected CODiScan device. Triggered by calling triggerBatteryStatus.
removeBatteryStatusListener	Remove a given BatteryStatusListener to stop receiving onBatteryStatus callbacks.
registerDeviceDetailsListener	Register a given DeviceDetailsListener to receive onDeviceDetails callbacks when device data is received from the connected CODiScan device. Triggered by calling triggerDeviceDetails.
removeDeviceDetailsListener	Remove a given DeviceDetailsListener to stop receiving onDeviceDetails callbacks.

Functions

triggerPairingObject

fun triggerPairingObject(): Int

Trigger the CODiScan service to send a pairing code to connect a CODiScan device by invoking any registered PairingCodeListener's onPairingCode callback.

Returns

• 0 -> Success.
• 5 -> Fail, already connected.
• 6 -> Fail, CODiScan service unbound.

Example

if (codiscanSDK.deviceManager.triggerPairingObject() != 0) {
    Log.i("MY_APP", "Failed to trigger pairing object for the CODiScan!")
}

---

triggerDisconnect

fun triggerDisconnect(): Int

Disconnect the connected CODiScan device. Will invoke any registered DisconnectListeners.

Returns

• 0 -> Success.
• 1 -> Fail, CODiScan device already disconnected.
• 6 -> Fail, CODiScan service unbound.

Example

if (codiscanSDK.deviceManager.triggerPairingObject() != 0) {
    Log.i("MY_APP", "Failed to disconnect from the CODiScan!")
}

---

triggerBatteryStatus

fun triggerBatteryStatus(): Int

Trigger the connected CODiScan device to send battery data by invoking any registered BatteryStatusListener's onBatteryStatus callback.

Returns

• 0 -> Success.
• 1 -> Fail, CODiScan device disconnected.
• 6 -> Fail, CODiScan service unbound.

Example

if (codiscanSDK.deviceManager.triggerBatteryStatus() != 0) {
    Log.i("MY_APP", "Failed to trigger battery status from the CODiScan!")
}

---

triggerDeviceDetails

fun triggerDeviceDetails(): Int

Trigger the connected CODiScan device to send device data by invoking any registered DeviceDetailsListener's onDeviceDetails callback.

Returns

• 0 -> Success.
• 1 -> Fail, CODiScan device disconnected.
• 6 -> Fail, CODiScan service unbound.

Example

if (codiscanSDK.deviceManager.triggerDeviceDetails() != 0) {
    Log.i("MY_APP", "Failed to trigger device details from the CODiScan!")
}

---

findMyDevice

fun findMyDevice(): Int

Send the "Find My Device" command to the connected CODiScan. Causes the devices to flash and beep.

Returns

• 0 -> Success.
• 1 -> Fail, CODiScan device disconnected.
• 6 -> Fail, CODiScan service unbound.

Example

if (codiscanSDK.deviceManager.findMyDevice() != 0) {
    Log.i("MY_APP", "Failed to trigger the \"Find My Device\" command for the CODiScan!")
}

---

registerConnectListener

fun registerConnectListener(listener: ConnectListener): Int

Register a given ConnectListener to receive onConnect callbacks when a CODiScan device pairs with the mobile device.

Parameters

• listener - the given GetConfigListener.

Returns

• 0 -> Success.
• 2 -> Fail, unable to register listener.
• 6 -> Fail, CODiScan service unbound.

Example

if (codiscanSDK.deviceManager.registerConnectListener(this) != 0) {
    Log.i("MY_APP", "Something went wrong with registering the connect listener!")
}

---

removeConnectListener

fun removeConnectListener(listener: ConnectListener): Int

Remove a given ConnectListener to stop receiving onConnect callbacks.

Parameters

• listener - the given ConnectListener.

Returns

• 0 -> Success.
• 3 -> Fail, unable to remove listener.
• 6 -> Fail, CODiScan service unbound.

Example

if (codiscanSDK.deviceManager.removeConnectListener(this) != 0) {
    Log.i("MY_APP", "Something went wrong with de-registering the connect listener!")
}

---

registerDisconnectListener

fun registerConnectListener(listener: DisconnectListener): Int

Register a given DisconnectListener to receive onDisconnect callbacks when a CODiScan device disconnects from the mobile device.

Parameters

• listener - the given GetConfigListener.

Returns

• 0 -> Success.
• 2 -> Fail, unable to register listener.
• 6 -> Fail, CODiScan service unbound.

Example

if (codiscanSDK.deviceManager.registerDisconnectListener(this) != 0) {
    Log.i("MY_APP", "Something went wrong with registering the disconnect listener!")
}

---

removeDisconnectListener

fun removeDisconnectListener(listener: DisconnectListener): Int

Remove a given DisconnectListener to stop receiving onDisconnect callbacks.

Parameters

• listener - the given DisconnectListener.

Returns

• 0 -> Success.
• 3 -> Fail, unable to remove listener.
• 6 -> Fail, CODiScan service unbound.

Example

if (codiscanSDK.deviceManager.removeDisconnectListener(this) != 0) {
    Log.i("MY_APP", "Something went wrong with de-registering the disconnect listener!")
}

---

registerPairingCodeListener

fun registerPairingCodeListener(listener: PairingCodeListener): Int

Register a given PairingCodeListener to receive onPairingCode callbacks when a new pairing code is sent from the CODiScan service.

Parameters

• listener - the given PairingCodeListener.

Returns

• 0 -> Success.
• 2 -> Fail, unable to register listener.
• 6 -> Fail, CODiScan service unbound.

Example

if (codiscanSDK.deviceManager.registerPairingCodeListener(this) != 0) {
    Log.i("MY_APP", "Something went wrong with registering the pairing code listener!")
}

---

removePairingCodeListener

fun removePairingCodeListener(listener: PairingCodeListener): Int

Remove a given PairingCodeListener to stop receiving onPairingCode callbacks.

Parameters

• listener - the given PairingCodeListener.

Returns

• 0 -> Success.
• 3 -> Fail, unable to remove listener.
• 6 -> Fail, CODiScan service unbound.

Example

if (codiscanSDK.deviceManager.removePairingCodeListener(this) != 0) {
    Log.i("MY_APP", "Something went wrong with de-registering the pairing code listener!")
}

---

registerScanListener

fun registerScanListener(listener: ScanListener): Int

Register a given ScanListener to receive onScan callbacks when a barcode is scanned by the connected CODiScan device.

Parameters

• listener - the given ScanListener.

Returns

• 0 -> Success.
• 2 -> Fail, unable to register listener.
• 6 -> Fail, CODiScan service unbound.

Example

if (codiscanSDK.deviceManager.registerScanListener(this) != 0) {
    Log.i("MY_APP", "Something went wrong with registering the scan listener!")
}

---

removeScanListener

fun removeScanListener(listener: ScanListener): Int

Remove a given ScanListener to stop receiving onScan callbacks.

Parameters

• listener - the given ScanListener.

Returns

• 0 -> Success.
• 3 -> Fail, unable to remove listener.
• 6 -> Fail, CODiScan service unbound.

Example

if (codiscanSDK.deviceManager.removeScanListener(this) != 0) {
    Log.i("MY_APP", "Something went wrong with de-registering the scan listener!")
}

---

registerBatteryStatusListener

fun registerBatteryStatusListener(listener: BatteryStatusListener): Int

Remove a given BatteryStatusListener to stop receiving onBatteryStatus callbacks.

Parameters

• listener - the given BatteryStatusListener.

Returns

• 0 -> Success.
• 2 -> Fail, unable to register listener.
• 6 -> Fail, CODiScan service unbound.

Example

if (codiscanSDK.deviceManager.registerBatteryStatusListener(this) != 0) {
    Log.i("MY_APP", "Something went wrong with registering the battery status listener!")
}

---

removeBatteryStatusListener

fun removeBatteryStatusListener(listener: BatteryStatusListener): Int

Remove a given BatteryStatusListener to stop receiving onBatteryStatus callbacks.

Parameters

• listener - the given BatteryStatusListener.

Returns

• 0 -> Success.
• 3 -> Fail, unable to remove listener.
• 6 -> Fail, CODiScan service unbound.

Example

if (codiscanSDK.deviceManager.removeBatteryStatusListener(this) != 0) {
    Log.i("MY_APP", "Something went wrong with de-registering the battery status listener!")
}

---

registerDeviceDetailsListener

fun registerDeviceDetailsListener(listener: DeviceDetailsListener): Int

Register a given DeviceDetailsListener to receive onDeviceDetails callbacks when device data is received from the connected CODiScan device. Triggered by calling triggerDeviceDetails.

Parameters

• listener - the given DeviceDetailsListener.

Returns

• 0 -> Success.
• 2 -> Fail, unable to register listener.
• 6 -> Fail, CODiScan service unbound.

Example

if (codiscanSDK.deviceManager.registerDeviceDetailsListener(this) != 0) {
    Log.i("MY_APP", "Something went wrong with registering the device details listener!")
}

---

removeDeviceDetailsListener

fun removeDeviceDetailsListener(listener: DeviceDetailsListener): Int

Remove a given DeviceDetailsListener to stop receiving onDeviceDetails callbacks.

Parameters

• listener - the given DeviceDetailsListener.

Returns

• 0 -> Success.
• 3 -> Fail, unable to remove listener.
• 6 -> Fail, CODiScan service unbound.

Example

if (codiscanSDK.deviceManager.removeDeviceDetailsListener(this) != 0) {
    Log.i("MY_APP", "Something went wrong with de-registering the device details listener!")
}

---