edilkamin 1.9.0 → 1.10.1

package/dist/cjs/src/library.js

@@ -227,81 +227,45 @@ const getPowerLevel = (baseURL) =>
     const info = yield deviceInfo(baseURL)(jwtToken, macAddress);
     return info.nvm.user_parameters.manual_power;
 });
-const setFan1Speed = (baseURL) => 
+const setFanSpeed = (baseURL) => 
 /**
- * Sets the speed of fan 1.
+ * Sets the speed of a fan by index.
  *
  * @param {string} jwtToken - The JWT token for authentication.
  * @param {string} macAddress - The MAC address of the device.
+ * @param {1 | 2 | 3} fanIndex - The fan index (1, 2, or 3).
  * @param {number} speed - The fan speed (0-5, 0=auto on some models).
  * @returns {Promise<unknown>} - A promise that resolves to the command response.
  */
-(jwtToken, macAddress, speed) => mqttCommand(baseURL)(jwtToken, macAddress, {
-    name: "fan_1_speed",
+(jwtToken, macAddress, fanIndex, speed) => mqttCommand(baseURL)(jwtToken, macAddress, {
+    name: `fan_${fanIndex}_speed`,
     value: speed,
 });
-const setFan2Speed = (baseURL) => 
+const getFanSpeed = (baseURL) => 
 /**
- * Sets the speed of fan 2.
- *
- * @param {string} jwtToken - The JWT token for authentication.
- * @param {string} macAddress - The MAC address of the device.
- * @param {number} speed - The fan speed (0-5, 0=auto on some models).
- * @returns {Promise<unknown>} - A promise that resolves to the command response.
- */
-(jwtToken, macAddress, speed) => mqttCommand(baseURL)(jwtToken, macAddress, {
-    name: "fan_2_speed",
-    value: speed,
-});
-const setFan3Speed = (baseURL) => 
-/**
- * Sets the speed of fan 3.
- *
- * @param {string} jwtToken - The JWT token for authentication.
- * @param {string} macAddress - The MAC address of the device.
- * @param {number} speed - The fan speed (0-5, 0=auto on some models).
- * @returns {Promise<unknown>} - A promise that resolves to the command response.
- */
-(jwtToken, macAddress, speed) => mqttCommand(baseURL)(jwtToken, macAddress, {
-    name: "fan_3_speed",
-    value: speed,
-});
-const getFan1Speed = (baseURL) => 
-/**
- * Retrieves the current speed of fan 1.
+ * Retrieves the current speed of a fan by index.
  *
  * @param {string} jwtToken - The JWT token for authentication.
  * @param {string} macAddress - The MAC address of the device.
+ * @param {1 | 2 | 3} fanIndex - The fan index (1, 2, or 3).
  * @returns {Promise<number>} - A promise that resolves to the fan speed.
  */
-(jwtToken, macAddress) => __awaiter(void 0, void 0, void 0, function* () {
-    const info = yield deviceInfo(baseURL)(jwtToken, macAddress);
-    return info.nvm.user_parameters.fan_1_ventilation;
-});
-const getFan2Speed = (baseURL) => 
-/**
- * Retrieves the current speed of fan 2.
- *
- * @param {string} jwtToken - The JWT token for authentication.
- * @param {string} macAddress - The MAC address of the device.
- * @returns {Promise<number>} - A promise that resolves to the fan speed.
- */
-(jwtToken, macAddress) => __awaiter(void 0, void 0, void 0, function* () {
-    const info = yield deviceInfo(baseURL)(jwtToken, macAddress);
-    return info.nvm.user_parameters.fan_2_ventilation;
-});
-const getFan3Speed = (baseURL) => 
-/**
- * Retrieves the current speed of fan 3.
- *
- * @param {string} jwtToken - The JWT token for authentication.
- * @param {string} macAddress - The MAC address of the device.
- * @returns {Promise<number>} - A promise that resolves to the fan speed.
- */
-(jwtToken, macAddress) => __awaiter(void 0, void 0, void 0, function* () {
+(jwtToken, macAddress, fanIndex) => __awaiter(void 0, void 0, void 0, function* () {
     const info = yield deviceInfo(baseURL)(jwtToken, macAddress);
-    return info.nvm.user_parameters.fan_3_ventilation;
-});
+    const fields = {
+        1: info.nvm.user_parameters.fan_1_ventilation,
+        2: info.nvm.user_parameters.fan_2_ventilation,
+        3: info.nvm.user_parameters.fan_3_ventilation,
+    };
+    return fields[fanIndex];
+});
+// Fan speed aliases for convenience
+const setFan1Speed = (baseURL) => (jwtToken, macAddress, speed) => setFanSpeed(baseURL)(jwtToken, macAddress, 1, speed);
+const setFan2Speed = (baseURL) => (jwtToken, macAddress, speed) => setFanSpeed(baseURL)(jwtToken, macAddress, 2, speed);
+const setFan3Speed = (baseURL) => (jwtToken, macAddress, speed) => setFanSpeed(baseURL)(jwtToken, macAddress, 3, speed);
+const getFan1Speed = (baseURL) => (jwtToken, macAddress) => getFanSpeed(baseURL)(jwtToken, macAddress, 1);
+const getFan2Speed = (baseURL) => (jwtToken, macAddress) => getFanSpeed(baseURL)(jwtToken, macAddress, 2);
+const getFan3Speed = (baseURL) => (jwtToken, macAddress) => getFanSpeed(baseURL)(jwtToken, macAddress, 3);
 const setAirkare = (baseURL) => 
 /**
  * Enables or disables Airkare (air quality) mode.
@@ -429,79 +393,43 @@ const getEnvironmentTemperature = (baseURL) =>
 });
 const getTargetTemperature = (baseURL) => 
 /**
- * Retrieves the target temperature value set on the device.
+ * Retrieves the target temperature for an environment zone.
  *
  * @param {string} jwtToken - The JWT token for authentication.
  * @param {string} macAddress - The MAC address of the device.
- * @returns {Promise<number>} - A promise that resolves to the target temperature (degree celsius).
+ * @param {1 | 2 | 3} envIndex - The environment zone index (1, 2, or 3).
+ * @returns {Promise<number>} - A promise that resolves to the target temperature (degrees Celsius).
  */
-(jwtToken, macAddress) => __awaiter(void 0, void 0, void 0, function* () {
+(jwtToken, macAddress, envIndex) => __awaiter(void 0, void 0, void 0, function* () {
     const info = yield deviceInfo(baseURL)(jwtToken, macAddress);
-    return info.nvm.user_parameters.enviroment_1_temperature;
+    const fields = {
+        1: info.nvm.user_parameters.enviroment_1_temperature,
+        2: info.nvm.user_parameters.enviroment_2_temperature,
+        3: info.nvm.user_parameters.enviroment_3_temperature,
+    };
+    return fields[envIndex];
 });
 const setTargetTemperature = (baseURL) => 
 /**
- * Sends a command to set the target temperature (degree celsius) of a device.
+ * Sets the target temperature for an environment zone.
  *
  * @param {string} jwtToken - The JWT token for authentication.
  * @param {string} macAddress - The MAC address of the device.
- * @param {number} temperature - The desired target temperature (degree celsius).
- * @returns {Promise<string>} - A promise that resolves to the command response.
- */
-(jwtToken, macAddress, temperature) => mqttCommand(baseURL)(jwtToken, macAddress, {
-    name: "enviroment_1_temperature",
-    value: temperature,
-});
-const setEnvironment2Temperature = (baseURL) => 
-/**
- * Sets the target temperature for Environment 2 zone.
- *
- * @param {string} jwtToken - The JWT token for authentication.
- * @param {string} macAddress - The MAC address of the device.
- * @param {number} temperature - The target temperature in degrees Celsius.
+ * @param {1 | 2 | 3} envIndex - The environment zone index (1, 2, or 3).
+ * @param {number} temperature - The desired target temperature (degrees Celsius).
  * @returns {Promise<unknown>} - A promise that resolves to the command response.
  */
-(jwtToken, macAddress, temperature) => mqttCommand(baseURL)(jwtToken, macAddress, {
-    name: "enviroment_2_temperature",
+(jwtToken, macAddress, envIndex, temperature) => mqttCommand(baseURL)(jwtToken, macAddress, {
+    name: `enviroment_${envIndex}_temperature`,
     value: temperature,
 });
-const getEnvironment2Temperature = (baseURL) => 
-/**
- * Retrieves the target temperature for Environment 2 zone.
- *
- * @param {string} jwtToken - The JWT token for authentication.
- * @param {string} macAddress - The MAC address of the device.
- * @returns {Promise<number>} - A promise that resolves to the temperature in degrees Celsius.
- */
-(jwtToken, macAddress) => __awaiter(void 0, void 0, void 0, function* () {
-    const info = yield deviceInfo(baseURL)(jwtToken, macAddress);
-    return info.nvm.user_parameters.enviroment_2_temperature;
-});
-const setEnvironment3Temperature = (baseURL) => 
-/**
- * Sets the target temperature for Environment 3 zone.
- *
- * @param {string} jwtToken - The JWT token for authentication.
- * @param {string} macAddress - The MAC address of the device.
- * @param {number} temperature - The target temperature in degrees Celsius.
- * @returns {Promise<unknown>} - A promise that resolves to the command response.
- */
-(jwtToken, macAddress, temperature) => mqttCommand(baseURL)(jwtToken, macAddress, {
-    name: "enviroment_3_temperature",
-    value: temperature,
-});
-const getEnvironment3Temperature = (baseURL) => 
-/**
- * Retrieves the target temperature for Environment 3 zone.
- *
- * @param {string} jwtToken - The JWT token for authentication.
- * @param {string} macAddress - The MAC address of the device.
- * @returns {Promise<number>} - A promise that resolves to the temperature in degrees Celsius.
- */
-(jwtToken, macAddress) => __awaiter(void 0, void 0, void 0, function* () {
-    const info = yield deviceInfo(baseURL)(jwtToken, macAddress);
-    return info.nvm.user_parameters.enviroment_3_temperature;
-});
+// Environment temperature aliases for convenience
+const setEnvironment1Temperature = (baseURL) => (jwtToken, macAddress, temperature) => setTargetTemperature(baseURL)(jwtToken, macAddress, 1, temperature);
+const setEnvironment2Temperature = (baseURL) => (jwtToken, macAddress, temperature) => setTargetTemperature(baseURL)(jwtToken, macAddress, 2, temperature);
+const setEnvironment3Temperature = (baseURL) => (jwtToken, macAddress, temperature) => setTargetTemperature(baseURL)(jwtToken, macAddress, 3, temperature);
+const getEnvironment1Temperature = (baseURL) => (jwtToken, macAddress) => getTargetTemperature(baseURL)(jwtToken, macAddress, 1);
+const getEnvironment2Temperature = (baseURL) => (jwtToken, macAddress) => getTargetTemperature(baseURL)(jwtToken, macAddress, 2);
+const getEnvironment3Temperature = (baseURL) => (jwtToken, macAddress) => getTargetTemperature(baseURL)(jwtToken, macAddress, 3);
 const setMeasureUnit = (baseURL) => 
 /**
  * Sets the temperature measurement unit (Celsius or Fahrenheit).
@@ -586,6 +514,194 @@ 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;
+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);
+    const totalCounters = info.nvm.total_counters;
+    const serviceCounters = info.nvm.service_counters;
+    const regeneration = info.nvm.regeneration;
+    const alarmsLog = info.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: info.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 registerDevice = (baseURL) => 
 /**
  * Registers a device with the user's account.
@@ -654,6 +770,8 @@ const configure = (baseURL = constants_1.API_URL) => ({
     getPower: getPower(baseURL),
     setPowerLevel: setPowerLevel(baseURL),
     getPowerLevel: getPowerLevel(baseURL),
+    setFanSpeed: setFanSpeed(baseURL),
+    getFanSpeed: getFanSpeed(baseURL),
     setFan1Speed: setFan1Speed(baseURL),
     setFan2Speed: setFan2Speed(baseURL),
     setFan3Speed: setFan3Speed(baseURL),
@@ -671,6 +789,8 @@ const configure = (baseURL = constants_1.API_URL) => ({
     getEnvironmentTemperature: getEnvironmentTemperature(baseURL),
     getTargetTemperature: getTargetTemperature(baseURL),
     setTargetTemperature: setTargetTemperature(baseURL),
+    setEnvironment1Temperature: setEnvironment1Temperature(baseURL),
+    getEnvironment1Temperature: getEnvironment1Temperature(baseURL),
     setEnvironment2Temperature: setEnvironment2Temperature(baseURL),
     getEnvironment2Temperature: getEnvironment2Temperature(baseURL),
     setEnvironment3Temperature: setEnvironment3Temperature(baseURL),
@@ -681,5 +801,16 @@ const configure = (baseURL = constants_1.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),
 });
 exports.configure = configure;