@apocaliss92/nodedreame 1.6.0 → 1.7.0

package/dist/index.cjs

@@ -55,10 +55,12 @@ __export(index_exports, {
   Nodreame: () => Nodreame,
   SuctionLevel: () => SuctionLevel,
   TaskStatus: () => TaskStatus,
+  VACUUM_CONSUMABLES: () => VACUUM_CONSUMABLES,
   VACUUM_MODEL_CAPABILITIES: () => MODEL_CAPABILITIES,
   VacuumCapabilityResolver: () => VacuumCapabilityResolver,
   VacuumDevice: () => VacuumDevice,
   WaterVolume: () => WaterVolume,
+  consumableSpec: () => consumableSpec,
   createClientDumper: () => createClientDumper,
   createDumper: () => createDumper,
   decodeAiFeature: () => decodeAiFeature,
@@ -73,7 +75,7 @@ module.exports = __toCommonJS(index_exports);
 
 // src/support/version.ts
 var LIBRARY_NAME = "nodedreame";
-var LIBRARY_VERSION = "1.6.0";
+var LIBRARY_VERSION = "1.7.0";
 
 // src/transport/errors.ts
 var DreameError = class extends Error {
@@ -1643,6 +1645,23 @@ function encodeAiFeatureWrite(raw, feature, value) {
   );
 }
 
+// src/models/vacuum/consumables.ts
+var VACUUM_CONSUMABLES = [
+  { key: "main-brush", label: "Main Brush", life: { siid: 9, piid: 2 }, reset: { siid: 9, aiid: 1 } },
+  { key: "side-brush", label: "Side Brush", life: { siid: 10, piid: 2 }, reset: { siid: 10, aiid: 1 } },
+  { key: "filter", label: "Filter", life: { siid: 11, piid: 1 }, reset: { siid: 11, aiid: 1 } },
+  { key: "sensor", label: "Sensor", life: { siid: 16, piid: 1 }, reset: { siid: 16, aiid: 1 } },
+  { key: "tank-filter", label: "Tank Filter", life: { siid: 17, piid: 1 }, reset: { siid: 17, aiid: 1 } },
+  { key: "mop-pad", label: "Mop Pad", life: { siid: 18, piid: 1 }, reset: { siid: 18, aiid: 1 } },
+  { key: "silver-ion", label: "Silver-ion", life: { siid: 19, piid: 2 }, reset: { siid: 19, aiid: 1 } },
+  { key: "detergent", label: "Detergent", life: { siid: 20, piid: 1 }, reset: { siid: 20, aiid: 1 } },
+  { key: "squeegee", label: "Squeegee", life: { siid: 24, piid: 1 }, reset: { siid: 24, aiid: 1 } },
+  { key: "dust-bag", label: "Dust Bag", life: { siid: 27, piid: 17 }, reset: null }
+];
+function consumableSpec(key2) {
+  return VACUUM_CONSUMABLES.find((c) => c.key === key2);
+}
+
 // src/models/vacuum/capabilities.ts
 var X50_AI_FEATURES = [
   "obstacleDetection",
@@ -2844,6 +2863,51 @@ var VacuumDevice = class _VacuumDevice extends BaseDevice {
   get volume() {
     return this.#num(SETTINGS_PROP.VOLUME.siid, SETTINGS_PROP.VOLUME.piid);
   }
+  // -- consumables --------------------------------------------------------
+  /**
+   * Remaining-life % (0..100) for one consumable, or `null` when the model does
+   * not report it (presence == support). Call {@link refreshConsumables} first
+   * on a docked robot so the cloud-shadow life values are seeded.
+   */
+  consumableLeftPct(key2) {
+    const spec = consumableSpec(key2);
+    if (spec === void 0) return null;
+    return this.#num(spec.life.siid, spec.life.piid);
+  }
+  /**
+   * The consumables this model EXPOSES — discovered by presence (a reported
+   * life property), mirroring how the HA integration derives support. Each
+   * reading carries the current remaining-life % and whether a reset action
+   * exists. Empty until the life properties have been observed (push) or seeded
+   * via {@link refreshConsumables}.
+   */
+  get supportedConsumables() {
+    return VACUUM_CONSUMABLES.flatMap((spec) => {
+      const leftPct = this.#num(spec.life.siid, spec.life.piid);
+      return leftPct === null ? [] : [{ key: spec.key, label: spec.label, leftPct, resettable: spec.reset !== null }];
+    });
+  }
+  /**
+   * Seed EVERY consumable life property from the cloud shadow (no robot wake) so
+   * {@link supportedConsumables} reflects the full set on a docked robot. The
+   * consumable life values are static settings the robot rarely re-pushes over
+   * MQTT, so a fresh connect surfaces only the actively-changing ones without this.
+   */
+  async refreshConsumables() {
+    await this.refreshCachedProperties(VACUUM_CONSUMABLES.map((c) => c.life));
+  }
+  /**
+   * Reset (mark replaced → life back to 100%) one consumable via its MIoT reset
+   * action. Rejects when the model exposes no reset action for the key (e.g.
+   * `dust-bag`) or the key is unknown.
+   */
+  async resetConsumable(key2) {
+    const spec = consumableSpec(key2);
+    if (spec === void 0 || spec.reset === null) {
+      throw new DreameError(`resetConsumable: no reset action for consumable "${key2}"`);
+    }
+    return this.callAction(spec.reset.siid, spec.reset.aiid, []);
+  }
   // -- AI obstacle-detection ----------------------------------------------
   /**
    * The raw `AI_DETECTION` value (siid 4 piid 22) — an int bitmask or a JSON
@@ -2866,6 +2930,20 @@ var VacuumDevice = class _VacuumDevice extends BaseDevice {
   aiFeature(feature) {
     return decodeAiFeature(this.aiDetectionRaw, feature);
   }
+  /**
+   * Seed {@link aiDetectionRaw} from the CLOUD SHADOW (the last value the robot
+   * pushed for `AI_DETECTION`, siid 4 piid 22) WITHOUT waking it. The AI-obstacle
+   * toggles are STATIC settings the robot rarely re-pushes over MQTT, so a fresh
+   * connect to an idle robot has no value cached — call this on activate to
+   * surface the current toggles. Emits the usual `propertyChanged`/`stateChanged`
+   * (so a watching consumer re-decodes) and returns the resolved raw value
+   * (`null` when the model has no AI detection or the shadow carries none yet).
+   */
+  async refreshAiDetection() {
+    if (!this.#caps.hasAiObstacleDetection) return null;
+    await this.refreshCachedProperties([VACUUM_PROP.AI_DETECTION]);
+    return this.aiDetectionRaw;
+  }
   /**
    * Toggle ONE AI-obstacle feature, preserving the others via a read-modify-write
    * of the packed `AI_DETECTION` property (mirrors Tasshack `set_ai_detection`).
@@ -4815,10 +4893,12 @@ function createClientDumper(client, options) {
   Nodreame,
   SuctionLevel,
   TaskStatus,
+  VACUUM_CONSUMABLES,
   VACUUM_MODEL_CAPABILITIES,
   VacuumCapabilityResolver,
   VacuumDevice,
   WaterVolume,
+  consumableSpec,
   createClientDumper,
   createDumper,
   decodeAiFeature,