2. Method List¶
2.1. getPlatformVersion¶
Retrieves the platform version.
Future<String?> getPlatformVersion()
Return Value¶
Type |
Description |
Future<String?> |
Platform version |
2.2. getSDKVersion¶
Retrieves the SDK version.
Future<String?> getSDKVersion()
Return Value¶
Type |
Description |
Future<String?> |
SDK version |
2.3. setConnectionType¶
Performs initialization settings based on the connection type.
Future<void> setConnectionType(ConnectionType connectionType)
Parameters¶
Parameter |
Type |
Description |
connectionType |
ConnectionType |
2.4. setLogLevel¶
Sets the log level.
Future<void> setLogLevel(LogLevel logLevel)
Parameters¶
Parameter |
Type |
Description |
logLevel |
LogLevel |
2.5. getLogLevel¶
Retrieves the log level.
Future<LogLevel?> getLogLevel()
Return Value¶
Type |
Description |
Future<LogLevel?> |
Refer to LogLevel |
2.6. setLog¶
Enables or disables log output within the SDK.
Future<void> setLog(bool enable)
Parameters¶
Parameter |
Type |
Description |
enable |
bool |
true: output logs
|
2.7. removeSDKLog¶
Deletes all log files.
Future<void> removeSDKLog()
2.8. enableAutoLaunchApp¶
Sets whether the app should automatically launch when connecting to the M24D.
Future<void> enableAutoLaunchApp(bool enable, String aliasName)
Parameters¶
Parameter |
Type |
Description |
enable |
bool |
Sets whether the demo app automatically launches when connecting to the M24D
|
aliasName |
String |
Activity flag |
2.9. getCharacterStatus¶
Retrieves the decode status.
Future<BarcodeSettings?> getCharacterStatus()
Return Value¶
Type |
Description |
Future<BarcodeSettings?> |
2.10. setDecodeMode¶
Sets the decode mode.
You can set either BarcodeSettings.DECODE_MODE_CONTINUOUS or BarcodeSettings.DECODE_MODE_SINGLE.
Future<void> setDecodeMode(BarcodeSettings mode)
Parameters¶
Parameter |
Type |
Description |
mode |
BarcodeSettings |
2.11. getDecodeMode¶
Retrieves the decode mode.
Future<BarcodeSettings?> getDecodeMode()
Return Value¶
Type |
Description |
Future<BarcodeSettings?> |
2.12. setEncodeMode¶
Sets the encode mode.
Future<void> setEncodeMode(QREncodeMode qrEncodeMode)
Parameters¶
Parameter |
Type |
Description |
qrEncodeMode |
QREncodeMode |
2.13. getEncodeMode¶
Retrieves the encode mode.
Future<QREncodeMode?> getEncodeMode()
Return Value¶
Type |
Description |
Future<QREncodeMode?> |
2.14. startDecode¶
Starts decoding.
After executing this method, the scanned data can be received via the callback methods:
ON_RECEIVED_BARCODE_DECODE_DATA
ON_RECEIVED_BARCODE_DECODE_DATA_BYTE.
Future<void> startDecode()
2.15. startDecode¶
Starts decoding.
After executing this method, the scanned data can be received via the callback methods:
ON_RECEIVED_BARCODE_DECODE_DATA
ON_RECEIVED_BARCODE_DECODE_DATA_BYTE.
Future<void> startDecode()
Parameters¶
Parameter |
Type |
Description |
count |
int |
Number of scans (0–255) |
time |
int |
Scan duration (0–255) |
2.16. getStopCondition¶
Retrieves the configured stop condition.
After executing this method, the result can be received via the callback method ON_RECEIVED_RESPONSE.
Future<void> getStopCondition()
2.17. stopDecode¶
Stops decoding.
Future<void> stopDecode()
2.18. factoryDefault¶
Resets the AsReader module to factory default settings.
After executing this method, the result can be received via the callback method ON_RECEIVED_RESPONSE.
Future<void> factoryDefault()
2.19. setBarcodeSettings¶
Sets the barcode configuration.
After executing this method, the result can be received via the callback method ON_RECEIVED_RESPONSE.
Future<void> setBarcodeSettings(MemoryType memoryType, BarcodeSettings settingsType)
Parameters¶
Parameter |
Type |
Description |
memoryType |
MemoryType |
|
settingsType |
BarcodeSettings |
2.20. getBarcodeSettings¶
Retrieves the barcode configuration.
After executing this method, the result can be received via the callback method ON_RECEIVED_RESPONSE.
Future<void> getBarcodeSettings(BarcodeSettings settingsType)
Parameters¶
Parameter |
Type |
Description |
settingsType |
BarcodeSettings |
2.21. setSymbologyAllEnable¶
Sets the On/Off state for all barcode types.
After executing this method, the result can be received via the callback method ON_RECEIVED_RESPONSE.
Future<void> setSymbologyAllEnable(MemoryType memoryType, bool isEnable)
Parameters¶
Parameter |
Type |
Description |
memoryType |
MemoryType |
|
isEnable |
bool |
Turns reading of all barcode types On/Off
|
2.22. setSymbologySettings¶
Sets the On/Off state for the current barcode type.
After executing this method, the result can be received via the callback method ON_RECEIVED_RESPONSE.
Future<void> setSymbologySettings(MemoryType memoryType, Symbology symbology, bool isEnable)
Parameters¶
Parameter |
Type |
Description |
memoryType |
MemoryType |
|
symbology |
Symbology |
|
isEnable |
bool |
Turns reading of the current barcode type On/Off
|
2.23. setSymbologyListSettings¶
Sets the On/Off state for barcode types.
After executing this method, the result can be received via the callback method ON_RECEIVED_RESPONSE.
Future<void> setSymbologyListSettings(MemoryType memoryType, List<SymbologyInfoModel> symbologyInfoList)
Parameters¶
Parameter |
Type |
Description |
memoryType |
MemoryType |
|
symbologyInfoList |
List |
Array of SymbologyInfoModel |
2.24. setOCRSettings¶
Sets whether the specified type of OCR should be read.
Future<void> setOCRSettings(MemoryType memoryType, OCR ocr, bool isEnable)
Parameters¶
Parameter |
Type |
Description |
memoryType |
MemoryType |
|
ocr |
OCR |
|
isEnable |
bool |
Turns reading of the specified OCR type On/Off
|
2.25. setOCRListSettings¶
Sets whether the specified types of OCR should be read.
After executing this method, the result can be received via the callback method ON_RECEIVED_RESPONSE.
Future<void> setOCRListSettings(MemoryType memoryType, List<OCRInfoModel> ocrInfoList)
Parameters¶
Parameter |
Type |
Description |
memoryType |
MemoryType |
|
ocrInfoList |
List |
Array of OCRInfoModel |
2.26. getSymbologySettings¶
Retrieves the current barcode configuration.
After executing this method, the result can be received via the callback method ON_RECEIVED_RESPONSE.
Future<void> getSymbologySettings(Symbology symbology)
Parameters¶
Parameter |
Type |
Description |
symbology |
Symbology |
2.27. getSymbologySettingsList¶
Retrieves barcode configurations.
After executing this method, the result can be received via the callback method ON_RECEIVED_RESPONSE.
Future<void> getSymbologySettingsList(List<Symbology> symbologyList)
Parameters¶
Parameter |
Type |
Description |
symbologyList |
List |
Array of Symbology |
2.28. getOCRSettings¶
Retrieves OCR configuration.
After executing this method, the result can be received via the callback method ON_RECEIVED_RESPONSE.
Future<void> getOCRSettings(OCR ocr)
Parameters¶
Parameter |
Type |
Description |
ocr |
OCR |
2.29. getOCRSettingsList¶
Retrieves OCR configurations.
After executing this method, the result can be received via the callback method ON_RECEIVED_RESPONSE.
Future<void> getOCRSettingsList(List<OCR> ocrList)
Parameters¶
Parameter |
Type |
Description |
ocrList |
List |
Array of OCR |
2.30. getSystemBeep¶
Retrieves the type of beep sound.
Future<SystemBeepSoundType?> getSystemBeep()
Return Value¶
Type |
Description |
Future<SystemBeepSoundType?> |
2.31. getNotisEditing¶
Retrieves the Notis editing configuration.
After executing this method, the result can be received via the callback method ON_RECEIVED_RESPONSE.
Future<void> getNotisEditing()
2.32. setNotisEditing¶
Sets On/Off for Notis editing.
Future<void> setNotisEditing(MemoryType memoryType, bool isEnabled)
Parameters¶
Parameter |
Type |
Description |
memoryType |
MemoryType |
|
isEnabled |
bool |
Turns Notis editing On/Off
|
2.33. setPresentationMode¶
Sets the trigger key mode.
TRIGGER_PRESENTATION: Presentation mode enabled
TRIGGER_STANDARD: Presentation mode disabled
Future<void> setPresentationMode(MemoryType memoryType, BarcodeSettings settingsType)
Parameters¶
Parameter |
Type |
Description |
memoryType |
MemoryType |
|
settingsType |
BarcodeSettings |
2.34. getPresentationMode¶
Retrieves the configured trigger key mode.
After executing this method, the result can be received via the callback method ON_RECEIVED_RESPONSE.
Future<void> getPresentationMode()
2.35. isConnected¶
Retrieves the connection status.
Future<bool?> isConnected()
Return Value¶
Type |
Description |
Future<bool?> |
Connection status |
2.36. setTriggerMode¶
Sets the trigger mode.
Future<void> setTriggerMode(TriggerMode mode)
Parameters¶
Parameter |
Type |
Description |
mode |
TriggerMode |
2.37. getTriggerMode¶
Retrieves the trigger mode.
Future<TriggerMode?> getTriggerMode()
Return Value¶
Type |
Description |
Future<TriggerMode?> |
2.38. isOpen¶
Retrieves the connection session status.
Future<bool?> isOpen()
Return Value¶
Type |
Description |
Future<bool?> |
Connection session status
|
2.39. open¶
Opens the connection session.
Future<void> open()
2.40. close¶
Turns off the connection session.
Future<void> close()
2.41. setReaderSettings¶
Sets the following parameters on the AsReader:
Future<void> setReaderSettings(bool beep, bool vib, bool aimer, bool led, bool powerOnBeep)
Parameters¶
Parameter |
Type |
Description |
beep |
bool |
Beep
|
vib |
bool |
Vibration
|
aimer |
bool |
Aiming
|
led |
bool |
Light
|
powerOnBeep |
bool |
Power-On Beep
|
2.42. getReaderSettings¶
Retrieves the AsReader settings.
After executing this method, the result can be received via the callback method ON_READER_SETTING_RECEIVED.
Future<void> getReaderSettings()
2.43. getReaderInfo¶
Retrieves information about the AsReader.
After executing this method, the information can be received via the callback method ON_READER_INFO_RECEIVED.
Future<void> getReaderInfo()
2.44. setSleepTime¶
Sets the sleep time.
Future<void> setSleepTime(int sleepTime)
Parameters¶
Parameter |
Type |
Description |
sleepTime |
int |
Sleep time range: 1–255 (minutes), 0: No sleep |
2.45. getSleepTime¶
Retrieves the sleep time.
After executing this method, the information can be received via the callback method ON_SLEEP_SETTING_RECEIVED.
Future<void> getSleepTime()
2.46. setSleepBeep¶
Sets whether the sleep feature should be used.
Future<void> setSleepBeep(bool isSleepBeepOn)
Parameters¶
Parameter |
Type |
Description |
isSleepBeepOn |
bool |
Turns sleep feature On/Off
|
2.47. getSleepBeep¶
Retrieves the sleep time and sleep feature settings.
After executing this method, the information can be received via the callback method ON_SLEEP_SETTING_RECEIVED.
Future<void> getSleepBeep()
2.48. setSleepTimeAndBeep¶
Sets the sleep time and whether the sleep feature should be used.
Future<void> setSleepTimeAndBeep(int sleepTime, bool isSleepBeepOn)
Parameters¶
Parameter |
Type |
Description |
sleepTime |
int |
Sleep time |
isSleepBeepOn |
bool |
Turns the sleep feature On/Off
|
2.49. getSleepTimeAndBeep¶
Retrieves the sleep time and sleep feature settings.
After executing this method, the information can be received via the callback method ON_SLEEP_SETTING_RECEIVED.
Future<void> getSleepTimeAndBeep()
2.50. setHIDMode¶
Sets whether to use HID mode.
Future<void> setHIDMode(HIDType hidMode)
Parameters¶
Parameter |
Type |
Description |
hidMode |
HIDType |
2.51. getHIDMode¶
Retrieves whether HID mode is used.
After executing this method, the HID mode information can be received via the callback method ON_HID_MODE_RECEIVED.
Future<void> getHIDMode()