Skip to content

Configuration

Ben edited this page Mar 17, 2021 · 65 revisions

⚠️ This configuration assumes the latest version of the plugin.

Required Settings

Add the following to your configuration file in the appropriate place. The following are the basic required fields.

{
   "name": "Govee",
   "apiKey": "your-govee-api-key",
   "platform": "Govee"
}
  • ⚠️ The "platform": "Govee" line must not be changed.

Obtaining Your API Key

You will need to retrieve an API key which you can obtain through the Govee mobile app.

  • Go to your account tab → "About us" → "Apply for API key"
  • Fill out your name and your reason - I'm sure "Control through Homebridge" would be sufficient
  • You'll receive your API key to your Govee registered email address normally within minutes

Optional Settings

Entry Type Default Explanation
refreshTime integer 15 An interval (in seconds) in which your devices will refresh with Govee. Must be 15 or more.
controlInterval integer 500 A minimum delay (in milliseconds) between device updates being sent. Increasing this may help if you find device updates are not working or if you use HomeKit scenes/groupings. Must be 500 or more.
disableDeviceLogging bool false If true, updates for all devices will not be added to the log when they are controlled.
debug bool false If true, more information will be added to the log.
debugFakegato bool false If true, the included Fakegato library will debug to the log.
disablePlugin bool false If true, the plugin will remove all accessories and not load the plugin on restart.
switchDevices array []

An array of objects to define custom options for your Govee switch devices.

  • deviceId - Govee Device ID
  • label - This setting has no effect except to be a helpful label for identifying which device this is when editing the configuration
  • overrideDisabledLogging - If true, updates for this device will be added to the log, even if the general 'Disable Device Logging' setting is true

Example:

[
   {
      "deviceId": "12:AB:A1:C5:A8:99:D2:17",
      "label": "Kitchen Lights",
      "overrideDisabledLogging": true
   }
]
lightDevices array []

An array of objects to define custom options for your Govee light devices.

  • deviceId - Govee Device ID
  • label - This setting has no effect except to be a helpful label for identifying which device this is when editing the configuration
  • brightnessStep - A minimum step for the brightness slider in the Home app. Must be 1 or more
  • adaptiveLightingShift - An adjustment factor for Adaptive Lighting. The mired value for each update will be increased by this setting, making the light appear warmer. A value between 50-200 should be appropriate. Must be 0 or more
  • overrideDisabledLogging - If true, updates for this device will be added to the log, even if the general 'Disable Device Logging' setting is true

Example:

[
   {
      "deviceId": "12:AB:A1:C5:A8:99:D2:17",
      "label": "TV LED Strip",
      "brightnessStep": 10,
      "adaptiveLightingShift": 15,
      "overrideDisabledLogging": true
   }
]
ignoredDevices array []

A list of devices to ignore by Govee Device ID. For example:

[
   "12:AB:A1:C5:A8:99:D2:17"
]