Home » Epson Manuals » Printers » Epson TM-m30III » Manual Viewer

Epson TM-m30III ePOS-Device XML Users Manual - Page 11

Features, How to Use the Communication Box p.13, Specifying the Print Job ID from the Application p.16

Add to My Manuals
Save this manual to your list of manuals

Page 11 highlights

Chapter 1 Overview - ePOS-Device XML Features ❏ No need to prepare any device (such as a PC) to act as a controller to control the peripheral devices. ❏ Epson peripheral devices as well as many other peripheral devices can be controlled via device control programs and device control scripts developed exclusively by Epson. Since the version of the loaded software differs depending on the printer, the controllable peripheral devices also differ. For details on the controllable peripheral devices, refer to the Technical Reference Guide of the printers. Device control programs are supported by TM-DT series devices with version 4.0 or later of the TM-DT software. Refer to the TM-DT Series Peripheral Device Control Guide for more information on device control programs and device control scripts. ❏ Accessing a device automatically locks the device exclusively. Even if accessed from multiple terminals simultaneously, the device is not under multiple controls. When the terminal that has controlled the device releases the device, the device becomes controllable from another terminal. ❏ If the network is cut off, you can easily re-establish the connection. ❏ Data can be sent and received between web applications. For details, refer to How to Use the Communication Box (p.13). ❏ Printing requests can be made to the printer by specifying the printing job ID. *2 For details, refer to Specifying the Print Job ID from the Application (p.16). ❏ Printing data can be sent to the printer without waiting for a printing complete response from the printer. (Spooler) *2 For details, refer to Spooler Function (p.17). ❏ Print data can be sent to another printer if the printer sends an error response (PAPER END, COVER OPEN, etc.) or does not return a response. (Print forwarding) *2 For details, refer to Forwarding (p.18). ❏ You can shut down the TM-DT from the application. *1 (DeviceHubTerminal object) *1 TM-DT series is supported only. *2 ePOS-Device Service Ver.2.6 or later 11

Section	Page
Cover	1
For Safety	3
Key to Symbols	3
Restriction of Use	3
About this Manual	3
Aim of the Manual	3
Manual Content	3
Contents	4
Chapter 1 Overview	10
ePOS-Device XML	10
Features	11
System Configuration Example	12
How to Use the Communication Box	13
Specifying the Print Job ID from the Application	16
Spooler Function	17
Operating Environment	19
Application Environment	19
Application Terminal	19
Supported Printers	19
ePOS-Device Service Versions	20
Controllable Peripheral Devices	22
Contents in the Package	25
Manual	25
Sample Program	25
Download	25
Restrictions	26
Chapter 2 Building Environment	27
Workflow	27
TM-DT Series	27
TM-T88VI-iHUB	28
Other TM-i Series	28
TM-H6000V	29
Registration of Device	30
TM-DT Series	30
TM-T88VI-iHUB	32
Other TM-i Series	33
TM-H6000V	34
Chapter 3 Programming Guide	35
Programming Flow	35
If Reconnecting to the printer when the Network was Cut Off	36
Programming flow for the Communication Box	37
Performing check process	40
Using the Spooler Function	43
Service Interface Specifications	44
Format	44
Communication Data Example	45
Communication Box Message Example	47
Array of <data> elements in <device_data> message	50
Chapter 4 XML Reference	51
List of ePOS-Device XMLs	51
Message	51
CommunicationBox Messages	52
Device Messages	52
DeviceHubTerminal	53
BarcodeScanner	53
Printer	54
HybridPrinter	54
CustomerDisplay	56
Keyboard	56
POSKeyboard	57
MSR	57
SerialDevice	57
Storage	57
OtherPeripheral	57
PrinterControl XML	58
CustomerDisplayControl XML	63
Message	66
<connect>	66
<reconnect>	67
<disconnect>	68
<admin_info>	69
<open_commbox>	70
<close_commbox>	72
<commbox_data>	73
<open_device>	74
<close_device>	76
<device_data>	78
<service_data>	80
<error>	82
CommunicationBox Messages	84
<type>getcommhistory</type>	84
<type>send</type>	86
<type>onreceive</type>	87
DeviceHubTerminal Messages	88
<type>shutdown</type>	88
<type>onshutdown</type>	89
<type>restart</type>	90
<type>onrestart</type>	91
BarcodeScanner Messages	92
<type>ondata</type>	92
Printer Messages	93
<type>print</type>	93
<type>onxmlresult</type>	95
HybridPrinter Messages	97
<type>lock</type>	97
<type>unlock</type>	98
<type>print</type>	99
<type>onxmlresult</type>	100
<type>slipwaitinsertion</type>	101
<type>slipprint2</type>	102
<type>slipcancel</type>	103
<type>endorsewaitinsertion</type>	104
<type>endorseprint2</type>	105
<type>endorsecancel</type>	106
<type>validationwaitinsertion</type>	107
<type>validationprint2</type>	108
<type>validationcancel</type>	109
<type>micrread</type>	110
<type>micrcleaning</type>	111
<type>micrcancel</type>	112
<type>eject</type>	113
<type>onreceive</type>	114
PrinterControl XML	117
<epos-print>	117
<response>	118
<text>	121
<feed>	126
<image>	128
<logo>	131
<barcode>	132
<symbol>	137
<hline>	142
<vline-begin>	143
<vline-end>	144
<page>	145
<area>	146
<direction>	148
<position>	149
<line>	150
<rectangle>	152
<cut>	154
<pulse>	155
<sound>	156
<command>	158
<layout>	159
<recovery>	163
<reset>	164
<batch-begin>	165
<batch-end>	167
<rotate-begin>	168
<rotate-end>	170
CustomerDisplay Messages	171
<type>display</type>	171
<type>onxmlresult</type>	172
CustomerDisplayControl XML	173
<epos-display>	173
<response>	174
<window>	176
<screen>	179
<textarea>	182
<cursor>	184
<text>	186
<marquee>	188
<blink>	190
<brightness>	191
<backgroundcolor>	192
<slideshow>	193
<downloadimage>	194
<registerdownloadimage>	196
<nvimage>	198
<clearimage>	200
<symbol>	201
<clearsymbol>	203
<clock>	204
<clear>	205
<reset>	206
<command>	207
Keyboard Messages	208
<type>onkeypress</type>	208
<type>setprefix</type>	209
<type>onstring</type>	210
<type>setMSRPrefix</type>	211
<type>ondata</type>	212
POSKeyboard Messages	213
<data>onkeypress</data>	213
MSR Messages	214
<data>ondata</data>	214
SerialDevice Messages	215
<type>sendcommand</type>	215
<type>oncommandreply</type>	216
Storage Messages	217
<type>operate</type>	217
<type>operateresult</type>	218
OtherPeripheral Messages	219
<type>User-defined Function</type>	219
<type>User-defined Event</type>	220
List of KeyCode	221
Chapter 5 Device Specifications	223
Supported Printers by XMLs	223
ePOS-Device XML Functions That Can Be Used with TM Printer	225
ePOS-Device XML Functions That Can Be Used	225
Messages That Can Be Used	225
Registration of Device	226
Limitations	226
List of Supported Elements	227
PrinterControl XML	227
CustomerDisplayControl XML	232
Printer-specific Support Information	236
TM-T20II-i	236
TM-T70-i	241
TM-T82II-i	245
TM-T83II-i	250
TM-T88V-i	255
TM-T88VI-iHUB	260
TM-U220-i	266
TM-T70II-DT	269
TM-T70II-DT2	274
TM-T88V-DT	279
TM-T88VI-DT2	284
TM-H6000IV-DT	289
TM-H6000V	294
TM-m30	300
TM-m30II	305
TM-m30II-H	310
TM-m30II-NT	315
TM-m30II-S	320
TM-m30II-SL	325
TM-m30III	330
TM-m30III-H	335
TM-m50	340
TM-T88VI	345
TM-T88VII	351
TM-L100	357
TM-m10	363
TM-P20	368
TM-P60II (Receipt)	374
TM-P60II (Peeler)	380
TM-P80	386
TM-T20	392
TM-T20II	397
TM-T70	402
TM-T70II	406
TM-T82II	411
TM-T83II	416
TM-T88IV	420
TM-T88V	424
TM-T90	429
TM-L90	433
TM-U220	437
TM-H6000IV	440
Usage restriction by firmware version	444
Chapter 6 Sample Program	448
Outline	448
Building Environment for Android	449
Environment	449
Flow of environment construction for TM-DT Series	450
Flow of environment construction for TM-T88VI-iHUB	452
Flow of environment construction for other TM-i Series	453
Installing Java SE Development Kit	455
Setting Up Eclipse	457
Setting Up Android SDK Manager	459
Installing ADT Plugin	464
Importing the Sample Program	468
Setting the Barcode Scanner	470
Building Environment for iOS	471
Environment	471
Flow of environment construction for TM-DT Series	472
Flow of environment construction for TM-T88VI-iHUB	473
Flow of environment construction for other TM-i Series	474
Setting the Barcode Scanner	475
Setting the Sample Program	475
Executing Sample Program	476
Android	476

Match case Limit results 1 per page

Chapter 1

Overview - ePOS-Device XML

Features

❏

No need to prepare any device (such as a PC) to act as a controller to control the peripheral devices.

❏

Epson peripheral devices as well as many other peripheral devices can be controlled via device control pro-

grams and device control scripts developed exclusively by Epson.

Since the version of the loaded software differs depending on the printer, the controllable peripheral devices

also differ.

For details on the controllable peripheral devices, refer to the Technical Reference Guide of the printers.

Device control programs are supported by TM-DT series devices with version 4.0 or later of the TM-DT soft-

ware.

Refer to the TM-DT Series Peripheral Device Control Guide for more information on device control programs

and device control scripts.

❏

Accessing a device automatically locks the device exclusively.

Even if accessed from multiple terminals simultaneously, the device is not under multiple controls. When the

terminal that has controlled the device releases the device, the device becomes controllable from another ter-

minal.

❏

If the network is cut off, you can easily re-establish the connection.

❏

Data can be sent and received between web applications.

For details, refer to

How to Use the Communication Box (p.13)

❏

Printing requests can be made to the printer by specifying the printing job ID.

For details, refer to

Specifying the Print Job ID from the Application (p.16)

❏

Printing data can be sent to the printer without waiting for a printing complete response from the printer.

(Spooler)

For details, refer to

Spooler Function (p.17)

❏

Print data can be sent to another printer if the printer sends an error response (PAPER END, COVER OPEN, etc.)

or does not return a response. (Print forwarding)

For details, refer to

Forwarding (p.18)

❏

You can shut down the TM-DT from the application.

(DeviceHubTerminal object)

*1 TM-DT series is supported only.

*2 ePOS-Device Service Ver.2.6 or later