@apocaliss92/nodedreame 1.8.1 → 1.10.0

package/dist/index.d.cts

@@ -1220,17 +1220,42 @@ interface VacuumMap {
  * Raster PNG renderer for a decoded `VacuumMap`.
  *
  * node-dreame ships only the structured model (no image); this is NEW. We paint
- * one pixel per grid cell (× an optional integer upscale `scale`) from the
- * run-length `layers`, later layers painting over earlier ones. The background
- * is transparent. Per-segment colours come from a deterministic golden-angle
- * palette so the same room id always renders the same hue.
+ * the run-length `layers` (floor / segments / carpet / walls) one pixel per grid
+ * cell (× an optional integer upscale `scale`), then composite the world-frame
+ * overlays on top: restricted areas (no-go / no-mop), virtual walls, the cleaning
+ * path polylines, AI obstacles, the charger, and the robot (body + heading). A
+ * `colorScheme` picks the palette and every overlay is independently toggleable,
+ * mirroring how the Home Assistant integration exposes map customization.
+ *
+ * Coordinate transform: every overlay coordinate is mm in the world frame.
+ * `dimensions.left` / `.top` are the world-mm of pixel (0,0) and `.gridSize` is
+ * mm-per-pixel, so `px = (worldX - left) / gridSize` (then × `scale`). Row 0 is
+ * the top edge — no Y flip.
  *
  * Pure: only `pngjs` + arithmetic. No casts.
  */
 
+/** A named map palette. Mirrors the HA integration's `color_scheme` choices. */
+type MapColorScheme = 'dreame-light' | 'dreame-dark' | 'mijia-light' | 'tasshack';
 interface RenderVacuumPngOptions {
     /** Integer upscale factor (nearest-neighbour). Default 1. */
     scale?: number;
+    /** Palette. Default `'dreame-light'`. */
+    colorScheme?: MapColorScheme;
+    /** Draw the cleaning/mopping path polylines. Default true. */
+    showPath?: boolean;
+    /** Draw the robot marker (body + heading). Default true. */
+    showRobot?: boolean;
+    /** Draw the charger / dock marker. Default true. */
+    showCharger?: boolean;
+    /** Draw no-go / no-mop restricted areas. Default true. */
+    showNoGo?: boolean;
+    /** Draw user-defined virtual walls. Default true. */
+    showVirtualWalls?: boolean;
+    /** Draw AI-detected obstacle markers. Default true. */
+    showObstacles?: boolean;
+    /** Draw the segment id as a tiny label at each room centroid. Default false. */
+    showSegmentLabels?: boolean;
 }
 declare function renderVacuumPng(map: VacuumMap, opts?: RenderVacuumPngOptions): Buffer;
 
@@ -1566,6 +1591,22 @@ declare class VacuumDevice extends BaseDevice<VacuumDeviceEvents> {
      * `applyVacuumPFrame` merge primitive ships separately for that work.
      */
     getMap(input: VacuumGetMapInput): Promise<VacuumMap>;
+    /** Drop the P-frame merge base so the next I-frame re-seeds the stream. */
+    resetMapStream(): void;
+    /**
+     * Fetch the latest advertised map frame and fold it into a continuously
+     * updating map. An I-frame (re)seeds the merge base and renders standalone; a
+     * P-frame is merged onto the base via {@link applyVacuumPFrame} so the live
+     * grid stays COMPLETE (a P-frame decoded standalone is only byte-deltas). On an
+     * out-of-order P-frame or a map-id change the base is dropped and `null`
+     * returned — the next I-frame re-seeds. Returns `null` when no frame is
+     * advertised yet, or a P-frame arrives before any I-frame.
+     *
+     * Caches {@link lastMap} and emits `'map'` exactly like {@link getMap}, so a
+     * map-watching consumer (e.g. the camstack map child) gets a fresh complete
+     * frame on every push during a live clean.
+     */
+    fetchLatestMapStreaming(opts?: Omit<VacuumGetMapInput, 'filename'>): Promise<VacuumMap | null>;
     /** Props worth seeding on start() / polling — exported for the facade. */
     static readonly DEFAULT_PROPS: readonly [{
         readonly siid: 2;
@@ -2407,4 +2448,4 @@ declare function createDumper(target: DumperDevice, options?: DumperOptions): Du
  */
 declare function createClientDumper(client: Nodreame, options?: DumperOptions): Dumper[];
 
-export { AI_FEATURE_BIT, AI_FEATURE_JSON_KEY, AUTO_SWITCH_JSON_KEY, type AiDetectionRaw, type AutoSwitchKey, type AutoSwitchRaw, BaseDevice, type BaseDeviceEvents, type BatchDeviceDataFetcher, type CapabilityResolver, ChargingStatus, type CleanOpts, CleaningMode, type ConsumableReading, type ConsumableSpec, type CreateDeviceArgs, DefaultCapabilityResolver, type DeviceCapabilities, type DeviceDump, type DeviceEvent, type DreameAiFeature, DreameApiError, DreameAuthError, type DreameCloudState, type DreameConsumableKey, type DreameDevice, DreameDeviceOfflineError, DreameError, type DreameRegion, type DreameSession, DreameTransportError, type DumperOptions, LIBRARY_NAME, MODEL_CAPABILITIES as MOWER_MODEL_CAPABILITIES, type MapBoundingBox, type MapCleanedAreaOverlay, type MapDimensions, type MapFrameType, type MapLayer, type MapLayerType, type MapLowLyingArea, type MapObstacle, type MapPath, type MapPathType, type MapPoint, type MapPose, type MapRestrictedArea, type MapRoom, type MapRoomWall, type MapRun, type MapSegment, type MapStorey, type MapVirtualWall, type MapWallsInfo, type MiotAction, MiotError, type MiotProp, MiotState, type MowerAvailableMap, type MowerCapabilities, MowerCapabilityResolver, MowerChargingStatus, type MowerContour, MowerControlAction, type MowerControlState, MowerDevice, type MowerDeviceInput, MowerFault, type MowerMap, type MowerMapBoundary, type MowerMowPath, type MowerPathEntry, type MowerPoint, type MowerSpotArea, MowerStatus, type MowerTaskDescriptor, MowerTaskStatus, type MowerZone, Nodreame, type NodreameDeps, type NodreameEvents, type NodreameOptions, type OssFetchInput, type OssFetcherLike, type PropertyChangedEvent, type PropertyResult, type PropertyState, type PropertyWrite, type RenderMowerSvgOptions, type RenderVacuumPngOptions, type StateChangedEvent, SuctionLevel, TaskStatus, VACUUM_CONSUMABLES, MODEL_CAPABILITIES$1 as VACUUM_MODEL_CAPABILITIES, type VacuumCapabilities, VacuumCapabilityResolver, VacuumDevice, type VacuumGetMapInput, type VacuumMap, WaterVolume, consumableSpec, createClientDumper, createDumper, decodeAiFeature, decodeAutoSwitch, decodeAutoSwitchAll, encodeAiFeatureWrite, encodeAutoSwitchWrite, getMowerCapabilities, getVacuumCapabilities, isDreameConsumableKey, renderMowerSvg, renderVacuumPng, resolveCapabilities, supportedAutoSwitchKeys };
+export { AI_FEATURE_BIT, AI_FEATURE_JSON_KEY, AUTO_SWITCH_JSON_KEY, type AiDetectionRaw, type AutoSwitchKey, type AutoSwitchRaw, BaseDevice, type BaseDeviceEvents, type BatchDeviceDataFetcher, type CapabilityResolver, ChargingStatus, type CleanOpts, CleaningMode, type ConsumableReading, type ConsumableSpec, type CreateDeviceArgs, DefaultCapabilityResolver, type DeviceCapabilities, type DeviceDump, type DeviceEvent, type DreameAiFeature, DreameApiError, DreameAuthError, type DreameCloudState, type DreameConsumableKey, type DreameDevice, DreameDeviceOfflineError, DreameError, type DreameRegion, type DreameSession, DreameTransportError, type DumperOptions, LIBRARY_NAME, MODEL_CAPABILITIES as MOWER_MODEL_CAPABILITIES, type MapBoundingBox, type MapCleanedAreaOverlay, type MapColorScheme, type MapDimensions, type MapFrameType, type MapLayer, type MapLayerType, type MapLowLyingArea, type MapObstacle, type MapPath, type MapPathType, type MapPoint, type MapPose, type MapRestrictedArea, type MapRoom, type MapRoomWall, type MapRun, type MapSegment, type MapStorey, type MapVirtualWall, type MapWallsInfo, type MiotAction, MiotError, type MiotProp, MiotState, type MowerAvailableMap, type MowerCapabilities, MowerCapabilityResolver, MowerChargingStatus, type MowerContour, MowerControlAction, type MowerControlState, MowerDevice, type MowerDeviceInput, MowerFault, type MowerMap, type MowerMapBoundary, type MowerMowPath, type MowerPathEntry, type MowerPoint, type MowerSpotArea, MowerStatus, type MowerTaskDescriptor, MowerTaskStatus, type MowerZone, Nodreame, type NodreameDeps, type NodreameEvents, type NodreameOptions, type OssFetchInput, type OssFetcherLike, type PropertyChangedEvent, type PropertyResult, type PropertyState, type PropertyWrite, type RenderMowerSvgOptions, type RenderVacuumPngOptions, type StateChangedEvent, SuctionLevel, TaskStatus, VACUUM_CONSUMABLES, MODEL_CAPABILITIES$1 as VACUUM_MODEL_CAPABILITIES, type VacuumCapabilities, VacuumCapabilityResolver, VacuumDevice, type VacuumGetMapInput, type VacuumMap, WaterVolume, consumableSpec, createClientDumper, createDumper, decodeAiFeature, decodeAutoSwitch, decodeAutoSwitchAll, encodeAiFeatureWrite, encodeAutoSwitchWrite, getMowerCapabilities, getVacuumCapabilities, isDreameConsumableKey, renderMowerSvg, renderVacuumPng, resolveCapabilities, supportedAutoSwitchKeys };

package/dist/index.d.ts

@@ -1220,17 +1220,42 @@ interface VacuumMap {
  * Raster PNG renderer for a decoded `VacuumMap`.
  *
  * node-dreame ships only the structured model (no image); this is NEW. We paint
- * one pixel per grid cell (× an optional integer upscale `scale`) from the
- * run-length `layers`, later layers painting over earlier ones. The background
- * is transparent. Per-segment colours come from a deterministic golden-angle
- * palette so the same room id always renders the same hue.
+ * the run-length `layers` (floor / segments / carpet / walls) one pixel per grid
+ * cell (× an optional integer upscale `scale`), then composite the world-frame
+ * overlays on top: restricted areas (no-go / no-mop), virtual walls, the cleaning
+ * path polylines, AI obstacles, the charger, and the robot (body + heading). A
+ * `colorScheme` picks the palette and every overlay is independently toggleable,
+ * mirroring how the Home Assistant integration exposes map customization.
+ *
+ * Coordinate transform: every overlay coordinate is mm in the world frame.
+ * `dimensions.left` / `.top` are the world-mm of pixel (0,0) and `.gridSize` is
+ * mm-per-pixel, so `px = (worldX - left) / gridSize` (then × `scale`). Row 0 is
+ * the top edge — no Y flip.
  *
  * Pure: only `pngjs` + arithmetic. No casts.
  */
 
+/** A named map palette. Mirrors the HA integration's `color_scheme` choices. */
+type MapColorScheme = 'dreame-light' | 'dreame-dark' | 'mijia-light' | 'tasshack';
 interface RenderVacuumPngOptions {
     /** Integer upscale factor (nearest-neighbour). Default 1. */
     scale?: number;
+    /** Palette. Default `'dreame-light'`. */
+    colorScheme?: MapColorScheme;
+    /** Draw the cleaning/mopping path polylines. Default true. */
+    showPath?: boolean;
+    /** Draw the robot marker (body + heading). Default true. */
+    showRobot?: boolean;
+    /** Draw the charger / dock marker. Default true. */
+    showCharger?: boolean;
+    /** Draw no-go / no-mop restricted areas. Default true. */
+    showNoGo?: boolean;
+    /** Draw user-defined virtual walls. Default true. */
+    showVirtualWalls?: boolean;
+    /** Draw AI-detected obstacle markers. Default true. */
+    showObstacles?: boolean;
+    /** Draw the segment id as a tiny label at each room centroid. Default false. */
+    showSegmentLabels?: boolean;
 }
 declare function renderVacuumPng(map: VacuumMap, opts?: RenderVacuumPngOptions): Buffer;
 
@@ -1566,6 +1591,22 @@ declare class VacuumDevice extends BaseDevice<VacuumDeviceEvents> {
      * `applyVacuumPFrame` merge primitive ships separately for that work.
      */
     getMap(input: VacuumGetMapInput): Promise<VacuumMap>;
+    /** Drop the P-frame merge base so the next I-frame re-seeds the stream. */
+    resetMapStream(): void;
+    /**
+     * Fetch the latest advertised map frame and fold it into a continuously
+     * updating map. An I-frame (re)seeds the merge base and renders standalone; a
+     * P-frame is merged onto the base via {@link applyVacuumPFrame} so the live
+     * grid stays COMPLETE (a P-frame decoded standalone is only byte-deltas). On an
+     * out-of-order P-frame or a map-id change the base is dropped and `null`
+     * returned — the next I-frame re-seeds. Returns `null` when no frame is
+     * advertised yet, or a P-frame arrives before any I-frame.
+     *
+     * Caches {@link lastMap} and emits `'map'` exactly like {@link getMap}, so a
+     * map-watching consumer (e.g. the camstack map child) gets a fresh complete
+     * frame on every push during a live clean.
+     */
+    fetchLatestMapStreaming(opts?: Omit<VacuumGetMapInput, 'filename'>): Promise<VacuumMap | null>;
     /** Props worth seeding on start() / polling — exported for the facade. */
     static readonly DEFAULT_PROPS: readonly [{
         readonly siid: 2;
@@ -2407,4 +2448,4 @@ declare function createDumper(target: DumperDevice, options?: DumperOptions): Du
  */
 declare function createClientDumper(client: Nodreame, options?: DumperOptions): Dumper[];
 
-export { AI_FEATURE_BIT, AI_FEATURE_JSON_KEY, AUTO_SWITCH_JSON_KEY, type AiDetectionRaw, type AutoSwitchKey, type AutoSwitchRaw, BaseDevice, type BaseDeviceEvents, type BatchDeviceDataFetcher, type CapabilityResolver, ChargingStatus, type CleanOpts, CleaningMode, type ConsumableReading, type ConsumableSpec, type CreateDeviceArgs, DefaultCapabilityResolver, type DeviceCapabilities, type DeviceDump, type DeviceEvent, type DreameAiFeature, DreameApiError, DreameAuthError, type DreameCloudState, type DreameConsumableKey, type DreameDevice, DreameDeviceOfflineError, DreameError, type DreameRegion, type DreameSession, DreameTransportError, type DumperOptions, LIBRARY_NAME, MODEL_CAPABILITIES as MOWER_MODEL_CAPABILITIES, type MapBoundingBox, type MapCleanedAreaOverlay, type MapDimensions, type MapFrameType, type MapLayer, type MapLayerType, type MapLowLyingArea, type MapObstacle, type MapPath, type MapPathType, type MapPoint, type MapPose, type MapRestrictedArea, type MapRoom, type MapRoomWall, type MapRun, type MapSegment, type MapStorey, type MapVirtualWall, type MapWallsInfo, type MiotAction, MiotError, type MiotProp, MiotState, type MowerAvailableMap, type MowerCapabilities, MowerCapabilityResolver, MowerChargingStatus, type MowerContour, MowerControlAction, type MowerControlState, MowerDevice, type MowerDeviceInput, MowerFault, type MowerMap, type MowerMapBoundary, type MowerMowPath, type MowerPathEntry, type MowerPoint, type MowerSpotArea, MowerStatus, type MowerTaskDescriptor, MowerTaskStatus, type MowerZone, Nodreame, type NodreameDeps, type NodreameEvents, type NodreameOptions, type OssFetchInput, type OssFetcherLike, type PropertyChangedEvent, type PropertyResult, type PropertyState, type PropertyWrite, type RenderMowerSvgOptions, type RenderVacuumPngOptions, type StateChangedEvent, SuctionLevel, TaskStatus, VACUUM_CONSUMABLES, MODEL_CAPABILITIES$1 as VACUUM_MODEL_CAPABILITIES, type VacuumCapabilities, VacuumCapabilityResolver, VacuumDevice, type VacuumGetMapInput, type VacuumMap, WaterVolume, consumableSpec, createClientDumper, createDumper, decodeAiFeature, decodeAutoSwitch, decodeAutoSwitchAll, encodeAiFeatureWrite, encodeAutoSwitchWrite, getMowerCapabilities, getVacuumCapabilities, isDreameConsumableKey, renderMowerSvg, renderVacuumPng, resolveCapabilities, supportedAutoSwitchKeys };
+export { AI_FEATURE_BIT, AI_FEATURE_JSON_KEY, AUTO_SWITCH_JSON_KEY, type AiDetectionRaw, type AutoSwitchKey, type AutoSwitchRaw, BaseDevice, type BaseDeviceEvents, type BatchDeviceDataFetcher, type CapabilityResolver, ChargingStatus, type CleanOpts, CleaningMode, type ConsumableReading, type ConsumableSpec, type CreateDeviceArgs, DefaultCapabilityResolver, type DeviceCapabilities, type DeviceDump, type DeviceEvent, type DreameAiFeature, DreameApiError, DreameAuthError, type DreameCloudState, type DreameConsumableKey, type DreameDevice, DreameDeviceOfflineError, DreameError, type DreameRegion, type DreameSession, DreameTransportError, type DumperOptions, LIBRARY_NAME, MODEL_CAPABILITIES as MOWER_MODEL_CAPABILITIES, type MapBoundingBox, type MapCleanedAreaOverlay, type MapColorScheme, type MapDimensions, type MapFrameType, type MapLayer, type MapLayerType, type MapLowLyingArea, type MapObstacle, type MapPath, type MapPathType, type MapPoint, type MapPose, type MapRestrictedArea, type MapRoom, type MapRoomWall, type MapRun, type MapSegment, type MapStorey, type MapVirtualWall, type MapWallsInfo, type MiotAction, MiotError, type MiotProp, MiotState, type MowerAvailableMap, type MowerCapabilities, MowerCapabilityResolver, MowerChargingStatus, type MowerContour, MowerControlAction, type MowerControlState, MowerDevice, type MowerDeviceInput, MowerFault, type MowerMap, type MowerMapBoundary, type MowerMowPath, type MowerPathEntry, type MowerPoint, type MowerSpotArea, MowerStatus, type MowerTaskDescriptor, MowerTaskStatus, type MowerZone, Nodreame, type NodreameDeps, type NodreameEvents, type NodreameOptions, type OssFetchInput, type OssFetcherLike, type PropertyChangedEvent, type PropertyResult, type PropertyState, type PropertyWrite, type RenderMowerSvgOptions, type RenderVacuumPngOptions, type StateChangedEvent, SuctionLevel, TaskStatus, VACUUM_CONSUMABLES, MODEL_CAPABILITIES$1 as VACUUM_MODEL_CAPABILITIES, type VacuumCapabilities, VacuumCapabilityResolver, VacuumDevice, type VacuumGetMapInput, type VacuumMap, WaterVolume, consumableSpec, createClientDumper, createDumper, decodeAiFeature, decodeAutoSwitch, decodeAutoSwitchAll, encodeAiFeatureWrite, encodeAutoSwitchWrite, getMowerCapabilities, getVacuumCapabilities, isDreameConsumableKey, renderMowerSvg, renderVacuumPng, resolveCapabilities, supportedAutoSwitchKeys };