@es-webdev/react-native-sunmi-printer

Caution: this is not the official project. I share it because I am working on this device but no any official support in react-native It's welcome to ask any question about the usage,problems or feature required, I will support ASAP.

Offical Demos plz refer: https://github.com/shangmisunmi/SunmiPrinterDemo

Platform support

This library only provides native code for Android. When you build an iOS target the JS API remains available, but every method will throw to signal that the functionality is unavailable. Guard your calls with Platform.OS === 'android' (or dynamically load the module) if your project ships to multiple platforms.

TOC

• Installation
• Linking
• Usage
• API
• Broadcast Events Listener

Installation:

Using npm：

npm install @es-webdev/react-native-sunmi-printer --save

or using yarn：

yarn add @es-webdev/react-native-sunmi-printer

Linking

Automatic linking is supported for all platforms (even windows on React native >= 0.63!)

Previous versions need to do manual linking.

New architecture (TurboModules)

Starting with this version the Android implementation ships a TurboModule spec and conditional source sets so it works out of the box when the host application enables the React Native New Architecture (including Expo SDKs built with expo prebuild --new-architecture). No additional manual steps are required—just enable the new architecture in your app and rebuild. Older apps that keep the legacy architecture continue to build thanks to the fallback stubs that ship in android/src/oldarch.

Usage

import { Platform } from 'react-native';
import SunmiPrinter from '@es-webdev/react-native-sunmi-printer';

if (Platform.OS === 'android') {
  SunmiPrinter.printerText('Hello World\n');
}

Scan

import { SunmiScan } from '@es-webdev/react-native-sunmi-printer';

useEffect(() => {
  DeviceEventEmitter.addListener('onScanSuccess', (msg) => {
    console.log('result', msg);
  });
  return () => DeviceEventEmitter.removeAllListeners('onScanSuccess');
}, []);

SunmiScan.scan();

API

The example app in this repository shows an example usage of every single API, consult the example app if you have questions, and if you think you see a problem make sure you can reproduce it using the example app before reporting it, thank you.

| Method | Return Type | iOS | Android | Windows | Web | | ----------------------------------------------------------------------- | ----------------- | :-: | :-----: | :-----: | :-: | | printerInit() | null | ❌ | ✅ | ❌ | ❌ | | printerSelfChecking() | null | ❌ | ✅ | ❌ | ❌ | | getPrinterSerialNo() | Promise<string> | ❌ | ✅ | ❌ | ❌ | | getPrinterVersion() | Promise<string> | ❌ | ✅ | ❌ | ❌ | | getServiceVersion() | Promise<string> | ❌ | ✅ | ❌ | ❌ | | getPrinterModal() | Promise<string> | ❌ | ✅ | ❌ | ❌ | | getPrinterPaper() | Promise<string> | ❌ | ✅ | ❌ | ❌ | | getPrintedLength() | null | ❌ | ✅ | ❌ | ❌ | | updatePrinterState() | Promise<number> | ❌ | ✅ | ❌ | ❌ | | sendRAWData() | null | ❌ | ✅ | ❌ | ❌ | | setPrinterStyle() | null | ❌ | ✅ | ❌ | ❌ | | setAlignment() | null | ❌ | ✅ | ❌ | ❌ | | setFontName() | null | ❌ | ✅ | ❌ | ❌ | | setFontSize() | null | ❌ | ✅ | ❌ | ❌ | | setFontWeight() | null | ❌ | ✅ | ❌ | ❌ | | printerText() | null | ❌ | ✅ | ❌ | ❌ | | printTextWithFont() | null | ❌ | ✅ | ❌ | ❌ | | printOriginalText() | null | ❌ | ✅ | ❌ | ❌ | | printColumnsText() | null | ❌ | ✅ | ❌ | ❌ | | printColumnsString() | null | ❌ | ✅ | ❌ | ❌ | | printBarCode() | null | ❌ | ✅ | ❌ | ❌ | | printQRCode() | null | ❌ | ✅ | ❌ | ❌ | | print2DCode() | null | ❌ | ✅ | ❌ | ❌ | | commitPrint() | null | ❌ | ✅ | ❌ | ❌ | | enterPrinterBuffer() | null | ❌ | ✅ | ❌ | ❌ | | exitPrinterBuffer() | null | ❌ | ✅ | ❌ | ❌ | | commitPrinterBuffer() | null | ❌ | ✅ | ❌ | ❌ | | commitPrinterBufferWithCallbacka() | null | ❌ | ✅ | ❌ | ❌ | | lineWrap() | null | ❌ | ✅ | ❌ | ❌ | | cutPaper() | null | ❌ | ✅ | ❌ | ❌ | | getCutPaperTimes() | Promise<number> | ❌ | ✅ | ❌ | ❌ | | openDrawer() | null | ❌ | ✅ | ❌ | ❌ | | getDrawerStatus() | null | ❌ | ✅ | ❌ | ❌ | | printBitmap() | null | ❌ | ✅ | ❌ | ❌ | | printBitmapCustom() | null | ❌ | ✅ | ❌ | ❌ |

Broadcast-Event-Listener

You can enable Output Via Broadcast option in your SUNMI Device Scanner's Settings and then listen the onScanSuccess Event with the result. You have to use physical special key buttons on your SUNMI device or soft floating button on your device (if you enabled that) to trigger infrared scanning for the barcodes . And then afterwards , you can get the result in the onScanSuccess event.

useEffect(() => {
  DeviceEventEmitter.addListener('onScanSuccess', (msg) => {
    console.log('result', msg);
  });
  return () => DeviceEventEmitter.removeAllListeners('onScanSuccess');
}, []);

Contributing

See the contributing guide to learn how to contribute to the repository and the development workflow.

License

MIT