TM-i WebConfig API User`s Manual
Contents
1. Chapter 2 Response Body Format JSON format response success Result This portion is added when response fails code Reason Response body Example When response is successful set_tcpip_wired cgi response success true When response fails response success false code InvalidlPAddress on page 41 N For details on an error code when response fails see Error Codes and Actions to Take 17 18 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 InvalidlPAddress For details on an error code when response fails see Error Codes and Actions to Take Q on page 41 Chapter 3 Reference Reference Referring to Set Values Wired LAN General SettingUrl config_general_wired cgi Refers to the link soeed of the wired LAN 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 19 20 TCP IP2. SettingUrl config_tcpip_wired cgi Refers to the IP address etc of the wired LAN Category WiredNetwork IPAddressSettingMethod Refers to the IP address setting method Auto Auto Manual Manual APIPA Refers to whether to enable or disable APIPA Enable Enable Disable Disable IPAddress String Refers to the IP address SubnetMask String Refers to the subnet mask Gateway String Refers to the default gateway DNSServerSettingMethod Refers to the DNS server IP address setting method Auto Auto Manual Manual DNSServerlPAddress1 String Refers to DNS server IP address 1 DNSServerlPAddress2 String Refers to DNS server IP address 2 DNSServerlPAddress3 String Refers to DNS server IP address 3 General SettingUrl config_general_wireless cgi Refers to the SSID etc of the wireless LAN Chapter 3 Reference Wireless LAN Key Description WiredLinkLayer NetworkMode Refers to the network mode Infrastructure Infrastructure mode Adhoc Adhoc mode SD Sting RReferstothe 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 Refers to the authentication method Opensystem Opensystem SharedKey SharedKey WPAPSK WPAPSK WPA2PSK WPA2PSK EncryptionMethod
3. DevicelDAlreadyRegistered The device specified for the DevicelD parameter cannot be registered because it is already registered Specify a different ID InvalidModel Invalid Model parameter value Correct the error InvalidRetryInterval Invalid Retrylnterval parameter value Correct the error DevicelDNotRegistered InvalidMACAdaress The device specified for the DevicelD parameter cannot be deleted because it is not registered Specify an already registered ID Invalid MACAdaress parameter value Correct the error InvalidHostName Invalid HostName parameter value Correct the error The string specified for the Password parameter did not PasswordNotCorrect match the password string set into the detected TM printer Correct the error The TM printer specified for the MACAddress or HostName DeviceNotFound parameter could not be found Check the connection status of the TM printer code InvalidCommunicationStandardAdhoc Chapter 3 Reference Action to Take 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 not a printer with any wireless LAN interface Check the interface of the TM printer InvalidAutoUpdate nvalid AutoUpdate parameter value Correct the error InvalidFrequency nvalid F
4. hexadecimal number e 5single byte alphanumeric characters Excluding spaces 13 single byte alphanumeric characters Excluding spaces PresharedKey String Specifies the pre shared key using one of the following strings 8ormore to 63 or less single byte alphanumeric characters Excluding spaces e 64 digit hexadecimal number 31 32 TCP IP SertingUrl set_tcpip_wireless cgi Changes the IP address etc of the wireless LAN POST parameter Specifiable value Description IPAddressSettingMethod Specifies the IP address setting method Auto Auto Manual Manual APIPA Refers to whether to enable or disable APIPA Enable Enable Disable Disable IPAddress String Specifies the IP address SubnetMask String Specifies the subnet mask Gateway String Specifies the default gateway DNSServerSettingMethod Specifies the DNS server IP address setting method Auto Auto Manual Manual DNSServerlPAdaress1 String Refers to DNS server IP address 1 DNSServerlPAddress2 String Refers to DNS server IP address 2 DNSServerlPAddress3 String Refers to DNS server IP address 3 Chapter 3 Reference Adding a Device SettingUrl set_epos_print cgi Registers a new device Q Refer to the Technical Reference Guide for printers that can be designated value DevicelD String Specifies the device ID by a character string using singl
5. to the IP address setting method Auto Auto Manual Manual APIPA Refers to whether to enable or disable APIPA Enable Enable Disable Disable SubnetMask String Refers to the subnet mask Gateway String Refers to the default gateway NetworkMode Refers to the network mode Infrastructure Infrastructure mode Adhoc Adhoc mode 23 Category NetworkPrinter n SSID String Refers to the SSID AdhocChannel String Refers to the AdhocChannel CommunicationStandard Refers to the communication standard 802 11b 802 11b 802 11b g 802 11b g 802 11b g n 802 11b g n AuthenticationMethod Refers to the authentication method Opensystem Opensystem SharedKey SharedKey WPAPSK WPAPSK EncryptionMethod Refers to the encryption method None No encryption WEP WEP TKIP TKIP AES AES DefaultWEPKey Refers to the WEP key to be used WEPKey1 WEP key 1 WEPKey2 WEP key 2 WEPKey3 WEP key 3 WEPKey4 WEP key 4 SettingUrl config_web_contents_updater cgi Refers to the Web contents update setting Category WebContents Chapter 3 Reference Web Contents Updater AutoUpdate Refers to whether to automatically update the Web contents Enable Enable Disable Disable Frequency Refers to the frequency of automatic update Hour Updates at specified time intervals Daily Updates daily at the spe
6. utility gt lt response success true gt lt Category gt lt Key1 gt Value1 lt YKey1 gt lt Key2 gt Value1 lt YKey2 gt lt Key3 gt Value1 lt YKey3 gt lt Category gt lt epos utility gt The above keys are in no particular order Response body Example config_tcpip_wired cgi lt xml version 1 0 encoding UTF 8 gt lt epos utility xmins http www epson pos com schemas 2012 02 epos utility gt lt response success true gt lt WiredNetwork gt lt IPAddressSettingMethod gt Auto lt IPAddressSettingMethod gt lt APIPA gt Enable lt APIPA gt lt IPAddress gt 192 168 192 168 lt IPAddress gt lt Netmask gt 255 255 255 0 lt Netmask gt lt Gateway gt 192 168 192 1 lt Gateway gt lt DNSServerSettingMethod gt Auto lt DNSServerSettingMethod gt lt DNSServerlPAddress1 gt 192 168 192 1 lt DNSServerlPAddress1 gt lt DNSServerlPAddress2 gt 192 168 192 1 lt DNSServerlPAddress2 gt lt DNSServerlPAddress3 gt 192 168 192 1 lt DNSServerlPAddress3 gt lt WiredNetwork gt lt epos utility gt Chapter 2 Response Body Format JSON format response success true i 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 hi WiredNetwork PAddres
7. EPSON EXCEED YOUR VISION TM i Series WebConfig API User s Manual Overview Response Body Format Reference Sample Program MO00052304 Rev E 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 E
8. ONT COLOR 0000ff gt Operation is complete lt FONT gt lt br gt lt br gt lt P gt lt AID pageback HREF onclick GoBack return false gt Go Back lt A gt
9. Refers to the encryption method None No encryption WEP WEP TKIP TKIP AES AES DefaultWEPKey Referstothe WEPkeytobe used WEPKey1 WEP key 1 WEPKey2 WEP key 2 WEPKey3 WEP key 3 WEPKey4 WEP key 4 WEPKey1 String Refers to WEP key 1 WEPKey2 String Refers to WEP key 2 WEPKey3 String Refers to WEP key 3 WEPKey4 String Refers to WEP key 4 PresharedKey String Refers to the pre shared key 21 TCP IP SettingUrl config_tcpip_wireless cgi Refers to the IP address etc of the wireless LAN Category WirelessNetwork IPAddressSettingMethod Refers to the IP address setting method Auto Auto Manual Manual APIPA Refers to whether to enable or disable APIPA Enable Enable Disable Disable IPAddress String Refers to the IP address SubnetMask String Refers to the subnet mask Gateway String Refers to the default gateway DNSServerSettingMethod Refers to the DNS server IP address setting method Auto Auto Manual Manual DNSServerlPAdaress1 String Refers to DNS server IP address 1 DNSServerlPAddress2 Sting Refers to DNS server IP address 2 DNSServerlPAdadress3 String Refers to DNS server IP address 3 Device SettingUrl config_epos_print cgi Refers to the registered device settings Category Key Description Devices DevicelD Refers to the device ID by turning it into the string Devices Device ID As many valu
10. TM i e html HTML format the same operation as the operation performed when viewing EPSON TMNet WebConfig by using a browser e xml XML format e json JSON format e ini ini format e Ifa password is set for EPSON TMNet WebConfig WebConfig API at the time of Q access to the above URL the user name epson specific and password strings will be requested through digest authentication For SettingUrl and values refer to Chapter 3 Reference To use WebConfig API from XmlHttpRequest in javascript register the Web page where the javascript code is written to the TM i as Web contents 15 16 XML format lt xml version 1 0 encoding UTF 8 gt lt epos utility xmins http www epson pos com schemas 2012 02 epos utility gt lt response success Result code Reason gt lt epos utility gt This portion is added when response fails Response body Example set_tcpip_wired cgi When response is successful lt epos utility xmins http www epson pos com schemas 2012 02 epos utility gt lt response success true gt lt epos utility gt When response fails lt epos utility xmins http www epson pos com schemas 2012 02 epos utility gt lt response success false code InvalidlPAddress gt lt epos utility gt For details on an error code when response fails see Error Codes and Actions to Take Q on page 41
11. alidUse Invalid Use parameter value Correct the error InvalidID Invalid ID parameter value Correct the error 43 44 InvalidPassword Invalid Password parameter value Correct the error When a string with no null character is specified for the Password parameter a null character string cannot be IDNeededToSetP AO oa specified for the ID parameter Set a value for the ID parameter nvalidURL nvalid URL parameter value Correct the error nvalidinterval nvalid Interval parameter value Correct the error nvalidAdministrator nvalid Administrator parameter value Correct the error nvalidLocation nvalid Location parameter value Correct the error nvalid Year parameter value nvalidYear re Correct the error nvalid Month parameter value nvalidMonth Sa Correct the error nvalid Day parameter value nvalidDay ES or Correct the error f nvalid Hour parameter value nvalidHour Correct the error nvalidMinute nvalid Minute parameter value Correct the error nvalidTimeZone nvalid TimeZone parameter value Correct the error nvalidUseTimeServer nvalid UseTimeServer parameter value Correct the error nvalicTimeServerSettingMethod nvalidTimeServer nvalid TimeServerSettingMethod parameter value Correct the error nvalid TimeServer parameter value Correct the error nvalidDate nvalid Year Month Day pa
12. alues of a TM i using the GET method hereafter GET defined in HTTP Hypertext Transfer Protocol AU Allows an application to change the set values of a TM i using the POST method hereafter POST defined in HTTP HyperText Transfer Protocol Usable Formats A html HyperText Markup Language A xml Extensible Markup Language A json Javascript Object Notation A ini Text file format mainly used in a Windows OS environment TM Printer a TM i e TM T88V i e TM T70 i e TM L90 i 1 TM Printer e TM T88V e TM T88IV e TM T70 e TM T90 e TM L9O e TM P60Il e TM T20 e TM U220 Chapter 1 Overview Contents in the Package Manual 1 TM i WebConfig API User s Manual This Document d ePOS Print XML User s Manual 1 ePOS Print API User s Manual 1 TM T88V i Technical Reference Guide 4 TM T70 i Technical Reference Guide 1 TM L90 i Technical Reference Guide Sample Program WebConfigAPISample xls 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 Restrictions Web contents zip file cannot be manually uploaded by using WebConfig API 1 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 th
13. cified time of day Weekly Updates weekly on the specified day of the week and at the specified time of day Monthly Updates monthly on the specified day and at the specified time of day Timing Refers to the timing of automatic update 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 Sunday Updates every Sunday Frequency Weekly Monday Updates every Monday Tuesday Updates every Tuesday Wednesday Updates every Wednesday Thursday Updates every Thursday Friday Updates every Friday Saturday Updates every Saturday When String Refers to the day to perform Frequency Monthly automatic update UpdateTimeHour String Refers to the hour of the time of day to perform automatic update When Frequency Hour an empty character is returned 25 Category WebContents UpdateTimeMinute String Refers to the minute of the time of day to perform automatic update When Frequency Hour an empty character is returned FileURL String Refers to the URL of the Web contents file UseProxy Refers to whether to use a proxy server at the time of automatic update Enable Enable Disable Disable ProxyURL String Refers to the URL of the proxy server LastUpdateYear String Refers to the year automatic update was performed last LastUpdateM
14. dates every Thursday Friday Updates every Friday Saturday Updates every Saturday When String Specifies the date to perform automatic Frequency Monthly update using an integer in the range 1 31 UpdateTimeHour String Specifies the hour of the time to perform automatic update using an integer in the range 0 23 When Frequency Hour specifies the empty character UpdateTimeMinute String Specifies the minute of the time to perform automatic update using an integer in the range 0 59 When Frequency Hour specifies the empty character FileURL String Specifies the URL of the Web contents file 37 value UseProxy Specifies whether to use a proxy server at the time of automatic update Enable Enable Disable Disable ProxyURL String Specifies the URL of the proxy server Automatic Update SettingUrl execute_web_contents_updater cgi Forcibly perform automatic update of the Web contents No parameter to be set Administrator and Location SettingUrl set_administrator cgi Changes the administrator information value Administrator String Specifies the string that designates the administrator 255 characters or less long Location String Specifies the string that designates the location 255 characters or less long Chapter 3 Reference Time of Day SettingUrl set_time cgi Changes the time of day setting value Year String Specifies the year of the in
15. ddress1 DNSServerlPAddress3 Gateway 192 168 192 1 192 168 192 20 PAddressSettingMethod 255 255 255 0 isable 192 168 192 1 4 Success or failure of the processs to change the set value will be disolayed 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 GET SET Upload Web Contents success false code InvalidlPAddress WirelessNetwork Oooo O DNSServerlPAddress2 o O DNSServerSettingMethod Manual PAddressSettingMethod Manual SubnetMask 255 255 255 0 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 lt xml version 1 0 encading UTF 8 gt lt epos utility xmins http www epson pos com schemas 201 2 02 er lt response success true gt lt Devices local_printer gt lt IPAddress gt lt IPAddress gt lt Model gt T M T70 lt Model gt lt RetryInte rval gt 100 lt RetryInterval gt Response body lt Devices lo cal_printer gt lt Devices printer gt lt IPAddress gt 192 1 68 192 168 lt IPAddress gt lt Model gt T M T70 lt Model gt lt RetryInterval gt 1 00 lt Retryinte rval lt Devices printer gt lt epos utility gt Devices lo cal p
16. duplex AutoNegotiation Auto negotiation TCP IP SettingUrl set_tcpip_wired cgi Changes the IP address etc of the wired LAN POST parameter Specifiable value Description IPAdaressSettingMethod Specifies the IP address setting method Auto Auto Manual Manual APIPA Refers to whether to enable or disable APIPA Enable Enable Disable Disable IPAddress String Specifies the IP address setting method SubnetMask String Specifies the subnet mask Gateway String Specifies the default gateway 29 30 POST parameter Specifiable value Description DNSServerSettingMethod Specifies the DNS server IP address setting method Auto Auto Manual Manual DNSServerlPAdaress1 String Refers to DNS server IP address 1 DNSServerlPAddress2 String Refers to DNS server IP address 2 DNSServerlPAddress3 String Refers to DNS server IP address 3 Wireless LAN General SettingUrl set_general_wireless cgi Changes the SSID etc of the wireless LAN value NetworkMode Specifies the network mode Infrastructure Infrastructure mode Adhoc Adhoc mode SSID String Specifies the SSID by a character string using single byte alphanumeric characters 1 character or more to 32 characters or less long Excluding spaces AdhocChannel String Specifies the ad hoc channel using an integer in the range 1 11 Communica
17. e byte alphanumeric characters underscore s period s and or dash es one character or more and 30 characters or less long Model Specifies the device model TMT88V TM BB TM T88IV TM T88IV PIM MA TM T90 TM T90 MO MAA ae sss IPAddress String Specifies the IP address Retrylnterval String Specifies the communication retry interval using a numeric value in milliseconds in the range 100 60000 Deleting a Device SettingUrl delete_epos_print cgi Deletes a registered device value DevicelD String Specifies the device ID by a character string using single byte alphanumeric characters underscore s period s and or dash es one character or more and 30 characters or less long 33 Setting a TM printer General SettingUrl set_device_tcpip cgi Changes the network settings for a TM printer connected to the TM i Setting is possible under the following conditions AN TM i and TM printers are connected to the same subnet network by a LAN cable Setting is not possible if the TM i and TM printers are connected by a wireless LAN A TMi printer and wireless LAN interface with a USB connector of a TM printer are connected by USB UB RO3 POST parameter Specifiable value Description MACAdaress String Specifies the MAC adaress HostName String Specifies the IP address IPAddressSettingMethod Specifies the IP address setting met
18. e factory default settings Chapter 3 Reference Error Codes and Actions to Take This section describes an error code returned to the response body when POST fails and an action to take Firmware is being updated by the remote update tool FirmwareUpdating Wait until the execution of the remote update tool becomes complete Invalid LinkSpeed parameter value ti Correct the error Invalid IPAddressSettingMethod parameter value InvalidlPAddressSettingMethod Gonscrineenar Invalid APIPA parameter value InvalidAPIPA Correct the error Invalid IPAddress parameter value ali ASES Correct the error Invalid SubnetMask parameter value InvalidSubnetMask Correct the error Invalid Gateway parameter value lidGat nvalidGateway Correct the error Invalid DNSServerSettingMethod parameter value InvalidDNSServerSettingMethod Gonchar Invalid value for any of the parameters DNSServerlPAddress1 InvalidDNSServerlPAddress to DNSServerlPAddress3 Correct the error Invalid NetworkMode parameter value InvalidNetworkMode Correct ihe gror Invalid SSID parameter value InvalidSSID Correct the error Invalid AdhocChannel parameter value lidAdh h di CO ROS Correct the error Invalid CommunicationStandard parameter value InvalidCommunicationStandard Check the values for the communication standard supported by the printer to correct the value Invalid A
19. e sample program Refer to the sample program 10 Chapter 2 Response Body Format Response Body Format An application can specify the format for the response body to be 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 q IP Adress The IP address of the TM i whose set values to be acquired T SettingUrl The URL of the set values to be acquired A format Specifies the format of the response body to be returned by the TM i e html HTML format the same operation as the operation performed when viewing EPSON TMNet WebConfig by using a browser e xml XML format e json JSON format e ini ini format e If a password is set for EPSON TMNet WebConfig WebConfig API at the time of Q access to the above URL the user name epson specific and password strings will be requested through digest authentication For SettingUrl and values refer to Chapter 3 Reference To use WebConfig API from XmlHttpRequest in javascript register the Web page where the javascript code is written to the TM i as Web contents 11 12 XML format lt xml version 1 0 encoding UTF 8 gt lt epos utility xmins http www epson pos com schemas 2012 02 epos
20. es for Category Model IPAddress and RetryInterval as registered devices will be returned from the TM i Model String Refers to the device model IPAddress String Refers to the IP address Retrylnterval String Refers to the communication retry interval in milliseconds Chapter 3 Reference Searching TM printers SettingUrl search_devices cgi Refers to the settings of TM printers connected to the TM i Referencing is possible under the following conditions AN e TM i and TM printers are connected to the same subnet network by a LAN cable Referencing is not possible if the TM i and TM printers are connected by a wireless LAN e A TMi printer and wireless LAN interface with a USB connector of a TM printer are connected by USB UB RO3 Category NetworkPrinter n Refer to detected printers with the character string NetworkPrinter n Cn is a number applied in the order the printers were detected in Model String Refers to the device model IPAddress String Refers to the IP address MACAddress String Refers to the MAC address Connection Refers to the detected printer s connection status Wired Detects a wired LAN connection printer on the LAN Wireless Detects a wireless LAN connection printer on the LAN USB Detects a wireless LAN connection printer via USB connection IPAddressSettingMethod Refers
21. hod Auto Auto Manual Manual APIPA Refers to whether to enable or disable APIPA Enable Enable Disable Disable IPAddress String Specifies the IP address SubnetMask String Specifies the subnet mask Gateway String Specifies the default gateway Password String Specifies a new password to be set using a single byte alphanumeric character string O zero character or more and 20 characters or less long Wireless LAN SettingUrl set_device_wireless cgi Changes the wireless LAN settings for a TM printer connected to the TM i Setting is possible under the following conditions AN e A TMi printer and wireless LAN interface with a USB connector of a TM printer are connected by USB UB RO3 value MACAddress String Specifies the MAC address HostName String Specifies the IP address 34 Chapter 3 Reference value NetworkMode Specifies the network mode Infrastructure Infrastructure mode Adhoc Adhoc mode SSID String Specifies the SSID by a character string using single byte alphanumeric characters 1 character or more to 32 characters or less long Excluding spaces AdhocChannel String Specifies the ad hoc channel using an integer in the range 1 11 CommunicationStandard Specifies the communication standard 802 116 802 116 802 11b g 802 11b g 802 11b g n 802 11b g n AuthenticationMethod Specif
22. ies the authentication method Opensystem Opensystem SharedKey SharedKey WPAPSK WPAPSK EncryptionMethod Specifies the encryption method None No encryption WEP WEP TKIP TKIP AES AES DefaultWEPKey Specifies the WEP key to be used WEPKey1 WEP key 1 WEPKey2 WEP key 2 WEPKey3 WEP key 3 WEPKey4 WEP key 4 WEPKey1 String Specifies a value for WEP key 1 using one of the following strings 10 digit hexadecimal number 26 digit hexadecimal number e 5single byte alphanumeric characters Excluding spaces e 13single byte alphanumeric characters Excluding spaces 35 36 POST parameter Specifiable value WEPKey2 String Description Specifies a value for WEP key 2 using one of the following strings 10 digit hexadecimal number e 26 digit hexadecimal number e 5single byte alphanumeric characters Excluding spaces e 13 single byte alphanumeric characters Excluding spaces WEPKey3 String Specifies a value for WEP key 3 using one of the following strings e 10 digit hexadecimal number e 26 digit hexadecimal number e 5single byte alphanumeric characters Excluding spaces e 13 single byte alphanumeric characters Excluding spaces WEPKey4 String Specifies a value for WEP key 4 using one of the following strings e 10 digit hexadecimal number e 26 digit hexadecimal number e 5single byte alphanumeric characters Excluding spaces e 13 single byte alphanume
23. ignment by the time server Enable Enable Disable Disable TimeServerSettingMethod Refers to the time server name acquisition method Auto Auto Manual Manual TimeServer Refers to the time server name LastUpdateResult Displays the results of the last time of day acquisition synchronized with the time server Success Time of day synchronization with the time server was successful Failure Time of day synchronization with the time server failed Time of day synchronization not done TimeZone Refers to the time zone 27 28 Password SettingUrl config_password cgi Refers to the set password Password PasswordMD5 String Refers to the string created from the password string through MD5 encryption Changing the Set Values Chapter 3 Reference Common You can not send only part of the parameters written in each SettingUrl Send all the parameters in each SettingURL If you want to change some set values only send together the parameters other than those you wantto change without changing their values acquired by referring to the settings Wired LAN General SettingUrl set_general_wired cgi Changes the link speed of the wired LAN POST parameter Specitabie value LinkSpeed Specifies the link speed 10BaseTHalf 10BaseT half duplex 10BaseTFull 10BaseT full duplex 100BaseTHalf 100BaseT half duplex 100BaseTFull 100BaseT full
24. ling macros Specify values for IP Address CGI Name Format User Name and Password For CGI Name and Format each select a parameter from a list 0030 00M 2 0 2 Click the GET button The response body and set values will be filled into the cells B Cc lo HTTP status code response success true J WiredNetwork DNSServerlPAddress2 DNSServerSettingMethod Manual R Di IPAddress 192 168 192 20 APOE IPAddressSettingMethod Manual SubnetMask 255 255 255 0 APIPA Disable DNSServerlPAddress1 DNSServerlPAddress3 Gateway 192 168 192 1 WiredNetwork J O IDNSServeriPAddress2 fT IDNSServerSettingMethod Manual M ServerlPAddre SubnetMask 2552552550 PIPA S PAddressSettingMethod Manual DNSServerlPAddresst ss3 PT 2 DNS 3 192 168 192 1 47 48 Change the set value you want to change and click the SET button The response body and set values will be filled into the cells GET SET Upload Web Contents HTTP status code 200 response success true ds WiredNetwork DNSServerlPAddress2 DNSServerSettingMethod Manual IPAddress 4 92 168 192 20 IPAddressSettingMethod Manual SubnetMask 255 255 255 0 APIPA Disable DNSServerlPA
25. n cnnnncnnnns 11 AMET Matas basas datada 12 JSON TOMO 13 NOME sac Ta poa raid ata 14 E Changing the Set Values Of a TMod ooooococoniconnnoncccnnnncccnancncnnnancnnannnn nana cnn nnnnnnnnnner nn nnnnnnn nan 15 XAML TO MO daa baca dane 16 JSON TO MO sara ds da dd ill a olaa 17 Muda ia 18 ROTTEN CO dicas 19 E Referring to Set Values wicoomiimiicinainci ceci ici ri 19 WIirEdiLAN iia a coastal a A AAA A 19 WHIRSISSS LAN A eE a ir a ea AN 21 DEVICE sk waa Su acid Bra A AA Saas eid A a nee 22 SEOPCHING IM PriNtSrSvss isssccsssecadsccdcasvassssiseaveanescuacestanscvensecdsnacdenseteasustesshsseiaetensisecuenedduesasvanniuernctedagey 23 Web Contents UCTS viii ri cn ci adi E died 25 Administrator ANC LOCATION woe ro rro rro rro rr rr 26 IAE SOLADE N AAEE EE E AAA AAA A 27 OEEO O A 28 M Changing the Set ValUEs cv iia ren 29 COMMO Man dana AA A a A a aea E avid adnan TR 29 ETO ANN E o T AS 29 Wireless LAN 0 A BA EE a AA as Deena A i 30 NO e lID KO NDIE CS AE A E A E a a a A 33 Deleting a Devic usina a A ania ci A EAEE EEE A A ANE EEA NERES aires 33 SETTING a MPAA il ca 34 Web Contents Updater a V A da i ri Ea 37 Automatic Update e raia at cas inaa as da Ebai Uinta PE PAAR cabo 38 Administrator and LOCOTION cinta a Ei EEE E PoR 38 IENEI DOV certs AEEA er E E EEA TE 39 POSSWOI ia A r A AA LAT NA DALE ae Tea A 39 Resetting and Initializing the SettidQS EE ee rr 40 E Error Codes and Actions to Take oo ccccccnncccccncno
26. onoccccccnononnnnncconnnnnnnnncnnnnnnnnnnnnnnnnnnsnnnnnnnn 41 Sampl PIOGKOING vrai 45 MSC Noia A A id 45 E Operating Environment oocoooncccnnoncccnnnaccnnnncnnnnnnncnnnnnnnnnnnn cnn cnn rc cnn cnc rra rre cannns 46 E Basic Usage of the Sample PrOQrUAM cooccccccconcccnnnnccnnnnnncnnnacnonannnonannnennnnnannnnnnn nn nnnnnnnnnns 47 E Uploading Files ieee lin dead 50 Chapter 1 Overview Overview What is WebConfig API WebConfig API is an API for setting and referencing the EPSON TMNet WebConfig of the TM i series You can use it by including it in your application This function can be used in the firmware Ver 2 x or later The EPSON TMNet WebConfig of the TM i series and of a TM printer registered in the TM i series can be referenced or set up from the client s application Setting work has been streamlined for TM printers with a UB RO3 interface because wireless LAN settings can be performed by connecting a USB Firmware Ver 3 x or later TM Printer EN Wired LAN 3 Computer pco to configure the settings USB ps Device Control e Do not use the WebConfig API if you are directly setting or referring to the TM i s Q settings from a browser on a computer e For the functions of EPSON TMNet WebConfig refer to the detailed manual for each printer T Allows getting setting setting values of TM i from HTTP supported devices Not OS dependent AU Allows an application to refer to the set v
27. onth String Refers to the month automatic update was performed last LastUpdateDay String Refers to the day automatic update was performed last LastUpdateHour String Refers to the hour of the time automatic update was performed last LastUpdateMinute String Refers to the minute of the time automatic update was performed last LastUpdateResultCode String Refers to the results of the last automatic update as a numeric value LastUpdateResultMessage String Refers to the results of the last automatic update as a message string Administrator and Location SettingUrl config_administrator cgi Refers to the administrator information Category General Administrator String Refers to the string that designates the administrator Location String Refers to the string that designates the location 26 Chapter 3 Reference Time of Day SettingUrl config_time cgi Refers to the time of day setting Time Year String Refers to the year of the internal clock of the TM i Month String Refers to the month of the internal clock of the TM i Day String Refers to the day of the internal clock of the TM i Hour String Refers to the hour of the time of the internal clock of the TM i Minute String Refers to the minute of the time of the internal clock of the TM i UseTimeServer Refers to whether to enable or disable the clock al
28. pson Corporation Trademarks Windows and Internet Explorer are either registered trademarks or trademarks of Microsoft Corpora tion in the United States and other countries EPSON and ESC POS are registered trademarks of Seiko Epson Corporation in the U S and other countries Copyright 2012 2013 Seiko Epson Corporation All rights reserved For Safety AO OS 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 avoid damage to your equipment or AN a malfunction Q 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 design 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 evalua
29. rameter combination Correct the error InvalidTime InvalidNewPassword nvalid Hour Minute parameter combination Correct the error nvalid NewPassword parameter value Correct the error InvalidOperation nvalid Operation parameter value Correct the error 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 co User Name ep 6 7 em GET SET Upload Web Contents Fo 10 response 12 code EER AA ss 15 Response bod 16 ay 18 19 20 21 22 aah 24 EAS 26 27 28 29 30_ 31 32 33 34 arn 45 Operating Environment 46 The system configuration diagram for the sample programs is as below 2 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 192 168 192 20 T Wireless LAN Router 1 TM i 1 set TM T88V i TM T70 i TM L90 i d Computer to configure the settings Computer in which Microsoft Office Excel 2003 Excel2003 or later and Microsoft Internet Explorer 7 or later are installed Chapter 4 Sample Program Basic Usage of the Sample Program This sample program is implemented using VBA macros Use this program by enab
30. requency parameter value Correct the error InvalidTiming nvalid Timing parameter value Correct the error InvalidUpdateTimeHour nvalid UpdateTimeHour parameter value Correct the error InvalidTimeMinute nvalid UpdateTimeMinute parameter value Correct the error InvalidFileURL nvalid FileURL parameter value Correct the error InvalidUseProxy nvalid UseProxy parameter value Correct the error InvalidProxyURL nvalid ProxyURL parameter value Correct the error AccessToFileURLFailed Failed to access the URL specified for the FileURL parameter Check the network settings for the TM i and for the server AccessToProxyURLFailed NotEnoughFreeSpace FileURLNotZip Failed to access the proxy URL specified for the ProxyURL parameter Check the network settings for the TM i and for the server The amount of free 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 contents is 30MB or less The Web contents downloaded from the URL specified for File URL were not of a zip file format Correct the error WebContentsUpdaterDisabled The Web contents automatic update setting is disabled Correct the error The Web contents save destination is specified as microSD microSDNotFound but no microSD could be detected Check that a microSD is mounted to the TM i Inv
31. ric characters Excluding spaces PresharedKey String Specifies the pre shared key using one of the following strings e 8 or more 63 or less single byte alphanumeric characters Excluding spaces Password String Specifies a new password to be set using a single byte alphanumeric character string O Zero character or more and 20 characters or less long Chapter 3 Reference Web Contents Updater Settingurl set_web_contents_updater cgi Changes the Web contents update setting value AutoUpdate Specifies whether to automatically update the Web contents Enable Enable Disable Disable Frequency Specifies the frequency of automatic update Hour Updates at specified time intervals Daily Updates daily at the specified time of day Weekly Updates weekly on the specified day of the week and at the specified time of day Monthly Updates monthly on the specified day and at the specified time of day Timing Specifies the timing of automatic update The value to be specified varies depending on the value for Frequency When Frequency Hour String Specifies the time interval of automatic update using an integer in the range l 23 When Frequency Daily Specify a blank character When Sunday Updates every Sunday Frequency Weekly Monday Updates every Monday Tuesday Updates every Tuesday Wednesday Updates every Wednesday Thursday Up
32. rinter IPAddress Moe frwerzo Retryinterval too IPAddress 192 168 192 168 TM T70 Retryinterval too PO All the registered devices are displayed B GET SET Upload Web Contents 14 HTTP status code 200 lt xml version 1 0 encoding UTF 8 gt lt epos utility xmins http www epson pos com schemas 201 2 02 epo Response body lt response success true gt lt epos utility gt DevicelD printe rt Write only one device Pes AENA to be registered Model rim T70 Retryintewal foo 49 Uploading Files 50 A Click the Upload Web Contents button GET SET Upload Web Contents response success 12 code 14 HTTP status code 15 se 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 which the file has been successfully uploaded ee 14 HTTP status code 200 lt link rel stylesheet href style css type text css gt lt TITLE gt Operation is complete lt TITLE gt lt HEAD gt lt BODY BGCOLOR FFFFFF TEXT 000000 gt lt script type text javascript gt function GoBack var calledurl document referrer location href calledurl Response body lt script gt lt CENTER gt lt F
33. sSettingMethod Auto APIPA Enable IPAddress 192 168 192 168 Netmask 255 255 255 0 Gateway 192 168 192 1 DNSServerSettingMethod Auto DNSServerlPAddress1 192 168 192 1 DNSServerlPAddress2 192 168 192 1 DNSServerlPAddress3 192 168 192 1 13 response success true Category Key1 Valuel 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 168 192 168 Netmask 255 255 255 0 Gateway 192 168 192 1 DNSServerSettingMethod Auto DNSServerlPAddress1 192 168 192 1 DNSServerlPAddress2 192 168 192 1 DNSServerlPAddress3 192 168 192 1 Chapter 2 Response Body Format Changing the Set Values of a TM i An application e g javascript or excel macro can change the set values of a TM i by executing POST for the following URL Execute POST after putting the set value you want to change and the set value after change into the POST parameter http IP Address PrinterConfigurationPage SettingUrl format html xml json ini 1 IP Adress The IP address of the TM i whose set values to be acquired MO SettingUrl The URL of the set value to be changed A format Specifies the format of the response body to be returned by the
34. ternal clock of the TM i using an integer in the range 2012 2036 Month String Specifies the month of the internal clock of the TM i using an integer in the range 1 12 if Day String Specifies the day of the internal clock of the TM i using an integer in the range 1 31 Hour String Specifies the hour of the time of the internal clock of the TM i using an integer in the range 0 23 if if Minute String Specifies the minute of the time of the internal clock of the TM i using an integer in the range 0 59 UseTimeServer Specifies whether to enable or disable the clock alignment by the time server Enable Enable Disable Disable TimeServerSettingMethod Specifies the time server name acquisition method Auto Auto Manual Manual TimeServer String Specifies the time server name TimeZone String Specifies the time zone with a value that is 14 or higher to 12 or lower Password SettingUrl set_password cgi Changes the set password value NewPassword String Specifies a new password to be set using a single byte alphanumeric character string 0 zero character or more and 20 characters or less long 39 Resetting and Initializing the Settings SettingUrl set_reset cgi Resets the wired LAN wireless LAN and restores the factory default settings value Operation Reset Resets the wired LAN wireless LAN FactoryDefault Restores th
35. tion About this Manual Aim of the Manual The aim of this manual is to provide development engineers with the necessary 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 e TM T88V i e TM T70 i e TM L90 i Manual Content The manual is made up of the following sections Chapter 1 Overview Chapter 2 Response Body Format Chapter 3 Reference Chapter 4 Sample Program Contents o A 3 Key to SyMbOIS nd oda 3 E Restriction of UsSe lt lt ciciaairaia a cio 3 E About this Manual cccccoconcccccononcccncnanarinnn nana ronnnnananconononancnn nn anar nn non ana ran non anna nro nanaranananana 4 AM Ae MARA ii d 4 SA O O 4 MC ONTENIS A A O A A Ud O IEEE AE A AT 5 OVOIVIO Wena EEE A llos dd 7 E What is WebConfig API wiiivcsccccceccsssdccvscteaeeccaceencieeeasscteeennedsesssievesscceeseutteeeadecteeestebdsacieneeesses 7 FINO TI aria A A a ita iaa 8 Usable FO Mad Lao E erate cia O EA wid erect hate as be adas 8 IMP o a A a ens d 8 Contents in the Package oii secccccccietecccceccctleccceteenedencdtedetueeesscdeencteessedtoreessscedveuceeesedueeeercttes 9 DOWBlOA A macia da ac Gavan 9 MResiTiCIONS 5 PENET a a cintas idad 10 Response Body ROTOR a ccsrcicaniosrairaa loli orar oideciads 11 E Referring to the Set Values Of a TMoi oooocoooccccccnoncncnonncnonancnnnnnancnnnnnnnnnnnnnnnnnnnnrrnnnn e
36. tionStandard Specifies the communication standard 802 11b g 802 11b g 802 11b g n 802 11b g n AuthenticationMethod Specifies the authentication method Opensystem Opensystem SharedKey SharedKey WPAPSK WPAPSK WPA2PSK WPA2PSK EncryptionMethod Specifies the encryption method None No encryption WEP WEP TKIP TKIP AES AES Chapter 3 Reference value DefaultWEPkKey Specifies the WEP key to be used WEPKey1 WEP key 1 WEPKey2 WEP key 2 WEPKey3 WEP key 3 WEPKey4 WEP key 4 WEPKey1 String Specifies a value for WEP key 1 using one of the following strings e 10 digit hexadecimal number e 26 digit hexadecimal number e 5single byte alphanumeric characters Excluding spaces 13 single byte alphanumeric characters Excluding spaces WEPKey2 String Specifies a value for WEP key 2 using one of the following strings 10 digit hexadecimal number e 26 digit hexadecimal number e 5single byte alphanumeric characters Excluding spaces 13 single byte alphanumeric characters Excluding spaces WEPKey3 String Specifies a value for WEP key 3 using one of the following strings e 10 digit hexadecimal number e 26 digit hexadecimal number 5single byte alphanumeric characters Excluding spaces 13 single byte alphanumeric characters Excluding spaces WEPKey4 String Specifies a value for WEP key 4 using one of the following strings 10 digit hexadecimal number e 26 digit
37. uthenticationMethod parameter value InvalidAuthenticationMethod Correct the error When Adhoc is specified for the NetworkMode parameter WPAPSK WPA2PSK cannot be specified for AuthenticationMethod Correct the error InvalidAuthenticationMethodAdhoc Invalid EncryptionMethod parameter value InvalidEncryptionMethod A etian When Adhoc is specified for the NetworkMode parameter InvalidEncryptionMethodAdhoc TKIP AES cannot be specified for EncryptionMethod Correct the error 41 code InvalidEncryptionMethodOpensystem Action to Take When OpensSystem is specified for the AuthenticationMethod parameter TKIP AES cannot be specified for EncryptionMethod Correct the error InvalidEncryptionMethodWPAPSK When WPAPSK is specified for the AuthenticationMethod parameter None WEP cannot be specified for EncryptionMethod Correct the error InvalidDefaultWEPkKey nvalid DefaultWEPKey parameter value Correct the error InvalidWEPKey 1 nvalid WEPKey1 parameter value Correct the error InvalidWEPKey2 nvalid WEPKey2 parameter value Correct the error InvalidWEPKey3 nvalid WEPKey3 parameter value Correct the error InvalidWEPKey4 nvalid WEPKey4 parameter value Correct the error InvalidPresharedkKey nvalid PresharedKey parameter value Correct the error InvalidDevicelD nvalid DevicelD parameter value Correct the error
Download Pdf Manuals
Related Search