1. TOP»
  2. Epson ePOS SDK for iOS »
  3. Epos2Printer class »
  4. updateFirmware

Select your printer model

Parameters are refined by the selected printer.

updateFirmware

Downloads the firmware image from the server, and instructs writing of the firmware image to the printer.

Execute verifyUpdate after executing this API, and make sure the printer firmware has been rewritten to the specified firmware image.

The return value of this API is the result of execution of the instruction to write the firmware image to the printer. It is not the execution result of the overall firmware update.

The progress or execution result of this API is notified to the callback method specified in the delegate parameter.

Syntax

 
 
- (int) updateFirmware: (Epos2FirmwareInfo *) targetFirmwareInfo
delegate: (id<Epos2FirmwareUpdateDelegate>) delegate;

Parameter

targetFirmwareInfo

Specifies the firmware image of the version to be applied to the printer from the list acquired in downloadFirmwareList.

delegate

Registers the callback method that returns the progress or execution result of this API.

  • Acquires the progress status
 
 
- (void) onFirmwareUpdateProgress:(NSString *)task progress:(float)progress;
  • task
    The name of the process being executed is stored.

  • Name

    Description

    Prepare

    Preparing.

    Download Firmware

    Downloading the firmware image from the server.

    Sending firmware image

    Sending the downloaded firmware image to the printer.
  • progress
    A value from 0.0 to 1.0 is stored depending on the progress of the process being executed.

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

Error status

Description

EPOS2_CODE_SUCCESS

Processed successfully.

EPOS2_CODE_ERR_DIFFERENT_MODEL

The corresponding model of the firmware image specified in targetFirmwareInfo, and the model name of the connected printer are different.

EPOS2_CODE_ERR_PARAM

An invalid parameter was passed.

EPOS2_CODE_ERR_MEMORY

Necessary memory could not be allocated.

EPOS2_CODE_ERR_CONNECT

Failed to communicate with the printer or the server.

EPOS2_CODE_ERR_TIMEOUT

The process did not end within the specified time period.

EPOS2_CODE_ERR_DATA_CORRUPTED

The firmware image is corrupted.

EPOS2_CODE_ERR_PROCESSING

Could not run the process.

EPOS2_CODE_ERR_ILLEGAL

This API was called while no communication had been started.

EPOS2_CODE_ERR_FAILURE

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

Return value

Error status

Description

EPOS2_SUCCESS

The function was executed successfully.

EPOS2_ERR_PARAM

An invalid parameter was passed.

EPOS2_ERR_FAILURE

An unknown error occurred.

Supplementary explanation

  • This API can be used in an environment that can be connected to both the Internet and the 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 Epos2Discovery 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.
  • Since it takes time to send and receive large amounts of data over BLE connection, this API cannot be used with BLE connection.
  • 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 iOS

  1. TOP»
  2. Epson ePOS SDK for iOS »
  3. Epos2Printer class »
  4. updateFirmware

Jump to the top