SCP Manual en Iss2

Linx SCP
Simple Communications
Protocol Reference Manual
Simple Communications Protcocol
Reference Manual
Linx Simple Communications Protocol (SCP)
Copyright notice
No part of this publication may be reproduced, transmitted, transcribed, stored in a
retrieval system, or translated into any human or computer language by any means or in
any form, without the express prior written permission of Linx Printing Technologies Ltd.
Neither whole nor part of the product described in this manual may be adapted or
reproduced in any material form without the express prior written permission of Linx
Printing Technologies Ltd.
Contravention of copyright may also reduce the ability of Linx Printing Technologies Ltd to
provide effective support for its equipment.
This Second edition published 2015
© Linx Printing Technologies Ltd 2014, 2015
LINX is a registered trademark of Linx Printing Technologies Ltd.
Manual content
The content of this manual is provided for information only. Nothing in the content of this
manual represents, or should be construed as, any contractual or other commitment on the
part of Linx Printing Technologies Ltd.
Linx products are subject to continual development and improvement, and updates to the
content of this manual will be made accordingly in subsequent editions.
Linx reserves the right to make changes without notice to both this publication and to the
products described herein.
All possible care has been taken in the preparation of this manual, and information of a
technical nature and particulars of the product and its use are given by Linx in good faith.
However, Linx makes no guarantees regarding the accuracy or completeness of this
publication.
Confidentiality statement
The information contained in this manual is confidential to Linx and its distributors, and to
Original Equipment Manufacturers (OEMs) who are integrating Linx products into a larger
system, and who have signed a confidentiality agreement with Linx.
Safety recommendation
Before attempting to use either a Linx printer or its accessories, you should read the
information contained in the Safety section of the relevant printer manual. It is essential that
you follow safe operating procedures at all times, and that the equipment is maintained
according to the directions contained therein and as recommended by Linx or its
authorized Distributors.
Page 1 of 147 TP8C001–2 English

Nov 2015
2
Simple Communications Protcocol
Reference Manual
About this manual

This manual describes the Linx Simple Communications Protocol (SCP), a communications
protocol for use with Linx printers. It is intended for users with business systems or IT
knowledge, and experience of YAML™ or similar markup languages.
Linx will be pleased to receive any correspondence relating to this manual and the
information contained herein; please write to us at the address below.
For further information or help with Linx products, please contact:
Linx Printing Technologies Ltd
Linx House
8 Stocks Bridge Way
Compass Point Business Park
St Ives
Cambridgeshire
PE27 3JL
UK
Tel: + 44 (0) 1480 302100
Fax: + 44 (0) 1480 302116
E-mail: sales@linx.co.uk
or visit our website at www.linxglobal.com

Nov 2015
2
Simple Communications Protocol
Reference Manual
Contents
Copyright notice................................................................................................. 1
Manual content .................................................................................................. 1
Confidentiality statement ................................................................................... 1
Safety recommendation..................................................................................... 1
About this manual .............................................................................................. 2
Contents ............................................................................................................ 3
1. INTRODUCTION ............................................................................. 7
1.1 The Linx Simple Communications Protocol................................................. 7
1.2 Connect the printer ...................................................................................... 7
1.2.1 RS-232 ............................................................................................... 7
1.2.2 Ethernet .............................................................................................. 7
1.3 Overview...................................................................................................... 7
1.4 Syntax.......................................................................................................... 8
1.5 Commands .................................................................................................. 8
1.6 Keywords..................................................................................................... 9
1.7 Security...................................................................................................... 10
1.7.1 Session and user access level ......................................................... 10
1.7.2 Command security............................................................................ 11
1.8 Parameters ................................................................................................ 12
1.8.1 General parameter properties .......................................................... 13
1.9 Errors......................................................................................................... 20
2. COMMAND EXAMPLES ............................................................... 23

2.1 Commands supported by SCP .................................................................. 23
2.2 SCP command details ............................................................................... 23
2.3 Pitch command.......................................................................................... 25
2.4 ProdLine command ................................................................................... 25
2.5 Count command ........................................................................................ 25
2.6 Speed command ....................................................................................... 26
2.7 Trigger command ...................................................................................... 26
2.7.1 Simple Trigger query ........................................................................ 26
2.7.2 Detailed Trigger query ...................................................................... 27
2.8 Alarm command ........................................................................................ 27
2.9 Orientation command ................................................................................ 28
2.10 Date command ........................................................................................ 28
2.11 Start command ........................................................................................ 29
2.12 Status command...................................................................................... 29
2.13 Delete command ..................................................................................... 29

Nov 2015
6
Reference Manual
2.14 Message command ................................................................................. 31

2.14.1 Create a message with a field ........................................................ 31
2.14.2 Create a message with two fields................................................... 31
2.14.3 Create a barcode message with a single text field ......................... 33
2.14.4 Create a barcode message with a text and a date field ................. 34
2.15 Image command...................................................................................... 35
2.16 PrintMessage command .......................................................................... 35
2.16.1 Simple PrintMessage command..................................................... 35
2.16.2 Detailed PrintMessage command................................................... 37
2.17 RF command ........................................................................................... 37
2.17.1 Check for remote fields in a message ............................................ 37
2.17.2 RF command with field name ......................................................... 38
2.17.3 RF command with one string.......................................................... 39
2.17.4 RF command with field ordering..................................................... 39
2.17.5 Configure remote field data ............................................................ 39
2.18 Info command.......................................................................................... 40
2.19 Comms command ................................................................................... 41
2.20 PrintImage command .............................................................................. 42
2.21 PowerDown command ............................................................................ 43
2.22 Connection command.............................................................................. 43
2.23 Events command..................................................................................... 43
2.24 Setup command ...................................................................................... 44
2.25 AsynchEvents command ......................................................................... 44
2.25.1 Indication structure ......................................................................... 45
2.26 Summary command ................................................................................ 45
2.27 Print command ........................................................................................ 45

Nov 2015
6
Reference Manual
3. SIMPLE COMMUNICATIONS PROTOCOL COMMANDS ........... 47

3.1 Simple Protocol Command descriptions.................................................... 54
3.1.1 Pitch.................................................................................................. 55
3.1.2 ProdLine ........................................................................................... 56
3.1.3 Count ................................................................................................ 57
3.1.4 Speed ............................................................................................... 59
3.1.5 Trigger .............................................................................................. 60
3.1.6 Alarm ................................................................................................ 61
3.1.7 Orientation ........................................................................................ 66
3.1.8 Date .................................................................................................. 66
3.1.9 Start .................................................................................................. 68
3.1.10 Stop ................................................................................................ 69
3.1.11 Status ............................................................................................. 70
3.1.12 Diagnostics ..................................................................................... 71
3.1.13 Resources ...................................................................................... 73
3.1.14 Delete ............................................................................................. 76
3.1.15 Message ......................................................................................... 78
3.1.16 Message field parameters .............................................................. 89
3.1.17 Image............................................................................................ 105
3.1.18 Print message............................................................................... 106
3.1.19 RF................................................................................................. 108
3.1.20 Info................................................................................................ 109
3.1.21 Comms ......................................................................................... 112
3.1.22 PrintImage .................................................................................... 115
3.1.23 PowerDown .................................................................................. 116
3.1.24 Connection ................................................................................... 117
3.1.25 Consumables................................................................................ 117
3.1.26 Events........................................................................................... 119
3.1.27 Setup ............................................................................................ 120
3.1.28 UserLevel ..................................................................................... 125
3.1.29 Asynchronous events ................................................................... 125
3.1.30 Summary ...................................................................................... 126
3.1.31 Print .............................................................................................. 127
APPENDIX A: SCP COMMAND STRUCTURES ............................ 128

A.1 Pitch command ....................................................................................... 128
A.2 ProdLine command ................................................................................. 128
A.3 Count command...................................................................................... 128
A.4 Speed command ..................................................................................... 128
A.5 Trigger command .................................................................................... 129
A.6 Alarm command ...................................................................................... 129
A.7 Orientation command .............................................................................. 129
A.8 Date command........................................................................................ 130
A.9 Start command........................................................................................ 130

Nov 2015
6
Reference Manual
A.10 Stop command ...................................................................................... 130

A.11 Status command ................................................................................... 130
A.12 Diagnostics command........................................................................... 130
A.13 Resources command ............................................................................ 131
A.14 Delete command ................................................................................... 131
A.15 Message command............................................................................... 131
A.16 Image command ................................................................................... 133
A.17 PrintMessage command ....................................................................... 133
A.18 RF command......................................................................................... 133
A.19 Info command ....................................................................................... 133
A.20 Comms command ................................................................................. 134
A.21 PrintImage command ............................................................................ 134
A.22 PowerDown command .......................................................................... 134
A.23 Connection command ........................................................................... 135
A.24 Consumables command ....................................................................... 135
A.25 Events command .................................................................................. 136
A.26 Setup command .................................................................................... 136
A.27 UserLevel command ............................................................................. 136
A.28 AsynchEvents command....................................................................... 137
A.29 Summary command .............................................................................. 137
A.30 Print command ...................................................................................... 137
APPENDIX B: SUPPORTED LOCALES ........................................ 138
APPENDIX C: PRINTER COMMUNICATIONS SETUP ................. 140

C.1 How to connect to the printer with SCP .................................................. 140
C.1.1 RS-232........................................................................................... 140
C.1.2 Ethernet ......................................................................................... 140
C.1.3 Log in to SCP................................................................................. 140
C.2 Add, edit, and delete SCP connections .................................................. 140
C.2.1 Add a SCP connection................................................................... 141
C.2.2 Edit a SCP connection ................................................................... 145
C.2.3 Delete a SCP connection............................................................... 145
C.2.4 SCP and RCI over RS-232 ............................................................ 145
APPENDIX D: SCP COMMAND ACCESS RIGHTS....................... 146

Nov 2015
6
Reference Manual
CHAPTER 1: INTRODUCTION
1.1 The Linx Simple Communications Protocol
The Linx Simple Communications Protocol (SCP) allows you to control printer functions
from a remote host through the RS-232 port and/or the Ethernet port, rather than the local
display. The printer acts as a 'slave' that receives commands from the remote host and sends
back status information and data as requested.
The serial hardware connection to Linx printers is based on the RS-232C standard.
Although this manual refers to the RS-232 standard, and the software refers to RS-232, this
does equate to the EIA-232 standard.
1.2 Connect the printer

For remote communications, Linx printers use a hardware connection based either on the
RS-232 standard or an Ethernet connection.
1.2.1 RS-232
The RS-232 standard is an Electronic Industries Association (EIA) approved standard for
connecting serial devices. It provides point-to-point communications.
1.2.2 Ethernet
The Ethernet hardware connection on this printer is based on the IEEE 802.3u 100BASE-T/
10BASE-T standard. The Ethernet port in use is 29044.
For more information about how to configure Linx printers to use SCP, see ‘Printer
Communications Setup’ on page 140.
1.3 Overview
This section describes the various commands used with SCP. The structure of the
information passed over the protocol is based on the YAML™ data serialisation standard.
YAML™ is a human-readable, cross-language, Unicode-based serialization language used
to describe each command. This means that human-readable text is sent to, and received
from, the printer.
The YAML™ syntax lists documents as members of a stream. For SCP, the word ‘document’
is replaced by ‘command’. For each command, the keys used to enumerate the command
and its parameters are the same as the keys that are used in the command itself.
The YAML™ syntax used to describe each command closely matches the data exchanged
with the printer. The description of a command includes all the possible parameters. Each
parameter provides sufficient information to both validate and implement the command.
NOTE: For this release of SCP, only UTF-8 encoding is supported.
The YAML™ format consists of a key in the form of a key-pair value and sequence data in a
hierarchical format. For example:

Nov 2015
22
Reference Manual
Sequence
Parent :
- Child 1
- Child 2
- Child 3
In the above example, ‘Child 1’, ‘Child 2’, and ‘Child 3’ are sequences of data that are
children of a ‘Parent’ node.
Map (key-pair value)
Parent :
- Child 1: 0
- Child 2: 1
- Child 3: 2
In the above example ‘Child 1: 0’, ‘Child 2: 1, and ‘Child 3: 2’ are sequences of map (key-
pair value) data that are children of a ‘Parent’ node.
1.4 Syntax
The following YAML™ elements are used within SCP.
YAML SYNTAX ELEMENTS

Element Description
--- Three hyphens. Used as the command separator in
the stream. Multiple commands within the stream are
separated by this element.
... Three full stops. This is an optional end of file
command within a stream.
: Colon plus space. Separates the key from the value in
the command.
- Single hyphen. Lists the members within the
command.
# Hash sign. This starts a comment. A comment can
start anywhere on a line and continue until the end of
the line.
Table 1. YAML syntax elements
1.5 Commands
Each command has a unique description. If different parameters are required for printer
operations, these parameters are represented by different, but clearly related commands.
The one exception is where a simplified version of a command exists, where a single
parameter is attached to the command. See ‘Simple Protocol Command descriptions’ on
page 54 for details of all commands and their variations.

Nov 2015
22
Reference Manual
The first line in the data transfer is the command separator, with a carriage return character
‘<CR>’, followed by the command name. For example, for the Count command (where the
command key is ‘Count’), the command is as follows:
---
Count:
Parameters for the commands are supplied as values to command keys. The command keys
are specific to particular commands and are preceded by two space characters. For example,
the Count command can take as a parameter the command key ‘Message’ (to set or query
the message print count):
---
Count:
Message: 0
…
The above command sets the message count to zero. Note the indentation that denotes the
structure of the command. Also, note the use of the colon and space combination to
separate the key value from the key 'Message'. Tab characters are not allowed.
For some commands there is only a single parameter. In these cases, the parameter
description can be provided for the command itself. For example, the command
PowerDown requires a single parameter, so its description is as follows:
---
PowerDown:
Description: "Powers down the printer."
...
1.6 Keywords
Some special keywords can be applied to commands or parameters. These keywords are
shown in the table below.
SCP KEYWORDS
Keyword Description
QY Query. Used to query the value of a parameter on the
printer. When applied to a command, it implies that the
values of ALL associated parameters are returned.
EQY Used to query the possible values for an enumerated
parameter or the detailed query of a complex object.
DS Requests a description of the command or parameter.
OK Indicates successful execution of a command.
NO Indicates failure of a command.
Table 2. SCP keywords

Nov 2015
22
Reference Manual
1.7 Security
1.7.1 Session and user access level
An individual connection or session established between a SCP client and the printer has a
user access level associated with it. The access levels are as follows:
• NoAccess
• Basic
• Advanced
• Service
When a connection to the printer is made, SCP uses the UserLevel command to establish a
user access level. You can enter a valid username and PIN code to assign the access level
associated with that user to the session. The username is one of the users listed on the Select
User screen accessed from the User Login option on the Main Menu screen (including the
default OPERATOR and SUPERVISOR usernames). The PIN code is the same PIN code
used on the printer user interface.
The access level for a session is the level associated with the last UserLevel command
executed. When a SCP session is started (that is, when either a TCP/IP connection is
established, or the serial port is first used after printer powerup), the user access level
associated with the session is NoAccess.
You can set the access level for a user on the printer from the User Management screen
(Main Menu > Printer Setup > User Management > Edit User). Select the Communications
Access option on the Printer Functions screen. You can assign NoAccess, or Basic, or
Advanced user access levels to a user.
NOTE: You cannot modify the rights for OPERATOR and SUPERVISOR via the printer
user interface. Security access rights for these users for communications options are
set to Basic and Advanced, respectively.

Nov 2015
22
Reference Manual
1.7.2 Command security

Each command has a security property associated with it. This property identifies what
operations you can perform during a session with a specific access level. These security
properties are shown in table below.
SECURITY PROPERTIES
Type Description
NO_ACCESS Attempts to query or modify a value associated with
this command fail.
READ Values that can be successfully queried using the
command can be returned. An attempt to modify a
value fails.
WRITE Values that can be modified by the command can be
successfully modified. Values cannot be queried.
READ_WRITE Values that can be modified by the command can be
successfully modified, and values can be queried.
Table 3. Security properties
For example, the Count command can have the following settings:
Count:
NoAccess: NO_ACCESS
Basic: READ
Advanced: READ_WRITE
Service: READ_WRITE
A session with NoAccess access that executes the Count command is rejected. A session
with Basic access can query count parameter values, but not set them. A session with any of
the other access levels can both query and set count parameter values.
The access rights of a particular field within a command can override the value set by the
command itself. For example:
Count:
Printer:
No level set: NO_ACCESS
Basic: READ
Advanced: READ
Service: READ
NOTE: The UserLevel command must have READ_WRITE privileges for all access levels
to allow access for all users.

Nov 2015
22
Reference Manual
1.8 Parameters
This section describes the parameter types. Each parameter starts with a key value
associated with that parameter. For example, the Count command has a parameter with the
key, Message. The command description uses the key value Message as a heading for the
description of its properties. Therefore, the command description might be as follows:
---
Count:
Message:
Description: "The number of times the message has been printed."
Min: 0
A command sent to the printer from a client might be as follows:
---
Count:
Message: QY
…
To which the reply might be as follows:
---
Count:
Message: 52
…
This reply indicates that the message has been printed 52 times.
The next section lists the properties that apply to all parameter types. Subsequent sections
list the properties that apply to specific parameter types.

Nov 2015
22
Reference Manual
1.8.1 General parameter properties

The table below shows properties that apply to all parameters.
GENERAL PARAMETERS PROPERTIES

Key type Value Description
Description String Describes the meaning of the parameter.
Type See below The type of data (for example, integer or string).
Readable TRUE or FALSE The parameter represents a value that can be
read from the printer.
Writable TRUE or FALSE The parameter represents a value that can be
set on the printer.
Optional TRUE or FALSE If FALSE, a value for this parameter must be
available to perform the command. If a value is
not supplied by the user, the Default value is
used. If TRUE, the parameter value is not
necessary for the command.
Default Type dependent If present, this value is used if Optional is FALSE
and the parameter is not supplied. If Default is
not present, the Optional is FALSE, and the
parameter is not supplied, an error is reported.
Table 4. General parameters properties

Nov 2015
22
Reference Manual
Current type values are shown in the table below.
TYPE VALUES
Type Description
Int A signed integer.
Float A floating point value.
String A string of UTF-8 characters.
Enum A fixed set of values that are listed in the description.
Bool A Boolean value (TRUE or FALSE).
Binary Binary data.
Date A date value.
Time A time value.
DateTime A combined date and time value.
Table 5. Type values
Each type can have the qualifier 'List' associated with it. This means that the command or
response contains a sequence of the specified type. For example, ‘String List’ means that the
command and response contains a sequence of string values.
Integer parameter properties

This parameter type represents an integer. The value supplied is either decimal or
hexadecimal (for example, 25D or 1FH). The parameter has the following properties.
INTEGER PARAMETER PROPERTIES

Key Description
Max The maximum value that can be supplied. A number
or MAX_INT.
Min The minimum value that can be supplied. A number or
MIN_INT.
Units The units used for this parameter (can be none for a
count type value).
Table 6. Integer parameter properties

Nov 2015
22
Reference Manual
Example
---
Count:
Message:
Type: Int
Readable: TRUE
Writeable: TRUE
Optional: TRUE
Description: "The number of times the message has been
printed."
Min: 0
Max: MAX_INT
Units: None
…
NOTE: The above example does not have a Default entry because the parameter can be
optional. If the Default entry is omitted from the command, it means that the
parameter should not be used. The use of MAX_INT or MIN_INT values means
that you can provide a parameter that has limits imposed only by the software
architecture.
Float parameter properties

This parameter represents a floating point number. Its value is supplied in either decimal or
exponential formats (for example -23.57 or -2.357E01).
Returned values are in fixed point format. Supplied values are rounded to a level of
precision for that parameter in the printer. When a value is set on the printer, its returned
value when read is the same as the value that is used to set it (depending on the level of
precision for the parameter).
The float point parameter properties are as follows.
FLOAT PARAMETER PROPERTIES

Key Description
Max The maximum value that can be supplied. A number
or MAX_FLOAT.
Min The minimum value that can be supplied. A number or
MIN_FLOAT.
Units The units used for this parameter. Can be none for a
ratio.
Table 7. Float parameter properties

Nov 2015
22
Reference Manual
Example
---
LineSpeed:
Description: “Set the line speed if mode is fixed.”
Type: Float
Readable: TRUE
Writeable: TRUE
Optional: TRUE
Min: 0.001
Max: 1.390
Units: m/s
…
String parameter properties

The parameter supplied represents a string and can be supplied as a sequence of UTF-8
characters. A string can be placed within double quotes, but this is not required. If the string
includes whitespace, it must be placed in double quotes.
The string parameter properties are as follows.
STRING PARAMETER PROPERTIES

Key Description
MAXLEN The maximum number of Unicode characters.
MINLEN The minimum number of Unicode characters.
Table 8. String parameter properties
NOTE: The maximum and minimum lengths are calculated from the length of the Unicode
strings that result from the receipt of the UTF-8 characters in the command.

Nov 2015
22
Reference Manual
Example
---
Message:
Name:
Type: String
Readable: TRUE
Writeable: TRUE
Optional: FALSE
Description: "The message name."
Default: "Message_1"
Maxlen: 32
Minlen: 1
…
The above example shows the Name parameter associated with downloading a message to
the printer. This parameter can be omitted, but if it is omitted, the Default is used (that is,
a message called ‘Message_1’ is created). Because the command creates an entry on the
printer, rather than accessing an existing one, the parameter is both readable and writeable.
Once created it can be read or modified.

Nov 2015
22
Reference Manual
Enum parameter properties

For Enum parameter properties, the description provides a list of possible values that the
parameter can take.
ENUM PARAMETER PROPERTIES

Key Description
Values Indicates that a list follows with the possible values.
Description A description of each value.
Table 9. Enum parameter properties
Example
---
SerialSettings:
Parity:
Type: Enum
Readable: TRUE
Writeable: TRUE
Optional: TRUE
Description: "The parity settings on the serial port."
Values:
-ODD
Description: "Odd parity."
-EVEN
Description: "Even parity."
…
The parameter, Parity, can have two possible values. It is both readable and writeable
(you can either set the parity to use, or read the current setting). You can send the command
SerialSettings and not include the Parity parameter (that is, optional is set TRUE).
There is no default value because if you omit the parameter in the command, that part of the
command is ignored.

Nov 2015
22
Reference Manual
Bool parameter properties

The Bool parameter type represents a Boolean quantity. It can have the values TRUE or
FALSE.
Example
---
Orientation:
HFlip:
Type: Bool
Readable: TRUE
Writeable: TRUE
Optional: TRUE
Description: "Whether the printed message is horizontally
flipped."
…
Binary parameters properties

The Binary parameter type indicates that you must supply one or more bytes of binary
data. The data is supplied in Base64 encoding within double quotes. Its properties are as
follows.
BINARY PARAMETER PROPERTIES

Key Description
Default The value used if this parameter is not supplied and
the parameter is not optional.
Minlen The minimum number of binary characters.
Maxlen The maximum number of binary characters.
Table 10. Binary parameter properties
NOTE: The maximum and minimum values are the limits on the number of binary
characters that the Base64-encoded string represents.
Example
---
Bitmap:
Minlen: 1
Maxlen: 1024
…

Nov 2015
22
Reference Manual
Date parameter properties

The Date parameter properties represent a date and are a string. For example, in the
format:
yyyy-mm-dd
Where ‘yyyy’ is four digits that represents the year, ‘mm’ is two digits that represents the
month in the range 1 to 12, and ‘dd’ is two digits that represents the day of the month with
a range appropriate to the month. Any string that represents a valid date is acceptable.
Time parameter properties

The Time parameter properties represent a time and are a string in the format:
(-)hh:mm(:ss)
Where ‘hh’ is two digits that represents the hour in the range 00 to 23, ‘mm’ is two digits
that represents the minute in the range 00 to 59, and ‘ss’ is two digits in the range 00 to 59
that represents the second. Any string that represents a valid time is acceptable. The
seconds are optional. The minus sign is optional and only valid when it represents a time
adjustment.
DateTime parameter properties

The DateTime parameter properties represent a combined date and time and are a string.
For example in the format:
yyyy-MM-ddThh:mm(:ss)
Where ‘yyyy’ is the four digit year, ‘MM’ is the month number in the range 01 to 12, ‘dd’ is
the day of the month, ‘hh’ is two digits in the range 00 to 23 that represents the hour, ‘mm’ is
two digits that represents the minute in the range 00 to 59, and ‘ss’ is two digits that
represents the second (00-59). Any string that represents a valid date/time is acceptable. The
seconds are optional. The minus sign is optional and only valid when it represents a time
adjustment.
For example:
2014-12-25T13:45:31
1.9 Errors
Errors are reported to the client as a YAML™ document in the form of the original
command with values modified to indicate the reasons for the failure. The failed command
or parameter has the value NO attached, followed by an explanation of the error. For
example, the command:
---
Count:
Message: -1
…
Receives the reply:
---

Nov 2015
22
Reference Manual
Count:
Message: NO - Invalid value
…
A key that is not recognized is ignored.
The table below shows the types of error that can occur and the associated explanation
given in the returned document.
ERROR TYPES
Error type Explanation string
Unknown command The command name was not
recognized.
Value out of range (Min %s, The numerical value was outside the
Max %s) range of possible values.
Invalid value The wrong type of parameter was
supplied (for example, a string when
a number should be given, or an
unrecognized enumerated type).
Invalid data The data supplied is invalid.
Unsupported value The value supplied is currently
unsupported.
Parameter required The parameter is not optional and no
default is available for that parameter.
Invalid parameter The parameter supplied is invalid.
Failed to execute command Execution of the command failed,
possibly due to the printer being in an
invalid state.
Unsupported command The printer does not support that
command.
Failed to execute command The execution of the command failed
due to syntax error(s).
Start, End, and Current String lengths are inconsistent in
string lengths are sequential number.
inconsistent
Message not selected In order for the command to work a
message must be selected.
Execution failed for one or The execution of the command failed
more items for multiple reasons.
Not in printing state In order for the command to work the
printer needs to be in the printing
state.
Table 11. Error types

Nov 2015
22
Reference Manual
ERROR TYPES
Error type Explanation string
Printing in progress The printer is currently busy.
Message/Image printing Message/Image cannot be deleted if
it is selected for printing and the
printer is in the printing state.
Duplicate name A duplicate name has been supplied
in the command
Unknown field type A field supplied is of unknown origin.
Field beyond message boundary A message field supplied is beyond
message boundary.
Invalid field Field supplied is invalid.
Node not found Supplied node has not been found.
Incomplete node Supplied node is incomplete.
Invalid trigger mode Trigger mode supplied is invalid.
Duplicate command ignored A duplicate command has been
queries received.
Unknown message style Message style supplied is unknown.
<Name> does not exist <Name> does not exist.
Table 11. Error types (Continued)

Nov 2015
22
Reference Manual
CHAPTER 2: COMMAND EXAMPLES

This chapter lists some examples of how to use SCP commands to set and request values on
the printer. For detailed information about each available SCP command, see ‘Simple
Communications Protocol commands’ on page 47.
2.1 Commands supported by SCP

To display a list of the commands supported by SCP, you can use the Summary command.
---
Summary: QY
…
NOTE: This command returns a list of supported commands based on the security access
rights of the current user.
2.2 SCP command details

You can use the QY query with a specific command to check all of the supported child
commands and some of their default values.
For example, if you want to see more information about the Count command, you can enter
the following:
---
Count: QY
…
To which an example reply might be:
---
Count:
Message Count: 5
Print Count: 10
Batch Count: 20
…
This means that the main Count command has three subcommands (Message Count,
Print Count, and Batch Count).

Nov 2015
46
Reference Manual
If you need to find out more information about the command (for example, the units used
for the values or an exact description of each subcommand), you can use the DS query for
the required command. For example, for the Count command, you can enter the following:
---
Count: DS
…
To which an example reply might be:
---
Count:
- Message:
- Description:
- Unsigned int
- Read-Write
- Min 0, Max UINT MAX
- ""
- Message count. Optional subcommand
- Printer:
- Description:
- Unsigned int
- Read-Write
- ""
- Print count. Optional subcommand
- Batch:
- Description:
- Unsigned int
- Read-Write
- ""
- Batch count. Optional subcommand
...

Nov 2015
46
Reference Manual
2.3 Pitch command

An example simple command to set the pitch in the horizontal axis (in millimetres) is as
follows:
---
Pitch: - Horizontal: 365
…
This means that the horizontal pitch value is set to 365 mm
A simple query returns all values. The values returned are as follows:
---
Pitch:
Horizontal: 365
HorizontalAdj: 0
VerticalAdj: 400
…
This means that the horizontal pitch value is currently set to 365 mm, the horizontal
adjustment is set to 0 mm, and the vertical adjustment is set to 400 mm.
2.4 ProdLine command

An example command and reply are as follows:
---
ProdLine:
StoS: 104
…
To which the reply is as follows:
---
ProdLine:
StoS: OK
…
This means that, for the current production line, the distance between the start of one
message and the start of the next message is set to 104 mm.
2.5 Count command

---
Count: QY
…

Nov 2015
46
Reference Manual

---
Count:
Message: 0
Printer: 55
Batch: 0
...
This means that the number of prints made with the current message is 0, the total number
of prints made by the printer is 55, and the total number of prints made by the printer since
the Batch Print Count was last reset is 0.
2.6 Speed command

An example command that returns the current Speed Mode is as follows:
---
Speed: QY
…
---
Speed:
- Mode: Shaft Encoder
…
This means that a shaft encoder is currently set to control the speed of the production line.
The detailed query returns details of all possible speed modes:
---
Speed:
- Mode: EQY
…
2.7 Trigger command

2.7.1 Simple Trigger query
A simple query to return the current trigger details is as follows:
---
Trigger: QY
…

Nov 2015
46
Reference Manual
2.7.2 Detailed Trigger query

A detailed query to returns detail of all the possible triggers is as follows:
---
Trigger: EQY
…
An example command that returns the current trigger mode is as follows:
---
Trigger: QY
…
---
Trigger:
-TriggerMode: LE_Primary
...
This means that the leading edge primary trigger is set to trigger a print (that is, the printer
prints or updates the message when the product sensor detects the leading edge of a
product).
2.8 Alarm command

An example command to trigger the 24V alarm at printer powerup is as follows:
---
Alarm:
24V:
Powerup: PC
…
---
Alarm:
24V:
Powerup: OK
…
The means that the 24V alarm is triggered when the printer is powered up.

Nov 2015
46
Reference Manual
2.9 Orientation command

An example command to set the orientation to horizontal flip is as follows:
---
Orientation:
HFlip: True
…
---
Orientation:
HFlip: OK
…
This means that the orientation of the current message is reversed in the horizontal axis.
2.10 Date command

An example command to query the current date and time is as follows:
---
Date: EQY
…
---
Date: 2014:12:25 13:24:01
…
An example command that sets the printer time to 12:30:00, but leaves the date unchanged,
is as follows:
---
Date:
Time: 12:30:00
…
---
Date: OK
…

Nov 2015
46
Reference Manual
2.11 Start command

An example command to start printing is as follows:
---
Start: Print
…
---
Start: OK
…
This reply confirms that the printer has started printing.
2.12 Status command

An example command to query the current state of the printer is as follows:
---
Status: QY
…
---
Status:
State: Idle
Fault: 1
Warning: 3
…
This means that the printer is currently in the ‘Idle’ printing state, and has one current fault
and three current warnings.
2.13 Delete command

An example command to delete a specific message is as follows:
---
Delete:
Message: Message_3
…
---
Delete: OK

Nov 2015
46
Reference Manual
…
This means that the message with the name ‘Message_3’ is deleted from the printer.
An example command to delete multiple messages is as follows:
---
Delete:
Message:
"Message_3"
"My message"
…
This deletes messages with the names ‘Message_3’ and ‘My message’ from the printer.
To delete a specific message and logo, you can use the following command:
---
Delete:
Message: ABC
Image: DEF
…
This means that a message with the name ‘ABC’ and an image with the name ‘DEF’ are
deleted from the printer.
To delete all messages on the printer, you can use the following command:
---
Delete:
Message: ALL
…
To delete all images on the printer, you can use the following command:
---
Delete:
Image: ALL
…
To delete all messages and images on the printer, you can use the following command:
---
Delete: ALL
…
NOTE: If a message or image is being printed, it cannot be deleted from the printer.

Nov 2015
46
Reference Manual
2.14 Message command

2.14.1 Create a message with a field
You can create a message that contains a field with the following command:
---
Message:
Name: Test
Field:
Type: Text
Current Value: ABC
…
The command creates a message with the name ‘Test’ that contains a Text field with the text
‘ABC’.
Message name, field type, and default value are required when you create a simple
message.
In the above example, the Type node has the value ‘Text’. You can use predefined field
types with the Type node. The value supported by Current Value node varies
depending on the field type.
Supported field type values are as follows:
• Text
• Remote
• Date
• Time
• Shift
• Sequential
• Logo
2.14.2 Create a message with two fields

You can create a message that contains two fields with the following command:
---
Message:
Name: Test
Field:
Type: Text
Current Value: ABC
Field:

Nov 2015
46
Reference Manual
Type: Date
Current Value: "%DD%-%MM%"
…
The command creates a message with two fields adjacent to each other. The first field is
always positioned at the top left of the message. The message looks similar to that in
Figure 1.
AS394
Figure 1. Example message 1

If no line information is supplied, both fields are added to a single line.
If you want to display the fields on separate lines, you can use the following command:
---
Message:
Name: Test
Line:
Field:
Type: Text
Current Value: ABC
Line:
Field:
Type: Date
…
The command creates a message with two fields, one below the other, as shown in Figure 2.
AS395
Figure 2. Example message 2

The Line node allows you to place fields in multiple lines of a message. If a field is added
without a Line node, then a Line node is automatically added to the command. The
Field node is then added. You can use the VGap command to adjust the spaces between
the two lines. You can use the HGap command to adjust the spaces between fields.

Nov 2015
46
Reference Manual
An example command to set the spaces between lines and fields is as follows:
---
Message:
Name: Test
Line:
Field:
Type: Text
Current Value: ABC
HGap: 5
Field:
Type: Time
Current Value: "%HH%:%MM%"
VGap: 2
Line:
Field:
Type: Date
…
In the above example, the space between two lines is 2 units (in mm, pixels, or points), and
the space between two messages is 5 units (in mm, pixels, or points). You can change these
values to adjust the position of fields within the message.
For information about how to delete a message, see ‘Delete command’ on page 29.
For information about how to select a message for printing, see ‘PrintMessage command’
on page 35.
For information about how to print a message, see ‘Print command’ on page 45.
2.14.3 Create a barcode message with a single text field

An example command to create a barcode message with a single text field is as follows:
---
Message:
Name: BC
Style: 1x16 Western Flexible
Line:
Field:
Name: Field 1
Type: Barcode

Nov 2015
46
Reference Manual
Parameters:
Barcode Type: Code 39
Source Fields:
Field 2
Field:
Name: Field 2
Type: Text
Parameters:
Text: BARCODE1
…
2.14.4 Create a barcode message with a text and a date field

An example command to create a barcode message with a text field and a date field is as
follows:
---
Message:
Name: BC
Style: 1x16 Western Flexible
Line:
Field:
Name: Field 1
Type: Barcode
Parameters:
Barcode Type: Code 39
Source Fields:
Field 2
Field 3
Field:
Name: Field 2
Type: Text
Parameters:
Text: BARCODE1
Field:
Name: Field 3
Type: Date
Parameters:

Nov 2015
46
Reference Manual
Format: "%DD%\%MM%\%YY%"
…
2.15 Image command

An example command to download an image to the printer is as follows:
---
Image:
Name: My_Logo
Data: "SGVsbG8sIFdvcmxkIQ=="
Format: bmp
…
This means an image with the name ‘My_Logo’ is downloaded to the printer from the
remote PC.
An example command to upload an image to the printer is as follows:
---
Image: My_Logo
…
This means an image with the name ‘My_Logo’ is uploaded from the printer to the remote
PC.
2.16 PrintMessage command

2.16.1 Simple PrintMessage command
An example command to select a specific message for printing is as follows:
---
PrintMessage: My message
…
---
PrintMessage: OK
…
This means that the message with the name ‘My message’ is selected for printing.
NOTE: If the requested message does not exist on the printer, the ‘No message doesn’t
exist’ reply is returned.
You can also use this command to deselect the current print message if the printer is not in
the ‘Printing’ state. To do this, enter an empty (“”) string after the command name.
An example of a simple query to identify the message to be printed is as follows:

Nov 2015
46
Reference Manual
---
PrintMessage: QY
…
---
PrintMessage: "Message_3"
…
This means that the message with the name ‘Message_3’’ is the message selected for
printing.

Nov 2015
46
Reference Manual
2.16.2 Detailed PrintMessage command

An example command to select one message to be printed five times, and then another
message to be printed twice, is as follows:
---
PrintMessage:
Repeat: 0
-Message:
Index: 1
Name: Message_3
Repeat: 5
-Message:
Index: 2
Name: Message_5
Repeat: 2
…
---
PrintMessage:
1: OK
Repeat: OK
…
2.17 RF command
2.17.1 Check for remote fields in a message
The remote field command supports the QY and EQY query keywords. An example QY
query to check whether there are any remote fields in a message is as follows:
---
RF: QY
…
---
RF:
RemoteField1: ABCD
RemoteField2: EFGH
RemoteField3: No Remote field does not exist

Nov 2015
46
Reference Manual
RemoteField4: No Remote field does not exist

…
The above reply means that there are four remote fields in the printer, but only two of them
are used in the message. ‘RemoteField1’ and ‘RemoteField2’ have four characters of data
(‘ABCD’ and ‘EFGH’, respectively). ‘RemoteField3’ and ‘RemoteField4’ are not used in the
current message.
A reply of ‘No Remote field does not exist’ for a remote field command normally means
that the given remote field name or the remote field index does not exist. However, for the
QY command this reply means that the remote field is not added to the message.
An example EQY query is as follows:
---
RF: EQY
…
---
RF: ABCDEFGH
…
Where ‘ABCDEFGH’ is a concatenated string of all the remote fields data in the current
message.
2.17.2 RF command with field name

An example command to populate a Remote field in a message with a named field is as
follows:
---
RF:
RemoteField1: "FGH"
…
---
RF: OK
…
This means that the remote field is populated with a field called ‘FGH’.

Nov 2015
46
Reference Manual
2.17.3 RF command with one string

The following command can be used to populate a message with two Remote fields, one
four characters in length and one two characters in length. The first field contains the
characters ‘FGHA’, and the second contains the characters ‘BC’.
---
RF: "FGHABC"
…
---
RF: OK
…
2.17.4 RF command with field ordering

An example command, which populates the first and third remote fields, is as follows:
---
RF:
1: "FGH"
3: "MNO"
…
---
RF: OK
…
2.17.5 Configure remote field data

You can use any of the three options below to configure remote field data. Option 1 is the
fastest of the three options.
If the size of the data is less than the total size of all remote fields, blank spaces are used to
populate the fields. The remote fields are populated in the order in which they were
created. If the size of data is greater than the total remote field size, extra data is truncated.
If there is an unknown remote field (that is, one which does not exist on the printer) in the
message, and the size of sent data is greater than the total size of remote fields on the
printer, the unknown remote field is populated with the extra data (to a maximum size of
five characters or spaces).

Nov 2015
46
Reference Manual
Option 1
---
RF: ABCDEFGHI
…
If this command is used, the remote data is distributed according to the size of the remote
fields in the message.
Option 2
---
RF:
RemoteField1: ABCD
RemoteField2: EDGHI
…
This command can be used if the remote fields in the message are already known.
Option 3
---
RF:
1: ABCD
2: EDGHI
…
This command can be used if the order of the remote fields is known (remote field 1 is
populated with the data ‘ABCD’ and remote field 2 is populated with the data ‘EDGHI’).
NOTE: If you use the remote field name to set remote field data, the reply ‘No Remote field
does not exist’ means that the remote field to be updated is not in the current
selected message. The reply ‘No Unknown command’ means that the remote field
to be updated is not available on the printer.
2.18 Info command

An example command to return the build number is as follows:
---
Info:
Build: QY
…
To which an example reply is as follows:
---
Info:
Build: "v1.6.0.32246 14/03/2014”

Nov 2015
46
Reference Manual
…
The format of the returned strings is shown in Table 17:
EXAMPLE RETURNED STRING FORMATS

Information type String format
Printer Linx CIJ
Build V1.6.0.32246 14/03/2014
Firmware Hw Issue3, FPGA 4, Build 11, PIC 15, Ink if v3.0,
Printhead Mk0 v0 (255), EHT PSU 0x0
ID 000002D67H
Configuration ASTX-TY45-U890-DF3S-HJJC-1FOP
Network "k.l.m.n" decimal notation of IP address
Resources RAM - Total xxxxxx kB, Free xx.xx%, Flash -
Total xxxxxx kB, Free xx.xx%
Maintenance Power On Time - Total h:mm:00, Present
h:mm:00, Jet On Time - Total h:mm:00, Present
h:mm:00, Maintainance Due Within xxxx hours,
Maintenance Due By yyyy-mm-dd
Table 17. Example returned string formats

NOTE: If a printhead is not fitted, printhead information does not appear in the Firmware
string.
2.19 Comms command

---
Comms:
Connection:
Name: CON1
Header: "*\n"
Footer: "\n^"
…
*
Comms: OK
^
The command to query the details of a particular connection (‘CON1’) is as follows:
---

Nov 2015
46
Reference Manual
Comms: CON1
…
---
Comms:
Connection:
Name: CON1
Header: "---\n"
Footer: "\n…"
Timeout: 0
Active: true
Security: 2
AsyncEvents:
PDElay: true
PGo: false
Pend: false
…
2.20 PrintImage command

An example command to request a bitmap image of the current message is as follows:
---
PrintImage:
Xoff: 0
Yoff: 0
…
---
PrintImage:
Data: !!binary "SGVsbG8sIFdvcmxkIQ=="
…

Nov 2015
46
Reference Manual
2.21 PowerDown command

An example command to power down the printer is as follows:
---
PowerDown: TRUE
…
To which, if successful, the reply is:
---
PowerDown: OK
…
2.22 Connection command

An example command to assign the named connection parameters to a connection
(‘CON1’) is as follows:
---
Connection: CON1
…
---
Connection: OK
…
2.23 Events command

An example command to request either the current events or the printer history is as
follows:
---
Events:
Current: QY
History: QY
…
The command to request both event types is as follows:
---
Events: QY
…
The format of the event string is as follows:
"fault/warning-number fault/warning-description time-stamp"

Nov 2015
46
Reference Manual
The events are returned in chronological order, with the most recent first. An example of a
reply is as follows:
---
Events:
Current:
-3.03 Ink Low 2014-02-28T13:23:00
-3.04 Solvent Low 2014-02-28T13:23:00
…
You can use a range to request specific items in the history. For example, the following
command requests the first five items in the event history:
---
Events:
History: 1-5
…
2.24 Setup command

An example command to set up the Remote field order for three remote fields on the printer
is as follows:
---
Setup:
RemoteField
Order:
-RemoteField2
-RemoteField3
-RemoteField1
…
This means that the Remote fields are populated in the order 2, then 3, and then 1.
2.25 AsynchEvents command

If the Async Events option is enabled for a SCP connection (see ‘Add a SCP connection’ on
page 141), you can set up notifications for every print start and print end events.
For example, if the PrintGo option is selected, for each print made by the printer, the
following AsynchEvents command is received:
---
AsyncEvents: PrintGo
…

Nov 2015
46
Reference Manual
If the PrintEnd option is selected, for each print made by the printer, the following
AsynchEvents command is received:
---
AsyncEvents: PrintEnd
…
2.25.1 Indication structure

The format of the indication that is sent to the client for the AsynchEvents command is as
follows:
---
AsyncEvents:
Type: Enum
Values:
-PDelay
Description: Print delay event
-PGo
Description: Print go event
-PEnd
Description: Print end event
2.26 Summary command

The following command returns a list of currently available commands:
---
Summary: QY
…
The following command returns a description for the Summary command only:
---
Summary: DS
…
2.27 Print command

Before you can use the Print command, make sure that:
• The required message is selected for printing (see ‘PrintMessage command’ on
page 35).
• The printer is in the ‘Printing’ state.
• The print trigger option is set to ‘Manual’ (Home > Line Settings > Advanced Line
Settings > Print Trigger).

Nov 2015
46
Reference Manual
The following command issues a manual trigger command to the printer for a single print:
---
Print: True
…
You can also use the Print command to query if the printer is currently printing:
---
Print: QY
…
If the printer is printing, the reply is as follows:
---
Print: Printing in progress
…
If the printer is not printing, the reply is as follows:
---
Print: False
…

Nov 2015
46
Reference Manual
CHAPTER 3: SIMPLE
COMMUNICATIONS PROTOCOL
COMMANDS
The table below provides a summary of the Simple Communications Protocol commands
and their parameters. For a detailed description of each command, refer to ‘Simple Protocol
Command descriptions’ on page 54..
SIMPLE COMMUNICATIONS PROTOCOL COMMANDS

Command name Parameter level 1 Parameter level 2 Parameter level 3 Parameter level 4
Pitch Horizontal
Vertical
HorizontalAdj
VerticalAdj
ProdLine SensorToHead
PrintPosition
StoS (Start of
message to start of
next message
distance)
EtoS (End of
message to start of
next message
distance)
LtoR (Line direction
- left to right)
Count Message
Printer
Batch
Speed Mode
LineSpeed
EncoderPitch
Trigger TriggerMode
Table 12. Simple Communication Protocol commands

Nov 2015
127
Reference Manual

Alarm 24V Printer Failure
StopPrinting
ScheduledMaintenance
Printing
ConsumableWarning
PrintWarning
Powerup
VFC PrinterFailure
StopPrinting
Warnings
Orientation Rotation
HFlip
VFlip
Date Time
Date
UTCOffset
DST
Start No parameters
Stop No parameters
Status State
Fault
Warning
Diagnostics RefTOF
TOF
Phase
Pressure
RefMod
Mod
SolventAdd
HeadTemp
Table 12. Simple Communication Protocol commands (Continued)

Nov 2015
127
Reference Manual

Resources Message
Image
DateTimeElements
Font
MessageStyle
Delete Message
Image
Message Overwrite
Name
Style
Units
Scaling
PrintDelay
Count
BoundaryCheck
VGap
HGap
Orientation Rotation
HFlip
VFlip
Printer Type
Pitch Horizontal
Vertical
HorizontalAdj
VerticalAdj
PromptOrder
Line HGap
Field Name
Type
Visible
Font Name
Size
Units
Rotation
Negative
Locale
Boldness X
Y

Nov 2015
127
Reference Manual

Position X
Y
HGap
Parameters See Table Table 13.
on page 53
Image Overwrite
Name
Data
Format
PrintMessage Repeat
Reset
PrintAll
Message Name
Index
Repeat
RF (Using field Remote_Name

name)
RF (Using one RF
string)
RF (Using field Field Index Remote String

ordering)
Info (Simple query) QY
Info (Type query) Printer

Build
Firmware
ID
SerialNo
Configuration
Network
Resources
Maintenance

Nov 2015
127
Reference Manual

Comms Connection Name
Header
Footer
Active
Timeout
Security
AsyncEvents PDelay
PGo
PEnd
PrintImage Xoff
Yoff
Width
Height
Data
PowerDown
Connection CommsReset
Consumables Ink Bottles

RecentBottles
UsageRate
Cartridge TotalDrops
Remaining Drops
Percent
Prints
DropsPerPrint
PrintsDone
Solvent Bottles
Recent
Usage
Cartridge Remaining
Percent
Reset
ServiceModule Remaining
Events Current
History

Nov 2015
127
Reference Manual

Setup ConfigCode
PowerSave OnShutDown
DelayOnIdle
DelayOnRunning
DelayOnPrinting
PrinterName
Ink
Solvent
Keyboard Primary
Secondary
Locale
Hardware Photocell PCellType
DeadTime
EncoderVoltage
PrintheadHeight
RemoteField Order
Mode
Buffers
ClearBuffers
OnFailure
UserLevel User
PIN
AsyncEvents PDelay
PGo
PEnd
Summary
Print

Nov 2015
127
Reference Manual
The table below shows the field parameters for SCP commands
FIELD PARAMETERS
Field type Parameter level 1 Parameter level 2 Parameter level 3
Text Text
Prompted field Text

Type
MaxChars
Default
PromptWith
List
Date Offset Time

Days
Months
Rounding Type
To
Change
Day
Time Offset
Rounding Type
Hour
Time
Change
Image Name
Data
Remote Name
Length
Table 13. Field parameters

Nov 2015
127
Reference Manual
FIELD PARAMETERS
Field type Parameter level 1 Parameter level 2 Parameter level 3
Counter Start
End
Step
Repeat
Range
Shift Code Type

Pattern Duration
Start
Cycle Shift Time
Text
Day
Table 13. Field parameters (Continued)
3.1 Simple Protocol Command descriptions

This section contains a description of each command based on the parameter descriptions
in ‘Introduction’ on page 7. Text in bold shows the command parameters. Indented text
below the bold text shows the properties of the parameters.
For examples of how to use selected commands, refer to ‘Command Examples’ on page 23.

Nov 2015
127
Reference Manual
3.1.1 Pitch
Command Type: Set
Request
This command is used on printers to set or request the pitch on the printer. On a CIJ printer
the vertical pitch cannot be set (or read) as its absolute value depends on the head to
substrate separation.
The pitch setting is specific to the current message and applies to that message until the
value is changed. If there is no message selected for printing, the command fails.
The command and its parameters are as follows:
---
Pitch:
Horizontal:
Description: “Horizontal Drop to Drop pitch.”
Type: Int
Readable: TRUE
Writeable: TRUE
Optional: TRUE
Min: 200
Max: 500
Units: Microns
Vertical:
Description: “Vertical Drop to Drop pitch (not CIJ).”
Type: Int
Readable: TRUE
Writeable: TRUE
Optional: TRUE
Min: 0
Max: MAX_INT
Units: Microns
HorizontalAdj:
Description: “Percentage horizontal adjustment from default.”
Type: Int
Readable: TRUE
Writeable: TRUE
Optional: TRUE
Min: -45

Nov 2015
127
Reference Manual
Max: 37
Units: Percent
VerticalAdj:
Description: “Percentage vertical adjustment from default.”
Type: Int
Readable: TRUE
Writeable: TRUE
Optional: TRUE
Min: -5
Max: 10
Units: Percent
...
3.1.2 ProdLine
Command Type: Set
Request
The command is used to set and request the production line parameters. Its parameters are
as follows:
---
ProdLine:
SensorToHead:
Description: “Product sensor to print head distance.”
Type: Unsigned int
Readable: TRUE
Writeable: TRUE
Optional: TRUE
Min: 0
Max: 1000000
Units: 100ths of mm
PrintPosition:
Description: “Print offset from trigger point on substrate.”
Type: Unsigned int
Readable: TRUE
Writeable: TRUE
Optional: TRUE
Min: 0

Nov 2015
127
Reference Manual
Max: 1000000
Units: 100ths of mm
StoS:
Description: “Start of message to start of next message
distance. Cannot be specified if EtoS is used.”
Type: Unsigned int
Readable: TRUE
Writeable: TRUE
Optional: TRUE
Min: 3010
Max: 1000000
Units: 100ths of mm
EtoS:
Description: “End of message to start of next message
distance. Cannot be specified if StoS is used.”
Type: Unsigned int
Readable: TRUE
Writeable: TRUE
Optional: TRUE
Min: 3010
Max: 1000000
Units: 100ths of mm
LtoR:
Description: “Line direction left to right.”
Type: Bool
Readable: TRUE
Writeable: TRUE
Optional: TRUE
Default: TRUE
...
3.1.3 Count
Command Type: Set
Request
The command is used to set and request the message, printer, and batch counts.

Nov 2015
127
Reference Manual
---
Count:
Message:
Description: “Currently selected print message count.”
Type: Int
Readable: TRUE
Writeable: TRUE
Optional: TRUE
Min: 0
Max: MAX_INT
Printer:
Description: “The total printer count.”
Type: Int
Readable: TRUE
Writeable: TRUE
Optional: TRUE
Min: 0
Max: MAX_INT
Batch:
Description: “The batch counter.”
Type: Int
Readable: TRUE
Writeable: TRUE
Optional: TRUE
Min: 0
Max: MAX_INT
...

Nov 2015
127
Reference Manual
3.1.4 Speed
Command Type: Set
Request
This command is used to set and request the printer speed mode, line speed, and encoder
pitch. The parameters are:
---
Speed:
Mode:
Description: “Set the Speed Mode.”
Type: Enum
Readable: TRUE
Writeable: TRUE
Optional: TRUE
Default: Fixed Speed
Values -
Fixed Speed
Description: “Fixed speed.”
Shaft Encoder
Description: “Shaft encoder.”
LineSpeed:
Description: “Set the line speed if mode is fixed.”
Type: Float
Readable: TRUE
Writeable: TRUE
Optional: TRUE
Min: 0.001
Max: 1.390
Units: m/s
EncoderPitch:
Description: “Set the encoder pitch if shaft encoder
selected.”
Type: Float
Readable: TRUE
Writeable: TRUE
Optional: TRUE

Nov 2015
127
Reference Manual
Min: 1.0
Max: 333.3
Units: Pulses per millimetre (PPM)
...
3.1.5 Trigger
Command Type: Set
Request
This command is used to set and request the trigger setting parameters on the printer.
---
Trigger:
TriggerMode:
Description: “Sets the trigger mode.”
Type: Enum
Readable: TRUE
Writeable: TRUE
Optional: FALSE
Default: Leading Edge Primary
Values -
LEPrimary
Description: “Primary, leading edge triggered.”
TEPrimary
Description: “Primary, trailing edge triggered.”
APrimary
Description: “Active primary level triggered.”
IPrimary
Description: “Inactive primary level triggered.”
Continuous
Description: “Continuously triggered.”

Nov 2015
127
Reference Manual
Manual
Description: “Manually triggered.”
...
3.1.6 Alarm
Command Type: Set
Request
Printer alarms have a common setup, but not every alarm supports all functionality. For
example, the Volt-free Contact (VFC) alarm only supports three alarm conditions and only
expects the On (CO) or Off (NO) states.
---
Alarm:
24V:
Printer Failure:
Description: “Printer Failure operation for 24V Alarm.”
Type: Enum
Readable: TRUE
Writeable: TRUE
Optional: TRUE
Values -
CO
Description: “Continuous.”
PC
Description: “Pulsed Continuous.”
PU
Description: “Pulsed.”
NO
Description: “None.”
Stop Printing:
Description: “Stop Printing operation for 24V Alarm.”
Type: Enum
Readable: TRUE
Writeable: TRUE
Optional: TRUE
Values -

Nov 2015
127
Reference Manual
CO
PC
PU
NO
ScheduledMaintenance:
Description:“Scheduled Maintenance 24V Alarm.”
Type: Enum
Readable: TRUE
Writeable: TRUE
Optional: TRUE
Values -
CO
PC
PU
NO
Printing:
Description: “Printing 24V Alarm.”
Type: Enum
Readable: TRUE
Writeable: TRUE
Optional: TRUE
Values -
CO
PC

Nov 2015
127
Reference Manual
PU
NO
ConsumableWarning:
Description: “Consumable Warning 24V Alarm.”
Type: Enum
Readable: TRUE
Writeable: TRUE
Optional: TRUE
Values -
CO
PC
PU
NO
Description: “None.”PrintWarning:
Description: “Print Warning 24V Alarm.”
Type: Enum
Readable: TRUE
Writeable: TRUE
Optional: TRUE
Values -
CO
PC
PU
NO
Powerup:
Description: “Powerup 24V Alarm.”

Nov 2015
127
Reference Manual
Type: Enum
Readable: TRUE
Writeable: TRUE
Optional: TRUE
Values -
CO
PC
PU
NO

Nov 2015
127
Reference Manual
VFC:
PrinterFailure:
Description: “Printer Failure VFC Alarm.”
Type: Enum
Readable: TRUE
Writeable: TRUE
Optional: TRUE
Values -
CO
NO
Description: “None.
StopPrinting:
Description: Stop Printing VFC Alarm.”
Type: Enum
Readable: TRUE
Writeable: TRUE
Optional: TRUE
Values -
CO
NO
Warnings:
Description: “Consumable Warning VFC Alarm.”
Type: Enum
Readable: TRUE
Writeable: TRUE
Optional: TRUE
Values -
CO
NO
...

Nov 2015
127
Reference Manual
3.1.7 Orientation
Command Type: Set
Request
This command is used to set or request the orientation of the printed image on the
substrate.
---
Orientation:
Rotation:
Description: “Rotation in degrees.”
Type: Int
Readable: TRUE
Writeable: TRUE
Optional: TRUE
Min: 0
Max: 359
Units: degrees
HFlip:
Description: “Horizontal Flip.”
Type: Bool
Readable: TRUE
Writeable: TRUE
Optional: TRUE
VFlip:
Description: “Vertical Flip.”
Type: Bool
Readable: TRUE
Writeable: TRUE
Optional: TRUE
...
3.1.8 Date
Command Type: Set
Request
This is a combined command to set and request the date and time.

Nov 2015
127
Reference Manual
A single command to set both date and time

---
Date:
Description: “Sets the date and time.”
Type: DateTime
Readable: TRUE
Writeable: TRUE
Optional: FALSE
MinDate: 2014-06-17T00:00
...
Separate date and time command

---
Date:
Time:
Description: “The printer time element.”
Type: Time
Readable: TRUE
Writeable: TRUE
Optional: TRUE
Date:
Description: “The printer date element.”
Type: Time
Readable: TRUE
Writeable: TRUE
Optional: TRUE
MinDate: 2014-06-17
UTCOffset:
Description: “The printer time offset from GMT.”
Type: Time
Readable: TRUE
Writeable: TRUE
Optional: TRUE

Nov 2015
127
Reference Manual
Default: 00:00
DST:
Description: “Daylight saving (+1hr) is active.”
Type: Bool
Readable: TRUE
Writeable: TRUE
Optional: TRUE
Default: FALSE
...
3.1.9 Start
Command Type: Set only
The command is used to either start printing or prepare the printer for printing. In normal
operation the printer can be in one of three states, or in transition between these states.
These states are as follows:
• Idle—The printer is not ready for printing and will not print.
• Running—The printer is ready to print, but does not print if it receives a trigger signal.
• Printing—The printer is ready to print and prints if it receives a trigger signal.
The Start command initiates a change of printer state so that its final state is either
‘Running’ or ‘Printing’.
---
Start:
Description: “The required new state for the printer.”
Type: Enum
Readable: FALSE
Writeable: TRUE
Optional: FALSE
Values -
Print
Description: “Start up the printer and enter the print
ready mode.”
Running
Description: “Start the jet running.”
...

Nov 2015
127
Reference Manual
Start command state transitions

The following table indicates the expected behaviour when the Start command is
received, depending on the current state of the printer.
START COMMAND STATE TRANSITIONS

Current state Start: Running > final state Start: Printing > final state
IDLE OK > RUNNING OK > PRINTING
RUNNING OK > RUNNING OK > PRINTING
STARTING OK > RUNNING OK > PRINTING
PRINTING OK > RUNNING OK > PRINTING
STOPPING OK > RUNNING OK > PRINTING
FAULT NO—Permission denied NO—Permission denied
Table 14. Start command state transitions
3.1.10 Stop
This command is used to either stop the printer printing or running.
---
Stop:
Description: “The way the printer should be stopped.”
Type: Enum
Readable: FALSE
Writeable: TRUE
Optional: FALSE
Values -
Print
Description: “Take the printer into Running mode after the
current print has completed (pausing print).”
Abort
Description: “Stop the print immediately and enter Running
mode (abort print).”
Running
Description: “Take the printer from Print mode to idle
(stop print).”
...

Nov 2015
127
Reference Manual
Stop command state transitions

The following table indicates the expected behaviour when the Stop command is received,
depending on the current state of the printer.
STOP COMMAND STATE TRANSITIONS

Current state Stop: Print Stop: Abort Stop: Running
IDLE OK > IDLE OK > IDLE OK > IDLE
RUNNING OK > RUNNING OK > RUNNING OK > IDLE
STARTING OK > RUNNING OK > RUNNING OK > IDLE
PRINTING OK > RUNNING OK > RUNNING OK > IDLE
STOPPING OK > IDLE OK > IDLE OK > IDLE
FAULT NO—Permission denied NO—Permission denied NO—Permission denied
Table 15. Stop command state transitions
3.1.11 Status
Command Type: Request only
The command is used to request the current state of the printer.
---
Status:
State:
Description: “The current printing state of the printer.”
Type: Enum
Readable: TRUE
Writeable: FALSE
Optional: TRUE
Values -
IDLE
Description: “The printer is idle.”
STARTING
Description: “The printer is starting.”
STOPPING
Description: “The printer is stopping.”
RUNNING
Description: “The printer is running.”

Nov 2015
127
Reference Manual
READY
Description: “The printer is ready to print.”
FAULT
Description: “The printer has a fault.”
Fault:
Description: “The number of current faults on the printer.”
Type: Int
Readable: TRUE
Writeable: FALSE
Optional: TRUE
Min: 0
Max: 1024
Warning:
Description: “The number of current warnings on the printer.”
Type: Int
Readable: TRUE
Writeable: FALSE
Optional: TRUE
Min: 0
Max: 1024
...
3.1.12 Diagnostics
The command is used to query diagnostic information specific to the printer type.
The command and its parameters for a CIJ printer are as follows:
---
Diagnostics:
RefTOF:
Description: “The Reference Time of Flight (TOF) on the
printer (Service user only).”
Type: Int
Readable: TRUE
Writeable: FALSE
Optional: TRUE
Min: 1800

Nov 2015
127
Reference Manual
Max: 2500
TOF:
Description: “The Actual TOF value on the printer (Service
user only).”
Type: Int
Readable: TRUE
Writeable: FALSE
Optional: TRUE
Min: 1800
Max: 2500
Phase:
Description: “The Actual Phase value on the printer (Service
user only).”
Type: Int
Readable: TRUE
Writeable: FALSE
Optional: TRUE
Min: 0
Max: 15
Pressure:
Description: “The Actual Pressure value on the printer
(Service user only).”
Type: Int
Readable: TRUE
Writeable: FALSE
Optional: TRUE
Min: 0
Max: 255
RefMod:
Description: “The Reference Modulation on the printer (Service
user only).”
Type: Int
Readable: TRUE
Writeable: FALSE
Optional: TRUE
Min: 0

Nov 2015
127
Reference Manual
Max: 255
Mod:
Description: “The Actual Modulation value on the printer
Type: Int
Readable: TRUE
Writeable: FALSE
Optional: TRUE
Min: 0
Max: 255
SolventAdd:
Description: “The number of solvent adds on the printer
Type: Int
Readable: TRUE
Writeable: FALSE
Optional: TRUE
Min: 0
Max: 1000
HeadTemp:
Description: “Head temperature (Service user only).”
Type: Int
Readable: TRUE
Writeable: FALSE
Optional: TRUE
Min: 0
Max: 150
Units: Degrees C
...
NOTE: The above parameters are only returned when the User Level is set to ‘Service’.
3.1.13 Resources
This command is used to retrieve information about resources on the printer.

Nov 2015
127
Reference Manual
---
Resources: QY
Simple query
This command returns all the resources available on the printer.
---
Resources:
Message:
Description: “The message name.”
Type: String
Readable: TRUE
Writeable: FALSE
Image:
Description: “The logo name.”
Type: String
Readable: TRUE
Writeable: FALSE
DateTimeElements:
Description: “The date format.”
Type: String
Readable: TRUE
Writeable: FALSE
Font:
Description: “The font name.”
Type: String
Readable: TRUE
Writeable: FALSE
MessageStyle:
Description: “The message style name.”
Type: String
Readable: TRUE
Writeable: FALSE
...

Nov 2015
127
Reference Manual
Query by type
This command can be used to request specific data types. One or more data types can be
queried in a single command.
---
Resources:
Message: QY
Image: QY
DateTimeElements: QY
Font: QY
MessageStyle: QY
…
The response is similar to the simplified query, except only the queried data types are
returned.
Detailed type query

This query uses the keyword EQY to return detailed information for specified data types:
---
Resources:
Message: EQY
Image: EQY
DateTimeElements: EQY
Font: EQY
Style: EQY
…
To which the response is as follows:
---
Resources:
Message:
Description: “List of message names with respective width
and height.”
Type: String List
Readable: TRUE
Writeable: FALSE
Image
Description: “List of logo names with respective width and
height.”
Type: String List

Nov 2015
127
Reference Manual
Readable: TRUE
Writeable: FALSE
Optional: TRUE
DateTimeElements
Description: “List of date formats with respective
description.”
Type: String List
Readable: TRUE
Writeable: FALSE
Font
Description: “List of font names with respective size.”
Type: String List
Readable: TRUE
Writeable: FALSE
MessageStyle
Description: “List of message style names.”
Type: String List
Readable: TRUE
Writeable: FALSE
...
NOTE: There is no detailed information associated with a message style.
3.1.14 Delete
This command is used to delete one or more resources on the printer.
Delete all
This command deletes all resources of a specified type (for example, messages or logos).
---
Delete:
Message: ALL
Description: “Delete all messages.”
Type: String
Readable: FALSE
Writeable: TRUE

Nov 2015
127
Reference Manual
Optional: TRUE
Image: ALL
Description: “Delete all images.”
Type: String
Readable: FALSE
Writeable: TRUE
Optional: TRUE
...
Delete a resource by name

This command deletes a specific, named resource.
---
Delete:
Message:
Description: “Message Name.”
Type: String
Readable: FALSE
Writeable: TRUE
Optional: TRUE
Minlen: 1
Maxlen: 32
Image:
Description: “Bitmap Name.”
Type: String
Readable: FALSE
Writeable: TRUE
Optional: TRUE
Minlen: 1
Maxlen: 32
...
Delete a list of resources

This command deletes one or more named resources (for example, a list of message names).
---

Nov 2015
127
Reference Manual
Delete:
Message:
Description: “A list of message names.”
Type: String List
Readable: FALSE
Writeable: TRUE
Optional: TRUE
Minlen: 1
Maxlen: 32
Image:
Description: “A list of image names.”
Type: String List
Readable: FALSE
Writeable: TRUE
Optional: TRUE
Minlen: 1
Maxlen: 32
...
3.1.15 Message
Command Type: Set
Request
This command is used to manage messages on the printer. As a message can contain one or
more fields of various types, parameters for the different field types are explained in
‘Message field parameters’ on page 39.
---
Message:
Overwrite:
Description: “Used to overwrite the existing message.”
Type: Bool
Readable: TRUE
Writeable: TRUE
Optional: TRUE
Default: FALSE

Nov 2015
127
Reference Manual
Name:
Description: “The message name.”
Type:String
Readable: TRUE
Writeable:TRUE
Optional: FALSE
Minlen: 1
Maxlen: 32
Style:
Description: “The message style.”
Type: String
Readable: TRUE
Writeable: TRUE
Optional: TRUE
Default: Depends on default style setting on the printer.
Units:
Description: “Units used in positional values.”
Type: Enum
Readable: TRUE
Writeable: TRUE
Optional: TRUE
Default: Drops
Values -
Drops
Millimetres
Points
Scaling:
Description: “Factor used with positional values.”
Type: Unsigned int
Readable: TRUE
Writeable: TRUE
Optional: TRUE
Default: 1
Min: 1
Max: UINT_MAX

Nov 2015
127
Reference Manual
PrintDelay:
Description: “Message print delay.”
Type: Unsigned int
Readable: TRUE
Writeable: TRUE
Optional: TRUE
Default: 0
Min: 0
Max: 10000
Units: mm
Count:
Description: “Message print count.”
Type: Unsigned int
Readable: TRUE
Writeable: TRUE
Optional: TRUE
Default: 0
Min: 0
Max: UNIT Max
BoundaryCheck:
Description: “Used to check if the given field is within the
boundaries of the message. Validates the height
of the message.”
Type: Bool
Readable: TRUE
Writeable: TRUE
Optional: TRUE
Default: TRUE
VGap:
Description: “Default drop gap between the lines.”
Type: Unsigned int
Readable: TRUE
Writeable: TRUE
Optional: TRUE
Default: 0

Nov 2015
127
Reference Manual
Min: 0
Max: 17 (Maximum of 34 drops, divided by 2)
HGap:
Description: “Default drop gap between the fields.”
Type: Unsigned int
Readable: TRUE
Writeable: TRUE
Optional: TRUE
Default: 0
Min: 0
Max: 33465 (drops equivalent to 1m length at 72 DPI)
Orientation:
Rotation:
Description: “Message rotation.”
Type: Unsigned int
Readable: TRUE
Writeable: TRUE
Optional: TRUE
Default: 0
Values -
0
90
180
270
HFlip:
Description: “Horizontal flip for message.”
Type: Boolean
Readable: TRUE
Writeable: TRUE
Optional: TRUE
Default: False
VFlip:
Description: “Vertical flip for message.”
Type: Boolean
Readable: TRUE

Nov 2015
127
Reference Manual
Writeable: TRUE
Optional: TRUE
Default: False
Printer:
Type:
Description: “Printer type.”
Type: String
Readable: TRUE
Writeable: TRUE
Optional: TRUE
Default: CIJ
Pitch:
Horizontal
Description: “Horizontal pitch value for message.”
Type: Unsigned int
Readable: TRUE
Writeable: TRUE
Optional: TRUE
Default: 365
Vertical
Description: “Vertical pitch adjustment value for
message.”
Type: Unsigned int
Readable: TRUE
Writeable: TRUE
Optional: TRUE
Default: 365
HorizontalAdj
Description: “Horizontal pitch adjustment value for
message.”
Type: Unsigned int
Readable: TRUE
Writeable: TRUE
Optional: TRUE
Default: 0

Nov 2015
127
Reference Manual
VerticalAdj
Description: “Vertical pitch adjustment value for
message.”
Type: Unsigned int
Readable: TRUE
Writeable: TRUE
Optional: TRUE
Default: 0
PromptOrder:
Description: “List of prompt field names.”
Type: String list
Readable: TRUE
Writeable: TRUE
Optional: TRUE
Default: If not defined, order is as defined in the message.
...
NOTE: The Style subcommand requires a valid message style description, either in the
current locale for the printer or in English. If a description is not found, the
command fails.
When a specific message is queried, the style returned is displayed, either:
• As it appeared in the Message command at creation (if the message was not
edited on the printer).
• In the current locale (if the message was edited on the printer).
Message header structure

In the example below, the definitions of the line and field structures are omitted for clarity
(For more information, see ‘Line definition’ on page 84 and ‘Field definition’ on page 85).
Sample structure for a message header

An example full sample structure for the message header in SCP might appear as follows:
Message:
- Overwrite: False
- Name: Message_1
- Style: 1x16 Western flexible
- Units: Drops
- Scaling: 1
- Delay: 0
- Count: 0

Nov 2015
127
Reference Manual
- Boundary Check: True

- VGap: 0
- HGap: 0
- Orientation:
- Rotation: 0
- HFlip: False
- VFlip: False
- Printer:
- Type: CIJ
- Pitch:
- Horizontal: 365
- Vertical Adjustment: 0
NOTE: The list of styles returned are the Western versions. The styles available depend on
the configuration code for an individual printer.
Query current message

You can use the following command to retrieve the current message on the printer:
---
Message: Message_1
...
‘Message_1’ is the name of the current message on the printer.
If you downloaded a message with the name ‘Message_1’ and do not edit that message on
the printer, the above command returns that message in the same YAML™ format as it was
downloaded.
If you edit the downloaded message (or the message was not created with SCP), the reply is
a complete message in YAML™ format. In a complete message in YAML™ format, drops
are the units for all positional values. All fields are added to a single line with an offset from
the top left (that is, the top left is treated as the origin).
Line definition
The order of the line sequence is significant. The first entry is assumed to be the top (first)
line. Additional entries are added below the first entry. The structure of each line
component is as follows:
Line:
HGap:
Description: “Gap between field or the starting of line to
field based on the location. It overrides the
default horizontal gap.”
Type: Unsigned int

Nov 2015
127
Reference Manual
Readable: TRUE
Writeable: TRUE
Optional: TRUE
Default: 0
Field: See ‘Field definition’ below
The fields under a line are placed adjacent to each other, from left to right in the order in
which they are added to the line. Lines can be considered as a way in which to arrange the
fields in rows. Multiple lines add fields in multiple rows starting from the top left. If fields
are added without Line nodes, each field is added to a new line until a Line node is seen.
Field definition
A field consists of a generic component (shown below) and a parameters component, which
is dependent on field type (see ‘Message field parameters’ on page 89).
Field:
Name:
Description: “The field name. Only required for barcode source
fields or to set prompt order.”
Type: String
Readable: TRUE
Writeable: TRUE
Optional: TRUE
Minlen: 1
Maxlen: 32
Type:
Description: “The field type.”
Type: Enum
Readable: TRUE
Writeable: TRUE
Optional: TRUE
Default: TEXT
Values -
Text
Date
Image
Counter
Time
Shift

Nov 2015
127
Reference Manual
Remote
Barcode
Visible:
Description: “Field visibility - currently used for
barcodes.”
Type: Bool
Readable: TRUE
Writeable: TRUE
Optional: TRUE
Default: TRUE
Font:
Name:
Description: “The font name.”
Type: String
Readable: TRUE
Writeable: TRUE
Optional: FALSE
Default: Universal
Size:
Description: “The font size.”
Type: Int
Readable: TRUE
Writeable: TRUE
Optional: TRUE
Default: # Depends on the selected style
Min: 1
Max: TBA
Default: Depends on the Units parameter
Units:
Description: “The units used for size and coordinate
values.”
Type: Enum
Readable: TRUE
Writeable: TRUE
Optional: FALSE (required when size or position are
set)

Nov 2015
127
Reference Manual
Default: drops
Values -
mm
drops
point
Rotation:
Description: “Character rotation.”
Type: Unsigned int
Readable: TRUE
Writeable: TRUE
Optional: TRUE
Default: 0
Values -
0
90
180
270
Negative:
Description: “Produces a negative image.”
Type: Bool
Readable: TRUE
Writeable: TRUE
Optional: TRUE
Default: FALSE
Locale:
Description: “Field locale.”
Type: String
Readable: TRUE
Writeable: TRUE
Optional: TRUE
Default: en_GB
Values -
See ‘Appendix B: Locales’
Boldness:
X:

Nov 2015
127
Reference Manual
Description: “The horizontal bold factor.”

Type: Int
Readable: TRUE
Writeable: TRUE
Optional: FALSE
Default: 1
Min: 1
Max: 10
Y:
Description: “The vertical bold factor.”
Type: Int
Readable: TRUE
Writeable: TRUE
Optional: FALSE
Default: 1
Min: 1
Max: 10
Position:
X:
Description: “The X coordinate of the field with
respect to the line coordinates.”
Type: Int
Readable: TRUE
Writeable: TRUE
Optional: TRUE
Min: 0
Max: MAX_INT
Y:
Description: “The Y coordinate of the field with
respect to the line coordinates.”
Type: Int
Readable: TRUE
Writeable: TRUE
Optional: TRUE
Min: 0

Nov 2015
127
Reference Manual
Max: MAX_INT
Current Value:
Description: “Current value for the field.”
Type: String
Readable: TRUE
Writeable: TRUE
Optional: TRUE
Default: User set value
The current value for a field depends on the field type.
CURRENT VALUES FOR FIELD TYPES

Field Type Value Type
Text Current text
Remote Remote field size
Date Date format
Time Time format
Shift Shift text
Sequential Number Current value
Logo Logo name
Barcode Barcode type
Table 16. Current values for field types

NOTE: Current values are overwritten by the values specified in the Parameters node.
3.1.16 Message field parameters

Message field parameters depend on the field type. These parameters are described below.
Text parameters
The following parameters are used in a Text field:
Text:
Description: “The text to be printed.”
Type: String
Readable: TRUE
Writeable: TRUE
Optional: FALSE
Maxlen: 255 / 32 (CIJ/TIJ)
Minlen: 3

Nov 2015
127
Reference Manual
This node can be used to set the default value for a Prompted field and a Shift Code field (it
is optional for a Shift code field). If used in a Shift Code field, the value is not validated. You
can also use the node in a Sequential Number field to set the current value.
Prompted field parameters

The following parameters are used in a Prompted field:
The default value for a Prompted field is set from the Text node under the Parameters
node.
Prompt:
PromptText:
Description: “The text used to prompt the operator.”
Type: String
Readable: TRUE
Writeable: TRUE
Optional: FALSE
Maxlen: 255
Minlen: 1
Type:
Type: Enum
Readable: TRUE
Writeable: TRUE
Optional: FALSE
Default: UserEntry
Values:
-UserEntry
-List
MaxChars
Description: “The maximum number of characters that the
operator may enter.”
Type: Int
Readable: TRUE
Writeable: TRUE
Optional: FALSE
Default: 10
Min: 1
Max: 255

Nov 2015
127
Reference Manual
PromptWidth:
Description: “The text placed in the text entry box
initially.”
Type: Enum
Readable: TRUE
Writeable: TRUE
Optional: FALSE
Default: -Default
Values:
-Default
Description: “User entry is primed with the DefaultText
string.”
-Current
Description: “User entry is primed with the current field
contents.”
-None
Description: “User entry is primed with nothing.”
List:
Description: “An item in the prompt list.”
Type: String list
Readable: TRUE
Writeable: TRUE
Optional: TRUE
Minlen: 1
Maxlen: 255
…
Date parameters
The following parameters can be used in a Date field:
Format:
Description: “The date format.”
Type: String
Readable: TRUE
Writeable: TRUE
Optional: FALSE
Min: 3

Nov 2015
127
Reference Manual
Max: 255 (excluding double quotes, but including single quotes)

The following Date and Time elements can be used:
• D— Day of month 1 - 31, without leading zero
• DD—Day of month 00 - 31
• d—Day week 1 - 7 (1 = Mon)
• M—Month of year 1 - 12, without leading zero
• MM—Month of year 01 - 12
• MMM—Month Abbreviated JAN - DEC
• MMMM—Month Complete JANUARY - DECEMBER
• J366—Day of year 1 - 366 (29th Feb = 366), without leading zero
• JJ366—Day of year 001 - 366 (29th Feb = 366)
• j60—Day of year 1 - 366 (29th Feb = 60), without leading zero
• jj60—Day of year 1 - 366 (29th Feb = 060)
• y—Year of decade 0 - 9
• Y—Year of century 0 - 99 without leading zero
• YY—Year of century 00 - 99
• YYYY—Year (for example, 2014)
• W—Week of year 1 - 53, without leading zero
• WW—Week of year 01 - 53
• HH—Hour 00 - 23
• HHH—Hour of the week
• hh—Hour 00 - 12
• mm—Minute 00 - 60
• mmm—Minute of the day
• ss—Second 00 - 60
• tt—AM / PM
Typical format:"%dd%\%mm%\%yy%
String override with range: "%dd%\% [A-L]mm%\%yy%"
Date and Time formats must always be in the following form:
"'%DATE/TIME-ELEMENT%SEPARATOR'%DATE/TIME-ELEMENT%". You can also use
single quotes instead of double quotes to enclose the string.
Each ‘DATE/TIME-ELEMENT’ must always be enclosed by the ‘%’ symbol.
The SEPARATOR character is optional, but if used, must not be in single quotes. Some
common separators are ' ', ':' , '/', and '-'.

Nov 2015
127
Reference Manual
You can create any Date/Time format with the supported Date/Time elements. Custom
created formats are not displayed in the list of supported formats. When you edit a Date/
Time field with a custom format, the ‘Format’ value in the user interface is empty.
NOTE: If the message is saved in YAML™ format, when the message is returned the extra
characters '!<!>' are added before the format of the date or time.
Offset: (if missing, assume zero offset)
Time:
Description: "The offset time +/- 23:59."
Type: Time
Readable: TRUE
Writeable: TRUE
Optional: TRUE
Default: 00:00
Min: -23:59
Max: 23:59
Days:
Description: “The number of days offset from the current date.
Mutually exclusive to Months.”
Type: Int
Readable: TRUE
Writeable: TRUE
Optional: TRUE
Default: 0
Min: -7305
Max: 7305
Months:
Description: “The number of months offset from the current
date. Mutually exclusive to Days.”
Type: Int
Readable: TRUE
Writeable: TRUE
Optional: TRUE
Default: 0
Min: -240
Max: 240

Nov 2015
127
Reference Manual
Rounding: (if missing, assume no rounding)

Type:
Description: “Round up or down to the nearest value.”
Type: Enum
Readable: TRUE
Writeable: TRUE
Optional: FALSE
Default: Up
Values:
-Up
-Down
-Nearest
To:
Description: “Element to be rounded to.”
Type: Enum
Readable: TRUE
Writeable: TRUE
Optional: TRUE
Default: DayOfWeek
Values:
-DayOfWeek
-DayOfMonth
-LastDayOfMonth
Change:
Description: “Change the day at 00:00 on the day or 00:00 on
the next day.”
Type: Enum
Readable: TRUE
Writeable: TRUE
Optional: TRUE
Default: After
Values:
-On
-After

Nov 2015
127
Reference Manual
Day:
Description: “Day of the week (1-7, Mon=1) or day of the
month.”
Type: Int
Readable: TRUE
Writeable: TRUE
Optional: TRUE
Default: 1
Min: 1:
Max: 31
The offset applies a positive or negative modification to the current date.
Time parameters
The following parameters can be used in a Time field:
Format:
Description: “The time format.”
Type: String
Readable: TRUE
Writeable: TRUE
Optional: FALSE
Minlen: 1
Maxlen: 12
Offset:
Description: “The offset time.”
Type: Time
Readable: TRUE
Writeable: TRUE
Optional: FALSE
Default: 00:00:00
Rounding: (if missing assume no rounding)
Type:
Description: “Round up, down or to the nearest value.”
Type: Enum
Readable: TRUE
Writeable: TRUE
Optional: TRUE

Nov 2015
127
Reference Manual
Default: Up
Values:
-Up
-Down
-Nearest
Hour:
Description: “The minute in the hour to which to round. Mutually
exclusive to Time.”
Type: Int
Readable: TRUE
Writeable: TRUE
Optional: FALSE
Default: 00
Min: 00
Max: 59
Time:
Description: “Time of day to which to round. Mutually exclusive
to Hour.”
Type: Int
Readable: TRUE
Writeable: TRUE
Optional: FALSE
Default: 00:00
Min: 00:00
Max: 23:59
Change:
Description: “Change the time at the time or after a minute.”
Type: Enum
Readable: TRUE
Writeable: TRUE
Optional: TRUE
Default: After
Values:
-On
-After

Nov 2015
127
Reference Manual
The offset applies a positive or negative modification to the current time.
Image parameters
The following Image field type parameters are used:
Image:
Description: “The image to print.”
Type: String
Readable: TRUE
Writeable: TRUE
Optional: FALSE
Minlen: 1
Maxlen: TBA
Remote field parameters

The name of the Remote field is given as part of the field name.
The following Remote field parameters are used:
Text:
Description: “Remote field text.”
Type: String
Readable: TRUE
Writeable: TRUE
Optional: TRUE
Min: 1
Max: 255
Size:
Description: “The remote field length.”
Type: Int
Readable: TRUE
Writeable: TRUE
Optional: TRUE
Default: 5
Min: 1
Max: 255/32 (CIJ/TIJ)
A field name is mandatory for Remote fields in a message. Validation of Remote fields is not
performed by SCP.

Nov 2015
127
Reference Manual
Sequential Number parameters

The following Sequential Number field parameters are used:
Start:
Description: “The start value.”
Type: Int
Readable: TRUE
Writeable: TRUE
Optional: TRUE
Default: 0
Max: 999999999
Min: 0
Stop:
Description: “The end value.”
Type: Int
Readable: TRUE
Writeable: TRUE
Optional: TRUE
Default: 99999
Max: 999999999
Min: 0
Step:
Description: “The increment value.”
Type: Int
Readable: TRUE
Writeable: TRUE
Optional: TRUE
Default: 1
Min: 0
Max: 99999
Repeat:
Description: “The repeat value.”
Type: Int
Readable: TRUE
Writeable: TRUE
Optional: TRUE

Nov 2015
127
Reference Manual
Default: 1
Min: 0
Max: 999999999
CurrentRepeat:
Description: “The current repeat value.”
Type: Int
Readable: TRUE
Writeable: TRUE
Optional: TRUE
Default: 1
Min: 0
Max: 999999999
Range:
Type: Enum
Description: “The characters to use.”
-LATIN
-ARABIC
-HINDI
Shift Code parameters

You can define a Shift Code to repeat daily (Type is Daily), weekly (Type is Weekly), or
over a number of days (Pattern is used, rather than Type). The following Shift Code field
parameters are used:
ShiftType:
Type: (Mutually exclusive with Pattern)
Description: “The Shift code type.”
Type: Enum
Readable: TRUE
Writeable: TRUE
Optional: FALSE
Default: DAILY
Values:
-DAILY
-WEEKLY

Nov 2015
127
Reference Manual
Pattern:
Duration:
Description: “Duration of pattern in days.”
Type: Int
Readable: TRUE
Writeable: TRUE
Optional: TRUE
Default: 7
Min: 1
Max: 100
Start:
Description: “The absolute start date of the pattern (in
the format ‘YYYY-MM-DD’.”
Type: Date
Readable: TRUE
Writeable: TRUE
Optional: FALSE
Cycle:
Shift:
Time:
Description: “The cycle time.”
Type: Time
Readable: TRUE
Writeable: TRUE
Optional: FALSE
Default: 00:00
Text:
Description: “The Shift Code text.”
Type: String
Readable: TRUE
Writeable: TRUE
Optional: FALSE
Minlen: 1
Maxlen: 255/32 (CIJ/TIJ)

Nov 2015
127
Reference Manual
Day: (not present for daily shifts)

Description: “The cycle day (1-7 if weekly type).”
Type: Int
Readable: TRUE
Writeable: TRUE
Optional: TRUE
Min: 1
Max: #7 for weekly, or Pattern duration
Barcode parameters
The following Barcode field parameters are used:
Barcode type:
Description: “Barcode type.”
Type: Enum
Readable: TRUE
Writeable: TRUE
Optional: FALSE
Default: Code 39
Values: ITF 2o5, Code 39, code 128, EAN-8, EAN-13,UPCA, Pharma
Code, DM ECC200, QR Code
SourceFields:
Description: “A list of field names.”
Type: String list
Readable: TRUE
Writeable: TRUE
Optional: FALSE
Minlen: 1
Maxlen: 32
Units:
Description: “Units for height measurement.”
Type: Enum
Readable: TRUE
Writeable: TRUE
Optional: FALSE
Default: drops
Values:

Nov 2015
127
Reference Manual
-mm
-drops
-point
Height:
Description: “Height of barcode in units specified.”
Type: Float
Readable: TRUE
Writeable: TRUE
Optional: FALSE
Min: 5
Max: 34
Units: #as defined by the Units parameter
Checksum:
Description: “Checksum (only applicable to ITF2o5 and Code 39
barcodes).”
Type: Bool
Readable: TRUE
Writeable: TRUE
Optional: TRUE
BarWidth:
Description: “The bar width value in units specified.”
Type: Int
Readable: TRUE
Writeable: TRUE
Optional: TRUE
Default: 6
Min: 1
Max: 12
Units: #as defined by the Units parameter
AspectRatio:
Description: “The Aspect Ratio (Wide:Narrow). Only applicable
to ITF2o5 and Code 39 barcodes.”
Type: String
Readable: TRUE
Writeable: TRUE

Nov 2015
127
Reference Manual
Optional: TRUE
Default: 2:1
HumanReadableText:
Description: “Only applicable to EAN8, EAN13, and UPCA
barcodes.”
Type: Bool
Readable: TRUE
Writeable: TRUE
Optional: TRUE
Size / Version:
Description: “Data Matrix Size or QR Code Version.”
Type: Enum
Readable: TRUE
Writeable: TRUE
Optional: FALSE
Default: 21 x 21 (QR) / 22 x 22 (DM ECC200)
ModuleSize:
Description: “The Module Size in multiples of drop size. Only
applicable to QR codes and DMECC200 barcodes.”
Type: Int
Readable: TRUE
Writeable: TRUE
Optional: TRUE
Default: 1
Min: 1
Max: 12
Version:
Description: “The QR Code Version. Only applicable to QR
codes.”
Type: Int
Readable: TRUE
Writeable: TRUE
Optional: TRUE
Default: 1
Min: 1
Max: 8

Nov 2015
127
Reference Manual
ErrorCorrection:
Description: “The QR Error Correction. Only applicable to QR
codes.”
Type: Enum
Readable: TRUE
Writeable: TRUE
Optional: TRUE
Default: L
Values -
L
Description: Low - 7%
M
Description: Medium - 15%
Q
Description: Q - 25%
H
Description: High - 30%
Logo parameters
The following Logo field parameters are used:
Name:
Description: “The name of the logo.”
Type: String
Readable: TRUE
Writeable: TRUE
Optional: FALSE
Data:
Description: “The contents of the logo.”
Type: Base64 data encoded
Readable: TRUE
Writeable: TRUE
Optional: TRUE
Refer to http://en.wikipedia.org/wiki/Base64 for information about Base64 encoded data.
If only a logo name is provided, then that logo must exist on the printer. If both name and
data are provided, a new logo is created on the printer. If a logo with the same name exists
on the printer, it is only overwritten if the ‘Overwrite’ tag in the message header is set.

Nov 2015
127
Reference Manual
3.1.17 Image
This command can be used to set or retrieve a bitmap image on the printer.
---
Image:
Overwrite:
Description: “Used to overwrite the name of the existing
image.”
Type: Bool
Readable: TRUE
Writeable: TRUE
Optional: TRUE
Name:
Description: “The name of the logo.”
Type: String
Readable: TRUE
Writeable: TRUE
Optional: FALSE
Data:
Description: “The content of the image.”
Type: Base64 data
Readable: TRUE
Writeable: TRUE
Optional: FALSE
Format:
Description: “The image format to be used (currently only .bmp
files are supported).”
Type: String
Readable: TRUE
Writeable: TRUE
Optional: TRUE
...

Nov 2015
127
Reference Manual
3.1.18 Print message

Command Type: Set
Request
This command sets or requests the current printed message.
Simple version
The simple version takes a parameter with the command to either request the current print
message name or select a message for printing.
---
PrintMessage:
Description: “Message Name to be selected for printing.”
Type: String
Readable: TRUE
Writeable: TRUE
Optional: TRUE
Default: Message_1
Minlen: 1
Maxlen: 32
...
Detailed version
The detailed version of the command and its parameters is as follows:
---
PrintMessage:
Repeat:
Description: “Number of times to repeat the cycle (zero means
print indefinitely).”
Type: Int
Readable: TRUE
Writeable: TRUE
Optional: TRUE
Min: 0
Max: MAX_INT
Units: None

Nov 2015
127
Reference Manual
Reset:
Description: “Reset source. When triggered, restarts the
sequence.”
Type: String
Readable: TRUE
Writeable: TRUE
Optional: TRUE
Minlen: 1
Maxlen: 32
PrintAll:
Description: “If TRUE, print all messages loaded with their
repeats from one trigger.”
Type: Bool
Readable: TRUE
Writeable: TRUE
Optional: TRUE
Message:
Name:
Description: “Message name to be printed.”
Type: String
Readable: TRUE
Writeable: TRUE
Optional: TRUE
Default: Message_1
Minlen: 1
Maxlen: 32
Index:
Description: “Message index.”
Type: Int
Readable: TRUE
Writeable: TRUE
Optional: FALSE
Min: 1
Max: TBA

Nov 2015
127
Reference Manual
Repeat:
Description: “Repeat print message count.”
Type: Int
Readable: TRUE
Writeable: TRUE
Optional: TRUE
Default: 1 (one print only)
Min: 0
Max: MAX_INT
...
3.1.19 RF
Command Type: Set
Request
This command is used to populate Remote fields in the current message.
NOTE: Remote data downloaded in a single command appears in the print message at the
same time. The same remote data is printed until new data is available.
There are three mutually exclusive formats for the RF command (see below).
Remote fields must not be used at the same time over RCI and SCP.
Users can only add a maximum of ten remote fields to the printer.
RF command with field name

---
RF:
Remote_Name:
Description: “Remote Field data.”
Type: String
Readable: FALSE
Writeable: TRUE
Optional: FALSE
Minlen: 1
Maxlen: 255
...
Where the key Remote_Name is the name of the remote field that receives the data (or
value) associated with this key. This command can contain several key and value pairs, each
of which refers to a different remote field.

Nov 2015
127
Reference Manual
RF command with one string

---
RF:
Description: “Remote Field data for multiple fields.”
Type: String
Readable: FALSE
Writeable: TRUE
Optional: FALSE
Minlen: 1
Maxlen: TBA
...
The command in this form is used to populate multiple remote fields in the current
message, in the order defined in the message.
RF command with field ordering

---
RF:
Field Index: Remote string
Description: “Remote Field index.”
Type: Integer list
Readable: FALSE
Writeable: TRUE
Optional: FALSE
Minlen: 1
Maxlen: 255
...
The remote field data is supplied as a list of field values, each with a priority or order (P key
value) that indicates which field should be populated with this data.
3.1.20 Info
Command Type: Request
The command and its parameters are as follows.
Simple query
The command to query for all information is as follows:

Nov 2015
127
Reference Manual
---
Info: QY
...
Type query
The command uses the QY keyword to query information by type is as follows. The
response data is shown in the command description.
---
Info:
Printer:
Description: “Printer type.”
Type: String
Readable: TRUE
Writeable: FALSE
Optional: TRUE
Minlen: 1
Maxlen: 255
Build:
Description: “The software build revision.”
Type: String
Readable: TRUE
Writeable: FALSE
Optional: TRUE
Minlen: 1
Maxlen: 255
Firmware:
Description: “The firmware build version.”
Type: String
Readable: TRUE
Writeable: FALSE
Optional: TRUE
Minlen: 1
Maxlen: 255
ID:
Description: “The identity of the printer.”
Type: String

Nov 2015
127
Reference Manual
Readable: TRUE
Writeable: FALSE
Optional: TRUE
Minlen: 1
Maxlen: 255
SerialNo:
Description: “The printer serial number.”
Type: String
Readable: TRUE
Writeable: TRUE
Optional: TRUE
Minlen: 1
Maxlen: 255
Configuration:
Description: “The configuration code.”
Type: String
Readable: TRUE
Writeable: FALSE
Optional: TRUE
Minlen: 1
Maxlen: 255
Network:
Description: “The printer IP Address.”
Type: String
Readable: TRUE
Writeable: FALSE
Optional: TRUE
Minlen: 1
Maxlen: 255
Resources:
Description: “The memory resources on the printer.”
Type: String
Readable: TRUE
Writeable: FALSE
Optional: TRUE

Nov 2015
127
Reference Manual
Minlen: 1
Maxlen: 255
Maintenance:
Description: “Running times and service due data.”
Type: Int
Readable: TRUE
Writeable: FALSE
Optional: TRUE
Minlen: 0
Maxlen: 255
...
3.1.21 Comms
Command Type: Set
Request
This command is used to set up or retrieve SCP settings.
SCP settings are stored as an array of connections, each of which has a unique, identifying
name. The special name ‘COM’ is given to the connection associated with the serial port
and is automatically assigned to the serial connection at power up. For systems that have
fixed IP addresses, use of a name in standard decimal dot format (for example,
192.168.1.255) automatically associates that named connection with the incoming client
connection if the IP address of the client matches. Similarly, if the client has a host name that
is available via a lookup on the name server of the network, then an identically named
connection is used for the settings of the incoming client. It is also possible to use the
Connection command to explicitly assign the named connection to the incoming client.
---
Comms:
Connection:
Name:
Description: “The unique name for the connection.”
Type: String
Readable: TRUE
Writeable: TRUE
Optional: FALSE
Minlen: 1

Nov 2015
127
Reference Manual
Header:
Description: “The characters used to start a command
document.”
Type: String
Readable: TRUE
Writeable: TRUE
Optional: TRUE
Default: "---\n"
Minlen: 1
Maxlen: 3
Footer:
Description: “The characters used to end a command
document.”
Type: String
Readable: TRUE
Writeable: TRUE
Optional: TRUE
Default: "\n…"
Minlen: 1
Maxlen: 3
Active:
Description: “Shows whether the connection is currently
being used.”
Type: Bool
Readable: TRUE
Writeable: FALSE
Optional: TRUE
Timeout:
Description: “The idle timeout value after which period the
connection is closed.”
Type: Integer
Readable: TRUE
Writeable: TRUE
Optional: TRUE
Minlen: MIN_INT
Maxlen: 0 (No timeout is applied)

Nov 2015
127
Reference Manual
Security:
Description: “The security level associated with the
connection.”
Type: Enum
Readable: TRUE
Writeable: FALSE
Values -
NoAccess
Basic
Advanced
Service
AsyncEvents:
PDelay:
Description: “Enable or disable the Print Delay event.”
Type: Bool
Readable: TRUE
Writeable: TRUE
Optional: TRUE
PGo:
Description: “Enable or disable the Print Go event.”
Type: Bool
Readable: TRUE
Writeable: TRUE
Optional: TRUE
PEnd
Description: “Enable or disable the Print End event.”
Type: Bool
Readable: TRUE
Writeable: TRUE
Optional: TRUE
...
NOTE: It is not possible to set a security level that is different from the level for the current
session. This prevents users creating a session with higher privileges, and then
switching to that session.
The response to a command that sets the header or footer strings uses the new set values. If
the command is successful, subsequent commands and responses use the new values.

Nov 2015
127
Reference Manual
3.1.22 PrintImage
The command requests a bitmap image of the current message being printed.
---
PrintImage:
Xoff:
Description: “X Start position of snapshot.”
Type: Int
Readable: TRUE
Writeable: TRUE
Optional: TRUE
Default: 0
Min: 0
Max: MAX_INT
Yoff:
Description: “Y Start position of snapshot.”
Type: Int
Readable: TRUE
Writeable: TRUE
Optional: TRUE
Default: 0
Min: 0
Max: MAX_INT
Width:
Description: “Snapshot width.”
Type: Int
Readable: TRUE
Writeable: TRUE
Optional: TRUE
Default: # Message width
Min: 0
Max: MAX_INT

Nov 2015
127
Reference Manual
Height:
Description: “Snapshot height.”
Type: Int
Readable: TRUE
Writeable: TRUE
Optional: TRUE
Default: # Message height
Min: 0
Max: MAX_INT
Data:
Description: “Image data.”
Type: Binary
Readable: TRUE
Writeable: FALSE
Optional: TRUE
...
3.1.23 PowerDown
Command Type: Set
This command is used to power down the printer. If the PowerDown command parameter
is set to FALSE,the command is acknowledged. If the printer cannot execute the command
because it does not support a software powerdown, the response to a TRUE parameter value
is ‘Unsupported command’.
---
PowerDown:
Description: “Power down now”
Type: Boolean
Readable: TRUE
Writeable: TRUE
Optional: FALSE
...

Nov 2015
127
Reference Manual
3.1.24 Connection
Command Type: Set
---
CommsReset:
Description: “Assign the named connection parameters to this
connection.”
Type: String
Readable: TRUE
Writeable: FALSE
Optional: FALSE
...
3.1.25 Consumables
This command is used to read or reset the consumables history data on the printer.
---
Consumables:
Ink:
Bottles:
Description: “Number of ink bottles used.”
Type: Int
Readable: TRUE
Writeable: FALSE
Optional: TRUE
Min: 0
Max: MAX_INT
RecentBottles:
Description: “Ink bottles used per month.”
Type: Float
Readable: TRUE
Writeable: FALSE
Optional: TRUE
Min: 0

Nov 2015
127
Reference Manual
Max: MAX_FLOAT
Units: Bottles per month
UsageRate:
Description: “Ink usage rate.”
Type: Float
Readable: TRUE
Writeable: FALSE
Optional: TRUE
Min: 0
Max: MAX_FLOAT
Units: Millilitres per hour
Solvent:
Bottles:
Description: “Number of solvent bottles used.”
Type: Int
Readable: TRUE
Writeable: FALSE
Optional: TRUE
Min: 0
Max: MAX_INT
Recent:
Description: “Solvent bottles used per month.”
Type: Float
Readable: TRUE
Writeable: FALSE
Optional: TRUE
Min: 0
Max: MAX_FLOAT
Units: Bottles per month
Usage:
Description: “Solvent usage rate.”
Type: Float
Readable: TRUE
Writeable: FALSE
Optional: TRUE

Nov 2015
127
Reference Manual
Min: 0
Max: MAX_FLOAT
Units: Millilitres per hour
Reset:
Description: “Used to reset the consumables calculation.”
Type: Boolean
Readable: FALSE
Writeable: TRUE
Optional: FALSE
ServiceModule:
Remaining:
Description: “Percentage remaining for the service module.”
Type: Float
Readable: TRUE
Writeable: FALSE
Optional: TRUE
Min: 0
Max: MAX_FLOAT
Units: None
...
3.1.26 Events
This command is used to return the current events and/or the event history of the printer.
---
Events:
Current:
Description: “List of current events.”
Type: String List
Readable: TRUE
Writeable: FALSE
Optional: TRUE
History:
Description: “Event history.”

Nov 2015
127
Reference Manual
Type: String list

Readable: TRUE
Writeable: FALSE
Optional: TRUE
...
3.1.27 Setup
This command is used to configure installation parameters on the printer.
---
Setup:
ConfigCode:
Description: “The configuration code.”
Type: String
Readable: TRUE
Writeable: TRUE
Optional: TRUE
PowerSave:
OnShutdown:
Description: “Powerdown occurs immediately after the jet is
shut down.”
Type: Bool
Readable: TRUE
Writeable: TRUE
Optional: TRUE
DelayOnIdle:
Description: “Powerdown if printer is idle for more than
this delay. Zero means ignore.”
Type: Int
Readable: TRUE
Writeable: TRUE
Optional: TRUE
Values -
Default: 0
Min: 0
Max: MAX_INT

Nov 2015
127
Reference Manual
Units: minutes
DelayOnPrinting:
Description: “Powerdown if printer is in running mode for
more than this delay. Zero means ignore.”
Type: Int
Readable: TRUE
Writeable: TRUE
Optional: TRUE
Values -
Default: 0
Min: 0
Max: MAX_INT
Units: minutes
PrinterName:
Description: “The name of the printer.”
Type: String
Readable: TRUE
Writeable: TRUE
Optional: TRUE
Ink:
Description: “The ink to be selected.”
Type: String
Readable: TRUE
Writeable: TRUE
Optional: TRUE
Solvent:
Description: “The solvent to be selected.”
Type: String
Readable: TRUE
Writeable: TRUE
Optional: TRUE
Keyboard:
Primary:
Description: “The primary keyboard type.”
Type: Enum

Nov 2015
127
Reference Manual
Readable: TRUE
Writeable: TRUE
Optional: TRUE
Secondary:
Description: “The secondary keyboard type.”
Type: Enum
Readable: TRUE
Writeable: TRUE
Optional: TRUE
Locale:
Description: “The user interface locale of the printer.”
Type: Enum
Readable: TRUE
Writeable: TRUE
Optional: TRUE
Hardware:
Photocell:
PCellType:
Description: “The type of photocell being used.”
Type: Enum
Readable: TRUE
Writeable: TRUE
Optional: TRUE
Values -
NPN
PNP
DeadTime:
Description: “The photocell deadtime.”
Type: Int
Readable: TRUE
Writeable: TRUE
Optional: TRUE
Min: 0
Max: 5
Units: ms

Nov 2015
127
Reference Manual
EncoderVoltage:
Description: “The shaft encoder voltage.”
Type: Enum
Readable: TRUE
Writeable: TRUE
Optional: TRUE
Values -
5V
24V
PrintheadHeight:
Description: “The printhead height.”
Type: Int
Readable: TRUE
Writeable: TRUE
Optional: TRUE
Min: -1000
Max: 1000
Units: mm
RemoteField:
Order:
Description: “The ordered list of remote fields.”
Type: String List
Readable: TRUE
Writeable: TRUE
Optional: TRUE
Mode:
Description: “Print Mode.”
Type: String List
Readable: TRUE
Writeable: TRUE
Optional: TRUE
Default: Continuous
Values -
Single
Continuous

Nov 2015
127
Reference Manual
Buffers:
Description: “Number of buffered fields per remote field.”
Type: Int
Readable: TRUE
Writeable: TRUE
Optional: TRUE
Default: 0
Min: 0
Max: 10
ClearBuffers:
Description: “Clear all remote buffers, including message
on stop print.”
Type: Bool
Readable: TRUE
Writeable: TRUE
Optional: TRUE
Default: False
OnFailure:
Description: “Action to take when no remote data is
available to print.”
Type: Enum
Readable: TRUE
Writeable: TRUE
Optional: TRUE
Default: WarnAndIgnore
Values -
WarnAndIgnore
WarnAndPausePrint
...

Nov 2015
127
Reference Manual
3.1.28 UserLevel
Command Type: Set
This command sets up the access level or user for a SCP session.
The possible user values are those names listed on the Select User screen accessed from the
User Login option on the Main Menu screen (these include the OPERATOR and
SUPERVISOR users, plus any other users that have been created on the printer). User PIN
codes for SCP are the same as the PIN codes for the specific printer user.
When the UserLevel command is executed with valid User and PIN parameters, a SCP
session uses the access level associated with that user.
---
UserLevel:
User:
Description: “The user.”
Type: String
Readable: FALSE
Writeable: TRUE
Optional: FALSE
PIN:
Description: “The PIN code of the user.”
Type: String
Readable: FALSE
Writeable: TRUE
Optional: FALSE
...
3.1.29 Asynchronous events

Command Type: Set
Request
This command is used to enable or disable the receipt of certain asynchronous events by the
client. By default no events are sent by the printer.
The command format to enable or disable the events is as follows:
---
AsyncEvents:
PDelay:
Description: “Enable or disable the Print Delay event.”
Type: Bool

Nov 2015
127
Reference Manual
Readable: TRUE
Writeable: TRUE
Optional: TRUE
PGo:
Description: “Enable or disable the Print Go event.”
Type: Bool
Readable: TRUE
Writeable: TRUE
Optional: TRUE
PEnd:
Description: “Enable or disable the Print End event.”
Type: Bool
Readable: TRUE
Writeable: TRUE
Optional: TRUE
...
3.1.30 Summary
This command is used to return a list of the currently available commands.
---
Summary:
Description: “Returns a list of the currently available SCP
commands.”
Type: String list
Readable: TRUE
Writeable: FALSE
Optional: FALSE
...

Nov 2015
127
Reference Manual
3.1.31 Print
This command is used to trigger a print. The command is only accepted only if the printer is
in the ‘Printing’ state and the trigger option is set to ‘Manual’.
---
Print:
Description: “Used to trigger a print.”
Type: Bool
Readable: TRUE
Writeable: TRUE
Optional: FALSE
...

Nov 2015
127
Reference Manual
APPENDIX A: SCP COMMAND

STRUCTURES
This appendix lists SCP command structures without their parameter descriptions.
A.1 Pitch command

---
Pitch:
Horizontal:
Vertical: not implemented for CIJ printers
HorizontalAdj:
VerticalAdj:
...
A.2 ProdLine command

---
ProdLine:
SensorToHead:
PrintPosition:
StoS:
EtoS:
LtoR:
...
A.3 Count command

---
Count:
Message:
Printer:
Batch:
...
A.4 Speed command

---
Speed:

Nov 2015
137
Reference Manual
Mode:
LineSpeed:
EncoderPitch:
...
A.5 Trigger command

---
Trigger:
TriggerMode:
...
A.6 Alarm command

---
Alarm:
24V:
Printer Failure:
Stop Printing:
ScheduledMaintenance:
Printing:
ConsumableWarning:
PrintWarning:
Powerup:
VFC:
PrinterFailure:N
StopPrinting:
Warnings:
...
A.7 Orientation command

---
Orientation:
Rotation:
HFlip:
VFlip:
...

Nov 2015
137
Reference Manual
A.8 Date command

---
Date:
Time:
Date:
UTCOffset:
DST:
...
A.9 Start command

---
Start:
...
A.10 Stop command

---
Stop:
...
A.11 Status command

---
Status:
State:
Fault:
Warning:
...
A.12 Diagnostics command

---
Diagnostics:
RefTOF:
TOF:
Phase:
Pressure:
RefMod:

Nov 2015
137
Reference Manual
Mod:
SolventAdd:
HeadTemp:
...
A.13 Resources command

---
Resources:
Message:
Image:
DateTimeElements:
Font:
MessageStyle:
...
A.14 Delete command

---
Delete:
Message:
Image:
...
A.15 Message command

---
Message:
Overwrite:
Name:
Style:
Units:
Scaling:
PrintDelay:
Count:
BoundaryCheck:
VGap:
HGap:

Nov 2015
137
Reference Manual
Orientation:
Rotation:
HFlip:
VFlip:
Printer:
Type:
Pitch:
Horizontal
Vertical
HorizontalAdj
VerticalAdj
PromptOrder:
Gap
Line:
Field:
Name:
Type:
Visible:
Negative:
Locale:
Bold:
X:
Y:
Position:
X:
Y:
Font:
Name:
Size:
Units:
Rotation:
Parameters: See ‘Message field parameters’ on page 89.
...

Nov 2015
137
Reference Manual
A.16 Image command

---
Image:
Name:
Data:
...
A.17 PrintMessage command

---
PrintMessage:
Repeat:
Reset:
PrintAll:
Message:
Name:
Index:
Repeat:
...
A.18 RF command
---
RF:
RemoteName:
...
A.19 Info command

---
Info:
Printer:
Build:
Firmware:
ID:
SerialNo:
Configuration:
Network:

Nov 2015
137
Reference Manual
Resources:
Maintenance:
...
A.20 Comms command

---
Comms:
Connection:
Name:
Header:
Footer:
Active:
Timeout:
Security:
AsyncEvents:
PDelay:
PGo:
PEnd:
...
A.21 PrintImage command

---
PrintImage:
Xoff:
Yoff:
Width:
Height:
Data:
...
A.22 PowerDown command

---
PowerDown:
...

Nov 2015
137
Reference Manual
A.23 Connection command

---
CommsReset:
...
A.24 Consumables command

---
Consumables:
Ink:
Bottles:
RecentBottles:
UsageRate:
Cartridge:
TotalDrops:
Remaining:
Drops:
Percent:
Prints:
DropsPerPrint:
PrintsDone:
Solvent:
Bottles:
Recent:
Usage:
Cartridge:
Remaining:
Percent:
Reset:
ServiceModule:
Remaining:
...

Nov 2015
137
Reference Manual
A.25 Events command

---
Events:
Current:
History:
...
A.26 Setup command

---
Setup:
ConfigCode:
PowerSave:
OnShutdown:
DelayOnIdle:
DelayOnPrinting:
PrinterName:
Ink:
Solvent:
Keyboard:
Primary:
Secondary:
Locale:
Hardware:
Photocell:
PCellType:
DeadTime: D
EncoderVoltage:
PrintheadHeight:
RemoteField:
Order:
...
A.27 UserLevel command

---
UserLevel:

Nov 2015
137
Reference Manual
User:
PIN:
...
A.28 AsynchEvents command

---
AsyncEvents:
PDelay:
PGo:
PEnd:
...
A.29 Summary command

---
Summary:
...
A.30 Print command

---
Print:
...

Nov 2015
137
Reference Manual
APPENDIX B: SUPPORTED LOCALES

The table below shows the locales supported by SCP..
SUPPORTED LOCALES
Language Locale String
English en_GB
Arabic (Egypt) ar_EG
Arabic (Lebanon) ar_LB
Bulgarian bg_BR
Croatian hr_HR
Czech cs_CZ
German de_DE
Danish da_DK
Greek el_GR
Spanish es_ES
Farsi (Persian) fa_IR
Finnish fi_FI
French fr_FR
Hebrew he_IL
Hindi hi_IN
Hungarian hu_HU
Italian it_IT
Japanese ja_JP
Korean ko_KR
Norwegian nb_NO
Dutch nl_NL
Polish pl_PL
Portuguese bt_BR
Romanian ro_RO
Russian ru_RU
Slovenian sl_SI
Swedish sv_SE
Thai th_TH
Table 18. Supported locales

Nov 2015
139
Reference Manual
SUPPORTED LOCALES
Language Locale String
Turkish tr_TR
Vietnamese vi_VN
Chinese zh_CN
Traditional Chinese zh_TW
Table 18. Supported locales (Continued)
All of the above locales are supported by the printer and are applicable to the date and time
fields in a SCPMessage.
NOTE: For sequential number fields, only the English, Arabic (Egypt), Arabic (Lebanon),
and Hindi locales are supported.

Nov 2015
139
Reference Manual
APPENDIX C: PRINTER
COMMUNICATIONS SETUP
This appendix describes how to configure compatible Linx printers for SCP remote
communications.
C.1 How to connect to the printer with SCP

SCP is currently supported on compatible Linx printers over RS-232 and Ethernet.
C.1.1 RS-232
Use a 9-pin crossover cable to connect your remote device to the printer.
The default R-232 hardware configuration is as follows:
• Baud rate: 115200
• Data bits: 8
• Parity: None
• Stop Bits: 1
• Flow Control: None
C.1.2 Ethernet
Use an Ethernet cable (RJ-45) to connect your remote device to the printer. You can use a
Telnet client or custom application to connect to port 29044 to establish a SCP connection.
C.1.3 Log in to SCP

When you connect to SCP for the first time, you must log in. The following command
allows you to log in to SCP:
---
UserLevel:
User: XYZ
PIN: 1234
…
Where ‘XYZ’ is the username and ‘1234’ is the PIN code of the user. You can also use the
default OPERATOR and SUPERVISOR printer users to log in to the printer
C.2 Add, edit, and delete SCP connections

To add, edit, or delete SCP connection settings, navigate from the Main Menu to Printer
Setup > Communications.

Nov 2015
145
Reference Manual
NOTE: The SCP option on the Communications screen is only enabled if you have
Advanced printer security access rights for the Communications printer functions
(see ‘Security’ on page 10).
Select the SCP option to display the SCP Connections screen. A list of connection session
names is displayed. There are initially two connection sessions on the printer—RS232, the
default RS-232 SCP connection, and Any Ethernet, the default Ethernet SCP connection. If
Ethernet is not configured on the printer, only the RS232 connection session is displayed.
40396
Figure 1. SCP Connections screen

There can be only one RS-232 connection session on the printer. You cannot add another
RS-232 connection. To create a RS-232 connection session with the required properties you
can edit the default RS232 entry (see ‘Edit a SCP connection’ on page 145). The default Any
Ethernet connection session allows any IP address or host name to access SCP, although
you can change this setting.
NOTE: You can create up to five Any Ethernet connection sessions.
The RS232 connection session blocks all connections by default. The Any Ethernet
connection session allows all connections by default.
C.2.1 Add a SCP connection

NOTE: The Add button is disabled if an Ethernet connection is not configured on the
printer.

Nov 2015
145
Reference Manual
To add an Any Ethernet SCP connection, touch the Add button. The Add SCP Connection
screen is displayed.
40397
Figure 2. Add SCP Connection screen

The initial properties for the new connection are the same as the default Any Ethernet
connection. You can change the following properties for your new connection.
• Name—Touch the Name option to open the Name screen, where you can enter a name
for the connection session. This name must be the IP address, or the host name, of the
PC that uses the connection (in ASCII format, up to a maximum of 32 characters).
NOTE: You cannot save an added connection session unless it has a name.
• Connection Allowed—You can toggle this option to enable or disable the named
connection session. If this option is set to Not Allowed, any connections that use that
named session are refused. If, during an active session, this option is changed from
Allowed to Not Allowed, all of the sessions that use that connection are disconnected
(that is, deleted from the connections map).
• Active—This option shows whether the connection session is active (Yes or No). This
option is read-only.
An Ethernet connection is active when it is assigned to a requested connection (and
added to the connections map). An active session becomes inactive when the timeout
period has expired, or the remote PC is disconnected, but only if the session is used by a
single connection.
The RS-232 connection is active when data is first read on the serial port. It becomes
inactive if no data is received before the end of the timeout period.
• Type—This option shows the current connection protocol (either RS232 or Ethernet).
This option is read-only and you cannot edit it.

Nov 2015
145
Reference Manual
• Hardware Setup—This option is only visible if you edit the RS-232 connection session.
Select this option to display the Hardware Setup screen.
40398
Figure 3. Hardware Setup screen

The following options are available:
❐ Baud Rate—This option sets the transmission speed of the data. Linx printers allow
transmission at baud rates of 9600, 19200, 38400, 57600, or 115200 baud.
❐ Data Bits—This option sets the number of data bits sent in each character. Select 5,
6, 7, or 8 bits.
❐ Parity—Parity bits are used to detect errors in transmission. An extra data bit is sent
with each character, so that the number of single bits in each character, including
the parity bit, is always odd or always even. If a byte is received with the incorrect
number of bits, there is an error in the transmission of data. Select None, Odd, or
Even.
❐ Stop Bits—This option sets the stop bits sent at the end of every character to allow
the printer to detect the end of a character. Select 1, 1.5, or 2 bits.
❐ Flow Control—This option sets how the flow of data is controlled. The two options
are:
−Xon/Xoff—The special characters ‘Xon’ and Xoff’ control the flow of data between
the printer and the remote host. An escape character identifies the special
characters in the data stream.
−None—There is no control of the flow of data between the printer and the remote
host.
Select the required options, and then touch the Exit button to return to the Edit SCP
Connection screen.

Nov 2015
145
Reference Manual
• Properties—Select this option to display the Properties screen.

40399
Figure 4. Properties screen

You can configure the following properties:
❐ Header and Footer—These options allow you to enter a maximum of three
characters as a header and footer for the data in the connection session.
❐ Alias File—This option allows you to select a custom .xml file that can be used to
display SCP commands and responses in a different language.
❐ Timeout—This option allows you to set a timeout period for the connection. You
can set the timeout to a value between 0 and 86400 seconds (24 hours).
An Ethernet connection is disconnected when the timeout period expires. If a
session only uses this connection, the session is labelled as Not Active. When the
timeout period for a RS-232 connection expires, the connection is labelled as Not
Active.
❐ Extended Response—If this option is set to Yes, more detailed information is
returned in a SCP document about the cause of any SCP errors.
❐ Security Level—You can use this option to set the security user access level for SCP
functionality. The highest security access level available is always at the level
assigned to the current user. If a user with a lower security access level selects a
connection with a higher security user level, they cannot use that higher security
user access level (only a lower security access level can be set).
Connection screen.
• Async Events—Select this option to allow you to enable and disable the print control
characters for the Print Delay Trigger, Print Go, and Print End events. All of the
options are set to Disabled by default. You can enable the options in any combination,
as required.
Connection screen. Touch the Exit button four times to return to the Main Menu
screen.

Nov 2015
145
Reference Manual
C.2.2 Edit a SCP connection

To edit an existing connection, touch the required entry on the SCP Connections screen.
The Edit SCP Connection screen is displayed, where you can edit the connection
properties, as described in ‘Add a SCP connection’ on page 141.
C.2.3 Delete a SCP connection

NOTE: You cannot delete the default RS232 and Any Ethernet connection sessions.
To delete a connection session, touch the Delete button. The Select Connection to Delete
screen is displayed. Touch the entry you want to delete to highlight it, and then touch the
Delete button. The selected connection session is deleted.
C.2.4 SCP and RCI over RS-232

You cannot select the RCI over RS-232 and SCP protocols at the same time. If you select the
RCI over RS232 option from the RCI Setup screen, the RS-232 connection session in SCP is
automatically labelled as Not Allowed and cannot be used. If the default RS-232 connection
session in SCP is then set to Allowed, the RCI over RS232 option is disabled.
The default setting for the RS-232 connection session in SCP is Not Allowed.
NOTE: The Ethernet connection is not affected by the above restriction.

Nov 2015
145
Reference Manual
APPENDIX D: SCP COMMAND

ACCESS RIGHTS
The table below shows the SCP command operations (see ‘Security’ on page 10) that can be
performed by printer state and user security access rights.
SCP COMMAND ACCESS RIGHTS

Command Printer State Security Level
Idle Starting Running Printing Stopping Failed None Basic Advanced Service
Pitch rw rw rw rw rw rw X X rw rw
Resolution rw rw rw ro rw rw X X rw rw
ProdLine rw rw rw rw rw rw X X rw rw
Count rw rw rw ro rw rw X ro rw rw
Speed rw rw rw ro rw rw X X rw rw
Trigger rw rw rw ro rw rw X X rw rw
Alarm rw rw rw ro rw rw X X rw rw
Orientation rw rw rw ro rw rw X X rw rw
Date rw rw rw ro rw rw X ro rw rw
Start wo wo wo wo wo X X wo wo wo
Stop wo wo wo wo wo X X wo wo wo
Status ro ro ro ro ro ro X ro ro ro
Diagnostics ro ro ro ro ro ro X X X ro
Manifest ro ro ro ro ro ro X X ro ro
Delete wo wo wo woa wo wo X X wo wo
Message rw rw rw rw rw rw X X rw rw
Image rw rw rw rw rw rw X X rw rw
PrintMessage rw rw rw rw rw rw X rw rw rw
RF rw rw rw rw rw rw X rw rw rw
Info ro ro ro ro ro ro X X ro ro
Comms rw rw rw ro rw rw X X rw rw
PrintImage ro ro ro ro ro ro X X ro ro
PowerDown wo X X X X wo X X wo wo
Consumables rw ro ro ro ro ro X X rw rw
Events ro ro ro ro ro ro X X ro ro
Setup rw ro ro ro ro ro X X rw rw
Table 19. SCP command access rights

Nov 2015
147
Reference Manual
SCP COMMAND ACCESS RIGHTS

Command Printer State Security Level
Idle Starting Running Printing Stopping Failed None Basic Advanced Service
UserLevel rw rw rw rw rw rw rw rw rw rw
AsynchEvents rw rw rw ro rw rw - - rw rw
Print - - - rw - - - rw rw rw
Summary ro ro ro ro ro ro - ro* ro* ro*
Table 19. SCP command access rights (Continued)

a. You cannot delete a message that is being printed.
Key:
ro—Read Only
wo—Write Only
wr—Read/Write
x—No Access
NOTE: Both printer state and security level must be set for a read or read/write operation.
For example, both must be Read for a read operation to be valid and both must be
Write for a write operation to be valid.

Nov 2015
147

SCP Manual en Iss2

Uploaded by

Document Information

Copyright

Available Formats

Share this document

Share or Embed Document

Sharing Options

Did you find this document useful?

Is this content inappropriate?

Copyright:

Available Formats

SCP Manual en Iss2

Uploaded by

Copyright:

Available Formats

Linx SCP

Page 1 of 147 TP8C001–2 English

About this manual

Page 2 of 147 TP8C001–2 English

2. COMMAND EXAMPLES ............................................................... 23

Page 3 of 147 TP8C001–2 English

2.14 Message command ................................................................................. 31

Page 4 of 147 TP8C001–2 English

3. SIMPLE COMMUNICATIONS PROTOCOL COMMANDS ........... 47

APPENDIX A: SCP COMMAND STRUCTURES ............................ 128

Page 5 of 147 TP8C001–2 English

A.10 Stop command ...................................................................................... 130

APPENDIX B: SUPPORTED LOCALES ........................................ 138

APPENDIX C: PRINTER COMMUNICATIONS SETUP ................. 140

APPENDIX D: SCP COMMAND ACCESS RIGHTS....................... 146

Page 6 of 147 TP8C001–2 English

1.2 Connect the printer

Page 7 of 147 TP8C001–2 English

YAML SYNTAX ELEMENTS

Table 1. YAML syntax elements

Page 8 of 147 TP8C001–2 English

Table 2. SCP keywords

Page 9 of 147 TP8C001–2 English

Page 10 of 147 TP8C001–2 English

1.7.2 Command security

Table 3. Security properties

Page 11 of 147 TP8C001–2 English

Page 12 of 147 TP8C001–2 English

1.8.1 General parameter properties

GENERAL PARAMETERS PROPERTIES

Table 4. General parameters properties

Page 13 of 147 TP8C001–2 English

Current type values are shown in the table below.

Table 5. Type values

Integer parameter properties

INTEGER PARAMETER PROPERTIES

Table 6. Integer parameter properties

Page 14 of 147 TP8C001–2 English

Float parameter properties

FLOAT PARAMETER PROPERTIES

Table 7. Float parameter properties

Page 15 of 147 TP8C001–2 English

String parameter properties

STRING PARAMETER PROPERTIES

Table 8. String parameter properties

Page 16 of 147 TP8C001–2 English

Page 17 of 147 TP8C001–2 English

Enum parameter properties

ENUM PARAMETER PROPERTIES

Table 9. Enum parameter properties

Page 18 of 147 TP8C001–2 English

Bool parameter properties

Binary parameters properties

BINARY PARAMETER PROPERTIES

Table 10. Binary parameter properties

Page 19 of 147 TP8C001–2 English

Date parameter properties

Time parameter properties

DateTime parameter properties

Page 20 of 147 TP8C001–2 English

Table 11. Error types

Page 21 of 147 TP8C001–2 English

Table 11. Error types (Continued)

Page 22 of 147 TP8C001–2 English