@kduma-autoid/capacitor-sunmi-scanhead
Sunmi Scan Head bindings for Capacitor
npm install @kduma-autoid/capacitor-sunmi-scanhead
npx cap sync
You can disable auto binding of the service by setting bindOnLoad
to false
in the plugin configuration in capacitor.config.ts
.
/// <reference types="@kduma-autoid/capacitor-sunmi-scanhead" />
import { CapacitorConfig } from '@capacitor/cli';
const config: CapacitorConfig = {
appId: "com.company.app",
...
plugins: {
SunmiScanHead: {
bindOnLoad: true
}
}
}
export default config;
bindService() => Promise<void>
bind scan service
unBindService() => Promise<void>
unbind scan service
Start scanner
Stop scanner
getScannerModel() => Promise<GetScannerModelResponse>
Get scanner model
Returns: Promise<GetScannerModelResponse>
clearConfig() => Promise<ClearConfigResponse>
Clear scanner configuration (reset to default)
Returns: Promise<ClearConfigResponse>
setTrigger(options?: SetTriggerOptions | undefined) => Promise<void>
Enable or disable trigger button
Play a beep sound
vibrate() => Promise<void>
Vibrate
createWriteContext(options?: CreateWriteContextOptions | undefined) => Promise<void>
Prepares transaction for writing settings to scanner
commitWriteContext() => Promise<void>
Write settings to scanner
discardWriteContext() => Promise<void>
Discard transaction for writing settings to scanner
getOutputType() => Promise<GetOutputTypeResponse>
Gets current output mode
Returns: Promise<GetOutputTypeResponse>
setOutputType(options: SetOutputTypeOptions) => Promise<void>
Set output mode
getTriggerMethod() => Promise<GetTriggerMethodResponse>
Gets current scan mode
Returns: Promise<GetTriggerMethodResponse>
setTriggerMethod(options: SetTriggerMethodOptions) => Promise<void>
Set scan mode
getScanResultCodeID() => Promise<GetScanResultCodeIDResponse>
Gets current variant of code type returned with scan result
Returns: Promise<GetScanResultCodeIDResponse>
setScanResultCodeID(options?: SetScanResultCodeIDOptions | undefined) => Promise<void>
Selects variant of code type returned with scan result
isAdvancedFormatEnabled()
isAdvancedFormatEnabled() => Promise<IsAdvancedFormatEnabledResponse>
Checks if advanced formatting options provided in configuration are enabled
Returns: Promise<IsAdvancedFormatEnabledResponse>
setAdvancedFormatEnabled(...)
setAdvancedFormatEnabled(options?: SetAdvancedFormatEnabledOptions | undefined) => Promise<void>
Enable or disable advanced formatting options provided in configuration
getAdvancedFormats() => Promise<GetAdvancedFormatEnabledResponse>
Gets advanced formatting options (character replacement arrays) provided in configuration
Returns: Promise<GetAdvancedFormatEnabledResponse>
setAdvancedFormats(options: SetAdvancedFormatOptions) => Promise<void>
Sets advanced formatting options (character replacement arrays) provided in configuration
clearAdvancedFormats() => Promise<void>
Clears all advanced formatting options
addAdvancedFormat(options: AddAdvancedFormatOptions) => Promise<void>
Adds new advanced formatting option
updateAdvancedFormat(...)
updateAdvancedFormat(options: UpdateAdvancedFormatOptions) => Promise<void>
Updates advanced formatting option
removeAdvancedFormat(...)
removeAdvancedFormat(options: RemoveAdvancedFormatOptions) => Promise<void>
Removes advanced formatting option
isBeep() => Promise<IsBeepResponse>
Checks if sound prompts on scan are enabled
Returns: Promise<IsBeepResponse>
setBeep(options?: SetBeepOptions | undefined) => Promise<void>
Enable or disable sound prompts on scan
isVibrate() => Promise<IsVibrateResponse>
Checks if vibration prompts on scan are enabled
Returns: Promise<IsVibrateResponse>
setVibrate(options?: SetVibrateOptions | undefined) => Promise<void>
Enable or disable vibration prompts on scan
isOutputBroadcastEnabled()
isOutputBroadcastEnabled() => Promise<IsOutputBroadcastEnableResponse>
Checks if scan result broadcast is enabled
Returns: Promise<IsOutputBroadcastEnableResponse>
setOutputBroadcastEnabled(...)
setOutputBroadcastEnabled(options?: SetOutputBroadcastEnabledOutput | undefined) => Promise<void>
Enable or disable scan result broadcast
getBroadcastConfiguration()
getBroadcastConfiguration() => Promise<GetBroadcastConfigurationResponse>
Get broadcast configuration
Warning: This method only reads what you have wrote to write context, as there is no way to read those settings from system at this moment (If you know how, please make a PR)
Returns: Promise<GetBroadcastConfigurationResponse>
setBroadcastConfiguration(...)
setBroadcastConfiguration(options?: SetBroadcastConfigurationOptions | undefined) => Promise<void>
Set broadcast configuration
getOutputEncodingCode() => Promise<GetOutputEncodingCodeResponse>
Get current output encoding/character set setting
Returns: Promise<GetOutputEncodingCodeResponse>
setOutputEncodingCode(...)
setOutputEncodingCode(options?: SetOutputEncodingCodeOptions | undefined) => Promise<void>
Set output encoding/character set setting
isVirtualFloatingScanButton()
isVirtualFloatingScanButton() => Promise<IsVirtualFloatingScanButtonResponse>
Checks if virtual floating scan button is enabled
Returns: Promise<IsVirtualFloatingScanButtonResponse>
setVirtualFloatingScanButton(...)
setVirtualFloatingScanButton(options?: SetVirtualFloatingScanButtonOptions | undefined) => Promise<void>
Enable or disable the virtual floating scan button
getCenterFlagScan() => Promise<GetCenterFlagScanResponse>
Gets current center point decoding mode
Returns: Promise<GetCenterFlagScanResponse>
setCenterFlagScan(options?: SetCenterFlagScanOptions | undefined) => Promise<void>
Sets center point decoding mode
isFlash() => Promise<IsFlashResponse>
Checks if scanner illumination is enabled
Returns: Promise<IsFlashResponse>
setFlash(options?: SetFlashOptions | undefined) => Promise<void>
Controls scanner illumination
Hardware support limited
getScene() => Promise<GetSceneResponse>
Gets current scanning scene preset
Returns: Promise<GetSceneResponse>
setScene(options?: SetSceneOptions | undefined) => Promise<void>
Sets scanning scene preset
Hardware support limited
isRemoveGroupSeparator() => Promise<IsRemoveGroupSeparatorResponse>
Checks if the removal of group separator characters is enabled
Returns: Promise<IsRemoveGroupSeparatorResponse>
setRemoveGroupSeparator(...)
setRemoveGroupSeparator(options?: SetRemoveGroupSeparatorOptions | undefined) => Promise<void>
Enables or disables the removal of group separator characters
Hardware support limited
getPrefix() => Promise<GetPrefixResponse>
Gets the prefix which is prepended to the barcode data
Returns: Promise<GetPrefixResponse>
setPrefix(options?: SetPrefixOptions | undefined) => Promise<void>
Sets the prefix to be prepended to the barcode data
getPrefixCharactersRemoved()
getPrefixCharactersRemoved() => Promise<GetPrefixCharactersRemovedResponse>
Gets the number of characters which are removed from the beginning of the barcode data
Returns: Promise<GetPrefixCharactersRemovedResponse>
setPrefixCharactersRemoved(...)
setPrefixCharactersRemoved(options?: SetPrefixCharactersRemovedOptions | undefined) => Promise<void>
Sets the prefix characters to be removed from the barcode data
Hardware support limited
getSuffix() => Promise<GetSuffixResponse>
Gets the suffix which is appended to the barcode data
Returns: Promise<GetSuffixResponse>
setSuffix(options?: SetSuffixOptions | undefined) => Promise<void>
Sets the suffix to be appended to the barcode data
getSuffixCharactersRemoved()
getSuffixCharactersRemoved() => Promise<GetSuffixCharactersRemovedResponse>
Gets the number of characters which are removed from the end of the barcode data
Returns: Promise<GetSuffixCharactersRemovedResponse>
setSuffixCharactersRemoved(...)
setSuffixCharactersRemoved(options?: SetSuffixCharactersRemovedOptions | undefined) => Promise<void>
Sets the suffix characters to be removed from the barcode data
Hardware support limited
getBarcodesList() => Promise<GetBarcodesListResponse>
Gets the list of barcodes, and its statuses.
Returns: Promise<GetBarcodesListResponse>
getBarcode(options: GetBarcodeOptions) => Promise<GetBarcodeResponse>
Gets the status of a barcode
Returns: Promise<GetBarcodeResponse>
setBarcode(options: SetBarcodeOptions) => Promise<void>
Sets the status of a barcode
getBarcodeConfig(options: GetBarcodeConfigOptions) => Promise<GetBarcodeConfigResponse>
Gets the configuration of a barcode symbology
Returns: Promise<GetBarcodeConfigResponse>
getCheckCharMode(options: GetCheckCharModeOptions) => Promise<GetCheckCharModeResponse>
Returns: Promise<GetCheckCharModeResponse>
setCheckCharMode(options: SetCheckCharModeOptions) => Promise<void>
getCheckCharType(options: GetCheckCharTypeOptions) => Promise<GetCheckCharTypeResponse>
Returns: Promise<GetCheckCharTypeResponse>
setCheckCharType(options: SetCheckCharTypeOptions) => Promise<void>
getDoubleCode(options: GetDoubleCodeOptions) => Promise<GetDoubleCodeResponse>
Returns: Promise<GetDoubleCodeResponse>
setDoubleCode(options: SetDoubleCodeOptions) => Promise<void>
getFormatCode(options: GetFormatCodeOptions) => Promise<GetFormatCodeResponse>
Returns: Promise<GetFormatCodeResponse>
setFormatCode(options: SetFormatCodeOptions) => Promise<void>
getInverseCode(options: GetInverseCodeOptions) => Promise<GetInverseCodeResponse>
Returns: Promise<GetInverseCodeResponse>
setInverseCode(options: SetInverseCodeOptions) => Promise<void>
isExtendCode1(options: IsExtendCode1Options) => Promise<IsExtendCode1Response>
Returns: Promise<IsExtendCode1Response>
setExtendCode1(options: SetExtendCode1Options) => Promise<void>
isExtendCode2(options: IsExtendCode2Options) => Promise<IsExtendCode2Response>
Returns: Promise<IsExtendCode2Response>
setExtendCode2(options: SetExtendCode2Options) => Promise<void>
isExtendToCode(options: IsExtendToCodeOptions) => Promise<IsExtendToCodeResponse>
Returns: Promise<IsExtendToCodeResponse>
setExtendToCode(options: SetExtendToCodeOptions) => Promise<void>
isMicroCode(options: IsMicroCodeOptions) => Promise<IsMicroCodeResponse>
Returns: Promise<IsMicroCodeResponse>
setMicroCode(options: SetMicroCodeOptions) => Promise<void>
isStartEndType(options: IsStartEndTypeOptions) => Promise<IsStartEndTypeResponse>
Returns: Promise<IsStartEndTypeResponse>
setStartEndType(options: SetStartEndTypeOptions) => Promise<void>
isSystemCharZero(options: IsSystemCharZeroOptions) => Promise<IsSystemCharZeroResponse>
Returns: Promise<IsSystemCharZeroResponse>
setSystemCharZero(options: SetSystemCharZeroOptions) => Promise<void>
getMaxLen(options: GetMaxLenOptions) => Promise<GetMaxLenResponse>
Returns: Promise<GetMaxLenResponse>
setMaxLen(options: SetMaxLenOptions) => Promise<void>
getMinLen(options: GetMinLenOptions) => Promise<GetMinLenResponse>
Returns: Promise<GetMinLenResponse>
setMinLen(options: SetMinLenOptions) => Promise<void>
getStartEndFormat(options: GetStartEndFormatOptions) => Promise<GetStartEndFormatResponse>
Returns: Promise<GetStartEndFormatResponse>
setStartEndFormat(options: SetStartEndFormatOptions) => Promise<void>
addListener('onScanResult', ...)
addListener(eventName: 'onScanResult', listenerFunc: OnScanResultListener) => Promise<PluginListenerHandle>
Listens for barcode scanner result events.
Returns: Promise<PluginListenerHandle>
addListener('onScanStart', ...)
addListener(eventName: 'onScanStart', listenerFunc: OnScanStartListener) => Promise<PluginListenerHandle>
Listens for barcode scanner start events.
Returns: Promise<PluginListenerHandle>
addListener('onScanStop', ...)
addListener(eventName: 'onScanStop', listenerFunc: OnScanStopListener) => Promise<PluginListenerHandle>
Listens for barcode scanner stop events.
Returns: Promise<PluginListenerHandle>
removeAllListeners() => Promise<void>
Removes all listeners
Prop |
Type |
Description |
id |
number |
Numeric identifier of the scanner model |
name |
ScannerModelName |
String identifier of the scanner model |
Prop |
Type |
Description |
cleared |
boolean |
Status of the operation |
Prop |
Type |
Description |
Default |
enabled |
boolean |
Enable or disable trigger button |
true |
CreateWriteContextOptions
Prop |
Type |
Description |
Default |
type |
WriteContextType | WriteContextType[] |
Selects write context type you want to create |
[WriteContextType.Service, WriteContextType.Decoders] |
GetOutputTypeDisabledResponse
GetOutputTypeKeystrokeResponse
Prop |
Type |
Description |
mode |
OutputMode.Keystroke |
Virtual Keyboard output |
interval |
number |
Time to sleep between keystrokes |
tab |
boolean |
Send a tab keystroke after the barcode |
enter |
boolean |
Send an enter keystroke after the barcode |
space |
boolean |
Send a space keystroke after the barcode Hardware support limited |
GetOutputTypeDirectFillResponse
Prop |
Type |
Description |
mode |
OutputMode.DirectFill | OutputMode.DirectFillWithReplace |
Fill in EditText directly |
tab |
boolean |
Send a tab keystroke after the barcode |
enter |
boolean |
Send an enter keystroke after the barcode |
space |
boolean |
Send a space keystroke after the barcode Hardware support limited |
asEvent |
boolean |
Convert characters into keys |
SetOutputTypeDisabledOptions
SetOutputTypeKeystrokeOptions
Prop |
Type |
Description |
Default |
mode |
OutputMode.Keystroke |
Virtual Keyboard output |
|
interval |
number |
Time to sleep between keystrokes |
0 |
tab |
boolean |
Send a tab keystroke after the barcode |
false |
enter |
boolean |
Send an enter keystroke after the barcode |
true |
space |
boolean |
Send a space keystroke after the barcode Hardware support limited |
false |
SetOutputTypeDirectFillOptions
Prop |
Type |
Description |
Default |
mode |
OutputMode.DirectFill | OutputMode.DirectFillWithReplace |
Fill in EditText directly |
|
tab |
boolean |
Send a tab keystroke after the barcode |
false |
enter |
boolean |
Send an enter keystroke after the barcode |
true |
space |
boolean |
Send a space keystroke after the barcode Hardware support limited |
false |
asEvent |
boolean |
Convert characters into keys |
false |
GetTriggerMethodTriggerPulseResponse
Prop |
Type |
Description |
mode |
ScanMode.Trigger | ScanMode.Pulse |
|
timeout |
number |
Timeout after which the scanner will stop scanning if no barcode is detected |
GetTriggerMethodContinuousLongPressResponse
Prop |
Type |
Description |
mode |
ScanMode.Continuous | ScanMode.LongPress |
|
timeout |
number |
Timeout after which the scanner will stop scanning if no barcode is detected |
sleep |
number |
Time to sleep between scans |
SetTriggerMethodTriggerPulseOptions
Prop |
Type |
Description |
Default |
mode |
ScanMode.Trigger | ScanMode.Pulse |
|
|
timeout |
number |
Timeout after which the scanner will stop scanning if no barcode is detected |
5000 |
SetTriggerMethodContinuousLongPressOptions
Prop |
Type |
Description |
Default |
mode |
ScanMode.Continuous | ScanMode.LongPress |
|
|
timeout |
number |
Timeout after which the scanner will stop scanning if no barcode is detected |
5000 |
sleep |
number |
Time to sleep between scans |
500 |
GetScanResultCodeIDResponse
Prop |
Type |
Description |
type |
ScanResultCodeIDEnum |
Selects variant of code type returned with scan result |
SetScanResultCodeIDOptions
Prop |
Type |
Description |
Default |
type |
ScanResultCodeIDEnum |
Selects variant of code type returned with scan result |
ScanResultCodeIDEnum.None |
IsAdvancedFormatEnabledResponse
Prop |
Type |
Description |
enabled |
boolean |
Enable or disable advanced formatting options provided in configuration |
SetAdvancedFormatEnabledOptions
Prop |
Type |
Description |
Default |
enabled |
boolean |
Enable or disable advanced formatting options provided in configuration |
true |
GetAdvancedFormatEnabledResponse
Prop |
Type |
Description |
formats |
Map<string, string> |
List of advanced formatting options - characters replacement |
Method |
Signature |
clear |
() => void |
delete |
(key: K) => boolean |
forEach |
(callbackfn: (value: V, key: K, map: Map<K, V>) => void, thisArg?: any) => void |
get |
(key: K) => V | undefined |
has |
(key: K) => boolean |
set |
(key: K, value: V) => this |
Prop |
Type |
Description |
Default |
formats |
Map<string, string> |
List of advanced formatting options - characters replacement |
[] |
Prop |
Type |
Description |
search |
string |
Value to search for |
replacement |
string |
Value to replace with |
UpdateAdvancedFormatOptions
Prop |
Type |
Description |
old_search |
string |
Previous search value |
search |
string |
New search value |
replacement |
string |
Value to replace with |
RemoveAdvancedFormatOptions
Prop |
Type |
Description |
search |
string |
Value to search for |
Prop |
Type |
Description |
enabled |
boolean |
Enable or disable sound prompts on scan |
Prop |
Type |
Description |
Default |
enabled |
boolean |
Enable or disable sound prompts on scan |
true |
Prop |
Type |
Description |
enabled |
boolean |
Enable or disable vibration prompts on scan |
Prop |
Type |
Description |
Default |
enabled |
boolean |
Enable or disable vibration prompts on scan |
true |
IsOutputBroadcastEnableResponse
Prop |
Type |
Description |
enabled |
boolean |
Enable or disable scan result broadcast |
SetOutputBroadcastEnabledOutput
Prop |
Type |
Description |
Default |
enabled |
boolean |
Enable or disable scan result broadcast |
true |
GetBroadcastConfigurationResponse
Prop |
Type |
Description |
scanned_intent |
string |
Intent name broadcasted when a barcode is scanned |
start_intent |
string | false |
Intent name broadcasted when scanner starts scanning Set to false to disable |
end_intent |
string | false |
Intent name broadcasted when scanner stops scanning Set to false to disable |
intent_data_key |
string |
Intent extra key for barcode plain text data in scan result intent (scanned_intent ) |
intent_byte_key |
string |
Intent extra key for barcode base64 encoded data in scan result intent (scanned_intent ) |
SetBroadcastConfigurationOptions
Prop |
Type |
Description |
Default |
scanned_intent |
string |
Intent name broadcasted when a barcode is scanned |
com.sunmi.scanner.ACTION_DATA_CODE_RECEIVED |
start_intent |
string | false |
Intent name broadcasted when scanner starts scanning Set to false to disable |
com.sunmi.scanner.ACTION_SCAN_START |
end_intent |
string | false |
Intent name broadcasted when scanner stops scanning Set to false to disable |
com.sunmi.scanner.ACTION_SCAN_END |
intent_data_key |
string |
Intent extra key for barcode plain text data in scan result intent (scanned_intent ) |
data |
intent_byte_key |
string |
Intent extra key for barcode base64 encoded data in scan result intent (scanned_intent ) |
source_byte |
GetOutputEncodingCodeResponse
SetOutputEncodingCodeOptions
Prop |
Type |
Description |
Default |
encoding |
OutputEncodingCodeEnum |
Set output encoding/character set setting |
OutputEncodingCodeEnum.UTF8 |
IsVirtualFloatingScanButtonResponse
Prop |
Type |
Description |
enabled |
boolean |
Enable or disable virtual floating scan button |
SetVirtualFloatingScanButtonOptions
Prop |
Type |
Description |
Default |
enabled |
boolean |
Enable or disable virtual floating scan button |
true |
GetCenterFlagScanResponse
Prop |
Type |
Description |
Default |
mode |
CenterDecodingSettingEnum |
Selects center point decoding mode |
CenterDecodingSettingEnum.Disabled |
Prop |
Type |
Description |
enabled |
boolean |
Enable or disable scanner illumination |
Prop |
Type |
Description |
Default |
enabled |
boolean |
Enable or disable scanner illumination |
true |
Prop |
Type |
Description |
Default |
scene |
SpecificSceneEnum |
Selects scanning scene preset |
SpecificSceneEnum.Default |
IsRemoveGroupSeparatorResponse
Prop |
Type |
Description |
enabled |
boolean |
Enable or disable the removal of group separator characters |
SetRemoveGroupSeparatorOptions
Prop |
Type |
Description |
Default |
enabled |
boolean |
Enable or disable the removal of group separator characters |
true |
Prop |
Type |
Description |
content |
string | false |
Prefix content to be prepended to the barcode data When set to false , the prefix will be disabled |
Prop |
Type |
Description |
Default |
content |
string | false |
Prefix content to be prepended to the barcode data When set to false , the prefix will be disabled |
false |
GetPrefixCharactersRemovedResponse
Prop |
Type |
Description |
length |
number |
Number of characters to be removed from the beginning of the barcode data |
SetPrefixCharactersRemovedOptions
Prop |
Type |
Description |
Default |
length |
number |
Number of characters to be removed from the beginning of the barcode data |
0 |
Prop |
Type |
Description |
content |
string | false |
Suffix content to be appended to the barcode data When set to false , the suffix will be disabled |
Prop |
Type |
Description |
Default |
content |
string | false |
Suffix content to be appended to the barcode data When set to false , the suffix will be disabled |
false |
GetSuffixCharactersRemovedResponse
Prop |
Type |
Description |
length |
number |
Number of characters to be removed from the end of the barcode data |
SetSuffixCharactersRemovedOptions
Prop |
Type |
Description |
Default |
length |
number |
Number of characters to be removed from the end of the barcode data |
0 |
Prop |
Type |
Description |
list |
Map<string, boolean> |
List of barcodes, and its statuses. Key is barcode symbology name, value is status: true if enabled, false if disabled. |
Prop |
Type |
Description |
enabled |
boolean |
Barcode status |
Prop |
Type |
Description |
name |
string |
Barcode symbology name |
Prop |
Type |
Description |
name |
string |
Barcode symbology name |
enabled |
boolean |
Barcode status |
Prop |
Type |
checkCharMode |
number |
checkCharType |
number |
doubleCode |
number |
formatCode |
number |
inverseCode |
number |
isExtendCode1 |
boolean |
isExtendCode2 |
boolean |
isExtendToCode |
boolean |
isMicroCode |
boolean |
isStartEndType |
boolean |
isSystemCharZero |
boolean |
maxLen |
number |
minLen |
number |
Prop |
Type |
Description |
name |
string |
Barcode symbology name |
Prop |
Type |
Description |
name |
string |
Barcode symbology name |
Prop |
Type |
Description |
name |
string |
Barcode symbology name |
value |
number |
|
Prop |
Type |
Description |
name |
string |
Barcode symbology name |
Prop |
Type |
Description |
name |
string |
Barcode symbology name |
value |
number |
|
Prop |
Type |
Description |
name |
string |
Barcode symbology name |
Prop |
Type |
Description |
name |
string |
Barcode symbology name |
value |
number |
|
Prop |
Type |
Description |
name |
string |
Barcode symbology name |
Prop |
Type |
Description |
name |
string |
Barcode symbology name |
value |
number |
|
Prop |
Type |
Description |
name |
string |
Barcode symbology name |
Prop |
Type |
Description |
name |
string |
Barcode symbology name |
value |
number |
|
Prop |
Type |
Description |
name |
string |
Barcode symbology name |
Prop |
Type |
Description |
name |
string |
Barcode symbology name |
value |
boolean |
|
Prop |
Type |
Description |
name |
string |
Barcode symbology name |
Prop |
Type |
Description |
name |
string |
Barcode symbology name |
value |
boolean |
|
Prop |
Type |
Description |
name |
string |
Barcode symbology name |
Prop |
Type |
Description |
name |
string |
Barcode symbology name |
value |
boolean |
|
Prop |
Type |
Description |
name |
string |
Barcode symbology name |
Prop |
Type |
Description |
name |
string |
Barcode symbology name |
value |
boolean |
|
Prop |
Type |
Description |
name |
string |
Barcode symbology name |
Prop |
Type |
Description |
name |
string |
Barcode symbology name |
value |
boolean |
|
Prop |
Type |
Description |
name |
string |
Barcode symbology name |
Prop |
Type |
Description |
name |
string |
Barcode symbology name |
value |
boolean |
|
Prop |
Type |
Description |
name |
string |
Barcode symbology name |
Prop |
Type |
Description |
name |
string |
Barcode symbology name |
value |
number |
|
Prop |
Type |
Description |
name |
string |
Barcode symbology name |
Prop |
Type |
Description |
name |
string |
Barcode symbology name |
value |
number |
|
GetStartEndFormatResponse
Prop |
Type |
Description |
name |
string |
Barcode symbology name |
Prop |
Type |
Description |
name |
string |
Barcode symbology name |
value |
number |
|
Prop |
Type |
remove |
() => Promise<void> |
ScannerModel | string
GetOutputTypeDisabledResponse | GetOutputTypeKeystrokeResponse | GetOutputTypeDirectFillResponse
SetOutputTypeDisabledOptions | SetOutputTypeKeystrokeOptions | SetOutputTypeDirectFillOptions
GetTriggerMethodTriggerPulseResponse | GetTriggerMethodContinuousLongPressResponse
SetTriggerMethodTriggerPulseOptions | SetTriggerMethodContinuousLongPressOptions
Callback to receive scan results broadcasted by the scanner
(scan: { data: string; source_bytes: string; }): void
Callback to receive scan start event broadcasted by the scanner
(): void
Callback to receive scan stop event broadcasted by the scanner
(): void
Members |
Value |
NONE |
"NONE" |
SUPER_N1365_Y1825 |
"SUPER_N1365_Y1825" |
NLS_2096 |
"NLS_2096" |
ZEBRA_4710 |
"ZEBRA_4710" |
HONEYWELL_3601 |
"HONEYWELL_3601" |
HONEYWELL_6603 |
"HONEYWELL_6603" |
ZEBRA_4750 |
"ZEBRA_4750" |
ZEBRA_1350 |
"ZEBRA_1350" |
HONEYWELL_6703 |
"HONEYWELL_6703" |
HONEYWELL_3603 |
"HONEYWELL_3603" |
NLS_CM47 |
"NLS_CM47" |
NLS_3108 |
"NLS_3108" |
ZEBRA_965 |
"ZEBRA_965" |
SM_SS_1100 |
"SM_SS_1100" |
NLS_CM30 |
"NLS_CM30" |
HONEYWELL_4603 |
"HONEYWELL_4603" |
ZEBRA_4770 |
"ZEBRA_4770" |
NLS_2596 |
"NLS_2596" |
SM_SS_1103 |
"SM_SS_1103" |
SM_SS_1101 |
"SM_SS_1101" |
HONEYWELL_5703 |
"HONEYWELL_5703" |
UNKNOWN |
"UNKNOWN" |
Members |
Value |
Description |
Service |
"service" |
Service write context type, permits reading and writing of scanner related settings |
Decoders |
"decoders" |
Decoder write context type, permits enabling or disabling of barcode symbologies, and changing its settings |
Members |
Value |
Description |
DirectFill |
"direct-fill" |
Fill in EditText directly |
DirectFillWithReplace |
"direct-fill-with-replace" |
Fill and overwrite in EditText directly |
Keystroke |
"keystroke" |
Virtual Keyboard output |
Disabled |
"disabled" |
No direct output |
Members |
Value |
Description |
Trigger |
"trigger" |
Trigger Mode: Short press to scan, and release to stop scanning |
Continuous |
"continuous" |
Continuous Mode: Short press to start scanning, and short press to stop scanning |
Pulse |
"pulse" |
Pulse Mode: Short press to start scanning until timeout |
LongPress |
"long-press" |
Long Press Mode: Long press to scan continuously, release to stop Hardware support limited |
Members |
Value |
Description |
None |
"none" |
|
SunmiId |
"sunmi-id" |
|
AimId |
"aim-id" |
Hardware support limited |
SymbolId |
"symbol-id" |
Hardware support limited |
Members |
Value |
Description |
UTF8 |
"UTF8" |
|
GBK |
"GBK" |
|
ISO88591 |
"ISO88591" |
|
SHIFTJIS |
"SHIFTJIS" |
|
Auto |
"Auto" |
Auto detect encoding/compatibility mode |
WINDOWS1256 |
"WINDOWS1256" |
|
WINDOWS874 |
"WINDOWS874" |
Hardware support limited |
Unicode |
"Unicode" |
Hardware support limited |
Big5 |
"Big5" |
Hardware support limited |
ASCII |
"ASCII" |
Hardware support limited |
GB2312 |
"GB2312" |
Hardware support limited |
GB18030 |
"GB18030" |
Hardware support limited |
CenterDecodingSettingEnum
Members |
Value |
Description |
Disabled |
"disabled" |
|
CenterOnly |
"center-only" |
|
CenterFirst |
"center-first" |
Hardware support limited |
Members |
Value |
Default |
"default" |
ReflectiveDMBarcode |
"reflective-dm-barcode" |
ReflectiveQRDMBarcode |
"reflective-qr-dm-barcode" |
SpecialColourBarcode |
"special-colour-barcode" |
DpmBarcode |
"dpm-barcode" |
MobileScreenScene |
"mobile-screen-scene" |