2. List of methods¶
2.1. getPlatformVersion¶
Get the platform version.
Future<string?> getPlatformVersion()
Return value¶
type |
Description |
Future<string?> |
Platform version |
2.2. getSDKVersion¶
Get the SDK version.
Future<string?> getSDKVersion()
Return value¶
type |
Description |
Future<string?> |
SDK version |
2.3. showPrintNSLog¶
Set whether to output SDK Log.
Future<void> showPrintNSLog(bool isShow) async
Parameters¶
argument name |
type |
Description |
isShow |
bool |
Whether to output Log |
2.4. getReaderInfo¶
Get the data information of AsReader. After execution, receive AsReader data information using the callback method READER_INFO_RECEIVED.
Future<bool> getReaderInfo(int infoType)
Parameters¶
Return value¶
type |
Description |
Future<bool> |
Method execution result
|
2.5. getCurrentBattery¶
Get the remaining battery power of AsReader. After execution, receive the remaining battery level of AsReader using the callback method BATTERY_RECEIVED.
Future<int> getCurrentBattery()
Return value¶
type |
Description |
Future<int> |
Battery level |
2.6. setTriggerMode¶
Sets the trigger mode of AsReader.
Future<bool> setTriggerMode(bool isDefault)
Parameters¶
argument name |
type |
Description |
isDefault |
bool |
true: perform default action with trigger key (scan)
|
Return value¶
type |
Description *-Future<bool> |
Method execution result
|
2.7. setBeep¶
Configure AsReader’s beep, vibration, LED, and aiming. After execution, the callback method DID_SET_BEEP receives the settings results for AsReader’s beep, LED, and aiming.
Future<bool> setBeep(bool isBeep,bool vibration,bool
batteryGaugeLed,bool barcodeAimer)
Parameters¶
Return value¶
type |
Description |
Future<bool> |
Method execution result
|
2.8. setBeepIncludePowerOnBeep¶
Configure AsReader’s beep, vibration, LED, aiming, and power-on beep.
Future<bool> setBeepIncludePowerOnBeep(bool isBeep,bool
vibration,bool batteryGaugeLed,bool barcodeAimer,bool barcodePowerOnBeep)
Parameters¶
Return value¶
type |
Description |
Future<bool> |
Method execution result
|
2.9. setReaderPower¶
Set the beep, vibration, LED, aiming, and power-on beep at the same time you power on AsReader. After execution, the callback method CONNECTED_STATUS receives the AsReader connection status, and the callback method POWER_ON_OFF receives the AsReader connection status and hardware status.
Future<int> setReaderPower(bool isOn,bool beep,bool vibration,bool led,bool illumination,bool connectedBeep,int mode)
Parameters¶
argument name |
type |
Description |
isOn |
bool |
Power on/off
|
beep |
bool |
Beep on/off
|
vibration |
bool |
Vibration on/off
|
led |
bool |
LED on/off
|
illumination |
bool |
Aiming on/off
|
connectedBeep |
bool |
Power-on beep on/off
|
mode |
int |
AsReader type
|
Return value¶
type |
Description *-Future<int> |
0: Failed to send command
|
2.10. setTagCount¶
Set the counting conditions for scanned RF tags.
Future<void> setTagCount(int mtnu,int mtime,int repeatCycle) async
Parameters¶
argument name |
type |
Description |
argument name mtnu |
type int |
Maximum number of RF tags to read |
argument name mtime |
type int |
Maximum time for reading |
argument name repeatCycle |
type int |
Number of read repetitions |
2.11. setChargingControl¶
Set whether to charge the smartphone at the same time when charging the AsReader with the Magconn cable.
Future<void> setChargingControl(bool isOn)
Parameters¶
argument name |
type |
Description |
isOn |
bool |
Charging settings
|
2.12. getDelayDisconnectOnBackground¶
Gets the time from when the app is in the background until the connection with AsReader is broken.
Future<double> getDelayDisconnectOnBackground()
Return value¶
2.13. isOpened¶
Get the AsReader connection status.
Future<bool> isOpened()
Return value¶
type |
Description |
Future<bool> |
true: Connected
|
2.14. setStopTagNum¶
Set the conditions to stop reading RF tags.
Future<bool> setStopTagNum(int maxTags,int maxTime,int repeatCycle)
Parameters¶
Return value¶
type |
Description |
Future<bool> |
Method execution result
|
2.15. getStopCondition¶
Get the value of StopCondition. After execution, receive the value of StopCondition in the callback method STOP_CONDITIONS_RECEIVED.
Future<bool> getStopCondition()
Return value¶
type |
Description |
Future<bool> |
Method execution result
|
2.16. reset¶
Reset AsReader.
Future<bool> reset()
Return value¶
2.17. getAutoLaunch¶
Gets the app’s autostart status when connecting to AsReader. (M24D only) After execution, receive the app’s autolaunch status in the callback method RECEIVED_GET_AUTO_LAUNCH.
Future<bool> getAutoLaunch()
Return value¶
type |
Description |
Future<bool> |
Method execution result
|
2.18. setAutoLaunch¶
Set whether the demo app starts automatically when connected to AsReader. (M24D only)
Future<bool> setAutoLaunch(bool enable,String bundleId)
Parameters¶
argument name |
type |
Description |
argument name enable |
type bool |
App auto-start
|
argument name bundleId |
type String |
Bundle ID |
Return value¶
type |
Description |
Future<bool> |
Method execution result
|
2.19. setSleepBeep¶
Set AsReader’s automatic sleep function. (M24D only) After execution, the setting result of AsReader’s automatic sleep function will be received using the callback method RECEIVED_SLEEP_BEEP.
Future<bool> setSleepBeep(bool isOn)
Parameters¶
argument name |
type |
Description |
isOn |
bool |
true: on
|
Return value¶
type |
Description |
Future<bool> |
Method execution result
|
2.20. setSleepTime¶
Set automatic sleep time for AsReader. (M24D only) After execution, the result of AsReader’s automatic sleep time setting will be received using the callback method RECEIVED_SLEEP_BEEP.
Future<bool> setSleepTime(int time)
Parameters¶
argument name |
type |
Description |
time |
int |
sleep time |
Return value¶
type |
Description |
Future<bool> |
Method execution result
|
2.21. getSleepTime¶
Get AsReader’s automatic sleep time. (M24D only)
Future<bool> getSleepTime()
Return value¶
type |
Description |
Future<bool> |
Method execution result
|
2.22. startBleScan¶
Start searching for Bluetooth devices. After execution, the callback method SCAN_BLE_STATUS will receive the search results for the Bluetooth device, and the callback method SCANING_BLE_DEVICE will receive the search results for the Bluetooth name.
Future<bool> startBleScan()
Return value¶
type |
Description |
Future<bool> |
Method execution result
|
2.23. stopBleScan¶
Stop searching for Bluetooth devices.
Future<void> stopBleScan()
2.24. disConnectBLE¶
Disconnect from the Bluetooth device.
Future<bool> disConnectBLE()
Return value¶
type |
Description |
Future<bool> |
Method execution result
|
2.25. connectBLE¶
Connect to your Bluetooth device.
Future<bool> connectBLE(String deviceName)
Parameters¶
argument name |
type |
Description |
deviceName |
String |
Name of the Bluetooth device connected to the iOS device |
Return value¶
type |
Description |
Future<bool> |
Method execution result
|
2.26. getSleepTimeForBLEDevice¶
Get the sleep time of a Bluetooth device. After execution, receive the sleep time of the Bluetooth device obtained/set using the callback method RECEIVED_SLEEP_TIME_AND_ISACK and RECEIVED_SLEEP_TIME.
Future<int> getSleepTimeForBLEDevice()
Return value¶
type |
Description |
Future<int> |
Method execution result
|
2.27. setSleepTimeForBLEDeviceType¶
Set the sleep time for your Bluetooth device. After execution, receive the sleep time of the Bluetooth device obtained/set using the callback method RECEIVED_SLEEP_TIME_AND_ISACK and RECEIVED_SLEEP_TIME.
Future<int> setSleepTimeForBLEDeviceType(int min,int type)
Parameters¶
argument name |
type |
Description |
min |
int |
Bluetooth device sleep time |
type |
int |
How to save |
Return value¶
type |
Description |
Future<int> |
Method execution result
|
2.28. startBarcodeScan¶
Start scanning the barcode. After execution, the scan results will be notified using one of the following callback methods:
-RECEIVED_SCAN_DATAReceive scanned barcode data. -RECEIVED_SCAN_DATA_AND_DATA_TYPEReceive barcode data and its data type. -RECEIVED_SCAN_BARCODE_DATA Receive barcode data and data type. *This callback is available on some models only, such as ASR-025S.
Future<bool> startBarcodeScan(int numberOfTags,int readUntilInSec)
Parameters¶
argument name |
type |
Description |
numberOfTags |
int |
Maximum number of barcodes read |
readUntilInSec |
int |
Maximum time that can be read at one time |
Return value¶
type |
Description |
Future<bool> |
Method execution result
|
2.29. stopBarcodeScan¶
Stop barcode scanning.
Future<bool> stopBarcodeScan()
Return value¶
type |
Description |
Future<bool> |
Method execution result
|
2.30. doFactoryReset¶
Restore the barcode module to factory settings.
Future<bool> doFactoryReset()
Return value¶
type |
Description |
Future<bool> |
Method execution result
|
2.31. setCustomPrefix¶
Set the same prefix for all types of barcodes.
Future<bool> setCustomPrefix(String prefix)
Parameters¶
argument name |
type |
Description |
prefix |
String |
prefix string |
Return value¶
type |
Description |
Future<bool> |
Method execution result
|
2.32. setDisableCustomPrefix¶
Delete the prefix set with setCustomPrefix.
Future<bool> setDisableCustomPrefix()
Return value¶
type |
Description |
Future<bool> |
Method execution result
|
2.33. setCustomSuffix¶
Set the same suffix for all types of barcodes.
Future<bool> setCustomSuffix(String suffix)
Parameters¶
argument name |
type |
Description |
suffix |
String |
suffix string |
Return value¶
type |
Description *-Future<bool> |
Method execution result
|
2.34. setDisableCustomSuffix¶
Removes the suffix specified by setCustomSuffix.
Future<bool> setDisableCustomSuffix()
Return value¶
type |
Description |
Future<bool> |
Method execution result
|
2.35. setSymbologyPrefix¶
Depending on the barcode type, set the appropriate prefix for each barcode type. A list of prefixes and corresponding barcode types can be found at Please refer to “5.1 Symbol Table” in Barcode Setting Manual.
Future<bool> setSymbologyPrefix()
Return value¶
type |
Description |
Future<bool> |
Method execution result
|
2.36. setDisableSymbologyPrefix¶
Delete the prefix specified with setSymbologyPrefix.
Future<bool> setDisableSymbologyPrefix()
Return value¶
type |
Description |
Future<bool> |
Method execution result
|
2.37. setCodeID¶
Set the CodeID type. (M24D only)
Future<bool> setCodeID(int type,bool isBeepOn)
Parameters¶
argument name |
type |
Description |
type |
int |
0:None, 1:Aim, 2:Symbol |
isBeepOn |
bool |
true: on
|
Return value¶
type |
Description *-Future<bool> |
Method execution result
|
2.38. setOCRType¶
Set the OCR type and on/off. (M24D only)
Future<bool> setOCRType(int type,bool isBeepOn)
Parameters¶
argument name |
type |
Description |
type |
int |
0:NONE, 1:A, 2:B, 3:AB |
isBeepOn |
bool |
true: on
|
Return value¶
2.39. setAndroidHIDEnable¶
Set whether to turn on Android HID mode. (M24D only)
Future<bool> setAndroidHIDEnable(int isOn)
Parameters¶
argument name |
type |
Description |
isOn |
int |
1: On
|
Return value¶
type |
Description |
Future<bool> |
Method execution result
|
2.40. setiOSHIDEnable¶
Set whether to turn on iOS HID mode. (M24D only)
Future<bool> setiOSHIDEnable(int isOn)
Parameters¶
argument name |
type |
Description |
isOn |
int |
1: On
|
Return value¶
type |
Description |
Future<bool> |
Method execution result
|
2.41. setPresentationMode¶
Set presentation mode on/off. (M24D only)
Future<bool> setPresentationMode(bool isOn,bool isBeepOn)
Parameters¶
argument name |
type |
Description |
isOn |
bool |
Presentation mode status
|
isBeepOn |
bool |
1: On
|
Return value¶
type |
Description |
Future<bool> |
Method execution result
|
2.42. getCodeID¶
Get CodeID. (M24D only) After execution, you will receive the CodeID in the callback method RECEIVED_CODE_ID.
Future<bool> getCodeID()
Return value¶
type |
Description |
Future<bool> |
Method execution result
|
2.43. getHID¶
Get the HID mode status. (M24D only) After execution, receive the HID mode status in the callback method RECEIVED_HID.
Future<bool> getHID()
Return value¶
2.44. getSymbologies¶
Get the barcode type reading status. (M24D only) After execution, receive the reading status of the barcode type in the callback method RECEIVED_SYMBOLOGIES.
Future<bool> getSymbologies()
Return value¶
type |
Description |
Future<bool> |
Method execution result
|
2.45. setSsiParamWithData¶
Configure SSI parameters. (M24D only)
Future<bool> setSsiParamWithData(Uint8List symbolData,bool beepOn)
Parameters¶
argument name |
type |
Description |
symbolData |
Uint8List |
data |
beepOn |
bool |
true: on
|
Return value¶
type |
Description |
Future<bool> |
Method execution result
|
2.46. setSsiParamWithDictionary¶
Configure SSI parameters. (M24D only) After execution, receive the Ssi parameter setting results using the callback method RECEIVED_BARCODE_SET_SSI_SUCCESS.
Future<bool> setSsiParamWithDictionary(Map symbologies,bool beepOn)
Parameters¶
argument name |
type |
Description |
symbologies |
Map |
data |
beepOn |
bool |
true: on
|
Return value¶
2.47. getPresentationMode¶
Gets the presentation mode status. (M24D only) After execution, receive the presentation mode status in the callback method RECEIVED_PRESENTATION_MODE.
Future<bool> getPresentationMode()
Return value¶
type |
Description |
Future<bool> |
Method execution result
|
2.48. getSecurity¶
Get the barcode security level. (M24D only) After execution, receive the security level of the barcode in the callback method RECEIVED_BARCODE_SECURITY.
Future<bool> getSecurity()
Return value¶
type |
Description |
Future<bool> |
Method execution result
|
2.49. startScan¶
Start reading the RF tag. After execution, receive scanned data with callback method RECEIVED_SCAN_DATA, receive data and data type with RECEIVED_SCAN_DATA_AND_DATA_TYPE, Receive the EPC data of the RF tag with PC_EPC_RECEIVED.
Future<bool> startScan(int numberOfTags,int readUntilInSec,int repeatCycle)
Parameters¶
Return value¶
type |
Description |
Future<bool> |
Method execution result
|
2.50. stopRfidScan¶
Stop reading RF tags.
Future<bool> stopRfidScan()
Return value¶
type |
Description |
Future<bool> |
Method execution result
|
2.52. startReadTagAndTidWithTagNum¶
AsReader turns on the TID function when reading RF tags. After execution, receive the EPC and TID data of the RF tag using the callback method EPC_RECEIVED_AND_TID.
Future<bool> startReadTagAndTidWithTagNum(int maxTags,int maxTime, int repeatCycle)
Parameters¶
Return value¶
type |
Description |
Future<bool> |
Method execution result
|
2.54. getSelectParameter¶
Get the parameters of AsReader’s select function. After execution, receive the select parameter acquisition result using the callback method SELECT_PARAM_RECEIVED.
Future<bool> getSelectParameter()
Return value¶
type |
Description |
Future<bool> |
Method execution result
|
2.55. setSelectParameter¶
Set the filter function when reading RF tags.
Future<bool> setSelectParameter(int target,int action,int memoryBank,int pointer, int length,int truncate,Uint8List mask)
Parameters¶
Return value¶
type |
Description |
Future<bool> |
Method execution result
|
2.56. getChannel¶
Acquires RF channel when in non-hopping mode. After execution, receive the RF channel acquisition result using the callback method CHANNEL_RECEIVED_AND_CHANNEL_OFFSET.
Future<bool> getChannel()
Return value¶
type |
Description |
Future<bool> |
Method execution result
|
2.57. setReadTime¶
Set the read time and idle time. After execution, the callback method ON_OFF_TIME_CHANGED receives the setting results of the read time and idle time.
Future<bool> setReadTime(int readTime,int idleTime)
Parameters¶
argument name |
type |
Description |
readTime |
int |
Reading time (ms) |
idleTime |
int |
Idle time (ms) |
Return value¶
type |
Description |
Future<bool> |
Method execution result
|
2.58. setChannel¶
Sets the RF channel when in non-hopping mode. After execution, receive the RF channel setting results using the callback method DID_SET_CHANNEL_PARAM_RECEIVED.
Future<bool> setChannel(int channel,int channelOffset)
Parameters¶
argument name |
type |
Description |
channel |
int |
channel value |
channelOffset |
int |
Mirror subcarrier channel offset |
Return value¶
type |
Description |
Future<bool> |
Method execution result
|
2.59. getFhLbtParameter¶
Get FH and LBT parameters. After execution, callback methods FHLBT_RECEIVED, RFID_ON_OFF_TIME_RECEIVED, [QUERY_ Receive the FH and LBT parameter acquisition results with PARAM_RECEIVED and FREQ_HP_TABLE_RECEIVED.
Future<bool> getFhLbtParameter()
Return value¶
2.60. setFhLbtParameter¶
Set the FH and LBT parameters. After execution, the FH and LBT parameter setting results are received using the callback method DID_SET_FREQ_HP_TABLE.
Future<bool> setFhLbtParameter(int readTime, int idleTime,
int carrierSenseTime, int targetRFPowerLevel, int frequencyHopping,
int listenBeforeTalk, int continuousWave)
Parameters¶
Return value¶
type |
Description |
Future<bool> |
Method execution result
|
2.61. getOutputPowerLevel¶
Get the current output power and maximum and minimum output power. After execution, the callback method TX_POWER_LEVEL_RECEIVED_POWER receives the current output power, maximum, and minimum output power acquisition results.
Future<bool> getOutputPowerLevel()
Return value¶
type |
Description |
Future<bool> |
Method execution result
|
2.62. setOutputPowerLevel¶
Set the current output power. After execution, receive the power setting result using the callback method DID_SET_OUTPUT_POWER_LEVEL.
Future<bool> setOutputPowerLevel(int powerLevel)
Parameters¶
argument name |
type |
Description |
powerLevel |
int |
Output power
|
Return value¶
type |
Description |
Future<bool> |
Method execution result
|
2.63. writeTagMemoryWithAccessPassword¶
Write data to the RF tag. After execution, the callback method ERROR_RECEIVED receives error information, and the callback method WRITTEN_RECEIVED receives the data written to the RF tag.
Future<bool> writeTagMemoryWithAccessPassword(Int32 accessPassword, Uint8List epc, int memoryBank, int startAddress, Uint8List dataToWrite)
Parameters¶
Return value¶
type |
Description |
Future<bool> |
Method execution result
|
2.64. killTagWithPassword¶
Kill the RF tag. Note: Before killing a tag, you must set a kill password. After execution, the error information is received using the callback method ERROR_RECEIVED, and the RF tag kill result is received using the callback method KILL_RECEIVED.
Future<bool> killTagWithPassword(Int32 accessPassword, Uint8List epc)
Parameters¶
argument name |
type |
Description |
accessPassword |
Int32 |
Kill password
|
epc |
Uint8List |
EPC data of target RF tag |
Return value¶
2.65. lockTagMemoryWithAccessPassword¶
Lock the RF tag. After execution, the error information is received using the callback method ERROR_RECEIVED, and the RF tag lock result is received using the callback method LOCKED_RECEIVED.
Future<bool> lockTagMemoryWithAccessPassword(Int32 accessPassword,Uint8List epc,int lockData)
Parameters¶
Return value¶
type |
Description |
Future<bool> |
Method execution result
|
2.66. getFrequencyHoppingTable¶
Get the current hopping table. After execution, receive the hopping table acquisition results using the callback method HOPPING_TABLE_RECEIVED.
Future<bool> getFrequencyHoppingTable()
Return value¶
type |
Description |
Future<bool> |
Method execution result
|
2.67. setFrequencyHoppingTableSize¶
Set up the hopping table. After execution, receive the hopping table setting result using the callback method DID_SET_OPTI_FREQ_HPTABLE.
Future<bool> setFrequencyHoppingTableSize(int tableSize, Uint8List channels)
Parameters¶
argument name |
type |
Description |
tableSize |
int |
Table size (8 digits) |
channels |
Uint8List |
Channel number (variable) |
Return value¶
type |
Description |
Future<bool> |
Method execution result
|
2.68. getRssi¶
Get RSSI.
Future<bool> getRssi()
Return value¶
type |
Description |
Future<bool> |
Method execution result
|
2.69. getSession¶
Get the current session. After execution, receive the session acquisition result using the callback method SESSION_RECEIVED.
Future<bool> getSession()
Return value¶
type |
Description |
Future<bool> |
Method execution result
|
2.70. setSession¶
Sets the current session. After execution, receive the session setting results using the callback method DID_SET_SESSION.
Future<bool> setSession(int session)
Parameters¶
argument name |
type |
Description |
session |
int |
S0:0, S1:1, S2:2, S3:3 |
Return value¶
type |
Description |
Future<bool> |
Method execution result
|
2.71. getAnticollision¶
Get the anti-collision algorithm. After execution, receive the results of the anti-collision algorithm using the callback method ANTICOL_PARAM_RECEIVED_AND_COUNTER.
Future<bool> getAnticollision()
Return value¶
type |
Description |
Future<bool> |
Method execution result
|
2.72. setAnticollision¶
Set the anti-collision algorithm. After execution, the anti-collision algorithm setting result is received in the callback method DID_SET_ANTI_COLLISION.
Future<bool> setAnticollision(int mode,int counter)
Parameters¶
argument name |
type |
Description |
mode |
int |
Fixed Q: 0, Dynamic Q: 1 |
counter |
int |
Counter (default value: 1) |
Return value¶
type |
Description |
Future<bool> |
Method execution result
|
2.73. updateRegistry¶
Update the registry. After execution, the registry update results are received using the callback method UPDATED_REGISTERY.
Future<bool> updateRegistry()
Return value¶
type |
Description |
Future<bool> |
Method execution result
|
2.74. getRFIDModuleVersion¶
Get the RFID module version of AsReader. After execution, the callback method RFID_MODULE_VERSION_RECEIVED receives the acquisition result of AsReader’s RFID module version.
Future<bool> getRFIDModuleVersion()
Return value¶
type |
Description |
Future<bool> |
Method execution result
|
2.75. setHoppingOnOff¶
Set hopping and LBT parameters. After execution, the hopping and LBT parameter setting results are received in the callback method DID_SET_FHLBT.
Future<bool> setHoppingOnOff(bool isOn)
Parameters¶
Return value¶
type |
Description |
Future<bool> |
Method execution result
|
2.76. writeTagMemoryWithEPC¶
Write data to the RF tag. After execution, receive the data writing results using the callback method WRITTEN_RECEIVED.
Future<bool> writeTagMemoryWithEPC(Uint8List epc,String dataToWrite)
Parameters¶
argument name |
type |
Description |
epc |
Uint8List |
EPC data of target tag |
epcdataToWrite |
Uint8ListString |
Write data |
Return value¶
2.77. setRSSIThreshold¶
Set the RSSI filter conditions.
Future<bool> setRSSIThreshold(int threshold)
Parameters¶
argument name |
type |
Description |
threshold |
int |
RSSI value: 50=-50dBm |
Return value¶
type |
Description |
Future<bool> |
Method execution result
|
2.78. getRSSIThreshold¶
Get the RSSI filter conditions. After execution, the callback method RSSI_THRESHOLD_RECEIVED receives the RSSI filter condition, and the callback method UNKNOWN_COMMAND_RECEIVED receives the undefined command.
Future<bool> getRSSIThreshold()
Return value¶
type |
Description |
Future<bool> |
Method execution result
|
2.79. getQueryParameter¶
Get A/I query parameters of type C.
Future<bool> getQueryParameter()
Return value¶
type |
Description |
Future<bool> |
Method execution result
|
2.80. readTagWithAccessPassword¶
Reads tag data from the specified memory. After execution, the callback method ERROR_RECEIVED receives error information, and the callback method TAG_MEMORY_RECEIVED receives the reading result of the tag data in the memory specified.
Future<bool> readTagWithAccessPassword(Int32 accessPassword, Uint8List epc,
int memoryBank, int startAddress, int dataLength)
Parameters¶
argument name |
type |
Description |
accessPassword |
Int32 |
access password |
epc |
Uint8List |
Target tag |
memoryBank |
int |
RFU: 0, EPC: 1, TID: 2, User: 3 |
startAddress |
int |
Start address (unit: word) |
dataLength |
int |
Data length (unit: word) |
Return value¶
type |
Description |
Future<bool> |
Method execution result
|
2.81. setQueryParam¶
Set the query command.
Future<bool> setQueryParam(int divideRatio,int m,int trext,int selection,
int session,int target,int qValue)
Parameters¶
Return value¶
type |
Description |
Future<bool> |
Method execution result
|
2.82. setRfCw¶
Configure continuous wave signal control for RF tags.
Future<bool> setRfCw(bool on)
Parameters¶
Return value¶
type |
Description |
Future<bool> |
Method execution result
|
2.83. getModulation¶
Get the current modulation mode. After execution, receive the modulation mode acquisition result using the callback method MODULATION_PARAM_RECEIVED_RXMOD_DR.
Future<bool> getModulation()
Return value¶
type |
Description *-Future<bool> |
Method execution result
|
2.84. setModulationBLF¶
Set the modulation mode. After execution, receive the modulation mode setting result using the callback method DID_SET_MODULATION.
Future<bool> setModulationBLF(int blf,int rxMod,int dr)
Parameters¶
Return value¶
type |
Description |
Future<bool> |
Method execution result
|
2.85. blockEraseTagMemoryWithAccessPassword¶
Block and erase RF tag data.
Future<bool> blockEraseTagMemoryWithAccessPassword(Int32 accessPassword, Uint8List epc, int memoryBank, int startAddress, int dataLength)
Parameters¶
Return value¶
type |
Description |
Future<bool> |
Method execution result
|
2.86. getTemperature¶
Get the temperature.
Future<bool> getTemperature()
Return value¶
type |
Description |
Future<bool> |
Method execution result
|
2.87. setOptimumFrequencyHoppingTable¶
Set up the perfect hopping table.
Future<bool> setOptimumFrequencyHoppingTable()
Return value¶
type |
Description |
Future<bool> |
Method execution result
|
2.88. getRegistryItem¶
Get the registry table. After execution, receive the registry table acquisition result using the callback method REGISTERY_ITEM_RECEIVED.
Future<bool> getRegistryItem(int registryItem)
Parameters¶
argument name |
type |
Description |
registryItem |
int |
Registry table version: 0x0000
|
Return value¶
type |
Description |
Future<bool> |
Method execution result
|
2.89. setFrequencyHoppingMode¶
Set hopping mode. After execution, receive the hopping mode setting result using the callback method DID_SET_FHMODE_CHANGED.
Future<bool> setFrequencyHoppingMode(int mode)
Parameters¶
argument name |
type |
Description |
mode |
int |
Hopping mode
|
Return value¶
type |
Description |
Future<bool> |
Method execution result
|
2.90. getFrequencyHoppingMode¶
Get hopping mode.
Future<bool> getFrequencyHoppingMode()
Return value¶
type |
Description |
Future<bool> |
Method execution result
|
2.91. setSmartHoppingOnOff¶
Set hopping mode.
Future<bool> setSmartHoppingOnOff(bool isOn)
Parameters¶
argument name |
type |
Description |
isOn |
bool |
Hopping mode
|
Return value¶
type |
Description |
Future<bool> |
Method execution result
|
2.92. getRegion¶
Get local information. After execution, receive the regional information acquisition results using the callback method REGION_RECEIVED.
Future<bool> getRegion()
Return value¶
type |
Description |
Future<bool> |
Method execution result
|
2.93. setReadRSSIMode¶
Get RFID module information and region information.
Future<void> setReadRSSIMode(bool isReadRSSIMode) async
Set whether to read the RF tag’s RSSI data when pressing the Trigger key in RFID mode.
2.94. getRfidModuleInformation¶
Future<bool> getRfidModuleInformation()
Return value¶
type |
Description |
Future<bool> |
RFID module: true |
2.95. 2.99sendData¶
Send data.
Future<bool> sendData(Uint8List sendData)
Parameters¶
argument name |
type |
Description |
sendData |
Uint8List |
Transmission data |
Return value¶
type |
Description |
Future<bool> |
Method execution result
|
2.96. setInventoryTime¶
Set inventory time.
Future<bool> setInventoryTime(double inventoryTime)
Return value¶
type |
Description |
Future<bool> |
Method execution result
|
2.97. startNFCScan¶
Start scanning the NFC tag. After execution, the callback method RECEIVED_SCAN_DATA receives the scanned data, and the callback method RECEIVED_SCAN_DATA_AND_DATA_TYPE receives the scanned data and data type.
Future<bool> startNFCScan()
Return value¶
type |
Description |
Future<bool> |
Method execution result
|
2.98. stopNFCScan¶
Stop scanning NFC tags
Future<bool> stopNFCScan()
Return value¶
type |
Description |
Future<bool> |
Method execution result
|
2.99. readMultiBlockWithBlockIndex¶
Reads multiple consecutive blocks of data on the IC tag memory with the specified UID. After execution, receive the NFC tag reading result using the callback method NFC_READ_MULTI_BLOCK_RECEIVED.
Future<bool> readMultiBlockWithBlockIndex(int index, int count)
Parameters¶
argument name |
type |
Description |
index |
int |
First read block number (0~255) |
count |
int |
Number of blocks read (0~255) |
Return value¶
type |
Description |
Future<bool> |
Method execution result
|
2.100. writeSingleBlockWithBlockIndex¶
Writes a single block of data to the IC tag memory with the specified UID. After execution, receive the NFC tag write result using the callback method NFC_WRITE_SINGLE_BLOCK_STATUS_CODE.
Future<bool> writeSingleBlockWithBlockIndex(int index, Uint8List writeData, Uint8List uid)
Parameters¶
Return value¶
type |
Description |
Future<bool> |
Method execution result
|
2.101. writeBytesWithBlockIndex¶
Writes multiple blocks of data to the IC tag memory with the specified UID. After execution, receive the NFC tag write result using the callback method NFC_WRITE_BYTES_STATUS_CODE.
Future<bool> writeBytesWithBlockIndex(int index, Uint8List writeData, Uint8List uid)
Parameters¶
argument name |
type |
Description |
index |
int |
First read block number (0~255) *-writeData -Uint8List -Write data (size of each block is 4bit) *-uid -Uint8List -NFC tag UID data |
Return value¶
type |
Description |
Future<bool> |
Method execution result
|
2.102. startLfScan¶
Starts automatic inventory of RF tags. After execution, the callback method RECEIVED_SCAN_DATA receives the inventoried data, and the callback method RECEIVED_SCAN_DATA_AND_DATA_TYPE receives the inventoried data and data type.
Future<bool> startLfScan(int numberOfTags, int readUntilInSec, int repeatCycle)
Parameters¶
Return value¶
type |
Description |
Future<bool> |
Method execution result
|
2.103. stopLfScan¶
Stop automatic inventory of RF tags.
Future<bool> stopLfScan()
Return value¶
type |
Description |
Future<bool> |
Method execution result
|
2.104. isShowPrintNSLog¶
Get the output status of SDK Log.
Future<bool> isShowPrintNSLog()
Return value¶
type |
Description |
Future<bool> |
SDK Log output status
|
2.105. bundleIdentifier¶
Get the unique identifier of an iOS application.
Future<string> bundleIdentifier()
Return value¶
type |
Description |
Future<string> |
Unique identifier for iOS applications |
2.106. deviceName¶
Get the device name of AsReader.
Future<string> deviceName()
Return value¶
type |
Description |
Future<string> |
AsReader device name |
2.107. deviceFirmware¶
Get the AsReader firmware.
Future<string> deviceFirmware()
Return value¶
type |
Description |
Future<string> |
AsReader firmware |
2.108. deviceHardware¶
Get the hardware version of AsReader.
Future<string> deviceHardware()
Return value¶
type |
Description *-Future<string> |
AsReader hardware version |
2.109. deviceID¶
Get the ID of AsReader.
Future<string> deviceID()
Return value¶
type |
Description |
Future<string> |
ID of AsReader |
2.110. deviceManufacturer¶
Get AsReader manufacturer information.
Future<string> deviceManufacturer()
Return value¶
type |
Description |
Future<string> |
AsReader manufacturer information |
2.111. deviceModelNumber¶
Get the model number of AsReader.
Future<string> deviceModelNumber()
Return value¶
type |
Description |
Future<string> |
AsReader model number |
2.112. deviceSerialNumber¶
Get the AsReader serial number.
Future<string> deviceSerialNumber()
Return value¶
type |
Description |
Future<string> |
AsReader serial number |
2.113. deviceProtocol¶
Gets the AsReader protocol.
Future<string> deviceProtocol()
Return value¶
type |
Description |
Future<string> |
AsReader protocol |
2.114. currentSelectDevice¶
Get the selected AsReader.
Future<int> currentSelectDevice()
Return value¶
type |
Description |
Future<int> |
Selected AsReader |
2.115. isPowerOn¶
Get power status.
Future<bool> isPowerOn()
Return value¶
type |
Description |
Future<bool> |
Power status
|
2.116. supportMode¶
Get the supported modes.
Future<int> supportMode()
Return value¶
type |
Description |
Future<int> |
Supported modes |
2.117. currentReaderMode¶
Get the current mode.
Future<int> currentReaderMode()
Return value¶
type |
Description *-Future<int> |
Current mode |
2.118. receiveDataType¶
Gets the AsReader type.
Future<int> receiveDataType()
Return value¶
type |
Description |
Future<int> |
AsReader type:
|
2.119. dualSameTime¶
Gets whether DUAL mode is supported.
Future<bool> dualSameTime()
Return value¶
type |
Description |
Future<bool> |
true: on
|
2.120. isBeep¶
Get the beep status.
Future<bool> isBeep()
Return value¶
type |
Description |
Future<bool> |
Peep status
|
2.121. isVibration¶
Get the vibration status.
Future<bool> isVibration()
Return value¶
type |
Description |
Future<bool> |
Vibration status
|
2.122. isLED¶
Get the LED status.
Future<bool> isLED()
Return value¶
type |
Description |
Future<bool> |
LED status
|
2.123. isIllumination¶
Get the illumination status.
Future<bool> isIllumination()
Return value¶
type |
Description |
Future<bool> |
illumination
|
2.124. count¶
Future<int> count()
Get the maximum number of RF tags to read.
Return value¶
type |
Description |
Future<int> |
Maximum number of RF tags to read |
2.125. scanTime¶
Get the maximum reading time.
Future<int> scanTime()
Return value¶
type |
Description |
Future<int> |
Maximum time for reading |
2.126. cycle¶
Gets the number of read repetitions.
Future<int> cycle()
Return value¶
type |
Description |
Future<int> |
Number of read repetitions |
2.127. isTriggerModeDefault¶
Gets the trigger mode of AsReader.
Future<bool> isTriggerModeDefault()
Return value¶
type |
Description *-Future<bool> |
Trigger mode
|
2.128. isReadRSSIMode¶
Gets the setting of whether to read RSSI values.
Future<bool> isReadRSSIMode()
Return value¶
type |
Description |
Future<bool> |
Whether to read the RSSI value of the RF tag
|
2.129. isEnginePowerAlwaysOn¶
If the connected AsReader is a model that automatically turns on the power, it will get On. (For M24D, always on)
Future<bool> isEnginePowerAlwaysOn()
Return value¶
type |
Description |
Future<bool> |
true: on
|
2.130. barcodeEngineType¶
Get the type of barcodeEngineType.
Future<int> barcodeEngineType()
Return value¶
type |
Description |
Future<int> |
type of barcodeEngineType |
2.131. carrierSenseTime¶
Get career sense time.
Future<int> carrierSenseTime()
Return value¶
type |
Description |
Future<int> |
Career sense time |
2.132. targetRFPowerLevel¶
Get the target RF power level.
Future<int> targetRFPowerLevel()
Return value¶
type |
Description |
Future<int> |
Target RF power level |
2.133. isSmartHopping¶
Get hopping mode.
Future<bool> isSmartHopping()
Return value¶
type |
Description |
Future<bool> |
Hopping mode
|
2.134. rfidPower¶
Get the current power.
Future<double> rfidPower()
Return value¶
type |
Description |
Future<double> |
Current power |
2.135. rfidPowerMax¶
Get maximum power.
Future<double> rfidPowerMax()
Return value¶
2.136. rfidPowerMin¶
Get the minimum power.
Future<double> rfidPowerMin()
Return value¶
type |
Description |
Future<double> |
minimum power |
2.137. rfidOnTime¶
Get RFID on time.
Future<int> rfidOnTime()
Return value¶
type |
Description |
Future<int> |
RFID on time |
2.138. rfidOffTime¶
Get RFID off time.
Future<int> rfidOffTime()
Return value¶
type |
Description |
Future<int> |
RFID off time |
2.139. rfidChannel¶
Get RFID channel.
Future<int> rfidChannel()
Return value¶
type |
Description |
Future<int> |
RFID channel |
2.140. rfidListenBeforeTalk¶
Get LBT.
Future<int> rfidListenBeforeTalk()
Return value¶
type |
Description *-Future<int> |
L.B.T. |
2.141. rfidFrequencyHopping¶
Get RFID hopping.
Future<int> rfidFrequencyHopping()
Return value¶
type |
Description |
Future<int> |
RFID hopping |
2.142. rfidContinuousWave¶
Obtain continuous scans of RF tags.
Future<int> rfidContinuousWave()
Return value¶
type |
Description |
Future<int> |
RF tag continuous scanning |
2.143. rfidModuleVersion¶
Get the RFID module version.
Future<string> rfidModuleVersion()
Return value¶
type |
Description |
Future<string> |
RFID module version |
2.144. isSupportType¶
Gets whether AsReader supports the entered module type.
Future<bool> isSupportType(int supportType)
Parameters¶
argument name |
type |
Description |
supportType |
int |
-1:SupportTypeNone
|
Return value¶
type |
Description |
Future<bool> |
Whether to support the input module type
|
2.145. setConnectionType¶
Set the connection method.
Future<bool> setConnectionType(int type)
Parameters¶
argument name |
type |
Description |
type |
int |
0: ConnectionTypeUSB
|
Return value¶
type |
Description |
Future<bool> |
Method execution result
|
2.146. getConnectionType¶
Get the connection method.
Future<int> getConnectionType()
Return value¶
type |
Description |
Future<int> |
0: ConnectionTypeUSB
|
2.147. getSupportTypeArray¶
Gets the module type array supported by AsReader.
Future<list<int>> getSupportTypeArray()
Return value¶
type |
Description |
Future<list |
Supported module type array |
2.148. parseDataByProtocolType¶
Analyze the data read by L70D.
Future<map<string,string>> parseDataByProtocolType(Uint8List data,int type)
Parameters¶
argument name |
type |
Description |
data |
Uint8List |
data |
type |
int |
Fixed value: 0 |
Return value¶
type |
Description |
Future<map<string,string>> |
The return value type is Map, and the key value is as follows.
|
2.149. setDelayDisconnectOnBackground¶
Set the time after the app is put in the background until it disconnects from AsReader.
Future<void> setDelayDisconnectOnBackground(double time)
Parameters¶
argument name |
type |
Description |
time |
double |
Time to disconnect |
2.150. getAutoOffTime¶
Set the automatic off time for AsReader. After executing this method, receive AsReader’s automatic off time using the callback method DID_GET_AUTO_OFF_TIME_RECEIVED.
⚠️ Attention This feature is only supported by some modelssuch as ASR-M30S, ASR-025S.
Future<bool> getAutoOffTime()
Return value¶
type |
Description |
Future<bool> |
Method execution result
|
2.151. setAutoOffTime¶
Set the automatic off time for AsReader. After executing this method, you will receive the AsReader automatic off time set in the callback method DID_SET_AUTO_OFF_TIME.
⚠️ Attention This feature is only supported by some modelssuch as ASR-M30S, ASR-025S.
Future<bool> setAutoOffTime(int time)
Parameters¶
argument name |
type |
Description |
time |
int |
Auto off time (0~1800s) 0: Do not turn off automatically |
Return value¶
type |
Description *-Future<bool> |
Method execution result
|
2.152. getContinuousMode¶
Gets whether AsReader is in continuous scan mode. When you run this method, you will be notified whether the AsReader is in continuous scan mode through the callback method DID_GET_CONTINUOUS_MODE_RECEIVED.
⚠️ Attention This feature is only supported by some modelssuch as ASR-M30S.
Future<bool> getContinuousMode()
Return value¶
type |
Description |
Future<bool> |
Method execution result
|
2.153. setContinuousMode¶
Sets whether AsReader operates in continuous scan mode. When this method is executed, the continuous scan setting result will be notified through the callback method DID_SET_CONTINUOUS_MODE.
⚠️ Attention This feature is only supported by some modelssuch as ASR-M30S.
Future<bool> setContinuousMode(bool isContinuousMode)
Parameters¶
argument name |
type |
Description |
isContinuousMode |
bool |
true: continuous scan false: single scan |
Return value¶
type |
Description |
Future<bool> |
Method execution result
|
2.154. getHidMode¶
Gets whether it is HID mode. When you run this method, you will be notified whether the AsReader is in HID mode through the callback method DID_GET_HID_MODE_RECEIVED.
⚠️ Attention This feature is only supported by some modelssuch as ASR-M30S.
Future<bool> getHidMode()
Return value¶
type |
Description *-Future<bool> |
Method execution result
|
2.155. setHidMode¶
Set HID mode. When this method is executed, the HID mode setting result of AsReader will be notified through the callback method DID_SET_HID_MODE.
⚠️ Attention This feature is only supported by some modelssuch as ASR-M30S.
Future<bool> setHidMode(bool hidMode)
Parameters¶
argument name |
type |
Description |
hidMode |
bool |
true: HID mode false: not HID mode |
Return value¶
type |
Description |
Future<bool> |
Method execution result
|
2.156. getQValue¶
Get the Q value. After executing this method, receive the Q value of AsReader using the callback method DID_GET_Q_VALUE_RECEIVED.
⚠️ Attention This feature is only supported by some modelssuch as ASR-M30S.
Future<bool>getQValue()
Return value¶
type |
Description |
Future<bool> |
Method execution result
|
2.157. setQValue¶
Set the Q value. After executing this method, you will receive the Q value set in the callback method DID_SET_Q_VALUE.
⚠️ Attention This feature is only supported by some modelssuch as ASR-M30S.
Future<bool> setQValue(int value)
Parameters¶
argument name |
type |
Description |
value |
int |
Q |
Return value¶
type |
Description |
Future<bool> |
Method execution result
|
2.158. getSessionFlag¶
Get SessionFlag. After executing this method, receive AsReader’s SessionFlag using the callback method DID_GET_SESSION_FLAG_RECEIVED.
⚠️ Attention This feature is only supported by some modelssuch as ASR-M30S.
Future<bool> getSessionFlag()
Return value¶
type |
Description |
Future<bool> |
Method execution result
|
2.159. setSessionFlag¶
Set SessionFlag. After executing this method, receive the SessionFlag setting result using the callback method DID_SET_SESSION_FLAG.
⚠️ Attention This feature is only supported by some modelssuch as ASR-M30S.
Future<bool> setSessionFlag(int sessionFlag)
Parameters¶
argument name |
type |
Description |
sessionFlag |
int |
SessionFlag |
Return value¶
type |
Description |
Future<bool> |
Method execution result
|
2.160. getDutyRatio¶
Get the duty ratio. After executing this method, receive the AsReader duty ratio using the callback method DID_GET_DUTY_RATIO_RECEIVED.
⚠️ Attention This feature is only supported by some modelssuch as ASR-M30S.
Future<bool> getDutyRatio()
Return value¶
type |
Description |
Future<bool> |
Method execution result
|
2.161. setDutyRatio¶
Set the duty ratio.
Range: 0-15 0: Full load; 1: 5%; 2: 10%; 3: 15%; 4: 20%; 5: 25%; 6: 30%; 7: 35%; 8: 40%; 9: 45%; 10: 50%; 11: 55%; 12: 60%; 13: 70%; 14: 80%; 15: 90% *Example: 5% means stopping for 5%. After executing this method, receive the duty ratio setting result using the callback method DID_SET_DUTY_RATIO.
⚠️ Attention This feature is only supported by some modelssuch as ASR-M30S.
Future<bool> setDutyRatio(int dutyRatio)
Parameters¶
argument name |
type |
Description |
dutyRatio |
int |
Duty ratio |
Return value¶
type |
Description |
Future<bool> |
Method execution result
|
2.162. getDutyRatioBaseTime¶
Get the duty ratio reference time. After executing this method, receive the duty ratio reference time using the callback method DID_GET_DUTY_RATIO_BASE_TIME_RECEIVED.
⚠️ Attention This feature is only supported by some modelssuch as ASR-M30S.
Future<bool> getDutyRatioBaseTime()
Return value¶
type |
Description *-Future<bool> |
Method execution result
|
2.163. setDutyRatioBaseTime¶
Set the duty ratio reference time. After executing this method, you will receive the duty ratio reference time setting result using the callback method DID_SET_DUTY_RATIO_BASE_TIME.
⚠️ Attention This feature is only supported by some modelssuch as ASR-M30S.
Future<bool> setDutyRatioBaseTime(int dutyRatioBaseTime)
Parameters¶
Return value¶
type |
Description |
Future<bool> |
Method execution result
|
2.164. getSleepBuzzer¶
Gets the buzzer when auto-off. After executing this method, you will receive the buzzer for auto-off using the callback method DID_GET_SLEEP_BUZZER_RECEIVED.
⚠️ Attention This feature is only supported by some modelssuch as ASR-025S.
Future<bool> getSleepBuzzer()
Return value¶
2.165. setSleepBuzzer¶
Set the buzzer for auto-off. After executing this method, receive the buzzer setting results for auto-off using the callback method DID_SET_SLEEP_BUZZER.
⚠️ Attention This feature is only supported by some modelssuch as ASR-025S.
Future<bool> setSleepBuzzer(bool sleepBuzzer)
Parameters¶
Return value¶
type |
Description |
Future<bool> |
Method execution result
|
2.166. getBarcodeTimeOut¶
Gets the barcode scanning timeout time of AsReader. When you run this method, you can receive the AsReader’s barcode scanning timeout time in the callback method DID_GET_BARCODE_TIME_OUT_RECEIVED.
⚠️ Attention This feature is only supported by some modelssuch as ASR-025S.
Future<bool> getBarcodeTimeOut()
Return value¶
type |
Description |
Future<bool> |
Method execution result
|
2.167. setBarcodeTimeOut¶
Set the timeout period for AsReader barcode scanning. After executing this method, you can receive the result of the set timeout time in the callback method DID_SET_BARCODE_TIME_OUT.
⚠️ Attention This feature is only supported by some modelssuch as ASR-025S.
Future<bool> setBarcodeTimeOut(int timeout)
Parameters¶
argument name |
type |
Description |
timeout |
int |
Scan timeout time (4~300s) |
Return value¶
type |
Description |
Future<bool> |
Method execution result
|