cap-label-printer-plugin
v1.4.2
Published
A capacitor plugin for integrating with any label printer
Downloads
17
Readme
cap-label-printer-plugin
An capacitor plugin for integrating with any label printer
Install
npm install cap-label-printer-plugin
npx cap sync
API
printEPL(...)
printEPL(opts: EPLPrintingOptions) => Promise<void>
Print a label using EPL commands to a specific printer.
| Param | Type | Description |
| ---------- | ----------------------------------------------------------------- | -------------------------------------------------------------------------- |
| opts
| EPLPrintingOptions | - The printing options, including printer name, address, and EPL commands. |
printTestPage(...)
printTestPage(opts: TestPagePrintingOptions) => Promise<void>
Print a self test page to a specified printer.
| Param | Type | Description |
| ---------- | --------------------------------------------------------------------------- | ---------------------------------------------------------- |
| opts
| TestPagePrintingOptions | - The printing options, including printer name and address |
discover()
discover() => Promise<PrinterDevices>
Discover available label printer devices.
Returns: Promise<PrinterDevices>
Interfaces
EPLPrintingOptions
Represents the options for printing using the EPL (Eltron Programming Language) commands.
| Prop | Type | Description |
| ------------- | ------------------- | ----------------------------------------------------------------- |
| name
| string | The name of the printer to use. |
| address
| string | The network address, device ID, or connection URL of the printer. |
| data
| string | The EPL commands to send to the printer for printing. |
TestPagePrintingOptions
Represents the options for printing a self test page.
| Prop | Type | Description |
| ------------- | ------------------- | ----------------------------------------------------------------- |
| name
| string | The name of the printer to use. |
| address
| string | The network address, device ID, or connection URL of the printer. |
PrinterDevices
Represents a collection of printer devices.
| Prop | Type | Description |
| ------------- | ---------------------------- | ---------------------------- |
| devices
| PrinterDevice[] | An array of printer devices. |
PrinterDevice
Represents a printer device with its name, address, and port information.
| Prop | Type | Description |
| ------------- | ------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------- |
| name
| string | The name or model of the printer device. |
| address
| string | The network address, device ID, or connection URL of the printer. |
| port
| 'USB' | 'NET' | 'BT' | 'Browser' | The port protocol used to communicate with the printer. Should be one of "USB", "NET", "BT" (for Bluetooth), or "Browser" |