react-native-ebprinter

v1.0.1

Published

9 days ago

Goodcom Printer sdk for react-native(TypeScript),supporting printing with Goodcom POS machines, Bluetooth printing, USB printing, and wifi printing.

0High
0Medium
0Low

goodcom

react-native goodcom printer

This is react-native(TypeScript) sdk,supporting printing with Goodcom POS machines, Bluetooth printing, USB printing, and wifi printing.

This is a React Native project, bootstrapped using @react-native-community/cli.

Getting Started

Note: Make sure you have completed the React Native - Environment Setup instructions till "Creating a new application" step, before proceeding.

Step 1: Installation

npm install react-native-ebprinter --save

yarn add react-native-ebprinter

Step 2: Add dependenceie

modify app/build.gradle under the android project：

implementation project(':react-native-ebprinter')

Step 3: Add 'EbPrinterPackage' to MainApplication

import com.goodcom.react.EbPrinter.EbPrinterPackage;
...

        @Override
        protected List<ReactPackage> getPackages() {
            return Arrays.<ReactPackage>asList(
                    new MainReactPackage(),
                    new EbPrinterPackage()
            );

Step 4: Import in React-Native

import EbPrinter, {FontSize, AlignmentType, BarcodeType} from 'react-native-ebprinter';

API

Constants

Method


  /**
   * Draw text into memory, you can specify the position and font size of the printed text, and you can print the left, middle, and right text at the same line
   * You can continuously use drawText to draw all the contents into memory, and finally use printText to print the contents.
   */
  drawText: (strLeft, fontLeft, strMid, fontMid, strRight, fontRight) => void,
 /**
   * Start printing. Except for image printing, other APIs, such as drawText, just draw the printing content in the memory first, and the printing has not been started yet.
   * This method is to print out the printing content in the memory.Control whether to automatically feed paper through isAutoFeed
   */
  printText: (isAutoFeed) => void,
  /**
   * Draw text into memory, you can print left-aligned and right-aligned content at the same line. It needs to be printed using printText.
   */
  drawLeftRight: (strLeft, fontLeft, strRight, fontRight) => void,
  /**
   * Draw text content to memory, you can specify the size and position of the content. It needs to be printed using printText.
   */
  drawCustom: (string, fontSize, align) => void,
  /**
   * Draw a blank line, similar to a newline.
   */
  drawNewLine: () => void,
  /**
   * Draw a horizontal line, you can specify the thickness of the horizontal line by setting the font size.
   */
  drawOneLine: (fontSize) => void,
  /**
   * Draw a horizontal line, use the default font without specifying the font size
   */
  drawOneLineDefault: () => void,
  /**
   * Draw barcodes, including qrcode, you can specify the alignment position and barcode type of the barcode.
   */
  drawBarcode: (str, align, type) => void,
  /**
   * Draw barcodes, including qrcode, you can specify the alignment position and barcode type of the barcode.
   * The height of the barcode can be specified. No width parameter is required, the width is determined by the specific barcode
   */
  drawBarcodeWithHeight: (string, align, type, height) => void,
   /**
   * Draw qrcode,you can specify the alignment position of the qrcode.
   */
  drawQrCode: (string, align) => void;
  /**
   * Draw qrcode,you can specify the alignment position of the qrcode.
   * The height of the qrcode can be specified. No width parameter is required, the width is determined by the specific qrcode
   */
  drawQrCodeWithHeight: (string,align,height) => void;  
  /**
   * Check whether printing is supported. This method returns true only on goodcom printers. This method allows the app to distinguish printers from different manufacturers.
   */
  isDeviceSupport: () => Promise<string>,
  /**
   * Print the content in json format, which will be parsed by the printer according to the template and formatted for printing
   */
  printJson: (json) => void,
  /**
   * Printing an image using base64 encoding, the Base64 string must start with "data:image/png;base64,"
   * You can set the alignment position of the printed image, and decide whether to automatically feed the paper after printing.
   * If you want to print the text after printing the image, the paper will not be automatically fed.
   */
  printImageByBase64: (base64, align, isAutoFeed) => void,
  /**
  * Printing an image using byteArray
  * You can set the alignment position of the printed image, and decide whether to automatically feed the paper after printing.
  * If you want to print the text after printing the image, the paper will not be automatically fed.
  */
  printImageByArray: (byteArray, align, isAutoFeed) => void,
  /**
  * Used to open the cash box, it will be opened once when called. Currently, only GT11R is supported
  */
  openCashBox: () => void,
  /**
  * Show bitmap in customer display LCD by base64 encoding
  * The maximum size is 240 * 320,Images smaller than the customer display screen will be displayed in the center.
  * This feature is supported on some models.
  */
  showLcdBitmapByBase64: (base64) => void,
  /**
  * Show bitmap in customer display LCD by byteArray
  * The maximum size is 240 * 320,Images smaller than the customer display screen will be displayed in the center.
  * This feature is supported on some models.
  */
  showLcdBitmapByArray: (byteArray) => void,
  /**
  * Select Bluetooth printing and set the bluetooth address of the Bluetooth printer device. 
  * This method is not mandatory. 
  * When no Bluetooth device address is set, the SDK will automatically display a list of devices for the user to select.
  */
  selectBluetoothPrinter: (macAddress) => void,
  /**
  * Select USB printing and specify the USB printing device
  * The deviceInfo format: vendor_id: xxx product_id: yyy Where xxx represents the vendor ID and yyy represents the product ID
  */
  selectUsbPrinter: (deviceInfo) => void,
  /**
  * Select USB printing and specify the USB printing device
  */
  selectUsbPrinterById: (vid ,pid) => void,
  /**
  * Select network printing and specify the IP address of the device.
  */
  selectNetworkPrinter: (ipAddress, port) => void,
  /**
  * Get Bluetooth devices
  */
  getBluetoothDeviceList: () => Promise<string[]>,
  /**
  * Get USB devices.
  */
  getUsbDeviceList: ()=>  Promise<string[]>,

Published

Vulnerabilities

Links

Maintainers

Keywords

Readme