@matterbridge/core 3.10.5 → 3.10.6-dev-20260816-34076cc

package/dist/devices/electricalUtilityMeter.d.ts

@@ -0,0 +1,60 @@
+import { CommodityPriceServer } from '@matter/node/behaviors/commodity-price';
+import { CommodityTariffServer } from '@matter/node/behaviors/commodity-tariff';
+import type { CommodityMetering } from '@matter/types/clusters/commodity-metering';
+import type { CommodityPrice } from '@matter/types/clusters/commodity-price';
+import { CommodityTariff } from '@matter/types/clusters/commodity-tariff';
+import type { ElectricalGridConditions } from '@matter/types/clusters/electrical-grid-conditions';
+import type { MeterIdentification } from '@matter/types/clusters/meter-identification';
+import { type Currency, type Semtag, TariffUnit } from '@matter/types/globals';
+import { MatterbridgeEndpoint } from '../matterbridgeEndpoint.js';
+export declare class MatterbridgeCommodityPriceServer extends CommodityPriceServer {
+    getDetailedPriceRequest(): CommodityPrice.GetDetailedPriceResponse;
+}
+declare const MatterbridgeCommodityTariffServer_base: import("@matter/node").ClusterBehavior.Type<typeof CommodityTariffServer, import("@matter/types").ClusterType.WithSupportedFeatures<CommodityTariff, {
+    auxiliaryLoad: false;
+    friendlyCredit: false;
+    peakPeriod: false;
+    powerThreshold: false;
+    pricing: true;
+    randomization: false;
+}>, import("@matter/types").ClusterType.Concrete, new () => {}, "commodityTariff">;
+export declare class MatterbridgeCommodityTariffServer extends MatterbridgeCommodityTariffServer_base {
+    getTariffComponent(request: CommodityTariff.GetTariffComponentRequest): CommodityTariff.GetTariffComponentResponse;
+    getDayEntry(request: CommodityTariff.GetDayEntryRequest): CommodityTariff.GetDayEntryResponse;
+}
+export interface ElectricalUtilityMeterOptions {
+    meterType?: MeterIdentification.MeterType | null;
+    pointOfDelivery?: string | null;
+    meterSerialNumber?: string | null;
+    protocolVersion?: string | null;
+    tagList?: Semtag[];
+}
+export interface ElectricalMeterOptions {
+    voltage?: number | bigint | null;
+    current?: number | bigint | null;
+    power?: number | bigint | null;
+    energyImported?: number | bigint | null;
+    energyExported?: number | bigint | null;
+    meteredQuantity?: CommodityMetering.MeteredQuantity[] | null;
+    meteredQuantityTimestamp?: number | null;
+    tariffUnit?: TariffUnit | null;
+    maximumMeteredQuantities?: number | null;
+    tagList?: Semtag[];
+}
+export interface ElectricalEnergyTariffOptions {
+    tariffLabel?: string | null;
+    providerName?: string | null;
+    tariffUnit?: TariffUnit;
+    currency?: Currency | null;
+    currentPrice?: CommodityPrice.CommodityPriceStruct | null;
+    localGenerationAvailable?: boolean | null;
+    currentConditions?: ElectricalGridConditions.ElectricalGridConditionsStruct | null;
+    tagList?: Semtag[];
+}
+export declare class ElectricalUtilityMeter extends MatterbridgeEndpoint {
+    constructor(name: string, serial: string, options?: ElectricalUtilityMeterOptions);
+    createDefaultMeterIdentificationClusterServer(meterType?: MeterIdentification.MeterType | null, pointOfDelivery?: string | null, meterSerialNumber?: string | null, protocolVersion?: string | null): this;
+    addElectricalMeter(name: string, options?: ElectricalMeterOptions): MatterbridgeEndpoint;
+    addElectricalEnergyTariff(name: string, options?: ElectricalEnergyTariffOptions): MatterbridgeEndpoint;
+}
+export {};

package/dist/devices/electricalUtilityMeter.js

@@ -0,0 +1,90 @@
+import { CommodityTariffChronologyTag, CommodityTariffCommodityTag, PowerSourceTag } from '@matter/node';
+import { CommodityMeteringServer } from '@matter/node/behaviors/commodity-metering';
+import { CommodityPriceServer } from '@matter/node/behaviors/commodity-price';
+import { CommodityTariffServer } from '@matter/node/behaviors/commodity-tariff';
+import { ElectricalGridConditionsServer } from '@matter/node/behaviors/electrical-grid-conditions';
+import { MeterIdentificationServer } from '@matter/node/behaviors/meter-identification';
+import { StatusResponse } from '@matter/types';
+import { CommodityTariff } from '@matter/types/clusters/commodity-tariff';
+import { TariffUnit } from '@matter/types/globals';
+import { electricalEnergyTariff, electricalMeter, electricalSensor, electricalUtilityMeter, meterReferencePoint, powerSource } from '../matterbridgeDeviceTypes.js';
+import { MatterbridgeEndpoint } from '../matterbridgeEndpoint.js';
+import { getSemtag, optionsFor } from '../matterbridgeEndpointHelpers.js';
+export class MatterbridgeCommodityPriceServer extends CommodityPriceServer {
+    getDetailedPriceRequest() {
+        return { currentPrice: this.state.currentPrice };
+    }
+}
+export class MatterbridgeCommodityTariffServer extends CommodityTariffServer.with(CommodityTariff.Feature.Pricing) {
+    getTariffComponent(request) {
+        const tariffComponent = (this.state.tariffComponents ?? []).find((component) => component.tariffComponentId === request.tariffComponentId);
+        if (!tariffComponent) {
+            throw new StatusResponse.NotFoundError(`No TariffComponent with id ${request.tariffComponentId}`);
+        }
+        const period = (this.state.tariffPeriods ?? []).find((p) => p.tariffComponentIDs.includes(request.tariffComponentId));
+        return { label: period?.label ?? null, dayEntryIDs: period?.dayEntryIDs ?? [], tariffComponent };
+    }
+    getDayEntry(request) {
+        const dayEntry = (this.state.dayEntries ?? []).find((entry) => entry.dayEntryId === request.dayEntryId);
+        if (!dayEntry) {
+            throw new StatusResponse.NotFoundError(`No DayEntry with id ${request.dayEntryId}`);
+        }
+        return { dayEntry };
+    }
+}
+export class ElectricalUtilityMeter extends MatterbridgeEndpoint {
+    constructor(name, serial, options = {}) {
+        const { meterType = null, pointOfDelivery = null, meterSerialNumber = null, protocolVersion = null, tagList = [getSemtag(PowerSourceTag.Grid)] } = options;
+        super([electricalUtilityMeter, meterReferencePoint, powerSource], {
+            id: `${name.replaceAll(' ', '')}-${serial.replaceAll(' ', '')}`,
+            tagList,
+        });
+        this.createDefaultIdentifyClusterServer();
+        this.createDefaultBasicInformationClusterServer(name, serial, 0xfff1, 'Matterbridge', 0x8000, 'Matterbridge Electrical Utility Meter');
+        this.createDefaultPowerSourceWiredClusterServer();
+        this.createDefaultMeterIdentificationClusterServer(meterType, pointOfDelivery, meterSerialNumber, protocolVersion);
+        this.addRequiredClusterServers();
+    }
+    createDefaultMeterIdentificationClusterServer(meterType = null, pointOfDelivery = null, meterSerialNumber = null, protocolVersion = null) {
+        this.behaviors.require(MeterIdentificationServer, optionsFor(MeterIdentificationServer, { meterType, pointOfDelivery, meterSerialNumber, protocolVersion }));
+        return this;
+    }
+    addElectricalMeter(name, options = {}) {
+        const { voltage = null, current = null, power = null, energyImported = null, energyExported = null, meteredQuantity = null, meteredQuantityTimestamp = null, tariffUnit = null, maximumMeteredQuantities = null, tagList, } = options;
+        const meter = this.addChildDeviceType(name, [electricalMeter, electricalSensor], tagList ? { tagList } : {})
+            .createDefaultPowerTopologyClusterServer()
+            .createDefaultElectricalPowerMeasurementClusterServer(voltage, current, power)
+            .createDefaultElectricalEnergyMeasurementClusterServer(energyImported, energyExported);
+        meter.behaviors.require(CommodityMeteringServer, optionsFor(CommodityMeteringServer, { meteredQuantity, meteredQuantityTimestamp, tariffUnit, maximumMeteredQuantities }));
+        meter.addRequiredClusterServers();
+        return meter;
+    }
+    addElectricalEnergyTariff(name, options = {}) {
+        const { tariffLabel = null, providerName = null, tariffUnit = TariffUnit.KWh, currency = null, currentPrice = null, localGenerationAvailable = null, currentConditions = null, tagList = [getSemtag(CommodityTariffChronologyTag.Current), getSemtag(CommodityTariffCommodityTag.ElectricalEnergy)], } = options;
+        const tariff = this.addChildDeviceType(name, electricalEnergyTariff, { tagList });
+        tariff.behaviors.require(MatterbridgeCommodityPriceServer, optionsFor(MatterbridgeCommodityPriceServer, { tariffUnit, currency, currentPrice }));
+        const tariffInfo = tariffLabel !== null || providerName !== null || currency !== null ? { tariffLabel, providerName, currency, blockMode: CommodityTariff.BlockMode.NoBlock } : null;
+        tariff.behaviors.require(MatterbridgeCommodityTariffServer, optionsFor(MatterbridgeCommodityTariffServer, {
+            tariffInfo,
+            tariffUnit: tariffInfo === null ? null : tariffUnit,
+            startDate: null,
+            dayEntries: null,
+            dayPatterns: null,
+            calendarPeriods: null,
+            individualDays: null,
+            tariffComponents: null,
+            tariffPeriods: null,
+            currentDay: null,
+            nextDay: null,
+            currentDayEntry: null,
+            currentDayEntryDate: null,
+            nextDayEntry: null,
+            nextDayEntryDate: null,
+            currentTariffComponents: null,
+            nextTariffComponents: null,
+        }));
+        tariff.behaviors.require(ElectricalGridConditionsServer, optionsFor(ElectricalGridConditionsServer, { localGenerationAvailable, currentConditions }));
+        tariff.addRequiredClusterServers();
+        return tariff;
+    }
+}

package/dist/devices/export.d.ts

@@ -16,6 +16,7 @@ export * from './microwaveOven.js';
 export * from './oven.js';
 export * from './refrigerator.js';
 export * from './batteryStorage.js';
+export * from './electricalUtilityMeter.js';
 export * from './evse.js';
 export * from './heatPump.js';
 export * from './solarPower.js';

package/dist/devices/export.js

@@ -16,6 +16,7 @@ export * from './microwaveOven.js';
 export * from './oven.js';
 export * from './refrigerator.js';
 export * from './batteryStorage.js';
+export * from './electricalUtilityMeter.js';
 export * from './evse.js';
 export * from './heatPump.js';
 export * from './solarPower.js';

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@matterbridge/core",
-  "version": "3.10.5",
+  "version": "3.10.6-dev-20260816-34076cc",
   "description": "Matterbridge core library",
   "author": "https://github.com/Luligu",
   "homepage": "https://matterbridge.io/",
@@ -132,16 +132,16 @@
   },
   "dependencies": {
     "@matter/main": "0.17.9",
-    "@matterbridge/dgram": "3.10.5",
-    "@matterbridge/thread": "3.10.5",
-    "@matterbridge/types": "3.10.5",
-    "@matterbridge/utils": "3.10.5",
+    "@matterbridge/dgram": "3.10.6-dev-20260816-34076cc",
+    "@matterbridge/thread": "3.10.6-dev-20260816-34076cc",
+    "@matterbridge/types": "3.10.6-dev-20260816-34076cc",
+    "@matterbridge/utils": "3.10.6-dev-20260816-34076cc",
     "escape-html": "1.0.3",
     "express": "5.2.1",
     "express-rate-limit": "8.6.2",
     "multer": "2.2.0",
     "node-ansi-logger": "3.3.0",
     "node-persist-manager": "2.1.0",
-    "ws": "8.21.2"
+    "ws": "8.21.3"
   }
 }