Skip to content

Latest commit

 

History

History
83 lines (57 loc) · 2.78 KB

ADDON.md

File metadata and controls

83 lines (57 loc) · 2.78 KB
Raw

Installing as a Home Assistant Add-On

If you are running HAOS or Supervised Home Assistant, then your installation is compatible with Home Assistant Add-Ons.

If you installed Home Assistant through a different technique, you cannot install Add-Ons and will need to use a different approach to setting up Govee2MQTT.

Overview

The process is relatively easy, it's just a lot of clicks in different places because of the way the UI is laid out.

The broad steps are:

  • Enable advanced mode to allow installing Govee2MQTT from this repository.
  • Install a MQTT Broker from the Add-On store
  • Enable the MQTT Integration
  • Add this repository to your Add-On store
  • Install Govee2MQTT
  • Configure it
  • Start it

Installation

Enable Advanced Mode

Go to your user profile; click on your profile icon in the bottom left of the screen. Scroll down and turn on "Advanced Mode" so that you will be able to see Govee2MQTT in the list of Add-Ons when we get to that point.

image

Set up MQTT

  1. Go to the Add-Ons section of the settings: https://my.home-assistant.io/redirect/supervisor
  2. Click on the "Adds-On Store" button in the bottom right corner
  3. Look for the "Mosquitto Broker"
    • Click on it
    • Install it
    • Start it
  4. Go to "Settings", then "Devices & Services" and you should see a tile offering to enable the MQTT integration. Click on it and enable it.

Now Install Govee2MQTT

  1. Go to the Add-Ons section of the settings: https://my.home-assistant.io/redirect/supervisor
  2. Click on the "Adds-On Store" button in the bottom right corner
  3. Look for the 3 vertically stacked dots in the top right corner:

image

  1. Click on "Repositories"
  2. Enter https://github.com/wez/govee2mqtt and click "Add"
  3. You should see:

image

  1. Click "close"
  2. You should now see:

image

  1. Click on it
  2. Click "install"
  3. At the top of the screen is a "Configuration" tab, click it

image

  1. Check the "Show unused optional configuration options" option

  2. Fill out at least the first three options; the govee email, password and api key

  3. Click "Save" (bottom right)

  4. Click on the "Info" tab (top of screen)

  5. Now you can click "Start" to launch it

Verify

  1. You can use the "Logs" tab (top right) to see diagnostics
  2. After a couple of seconds, your devices should be discovered and show up under the MQTT integration