Superroute.SPrint 0.1.6

Superroute.SPrint

sPrint for .NET: Superroute's printing SDK. Find network, USB and Bluetooth printers, detect their command language (ZPL, TSPL, ESC/POS, CPCL and the vendor dialects), print labels, PDF, HTML, images and raw bytes, and turn the machine into a Superroute print node.

using Superroute.SPrint;

using var printers = new PrinterRegistry("printers.json");
printers.Save(new TargetPrinter { Name = "Labels", Host = "192.168.1.40", Transport = Transports.Network, Language = Languages.Zpl });

var label = LabelJob.Parse(File.ReadAllText("label.json"));
var result = printers.Print(new PrintJob { Type = JobTypes.Label, Label = label });
if (!result.Ok) Console.WriteLine($"{result.Reason}: {result.Message}");

foreach (var p in Discovery.ScanNetwork()) Console.WriteLine($"{p.Name} {p.Host}");

using var node = new PrintNode(printers, savedState);
node.StateChanged += (_, s) => Save(s);  // holds the node token
node.Pair("K2M9XY");                      // the code from the Print Nodes page
node.Start();

Print node hooks

The host app may answer remote commands first, follow the server's printer settings and jobs in flight, and add its own heartbeat fields (see docs/NODE-HOOKS.md):

using var node = new PrintNode(printers, savedState,
    onCommand: async c => c.Action == "connectivity_test"
        ? new CommandAnswer { Output = await CheckNetwork() }
        : null,                                     // null: the node answers it
    commandsEvery: TimeSpan.FromSeconds(15));
node.SettingsChanged += (_, s) => ShowLocks(s.Locks, s.Paper);   // languages, locks, default papers: already applied
node.Printing += (_, e) => ShowPrinting(e.Printer, e.Started);  // cloud and peer jobs
node.SetPrinterFields("Labels", new JsonObject { ["language_kept"] = kept });
var refused = node.PushLanguages(new Dictionary<string, string> { ["Labels"] = "zpl" });
var media = SPrint.QueryZplMedia(zebra);                        // dpi, width × length mm; null: no answer

A language the client locked is refused by PrinterRegistry.Save and by PushLanguages, except a post-job correction passed in corrections.

LAN peer printing

Two devices on the same network print to each other's shared printers with no server in between (the SuperPrinter apps' peer-direct protocol). A host shares nothing until it names its printers, and admits peers in approval mode unless told otherwise; sPrint keeps no files for peers, so store the state it hands over.

// The printer owner
using var host = new PeerHost(printers, state: savedPeerState, name: "Front desk");
host.StateChanged += (_, s) => Save(s);                       // identity, mode, shared printers, trust list
host.ApprovalRequested += (_, p) => host.Decide(p.Id, AskOwner(p.Name, p.Fingerprint, p.Note));
host.SetShared(new[] { "Labels" });
host.SetDiscoverable(true);                                   // advertised over mDNS
host.Start();

// The printer user
using var me = PeerIdentity.FromSeed(savedSeed);
var peer = Discovery.BrowsePeers().First();
using var session = PeerSession.Connect(me, new PeerConnectOptions { Addr = peer.Addr, Fingerprint = peer.Fingerprint, Note = "Packing desk" });
if (session.Status.Status == "pending") session.WaitApproval();  // SPrintException Code "denied" / "timeout"
session.Ended += (_, e) => Console.WriteLine($"ended: {e.Reason}");
var result = session.Print("Labels", new PrintJob { Type = JobTypes.Label, Label = label });
printers.AttachPeer(session);                                 // or route jobs to "peer:<fingerprint>/Labels"

Native libraries are included for Windows (x64, arm64), macOS (arm64, x64) and Linux (x64, arm64, arm). On Windows the package also copies SumatraPDF.exe (PDF to a printer driver) and blepair.exe (bonding BLE printers) next to your executable; set <SPrintWindowsHelpers>false</SPrintWindowsHelpers> to leave them out.

Licensed under the Superroute SDK License.