@captureid/capacitor-cidprint 0.2.64 → 5.0.1

package/README.md

@@ -1,8 +1,85 @@
-[![appcenterbanner](https://captureid.de/wp-content/uploads/2020/03/capID.png)](https://www.captureid.de/)
+[![appcenterbanner](https://www.captureid.de/wp-content/uploads/2020/12/captureid_logo-1.svg)](https://www.captureid.de/)
 
-# Ionic Capacitor Plugin for Mobile Print
+# Ionic Capacitor 5 Plugin for Mobile Print
+
+This plugin enables you to use the CaptureID Printer Library and to easily integrate Bluetooth printing into your app(s).
+
+## Release Notes
+### version 5.0.1
+new:
+    
+  #### switch to capacitor 5
+
+
+### version 0.0.94
+new:
+
+  #### Device class changed vendorname and printermodel to optional values
+  #### Font change for SATO MB200i
+  #### character spacing for PW208NX removed
+
+  
+### version 0.0.93
+new:
+
+```typescript
+  discoverDevices(options: {timeout: number});
+```
+  #### timout parameter added to discover method
+
+  #### connect result:
+  connecteddevice now contains vendor name and printer model
+
+  enums and methods to extract vendor and model from result.
+
+
+### version 0.0.92
+fixed:
+
+#### setupMediaSize does not return result for SATO printers
+
+### version 0.0.91
+new:
+
+```typescript
+  getPrinterInformation(): Promise<CIDPrinterInformation>;
+```
+  #### retrieve detailed information of the printer
+---
+### version 0.0.90
+new:
+
+```typescript
+  enableClipping(options: {enable: boolean}): void;
+```
+  #### enable/disable clipping (prevents Honeywell/Intermec printer from displaying "Field out of Label" messages)
+---
+### version 0.0.89
+  
+  new:
+  
+  ```typescript
+  enableBluetoothAdapter(options {enable: boolean}): Promise<PrinterLibraryEvent>;
+  ```
+  #### enable/disable Bluetooth adapter
+  ---
+  ```typescript  
+  enableCalibration(options: {enable: boolean}): void
+  ```
+  #### trigger sensor calibration (Honeywell/Intermec printers)
+  ---
+  ```typescript
+  getMediaSize(): Promise<MediaSize>;
+  ```
+  #### request the media size currently set
+  ---
+  isBluetoothAdapterEnabled(): Promise<{result: boolean}>;
+  #### check if bluetoothadapter is enabled
+  ---
+  sendFormFeed(): void;
+  #### send a Formfeed request to the printer
+  ---
 
-This plugin provides the ability to use the CaptureID Printer Library to easily integrate Bluetooth printing into your app(s).
 
 <!-- Capacitor Catalog -->
 
@@ -22,15 +99,15 @@ After this period you must request a valid license key. This license must be pur
 
 ## How does it work?
 
-The CaptureID Printer Plugin can be used in Ionic Capacitor app's to support label printing on SATO mobile Printers (MB200i, PW208nx).
-It enables you to easily scan for SATO Bluetooth Printers, connect to an selected printer or the last connected printer.
+The CaptureID Printer Plugin can be used in Ionic Capacitor app's to support label printing on SATO mobile Printers (i.e. MB200i, PW208nx), SATO Desktop Printers (i.e. CT4LX), Honeywell Printers that supports Fingerprint Language and a wide range of ZEBRA Printers (mobile and Desktop Models).
+It enables you to easily scan for Bluetooth Printers, connect to an selected printer or the last connected printer.
 
 ## Getting Started
 
 Install the plugin into your existing project by running the command
 
 ```shell
-npm install capacitor-cidprint@latest
+npm install @captureid/capacitor3-cidprint@latest
 ```
 run the build command to integrate the plugin code and it's libraries into your android project and to open the project in Android Studio
 
@@ -38,21 +115,15 @@ run the build command to integrate the plugin code and it's libraries into your
 ionic capacitor run android
 ``` 
 
-insert the line "add(CIDPrint.class);" into the app's main activity file.
+Note:
+In case of an error during the build process stating cidprintlibrary and/or supportv1 can't be found you have to add the following entry into your apps build.gradle file to ensure the required files can be found.
 
-```java
-  public void onCreate(Bundle savedInstanceState) {
-    super.onCreate(savedInstanceState);
-
-    // Initializes the Bridge
-    this.init(savedInstanceState, new ArrayList<Class<? extends Plugin>>() {{
-      // Additional plugins you've installed go here
-      // Ex: add(TotallyAwesomePlugin.class);
-      add(CIDPrint.class);
-    }});
-  }
-
-```
+repositories {
+    mavenLocal()
+    maven {
+        url("$rootDir/../node_modules/@captureid/capacitor3-cidprint/android")
+    }
+}
 
 ## Plugin Usage
 
@@ -94,6 +165,724 @@ In case of the app is missing some permissions the EventType of the struct is se
 
 #
 
+<docgen-api>
+<!--Update the source file JSDoc comments and rerun docgen to update the docs below-->
+
+### activateLicense(...)
+
+```typescript
+activateLicense(options: { licenseKey: string; customerID: string; }) => Promise<PrinterLibraryEvent>
+```
+
+| Param         | Type                                                     |
+| ------------- | -------------------------------------------------------- |
+| **`options`** | <code>{ licenseKey: string; customerID: string; }</code> |
+
+**Returns:** <code>Promise&lt;<a href="#printerlibraryevent">PrinterLibraryEvent</a>&gt;</code>
+
+--------------------
+
+
+### closeCIDPrinterLib()
+
+```typescript
+closeCIDPrinterLib() => void
+```
+
+--------------------
+
+
+### connectToPreferredPrinter(...)
+
+```typescript
+connectToPreferredPrinter(options: { mac: string; }) => void
+```
+
+| Param         | Type                          |
+| ------------- | ----------------------------- |
+| **`options`** | <code>{ mac: string; }</code> |
+
+--------------------
+
+
+### connectToPreferredPrinter(...)
+
+```typescript
+connectToPreferredPrinter(options: { mac: string; autoreconnect: boolean; }) => void
+```
+
+| Param         | Type                                                  |
+| ------------- | ----------------------------------------------------- |
+| **`options`** | <code>{ mac: string; autoreconnect: boolean; }</code> |
+
+--------------------
+
+
+### connectToPrinter(...)
+
+```typescript
+connectToPrinter(options: { address: string; }) => void
+```
+
+| Param         | Type                              |
+| ------------- | --------------------------------- |
+| **`options`** | <code>{ address: string; }</code> |
+
+--------------------
+
+
+### connectToPrinter(...)
+
+```typescript
+connectToPrinter(options: { address: string; autoreconnect: boolean; }) => void
+```
+
+| Param         | Type                                                      |
+| ------------- | --------------------------------------------------------- |
+| **`options`** | <code>{ address: string; autoreconnect: boolean; }</code> |
+
+--------------------
+
+
+### connectToPrinter(...)
+
+```typescript
+connectToPrinter(options: { address: string; port: number; }) => void
+```
+
+| Param         | Type                                            |
+| ------------- | ----------------------------------------------- |
+| **`options`** | <code>{ address: string; port: number; }</code> |
+
+--------------------
+
+
+### convert(...)
+
+```typescript
+convert(options: { label: string; }) => void
+```
+
+| Param         | Type                            |
+| ------------- | ------------------------------- |
+| **`options`** | <code>{ label: string; }</code> |
+
+--------------------
+
+
+### disconnectFromPrinter(...)
+
+```typescript
+disconnectFromPrinter(options: { mac: string; }) => void
+```
+
+| Param         | Type                          |
+| ------------- | ----------------------------- |
+| **`options`** | <code>{ mac: string; }</code> |
+
+--------------------
+
+
+### discoverDevices(...)
+
+```typescript
+discoverDevices(options: { timeout: number; }) => void
+```
+
+| Param         | Type                              |
+| ------------- | --------------------------------- |
+| **`options`** | <code>{ timeout: number; }</code> |
+
+--------------------
+
+
+### enableBluetoothAdapter(...)
+
+```typescript
+enableBluetoothAdapter(options: { enable: boolean; }) => Promise<PrinterLibraryEvent>
+```
+
+| Param         | Type                              |
+| ------------- | --------------------------------- |
+| **`options`** | <code>{ enable: boolean; }</code> |
+
+**Returns:** <code>Promise&lt;<a href="#printerlibraryevent">PrinterLibraryEvent</a>&gt;</code>
+
+--------------------
+
+
+### enableBluetoothPrinting(...)
+
+```typescript
+enableBluetoothPrinting(options: { enable: boolean; }) => void
+```
+
+| Param         | Type                              |
+| ------------- | --------------------------------- |
+| **`options`** | <code>{ enable: boolean; }</code> |
+
+--------------------
+
+
+### enableCalibration(...)
+
+```typescript
+enableCalibration(options: { enable: boolean; }) => void
+```
+
+| Param         | Type                              |
+| ------------- | --------------------------------- |
+| **`options`** | <code>{ enable: boolean; }</code> |
+
+--------------------
+
+
+### enableClipping(...)
+
+```typescript
+enableClipping(options: { enable: boolean; }) => void
+```
+
+| Param         | Type                              |
+| ------------- | --------------------------------- |
+| **`options`** | <code>{ enable: boolean; }</code> |
+
+--------------------
+
+
+### enableDebugToFile(...)
+
+```typescript
+enableDebugToFile(options: { enable: boolean; }) => void
+```
+
+| Param         | Type                              |
+| ------------- | --------------------------------- |
+| **`options`** | <code>{ enable: boolean; }</code> |
+
+--------------------
+
+
+### enableDispendingMode(...)
+
+```typescript
+enableDispendingMode(options: { enable: boolean; }) => void
+```
+
+| Param         | Type                              |
+| ------------- | --------------------------------- |
+| **`options`** | <code>{ enable: boolean; }</code> |
+
+--------------------
+
+
+### enableNetworkPrinting(...)
+
+```typescript
+enableNetworkPrinting(options: { enable: boolean; }) => void
+```
+
+| Param         | Type                              |
+| ------------- | --------------------------------- |
+| **`options`** | <code>{ enable: boolean; }</code> |
+
+--------------------
+
+
+### getLatestConnectState()
+
+```typescript
+getLatestConnectState() => Promise<PrinterLibraryEvent>
+```
+
+**Returns:** <code>Promise&lt;<a href="#printerlibraryevent">PrinterLibraryEvent</a>&gt;</code>
+
+--------------------
+
+
+### getMediaSize()
+
+```typescript
+getMediaSize() => Promise<MediaSize>
+```
+
+**Returns:** <code>Promise&lt;<a href="#mediasize">MediaSize</a>&gt;</code>
+
+--------------------
+
+
+### getPairedDevices()
+
+```typescript
+getPairedDevices() => void
+```
+
+--------------------
+
+
+### getPrinterInformation()
+
+```typescript
+getPrinterInformation() => Promise<CIDPrinterInformation>
+```
+
+**Returns:** <code>Promise&lt;<a href="#cidprinterinformation">CIDPrinterInformation</a>&gt;</code>
+
+--------------------
+
+
+### getPrinterLibraryVersion()
+
+```typescript
+getPrinterLibraryVersion() => Promise<string>
+```
+
+**Returns:** <code>Promise&lt;string&gt;</code>
+
+--------------------
+
+
+### getPrinterStatus()
+
+```typescript
+getPrinterStatus() => void
+```
+
+--------------------
+
+
+### initCIDPrinterLib()
+
+```typescript
+initCIDPrinterLib() => Promise<PrinterLibraryEvent>
+```
+
+**Returns:** <code>Promise&lt;<a href="#printerlibraryevent">PrinterLibraryEvent</a>&gt;</code>
+
+--------------------
+
+
+### isBluetoothAdapterEnabled()
+
+```typescript
+isBluetoothAdapterEnabled() => Promise<{ result: boolean; }>
+```
+
+**Returns:** <code>Promise&lt;{ result: boolean; }&gt;</code>
+
+--------------------
+
+
+### isLibraryInitialized()
+
+```typescript
+isLibraryInitialized() => Promise<{ result: boolean; }>
+```
+
+**Returns:** <code>Promise&lt;{ result: boolean; }&gt;</code>
+
+--------------------
+
+
+### printData(...)
+
+```typescript
+printData(options: { data: string; }) => void
+```
+
+| Param         | Type                           |
+| ------------- | ------------------------------ |
+| **`options`** | <code>{ data: string; }</code> |
+
+--------------------
+
+
+### printLabel(...)
+
+```typescript
+printLabel(options: { label: string; }) => void
+```
+
+| Param         | Type                            |
+| ------------- | ------------------------------- |
+| **`options`** | <code>{ label: string; }</code> |
+
+--------------------
+
+
+### printLabelWithData(...)
+
+```typescript
+printLabelWithData(options: { label: string; data: string[]; }) => void
+```
+
+| Param         | Type                                            |
+| ------------- | ----------------------------------------------- |
+| **`options`** | <code>{ label: string; data: string[]; }</code> |
+
+--------------------
+
+
+### printLabelWithObject(...)
+
+```typescript
+printLabelWithObject(options: { label: string; data: TicketData; }) => void
+```
+
+| Param         | Type                                                                        |
+| ------------- | --------------------------------------------------------------------------- |
+| **`options`** | <code>{ label: string; data: <a href="#ticketdata">TicketData</a>; }</code> |
+
+--------------------
+
+
+### printNativeData(...)
+
+```typescript
+printNativeData(options: { data: string; }) => void
+```
+
+| Param         | Type                           |
+| ------------- | ------------------------------ |
+| **`options`** | <code>{ data: string; }</code> |
+
+--------------------
+
+
+### printReferenceLabel(...)
+
+```typescript
+printReferenceLabel(options: { labeltype: ReferenceTicketType; }) => void
+```
+
+| Param         | Type                                                                                |
+| ------------- | ----------------------------------------------------------------------------------- |
+| **`options`** | <code>{ labeltype: <a href="#referencetickettype">ReferenceTicketType</a>; }</code> |
+
+--------------------
+
+
+### requestPermission(...)
+
+```typescript
+requestPermission(options: { permission: string; }) => Promise<{ result: boolean; }>
+```
+
+| Param         | Type                                 |
+| ------------- | ------------------------------------ |
+| **`options`** | <code>{ permission: string; }</code> |
+
+**Returns:** <code>Promise&lt;{ result: boolean; }&gt;</code>
+
+--------------------
+
+
+### requestAllPermissions(...)
+
+```typescript
+requestAllPermissions(options: { permissions: string[]; }) => Promise<{ result: boolean; }>
+```
+
+| Param         | Type                                    |
+| ------------- | --------------------------------------- |
+| **`options`** | <code>{ permissions: string[]; }</code> |
+
+**Returns:** <code>Promise&lt;{ result: boolean; }&gt;</code>
+
+--------------------
+
+
+### sendFormFeed()
+
+```typescript
+sendFormFeed() => void
+```
+
+--------------------
+
+
+### setAutoReconnect(...)
+
+```typescript
+setAutoReconnect(options: { autoreconnect: boolean; }) => void
+```
+
+| Param         | Type                                     |
+| ------------- | ---------------------------------------- |
+| **`options`** | <code>{ autoreconnect: boolean; }</code> |
+
+--------------------
+
+
+### setConfiguration(...)
+
+```typescript
+setConfiguration(options: { config: PrinterConfiguration; }) => void
+```
+
+| Param         | Type                                                                               |
+| ------------- | ---------------------------------------------------------------------------------- |
+| **`options`** | <code>{ config: <a href="#printerconfiguration">PrinterConfiguration</a>; }</code> |
+
+--------------------
+
+
+### setupMediaSize(...)
+
+```typescript
+setupMediaSize(options: { width: number; height: number; }) => void
+```
+
+| Param         | Type                                            |
+| ------------- | ----------------------------------------------- |
+| **`options`** | <code>{ width: number; height: number; }</code> |
+
+--------------------
+
+
+### showNavigationBar(...)
+
+```typescript
+showNavigationBar(options: { show: boolean; }) => void
+```
+
+| Param         | Type                            |
+| ------------- | ------------------------------- |
+| **`options`** | <code>{ show: boolean; }</code> |
+
+--------------------
+
+
+### showSettings(...)
+
+```typescript
+showSettings(options: { show: boolean; }) => void
+```
+
+| Param         | Type                            |
+| ------------- | ------------------------------- |
+| **`options`** | <code>{ show: boolean; }</code> |
+
+--------------------
+
+
+### showUI(...)
+
+```typescript
+showUI(options: { show: boolean; }) => void
+```
+
+| Param         | Type                            |
+| ------------- | ------------------------------- |
+| **`options`** | <code>{ show: boolean; }</code> |
+
+--------------------
+
+
+### uploadFile(...)
+
+```typescript
+uploadFile(options: { file: string; filetype: number; }) => void
+```
+
+| Param         | Type                                             |
+| ------------- | ------------------------------------------------ |
+| **`options`** | <code>{ file: string; filetype: number; }</code> |
+
+--------------------
+
+
+### addListener(string, ...)
+
+```typescript
+addListener(eventName: string, listenerFunc: (data: PrinterLibraryEvent) => void) => PluginListenerHandle
+```
+
+| Param              | Type                                                                                   |
+| ------------------ | -------------------------------------------------------------------------------------- |
+| **`eventName`**    | <code>string</code>                                                                    |
+| **`listenerFunc`** | <code>(data: <a href="#printerlibraryevent">PrinterLibraryEvent</a>) =&gt; void</code> |
+
+**Returns:** <code><a href="#pluginlistenerhandle">PluginListenerHandle</a></code>
+
+--------------------
+
+
+### removeAllListeners()
+
+```typescript
+removeAllListeners() => void
+```
+
+--------------------
+
+
+### Interfaces
+
+
+#### PrinterLibraryEvent
+
+| Prop          | Type                                                                          |
+| ------------- | ----------------------------------------------------------------------------- |
+| **`sender`**  | <code>string</code>                                                           |
+| **`type`**    | <code><a href="#eventtype">EventType</a></code>                               |
+| **`message`** | <code>string</code>                                                           |
+| **`error`**   | <code>number</code>                                                           |
+| **`data`**    | <code><a href="#resultclass">ResultClass</a></code>                           |
+| **`action`**  | <code><a href="#printerlibraryactiontype">PrinterLibraryActionType</a></code> |
+
+
+#### ResultClass
+
+
+#### MediaSize
+
+| Prop         | Type                |
+| ------------ | ------------------- |
+| **`width`**  | <code>number</code> |
+| **`height`** | <code>number</code> |
+
+
+#### CIDPrinterInformation
+
+| Prop                       | Type                                          |
+| -------------------------- | --------------------------------------------- |
+| **`firmware`**             | <code><a href="#firmware">Firmware</a></code> |
+| **`main_firmware`**        | <code><a href="#firmware">Firmware</a></code> |
+| **`module_firmware`**      | <code><a href="#firmware">Firmware</a></code> |
+| **`sensor_boot_firmware`** | <code><a href="#firmware">Firmware</a></code> |
+| **`sensor_firmware`**      | <code><a href="#firmware">Firmware</a></code> |
+| **`media`**                | <code><a href="#media">Media</a></code>       |
+| **`battery`**              | <code><a href="#battery">Battery</a></code>   |
+| **`modeltype`**            | <code>number</code>                           |
+| **`modelname`**            | <code>string</code>                           |
+| **`dpi`**                  | <code>number</code>                           |
+| **`dots_mm`**              | <code>number</code>                           |
+| **`dots`**                 | <code>number</code>                           |
+| **`lanaddress`**           | <code>string</code>                           |
+| **`wlanaddress`**          | <code>string</code>                           |
+| **`btaddress`**            | <code>string</code>                           |
+| **`headcount`**            | <code>string</code>                           |
+| **`lifecount`**            | <code>string</code>                           |
+| **`cutcount`**             | <code>string</code>                           |
+| **`dispensecount`**        | <code>string</code>                           |
+| **`thermotransfer`**       | <code>boolean</code>                          |
+
+
+#### Firmware
+
+| Prop           | Type                |
+| -------------- | ------------------- |
+| **`version`**  | <code>string</code> |
+| **`date`**     | <code>string</code> |
+| **`checksum`** | <code>string</code> |
+
+
+#### Media
+
+| Prop              | Type                |
+| ----------------- | ------------------- |
+| **`labelwidth`**  | <code>number</code> |
+| **`labelheight`** | <code>number</code> |
+
+
+#### Battery
+
+| Prop             | Type                |
+| ---------------- | ------------------- |
+| **`cyclecount`** | <code>number</code> |
+| **`chargestat`** | <code>number</code> |
+| **`health`**     | <code>number</code> |
+| **`remain`**     | <code>number</code> |
+
+
+#### TicketData
+
+| Prop            | Type                                                      |
+| --------------- | --------------------------------------------------------- |
+| **`variables`** | <code><a href="#ticketvariable">TicketVariable</a></code> |
+
+
+#### TicketVariable
+
+
+#### PrinterConfiguration
+
+| Prop                      | Type                                          |
+| ------------------------- | --------------------------------------------- |
+| **`disconnectonpause`**   | <code>boolean</code>                          |
+| **`connectonresume`**     | <code>boolean</code>                          |
+| **`lowbatterythreshold`** | <code>number</code>                           |
+| **`media`**               | <code><a href="#cidmedia">CIDMedia</a></code> |
+
+
+#### CIDMedia
+
+| Prop       | Type                                            |
+| ---------- | ----------------------------------------------- |
+| **`size`** | <code><a href="#mediasize">MediaSize</a></code> |
+| **`type`** | <code><a href="#mediatype">MediaType</a></code> |
+
+
+#### PluginListenerHandle
+
+| Prop         | Type                                      |
+| ------------ | ----------------------------------------- |
+| **`remove`** | <code>() =&gt; Promise&lt;void&gt;</code> |
+
+
+### Enums
+
+
+#### EventType
+
+| Members       | Value          |
+| ------------- | -------------- |
+| **`SUCCESS`** | <code>0</code> |
+| **`NOTIFY`**  | <code>1</code> |
+| **`FAILED`**  | <code>2</code> |
+
+
+#### PrinterLibraryActionType
+
+| Members                    | Value           |
+| -------------------------- | --------------- |
+| **`NONE`**                 | <code>0</code>  |
+| **`INITIALIZE`**           | <code>1</code>  |
+| **`BLUETOOTH_INITIALIZE`** | <code>2</code>  |
+| **`BLUETOOTH_ENABLE`**     | <code>3</code>  |
+| **`BLUETOOTH_DISABLE`**    | <code>4</code>  |
+| **`DISCOVER_START`**       | <code>5</code>  |
+| **`DISCOVER_DETECT`**      | <code>6</code>  |
+| **`DISCOVER_FINISH`**      | <code>7</code>  |
+| **`CONNECT`**              | <code>8</code>  |
+| **`DISCONNECT`**           | <code>9</code>  |
+| **`PRINT`**                | <code>10</code> |
+| **`STATUS`**               | <code>11</code> |
+| **`CONFIGURE`**            | <code>12</code> |
+| **`BLUETOOTH_TURNED_OFF`** | <code>13</code> |
+| **`BLUETOOTH_TURNED_ON`**  | <code>14</code> |
+| **`LICENSE_ACTIVATION`**   | <code>15</code> |
+| **`FILEUPLOAD`**           | <code>16</code> |
+| **`EXCEPTION`**            | <code>17</code> |
+
+
+#### ReferenceTicketType
+
+| Members          | Value          |
+| ---------------- | -------------- |
+| **`DOT_MATRIX`** | <code>0</code> |
+
+
+#### MediaType
+
+| Members     | Value          |
+| ----------- | -------------- |
+| **`GAP`**   | <code>0</code> |
+| **`IMARK`** | <code>1</code> |
+
+</docgen-api>
+
 ### initCIDPrinterLib(): Promise<{event: PrinterLibraryEvent}>
 
 ```javascript