@mmote/niimblue-node 0.0.7 → 0.0.9

package/README.md

@@ -6,10 +6,20 @@ Command line interface, simple REST server are also included.
 
 Tested with:
 
+Windows:
+
 * Windows 10
 * Bluetooth adapter (TP-LINK UB500)
 * USB serial connection
-* Printers: B1, D110
+* Printers: B1, D110, B21_C2B, B21_PRO
+
+Mac:
+
+* macOS 15.5
+* Integrated Bluetooth adapter
+* Printer: D110
+
+[Protocol tested with these models (niimbluelib repo)](https://github.com/MultiMote/niimbluelib/issues/1).
 
 Usage example:
 
@@ -32,6 +42,11 @@ Windows requirements:
   - C++ build tools with `Windows SDK >=22000` must be installed
 * Python 3
 
+Mac requirements:
+
+* [Xcode](https://apps.apple.com/ca/app/xcode/id497799835)
+* Permissions: Open "System Settings" → "Privacy & Security" → "Bluetooth" and then add your terminal to allowed applications.
+
 See [node-gyp](https://github.com/nodejs/node-gyp) and [noble](https://github.com/abandonware/noble) installation.
 
 ### Command-line usage
@@ -72,12 +87,26 @@ D110 BLE:
 niimblue-cli print -d -t ble -a 26:03:03:c3:f9:11 -p D110 -o left label_15x30.png
 ```
 
-B1 serial, long parameter names (will resize image to fit 50x30 label keeping aspect ration):
+D110 BLE via name:
+
+_Connecting via the Bluetooth device name instead of address is required on macOS. Find the device name with `niimblue-cli scan -t ble`._
+
+```bash
+niimblue-cli print -d -t ble -a 'D110-XXXXXXXXXX' -p D110 -o left -w 192 -h 96 label_15x30.png
+```
+
+B1 serial, long parameter names (will resize image to fit 50x30 label, keeping aspect ratio):
 
 ```bash
 niimblue-cli print --debug --transport serial --address COM8 --print-task B1 --print-direction top --label-width 384 --label-height 240 label_15x30.png
 ```
 
+B21_PRO BLE, long parameter names (will resize image to fit 50x30 300dpi label, don't keep aspect ratio):
+
+```bash
+niimblue-cli print --debug --transport ble --address c3:16:13:04:06:18 --print-task D110M_V4 --print-direction top --label-width 584 --label-height 354 --image-fit fill label_15x30.png
+```
+
 B1 firmware upgrade via serial:
 
 ```bash
@@ -98,4 +127,6 @@ Enable debug logging, set host and port, enable CORS:
 niimblue-cli server -d -h 0.0.0.0 -p 5000 --cors
 ```
 
-[Server API docs](https://multimote.github.io/niimblue-node/server/)
+See [sharp docs](https://sharp.pixelplumbing.com/api-resize/) for image resize options.
+
+[Server API docs](https://niimnode-docs.pages.dev/server/)

package/dist/cli/index.js

@@ -17,7 +17,7 @@ extra_typings_1.program
     .description("Printer information")
     .requiredOption("-d, --debug", "Debug information", false)
     .addOption(new extra_typings_1.Option("-t, --transport <type>", "Transport").makeOptionMandatory().choices(["ble", "serial"]))
-    .requiredOption("-a, --address <string>", "Device bluetooth address or serial port name/path")
+    .requiredOption("-a, --address <string>", "Device bluetooth address/name or serial port name/path")
     .action(worker_1.cliPrinterInfo);
 extra_typings_1.program
     .command("scan")
@@ -31,7 +31,7 @@ extra_typings_1.program
     .argument("<path>", "PNG image path")
     .requiredOption("-d, --debug", "Debug information", false)
     .addOption(new extra_typings_1.Option("-t, --transport <type>", "Transport").makeOptionMandatory().choices(["ble", "serial"]))
-    .requiredOption("-a, --address <string>", "Device bluetooth address or serial port name/path")
+    .requiredOption("-a, --address <string>", "Device bluetooth address/name or serial port name/path")
     .addOption(new extra_typings_1.Option("-o, --print-direction <dir>", "Print direction").choices(["left", "top"]))
     .addOption(new extra_typings_1.Option("-p, --print-task <type>", "Print task").choices(niimbluelib_1.printTaskNames))
     .requiredOption("-l, --label-type <type number>", "Label type", intOption, 1)
@@ -46,7 +46,7 @@ extra_typings_1.program
     "fill",
     "inside",
     "outside",
-]).default("contain"))
+]))
     .addOption(new extra_typings_1.Option("-m, --image-position <dir>", "Image position while resizing (label-width and label-height must be set)").choices([
     "left",
     "top",
@@ -57,7 +57,7 @@ extra_typings_1.program
     "bottom",
     "left bottom",
     "left top",
-]).default("centre"))
+]))
     .action(worker_1.cliConnectAndPrintImageFile);
 extra_typings_1.program
     .command("server")
@@ -72,7 +72,7 @@ extra_typings_1.program
     .description("Flash firmware")
     .requiredOption("-d, --debug", "Debug information", false)
     .addOption(new extra_typings_1.Option("-t, --transport <type>", "Transport").makeOptionMandatory().choices(["ble", "serial"]))
-    .requiredOption("-a, --address <string>", "Device bluetooth address or serial port name/path")
+    .requiredOption("-a, --address <string>", "Device bluetooth address/name or serial port name/path")
     .requiredOption("-f, --file <path>", "Firmware path")
     .requiredOption("-n, --new-version <version>", "New firmware version")
     .action(worker_1.cliFlashFirmware);

package/dist/cli/worker.d.ts

@@ -31,8 +31,8 @@ export interface PrintOptions {
     threshold: number;
     labelWidth?: number;
     labelHeight?: number;
-    imageFit: SharpImageFit;
-    imagePosition: SharpImagePosition;
+    imageFit?: SharpImageFit;
+    imagePosition?: SharpImagePosition;
     debug: boolean;
 }
 export declare const cliConnectAndPrintImageFile: (path: string, options: PrintOptions & TransportOptions) => Promise<never>;

package/dist/cli/worker.js

@@ -20,8 +20,8 @@ const cliConnectAndPrintImageFile = async (path, options) => {
     if (options.labelWidth !== undefined && options.labelHeight !== undefined) {
         image = image.resize(options.labelWidth, options.labelHeight, {
             kernel: sharp_1.default.kernel.nearest,
-            fit: options.imageFit,
-            position: options.imagePosition,
+            fit: options.imageFit ?? "contain",
+            position: options.imagePosition ?? "centre",
             background: "#fff",
         });
     }

package/dist/client/headless_ble_impl.d.ts

@@ -8,7 +8,7 @@ export declare class NiimbotHeadlessBleClient extends NiimbotAbstractClient {
     private device;
     private channel;
     constructor();
-    /** Set device mac address for connect */
+    /** Set device mac address or name for connect */
     setAddress(address: string): void;
     static waitAdapterReady(): Promise<void>;
     static scan(timeoutMs?: number): Promise<ScanItem[]>;

package/dist/client/headless_ble_impl.js

@@ -11,9 +11,9 @@ class NiimbotHeadlessBleClient extends niimbluelib_1.NiimbotAbstractClient {
         super();
         this.addr = "";
     }
-    /** Set device mac address for connect */
+    /** Set device mac address or name for connect */
     setAddress(address) {
-        this.addr = address.toLowerCase();
+        this.addr = address;
     }
     static async waitAdapterReady() {
         if (noble_1.default._state === "poweredOn") {
@@ -63,7 +63,8 @@ class NiimbotHeadlessBleClient extends niimbluelib_1.NiimbotAbstractClient {
         return new Promise((resolve, reject) => {
             let timer;
             noble_1.default.on("discover", async (peripheral) => {
-                if (peripheral.address === address) {
+                if (peripheral.address === address.toLowerCase() ||
+                    peripheral.advertisement.localName === address) {
                     clearTimeout(timer);
                     resolve(peripheral);
                 }
@@ -115,7 +116,7 @@ class NiimbotHeadlessBleClient extends niimbluelib_1.NiimbotAbstractClient {
     async connect() {
         await this.disconnect();
         if (!this.addr) {
-            throw new Error("Device address not set");
+            throw new Error("Device address or name not set");
         }
         await this.connectToDevice(this.addr);
         try {

package/dist/server/worker.d.ts

@@ -15,7 +15,7 @@ export declare const connected: () => Promise<{
 export declare const info: () => Promise<{
     printerInfo: import("@mmote/niimbluelib").PrinterInfo;
     modelMetadata: import("@mmote/niimbluelib").PrinterModelMeta | undefined;
-    detectedPrintTask: "D11_V1" | "D110" | "B1" | "B21_V1" | "V5" | undefined;
+    detectedPrintTask: "D11_V1" | "D110" | "B1" | "B21_V1" | "D110M_V4" | undefined;
 }>;
 export declare const print: (r: IncomingMessage) => Promise<{
     message: string;

package/dist/utils.js

@@ -66,7 +66,7 @@ const printImage = async (client, printTaskName, encoded, options) => {
     catch (e) {
         console.error(e);
     }
-    await client.abstraction.printEnd();
+    await printTask.printEnd();
 };
 exports.printImage = printImage;
 const loadImageFromBase64 = async (b64) => {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@mmote/niimblue-node",
-  "version": "0.0.7",
+  "version": "0.0.9",
   "description": "Headless clients for niimbluelib. Command line interface, simple REST server are also included.",
   "keywords": [
     "command-line",
@@ -9,6 +9,7 @@
     "niimbot",
     "niimbot-d110",
     "niimbot-b1",
+    "niimbot-b21",
     "bluetooth",
     "serial"
   ],
@@ -39,11 +40,12 @@
   "dependencies": {
     "@abandonware/noble": "^1.9.2-26",
     "@commander-js/extra-typings": "^12.1.0",
-    "@mmote/niimbluelib": "0.0.1-alpha.24",
+    "@mmote/niimbluelib": "0.0.1-alpha.29",
     "async-mutex": "^0.5.0",
     "commander": "^12.1.0",
     "serialport": "^12.0.0",
     "sharp": "^0.33.5",
     "zod": "^3.23.8"
-  }
+  },
+  "packageManager": "yarn@1.22.22+sha512.a6b2f7906b721bba3d67d4aff083df04dad64c399707841b7acf00f6b133b7ac24255f2652fa22ae3534329dc6180534e98d17432037ff6fd140556e2bb3137e"
 }