Home

TM-i Series WebConfig API User`s Manual

1. Operation settings SettingUrl set_epos_print_spooler cgi For changing the operation settings for the job spooler POST parameter Specifable value Use Specifies to whether to use spool function When this is set to Enable PHP will be disabled Enable Enable Disable Disable RetryInterval String Specifies a value from 1 to 60 for the communication retry interval RetryCount String Specifies a value from O to 60 for the number of communication retries 47 Forwarding message settings SettingUrl set_print_forwarding_message cgi Changing the forwarding message settings for the job spooler POST parameter Specifable value Messagestring String Specifies a character string of up to 255 bytes for the notification message printed during forwarding processing Bold Specifies to whether to enable or disable character decoration Bold If no setting is specified the current settings are used Enable Enable Disable Disable Underline Specifies to whether to enable or disable character decoration Underline If no setting is specified the current settings are used Enable Enable Disable Disable DoubleWidth Specifies to whether to enable or disable character decoration Double Width If no setting is specified the current settings are used Enable Enable Disable Disable
2. POST parameter Specifiable value Description Use Designates whether the status notification function is used Enable Enable Disable Disable ID String Designates an ID of no more than 30 alphanumeric characters underbars periods and hyphens Password String Designates a password of no more than 30 alphanumeric characters underbars periods and hyphens URL String Designates the status notification destination URL Interval String Designates a value seconds between 1 and 86400 for the standby time from the completion of acquisition of print data until acquisition of the next print data ServerAuthentication Designates whether to use server authentication If no setting is specified the current settings are used Enable Enable Disable Disable 53 Device Data Notification 2 This function is supported for TM i TM i firmware Ver 4 1 or later SettingUrl set_device_data_notification cgi Changes the settings for device data notification POST parameter Specifiable value Description Use Designates whether the device data notification is used Enable Enable Disable Disable ID String Designates an ID of no more than 30 alphanumeric characters underbars periods and hyphens Password String Designates a password of no more than 30 alphanumeric characters underbars periods and hyphens URL String Specifies the
3. 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 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 not a printer with any wireless LAN interface Check the interface of the TM printer InvalidAutoUpdate Invalid AutoUpdate parameter value Correct the error InvalidFrequency Invalid Frequency parameter value Correct the error Chapter 3 Reference InvalidTiming Invalid Timing parameter value Correct the error InvalidUpdateTimeHour Invalid UpdateTimeHour parameter value Correct the error InvalidTimeMinute Invalid UpdateTimeMinute parameter value Correct the error InvalidFileURL Invalid FileURL parameter value Correct the error InvalidUseProxy Invalid UseProxy parameter value Correct the error InvalidProxyURL Invalid ProxyURL parameter value Correct the error AccessToFileURLFailed Failed to access the URL specified for the FileURL parameter Check the network settings for the
4. Correct the error InvalidEncryptionMethodOpensystem 59 60 code InvalidEncryptionMethodWPAPSK Action to Take When WPAPSK is specified for the AuthenticationMethod parameter None WEP cannot be specified for EncryptionMethod Correct the error InvalidDefaultWEPKey Invalid DefaultWEPKey parameter value Correct the error InvalidWEPKey 1 Invalid WEPKey1 parameter value Correct the error InvalidWEPKey2 Invalid WEPKey2 parameter value Correct the error InvalidWEPKey3 Invalid WEPKey3 parameter value Correct the error Invalid WEPKey4 Invalid WEPKey4 parameter value Correct the error InvalidPresharedKey Invalid PresharedKey parameter value Correct the error InvalidDevicelD Invalid DevicelD parameter value Correct the error 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 RetryInterval parameter value Correct the error DevicelDNotRegistered The device specified for the DevicelD parameter cannot be deleted because it is not registered Specify an already registered ID InvalidMACAdaress Invalid MACAddress parameter value Correct the error InvalidHostName Invalid HostName parameter value Correct the error
5. Error Codes and Actions to Take Q on page 59 17 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 59 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 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 TCP IP SettingUrl config_tcpip_wired cgi Refers to the IP address etc of the wired LAN Category Key Value Description 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
6. 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 updates SettingUrl config_web_contents_storage cgi Refers to PHP settings Category Key Value Description WebContentsstorage microSDAvailable Refers to whether micro SD card is installed Enable Micro SD card is installed Disable Micro SD card is not installed FreeSpace String Refers to the micro SD card s free space in units of MB megabytes If micro SD card is not installed null characters will be shown PHP Refers to whether to enable or disable PHP Enable Enable Disable Disable WebContentsStorage Refers to the destination that the web contents will be stored to Printer Web contents will be stored to the printer itself microSD Web contents will be stored to the micro SD card 29 30 Server Direct Print SettingUrl config_server_direct_print cgi Refers to Server Direct Print setting values Category Key ServerDirectPrint Use Value Description Refers to whether Server Direct Print is used Enable Disable Enable Disable ID Password String String Refers to the ID Refers to the password URL String Refers to the acquisition destination URL for printed data Interval String Designates a value in second
7. When Frequency Hour an empty character is returned UpdateTimeMinute String Refers to the minute of the time of day to perform automatic update When Frequency Hour an empty character is returned File URL 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 LastUpdateMonth 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 LastUpdateSecond String Refers to the second of the time automatic update was performed last 28 Chapter 3 Reference Category Key Value Description WebContents ServerAuthentication Refers to whether server authentication is used If this authentication cannot be acquired the setting becomes Disable Enable Enable Disable Disable ID
8. 11 success 12 code 65 2 Click the GET button The response result from the TM i will be displayed in the Response body and in the value for each parameter GET Upload Web Contents Upload Certificate File ele ER AHHAR 8 co m response success true WiredNetwork DNSServerlPAddress2 DNSServerSettingMethod Manual Response body IPAddress 4 92 168 192 20 IPAddressSettingMethod Manual SubnetMask 255 255 255 0 APIPA Disable DNSServerlPAddress1 DNSServerlPAddress3 Gateway 192 168 192 1 WiredNetwork J o O IDNSServerlPAddress2_ DNSServerSettingMethod Manual lPAdcressSetingHetiod wana 2222222 Subnetilask 256 2552560 O UOO APIPA Disable IDNSServerlPAddresst DNSServerlPAddress3 192 168 192 1 Chapter 4 Sample Program Edit the cgi data acquired from the TM i and register it to the TM i Rewrite the settings you want to change then click SET When you click SET the changed data will be registered to the TM i The edited content will be displayed inside the cells Z 8 GET SET Upload Web Contents Upload Certificate File HTTP status code response success true WiredNetwork DNSServerlPAddress2 DNSServerSettingMethod Manual IPAd
9. 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 For TM i firmware Ver 4 x or later use the following URL http IP Address webconfig Setting Url format html xml json ini 1 IP Address The IP address of the TM i whose set values to be acquired T SettingUrl The URL of the set value to be changed 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 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 e For SettingUrl and values refer to Chapter 3 Reference To use WebConfig API from XmlHttoRequest in Javascri
10. Devices local_display Key Value Description Baudrate Refers to the communication speed 2400 2400 bps 4800 4800 bps 9600 9600 bps 19200 19200 bps 38400 38400 bps 57600 57600 bps 115200 115200 bps Databit Refers to the data bit 7 7 bits 8 8 bits Parity Refers to the parity None None Even Even Odd Odd Brightness Refers to the brightness 100 100 60 60 40 40 20 20 Use Refers to whether customer displays are used Enable Enable Disable Disable SettingUrl config_epos_key_input_device cgi References the device ID and device information for all key input devices that are registered Category Example Key Devices local_keyboard Devices Device ID of key input device Value Description DeviceName String Refers to the device name VID String Refers to vendor ID 4 digit hexadecimal value PID String Refers to product ID 4 digit hexadecimal value ControlScript String Refers to file name of a control script to be used 22 Chapter 3 Reference SettingUrl config_epos_serial cgi Refers to the communication settings of registered serial communication devices If the TM i specifications do not include a serial port this does not refer Category Key Value Description Devices Serial Communication Device
11. DoubleHeight Specifies to whether to enable or disable character decoration Double Height If no setting is specified the current settings are used Enable Enable Disable Disable Reverse Specifies to whether to enable or disable character decoration Reverse black and white If no setting is specified the current settings are used Enable Enable Disable Disable UpsideDown Specifies to whether to enable or disable character decoration Upside Down If no setting is specified the current settings are used Enable En Disable Disable Position Specifies the position where the notification message is printed If no setting is specified the current settings are used Top Before the print data Bottom After the print data Cut Specifies whether the paper is to be cut after the notification message is printed If no setting is specified the current settings are used Enable Enable Disable Disable 48 Chapter 3 Reference Addition of print forwarding routes SettingUrl add_print_forwarding_route cgi Adds print forwarding routes for the job spooler POST parameter Specifable value DevicelD String Specifies the printers for which forwarding routes will be set in the format Devices printer device IDs For each printer s device ID specify a string of from 1 to 30 alphanumeric characters which can include one or more underscores periods and or hyphens Any device IDs that are already registered will be ove
12. Name epson 6 Password H 8 GET SET Upload Web Contents Upload Certificate File 10 response 11 success 12 code 13 14 15 Resnonse bodv 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 Response body 70
13. 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 A Setting is possible under the following conditions e 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 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 and spaces 1 character or more to 32 characters or less long 45 POST parameter Specifiable value Description AdhocChannel String Specifies the ad hoc channel using an integer in the range l 11 CommunicationStandard Specifies the communication standard 802 116 802 11b 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 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 Specifi
14. TM i and for the server AccessToProxyURLFailed Failed to access the proxy URL specified for the ProxyURL parameter Check the network settings for the TM i and for the server NotEnoughFreeSpace 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 FileURLNotZip The Web contents downloaded from the URL specified for FileURL 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 InvalidUse Invalid Use parameter value Correct the error InvalidID Invalid ID parameter value Correct the error 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 IDNeededToSetPassword specified for the ID parameter Set a value for the ID parameter InvalidURL Invalid URL parameter value Correct the error Invalidinterval Invalid Interval parameter value Correct the error InvalidUseProxyDeviceDataNotification Invalid UseProxyDeviceDataNotification parameter value Corr
15. 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 XmlHttoRequest 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 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 Net
16. digit hexadecimal number e 5single byte alphanumeric characters and spaces e 13single byte alphanumeric characters and 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 and spaces e 13single byte alphanumeric characters and 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 and spaces e 13single byte alphanumeric characters and spaces PresharedKey String Specifies the pre shared key using one of the following strings e 8ormore to 63 or less single byte alphanumeric characters and spaces e 64 digit hexadecimal number 39 40 TCP IP SettingUrl 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 D
17. the range 100 60000 1 TM i Firmware Ver 4 0 or later TM L90 i is not supported 2 TM i Firmware Ver 3 0 or later 3 TM i Firmware Ver 4 1 or later TM L90 i is not supported 41 Deleting a TM Printer SettingUrl delete_epos_print cgi Deletes a Device ID of the TM printer registered to TM i POST parameter Specifiable value Description 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 Setting a Customer Display SettingUrl set_epos_display cgi Changes the communication settings for customer display registered to TM i POST parameter Specifiable value Description Baudrate Specifies the communication speed 2400 2400 bps 4800 4800 bes 9600 9600 bes 19200 19200 bps 38400 38400 bps 57600 57600 bps 115200 115200 bps Databit Specifies the data bit 7 7 bits 8 bits Parity Specifies the parity None None Even Even Odd Odd Brightness Specifies the brightness 100 100 60 60 40 40 20 20 Use Refers to whether customer displays are used Enable Enable Disable Disable Chapter 3 Reference Adding a key input device SettingUrl set_epos_key_input_device cgi Changes the device information for key input devices refistered to TV i POST parameter Specifiable valu
18. 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 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 SSID String Refers to the SSID AdhocChannel String Refers to the AdhocChannel Chapter 3 Reference Category Key Value Description NetworkPrinter n 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 WEPKeyl WePkeyl WEPKey2 WEP key 2 WEPKey3 WEP key 3 WEPKey4 WEP key 4 Q This function is supported for TM i TM i firmw
19. 00 9600 bps 19200 19200 bps 38400 38400 bps 57600 57600 bps 115200 115200 bps Databit Specifies the data bit 7 bits 8 bits Parity Specifies the parity None None Even Even Odd Odd Stopbit Specifies the stop bit 1 bit 1 5 1 5 bit 2 2 bit FlowControl Specifies the flow control XOnXOff XONXOff Hardware Hardware None None Chapter3 Reference Setting a TM printer General SettingUrl set_device_tcpip cgi Changes the network settings for a TM printer connected to the TM i A Setting is possible under the following conditions e 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 e A TMi printer and wireless LAN interface with a USB connector of a TM printer are connected by USB UB RO3 Specifiable POST parameter Description value MACAdaress String Specifies the MAC adaress HostName String Specifies the IP adaress 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 Password String Specifies a new password to be set using a single byte alphanumeric character string
20. EPSON 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 M00052306 Rev G 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 o
21. 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 57 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 O 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 Specifable value Operation Reset Resets the wired LAN wireless LAN FactoryDefault Restores the 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 Correct the error Invalid IPAddressSettingMethod parameter value Correct the error InvalidLinkSpeed InvalidlPAddressSettingMethod Invalid APIPA parameter value InvalidAPIPA Correct the error Invalid IPAddress parameter value val
22. Message String References the character string in the notification message Bold Refers to whether to enable or disable character decoration Bold If this setting cannot be acquired the setting becomes Disable Enable Enable Disable Disable Underline Refers to whether to enable or disable character decoration Underline If this setting cannot be acquired the setting becomes Disable Enable Enable Disable Disable Chapter 3 Reference Category Key Value Description DeviceData DoubleWidth Refers to whether to enable or disable Notification character decoration Double Width If this setting cannot be acquired the setting becomes Disable Enable Enable Disable Disable DoubleHeight Refers to whether to enable or disable character decoration Double Height If this setting cannot be acquired the setting becomes Disable Enable Enable Disable Disable Reverse Refers to whether to enable or disable character decoration Reverse black and white If this setting cannot be acquired the setting becomes Disable Enable Enable Disable Disable UpsideDown Refers to whether to enable or disable character decoration Upside Down If this setting cannot be acquired the setting becomes Disable Enable Enable Disable Disable Cut References whether the paper is to be cut after the notification message is print
23. NSServerlPAdaress1 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 TM Printer SettingUrl set_epos_print cgi References the device ID of a new TM printer N Refer to the Technical Reference Guide for each printers that can be designated POST param Specifiable Description eter 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 Model Specifies the device model TM T88V TM T88V TM T88V i TM i Firmware Ver 4 0 or later n TM T88IV TM T88IV TM T70 TM T70 TM T70 i TM i Firmware Ver 4 0 or later TM T70 Simplified Chinese model 2 TM T70II TM T70Il TM T70ll Korea model TM T90 TM T90 TM L90 TM L90 TM L90 Traditional Chinese model South Asia model Simplified Chinese model Korea model 2 TM 120 TM T20 TM T2011 2 TM T20I TM T20ll i TM T8211 TM T8211 TM T8211 TM T83il TM T83ll TM T83ll i TM P60l 2 TM P6OII TM P80 TM P80 TM P20 3 TM P20 TM U220 TM U220 IPAddress String Specifies the IP adaress Retrylnterval String Specifies the communication retry interval using a numeric value in milliseconds in
24. 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 19 Wireless LAN General SettingUrl config_general_wireless cgi Refers to the SSID etc of the wireless LAN Category WiredLinkLayer Key Value Description NetworkMode Refers 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 Refers to the authentication method Opensystem Opensystem SharedKey SharedKey WPAPSK WPAPSK WPA2PSK WPA2PSK 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 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 20 Chapter 3 Reference TCP IP SettingUrl config_tcpip_wir
25. Technical Reference Guide Sample Program WebConfigAPlSample_Verx xx zip For customers in North America go to the following web site httpo 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 11 Web contents zip file and a certificate cannot be manually uploaded by using WebConfig API 1 To enable manual uploading of Web contents zip file and a certificate 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 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 For TM i firmware Ver 4 x or later use the following URL http IP Address webcontig SettingUrl format html xml json ini 1 IP Address The IP address of the TM i whose set values to be acquired d SettingUrl The URL of the set values to be acquired A format Specifies the format of the response
26. URL that the device data is to be notified to ServerAuthentication Designates whether to use server authentication Enable Enable Disable Disable BoxID String For the BoxID for the communication box specify a string of up to 30 alphanumeric characters which can include one or more underscores periods and or hyphens PrintError Specifies whether a notification message is to be printed when a device data notification error OCCUIS Enable Enable Disable Disable ErrorMessage String Specifies a character string of up to 255 bytes for the notification message Bold Specifies to whether to enable or disable character decoration Bola Enable Enable Disable Disable Underline Specifies to whether to enable or disable character decoration Underline Enable Enable Disable Disable DoubleWidth Specifies to whether to enable or disable character decoration Double Width Enable Enable Disable Disable Chapter 3 Reference POST parameter Specifiable value Description DoubleHeight Specifies to whether to enable or disable character decoration Double Height Enable Enable Disable Disable Reverse Specifies to whether to enable or disable character decoration Reverse black and white Enable Enable Disable Disable UpsideDown Specifies to whether to enable or disable character decoration Upside Down Enable Enabl
27. Wireless LAN Router 192 168 192 1 192 168 192 20 1 Wireless LAN Router 1 TM i 1 set TM T88V i TM T70 i TM L90 i TM T20II i TM T821I i TM T83II i 1 Computer to configure the settings Computer in which Microsoft Office Excel 2003 Excel2003 or later and Microsoft Internet Explorer 7 or later are installed 64 Chapter 4 Sample Program Basic Usage of the Sample Program This sample program must be used with macro enabled This program acquires a single set of cgi data once only lt cannot acquire or set multiple cgi data sets Below is explained how to use the program to acquire data from a TM i edit the data and register it on the TM i Enter information on the TM i from which WebConfig data is to be acquired and enter the cgi to be acquired Item Description IP Address Enter the TM i s IP address CGI Name Select the name of the cgi to be acquired from the list Format Select the format of the data to be acquired from the list User Name Enter the user name for the TM i s EPSON TMNet WebContfig epson is fixed Password The password for the TM i s EPSON TMNet WebConfig This will be blank if no password has been specified Specification of a password is not required in the initial settings 192168 192 20 PrinterConfigurationPage config _general_wired cgi set_general_wired cgi GET SEN Upload Web Contents Upload Certificate File 10 response
28. ar here Web Contents Updater SettingUrl config_web_contents_updater cgi Refers to the Web contents update setting Category Key Value Description WebContents 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 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 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 27 Category WebContents Key Value Description When Frequency Weekly Sunday Updates every Sunday 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 Frequency Monthly String Refers to the day to perform automatic update UpdateTimeHour String Refers to the hour of the time of day to perform automatic update
29. are Ver 4 1 or later Operation settings SettingUrl config_epos_print_spooler cgi References the operation settings for the job spooler Category Key Value Description PrintSpooler Use Refers to whether to enable or disable spooler If this setting cannot be acquired the setting becomes Disable Enable Enable Disable Disable Retrylnterval String Refers a value in seconds for the retry interval of communication RetryCount String Refers to retry count of communication 25 26 Forwarding settings SettingUrl config_print_forwarding cgi References the print forwarding settings for the job spooler Category PrintForwarding Message String Description References the character string in the notification message printed during forwarding processing Bold Refers to whether to enable or disable character decoration Bold If this setting cannot be acquired the setting becomes Disable Enable Enable Disable Disable Underline DoubleWidth DoubleHeight Reverse Refers to whether to enable or disable character decoration Underline If this setting cannot be acquired the setting becomes Disable Enable Enable Disable Enable Disable Refers to whether to enable or disable character decoration Double Width If this setting cannot be acquired the setting becomes Disable Enable Di
30. d of no more than 30 alphanumeric characters underbars periods and hyphens URL String Designates the acquisition destination URL for print data If URL1 is specified this parameter is ignored Interval String Designates a value seconds between 1 and 86400 for the standby time from the completion of acquisition of print data until acquisition of the next print data URLI String Designates the acquisition destination URL for print data Intervall String Designates a value seconds between 1 and 86400 for the standby time from the completion of acquisition of print data until acquisition of the next print data URL2 String Designates the acquisition destination URL for print data Interval2 String Designates a value seconds between 1 and 86400 for the standby time from the completion of acquisition of print data until acquisition of the next print data URL3 String Designates the acquisition destination URL for print data Interval3 String Designates a value seconds between 1 and 86400 for the standby time from the completion of acquisition of print data until acquisition of the next print data ServerAuthentication Designates whether to use server authentication If no password is specified the current settings are used Enable Enable Disable Disable Chapter 3 Reference Status Notification SettingUrl set_status_notification cgi Changes the settings for status notifications
31. date 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 Frequency Weekly Sunday Updates every Sunday 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 Frequency Monthly String Specifies the date to perform automatic 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 O 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 UseProxy Specifies whether to use a p
32. dress 192 168 192 20 IPAddressSettingMethod Manual SubnetMask 255 255 255 0 APIPA Disable DNSServerlPAddress1 DNSServerlPAddress3 Gateway 192 168 192 1 WiredNetwork DNSServerlPAddress2 DNSServerSettingMethod Manual 192 168 192 20 DNSServerlPAddress1 DNSServeriPAddress3 192 168 192 1 By selecting config_epos_print cgi and set_epos_print cgi and then clicking GET you can Q acquire all the registered device values However values for only 1 device can be registered SET at a time To register the setting values for multiple devices set the values for each device individually 67 68 4 The results of the setting value changes will be displayed Result Indication Success TRUE will be displayed at success Failure FALSE will be displayed at success The reason will be displayed at reason The following screen shows the case in which the IP address failed to be set 15 16 ei 18 19 20 21 22 GET SET Upload Web Contents Upload Certificate File FALSE InvalidiPAddress success false code InvalidlPAddress HTTP status code WirelessNetwork DNSServerlPAddress2 DNSServerSettingMethod Manual 192 168 255 255 Chapter 4 Sample Program Uploading Web Contents The program can be used to upload web co
33. e Description DevicelD String Designates a device ID of 1 to 30 alphanumeric characters underbars periods and hyphens local_printer local_display and local_serial cannot be designated Designate IDs that are not the same as those used for registered printers and registered key input devices DeviceName String Specifies the device name VID String Designates a vendor ID 4 digit hexadecimal value PID String Designates a product ID 4 digit hexadecimal value ControlScript String Designates the file name of the control script to be used Deleting a key input device SettingUrl delete_epos_key_input_device cgi Deletes the Device ID of the key input device registered to TM i POST parameter Specifiable value Description DevicelD String Designates a device ID of 1 to 30 alphanumeric characters underbars periods and hyphens 43 Setting a Serial Communication Device SettingUrl set_epos_serial cgi Changes the communication settings of the serial communication device and device ID sets to local_serilal If the TM i specifications include no serial ports this setting is disabled POST parameter Specifiable value Description Use Designates whether to use a serial communication device Enable Enable Disable Disable Baudrate Specifies the communication speed 2400 2400 bps 4800 4800 bps 96
34. e Disable Disable Cut Specifies whether the paper is to be cut after the notification message is printed Enable Enable Disable Disable Devices device ID s of String Specify the device s for which device data device s notification is to be used in the format Devices device ID s of device s for which the notification is to be used In the case of more than one device specify all the IDs together here 55 Certificate SettingUrl delete_certificate cgi Deletes the specified certificate POST parameter Specifiable value Description FileDigest String Designates the MDS hash value for the certificate to be deleted SettingUrl set_proxy cgi Changes the proxy information POST parameter Specifiable value Description ProxyURL String Enter the proxy server URL and port number in the following http host name port number Example http 10 0 0 1 8008 ID String Designates an ID of no more than 30 alphanumeric characters underbars periods and hyphens Password String Designates a password of no more than 30 alphanumeric characters underbars periods and hyphens UseProxyServerDirectPrint Designates whether a proxy is used in Server Direct Print Enable Enable Disable z Disable S UseProxyStatusNotification Designates whether a proxy is used in status notifications Enable Enable Disable Disable UseProxyDeviceDa
35. ect the error InvalidServerAuthentication Invalid ServerAuthentication parameter value Correct the error InvalidBoxld Invalid Boxld parameter value Correct the error 61 62 InvalidPrintMessage Invalid PrintMessage parameter value Correct the error InvalidMessagestring Invalid MessageString parameter value Correct the error InvalidTextAttributes Invalid TextAttributes parameter value Correct the error InvalidCut Invalid Cut parameter value Correct the error InvalidPosition Invalid Position parameter value Correct the error InvalidCandidatel Invalid Candidatel parameter value Correct the error InvalidCandidate2 Invalid Candidate2 parameter value Correct the error InvalidRetryCount Invalid RetryCount parameter value Correct the error SameDevicelD The same device ID has been specified for DevicelD and or Candidate and or Candidate2 Specify a separate device ID for each item nvalidAdministrator Invalid Administrator parameter value Correct the error nvalidLocation Invalid Location parameter value Correct the error Invalid Year parameter value lane Correct the error nvalidMonth Invalid Month parameter value Correct the error i Invalid Day parameter value Ian Correct the error IES Invalid Hour parameter value Correct the error nvalidMinute Invalid Minute parame
36. ed If this setting cannot be acquired the setting becomes Disable Enable Enable Disable Disable Devices Registered Device ID Returns all the device IDs registered Example Devices local_scanner Enable Use device data notification Disable Not use device data notification 33 Certificates SettingUrl listup_ certificates cgi Refers to a list of all certificates installed in TM i Category Key Value Description Certificate X 1 lt X ValidFromYear String Refers to valid period start year ValidFromMonth String Refers to valid period start month ValidFromDay String Refers to valid period start day ValidFromHour String Refers to valid period start hour ValidFromMinute String Refers to valid period start minute ValidFromSecond String Refers to valid period start second ValidUntilYear String Refers to valid period end year ValidUntilMonth String Refers to valid period end month ValidUntilDay String Refers to valid period end day ValidUntilHour String Refers to valid period end hour ValidUntilMinute String Refers to valid period end minute ValidUntilsecond String Refers to valid period end second FileDigest String Refers to the hash value of the certificate issuer String Refers to the person who issued the certificate issuedTo String Refers to the issue destination for the ce
37. eeesseaeeseeeeseeeeneees 10 DOWNIGOG orinar soiled dra said ee peat ais ayant teases 10 E RESIICTIONS risa 10 Response Body Format eiii ori 11 E Referring to the Set Values Of a TMci ooooooccccnnicccnnccccnnonnccnnnnccnnnnnnnnnnnnnn naar nn nnnnnnnnnnnrn nan 11 AMO Ma red pcia neds 12 ISON TOMA Bi la o 13 II A A Tas 14 E Changing the Set Values Of a TM ni cescccecscceeeeeeeeeeeeeeeeeeeeeeeeeeeeseseeseeseeeeseeaeeeeeneeeeeeneees 15 XMETO OT suisia naaa a ii 16 JSON leed id id 17 NOM do ed 18 ROI edad ae nnn 19 E Referring to Sef Values iis ennnen innne araara a eaaa i 19 Wired LAN caia a AA O NN on 19 Wireless LAN ia a 20 Deve Mat A ra 21 searching IM PINTER siii adds dont pas il 24 SDOOIET meai A AA A AE a a ee 25 Web Contents Update lio 27 Server Direct PA A Ao 30 Status NOHEA Orar aid ir td pola eos 31 Device Data NOTIiCOTION a A E T 32 SA E A henna anne Beaten a a bin eA italics 34 PIOX i A A and oni adi A ii lia ENTA 35 AdministratorGnd Loc iia art dad 35 MMS o DAY atan A DAA AA a i 36 POS WO italia a a id 36 E Changing the Set Values momias ri iia 37 COMMON AAA TS Te 37 Wired LAN Saano ne Ena ans aint cate AE aa SEE anda SERTA ria Tatna ET aAa D na A anias dae RTTA 37 Wireless LAN citan a E iia A ta E AATE a AATE 38 Adding A TM PriNt Ol tis a a a da ATRE AA 41 Deleting a IM Pta e lA SUA Gd 42 Sefing a CUSTOMER DISDIOY cil 42 Adding a key INDUFASVICS iii ii A A ania E N E manic 43 Deleting a key
38. eless cgi Refers to the IP address etc of the wireless LAN Category Key Value Description 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 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 Device SettingUrl config_epos_print cgi Refers to the Device ID and device information of registered device Category Key Value Description Devices DevicelD Refers to the device ID by turning it into the string Devices Device ID As many values 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 RetryInterval String Refers to the communication retry interval in milliseconas 21 SettingUrl config_epos_display cgi Refers to communication settings for customer displays Category
39. es You can use it by including it in your application This function can be used in the TM i 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 With TM printer models used with Ethernet being able to set the IP address and other network settings via the network makes for more efficient setting work TM i firmware Ver 3 x or later e Do not use the WebConfig API if you are directly setting or referring to the EPSON Q TMNet WebConfig settings of TM i from a browser on a computer e The WebConfig API cannot be used to set or reference the memory switches customized values of a TM i or TM printer e For the functions of EPSON TMNet WebConfig refer to the detailed manual for each printer Network Settings Referring Setting gt TM i TM Printer Application for setting Wireless LAN Interface referring to WebConfig Ethernet USB connection Ezy T Allows getting setting setting values of the EPSON TMNet WebConfig of TM i from HTTP supported devices Not OS dependent AU Allows an application to refer to the set values of the EPSON TMNet WebConfig of TM printer using the GET method hereafter GET defined in HTTP Hy
40. es 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 and spaces e 13 single byte alphanumeric characters and spaces WEPKey2 String Specifies a value for WEP key 2 using one of the following strings e 10 digit hexadecimal number e 26 digit hexadecimal number e 5single byte alphanumeric characters and spaces e 13 single byte alphanumeric characters and 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 and spaces e 13 single byte alphanumeric characters and spaces 46 Chapter 3 Reference POST parameter Specifiable value Description 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 and spaces e 13 single byte alphanumeric characters and 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 and 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 2 This function is supported for TM i TM i firmware Ver 4 1 or later
41. idos Correct the error Invalid SubnetMask parameter value vao SA el Mioek Correct the error Invalid Gateway parameter value Correct the error Invalid DNSServerSettingMethod parameter value Correct the error InvalidGateway InvalidDNSServerSettingMethod Invalid value for any of the parameters DNSServerlPAddress1 InvalidDNSServerlPAddress to DNSServerlPAddress3 Correct the error Invalid NetworkMode parameter value Correct the error InvalidNetworkMode Invalid SSID parameter value InvalidSSID Correct the error Invalid AdhocChannel parameter value InvalidAdhocChannel ar Invalid CommunicationStandard parameter value InvalidCommunicationStandard Check the values for the communication standard supported by the printer to correct the value Invalid AuthenticationMethod parameter value Correct the error InvalidAuthenticationMethod When Adhoc is specified for the NetworkMode parameter WPAPSK WPA2PSK cannot be specified for AuthenticationMethod Correct the error InvalidAuthenticationMethodAdhoc Invalid EncryptionMethod parameter value InvalidEncryptionMethod Coreei he ciron When Adhoc is specified for the NetworkMode parameter InvalidEncryptionMethodAdhoc TKIP AES cannot be specified for EncryptionMethod Correct the error When OpenSystem is specified for the AuthenticationMethod parameter TKIP AES cannot be specified for EncryptionMethod
42. input AEV CE LE EE rro rr ren rra rr rre rn 43 Setting a Serial COMMUNICATION DEVICE Lo Ee rr rr 44 SETA LM At sae 45 SPA iia Dd O a a a Teen A ii 47 Web Contents UDCOTEr or EE EE rrr eerie 50 Automatic UbdOTe sniadania A A A Niece ala adden a 5 Server Di Pla cagsslagsevdsadedaieseagis thagetceueiensaanehagautendietgy sees 52 Status NOTICIA A T AE oceanic aimee 53 Device Data NotifiCOtion Eee eee creer nanan ines 54 CORINCOTS a tater doit elaiea A cat ieee detente aaa dat 56 AN ated AEA tanta A T aebaucncanes tant a A 56 Administrator Na doc viii aaa conc wanted ana ide 57 MA o antes castles tanta esti toate EA T E A ee naaans eeceatad 57 PASS WO A A a a ee Bl Gd ag ea A 58 Resetting and Initializing the Settings oe ee rr 58 E Error Codes and Actions to Take cccccccessseecceeesseeeeeeeeesseneeeeeeeesseeeeeeeeensseeeeeeeenseeeaeeeens 59 Sample PEO cri ins 63 MSc iii iia Do aaa vanity 63 E Operating EnvironMeNt a rri rar aa s paame nar a Aae ae cnn nan a eenia PN ewean Se Eee eiaa Sapiani ain 64 E Basic Usage of the Sample Progr aM coooocccnncccncnnccccnnnnncnnnnnncnnnnnnnnnnnncnnnnnnn nan nnrnnnnannnnnnnes 65 E Uploading Web Contents oiicsiiaiconcosicaranccccis ea ora aap a Riiie since 69 E Uploading Certificate lt lt mommmirmiiaanacaa rd 70 Chapter Overview Overview What is WebConfig API WebConfig API is an API for setting and referencing the EPSON TMNet WebConfig of the TM i seri
43. l set_general_wireless cgi Changes the SSID etc of the wireless LAN POST parameter speciiable Description 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 and spaces 1 character or more to 32 characters or less long AdhocChannel String Specifies the ad hoc channel using an integer in the range 1 11 CommunicationStandard Specifies the communication standard 802 11b g 802 11b g 802 11b g n 802 11b g n Chapter 3 Reference Specifiable value AuthenticationMethod Specifies the authentication method POST parameter Description Opensystem Opensystem SharedKey SharedKey WPAPSK WPAPSK WPA2PSK WPA2PSK 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 e 10 digit hexadecimal number e 26 digit hexadecimal number e 5single byte alphanumeric characters and spaces e 13single byte alphanumeric characters and spaces WEPKey2 String Specifies a value for WEP key 2 using one of the following strings e 10 digit hexadecimal number e 26
44. lD Example Devices local_serial Use Refers to whether a serial communication device is used Enable Enable Disable Disable Baudrate Refers to the communication speed 2400 2400 bps 4800 4800 bps 9600 9600 bps 19200 19200 bps 38400 38400 bps 57600 57600 bps 115200 115200 bps Databit Refers to the data bit 7 7 bits 8 8 bits Parity Refers to the parity None None Even Even Odd Odd Stopbit Refers to the stop bit 1 1 bit 1 5 1 5 bit 2 2 bit FlowControl Refers to the flow control XOnXOff XOnXOff Hardware Hardware None None 23 24 Searching TM printers SettingUrl search_devices cgi Refers to the settings of TM printers connected to the TM i Generates a NetworkPrinter n category for each printer detected enabling referencing of the network settings for those printers 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 Referencing is possible under the following conditions Category Key Value Description 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
45. mask 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 1 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 hs WiredNetwork PAddressSettingMethod 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 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 168 192 168 Netmask 255 255 255 0 Gateway
46. ntent or style sheets for registration on the TM i See the TM i s Technical Reference Guide for the specifications of files that can be registered A Click the Upload Web Contents button IP Address 192 168 192 168 GET SET Upload Web Contents Upload Certificate File 11 success 12 eode ooo A E 13 14 15 Resnonse bodv 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 Response body The following screen shows the case in which the file has been successfully uploaded 13 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 FONT 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 lt CENTER gt 69 Uploading Certificate A Click the Upload Certificate File button B Cc 2 IP Address 3 config general wired cgi set general wired cgi 4 Format json 5 User
47. nth 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 alignment 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 Password SettingUrl config_password cgi Refers to the set password Category Description Password PasswordMD5 String Refers to the string created from the password string through MD5 encryption Changing the Set Values Common Chapter 3 Reference 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 thei
48. o the password URL String Refers to the notification destination URL for status Interval String Refers to the standby time in seconds from the completion of a status notification until the next notification is sent ServerAuthentication Refers to whether server authentication is used If this authentication cannot be acquired the setting becomes Disable Enable Enable Disable Disable 31 Device Data Notification 2 This function is supported for TM i TM i firmware Ver 4 1 or later SettingUrl config_device_data_notification cgi References the notification settings for device data Category Key Value Description DeviceData Use Refers to whether Device Data Notification Notification is used Enable Enable Disable Disable ID String Refers to the ID Password String Refers to the password URL String Refers to the notification destination URL for notification ServerAuthentication Refers to whether server authentication is used If this authentication cannot be acquired the setting becomes Disable Enable Enable Disable Disable Box ID String Refers to the Box ID of the communication box PrintError References whether a notification message is to be printed when a device data notification error occurs If this settings cannot be acquired the setting becomes Disable Enable Enable Disable Disable Error
49. perText Transfer Protocol UA Allows an application to change the set values of the EPSON TMNet WebConfig of TM printer using the POST method hereafter POST defined in HTTP HyperText Transfer Protocol 1 The sample program is equipped with the following functions e Referencing and setting of the EPSON TMNet WebContfig for a TM i using the WebConfig API e Registration of web content to a TM i using HTTP functions e Registration of certificates to a TM i using HTTP functions 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 Chapter Overview Supported printers TM i refers to EpsonNet WebConfig setting values These values can be changed A TM T188V i O TM T70 i A TM T20ll i A TM T82Il i 1 TM T18311 1 TM L90 i TM Printer The TM printer refers to network setting values These values can be changed Available TM printers are different depending on the version of the TM i firmware installed in the product For details refer to the Technical Reference Guide for each printer lo Contents in the Package Manual 4 TM i WebConfig API User s Manual This Document 1 TM T88V i Technical Reference Guide 1 TM T70 i Technical Reference Guide 1 TM T20ll i Technical Reference Guide 1 TM T82ll i Technical Reference Guide 1 TM T83ll i Technical Reference Guide 1 TM L90 i
50. pt register the Web page where the JavaScript code is written to the TM i as Web contents 15 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 59 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 When response fails response success false code InvalidlPAddress For details on an error code when response fails see
51. r problems arising from the use of any options or any consumable products other than those designated as Original EPSON Products or EPSON Approved Products by Seiko Epson Corporation Trademarks EPSON is a registered trademark of Seiko Epson Corporation Exceed Your Vision is registered trademark or trademark of Seiko Epson Corporation Microsoft Visual Basic Windows Excel and Internet Explorer are either registered trademarks or trade marks of Microsoft Corporation in the United States and other countries O Seiko Epson Corporation 2012 2014 All rights reserved 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 avoid damage to your equipment or NM a 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 design to maintain safety and total system reliability Because this product was not intended for use in applications requiring extremely high reliability
52. r values acquired by referring to the settings There is no API for uploading web content or certificate files but the sample program includes Q functions for uploading files using HTTP Wired LAN General SettingUrl set_general_wired cgi Changes the link soeed of the wired LAN POST parameter LinkSpeed Specifiable value Description Specifies the link soeed 10BaseTHalf 10BaseT half duplex 10BaseTFull 10BaseT full duplex 100BaseTHalf 100BaseT half duplex 100BaseTFuill 100BaseT full duplex AutoNegotiation Auto negotiation 38 TCP IP SettingUrl set_tcpip_wired cgi Changes the IP address etc of the wired 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 setting method 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 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 Wireless LAN General SettingUr
53. roxy server at the time of automatic update Enable Enable Disable Disable ProxyURL String Specifies the URL of the proxy server Chapter 3 Reference POST parameter PAR EMABIe Description value ID String Designates the ID that identifies TM i on the web server side This is the user ID used for digest authentication Password String Designates the password used for Digest authentication ServerAuthentication Designates whether to use server authentication If no password is specified the current settings are used Enable Enable Disable Disable SettingUrl set_web_contents_storage cgi Changes the PHP setting POST parameter Description Specifiable value PHP Specify the Enable Disable PHP When this is set to Enable Spooler will be disabled Enable Enable Disable Disable Automatic Update SettingUr execute_web_contents_updater cgi Forcibly perform automatic update of the Web contents No parameter to be set 51 Server Direct Print SettingUrl set_server_direct_print cgi Changes the Server Direct Print settings POST parameter specitcble Description value Use Designates whether to use Server Direct Print Enable Enable Disable Disable ID String Designates an ID of no more than 30 alphanumeric characters underbars periods and hyphens Password String Designates a passwor
54. rtificate Chapter 3 Reference 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 Refers to whether a proxy is used for Server Direct Print Enable Enable Disable Disable UseProxyStatusNotification Refers to whether a proxy is used in status notifications Enable Enable Disable Disable UseProxyDeviceDataNotification Refers to whether a proxy is used in device data notifications Enable Enable Disable Disable UseProxyWebContentsUpdate Refers to whether a proxy is used for automatic updating of web content Enable Enable Disable Disable ProxyURL Sting Referstothe proxy UR Administrator and Location SettingUrl config_administrator cgi Refers to the administrator information Category Description General Administrator String Refers to the string that designates the administrator Location String Refers to the string that designates the location 35 36 Time of Day SettingUrl config_time cgi Refers to the time of day setting Category Key Value Description Time Year String Refers to the year of the internal clock of the TM i Month String Refers to the mo
55. rwritten Candidate String For the device ID of a candidate forwarding route printer specify a string of from 1 to 30 alphanumeric characters which can include one or more underscores periods and or hyphens For this you cannot use a device ID that you specified for the DevicelD item above Candidate2 String For the device ID of another candidate forwarding route printer specify a string of from 1 to 30 alohanumeric characters which can include one or more underscores periods and or hyphens For this you cannot use a device ID that you specified for the DevicelD item or Candidate1 item above If you do not specify a device ID for this only one forwarding candidate will be set Deletion of print forwarding route SettingUrl delete_print_forwarding_route cgi Deletes a registered print forwarding route POST parameter Specifable value DevicelD String Specifies the printer for which the forwarding route will be deleted in the format Devices printer device ID For the printer s device ID specify a string of from 1 to 30 alphanumeric characters which can include one or more underscores periods and or hyphens 49 50 Web Contents Updater SettingUrl set_web_contents_updater cgi Changes the Web contents update setting Specifiable POST parameter Description value AutoUpdate Specifies whether to automatically up
56. s for the standby time from the completion of acquisition of print data until acquisition of the next print data URLI String Refers to the acquisition destination URL for printed data Interval String Designates a value in seconds for the standby time from the completion of acquisition of print data until acquisition of the next print data URL2 String Refers to the acquisition destination URL for printed data Interval2 String Designates a value in seconds for the standby time from the completion of acquisition of print data until acquisition of the next print data URLS String Refers to the acquisition destination URL for printed data Interval3 String Designates a value in seconds for the standby time from the completion of acquisition of print data until acquisition of the next print data ServerAuthentication Refers to whether server authentication is used If this authentication cannot be acquired the setting becomes Disable Enable Enable Disable Disable 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 Refers to the ID Password String Refers t
57. sable Enable Disable Refers to whether to enable or disable character decoration Double Height If this setting cannot be acquired the setting becomes Disable Enable Disable Disable Refers to whether to enable or disable character decoration Reverse black and white If this setting cannot be acquired the setting becomes Disable Enable Enable Disable Disable UpsideDown Refers to whether to enable or disable character decoration Upside Down If this setting cannot be acquired the setting becomes Disable Enable Enable Disable Disable Position References the position where the notification message is printed If this setting cannot be acquired the setting becomes Top Top Before the print data Bottom After the print data Chapter 3 Reference Category Key Value Description PrintForwarding Cut References whether the paper is to be cut after the notification message is printed If this setting cannot be acquired the setting becomes Disable Enable Enable Disable Disable Devices Device IDs of candidate printers Example Devices local_printer Candidatel String References the device ID of the candidate printers for forwarding Candidate2 String References the device ID of the candidate printers for forwarding If only one candidate printer has been set null characters will appe
58. 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 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 20ll i e TM T82ll i e TM T83Il 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 BE FOr Sate y siete asec See ee esas A AEs eee See eee AN ON See 3 Key TOS YMDOIS vs cara ae es re A A i AT AA Ata 3 ME Restriction Of USE cion ic di dic din 3 E About Mis Manual circa ie 4 Aim ofthe Manual it A ad Ro eae AAA A 4 Manual Contrario E E r Aca dede cio yes 4 MC iii ii tenes iis dev etext 5 OVGEIVIOW asia l 7 E What is WebConfig API ii ooocicinia cion ii 7 FUNCTIONS ias A E O A dena hans N aerate 8 BALA A A tienes AA ramy wtagags ates T TAA 8 E Supported printers id 9 Mi A daira aie ines Mabie a ahi Hei a hail eins 9 TM PiN Ehet A Ai 9 E Contents in the PACK C cccccccceceeeeeeseeeeeeeeeeeeeneeeeeeaaeeeeeeeeeseaeeesesaesseeee
59. taNotification Designates whether a proxy is used in device data notifications Enable Enable Disable Disable UseProxyWebContentsUpdate Designates whether a proxy is used in Web Contents Update Enable Enable Disable Disable gt d 56 Chapter 3 Reference Administrator and Location SettingUrl set_administrator cgi Changes the administrator information POST parameter EXE 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 Time of Day SettingUrl set_time cgi Changes the time of day setting value Year String Specifies the year of the internal 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 y Day String Specifies the day of the internal clock of the TM i using an integer in the range 1 31 E Hour String Specifies the hour of the time of the internal clock of the TM i using an integer in the range 0 23 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
60. ter value Correct the error nvalidTimeZone Invalid TimeZone parameter value Correct the error nvalidUseTimeServer Invalid UseTimeServer parameter value Correct the error nvalicTimeServerSettingMethod Invalid TimeServerSettingMethod parameter value Correct the error nvalidTimeServer Invalid TimeServer parameter value Correct the error nvalidDate Invalid Year Month Day parameter combination Correct the error nvalidTime Invalid Hour Minute parameter combination Correct the error nvalidNewPassword Invalid NewPassword parameter value Correct the error nvalidOperation Invalid Operation parameter value Correct the error Chapter 4 Sample Program sample Program This sample program is installed in VBA Visual Basic for Application and has the following functions e Referencing and setting of the EPSON TMNet WebConfig for a TM i using the WebConfig API e Registration of web content to a TM i using HTTP functions e Registration of certificates to a TM i using HTTP functions Screen The following screen appears when the sample program starts 63 Operating Environment 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

TM-i Series WebConfig API User`s Manual

Contents

Download Pdf Manuals

Related Search

Related Contents