CPCL iOS SDK Reference Guide

1 Label Formatting Commands

1.1 Label Sessions

• Function

  A label that contains information to be printed begins with the ! character, followed by a series of ASCIInumbers which represent information about the label that follows.

  In order for this session to be detected, the first character of the Offset parameter must be a digit.

• Swift (iOS)

   
  1
  public func cpclLabel(offset offset: Int, hRes: Int, vRes: Int, height: Int, quantity: Int)
  

• Java (Android)

• C (Windows)

• Parameter

  Field Name	Description	Type	Valid Range
  Offset	The number of units to offset all fields from the left side of the label horizontally.	Units Number	0 to 65535
  Horizontal Res.	The horizontal resolution of this label, expressed in dots per inch.	Number (in dpi)	100 or 200
  Vertical Res.	The vertical resolution of this label, expressed in dots per inch.	Number (in dpi)	100 or 200
  Height	The height of the label in units.	Unit Number	0 to 65535
  Quantity	The number of copies of the label to print.	Number (in quantity)	0 to 1024

• Sample Code (Swift)

   
  1
  cpclLabel(offset: 0, hRes: 200, vRes: 200, height: 210, quantity: 1)
  2
  cpclCenter()
  3
  cpclText(rotate: 0, font: 4, fontSize: 0, x: 10, y: 0, text: "This is a ! command.")
  4
  cpclPrint()
  

  ​

1.2 Barcode

1.2.0 Barcode 1D

• Function

  The barcode command has several syntaxes based on the type of barcode being printed. The mostcommon syntax is the 1D barcode format.

• Swift (iOS)

   
  1
  public func cpclBarcode(type type: String, width: Int, ratio: Int, height: Int, x: Int, y: Int, barcode: String)
  

• Parameter

  Parameter	Type	Description	Valid Range
  Type	Space Terminated String	The type of barcode to print.	See table below.
  Width	5 Digit Unit Number	The width of a narrow bar.	0 to 65535 units
  Ratio	5 Digit Number	The ratio of wide to narrow bars.	0 to 4, 20 to 30.
  Height	5 Digit Unit Number	The height of the barcode.	0 to 65535 units
  X	5 Digit Unit Number	The X position where the barcode begins	0 to 65535 units
  Y	5 Digit Unit Number	The Y position where the barcode begins	0 to 65535 units
  Data	Terminated String	The data to be encoded into a barcode.	Up to 8191 bytes of Alpha Numeric Data.

• Sample Code (Swift)

   
  1
  cpclLabel(offset: 0, hRes: 200, vRes: 200, height: 210, quantity: 1)
  2
  cpclBarcode(type: CPCLBarcodeType.Code128.rawValue, width: 1, ratio: 1, height: 50, x: 150, y: 10, barcode: "horizontal")
  3
  cpclText(rotate: 0, font: 4, fontSize: 0, x: 180, y: 60, text: "HORIZ.")
  4
  cpclBarcodeVertical(type: CPCLBarcodeType.Code128.rawValue, width: 1, ratio: 1, height: 50, x: 10, y: 200, barcode: "vertical")
  5
  cpclText(rotate: 90, font: 4, fontSize: 0, x: 60, y: 180, text: "vertical")
  6
  cpclPrint()
  

1.2.1 Barocde Aztec

• Function

  • The BARCODE AZTEC command is used to print Aztec Code barcodes in the CPCL language.
  • VBARCODE AZTEC is identical to BARCODE, except it is oriented vertically.
  • Note that this command has optional parameters XD, EC, F, ME, M and ID. In order to use these parameters, the optional parameter must be followed by a space, then a number which complies with the table below.

• Swift (iOS)

   
  1
  public func cpclBarcodeAztec(xPos xPos: Int, yPos: Int, width: Int, erc: Int, flags: Int, menu: Int, multi: Int, idField: String)
  

• Parameter

  Parameter	Type	Description	Valid Range
  X	5 Digit Unit Number	The X position where the barcode begins	0 to 65535 units
  Y	5 Digit Unit Number	The Y position where the barcode begins	0 to 65535 units
  Width	5 Digit Number	The dot-width of a single element in the code	1 to 36
  ERL	5 Digit Number	The error recovery level or size	See below
  Flags	5 Digit Number	Is the barcode using flag escapes?	0 or 1
  Menu	5 Digit Number	Is the barcode a menu?	0 or 1
  Multi	5 Digit Number	Is the barcode a structured append part?	0 or 1
  ID	Or Space Terminated String	The structured append ID field	Up to 25 ASCII Characters
  Data	Terminated String	The data to be encoded in the barcode	See below

• Sample Code (Swift)

1.2.2 Data Matrix

• Function

  • The BARCODE DATAMATRIX command is used to print Data Matrix barcodes in the CPCL language.
  • The command has a number of optional parameters, any number of which may be specified. If a parameter is specified more than once, the last value specified is used.

• Swift (iOS)

   
  1
  public func cpclDataMatrix(xPos xPos: Int, yPos: Int, scale: Int, ecc: Int, columns: Int, rows: Int, format: Int, escapeChar: Int)
  2
  public func cpclAddBarcodeDataMatrixData(barcodeDataMatrix: String)
  3
  public func cpclEndDataMatrix()
  

• Parameter

  Parameter	Type	Description	Valid Range
  X	5 Digit Unit Number	The X position where the barcode begins	0 to 65535 units
  Y	5 Digit Unit Number	The Y position where the barcode begins	0 to 65535 units
  Scale	5 Digit Number	The scale of the barcode.	0 to 65535
  ECC	5 Digit Number	Specifies the level of error correction.	See Below.
  Columns	5 Digit Number	Specifies the number of columns to use.	See Below.
  Rows	5 Digit Number	Specifies the number of rows to use.	See Below.
  Format	5 Digit Number	Specifies the data format when ECC is not 200.	1 to 6
  EscapeChar	Space Terminated String	Specifies the escape character to use.	See Below.
  Data	Raw String	Data for barcode	See Below.

• Sample Code (Swift)

1.2.3 DataBar(RSS) and CompositeBarcodes

• Function

  • This command is used to print GS1 Databar (also known reduced space symbology) barcodes in CPCL, as well as Composite barcodes. There are 12 supported sub-types of GS1 Databar\Composite barcodes.
  • All barcode types supported by this command can consist of both a 1D and 2D component. If the barcode contains a 2D component, the output is referred to as a composite barcode. The 2D portion is optional, but the 1D portion is required.
  • If the parameters of the barcode are incorrect, in place of the barcode, a text message indicating the problem encountered while trying to form the barcode will be printed.

• Swift (iOS)

   
  1
  public func cpclBarcodeRSS(xPos xPos: Int, yPos: Int, scale: Int, lHeight: Int, sHeight: Int, segs: Int, type: Int, barcodeRSS: String)
  

• Parameter

  Parameter	Type	Description	Valid Range
  X	5 Digit Unit Number	The X position where the barcode begins	0 to 65535
  Y	5 Digit Unit Number	The Y position where the barcode begins	0 to 65535
  Scale	5 Digit Unit Number	The X and Y scaling factor of the barcode.	0 to 65535
  LHeight	5 Digit Unit Number	Height of the linear part of the barcode	0 to 65535
  SHeight	5 Digit Unit Number	Height of the separator between barcode parts	0 to 65535
  Segs	5 Digit Unit Number	The maximum number of segments per row	0 to 65535
  Type	5 Digit Number	The type of RSS barcode to print.	1 to 12
  Data	Terminated String	1D and 2D Data to Print	8191 alphanumeric characters

• Sample Code (Swift)

1.2.4 Maxicode

• Function

  • The BARCODE MAXICODE command is used to print MaxiCode barcodes in the CPCL language. Only type-2 MaxiCode barcodes (which contain formatted data with a structured carrier message a d numeric postal code) can be used in CPCL.
  • VBARCODE MAXICODE is identical to BARCODE MAXI. MaxiCode barcodes do not print in vertical orentation.
  • The barcode consists of fields that are represented with a field name followed by data. This field and data line can be repeated as many times as necessary to complete the barcode.
  • MaxiCode barcodes are always of a fixed size, there are no options to adjust its size.

• Swift (iOS)

  public func cpclBarcodeMaxicode(xPos xPos: Int, yPos: Int, field: Int, barcodeMaxicode: String)

• Parameter

  Parameter	Type	Description	Valid Range
  X	5 Digit Unit Number	The X position where the barcode begins	0 to 65535 units
  Y	5 Digit Unit Number	The Y position where the barcode begins	0 to 65535 units
  Field	Space Terminated String	The ratio of wide to narrow bars.	1 or 2
  Data	Terminated String	Unit-width of the barcode in dots	0 to 65535 dots

• Sample Code (Swift)

1.2.5 PDF417

• Function

  • The BARCODE PDF-417 command is used to print PDF417 barcodes in the CPCL language.
  • The command has a number of optional parameters, any number of which may be specified. If a parameter is specified more than once, the last value specified is used.
  • If a PDF-417 barcode’s parameter’s cause an error that would cause it not to print, a detailed error message will be displayed instead.
  • There is no option to use structured append PDF-417 barcodes in CPCL.

• Swift (iOS)

   
  1
  public func cpclBarcodePDF417(xPos xPos: Int, yPos: Int, XDot: Int, YDot: Int, columes: Int, rows: Int, ecc: Int, binaryModel: Int)
  2
  public func cpclBarcodePDF417Vertical(xPos xPos: Int, yPos: Int, XDot: Int, YDot: Int, columes: Int, rows: Int, ecc: Int, binaryModel: Int)
  3
  public func cpclBarcodePDF417Data(pdf417Data: String)
  4
  public func cpclBarcodePDF417End()
  

• Parameter

  Parameter	Type	Description	Valid Range
  X	5 Digit Unit Number	The X position where the barcode begins	0 to 65535 units
  Y	5 Digit Unit Number	The Y position where the barcode begins	0 to 65535 units
  XDot	5 Digit Number	The X size of a single element in dots	0 to 65535
  YDot	5 Digit Number	The Y size of a single element in dots	0 to 65535
  Columns	5 Digit Number	Specifies the number of columns to use.	1 to 30
  Rows	5 Digit Number	Specifies the number of rows to use.	0 to 90
  ECC	5 Digit Number	Specifies the error recovery level.	1 to 8
  BinaryMode	Single Digit	Force binary compaction mode	0 or 1
  Data	Raw String	The data to be encoded in the barcode.	See below.

• Sample Code (Swift)

   
  1
  cpclLabel(offset: 0, hRes: 200, vRes: 200, height: 210, quantity: 1)
  2
  cpclCenter()
  3
  cpclBarcodePDF417(xPos: 10, yPos: 20, XDot: 3, YDot: 6, columes: 3, rows: 3, ecc: 2, binaryModel: 1)
  4
  cpclBarcodePDF417Data("pdf-417 data")
  5
  cpclBarcodePDF417End()
  6
  cpclText(rotate: 0, font: 1, fontSize: 0, x: 10, y: 120, text: "pdf data")
  7
  cpclText(rotate: 0, font: 1, fontSize: 0, x: 10, y: 160, text: "abcde123456")
  8
  cpclPrint()
  9
  cpclLabel(offset: 0, hRes: 200, vRes: 200, height: 400, quantity: 1)
  10
  cpclBarcodePDF417Vertical(xPos: 30, yPos: 400, XDot: 3, YDot: 6, columes: 3, rows: 3, ecc: 3, binaryModel: 1)
  11
  cpclBarcodePDF417Data("pdf data vertical")
  12
  cpclBarcodePDF417End()
  13
  cpclText(rotate: 90, font: 1, fontSize: 0, x: 120, y: 400, text: "pdf data")
  14
  cpclText(rotate: 90, font: 1, fontSize: 0, x: 170, y: 400, text: "abcde123456")
  15
  cpclPrint()
  

  ​

1.2.6 QR Code

• Function

  • The BARCODE QR command is used to print QR Code barcodes in the CPCL language.
  • VBARCODE QR is identical to BARCODE, except it is oriented vertically.
  • Note that this command has optional parameters M, U. In order to use these parameters, the M or U character must be followed by a space, then a number which complies with the table below.

• Swift (iOS)

  public func cpclBarcodeQRcode(xPos xPos: Int, yPos: Int, model: Int, unitWidth: Int)
  public func cpclBarcodeQRcodeVertical(xPos xPos: Int, yPos: Int, model: Int, unitWidth: Int, config: Int, barcodeQRcode: String)
  public func cpclBarcodeQRcodeData(barcodeQRcode: String, config: String)
  public func cpclBarcodeQRcodeEnd()

• Parameter

  Parameter	Type	Description	Valid Range
  X	5 Digit Unit Number	The X position where the barcode begins	0 to 65535 units
  Y	5 Digit Unit Number	The Y position where the barcode begins	0 to 65535 units
  Model	5 Digit Number	The ratio of wide to narrow bars.	1 or 2
  Width	5 Digit Number	Unit-width of the barcode in dots	0 to 65535 dots
  Config	Raw String	Configuration options for barcode	See Below.
  Data	Raw String	Data for barcode	See Below.

• Sample Code (Swift)

   
  1
  cpclLabel(offset: 0, hRes: 200, vRes: 200, height: 500, quantity: 1)
  2
  cpclBarcodeQRcode(xPos: 50, yPos: 50, model: 2, unitWidth: 5)
  3
  cpclBarcodeQRcodeData("AQR code ABC123,N9876", config: "MM")
  4
  cpclBarcodeQRcodeEnd()
  5
  cpclPrint()
  6
  cpclLabel(offset: 0, hRes: 200, vRes: 200, height: 210, quantity: 1)
  7
  cpclBarcodeQRcode(xPos: 50, yPos: 50, model: 2, unitWidth: 10)
  8
  cpclBarcodeQRcodeData("AQR code ABC123,N9876", config: "MM")
  9
  cpclBarcodeQRcodeEnd()
  10
  cpclPrint()
  

  ​

1.3 Barcode Text

• Function

  BARCODE-TEXT is used to specify if a human-readable text representation of barcode data should be printed below 1D barcodes. This text is applied for both line-print and label-based barcodes.

• Swift (iOS)

   
  1
  // print annotation text line
  2
  public func cpclBarcodeText(font font: Int, fontSize: Int, offset: Int)
  3
  public func cpclBarcodeText(trueTypeFont trueTypeFont: Int, xScale: Int, yScale: Int, offset: Int)
  4
  // close annotation text line
  5
  public func cpclBarcodeTextOff()
  

• Parameter

  • Pre-scaled Font Syntax

  Parameter	Type	Description	Range
  FontNameOrNumber	Space-Terminated String	A font name or number to create the representation	See Below.
  FontSize	3 Digit Number	The size of the font.	0 to 999
  Offset	3 Digit Unit Number	How far in units the text is from the barcode	0 to 999

  • Alternate Syntax – TTF Font Syntax

  Parameter	Type	Description	Range
  TrueTypeFontName	Space-Terminated String	The filename of the TTF font with extension	See Below.
  XScale	3 Digit Number	The X size of the font, in dots.	0 to 999
  YScale	3 Digit Number	The Y size of the font, in dots	0 to 999
  Offset	3 Digit Unit Number	How far in units the text is from the barcode	0 to 999

• Sample Code (Swift)

   
  1
  cpclLabel(offset: 0, hRes: 200, vRes: 200, height: 400, quantity: 1)
  2
  cpclCenter()
  3
  cpclBarcodeText(font: 4, fontSize: 0, offset: 10)
  4
  cpclBarcode(type: CPCLBarcodeType.Code128.rawValue, width: 1, ratio: 1, height: 50, x: 0, y: 20, barcode: "barcode data")
  5
  cpclBarcodeVertical(type: "128", width: 1, ratio: 1, height: 50, x: 0, y: 390, barcode: "barcode data")
  6
  cpclBarcodeTextOff()
  7
  cpclPrint()
  

  ​

1.4 Bat-Indicator

• Function

  BAT-INDICATOR is used to print a graphical representation of the current charge state of the battery on a label.The BAT-INDICATOR command takes a series of optional parameters to specify its size and configuration.

• Swift (iOS)

   
  1
  public func cpclBatIndicator(xPos xPos: String, yPos: String)
  

• Parameter

  Parameter	Type	Description	Valid Range
  X	5 Digit Unit Number	The X origin of the graphic.	0 to 65535
  Y	5 Digit Unit Number	The Y origin of the graphic.	0 to 65535

• Sample Code

1.5 Box

• Function

  The BOX command is used to draw a box.By default, BOX draws a box in solid black, but the pattern used to fill the box can be changed with the PATTERN command.The BOX command can be used with the justify commands CENTER, LEFT and RIGHT to align the box.

• Swift (iOS)

   
  1
  public func cpclBox(xPos xPos: Int, yPos: Int, xEnd: Int, yEnd: Int, thickness: Int)
  

• Parameter

  Parameter	Type	Description	Valid Range
  X	5 Digit Unit Number	The X origin of the box.	0 to 65535
  Y	5 Digit Unit Number	The Y origin of the box.	0 to 65535
  EndX	5 Digit Unit Number	The X coordinate where the box ends.	0 to 65535
  EndY	5 Digit Unit Number	The Y coordinate where the box ends.	0 to 65535
  Thickness	5 Digit Unit Number	The thickness of the lines in the box.	0 to 65535

• Sample Code

   
  1
  cpclLabel(offset: 0, hRes: 200, vRes: 200, height: 210, quantity: 1)
  2
  cpclBox(xPos: 0, yPos: 0, xEnd: 200, yEnd: 200, thickness: 1)
  3
  cpclPrint()
  4
  cpclLabel(offset: 0, hRes: 200, vRes: 200, height: 210, quantity: 1)
  5
  cpclBox(xPos: 0, yPos: 0, xEnd: 200, yEnd: 200, thickness: 2)
  6
  cpclPrint()
  7
  cpclLabel(offset: 0, hRes: 200, vRes: 200, height: 210, quantity: 1)
  8
  cpclBox(xPos: 0, yPos: 0, xEnd: 200, yEnd: 200, thickness: 3)
  9
  cpclPrint()
  

  ​

1.6 CompressedGraphics

• Function

  The COMPRESSED-GRAPHICS command is used to print raw binary bitmap data to the label. COMPRESSED-GRAPHICS is the same except it is oriented vertically. The data itself is not compressed per say, it is just more efficiently represented than in the EXPANDED- GRAPHICS command. The binary data is not compressed in this command.

• Swift (iOS)

   
  1
  public func cpclCompressedGraphics(imageWidth imageWidth: Int, imageHeight: Int, x: Int, y: Int, bitmapData: NSData)
  2
  public func cpclCompressedGraphicsVertical(byteWidth byteWidth: Int, height: Int, x: Int, y: Int, bitmapData: NSData)
  

• Parameter

  Parameter	Type	Description	Valid Range
  ByteWidth	3 Digit Number	The byte width of the image being transmitted.	0 to 999
  Height	5 Digit Unit Number	The height of the data to follow in units.	0 to 65535
  X	5 Digit Unit Number	The X origin of the graphic.	0 to 65535
  Y	5 Digit Unit Number	The Y origin of the graphic.	0 to 65535
  Data	Raw String	The data that makes up the bitmap to be printed.	See below.

• Sample Code

1.7 Concat

• Function

  The CONCAT command is used to concatenate multiple fonts and sizes of text on to a single line, and to align their top-lines in a specific way. The command starts with a CONCAT command, followed by one or more sub-commands. Each sub-command adds more text onto the concatenation from left to right.

• Swift (iOS)

   
  1
  // Concat Begin (Master Syntax)
  2
  public func cpclConcatStart(xPos xPos: Int, yPos: Int)
  3
  public func cpclConcatVerticalStart(xPos xPos: Int, yPos: Int)
  4
  // FontNameOrNumber
  5
  public func cpclConcatText(font font: Int, fontSize: Int, offset: Int, text: String)
  6
  // Sub-Command – Scale-Text 
  7
  public func cpclConcatScaleText(scaledFont scaledFont: Int, xScale: Int, yScale: Int, offset: Int, text: String)
  8
  public func cpclConcatScaleTextVertical(scaledFont scaledFont: Int, xScale: Int, yScale: Int, offset: Int, text: String)
  9
  // Sub-command – Font-Group
  10
  public func cpclConcatText(fontGroup fontGroup: Int, offset: Int, text: String)
  11
  // Concat End
  12
  public func cpclConcatEnd()
  

• Parameter

  • Master Syntax

    Parameter	Type	Description	Valid Range
    X	5 Digit Unit Number	The X origin of the text string.	0 to 65535
    Y	5 Digit Unit Number	The Y origin of the text string.	0 to 65535

  • FontNameOrNumber

    Parameter	Type	Description	Valid Range
    FontNameOrNumber	Space-Terminated String	A font name or number to create the text.	See Below.
    FontSize	5 Digit Number	The size of the pre-scaled font.	0 to 65535
    Offset	5 Digit Unit Number	How far from Y is the top of this text?	0 to 65535
    Data	CR-LF Terminated String	The text data to be concatenated.	Up to 2024 characters1

  • Sub-Command – Scale-Text

    Parameter	Type	Description	Valid Range
    ScaledFontName	Space-Terminated String	A scaled font used to create the text.	See Below.
    XPoints	5 Digit Number	The X size of the scaled font, in points.	0 to 65535
    YPoints	5 Digit Number	The Y size of the scaled font, in points.	0 to 65535
    Offset	5 Digit Unit Number	How far from Y is the top of this text?	0 to 65535
    Data	CR-LF Terminated String	The text data to be concatenated.	Up to 2024 characters1

  • Sub-command – Font-Group

    Parameter	Type	Description	Valid Range
    FontGroupNumber	Space-Terminated String	The number of the font-group to use	0 to 10
    Offset	5 Digit Unit Number	How far from Y is the top of this text?	0 to 65535
    Data	CR-LF Terminated String	The text data to be concatenated.	Up to 2024 characters1

• Sample Code (Swift)

   
  1
  cpclLabel(offset: 0, hRes: 200, vRes: 200, height: 210, quantity: 1)
  2
  cpclText(rotate: 0, font: 0, fontSize: 2, x: 0, y: 0, text: "concat command")
  3
  cpclConcatStart(xPos: 0, yPos: 90)
  4
  cpclConcatText(font: 4, fontSize: 0, offset: 10, text: "$")
  5
  cpclConcatText(font: 4, fontSize: 1, offset: 20, text: "12")
  6
  cpclConcatText(font: 1, fontSize: 2, offset: 30, text: "34")
  7
  cpclConcatText(font: 8, fontSize: 0, offset: 60, text: "Hello")
  8
  cpclConcatText(font: 9, fontSize: 1, offset: 90, text: "World")
  9
  cpclConcatEnd()
  10
  cpclPrint()
  

  ​

1.8 Count

• Function

  • The COUNT command is used to increment or decrement a field on a label when the labels are printed in a batch, that is with a quantity greater than one on in the label session definition.
  • COUNT fields are not cleared at the start of each new label session. If you try to use COUNT on an unsupported field, or use COUNT without a field, and you previously adjusted a field successfully, the old field definition will be used for the second label and on in the batch (adjusts don’t take effect until the second label)
  • No more than 30 COUNT commands can appear in a single label session. Any beyond this amount will have no effect.

• Swift (iOS)

   
  1
  // 计数，加减条码文本数据段数值
  2
  public func cpclCount(adjust: Int)
  

• Parameter

  Parameter	Type	Description	Valid Range
  Adjust	Terminated String	The amount to adjust the field.	Up to 20 ASCII digits, signed

• Sample Code

   
  1
  cpclLabel(offset: 0, hRes: 200, vRes: 200, height: 210, quantity: 3)
  2
  cpclAnnotation("Print 3 labels")
  3
  cpclCenter()
  4
  cpclText(rotate: 0, font: 4, fontSize: 0, x: 0, y: 50, text: "testing 001")
  5
  cpclCount(1) // 计数，加减条码文本数据段数值
  6
  cpclText(rotate: 0, font: 4, fontSize: 0, x: 0, y: 100, text: "barcode value is 123456789")
  7
  cpclCount(-10)
  8
  cpclBarcode(type: CPCLBarcodeType.Code128.rawValue, width: 1, ratio: 1, height: 50, x: 0, y: 150, barcode: "{A123456789")
  9
  cpclCount(-10)
  10
  cpclPrint()
  

  ​

1.9 End/Print

• Function

  • PRINT, and its alias END is used to terminate a CPCL label session, and create the resulting print out.
  • Every CPCL label session must be terminated with a PRINT command.
  • Every example for this section uses the PRINT command to terminate labels.

• Swift (iOS)

   
  1
   // 功能完全一样，End 是 Print 的别名
  2
   public func cpclPrint()
  3
   public func cpclEnd()
  

• Sample Code (Swift)

   
  1
  cpclLabel(offset: 0, hRes: 200, vRes: 200, height: 210, quantity: 1)
  2
  cpclCenter()
  3
  cpclText(rotate: 0, font: 4, fontSize: 0, x: 10, y: 0, text: "This is a ! command.")
  4
  cpclPrint()
  

  ​

1.10 ExpandedGraphics

• Function

  • The EXPANDED-GRAPHICS command is used to print ASCII encoded bitmap data to the label.

  EXPANDED-GRAPHICS is the same except it is oriented vertically.

  • Unless the communication method does not permit the use of binary data, graphical data is more efficiently represented by using the COMPRESSED-GRAPHICS command.

• Swift (iOS)

   
  1
  public func cpclExpandedGraphics(byteWidth byteWidth: Int, height: Int, xPos: Int, yPos: Int, bitmapData: NSData)
  2
  public func cpclExpandedGraphicsVertical(byteWidth byteWidth: Int, height: Int, xPos: Int, yPos: Int, bitmapData: NSData)
  

• Parameter

  Parameter	Type	Description	Valid Range
  ByteWidth	3 Digit Number	The byte width of the image being transmitted.	0 to 999
  Height	5 Digit Number	The height of the data to follow in units.	0 to 65535
  X	5 Digit Number	The X origin of the graphic.	0 to 65535
  Y	5 Digit Number	The Y origin of the graphic.	0 to 65535
  Data	Raw String	The data that makes up the bitmap to be printed.	See below.

• Sample Code

1.11 FontGroup

• Function

  • FONT-GROUP is used to define groups of pre-scaled fonts which can be used to for automatic font size calculation when used with various text commands in CPCL.
  • Up to a total of 10 font groups can be defined, numbering from 0 to 9. Each FONT-GROUP command defines a single font group, which an in turn contain up to 10 pairs of font name or number and size values. These values are repeated as many times as desired in the FONT-GROUP command before being CR-LF terminated. At least one pair must be specified to define the group, though two or more is recommended.
  • When a text command using a font group is used, the printer will automatically select a font from the font group which allows the text to fit in the area from the X and Y coordinates specified in the text command to the edge of the label area as defined by the PAGE-WIDTH command.
  • In order to make the text fit, the printer can not only select any of the fonts, but can change the spacing of the font, decreasing the space between characters to attempt to make it fit. If, even after decreasing the spacing to a minimal amount, the text will not fit, the text command is aborted and no text is printed all for that text command.
  • Font groups are supported in the TEXT and CONCAT commands in CPCL. Font groups do work with the MULTILINE command, however only one member of the font group is selected for the entire MULTI-LINE set, based on the font size needed for the widest line of text in the MULTI-LINE group.
  • Once defined in a label or utilities session, a font group remains defined until power is cycled. By default at power on, no font groups are defined.

• Swift (iOS)

   
  1
  public func cpclFontGroup(group: Int, font: Int, size: Int)
  

• Parameter

  Parameter	Type	Description	Valid Range
  Group	5 Digit Number	Specifies the group number to define	0 to 9
  FontNameOrNumber	Space-Terminated String	A font name or number to create the representation	See Below.
  FontSize	5 Digit Number	The size of the font.	0 to 65535

• Sample Code

1.12 Image

• Function

  • IMAGE is used to change the drawing method of pre-scaled text commands and LINE commands.
  • By default, image data drawn to a label ORed with existing label data, that is if there is already a black dot at the location being drawn to, the dot will continue to appear black.
  • By using the IMAGE command, you can change this behavior to XOR new drawing with existing label data, which means that if there is an existing black dot at the location being drawn to, the dot will be erased and replaced with a white dot.
  • IMAGE is persistent between labels, with the most recent setting in either a label or utilities session taking precedence. It can be changed as many times as needed per label.

• Swift (iOS)

   
  1
  public func cpclImageMode(mode: String)
  

• Parameter

  Parameter	Type	Description	Valid Range
  Mode	CR-LF Terminated String	Specifies the drawing mode	OR or XOR

• Sample Code

1.13 Centimeters, Dots, Inches, Millimeters

• Function

  • The various IN- commands change the system of measurement for all parameters in CPCL which are identified as unit numbers to centimeters. At the beginning of each new label, the system is reset to dots (the equivalent of the IN-DOTS command).
  • If any of these commands are the very first one in a label session, the session definition’s height parameter is re-evaluated in the new system of measurement. Otherwise the command only affects subsequent fields in the label session.
  • You can change the system of measurement as many times as necessary per label.

• Swift (iOS)

   
  1
  public func cpclInCentimeters()
  2
  public func cpclInDots()
  3
  public func cpclInChes()
  4
  public func cpclInMillimeters()
  

• Parameter

  Requested Unit	Conversion Factor to Dots
  Dots (Default)	1
  Centimeters	80
  Millimeters	8
  Inches	203.2

• Sample Code

1.14 InverseLine

• Function

  • The INVERSE-LINE command is used to draw a line which inverts the label area over which it is drawn.
  • LINE has two modes of operation based on whether or not one side of the line is flat.
  • If the line is straight (X and EndX are the same or Y and EndY are the same), you can align the line using the CENTER, LEFT and RIGHT commands.
  • If the line is diagonal, it cannot be aligned or filled.

• Swift (iOS)

   
  1
  public func cpclInverseLine(xPos xPos: Int, yPos: Int, xEnd: Int, yEnd: Int, thickness: Int)
  2
  public func cpclReverseLine(xPos xPos: Int, yPos: Int, xEnd: Int, yEnd: Int, thickness: Int)
  

• Parameter

  Parameter	Type	Description	Valid Range
  X	5 Digit Unit Number	The X origin of the line.	0 to 65535
  Y	5 Digit Unit Number	The Y origin of the line.	0 to 65535
  EndX	5 Digit Unit Number	The X coordinate where the line ends.	0 to 65535
  EndY	5 Digit Unit Number	The Y coordinate where the line ends.	0 to 65535
  Thickness	5 Digit Unit Number	The thickness of the line.	0 to 65535

• Sample Code

1.15 Left, Center, Right

• Function

  • The LEFT command is used to change the justification of supported fields. It is part of a series of justification commands which includes LEFT, CENTER and RIGHT.
  • LEFT is the default justification for labels. Each time a new label session is started, it is set to LEFT alignment (specifically LEFT 0). Once used, LEFT is persistent within the label session.

• Swift (iOS)

   
  1
  public func cpclLeft(range: Int)
  2
  public func cpclLeft()
  3
  ​
  4
  public func cpclCenterWithRange(range: Int)
  5
  public func cpclCenter()
  6
  ​
  7
  public func cpclRight(range: Int)
  8
  public func cpclRight()
  

• Parameter

  Parameter	Type	Description	Valid Range
  Range	5 Digit Unit Number	Sets FONT-GROUP field width.	0 to 65535

• Mark

  The following commands support justification：

  BARCODE (all 1D types)	BARCODE MAXICODE	BOX
  CONCAT	INVERSE-LINE, REVERSE-LINE	LINE
  PCX, PCX90, PCX180, PCX270	PCXMAG	SCALE-TEXT
  SCALE-TO-FIT	TEXT, TEXT90, TEXT180, TEXT270	COMPRESSED-GRAPHICS, EXPANDED- GRAPHICS

• Sample Code (Swift)

   
  1
  cpclLabel(offset: 0, hRes: 200, vRes: 200, height: 500, quantity: 1)
  2
  cpclCenter()
  3
  cpclText(rotate: 0, font: 4, fontSize: 0, x: 0, y: 0, text: "center")
  4
  cpclLeft()
  5
  cpclText(rotate: 0, font: 4, fontSize: 0, x: 0, y: 50, text: "left")
  6
  cpclRight()
  7
  cpclText(rotate: 0, font: 4, fontSize: 0, x: 0, y: 100, text: "right")
  8
  cpclCenterWithRange(200)
  9
  cpclText(rotate: 0, font: 4, fontSize: 0, x: 0, y: 150, text: "center 200")
  10
  cpclRight(200)
  11
  cpclText(rotate: 0, font: 4, fontSize: 0, x: 0, y: 200, text: "right 200")
  12
  cpclLeft()
  13
  cpclText(rotate: 0, font: 4, fontSize: 0, x: 0, y: 250, text: "left 200")
  14
  cpclPrint()
  

  ​

1.16 Line

• Function

  • The LINE command is used to draw a line.
  • LINE has two modes of operation based on whether or not one side of the line is flat.
  • If the line is straight (X and EndX are the same or Y and EndY are the same), you can align the line using the CENTER, LEFT and RIGHT commands. You can also use the PATTERN command to fill the line with a pattern. The PATTERN command can be used to create white lines.
  • If the line is diagonal, it cannot be aligned or filled.

• Swift (iOS)

   
  1
  public func cpclLine(xPos xPos: Int, yPos: Int, xEnd: Int, yEnd: Int, thickness: Int)
  

• Parameter

  Parameter	Type	Description	Valid Range
  X	5 Digit Unit Number	The X origin of the line.	0 to 65535
  Y	5 Digit Unit Number	The Y origin of the line.	0 to 65535
  EndX	5 Digit Unit Number	The X coordinate where the line ends.	0 to 65535
  EndY	5 Digit Unit Number	The Y coordinate where the line ends.	0 to 65535
  Thickness	5 Digit Unit Number	The thickness of the line.	0 to 65535

• Sample Code

1.17 Move

• Function

  • The MOVE command moves the origin of a label. The effect is most pronounced when using a media that synchronizes to marks. It does affect continuous mode labels, but the effects may be difficult to see, particularly with the MoveUp parameter.

  • The values specified by MOVE are added to those specified by TEMP-MOVE to determine the final position. Note that TEMP-MOVE and MOVE are both negative aware. This means that if a MOVE 20 20 was in effect, and a TEMP-MOVE -20 -20 was also in effect, the net location used would be 0,0.
  • The MOVE command is available in both label and utilities sessions and is persistent between labels, but is reset when the printer is power cycled.

• Swift (iOS)

   
  1
  public func cpclMove(right right: String, up: String)
  

• Parameter

  Parameter	Type	Description	Valid Range
  MoveRight	5 Digit Unit Number	How far to move the label to the right.	0 to 65535
  MoveUp	5 Digit Unit Number	How far to move the label up.	0 to 65535

• Sample Code

1.18 Multi-Line

• Function

  • The MULTILINE command is used to print a number of lines of text using the same font without having to manually specify the spacing or positioning of each line.
  • The basic format of the command is the MULTILINE command followed by LineHeight and then a fully formed text command without its final parameter which would specify the data to print, followed by a CR and LF.
  • After that, as many Data lines as necessary can be specified without limit. Each field will be printed as if it was an individual text command, with the vertical position increasing by LineHeight for each line.

• Swift (iOS)

   
  1
  public func cpclMultiLineStart(lineHeight lineHeight: Int)
  2
  ...
  3
  public func cpclInsertTextLine(textLine: String)
  4
  ...
  5
  public func cpclMultiLineEnd()
  

• Parameter

  Parameter	Type	Description	Valid Range
  LineHeight	5 Digit Unit Number	Spacing between each line in units.	0 to 65535
  TextCommand	Command	A command specifying formatting for the text.	See Below.
  Data	CR-LF Terminated String	A text line to print using the formatting.	See Below.

• Mark

  the following text commands are supported for use with MULTILINE.

  • TEXT, TEXT90, TEXT180, TEXT270, VTEXT, T, T90,T180,T270, VT
  • SCALE-TO-FIT, VSCALE-TO-FIT, STF, VSTF
  • SCALE-TEXT, VSCALE-TEXT, ST, VST

• Sample Code

   
  1
  cpclLabel(offset: 0, hRes: 200, vRes: 200, height: 228, quantity: 1)
  2
  cpclMultiLineStart(lineHeight: 40)
  3
  cpclText(rotate: 0, fontGroup: 1, x: 0, y: 0, text: "10")
  4
  cpclInsertTextLine("line 1")
  5
  cpclInsertTextLine("line 2")
  6
  cpclInsertTextLine("line 3")
  7
  cpclInsertTextLine("line 4")
  8
  cpclMultiLineEnd()
  9
  cpclPrint()
  

  ​

1.19 Page Width

• Function

  • The PAGE-WIDTH command is used to specify the width a label session. The height of the session is defined in the session header.
  • Some printers have built-in sensors to detect the width of the currently installed media. If this sensor is installed and enabled, setting a PAGE-WIDTH of 0 will use the detected media width for the label.
  • The PAGE-WIDTH command must either be used in a utilities session, or before any command which creates output on the label is used. If used in a label session, it should be the first command after the session line (or the second if you are using a units command such as IN-CENTIMERES to modify the session line).
  • It is not recommended to change PAGE-WIDTH once you have started drawing to the label, as any fields drawn so far will become corrupted.

• Swift (iOS)

   
  1
  public func cpclPageWidth(width: Int)
  

• Parameter

  Parameter	Type	Description	Valid Range
  Width	5 Digit Unit Number	Spacing between each line in units.	0 to 65535

• Sample Code

1.20 Pattern

• Function

  • The PATTERN command is used to change the fill patterns of the SCALE-TEXT and SCALE-TO-FIT (when using CSF fonts only), some LINE commands (must be horizontal or vertical lines), and all BOX commands.

  • By default and at the start of each label session, PATTERN is set to 100, which is solid black. PATTERN is persistent within the same label session.
  • Lines or boxes drawn with PATTERN values besides 100 start and end one dot higher than their pixel position indicates. This behavior does not occur with SCALE-TEXT.

• Swift (iOS)

   
  1
  public func cpclPatternNumber(patternNumber: Int)
  

• Parameter

  Parameter	Type	Description	Valid Range
  Pattern	5 Digit Number	The pattern number to use	0 to 106

• Sample Code

1.21 PCX

• Function

  • The PCX command is used to print a ZSoft PCX file.
  • The PCX file must be a 2-color, 1-plane RLE-encoded PCX file. If it is not, command is aborted and the binary data of the PCX flows into the label data, often causing the printer to enter an unpredictable state.
  • PCX supports the justification commands LEFT, RIGHT and CENTER, but if the PCX is too wide to fit on the current label (as determined with PAGE-WIDTH), no image will be printed at all. This does not occur if the image is too tall – it will be properly clipped in this case.
  • The origins of the rotated versions of the PCX commands (PCX90, PCX180 and PCX270) do not use the same math for their origins as TEXT and other commands do. See the example for more details.

• Swift (iOS)

   
  1
  public func cpclPCX(rotation rotation: Int, xPos: Int, yPos: Int, bitmapData: NSData)
  

• Parameter

  Parameter	Type	Description	Valid Range
  X	5 Digit Unit Number	The X origin of the PCX.	0 to 65535
  Y	5 Digit Unit Number	The Y origin of the PCX.	0 to 65535
  Data	Raw String	Binary data containing the PCX file	See below.

• Sample Code

1.22 PCXMAG

• Function

  • The PCXMAG command is used to print a ZSoft PCX file that has been magnified vertically and horizontally.
  • The requirements for the PCX file itself are identical to the PCX command. The only difference between this command and PCX is the addition of the magnification parameters.
  • PCXMAG supports the justification commands LEFT, RIGHT and CENTER. Unlike with PCX, if the image flows off the right side of the page, it does not wrap, the remainder of the image data is disposed of.
  • If the unscaled image is too wide to fit on the page (as defined by page width), no image will be printed.
  • The use of alignment commands (RIGHT and CENTER) with PCXMAG is not supported.

• Swift (iOS)

   
  1
  public func cpclPCXMAG(xPos xPos: Int, yPos: Int, XMag: Int, YMag: Int, bitmapData: NSData)
  

• Parameter

  Parameter	Type	Description	Valid Range
  X	5 Digit Unit Number	The X origin of the PCX.	0 to 65535
  Y	5 Digit Unit Number	The Y origin of the PCX.	0 to 65535
  XMag	5 Digit Unit Number	The X magnification factor of the PCX	0 to 65535
  YMag	5 Digit Unit Number	The Y magnification factor of the PCX	0 to 65535
  Data	Raw String	Binary data containing the PCX file	See below.

• Sample Code

1.23 Persist

• Function

  • PERSIST is used to determine if label memory is erased at the end of each label session. By default, when a label session ends, the label memory is cleared. This option can be changed so that the image of the last label is retained and merged with any subsequent label commands.

  • The setting is preserved between label sessions, but is always set to OFF at startup.

• Swift (iOS)

   
  1
  public func cpclPersist(option: String)
  

• Parameter

  Parameter	Type	Description	Valid Range
  Option	Terminated String	When set to ON, label images persist	ON or OFF

• Sample Code

1.24 Rotate

• Function

  • The ROTATE command is used to specify the rotation of a scalable or TrueType font within the printer.
  • ROTATE can also be used with any of these commands when they are part of a MULTI-LINE session, but not within the MULTI-LINE session itself.
  • For all of these commands, if the rotated text extends off the top or right edge of the label, the text will be truncated, and the final character on the line may not be fully formed. In the left and bottom direction, a fully formed partial character will be printed instead.
  • SCALE-TO-FIT and CONCAT does not support use of the ROTATE command with TrueType fonts.

• Swift (iOS)

   
  1
  public func cpclRotate(degrees: Int)
  

• Parameter

  Parameter	Type	Description	Valid Range
  Degrees	5 Digit Number	The number of degrees to rotate counter-clockwise	0 to 65535

• Mark

  The following commands support rotation

  • CONCAT, VCONCAT
  • SCALE-TEXT, VSCALE-TEXT
  • SCALE-TO-FIT, VSCALE-TO-FIT

• Sample Code

1.25 Scale Text

• Function

  • The SCALE-TEXT command is used print scaled text in CPCL from either a scaled or TrueType font.
  • VSCALE-TEXT has the same functionality, but orients the text rotated 90 degrees.
  • When the text generated by SCALE-TEXT flows off the edge of the page, it does not wrap. On the top edge it is truncated to the nearest character that will fully fit (when using VSCALE-TEXT). On the right edge, it is truncated to at the last pixel of the page width, including any partial characters.

• Swift (iOS)

   
  1
  public func cpclScaleText(scaledFont: String, xScale: Int, yScale: Int, x: Int, y: Int, text:String)
  2
  public func cpclScaleTextVertical(scaledFont: String, xScale: Int, yScale: Int, x: Int, y: Int, text:String)
  

• Parameter

  Parameter	Type	Description	Valid Range
  ScaledFontName	Space-Terminated String	A scaled font used to create the text.	See Below.
  XPoints	5 Digit Number	The X size of the scaled font, in points.	0 to 65535
  YPoints	5 Digit Number	The Y size of the scaled font, in points.	0 to 65535
  X	5 Digit Unit Number	The X origin of the scaled text in units.	0 to 65535
  Y	5 Digit Unit Number	The Y origin of the scaled text in units.	0 to 65535
  Data	CR-LF Terminated String	The text data to be printed.	Up to 8191 characters.

• Sample Code

1.26 Scale To Fit

• Function

  • The SCALE-TO-FIT command is used print scaled text which is to fit within a particular bounding box in CPCL. The command is similar in syntax to the SCALE-TEXT command, but the difference is that the sizing parameters XScale and YScale are now replaced with Width and Height. The font’s vertical and horizontal size will be selected to fit within the box specified.
  • SCALE-TO-FIT can be used with TrueType or scaled fonts.
  • VSCALE-TO-FIT has the same functionality, but orients the text rotated 90 degrees.
  • Because SCALE-TO-FIT can only contain a single line of text, the height of the output text is always Height.

• Swift (iOS)

   
  1
  public func cpclScaleToFit(scaleFont: String, width: Int, height: Int, x: Int, y: Int, text: String)
  

• Parameter

  Parameter	Type	Description	Valid Range
  ScaledFontName	Space-Terminated String	A scaled font used to create the text.	See Below.
  Width	5 Digit Unit Number	The width of the box to contain the text.	0 to 65535
  Height	5 Digit Unit Number	The height of the box to contain the text.	0 to 65535
  X	5 Digit Unit Number	The X origin of the scaled text in units.	0 to 65535
  Y	5 Digit Unit Number	The Y origin of the scaled text in units.	0 to 65535
  Data	CR-LF Terminated String	The text data to be printed.	Up to 8191 characters.

• Sample Code

1.27 Set Bold

• Function

  • SET BOLD is used to add a faux bolding effect to pre-scaled fonts in CPCL. It accomplishes this by redrawing the text one or more times, shifting one pixel to the right side of the page each time. The spacing of the characters does not change as a result of the bolding.
  • The number of shifts and writes is specified by the Boldness parameter.
  • The command affects any pre-scaled text drawing in CPCL, no matter what command it comes from.

• Swift (iOS)

   
  1
  public func cpclSetBold(boldness: Int)
  

• Parameter

  Parameter	Type	Description	Valid Range
  Boldness	3-digit Unit Number	Sets the boldness of the text.	0 to 999

• Sample Code

1.28 Set Mag

• Function

  • SETMAG is used to set the output scaling of pre-scaled fonts, overriding the sizing behaviors defined in the font files themselves. When a non-zero value for SETMAG is used, that value replaces that element in the sizing of all pre-scaled fonts, regardless of what command is used to draw them.
  • SETMAG’s value is preserved between labels, and also shared with line print mode.

• Swift (iOS)

   
  1
  public func cpclSetMag(width width: Int, height: Int)
  

• Parameter

  Parameter	Type	Description	Valid Range
  Width	3-digit Number	Sets the width multiplier of the font.	0 to 16
  Height	3-digit Number	Sets the height multiplier of the font.	0 to 127

• Sample Code

   
  1
  cpclLabel(offset: 0, hRes: 200, vRes: 200, height: 500, quantity: 1)
  2
  cpclText(rotate: 0, font: 0, fontSize: 0, x: 0, y: 0, text: "Text")
  3
  cpclText(rotate: 0, font: 0, fontSize: 1, x: 0, y: 30, text: "T90")
  4
  cpclText(rotate: 0, font: 0, fontSize: 2, x: 0, y: 90, text: "T180")
  5
  cpclText(rotate: 0, font: 0, fontSize: 3, x: 0, y: 120, text: "T270")
  6
          
  7
  cpclSetMag(width: 2, height: 2)
  8
  cpclText(rotate: 0, font: 0, fontSize: 0, x: 0, y: 180, text: "text")
  9
  cpclText(rotate: 0, font: 0, fontSize: 1, x: 0, y: 250, text: "T90")
  10
  cpclText(rotate: 0, font: 0, fontSize: 2, x: 0, y: 330, text: "T180")
  11
  cpclText(rotate: 0, font: 0, fontSize: 3, x: 0, y: 400, text: "T270")
  12
  cpclPrint()
  

  ​

1.29 Set Spacing

• Function

  • SETSP is used to set the horizontal spacing between characters. The command adjusts the spacing of both pre-scaled and scaled fonts. The command can only increase the spacing between characters, it cannot decrease it.
  • If the spacing is large enough, this may cause the text to flow off the edge of the page. In this case, what happens to the extra text is a function of the underlying command used to print the text (i.e. wraps with TEXT, is truncated withSCALE-TEXT).
  • SETSP is not supported for TrueType fonts.
  • SETSP is reset at the start of each label to 0 for pre-scaled fonts. It is not reset for scaled fonts.

• Swift (iOS)

   
  1
  public func cpclSetSpacing(spacing: Int)
  

• Parameter

  Parameter	Type	Description	Valid Range
  Spacing	3-digit Unit Number	Sets the spacing between characters of a font	See Below.

• Sample Code

1.30 Temp Move

• Function

  • The TEMP-MOVE command moves the origin of the next or current label session. The effect is most pronounced when using a media that synchronizes to marks. It does affect continuous mode labels, but the effects may be difficult to see, particularly with the MoveUp parameter.
  • The TEMP-MOVE command is available in both label and utilities sessions, and only applies to the next or current label session. After the session ends, TEMP-MOVE is reset to zero.
  • The values specified by TEMP-MOVE are added to those specified by MOVE to determine the final position. Note that TEMP-MOVE and MOVE are both negative aware. This means that if a MOVE 20 20 was in effect, and a TEMP-MOVE -20 -20 was also in effect, the net location used would be 0,0.
  • Syntax and functionality wise, TEMP-MOVE is identical to MOVE.

• Swift (iOS)

   
  1
  public func cpclTempMove(right: Int, up: Int)
  

• Parameter

  Parameter	Type	Description	Valid Range
  MoveRight	5 Digit Unit Number	How far to move the label to the right.	0 to 65535
  MoveUp	5 Digit Unit Number	How far to move the label up.	0 to 65535

• Sample Code

1.31 Text

• Function

  • The TEXT command is used to print text in CPCL. The command can be used with both pre-scaled and TrueType fonts, but not with scalable fonts (use SCALE-TEXT for these instead). The TEXT command can also be used to print using font groups.
  • There are three syntaxes to the command. The first is for pre-scaled fonts, the second for TrueType fonts, and the third is for font group.
  • The alignment commands CENTER, LEFT and RIGHT are supported for all forms of the TEXT command.

• Swift (iOS)

   
  1
  // Pre-scaled Font Syntax
  2
  public func cpclText(rotate rotate: Int, font: Int, fontSize: Int, x: Int, y: Int, text: String)
  3
  // Alternate Syntax -TTF Font Syntax
  4
  public func cpclText(rotate rotate: Int, trueTypeFont: Int, xScale: Int, yScale: Int, x: Int, y: Int, text: String)
  5
  // Alternate Syntax -Font-Group
  6
  public func cpclText(rotate rotate: Int, fontGroup: Int, x: Int, y: Int, text: String)
  

• Parameter

  • Pre-scaled Font Syntax

    Parameter	Type	Description	Valid Range
    FontNameOrNumber	Space-Terminated String	A font name or number to create the representation	See Below.
    FontSize	5 Digit Number	The size of the font.	0 to 65535
    X	5 Digit Unit Number	The X origin of the text in units.	0 to 65535
    Y	5 Digit Unit Number	The Y origin of the text in units.	0 to 65535
    Data	CR-LF Terminated String	The text data to be printed.	Up to 8191 characters

  • Alternate Syntax – TTF Font Syntax

    Parameter	Type	Description	Valid Range
    TrueTypeFontName	Space-Terminated String	The filename of the TTF font with extension	See Below.
    XScale	5 Digit Number	The X size of the font, in dots.	10 to 1450
    YScale	5 Digit Number	The Y size of the font, in dots	10 to 1450
    X	5 Digit Unit Number	The X origin of the text in units.	0 to 65535
    Y	5 Digit Unit Number	The Y origin of the text in units.	0 to 65535
    Data	CR-LF Terminated String	The text data to be printed.	Up to 8191 characters

  • Alternate Syntax – Font-Group

    Parameter	Type	Description	Valid Range
    FontGroupNumber	Space-Terminated String	The number of the font-group to use	0 to 10
    X	5 Digit Unit Number	The X origin of the text in units.	0 to 65535
    Y	5 Digit Unit Number	The Y origin of the text in units.	0 to 65535
    Data	CR-LF Terminated String	The text data to be printed.	Up to 8191 characters

• Sample Code (Swift)

   
  1
  cpclLabel(offset: 0, hRes: 200, vRes: 200, height: 210, quantity: 1)
  2
  cpclLabel(offset: 0, hRes: 200, vRes: 200, height: 200, quantity: 1)
  3
  cpclText(rotate: 0, font: 4, fontSize: 0, x: 200, y: 100, text: "Text")
  4
  cpclText(rotate: 90, font: 4, fontSize: 0, x: 200, y: 100, text: "T90")
  5
  cpclText(rotate: 180, font: 4, fontSize: 0, x: 200, y: 100, text: "T180")
  6
  cpclText(rotate: 270, font: 4, fontSize: 0, x: 200, y: 100, text: "T270")
  7
  cpclPrint()
  

  ​

2 Line Print Commands

2.1 Left Margin

• Function

  The MARGIN command is used to offset line print printing by a fixed amount. This command affects all data printed via line print text or any utilities command which results in printout.

• Swift (iOS)

   
  1
  public func cpclLineMargin(offset: Int)
  

• Parameter

  Parameter	Type	Description	Valid Range
  Offset	3 Digit Unit Number	Specifics the distance from the left edge in units	0 to 999

• Sample Code

2.2 LF equals CRLF (Line Print)

• Function

  • the LP-LF-EQUALS-CRLF command is used to tell the printer that when printing line print text, the LF character is equivalent to the two characters CR and LF.
  • This command only applies to line print text; it has no effect on any other part of the printer’s operation.
  • The value is persistent until reboot or until changed. The default value is OFF.

• Swift (iOS)

   
  1
  public func cpclLinePrintSetLF(option: String)
  

• Parameter

  Parameter	Type	Description	Valid Range
  Option	Space terminated string	Specifies the enable or disable of the function	ON or OFF

• Sample Code

2.3 Orient (Line Print)

• Function

  • The LP-ORIENT command is used to specify if line print operates in standard mode, or in rotated mode.
  • The implementation of LP-ORIENT is such that the data received is only reversed and rotated, and as such, to create readable text, significant modification of the format of the text is required before transmission to the printer to make it readable. See the example for an indication on how to send the data.There is only one rotation supported which is 270 degrees.
  • The only other supported option is 0, which is the power on default. The value specified is retained until it is changed or the printer’s power is cycled.
  • Only line print text is affected by the LP-ORIENT command. When using LP-ORIENT 270, the LMARGIN and SETLF commands have no effect; the MARGIN is fixed at 0, and SETLF is forced to 10.
  • When using LP-ORIENT 270, the height of the page is determined by the number of lines transmitted.
  • LP-ORIENT 270 is not supported for TrueType fonts.

• Swift (iOS)

   
  1
  public func cpclLinePrintOrient(option: Int)
  

• Parameter

  Parameter	Type	Description	Valid Range
  Option	Space terminated string	Specifies the amount of rotation	0 or 270

• Sample Code

2.4 Line Print Position Adjust

• Function

  • RX, RY, and RXY are used in line print mode to specify that an element should be positioned relative to the line print text element printed. The command can be used at any time to adjust the line print cursor position, even in the middle of a string of line print characters.
  • This command only impacts line print text and the g command. It has no effect on labels or utilities-based line print commands.

• Swift (iOS)

   
  1
   public func cpclLinePrintAdjust(xPos xPos: Int)
  2
   public func cpclLinePrintAdjust(yPos yPos: Int)
  3
   public func cpclLinePrintAdjust(xPos xPos: Int, yPos: Int)
  

• Parameter

  Parameter	Type	Description	Valid Range
  XValue	5 Digit Number	Specifies the value to use for the X position	-32767 to 32767
  YValue	5 Digit Number	Specifies the value to use for the Y position	-32767 to 32767

• Sample Code

2.5 Set LF

• Function

  • SETLF is used in line print mode to set how much media is fed by the printer when the LF character is received by the printer.
  • At power on, this value is set to 10, which puts a space of 10 pixels between each row of line print printed characters. Note that this space is an addition to any space defined by the font itself, which is specified by the SETLP command on page 176. Any value set is persistent until reboot, except if the AUTOCAL command is run, which sets it to 0.
  • SETLF can perform an important function regarding the ability to print PCX images and barcodes in line print mode. When a barcode or PCX image is printed in line print, without any modifications, the maximum height of the output will be the value specified by SETLF (10 by default) plus the height value specified for SETLP (24 by default), or 34 pixels. Adjusting the SETLF value up allows a larger maximum height to be printed. See page 175 for an introduction to line print for more information.

• Swift (iOS)

   
  1
  public func cpclSetLF(height: Int)
  

• Parameter

  Parameter	Type	Description	Valid Range
  Height	5 digit Unit Number	Specifies the height fed when an LF is received	0 to 32767

• Sample Code

2.6 Set LP

• Function

  • SETLP is used to set the name or number and size of the font which is to be used for printing line print text. The font can either be a pre-scaled font or a TrueType font.
  • The default values for SETLP use the pre-scaled font syntax, and specify font number 7, size 0, and a line spacing of 24.

• Swift (iOS)

   
  1
  // Pre-Scaled Font Syntax
  2
  public func cpclSetLP(font font: Int, fontSize: Int, lineSpacing: Int)
  3
  // Alternate Syntax - TTF Font Syntax
  4
  public func cpclSetLP(trueTypeFont font: String, xScale: Int, yScale: Int, lineSpacing: Int)
  

• Parameter

  • Pre-scaled Font Syntax

    Parameter	Type	Description	Valid Range
    FontNameOrNumber	Space-Terminated String	A font name or number to create the representation	See Below.
    FontSize	3 Digit Number	The size of the font.	0 to 65535
    LineSpacing	5 Digit Unit Number	The amount of space to place between lines in units.	0 to 65535

  • Alternate Syntax – TTF Font Syntax

    Parameter	Type	Description	Valid Range
    TrueTypeFontName	Space-Terminated String	The filename of the TTF font with extension	See Below.
    XScale	5 Digit Unit Number	The X size of the font, in units.	10 to 1450 dots
    YScale	5 Digit Unit Number	The Y size of the font, in units.	10 to 1450 dots
    LineSpacing	5 Digit Unit Number	The amount of space to place between lines in units.	0 to 65535

• Sample Code

2.7 Set LP Buffer

• Function

  • SETLP-BUFFER is used to set the height of the line print buffer. This buffer represents the maximum area that can be written to in a single line print transaction.
  • Typically the size of this buffer does not require adjustment because Link-OS CPCL will seamlessly join line print buffers while printing normal text or line print graphics.
  • There are a small number of cases for which this command is needed however, such as printing a PCXor Barcode longer than the default SETLP-BUFFER size.
  • The default buffer at power on is 2400 dots. Any value set will remain active until it is changed or until reboot.

• Swift (iOS)

   
  1
  public func cpclSetLPBuffer(height: Int)
  

• Parameter

  Parameter	Type	Description	Valid Range
  Height	5 digit Unit Number	Specifies the size of the line print buffer in units.	0 to 2400 dots

• Sample Code

2.8 Set LP Timeout

• Function

  • SETLP-TIMEOUT sets how long the printer waits for additional line print text data before forcing termination and printing of un-terminated data.
  • Normally lines in line print text are terminated with a CR, an LF or a CR and LF character. If data arrives which is not terminated with a CR or LF, this timeout specifies how long the printer will wait for more data before terminating the line and printing the data.
  • Each time a character destined for line print is received, the timer is reset. In addition, the timer is reset when a line print barcode or PCXcommand is processed.
  • The default value at power on is 4 (representing 500ms). The value is persistent until power cycle or changed with this command. Setting this command to a value of 0 disables the line print timeout, and characters will be held forever until a terminator is received.

• Swift (iOS)

   
  1
  public func cpclSetLPTimeout(timeout: Int)
  

• Parameter

  Parameter	Type	Description	Range
  Timeout	5-digit Number	Specifies line print timeout in 1/8th of a second increments	0 to 99999

• Sample Code

2.9 Set Position

• Function

  • X, Y, and XY are used in line print mode to specify that an element should be positioned. The command can be used at any time to adjust the line print cursor position, even in the middle of a string of line print characters.
  • This command only impacts line print text and the g command. It has no effect on labels or utilities-based line print commands.

• Swift (iOS)

   
  1
  public func cpclSetPosition(xPos xPos: Int, yPos: Int)
  2
  public func cpclSetPosition(xPos xPos: Int)
  3
  public func cpclSetPosition(yPos yPos: Int)
  

• Parameter

  Parameter	Type	Description	Valid Range
  XValue	5 Digit Number	Specifies the value to use for the X position	-32767 to 32767
  YValue	5 Digit Number	Specifies the value to use for the Y position	-32767 to 32767

• Sample Code

2.10 Line Feed

• Function

  • is a line print character which is used to advance the cursor along the Y axis while not resetting the X axis.
  • The height advanced in the Y direction is specified by the SETLF command. By default, the value is 10,

• Swift (iOS)

   
  1
  public func cpclLineFeed()
  

• Sample Code

2.11 Carriage Return

• Function

  is a line print character which is used to advance the cursor along the Y axis and also reset the X axis to 0.

• Swift (iOS)

   
  1
  public func cpclCarriageReturn()
  

• Sample Code

2.12 Line Print Graphics

• Function

  • The g command is used to print graphics in line print mode.
  • Each g command is used to print a single pixel line of graphic data. The width of the line is specified in the first two bytes following the g command as a 16-bit integer. All current printers with CPCL only require a single byte to represent maximum width, though both bytes must be specified.
  • The design intent of the g command is that the SETLP and SETLF commands first be used to configure the total line height to 1 pixel, since each g command only prints one line at a time. g by itself will not affect any print out; the or commands must be used at the end of the line to terminate it. Generally this involves setting the LF height to 1 with the SETLF command, and setting the font height to 0 with the SETLP command. See the example below for more information.
  • The g command positions its output at the current line print cursor location. The LMARGIN, RX, RY, RXY, X, Y and XY commands can all be used to control the position of the line print cursor. The LMARGIN command is often used to avoid having to specify large blocks of blank space at the start of lines. The RY command can be used to easily skip areas of blank paper without having to send large amounts of NUL data.

• Swift (iOS)

   
  1
  public func cpclLinePrintGraphics(byteWidth byteWidth: Int, bitmapData: NSData)
  

• Parameter

  Parameter	Type	Description	Valid Range
  ByteWidth	2 Byte Binary Number	The byte width of the data for this dot line	0 to 104 in practice
  Data	Raw String	The data that makes up the bitmap to be printed.	See below.

• Sample Code

3 Font Commands

3.1 File Header

• Function

  • CPF and ECPF fonts both begin with a human readable file header, followed by binary data. The header contains identification information and the size table mentioned above. All CPF fonts begin with the text CISBF. This identifies the file as a font.
  • At startup, all files on the printer are checked for this header, and if it is found, the printer attempts to load them as CPF fonts.
  • The items beginning with a dash may appear in any order in the font file (although the –END-FONT-INF must be at the end)

• Swift (iOS)

   
  1
  public func cpclFileHeader(description description: Int, fontNumber: Int, sizeOut: Int)
  2
  public func cpclFileHeaderDefineScalingFactor(heightMult heightMult:Int, widthMult: Int, pageOffset: Int)
  3
  public func cpclEndOfHeaderDesignation()
  

• Parameter

  Field Name	Description	Type	Valid Range
  Description	Description of the font file.	Terminated String	Up to 30 characters
  FontNumber	The font number, optional.	Terminated String	8 to 63
  SizeCount	The number of entries in the sizes table.	Terminated String	1 to 255
  HeightMult	The height scaling factor of this size.	Space Terminated String	0 to 65535
  WidthMult	The width scaling factor of this size.	Space or CRLF Terminated	0 to 65535
  PageOffset	The address location of the bitmaps	4 binary bytes (uint32)	All values valid.

• Sample Code

3.2 Char Set And Country

• Function

  • This command is used to set the encoding for CPF, CSF and TTF fonts in CPCL. For more information about the various internal supported options, see the previous section.
  • Besides the list of internally supported encodings, custom encodings from ZPL can also be used in CPCL by using the filename in place of the Name option above. These files are referred to by the filename, without their extension, which must be .DAT. See the ZPL documentation for more information on custom character mappings.

• Swift (iOS)

   
  1
  public func cpclCountry(country: String)
  

• Parameter

  Name	Encoding Type
  BIG5	BIG5 Encoding. TTF maps to UTF points, multi byte.
  CHINA	EUC-CN Encoding, TTF maps to UTF points, multi byte.
  CP850	USA with substitutions, single byte. Box and graphics chars not supported.
  CP874	Font defines encoding for CPF, TTF maps to UTF points. , single byte.
  FRANCE	USA with 7-bit substitutions, single byte.
  GERMANY	USA with 7-bit substitutions, single byte.
  ITALY	USA with 7-bit substitutions, single byte.
  JAPAN	GBK Encoding, TTF maps to UTF points, multi byte.
  JAPAN-S	GBK Encoding. TTF maps to UTF points, multi byte.
  KOREA	GBK Encoding, TTF maps to UTF points, multi byte.
  LATIN9	USA with substitutions, single byte.
  NORWAY	USA with 7-bit substitutions, single byte.
  SPAIN	USA with 7-bit substitutions, single byte.
  SWEDEN	USA with 7-bit substitutions, single byte.
  THAI	Thai multi-byte encoding. Superseded by CP874.
  UK	USA with 7-bit substitutions, single byte.
  USA	Font defines encoding, single byte.
  VIETNAM	Font defines ECPF encoding, TTF maps to UTF points, multi byte.

• Sample Code

4 Media Management Commands

4.1 Auto Cal

• Function

  • The AUTODIAL command is used to calibrate the detection thresholds of the printer based on the currently selected media type.
  • By default, the printer is preset to calibration thresholds of 70 for mark\bar media and 50 for gap media. These values are selected to be compatible with a wide range of medias, however if the media is unusual performance may be improved through this calibration process. The current values are viewable on the two-key report . The command uses two labels worth of media to perform the calibration.

• Swift (iOS)

   
  1
  public func cpclAutoCal()
  

• Sample Code