@mega-yfue/eufy-sdk 0.5.0-beta.3 → 0.5.0-beta.31

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (39) hide show
  1. package/dist/client/device-registry.d.ts +24 -2
  2. package/dist/client/eufy-mega.d.ts +50 -6
  3. package/dist/client/types.d.ts +1 -1
  4. package/dist/core/contracts.d.ts +52 -26
  5. package/dist/core/store.d.ts +2 -0
  6. package/dist/core/types.d.ts +2 -0
  7. package/dist/index.js +2271 -259
  8. package/dist/index.js.map +4 -4
  9. package/dist/model/capabilities/arming.d.ts +31 -4
  10. package/dist/model/capabilities/camera.d.ts +24 -10
  11. package/dist/model/capabilities/dp-catalog.d.ts +4 -3
  12. package/dist/model/capabilities/light.d.ts +3 -0
  13. package/dist/model/capabilities/motion.d.ts +5 -0
  14. package/dist/model/capabilities/suction.d.ts +5 -5
  15. package/dist/model/capabilities/types.d.ts +6 -0
  16. package/dist/model/capabilities/vacuum-clean.d.ts +19 -13
  17. package/dist/model/classify.d.ts +1 -2
  18. package/dist/model/device-family.d.ts +4 -0
  19. package/dist/model/registry.d.ts +3 -2
  20. package/dist/model/types.d.ts +6 -0
  21. package/dist/transport/abortable.d.ts +8 -0
  22. package/dist/transport/http/mega-client.d.ts +26 -0
  23. package/dist/transport/p2p/command-router.d.ts +14 -26
  24. package/dist/transport/p2p/fmp4.d.ts +6 -1
  25. package/dist/transport/p2p/live-stream.d.ts +3 -0
  26. package/dist/transport/p2p/p2p-session.d.ts +22 -3
  27. package/dist/transport/p2p/recording-download.d.ts +4 -3
  28. package/dist/transport/p2p/shared-live-source.d.ts +9 -0
  29. package/dist/transport/p2p/talkback.d.ts +21 -10
  30. package/dist/transport/p2p/video.d.ts +5 -2
  31. package/dist/transport/rtc/command-router.d.ts +109 -0
  32. package/dist/transport/rtc/live.d.ts +69 -0
  33. package/dist/transport/rtc/peer.d.ts +101 -0
  34. package/dist/transport/rtc/portal-packet.d.ts +72 -0
  35. package/dist/transport/rtc/ptcs-framer.d.ts +86 -0
  36. package/dist/transport/rtc/scall-sdp.d.ts +42 -0
  37. package/dist/transport/rtc/session.d.ts +88 -0
  38. package/dist/transport/rtc/signaling.d.ts +139 -0
  39. package/package.json +2 -1
@@ -16,7 +16,10 @@ export interface DeviceRecord {
16
16
  deviceType?: number;
17
17
  model?: string;
18
18
  category?: string;
19
- /** The app-shown device name (`device_name`); see {@link CloudRecord.name}. */
19
+ /**
20
+ * The app-shown device name: `alias_name` first on a vacuum, `device_name` first otherwise;
21
+ * see {@link CloudRecord.name}.
22
+ */
20
23
  name?: string;
21
24
  /** Parent HomeBase serial when attached (topology signal; see {@link CloudRecord.parentSn}). */
22
25
  parentSn?: string;
@@ -92,6 +95,8 @@ export declare class DeviceRegistry {
92
95
  private overlayRefusalReported;
93
96
  /** Per-serial capability cache for {@link capabilitiesForDevice}; `null` = negative hit. */
94
97
  private readonly deviceCapsCache;
98
+ /** Per-serial cloud data points of an AIoT robot, joined beneath the params in {@link record} — see {@link loadCloudDps}. */
99
+ private readonly cloudDps;
95
100
  /** Per-serial realtime state, keyed by param id in the device's own namespace (see {@link DeviceRecord.dpParams}). */
96
101
  private readonly dpParams;
97
102
  /** Callers blocked in {@link awaitRealtimeState}, released by the device's first report. */
@@ -181,9 +186,26 @@ export declare class DeviceRegistry {
181
186
  * transport stacks own the claim predicate over the record.
182
187
  */
183
188
  require(sn: string): EufyDevice;
189
+ /**
190
+ * Hold an AIoT robot's cloud data points: the cloud's last-known value of each one it has reported,
191
+ * from `getDeviceRelationList`'s per-device `dps`.
192
+ *
193
+ * The device list carries only some of a robot's data points, so a point the robot publishes on change
194
+ * alone (its scene list, its schedules, its consumables) has no value until it next reports. The
195
+ * relation list holds every one, for an account the robot is shared with as well as its owner.
196
+ *
197
+ * Kept apart from the device list's params rather than merged into them: those are what a poll diffs,
198
+ * and a diff retires the realtime report for that id, so a cloud value lagging the robot's last report
199
+ * would replace it. {@link record} joins this beneath both halves. A failure keeps what was held.
200
+ *
201
+ * Limited to {@link CLOUD_DPS_MODELS}, the models whose relation-list `dps` are checked to carry the
202
+ * DP numbers their realtime reports use.
203
+ */
204
+ private loadCloudDps;
184
205
  /**
185
206
  * Resolve a serial to a {@link DeviceRecord} with current params: starts from the device-list params, then
186
- * overlays a fresh `get_device_param_list` when that call is available to this account.
207
+ * overlays a fresh `get_device_param_list` when that call is available to this account. An AIoT robot's
208
+ * cloud data points ({@link loadCloudDps}) sit beneath both, filling only ids neither carries.
187
209
  *
188
210
  * The overlay is **owner-gated** — a shared or member account is refused it for every device, permanently,
189
211
  * which {@link OWNER_ONLY_CODE} identifies — so when it is unavailable the device list is the source
@@ -98,6 +98,8 @@ export declare class EufyMega extends EventEmitter {
98
98
  private readonly prewarmTiers;
99
99
  /** Transport-side owner of the P2P sessions + all wire senders. */
100
100
  private readonly p2p;
101
+ /** Transport-side owner of the T9000 station sessions (sibling of {@link p2p}). */
102
+ private readonly rtc;
101
103
  /** Transport-side owner of the secure-MQTT ff09 lock/garage command path (sibling of {@link p2p}). */
102
104
  private readonly mqtt;
103
105
  /** Transport-side owner of the legacy Tuya REST command path for non-AIoT vacuums (G-series). */
@@ -119,6 +121,8 @@ export declare class EufyMega extends EventEmitter {
119
121
  private readonly mapStores;
120
122
  /** Re-armed after each cloud-param poll; cancelled by {@link disconnect}. */
121
123
  private readonly pollTimer;
124
+ /** Armed while a failed push bring-up waits to be retried; cancelled by {@link disconnect}. */
125
+ private readonly pushRetryTimer;
122
126
  constructor(opts: EufyMegaOptions);
123
127
  /**
124
128
  * Builds the inbound listener that converts ThingClips DP maps to realtime capability state.
@@ -234,6 +238,11 @@ export declare class EufyMega extends EventEmitter {
234
238
  *
235
239
  * The evidence set is widened, never replaced: the ids come back through the cloud record, and a
236
240
  * record that omits a realtime-only id would otherwise un-know it and re-trigger on the next report.
241
+ *
242
+ * The device is re-resolved against the fresh record before binding. A property gated on a
243
+ * realtime-only param enters the schema only once that param is evidence, and the value that made it
244
+ * evidence was stored before the property existed, so the record's realtime params are applied again
245
+ * to land it under the property's name.
237
246
  */
238
247
  private rebindReads;
239
248
  /** The distinct credential scopes the current MQTT roster needs — no devices on a scope, no connection. */
@@ -261,6 +270,8 @@ export declare class EufyMega extends EventEmitter {
261
270
  * only "differs from what was read before", which state already on hand can satisfy spuriously — and the
262
271
  * caller that has no expectation is the push path, where the signal itself is the news that a re-read is owed.
263
272
  *
273
+ * Only a write's observation throws at the deadline; a push with nothing moved answers `false`.
274
+ *
264
275
  * The cloud half is asked for through {@link DeviceRegistry.refreshedList}, never by fetching the account
265
276
  * list outright. The fetch is account-wide — one house list plus one device list per house — so a param that
266
277
  * never converges would otherwise spend a whole burst of those every iteration of this loop, and concurrent
@@ -390,6 +401,14 @@ export declare class EufyMega extends EventEmitter {
390
401
  * other kind is P2P.
391
402
  */
392
403
  private commandSinkFor;
404
+ /**
405
+ * The station a device's commands go through: the device itself, or the HomeBase the registry links it
406
+ * to. Answers the target record, the station record and serial, the station's `device_type`, and the
407
+ * `t9000` / `t8n00` family flags.
408
+ */
409
+ private stationOf;
410
+ /** The vendor DeviceType of the station a device hangs off; `undefined` for a station itself. */
411
+ private stationDeviceTypeOf;
393
412
  /**
394
413
  * Combine explicit P2P media with the optional passive push-thumbnail provider.
395
414
  *
@@ -409,10 +428,23 @@ export declare class EufyMega extends EventEmitter {
409
428
  * The `eufy_life` DP writes (smart lights) are secure-MQTT-only. `aiot-dp` routes to either the
410
429
  * Anker AIoT MQTT stack or the legacy Tuya REST router depending on the device's category
411
430
  * (`eufy_home_tuya` → Tuya, everything else → MQTT). The capability layer emits a single `aiot-dp`
412
- * kind and stays transport-agnostic; only the facade sees both sides and decides here. Everything
413
- * else is P2P.
431
+ * kind and stays transport-agnostic; only the facade sees both sides and decides here. A T9000 or T8N00
432
+ * station and the devices attached to it go over RTC, with an attached device's command refused
433
+ * unless its channel resolves back to it on the station. T8N00 uses full SDP and admits direct and
434
+ * relay candidates; T9000 retains compact SDP and relay-only candidates. Everything else is P2P.
414
435
  */
415
436
  private routeCommand;
437
+ /**
438
+ * The RTC route for a T9000 or T8N00 station or a device attached to one, decided by the station's model
439
+ * classification; `undefined` for any other device. A T8N00 route carries its native `call` signalling. The admin id is the station's
440
+ * `member.admin_user_id`, else the logged-in user.
441
+ */
442
+ private rtcRouteFor;
443
+ /**
444
+ * The RTC media provider for a camera attached to a T9000 whose `device_channel` resolves back to it on
445
+ * the station; `undefined` otherwise, including a camera behind a T8N00, whose route carries commands only.
446
+ */
447
+ private rtcMediaFor;
416
448
  /**
417
449
  * List + classify devices across all houses (mega API). Each device is tagged with its API backend
418
450
  * + realtime transport. Camera/HomeBase records still appear here for inventory; driving them is
@@ -524,6 +556,14 @@ export declare class EufyMega extends EventEmitter {
524
556
  private ensureRealtimeGeneration;
525
557
  /** Start all selected transports concurrently and settle their owning generation once. */
526
558
  private startRealtimeGeneration;
559
+ /**
560
+ * Bring push up again after the generation's startup attempt failed, backing off between attempts
561
+ * until one connects, the generation is superseded, or it is aborted by {@link disconnect}.
562
+ *
563
+ * The MCS socket reconnects on its own only once it has connected. The settled
564
+ * {@link RealtimeReadiness} is a startup snapshot and is not revised when a retry connects.
565
+ */
566
+ private retryPush;
527
567
  /** Resolve a generation with an immutable count snapshot; later transport completions are ignored. */
528
568
  private settleRealtimeGeneration;
529
569
  /**
@@ -835,11 +875,14 @@ export declare class EufyMega extends EventEmitter {
835
875
  */
836
876
  setProperty(sn: string, name: string, value: boolean | number | string): Promise<void>;
837
877
  /**
838
- * Restart a HomeBase.
878
+ * Restart a station: a HomeBase, or a camera-family device that is its own station.
839
879
  *
840
- * **HomeBases only** — restart is a hub operation, so a non-HomeBase serial (a camera, an NVR)
841
- * throws rather than doing nothing. The hub drops its connection and returns after a minute or two,
842
- * so everything behind it is briefly offline. Verified on real hardware.
880
+ * The restart is `RESTART_HUB` on the station's broadcast channel, so it reaches whatever owns the
881
+ * P2P session. A standalone camera or doorbell owns its own session and is the station it restarts.
882
+ * A camera attached to a HomeBase is not — the same frame would restart its HomeBase — so its serial
883
+ * throws, as does any non-camera serial, rather than doing nothing. The device drops its connection
884
+ * and returns after a minute or two; a HomeBase takes everything behind it offline meanwhile.
885
+ * Verified on real hardware against a HomeBase and a standalone indoor camera.
843
886
  */
844
887
  reboot(sn: string): Promise<void>;
845
888
  /**
@@ -857,6 +900,7 @@ export declare class EufyMega extends EventEmitter {
857
900
  * exactly the reads it has.
858
901
  */
859
902
  private fetchDpCatalog;
903
+ /** The {@link CommandContext} for a device, built from `known` when that record is already in hand. */
860
904
  private commandContext;
861
905
  /**
862
906
  * **Generic P2P request/reply query** — sends a `SET_PAYLOAD` sub-command and resolves with the
@@ -390,7 +390,7 @@ export type EufyMegaEventMap = {
390
390
  sn: string;
391
391
  property: string;
392
392
  param: number;
393
- expected?: boolean | number | string;
393
+ expected: boolean | number | string;
394
394
  observed?: boolean | number | string;
395
395
  timeoutMs: number;
396
396
  }
@@ -171,9 +171,10 @@ export declare class RecordingDownloadError extends Error {
171
171
  * A recording downloaded from the station, as elementary streams.
172
172
  *
173
173
  * `video` is Annex-B H.264 in decode order, `audio` AAC-LC 16 kHz mono in ADTS framing (absent when the
174
- * recording carried none that could be decoded). `frames` counts the distinct video frames received,
175
- * `missingFrames` the ones the camera numbered but that never arrived, and `durationMs` spans the first
176
- * to the last received frame by the camera's own timestamps; `fps` is derived from those two stamps.
174
+ * recording carried none that could be decoded). `frames` counts the distinct video sequences emitted.
175
+ * `missingFrames` counts gaps between received sequences and received sequences that yielded no usable
176
+ * picture, including at either end. `durationMs` spans the first to the last emitted picture by the
177
+ * camera's own timestamps; `fps` is derived from those stamps.
177
178
  */
178
179
  export interface RecordingDownload {
179
180
  video: Buffer;
@@ -230,7 +231,7 @@ export interface StateConvergenceFailure {
230
231
  property: string;
231
232
  param: number;
232
233
  /** The RAW param value the write asked the device to report. */
233
- expected?: boolean | number | string;
234
+ expected: boolean | number | string;
234
235
  /** What the param actually read when the deadline passed, absent where the device reported none at all. */
235
236
  observed?: boolean | number | string;
236
237
  timeoutMs: number;
@@ -248,7 +249,7 @@ export declare class StateConvergenceError extends Error {
248
249
  readonly sn: string;
249
250
  readonly property: string;
250
251
  readonly param: number;
251
- readonly expected?: boolean | number | string;
252
+ readonly expected: boolean | number | string;
252
253
  readonly observed?: boolean | number | string;
253
254
  readonly timeoutMs: number;
254
255
  constructor(failure: StateConvergenceFailure);
@@ -487,6 +488,8 @@ export type VideoCodec = "h264" | "h265" | "av1";
487
488
  * headers promise decodes to no picture at all.
488
489
  */
489
490
  export interface LiveVideoFrame {
491
+ /** Source-reported unsigned 32-bit timestamp; unit and clock origin are unspecified. */
492
+ sourceTimestamp?: number;
490
493
  /** True on an IDR — a unit a consumer may begin decoding at, never a continuation of an earlier one. */
491
494
  keyframe: boolean;
492
495
  /**
@@ -548,19 +551,30 @@ export interface LiveVideoConfig {
548
551
  * 7 → `mp4a.40.39`); it fails the stream on anything else.
549
552
  */
550
553
  export type AudioCodec = "aac-lc" | "aac-eld" | "g711a";
554
+ /** The codec a camera's speaker plays: `aac-eld` on a camera whose speaker plays it, `aac-lc` otherwise. */
555
+ export type TalkbackCodec = Extract<AudioCodec, "aac-lc" | "aac-eld">;
551
556
  /**
552
557
  * One audio access unit, carrying the codec the station declared for it.
553
558
  *
554
- * Sample rate and channel count are deliberately absent: they are not on the wire. The v6 app assumes
555
- * 16 kHz mono for every audio type rather than reading them, so the SDK does not invent fields the
556
- * device never sent.
559
+ * Sample rate and channel count are absent for `aac-lc` and `g711a`: they are not on the wire, and the v6 app
560
+ * assumes 16 kHz mono for every audio type rather than reading them. An `aac-lc` frame is one ADTS frame and
561
+ * `g711a` is raw A-law. An `aac-eld` frame is one raw access unit with no transport framing, so it carries the
562
+ * AudioSpecificConfig that decodes it.
557
563
  */
558
- export interface LiveAudioFrame {
564
+ export type LiveAudioFrame = {
559
565
  /** Codec declared in the frame header. */
560
- codec: AudioCodec;
561
- /** Elementary-stream bytes (ADTS-framed for the two AAC profiles). */
566
+ codec: "aac-lc" | "g711a";
567
+ /** One ADTS frame for `aac-lc`, raw A-law samples for `g711a`. */
562
568
  data: Buffer;
563
- }
569
+ config?: undefined;
570
+ } | {
571
+ /** Codec declared in the frame header. */
572
+ codec: "aac-eld";
573
+ /** One raw AAC-ELD access unit. */
574
+ data: Buffer;
575
+ /** AudioSpecificConfig (ISO/IEC 14496-3) that decodes `data`. */
576
+ config: Buffer;
577
+ };
564
578
  /**
565
579
  * One fragmented-MP4 (CMAF) output unit from the native muxer. `init` (the `ftyp`+`moov` init
566
580
  * segment) is present exactly once, on the first fragment; every fragment carries a `moof`+`mdat`
@@ -868,10 +882,11 @@ export interface MediaProvider {
868
882
  }): Promise<Record<string, unknown>>;
869
883
  }
870
884
  /**
871
- * An encoder that turns raw PCM into AAC-LC frames, supplied by the CALLER. The SDK ships none: the
872
- * device's audio path is fixed at AAC-LC 16 kHz mono, and every plausible encoder is either a native
885
+ * An encoder that turns raw PCM into AAC-LC frames, supplied by the CALLER. The SDK ships none: an
886
+ * `aac-lc` speaker plays AAC-LC 16 kHz mono, and every plausible encoder is either a native
873
887
  * dependency or an external process, both of which belong to the host rather than to a protocol SDK.
874
- * It is unnecessary where the audio is already AAC — see {@link TalkbackHandle}.
888
+ * It is unnecessary where the audio is already AAC — see {@link TalkbackHandle}. A camera whose speaker
889
+ * plays `aac-eld` refuses an encoder: a talkback opened with one is rejected before the speaker path opens.
875
890
  *
876
891
  * `encode` receives 16-bit little-endian mono PCM at 16 kHz and returns whole ADTS frames, zero or
877
892
  * more per call (an encoder buffers until it has a full 1024-sample block). `flush` drains a partial
@@ -886,17 +901,19 @@ export interface AacEncoder {
886
901
  * A live talkback session: audio pushed from the host to a camera's speaker, the mirror of
887
902
  * {@link LiveStreamHandle}'s inbound feed.
888
903
  *
889
- * Audio must be **AAC-LC, 16 kHz, mono, in ADTS frames** — what the device's path is fixed at, so a
890
- * stream at another rate or channel count is rejected rather than resampled (it would otherwise play
891
- * at the wrong pitch and speed). Feed it either way:
904
+ * Audio must be in the codec the camera's speaker plays, {@link TalkbackHandle.codec}:
892
905
  *
893
- * - **ADTS AAC** — the default. Chunk boundaries are irrelevant; frames are recovered from the
894
- * stream, so piping an encoder's output straight in works.
895
- * - **PCM** — only when the handle was opened with an {@link AacEncoder}, which then does the
896
- * conversion. `write` takes 16-bit little-endian mono PCM at 16 kHz instead.
906
+ * - **`aac-lc`:** AAC-LC, 16 kHz, mono, in ADTS frames, through `write` / `writable()`. Chunk boundaries are
907
+ * irrelevant; frames are recovered from the stream. With an {@link AacEncoder}, `write` takes 16-bit
908
+ * little-endian mono PCM at 16 kHz instead.
909
+ * - **`aac-eld`:** one raw AAC-ELD access unit with LD-SBR (16 kHz, mono, 512 samples) per `write`, or per
910
+ * object-mode `writable()` write. No encoder applies.
897
911
  *
898
- * Frames are **paced** at their own playback rate (64 ms each) rather than flushed as fast as they
899
- * arrive, so feeding a file plays it at speed instead of overrunning the device. A live source keeps
912
+ * An `aac-lc` stream at another rate or channel count is rejected rather than resampled. An `aac-eld` unit longer
913
+ * than the device accepts is refused with an `error`.
914
+ *
915
+ * Frames are **paced** at their own playback rate (64 ms for `aac-lc`, 32 ms for `aac-eld`) rather than flushed as
916
+ * fast as they arrive, so feeding a file plays it at speed instead of overrunning the device. A live source keeps
900
917
  * the queue near-empty and is unaffected.
901
918
  *
902
919
  * @example
@@ -908,7 +925,16 @@ export interface AacEncoder {
908
925
  * ```
909
926
  */
910
927
  export interface TalkbackHandle {
911
- /** Queue audio — ADTS frames, or PCM when an encoder was supplied. Partial frames are held. */
928
+ /**
929
+ * The codec this camera's speaker plays: `aac-eld` on a camera whose speaker plays it and whose stream on the same
930
+ * media session carries `aac-eld`, `aac-lc` otherwise, including when that stream carries no audio. It decides
931
+ * what {@link write} and {@link writable} take.
932
+ */
933
+ readonly codec: TalkbackCodec;
934
+ /**
935
+ * Queue audio: ADTS frames or PCM for `aac-lc`, one access unit per call for `aac-eld`. Partial ADTS frames are
936
+ * held.
937
+ */
912
938
  write(chunk: Buffer): void;
913
939
  /**
914
940
  * A `node:stream` Writable over {@link write}, for piping a file or an encoder's stdout. Applies
@@ -931,7 +957,7 @@ export interface TalkbackHandle {
931
957
  *
932
958
  * This deliberately does NOT fire on a merely-empty queue. A realtime source keeps the queue near
933
959
  * empty by design, so "queue is empty" arrives after the very first frame and stopping on it would
934
- * cut the clip to 64 ms. {@link pending} is the instantaneous depth.
960
+ * cut the clip to one frame. {@link pending} is the instantaneous depth.
935
961
  */
936
962
  on(event: "finished", listener: () => void): this;
937
963
  /**
@@ -16,6 +16,8 @@ export interface PersistedSession {
16
16
  authToken: string;
17
17
  geoKey?: string;
18
18
  region: RegionShard;
19
+ /** The host `estimate_domain` answered; it names shards the region classification cannot (`ie`). */
20
+ estimatedDomain?: string;
19
21
  openudid: string;
20
22
  /** This install's reported device model + media user-agent, generated once and reused. */
21
23
  phoneModel?: string;
@@ -55,6 +55,8 @@ export interface EufyDevice {
55
55
  * every attached sensor of a T8010 — and serves only as a fallback for a device naming no parent.
56
56
  */
57
57
  stationSn?: string;
58
+ /** The device's channel on its station, as its record states it (`device_channel`); absent where it states none. */
59
+ channel?: number;
58
60
  /** Present (and non-empty) for P2P devices. */
59
61
  p2pDid?: string;
60
62
  /**