📦 @un1v3r/react-native-sunmi-printer

A React Native native module for Sunmi POS printers and scanners (Android only).

⚠️ This is a community-maintained fork Original project: https://github.com/es-webdev/react-native-sunmi-printer Fork repository: https://github.com/st3k0/react-native-sunmi-printer

This fork exists due to lack of maintenance in the original library and fixes required for modern React Native / Expo New Architecture support.

TOC

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

Installation:

Using npm：

npm install @un1v3r/react-native-sunmi-printer --save

or using bun：

bun add @un1v3r/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)

This library is New Architecture only. The Android implementation ships a TurboModule spec and relies on codegen, so the host application must have the React Native New Architecture enabled (including Expo SDKs built with expo prebuild, which enable it by default). No additional manual steps are required—just make sure the new architecture is on and rebuild. The legacy bridge is not supported.

Usage

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

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

Scan

import { SunmiScan } from '@un1v3r/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> | ❌ | ✅ | ❌ | ❌ | | getDeviceSerialNumber() | 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 | ❌ | ✅ | ❌ | ❌ |

getDeviceSerialNumber

Returns the device serial number (the hardware/body SN of the SUNMI device), which is different from getPrinterSerialNo() — the latter returns the serial number of the built-in printer.

Unlike most other methods, this does not require the printer service to be connected, since it reads the serial number from the device's system properties (ro.serialno), falling back to Build.getSerial(). If the serial number cannot be resolved, it resolves to an empty string ''.

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

if (Platform.OS === 'android') {
  const serial = await SunmiPrinter.getDeviceSerialNumber();
  console.log('Device serial number:', serial);
}

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