Dela via


Govee (Independent Publisher) (Preview)

Integrate Govee smart light devices into your applications with the Govee Developer API. Control lights, change colors, adjust brightness, and set timers. Access real-time device status for advanced application development.

This connector is available in the following products and regions:

Service Class Regions
Logic Apps Standard All Logic Apps regions except the following:
     -   Azure Government regions
     -   Azure China regions
     -   US Department of Defense (DoD)
Power Automate Premium All Power Automate regions except the following:
     -   US Government (GCC)
     -   US Government (GCC High)
     -   China Cloud operated by 21Vianet
     -   US Department of Defense (DoD)
Power Apps Premium All Power Apps regions except the following:
     -   US Government (GCC)
     -   US Government (GCC High)
     -   China Cloud operated by 21Vianet
     -   US Department of Defense (DoD)
Contact
Name Richard Wilson
URL https://www.richardawilson.com/
Email richard.a.wilson@microsoft.com
Connector Metadata
Publisher Richard Wilson
Website https://us.govee.com/
Privacy policy https://us.govee.com/policies/privacy-policy
Categories Internet of Things

Govee

Offers seamless integration with Govee's smart lighting systems, enabling users to effortlessly control and manage their devices. It allows for a wide range of functionalities including adjusting light settings, changing colors, modifying brightness, and accessing real-time device status.

The ability to automate and customize lighting setups makes this connector particularly useful for enhancing ambiance in smart homes, creating dynamic lighting scenes for various occasions, and integrating smart lighting into broader home automation systems. It offers a convenient and intuitive way for users to personalize their lighting experience and fully leverage the capabilities of Govee's smart lighting technology.

Publisher: Richard Wilson

Prerequisites

Before you can use the Govee connector, you must obtain a Govee Developer API Key. Follow these steps to acquire the key:

Obtaining a Govee Developer API Key

  1. Download the Govee Home App:

  2. Access Your Profile:

    • Open the Govee Home App and navigate to the 'My Profile' page by tapping the profile icon (👤).
  3. Go to Settings:

    • Click on the settings icon (⚙️) located at the top right corner to access the Settings menu.
  4. Apply for API Key:

    • Select 'Apply for API Key' within the Settings menu.
  5. Complete Application Form:

    • Fill in the required fields for 'Name' and 'Reason for application'.
      • Example reasons include home automation, third-party integration, or educational purposes.
  6. Agree to Terms of Service:

    • Carefully read the Govee Developer API Terms of Service. Once you have understood the terms, check the box to indicate your acceptance.
  7. Submit Application:

    • Click 'Submit' to send your application for an API key. Once approved, you will receive your Govee API Key, which is necessary to use this connector.

Please be aware that the API key approval process may take some time, and approval is at the discretion of Govee. Ensure that your application includes a valid and clear reason for requesting the API key to increase the likelihood of approval.

Supported Operations

1. Run Command on Device

This operation allows you to send various commands to control your Govee device.

  • Input Properties:
    • Device MAC Address: The unique MAC address of the Govee device to be controlled.
    • Device Model: The model number of the Govee device.
    • Command Details: An object containing the command to be executed. It includes:
      • Name: The command name (e.g., 'turn', 'brightness', 'color', 'colorTem').
    • Additional Parameters (based on the command):
      • Turn: (Optional) 'on' or 'off' - used when the command is 'turn'.
      • Brightness: (Optional) Numeric value (0-100) - used when the command is 'brightness'.
      • Color: (Optional) Object with 'r', 'g', 'b' values - used when the command is 'color'.
      • Color Temperature: (Optional) Numeric value for color temperature - used when the command is 'colorTem'.

2. Get Device Information

Retrieve information about a specific Govee device or all devices associated with your account.

  • Input Properties:
    • Device MAC Address: (Optional) The MAC address of the specific Govee device for which information is being requested. If omitted, information for all devices is returned.
    • Device Model: (Optional) The model of the Govee device. If specified along with the MAC address, it refines the query to that specific device.

API Documentation

For detailed information about the Govee Lights Developer API, including its capabilities, endpoints, parameters, and responses, refer to the official Govee API Documentation. The documentation provides comprehensive guidance and examples to help you effectively integrate and utilize the API within your applications and workflows.

Known Issues and Limitations

Currently, no known issues or limitations exist. Always refer to this section for updated information.

Creating a connection

The connector supports the following authentication types:

Default Parameters for creating connection. All regions Not shareable

Default

Applicable: All regions

Parameters for creating connection.

This is not shareable connection. If the power app is shared with another user, another user will be prompted to create new connection explicitly.

Name Type Description Required
Govee API Key securestring The Govee API Key which can be requested within the Govee mobile app. True

Throttling Limits

Name Calls Renewal Period
API calls per connection 100 60 seconds

Actions

Get Device Information

Access detailed information about your Govee devices. This endpoint retrieves data for a specific device when provided with its MAC address and model. If no specific device is specified, the endpoint returns information for all devices associated with your account. The response includes device details such as the device name, controllability, retrievability, supported commands, and additional properties. This is useful for understanding the capabilities and current configuration of your Govee devices.

Run Command on Device

Execute a specific command on a Govee device. This endpoint allows you to control various aspects of the device such as power state, brightness, color, and color temperature. Provide the device's MAC address and model along with the command details. Supported commands include 'turn' for power control, 'brightness' for adjusting brightness levels, 'color' for setting RGB color values, and 'colorTem' for adjusting color temperature.

Get Device Information

Access detailed information about your Govee devices. This endpoint retrieves data for a specific device when provided with its MAC address and model. If no specific device is specified, the endpoint returns information for all devices associated with your account. The response includes device details such as the device name, controllability, retrievability, supported commands, and additional properties. This is useful for understanding the capabilities and current configuration of your Govee devices.

Parameters

Name Key Required Type Description
Device MAC Address
device string

An optional parameter representing the MAC address of the Govee device for which information is being requested. If provided, the API will return details specifically for this device. Leave this parameter empty to retrieve information for all devices associated with the account.

Device Model
model string

An optional parameter indicating the model of the Govee device. If specified, the API will return information for devices matching this model. This parameter can be used in conjunction with the Device MAC Address.

Returns

Name Path Type Description
Devices
data.devices array of object

A list of devices associated with the account. If a specific device is requested, the list will only contain one device.

Device MAC Address
data.devices.device string

The unique MAC address of the device

Device Model
data.devices.model string

The model number of the device

Device Name
data.devices.deviceName string

The name of the device

Controllable
data.devices.controllable boolean

Indicates if the device is controllable

Minimum
data.devices.properties.colorTem.range.min integer

Minimum color temperature value

Maximum
data.devices.properties.colorTem.range.max integer

Maximum color temperature value

Retrievable
data.devices.retrievable boolean

Indicates if the device is retrievable

Supported Commands
data.devices.supportCmds array of string

Supported commands for the device

Message
message string

A message describing the result of the operation

Status Code
code integer

The HTTP status code of the response

Run Command on Device

Execute a specific command on a Govee device. This endpoint allows you to control various aspects of the device such as power state, brightness, color, and color temperature. Provide the device's MAC address and model along with the command details. Supported commands include 'turn' for power control, 'brightness' for adjusting brightness levels, 'color' for setting RGB color values, and 'colorTem' for adjusting color temperature.

Parameters

Name Key Required Type Description
Device MAC Address
device True string

The unique MAC address of the Govee device. This identifier is used to specify which device you want to control.

Device Model
model True string

The model number of your Govee device. This information helps in identifying the specific features and capabilities available for the device.

Command Name
name True string

The command to be executed on the device. This object includes the command name (e.g., 'turn', 'brightness', 'color', 'colorTem') and its associated value. The command name dictates the type of action to be performed on the device.

Turn
turn string

This parameter is used to turn the device on or off. Use this only when the 'turn' command is selected. Valid values are 'on' or 'off'.

Brightness
brightness integer

The brightness level to set for the device. Use this parameter only when the 'brightness' command is selected. Enter a value between 0 (minimum brightness) and 100 (maximum brightness).

Color - Red
r integer

This parameter represents the red component of the RGB color value for the device. It is a part of the 'color' command. Specify an integer value ranging from 0 to 255, where 0 means no red and 255 represents the maximum intensity of red.

Color - Green
g integer

This parameter defines the green component of the RGB color value for the device. It is used in conjunction with the 'color' command. Provide an integer value between 0 and 255, with 0 indicating no green and 255 signifying the highest intensity of green.

Color - Blue
b integer

The blue component of the RGB color value to set on the device. This parameter is part of the 'color' command. The value should be an integer ranging from 0 to 255, where 0 is the absence of blue and 255 denotes the brightest blue.

Color Temperature
colorTem integer

The color temperature value to set for the device. Use this parameter only when the 'colorTem' command is selected. Enter the color temperature value as required by your device.

Returns

Name Path Type Description
Status Code
code integer

The HTTP status code of the response

Message
message string

A message describing the result of the operation

data
data object

The data returned with the response.