NexusConnect UHF Documentation - Android (2.0.6)

NexusConnectUHF is a library that manages the connection to NexusConnectUHF device, which scans barcodes and UHF tags. It provides functionality to establish and maintain communication, receive scanned data, and process barcode and UHF tag inputs for various applications.

---

Table of contents

1. Installation
   1. Manual Installation
2. Usage
   1. Developer Key
   2. Initialization
   3. Discover and Connect Devices
   4. Connection State Listener
   5. Device Button Events
   6. Barcode Operations
      1. Barcode Scanning
      2. Scan Modes
   7. UHF Operations
      1. Tag Reading
      2. Antenna Power
      3. Region Frequency
      4. Sessions and Targets
      5. Memory Bank Configuration
      6. Tracking UHF Tags
      7. Writing and Killing Tags
3. Device Information
4. Device Settings
5. Firmware Update

---

Installation

Manual Installation

To integrate NexusConnectSDK into your Android application:

1. Obtain the SDK: Contact IPCMobile to request the latest NexusConnectSDK library (.aar file).
2. Add Dependency: Include the SDK in your application’s build configuration. The SDK provides essential features to interact seamlessly with NexusConnect UHF devices.

Kotlin (build.gradle.kts):

dependencies {
    implementation(files("../app/libs/NexusConnectSDK.aar"))
}

Groovy (build.gradle):

dependencies {
    implementation(name: 'NexusConnectSDK', ext: 'aar')
}

Usage

Developer Key

To securely access NexusConnectSDK features, you need an IPCMobile developer key. Register at developer.ipcmobile.com and create a key specifically associated with your application’s package name.

Initialization

Initialize the SDK in your application’s lifecycle to ensure all required services and resources are properly configured:

val nexusConnect = NexusConnectUHF
nexusConnect.initialize(context, "YOUR_IPCMOBILE_DEVELOPER_KEY")

Always clean up resources when your application or activity is destroyed to prevent memory leaks:

nexusConnect.cleanup()

Discover and Connect Devices

NexusConnect UHF devices support BLE pairing, making it easy to find and connect devices nearby.

Start device discovery:

nexusConnect.startDiscoveringDevices()

Handle discovered devices through callbacks, capturing device details and signal strength:

nexusConnect.setDeviceDiscoveryListener(object : NCDeviceDiscoveryListener {
    override fun onDeviceDiscovered(device: NCDevice, rssi: Int) {
        // Handle device discovery
    }
})

Stop discovery when devices are found or no longer needed:

nexusConnect.stopDiscoveringDevices()

Connect devices easily by object reference or MAC address:

nexusConnect.connectDevice(device) // Using device object
nexusConnect.connectDevice("device_mac_address") // Using MAC address

Disconnect when finished:

nexusConnect.disconnectDevice()

Connection State Listener

Effectively monitor the device’s connection state to manage user interface changes or operational logic:

nexusConnect.setConnectionStateListener(object : NCConnectionStateListener {
    override fun onConnectionStateChanged(state: NCConnectionState) {
        // Handle connection state changes
    }
})

Device Button Events

Respond instantly to hardware button interactions, allowing real-time operational feedback:

nexusConnect.setDeviceOperationListener(object : NCDeviceOperationListener {
    override fun onDeviceButtonPressed() {}
    override fun onDeviceButtonReleased() {}
})

Barcode Operations

Efficiently scan and process barcode data using integrated readers.

Barcode Scanning

Start and stop barcode scanning easily:

nexusConnect.startBarcodeReader()
nexusConnect.stopBarcodeReader()

Receive barcode data instantly:

nexusConnect.setBarcodeDataListener(object : NCBarcodeDataListener {
    override fun onBarcodeData(data: String, type: NCSymbology) {}
    override fun onBarcodeData(data: ByteArray, type: NCSymbology) {} // optional
})

Scan Modes

Configure barcode scanning behavior to suit your application:

nexusConnect.setBarcodeScanMode(NCBarcodeScanMode.SINGLE)
val currentMode = nexusConnect.getBarcodeScanMode()

UHF Operations

Manage RFID tag inventory, data reading, and writing through powerful UHF functionality.

Tag Reading

Start and stop RFID tag scanning quickly:

nexusConnect.startUHFReader()
nexusConnect.stopUHFReader()

Capture RFID tag information dynamically:

nexusConnect.setUHFTagDataListener(object : NCUHFTagListener {
    override fun onUHFTagDetected(tag: NCUHFTag) {}
})

Antenna Power

Optimize RFID reader performance by adjusting antenna power settings (1-30 dBm):

val currentPower = nexusConnect.getUHFPower()
nexusConnect.setUHFPower(15)

Region Frequency

Adjust regional frequency settings for global compatibility:

val currentFrequency = nexusConnect.getUHFFrequency()
nexusConnect.setUHFFrequency(NCUHFFrequency.UNITED_STATES)

Sessions and Targets

Manage tag querying sessions and targets to optimize RFID reading efficiency:

val inventory = nexusConnect.getUHFInventory()
inventory.querySession = NCUHFInventory.QuerySession.s0
inventory.queryTarget = NCUHFInventory.QueryTarget.a
nexusConnect.setUHFInventory(inventory)

Memory Bank Configuration

Set specific memory bank modes for detailed data management on RFID tags:

val memoryBank = nexusConnect.getUHFMemoryBank()
memoryBank.mode = NCUHFMemoryBankMode.EPC // adjust offsets as needed
nexusConnect.setUHFMemoryBank(memoryBank)

Tracking UHF Tags

Use RSSI to effectively estimate RFID tag proximity and manage inventory more precisely:

val filter = NCUHFTagFilter(NCUHFMemoryBankType.EPC, 32, 96, "TAG_EPC")
nexusConnect.startTrackingUHFTag(context, filter) { tag, strength, angle ->
    // Handle tag proximity
}

nexusConnect.stopTrackingTag()

Writing and Killing Tags

Securely write data to RFID tags and manage tag lifecycle operations:

val filter = NCUHFTagFilter().apply {
    bankType = NCUHFMemoryBankType.EPC
    offset = 32
    length = 16
    data = "AABB"
}

nexusConnect.writeUHFTag(filter, NCUHFMemoryBankType.EPC, 32, 96, "DATA_TO_WRITE")

Permanently disable (kill) tags:

val success = nexusConnect.killUHFTag(filter, "TAG_PASSWORD")

Device Information

Retrieve essential device metrics and firmware details:

val battery = nexusConnect.getBatteryLevel()
val temperature = nexusConnect.getTemperature()
val mainboardVersion = nexusConnect.getMainboardVersion()
val uhfVersion = nexusConnect.getUHFFirmwareVersion()
val bleVersion = nexusConnect.getBLEFirmwareVersion()

Device Settings

Customize device alerts and feedback:

val beepOn = nexusConnect.getScanBeep()
nexusConnect.setScanBeep(false)

Firmware Update

Perform seamless firmware updates with real-time progress tracking:

nexusConnect.updateFirmware(context, uri, NCFirmwareType.MAINBOARD, object : NCUpdateProgressListener {
    override fun onProgressUpdate(progress: Int) {}
    override fun onUpdateComplete(success: Boolean) {}
})