Cordova plugin for using Star micronics printers from a cordova, phonegap or Ionic application.

Note: This is based on the work from the guys at InteractiveObject

This plugin defines global starprnt object.

Although in the global scope, it is not available until after the deviceready event.

document.addEventListener("deviceready", onDeviceReady, false);
function onDeviceReady() {
    console.log(starprnt);
}

Ionic 1 example app: https://github.com/infoxicator/StarprntDemo-Ionic1

Ionic 2/3 example app: https://github.com/infoxicator/StarprnDemoIonicV2

Cordova: cordova plugin add cordova-plugin-starprnt

Github: cordova plugin add https://github.com/auctifera-josed/starprnt

Warning: when updating you should run first ionic cordova plugin rm cordova-plugin-starprnt and then install again

starprnt.portDiscovery('All', function(result) {
        console.log(result);
    },
    function(error){
        console.log(error);
    });

Success Log Example: console[{modelName: "TSP700II", macAddress: "00:00:00:00", portName: "TCP:192.168.1.1"}]

SMPort opens the connection to the printer and closes it after the commands are successfully sent.

printObj = {
    text:"Star Clothing Boutique\n123 Star Road\nCity, State 12345\n\n",
    cutReceipt:"true",
    openCashDrawer: "true"
}
starprnt.printRawText("TCP:192.168.1.1","StarLine", printObj, function(result){
        console.log(result);
    },
    function(error) {
        console.log(error);
    });

StarIOExtManager Allows you to connect to the printer and listen for hardware events, you will need to manually open and close the connection.

starprnt.connect("TCP:192.168.1.1","StarLine", function(err,res) {});
printObj = {
    text:"Star Clothing Boutique\n123 Star Road\nCity, State 12345\n\n",
    cutReceipt:"true",
    openCashDrawer: "true"
}
/*Send null to use a printer connected via StarIOExtManager using the connect() function*/
starprnt.printRawText(null, "StarLine", printObj, function (result) {
        console.log(result);
    },
    function(error){
        console.log(error);
    });

To print special characters using the print() function, select the correct Encoding, CodePageType and International then send the bytes using the appendBytes command.

CodePage 858

var commands = [];
commands.push({appendCodePage:'CP858'});
            commands.push({appendEncoding:'US-ASCII'});
            commands.push({appendInternational: 'UK'});
            commands.push({appendBytes:[0x9c]});
starprnt.print("TCP:192.168.1.1","StarLine", commands, function(result) {
       console.log(result);
    },
    function(error){
       console.log(error);
   });

CodePage 858

var commands = [];
commands.push({appendCodePage:'CP858'});
            commands.push({appendEncoding:'Windows-1252'});
            commands.push({appendInternational: 'Spain'});
            commands.push({appendBytes:[0xd5]});
starprnt.print("TCP:192.168.1.1","StarLine", commands, function(result) {
       console.log(result);
    }, function(error) {
        console.log(error);
   });

• portDiscovery(type, success, error)
• checkStatus(port, emulation, success, error)
• printRawText(port, emulation, printObj, success, error)
• printRasterReceipt(port, emulation, rasterObj, success, error)
• printImage(port, emulation, imageObj, success, error)
• printBase64Image(port, emulation, imageObj, success, error)
• print(port, emulation, commandArray, success, error)
• connect(port, emulation, hasBarcodeReader, callback)
• disconnect(success, error)
• openCashDrawer(port, emulation, success, error)

• PrinterEvents
• Cash Drawer Events

List of commands available through the print() function

• InternationalType
• FontStyleType
• CutPaperAction
• BlackMarkType
• LogoSize
• AlignmentPosition
• BarcodeSymbology
• BarcodeWidth
• QrCodeModel
• QrCodeLevel
• BitmapConverterRotation

Almost all the methods take success an error functions as parameters, these are callback functions to execute in either case. They are not listed in the parameters for simplicity.

Note: asterisk (*) indicates a required parameter

The portDiscovery(type, success, error) Find available printers

The checkStatus(port, emulation, success, error) returns the current status of the printer, as well as model number and firmware information. Checking status of a printer while connected to that printer can produce unexpected results.

The printRawText(port, emulation, printObj, success, error) Prints plain text and command

var printObj = {
    text:"Star Clothing Boutique\n123 Star Road\nCity, State 12345\n\n",
    cutReceipt:true, // optional - Defaults to true
    openCashDrawer:true // optional -Defaults to true
}

The printRasterReceipt(port, emulation, rasterObj, success, error) Converts the text into a bitmap image and sends it to the printer

var rasterObj = {
        text : "        Star Clothing Boutique\n" +
        "             123 Star Road\n" +
        "           City, State 12345\n" +
        "\n" +
        "Date:MM/DD/YYYY          Time:HH:MM PM\n" +
        "--------------------------------------\n" +
        "SALE\n" +
        "SKU            Description       Total\n" +
        "300678566      PLAIN T-SHIRT     10.99\n" +
        "300692003      BLACK DENIM       29.99\n" +
        "300651148      BLUE DENIM        29.99\n" +
        "300642980      STRIPED DRESS     49.99\n" +
        "30063847       BLACK BOOTS       35.99\n" +
        "\n" +
        "Subtotal                        156.95\n" +
        "Tax                               0.00\n" +
        "--------------------------------------\n" +
        "Total                          $156.95\n" +
        "--------------------------------------\n" +
        "\n" +
        "Charge\n" +
        "156.95\n" +
        "Visa XXXX-XXXX-XXXX-0123\n" +
        "Refunds and Exchanges\n" +
        "Within 30 days with receipt\n" +
        "And tags attached\n",
        fontSize: 25,       //Defaults to 25
        paperWidth: 576,    // options: 384 = 2", 576 = 3", 832 = 4"
        cutReceipt:true, // Defaults to true
        openCashDrawer:true // Defaults to true
        };

The printImage(port, emulation, imageObj, success, error) prints a picture from the photo library or camera, Gets an image from a string URI and converts it to bitmap to send it to the printer.

 var imageObj = {
    uri: 'file:https:///var/mobile/Containers/Data/Application/1B4B8C4C-6487-45AB-B950-0AC3633542F5/tmp/cdv_photo_002.jpg',
    width: 576 // options: 384 = 2", 576 = 3", 832 = 4"
    cutReceipt:true, // Defaults to true
    openCashDrawer:true // Defaults to true
};

Note: The base64 option was originally left out because of performance concerns. The preferred option is using images stored in the phone's memory. The base64 option should only be used if strictly necessary or when performance is not a concern.

The printBase64Image(port, emulation, imageObj, success, error) prints an image from a base64 string. The base64 string is converted to a bitmap and sent to the printer. This can be useful if you would like to print an image directly from an HTML element, HTML canvas or a database. Here is an example for converting an html element to a base64 string using the html2canvas library (https://github.com/niklasvh/html2canvas).

getBase64Image = () => {
    const imageElement = document.getElementById('receiptpaper');
    var base64Image;
    (imageElement).then(function(canvas) {
        var data = canvas.toDataURL();
        base64Image=data.split('base64,')[1];
    });
    return base6Image;
}

After you have a base64Image string you can then insert it as described below.

 var imageObj = {
    base64Image: 'put base64 image string here',
    width: 576 // options: 384 = 2", 576 = 3", 832 = 4"
    cutReceipt:true, // Defaults to true
    openCashDrawer:true // Defaults to true
};

The print(port, emulation, CommandsArray, success, error) Sends an Array of commands to the command buffer using the Android ICommandBuilderInterface or iOS ISCBBuilderInterface

var commandsArray = [];
commandsArray.push({appendInternational: 'UK'});
commandsArray.push({
    appendLogo:1,  //Logo number configured using Star Print utility
    logoSize:"Normal"
});
commandsArray.push({appendAlignment:"Center"});
commandsArray.push({append: "Star Clothing Boutique\n"});
commandsArray.push({appendCutPaper:'PartialCutWithFeed'});

The connect(printerPort, emulation, hasBarcodeReader, function(err,res){}) function allows to 'connect' to the peripheral, to keep alive the connection between the device and the peripheral.

starprnt.connect("BT:StarMicronics", 'EscPosMobile', false, function(err,res){});

Notes:

• You need to connect before printing if using StarIOExtManager
• You should call this function on app resume event if you have disconnected on pause event
• After connecting the window event starPrntData stars firing with the printer status

The disconnect(success, error) function allows to disconnect (i.e. close the connection to the peripherals), this is useful to avoid keeping alive a connection when not in the app to save device battery (or energy consumption).

Notes:

• You should call this function on app pause event or when the app is closed

The openCashDrawer(port, emulation, success, error) sends an appendPeripheral command to the printer for channels No1 and No2

Listen to printer events as cases of the starPrntData event, cases are:

• Printer cover open: printerCoverOpen
• Printer cover close: printerCoverClose
• Printer impossible: printerImpossible
• Printer online: printerOnline
• Printer offline: printerOffline
• Printer paper empty: printerPaperEmpty
• Printer paper near empty: printerPaperNearEmpty
• Printer paper ready: printerPaperReady
• Barcode reader impossible: barcodeReaderImpossible
• Barcode reader connect: barcodeReaderConnect
• Barcode reader disconnect: barcodeReaderDisconnect
• Barcode data receive: barcodeDataReceive

• Cash drawer open: cashDrawerOpen
• Cash drawer close: cashDrawerClose

window.addEventListener('starPrntData', function (e) {
  switch (e.dataType) {
    case 'printerCoverOpen':
      console.log(e.data);
      break;
    default:
      console.log(e.data);
      break;
  }
});

Values for the PrintCommand properties. (Case and type sensitive)

CP737 = 'CP737',
CP772 = 'CP772',
CP774 = 'CP774',
CP851 = 'CP851',
CP852 = 'CP852',
CP855 = 'CP855',
CP857 = 'CP857',
CP858 = 'CP858',
CP860 = 'CP860',
CP861 = 'CP861',
CP862 = 'CP862',
CP863 = 'CP863',
CP864 = 'CP864',
CP865 = 'CP865',
CP869 = 'CP869',
CP874 = 'CP874',
CP928 = 'CP928',
CP932 = 'CP932',
CP999 = 'CP999',
CP1001 = 'CP1001',
CP1250 = 'CP1250',
CP1251 = 'CP1251',
CP1252 = 'CP1252',
CP2001 = 'CP2001',
CP3001 = 'CP3001',
CP3002 = 'CP3002',
CP3011 = 'CP3011',
CP3012 = 'CP3012',
CP3021 = 'CP3021',
CP3041 = 'CP3041',
CP3840 = 'CP3840',
CP3841 = 'CP3841',
CP3843 = 'CP3843',
CP3845 = 'CP3845',
CP3846 = 'CP3846',
CP3847 = 'CP3847',
CP3848 = 'CP3848',
UTF8 = 'UTF8',
Blank = 'Blank'

}

UK = 'UK',
USA = 'USA',
France = 'France',
Germany = 'Germany',
Denmark = 'Denmark',
Sweden = 'Sweden',
Italy = 'Italy',
Spain = 'Spain',
Japan = 'Japan',
Norway = 'Norway',
Denmark2 = 'Denmark2',
Spain2 = 'Spain2',
LatinAmerica = 'LatinAmerica',
Korea = 'Korea',
Ireland = 'Ireland',
Legal = 'Legal'

Font-A (12 x 24 dots) / Specify 7 x 9 font (half dots) = 'A'
Font-B (9 x 24 dots) / Specify 5 x 9 font (2P-1) = 'B'

FullCut = 'FullCut',
FullCutWithFeed = 'FullCutWithFeed',
PartialCut = 'PartialCut',
PartialCutWithFeed = 'PartialCutWithFeed'

Valid = 'Valid',
Invalid = 'Invalid',
ValidWithDetection = 'ValidWithDetection'

Normal = 'Normal',
DoubleWidth = 'DoubleWidth',
DoubleHeight = 'DoubleHeight',
DoubleWidthDoubleHeight = 'DoubleWidthDoubleHeight'

Left = 'Left',
Center = 'Center',
Right = 'Right'

Code128 = 'Code128',
Code39 = 'Code39',
Code93 = 'Code93',
ITF = 'ITF',
JAN8 = 'JAN8',
JAN13 = 'JAN13',
NW7 = 'NW7',
UPCA = 'UPCA',
UPCE = 'UPCE'

Mode1 = 'Mode1',
Mode2 = 'Mode2',
Mode3 = 'Mode3',
Mode4 = 'Mode4',
Mode5 = 'Mode5',
Mode6 = 'Mode6',
Mode7 = 'Mode7',
Mode8 = 'Mode8',
Mode9 = 'Mode9'

No1 = 'No1',
No2 = 'No2'

H = 'H',
L = 'L',
M = 'M',
Q = 'Q'

Normal = 'Normal',
Left90 = 'Left90',
Right90 = 'Right90',
Rotate180 = 'Rotate180'

Source: Star SDK Documentation