@mega-yfue/eufy-sdk 0.2.0-beta.4 → 0.2.0-beta.6

package/dist/index.js

@@ -7737,6 +7737,89 @@ var ModeCtrlMethod = {
   STOP_SMART_FOLLOW: 18,
   START_GLOBAL_CRUISE: 20
 };
+var ModeCtrlParamMethod = {
+  /** `START_SELECT_ROOMS_CLEAN` — clean the named rooms of a named map. */
+  SELECT_ROOMS: { method: 1, param: 4 },
+  /** `START_SELECT_ZONES_CLEAN` — clean the given rectangles of a named map. */
+  SELECT_ZONES: { method: 2, param: 5 },
+  /** `START_GOTO_CLEAN` — drive to a point and clean around it. */
+  GOTO: { method: 4, param: 7 },
+  /** `START_SCENE_CLEAN` — run a saved scene by its id. */
+  SCENE: { method: 24, param: 14 }
+};
+var SELECT_ROOMS_FIELD = {
+  /** `rooms` — repeated, one entry per room. */
+  ROOMS: 1,
+  /** `clean_times` — how many passes to make. */
+  CLEAN_TIMES: 2,
+  /** `map_id` — WHICH saved map the room ids belong to. */
+  MAP_ID: 3,
+  /** `id` within a `Room`. */
+  ROOM_ID: 1,
+  /** `order` within a `Room` — the sequence to visit them in. */
+  ROOM_ORDER: 2
+};
+var SELECT_ZONES_FIELD = {
+  /** `zones` — repeated, one entry per rectangle. */
+  ZONES: 1,
+  /** `map_id` — which saved map the coordinates belong to. */
+  MAP_ID: 2,
+  /** `quadrangle` within a `Zone` — its four corners. */
+  QUADRANGLE: 1,
+  /** `clean_times` within a `Zone`. */
+  ZONE_CLEAN_TIMES: 2,
+  /** `x` within a `Point`, SIGNED centimetres. */
+  POINT_X: 1,
+  /** `y` within a `Point`, SIGNED centimetres. */
+  POINT_Y: 2
+};
+var SCENE_CLEAN_ID = 1;
+function encodeModeCtrlParam(method2, paramField, build) {
+  return rawDp((w) => {
+    if (method2 !== 0)
+      w.int(MODE_CTRL_FIELD.METHOD, method2);
+    w.int(MODE_CTRL_FIELD.SEQ, nextModeCtrlSeq());
+    w.sub(paramField, build);
+  });
+}
+function encodeSelectRoomsClean(mapId, rooms, cleanTimes = 1) {
+  const { method: method2, param } = ModeCtrlParamMethod.SELECT_ROOMS;
+  return encodeModeCtrlParam(method2, param, (p) => {
+    for (const room of rooms) {
+      p.sub(SELECT_ROOMS_FIELD.ROOMS, (r) => {
+        r.int(SELECT_ROOMS_FIELD.ROOM_ID, room.id);
+        if (room.order !== void 0)
+          r.int(SELECT_ROOMS_FIELD.ROOM_ORDER, room.order);
+      });
+    }
+    p.int(SELECT_ROOMS_FIELD.CLEAN_TIMES, cleanTimes);
+    p.int(SELECT_ROOMS_FIELD.MAP_ID, mapId);
+  });
+}
+function encodeSelectZonesClean(mapId, zones) {
+  const { method: method2, param } = ModeCtrlParamMethod.SELECT_ZONES;
+  return encodeModeCtrlParam(method2, param, (p) => {
+    for (const zone of zones) {
+      p.sub(SELECT_ZONES_FIELD.ZONES, (z) => {
+        z.sub(SELECT_ZONES_FIELD.QUADRANGLE, (q) => {
+          for (const [i, corner] of zone.corners.entries()) {
+            q.sub(i + 1, (pt) => {
+              pt.sint(SELECT_ZONES_FIELD.POINT_X, corner.x);
+              pt.sint(SELECT_ZONES_FIELD.POINT_Y, corner.y);
+            });
+          }
+        });
+        if (zone.cleanTimes !== void 0)
+          z.int(SELECT_ZONES_FIELD.ZONE_CLEAN_TIMES, zone.cleanTimes);
+      });
+    }
+    p.int(SELECT_ZONES_FIELD.MAP_ID, mapId);
+  });
+}
+function encodeSceneClean(sceneId) {
+  const { method: method2, param } = ModeCtrlParamMethod.SCENE;
+  return encodeModeCtrlParam(method2, param, (p) => p.int(SCENE_CLEAN_ID, sceneId));
+}
 var modeCtrlSeq = 111;
 function nextModeCtrlSeq() {
   return ++modeCtrlSeq;
@@ -9572,7 +9655,41 @@ var VACUUM_CLEAN_MEMBERS = {
   /** Return to the dock via ModeCtrlRequest method 6 (DP 152). AIoT only — Tuya write unverified. */
   returnToDock: method(({ sink }) => () => sink.dispatch(aiotDp(VACUUM_DP.MODE_CTRL, encodeModeCtrl(ModeCtrlMethod.START_GOHOME, nextModeCtrlSeq()))), "Return to the dock (ModeCtrlRequest method 6 over DP 152).", isAiotVacuum),
   /** Pause the current cleaning task via ModeCtrlRequest method 13 (DP 152). AIoT only — Tuya write unverified. */
-  pauseCleaning: method(({ sink }) => () => sink.dispatch(aiotDp(VACUUM_DP.MODE_CTRL, encodeModeCtrl(ModeCtrlMethod.PAUSE_TASK, nextModeCtrlSeq()))), "Pause the current cleaning task (ModeCtrlRequest method 13 over DP 152).", isAiotVacuum)
+  pauseCleaning: method(({ sink }) => () => sink.dispatch(aiotDp(VACUUM_DP.MODE_CTRL, encodeModeCtrl(ModeCtrlMethod.PAUSE_TASK, nextModeCtrlSeq()))), "Pause the current cleaning task (ModeCtrlRequest method 13 over DP 152).", isAiotVacuum),
+  /**
+   * Run a saved cleaning scene by its id (ModeCtrlRequest method 24 over DP 152).
+   *
+   * The id is the device's own, as {@link VACUUM_CLEAN_MEMBERS.scenes} reports it — `VacuumScene.id`
+   * off the `SceneResponse` on DP 180. A scene the device reports invalid stays reportable and running
+   * it is still a well-formed request; `VacuumScene.invalidReason` says why the device will refuse.
+   *
+   * Frame shape is byte-proven against the shared outer `ModeCtrlRequest`, and method 24 has been
+   * WATCHED: run on a T2351, it started the named scene.
+   */
+  startScene: method(({ sink }) => (sceneId) => sink.dispatch(aiotDp(VACUUM_DP.MODE_CTRL, encodeSceneClean(sceneId))), "Run a saved cleaning scene by its id (ModeCtrlRequest method 24 over DP 152).", isAiotVacuum),
+  /**
+   * Clean the named rooms of a named map (ModeCtrlRequest method 1 over DP 152).
+   *
+   * `mapId` has no default and that is deliberate: room ids are per map, so assuming the map a
+   * single-floor home would have sends a two-floor home's ids against the wrong floor. `SceneInfo.mapid`
+   * on DP 180 and a scheduled rooms-clean's `map_id` are the two real map ids the device reports.
+   *
+   * `cleanTimes` is how many passes to make over the set; rooms with no `order` are visited in the
+   * order given.
+   *
+   * Frame shape is byte-proven against the shared outer `ModeCtrlRequest`, and method 1 has been
+   * WATCHED: run on a T2351, it cleaned the rooms named.
+   */
+  cleanRooms: method(({ sink }) => (mapId, rooms, cleanTimes = 1) => sink.dispatch(aiotDp(VACUUM_DP.MODE_CTRL, encodeSelectRoomsClean(mapId, rooms, cleanTimes))), "Clean the named rooms of a named map (ModeCtrlRequest method 1 over DP 152).", isAiotVacuum),
+  /**
+   * Clean the given rectangles of a named map (ModeCtrlRequest method 2 over DP 152).
+   *
+   * Corners are SIGNED centimetres in the map's own frame, whose origin sits wherever the robot first
+   * mapped from — negative coordinates are ordinary and are ZigZag-encoded, not written as plain
+   * varints. Same `mapId` reasoning as {@link VACUUM_CLEAN_MEMBERS.cleanRooms}, and the same evidence:
+   * method 2 was run on a T2351 and cleaned the rectangles given.
+   */
+  cleanZones: method(({ sink }) => (mapId, zones) => sink.dispatch(aiotDp(VACUUM_DP.MODE_CTRL, encodeSelectZonesClean(mapId, zones))), "Clean the given rectangles of a named map (ModeCtrlRequest method 2 over DP 152).", isAiotVacuum)
 };
 var VACUUM_CLEAN = {
   capability: "vacuum_clean",
@@ -9748,6 +9865,70 @@ function toNumberArray(arr) {
   return result;
 }
 
+// dist/model/capabilities/display.js
+var DISPLAY_PARAM = { BATTERY: 8001, SOFTWARE_VERSION: 8003 };
+var DISPLAY_MEMBERS = {
+  /**
+   * Battery level, 0-100.
+   *
+   * **On this capability rather than on `battery`, and that is the line partition doing its job.** The
+   * security-line `battery` capability reads param 1101 and a Smart Display's charge is 8001 in its own
+   * id space — two wires that happen to mean the same thing. One capability reading both would be a claim
+   * that the two ecosystems share a param space, so a consumer reads a display's charge through
+   * `dev.display()` and a camera's through `dev.battery()`.
+   *
+   * `verified` rather than `mega`: the id is in the device's cloud record, but the NAME came from the
+   * maintainer's own knowledge of the hardware rather than from the cloud data-point list, and `"100"`
+   * fits brightness, volume or charge equally.
+   *
+   * The scale is `percent` on the reading itself, not on convention alone: a full charge reads `255` on a
+   * 0-255 scale and `1000` on a 0-1000 one, so `"100"` on a charged unit is positive evidence for 0-100
+   * rather than merely consistent with it. What nobody has done is watch it MOVE, which is why a value
+   * frozen at 100 would not yet be distinguishable from a healthy one.
+   */
+  battery: {
+    param: DISPLAY_PARAM.BATTERY,
+    type: "number",
+    unit: "%",
+    kind: "percent",
+    provenance: "verified",
+    description: "Battery level, 0-100 (param 8001)."
+  },
+  /**
+   * Version-shaped, and that shape is the whole of the evidence — hence `guessed`, and hence no typed
+   * getter: a caller reading this off a bound object cannot see the label.
+   *
+   * `unexposed` rather than absent, so the schema still carries its type and that label and
+   * `getProperty("softwareVersion")` still answers. `dev.info()?.firmwareVersion` is the field to trust
+   * where the cloud record carries one; on this display it does not, which is the only reason 8003 is
+   * named at all.
+   */
+  softwareVersion: {
+    param: DISPLAY_PARAM.SOFTWARE_VERSION,
+    type: "string",
+    kind: "text",
+    provenance: "guessed",
+    unexposed: true,
+    description: "Version-shaped string (param 8003), meaning unconfirmed \u2014 prefer `info.firmwareVersion`."
+  }
+};
+var DISPLAY = {
+  capability: "display",
+  line: "display",
+  description: "Smart Display battery level (param 8001, display namespace).",
+  members: DISPLAY_MEMBERS,
+  properties: propertiesOf(DISPLAY_MEMBERS),
+  /**
+   * Claimed by CODEC, not by an evidence param.
+   *
+   * 8001 is in the device's cloud record, so the ordinary evidence gate would install the getter anyway
+   * — but the capability should attach to a Smart Display that has reported nothing yet too, because a
+   * device on this line has no other capability to carry it. The line partition keeps this off
+   * everything else: `display` is the only codec in the `display` line.
+   */
+  detection: { codecs: ["display"] }
+};
+
 // dist/model/capabilities/locate.js
 var LOCATE_DP = 160;
 var LEGACY_LOCATE_DP = TUYA_VACUUM_DP.LOOK_FOR_SWEEPER;
@@ -9876,6 +10057,7 @@ var MODULES = [
   VACUUM_DOCK,
   SUCTION,
   LOCATE,
+  DISPLAY,
   INFO
 ];
 var BY_CAP = new Map(MODULES.map((m) => [m.capability, m]));
@@ -9920,7 +10102,7 @@ var CODEC_LINE = {
   mower: "clean",
   light: "life",
   printer: "print",
-  display: "security"
+  display: "display"
 };
 function lineAllows(module, codec) {
   const line = module.line ?? "security";
@@ -12020,6 +12202,28 @@ var CLEAN_PARAMS = {
     provenance: "mega"
   }
 };
+var DISPLAY_PARAMS = {
+  8001: {
+    name: "battery",
+    type: "number",
+    provenance: "verified"
+  },
+  8003: {
+    name: "softwareVersion",
+    type: "string",
+    provenance: "guessed"
+  },
+  8005: {
+    name: "modelName",
+    type: "string",
+    provenance: "mega"
+  },
+  8006: {
+    name: "modelCode",
+    type: "string",
+    provenance: "mega"
+  }
+};
 
 // dist/model/life-params.js
 var LIFE_PARAMS = {
@@ -12047,7 +12251,10 @@ var TABLES = {
   // 3D-printer (ankermake) id space — empty until a live capture confirms the param↔semantic map
   // (printer-support plan Stage 3). Present so the printer codec resolves to its OWN namespace rather
   // than falling through to `security` and decoding another line's dictionary.
-  print: {}
+  print: {},
+  // Smart Display (T87Ax) — ids 8001-8006, four of them named. Same reason as `print`: its own
+  // dictionary rather than a corner of another line's.
+  display: DISPLAY_PARAMS
 };
 function paramDef(ns, paramType) {
   return TABLES[ns][paramType];
@@ -12062,7 +12269,7 @@ var NAMESPACE_BY_CODEC = {
   mower: "clean",
   light: "life",
   printer: "print",
-  display: "security"
+  display: "display"
 };
 function namespaceForCodec(codec) {
   return NAMESPACE_BY_CODEC[codec];
@@ -25424,6 +25631,7 @@ export {
   CusPushEvent,
   CusPushMode,
   DEFAULT_KEEPALIVE_MS,
+  DISPLAY_MEMBERS,
   DOCK_ACTIVITIES,
   DOCK_KINDS,
   DOORBELL_MEMBERS,