@enyo-energy/energy-app-sdk 0.0.77 → 0.0.78

package/dist/cjs/energy-app-permission.type.cjs

@@ -36,4 +36,7 @@ var EnergyAppPermissionTypeEnum;
     EnergyAppPermissionTypeEnum["InverterControlCommands"] = "InverterControlCommands";
     EnergyAppPermissionTypeEnum["BatteryControlCommands"] = "BatteryControlCommands";
     EnergyAppPermissionTypeEnum["ChargerControlCommands"] = "ChargerControlCommands";
+    EnergyAppPermissionTypeEnum["EebusDeviceManagement"] = "EebusDeviceManagement";
+    EnergyAppPermissionTypeEnum["EebusDataAccess"] = "EebusDataAccess";
+    EnergyAppPermissionTypeEnum["EebusControl"] = "EebusControl";
 })(EnergyAppPermissionTypeEnum || (exports.EnergyAppPermissionTypeEnum = EnergyAppPermissionTypeEnum = {}));

package/dist/cjs/energy-app-permission.type.d.cts

@@ -1,4 +1,4 @@
-export type EnergyAppPermissionType = 'RestrictedInternetAccess' | 'NetworkDeviceDiscovery' | 'NetworkDeviceSearch' | 'NetworkDeviceAccess' | 'Modbus' | 'Storage' | 'Appliance' | 'AllAppliances' | 'SendDataBusValues' | 'SubscribeDataBus' | 'SendDataBusCommands' | 'OcppServer' | 'ChargingCard' | 'Vehicle' | 'Charge' | 'SecretManager' | 'LocationZipCode' | 'LocationCoordinates' | 'Timeseries' | 'EnergyManagerInfo' | 'ElectricityTariff' | 'WeatherForecastRegister' | 'WeatherForecastUse' | 'PvForecastRegister' | 'PvForecastUse' | 'PvSystemRegister' | 'PvSystemUse' | 'InverterControlCommands' | 'BatteryControlCommands' | 'ChargerControlCommands' | 'ModbusRtu' | 'EnergyPrices' | 'EnergyManager';
+export type EnergyAppPermissionType = 'RestrictedInternetAccess' | 'NetworkDeviceDiscovery' | 'NetworkDeviceSearch' | 'NetworkDeviceAccess' | 'Modbus' | 'Storage' | 'Appliance' | 'AllAppliances' | 'SendDataBusValues' | 'SubscribeDataBus' | 'SendDataBusCommands' | 'OcppServer' | 'ChargingCard' | 'Vehicle' | 'Charge' | 'SecretManager' | 'LocationZipCode' | 'LocationCoordinates' | 'Timeseries' | 'EnergyManagerInfo' | 'ElectricityTariff' | 'WeatherForecastRegister' | 'WeatherForecastUse' | 'PvForecastRegister' | 'PvForecastUse' | 'PvSystemRegister' | 'PvSystemUse' | 'InverterControlCommands' | 'BatteryControlCommands' | 'ChargerControlCommands' | 'ModbusRtu' | 'EnergyPrices' | 'EnergyManager' | 'EebusDeviceManagement' | 'EebusDataAccess' | 'EebusControl';
 export declare enum EnergyAppPermissionTypeEnum {
     RestrictedInternetAccess = "RestrictedInternetAccess",
     NetworkDeviceDiscovery = "NetworkDeviceDiscovery",
@@ -32,5 +32,8 @@ export declare enum EnergyAppPermissionTypeEnum {
     PvSystemUse = "PvSystemUse",
     InverterControlCommands = "InverterControlCommands",
     BatteryControlCommands = "BatteryControlCommands",
-    ChargerControlCommands = "ChargerControlCommands"
+    ChargerControlCommands = "ChargerControlCommands",
+    EebusDeviceManagement = "EebusDeviceManagement",
+    EebusDataAccess = "EebusDataAccess",
+    EebusControl = "EebusControl"
 }

package/dist/cjs/enyo-energy-app-sdk.d.cts

@@ -24,6 +24,7 @@ import { EnergyAppPvForecasting } from "./packages/energy-app-pv-forecasting.cjs
 import { EnergyAppPvSystem } from "./packages/energy-app-pv-system.cjs";
 import { EnergyAppSequenceGenerator } from "./packages/energy-app-sequence-generator.cjs";
 import { EnergyAppModbusRtu } from "./packages/energy-app-modbus-rtu.cjs";
+import { EnergyAppEebus } from "./packages/energy-app-eebus.cjs";
 export declare enum EnergyAppStateEnum {
     Launching = "launching",
     Running = "running",
@@ -98,4 +99,6 @@ export interface EnyoEnergyAppSdk {
     useSequenceGenerator: () => EnergyAppSequenceGenerator;
     /** Get the Modbus RTU serial communication API */
     useModbusRtu: () => EnergyAppModbusRtu;
+    /** Get the EEbus SHIP/SPINE communication API for device pairing, data access, and power management */
+    useEebus: () => EnergyAppEebus;
 }

package/dist/cjs/index.cjs

@@ -46,6 +46,8 @@ __exportStar(require("./types/enyo-currency.cjs"), exports);
 __exportStar(require("./packages/energy-app-sequence-generator.cjs"), exports);
 __exportStar(require("./packages/energy-app-energy-prices.cjs"), exports);
 __exportStar(require("./packages/energy-app-modbus-rtu.cjs"), exports);
+__exportStar(require("./types/enyo-eebus.cjs"), exports);
+__exportStar(require("./packages/energy-app-eebus.cjs"), exports);
 class EnergyApp {
     energyAppSdk;
     constructor() {
@@ -211,6 +213,16 @@ class EnergyApp {
     useModbusRtu() {
         return this.energyAppSdk.useModbusRtu();
     }
+    /**
+     * Gets the EEbus API for SHIP/SPINE device communication.
+     * Provides device pairing and discovery, low-level SPINE data access,
+     * and high-level convenience methods for power management and device classification.
+     * Supports both appliance and energy manager roles for bidirectional communication.
+     * @returns The EEbus API instance
+     */
+    useEebus() {
+        return this.energyAppSdk.useEebus();
+    }
     /**
      * Gets the current SDK version.
      * @returns The semantic version string of the SDK

package/dist/cjs/index.d.cts

@@ -25,6 +25,7 @@ import { EnergyAppPvForecasting } from "./packages/energy-app-pv-forecasting.cjs
 import { EnergyAppPvSystem } from "./packages/energy-app-pv-system.cjs";
 import { EnergyAppSequenceGenerator } from "./packages/energy-app-sequence-generator.cjs";
 import { EnergyAppModbusRtu } from "./packages/energy-app-modbus-rtu.cjs";
+import { EnergyAppEebus } from "./packages/energy-app-eebus.cjs";
 export * from './energy-app-package-definition.cjs';
 export * from './version.cjs';
 export * from './implementations/ocpp/ocpp16.cjs';
@@ -55,6 +56,8 @@ export * from './types/enyo-currency.cjs';
 export * from './packages/energy-app-sequence-generator.cjs';
 export * from './packages/energy-app-energy-prices.cjs';
 export * from './packages/energy-app-modbus-rtu.cjs';
+export * from './types/enyo-eebus.cjs';
+export * from './packages/energy-app-eebus.cjs';
 export declare class EnergyApp implements EnyoEnergyAppSdk {
     private readonly energyAppSdk;
     constructor();
@@ -143,6 +146,14 @@ export declare class EnergyApp implements EnyoEnergyAppSdk {
      * @returns The Modbus RTU API instance
      */
     useModbusRtu(): EnergyAppModbusRtu;
+    /**
+     * Gets the EEbus API for SHIP/SPINE device communication.
+     * Provides device pairing and discovery, low-level SPINE data access,
+     * and high-level convenience methods for power management and device classification.
+     * Supports both appliance and energy manager roles for bidirectional communication.
+     * @returns The EEbus API instance
+     */
+    useEebus(): EnergyAppEebus;
     /**
      * Gets the current SDK version.
      * @returns The semantic version string of the SDK

package/dist/cjs/packages/energy-app-eebus.cjs

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/cjs/packages/energy-app-eebus.d.cts

@@ -0,0 +1,176 @@
+import { EebusConnectionStatusEnum, EebusDataPoint, EebusDevice, EebusDeviceDetails, EebusDiscoveredDevice, EebusFeatureTypeEnum, EebusPowerLimit } from "../types/enyo-eebus.cjs";
+/**
+ * Interface for EEbus (SHIP/SPINE) device communication in enyo packages.
+ *
+ * Provides three layers of API:
+ * - **Device Management**: Pairing, connecting, and managing EEbus devices
+ * - **Low-Level API**: Direct SPINE feature data read/write/subscribe operations
+ * - **High-Level API**: Convenient methods for common energy use cases (power consumption, power limits, device details)
+ *
+ * The high-level API supports both directions of communication:
+ * - **Energy Manager role**: Reads power consumption from appliances and sends power limit commands
+ * - **Appliance role**: Receives power limit commands and provides power consumption data via registered handlers
+ *
+ * @example
+ * ```typescript
+ * const eebus = energyApp.useEebus();
+ *
+ * // Discover and pair a device
+ * const discovered = await eebus.getDiscoveredDevices();
+ * const device = await eebus.pairDevice(discovered[0].ski);
+ *
+ * // Connect and read power (Energy Manager role)
+ * await eebus.connect(device.ski);
+ * const watts = await eebus.getPowerConsumption(device.ski);
+ *
+ * // Receive power limits (Appliance role)
+ * eebus.onPowerLimitReceived((ski, limit) => {
+ *   console.log(`Received limit: ${limit.watts}W from ${ski}`);
+ * });
+ * ```
+ */
+export interface EnergyAppEebus {
+    /**
+     * Get all devices that have been successfully paired (trusted).
+     * @returns Array of paired EEbus devices with their current connection status
+     */
+    getPairedDevices: () => Promise<EebusDevice[]>;
+    /**
+     * Get devices currently visible on the network that have not yet been paired.
+     * Uses mDNS discovery to find EEbus-capable devices.
+     * @returns Array of discovered but unpaired EEbus devices
+     */
+    getDiscoveredDevices: () => Promise<EebusDiscoveredDevice[]>;
+    /**
+     * Initiate the EEbus pairing (trust) handshake with a device identified by its SKI.
+     * The device must have been previously discovered via {@link getDiscoveredDevices}.
+     * @param ski Subject Key Identifier of the device to pair with
+     * @returns The newly paired device
+     */
+    pairDevice: (ski: string) => Promise<EebusDevice>;
+    /**
+     * Remove the trust relationship and delete stored connection information for a paired device.
+     * If the device is currently connected, it will be disconnected first.
+     * @param ski Subject Key Identifier of the device to unpair
+     */
+    unpairDevice: (ski: string) => Promise<void>;
+    /**
+     * Establish an active SHIP connection to an already-paired device.
+     * The device must have been previously paired via {@link pairDevice}.
+     * @param ski Subject Key Identifier of the device to connect to
+     */
+    connect: (ski: string) => Promise<void>;
+    /**
+     * Safely disconnect from a currently connected device.
+     * @param ski Subject Key Identifier of the device to disconnect from
+     */
+    disconnect: (ski: string) => Promise<void>;
+    /**
+     * Check the current connection status of a device.
+     * @param ski Subject Key Identifier of the device to check
+     * @returns The current connection status (Connected, Disconnected, or Connecting)
+     */
+    getConnectionStatus: (ski: string) => Promise<EebusConnectionStatusEnum>;
+    /**
+     * Register a listener for connection status changes of EEbus devices.
+     * The listener is invoked whenever any paired device's connection status changes.
+     * @param listener Callback invoked with the device SKI and its new connection status
+     * @returns Listener ID that can be passed to {@link removeListener} to stop listening
+     */
+    listenForConnectionStatusChange: (listener: (ski: string, status: EebusConnectionStatusEnum) => void) => string;
+    /**
+     * Read specific data points from a device's SPINE feature.
+     * @param ski Subject Key Identifier of the target device
+     * @param featureType The SPINE feature type to read from
+     * @param functionName The specific function or data set to read (e.g. "measurementListData")
+     * @returns The data point containing the value, timestamp, and optional unit
+     */
+    readData: (ski: string, featureType: EebusFeatureTypeEnum, functionName: string) => Promise<EebusDataPoint>;
+    /**
+     * Write data or send a command to a device's SPINE feature.
+     * @param ski Subject Key Identifier of the target device
+     * @param featureType The SPINE feature type to write to
+     * @param functionName The specific function or command to invoke (e.g. "loadControlLimitListData")
+     * @param payload The data payload to send
+     */
+    writeData: (ski: string, featureType: EebusFeatureTypeEnum, functionName: string, payload: unknown) => Promise<void>;
+    /**
+     * Subscribe to automatic notifications when a SPINE feature's data changes on the remote device.
+     * Sets up a SPINE binding so the local device is notified whenever the subscribed data changes.
+     * @param ski Subject Key Identifier of the target device
+     * @param featureType The SPINE feature type to subscribe to
+     * @param listener Callback invoked with updated data whenever the value changes
+     * @returns Listener ID that can be passed to {@link removeListener} to cancel the subscription
+     */
+    subscribe: (ski: string, featureType: EebusFeatureTypeEnum, listener: (data: EebusDataPoint) => void) => string;
+    /**
+     * Get the current active power consumption of a remote device in Watts.
+     * Reads the Measurement feature (SPINE) for active power data.
+     * Intended for the **energy manager role** — reading consumption from a remote appliance.
+     * @param ski Subject Key Identifier of the target device
+     * @returns Current power consumption in Watts
+     */
+    getPowerConsumption: (ski: string) => Promise<number>;
+    /**
+     * Send a power limit command to a consumer device (e.g. a wallbox).
+     * Uses the LoadControl feature (SPINE) to set consumption limits.
+     * Intended for the **energy manager role** — sending limits to a remote appliance.
+     * @param ski Subject Key Identifier of the target device
+     * @param limit The power limit to apply, including watts and optional duration
+     *
+     * @example
+     * ```typescript
+     * // Limit a wallbox to 11kW
+     * await eebus.setPowerLimit(wallboxSki, { watts: 11000 });
+     *
+     * // Temporary limit for 30 minutes
+     * await eebus.setPowerLimit(wallboxSki, { watts: 6000, durationSeconds: 1800 });
+     * ```
+     */
+    setPowerLimit: (ski: string, limit: EebusPowerLimit) => Promise<void>;
+    /**
+     * Get detailed device information including manufacturer, model, and serial number.
+     * Reads the DeviceClassification feature (SPINE).
+     * @param ski Subject Key Identifier of the target device
+     * @returns Device classification details
+     */
+    getDeviceDetails: (ski: string) => Promise<EebusDeviceDetails>;
+    /**
+     * Register a handler for incoming power limit commands (appliance role).
+     * When this device acts as an appliance, a remote energy manager may send
+     * power limit commands via LoadControl. This handler is invoked for each incoming command.
+     * @param handler Callback invoked with the sender's SKI and the power limit received
+     * @returns Listener ID that can be passed to {@link removeListener} to deregister the handler
+     *
+     * @example
+     * ```typescript
+     * eebus.onPowerLimitReceived((ski, limit) => {
+     *   console.log(`Energy manager ${ski} requests limit: ${limit.watts}W`);
+     *   applyChargingLimit(limit.watts);
+     * });
+     * ```
+     */
+    onPowerLimitReceived: (handler: (ski: string, limit: EebusPowerLimit) => void) => string;
+    /**
+     * Register a handler to provide power consumption data on request (appliance role).
+     * When this device acts as an appliance, a remote energy manager may request
+     * the current power consumption. The handler should return the current value in Watts.
+     * @param handler Async callback invoked with the requester's SKI, returning power in Watts
+     * @returns Listener ID that can be passed to {@link removeListener} to deregister the handler
+     *
+     * @example
+     * ```typescript
+     * eebus.onPowerConsumptionRequested(async (ski) => {
+     *   return getCurrentChargingPowerWatts();
+     * });
+     * ```
+     */
+    onPowerConsumptionRequested: (handler: (ski: string) => Promise<number>) => string;
+    /**
+     * Remove a previously registered listener, subscription, or handler.
+     * Works for IDs returned by {@link listenForConnectionStatusChange}, {@link subscribe},
+     * {@link onPowerLimitReceived}, and {@link onPowerConsumptionRequested}.
+     * @param listenerId The ID returned by the registration method
+     */
+    removeListener: (listenerId: string) => void;
+}

package/dist/cjs/types/enyo-eebus.cjs

@@ -0,0 +1,36 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.EebusFeatureTypeEnum = exports.EebusConnectionStatusEnum = void 0;
+/**
+ * Enum representing the connection status of an EEbus device.
+ */
+var EebusConnectionStatusEnum;
+(function (EebusConnectionStatusEnum) {
+    /** The device is actively connected via SHIP */
+    EebusConnectionStatusEnum["Connected"] = "connected";
+    /** The device is not connected */
+    EebusConnectionStatusEnum["Disconnected"] = "disconnected";
+    /** A SHIP connection is currently being established */
+    EebusConnectionStatusEnum["Connecting"] = "connecting";
+})(EebusConnectionStatusEnum || (exports.EebusConnectionStatusEnum = EebusConnectionStatusEnum = {}));
+/**
+ * Enum representing EEbus SPINE feature types for low-level data access.
+ * These map to the functional model feature types defined in the SPINE specification.
+ */
+var EebusFeatureTypeEnum;
+(function (EebusFeatureTypeEnum) {
+    /** Device manufacturer, model, serial number */
+    EebusFeatureTypeEnum["DeviceClassification"] = "DeviceClassification";
+    /** Device operational state and diagnostics */
+    EebusFeatureTypeEnum["DeviceDiagnosis"] = "DeviceDiagnosis";
+    /** Electrical connection parameters (voltage, current, power limits) */
+    EebusFeatureTypeEnum["ElectricalConnection"] = "ElectricalConnection";
+    /** Measurement data (power, energy, temperature) */
+    EebusFeatureTypeEnum["Measurement"] = "Measurement";
+    /** Load control limits and obligations */
+    EebusFeatureTypeEnum["LoadControl"] = "LoadControl";
+    /** Device configuration key-value pairs */
+    EebusFeatureTypeEnum["DeviceConfiguration"] = "DeviceConfiguration";
+    /** Device and entity identification */
+    EebusFeatureTypeEnum["Identification"] = "Identification";
+})(EebusFeatureTypeEnum || (exports.EebusFeatureTypeEnum = EebusFeatureTypeEnum = {}));

package/dist/cjs/types/enyo-eebus.d.cts

@@ -0,0 +1,100 @@
+/**
+ * Enum representing the connection status of an EEbus device.
+ */
+export declare enum EebusConnectionStatusEnum {
+    /** The device is actively connected via SHIP */
+    Connected = "connected",
+    /** The device is not connected */
+    Disconnected = "disconnected",
+    /** A SHIP connection is currently being established */
+    Connecting = "connecting"
+}
+/**
+ * Enum representing EEbus SPINE feature types for low-level data access.
+ * These map to the functional model feature types defined in the SPINE specification.
+ */
+export declare enum EebusFeatureTypeEnum {
+    /** Device manufacturer, model, serial number */
+    DeviceClassification = "DeviceClassification",
+    /** Device operational state and diagnostics */
+    DeviceDiagnosis = "DeviceDiagnosis",
+    /** Electrical connection parameters (voltage, current, power limits) */
+    ElectricalConnection = "ElectricalConnection",
+    /** Measurement data (power, energy, temperature) */
+    Measurement = "Measurement",
+    /** Load control limits and obligations */
+    LoadControl = "LoadControl",
+    /** Device configuration key-value pairs */
+    DeviceConfiguration = "DeviceConfiguration",
+    /** Device and entity identification */
+    Identification = "Identification"
+}
+/**
+ * Represents an EEbus device that has been successfully paired (trusted).
+ */
+export interface EebusDevice {
+    /** Subject Key Identifier — unique cryptographic identifier for the device */
+    ski: string;
+    /** Human-readable device name */
+    deviceName: string;
+    /** Device brand or model description, if available */
+    deviceModel?: string;
+    /** Current connection status of the device */
+    connectionStatus: EebusConnectionStatusEnum;
+    /** Timestamp of when the pairing (trust) was established */
+    pairedAt: Date;
+    /** Timestamp of the last successful communication with the device */
+    lastSeen?: Date;
+}
+/**
+ * Represents a device discovered on the network via mDNS that has not yet been paired.
+ */
+export interface EebusDiscoveredDevice {
+    /** Subject Key Identifier — unique cryptographic identifier for the device */
+    ski: string;
+    /** Human-readable device name advertised during discovery */
+    deviceName?: string;
+    /** IP address or hostname of the device */
+    host: string;
+    /** Port number for the SHIP connection */
+    port: number;
+}
+/**
+ * Detailed device information retrieved from the EEbus Device Classification feature.
+ */
+export interface EebusDeviceDetails {
+    /** Device manufacturer name */
+    manufacturer?: string;
+    /** Device model name */
+    model?: string;
+    /** Device serial number */
+    serialNumber?: string;
+    /** Firmware or software version of the device */
+    softwareVersion?: string;
+    /** Hardware version of the device */
+    hardwareVersion?: string;
+    /** Device type description */
+    deviceType?: string;
+}
+/**
+ * Represents a data point read from an EEbus device via the low-level SPINE API.
+ */
+export interface EebusDataPoint {
+    /** The value of the data point */
+    value: unknown;
+    /** Timestamp when the value was read or last updated */
+    timestamp: Date;
+    /** Unit of measurement, if applicable (e.g. "W", "Wh", "°C") */
+    unit?: string;
+}
+/**
+ * Represents a power limit command to be sent to or received from an EEbus device.
+ */
+export interface EebusPowerLimit {
+    /** Power limit in Watts */
+    watts: number;
+    /** Whether this limit is an obligation (true) or a recommendation (false). Defaults to true. */
+    isObligatory?: boolean;
+    /** Duration in seconds for which the limit applies. 0 or undefined means indefinite. */
+    durationSeconds?: number;
+}

package/dist/cjs/version.cjs

@@ -9,7 +9,7 @@ exports.getSdkVersion = getSdkVersion;
 /**
  * Current version of the enyo Energy App SDK.
  */
-exports.SDK_VERSION = '0.0.77';
+exports.SDK_VERSION = '0.0.78';
 /**
  * Gets the current SDK version.
  * @returns The semantic version string of the SDK

package/dist/cjs/version.d.cts

@@ -5,7 +5,7 @@
 /**
  * Current version of the enyo Energy App SDK.
  */
-export declare const SDK_VERSION = "0.0.77";
+export declare const SDK_VERSION = "0.0.78";
 /**
  * Gets the current SDK version.
  * @returns The semantic version string of the SDK

package/dist/energy-app-permission.type.d.ts

@@ -1,4 +1,4 @@
-export type EnergyAppPermissionType = 'RestrictedInternetAccess' | 'NetworkDeviceDiscovery' | 'NetworkDeviceSearch' | 'NetworkDeviceAccess' | 'Modbus' | 'Storage' | 'Appliance' | 'AllAppliances' | 'SendDataBusValues' | 'SubscribeDataBus' | 'SendDataBusCommands' | 'OcppServer' | 'ChargingCard' | 'Vehicle' | 'Charge' | 'SecretManager' | 'LocationZipCode' | 'LocationCoordinates' | 'Timeseries' | 'EnergyManagerInfo' | 'ElectricityTariff' | 'WeatherForecastRegister' | 'WeatherForecastUse' | 'PvForecastRegister' | 'PvForecastUse' | 'PvSystemRegister' | 'PvSystemUse' | 'InverterControlCommands' | 'BatteryControlCommands' | 'ChargerControlCommands' | 'ModbusRtu' | 'EnergyPrices' | 'EnergyManager';
+export type EnergyAppPermissionType = 'RestrictedInternetAccess' | 'NetworkDeviceDiscovery' | 'NetworkDeviceSearch' | 'NetworkDeviceAccess' | 'Modbus' | 'Storage' | 'Appliance' | 'AllAppliances' | 'SendDataBusValues' | 'SubscribeDataBus' | 'SendDataBusCommands' | 'OcppServer' | 'ChargingCard' | 'Vehicle' | 'Charge' | 'SecretManager' | 'LocationZipCode' | 'LocationCoordinates' | 'Timeseries' | 'EnergyManagerInfo' | 'ElectricityTariff' | 'WeatherForecastRegister' | 'WeatherForecastUse' | 'PvForecastRegister' | 'PvForecastUse' | 'PvSystemRegister' | 'PvSystemUse' | 'InverterControlCommands' | 'BatteryControlCommands' | 'ChargerControlCommands' | 'ModbusRtu' | 'EnergyPrices' | 'EnergyManager' | 'EebusDeviceManagement' | 'EebusDataAccess' | 'EebusControl';
 export declare enum EnergyAppPermissionTypeEnum {
     RestrictedInternetAccess = "RestrictedInternetAccess",
     NetworkDeviceDiscovery = "NetworkDeviceDiscovery",
@@ -32,5 +32,8 @@ export declare enum EnergyAppPermissionTypeEnum {
     PvSystemUse = "PvSystemUse",
     InverterControlCommands = "InverterControlCommands",
     BatteryControlCommands = "BatteryControlCommands",
-    ChargerControlCommands = "ChargerControlCommands"
+    ChargerControlCommands = "ChargerControlCommands",
+    EebusDeviceManagement = "EebusDeviceManagement",
+    EebusDataAccess = "EebusDataAccess",
+    EebusControl = "EebusControl"
 }

package/dist/energy-app-permission.type.js

@@ -33,4 +33,7 @@ export var EnergyAppPermissionTypeEnum;
     EnergyAppPermissionTypeEnum["InverterControlCommands"] = "InverterControlCommands";
     EnergyAppPermissionTypeEnum["BatteryControlCommands"] = "BatteryControlCommands";
     EnergyAppPermissionTypeEnum["ChargerControlCommands"] = "ChargerControlCommands";
+    EnergyAppPermissionTypeEnum["EebusDeviceManagement"] = "EebusDeviceManagement";
+    EnergyAppPermissionTypeEnum["EebusDataAccess"] = "EebusDataAccess";
+    EnergyAppPermissionTypeEnum["EebusControl"] = "EebusControl";
 })(EnergyAppPermissionTypeEnum || (EnergyAppPermissionTypeEnum = {}));

package/dist/enyo-energy-app-sdk.d.ts

@@ -24,6 +24,7 @@ import { EnergyAppPvForecasting } from "./packages/energy-app-pv-forecasting.js"
 import { EnergyAppPvSystem } from "./packages/energy-app-pv-system.js";
 import { EnergyAppSequenceGenerator } from "./packages/energy-app-sequence-generator.js";
 import { EnergyAppModbusRtu } from "./packages/energy-app-modbus-rtu.js";
+import { EnergyAppEebus } from "./packages/energy-app-eebus.js";
 export declare enum EnergyAppStateEnum {
     Launching = "launching",
     Running = "running",
@@ -98,4 +99,6 @@ export interface EnyoEnergyAppSdk {
     useSequenceGenerator: () => EnergyAppSequenceGenerator;
     /** Get the Modbus RTU serial communication API */
     useModbusRtu: () => EnergyAppModbusRtu;
+    /** Get the EEbus SHIP/SPINE communication API for device pairing, data access, and power management */
+    useEebus: () => EnergyAppEebus;
 }

package/dist/index.d.ts

@@ -25,6 +25,7 @@ import { EnergyAppPvForecasting } from "./packages/energy-app-pv-forecasting.js"
 import { EnergyAppPvSystem } from "./packages/energy-app-pv-system.js";
 import { EnergyAppSequenceGenerator } from "./packages/energy-app-sequence-generator.js";
 import { EnergyAppModbusRtu } from "./packages/energy-app-modbus-rtu.js";
+import { EnergyAppEebus } from "./packages/energy-app-eebus.js";
 export * from './energy-app-package-definition.js';
 export * from './version.js';
 export * from './implementations/ocpp/ocpp16.js';
@@ -55,6 +56,8 @@ export * from './types/enyo-currency.js';
 export * from './packages/energy-app-sequence-generator.js';
 export * from './packages/energy-app-energy-prices.js';
 export * from './packages/energy-app-modbus-rtu.js';
+export * from './types/enyo-eebus.js';
+export * from './packages/energy-app-eebus.js';
 export declare class EnergyApp implements EnyoEnergyAppSdk {
     private readonly energyAppSdk;
     constructor();
@@ -143,6 +146,14 @@ export declare class EnergyApp implements EnyoEnergyAppSdk {
      * @returns The Modbus RTU API instance
      */
     useModbusRtu(): EnergyAppModbusRtu;
+    /**
+     * Gets the EEbus API for SHIP/SPINE device communication.
+     * Provides device pairing and discovery, low-level SPINE data access,
+     * and high-level convenience methods for power management and device classification.
+     * Supports both appliance and energy manager roles for bidirectional communication.
+     * @returns The EEbus API instance
+     */
+    useEebus(): EnergyAppEebus;
     /**
      * Gets the current SDK version.
      * @returns The semantic version string of the SDK

package/dist/index.js

@@ -29,6 +29,8 @@ export * from './types/enyo-currency.js';
 export * from './packages/energy-app-sequence-generator.js';
 export * from './packages/energy-app-energy-prices.js';
 export * from './packages/energy-app-modbus-rtu.js';
+export * from './types/enyo-eebus.js';
+export * from './packages/energy-app-eebus.js';
 export class EnergyApp {
     energyAppSdk;
     constructor() {
@@ -194,6 +196,16 @@ export class EnergyApp {
     useModbusRtu() {
         return this.energyAppSdk.useModbusRtu();
     }
+    /**
+     * Gets the EEbus API for SHIP/SPINE device communication.
+     * Provides device pairing and discovery, low-level SPINE data access,
+     * and high-level convenience methods for power management and device classification.
+     * Supports both appliance and energy manager roles for bidirectional communication.
+     * @returns The EEbus API instance
+     */
+    useEebus() {
+        return this.energyAppSdk.useEebus();
+    }
     /**
      * Gets the current SDK version.
      * @returns The semantic version string of the SDK

package/dist/packages/energy-app-eebus.d.ts

@@ -0,0 +1,176 @@
+import { EebusConnectionStatusEnum, EebusDataPoint, EebusDevice, EebusDeviceDetails, EebusDiscoveredDevice, EebusFeatureTypeEnum, EebusPowerLimit } from "../types/enyo-eebus.js";
+/**
+ * Interface for EEbus (SHIP/SPINE) device communication in enyo packages.
+ *
+ * Provides three layers of API:
+ * - **Device Management**: Pairing, connecting, and managing EEbus devices
+ * - **Low-Level API**: Direct SPINE feature data read/write/subscribe operations
+ * - **High-Level API**: Convenient methods for common energy use cases (power consumption, power limits, device details)
+ *
+ * The high-level API supports both directions of communication:
+ * - **Energy Manager role**: Reads power consumption from appliances and sends power limit commands
+ * - **Appliance role**: Receives power limit commands and provides power consumption data via registered handlers
+ *
+ * @example
+ * ```typescript
+ * const eebus = energyApp.useEebus();
+ *
+ * // Discover and pair a device
+ * const discovered = await eebus.getDiscoveredDevices();
+ * const device = await eebus.pairDevice(discovered[0].ski);
+ *
+ * // Connect and read power (Energy Manager role)
+ * await eebus.connect(device.ski);
+ * const watts = await eebus.getPowerConsumption(device.ski);
+ *
+ * // Receive power limits (Appliance role)
+ * eebus.onPowerLimitReceived((ski, limit) => {
+ *   console.log(`Received limit: ${limit.watts}W from ${ski}`);
+ * });
+ * ```
+ */
+export interface EnergyAppEebus {
+    /**
+     * Get all devices that have been successfully paired (trusted).
+     * @returns Array of paired EEbus devices with their current connection status
+     */
+    getPairedDevices: () => Promise<EebusDevice[]>;
+    /**
+     * Get devices currently visible on the network that have not yet been paired.
+     * Uses mDNS discovery to find EEbus-capable devices.
+     * @returns Array of discovered but unpaired EEbus devices
+     */
+    getDiscoveredDevices: () => Promise<EebusDiscoveredDevice[]>;
+    /**
+     * Initiate the EEbus pairing (trust) handshake with a device identified by its SKI.
+     * The device must have been previously discovered via {@link getDiscoveredDevices}.
+     * @param ski Subject Key Identifier of the device to pair with
+     * @returns The newly paired device
+     */
+    pairDevice: (ski: string) => Promise<EebusDevice>;
+    /**
+     * Remove the trust relationship and delete stored connection information for a paired device.
+     * If the device is currently connected, it will be disconnected first.
+     * @param ski Subject Key Identifier of the device to unpair
+     */
+    unpairDevice: (ski: string) => Promise<void>;
+    /**
+     * Establish an active SHIP connection to an already-paired device.
+     * The device must have been previously paired via {@link pairDevice}.
+     * @param ski Subject Key Identifier of the device to connect to
+     */
+    connect: (ski: string) => Promise<void>;
+    /**
+     * Safely disconnect from a currently connected device.
+     * @param ski Subject Key Identifier of the device to disconnect from
+     */
+    disconnect: (ski: string) => Promise<void>;
+    /**
+     * Check the current connection status of a device.
+     * @param ski Subject Key Identifier of the device to check
+     * @returns The current connection status (Connected, Disconnected, or Connecting)
+     */
+    getConnectionStatus: (ski: string) => Promise<EebusConnectionStatusEnum>;
+    /**
+     * Register a listener for connection status changes of EEbus devices.
+     * The listener is invoked whenever any paired device's connection status changes.
+     * @param listener Callback invoked with the device SKI and its new connection status
+     * @returns Listener ID that can be passed to {@link removeListener} to stop listening
+     */
+    listenForConnectionStatusChange: (listener: (ski: string, status: EebusConnectionStatusEnum) => void) => string;
+    /**
+     * Read specific data points from a device's SPINE feature.
+     * @param ski Subject Key Identifier of the target device
+     * @param featureType The SPINE feature type to read from
+     * @param functionName The specific function or data set to read (e.g. "measurementListData")
+     * @returns The data point containing the value, timestamp, and optional unit
+     */
+    readData: (ski: string, featureType: EebusFeatureTypeEnum, functionName: string) => Promise<EebusDataPoint>;
+    /**
+     * Write data or send a command to a device's SPINE feature.
+     * @param ski Subject Key Identifier of the target device
+     * @param featureType The SPINE feature type to write to
+     * @param functionName The specific function or command to invoke (e.g. "loadControlLimitListData")
+     * @param payload The data payload to send
+     */
+    writeData: (ski: string, featureType: EebusFeatureTypeEnum, functionName: string, payload: unknown) => Promise<void>;
+    /**
+     * Subscribe to automatic notifications when a SPINE feature's data changes on the remote device.
+     * Sets up a SPINE binding so the local device is notified whenever the subscribed data changes.
+     * @param ski Subject Key Identifier of the target device
+     * @param featureType The SPINE feature type to subscribe to
+     * @param listener Callback invoked with updated data whenever the value changes
+     * @returns Listener ID that can be passed to {@link removeListener} to cancel the subscription
+     */
+    subscribe: (ski: string, featureType: EebusFeatureTypeEnum, listener: (data: EebusDataPoint) => void) => string;
+    /**
+     * Get the current active power consumption of a remote device in Watts.
+     * Reads the Measurement feature (SPINE) for active power data.
+     * Intended for the **energy manager role** — reading consumption from a remote appliance.
+     * @param ski Subject Key Identifier of the target device
+     * @returns Current power consumption in Watts
+     */
+    getPowerConsumption: (ski: string) => Promise<number>;
+    /**
+     * Send a power limit command to a consumer device (e.g. a wallbox).
+     * Uses the LoadControl feature (SPINE) to set consumption limits.
+     * Intended for the **energy manager role** — sending limits to a remote appliance.
+     * @param ski Subject Key Identifier of the target device
+     * @param limit The power limit to apply, including watts and optional duration
+     *
+     * @example
+     * ```typescript
+     * // Limit a wallbox to 11kW
+     * await eebus.setPowerLimit(wallboxSki, { watts: 11000 });
+     *
+     * // Temporary limit for 30 minutes
+     * await eebus.setPowerLimit(wallboxSki, { watts: 6000, durationSeconds: 1800 });
+     * ```
+     */
+    setPowerLimit: (ski: string, limit: EebusPowerLimit) => Promise<void>;
+    /**
+     * Get detailed device information including manufacturer, model, and serial number.
+     * Reads the DeviceClassification feature (SPINE).
+     * @param ski Subject Key Identifier of the target device
+     * @returns Device classification details
+     */
+    getDeviceDetails: (ski: string) => Promise<EebusDeviceDetails>;
+    /**
+     * Register a handler for incoming power limit commands (appliance role).
+     * When this device acts as an appliance, a remote energy manager may send
+     * power limit commands via LoadControl. This handler is invoked for each incoming command.
+     * @param handler Callback invoked with the sender's SKI and the power limit received
+     * @returns Listener ID that can be passed to {@link removeListener} to deregister the handler
+     *
+     * @example
+     * ```typescript
+     * eebus.onPowerLimitReceived((ski, limit) => {
+     *   console.log(`Energy manager ${ski} requests limit: ${limit.watts}W`);
+     *   applyChargingLimit(limit.watts);
+     * });
+     * ```
+     */
+    onPowerLimitReceived: (handler: (ski: string, limit: EebusPowerLimit) => void) => string;
+    /**
+     * Register a handler to provide power consumption data on request (appliance role).
+     * When this device acts as an appliance, a remote energy manager may request
+     * the current power consumption. The handler should return the current value in Watts.
+     * @param handler Async callback invoked with the requester's SKI, returning power in Watts
+     * @returns Listener ID that can be passed to {@link removeListener} to deregister the handler
+     *
+     * @example
+     * ```typescript
+     * eebus.onPowerConsumptionRequested(async (ski) => {
+     *   return getCurrentChargingPowerWatts();
+     * });
+     * ```
+     */
+    onPowerConsumptionRequested: (handler: (ski: string) => Promise<number>) => string;
+    /**
+     * Remove a previously registered listener, subscription, or handler.
+     * Works for IDs returned by {@link listenForConnectionStatusChange}, {@link subscribe},
+     * {@link onPowerLimitReceived}, and {@link onPowerConsumptionRequested}.
+     * @param listenerId The ID returned by the registration method
+     */
+    removeListener: (listenerId: string) => void;
+}

package/dist/packages/energy-app-eebus.js

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

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

@@ -0,0 +1,100 @@
+/**
+ * Enum representing the connection status of an EEbus device.
+ */
+export declare enum EebusConnectionStatusEnum {
+    /** The device is actively connected via SHIP */
+    Connected = "connected",
+    /** The device is not connected */
+    Disconnected = "disconnected",
+    /** A SHIP connection is currently being established */
+    Connecting = "connecting"
+}
+/**
+ * Enum representing EEbus SPINE feature types for low-level data access.
+ * These map to the functional model feature types defined in the SPINE specification.
+ */
+export declare enum EebusFeatureTypeEnum {
+    /** Device manufacturer, model, serial number */
+    DeviceClassification = "DeviceClassification",
+    /** Device operational state and diagnostics */
+    DeviceDiagnosis = "DeviceDiagnosis",
+    /** Electrical connection parameters (voltage, current, power limits) */
+    ElectricalConnection = "ElectricalConnection",
+    /** Measurement data (power, energy, temperature) */
+    Measurement = "Measurement",
+    /** Load control limits and obligations */
+    LoadControl = "LoadControl",
+    /** Device configuration key-value pairs */
+    DeviceConfiguration = "DeviceConfiguration",
+    /** Device and entity identification */
+    Identification = "Identification"
+}
+/**
+ * Represents an EEbus device that has been successfully paired (trusted).
+ */
+export interface EebusDevice {
+    /** Subject Key Identifier — unique cryptographic identifier for the device */
+    ski: string;
+    /** Human-readable device name */
+    deviceName: string;
+    /** Device brand or model description, if available */
+    deviceModel?: string;
+    /** Current connection status of the device */
+    connectionStatus: EebusConnectionStatusEnum;
+    /** Timestamp of when the pairing (trust) was established */
+    pairedAt: Date;
+    /** Timestamp of the last successful communication with the device */
+    lastSeen?: Date;
+}
+/**
+ * Represents a device discovered on the network via mDNS that has not yet been paired.
+ */
+export interface EebusDiscoveredDevice {
+    /** Subject Key Identifier — unique cryptographic identifier for the device */
+    ski: string;
+    /** Human-readable device name advertised during discovery */
+    deviceName?: string;
+    /** IP address or hostname of the device */
+    host: string;
+    /** Port number for the SHIP connection */
+    port: number;
+}
+/**
+ * Detailed device information retrieved from the EEbus Device Classification feature.
+ */
+export interface EebusDeviceDetails {
+    /** Device manufacturer name */
+    manufacturer?: string;
+    /** Device model name */
+    model?: string;
+    /** Device serial number */
+    serialNumber?: string;
+    /** Firmware or software version of the device */
+    softwareVersion?: string;
+    /** Hardware version of the device */
+    hardwareVersion?: string;
+    /** Device type description */
+    deviceType?: string;
+}
+/**
+ * Represents a data point read from an EEbus device via the low-level SPINE API.
+ */
+export interface EebusDataPoint {
+    /** The value of the data point */
+    value: unknown;
+    /** Timestamp when the value was read or last updated */
+    timestamp: Date;
+    /** Unit of measurement, if applicable (e.g. "W", "Wh", "°C") */
+    unit?: string;
+}
+/**
+ * Represents a power limit command to be sent to or received from an EEbus device.
+ */
+export interface EebusPowerLimit {
+    /** Power limit in Watts */
+    watts: number;
+    /** Whether this limit is an obligation (true) or a recommendation (false). Defaults to true. */
+    isObligatory?: boolean;
+    /** Duration in seconds for which the limit applies. 0 or undefined means indefinite. */
+    durationSeconds?: number;
+}

package/dist/types/enyo-eebus.js

@@ -0,0 +1,33 @@
+/**
+ * Enum representing the connection status of an EEbus device.
+ */
+export var EebusConnectionStatusEnum;
+(function (EebusConnectionStatusEnum) {
+    /** The device is actively connected via SHIP */
+    EebusConnectionStatusEnum["Connected"] = "connected";
+    /** The device is not connected */
+    EebusConnectionStatusEnum["Disconnected"] = "disconnected";
+    /** A SHIP connection is currently being established */
+    EebusConnectionStatusEnum["Connecting"] = "connecting";
+})(EebusConnectionStatusEnum || (EebusConnectionStatusEnum = {}));
+/**
+ * Enum representing EEbus SPINE feature types for low-level data access.
+ * These map to the functional model feature types defined in the SPINE specification.
+ */
+export var EebusFeatureTypeEnum;
+(function (EebusFeatureTypeEnum) {
+    /** Device manufacturer, model, serial number */
+    EebusFeatureTypeEnum["DeviceClassification"] = "DeviceClassification";
+    /** Device operational state and diagnostics */
+    EebusFeatureTypeEnum["DeviceDiagnosis"] = "DeviceDiagnosis";
+    /** Electrical connection parameters (voltage, current, power limits) */
+    EebusFeatureTypeEnum["ElectricalConnection"] = "ElectricalConnection";
+    /** Measurement data (power, energy, temperature) */
+    EebusFeatureTypeEnum["Measurement"] = "Measurement";
+    /** Load control limits and obligations */
+    EebusFeatureTypeEnum["LoadControl"] = "LoadControl";
+    /** Device configuration key-value pairs */
+    EebusFeatureTypeEnum["DeviceConfiguration"] = "DeviceConfiguration";
+    /** Device and entity identification */
+    EebusFeatureTypeEnum["Identification"] = "Identification";
+})(EebusFeatureTypeEnum || (EebusFeatureTypeEnum = {}));

package/dist/version.d.ts

@@ -5,7 +5,7 @@
 /**
  * Current version of the enyo Energy App SDK.
  */
-export declare const SDK_VERSION = "0.0.77";
+export declare const SDK_VERSION = "0.0.78";
 /**
  * Gets the current SDK version.
  * @returns The semantic version string of the SDK

package/dist/version.js

@@ -5,7 +5,7 @@
 /**
  * Current version of the enyo Energy App SDK.
  */
-export const SDK_VERSION = '0.0.77';
+export const SDK_VERSION = '0.0.78';
 /**
  * Gets the current SDK version.
  * @returns The semantic version string of the SDK

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@enyo-energy/energy-app-sdk",
-  "version": "0.0.77",
+  "version": "0.0.78",
   "description": "enyo Energy App SDK",
   "type": "module",
   "main": "dist/index.js",