@mega-yfue/eufy-sdk 0.6.0-beta.17 → 0.6.0-beta.19

package/dist/model/capabilities/vacuum-clean.d.ts

@@ -280,6 +280,16 @@ export declare function encodeSelectZonesClean(mapId: number, zones: readonly Va
  * @internal
  */
 export declare function encodeSceneClean(sceneId: number): string;
+/**
+ * Build one of the two DP 153 writes the vendor app sends when its map view opens: the time in
+ * microseconds, and on the second write field 2 set to `1`.
+ *
+ * Captured from the vendor app on the device's `cmd/…/req` leg, three times with the same layout. The
+ * product catalogue lists DP 153 as uplink-only (`WorkStatus`); the vendor app writes this message to it
+ * all the same. {@link VACUUM_CLEAN_MEMBERS.requestMap} dispatches both.
+ * @internal
+ */
+export declare function encodeMapWatch(nowMs: number, watching: boolean): string;
 /**
  * Build a whole-floor auto clean carrying an `AutoClean` payload of one pass.
  * @internal
@@ -1986,6 +1996,19 @@ export declare const VACUUM_CLEAN_MEMBERS: {
     readonly startScene: import("./members.js").MethodMember<(sceneId: number) => Promise<void>> & {
         available: (ctx: import("./types.js").CommandContext) => boolean;
     };
+    /**
+     * Ask the robot to push its whole map — plane, room outline, room list and restricted zones — on the
+     * map stream, as the vendor app does when its map view opens: two DP 153 writes, the time and then the
+     * time with field 2 set (see {@link encodeMapWatch}).
+     *
+     * A docked robot sends no map of its own accord, so this is how its room ids and names become
+     * readable without a clean. The map arrives on the stream like any other, not as this call's result.
+     *
+     * WATCHED: sent to a docked robot, it pushed its whole map within a second.
+     */
+    readonly requestMap: import("./members.js").MethodMember<() => Promise<void>> & {
+        available: (ctx: import("./types.js").CommandContext) => boolean;
+    };
     /**
      * State the cleaning settings a run uses — `CleanParamRequest.clean_param` over DP 154.
      *

package/dist/transport/mqtt/biz-stream.d.ts

@@ -12,44 +12,41 @@ export declare const BIZ_PROTOCOL: {
     readonly LIVE_PHOTO: 43;
 };
 /**
- * The channels a map frame can arrive on, by id.
+ * The channels a map frame arrives on, by id, as a robot's own frames identify them.
  *
- * **The trap.** Ids 1–10 come from `Metadata.ChanIds` in `stream.proto`, where each *field* names a
- * message and each field's *value* is the id the device chose for it. The names below pair each
- * channel with its field NUMBER, because that is the numbering the vendor ships and the one a live
- * capture shows — but a device announcing a `Metadata` frame is announcing its own numbering, and a
- * firmware that renumbers would make this table wrong without making it look wrong. Anything that
- * *decodes* a channel's bytes must therefore prefer a device-declared mapping when one has been seen;
- * this table is the default to fall back on, not an authority.
+ * Each id is paired with the `stream.proto` message whose field layout its frames carry, which is not
+ * the field-number order of `Metadata.ChanIds`: the cell plane (`Map`) arrives on 2, its room outline
+ * on 4, the room list on 5, the restricted zones on 6, the robot's pose (`DynamicData`) on 7, the map's
+ * `MapDescription` on 60 and a whole `MapBackup` on 68. A `Metadata` frame would declare a device's own numbering; none has been seen,
+ * so none is read, and this table is the numbering every frame is read by.
  *
- * Channel 0 is the exception and is not in `ChanIds` at all: the app hard-codes it, routing it to a
- * scene-data event rather than a map one, and asks for the scene list on it by number. That one is
- * fixed.
+ * Only channels whose message is identified are listed. A channel whose frames carry too little to
+ * identify, or that carries a message nothing here reads, is absent.
+ *
+ * Channel 0 is not in `ChanIds` at all: the app hard-codes it, routing it to a scene-data event rather
+ * than a map one, and asks for the scene list on it by number.
  */
 export declare const BIZ_CHANNEL: {
     /** Scene (room-group) data. Hard-coded in the app, not part of `ChanIds`. */
     readonly SCENES: 0;
-    readonly MAP_INFO: 1;
-    readonly PATH: 2;
-    readonly ROOM_OUTLINE: 3;
-    readonly ROOM_PARAMS: 4;
-    readonly RESTRICTED_ZONE: 5;
-    readonly DYNAMIC_DATA: 6;
-    readonly TEMPORARY_DATA: 7;
-    readonly OBSTACLE_INFO: 8;
-    readonly MAP_DATA: 9;
-    readonly CRUISE_DATA: 10;
+    readonly MAP_DATA: 2;
+    readonly ROOM_OUTLINE: 4;
+    readonly ROOM_PARAMS: 5;
+    readonly RESTRICTED_ZONE: 6;
+    readonly DYNAMIC_DATA: 7;
+    readonly MAP_DESCRIPTION: 60;
+    readonly MAP_BACKUP: 68;
 };
-/** A channel's name under the default numbering — see the trap in {@link BIZ_CHANNEL}. */
+/** A channel's name under the {@link BIZ_CHANNEL} numbering. */
 export type BizChannel = keyof typeof BIZ_CHANNEL;
 /**
- * Name a channel id under the default numbering, or `undefined` for an id the vendor's table does not
- * list. Not a substitute for a device-declared mapping where one exists.
+ * Name a channel id under the {@link BIZ_CHANNEL} numbering, or `undefined` for an id it does not list.
+ * Not a substitute for a device-declared mapping where one exists.
  */
 export declare function bizChannelName(id: number): BizChannel | undefined;
 /** One frame off the map stream, unwrapped as far as its bytes but not decoded. */
 export interface BizMapFrame {
-    /** Which channel the bytes belong to. Compare against {@link BIZ_CHANNEL}, mindful of its trap. */
+    /** Which channel the bytes belong to. Compare against {@link BIZ_CHANNEL}. */
     readonly channelId: number;
     /**
      * The vendor's `clear_type`. Forwarded, not interpreted: the app passes it straight through to its

package/dist/transport/p2p/command-router.d.ts

@@ -62,6 +62,8 @@ export interface P2PRouterDeps {
     onClose: (stationSn: string) => void;
     onError: (err: Error) => void;
     onLevel2Ready: (stationSn: string, cipherId: number) => void;
+    /** The station answered on its own session at `atMs` — a PONG or an ACK from the connected peer. */
+    onPeerAnswer?: (stationSn: string, atMs: number) => void;
     /** A raw decoded frame — the client emits the low-level `p2p` event + runs the semantic decode. */
     onFrame: (stationSn: string, frame: P2PFrame) => void;
     /**

package/dist/transport/p2p/live-stream.d.ts

@@ -180,6 +180,7 @@ export declare class LiveStream extends EventEmitter {
     stop(): void;
     /** Extract the Annex-B payload from a plaintext 1300 frame (fixed 22-byte header), or undefined. */
     private plaintextAnnexB;
+    /** Emit one accepted media frame; an audio frame with no bytes past its header emits nothing. */
     private onFrame;
     /**
      * Whether this stream may take `frame` — the demultiplexer for a station that serves several cameras.
@@ -226,7 +227,7 @@ export declare class LiveStream extends EventEmitter {
      * The payload of an audio frame. On a stream with an ECIES decoder, a sealed frame ({@link isSealedAudio}) is
      * opened under the media key of the latest keyframe, and answers `undefined` when it does not open or arrives
      * before any keyframe gave a media key, since its bytes are ciphertext. Every other frame is the bytes after
-     * its header.
+     * its header, empty for a frame that carries only its header.
      */
     private audioPayload;
     /**

package/dist/transport/p2p/p2p-session.d.ts

@@ -95,6 +95,12 @@ export interface P2PFrame extends P2PDataFrameHeader {
      * the values as device state without any per-capability decoder.
      */
     params?: Record<number, string>;
+    /**
+     * A station's camera-info table, one `param_type → param_value` map per channel it names (255 is the
+     * station). Set instead of {@link params} when the station answered on {@link STATION_CHANNEL}, so each
+     * channel's state can land on the device attached there.
+     */
+    channelParams?: Record<number, Record<number, string>>;
 }
 /**
  * A live PPCS session. Internal transport; a host drives cameras through the capability surface.
@@ -134,7 +140,12 @@ export declare class P2PSession extends EventEmitter {
     private audioStalled;
     private audioRetransmitTimer?;
     private lastPongData?;
-    /** When the selected peer last answered outbound P2P traffic on this connection. */
+    /**
+     * When the selected peer last answered outbound P2P traffic on this connection.
+     *
+     * Each answer also emits `peerAnswer` with this time: a PONG or an ACK from the connected address is the
+     * station replying on this connection now, which a heartbeat draws every {@link HEARTBEAT_MS}.
+     */
     private lastPeerAt?;
     /** Whether the silence has already been stated, so it is traced once per connection rather than per read. */
     private pathStaleTraced;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@mega-yfue/eufy-sdk",
-  "version": "0.6.0-beta.17",
+  "version": "0.6.0-beta.19",
   "description": "One typed TypeScript client for the Anker eufy v6 cloud — capability-driven devices, realtime events over P2P/MQTT/push, and live media",
   "license": "Apache-2.0",
   "author": "mega-yfue",