@enyo-energy/energy-app-sdk 0.0.153 → 0.0.155

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (9) hide show
  1. package/dist/cjs/types/enyo-charger-appliance.d.cts +6 -0
  2. package/dist/cjs/types/enyo-eebus-use-cases.d.cts +98 -22
  3. package/dist/cjs/version.cjs +1 -1
  4. package/dist/cjs/version.d.cts +1 -1
  5. package/dist/types/enyo-charger-appliance.d.ts +6 -0
  6. package/dist/types/enyo-eebus-use-cases.d.ts +98 -22
  7. package/dist/version.d.ts +1 -1
  8. package/dist/version.js +1 -1
  9. package/package.json +1 -1
package/dist/cjs/types/enyo-charger-appliance.d.cts CHANGED
@@ -75,4 +75,10 @@ export interface EnyoChargerApplianceMetadata {
75
75
  cableLocked?: boolean;
76
76
  /** Current charging power limit in kilowatts */
77
77
  currentChargingLimitKw?: number;
78
+ /**
79
+ * Hardware maximum charging power the charger can deliver, in
80
+ * kilowatts. Derived from the device's nameplate / capability
81
+ * report; treat as a physical ceiling that the EMS cannot exceed.
82
+ */
83
+ maxChargingPowerKw?: number;
78
84
  }
package/dist/cjs/types/enyo-eebus-use-cases.d.cts CHANGED
@@ -193,12 +193,34 @@ export interface EebusMgcpReading {
193
193
  timestamp: Date;
194
194
  /** Total active power in Watts. Positive = import, negative = export. */
195
195
  activePowerW: number;
196
- /** Optional per-phase active power in Watts (length 1 or 3) */
197
- activePowerPerPhaseW?: number[];
198
- /** Optional per-phase voltage in Volts */
199
- voltagePerPhaseV?: number[];
200
- /** Optional per-phase current in Amperes */
201
- currentPerPhaseA?: number[];
196
+ /**
197
+ * Optional per-phase active power in Watts, keyed by phase label.
198
+ * Each phase is independently optional — single-phase peers populate
199
+ * only `a`, three-phase peers populate `a`, `b`, and `c`.
200
+ */
201
+ activePowerByPhase?: {
202
+ a?: number;
203
+ b?: number;
204
+ c?: number;
205
+ };
206
+ /**
207
+ * Optional per-phase voltage in Volts, keyed by phase label. Each
208
+ * phase is independently optional.
209
+ */
210
+ voltageByPhase?: {
211
+ a?: number;
212
+ b?: number;
213
+ c?: number;
214
+ };
215
+ /**
216
+ * Optional per-phase current in Amperes, keyed by phase label. Each
217
+ * phase is independently optional.
218
+ */
219
+ currentByPhase?: {
220
+ a?: number;
221
+ b?: number;
222
+ c?: number;
223
+ };
202
224
  /** Optional grid frequency in Hertz */
203
225
  frequencyHz?: number;
204
226
  /** Cumulative energy imported from the grid in Watt-hours */
@@ -214,10 +236,25 @@ export interface EebusMpcReading {
214
236
  timestamp: Date;
215
237
  /** Active power consumption in Watts */
216
238
  activePowerW: number;
217
- /** Optional per-phase active power in Watts (length 1 or 3) */
218
- activePowerPerPhaseW?: number[];
219
- /** Optional per-phase current in Amperes */
220
- currentPerPhaseA?: number[];
239
+ /**
240
+ * Optional per-phase active power in Watts, keyed by phase label.
241
+ * Each phase is independently optional — single-phase peers populate
242
+ * only `a`, three-phase peers populate `a`, `b`, and `c`.
243
+ */
244
+ activePowerByPhase?: {
245
+ a?: number;
246
+ b?: number;
247
+ c?: number;
248
+ };
249
+ /**
250
+ * Optional per-phase current in Amperes, keyed by phase label. Each
251
+ * phase is independently optional.
252
+ */
253
+ currentByPhase?: {
254
+ a?: number;
255
+ b?: number;
256
+ c?: number;
257
+ };
221
258
  /** Cumulative energy consumed in Watt-hours */
222
259
  totalEnergyConsumedWh?: number;
223
260
  }
@@ -611,12 +648,34 @@ export interface EebusEvcemReading {
611
648
  timestamp: Date;
612
649
  /** Total active charging power in Watts. */
613
650
  activePowerW: number;
614
- /** Optional per-phase active power in Watts (length 1 or 3). */
615
- activePowerPerPhaseW?: number[];
616
- /** Optional per-phase current in Amperes (length 1 or 3). */
617
- currentPerPhaseA?: number[];
618
- /** Optional per-phase voltage in Volts (length 1 or 3). */
619
- voltagePerPhaseV?: number[];
651
+ /**
652
+ * Optional per-phase active power in Watts, keyed by phase label.
653
+ * Each phase is independently optional — single-phase EVSEs populate
654
+ * only `a`, three-phase EVSEs populate `a`, `b`, and `c`.
655
+ */
656
+ activePowerByPhase?: {
657
+ a?: number;
658
+ b?: number;
659
+ c?: number;
660
+ };
661
+ /**
662
+ * Optional per-phase current in Amperes, keyed by phase label. Each
663
+ * phase is independently optional.
664
+ */
665
+ currentByPhase?: {
666
+ a?: number;
667
+ b?: number;
668
+ c?: number;
669
+ };
670
+ /**
671
+ * Optional per-phase voltage in Volts, keyed by phase label. Each
672
+ * phase is independently optional.
673
+ */
674
+ voltageByPhase?: {
675
+ a?: number;
676
+ b?: number;
677
+ c?: number;
678
+ };
620
679
  /** Cumulative energy charged since session start, in Watt-hours. */
621
680
  totalEnergyChargedWh?: number;
622
681
  }
@@ -668,12 +727,21 @@ export interface EebusCevcAck {
668
727
  * OPEV use case. OPEV is an *obligation*: the EVSE MUST respect the
669
728
  * limit (it is grid-safety driven, not optimisation driven).
670
729
  *
671
- * Phase count is determined by the EVSE — single-phase wallboxes report
672
- * length 1, three-phase wallboxes length 3.
730
+ * Single-phase EVSEs populate only `a`; three-phase EVSEs populate `a`,
731
+ * `b`, and `c`. Phases the EVSE does not carry are left absent rather
732
+ * than implied by array length.
673
733
  */
674
734
  export interface EebusOpevLimit {
675
- /** Per-phase current limits in Amperes (length 1 or 3). */
676
- perPhaseA: number[];
735
+ /**
736
+ * Per-phase current limits in Amperes, keyed by phase label. Each
737
+ * phase is independently optional — omit phases the EVSE does not
738
+ * carry.
739
+ */
740
+ currentLimitByPhase: {
741
+ a?: number;
742
+ b?: number;
743
+ c?: number;
744
+ };
677
745
  /** Whether the limit is currently active. */
678
746
  isActive: boolean;
679
747
  /**
@@ -701,8 +769,16 @@ export interface EebusOpevAck {
701
769
  * (obligation vs recommendation), as with LPC vs LPP.
702
770
  */
703
771
  export interface EebusOscevLimit {
704
- /** Per-phase recommended current limits in Amperes (length 1 or 3). */
705
- perPhaseA: number[];
772
+ /**
773
+ * Per-phase recommended current limits in Amperes, keyed by phase
774
+ * label. Each phase is independently optional — omit phases the EVSE
775
+ * does not carry.
776
+ */
777
+ currentLimitByPhase: {
778
+ a?: number;
779
+ b?: number;
780
+ c?: number;
781
+ };
706
782
  /** Whether the recommendation is currently active. */
707
783
  isActive: boolean;
708
784
  /** Duration in seconds; omit or `0` for indefinite. */
package/dist/cjs/version.cjs CHANGED
@@ -9,7 +9,7 @@ exports.getSdkVersion = getSdkVersion;
9
9
  /**
10
10
  * Current version of the enyo Energy App SDK.
11
11
  */
12
- exports.SDK_VERSION = '0.0.153';
12
+ exports.SDK_VERSION = '0.0.155';
13
13
  /**
14
14
  * Gets the current SDK version.
15
15
  * @returns The semantic version string of the SDK
package/dist/cjs/version.d.cts CHANGED
@@ -5,7 +5,7 @@
5
5
  /**
6
6
  * Current version of the enyo Energy App SDK.
7
7
  */
8
- export declare const SDK_VERSION = "0.0.153";
8
+ export declare const SDK_VERSION = "0.0.155";
9
9
  /**
10
10
  * Gets the current SDK version.
11
11
  * @returns The semantic version string of the SDK
package/dist/types/enyo-charger-appliance.d.ts CHANGED
@@ -75,4 +75,10 @@ export interface EnyoChargerApplianceMetadata {
75
75
  cableLocked?: boolean;
76
76
  /** Current charging power limit in kilowatts */
77
77
  currentChargingLimitKw?: number;
78
+ /**
79
+ * Hardware maximum charging power the charger can deliver, in
80
+ * kilowatts. Derived from the device's nameplate / capability
81
+ * report; treat as a physical ceiling that the EMS cannot exceed.
82
+ */
83
+ maxChargingPowerKw?: number;
78
84
  }
package/dist/types/enyo-eebus-use-cases.d.ts CHANGED
@@ -193,12 +193,34 @@ export interface EebusMgcpReading {
193
193
  timestamp: Date;
194
194
  /** Total active power in Watts. Positive = import, negative = export. */
195
195
  activePowerW: number;
196
- /** Optional per-phase active power in Watts (length 1 or 3) */
197
- activePowerPerPhaseW?: number[];
198
- /** Optional per-phase voltage in Volts */
199
- voltagePerPhaseV?: number[];
200
- /** Optional per-phase current in Amperes */
201
- currentPerPhaseA?: number[];
196
+ /**
197
+ * Optional per-phase active power in Watts, keyed by phase label.
198
+ * Each phase is independently optional — single-phase peers populate
199
+ * only `a`, three-phase peers populate `a`, `b`, and `c`.
200
+ */
201
+ activePowerByPhase?: {
202
+ a?: number;
203
+ b?: number;
204
+ c?: number;
205
+ };
206
+ /**
207
+ * Optional per-phase voltage in Volts, keyed by phase label. Each
208
+ * phase is independently optional.
209
+ */
210
+ voltageByPhase?: {
211
+ a?: number;
212
+ b?: number;
213
+ c?: number;
214
+ };
215
+ /**
216
+ * Optional per-phase current in Amperes, keyed by phase label. Each
217
+ * phase is independently optional.
218
+ */
219
+ currentByPhase?: {
220
+ a?: number;
221
+ b?: number;
222
+ c?: number;
223
+ };
202
224
  /** Optional grid frequency in Hertz */
203
225
  frequencyHz?: number;
204
226
  /** Cumulative energy imported from the grid in Watt-hours */
@@ -214,10 +236,25 @@ export interface EebusMpcReading {
214
236
  timestamp: Date;
215
237
  /** Active power consumption in Watts */
216
238
  activePowerW: number;
217
- /** Optional per-phase active power in Watts (length 1 or 3) */
218
- activePowerPerPhaseW?: number[];
219
- /** Optional per-phase current in Amperes */
220
- currentPerPhaseA?: number[];
239
+ /**
240
+ * Optional per-phase active power in Watts, keyed by phase label.
241
+ * Each phase is independently optional — single-phase peers populate
242
+ * only `a`, three-phase peers populate `a`, `b`, and `c`.
243
+ */
244
+ activePowerByPhase?: {
245
+ a?: number;
246
+ b?: number;
247
+ c?: number;
248
+ };
249
+ /**
250
+ * Optional per-phase current in Amperes, keyed by phase label. Each
251
+ * phase is independently optional.
252
+ */
253
+ currentByPhase?: {
254
+ a?: number;
255
+ b?: number;
256
+ c?: number;
257
+ };
221
258
  /** Cumulative energy consumed in Watt-hours */
222
259
  totalEnergyConsumedWh?: number;
223
260
  }
@@ -611,12 +648,34 @@ export interface EebusEvcemReading {
611
648
  timestamp: Date;
612
649
  /** Total active charging power in Watts. */
613
650
  activePowerW: number;
614
- /** Optional per-phase active power in Watts (length 1 or 3). */
615
- activePowerPerPhaseW?: number[];
616
- /** Optional per-phase current in Amperes (length 1 or 3). */
617
- currentPerPhaseA?: number[];
618
- /** Optional per-phase voltage in Volts (length 1 or 3). */
619
- voltagePerPhaseV?: number[];
651
+ /**
652
+ * Optional per-phase active power in Watts, keyed by phase label.
653
+ * Each phase is independently optional — single-phase EVSEs populate
654
+ * only `a`, three-phase EVSEs populate `a`, `b`, and `c`.
655
+ */
656
+ activePowerByPhase?: {
657
+ a?: number;
658
+ b?: number;
659
+ c?: number;
660
+ };
661
+ /**
662
+ * Optional per-phase current in Amperes, keyed by phase label. Each
663
+ * phase is independently optional.
664
+ */
665
+ currentByPhase?: {
666
+ a?: number;
667
+ b?: number;
668
+ c?: number;
669
+ };
670
+ /**
671
+ * Optional per-phase voltage in Volts, keyed by phase label. Each
672
+ * phase is independently optional.
673
+ */
674
+ voltageByPhase?: {
675
+ a?: number;
676
+ b?: number;
677
+ c?: number;
678
+ };
620
679
  /** Cumulative energy charged since session start, in Watt-hours. */
621
680
  totalEnergyChargedWh?: number;
622
681
  }
@@ -668,12 +727,21 @@ export interface EebusCevcAck {
668
727
  * OPEV use case. OPEV is an *obligation*: the EVSE MUST respect the
669
728
  * limit (it is grid-safety driven, not optimisation driven).
670
729
  *
671
- * Phase count is determined by the EVSE — single-phase wallboxes report
672
- * length 1, three-phase wallboxes length 3.
730
+ * Single-phase EVSEs populate only `a`; three-phase EVSEs populate `a`,
731
+ * `b`, and `c`. Phases the EVSE does not carry are left absent rather
732
+ * than implied by array length.
673
733
  */
674
734
  export interface EebusOpevLimit {
675
- /** Per-phase current limits in Amperes (length 1 or 3). */
676
- perPhaseA: number[];
735
+ /**
736
+ * Per-phase current limits in Amperes, keyed by phase label. Each
737
+ * phase is independently optional — omit phases the EVSE does not
738
+ * carry.
739
+ */
740
+ currentLimitByPhase: {
741
+ a?: number;
742
+ b?: number;
743
+ c?: number;
744
+ };
677
745
  /** Whether the limit is currently active. */
678
746
  isActive: boolean;
679
747
  /**
@@ -701,8 +769,16 @@ export interface EebusOpevAck {
701
769
  * (obligation vs recommendation), as with LPC vs LPP.
702
770
  */
703
771
  export interface EebusOscevLimit {
704
- /** Per-phase recommended current limits in Amperes (length 1 or 3). */
705
- perPhaseA: number[];
772
+ /**
773
+ * Per-phase recommended current limits in Amperes, keyed by phase
774
+ * label. Each phase is independently optional — omit phases the EVSE
775
+ * does not carry.
776
+ */
777
+ currentLimitByPhase: {
778
+ a?: number;
779
+ b?: number;
780
+ c?: number;
781
+ };
706
782
  /** Whether the recommendation is currently active. */
707
783
  isActive: boolean;
708
784
  /** Duration in seconds; omit or `0` for indefinite. */
package/dist/version.d.ts CHANGED
@@ -5,7 +5,7 @@
5
5
  /**
6
6
  * Current version of the enyo Energy App SDK.
7
7
  */
8
- export declare const SDK_VERSION = "0.0.153";
8
+ export declare const SDK_VERSION = "0.0.155";
9
9
  /**
10
10
  * Gets the current SDK version.
11
11
  * @returns The semantic version string of the SDK
package/dist/version.js CHANGED
@@ -5,7 +5,7 @@
5
5
  /**
6
6
  * Current version of the enyo Energy App SDK.
7
7
  */
8
- export const SDK_VERSION = '0.0.153';
8
+ export const SDK_VERSION = '0.0.155';
9
9
  /**
10
10
  * Gets the current SDK version.
11
11
  * @returns The semantic version string of the SDK
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@enyo-energy/energy-app-sdk",
3
- "version": "0.0.153",
3
+ "version": "0.0.155",
4
4
  "description": "enyo Energy App SDK",
5
5
  "type": "module",
6
6
  "main": "dist/index.js",