Overview

Introduction

UBX UHF RFID SDK (URFIDLibrary) is an Android UHF RFID library delivered as an AAR. It abstracts reader communication and provides inventory, tag access, configuration, firmware upgrade, and peripheral management.

Document version: V2.25

Version history

2025-12-30 （URFIDLibrary-v2.5.1230.aar）

1. setInventorySceneMode - New Inventory Scene Modes

Added two new reading modes: • Cycle Count Mode: Deduplicated inventory counting mode • Max Range Mode: Maximum read distance mode

2. Data Callback Parameter Type Change

The onInventoryTag callback method signature has been updated:

java

Previous:
onInventoryTag(String EPC, String Data, String rssi);
Updated:
onInventoryTag(String EPC, String Data, int rssi);

Note: The rssi parameter type changed from String to int.

3. RfidProfile Enumeration - Miller Configuration Return Type Change

The Miller configuration getter in RfidProfile enumeration now returns int type instead of String.

4. New Method: getSupportProfileList()

Added a new method to retrieve the list of supported Profile combinations: getSupportProfileList()

5. New Method: getSupportFrequencyBandList()

Added a new method to retrieve the list of supported Frequency Region combinations: getSupportFrequencyBandList()

6. New Method: getSupportWorkRegionList()

Added a new method to retrieve the list of supported Country Code combinations: getSupportWorkRegionList()

7. Enhanced Module Type Identification: getModuleType()

Enhanced the method for retrieving the current module type. This method can be used to differentiate supported Profiles:

java

int getModuleType()
Supported Module Types:
•	MODULE_U1
•	MODULE_U2
•	MODULE_U3
•	MODULE_U4
•	MODULE_U5
•	MODULE_OTHER

8. New Method: getReaderDeviceType()

Added a new method to retrieve the reader device type: getReaderDeviceType() ReaderDeviceType Enumeration Values:

java

Value	Constant	                Description
	-1	ReaderDeviceType.UNKNOWN	Unknown device type
	0	ReaderDeviceType.INTEGRATED	Integrated device
	1	ReaderDeviceType.PERIPHERAL_UART	Serial port device
	2	ReaderDeviceType.BLE_DEVICE	Bluetooth device

9. New Method: setInventoryPhaseFlag(boolean flag)

Added a new method to enable or disable the return of phase and frequency information: setInventoryPhaseFlag(boolean flag)

10. Callback Registration Method Update

Recommended: Use addDataCallback() instead of the deprecated registration method.

java

Previous:
		registerCallback(IRfidCallback cb) 
	 Updated:
		addDataCallback(DataCallback cb)

Callback Method Signature Change:

java

Previous: onInventoryTag(String EPC, String Data, int rssi);
	Updated: onInventoryTag(ReadTag readTag);

ReadTag Class Properties:

java

Property	Type	Description
epcId	    String	EPC value
memId	    String	TID or USER data (In QueryMemBank EPC+TID or EPC+USER mode, this parameter contains TID or USER data respectively)
rssi	    int	    Signal strength value (0-100)
phase	    int	    Phase value
FreqKhz	    int	    Frequency point (in KHz)

11. Release Method Deprecation

The rfidManager.release() method has been removed. Use the following method instead: RFIDSDKManager.getInstance().release();

12.Code optimization

The core functional modules have been optimized to enhance code maintainability and execution efficiency.

2026-04-08 （URFIDLibrary-v2.6.0408.aar）

1. The SO library is 16KB aligned.

2. The method setRssiInDbm has been removed.

Now, the dBm value is automatically returned in the readTag.rssidBm field of the onInventoryTag(ReadTag readTag) callback, which represents the dBm signal value.

3. The method for switching the signal value return range has been modified:

java

"setRssiConvertEnabled" has been replaced with: 2.5.15 "setRssiUnitType"
"getRssiConvertEnabled" has been replaced with:        "getRssiUnitType"

2026-06-09 （URFIDLibrary-v2.6.0609.aar）

1. Added RFID firmware update interface.

2. Optimized and fixed the issue of inconsistent 16KB alignment display results on different Android Studio versions.

Core capabilities

Lifecycle: integrated/UART and Bluetooth init, connection, release
Inventory: continuous, timed, single-shot, scene modes, mixed memory bank query
Tag access: Gen2 read/write/lock/kill, mask ops, TID-based access
Reader config: power, profile, region, antenna multiplexing
Firmware upgrade: local and online via RFUpgradeManager
Peripherals: Bluetooth/UART sled barcode, battery/offline, key events

Use cases

Warehouse/asset batch inventory
Single-tag read/write and EPC rewrite
PDA and Bluetooth RFID sled applications
Fixed reader multi-antenna inventory

Requirements

Item	Requirement
Platform	Android
Min SDK	API 18 (Android 4.3)
Artifact	`URFIDLibrary-xxxxxx.aar`
Hardware	Company-provided device and module
Demo	RFIDDemo

Integration

Obtain the SDK

gradle

dependencies {
    implementation files('libs/URFIDLibrary-xxxxxx.aar')
}

Project setup

Permissions

xml

<uses-permission android:name="android.permission.BLUETOOTH" />
<uses-permission android:name="android.permission.BLUETOOTH_ADMIN" />
<uses-permission android:name="android.permission.BLUETOOTH_CONNECT" />
<uses-permission android:name="android.permission.INTERNET" />
<uses-permission android:name="android.permission.WRITE_EXTERNAL_STORAGE" />
<uses-permission android:name="android.permission.FOREGROUND_SERVICE" />
<uses-permission android:name="android.permission.FOREGROUND_SERVICE_CONNECTED_DEVICE" />

BLE firmware upgrade deps

gradle

implementation 'no.nordicsemi.android:dfu:2.9.0'
implementation 'com.google.code.gson:gson:2.11.0'

Notes:

Ensure the SDK is initialized: RFIDSDKManager.init() or initBTtoMac() must have completed successfully.

Firmware package format: ZIP archive — use the package provided by UBX as-is. Do not extract, rename, or change the format.

Context: Routine checks may use ApplicationContext. When showUI=true, pass an Activity Context.

Permissions: For BLE sled firmware upgrade on Android 12+ (API 31+), BLUETOOTH_CONNECT must be granted.

Not thread-safe: Do not run multiple check/upgrade flows concurrently — only one upgrade task at a time.

BLE sled upgrade requires additional configuration:

Additional dependencies:

implementation 'no.nordicsemi.android:dfu:2.9.0' implementation 'com.google.code.gson:gson:2.11.0'

ProGuard rules:

-keep class no.nordicsemi.* { ; }

Add to AndroidManifest.xml:

<uses-permission android:name="android.permission.FOREGROUND_SERVICE"/>

<uses-permission android:name="android.permission.FOREGROUND_SERVICE_CONNECTED_DEVICE"/>

Class: RFUpgradeManager.getInstance()

Flow:

checkUpgrade() → [user confirmation] → startUpgrade()

3.1 Check for update

ProGuard

proguard

-keep class com.ubx.** { *; }
-keep class no.nordicsemi.** { *; }
-keep class com.iflytek.** { *; }
-keep class com.lib.** { *; }
-keep class android.device.** { *; }

Initialization

Device	API
Integrated / UART	`RFIDSDKManager.getInstance().init(context, listener)`
Bluetooth	`RFIDSDKManager.getInstance().initBTtoMac(context, mac, listener)`
Release	`RFIDSDKManager.getInstance().release()`

Call SDK on a background thread; execute commands serially.

Authentication

None.

Quick Start

java

RFIDSDKManager.getInstance().init(context, status -> {
    if (!status) return;
});

RfidManager rfid = RFIDSDKManager.getInstance().getRfidManager();
rfid.addDataCallback(new DataCallback() {
    @Override public void onInventoryTag(ReadTag readTag) { /* EPC: readTag.epcId */ }
    @Override public void onInventoryTagEnd() { }
});

rfid.startInventoryWithTimeout(300);

// stop: RFIDSDKManager.getInstance().getRfidManager().stopInventory();
// exit: RFIDSDKManager.getInstance().release();

Note: Call addDataCallback, startInventoryWithTimeout, stopInventory, and release outside the init callback; the callback should only handle connection success or failure.

Success indicators: InitListener.onStatus(true); inventory callbacks receive ReadTag data.

Access via RFIDSDKManager.getInstance()

Init callback

java

RFIDSDKManager.getInstance().init(context, status -> {
    if (!status) return;
});

In InitListener.onStatus(boolean status): status == true — initialization succeeded; status == false — initialization failed. Handle only the connection result inside the init callback; call addDataCallback, startInventoryWithTimeout, stopInventory, and release outside the callback.

Parameter	Type	Description
context	Context	Application `Context`
listener	InitListener	Callback for init success or failure new InitListener() { @Override public void onStatus(boolean status) { } } status : `true` — initialization succeeded `false` — initialization failed

Parameter	Type	Description
context	Context	Context
mac	String	Bluetooth device MAC address, e.g. `41:BB:00:F8:DB:51`.
listener	InitListener	Init success/failure callback: `new InitListener() { @Override public void onStatus(boolean status) { } }` `status`: `true` — connected; `false` — connection failed

Returns

true — connected; false — not connected. (boolean)

Callback when switching between the DT610 built-in RFID and RFG91 UART module. Valid only for the DT610 + RFG91 UART combination.

Example

java

RFIDSDKManager.getInstance().setSwitchCallback(new ModelInfoCallback() {
@Override
public void onModuleStatus(int status) {
}
@Override
public void onInfo(int type, String firmware, int power) {
}
});

Access via RFIDSDKManager.getInstance().getRfidManager()

onInventoryTag and onInventoryTagEnd are DataCallback interface methods; register via addDataCallback to receive callbacks.

Results are delivered via addDataCallback().

Returns

Success: RfidErrorConstants.SUCCESS (int)

Failure: other codes (see Error codes and types).

Example

java

RFIDSDKManager.getInstance().getRfidManager().startInventoryWithTimeout(300);
To trigger inventory from the RFID grip key, use one of the following:
1. Integrated reader — listen for Android key events:
@Override
public boolean dispatchKeyEvent(KeyEvent event) {
if ((event.getKeyCode() == 523 

event.getKeyCode() == 515 )
&& event.getRepeatCount() == 0) {
//TODO The key value of the PTT button on the left side of DT610 is 515
if (event.getAction() == KeyEvent.ACTION_DOWN ) {
//start Inventory
//RFIDSDKManager.getInstance().getRfidManager().startInventoryWithTimeout(300);
return true;
} else if (event.getAction() == KeyEvent.ACTION_UP ) {
//stop Inventory
//RFIDSDKManager.getInstance().getRfidManager().stopInventory();
return true;
}
}
return super.dispatchKeyEvent(event);
}
2. Bluetooth device — use the key event callback:
GripDeviceManager.getInstance().setKeyEventListener(new KeyEventListener() {
@Override
public void event(int keyCode, boolean isDown) {
//keycode == BTKeyEvent.BT_SCAN The handle button was pressed
//isDown true: down false: up
if (keyCode == BTKeyEvent.BT_SCAN) {
if (isDown ) {
//start Inventory
//RFIDSDKManager.getInstance().getRfidManager().startRead();
} else {
//stop Inventory
//RFIDSDKManager.getInstance().getRfidManager().stopInventory();
}
}
}
});

Tag results are returned via addDataCallback().

Returns

Success: RfidErrorConstants.SUCCESS (int)

Failure: other codes (see Error codes and types).

Example

java

RFIDSDKManager.getInstance().getRfidManager().startInventory();
To trigger inventory from the RFID grip key, use one of the following:
1. Integrated reader — listen for Android key events:
@Override
public boolean dispatchKeyEvent(KeyEvent event) {
if (event.getKeyCode() == 523 && event.getRepeatCount() == 0) {
//TODO The Grip key value of the key is 523
if (event.getAction() == KeyEvent.ACTION_DOWN ) {
//start Inventory
//RFIDSDKManager.getInstance().getRfidManager().startInventory();
return true;
} else if (event.getAction() == KeyEvent.ACTION_UP ) {
//stop Inventory
//RFIDSDKManager.getInstance().getRfidManager().stopInventory();
return true;
}
}
return super.dispatchKeyEvent(event);
}
2. Bluetooth device — use the key event callback:
GripDeviceManager.getInstance().setKeyEventListener(new KeyEventListener() {
@Override
public void event(int keyCode, boolean isDown) {
//keycode == BTKeyEvent.BT_SCAN The handle button was pressed
//isDown true: down false: up
if (keyCode == BTKeyEvent.BT_SCAN) {
if (isDown ) {
//start Inventory
//RFIDSDKManager.getInstance().getRfidManager().startInventory();
} else {
//stop Inventory
//RFIDSDKManager.getInstance().getRfidManager().stopInventory();
}
}
}
});

Parameter	Type	Description
cb	DataCallback	Callback

Parameter	Type	Description
readTag.epcId	String	Tag EPC (excluding CRC/PC).
readTag.memId	String	Mixed-query memory data (TID, USER, RESERVED, etc.). Configure via `setQueryMemoryBank(QueryMemBank mode)`.
readTag.rssidBm	int	Signal strength in dBm (decibel-milliwatts).

Returns

Success: RfidErrorConstants.SUCCESS (int)

Failure: other codes (see Error codes and types).

Returns

Success: RfidErrorConstants.SUCCESS； Other — failure (see Error codes and types). Read result returned in onInventoryTag().

com.ubx.usdk.RfidManager

setInventorySceneMode

Preset modes for common scenarios. For custom settings, use Inventory parameters with InventorySceneMode.CUSTOM_MODE. Note: When not in CUSTOM_MODE, Session, Q-value, Target, and Profile cannot be changed. After changing mode, output power resets to the mode default — re-apply your desired power if needed.

int setInventorySceneMode(InventorySceneMode mode);

Parameter	Type	Description
mode	InventorySceneMode	Inventory scene mode — see Inventory scene mode reference below.

Returns

Success: RfidErrorConstants.SUCCESS (int)

Failure: other codes (see Error codes and types).

Example

java

RFIDSDKManager.getInstance().getRfidManager().setInventorySceneMode(InventorySceneMode.BATTERY_LIFE);

Inventory scene mode reference

Inventory scene mode	Use case
(InventorySceneMode)
BATTERY_LIFE	Low-power mode — extends device battery life
FULL_INVENTORY	Full tag inventory — read all tags as quickly as possible
REPEAT_READ	Rapid accumulation — repeatedly read and count tags
	Note: This mode inventories EPC only.
	Mask filtering cannot use `addMaskBits()`; use `setInventoryMatchData()` instead.
BALANCED_PERFORMANCE	Balanced mode — trade-off between performance and battery
CYCLE_COUNT	Deduplicated inventory — count each tag once; suited to noisy environments but slower subsequent reads
MAX_RANGE	Maximum read distance — single-tag range testing
CUSTOM_MODE	Custom parameters — configure Session, Q, Target, Profile manually

Returns

InventorySceneMode ： (InventorySceneMode) InventorySceneMode.BATTERY_LIFE InventorySceneMode.FULL_INVENTORY InventorySceneMode.REPEAT_READ InventorySceneMode.BALANCED_PERFORMANCE InventorySceneMode.CUSTOM_MODE

Example

java

InventorySceneMode mode =
RFIDSDKManager.getInstance().getRfidManager().getInventorySceneMode();

Parameter	Type	Description
mode	QueryMemBank	See QueryMemBank reference below.
startAddress	int	Start word address for inventory (1 word = 16 bits).
readLen	int	Number of words to read during inventory (16 bits per word).

Returns

Success: RfidErrorConstants.SUCCESS (int)

Failure: other codes (see Error codes and types).

Example

java

RFIDSDKManager.getInstance().getRfidManager().setQueryMemoryBank(QueryMemBank.EPC,0,0);
RFIDSDKManager.getInstance().getRfidManager().setQueryMemoryBank(QueryMemBank.EPC_USER,startAddress,readLen);

QueryMemBank reference

QueryMemBank	Memory bank read
EPC	EPC query
	Parameters: startAddress = 0, readLen = 0
	Behavior: reads default-length EPC (excluding CRC and PC header)
EPC_TID	EPC + TID mixed query
	Parameters: startAddress = TID start word (0–5), readLen = TID length in words (1–6)
	Callback: EPC → `ReadTag.epcId`; TID → `ReadTag.memId`
EPC_USE	EPC + USER mixed query
	Parameters: startAddress = USER start word (≥ 0), readLen = USER length (1–32 words)
	Callback: EPC → `ReadTag.epcId`; USER → `ReadTag.memId`
EPC_RESERVED	EPC + RESERVED (password) query
	Parameters: startAddress = RESERVED start (0–3), readLen = password length (1–4 words)
	Callback: EPC → `ReadTag.epcId`; RESERVED → `ReadTag.memId`
FASTTID	Impinj FastTID mode
	Parameters: startAddress = 0, readLen = 0 (fixed)
	Reads full 96-bit TID (word addresses 0–5) into `ReadTag.memId`
	Compatible with Impinj Monza® tags only
EPC_EPC	Dual EPC query
	Parameters: startAddress = second EPC start, readLen = second EPC length
	First EPC (default length) → `ReadTag.epcId`; second segment → `ReadTag.memId`
	Typical use: read PC bits or partial EPC verification
BID	BID query (special tags only)
	Parameters: startAddress = 0, readLen = 0 (fixed)

Returns

Returns the configured mode value: (int) QueryMemBank queryMemBank : queryMemBank .getStartAddress();//Start address in word units (16 bits per word). queryMemBank.getReadLength(); // read length in words (16 bits per word)

Example

java

QueryMemBank queryMemBank =
RFIDSDKManager.getInstance().getRfidManager().getQueryMemoryBank();
int startAdd = queryMemBank .getStartAddress();
int readLen = queryMemBank .getReadLength();

Access via RFIDSDKManager.getInstance().getRfidManager()

Parameter	Type	Description
outputPower	int	Output power. Max supported power:

int maxPower = RFIDSDKManager.getInstance().getRfidManager().getSupportMaxOutputPower(); |

Returns

Success: RfidErrorConstants.SUCCESS (int)

Failure: other codes (see Error codes and types).

Returns

Output power (int); values < 0 indicate failure.

Note: Not configurable unless InventorySceneMode.CUSTOM_MODE is active. Call setInventorySceneMode(CUSTOM_MODE) first.

Example

java

RFIDSDKManager.getInstance().getRfidManager().setProfile(RfidProfile.PROFILE_5);

Profiles by chip:

RfidProfile	Module support	Parameter details
PROFILE_3	MODULE_U3 、MODULE_U4 、MODULE_U5	PR_ASK, PIE: 2.0, Tari: 20.0μs, BLF: 320kHz, Miller=2
PROFILE_5	MODULE_U3 、MODULE_U4 、MODULE_U5	PR_ASK, PIE: 2.0, Tari: 20.0μs, BLF: 320kHz, Miller=4
PROFILE_7	MODULE_U3 、MODULE_U4 、MODULE_U5	PR_ASK, PIE: 2.0, Tari: 20.0μs, BLF: 250kHz, Miller=4
PROFILE_12	MODULE_U3 、MODULE_U4 、MODULE_U5	PR_ASK, PIE: 2.0, Tari: 15.0μs, BLF: 320kHz, Miller=2
PROFILE_13	MODULE_U3 、MODULE_U4 、MODULE_U5	PR_ASK, PIE: 2.0, Tari: 20.0μs, BLF: 160kHz, Miller=8
PROFILE_1	MODULE_U4 、MODULE_U5	PR_ASK, PIE: 2.0, Tari: 7.5μs, BLF: 640kHz, Miller=2
PROFILE_15	MODULE_U4 、MODULE_U5	PR_ASK, PIE: 2.0, Tari: 7.5μs, BLF: 640kHz, Miller=4
PROFILE_51	MODULE_U4 、MODULE_U5	DSB, PIE: 1.5, Tari: 6.25μs, BLF: 640kHz, Miller=2
PROFILE_53	MODULE_U4 、MODULE_U5	PR_ASK, PIE: 1.5, Tari: 7.5, BLF:640kHz, Miller=4
PROFILE_11	MODULE_U5	PR_ASK, PIE: 2.0, Tari: 7.5μs, BLF: 640kHz, FM0
PROFILE_50	MODULE_U5	DSB, PIE: 1.5, Tari: 6.25μs, BLF: 640kHz, FM0
PROFILE_52	MODULE_U5	PR_ASK, PIE: 2.0, Tari: 15.0μs, BLF: 426kHz, FM0
PROFILE_R2000_0	MODULE_U2	DSB-ASK, PIE: 1.0, Tari: 25.0μs, BLF: 40kHz, FM0
PROFILE_R2000_1	MODULE_U2	PR_ASK, PIE: 0.5, Tari: 25.0μs, BLF: 250kHz, FM4
PROFILE_R2000_2	MODULE_U2	PR_ASK, PIE: 0.5, Tari: 25.0μs, BLF: 300kHz, FM4
PROFILE_R2000_3	MODULE_U2	DSB-ASK, PIE: 0.5, Tari: 6.5μs, BLF: 400kHz, FM0

Impinj Gen2X Profiles:

Gen2X description：

Gen2X is Impinj high-performance read mode optimized for M700/M800 tags. Two strategies:

Config type Profile IDs Read scope Dedicated 4123、4124、4141、4146、4148、4185 M700/M800 tags only

Compatible 5123、5124、5141、5146、5148、5185 M700/M800 tags + standard tags

RfidProfile	Module support	Parameter details
PROFILE_Gen2X_4123	MODULE_U3 、MODULE_U4 、MODULE_U5	PR_ASK,pie: 2.0, tari_us: 20.0,lf_khz: 320k, PSK2
PROFILE_Gen2X_4124	MODULE_U4 、MODULE_U5	PR_ASK,pie: 2.0, tari_us: 7.5, lf_khz: 640k, BPSK2
PROFILE_Gen2X_4141	MODULE_U3 、MODULE_U4 、MODULE_U5	PR_ASK,pie: 2.0, tari_us: 20.0,lf_khz: 320k, BPSK4
PROFILE_Gen2X_4146	MODULE_U3 、MODULE_U4 、MODULE_U5	PR_ASK,pie: 2.0, tari_us: 20.0,lf_khz: 250k, BPSK4
PROFILE_Gen2X_4148	MODULE_U4 、MODULE_U5	PR_ASK,pie: 1.5, tari_us: 7.5, lf_khz: 640k, BPSK4
PROFILE_Gen2X_4185	MODULE_U3 、MODULE_U4 、MODULE_U5	PR_ASK,pie: 2.0, tari_us: 20.0,lf_khz: 160k, BPSK8
PROFILE_Gen2X_5123	MODULE_U3 、MODULE_U4 、MODULE_U5	PR_ASK,pie: 2.0, tari_us: 20.0,lf_khz: 320k, M+B2
PROFILE_Gen2X_5124	MODULE_U4 、MODULE_U5	PR_ASK,pie: 2.0, tari_us: 7.5, lf_khz: 640k, M+B2
PROFILE_Gen2X_5141	MODULE_U3 、MODULE_U4 、MODULE_U5	PR_ASK,pie: 2.0, tari_us: 20.0,lf_khz: 320k, M+B4
PROFILE_Gen2X_5146	MODULE_U3 、MODULE_U4 、MODULE_U5	PR_ASK,pie: 2.0, tari_us: 20.0,lf_khz: 250k, M+B4
PROFILE_Gen2X_5148	MODULE_U4 、MODULE_U5	PR_ASK,pie: 1.5, tari_us: 7.5, lf_khz: 640k, M+B4
PROFILE_Gen2X_5185	MODULE_U3 、MODULE_U4 、MODULE_U5	PR_ASK,pie: 2.0, tari_us: 20.0,lf_khz: 160k, M+B8

Tari/PIE/BLF/Miller overview：

Parameter Explanation Introduction

Tari	Class A reference interval — base time unit for reader-to-tag signaling. Forward link timing; smaller values mean higher data rate.
PIE	Pulse-interval encoding for reader-to-tag data. Smaller Tari → higher rate/shorter range; larger Tari → more robust/longer range/lower rate.
BLF	Backscatter link frequency — tag-to-reader data rate. Backscatter clock; higher BLF = faster reads but shorter range.
Miller	Miller subcarrier encoding for tag-to-reader data. Better noise immunity; Miller-2/4/8 — higher number = more robust, slower.

Chip support for API：

ModuleType moduleType = RFIDSDKManager.getInstance().getRfidManager().getModuleType();

moduleType == ModuleType.MODULE_U1 ...

Example

java

RfidProfile rfidProfile =
RFIDSDKManager.getInstance().getRfidManager().getProfile();

Parameter	Type	Description
session	int	Session (default `SESSION.S1`): - SESSION.S0 : 0; - SESSION.S1 : 1; - SESSION.S2 : 2; - SESSION.S3 : 3;; SESSION.S0 — few tags, higher per-tag read rate.; SESSION.S1 — large dynamic populations, discover new tags.; SESSION.S2/S3 — static tag lists using persistent session state。

Example

java

RFIDSDKManager.getInstance().getRfidManager().setInventoryWithSession(SESSION.S1);

Returns

Success:

SESSION.S0 : 0;
SESSION.S1 : 1;
SESSION.S2 : 2;
SESSION.S3 : 3;

Failure: other codes (see Error codes and types).

Example

java

int sesion =
RFIDSDKManager.getInstance().getRfidManager().getInventoryWithSession();

Parameter	Type	Description
target	int	- Target.TARGET_A - 0 : Only Flag A tags respond (Inventoried Flag = A) - Target.TARGET_B - 1 : Only Flag B tags respond (Inventoried Flag = B) - Target.TARGET_AB - 2 : Dynamic switching: first round — Flag A tags respond; later rounds — auto-switch to Flag B

Returns

Success: 0 -TARGET_A； 1 -TARGET_B； 2 -TARGET_AB . Failure: other codes (see Error codes and types).

Parameter	Type	Description
QvalueStart	Int	Initial Q (0–15, default 6) sets first-round slot count; adjusts dynamically. Decrease Q for sparse tags; increase for dense tags. Q is dynamic and adjusts during inventory.

Returns

Success: RfidErrorConstants.SUCCESS； Failure: other codes (see Error codes and types).

Parameter	Type	Description
password	String	Inventory query password — 2 words, hex string.

Returns

Returns inventory query password.

Parameter	Type	Description
rssi	int	Valid range 0–110. Filters out tags below this RSSI.

Returns

Supported: true; Not supported: false.

Parameter	Type	Description
unitType	RssiUnitType	`RELATIVE` — 40–110 (relative) `PERCENTAGE` — 0–100%

com.ubx.usdk.RfidManager

addMaskBits

Add inventory filter masks — only tags matching the mask are inventoried. Multiple masks may be added.

void addMask(int memMask, int startMask, int lenMask, String datasMask);

Parameter	Type	Description
memMask	int	Filter region: Tag memory bank: MemoryBank.RESERVED(RESERVED); MemoryBank.EPC (EPC); MemoryBank.TID (TID); MemoryBank.USER (USER)
startMask	int	Start bit index in hex string (differs from word-address params): Example — mask EPC data: EPC :E280FE9889895674 To mask substring"FE98"set start position to 12（bits） (EPC is preceded by CRC+PC) For TID or USER: USER (or TID)：00001234567898762345 To mask `"56789876"`, set start position to 32（bits）
lenMask	int	Mask length in bits (even hex character count): Example — mask EPC data: EPC :E280FE9889895674 To mask substring"FE98"set length to 16（bits） Or EPC:00001234567898762345 To mask substring"567898762345"set length to 48（bits）
datasMask	String	Filter data as hex string (even number of characters).

Example

java

Example:
Tag content:
Epc:123456789
Tid:234567891
To filter the TID region starting from the second hex character, use `4567` as filter data. Set:
memMask: MemoryBank.TID, startMask: 8, lenMask: 16, datasMask: 4567.
The code:
RFIDSDKManager.getInstance().getRfidManager().addMask(MemoryBank.TID,8,16,"4567")

Parameter	Type	Description
flag	boolean	`true` — include frequency and phase; `false` — exclude (default).

Returns

true — include frequency and phase; false — exclude frequency and phase;

Returns

Returns a List.

Returns

Returns a List.

Returns

Returns a List.

Query whether PC is included in inventory callbacks: boolean enable = RFIDSDKManager.getInstance().getRfidManager().getInventoryPCEnabled();

Returns

Success: RfidErrorConstants.SUCCESS； ( int) Failure: other codes (see Error codes and types).

Example

java

RFIDSDKManager.getInstance().getRfidManager().setInventoryPCEnabled(true);

Access via RFIDSDKManager.getInstance().getRfidManager()

Parameter	Type	Description
EPC	Stirng	Tag EPC (excluding CRC/PC). Hex string length must be a multiple of 4 (whole words).
password	String	Tag access password — 2 words, hex string.
memBank	int	Tag memory bank: MemoryBank.RESERVED (kill password words 0–1, access password words 2–3); MemoryBank.EPC (EPC); MemoryBank.TID (TID); MemoryBank.USER (USER)
startAdd	int	Start address in word units (16 bits per word).
wordCnt	int	Words to read (max 32 words per call; loop for larger reads).

Returns

TagResult fields:

code — RfidErrorConstants.SUCCESS on success; other codes on failure (see Error codes and types)
message — error description
data — tag data when code == RfidErrorConstants.SUCCESS

Parameter	Type	Description
EPC	String	Tag EPC (excluding CRC/PC). Hex string length must be a multiple of 4 (whole words).
password	String	Tag access password — 2 words, hex string.
memBank	int	Tag memory bank: MemoryBank.RESERVED(RESERVED); MemoryBank.EPC (EPC); MemoryBank.TID (TID); MemoryBank.USER (USER)
startAdd	int	Start address in word units (16 bits per word). When writing the EPC bank: 1. To change EPC length, write from PC (word address 1) and prepend the computed PC (Protocol Control) value. 2. If EPC length is unchanged, start at word address 2.
writeData	String	Data to write — hex string, length multiple of 4 (whole words). For large writes, loop with max 32 words per call.

Returns

Success: RfidErrorConstants.SUCCESS (int)

Failure: other codes (see Error codes and types).

Parameter	Type	Description
EPC	String	Tag EPC (excluding CRC/PC). Hex string length must be a multiple of 4 (whole words).
password	String	Tag access password — 2 words, hex string.
writeData	String	Data to write — hex string, length multiple of 4 (whole words).

Returns

Success: RfidErrorConstants.SUCCESS (int)

Failure: other codes (see Error codes and types).

Parameter	Type	Description
EPC	String	Hex string; length must be a multiple of 4 (whole words).
password	String	Tag access password — 2 words, hex string.

Returns

Success: RfidErrorConstants.SUCCESS (int)

Failure: other codes (see Error codes and types).

Parameter	Type	Description
EPC	String	Tag EPC (excluding CRC/PC). Hex string length must be a multiple of 4 (whole words).
password	String	Tag access password.
lockBank	int	LockMemBank.KILL_PW -- Kill password lock settings。 LockMemBank.ACCESS_PW -- Access password lock settings。 LockMemBank.EPC -- EPC memory lock settings。 LockMemBank.TID -- TID memory lock settings。 LockMemBank.USER -- USER memory lock settings。
lockType	int	Allowed values: LockType.SET_READABLE_OR_WRITABLE LockType.SET_ALWAYS_READ_ABLE_OR_WRITABLE LockType.SET_WITH_PASSWORD_READABLE_OR_WRITABLE LockType.SET_NEVER_READABLE_OR_WRITABLE Meaning depends on `lockBank` — see lockBank vs lockType table.

Returns

Success: RfidErrorConstants.SUCCESS (int)

Failure: other codes (see Error codes and types).

lockBank vs lockType：

	LockMemBank.KILL_PW
	LockMemBank.ACCESS_PW LockMemBank.TID
	LockMemBank.USER
LockType.SET_READABLE_OR_WRITABLE	Readable/writable Writable only
LockType.SET_ALWAYS_READ_ABLE_OR_WRITABLE	Permanently readable/writable Permanently writable
LockType.SET_WITH_PASSWORD_READABLE_OR_WRITABLE	Password-protected read/write Password-protected write
LockType.SET_NEVER_READABLE_OR_WRITABLE	Permanently locked Permanently not writable

Parameter	Type	Description
EPC	String	Tag EPC (excluding CRC/PC). Hex string length must be a multiple of 4 (whole words).
password	String	Kill password — 2 words, hex string.

Returns

Success: RfidErrorConstants.SUCCESS (int)

Failure: other codes (see Error codes and types).

Parameter	Type	Description
TID	String	Tag TID as hex string.
menBank	int	Tag memory bank: MemoryBank.RESERVED(RESERVED); MemoryBank.EPC (EPC); MemoryBank.TID (TID); MemoryBank.USER (USER)
startAdd	int	Start address in word units (16 bits per word).
wordCnt	int	Read length in words (max 32 words per call; loop for larger reads).
password	String	Tag access password — 2 words, hex string.

Returns

Returns read data on success; null on failure.

Parameter	Type	Description
TID	String	Tag TID as hex string.
memBank	int	Tag memory bank: MemoryBank.RESERVED(RESERVED); MemoryBank.EPC (EPC); MemoryBank.TID (TID); MemoryBank.USER (USER)
startAdd	int	Start address in word units (16 bits per word).
password	String	Tag access password — 2 words, hex string.
writeData	String	Data to write — hex string, length multiple of 4 (whole words).

Returns

Success: RfidErrorConstants.SUCCESS (int)

Failure: other codes (see Error codes and types).

Parameter	Type	Description
TID	String	Tag TID as hex string.
lockBank	int	LockMemBank.KILL_PW -- Kill password lock settings。 LockMemBank.ACCESS_PW -- Access password lock settings。 LockMemBank.EPC -- EPC memory lock settings。 LockMemBank.TID -- TID memory lock settings。 LockMemBank.USER -- USER memory lock settings。
lockType	int	Allowed values: LockType.SET_READABLE_OR_WRITABLE LockType.SET_ALWAYS_READ_ABLE_OR_WRITABLE LockType.SET_WITH_PASSWORD_READABLE_OR_WRITABLE LockType.SET_NEVER_READABLE_OR_WRITABLE Meaning depends on `lockBank` — see lockBank vs lockType table.
password	String	Tag access password — 2 words.

Returns

Success: RfidErrorConstants.SUCCESS (int)

Failure: other codes (see Error codes and types).

lockBank vs lockType：

	LockMemBank.KILL_PW
	LockMemBank.ACCESS_PW LockMemBank.TID
	LockMemBank.USER
LockType.SET_READABLE_OR_WRITABLE	Readable/writable Writable only
LockType.SET_ALWAYS_READ_ABLE_OR_WRITABLE	Permanently readable/writable Permanently writable
LockType.SET_WITH_PASSWORD_READABLE_OR_WRITABLE	Password-protected read/write Password-protected write
LockType.SET_PERMANENT_NOT_READABLE_OR_WRITABLE	Permanently locked Permanently not writable

com.ubx.usdk.RfidManager

killTagByTid

Permanently kill tag by TID. Kill password cannot be the default 00000000; change it first if still default.

int killTagByTid( String TID, String password);

Parameter	Type	Description
TID	String	Tag TID as hex string.
password	String	Kill password — 2 words, hex string.

Returns

Success: RfidErrorConstants.SUCCESS (int)

Failure: other codes (see Error codes and types).

Parameter	Type	Description
TID	String	Tag TID.
password	String	Tag access password — 2 words, hex string.
writeData	String	Data to write — hex string, length multiple of 4 (whole words).

Returns

Success: RfidErrorConstants.SUCCESS (int)

Failure: other codes (see Error codes and types).

Parameter	Type	Description
memBank	int	Target memory bank: MemoryBank.RESERVED(RESERVED); MemoryBank.EPC (EPC); MemoryBank.TID (TID); MemoryBank.USER (USER)
startAdd	int	Start address in word units (16 bits per word).
wordCnt	int	Read length in words (max 32 words per call; loop for larger reads).
password	String	Tag access password — 2 words, hex string.
memMask	int	Filter region: MemoryBank.RESERVED(RESERVED); MemoryBank.EPC (EPC); MemoryBank.TID (TID); MemoryBank.USER (USER)
startMask	int	Start bit index in hex string (differs from word-address params): Example — mask EPC data: EPC :E280FE9889895674 To mask substring"FE98"set start position to 48 (EPC is preceded by CRC+PC) For TID or USER: USER (or TID)：00001234567898762345 To mask `"56789876"`, set start position to 32
lenMask	int	Mask length (bits): Example — mask EPC data: EPC :E280FE9889895674 To mask substring"FE98"set length to 16(bits) Or EPC:00001234567898762345 To mask substring"567898762345"set length to 48 (bits)
datasMask	String	Filter data as hex string (even number of characters).

Returns

TagResult fields:

code — RfidErrorConstants.SUCCESS on success; other codes on failure (see Error codes and types)
message — error description
data — tag data when code == RfidErrorConstants.SUCCESS

Example

java

Example:
Tag content:
Epc:123456789999
Tid:23456789000055557777
User:345678912
**Example 1:**
**Operation：**
Read EPC from word 2 (3 words); filter TID from char 5 matching `"56"`.
**Parameter notes**：
RFIDSDKManager.getInstance().getRfidManager().maskReadTag(
MemoryBank.EPC, // Target bank: EPC
2, // Start word address: 2
3, // Read length: 3 words
"00000000", // Access password (default)
MemoryBank.TID, // Mask bank: TID
16, // Mask start: 16 bits
8, // Mask length: 8 bits
"56" // Match: `"56"`
)
**Example 2:**
**Operation：**
Read EPC from word 2 (3 words); filter EPC from char 13 matching `"6789"` (skip CRC+PC).
**Parameter notes：**
RFIDSDKManager.getInstance().getRfidManager().maskReadTag(
MemoryBank.EPC, // Target bank: EPC
2, // Start word address: 2
3, // Read length: 3 words
"00000000", // Access password (default)
MemoryBank.EPC, // Mask bank: EPC
52, // Mask start: char index 13
16, // Mask length: 16 bits
"6789" // Match: `"6789"`
)

Example 1:

Operation： Read EPC from word 2 (3 words); filter TID from char 5 matching "56". Parameter notes： RFIDSDKManager.getInstance().getRfidManager().maskReadTag( MemoryBank.EPC, // Target bank: EPC 2, // Start word address: 2 3, // Read length: 3 words "00000000", // Access password (default) MemoryBank.TID, // Mask bank: TID 16, // Mask start: 16 bits 8, // Mask length: 8 bits "56" // Match: "56" )

Example 2:

Operation： Read EPC from word 2 (3 words); filter EPC from char 13 matching "6789" (skip CRC+PC).

Parameter notes：

RFIDSDKManager.getInstance().getRfidManager().maskReadTag( MemoryBank.EPC, // Target bank: EPC 2, // Start word address: 2 3, // Read length: 3 words "00000000", // Access password (default) MemoryBank.EPC, // Mask bank: EPC 52, // Mask start: char index 13 16, // Mask length: 16 bits "6789" // Match: "6789" ) `

Parameter	Type	Description
writeData	String	Hex data to write.
memBank	int	Tag memory bank: MemoryBank.RESERVED(RESERVED); MemoryBank.EPC (EPC); MemoryBank.TID (TID); MemoryBank.USER (USER)
startAdd	int	Start address in word units (16 bits per word). When writing the EPC bank: To change EPC length, write from PC (word 1) with computed PC value prepended. 2. If EPC length is unchanged, start at word address 2.
wordCnt	int	Read length in words (max 32 words per call; loop for larger reads).
password	String	Tag access password — 2 words, hex string.
memMask	int	Filter region: MemoryBank.RESERVED(RESERVED); MemoryBank.EPC (EPC); MemoryBank.TID (TID); MemoryBank.USER (USER)
startMask	int	Mask start in bits (hex string character index): Example — mask EPC data: EPC :E280FE9889895674 To mask substring"FE98"set start position to 48 (EPC is preceded by CRC+PC) For TID or USER: USER (or TID)：00001234567898762345 To mask `"56789876"`, set start position to 32
lenMask	int	Mask length in bits: Example — mask EPC data: EPC :E280FE9889895674 To mask substring"FE98"set length to 16（bits） Or EPC:00001234567898762345 To mask substring"567898762345"set length to 48（bits）
datasMask	String	Filter data as hex string (even number of characters).

Returns

Success: RfidErrorConstants.SUCCESS (int)

Failure: other codes (see Error codes and types).

Example

java

Tag content:
EPC:123456789999
TID:234567890000555577778888
USER:34567891
**Example 1: Write EPC + filter TID**
**Requirement:**
Write `999999999999` to EPC (12 hex chars = 3 words).
Filter: TID from char index 3, length 2, match `"56"`.
**Parameter mapping：**
filter start startMask=12 (index 3 = 4th char)
filter length lenMask=8
**Sample code:**
RFIDSDKManager.getInstance().getRfidManager().maskWriteTag(
"999999999999", // data to write
MemoryBank.EPC, // target bank
2, // write start address (word 2 = 8-char offset)
3, // write length (3 words = 12 chars)
"00000000", // reserved parameter (fixed)
MemoryBank.TID, // filter bank
12, // filter start index (bits)
8, // filter mask length in bits
"56" // filter match value
);
**Example 2: Write USER + filter EPC**
**Requirement:**
Write `55555555` to USER (8 hex chars = 2 words).
Filter: EPC from char index 13, length 2, match `"67"`.
**Parameter mapping：**
filter start startMask=52 bits
filter length lenMask=8bits
**Sample code:**
RFIDSDKManager.getInstance().getRfidManager().maskWriteTag(
"55555555", // data to write
MemoryBank.USER, // target bank
0, // write start address (word 0 = USER start)
2, // write length (2 words = 8 hex chars)
"00000000", // reserved parameter (fixed)
MemoryBank.EPC, // filter bank
52, // filter start index (bits)
8, // filter mask length in bits
"67" // filter match value
);

Example 1: Write EPC + filter TID

Requirement: Write 999999999999 to EPC (12 hex chars = 3 words). Filter: TID from char index 3, length 2, match "56".

Parameter mapping：

filter start startMask=12 (index 3 = 4th char) filter length lenMask=8

Sample code:

RFIDSDKManager.getInstance().getRfidManager().maskWriteTag( "999999999999", // data to write MemoryBank.EPC, // target bank 2, // write start address (word 2 = 8-char offset) 3, // write length (3 words = 12 chars) "00000000", // reserved parameter (fixed) MemoryBank.TID, // filter bank 12, // filter start index (bits) 8, // filter mask length in bits "56" // filter match value );

Example 2: Write USER + filter EPC

Requirement: Write 55555555 to USER (8 hex chars = 2 words). Filter: EPC from char index 13, length 2, match "67".

Parameter mapping：

filter start startMask=52 bits filter length lenMask=8bits

Sample code:

RFIDSDKManager.getInstance().getRfidManager().maskWriteTag( "55555555", // data to write MemoryBank.USER, // target bank 0, // write start address (word 0 = USER start) 2, // write length (2 words = 8 hex chars) "00000000", // reserved parameter (fixed) MemoryBank.EPC, // filter bank 52, // filter start index (bits) 8, // filter mask length in bits "67" // filter match value ); `

Parameter	Type	Description
EPC	Stirng	Tag EPC (excluding CRC/PC). Hex string length must be a multiple of 4 (whole words).
memBank	int	Tag memory bank: MemoryBank.RESERVED(RESERVED); MemoryBank.EPC (EPC); MemoryBank.TID (TID); MemoryBank.USER (USER)
startAdd	int	Start address in word units (16 bits per word). When writing the EPC bank: To change EPC length, write from PC (word 1) with computed PC value prepended. 2. If EPC length is unchanged, start at word address 2.
wordCnt	int	Read length in words (max 32 words per call; loop for larger reads).
password	String	Tag access password — 2 words, hex string.

Returns

TagResult fields:

code — RfidErrorConstants.SUCCESS on success; other codes on failure (see Error codes and types)
message — error description
data — tag data when code == RfidErrorConstants.SUCCESS

Parameter	Type	Description
EPC	String	Tag EPC (excluding CRC/PC). Hex string length must be a multiple of 4 (whole words).
password	String	Tag access password — 2 words, hex string.
memBank	int	Tag memory bank: MemoryBank.RESERVED(RESERVED); MemoryBank.EPC (EPC); MemoryBank.TID (TID); MemoryBank.USER (USER)
startAdd	int	Start address in word units (16 bits per word). When writing the EPC bank: To change EPC length, write from PC (word 1) with computed PC value prepended. 2. If EPC length is unchanged, start at word address 2.
writeData	String	Data to write — hex string, length multiple of 4 (whole words).

Returns

Success: RfidErrorConstants.SUCCESS (int)

Failure: other codes (see Error codes and types).

Parameter	Type	Description
EPC	Stirng	Tag EPC (excluding CRC/PC). Hex string length must be a multiple of 4 (whole words).
password	String	Tag access password — 2 words, hex string.
memBank	int	Tag memory bank: MemoryBank.RESERVED (kill password words 0–1, access password words 2–3); MemoryBank.EPC (EPC); MemoryBank.TID (TID); MemoryBank.USER (USER)
startAdd	int	Erase start word address.
wordCnt	int	Erase length in words.

Returns

Success: RfidErrorConstants.SUCCESS (int)

Failure: other codes (see Error codes and types).

Parameter	Type	Description
selectEpc	String	Tag EPC.

Returns

Non-null Tag6C means a tag was found (int).

Use Tag6C.rssi for proximity. Call repeatedly on a background thread for rapid RSSI updates.

Configure RSSI format via setRssiUnitType(RssiUnitType unitType).

Use on a background thread; call repeatedly in a loop for rapid RSSI updates.

Configure RSSI format via setRssiUnitType(RssiUnitType unitType).

Parameter	Type	Description
EPC	String	Tag EPC.
password	String	Tag access password — 2 words, hex string.
milliseconds	int	Range 100–25500 ms in steps of 100 ms (e.g. 25500 ms → pass `255`).

Returns

Success: RfidErrorConstants.SUCCESS (int)

Failure: other codes (see Error codes and types).

Parameter	Type	Description
manufacturers	int	Manufacturer ID: 0 — KaiLuWei; 1 — YiLian
epcs	List<String>	EPC list of tags to light up.

Returns

Success: RfidErrorConstants.SUCCESS (int)

Failure: other codes (see Error codes and types).

Access via RFIDSDKManager.getInstance().getRfidManager()

Parameter	Type	Description
cntyCode	CountryCode	Regulatory region (region reference) e.g. CountryCode.ALB CountryCode.BEL ...

Returns

Success: RfidErrorConstants.SUCCESS (int)

Failure: other codes (see Error codes and types).

Example

java

int ret = RFIDSDKManager.getInstance().getRfidManager()
.setWorkRegion(CountryCode.ALB);

com.ubx.usdk.RfidManager

getWorkRegion

Get the current regulatory region/frequency band. If null, setWorkRegion() may not have been called — use getFrequencyRegion() instead.

CountryCode getWorkRegion();

Returns

Success:CountryCode non-null; (CountryCode ) Failure:CountryCode is null;

Parameter	Type	Description
region	FrequencyRegion	Frequency region type. FrequencyRegion.UKRAINE;//Ukraine band FrequencyRegion.CHINESE1;//Chinese band 1 FrequencyRegion.EU;//EU band FrequencyRegion.CHINESE2;//Chinese band 2 FrequencyRegion.US;//US band FrequencyRegion.KOREAN;//Korean band FrequencyRegion.PERU;//Peru band FrequencyRegion.US3;//US band3 FrequencyRegion.Taiwan;//Taiwan band See frequency band reference
btStartIndex	int	Start channel index.
btEndIndex	int	End channel index. Rules: start ≤ end; both within allowed band; equal start/end = single channel.

Returns

Success: RfidErrorConstants.SUCCESS (int)

Failure: other codes (see Error codes and types).

Example

java

int ret =
RFIDSDKManager.getInstance().getRfidManager().setFrequencyRegion(FrequencyRegion.US, FrequencyRegion.US.getMinChannelIndex(),FrequencyRegion.US.getMaxChannelIndex());

Returns

FrequencyRegion frequencyRegion = (FrequencyRegion ) RFIDSDKManager.getInstance().getRfidManager().getFrequencyRegion();

Get band region:frequencyRegion.getbtRegion()
Get start channel index:frequencyRegion.getMinChannelIndex()
Get end channel index:frequencyRegion.getMaxChannelIndex()
Compute start frequency (MHz):

float startFreq = frequencyRegion.getStartFreqMHz() + frequencyRegion.getMinChannelIndex() * frequencyRegion.getStepSizeMHz()

Compute end frequency (MHz):

float endFreq = frequencyRegion.getStartFreqMHz() + frequencyRegion.getMaxChannelIndex() * frequencyRegion.getStepSizeMHz() If frequencyRegion is null, the read failed.

Returns

RFID module firmware version string (String).

Parameter	Type	Description
enable	int	0 — off; 1 — on

Returns

Success: RfidErrorConstants.SUCCESS (int)

Failure: other codes (see Error codes and types).

Returns

Success: RfidErrorConstants.SUCCESS-off; 1 — on; (int) Failure: other codes (see Error codes and types).

Returns

Module information (String).

Returns

Success: value > 0 (int).

Failure: -1.

Returns

Temperature string in degrees Celsius (String).

Parameter	Type	Description
flags	int	Persist after power-off: 0 — save; 1 — do not save.
int	FreSpace	Channel spacing (KHz); must be a multiple of 125.
int	FreNum	Channel count.
int	StartFre	Start frequency (KHz).

Returns

Success: RfidErrorConstants.SUCCESS (int)

Failure: other codes (see Error codes and types).

Note: After a custom band is set, getFrequencyRegion() no longer returns standard band info.

Returns

CustomRegionBean customRegion = rfidManager.getCustomRegion(); (CustomRegionBean ) if (customRegion != null) { // Extract fields int band = customRegion.band[0]; // Band region int stepKHz = customRegion.FreSpace[0]; // Channel spacing (KHz) int channelCount = customRegion.FreNum[0]; //Channel count. int startFreqKHz = customRegion.StartFre[0]; //Start frequency (KHz). } else { System.err.println("Failed to get custom region configuration!"); }

Returns

RFID chip info (ExVersionInfo):

code — RfidErrorConstants.SUCCESS on success
versionInfo — chip firmware version
type — EXChipType.E310/E510/E710/OTHER

Parameter	Type	Description
enable	boolean	`true` — enable logging; `false` — disable.

Recommended: call UlogManager.enableLog(true) once before using the SDK. Logs: /sdcard/Download/rfidLog (storage permission required).

Parameter

Returns

Device type (int):

ReaderDeviceType.UNKNOWN — unknown
INTEGRATED — integrated reader
PERIPHERAL_UART — UART peripheral
BLE_DEVICE — Bluetooth device

Returns

ModuleTypeDescription : ( int) ModuleType.OTHER ModuleType.U1 ModuleType.U2 ModuleType.U3 ModuleType.U4 ModuleType.U5 }

Access via RFIDSDKManager.getInstance().getRfidManager()

Parameter	Type	Description
enable	boolean	`true` — on; `false` — off.

Returns

Success: RfidErrorConstants.SUCCESS (int)

Failure: other codes (see Error codes and types).

Parameter	Type	Description
volume	int	Range 1–10 (default 4); 1 = quietest, 10 = loudest.

Returns

Success: RfidErrorConstants.SUCCESS (int)

Failure: other codes (see Error codes and types).

Access via RFIDSDKManager.getInstance().getRfidManager()

APIs in this section apply to the FR1000 fixed reader only; handheld PDAs do not support them.

Parameter	Type	Description
antennaStatus	AntennaStatus	AntennaStatus { //false = disconnected, true = connected boolean ant1 = false; boolean ant2 = false; boolean ant3 = false; boolean ant4 = false; boolean ant5 = false; boolean ant6 = false; boolean ant7 = false; boolean ant8 = false; } Antenna 1–8 connection status.

Returns

Success: non-null AntennaStatus.

Failure: null.

Example

java

AntennaStatus result =
RFIDSDKManager.getInstance().getRfidManager().checkAntennaStatus();

Parameter	Type	Description
antennaSet	AntennaSet	AntennaSet { boolean ant1 = false;//false = disabled, true = enabled boolean ant2 = false; boolean ant3 = false; boolean ant4 = false; boolean ant5 = false; boolean ant6 = false; boolean ant7 = false; boolean ant8 = false; } Antenna 1–8 enable flags; at least one must be enabled.

Returns

Success: RfidErrorConstants.SUCCESS (int)

Failure: other codes (see Error codes and types).

Example

java

RFIDSDKManager.getInstance().getRfidManager().setInventoryAntennaMultiplexing(antennaSet);

**To query enabled inventory antennas:**
ResultAntenna result =
RFIDSDKManager.getInstance().getRfidManager().getInventoryAntennaMultiplexing();
Where:
result.code :
RfidErrorConstants.SUCCESS — success
Other codes — failure (see **Error codes and types**)
AntennaSet antennaSet = result.antennaSet;
`antennaSet` — enabled inventory antennas.

Parameter	Type	Description
antennaSet	AntennaSet	AntennaSet { boolean ant1 = false;//false = disabled, true = enabled boolean ant2 = false; boolean ant3 = false; boolean ant4 = false; boolean ant5 = false; boolean ant6 = false; boolean ant7 = false; boolean ant8 = false; } Antenna 1–8 enable flags; at least one must be enabled.

Returns

Success: RfidErrorConstants.SUCCESS (int)

Failure: other codes (see Error codes and types).

Example

java

RFIDSDKManager.getInstance().getRfidManager().setAccessAntennaMultiplexing(antennaSet);

**To query enabled Access antennas:**
ResultAntenna result =
RFIDSDKManager.getInstance().getRfidManager().getAccessAntennaMultiplexing();
Where:
result.code :
RfidErrorConstants.SUCCESS — success
Other codes — failure (see **Error codes and types**)
AntennaSet antennaSet = result.antennaSet;
`antennaSet` — enabled Access antennas.

*Notes:*

SDK initialized via init() or initBTtoMac().

Firmware package: ZIP as provided — do not extract, rename, or reformat.

Use ApplicationContext for checks; Activity Context when showUI=true.

BLE upgrade on Android 12+ requires BLUETOOTH_CONNECT.

Not thread-safe — one check/upgrade flow at a time.
BLE sled upgrade requires additional configuration.

*Additional dependencies:*

implementation 'no.nordicsemi.android:dfu:2.9.0' implementation 'com.google.code.gson:gson:2.11.0'

*ProGuard rules:*

-keep class no.nordicsemi.*{;}

*Add to AndroidManifest.xml:*

<uses-permission android:name="android.permission.FOREGROUND_SERVICE"/>

<uses-permission android:name="android.permission.FOREGROUND_SERVICE_CONNECTED_DEVICE"/>

*Class:RFUpgradeManager.getInstance();*

Flow:

checkUpgrade() → [user confirmation] → startUpgrade()

Access via RFUpgradeManager.getInstance()

Parameter	Type	Description
context	Context	Context
source	UpgradeSource	RFUpgradeManager.UpgradeSource source = null; From assets (relative path), e.g. `"bin/xxxx.zip" source = RFUpgradeManager.UpgradeSource.fromAssets("bin/" + "xxxx.zip"); From local filesystem (must exist and be readable): source = RFUpgradeManager.UpgradeSource.fromLocalPath(getFilesDir()+"/files/"+"xxxx.zip");
myCallback	FWUpdateCallback	See description below

Example

java

RFUpgradeManager.getInstance().checkUpgrade(
context,RFUpgradeManager.UpgradeSource.fromAssets("bin/your_firmware.zip"),
new FirmwareUpgradeCallback() {
@Override
public void onCheckResult(UpgradeCheckResult result, UpgradeInfo info) {
if (!result.checkPassed) {
// Handle failure: result.errorMessage
return;
}
if (!result.hasUpgrade) {
// Already up to date
return;
}
// Upgrade available — show details from info
RFUpgradeManager.getInstance().showConfirmDialog(
activity, info, "", "", confirmListener);
}
// onStepChanged / onUpgradeFinished / onError ...
});

FWUpdateCallback methods:

onCheckResult(UpgradeCheckResult, UpgradeInfo) — after checkUpgrade().

onStepChanged(UpgradeStepEvent) — during startUpgrade().

onUpgradeFinished(boolean, String) — upgrade finished:

success: true — succeeded; false — failed.

message — success or failure reason.

onError(int, String) — error during check or upgrade.

Results are delivered via onCheckResult(result, info).

UpgradeCheckResult

Key fields:

checkPassed — check/extract passed

hasUpgrade — firmware upgrade available

errorMessage — reason when checkPassed=false

errorCode — 0 means no error

Decision logic:

checkPassed=true && hasUpgrade=false — up to date; do not call startUpgrade().

checkPassed=true && hasUpgrade=true — info has firmware/device details.

checkPassed=false — do not call startUpgrade() (info == null).

*errorCode reference:*

Error code	Constant	Meaning
-1001	`ERROR_CHECK_NOT_DONE`	Check/extract not run or cache empty
-1002	`ERROR_CHECK_FAILED`	Check failed, invalid params, missing firmware, etc.
-1003	`ERROR_NO_UPGRADE`	No upgrade required (for `startUpgrade`)
-1004	`ERROR_ANDROID_BATTERY_LOW`	Host battery ≤ 20%
-1005	`ERROR_GRIP_BATTERY_LOW`	Sled battery ≤ 10% (BLE/UART only)
-1006	`ERROR_INVALID_FIRMWARE_PACKAGE`	Invalid firmware package (including 0 KB file)

com.ubx.usdk.RFUpgradeManager

checkUpgradeFromServer

Check online whether a firmware upgrade is available. Requires network connectivity and INTERNET permission. Required permission: <uses-permission android:name="android.permission.INTERNET"/>

Void checkUpgradeFromServer(Context context, boolean showUI,, FirmwareUpgradeCallback callback);

Parameter	Type	Description
context	Context	Context
showUI	boolean	`true` — show progress UI; `false` — callback only.
myCallback	FWUpdateCallback	See description below

Returns

(void)

Example

java

RFUpgradeManager.*getInstance*().checkUpgradeFromServer(this,true,
new FirmwareUpgradeCallback() {
@Override
public void onCheckResult(UpgradeCheckResult result, UpgradeInfo info) {
if (!result.checkPassed) {
// Handle failure: result.errorMessage
return;
}
if (!result.hasUpgrade) {
// Already up to date
return;
}
// Upgrade available — show details from info
RFUpgradeManager.getInstance().showConfirmDialog(
activity, info, "", "", confirmListener);
}
// onStepChanged / onUpgradeFinished / onError ...
});

FWUpdateCallback methods:

onCheckResult(UpgradeCheckResult, UpgradeInfo) — after checkUpgrade().

onStepChanged(UpgradeStepEvent) — during startUpgrade().

onUpgradeFinished(boolean, String) — upgrade finished:

success: true — succeeded; false — failed.

message — success or failure reason.

onError(int, String) — error during check or upgrade.

Results are delivered via onCheckResult(result, info).

UpgradeCheckResult

Key fields:

checkPassed — check/extract passed

hasUpgrade — firmware upgrade available

errorMessage — reason when checkPassed=false

errorCode — 0 means no error

Decision logic:

checkPassed=true && hasUpgrade=false — up to date; do not call startUpgrade().

checkPassed=true && hasUpgrade=true — info has firmware/device details.

checkPassed=false — do not call startUpgrade() (info == null).

*errorCode reference:*

Error code	Constant	Meaning
-1101	`ERROR_REMOTE_CHECK_HTTP`	Online check HTTP failure (non-2xx)
-1102	`ERROR_REMOTE_CHECK_REQUEST`	Online check network/request failure
-1103	`ERROR_REMOTE_CHECK_SERVER_CODE`	Online check server business code non-zero
-1104	`ERROR_REMOTE_CHECK_RESPONSE_INVALID`	Invalid online check response (missing `udpUrl`/`packageVersion`)
-1201	`ERROR_REMOTE_DOWNLOAD_URL_EMPTY`	Download URL empty
-1202	`ERROR_REMOTE_DOWNLOAD_HTTP`	Download HTTP failure (non-2xx)
-1203	`ERROR_REMOTE_DOWNLOAD_IO`	Download I/O or connection error
-1204	`ERROR_REMOTE_DOWNLOAD_SIZE_MISMATCH`	Download size mismatch (`fileSize`)
-1205	`ERROR_REMOTE_DOWNLOAD_MD5_MISMATCH`	Download MD5 mismatch (`md5Value`)

Start upgrade

Prerequisite: successful checkUpgrade() with checkPassed=true and hasUpgrade=true.

com.ubx.usdk.RFUpgradeManager

startUpgrade

Start firmware upgrade. Host battery must be > 20%; sled battery > 10% (BLE/UART). Any failed check invokes onError immediately without starting upgrade.

void startUpgrade(Context context, boolean showUI, FirmwareUpgradeCallback callback );

Parameter	Type	Description
context	Context	When `showUI=true`, must be an Activity `Context` (not `ApplicationContext`).
showUI	boolean	`true` — show progress UI; `false` — callback only.
callback	FirmwareUpgradeCallback	May be `null`; recommended when `showUI=true` for completion notification.

Example

java

RFUpgradeManager.getInstance().startUpgrade(
MainActivity.this, true, upgradeCallback);

Notes:

Upgrade runs in background (may take minutes); UI keeps screen on.

BLE sled: pairing check before BLE firmware (up to 5 minutes).

After MCU upgrade, user may need to power on sled manually; SDK retries connection.

Do not call checkUpgrade / startUpgrade during an active upgrade.

Avoid finish() or rotation during upgrade — lock orientation.

Restart the app after upgrade.

Access via GripDeviceManager.getInstance()

Bluetooth / UART peripheral APIs (non-integrated devices)

Devices: RFG91 UART peripheral and Bluetooth devices only.

Features: barcode results, device status callbacks, device info, settings.

Prerequisite: successful init (see Entry and lifecycle).

Barcode scan results

Receive barcode scan results.

Parameter	Type	Description
cb	BarcodeCallback	Callback

Example

java

GripDeviceManager.getInstance().registerBarcodeCallback(new BarcodeCallback() {
@Override
public void onResult(byte[] barcode) {
// Barcode scan result
}
});

On RFG91, the scan key does not trigger RFID by default — listen here and call inventory APIs to bind key actions.

Example

java

GripDeviceManager.getInstance().setKeyEventListener(new KeyEventListener() {
@Override
public void event(int keyCode, boolean isDown) {
//keyCode== BTKeyEvent.BT_SCAN The handle button was pressed
//isDown true: down false: up
if (keyCode == BTKeyEvent.BT_SCAN) {
if (isDown ) {
//start Inventory
//RFIDSDKManager.getInstance().getRfidManager().startInventory(1);
} else {
//stop Inventory
//RFIDSDKManager.getInstance().getRfidManager().stopInventory();
}
}
}
});

com.ubx.usdk.GripDeviceManager

setBatteryGripListener

Register battery/charging callback (fires on change only). For immediate values, call getIsChange() and getElectricQuantity().

void setBatteryGripListener(BatteryGripListener cb);

Parameter	Type	Description
cb	BatteryGripListener	Device charging status and battery callback: `new BatteryGripListener() { ... }` // change: 0 = not charging, 1 = charging // percent: battery 0–100%

Example

java

GripDeviceManager.getInstance().setBatteryGripListener(new BatteryGripListener() {
@Override
public void isChange(int change) {
// change: 0 = not charging, 1 = charging
}
@Override
public void level(int percent) {
// percent: battery 0–100%
}
});

Parameter	Type	Description
enable	boolean	`true` — start scan; `false` — stop scan.

Example

java

String sn= GripDeviceManager.getInstance().getDeviceSN();

Parameter	Type	Description
beep	int	Range 0–10; 0 disables beeper.

Returns

Success: RfidErrorConstants.SUCCESS (int)

Failure: other codes (see Error codes and types).

Example

java

int ret = GripDeviceManager.getInstance().setBeepRange(10);

Returns

Beeper volume (int); values < 0 indicate failure.

Example

java

int beepValue = GripDeviceManager.getInstance().getBeepRange();

Parameter	Type	Description
time	int	Range 0–3600 s; 0 — never sleep.

Returns

Success: RfidErrorConstants.SUCCESS (int)

Failure: other codes (see Error codes and types).

Example

java

int ret = GripDeviceManager.getInstance().setSleepTime(60);

Returns

Sleep timeout (int); values < 0 indicate failure.

Example

java

int sleepValue = GripDeviceManager.getInstance().getSleepTime();

Parameter	Type	Description
offTime	int	Range 0–3600 s; 0 — never auto power-off.

Returns

Success: RfidErrorConstants.SUCCESS (int)

Failure: other codes (see Error codes and types).

Example

java

int ret = GripDeviceManager.getInstance().setPowerOffTime(600);

Returns

Auto power-off timeout (int); values < 0 indicate failure.

Example

java

int OFFValue =
GripDeviceManager.getInstance().getPowerOffTime();

Returns

Success: returns MAC address, e.g. 41:BB:00:F8:DB:51.

Example

java

String mac= GripDeviceManager.getInstance().getBLEMac();

Parameter	Type	Description
mode	int	Range 0–1; 0 — offline off; 1 — offline on.

Returns

Success: RfidErrorConstants.SUCCESS (int)

Failure: other codes (see Error codes and types).

Example

java

int ret = GripDeviceManager.getInstance().setOfflineModeOpen(1);

Returns

Offline mode status (int):

0 — offline mode off
1 — offline mode on

Example

java

int value =
GripDeviceManager.getInstance().getOfflineModeOpen();

Parameter	Type	Description
mode	int	Range 0–1; 0 — no auto-clear; 1 — auto-clear after transfer.

Returns

Success: RfidErrorConstants.SUCCESS (int)

Failure: other codes (see Error codes and types).

Example

java

int ret =
GripDeviceManager.getInstance().setOfflineTransferClearData(1);

Returns

Offline auto-clear status (int):

0 — do not clear after transfer
1 — clear after transfer

Example

java

int value =
GripDeviceManager.getInstance().getOfflineTransferClearData();

Parameter	Type	Description
delay	int	Valid values:0-10000ms

Returns

Success: RfidErrorConstants.SUCCESS (int)

Failure: other codes (see Error codes and types).

Example

java

int ret =
GripDeviceManager.getInstance().setOfflineTransferDelay(0);

Returns

Returns array：int[] numArr (int[]) Non-empty numArr means success:

numArr[0] — cached RFID count
numArr[1] — cached barcode count

Empty or zero-length numArr means failure.

Example

java

int[] numArr=
GripDeviceManager.getInstance().getOfflineQueryNum();

Returns

Returns array：double[] memArr (int) Non-empty memArr means success:

memArr[0] — RFID cache usage ratio
memArr[1] — barcode cache usage ratio

Empty memArr means failure.

Example

java

double[] memArr=
GripDeviceManager.getInstance().getOfflineQueryMem();

Returns

Success: RfidErrorConstants.SUCCESS (int)

Failure: other codes (see Error codes and types).

Example

java

int value =
GripDeviceManager.getInstance().offlineManaulClearScanData();

Returns

Success: RfidErrorConstants.SUCCESS (int)

Failure: other codes (see Error codes and types).

Example

java

int value =
GripDeviceManager.getInstance().offlineManaulClearRFIDData();

Returns

Success: RfidErrorConstants.SUCCESS (int)

Failure: other codes (see Error codes and types).

Example

java

int ret=
GripDeviceManager.getInstance().offlineStartTransferRFID();

Returns

Success: RfidErrorConstants.SUCCESS (int)

Failure: other codes (see Error codes and types).

Example

java

int ret=
GripDeviceManager.getInstance().offlineStartTransferScan();

Returns

Success: RfidErrorConstants.SUCCESS (int)

Failure: other codes (see Error codes and types).

Example

java

int ret= GripDeviceManager.getInstance().modeResetFactory();

Enabling Gen2X:

Gen2X is Impinj's high-performance read mode optimized for M700 and M800 series tags. Choose one of two read strategies:

Config type	Profile IDs	Read scope
Dedicated	4123, 4124, 4141, 4146, 4148, 4185	M700/M800 tags only
Compatible	5123, 5124, 5141, 5146, 5148, 5185	M700/M800 tags + standard tags

Note: You must set the Profile to one of the 12 values above before Gen2X features take effect.

Access via RFIDSDKManager.getInstance().getRfidManager()

Equivalent to setProfile(RfidProfile) with a different parameter type.

Note: Profile changes only when set explicitly. After using a Gen2X Profile, switch back to a standard Profile when leaving Gen2X features.

Returns

Success:0；Failure:other； (int)

Supported Gen2X Profile details

"1: PR_ASK, pie: 2.0, tari_us: 7.5, lf_khz: 640, M: 2",

"3: PR_ASK, pie: 2.0, tari_us: 20.0,lf_khz: 320, M: 2",

"5: PR_ASK, pie: 2.0, tari_us: 20.0,lf_khz: 320, M: 4",

"7: PR_ASK, pie: 2.0, tari_us: 20.0,lf_khz: 250, M: 4",

"11: PR_ASK, pie: 2.0, tari_us: 7.5, lf_khz: 640, M: 1",

"12: PR_ASK, pie: 2.0, tari_us: 15.0,lf_khz: 320, M: 2",

"13: PR_ASK, pie: 2.0, tari_us: 20.0,lf_khz: 160, M: 8",

"15: PR_ASK, pie: 2.0, tari_us: 7.5, lf_khz: 640, M: 4",

"102:PR_ASK, pie: 2.0, tari_us: 7.5, lf_khz: 640, M: 0",

"103:DSB, pie: 1.5, tari_us: 6.25,lf_khz: 640, M: 0",

"104:DSB, pie: 1.5, tari_us: 6.25,lf_khz: 320, M: 1",

"120:DSB, pie: 1.5, tari_us: 6.25,lf_khz: 640, M: 2",

"123:PR_ASK, pie: 2.0, tari_us: 20.0,lf_khz: 320, M: 2",

"124:PR_ASK, pie: 2.0, tari_us: 7.5, lf_khz: 640, M: 2",

"125:PR_ASK, pie: 2.0, tari_us: 15.0,lf_khz: 320, M: 2",

"126:PR_ASK, pie: 1.5, tari_us: 12.5,lf_khz: 320, M: 2",

"141:PR_ASK, pie: 2.0, tari_us: 20.0,lf_khz: 320, M: 4",

"146:PR_ASK, pie: 2.0, tari_us: 20.0,lf_khz: 250, M: 4",

"147:PR_ASK, pie: 2.0, tari_us: 7.5, lf_khz: 640, M: 4",

"148:PR_ASK, pie: 1.5, tari_us: 7.5, lf_khz: 640, M: 4",

"185:PR_ASK, pie: 2.0, tari_us: 20.0,lf_khz: 160, M: 8",

"202:PR_ASK, pie: 2.0, tari_us: 15.0,lf_khz: 426, M: 0",

"203:PR_ASK, pie: 1.5, tari_us: 12.5,lf_khz: 426, M: 0",

"205:PR_ASK, pie: 2.0, tari_us: 20.0,lf_khz: 50, M: 1",

"222:PR_ASK, pie: 2.0, tari_us: 20.0,lf_khz: 320, M: 2",

"223:PR_ASK, pie: 2.0, tari_us: 15.0,lf_khz: 320, M: 2",

"224:PR_ASK, pie: 1.5, tari_us: 12.5,lf_khz: 320, M: 2",

"225:PR_ASK, pie: 2.0, tari_us: 15.0,lf_khz: 426, M: 2",

"226:PR_ASK, pie: 1.5, tari_us: 12.5,lf_khz: 426, M: 2",

"241:PR_ASK, pie: 2.0, tari_us: 20.0,lf_khz: 320, M: 4",

"244:PR_ASK, pie: 2.0, tari_us: 20.0,lf_khz: 250, M: 4",

"285:PR_ASK, pie: 2.0, tari_us: 20.0,lf_khz: 160, M: 8",

"302:PR_ASK, pie: 2.0, tari_us: 7.5, lf_khz: 640, M: 0",

"323:PR_ASK, pie: 2.0, tari_us: 7.5, lf_khz: 640, M: 2",

"324:PR_ASK, pie: 2.0, tari_us: 20.0,lf_khz: 320, M: 2",

"325:PR_ASK, pie: 2.0, tari_us: 15.0,lf_khz: 320, M: 2",

"326:PR_ASK, pie: 1.5, tari_us: 12.5,lf_khz: 320, M: 2",

"342:PR_ASK, pie: 2.0, tari_us: 20.0,lf_khz: 320, M: 4",

"343:PR_ASK, pie: 2.0, tari_us: 20.0,lf_khz: 250, M: 4",

"344:PR_ASK, pie: 2.0, tari_us: 7.5 ,lf_khz: 640, M: 4",

"345:PR_ASK, pie: 1.5, tari_us: 7.5 ,lf_khz: 640, M: 4",

"382:PR_ASK, pie: 2.0, tari_us: 20.0,lf_khz: 160, M: 8",

"4123:PR_ASK,pie: 2.0, tari_us: 20.0,lf_khz: 320, PSK2",

"4124:PR_ASK,pie: 2.0, tari_us: 7.5, lf_khz: 640, BPSK2"

"4141:PR_ASK,pie: 2.0, tari_us: 20.0,lf_khz: 320, BPSK4"

"4146:PR_ASK,pie: 2.0, tari_us: 20.0,lf_khz: 250, BPSK4"

"4148:PR_ASK,pie: 1.5, tari_us: 7.5, lf_khz: 640, BPSK4"

"4185:PR_ASK,pie: 2.0, tari_us: 20.0,lf_khz: 160, BPSK8"

"5123:PR_ASK,pie: 2.0, tari_us: 20.0,lf_khz: 320, M+B2",

"5124:PR_ASK,pie: 2.0, tari_us: 7.5, lf_khz: 640, M+B2",

"5141:PR_ASK,pie: 2.0, tari_us: 20.0,lf_khz: 320, M+B4",

"5146:PR_ASK,pie: 2.0, tari_us: 20.0,lf_khz: 250, M+B4",

"5148:PR_ASK,pie: 1.5, tari_us: 7.5, lf_khz: 640, M+B4",

"5185:PR_ASK,pie: 2.0, tari_us: 20.0,lf_khz: 160, M+B8"

Returns

Current Profile value (int)

com.ubx.usdk.RfidManager

setImpinjScanParam

Configure Impinj Scan parameters (Ex10 series only). After setting, call inventory APIs to scan.

public int setImpinjScanParam(int opt,int N,int Code,int CR,int Protection,int ID, int CopyTo)

Parameter	Type	Description
opt	int	0 — persist after power-off; 1 — volatile
N	int	Default `0x0F`.
Code	int	0-Rfu;1-Antipodal;2-CCOneHalf;3-CCThreeQuarters.
CR	int	0-ID32;1-ID16;2-StoredCRC;3-RN16.
Protection	int	0-NoProtection;1-Parity;2-CRC5;3-CRC5Plus.
ID	int	0-NoAckResponse; 1-TMNPlusTSN; 2-Part EPC;3-Full.
CopyTo	int	0-All tag;1-S=1 tags only.

Returns

0 — success; non-zero — failure (see error code table). (int)

com.ubx.usdk.RfidManager

getImpinjScanParam

Read Impinj Scan parameters (Ex10 series only). int[] aar = RFIDSDKManager.getInstance().getRfidManager().getImpinjScanParam();

public int[] getImpinjScanParam()

Parameter	Type	Description
N --> aar[0]	int	Default `0x0F`.
Code--> aar[1]	int	0-Rfu;1-Antipodal;2-CCOneHalf;3-CCThreeQuarters.
CR--> aar[2]	int	0-ID32;1-ID16;2-StoredCRC;3-RN16.
Protection--> aar[3]	int	0-NoProtection;1-Parity;2-CRC5;3-CRC5Plus.
ID--> aar[4]	int	0-NoAckResponse; 1-TMNPlusTSN; 2-Part EPC;3-Full.
CopyTo--> aar[5]	int	0-All tag;1-S=1 tags only.

Returns

0 — success; non-zero — failure (see error code table). (int) When return is 0, read values from the output array parameters.

Parameter	Type	Description
MatchType	int	0 — match; 1 — invert match
matchDataList	List<MatchData>	Mask list (max 5). Empty list clears masks. class MatchData { int memBank = 0;//Memory bank int maskStart = 0;//Mask start bit offset int maskLen = 0;//Mask length in bits String maskData = "";//Mask data }

Returns

0 — success; non-zero — failure (see error code table). (int)

com.ubx.usdk.RfidManager

protectedMode

Enable or disable tag protected (privacy) mode. Change the access password first and use the same password when enabling privacy mode.

public int protectedMode(String EPCStr, int enable, String Password);

Parameter	Type	Description
EPCStr	String	Selected tag EPC
enable	int	0 — disable privacy mode; 1 — enable
Password	String	Access password (must match the password set before enabling privacy)

Returns

Success:0； (int) Failure:Other。

Parameter	Type	Description
Opt	int	0 — persist after power-off; 1 — volatile
enableFlag	int	0 — off; 1 — on
strPassword	String	4-byte access password used internally by reader privacy mode

Returns

0 — success; non-zero — failure (see error code table). (int)

Returns

On success, returns String[]: (int) String enable = aar[0];//0 — off; 1 — on String password= aar[1];//4-byte access password used internally by reader privacy mode Returns null on failure.

Parameter	Type	Description
epcNum	int	EPC length in words; use mask mode when value is 255.
strEPC	String	Tag EPC in `epcNum` words.
strPassword	String	4-byte tag access password.
MaskMemInt	int	Mask memory bank: 1 — EPC bank 2 — TID bank 3 — USER bank
btWordAdd	int	Mask start bit address (0–16383). Example: for EPC `E28011113333`, mask `1111` starts at bit 12 (after the 2-word E280 prefix).
MaskLength	int	Mask length in bits (e.g. `1111` → 4).
strMaskData	String	Mask data — even-length hex string.
srBit	int	Short-range bit index: Impinj M700/M800: SRBit = 4; Impinj MR6-X: SRBit = 1;
srValue	int	0 — Short-range off; 1 — Short-range on.

Returns

0 — success; non-zero — failure (see error code table). (void)

Parameter	Type	Description
epcNum	int	EPC length in words; use mask mode when value is 255.
strEPC	String	Tag EPC in `epcNum` words.
strPassword	String	4-byte tag access password.
MaskMemInt	int	Mask memory bank: 1 — EPC bank 2 — TID bank 3 — USER bank
btWordAdd	int	Mask start bit address (0–16383). Example: for EPC `E28011113333`, mask `1111` starts at bit 12 (after the 2-word E280 prefix).
MaskLength	int	Mask length in bits (e.g. `1111` → 4).
strMaskData	String	Mask data — even-length hex string.
srBit	int	Short-range bit index: Impinj M700/M800: SRBit = 4; Impinj MR6-X: SRBit = 1;

Returns

0 — Short-range off; 1 — Short-range on (void).

Other values — failure (see error code table).

FR1000 fixed reader only.

Access via GpioController.getInstance()

GPO output: int out — 0 = low, 1 = high.

GPI input example:

java

GpioController.getInstance().setGpioInputListener(new GpioController.GpioInputListener() {
    @Override public void onInput1Changed(int state) { /* GPI1: 0=low 1=high */ }
    @Override public void onInput2Changed(int state) { }
    @Override public void onInput3Changed(int state) { }
    @Override public void onInput4Changed(int state) { }
});
GpioController.getInstance().startMonitoring();

RfidErrorConstants

Use RfidErrorConstants.getDescription(errorCode) for human-readable descriptions.

Error code	Description
(RfidErrorConstants)
SUCCESS(0)	Operation succeeded.
TAG_NOT_FOUND(1)	No tag found.
INSUFFICIENT_POWER(2)	Insufficient tag power for memory write.
MEMORY_ERROR(3)	Memory overflow or unsupported PC; location does not exist or PC not supported.
MEMORY_LOCKED(4)	Memory permanently locked and not writable.
ACCESS_PWD_ERROR(5)	Access password incorrect.
KILL_PWD_ERROR(9)	Kill password incorrect.
INVALID_KILL_PWD(10)	Kill password cannot be all zeros.
UNSUPPORTED_CMD(11)	Tag does not support this command.
INVALID_ACCESS_PWD(12)	Access password cannot be zero for this command.
READ_PROTECTED(13)	Tag already read-protected; cannot set again.
NOT_READ_PROTECTED(14)	Tag is not read-protected; unlock not required.
GENERIC_ERROR(15)	Generic tag error (no specific code).
WRITE_FAILED(16)	Write failed — locked bytes.
LOCK_FAILED(17)	Cannot lock.
ALREADY_LOCKED(18)	Already locked; cannot lock again.
PARAM_SAVE_FAILED(19)	Parameter save failed; value valid until power-off.
ADJUST_FAILED(20)	Adjustment failed.
FIRMWARE_PACKAGE_NOT_MATCH(247)	Firmware package mismatch.
ANTENNA_ERROR(248)	Antenna detection error.
CMD_EXEC_FAILED(249)	Command execution failed.
COMMUNICATION_FAILURE(250)	Tag present but communication poor.
NO_TAG(251)	No tag available.
TAG_ERROR(252)	Tag returned an error code.
INVALID_CMD_LENGTH(253)	Invalid command length.
ILLEGAL_CMD(254)	Illegal command.
PARAM_ERROR(255)	Parameter error.
INVALID_INVENTORY_MODE(260)	Inventory scene mode is not CUSTOM_MODE; setting not allowed.
UNSUPPORTED_FEATURE(261)	Firmware does not support this feature.
COMMUNICATION_ERROR(48)	Communication error.
COMMUNICATION_BUSY	Communication busy
\(50\)
SDK_UNINITIALIZED(-1)	SDK not initialized.
DEVICE_DISCONNECTED(-101)	RFID device not connected (peripheral or Bluetooth).
SEND_CMD_FAILED(-102)	Failed to send command (peripheral or Bluetooth).

ReadTag

Property	Type	Description
epcId	String	EPC (excluding CRC/PC)
memId	String	TID/USER (mixed memory bank query)
rssidBm	int	Signal strength in dBm
rssi	int	Signal strength 0–100
phase	int	Phase
FreqKhz	int	Frequency in KHz

DataCallback

java

void onInventoryTag(ReadTag readTag);
void onInventoryTagEnd();

QueryMemBank

QueryMemBank enum for setQueryMemoryBank() / getQueryMemoryBank().

QueryMemBank	Memory bank read
EPC	EPC query
	Parameters: startAddress = 0, readLen = 0
	Behavior: reads default-length EPC (excluding CRC and PC header)
EPC_TID	EPC + TID mixed query
	Parameters: startAddress = TID start word (0–5), readLen = TID length in words (1–6)
	Callback: EPC → `ReadTag.epcId`; TID → `ReadTag.memId`
EPC_USE	EPC + USER mixed query
	Parameters: startAddress = USER start word (≥ 0), readLen = USER length (1–32 words)
	Callback: EPC → `ReadTag.epcId`; USER → `ReadTag.memId`
EPC_RESERVED	EPC + RESERVED (password) query
	Parameters: startAddress = RESERVED start (0–3), readLen = password length (1–4 words)
	Callback: EPC → `ReadTag.epcId`; RESERVED → `ReadTag.memId`
FASTTID	Impinj FastTID mode
	Parameters: startAddress = 0, readLen = 0 (fixed)
	Reads full 96-bit TID (word addresses 0–5) into `ReadTag.memId`
	Compatible with Impinj Monza® tags only
EPC_EPC	Dual EPC query
	Parameters: startAddress = second EPC start, readLen = second EPC length
	First EPC (default length) → `ReadTag.epcId`; second segment → `ReadTag.memId`
	Typical use: read PC bits or partial EPC verification
BID	BID query (special tags only)
	Parameters: startAddress = 0, readLen = 0 (fixed)

InventorySceneMode

InventorySceneMode enum for setInventorySceneMode() / getInventorySceneMode().

Inventory scene mode	Use case
(InventorySceneMode)
BATTERY_LIFE	Low-power mode — extends device battery life
FULL_INVENTORY	Full tag inventory — read all tags as quickly as possible
REPEAT_READ	Rapid accumulation — repeatedly read and count tags
	Note: This mode inventories EPC only.
	Mask filtering cannot use `addMaskBits()`; use `setInventoryMatchData()` instead.
BALANCED_PERFORMANCE	Balanced mode — trade-off between performance and battery
CYCLE_COUNT	Deduplicated inventory — count each tag once; suited to noisy environments but slower subsequent reads
MAX_RANGE	Maximum read distance — single-tag range testing
CUSTOM_MODE	Custom parameters — configure Session, Q, Target, Profile manually

ReaderDeviceType

Value	Constant	Description
-1	UNKNOWN	Unknown
0	INTEGRATED	Integrated
1	PERIPHERAL_UART	UART peripheral
2	BLE_DEVICE	Bluetooth

ModuleType

Constant	Description
MODULE_U1 ~ MODULE_U5	UHF module generations
MODULE_OTHER	Other

GpioInputListener

GPI change callbacks onInput1Changed–onInput4Changed; state 0=low, 1=high.

Examples

Key-triggered inventory

Bind the RFG91 scan key to start/stop inventory (see Grip and peripheral → setKeyEventListener):

java

GripDeviceManager.getInstance().setKeyEventListener((keyCode, isDown) -> {
    if (keyCode == BTKeyEvent.BT_SCAN) {
        RfidManager rfid = RFIDSDKManager.getInstance().getRfidManager();
        if (isDown) rfid.startInventory();
        else rfid.stopInventory();
    }
});

EPC+TID mixed query

Read EPC plus the first 6 words of TID during inventory:

java

RfidManager rfid = RFIDSDKManager.getInstance().getRfidManager();
rfid.setQueryMemoryBank(QueryMemBank.EPC_TID, 0, 6);
rfid.startInventoryWithTimeout(60);

Firmware upgrade

Check a firmware package bundled in assets, then call startUpgrade() if an update is required:

java

RFUpgradeManager.getInstance().checkUpgrade(context,
    RFUpgradeManager.UpgradeSource.fromAssets("bin/fw.zip"),
    callback);

Notes & FAQ

Threading and lifecycle

Pair init() with release() — call release() when the app exits.
Call stopInventory() promptly when inventory finishes or is cancelled.

Logging

Enable with UlogManager.enableLog(true). Log files are written to /sdcard/Download/rfidLog (storage permission required).

Frequency bands

European band (865–868 MHz)

Frequency region	Band name	Channels	Spacing
			kHz
FrequencyRegion.UKRAINE	Ukraine	7	100
FrequencyRegion.CHINESE1	China (band 1)	20	250
FrequencyRegion.EU(RF1)	Europe	4	600
FrequencyRegion.INDIA	India	4	600
FrequencyRegion.URUGUAY	Uruguay	23	500

Americas band (902–928 MHz)

Frequency region	Band name	Channels	Spacing
			kHz
FrequencyRegion.CHINESE2	China (band 2)	20	250
FrequencyRegion.US	United States	50	500
FrequencyRegion.KOREAN	Korea	6	600
FrequencyRegion.PERU	Peru	23	500
FrequencyRegion.US3	US ISM extended	53	500
FrequencyRegion.Taiwan	Taiwan	14	500
FrequencyRegion.EU2(RF2)	Russia	4	1200
FrequencyRegion.Japan	Japan	4	1200
FrequencyRegion.Taiwan	Taiwan	14	500
FrequencyRegion.MALAYSIA	Malaysia	8	500
FrequencyRegion.BRAZIL	Brazil	35	500
FrequencyRegion.THAILAND	Thailand	10	500
FrequencyRegion.SINGAPORE	Singapore	10	500
FrequencyRegion.AUSTRALIA	Australia	10	500
FrequencyRegion.VIETNAM	Vietnam	8	500
FrequencyRegion.ISRAEL	Israel	1	500
FrequencyRegion.INDONESIA	Indonesia	4	500
FrequencyRegion.NEW_ZEALAND	New Zealand	10	500
FrequencyRegion.SOUTH_AFRICA	South Africa	17	200
FrequencyRegion.PHILIPPINES	Philippines	4	500
FrequencyRegion.ETSI_UPPER	ETSI UPPER	3	1200
FrequencyRegion.HK	Hong Kong	10	500
FrequencyRegion.JAPANLBT1	Japan LBT1 (low power)	3+16	200,1200
	Requires RFID firmware 3.0+ (`getFirmwareVersion()`)
FrequencyRegion.JAPANLBT2	Japan LBT2 (high power)	4+2	1200,200
	Requires RFID firmware 3.0+ (`getFirmwareVersion()`)

Example — configuring regional channel ranges:

For FrequencyRegion.EU (channel indices 0–3, top to bottom):

865.7 0

866.3 1

866.9 2

867.5 3

EU band 866.3–866.9 MHz: setFrequencyRegion(FrequencyRegion.EU, 1, 2)

EU band 865.7–867.5 MHz: setFrequencyRegion(FrequencyRegion.EU, 0, 3)

RSSI reference

RSSI value	Signal strength	RSSI value	Signal strength
110(0x6E)	-19dBm	70(0x46)	-60dBm
109(0x6D)	-20dBm	69(0x45)	-61dBm
108(0x6C)	-21dBm	68(0x44)	-62dBm
107(0x6B)	-22dBm	67(0x43)	-63dBm
106(0x6A)	-23dBm	66(0x42)	-64dBm
105(0x69)	-24dBm	65(0x41)	-65dBm
104(0x68)	-25dBm	64(0x40)	-66dBm
103(0x67)	-26dBm	63(0x3F)	-67dBm
102(0x66)	-27dBm	62(0x3E)	-68dBm
101(0x65)	-28dBm	61(0x3D)	-69dBm
100(0x64)	-29dBm	60(0x3C)	-70dBm
99(0x63)	-30dBm	59(0x3B)	-71dBm
98(0x62)	-31dBm	58(0x3A)	-72dBm
97(0x61)	-32dBm	57(0x39)	-73dBm
96(0x60)	-33dBm	56(0x38)	-74dBm
95(0x5F)	-34dBm	55(0x37)	-75dBm
94(0x5E)	-35dBm	54(0x36)	-76dBm
93(0x5D)	-36dBm	53(0x35)	-77dBm
92(0x5C)	-37dBm	52(0x34)	-78dBm
91(0x5B)	-38dBm	51(0x33)	-79dBm
90(0x5A)	-39dBm	50(0x32)	-80dBm
89(0x59)	-41dBm	49(0x31)	-81dBm
88(0x58)	-42dBm	48(0x30)	-82dBm
87(0x57)	-43dBm	47(0x2F)	-83dBm
86(0x56)	-44dBm	46(0x2E)	-84dBm
85(0x55)	-45dBm	45(0x2D)	-85dBm
84(0x54)	-46dBm	44(0x2C)	-86dBm
83(0x53)	-47dBm	43(0x2B)	-87dBm
82(0x52)	-48dBm	42(0x2A)	-88dBm
81(0x51)	-49dBm	41(0x29)	-89dBm
80(0x50)	-50dBm	40(0x28)	-90dBm
79(0x4F)	-51dBm	39(0x27)	-91dBm
78(0x4E)	-52dBm	38(0x26)	-92dBm
77(0x4D)	-53dBm	37(0x25)	-93dBm
76(0x4C)	-54dBm	36(0x24)	-94dBm
75(0x4B)	-55dBm	35(0x23)	-95dBm
74(0x4A)	-56dBm	34(0x22)	-96dBm
73(0x49)	-57dBm	33(0x21)	-97dBm
72(0x48)	-58dBm	32(0x20)	-98dBm
71(0x47)	-59dBm	31(0x1F)	-99dBm

Convert RSSI to dBm using:

int dBm = RssiToDBmUtils.dBmConver(int rssi);

Or set default RSSI format via setRssiInDbm(boolean isDbm).

Region reference

Parameter (CountryCode)	Region
`CountryCode.ALB`	Albania
`CountryCode.ARG`	Argentina
`CountryCode.ARM`	Armenia
`CountryCode.AUT`	Austria
`CountryCode.AZE`	Azerbaijan
`CountryCode.BLR`	Belarus
`CountryCode.BEL`	Belgium
`CountryCode.BIH`	Bosnia and Herzegovina
`CountryCode.BRA`	Brazil
`CountryCode.BUL`	Bulgaria
`CountryCode.CAN`	Canada
`CountryCode.CHI`	Chile
`CountryCode.CHN`	China
`CountryCode.COL`	Colombia
`CountryCode.CRC`	Costa Rica
`CountryCode.CRO`	Croatia
`CountryCode.CYP`	Cyprus
`CountryCode.CZE`	Czech Republic
`CountryCode.DEN`	Denmark
`CountryCode.DOM`	Dominican Republic
`CountryCode.EST`	Estonia
`CountryCode.FIN`	Finland
`CountryCode.FRA`	France
`CountryCode.GER`	Germany
`CountryCode.GRE`	Greece
`CountryCode.HUN`	Hungary
`CountryCode.ISL`	Iceland
`CountryCode.IRI`	Iran, Islamic Rep.
`CountryCode.ITA`	Italy
`CountryCode.KOR`	Korea, Rep.
`CountryCode.LIE`	Liechtenstein
`CountryCode.LTU`	Lithuania
`CountryCode.LUX`	Luxembourg
`CountryCode.MKD`	Macedonia, FYR
`CountryCode.MLT`	Malta
`CountryCode.MEX`	Mexico
`CountryCode.MDA`	Moldova
`CountryCode.NED`	Netherlands
`CountryCode.NZL`	New Zealand
`CountryCode.NGR`	Nigeria
`CountryCode.NOR`	Norway
`CountryCode.PAN`	Panama
`CountryCode.PER`	Peru
`CountryCode.POL`	Poland
`CountryCode.POR`	Portugal
`CountryCode.ROM`	Romania
`CountryCode.RUS`	Russian Federation
`CountryCode.KSA`	Saudi Arabia
`CountryCode.SVK`	Slovak Republic
`CountryCode.SLO`	Slovenia
`CountryCode.RSA`	South Africa
`CountryCode.ESP`	Spain
`CountryCode.SWE`	Sweden
`CountryCode.SUI`	Switzerland
`CountryCode.HKG`	Hong Kong
`CountryCode.THA`	Thailand
`CountryCode.TUN`	Tunisia
`CountryCode.TUR`	Turkey
`CountryCode.UAE`	United Arab Emirates
`CountryCode.GBR`	United Kingdom
`CountryCode.USA`	United States
`CountryCode.URU`	Uruguay
`CountryCode.VEN`	Venezuela, RB
`CountryCode.UKR`	Ukraine
`CountryCode.MAS`	Malaysia
`CountryCode.SIN`	Singapore
`CountryCode.AUS`	Australia
`CountryCode.IND`	India
`CountryCode.VIE`	Vietnam
`CountryCode.ISR`	Israel
`CountryCode.INA`	Indonesia
`CountryCode.JPN`	Japan
`CountryCode.PHI`	Philippines

Additional notes

1. Long-range RFID sled — scan head trigger (non-Bluetooth devices)

RFIDSDKManager.getInstance().enableScanHead(boolean isOpen);

Controls whether the physical key on a long-range RFID sled triggers the barcode scan head.

Parameter	Type	Description
isOpen	boolean	`true` — key triggers scanning; `false` — key does not trigger scanning

2. Bluetooth device — parse MAC from NFC

java

String mac = NFCUtils.getBleMac(NdefMessage ndefMessage);

Pass the NdefMessage read from NFC; returns the Bluetooth MAC address for use with initBTtoMac(context, mac, listener).

Parameter	Type	Description
ndefMessage	NdefMessage	NFC `NdefMessage` payload

Recommendations

Pair init() with release() — call release() when exiting the app to disconnect the RFID module.
Use the error code reference for troubleshooting (see Error codes and types).
SDK logging: call UlogManager.enableLog(true) once before using the SDK. Logs are written to /sdcard/Download/rfidLog (storage permission required).

Contact and support

For the latest updates, sample code, and technical support, contact the UBX support team.

End of document.

Q: BLE MAC via NFC?

A: NFCUtils.getBleMac(ndefMessage) → pass to initBTtoMac()

Q: Which class provides release()?

A: RFIDSDKManager.getInstance().release()

Q: Change Session outside CUSTOM_MODE?

A: Set InventorySceneMode.CUSTOM_MODE first via setInventorySceneMode()

Q: Firmware upgrade battery requirements?

A: Host (Android) battery > 20%; sled (BLE/UART) > 10%

概述

SDK 简介

UBX UHF RFID SDK（URFIDLibrary）是面向 Android 平台的超高频（UHF）RFID 开发库，以 AAR 形式交付（URFIDLibrary-xxxxxx.aar），封装与 RFID 读写模块的通信细节，为应用层提供初始化、盘点（Inventory）、标签读写、参数配置、固件升级及蓝牙/UART 外设管理等能力。

文档版本：V2.25

版本变更

2025-12-30 （URFIDLibrary-v2.5.1230.aar）

1. setInventorySceneMode - 新增盘点场景模式

新增两种读取模式： • Cycle Count（去重盘点模式）：自动去重的盘点计数模式 • Max Range（最远读距模式）：最大读取距离模式

2. 数据回调参数类型变更

onInventoryTag 回调方法签名已更新：变更前： onInventoryTag(String EPC, String Data, String rssi); 变更后： onInventoryTag(String EPC, String Data, int rssi); 说明：rssi 参数类型从 String 变更为 int。

3. RfidProfile 枚举 - Miller 配置返回类型变更

RfidProfile 枚举中获取 Miller 配置的方法，返回类型从 String 变更为 int。

4. 新增方法：getSupportProfileList()

新增获取支持的 Profile 组合列表的方法： getSupportProfileList()

5. 新增方法：getSupportFrequencyBandList()

新增获取支持的频率区域（FrequencyRegion）组合列表的方法： getSupportFrequencyBandList()

6. 新增方法：getSupportWorkRegionList()

新增获取支持的国家代码（CountryCode）组合列表的方法： getSupportWorkRegionList()

7. 完善模块类型获取方法：getModuleType()

完善获取当前模块类型的方法，可用于区分支持的 Profile：

java

int getModuleType()
支持的模块类型：
•	MODULE_U1
•	MODULE_U2
•	MODULE_U3
•	MODULE_U4
•	MODULE_U5
•	MODULE_OTHER

8. 新增方法：getReaderDeviceType()

新增获取设备类型的方法：

java

getReaderDeviceType() ReaderDeviceType 枚举值：
值	常量	说明
-1	ReaderDeviceType.UNKNOWN	未知设备类型
0	ReaderDeviceType.INTEGRATED	一体机设备
1	ReaderDeviceType.PERIPHERAL_UART	串口设备
2	ReaderDeviceType.BLE_DEVICE	蓝牙设备

9. 新增方法：setInventoryPhaseFlag(boolean flag)

新增设置是否返回相位、频点信息的方法：

java

setInventoryPhaseFlag(boolean flag)
参数说明：
•	flag = true：返回相位和频点信息
•	flag = false：不返回相位和频点信息

10. 回调注册方法变更

建议使用 addDataCallback() 替代原有的回调注册方法。

java

变更前：
registerCallback(IRfidCallback cb)
变更后：
addDataCallback(DataCallback cb)

java

回调方法签名变更：
变更前：
onInventoryTag(String EPC, String Data, int rssi);
变更后：
onInventoryTag(ReadTag readTag);

ReadTag 类属性说明：

java

属性	类型	说明
	epcId	String	EPC 值
	memId	String	TID 或 USER 数据（在 QueryMemBank 的 EPC+TID 或 EPC+USER 模式下，该参数分别为 TID 和 USER 数据）
	rssi	int	   信号强度值（范围：0-100）
	phase	int	   相位值
	FreqKhz	int	   频点（单位：KHz）

11. release 方法变更

移除了 rfidManager.release() 方法。请使用以下方法替代： RFIDSDKManager.getInstance().release();

12. 代码优化

针对核心功能模块进行了优化，提升代码可维护性与执行效率。

2026-04-08 （URFIDLibrary-v2.6.0408.aar）

1.SO库做了16KB对齐；

2.删除了 setRssiInDbm 方法

dBm值现在在盘点回调 onInventoryTag(ReadTag readTag) 中的 readTag.rssidBm 字段默认返回 dBm 信号值。

3.用于切换信号值返回范围的方法，做了变更：

java

setRssiConvertEnabled 替换成：setRssiUnitType  
getRssiConvertEnabled 替换成：getRssiUnitType

2026-06-09 （URFIDLibrary-v2.6.0609.aar）

1.新增RFID固件更新接口；

2- 优化并修复了不同 Android Studio 版本之间显示的 16KB 对齐结果不一致的问题。

核心能力

模块生命周期管理：一体机/UART 串口与蓝牙设备初始化、连接状态查询、资源释放
标签盘点（Inventory）：连续盘点、定时盘点、单次询查、场景模式与混合存储区查询
标签访问：Gen2 标签读/写/锁/销毁、掩码操作、TID 寻址
读写器配置：发射功率、链路 Profile、频段/区域、天线多路复用
固件升级：本地包检测升级、在线检测下载升级（RFUpgradeManager）
外设扩展：蓝牙/UART 手柄（Sled）条码扫描、电量/离线数据、按键事件

适用场景

物流仓储、资产管理中的 UHF 标签批量盘点
零售/制造单标签读写与 EPC 改写
搭载 RFG91 等模块的 PDA、蓝牙 RFID 手柄（Sled）应用
固定式读写器天线多路盘点与 Access 操作

环境要求

项目	要求
平台	Android
最低 SDK	API 18 (Android 4.3)
交付物	`URFIDLibrary-xxxxxx.aar`
硬件	须使用本公司提供的设备及 RFID 模块
参考 Demo	RFIDDemo

接入

获取 SDK

gradle

dependencies {
    implementation files('libs/URFIDLibrary-xxxxxx.aar')
}

工程配置

权限

xml

<uses-permission android:name="android.permission.BLUETOOTH" />
<uses-permission android:name="android.permission.BLUETOOTH_ADMIN" />
<uses-permission android:name="android.permission.BLUETOOTH_CONNECT" />
<uses-permission android:name="android.permission.INTERNET" />
<uses-permission android:name="android.permission.WRITE_EXTERNAL_STORAGE" />
<uses-permission android:name="android.permission.FOREGROUND_SERVICE" />
<uses-permission android:name="android.permission.FOREGROUND_SERVICE_CONNECTED_DEVICE" />

BLE 固件升级依赖与 Manifest

gradle

implementation 'no.nordicsemi.android:dfu:2.9.0'
implementation 'com.google.code.gson:gson:2.11.0'

注意事项：

1>.确保SD已初始化：RFIDSDKManager 已完成 init或initBTtoMac；

2>.固件包格式 : ZIP 压缩包，直接用我司提供的固件包即可，不要解压、不要修改文件名称，不要修改文件格式；

3>.Context: 常规检测可用 ApplicationContext ;带UI升级（showUI=true）须传入 Activity Context；

4>.权限 : BLE Sled 升级 BLE 固件时，Android 12+（API 31+）需已授予 BLUETOOTH_CONNECT；

5>.非线程安全: 请勿并发调用多个检测/升级流程；同一时刻只应有一个升级任务。 6>.BLE Sled升级需要注意：需要增加额外配置：

新增依赖包：

implementation 'no.nordicsemi.android:dfu:2.9.0' implementation 'com.google.code.gson:gson:2.11.0'

混淆规则：

-keep class no.nordicsemi.*{;}

AndroidManifest.xml 添加如下配置：

<uses-permission android:name="android.permission.FOREGROUND_SERVICE"/>

<uses-permission android:name="android.permission.FOREGROUND_SERVICE_CONNECTED_DEVICE"/>

使用的类：RFUpgradeManager.getInstance();

调用步骤：

checkUpgrade() → [用户确认] → startUpgrade()

3.1 检查更新

ProGuard 混淆规则

proguard

-keep class com.ubx.** { *; }
-keep class no.nordicsemi.** { *; }
-keep class com.iflytek.** { *; }
-keep class com.lib.** { *; }
-keep class android.device.** { *; }

初始化入口

设备类型	API
一体机 / UART	`RFIDSDKManager.getInstance().init(context, listener)`
蓝牙设备	`RFIDSDKManager.getInstance().initBTtoMac(context, mac, listener)`
释放	`RFIDSDKManager.getInstance().release()`

SDK 方法可能阻塞线程，请在后台线程调用，串行执行指令。

鉴权

无。

快速开始

java

RFIDSDKManager.getInstance().init(context, status -> {
    if (!status) return;
});

RfidManager rfid = RFIDSDKManager.getInstance().getRfidManager();
rfid.addDataCallback(new DataCallback() {
    @Override public void onInventoryTag(ReadTag readTag) { /* EPC: readTag.epcId */ }
    @Override public void onInventoryTagEnd() { }
});

rfid.startInventoryWithTimeout(300);

// stop: RFIDSDKManager.getInstance().getRfidManager().stopInventory();
// exit: RFIDSDKManager.getInstance().release();

说明：addDataCallback、startInventoryWithTimeout、stopInventory、release 应在 init 回调外调用；init 回调内仅处理连接成功/失败。

成功标志：InitListener.onStatus(true)；盘点回调收到 ReadTag 数据。

调用路径：RFIDSDKManager.getInstance()

初始化回调说明

java

RFIDSDKManager.getInstance().init(context, status -> {
    if (!status) return;
});

InitListener.onStatus(boolean status) 回调中：status == true 表示初始化成功，status == false 表示初始化失败。init 回调内仅处理连接结果；addDataCallback、startInventoryWithTimeout、stopInventory、release 等操作应在回调外调用。

参数	类型	说明
context	Context	应用上下文
listener	InitListener	监听初始化成功或失败的回调 new InitListener() { @Override public void onStatus(boolean status) { } } status : true:初始化成功 false:初始化失败

参数	类型	说明
context	Context	上下文
mac	String	需要连接的蓝牙设备的MAC地址，例如：41:BB:00:F8:DB:51
listener	InitListener	监听初始化成功或失败的回调 new InitListener() { @Override public void onStatus(boolean status) { } } status : true:初始化(连接)成功 false:初始化(连接)失败

返回值

true：已连接； false：未连接。 (boolean)

com.ubx.usdk.RFIDSDKManager

setSwitchCallback

使用类：RFIDSDKManager.getInstance()；监听DT610自带RFID和RFG91 UART设备的切换使用时，切换后RFID模块状态的回调。注意：只在DT610和RFG91 UART设备搭配使用时才有效，不是该组合下的设备调用该方法无效。

void setSwitchCallback(ModelInfoCallback cb);

参数	类型	说明
cb	ModelInfoCallback	切换后的模块信息回调： interface ModelInfoCallback { /* @param type 0 : 自带模块（DT610自带模块） 1: UART模块（RFG91 UART设备） @param firmware 模块版本号 @param power 使用的功率值 / void onInfo(int type, String firmware, int power); / @param status ModelStatus.Connected = 0; //合上 ModelStatus.Separate = 1; //分离 ModelStatus.StartingUp = 2; //待机 ModelStatus.Shutdown = 3; //关机 */ void onModuleStatus(int status); }

示例

java

RFIDSDKManager.getInstance().setSwitchCallback(new ModelInfoCallback() {
@Override
public void onModuleStatus(int status) {
}
@Override
public void onInfo(int type, String firmware, int power) {
}
});

调用路径：RFIDSDKManager.getInstance().getRfidManager()

onInventoryTag、onInventoryTagEnd 为 DataCallback 接口方法，通过 addDataCallback 注册后回调。

startInventoryWithTimeout

启动盘点，这里的传参 timeout 单位为seconds。在盘点执行到timeout 时间，会自动停止盘点，同时会在回调方法的 onInventoryTagEnd() 回调通知，如果未到timeout 时间，想要停止，也可以调用 stopInventory() 进行手动停止。结果在addDataCallback()回调返回。

int startInventoryWithTimeout(int timeout);

参数	类型	说明
timeout	int	超时时间，单位：秒，必须大于或等于0.并且不能超过 36000秒：设置 0 ：则表示一直盘点，必须要调用stopInventory()才会停止；设置 0< timeout <= 36000：则会根据timeout时间，到时间自动停止，期间也可以调用stopInventory()进行提前停止。

返回值

成功: RfidErrorConstants.SUCCESS； (int) 失败：其他(错误码信息详见:附录1：常见错误码)。

示例

java

RFIDSDKManager.getInstance().getRfidManager().startInventoryWithTimeout(300);
如果要监听RFID手柄的按键来触发盘点方法，可以使用如下方式：
1.一体机设备，监听android标准按键事件：
@Override
public boolean dispatchKeyEvent(KeyEvent event) {
if ((event.getKeyCode() == 523 

event.getKeyCode() == 515 )
&& event.getRepeatCount() == 0) {
//TODO The key value of the PTT button on the left side of DT610 is 515
if (event.getAction() == KeyEvent.ACTION_DOWN ) {
//start Inventory
//RFIDSDKManager.getInstance().getRfidManager().startInventoryWithTimeout(300);
return true;
} else if (event.getAction() == KeyEvent.ACTION_UP ) {
//stop Inventory
//RFIDSDKManager.getInstance().getRfidManager().stopInventory();
return true;
}
}
return super.dispatchKeyEvent(event);
}
2.蓝牙设备，监听方法的回调
GripDeviceManager.getInstance().setKeyEventListener(new KeyEventListener() {
@Override
public void event(int keyCode, boolean isDown) {
//keycode == BTKeyEvent.BT_SCAN The handle button was pressed
//isDown true: down false: up
if (keyCode == BTKeyEvent.BT_SCAN) {
if (isDown ) {
//start Inventory
//RFIDSDKManager.getInstance().getRfidManager().startRead();
} else {
//stop Inventory
//RFIDSDKManager.getInstance().getRfidManager().stopInventory();
}
}
}
});

com.ubx.usdk.RfidManager

startInventory

启动盘点；启动后，必须要通过stopInventory()来停止。盘点到的Tag结果在addDataCallback()回调方法返回。

int startInventory();

返回值

成功: RfidErrorConstants.SUCCESS； (int) 失败：其他(错误码信息详见:附录1：常见错误码)。

示例

java

RFIDSDKManager.getInstance().getRfidManager().startInventory();
如果要监听RFID手柄的按键来触发盘点方法，可以使用如下方式：
1.一体机设备，监听android标准按键事件：
@Override
public boolean dispatchKeyEvent(KeyEvent event) {
if (event.getKeyCode() == 523 && event.getRepeatCount() == 0) {
//TODO The Grip key value of the key is 523
if (event.getAction() == KeyEvent.ACTION_DOWN ) {
//start Inventory
//RFIDSDKManager.getInstance().getRfidManager().startInventory();
return true;
} else if (event.getAction() == KeyEvent.ACTION_UP ) {
//stop Inventory
//RFIDSDKManager.getInstance().getRfidManager().stopInventory();
return true;
}
}
return super.dispatchKeyEvent(event);
}
2.蓝牙设备，监听方法的回调
GripDeviceManager.getInstance().setKeyEventListener(new KeyEventListener() {
@Override
public void event(int keyCode, boolean isDown) {
//keycode == BTKeyEvent.BT_SCAN The handle button was pressed
//isDown true: down false: up
if (keyCode == BTKeyEvent.BT_SCAN) {
if (isDown ) {
//start Inventory
//RFIDSDKManager.getInstance().getRfidManager().startInventory();
} else {
//stop Inventory
//RFIDSDKManager.getInstance().getRfidManager().stopInventory();
}
}
}
});

参数	类型	说明
cb	DataCallback	回调

参数	类型	说明
readTag.epcId	String	盘点到的标签的EPC（不包含CRC、PC）
readTag.memId	String	混合查询模式下返回的对应区域的数据，比如：TID数据、USER区数据或保留区数据；混合查询可通过 setQueryMemoryBank(QueryMemBank mode) 方法设置。
readTag.rssidBm	int	标签的信号强度，dBm (分贝毫瓦) 射频信号强度的绝对测量单位。

返回值

成功: RfidErrorConstants.SUCCESS； (int) 失败：(错误码信息详见:附录1：常见错误码)。

com.ubx.usdk.RfidManager

inventorySingle

每次调用最多只读取一个标签，如果附近没有标签，也有可能读不到。结果在addDataCallback()回调返回。

int inventorySingle();

返回值

成功: RfidErrorConstants.SUCCESS；其他：调用失败(错误码信息详见:附录1：常见错误码)。读取结果在 onInventoryTag() 回调返回对应结果。

com.ubx.usdk.RfidManager

setInventorySceneMode

几种不同场景下的模式，可以根据自己的场景，选择对应的模式；如果需要自定义设置，也可以通过本文档中的《2.5盘点参数设置》进行自定义设置。注意：如果在非自定义模式(InventorySceneMode.CUSTOM_MODE)下，参数 Session、Q 值、Target、Profile 都不可设置。每次设置模式后，功率会变更成对应模式下的默认值，如果之前手动设置过功率的大小，在设置模式后，需要再次设置一次自己期望的的功率值。

int setInventorySceneMode(InventorySceneMode mode);

参数	类型	说明
mode	InventorySceneMode	盘点场景模式，请参考下面的：盘点场景模式说明。

返回值

成功: RfidErrorConstants.SUCCESS； (int) 失败：其他(错误码信息详见:附录1：常见错误码)。

示例

java

RFIDSDKManager.getInstance().getRfidManager().setInventorySceneMode(InventorySceneMode.BATTERY_LIFE);

盘点场景模式说明

盘点场景模式	适用场景
(InventorySceneMode)
BATTERY_LIFE	低功耗场景延长设备续航时间
FULL_INVENTORY	盘点读取全标签以尽快识别全部标签为目的
REPEAT_READ	快速累加模式频繁（重复）读取并累计标签数量
	注意：此模式仅盘点 EPC。
	掩码过滤不能使用 `addMaskBits()`，请改用 `setInventoryMatchData()`。
BALANCED_PERFORMANCE	均衡模式平衡性能与续航
CYCLE_COUNT	去重盘点模式盘点未被重复计数的标签；适用于高干扰环境，但后续读取较慢
MAX_RANGE	最远读距模式适用于单标签远距测试
CUSTOM_MODE	自定义参数可自行配置 Session、Q 值、Target、Profile

返回值

示例

java

InventorySceneMode mode =
RFIDSDKManager.getInstance().getRfidManager().getInventorySceneMode();

参数	类型	说明
mode	QueryMemBank	请看下方的QueryMemBank 说明。
startAddress	int	要盘点的内存区域的起始位置，以字（Word）地址（Word Address）为单位((1字长 = 16 bits) 。
readLen	int	盘点时要读取的字(Word)长度(1字长 = 16 bits) 。

返回值

成功: RfidErrorConstants.SUCCESS； (int) 失败：其他(错误码信息详见:附录1：常见错误码)。

示例

java

RFIDSDKManager.getInstance().getRfidManager().setQueryMemoryBank(QueryMemBank.EPC,0,0);
RFIDSDKManager.getInstance().getRfidManager().setQueryMemoryBank(QueryMemBank.EPC_USER,startAddress,readLen);

QueryMemBank 说明

QueryMemBank	读取的 Bank
EPC	EPC 查询
	参数：startAddress = 0，readLen = 0
	行为：读取默认长度 EPC（不含 CRC 与 PC 头）
EPC_TID	EPC + TID 混合查询
	参数：startAddress = TID 起始字地址（0–5），readLen = TID 读取长度（1–6 字）
	回调：EPC → `ReadTag.epcId`；TID → `ReadTag.memId`
EPC_USE	EPC + USER 混合查询
	参数：startAddress = USER 起始字地址（≥ 0），readLen = USER 读取长度（1–32 字）
	回调：EPC → `ReadTag.epcId`；USER → `ReadTag.memId`
EPC_RESERVED	EPC + RESERVED（Password）混合查询
	参数：startAddress = RESERVED 起始地址（0–3），readLen = 密码读取长度（1–4 字）
	回调：EPC → `ReadTag.epcId`；RESERVED → `ReadTag.memId`
FASTTID	Impinj FastTID 快速模式
	参数：startAddress = 0，readLen = 0（固定）
	自动读取完整 96 位 TID（字地址 0–5）写入 `ReadTag.memId`
	兼容性：仅支持 Impinj Monza® 系列标签
EPC_EPC	EPC + EPC 双区查询
	参数：startAddress = 第二 EPC 起始地址，readLen = 第二 EPC 读取长度
	第一 EPC（默认长度）→ `ReadTag.epcId`；第二 EPC 段 → `ReadTag.memId`
	典型应用：读取 PC 位或部分 EPC 校验
BID	BID 查询（需特殊标签支持）
	参数：startAddress = 0，readLen = 0（固定）

返回值

返回的对应模式值： (int) QueryMemBank queryMemBank : queryMemBank .getStartAddress();//要读取/写入的内存区域的起始位置，以字（Word）地址（Word Address）为单位。 queryMemBank .getReadLength();//读取的字长度(一个字长为16 bits)

示例

java

QueryMemBank queryMemBank =
RFIDSDKManager.getInstance().getRfidManager().getQueryMemoryBank();
int startAdd = queryMemBank .getStartAddress();
int readLen = queryMemBank .getReadLength();

调用路径：RFIDSDKManager.getInstance().getRfidManager()

参数	类型	说明
outputPower	int	设备的输出功率：模块支持的最大功率值可通过下面方法获取： int maxPower = RFIDSDKManager.getInstance().getRfidManager().getSupportMaxOutputPower(); maxPower 即为支持的最大功率值。

返回值

成功: RfidErrorConstants.SUCCESS； (int) 失败：其他(错误码信息详见:附录1：常见错误码)。

返回值

返回输出功率(小于0则获取失败) (int)

com.ubx.usdk.RfidManager

setProfile

设置链路信息：BLF(Backscatter Link Frequency)、Miller、Tari、Pie 该方法是BLF、Miller、Tari、PIE参数的固定组合。注意：如果处于非自定义模式(InventorySceneMode.CUSTOM_MODE),该参数不可设置; 如果要设置，请先通过 setInventorySceneMode()设置盘点模式为自定义模式(InventorySceneMode.CUSTOM_MODE)。

int setProfile(RfidProfile profile);

参数	类型	说明
profile	RfidProfile	模块类型可通过 `getModuleType()` 获取。不同模块支持的RfidProfile组合参考下方表格。

示例

java

RFIDSDKManager.getInstance().getRfidManager().setProfile(RfidProfile.PROFILE_5);

不同芯片支持的Profile：

RfidProfile	模块支持	参数详情
PROFILE_3	MODULE_U3 、MODULE_U4 、MODULE_U5	PR_ASK, PIE: 2.0, Tari: 20.0μs, BLF: 320kHz, Miller=2
PROFILE_5	MODULE_U3 、MODULE_U4 、MODULE_U5	PR_ASK, PIE: 2.0, Tari: 20.0μs, BLF: 320kHz, Miller=4
PROFILE_7	MODULE_U3 、MODULE_U4 、MODULE_U5	PR_ASK, PIE: 2.0, Tari: 20.0μs, BLF: 250kHz, Miller=4
PROFILE_12	MODULE_U3 、MODULE_U4 、MODULE_U5	PR_ASK, PIE: 2.0, Tari: 15.0μs, BLF: 320kHz, Miller=2
PROFILE_13	MODULE_U3 、MODULE_U4 、MODULE_U5	PR_ASK, PIE: 2.0, Tari: 20.0μs, BLF: 160kHz, Miller=8
PROFILE_1	MODULE_U4 、MODULE_U5	PR_ASK, PIE: 2.0, Tari: 7.5μs, BLF: 640kHz, Miller=2
PROFILE_15	MODULE_U4 、MODULE_U5	PR_ASK, PIE: 2.0, Tari: 7.5μs, BLF: 640kHz, Miller=4
PROFILE_51	MODULE_U4 、MODULE_U5	DSB, PIE: 1.5, Tari: 6.25μs, BLF: 640kHz, Miller=2
PROFILE_53	MODULE_U4 、MODULE_U5	PR_ASK, PIE: 1.5, Tari: 7.5, BLF:640kHz, Miller=4
PROFILE_11	MODULE_U5	PR_ASK, PIE: 2.0, Tari: 7.5μs, BLF: 640kHz, FM0
PROFILE_50	MODULE_U5	DSB, PIE: 1.5, Tari: 6.25μs, BLF: 640kHz, FM0
PROFILE_52	MODULE_U5	PR_ASK, PIE: 2.0, Tari: 15.0μs, BLF: 426kHz, FM0
PROFILE_R2000_0	MODULE_U2	DSB-ASK, PIE: 1.0, Tari: 25.0μs, BLF: 40kHz, FM0
PROFILE_R2000_1	MODULE_U2	PR_ASK, PIE: 0.5, Tari: 25.0μs, BLF: 250kHz, FM4
PROFILE_R2000_2	MODULE_U2	PR_ASK, PIE: 0.5, Tari: 25.0μs, BLF: 300kHz, FM4
PROFILE_R2000_3	MODULE_U2	DSB-ASK, PIE: 0.5, Tari: 6.5μs, BLF: 400kHz, FM0

Impinj 的 Gen2X Profile：

Gen2X 功能说明：

Gen2X 是 Impinj 的高性能读取模式，针对 M700、M800 系列标签进行了优化。根据您的需求，可选择两种读取策略：

配置类型 Profile 编号读取范围专用模式 4123、4124、4141、4146、4148、4185 仅读取 M700、M800 系列标签

兼容模式 5123、5124、5141、5146、5148、5185 读取 M700、M800 系列标签 + 普通标签

RfidProfile	模块支持	参数详情
PROFILE_Gen2X_4123	MODULE_U3 、MODULE_U4 、MODULE_U5	PR_ASK,pie: 2.0, tari_us: 20.0,lf_khz: 320k, PSK2
PROFILE_Gen2X_4124	MODULE_U4 、MODULE_U5	PR_ASK,pie: 2.0, tari_us: 7.5, lf_khz: 640k, BPSK2
PROFILE_Gen2X_4141	MODULE_U3 、MODULE_U4 、MODULE_U5	PR_ASK,pie: 2.0, tari_us: 20.0,lf_khz: 320k, BPSK4
PROFILE_Gen2X_4146	MODULE_U3 、MODULE_U4 、MODULE_U5	PR_ASK,pie: 2.0, tari_us: 20.0,lf_khz: 250k, BPSK4
PROFILE_Gen2X_4148	MODULE_U4 、MODULE_U5	PR_ASK,pie: 1.5, tari_us: 7.5, lf_khz: 640k, BPSK4
PROFILE_Gen2X_4185	MODULE_U3 、MODULE_U4 、MODULE_U5	PR_ASK,pie: 2.0, tari_us: 20.0,lf_khz: 160k, BPSK8
PROFILE_Gen2X_5123	MODULE_U3 、MODULE_U4 、MODULE_U5	PR_ASK,pie: 2.0, tari_us: 20.0,lf_khz: 320k, M+B2
PROFILE_Gen2X_5124	MODULE_U4 、MODULE_U5	PR_ASK,pie: 2.0, tari_us: 7.5, lf_khz: 640k, M+B2
PROFILE_Gen2X_5141	MODULE_U3 、MODULE_U4 、MODULE_U5	PR_ASK,pie: 2.0, tari_us: 20.0,lf_khz: 320k, M+B4
PROFILE_Gen2X_5146	MODULE_U3 、MODULE_U4 、MODULE_U5	PR_ASK,pie: 2.0, tari_us: 20.0,lf_khz: 250k, M+B4
PROFILE_Gen2X_5148	MODULE_U4 、MODULE_U5	PR_ASK,pie: 1.5, tari_us: 7.5, lf_khz: 640k, M+B4
PROFILE_Gen2X_5185	MODULE_U3 、MODULE_U4 、MODULE_U5	PR_ASK,pie: 2.0, tari_us: 20.0,lf_khz: 160k, M+B8

Tari/PIE/BLF/Miller 简要说明：

Parameter Explanation Introduction

Tari	A类参考时间间隔,定义了读写器发送给标签的最基本时间单位。前向链路的基石，决定了通信的基准速率。值越小，数据速率越高。
PIE	脉冲间隔编码,读写器向标签发送数据时采用的编码方式。 PIE值大小，核心是指其基准时间间隔Tari的数值，（具体为Tari）越小，数据速率越高，但信号能量可能不足，导致读取距离变短或稳定性下降；反之，Tari越大，通信越稳健，读取距离可能更远，但速率会降低。
BLF	反向散射链路频率,决定标签返回数据给读写器的速率。反向链路的时钟。BLF越高，读取速度越快，但信号衰减也越快，读取距离可能受影响。
Miller	密勒调制副载波,标签向读写器返回数据时采用的一种编码方式提高抗干扰能力，但会降低有效数据速率（Miller-2/4/8，数字越大越稳健，读取速度越慢）。

Chip support for API：

ModuleType moduleType = RFIDSDKManager.getInstance().getRfidManager().getModuleType();

moduleType == ModuleType.MODULE_U1 ...

示例

java

RfidProfile rfidProfile =
RFIDSDKManager.getInstance().getRfidManager().getProfile();

参数	类型	说明
session	int	Session 默认SESSION.S1； - SESSION.S0 : 0; - SESSION.S1 : 1; - SESSION.S2 : 2; - SESSION.S3 : 3;; SESSION.S0:用于查询单个或少量的标签，在相同的时间范围内实现更高的每个标签的读取速率。; SESSION.S1:针对大量标签群体的动态环境进行了优化，尽可能的寻找新标签。; SESSION.S2/SESSION.S3:专为利用持久会话状态的静态标签清单而设计。

示例

java

RFIDSDKManager.getInstance().getRfidManager().setInventoryWithSession(SESSION.S1);

返回值

成功：

SESSION.S0 : 0;
SESSION.S1 : 1;
SESSION.S2 : 2;
SESSION.S3 : 3;

失败：其他(错误码信息详见:<附录1：常见错误码>)。

示例

java

int sesion =
RFIDSDKManager.getInstance().getRfidManager().getInventoryWithSession();

参数	类型	说明
target	int	- Target.TARGET_A - 0 : 仅 A状态标签响应盘点（Inventoried Flag = A） - Target.TARGET_B - 1 : 仅 B状态标签响应盘点（Inventoried Flag = B） - Target.TARGET_AB - 2 : 动态切换状态：首次查询：A状态标签响应后续查询：自动切换为B状态标签响应

返回值

成功： 0 -TARGET_A； 1 -TARGET_B； 2 -TARGET_AB . 失败：其他(错误码信息详见:<附录1：常见错误码>)。

参数	类型	说明
QvalueStart	Int	起始Q-value ，决定首次盘点周期（Inventory Round）的时隙数量，后续会自动根据扫描到的标签情况进行动态变化。值的范围0~15，默认6；标签密度小可以减小Q，标签密度高可以加大。备注：Q为动态Q，盘点过程会根据标签密度会自动加大或减少Q值。

返回值

成功: RfidErrorConstants.SUCCESS；失败：其他(错误码信息详见:<附录1：常见错误码>)。

参数	类型	说明
password	String	盘点时的询查密码 2个字长， 16进制字符串格式。

返回值

返回盘点时的询查密码。

参数	类型	说明
rssi	int	范围：0-110 过滤小于 RSSI值的标签

返回值

支持：true；不支持：false。

参数	类型	说明
unitType	RssiUnitType	RELATIVE 常规类型 (相对值)范围: 40 ~ 110 PERCENTAGE:百分比类型:范围: 0 ~ 100%

com.ubx.usdk.RfidManager

addMaskBits

添加盘点时的过滤参数,添加该掩码参数后，盘点时只会盘点到设置了对应掩码的标签。过滤掉不属于掩码内的标签。可以多次添加不同的掩码数据。

void addMask(int memMask, int startMask, int lenMask, String datasMask);

参数	类型	说明
memMask	int	过滤区域： TAG存储区：; MemoryBank.RESERVED(RESERVED); MemoryBank.EPC (EPC); MemoryBank.TID (TID); MemoryBank.USER (USER)
startMask	int	起始地址，这里地址的参数跟其他方法参数有差异,数据起始位是从16进制字符串的字符所在位置算起：比如要掩码EPC的数据： EPC :E280FE9889895674 如果要掩码其中的"FE98"那么这里的起始位置则填 12（bits） (因为EPC前面还有CRC+PC) 如果是TID或USER： USER(或TID)：00001234567898762345 如果要掩码其中的"56789876"那么这里的起始位置填 32（bits）
lenMask	int	掩码长度，这里长度的参数跟其他方法参数有差异，是需要过滤的数据的16进制字符串字符长度，且长度值需是偶数: 比如要掩码EPC的数据： EPC :E280FE9889895674 如果要掩码其中的"FE98"那么这里的长度填 16（bits）又或者EPC：00001234567898762345 如果要掩码其中的"567898762345"那么这里的长度填 48（bits）
datasMask	String	要过滤的内容，十六进制数据。（数据长度需是十六进制字符串2个字符的倍数）

示例

java

例子:
标签内容 :
Epc:123456789
Tid:234567891
如果要过滤从第二个字母开始的TID区域，则需要使用4567过滤数据。您应该设置:
memMask:MemoryBank.TID,startMask:8,lenMask：16，datasMask:4567.
The code:
RFIDSDKManager.getInstance().getRfidManager().addMask(MemoryBank.TID,8,16,"4567")

参数	类型	说明
flag	boolean	true:返回频点和相位信息； false:不返回频点和相位信息；默认不返回。

返回值

true:返回频点和相位信息； false:不返回频点和相位信息；

返回值

返回List集合。

返回值

返回List集合。

返回值

返回List集合。

可通过下面方法获取盘点是否返回PC值的标识： boolean enable = RFIDSDKManager.getInstance().getRfidManager().getInventoryPCEnabled();

返回值

成功: RfidErrorConstants.SUCCESS； ( int) 失败：其他(错误码信息详见:<附录1：常见错误码>)。

示例

java

RFIDSDKManager.getInstance().getRfidManager().setInventoryPCEnabled(true);

调用路径：RFIDSDKManager.getInstance().getRfidManager()

参数	类型	说明
EPC	Stirng	标签的EPC(不包含CRC和PC)，数据长度必须是 1 字长(Word) 的整数倍（即十六进制字符串长度为 4 的倍数）。
password	String	标签的访问密码，2个字长，16进制字符串格式。
memBank	int	TAG存储区：; MemoryBank.RESERVED(密码区，前2个字是销毁密码，后2个字是访问密码); MemoryBank.EPC (EPC); MemoryBank.TID (TID); MemoryBank.USER (USER)
startAdd	int	要读取/写入的内存区域的起始位置，以字（Word）地址（Word Address）为单位。
wordCnt	int	读取的字(Word)长度（如果要读取的内容很长，建议循环读取,每次读取的最大长度为32个字长）

返回值

TagResult 类字段信息： (TagResult) code: 状态码：成功：RfidErrorConstants.SUCCESS；失败：其他(错误码信息详见:附录1：常见错误码)。 message:错误信息。 data:如果 code == RfidErrorConstants.SUCCESS ,该字段返回读到的标签值内容。

参数	类型	说明
EPC	String	标签的EPC(不包含CRC和PC)，数据长度必须是 1 字长(Word) 的整数倍（即十六进制字符串长度为 4 的倍数）。
password	String	标签的访问密码，2个字长，16进制字符串格式。
memBank	int	TAG存储区：; MemoryBank.RESERVED(RESERVED); MemoryBank.EPC (EPC); MemoryBank.TID (TID); MemoryBank.USER (USER)
startAdd	int	要读取/写入的内存区域的起始位置，以字（Word）地址（Word Address）为单位。注意，如果是写 EPC 区： 1>.如果要改变EPC的长度，需从PC位(起始地址为1) 开始写，同时要计算PC位(PC: Protocol Control, 协议控制位)的值作为写入内容放到写入内容的第一个字； 2>.如果写之后不需要改变EPC的长度，从起始地址2开始写即可。
writeData	String	待写入的数据，16进制字符串，数据长度必须是 1 字长(Word) 的整数倍（即十六进制字符串长度为 4 的倍数）。如果写入内容很大，建议循环写入,每次写入的最大长度为32个字长。

返回值

成功: RfidErrorConstants.SUCCESS； (int) 失败：其他(错误码信息详见:附录1：常见错误码)。

com.ubx.usdk.RfidManager

writeTagEpc

修改标签的EPC值(会默认改动PC值)，通过原EPC值改写成写入的EPC值，即把标签EPC号改成新写入的。

int writeTagEpc(String EPC, String password, String writeData);

参数	类型	说明
EPC	String	标签的EPC(不包含CRC和PC)，数据长度必须是 1 字长(Word) 的整数倍（即十六进制字符串长度为 4 的倍数）。
password	String	标签的访问密码，2个字长，16进制字符串格式。
writeData	String	待写入的数据，16进制字符串，数据长度必须是 1 字长(Word) 的整数倍（即十六进制字符串长度为 4 的倍数）。

返回值

成功: RfidErrorConstants.SUCCESS； (int) 失败：其他(错误码信息详见:附录1：常见错误码)。

参数	类型	说明
EPC	String	16进制字符串，数据长度必须是 1 字长(Word) 的整数倍（即十六进制字符串长度为 4 的倍数）。
password	String	标签的访问密码，2个字长，16进制字符串格式。

返回值

成功: RfidErrorConstants.SUCCESS； (int) 失败：其他(错误码信息详见:附录1：常见错误码)。

参数	类型	说明
EPC	String	标签的EPC(不包含CRC和PC)，数据长度必须是 1 字长(Word) 的整数倍（即十六进制字符串长度为 4 的倍数）。
password	String	标签的访问密码
lockBank	int	LockMemBank.KILL_PW -- 控制Kill密码读写保护设定。 LockMemBank.ACCESS_PW -- 控制访问密码读写保护设定。 LockMemBank.EPC -- 控制EPC存储器读写保护设定。 LockMemBank.TID -- 控制TID存储器读写保护设定。 LockMemBank.USER -- 控制用户存储器读写保护设定。
lockType	int	可设置的值： LockType.SET_READABLE_OR_WRITABLE LockType.SET_ALWAYS_READ_ABLE_OR_WRITABLE LockType.SET_WITH_PASSWORD_READABLE_OR_WRITABLE LockType.SET_NEVER_READABLE_OR_WRITABLE 该参数在lockBank不同时，其设置的含义不一样，具体说明见下表：《lockBank 和 lockType 的关系说明》

返回值

成功: RfidErrorConstants.SUCCESS； (int) 失败：其他(错误码信息详见:附录1：常见错误码)。

lockBank 和 lockType 的关系说明：

	LockMemBank.KILL_PW
	LockMemBank.ACCESS_PW LockMemBank.TID
	LockMemBank.USER
LockType.SET_READABLE_OR_WRITABLE	设置为可读写设置为可写
LockType.SET_ALWAYS_READ_ABLE_OR_WRITABLE	设置为永远可读写设置为永远可写
LockType.SET_WITH_PASSWORD_READABLE_OR_WRITABLE	设置为带密码可读写设置为带密码可写
LockType.SET_NEVER_READABLE_OR_WRITABLE	设置为永远不可读写设置为永远不可写。

com.ubx.usdk.RfidManager

killTag

销毁标签（销毁密码不能为默认密码00000000，如果销毁密码是默认密码00000000,需要先修改成其他，再去销毁）。

int killTag(String EPC, String password);

参数	类型	说明
EPC	String	标签的EPC(不包含CRC和PC)，数据长度必须是 1 字长(Word) 的整数倍（即十六进制字符串长度为 4 的倍数）。
password	String	销毁密码,2个字长，16进制字符串格式。

返回值

成功: RfidErrorConstants.SUCCESS； (int) 失败：其他(错误码信息详见:附录1：常见错误码)。

参数	类型	说明
TID	String	标签的TID，十六进制字符串。
menBank	int	TAG存储区：; MemoryBank.RESERVED(RESERVED); MemoryBank.EPC (EPC); MemoryBank.TID (TID); MemoryBank.USER (USER)
startAdd	int	要读取/写入的内存区域的起始位置，以字（Word）地址（Word Address）为单位。
wordCnt	int	读取的字(Word)长度（如果要读取的内容很长，建议每次读取最大32个字长的内容，做循环读取）
password	String	标签的访问密码，2个字长，16进制字符串格式。

返回值

成功返回读取的内容，不成功返回null。

参数	类型	说明
TID	String	标签的TID，16进制字符串
memBank	int	TAG存储区：; MemoryBank.RESERVED(RESERVED); MemoryBank.EPC (EPC); MemoryBank.TID (TID); MemoryBank.USER (USER)
startAdd	int	要读取/写入的内存区域的起始位置，以字（Word）地址（Word Address）为单位。
password	String	标签的访问密码，2个字长，16进制字符串格式。
writeData	String	待写入的数据，16进制字符串，数据长度必须是 1 字长(Word) 的整数倍（即十六进制字符串长度为 4 的倍数）。

返回值

成功: RfidErrorConstants.SUCCESS； (int) 失败：其他(错误码信息详见:附录1：常见错误码)。

参数	类型	说明
TID	String	标签的TID，16进制字符串格式。
lockBank	int	LockMemBank.KILL_PW -- 控制Kill密码读写保护设定。 LockMemBank.ACCESS_PW -- 控制访问密码读写保护设定。 LockMemBank.EPC -- 控制EPC存储器读写保护设定。 LockMemBank.TID -- 控制TID存储器读写保护设定。 LockMemBank.USER -- 控制用户存储器读写保护设定。
lockType	int	可设置的值： LockType.SET_READABLE_OR_WRITABLE LockType.SET_ALWAYS_READ_ABLE_OR_WRITABLE LockType.SET_WITH_PASSWORD_READABLE_OR_WRITABLE LockType.SET_NEVER_READABLE_OR_WRITABLE 该参数在lockBank不同时，其设置的含义不一样，具体说明见下表：《lockBank 和 lockType 的关系说明》
password	String	标签的访问密码，2个字长。

返回值

成功: RfidErrorConstants.SUCCESS； (int) 失败：其他(错误码信息详见:附录1：常见错误码)。

lockBank 和 lockType 的关系说明：

	LockMemBank.KILL_PW
	LockMemBank.ACCESS_PW LockMemBank.TID
	LockMemBank.USER
LockType.SET_READABLE_OR_WRITABLE	设置为可读写设置为可写
LockType.SET_ALWAYS_READ_ABLE_OR_WRITABLE	设置为永远可读写设置为永远可写
LockType.SET_WITH_PASSWORD_READABLE_OR_WRITABLE	设置为带密码可读写设置为带密码可写
LockType.SET_PERMANENT_NOT_READABLE_OR_WRITABLE	设置为永远不可读写设置为永远不可写。

com.ubx.usdk.RfidManager

killTagByTid

通过TID销毁标签（销毁密码不能为默认密码00000000，如果销毁密码是默认密码00000000,需要先修改成其他，再去销毁）。

int killTagByTid( String TID, String password);

参数	类型	说明
TID	String	标签的TID，16进制字符串格式。
password	String	销毁密码,2个字长，16进制字符串格式。

返回值

成功: RfidErrorConstants.SUCCESS； (int) 失败：其他(错误码信息详见:附录1：常见错误码)。

com.ubx.usdk.RfidManager

writeTagEpcByTid

修改标签的EPC值，通过TID值,把标签当前的EPC值改写成写入的(writeData)EPC值，会自动改写PC值。

int writeTagEpcByTid(String TID, String password, String writeData);

参数	类型	说明
TID	String	标签的TID。
password	String	标签的访问密码，2个字长，16进制字符串格式。
writeData	String	待写入的数据，16进制字符串，数据长度必须是 1 字长(Word) 的整数倍（即十六进制字符串长度为 4 的倍数）。

返回值

成功: RfidErrorConstants.SUCCESS； (int) 失败：其他(错误码信息详见:附录1：常见错误码)。

参数	类型	说明
memBank	int	要读取的TAG存储区：; MemoryBank.RESERVED(RESERVED); MemoryBank.EPC (EPC); MemoryBank.TID (TID); MemoryBank.USER (USER)
startAdd	int	要读取/写入的内存区域的起始位置，以字（Word）地址（Word Address）为单位。
wordCnt	int	读取的字(Word)长度（如果要读取的内容很长，建议每次读取最大32个字长的内容，做循环读取）
password	String	标签的访问密码，2个字长，16进制字符串格式。
memMask	int	过滤区域：; MemoryBank.RESERVED(RESERVED); MemoryBank.EPC (EPC); MemoryBank.TID (TID); MemoryBank.USER (USER)
startMask	int	起始地址，这里地址的参数跟其他方法参数有差异，数据起始位是从16进制字符串的字符所在位置算起：比如要掩码EPC的数据： EPC :E280FE9889895674 如果要掩码其中的"FE98"那么这里的起始位置则填 48 (因为EPC前面还有前面还有CRC+PC) 如果是TID或USER： USER(或TID)：00001234567898762345 如果要掩码其中的"56789876"那么这里的起始位置填 32
lenMask	int	掩码长度（ bits）；比如要掩码EPC的数据： EPC :E280FE9889895674 如果要掩码其中的"FE98"那么这里的长度填 16(bits) 或者EPC：00001234567898762345 如果要掩码其中的"567898762345"那么这里的长度填 48 (bits)
datasMask	String	要过滤的内容，十六进制数据。（数据长度需是十六进制字符串2个字符的倍数）

返回值

TagResult 类字段信息： (String) code: 状态码：成功；RfidErrorConstants.SUCCESS；失败：其他(错误码信息详见:附录1：常见错误码)。 message:错误信息。 data:如果 code == RfidErrorConstants.SUCCESS ,该字段返回读到的标签值内容。

示例

java

例子:
标签内容 :
Epc:123456789999
Tid:23456789000055557777
User:345678912
**示例1：**
**操作描述：**
读取 EPC 区数据（从第2字开始，读3字长），同时过滤 TID 区（从第5字符开始，匹配2字符 "56"）
**参数解析**：
RFIDSDKManager.getInstance().getRfidManager().maskReadTag(
MemoryBank.EPC, // 目标存储区：EPC
2, // 起始字地址：2 (Word Address)
3, // 读取长度：3 Words
"00000000", // 访问密码（默认值）
MemoryBank.TID, // 掩码存储区：TID
16, // 掩码起始位置：16(bits)
8, // 掩码长度：8(bits)
"56" // 匹配值："56"
)
**示例2：**
**操作描述：**
读取 EPC 区数据（从第2字开始，读3字长），同时过滤 EPC 区自身（跳过前8字符 CRC+PC，从第13字符开始匹配 "6789"）
**参数解析：**
RFIDSDKManager.getInstance().getRfidManager().maskReadTag(
MemoryBank.EPC, // 目标存储区：EPC
2, // 起始字地址：2 (Word Address)
3, // 读取长度：3 Words
"00000000", // 访问密码（默认值）
MemoryBank.EPC, // 掩码存储区：EPC自身
52, // 掩码起始位置：第14字符（索引13）
16, // 掩码长度：16bits
"6789" // 匹配值："6789"
)

示例1：

操作描述： 读取 EPC 区数据（从第2字开始，读3字长），同时过滤 TID 区（从第5字符开始，匹配2字符 "56"） 参数解析： RFIDSDKManager.getInstance().getRfidManager().maskReadTag( MemoryBank.EPC, // 目标存储区：EPC 2, // 起始字地址：2 (Word Address) 3, // 读取长度：3 Words "00000000", // 访问密码（默认值） MemoryBank.TID, // 掩码存储区：TID 16, // 掩码起始位置：16(bits) 8, // 掩码长度：8(bits) "56" // 匹配值："56" )

示例2：

操作描述： 读取 EPC 区数据（从第2字开始，读3字长），同时过滤 EPC 区自身（跳过前8字符 CRC+PC，从第13字符开始匹配 "6789"）

参数解析：

RFIDSDKManager.getInstance().getRfidManager().maskReadTag( MemoryBank.EPC, // 目标存储区：EPC 2, // 起始字地址：2 (Word Address) 3, // 读取长度：3 Words "00000000", // 访问密码（默认值） MemoryBank.EPC, // 掩码存储区：EPC自身 52, // 掩码起始位置：第14字符（索引13） 16, // 掩码长度：16bits "6789" // 匹配值："6789" )

<!-- api:RfidManager.maskWriteTag -->
### RfidManager.maskWriteTag

写标签。

**方法**

int maskWriteTag( String writeData, int memBank, int startAdd ,int wordCnt , String password, int memMask, int startMask, int lenMask, String datasMask);

| 参数 | 类型 | 说明 |
|------|------|------|
| writeData | String | 待写入的16进制数据。 |
| memBank | int | TAG存储区：; MemoryBank.RESERVED(RESERVED); MemoryBank.EPC (EPC); MemoryBank.TID (TID); MemoryBank.USER (USER) |
| startAdd | int | 要读取/写入的内存区域的起始位置，以字（Word）地址（Word Address） 为单位。<br>注意，如果是写 EPC 区：<br>1>.如果要改变EPC的长度，需从PC位(起始地址为1) 开始写，同时要计算PC位的值作为写入内容放到写入内容的第一个字；<br>2>.如果写之后不需要改变EPC的长度，从起始地址2开始写即可。 |
| wordCnt | int | 读取的字(Word)长度（如果要读取的内容很长，建议每次读取最大32个字长的内容，做循环读取） |
| password | String | 标签的访问密码，2个字长，16进制字符串格式。 |
| memMask | int | 过滤区域：; MemoryBank.RESERVED(RESERVED); MemoryBank.EPC (EPC); MemoryBank.TID (TID); MemoryBank.USER (USER) |
| startMask | int | 掩码起始地址，bits位,数据起始位是从16进制字符串的字符所在位置算起：<br>比如要掩码EPC的数据：<br>EPC :E280FE9889895674<br>如果要掩码其中的"FE98"那么这里的起始位置则填 48 (因为EPC前面还有前面还有CRC+PC)<br>如果是TID或USER：<br>USER(或TID)：00001234567898762345<br>如果要掩码其中的"56789876"那么这里的起始位置填 32 |
| lenMask | int | 掩码长度，bits: 比如要掩码EPC的数据：<br>EPC :E280FE9889895674<br>如果要掩码其中的"FE98"那么这里的长度填 16（bits）<br>又或者EPC：00001234567898762345<br>如果要掩码其中的"567898762345"那么这里的长度填 48（bits） |
| datasMask | String | 要过滤的内容，十六进制数据。（ 数据长度需是十六进制字符串2个字符的倍数） |

**返回值**

成功: RfidErrorConstants.SUCCESS；
(int)
失败：其他(错误码信息详见:附录1：常见错误码)。

**示例**

标签内容 : EPC:123456789999 TID:234567890000555577778888 USER:34567891 示例1：写EPC区 + 过滤TID区 操作需求： 将EPC区写入数据 999999999999（12字符，需3字长度）过滤条件：TID区从第4字符（索引3）开始取2字符，匹配值 "56" 参数转换： 过滤起始位 startMask=12（索引3对应第4字符）过滤长度 lenMask=8 代码实现： RFIDSDKManager.getInstance().getRfidManager().maskWriteTag( "999999999999", // 写入数据 MemoryBank.EPC, // 写入存储区 2, // 写入起始地址（2字=8字符偏移） 3, // 写入长度（3字=12字符） "00000000", // 保留参数（固定值） MemoryBank.TID, // 过滤存储区 12, // 过滤起始索引（字符位置）（bits） 8, // 过滤长度（bits） "56" // 过滤匹配值 ); 示例2：写USER区 + 过滤EPC区 操作需求： 将USER区写入数据 55555555（8字符，需2字长度）过滤条件：EPC区从第14字符（索引13）开始取2字符，匹配值 "67" 参数转换： 过滤起始位 startMask=52bits 过滤长度 lenMask=8bits 代码实现： RFIDSDKManager.getInstance().getRfidManager().maskWriteTag( "55555555", // 写入数据 MemoryBank.USER, // 写入存储区 0, // 写入起始地址（0字=USER区起始位置） 2, // 写入长度（2字=8字符） "00000000", // 保留参数（固定值） MemoryBank.EPC, // 过滤存储区 52, // 过滤起始索引（bits） 8, // 过滤长度（bits） "67" // 过滤匹配值 );

**示例1：写EPC区 + 过滤TID区**

**操作需求：**
将EPC区写入数据 999999999999（12字符，需3字长度）
过滤条件：TID区从第4字符（索引3） 开始取2字符，匹配值 "56"

**参数转换：**

过滤起始位 startMask=12（索引3对应第4字符）
过滤长度 lenMask=8

**代码实现：**

RFIDSDKManager.getInstance().getRfidManager().maskWriteTag(
"999999999999", // 写入数据
MemoryBank.EPC, // 写入存储区
2, // 写入起始地址（2字=8字符偏移）
3, // 写入长度（3字=12字符）
"00000000", // 保留参数（固定值）
MemoryBank.TID, // 过滤存储区
12, // 过滤起始索引（字符位置）（bits）
8, // 过滤长度（bits）
"56" // 过滤匹配值
);

**示例2：写USER区 + 过滤EPC区**

**操作需求：**
将USER区写入数据 55555555（8字符，需2字长度）
过滤条件：EPC区从第14字符（索引13） 开始取2字符，匹配值 "67"

**参数转换：**

过滤起始位 startMask=52bits
过滤长度 lenMask=8bits

**代码实现：**

RFIDSDKManager.getInstance().getRfidManager().maskWriteTag(
"55555555", // 写入数据
MemoryBank.USER, // 写入存储区
0, // 写入起始地址（0字=USER区起始位置）
2, // 写入长度（2字=8字符）
"00000000", // 保留参数（固定值）
MemoryBank.EPC, // 过滤存储区
52, // 过滤起始索引（bits）
8, // 过滤长度（bits）
"67" // 过滤匹配值
);

参数	类型	说明
EPC	Stirng	标签的EPC(不包含CRC和PC)，数据长度必须是 1 字长(Word) 的整数倍（即十六进制字符串长度为 4 的倍数）。
memBank	int	TAG存储区：; MemoryBank.RESERVED(RESERVED); MemoryBank.EPC (EPC); MemoryBank.TID (TID); MemoryBank.USER (USER)
startAdd	int	要读取/写入的内存区域的起始位置，以字（Word）地址（Word Address）为单位。注意，如果是写 EPC 区： 1>.如果要改变EPC的长度，需从PC位(起始地址为1) 开始写，同时要计算PC位的值作为写入内容放到写入内容的第一个字； 2>.如果写之后不需要改变EPC的长度，从起始地址2开始写即可。
wordCnt	int	读取的字(Word)长度（如果要读取的内容很长，建议每次读取最大32个字长的内容，做循环读取）
password	String	标签的访问密码，2个字长，16进制字符串格式。

返回值

TagResult 类字段信息： (String) code: 状态码：成功：RfidErrorConstants.SUCCESS；失败：其他(错误码信息详见:附录1：常见错误码)。 message:错误信息。 data:如果 code == RfidErrorConstants.SUCCESS ,该字段返回读到的标签值内容。

参数	类型	说明
EPC	String	标签的EPC(不包含CRC和PC)，数据长度必须是 1 字长(Word) 的整数倍（即十六进制字符串长度为 4 的倍数）。
password	String	标签的访问密码，2个字长，16进制字符串格式。
memBank	int	TAG存储区：; MemoryBank.RESERVED(RESERVED); MemoryBank.EPC (EPC); MemoryBank.TID (TID); MemoryBank.USER (USER)
startAdd	int	要读取/写入的内存区域的起始位置，以字（Word）地址（Word Address）为单位。注意，如果是写 EPC 区： 1>.如果要改变EPC的长度，需从PC位(起始地址为1) 开始写，同时要计算PC位的值作为写入内容放到写入内容的第一个字； 2>.如果写之后不需要改变EPC的长度，从起始地址2开始写即可。
writeData	String	待写入的数据，16进制字符串，数据长度必须是 1 字长(Word) 的整数倍（即十六进制字符串长度为 4 的倍数）。

返回值

成功: RfidErrorConstants.SUCCESS； (int) 失败：其他(错误码信息详见:附录1：常见错误码)。

参数	类型	说明
EPC	Stirng	标签的EPC(不包含CRC和PC)，数据长度必须是 1 字长(Word) 的整数倍（即十六进制字符串长度为 4 的倍数）。
password	String	标签的访问密码，2个字长，16进制字符串格式。
memBank	int	TAG存储区：; MemoryBank.RESERVED(密码区，前2个字是销毁密码，后2个字是访问密码); MemoryBank.EPC (EPC); MemoryBank.TID (TID); MemoryBank.USER (USER)
startAdd	int	擦除的起始字地址，以字（Word）地址（Word Address）为单位。
wordCnt	int	擦除的字(Word)长度。

返回值

成功: RfidErrorConstants.SUCCESS； (int) 失败：其他(错误码信息详见:附录1：常见错误码)。

参数	类型	说明
selectEpc	String	标签的epc号

返回值

返回Tag6C 不为空则表示读到标签。 (int) 通过 Tag6C 的rssi 字段，来判断信号的强弱，以此来判断是否靠近标签，进行定位判断。 使用此方法，建议在异步线程使用，方法执行结束后，马上再次调用，如此循环，来达到快速获取标签的信号值。 可通过 setRssiUnitType(RssiUnitType unitType); 方法设置返回信号的类型.

使用此方法，建议在异步线程使用，方法执行结束后，马上再次调用，如此循环，来达到快速获取标签的信号值。

可通过 setRssiUnitType(RssiUnitType unitType); 方法设置返回信号的类型.

参数	类型	说明
EPC	String	标签的EPC
password	String	标签的访问密码，2个字长，16进制字符串格式。
milliseconds	int	参数范围100ms - 25500ms ; 要以100ms的倍数传参。比如需要点亮最大的 25500 毫秒，传 255.

返回值

成功: RfidErrorConstants.SUCCESS； (int) 失败：其他(错误码信息详见:附录1：常见错误码)。

参数	类型	说明
manufacturers	int	厂商编号（0或1） 0：凯路威 1：宜联
epcs	List<String>	需要点亮的EPC标签集合

返回值

成功: RfidErrorConstants.SUCCESS； (int) 失败：其他(错误码信息详见:附录1：常见错误码)。

调用路径：RFIDSDKManager.getInstance().getRfidManager()

setWorkRegion

根据区域设置频段；备注：如果要设置的地区，在附录4: 区域对照表中找不到，您可以参考API 中 setFrequencyRegion() 方法进行设置。

int setWorkRegion(CountryCode cntyCode );

参数	类型	说明
cntyCode	CountryCode	国际区域参数（附录4: 区域对照表）例如： CountryCode.ALB CountryCode.BEL ...

返回值

成功: RfidErrorConstants.SUCCESS； (int) 失败：其他(错误码信息详见:附录1：常见错误码)。

示例

java

int ret = RFIDSDKManager.getInstance().getRfidManager()
.setWorkRegion(CountryCode.ALB);

com.ubx.usdk.RfidManager

getWorkRegion

获取当前设备使用的区域频段信息。如果获取结果为null,则可能是之前没有通过setWorkRegion(CountryCode cntyCode ) 设置过，可以使用 getFrequencyRegion() 方法来获取当前的频段信息。

CountryCode getWorkRegion();

返回值

成功：CountryCode 不为null ； (CountryCode ) 失败：CountryCode 为null；

参数	类型	说明
region	FrequencyRegion	频段类型。 FrequencyRegion.UKRAINE;//Ukraine band FrequencyRegion.CHINESE1;//Chinese band 1 FrequencyRegion.EU;//EU band FrequencyRegion.CHINESE2;//Chinese band 2 FrequencyRegion.US;//US band FrequencyRegion.KOREAN;//Korean band FrequencyRegion.PERU;//Peru band FrequencyRegion.US3;//US band3 FrequencyRegion.Taiwan;//Taiwan band 详见：附录2：频段说明
btStartIndex	int	频谱的起始频点索引。
btEndIndex	int	频谱的终止频点索引设置射频输出频谱的范围。规则： 1、起始频率和终止频率应在规定的规定范围内。 2、起始频率应等于或低于终止频率。 3、结束频率等于起始频率，即使用单频点。

返回值

成功: RfidErrorConstants.SUCCESS； (int) 失败：其他(错误码信息详见:[[<附录1：常见错误码>]{.underline}](#附录1常见错误码))。

示例

java

int ret =
RFIDSDKManager.getInstance().getRfidManager().setFrequencyRegion(FrequencyRegion.US, FrequencyRegion.US.getMinChannelIndex(),FrequencyRegion.US.getMaxChannelIndex());

返回值

FrequencyRegion frequencyRegion = (FrequencyRegion ) RFIDSDKManager.getInstance().getRfidManager().getFrequencyRegion();

获取频谱频段：frequencyRegion.getbtRegion()
获取起始频点索引：frequencyRegion.getMinChannelIndex()
获取终止频点索引：frequencyRegion.getMaxChannelIndex()
计算起始频率（MHz）：

float startFreq = frequencyRegion.getStartFreqMHz() + frequencyRegion.getMinChannelIndex() * frequencyRegion.getStepSizeMHz()

计算结束频率（MHz）：

float endFreq = frequencyRegion.getStartFreqMHz() + frequencyRegion.getMaxChannelIndex() * frequencyRegion.getStepSizeMHz() 如果frequencyRegion为null，表示获取失败。

返回值

返回String类型的RFID模块固件版本信息 (String)

参数	类型	说明
enable	int	0-关闭；1-打开

返回值

成功: RfidErrorConstants.SUCCESS； (int) 失败：其他(错误码信息详见:附录1：常见错误码)。

返回值

成功: RfidErrorConstants.SUCCESS-关闭；1-开启； (int) 失败：其他(错误码信息详见:附录1：常见错误码)。

返回值

模块信息 (String)

返回值

成功：大于0 (int) 失败：-1。

返回值

返回字符串格式的温度值，单位（摄氏度） (String)

参数	类型	说明
flags	int	下电是否保存设置标识 0：保存 1：不保存
int	FreSpace	频段间隔（单位KHz），参数需要是 125 的倍数。
int	FreNum	频点数量
int	StartFre	起始频率（单位KHz）

返回值

成功: RfidErrorConstants.SUCCESS； (int) 失败：其他(错误码信息详见:附录1：常见错误码)。

com.ubx.usdk.RfidManager

getCustomRegion

获取自定义频段信息；注意：设置自定义频段后，调用getFrequencyRegion()无法获取标准频段的相关信息。

CustomRegionBean getCustomRegion();

返回值

CustomRegionBean customRegion = rfidManager.getCustomRegion(); (CustomRegionBean ) if (customRegion != null) { // 提取参数 int band = customRegion.band[0]; //频段区域 int stepKHz = customRegion.FreSpace[0]; //频段间隔（单位KHz） int channelCount = customRegion.FreNum[0]; //频点数量 int startFreqKHz = customRegion.StartFre[0]; //起始频率（单位KHz） } else { System.err.println("获取自定义频段配置失败！"); }

返回值

RFID的芯片信息，包含芯片类型和版本号. ( ExVersionInfo ) ExVersionInfo 说明 : public class ExVersionInfo { public int code ; //返回值成功: RfidErrorConstants.SUCCESS 失败：其他 public String versionInfo ; //芯片的固件版本号 public int type ; // EXChipType.E310: E310; EXChipType.E510: E510; EXChipType.E710: E710; EXChipType.OTHER: 其他 }

参数	类型	说明
enable	boolean	true:开启日志；false:关闭日志

最新建议使用：UlogManager.enableLog(true); true:开启日志 false:关闭日志；用此方法在调用本SDK前先设置一次，日志文件会保存在 /sdcard/Download/rfidLog ，记录文件需要存储权限。

参数

名称	类型	备注
enable	boolean	true:开启日志；false:关闭日志

返回值

int说明 : ( int) ReaderDeviceType.UNKNOW: 未知; ReaderDeviceType.INTEGRATED: 一体机设备; ReaderDeviceType.PERIPHERAL_UART:串口设备; ReaderDeviceType.BLE_DEVICE: 蓝牙设备 }

返回值

ModuleType说明 : ( int) ModuleType.OTHER ModuleType.U1 ModuleType.U2 ModuleType.U3 ModuleType.U4 ModuleType.U5 }

调用路径：RFIDSDKManager.getInstance().getRfidManager()

参数	类型	说明
enable	boolean	true-打开,false-关闭

返回值

成功: RfidErrorConstants.SUCCESS； (int) 失败：其他(错误码信息详见:附录1：常见错误码)。

com.ubx.usdk.RfidManager

setBeepVolume

设置蜂鸣器音量,volume 默认为4，注意：这个值设置越大耗电会越高，使用的时候请根据实际场景进行设置或使用默认。

int setBeepVolume(int volume);

参数	类型	说明
volume	int	范围 1-10，默认4. 1最小，10最大。

返回值

成功: RfidErrorConstants.SUCCESS； (int) 失败：其他(错误码信息详见:附录1：常见错误码)。

调用路径：RFIDSDKManager.getInstance().getRfidManager()

本章接口仅适用于固定式读写器 FR1000，手持 PDA 无此功能。

参数	类型	说明
antennaStatus	AntennaStatus	AntennaStatus { //false未连接，true已连接 boolean ant1 = false; boolean ant2 = false; boolean ant3 = false; boolean ant4 = false; boolean ant5 = false; boolean ant6 = false; boolean ant7 = false; boolean ant8 = false; } 以上分别对应1-8天线的连接情况。

返回值

成功: antennaStatus 不为空； (AntennaStatus) 失败：antennaStatus 为null.

示例

java

AntennaStatus result =
RFIDSDKManager.getInstance().getRfidManager().checkAntennaStatus();

参数	类型	说明
antennaSet	AntennaSet	AntennaSet { boolean ant1 = false;//false不启用，true启用 boolean ant2 = false; boolean ant3 = false; boolean ant4 = false; boolean ant5 = false; boolean ant6 = false; boolean ant7 = false; boolean ant8 = false; } 以上分别对应1-8天线的启用，且必须有一根天线为启用状态。

返回值

成功: RfidErrorConstants.SUCCESS； (int) 失败：其他(错误码信息详见:附录1：常见错误码)。

示例

java

RFIDSDKManager.getInstance().getRfidManager().setInventoryAntennaMultiplexing(antennaSet);

**如要获取已启用的的盘点使用的天线：**
ResultAntenna result =
RFIDSDKManager.getInstance().getRfidManager().getInventoryAntennaMultiplexing();
其中：
result.code :
RfidErrorConstants.SUCCESS ：成功
其他(错误码信息详见:附录1：常见错误码)：失败
AntennaSet antennaSet = result.antennaSet;
antennaSet 即返回的盘点模式下启用的天线状态。

参数	类型	说明
antennaSet	AntennaSet	AntennaSet { boolean ant1 = false;//false不启用，true启用 boolean ant2 = false; boolean ant3 = false; boolean ant4 = false; boolean ant5 = false; boolean ant6 = false; boolean ant7 = false; boolean ant8 = false; } 以上分别对应1-8天线的启用，且必须有一根天线为启用状态。

返回值

成功: RfidErrorConstants.SUCCESS； (int) 失败：其他(错误码信息详见:附录1：常见错误码)。

示例

java

RFIDSDKManager.getInstance().getRfidManager().setAccessAntennaMultiplexing(antennaSet);

**如要获取Access操作启用的天线**：
ResultAntenna result =
RFIDSDKManager.getInstance().getRfidManager().getAccessAntennaMultiplexing();
其中：
result.code :
RfidErrorConstants.SUCCESS ：成功
其他(错误码信息详见:附录1：常见错误码)：失败
AntennaSet antennaSet = result.antennaSet;
antennaSet 即返回的Access操作启用的天线状态。

注意事项：

1>.确保SD已初始化：RFIDSDKManager 已完成 init或initBTtoMac；

2>.固件包格式 : ZIP 压缩包，直接用我司提供的固件包即可，不要解压、不要修改文件名称，不要修改文件格式；

3>.Context: 常规检测可用 ApplicationContext ;带UI升级（showUI=true）须传入 Activity Context；

4>.权限 : BLE Sled 升级 BLE 固件时，Android 12+（API 31+）需已授予 BLUETOOTH_CONNECT；

5>.非线程安全: 请勿并发调用多个检测/升级流程；同一时刻只应有一个升级任务。 6>.BLE Sled升级需要注意：需要增加额外配置：

新增依赖包：

implementation 'no.nordicsemi.android:dfu:2.9.0' implementation 'com.google.code.gson:gson:2.11.0'

混淆规则：

-keep class no.nordicsemi.*{;}

AndroidManifest.xml 添加如下配置：

<uses-permission android:name="android.permission.FOREGROUND_SERVICE"/>

<uses-permission android:name="android.permission.FOREGROUND_SERVICE_CONNECTED_DEVICE"/>

使用的类：RFUpgradeManager.getInstance();

调用步骤：

checkUpgrade() → [用户确认] → startUpgrade()

调用路径：RFUpgradeManager.getInstance()

checkUpgrade

通过异步方式，检测本地的固件包，判断固件版本，返回是否需要升级的标识。

void checkUpgrade(Context context, UpgradeSource source, FirmwareUpgradeCallback callback);

参数	类型	说明
context	Context	上下文
source	UpgradeSource	RFUpgradeManager.UpgradeSource source = null; assets 相对路径，如 `"bin/xxxx.zip" source = RFUpgradeManager.UpgradeSource.fromAssets("bin/" + "xxxx.zip"); 从本地文件系统读取；文件须存在且可读: source = RFUpgradeManager.UpgradeSource.fromLocalPath(getFilesDir()+"/files/"+"xxxx.zip");
myCallback	FWUpdateCallback	见下方说明

示例

java

RFUpgradeManager.getInstance().checkUpgrade(
context,RFUpgradeManager.UpgradeSource.fromAssets("bin/your_firmware.zip"),
new FirmwareUpgradeCallback() {
@Override
public void onCheckResult(UpgradeCheckResult result, UpgradeInfo info) {
if (!result.checkPassed) {
// 处理失败：result.errorMessage
return;
}
if (!result.hasUpgrade) {
// 已是最新
return;
}
// 需要升级：使用 info 展示详情
RFUpgradeManager.getInstance().showConfirmDialog(
activity, info, "", "", confirmListener);
}
// onStepChanged / onUpgradeFinished / onError ...
});

FWUpdateCallback回调方法有下面4个：

- onCheckResult(UpgradeCheckResult result, UpgradeInfo info) 触发于： checkUpdate()；

onStepChanged(UpgradeStepEvent event) 触发于：startUpgrade()的升级过程中；

onUpgradeFinished(boolean success, String message) 升级流程全部结束:

success:true 升级成功 false 升级失败，

message：升级成功或失败的原因

onError(int errorCode, String message) 校验升级或者开始升级过程，回调出现的错误。

成功/失败均通过 `onCheckResult(result,info)回调

UpgradeCheckResult

要关注以下字段：

checkPassed： boolean 是否检测/解压通过；

hasUpgrade： Boolean 是否至少有一个固件需要升级；

errorMessage：String checkPassed=false 时的失败原因；

errorCode：int 错误码，0 表示无错误。

主要判断：

checkPassed=true && hasUpgrade=false：已是最新，不要调用 startUpgrade()，此时 info == null。

checkPassed=true && hasUpgrade=true：info 非 null，含固件与设备详情。

checkPassed=false：不可调用 startUpgrade()，info == null。

errorCode错误码说明：

com.ubx.usdk.RFUpgradeManager

checkUpgradeFromServer

通过在线检测升级的方式，返回是否需要升级的标识。本接口需要android设备能正常连接外部网络，并且应用有联网权限。添加权限： <uses-permission android:name="android.permission.INTERNET"/>

Void checkUpgradeFromServer(Context context, boolean showUI,, FirmwareUpgradeCallback callback);

参数	类型	说明
context	Context	上下文
showUI	boolean	true=弹出进度弹窗； false= 无弹窗，仅回调。
myCallback	FWUpdateCallback	见下方说明

返回值

(void)

示例

java

RFUpgradeManager.*getInstance*().checkUpgradeFromServer(this,true,
new FirmwareUpgradeCallback() {
@Override
public void onCheckResult(UpgradeCheckResult result, UpgradeInfo info) {
if (!result.checkPassed) {
// 处理失败：result.errorMessage
return;
}
if (!result.hasUpgrade) {
// 已是最新
return;
}
// 需要升级：使用 info 展示详情
RFUpgradeManager.getInstance().showConfirmDialog(
activity, info, "", "", confirmListener);
}
// onStepChanged / onUpgradeFinished / onError ...
});

FWUpdateCallback回调方法有下面4个：

- onCheckResult(UpgradeCheckResult result, UpgradeInfo info) 触发于： checkUpdate()；

onStepChanged(UpgradeStepEvent event) 触发于：startUpgrade()的升级过程中；

onUpgradeFinished(boolean success, String message) 升级流程全部结束:

success:true 升级成功 false 升级失败，

message：升级成功或失败的原因

onError(int errorCode, String message) 校验升级或者开始升级过程，回调出现的错误。

成功/失败均通过 `onCheckResult(result,info)回调

UpgradeCheckResult

要关注以下字段：

checkPassed： boolean 是否检测/解压通过；

hasUpgrade： Boolean 是否至少有一个固件需要升级；

errorMessage：String checkPassed=false 时的失败原因；

errorCode：int 错误码，0 表示无错误。

主要判断：

checkPassed=true && hasUpgrade=false：已是最新，不要调用 startUpgrade()，此时 info == null。

checkPassed=true && hasUpgrade=true：info 非 null，含固件与设备详情。

checkPassed=false：不可调用 startUpgrade()，info == null。

errorCode错误码说明：

3.2 开始升级

前置条件: 必须先成功调用 checkUpgrade() ，且 checkPassed=true、hasUpgrade=true

com.ubx.usdk.RFUpgradeManager

startUpgrade

开始升级固件，android主机需要电量大于20%以上， Sled设备电量需要大于10%以上。（方法内部有任何一项判断为失败会立即 onError，不进入升级）。

void startUpgrade(Context context, boolean showUI, FirmwareUpgradeCallback callback );

参数	类型	说明
context	Context	showUI=true 时必须为Activity Context（非 ApplicationContext）
showUI	boolean	true=弹出进度弹窗； false= 无弹窗，仅回调。
callback	FirmwareUpgradeCallback	可为 `null`；`showUI=true` 时仍建议传入以接收完成通知

示例

java

RFUpgradeManager.getInstance().startUpgrade(
MainActivity.this, true, upgradeCallback);

注意事项:

升级在后台线程执行，可能持续数分钟；弹窗期间屏幕常亮（FLAG_KEEP_SCREEN_ON）。

BLE Sled升级, BLE 固件前会进行配对检测（最长 5 分钟）。

MCU 升级后可能需用户手动按手柄开机，SDK 会循环重连并播放提示音。

不可在升级过程中再次调用 checkUpgrade / startUpgrade。

Activity finish() 或旋转屏幕可能导致升级中断；升级期间请锁定屏幕方向或阻止 Activity 销毁。

升级完请重启软件。

调用路径：GripDeviceManager.getInstance()

4.蓝牙、UART分体设备接口说明(非一体设备)

适用设备：本章节只适用于 RFG91 UART分体设备和蓝牙设备；

功能：获取条码扫描结果、设备状态回调监听、设备信息获取、参数设置等。

使用条件：接口的正常运行依赖于上面 [2.1 初始化和连接] 章节的初始化成功为前提。

扫描条码结果获取

接收扫描条码的结果。

参数	类型	说明
cb	BarcodeCallback	回调

示例

java

GripDeviceManager.getInstance().registerBarcodeCallback(new BarcodeCallback() {
@Override
public void onResult(byte[] barcode) {
//barcode 扫描到的条码结果
}
});

com.ubx.usdk.GripDeviceManager

setKeyEventListener

注册回调（该方法会在按下或抬起扫描按键时，监听到相应的事件）。 RFG91 按下按键后，默认不会执行RFID的相关操作，如果要通过RFG91上的按键来触发RFID的动作，需要监听本回调事件，并进行相应的接口调用，来触发RFID。

void setKeyEventListener(KeyEventListener cb);

参数	类型	说明
cb	KeyEventListener	按键状态回调： public void event(int keyCode, boolean isDown) { //keyCode== BTKeyEvent.BT_SCAN The handle button was pressed //isDown true: down false: up }

示例

java

GripDeviceManager.getInstance().setKeyEventListener(new KeyEventListener() {
@Override
public void event(int keyCode, boolean isDown) {
//keyCode== BTKeyEvent.BT_SCAN The handle button was pressed
//isDown true: down false: up
if (keyCode == BTKeyEvent.BT_SCAN) {
if (isDown ) {
//start Inventory
//RFIDSDKManager.getInstance().getRfidManager().startInventory(1);
} else {
//stop Inventory
//RFIDSDKManager.getInstance().getRfidManager().stopInventory();
}
}
}
});

com.ubx.usdk.GripDeviceManager

setBatteryGripListener

注册设备电池相关状态的回调，该方法会设备充电状态改变，电池电量变化时，监听到相应的值的改变），因为该方法是在状态改变的时候才会回调，所以如果要立刻获取充电状态以及设备电量，需要通过 getIsChange 和 getElectricQuantity 方法来获取。

void setBatteryGripListener(BatteryGripListener cb);

参数	类型	说明
cb	BatteryGripListener	设备充电状态、电量信息回调： new BatteryGripListener() { @Override public void isChange(int change) { //change 0：未充电 1：充电 } @Override public void level(int percent) { //percent 电量百分比 0-100% } };

示例

java

GripDeviceManager.getInstance().setBatteryGripListener(new BatteryGripListener() {
@Override
public void isChange(int change) {
//change 0：未充电 1：充电
}
@Override
public void level(int percent) {
//percent 电量百分比 0-100%
}
});

参数	类型	说明
enable	boolean	true:触发开始扫码 false:触发停止扫码

返回值

String sn= GripDeviceManager.getInstance().getDeviceSN();

参数	类型	说明
beep	int	范围：0-10 如果是0，则关闭蜂鸣器。

返回值

成功: RfidErrorConstants.SUCCESS； (int) 失败：其他(错误码信息详见:附录1：常见错误码)。

示例

java

int ret = GripDeviceManager.getInstance().setBeepRange(10);

返回值

返回蜂鸣器音量大小(小于0则获取失败) (int)

示例

java

int beepValue = GripDeviceManager.getInstance().getBeepRange();

参数	类型	说明
time	int	范围：0-3600 0：永不休眠 1-3600：到了对应的秒数就会自动进入休眠

返回值

成功: RfidErrorConstants.SUCCESS； (int) 失败：其他(错误码信息详见:附录1：常见错误码)。

示例

java

int ret = GripDeviceManager.getInstance().setSleepTime(60);

返回值

返回休眠时间(小于0则获取失败) (int)

示例

java

int sleepValue = GripDeviceManager.getInstance().getSleepTime();

com.ubx.usdk.GripDeviceManager

setPowerOffTime

设置超时关机的时间,在设备未被连接的状态下，如果没有对设备进行接口调用和按设备上的实体按键，在超时对应时间后，设备将关机。单位：秒

int setPowerOffTime(int offTime);

参数	类型	说明
offTime	int	范围：0-3600 0：永不自动关机 1-3600：到了对应的秒数就会自动关机

返回值

成功: RfidErrorConstants.SUCCESS； (int) 失败：其他(错误码信息详见:附录1：常见错误码)。

示例

java

int ret = GripDeviceManager.getInstance().setPowerOffTime(600);

返回值

返回超时关机的时间(小于0则获取失败) (int)

示例

java

int OFFValue =
GripDeviceManager.getInstance().getPowerOffTime();

返回值

成功：返回MAC地址，例如：41:BB:00:F8:DB:51

示例

java

String mac= GripDeviceManager.getInstance().getBLEMac();

参数	类型	说明
mode	int	范围：0-1 0：关闭离线模式 1：开启离线模式

返回值

成功: RfidErrorConstants.SUCCESS； (int) 失败：其他(错误码信息详见:附录1：常见错误码)。

示例

java

int ret = GripDeviceManager.getInstance().setOfflineModeOpen(1);

返回值

返回离线模式状态 (int) 0：离线模式处于关闭状态 1：离线模式处于开启状态

示例

java

int value =
GripDeviceManager.getInstance().getOfflineModeOpen();

参数	类型	说明
mode	int	范围：0-1 0：不自动清除 1：自动清除

返回值

成功: RfidErrorConstants.SUCCESS； (int) 失败：其他(错误码信息详见:附录1：常见错误码)。

示例

java

int ret =
GripDeviceManager.getInstance().setOfflineTransferClearData(1);

返回值

返回离线模式下数据清除的状态 (int) 0：离线数据传输后，不自动清除数据 1：离线数据传输后，自动清除数据

示例

java

int value =
GripDeviceManager.getInstance().getOfflineTransferClearData();

参数	类型	说明
delay	int	范围：0-10000ms

返回值

成功: RfidErrorConstants.SUCCESS； (int) 失败：其他(错误码信息详见:附录1：常见错误码)。

示例

java

int ret =
GripDeviceManager.getInstance().setOfflineTransferDelay(0);

返回值

返回集合：int[] numArr (int[]) 如果numArr 长度大于0，则表示获取成功， numArr[0]：缓存的RFID数量 numArr[1]：缓存的扫描条码数量如果numArr 等于空或长度等于0，则获取失败

示例

java

int[] numArr=
GripDeviceManager.getInstance().getOfflineQueryNum();

返回值

返回集合：double[] memArr (int) 如果memArr长度大于0，则表示获取成功， memArr[0]：缓存的RFID 占比 memArr[1]：缓存的扫描条码占比如果memArr等于空或长度等于0，则获取失败

示例

java

double[] memArr=
GripDeviceManager.getInstance().getOfflineQueryMem();

返回值

成功: RfidErrorConstants.SUCCESS； (int) 失败：其他(错误码信息详见:附录1：常见错误码)。

示例

java

int value =
GripDeviceManager.getInstance().offlineManaulClearScanData();

返回值

成功: RfidErrorConstants.SUCCESS； (int) 失败：其他(错误码信息详见:附录1：常见错误码)。

示例

java

int value =
GripDeviceManager.getInstance().offlineManaulClearRFIDData();

返回值

成功: RfidErrorConstants.SUCCESS； (int) 失败：其他(错误码信息详见:附录1：常见错误码)。

示例

java

int ret=
GripDeviceManager.getInstance().offlineStartTransferRFID();

返回值

成功: RfidErrorConstants.SUCCESS； (int) 失败：其他(错误码信息详见:附录1：常见错误码)。

示例

java

int ret=
GripDeviceManager.getInstance().offlineStartTransferScan();

返回值

成功: RfidErrorConstants.SUCCESS； (int) 失败：其他(错误码信息详见:附录1：常见错误码)。

示例

java

int ret= GripDeviceManager.getInstance().modeResetFactory();

启用 Gen2X 功能说明：

Gen2X 是 Impinj 的高性能读取模式，针对 M700、M800 系列标签进行了优化。根据您的需求，可选择两种读取策略：

配置类型 Profile 编号读取范围专用模式 4123、4124、4141、4146、4148、4185 仅读取 M700、M800 系列标签

兼容模式 5123、5124、5141、5146、5148、5185 读取 M700、M800 系列标签 + 普通标签

注意：必须设置了Profile为上面12种的其中一种后，才能开启Gen2X的功能特性

调用路径：RFIDSDKManager.getInstance().getRfidManager()

setExtProfile

设置Gen2X的Profile；也可通过 setProfile(RfidProfile rfidProfile ); 接口设置，效果一样，只是传参类型不一样。注意：Profile需要主动设置才会变化，如果设置过Gen2X的特定Profile，需要使用非Gen2X的功能，请根据自己的业务需求看是否要设置回普通支持的Profile （非Gen2X的Profile）.

public int setExtProfile(int ExtProfile);

参数	类型	说明
ExtProfile	int	范围： 1、3 、5 、7 11 、12 、13 、15 102 、103 、104 、120 、123 、124 125 、126 、141 、146 、147 、148 185 、202 、203 、205 、222 、223 224 、225 、226 、241 、244 、285 302 、323 、324 、325 、326 、342 343 、344 、345 、382 4123、4124、4141、4146、4148、4185 5123、5124、5141、5146、5148、5185 更多Profile详细参数组合见下方。

返回值

成功：0；失败：other； (int)

Gen2X 支持的 Profile 详情

"1: PR_ASK, pie: 2.0, tari_us: 7.5, lf_khz: 640, M: 2",

"3: PR_ASK, pie: 2.0, tari_us: 20.0,lf_khz: 320, M: 2",

"5: PR_ASK, pie: 2.0, tari_us: 20.0,lf_khz: 320, M: 4",

"7: PR_ASK, pie: 2.0, tari_us: 20.0,lf_khz: 250, M: 4",

"11: PR_ASK, pie: 2.0, tari_us: 7.5, lf_khz: 640, M: 1",

"12: PR_ASK, pie: 2.0, tari_us: 15.0,lf_khz: 320, M: 2",

"13: PR_ASK, pie: 2.0, tari_us: 20.0,lf_khz: 160, M: 8",

"15: PR_ASK, pie: 2.0, tari_us: 7.5, lf_khz: 640, M: 4",

"102:PR_ASK, pie: 2.0, tari_us: 7.5, lf_khz: 640, M: 0",

"103:DSB, pie: 1.5, tari_us: 6.25,lf_khz: 640, M: 0",

"104:DSB, pie: 1.5, tari_us: 6.25,lf_khz: 320, M: 1",

"120:DSB, pie: 1.5, tari_us: 6.25,lf_khz: 640, M: 2",

"123:PR_ASK, pie: 2.0, tari_us: 20.0,lf_khz: 320, M: 2",

"124:PR_ASK, pie: 2.0, tari_us: 7.5, lf_khz: 640, M: 2",

"125:PR_ASK, pie: 2.0, tari_us: 15.0,lf_khz: 320, M: 2",

"126:PR_ASK, pie: 1.5, tari_us: 12.5,lf_khz: 320, M: 2",

"141:PR_ASK, pie: 2.0, tari_us: 20.0,lf_khz: 320, M: 4",

"146:PR_ASK, pie: 2.0, tari_us: 20.0,lf_khz: 250, M: 4",

"147:PR_ASK, pie: 2.0, tari_us: 7.5, lf_khz: 640, M: 4",

"148:PR_ASK, pie: 1.5, tari_us: 7.5, lf_khz: 640, M: 4",

"185:PR_ASK, pie: 2.0, tari_us: 20.0,lf_khz: 160, M: 8",

"202:PR_ASK, pie: 2.0, tari_us: 15.0,lf_khz: 426, M: 0",

"203:PR_ASK, pie: 1.5, tari_us: 12.5,lf_khz: 426, M: 0",

"205:PR_ASK, pie: 2.0, tari_us: 20.0,lf_khz: 50, M: 1",

"222:PR_ASK, pie: 2.0, tari_us: 20.0,lf_khz: 320, M: 2",

"223:PR_ASK, pie: 2.0, tari_us: 15.0,lf_khz: 320, M: 2",

"224:PR_ASK, pie: 1.5, tari_us: 12.5,lf_khz: 320, M: 2",

"225:PR_ASK, pie: 2.0, tari_us: 15.0,lf_khz: 426, M: 2",

"226:PR_ASK, pie: 1.5, tari_us: 12.5,lf_khz: 426, M: 2",

"241:PR_ASK, pie: 2.0, tari_us: 20.0,lf_khz: 320, M: 4",

"244:PR_ASK, pie: 2.0, tari_us: 20.0,lf_khz: 250, M: 4",

"285:PR_ASK, pie: 2.0, tari_us: 20.0,lf_khz: 160, M: 8",

"302:PR_ASK, pie: 2.0, tari_us: 7.5, lf_khz: 640, M: 0",

"323:PR_ASK, pie: 2.0, tari_us: 7.5, lf_khz: 640, M: 2",

"324:PR_ASK, pie: 2.0, tari_us: 20.0,lf_khz: 320, M: 2",

"325:PR_ASK, pie: 2.0, tari_us: 15.0,lf_khz: 320, M: 2",

"326:PR_ASK, pie: 1.5, tari_us: 12.5,lf_khz: 320, M: 2",

"342:PR_ASK, pie: 2.0, tari_us: 20.0,lf_khz: 320, M: 4",

"343:PR_ASK, pie: 2.0, tari_us: 20.0,lf_khz: 250, M: 4",

"344:PR_ASK, pie: 2.0, tari_us: 7.5 ,lf_khz: 640, M: 4",

"345:PR_ASK, pie: 1.5, tari_us: 7.5 ,lf_khz: 640, M: 4",

"382:PR_ASK, pie: 2.0, tari_us: 20.0,lf_khz: 160, M: 8",

"4123:PR_ASK,pie: 2.0, tari_us: 20.0,lf_khz: 320, PSK2",

"4124:PR_ASK,pie: 2.0, tari_us: 7.5, lf_khz: 640, BPSK2"

"4141:PR_ASK,pie: 2.0, tari_us: 20.0,lf_khz: 320, BPSK4"

"4146:PR_ASK,pie: 2.0, tari_us: 20.0,lf_khz: 250, BPSK4"

"4148:PR_ASK,pie: 1.5, tari_us: 7.5, lf_khz: 640, BPSK4"

"4185:PR_ASK,pie: 2.0, tari_us: 20.0,lf_khz: 160, BPSK8"

"5123:PR_ASK,pie: 2.0, tari_us: 20.0,lf_khz: 320, M+B2",

"5124:PR_ASK,pie: 2.0, tari_us: 7.5, lf_khz: 640, M+B2",

"5141:PR_ASK,pie: 2.0, tari_us: 20.0,lf_khz: 320, M+B4",

"5146:PR_ASK,pie: 2.0, tari_us: 20.0,lf_khz: 250, M+B4",

"5148:PR_ASK,pie: 1.5, tari_us: 7.5, lf_khz: 640, M+B4",

"5185:PR_ASK,pie: 2.0, tari_us: 20.0,lf_khz: 160, M+B8"

返回值

返回对应的Profile值 (int)

com.ubx.usdk.RfidManager

setImpinjScanParam

该命令用于设置Impinj scan命令参数，仅限Ex10系列。设置后，可调用startRead 方法进行盘点扫描。

public int setImpinjScanParam(int opt,int N,int Code,int CR,int Protection,int ID, int CopyTo)

参数	类型	说明
opt	int	0-掉电保存；1-掉电不保存
N	int	默认0x0F;
Code	int	0-Rfu;1-Antipodal;2-CCOneHalf;3-CCThreeQuarters.
CR	int	0-ID32;1-ID16;2-StoredCRC;3-RN16.
Protection	int	0-NoProtection;1-Parity;2-CRC5;3-CRC5Plus.
ID	int	0-NoAckResponse; 1-TMNPlusTSN; 2-Part EPC;3-Full.
CopyTo	int	0-All tag;1-S=1 tags only.

返回值

0:表示成功。不等于0:表示失败，请查看返回值错误代码表。 (int)

com.ubx.usdk.RfidManager

getImpinjScanParam

该命令用于读取Impinj scan命令参数，仅限Ex10系列。 int[] aar = RFIDSDKManager.getInstance().getRfidManager().getImpinjScanParam();

public int[] getImpinjScanParam()

参数	类型	说明
N --> aar[0]	int	默认0x0F;
Code--> aar[1]	int	0-Rfu;1-Antipodal;2-CCOneHalf;3-CCThreeQuarters.
CR--> aar[2]	int	0-ID32;1-ID16;2-StoredCRC;3-RN16.
Protection--> aar[3]	int	0-NoProtection;1-Parity;2-CRC5;3-CRC5Plus.
ID--> aar[4]	int	0-NoAckResponse; 1-TMNPlusTSN; 2-Part EPC;3-Full.
CopyTo--> aar[5]	int	0-All tag;1-S=1 tags only.

返回值

0:表示成功。不等于0:表示失败，请查看返回值错误代码表。 (int) 如果返回0 ，则通过读取传入的参数，来获取对应的参数值。

参数	类型	说明
MatchType	int	0-匹配；1-不匹配
matchDataList	List<MatchData>	掩码列表，最多5组，当为空时，表示清空掩码列表; class MatchData { int memBank = 0;//内存区域 int maskStart = 0;//其实位置长度（bits） int maskLen = 0;//长度（bits） String maskData = "";//掩码内容 }

返回值

0:表示成功。不等于0:表示失败，请查看返回值错误代码表。 (int)

com.ubx.usdk.RfidManager

protectedMode

设置隐私模式，设置隐私模式前，一定要修改访问密码，并且修改后的访问密码，在设置隐私模式的时候，要一致。

public int protectedMode(String EPCStr, int enable, String Password);

参数	类型	说明
EPCStr	String	选中的EPC号
enable	int	0：禁用隐私模式 1：启用隐私模式
Password	String	设置隐私模式下的访问密码，该密码要与修改后的访问密码一致

返回值

成功：0； (int) 失败：其他。

参数	类型	说明
Opt	int	0-掉电保存；1-掉电不保存
enableFlag	int	0-关闭；1-打开
strPassword	String	4字节，读写器隐私模式内部使用的访问密码

返回值

0:表示成功。不等于0:表示失败，请查看返回值错误代码表。 (int)

返回值

获取成功:返回集合 String[] aar; (int) String enable = aar[0];//0-关闭；1-打开 String password= aar[1];//4字节，读写器隐私模式内部使用的访问密码获取成功:返回null对象

参数	类型	说明
epcNum	int	标签的EPC号字长度，当Enum=255时，使用掩码方式。
strEPC	String	ENum个字，标签的EPC号。
strPassword	String	4个字节，标签的访问密码。
MaskMemInt	int	掩码区。 1 -- EPC存储区； 2 -- TID存储区； 3 --用户存储区。
btWordAdd	int	掩码的起始位地址。范围0~16383。比如EPC为：E28011113333 中的 1111 ，该起始位置为 12 （因为EPC的E280前面还有2个字长的数据）
MaskLength	int	掩码的位长度，比如数据是"1111"则这里的长度用 4 表示。
strMaskData	String	掩码数据。字符长度为为偶数
srBit	int	Short-range模式存储的位置， Impinj700/800标签SRBit=4； Impinj MR6-X标签SRBit=1；
srValue	int	0-关闭Short-range模式； 1-打开Short-range模式。

返回值

0:表示成功。不等于0:表示失败，请查看返回值错误代码表。 (void)

参数	类型	说明
epcNum	int	标签的EPC号字长度，当Enum=255时，使用掩码方式。
strEPC	String	ENum个字，标签的EPC号。
strPassword	String	4个字节，标签的访问密码。
MaskMemInt	int	掩码区。 1 -- EPC存储区； 2 -- TID存储区； 3 --用户存储区。
btWordAdd	int	掩码的起始位地址。范围0~16383。比如EPC为：E28011113333 中的 1111 ，该起始位置为 12 （因为EPC的E280前面还有2个字长的数据）
MaskLength	int	掩码的位长度，比如数据是"1111"则这里的长度用 4 表示。
strMaskData	String	掩码数据。字符长度为为偶数
srBit	int	Short-range模式存储的bit位置， Impinj700/800标签SRBit=4； Impinj MR6-X标签SRBit=1；

返回值

0-关闭Short-range模式； (void) 1-打开Short-range模式。其他:表示失败，请查看返回值错误代码表。

以下接口仅适用于固定式读写器 FR1000，手持 PDA 无此功能。

调用路径：GpioController.getInstance()

GPO 输出口：int out — 0 输出低电平，1 输出高电平。

GPI 输入口示例：

java

GpioController.getInstance().setGpioInputListener(new GpioController.GpioInputListener() {
    @Override public void onInput1Changed(int state) { /* GPI1: 0=low 1=high */ }
    @Override public void onInput2Changed(int state) { }
    @Override public void onInput3Changed(int state) { }
    @Override public void onInput4Changed(int state) { }
});
GpioController.getInstance().startMonitoring();

RfidErrorConstants

通过 RfidErrorConstants.getDescription(errorCode) 获取描述。

错误代码	描述
(RfidErrorConstants)
SUCCESS(0)	执行成功。
TAG_NOT_FOUND(1)	未询查到电子标签。
INSUFFICIENT_POWER(2)	电源不足，标签电源不足，无法执行存储写入操作。
MEMORY_ERROR(3)	存储器超限或不被支持的PC值，规定存储位置不存在或标签不支持PC值。
MEMORY_LOCKED(4)	存储器锁定，存储位置锁定永久锁定，且不可写入。
ACCESS_PWD_ERROR(5)	访问密码错误。
KILL_PWD_ERROR(9)	销毁密码错误。
INVALID_KILL_PWD(10)	销毁密码不能为全0。
UNSUPPORTED_CMD(11)	电子标签不支持该命令。
INVALID_ACCESS_PWD(12)	对该命令，访问密码不能为0。
READ_PROTECTED(13)	电子标签已经被设置了读保护，不能再次设置。
NOT_READ_PROTECTED(14)	电子标签没有被设置读保护，不需要解锁。
GENERIC_ERROR(15)	非特定错误，标签不支持特定错误代码。
WRITE_FAILED(16)	有字节空间被锁定，写入失败。
LOCK_FAILED(17)	不能锁定。
ALREADY_LOCKED(18)	已经锁定，不能再次锁定。
PARAM_SAVE_FAILED(19)	参数保存失败,但设置的值在读写模块断电前有效。
ADJUST_FAILED(20)	无法调整。
FIRMWARE_PACKAGE_NOT_MATCH(247)	固件包不匹配
ANTENNA_ERROR(248)	天线检测错误
CMD_EXEC_FAILED(249)	命令执行出错。
COMMUNICATION_FAILURE(250)	有电子标签，但通信不畅，无法操作。
NO_TAG(251)	无电子标签可操作。
TAG_ERROR(252)	电子标签返回错误代码。
INVALID_CMD_LENGTH(253)	命令长度错误。
ILLEGAL_CMD(254)	不合法的命令。
PARAM_ERROR(255)	参数错误。
INVALID_INVENTORY_MODE(260)	盘点模式(InventorySceneMode)非自定义模式，不允许设置。
UNSUPPORTED_FEATURE(261)	固件不支持该功能。
COMMUNICATION_ERROR(48)	通讯错误。
COMMUNICATION_BUSY	通讯繁忙
(50)
SDK_UNINITIALIZED(-1)	SDK未初始化
DEVICE_DISCONNECTED(-101)	RFID设备未连接(外接设备或蓝牙设备)
SEND_CMD_FAILED(-102)	发送指令数据失败(外接设备或蓝牙设备)

ReadTag

属性	类型	说明
epcId	String	EPC（不含 CRC/PC）
memId	String	TID/USER（混合查询模式）
rssidBm	int	dBm 信号强度
rssi	int	0–100 信号值
phase	int	相位
FreqKhz	int	频点 KHz

DataCallback

java

void onInventoryTag(ReadTag readTag);
void onInventoryTagEnd();

QueryMemBank

QueryMemBank 枚举，供 setQueryMemoryBank() / getQueryMemoryBank() 使用。

QueryMemBank	读取的 Bank
EPC	EPC 查询
	参数：startAddress = 0，readLen = 0
	行为：读取默认长度 EPC（不含 CRC 与 PC 头）
EPC_TID	EPC + TID 混合查询
	参数：startAddress = TID 起始字地址（0–5），readLen = TID 读取长度（1–6 字）
	回调：EPC → `ReadTag.epcId`；TID → `ReadTag.memId`
EPC_USE	EPC + USER 混合查询
	参数：startAddress = USER 起始字地址（≥ 0），readLen = USER 读取长度（1–32 字）
	回调：EPC → `ReadTag.epcId`；USER → `ReadTag.memId`
EPC_RESERVED	EPC + RESERVED（Password）混合查询
	参数：startAddress = RESERVED 起始地址（0–3），readLen = 密码读取长度（1–4 字）
	回调：EPC → `ReadTag.epcId`；RESERVED → `ReadTag.memId`
FASTTID	Impinj FastTID 快速模式
	参数：startAddress = 0，readLen = 0（固定）
	自动读取完整 96 位 TID（字地址 0–5）写入 `ReadTag.memId`
	兼容性：仅支持 Impinj Monza® 系列标签
EPC_EPC	EPC + EPC 双区查询
	参数：startAddress = 第二 EPC 起始地址，readLen = 第二 EPC 读取长度
	第一 EPC（默认长度）→ `ReadTag.epcId`；第二 EPC 段 → `ReadTag.memId`
	典型应用：读取 PC 位或部分 EPC 校验
BID	BID 查询（需特殊标签支持）
	参数：startAddress = 0，readLen = 0（固定）

InventorySceneMode

InventorySceneMode 枚举，供 setInventorySceneMode() / getInventorySceneMode() 使用。

盘点场景模式	适用场景
(InventorySceneMode)
BATTERY_LIFE	低功耗场景延长设备续航时间
FULL_INVENTORY	盘点读取全标签以尽快识别全部标签为目的
REPEAT_READ	快速累加模式频繁（重复）读取并累计标签数量
	注意：此模式仅盘点 EPC。
	掩码过滤不能使用 `addMaskBits()`，请改用 `setInventoryMatchData()`。
BALANCED_PERFORMANCE	均衡模式平衡性能与续航
CYCLE_COUNT	去重盘点模式盘点未被重复计数的标签；适用于高干扰环境，但后续读取较慢
MAX_RANGE	最远读距模式适用于单标签远距测试
CUSTOM_MODE	自定义参数可自行配置 Session、Q 值、Target、Profile

ReaderDeviceType

Value	Constant	说明
-1	UNKNOWN	未知
0	INTEGRATED	一体机
1	PERIPHERAL_UART	串口外设
2	BLE_DEVICE	蓝牙设备

ModuleType

常量	说明
MODULE_U1 ~ MODULE_U5	各代 UHF 模块
MODULE_OTHER	其他

GpioInputListener

GPI 状态变化回调，包含 onInput1Changed ~ onInput4Changed；state：0 低电平，1 高电平。

示例

按键触发盘点

Bind the RFG91 scan key to start/stop inventory (see Grip and peripheral → setKeyEventListener):

java

GripDeviceManager.getInstance().setKeyEventListener((keyCode, isDown) -> {
    if (keyCode == BTKeyEvent.BT_SCAN) {
        RfidManager rfid = RFIDSDKManager.getInstance().getRfidManager();
        if (isDown) rfid.startInventory();
        else rfid.stopInventory();
    }
});

EPC+TID 混合查询

Read EPC plus the first 6 words of TID during inventory:

java

RfidManager rfid = RFIDSDKManager.getInstance().getRfidManager();
rfid.setQueryMemoryBank(QueryMemBank.EPC_TID, 0, 6);
rfid.startInventoryWithTimeout(60);

固件升级

Check a firmware package bundled in assets, then call startUpgrade() if an update is required:

java

RFUpgradeManager.getInstance().checkUpgrade(context,
    RFUpgradeManager.UpgradeSource.fromAssets("bin/fw.zip"),
    callback);

注意事项与 FAQ

线程与生命周期

init() / release() 成对调用
盘点完成后及时 stopInventory()

日志

UlogManager.enableLog(true)，日志目录 /sdcard/Download/rfidLog

频段说明

欧标频段（865~868MHz）

频率区域	频段名称	频点个数	频道间隔
			kHz
FrequencyRegion.UKRAINE	乌克兰频段	7	100
FrequencyRegion.CHINESE1	中国标准1区	20	250
FrequencyRegion.EU(RF1)	欧洲频段	4	600
FrequencyRegion.INDIA	印度频段	4	600
FrequencyRegion.URUGUAY	乌拉圭	23	500

美标频段（902~928MHz）

频率区域	频段名称	频点个数	频道间隔
			kHz
FrequencyRegion.CHINESE2	中国标准2区	20	250
FrequencyRegion.US	美国频段	50	500
FrequencyRegion.KOREAN	韩国频段	6	600
FrequencyRegion.PERU	秘鲁	23	500
FrequencyRegion.US3	美国工业/科学频段扩展	53	500
FrequencyRegion.Taiwan	中国台湾	14	500
FrequencyRegion.EU2(RF2)	俄罗斯	4	1200
FrequencyRegion.Japan	日本	4	1200
FrequencyRegion.Taiwan	中国台湾	14	500
FrequencyRegion.MALAYSIA	马来西亚	8	500
FrequencyRegion.BRAZIL	巴西	35	500
FrequencyRegion.THAILAND	泰国	10	500
FrequencyRegion.SINGAPORE	新加坡	10	500
FrequencyRegion.AUSTRALIA	澳大利亚	10	500
FrequencyRegion.VIETNAM	越南	8	500
FrequencyRegion.ISRAEL	以色列	1	500
FrequencyRegion.INDONESIA	印度尼西亚	4	500
FrequencyRegion.NEW_ZEALAND	新西兰岛	10	500
FrequencyRegion.SOUTH_AFRICA	南非	17	200
FrequencyRegion.PHILIPPINES	菲律宾	4	500
FrequencyRegion.ETSI_UPPER	ETSI UPPER	3	1200
FrequencyRegion.HK	中国香港	10	500
FrequencyRegion.JAPANLBT1	日本LBT1（小功率）	3+16	200,1200
	需要RFID固件版本是3.0以上，getFirmwareVersion()
FrequencyRegion.JAPANLBT2	日本LBT2（大功率）	4+2	1200,200
	需要RFID固件版本是3.0以上，getFirmwareVersion()

设置这些特定区域频段的示例:

如欧洲频段FrequencyRegion.EU：（从上到下依次对应参数0-3）

865.7 0

866.3 1

866.9 2

867.5 3

如果需要设置欧洲频段 866.3-mRfidManager.setFrequencyRegion(FrequencyRegion.EU, 1, 2);

如果需要设置欧洲频段 865.7-mRfidManager.setFrequencyRegion(FrequencyRegion.EU, 0, 3);

RSSI 对照

RSSI参数	信号强度	RSSI参数	信号强度
110(0x6E)	-19dBm	70(0x46)	-60dBm
109(0x6D)	-20dBm	69(0x45)	-61dBm
108(0x6C)	-21dBm	68(0x44)	-62dBm
107(0x6B)	-22dBm	67(0x43)	-63dBm
106(0x6A)	-23dBm	66(0x42)	-64dBm
105(0x69)	-24dBm	65(0x41)	-65dBm
104(0x68)	-25dBm	64(0x40)	-66dBm
103(0x67)	-26dBm	63(0x3F)	-67dBm
102(0x66)	-27dBm	62(0x3E)	-68dBm
101(0x65)	-28dBm	61(0x3D)	-69dBm
100(0x64)	-29dBm	60(0x3C)	-70dBm
99(0x63)	-30dBm	59(0x3B)	-71dBm
98(0x62)	-31dBm	58(0x3A)	-72dBm
97(0x61)	-32dBm	57(0x39)	-73dBm
96(0x60)	-33dBm	56(0x38)	-74dBm
95(0x5F)	-34dBm	55(0x37)	-75dBm
94(0x5E)	-35dBm	54(0x36)	-76dBm
93(0x5D)	-36dBm	53(0x35)	-77dBm
92(0x5C)	-37dBm	52(0x34)	-78dBm
91(0x5B)	-38dBm	51(0x33)	-79dBm
90(0x5A)	-39dBm	50(0x32)	-80dBm
89(0x59)	-41dBm	49(0x31)	-81dBm
88(0x58)	-42dBm	48(0x30)	-82dBm
87(0x57)	-43dBm	47(0x2F)	-83dBm
86(0x56)	-44dBm	46(0x2E)	-84dBm
85(0x55)	-45dBm	45(0x2D)	-85dBm
84(0x54)	-46dBm	44(0x2C)	-86dBm
83(0x53)	-47dBm	43(0x2B)	-87dBm
82(0x52)	-48dBm	42(0x2A)	-88dBm
81(0x51)	-49dBm	41(0x29)	-89dBm
80(0x50)	-50dBm	40(0x28)	-90dBm
79(0x4F)	-51dBm	39(0x27)	-91dBm
78(0x4E)	-52dBm	38(0x26)	-92dBm
77(0x4D)	-53dBm	37(0x25)	-93dBm
76(0x4C)	-54dBm	36(0x24)	-94dBm
75(0x4B)	-55dBm	35(0x23)	-95dBm
74(0x4A)	-56dBm	34(0x22)	-96dBm
73(0x49)	-57dBm	33(0x21)	-97dBm
72(0x48)	-58dBm	32(0x20)	-98dBm
71(0x47)	-59dBm	31(0x1F)	-99dBm

可以使用工具类转换成dBm值：

int dBm = RssiToDBmUtils.dBmConver(int RSSI);

或通过方法 setRssiInDbm(boolean isDbm)设置默认输出格式。

区域对照

参数 (CountryCode)	地区
`CountryCode.ALB`	Albania
`CountryCode.ARG`	Argentina
`CountryCode.ARM`	Armenia
`CountryCode.AUT`	Austria
`CountryCode.AZE`	Azerbaijan
`CountryCode.BLR`	Belarus
`CountryCode.BEL`	Belgium
`CountryCode.BIH`	Bosnia and Herzegovina
`CountryCode.BRA`	Brazil
`CountryCode.BUL`	Bulgaria
`CountryCode.CAN`	Canada
`CountryCode.CHI`	Chile
`CountryCode.CHN`	China
`CountryCode.COL`	Colombia
`CountryCode.CRC`	Costa Rica
`CountryCode.CRO`	Croatia
`CountryCode.CYP`	Cyprus
`CountryCode.CZE`	Czech Republic
`CountryCode.DEN`	Denmark
`CountryCode.DOM`	Dominican Republic
`CountryCode.EST`	Estonia
`CountryCode.FIN`	Finland
`CountryCode.FRA`	France
`CountryCode.GER`	Germany
`CountryCode.GRE`	Greece
`CountryCode.HUN`	Hungary
`CountryCode.ISL`	Iceland
`CountryCode.IRI`	Iran, Islamic Rep.
`CountryCode.ITA`	Italy
`CountryCode.KOR`	Korea, Rep.
`CountryCode.LIE`	Liechtenstein
`CountryCode.LTU`	Lithuania
`CountryCode.LUX`	Luxembourg
`CountryCode.MKD`	Macedonia, FYR
`CountryCode.MLT`	Malta
`CountryCode.MEX`	Mexico
`CountryCode.MDA`	Moldova
`CountryCode.NED`	Netherlands
`CountryCode.NZL`	New Zealand
`CountryCode.NGR`	Nigeria
`CountryCode.NOR`	Norway
`CountryCode.PAN`	Panama
`CountryCode.PER`	Peru
`CountryCode.POL`	Poland
`CountryCode.POR`	Portugal
`CountryCode.ROM`	Romania
`CountryCode.RUS`	Russian Federation
`CountryCode.KSA`	Saudi Arabia
`CountryCode.SVK`	Slovak Republic
`CountryCode.SLO`	Slovenia
`CountryCode.RSA`	South Africa
`CountryCode.ESP`	Spain
`CountryCode.SWE`	Sweden
`CountryCode.SUI`	Switzerland
`CountryCode.HKG`	Hong Kong
`CountryCode.THA`	Thailand
`CountryCode.TUN`	Tunisia
`CountryCode.TUR`	Turkey
`CountryCode.UAE`	United Arab Emirates
`CountryCode.GBR`	United Kingdom
`CountryCode.USA`	United States
`CountryCode.URU`	Uruguay
`CountryCode.VEN`	Venezuela, RB
`CountryCode.UKR`	Ukraine
`CountryCode.MAS`	Malaysia
`CountryCode.SIN`	Singapore
`CountryCode.AUS`	Australia
`CountryCode.IND`	India
`CountryCode.VIE`	Vietnam
`CountryCode.ISR`	Israel
`CountryCode.INA`	Indonesia
`CountryCode.JPN`	Japan
`CountryCode.PHI`	Philippines

补充说明

1. 长距（带手柄）设备控制扫描头出光(针对非蓝牙设备)

RFIDSDKManager.getInstance().enableScanHead(boolean isOpen);

说明：此方法是针对长距带手柄RFID设备，控制手柄上的按键，是否触发扫码头扫码

参数类型说明 isOpen boolean true,手柄按键触发扫码；false，手柄按键不触发扫码

2. 蓝牙设备，使用NFC连接方式时，读到的信息解析MAC地址

String mac = NFCUtils.getBleMac(NdefMessage ndefMessage);

说明：传入NFC拿到的NdefMessage 对象，方法返回的是蓝牙设备的MAC地址，拿到地址后，可以传入 initBTToMac(Context context, String mac, InitListener listener);方法中的 mac 传参。

参数类型说明 ndefMessage NdefMessage NFC拿到的NdefMessage 对象

建议

init()方法和release()方法成对出现，退出应用时调用release()断开RFID连接。

根据错误码对照表进行故障处理。

关于开启SDK日志: 建议使用UlogManager.enableLog(true); true:开启日志 false:关闭日志；用此方法在调用本SDK前先设置一次，日志文件会保存在 /sdcard/Download/rfidLog ，记录文件需要存储权限。

联系与支持

有关最新的更新、示例代码和技术支持，请联系我们的支持团队。

文档结束。

Q: NFC 获取蓝牙 MAC？

A: NFCUtils.getBleMac(ndefMessage) → initBTtoMac

Q: release 调用哪个类？

A: RFIDSDKManager.getInstance().release()

Q: 非 CUSTOM_MODE 能否改 Session？

A: 需先 setInventorySceneMode(CUSTOM_MODE)

Q: 固件升级电量？

A: Android >20%，手柄 >10%

1、Overview

1.1、Introduction

1.2、Version history

2025-12-30 （URFIDLibrary-v2.5.1230.aar）

1. setInventorySceneMode - New Inventory Scene Modes

2. Data Callback Parameter Type Change

3. RfidProfile Enumeration - Miller Configuration Return Type Change

4. New Method: getSupportProfileList()

5. New Method: getSupportFrequencyBandList()

6. New Method: getSupportWorkRegionList()

7. Enhanced Module Type Identification: getModuleType()

8. New Method: getReaderDeviceType()

9. New Method: setInventoryPhaseFlag(boolean flag)

10. Callback Registration Method Update

11. Release Method Deprecation

12.Code optimization

2026-04-08 （URFIDLibrary-v2.6.0408.aar）

1. The SO library is 16KB aligned.

2. The method setRssiInDbm has been removed.

3. The method for switching the signal value return range has been modified:

2026-06-09 （URFIDLibrary-v2.6.0609.aar）

1. Added RFID firmware update interface.

2. Optimized and fixed the issue of inconsistent 16KB alignment display results on different Android Studio versions.

1.3、Core capabilities

1.4、Use cases

1.5、Requirements

2、Integration

2.1、Obtain the SDK

2.2、Project setup

Permissions

BLE firmware upgrade deps

ProGuard

2.3、Initialization

2.4、Authentication

3、Quick Start

API Reference

Returns

Example

Returns

Example

Returns

Example

Returns

Returns

Returns

Example

Returns

Example

Returns

Example

Returns

Example

Returns

Returns

Example

Example

Example

Returns

Example

Returns

Returns

Returns

Returns

Example

Returns

Returns

Returns

Returns

Returns

Example

Returns

Returns

Returns

Returns

Returns

Returns

Returns

Returns

Returns

Returns

Overview

Introduction

Version history

Core capabilities

Use cases

Requirements

Integration

Obtain the SDK

Project setup

Initialization

Authentication

Quick Start