How to print raw Godex EZPL commands from Javascript

Product JSPrintManager Published 03/05/2019 Updated 03/05/2019 Author

Overview

The EZPL (EZ Programming Language) is a high-level label definition and printer control language for Godex printers. There are three types of commands in EZPL:

  • Setup commands: It includes printer control instructions, configuration instructions and image downloading instructions.
  • Control commands: It includes commands that cancontrol the printer to take action immediately, such as cleaning memory, feedinglabel.
  • Label Format commands: Define the format of datathat will be presentedon the label, such as Line, Rectangle, Barcode, Text and image.
Godex EZPL Rules and syntax
  1. The syntax of commands contains capital letters as the ID for each function.
  2. The lower case letters in command represent parameters.
  3. Control and Setup commands use the tilde (~) and caret (^) as prefix.
  4. Label Format commands have no prefix.
  5. The comma (,) is the delimiter to separate each parameter, and the CR (Carriage Return) signifies the end of every command.

Godex EZPL commands are very simple and text plain! The main advantage of using raw Godex EZPL commands for printing instead of using the built-in browser javascript printing (window.print();) is that the printing performance will be way faster; a factor that is key in the aforementioned scenarios. No matter which Web Platform/Framework you use (ASP.NET, PHP, Django, Ruby On Rails (RoR), Express.js, AngularJS/SPA, etc.), you'll be able to use raw printing feature with the help of our JSPrintManager solution that was specially designed for this kind of printing needs.

In this walkthrough, you'll learn how to print raw Godex EZPL commands from Javascript directly to the client printer without displaying a print dialog at all. You'll be able to print Godex EZPL commands to the Default client printer as well as to any other installed printer at the client machine. This solution works with any popular browser like Chrome, Firefox, IE/Edge & Safari on Windows, Linux, Raspberry Pi and Mac systems!

The Godex EZPL commands that we'll use in this article will print out a simple label that will look like this:

A Sample Label printed from Javascript and created by using Godex EZPL commands
A Sample Label printed from Javascript and created by using Godex EZPL commands



Follow up these steps

  • Be sure you install in your dev machine JSPrintManager (JSPM) (Available for Windows, Linux, Raspberry Pi & Mac)
    This small app must be installed on each client that will print from your website!
  • By using your favorite Web Development IDE or Text Editor, create a new HTML file like index.html
    Copy/paste the following snipped codes:

    HTML Code

    
<div style="text-align:center">
    <h1>Print Godex EZPL commands from Javascript</h1>
    <hr />
    <label class="checkbox">
        <input type="checkbox" id="useDefaultPrinter" /> <strong>Print to Default printer</strong>
    </label>
    <p>or...</p>
    <div id="installedPrinters">
        <label for="installedPrinterName">Select an installed Printer:</label>
        <select name="installedPrinterName" id="installedPrinterName"></select>
    </div>
    <br /><br />
    <button type="button" onclick="print();">Print Now...</button>
</div>

    Script References

    • Download JSPrintManager.js
    • Copy all of these *.js files to the same folder where your html page is located and the add the following script references to your page.

    



<script src="JSPrintManager.js"></script>

<script src="https://cdnjs.cloudflare.com/ajax/libs/bluebird/3.3.5/bluebird.min.js"></script>
<script src="https://code.jquery.com/jquery-3.2.1.slim.min.js"></script>

    Script Code

    
<script>

    //WebSocket settings
    JSPM.JSPrintManager.auto_reconnect = true;
    JSPM.JSPrintManager.start();
    JSPM.JSPrintManager.WS.onStatusChanged = function () {
        if (jspmWSStatus()) {
            //get client installed printers
            JSPM.JSPrintManager.getPrinters().then(function (myPrinters) {
                var options = '';
                for (var i = 0; i < myPrinters.length; i++) {
				    options += '<option>' + myPrinters[i] + '</option>';
				}
                $('#installedPrinterName').html(options);
            });
        }
    };

    //Check JSPM WebSocket status
    function jspmWSStatus() {
        if (JSPM.JSPrintManager.websocket_status == JSPM.WSStatus.Open)
            return true;
        else if (JSPM.JSPrintManager.websocket_status == JSPM.WSStatus.Closed) {
            alert('JSPrintManager (JSPM) is not installed or not running! Download JSPM Client App from https://neodynamic.com/downloads/jspm');
            return false;
        }
        else if (JSPM.JSPrintManager.websocket_status == JSPM.WSStatus.Blocked) {
            alert('JSPM has blocked this website!');
            return false;
        }
    }

    //Do printing...
    function print(o) {
        if (jspmWSStatus()) {
            //Create a ClientPrintJob
            var cpj = new JSPM.ClientPrintJob();
            //Set Printer type (Refer to the help, there many of them!)
            if ($('#useDefaultPrinter').prop('checked')) {
                cpj.clientPrinter = new JSPM.DefaultPrinter();
            } else {
                cpj.clientPrinter = new JSPM.InstalledPrinter($('#installedPrinterName').val());
            }
            //Set content to print...
            //Create Godex EZPL commands for sample label

            var CR = "\x0D";

            var cmds "^Q100,0,0" + CR;
            cmds += "^W102" + CR;
            cmds += "^H5" + CR;
            cmds += "^P1" + CR;
            cmds += "^S4" + CR;
            cmds += "^AD" + CR;
            cmds += "^C1" + CR;
            cmds += "^R0" + CR;
            cmds += "~Q+0" + CR;
            cmds += "^O0" + CR;
            cmds += "^D0" + CR;
            cmds += "^E15" + CR;
            cmds += "~R200" + CR;
            cmds += "^L" + CR;
            cmds += "Dy4-me-dd" + CR;
            cmds += "Th:m:s" + CR;
            cmds += "Lo,294,12,297,633" + CR;
            cmds += "BG,428,32,2,5,100,0,1,12345678901212345" + CR;
            cmds += "BQ,148,184,3,7,100,1,1,CODE128" + CR;
            cmds += "BH,288,212,3,7,100,1,1,12345678901" + CR;
            cmds += "AG,358,175,1,1,0,0,GODEX EZPL" + CR;
            cmds += "BA,448,461,2,6,95,0,1,CODE39" + CR;
            cmds += "AB,14,22,2,2,0,0,SOME TEXT" + CR;
            cmds += "Lo,296,164,799,165" + CR;
            cmds += "Lo,296,268,799,269" + CR;
            cmds += "AA,306,38,1,1,0,0,EAN13 ADD5" + CR;
            cmds += "W449,296,5,1,M,8,4,17,0" + CR;
            cmds += "QRCODE 0123456789" + CR;
            cmds += "XRB591,297,4,0,21" + CR;
            cmds += "DATAMATRIX 0123456789" + CR;
            cmds += "E" + CR;

            cpj.printerCommands = cmds;
            //Send print job to printer!
            cpj.sendToClient();
        }
    }

</script>
  • That's it! Run your website and test it. Click on Print Now... to print the Godex EZPL Commands without print dialog. You can print it to the Default client printer or you can get a list of the installed printers available at the client machine.

    NOTE You can also print directly to any LPT Parallel Port, RS232 Serial Port or IP/Ethernet Printer although these scenarios have not been considered in this article for simplicity. For further details on those scenarios, please contact our tech support.
Try JSPrintManager Online Demo!


Useful? Share it!

Related Articles

  How to configure RAW printing mode in Windows
  How to configure RAW printing mode in Linux and Raspberry Pi
  How to configure RAW printing mode in macOS and OSX

Need help? Contact Support

We provide best-in-class customer service and support directly from members of our dev team! If we are available when you contact us, you will get a response in few minutes; otherwise the maximum turnaround is 24hs in most cases.