3. Callback List¶
In this plugin, results of scan processes and various operations are generally notified via callback functions.
For example, resluts of operations such as RFID tag scan and setting changes are returned via callbacks, so the app side should receive these results and process them as necessary.
3.1. ON_CONNECT¶
Notifies whether the AsReader is physically connected to the device. The connection status is acquired when the AsReader is inserted or removed.
Parameters¶
Argument Name |
Type |
Description |
result |
bool |
AsReader connection status
|
Sample Code¶
if (_a3xdPlugin.ON_CONNECT == methodCall.method) {
bool isConnected = methodCall.arguments['result'];
}
3.2. ON_COMPLETED_PREPARATION¶
Receives the AsReader’s power and setting item configurations. When the setPowerWithOption method is called, this callback method receives the power and setting item configuration results.
Parameters¶
Argument Name |
Type |
Description |
result |
bool |
AsReader connection status
|
Sample Code¶
if (_a3xdPlugin.ON_COMPLETED_PREPARATION == methodCall.method) {
bool isPower = methodCall.arguments['result'];
}
3.3. ON_BATTERY_STATE_RECEIVED¶
Reports the AsReader’s remaining battery level. When getBattery is called, the AsReader’s battery level is returned.
Parameters¶
Argument Name |
Type |
Description |
dest |
int |
AsReader’s battery level |
charging |
int |
0x00: Discharged, 0x01: Charging, 0xFF: Fully charged, 0x10: Not supported |
Sample Code¶
if (_a3xdPlugin.BATTERY_RECEIVED == methodCall.method) {
int battery = methodCall.arguments['dest'];
int charging = methodCall.arguments['charging'];
}
3.4. ON_READER_INFO_RECEIVED¶
Receives the configured parameter information. When the getReaderInfo method is called, this callback method receives the configured parameter information.
Parameters¶
Argument Name |
Type |
Description |
onTime |
int |
Inventory time |
offTime |
int |
Idle time |
senseTime |
int |
Carrier sense time |
lbtLevel |
int |
Target frequency level |
fhEnable |
int |
On (0x01 or higher) / Off (0x00) |
lbtEnable |
int |
On (0x01 or higher) / Off (0x00) |
cwEnable |
int |
On (0x01) / Off (0x00) |
power |
int |
Current power |
minPower |
int |
Minimum power |
maxPower |
int |
Maximum power |
Sample Code¶
if (_a3xdPlugin.ON_READER_INFO_RECEIVED == methodCall.method) {
int onTime = methodCall.arguments['onTime'];
int offTime = methodCall.arguments['offTime'];
int senseTime = methodCall.arguments['senseTime'];
int lbtLevel = methodCall.arguments['lbtLevel'];
int fhEnable = methodCall.arguments['fhEnable'];
int lbtEnable = methodCall.arguments['lbtEnable'];
int cwEnable = methodCall.arguments['cwEnable'];
int power = methodCall.arguments['power'];
int minPower = methodCall.arguments['minPower'];
int maxPower = methodCall.arguments['maxPower'];
}
3.5. ON_READER_ABOUT_INFO¶
Receives the configured parameter information. When the getReaderInfo method is called, this callback method receives the configured parameter information.
Parameters¶
Argument Name |
Type |
Description |
model |
String |
AsReader model number |
hwVersion |
String |
Hardware version |
fwVersion |
String |
Firmware version |
region |
int |
Region
|
Sample Code¶
if (_a3xdPlugin.ON_READER_ABOUT_INFO == methodCall.method) {
String model = methodCall.arguments['model'];
String hwVersion = methodCall.arguments['hwVersion'];
String fwVersion = methodCall.arguments['fwVersion'];
int region = methodCall.arguments['region'];
}
3.6. ON_RECEIVED_RFID_MODULE_VERSION¶
Receives the RF module version. When the getReaderInfo method is called, this callback method receives the RF module version.
Parameters¶
Argument Name |
Type |
Description |
result |
String |
RF module version |
Sample Code¶
if (_a3xdPlugin.ON_RECEIVED_RFID_MODULE_VERSION == methodCall.method) {
String version = methodCall.arguments['result'];
}
3.7. ON_SET_READER_SETTING_SUCCESS¶
Receives the AsReader’s setting item configuration result. When the setReaderSettings method is called, this callback method receives the setting item configuration result.
Sample Code¶
if (_a3xdPlugin.ON_SET_READER_SETTING_SUCCESS == methodCall.method) {
}
3.8. ON_DEVICE_MANAGER_ERROR¶
Callbacks when a setting error occurs on the AsReader.
Parameters¶
Argument Name |
Type |
Description |
result |
String |
Error message |
Sample Code¶
if (_a3xdPlugin.ON_DEVICE_MANAGER_ERROR == methodCall.method) {
String message = methodCall.arguments['result'];
}
3.9. DID_UPDATE_REGISTRY¶
Receives the registry update function setting result. When the updateRegistry method is called, this callback method receives the registry update function setting result.
Parameters¶
Argument Name |
Type |
Description |
result |
int |
0: Data saved to registry successfully
|
Sample Code¶
if (_a3xdPlugin.DID_UPDATE_REGISTRY == methodCall.method) {
int state = methodCall.arguments['result'];
}
3.10. ON_MODULATION_RECEIVED¶
Receives the debug mode. When the getModulation method is called, this callback method receives the debug mode.
Parameters¶
Argument Name |
Type |
Description |
result |
String |
Debug mode |
Sample Code¶
if (_a3xdPlugin.ON_MODULATION_RECEIVED == methodCall.method) {
String state = methodCall.arguments['result'];
}
3.11. DID_SET_MODULATION¶
Receives the debug mode setting result. When the setModulation method is called, this callback method receives the debug mode setting result.
Parameters¶
Argument Name |
Type |
Description |
result |
int |
0: Success
|
Sample Code¶
if (_a3xdPlugin.DID_SET_MODULATION == methodCall.method) {
int state = methodCall.arguments['result'];
}
3.12. ON_TX_POWER_LEVEL_RECEIVED¶
Receives the power level and the configurable maximum and minimum power levels. When the getOutputPowerLevel method is called, this callback method receives the power level and the configurable maximum and minimum power levels.
Parameters¶
Argument Name |
Type |
Description |
power |
int |
Current power level |
minPower |
int |
Minimum power level |
maxPower |
int |
Maximum power level |
Sample Code¶
if (_a3xdPlugin.ON_TX_POWER_LEVEL_RECEIVED == methodCall.method) {
int power = methodCall.arguments['power'];
int minPower = methodCall.arguments['minPower'];
int maxPower = methodCall.arguments['maxPower'];
}
3.13. ON_FH_LBT_RECEIVED¶
Receives FH and LBT parameters. When the getFhLbtParam method is called, this callback method receives the FH and LBT parameters.
Parameters¶
Argument Name |
Type |
Description |
onTime |
int |
Read time |
offTime |
int |
Idle time |
senseTime |
int |
Carrier sense time |
lbtLevel |
int |
Target frequency level |
fhEnable |
int |
On (0x01 or higher) / Off (0x00) |
lbtEnable |
int |
On (0x01 or higher) / Off (0x00) |
cwEnable |
int |
On (0x01) / Off (0x00) |
Sample Code¶
if (_a3xdPlugin.ON_FH_LBT_RECEIVED == methodCall.method) {
int onTime = methodCall.arguments['onTime'];
int offTime = methodCall.arguments['offTime'];
int senseTime = methodCall.arguments['senseTime'];
int lbtLevel = methodCall.arguments['lbtLevel'];
int fhEnable = methodCall.arguments['fhEnable'];
int lbtEnable = methodCall.arguments['lbtEnable'];
int cwEnable = methodCall.arguments['cwEnable'];
}
3.14. ON_RECEIVED_ANTIMODE¶
Receives the anti-collision algorithm. When the getAntiCollisionMode method is called, this callback method receives the anti-collision algorithm.
Parameters¶
Argument Name |
Type |
Description |
mode |
int |
Anti-collision: Fixed Q (0x00), Dynamic Q (0x01) |
qStart |
int |
Q start position |
qMax |
int |
Q maximum value |
qMin |
int |
Q minimum value |
counter |
int |
Counter |
Sample Code¶
if (_a3xdPlugin.ON_RECEIVED_ANTIMODE == methodCall.method) {
int mode = methodCall.arguments['mode'];
int qStart = methodCall.arguments['qStart'];
int qMax = methodCall.arguments['qMax'];
int qMin = methodCall.arguments['qMin'];
int counter = methodCall.arguments['counter'];
}
3.15. ON_SESSION_RECEIVED¶
Receives the Session. When the getSession method is called, this callback method receives the Session.
Parameters¶
Argument Name |
Type |
Description |
result |
int |
S0:0, S1:1, S2:2, S3:3 |
Sample Code¶
if (_a3xdPlugin.ON_SESSION_RECEIVED == methodCall.method) {
int session = methodCall.arguments['result'];
}
3.16. ON_REGION_RECEIVED¶
Receives the AsReader’s region. When the getRegion method is called, this callback method receives the AsReader’s region.
Parameters¶
Argument Name |
Type |
Description |
result |
int |
AsReader’s region |
Sample Code¶
if (_a3xdPlugin.ON_REGION_RECEIVED == methodCall.method) {
int region = methodCall.arguments['result'];
}
3.17. DID_RECEIVE_REGION¶
Receives the AsReader’s region setting result. When the setRegion method is called, this callback receives the AsReader’s region setting result.
Parameters¶
Argument Name |
Type |
Description |
result |
int |
0: Success
|
Sample Code¶
if (_a3xdPlugin.DID_RECEIVE_REGION == methodCall.method) {
int state = methodCall.arguments['result'];
}
3.18. ON_CHANNEL_RECEIVED¶
Receives the channel. When the getChannel method is called, this callback method receives the channel.
Parameters¶
Argument Name |
Type |
Description |
channel |
int |
Channel number |
channelOffset |
int |
Channel offset |
Sample Code¶
if (_a3xdPlugin.ON_CHANNEL_RECEIVED == methodCall.method) {
int channel = methodCall.arguments['channel'];
int channelOffset = methodCall.arguments['channelOffset'];
}
3.19. ON_RECEIVE_SMART_MODE¶
Receives the hopping mode. When the getFrequencyHoppingMode method is called, this callback receives the hopping mode.
Parameters¶
Argument Name |
Type |
Description |
result |
int |
0x00: Normal mode
|
Sample Code¶
if (_a3xdPlugin.ON_RECEIVE_SMART_MODE == methodCall.method) {
int state = methodCall.arguments['result'];
}
3.20. DID_SET_SMART_MODE¶
Receives the hopping mode setting result. When the setSmartHopping method is called, this callback receives the hopping mode setting result.
Parameters¶
Argument Name |
Type |
Description |
result |
int |
0: Success
|
Sample Code¶
if (_a3xdPlugin.DID_SET_SMART_MODE == methodCall.method) {
int state = methodCall.arguments['result'];
}
3.21. DID_SET_OPTI_FREQ_HP_TABLE¶
Receives the hopping table setting result. When the setOptimumFrequencyHoppingTable method is called, this callback receives the hopping table setting result.
Parameters¶
Argument Name |
Type |
Description |
result |
int |
0: Success
|
Sample Code¶
if (_a3xdPlugin.DID_SET_OPTI_FREQ_HP_TABLE == methodCall.method) {
int state = methodCall.arguments['result'];
}
3.22. ON_TAG_RECEIVED¶
Receives the inventoried data. When the startInventory method is called, this callback receives the inventoried data.
Parameters¶
Argument Name |
Type |
Description |
result |
List<int> |
PC+EPC data |
Sample Code¶
if (_a3xdPlugin.ON_TAG_RECEIVED == methodCall.method) {
List<int> intList = methodCall.arguments['result'].whereType<int>().toList();
}
3.23. ON_TAG_WITH_TID_RECEIVED¶
Receives the inventoried data including TID information. When the startInventoryTagID method is called, this callback receives the inventoried data.
Parameters¶
Argument Name |
Type |
Description |
pcEpc |
List<int> |
PC+EPC data |
tid |
List<int> |
TID data |
Sample Code¶
if (_a3xdPlugin.ON_TAG_WITH_TID_RECEIVED == methodCall.method) {
List<int> pcEpcList = methodCall.arguments['pcEpc'].whereType<int>().toList();
List<int> tidList = methodCall.arguments['tid'].whereType<int>().toList();
}
3.24. ON_TAG_WITH_RSSI_RECEIVED¶
Receives the inventoried data including RSSI information. When the startInventoryRSSI method is called, this callback receives the inventoried data.
Parameters¶
Argument Name |
Type |
Description |
pcEpc |
List<int> |
PC+EPC data |
rssi |
int |
RSSI status |
Sample Code¶
if (_a3xdPlugin.ON_TAG_WITH_RSSI_RECEIVED == methodCall.method) {
List<int> pcEpcList = methodCall.arguments['pcEpc'].whereType<int>().toList();
int rssi = methodCall.arguments['rssi'];
}
3.25. ON_TAG_MEMORY_RECEIVED¶
Receives the read tag data. When the readTagMemory, readTagMemoryWithTimeout, or readTagMemoryWithData methods are called, this callback method receives the read tag data.
Parameters¶
Argument Name |
Type |
Description |
result |
List<int> |
Tag data |
Sample Code¶
if (_a3xdPlugin.ON_TAG_MEMORY_RECEIVED == methodCall.method) {
List<int> dataList = methodCall.arguments['result'].whereType<int>().toList();
}
3.26. ON_TAG_MEMORY_LONG_RECEIVED¶
Receives the read tag data. When the readTagMemory, readTagMemoryWithTimeout, or readTagMemoryWithData methods are called, this callback method receives the read tag data.
Parameters¶
Argument Name |
Type |
Description |
result |
List<int> |
Tag data |
Sample Code¶
if (_a3xdPlugin.ON_TAG_MEMORY_LONG_RECEIVED == methodCall.method) {
List<int> dataList = methodCall.arguments['result'].whereType<int>().toList();
}
3.27. ON_PC_EPC_SENSOR_DATA_RECEIVED¶
Receives inventoried temperature/humidity RF tag data. When the startRFMDecode method is called, this callback method receives the inventoried temperature/humidity RF tag data.
Parameters¶
Argument Name |
Type |
Description |
pcEpc |
List<int> |
PC+EPC data |
sensorData |
List<int> |
Sensor data |
Sample Code¶
if (_a3xdPlugin.ON_PC_EPC_SENSOR_DATA_RECEIVED == methodCall.method) {
List<int> pcEpcList = methodCall.arguments['pcEpc'].whereType<int>().toList();
List<int> sensorDataList = methodCall.arguments['sensorData'].whereType<int>().toList();
}
3.28. ON_SET_CHANNEL_SUCCESS¶
Receives the configured channel result. When the setChannel method is called, this callback receives the channel setting result.
Sample Code¶
if (_a3xdPlugin.ON_SET_CHANNEL_SUCCESS == methodCall.method) {
}
3.29. ON_SET_FH_LBT_PARAM_SUCCESS¶
Receives the FH and LBT parameter setting result. When the setFhLbtParam method is called, this callback method receives the FH and LBT parameter setting result.
Sample Code¶
if (_a3xdPlugin.ON_SET_FH_LBT_PARAM_SUCCESS == methodCall.method) {
}
3.30. ON_LOCK_TAG_MEMORY_SUCCESS¶
Receives the RF tag lock result. When the lockTagMemory or lockTagMemoryWithTimeout methods are called, this callback method receives the RF tag lock result.
Sample Code¶
if (_a3xdPlugin.ON_LOCK_TAG_MEMORY_SUCCESS == methodCall.method) {
}
3.31. ON_WRITE_TO_TAG_MEMORY_SUCCESS¶
Receives the result of writing data to the RF tag. When the writeTagMemory, writeTagMemoryWithTimeout, or writeTagMemoryWithData methods are called, this callback method receives the result of writing data to the RF tag.
Sample Code¶
if (_a3xdPlugin.ON_WRITE_TO_TAG_MEMORY_SUCCESS == methodCall.method) {
}
3.32. ON_KILL_TAG_MEMORY_SUCCESS¶
Receives the RF tag kill result. When the killTag method is called, this callback method receives the RF tag kill result.
Sample Code¶
if (_a3xdPlugin.ON_KILL_TAG_MEMORY_SUCCESS == methodCall.method) {
}
3.33. ON_SET_SESSION_SUCCESS¶
Receives the Session setting result. When the setSession method is called, this callback method receives the Session setting result.
Sample Code¶
if (_a3xdPlugin.ON_SET_SESSION_SUCCESS == methodCall.method) {
}
3.34. ON_GET_FREQUENCY_HOPPING_TABLE_SUCCESS¶
Receives the hopping table. When the getFrequencyHoppingTable method is called, this callback method receives the hopping table.
Parameters¶
Argument Name |
Type |
Description |
result |
List<int> |
Hopping table |
Sample Code¶
if (_a3xdPlugin.ON_GET_FREQUENCY_HOPPING_TABLE_SUCCESS == methodCall.method) {
List<int> dataList = methodCall.arguments['result'].whereType<int>().toList();
}
3.35. ON_SET_OUTPUTPOWER_LEVEL_SUCCESS¶
Receives the power level setting result. When the setOutputPowerLevel method is called, this callback method receives the power level setting result.
Sample Code¶
if (_a3xdPlugin.ON_SET_OUTPUTPOWER_LEVEL_SUCCESS == methodCall.method) {
}
3.36. ON_SET_ANTICOLLISION_MODE_SUCCESS¶
Receives the anti-collision algorithm setting result. When the setAntiCollisionMode method is called, this callback method receives the power level setting result.
Sample Code¶
if (_a3xdPlugin.ON_SET_ANTICOLLISION_MODE_SUCCESS == methodCall.method) {
}
3.37. ON_SET_TRIGGER_STOP_CONDITION_SUCCESS¶
Receives the trigger stop condition setting result. When the setTriggerStopCondition method is called, this callback method receives the trigger stop condition setting result.
Sample Code¶
if (_a3xdPlugin.ON_SET_TRIGGER_STOP_CONDITION_SUCCESS == methodCall.method) {
}
3.38. ON_AUTO_INVENTORY_FINISHED¶
Receives the result of automatic inventory completion. When the startInventory method is called, this callback method receives the result of automatic inventory completion.
Sample Code¶
if (_a3xdPlugin.ON_AUTO_INVENTORY_FINISHED == methodCall.method) {
}
3.39. ON_RFID_MANAGER_ERROR¶
Callbacks when an RFID-related setting error occurs.
Parameters¶
Argument Name |
Type |
Description |
result |
String |
Error message |
Sample Code¶
if (_a3xdPlugin.ON_RFID_MANAGER_ERROR == methodCall.method) {
String message = methodCall.arguments['result'];
}
3.40. ON_RECEIVE_AUTO_OFF_TIME¶
Receives the auto-off time. (M30S only) When the getAutoOffTime method is called, this callback method receives the AsReader’s auto-off time.
Parameters¶
Argument Name |
Type |
Description |
result |
int |
Device auto-off time |
Sample Code¶
if (_a3xdPlugin.ON_RECEIVE_AUTO_OFF_TIME == methodCall.method) {
int time = methodCall.arguments['result'];
}
3.41. DID_SET_AUTO_OFF_TIME¶
Receives the auto-off time setting result. (M30S only) When the setAutoOffTime method is called, this callback method receives the AsReader’s auto-off time setting result.
Parameters¶
Argument Name |
Type |
Description |
result |
int |
0: Success
|
Sample Code¶
if (_a3xdPlugin.DID_SET_AUTO_OFF_TIME == methodCall.method) {
int status = methodCall.arguments['result'];
}
3.42. ON_RECEIVE_CONTINUOUS_MODE¶
Receives the continuous scan status. (M30S only) When the getContinuousMode method is called, this callback method receives whether continuous scan is active.
Parameters¶
Argument Name |
Type |
Description |
result |
bool |
true: Continuous scan
|
Sample Code¶
if (_a3xdPlugin.ON_RECEIVE_CONTINUOUS_MODE == methodCall.method) {
bool status = methodCall.arguments['result'];
}
3.43. DID_SET_CONTINUOUS_MODE¶
Receives the continuous scan setting result. (M30S only) When the setContinuousMode method is called, this callback method receives the continuous scan setting result.
Parameters¶
Argument Name |
Type |
Description |
result |
int |
0: Success
|
Sample Code¶
if (_a3xdPlugin.DID_SET_CONTINUOUS_MODE == methodCall.method) {
int status = methodCall.arguments['result'];
}
3.44. ON_RECEIVE_HID_MODE¶
Receives the HID status. (M30S only) When the getHidMode method is called, this callback method receives whether the AsReader is in HID mode.
Parameters¶
Argument Name |
Type |
Description |
result |
bool |
true: HID mode
|
Sample Code¶
if (_a3xdPlugin.ON_RECEIVE_HID_MODE == methodCall.method) {
bool status = methodCall.arguments['result'];
}
3.45. DID_SET_HID_MODE¶
Receives the HID setting result. (M30S only) When the setHidMode method is called, this callback method receives the AsReader’s HID mode setting result.
Parameters¶
Argument Name |
Type |
Description |
result |
int |
0: Success
|
Sample Code¶
if (_a3xdPlugin.DID_SET_HID_MODE == methodCall.method) {
int status = methodCall.arguments['result'];
}
3.46. ON_RECEIVE_Q_VALUE¶
Receives the Q value. (M30S only) When the getQValue method is called, this callback method receives the AsReader’s Q value.
パラメータ¶
Argument Name |
Type |
Description |
result |
int |
Q value |
Sample Code¶
if (_a3xdPlugin.ON_RECEIVE_Q_VALUE == methodCall.method) {
int value = methodCall.arguments['result'];
}
3.47. DID_SET_Q_VALUE¶
Receives the Q value setting result. (M30S only) When the setQValue method is called, this callback method receives the Q value setting result.
Parameters¶
Argument Name |
Type |
Description |
result |
int |
0: Success
|
Sample Code¶
if (_a3xdPlugin.DID_SET_Q_VALUE == methodCall.method) {
int status = methodCall.arguments['result'];
}
3.48. ON_RECEIVE_SESSION_FLAG¶
Receives the SessionFlag. (M30S only) When the getSessionFlag method is called, this callback method receives the AsReader’s SessionFlag.
Parameters¶
Argument Name |
Type |
Description |
result |
int |
SessionFlag |
Sample Code¶
if (_a3xdPlugin.ON_RECEIVE_SESSION_FLAG == methodCall.method) {
int value = methodCall.arguments['result'];
}
3.49. DID_SET_SESSION_FLAG¶
Receives the SessionFlag setting result. (M30S only) When the setSessionFlag method is called, this callback method receives the SessionFlag setting result.
Parameters¶
Argument Name |
Type |
Description |
result |
int |
0: Success Others: Failure |
Sample Code¶
if (_a3xdPlugin.DID_SET_SESSION_FLAG == methodCall.method) {
int status = methodCall.arguments['result'];
}
3.50. ON_RECEIVE_DUTY_RATIO¶
Receives the duty ratio. (M30S only) When the getDutyRatio method is called, this callback method receives the AsReader’s duty ratio.
Parameters¶
Argument Name |
Type |
Description |
result |
int |
Duty ratio |
Sample Code¶
if (_a3xdPlugin.ON_RECEIVE_DUTY_RATIO == methodCall.method) {
int value = methodCall.arguments['result'];
}
3.51. DID_SET_DUTY_RATIO¶
Receives the duty ratio setting result. (M30S only) When the setDutyRatio method is called, this callback method receives the AsReader’s duty ratio setting result.
Parameters¶
Argument Name |
Type |
Description |
result |
int |
0: Success
|
Sample Code¶
if (_a3xdPlugin.DID_SET_DUTY_RATIO == methodCall.method) {
int status = methodCall.arguments['result'];
}
3.52. ON_RECEIVE_DUTY_RATIO_BASE_TIME¶
Receives the duty ratio base time. (M30S only) When the getDutyRatioBaseTime method is called, this callback method receives the AsReader’s duty ratio base time.
Parameters¶
Argument Name |
Type |
Description |
result |
int |
Duty ratio base time |
Sample Code¶
if (_a3xdPlugin.ON_RECEIVE_DUTY_RATIO_BASE_TIME == methodCall.method) {
int value = methodCall.arguments['result'];
}
3.53. DID_SET_DUTY_RATIO_BASE_TIME¶
Receives the duty ratio base time setting result. (M30S only) When the setDutyRatioBaseTime method is called, this callback method receives the AsReader’s duty ratio base time setting result.
Parameters¶
Argument Name |
Type |
Description |
result |
int |
0: Success
|
Sample Code¶
if (_a3xdPlugin.DID_SET_DUTY_RATIO_BASE_TIME == methodCall.method) {
int status = methodCall.arguments['result'];
}