@martyndevries/xiaomi-miio 0.1.0 → 0.1.1

package/README.md

@@ -16,6 +16,12 @@ This library focuses on the protocol and transport layer only:
 - Node.js 22+
 - npm 10+
 
+## Install
+
+```bash
+npm install @martyndevries/xiaomi-miio
+```
+
 ## Background and references
 
 - miIO binary protocol notes: https://github.com/OpenMiHome/mihome-binary-protocol
@@ -62,12 +68,20 @@ npm run example:discovery
 
 This prints each responding device with its IP address, device ID, and stamp. Tokens are optional.
 
+DNS hostname lookup CLI (reverse lookup by IP address):
+
+```bash
+npm run example:hostname
+```
+
+You will be prompted for the IP address and optional port.
+
 ## Minimal usage (TypeScript)
 
 This example connects to a known device IP and token, turns it on, and sets the speed level.
 
 ```ts
-import { MiioDevice, MiioProtocol } from 'xiaomi-miio';
+import { MiioDevice, MiioProtocol } from '@martyndevries/xiaomi-miio';
 
 const device = new MiioDevice({
   address: '192.168.1.50',
@@ -89,7 +103,7 @@ device.destroy();
 This example broadcasts a discovery packet and prints all devices that respond.
 
 ```ts
-import { discoverMiioDevices } from 'xiaomi-miio';
+import { discoverMiioDevices } from '@martyndevries/xiaomi-miio';
 
 const devices = await discoverMiioDevices({ timeout: 3000, includeToken: false });
 for (const device of devices) {

package/dist/device.d.ts

@@ -1,3 +1,4 @@
+import { type DnsLookupOptions, type DnsLookupResult } from './dns.js';
 import { MiioTransport, type TransportOptions } from './protocol/transport.js';
 export interface DeviceOptions extends TransportOptions {
     /** Device model identifier (e.g. "yeelink.light.bslamp2"). */
@@ -25,6 +26,8 @@ export declare class MiioDevice {
     call(method: string, params?: unknown[]): Promise<unknown>;
     /** Query device properties. */
     getProperties(props: string[]): Promise<unknown>;
+    /** Resolve the device hostname via reverse DNS lookup. */
+    lookupHostname(options?: DnsLookupOptions): Promise<DnsLookupResult>;
     /** Disconnect and clean up resources. */
     destroy(): void;
 }

package/dist/device.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"device.d.ts","sourceRoot":"","sources":["../src/device.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,aAAa,EAAE,KAAK,gBAAgB,EAAE,MAAM,yBAAyB,CAAC;AAE/E,MAAM,WAAW,aAAc,SAAQ,gBAAgB;IACrD,8DAA8D;IAC9D,KAAK,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;CAC5B;AAED,MAAM,WAAW,UAAU;IACzB,OAAO,EAAE,MAAM,CAAC;IAChB,QAAQ,EAAE,MAAM,CAAC;IACjB,KAAK,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;CAC5B;AAED;;;;;GAKG;AACH,qBAAa,UAAU;IACrB,SAAS,CAAC,QAAQ,CAAC,SAAS,EAAE,aAAa,CAAC;IAC5C,QAAQ,CAAC,KAAK,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IACpC,QAAQ,CAAC,OAAO,EAAE,MAAM,CAAC;gBAEb,OAAO,EAAE,aAAa;IAMlC,yDAAyD;IACnD,OAAO,IAAI,OAAO,CAAC,UAAU,CAAC;IASpC,+BAA+B;IACzB,IAAI,CAAC,MAAM,EAAE,MAAM,EAAE,MAAM,GAAE,OAAO,EAAO,GAAG,OAAO,CAAC,OAAO,CAAC;IAIpE,+BAA+B;IACzB,aAAa,CAAC,KAAK,EAAE,MAAM,EAAE,GAAG,OAAO,CAAC,OAAO,CAAC;IAItD,yCAAyC;IACzC,OAAO,IAAI,IAAI;CAGhB"}
+{"version":3,"file":"device.d.ts","sourceRoot":"","sources":["../src/device.ts"],"names":[],"mappings":"AAAA,OAAO,EAAwB,KAAK,gBAAgB,EAAE,KAAK,eAAe,EAAE,MAAM,UAAU,CAAC;AAC7F,OAAO,EAAE,aAAa,EAAE,KAAK,gBAAgB,EAAE,MAAM,yBAAyB,CAAC;AAE/E,MAAM,WAAW,aAAc,SAAQ,gBAAgB;IACrD,8DAA8D;IAC9D,KAAK,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;CAC5B;AAED,MAAM,WAAW,UAAU;IACzB,OAAO,EAAE,MAAM,CAAC;IAChB,QAAQ,EAAE,MAAM,CAAC;IACjB,KAAK,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;CAC5B;AAED;;;;;GAKG;AACH,qBAAa,UAAU;IACrB,SAAS,CAAC,QAAQ,CAAC,SAAS,EAAE,aAAa,CAAC;IAC5C,QAAQ,CAAC,KAAK,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IACpC,QAAQ,CAAC,OAAO,EAAE,MAAM,CAAC;gBAEb,OAAO,EAAE,aAAa;IAMlC,yDAAyD;IACnD,OAAO,IAAI,OAAO,CAAC,UAAU,CAAC;IASpC,+BAA+B;IACzB,IAAI,CAAC,MAAM,EAAE,MAAM,EAAE,MAAM,GAAE,OAAO,EAAO,GAAG,OAAO,CAAC,OAAO,CAAC;IAIpE,+BAA+B;IACzB,aAAa,CAAC,KAAK,EAAE,MAAM,EAAE,GAAG,OAAO,CAAC,OAAO,CAAC;IAItD,0DAA0D;IACpD,cAAc,CAAC,OAAO,GAAE,gBAAqB,GAAG,OAAO,CAAC,eAAe,CAAC;IAI9E,yCAAyC;IACzC,OAAO,IAAI,IAAI;CAGhB"}

package/dist/device.js

@@ -1,3 +1,4 @@
+import { lookupDeviceHostname } from './dns.js';
 import { MiioTransport } from './protocol/transport.js';
 /**
  * Base class for miIO devices.
@@ -31,6 +32,10 @@ export class MiioDevice {
     async getProperties(props) {
         return this.call('get_prop', props);
     }
+    /** Resolve the device hostname via reverse DNS lookup. */
+    async lookupHostname(options = {}) {
+        return lookupDeviceHostname(this.address, options);
+    }
     /** Disconnect and clean up resources. */
     destroy() {
         this.transport.destroy();

package/dist/device.js.map

@@ -1 +1 @@
-{"version":3,"file":"device.js","sourceRoot":"","sources":["../src/device.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,aAAa,EAAyB,MAAM,yBAAyB,CAAC;AAa/E;;;;;GAKG;AACH,MAAM,OAAO,UAAU;IACF,SAAS,CAAgB;IACnC,KAAK,CAAsB;IAC3B,OAAO,CAAS;IAEzB,YAAY,OAAsB;QAChC,IAAI,CAAC,SAAS,GAAG,IAAI,aAAa,CAAC,OAAO,CAAC,CAAC;QAC5C,IAAI,CAAC,KAAK,GAAG,OAAO,CAAC,KAAK,CAAC;QAC3B,IAAI,CAAC,OAAO,GAAG,OAAO,CAAC,OAAO,CAAC;IACjC,CAAC;IAED,yDAAyD;IACzD,KAAK,CAAC,OAAO;QACX,MAAM,EAAE,QAAQ,EAAE,GAAG,MAAM,IAAI,CAAC,SAAS,CAAC,SAAS,EAAE,CAAC;QACtD,OAAO;YACL,OAAO,EAAE,IAAI,CAAC,OAAO;YACrB,QAAQ;YACR,KAAK,EAAE,IAAI,CAAC,KAAK;SAClB,CAAC;IACJ,CAAC;IAED,+BAA+B;IAC/B,KAAK,CAAC,IAAI,CAAC,MAAc,EAAE,SAAoB,EAAE;QAC/C,OAAO,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IAC7C,CAAC;IAED,+BAA+B;IAC/B,KAAK,CAAC,aAAa,CAAC,KAAe;QACjC,OAAO,IAAI,CAAC,IAAI,CAAC,UAAU,EAAE,KAAK,CAAC,CAAC;IACtC,CAAC;IAED,yCAAyC;IACzC,OAAO;QACL,IAAI,CAAC,SAAS,CAAC,OAAO,EAAE,CAAC;IAC3B,CAAC;CACF"}
+{"version":3,"file":"device.js","sourceRoot":"","sources":["../src/device.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,oBAAoB,EAA+C,MAAM,UAAU,CAAC;AAC7F,OAAO,EAAE,aAAa,EAAyB,MAAM,yBAAyB,CAAC;AAa/E;;;;;GAKG;AACH,MAAM,OAAO,UAAU;IACF,SAAS,CAAgB;IACnC,KAAK,CAAsB;IAC3B,OAAO,CAAS;IAEzB,YAAY,OAAsB;QAChC,IAAI,CAAC,SAAS,GAAG,IAAI,aAAa,CAAC,OAAO,CAAC,CAAC;QAC5C,IAAI,CAAC,KAAK,GAAG,OAAO,CAAC,KAAK,CAAC;QAC3B,IAAI,CAAC,OAAO,GAAG,OAAO,CAAC,OAAO,CAAC;IACjC,CAAC;IAED,yDAAyD;IACzD,KAAK,CAAC,OAAO;QACX,MAAM,EAAE,QAAQ,EAAE,GAAG,MAAM,IAAI,CAAC,SAAS,CAAC,SAAS,EAAE,CAAC;QACtD,OAAO;YACL,OAAO,EAAE,IAAI,CAAC,OAAO;YACrB,QAAQ;YACR,KAAK,EAAE,IAAI,CAAC,KAAK;SAClB,CAAC;IACJ,CAAC;IAED,+BAA+B;IAC/B,KAAK,CAAC,IAAI,CAAC,MAAc,EAAE,SAAoB,EAAE;QAC/C,OAAO,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IAC7C,CAAC;IAED,+BAA+B;IAC/B,KAAK,CAAC,aAAa,CAAC,KAAe;QACjC,OAAO,IAAI,CAAC,IAAI,CAAC,UAAU,EAAE,KAAK,CAAC,CAAC;IACtC,CAAC;IAED,0DAA0D;IAC1D,KAAK,CAAC,cAAc,CAAC,UAA4B,EAAE;QACjD,OAAO,oBAAoB,CAAC,IAAI,CAAC,OAAO,EAAE,OAAO,CAAC,CAAC;IACrD,CAAC;IAED,yCAAyC;IACzC,OAAO;QACL,IAAI,CAAC,SAAS,CAAC,OAAO,EAAE,CAAC;IAC3B,CAAC;CACF"}

package/dist/dns.d.ts

@@ -0,0 +1,36 @@
+/** Result from a DNS hostname lookup. */
+export interface DnsLookupResult {
+    /** IP address that was looked up. */
+    address: string;
+    /** Port used for the lookup. */
+    port: number;
+    /** Resolved hostname, or null if lookup failed. */
+    hostname: string | null;
+    /** Resolved service name, or null if lookup failed. */
+    service: string | null;
+    /** Error details if lookup failed. */
+    error: DnsLookupError | null;
+}
+/** Function signature for a DNS lookup implementation. */
+export type DnsLookupService = (address: string, port: number) => Promise<{
+    hostname: string;
+    service: string;
+}>;
+/** Options for DNS hostname lookup. */
+export interface DnsLookupOptions {
+    /** Port to use for reverse DNS lookup. Default: 54321 */
+    port?: number | undefined;
+    /** Optional lookupService implementation (for testing). */
+    lookupService?: DnsLookupService | undefined;
+}
+/** Error returned when DNS hostname lookup fails. */
+export declare class DnsLookupError extends Error {
+    readonly address: string;
+    readonly port: number;
+    constructor(address: string, port: number, cause: unknown);
+}
+/**
+ * Resolve the device hostname via reverse DNS lookup.
+ */
+export declare function lookupDeviceHostname(address: string, options?: DnsLookupOptions): Promise<DnsLookupResult>;
+//# sourceMappingURL=dns.d.ts.map

package/dist/dns.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"dns.d.ts","sourceRoot":"","sources":["../src/dns.ts"],"names":[],"mappings":"AAIA,yCAAyC;AACzC,MAAM,WAAW,eAAe;IAC9B,qCAAqC;IACrC,OAAO,EAAE,MAAM,CAAC;IAChB,gCAAgC;IAChC,IAAI,EAAE,MAAM,CAAC;IACb,mDAAmD;IACnD,QAAQ,EAAE,MAAM,GAAG,IAAI,CAAC;IACxB,uDAAuD;IACvD,OAAO,EAAE,MAAM,GAAG,IAAI,CAAC;IACvB,sCAAsC;IACtC,KAAK,EAAE,cAAc,GAAG,IAAI,CAAC;CAC9B;AAED,0DAA0D;AAC1D,MAAM,MAAM,gBAAgB,GAAG,CAAC,OAAO,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,KAAK,OAAO,CAAC;IAAE,QAAQ,EAAE,MAAM,CAAC;IAAC,OAAO,EAAE,MAAM,CAAA;CAAE,CAAC,CAAC;AAEjH,uCAAuC;AACvC,MAAM,WAAW,gBAAgB;IAC/B,yDAAyD;IACzD,IAAI,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IAC1B,2DAA2D;IAC3D,aAAa,CAAC,EAAE,gBAAgB,GAAG,SAAS,CAAC;CAC9C;AAED,qDAAqD;AACrD,qBAAa,cAAe,SAAQ,KAAK;IACvC,QAAQ,CAAC,OAAO,EAAE,MAAM,CAAC;IACzB,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC;gBAEV,OAAO,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,EAAE,KAAK,EAAE,OAAO;CAM1D;AAED;;GAEG;AACH,wBAAsB,oBAAoB,CACxC,OAAO,EAAE,MAAM,EACf,OAAO,GAAE,gBAAqB,GAC7B,OAAO,CAAC,eAAe,CAAC,CAgB1B"}

package/dist/dns.js

@@ -0,0 +1,34 @@
+import { lookupService as nodeLookupService } from 'node:dns/promises';
+const DEFAULT_PORT = 54321;
+/** Error returned when DNS hostname lookup fails. */
+export class DnsLookupError extends Error {
+    address;
+    port;
+    constructor(address, port, cause) {
+        super(`DNS lookup failed for ${address}:${port}`, { cause });
+        this.name = 'DnsLookupError';
+        this.address = address;
+        this.port = port;
+    }
+}
+/**
+ * Resolve the device hostname via reverse DNS lookup.
+ */
+export async function lookupDeviceHostname(address, options = {}) {
+    const port = options.port ?? DEFAULT_PORT;
+    const lookupService = options.lookupService ?? nodeLookupService;
+    try {
+        const { hostname, service } = await lookupService(address, port);
+        return { address, port, hostname, service, error: null };
+    }
+    catch (err) {
+        return {
+            address,
+            port,
+            hostname: null,
+            service: null,
+            error: new DnsLookupError(address, port, err),
+        };
+    }
+}
+//# sourceMappingURL=dns.js.map

package/dist/dns.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"dns.js","sourceRoot":"","sources":["../src/dns.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,aAAa,IAAI,iBAAiB,EAAE,MAAM,mBAAmB,CAAC;AAEvE,MAAM,YAAY,GAAG,KAAK,CAAC;AA2B3B,qDAAqD;AACrD,MAAM,OAAO,cAAe,SAAQ,KAAK;IAC9B,OAAO,CAAS;IAChB,IAAI,CAAS;IAEtB,YAAY,OAAe,EAAE,IAAY,EAAE,KAAc;QACvD,KAAK,CAAC,yBAAyB,OAAO,IAAI,IAAI,EAAE,EAAE,EAAE,KAAK,EAAE,CAAC,CAAC;QAC7D,IAAI,CAAC,IAAI,GAAG,gBAAgB,CAAC;QAC7B,IAAI,CAAC,OAAO,GAAG,OAAO,CAAC;QACvB,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC;IACnB,CAAC;CACF;AAED;;GAEG;AACH,MAAM,CAAC,KAAK,UAAU,oBAAoB,CACxC,OAAe,EACf,UAA4B,EAAE;IAE9B,MAAM,IAAI,GAAG,OAAO,CAAC,IAAI,IAAI,YAAY,CAAC;IAC1C,MAAM,aAAa,GAAG,OAAO,CAAC,aAAa,IAAI,iBAAiB,CAAC;IAEjE,IAAI,CAAC;QACH,MAAM,EAAE,QAAQ,EAAE,OAAO,EAAE,GAAG,MAAM,aAAa,CAAC,OAAO,EAAE,IAAI,CAAC,CAAC;QACjE,OAAO,EAAE,OAAO,EAAE,IAAI,EAAE,QAAQ,EAAE,OAAO,EAAE,KAAK,EAAE,IAAI,EAAE,CAAC;IAC3D,CAAC;IAAC,OAAO,GAAY,EAAE,CAAC;QACtB,OAAO;YACL,OAAO;YACP,IAAI;YACJ,QAAQ,EAAE,IAAI;YACd,OAAO,EAAE,IAAI;YACb,KAAK,EAAE,IAAI,cAAc,CAAC,OAAO,EAAE,IAAI,EAAE,GAAG,CAAC;SAC9C,CAAC;IACJ,CAAC;AACH,CAAC"}

package/dist/index.d.ts

@@ -4,4 +4,5 @@ export { MiioCrypto } from './protocol/crypto.js';
 export { MiioTransport, type TransportOptions } from './protocol/transport.js';
 export { discoverMiioDevices, type DiscoveryOptions, type MiioDiscoveredDevice } from './protocol/discovery.js';
 export { MiioDevice, type DeviceInfo, type DeviceOptions } from './device.js';
+export { lookupDeviceHostname, DnsLookupError, type DnsLookupOptions, type DnsLookupResult, type DnsLookupService, } from './dns.js';
 //# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,YAAY,EAAE,MAAM,wBAAwB,CAAC;AACtD,OAAO,EAAE,UAAU,EAAE,MAAM,sBAAsB,CAAC;AAClD,OAAO,EAAE,UAAU,EAAE,MAAM,sBAAsB,CAAC;AAClD,OAAO,EAAE,aAAa,EAAE,KAAK,gBAAgB,EAAE,MAAM,yBAAyB,CAAC;AAC/E,OAAO,EAAE,mBAAmB,EAAE,KAAK,gBAAgB,EAAE,KAAK,oBAAoB,EAAE,MAAM,yBAAyB,CAAC;AAChH,OAAO,EAAE,UAAU,EAAE,KAAK,UAAU,EAAE,KAAK,aAAa,EAAE,MAAM,aAAa,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,YAAY,EAAE,MAAM,wBAAwB,CAAC;AACtD,OAAO,EAAE,UAAU,EAAE,MAAM,sBAAsB,CAAC;AAClD,OAAO,EAAE,UAAU,EAAE,MAAM,sBAAsB,CAAC;AAClD,OAAO,EAAE,aAAa,EAAE,KAAK,gBAAgB,EAAE,MAAM,yBAAyB,CAAC;AAC/E,OAAO,EAAE,mBAAmB,EAAE,KAAK,gBAAgB,EAAE,KAAK,oBAAoB,EAAE,MAAM,yBAAyB,CAAC;AAChH,OAAO,EAAE,UAAU,EAAE,KAAK,UAAU,EAAE,KAAK,aAAa,EAAE,MAAM,aAAa,CAAC;AAC9E,OAAO,EACL,oBAAoB,EACpB,cAAc,EACd,KAAK,gBAAgB,EACrB,KAAK,eAAe,EACpB,KAAK,gBAAgB,GACtB,MAAM,UAAU,CAAC"}

package/dist/index.js

@@ -4,4 +4,5 @@ export { MiioCrypto } from './protocol/crypto.js';
 export { MiioTransport } from './protocol/transport.js';
 export { discoverMiioDevices } from './protocol/discovery.js';
 export { MiioDevice } from './device.js';
+export { lookupDeviceHostname, DnsLookupError, } from './dns.js';
 //# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,YAAY,EAAE,MAAM,wBAAwB,CAAC;AACtD,OAAO,EAAE,UAAU,EAAE,MAAM,sBAAsB,CAAC;AAClD,OAAO,EAAE,UAAU,EAAE,MAAM,sBAAsB,CAAC;AAClD,OAAO,EAAE,aAAa,EAAyB,MAAM,yBAAyB,CAAC;AAC/E,OAAO,EAAE,mBAAmB,EAAoD,MAAM,yBAAyB,CAAC;AAChH,OAAO,EAAE,UAAU,EAAuC,MAAM,aAAa,CAAC"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,YAAY,EAAE,MAAM,wBAAwB,CAAC;AACtD,OAAO,EAAE,UAAU,EAAE,MAAM,sBAAsB,CAAC;AAClD,OAAO,EAAE,UAAU,EAAE,MAAM,sBAAsB,CAAC;AAClD,OAAO,EAAE,aAAa,EAAyB,MAAM,yBAAyB,CAAC;AAC/E,OAAO,EAAE,mBAAmB,EAAoD,MAAM,yBAAyB,CAAC;AAChH,OAAO,EAAE,UAAU,EAAuC,MAAM,aAAa,CAAC;AAC9E,OAAO,EACL,oBAAoB,EACpB,cAAc,GAIf,MAAM,UAAU,CAAC"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@martyndevries/xiaomi-miio",
-  "version": "0.1.0",
+  "version": "0.1.1",
   "description": "Zero-dependency Node.js library for Xiaomi miIO protocol",
   "type": "module",
   "exports": {
@@ -26,6 +26,7 @@
     "build:examples": "tsc -p tsconfig.examples.json",
     "example:bedlamp2": "tsc -p tsconfig.examples.json && node dist-examples/examples/bedlamp2-cli.js",
     "example:discovery": "tsc -p tsconfig.examples.json && node dist-examples/examples/discovery-cli.js",
+    "example:hostname": "tsc -p tsconfig.examples.json && node dist-examples/examples/hostname-cli.js",
     "clean": "rm -rf dist dist-test dist-examples",
     "prepublishOnly": "npm run clean && npm run build"
   },
@@ -40,7 +41,7 @@
   },
   "repository": {
     "type": "git",
-    "url": "https://github.com/mvdevries/xiaomi-miio.git"
+    "url": "git+https://github.com/mvdevries/xiaomi-miio.git"
   },
   "publishConfig": {
     "registry": "https://registry.npmjs.org",