edilkamin 1.7.3 → 1.8.0

package/dist/esm/src/types.d.ts

@@ -0,0 +1,86 @@
+/**
+ * Represents a Node.js Buffer object serialized to JSON.
+ * This format is used by the Edilkamin API for gzip-compressed fields.
+ */
+interface BufferEncodedType {
+    type: "Buffer";
+    data: number[];
+}
+interface CommandsType {
+    power: boolean;
+}
+interface TemperaturesType {
+    board: number;
+    enviroment: number;
+}
+interface StatusType {
+    commands: CommandsType;
+    temperatures: TemperaturesType;
+}
+interface UserParametersType {
+    enviroment_1_temperature: number;
+    enviroment_2_temperature: number;
+    enviroment_3_temperature: number;
+    is_auto: boolean;
+    is_sound_active: boolean;
+}
+interface DeviceInfoType {
+    status: StatusType;
+    nvm: {
+        user_parameters: UserParametersType;
+    };
+}
+/**
+ * Raw device info response that may contain Buffer-encoded compressed fields.
+ * Used internally before processing; external callers receive DeviceInfoType.
+ */
+interface DeviceInfoRawType {
+    status: StatusType | BufferEncodedType;
+    nvm: {
+        user_parameters: UserParametersType;
+    } | BufferEncodedType;
+    component_info?: BufferEncodedType | Record<string, unknown>;
+}
+/**
+ * Request body for registering a device with a user account.
+ * All fields are required by the API.
+ */
+interface DeviceAssociationBody {
+    macAddress: string;
+    deviceName: string;
+    deviceRoom: string;
+    serialNumber: string;
+}
+/**
+ * Request body for editing a device's name and room.
+ * MAC address is specified in the URL path, not the body.
+ * Serial number cannot be changed after registration.
+ */
+interface EditDeviceAssociationBody {
+    deviceName: string;
+    deviceRoom: string;
+}
+/**
+ * Response from device registration endpoint.
+ * Structure based on Android app behavior - may need adjustment after testing.
+ */
+interface DeviceAssociationResponse {
+    macAddress: string;
+    deviceName: string;
+    deviceRoom: string;
+    serialNumber: string;
+}
+/**
+ * Represents a discovered Edilkamin device from Bluetooth scanning.
+ */
+interface DiscoveredDevice {
+    /** BLE MAC address as discovered */
+    bleMac: string;
+    /** WiFi MAC address (BLE MAC - 2), used for API calls */
+    wifiMac: string;
+    /** Device name (typically "EDILKAMIN_EP") */
+    name: string;
+    /** Signal strength in dBm (optional, not all platforms provide this) */
+    rssi?: number;
+}
+export type { BufferEncodedType, CommandsType, DeviceAssociationBody, DeviceAssociationResponse, DeviceInfoRawType, DeviceInfoType, DiscoveredDevice, EditDeviceAssociationBody, StatusType, TemperaturesType, UserParametersType, };

package/dist/esm/src/types.js

@@ -0,0 +1 @@
+export {};

package/package.json

@@ -1,19 +1,29 @@
 {
   "name": "edilkamin",
-  "version": "1.7.3",
+  "version": "1.8.0",
   "description": "",
-  "main": "dist/cjs/index.js",
-  "module": "dist/esm/index.js",
-  "types": "dist/esm/index.d.ts",
+  "main": "dist/cjs/src/index.js",
+  "module": "dist/esm/src/index.js",
+  "types": "dist/esm/src/index.d.ts",
   "exports": {
     ".": {
       "import": {
-        "types": "./dist/esm/index.d.ts",
-        "default": "./dist/esm/index.js"
+        "types": "./dist/esm/src/index.d.ts",
+        "default": "./dist/esm/src/index.js"
       },
       "require": {
-        "types": "./dist/cjs/index.d.ts",
-        "default": "./dist/cjs/index.js"
+        "types": "./dist/cjs/src/index.d.ts",
+        "default": "./dist/cjs/src/index.js"
+      }
+    },
+    "./bluetooth": {
+      "import": {
+        "types": "./dist/esm/src/bluetooth.d.ts",
+        "default": "./dist/esm/src/bluetooth.js"
+      },
+      "require": {
+        "types": "./dist/cjs/src/bluetooth.d.ts",
+        "default": "./dist/cjs/src/bluetooth.js"
       }
     }
   },
@@ -43,7 +53,7 @@
   },
   "homepage": "https://github.com/AndreMiras/edilkamin.js#readme",
   "bin": {
-    "edilkamin": "dist/cjs/cli.js"
+    "edilkamin": "dist/cjs/src/cli.js"
   },
   "nyc": {
     "reporter": [
@@ -57,12 +67,13 @@
     "pako": "^2.1.0"
   },
   "devDependencies": {
-    "@aws-amplify/cli": "^7.6.21",
     "@eslint/eslintrc": "^3.2.0",
     "@eslint/js": "^9.16.0",
     "@types/mocha": "^10.0.10",
+    "@types/node": "^25.0.2",
     "@types/pako": "^2.0.4",
     "@types/sinon": "^17.0.3",
+    "@types/web-bluetooth": "^0.0.21",
     "@typescript-eslint/eslint-plugin": "^8.17.0",
     "@typescript-eslint/parser": "^8.17.0",
     "esbuild": "^0.27.1",
@@ -79,6 +90,6 @@
     "typescript": "^5.7.2"
   },
   "optionalDependencies": {
-    "commander": "^12.1.0"
+    "commander": "^14.0.2"
   }
 }

package/src/bluetooth-utils.test.ts

@@ -0,0 +1,46 @@
+import { strict as assert } from "assert";
+
+import { bleToWifiMac } from "./bluetooth-utils";
+
+describe("bleToWifiMac", () => {
+  it("converts BLE MAC with colons to WiFi MAC", () => {
+    assert.equal(bleToWifiMac("A8:03:2A:FE:D5:0A"), "a8032afed508");
+  });
+
+  it("converts BLE MAC without separators", () => {
+    assert.equal(bleToWifiMac("a8032afed50a"), "a8032afed508");
+  });
+
+  it("converts BLE MAC with dashes", () => {
+    assert.equal(bleToWifiMac("A8-03-2A-FE-D5-0A"), "a8032afed508");
+  });
+
+  it("handles lowercase input", () => {
+    assert.equal(bleToWifiMac("a8:03:2a:fe:d5:0a"), "a8032afed508");
+  });
+
+  it("handles edge case where subtraction crosses byte boundary", () => {
+    // FF:FF:FF:FF:FF:01 - 2 = FF:FF:FF:FF:FE:FF
+    assert.equal(bleToWifiMac("FF:FF:FF:FF:FF:01"), "fffffffffeff");
+  });
+
+  it("handles minimum value edge case", () => {
+    // 00:00:00:00:00:02 - 2 = 00:00:00:00:00:00
+    assert.equal(bleToWifiMac("00:00:00:00:00:02"), "000000000000");
+  });
+
+  it("throws on invalid MAC format - too short", () => {
+    assert.throws(() => bleToWifiMac("A8:03:2A"), /Invalid MAC address format/);
+  });
+
+  it("throws on invalid MAC format - invalid characters", () => {
+    assert.throws(
+      () => bleToWifiMac("G8:03:2A:FE:D5:0A"),
+      /Invalid MAC address format/,
+    );
+  });
+
+  it("throws on empty string", () => {
+    assert.throws(() => bleToWifiMac(""), /Invalid MAC address format/);
+  });
+});

package/src/bluetooth-utils.ts

@@ -0,0 +1,29 @@
+/**
+ * Converts a BLE MAC address to WiFi MAC address.
+ * The WiFi MAC is the BLE MAC minus 2 in hexadecimal.
+ *
+ * @param bleMac - BLE MAC address (with or without colons/dashes)
+ * @returns WiFi MAC address in lowercase without separators
+ *
+ * @example
+ * bleToWifiMac("A8:03:2A:FE:D5:0A") // returns "a8032afed508"
+ * bleToWifiMac("a8032afed50a")      // returns "a8032afed508"
+ */
+const bleToWifiMac = (bleMac: string): string => {
+  // Remove colons, dashes, and convert to lowercase
+  const normalized = bleMac.replace(/[:-]/g, "").toLowerCase();
+
+  // Validate MAC address format (12 hex characters)
+  if (!/^[0-9a-f]{12}$/.test(normalized)) {
+    throw new Error(`Invalid MAC address format: ${bleMac}`);
+  }
+
+  // Convert to number, subtract 2, convert back to hex
+  const bleValue = BigInt(`0x${normalized}`);
+  const wifiValue = bleValue - BigInt(2);
+
+  // Pad to 12 characters and return lowercase
+  return wifiValue.toString(16).padStart(12, "0");
+};
+
+export { bleToWifiMac };

package/src/bluetooth.ts

@@ -0,0 +1,115 @@
+import { bleToWifiMac } from "./bluetooth-utils";
+import { DiscoveredDevice } from "./types";
+
+/** Device name broadcast by Edilkamin stoves */
+const EDILKAMIN_DEVICE_NAME = "EDILKAMIN_EP";
+
+/** GATT Service UUID for Edilkamin devices (0xABF0) */
+const EDILKAMIN_SERVICE_UUID = 0xabf0;
+
+/**
+ * Check if Web Bluetooth API is available in the current browser.
+ *
+ * @returns true if Web Bluetooth is supported
+ */
+const isWebBluetoothSupported = (): boolean => {
+  return typeof navigator !== "undefined" && "bluetooth" in navigator;
+};
+
+/**
+ * Scan for nearby Edilkamin stoves using the Web Bluetooth API.
+ *
+ * This function triggers the browser's Bluetooth device picker dialog,
+ * filtered to show only devices named "EDILKAMIN_EP".
+ *
+ * Note: Web Bluetooth requires:
+ * - HTTPS or localhost
+ * - User gesture (button click)
+ * - Chrome/Edge/Opera (not Firefox/Safari)
+ *
+ * @returns Promise resolving to array of discovered devices
+ * @throws Error if Web Bluetooth is not supported or user cancels
+ *
+ * @example
+ * const devices = await scanForDevices();
+ * console.log(devices[0].wifiMac); // Use this for API calls
+ */
+const scanForDevices = async (): Promise<DiscoveredDevice[]> => {
+  if (!isWebBluetoothSupported()) {
+    throw new Error(
+      "Web Bluetooth API is not supported in this browser. " +
+        "Use Chrome, Edge, or Opera on desktop/Android. " +
+        "On iOS, use the Bluefy browser app.",
+    );
+  }
+
+  try {
+    // Request device - this opens the browser's device picker
+    const device = await navigator.bluetooth.requestDevice({
+      filters: [{ name: EDILKAMIN_DEVICE_NAME }],
+      optionalServices: [EDILKAMIN_SERVICE_UUID],
+    });
+
+    // Extract BLE MAC from device ID if available
+    // Note: device.id format varies by platform, may need adjustment
+    const bleMac = device.id || "";
+    const name = device.name || EDILKAMIN_DEVICE_NAME;
+
+    // Calculate WiFi MAC for API calls
+    let wifiMac = "";
+    if (bleMac && /^[0-9a-f:-]{12,17}$/i.test(bleMac)) {
+      try {
+        wifiMac = bleToWifiMac(bleMac);
+      } catch {
+        // device.id may not be a valid MAC format on all platforms
+        wifiMac = "";
+      }
+    }
+
+    const discoveredDevice: DiscoveredDevice = {
+      bleMac,
+      wifiMac,
+      name,
+      // RSSI not directly available from requestDevice
+    };
+
+    return [discoveredDevice];
+  } catch (error) {
+    if (error instanceof Error) {
+      if (error.name === "NotFoundError") {
+        // User cancelled the device picker
+        return [];
+      }
+      throw error;
+    }
+    throw new Error("Unknown error during Bluetooth scan");
+  }
+};
+
+/**
+ * Scan for devices with a custom filter.
+ * Advanced function for users who need more control over device selection.
+ *
+ * @param options - Web Bluetooth requestDevice options
+ * @returns Promise resolving to the selected BluetoothDevice
+ */
+const scanWithOptions = async (
+  options: RequestDeviceOptions,
+): Promise<BluetoothDevice> => {
+  if (!isWebBluetoothSupported()) {
+    throw new Error("Web Bluetooth API is not supported in this browser.");
+  }
+
+  return navigator.bluetooth.requestDevice(options);
+};
+
+export {
+  EDILKAMIN_DEVICE_NAME,
+  EDILKAMIN_SERVICE_UUID,
+  isWebBluetoothSupported,
+  scanForDevices,
+  scanWithOptions,
+};
+
+// Re-export DiscoveredDevice for convenience
+export type { DiscoveredDevice } from "./types";

package/src/browser-bundle.test.ts

@@ -7,7 +7,7 @@ describe("browser-bundle", () => {
     // without requiring Node.js built-in modules (fs, os, path).
     // If this test fails, it means Node.js-only code has leaked into the main exports.
     const result = await esbuild.build({
-      entryPoints: ["dist/esm/index.js"],
+      entryPoints: ["dist/esm/src/index.js"],
       platform: "browser",
       bundle: true,
       write: false,

package/src/index.ts

@@ -1,5 +1,6 @@
 import { configure } from "./library";
 
+export { bleToWifiMac } from "./bluetooth-utils";
 export { decompressBuffer, isBuffer, processResponse } from "./buffer-utils";
 export { API_URL, NEW_API_URL, OLD_API_URL } from "./constants";
 export { configure, getSession, signIn } from "./library";
@@ -15,6 +16,7 @@ export {
   DeviceAssociationResponse,
   DeviceInfoRawType,
   DeviceInfoType,
+  DiscoveredDevice,
   EditDeviceAssociationBody,
   StatusType,
   TemperaturesType,

package/src/types.ts

@@ -82,6 +82,20 @@ interface DeviceAssociationResponse {
   serialNumber: string;
 }
 
+/**
+ * Represents a discovered Edilkamin device from Bluetooth scanning.
+ */
+interface DiscoveredDevice {
+  /** BLE MAC address as discovered */
+  bleMac: string;
+  /** WiFi MAC address (BLE MAC - 2), used for API calls */
+  wifiMac: string;
+  /** Device name (typically "EDILKAMIN_EP") */
+  name: string;
+  /** Signal strength in dBm (optional, not all platforms provide this) */
+  rssi?: number;
+}
+
 export type {
   BufferEncodedType,
   CommandsType,
@@ -89,6 +103,7 @@ export type {
   DeviceAssociationResponse,
   DeviceInfoRawType,
   DeviceInfoType,
+  DiscoveredDevice,
   EditDeviceAssociationBody,
   StatusType,
   TemperaturesType,

package/tsconfig.cjs.json

@@ -1,7 +1,7 @@
 {
   "extends": "./tsconfig.json",
   "compilerOptions": {
-    "outDir": "dist/esm",
-    "module": "es6"
+    "outDir": "dist/cjs",
+    "module": "commonjs"
   }
 }

package/tsconfig.json

@@ -1,10 +1,10 @@
 {
   "compilerOptions": {
     "target": "es6",
-    "target": "es6",
+    "lib": ["ES6", "DOM"],
     "moduleResolution": "node",
     "outDir": "dist",
-    "rootDir": "src",
+    "rootDir": ".",
     "strict": true,
     "declaration": true,
     "esModuleInterop": true,
@@ -13,5 +13,5 @@
     "noUnusedParameters": true,
     "preserveConstEnums": true
   },
-  "include": ["src/**/*.ts"]
+  "include": ["src/**/*.ts", "package.json"]
 }