Capacitor Senraise Printer

A Capacitor plugin for Senraise thermal printers. This plugin allows you to print text, barcodes, QR codes, and images from your Capacitor application to a connected Senraise printer.

Supported Platforms

Install

npm install capacitor-senraise-printer
npx cap sync

Usage Example

Here's an example of how to print a simple receipt:

import { Printer } from 'capacitor-senraise-printer';

export class ReceiptPrinter {

  init() {
    Printer.connect().then(() => {
      console.log("Printer connected successfully");
    }).catch((error) => {
      console.error("Failed to connect to printer:", error);
    });
  }

  async printReceipt() {
    try {
      await Printer.setTextSize({ textSize: 28.0 });
      await Printer.setAlignment({ alignment: 1 }); // Center
      await Printer.setTextBold({ bold: true });
      await Printer.printText({ text: 'My Store\n' });

      await Printer.setTextSize({ textSize: 18.0 });
      await Printer.setAlignment({ alignment: 0 }); // Left
      await Printer.setTextBold({ bold: false });
      await Printer.printText({ text: '123 Main Street\n' });
      await Printer.printText({ text: 'Anytown, USA 12345\n\n' });

      await Printer.printTableText({
        text: ['Item', 'Qty', 'Price'],
        weight: [2, 1, 1],
        alignment: [0, 1, 2] // Left, Center, Right
      });
      await Printer.printTableText({
        text: ['----------------', '---', '-----'],
        weight: [2, 1, 1],
        alignment: [0, 1, 2]
      });
      await Printer.printTableText({
        text: ['Product 1', '1', '$10.00'],
        weight: [2, 1, 1],
        alignment: [0, 1, 2]
      });
      await Printer.printTableText({
        text: ['Product 2', '2', '$5.00'],
        weight: [2, 1, 1],
        alignment: [0, 1, 2]
      });
      await Printer.nextLine({line : 2});

      await Printer.setAlignment({ alignment: 1 }); // Center
      await Printer.printQRCode({
        data: 'https://your-website.com',
        modulesize: 8,
        errorlevel: 1
      });
      await Printer.nextLine({line : 4});

    } catch (error) {
      console.error('Error printing receipt:', error);
    }
  }
}

API Reference

Initializes and connects to the Senraise thermal printer.

This method only needs to be called once, typically when the application starts (for example, in AppComponent, main.ts, or the first screen of your app).

Note

⚠️ Important: `Printer.connect()` is a one-time initialization.
Once connected, you can print from any page without reconnecting, as long as the app is not closed.

example :

import { Printer } from 'capacitor-senraise-printer';

function initPrinter() {
  Printer.connect().then(() => {
    console.log("Printer connected successfully");
  }).catch((error) => {
    console.error("Failed to connect to printer:", error);
  });
}

or

import { Printer } from 'capacitor-senraise-printer';

async function initPrinter() {
  try {
    await Printer.connect();
    console.log('Printer connected successfully');
  } catch (error) {
    console.error('Failed to connect to printer:', error);
  }
}

Prints raw ESC/POS (Epson Standard Code) commands. This is useful for advanced printing tasks that are not covered by the other methods.

| Param | Type | Description | | :--------- | :--------- | :--------------------------------------------------------- | | data | number[] | An array of byte values representing the ESC/POS commands. |

example :

Printer.printEpson({
  data: [
    0x1B, 0x40, // Initialize printer
    0x1B, 0x61, 0x01, // Center alignment
    0x1B, 0x45, 0x01, // Bold on
    0x1D, 0x21, 0x00, // Change Text size to 22
    // "Mawlood Fareq" in ASCII
    0x4D, 0x61, 0x77, 0x6C, 0x6F, 0x6F, 0x64, 0x20,
    0x46, 0x61, 0x72, 0x65, 0x71,
    0x0A, // New line
    0x1D, 0x21, 0x11, // Double width and height
    0x1D, 0x21, 0x00, // Normal size
    0x1B, 0x45, 0x00, // Bold off
    0x1B, 0x61, 0x00, // Left alignment
    // "Hello, World!" in ASCII
    0x48, 0x65, 0x6C, 0x6C, 0x6F, 0x2C, 0x20,
    0x57, 0x6F, 0x72, 0x6C, 0x64, 0x21,
    0x0A, // New line
    // 0x1D, 0x56, 0x00 // Cut paper
  ]
})

Prints a string of text.

| Param | Type | Description | | :--------- | :------- | :----------------------------------------- | | text | string | The text to print. Use \n for new lines. |

example :

Printer.printText({ text: '123 Main Street\n' });

Prints a barcode.

| Param | Type | Description | | :---------- | :------- | :----------------------------------------------------------------------------------------------------------------------- | | data | string | The barcode data. | | symbology | number | The barcode type. Common values include: 0 (UPC-A), 1 (UPC-E), 2 (EAN13), 3 (EAN8), 4 (CODE39), 8 (CODE128). | | height | number | The height of the barcode in dots. | | width | number | The width of the barcode. The value range is 1-4. |

example :

printBarCode({ data: "ABC-12345", symbology: 8, height: 60, width: 2 });

Prints a QR code.

| Param | Type | Description | | :----------- | :------- | :--------------------------------------------------------------------------- | | data | string | The data to encode in the QR code. | | modulesize | number | The size of the QR code module (dot). The value range is 1-16. | | errorlevel | number | The error correction level. The value range is 0-3, representing L, M, Q, H. |

example :

printQRCode({ data: "https://your-website.com", modulesize: 8, errorlevel: 1 });

Sets the text alignment.

| Param | Type | Description | | :---------- | :------- | :---------------------------------------------------------------- | | alignment | number | The alignment style. 0 for left, 1 for center, 2 for right. |

example :

Printer.setAlignment({ alignment: 2 });

Sets the text size.

| Param | Type | Description | | :--------- | :------- | :------------------------------------------------------------------- | | textSize | number | The size of the text, e.g., 18 for normal, 28 for large. |

example :

Printer.setTextSize({ textSize: 24 });

Sets the text to bold or normal.

| Param | Type | Description | | :----- | :-------- | :---------------------------------------- | | bold | boolean | true for bold text, false for normal. |

example :

Printer.setTextBold({ bold: true });

Adds a specified number of empty lines.

| Param | Type | Description | | :----- | :------- | :---------------------------------------- | | line | number | The number of lines to feed. |

example :

Printer.nextLine({line : 4});

Platform Specific Configuration

Android

No special permissions are required in your AndroidManifest.xml for this plugin to work.

Contributing

Contributions to this Capacitor plugin are welcome! For major changes or new features, please open an issue first to discuss your ideas. Please note that this repository focuses on the plugin's integration and functionality, not modifications to the underlying Senraise SDK.

Please make sure to update tests as appropriate.

License

MIT