1. TOP»
  2. Epson ePOS SDK for Android »
  3. Printer class »
  4. updateFirmware

Select your printer model

Parameters are refined by the selected printer.

updateFirmware

Downloads the firmware image from the server and instructs the printer to overwrite the firmware image.

Execute verifyUpdate after executing this API, and confirm that the printer firmware has been overwritten by the firmware image.

The return value from this API is the result of instructing writing of the firmware image to the printer. It is not the execution result of the overall firmware update.

The progress and processing result of this API is notified to the listener method specified in the listener parameter.

Syntax

 
 
public void updateFirmware(FirmwareInfo targetFirmwareInfo, FirmwareUpdateListener listener, android.content.Context context) throws Epos2Exception

Parameter

targetFirmwareInfo

Specifies the firmware image version that you want to apply to the printer from the list acquired by downloadFirmwareList.

listener

Registers the listener method that returns the progress and execution result of this API.

  • Acquires the progress status
 
 
- (void) onFirmwareUpdateProgress(String task, float progress);
  • task
    The name of the executed process is stored.

  • Name

    Description

    Prepare

    Under preparation

    Download Firmware

    Downloading the firmware image from the server

    Sending firmware image

    Sending the downloaded firmware image to the printer
  • progress
    A value between 0.0 and 1.0 is stored according to the progress status of the executed process.

  • Acquires the execution result
 
 
- (void) onUpdateFirmware(int code, int maxWaitTime);
  • code
    The processing result is stored.

Error status

Description

CODE_SUCCESS

Processed successfully.

CODE_ERR_DIFFERENT_MODEL

The compatible model of the firmware image specified in targetFirmwareInfo differs from the model name of the connected printer.

CODE_ERR_PARAM

An invalid parameter was passed.

CODE_ERR_MEMORY

Necessary memory could not be allocated.

CODE_ERR_CONNECT

No communication with the printer or server.

CODE_ERR_TIMEOUT

Processing did not complete within the specified time period.

CODE_ERR_IO

Could not access the firmware image downloaded from the server.

CODE_ERR_DATA_CORRUPTED

The firmware image is corrupt.

CODE_ERR_PROCESSING

Could not run the process.

CODE_ERR_ILLEGAL

This API was called while no communication had been started.

CODE_ERR_FAILURE

An unknown error occurred.
  • maxWaitTime
    The maximum wait time to complete writing of the firmware image is stored.

Exception

When the process fails, Epos2Exception with one of the following error value occurs.

Error status

Description

ERR_PARAM

An invalid parameter was passed.

ERR_FAILURE

An unknown error occurred.

Supplementary explanation

  • This API can be used in an environment where it can connect to both the Internet and a printer.
  • This API cannot be used simultaneously with other APIs.
    After executing this API, do not execute any other API until the callback is returned.
  • Do not turn off the power supply to the printer while executing this API.
  • Immediately after starting the printer, do not execute this API until the LED is lit.
    Execution takes time, and a timeout error may occur.
  • Communication with the printer disconnects as the printer automatically restarts during execution of this API. Reconnect as necessary.
    In a network environment that uses DHCP, the IP address may change due to restart of the printer.
    In such a case, search for the printer using Discovery class and reconnect.
    When connected via USB, the USB device node may change due to restart of the printer.
    In such a case, search for the printer using Discovery class and reconnect.
  • This API can be used in the system configuration of the TM printer model and customer display model.
    With the system configuration of the TM Printer + DM-D + barcode scanner model, this API can be used when connecting via Bluetooth or USB.
  • This API cannot be used with SSL/TLS communication.
  • Connect to only Printer class when executing this API.
  • When updating the firmware by executing this API, note the following points:
    • The time required to update depends on the interface.
    • About 15 minutes for a network connection
    • About 85 minutes for a Bluetooth connection
    • You cannot stop the update once it has started.
    • Check that the smart device is charged sufficiently.
    • Check that no errors have occurred in the printer.
    • Check that the printer's communication status is in good condition.
    • Do not operate the smart device while updating the firmware.
    • Do not disconnect the connection cable and power cable while updating the firmware.
    • Do not sleep the smart device while updating the firmware.
 

Quick Access

  • [Name]
  • [Format]
  • [Range]
  • [Description]
  • [Notes]
Epson ePOS SDK includes patented or patent pending functions. The contents must not be disclosed to third parties.


Epson ePOS SDK for Android

  1. TOP»
  2. Epson ePOS SDK for Android »
  3. Printer class »
  4. updateFirmware

Jump to the top