@enyo-energy/energy-app-sdk 0.0.34

package/dist/permission-not-granted.d.ts

@@ -0,0 +1,8 @@
+/**
+ * Error thrown when a required permission is not granted in the package configuration
+ */
+export declare class EnergyAppPermissionNotGrantedError extends Error {
+    readonly requiredPermission: string;
+    readonly availablePermissions: string[];
+    constructor(requiredPermission: string, availablePermissions: string[]);
+}

package/dist/permission-not-granted.js

@@ -0,0 +1,14 @@
+/**
+ * Error thrown when a required permission is not granted in the package configuration
+ */
+export class EnergyAppPermissionNotGrantedError extends Error {
+    requiredPermission;
+    availablePermissions;
+    constructor(requiredPermission, availablePermissions) {
+        super(`Permission '${requiredPermission}' is required but not granted. ` +
+            `Available permissions: [${availablePermissions.join(', ')}]`);
+        this.requiredPermission = requiredPermission;
+        this.availablePermissions = availablePermissions;
+        this.name = 'PermissionNotGrantedError';
+    }
+}

package/dist/types/connect-appliance-type.enum.d.ts

@@ -0,0 +1,6 @@
+export declare enum ConnectApplianceTypeEnum {
+    Inverter = "Inverter",
+    Charger = "Charger",
+    Storage = "Storage",
+    Meter = "Meter"
+}

package/dist/types/connect-appliance-type.enum.js

@@ -0,0 +1,7 @@
+export var ConnectApplianceTypeEnum;
+(function (ConnectApplianceTypeEnum) {
+    ConnectApplianceTypeEnum["Inverter"] = "Inverter";
+    ConnectApplianceTypeEnum["Charger"] = "Charger";
+    ConnectApplianceTypeEnum["Storage"] = "Storage";
+    ConnectApplianceTypeEnum["Meter"] = "Meter";
+})(ConnectApplianceTypeEnum || (ConnectApplianceTypeEnum = {}));

package/dist/types/energy-app-settings.d.ts

@@ -0,0 +1,74 @@
+import { EnergyAppPackageLanguage } from "../energy-app-package-definition.js";
+/**
+ * Represents a translated value for different languages in Energy App settings.
+ */
+export interface EnergyAppPackageConfigurationTranslatedValue {
+    /** Language code */
+    language: EnergyAppPackageLanguage;
+    /** The displayed value */
+    value: string;
+}
+/**
+ * Represents an option in a select-type setting field.
+ */
+export interface EnergyAppPackageConfigurationSettingSelectOption {
+    value: string;
+    /** The displayed name of the option */
+    optionName: EnergyAppPackageConfigurationTranslatedValue[];
+}
+/**
+ * Represents a single configuration setting for an Energy App package.
+ */
+export interface EnergyAppPackageConfigurationSetting {
+    /** internal name of the setting - must be unique */
+    name: string;
+    /** the type of the setting */
+    type: 'text' | 'select';
+    /** if the setting is required */
+    required: boolean;
+    /** The displayed name of the field */
+    fieldName: EnergyAppPackageConfigurationTranslatedValue[];
+    /** An optional description for the user*/
+    fieldDescription?: EnergyAppPackageConfigurationTranslatedValue[];
+    /** The current value of the setting (optional) */
+    currentValue?: string;
+    /** Optional appliance ID. If provided, setting is for specific appliance. If omitted, setting is for the whole package */
+    applianceId?: string;
+    selectOptions?: EnergyAppPackageConfigurationSettingSelectOption[];
+}
+/**
+ * Configuration container for Energy App package settings.
+ */
+export interface EnergyAppPackageConfiguration {
+}
+/**
+ * Represents a change event when a setting value is modified.
+ */
+export interface EnergyAppSettingChangeEvent {
+    /** The name of the setting that changed */
+    settingName: string;
+    /** The new value of the setting */
+    newValue: string;
+    /** The previous value of the setting (if any) */
+    previousValue?: string;
+}
+/**
+ * Callback function type for listening to setting changes.
+ */
+export type EnergyAppSettingsChangeListener = (event: EnergyAppSettingChangeEvent) => Promise<void> | void;
+/**
+ * Represents a configuration setting with a unique identifier.
+ * Extends the base setting configuration to include an ID for tracking and management.
+ */
+export interface EnergyAppSettingConfigWithId extends EnergyAppPackageConfigurationSetting {
+    /** Unique identifier for this setting */
+    id: string;
+}
+/**
+ * Represents a configuration setting with its current value.
+ * Extends the setting configuration with ID to include the actual current value.
+ */
+export interface EnergyAppSettingConfigWithValue extends EnergyAppSettingConfigWithId {
+    /** Current value of the setting (if set) */
+    currentValue?: string;
+}

package/dist/types/energy-app-settings.js

@@ -0,0 +1 @@
+export {};

package/dist/types/enyo-appliance.d.ts

@@ -0,0 +1,81 @@
+import { EnergyAppPackageLanguage } from "../energy-app-package-definition.js";
+import { EnyoChargerApplianceMetadata } from "./enyo-charger-appliance.js";
+import { EnyoHeatpumpApplianceMetadata } from "./enyo-heatpump-appliance.js";
+import { EnyoBatteryApplianceMetadata } from "./enyo-battery-appliance.js";
+import { EnyoInverterApplianceMetadata } from "./enyo-inverter-appliance.js";
+import { EnyoMeterAppliance } from "./enyo-meter-appliance.js";
+export declare enum EnyoApplianceTypeEnum {
+    Inverter = "Inverter",
+    Charger = "Charger",
+    Storage = "Storage",
+    Meter = "Meter",
+    Heatpump = "Heatpump"
+}
+export interface EnyoApplianceName {
+    language: EnergyAppPackageLanguage;
+    name: string;
+}
+export declare enum EnyoApplianceStateEnum {
+    Connected = "connected",
+    ConnectionPending = "connection-pending",
+    Offline = "offline"
+}
+export interface EnyoApplianceNetworkMetadata {
+    /** If the appliance is connected via cellular network, you can put the imsi here*/
+    imsi?: string;
+}
+export declare enum EnyoApplianceConnectionType {
+    Connector = "Connector",
+    Cloud = "Cloud"
+}
+export interface EnyoApplianceMetadata {
+    modelName?: string;
+    vendorName?: string;
+    serialNumber?: string;
+    firmwareVersion?: string;
+    state?: EnyoApplianceStateEnum;
+    network?: EnyoApplianceNetworkMetadata;
+    connectionType: EnyoApplianceConnectionType;
+}
+export declare enum EnyoApplianceTopologyFeatureEnum {
+    /** If the meter is the real Primary Meter collecting feed in and consumption in Wh */
+    PrimaryMeter = "PrimaryMeter",
+    /** If the meter is an Intermediate Meter (like the meter of an Inverter) directly behind the Primary Meter */
+    IntermediateOfPrimaryMeter = "IntermediateOfPrimaryMeter",
+    /** If the meter is an Intermediate Meter for a single appliance */
+    IntermediateMeter = "PrimaryMeter",
+    /** If the inverter does a direct grid feed in without self consumption */
+    InverterFullGridFeedIn = "InverterFullGridFeedIn"
+}
+export interface EnyoApplianceTopology {
+    features: EnyoApplianceTopologyFeatureEnum[];
+    /** Information, behind which meter this appliance is located, for example if the wallbox is behind the primary meter or a submeter. Put the appliance ID of the meter */
+    behindMeterApplianceId?: string;
+}
+/**
+ * Represents an appliance managed by the enyo system.
+ */
+export interface EnyoAppliance {
+    /** Unique identifier for the appliance */
+    id: string;
+    /** Name of the appliance in different supported languages */
+    name: EnyoApplianceName[];
+    /** Type/category of the appliance */
+    type: EnyoApplianceTypeEnum;
+    /** network device IDs associated with the appliance */
+    networkDeviceIds: string[];
+    /** Optional Metadata of the Appliance */
+    metadata?: EnyoApplianceMetadata;
+    /** Topology Information of the appliance */
+    topology?: EnyoApplianceTopology;
+    /** Optional Metadata of the Appliance if of type Meter */
+    meter?: EnyoMeterAppliance;
+    /** Optional Metadata of the Appliance if of type Inverter */
+    inverter?: EnyoInverterApplianceMetadata;
+    /** Optional Metadata of the Appliance if of type Charger */
+    charger?: EnyoChargerApplianceMetadata;
+    /** Optional Metadata of the Appliance if of type Heatpump */
+    heatpump?: EnyoHeatpumpApplianceMetadata;
+    /** Optional Metadata of the Appliance if of type Battery */
+    battery?: EnyoBatteryApplianceMetadata;
+}

package/dist/types/enyo-appliance.js

@@ -0,0 +1,30 @@
+export var EnyoApplianceTypeEnum;
+(function (EnyoApplianceTypeEnum) {
+    EnyoApplianceTypeEnum["Inverter"] = "Inverter";
+    EnyoApplianceTypeEnum["Charger"] = "Charger";
+    EnyoApplianceTypeEnum["Storage"] = "Storage";
+    EnyoApplianceTypeEnum["Meter"] = "Meter";
+    EnyoApplianceTypeEnum["Heatpump"] = "Heatpump";
+})(EnyoApplianceTypeEnum || (EnyoApplianceTypeEnum = {}));
+export var EnyoApplianceStateEnum;
+(function (EnyoApplianceStateEnum) {
+    EnyoApplianceStateEnum["Connected"] = "connected";
+    EnyoApplianceStateEnum["ConnectionPending"] = "connection-pending";
+    EnyoApplianceStateEnum["Offline"] = "offline";
+})(EnyoApplianceStateEnum || (EnyoApplianceStateEnum = {}));
+export var EnyoApplianceConnectionType;
+(function (EnyoApplianceConnectionType) {
+    EnyoApplianceConnectionType["Connector"] = "Connector";
+    EnyoApplianceConnectionType["Cloud"] = "Cloud";
+})(EnyoApplianceConnectionType || (EnyoApplianceConnectionType = {}));
+export var EnyoApplianceTopologyFeatureEnum;
+(function (EnyoApplianceTopologyFeatureEnum) {
+    /** If the meter is the real Primary Meter collecting feed in and consumption in Wh */
+    EnyoApplianceTopologyFeatureEnum["PrimaryMeter"] = "PrimaryMeter";
+    /** If the meter is an Intermediate Meter (like the meter of an Inverter) directly behind the Primary Meter */
+    EnyoApplianceTopologyFeatureEnum["IntermediateOfPrimaryMeter"] = "IntermediateOfPrimaryMeter";
+    /** If the meter is an Intermediate Meter for a single appliance */
+    EnyoApplianceTopologyFeatureEnum["IntermediateMeter"] = "PrimaryMeter";
+    /** If the inverter does a direct grid feed in without self consumption */
+    EnyoApplianceTopologyFeatureEnum["InverterFullGridFeedIn"] = "InverterFullGridFeedIn";
+})(EnyoApplianceTopologyFeatureEnum || (EnyoApplianceTopologyFeatureEnum = {}));

package/dist/types/enyo-authentication.d.ts

@@ -0,0 +1,69 @@
+import { EnyoPackageConfigurationTranslatedValue } from "./enyo-settings.js";
+export type EnyoAuthenticationType = 'apiKey' | 'oauth' | 'usernamePassword';
+export interface EnyoApiKeyAuthentication {
+    fieldName: EnyoPackageConfigurationTranslatedValue[];
+    fieldDescription?: EnyoPackageConfigurationTranslatedValue[];
+    /** A link to an external resource where to find more information how to get an api key */
+    externalGuideUrl?: string;
+}
+export interface EnyoUsernamePasswordAuthentication {
+    description?: EnyoPackageConfigurationTranslatedValue[];
+    usernameName: EnyoPackageConfigurationTranslatedValue[];
+    passwordName: EnyoPackageConfigurationTranslatedValue[];
+    /** A link to an external resource where to find more information how to get an api key */
+    externalGuideUrl?: string;
+}
+export interface EnyoOauthAuthentication {
+    description?: EnyoPackageConfigurationTranslatedValue[];
+    /** If the client id and client secret need to be provided by the user*/
+    clientIdName?: EnyoPackageConfigurationTranslatedValue[];
+    clientSecretName?: EnyoPackageConfigurationTranslatedValue[];
+    redirectUrl?: string;
+}
+export interface EnyoOauthAuthenticationParameters {
+    clientId?: string;
+    clientSecret?: string;
+}
+export interface EnyoOauthAuthenticationRedirectUrlResponse {
+    redirectUrl: string;
+}
+export interface EnyoAuthentication {
+    /** The authentication mode */
+    authenticationType: EnyoAuthenticationType;
+    /** the api key configuration */
+    apiKey?: EnyoApiKeyAuthentication;
+    /** the oauth configuration */
+    oauth?: EnyoOauthAuthentication;
+    /** the username password configuration */
+    usernamePassword?: EnyoUsernamePasswordAuthentication;
+    /** If the authentication is one time or not. If not a one time authentication, the user can sign out*/
+    oneTimeAuthentication: boolean;
+    /** Optional appliance ID. If provided, authentication is for specific appliance. If omitted, authentication is for the whole package */
+    applianceId?: string;
+}
+export interface EnyoApiKeyAuthenticationResponse {
+    apiKey: string;
+}
+export interface EnyoUsernamePasswordAuthenticationResponse {
+    username: string;
+    password: string;
+}
+export interface EnyoOauthAuthenticationResponse {
+    code: string;
+    challenge: string;
+}
+export interface EnyoAuthenticationResponse {
+    requestId: string;
+    authenticationType: EnyoAuthenticationType;
+    apiKey?: EnyoApiKeyAuthenticationResponse;
+    usernamePassword?: EnyoUsernamePasswordAuthenticationResponse;
+    oauth?: EnyoOauthAuthenticationResponse;
+}
+export declare enum EnyoAuthenticationStateEnum {
+    Authenticated = "Authenticated",
+    AuthenticationFailed = "AuthenticationFailed",
+    Unauthenticated = "Unauthenticated"
+}
+export interface EnyoAuthenticateState {
+    state: EnyoAuthenticationStateEnum;
+}

package/dist/types/enyo-authentication.js

@@ -0,0 +1,6 @@
+export var EnyoAuthenticationStateEnum;
+(function (EnyoAuthenticationStateEnum) {
+    EnyoAuthenticationStateEnum["Authenticated"] = "Authenticated";
+    EnyoAuthenticationStateEnum["AuthenticationFailed"] = "AuthenticationFailed";
+    EnyoAuthenticationStateEnum["Unauthenticated"] = "Unauthenticated";
+})(EnyoAuthenticationStateEnum || (EnyoAuthenticationStateEnum = {}));

package/dist/types/enyo-battery-appliance.d.ts

@@ -0,0 +1,6 @@
+export interface EnyoBatteryApplianceMetadata {
+    connectedToApplianceId?: string;
+    maxDischargePowerW?: number;
+    maxChargingPowerW?: number;
+    maxCapacityWh?: number;
+}

package/dist/types/enyo-battery-appliance.js

@@ -0,0 +1 @@
+export {};

package/dist/types/enyo-charge.d.ts

@@ -0,0 +1,82 @@
+/**
+ * Status of a charging session
+ */
+export declare enum EnyoChargeStatus {
+    /** Charging session is active */
+    Charging = "Charging",
+    /** Charging session completed successfully */
+    Completed = "Completed",
+    /** Charging session ended due to fault */
+    Failed = "Failed"
+}
+/**
+ * Meter values recorded during a charging session
+ */
+export interface ChargeMeterValue {
+    /** Timestamp when the value was recorded */
+    timestamp: Date;
+    /** Energy value in Watt hours */
+    valueWh: number;
+    /** Price per kWh at the time of measurement */
+    pricePerKwh?: number;
+    /** Charging cost in Euro for this measurement */
+    chargingCostEuro?: number;
+    /** Current on phase 1 in Amperes */
+    currentPhase1: number;
+    /** Current on phase 2 in Amperes */
+    currentPhase2?: number;
+    /** Current on phase 3 in Amperes */
+    currentPhase3?: number;
+}
+/**
+ * Represents a charging session in the enyo system.
+ * Contains all relevant information about an EV charging transaction.
+ */
+export interface EnyoCharge {
+    /** Unique identifier for the charging session */
+    id: string;
+    /** Transaction ID for the charging session */
+    transactionId: string;
+    /** ID of the appliance (charger) handling this session */
+    applianceId: string;
+    /** ID of the charging card used for this session */
+    chargingCardId?: string;
+    /** Connector ID on the charge point */
+    connectorId?: number;
+    /** ID of the vehicle being charged */
+    vehicleId?: string;
+    /** Current status of the charging session */
+    status: EnyoChargeStatus;
+    /** Meter reading at session start in Watt hours */
+    meterStartValueWh?: number;
+    /** Meter reading at session end in Watt hours */
+    meterEndValueWh?: number;
+    /** Paid price in Euro cents */
+    paidPriceEuroCent?: number;
+    /** Total energy delivered in kWh */
+    totalEnergyKwh?: number;
+    /** Timestamp when charging started */
+    startTime?: Date;
+    /** Timestamp when charging ended */
+    endTime?: Date;
+    /** Array of meter values recorded during the session */
+    meterValues?: ChargeMeterValue[];
+    /** Number of phases used for charging */
+    numberOfPhases: number;
+}
+export interface EnyoChargeFilter {
+    /** Filter by specific appliance ID */
+    applianceId?: string;
+    /** Filter by specific charge point ID */
+    chargePointId?: string;
+    /** Filter sessions starting after this ISO timestamp */
+    startDate?: string;
+    /** Filter sessions ending before this ISO timestamp */
+    endDate?: string;
+    /** Filter by charging session status */
+    status?: EnyoChargeStatus;
+    /** Filter by chargingCard */
+    chargingCardId?: string;
+    /** Filter by vehicle */
+    vehicleId?: string;
+}

package/dist/types/enyo-charge.js

@@ -0,0 +1,12 @@
+/**
+ * Status of a charging session
+ */
+export var EnyoChargeStatus;
+(function (EnyoChargeStatus) {
+    /** Charging session is active */
+    EnyoChargeStatus["Charging"] = "Charging";
+    /** Charging session completed successfully */
+    EnyoChargeStatus["Completed"] = "Completed";
+    /** Charging session ended due to fault */
+    EnyoChargeStatus["Failed"] = "Failed";
+})(EnyoChargeStatus || (EnyoChargeStatus = {}));

package/dist/types/enyo-charger-appliance.d.ts

@@ -0,0 +1,49 @@
+export declare enum EnyoChargerApplianceStatusEnum {
+    Available = "Available",
+    Occupied = "Occupied",
+    Suspended = "Suspended",
+    Finishing = "Finishing",
+    Reserved = "Reserved",
+    Unavailable = "Unavailable",
+    Faulted = "Faulted"
+}
+export declare enum EnyoChargerApplianceAuthorizationModeEnum {
+    AuthorizationRequired = "AuthorizationRequired",
+    NoAuthorization = "NoAuthorization"
+}
+export interface EnyoChargerApplianceOcppMetadata {
+    chargePointId: string;
+    ocppVersion: '1.6' | '2.0.1';
+}
+export declare enum EnyoChargerApplianceAvailableFeaturesEnum {
+    /** If the charger can limit the power in Ampere or Watt*/
+    PowerLimitation = "PowerLimitation",
+    /** If the charger is capable of smart charging to adjust the charging power in a pre-defined schedule */
+    SmartChargingSchedule = "SmartChargingSchedule",
+    /** If the cable can be locked (only available for socket wallboxes */
+    CableLocking = "CableLocking",
+    /** If the LED of the charger can be dimmed by the user */
+    LedDimming = "LedDimming",
+    /** If the charger has a simple meter to collect the charged electricity consumption */
+    SimpleMeter = "SimpleMeter",
+    /** If the charger has a mid certified meter to collect the charged electricity consumption */
+    MidMeter = "MidMeter",
+    /** If the charger has an eichrecht certified meter to collect the charged electricity consumption */
+    EichrechtMeter = "EichrechtMeter",
+    /** If the charger has a fixed cable attached */
+    FixedCable = "FixedCable",
+    /** If the charger has a socket for charging cable */
+    Socket = "Socket",
+    /** If the charger supports authorization via rfid reader*/
+    RfidAuthorization = "RfidAuthorization"
+}
+export interface EnyoChargerApplianceMetadata {
+    availableFeatures: EnyoChargerApplianceAvailableFeaturesEnum[];
+    status: EnyoChargerApplianceStatusEnum;
+    /** ISO Timestamp of the last heartbeat */
+    lastHeartbeatAtIso?: string;
+    ocpp?: EnyoChargerApplianceOcppMetadata;
+    authorizationMode: EnyoChargerApplianceAuthorizationModeEnum;
+    /** If cableType is Socket, the cable can be locked for theft protection */
+    cableLocked?: boolean;
+}

package/dist/types/enyo-charger-appliance.js

@@ -0,0 +1,38 @@
+export var EnyoChargerApplianceStatusEnum;
+(function (EnyoChargerApplianceStatusEnum) {
+    EnyoChargerApplianceStatusEnum["Available"] = "Available";
+    EnyoChargerApplianceStatusEnum["Occupied"] = "Occupied";
+    EnyoChargerApplianceStatusEnum["Suspended"] = "Suspended";
+    EnyoChargerApplianceStatusEnum["Finishing"] = "Finishing";
+    EnyoChargerApplianceStatusEnum["Reserved"] = "Reserved";
+    EnyoChargerApplianceStatusEnum["Unavailable"] = "Unavailable";
+    EnyoChargerApplianceStatusEnum["Faulted"] = "Faulted";
+})(EnyoChargerApplianceStatusEnum || (EnyoChargerApplianceStatusEnum = {}));
+export var EnyoChargerApplianceAuthorizationModeEnum;
+(function (EnyoChargerApplianceAuthorizationModeEnum) {
+    EnyoChargerApplianceAuthorizationModeEnum["AuthorizationRequired"] = "AuthorizationRequired";
+    EnyoChargerApplianceAuthorizationModeEnum["NoAuthorization"] = "NoAuthorization";
+})(EnyoChargerApplianceAuthorizationModeEnum || (EnyoChargerApplianceAuthorizationModeEnum = {}));
+export var EnyoChargerApplianceAvailableFeaturesEnum;
+(function (EnyoChargerApplianceAvailableFeaturesEnum) {
+    /** If the charger can limit the power in Ampere or Watt*/
+    EnyoChargerApplianceAvailableFeaturesEnum["PowerLimitation"] = "PowerLimitation";
+    /** If the charger is capable of smart charging to adjust the charging power in a pre-defined schedule */
+    EnyoChargerApplianceAvailableFeaturesEnum["SmartChargingSchedule"] = "SmartChargingSchedule";
+    /** If the cable can be locked (only available for socket wallboxes */
+    EnyoChargerApplianceAvailableFeaturesEnum["CableLocking"] = "CableLocking";
+    /** If the LED of the charger can be dimmed by the user */
+    EnyoChargerApplianceAvailableFeaturesEnum["LedDimming"] = "LedDimming";
+    /** If the charger has a simple meter to collect the charged electricity consumption */
+    EnyoChargerApplianceAvailableFeaturesEnum["SimpleMeter"] = "SimpleMeter";
+    /** If the charger has a mid certified meter to collect the charged electricity consumption */
+    EnyoChargerApplianceAvailableFeaturesEnum["MidMeter"] = "MidMeter";
+    /** If the charger has an eichrecht certified meter to collect the charged electricity consumption */
+    EnyoChargerApplianceAvailableFeaturesEnum["EichrechtMeter"] = "EichrechtMeter";
+    /** If the charger has a fixed cable attached */
+    EnyoChargerApplianceAvailableFeaturesEnum["FixedCable"] = "FixedCable";
+    /** If the charger has a socket for charging cable */
+    EnyoChargerApplianceAvailableFeaturesEnum["Socket"] = "Socket";
+    /** If the charger supports authorization via rfid reader*/
+    EnyoChargerApplianceAvailableFeaturesEnum["RfidAuthorization"] = "RfidAuthorization";
+})(EnyoChargerApplianceAvailableFeaturesEnum || (EnyoChargerApplianceAvailableFeaturesEnum = {}));

package/dist/types/enyo-charging-card.d.ts

@@ -0,0 +1,11 @@
+/**
+ * Represents a charging card in the enyo system.
+ * Contains all relevant information about an electric vehicle charging card.
+ */
+export interface EnyoChargingCard {
+    /** Unique identifier for the charging card */
+    id: string;
+    name: string;
+    rfid?: string;
+    pendingRegistration?: boolean;
+}

package/dist/types/enyo-charging-card.js

@@ -0,0 +1 @@
+export {};