homebridge-hilo/src/hilo.ts

Plugin Homebridge (non officiel) pour la passerelle et les appareils Hilo de Hydro-Québec | Unofficial Homebridge plugin for Hydro-Québec Hilo bridge and devices

import {
  API,
  APIEvent,
  DynamicPlatformPlugin,
  Logging,
  PlatformAccessory,
  PlatformConfig,
} from "homebridge";
import { getConfig, HiloConfig, setConfig } from "./config";
import { getLogger, setLogger } from "./logger";
import { setApi } from "./api";
import { hiloApi } from "./hiloApi";
import { initializeHiloDevice } from "./devices";
import { HiloDevice } from "./devices/HiloDevice";
import { setupSubscription } from "./subscription";
import { Device } from "./graphql/graphql";
import { fetchDevicesForLocation } from "./location";
import {
  ChallengeAccessory,
  DeviceAccessory,
  EventsResponse,
  OldApiDevice,
  SUPPORTED_DEVICES,
} from "./devices/types";
import { HiloChallengeSensor } from "./devices/HiloChallengeSensor";
import axios from "axios";
const PLUGIN_NAME = "homebridge-hilo";
const PLATFORM_NAME = "Hilo";

export default function (api: API) {
  api.registerPlatform(PLATFORM_NAME, Hilo);
}

class Hilo implements DynamicPlatformPlugin {
  private readonly pluginAccessories: Record<string, HiloDevice<any>> = {};
  private locations: Location[] = [];
  private subscriptions: Record<string, any> = {};
  private oldApiDevices: OldApiDevice[] = [];
  private staleAccessories: PlatformAccessory<any>[] = [];
  constructor(
    private readonly log: Logging,
    private readonly config: PlatformConfig,
    private readonly api: API,
    private readonly accessories: Record<
      string,
      | PlatformAccessory<DeviceAccessory<Device>>
      | PlatformAccessory<ChallengeAccessory>
    > = {},
  ) {
    setConfig(config as HiloConfig);
    this.config = getConfig();
    if (!this.config.refreshToken) {
      this.log.error("Please login with hilo in the plugin configuration page");
      return;
    }
    setLogger(log);
    setApi(api);
    log.info("Initializing Hilo platform");
    api.on(APIEvent.DID_FINISH_LAUNCHING, async () => {
      this.locations = await fetchLocations();
      if (this.locations.length === 0) {
        log.error("No locations found");
        return;
      }
      const devices = (
        await Promise.all(
          this.locations.map((location) =>
            fetchDevicesForLocation(location.locationHiloId),
          ),
        )
      )
        .flatMap((response) => response)
        .filter((device) => SUPPORTED_DEVICES.includes(device.__typename!));
      this.oldApiDevices = (
        await Promise.all(
          this.locations.map((location) => fetchDevices(location)),
        )
      ).flatMap((response) => response);

      if (devices.length === 0) {
        log.error("No devices found");
        return;
      }
      devices.forEach((device) => {
        this.log.debug("Initializing device", device);
        const oldDevice = this.oldApiDevices.find(
          (d) => d.hiloId === device.hiloId,
        );
        if (!oldDevice) {
          this.log.error("No old device found for", device);
          return;
        }
        let accessory = this.accessories[device.hiloId];
        if (!accessory) {
          this.log.debug(
            `Setting up new accessory for device ${device.hiloId}`,
          );
          accessory = this.setupNewAccessory(device, oldDevice);
        } else if (accessory.context.device.type !== "Challenge") {
          this.log.debug(
            `Setting up cached accessory for device ${device.hiloId}`,
          );
          (accessory.context as DeviceAccessory<Device>) = {
            device: oldDevice,
            graphqlDevice: device,
          };
        }
        const pluginAccessory = initializeHiloDevice[device.__typename!](
          accessory as any,
          this.api,
        );
        this.pluginAccessories[device.hiloId] = pluginAccessory;
      });
      this.setupSubscriptions();

      const currentDeviceHiloIds = this.oldApiDevices.map(
        (device) => device.hiloId,
      );
      this.staleAccessories.concat(
        Object.values(this.accessories).filter((accessory) => {
          if (accessory.context.device.type === "Challenge") {
            return false;
          } else {
            return !currentDeviceHiloIds.includes(
              accessory.context.device.hiloId,
            );
          }
        }),
      );
      this.log.debug(
        `Found ${this.staleAccessories.length} stale accessories removing...`,
      );
      this.api.unregisterPlatformAccessories(
        PLUGIN_NAME,
        PLATFORM_NAME,
        this.staleAccessories,
      );

      if (this.config.noChallengeSensor !== true) {
        // Add Hilo Challenge sensor for each location
        this.log.info("Setting up Hilo Challenge sensors");
        this.locations.forEach((location) => {
          const challengeDevices = this.setupHiloChallengeDevices(location);

          setInterval(
            async () => {
              this.updateChallenges(location, challengeDevices);
            },
            /* 4 hours */ 4 * 60 * 60 * 1000,
          );
          this.updateChallenges(location, challengeDevices);
        });
      }
      log.info("Hilo platform is ready");
    });
  }

  private setupHiloChallengeDevices(location: Location): HiloChallengeSensor[] {
    return [
      "preheat",
      "reduction",
      "recovery",
      "plannedAM",
      "plannedPM",
      "inProgress",
    ].map((phase, index) => {
      const challengeId = `${phase}-hilo-challenge-${location.id}`;
      const challengeName = `${phase.charAt(0).toUpperCase() + phase.slice(1)} Hilo Challenge ${location.name}`;
      let challengeAccessory = this.accessories[challengeId] as unknown as
        | PlatformAccessory<ChallengeAccessory>
        | undefined;
      if (!challengeAccessory) {
        const uuid = this.api.hap.uuid.generate(challengeId);
        challengeAccessory = new this.api.platformAccessory<ChallengeAccessory>(
          challengeName,
          uuid,
        );
        challengeAccessory.context = {
          device: {
            assetId: challengeId,
            id: location.id + index + 100,
            name: challengeName,
            type: "Challenge",
            locationId: location.id,
            modelNumber: "Hilo Challenge",
            identifier: challengeId,
            hiloId: challengeId,
          },
          v4Device: {
            value: false,
            phase,
            localId: challengeId,
          },
        };
        this.api.registerPlatformAccessories(PLUGIN_NAME, PLATFORM_NAME, [
          challengeAccessory,
        ]);
        this.accessories[challengeId] = challengeAccessory as any;
      } else {
        challengeAccessory.context = {
          device: {
            assetId: challengeId,
            id: location.id + index + 100,
            name: challengeName,
            type: "Challenge",
            locationId: location.id,
            modelNumber: "Hilo Challenge",
            identifier: challengeId,
            hiloId: challengeId,
          },
          v4Device: {
            value: false,
            phase,
            localId: challengeId,
          },
        };
      }
      return new HiloChallengeSensor(
        challengeAccessory as any,
        this.api,
        this.log,
      );
    });
  }

  private async setupSubscriptions() {
    for (const location of this.locations) {
      try {
        const subscription = await setupSubscription(
          location.locationHiloId,
          (device) => {
            this.log.debug(`Device update received:`, device);
            const oldApiDevice = this.oldApiDevices.find(
              (d) => d.hiloId === device.hiloId,
            );
            if (!oldApiDevice) {
              this.log.error("No old device found for", device);
              return;
            }
            const accessory = this.accessories[device.hiloId];
            const pluginAccessory = this.pluginAccessories[device.hiloId];
            if (!accessory || !pluginAccessory) {
              this.log.debug(`No accessory for device ${device.hiloId}`);
              return;
            }
            pluginAccessory.updateDevice(device);
          },
        );
        this.subscriptions[location.locationHiloId] = subscription;
        this.log.info(
          `Subscribed to updates for location ${location.locationHiloId}`,
        );
      } catch (error: unknown) {
        this.log.error(
          `Failed to subscribe to location ${location.locationHiloId}:`,
          error instanceof Error ? error.message : String(error),
        );
      }
    }
  }

  configureAccessory(accessory: PlatformAccessory): void {
    this.log.debug(`Configuring accessory from cache ${accessory.displayName}`);
    if (
      accessory.context.device.type !== "Challenge" &&
      !accessory.context.device.hiloId
    ) {
      this.log.warn(`Could not configure accessory ${accessory.displayName}`);
      this.staleAccessories.push(accessory);
      return;
    }
    this.accessories[accessory.context.device.hiloId] = accessory as
      | PlatformAccessory<DeviceAccessory<Device>>
      | PlatformAccessory<ChallengeAccessory>;
  }

  private setupNewAccessory(
    device: Device,
    oldApiDevice: OldApiDevice,
  ): PlatformAccessory<DeviceAccessory<Device>> {
    const uuid = this.api.hap.uuid.generate(oldApiDevice.assetId);
    const accessory = new this.api.platformAccessory<DeviceAccessory<Device>>(
      oldApiDevice.name.trim(),
      uuid,
    );
    accessory.context = {
      device: oldApiDevice,
      graphqlDevice: device,
    };
    this.api.registerPlatformAccessories(PLUGIN_NAME, PLATFORM_NAME, [
      accessory,
    ]);
    this.accessories[device.hiloId] = accessory;
    return accessory;
  }

  private async updateChallenges(
    location: Location,
    challengeDevices: HiloChallengeSensor[],
  ) {
    if (this.config.noChallengeSensor === true) {
      return;
    }
    try {
      const response = await hiloApi.get<EventsResponse>(
        `/GDService/v1/api/Locations/${location.id}/Events`,
        { params: { active: true } },
      );
      const challenges = response.data;
      challengeDevices.forEach((device) =>
        device.updateChallengeStatus(challenges),
      );
    } catch (error) {
      this.log.error("Could not retrieve Hilo Challenges", error);
    }
  }
}

type Location = {
  id: number;
  locationHiloId: string;
  adressId: string;
  name: string;
  energyCostConfigured: boolean;
  postalCode: string;
  countryCode: string;
  temperatureFormat: string;
  timeFormat: string;
  timeZone: string;
  gatewayCount: number;
  createdUtc: string;
};
type LocationsResponse = Array<Location>;
async function fetchLocations() {
  getLogger().debug("Fetching locations");
  try {
    const response = await hiloApi.get<LocationsResponse>(
      "/Automation/v1/api/Locations",
      {
        params: { force: true },
      },
    );
    return response.data;
  } catch (error: unknown) {
    getLogger().error(
      "Error while fetching locations",
      error instanceof Error ? error.message : String(error),
    );
    return [];
  }
}

type DevicesResponse = OldApiDevice[];
async function fetchDevices(location: Location) {
  getLogger().debug("Fetching devices for location", location.name);
  try {
    const response = await hiloApi.get<DevicesResponse>(
      `/Automation/v1/api/Locations/${location.id}/Devices`,
      {
        params: { force: true },
      },
    );
    return response.data;
  } catch (error) {
    getLogger().error(
      "Error while fetching devices",
      axios.isAxiosError(error) ? error.response?.data : error,
    );
    return [];
  }
}