Have ideas to improve npm?Join in the discussion! »

cordova-plugin-epson-epos2

1.0.3 • Public • Published

cordova-plugin-epos2

Cordova plugin for Epson ePOS SDK(v2.6.0) for iOS and Android.

Integrates the Epson ePOS2 SDK for iOS and Android with a limited set of functions to discover and connect ePOS printers

Check supported devices and requirements from official SDK by Epson.

Install

cordova plugin add cordova-plugin-epson-epos2

API

The plugin exposes an interface object to cordova.epos2 for direct interaction with the SDK functions. See www/plugin.js for details about the available functions and their arguments. All API functions are asynchronous and return a Promise.

Printer Discovery

.startDiscover(discoverCallback)

This will search for supported printers connected to your mobiel device via Bluetooth or available in local area network (LAN)

cordova.epos2.startDiscover(function(deviceInfo) {
    // success callback with deviceInfo
}).catch(function(error) => {
    // error callback
});

.stopDiscover()

cordova.epos2.stopDiscover()
  .then(function() {
    // success callback
  })
  .catch(function(error) {
    // error callback
  });

.getSupportedModels()

Resolves with an array of strings denoting the supported printer models.

cordova.epos2.getSupportedModels()
  .then(function(models) {
    // success callback
  })
  .catch(function(error) {
    // error callback
  });

Printer Connection

.connectPrinter(device, printerModel)

Establish a connection to the given printer device. For device either provide a device information objects as retrieved from discovery or string with device address ('BT:xx:xx:xx:xx:xx' or 'TCP:xx.xx.xx.xx').

cordova.epos2.connectPrinter(device, printerModel)
  .then(function() {
    // success callback
  })
  .catch(function(error) {
    // error callback
  });

.disconnectPrinter()

cordova.epos2.disconnectPrinter()
  .then(function() {
    // success callback
  })
  .catch(function(error) {
    // error callback
  });

.getPrinterStatus()

cordova.epos2.getPrinterStatus()
  .then(function(status) {
    // success callback with status object
  })
  .catch(function(error) {
    // error callback
  });

Printing

.print(stringData, successCallback, errorCallback)

One-shot function printing the given text. Use '\n' in string data in order to move to next line. Cut feed is added automatically.

cordova.epos2.print(stringData, function() => {
    // success callback
}, function(error) => {
    // error callback
});

.printText(stringData, textFont, textSize, textAlign, terminate)

Send text to the connected printer. Also accepts parameters for font type, text size and alignment. Can be called multiple times for additional text lines. Set terminate to True in order to complete the print job and add cut feed.

cordova.epos2.printText(stringData, 0, 1, 2, false)
  .then(function() {}
    // success callback
  })
  .catch(function(error) => {
    // error callback
  });

.printImage(data, printMode, halfTone, terminate)

Send image data as data-url to the connected printer.

cordova.epos2.printImage(imageSource, 0, 0, false)
  .then(function() {}
    // success callback
  })
  .catch(function(error) => {
    // error callback
  });

Example

After successful discovery or entering the printer address, one can send a print job like this:

cordova.epos2.connectPrinter(device, model)
  .then(function() {
    return cordova.epos2.printText([
      'This is a printing demo from Cordova\n',
      'Composed using the cordova-plugin-epos2 plugin\n',
      '\n'
    ]);
  })
  .then(function() {
    // send image with `terminate` flag to complete the print job
    return cordova.epos2.printImage('data:image/png;base64,xxxxx', 0, 0, true);
  })
  .then(function() {
    return cordova.epos2.disconnectPrinter()
      .catch(function() { /* ignore disconnect errors */ });
  })
  .then(function() {
    console.log('Printing complete.');
  })
  .catch(function(err) {
    console.error('Printing failed', err);
  })

Platforms

  • iOS 9+
  • Android

License

MIT License

Install

npm i cordova-plugin-epson-epos2

DownloadsWeekly Downloads

42

Version

1.0.3

License

MIT

Unpacked Size

141 MB

Total Files

22

Last publish

Collaborators

  • avatar