@kduma-autoid/capacitor-sunmi-scanhead v3.1.2

@kduma-autoid/capacitor-sunmi-scanhead

Sunmi Scan Head bindings for Capacitor

Install

npm install @kduma-autoid/capacitor-sunmi-scanhead
npx cap sync

Configuration

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;

API

• bindService()
• unBindService()
• scan()
• stop()
• getScannerModel()
• clearConfig()
• setTrigger(...)
• beep()
• vibrate()
• createWriteContext(...)
• commitWriteContext()
• discardWriteContext()
• getOutputType()
• setOutputType(...)
• getTriggerMethod()
• setTriggerMethod(...)
• getScanResultCodeID()
• setScanResultCodeID(...)
• isAdvancedFormatEnabled()
• setAdvancedFormatEnabled(...)
• getAdvancedFormats()
• setAdvancedFormats(...)
• clearAdvancedFormats()
• addAdvancedFormat(...)
• updateAdvancedFormat(...)
• removeAdvancedFormat(...)
• isBeep()
• setBeep(...)
• isVibrate()
• setVibrate(...)
• isOutputBroadcastEnabled()
• setOutputBroadcastEnabled(...)
• getBroadcastConfiguration()
• setBroadcastConfiguration(...)
• getOutputEncodingCode()
• setOutputEncodingCode(...)
• isVirtualFloatingScanButton()
• setVirtualFloatingScanButton(...)
• getCenterFlagScan()
• setCenterFlagScan(...)
• isFlash()
• setFlash(...)
• getScene()
• setScene(...)
• isRemoveGroupSeparator()
• setRemoveGroupSeparator(...)
• getPrefix()
• setPrefix(...)
• getPrefixCharactersRemoved()
• setPrefixCharactersRemoved(...)
• getSuffix()
• setSuffix(...)
• getSuffixCharactersRemoved()
• setSuffixCharactersRemoved(...)
• getBarcodesList()
• getBarcode(...)
• setBarcode(...)
• getBarcodeConfig(...)
• getCheckCharMode(...)
• setCheckCharMode(...)
• getCheckCharType(...)
• setCheckCharType(...)
• getDoubleCode(...)
• setDoubleCode(...)
• getFormatCode(...)
• setFormatCode(...)
• getInverseCode(...)
• setInverseCode(...)
• isExtendCode1(...)
• setExtendCode1(...)
• isExtendCode2(...)
• setExtendCode2(...)
• isExtendToCode(...)
• setExtendToCode(...)
• isMicroCode(...)
• setMicroCode(...)
• isStartEndType(...)
• setStartEndType(...)
• isSystemCharZero(...)
• setSystemCharZero(...)
• getMaxLen(...)
• setMaxLen(...)
• getMinLen(...)
• setMinLen(...)
• getStartEndFormat(...)
• setStartEndFormat(...)
• addListener('onScanResult', ...)
• addListener('onScanStart', ...)
• addListener('onScanStop', ...)
• removeAllListeners()
• Interfaces
• Type Aliases
• Enums

bindService()

bindService() => Promise<void>

bind scan service

unBindService()

unBindService() => Promise<void>

unbind scan service

scan()

scan() => Promise<void>

Start scanner

stop()

stop() => Promise<void>

Stop scanner

getScannerModel()

getScannerModel() => Promise<GetScannerModelResponse>

Get scanner model

Returns: Promise<GetScannerModelResponse>

clearConfig()

clearConfig() => Promise<ClearConfigResponse>

Clear scanner configuration (reset to default)

Returns: Promise<ClearConfigResponse>

setTrigger(...)

setTrigger(options?: SetTriggerOptions | undefined) => Promise<void>

Enable or disable trigger button

beep()

beep() => Promise<void>

Play a beep sound

vibrate()

vibrate() => Promise<void>

Vibrate

createWriteContext(...)

createWriteContext(options?: CreateWriteContextOptions | undefined) => Promise<void>

Prepares transaction for writing settings to scanner

commitWriteContext()

commitWriteContext() => Promise<void>

Write settings to scanner

discardWriteContext()

discardWriteContext() => Promise<void>

Discard transaction for writing settings to scanner

getOutputType()

getOutputType() => Promise<GetOutputTypeResponse>

Gets current output mode

Returns: Promise<GetOutputTypeResponse>

setOutputType(...)

setOutputType(options: SetOutputTypeOptions) => Promise<void>

Set output mode

getTriggerMethod()

getTriggerMethod() => Promise<GetTriggerMethodResponse>

Gets current scan mode

Returns: Promise<GetTriggerMethodResponse>

setTriggerMethod(...)

setTriggerMethod(options: SetTriggerMethodOptions) => Promise<void>

Set scan mode

getScanResultCodeID()

getScanResultCodeID() => Promise<GetScanResultCodeIDResponse>

Gets current variant of code type returned with scan result

Returns: Promise<GetScanResultCodeIDResponse>

setScanResultCodeID(...)

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()

getAdvancedFormats() => Promise<GetAdvancedFormatEnabledResponse>

Gets advanced formatting options (character replacement arrays) provided in configuration

Returns: Promise<GetAdvancedFormatEnabledResponse>

setAdvancedFormats(...)

setAdvancedFormats(options: SetAdvancedFormatOptions) => Promise<void>

Sets advanced formatting options (character replacement arrays) provided in configuration

clearAdvancedFormats()

clearAdvancedFormats() => Promise<void>

Clears all advanced formatting options

addAdvancedFormat(...)

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()

isBeep() => Promise<IsBeepResponse>

Checks if sound prompts on scan are enabled

Returns: Promise<IsBeepResponse>

setBeep(...)

setBeep(options?: SetBeepOptions | undefined) => Promise<void>

Enable or disable sound prompts on scan

isVibrate()

isVibrate() => Promise<IsVibrateResponse>

Checks if vibration prompts on scan are enabled

Returns: Promise<IsVibrateResponse>

setVibrate(...)

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()

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()

getCenterFlagScan() => Promise<GetCenterFlagScanResponse>

Gets current center point decoding mode

Returns: Promise<GetCenterFlagScanResponse>

setCenterFlagScan(...)

setCenterFlagScan(options?: SetCenterFlagScanOptions | undefined) => Promise<void>

Sets center point decoding mode

isFlash()

isFlash() => Promise<IsFlashResponse>

Checks if scanner illumination is enabled

Returns: Promise<IsFlashResponse>

setFlash(...)

setFlash(options?: SetFlashOptions | undefined) => Promise<void>

Controls scanner illumination

Hardware support limited

getScene()

getScene() => Promise<GetSceneResponse>

Gets current scanning scene preset

Returns: Promise<GetSceneResponse>

setScene(...)

setScene(options?: SetSceneOptions | undefined) => Promise<void>

Sets scanning scene preset

Hardware support limited

isRemoveGroupSeparator()

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()

getPrefix() => Promise<GetPrefixResponse>

Gets the prefix which is prepended to the barcode data

Returns: Promise<GetPrefixResponse>

setPrefix(...)

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()

getSuffix() => Promise<GetSuffixResponse>

Gets the suffix which is appended to the barcode data

Returns: Promise<GetSuffixResponse>

setSuffix(...)

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()

getBarcodesList() => Promise<GetBarcodesListResponse>

Gets the list of barcodes, and its statuses.

Returns: Promise<GetBarcodesListResponse>

getBarcode(...)

getBarcode(options: GetBarcodeOptions) => Promise<GetBarcodeResponse>

Gets the status of a barcode

Returns: Promise<GetBarcodeResponse>

setBarcode(...)

setBarcode(options: SetBarcodeOptions) => Promise<void>

Sets the status of a barcode

getBarcodeConfig(...)

getBarcodeConfig(options: GetBarcodeConfigOptions) => Promise<GetBarcodeConfigResponse>

Gets the configuration of a barcode symbology

Returns: Promise<GetBarcodeConfigResponse>

getCheckCharMode(...)

getCheckCharMode(options: GetCheckCharModeOptions) => Promise<GetCheckCharModeResponse>

Returns: Promise<GetCheckCharModeResponse>

setCheckCharMode(...)

setCheckCharMode(options: SetCheckCharModeOptions) => Promise<void>

getCheckCharType(...)

getCheckCharType(options: GetCheckCharTypeOptions) => Promise<GetCheckCharTypeResponse>

Returns: Promise<GetCheckCharTypeResponse>

setCheckCharType(...)

setCheckCharType(options: SetCheckCharTypeOptions) => Promise<void>

getDoubleCode(...)

getDoubleCode(options: GetDoubleCodeOptions) => Promise<GetDoubleCodeResponse>

Returns: Promise<GetDoubleCodeResponse>

setDoubleCode(...)

setDoubleCode(options: SetDoubleCodeOptions) => Promise<void>

getFormatCode(...)

getFormatCode(options: GetFormatCodeOptions) => Promise<GetFormatCodeResponse>

Returns: Promise<GetFormatCodeResponse>

setFormatCode(...)

setFormatCode(options: SetFormatCodeOptions) => Promise<void>

getInverseCode(...)

getInverseCode(options: GetInverseCodeOptions) => Promise<GetInverseCodeResponse>

Returns: Promise<GetInverseCodeResponse>

setInverseCode(...)

setInverseCode(options: SetInverseCodeOptions) => Promise<void>

isExtendCode1(...)

isExtendCode1(options: IsExtendCode1Options) => Promise<IsExtendCode1Response>

Returns: Promise<IsExtendCode1Response>

setExtendCode1(...)

setExtendCode1(options: SetExtendCode1Options) => Promise<void>

isExtendCode2(...)

isExtendCode2(options: IsExtendCode2Options) => Promise<IsExtendCode2Response>

Returns: Promise<IsExtendCode2Response>

setExtendCode2(...)

setExtendCode2(options: SetExtendCode2Options) => Promise<void>

isExtendToCode(...)

isExtendToCode(options: IsExtendToCodeOptions) => Promise<IsExtendToCodeResponse>

Returns: Promise<IsExtendToCodeResponse>

setExtendToCode(...)

setExtendToCode(options: SetExtendToCodeOptions) => Promise<void>

isMicroCode(...)

isMicroCode(options: IsMicroCodeOptions) => Promise<IsMicroCodeResponse>

Returns: Promise<IsMicroCodeResponse>

setMicroCode(...)

setMicroCode(options: SetMicroCodeOptions) => Promise<void>

isStartEndType(...)

isStartEndType(options: IsStartEndTypeOptions) => Promise<IsStartEndTypeResponse>

Returns: Promise<IsStartEndTypeResponse>

setStartEndType(...)

setStartEndType(options: SetStartEndTypeOptions) => Promise<void>

isSystemCharZero(...)

isSystemCharZero(options: IsSystemCharZeroOptions) => Promise<IsSystemCharZeroResponse>

Returns: Promise<IsSystemCharZeroResponse>

setSystemCharZero(...)

setSystemCharZero(options: SetSystemCharZeroOptions) => Promise<void>

getMaxLen(...)

getMaxLen(options: GetMaxLenOptions) => Promise<GetMaxLenResponse>

Returns: Promise<GetMaxLenResponse>

setMaxLen(...)

setMaxLen(options: SetMaxLenOptions) => Promise<void>

getMinLen(...)

getMinLen(options: GetMinLenOptions) => Promise<GetMinLenResponse>

Returns: Promise<GetMinLenResponse>

setMinLen(...)

setMinLen(options: SetMinLenOptions) => Promise<void>

getStartEndFormat(...)

getStartEndFormat(options: GetStartEndFormatOptions) => Promise<GetStartEndFormatResponse>

Returns: Promise<GetStartEndFormatResponse>

setStartEndFormat(...)

setStartEndFormat(options: SetStartEndFormatOptions) => Promise<void>

addListener('onScanResult', ...)

addListener(eventName: 'onScanResult', listenerFunc: OnScanResultListener) => Promise<PluginListenerHandle> & PluginListenerHandle

Listens for barcode scanner result events.

Returns: Promise<PluginListenerHandle> & PluginListenerHandle

addListener('onScanStart', ...)

addListener(eventName: 'onScanStart', listenerFunc: OnScanStartListener) => Promise<PluginListenerHandle> & PluginListenerHandle

Listens for barcode scanner start events.

Returns: Promise<PluginListenerHandle> & PluginListenerHandle

addListener('onScanStop', ...)

addListener(eventName: 'onScanStop', listenerFunc: OnScanStopListener) => Promise<PluginListenerHandle> & PluginListenerHandle

Listens for barcode scanner stop events.

Returns: Promise<PluginListenerHandle> & PluginListenerHandle

removeAllListeners()

removeAllListeners() => Promise<void>

Removes all listeners

Interfaces

GetScannerModelResponse

ClearConfigResponse

SetTriggerOptions

CreateWriteContextOptions

GetOutputTypeDisabledResponse

GetOutputTypeKeystrokeResponse

GetOutputTypeDirectFillResponse

SetOutputTypeDisabledOptions

SetOutputTypeKeystrokeOptions

SetOutputTypeDirectFillOptions

GetTriggerMethodTriggerPulseResponse

GetTriggerMethodContinuousLongPressResponse

SetTriggerMethodTriggerPulseOptions

SetTriggerMethodContinuousLongPressOptions

GetScanResultCodeIDResponse

SetScanResultCodeIDOptions

IsAdvancedFormatEnabledResponse

SetAdvancedFormatEnabledOptions

GetAdvancedFormatEnabledResponse

Map

SetAdvancedFormatOptions

AddAdvancedFormatOptions

UpdateAdvancedFormatOptions

RemoveAdvancedFormatOptions

IsBeepResponse

SetBeepOptions

IsVibrateResponse

SetVibrateOptions

IsOutputBroadcastEnableResponse

SetOutputBroadcastEnabledOutput

GetBroadcastConfigurationResponse

SetBroadcastConfigurationOptions

GetOutputEncodingCodeResponse

SetOutputEncodingCodeOptions

IsVirtualFloatingScanButtonResponse

SetVirtualFloatingScanButtonOptions

GetCenterFlagScanResponse

SetCenterFlagScanOptions

IsFlashResponse