@sstscode/ezware

EZWare device driver module for SSTS system

Installation

npm install @sstscode/ezware

Usage

import { useEZWare } from '@sstscode/ezware'
import type { EventFunctionType, EventResultType } from '@sstscode/ezware'

// Define your event handlers
const globalEventFunction: EventFunctionType = (event) => {
  console.log('Event received:', event)
}

const globalEventResult: EventResultType = (result) => {
  console.log('Result received:', result)
}

// Initialize EZWare with default WebSocket URL (ws://localhost:8887)
const devices = useEZWare(globalEventFunction, globalEventResult)

// Or specify custom WebSocket URL
// const devices = useEZWare(globalEventFunction, globalEventResult, 'ws://your-url:port');

Available Device Drivers

• Barcode Scanner: barcode
• Bill Validator: billValidator
• Camera (Common): camCommon
• Signature Camera: camSignature
• Card Dispenser: cardDispenser
• IC Card Reader: icCardReader
• Card Dispenser Reader: cardDispenserReader
• ID Card Reader (Inductive): idCardReader
• ID Card Reader (Insertion): idCardReader1
• Card Reader: cardReader
• SS Card Reader: ssCardReader
• Swipe Card Reader: swCardReader
• PIN Pad: pinPad
• Check Printer: ptrCheckPrinter
• Check Scanner: ptrCheckScanner
• Document Printer: documentPrinter
• Fingerprint Scanner: ptrFinger
• Label Printer: labelPrinter
• Passbook Printer: passbookPrinter
• Receipt Printer: receiptPrinter
• Scanner: ptrScanner
• Sensors Interface Unit: siu
• Base Com Ctrl: baseComCtrl
• DJ Sign Ctrl: dJSignCtrl
• Duo Wen IME Inspur: duoWenIMEInspur
• Duo Wen IME: duoWenIME
• Ftp Plugin Ctrl: ftpPluginCtrl
• Http Plugin Ctrl: httpPluginCtrl
• Insp Pub Ctrl: inspPubCtrl
• OS Plugin Ctrl: oSPluginCtrl
• Sapi Sp Voice Ctrl: sapiSpVoiceCtrl
• WScript Shell Ctrl: wScriptShellCtrl

Configuration

The default WebSocket URL is ws://localhost:8887. You can override this by passing a custom URL as the third parameter to useEZWare().

TypeScript Support

This package includes TypeScript type definitions. The main types are:

• EventFunctionType: Type for event handler function
• EventResultType: Type for result handler function

License

MIT