Epson TM-H6000V Web Config API Users Manual

Epson TM-H6000V Manual

Get Epson TM-H6000V PDF manuals and user guides View all Epson TM-H6000V manuals
Add to My Manuals
Save this manual to your list of manuals

Epson TM-H6000V manual content summary:

  • Epson TM-H6000V | Web Config API Users Manual - Page 1
    TM-H6000V WebConfig API User's Manual Overview Describes an overview of WebConfig API. Web API Specification Describes the web API specification. Reference Describes how to refer to and change setting values. M00110400 Rev.A
  • Epson TM-H6000V | Web Config API Users Manual - Page 2
    to this product, or (excluding the U.S.) failure to strictly comply with Seiko Epson Corporation's operating and maintenance instructions.  Seiko Epson Corporation shall not be liable against any damages or problems arising from the use of any options or any consumable products other than those
  • Epson TM-H6000V | Web Config API Users Manual - Page 3
    For Safety Key to Symbols The symbols in this manual are identified by their level of importance, as defined 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
  • Epson TM-H6000V | Web Config API Users Manual - Page 4
    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 WebConfig API for the TM-H6000V. Manual Content The manual is made up of the following sections: Chapter 1 Overview
  • Epson TM-H6000V | Web Config API Users Manual - Page 5
    of Use ...3 ■ About this Manual ...4 Aim of the Manual ...4 Manual Content ...4 ■ Contents...5 Overview ...7 ■ Overview of WebConfig API 7 ■ Printers...8 Support functions...8 Interface...8 ■ Usage Instructions ...9 Acquisition and Configuration of Setting Values...9 Digest authentication...11
  • Epson TM-H6000V | Web Config API Users Manual - Page 6
    ■ Characters...19 Character Code...19 Escape Sequence ...19 Passwords...19 ■ Operation specifications...19 Printer Response Time ...19 ■ Example of Request and Response 20 Reference...25 6
  • Epson TM-H6000V | Web Config API Users Manual - Page 7
    be included in your Web application in order to update the setting values of your TM printer. The GET method, defined in HTTP (Hyper Text Transfer Protocol), is used to acquire setting values, and the PUT method is used to update the settings. The data is in JSON (JavaScript Object Notation) format
  • Epson TM-H6000V | Web Config API Users Manual - Page 8
    Printers  TM-H6000V Support functions Your printer includes a variety of functions for software settings. The functions that are supported (and not supported) by this API are shown in the following table. Function Supported / Not supported TM intelligent function Supported 1 Customize
  • Epson TM-H6000V | Web Config API Users Manual - Page 9
    Usage Instructions Chapter 1 Overview Acquisition and Configuration of Setting Values This section explains the system sequence and each element needed in order to acquire set values from printers and specify the settings by using the WebConfig API. Acquisition and Configuration of Setting Values
  • Epson TM-H6000V | Web Config API Users Manual - Page 10
    JSON format. Creation of setting values 1 Creation of each key value to configure the printer. There are two setting methods: You can specify only printer. For example: Acquisition JSON data Edit data ... "StatusNotification": { "Active": "OFF", "ID": "", "Interval": "5", "Name": "" "Password
  • Epson TM-H6000V | Web Config API Users Manual - Page 11
    the values for each key set in the printer and the JSON set values acquired from the printer, and check that they have been properly revised. Digest authentication You need Digest authentication to communicate with the printer. The default ID and Password are ID: epson, Pass: epson and are the same
  • Epson TM-H6000V | Web Config API Users Manual - Page 12
    Chapter 1 Overview Restrictions Manual uploading of certificate files are not possible. In order to upload these, it is necessary to use an uploading program, or upload using the TM-H6000V Utility. 1 12
  • Epson TM-H6000V | Web Config API Users Manual - Page 13
    IP address>/webconfig/api/v1/webconfig.cgi  Printer reset: https://
  • Epson TM-H6000V | Web Config API Users Manual - Page 14
    default password is incorrect). It is not specified when digest authentica- ● ● ● ● tion is completed normally. Digest realm="", nonce="xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx", qop="auth" Response Body HTTP Method GET PUT Description The setting values are returned from the printer
  • Epson TM-H6000V | Web Config API Users Manual - Page 15
    /json; charset=utf-8 Authorization: Digest username="epson" realm="ByPassword" nonce="xxxxxxxxxxxxxxxxxxxxxxxxx", qop="auth" ,,,,,, 2 Request Body HTTP Method GET PUT Description Acquires the current setting values from the printer. For details of these set values, see "GET method" on page
  • Epson TM-H6000V | Web Config API Users Manual - Page 16
    memory" } Failed due to insufficient memory. Repair is necessary if the problem occurs even after restarting the printer. 400 Bad Request { "Setting" : {}, "message": "Specified key is not exist" } Failed to acquire settings. Keyname % not present in JSON data of keyname=% specified values
  • Epson TM-H6000V | Web Config API Users Manual - Page 17
    value in the prescribed manner as "message": "Failed to update the settings" described at "Reference" on page } 25.  Any characters in necessary if the problem occurs even after restarting the printer. 503 Service Unavailable { "message": "Cannot communi- cate with the printer : The other
  • Epson TM-H6000V | Web Config API Users Manual - Page 18
    Chapter 2 Web API Specification PUT Parameter Response (status) Response (body) Description 400 Bad Request { "message": "Special characters must be escaped" } The JSON escape process is not valid. When a method that cannot be used is specified "405 Method Not Allowed" or "403 Forbidden" is
  • Epson TM-H6000V | Web Config API Users Manual - Page 19
    According to the JSON RFC (Request for Comments), the setting character string transmitted by PUT must use the following escape password. When registering/changing a password, please replace the (Registered) or (Not registered) string with the desired password. Operation specifications Printer
  • Epson TM-H6000V | Web Config API Users Manual - Page 20
    Active ON. It is turned OFF in the factory default settings.  Printer List: Set the Device IDs and other printer information.  Server Direct Print: Specify the server and http://192.168.192.20/> Authorization: Digest username="epson", realm="ByPassword", nonce="", uri="/webconfig/api/v1/
  • Epson TM-H6000V | Web Config API Users Manual - Page 21
    -Policy: default-src 'none' Connection: close Transfer-Encoding: chunked Date: Wed, 23 Aug 2017 07:46:22 GMT Server: lighttpd Response Body { "Setting": { "ePOS-Print": { "Active": "OFF" } "PrinterList": { "Printer1": { "DeviceID": "local_printer", "IPAddress": "127.0.0.1", "ModelName": "TM-H6000V
  • Epson TM-H6000V | Web Config API Users Manual - Page 22
     Active: OFF Printer List  Printer1  DeviceID: local_printer This setting can be configured according to the application.  IPAddress: 127.0.0.1 Do not change this setting. Otherwise, printing will not be possible.  ModelName: TM-H6000V Do not change this setting. Otherwise, printing
  • Epson TM-H6000V | Web Config API Users Manual - Page 23
    Authorization: Digest username="epson", realm="ByPassword", nonce="", uri="/webconfig/api/v1/webconfig { "Setting": { "ePOS-Print": { "Active": "ON" } "PrinterList": { "Printer1": { "DeviceID": "local_printer", "IPAddress": "127.0.0.1", "ModelName": "TM-H6000V" }
  • Epson TM-H6000V | Web Config API Users Manual - Page 24
    :47:15 GMT Server: lighttpd Response Body { "Setting": { "ePOS-Print": { "Active": "ON" 2 }, "Setting": { "PrinterList": { "Printer1": { "DeviceID": "local_printer", "IPAddress": "127.0.0.1", "ModelName": "TM-H6000V" } } }, "ServerDirectPrint": { "Active": "ON", "CutReserveTimeout
  • Epson TM-H6000V | Web Config API Users Manual - Page 25
    Notification "OFF", "ON" 3 ePOS-Device setting Active Sets to whether to enable or disable ePOS-Device. "OFF", "ON" Printer List Printer list that is set with the WebConfig API. Printer1 Setting for the TM-H6000V. DeviceID IDs that identify printer devices. Device ID specified for
  • Epson TM-H6000V | Web Config API Users Manual - Page 26
    z, A to Z), "_", "." and "-". Specify the proxy server authentication password. Empty string or string with 1 to 30 characters. Characters that can empty string is specified. It is left empty if the printer serial number is not set. Specify the Digest authentication ID. Empty string or string
  • Epson TM-H6000V | Web Config API Users Manual - Page 27
    Key 1 Key 2 Key 3 Key 4 Description Value Password Specify the Digest authentication Password. Empty string or string with 1 to 30 characters. Specify whether a proxy server is used. "OFF", "ON" When this setting is "ON", is it necessary to specify "ProxyInfo". UseUrlEncode Specify whether
  • Epson TM-H6000V | Web Config API Users Manual - Page 28
    for "Name" when the initial value or an empty string is specified. It is left empty if the printer serial number is not set. ID Specify the Digest authentication ID. Password Empty string or string with 1 to 30 characters. Characters that can be used are single-byte alphanumeric characters
  • 1
  • 2
  • 3
  • 4
  • 5
  • 6
  • 7
  • 8
  • 9
  • 10
  • 11
  • 12
  • 13
  • 14
  • 15
  • 16
  • 17
  • 18
  • 19
  • 20
  • 21
  • 22
  • 23
  • 24
  • 25
  • 26
  • 27
  • 28
TM-H6000V
WebConfig API User's Manual
M00110400
Rev.A
Overview
Web API Specification
Reference
Describes an overview of WebConfig API.
Describes the web API specification.
Describes how to refer to and change setting values.