Device Data Notification User`s Manual
Contents
1. 19 E Request Device Use Rights Acquisition Result Notification esses 19 E Response Device Use Rights Acquisition Result Notification 20 E Request Input Data from Input 21 E Response Input Data from Input 22 E Request Device Control Execution 23 E Response Device Control Execution 24 E Response to Disable Device 24 Chapter 1 Overview Overview This chapter provides the overview of Device Data Notification Overview of Device Data Notification Device Data Notification is a function used to post the data input from the input device that is connected to the TM intelligent printer to the designated URL of the Web server The Web server application performs device control such as printing and displaying information on the customer display by including print data in ePOS Device XML format and device control into the response to a request from the TM intelligent printer Web server Application TM Intelligent Printer Input Device 1 When a data input occurs for example when an operator reads a barcode with the barcode2. ID amp Data lt device_data gt lt sequence gt 0 lt sequence gt lt device_id gt local_scanner lt device_id gt lt data gt lt resultdata gt response success true code statusz 251658262 battery 0 xmlnsz http www epson pos com schemas 2011 03 epos print gt lt resultdata gt type onxmlresult type data data gt 5 lt id device data When the TM intelligent printer receives multiple device control data items from the Web server the TM intelligent printer executes each device control result separately The device control execution result is sent as one HTTP request Device Control Execution Result to the Web server for each device control 23 Response Device Control Execution Result Input Device TM Intelligent Printer Web server 1 Data input occurs p 1 1 HTTP Request Input Data 1 1 1 Create XML from a database or HTTP Response other system Device Control 2 Device Control Execution HTTP Request 1 Device Control Execution Result 3 1 Register control result to a database or other system HTTP Response Device Control 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 ES 1 1 1 1 1 1 1 The Web server application creates response data to a HTTP request Device Control Execution Result and returns it to the TM intelligent printer For the r
3. amp Data lt device_data gt lt sequence gt 0 lt sequence gt lt device_id gt local_scanner lt device_id gt lt data gt lt inout gt XXXXxXX lt input gt lt type gt ondata lt type gt lt data gt lt data_id gt X lt data_id gt lt device_data gt 21 Response Input Data from Input Device Input Device TM Intelligent Printer Web server 1 Data input occurs gt 1 1 1 HTTP Request Input Data 1 1 1 Create XML from a database or HTTP Response other system Device Control The Web server application creates response data as shown below to a HTTP request Input Data and returns it to the TM intelligent printer This data contains device control data The format of response message is ePOS Device XML text xml HTTP 1 1 200 OK Content Type text xml charset utf 8 Content Length xxx lt device_data gt lt device_id gt local_keyboard lt device_id gt lt data gt lt type gt print lt type gt lt Timeout gt 10000 lt Timeout gt lt printdata gt lt epos print xmlnsz http www epson pos com schemas 201 1 03 epos print lt epos print gt lt printdata gt lt data gt lt device_data gt 0 lt device_data gt lt device_id gt local_display lt device_id gt lt data gt lt type gt display lt type gt lt Timeout gt 10000 lt Timeout gt lt displaydata gt lt epos print xmlnsz http www epson pos com schemas 201 1 03 epos p
4. reader the input device sends the input data to the TM intelligent printer 2 The TM intelligent printer formats the input data received from the input device and sends the data to the Web server application POST 3 Triggered by the input data the Web server application generates device control data in ePOS Device XML format from database or other system and returns a response to the request from the TM intelligent printer 4 The TM intelligent printer sends the device control data to the device 5 The TM intelligent printer sends the result of device control to the Web server Operating Environment How to Access the Web server How to access TM i Proxy server v Proxy authentication v Digest authentication v HTTPS communication v HTTPS communication with server authentication v TM Intelligent Printer TM T88V i TM i firmware Ver 4 1 or later TM T7O i TM i firmware Ver 4 1 or later TM T20ll i TM i firmware Ver 4 1 or later TM T82ll i TM i firmware 4 1 or later TM T83ll i TM i firmware Ver 4 1 or later For details about how to check the version of TM i Firmware refer to the Technical Reference Q Guide for each printer Input Device The following devices can be designated as the input device for Device Data Notification Key input device keyboard barcode scanner etc Serial communication device Communication box in the TM intelligen
5. www form urlencoded Set the sending destination according to Device Data Notification p 17 ID The ID set with WebConfig p 17 Data ePOS Device XML format POST Test DeviceData php HTTP 1 1 Host 192 168 192 10 Content Type application x www form urlencoded Content Length xxx Header ID amp Data lt open_device gt lt device_id gt local_printer lt device_id gt lt code gt OK lt code gt lt data_id gt 1 lt data_id gt lt open_device gt TM intelligent printer sends one HTTP request Device Use Rights Acquisition Result Notification to the Web server for each device Therefore when multiple devices are set as the target device for Device Data Notification multiple HTTP requests Device Use Rights Acquisition Result Notification are sent to the Web server 19 Response Device Use Rights Acquisition Result Notification Input Device TM Intelligent Printer Web server 1 Device Use Rights Acquisition 2 HTTP Request K Device Use Rights Acquisition Result Notification 2 1 Create XML from a database or HTTP Response other system Device Control The Web server application creates response data as shown below to a HTTP request Device Use Rights Acquisition Result Notification and returns it to the TM intelligent printer This data contains device
6. 3 Register the Devices p 16 Register the scanner and customer display 4 Device Data Notification Settings p 17 Configure the Device Data Notification settings Sample Program Configuration Save the sample program files to the Web server Save the files directly under the following folders Environment Folder Saved File IIS inetpub wwwroot Test print php XAMPP xampp htdocs 15 16 TM Intelligent Printer Settings Register the Devices Register the scanner and customer display using EPSON TMNet WebConfig 1 2 3 4 Turn off the TM intelligent printer and connect the scanner and customer display Then turn on the TM intelligent printer Start the Web browser on the setup computer and enter as follows http IP address of the TM i webconfig EPSON TMNet WebConfig starts Register the scanner Select configuration Web Service Settings Device Admin Device Registration Key Input Device The Key Inout Device screen appears Set the following items and click Apply Item Description Set the device ID Enter scanner Device name Confirm that the connected scanner is selected Control script Set the control script Select Scanner Generic js The scanner is added to the registered key input devices Click Operating test and check whether the registered scanner operates properly Register the customer di
7. EPSON EXCEED YOUR VISION Device Data Notification User s Manual Overview m Describes the operating environment and system config uration for Device Data Notification Sample Program Describes how to use the sample program and how to configure the system Request and Response Describes the requests and responses in Device Data Notification 0084500 Rev A 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 instru
8. ample program Set this item to use HTTP digest authentication Password Not required for the sample program Enter the URL of the Device Data Notification destination sample program Enter as follows URL http IP address of the Web server Test_DeviceData ohp After entry check whether the URL is correct Click Access Server Access Test Set this item to perform server authentication with the server registered certificate during access with https Authentication Not required for the sample program Specify the box ID of the communication box to be controlled by the Device Data Notification function To use the communication box by the Device Data Notification function set the member ID for sending data to the communication box as null Box ID Not required for the sample program To print an error message when POST to the server fails Print M select Enable Enter the character string to be printed when POST to the server fails Set the character decoration for message Select the POST Error character decoration to be used The following decorations Text Attributes are available Bold Underline Double width Double height Reverse black and white Upside down Message Text To cut the paper after printing an error message select vu Enable 17 Item Description Capture Device Device Select the device to be used For the sampl
9. control data The format of response message is ePOS Device XML text xml HTTP 1 1 200 OK Content Type text xml charset utf 8 Content Length xxx lt device_data gt lt device_id gt local_keyboard lt device_id gt lt data gt lt type gt setprefix lt type gt lt data gt lt device_data gt 0 For the lt device_data gt tag be sure to end the message with 0 When no device control is required refer to Response to Disable Device Control p 24 20 Request Input Data from Input Device Input Device 1 Data input occurs Chapter3 Request and Response TM Intelligent Printer Web server 1 1 HTTP Request Input Data HTTP Response Device Control 1 1 1 Create XML from a database or other system When dota is input from the input device the TM intelligent printer formats the input data received from the input device in ePOS Device XML format and sends a HTTP POST request as shown below to the Web server The format of request message is URL encoded form data application x www form urlencoded Set the sending destination according to Device Data Notification p 17 Parameter ID Value The ID set with WebConfig p 17 Data ePOS Device XML format Header POST DeviceData php HTTP 1 1 Host 192 168 192 10 Content Type application x www form urlencoded Content Length xxx ID
10. ctions Seiko Epson Corporation shall not be liable against any damages or problerns 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 is a registered trademark of Seiko Epson Corporation Exceed Your Vision is a registered trademark or trademark of Seiko Epson Corporation Windows and Internet Explorer are either registered trademarks or trademarks of Microsoft Corporation in the United States and other countries All other trademarks are the property of their respective owners and used for identification purpose only Q Seiko Epson Corporation 2014 All rights reserved For Safety 5 The symbols in this manual identified by their level of importance as defined below Read the following carefully before handling the product Provides information that must be observed to avoid damage to your equipment or a N malfunction 2 Provides important information and useful tips Restriction of Use When this product is used for applications requiring high reliability safety such as transportation devices related to aviation rail marine automotive etc disaster prevention devices various safety devices etc or functional precision devices etc you should use this product only after giving consideration to including fail safes and redundancies into your de
11. e program select the following items local printer local display local scanner Execution of Sample Program 1 Confirm that Device Data Notification enabled using EPSON TMNet WebConfig 2 Read a barcode using the scanner connected to the TM intelligent printer 3 To the request from the TM intelligent printer print data is returned as a response and a coupon is printed from the printer A message is displayed on the customer display 18 Chapter3 Request and Response Request and Response This chapter describes data inputs from the input device requests from the TM intelligent printer and responses from the Web server Request Device Use Rights Acquisition Result Notification Input Device TM Intelligent Printer Web server 1 Device Use Rights Acquisition 2 HTTP Request Device Use Rights Acquisition Result Notification 2 1 Create XML from a database or other system HTTP Response Device Control When the IM intelligent printer is turned on or when the Device Data Notification settings are changed with EPSON TMNet WebConfig the TM intelligent printer executes lt open_device gt in ePOS Device XML to enable the device designated as the input control device formats the result in ePOS Device XML format and sends a HTTP POST request as shown below The format of request message is URL encoded form data application x
12. eb server 3 Returning the print data customer display data to the printer 4 Printing the data and displaying a message on the custorner display 5 Sending the print result customer display result to the Web server 13 Environment Settings 14 The environment setting flow of the sample program is as shown below 1 Router Settings Set information such as SSID IP address DHCP and allocated IP address For details see the manual for each device 2 Web Server Settings 1 Web Server Configuration Configure IIS and XAMPP in the computer 2 Sample Program Configuration p 15 Save the sample program files in the computer 3 Network Settings Configure the network settings such as IP address to the computer 3 TM Printer Network Settings Configure the network settings such as IP address to the TM printer to be connected Configure the network settings such as IP address to the printer by using EPSON TMNet WebConfig from a Web browser on the setup computer For the configuration procedure refer to the Technical Reference Guide for each TM printer Chapter2 Sample Program 4 TM Intelligent Printer Settings p 16 1 IP Address Setting Set the IP address For details on how to set refer to Technical Reference Guide for each printer 2 Register the TM Printers Register the TM printer to be used for printing Not required for the sample program
13. esponses refer to Response to Disable Device Control p 24 Response to Disable Device Control When no device control is required notifies that there is no device control data by returning the response as shown below to a HTTP request from the TM intelligent printer Refer to Test DeviceData php in the sample program HTTP 1 1 200 OK Content Type text xml charset utf 8 Content Length 0 24
14. he sample program that uses PHP can be registered to the Web server and be operated When a barcode is read with the scanner the TM intelligent printer sends a request containing barcode data to the sample program in the Web server The sample program sends response data containing print data in ePOS Device format and display data The main printer of the TM intelligent printer prints a coupon and displays a message on the customer display Hardware Configuration The system configuration of the sample program is as shown below The figure below also shows IP address examples for the network settings Web Server 192 168 192 10 TM Intelligent Printer TM T88V i 192 168 192 20 Customer display display Scanner local scanner Web Server Router TM Intelligent Printer Scanner Customer display Use of the customer display is optional 11 12 File Configuration File Name Description The server returns a response containing print data when the printer sends a request Printing Result Test DeviceData php Discount Coupon Lunch 10 OFF Expiration Date 11 11 2014 1111111111111 22222 22 2222 22 Chapter2 Sample Program Program Flow The flow from the initial display to the print completion of the sample program is as shown below 1 Reading a barcode with the scanner 2 Sending the data read with the scanner to the W
15. rating 8 How to Access ic et test Ho e a ia a vi Eo EU E d o M Pc ve a n 8 TM IritelligenmtiPrter sss oo ce e rota ara va a a eR e WERE ee 8 Devices e E mde a a stc md 8 DEVICES ses eoe REIN eno eV nen nh A ape ee RR E et 9 B Contents In the Package einen leitet niece eed eee 10 TIL ITE 10 Sample Progra min epe 10 RE CH EE 10 Sdmpl PIOGQIGITI isset ob xta cione GE nie 11 OVervIew tiii tenere eiii ei eie ir Ie Ra TT 11 Hardware Configuration woe EEE nnne nennen nennen 11 File COMIGQUIGTION 12 Printimetsestl Eee tents cte ctor ct aera bre 12 FlOW e EU 13 B Environment Sellfings rine edere eee arii 14 sample Program Config rction pd nra bn RO REED UE ven RV IR 15 TM IntelligentiPrinter Settirigs icc p reiten tec Rp e vr n Ee ere ee v ven ere ne neta 16 E Execution of Sample 18 Request and
16. rint gt lt epos print gt lt displaydata gt lt data gt lt device_data gt 0 For the device data tag be sure to end the message with XO When no device control is required refer to Response to Disable Device Control p 24 22 Chapter3 Request and Response Request Device Control Execution Result Input Device TM Intelligent Printer Web server 1 Data input occurs f 1 1 HTTP Request Input Data 1 1 1 Create XML from a database or other system HTTP Response Device Control 2 Device Control Execution 3 HTTP Request 1 Device Control Execution Result 3 1 Register control result to a database or other system The TM intelligent printer executes device control according to the device control data ePOS Device XML received from the Web server formats the result in ePOS Device XML format and sends a HTTP POST request as shown below The format of request message is URL encoded form data application x www form urlencoded Set the sending destination according to Device Data Notification p 17 HTTP Response Device Control ID The ID set with WebConfig p 17 Data ePOS Device XML format POST Test DeviceData php HTTP 1 1 Host 192 168 192 10 Content Type application x www form urlencoded Content Length xxx Header
17. sign to maintain safety and total system reliability Because this product was not intended for use in applications requiring extremely high reliability safety such as aerospace equipment main communication equipment nuclear power control equipment or medical equipment related to direct medical care etc please make your own judgment on this product s suitability after a full evaluation About this Manual Aim of the Manual This manual presents information that is necessary information for using the TM Intelligent The TM Intelligent series in this manual is a generic term for the TM i series The TM i series in this manual is a generic term for the following printers TM T88 V i TM T7O i e TM T20ll i e TM T82ll i TM T83ll i Manual Content The manual is made up of the following sections Chapter 1 Overview Chapter 2 Sample Program Chapter 3 Request and Response Contents FOr Scotty ME 3 Key TO SyrmibOls us ciate eet cL ri e E cie EE ek ERU t a Ca EE a ta 3 B Resiriclion of Use noie genetic ee etg eee Ln raisin e or 3 E ADOUt TiS MOU 4 Manu rc 4 MOmUGh COMER cats each fetuses sua ti Destra pns thoes bent a eade T Boh 4 B 5 euam aa 7 E Overview of Device Data 7 E Ope
18. splay Select configuration Web Service Settings Device Admin Device Registration Customer Display The Customer Display screen appears Set the following items and click Apply Item Description Customer Display Select Use d Set the communication speed Communication M Select the communication speed according to the speed bps oa customer display Set the data settings Data bit 7 Select the data bit according to the customer display Set the parity Parity Select the parity according to the customer display Brightness setting Set the brightness Select the brightness as desired Chapter2 Sample Program The customer display is registered Click Test display and check whether the registered customer display operates properly 2 The device ID of the customer display is local display Device Data Notification Settings Configure the Device Data Notification settings using EPSON TMNet WebConfig as follows EPSON TMNet WebConfig starts Select configuration Web Service Settings Server Access Device Data Notification The Device Data Notification screen appears Set the following items and click Apply Item Description settings Device Data Notification Select Enable Set this item to use HTTP digest authentication or to identify ID the main printer from the server Not required for the s
19. t printer Chapter 1 Overview Control Device The following devices can be designated as the control device for Device Data Notification Main printer of the TM intelligent printer TM printer Customer display Serial communication device Communication box in the TM intelligent printer Available TM printers are different depending on the TM i Firmware version in the TM intelligent printer For details refer to Technical Reference Guide for each printer Device Data Notification Therefore the designated device cannot be controlled by ePOS Device SDK or ePOS Device XML The device designated as the input device or control device is locked with exclusive lock by Contents In the Package 10 Device Data Notification User s Manual This Document Technical Reference Guide for each printer ePOS Device XML User s manual Sample Program Description DDN Sample V o zip Sample program for Device Data Notification Test DeviceData php Sample program file README txt Readme file For customers in North America go to the following web site http www epsonexpert com and follow the on screen instructions For customers in other countries go to the following web site https download epson biz com service pos Chapter2 Sample Program Sample Program This chapter describes how to use the sample program for Device Data Notification Overview T
Download Pdf Manuals
Related Search