Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/rdlabo-team/capacitor-brotherprint
Capacitor plugin for Brother Print SDK
https://github.com/rdlabo-team/capacitor-brotherprint
Last synced: about 2 months ago
JSON representation
Capacitor plugin for Brother Print SDK
- Host: GitHub
- URL: https://github.com/rdlabo-team/capacitor-brotherprint
- Owner: rdlabo-team
- Created: 2020-08-02T12:32:06.000Z (over 4 years ago)
- Default Branch: main
- Last Pushed: 2024-11-12T08:35:11.000Z (2 months ago)
- Last Synced: 2024-11-12T09:28:23.910Z (2 months ago)
- Language: Swift
- Size: 23.4 MB
- Stars: 10
- Watchers: 2
- Forks: 5
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
- awesome-capacitor - Brother Print - A native Brother Print SDK implementation for iOS & Android. (Other plugins)
README
# @rdlabo/capacitor-brotherprint
Capacitor Brother Print is a native Brother Print SDK implementation for iOS & Android. Support These models.
**This plugin is still in the RC (release candidate) phase.**
## Supported models
Each product link is an Amazon affiliate link. If you choose to make a purchase through these links, it would be greatly appreciated and **would help** support development costs. Thank you!
| 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-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 | ◯ | △ | △ | ◯ | ◯ | ◯ | △ |
Amazon Affiliate Links: **https://amzn.to/3AiiOFT**
**Supplement**
| | description |
| --- | -------------------------- |
| ◯ | Supported and tested |
| △ | Implemented but not tested |
| - | Plugin is not supported |
| ✗ | Device is not supported |
| BT | Bluetooth |
| BLE | Bluetooth Low Energy |
※1 Due to low Bluetooth version, connection is not possible with iOS. Ref: https://okbizcs.okwave.jp/brother/qa/q9932082.html
※2 The iOS/BT implementation for the QL-820NWBc is in place, but it’s uncertain if it functions correctly. It’s unclear whether this is an implementation issue, as Brother’s official app also doesn’t work well.
## How to install
```
% npm install @rdlabo/capacitor-brotherprint
```
## 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`
The `BrotherPrintLibrary.aar` file is the Brother Print SDK library, which you can download from the Brother website: 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 the `android/BrotherPrintLibrary/build.gradle file`, include the following content:
```
configurations.maybeCreate(“default”)
artifacts.add(“default”, file('BrotherPrintLibrary.aar'))
```
3. Open `android/settings.gradle` and add the following lines:
```
include ':BrotherPrintLibrary'
project(':BrotherPrintLibrary').projectDir = new File('./BrotherPrintLibrary/')
```
These steps will integrate the Brother Print SDK with your Capacitor Android project.
### iOS configuration
Update the `ios/App/Podfile` file at your project. https://github.com/BernardRadman/BRLMPrinterKit 's SDK is version 4.7.2. This is old. So should link to direct own repository.
```diff
target 'App' do
capacitor_pods
# Add your Pods here
+ pod 'BRLMPrinterKit_v4', :git => 'https://github.com/rdlabo/BRLMPrinterKit.git', :branch => 'feat/update_4_9_1'
end
```
After set, run `pod update` in the `ios` directory.
## Permission configuration
### Android configuration
Update `AndroidManifest.xml` to include the following permissions:
```diff
-
+
...
+
+
+
+
+
+
+
+
+
```
More information is here: 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 permissions:
```diff
+ NSBluetoothAlwaysUsageDescription
+ 【Why use Bluetooth for your app.】
+ NSBluetoothPeripheralUsageDescription
+ 【Why use Bluetooth for your app.】
+ NSBonjourServices
+
+ _pdl-datastream._tcp
+ _printer._tcp
+ _ipp._tcp
+
+ NSLocalNetworkUsageDescription
+ 【Why use WiFi for your app.】
+ UISupportedExternalAccessoryProtocols
+ com.brother.ptcbp
```
More information is here: https://support.brother.co.jp/j/s/support/html/mobilesdk/guide/getting-started/getting-started-ios.html
## How to use
```typescript
@Component({
selector: 'brother-print',
templateUrl: 'brother.component.html',
styleUrls: ['brother.component.scss'],
})
export class BrotherComponent implements OnInit, OnDestroy {
readonly #listenerHandlers: PluginListenerHandle[] = [];
readonly printers = signal([]);
async ngOnInit() {
this.#listenerHandlers.push(
await BrotherPrint.addListener(BrotherPrintEventsEnum.onPrint, () => {
console.log('onPrint');
}),
);
this.#listenerHandlers.push(
await BrotherPrint.addListener(
BrotherPrintEventsEnum.onPrintError,
info => {
console.log('onPrintError');
},
),
);
this.#listenerHandlers.push(
await BrotherPrint.addListener(
BrotherPrintEventsEnum.onPrintFailedCommunication,
info => {
console.log('onPrintFailedCommunication');
},
),
);
this.#listenerHandlers.push(
await BrotherPrint.addListener(
BrotherPrintEventsEnum.onPrinterAvailable,
printer => {
this.printers.update(prev => [...prev, printer]);
},
),
);
}
async ngOnDestroy() {
this.#listenerHandlers.forEach(handler => handler.remove());
}
async searchPrinter(port: BRKMPrinterPort) {
// This method return void. Get the printer list by listening to the event.
await BrotherPrint.search({
port,
searchDuration: 15, // seconds
});
}
print() {
if (this.printers().length === 0) {
console.error('No printer found');
return;
}
const defaultPrintSettings: BRLMPrintOptions = {
modelName: BRLMPrinterModelName.QL_820NWB,
labelName: BRLMPrinterLabelName.RollW62,
encodedImage: 'base64 removed mime-type', // base64
numberOfCopies: 1, // default 1
autoCut: true, // default true
};
BrotherPrint.printImage({
...defaultPrintSettings,
...{
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
- [`printImage(...)`](#printimage)
- [`search(...)`](#search)
- [`cancelSearchWiFiPrinter()`](#cancelsearchwifiprinter)
- [`cancelSearchBluetoothPrinter()`](#cancelsearchbluetoothprinter)
- [`addListener(BrotherPrintEventsEnum.onPrinterAvailable, ...)`](#addlistenerbrotherprinteventsenumonprinteravailable-)
- [`addListener(BrotherPrintEventsEnum.onPrint, ...)`](#addlistenerbrotherprinteventsenumonprint-)
- [`addListener(BrotherPrintEventsEnum.onPrintFailedCommunication, ...)`](#addlistenerbrotherprinteventsenumonprintfailedcommunication-)
- [`addListener(BrotherPrintEventsEnum.onPrintError, ...)`](#addlistenerbrotherprinteventsenumonprinterror-)
- [Interfaces](#interfaces)
- [Type Aliases](#type-aliases)
- [Enums](#enums)
### printImage(...)
```typescript
printImage(options: BRLMPrintOptions) => Promise
```
| Param | Type |
| ------------- | ------------------------------------------------------------- |
| **`options`** | BRLMPrintOptions |
---
### search(...)
```typescript
search(option: BRLMSearchOption) => Promise
```
Search for printers. If not found, it will return an empty array.(not error)
| Param | Type |
| ------------ | ------------------------------------------------------------- |
| **`option`** | BRLMSearchOption |
---
### cancelSearchWiFiPrinter()
```typescript
cancelSearchWiFiPrinter() => Promise
```
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.
---
### cancelSearchBluetoothPrinter()
```typescript
cancelSearchBluetoothPrinter() => Promise
```
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.
---
### addListener(BrotherPrintEventsEnum.onPrinterAvailable, ...)
```typescript
addListener(eventName: BrotherPrintEventsEnum.onPrinterAvailable, listenerFunc: (printers: BRLMChannelResult) => void) => Promise
```
Find the printer that can connected to the device.
| Param | Type |
| ------------------ | -------------------------------------------------------------------------------------------- |
| **`eventName`** | BrotherPrintEventsEnum.onPrinterAvailable |
| **`listenerFunc`** | (printers: BRLMChannelResult) => void |
**Returns:** Promise<PluginListenerHandle>
---
### addListener(BrotherPrintEventsEnum.onPrint, ...)
```typescript
addListener(eventName: BrotherPrintEventsEnum.onPrint, listenerFunc: () => void) => Promise
```
Success Print Event
| Param | Type |
| ------------------ | --------------------------------------------------------------------------------- |
| **`eventName`** | BrotherPrintEventsEnum.onPrint |
| **`listenerFunc`** | () => void |
**Returns:** Promise<PluginListenerHandle>
---
### addListener(BrotherPrintEventsEnum.onPrintFailedCommunication, ...)
```typescript
addListener(eventName: BrotherPrintEventsEnum.onPrintFailedCommunication, listenerFunc: (info: ErrorInfo) => void) => Promise
```
Failed to connect to the printer.
ex: Bluetooth is off, Printer is off, etc.
| Param | Type |
| ------------------ | ---------------------------------------------------------------------------------------------------- |
| **`eventName`** | BrotherPrintEventsEnum.onPrintFailedCommunication |
| **`listenerFunc`** | (info: ErrorInfo) => void |
**Returns:** Promise<PluginListenerHandle>
---
### addListener(BrotherPrintEventsEnum.onPrintError, ...)
```typescript
addListener(eventName: BrotherPrintEventsEnum.onPrintError, listenerFunc: (info: ErrorInfo) => void) => Promise
```
Failed to print.
| Param | Type |
| ------------------ | -------------------------------------------------------------------------------------- |
| **`eventName`** | BrotherPrintEventsEnum.onPrintError |
| **`listenerFunc`** | (info: ErrorInfo) => void |
**Returns:** Promise<PluginListenerHandle>
---
### Interfaces
#### PluginListenerHandle
| Prop | Type |
| ------------ | ----------------------------------------- |
| **`remove`** | () => Promise<void> |
### Type Aliases
#### BRLMPrintOptions
{ encodedImage: string; /\*\* _ Should use enum BRLMPrinterModelName _/ modelName: BRLMPrinterModelName; } & Partial<BRLMChannelResult> & (BRLMPrinterQLModelSettings | BRLMPrinterTDModelSettings)
#### Partial
Make all properties in T optional
{
[P in keyof T]?: T[P];
}
#### BRLMChannelResult
{ port: BRLMPrinterPort; 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; }
#### BRLMPrinterQLModelSettings
{ /\*\* _ Should use enum BRLMPrinterLabelName _/ labelName: BRLMPrinterLabelName; } & BRLMPrinterSettings
#### BRLMPrinterSettings
These are optional. If these are not set, default values are assigned by the printer.
{ /** _ The number of copies you print. _/ numberOfCopies?: BRLMPrinterNumberOfCopies; /** _ Whether the auto-cut is enabled or not. If true, your printer cut the paper each page. _/ autoCut?: BRLMPrinterAutoCutType; /** _ A scale mode that specifies how your data is scaled in a print area of your printer. _/ scaleMode?: BRLMPrinterScaleMode; /** _ A scale value. This is effective when ScaleMode is ScaleValue. _/ scaleValue?: BRLMPrinterScaleValueType; /** _ A way to rasterize your data. _/ halftone?: BRLMPrinterHalftone; /** _ A threshold value. This is effective when the Halftone is Threshold. _/ halftoneThreshold?: BRLMPrinterHalftoneThresholdType; /** _ An image rotation that specifies the angle in which your data is placed in the print area. Rotation direction is clockwise. _/ imageRotation?: BRLMPrinterImageRotation; /** _ A vertical alignment that specifies how your data is placed in the printable area. _/ verticalAlignment?: BRLMPrinterVerticalAlignment; /** _ A horizontal alignment that specifies how your data is placed in the printable area. _/ horizontalAlignment?: BRLMPrinterHorizontalAlignment; /** _ A compress mode that specifies how to compress your data. _ note: This is ios only. _/ compressMode?: BRLMPrinterCompressMode; /\*\* _ A priority that is print speed or print quality. Whether or not this has an effect is depend on your printer. \*/ printQuality?: BRLMPrinterPrintQuality; }
#### BRLMPrinterNumberOfCopies
number
#### BRLMPrinterAutoCutType
boolean
#### BRLMPrinterScaleValueType
number
#### BRLMPrinterHalftoneThresholdType
number
#### BRLMPrinterTDModelSettings
{ /** _ Should use enum BRKMPrinterCustomPaperType _/ paperType: BRLMPrinterCustomPaperType; /** _ The width of the label. For example, the RD-U04J1 is 60.0 wide. _/ tapeWidth: number; /** _ The length of the label. For example, the RD-U04J1 is 60.0 wide. _/ tapeLength: number; /** _ It is the difference between a sticker and a mount. _ For example, the RD-U04J1 is `1.0, 2.0, 1.0, 2.0` _/ marginTop: number; marginRight: number; marginBottom: number; marginLeft: number; /\*\* _ The spacing between seals. For example, the RD-U04J1 is 0.2. _/ gapLength: number; paperMarkPosition: number; paperMarkLength: number; /\*\* _ Should use enum BRKMPrinterCustomPaperUnit. _ For example, the RD-U04J1 is mm. _/ paperUnit: BRLMPrinterCustomPaperUnit; }
#### BRLMSearchOption
{ /** _ 'usb' is android only, and now developing. _/ port: BRLMPrinterPort; /** _ searchDuration is the time to end search for devices. _ default is 15 seconds. _ use only port is 'wifi' or 'bluetoothLowEnergy'. _/ searchDuration: number; }
#### ErrorInfo
{ message: string; code: number; }
### Enums
#### BRLMPrinterModelName
| Members | Value |
| ------------------ | --------------------------- |
| **`QL_800`** | 'QL_800' |
| **`QL_810W`** | 'QL_810W' |
| **`QL_820NWB`** | 'QL_820NWB' |
| **`TD_2320D_203`** | 'TD_2320D_203' |
| **`TD_2030AD`** | 'TD_2030AD' |
| **`TD_2350D_300`** | 'TD_2350D_300' |
#### BRLMPrinterPort
| Members | Value |
| ------------------------ | --------------------------------- |
| **`usb`** | 'usb' |
| **`wifi`** | 'wifi' |
| **`bluetooth`** | 'bluetooth' |
| **`bluetoothLowEnergy`** | 'bluetoothLowEnergy' |
#### BRLMPrinterLabelName
| Members | Value | Description |
| --------------------- | ------------------------------ | ------------- |
| **`DieCutW17H54`** | 'DieCutW17H54' | |
| **`DieCutW17H87`** | 'DieCutW17H87' | |
| **`DieCutW23H23`** | 'DieCutW23H23' | |
| **`DieCutW29H42`** | 'DieCutW29H42' | |
| **`DieCutW29H90`** | 'DieCutW29H90' | |
| **`DieCutW38H90`** | 'DieCutW38H90' | |
| **`DieCutW39H48`** | 'DieCutW39H48' | |
| **`DieCutW52H29`** | 'DieCutW52H29' | |
| **`DieCutW62H29`** | 'DieCutW62H29' | |
| **`DieCutW62H60`** | 'DieCutW62H60' | |
| **`DieCutW62H75`** | 'DieCutW62H75' | |
| **`DieCutW62H100`** | 'DieCutW62H100' | |
| **`DieCutW60H86`** | 'DieCutW60H86' | |
| **`DieCutW54H29`** | 'DieCutW54H29' | |
| **`DieCutW102H51`** | 'DieCutW102H51' | |
| **`DieCutW102H152`** | 'DieCutW102H152' | |
| **`DieCutW103H164`** | 'DieCutW103H164' | |
| **`RollW12`** | 'RollW12' | |
| **`RollW29`** | 'RollW29' | |
| **`RollW38`** | 'RollW38' | |
| **`RollW50`** | 'RollW50' | |
| **`RollW54`** | 'RollW54' | |
| **`RollW62`** | 'RollW62' | |
| **`RollW62RB`** | 'RollW62RB' | |
| **`RollW102`** | 'RollW102' | |
| **`RollW103`** | 'RollW103' | |
| **`DTRollW90`** | 'DTRollW90' | |
| **`DTRollW102`** | 'DTRollW102' | |
| **`DTRollW102H51`** | 'DTRollW102H51' | |
| **`DTRollW102H152`** | 'DTRollW102H152' | |
| **`RoundW12DIA`** | 'RoundW12DIA' | |
| **`RoundW24DIA`** | 'RoundW24DIA' | |
| **`RoundW58DIA`** | 'RoundW58DIA' | |
| **`RDDieCutW60H60`** | 'RDDieCutW60H60' | For TD series |
| **`RDDieCutW50H30`** | 'RDDieCutW50H30' | |
| **`RDDieCutW40H60`** | 'RDDieCutW40H60' | |
| **`RDDieCutW40H50`** | 'RDDieCutW40H50' | |
| **`RDDieCutW40H40`** | 'RDDieCutW40H40' | |
| **`RDDieCutW30H30`** | 'RDDieCutW30H30' | |
| **`RDDieCutW50H35`** | 'RDDieCutW50H35' | |
| **`RDDieCutW60H80`** | 'RDDieCutW60H80' | |
| **`RDDieCutW60H100`** | 'RDDieCutW60H100' | |
#### BRLMPrinterScaleMode
| Members | Value |
| -------------------- | ----------------------------- |
| **`ActualSize`** | 'ActualSize' |
| **`FitPageAspect`** | 'FitPageAspect' |
| **`FitPaperAspect`** | 'FitPaperAspect' |
| **`ScaleValue`** | 'ScaleValue' |
#### BRLMPrinterHalftone
| Members | Value |
| -------------------- | ----------------------------- |
| **`Threshold`** | 'Threshold' |
| **`ErrorDiffusion`** | 'ErrorDiffusion' |
| **`PatternDither`** | 'PatternDither' |
#### BRLMPrinterImageRotation
| Members | Value |
| --------------- | ------------------------ |
| **`Rotate0`** | 'Rotate0' |
| **`Rotate90`** | 'Rotate90' |
| **`Rotate180`** | 'Rotate180' |
| **`Rotate270`** | 'Rotate270' |
#### BRLMPrinterVerticalAlignment
| Members | Value |
| ------------ | --------------------- |
| **`Top`** | 'Top' |
| **`Center`** | 'Center' |
| **`Bottom`** | 'Bottom' |
#### BRLMPrinterHorizontalAlignment
| Members | Value |
| ------------ | --------------------- |
| **`Left`** | 'Left' |
| **`Center`** | 'Center' |
| **`Right`** | 'Right' |
#### BRLMPrinterCompressMode
| Members | Value |
| ----------- | -------------------- |
| **`None`** | 'None' |
| **`Tiff`** | 'Tiff' |
| **`Mode9`** | 'Mode9' |
#### BRLMPrinterPrintQuality
| Members | Value |
| ---------- | ------------------- |
| **`Best`** | 'Best' |
| **`Fast`** | 'Fast' |
#### BRLMPrinterCustomPaperType
| Members | Value |
| ------------------- | ---------------------------- |
| **`rollPaper`** | 'rollPaper' |
| **`dieCutPaper`** | 'dieCutPaper' |
| **`markRollPaper`** | 'markRollPaper' |
#### BRLMPrinterCustomPaperUnit
| Members | Value |
| ---------- | ------------------- |
| **`mm`** | 'mm' |
| **`inch`** | 'inch' |
#### BrotherPrintEventsEnum
| Members | Value |
| -------------------------------- | ----------------------------------------- |
| **`onPrinterAvailable`** | 'onPrinterAvailable' |
| **`onPrint`** | 'onPrint' |
| **`onPrintFailedCommunication`** | 'onPrintFailedCommunication' |
| **`onPrintError`** | 'onPrintError' |