matterbridge 3.4.3-dev-20251209-e6cb85f → 3.4.3

package/dist/matterbridgeEndpointHelpers.d.ts

@@ -0,0 +1,787 @@
+/**
+ * This file contains the helpers for the class MatterbridgeEndpoint.
+ *
+ * @file matterbridgeEndpointHelpers.ts
+ * @author Luca Liguori
+ * @created 2024-10-01
+ * @version 2.1.0
+ * @license Apache-2.0
+ *
+ * Copyright 2024, 2025, 2026 Luca Liguori.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+import { AnsiLogger } from 'node-ansi-logger';
+import { ActionContext, Behavior, Endpoint } from '@matter/node';
+import { ClusterId } from '@matter/types/datatype';
+import { ClusterType } from '@matter/types/cluster';
+import { PowerSource } from '@matter/types/clusters/power-source';
+import { OperationalState } from '@matter/types/clusters/operational-state';
+import { DeviceEnergyManagement } from '@matter/types/clusters/device-energy-management';
+import { DeviceEnergyManagementMode } from '@matter/types/clusters/device-energy-management-mode';
+import { MatterbridgeEndpoint } from './matterbridgeEndpoint.js';
+import { MatterbridgeEndpointCommands } from './matterbridgeEndpointTypes.js';
+/**
+ *  Capitalizes the first letter of a string.
+ *
+ * @param {string} name - The string to capitalize.
+ * @returns {string} The string with the first letter capitalized.
+ */
+export declare function capitalizeFirstLetter(name: string): string;
+/**
+ * Lowercases the first letter of a string.
+ *
+ * @param {string} name - The string to lowercase the first letter of.
+ * @returns {string} The string with the first letter lowercased.
+ */
+export declare function lowercaseFirstLetter(name: string): string;
+/**
+ * Checks if the device name contains non-Latin characters.
+ *
+ * @param {string} deviceName - The name of the device to check.
+ * @returns {boolean} Returns true if the device name contains non-Latin characters, false otherwise.
+ */
+export declare function checkNotLatinCharacters(deviceName: string): boolean;
+/**
+ * Generates a unique ID based on the device name.
+ *
+ * @param {string} deviceName - The name of the device to generate a unique ID for.
+ * @returns {string} A unique ID generated from the device name using MD5 hashing.
+ */
+export declare function generateUniqueId(deviceName: string): string;
+/**
+ * Generates a unique ID based on four parameters.
+ *
+ * @param {string} param1 - The first parameter.
+ * @param {string} param2 - The second parameter.
+ * @param {string} param3 - The third parameter.
+ * @param {string} param4 - The fourth parameter.
+ * @returns {string} A unique ID generated from the concatenation of the parameters using MD5 hashing.
+ */
+export declare function createUniqueId(param1: string, param2: string, param3: string, param4: string): string;
+/**
+ * Retrieves the features for a specific behavior.
+ *
+ * @param {Endpoint} endpoint - The endpoint to retrieve the features from.
+ * @param {Behavior.Type | ClusterType | ClusterId | string} cluster - The cluster to retrieve the features for.
+ *
+ * @returns {Record<string, boolean | undefined>} The features for the specified behavior.
+ *
+ * @remarks Use with:
+ * ```typescript
+ *     expect(featuresFor(device, 'powerSource').wired).toBe(true);
+ * ```
+ */
+export declare function featuresFor(endpoint: MatterbridgeEndpoint, cluster: Behavior.Type | ClusterType | ClusterId | string): Record<string, boolean | undefined>;
+/**
+ * Maps a list of ClusterId to Behavior.Type for server clusters.
+ *
+ * @param {ClusterId[]} clusterServerList - The list of ClusterId to map.
+ * @returns {Behavior.Type[]} An array of Behavior.Type corresponding to the ClusterId in the server list.
+ */
+export declare function getBehaviourTypesFromClusterServerIds(clusterServerList: ClusterId[]): Behavior.Type[];
+/**
+ * Maps a list of ClusterId to Behavior.Type for client clusters.
+ *
+ * @param {ClusterId[]} clusterClientList - The list of ClusterId to map.
+ * @returns {Behavior.Type[]} An array of Behavior.Type corresponding to the ClusterId in the client list.
+ */
+export declare function getBehaviourTypesFromClusterClientIds(clusterClientList: ClusterId[]): Behavior.Type[];
+/**
+ * Maps a ClusterId to a Behavior.Type for server clusters.
+ *
+ * @param {ClusterId} clusterId - The ClusterId to map.
+ * @returns {Behavior.Type} The corresponding Behavior.Type for the given ClusterId.
+ */
+export declare function getBehaviourTypeFromClusterServerId(clusterId: ClusterId): Behavior.Type;
+/**
+ *  Maps a ClusterId to a Behavior.Type for client clusters.
+ *
+ * @param {ClusterId} _clusterId - The ClusterId to map.
+ */
+export declare function getBehaviourTypeFromClusterClientId(_clusterId: ClusterId): void;
+/**
+ *  Retrieves the Behavior.Type for a given cluster from the endpoint's supported behaviors.
+ *
+ * @param {MatterbridgeEndpoint} endpoint - The endpoint to retrieve the behavior from.
+ * @param {Behavior.Type | ClusterType | ClusterId | string} cluster - The cluster to retrieve the behavior for.
+ * @returns {Behavior.Type | undefined} The Behavior.Type for the given cluster, or undefined if not found.
+ */
+export declare function getBehavior(endpoint: MatterbridgeEndpoint, cluster: Behavior.Type | ClusterType | ClusterId | string): Behavior.Type | undefined;
+/**
+ * Invokes a command on the specified behavior of the endpoint. Used ONLY in Jest tests.
+ *
+ * @param {MatterbridgeEndpoint} endpoint - The endpoint to invoke the command on.
+ * @param {Behavior.Type | ClusterType | ClusterId | string} cluster - The cluster to invoke the command on.
+ * @param {keyof MatterbridgeEndpointCommands} command - The command to invoke.
+ * @param {Record<string, boolean | number | bigint | string | object | null>} [params] - The parameters to pass to the command.
+ *
+ * @returns {Promise<boolean>} A promise that resolves to true if the command was invoked successfully, false otherwise.
+ *
+ * @deprecated Used ONLY in Jest tests.
+ */
+export declare function invokeBehaviorCommand(endpoint: MatterbridgeEndpoint, cluster: Behavior.Type | ClusterType | ClusterId | string, command: keyof MatterbridgeEndpointCommands, params?: Record<string, boolean | number | bigint | string | object | null>): Promise<boolean>;
+/**
+ * Invokes the subscription handler on the specified cluster and attribute of the endpoint. Used ONLY in Jest tests.
+ *
+ * @param {MatterbridgeEndpoint} endpoint - The endpoint to invoke the subscription handler on.
+ * @param {Behavior.Type | ClusterType | ClusterId | string} cluster - The cluster to invoke the subscription handler on.
+ * @param {string} attribute - The attribute to invoke the subscription handler on.
+ * @param {unknown} newValue - The new value of the attribute.
+ * @param {unknown} oldValue - The old value of the attribute.
+ *
+ * @returns {Promise<boolean>} A promise that resolves to true if the subscription handler was invoked successfully, false otherwise.
+ *
+ * @deprecated Used ONLY in Jest tests.
+ */
+export declare function invokeSubscribeHandler(endpoint: MatterbridgeEndpoint, cluster: Behavior.Type | ClusterType | ClusterId | string, attribute: string, newValue: unknown, oldValue: unknown): Promise<boolean>;
+/**
+ * Adds required cluster servers to the specified endpoint based on the device types.
+ *
+ * @param {MatterbridgeEndpoint} endpoint - The endpoint to add the required cluster servers to.
+ * @returns {void}
+ */
+export declare function addRequiredClusterServers(endpoint: MatterbridgeEndpoint): void;
+/**
+ * Adds optional cluster servers to the specified endpoint based on the device types.
+ *
+ * @param {MatterbridgeEndpoint} endpoint - The endpoint to add the optional cluster servers to.
+ * @returns {void}
+ */
+export declare function addOptionalClusterServers(endpoint: MatterbridgeEndpoint): void;
+/**
+ * Adds cluster servers to the specified endpoint based on the provided server list.
+ *
+ * @param {MatterbridgeEndpoint} endpoint - The endpoint to add the cluster servers to.
+ * @param {ClusterId[]} serverList - The list of cluster IDs to add.
+ */
+export declare function addClusterServers(endpoint: MatterbridgeEndpoint, serverList: ClusterId[]): void;
+/**
+ * Adds a fixed label to the FixedLabel cluster. The FixedLabel cluster is created if it does not exist.
+ *
+ * @param {MatterbridgeEndpoint} endpoint - The endpoint to add the cluster servers to.
+ * @param {string} label - The label to add. Max 16 characters.
+ * @param {string} value - The value of the label. Max 16 characters.
+ */
+export declare function addFixedLabel(endpoint: MatterbridgeEndpoint, label: string, value: string): Promise<void>;
+/**
+ * Adds a user label to the UserLabel cluster. The UserLabel cluster is created if it does not exist.
+ *
+ * @param {MatterbridgeEndpoint} endpoint - The endpoint to add the cluster servers to.
+ * @param {string} label - The label to add. Max 16 characters.
+ * @param {string} value - The value of the label. Max 16 characters.
+ */
+export declare function addUserLabel(endpoint: MatterbridgeEndpoint, label: string, value: string): Promise<void>;
+/**
+ * Returns the options for a given behavior type.
+ *
+ * @param {T} type - The behavior type.
+ * @param {Behavior.Options<T>} options - The options for the behavior type.
+ * @returns {Behavior.Options<T>} The options for the behavior type.
+ */
+export declare function optionsFor<T extends Behavior.Type>(type: T, options: Behavior.Options<T>): Behavior.Options<T>;
+/**
+ * Retrieves the cluster ID.
+ *
+ * @param {Endpoint} endpoint - The endpoint to retrieve the cluster ID from.
+ * @param {ClusterId} cluster - The ID of the cluster.
+ * @returns {number | undefined} The ID of the cluster.
+ */
+export declare function getClusterId(endpoint: Endpoint, cluster: string): number | undefined;
+/**
+ * Retrieves the ID of an attribute from a cluster behavior.
+ *
+ * @param {Endpoint} endpoint - The endpoint to retrieve the attribute ID from.
+ * @param {string} cluster - The name of the cluster.
+ * @param {string} attribute - The name of the attribute.
+ * @returns {number | undefined} The ID of the attribute, or undefined if not found.
+ */
+export declare function getAttributeId(endpoint: Endpoint, cluster: string, attribute: string): number | undefined;
+/**
+ * Retrieves the value of the provided attribute from the given cluster.
+ *
+ * @param {MatterbridgeEndpoint} endpoint - The endpoint to retrieve the attribute from.
+ * @param {Behavior.Type | ClusterType | ClusterId | string} cluster - The cluster to retrieve the attribute from.
+ * @param {string} attribute - The name of the attribute to retrieve.
+ * @param {AnsiLogger} [log] - (Optional) The logger to use for logging the retrieve. Errors are logged to the endpoint logger.
+ * @returns {any} The value of the attribute, or undefined if the attribute is not found.
+ */
+export declare function getAttribute(endpoint: MatterbridgeEndpoint, cluster: Behavior.Type | ClusterType | ClusterId | string, attribute: string, log?: AnsiLogger): any;
+/**
+ * Sets the value of an attribute on a cluster server.
+ *
+ * @param {MatterbridgeEndpoint} endpoint - The endpoint to set the attribute on.
+ * @param {Behavior.Type | ClusterType | ClusterId | string} cluster - The cluster to set the attribute on.
+ * @param {string} attribute - The name of the attribute.
+ * @param {boolean | number | bigint | string | object | null} value - The value to set for the attribute.
+ * @param {AnsiLogger} [log] - (Optional) The logger to use for logging the set. Errors are logged to the endpoint logger.
+ * @returns {Promise<boolean>} - A promise that resolves to a boolean indicating whether the attribute was successfully set.
+ */
+export declare function setAttribute(endpoint: MatterbridgeEndpoint, cluster: Behavior.Type | ClusterType | ClusterId | string, attribute: string, value: boolean | number | bigint | string | object | null, log?: AnsiLogger): Promise<boolean>;
+/**
+ * Sets the value of an attribute on a cluster server.
+ *
+ * @param {MatterbridgeEndpoint} endpoint - The endpoint to update the attribute on.
+ * @param {Behavior.Type | ClusterType | ClusterId | string} cluster - The cluster to update the attribute on.
+ * @param {string} attribute - The name of the attribute.
+ * @param {boolean | number | bigint | string | object | null} value - The value to set for the attribute.
+ * @param {AnsiLogger} [log] - (Optional) The logger to use for logging the update. Errors are logged to the endpoint logger.
+ * @returns {Promise<boolean>} - A promise that resolves to a boolean indicating whether the attribute was successfully set.
+ */
+export declare function updateAttribute(endpoint: MatterbridgeEndpoint, cluster: Behavior.Type | ClusterType | ClusterId | string, attribute: string, value: boolean | number | bigint | string | object | null, log?: AnsiLogger): Promise<boolean>;
+/**
+ * Subscribes to the provided attribute on a cluster.
+ *
+ * @param {MatterbridgeEndpoint} endpoint - The endpoint to subscribe the attribute to.
+ * @param {Behavior.Type | ClusterType | ClusterId | string} cluster - The cluster to subscribe the attribute to.
+ * @param {string} attribute - The name of the attribute to subscribe to.
+ * @param {(newValue: any, oldValue: any, context: ActionContext) => void} listener - A callback function that will be called when the attribute value changes. When context.offline === true then the change is locally generated and not from the controller.
+ * @param {AnsiLogger} [log] - Optional logger for logging errors and information.
+ * @returns {boolean} - A boolean indicating whether the subscription was successful.
+ *
+ * @remarks The listener function (cannot be async) will receive three parameters:
+ * - `newValue`: The new value of the attribute.
+ * - `oldValue`: The old value of the attribute.
+ * - `context`: The action context, which includes information about the action that triggered the change. When context.offline === true then the change is locally generated and not from the controller.
+ */
+export declare function subscribeAttribute(endpoint: MatterbridgeEndpoint, cluster: Behavior.Type | ClusterType | ClusterId | string, attribute: string, listener: (newValue: any, oldValue: any, context: ActionContext) => void, log?: AnsiLogger): Promise<boolean>;
+/**
+ * Triggers an event on the specified cluster.
+ *
+ * @param {MatterbridgeEndpoint} endpoint - The endpoint to trigger the event on.
+ * @param {Behavior.Type | ClusterType | ClusterId | string} cluster - The ID of the cluster.
+ * @param {string} event - The name of the event to trigger.
+ * @param {Record<string, boolean | number | bigint | string | object | undefined | null>} payload - The payload to pass to the event.
+ * @param {AnsiLogger} [log] - Optional logger for logging information.
+ *
+ * @returns {Promise<boolean>} - A promise that resolves to a boolean indicating whether the event was successfully triggered.
+ */
+export declare function triggerEvent(endpoint: MatterbridgeEndpoint, cluster: Behavior.Type | ClusterType | ClusterId | string, event: string, payload: Record<string, boolean | number | bigint | string | object | undefined | null>, log?: AnsiLogger): Promise<boolean>;
+/** Utility Cluster Helpers */
+/**
+ * Get the default power source wired cluster server options.
+ *
+ * @param {PowerSource.WiredCurrentType} wiredCurrentType - The type of wired current (default: PowerSource.WiredCurrentType.Ac)
+ * @returns {Behavior.Options<PowerSourceClusterServer>} The options for the power source wired cluster server.
+ *
+ * @remarks
+ * - order: The order of the power source is a persisted attribute that indicates the order in which the power sources are used.
+ * - description: The description of the power source is a fixed attribute that describes the power source type.
+ * - wiredCurrentType: The type of wired current is a fixed attribute that indicates the type of wired current used by the power source (AC or DC).
+ */
+export declare function getDefaultPowerSourceWiredClusterServer(wiredCurrentType?: PowerSource.WiredCurrentType): Partial<{
+    status: number;
+    order: number;
+    endpointList: number[];
+    wiredAssessedInputVoltage?: number | null | undefined;
+    wiredAssessedInputFrequency?: number | null | undefined;
+    wiredAssessedCurrent?: number | null | undefined;
+    wiredPresent?: boolean | undefined;
+    activeWiredFaults?: number[] | undefined;
+    description: string;
+    wiredCurrentType: number;
+    wiredNominalVoltage?: number | undefined;
+    wiredMaximumCurrent?: number | undefined;
+}>;
+/**
+ * Get the default power source battery cluster server options.
+ *
+ * @param {null | number} batPercentRemaining - The remaining battery percentage (default: null). The attribute is in the range 0-200.
+ * @param {PowerSource.BatChargeLevel} batChargeLevel - The battery charge level (default: PowerSource.BatChargeLevel.Ok).
+ * @param {null | number} batVoltage - The battery voltage (default: null).
+ * @param {PowerSource.BatReplaceability} batReplaceability - The replaceability of the battery (default: PowerSource.BatReplaceability.Unspecified).
+ * @returns {Behavior.Options<PowerSourceClusterServer>} The options for the power source replaceable battery cluster server.
+ *
+ * @remarks
+ * - order: The order of the power source is a persisted attribute that indicates the order in which the power sources are used.
+ * - description: The description of the power source is a fixed attribute that describes the power source type.
+ * - batReplaceability: The replaceability of the battery is a fixed attribute that indicates whether the battery is user-replaceable or not.
+ */
+export declare function getDefaultPowerSourceBatteryClusterServer(batPercentRemaining?: null | number, batChargeLevel?: PowerSource.BatChargeLevel, batVoltage?: null | number, batReplaceability?: PowerSource.BatReplaceability): Partial<{
+    status: number;
+    order: number;
+    endpointList: number[];
+    batChargeLevel: number;
+    batReplacementNeeded: boolean;
+    batVoltage?: number | null | undefined;
+    batPercentRemaining?: number | null | undefined;
+    batTimeRemaining?: number | null | undefined;
+    batPresent?: boolean | undefined;
+    activeBatFaults?: number[] | undefined;
+    description: string;
+    batReplaceability: number;
+}>;
+/**
+ * Get the default power source replaceable battery cluster server options.
+ *
+ * @param {number} batPercentRemaining - The remaining battery percentage (default: 100). The attribute is in the range 0-200.
+ * @param {PowerSource.BatChargeLevel} batChargeLevel - The battery charge level (default: PowerSource.BatChargeLevel.Ok).
+ * @param {number} batVoltage - The battery voltage (default: 1500).
+ * @param {string} batReplacementDescription - The description of the battery replacement (default: 'Battery type').
+ * @param {number} batQuantity - The quantity of the battery (default: 1).
+ * @param {PowerSource.BatReplaceability} batReplaceability - The replaceability of the battery (default: PowerSource.BatReplaceability.UserReplaceable).
+ * @returns {Behavior.Options<PowerSourceClusterServer>} The options for the power source replaceable battery cluster server.
+ *
+ * @remarks
+ * - order: The order of the power source is a persisted attribute that indicates the order in which the power sources are used.
+ * - description: The description of the power source is a fixed attribute that describes the power source type.
+ * - batReplaceability: The replaceability of the battery is a fixed attribute that indicates whether the battery is user-replaceable or not.
+ * - batReplacementDescription: The description of the battery replacement is a fixed attribute that describes the battery type.
+ * - batQuantity: The quantity of the battery is a fixed attribute that indicates how many batteries are present in the device.
+ */
+export declare function getDefaultPowerSourceReplaceableBatteryClusterServer(batPercentRemaining?: number, batChargeLevel?: PowerSource.BatChargeLevel, batVoltage?: number, batReplacementDescription?: string, batQuantity?: number, batReplaceability?: PowerSource.BatReplaceability): Partial<{
+    status: number;
+    order: number;
+    endpointList: number[];
+    batChargeLevel: number;
+    batReplacementNeeded: boolean;
+    batVoltage?: number | null | undefined;
+    batPercentRemaining?: number | null | undefined;
+    batTimeRemaining?: number | null | undefined;
+    batPresent?: boolean | undefined;
+    activeBatFaults?: number[] | undefined;
+    description: string;
+    batReplaceability: number;
+    batReplacementDescription: string;
+    batQuantity: number;
+    batCommonDesignation?: number | undefined;
+    batAnsiDesignation?: string | undefined;
+    batIecDesignation?: string | undefined;
+    batApprovedChemistry?: number | undefined;
+    batCapacity?: number | undefined;
+}>;
+/**
+ * Creates a default power source rechargeable battery cluster server.
+ *
+ * @param {number} [batPercentRemaining] - The remaining battery percentage (default: 100). The attribute is in the range 0-200.
+ * @param {PowerSource.BatChargeLevel} [batChargeLevel] - The battery charge level (default: PowerSource.BatChargeLevel.Ok).
+ * @param {number} [batVoltage] - The battery voltage in mV (default: 1500).
+ * @param {PowerSource.BatReplaceability} [batReplaceability] - The replaceability of the battery (default: PowerSource.BatReplaceability.Unspecified).
+ * @returns {Behavior.Options<PowerSourceClusterServer>} The options for the power source rechargeable battery cluster server.
+ *
+ * @remarks
+ * - order: The order of the power source is a persisted attribute that indicates the order in which the power sources are used.
+ * - description: The description of the power source is a fixed attribute that describes the power source type.
+ * - batReplaceability: The replaceability of the battery is a fixed attribute that indicates whether the battery is user-replaceable or not.
+ */
+export declare function getDefaultPowerSourceRechargeableBatteryClusterServer(batPercentRemaining?: number, batChargeLevel?: PowerSource.BatChargeLevel, batVoltage?: number, batReplaceability?: PowerSource.BatReplaceability): Partial<{
+    status: number;
+    order: number;
+    endpointList: number[];
+    batChargeLevel: number;
+    batReplacementNeeded: boolean;
+    batChargeState: number;
+    batFunctionalWhileCharging: boolean;
+    batVoltage?: number | null | undefined;
+    batPercentRemaining?: number | null | undefined;
+    batTimeRemaining?: number | null | undefined;
+    batPresent?: boolean | undefined;
+    activeBatFaults?: number[] | undefined;
+    batTimeToFullCharge?: number | null | undefined;
+    batChargingCurrent?: number | null | undefined;
+    activeBatChargeFaults?: number[] | undefined;
+    description: string;
+    batReplaceability: number;
+    batCapacity?: number | undefined;
+}>;
+/**
+ * Get the default Electrical Energy Measurement Cluster Server options with features ImportedEnergy, ExportedEnergy, and CumulativeEnergy.
+ *
+ * @param {number} energyImported - The total consumption value in mW/h.
+ * @param {number} energyExported - The total production value in mW/h.
+ * @returns {Behavior.Options<ElectricalEnergyMeasurementServer>} - The default options for the Electrical Energy Measurement Cluster Server.
+ */
+export declare function getDefaultElectricalEnergyMeasurementClusterServer(energyImported?: number | bigint | null, energyExported?: number | bigint | null): Partial<{
+    cumulativeEnergyImported: {
+        energy: number | bigint;
+        startTimestamp?: number | undefined;
+        endTimestamp?: number | undefined;
+        startSystime?: number | bigint | undefined;
+        endSystime?: number | bigint | undefined;
+    } | null;
+    cumulativeEnergyExported: {
+        energy: number | bigint;
+        startTimestamp?: number | undefined;
+        endTimestamp?: number | undefined;
+        startSystime?: number | bigint | undefined;
+        endSystime?: number | bigint | undefined;
+    } | null;
+    cumulativeEnergyReset?: {
+        importedResetTimestamp?: number | null | undefined;
+        exportedResetTimestamp?: number | null | undefined;
+        importedResetSystime?: number | bigint | null | undefined;
+        exportedResetSystime?: number | bigint | null | undefined;
+    } | null | undefined;
+    accuracy: {
+        measurementType: number;
+        measured: boolean;
+        minMeasuredValue: number | bigint;
+        maxMeasuredValue: number | bigint;
+        accuracyRanges: {
+            rangeMin: number | bigint;
+            rangeMax: number | bigint;
+            percentMax?: number | undefined;
+            percentMin?: number | undefined;
+            percentTypical?: number | undefined;
+            fixedMax?: number | bigint | undefined;
+            fixedMin?: number | bigint | undefined;
+            fixedTypical?: number | bigint | undefined;
+        }[];
+    };
+}>;
+/**
+ * Get the default Electrical Power Measurement Cluster Server options with features AlternatingCurrent.
+ *
+ * @param {number} voltage - The voltage value in millivolts.
+ * @param {number} current - The current value in milliamperes.
+ * @param {number} power - The power value in milliwatts.
+ * @param {number} frequency - The frequency value in millihertz.
+ * @returns {Behavior.Options<ElectricalPowerMeasurementServer>} - The default options for the Electrical Power Measurement Cluster Server.
+ */
+export declare function getDefaultElectricalPowerMeasurementClusterServer(voltage?: number | bigint | null, current?: number | bigint | null, power?: number | bigint | null, frequency?: number | bigint | null): Partial<{
+    powerMode: number;
+    activePower: number | bigint | null;
+    ranges?: {
+        measurementType: number;
+        min: number | bigint;
+        max: number | bigint;
+        startTimestamp?: number | undefined;
+        endTimestamp?: number | undefined;
+        minTimestamp?: number | undefined;
+        maxTimestamp?: number | undefined;
+        startSystime?: number | bigint | undefined;
+        endSystime?: number | bigint | undefined;
+        minSystime?: number | bigint | undefined;
+        maxSystime?: number | bigint | undefined;
+    }[] | undefined;
+    voltage?: number | bigint | null | undefined;
+    activeCurrent?: number | bigint | null | undefined;
+    frequency?: number | bigint | null | undefined;
+    reactiveCurrent?: number | bigint | null | undefined;
+    apparentCurrent?: number | bigint | null | undefined;
+    reactivePower?: number | bigint | null | undefined;
+    apparentPower?: number | bigint | null | undefined;
+    rmsVoltage?: number | bigint | null | undefined;
+    rmsCurrent?: number | bigint | null | undefined;
+    rmsPower?: number | bigint | null | undefined;
+    powerFactor?: number | bigint | null | undefined;
+    numberOfMeasurementTypes: number;
+    accuracy: {
+        measurementType: number;
+        measured: boolean;
+        minMeasuredValue: number | bigint;
+        maxMeasuredValue: number | bigint;
+        accuracyRanges: {
+            rangeMin: number | bigint;
+            rangeMax: number | bigint;
+            percentMax?: number | undefined;
+            percentMin?: number | undefined;
+            percentTypical?: number | undefined;
+            fixedMax?: number | bigint | undefined;
+            fixedMin?: number | bigint | undefined;
+            fixedTypical?: number | bigint | undefined;
+        }[];
+    }[];
+}>;
+/**
+ * Get the default Electrical Apparent Power Measurement Cluster Server with features AlternatingCurrent.
+ *
+ * @param {number} voltage - The voltage value in millivolts.
+ * @param {number} apparentCurrent - The current value in milliamperes.
+ * @param {number} apparentPower - The apparent power value in millivoltamperes.
+ * @param {number} frequency - The frequency value in millihertz.
+ * @returns {Behavior.Options<ElectricalPowerMeasurementServer>} - The default options for the Electrical Apparent Power Measurement Cluster Server.
+ */
+export declare function getApparentElectricalPowerMeasurementClusterServer(voltage?: number | bigint | null, apparentCurrent?: number | bigint | null, apparentPower?: number | bigint | null, frequency?: number | bigint | null): Partial<{
+    powerMode: number;
+    activePower: number | bigint | null;
+    ranges?: {
+        measurementType: number;
+        min: number | bigint;
+        max: number | bigint;
+        startTimestamp?: number | undefined;
+        endTimestamp?: number | undefined;
+        minTimestamp?: number | undefined;
+        maxTimestamp?: number | undefined;
+        startSystime?: number | bigint | undefined;
+        endSystime?: number | bigint | undefined;
+        minSystime?: number | bigint | undefined;
+        maxSystime?: number | bigint | undefined;
+    }[] | undefined;
+    voltage?: number | bigint | null | undefined;
+    activeCurrent?: number | bigint | null | undefined;
+    frequency?: number | bigint | null | undefined;
+    reactiveCurrent?: number | bigint | null | undefined;
+    apparentCurrent?: number | bigint | null | undefined;
+    reactivePower?: number | bigint | null | undefined;
+    apparentPower?: number | bigint | null | undefined;
+    rmsVoltage?: number | bigint | null | undefined;
+    rmsCurrent?: number | bigint | null | undefined;
+    rmsPower?: number | bigint | null | undefined;
+    powerFactor?: number | bigint | null | undefined;
+    numberOfMeasurementTypes: number;
+    accuracy: {
+        measurementType: number;
+        measured: boolean;
+        minMeasuredValue: number | bigint;
+        maxMeasuredValue: number | bigint;
+        accuracyRanges: {
+            rangeMin: number | bigint;
+            rangeMax: number | bigint;
+            percentMax?: number | undefined;
+            percentMin?: number | undefined;
+            percentTypical?: number | undefined;
+            fixedMax?: number | bigint | undefined;
+            fixedMin?: number | bigint | undefined;
+            fixedTypical?: number | bigint | undefined;
+        }[];
+    }[];
+}>;
+/**
+ * Get the default Device Energy Management Cluster Server with feature PowerForecastReporting and with the specified ESA type, ESA canGenerate, ESA state, and power limits.
+ *
+ * @param {DeviceEnergyManagement.EsaType} [esaType] - The ESA type. Defaults to `DeviceEnergyManagement.EsaType.Other`.
+ * @param {boolean} [esaCanGenerate] - Indicates if the ESA can generate energy. Defaults to `false`.
+ * @param {DeviceEnergyManagement.EsaState} [esaState] - The ESA state. Defaults to `DeviceEnergyManagement.EsaState.Online`.
+ * @param {number} [absMinPower] - Indicate the minimum electrical power in mw that the ESA can consume when switched on. Defaults to `0` if not provided.
+ * @param {number} [absMaxPower] - Indicate the maximum electrical power in mw that the ESA can consume when switched on. Defaults to `0` if not provided.
+ * @returns {Behavior.Options<DeviceEnergyManagementClusterServer>} - The default options for the Device Energy Management Cluster Server.
+ *
+ * @remarks
+ * - The forecast attribute is set to null, indicating that there is no forecast currently available.
+ * - The ESA type and canGenerate attributes are fixed and cannot be changed after creation.
+ * - The ESA state is set to Online by default.
+ * - The absolute minimum and maximum power attributes are set to 0 by default.
+ * - For example, a battery storage inverter that can charge its battery at a maximum power of 2000W and can
+ * discharge the battery at a maximum power of 3000W, would have a absMinPower: -3000W, absMaxPower: 2000W.
+ */
+export declare function getDefaultDeviceEnergyManagementClusterServer(esaType?: DeviceEnergyManagement.EsaType, esaCanGenerate?: boolean, esaState?: DeviceEnergyManagement.EsaState, absMinPower?: number, absMaxPower?: number): Partial<{
+    powerAdjustmentCapability: {
+        powerAdjustCapability: {
+            minPower: number | bigint;
+            maxPower: number | bigint;
+            minDuration: number;
+            maxDuration: number;
+        }[] | null;
+        cause: number;
+    } | null;
+    forecast: {
+        forecastId: number;
+        activeSlotNumber: number | null;
+        startTime: number;
+        endTime: number;
+        isPausable: boolean;
+        slots: {
+            minDuration: number;
+            maxDuration: number;
+            defaultDuration: number;
+            elapsedSlotTime: number;
+            remainingSlotTime: number;
+            minPower?: number | bigint | undefined;
+            maxPower?: number | bigint | undefined;
+            slotIsPausable?: boolean | undefined;
+            minPauseDuration?: number | undefined;
+            maxPauseDuration?: number | undefined;
+            manufacturerEsaState?: number | undefined;
+            nominalPower?: number | bigint | undefined;
+            nominalEnergy?: number | bigint | undefined;
+            costs?: {
+                value: number;
+                costType: number;
+                decimalPoints: number;
+                currency?: number | undefined;
+            }[] | undefined;
+            minPowerAdjustment?: number | bigint | undefined;
+            maxPowerAdjustment?: number | bigint | undefined;
+            minDurationAdjustment?: number | undefined;
+            maxDurationAdjustment?: number | undefined;
+        }[];
+        forecastUpdateReason: number;
+        earliestStartTime?: number | null | undefined;
+        latestEndTime?: number | undefined;
+    } | null;
+    optOutState: number;
+    esaState: number;
+    absMinPower: number | bigint;
+    absMaxPower: number | bigint;
+    esaType: number;
+    esaCanGenerate: boolean;
+}>;
+/**
+ * Get the default EnergyManagementMode Cluster Server.
+ *
+ * @param {number} [currentMode] - The current mode of the EnergyManagementMode cluster. Defaults to mode 1 (DeviceEnergyManagementMode.ModeTag.NoOptimization).
+ * @param {EnergyManagementMode.ModeOption[]} [supportedModes] - The supported modes for the DeviceEnergyManagementMode cluster. The attribute is fixed and defaults to a predefined set of cluster modes.
+ * @returns {Behavior.Options<DeviceEnergyManagementModeClusterServer>} - The default options for the Device Energy Management Mode cluster server.
+ *
+ * @remarks
+ * A few examples of Device Energy Management modes and their mode tags are provided below.
+ *  - For the "No Energy Management (Forecast reporting only)" mode, tags: 0x4000 (NoOptimization).
+ *  - For the "Device Energy Management" mode, tags: 0x4001 (DeviceOptimization).
+ *  - For the "Home Energy Management" mode, tags: 0x4001 (DeviceOptimization), 0x4002 (LocalOptimization).
+ *  - For the "Grid Energy Management" mode, tags: 0x4003 (GridOptimization).
+ *  - For the "Full Energy Management" mode, tags: 0x4001 (DeviceOptimization), 0x4002 (LocalOptimization), 0x4003 (GridOptimization).
+ */
+export declare function getDefaultDeviceEnergyManagementModeClusterServer(currentMode?: number, supportedModes?: DeviceEnergyManagementMode.ModeOption[]): Partial<{
+    currentMode: number;
+    supportedModes: {
+        mode: number;
+        label: string;
+        modeTags: {
+            value: number;
+            mfgCode?: number | undefined;
+        }[];
+    }[];
+}>;
+/** Application Cluster Helpers */
+/**
+ * Get the default OperationalState Cluster Server.
+ *
+ * @param {OperationalState.OperationalStateEnum} operationalState - The initial operational state id.
+ * @returns {Behavior.Options<MatterbridgeOperationalStateServer>} - The default options for the OperationalState cluster server.
+ *
+ * @remarks
+ * This method adds a cluster server with a default operational state configuration:
+ * - { operationalStateId: OperationalState.OperationalStateEnum.Stopped, operationalStateLabel: 'Stopped' },
+ * - { operationalStateId: OperationalState.OperationalStateEnum.Running, operationalStateLabel: 'Running' },
+ * - { operationalStateId: OperationalState.OperationalStateEnum.Paused, operationalStateLabel: 'Paused' },
+ * - { operationalStateId: OperationalState.OperationalStateEnum.Error, operationalStateLabel: 'Error' },
+ */
+export declare function getDefaultOperationalStateClusterServer(operationalState?: OperationalState.OperationalStateEnum): Partial<{
+    phaseList: string[] | null;
+    currentPhase: number | null;
+    operationalStateList: {
+        operationalStateId: number;
+        operationalStateLabel?: string | undefined;
+    }[];
+    operationalState: number;
+    operationalError: {
+        errorStateId: number;
+        errorStateLabel?: string | undefined;
+        errorStateDetails?: string | undefined;
+    };
+    countdownTime?: number | null | undefined;
+}>;
+/**
+ * Get the default TemperatureMeasurement cluster server options.
+ *
+ * @param {number | null} measuredValue - The measured value of the temperature x 100.
+ * @param {number | null} minMeasuredValue - The minimum measured value of the temperature x 100.
+ * @param {number | null} maxMeasuredValue - The maximum measured value of the temperature x 100.
+ * @returns {Behavior.Options<MatterbridgeTemperatureMeasurementServer>} - The default options for the TemperatureMeasurement cluster server.
+ */
+export declare function getDefaultTemperatureMeasurementClusterServer(measuredValue?: number | null, minMeasuredValue?: number | null, maxMeasuredValue?: number | null): Partial<{
+    measuredValue: number | null;
+    minMeasuredValue: number | null;
+    maxMeasuredValue: number | null;
+    tolerance?: number | undefined;
+}>;
+/**
+ * Get the default RelativeHumidityMeasurement cluster server options.
+ *
+ * @param {number | null} measuredValue - The measured value of the relative humidity x 100.
+ * @param {number | null} minMeasuredValue - The minimum measured value of the relative humidity x 100.
+ * @param {number | null} maxMeasuredValue - The maximum measured value of the relative humidity x 100.
+ * @returns {Behavior.Options<MatterbridgeRelativeHumidityMeasurementServer>} - The default options for the RelativeHumidityMeasurement cluster server.
+ */
+export declare function getDefaultRelativeHumidityMeasurementClusterServer(measuredValue?: number | null, minMeasuredValue?: number | null, maxMeasuredValue?: number | null): Partial<{
+    measuredValue: number | null;
+    minMeasuredValue: number | null;
+    maxMeasuredValue: number | null;
+    tolerance?: number | undefined;
+}>;
+/**
+ * Get the default PressureMeasurement cluster server options.
+ *
+ * @param {number | null} measuredValue - The measured value for the pressure in kPa x 10.
+ * @param {number | null} minMeasuredValue - The minimum measured value for the pressure in kPa x 10.
+ * @param {number | null} maxMeasuredValue - The maximum measured value for the pressure in kPa x 10.
+ * @returns {Behavior.Options<MatterbridgePressureMeasurementServer>} - The default options for the PressureMeasurement cluster server.
+ */
+export declare function getDefaultPressureMeasurementClusterServer(measuredValue?: number | null, minMeasuredValue?: number | null, maxMeasuredValue?: number | null): Partial<{
+    measuredValue: number | null;
+    minMeasuredValue: number | null;
+    maxMeasuredValue: number | null;
+    tolerance?: number | undefined;
+}>;
+/**
+ * Get the default IlluminanceMeasurement cluster server options.
+ *
+ * @param {number | null} measuredValue - The measured value of illuminance.
+ * @param {number | null} minMeasuredValue - The minimum measured value of illuminance.
+ * @param {number | null} maxMeasuredValue - The maximum measured value of illuminance.
+ * @returns {Behavior.Options<MatterbridgeIlluminanceMeasurementServer>} - The default options for the IlluminanceMeasurement cluster server.
+ *
+ * @remarks The default value for the illuminance measurement is null.
+ * This attribute SHALL indicate the illuminance in Lux (symbol lx) as follows:
+ * •  MeasuredValue = 10,000 x log10(illuminance) + 1,
+ *    where 1 lx <= illuminance <= 3.576 Mlx, corresponding to a MeasuredValue in the range 1 to 0xFFFE.
+ * • 0 indicates a value of illuminance that is too low to be measured
+ * • null indicates that the illuminance measurement is invalid.
+ */
+export declare function getDefaultIlluminanceMeasurementClusterServer(measuredValue?: number | null, minMeasuredValue?: number | null, maxMeasuredValue?: number | null): Partial<{
+    measuredValue: number | null;
+    minMeasuredValue: number | null;
+    maxMeasuredValue: number | null;
+    tolerance?: number | undefined;
+    lightSensorType?: number | null | undefined;
+}>;
+/**
+ * Get the default FlowMeasurement cluster server options.
+ *
+ * @param {number | null} measuredValue - The measured value of the flow in 10 x m3/h.
+ * @param {number | null} minMeasuredValue - The minimum measured value of the flow in 10 x m3/h.
+ * @param {number | null} maxMeasuredValue - The maximum measured value of the flow in 10 x m3/h.
+ * @returns {Behavior.Options<MatterbridgeFlowMeasurementServer>} - The default options for the FlowMeasurement cluster server.
+ */
+export declare function getDefaultFlowMeasurementClusterServer(measuredValue?: number | null, minMeasuredValue?: number | null, maxMeasuredValue?: number | null): Partial<{
+    measuredValue: number | null;
+    minMeasuredValue: number | null;
+    maxMeasuredValue: number | null;
+    tolerance?: number | undefined;
+}>;
+/**
+ * Get the default OccupancySensing cluster server options.
+ *
+ * @param {boolean} occupied - A boolean indicating whether the occupancy is occupied or not. Default is false.
+ * @param {number} holdTime - The hold time in seconds. Default is 30.
+ * @param {number} holdTimeMin - The minimum hold time in seconds. Default is 1.
+ * @param {number} holdTimeMax - The maximum hold time in seconds. Default is 300.
+ * @returns {Behavior.Options<MatterbridgeOccupancySensingServer>} - The default options for the OccupancySensing cluster server.
+ *
+ * @remarks The default value for the occupancy sensor type is PIR.
+ * Servers SHALL set these attributes for backward compatibility with clients implementing a cluster revision <= 4 as
+ * described in OccupancySensorType and OccupancySensorTypeBitmap Attributes.
+ * This replaces the 9 legacy attributes PIROccupiedToUnoccupiedDelay through PhysicalContactUnoccupiedToOccupiedThreshold.
+ */
+export declare function getDefaultOccupancySensingClusterServer(occupied?: boolean, holdTime?: number, holdTimeMin?: number, holdTimeMax?: number): Partial<{
+    occupancy: {
+        occupied?: boolean | undefined;
+    };
+    holdTime?: number | undefined;
+    pirOccupiedToUnoccupiedDelay?: number | undefined;
+    pirUnoccupiedToOccupiedDelay?: number | undefined;
+    pirUnoccupiedToOccupiedThreshold?: number | undefined;
+    occupancySensorType: number;
+    occupancySensorTypeBitmap: {
+        pir?: boolean | undefined;
+        ultrasonic?: boolean | undefined;
+        physicalContact?: boolean | undefined;
+    };
+    holdTimeLimits?: {
+        holdTimeMin: number;
+        holdTimeMax: number;
+        holdTimeDefault: number;
+    } | undefined;
+}>;
+//# sourceMappingURL=matterbridgeEndpointHelpers.d.ts.map