@enyo-energy/sunspec-sdk 0.0.30 → 0.0.32

package/dist/cjs/sunspec-devices.cjs

@@ -348,6 +348,16 @@ class SunspecBattery extends BaseSunspecDevice {
             const mpptBatteryPowerW = this.extractBatteryPowerFromMPPT(mpptDataList);
             if (batteryData) {
                 const advancedBatteryModel = this.sunspecClient.findModel(801);
+                const batteryBaseModel = this.sunspecClient.findModel(sunspec_interfaces_js_1.SunspecModelId.BatteryBase);
+                // Determine battery power: prefer model 802 w field, then MPPT extraction, then undefined
+                let batteryPowerW;
+                if (batteryBaseModel && (batteryData.chargePower !== undefined || batteryData.dischargePower !== undefined)) {
+                    // Model 802 provides power directly: positive = charge, negative = discharge
+                    batteryPowerW = (batteryData.chargePower || 0) - (batteryData.dischargePower || 0);
+                }
+                else if (!advancedBatteryModel) {
+                    batteryPowerW = mpptBatteryPowerW;
+                }
                 const batteryMessage = {
                     id: (0, node_crypto_1.randomUUID)(),
                     message: enyo_data_bus_value_js_1.EnyoDataBusMessageEnum.BatteryValuesUpdateV1,
@@ -359,7 +369,7 @@ class SunspecBattery extends BaseSunspecDevice {
                     resolution,
                     data: {
                         batterySoC: batteryData.soc || batteryData.chaState || 0,
-                        batteryPowerW: advancedBatteryModel ? undefined : mpptBatteryPowerW,
+                        batteryPowerW,
                         state: this.mapToEnyoBatteryState(batteryData.chaSt),
                     }
                 };
@@ -499,6 +509,21 @@ class SunspecBattery extends BaseSunspecDevice {
         }
         return this.sunspecClient.readBatteryControls();
     }
+    /**
+     * Read full battery base data from Model 802
+     *
+     * Returns the complete Model 802 data structure with all fields,
+     * including nameplate, SoC/health, status, events, voltage, current, and power.
+     *
+     * @returns Promise<SunspecBatteryBaseData | null> - Full model 802 data or null if not available
+     */
+    async readBatteryBaseData() {
+        if (!this.isConnected()) {
+            console.error('Battery not connected');
+            return null;
+        }
+        return this.sunspecClient.readBatteryBaseData();
+    }
     /**
      * Write custom battery control settings
      *

package/dist/cjs/sunspec-devices.d.cts

@@ -1,4 +1,4 @@
-import { type SunspecBatteryControls, SunspecStorageMode } from "./sunspec-interfaces.cjs";
+import { type SunspecBatteryBaseData, type SunspecBatteryControls, SunspecStorageMode } from "./sunspec-interfaces.cjs";
 import { ApplianceManager, EnergyApp } from "@enyo-energy/energy-app-sdk";
 import { EnyoApplianceName } from "@enyo-energy/energy-app-sdk/dist/types/enyo-appliance.js";
 import { EnyoNetworkDevice } from "@enyo-energy/energy-app-sdk/dist/types/enyo-network-device.js";
@@ -130,6 +130,15 @@ export declare class SunspecBattery extends BaseSunspecDevice {
      * @returns Promise<SunspecBatteryControls | null> - Current control settings or null if error
      */
     getBatteryControls(): Promise<SunspecBatteryControls | null>;
+    /**
+     * Read full battery base data from Model 802
+     *
+     * Returns the complete Model 802 data structure with all fields,
+     * including nameplate, SoC/health, status, events, voltage, current, and power.
+     *
+     * @returns Promise<SunspecBatteryBaseData | null> - Full model 802 data or null if not available
+     */
+    readBatteryBaseData(): Promise<SunspecBatteryBaseData | null>;
     /**
      * Write custom battery control settings
      *

package/dist/cjs/sunspec-interfaces.cjs

@@ -3,7 +3,7 @@
  * SunSpec block interfaces with block numbers
  */
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.SunspecStorageMode = exports.SunspecChargeSource = exports.SunspecVArPctMode = exports.SunspecEnableControl = exports.SunspecConnectionControl = exports.SunspecStorageControlMode = exports.SunspecBatteryChargeState = exports.SunspecMPPTOperatingState = exports.SunspecModelId = exports.DEFAULT_RETRY_CONFIG = void 0;
+exports.SunspecStorageMode = exports.SunspecChargeSource = exports.SunspecVArPctMode = exports.SunspecEnableControl = exports.SunspecConnectionControl = exports.SunspecStorageControlMode = exports.SunspecBatteryEvent1 = exports.SunspecBatteryBankState = exports.SunspecBatteryType = exports.SunspecBatteryControlMode = exports.SunspecBatteryChargeState = exports.SunspecMPPTOperatingState = exports.SunspecModelId = exports.DEFAULT_RETRY_CONFIG = void 0;
 exports.DEFAULT_RETRY_CONFIG = {
     initialDelayMs: 1000,
     maxDelayMs: 30000,
@@ -61,6 +61,87 @@ var SunspecBatteryChargeState;
     SunspecBatteryChargeState[SunspecBatteryChargeState["HOLDING"] = 6] = "HOLDING";
     SunspecBatteryChargeState[SunspecBatteryChargeState["TESTING"] = 7] = "TESTING";
 })(SunspecBatteryChargeState || (exports.SunspecBatteryChargeState = SunspecBatteryChargeState = {}));
+/**
+ * Battery Control Mode values for Model 802
+ * Offset 17: LocRemCtl - Local/Remote control mode
+ */
+var SunspecBatteryControlMode;
+(function (SunspecBatteryControlMode) {
+    SunspecBatteryControlMode[SunspecBatteryControlMode["REMOTE"] = 0] = "REMOTE";
+    SunspecBatteryControlMode[SunspecBatteryControlMode["LOCAL"] = 1] = "LOCAL";
+})(SunspecBatteryControlMode || (exports.SunspecBatteryControlMode = SunspecBatteryControlMode = {}));
+/**
+ * Battery Type values for Model 802
+ * Offset 21: Typ - Battery type
+ */
+var SunspecBatteryType;
+(function (SunspecBatteryType) {
+    SunspecBatteryType[SunspecBatteryType["NOT_APPLICABLE_UNKNOWN"] = 0] = "NOT_APPLICABLE_UNKNOWN";
+    SunspecBatteryType[SunspecBatteryType["LEAD_ACID"] = 1] = "LEAD_ACID";
+    SunspecBatteryType[SunspecBatteryType["NICKEL_METAL_HYDRIDE"] = 2] = "NICKEL_METAL_HYDRIDE";
+    SunspecBatteryType[SunspecBatteryType["NICKEL_CADMIUM"] = 3] = "NICKEL_CADMIUM";
+    SunspecBatteryType[SunspecBatteryType["LITHIUM_ION"] = 4] = "LITHIUM_ION";
+    SunspecBatteryType[SunspecBatteryType["CARBON_ZINC"] = 5] = "CARBON_ZINC";
+    SunspecBatteryType[SunspecBatteryType["ZINC_CHLORIDE"] = 6] = "ZINC_CHLORIDE";
+    SunspecBatteryType[SunspecBatteryType["ALKALINE"] = 7] = "ALKALINE";
+    SunspecBatteryType[SunspecBatteryType["RECHARGEABLE_ALKALINE"] = 8] = "RECHARGEABLE_ALKALINE";
+    SunspecBatteryType[SunspecBatteryType["SODIUM_SULFUR"] = 9] = "SODIUM_SULFUR";
+    SunspecBatteryType[SunspecBatteryType["FLOW"] = 10] = "FLOW";
+    SunspecBatteryType[SunspecBatteryType["SUPER_CAPACITOR"] = 11] = "SUPER_CAPACITOR";
+    SunspecBatteryType[SunspecBatteryType["OTHER"] = 99] = "OTHER";
+})(SunspecBatteryType || (exports.SunspecBatteryType = SunspecBatteryType = {}));
+/**
+ * Battery Bank State values for Model 802
+ * Offset 22: State - Battery bank state
+ */
+var SunspecBatteryBankState;
+(function (SunspecBatteryBankState) {
+    SunspecBatteryBankState[SunspecBatteryBankState["DISCONNECTED"] = 1] = "DISCONNECTED";
+    SunspecBatteryBankState[SunspecBatteryBankState["INITIALIZING"] = 2] = "INITIALIZING";
+    SunspecBatteryBankState[SunspecBatteryBankState["CONNECTED"] = 3] = "CONNECTED";
+    SunspecBatteryBankState[SunspecBatteryBankState["STANDBY"] = 4] = "STANDBY";
+    SunspecBatteryBankState[SunspecBatteryBankState["SOC_PROTECTION"] = 5] = "SOC_PROTECTION";
+    SunspecBatteryBankState[SunspecBatteryBankState["SUSPENDING"] = 6] = "SUSPENDING";
+    SunspecBatteryBankState[SunspecBatteryBankState["FAULT"] = 99] = "FAULT";
+})(SunspecBatteryBankState || (exports.SunspecBatteryBankState = SunspecBatteryBankState = {}));
+/**
+ * Battery Event 1 bit positions for Model 802
+ * Offset 26-27: Evt1 - Battery event bitfield
+ */
+var SunspecBatteryEvent1;
+(function (SunspecBatteryEvent1) {
+    SunspecBatteryEvent1[SunspecBatteryEvent1["COMMUNICATION_ERROR"] = 0] = "COMMUNICATION_ERROR";
+    SunspecBatteryEvent1[SunspecBatteryEvent1["OVER_TEMP_ALARM"] = 1] = "OVER_TEMP_ALARM";
+    SunspecBatteryEvent1[SunspecBatteryEvent1["OVER_TEMP_WARNING"] = 2] = "OVER_TEMP_WARNING";
+    SunspecBatteryEvent1[SunspecBatteryEvent1["UNDER_TEMP_ALARM"] = 3] = "UNDER_TEMP_ALARM";
+    SunspecBatteryEvent1[SunspecBatteryEvent1["UNDER_TEMP_WARNING"] = 4] = "UNDER_TEMP_WARNING";
+    SunspecBatteryEvent1[SunspecBatteryEvent1["OVER_CHARGE_CURRENT_ALARM"] = 5] = "OVER_CHARGE_CURRENT_ALARM";
+    SunspecBatteryEvent1[SunspecBatteryEvent1["OVER_CHARGE_CURRENT_WARNING"] = 6] = "OVER_CHARGE_CURRENT_WARNING";
+    SunspecBatteryEvent1[SunspecBatteryEvent1["OVER_DISCHARGE_CURRENT_ALARM"] = 7] = "OVER_DISCHARGE_CURRENT_ALARM";
+    SunspecBatteryEvent1[SunspecBatteryEvent1["OVER_DISCHARGE_CURRENT_WARNING"] = 8] = "OVER_DISCHARGE_CURRENT_WARNING";
+    SunspecBatteryEvent1[SunspecBatteryEvent1["OVER_VOLT_ALARM"] = 9] = "OVER_VOLT_ALARM";
+    SunspecBatteryEvent1[SunspecBatteryEvent1["OVER_VOLT_WARNING"] = 10] = "OVER_VOLT_WARNING";
+    SunspecBatteryEvent1[SunspecBatteryEvent1["UNDER_VOLT_ALARM"] = 11] = "UNDER_VOLT_ALARM";
+    SunspecBatteryEvent1[SunspecBatteryEvent1["UNDER_VOLT_WARNING"] = 12] = "UNDER_VOLT_WARNING";
+    SunspecBatteryEvent1[SunspecBatteryEvent1["UNDER_SOC_MIN_ALARM"] = 13] = "UNDER_SOC_MIN_ALARM";
+    SunspecBatteryEvent1[SunspecBatteryEvent1["UNDER_SOC_MIN_WARNING"] = 14] = "UNDER_SOC_MIN_WARNING";
+    SunspecBatteryEvent1[SunspecBatteryEvent1["OVER_SOC_MAX_ALARM"] = 15] = "OVER_SOC_MAX_ALARM";
+    SunspecBatteryEvent1[SunspecBatteryEvent1["OVER_SOC_MAX_WARNING"] = 16] = "OVER_SOC_MAX_WARNING";
+    SunspecBatteryEvent1[SunspecBatteryEvent1["VOLTAGE_IMBALANCE_WARNING"] = 17] = "VOLTAGE_IMBALANCE_WARNING";
+    SunspecBatteryEvent1[SunspecBatteryEvent1["TEMPERATURE_IMBALANCE_ALARM"] = 18] = "TEMPERATURE_IMBALANCE_ALARM";
+    SunspecBatteryEvent1[SunspecBatteryEvent1["TEMPERATURE_IMBALANCE_WARNING"] = 19] = "TEMPERATURE_IMBALANCE_WARNING";
+    SunspecBatteryEvent1[SunspecBatteryEvent1["CONTACTOR_ERROR"] = 20] = "CONTACTOR_ERROR";
+    SunspecBatteryEvent1[SunspecBatteryEvent1["FAN_ERROR"] = 21] = "FAN_ERROR";
+    SunspecBatteryEvent1[SunspecBatteryEvent1["FUSE_ERROR"] = 22] = "FUSE_ERROR";
+    SunspecBatteryEvent1[SunspecBatteryEvent1["GROUND_FAULT"] = 23] = "GROUND_FAULT";
+    SunspecBatteryEvent1[SunspecBatteryEvent1["OPEN_DOOR_ERROR"] = 24] = "OPEN_DOOR_ERROR";
+    SunspecBatteryEvent1[SunspecBatteryEvent1["CURRENT_IMBALANCE_WARNING"] = 25] = "CURRENT_IMBALANCE_WARNING";
+    SunspecBatteryEvent1[SunspecBatteryEvent1["OTHER_ALARM"] = 26] = "OTHER_ALARM";
+    SunspecBatteryEvent1[SunspecBatteryEvent1["OTHER_WARNING"] = 27] = "OTHER_WARNING";
+    SunspecBatteryEvent1[SunspecBatteryEvent1["RESERVED_1"] = 28] = "RESERVED_1";
+    SunspecBatteryEvent1[SunspecBatteryEvent1["CONFIGURATION_ALARM"] = 29] = "CONFIGURATION_ALARM";
+    SunspecBatteryEvent1[SunspecBatteryEvent1["CONFIGURATION_WARNING"] = 30] = "CONFIGURATION_WARNING";
+})(SunspecBatteryEvent1 || (exports.SunspecBatteryEvent1 = SunspecBatteryEvent1 = {}));
 /**
  * Storage Control Mode bitfield values for Model 124
  *

package/dist/cjs/sunspec-interfaces.d.cts

@@ -178,6 +178,83 @@ export declare enum SunspecBatteryChargeState {
     HOLDING = 6,
     TESTING = 7
 }
+/**
+ * Battery Control Mode values for Model 802
+ * Offset 17: LocRemCtl - Local/Remote control mode
+ */
+export declare enum SunspecBatteryControlMode {
+    REMOTE = 0,
+    LOCAL = 1
+}
+/**
+ * Battery Type values for Model 802
+ * Offset 21: Typ - Battery type
+ */
+export declare enum SunspecBatteryType {
+    NOT_APPLICABLE_UNKNOWN = 0,
+    LEAD_ACID = 1,
+    NICKEL_METAL_HYDRIDE = 2,
+    NICKEL_CADMIUM = 3,
+    LITHIUM_ION = 4,
+    CARBON_ZINC = 5,
+    ZINC_CHLORIDE = 6,
+    ALKALINE = 7,
+    RECHARGEABLE_ALKALINE = 8,
+    SODIUM_SULFUR = 9,
+    FLOW = 10,
+    SUPER_CAPACITOR = 11,
+    OTHER = 99
+}
+/**
+ * Battery Bank State values for Model 802
+ * Offset 22: State - Battery bank state
+ */
+export declare enum SunspecBatteryBankState {
+    DISCONNECTED = 1,
+    INITIALIZING = 2,
+    CONNECTED = 3,
+    STANDBY = 4,
+    SOC_PROTECTION = 5,
+    SUSPENDING = 6,
+    FAULT = 99
+}
+/**
+ * Battery Event 1 bit positions for Model 802
+ * Offset 26-27: Evt1 - Battery event bitfield
+ */
+export declare enum SunspecBatteryEvent1 {
+    COMMUNICATION_ERROR = 0,
+    OVER_TEMP_ALARM = 1,
+    OVER_TEMP_WARNING = 2,
+    UNDER_TEMP_ALARM = 3,
+    UNDER_TEMP_WARNING = 4,
+    OVER_CHARGE_CURRENT_ALARM = 5,
+    OVER_CHARGE_CURRENT_WARNING = 6,
+    OVER_DISCHARGE_CURRENT_ALARM = 7,
+    OVER_DISCHARGE_CURRENT_WARNING = 8,
+    OVER_VOLT_ALARM = 9,
+    OVER_VOLT_WARNING = 10,
+    UNDER_VOLT_ALARM = 11,
+    UNDER_VOLT_WARNING = 12,
+    UNDER_SOC_MIN_ALARM = 13,
+    UNDER_SOC_MIN_WARNING = 14,
+    OVER_SOC_MAX_ALARM = 15,
+    OVER_SOC_MAX_WARNING = 16,
+    VOLTAGE_IMBALANCE_WARNING = 17,
+    TEMPERATURE_IMBALANCE_ALARM = 18,
+    TEMPERATURE_IMBALANCE_WARNING = 19,
+    CONTACTOR_ERROR = 20,
+    FAN_ERROR = 21,
+    FUSE_ERROR = 22,
+    GROUND_FAULT = 23,
+    OPEN_DOOR_ERROR = 24,
+    CURRENT_IMBALANCE_WARNING = 25,
+    OTHER_ALARM = 26,
+    OTHER_WARNING = 27,
+    RESERVED_1 = 28,
+    CONFIGURATION_ALARM = 29,
+    CONFIGURATION_WARNING = 30
+}
 /**
  * Storage Control Mode bitfield values for Model 124
  *
@@ -247,6 +324,102 @@ export interface SunspecBatteryData extends SunspecBlock {
     temperature?: number;
     status?: number;
 }
+/**
+ * Battery Base data structure based on Model 802 (Battery Base Model)
+ *
+ * SunSpec Model 802 Register Map (offsets relative to model start):
+ * - 0-1: ID and Length
+ * - 2: AHRtg - Nameplate charge capacity (AH) (uint16)
+ * - 3: WHRtg - Nameplate energy capacity (WH) (uint16)
+ * - 4: WChaRteMax - Maximum rate of charge (W) (uint16)
+ * - 5: WDisChaRteMax - Maximum rate of discharge (W) (uint16)
+ * - 6: DisChaRte - Self discharge rate (%) (uint16)
+ * - 7: SoCMax - Maximum state of charge (%) (uint16)
+ * - 8: SoCMin - Minimum state of charge (%) (uint16)
+ * - 9: SoCRsvMax - Maximum reserve SOC (%) (uint16)
+ * - 10: SoCRsvMin - Minimum reserve SOC (%) (uint16)
+ * - 11: SoC - State of charge (%) (uint16)
+ * - 12: DoD - Depth of discharge (%) (uint16)
+ * - 13: SoH - State of health (%) (uint16)
+ * - 14-15: NCyc - Cycle count (uint32)
+ * - 16: ChaSt - Charge status (enum16)
+ * - 17: LocRemCtl - Local/Remote control (enum16)
+ * - 18: Hb - Heartbeat (uint16)
+ * - 19: CtrlHb - Controller heartbeat (uint16)
+ * - 20: AlmRst - Alarm reset (uint16)
+ * - 21: Typ - Battery type (enum16)
+ * - 22: State - Battery bank state (enum16)
+ * - 23: StateVnd - Vendor-specific state (enum16)
+ * - 24-25: WarrDt - Warranty date (uint32)
+ * - 26-27: Evt1 - Event bitfield 1 (bitfield32)
+ * - 28-29: Evt2 - Event bitfield 2 (bitfield32)
+ * - 30-31: EvtVnd1 - Vendor event bitfield 1 (bitfield32)
+ * - 32-33: EvtVnd2 - Vendor event bitfield 2 (bitfield32)
+ * - 34: V - Battery voltage (V) (uint16)
+ * - 35: VMax - Maximum battery voltage (V) (uint16)
+ * - 36: VMin - Minimum battery voltage (V) (uint16)
+ * - 37: CellVMax - Maximum cell voltage (V) (uint16)
+ * - 38: CellVMaxStr - String containing max cell voltage (uint16)
+ * - 39: CellVMaxMod - Module containing max cell voltage (uint16)
+ * - 40: CellVMin - Minimum cell voltage (V) (uint16)
+ * - 41: CellVMinStr - String containing min cell voltage (uint16)
+ * - 42: CellVMinMod - Module containing min cell voltage (uint16)
+ * - 43: CellVAvg - Average cell voltage (V) (uint16)
+ * - 44: A - Battery current (A) (int16)
+ * - 45: AChaMax - Maximum charge current (A) (uint16)
+ * - 46: ADisChaMax - Maximum discharge current (A) (uint16)
+ * - 47: W - Battery power (W) (int16)
+ * - 48: ReqInvState - Requested inverter state (enum16)
+ * - 49: ReqW - Requested power (W) (int16)
+ * - 50: SetOp - Set operation (enum16)
+ * - 51: SetInvState - Set inverter state (enum16)
+ * Scale factors at offsets 52-63
+ */
+export interface SunspecBatteryBaseData extends SunspecBlock {
+    blockNumber: 802;
+    ahRtg?: number;
+    whRtg?: number;
+    wChaRteMax?: number;
+    wDisChaRteMax?: number;
+    disChaRte?: number;
+    soCMax?: number;
+    soCMin?: number;
+    soCRsvMax?: number;
+    soCRsvMin?: number;
+    soC?: number;
+    doD?: number;
+    soH?: number;
+    nCyc?: number;
+    chaSt?: number;
+    chaStName?: string;
+    locRemCtl?: number;
+    typ?: number;
+    typName?: string;
+    state?: number;
+    stateName?: string;
+    evt1?: number;
+    evt2?: number;
+    evtVnd1?: number;
+    evtVnd2?: number;
+    v?: number;
+    vMax?: number;
+    vMin?: number;
+    cellVMax?: number;
+    cellVMaxStr?: number;
+    cellVMaxMod?: number;
+    cellVMin?: number;
+    cellVMinStr?: number;
+    cellVMinMod?: number;
+    cellVAvg?: number;
+    a?: number;
+    aChaMax?: number;
+    aDisChaMax?: number;
+    w?: number;
+    reqInvState?: number;
+    reqW?: number;
+    setOp?: number;
+    setInvState?: number;
+}
 /**
  * Meter data structure
  */