@enyo-energy/energy-app-sdk 0.0.168 → 0.0.170

package/dist/cjs/energy-app-package-definition.d.cts

@@ -97,6 +97,46 @@ export interface EnergyAppPackageOptionsDeviceDetectionMqtt {
     /** Matching values to identify the device */
     matchingValues: string[];
 }
+/**
+ * Optional device detection configuration for UDP broadcast probing.
+ * The host broadcasts the probe message on the local network and matches a
+ * JSON field in each response against the expected values to identify the
+ * device.
+ *
+ * @example
+ * // Detect Marstek Venus batteries answering on port 30000:
+ * {
+ *   port: 30000,
+ *   message: { id: 0, method: 'Marstek.GetDevice', params: { ble_mac: '0' } },
+ *   field: 'src',
+ *   operation: 'startsWith',
+ *   matchingValues: ['VenusC'],
+ * }
+ */
+export interface EnergyAppPackageOptionsDeviceDetectionUdp {
+    /**
+     * Destination UDP port the device listens on. The probe is broadcast to
+     * this port (e.g. 30000 for Marstek Venus); responses are read from the
+     * datagrams the device sends back. Required — a UDP broadcast always needs
+     * a destination port.
+     */
+    port: number;
+    /**
+     * The probe message to broadcast. Provide a JSON-serializable object
+     * (sent as its JSON string) or a raw string payload.
+     */
+    message: Record<string, unknown> | string;
+    /**
+     * JSON field path in the response to match against. Supports dot notation
+     * for nested keys (e.g. `'src'` or `'result.device'`). If omitted, the
+     * entire response payload is matched.
+     */
+    field?: string;
+    /** The matching operation to perform on the response field value */
+    operation: 'eq' | 'startsWith';
+    /** Values to match the response field value against */
+    matchingValues: string[];
+}
 /**
  * Optional device detection configuration
  */
@@ -108,6 +148,7 @@ export interface EnergyAppPackageOptionsDeviceDetection {
     eebus?: EnergyAppPackageOptionsDeviceDetectionEebus[];
     mqtt?: EnergyAppPackageOptionsDeviceDetectionMqtt[];
     mdns?: EnergyAppPackageOptionsDeviceDetectionMdns[];
+    udp?: EnergyAppPackageOptionsDeviceDetectionUdp[];
 }
 /**
  * Optional configuration settings for an Energy App package.

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

@@ -12,6 +12,27 @@ export interface ModbusOptions {
     unitId?: number;
     /** Whether to use TLS/SSL for the Modbus connection. Defaults to false (plain Modbus TCP). Set to true to enable Modbus Security (TLS, typically port 802). */
     useTls?: boolean;
+    /**
+     * PEM-encoded client certificate (or Buffer) presented for mutual-TLS Modbus Security
+     * connections. Only used when {@link useTls} is true.
+     */
+    cert?: string | Buffer;
+    /**
+     * PEM-encoded private key (or Buffer) matching {@link cert} for mutual-TLS connections.
+     * Only used when {@link useTls} is true.
+     */
+    key?: string | Buffer;
+    /**
+     * Trusted CA certificate(s) — a PEM string/Buffer, or an array of them — used to verify the
+     * server's certificate. Only used when {@link useTls} is true.
+     */
+    ca?: string | Buffer | Array<string | Buffer>;
+    /**
+     * Whether to reject a TLS connection whose server certificate cannot be verified against
+     * {@link ca}. When omitted, the transport's default verification behaviour is used. Only
+     * used when {@link useTls} is true.
+     */
+    rejectUnauthorized?: boolean;
 }
 /**
  * Interface for Modbus TCP/IP communication in enyo packages.

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

@@ -18,9 +18,11 @@ export interface EnergyAppSettings {
      * This will remove the setting regardless of whether it's for an appliance or the package.
      *
      * @param settingName - The unique name of the setting to remove
+     * @param applianceId - Optional appliance ID. If provided, only the setting scoped to that
+     *   specific appliance is removed. If omitted, the setting is removed regardless of scope.
      * @returns Promise that resolves when the setting is successfully removed
      */
-    removeSettingConfig(settingName: string): Promise<void>;
+    removeSettingConfig(settingName: string, applianceId?: string): Promise<void>;
     /**
      * Updates the value of an existing setting.
      * The setting is identified by its unique name across all appliances and package settings.

package/dist/cjs/types/enyo-network-device.cjs

@@ -9,4 +9,5 @@ var EnyoNetworkDeviceDetectedAtEnum;
     EnyoNetworkDeviceDetectedAtEnum["Modbus"] = "modbus";
     EnyoNetworkDeviceDetectedAtEnum["Http"] = "http";
     EnyoNetworkDeviceDetectedAtEnum["Mdns"] = "mdns";
+    EnyoNetworkDeviceDetectedAtEnum["Udp"] = "udp";
 })(EnyoNetworkDeviceDetectedAtEnum || (exports.EnyoNetworkDeviceDetectedAtEnum = EnyoNetworkDeviceDetectedAtEnum = {}));

package/dist/cjs/types/enyo-network-device.d.cts

@@ -4,7 +4,8 @@ export declare enum EnyoNetworkDeviceDetectedAtEnum {
     Hostname = "hostname",
     Modbus = "modbus",
     Http = "http",
-    Mdns = "mdns"
+    Mdns = "mdns",
+    Udp = "udp"
 }
 /**
  * Represents a detected network device with its connectivity information.

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.168';
+exports.SDK_VERSION = '0.0.170';
 /**
  * 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.168";
+export declare const SDK_VERSION = "0.0.170";
 /**
  * Gets the current SDK version.
  * @returns The semantic version string of the SDK

package/dist/energy-app-package-definition.d.ts

@@ -97,6 +97,46 @@ export interface EnergyAppPackageOptionsDeviceDetectionMqtt {
     /** Matching values to identify the device */
     matchingValues: string[];
 }
+/**
+ * Optional device detection configuration for UDP broadcast probing.
+ * The host broadcasts the probe message on the local network and matches a
+ * JSON field in each response against the expected values to identify the
+ * device.
+ *
+ * @example
+ * // Detect Marstek Venus batteries answering on port 30000:
+ * {
+ *   port: 30000,
+ *   message: { id: 0, method: 'Marstek.GetDevice', params: { ble_mac: '0' } },
+ *   field: 'src',
+ *   operation: 'startsWith',
+ *   matchingValues: ['VenusC'],
+ * }
+ */
+export interface EnergyAppPackageOptionsDeviceDetectionUdp {
+    /**
+     * Destination UDP port the device listens on. The probe is broadcast to
+     * this port (e.g. 30000 for Marstek Venus); responses are read from the
+     * datagrams the device sends back. Required — a UDP broadcast always needs
+     * a destination port.
+     */
+    port: number;
+    /**
+     * The probe message to broadcast. Provide a JSON-serializable object
+     * (sent as its JSON string) or a raw string payload.
+     */
+    message: Record<string, unknown> | string;
+    /**
+     * JSON field path in the response to match against. Supports dot notation
+     * for nested keys (e.g. `'src'` or `'result.device'`). If omitted, the
+     * entire response payload is matched.
+     */
+    field?: string;
+    /** The matching operation to perform on the response field value */
+    operation: 'eq' | 'startsWith';
+    /** Values to match the response field value against */
+    matchingValues: string[];
+}
 /**
  * Optional device detection configuration
  */
@@ -108,6 +148,7 @@ export interface EnergyAppPackageOptionsDeviceDetection {
     eebus?: EnergyAppPackageOptionsDeviceDetectionEebus[];
     mqtt?: EnergyAppPackageOptionsDeviceDetectionMqtt[];
     mdns?: EnergyAppPackageOptionsDeviceDetectionMdns[];
+    udp?: EnergyAppPackageOptionsDeviceDetectionUdp[];
 }
 /**
  * Optional configuration settings for an Energy App package.

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

@@ -12,6 +12,27 @@ export interface ModbusOptions {
     unitId?: number;
     /** Whether to use TLS/SSL for the Modbus connection. Defaults to false (plain Modbus TCP). Set to true to enable Modbus Security (TLS, typically port 802). */
     useTls?: boolean;
+    /**
+     * PEM-encoded client certificate (or Buffer) presented for mutual-TLS Modbus Security
+     * connections. Only used when {@link useTls} is true.
+     */
+    cert?: string | Buffer;
+    /**
+     * PEM-encoded private key (or Buffer) matching {@link cert} for mutual-TLS connections.
+     * Only used when {@link useTls} is true.
+     */
+    key?: string | Buffer;
+    /**
+     * Trusted CA certificate(s) — a PEM string/Buffer, or an array of them — used to verify the
+     * server's certificate. Only used when {@link useTls} is true.
+     */
+    ca?: string | Buffer | Array<string | Buffer>;
+    /**
+     * Whether to reject a TLS connection whose server certificate cannot be verified against
+     * {@link ca}. When omitted, the transport's default verification behaviour is used. Only
+     * used when {@link useTls} is true.
+     */
+    rejectUnauthorized?: boolean;
 }
 /**
  * Interface for Modbus TCP/IP communication in enyo packages.

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

@@ -18,9 +18,11 @@ export interface EnergyAppSettings {
      * This will remove the setting regardless of whether it's for an appliance or the package.
      *
      * @param settingName - The unique name of the setting to remove
+     * @param applianceId - Optional appliance ID. If provided, only the setting scoped to that
+     *   specific appliance is removed. If omitted, the setting is removed regardless of scope.
      * @returns Promise that resolves when the setting is successfully removed
      */
-    removeSettingConfig(settingName: string): Promise<void>;
+    removeSettingConfig(settingName: string, applianceId?: string): Promise<void>;
     /**
      * Updates the value of an existing setting.
      * The setting is identified by its unique name across all appliances and package settings.

package/dist/types/enyo-network-device.d.ts

@@ -4,7 +4,8 @@ export declare enum EnyoNetworkDeviceDetectedAtEnum {
     Hostname = "hostname",
     Modbus = "modbus",
     Http = "http",
-    Mdns = "mdns"
+    Mdns = "mdns",
+    Udp = "udp"
 }
 /**
  * Represents a detected network device with its connectivity information.

package/dist/types/enyo-network-device.js

@@ -6,4 +6,5 @@ export var EnyoNetworkDeviceDetectedAtEnum;
     EnyoNetworkDeviceDetectedAtEnum["Modbus"] = "modbus";
     EnyoNetworkDeviceDetectedAtEnum["Http"] = "http";
     EnyoNetworkDeviceDetectedAtEnum["Mdns"] = "mdns";
+    EnyoNetworkDeviceDetectedAtEnum["Udp"] = "udp";
 })(EnyoNetworkDeviceDetectedAtEnum || (EnyoNetworkDeviceDetectedAtEnum = {}));

package/dist/version.d.ts

@@ -5,7 +5,7 @@
 /**
  * Current version of the enyo Energy App SDK.
  */
-export declare const SDK_VERSION = "0.0.168";
+export declare const SDK_VERSION = "0.0.170";
 /**
  * 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.168';
+export const SDK_VERSION = '0.0.170';
 /**
  * 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.168",
+  "version": "0.0.170",
   "description": "enyo Energy App SDK",
   "type": "module",
   "main": "dist/index.js",