Home » Epson Manuals » Cash Registers & POS Equipment » Epson TM-H6000IV-DT » Manual Viewer

Epson TM-H6000IV-DT ePOS-Device XML Users Manual - Page 2

Cautions, Trademarks, ESC/POS, Command System, EPSON, EXCEED YOUR VISION - parts

View all Epson TM-H6000IV-DT manuals

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

Page 2 highlights

Cautions • No part of this document may be reproduced, stored in a retrieval system, or transmitted in any form or by any means, electronic, mechanical, photocopying, recording, or otherwise, without the prior written permission of Seiko Epson Corporation. • The contents of this document are subject to change without notice. Please contact us for the latest information. • While every precaution has taken in the preparation of this document, Seiko Epson Corporation assumes no responsibility for errors or omissions. • Neither is any liability assumed for damages resulting from the use of the information contained herein. • Neither Seiko Epson Corporation nor its affiliates shall be liable to the purchaser of this product or third parties for damages, losses, costs, or expenses incurred by the purchaser or third parties as a result of: accident, misuse, or abuse of this product or unauthorized modifications, repairs, or alterations to this product, or (excluding the U.S.) failure to strictly comply with Seiko Epson Corporation's operating and maintenance instructions. • Seiko Epson Corporation shall not be liable against any damages or problems arising from the use of any options or any consumable products other than those designated as Original EPSON Products or EPSON Approved Products by Seiko Epson Corporation. Trademarks EPSON, EXCEED YOUR VISION, and ESC/POS are registered trademarks of Seiko Epson Corporation in Japan and other countries/regions. Windows and Internet Explorer are either registered trademarks or trademarks of Microsoft Corporation in the United States and other countries. AndroidTM and Google ChromeTM are either registered trademarks or trademarks of Google Inc. in the United States and other countries. Apple, Mac, Mac OS and Xcode iPhone, iPad are either registered trademarks or trademarks of Apple Inc. in the United States and other countries. iOS is registered trademarks or trademarks of Cisco in the United States and other countries. Flash, FlexTM are either registered trademarks or trademarks of Adobe Systems Incorporated in the United States and other countries. JavaTM is a registered trademark of Oracle Corporation, its subsidiaries, and affiliates in the U.S. and other countries. Eclipse is a trademark or registered trademark of Eclipse Foundation, Inc. ESC/POS® Command System EPSON has been taking industry's initiatives with its own POS printer command system (ESC/POS). ESC/POS has a large number of commands including patented ones. Its high scalability enables users to build versatile POS systems. The system is compatible with all types of EPSON POS printers (excluding the TM-C100) and displays. Moreover, its flexibility makes it easy to upgrade the future. The functionality and the user-friendliness is valued around the world. © Seiko Epson Corporation 2014. All rights reserved. 2

Section	Page
Cover	1
For Safety	3
Key to Symbols	3
Restriction of Use	3
About this Manual	4
Aim of the Manual	4
Manual Content	4
Contents	5
Chapter 1 Overview	11
ePOS-Device XML	11
Features	12
System Configuration Example	12
How to Use the Communication Box	13
Operating Environment	16
Application Environment	16
Application Terminal	16
TM-Intelligent	16
TM Printer	17
Customer Display	17
Peripheral Device	18
Contents in the Package	19
Manual	19
Sample Program	19
Download	19
Restrictions	20
Chapter 2 Building Environment	21
Updating the ePOS-Device	21
TM-DT Series	21
TM-i Series	22
Workflow	23
TM-DT Series	23
TM-i Series	24
Registration of Device Control Script (TM-DT Series)	25
Registration of Device	27
TM-DT Series	27
TM-i Series	30
Chapter 3 Programming Guide	33
Programming Flow	33
If Reconnecting to the TM-Intelligent when the Network was Cut Off	34
Programming flow for the Communication Box	35
Service Interface Specifications	38
Format	38
Communication Data Example	39
Communication Box Message Example	42
Array of <data> elements in <device_data> message	44
Chapter 4 ePOS-Device XML	45
ePOS-Device XML List	45
Message	45
Message Data for Communication Box	46
Message Data for Each Device	46
Messages	49
<connect>	49
<reconnect>	50
<disconnect>	51
<admin_info>	52
<open_commbox>	54
<close_commbox>	56
<commbox_data>	57
<open_device>	58
<close_device>	60
<device_data>	62
<error>	63
Message Data for Communication Box	64
<type>getcommhistory</type>	64
<type>send</type>	66
<type>onreceive</type>	67
Message Data for Device Hub Terminal	68
<type>shutdown</type>	68
<type>onshutdown</type>	68
Message Data for the Barcode Scanner	69
<type>ondata</type>	69
Message Data for Printers	70
<type>print</type>	70
<type>onxmlresult</type>	70
Message Data for Hybrid Printers	71
<type>lock</type>	71
<type>unlock</type>	71
<type>print</type>	72
<type>onxmlresult</type>	72
<type>slipprint</type>	73
<type>slipcancel</type>	73
<type>endorseprint</type>	74
<type>endorsecancel</type>	74
<type>micrread</type>	75
<type>micrcancel</type>	76
<type>micreject</type>	76
<type>micrcleaning</type>	76
<type>onreceive</type>	77
Printer Control XML	79
<epos-print>	79
<response>	81
<text>	84
<feed>	90
<image>	92
<logo>	94
<barcode>	95
<symbol>	99
<hline>	104
<vline-begin>	105
<vline-end>	106
<page>	107
<area>	108
<direction>	109
<position>	110
<line>	111
<rectangle>	112
<cut>	113
<pulse>	114
<sound>	115
<command>	117
<layout>	118
<recovery>	121
<reset>	121
Message Data for the Customer Display	122
<type>display</type>	122
<type>onxmlresult</type>	123
Customer Display Control XML	124
<epos-display>	124
<response>	125
<window>	126
<text>	128
<cursor>	129
<blink>	130
<brightness>	131
<marquee>	132
<clock>	133
<clear>	133
<reset>	133
<command>	133
Message Data for the POS Keyboard	134
<type>onkeypress</type>	134
<type>setprefix</type>	135
<type>onstring</type>	136
<type>setMSRPrefix</type>	137
<type>ondata</type>	138
Message Data for the Serial Device	139
<type>sendcommand</type>	139
<type>oncommandreply</type>	140
Chapter 5 Device Control Script	141
Programming	141
Using Device Control Script	141
Configuration of Device Control Script	142
List of Device Control Script API	144
ClientConnection object	144
DeviceConnection object	144
Device Control Script Name object	144
ClientConnection Object	145
send	145
DeviceConnection Object	146
send	146
Device Control Script Name Object	147
onDeviceData event (Input Device That Can Run with a HID Driver)	147
onDeviceData event (Serial Communication Device)	147
Any event	148
Chapter 6 Sample Program	149
Outline	149
Building Environment for Android	150
Environment	150
Flow of environment construction for TM-DT Series	151
Flow of environment construction for TM-i Series	153
Installing Java SE Development Kit	155
Setting Up Eclipse	157
Setting Up Android SDK Manager	159
Installing ADT Plugin	164
Importing the Sample Program	168
Setting the Barcode Scanner	170
Building Environment for iOS	172
Environment	172
Flow of environment construction for TM-DT Series	173
Flow of environment construction for TM-i Series	174
Setting the Barcode Scanner	175
Setting the Sample Program	177
Executing Sample Program	178
Androiod	178
How to Use the Sample Program	183
Appendix	185
List of KeyCode	185
Printer specifications	187
TM-H6000IV-DT/ TM-H6000IV	187
TM-T70II-DT/ TM-T70II	189
TM-T88V-DT/ TM-T88V-i/ TM-T88V	191
TM-T20II-i	193
TM-T70-i/ TM-T70	195
TM-T82II-i/ TM-T82II	197
TM-L90	199
TM-P60II	201
TM-P60II with Peeler	203
TM-P80	205
TM-T20	207
TM-T20II	209
TM-T88IV	211
TM-T90	213
TM-U220	215
Paper setting function of TM-L90	217
Setting Paper Width	217

Match case Limit results 1 per page

Cautions

•

No part of this document may be reproduced, stored in a retrieval system, or transmitted in any form or

by any means, electronic, mechanical, photocopying, recording, or otherwise, without the prior written

permission of Seiko Epson Corporation.

•

The contents of this document are subject to change without notice. Please contact us for the latest

information.

•

While every precaution has taken in the preparation of this document, Seiko Epson Corporation assumes

no responsibility for errors or omissions.

•

Neither is any liability assumed for damages resulting from the use of the information contained herein.

•

Neither Seiko Epson Corporation nor its affiliates shall be liable to the purchaser of this product or third

parties for damages, losses, costs, or expenses incurred by the purchaser or third parties as a result of:

accident, misuse, or abuse of this product or unauthorized modifications, repairs, or alterations to this

product, or (excluding the U.S.) failure to strictly comply with Seiko Epson Corporation’s operating and

maintenance instructions.

•

Seiko Epson Corporation shall not be liable against any damages or problems arising from the use of any

options or any consumable products other than those designated as Original EPSON Products or EPSON

Approved Products by Seiko Epson Corporation.

Trademarks

EPSON, EXCEED YOUR VISION, and ESC/POS are registered trademarks of Seiko Epson Corporation in Japan

and other countries/regions.

Windows



and Internet Explorer



are either registered trademarks or trademarks of Microsoft Corporation in

the United States and other countries.

Android

and Google Chrome

are either registered trademarks or trademarks of Google Inc. in the

United States and other countries.

Apple



, Mac



, Mac OS



and Xcode



iPhone



, iPad



are either registered trademarks or trademarks of

Apple Inc. in the United States and other countries.

iOS



is registered trademarks or trademarks of Cisco in the United States and other countries.

Flash



, Flex

are either registered trademarks or trademarks of Adobe Systems Incorporated in the United

States and other countries.

Java

is a registered trademark of Oracle Corporation, its subsidiaries, and affiliates in the U.S. and other

countries.

Eclipse



is a trademark or registered trademark of Eclipse Foundation, Inc.

ESC/POS

Command System

EPSON has been taking industry’s initiatives with its own POS printer command system (ESC/POS). ESC/POS

has a large number of commands including patented ones. Its high scalability enables users to build versa-

tile POS systems. The system is compatible with all types of EPSON POS printers (excluding the TM-C100) and

displays. Moreover, its flexibility makes it easy to upgrade the future. The functionality and the user-friendli-

ness is valued around the world.