Skip to content

Latest commit

 

History

History
executable file
·
47 lines (28 loc) · 3.36 KB

README.md

File metadata and controls

executable file
·
47 lines (28 loc) · 3.36 KB

cloudprnt-sdk

Introduction

Star CloudPRNT is a protocol that enables printing to a printer and peripheral device control from a back-end service on a remote server.

CloudPRNT servers can be created using any server side technology that can be used to implement web services. Very many server side technologies are widely used such as PHP, Node.js, ASP.Net, ASP.Net Core, JSP, Python, Lua, and many more.

In order to provide maximum benefit to developers, this SDK is not a CloudPRNT server implementation (although sample servers are included), but a set of helper functions, that can be extended as needed and incorporated into as many server side systems as possible.

SDK Helper features

This SDK provides functions to assist with:

  • Status decoding
  • Print job media format negotiation
  • Print job conversion, so that the server may generate print jobs in a single media format, which will be converted in case that format is not supported by the client device.

SDK Integration

For integration purposes, the SDK provides the following:

  • .NET API
    A .Net Standard 2.0 compatible library, which can be installed via NuGet into .NET Framework 4.6.1 or later, and .NET Core 2.0 or later project. This API provides job format conversion, status decoding, and ready made classes for serializing/de-serializing CloudPRNT JSON messages.
    For more details, please refer our Online Manual.

  • cputil (CloudPRNTSDKSamples)
    CPUtil is a useful back-end tool to help with implementing CloudPRNT servers that are not .NET framework or .NET Core-based. Since its source code is published, server developers can implement necessary functions by freely modifying CPUtil as necessary.
    A stand-alone command line tool that can be integrated with any server-side development system that can invoke local processes. This tool can be provided as native binaries for Linux x86, Linux x64, Linux Arm, Mac OS x64, Windows x86 and Windows x64 servers (it is not necessary to install the .Net Framework or .Net Core runtime). environments in order to use it. And this tool uses the .NET API.

  • Star Document Markup
    A simple, unified printer markup language that can adapt to any Star printer regardless of emulation, print width, or print method. It is a higher level language that abstracts away the need to know printer-specific escape sequences. It does this by providing easy to use tags for various POS printer functions such as cut, alignment, image printing, and text formatting. Using the document markup system provides a balance between full bit-image based printing, and plain text output, while being easier to use than printer-specific commands. In order to take advantage of the markup language you must use it in conjunction with cputil.
    For more details, please refer our Online Manual.

  • Sample Projects (ExampleServers)
    Examples of very simple CloudPRNT servers. The sample serves as the examples of implementing the CloudPRNT protocol and how to integrate either the cputil.

Copyright

Copyright 2019 Star Micronics Co., Ltd. All rights reserved.