homebridge-smarthq-client 1.0.0

package/src/refrigerator/waterFilter.ts

@@ -0,0 +1,107 @@
+import { CharacteristicValue, PlatformAccessory, Logging } from 'homebridge';
+import { SmartHqPlatform } from '../platform.js';
+import { SmartHqApi } from '../smartHqApi.js';
+import { DevService } from '../smarthq-types.js';
+
+/**
+ * Platform Accessory
+ * An instance of this class is created for each accessory your platform registers
+ * Each accessory may expose multiple services of different service types.
+ */
+export class WaterFilter {
+
+  private readonly smartHqApi: SmartHqApi;
+  private log : Logging;
+
+  constructor(
+    private readonly platform: SmartHqPlatform,
+    private readonly accessory: PlatformAccessory,
+    public readonly deviceServices: DevService[],
+    public readonly deviceId: string
+    ) {
+    this.platform = platform;
+    this.accessory = accessory;
+    this.deviceServices = deviceServices;
+    this.deviceId = deviceId;
+    this.log = platform.log;
+
+    this.smartHqApi = new SmartHqApi(this.platform); 
+
+    //=====================================================================================
+    // Check to see if the device has any supported FilterMaintenance services
+    // If not, then don't add services for device that doesn't support it
+    //=====================================================================================
+
+    if (!this.platform.deviceSupportsThisService(this.deviceServices, 
+          'cloud.smarthq.device.waterfilter',
+          'cloud.smarthq.service.mode',
+          'cloud.smarthq.domain.state')) {
+      this.log.info('No supported FilterMaintenance service found for device: ' + this.accessory.displayName);
+      return;
+    }
+    this.platform.debug('green', 'Adding a Water Filter Sensor');
+
+    //=====================================================================================
+    // create a new water FilterMaintenance service for the Refrigerator
+    // This works in Homebridge and HomeKit has a native FilterMaintenance service type but the Home app does not implement it yet 
+    // so no sensor/accessory will show up in the Home app for this service type.
+    //===================================================================================== 
+    const displayName = "Filter Life";
+    const refrigeratorWaterFilter = this.accessory.getService(displayName) 
+    || this.accessory.addService(this.platform.Service.FilterMaintenance, displayName, 'filter-maintenance-1');
+    refrigeratorWaterFilter.addOptionalCharacteristic(this.platform.Characteristic.ConfiguredName)
+    refrigeratorWaterFilter.setCharacteristic(this.platform.Characteristic.ConfiguredName, displayName)
+
+    refrigeratorWaterFilter.getCharacteristic(this.platform.Characteristic.FilterChangeIndication)
+      .onGet(this.getWaterFilterChangeIndication.bind(this));
+      refrigeratorWaterFilter.getCharacteristic(this.platform.Characteristic.FilterLifeLevel)
+      .onGet(this.getWaterFilterLifeLevel.bind(this));
+      
+    
+  
+  }
+  //=====================================================================================
+  async getWaterFilterChangeIndication(): Promise<CharacteristicValue> {
+    let filterStatus = 0
+    for (const service of this.deviceServices) {
+      if (service.serviceDeviceType === 'cloud.smarthq.device.waterfilter' 
+        && service.serviceType      === 'cloud.smarthq.service.mode') {
+
+        const state = await this.smartHqApi.getServiceState(this.deviceId, service.serviceId);
+        if (state?.mode == null) {
+          this.platform.debug('blue', 'No state.mode returned from getWaterFilterChangeIndication state');
+          return false;
+        }
+        if (state?.mode  === 'cloud.smarthq.type.mode.good'
+          || state?.mode === 'cloud.smarthq.type.mode.bypass'
+          || state?.mode === 'cloud.smarthq.type.mode.expiringsoon'
+        ) {
+            filterStatus = this.platform.Characteristic.FilterChangeIndication.FILTER_OK;
+        } else {
+            filterStatus = this.platform.Characteristic.FilterChangeIndication.CHANGE_FILTER;
+        }
+      }
+    }
+    return filterStatus;
+  }
+
+  //=====================================================================================
+  async getWaterFilterLifeLevel(): Promise<CharacteristicValue> {
+    
+    let filterRemaining = 0;
+    for (const service of this.deviceServices) {
+      if (service.serviceDeviceType === 'cloud.smarthq.device.waterfilter' 
+        && service.serviceType      === 'cloud.smarthq.service.integer') {
+
+        const state = await this.smartHqApi.getServiceState(this.deviceId, service.serviceId);
+        if (state?.value == null) {
+          this.platform.debug('blue', 'No value returned from getWaterFilterLifeLevel state');
+          return false;
+        }
+        filterRemaining = state?.value;
+      }
+    }
+    return filterRemaining;
+  }
+
+}

package/src/refrigeratorServices.ts

@@ -0,0 +1,60 @@
+// These functions setup the various services for a refrigerator appliance
+// imported into platform.ts
+// Refrigerator and Freezer are always added; the rest are optional based on config settings
+
+import { Refrigerator }       from './refrigerator/refrigerator.js';
+import { Freezer }            from './refrigerator/freezer.js';
+import { ControlLock }        from './refrigerator/controlLock.js';
+import { ConvertibleDrawer }  from './refrigerator/convertibleDrawer.js';
+import { DispenserLight }     from './refrigerator/dispenserLight.js';
+import { EnergySensor }       from './refrigerator/energy.js';
+import { IceMaker }           from './refrigerator/iceMaker.js';
+import { InteriorLight }      from './refrigerator/interiorLight.js';
+import { SabbathMode }        from './refrigerator/sabbathMode.js';
+import { TemperatureUnits }   from './refrigerator/temperatureUnits.js';
+import { TurboCoolMode }      from './refrigerator/turboCoolMode.js';
+import { WaterFilter }        from './refrigerator/waterFilter.js';
+import { RefrigeratorAlerts } from './refrigerator/refrigeratorAlerts.js';
+import { DevService }         from './smarthq-types.js';
+import { PlatformAccessory }  from 'homebridge';
+import { SmartHqPlatform }    from './platform.js';
+import { DevDevice }          from './smarthq-types.js';
+
+
+  export function setupRefrigeratorServices(this: SmartHqPlatform, accessory: PlatformAccessory, device: DevDevice, deviceServices: DevService[]) {
+    new Refrigerator(this, accessory, deviceServices, device.deviceId);
+    new Freezer(this, accessory, deviceServices, device.deviceId);
+
+    if (this.config.addConvertibleDrawer) {
+      new ConvertibleDrawer(this, accessory, deviceServices, device.deviceId);}
+
+    if (this.config.addControlLock) {
+      new ControlLock(this, accessory, deviceServices, device.deviceId);}
+      
+    if (this.config.addDispenserLight) {
+      new DispenserLight(this, accessory, deviceServices, device.deviceId);}
+
+    if (this.config.addEnergyMonitor) {
+      new EnergySensor(this, accessory, deviceServices, device.deviceId);}
+
+    if (this.config.addIceMaker) {
+      new IceMaker(this, accessory, deviceServices, device.deviceId);}
+
+    if (this.config.addInteriorLight) {
+      new InteriorLight(this, accessory, deviceServices, device.deviceId);}
+
+    if (this.config.addSabbathMode) {
+      new SabbathMode(this, accessory, deviceServices, device.deviceId);}
+
+    if (this.config.addTemperatureUnits) {
+      new TemperatureUnits(this, accessory, deviceServices, device.deviceId);}
+
+    if (this.config.addTurboCool) {
+      new TurboCoolMode(this, accessory, deviceServices, device.deviceId);}
+
+    if (this.config.addWaterFilter) {
+      new WaterFilter(this, accessory, deviceServices, device.deviceId); }
+
+    if (this.config.addAlerts) {
+      new RefrigeratorAlerts(this, accessory, deviceServices, device.deviceId); }
+  } 

package/src/settings.ts

@@ -0,0 +1,14 @@
+/**
+ * This is the name of the platform that users will use to register the plugin in the Homebridge config.json
+ */
+export const PLATFORM_NAME = "SmartHqPlatform";
+
+/**
+ * This must match the name of your plugin as defined the package.json `name` property
+ */
+export const PLUGIN_NAME = 'homebridge-smarthq-client';
+export const API_URL =     'https://client.mysmarthq.com';
+
+export const AUTH_URL =    'https://accounts.brillion.geappliances.com/oauth2/auth';
+export const ACCESSTOKEN_URL =  'https://accounts.brillion.geappliances.com/oauth2/token';
+export const TOKEN_STORE =  'smarthq.tokens.json';

package/src/smartHqApi.ts

@@ -0,0 +1,305 @@
+import axios, { AxiosResponse, isAxiosError } from 'axios';
+import { writeFileSync, existsSync, readFileSync } from 'fs';
+import { stringify } from 'querystring';
+import chalk from 'chalk';
+
+import { API_URL, AUTH_URL, ACCESSTOKEN_URL} from './settings.js';
+import { SmartHqPlatform } from './platform.js';
+import { DevService } from './smarthq-types.js';
+
+/**
+ * SmartHq Api functions         
+ * This class is the main constructor for your plugin, this is where you should
+ * parse the user config and discover/register accessories with Homebridge.
+ */
+/* ---------- SmartHq Api ---------- */
+
+export class SmartHqApi {
+  refresh_token: string;
+  expires: number;
+  access_token: string;
+
+  constructor(
+    private readonly platform: SmartHqPlatform,
+  ) {
+    this.refresh_token = '';
+    this.access_token = '';
+    this.expires = 0;
+    this.loadAccessToken();
+  }
+
+
+  //-------------------------------------------------------------
+  // Create the url to be displayed in Homebridge log for first time
+  // user to visit the link and login successfully.
+  // Response will be sent to redirect uri
+  //-------------------------------------------------------------
+  authUrl() {
+    return AUTH_URL + stringify({
+      response_type: 'code',
+      client_id: this.platform.config.clientId,
+      redirect_uri: this.platform.config.redirectUri
+    });
+  }
+
+  async getOauthAccessToken(dataForBody: Record<string, string>) {
+    try {
+      const response = await axios.post(
+        ACCESSTOKEN_URL,
+        stringify(dataForBody),
+        { headers: { 'Content-Type': 'application/x-www-form-urlencoded' } }
+      );
+     
+      this.saveToken(response.data);
+    } catch (error) {
+      // Use isAxiosError type guard for safe property access
+      if (axios.isAxiosError(error)) {
+        if (error.response) {
+          switch (error.response.status) {
+            case 400:
+              this.platform.log.error('(400) Bad Request: The request is missing required parameters or includes invalid values.');
+              break;
+            case 401:
+              this.platform.log.error('(401) Unauthorized – The provided client credentials are invalid.: ');
+              break;
+            default:
+              this.platform.log.error('Error obtaining token: ', error.message);
+              break;
+          }
+        }
+      } else {
+        // Not an Axios error (e.g., a general JavaScript error)
+        console.error('Unexpected error:', error);
+      }
+    }
+  }
+
+  async exchangeCodeForToken(code: string) {
+    return this.getOauthAccessToken({
+      grant_type: 'authorization_code',
+      client_id: this.platform.config.clientId,
+      client_secret: this.platform.config.clientSecret,
+      redirect_uri: this.platform.config.redirectUri,
+      code: code
+    });
+  }
+
+  async refreshAccessToken() {
+    return this.getOauthAccessToken({
+      grant_type: 'refresh_token',
+      client_id: this.platform.config.clientId,
+      client_secret: this.platform.config.clientSecret,
+      refresh_token: this.refresh_token
+    });
+  }
+
+  saveToken(data: AxiosResponse['data']) {
+    Object.assign(this, data);
+    
+    this.expires = Date.now() + data.expires_in * 1000;
+    try {
+      writeFileSync(this.platform.tokenPath, JSON.stringify(data, null, 2));
+    } catch (error) {
+      this.platform.log.error('Error saving token: ', error);
+    }
+  }
+
+  loadAccessToken() {
+    if (!existsSync(this.platform.tokenPath)) return;
+    const data: string = readFileSync(this.platform.tokenPath).toString('utf8');
+    const tokenData = JSON.parse(data);
+    Object.assign(this, tokenData);
+    this.expires = Date.now() + tokenData.expires_in * 1000;
+  }
+
+  async httpHeaders() {
+    if (!this.access_token || Date.now() > this.expires - 60000) {
+      await this.refreshAccessToken();
+    }
+    return { Authorization: `Bearer ${this.access_token}` };
+  }
+  
+  async getAppliances() {
+    //======================================================
+    // Get list of devices for your account
+    //======================================================
+      this.debug('green', 'Entering getAppliances()');
+    
+    const url = new URL('/v2/device', API_URL);
+    try {
+      const res = await axios.get(url.toString(),
+        { headers: await this.httpHeaders() }
+      );
+      return res.data.devices;
+    } catch (error) {
+      if (isAxiosError(error)) {
+        if (error.response) {
+          switch (error.response.status) {
+            case 400:
+              this.platform.log.error('(400) Bad Request: ', error.message);
+              break;
+            case 401:
+              this.refreshAccessToken();
+              //this.platform.log.error('(401) Unauthorized: ', error.message);   token expired - refresh token instead of error
+              break;
+            case 403:
+              this.platform.log.error('(403) Forbidden client does not have permission to view device: ', error.message);
+              break;
+            default:
+              this.platform.log.error('Error in getAppliances(): ', error.message);
+              break;
+          }
+        }  else {
+          this.debug('red', ('Still here too early.'));
+        }
+      }
+    }
+  }
+
+  async getServiceState(deviceId: string, serviceId: string) {
+    //======================================================
+    // Get the state of the service        
+    //======================================================
+    const url = new URL(`/v2/device/${deviceId}/service/${serviceId}`, API_URL);
+    try {
+      const response = await axios.get(url.toString(),
+        { headers: await this.httpHeaders() }
+      );
+      if (!response.data) {
+        this.platform.log.error(
+          `Request ${url} failed with status ${response.status}`
+        );
+        return;
+      }
+      return response.data.state;
+      
+    } catch (error) {
+      if (isAxiosError(error)) {
+        if (error.response && error.response.status === 401) {
+          await this.refreshAccessToken();
+          this.debug('red', 'Token refreshed in getServiceState.');
+        }
+      }
+    }
+  }
+
+
+
+
+
+  async getDeviceServices(deviceId: string) {
+    const url = new URL(`/v2/device/${deviceId}`, API_URL);
+    try {
+        const response = await axios.get(url.toString(),
+          { headers: await this.httpHeaders() }
+        );
+        const services: DevService[] = response.data.services;
+        const sortedServices = services.sort((a, b) => {
+          if (a.serviceDeviceType < b.serviceDeviceType) return -1;
+          if (a.serviceDeviceType > b.serviceDeviceType) return 1;
+          return 0;
+        });
+
+        if (this.platform.config.debugServices) {
+          this.platform.log.info(chalk.red("(The 'state' of each service can be queried using getServiceState() in smartHQApi.js)"));
+          for (const service of sortedServices) {
+            this.platform.log.info(chalk.yellow("ServiceDeviceType = " + service.serviceDeviceType));
+            this.platform.log.info(chalk.yellow("ServiceType       = " + service.serviceType));
+            this.platform.log.info(chalk.yellow("Domain            = " + service.domainType));
+            this.platform.log.info(chalk.yellow("Valid Commands    = " + chalk.green(JSON.stringify(service.supportedCommands))));
+            this.platform.log.info(chalk.yellow("Config            = " + chalk.green(JSON.stringify(service.config))));
+            this.platform.log.info(chalk.yellow("State             = " + chalk.red(JSON.stringify(service.state))));
+            this.platform.log.info("------------------------------------------------------------------------");
+          }
+        }
+        if (!response.data) {
+          this.platform.log.error(
+            `Request ${url} failed with status ${response.status}`
+          );
+          return;
+        }
+        return response.data.services;
+    } catch (error) {
+      if (isAxiosError(error)) {
+        if (error.response && error.response.status === 401) {
+          await this.refreshAccessToken();
+          this.debug('red', 'Token refreshed in getDeviceServices.');
+        } else {
+          this.platform.log.error('Error from getDeviceServices():', error.message);
+        }
+      }
+    }
+  }
+ async getRecentAlerts() {
+    // Check for alerts every minute
+    const urlAlert = new URL(`/v2/alert/recent?after=1m`, API_URL);
+
+    try {
+        const res = await axios.get(urlAlert.toString(),
+          { headers: await this.httpHeaders() }
+        );
+        return res.data.alerts;
+
+    } catch (error) {
+      if (isAxiosError(error)) {
+        if (error.response && error.response.status === 401) {
+          await this.refreshAccessToken();
+          this.debug('red', 'Token refreshed in getRecentAlerts.');
+        } else {
+          this.platform.log.error('Error getting recent alerts:', + error.message);
+        }
+      } 
+    }
+  }
+
+  async command(body: string) {
+
+    const url = new URL('/v2/command', API_URL);
+
+    try {
+      const response = await axios.post(url.toString(), 
+        body,
+        { headers: await this.httpHeaders() }
+      );
+      return response.data;
+
+    } catch (error) {
+      if (isAxiosError(error)) {
+        if (error.response && error.response.status === 401) {
+          await this.refreshAccessToken();
+          this.debug('red', 'Token refreshed in command.');
+        } else {
+          this.platform.log.error('Error sending command:', body);
+          if (error.response) {       // that falls out of the range of 2xx
+            this.platform.log(error.response.data);
+          }
+        }
+      }
+  }
+}
+
+// Use chalk to color debug messages (local to this plugin)
+// only show debug messages if debugLogging is enabled in config
+
+debug(color: string, message: string) {
+    if (this.platform.config.debugLogging) {
+      switch(color) {
+        case 'red':
+          this.platform.log.info(chalk.red('[SmartHQ] ' + message));
+          break;
+        case 'blue':
+          this.platform.log.info(chalk.blue('[SmartHQ] ' + message));
+          break;
+        case 'green':
+          this.platform.log.info(chalk.green('[SmartHQ] ' + message));
+          break;
+        case 'yellow':
+          this.platform.log.info(chalk.yellow('[SmartHQ] ' + message));
+          break;
+        default:
+          this.platform.log.info('[SmartHQ] ' + message);
+      }
+    }  
+  }
+
+}

package/src/smarthq-types.ts

@@ -0,0 +1,31 @@
+export interface DevService {
+  serviceType: string;
+  lastSyncTime: string;
+  domainType: string;
+  supportedCommands: string[];
+  state: Record<string, unknown>;
+  serviceId: string;
+  serviceDeviceType: string;
+  config: Record<string, unknown>;
+  lastStateTime: string;
+}
+
+export interface DevDevice {
+    deviceType: string;
+    lastSyncTime: string;
+    roomNumber: string;
+    serial: string;
+    lastPresenceTime: string;
+    createdDateTime: string;
+    presence: string;
+    deviceId: string;
+    gatewayId: string;
+    room: string;
+    icon: string;
+    manufacturer: string;
+    nickname: string;
+    model: string;
+    floor: string;
+    macAddress: string;
+
+}

package/tsconfig.json

@@ -0,0 +1,24 @@
+{
+  "compilerOptions": {
+    "target": "ES2022",
+    "lib": [
+      "DOM",
+      "ES2022"
+    ],
+    "rootDir": "src",
+    "module": "nodenext",
+    "moduleResolution": "nodenext",
+    "strict": true,
+    "declaration": true,
+    "outDir": "dist",
+    "sourceMap": true,
+    "allowSyntheticDefaultImports": true,
+    "esModuleInterop": true,
+    "forceConsistentCasingInFileNames": true
+  },
+  "include": [
+    "eslint.config.js",
+    "homebridge-ui",
+    "src"
+  ]
+}