Homebridge-SmartHQ Client

A homebridge plugin for GE appliances using the SmartHQ API s (Identity and Access Management API, Digital Twin API). Currently only services for a refrigerator are implemented.

The refrigerator services include controls for:

• refrigerator temperature
• freezer temperature
• controls lock
• convertible drawer modes
• dispenser light
• icemaker
• interior light
• sabbath mode
• temperature units
• turbo cool modes refrigerator & freezer
• water filter maintenance (see notes)
• additional switches are used to implement notifications

Installation

Option 1: Homebridge UI

Go to the 'Plugins' page, search for homebridge-smarthq-client, and click 'Install'.

Option 2: Manually

Run the following command to install the plugin globally:

$ sudo npm install homebridge-smarthq-client -g

Requirements

The SmartHQ API uses an OAuth 2.0 authentication process. The steps required to setup an account in order to use the API are

• Follow the steps at Get Started - SmartHQ Docs
  (The Callback URL specified in step 2.4 must match the corresponding field in the plugin config setup (recommended http://localhost:8888/callback)

• When step 2 from Get Started is complete and you have created an app, click on the app to display your apps page. Find the Credentials tab and copy the Client Id, Client Secret and Callback URL to the plugin config.

Configuration

Use the Homebridge UI to configure this plugin. See Requirements for steps to obtain a Client Id and Client Secret.

• Select the services you want to add for the appliance in the plugin config.

• Select Logging options.
  Plugin Debug Logging will log additional messages to the Homebridge log.
  Display Service Details will log sorted information about all services for each discovered device.
  (This info is used to add support for other appliances.)

• Save plugin config and restart child bridge.

Or manually edit the config file with

{
        "name": "SmartHQ Client",
        "clientId": "your client id",
        "clientSecret": "your client secret",
        "redirectUri": "http://localhost:8888/callback",
        "addControlLock": false,
        "addConvertibleDrawer": false,
        "addDispenserLight": false,
        "addIceMaker": false,
        "addInteriorLight": false,
        "addSabbathMode": false,
        "addTemperatureUnits": false,
        "addEnergyMonitor": false,
        "addTurboCool": false,
        "addWaterFilter": false,
        "addAlerts": false,
        "debugLogging": false,
        "debugServices": false,
        "_bridge": {
            "name": "SmartHQ Bridge",
            "username": "0E:23:87:36:1A:C8",
            "port": 34603
        },
        "platform": "SmartHqPlatform"
    }

Initial Authentication

(If access token does not exist). Check the Homebridge log for a highlighted localhost URL.

======================================================================= 
Click to login for SmartHQ Auth setup ===>: http://localhost:8888/login
=======================================================================  

Click on the URL to be redirected to a SmartHQ authorization screen. Login to your SmartHQ account to complete the process. Once an access (and refresh) token have been saved this step will only be needed if the file used to store your tokens is deleted. When an access token expires the plugin will use the refresh token to obtain a new access token.

Notifications

API device alerts are monitored for the following conditions:

• Door left open
• Temperature alert (either fridge or freezer)
• Water pitcher leak
• Filter maintenance
• Firmware

If selected during configuration, switches are added that will be turned on temporarily
when a corresponding alert is triggered. Using these switches in conjunction with a 3rd party service (e.g PushOver, PushCutter etc)
an Apple Home automation can be set up to issue notifications for your iOS devices.

These switches will appear in Accessories as Alert Door, Alert Temp, Alert Leak, Alert Filter, Alert Firm

Documentation

SmartHQ Documentation

Notes

The water filter maintenance option uses the Filter Maintenance Service in the Homebridge API.
The service exists in HomeKit but has not been implemented in the Apple Home app.
If selected in the plugin config you will notice a tile on the Homebridge Accessories page but there
will not be any tile/device shown in the Home app.

Feedback

If you have any feedback, please reach out at: [email protected]

If you have GE smart appliances other than refrigerator you can capture the following information (after adding the appliance to your SmartHQ account)

• Update the plugin config to select Display Service Details
• Restart the child bridge.
• Copy log output including 'SmartHQ Discovered device: newDevice Model: PVD28BYNIFS'
  plus all logged services and forward the file to me. As my time permits I will attempt to add support for new devices.