TscZebra.Plugin.Abstractions 1.0.4

TscZebra.Plugin

This NuGet package simplifies printer connectivity via TCP connection, enabling querying of printer status and sending print commands 🖨️

It exclusively supports ZPL labels for thermal printers 🔥

Support manufactures

• TSC
• Zebra

Setup printer

This code creates IZplPrinter Instance without connecting

using TscZebra.Plugin;
using TscZebra.Plugin.Abstractions;

IZplPrinter Printer = 
    PrinterFactory.Create(IPAddress.Parse("127.0.0.1"), 9100, PrinterTypes.Tsc);

Connect

try
{
  await Printer.ConnectAsync();
} catch (PrinterConnectionException)
{
  // connection cannot be established
} 

Get status

By polling

This method request printer for status, every interval seconds. Invokes event OnStatusChanged.

Method auto disabled when printer disabled (always when IZplPrinter throws PrinterConnectionException). Use after ConnectAsync method

  Printer.StartStatusPolling(5);
  
  Printer.OnStatusChanged += Receive;

  private void Receive(object? sender, PrinterStatus status)
  {
    // Your logic here
  }
  
  Printer.StopStatusPolling();
  Printer.OnStatusChanged -= Receive;

By hand

This method also invokes event OnStatusChanged

  PrinterStatuses StatusByHand = await Printer.RequestStatusAsync();

Print zpl

Before printing, the printer requests its status and triggers all status events.

  try {
    Printer.PrintZplAsync(string zpl);
  } catch {
      
  }

This method validates the ZPL code for printing. If the ZPL code is not valid, it throws a PrinterCommandBodyException

   public async Task PrintZplAsync(string zpl)
    {
        if (!(zpl.StartsWith("^XA") && zpl.EndsWith("^XZ")))
            throw new PrinterCommandBodyException();
    }

If the printer is successfully connected but cannot print a label (e.g., the head is open), it throws a PrinterStatusException

    public async Task PrintZplAsync(string zpl)
    {
        if (Status is not (PrinterStatuses.Ready or PrinterStatuses.Busy))
            throw new PrinterStatusException();
    }

Disconnect

Printer.Disconnect();

or

Printer.Dispose();

Other Commands

You can find comprehensive documentation for IZplPrinter in the code.