Epson TM-T70-i TM-i WebConfig API Users Manual

Epson TM-T70-i Manual

Epson TM-T70-i manual content summary:

  • Epson TM-T70-i | TM-i WebConfig API Users Manual - Page 1
    TM-i Series WebConfig API User's Manual Overview Response Body Format Reference Sample Program M00052304 Rev.E
  • Epson TM-T70-i | TM-i WebConfig API Users Manual - 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-T70-i | TM-i WebConfig API Users Manual - 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-T70-i | TM-i WebConfig API Users Manual - Page 4
    information to develop 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-L90-i Manual Content The manual is made up of the following sections: Chapter
  • Epson TM-T70-i | TM-i WebConfig API Users Manual - Page 5
    ...4 Aim of the Manual...4 Manual Content ...4 ■ Contents ...5 Overview 7 ■ What is WebConfig API?...7 Function ...8 Usable Formats...8 TM Printer ...8 ■ Contents in the Package ...9 Download ...9 ■ Restrictions ...10 Response Body Format 11 ■ Referring to the Set Values of a TM-i 11 XML format
  • Epson TM-T70-i | TM-i WebConfig API Users Manual - Page 6
    Reference 19 ■ Referring to Set Values ...19 Wired LAN...19 Wireless LAN ...21 Device ...22 Searching TM printers...23 Web Contents Updater LAN ...30 Adding a Device ...33 Deleting a Device ...33 Setting a TM printer ...34 Web Contents Updater ...37 Automatic Update ...38 Administrator and Location
  • Epson TM-T70-i | TM-i WebConfig API Users Manual - Page 7
    TM-Printer 1 Wired LAN Computer to configure the settings 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
  • Epson TM-T70-i | TM-i WebConfig API Users Manual - Page 8
    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 environment TM Printer ❏ TM-i  TM-T88V-i  TM-T70-i  TM-L90-i ❏ TM-Printer  TM-T88V  TM-T88IV  TM-T70  TM-T90  TM-L90  TM-P60II  TM-T20  TM-
  • Epson TM-T70-i | TM-i WebConfig API Users Manual - Page 9
    User's Manual ❏ TM-T88V-i Technical Reference Guide ❏ TM-T70-i Technical Reference Guide ❏ TM-L90-i Technical Reference Guide Sample Program WebConfigAPISample.xls Download For customers in North America, go to the following web site: http://www.epsonexpert.com/ and follow the on-screen instructions
  • Epson TM-T70-i | TM-i WebConfig API Users Manual - Page 10
    (zip file) cannot be manually uploaded by using WebConfig API. ❏ To enable manual uploading of Web contents (zip file), file upload functionality used by applications as standard should be programmed.  (Manual uploading functionality is embedded in the sample program. Refer to the sample program
  • Epson TM-T70-i | TM-i WebConfig API Users Manual - Page 11
    returned when using GET or POST for a TM-i. Referring to the Set Values of a TM-i An application (e.g. javascript or excel macro) can refer to the set values of a TM-i by executing GET for the following URL: http://%IP Address%/PrinterConfigurationPage/%SettingUrl%?format=[html | xml | json | ini
  • Epson TM-T70-i | TM-i WebConfig API Users Manual - Page 12
    in no particular order. Response body (Example : config_tcpip_wired.cgi) Auto Enable
  • Epson TM-T70-i | TM-i WebConfig API Users Manual - 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-T70-i | TM-i WebConfig API Users Manual - 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-T70-i | TM-i WebConfig API Users Manual - Page 15
    ] ❏ IP Adress : 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-T70-i | TM-i WebConfig API Users Manual - Page 16
    -utility> This portion is added when response fails. Response body (Example : set_tcpip_wired.cgi) When response is successful When response fails
  • Epson TM-T70-i | TM-i WebConfig API Users Manual - 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-T70-i | TM-i WebConfig API Users Manual - 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-T70-i | TM-i WebConfig API Users Manual - Page 19
    to the link speed of the wired LAN. Category Key Value Description WiredLinkLayer LinkSpeed Refers to the link speed. 10BaseTHalf 10BaseT half duplex 10BaseTFull 10BaseT full duplex 100BaseTHalf 100BaseT half duplex 100BaseTFull 100BaseT full duplex AutoNegotiation Auto-negotiation
  • Epson TM-T70-i | TM-i WebConfig API Users Manual - Page 20
    Auto Manual Refers to whether 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
  • Epson TM-T70-i | TM-i WebConfig API Users Manual - Page 21
    to the network mode. Infrastructure Infrastructure mode Adhoc Adhoc mode SSID (String) Refers to the SSID. AdhocChannel (String) Refers to the AdhocChannel. CommunicationStandard Refers to the communication standard. 802.11b/g 802.11b/g 802.11b/g/n 802.11b/g/n AuthenticationMethod
  • Epson TM-T70-i | TM-i WebConfig API Users Manual - Page 22
    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. Device SettingUrl
  • Epson TM-T70-i | TM-i WebConfig API Users Manual - Page 23
    the LAN. Wireless Detects a wireless LAN connection printer on the LAN. USB Detects a wireless LAN connection printer via USB connection. IPAddressSettingMethod Refers to the IP address setting method. Auto Auto Manual Manual APIPA Refers to whether to enable or disable APIPA. Enable
  • Epson TM-T70-i | TM-i WebConfig API Users Manual - Page 24
    None WEP TKIP AES WEPKey1 WEPKey2 WEPKey3 WEPKey4 Description Refers to the SSID. Refers to the AdhocChannel. Refers to the communication standard. 802.11b 802.11b/g 802.11b/g/n Refers to the authentication method. OpenSystem SharedKey WPAPSK Refers to the encryption method. No encryption WEP TKIP
  • Epson TM-T70-i | TM-i WebConfig API Users Manual - Page 25
    to the timing of automatic update. 3 The return value varies depending on the value for Frequency. (When Frequency=Hour) (String) Refers to the interval of automatic update. (When Frequency=Daily) A blank character is returned. (When Frequency=Weekly) Sunday Monday Updates every Sunday
  • Epson TM-T70-i | TM-i WebConfig API Users Manual - Page 26
    LastUpdateDay LastUpdateHour Enable Disable (String) (String) (String) (String) (String) LastUpdateMinute (String) LastUpdateResultCode (String) LastUpdateResultMessage (String) Description Refers to the minute of the time of day to perform automatic update. When Frequency=Hour, an empty
  • Epson TM-T70-i | TM-i WebConfig API Users Manual - Page 27
    clock of the TM-i. UseTimeServer Refers to whether to enable or disable the clock alignment by the time server. Enable Enable Disable Disable TimeServerSettingMethod Refers to the time server name acquisition method. 3 Auto Auto Manual Manual TimeServer Refers to the time server
  • Epson TM-T70-i | TM-i WebConfig API Users Manual - Page 28
    Password SettingUrl : config_password.cgi Refers to the set password. Category Password Key PasswordMD5 Value (String) Description Refers to the string created from the password string through MD5 encryption. 28
  • Epson TM-T70-i | TM-i WebConfig API Users Manual - Page 29
    value Auto Manual Enable Disable (String) (String) (String) Description Specifies the IP address setting method. Auto Manual Refers to whether to enable or disable APIPA. Enable Disable Specifies the IP address setting method. Specifies the subnet mask. Specifies the default gateway. 29
  • Epson TM-T70-i | TM-i WebConfig API Users Manual - Page 30
    (String) (String) (String) Description 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. Wireless LAN General SettingUrl : set_general_wireless.cgi Changes the SSID, etc. of
  • Epson TM-T70-i | TM-i WebConfig API Users Manual - Page 31
    Chapter 3 Reference POST parameter Specifiable value Description DefaultWEPKey Specifies the WEP key to be used. WEPKey1 WEP key 1 WEPKey2 WEP key 2 WEPKey3 WEP key 3 WEPKey4 WEP key 4
  • Epson TM-T70-i | TM-i WebConfig API Users Manual - Page 32
    Auto Manual Refers to whether 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
  • Epson TM-T70-i | TM-i WebConfig API Users Manual - Page 33
    set_epos_print.cgi Registers a new device. Refer to the Technical Reference Guide for printers that can be designated. POST parameter . TM-T88V TM-T88V TM-T88IV TM-T88IV TM-T70 TM-T70 TM-T90 TM-T90 IPAddress RetryInterval TM-L90 (String) (String) TM-L90 Specifies the IP address.
  • Epson TM-T70-i | TM-i WebConfig API Users Manual - Page 34
    (String) Description Specifies the MAC address. Specifies the IP address. Specifies the IP address setting method. Auto Manual Refers to whether to enable or disable APIPA. Enable Disable Specifies the IP address. Specifies the subnet mask. Specifies the default gateway. Specifies a new password to
  • Epson TM-T70-i | TM-i WebConfig API Users Manual - Page 35
    Chapter 3 Reference POST parameter Specifiable value Description NetworkMode Specifies the network mode. Infrastructure Infrastructure mode Adhoc Adhoc mode SSID (String) Specifies the SSID by a character string using
  • Epson TM-T70-i | TM-i WebConfig API Users Manual - Page 36
    POST parameter WEPKey2 WEPKey3 WEPKey4 PresharedKey Password Specifiable value (String) (String) (String) (String) (String) Description Specifies a value for WEP key 2 using one of the following strings: • 10-digit hexadecimal number • 26-digit hexadecimal number • 5 single-byte alphanumeric
  • Epson TM-T70-i | TM-i WebConfig API Users Manual - Page 37
    Chapter 3 Reference Web Contents Updater SettingUrl : set_web_contents_updater.cgi Changes the Web contents update setting. POST parameter Specifiable value Description AutoUpdate Specifies whether to automatically update the Web
  • Epson TM-T70-i | TM-i WebConfig API Users Manual - Page 38
    POST parameter UseProxy ProxyURL Specifiable value Enable Disable (String) Description Specifies whether to use a proxy server at the time of automatic update. Enable Disable Specifies the URL of the proxy server. Automatic Update SettingUrl : execute_web_contents_updater.cgi Forcibly perform
  • Epson TM-T70-i | TM-i WebConfig API Users Manual - Page 39
    Reference Time of Day SettingUrl : set_time.cgi Changes the time-of-day setting. POST parameter Specifiable value Description Year (String) Specifies the year of the internal clock of the TM server name acquisition method. Auto 3 Manual Manual TimeServer (String) Specifies the time
  • Epson TM-T70-i | TM-i WebConfig API Users Manual - Page 40
    and Initializing the Settings SettingUrl : set_reset.cgi Resets the wired LAN/wireless LAN and restores the factory default settings. POST parameter Operation Specifiable value Reset FactoryDefault Description Resets the wired LAN/wireless LAN. Restores the factory default settings. 40
  • Epson TM-T70-i | TM-i WebConfig API Users Manual - Page 41
    Chapter 3 Reference Error Codes and Actions to Take This section describes an error code returned to the response body value. Check the values for the communication standard supported by the printer to correct the value. InvalidAuthenticationMethod Invalid AuthenticationMethod parameter value
  • Epson TM-T70-i | TM-i WebConfig API Users Manual - Page 42
    HostName parameter value. Correct the error. The string specified for the Password parameter did not match the password string set into the detected TM printer. Correct the error. The TM printer specified for the MACAddress or HostName parameter could not be found. Check the connection status of the
  • Epson TM-T70-i | TM-i WebConfig API Users Manual - Page 43
    Chapter 3 Reference code Action to Take InvalidCommunicationStandardAdhoc When Adhoc is specified for the NetworkMode parameter, 802.11b/g/n cannot be specified for CommunicationStandard. Correct the error. DeviceNotWireless The TM printer specified for the MACAddress or HostName parameter is
  • Epson TM-T70-i | TM-i WebConfig API Users Manual - Page 44
    code InvalidPassword IDNeededToSetPassword InvalidURL InvalidInterval InvalidAdministrator InvalidLocation InvalidYear InvalidMonth InvalidDay InvalidHour InvalidMinute InvalidTimeZone InvalidUseTimeServer InvalidTimeServerSettingMethod InvalidTimeServer InvalidDate InvalidTime InvalidNewPassword
  • Epson TM-T70-i | TM-i WebConfig API Users Manual - Page 45
    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 45
  • Epson TM-T70-i | TM-i WebConfig API Users Manual - Page 46
    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-T70-i | TM-i WebConfig API Users Manual - Page 47
    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-T70-i | TM-i WebConfig API Users Manual - Page 48
    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. 48
  • Epson TM-T70-i | TM-i WebConfig API Users Manual - Page 49
    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-T70-i | TM-i WebConfig API Users Manual - Page 50
    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
  • 1
  • 2
  • 3
  • 4
  • 5
  • 6
  • 7
  • 8
  • 9
  • 10
  • 11
  • 12
  • 13
  • 14
  • 15
  • 16
  • 17
  • 18
  • 19
  • 20
  • 21
  • 22
  • 23
  • 24
  • 25
  • 26
  • 27
  • 28
  • 29
  • 30
  • 31
  • 32
  • 33
  • 34
  • 35
  • 36
  • 37
  • 38
  • 39
  • 40
  • 41
  • 42
  • 43
  • 44
  • 45
  • 46
  • 47
  • 48
  • 49
  • 50

TM-i Series
WebConfig API User's Manual
M00052304
Rev.E
Overview
Response Body Format
Reference
Sample Program