@kduma-autoid/capacitor-sunmi-scanhead

@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(...)
• setOutputMode(...)
• setScanMode(...)
• setReturnCodeType(...)
• setBroadcast(...)
• setBroadcastConfiguration(...)
• addListener('onScanResult', ...)
• addListener('onScanStart', ...)
• addListener('onScanStop', ...)
• removeAllListeners()
• Interfaces
• 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<{ model: number; }>

Get scanner model ID

Returns: Promise<{ model: number; }>

clearConfig()

clearConfig() => Promise<void>

Clear scanner configuration (reset to default)

setTrigger(...)

setTrigger(options: { enabled: boolean; }) => Promise<void>

Enable or disable trigger button

Param	Type
options	{ enabled: boolean; }

setOutputMode(...)

setOutputMode(options: { mode: OutputMode.DISABLED; } | { mode: OutputMode.KEYSTROKE; interval?: number; tab?: boolean; enter?: boolean; } | { mode: OutputMode.DIRECTFILL; overwrite?: boolean; tab?: boolean; enter?: boolean; asEvent?: boolean; }) => Promise<void>

Set output mode

Param	Type
options	{ mode: OutputMode.DISABLED; } | { mode: OutputMode.KEYSTROKE; interval?: number; tab?: boolean; enter?: boolean; } | { mode: OutputMode.DIRECTFILL; overwrite?: boolean; tab?: boolean; enter?: boolean; asEvent?: boolean; }

setScanMode(...)

setScanMode(options: { mode: ScanMode.TRIGGER | ScanMode.PULSE; timeout?: number; } | { mode: ScanMode.CONTINUOUS | ScanMode.LONGPRESS; sleep?: number; timeout?: number; }) => Promise<void>

Set scan mode

Param	Type
options	{ mode: ScanMode.TRIGGER | ScanMode.PULSE; timeout?: number; } | { mode: ScanMode.CONTINUOUS | ScanMode.LONGPRESS; sleep?: number; timeout?: number; }

setReturnCodeType(...)

setReturnCodeType(options: { enabled: boolean; }) => Promise<void>

Enable or disable returning of code type with scan result

Param	Type
options	{ enabled: boolean; }

setBroadcast(...)

setBroadcast(options: { enabled: boolean; }) => Promise<void>

Enable or disable scan result broadcast

Param	Type
options	{ enabled: boolean; }

setBroadcastConfiguration(...)

setBroadcastConfiguration(options?: { scanned_intent?: string | null | undefined; start_intent?: string | null | undefined; end_intent?: string | null | undefined; intent_data_key?: string | null | undefined; intent_byte_key?: string | null | undefined; } | undefined) => Promise<void>

Set broadcast configuration

Param	Type
options	{ scanned_intent?: string | null; start_intent?: string | null; end_intent?: string | null; intent_data_key?: string | null; intent_byte_key?: string | null; }

addListener('onScanResult', ...)

addListener(eventName: 'onScanResult', listenerFunc: (scan: { data: string; source_bytes: string; }) => void) => Promise<PluginListenerHandle> & PluginListenerHandle

Listens for barcode scanner result events.

Param	Type
eventName	'onScanResult'
listenerFunc	(scan: { data: string; source_bytes: string; }) => void

Returns: Promise<PluginListenerHandle> & PluginListenerHandle

addListener('onScanStart', ...)

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

Listens for barcode scanner start events.

Param	Type
eventName	'onScanStart'
listenerFunc	() => void

Returns: Promise<PluginListenerHandle> & PluginListenerHandle

addListener('onScanStop', ...)

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

Listens for barcode scanner stop events.

Param	Type
eventName	'onScanStop'
listenerFunc	() => void

Returns: Promise<PluginListenerHandle> & PluginListenerHandle

removeAllListeners()

removeAllListeners() => Promise<void>

Removes all listeners

Interfaces

PluginListenerHandle

Prop	Type
remove	() => Promise<void>

Enums

OutputMode

Members	Value
KEYSTROKE	"keystroke"
DIRECTFILL	"directFill"
DISABLED	"disabled"

ScanMode

Members	Value
TRIGGER	"trigger"
CONTINUOUS	"continuous"
PULSE	"pulse"
LONGPRESS	"longPress"