Epson TM-T88V-i with VGA or COM User's Manual
TM-i Series
WebConfig API User's Manual
Describes an overview of WebConfig API.
Describes the response body format.
Describes how to refer to and change setting values.
Describes how to use the sample program.
M00052305
Rev.F
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 Epson Corporation.
Trademarks
EPSON and EXCEED YOUR VISION are registered trademarks of Seiko Epson Corporation in Japan and other countries/regions.
Microsoft
is either registered trademarks or trademarks of Microsoft Corporation in the United States and other countries.
© 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 a malfunction.
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 failsafes 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 evaluation.
3
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.
TM-T88V-i TM-T70-i TM-20II-i TM-T82II-i TM-L90-i
Manual Content
The manual is made up of the following sections:
Chapter 1
Chapter 2
Chapter 3
Chapter 4
4
Contents
Overview ........................................................................................7
Response Body Format ...............................................................11
5
6
Reference..................................................................................... 19
Sample Program .......................................................................... 55
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 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-R03 interface because wireless LAN settings can be performed by connecting a USB.
*: TM-i firmware Ver.3.x or later
TM-Printer
Wireless LAN interface
Wired LAN interface
1
Computer
to configure the settings
Wireless LAN interface
Wired LAN
Wireless LAN
USB
Device Control
TM-i
Do not use the WebConfig API if you are directly setting or referring to the TM-i's settings from a browser on a computer.
For the functions of EPSON TMNet WebConfig, refer to the detailed manual for each printer.
7
8
Function
❏ Allows getting/setting setting values of TM-i from HTTP-supported devices. Not OS-dependent.
❏ Allows an application to refer to the set values of a TM-i using the GET method (hereafter "GET") defined in
HTTP (HyperText Transfer Protocol).
❏ Allows an application to change the set values of a TM-i using the POST method (hereafter "POST") defined in HTTP (HyperText Transfer Protocol).
Usable Formats
❏ html :
❏ xml :
❏ json :
❏ ini :
HyperText Markup Language
Extensible Markup Language
JavaScript Object Notation
Text file format mainly used in a Windows OS environment
Chapter 1 Overview
Supported printers
TM-i
TM-i refers to EpsonNet WebConfig setting values. These values can be changed.
❏ TM-T88V-i
❏ TM-T70-i
❏ TM-T20II-i
❏ TM-T82II-i
❏ TM-L90-i
Confirming the TM-i firmware
You can confirm the TM-i firmware version by printing out a status sheet. With the printer ready for printing
(paper loaded and power on), press and hold the push button on the rear panel of this device for at least 3 seconds.
TM-i Firmware Ver.4.0 or later TM-i Firmware Ver.3.x or earlier
1
<General Information>
Firmware
X.XX
ePOS-Device
X.XX
Model
TM-T88V-i
“Firmware” (TM‐i Firmware Version) is printed under
<General Information>.
<General Information>
Software
X.XX
Model
TM-T88V-i
Time
yyyy-mm-dd hh:nn:ss
ʺSoftwareʺ (TM‐i Firmware Version) is printed under
<General Information>.
TM Printer
The TM printer refers to network setting values. These values can be changed.
❏ TM-T88V
❏ TM-T88IV
❏ TM-T70
❏ TM-T70II
❏ TM-T90
❏ TM-L90
❏ TM-P60II
❏ TM-T20
❏ TM-T82II
❏ TM-P80
❏ TM-U220
9
Contents in the Package
Manual
❏ TM-i WebConfig API User's Manual (This Document)
❏ TM-T88V-i Technical Reference Guide
❏ TM-T70-i Technical Reference Guide
❏ TM-T20II-i Technical Reference Guide
❏ TM-T82II-i Technical Reference Guide
❏ TM-L90-i Technical Reference Guide
Sample Program
WebConfigAPISample.xls
Download
For customers in North America, go to the following web site: http://www.epsonexpert.com/ and follow the on-screen instructions.
For customers in other countries, go to the following web site: https://download.epson-biz.com/?service=pos
Restrictions
❏ Web contents (zip file) and a certificate cannot be manually uploaded by using WebConfig API.
❏ To enable 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%/webconfig/%SettingUrl%?format=[html | xml | json | ini]
❏ IP Address
: The IP address of the TM-i whose set values to be acquired
❏ SettingUrl
: The URL of the set values to be acquired
❏ format
html
: Specifies the format of the response body to be returned by the TM-i
: HTML format (the same operation as the operation performed when viewing EPSON
TMNet WebConfig by using a browser)
2
ini
: ini format
• If a password is set for EPSON TMNet WebConfig/ WebConfig API, at the time of 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
<?xml version="1.0" encoding="UTF-8"?>
<epos-utility xmlns="http://www.epson-pos.com/schemas/2012/02/epos-utility">
<response success="true"/>
<%Category%>
<%Key1%>%Value1%</%Key1%>
<%Key2%>%Value1%</%Key2%>
<%Key3%>%Value1%</%Key3%>
.
.
</%Category%>
</epos-utility>
The above keys are in no particular order.
Response body (Example : config_tcpip_wired.cgi)
<?xml version="1.0" encoding="UTF-8"?>
<epos-utility xmlns="http://www.epson-pos.com/schemas/2012/02/epos-utility">
<response success="true" />
<WiredNetwork>
<IPAddressSettingMethod>Auto</IPAddressSettingMethod>
<APIPA>Enable</APIPA>
<IPAddress>192.168.192.168</IPAddress>
<Netmask>255.255.255.0</Netmask>
<Gateway>192.168.192.1</Gateway>
<DNSServerSettingMethod>Auto</DNSServerSettingMethod>
<DNSServerIPAddress1>192.168.192.1</DNSServerIPAddress1>
<DNSServerIPAddress2>192.168.192.1</DNSServerIPAddress2>
<DNSServerIPAddress3>192.168.192.1</DNSServerIPAddress3>
</WiredNetwork>
</epos-utility>
JSON format
{ "response" :
{
"success" : "true"
} ,
"%Category%" :
{
"%Key1%" : "%Value1%" ,
"%Key2%" : "%Value2%" ,
"%Key3%" : "%Value3%" ,
}
}
The above keys are in no particular order.
Response body (Example : config_tcpip_wired.cgi)
{ "response" :
{
"success" : "true"
} ,
"WiredNetwork" :
{
"IPAddressSettingMethod" : "Auto" ,
"APIPA" : "Enable" ,
"IPAddress" : "192.168.192.168" ,
"Netmask" : "255.255.255.0" ,
"Gateway" : "192.168.192.1" ,
"DNSServerSettingMethod" : "Auto" ,
"DNSServerIPAddress1" : "192.168.192.1" ,
"DNSServerIPAddress2" : "192.168.192.1" ,
"DNSServerIPAddress3" : "192.168.192.1"
}
}
Chapter 2 Response Body Format
2
13
14 ini format
[response] success="true"
[%Category%]
%Key1%="%Value1%"
%Key2%="%Value2%"
%Key3%="%Value3%"
.
.
The above keys are in no particular order.
Response body (Example : config_tcpip_wired.cgi)
[response] success="true"
[WiredNetwork]
IPAddressSettingMethod="Auto"
APIPA="Enable"
IPAddress="192.168.192.168"
Netmask="255.255.255.0"
Gateway="192.168.192.1"
DNSServerSettingMethod="Auto"
DNSServerIPAddress1="192.168.192.1"
DNSServerIPAddress2="192.168.192.1"
DNSServerIPAddress3="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/%SettingUrl%?format=[html | xml | json | ini]
❏ IP Address : The IP address of the TM-i whose set values to be acquired
❏ SettingUrl : The URL of the set value to be changed
❏ format
: Specifies the format of the response body to be returned by the TM-i
html
: HTML format (the same operation as the operation performed when viewing EPSON TMNet
WebConfig by using a browser)
2
ini
: ini format
• If a password is set for EPSON TMNet WebConfig / WebConfig API, at the time of 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
<?xml version="1.0" encoding="UTF-8"?>
<epos-utility xmlns="http://www.epson-pos.com/schemas/2012/02/epos-utility">
<response success="%Result%" code="%Reason%” />
</epos-utility>
This portion is added when response fails.
Response body (Example : set_tcpip_wired.cgi)
When response is successful
<epos-utility xmlns="http://www.epson-pos.com/schemas/2012/02/epos-utility">
<response success="true"/>
</epos-utility>
When response fails
<epos-utility xmlns="http://www.epson-pos.com/schemas/2012/02/epos-utility">
<response success="false" code="InvalidIPAddress” />
</epos-utility>
For details on an error code when response fails, see
"Error Codes and Actions to Take" on page 50 .
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" : "InvalidIPAddress"
}
}
For details on an error code when response fails, see
"Error Codes and Actions to Take" on page 50 .
2
17
18 ini format
[response] success="%Result%" code="%Reason%"
This portion is added when response fails.
Response body (Example : set_tcpip_wired.cgi)
When response is successful
[response] success="true"
When response fails
[response] success="false" code="InvalidIPAddress"
For details on an error code when response fails, see
"Error Codes and Actions to Take" on page 50 .
Chapter 3 Reference
Reference
Referring to Set Values
Wired LAN
General
SettingUrl : config_general_wired.cgi
Refers to the link speed of the wired LAN.
Category
WiredLinkLayer LinkSpeed
Key Value
10BaseTHalf
10BaseTFull
100BaseTHalf
100BaseTFull
AutoNegotiation
TCP/IP
SettingUrl : config_tcpip_wired.cgi
Refers to the IP address, etc. of the wired LAN.
Category
WiredNetwork
Key
IPAddressSettingMethod
Value
Auto
Manual
APIPA
IPAddress
SubnetMask
Gateway
DNSServerSettingMethod
Enable
Disable
(String)
(String)
(String)
DNSServerIPAddress1
DNSServerIPAddress2
DNSServerIPAddress3
Auto
Manual
(String)
(String)
(String)
Description
Refers to the link speed.
10BaseT half duplex
10BaseT full duplex
100BaseT half duplex
100BaseT full duplex
Auto-negotiation
Description
Refers to the IP address setting method.
Auto
Manual
Refers to whether to enable or disable APIPA.
Enable
Disable
Refers to the IP address.
Refers to the subnet mask.
Refers to the default gateway.
Refers to the DNS server IP address setting method.
Auto
Manual
Refers to DNS server IP address 1.
Refers to DNS server IP address 2.
Refers to DNS server IP address 3.
3
19
20
Wireless LAN
General
SettingUrl : config_general_wireless.cgi
Refers to the SSID, etc. of the wireless LAN.
Category
WiredLinkLayer
Key Value
NetworkMode
Infrastructure
Adhoc
SSID
AdhocChannel
CommunicationStandard
(String)
(String)
802.11b/g
802.11b/g/n
AuthenticationMethod
OpenSystem
SharedKey
WPAPSK
WPA2PSK
EncryptionMethod
None
WEP
TKIP
AES
DefaultWEPKey
WEPKey1
WEPKey2
WEPKey3
WEPKey4
PresharedKey
WEPKey1
WEPKey2
WEPKey3
WEPKey4
(String)
(String)
(String)
(String)
(String)
Description
Refers to the network mode.
Infrastructure mode
Adhoc mode
Refers to the SSID.
Refers to the AdhocChannel.
Refers to the communication standard.
802.11b/g
802.11b/g/n
Refers to the authentication method.
OpenSystem
SharedKey
WPAPSK
WPA2PSK
Refers to the encryption method.
No encryption
WEP
TKIP
AES
Refers to the WEP key to be used.
WEP key 1
WEP key 2
WEP key 3
WEP key 4
Refers to WEP key 1.
Refers to WEP key 2.
Refers to WEP key 3.
Refers to WEP key 4.
Refers to the pre-shared key.
Chapter 3 Reference
TCP/IP
SettingUrl : config_tcpip_wireless.cgi
Refers to the IP address, etc. of the wireless LAN.
Category
WirelessNetwork
Key
IPAddressSettingMethod
Value
Auto
Manual
APIPA
IPAddress
SubnetMask
Enable
Disable
(String)
(String)
Gateway
DNSServerSettingMethod
(String)
DNSServerIPAddress1
DNSServerIPAddress2
DNSServerIPAddress3
Auto
Manual
(String)
(String)
(String)
Description
Refers to the IP address setting method.
Auto
Manual
Refers to whether to enable or disable APIPA.
Enable
Disable
Refers to the IP address.
Refers to the subnet mask.
Refers to the default gateway.
Refers to the DNS server IP address setting method.
Auto
Manual
Refers to DNS server IP address 1.
Refers to DNS server IP address 2.
Refers to DNS server IP address 3.
Device
SettingUrl : config_epos_print.cgi
Refers to the registered device settings.
Category
Devices-%DeviceID%
Key Value
Model
IPAddress
RetryInterval
(String)
(String)
(String)
Description
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.
Refers to the device model.
Refers to the IP address.
Refers to the communication retry interval (in milliseconds).
3
21
22
SettingUrl : config_epos_display.cgi
Refers to setting values for customer displays.
Category
Deviceslocal_display
Key
Baudrate
Value
2400
4800
9600
19200
38400
57600
115200
Databit
7
8
Parity
None
Even
Odd
Brightness
100
60
40
20
Use
Enable
Disable
Description
Refers to the communication speed.
2400 bps
4800 bps
9600 bps
19200 bps
38400 bps
57600 bps
115200 bps
Refers to the data bit.
7 bits
8 bits
Refers to the parity.
None
Even
Odd
Refers to the brightness.
100%
60%
40%
20%
Refers to whether customer displays are used.
Enable
Disable
SettingUrl : config_epos_key_input_device.cgi
Refers to all registered key input device information.
Category Key Value
Devices- "Device ID of key input device"
[Example]
Devices-local_keyboard
DeviceName (String)
VID
PID
ControlScript
(String)
(String)
(String)
Description
Refers to the device name.
Refers to vendor ID (4-digit hexadecimal value).
Refers to product ID (4-digit hexadecimal value).
Refers to file name of a control script to be used.
Chapter 3 Reference
SettingUrl : config_epos_serial.cgi
Refers to serial communication device information that has a device ID of [local_serial].
If the TM-i specifications do not include a serial port, this does not refer to serial communication device information.
Description Category Key Value
Devices-”Serial Communication DeviceID”
[Example]
Devices-local_serial
Use
Baudrate
Databit
Parity
Stopbit
FlowControl
7
8
Enable
Disable
2400
4800
9600
19200
38400
57600
115200
None
Even
Odd
1
1.5
2
XOnXOff
Hardware
None
Refers to whether a serial communication device is used.
Enable
Disable
Refers to the communication speed.
2400 bps
4800 bps
9600 bps
19200 bps
38400 bps
57600 bps
115200 bps
Refers to the data bit.
7 bits
8 bits
Refers to the parity.
None
Even
Odd
Refers to the stop bit.
1 bit
1.5 bit
2 bit
Refers to the flow control.
XOnXOff
Hardware
None
3
23
24
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.
• 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.)
• A TM-i printer and wireless LAN interface with a USB connector of a TM printer are connected by USB. (UB-R03)
Category
NetworkPrinter-n
Model
IPAddress
MACAddress
Connection
IPAddressSettingMethod
APIPA
Key
SubnetMask
Gateway
NetworkMode
(String)
(String)
(String)
Value
Wired
Wireless
USB
Auto
Manual
Enable
Disable
(String)
(String)
Infrastructure
Adhoc
Description
Refer to detected printers with the character string, "NetworkPrintern".
("n" is a number applied in the order the printers were detected in.)
Refers to the device model.
Refers to the IP address.
Refers to the MAC address.
Refers to the detected printer's connection status.
Detects a wired LAN connection printer on the LAN.
Detects a wireless LAN connection printer on the LAN.
Detects a wireless LAN connection printer via USB connection.
Refers to the IP address setting method.
Auto
Manual
Refers to whether to enable or disable APIPA.
Enable
Disable
Refers to the subnet mask.
Refers to the default gateway.
Refers to the network mode.
Infrastructure mode
Adhoc mode
Category
NetworkPrinter-n
Key
SSID (String)
AdhocChannel
CommunicationStandard
(String)
Value
802.11b
802.11b/g
802.11b/g/n
AuthenticationMethod
OpenSystem
SharedKey
WPAPSK
EncryptionMethod
None
WEP
TKIP
AES
DefaultWEPKey
WEPKey1
WEPKey2
WEPKey3
WEPKey4
Chapter 3 Reference
Description
Refers to the SSID.
Refers to the AdhocChannel.
Refers to the communication standard.
802.11b
802.11b/g
802.11b/g/n
Refers to the authentication method.
OpenSystem
SharedKey
WPAPSK
Refers to the encryption method.
No encryption
WEP
TKIP
AES
Refers to the WEP key to be used.
WEP key 1
WEP key 2
WEP key 3
WEP key 4
3
25
26
Web Contents Updater
SettingUrl : config_web_contents_updater.cgi
Refers to the Web contents update setting.
Category
WebContents AutoUpdate
Key Value
Frequency
Timing
Enable
Disable
Hour
Daily
Weekly
Monthly
(When Frequency=Hour) (String)
(When Frequency=Daily)
(When Frequency=Weekly) Sunday
Monday
Tuesday
Wednesday
Thursday
Friday
Saturday
(When Frequency=Monthly) (String)
UpdateTimeHour (String)
Description
Refers to whether to automatically update the Web contents.
Enable
Disable
Refers to the frequency of automatic update.
Updates at specified time intervals.
Updates daily, at the specified time of day.
Updates weekly, on the specified day of the week and at the specified time of day.
Updates monthly, on the specified day and at the specified time of day.
Refers to the timing of automatic update.
The return value varies depending on the value for Frequency.
Refers to the interval of automatic update.
A blank character is returned.
Updates every Sunday.
Updates every Monday.
Updates every Tuesday.
Updates every Wednesday.
Updates every Thursday.
Updates every Friday.
Updates every Saturday.
Refers to the day to perform automatic update.
Refers to the hour of the time of day to perform automatic update.
When Frequency=Hour, an empty character is returned.
Chapter 3 Reference
Category
WebContents UpdateTimeMinute
FileURL
UseProxy
Key
ProxyURL
LastUpdateYear
LastUpdateMonth
LastUpdateDay
LastUpdateHour
LastUpdateMinute
LastUpdateSecond
ServerAuthentication
ID
Password
Value
(String)
(String)
Enable
Disable
(String)
(String)
(String)
(String)
(String)
(String)
LastUpdateResultCode
LastUpdateResultMessage
(String)
(String)
(String)
Enable
Disable
(String)
(String)
Description
Refers to the minute of the time of day to perform automatic update.
When Frequency=Hour, an empty character is returned.
Refers to the URL of the Web contents file.
Refers to whether to use a proxy server at the time of automatic update.
Enable
Disable
Refers to the URL of the proxy server.
Refers to the year automatic update was performed last.
Refers to the month automatic update was performed last.
Refers to the day automatic update was performed last.
Refers to the hour of the time automatic update was performed last.
Refers to the minute of the time automatic update was performed last.
Refers to the results of the last automatic update as a numeric value.
Refers to the results of the last automatic update as a message string.
Refers to the second of the time automatic update was performed last.
Refers to whether server authentication is used.
If this authentication cannot be acquired, the setting becomes
"Disable".
Enable
Disable
Refers to an ID for identifying TM-i on the web server side. This is a user ID used for Digest authentication.
Refers to the password for web content updates.
3
27
28
Server Direct Print
SettingUrl : config_server_direct_print.cgi
Refers to Server Direct Print setting values.
Category
ServerDirectPrint Use
Key Value
ID
Password
URL
Enable
Disable
(String)
(String)
(String)
Interval (String)
URL1
Interval1
URL2
Interval2
URL3
Interval3
ServerAuthentication
(String)
(String)
(String)
(String)
(String)
(String)
Enable
Disable
Description
Refers to whether Server Direct Print is used.
Enable
Disable
Refers to the ID.
Refers to the password.
Refers to the acquisition destination URL for printed data.
Designates a value in seconds for the standby time from the completion of acquisition of print data until acquisition of the next print data.
Refers to the acquisition destination URL for printed data.
Designates a value in seconds for the standby time from the completion of acquisition of print data until acquisition of the next print data.
Refers to the acquisition destination URL for printed data.
Designates a value in seconds for the standby time from the completion of acquisition of print data until acquisition of the next print data.
Refers to the acquisition destination URL for printed data.
Designates a value in seconds for the standby time from the completion of acquisition of print data until acquisition of the next print data.
Refers to whether server authentication is used.
If this authentication cannot be acquired, the setting becomes "Disable".
Enable
Disable
Chapter 3 Reference
Status Notification
SettingUrl : config_status_notification.cgi
Refers to status notification setting.
Category
StatusNotification Use
Key Value
ID
Password
URL
Interval
Enable
Disable
(String)
(String)
(String)
(String)
ServerAuthentication
Enable
Disable
Description
Refers to whether the status notification function is used.
Enable
Disable
Refers to the ID.
Refers to the password.
Refers to the notification destination URL for status.
Refers to the standby time in seconds from the completion of a status notification until the next notification is sent.
Refers to whether server authentication is used.
If this authentication cannot be acquired, the setting becomes "Disable".
Enable
Disable
3
29
30
Certificates
SettingUrl : listup_certificates.cgi
Refers to a list of all certificates installed in TM-i.
Category Key
Certificate-%X%(1 <= %X%)
ValidFromYear
ValidFromMonth
ValidFromDay
ValidFromHour
ValidFromMinute
ValidFromSecond
ValidUntilYear
ValidUntilMonth
ValidUntilDay
ValidUntilHour
ValidUntilMinute
ValidUntilSecond
FileDigest issuer
Value
(String)
(String)
(String)
(String)
(String)
(String)
(String)
(String)
(String)
(String)
(String)
(String)
(String)
(String) issuedTo (String)
Description
Refers to valid period (start year).
Refers to valid period (start month).
Refers to valid period (start day).
Refers to valid period (start hour).
Refers to valid period (start minute).
Refers to valid period (start second).
Refers to valid period (end year).
Refers to valid period (end month).
Refers to valid period (end day).
Refers to valid period (end hour).
Refers to valid period (end minute).
Refers to valid period (end second).
Refers to the hash value of the certificate.
Refers to the person who issued the certificate.
Refers to the issue destination for the certificate.
Chapter 3 Reference
Proxy
SettingUrl : config_proxy.cgi
Refers to setting information for the proxy.
Category
Proxy ID
Key Value
(String)
Password
UseProxyServerDirectPrint
(String)
Enable
Disable
UseProxyStatusNotification
Enable
Disable
UseProxyWebContentsUpdate
ProxyURL
Enable
Disable
(String)
Administrator and Location
SettingUrl : config_administrator.cgi
Refers to the administrator information.
Category
General
Key
Administrator
Value
(String)
Location (String)
Description
Refers to an ID for proxy authentication.
Refers to the password for proxy authentication.
Refers to whether a proxy is used for
Server Direct Print.
Enable
Disable
Refers to whether a proxy is used in status notifications.
Enable
Disable
Refers to whether a proxy is used for automatic updating of web content.
Enable
Disable
Refers to the proxy URL.
Description
Refers to the string that designates the administrator.
Refers to the string that designates the location.
3
31
32
Time of Day
SettingUrl : config_time.cgi
Refers to the time-of-day setting.
Time
Category
Year
Key
Month
Day
Hour
Minute
UseTimeServer
TimeServerSettingMethod
Enable
Disable
Auto
Manual
TimeServer
LastUpdateResult
-
Success
Failure
TimeZone
Value
(String)
(String)
(String)
(String)
(String)
Description
Refers to the year of the internal clock of the TM-i.
Refers to the month of the internal clock of the TM-i.
Refers to the day of the internal clock of the TM-i.
Refers to the hour of the time of the internal clock of the TM-i.
Refers to the minute of the time of the internal clock of the TM-i.
Refers to whether to enable or disable the clock alignment by the time server.
Enable
Disable
Refers to the time server name acquisition method.
Auto
Manual
Refers to the time server name.
Displays the results of the last timeof-day acquisition synchronized with the time server.
Time-of-day synchronization with the time server was successful.
Time-of-day synchronization with the time server failed.
Time-of-day synchronization not done.
Refers to the time zone.
Password
SettingUrl : config_password.cgi
Refers to the set password.
Category
Password
Key
PasswordMD5
Value
(String)
Description
Refers to the string created from the password string through MD5 encryption.
Chapter 3 Reference
Changing the Set Values
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 want to 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
LinkSpeed
Specifiable value
10BaseTHalf
10BaseTFull
100BaseTHalf
100BaseTFull
AutoNegotiation
Description
Specifies the link speed.
10BaseT half duplex
10BaseT full duplex
100BaseT half duplex
100BaseT full duplex
Auto-negotiation
TCP/IP
SettingUrl : set_tcpip_wired.cgi
Changes the IP address, etc. of the wired LAN.
POST parameter
IPAddressSettingMethod
Specifiable value
Auto
Manual
APIPA
IPAddress
SubnetMask
Gateway
DNSServerSettingMethod
Enable
Disable
(String)
(String)
(String)
DNSServerIPAddress1
DNSServerIPAddress2
DNSServerIPAddress3
Auto
Manual
(String)
(String)
(String)
Description
Specifies the IP address setting method.
Auto
Manual
Refers to whether to enable or disable APIPA.
Enable
Disable
Specifies the IP address setting method.
Specifies the subnet mask.
Specifies the default gateway.
Specifies the DNS server IP address setting method.
Auto
Manual
Refers to DNS server IP address 1.
Refers to DNS server IP address 2.
Refers to DNS server IP address 3.
3
33
34
Wireless LAN
General
SettingUrl : set_general_wireless.cgi
Changes the SSID, etc. of the wireless LAN.
POST parameter
Specifiable value
NetworkMode
SSID
Infrastructure
Adhoc
(String)
AdhocChannel
CommunicationStandard
AuthenticationMethod
EncryptionMethod
DefaultWEPKey
WEPKey1
WEPKey2
(String)
802.11b/g
802.11b/g/n
OpenSystem
SharedKey
WPAPSK
WPA2PSK
None
WEP
TKIP
AES
WEPKey1
WEPKey2
WEPKey3
WEPKey4
(String)
(String)
Description
Specifies the network mode.
Infrastructure mode
Adhoc mode
Specifies the SSID by a character string using single-byte alphanumeric characters and spaces, 1 character or more to 32 characters or less long.
Specifies the ad hoc channel using an integer in the range 1- 11.
Specifies the communication standard.
802.11b/g
802.11b/g/n
Specifies the authentication method.
OpenSystem
SharedKey
WPAPSK
WPA2PSK
Specifies the encryption method.
No encryption
WEP
TKIP
AES
Specifies the WEP key to be used.
WEP key 1
WEP key 2
WEP key 3
WEP key 4
Specifies a value for WEP key 1 using one of the following strings:
• 10-digit hexadecimal number
• 26-digit hexadecimal number
• 5 single-byte alphanumeric characters and spaces
• 13 single-byte alphanumeric characters and spaces
Specifies a value for WEP key 2 using one of the following strings:
• 10-digit hexadecimal number
• 26-digit hexadecimal number
• 5 single-byte alphanumeric characters and spaces
• 13 single-byte alphanumeric characters and spaces
Chapter 3 Reference
POST parameter
WEPKey3
WEPKey4
PresharedKey
Specifiable value
(String)
(String)
(String)
Description
Specifies a value for WEP key 3 using one of the following strings:
• 10-digit hexadecimal number
• 26-digit hexadecimal number
• 5 single-byte alphanumeric characters and spaces
• 13 single-byte alphanumeric characters and spaces
Specifies a value for WEP key 4 using one of the following strings:
• 10-digit hexadecimal number
• 26-digit hexadecimal number
• 5 single-byte alphanumeric characters and spaces
• 13 single-byte alphanumeric characters and spaces
Specifies the pre-shared key using one of the following strings:
• 8 or more to 63 or less single-byte alphanumeric characters and spaces
• 64-digit hexadecimal number
3
35
36
TCP/IP
SettingUrl : set_tcpip_wireless.cgi
Changes the IP address, etc. of the wireless LAN.
POST parameter
IPAddressSettingMethod
Specifiable value
Auto
Manual
APIPA
IPAddress
SubnetMask
Gateway
DNSServerSettingMethod
Enable
Disable
(String)
(String)
(String)
DNSServerIPAddress1
DNSServerIPAddress2
DNSServerIPAddress3
Auto
Manual
(String)
(String)
(String)
Description
Specifies the IP address setting method.
Auto
Manual
Refers to whether to enable or disable APIPA.
Enable
Disable
Specifies the IP address.
Specifies the subnet mask.
Specifies the default gateway.
Specifies the DNS server IP address setting method.
Auto
Manual
Refers to DNS server IP address 1.
Refers to DNS server IP address 2.
Refers to DNS server IP address 3.
Chapter 3 Reference
Adding a TM Printer
SettingUrl : set_epos_print.cgi
Registers a new device.
Refer to the Technical Reference Guide for printers that can be designated.
POST parameter
DeviceID
Model
IPAddress
RetryInterval
TM-T88V
TM-T88IV
TM-T70
TM-T70II
TM-T90
TM-L90
TM-P60II
TM-T20
TM-T20II
TM-T82II
TM-P80
TM-U220
(String)
(String)
Specifiable value
(String)
Description
Specifies the device ID by a character string using singlebyte alphanumeric characters, underscore(s), period(s), and/or dash(es), one character or more and 30 characters or less long.
Specifies the device model.
TM-T88V
TM-T88IV
TM-T70
TM-T70II
TM-T90
TM-L90
TM-P60II
TM-T20
TM-T20
TM-T82II
TM-P80
TM-U220
Specifies the IP address.
Specifies the communication retry interval using a numeric value (in milliseconds) in the range 100- 60000.
Deleting a TM Printer
SettingUrl : delete_epos_print.cgi
Deletes a registered device.
POST parameter
DeviceID
Specifiable value
(String)
Description
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.
3
37
38
Setting a Customer Display
SettingUrl : set_epos_display.cgi
Changes the settings for customer displays connected to TM-i.
POST parameter
Specifiable value
Baudrate
Databit
Parity
Brightness
Use
7
8
2400
4800
9600
19200
38400
57600
115200
None
Even
Odd
100
60
40
20
Enable
Disable
Description
Specifies the communication speed.
2400 bps
4800 bps
9600 bps
19200 bps
38400 bps
57600 bps
115200 bps
Specifies the data bit.
7 bits
8 bits
Specifies the parity.
None
Even
Odd
Specifies the brightness.
100%
60%
40%
20%
Refers to whether customer displays are used.
Enable
Disable
Chapter 3 Reference
Adding a key input device
SettingUrl : set_epos_key_input_device.cgi
Changes the information for key input devices connected to TM-i.
POST parameter
DeviceID
DeviceName
VID
PID
ControlScript
Specifiable value
(String)
(String)
(String)
(String)
(String)
Description
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.
Specifies the device name.
Designates a vendor ID (4-digit hexadecimal value).
Designates a product ID (4-digit hexadecimal value).
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 key input device information for the device ID specified in the parameter.
POST parameter
DeviceID
Specifiable value
(String)
Description
Designates a device ID of 1 to 30 alphanumeric characters, underbars, periods, and hyphens.
3
39
40
Setting a Serial Communication Device
SettingUrl : set_epos_serial.cgi
Changes the serial communication device information with a device ID of [local_serial].
If the TM-i specifications include no serial ports, this setting is disabled.
POST parameter
Use
Baudrate
Databit
Parity
Stopbit
FlowControl
7
8
Enable
Disable
2400
4800
9600
19200
38400
57600
115200
None
Even
Odd
1
1.5
2
Specifiable value
XOnXOff
Hardware
None
Description
Designates whether to use a serial communication device.
Enable
Disable
Specifies the communication speed.
2400 bps
4800 bps
9600 bps
19200 bps
38400 bps
57600 bps
115200 bps
Specifies the data bit.
7 bits
8 bits
Specifies the parity.
None
Even
Odd
Specifies the stop bit.
1 bit
1.5 bit
2 bit
Specifies the flow control.
XOnXOff
Hardware
None
Chapter 3 Reference
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.
• 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 TM-i printer and wireless LAN interface with a USB connector of a TM printer are connected by USB. (UB-R03)
POST parameter
MACAddress
HostName
IPAddressSettingMethod
APIPA
IPAddress
SubnetMask
Gateway
Password
Specifiable value
(String)
(String)
Auto
Manual
Enable
Disable
(String)
(String)
(String)
(String)
Description
Specifies the MAC address.
Specifies the IP address.
Specifies the IP address setting method.
Auto
Manual
Refers to whether to enable or disable APIPA.
Enable
Disable
Specifies the IP address.
Specifies the subnet mask.
Specifies the default gateway.
Specifies a new password to be set using a single-byte alphanumeric character string 0 (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.
• A TM-i printer and wireless LAN interface with a USB connector of a TM printer are connected by USB. (UB-R03)
POST parameter
MACAddress
HostName
NetworkMode
SSID
Specifiable value
(String)
(String)
Infrastructure
Adhoc
(String)
Description
Specifies the MAC address.
Specifies the IP address.
Specifies the network mode.
Infrastructure mode
Adhoc mode
Specifies the SSID by a character string using single-byte alphanumeric characters and spaces,
1 character or more to 32 characters or less long.
3
41
42
POST parameter
AdhocChannel
CommunicationStandard
AuthenticationMethod
EncryptionMethod
DefaultWEPKey
WEPKey1
WEPKey2
WEPKey3
Specifiable value
(String)
802.11b
802.11b/g
802.11b/g/n
OpenSystem
SharedKey
WPAPSK
None
WEP
TKIP
AES
WEPKey1
WEPKey2
WEPKey3
WEPKey4
(String)
(String)
(String)
Description
Specifies the ad hoc channel using an integer in the range 1- 11.
Specifies the communication standard.
802.11b
802.11b/g
802.11b/g/n
Specifies the authentication method.
OpenSystem
SharedKey
WPAPSK
Specifies the encryption method.
No encryption
WEP
TKIP
AES
Specifies the WEP key to be used.
WEP key 1
WEP key 2
WEP key 3
WEP key 4
Specifies a value for WEP key 1 using one of the following strings:
• 10-digit hexadecimal number
• 26-digit hexadecimal number
• 5 single-byte alphanumeric characters and spaces
13 single-byte alphanumeric characters and spaces
Specifies a value for WEP key 2 using one of the following strings:
• 10-digit hexadecimal number
• 26-digit hexadecimal number
• 5 single-byte alphanumeric characters and spaces
13 single-byte alphanumeric characters and spaces
Specifies a value for WEP key 3 using one of the following strings:
• 10-digit hexadecimal number
• 26-digit hexadecimal number
• 5 single-byte alphanumeric characters and spaces
13 single-byte alphanumeric characters and spaces
Chapter 3 Reference
POST parameter
WEPKey4
PresharedKey
Password
Specifiable value
(String)
(String)
(String)
Description
Specifies a value for WEP key 4 using one of the following strings:
• 10-digit hexadecimal number
• 26-digit hexadecimal number
• 5 single-byte alphanumeric characters and spaces
13 single-byte alphanumeric characters and spaces
Specifies the pre-shared key using one of the following strings:
8 or more, 63 or less single-byte alphanumeric characters and spaces
Specifies a new password to be set using a singlebyte alphanumeric character string 0 (zero) character or more and 20 characters or less long.
3
43
44
Web Contents Updater
SettingUrl : set_web_contents_updater.cgi
Changes the Web contents update setting.
POST parameter
Specifiable value
AutoUpdate
Frequency
Timing
(When Frequency=Hour)
(When Frequency=Daily)
(When Frequency=Weekly)
(When Frequency=Monthly)
UpdateTimeHour
UpdateTimeMinute
FileURL
UseProxy
ProxyURL
Enable
Disable
Hour
Daily
Weekly
Monthly
(String)
Sunday
Monday
Tuesday
Wednesday
Thursday
Friday
Saturday
(String)
(String)
(String)
(String)
Enable
Disable
(String)
Description
Specifies whether to automatically update the Web contents.
Enable
Disable
Specifies the frequency of automatic update.
Updates at specified time intervals.
Updates daily, at the specified time of day.
Updates weekly, on the specified day of the week and at the specified time of day.
Updates monthly, on the specified day and at the specified time of day.
Specifies the timing of automatic update.
The value to be specified varies depending on the value for Frequency.
Specifies the time interval of automatic update using an integer in the range 1- 23.
Specify a blank character.
Updates every Sunday.
Updates every Monday.
Updates every Tuesday.
Updates every Wednesday.
Updates every Thursday.
Updates every Friday.
Updates every Saturday.
Specifies the date to perform automatic update using an integer in the range 1- 31.
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.
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.
Specifies the URL of the Web contents file.
Specifies whether to use a proxy server at the time of automatic update.
Enable
Disable
Specifies the URL of the proxy server.
Chapter 3 Reference
ID
POST parameter
Password
ServerAuthentication
Specifiable value
(String)
(String)
Enable
Disable
Description
Designates the ID that identifies TM-i on the web server side. This is the user ID used for digest authentication.
Designates the password used for Digest authentication.
Designates whether to use server authentication. If no password is specified, the current settings are used.
Enable
Disable
Automatic Update
SettingUrl : execute_web_contents_updater.cgi
Forcibly perform automatic update of the Web contents.
No parameter to be set.
Server Direct Print
SettingUrl : set_server_direct_print.cgi
Changes the Server Direct Print settings.
POST parameter
Specifiable value
Use
ID
Enable
Disable
(String)
Password
URL
Interval
URL1
Interval1
(String)
(String)
(String)
(String)
(String)
Description
Designates whether to use Server Direct Print.
Enable
Disable
Designates an ID of no more than 30 alphanumeric characters, underbars, periods, and hyphens.
Designates a password of no more than 30 alphanumeric characters, underbars, periods, and hyphens.
Designates the acquisition destination URL for print data.
If URL1 is specified, this parameter is ignored.
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.
Designates the acquisition destination URL for print data.
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.
45
3
46
URL2
POST parameter
Interval2
URL3
Interval3
ServerAuthentication
Specifiable value
(String)
(String)
(String)
(String)
Enable
Disable
Description
Designates the acquisition destination URL for print data.
Designates a value (seconds) between 1 and 86400 for the standby time from the completion of acquisition of print data until acquisition of the next print data.
Designates the acquisition destination URL for print data.
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.
Designates whether to use server authentication. If no password is specified, the current settings are used.
Enable
Disable
Status Notification
SettingUrl : set_status_notification.cgi
Changes the settings for status notifications.
POST parameter
Specifiable value
Use
ID
Enable
Disable
(String)
Password
URL
Interval
ServerAuthentication
(String)
(String)
(String)
Enable
Disable
Description
Designates whether the status notification function is used.
Enable
Disable
Designates an ID of no more than 30 alphanumeric characters, underbars, periods, and hyphens.
Designates a password of no more than 30 alphanumeric characters, underbars, periods, and hyphens.
Designates the status notification destination URL.
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.
Designates whether to use server authentication.
If no password is specified, the current settings are used.
Enable
Disable
Chapter 3 Reference
Certificate
SettingUrl : delete_certificate.cgi
Deletes the specified certificate.
POST parameter
FileDigest
Specifiable value
(String)
Description
Designates the "MD5" hash value for the certificate to be deleted.
Proxy
SettingUrl : set_proxy.cgi
Changes the proxy information.
POST parameter
ProxyURL
Specifiable value
(String)
ID
Password
(String)
(String)
UseProxyServerDirectPrint
Enable
Disable
UseProxyStatusNotification
UseProxyWebContentsUpdate
Enable
Disable
Enable
Disable
Description
Enter the proxy server URL and port number in the following:
"http://host name: port number".
Example: http://10.0.0.1:8008
Designates an ID of no more than 30 alphanumeric characters, underbars, periods, and hyphens.
Designates a password of no more than 30 alphanumeric characters, underbars, periods, and hyphens.
Designates whether a proxy is used in Server
Direct Print.
Enable
Disable
Designates whether a proxy is used in status notifications.
Enable
Disable
Designates whether a proxy is used in Web
Contents Update.
Enable
Disable
3
47
48
Administrator and Location
SettingUrl : set_administrator.cgi
Changes the administrator information.
POST parameter
Administrator
Specifiable value
(String)
Location (String)
Description
Specifies the string that designates the administrator, 255 characters or less long.
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.
Year
POST parameter
Specifiable value
(String)
Month
Day
Hour
Minute
UseTimeServer
TimeServerSettingMethod
TimeServer
TimeZone
(String)
(String)
(String)
(String)
Enable
Disable
Auto
Manual
(String)
(String)
Description
Specifies the year of the internal clock of the TM-i using an integer in the range 2012-2036.
Specifies the month of the internal clock of the TM-i using an integer in the range 1-12.
Specifies the day of the internal clock of the TM-i using an integer in the range 1-31.
Specifies the hour of the time of the internal clock of the TM-i using an integer in the range 0-23.
Specifies the minute of the time of the internal clock of the TM-i using an integer in the range 0-59.
Specifies whether to enable or disable the clock alignment by the time server.
Enable
Disable
Specifies the time server name acquisition method.
Auto
Manual
Specifies the time server name.
Specifies the time zone with a value that is -14 or higher to 12 or lower.
Chapter 3 Reference
Password
SettingUrl : set_password.cgi
Changes the set password.
POST parameter
NewPassword
Specifiable value
(String)
Description
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.
Resetting and Initializing the Settings
SettingUrl : set_reset.cgi
Resets the wired LAN/wireless LAN and restores the factory default settings.
POST parameter
Operation
Specifiable value Description
Reset
FactoryDefault
Resets the wired LAN/wireless LAN.
Restores the factory default settings.
3
49
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.
FirmwareUpdating
InvalidLinkSpeed
InvalidIPAddressSettingMethod
InvalidAPIPA
InvalidIPAddress
InvalidSubnetMask
InvalidGateway
InvalidDNSServerSettingMethod
InvalidDNSServerIPAddress
InvalidNetworkMode
InvalidSSID
code
InvalidAdhocChannel
InvalidCommunicationStandard
InvalidAuthenticationMethod
InvalidAuthenticationMethodAdhoc
InvalidEncryptionMethod
InvalidEncryptionMethodAdhoc
InvalidEncryptionMethodOpenSystem
Action to Take
Firmware is being updated by the remote update tool.
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.
Invalid APIPA parameter value.
Correct the error.
Invalid IPAddress parameter value.
Correct the error.
Invalid SubnetMask parameter value.
Correct the error.
Invalid Gateway parameter value.
Correct the error.
Invalid DNSServerSettingMethod parameter value.
Correct the error.
Invalid value for any of the parameters DNSServerIPAddress1 to DNSServerIPAddress3.
Correct the error.
Invalid NetworkMode parameter value.
Correct the error.
Invalid SSID parameter value.
Correct the error.
Invalid AdhocChannel parameter value.
Correct the error.
Invalid CommunicationStandard parameter value.
Check the values for the communication standard supported by the printer to correct the value.
Invalid AuthenticationMethod parameter value.
Correct the error.
When Adhoc is specified for the NetworkMode parameter,
WPAPSK/WPA2PSK cannot be specified for
AuthenticationMethod.
Correct the error.
Invalid EncryptionMethod parameter value.
Correct the error.
When Adhoc is specified for the NetworkMode parameter,
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.
Correct the error.
50
Chapter 3 Reference
code
InvalidEncryptionMethodWPAPSK
InvalidDefaultWEPKey
InvalidWEPKey1
InvalidWEPKey2
InvalidWEPKey3
InvalidWEPKey4
InvalidPresharedKey
InvalidDeviceID
DeviceIDAlreadyRegistered
InvalidModel
InvalidRetryInterval
DeviceIDNotRegistered
InvalidMACAddress
InvalidHostName
PasswordNotCorrect
DeviceNotFound
InvalidCommunicationStandardAdhoc
DeviceNotWireless
InvalidAutoUpdate
Action to Take
When WPAPSK is specified for the AuthenticationMethod parameter, None/WEP cannot be specified for
EncryptionMethod.
Correct the error.
Invalid DefaultWEPKey parameter value.
Correct the error.
Invalid WEPKey1 parameter value.
Correct the error.
Invalid WEPKey2 parameter value.
Correct the error.
Invalid WEPKey3 parameter value.
Correct the error.
Invalid WEPKey4 parameter value.
Correct the error.
Invalid PresharedKey parameter value.
Correct the error.
Invalid DeviceID parameter value.
Correct the error.
The device specified for the DeviceID parameter cannot be registered because it is already registered.
Specify a different ID.
Invalid Model parameter value.
Correct the error.
Invalid RetryInterval parameter value.
Correct the error.
The device specified for the DeviceID parameter cannot be deleted because it is not registered.
Specify an already registered ID.
Invalid MACAddress parameter value.
Correct the error.
Invalid HostName parameter value.
Correct the error.
The string specified for the Password parameter did not match the password string set into the detected TM printer.
Correct the error.
The TM printer specified for the MACAddress or HostName parameter could not be found.
Check the connection status of the TM printer.
When Adhoc is specified for the NetworkMode parameter,
802.11b/g/n cannot be specified for
CommunicationStandard.
Correct the error.
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.
Invalid AutoUpdate parameter value.
Correct the error.
3
51
52
InvalidFrequency
code
InvalidTiming
InvalidUpdateTimeHour
InvalidTimeMinute
InvalidFileURL
InvalidUseProxy
InvalidProxyURL
AccessToFileURLFailed
AccessToProxyURLFailed
NotEnoughFreeSpace
FileURLNotZip
WebContentsUpdaterDisabled microSDNotFound
InvalidUse
InvalidID
InvalidPassword
IDNeededToSetPassword
InvalidURL
InvalidInterval
InvalidAdministrator
Action to Take
Invalid Frequency parameter value.
Correct the error.
Invalid Timing parameter value.
Correct the error.
Invalid UpdateTimeHour parameter value.
Correct the error.
Invalid UpdateTimeMinute parameter value.
Correct the error.
Invalid FileURL parameter value.
Correct the error.
Invalid UseProxy parameter value.
Correct the error.
Invalid ProxyURL parameter value.
Correct the error.
Failed to access the URL specified for the FileURL parameter.
Check the network settings for the TM-i and for the server.
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
FileURL were not of a zip file format.
Correct the error.
The Web contents automatic update setting is disabled.
Correct the error.
The Web contents save destination is specified as microSD, but no microSD could be detected.
Check that a microSD is mounted to the TM-i.
Invalid Use parameter value.
Correct the error.
Invalid ID parameter value.
Correct the error.
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 specified for the ID parameter.
Set a value for the ID parameter.
Invalid URL parameter value.
Correct the error.
Invalid Interval parameter value.
Correct the error.
Invalid Administrator parameter value.
Correct the error.
code
InvalidLocation
InvalidYear
InvalidMonth
InvalidDay
InvalidHour
InvalidMinute
InvalidTimeZone
InvalidUseTimeServer
InvalidTimeServerSettingMethod
InvalidTimeServer
InvalidDate
InvalidTime
InvalidNewPassword
InvalidOperation
Chapter 3 Reference
Action to Take
Invalid Location parameter value.
Correct the error.
Invalid Year parameter value.
Correct the error.
Invalid Month parameter value.
Correct the error.
Invalid Day parameter value.
Correct the error.
Invalid Hour parameter value.
Correct the error.
Invalid Minute parameter value.
Correct the error.
Invalid TimeZone parameter value.
Correct the error.
Invalid UseTimeServer parameter value.
Correct the error.
Invalid TimeServerSettingMethod parameter value.
Correct the error.
Invalid TimeServer parameter value.
Correct the error.
Invalid Year/Month/Day parameter combination.
Correct the error.
Invalid Hour/Minute parameter combination.
Correct the error.
Invalid NewPassword parameter value.
Correct the error.
Invalid Operation parameter value.
Correct the error.
3
53
54
Chapter 4 Sample Program
Sample Program
This sample program can acquire/change the set values of the TM-i and upload files.
Screen
The following screen appears when the sample program starts.
4
55
Operating Environment
The system configuration diagram for the sample programs is as below.
The IP address value is just an example. Set the value that suits your use environment.
Computer to configure the settings
Wireless LAN Router
[192.168.192.1]
TM-i
[192.168.192.20]
❏ Wireless LAN Router
❏ TM-i (1 set)
TM-T88V-i/ TM-T70-i/TM-L90-i
❏ Computer to configure the settings
Computer in which Microsoft Office Excel 2003(Excel2003) or later and Microsoft Internet Explorer 7 or later are installed.
56
Chapter 4 Sample Program
Basic Usage of the Sample Program
This sample program is implemented using VBA macros. Use this program by enabling macros.
1
Specify values for IP Address, CGI Name, Format, User Name, and Password.
For CGI Name and Format each, select a parameter from a list.
2
Click the [GET] button.
The response body and set values will be filled into the cells.
4
57
3
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.
58
4
Success or failure of the process to change the set value will be displayed. If the process fails, the reason will be filled into the cell.
The following screen shows the case in which the IP address failed to be set.
Chapter 4 Sample Program
Note
If [config_epos_print.cgi, set_epos_print.cgi] is selected for CGI Name and the [GET] button is clicked, all the registered devices will be filled into [Response body].
All the registered devices are displayed.
Note that one device at a time can be registered (SET).
Write only one device to be registered.
4
59
Uploading Files
1
Click the [Upload Web Contents] button.
2
The file selection screen appears. Select the file to be uploaded to the TM-i. Click the [OPEN] button and the file starts to be uploaded.
3
The results are displayed in the cell.
The following screen shows the case in which the file has been successfully uploaded.
60
Uploading Certificate
1
Click the [Upload Certificate File] button.
Chapter 4 Sample Program
2
The file selection screen appears. Select the file to be uploaded to the TM-i. Click the [OPEN] button and the file starts to be uploaded.
3
The results are displayed in the cell.
The following screen shows the case in which the file has been successfully uploaded.
4
61
62
* Your assessment is very important for improving the workof artificial intelligence, which forms the content of this project