edilkamin 1.8.0 → 1.10.0

package/src/library.ts

@@ -206,6 +206,224 @@ const setPowerOff =
   (jwtToken: string, macAddress: string) =>
     setPower(baseURL)(jwtToken, macAddress, 0);
 
+const setPowerLevel =
+  (baseURL: string) =>
+  /**
+   * Sets the manual power level of the device.
+   *
+   * @param {string} jwtToken - The JWT token for authentication.
+   * @param {string} macAddress - The MAC address of the device.
+   * @param {number} level - The power level (1-5).
+   * @returns {Promise<unknown>} - A promise that resolves to the command response.
+   */
+  (jwtToken: string, macAddress: string, level: number) =>
+    mqttCommand(baseURL)(jwtToken, macAddress, {
+      name: "power_level",
+      value: level,
+    });
+
+const getPowerLevel =
+  (baseURL: string) =>
+  /**
+   * Retrieves the current manual power level of the device.
+   *
+   * @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 power level (1-5).
+   */
+  async (jwtToken: string, macAddress: string): Promise<number> => {
+    const info = await deviceInfo(baseURL)(jwtToken, macAddress);
+    return info.nvm.user_parameters.manual_power;
+  };
+
+const setFanSpeed =
+  (baseURL: string) =>
+  /**
+   * 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: string, macAddress: string, fanIndex: 1 | 2 | 3, speed: number) =>
+    mqttCommand(baseURL)(jwtToken, macAddress, {
+      name: `fan_${fanIndex}_speed`,
+      value: speed,
+    });
+
+const getFanSpeed =
+  (baseURL: string) =>
+  /**
+   * 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.
+   */
+  async (
+    jwtToken: string,
+    macAddress: string,
+    fanIndex: 1 | 2 | 3,
+  ): Promise<number> => {
+    const info = await deviceInfo(baseURL)(jwtToken, macAddress);
+    const fields: Record<1 | 2 | 3, number> = {
+      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: string) => (jwtToken: string, macAddress: string, speed: number) =>
+    setFanSpeed(baseURL)(jwtToken, macAddress, 1, speed);
+
+const setFan2Speed =
+  (baseURL: string) => (jwtToken: string, macAddress: string, speed: number) =>
+    setFanSpeed(baseURL)(jwtToken, macAddress, 2, speed);
+
+const setFan3Speed =
+  (baseURL: string) => (jwtToken: string, macAddress: string, speed: number) =>
+    setFanSpeed(baseURL)(jwtToken, macAddress, 3, speed);
+
+const getFan1Speed =
+  (baseURL: string) => (jwtToken: string, macAddress: string) =>
+    getFanSpeed(baseURL)(jwtToken, macAddress, 1);
+
+const getFan2Speed =
+  (baseURL: string) => (jwtToken: string, macAddress: string) =>
+    getFanSpeed(baseURL)(jwtToken, macAddress, 2);
+
+const getFan3Speed =
+  (baseURL: string) => (jwtToken: string, macAddress: string) =>
+    getFanSpeed(baseURL)(jwtToken, macAddress, 3);
+
+const setAirkare =
+  (baseURL: string) =>
+  /**
+   * Enables or disables Airkare (air quality) mode.
+   *
+   * @param {string} jwtToken - The JWT token for authentication.
+   * @param {string} macAddress - The MAC address of the device.
+   * @param {boolean} enabled - Whether to enable Airkare mode.
+   * @returns {Promise<unknown>} - A promise that resolves to the command response.
+   */
+  (jwtToken: string, macAddress: string, enabled: boolean) =>
+    mqttCommand(baseURL)(jwtToken, macAddress, {
+      name: "airkare_function",
+      value: enabled ? 1 : 0,
+    });
+
+const setRelax =
+  (baseURL: string) =>
+  /**
+   * Enables or disables Relax (comfort) mode.
+   *
+   * @param {string} jwtToken - The JWT token for authentication.
+   * @param {string} macAddress - The MAC address of the device.
+   * @param {boolean} enabled - Whether to enable Relax mode.
+   * @returns {Promise<unknown>} - A promise that resolves to the command response.
+   */
+  (jwtToken: string, macAddress: string, enabled: boolean) =>
+    mqttCommand(baseURL)(jwtToken, macAddress, {
+      name: "relax_mode",
+      value: enabled,
+    });
+
+const setStandby =
+  (baseURL: string) =>
+  /**
+   * Enables or disables Standby mode.
+   *
+   * @param {string} jwtToken - The JWT token for authentication.
+   * @param {string} macAddress - The MAC address of the device.
+   * @param {boolean} enabled - Whether to enable Standby mode.
+   * @returns {Promise<unknown>} - A promise that resolves to the command response.
+   */
+  (jwtToken: string, macAddress: string, enabled: boolean) =>
+    mqttCommand(baseURL)(jwtToken, macAddress, {
+      name: "standby_mode",
+      value: enabled,
+    });
+
+const getStandby =
+  (baseURL: string) =>
+  /**
+   * Retrieves the current Standby mode status.
+   *
+   * @param {string} jwtToken - The JWT token for authentication.
+   * @param {string} macAddress - The MAC address of the device.
+   * @returns {Promise<boolean>} - A promise that resolves to the standby status.
+   */
+  async (jwtToken: string, macAddress: string): Promise<boolean> => {
+    const info = await deviceInfo(baseURL)(jwtToken, macAddress);
+    return info.nvm.user_parameters.is_standby_active;
+  };
+
+const setStandbyTime =
+  (baseURL: string) =>
+  /**
+   * Sets the standby waiting time in minutes.
+   *
+   * @param {string} jwtToken - The JWT token for authentication.
+   * @param {string} macAddress - The MAC address of the device.
+   * @param {number} minutes - The standby waiting time in minutes.
+   * @returns {Promise<unknown>} - A promise that resolves to the command response.
+   */
+  (jwtToken: string, macAddress: string, minutes: number) =>
+    mqttCommand(baseURL)(jwtToken, macAddress, {
+      name: "standby_time",
+      value: minutes,
+    });
+
+const getStandbyTime =
+  (baseURL: string) =>
+  /**
+   * Retrieves the standby waiting time in minutes.
+   *
+   * @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 standby time in minutes.
+   */
+  async (jwtToken: string, macAddress: string): Promise<number> => {
+    const info = await deviceInfo(baseURL)(jwtToken, macAddress);
+    return info.nvm.user_parameters.standby_waiting_time;
+  };
+
+const setAuto =
+  (baseURL: string) =>
+  /**
+   * Enables or disables Auto mode for automatic temperature regulation.
+   *
+   * @param {string} jwtToken - The JWT token for authentication.
+   * @param {string} macAddress - The MAC address of the device.
+   * @param {boolean} enabled - Whether to enable Auto mode.
+   * @returns {Promise<unknown>} - A promise that resolves to the command response.
+   */
+  (jwtToken: string, macAddress: string, enabled: boolean) =>
+    mqttCommand(baseURL)(jwtToken, macAddress, {
+      name: "auto_mode",
+      value: enabled,
+    });
+
+const getAuto =
+  (baseURL: string) =>
+  /**
+   * Retrieves the current Auto mode status.
+   *
+   * @param {string} jwtToken - The JWT token for authentication.
+   * @param {string} macAddress - The MAC address of the device.
+   * @returns {Promise<boolean>} - A promise that resolves to the auto mode status.
+   */
+  async (jwtToken: string, macAddress: string): Promise<boolean> => {
+    const info = await deviceInfo(baseURL)(jwtToken, macAddress);
+    return info.nvm.user_parameters.is_auto;
+  };
+
 const getPower =
   (baseURL: string) =>
   /**
@@ -237,33 +455,175 @@ const getEnvironmentTemperature =
 const getTargetTemperature =
   (baseURL: string) =>
   /**
-   * 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).
    */
-  async (jwtToken: string, macAddress: string): Promise<number> => {
+  async (
+    jwtToken: string,
+    macAddress: string,
+    envIndex: 1 | 2 | 3,
+  ): Promise<number> => {
     const info = await deviceInfo(baseURL)(jwtToken, macAddress);
-    return info.nvm.user_parameters.enviroment_1_temperature;
+    const fields: Record<1 | 2 | 3, number> = {
+      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: string) =>
   /**
-   * 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.
+   * @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: string, macAddress: string, temperature: number) =>
+  (
+    jwtToken: string,
+    macAddress: string,
+    envIndex: 1 | 2 | 3,
+    temperature: number,
+  ) =>
     mqttCommand(baseURL)(jwtToken, macAddress, {
-      name: "enviroment_1_temperature",
+      name: `enviroment_${envIndex}_temperature`,
       value: temperature,
     });
 
+// Environment temperature aliases for convenience
+const setEnvironment1Temperature =
+  (baseURL: string) =>
+  (jwtToken: string, macAddress: string, temperature: number) =>
+    setTargetTemperature(baseURL)(jwtToken, macAddress, 1, temperature);
+
+const setEnvironment2Temperature =
+  (baseURL: string) =>
+  (jwtToken: string, macAddress: string, temperature: number) =>
+    setTargetTemperature(baseURL)(jwtToken, macAddress, 2, temperature);
+
+const setEnvironment3Temperature =
+  (baseURL: string) =>
+  (jwtToken: string, macAddress: string, temperature: number) =>
+    setTargetTemperature(baseURL)(jwtToken, macAddress, 3, temperature);
+
+const getEnvironment1Temperature =
+  (baseURL: string) => (jwtToken: string, macAddress: string) =>
+    getTargetTemperature(baseURL)(jwtToken, macAddress, 1);
+
+const getEnvironment2Temperature =
+  (baseURL: string) => (jwtToken: string, macAddress: string) =>
+    getTargetTemperature(baseURL)(jwtToken, macAddress, 2);
+
+const getEnvironment3Temperature =
+  (baseURL: string) => (jwtToken: string, macAddress: string) =>
+    getTargetTemperature(baseURL)(jwtToken, macAddress, 3);
+
+const setMeasureUnit =
+  (baseURL: string) =>
+  /**
+   * Sets the temperature measurement unit (Celsius or Fahrenheit).
+   *
+   * @param {string} jwtToken - The JWT token for authentication.
+   * @param {string} macAddress - The MAC address of the device.
+   * @param {boolean} isFahrenheit - true for Fahrenheit, false for Celsius.
+   * @returns {Promise<unknown>} - A promise that resolves to the command response.
+   */
+  (jwtToken: string, macAddress: string, isFahrenheit: boolean) =>
+    mqttCommand(baseURL)(jwtToken, macAddress, {
+      name: "measure_unit",
+      value: isFahrenheit,
+    });
+
+const getMeasureUnit =
+  (baseURL: string) =>
+  /**
+   * Retrieves the current temperature measurement unit setting.
+   *
+   * @param {string} jwtToken - The JWT token for authentication.
+   * @param {string} macAddress - The MAC address of the device.
+   * @returns {Promise<boolean>} - A promise that resolves to true if Fahrenheit, false if Celsius.
+   */
+  async (jwtToken: string, macAddress: string): Promise<boolean> => {
+    const info = await deviceInfo(baseURL)(jwtToken, macAddress);
+    return info.nvm.user_parameters.is_fahrenheit;
+  };
+
+const setLanguage =
+  (baseURL: string) =>
+  /**
+   * Sets the display language of the device.
+   *
+   * Language codes:
+   * 0=Italian, 1=French, 2=English, 3=Spanish, 4=Portuguese,
+   * 5=Danish, 6=Dutch, 7=German, 8=Hungarian, 9=Polish
+   *
+   * @param {string} jwtToken - The JWT token for authentication.
+   * @param {string} macAddress - The MAC address of the device.
+   * @param {number} languageCode - The language code (0-9).
+   * @returns {Promise<unknown>} - A promise that resolves to the command response.
+   */
+  (jwtToken: string, macAddress: string, languageCode: number) =>
+    mqttCommand(baseURL)(jwtToken, macAddress, {
+      name: "language",
+      value: languageCode,
+    });
+
+const getLanguage =
+  (baseURL: string) =>
+  /**
+   * Retrieves the current display language setting.
+   *
+   * Language codes:
+   * 0=Italian, 1=French, 2=English, 3=Spanish, 4=Portuguese,
+   * 5=Danish, 6=Dutch, 7=German, 8=Hungarian, 9=Polish
+   *
+   * @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 language code (0-9).
+   */
+  async (jwtToken: string, macAddress: string): Promise<number> => {
+    const info = await deviceInfo(baseURL)(jwtToken, macAddress);
+    return info.nvm.user_parameters.language;
+  };
+
+const getPelletInReserve =
+  (baseURL: string) =>
+  /**
+   * Retrieves the pellet reserve status.
+   * Returns true if pellet level is low (in reserve), false if pellet level is ok.
+   *
+   * @param {string} jwtToken - The JWT token for authentication.
+   * @param {string} macAddress - The MAC address of the device.
+   * @returns {Promise<boolean>} - A promise that resolves to the pellet reserve status.
+   */
+  async (jwtToken: string, macAddress: string): Promise<boolean> => {
+    const info = await deviceInfo(baseURL)(jwtToken, macAddress);
+    return info.status.flags.is_pellet_in_reserve;
+  };
+
+const getPelletAutonomyTime =
+  (baseURL: string) =>
+  /**
+   * Retrieves the estimated pellet autonomy time.
+   * Represents the estimated time remaining with current pellet level.
+   *
+   * @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 autonomy time (likely in minutes or hours).
+   */
+  async (jwtToken: string, macAddress: string): Promise<number> => {
+    const info = await deviceInfo(baseURL)(jwtToken, macAddress);
+    return info.status.pellet.autonomy_time;
+  };
+
 const registerDevice =
   (baseURL: string) =>
   /**
@@ -355,9 +715,39 @@ const configure = (baseURL: string = API_URL) => ({
   setPowerOff: setPowerOff(baseURL),
   setPowerOn: setPowerOn(baseURL),
   getPower: getPower(baseURL),
+  setPowerLevel: setPowerLevel(baseURL),
+  getPowerLevel: getPowerLevel(baseURL),
+  setFanSpeed: setFanSpeed(baseURL),
+  getFanSpeed: getFanSpeed(baseURL),
+  setFan1Speed: setFan1Speed(baseURL),
+  setFan2Speed: setFan2Speed(baseURL),
+  setFan3Speed: setFan3Speed(baseURL),
+  getFan1Speed: getFan1Speed(baseURL),
+  getFan2Speed: getFan2Speed(baseURL),
+  getFan3Speed: getFan3Speed(baseURL),
+  setAirkare: setAirkare(baseURL),
+  setRelax: setRelax(baseURL),
+  setStandby: setStandby(baseURL),
+  getStandby: getStandby(baseURL),
+  setStandbyTime: setStandbyTime(baseURL),
+  getStandbyTime: getStandbyTime(baseURL),
+  setAuto: setAuto(baseURL),
+  getAuto: getAuto(baseURL),
   getEnvironmentTemperature: getEnvironmentTemperature(baseURL),
   getTargetTemperature: getTargetTemperature(baseURL),
   setTargetTemperature: setTargetTemperature(baseURL),
+  setEnvironment1Temperature: setEnvironment1Temperature(baseURL),
+  getEnvironment1Temperature: getEnvironment1Temperature(baseURL),
+  setEnvironment2Temperature: setEnvironment2Temperature(baseURL),
+  getEnvironment2Temperature: getEnvironment2Temperature(baseURL),
+  setEnvironment3Temperature: setEnvironment3Temperature(baseURL),
+  getEnvironment3Temperature: getEnvironment3Temperature(baseURL),
+  setMeasureUnit: setMeasureUnit(baseURL),
+  getMeasureUnit: getMeasureUnit(baseURL),
+  setLanguage: setLanguage(baseURL),
+  getLanguage: getLanguage(baseURL),
+  getPelletInReserve: getPelletInReserve(baseURL),
+  getPelletAutonomyTime: getPelletAutonomyTime(baseURL),
 });
 
 export {

package/src/types.ts

@@ -16,9 +16,19 @@ interface TemperaturesType {
   enviroment: number;
 }
 
+interface GeneralFlagsType {
+  is_pellet_in_reserve: boolean;
+}
+
+interface PelletAutonomyType {
+  autonomy_time: number;
+}
+
 interface StatusType {
   commands: CommandsType;
   temperatures: TemperaturesType;
+  flags: GeneralFlagsType;
+  pellet: PelletAutonomyType;
 }
 
 interface UserParametersType {
@@ -27,6 +37,14 @@ interface UserParametersType {
   enviroment_3_temperature: number;
   is_auto: boolean;
   is_sound_active: boolean;
+  manual_power: number;
+  fan_1_ventilation: number;
+  fan_2_ventilation: number;
+  fan_3_ventilation: number;
+  is_standby_active: boolean;
+  standby_waiting_time: number;
+  is_fahrenheit: boolean;
+  language: number;
 }
 
 interface DeviceInfoType {
@@ -105,6 +123,8 @@ export type {
   DeviceInfoType,
   DiscoveredDevice,
   EditDeviceAssociationBody,
+  GeneralFlagsType,
+  PelletAutonomyType,
   StatusType,
   TemperaturesType,
   UserParametersType,