@rdlabo/capacitor-brotherprint 8.1.1 → 8.2.0

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

@@ -23,6 +23,7 @@ import com.brother.sdk.lmprinter.PrintError
 import com.brother.sdk.lmprinter.PrinterDriverGenerator
 import com.brother.sdk.lmprinter.PrinterModel
 import com.brother.sdk.lmprinter.PrinterSearcher
+import com.brother.sdk.lmprinter.PrinterSearchError
 import com.brother.sdk.lmprinter.PrinterSearcher.cancelNetworkSearch
 import com.brother.sdk.lmprinter.setting.PrintSettings
 import com.brother.sdk.lmprinter.setting.QLPrintSettings
@@ -45,8 +46,6 @@ import jp.rdlabo.capacitor.plugin.brotherprint.models.BrotherPrintSettings
         Permission(
             alias = "bluetooth",
             strings = [
-                Manifest.permission.BLUETOOTH,
-                Manifest.permission.BLUETOOTH_ADMIN,
                 Manifest.permission.BLUETOOTH_CONNECT,
                 Manifest.permission.BLUETOOTH_SCAN,
             ],
@@ -69,17 +68,36 @@ class BrotherPrint : Plugin() {
         "Unable to do call operation, user denied permission request"
 
     private var storeCall: PluginCall? = null
+    private var usbReceiverRegistered = false
 
     @PluginMethod
     fun printImage(call: PluginCall) {
         val encodedImage = call.getString("encodedImage", "")
         if (encodedImage == "") {
+            notifyListeners(BrotherPrintEvent.onPrintError.webEventName,
+                JSObject().put("code", 0).put("message", "Error - Image data is not found.")
+            )
             call.reject("Error - Image data is not found.")
             return
         }
 
-        val decodedString = Base64.decode(encodedImage, Base64.DEFAULT)
+        val decodedString = try {
+            Base64.decode(encodedImage, Base64.DEFAULT)
+        } catch (error: IllegalArgumentException) {
+            notifyListeners(BrotherPrintEvent.onPrintError.webEventName,
+                JSObject().put("code", 0).put("message", "Error - Invalid Base64 image data")
+            )
+            call.reject("Error - Invalid Base64 image data")
+            return
+        }
         val decodedByte = BitmapFactory.decodeByteArray(decodedString, 0, decodedString.size)
+        if (decodedByte == null) {
+            notifyListeners(BrotherPrintEvent.onPrintError.webEventName,
+                JSObject().put("code", 0).put("message", "Error - Create decodedByte From ImageData is failed.")
+            )
+            call.reject("Error - Create decodedByte From ImageData is failed.")
+            return
+        }
 
         val port: String? = call.getString("port", "wifi")
         val channelInfo: String? = call.getString("channelInfo", "")
@@ -100,6 +118,9 @@ class BrotherPrint : Plugin() {
             settings = BrotherPrintSettings().modelTDSettings(call, settings)
             settings.workPath = bridge.context.cacheDir.path;
         } else {
+            notifyListeners(BrotherPrintEvent.onPrintError.webEventName,
+                JSObject().put("code", 0).put("message", "Error - modelName:$modelName is not supported")
+            )
             call.reject("Error - modelName:$modelName is not supported")
             return;
         }
@@ -113,6 +134,9 @@ class BrotherPrint : Plugin() {
                     channelInfo, bridge.context, getBluetoothAdapter(bridge.context)
                 )
                 else -> {
+                    notifyListeners(BrotherPrintEvent.onPrintError.webEventName,
+                        JSObject().put("code", 0).put("message", "Error - port:$port is not supported")
+                    )
                     call.reject("Error - port:$port is not supported")
                     return@Thread
                 }
@@ -161,6 +185,10 @@ class BrotherPrint : Plugin() {
 
     @PluginMethod
     fun isChannelAvailable(call: PluginCall) {
+        if (call.getString("port") in listOf("bluetooth", "bluetoothLowEnergy") && !isBluetoothPermissionGranted()) {
+            call.resolve(JSObject().put("result", false))
+            return
+        }
         val port: String? = call.getString("port", "wifi")
         val channelInfo: String? = call.getString("channelInfo", "")
 
@@ -200,29 +228,22 @@ class BrotherPrint : Plugin() {
         }
     }
 
+    @Synchronized
     private fun searchUsbPrinter(call: PluginCall) {
+        if (this.storeCall != null) {
+            call.reject("Error - USB permission request is already pending")
+            return
+        }
         if (!this.requestUsbPermission(call)) {
-            this.storeCall = call;
             return
         }
-        this.storeCall = null
 
         Thread {
             val result = PrinterSearcher.startUSBSearch(bridge.context)
 
-            when (result.error.code) {
-                com.brother.sdk.lmprinter.PrinterSearchError.ErrorCode.NoError -> {
-                }
-                com.brother.sdk.lmprinter.PrinterSearchError.ErrorCode.NotPermitted -> {
-                    // TODO: has error
-                }
-                com.brother.sdk.lmprinter.PrinterSearchError.ErrorCode.Canceled,
-                com.brother.sdk.lmprinter.PrinterSearchError.ErrorCode.InterfaceInactive,
-                com.brother.sdk.lmprinter.PrinterSearchError.ErrorCode.InterfaceUnsupported,
-                com.brother.sdk.lmprinter.PrinterSearchError.ErrorCode.AlreadySearching,
-                com.brother.sdk.lmprinter.PrinterSearchError.ErrorCode.UnknownError -> {
-                }
-                null -> {}
+            if (result.error.code != PrinterSearchError.ErrorCode.NoError) {
+                call.reject("Error - startUSBSearch: " + result.error.code.toString())
+                return@Thread
             }
 
             for (channel in result.channels){
@@ -231,8 +252,8 @@ class BrotherPrint : Plugin() {
                     this.chanelToPrinter("usb", channel)
                 );
             }
+            call.resolve();
         }.start()
-        call.resolve();
     }
 
     private fun searchWiFiPrinter(call: PluginCall) {
@@ -243,7 +264,7 @@ class BrotherPrint : Plugin() {
             }
             val intDuration: Int = call.getInt("searchDuration") ?: 15 ;
             val option = NetworkSearchOption(intDuration.toDouble(), false);
-            PrinterSearcher.startNetworkSearch(bridge.context, option){ channel ->
+            val result = PrinterSearcher.startNetworkSearch(bridge.context, option){ channel ->
                 run {
                     Log.d("brother", this.chanelToPrinter("wifi", channel).toString())
                     this.notifyListeners(
@@ -253,8 +274,12 @@ class BrotherPrint : Plugin() {
                 }
             }
             this.cancelRoutineWiFi = null
+            if (result.error.code != PrinterSearchError.ErrorCode.NoError) {
+                call.reject("Error - startNetworkSearch: " + result.error.code.toString())
+                return@Thread
+            }
+            call.resolve();
         }.start()
-        call.resolve();
     }
 
     private fun checkBLEChannel(call: PluginCall) {
@@ -263,12 +288,21 @@ class BrotherPrint : Plugin() {
         } else {
             Log.d("brother", "checkBLEChannel")
             Thread {
-                for (channel in PrinterSearcher.startBluetoothSearch(bridge.context).channels){
+                val result = PrinterSearcher.startBluetoothSearch(bridge.context)
+                if (result.error.code != PrinterSearchError.ErrorCode.NoError) {
+                    call.reject("Error - startBluetoothSearch: " + result.error.code.toString())
+                    return@Thread
+                }
+                for (channel in result.channels){
+                    if (!matchesBluetoothPrinterFilter(call.getBoolean("bluetoothPrintersOnly", false) == true) {
+                        val device = getBluetoothAdapter(bridge.context)?.getRemoteDevice(channel.channelInfo)
+                        device?.bluetoothClass?.deviceClass
+                    }) continue
                     Log.d("brother", this.chanelToPrinter("bluetooth", channel).toString())
                     this.notifyListeners(BrotherPrintEvent.onPrinterAvailable.webEventName, this.chanelToPrinter("bluetooth", channel));
                 }
+                call.resolve();
             }.start()
-            call.resolve();
         }
     }
 
@@ -276,18 +310,18 @@ class BrotherPrint : Plugin() {
         if (!isBluetoothPermissionGranted()) {
             requestPermissionForAlias("bluetooth", call, "permissionCallback");
             return;
-        } else if (!isLocationPermissionGranted()) {
-            requestPermissionForAlias("location", call, "permissionCallback");
+        } else if (Build.VERSION.SDK_INT < Build.VERSION_CODES.S && !isLocationPermissionGranted()) {
+            requestPermissionForAlias("location", call, "locationPermissionCallback");
             return;
         } else {
             Log.d("brother", "searchBLEPrinter")
             Thread {
                 this.cancelRoutineBluetooth = {
-                    cancelNetworkSearch()
+                    PrinterSearcher.cancelBLESearch()
                 }
                 val intDuration: Int = call.getInt("searchDuration") ?: 15 ;
                 val option = BLESearchOption(intDuration.toDouble())
-                PrinterSearcher.startBLESearch(bridge.context, option){ channel ->
+                val result = PrinterSearcher.startBLESearch(bridge.context, option){ channel ->
                     run {
                         Log.d("brother", this.chanelToPrinter("bluetoothLowEnergy", channel).toString())
                         this.notifyListeners(
@@ -297,15 +331,19 @@ class BrotherPrint : Plugin() {
                     }
                 }
                 this.cancelRoutineBluetooth = null;
+                if (result.error.code != PrinterSearchError.ErrorCode.NoError) {
+                    call.reject("Error - startBLESearch: " + result.error.code.toString())
+                    return@Thread
+                }
+                call.resolve();
             }.start()
-            call.resolve();
         }
     }
 
     private fun chanelToPrinter(port: String, channel: Channel): JSObject? {
         Log.d("brother", channel.toString());
         val modelName = channel.extraInfo[Channel.ExtraInfoKey.ModelName] ?: ""
-        val serialNumber = channel.extraInfo[Channel.ExtraInfoKey.SerialNubmer] ?: ""
+        val serialNumber = channel.extraInfo[Channel.ExtraInfoKey.SerialNumber] ?: ""
         val macAddress = channel.extraInfo[Channel.ExtraInfoKey.MACAddress] ?: ""
         val nodeName = channel.extraInfo[Channel.ExtraInfoKey.NodeName] ?: ""
         val location = channel.extraInfo[Channel.ExtraInfoKey.Location] ?: ""
@@ -346,49 +384,37 @@ class BrotherPrint : Plugin() {
             call.reject(PERMISSION_DENIED_ERROR)
             return
         }
+        when (call.methodName) {
+            "search" -> this.search(call)
+        }
+    }
+
+    @PermissionCallback
+    private fun locationPermissionCallback(call: PluginCall) {
         if (!isLocationPermissionGranted()) {
             Log.d("brother", "!isLocationPermissionGranted()")
             call.reject(PERMISSION_DENIED_ERROR)
             return
         }
-        when (call.methodName) {
-            "search" -> this.search(call)
-        }
+        this.search(call)
     }
 
-    /**
-     * 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");
+            synchronized(this@BrotherPrint) {
+                if (intent?.action != ActionUSBPermission) return
+                val call = storeCall ?: return
+                storeCall = null
+                if (intent.getBooleanExtra(UsbManager.EXTRA_PERMISSION_GRANTED, false)) {
+                    searchUsbPrinter(call)
+                } else {
+                    call.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 {
-            ContextCompat.registerReceiver(
-                bridge.context,
-                usbReceiver,
-                IntentFilter(ActionUSBPermission),
-                ContextCompat.RECEIVER_NOT_EXPORTED
-            )
-        }
-
         var connectDevice: UsbDevice? = null
         val usbManager = bridge.context.getSystemService(Context.USB_SERVICE) as UsbManager
         for (device in usbManager.deviceList.values) {
@@ -399,14 +425,48 @@ class BrotherPrint : Plugin() {
             call.reject("Error - connection failed: device not found")
             return false
         }
+        if (usbManager.hasPermission(connectDevice)) return true
+
+        val permissionIntent = PendingIntent.getBroadcast(
+            bridge.context, 0, Intent(ActionUSBPermission), PendingIntent.FLAG_IMMUTABLE
+        )
+
+        if (!usbReceiverRegistered) {
+            if (Build.VERSION.SDK_INT >= Build.VERSION_CODES.TIRAMISU) {
+                bridge.context.registerReceiver(
+                    usbReceiver, IntentFilter(ActionUSBPermission),
+                    Context.RECEIVER_NOT_EXPORTED
+                )
+            } else {
+                ContextCompat.registerReceiver(
+                    bridge.context,
+                    usbReceiver,
+                    IntentFilter(ActionUSBPermission),
+                    ContextCompat.RECEIVER_NOT_EXPORTED
+                )
+            }
+            usbReceiverRegistered = true
+        }
 
+        storeCall = call
         usbManager.requestPermission(connectDevice, permissionIntent)
+        return false
+    }
 
-        return usbManager.hasPermission(connectDevice)
+    @Synchronized
+    override fun handleOnDestroy() {
+        val call = storeCall
+        storeCall = null
+        call?.reject("Error - plugin destroyed while waiting for USB permission")
+        if (usbReceiverRegistered) {
+            bridge.context.unregisterReceiver(usbReceiver)
+            usbReceiverRegistered = false
+        }
+        super.handleOnDestroy()
     }
 
     private fun isBluetoothPermissionGranted(): Boolean {
-        return getPermissionState("bluetooth") == PermissionState.GRANTED
+        return Build.VERSION.SDK_INT < Build.VERSION_CODES.S || getPermissionState("bluetooth") == PermissionState.GRANTED
     }
 
     private fun isLocationPermissionGranted(): Boolean {

package/dist/docs.json

@@ -66,7 +66,7 @@
         "parameters": [],
         "returns": "Promise<void>",
         "tags": [],
-        "docs": "Basically, it times out, so there is no need to use it. Use it when you want to run multiple connectType searches at the same time and time out any of them manually.",
+        "docs": "Stop an active search before its timeout, including when leaving the screen.",
         "complexTypes": [],
         "slug": "cancelsearchwifiprinter"
       },
@@ -76,7 +76,7 @@
         "parameters": [],
         "returns": "Promise<void>",
         "tags": [],
-        "docs": "Basically, it times out, so there is no need to use it. Use it when you want to run multiple connectType searches at the same time and time out any of them manually.",
+        "docs": "Stop an active search before its timeout, including when leaving the screen.",
         "complexTypes": [],
         "slug": "cancelsearchbluetoothprinter"
       },
@@ -929,7 +929,7 @@
       "docs": "",
       "types": [
         {
-          "text": "{\n  /**\n   * 'usb' is android only, and now developing.\n   */\n  port: BRLMPrinterPort;\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}",
+          "text": "{\n  /**\n   * 'usb' is android only, and now developing.\n   */\n  port: BRLMPrinterPort;\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  /**\n   * Android Bluetooth Classic only. Include only devices whose Bluetooth class\n   * reports a printer. Defaults to false; ignored for other ports and on iOS.\n   * This does not identify Brother devices. Devices with an unknown class are excluded when true.\n   */\n  bluetoothPrintersOnly?: boolean;\n}",
           "complexTypes": [
             "BRLMPrinterPort"
           ]

package/dist/esm/definitions.d.ts

@@ -13,11 +13,11 @@ export interface BrotherPrintPlugin {
      */
     isChannelAvailable(option: BRLMChannelResult): Promise<isChannelAvailableResult>;
     /**
-     * Basically, it times out, so there is no need to use it. Use it when you want to run multiple connectType searches at the same time and time out any of them manually.
+     * Stop an active search before its timeout, including when leaving the screen.
      */
     cancelSearchWiFiPrinter(): Promise<void>;
     /**
-     * Basically, it times out, so there is no need to use it. Use it when you want to run multiple connectType searches at the same time and time out any of them manually.
+     * Stop an active search before its timeout, including when leaving the screen.
      */
     cancelSearchBluetoothPrinter(): Promise<void>;
     /**

package/dist/esm/definitions.js.map

@@ -1 +1 @@
-{"version":3,"file":"definitions.js","sourceRoot":"","sources":["../../src/definitions.ts"],"names":[],"mappings":"","sourcesContent":["import type { PluginListenerHandle } from '@capacitor/core';\n\nimport type { BrotherPrintEventsEnum } from './events.enum';\nimport type {\n  BRLMChannelResult,\n  BRLMPrintOptions,\n  BRLMSearchOption,\n  ErrorInfo,\n  isChannelAvailableResult,\n} from './interfaces';\n\nexport interface BrotherPrintPlugin {\n  printImage(options: BRLMPrintOptions): Promise<void>;\n\n  /**\n   * Search for printers. If not found, it will return an empty array.(not error)\n   */\n  search(option: BRLMSearchOption): Promise<void>;\n\n  /**\n   * If you have saved the last connected BRLMChannelResult,\n   * you can use it to verify whether it is currently usable.\n   */\n  isChannelAvailable(option: BRLMChannelResult): Promise<isChannelAvailableResult>;\n\n  /**\n   * Basically, it times out, so there is no need to use it. Use it when you want to run multiple connectType searches at the same time and time out any of them manually.\n   */\n  cancelSearchWiFiPrinter(): Promise<void>;\n\n  /**\n   * Basically, it times out, so there is no need to use it. Use it when you want to run multiple connectType searches at the same time and time out any of them manually.\n   */\n  cancelSearchBluetoothPrinter(): Promise<void>;\n\n  /**\n   * Find the printer that can connected to the device.\n   */\n  addListener(\n    eventName: BrotherPrintEventsEnum.onPrinterAvailable,\n    listenerFunc: (printers: BRLMChannelResult) => void,\n  ): Promise<PluginListenerHandle>;\n\n  /**\n   * Success Print Event\n   */\n  addListener(eventName: BrotherPrintEventsEnum.onPrint, listenerFunc: () => void): Promise<PluginListenerHandle>;\n\n  /**\n   * Failed to connect to the printer.\n   * ex: Bluetooth is off, Printer is off, etc.\n   */\n  addListener(\n    eventName: BrotherPrintEventsEnum.onPrintFailedCommunication,\n    listenerFunc: (info: ErrorInfo) => void,\n  ): Promise<PluginListenerHandle>;\n\n  /**\n   * Failed to print.\n   */\n  addListener(\n    eventName: BrotherPrintEventsEnum.onPrintError,\n    listenerFunc: (info: ErrorInfo) => void,\n  ): Promise<PluginListenerHandle>;\n}\n"]}
+{"version":3,"file":"definitions.js","sourceRoot":"","sources":["../../src/definitions.ts"],"names":[],"mappings":"","sourcesContent":["import type { PluginListenerHandle } from '@capacitor/core';\n\nimport type { BrotherPrintEventsEnum } from './events.enum';\nimport type {\n  BRLMChannelResult,\n  BRLMPrintOptions,\n  BRLMSearchOption,\n  ErrorInfo,\n  isChannelAvailableResult,\n} from './interfaces';\n\nexport interface BrotherPrintPlugin {\n  printImage(options: BRLMPrintOptions): Promise<void>;\n\n  /**\n   * Search for printers. If not found, it will return an empty array.(not error)\n   */\n  search(option: BRLMSearchOption): Promise<void>;\n\n  /**\n   * If you have saved the last connected BRLMChannelResult,\n   * you can use it to verify whether it is currently usable.\n   */\n  isChannelAvailable(option: BRLMChannelResult): Promise<isChannelAvailableResult>;\n\n  /**\n   * Stop an active search before its timeout, including when leaving the screen.\n   */\n  cancelSearchWiFiPrinter(): Promise<void>;\n\n  /**\n   * Stop an active search before its timeout, including when leaving the screen.\n   */\n  cancelSearchBluetoothPrinter(): Promise<void>;\n\n  /**\n   * Find the printer that can connected to the device.\n   */\n  addListener(\n    eventName: BrotherPrintEventsEnum.onPrinterAvailable,\n    listenerFunc: (printers: BRLMChannelResult) => void,\n  ): Promise<PluginListenerHandle>;\n\n  /**\n   * Success Print Event\n   */\n  addListener(eventName: BrotherPrintEventsEnum.onPrint, listenerFunc: () => void): Promise<PluginListenerHandle>;\n\n  /**\n   * Failed to connect to the printer.\n   * ex: Bluetooth is off, Printer is off, etc.\n   */\n  addListener(\n    eventName: BrotherPrintEventsEnum.onPrintFailedCommunication,\n    listenerFunc: (info: ErrorInfo) => void,\n  ): Promise<PluginListenerHandle>;\n\n  /**\n   * Failed to print.\n   */\n  addListener(\n    eventName: BrotherPrintEventsEnum.onPrintError,\n    listenerFunc: (info: ErrorInfo) => void,\n  ): Promise<PluginListenerHandle>;\n}\n"]}

package/dist/esm/interfaces.d.ts

@@ -124,6 +124,12 @@ export type BRLMSearchOption = {
      * use only port is 'wifi' or 'bluetoothLowEnergy'.
      */
     searchDuration: number;
+    /**
+     * Android Bluetooth Classic only. Include only devices whose Bluetooth class
+     * reports a printer. Defaults to false; ignored for other ports and on iOS.
+     * This does not identify Brother devices. Devices with an unknown class are excluded when true.
+     */
+    bluetoothPrintersOnly?: boolean;
 };
 export type ErrorInfo = {
     message: string;

package/dist/esm/interfaces.js.map

@@ -1 +1 @@
-{"version":3,"file":"interfaces.js","sourceRoot":"","sources":["../../src/interfaces.ts"],"names":[],"mappings":"","sourcesContent":["import type {\n  BRLMPrinterLabelName,\n  BRLMPrinterModelName,\n  BRLMPrinterAutoCutType,\n  BRLMPrinterCompressMode,\n  BRLMPrinterHalftone,\n  BRLMPrinterHalftoneThresholdType,\n  BRLMPrinterHorizontalAlignment,\n  BRLMPrinterNumberOfCopies,\n  BRLMPrinterPrintQuality,\n  BRLMPrinterImageRotation,\n  BRLMPrinterScaleMode,\n  BRLMPrinterScaleValueType,\n  BRLMPrinterVerticalAlignment,\n  BRLMPrinterCustomPaperType,\n  BRLMPrinterCustomPaperUnit,\n  BRLMPrinterPort,\n} from './brother-printer.enum';\n\nexport type BRLMChannelResult = {\n  port: BRLMPrinterPort;\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};\n\nexport type BRLMPrintOptions = {\n  encodedImage: string;\n\n  /**\n   * Should use enum BRLMPrinterModelName\n   */\n  modelName: BRLMPrinterModelName;\n} & Partial<BRLMChannelResult> &\n  (BRLMPrinterQLModelSettings | BRLMPrinterTDModelSettings);\n\nexport type isChannelAvailableResult = {\n  result: boolean;\n};\n\nexport type BRLMPrinterTDModelSettings = {\n  /**\n   * Should use enum BRKMPrinterCustomPaperType\n   */\n  paperType: BRLMPrinterCustomPaperType;\n\n  /**\n   * The width of the label. For example, the RD-U04J1 is 60.0 wide.\n   */\n  tapeWidth: number;\n\n  /**\n   * The length of the label. For example, the RD-U04J1 is 60.0 wide.\n   */\n  tapeLength: number;\n\n  /**\n   * It is the difference between a sticker and a mount.\n   * For example, the RD-U04J1 is `1.0, 2.0, 1.0, 2.0`\n   */\n  marginTop: number;\n  marginRight: number;\n  marginBottom: number;\n  marginLeft: number;\n\n  /**\n   * The spacing between seals. For example, the RD-U04J1 is 0.2.\n   */\n  gapLength: number;\n\n  paperMarkPosition: number;\n  paperMarkLength: number;\n\n  /**\n   * Should use enum BRKMPrinterCustomPaperUnit.\n   * For example, the RD-U04J1 is mm.\n   */\n  paperUnit: BRLMPrinterCustomPaperUnit;\n};\n\nexport type BRLMPrinterQLModelSettings = {\n  /**\n   * Should use enum BRLMPrinterLabelName\n   */\n  labelName: BRLMPrinterLabelName;\n} & BRLMPrinterSettings;\n\n/**\n * These are optional. If these are not set, default values are assigned by the printer.\n */\nexport type BRLMPrinterSettings = {\n  /**\n   * The number of copies you print.\n   */\n  numberOfCopies?: BRLMPrinterNumberOfCopies;\n\n  /**\n   * Whether the auto-cut is enabled or not. If true, your printer cut the paper each page.\n   */\n  autoCut?: BRLMPrinterAutoCutType;\n\n  /**\n   * A scale mode that specifies how your data is scaled in a print area of your printer.\n   */\n  scaleMode?: BRLMPrinterScaleMode;\n\n  /**\n   * A scale value. This is effective when ScaleMode is ScaleValue.\n   */\n  scaleValue?: BRLMPrinterScaleValueType;\n\n  /**\n   * A way to rasterize your data.\n   */\n  halftone?: BRLMPrinterHalftone;\n\n  /**\n   * A threshold value. This is effective when the Halftone is Threshold.\n   */\n  halftoneThreshold?: BRLMPrinterHalftoneThresholdType;\n\n  /**\n   * An image rotation that specifies the angle in which your data is placed in the print area. Rotation direction is clockwise.\n   */\n  imageRotation?: BRLMPrinterImageRotation;\n\n  /**\n   * A vertical alignment that specifies how your data is placed in the printable area.\n   */\n  verticalAlignment?: BRLMPrinterVerticalAlignment;\n\n  /**\n   * A horizontal alignment that specifies how your data is placed in the printable area.\n   */\n  horizontalAlignment?: BRLMPrinterHorizontalAlignment;\n\n  /**\n   * A compress mode that specifies how to compress your data.\n   * note: This is ios only.\n   */\n  compressMode?: BRLMPrinterCompressMode;\n\n  /**\n   * A priority that is print speed or print quality. Whether or not this has an effect is depend on your printer.\n   */\n  printQuality?: BRLMPrinterPrintQuality;\n};\n\nexport type BRLMSearchOption = {\n  /**\n   * 'usb' is android only, and now developing.\n   */\n  port: BRLMPrinterPort;\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};\n\nexport type ErrorInfo = {\n  message: string;\n  code: number;\n};\n"]}
+{"version":3,"file":"interfaces.js","sourceRoot":"","sources":["../../src/interfaces.ts"],"names":[],"mappings":"","sourcesContent":["import type {\n  BRLMPrinterLabelName,\n  BRLMPrinterModelName,\n  BRLMPrinterAutoCutType,\n  BRLMPrinterCompressMode,\n  BRLMPrinterHalftone,\n  BRLMPrinterHalftoneThresholdType,\n  BRLMPrinterHorizontalAlignment,\n  BRLMPrinterNumberOfCopies,\n  BRLMPrinterPrintQuality,\n  BRLMPrinterImageRotation,\n  BRLMPrinterScaleMode,\n  BRLMPrinterScaleValueType,\n  BRLMPrinterVerticalAlignment,\n  BRLMPrinterCustomPaperType,\n  BRLMPrinterCustomPaperUnit,\n  BRLMPrinterPort,\n} from './brother-printer.enum';\n\nexport type BRLMChannelResult = {\n  port: BRLMPrinterPort;\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};\n\nexport type BRLMPrintOptions = {\n  encodedImage: string;\n\n  /**\n   * Should use enum BRLMPrinterModelName\n   */\n  modelName: BRLMPrinterModelName;\n} & Partial<BRLMChannelResult> &\n  (BRLMPrinterQLModelSettings | BRLMPrinterTDModelSettings);\n\nexport type isChannelAvailableResult = {\n  result: boolean;\n};\n\nexport type BRLMPrinterTDModelSettings = {\n  /**\n   * Should use enum BRKMPrinterCustomPaperType\n   */\n  paperType: BRLMPrinterCustomPaperType;\n\n  /**\n   * The width of the label. For example, the RD-U04J1 is 60.0 wide.\n   */\n  tapeWidth: number;\n\n  /**\n   * The length of the label. For example, the RD-U04J1 is 60.0 wide.\n   */\n  tapeLength: number;\n\n  /**\n   * It is the difference between a sticker and a mount.\n   * For example, the RD-U04J1 is `1.0, 2.0, 1.0, 2.0`\n   */\n  marginTop: number;\n  marginRight: number;\n  marginBottom: number;\n  marginLeft: number;\n\n  /**\n   * The spacing between seals. For example, the RD-U04J1 is 0.2.\n   */\n  gapLength: number;\n\n  paperMarkPosition: number;\n  paperMarkLength: number;\n\n  /**\n   * Should use enum BRKMPrinterCustomPaperUnit.\n   * For example, the RD-U04J1 is mm.\n   */\n  paperUnit: BRLMPrinterCustomPaperUnit;\n};\n\nexport type BRLMPrinterQLModelSettings = {\n  /**\n   * Should use enum BRLMPrinterLabelName\n   */\n  labelName: BRLMPrinterLabelName;\n} & BRLMPrinterSettings;\n\n/**\n * These are optional. If these are not set, default values are assigned by the printer.\n */\nexport type BRLMPrinterSettings = {\n  /**\n   * The number of copies you print.\n   */\n  numberOfCopies?: BRLMPrinterNumberOfCopies;\n\n  /**\n   * Whether the auto-cut is enabled or not. If true, your printer cut the paper each page.\n   */\n  autoCut?: BRLMPrinterAutoCutType;\n\n  /**\n   * A scale mode that specifies how your data is scaled in a print area of your printer.\n   */\n  scaleMode?: BRLMPrinterScaleMode;\n\n  /**\n   * A scale value. This is effective when ScaleMode is ScaleValue.\n   */\n  scaleValue?: BRLMPrinterScaleValueType;\n\n  /**\n   * A way to rasterize your data.\n   */\n  halftone?: BRLMPrinterHalftone;\n\n  /**\n   * A threshold value. This is effective when the Halftone is Threshold.\n   */\n  halftoneThreshold?: BRLMPrinterHalftoneThresholdType;\n\n  /**\n   * An image rotation that specifies the angle in which your data is placed in the print area. Rotation direction is clockwise.\n   */\n  imageRotation?: BRLMPrinterImageRotation;\n\n  /**\n   * A vertical alignment that specifies how your data is placed in the printable area.\n   */\n  verticalAlignment?: BRLMPrinterVerticalAlignment;\n\n  /**\n   * A horizontal alignment that specifies how your data is placed in the printable area.\n   */\n  horizontalAlignment?: BRLMPrinterHorizontalAlignment;\n\n  /**\n   * A compress mode that specifies how to compress your data.\n   * note: This is ios only.\n   */\n  compressMode?: BRLMPrinterCompressMode;\n\n  /**\n   * A priority that is print speed or print quality. Whether or not this has an effect is depend on your printer.\n   */\n  printQuality?: BRLMPrinterPrintQuality;\n};\n\nexport type BRLMSearchOption = {\n  /**\n   * 'usb' is android only, and now developing.\n   */\n  port: BRLMPrinterPort;\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  /**\n   * Android Bluetooth Classic only. Include only devices whose Bluetooth class\n   * reports a printer. Defaults to false; ignored for other ports and on iOS.\n   * This does not identify Brother devices. Devices with an unknown class are excluded when true.\n   */\n  bluetoothPrintersOnly?: boolean;\n};\n\nexport type ErrorInfo = {\n  message: string;\n  code: number;\n};\n"]}

package/docs/events.md

@@ -0,0 +1,58 @@
+# Events
+
+Listen for discovered printers and print results. Register listeners before [Search](/docs/search) and [Print](/docs/print) so the first events are not missed.
+
+```typescript
+import type { PluginListenerHandle } from '@capacitor/core';
+import { BrotherPrint, BrotherPrintEventsEnum } from '@rdlabo/capacitor-brotherprint';
+
+const handles: PluginListenerHandle[] = [];
+
+const registerPrintListeners = async () => {
+  handles.push(
+    await BrotherPrint.addListener(BrotherPrintEventsEnum.onPrinterAvailable, (printer) => {
+      console.log('printer', printer.channelInfo);
+    }),
+  );
+  handles.push(
+    await BrotherPrint.addListener(BrotherPrintEventsEnum.onPrint, () => {
+      console.log('onPrint');
+    }),
+  );
+  handles.push(
+    await BrotherPrint.addListener(BrotherPrintEventsEnum.onPrintFailedCommunication, (info) => {
+      console.log('onPrintFailedCommunication', info);
+    }),
+  );
+  handles.push(
+    await BrotherPrint.addListener(BrotherPrintEventsEnum.onPrintError, (info) => {
+      console.log('onPrintError', info);
+    }),
+  );
+};
+
+const removePrintListeners = async () => {
+  await Promise.all(handles.map((handle) => handle.remove()));
+};
+```
+
+| Event                        | When it fires                        |
+| ---------------------------- | ------------------------------------ |
+| `onPrinterAvailable`         | A printer that can connect was found |
+| `onPrint`                    | Print succeeded                      |
+| `onPrintFailedCommunication` | The printer could not be reached     |
+| `onPrintError`               | Print failed                         |
+
+When `printImage` rejects an invalid image, unsupported model or port, or a print-settings creation failure, it also emits `onPrintError` with `code: 0` and an explanatory `message`. This code denotes a plugin validation error, not an SDK error. Failure to open the printer channel emits `onPrintFailedCommunication` instead.
+
+See the demo for a complete page:
+
+https://github.com/rdlabo-dev/capacitor-brotherprint/blob/v8.1.1/demo/src/app/home/home.page.ts
+
+<!-- !::addListener.BrotherPrintEventsEnum:: -->
+
+<!-- !::BrotherPrintEventsEnum:: -->
+
+<!-- !::PluginListenerHandle:: -->
+
+<!-- !::ErrorInfo:: -->

package/docs/installation.md

@@ -0,0 +1,133 @@
+# Installation
+
+## Install
+
+```
+npm install @rdlabo/capacitor-brotherprint
+```
+
+The published plugin package declares an SPM dependency on a **local** Brother kit at your app root:
+
+`ios/LocalPackages/BRLMPrinterKit`
+
+That path is relative from `node_modules/@rdlabo/capacitor-brotherprint` (`../../../ios/LocalPackages/BRLMPrinterKit`). Place the Brother iOS SDK under your Capacitor app’s `ios` tree as shown below, then run `npx cap sync`. This plugin requires **iOS 15** and **Swift Package Manager** only (no CocoaPods / Podfile steps).
+
+This plugin does not redistribute the Brother SDK. Download it from Brother’s official pages for your platform.
+
+## Initialize the Brother SDK
+
+### Android configuration
+
+1. Place the following files in the android folder of your Capacitor project:
+
+- `android/BrotherPrintLibrary/BrotherPrintLibrary.aar`
+- `android/BrotherPrintLibrary/build.gradle`
+
+Download the Android SDK from Brother: https://support.brother.co.jp/j/s/es/dev/ja/mobilesdk/android/index.html?c=jp&lang=ja&navi=offall&comple=on&redirect=on#ver4
+
+2. In `android/BrotherPrintLibrary/build.gradle`, include:
+
+```
+configurations.maybeCreate("default")
+artifacts.add("default", file('BrotherPrintLibrary.aar'))
+```
+
+3. Open `android/settings.gradle` and add:
+
+```
+include ':BrotherPrintLibrary'
+project(':BrotherPrintLibrary').projectDir = new File('./BrotherPrintLibrary/')
+```
+
+### iOS configuration
+
+1. Under your Capacitor app (not inside `node_modules`), place:
+
+- `ios/LocalPackages/BRLMPrinterKit/Sources/BRLMPrinterKit.xcframework`
+- `ios/LocalPackages/BRLMPrinterKit/Package.swift`
+
+Download the iOS SDK from Brother: https://support.brother.com/g/s/es/dev/en/mobilesdk/ios/index.html
+
+2. Create `ios/LocalPackages/BRLMPrinterKit/Package.swift` for that local binary package (minimum iOS 15 to match the plugin):
+
+```swift
+// swift-tools-version: 5.9
+import PackageDescription
+
+let package = Package(
+    name: "BRLMPrinterKit",
+    platforms: [
+        .iOS(.v15)
+    ],
+    products: [
+        .library(name: "BRLMPrinterKit", targets: ["BRLMPrinterKit"])
+    ],
+    targets: [
+        .binaryTarget(
+            name: "BRLMPrinterKit",
+            path: "Sources/BRLMPrinterKit.xcframework"
+        )
+    ]
+)
+```
+
+3. After the SDK files are in place, run `npx cap sync` so the app’s iOS project picks up the plugin and the local package path.
+
+## Permission configuration
+
+### Android configuration
+
+Update `AndroidManifest.xml` to include the following permissions:
+
+```diff
+- <manifest xmlns:android="http://schemas.android.com/apk/res/android">
++ <manifest xmlns:android="http://schemas.android.com/apk/res/android"
++    xmlns:tools="http://schemas.android.com/tools">
+...
++     <!-- For Bluetooth -->
++     <uses-permission android:name="android.permission.BLUETOOTH" />
++     <uses-permission android:name="android.permission.BLUETOOTH_ADMIN" />
++     <uses-permission android:name="android.permission.BLUETOOTH_CONNECT" />
+
++     <!-- For Bluetooth Low Energy, Android 11 and earlier-->
++     <uses-permission android:name="android.permission.ACCESS_COARSE_LOCATION" />
++     <uses-permission android:name="android.permission.ACCESS_FINE_LOCATION" />
+
++     <!-- For Bluetooth Low Energy, Android 12 and later -->
++     <uses-permission android:name="android.permission.BLUETOOTH_SCAN"
++         android:usesPermissionFlags="neverForLocation"
++         tools:targetApi="s" />
+```
+
+More information: https://support.brother.co.jp/j/s/support/html/mobilesdk/guide/getting-started/getting-started-android.html
+
+### iOS configuration
+
+Update `Info.plist` to include the following keys. `UISupportedExternalAccessoryProtocols` must be an **array of strings**.
+
+```diff
++ <key>NSBluetoothAlwaysUsageDescription</key>
++ <string>【Why use Bluetooth for your app.】</string>
++ <key>NSBluetoothPeripheralUsageDescription</key>
++ <string>【Why use Bluetooth for your app.】</string>
++ <key>NSBonjourServices</key>
++ <array>
++ 	<string>_pdl-datastream._tcp</string>
++ 	<string>_printer._tcp</string>
++ 	<string>_ipp._tcp</string>
++ </array>
++ <key>NSLocalNetworkUsageDescription</key>
++ <string>【Why use WiFi for your app.】</string>
++ <key>UISupportedExternalAccessoryProtocols</key>
++ <array>
++ 	<string>com.brother.ptcbp</string>
++ </array>
+```
+
+#### Bluetooth plist types (verified September 9, 2026)
+
+`UISupportedExternalAccessoryProtocols` must be an **array of strings**, even when `com.brother.ptcbp` is the only protocol. Earlier versions of this repository's example incorrectly used a single `<string>`, which caused Bluetooth discovery to crash with `-[__NSCFString count]: unrecognized selector`. Use the `<array>` shown above. See [Apple's type definition](https://developer.apple.com/documentation/bundleresources/information-property-list/uisupportedexternalaccessoryprotocols).
+
+The `NSBluetoothAlwaysUsageDescription` and `NSBluetoothPeripheralUsageDescription` values are **strings**, not arrays. The examples for these keys in [Brother's official iOS setup guide](https://support.brother.com/g/s/es/htmldoc/mobilesdk/guide/getting-started/getting-started-ios.html) are correct as of September 9, 2026; they were not the cause of this crash. Brother's guide separately instructs adding `com.brother.ptcbp` as an item under `UISupportedExternalAccessoryProtocols`. It requires `NSBluetoothPeripheralUsageDescription` additionally only for deployment targets earlier than iOS 13.
+
+More information: https://support.brother.co.jp/j/s/support/html/mobilesdk/guide/getting-started/getting-started-ios.html