Skip to content

Latest commit

 

History

History
126 lines (99 loc) · 6.17 KB

README.md

File metadata and controls

126 lines (99 loc) · 6.17 KB
Raw

Govee LAN Control for Home Assistant

hacs_badge

Open your Home Assistant instance and open a repository inside the Home Assistant Community Store.

⚠️ Consider using the Govee2MQTT AddOn Instead ⚠️

Before you get too invested in setting up govee-lan-hass, I wanted to note that I've shifted my development focus to my Govee2MQTT AddOn. That has support for new APIs and devices, and is more flexible than the govee-lan-hass integration.

Note that due to how Govee's LAN API works, you cannot run both the addon and the integration at the same time.

Govee LAN Control for Home Assistant

This works in conjunction with my govee-led-wez python library to provide control over Govee-manufactured lights, preferentially using the LAN protocol for local control.

Installation

Note: you need to enable the LAN API for each individual device!

Recommended first step: Obtain an HTTP API key from the Govee API:

  • Open the Account Page of the Govee mobile app (the person icon in the bottom right)
  • Click the settings "cog" icon in the top right
  • Click Apply for API Key and fill out the form
  • Your key will be emailed to you.

It is recommended to wait until you have the key before configuring the integration, as the HTTP API is used to retrieve the names of the devices from your account, and those names influence the entity ids that are set up for the devices.

You don't require an HTTP API key to use this integration if all of the devices that you want to control are supported by the LAN API, but having your names set up from the app is nice, so I recommend getting that set up anyway.

  • Install HACS - the Home Assistant Community Store

  • Add this repo to HACS by:

    1. Open the HACS integrations page
    2. In the bottom right corner click the "Explore & Download Repositories" button
    3. Type in "Govee LAN Control" and select it and add it

  • Once added, restart Home Assistant

  • Then go to Settings -> Devices & Services and click "Add Integration"

  • Type "Govee LAN Control" and add the integration

  • Enter your HTTP API key where prompted

Notes

  • The govee-led-wez library doesn't perform immediate read-after-write of the device state after controlling a device. When using the HTTP API, doing so would double the number of calls made to the web service and increase the chances of hitting a rate limit. For the LAN API, while the devices generally respond immediate to a control request, they don't reliably return the updated device state for several seconds. As such, this integration assumes that successful control requests result in the state reflecting the request. If you are using other software to also control the lights, then you may experience incorrect information being reported in Home Assistant until the devices are polled.
  • LAN devices have their individual state polled once per minute
  • HTTP devices have their individual state polled once every 10 minutes
  • New LAN devices are discovered every 10 seconds
  • New HTTP devices are discovered every 10 minutes
  • You can force re-discovery/updating of HTTP device and their names by reloading the integration

Tips on Enabling the LAN API

Note: you need to enable the LAN API for each individual device! Repeat these steps for each of your devices!

The LAN API docs have a list of supported models. The Govee app sometimes needs coaxing to show the LAN Control option for supported devices. Here's what works for me:

  • Open the app and ensure that the device(s) are fully up to date and have WiFi configured
  • Close/kill the Govee app
  • Turn off wifi on your mobile device; this seems to help encourage the app to show the LAN Control option.
  • Open the app and go to the settings for the device
  • The LAN Control option should appear for supported devices
  • Turn it on
  • Once done enabling LAN Control for your Govee devices, re-enable wifi on your mobile device

Requirements of the LAN API

  • Home Assistant must be running on the same network as your Govee devices. If you are running it in docker, you will need to use network_mode: host or use a macvlan network.
  • UDP port 4001 much be reachable from the integration. The LAN discovery protocol sends a multicast packet to 239.255.255.250 port 4001.
  • UDP port 4002 must be available for the integration to receive UDP packets from the discovery protocol ping.
  • UDP port 4003 must be reachable from the integration. Govee devices will listen for commands on this port.
  • These fix port requirements are unfortunately part of the LAN API protocol. That means that you cannot run two different implementations of the Govee LAN API from the same IP address (eg: homebridge's govee plugin cannot run on the same IP as this HASS integration). If you need to do that for some reason, you will need to configure each of them to run on separate IP addresses.
  • Your network needs to support multicast UDP over wifi. Your wifi router may require some specific configuration to allow this to work reliably. Note that this is NOT the same thing as multicast DNS, although there is some relation between them.

Troubleshooting

If you add this to your configuration.yaml and restart home assistant, you'll get verbose logging that might reveal more about what's happening:

logger:
  logs:
    custom_components.govee_lan: debug
    govee_led_wez: debug

In addition, some diagnostics are recorded as extended attribute data associated with each entity. In HASS, go to "Developer Tools" -> "State", then type in the name of the light you were trying to control; it should show something like this screenshot:

image