Configuration

⚠️ It is recommended (and easier) to use the Homebridge UI plugin settings screen to configure the plugin. The settings screen is generated from the same source as this page, and always reflects the full, current set of options.

This page is for reference and for users who edit their configuration JSON manually.

Required Settings

Add the following to your configuration file inside the platforms array.

{
   "name": "Resideo",
   "credentials": {
      "consumerKey": "your-consumer-key",
      "consumerSecret": "your-consumer-secret",
      "refreshToken": "your-refresh-token"
   },
   "platform": "Resideo"
}

• ⚠️ The "platform": "Resideo" line must not be changed
• The credentials come from the Resideo developer portal - the plugin settings screen in the Homebridge UI can walk you through linking your account, which is much easier than creating them manually.

Credentials (credentials)

Setting	Type	Default	Explanation
consumerKey	string	-	Consumer Key
consumerSecret	string	-	Consumer Secret
refreshToken	string	-	Refresh Token
notice	string	Keep your tokens a secret!	Notice

Options (options)

Setting	Type	Default	Explanation
preferMatter	boolean	true	When Matter is available in Homebridge v2.0+, prefer registering devices as Matter accessories. Requires enableMatter to also be true.
enableMatter	boolean	true	Allow the plugin to use the Homebridge Matter API (Homebridge v2.0+). Set to false to always use the HAP path.
devices	array	-
refreshRate	number	-	Indicates the number of seconds between polls of the Resideo service.
pushRate	number	-	Indicates the number of seconds between pushes to Honewell Home API.
logging	string	``	Logging Setting
allowInvalidCharacters	boolean	-	If true, invalid characters will be allowed in the device name.
convertUnits	string	``	Override automatic API unit handling when temperatures are reported with the wrong unit.