@mega-yfue/eufy-sdk 0.2.0-beta.8 → 0.2.0

package/dist/model/capabilities/types.d.ts

@@ -136,6 +136,45 @@ export interface EventMapping {
      * capture. Return `{}` when this signal doesn't carry the field, so nothing is invented.
      */
     derive?(signal: InboundSignal): Record<string, unknown>;
+    /**
+     * Evidence that this device deals in the classification the id names, for an id whose presence in
+     * the wire vocabulary does not prove it.
+     *
+     * The AI-detection ids are shared verbatim across the camera families, so the id space says what an
+     * integer MEANS and never which units classify that way. A claim is how a mapping states the
+     * evidence that separates them, and it narrows the DESCRIPTION only: {@link EventMapping} stays in
+     * the dispatch index unclaimed, so a device that sends the push still gets the event. Under-reporting
+     * what a device is expected to emit is recoverable; dropping an event it did emit is not.
+     *
+     * Every field must hold — the AND to {@link DetectionSpec}'s OR, because a claim rules a family OUT
+     * rather than finding one more reason to say yes. A fact the context does not carry rules nothing
+     * out: only evidence that positively contradicts the claim withdraws the event.
+     */
+    claim?: EventClaim;
+}
+/**
+ * Evidence separating the families that share one inbound id.
+ *
+ * Both fields are optional and independent; an empty claim asserts nothing and is the same as none.
+ */
+export interface EventClaim {
+    /**
+     * The codecs whose devices issue the id. For an id drawn from a vocabulary one device family owns:
+     * the AI-detection ids belong to the camera families, and a standalone sensor announces its own
+     * motion under a different id entirely.
+     */
+    codecs?: readonly Codec[];
+    /**
+     * Member names whose INSTALLED getter is the evidence — the device reported the parameter behind
+     * the classification, which is the same bar every typed read is held to.
+     */
+    reads?: readonly string[];
+    /**
+     * The topology the id belongs to: `true` for an id only a station's attached device sends, `false`
+     * for one only a standalone unit sends. Compared against {@link AvailabilityContext.homeBaseAttached},
+     * and ignored where that is absent.
+     */
+    homeBaseAttached?: boolean;
 }
 /**
  * A decoded inbound event a capability wants surfaced on the SDK. `event` is the EufyMega event
@@ -169,8 +208,13 @@ export interface DecodedState {
  * the manifest path and the command path.
  */
 export interface AvailabilityContext {
-    /** Resolved codec/family. */
-    codec: Codec;
+    /**
+     * Resolved codec/family. Absent for a device outside the eufy device model entirely — the codecs are
+     * the eufy transport families, so an ecosystem with its own backend has no truthful value here and
+     * says so by omission rather than borrowing another family's. Every gate that reads it compares
+     * against a specific codec, so an absent one matches none.
+     */
+    codec?: Codec;
     /** eufy DeviceType, when known. */
     deviceType?: number;
     /** Model / T-code, when known. */
@@ -192,6 +236,15 @@ export interface AvailabilityContext {
      * `undefined` as an empty set — `ctx.paramIds?.has(dp) ?? false`.
      */
     paramIds?: ReadonlySet<number>;
+    /**
+     * Whether the device hangs off a HomeBase (a `parent_sn` other than its own) rather than standing
+     * alone. A DEVICE fact, not a transport one — the same class of routing evidence as {@link hasP2p} —
+     * which is why it sits here rather than on {@link CommandContext}: it is as true of a described
+     * device as of a commanded one. The `rtsp` capability gates on it because a station serves an
+     * attached camera's stream itself and ignores that camera's authentication setting, so the write
+     * cannot do what its name promises there.
+     */
+    homeBaseAttached?: boolean;
 }
 export interface CommandContext extends AvailabilityContext {
     /** Device channel (0 for standalone, `device_channel` on a HomeBase). */
@@ -242,7 +295,11 @@ export interface CommandContext extends AvailabilityContext {
     adminUserId?: string;
     /** The acting member's short id (`member.short_user_id`, hex, e.g. `"0003"`) — the lock cmd `A5` field. */
     shortUserId?: string;
-    /** The logged-in account's display name (email local-part) — the lock cmd acting-username `A4` field. */
+    /**
+     * The acting name a command attributes itself to — the lock cmd acting-username `A4` field, and the
+     * `user_name` of the guard-mode and HomeBase-alarm writes. The logged-in account's display name
+     * (email local-part) unless the client pins a different label for it.
+     */
     accountName?: string;
     /**
      * Whether the device has a usable P2P endpoint (a non-empty `p2p_did`). A HomeBase-attached lock
@@ -250,13 +307,6 @@ export interface CommandContext extends AvailabilityContext {
      * capability uses this to route lock/unlock to P2P vs. reject with a clear MQTT-not-wired error.
      */
     hasP2p?: boolean;
-    /**
-     * Whether the device hangs off a HomeBase (a `parent_sn` other than its own) rather than standing
-     * alone. A DEVICE fact, not a transport one — the same class of routing evidence as {@link hasP2p}.
-     * The `rtsp` capability gates on it because a station serves an attached camera's stream itself and
-     * ignores that camera's authentication setting, so the write cannot do what its name promises there.
-     */
-    homeBaseAttached?: boolean;
     /**
      * Parsed `get_product_data_point` catalog for this device's SKU — present for vacuum/mower devices,
      * absent for all other codecs. Capabilities use it for per-model feature-availability and value-range

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

@@ -379,6 +379,23 @@ export type CarpetStrategy = (typeof CARPET_STRATEGIES)[number];
  */
 export declare const CLEAN_EXTENTS: readonly ["normal", "narrow", "quick"];
 export type CleanExtent = (typeof CLEAN_EXTENTS)[number];
+/**
+ * Build a `CleanParamRequest` (DP 154) stating the three cleaning settings a run uses.
+ *
+ * The message is `{ clean_param: CleanParam }` — field 1 of the request, carrying the same `CleanParam`
+ * this module decodes out of field 1 of the reports it receives, so the shape a write sends is the
+ * shape a read has already been proven against on live hardware.
+ *
+ * All three settings are stated together because one message carries all three: a write naming fewer
+ * would be a `CleanParam` with the rest silent, and what a robot does with a half-stated one is not
+ * something this SDK has observed. `clean_times`(7) is never written — the vendor's own field comment
+ * makes zero mean "not stated", so omitting it leaves the robot's configured pass count alone — and
+ * neither is `fan`(6), which belongs to the suction capability's own data point.
+ *
+ * {@link VACUUM_CLEAN_MEMBERS.setCleanParam} dispatches this.
+ * @internal
+ */
+export declare function encodeCleanParam(cleanType: VacuumCleanType, cleanExtent: CleanExtent, mopLevel: MopLevel): string;
 /**
  * Read one setting out of the CONFIGURED `CleanParam` (DP 154), by its field number.
  *
@@ -1963,6 +1980,48 @@ export declare const VACUUM_CLEAN_MEMBERS: {
     readonly startScene: import("./members.js").MethodMember<(sceneId: number) => Promise<void>> & {
         available: (ctx: import("./types.js").CommandContext) => boolean;
     };
+    /**
+     * State the cleaning settings a run uses — `CleanParamRequest.clean_param` over DP 154.
+     *
+     * The write counterpart of {@link VACUUM_CLEAN_MEMBERS.cleanType},
+     * {@link VACUUM_CLEAN_MEMBERS.cleanExtent} and {@link VACUUM_CLEAN_MEMBERS.mopLevel}: one message
+     * carries all three, so they are set together rather than through three setters that would each send
+     * the same message with the other two silent.
+     *
+     * **The evidence, and its limit.** The frame is field 1 of `CleanParamRequest`, which carries the
+     * very `CleanParam` this module decodes out of field 1 of the reports a live T2351 sends — the
+     * field numbers, the single-field wrappers and the `mop_mode.level` scale are all read off that
+     * capture, and `encodeCleanParam` writes what `decodeCleanParamValue` reads. What is NOT captured is
+     * the write direction itself. It ships as a method rather than an unverified write because the
+     * hazard that rule answers does not arise here: DP 154 is the robot's own settings report, so a frame
+     * it does not accept leaves those three reads unchanged, where a wrong fire-and-forget command would
+     * look exactly like success.
+     *
+     * Suction is not here. It has its own data point and its own capability — a `fan` field exists in
+     * this message and is deliberately not written, for the same reason it is not read.
+     */
+    readonly setCleanParam: {
+        readonly method: (deps: import("./members.js").MemberDeps) => (cleanType: VacuumCleanType, cleanExtent: CleanExtent, mopLevel: MopLevel) => Promise<void>;
+        readonly description: string;
+        readonly available: ((ctx: import("./types.js").CommandContext) => boolean) & ((ctx: import("./types.js").CommandContext) => boolean);
+        readonly answers?: true;
+        readonly args: readonly [{
+            readonly name: "cleanType";
+            readonly kind: "enum";
+            readonly values: readonly ["sweep", "mop", "sweepAndMop", "sweepThenMop"];
+            readonly description: "What the robot does with a surface.";
+        }, {
+            readonly name: "cleanExtent";
+            readonly kind: "enum";
+            readonly values: readonly ["normal", "narrow", "quick"];
+            readonly description: "How far past the mapped edge a job reaches. Wire order, not app order.";
+        }, {
+            readonly name: "mopLevel";
+            readonly kind: "enum";
+            readonly values: readonly ["low", "middle", "high"];
+            readonly description: "How much water the mop lays down. Only meaningful for a clean type that mops.";
+        }];
+    };
     /**
      * Clean the named rooms of a named map (ModeCtrlRequest method 1 over DP 152).
      *

package/dist/model/classify.d.ts

@@ -55,7 +55,9 @@ export declare function codecForType(deviceType: number): Codec | undefined;
  *    EXCEPT `T8520`-prefixed which can be lock variants — still lock.
  *  - `T74xx` → **lock** (SmartSafe 7400-series).
  *  - `T80xx` / `T8001` / `T8002` / `T8010` / `T8030` / `T8023` / `T8025` → **station**
- *    (HomeBase / HomeBase 2 / 3 / Mini), and `T8N00` (NVR) / `T8E00` (PoE NVR) → station.
+ *    (HomeBase / HomeBase 2 / 3 / Mini), `T9000` (the app's own model registry files it as family
+ *    `STATION_9000`, the one station family outside the T8 band), and `T8N00` (NVR) / `T8E00` (PoE
+ *    NVR) → station.
  *  - `T89xx` (entry/motion/water/siren sensors, e.g. T8900/T8910/T8920) → **sensor**.
  *  - `T87xx` keypad (`T8960`) → **keypad**.
  *  - any other `T8…` security T-code → **camera** (the default security family).

package/dist/model/device-family.d.ts

@@ -27,7 +27,8 @@ export declare const WALL_LIGHT_TYPES: ReadonlySet<number>;
  * they own the hub-audio surface (alarm / voice-prompt volume). A deliberate SUBSET of the `station`
  * codec that EXCLUDES the NVRs (S4 Max, PoE NVR): those resolve to `station` for arming/storage but
  * have no speaker, so they must NOT expose the hub-audio controls (they'd fire at nothing). The
- * alarm/prompt wire is verified on HomeBase 3 (HB3); the other hubs share the hub hardware.
+ * alarm/prompt wire is verified on HomeBase 3 (HB3); the other hubs, T9000 (`STATION_9000`) included,
+ * share the hub hardware.
  */
 export declare const HOMEBASE_TYPES: ReadonlySet<number>;
 /** Indoor camera (any indoor variant). */

package/dist/model/device-types.d.ts

@@ -42,6 +42,7 @@ export declare const DeviceType: {
     readonly PROFESSIONAL_247: 24;
     readonly MINIBASE_CHIME: 25;
     readonly CAMERA3_PRO: 26;
+    readonly STATION_9000: 27;
     readonly HOMEBASE_MINI: 28;
     readonly INDOOR_CAMERA: 30;
     readonly INDOOR_PT_CAMERA: 31;

package/dist/model/device.d.ts

@@ -62,6 +62,11 @@ export declare class Device {
      * different wire ids across device families still resolves to one named value.
      */
     private specByParam;
+    /**
+     * Params a resolved capability declares that this device's schema does not carry — withheld by a
+     * member's gate, so not named from the param dictionary either. See {@link Device.applyParams}.
+     */
+    private withheld;
     /** Which param namespace this device's ids live in (clean DPs vs security P2P). */
     private namespace;
     /** The record's `device_name` as stated, before the {@link modelName} fallback is applied. */
@@ -201,6 +206,16 @@ export declare class Device {
      * Apply a raw param map (cloud record or P2P notification). Known params update their named
      * property; unrecognised params are retained as `unknown_<paramType>` so nothing is lost.
      *
+     * Naming precedence: this device's own `PropertySpec` (curated), then the param dictionary for its
+     * namespace, then the `unknown_<paramType>` passthrough. The dictionary def is consulted even where a
+     * spec exists, because `encoding` lives there.
+     *
+     * A param a resolved capability's gate WITHHELD takes the passthrough instead of its dictionary name.
+     * The gate decided the read does not describe this device, the dictionary names it what the member
+     * would have, and republishing it there hands a caller a reading indistinguishable from one the device
+     * really answered. A capability that never resolved withholds nothing: a param arriving before its
+     * capability is still the device's own, and keeps its dictionary name.
+     *
      * @param params param_type → raw value.
      * @param ts observation time (epoch ms); defaults to `Date.now()`.
      * @returns the list of property names whose value changed.

package/dist/model/index.d.ts

@@ -30,3 +30,8 @@ export * from "./capabilities/index.js";
  */
 export type { FamilyContext } from "./device-family.js";
 export { CusPushEvent, CusPushAlarmType, CusPushMode, DoorbellPushEvent, IndoorPushEvent, HB3PairedDevicePushEvent, LockPushEvent, SmartDropPushEvent, NotificationStyle, detectionName, } from "./push-events.js";
+export { SolixDevice, discoverSolixDevices, solarbankSceneReadings, type SolixDeviceReader, type SolixDeviceRecord, type SolixIdentity, type SolixConnectivity, type SolixEnergyMeter, type SolixDeviceOptions, } from "./solix-device.js";
+export { SOLIX_ENERGY_METER_MEMBERS, type SolixCapability, type SolixEnergyMeterReads } from "./capabilities/solix.js";
+export { buildModelIndex, type SolixProduct, type SolixProductCategory } from "./solix-catalog.js";
+export { solixProductFamily, isSolixPowerStation, isSolixSolarbank, isSolixSmartMeter, type SolixProductFamily, type SolixFamilyInput, } from "./solix-family.js";
+export { SolixSite, discoverSolixSites, type SolixSiteReader, type SolixSiteOptions } from "./solix-site.js";

package/dist/model/solix-catalog.d.ts

@@ -0,0 +1,25 @@
+/**
+ * Anker Solix product catalog — the vendor's pairable-product registry (categories → products),
+ * used to label a discovered device's model code with a marketing name + category.
+ *
+ * This is model-layer vocabulary: pure data shapes + a lookup builder, with no wire/transport
+ * dependency. The catalog itself is fetched from the cloud by the client layer (`SolixClient`), which
+ * feeds it here via {@link buildModelIndex}; keeping the shapes and the index in the model layer lets
+ * `SolixDevice` resolve a name/category without reaching across the capability↔transport boundary.
+ */
+export type { SolixProduct, SolixProductCategory } from "../core/solix-types.js";
+import type { SolixProductCategory } from "../core/solix-types.js";
+/**
+ * Flatten a product catalog into a `product_code → { name, category }` lookup for labelling
+ * discovered devices. Every variant code in `p_codes` maps to its parent product too, so a device
+ * reporting a sub-model resolves to the same marketing name.
+ *
+ * The category name is trimmed here, at ingest — the live catalog returns some names with trailing
+ * whitespace (e.g. `"Plug-in Home Battery "`), and normalising once at the source means every consumer
+ * (a device's `identity().category`, `detectSolixCapabilities`, and any exact-match category test) sees
+ * the clean name, rather than each call site having to remember to trim.
+ */
+export declare function buildModelIndex(categories: SolixProductCategory[]): Map<string, {
+    name: string;
+    category: string;
+}>;

package/dist/model/solix-device.d.ts

@@ -0,0 +1,137 @@
+import { type SolixCapability, type SolixEnergyMeterReads } from "./capabilities/solix.js";
+import { type SolixProductFamily } from "./solix-family.js";
+import type { SolixDeviceRecord, SolixProductCategory, SolixSiteScene } from "../core/solix-types.js";
+/**
+ * The device record shape, re-exported from the model surface. It lives in `core/solix-types` so the
+ * transport client can return it without crossing the transport↔model line.
+ */
+export type { SolixDeviceRecord } from "../core/solix-types.js";
+export interface SolixIdentity {
+    serial: string;
+    productCode: string;
+    /** Friendly name — the catalog marketing name if resolvable, else the record's alias/name. */
+    name: string;
+    /** Anker catalog category (e.g. "Accessory", "Portable Power Station"), if resolvable. */
+    category?: string;
+    /**
+     * Normalized product family — the "what kind of thing is this" answer (power station, Solarbank,
+     * smart meter, …), decorrelated from the marketing `category` string. See {@link SolixDevice.family}.
+     */
+    family: SolixProductFamily;
+}
+export interface SolixConnectivity {
+    online: boolean;
+    rssi?: number;
+    ssid?: string;
+}
+/**
+ * The `dev.energyMeter()` handle: the members-derived reads ({@link SolixEnergyMeterReads} —
+ * `meterVoltageL1` is present only once a frame carrying its tag has landed). Every not-yet-named meter
+ * quantity is read from {@link SolixDevice.telemetry} under its `channel_<hex tag>` key instead, which a
+ * static members table cannot enumerate.
+ */
+export type SolixEnergyMeter = SolixEnergyMeterReads;
+/** Options for {@link SolixDevice}. */
+export interface SolixDeviceOptions {
+    /** Catalog categories (from `SolixClient.getProductCatalog()`) — used to resolve name + category. */
+    catalog?: SolixProductCategory[];
+}
+/**
+ * A discovered Solix device with resolved category + capabilities. Feed live telemetry with
+ * {@link applyReading} (from {@link SolixMqtt}'s `reading` events) to populate value accessors.
+ */
+export declare class SolixDevice {
+    readonly serial: string;
+    readonly productCode: string;
+    readonly record: SolixDeviceRecord;
+    private readonly caps;
+    private readonly identity_;
+    private values;
+    constructor(record: SolixDeviceRecord, opts?: SolixDeviceOptions);
+    /**
+     * The device's {@link SolixProductFamily} — the classification a caller branches on to SORT devices
+     * (a site's power stations vs its meters), the Solix analogue of eufy's `isHomeBase()`. Distinct from
+     * {@link has}, which answers what the device can DO; family answers what KIND of device it is.
+     */
+    get family(): SolixProductFamily;
+    /** All capabilities this device carries. */
+    get capabilities(): SolixCapability[];
+    /** Whether the device carries a capability — the only correct way to branch on behaviour. */
+    has(capability: SolixCapability): boolean;
+    /**
+     * Merge a live telemetry reading (a `SolixMqtt` `reading` event) so accessors reflect it. Takes the
+     * WHOLE reading, not just its values, and drops one addressed to a different device: the documented
+     * wiring is `mqtt.on("reading", r => device.applyReading(r))`, and one MQTT stream carries every
+     * watched meter on the account — so without this filter two meters would cross-feed each other's floats.
+     * A reading with no `deviceSn` (a hand-built one) is accepted as-is.
+     */
+    applyReading(reading: {
+        deviceSn?: string;
+        values: Record<string, number>;
+    }): void;
+    /** All decoded float telemetry channels from the latest applied reading (raw, `channel_<tag>` keys). */
+    telemetry(): Record<string, number>;
+    identity(): SolixIdentity;
+    firmware(): {
+        version: string;
+    } | undefined;
+    connectivity(): SolixConnectivity | undefined;
+    /**
+     * The members-derived `energyMeter` reads, or `undefined` when the device has no meter. Each getter is
+     * installed only for a tag this device has actually reported, and reads `this.values` LIVE — a handle
+     * held across an {@link applyReading} reflects the newer values. Getter INSTALLATION is fixed at the
+     * time of this call, so re-call it to pick up a tag first seen since.
+     */
+    energyMeter(): SolixEnergyMeter | undefined;
+    /**
+     * The {@link MemberDeps} the members engine needs: a read closure over the live values store, and the
+     * evidence gate (`ctx.paramIds`) rebuilt from the ff09 tags this device has reported. No `codec` — the
+     * codecs are eufy transport families and a Solix device belongs to none of them. The sink is a no-op:
+     * Solix telemetry is read-only, no member here dispatches a command.
+     */
+    private meterDeps;
+    /** The ff09 tags this device has reported, derived from the decoder's `channel_<hex>` keys. */
+    private seenTags;
+}
+/**
+ * The minimum a client must offer to be discovered against — the two wire reads {@link discoverSolixDevices}
+ * composes. Typed STRUCTURALLY (not as `SolixClient`) so the model layer never imports the transport
+ * client: the hard `transport ⊥ model` rule forbids it, and a structural shape needs no import.
+ */
+export interface SolixDeviceReader {
+    getDevices(): Promise<SolixDeviceRecord[]>;
+    getProductCatalog(): Promise<SolixProductCategory[]>;
+}
+/**
+ * Resolve the product catalog for a discovery: a caller-supplied `opts.catalog` short-circuits the wire
+ * read, and a failed `getProductCatalog()` degrades to no categories (names/families just go unresolved,
+ * never a thrown discovery). Shared by {@link discoverSolixDevices} and `discoverSolixSites` so that
+ * "a failed catalog is non-fatal" decision lives in exactly one place.
+ */
+export declare function resolveSolixCatalog(client: SolixDeviceReader, opts: {
+    catalog?: SolixProductCategory[];
+}): Promise<SolixProductCategory[]>;
+/**
+ * Discover an account's Solix devices as capability-driven {@link SolixDevice} objects — the wire+model
+ * composition (a transport read + the product catalog) that used to be `SolixClient.discoverDevices()`.
+ * It lives in the model layer because it builds `SolixDevice`; the wire client (now `transport/http`)
+ * cannot, and passing it structurally keeps the layers decorrelated. Feed live telemetry to each result
+ * via `SolixDevice.applyReading`.
+ */
+export declare function discoverSolixDevices(client: SolixDeviceReader, opts?: {
+    catalog?: SolixProductCategory[];
+}): Promise<SolixDevice[]>;
+/**
+ * Reduce a site "scene" snapshot to per-device telemetry readings — the BACKSTOP counterpart to the
+ * realtime `ff09` decode. It emits the fields the scene reliably carries that the fast MQTT frame does
+ * NOT: `batteryTemperature` (the realtime frame's BMS blob is empty, so `solixReadings` withholds it),
+ * `batterySoc` (a cross-check/seed for the `0xa3` SOC), and `expansionPacks` — the count of ATTACHED
+ * add-on battery packs (0 on a standalone main unit). Each reading is shaped exactly like a `SolixMqtt`
+ * `reading` event — `{ deviceSn, values }` — so a caller can feed it straight into
+ * {@link SolixDevice.applyReading} and broadcast it on the same path as a live frame. Entries with no
+ * usable value are dropped.
+ */
+export declare function solarbankSceneReadings(scene: SolixSiteScene): {
+    deviceSn: string;
+    values: Record<string, number>;
+}[];

package/dist/model/solix-family.d.ts

@@ -0,0 +1,31 @@
+/**
+ * A Solix device's product family — the normalized "what kind of thing is this" answer, decorrelated
+ * from the Anker catalog's marketing category strings. `unknown` when neither the product code nor the
+ * category identifies a family (never a guess).
+ */
+export type SolixProductFamily = "powerStation" | "solarbank" | "smartMeter" | "powerBank" | "cooler" | "evCharger" | "charger" | "unknown";
+/** The pure evidence a family decision reads: the product code, and the catalog category when resolved. */
+export interface SolixFamilyInput {
+    /** SKU / model code, e.g. `A1782`, `AE103`, `AE1X0`. */
+    product_code: string;
+    /** Anker catalog category, when a catalog resolved one (e.g. `"Portable Power Station"`). */
+    category?: string;
+}
+/** Grid-tie Solarbank / plug-in home battery family (by product code, catalog-independent). */
+export declare const isSolixSolarbank: (input: SolixFamilyInput) => boolean;
+/** Smart energy meter / grid-CT family (by product code, catalog-independent). */
+export declare const isSolixSmartMeter: (input: SolixFamilyInput) => boolean;
+/** Portable Power Station (SOLIX F-series) family — resolved from the catalog category. */
+export declare const isSolixPowerStation: (input: SolixFamilyInput) => boolean;
+/**
+ * Resolve a Solix device's {@link SolixProductFamily} by consulting the family predicates first (they are
+ * catalog-independent, so a device classifies even before a catalog is fetched), then the catalog
+ * category for the families that have no prefix set yet. Returns `"unknown"` when neither identifies one —
+ * never a guess, mirroring `device-family.ts` returning `false` on an unknown device type.
+ *
+ * The meter is checked before the Solarbank: both can present a battery-ish catalog category, but the
+ * meter's `AE1X0` prefix is unambiguous and a meter is never a Solarbank. The Solarbank case reuses
+ * {@link isSolixSolarbank} (prefix OR the home-battery category) rather than re-testing the prefix here,
+ * so the two never drift.
+ */
+export declare function solixProductFamily(input: SolixFamilyInput): SolixProductFamily;

package/dist/model/solix-site.d.ts

@@ -0,0 +1,70 @@
+/**
+ * A capability-driven model for an Anker Solix **site** — the account's home energy system, the "My
+ * Home" the app shows. A site is the Solix analogue of a eufy HomeBase in its GROUPING role: it is the
+ * system that member devices belong to, so it is what a caller reaches for to ask "what's in this
+ * system" and to sort the members by family ({@link SolixSite.powerStations} / {@link solarbanks} /
+ * {@link smartMeters}) or by capability ({@link SolixSite.withCapability}).
+ *
+ * A site is a *grouping*, not a device: it carries no telemetry of its own. Its members are full
+ * {@link SolixDevice} models (each with its own capabilities + live telemetry), resolved by
+ * {@link discoverSolixSites} from the site record's member list joined to the account's device records.
+ * The realtime SYSTEM aggregate the app draws (instantaneous battery SoC + solar + grid flow) is not
+ * modelled here: it has no confirmed, stable read surface for the current device generation, and this
+ * layer does not fabricate a getter for a value it cannot ground — a caller reads each member device's
+ * telemetry instead.
+ */
+import { SolixDevice, type SolixDeviceReader } from "./solix-device.js";
+import type { SolixProductFamily } from "./solix-family.js";
+import type { SolixCapability } from "./capabilities/solix.js";
+import type { SolixProductCategory, SolixSiteRecord } from "../core/solix-types.js";
+/**
+ * The minimum a client must offer to discover an account's SITES against — {@link SolixDeviceReader}
+ * (the device + catalog reads {@link discoverSolixDevices} already composes) plus the site read.
+ * Structural (not `SolixClient`) so the model layer never imports the transport client: the hard
+ * `transport ⊥ model` rule forbids it, and a structural shape needs no import.
+ */
+export interface SolixSiteReader extends SolixDeviceReader {
+    getSites(): Promise<SolixSiteRecord[]>;
+}
+/** Options for {@link SolixSite} / {@link discoverSolixSites} — the same catalog the device model takes. */
+export interface SolixSiteOptions {
+    catalog?: SolixProductCategory[];
+}
+/**
+ * A discovered Solix site with its member devices resolved to {@link SolixDevice} models. Build one
+ * directly from a record + members, or discover an account's sites with {@link discoverSolixSites}.
+ */
+export declare class SolixSite {
+    readonly id: string;
+    /** Friendly site name (e.g. "My Home"), or the site id when the record carries none. */
+    readonly name: string;
+    /** Anker's site-type discriminator (e.g. 20 for a Solarbank-anchored home system), when present. */
+    readonly powerSiteType?: number;
+    readonly record: SolixSiteRecord;
+    readonly devices: SolixDevice[];
+    constructor(record: SolixSiteRecord, devices: SolixDevice[]);
+    /** The member device with this serial, if it belongs to the site. */
+    device(serial: string): SolixDevice | undefined;
+    /** Member devices of a given product {@link SolixProductFamily} — the grouping accessor. */
+    withFamily(family: SolixProductFamily): SolixDevice[];
+    /** Member devices that carry a given capability (e.g. every `battery` in the system). */
+    withCapability(capability: SolixCapability): SolixDevice[];
+    /** The Solarbank / plug-in home-battery members of the system. */
+    solarbanks(): SolixDevice[];
+    /** The smart-meter (grid-CT) members of the system. */
+    smartMeters(): SolixDevice[];
+    /** The portable power-station members of the system. */
+    powerStations(): SolixDevice[];
+}
+/**
+ * Discover an account's Solix sites as {@link SolixSite} groupings of capability-driven
+ * {@link SolixDevice} members — the site analogue of {@link discoverSolixDevices}. Composes three wire
+ * reads (the sites, the account's device records, the product catalog) entirely model-side, so the
+ * transport client is passed structurally and the layers stay decorrelated.
+ *
+ * A site member is resolved to its FULL device record from `getDevices()` when the account lists one
+ * (so the member carries firmware/connectivity + telemetry identity); a member the flat device list
+ * omits is built from the site entry alone (serial + product code + name), so the system is never
+ * missing a device it declares.
+ */
+export declare function discoverSolixSites(client: SolixSiteReader, opts?: SolixSiteOptions): Promise<SolixSite[]>;

package/dist/transport/ff09.d.ts

@@ -397,6 +397,13 @@ export interface Ff09SettingsResponse {
  * padding past the last real field.
  */
 export declare function parseFf09SettingsResponse(plain: Buffer): Ff09SettingsResponse;
+/**
+ * Walk a bounded `tag|len|value` TLV region into a `tag → bytes` map. Stops at a `0x00` tag (only ever
+ * trailing zero-padding, never a real field — real tags start at `0xa1`) and refuses a field whose
+ * declared length would overrun `end`, so a corrupt length can't read past the region (e.g. into a
+ * trailing checksum). Shared by {@link parseFf09SettingsResponse} and the Solix param decoder.
+ */
+export declare function walkFf09Tlv(buf: Buffer, start: number, end: number): Map<number, Buffer>;
 /** Read a little-endian u16 out of a TLV field buffer (throws on a missing/short field — a caller-side bug, not a wire ambiguity). */
 export declare function readFf09U16LE(field: Buffer | undefined, name: string): number;
 /** Read a single byte out of a TLV field buffer (throws on a missing field — same convention as {@link readFf09U16LE}). */

package/dist/transport/http/decodeImageV2.d.ts

@@ -1,19 +1,13 @@
-/**
- * Per-channel auto-contrast, a byte-exact port of PIL `ImageOps.autocontrast` (cutoff 0.5%). The lost
- * quant tables leave the reconstruction low-contrast ("foggy"); stretching each channel's clipped range
- * to full scale restores a natural-looking image. Mutates `data` (RGBA) in place.
- *
- * Parity notes vs PIL: the cutoff count is `n * cutoff // 100` (integer floor); it is trimmed off each
- * end by zeroing whole histogram bins until the count is spent; the range is then the first/last
- * non-empty bins; and the LUT truncates toward zero (`int()`), NOT rounds — rounding would shift pixels.
- */
-export declare function autoContrast(data: Uint8Array, width: number, height: number, cutoff?: number): void;
 /** True if the blob is a v2 `v2_eufysecurity:` push thumbnail. */
 export declare function isV2Image(data: Buffer): boolean;
 /**
- * Decode a v2 blob to a plain JPEG buffer by reconstructing its header, or null if it isn't v2 or the
- * plaintext scan can't be located. The search first chooses subsampling and coarse geometry, derives
- * the fixed MCU count, refines width by row shear, and pins the exact fill height before applying
- * auto-contrast and re-encoding. See the module doc for the keyless-splice rationale.
+ * Decode a v2 blob to a plain JPEG buffer by reconstructing its header, or null if it isn't v2, the
+ * plaintext scan can't be located, or no frame shape explains it.
+ *
+ * Three steps and no pixel rewrite: the frame shape is read out of the entropy scan,
+ * one probe decode both proves the spliced JPEG decodes and measures how far the substitute quant
+ * tables fall short of the camera's, and the answer is the same tail under a header carrying the
+ * corrected tables. See the module doc for the keyless-splice rationale and for why neither the search
+ * nor the correction decodes candidate frames or re-encodes the picture.
  */
 export declare function decodeImageV2(data: Buffer): Buffer | null;

package/dist/transport/http/index.d.ts

@@ -3,3 +3,4 @@ export { randomPhoneModel, randomUserAgent } from "./phone-model.js";
 export * from "./decodeImageV1.js";
 export * from "./decodeImageV2.js";
 export { listLightEffects, listAiSceneRecommendations, type LightEffectSummary } from "./light-catalog.js";
+export { SolixClient, type SolixClientOptions, type SolixLoginResult, type SolixSession, type SolixPersisted, type SolixSessionStore, } from "./solix-client.js";

package/dist/transport/http/jpeg-scan.d.ts

@@ -0,0 +1,59 @@
+/**
+ * A baseline-JPEG entropy scanner that decodes no pixels.
+ *
+ * The v2 thumbnail decoder next door has to discover a frame geometry its blob does not state, and the
+ * only evidence is the plaintext entropy-coded scan: how many MCUs it carries, and whether it carries
+ * them under a given chroma subsampling. A JPEG decoder answers that — it throws on a frame the scan
+ * does not fill — and charges a full set of component and output buffers for each question.
+ *
+ * That bill is fatal for a caller under a hard memory cap. Each `jpeg-js` decode churns roughly a
+ * megabyte of typed arrays, glibc keeps the arenas rather than handing them back, and a search asking
+ * the question of every candidate geometry costs tens of megabytes per thumbnail — permanently, and
+ * more than an embedded host gives an app in total.
+ *
+ * This module asks the same question by walking the Huffman-coded coefficients and throwing them away:
+ * no IDCT, no component planes, no output image. What it keeps is one number per MCU — the DC
+ * coefficient of its luma block(s), i.e. that block's average brightness — which is all the geometry
+ * search needs to tell a sheared row apart from a continuous one. Allocation is a single `Int32Array`
+ * of MCU count, and the walk is linear in the scan's length.
+ *
+ * Baseline sequential only (SOF0), which is what the v2 tail is: no progressive refinement, no
+ * arithmetic coding. Restart markers are tolerated — the scan resynchronises and resets its DC
+ * predictors, exactly as a decoder would.
+ *
+ * @module transport/http/jpeg-scan
+ */
+/** What the scan carried, under one subsampling hypothesis. */
+export interface EntropyScan {
+    /** Complete MCUs decoded before the data ran out. */
+    mcus: number;
+    /**
+     * Mean luma DC per MCU, in scan order — a thumbnail of the picture at MCU resolution.
+     *
+     * Quantized units (the quant tables are lost with the v2 head), so the values are a scale of their
+     * own. Differences between neighbours are what the geometry search reads, and those survive.
+     */
+    luma: Int32Array;
+    /**
+     * Whether the scan ended where a whole MCU ended, with nothing but the EOI marker left.
+     *
+     * The discriminator between hypotheses: a wrong one reads a block with the wrong Huffman table,
+     * diverges, and either dies mid-MCU or stops with data still ahead of it. Only the subsampling the
+     * encoder used walks the scan to its last byte on an MCU boundary.
+     */
+    complete: boolean;
+}
+/**
+ * Walk the plaintext tail's scan under one subsampling hypothesis.
+ *
+ * `extraTables` carries the DHT segments that are NOT in the tail — for a v2 thumbnail, the standard
+ * luma tables the reconstructed header supplies, since only the chroma ones survive in plaintext.
+ * Returns null when the tail is not a baseline scan at all (no SOS, missing tables).
+ *
+ * The walk stops at the first byte it cannot read as this hypothesis's next block, and the result is
+ * `complete` only when that happened on an MCU boundary with nothing but a marker left. The DC array
+ * grows as the scan turns out to be long rather than being sized from the scan's byte length: a wrong
+ * hypothesis dies after a handful of MCUs, and provisioning three whole-scan arrays to discover that is
+ * the kind of allocation this module exists to avoid.
+ */
+export declare function scanEntropy(tail: Uint8Array, subsampling: number, extraTables: readonly Uint8Array[]): EntropyScan | null;

package/dist/transport/http/media-download.d.ts

@@ -1,7 +1,10 @@
+import type { MediaFailureReason } from "../media-failure.js";
 type ResolveHost = (hostname: string) => Promise<readonly {
     address: string;
     family: number;
 }[]>;
+/** Tag a failure OUTSIDE the transfer itself — the push-image decoder refusing bytes that did arrive. @internal */
+export declare function mediaFailureError(message: string, reason: MediaFailureReason, cause?: unknown): Error;
 /** Signals rejection of the active Eufy session without exposing response content. @internal */
 export declare class MediaDownloadAuthenticationError extends Error {
 }