@opendisplay/opendisplay 1.0.1 → 1.1.1

package/README.md

@@ -3,7 +3,6 @@
 TypeScript library for OpenDisplay BLE e-paper displays using Web Bluetooth API. Control your OpenDisplay devices directly from the browser.
 
 [![npm version](https://badge.fury.io/js/@opendisplay%2Fopendisplay.svg)](https://www.npmjs.com/package/@opendisplay/opendisplay)
-[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
 
 ## Features
 
@@ -12,8 +11,6 @@ TypeScript library for OpenDisplay BLE e-paper displays using Web Bluetooth API.
 - **Automatic Image Processing**: Built-in dithering, encoding, and compression
 - **Type-Safe**: Full TypeScript support with exported types
 - **Device Discovery**: Browser-native device picker
-- **Protocol Compliance**: Byte-for-byte compatible with [py-opendisplay](https://github.com/OpenDisplay-org/py-opendisplay)
-
 ## Browser Compatibility
 
 Web Bluetooth API is required. Supported browsers:
@@ -188,7 +185,7 @@ Write configuration to device. Device must be rebooted for changes to take effec
 const config = device.config!;
 
 // Modify config
-config.displays[0].rotation = 180;
+config.displays[0].rotation = 1;
 
 // Write back to device
 await device.writeConfig(config);
@@ -234,7 +231,7 @@ Possible values:
 
 ##### `rotation: number`
 
-Display rotation in degrees (0, 90, 180, 270).
+Display rotation steps (by 90 degrees) (0, 1, 2, 3).
 
 ##### `config: GlobalConfig | null`
 
@@ -252,7 +249,7 @@ import { discoverDevices } from '@opendisplay/opendisplay';
 // Show device picker
 const device = await discoverDevices();
 // or with name filter
-const device = await discoverDevices('OpenDisplay');
+const device = await discoverDevices('OD');
 ```
 
 ### Types
@@ -441,15 +438,4 @@ npm run lint
 ## Related Packages
 
 - [@opendisplay/epaper-dithering](https://www.npmjs.com/package/@opendisplay/epaper-dithering) - Dithering algorithms for e-paper displays
-- [py-opendisplay](https://github.com/OpenDisplay-org/py-opendisplay) - Python version for desktop/server applications
-
-## License
-
-MIT
-
-## Links
-
-- [npm Package](https://www.npmjs.com/package/@opendisplay/opendisplay)
-- [GitHub Repository](https://github.com/OpenDisplay-org/opendisplay-js)
-- [OpenDisplay Website](https://opendisplay.io)
-- [Python Library](https://github.com/OpenDisplay-org/py-opendisplay)
+- [py-opendisplay](https://github.com/OpenDisplay-org/py-opendisplay) - Python version

package/dist/index.cjs

@@ -1396,6 +1396,16 @@ var BLEConnection = class {
     }
     return this.notificationQueue.dequeue(timeoutMs);
   }
+  /**
+   * Clear the notification queue.
+   *
+   * Useful for clearing any stale responses before starting a new operation.
+   * This drains any buffered notifications and cancels pending read requests.
+   */
+  clearQueue() {
+    console.debug(`Clearing notification queue (${this.notificationQueue.size} buffered)`);
+    this.notificationQueue.clear("Queue cleared by request");
+  }
   /**
    * Handle incoming BLE notifications.
    *
@@ -1716,7 +1726,10 @@ var OpenDisplayDevice = class _OpenDisplayDevice {
    * await device.uploadImage(imageData, {
    *   refreshMode: RefreshMode.FULL,
    *   ditherMode: DitherMode.BURKES,
-   *   compress: true
+   *   compress: true,
+   *   onProgress: (current, total, stage) => {
+   *     console.log(`${stage}: ${current}/${total} (${Math.floor(current/total*100)}%)`);
+   *   }
    * });
    * ```
    */
@@ -1726,9 +1739,12 @@ var OpenDisplayDevice = class _OpenDisplayDevice {
     const refreshMode = options.refreshMode ?? 0 /* FULL */;
     const ditherMode = options.ditherMode ?? import_epaper_dithering4.DitherMode.BURKES;
     const compress = options.compress ?? true;
+    const onProgress = options.onProgress;
+    const onStatusChange = options.onStatusChange;
     console.log(
       `Uploading image (${this.width}x${this.height}, ${import_epaper_dithering4.ColorScheme[this.colorScheme]})`
     );
+    onStatusChange?.("Preparing image...");
     const encodedData = prepareImageForUpload(
       imageData,
       this.width,
@@ -1738,27 +1754,44 @@ var OpenDisplayDevice = class _OpenDisplayDevice {
     );
     let compressedData = null;
     if (compress) {
+      onStatusChange?.("Compressing...");
       compressedData = compressImageData(encodedData, 6);
       if (compressedData.length < MAX_COMPRESSED_SIZE) {
         console.log(`Using compressed upload protocol (size: ${compressedData.length} bytes)`);
+        onStatusChange?.("Uploading...");
         await this.executeUpload({
           imageData: encodedData,
           refreshMode,
           useCompression: true,
           compressedData,
-          uncompressedSize: encodedData.length
+          uncompressedSize: encodedData.length,
+          onProgress,
+          onStatusChange
         });
       } else {
         console.log(
           `Compressed size exceeds ${MAX_COMPRESSED_SIZE} bytes, using uncompressed protocol`
         );
-        await this.executeUpload({ imageData: encodedData, refreshMode });
+        onStatusChange?.("Uploading...");
+        await this.executeUpload({
+          imageData: encodedData,
+          refreshMode,
+          onProgress,
+          onStatusChange
+        });
       }
     } else {
       console.log("Compression disabled, using uncompressed protocol");
-      await this.executeUpload({ imageData: encodedData, refreshMode });
+      onStatusChange?.("Uploading...");
+      await this.executeUpload({
+        imageData: encodedData,
+        refreshMode,
+        onProgress,
+        onStatusChange
+      });
     }
     console.log("Image upload complete");
+    onStatusChange?.("Upload complete!");
   }
   /**
    * Execute image upload using compressed or uncompressed protocol.
@@ -1769,8 +1802,11 @@ var OpenDisplayDevice = class _OpenDisplayDevice {
       refreshMode,
       useCompression = false,
       compressedData,
-      uncompressedSize
+      uncompressedSize,
+      onProgress,
+      onStatusChange
     } = params;
+    this.connection.clearQueue();
     let startCmd;
     let remainingCompressed = null;
     if (useCompression && compressedData && uncompressedSize) {
@@ -1788,11 +1824,12 @@ var OpenDisplayDevice = class _OpenDisplayDevice {
     validateAckResponse(response, 112 /* DIRECT_WRITE_START */);
     let autoCompleted = false;
     if (useCompression && remainingCompressed && remainingCompressed.length > 0) {
-      autoCompleted = await this.sendDataChunks(remainingCompressed);
+      autoCompleted = await this.sendDataChunks(remainingCompressed, onProgress, onStatusChange);
     } else if (!useCompression) {
-      autoCompleted = await this.sendDataChunks(imageData);
+      autoCompleted = await this.sendDataChunks(imageData, onProgress, onStatusChange);
     }
     if (!autoCompleted) {
+      onStatusChange?.("Refreshing display...");
       const endCmd = buildDirectWriteEndCommand(refreshMode);
       await this.connection.writeCommand(endCmd);
       response = await this.connection.readResponse(
@@ -1810,11 +1847,13 @@ var OpenDisplayDevice = class _OpenDisplayDevice {
    * - Progress logging
    *
    * @param imageData - Data to send in chunks
+   * @param onProgress - Optional progress callback (current bytes, total bytes, stage)
+   * @param onStatusChange - Optional status message callback
    * @returns True if device auto-completed (sent 0x0072 END early), false if all chunks sent normally
    * @throws {ProtocolError} If unexpected response received
    * @throws {BLETimeoutError} If no response within timeout
    */
-  async sendDataChunks(imageData) {
+  async sendDataChunks(imageData, onProgress, onStatusChange) {
     let bytesSent = 0;
     let chunksSent = 0;
     while (bytesSent < imageData.length) {
@@ -1835,6 +1874,7 @@ var OpenDisplayDevice = class _OpenDisplayDevice {
           console.log(
             `No response after chunk ${chunksSent} (${(bytesSent / imageData.length * 100).toFixed(1)}%), waiting for device refresh...`
           );
+          onStatusChange?.("Refreshing display...");
           response = await this.connection.readResponse(
             _OpenDisplayDevice.TIMEOUT_REFRESH
           );
@@ -1844,10 +1884,12 @@ var OpenDisplayDevice = class _OpenDisplayDevice {
       }
       const [command, isAck] = checkResponseType(response);
       if (command === 113 /* DIRECT_WRITE_DATA */) {
+        onProgress?.(bytesSent, imageData.length, "upload");
       } else if (command === 114 /* DIRECT_WRITE_END */) {
         console.log(
           `Received END response after chunk ${chunksSent} - device auto-completed`
         );
+        onProgress?.(imageData.length, imageData.length, "upload");
         return true;
       } else {
         throw new ProtocolError(