Location via proxy:   [ UP ]  
[Report a bug]   [Manage cookies]                

MiniRemoteComm_v1_7b

Download as pdf or txt
Download as pdf or txt
You are on page 1of 52

MiniTouch / MiniKey

REMOTE
COMMUNICATION
Technical reference

Ethernet / RS232
Version: November 2017
MT Firmware 1.98
Revision history

December 2011 Initial version TDJ


14 Mar 2012 Corrected O:, where : was wrong. Should be Oobject... TDJ
Dec 2017 Added missing CMD:Z for clear buffer TDJ
CONTENT

Introduction .................................................................................................................4
Conventions used in this guide ............................................................................................................ 4
What you should understand before continuing .................................................................................. 4
Basics of communicating with the Mini Series...................................................................................... 5
Examples .............................................................................................................................................. 6

Quick Guide..................................................................................................................7
RS232 quick guide ................................................................................................................................ 7
Ethernet quick guide............................................................................................................................. 8

COMMAND REFERENCE ...............................................................................................9


RS232 command reference ........................................................................................10
Basic commands – prefix: C ................................................................................................................ 10
Object handling – prefix O.................................................................................................................. 13
Content Handling – Prefix O ............................................................................................................... 16
PARAMETER HANDLING – Prefix P ..................................................................................................... 18
REQUEST HANDLING – Prefix R .......................................................................................................... 22

ETHERNET COMMAND REFERENCE ...........................................................................26


COMMANDS – Prefix CMD ................................................................................................................. 26
OBJECT HANDLING – Prefix OBJ ......................................................................................................... 28
PARAMETER HANDLING – Prefix PAR ................................................................................................. 32
REQUEST – Prefix REQ ........................................................................................................................ 36

ENUMERATIONS.........................................................................................................42
ERROR CODES ............................................................................................................45
ENCODING .................................................................................................................46
Encoding tables .................................................................................................................................. 47
Page 4 of 52 Mini Series remote control manual

Introduction

The MiniTouch / MiniKey products are powerful stand-alone controllers with ability to perform almost any
print task using the print jobs as templates and external communication through RS232 or Ethernet.

Design layouts once, and fill with content as required. Select jobs. Change parameters. Ask status – and
many other functions are possible. Using intelligence of external software allows you to extend the
possibilities of the controllers to do almost anything you want.

And with the MiniTouch you have even more flexibility because of its ability to interact with external devices.
With this controller you get 7 output signals that can be controlled by events OR manually by remote control.

You do not get a pre-defined software package with Mini series. Instead, you get the building blocks which
allow you to custom build a tailored solution for the individual application.

Conventions used in this guide

CMD:R# Data string SENT TO controller


RES:0# Data string RECEIVED FROM controller

<ESC> ESCAPE CHARACTER, ascii 27.


<EOT> End of Text character, ascii 04

{variable} Placeholder, like for a command or error code

<a|b|c> Alternatives, meaning a OR b OR c

What you should understand before continuing

In order to understand the protocol for communicating with the Mini series, you should understand:

Basic principles of request-response communication

Basic principles of inkjet concepts, such as offsets, buffers etc

Fundamentals of RS232 and the ASCII character set, such as hexadecimal values and escape codes

Ethernet communication principles such as IP address, subnet mask and sockets.

It does not matter what programming language you use to connect to the controller. Perl, Ruby, VB.NET,
C++, C# or AutoIT Script are all among possible alternatives.

Please bear in mind that HSA can not support you in the above fundamentals.
You should consult an external programmer if you do not fully understand this
documentation.
You are recommended to read the source code of the free examples we provide
and build your application from there.
Page 5 of 52 Mini Series remote control manual

Basics of communicating with the Mini Series

Before going into details about the commands, you should understand some basics about communication
with the Mini Series.

Read below carefully to avoid any issues with your communication.

For Ethernet, all commands and responses are terminated by the “#” character.

A group of “special characters” ( '#' ';' ':' '\' ) must be escaped by \ (backslash) to be used in
content.

ALL other character values are returned and sent in their raw ascii value (32 .. 255). Language
sets other than English must be encoded according to ANSI / Windows 12xx. Make sure that
characters above ascii 127 are not interpreted as control characters in your application. See section
on encoding.

For Ethernet: When content is returned (by a REQuest command) the content is NOT escaped, so
you have to be careful if the content contains one of the special characters. Example: content
##Hello## is returned as DAT:S1=static;tex=##Hello###
The programmer must evaluate only LAST returned separator in the string, or
communication will break.

For RS232 communication, use a NULL-modem cable on pins 2,3 and 5 with these parameters:
You can change these parameters if your applications requires it.

Bits per Second: 115.200


Data Bits: 8
Parity: NONE
Stop Bits 2
Flow Control: NONE

For RS232 you MUST enclose command strings in ESC (ascii 27) and EOT (ascii 04). These special
characters are written <ESC> and <EOT> in this guide.

For Ethernet communication, use device IP address, port 3000. You can set IP / Netmask / Gateway
manually or use DHCP server on same network. DHCP is the simplest and recommended.

The Mini Series will send a response to EVERY command you send with a result code. It is not
NECESSARY to evaluate response, but strongly recommended.

The Mini Series separates OBJECTS and CONTENT. Objects have visual properties like position,
where content have options for the text you can read.

The commands to use are abbreviated to single letters when using RS232. This is to speed up
communication

The commands AND all object names are CASE SENSITIVE. RO is not identical to Ro, like Object1
is not identical to object1
Page 6 of 52 Mini Series remote control manual

Examples

Below follows a few examples of the communication. If you do not understand at first, do not worry, the
commands will be explained below.

The examples both demonstrate connection, changing some content and disconnecting.

RS232 communication
<ESC>CC;admin;admin<EOT> Login
<ESC>C<ACK><EOT> ..accepted
<ESC>CF;FILE1<EOT> Load “FILE1”
<ESC>C<ACK><EOT> ..accepted
<ESC>Obatch:T=12345<EOT> Chg. batch to 12345
<ESC>O<ACK><EOT> ..acepted
<ESC>CD<EOT> Logout

Ethernet communication
CMD:C;admin;admin# Login
RES:0;Transmission OK# ..accepted
CMD:F;FILE1# Load “File1”
RES:0;Transmission OK# ..accepted
OBJ:batch;TEX=12345# Chg. batch to 12345
RES:0;Transmission OK# ..accepted
CMD:D# Logout
Page 7 of 52 Mini Series remote control manual

Quick Guide

Use the quick guide as a 1-page reference for the most common tasks. This is your checklist for most
communication.

RS232 quick guide

The RS232 command string has the following form:


<ESC>{command}{function}:{parameter 1};{parameter 2}<EOT>
<ESC> is ASCII char 027, hex 0x1B
<EOT> is ASCII char 004, hex 0x04

{Command}{function} and {parameters} are separated by a colon. Individual parameters separated by a


semicolon. Not all commands have parameters.

For all commands, the controller will return a response in the form
<ESC>{command}<ACK><EOT> SUCCESS, command accepted
<ESC><NAK>{error code}<EOT> FAIL, not executed

<ACK> is ascii 006, hex 0x06


<NAK> is ascii 021, hex 0x15
{error code} is a distinct code to tell you the fail you made.

The most common commands are:

<ESC>CC<EOT> Connect (logins disabled)


<ESC>CC;a1;xxx<EOT> Login user a1 with pass xxx
<ESC>CF:FILENAME<EOT> Load the layout “filename”
<ESC>RO<EOT> List objects
<ESC>RC<EOT> List content
<ESC>Rc;tex1<EOT> Get information about content "tex1"
<ESC>Oobj1:T=xxx<EOT> Change content in obj1 to xxx
<ESC>CR<EOT> Enter print mode
<ESC>CS<EOT> Leave print mode
<ESC>CD<EOT> Disconnect
Page 8 of 52 Mini Series remote control manual

Ethernet quick guide

Ethernet command string has the following form:


{Command}:{Function};{Parameters}#

For each command, the Mini series will send a response:


RES:0;Transmission OK# SUCCESS
RES:{error code};{error description}# FAIL

The most common commands are:

CMD:C# Connect (logins disabled)


CMD:C;a1;xxx# Login user a1 with pass xxx
CMD:F;filename# Load the layout “filename”
REQ:objects# List objects
REQ:contents# List content
OBJ:obj1;TEX=xxx# Change content in obj1 to xxx
CMD:R# Enter print mode
CMD:S# Leave print mode
CMD:D# Disconnect
Page 9 of 52 Mini Series remote control manual

COMMAND REFERENCE

This chapter contains a complete reference for the commands available on the Mini Series, including
examples.
Page 10 of 52 Mini Series remote control manual

RS232 command reference

Basic commands – prefix: C

Name Function Parameters Reply Description Example Notes


Connect C <user>;<password> (optional) C<ACK> Connects to MT from remote Ex1: If a user is already
location. <ESC>CC<EOT> connected on the terminal,
<user> (optional) IU (input user) (optional) <ESC>IU<EOT> remote user must have
<ESC><user><EOT>
<password> (optional) IP (input password) (optional) Login user+password is used if <ESC>IP<EOT> admin rights to login.
login is enabled <ESC><password><EOT>
on MT. <ESC>C<ACK><EOT>

Ex2:
<ESC>CC;<user>;<password><EOT>
<ESC>C<ACK><EOT>

Disconnect D C<ACK> Disconnect remote connection to <ESC>CD<EOT>


MT <ESC>C<ACK><EOT>
Start print R (none) – just start print mode C<ACK> Start print mode on MT. Parameter '- <ESC>CR<EOT>
<-> (optional - wait for go) ' (minus sign) <ESC>C<ACK><EOT>
starts print mode but wait for go <ESC>CR;-<EOT>
<sw> (optional - print on next command before <ESC>C<ACK><EOT>
'sw' start switches) printing on start switch. Parameter
<sw> is print go <ESC>CR;10<EOT>
<ESC>C<ACK><EOT>
command and MT will print on next
<sw>
start switches.
Stop print S C<ACK> Stop print mode on MT <ESC>CS<EOT>
<ESC>C<ACK><EOT>
Page 11 of 52 Mini Series remote control manual

Update next B C<ACK> User managed buffer: Put 1 print


print on print queue.
buffer

Normal/no buffer: Updates print


buffer. Must be used when objects
are changed during print to avoid
object buffer delay.
Load Job F <job_name> C<ACK> Loads <Job_name> from <path> <ESC>CF;JOBS\\EX\\MY_JOB<EOT> Folder names and
in MT memory. <ESC>C<ACK><EOT> filenames are max 8 chars
<path\\job_name> (optional The <path\\> is optional if job is with large capital letters
path) saved in root. (DOS file names). Use '\\' to
seperate folders in
<path>.

User message U <line1>;<line2>;<line3> C<ACK> Displayes user text lines on MT <ESC>CU;Controlled;Important!; The 3 user lines are
(line2 + line3 are optional) display. Please don't turn off<EOT> displayed on MT
<ESC>C<ACK><EOT> "Remotely Controlled"
menu.
Reboot Q R (reboot optional) C<ACK> Reboots or shuts down MT
(shutdown if R is omitted)
Set output O <output C<ACK> Set an output (0-6), either with an <ESC>CO;1;200;2000<EOT> Output nr 0 = IO output 1
nr>;<delay(mm)>;<pulse(mm)> delayed pulse (outputs 0-3 only) or Output nr 1 = IO output 2
<output nr>;<1|0> with constant value (outputs 2-6 (set IO output 2 for 2000mm after 200mm) Output nr 2 = Control
only) output 1
<ESC>CO;2;1<EOT> Output nr 3 = Control
output 2
(set control output 1)
etc…
Page 12 of 52 Mini Series remote control manual

Clear Buffer Z C<ACK> Clear current print buffer, if running <ESC>CMD:Z<EOT>


user-managed buffer mode the
buffer will not contain anything.
In normal buffer will force a refresh
of content.
Page 13 of 52 Mini Series remote control manual

Object handling – prefix O

Object handling requires Object access = On by remotely connected user.

Multiple parameters for 1 object can be send in 1 command.

Text Objects
Name Function Parameters Reply Description Example Notes
Text <text_object> T=<new text> O<ACK> Sets text of text object (text <ESC>OMY_TEXT;T=this is a Max text size is 127 chars.
object must be linked to a static test<EOT> Only for text objects linked
content, and ONLY contain ONE to static content.
<ESC>O<ACK><EOT>
content).

Font by number <text_object> f=<font number> O<ACK> Sets text print font to font with <ESC>OT1;f=4<EOT>
list number
<font number>.
Font by name <text_object> F=<font name> O<ACK> Sets text print font to font with <ESC>OT1;F=Arial10<EOT>
<font name>.

Position <text_object> P=<x>,<y> O<ACK> Sets text object position in print. <ESC>OT1;P=600,10<EOT> (0,0) is upper left corner.
Measurement in pixel
600 pixel = 1 inch =
2.54cm
Page 14 of 52 Mini Series remote control manual

Graphic objects
Name Function Parameters Reply Description Example Notes
Logo <graphic_object> l=<logo name> O<ACK> Sets active logo of a Graphics logo object <ESC>OL1;l=mylogo<EOT>
by logo name (7-char logo name given at
upload time)
Logo by number <graphic_object> N=<logo number> O<ACK> Sets active logo of a Graphics logo object
by logo number.
Position <graphic_object> P=<x>,<y> O<ACK> Sets graphic object position in print.
Line width <graphic_object> W=<line width in pixels> O<ACK> Sets graphic box or line object line width.
Length <graphic_object> L=<object length in O<ACK> Sets graphic box width or line length.
pixels>
Height <graphic_object> H=<object height in O<ACK> Sets graphic box height.
pixels>
Fill <graphic_object> B=<1|0> (1=ON) O<ACK> Sets graphic box black fill ON/OFF.

Barcode objects

Name Function Parameters Reply Description Example Notes


Text <barcode_object> C=<new text> O<ACK> Sets text of barcode object (barcode object <ESC>Ob1;C=1234<EOT> Max text size is 127 chars.
must be linked to a static content and ONLY Only for barcode objects
ONE content). linked to static content.
Human readable <barcode_object> H=<1|0> (1=ON) O<ACK> Enables/disables human readable text on
barcode.
Size <barcode_object> S=<line width>,<line O<ACK> Set barcode line size.
Page 15 of 52 Mini Series remote control manual

height> (in pixels)


Space <barcode_object> W=<line extra spacing> O<ACK> Set barcode extra white spacing.
(in pixels)
Black <barcode_object> B=<line extra black> (in O<ACK> Set barcode extra black line width.
pixels)
Checksum <barcode_object> O=<0|1> (1=ON) O<ACK> Set barcode checksum on/off.
Type <barcode_object> T=<barcode type> O<ACK> Set barcode type.
Font by number <barcode_object> f=<font number> O<ACK> Sets human readable font to font with list
number
<font number>.
Font by name <barcode_object> F=<font name> O<ACK> Sets human readable font to font with <font
name>.
Position <barcode_object> P=<x>,<y> O<ACK> Sets barcode object position in print.
Page 16 of 52 Mini Series remote control manual

Content Handling – Prefix O

Static content
Name Function Parameters Reply Description Example Notes
Text <Static content> T=<new text> O<ACK> Sets text of a static content object. <ESC>OMY_STATIC;T=this is Max text size is 127 chars.
a test<EOT>
<ESC>O<ACK><EOT>

Counter content
Name Function Parameters Reply Description Example Notes
Minimum value <counter> m=<value> O<ACK> Set minimum count value of a counter Min value must be less than
content. counter max value.
Maximum value <counter> M=<value> O<ACK> Set maximum count value of a counter Max value must be larger than
content. counter min value.
Current value <counter> C=<value> O<ACK> Set current count value of a counter New counter value must be within
content. min/max limits.
Digits <counter> D=<value> O<ACK> Set amount of digits in a counter content. Max 10 digits.
Repeats <counter> R=<value> O<ACK> Set amount of prints per counter
increment.
Step <counter> S=<value> O<ACK> Set counter increment value.
Leadin <counter> L=< |'0'|> (' '=spaces O<ACK> Set leadin of printed counter value. <ESC>OCOUNTER;L=x<EOT>
leadin, (x = other so no leadin)
<ESC>O<ACK><EOT>
'0'=zeros leadin ,
blank/others=no leadin)
Page 17 of 52 Mini Series remote control manual

Date/Time content
Name Function Parameters Reply Description Example Notes
Expirery day offset <datatime_content> E=<day offset> O<ACK> Set day offset of a date content. In the layout design you can
also offset by months, years,
hours, minutes and seconds.
Format <datatime_content> F=<format string> O<ACK> Sets date/time content print format.
(see format types)
Date set <datatime_content> D=<year/month/day> O<ACK> Sets date of a data/time content object. <ESC>ODate1;D=2012/12/30<EOT>
<ESC>O<ACK><EOT>
Time set <datatime_content> T=<hour:minute:second> O<ACK> Sets time of a data/time content object. <ESC>ODate1;T=13:37:14<EOT>
<ESC>O<ACK><EOT>
Page 18 of 52 Mini Series remote control manual

PARAMETER HANDLING – Prefix P

Parameter handling requires Parameter access = On by remotely connected user.

Multiple parameters can be send in 1 command.

Parameter commands are appended with <L|M|none> to set (L)ayout, (M)achine or none=Machine paremeters.
Example: Sets resolution, encoder parm, print mode and buffer mode Machine parameters in 1 command.
<ESC>PM:r=0;e=0,04;E=P;B=-<EOT>
<ESC>P<ACK><EOT>

Print parameters
Name Function Parameters Reply Description Example Notes
Picture length <L|M|none> L=<value> (in pixels) P<ACK> Set picture length i pixels. <ESC>PM:L=2400<EOT> 600 pixel = 1 inch = 2.54
cm
Resolution <L|M|none> r=<600|300|1row300A| P<ACK> Set print resolution. (Sets both vertical and <ESC>PM:r=600<EOT>
1row300B> horizontal resolution to selected). 1row300A
prints with row A only, 1row300B is row B
only.
Vertical Resolution <L|M|none> vres=<600|300|1row300 P<ACK> Set vertical resolution. 600 and 300 implies <ESC>P:vres=1row300A<EOT>
A|1row300B> 2row printing. 1row300A prints with row A
only, 1row300B is row B only.
Horizontal <L|M|none> hres=<75|90|110|150|2 P<ACK> Set horizontal resolution. <ESC>P:hres=320<EOT>
Resolution 00|240
|300|320|400|440|
480|500|600|800|
960|1200|1600|2400>
Print direction <L|M|none> D=<r|l|b> P<ACK> Set print direction (r)ight|(l)eft|(b)idir. <ESC>PL:D=b<EOT>
Page 19 of 52 Mini Series remote control manual

Bidir start direction <L|M|none> b=<r|l|1|2|3|4> P<ACK> Set start print direction on bidir print mode. <ESC>P:b=4<EOT> On input selection, start is
(right)|(l)eft|input(1) select|input(2) select either set print direction or
|input(3) select|input(4) select opposite set print direction
Start distance <L|M|none> S=<value> (in pixels) P<ACK> Set start distance from start signal to print i <ESC>PL:S=140<EOT>
pixels.
Start dist. (bidir) <L|M|none> >=<value> (right P<ACK> Set bidir start distances from start signal to <ESC>PM:>=1200;<=2400<EOT>
direction in pixels) print.
<=<value> (left direction (>)=right print direction
in pixels) (<)=left print direction
Start sensor edge <L|M|none> G=<+|-> P<ACK> Set startsensor active edge (+=positive, - <ESC>P:G=+<EOT>
=negative).
Modular parameter <L|M|none> M=<value> P<ACK> Set modular parameter.
Velocity parameter <L|M|none> V=<velocity> (in P<ACK> Set velocity parameter. (decimal notation is
meters/min) allowed)
Encoder parameter <L|M|none> e=<encoder_par> (in P<ACK> Set encoder parameter. (decimal notation is
mm/pulse) allowed)
Quadrature <L|M|none> Q=<+|-> P<ACK> Set encoder quadrature on|off.
Repeat <L|M|none> R=<repeats>,<repeat_di P<ACK> Set print repeats and distance between
stance> (in pixels) repeats.
Endless mode <L|M|none> U=<+|-> P<ACK> Set endless print on/off.
Print mode <L|M|none> E=<P|M|V> P<ACK> Set print mode (P)osition, (M)odular or
(V)elocity.
Buffer mode <L|M|none> B=<+|-|u> P<ACK> Set print buffer mode (+)normal buffer (-)no
buffer (u)user managed.
Head offset none O=<head nr>;<head P<ACK> Set pen offsets for a complete head. Offset <ESC>P:O=1;0;0;25mm;50.1mm Sets offsets for head 1, in this
offset>;<pen1 offset>;… are written with/without decimal point, and ;75.2mm<EOT> case a 4-pen stall with
value may be appended with unit type <ESC>P<ACK><EOT> head offset 0 and pen offsets
(mm, in or px for mm, inches or pixels 0, 25mm, 50.1mm and
notation). 75.2mm.
Head parameters None H=<head nr.>; Set head parameter: Offset, Upsidedown, <ESC>P:H=1;U=+<EOT> Enable upsidedown for head
<parameter>=<value> otherside, voltage or head size. <ESC>P<ACK><EOT> 1.

parameters:
offset:
O=<value><unit>
upside/down: U=<+|->
Page 20 of 52 Mini Series remote control manual

otherside: S=<+|->
Mirror: M=<+|->
voltage:
V=<voltage>;<fire
width(us)>
size:s=<head_size>

Pen parameters None P=<head nr>;<pen Set pen parameters: turn off, turn on, offset, <ESC>P:P=1;1;I=42;4<EOT> Set ink supply size (42ml) and
nr>;<parm>=<value> overlap, ink setup, ink warning level (4ml)
<ESC>P<ACK><EOT>
ink reset and pen auto switch. of pen 1 in head 1.
parameters:
turn off: -
turn on: +
offset:
O=<value><unit>
overlap: L=<value>
ink setup: I=<ink supply
(ml)>;<ink low (ml)>
ink reset: R+
pen switch: S=<+|->
Set date none d=<year>/<month>/<d P<ACK> Set system date. <ESC>P:d=2012/12/30<EOT>
ay>
(format yyyy/m/d)
Set time None t=<hour>:<minute>:<s P<ACK> Set system time. <ESC>P:t=17:32:59<EOT>
econd>
(format h:m:s)
Set start sensor block None z=<start_block_dist(units) P<ACK> Set start sensor start block distance and end <ESC>P:z=1mm;30mm<EOT>
distances >; block distance including units (mm|in|px).
<end_block_dist(units)>
Page 21 of 52 Mini Series remote control manual

Parameter Source selection


Name Function Parameters Reply Description Example Notes
Select parmaeters SEL <resolution_source> P<ACK> Select resolution, sensor, repeat and head <ESC>PSEL:MMMM<EOT> Set all parameters to Machine source.
source <sensor_source> voltage parameters source to (M)achine or
<repeat_source> <head (L)ayout
voltage source> (L|M)

Network parameter handling


Name Function Parameters Reply Description Example Notes
Network setup N D=<1|0> (DHCP on/off) P<ACK> Set network parameters. Include parameters <ESC>PN:D=0;I=192.168.160.199; Set DHCP off + IP address +
N=<network name> which needs to be changed in command. N=HSAMT<EOT> network name.
I=<IP address> (IPV4 dot <ESC>P<ACK><EOT>
separated)
G=<Gateway address>
M=<network mask>
P=<ip port>,<file port>
Page 22 of 52 Mini Series remote control manual

REQUEST HANDLING – Prefix R

OBJECT INFORMATION
Name Function Parameters Reply Description Example Notes
Grahic Object info o <grahic_line_object> Ro:<object_name>; Request information about a line. <ESC>Ro:gra1<EOT> See enumeration for graphic
(line) <graphic_type>; types.
<X>,<Y>; Measurements in pixel
<line_length>;<line_width>
Graphic Object o <grahic_box_object> Ro:<object_name>; Request information about a box
info <graphic_type>;
(box) <X>,<Y>;
<box_width>;<box_height>;
<line_width>;
<box_fill+|->
Graphic Object o <grahic_logo_object> Ro:<object_name>; Request information about a logo
info <graphic_type>;
(logo) <X>,<Y>;
<logo_width>;<logo_height>;
<logo_name>
Text Object info o <text_object> Ro:<object_name>; Request information about a text Linked content is the name of
<X>,<Y>;<rotation_type>; object the content linked into the
<font_name>; object
<linked_content_1>;…;<linked_content_n>;
<content_seperator_char>
Barcode Object o <barcode_object> Ro:<object_name>; Request information about a barcode Linked content is the name of
info <X>,<Y>;<rotation_type>; object the content linked into the
<font_name>; object
<linked_content_1>;…; See enumeration for barcodes
<linked_content_n>;
<content_seperator_char>;
Page 23 of 52 Mini Series remote control manual

<barcode_type>;
<checksum_0|1>;
<line_width>;
<black_size>;<white_size>;
<human_readable>;
<lines_height>

CONTENT INFORMATION
Name Function Parameters Reply Description Example Notes
Static Content info c <static_content> Rc:<content_name>;<static_text> Info on a static content <ESC>Rc:Sta1<EOT>
Notice! Special characters (;\#:) are <ESC>Rc:Sta1;Hello
world<EOT>
NOT escaped on request content
Counter Content c <counter_content> Rc:<content_name>; Info on a counter content Leadin type = < |0|>
info <current_value>;
<digits>;
<min_value>;<max_value>;
<repeats>;
<step_value>;<leadin_type>
DateTime Content c <data_time_content> Rc:<content_name>; Info on a datetime content Offset format:
info <format>; <year>-<month>-<day>
<offset>; <hour>:<min>:<sec>
<locales_name>
Shift Content info c <shift_content> Rc:<content_name>; Info on a shiftcode content Shift data format:
<shift_datetime_1>;<shift_data_1>; <year>-<month>-<day>
…; <hour>:<min>:<sec>
<shift_datetime_n>;<shift_data_n>
System Content c <system_content> Rc:<content_name>; Info on a system content
info <system_type>
Identifier content c <identifier_content> Rc:<content_name>; Info on an identifier content
<ID_format>
Page 24 of 52 Mini Series remote control manual

OTHER INFORMATION

Name Function Parameters Reply Description Example Notes


Parameters list p <L|M|none> RP:<picture_length>; <start_distance>; Get a list of parameters for
<resolution_type>; either (L)ayout or (M)achine.
quadrature+|->; <print_dir_r|l>; <repeats>; If nothing specified,
<modular_parm>; machine parameters are
<velocity_parm>; <encoder_parm>; returned.
<sensor_edge_+|->;
<endless_+|->; <printmode_p|m|v>;
<buffer_mode_+|-|u>;
<head_offset_1>; <head_size_1>;
<head_1_pen_offset_1>;...;
<head_1_pen_offset_n>;....; <head_n....>

File list D <directory_path> RD:<file/dir_name_1>;….;<file/dir_name_n> <ESC>RD<EOT> directory names are indicated


(optional) <ESC>RD:<SUB>;<SUB2>;f by '<'dir_name'>'
ile1<EOT>

Active jobname F RF:<job_name> Name of active job name.


Does not load a file.
Active user U RU:<user_name> Name of active user.

Object list O RO:<object_name_1>=<tex|bar|grp>;…; List of OBJECTS


<object_name_n>=<tex|bar|grp>
Page 25 of 52 Mini Series remote control manual

Content list C RC:<static_name_1>=<sta>;..;<static_name_n List of CONTENT


>=<sta>;
<counter_name_1>=<cnt>;…;<counter_name_
n>=<cnt>;
<date_time_name_1>=<dat>;…;<date_time_n
ame_n>=<dat>;
<shift_name_1>=<shf>;…;<shift_name_n>=
<shf>;
<system_name_1>=<sys>;…;<system_name_n
>=<sys>;
<identifier_name_1>=<id>;…;<identifier_name
_n>=<id>
Version info V RV:<MT_type>;<firmware_version>;<build_date Version information
>;
<FPGA_version>
Ethernet info I RI:<network_name>;<ip_address>;<ip_netmask Ethernet settings
>;
<ip_gateway>;<ip_com_port>;<ip_file_port>;
<DHCP_on(+)|off(-)|failed(f)>
Uptime T RT:<uptime_hours> Uptime hours, starting from
0 at last power on.
Print info i Ri:<printing_1|0>;<pictures_printed> How many prints has been
done, and print mode
Ink info B RB:<ink_used_pen_1>;…;<ink_used_pen_n> How much ink has been Remaining ink = full amount
used (calculated), in ml. minus used amount
Pen status S RS:<pen_1_status>;<pen_2_status>;… See pen status enumeration

Print Done Interrupt d +/- Rd:<print_done_interrupt_on|off_1|0> (when print done and print If print is very fast, there may
interrupt on:) be more than one print before
<ESC>SP:<prints_since_ an interrupt, so
last_interrupt><EOT> <ESC>SP:2<EOT> may be
returned. (or, 3,4…)
Page 26 of 52 Mini Series remote control manual

ETHERNET COMMAND REFERENCE

Command syntax: <Command>:<Function>;<Parameters>#

Reply on succes: RES:0;Transmission OK# IN THE DOCUMENTATION EXAMPLES BELOW THIS IS SHORTED RES:0#

Reply on fail: RES:<error_code>;<error_description>

COMMANDS – Prefix CMD

Name Function Parameters Reply Description Example Notes


Connect C <user>;<password> (optional) RES:0 Connects to MT from remote Ex1: If a user is already logged in on
location. the terminal, remote user must
<user> (optional) DAT:Please login Login user+password is used if CMD:C# have admin rights
DAT:Please login#
<password> (optional) INP:username (optional) login is enabled
INP:username#
INP:password (optional) on MT. <user>#
INP:password#
<password>#
RES:0#

Ex2:
CMD:C;<user>;<password>#
RES:0#
Disconnect D RES:0 Disconnect remote connection to MT CMD:D#
RES:0#
Start print R None – just start print mode. RES:0 Start print mode on MT. Parameter '-' CMD:R;-# CMD:R# with no parameters
(minus sign) starts print mode but RES:0;# starts print mode and MT will
(start print mode and wait for go
<-> (optional - wait for go) wait for go command before printing print on every start switch if
command)
on start switch. Parameter <sw> is valid.
<sw> (optional - print on next 'sw' start print go
CMD:R;1#
switches) command and MT will print on next
RES:0#
<sw> (print on next start switch only)
start switches.
Stop print S RES:0 Stop print mode on MT
Page 27 of 52 Mini Series remote control manual

Update next B RES:0 User managed buffer: Put 1 print on


print print queue.
buffer
Normal/no buffer: Updates print
buffer.

Must be used when objects are


changed during print to avoid
object buffer delay.
Load Job F <job_name> RES:0 Loads <Job_name> from <path> CMD:F;MY_JOBS\\EX\\MY_JOB# Folder names and filenames are
<path\\job_name> (optional path) in MT memory. RES:0;…# max 8 chars with large capital
letters (DOS file names).
The <path\\> is optional if job is
saved in root. Use '\\' to seperate folders in
<path>.
User message U <line1>;<line2>;<line3> RES:0 Displayes user text lines on MT CMD:U;User control;Do The 3 user lines are displayed on
(line2 + line3 are optional) display. not;turn off# MT "Remotely Controlled" menu.
RES:0;…#
Reboot Q R (reboot optional) RES:0 Reboots or shuts down MT CMD:Q#
RES:0;#
(shutdown if R is omitted) CMD:Q;R#
RES:0;#
Set output O <output RES:0 Set an output (0-6), either with an CMD:O;1;200;2000# Output nr 0 = IO output 1
nr>;<delay(mm)>;<pulse(mm)> delayed pulse (outputs 0-3 only) or RES:0;…# Output nr 1 = IO output 2
<output nr>;<1|0> with constant value (outputs 2-6 (set IO output 2 for Output nr 2 = Control output 1
only) 2000mm after 200mm) Output nr 3 = Control output 2
etc…
CMD:O;2;1#
RES:0;…#
(set control output 1)
Clear Buffer Z RES:0 Clear print buffer. User managed CMD:Z#
buffer will be empty. Normal buffer
refreshed.
Page 28 of 52 Mini Series remote control manual

OBJECT HANDLING – Prefix OBJ

Object handling requires Object access = On by remotely connected user.

Multiple parameters for 1 object can be send in 1 command.

TEXT OBJECTS
Name Function Parameters Reply Description Example Notes
Text <text_object> TEX=<new text> RES:0 Sets text of text object (text object OBJ:MY_TEXT;TEX=this is a test# Max text size is 127 chars.
must be linked to a static content). RES:0;# Only for text objects linked to static
content.
Font by number <text_object> FNT=<font number> RES:0 Sets text print font to font with list
number <font number>.
Font by name <text_object> FON=<font name> RES:0 Sets text print font to font with OBJ:Text1;FON=Arial10#
<font name>. RES:0;…#
Position <text_object> POS=<x>,<y> RES:0 Sets text object position in print. Position is in pixel, upper left corner is
(0,0)

GRAPHIC OBJECTS
Name Function Parameters Reply Description Example Notes
Logo <graphic_object> PAT=<logo name> RES:0 Sets active logo of a Graphics OBJ:log1;PAT=complog# Request object / content list for valid
logo object by logo name. RES:0;…# names.
Page 29 of 52 Mini Series remote control manual

Logo by number <graphic_object> NUM=<logo RES:0 Sets active logo of a Graphics


number> logo object by logo number.
Position <graphic_object> POS=<x>,<y> RES:0 Sets graphic object position in
print.
Line width <graphic_object> WID=<line width in RES:0 Sets graphic box or line object
pixels> line width.
Length <graphic_object> LEN=<object length RES:0 Sets graphic box width or line
in pixels> length.
Height <graphic_object> HIG=<object height RES:0 Sets graphic box height.
in pixels>
Fill <graphic_object> FLL=<On|Off> RES:0 Sets graphic box black fill ON/OFF.

BARCODE OBJECTS
Name Function Parameters Reply Description Example Notes
Text <barcode_object> CON=<new text> RES:0 Sets text of barcode object OBJ:BC1;CON=123456789012# Max text size is 127 chars.
(barcode object must be linked RES:0;…# Only for barcode objects linked
to a static content). to static content.

Content must be valid for


symbology.
Human readable <barcode_object> HUM=<1|0> (1=ON) RES:0 Enables/disables human
readable text on barcode.
Size <barcode_object> SIZ=<line width>;<line height> (in RES:0 Set barcode line size.
pixels)
Space <barcode_object> SPC=<line extra spacing> (in pixels) RES:0 Set barcode extra white spacing.
Black <barcode_object> BLK=<line extra black> (in pixels) RES:0 Set barcode extra black line
width.
Checksum <barcode_object> CHK=<0|1> (1=ON) RES:0 Set barcode checksum on/off.
Type <barcode_object> TYP=<barcode type> RES:0 Set barcode type. See barcode enumerations
Page 30 of 52 Mini Series remote control manual

Font by number <barcode_object> FNT=<font number> RES:0 Sets human readable font to font
with list number
<font number>.
Font by name <barcode_object> FON=<font name> RES:0 Sets human readable font to font
with <font name>.
Position <barcode_object> POS=<x>,<y> RES:0 Sets barcode object position in
print.

STATIC CONTENT
Name Function Parameters Reply Description Example Notes
Text <static_content> TEX=<new text> RES:0 Sets text of a static content OBJ:MY_STATIC;TEX=this is a test# Max text size is 127 chars.
object. Special characters can be
RES:0;…#
escaped using \ character.
Literal \ is input as \\

COUNTER CONTENTS
Name Function Parameters Reply Description Example Notes
Minimum value <counter_content> MIN=<value> RES:0 Set minimum count value of a OBJ:C1;MIN=125# Min value must be less than
counter content. RES:0;…# counter max value.
Maximum value <counter_content> MAX=<value> RES:0 Set maximum count value of a Max value must be larger than
counter content. counter min value.
Current value <counter_content> CUR=<value> RES:0 Set current count value of a New counter value must be
counter content. within min/max limits.
Digits <counter_content> DIG=<value> RES:0 Set amount of digits in a counter Max 10 digits.
content.
Page 31 of 52 Mini Series remote control manual

Repeats <counter_content> REP=<value> RES:0 Set amount of prints per counter


increment. (repeat value)
Step <counter_content> STP=<value> RES:0 Set counter increment value.
(step value)
Leadin <counter_content> LDN=< |'0'|> (' '=spaces leadin, RES:0 Set leadin of printed counter OBJ:C1;LDN= # (SPACE)
'0'=zeros leadin , blank/others=no value. RES:0;…#
leadin)

DATE/TIME CONTENT
Name Function Parameters Reply Description Example Notes
Expirery day offset <datatime_content> EXP=<day offset> RES:0 Set day offset of a date content. OBJ:D1;EXP=10# Set relative date, based on
RES:0;…# no.of days.
In design mode offset can also
be set to years, months, hours
and minutes
Format <datatime_content> FOR=<format string> (see format RES:0 Sets date/time content print OBJ:D1;FOR=yyyy-mm-dd#
types) format. RES:0;…#
Date set <datatime_content> DAT=<year/month/day> RES:0 Sets date of a data/time content Set absolute value, opposite to
object. expiery day offset.
Time set <datatime_content> TIM=<hour:minute:second> RES:0 Sets time of a data/time content Set absolute time
object.
Page 32 of 52 Mini Series remote control manual

PARAMETER HANDLING – Prefix PAR

Parameter handling requires Parameter acces On by remotely connected user.


Multiple parameters can be send in 1 command.
Paremeter commands are appended with <L|M|none> to set (L)ayout, (M)achine or none=Machine paremeters.
Examlpe: Sets resolution, encoder parm, print mode and buffer mode Machine parameters in 1 command.
PAR:M;RES=600;ENC=0,04;ENM=pos;BUF=-#
RES:0;…#"

NORMAL PARAMETERS
Name Function Parameters Reply Description Example Notes
Picture length <L|M|none> LEN=<value> (in pixels) RES:0 Set picture length i pixels. PAR:L;LEN=600# 600 pixel = 1 inch = 2.54 cm
RES:0;…#
size=<value> (in pixels)
Resolution <L|M|none> RES=<600|300|1row300A|1row300B> RES:0 Set print resolution. (Sets both
resolution=<600|300|1row300A|1row300B> vertical and horizontal
resolution to selected)
1row300A prints with row A
only, 1row300B is row B only.
Vertical Resolution <L|M|none> vres=<600|300|1row300A|1row300B> RES:0 Set vertical resolution.
600 and 300 implies 2row
printing. 1row300A prints with
row A only, 1row300B is row B
only.
Horizontal <L|M|none> hres=<75|90|110|150|200|240|300| RES:0 Set horizontal resolution in DPI PAR;hres=440#
Resolution 320|400|440|480|500| RES:0;…#
600|800|960|1200|1600|2400>
Page 33 of 52 Mini Series remote control manual

Print direction <L|M|none> DIR=<right|left|bidir> RES:0 Set print direction right, left or
direction=<right|left|bidir> bidirectionel.
<L|M|none> BDR=<right|left|inp1|inp2|inp3|inp4> Set print start direction on Start direction is FIRST print
bidirection=<right|left|inp1|inp2|inp3|inp4> bidirectionel mode. direction after print mode has
Right, left, input1 select, input2 been activated.
select,…
Start distance <L|M|none> DIS=<value> (in pixels) RES:0 Set start distance from start
start=<value> (in pixels) signal to print i pixels.
Start dist. (bidir) <L|M|none> DRT=<value> (right direction in pixels) RES:0 Set bidir start distances from
DLT=<value> (left direction in pixels) start signal to print.
start right=<value> (right direction in pixels)
start left=<value> (left direction in pixels)
Start sensor edge <L|M|none> EDG=<pos|neg> RES:0 Set startsensor active edge
edge=<positive|negative> (+=positive, -=negative).
Modular <L|M|none> MOD=<value> RES:0 Set modular parameter.
parameter modular=<value>
Velocity parameter <L|M|none> VEL=<velocity> (in meters/min) RES:0 Set velocity parameter. (decimal PAR;VEL=25.33#
velocity=<velocity> (in meters/min) notation is allowed) RES:0;…#
Encoder parameter <L|M|none> ENC=<encoder_par> (in mm/pulse) RES:0 Set encoder parameter. PAR;ENC=0.00716#
encoder=<encoder_par> (in mm/pulse) (decimal notation is allowed) RES:0;…#
Quadrature <L|M|none> QDT=<+|-> RES:0 Set encoder quadrature on|off.
quadrature=<+|->
Repeat <L|M|none> REP=<repeats>,<repeat_distance> (in pixels) RES:0 Set print repeats and distance
repeat=<repeats>,<repeat_distance> (in between repeats.
pixels)
Endless mode <L|M|none> ENL=<+|-> RES:0 Set endless print on/off.
endless=<+|->
Print mode <L|M|none> ENM=<pos|mod|vel> RES:0 Set print mode to Position, PAR;mode=velocity#
mode=<position|modular|velocity> Modular or Velocity. RES:0;…#
Buffer mode <L|M|none> BUF=<+|-|u> RES:0 Set print buffer mode
buffermode=<+|-|u> (+)normal buffer (-)no buffer
(u)user managed.
Head offset <L|M|none> OFF|offset=<head nr>;<head offset>;<pen1 RES:0 Set offsets for a complete head. PAR:OFF=1;0;0;25mm;50.1mm;75.2mm# Sets offsets for head 1, in this
offset>;… Offset are written RES:0;…# case a 4-pen stall with
with/without decimal point, head offset 0 and pen offsets
PAR:OFF=2;3in;0;1in#
and value may be RES:0;…# 0, 25mm, 50.1mm and
Page 34 of 52 Mini Series remote control manual

appended with unit type 75.2mm.


(mm, in or px for mm, inches or
pixels notation). Second example for head 1,
head offset = 3 in, pen offset
2 = 1 inch
Head parameters <L|M|none> HEA|head=<head RES:0 Set head parameter: Offset, PAR:head=1;UPS=+# Enable upsidedown for head
nr.>;<parameter>=<value> Upsidedown, otherside, voltage RES:0;…# 1.
or head size.
PAR:HEA=2;MIR=+#
parameters: RES:0;…# Set MIRROR = on for head 2
offset: OFF|offset=<value><unit>
upside/down: UPS|updown=<+|->
otherside: OTH|othside=<+|->
voltage: VOL|voltage=<volt>;<fire
width(us)>
size: SIZ|size=<head_size>
mirror: MIR|mirror=<+|->
Pen parameters <L|M|none> PEN|pen=<head nr>;<pen RES:0 Set pen parameters: turn off, PAR:PEN=1;1;INK=42;4# Set ink supply size (42ml) and
nr>;<parm>=<value> turn on, offset, overlap, ink RES:0;…# ink warning level (4ml)
parameters: setup, of pen 1 in head 1.
turn off: OFF|off|- ink reset and pen auto switch.
turn on: ON|on|+
offset: OFS|offset=<value><unit>
overlap: OVL|overlap=<value>
ink setup: INK|ink=<ink supply (ml)>;<ink
low (ml)>
ink reset: RST|reset
pen switch: SWH|switch=<+|->
Set date none date=<year>/<month>/<day> (format RES:0 Set system date. PAR:date=2009/9/17#
yyyy/m/d) RES:0;…#
Set time none time=<hour>:<minute>:<second> RES:0 Set system time. PAR:time=13:42:00#
(format h:m:s) RES:0;…#
Set start sensor none BLK|block=<start_block_dist(units)>; RES:0 Set start sensor start block
block distances <end_block_dist(units)> distance and end block distance
including units (mm|in|px).
PAR:M;RES=600;ENC=0,04:ENM=pos;BUF=- Sets resolution, encoder parm,
# print mode and buffer
RES:0;…#
mode Machine parameters in
Page 35 of 52 Mini Series remote control manual

1 command.

Parameter set selection


Name Function Parameters Reply Description Example Notes
Select parmaeters SEL <resolution_source><sensor_source> RES:0 Select resolution, sensor and PAR:SEL;MMMM# Set all parameters to
source <repeat_source><head setup source> repeat parameters source to Machine source.
(L|M) (M)achine or (L)ayout

COMMUNICATION PARAMETER selection


Name Function Parameters Reply Description Example Notes
Network setup N DHCP=<on|off> RES:0 Set network parameters. PAR:N;DHCP=off;IP=192.168.160.199;NAME=MT1# Set DHCP off + IP
NAME=<network name> Include parameters which RES:0;…# address + network
IP=<IP address> (dot '.' seperated) needs to be changed in name.
PAR:N;PORT=9000,9300#
GATE=<Gateway address> command. RES:0;…#
MASK=<network mask> Example 2 changes
PORT=<ip port>,<file port> Note when changing default port settings
network settings via
network,
the connection may be
disconnected.
UART setup U BAUD=<value> (bits per sec) RES:0 Set RS232 connection PAR:U;BAUD=115200;BITS=8;PARITY=none;STOP=2#
BITS=<5|6|7|8> parameters.
PARITY=<none|even|odd>
STOP=<1|2>
Page 36 of 52 Mini Series remote control manual

REQUEST – Prefix REQ

TEXT OBJECT
Name Function Parameters Reply Description Example Notes
Text Object info OBJ <text_object> DAT:<object_name>=text; Return information See enumerations on rotation
pos=<X>,<Y>pix; about a text object types and content types
object ori=<rotation_type>;
font=<font_name>;
<content_1_type>=<linked_content_1>;…;
<content_n_type=<linked_content_n>;
sep=<content_seperator_char>

BARCODE OBJECT
Name Function Parameters Reply Description Example Notes
Barcode Object OBJ <barcode_object> DAT:<object_name>=barcode; Return information See enumeration on barcode
info pos=<X>,<Y>pix; about a barcode types
object ori=<rotation_type>;font=<font_name>; object
<content_1_type>=<linked_content_1>;…;
<content_n_type=<linked_content_n>;
sep=<content_seperator_char>;
bartype=<barcode_type>;
checktype=<checksum_0|1>;
modules=<line_width>;
blacksize=<black_size>;
whitesize=<white_size>;
Page 37 of 52 Mini Series remote control manual

human read=<human_readable>;
height=<lines_height>

GRAPHIC OBJECT
Name Function Parameters Reply Description Example Notes
Grahic Object OBJ <grahic_line_object> DAT:<object_name>=graphic; Request info on a
info object type=<graphic_type>; line
(line) pos=<X>,<Y>pix;
length=<line_length>pix;
line=<line_width>pix
Graphic Object OBJ <grahic_box_object> DAT:<object_name>=graphic; Request info on a
info object type=<graphic_type>; box
(box) pos=<X>,<Y>pix;
width=<box_width>pix;
height=<box_height>pix;
line=<line_width>pix;
fill=<box_fill+|->
Graphic Object OBJ <grahic_logo_object> DAT:<object_name>=graphic; Request info on a
info object type=<graphic_type>; logo
(logo) pos=<X>,<Y>pix;
width=<logo_width>pix;
height=<logo_height>pix;
logo=<logo_name>
Page 38 of 52 Mini Series remote control manual

CONTENT information
Name Function Parameters Reply Description Example Notes
Static Content info CON <static_content> DAT:<content_name>=static;tex=<static_text> Request value of REQ:CON;MyStatic#
static content DAT:MyStatic=static;
tex=Hello, World#
content

Counter Content CON <counter_content> DAT:<content_name>=counter;value=<current_value>; Properties of counter


info content digits=<digits>;min=<min_value>;max=<max_value>; content
rep=<repeats>;step=<step_value>;leadin=<leadin_type>
DateTime Content CON <data_time_content> DAT:<content_name>datetime;format=<format>; Properties of Offset format:
info content offset=<offset>;locale=<locales_name> date/time content <year>-<month>-
<day>
<hour>:<min>:<sec>
Shift Content info CON <shift_content> DAT:<content_name>=shift; Properties of shift Shift data format:
content timeshift=<shift_datetime_1>;data=<shift_data_1>;…; content <year>-<month>-
timeshift=<shift_datetime_n>;data=<shift_data_n> <day>
<hour>:<min>:<sec>

There are maximum 5


rules.
System Content CON <system_content> DAT:<content_name>=system;type=<system_type> Properties of system See types enumeration.
info content content. Returns the type, not the
actual value
Identifier content CON <identifier_content> DAT:<content_name>=identifier;ID=<ID_format> Properties of GS1
content identifier
Page 39 of 52 Mini Series remote control manual

Other information that can be returned


Name Function Parameters Reply Description Example Notes
Parameters list PAR <L|M|none> DAT:size=<picture_length>pix; Return a lot of print REQ:PAR;M# If the argument is
parameters start=<start_distance>pix; parameters. DAT:size=2560pix; left out, default is
start=400pix;
res=<resolution_type>; res=600; machine parameters
quad=<quadrature+|->; ….
dir=<print_dir_right|left>;
repeat=<repeats>,<repeat_dist>pix;
mod=<modular_parm>;
vel=<velocity_parm>;
enc=<encoder_parm>;
edge=<sensor_edge_pos|meg>;
endless<endless_+|->;
mode=<printmode_pos|mod|vel>;
buffer=<buffer_mode_+|-|u>;
headoffset=<head_offset_1>;headsize=<head_size_1>;
penoffset<head_1_pen_offset_1>;...;
penoffset<head_1_pen_offset_n>;....;
head...=<head_n....>

File list DIR <directory_path> DAT:dir;<file/dir_name_1>;….;<file/dir_name_n> directory names are


dir (optional) indicated by
'<'dir_name'>'
Active jobname FIL DAT:file=<job_name> Request active file
filename name. Does not
change file.
Active user user DAT:user=<user_name> Request active
Page 40 of 52 Mini Series remote control manual

username
Object list OLS DAT:objects;<object_name_1>=<tex|bar|grp>;…; Get an object list REQ:OLS#
objects <object_name_n>=<tex|bar|grp> DAT:objects;S1=tex;
S2=tex;obj145=tex#

Content list CLS DAT:contents; Get a content list REQ:Contents#


contents <static_name_1>=<sta>;..;<static_name_n>=<sta>; DAT:contents;
static1=sta;
<counter_name_1>=<cnt>;…;<counter_name_n>=<cnt>; MyBarcode1=sta;
<date_time_name_1>=<dat>;…;<date_time_name_n>=<dat>; TimeDate1=dat#
<shift_name_1>=<shf>;…;<shift_name_n>=<shf>;
<system_name_1>=<sys>;…;<system_name_n>=<sys>;
<identifier_name_1>=<id>;…;<identifier_name_n>=<id>

Version info VER DAT:version; Get version REQ:version#


version System=<MT_type>;ver=<firmware_version>; information of DAT:version;System=
MiniKey;ver=1.65C;
build=<build_date>;FPGA=<FPGA_version> controller firmware. build=15. jan 2011;
FPGA=49.3#

Ethernet info IP DAT:tcpip;name=<network_name>;ip=<ip_address>; Get information on TCP Since you need to be


tcpip mask=<ip_netmask>;gateway=<ip_gateway>; settings connected to request
ipport=<ip_com_port>;fileport=<ip_file_port>; it, must be known
dhcp=<on|off|failed> already ☺
Useful to uniquely
identify each
controller in a
network
Uptime UP DAT:uptime=<uptime_hours>hr Get uptime since last Integer hours
uptime power on
Page 41 of 52 Mini Series remote control manual

Print info PI DAT:print info;print=<on|off>;prints=<pictures_printed> Get status of print


print info mode and no. of prints
done
Ink info II DAT:ink info;<ink_used_pen_1>;…;<ink_used_pen_n> Get ink status REQ:II# Ink remaining = ink
ink info DAT:ink info; size minus ink status
3;4;40;13#
Pen status PS DAT:pen1=<pen_status_nr>;<pen_status_text>;pen2=… Get status of each pen REQ:pen status# See penstatus
pen status DAT:pen1=12;pen2=12; enumeration.
pen3=0;pen4=0#
12 is ”OK” status.
Print done interrupt PD <on|off> DAT:print done=<on|off> Request print done REQ:PD# When set on and
print done (when print done and print interrupt on: interrupt print done.
SYS:PRD;<prints_since_last_interrupt>) [print] MT returns
SYS:PRD;1#
SYS:PRD;<prints>
Page 42 of 52 Mini Series remote control manual

ENUMERATIONS

BARCODES
Barcodes types Limitations
EAN8 8 digits (7 + checksum)
EAN13 13 digits (12+checksum)
UPCA 13 digits (12+checksum)
ITF Even number of digits (uneven number + checksum)
Code39 Digits only
Code128 None
EAN128 Must have identifier structure
DM None
GS1DM Must have identifier structure

DATE / TIME
Date & Time format types
| separates alternatives
Day of week #d | #D
Day of year #j | #J (zeros leadin)
Week of year #w | #W (zeros leadin)
Year (4 chars) yyyy | YYYY
Year (2 chars) yy | YY
Year (1 char) y|Y
Month (2 chars) mm | MM zero leadin
Month (1-2 chars) m|M
Month (short names) mmm | MMM
Month (long names) mmmm | MMMM
Day (2 chars) dd | DD zero leadin
Day (1-2 chars) d | DD
Day (short names) ddd | DDD
Day (long names) dddd | DDDD
Hour (1-2 chars) h|H
Hour (2 chars) hh | HH zero leadin
(Casing as indicated,
AM/PM hours pp | PP | Pp | pP eg. hhpp -> 02am, hPp -> 2Am)
Minute (1-2 chars) n|N
Minute (2 chars) nn | NN zero leadin
Seconds (1-2 chars) s|S
Seconds (2 chars) ss | SS zero leadin
Page 43 of 52 Mini Series remote control manual

CONTENT / OBJECTS
Content types
sta Static
cnt Counter
dat Date/Time
shf Shift Code
sys System var.
id Identifier

Object types
tex Text objects
bar Barcode objects
grp Graphic objects

System types
user print user name
line print line name
file print job filename
print print print number

Grahic types
0 Line
1 Box
2 Logo
Page 44 of 52 Mini Series remote control manual

PARAMETERS
Pen status decode:
0: Offline
1: Power off
2: Hot
3: Warm
4: Short
5: Power low
6: Power high
7: Fault
8: New pen installed
9: Stall open
10: Ink low
11: No ink
12: Pen online

Print resolutions types (Vertical)


resolution text resolution
600 600 DPI
300 300 DPI (2 rows highspeed)
1row300A 300 DPI (one row, row A)
1row300B 300 DPI (one row, row B)
Page 45 of 52 Mini Series remote control manual

ERROR CODES

Code Description Explanation / when returned


RS-232 Ethernet
0 0 Transmission OK Command understood
1 2 Unknown command Initial command incorrect. Take care when sending data from a
script, it’s easy to send <CR><LF>Command… which will
fail since CR and LF are also interpreted
2 300 Object not found Request object names first
3 301 OBJ: not a number Numeral expected
4 310 POS: x not a number Numeral expected
5 311 POS: y not a number Numeral expected
6 318 FONT: not a number Numeral expected (existing font)
7 321 FONT: invalid font
8 340 LOGO: unknown logo
9 343 LOGO: invalid logo
10 352 BARCODE: function failed
11 353 BARCODE: unknown type
12 354 BARCODE: invalid checksum
13 600 SYSTEM: unknown variable
14 602 TEXT: function failed
15 1010 PAR: not a number
16 1020 PAR: unknown edge
17 1050 PAR: unknown printmode
28 220 Printing, can't start now Tried to start print when already printing
29 221 Stopped, can't stop now Tried to stop print when already stopped
30 104 User remote login not allowed A user is already logged into the controller. Remote user MUST
have admin rights to overrule
31 105 Not connected No commands can be executed if not logged in
32 101 Username not found See userlist on controller.
33 102 Password not accepted
34 210 File not found
35 504 Not found
36 106 Parameters changes not allowed Parameter access off for user name
37 404 Object changes not allowed Object access off for user name
44 4001 BUF: Print buffer full Tried to add more than 4 images to user-managed buffer
45 4002 BUF: Print buffer empty Tried to print on user managed (empty) buffer
Page 46 of 52 Mini Series remote control manual

ENCODING

Is is important to understand that MiniTouch and MiniKey are NOT using UniCode standards (multiple bytes
per character) to store character values. Instead, all characters are stored as a SINGLE byte value.

The actual character that will appear on the screen and in print will depend on the character encoding
selected on the font. In other words, a font encoded in "Western" may display a totally different character
from a font encoded in "Cyrillic". Whereas with UniCode, the character would always be the same.

MiniTouch / MiniKey supports the following encodings:

Codepage Language group

Win-1250 Central / Eastern Europe

Win-1251 Cyrillic

Win-1252 English / Western Europe

Win-1253 Greek (Modern)

Win-1254 Turkish

Win-1257 Baltic

Win-1258 Vietnamese

Win-932 Japanese (Shift-JIS), half-width KATAKANA only

Notice: Although encodings exist for Hebrew and Arab, these languages are not supported as the controller
can not combine characters in the correct way, and does not respect the R2L direction.

All other languages (character sets) not covered in the table above are generally NOT supported. This
especially includes all "complex scripts" (chinese, japanese, korean, arab, farsi, pashtun, hebrew, thai etc).

Notice also that UniCode contains many more diacritics not found in the encodings above. (example: ก)

The encodings above are fully supported given the right byte values. This includes screen menus, locales,
keyboard and variable print.

In order to communicate strings the raw byte values must be sent and interpreted when received. It is up to
the controlling software / device to know the encoding.
Page 47 of 52 Mini Series remote control manual

Encoding tables

Windows 1250

Central and Eastern Europe

Windows 1251

Cyrillic
Page 48 of 52 Mini Series remote control manual

Win 1251

English and Western Europe

Windows 1253

Modern Greek
Page 49 of 52 Mini Series remote control manual

Win 1254

Turkish

Windows 1257

Baltic Region
Page 50 of 52 Mini Series remote control manual

Win 1258

Vietnamese

Windows 932

Japanese (Shift-JIS)

NOTICE: Shaded byte values are meant for double byte


characters. These are NOT available.

This table shows half-width KATAKANA only.


Page 51 of 52 Mini Series remote control manual

Tools and Example Code (coming soon)

HSA Systems has developed a number of tools and example code that you can use as inspiration for your
projects.

This section will contain an overview of the tools and examples.


Page 52 of 52 Mini Series remote control manual

Support

For technical support in remote communication to MiniTouch and MiniKey, please contact

applications@hsasystems.com

You might also like