Epson TM-T20II-i TM-i Series WebConfig API Users Manual for TM-i firmware ver.
Epson TM-T20II-i Manual
View all Epson TM-T20II-i manuals
Add to My Manuals
Save this manual to your list of manuals |
Epson TM-T20II-i manual content summary:
- Epson TM-T20II-i | TM-i Series WebConfig API Users Manual for TM-i firmware ver. - Page 1
TM-i Series WebConfig API User's Manual Overview Describes an overview of WebConfig API. Response Body Format Describes the response body format. Reference Describes how to refer to and change setting values. Sample Program Describes how to use the sample program. M00052305 Rev.F - Epson TM-T20II-i | TM-i Series WebConfig API Users Manual for TM-i firmware ver. - Page 2
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 - Epson TM-T20II-i | TM-i Series WebConfig API Users Manual for TM-i firmware ver. - Page 3
For Safety Key to Symbols The symbols in this manual are identified by their level of importance, as defined below. Read the following carefully before handling the product. Provides information that must be observed to - Epson TM-T20II-i | TM-i Series WebConfig API Users Manual for TM-i firmware ver. - Page 4
applications to set and refer to the EPSON TMNet WebConfig for the TM-i series. The TM-i series in this manual is a generic term for the following printers. TM-T88V-i TM-T70-i TM-20II-i TM-T82II-i TM-L90-i Manual Content The manual is made up of the following sections: Chapter - Epson TM-T20II-i | TM-i Series WebConfig API Users Manual for TM-i firmware ver. - Page 5
■ Restriction of Use ...3 ■ About this Manual ...4 Aim of the Manual ...4 Manual Content ...4 ■ Contents...5 Overview 7 ■ What is WebConfig API? ...7 Function ...8 Usable Formats...8 ■ Supported printers ...9 TM-i...9 Confirming the TM-i firmware...9 TM Printer...9 ■ Contents in the Package 10 - Epson TM-T20II-i | TM-i Series WebConfig API Users Manual for TM-i firmware ver. - Page 6
and Location ...31 Time of Day ...32 Password...32 ■ Changing the Set Values 33 Common ...33 Wired LAN...33 Wireless LAN ...34 Adding a TM Printer...37 Deleting a TM Printer ...37 Setting a Customer Display ...38 Adding a key input device...39 Deleting a key input device...39 Setting a Serial - Epson TM-T20II-i | TM-i Series WebConfig API Users Manual for TM-i firmware ver. - Page 7
settings Wireless LAN interface Wired LAN Wireless LAN USB Device Control TM-i Do not use the WebConfig API if you are directly setting or referring to the TM-i's settings from a browser on a computer. For the functions of EPSON TMNet WebConfig, refer to the detailed manual for each printer - Epson TM-T20II-i | TM-i Series WebConfig API Users Manual for TM-i firmware ver. - Page 8
Function ❏ Allows getting/setting setting values of TM-i from HTTP-supported devices. Not OS-dependent. ❏ Allows an application to refer to the set values of a TM-i using the GET method (hereafter "GET") defined in HTTP (HyperText Transfer Protocol). ❏ Allows an application to change the set values - Epson TM-T20II-i | TM-i Series WebConfig API Users Manual for TM-i firmware ver. - Page 9
Supported printers Chapter 1 Overview TM-i TM-i refers to EpsonNet WebConfig setting values. These values can be changed. ❏ TM-T88V-i ❏ TM-T70-i ❏ TM-T20II-i ❏ TM-T82II-i ❏ TM-L90-i 1 Confirming the TM-i firmware You can confirm the TM-i firmware version by printing out a status sheet. - Epson TM-T20II-i | TM-i Series WebConfig API Users Manual for TM-i firmware ver. - Page 10
: 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 Restrictions ❏ Web contents (zip file) and a certificate cannot be manually uploaded by using WebConfig API. ❏ To enable - Epson TM-T20II-i | TM-i Series WebConfig API Users Manual for TM-i firmware ver. - Page 11
IP Address : The IP address of the TM-i whose set values to be acquired 2 ❏ SettingUrl : The URL of the set values to be acquired ❏ format html : Specifies the format of the response body to be returned by the TM-i : HTML format (the same operation as the operation performed when viewing EPSON - Epson TM-T20II-i | TM-i Series WebConfig API Users Manual for TM-i firmware ver. - Page 12
particular order. Response body (Example : config_tcpip_wired.cgi) Auto Enable - Epson TM-T20II-i | TM-i Series WebConfig API Users Manual for TM-i firmware ver. - Page 13
JSON format { "response" : { "success" : "true" } , "%Category%" : { "%Key1%" : "%Value1%" , "%Key2%" : "%Value2%" , "%Key3%" : "%Value3%" , } } The above keys are in no particular order. Response body (Example : config_tcpip_wired.cgi) { "response" : { "success" : "true" } , "WiredNetwork" : { " - Epson TM-T20II-i | TM-i Series WebConfig API Users Manual for TM-i firmware ver. - Page 14
ini format [response] success="true" [%Category%] %Key1%="%Value1%" %Key2%="%Value2%" %Key3%="%Value3%" . . The above keys are in no particular order. Response body (Example : config_tcpip_wired.cgi) [response] success="true" [WiredNetwork] IPAddressSettingMethod="Auto" APIPA="Enable" IPAddress="192 - Epson TM-T20II-i | TM-i Series WebConfig API Users Manual for TM-i firmware ver. - Page 15
] ❏ IP Address : The IP address of the TM-i whose set values to be acquired ❏ SettingUrl : The URL of the set value to be changed ❏ format : Specifies the format of the response body to be returned by the TM-i html : HTML format (the same operation as the operation performed when viewing EPSON - Epson TM-T20II-i | TM-i Series WebConfig API Users Manual for TM-i firmware ver. - Page 16
.cgi) When response is successful When response fails - Epson TM-T20II-i | TM-i Series WebConfig API Users Manual for TM-i firmware ver. - Page 17
Chapter 2 Response Body Format JSON format { "response" : { "success" : "%Result%" , "code" : "%Reason%" } } This portion is added when response fails. Response body (Example : set_tcpip_wired.cgi) When response is successful { "response" : { "success" : "true" 2 } } When response fails - Epson TM-T20II-i | TM-i Series WebConfig API Users Manual for TM-i firmware ver. - Page 18
ini format [response] success="%Result%" code="%Reason%" This portion is added when response fails. Response body (Example : set_tcpip_wired.cgi) When response is successful [response] success="true" When response fails [response] success="false" code="InvalidIPAddress" For details on an error - Epson TM-T20II-i | TM-i Series WebConfig API Users Manual for TM-i firmware ver. - Page 19
to enable or disable APIPA. Enable Disable Refers to the IP address. Refers to the subnet mask. Refers to the default gateway. Refers to the DNS server IP address setting method. Auto Manual Refers to DNS server IP address 1. Refers to DNS server IP address 2. Refers to DNS server IP address 3. 19 - Epson TM-T20II-i | TM-i Series WebConfig API Users Manual for TM-i firmware ver. - Page 20
LAN General SettingUrl : config_general_wireless.cgi Refers to the SSID, etc. of the wireless LAN. Category WiredLinkLayer Key Value NetworkMode Infrastructure Adhoc SSID (String) AdhocChannel (String) CommunicationStandard AuthenticationMethod 802.11b/g 802.11b/g/n EncryptionMethod - Epson TM-T20II-i | TM-i Series WebConfig API Users Manual for TM-i firmware ver. - Page 21
. Refers to the subnet mask. Refers to the default gateway. Refers to the DNS server IP address setting method. Auto Manual Refers to DNS server IP address 1. 3 Refers to DNS server IP address 2. Refers to DNS server IP address 3. Device SettingUrl : config_epos_print.cgi Refers to the - Epson TM-T20II-i | TM-i Series WebConfig API Users Manual for TM-i firmware ver. - Page 22
SettingUrl : config_epos_display.cgi Refers to setting values for customer displays. Category Deviceslocal_display Key Baudrate Databit Parity Brightness Use Value 2400 4800 9600 19200 38400 57600 115200 7 8 None Even Odd 100 60 40 20 Enable Disable Description Refers to the communication - Epson TM-T20II-i | TM-i Series WebConfig API Users Manual for TM-i firmware ver. - Page 23
3 Reference SettingUrl : config_epos_serial.cgi Refers to serial communication device information that has a device ID of [local_serial]. If the TM-i specifications do not include a serial port, this does not refer to serial communication device information. Category Key Value Description - Epson TM-T20II-i | TM-i Series WebConfig API Users Manual for TM-i firmware ver. - Page 24
printer on the LAN. Detects a wireless LAN connection printer on the LAN. Detects a wireless LAN connection printer via USB connection. Refers to the IP address setting method. Auto Manual Refers to whether to enable or disable APIPA. Enable Disable Refers to the subnet mask. Refers to the default - Epson TM-T20II-i | TM-i Series WebConfig API Users Manual for TM-i firmware ver. - Page 25
Chapter 3 Reference Category NetworkPrinter-n Key Value SSID (String) AdhocChannel (String) CommunicationStandard AuthenticationMethod 802.11b 802.11b/g 802.11b/g/n EncryptionMethod DefaultWEPKey OpenSystem SharedKey WPAPSK None WEP TKIP AES WEPKey1 WEPKey2 WEPKey3 WEPKey4 Description - Epson TM-T20II-i | TM-i Series WebConfig API Users Manual for TM-i firmware ver. - Page 26
Web Contents Updater SettingUrl : config_web_contents_updater.cgi Refers to the Web contents update setting. Category WebContents Key AutoUpdate Value Frequency Enable Disable Hour Daily Weekly Timing Monthly (When Frequency=Hour) (String) (When Frequency=Daily) (When Frequency=Weekly) - Epson TM-T20II-i | TM-i Series WebConfig API Users Manual for TM-i firmware ver. - Page 27
. If this authentication cannot be acquired, the setting becomes "Disable". Enable Enable Disable Disable ID (String) Refers to an ID for identifying TM-i on the web server side. This is a user ID used for Digest authentication. Password (String) Refers to the password for web content - Epson TM-T20II-i | TM-i Series WebConfig API Users Manual for TM-i firmware ver. - Page 28
Server Direct Print SettingUrl : config_server_direct_print.cgi Refers to Server Direct Print setting values. Category Key ServerDirectPrint Use ID Password URL Value Enable Disable (String) (String) (String) Interval (String) URL1 Interval1 (String) (String) URL2 Interval2 (String) ( - Epson TM-T20II-i | TM-i Series WebConfig API Users Manual for TM-i firmware ver. - Page 29
Chapter 3 Reference Status Notification SettingUrl : config_status_notification.cgi Refers to status notification setting. Category Key Value Description StatusNotification Use Refers to whether the status notification function is used. Enable Enable Disable Disable ID (String) - Epson TM-T20II-i | TM-i Series WebConfig API Users Manual for TM-i firmware ver. - Page 30
Certificates SettingUrl : listup_certificates.cgi Refers to a list of all certificates installed in TM-i. Category Key Certificate-%X%(1 - Epson TM-T20II-i | TM-i Series WebConfig API Users Manual for TM-i firmware ver. - Page 31
Chapter 3 Reference Proxy SettingUrl : config_proxy.cgi Refers to setting information for the proxy. Category Key Value Description Proxy ID (String) Refers to an ID for proxy authentication. Password (String) Refers to the password for proxy authentication. UseProxyServerDirectPrint - Epson TM-T20II-i | TM-i Series WebConfig API Users Manual for TM-i firmware ver. - Page 32
to the minute of the time of the internal clock of the TM-i. Refers to whether to enable or disable the clock alignment by the time server. Enable Disable Refers to the time server name acquisition method. Auto Manual Refers to the time server name. Displays the results of the last timeof - Epson TM-T20II-i | TM-i Series WebConfig API Users Manual for TM-i firmware ver. - Page 33
APIPA. Enable Disable Specifies the IP address setting method. Specifies the subnet mask. Specifies the default gateway. Specifies the DNS server IP address setting method. Auto Manual Refers to DNS server IP address 1. Refers to DNS server IP address 2. Refers to DNS server IP address 3. 33 - Epson TM-T20II-i | TM-i Series WebConfig API Users Manual for TM-i firmware ver. - Page 34
LAN General SettingUrl : set_general_wireless.cgi Changes the SSID, etc. of the wireless LAN. POST parameter NetworkMode SSID Specifiable value Infrastructure Adhoc (String) AdhocChannel (String) CommunicationStandard AuthenticationMethod EncryptionMethod DefaultWEPKey WEPKey1 802.11b - Epson TM-T20II-i | TM-i Series WebConfig API Users Manual for TM-i firmware ver. - Page 35
Chapter 3 Reference POST parameter WEPKey3 WEPKey4 PresharedKey Specifiable value (String) (String) (String) Description Specifies a value for WEP key 3 using one of the following strings: • 10-digit hexadecimal number • 26-digit hexadecimal number • 5 single-byte alphanumeric characters and - Epson TM-T20II-i | TM-i Series WebConfig API Users Manual for TM-i firmware ver. - Page 36
to enable or disable APIPA. Enable Disable Specifies the IP address. Specifies the subnet mask. Specifies the default gateway. Specifies the DNS server IP address setting method. Auto Manual Refers to DNS server IP address 1. Refers to DNS server IP address 2. Refers to DNS server IP address 3. 36 - Epson TM-T20II-i | TM-i Series WebConfig API Users Manual for TM-i firmware ver. - Page 37
-P60II TM-T20 TM-T20 TM-T20II TM-T20 TM-T82II TM-T82II TM-P80 TM-P80 TM-U220 TM-U220 IPAddress (String) Specifies the IP address. RetryInterval (String) Specifies the communication retry interval using a numeric value (in milliseconds) in the range 100- 60000. Deleting a TM Printer - Epson TM-T20II-i | TM-i Series WebConfig API Users Manual for TM-i firmware ver. - Page 38
Setting a Customer Display SettingUrl : set_epos_display.cgi Changes the settings for customer displays connected to TM-i. POST parameter Baudrate Databit Parity Brightness Use Specifiable value 2400 4800 9600 19200 38400 57600 115200 7 8 None Even Odd 100 60 40 20 Enable Disable - Epson TM-T20II-i | TM-i Series WebConfig API Users Manual for TM-i firmware ver. - Page 39
.cgi Changes the information for key input devices connected to TM-i. POST parameter DeviceID DeviceName VID PID ControlScript Specifiable value ( Designate IDs that are not the same as those used for registered printers and registered key input devices. Specifies the device name. Designates a - Epson TM-T20II-i | TM-i Series WebConfig API Users Manual for TM-i firmware ver. - Page 40
Communication Device SettingUrl : set_epos_serial.cgi Changes the serial communication device information with a device ID of [local_serial]. If the TM-i specifications include no serial ports, this setting is disabled. POST parameter Use Baudrate Databit Parity Stopbit FlowControl Specifiable - Epson TM-T20II-i | TM-i Series WebConfig API Users Manual for TM-i firmware ver. - Page 41
-i and TM printers are connected by a wireless LAN.) • A TM-i printer and wireless LAN interface with a USB connector of a TM printer are connected by USB. (UB-R03) POST parameter Specifiable value Description MACAddress (String) Specifies the MAC address. HostName (String) Specifies the IP - Epson TM-T20II-i | TM-i Series WebConfig API Users Manual for TM-i firmware ver. - Page 42
POST parameter AdhocChannel CommunicationStandard AuthenticationMethod EncryptionMethod DefaultWEPKey WEPKey1 WEPKey2 WEPKey3 Specifiable value (String) 802.11b 802.11b/g 802.11b/g/n OpenSystem SharedKey WPAPSK None WEP TKIP AES WEPKey1 WEPKey2 WEPKey3 WEPKey4 (String) (String) (String) - Epson TM-T20II-i | TM-i Series WebConfig API Users Manual for TM-i firmware ver. - Page 43
Chapter 3 Reference POST parameter WEPKey4 PresharedKey Password Specifiable value (String) (String) (String) Description Specifies a value for WEP key 4 using one of the following strings: • 10-digit hexadecimal number • 26-digit hexadecimal number • 5 single-byte alphanumeric characters and - Epson TM-T20II-i | TM-i Series WebConfig API Users Manual for TM-i firmware ver. - Page 44
Web Contents Updater SettingUrl : set_web_contents_updater.cgi Changes the Web contents update setting. POST parameter AutoUpdate Frequency Timing Specifiable value Enable Disable Hour Daily Weekly Monthly (When Frequency=Hour) (String) (When Frequency=Daily) (When Frequency=Weekly) (When - Epson TM-T20II-i | TM-i Series WebConfig API Users Manual for TM-i firmware ver. - Page 45
Chapter 3 Reference POST parameter ID Password ServerAuthentication Specifiable value (String) (String) Enable Disable Description Designates the ID that identifies TM-i on the web server side. This is the user ID used for digest authentication. Designates the password used for Digest - Epson TM-T20II-i | TM-i Series WebConfig API Users Manual for TM-i firmware ver. - Page 46
POST parameter URL2 Interval2 URL3 Interval3 ServerAuthentication Specifiable value (String) (String) (String) (String) Enable Disable Description Designates the acquisition destination URL for print data. Designates a value (seconds) between 1 and 86400 for the standby time from the completion of - Epson TM-T20II-i | TM-i Series WebConfig API Users Manual for TM-i firmware ver. - Page 47
Chapter 3 Reference Certificate SettingUrl : delete_certificate.cgi Deletes the specified certificate. POST parameter FileDigest Specifiable value (String) Description Designates the "MD5" hash value for the certificate to be deleted. Proxy SettingUrl : set_proxy.cgi Changes the proxy - Epson TM-T20II-i | TM-i Series WebConfig API Users Manual for TM-i firmware ver. - Page 48
) Day (String) Hour (String) Minute (String) UseTimeServer TimeServerSettingMethod TimeServer TimeZone Enable Disable Auto Manual (String) (String) Description Specifies the year of the internal clock of the TM-i using an integer in the range 2012-2036. Specifies the month of the internal - Epson TM-T20II-i | TM-i Series WebConfig API Users Manual for TM-i firmware ver. - Page 49
string 0 (zero) character or more and 20 characters or less long. Resetting and Initializing the Settings SettingUrl : set_reset.cgi Resets the wired LAN/wireless LAN and restores the factory default settings. POST parameter Specifiable value Description Operation Reset Resets the wired LAN - Epson TM-T20II-i | TM-i Series WebConfig API Users Manual for TM-i firmware ver. - Page 50
AdhocChannel parameter value. Correct the error. Invalid CommunicationStandard parameter value. Check the values for the communication standard supported by the printer to correct the value. Invalid AuthenticationMethod parameter value. Correct the error. When Adhoc is specified for the NetworkMode - Epson TM-T20II-i | TM-i Series WebConfig API Users Manual for TM-i firmware ver. - Page 51
specified for CommunicationStandard. Correct the error. DeviceNotWireless The TM printer specified for the MACAddress or HostName parameter is not a printer with any wireless LAN interface. Check the interface of the TM printer. InvalidAutoUpdate Invalid AutoUpdate parameter value. Correct the - Epson TM-T20II-i | TM-i Series WebConfig API Users Manual for TM-i firmware ver. - Page 52
ROM space on the TM-i is not enough to explode the Web contents downloaded from the URL specified for FileURL. Check that the file size of the Web no microSD could be detected. Check that a microSD is mounted to the TM-i. Invalid Use parameter value. Correct the error. Invalid ID parameter value. - Epson TM-T20II-i | TM-i Series WebConfig API Users Manual for TM-i firmware ver. - Page 53
code InvalidLocation InvalidYear InvalidMonth InvalidDay InvalidHour InvalidMinute InvalidTimeZone InvalidUseTimeServer InvalidTimeServerSettingMethod InvalidTimeServer InvalidDate InvalidTime InvalidNewPassword InvalidOperation Chapter 3 Reference Action to Take Invalid Location parameter value. - Epson TM-T20II-i | TM-i Series WebConfig API Users Manual for TM-i firmware ver. - Page 54
54 - Epson TM-T20II-i | TM-i Series WebConfig API Users Manual for TM-i firmware ver. - Page 55
Chapter 4 Sample Program Sample Program This sample program can acquire/change the set values of the TM-i and upload files. Screen The following screen appears when the sample program starts. 4 55 - Epson TM-T20II-i | TM-i Series WebConfig API Users Manual for TM-i firmware ver. - Page 56
programs is as below. The IP address value is just an example. Set the value that suits your use environment. Computer to configure the settings Wireless LAN Router [192.168.192.1] TM-i [192.168.192.20] ❏ Wireless LAN Router ❏ TM-i (1 set) TM-T88V-i/ TM-T70-i/TM-L90-i ❏ Computer to configure the - Epson TM-T20II-i | TM-i Series WebConfig API Users Manual for TM-i firmware ver. - Page 57
Basic Usage of the Sample Program This sample program is implemented using VBA macros. Use this program by enabling macros. 1 Specify values for IP Address, CGI Name, Format, User Name, and Password. For CGI Name and Format each, select a parameter from a list. 2 Click the [GET] button. The response - Epson TM-T20II-i | TM-i Series WebConfig API Users Manual for TM-i firmware ver. - Page 58
value will be displayed. If the process fails, the reason will be filled into the cell. The following screen shows the case in which the IP address failed to be set. 58 - Epson TM-T20II-i | TM-i Series WebConfig API Users Manual for TM-i firmware ver. - Page 59
Chapter 4 Sample Program Note If [config_epos_print.cgi, set_epos_print.cgi] is selected for CGI Name and the [GET] button is clicked, all the registered devices will be filled into [Response body]. All the registered devices are displayed. Note that one device at a time can be registered (SET). - Epson TM-T20II-i | TM-i Series WebConfig API Users Manual for TM-i firmware ver. - Page 60
Uploading Files 1 Click the [Upload Web Contents] button. 2 The file selection screen appears. Select the file to be uploaded to the TM-i. Click the [OPEN] button and the file starts to be uploaded. 3 The results are displayed in the cell. The following screen shows the case in - Epson TM-T20II-i | TM-i Series WebConfig API Users Manual for TM-i firmware ver. - Page 61
Certificate 1 Click the [Upload Certificate File] button. Chapter 4 Sample Program 2 The file selection screen appears. Select the file to be uploaded to the TM-i. Click the [OPEN] button and the file starts to be uploaded. 3 The results are displayed in the cell. The following screen shows the - Epson TM-T20II-i | TM-i Series WebConfig API Users Manual for TM-i firmware ver. - Page 62
62
TM-i Series
WebConfig API User's Manual
M00052305
Rev.F
Overview
Response Body Format
Reference
Sample Program
Describes an overview of WebConfig API.
Describes the response body format.
Describes how to refer to and change setting values.
Describes how to use the sample program.