daikin-airbase 0.2.0 → 0.3.0

package/dist/index.cjs

@@ -344,6 +344,7 @@ var DaikinClient = class {
   api;
   zones;
   cachedControlInfo;
+  cachedSensorInfo;
   constructor(options) {
     this.options = options;
     if ("host" in options) {
@@ -353,6 +354,10 @@ var DaikinClient = class {
     }
     this.zones = new Zones(this);
   }
+  /**
+   * Gets the current state of the aircon.
+   * @returns the current state of the aircon.
+   */
   async getControlInfo() {
     const response = await get_control_info(this.api);
     const responseValues = Object.entries(response);
@@ -362,7 +367,7 @@ var DaikinClient = class {
       fanAuto: response.f_auto != 0,
       fanAirside: response.f_airside != 0,
       targetTemperature: response.stemp,
-      sensorTemperatures: responseValues.filter(([k, v]) => k.startsWith("dt")).map(([k, v]) => +v),
+      controlTemperature: responseValues.filter(([k, v]) => k.startsWith("dt")).map(([k, v]) => +v),
       power: response.pow != 0,
       status: Number(response.operate),
       swinging: response.f_dir != 0,
@@ -371,21 +376,40 @@ var DaikinClient = class {
       remoteControlType: Number(response.remo)
     };
   }
+  /** Gets the cached state of the aircon. */
   getCachedControlInfo() {
     return this.cachedControlInfo;
   }
+  /**
+   * Retrieves the power state of the unit.
+   */
   async getPowered() {
     return (await this.getControlInfo()).power;
   }
+  /**
+   * Sets the powered state of the unit.
+   * @param state true to turn the unit on.
+   */
   async setPowered(state) {
     return await this.setControlInfo({ power: state });
   }
+  /**
+   * Gets the current mode of the unit.
+   */
   async getMode() {
     return (await this.getControlInfo()).mode;
   }
+  /**
+   * Sets the mode of the unit.
+   * @param mode The mode to set
+   */
   async setMode(mode) {
     return await this.setControlInfo({ mode });
   }
+  /**
+   * Gets the current fan settings of the unit.
+   * @returns the current fan settings.
+   */
   async getFan() {
     const info = await this.getControlInfo();
     return {
@@ -394,21 +418,31 @@ var DaikinClient = class {
       airside: info.fanAirside
     };
   }
+  /**
+   * Sets the fan settings of the unit.
+   * @param fan the fan settings to set.
+   */
   async setFan(fan) {
     return await this.setControlInfo({ fanSpeed: fan.speed, fanAuto: fan.auto, fanAirside: fan.airside ?? false });
   }
+  /**
+   * Gets the current target temperature of the unit
+   */
   async getTargetTemperature() {
     return (await this.getControlInfo()).targetTemperature;
   }
+  /**
+   * Sets the target temperature of the unit.
+   * @param temperature the temperature to set. This is rounded to the nearest integer.
+   */
   async setTargetTemperature(temperature) {
     return await this.setControlInfo({ targetTemperature: temperature });
   }
-  async getSensorTemperatures() {
-    return (await this.getControlInfo()).sensorTemperatures;
-  }
+  /** Gets the current status of the unit. */
   async getStatus() {
     return (await this.getControlInfo()).status;
   }
+  /** Sets the control state of the unit. */
   async setControlInfo(info) {
     const latest = await this.getControlInfo();
     const update = { ...latest, ...info };
@@ -431,6 +465,32 @@ var DaikinClient = class {
       throw new Error(`Failed to update control info: ${response.ret}`);
     this.cachedControlInfo = update;
   }
+  /**
+   * Get the current reading of the temperature sensors.
+   */
+  async getSensorInfo() {
+    const response = await get_sensor_info(this.api);
+    return this.cachedSensorInfo = {
+      insideTemperature: response.htemp,
+      outsideTemperature: response.otemp === "-" ? void 0 : response.otemp
+    };
+  }
+  /** Gets the current indoor temperature reading. */
+  async getInsideTemperature() {
+    return (await this.getSensorInfo()).insideTemperature;
+  }
+  /** Gets the current outdoor temperature reading. */
+  async getOutsideTemperature() {
+    return (await this.getSensorInfo()).outsideTemperature;
+  }
+  /** Gets the cached state of the sensor info. */
+  getCachedSensorInfo() {
+    return this.cachedSensorInfo;
+  }
+  /**
+   * Gets the basic information about the aircon.
+   * @returns the basic information about the aircon.
+   */
   async getBasicInfo() {
     const response = await basic_info(this.api);
     return {

package/dist/index.d.mts

@@ -307,7 +307,7 @@ type ControlInfo = {
     fanAuto: boolean;
     fanAirside: boolean;
     targetTemperature: number;
-    sensorTemperatures: number[];
+    controlTemperature: number[];
     power: boolean;
     status: Status;
     swinging: boolean;
@@ -315,6 +315,10 @@ type ControlInfo = {
     isCentrallyControlled: boolean;
     remoteControlType: RemoteType;
 };
+type SensorInfo = {
+    insideTemperature: number;
+    outsideTemperature: number | undefined;
+};
 
 type DeviceOption = {
     device: DiscoveredDevice;
@@ -335,23 +339,73 @@ declare class DaikinClient {
     readonly api: Client;
     readonly zones: Zones;
     private cachedControlInfo;
+    private cachedSensorInfo;
     constructor(options: DaikinClientOptions);
+    /**
+     * Gets the current state of the aircon.
+     * @returns the current state of the aircon.
+     */
     getControlInfo(): Promise<ControlInfo>;
+    /** Gets the cached state of the aircon. */
     getCachedControlInfo(): ControlInfo | undefined;
+    /**
+     * Retrieves the power state of the unit.
+     */
     getPowered(): Promise<boolean>;
+    /**
+     * Sets the powered state of the unit.
+     * @param state true to turn the unit on.
+     */
     setPowered(state: boolean): Promise<void>;
+    /**
+     * Gets the current mode of the unit.
+     */
     getMode(): Promise<ControlMode>;
+    /**
+     * Sets the mode of the unit.
+     * @param mode The mode to set
+     */
     setMode(mode: ControlMode): Promise<void>;
+    /**
+     * Gets the current fan settings of the unit.
+     * @returns the current fan settings.
+     */
     getFan(): Promise<Fan>;
+    /**
+     * Sets the fan settings of the unit.
+     * @param fan the fan settings to set.
+     */
     setFan(fan: Fan): Promise<void>;
+    /**
+     * Gets the current target temperature of the unit
+     */
     getTargetTemperature(): Promise<number>;
+    /**
+     * Sets the target temperature of the unit.
+     * @param temperature the temperature to set. This is rounded to the nearest integer.
+     */
     setTargetTemperature(temperature: number): Promise<void>;
-    getSensorTemperatures(): Promise<number[]>;
+    /** Gets the current status of the unit. */
     getStatus(): Promise<Status>;
+    /** Sets the control state of the unit. */
     setControlInfo(info: Partial<ControlInfo>): Promise<void>;
+    /**
+     * Get the current reading of the temperature sensors.
+     */
+    getSensorInfo(): Promise<SensorInfo>;
+    /** Gets the current indoor temperature reading. */
+    getInsideTemperature(): Promise<number>;
+    /** Gets the current outdoor temperature reading. */
+    getOutsideTemperature(): Promise<number | undefined>;
+    /** Gets the cached state of the sensor info. */
+    getCachedSensorInfo(): SensorInfo | undefined;
+    /**
+     * Gets the basic information about the aircon.
+     * @returns the basic information about the aircon.
+     */
     getBasicInfo(): Promise<BasicInfo>;
     /** Broadcasts a request to discover devices on the network. */
     static discover(timeoutMs?: number): Promise<DiscoveredDevice[]>;
 }
 
-export { type BasicInfo, type BasicInfoResponse, Client, type ControlInfo, type ControlInfoRequestParam, type ControlInfoResponse, ControlMode, DaikinClient, type DaikinClientOptions, type DaikinError, type DaikinResponse, type DateTimeResponse, type DealerInfoResponse, type DiscoveredDevice, type Fan, FanSpeed, type ModelInfoResponse, type NetworkSettingResponse, type QuickTimerResponse, RemoteType, type SensorInfoResponse, Status, type WifiSettingResponse, type Zone, type ZoneSettingRequestParam, type ZoneSettingResponse, Zones, basic_info, discover, getNetwork_setting, get_control_info, get_datetime, get_dealer_info, get_model_info, get_quick_timer, get_sensor_info, get_wifi_setting, get_zone_settings, set_control_info, set_zone_setting };
+export { type BasicInfo, type BasicInfoResponse, Client, type ControlInfo, type ControlInfoRequestParam, type ControlInfoResponse, ControlMode, DaikinClient, type DaikinClientOptions, type DaikinError, type DaikinResponse, type DateTimeResponse, type DealerInfoResponse, type DiscoveredDevice, type Fan, FanSpeed, type ModelInfoResponse, type NetworkSettingResponse, type QuickTimerResponse, RemoteType, type SensorInfo, type SensorInfoResponse, Status, type WifiSettingResponse, type Zone, type ZoneSettingRequestParam, type ZoneSettingResponse, Zones, basic_info, discover, getNetwork_setting, get_control_info, get_datetime, get_dealer_info, get_model_info, get_quick_timer, get_sensor_info, get_wifi_setting, get_zone_settings, set_control_info, set_zone_setting };

package/dist/index.d.ts

@@ -307,7 +307,7 @@ type ControlInfo = {
     fanAuto: boolean;
     fanAirside: boolean;
     targetTemperature: number;
-    sensorTemperatures: number[];
+    controlTemperature: number[];
     power: boolean;
     status: Status;
     swinging: boolean;
@@ -315,6 +315,10 @@ type ControlInfo = {
     isCentrallyControlled: boolean;
     remoteControlType: RemoteType;
 };
+type SensorInfo = {
+    insideTemperature: number;
+    outsideTemperature: number | undefined;
+};
 
 type DeviceOption = {
     device: DiscoveredDevice;
@@ -335,23 +339,73 @@ declare class DaikinClient {
     readonly api: Client;
     readonly zones: Zones;
     private cachedControlInfo;
+    private cachedSensorInfo;
     constructor(options: DaikinClientOptions);
+    /**
+     * Gets the current state of the aircon.
+     * @returns the current state of the aircon.
+     */
     getControlInfo(): Promise<ControlInfo>;
+    /** Gets the cached state of the aircon. */
     getCachedControlInfo(): ControlInfo | undefined;
+    /**
+     * Retrieves the power state of the unit.
+     */
     getPowered(): Promise<boolean>;
+    /**
+     * Sets the powered state of the unit.
+     * @param state true to turn the unit on.
+     */
     setPowered(state: boolean): Promise<void>;
+    /**
+     * Gets the current mode of the unit.
+     */
     getMode(): Promise<ControlMode>;
+    /**
+     * Sets the mode of the unit.
+     * @param mode The mode to set
+     */
     setMode(mode: ControlMode): Promise<void>;
+    /**
+     * Gets the current fan settings of the unit.
+     * @returns the current fan settings.
+     */
     getFan(): Promise<Fan>;
+    /**
+     * Sets the fan settings of the unit.
+     * @param fan the fan settings to set.
+     */
     setFan(fan: Fan): Promise<void>;
+    /**
+     * Gets the current target temperature of the unit
+     */
     getTargetTemperature(): Promise<number>;
+    /**
+     * Sets the target temperature of the unit.
+     * @param temperature the temperature to set. This is rounded to the nearest integer.
+     */
     setTargetTemperature(temperature: number): Promise<void>;
-    getSensorTemperatures(): Promise<number[]>;
+    /** Gets the current status of the unit. */
     getStatus(): Promise<Status>;
+    /** Sets the control state of the unit. */
     setControlInfo(info: Partial<ControlInfo>): Promise<void>;
+    /**
+     * Get the current reading of the temperature sensors.
+     */
+    getSensorInfo(): Promise<SensorInfo>;
+    /** Gets the current indoor temperature reading. */
+    getInsideTemperature(): Promise<number>;
+    /** Gets the current outdoor temperature reading. */
+    getOutsideTemperature(): Promise<number | undefined>;
+    /** Gets the cached state of the sensor info. */
+    getCachedSensorInfo(): SensorInfo | undefined;
+    /**
+     * Gets the basic information about the aircon.
+     * @returns the basic information about the aircon.
+     */
     getBasicInfo(): Promise<BasicInfo>;
     /** Broadcasts a request to discover devices on the network. */
     static discover(timeoutMs?: number): Promise<DiscoveredDevice[]>;
 }
 
-export { type BasicInfo, type BasicInfoResponse, Client, type ControlInfo, type ControlInfoRequestParam, type ControlInfoResponse, ControlMode, DaikinClient, type DaikinClientOptions, type DaikinError, type DaikinResponse, type DateTimeResponse, type DealerInfoResponse, type DiscoveredDevice, type Fan, FanSpeed, type ModelInfoResponse, type NetworkSettingResponse, type QuickTimerResponse, RemoteType, type SensorInfoResponse, Status, type WifiSettingResponse, type Zone, type ZoneSettingRequestParam, type ZoneSettingResponse, Zones, basic_info, discover, getNetwork_setting, get_control_info, get_datetime, get_dealer_info, get_model_info, get_quick_timer, get_sensor_info, get_wifi_setting, get_zone_settings, set_control_info, set_zone_setting };
+export { type BasicInfo, type BasicInfoResponse, Client, type ControlInfo, type ControlInfoRequestParam, type ControlInfoResponse, ControlMode, DaikinClient, type DaikinClientOptions, type DaikinError, type DaikinResponse, type DateTimeResponse, type DealerInfoResponse, type DiscoveredDevice, type Fan, FanSpeed, type ModelInfoResponse, type NetworkSettingResponse, type QuickTimerResponse, RemoteType, type SensorInfo, type SensorInfoResponse, Status, type WifiSettingResponse, type Zone, type ZoneSettingRequestParam, type ZoneSettingResponse, Zones, basic_info, discover, getNetwork_setting, get_control_info, get_datetime, get_dealer_info, get_model_info, get_quick_timer, get_sensor_info, get_wifi_setting, get_zone_settings, set_control_info, set_zone_setting };

package/dist/index.mjs

@@ -289,6 +289,7 @@ var DaikinClient = class {
   api;
   zones;
   cachedControlInfo;
+  cachedSensorInfo;
   constructor(options) {
     this.options = options;
     if ("host" in options) {
@@ -298,6 +299,10 @@ var DaikinClient = class {
     }
     this.zones = new Zones(this);
   }
+  /**
+   * Gets the current state of the aircon.
+   * @returns the current state of the aircon.
+   */
   async getControlInfo() {
     const response = await get_control_info(this.api);
     const responseValues = Object.entries(response);
@@ -307,7 +312,7 @@ var DaikinClient = class {
       fanAuto: response.f_auto != 0,
       fanAirside: response.f_airside != 0,
       targetTemperature: response.stemp,
-      sensorTemperatures: responseValues.filter(([k, v]) => k.startsWith("dt")).map(([k, v]) => +v),
+      controlTemperature: responseValues.filter(([k, v]) => k.startsWith("dt")).map(([k, v]) => +v),
       power: response.pow != 0,
       status: Number(response.operate),
       swinging: response.f_dir != 0,
@@ -316,21 +321,40 @@ var DaikinClient = class {
       remoteControlType: Number(response.remo)
     };
   }
+  /** Gets the cached state of the aircon. */
   getCachedControlInfo() {
     return this.cachedControlInfo;
   }
+  /**
+   * Retrieves the power state of the unit.
+   */
   async getPowered() {
     return (await this.getControlInfo()).power;
   }
+  /**
+   * Sets the powered state of the unit.
+   * @param state true to turn the unit on.
+   */
   async setPowered(state) {
     return await this.setControlInfo({ power: state });
   }
+  /**
+   * Gets the current mode of the unit.
+   */
   async getMode() {
     return (await this.getControlInfo()).mode;
   }
+  /**
+   * Sets the mode of the unit.
+   * @param mode The mode to set
+   */
   async setMode(mode) {
     return await this.setControlInfo({ mode });
   }
+  /**
+   * Gets the current fan settings of the unit.
+   * @returns the current fan settings.
+   */
   async getFan() {
     const info = await this.getControlInfo();
     return {
@@ -339,21 +363,31 @@ var DaikinClient = class {
       airside: info.fanAirside
     };
   }
+  /**
+   * Sets the fan settings of the unit.
+   * @param fan the fan settings to set.
+   */
   async setFan(fan) {
     return await this.setControlInfo({ fanSpeed: fan.speed, fanAuto: fan.auto, fanAirside: fan.airside ?? false });
   }
+  /**
+   * Gets the current target temperature of the unit
+   */
   async getTargetTemperature() {
     return (await this.getControlInfo()).targetTemperature;
   }
+  /**
+   * Sets the target temperature of the unit.
+   * @param temperature the temperature to set. This is rounded to the nearest integer.
+   */
   async setTargetTemperature(temperature) {
     return await this.setControlInfo({ targetTemperature: temperature });
   }
-  async getSensorTemperatures() {
-    return (await this.getControlInfo()).sensorTemperatures;
-  }
+  /** Gets the current status of the unit. */
   async getStatus() {
     return (await this.getControlInfo()).status;
   }
+  /** Sets the control state of the unit. */
   async setControlInfo(info) {
     const latest = await this.getControlInfo();
     const update = { ...latest, ...info };
@@ -376,6 +410,32 @@ var DaikinClient = class {
       throw new Error(`Failed to update control info: ${response.ret}`);
     this.cachedControlInfo = update;
   }
+  /**
+   * Get the current reading of the temperature sensors.
+   */
+  async getSensorInfo() {
+    const response = await get_sensor_info(this.api);
+    return this.cachedSensorInfo = {
+      insideTemperature: response.htemp,
+      outsideTemperature: response.otemp === "-" ? void 0 : response.otemp
+    };
+  }
+  /** Gets the current indoor temperature reading. */
+  async getInsideTemperature() {
+    return (await this.getSensorInfo()).insideTemperature;
+  }
+  /** Gets the current outdoor temperature reading. */
+  async getOutsideTemperature() {
+    return (await this.getSensorInfo()).outsideTemperature;
+  }
+  /** Gets the cached state of the sensor info. */
+  getCachedSensorInfo() {
+    return this.cachedSensorInfo;
+  }
+  /**
+   * Gets the basic information about the aircon.
+   * @returns the basic information about the aircon.
+   */
   async getBasicInfo() {
     const response = await basic_info(this.api);
     return {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "daikin-airbase",
-  "version": "0.2.0",
+  "version": "0.3.0",
   "main": "./dist/index.cjs",
   "module": "./dist/index.mjs",
   "types": "./dist/index.d.ts",