-
-
Notifications
You must be signed in to change notification settings - Fork 53
Configuration
Ben edited this page Jul 11, 2021
·
65 revisions
Add the following to your configuration file in the appropriate place. The following are the basic required fields.
{
"name": "Govee",
"username": "your-govee-username",
"password": "your-govee-password",
"apiKey": "your-govee-api-key",
"platform": "Govee"
}
⚠️ The"platform": "Govee"
line must not be changed-
username
andpassword
is required if you wish to enable support for bluetooth devices -
apiKey
is required if you wish to enable support for cloud devices
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
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 |
Global logging setting for accessory status changes. If true then accessory status changes will not be logged. This can also be set per accessory later in the config. |
debug |
bool |
false |
Global logging setting for the plugin. If true then debug information will be added to the log. This can also be set per accessory later in the config. |
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. |
lightDevices |
array |
[] |
An array of objects to define custom options for your Govee light devices.
Example: [
{
"deviceId": "12:AB:A1:C5:A8:99:D2:17",
"label": "TV LED Strip",
"enableBT": true,
"brightnessStep": 10,
"adaptiveLightingShift": 15,
"overrideLogging": "default"
}
] |
switchDevices |
array |
[] |
An array of objects to define custom options for your Govee switch devices.
Example: [
{
"deviceId": "12:AB:A1:C5:A8:99:D2:17",
"label": "Kitchen Lights",
"showAsType": "outlet",
"overrideLogging": "debug"
}
] |