@rdlabo/capacitor-brotherprint 6.3.0 → 6.4.1

package/README.md

@@ -10,11 +10,11 @@ Each product link is an Amazon affiliate link. If you choose to make a purchase
 
 | Product                               | Model        | iOS/WiFi | iOS/BT | iOS/BLE | Android/USB | Android/WiFi | Android/BT | Android/BLE |
 | ------------------------------------- | ------------ | -------- | ------ | ------- | ----------- | ------------ | ---------- | ----------- |
-| QL-810W                               | QL_810W      | ✗        | ✗      | ✗       | -           | ✗            | ✗          | ✗           |
-| [QL-820NWB](https://amzn.to/3BXQ1aj)  | QL_820NWB    | ◯        | ※1     | ✗       | -           | ◯            | △          | ✗           |
+| QL-810W                               | QL_810W      | ✗        | ✗      | ✗       | ◯           | ✗            | ✗          | ✗           |
+| [QL-820NWB](https://amzn.to/3BXQ1aj)  | QL_820NWB    | ◯        | ※1     | ✗       | △           | ◯            | △          | ✗           |
 | [QL-820NWBc](https://amzn.to/4fjhUIe) | QL_820NWB    | ◯        | ※2     | ✗       | ✗           | ◯            | ◯          | ✗           |
 | [TD-2320D](https://amzn.to/48EFCN3)   | TD_2320D_203 | ✗        | ✗      | ✗       | △           | ✗            | ✗          | ✗           |
-| [TD-2350D](https://amzn.to/48ma6TK)   | TD_2350D_300 | ◯        | △      | △       | -           | ◯            | ◯          | △           |
+| [TD-2350D](https://amzn.to/48ma6TK)   | TD_2350D_300 | ◯        | △      | △       | ◯           | ◯            | ◯          | △           |
 
 Amazon Affiliate Links:　**https://amzn.to/3AiiOFT**
 
@@ -134,15 +134,6 @@ More information is here: https://support.brother.co.jp/j/s/support/html/mobiles
 ## How to use
 
 ```typescript
-import {
-  BrotherPrint,
-  BRLMPrintOptions,
-  BRLMPrinterLabelName,
-  BrotherPrintEventsEnum,
-  BRLMPrinterModelName,
-  BRLMChannelResult,
-} from '@rdlabo/capacitor-brotherprint';
-
 @Component({
   selector: 'brother-print',
   templateUrl: 'brother.component.html',
@@ -188,7 +179,7 @@ export class BrotherComponent implements OnInit, OnDestroy {
     this.#listenerHandlers.forEach(handler => handler.remove());
   }
 
-  async searchPrinter(port: 'wifi' | 'bluetooth' | 'bluetoothLowEnergy') {
+  async searchPrinter(port: BRKMPrinterPort) {
     // This method return void. Get the printer list by listening to the event.
     await BrotherPrint.search({
       port,
@@ -204,7 +195,7 @@ export class BrotherComponent implements OnInit, OnDestroy {
 
     const defaultPrintSettings: BRLMPrintOptions = {
       modelName: BRLMPrinterModelName.QL_820NWB,
-      labelName: BRLMPrinterLabelName.W62,
+      labelName: BRLMPrinterLabelName.RollW62,
       encodedImage: 'base64 removed mime-type', // base64
       numberOfCopies: 1, // default 1
       autoCut: true, // default true
@@ -213,17 +204,17 @@ export class BrotherComponent implements OnInit, OnDestroy {
     BrotherPrint.printImage({
       ...defaultPrintSettings,
       ...{
-        ipAddress: this.printers()[0].ipAddress,
-        localName: this.printers()[0].nodeName,
-        macAddress: this.printers()[0].macAddress,
-        serialNumber: this.printers()[0].serialNumber,
         port: this.printers()[0].port,
+        channelInfo: this.printers()[0].channelInfo,
       },
     });
   }
 }
 ```
 
+See demo for complete code:
+https://github.com/rdlabo-team/capacitor-brotherprint/blob/main/demo/src/app/home/home.page.ts
+
 ## API
 
 <docgen-index>
@@ -395,7 +386,7 @@ Make all properties in T optional
 
 #### BRLMChannelResult
 
-<code>{ port: 'usb' | 'wifi' | 'bluetooth' | 'bluetoothLowEnergy'; modelName: string; serialNumber: string; macAddress: string; nodeName: string; location: string; /** * This need to connect to the printer. * wifi: IP Address * bluetooth: macAddress * bluetoothLowEnergy: modelName for bluetoothLowEnergy */ channelInfo: string; }</code>
+<code>{ port: <a href="#brkmprinterport">BRKMPrinterPort</a>; modelName: string; serialNumber: string; macAddress: string; nodeName: string; location: string; /** * This need to connect to the printer. * wifi: IP Address * bluetooth: macAddress * bluetoothLowEnergy: modelName for bluetoothLowEnergy */ channelInfo: string; }</code>
 
 
 #### BRLMPrinterQLModelSettings
@@ -437,7 +428,7 @@ These are optional. If these are not set, default values are assigned by the pri
 
 #### BRLMSearchOption
 
-<code>{ /** * 'usb' is android only, and now developing. */ port: 'usb' | 'wifi' | 'bluetooth' | 'bluetoothLowEnergy'; /** * searchDuration is the time to end search for devices. * default is 15 seconds. * use only port is 'wifi' or 'bluetoothLowEnergy'. */ searchDuration: number; }</code>
+<code>{ /** * 'usb' is android only, and now developing. */ port: <a href="#brkmprinterport">BRKMPrinterPort</a>; /** * searchDuration is the time to end search for devices. * default is 15 seconds. * use only port is 'wifi' or 'bluetoothLowEnergy'. */ searchDuration: number; }</code>
 
 
 #### ErrorInfo
@@ -452,6 +443,7 @@ These are optional. If these are not set, default values are assigned by the pri
 
 | Members            | Value                       |
 | ------------------ | --------------------------- |
+| **`QL_800`**       | <code>'QL_800'</code>       |
 | **`QL_810W`**      | <code>'QL_810W'</code>      |
 | **`QL_820NWB`**    | <code>'QL_820NWB'</code>    |
 | **`TD_2320D_203`** | <code>'TD_2320D_203'</code> |
@@ -459,34 +451,53 @@ These are optional. If these are not set, default values are assigned by the pri
 | **`TD_2350D_300`** | <code>'TD_2350D_300'</code> |
 
 
+#### BRKMPrinterPort
+
+| Members                  | Value                             |
+| ------------------------ | --------------------------------- |
+| **`usb`**                | <code>'usb'</code>                |
+| **`wifi`**               | <code>'wifi'</code>               |
+| **`bluetooth`**          | <code>'bluetooth'</code>          |
+| **`bluetoothLowEnergy`** | <code>'bluetoothLowEnergy'</code> |
+
+
 #### BRLMPrinterLabelName
 
-| Members       | Value                  |
-| ------------- | ---------------------- |
-| **`W17H54`**  | <code>'W17H54'</code>  |
-| **`W17H87`**  | <code>'W17H87'</code>  |
-| **`W23H23`**  | <code>'W23H23'</code>  |
-| **`W29H42`**  | <code>'W29H42'</code>  |
-| **`W29H90`**  | <code>'W29H90'</code>  |
-| **`W38H90`**  | <code>'W38H90'</code>  |
-| **`W39H48`**  | <code>'W39H48'</code>  |
-| **`W52H29`**  | <code>'W52H29'</code>  |
-| **`W62H29`**  | <code>'W62H29'</code>  |
-| **`W62H100`** | <code>'W62H100'</code> |
-| **`W12`**     | <code>'W12'</code>     |
-| **`W29`**     | <code>'W29'</code>     |
-| **`W38`**     | <code>'W38'</code>     |
-| **`W50`**     | <code>'W50'</code>     |
-| **`W54`**     | <code>'W54'</code>     |
-| **`W62`**     | <code>'W62'</code>     |
-| **`W60H86`**  | <code>'W60H86'</code>  |
-| **`W62RB`**   | <code>'W62RB'</code>   |
-| **`W54H29`**  | <code>'W54H29'</code>  |
-| **`W12DIA`**  | <code>'W12DIA'</code>  |
-| **`W24DIA`**  | <code>'W24DIA'</code>  |
-| **`W58DIA`**  | <code>'W58DIA'</code>  |
-| **`W62H60`**  | <code>'W62H60'</code>  |
-| **`W62H75`**  | <code>'W62H75'</code>  |
+| Members              | Value                         |
+| -------------------- | ----------------------------- |
+| **`DieCutW17H54`**   | <code>'DieCutW17H54'</code>   |
+| **`DieCutW17H87`**   | <code>'DieCutW17H87'</code>   |
+| **`DieCutW23H23`**   | <code>'DieCutW23H23'</code>   |
+| **`DieCutW29H42`**   | <code>'DieCutW29H42'</code>   |
+| **`DieCutW29H90`**   | <code>'DieCutW29H90'</code>   |
+| **`DieCutW38H90`**   | <code>'DieCutW38H90'</code>   |
+| **`DieCutW39H48`**   | <code>'DieCutW39H48'</code>   |
+| **`DieCutW52H29`**   | <code>'DieCutW52H29'</code>   |
+| **`DieCutW62H29`**   | <code>'DieCutW62H29'</code>   |
+| **`DieCutW62H60`**   | <code>'DieCutW62H60'</code>   |
+| **`DieCutW62H75`**   | <code>'DieCutW62H75'</code>   |
+| **`DieCutW62H100`**  | <code>'DieCutW62H100'</code>  |
+| **`DieCutW60H86`**   | <code>'DieCutW60H86'</code>   |
+| **`DieCutW54H29`**   | <code>'DieCutW54H29'</code>   |
+| **`DieCutW102H51`**  | <code>'DieCutW102H51'</code>  |
+| **`DieCutW102H152`** | <code>'DieCutW102H152'</code> |
+| **`DieCutW103H164`** | <code>'DieCutW103H164'</code> |
+| **`RollW12`**        | <code>'RollW12'</code>        |
+| **`RollW29`**        | <code>'RollW29'</code>        |
+| **`RollW38`**        | <code>'RollW38'</code>        |
+| **`RollW50`**        | <code>'RollW50'</code>        |
+| **`RollW54`**        | <code>'RollW54'</code>        |
+| **`RollW62`**        | <code>'RollW62'</code>        |
+| **`RollW62RB`**      | <code>'RollW62RB'</code>      |
+| **`RollW102`**       | <code>'RollW102'</code>       |
+| **`RollW103`**       | <code>'RollW103'</code>       |
+| **`DTRollW90`**      | <code>'DTRollW90'</code>      |
+| **`DTRollW102`**     | <code>'DTRollW102'</code>     |
+| **`DTRollW102H51`**  | <code>'DTRollW102H51'</code>  |
+| **`DTRollW102H152`** | <code>'DTRollW102H152'</code> |
+| **`RoundW12DIA`**    | <code>'RoundW12DIA'</code>    |
+| **`RoundW24DIA`**    | <code>'RoundW24DIA'</code>    |
+| **`RoundW58DIA`**    | <code>'RoundW58DIA'</code>    |
 
 
 #### BRLMPrinterScaleMode

package/android/src/main/java/jp/rdlabo/capacitor/plugin/brotherprint/BrotherPrint.kt

@@ -1,11 +1,17 @@
 package jp.rdlabo.capacitor.plugin.brotherprint
 
 import android.Manifest
+import android.app.PendingIntent
 import android.bluetooth.BluetoothAdapter
 import android.bluetooth.BluetoothManager
+import android.content.BroadcastReceiver
 import android.content.Context
+import android.content.Intent
+import android.content.IntentFilter
 import android.graphics.BitmapFactory
+import android.hardware.usb.UsbDevice
 import android.hardware.usb.UsbManager
+import android.os.Build
 import android.util.Base64
 import android.util.Log
 import com.brother.sdk.lmprinter.BLESearchOption
@@ -56,9 +62,13 @@ import jp.rdlabo.capacitor.plugin.brotherprint.models.BrotherPrintSettings
 class BrotherPrint : Plugin() {
     private var cancelRoutineWiFi: (() -> Unit)? = null
     private var cancelRoutineBluetooth: (() -> Unit)? = null
+
+    private val ActionUSBPermission = "jp.rdlabo.capacitor.plugin.brotherprint.USB_PERMISSION"
     private val PERMISSION_DENIED_ERROR =
         "Unable to do call operation, user denied permission request"
 
+    private var storeCall: PluginCall? = null
+
     @PluginMethod
     fun printImage(call: PluginCall) {
         val encodedImage = call.getString("encodedImage", "")
@@ -159,7 +169,12 @@ class BrotherPrint : Plugin() {
     }
 
     private fun searchUsbPrinter(call: PluginCall) {
-        Log.d("brother", "searchUsbPrinter")
+        if (!this.requestUsbPermission(call)) {
+            this.storeCall = call;
+            return
+        }
+        this.storeCall = null
+
         Thread {
             val result = PrinterSearcher.startUSBSearch(bridge.context)
 
@@ -309,6 +324,52 @@ class BrotherPrint : Plugin() {
         }
     }
 
+    /**
+     * TODO: This is not called for in spite of registration.
+     * Therefore, it is now necessary for the user to run it again after permission is granted.
+     */
+    private val usbReceiver: BroadcastReceiver = object : BroadcastReceiver() {
+        override fun onReceive(context: Context?, intent: Intent?) {
+            if (intent?.action == ActionUSBPermission && intent.getBooleanExtra(UsbManager.EXTRA_PERMISSION_GRANTED, false)) {
+                storeCall?.let { searchUsbPrinter(it) }
+            } else {
+                storeCall?.reject("Error - usbReceiver can't current receiver");
+            }
+        }
+    }
+
+    private fun requestUsbPermission(call: PluginCall): Boolean {
+        val permissionIntent = PendingIntent.getBroadcast(
+            bridge.context, 0, Intent(ActionUSBPermission), PendingIntent.FLAG_IMMUTABLE
+        )
+
+        if (Build.VERSION.SDK_INT >= Build.VERSION_CODES.TIRAMISU) {
+            bridge.context.registerReceiver(
+                usbReceiver, IntentFilter(ActionUSBPermission),
+                Context.RECEIVER_NOT_EXPORTED
+            )
+        } else {
+            bridge.context.registerReceiver(
+                usbReceiver, IntentFilter(ActionUSBPermission)
+            )
+        }
+
+        var connectDevice: UsbDevice? = null
+        val usbManager = bridge.context.getSystemService(Context.USB_SERVICE) as UsbManager
+        for (device in usbManager.deviceList.values) {
+            connectDevice = device
+        }
+
+        if (connectDevice == null) {
+            call.reject("Error - connection failed: device not found")
+            return false
+        }
+
+        usbManager.requestPermission(connectDevice, permissionIntent)
+
+        return usbManager.hasPermission(connectDevice)
+    }
+
     private fun isBluetoothPermissionGranted(): Boolean {
         return getPermissionState("bluetooth") == PermissionState.GRANTED
     }

package/dist/docs.json

@@ -186,6 +186,12 @@
       "name": "BRLMPrinterModelName",
       "slug": "brlmprintermodelname",
       "members": [
+        {
+          "name": "QL_800",
+          "value": "'QL_800'",
+          "tags": [],
+          "docs": ""
+        },
         {
           "name": "QL_810W",
           "value": "'QL_810W'",
@@ -218,151 +224,235 @@
         }
       ]
     },
+    {
+      "name": "BRKMPrinterPort",
+      "slug": "brkmprinterport",
+      "members": [
+        {
+          "name": "usb",
+          "value": "'usb'",
+          "tags": [],
+          "docs": ""
+        },
+        {
+          "name": "wifi",
+          "value": "'wifi'",
+          "tags": [],
+          "docs": ""
+        },
+        {
+          "name": "bluetooth",
+          "value": "'bluetooth'",
+          "tags": [],
+          "docs": ""
+        },
+        {
+          "name": "bluetoothLowEnergy",
+          "value": "'bluetoothLowEnergy'",
+          "tags": [],
+          "docs": ""
+        }
+      ]
+    },
     {
       "name": "BRLMPrinterLabelName",
       "slug": "brlmprinterlabelname",
       "members": [
         {
-          "name": "W17H54",
-          "value": "'W17H54'",
+          "name": "DieCutW17H54",
+          "value": "'DieCutW17H54'",
+          "tags": [],
+          "docs": ""
+        },
+        {
+          "name": "DieCutW17H87",
+          "value": "'DieCutW17H87'",
+          "tags": [],
+          "docs": ""
+        },
+        {
+          "name": "DieCutW23H23",
+          "value": "'DieCutW23H23'",
+          "tags": [],
+          "docs": ""
+        },
+        {
+          "name": "DieCutW29H42",
+          "value": "'DieCutW29H42'",
           "tags": [],
           "docs": ""
         },
         {
-          "name": "W17H87",
-          "value": "'W17H87'",
+          "name": "DieCutW29H90",
+          "value": "'DieCutW29H90'",
           "tags": [],
           "docs": ""
         },
         {
-          "name": "W23H23",
-          "value": "'W23H23'",
+          "name": "DieCutW38H90",
+          "value": "'DieCutW38H90'",
           "tags": [],
           "docs": ""
         },
         {
-          "name": "W29H42",
-          "value": "'W29H42'",
+          "name": "DieCutW39H48",
+          "value": "'DieCutW39H48'",
           "tags": [],
           "docs": ""
         },
         {
-          "name": "W29H90",
-          "value": "'W29H90'",
+          "name": "DieCutW52H29",
+          "value": "'DieCutW52H29'",
           "tags": [],
           "docs": ""
         },
         {
-          "name": "W38H90",
-          "value": "'W38H90'",
+          "name": "DieCutW62H29",
+          "value": "'DieCutW62H29'",
           "tags": [],
           "docs": ""
         },
         {
-          "name": "W39H48",
-          "value": "'W39H48'",
+          "name": "DieCutW62H60",
+          "value": "'DieCutW62H60'",
           "tags": [],
           "docs": ""
         },
         {
-          "name": "W52H29",
-          "value": "'W52H29'",
+          "name": "DieCutW62H75",
+          "value": "'DieCutW62H75'",
           "tags": [],
           "docs": ""
         },
         {
-          "name": "W62H29",
-          "value": "'W62H29'",
+          "name": "DieCutW62H100",
+          "value": "'DieCutW62H100'",
           "tags": [],
           "docs": ""
         },
         {
-          "name": "W62H100",
-          "value": "'W62H100'",
+          "name": "DieCutW60H86",
+          "value": "'DieCutW60H86'",
           "tags": [],
           "docs": ""
         },
         {
-          "name": "W12",
-          "value": "'W12'",
+          "name": "DieCutW54H29",
+          "value": "'DieCutW54H29'",
           "tags": [],
           "docs": ""
         },
         {
-          "name": "W29",
-          "value": "'W29'",
+          "name": "DieCutW102H51",
+          "value": "'DieCutW102H51'",
           "tags": [],
           "docs": ""
         },
         {
-          "name": "W38",
-          "value": "'W38'",
+          "name": "DieCutW102H152",
+          "value": "'DieCutW102H152'",
           "tags": [],
           "docs": ""
         },
         {
-          "name": "W50",
-          "value": "'W50'",
+          "name": "DieCutW103H164",
+          "value": "'DieCutW103H164'",
           "tags": [],
           "docs": ""
         },
         {
-          "name": "W54",
-          "value": "'W54'",
+          "name": "RollW12",
+          "value": "'RollW12'",
           "tags": [],
           "docs": ""
         },
         {
-          "name": "W62",
-          "value": "'W62'",
+          "name": "RollW29",
+          "value": "'RollW29'",
           "tags": [],
           "docs": ""
         },
         {
-          "name": "W60H86",
-          "value": "'W60H86'",
+          "name": "RollW38",
+          "value": "'RollW38'",
           "tags": [],
           "docs": ""
         },
         {
-          "name": "W62RB",
-          "value": "'W62RB'",
+          "name": "RollW50",
+          "value": "'RollW50'",
           "tags": [],
           "docs": ""
         },
         {
-          "name": "W54H29",
-          "value": "'W54H29'",
+          "name": "RollW54",
+          "value": "'RollW54'",
           "tags": [],
           "docs": ""
         },
         {
-          "name": "W12DIA",
-          "value": "'W12DIA'",
+          "name": "RollW62",
+          "value": "'RollW62'",
           "tags": [],
           "docs": ""
         },
         {
-          "name": "W24DIA",
-          "value": "'W24DIA'",
+          "name": "RollW62RB",
+          "value": "'RollW62RB'",
           "tags": [],
           "docs": ""
         },
         {
-          "name": "W58DIA",
-          "value": "'W58DIA'",
+          "name": "RollW102",
+          "value": "'RollW102'",
           "tags": [],
           "docs": ""
         },
         {
-          "name": "W62H60",
-          "value": "'W62H60'",
+          "name": "RollW103",
+          "value": "'RollW103'",
           "tags": [],
           "docs": ""
         },
         {
-          "name": "W62H75",
-          "value": "'W62H75'",
+          "name": "DTRollW90",
+          "value": "'DTRollW90'",
+          "tags": [],
+          "docs": ""
+        },
+        {
+          "name": "DTRollW102",
+          "value": "'DTRollW102'",
+          "tags": [],
+          "docs": ""
+        },
+        {
+          "name": "DTRollW102H51",
+          "value": "'DTRollW102H51'",
+          "tags": [],
+          "docs": ""
+        },
+        {
+          "name": "DTRollW102H152",
+          "value": "'DTRollW102H152'",
+          "tags": [],
+          "docs": ""
+        },
+        {
+          "name": "RoundW12DIA",
+          "value": "'RoundW12DIA'",
+          "tags": [],
+          "docs": ""
+        },
+        {
+          "name": "RoundW24DIA",
+          "value": "'RoundW24DIA'",
+          "tags": [],
+          "docs": ""
+        },
+        {
+          "name": "RoundW58DIA",
+          "value": "'RoundW58DIA'",
           "tags": [],
           "docs": ""
         }
@@ -653,8 +743,10 @@
       "docs": "",
       "types": [
         {
-          "text": "{\n  port: 'usb' | 'wifi' | 'bluetooth' | 'bluetoothLowEnergy';\n  modelName: string;\n  serialNumber: string;\n  macAddress: string;\n  nodeName: string;\n  location: string;\n\n  /**\n   * This need to connect to the printer.\n   * wifi: IP Address\n   * bluetooth: macAddress\n   * bluetoothLowEnergy: modelName for bluetoothLowEnergy\n   */\n  channelInfo: string;\n}",
-          "complexTypes": []
+          "text": "{\n  port: BRKMPrinterPort;\n  modelName: string;\n  serialNumber: string;\n  macAddress: string;\n  nodeName: string;\n  location: string;\n\n  /**\n   * This need to connect to the printer.\n   * wifi: IP Address\n   * bluetooth: macAddress\n   * bluetoothLowEnergy: modelName for bluetoothLowEnergy\n   */\n  channelInfo: string;\n}",
+          "complexTypes": [
+            "BRKMPrinterPort"
+          ]
         }
       ]
     },
@@ -759,8 +851,10 @@
       "docs": "",
       "types": [
         {
-          "text": "{\n  /**\n   * 'usb' is android only, and now developing.\n   */\n  port: 'usb' | 'wifi' | 'bluetooth' | 'bluetoothLowEnergy';\n\n  /**\n   * searchDuration is the time to end search for devices.\n   * default is 15 seconds.\n   * use only port is 'wifi' or 'bluetoothLowEnergy'.\n   */\n  searchDuration: number;\n}",
-          "complexTypes": []
+          "text": "{\n  /**\n   * 'usb' is android only, and now developing.\n   */\n  port: BRKMPrinterPort;\n\n  /**\n   * searchDuration is the time to end search for devices.\n   * default is 15 seconds.\n   * use only port is 'wifi' or 'bluetoothLowEnergy'.\n   */\n  searchDuration: number;\n}",
+          "complexTypes": [
+            "BRKMPrinterPort"
+          ]
         }
       ]
     },