react-native-epson-escposprinter

import EventEmitter from "eventemitter3"; import { type CallbackCode } from "./errors"; import type { PrinterAlign, PrinterBarcodeHri, PrinterBarcodeType, PrinterColor, PrinterColorMode, PrinterCompress, PrinterCutType, PrinterFeedPosition, PrinterFirmwareInformation, PrinterFont, PrinterHalftone, PrinterInformation, PrinterLanguage, PrinterLayoutType, PrinterLineStyle, PrinterLocale, PrinterMaintenanceCounterType, PrinterPageDirection, PrinterPulseDrawer, PrinterPulseTime, PrinterSeries, PrinterSettings, PrinterSettingType, PrinterSettingValue, PrinterSoundPattern, PrinterStatus, PrinterStatusChangeEvent, PrinterSymbolLevelPdf, PrinterSymbolLevelQrcode, PrinterSymbolTypeAztecCode, PrinterSymbolTypeOthers, PrinterSymbolTypePdf, PrinterSymbolTypeQrcode } from "./PrinterConst"; /** * Starts communication with the printer. * * @returns A printer instance. */ export declare function connect(series: PrinterSeries, lang: PrinterLocale, target: string, timeout?: number): Promise<Printer>; declare abstract class CommonPrinter extends EventEmitter<{ statusChange: [status: PrinterStatusChangeEvent]; printStatusChange: [ code: CallbackCode, status: PrinterStatus, printJobId?: string ]; updateProgress: [task: string, progress: number]; disconnect: []; }> { static TRUE: number; static FALSE: number; static PARAM_UNSPECIFIED: number; static PARAM_DEFAULT: number; static UNKNOWN: number; static REMOVAL_WAIT_PAPER: number; static REMOVAL_WAIT_NONE: number; static EVENT_RECONNECTING: number; static EVENT_RECONNECT: number; static EVENT_DISCONNECT: number; } export declare class Printer extends CommonPrinter implements AsyncDisposable { #private; static WIFI_SIGNAL_NO: number; static WIFI_SIGNAL_FAIL: number; static WIFI_SIGNAL_GOOD: number; static WIFI_SIGNAL_EXCELLENT: number; static JSON_KEY_PRINTERSPEC_NAME: string; static JSON_KEY_PRODUCT_NAME: string; static JSON_KEY_SERIALNO_NAME: string; static JSON_KEY_MAINTENANCE_NAME: string; static JSON_KEY_THERMALHEAD_NAME: string; static JSON_KEY_N_WARNINGDOT_NAME: string; static JSON_KEY_P_WARNINGDOT_NAME: string; static JSON_KEY_N_BROKENDOT_NAME: string; static JSON_KEY_P_BROKENDOT_NAME: string; static JSON_KEY_SETTING_NWDEVINFO_PASSWORDAUTH_KEY: string; static JSON_KEY_SETTING_NWDEVINFO_ADMINID_KEY: string; static JSON_KEY_SETTING_NWCSAUTH_PASSWORD_KEY: string; static JSON_KEY_SETTING_WIFICFG_WPAPSK_KEY: string; static PREFIX_ENCRYPT: string; static FIRMWARE_MODE_NORMAL: number; static FIRMWARE_MODE_MEMORY_REWRITE: number; static HTTPS_TIMEOUT: number; constructor(id: number); /** * Supports `using` keyword via the Explicit Resource Management proposal. * * The draft needs to reach stage 4 and in turn implemented by Hermes to work, * let's sit back and wait. * * @example * ```ts * await using printer = await connect(ESCPOSConst.CMP_PORT_USB); * ``` * * @see https://github.com/tc39/proposal-explicit-resource-management */ [Symbol.asyncDispose](): Promise<void>; /** * Ends communication with the printer. */ disconnect(): Promise<void>; /** Acquires the current status information. */ getStatus(): Promise<PrinterStatus>; /** * Sends the print command. * * Make sure not to use this API repeatedly without getting the result in the * callback. * * This API sends data buffered by an add-type API (e.g., `addText`). */ sendData(timeout?: number): Promise<void>; /** * Starts a transaction. * * A transaction represents a single printing task such as printing a single * sheet of receipt or coupon. * * After this API is called, data until the transaction is terminated by * `endTransaction` will be regarded as a single printing task. */ beginTransaction(): Promise<void>; /** * Ends a transaction. * * A transaction represents a single printing task such as printing a single * sheet of receipt or coupon. * * After `beginTransaction` is called, data until the transaction is * terminated by this API will be regarded as a single printing task. */ endTransaction(): Promise<void>; /** * Acquires the print result for the specified print job ID. * * - The result of this API is notified to the listener method set by the * `setReceiveEventListener` API of the `Printer` class. * - When multiple print processes were performed with the same print job ID, * the status of the latest print job is acquired. */ requestPrintJobStatus( /** * Specifies the print job ID. * * Alphanumeric characters, underscore, hyphen, and period in 1 to 30 digits * can be used. */ printJobId: string): Promise<void>; /** * Clears the command buffer. * * The contents buffered in the command buffer are retained until this API is * called. */ clearCommandBuffer(): Promise<void>; /** * Adds text alignment setting to the command buffer. * * - Use this API at the "beginning of a line." If this API is used elsewhere, * it will be ignored. * - Setting of this API is also applied to the barcode/2D symbol/raster * image/NV logo. * - When specifying alignment in the page mode, use `addPagePosition` instead * of this API. */ addTextAlign(align?: PrinterAlign): Promise<void>; /** * Adds line spacing setting to the command buffer. * * - If the line spacing for a single line is set smaller than the print * character size, paper may be fed for a larger quantity than the set amount * to ensure proper printing. */ addLineSpace( /** Specifies the line spacing (in dots). */ lineSpace: number): Promise<void>; /** * Adds text rotation setting to the command buffer. * * - Use this API at the "beginning of a line." If this API is used elsewhere, * it will be ignored. * - Setting of this API is also applied to the barcode/2D symbol. * - When specifying text rotation in the page mode, use addPageDirection * instead of this API. */ addTextRotate( /** Specifies the text rotation. */ rotate?: boolean): Promise<void>; /** * Adds a character print command to the command buffer. * * - To print data other than text after printing text, feed a line or page. * A line which does not end with a line feed will be discarded as unfixed * data by the next `sendData`. * - In the page mode, text is printed from the current print position with * the base line dot of the characters as the standard. */ addText( /** * Specifies the string to print. * * Use the following escape sequences for a horizontal tab and line feed. * * | String | Description | * | ------ | :------------------ | * | \t | Horizontal tab (HT) | * | \h | Line feed (LF) | * | \\ | Backslash | */ text: string): Promise<void>; /** * Adds language setting to the command buffer. * * A text string specified by the addText API is encoded according to the * language specified by this API. * * - This API is called before the `addText` API. * - Use this API at the top of each print job. * - Available languages differ depending on character specifications of the * printer. For details, see Technical Reference Guide of the printer. */ addTextLang( /** Specifies the language. */ lang?: PrinterLanguage): Promise<void>; /** * Adds character font setting to the command buffer. */ addTextFont( /** Specifies the font. */ font?: PrinterFont): Promise<void>; /** * Adds smoothing setting to the command buffer. */ addTextSmooth(smooth?: boolean): Promise<void>; /** * Adds character scaling factor setting to the command buffer. * * - If all the parameters are set to "Printer.PARAM_UNSPECIFIED," * ERR_PARAM will be returned. * - For slip, endorsement, or validation printing, an integer from 1 to 2 * can be set for the width and height. */ addTextSize( /** Specifies the width scaling factor. */ width: number, /** Specifies the height scaling factor. */ height: number): Promise<void>; /** * Adds character style setting to the command buffer. * * - Use this API at the "beginning of a line." If this API is used elsewhere, * it will be ignored. */ addTextStyle( /** Specifies the reverse print. */ reverse?: boolean, /** Specifies the underline. */ ul?: boolean, /** Specifies the emphasized print. */ em?: boolean, /** Specifies the color. */ color?: PrinterColor): Promise<void>; /** * Adds horizontal character print start position to the command buffer. * * - Calling this API causes the printer positioned at "other than the * beginning of the line." This is also true even if 0 is set to "X." * - After executing this API, addTextAlign and addTextRotate cannot be used. * - Setting of this API is also applied to the barcode/2D symbol/raster * image/NV logo. * - The setting of this API is applied to each line (Or to each barcode, * 2D symbol, raster image, or NV logo). If you want to apply the setting to * multiple lines, set this API to each of the lines. */ addHPosition( /** Specifies the horizontal position (in dots). */ x: number): Promise<void>; /** * Adds a paper-feed-by-dot command to the command buffer. * * - Calling this API causes the printer positioned at "the beginning of the * line." */ addFeedUnit( /** Specifies the feed amount (in dots). */ unit: number): Promise<void>; /** * Adds a paper-feed-by-line command to the command buffer. * * - Calling this API causes the printer positioned at "the beginning of the * line." */ addFeedLine( /** Specifies the feed amount (in lines). */ line: number): Promise<void>; /** * Adds a raster image print command to the command buffer. * * Prints Android.graphics.Bitmap class graphics. * * A specified area of Android.graphics.Bitmap class graphics is binarized * according to the mode, halftone, and brightness parameters and converted * into a raster image. * * The converted image is compressed or not compressed before transmission * according to the compress parameter value. * * One pixel of an image corresponds to one dot of the printer. When a * transparent color is contained in the image, the background of the image is * assumed to be white. * * - Use this API at the "beginning of a line." If this API is used elsewhere, * it will be ignored. * - If the area specified by x/y and width/height parameters does not fit * within the image size specified by data parameter, ERR_PARAM will be * returned as an exception. * - The "compress" parameter is effective when the printer is connected via * Bluetooth. For other printers, specify Printer.COMPRESS_AUTO. * - Printing may get slower if a transparent image is printed. * - The multi-gradation and the compression of image data are not supported * in the page mode. If you set those in the page mode, nothing will be * printed. * - Set an image size appropriate for the printer. If you set to print a * large image, the API commands will be succeeded, but the printer may * print nothing. * - Even if the size of an image is printable, the ERR_MEMORY error may occur * depending on the Android device specification. In such case, reduce the * image size. * - This API consumes a lot of the buffer provided in the printer. When using * this API for LFCPrinter class, be sure to check the buffer size of the * printer. */ addImage( /** Bitmap data in base64 format. */ image: string, /** Specifies the horizontal start position of the print area (in pixels). */ x: number, /** Specifies the vertical start position of the print area (in pixels). */ y: number, /** Specifies the width (in dots). */ width: number, /** Specifies the height (in dots). */ height: number, /** Specifies the color. */ color?: PrinterColor, /** Specifies the mode. */ mode?: PrinterColorMode, /** * Specifies the halftone. * * Effective for the monochrome (2 scales) color mode only. */ halftone?: PrinterHalftone, /** * Specifies the brightness. * * When a value other than 1.0 is specified for the brightness compensation * value, processing gets slower. */ brightness?: number, /** Specifies the compress. */ compress?: PrinterCompress): Promise<void>; /** * Adds a NV logo print command to the command buffer. * * Prints the logo registered in the NV memory of the printer. * * - Use this API at the "beginning of a line." If this API is used elsewhere, * it will be ignored. * - For how to register the NV logo, refer to the Technical Reference Guide * of the printer. * - The page mode does not support multi-gradation printing. Multi-gradation * graphics can be printed in the standard mode only. * - The NV logo specified by this API is printed with the color setting * specified by addTextStyle buffered in advance. * - TM-U220 and TM-U220II, TM-U330 use only the key1 parameter, however, you * need to set "Printer.PARAM_DEFAULT" as the key2 parameter for those * printers since an empty key2 parameter causes an error. */ addLogo( /** Specifies the key code 1 of the NV logo. */ key1: number, /** Specifies the key code 2 of the NV logo. */ key2?: number): Promise<void>; /** * Adds a barcode print command to the command buffer. * * - Use this API at the "beginning of a line." * - When the barcode data specified in data does not conform to the barcode * type specified in type, an error will not be returned as an exception and * the barcode will not be printed. * - The "CODE 128 auto" type of barcode can be specified when the printer is * TM-m30II, TM-m30II-H, TM-m30II-NT, TMm30II-S, TM-m30II-SL, TM-m30III, * TM-m30III-H, TM-m50, TM-m50II, TM-m50II-H, TM-T88VII, TM-L100, TM-P20II * or TM-P80II. */ addBarcode( /** * Specifies barcode data as a text string. * * When specifying binary data which cannot be represented as a string, use * the following escape sequences. * * | String | Description | * | ------ | :------------------------- | * | \xnn | Hexadecimal control code | * | \\ | Backslash | */ barcode: string, /** Specifies the barcode type. */ type: PrinterBarcodeType, /** Specifies the HRI (Human Readable Interpretation) setting. */ hri: PrinterBarcodeHri, /** Specify the font */ font: PrinterFont, /** Specifies the barcode width (in dots). */ width: number, /** Specifies the barcode height (in dots). */ height: number): Promise<void>; /** * Adds a 2D symbol print command to the command buffer. * * - Use this API at the "beginning of a line." * - When the 2D symbol data specified in data does not conform to the 2D * symbol type specified in type, an error will not be returned as an * exception and the 2D symbol will not be printed. * - During ESC/POS control, specifying values outside the valid ranges for * the width and height parameters results in default value printing. * - During ePOS-Device XML control, specifying values outside the valid * ranges for the width and height parameters causes `sendData` to generate * an exception with ERR_FAILURE. */ addSymbol( /** Specifies the symbol data as a text string. */ symbol: string, type: PrinterSymbolTypePdf, level: PrinterSymbolLevelPdf, width: number, height: number, size: number): Promise<void>; addSymbol(symbol: string, type: PrinterSymbolTypeQrcode, level: PrinterSymbolLevelQrcode, width: number): Promise<void>; addSymbol(symbol: string, type: PrinterSymbolTypeAztecCode, level: number, width: number): Promise<void>; addSymbol(symbol: string, type: PrinterSymbolTypeOthers, level: number, // PARAM_DEFAULT width: number, height: number, size: number): Promise<void>; /** * Adds a horizontal ruled line print command to the command buffer. * * Draws a horizontal ruled line. * * - This API cannot be used in the page mode. * - Use addPageLine to draw a horizontal ruled line in the page mode. */ addHLine(x1: number, x2: number, lineStyle?: PrinterLineStyle): Promise<void>; /** * Adds a command to start drawing a vertical ruled line to the command * buffer. * * Starts drawing a vertical line. * * - This API cannot be used in the page mode. * - Use addPageLine to draw a vertical ruled line in the page mode. * - Drawing of the vertical ruled line continues until stopped by the * `addVLineEnd` API. * - Use this API with the `addVLineEnd` API. */ addVLineBegin( /** Start position to draw a vertical ruled line (in dots) */ x: number, lineStyle?: PrinterLineStyle): Promise<number>; /** * Adds a command to stop drawing a vertical ruled line to the command buffer. * * Ends drawing a vertical line. * * - This API cannot be used in the page mode. * - Use addPageLine to draw a vertical ruled line in the page mode. * - This API draws a vertical ruled line until stopped by `addVLineEnd`. * - Use this API with the `addVLineBegin` API. */ addVLineEnd(lineId: number): Promise<void>; /** * Adds a page mode start command to the command buffer. * * Starts processing in the page mode. * * - The page mode does not support multi-gradation printing. * - Use this API with the `addPageEnd` API. * - Use this API at the "beginning of a line." If this API is used elsewhere, * it will be ignored. */ addPageBegin(): Promise<void>; /** * Adds a page mode end command to the command buffer. * * Ends processing in the page mode. * * - The page mode does not support multi-gradation printing. * - Use this API with the `addPageBegin` API. */ addPageEnd(): Promise<void>; /** * Adds page mode print area setting to the command buffer. * * Specifies the page mode print area (coordinates). Following this API, call * an API to specify print data such as the `addText` API. * * - Define the print area in accordance with the contents to print. If the * print data does not fit within the print area, the printed contents will * be truncated. * - Use this API between the `addPageBegin` and `addPageEnd` APIs. * - Specify the width and height of the print area in accordance with the * print direction setting. Otherwise the print data may be truncated. Set * the print direction by `addPageDirection`. * - This API does not work in the standard mode. */ addPageArea( /** Specifies the horizontal start position of the print area (in dots). */ x: number, /** Specifies the vertical start position of the print area (in dots). */ y: number, /** Specifies the width of a print area (in dots). */ width: number, /** Specifies the height of a print area (in dots). */ height: number): Promise<void>; /** * Adds page mode print direction setting to the command buffer. * * Specifies the print direction in the page mode. * * - This API does not work in the standard mode. * - Use this API between the `addPageBegin` and `addPageEnd` APIs. */ addPageDirection( /** Specifies the print direction. */ direction?: PrinterPageDirection): Promise<void>; /** * Adds print position setting within the print area in the page mode to the * command buffer. * * Specifies the print start position (coordinates) within the area specified * by the `addPageArea` API. * * - This API does not work in the standard mode. * - Use this API between the `addPageBegin` and `addPageEnd` APIs. * - Specify the print start position (coordinates) in accordance with the * contents to print. */ addPagePosition( /** Specifies the horizontal start position of the print area (in dots). */ x: number, /** Specifies the vertical start position of the print area (in dots). */ y: number): Promise<void>; /** * Adds a page mode line draw command to the command buffer. * * Draws a line in the page mode. * * - This API does not work in the standard mode. * - A diagonal line cannot be drawn. * - Use this API between the `addPageBegin` and `addPageEnd` APIs. */ addPageLine(x1: number, y1: number, x2: number, y2: number, style?: PrinterLineStyle): Promise<void>; /** * Adds a page mode rectangle draw command to the command buffer. * * Draws a rectangle in the page mode. * * - This API does not work in the standard mode. * - Use this API between the `addPageBegin` and `addPageEnd` APIs. */ addPageRectangle(x1: number, y1: number, x2: number, y2: number, style?: PrinterLineStyle): Promise<void>; /** * Adds the start batch rotate print mode to the command buffer. * * - This API does not work in the page mode. * - Use the add APIs for batch rotate printing (Example: `addText`) by * enclosing between this API and the `addRotateEnd` API. * - Do not use the following APIs between this API and the `addRotateEnd` API. * - `endTransaction` * - `addPageBegin` * - `addPageEnd` * - `addCut` * - `addPulse` * - `addSound` * - `setPrinterSetting` * - `ejectPaper` * - The data volume that the printer can process in a single batch rotate * printing is as described below. * - Strings: 80 lines * - Graphics: 2400 dots * - When you are using the add APIs (Example: `addText`) in the batch rotate * print mode, you must take care while using certain APIs. * - `addTextSize` * - If the longitudinal direction is set to triple angle or higher with * `addTextSize` before this API, then this API and the succeeding APIs * will become double-angled. * - If the longitudinal direction is set to triple angle or higher with * `addTextSize` after this API, then the specification in the * longitudinal direction will be ignored and become single-angled. * - `addFeedUnit` * - The number of paper feed lines varies depending on the line spacing * specified in `addLineSpace`. If the line spacing is specified as 30 * in `addLineSpace`, paper feeding can be performed for 8 lines with * the maximum value of `addFeedUnit` as 255. * - `addImage` * - If the total vertical size of print data exceeds 2400 dots, printing * may not be performed as intended. For example, if 500-dot data B is * sent to a location in the printer buffer where 2000-dot data A is * accumulated, then data B will be accumulated in the printer buffer * after data A has been printed. * - The multi-gradation (16 scales) maximum size is up to 600 dots * vertically. In the case of multi-gradation (16 scales), a data volume * that is four times that of monochrome (2 scales) is required. * - If the vertical size of one image element exceeds the data volume * that can be processed in one go, printing will not be performed. * - Monochrome (2 scales) maximum value: 2400 dots * - Multi-gradation (16 scales) maximum value: 600 dots */ addRotateBegin(): Promise<void>; /** * Adds the end batch rotate print mode to the command buffer. * * - This API does not work in the page mode. * - Use the add APIs for batch rotate printing (Example: addText) by * enclosing between this API and the `addRotateBegin` API. */ addRotateEnd(): Promise<void>; /** * Adds a sheet cut command to the command buffer. * * Sets how to cut paper. * * - This API cannot be used in the page mode. * - Use this API at the "beginning of a line." If this API is used elsewhere, * it will be ignored. * - If print data is not specified after the cut reservation * (Printer.CUT_RESERVE), the printer will execute the cut after feeding * paper up to the position of the reserved cut. * - Depending on the printer, it may wait approximately 2 seconds for the * print data after the cut reservation (Printer.CUT_RESERVE) before * starting the paper feed operation. * - When using the cut reservation (Printer.CUT_RESERVE), set the length of * one receipt to at least 20 mm. */ addCut( /** Specifies the cut type. */ type?: PrinterCutType): Promise<void>; /** * Adds a drawer kick command to the command buffer. * * Sets the drawer kick. * * - This API cannot be used in the page mode. * - The drawer and optional external buzzer cannot be connected * simultaneously. * - Do not open the drawer repeatedly for a short time. The drawer may be * damaged due to too much load. * - For built-in buzzer equipped models of the following printers, sounding * the buzzer is possible using the pulse output commands for drawer kick * connectors. For details on controlling the built-in buzzer, refer to the * Technical Reference Guide of the printer. TM-T70 / TM-T70II / TM-T82II / * TM-T82III / TM-T83II / TM-T88IV / TM-T88V / TM-T88VI / TM-T88VII / * TM-T82II-i / TM-T83II-i / TM-T88VI-iHUB / TM-L90 / TM-L100 */ addPulse( /** Specifies the drawer kick connector number. */ drawer?: PrinterPulseDrawer, /** Specifies the on time (in milliseconds). */ time?: PrinterPulseTime): Promise<void>; /** * Adds buzzer sound setting to the command buffer. * * Sets the buzzer. * * - This API cannot be used in the page mode. * - The drawer and optional external buzzer cannot be connected simultaneously. * - This API cannot be used if the printer is not equipped with a buzzer. * - The timing to receive the callback of sendData API varies by printer. * - Mobile models: after the `sendData` API is executed. * - Other than Mobile models: after the buzzer sounding is finished. * - For built-in buzzer equipped models of the following printers, sounding * the buzzer is possible using `addPulse`. * TM-T70 / TM-T70II / TM-T82II / TM-T82III / TM-T83II / TM-T88IV / TM-T88V * / TM-T88VI / TM-T88VII / TM-T82II-i / TM-T83II-i / TM-T88VI-iHUB / TM-L90 * / TM-L100 */ addSound( /** Specifies the sound pattern. */ pattern?: PrinterSoundPattern, /** Specifies the repeat count. 0 = Unlimited */ repeat?: number, /** Effective for Patterns 1 to 10 only. */ cycle?: number): Promise<void>; /** * Adds a label sheet/black mark sheet feed command to the command buffer. * * - The label sheet/black mark sheet can be controlled in the standard mode. * - This API cannot be used in the page mode. * - Use this API at the "beginning of a line." If this API is used elsewhere, * it will be ignored. */ addFeedPosition(position: PrinterFeedPosition): Promise<void>; /** * Adds layout setting of the label sheet/black mark sheet to the command * buffer. * * - This API does not work in the page mode. * - Use this API at the "beginning of a line." If this API is used elsewhere, * it will be ignored. * - Available setting values vary by TM printer model. For more details, see * the FS (L<Function 33> command. * https://support.epson.net/publist/reference_en/ * - The available parameter values for each type of paper are listed below. * The following table shows available values for TM printer models, and * shows those for POS terminal models in parentheses. */ addLayout( /** Specifies the paper type. */ type: PrinterLayoutType, /** Specifies the paper width (in 0.1 mm units). */ width: number, /** * Specifies the distance from the print reference mark to the next print * reference mark (in 0.1mm units). */ height: number, /** * Specifies the distance from the print reference mark to the top of the * sheet (in 0.1mm units). */ marginTop: number, /** * Specifies the distance from the eject reference mark to the bottom edge * of the printable area (in 0.1mm units). */ marginBottom: number, /** * Specifies the distance from the eject reference mark to the cut position * (in 0.1mm units). */ offsetCut: number, /** * Specifies the distance from the eject reference mark to the bottom edge * of the label (in 0.1mm units). */ offsetLabel: number): Promise<void>; /** * Adds a command to the command buffer. * * Sends the ESC/POS command. * * - Refer to the following URL for details of the ESC/POS command. * https://support.epson.net/publist/reference_en/ * * - Epson ePOS SDK does not check the commands sent using this API. * * If the commands interfere with Epson ePOS SDK operations, other APIs may * work wrongly or status values may become invalid. * * This API should be used with a full understanding of ESC/POS commands and * the receipt printer specifications. */ addCommand(command: string): Promise<void>; /** * Acquires the value of the printer's maintenance counter. */ getMaintenanceCounter(type: PrinterMaintenanceCounterType, timeout?: number): Promise<number>; /** * Resets the value of the printer's maintenance counter. * * The value acquired by this API is notified to the listener method specified * in the listener parameter. */ resetMaintenanceCounter(type: PrinterMaintenanceCounterType, timeout?: number): Promise<void>; /** * Acquires the set value of the printer setting. * * The value acquired by this API is notified to the listener method specified * in the listener parameter. */ getPrinterSetting(type: PrinterSettingType, timeout?: number): Promise<PrinterSettingValue>; /** * Changes the set value of the printer setting. * * The value acquired by this API is notified to the listener method specified * in the listener parameter. */ setPrinterSetting(settings: Record<PrinterSettingType, PrinterSettingValue>, timeout?: number): Promise<void>; /** * Acquires the set value of the printer setting in JSON format. */ getPrinterSettingEx(timeout?: number): Promise<PrinterSettings>; /** * Changes the set value of the printer setting in JSON format. * * For the JSON used in this API, use the printer information JSON acquired * with the getPrinterSettingEx API. * * Do not use the printer information JSON acquired from another model. * * Before executing the API, you can execute the verifyPassword API to make * sure this API uses the correct password. * * Execute the getPrinterSettingEx API after executing this API, and check * that the printer settings have been changed correctly. * * This API error status is the API processing result. * * The processing result of the devices using this API is notified to the * listener method set by the `setSetPrinterSettingExListener` API of the * Printer class. * * Do not execute this API in continuation without checking the processing * result with the callback method. */ setPrinterSettingEx( /** * Specifies the set value of the printer setting in JSON format. * * Refer to JSON_Spec_sheet_revx.pdf included in the package for more * information. */ settings: PrinterSettings["Setting"], password: string, timeout?: number): Promise<void>; /** * Compare the character string specified in this API with the administrator * password set in the printer. Check to see if the specified character string * and administrator password match. * * This API error status is the API processing result. * * The processing result of the devices using this API is notified to the * listener method set by the `setVerifyPasswordListener` API of the Printer * class. * * Do not execute this API in continuation without checking the processing * result with the callback method. */ verifyPassword(password: string, timeout?: number): Promise<CallbackCode>; /** * Acquires the printer serial number and the missing dot information of the * thermal head. * * The value acquired by this API is notified to the listener method specified * in the listener parameter. */ getPrinterInformation(timeout?: number): Promise<PrinterInformation>; /** * Acquires the firmware information for the connected printer. */ getPrinterFirmwareInfo(timeout?: number): Promise<PrinterFirmwareInformation>; /** * Compares the firmware of the connected printer with the firmware image * specified by `updateFirmware`. * * Execute this API after executing `updateFirmware`, and confirm that the * printer firmware has been overwritten by the firmware image specified in * `updateFirmware`. * * The processing result of this API is notified to the listener method * specified in the listener parameter. */ verifyUpdate(targetFirmwareInfo: PrinterFirmwareInformation): Promise<number>; downloadFirmwareList(printerModel: string, option: string): Promise<PrinterFirmwareInformation[]>; /** * 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. * * @returns The maximum waiting time for the firmware update */ updateFirmware(firmwareInfo: PrinterFirmwareInformation): Promise<number>; /** * Forcibly sends the error recovery command from a recoverable error status * (example: auto cutter error). * * For details on recoverable errors, refer to the Technical Reference Guide * of each printer. * * - After recovering from a recoverable error, the buffer of the printer is * reset. * - For TM-H6000V, the “Command execution during offline” setting must be * enabled. \ * Refer to TM-H6000V Utility User’s Manual for more information. * - Available during ePOS-Device XML control. */ forceRecover(timeout?: number): Promise<void>; /** * Forcibly sends the drawer kick command. * * - The drawer and optional external buzzer cannot be connected * simultaneously. * - For TM-H6000V, the “Command execution during offline” setting must be * enabled. \ * Refer to TM-H6000V Utility User’s Manual for more information. * - Available during ePOS-Device XML control. */ forcePulse(drawer: PrinterPulseDrawer, time?: PrinterPulseTime, timeout?: number): Promise<void>; /** * Forcibly sends the buzzer sound command. * * - The drawer and optional external buzzer cannot be connected * simultaneously. * - For TM-H6000V, the “Command execution during offline” setting must be * enabled. \ * Refer to TM-H6000V Utility User’s Manual for more information. * - Available during ePOS-Device XML control. */ forceStopSound(timeout?: number): Promise<void>; /** * Forcibly sends the ESC/POS command. * * - For TM-H6000V, the “Command execution during offline” setting must be * enabled. \ * Refer to TM-H6000V Utility User’s Manual for more information. * - Available during ePOS-Device XML control. */ forceCommand( /** Base64 encoded byte[] */ data: string, timeout?: number): Promise<void>; /** * Forcibly sends the printer reset command. * * - For TM-H6000V, the “Command execution during offline” setting must be * enabled. \ * Refer to TM-H6000V Utility User’s Manual for more information. * - Available during ePOS-Device XML control. */ forceReset(timeout?: number): Promise<void>; /** * Sending print data in the callback as a single transaction. */ transaction(callback: (printer: Printer) => Promise<void>): Promise<void>; /** * Sending print data in the callback as a single rotate batch. */ rotate(callback: (printer: Printer) => Promise<void>): Promise<void>; /** * Sending print data in the callback as a single page. */ page(callback: (printer: Printer) => Promise<void>): Promise<void>; } export {}; //# sourceMappingURL=Printer.d.ts.map