Merge pull request #64 from abn/add-consumptionDetails

api: add support for /consumptionDetails endpoint
mattdavis90 · Oct 26, 2024 · edf6b61 · edf6b61
2 parents cd21838 + 11d415d
commit edf6b61
Show file tree

Hide file tree

Showing 8 changed files with 688 additions and 1 deletion.
diff --git a/build/index.d.ts b/build/index.d.ts
@@ -8,6 +8,7 @@ import {
   Country,
   DefaultOverlay,
   Device,
+  EnergyIQConsumptionDetails,
   EnergyIQMeterReadings,
   EnergyIQOverview,
   EnergyIQTariff,
@@ -188,6 +189,11 @@ export declare class Tado {
   setChildlock(serial_no: string, child_lock: boolean): Promise<void>;
   getAirComfort(home_id: number): Promise<AirComfort>;
   getAirComfortDetailed(home_id: number): Promise<AirComfortDetailed>;
+  EnergyIQConsumptionDetails(
+    home_id: number,
+    month: number,
+    year: number,
+  ): Promise<EnergyIQConsumptionDetails>;
   getEnergyIQOverview(home_id: number, month: number, year: number): Promise<EnergyIQOverview>;
   getEnergyIQTariff(home_id: number): Promise<EnergyIQTariff>;
   addEnergyIQTariff(

diff --git a/build/index.js b/build/index.js
diff --git a/build/index.js.map b/build/index.js.map
diff --git a/build/types/index.d.ts b/build/types/index.d.ts
@@ -531,6 +531,24 @@ export type EnergyIQOverview = {
   };
   ecogaz: unknown;
 };
+export type EnergyIQConsumptionDetailsSummary = {
+  costInCents: number;
+  costForecastInCents: number;
+  averageDailyCostInCents: number;
+  consumption: number;
+  consumptionForecast: number;
+  averageDailyConsumption: number;
+  unit: IQUnit;
+  tariff: {
+    unit: IQUnit;
+    unitPriceInCents: number;
+  };
+};
+export type EnergyIQConsumptionDetails = {
+  isInPreferredUnit: boolean;
+  summary: EnergyIQConsumptionDetailsSummary;
+  graphConsumption: EnergyIQOverview;
+};
 export type EnergyIQMeterReading = {
   id: string;
   homeId: number;

diff --git a/src/index.ts b/src/index.ts
@@ -11,6 +11,7 @@ import {
   DeepPartial,
   DefaultOverlay,
   Device,
+  EnergyIQConsumptionDetails,
   EnergyIQMeterReadings,
   EnergyIQOverview,
   EnergyIQTariff,
@@ -662,6 +663,17 @@ export class Tado {
     return this.apiCall(`https://acme.tado.com/v1/homes/${home_id}/airComfort?${location}`);
   }
 
+  async EnergyIQConsumptionDetails(
+    home_id: number,
+    month: number,
+    year: number,
+  ): Promise<EnergyIQConsumptionDetails> {
+    const date = `${year}-${month.toString().padStart(2, "0")}`;
+    return this.apiCall(
+      `https://energy-insights.tado.com/api/homes/${home_id}/consumptionDetails?month=${date}`,
+    );
+  }
+
   async getEnergyIQOverview(
     home_id: number,
     month: number,

diff --git a/src/types/index.ts b/src/types/index.ts
@@ -592,6 +592,23 @@ export type EnergyIQOverview = {
   ecogaz: unknown;
 };
 
+export type EnergyIQConsumptionDetailsSummary = {
+  costInCents: number;
+  costForecastInCents: number;
+  averageDailyCostInCents: number;
+  consumption: number;
+  consumptionForecast: number;
+  averageDailyConsumption: number;
+  unit: IQUnit;
+  tariff: { unit: IQUnit; unitPriceInCents: number };
+};
+
+export type EnergyIQConsumptionDetails = {
+  isInPreferredUnit: boolean;
+  summary: EnergyIQConsumptionDetailsSummary;
+  graphConsumption: EnergyIQOverview;
+};
+
 export type EnergyIQMeterReading = {
   id: string;
   homeId: number;

diff --git a/test/index.test.js b/test/index.test.js
@@ -23,6 +23,7 @@ const away_configuration_response = require("./response.away");
 const timetable_response = require("./response.timetable");
 const zone_overlay_response = require("./response.zone.overlay");
 const eneryIQOverview_response = require("./response.energyIQOverview");
+const eneryIQConsumptionDetails_response = require("./response.energyIQConsumptionDetails");
 const eneryIQ_tariff_response = require("./response.eneryIQ.tariff");
 const eneryIQ_meter_readings_response = require("./response.eneryIQ.meterReadings");
 const eneryIQ_savings_response = require("./response.eneryIQ.savings");
@@ -613,6 +614,22 @@ describe("High-level API tests", () => {
       .catch(done);
   });
 
+  it("Should get getEnergyIQConsumptionDetails", (done) => {
+    nock("https://energy-insights.tado.com")
+      .get("/api/homes/1907/consumptionDetails?month=2024-10")
+      .reply(200, eneryIQConsumptionDetails_response);
+
+    tado
+      .EnergyIQConsumptionDetails("1907", 10, 2024)
+      .then((response) => {
+        expect(typeof response).to.equal("object");
+        expect(response.summary.averageDailyCostInCents).to.equal(164.7665);
+        expect(response.graphConsumption).to.deep.equal(eneryIQOverview_response);
+        done();
+      })
+      .catch(done);
+  });
+
   it("Should get energyIQ Tariff", (done) => {
     nock("https://energy-insights.tado.com")
       .get("/api/homes/1907/tariffs")