Get you devices and capabilities
Device Types
- devices.types.light
- devices.types.air_purifier
- devices.types.thermometer
- devices.types.socket
- devices.types.sensor
- devices.types.heater
- devices.types.humidifier
- devices.types.dehumidifier
- devices.types.ice_maker
- devices.types.aroma_diffuser
- devices.types.box
Capability Types
| capabilities | instance | overview |
|---|---|---|
| devices.capabilities.on_off | powerSwitch | on/off enum options |
| devices.capabilities.toggle | oscillationToggle,nightlightToggle,gradientToggle,ect | on/off Enum options |
| devices.capabilities.range | brightness,humidity,volume,temperature,ect | set a range number |
| devices.capabilities.mode | ngihtlightScene,presetScene,gearMode,fanSpeed,ect | enum options |
| devices.capabilities.color_setting | colorRgb,colorTemperatureK | rgb or Kelvin color temperature |
| devices.capabilities.segment_color_setting | segmentedBrightness,segmentedColorRgb | set color or brightness on segment |
| devices.capabilities.music_setting | musicMode | set music mode |
| devices.capabilities.dynamic_scene | lightScene,diyScene,snapshot | set scene,but the options are not static |
| device.capabilities.work_mode | workMode | Set the working mode and give it a working value |
| device.capabilities.temperature_setting | targetTemperature,sliderTemperature | set temperature |
Discover Devices
Get your devices from Govee ，it will return the capabilities，
- request example
GET /router/api/v1/user/devices HTTP/1.1
Host: https://openapi.api.govee.com
Content-Type: application/json
Govee-API-Key: xxxx
- response success example
{
"code": 200,
"message": "success",
"data": [
{
"sku": "H6601",
"device": "9D:FA:85:EB:D3:00:8B:FF",
"capabilities": [
{
"type": "devices.capabilities.on_off",
"instance": "powerSwitch",
"parameters": {
"dataType": "ENUM",
"options": [
{
"name": "on",
"value": 1
},
{
"name": "off",
"value": 0
}
]
}
},
{
"type": "devices.capabilities.toggle",
"instance": "gradientToggle",
"parameters": {
"dataType": "ENUM",
"options": [
{
"name": "on",
"value": 1
},
{
"name": "off",
"value": 0
}
]
}
},
{
"type": "devices.capabilities.range",
"instance": "brightness",
"parameters": {
"unit": "unit.percent",
"dataType": "INTEGER",
"range": {
"min": 1,
"max": 100,
"precision": 1
}
}
},
{
"type": "devices.capabilities.segment_color_setting",
"instance": "segmentedColorRgb",
"parameters": {
"dataType": "STRUCT",
"fields": [
{
"fieldName": "segment",
"dataType": "Array",
"options": [
{
"value": 0
},
{
"value": 1
},
{
"value": 2
},
{
"value": 3
},
{
"value": 4
},
{
"value": 5
},
{
"value": 6
},
{
"value": 7
},
{
"value": 8
},
{
"value": 9
},
{
"value": 10
},
{
"value": 11
},
{
"value": 12
},
{
"value": 13
},
{
"value": 14
}
],
"required": true
},
{
"fieldName": "rgb",
"dataType": "INTEGER",
"range": {
"min": 0,
"max": 16777215,
"precision": 1
},
"required": true
}
]
}
},
{
"type": "devices.capabilities.color_setting",
"instance": "colorRgb",
"parameters": {
"dataType": "INTEGER",
"range": {
"min": 0,
"max": 16777215,
"precision": 1
}
}
},
{
"type": "devices.capabilities.color_setting",
"instance": "colorTemperatureK",
"parameters": {
"dataType": "INTEGER",
"range": {
"min": 2000,
"max": 9000,
"precision": 1
}
}
},
{
"type": "devices.capabilities.dynamic_scene",
"instance": "lightScene",
"parameters": {
"dataType": "ENUM",
"options": [
{
"name": "Tudum",
"value": 3054
},
{
"name": "Party",
"value": 3055
},
{
"name": "Dance Party",
"value": 3056
},
{
"name": "Dine Together",
"value": 3057
},
{
"name": "Dating",
"value": 3058
},
{
"name": "Adventure",
"value": 3059
},
{
"name": "Technology",
"value": 3060
},
{
"name": "Sports",
"value": 3061
},
{
"name": "Dreamlike",
"value": 3062
},
{
"name": "Dynamic",
"value": 3063
},
{
"name": "Blossom",
"value": 3064
},
{
"name": "Christmas",
"value": 3065
},
{
"name": "Halloween",
"value": 3066
},
{
"name": "Fireworks",
"value": 3067
},
{
"name": "Ghost",
"value": 3068
},
{
"name": "Easter",
"value": 3069
},
{
"name": "Valentine's Day",
"value": 3070
},
{
"name": "Spin",
"value": 3071
},
{
"name": "Stacking",
"value": 3072
},
{
"name": "Shoot",
"value": 3073
},
{
"name": "Racing",
"value": 3074
},
{
"name": "Poker",
"value": 3075
},
{
"name": "Crossing",
"value": 3076
},
{
"name": "Fight",
"value": 3077
},
{
"name": "Electro Dance",
"value": 3078
},
{
"name": "Swing",
"value": 3079
},
{
"name": "Candy Crush",
"value": 3080
},
{
"name": "Portal",
"value": 3081
},
{
"name": "Freeze",
"value": 3082
},
{
"name": "Excited",
"value": 3083
},
{
"name": "Tension",
"value": 3084
},
{
"name": "Fright",
"value": 3085
},
{
"name": "Energetic",
"value": 3086
},
{
"name": "Doubt",
"value": 3087
},
{
"name": "Meditation",
"value": 3088
},
{
"name": "Daze",
"value": 3089
},
{
"name": "Action",
"value": 3090
},
{
"name": "Rivalry",
"value": 3091
},
{
"name": "Puzzle Game",
"value": 3092
},
{
"name": "Shooting Game",
"value": 3093
},
{
"name": "Racing Game",
"value": 3094
},
{
"name": "Card Playing",
"value": 3095
}
]
}
},
{
"type": "devices.capabilities.music_setting",
"instance": "musicMode",
"parameters": {
"dataType": "STRUCT",
"fields": [
{
"fieldName": "musicMode",
"dataType": "ENUM",
"options": [
{
"name": "Energic",
"value": 5
},
{
"name": "Rhythm",
"value": 3
},
{
"name": "Spectrum",
"value": 6
},
{
"name": "Rolling",
"value": 4
}
],
"required": true
},
{
"unit": "unit.percent",
"fieldName": "sensitivity",
"dataType": "INTEGER",
"range": {
"min": 0,
"max": 100,
"precision": 1
},
"required": true
},
{
"fieldName": "autoColor",
"dataType": "ENUM",
"options": [
{
"name": "on",
"value": 1
},
{
"name": "off",
"value": 0
}
],
"required": false
},
{
"unit": "unit.percent",
"fieldName": "rgb",
"dataType": "INTEGER",
"range": {
"min": 0,
"max": 16777215,
"precision": 1
},
"required": true
}
]
}
},
{
"type": "devices.capabilities.dynamic_scene",
"instance": "diyScene",
"parameters": {
"dataType": "ENUM",
"options": [
{
"name": "Fade",
"value": 8216567
}
]
}
},
{
"type": "devices.capabilities.dynamic_scene",
"instance": "snapshot",
"parameters": {
"dataType": "ENUM",
"options": [
{
"name": "Sunrise",
"value": 0
},
{
"name": "Sunset",
"value": 1
}
]
}
}
]
},
{
"sku": "H605C",
"device": "69:EC:D1:37:36:39:24:4B",
"capabilities": [
{
"type": "devices.capabilities.on_off",
"instance": "powerSwitch",
"parameters": {
"dataType": "ENUM",
"options": [
{
"name": "on",
"value": 1
},
{
"name": "off",
"value": 0
}
]
}
},
{
"type": "devices.capabilities.toggle",
"instance": "gradientToggle",
"parameters": {
"dataType": "ENUM",
"options": [
{
"name": "on",
"value": 1
},
{
"name": "off",
"value": 0
}
]
}
},
{
"type": "devices.capabilities.range",
"instance": "brightness",
"parameters": {
"unit": "unit.percent",
"dataType": "INTEGER",
"range": {
"min": 1,
"max": 100,
"precision": 1
}
}
},
{
"type": "devices.capabilities.segment_color_setting",
"instance": "segmentedColorRgb",
"parameters": {
"dataType": "STRUCT",
"fields": [
{
"fieldName": "segment",
"dataType": "Array",
"options": [
{
"value": 0
},
{
"value": 1
},
{
"value": 2
},
{
"value": 3
},
{
"value": 4
},
{
"value": 5
},
{
"value": 6
},
{
"value": 7
},
{
"value": 8
},
{
"value": 9
},
{
"value": 10
},
{
"value": 11
},
{
"value": 12
},
{
"value": 13
},
{
"value": 14
}
],
"required": true
},
{
"fieldName": "rgb",
"dataType": "INTEGER",
"range": {
"min": 0,
"max": 16777215,
"precision": 1
},
"reauired": true
}
]
}
},
{
"type": "devices.capabilities.color_setting",
"instance": "colorRgb",
"parameters": {
"dataType": "INTEGER",
"range": {
"min": 0,
"max": 16777215,
"precision": 1
}
}
},
{
"type": "devices.capabilities.color_setting",
"instance": "colorTemperatureK",
"parameters": {
"dataType": "INTEGER",
"range": {
"min": 2000,
"max": 9000,
"precision": 1
}
}
},
{
"type": "devices.capabilities.dynamic_scene",
"instance": "lightScene",
"parameters": {
"dataType": "ENUM",
"options": [
{
"name": "Tudum",
"value": 3054
},
{
"name": "Party",
"value": 3055
},
{
"name": "Dance Party",
"value": 3056
},
{
"name": "Dine Together",
"value": 3057
},
{
"name": "Dating",
"value": 3058
},
{
"name": "Adventure",
"value": 3059
},
{
"name": "Technology",
"value": 3060
},
{
"name": "Sports",
"value": 3061
},
{
"name": "Dreamlike",
"value": 3062
},
{
"name": "Dynamic",
"value": 3063
},
{
"name": "Blossom",
"value": 3064
},
{
"name": "Christmas",
"value": 3065
},
{
"name": "Halloween",
"value": 3066
},
{
"name": "Fireworks",
"value": 3067
},
{
"name": "Ghost",
"value": 3068
},
{
"name": "Easter",
"value": 3069
},
{
"name": "Valentine's Day",
"value": 3070
},
{
"name": "Spin",
"value": 3071
},
{
"name": "Stacking",
"value": 3072
},
{
"name": "Shoot",
"value": 3073
},
{
"name": "Racing",
"value": 3074
},
{
"name": "Poker",
"value": 3075
},
{
"name": "Crossing",
"value": 3076
},
{
"name": "Fight",
"value": 3077
},
{
"name": "Electro Dance",
"value": 3078
},
{
"name": "Swing",
"value": 3079
},
{
"name": "Candy Crush",
"value": 3080
},
{
"name": "Portal",
"value": 3081
},
{
"name": "Freeze",
"value": 3082
},
{
"name": "Excited",
"value": 3083
},
{
"name": "Tension",
"value": 3084
},
{
"name": "Fright",
"value": 3085
},
{
"name": "Energetic",
"value": 3086
},
{
"name": "Doubt",
"value": 3087
},
{
"name": "Meditation",
"value": 3088
},
{
"name": "Daze",
"value": 3089
},
{
"name": "Action",
"value": 3090
},
{
"name": "Rivalry",
"value": 3091
},
{
"name": "Puzzle Game",
"value": 3092
},
{
"name": "Shooting Game",
"value": 3093
},
{
"name": "Racing Game",
"value": 3094
},
{
"name": "Card Playing",
"value": 3095
}
]
}
},
{
"type": "devices.capabilities.music_setting",
"instance": "musicMode",
"parameters": {
"dataType": "STRUCT",
"fields": [
{
"fieldName": "musicMode",
"dataType": "ENUM",
"options": [
{
"name": "Energic",
"value": 5
},
{
"name": "Rhythm",
"value": 3
},
{
"name": "Spectrum",
"value": 4
},
{
"name": "Rolling",
"value": 6
}
],
"required": true
},
{
"unit": "unit.percent",
"fieldName": "sensitivity",
"dataType": "INTEGER",
"range": {
"min": 0,
"max": 100,
"precision": 1
},
"required": true
},
{
"fieldName": "autoColor",
"dataType": "ENUM",
"options": [
{
"name": "on",
"value": 1
},
{
"name": "off",
"value": 0
}
],
"required": false
},
{
"fieldName": "rgb",
"dataType": "INTEGER",
"range": {
"min": 0,
"max": 16777215,
"precision": 1
},
"required": true
}
]
}
},
{
"type": "devices.capabilities.dynamic_setting",
"instance": "diyScene",
"parameters": {
"dataType": "ENUM",
"options": [
{
"name": "fade",
"value": 8216567
}
]
}
},
{
"type": "devices.capabilities.dynamic_scene",
"instance": "snapshot",
"parameters": {
"dataType": "ENUM",
"options": [
{
"name": "color scene",
"value": 465503
}
]
}
}
]
},
{
"sku": "H7055",
"device": "B6:21:C3:37:34:32:33:86",
"capabilities": [
{
"type": "devices.capabilities.on_off",
"instance": "powerSwitch",
"parameters": {
"dataType": "ENUM",
"options": [
{
"name": "on",
"value": 1
},
{
"name": "off",
"value": 0
}
]
}
},
{
"type": "devices.capabilities.toggle",
"instance": "gradientToggle",
"parameters": {
"dataType": "ENUM",
"options": [
{
"name": "on",
"value": 1
},
{
"name": "off",
"value": 0
}
]
}
},
{
"type": "devices.capabilities.range",
"instance": "brightness",
"parameters": {
"unit": "unit.percent",
"dataType": "INTEGER",
"range": {
"min": 1,
"max": 100,
"precision": 1
}
}
},
{
"type": "devices.capabilities.segment_color_setting",
"instance": "segmentedColorRgb",
"parameters": {
"dataType": "STRUCT",
"fields": [
{
"fieldName": "segment",
"dataType": "Array",
"options": [
{
"value": 0
},
{
"value": 1
},
{
"value": 2
},
{
"value": 3
},
{
"value": 4
},
{
"value": 5
},
{
"value": 6
},
{
"value": 7
},
{
"value": 8
},
{
"value": 9
},
{
"value": 10
},
{
"value": 11
},
{
"value": 12
},
{
"value": 13
},
{
"value": 14
}
],
"required": true
},
{
"fieldName": "rgb",
"dataType": "INTEGER",
"range": {
"min": 0,
"max": 16777215,
"precision": 1
},
"required": true
}
]
}
},
{
"type": "devices.capabilities.color_setting",
"instance": "colorRgb",
"parameters": {
"dataType": "INTEGER",
"range": {
"min": 0,
"max": 16777215,
"precision": 1
}
}
},
{
"type": "devices.capabilities.color_setting",
"instance": "colorTemperatureK",
"parameters": {
"dataType": "INTEGER",
"range": {
"min": 2000,
"max": 9000,
"precision": 1
}
}
},
{
"type": "devices.capabilities.dynamic_scene",
"instance": "lightScene",
"parameters": {
"dataType": "ENUM",
"options": [
{
"name": "Tudum",
"value": 3054
},
{
"name": "Party",
"value": 3055
},
{
"name": "Dance Party",
"value": 3056
},
{
"name": "Dine Together",
"value": 3057
},
{
"name": "Dating",
"value": 3058
},
{
"name": "Adventure",
"value": 3059
},
{
"name": "Technology",
"value": 3060
},
{
"name": "Sports",
"value": 3061
},
{
"name": "Dreamlike",
"value": 3062
},
{
"name": "Dynamic",
"value": 3063
},
{
"name": "Blossom",
"value": 3064
},
{
"name": "Christmas",
"value": 3065
},
{
"name": "Halloween",
"value": 3066
},
{
"name": "Fireworks",
"value": 3067
},
{
"name": "Ghost",
"value": 3068
},
{
"name": "Easter",
"value": 3069
},
{
"name": "Valentine's Day",
"value": 3070
},
{
"name": "Spin",
"value": 3071
},
{
"name": "Stacking",
"value": 3072
},
{
"name": "Shoot",
"value": 3073
},
{
"name": "Racing",
"value": 3074
},
{
"name": "Poker",
"value": 3075
},
{
"name": "Crossing",
"value": 3076
},
{
"name": "Fight",
"value": 3077
},
{
"name": "Electro Dance",
"value": 3078
},
{
"name": "Swing",
"value": 3079
},
{
"name": "Candy Crush",
"value": 3080
},
{
"name": "Portal",
"value": 3081
},
{
"name": "Freeze",
"value": 3082
},
{
"name": "Excited",
"value": 3083
},
{
"name": "Tension",
"value": 3084
},
{
"name": "Fright",
"value": 3085
},
{
"name": "Energetic",
"value": 3086
},
{
"name": "Doubt",
"value": 3087
},
{
"name": "Meditation",
"value": 3088
},
{
"name": "Daze",
"value": 3089
},
{
"name": "Action",
"value": 3090
},
{
"name": "Rivalry",
"value": 3091
},
{
"name": "Puzzle Game",
"value": 3092
},
{
"name": "Shooting Game",
"value": 3093
},
{
"name": "Racing Game",
"value": 3094
},
{
"name": "Card Playing",
"value": 3095
}
]
}
},
{
"type": "devices.capabilities.music_setting",
"instance": "musicMode",
"parameters": {
"dataType": "STRUCT",
"fields": [
{
"fieldName": "musicMode",
"dataType": "ENUM",
"options": [
{
"name": "Energic",
"value": 5
},
{
"name": "Rhythm",
"value": 3
},
{
"name": "Spectrum",
"value": 6
},
{
"name": "Rolling",
"value": 4
}
],
"required": true
},
{
"unit": "unit.percent",
"fieldName": "sensitivity",
"dataType": "INTEGER",
"range": {
"min": 0,
"max": 100,
"precision": 1
},
"required": true
},
{
"fieldName": "autoColor",
"dataType": "ENUM",
"options": [
{
"name": "on",
"value": 1
},
{
"name": "off",
"value": 0
}
],
"required": false
},
{
"unit": "unit.percent",
"fieldName": "rgb",
"dataType": "INTEGER",
"range": {
"min": 0,
"max": 16777215,
"precision": 1
},
"required": true
}
]
}
},
{
"type": "devices.capabilities.dynamic_scene",
"instance": "diyScene",
"parameters": {
"dataType": "ENUM",
"options": [
{
"name": "Fade",
"value": 8216567
}
]
}
},
{
"type": "devices.capabilities.dynamic_scene",
"instance": "snapshot",
"parameters": {
"dataType": "ENUM",
"options": [
{
"name": "Sunrise",
"value": 0
},
{
"name": "Sunset",
"value": 1
}
]
}
}
]
}
]
}
- response field
| field | data type | |
|---|---|---|
| sku | String | Product model |
| device | String | device id |
| deviceName | String | The device name in Govee Home App. |
| capabilities | Array | device capabilities array |
- capabilities array
| field | data type | |
|---|---|---|
| type | String | capbility type |
| instance | String | capability instance |
| parameters | Object | the struct definition of control command in this instance |
- parameters object
- enum type parameters
| field | data type | desc |
|---|---|---|
| dataType | String | define the data type of control value . e.g. ENUM,INTEGER,STRUCT |
| options | Array | show the options of control value |
| options.name | String | show the name of this option |
| options.value | -- | the control value |
- integer type parameters
| field | data type | desc |
|---|---|---|
| dataType | String | define the data type of control value . e.g. ENUM,INTEGER,STRUCT |
| range | Object | define the range of value |
| range.max | Integer | the max of control value |
| range.min | Integer | the min of control value |
| range.precision | Integer | the precision of control value |
| unit | String | the unit of this control value e.g. temperature Celsius,temperature Fahrenheit |
- struct type parameters
| field | data type | desc |
|---|---|---|
| dataType | String | define the data type of control value . e.g. ENUM,INTEGER,STRUCT |
| fields | Array | when control value is struct, define the struct filed |
| Array.fieldName | String | the struct field name |
| Array.dataType | String | define the field data type e.g. ENUM,INTEGER,STRUCT |
| Array.required | Boolean | required of this field |
- http code
| code | desc |
|---|---|
| 200 | success |
| 429 | too many request, request limits, 10000/Account/Day |
| 401 | Unauthorized. check you apiKey |
- Friendly Reminder
if the request response 429, means request limits happens, 10000/Account/Day