Control Govee LED lights
This library provides control over Govee-manufactured lights. @wez built this for use with Home Assistant. You can find the corresponding hacs-govee-lan repo here.
It has an emphasis on making use of their LAN API but also makes use of their HTTP API in order to retrieve the user-assigned names of the devices, and to control the devices that don't yet support the LAN API.
from govee_led_wez import GoveeController, GoveeDevice
controller = GoveeController()
def device_changed(device: GoveeDevice):
print(f"{device.device_id} state -> {device.state}")
controller.set_device_change_callback(device_changed)
if YOUR_API_KEY:
controller.set_http_api_key(YOUR_API_KEY)
controller.start_http_poller()
controller.start_lan_poller()
if YOU_WANT_BLE:
# Optional, if you want bluetooth device control.
# This will disconnect from devices after they are idle
# for a while. If you omit this, devices will be disconnected
# in case of error. You probably want this.
controller.start_ble_idler()
# This will look for new devices in the background,
# by default every 10 minutes
controller.start_ble_poller()
# Alternatively: This will look for devices right now,
# but note that it needs # to perform discovery and can
# take several seconds
# await controller.query_ble_devices()
# Devices will now be discovered asynchronously
Devices are discovered asynchronously. While the full set of devices
associated with your account can be returned via the HTTP API, the
initial request for them is made asynchronously by the background
http poller task. If you need the list immediately, you can call
controller.query_http_devices()
to obtain that list.
The HTTP API has some tight rate limits. This library prefers to avoid
read-after-write operations to verify the state in order to reserve the calls
for issuing commands to your devices. This means that, for devices that don't
support the LAN API, the assumed state may be a bit wonky until the device
is controlled. You can call controller.update_device_state()
to
explicitly retrieve the state.
BLE is preferred over HTTP. When we know a device is accessible via BLE, then we will attempt to control it via BLE before trying to use HTTP. LAN is always attempted first, as it has the lowest latency.
BLE is currently only usable in conjunction with HTTP and/or LAN discovery. There isn't a BLE-only usage at the moment.
A Makefile
provides shortcuts for doing stuff:
make setup
- do one-time setup for developingmake check
- performs type checking and lintingmake test
- runs testsmake fmt
- runs code formatting, potentially appeasing make check
make build
- builds distributable bitsGitHub Actions will run the check
, test
and build
actions on PRs.