edilkamin 1.10.0 → 1.10.2

package/dist/esm/src/cli.js

@@ -14,6 +14,7 @@ import { version } from "../package.json";
 import { NEW_API_URL, OLD_API_URL } from "./constants";
 import { configure, configureAmplify, getSession, signIn } from "./library";
 import { clearSession, createFileStorage } from "./token-storage";
+import { AlarmCode, AlarmDescriptions } from "./types";
 const promptPassword = () => {
     const rl = readline.createInterface({
         input: process.stdin,
@@ -222,6 +223,84 @@ const createProgram = () => {
             description: "Retrieve estimated pellet autonomy time",
             getter: (api, jwtToken, mac) => api.getPelletAutonomyTime(jwtToken, mac),
         },
+        // Statistics getters
+        {
+            commandName: "getTotalCounters",
+            description: "Get lifetime operating counters (power-ons, runtime by power level)",
+            getter: (api, jwtToken, mac) => api.getTotalCounters(jwtToken, mac),
+        },
+        {
+            commandName: "getServiceCounters",
+            description: "Get service counters (runtime since last maintenance)",
+            getter: (api, jwtToken, mac) => api.getServiceCounters(jwtToken, mac),
+        },
+        {
+            commandName: "getRegenerationData",
+            description: "Get regeneration and maintenance data",
+            getter: (api, jwtToken, mac) => api.getRegenerationData(jwtToken, mac),
+        },
+        {
+            commandName: "getServiceTime",
+            description: "Get total service time in hours",
+            getter: (api, jwtToken, mac) => api.getServiceTime(jwtToken, mac),
+        },
+        // Analytics getters
+        {
+            commandName: "getTotalOperatingHours",
+            description: "Get total operating hours across all power levels",
+            getter: (api, jwtToken, mac) => api.getTotalOperatingHours(jwtToken, mac),
+        },
+        {
+            commandName: "getPowerDistribution",
+            description: "Get power level usage distribution as percentages",
+            getter: (api, jwtToken, mac) => __awaiter(void 0, void 0, void 0, function* () {
+                const result = yield api.getPowerDistribution(jwtToken, mac);
+                return {
+                    p1: `${result.p1.toFixed(1)}%`,
+                    p2: `${result.p2.toFixed(1)}%`,
+                    p3: `${result.p3.toFixed(1)}%`,
+                    p4: `${result.p4.toFixed(1)}%`,
+                    p5: `${result.p5.toFixed(1)}%`,
+                };
+            }),
+        },
+        {
+            commandName: "getServiceStatus",
+            description: "Get service status including whether maintenance is due",
+            getter: (api, jwtToken, mac) => api.getServiceStatus(jwtToken, mac),
+        },
+        {
+            commandName: "getUsageAnalytics",
+            description: "Get comprehensive usage analytics in single response",
+            getter: (api, jwtToken, mac) => __awaiter(void 0, void 0, void 0, function* () {
+                var _a;
+                const analytics = yield api.getUsageAnalytics(jwtToken, mac);
+                return {
+                    lifetime: {
+                        powerOnCount: analytics.totalPowerOns,
+                        totalOperatingHours: analytics.totalOperatingHours,
+                        blackoutCount: analytics.blackoutCount,
+                    },
+                    powerDistribution: {
+                        p1: `${analytics.powerDistribution.p1.toFixed(1)}%`,
+                        p2: `${analytics.powerDistribution.p2.toFixed(1)}%`,
+                        p3: `${analytics.powerDistribution.p3.toFixed(1)}%`,
+                        p4: `${analytics.powerDistribution.p4.toFixed(1)}%`,
+                        p5: `${analytics.powerDistribution.p5.toFixed(1)}%`,
+                    },
+                    service: {
+                        totalServiceHours: analytics.serviceStatus.totalServiceHours,
+                        hoursSinceLastService: analytics.serviceStatus.hoursSinceService,
+                        thresholdHours: analytics.serviceStatus.serviceThresholdHours,
+                        isServiceDue: analytics.serviceStatus.isServiceDue,
+                        lastMaintenanceDate: ((_a = analytics.lastMaintenanceDate) === null || _a === void 0 ? void 0 : _a.toISOString()) || "Never",
+                    },
+                    alarms: {
+                        totalCount: analytics.alarmCount,
+                    },
+                };
+            }),
+        },
     ].forEach(({ commandName, description, getter }) => {
         addLegacyOption(addMacOption(addAuthOptions(program.command(commandName).description(description)))).action((options) => executeGetter(options, getter));
     });
@@ -403,6 +482,32 @@ const createProgram = () => {
         const result = yield api.setTargetTemperature(jwtToken, normalizedMac, index, value);
         console.log(JSON.stringify(result, null, 2));
     }));
+    // Alarm history command with human-readable descriptions
+    addLegacyOption(addMacOption(addAuthOptions(program
+        .command("getAlarmHistory")
+        .description("Get alarm history log with human-readable descriptions")))).action((options) => __awaiter(void 0, void 0, void 0, function* () {
+        const { username, password, mac, legacy = false } = options;
+        const normalizedMac = mac.replace(/:/g, "");
+        const storage = createFileStorage();
+        configureAmplify(storage);
+        let jwtToken;
+        try {
+            jwtToken = yield getSession(false, legacy);
+        }
+        catch (_a) {
+            if (!username) {
+                throw new Error("No session found. Please provide --username to sign in.");
+            }
+            const pwd = password || (yield promptPassword());
+            jwtToken = yield signIn(username, pwd, legacy);
+        }
+        const apiUrl = legacy ? OLD_API_URL : NEW_API_URL;
+        const api = configure(apiUrl);
+        const result = yield api.getAlarmHistory(jwtToken, normalizedMac);
+        // Format alarms with human-readable descriptions
+        const formattedAlarms = result.alarms.map((alarm) => (Object.assign(Object.assign({}, alarm), { typeName: AlarmCode[alarm.type] || "UNKNOWN", description: AlarmDescriptions[alarm.type] || "Unknown alarm", date: new Date(alarm.timestamp * 1000).toISOString() })));
+        console.log(JSON.stringify(Object.assign(Object.assign({}, result), { alarms: formattedAlarms }), null, 2));
+    }));
     // Command: register
     addLegacyOption(addAuthOptions(program
         .command("register")

package/dist/esm/src/index.d.ts

@@ -1,7 +1,8 @@
 export { bleToWifiMac } from "./bluetooth-utils";
 export { decompressBuffer, isBuffer, processResponse } from "./buffer-utils";
 export { API_URL, NEW_API_URL, OLD_API_URL } from "./constants";
-export { configure, getSession, signIn } from "./library";
+export { configure, deriveUsageAnalytics, getSession, signIn } from "./library";
 export { serialNumberDisplay, serialNumberFromHex, serialNumberToHex, } from "./serial-utils";
-export { BufferEncodedType, CommandsType, DeviceAssociationBody, DeviceAssociationResponse, DeviceInfoRawType, DeviceInfoType, DiscoveredDevice, EditDeviceAssociationBody, StatusType, TemperaturesType, UserParametersType, } from "./types";
+export { AlarmEntryType, AlarmsLogType, BufferEncodedType, CommandsType, DeviceAssociationBody, DeviceAssociationResponse, DeviceInfoRawType, DeviceInfoType, DiscoveredDevice, EditDeviceAssociationBody, PowerDistributionType, RegenerationDataType, ServiceCountersType, ServiceStatusType, StatusCountersType, StatusType, TemperaturesType, TotalCountersType, UsageAnalyticsType, UserParametersType, } from "./types";
+export { AlarmCode, AlarmDescriptions } from "./types";
 export declare const deviceInfo: (jwtToken: string, macAddress: string) => Promise<import("./types").DeviceInfoType>, registerDevice: (jwtToken: string, macAddress: string, serialNumber: string, deviceName?: string, deviceRoom?: string) => Promise<import("./types").DeviceAssociationResponse>, editDevice: (jwtToken: string, macAddress: string, deviceName?: string, deviceRoom?: string) => Promise<import("./types").DeviceAssociationResponse>, setPower: (jwtToken: string, macAddress: string, value: number) => Promise<unknown>, setPowerOff: (jwtToken: string, macAddress: string) => Promise<unknown>, setPowerOn: (jwtToken: string, macAddress: string) => Promise<unknown>, getPower: (jwtToken: string, macAddress: string) => Promise<boolean>, getEnvironmentTemperature: (jwtToken: string, macAddress: string) => Promise<number>, getTargetTemperature: (jwtToken: string, macAddress: string, envIndex: 1 | 2 | 3) => Promise<number>, setTargetTemperature: (jwtToken: string, macAddress: string, envIndex: 1 | 2 | 3, temperature: number) => Promise<unknown>;

package/dist/esm/src/index.js

@@ -2,6 +2,7 @@ import { configure } from "./library";
 export { bleToWifiMac } from "./bluetooth-utils";
 export { decompressBuffer, isBuffer, processResponse } from "./buffer-utils";
 export { API_URL, NEW_API_URL, OLD_API_URL } from "./constants";
-export { configure, getSession, signIn } from "./library";
+export { configure, deriveUsageAnalytics, getSession, signIn } from "./library";
 export { serialNumberDisplay, serialNumberFromHex, serialNumberToHex, } from "./serial-utils";
+export { AlarmCode, AlarmDescriptions } from "./types";
 export const { deviceInfo, registerDevice, editDevice, setPower, setPowerOff, setPowerOn, getPower, getEnvironmentTemperature, getTargetTemperature, setTargetTemperature, } = configure();

package/dist/esm/src/library.d.ts

@@ -1,5 +1,5 @@
 import * as amplifyAuth from "aws-amplify/auth";
-import { DeviceAssociationResponse, DeviceInfoType } from "./types";
+import { AlarmsLogType, DeviceAssociationResponse, DeviceInfoType, PowerDistributionType, RegenerationDataType, ServiceCountersType, ServiceStatusType, TotalCountersType, UsageAnalyticsType } from "./types";
 /**
  * Generates headers with a JWT token for authenticated requests.
  * @param {string} jwtToken - The JWT token for authorization.
@@ -29,6 +29,22 @@ declare const createAuthService: (auth: typeof amplifyAuth) => {
     getSession: (forceRefresh?: boolean, legacy?: boolean) => Promise<string>;
 };
 declare const signIn: (username: string, password: string, legacy?: boolean) => Promise<string>, getSession: (forceRefresh?: boolean, legacy?: boolean) => Promise<string>;
+/**
+ * Derives usage analytics from an existing DeviceInfo response.
+ * This is a pure function that performs client-side calculations without API calls.
+ *
+ * Use this when you already have a DeviceInfo object (e.g., from a previous deviceInfo() call)
+ * to avoid making an additional API request.
+ *
+ * @param {DeviceInfoType} deviceInfo - The device info response object.
+ * @param {number} [serviceThreshold=2000] - Service threshold in hours.
+ * @returns {UsageAnalyticsType} - Comprehensive usage analytics.
+ *
+ * @example
+ * const info = await api.deviceInfo(token, mac);
+ * const analytics = deriveUsageAnalytics(info);
+ */
+export declare const deriveUsageAnalytics: (deviceInfo: DeviceInfoType, serviceThreshold?: number) => UsageAnalyticsType;
 /**
  * Configures the library for API interactions.
  * Initializes API methods with a specified base URL.
@@ -81,5 +97,14 @@ declare const configure: (baseURL?: string) => {
     getLanguage: (jwtToken: string, macAddress: string) => Promise<number>;
     getPelletInReserve: (jwtToken: string, macAddress: string) => Promise<boolean>;
     getPelletAutonomyTime: (jwtToken: string, macAddress: string) => Promise<number>;
+    getTotalCounters: (jwtToken: string, macAddress: string) => Promise<TotalCountersType>;
+    getServiceCounters: (jwtToken: string, macAddress: string) => Promise<ServiceCountersType>;
+    getAlarmHistory: (jwtToken: string, macAddress: string) => Promise<AlarmsLogType>;
+    getRegenerationData: (jwtToken: string, macAddress: string) => Promise<RegenerationDataType>;
+    getServiceTime: (jwtToken: string, macAddress: string) => Promise<number>;
+    getTotalOperatingHours: (jwtToken: string, macAddress: string) => Promise<number>;
+    getPowerDistribution: (jwtToken: string, macAddress: string) => Promise<PowerDistributionType>;
+    getServiceStatus: (jwtToken: string, macAddress: string, thresholdHours?: number) => Promise<ServiceStatusType>;
+    getUsageAnalytics: (jwtToken: string, macAddress: string, serviceThreshold?: number) => Promise<UsageAnalyticsType>;
 };
 export { configure, configureAmplify, createAuthService, getSession, headers, signIn, };

package/dist/esm/src/library.js

@@ -473,6 +473,212 @@ const getPelletAutonomyTime = (baseURL) =>
     const info = yield deviceInfo(baseURL)(jwtToken, macAddress);
     return info.status.pellet.autonomy_time;
 });
+const getTotalCounters = (baseURL) => 
+/**
+ * Retrieves lifetime operating counters.
+ * Includes power-on count and runtime hours per power level.
+ * These counters are never reset.
+ *
+ * @param {string} jwtToken - The JWT token for authentication.
+ * @param {string} macAddress - The MAC address of the device.
+ * @returns {Promise<TotalCountersType>} - Lifetime operating statistics.
+ */
+(jwtToken, macAddress) => __awaiter(void 0, void 0, void 0, function* () {
+    const info = yield deviceInfo(baseURL)(jwtToken, macAddress);
+    return info.nvm.total_counters;
+});
+const getServiceCounters = (baseURL) => 
+/**
+ * Retrieves service counters (runtime since last maintenance).
+ * These counters track hours per power level since last service reset.
+ *
+ * @param {string} jwtToken - The JWT token for authentication.
+ * @param {string} macAddress - The MAC address of the device.
+ * @returns {Promise<ServiceCountersType>} - Service tracking statistics.
+ */
+(jwtToken, macAddress) => __awaiter(void 0, void 0, void 0, function* () {
+    const info = yield deviceInfo(baseURL)(jwtToken, macAddress);
+    return info.nvm.service_counters;
+});
+const getAlarmHistory = (baseURL) => 
+/**
+ * Retrieves the alarm history log.
+ * Contains a circular buffer of recent alarms with timestamps.
+ *
+ * @param {string} jwtToken - The JWT token for authentication.
+ * @param {string} macAddress - The MAC address of the device.
+ * @returns {Promise<AlarmsLogType>} - Alarm history log.
+ */
+(jwtToken, macAddress) => __awaiter(void 0, void 0, void 0, function* () {
+    const info = yield deviceInfo(baseURL)(jwtToken, macAddress);
+    return info.nvm.alarms_log;
+});
+const getRegenerationData = (baseURL) => 
+/**
+ * Retrieves regeneration and maintenance data.
+ * Includes blackout counter and last intervention timestamp.
+ *
+ * @param {string} jwtToken - The JWT token for authentication.
+ * @param {string} macAddress - The MAC address of the device.
+ * @returns {Promise<RegenerationDataType>} - Maintenance tracking data.
+ */
+(jwtToken, macAddress) => __awaiter(void 0, void 0, void 0, function* () {
+    const info = yield deviceInfo(baseURL)(jwtToken, macAddress);
+    return info.nvm.regeneration;
+});
+const getServiceTime = (baseURL) => 
+/**
+ * Retrieves the total service time in hours.
+ *
+ * @param {string} jwtToken - The JWT token for authentication.
+ * @param {string} macAddress - The MAC address of the device.
+ * @returns {Promise<number>} - Total service hours.
+ */
+(jwtToken, macAddress) => __awaiter(void 0, void 0, void 0, function* () {
+    const info = yield deviceInfo(baseURL)(jwtToken, macAddress);
+    return info.status.counters.service_time;
+});
+/**
+ * Default service threshold in hours (from OEM parameters).
+ * Most devices use 2000 hours.
+ */
+const DEFAULT_SERVICE_THRESHOLD = 2000;
+/**
+ * Derives usage analytics from an existing DeviceInfo response.
+ * This is a pure function that performs client-side calculations without API calls.
+ *
+ * Use this when you already have a DeviceInfo object (e.g., from a previous deviceInfo() call)
+ * to avoid making an additional API request.
+ *
+ * @param {DeviceInfoType} deviceInfo - The device info response object.
+ * @param {number} [serviceThreshold=2000] - Service threshold in hours.
+ * @returns {UsageAnalyticsType} - Comprehensive usage analytics.
+ *
+ * @example
+ * const info = await api.deviceInfo(token, mac);
+ * const analytics = deriveUsageAnalytics(info);
+ */
+export const deriveUsageAnalytics = (deviceInfo, serviceThreshold = DEFAULT_SERVICE_THRESHOLD) => {
+    const totalCounters = deviceInfo.nvm.total_counters;
+    const serviceCounters = deviceInfo.nvm.service_counters;
+    const regeneration = deviceInfo.nvm.regeneration;
+    const alarmsLog = deviceInfo.nvm.alarms_log;
+    const totalOperatingHours = totalCounters.p1_working_time +
+        totalCounters.p2_working_time +
+        totalCounters.p3_working_time +
+        totalCounters.p4_working_time +
+        totalCounters.p5_working_time;
+    const hoursSinceService = serviceCounters.p1_working_time +
+        serviceCounters.p2_working_time +
+        serviceCounters.p3_working_time +
+        serviceCounters.p4_working_time +
+        serviceCounters.p5_working_time;
+    const powerDistribution = totalOperatingHours === 0
+        ? { p1: 0, p2: 0, p3: 0, p4: 0, p5: 0 }
+        : {
+            p1: (totalCounters.p1_working_time / totalOperatingHours) * 100,
+            p2: (totalCounters.p2_working_time / totalOperatingHours) * 100,
+            p3: (totalCounters.p3_working_time / totalOperatingHours) * 100,
+            p4: (totalCounters.p4_working_time / totalOperatingHours) * 100,
+            p5: (totalCounters.p5_working_time / totalOperatingHours) * 100,
+        };
+    return {
+        totalPowerOns: totalCounters.power_ons,
+        totalOperatingHours,
+        powerDistribution,
+        serviceStatus: {
+            totalServiceHours: deviceInfo.status.counters.service_time,
+            hoursSinceService,
+            serviceThresholdHours: serviceThreshold,
+            isServiceDue: hoursSinceService >= serviceThreshold,
+        },
+        blackoutCount: regeneration.blackout_counter,
+        lastMaintenanceDate: regeneration.last_intervention > 0
+            ? new Date(regeneration.last_intervention * 1000)
+            : null,
+        alarmCount: alarmsLog.number,
+    };
+};
+const getTotalOperatingHours = (baseURL) => 
+/**
+ * Calculates total operating hours across all power levels.
+ *
+ * @param {string} jwtToken - The JWT token for authentication.
+ * @param {string} macAddress - The MAC address of the device.
+ * @returns {Promise<number>} - Total operating hours.
+ */
+(jwtToken, macAddress) => __awaiter(void 0, void 0, void 0, function* () {
+    const counters = yield getTotalCounters(baseURL)(jwtToken, macAddress);
+    return (counters.p1_working_time +
+        counters.p2_working_time +
+        counters.p3_working_time +
+        counters.p4_working_time +
+        counters.p5_working_time);
+});
+const getPowerDistribution = (baseURL) => 
+/**
+ * Calculates power level usage distribution as percentages.
+ *
+ * @param {string} jwtToken - The JWT token for authentication.
+ * @param {string} macAddress - The MAC address of the device.
+ * @returns {Promise<PowerDistributionType>} - Percentage time at each power level.
+ */
+(jwtToken, macAddress) => __awaiter(void 0, void 0, void 0, function* () {
+    const counters = yield getTotalCounters(baseURL)(jwtToken, macAddress);
+    const total = counters.p1_working_time +
+        counters.p2_working_time +
+        counters.p3_working_time +
+        counters.p4_working_time +
+        counters.p5_working_time;
+    if (total === 0) {
+        return { p1: 0, p2: 0, p3: 0, p4: 0, p5: 0 };
+    }
+    return {
+        p1: (counters.p1_working_time / total) * 100,
+        p2: (counters.p2_working_time / total) * 100,
+        p3: (counters.p3_working_time / total) * 100,
+        p4: (counters.p4_working_time / total) * 100,
+        p5: (counters.p5_working_time / total) * 100,
+    };
+});
+const getServiceStatus = (baseURL) => 
+/**
+ * Calculates service status including whether maintenance is due.
+ *
+ * @param {string} jwtToken - The JWT token for authentication.
+ * @param {string} macAddress - The MAC address of the device.
+ * @param {number} [thresholdHours=2000] - Service threshold in hours.
+ * @returns {Promise<ServiceStatusType>} - Service status with computed fields.
+ */
+(jwtToken_1, macAddress_1, ...args_1) => __awaiter(void 0, [jwtToken_1, macAddress_1, ...args_1], void 0, function* (jwtToken, macAddress, thresholdHours = DEFAULT_SERVICE_THRESHOLD) {
+    const info = yield deviceInfo(baseURL)(jwtToken, macAddress);
+    const serviceCounters = info.nvm.service_counters;
+    const hoursSinceService = serviceCounters.p1_working_time +
+        serviceCounters.p2_working_time +
+        serviceCounters.p3_working_time +
+        serviceCounters.p4_working_time +
+        serviceCounters.p5_working_time;
+    return {
+        totalServiceHours: info.status.counters.service_time,
+        hoursSinceService,
+        serviceThresholdHours: thresholdHours,
+        isServiceDue: hoursSinceService >= thresholdHours,
+    };
+});
+const getUsageAnalytics = (baseURL) => 
+/**
+ * Retrieves comprehensive usage analytics in a single call.
+ * Combines multiple statistics into a unified analytics object.
+ *
+ * @param {string} jwtToken - The JWT token for authentication.
+ * @param {string} macAddress - The MAC address of the device.
+ * @param {number} [serviceThreshold=2000] - Service threshold in hours.
+ * @returns {Promise<UsageAnalyticsType>} - Comprehensive usage analytics.
+ */
+(jwtToken_1, macAddress_1, ...args_1) => __awaiter(void 0, [jwtToken_1, macAddress_1, ...args_1], void 0, function* (jwtToken, macAddress, serviceThreshold = DEFAULT_SERVICE_THRESHOLD) {
+    const info = yield deviceInfo(baseURL)(jwtToken, macAddress);
+    return deriveUsageAnalytics(info, serviceThreshold);
+});
 const registerDevice = (baseURL) => 
 /**
  * Registers a device with the user's account.
@@ -572,5 +778,16 @@ const configure = (baseURL = API_URL) => ({
     getLanguage: getLanguage(baseURL),
     getPelletInReserve: getPelletInReserve(baseURL),
     getPelletAutonomyTime: getPelletAutonomyTime(baseURL),
+    // Statistics getters
+    getTotalCounters: getTotalCounters(baseURL),
+    getServiceCounters: getServiceCounters(baseURL),
+    getAlarmHistory: getAlarmHistory(baseURL),
+    getRegenerationData: getRegenerationData(baseURL),
+    getServiceTime: getServiceTime(baseURL),
+    // Analytics functions
+    getTotalOperatingHours: getTotalOperatingHours(baseURL),
+    getPowerDistribution: getPowerDistribution(baseURL),
+    getServiceStatus: getServiceStatus(baseURL),
+    getUsageAnalytics: getUsageAnalytics(baseURL),
 });
 export { configure, configureAmplify, createAuthService, getSession, headers, signIn, };