@homebridge-plugins/homebridge-govee 11.31.0 → 11.32.0-beta.1

package/CHANGELOG.md

@@ -2,6 +2,14 @@
 
 All notable changes to `@homebridge-plugins/homebridge-govee` will be documented in this file.
 
+## v11.32.0 (Pending Release)
+
+### Changed
+
+- chore(github): use the shared homebridge action to deprecate past pre-releases
+- feat(ui): add and remove devices from the config via the my devices tab (#1323)
+- feat(ui): hide or show a device in homekit from the my devices tab
+
 ## v11.31.0 (2026-07-24)
 
 ### Added

package/lib/homebridge-ui/public/index.html

@@ -161,11 +161,24 @@
           <th scope="row">Humidity Range</th>
           <td id="humi_range"></td>
         </tr>
+        <tr>
+          <th scope="row">Hide From HomeKit</th>
+          <td>
+            <div class="custom-control custom-checkbox">
+              <input type="checkbox" class="custom-control-input" id="hideDeviceCheck">
+              <label class="custom-control-label" for="hideDeviceCheck">Hide this device from HomeKit</label>
+            </div>
+          </td>
+        </tr>
         <tr>
           <td colspan="2" style="text-align: center" id="image"></td>
         </tr>
       </tbody>
     </table>
+    <div id="configBtnRow" class="text-center mt-2 mb-3" style="display: none;">
+      <button type="button" class="btn btn-primary" id="deviceConfigBtn">Add To Config</button>
+      <button type="button" class="btn btn-secondary" id="addAllBtn">Add All To Config</button>
+    </div>
   </div>
 </div>
 <div id="pageSupport" class="mt-4" style="display: none;">
@@ -305,6 +318,208 @@
   ;(async () => {
     try {
       const currentConfig = await homebridge.getPluginConfig()
+
+      // ===== Device picker (add/remove config entries from the My Devices tab) =====
+      // The button state is always computed from a fresh getPluginConfig() call,
+      // so staged-but-unsaved edits made in the Settings tab are respected
+      const deviceArrayKeys = [
+        'lightDevices',
+        'switchDevices',
+        'leakDevices',
+        'thermoDevices',
+        'fanDevices',
+        'heaterDevices',
+        'dehumidifierDevices',
+        'humidifierDevices',
+        'purifierDevices',
+        'diffuserDevices',
+        'kettleDevices',
+        'iceMakerDevices',
+      ]
+      let pickerAccessories = []
+      let pickerModelMap = {}
+      let removeConfirmTimer
+
+      // Compare device ids ignoring case, colons and underscores, so an entry
+      // typed by hand in a different format still counts as the same device
+      const looseId = id => (id || '').toString().toUpperCase().replace(/[^A-F0-9]+/g, '')
+
+      const getConfigBlocks = async () => {
+        const blocks = await homebridge.getPluginConfig()
+        if (!blocks.length) {
+          blocks.push({ name: 'Govee' })
+        }
+        return blocks
+      }
+
+      const findInConfig = (config, deviceId) => {
+        const target = looseId(deviceId)
+        for (const key of deviceArrayKeys) {
+          if (Array.isArray(config[key])) {
+            const index = config[key].findIndex(entry => entry && looseId(entry.deviceId) === target)
+            if (index !== -1) {
+              return { key, index }
+            }
+          }
+        }
+        return null
+      }
+
+      const setHideCheckbox = hidden => {
+        document.getElementById('hideDeviceCheck').checked = !!hidden
+      }
+
+      const setConfigButton = inConfig => {
+        const btn = document.getElementById('deviceConfigBtn')
+        clearTimeout(removeConfirmTimer)
+        delete btn.dataset.confirm
+        btn.dataset.state = inConfig ? 'remove' : 'add'
+        btn.classList.remove('btn-danger')
+        btn.classList.add('btn-primary')
+        btn.innerHTML = inConfig ? 'Remove From Config' : 'Add To Config'
+      }
+
+      const addDeviceToConfig = (config, acc) => {
+        const arrayKey = pickerModelMap[acc.context.gvModel] || 'lightDevices'
+        if (!Array.isArray(config[arrayKey])) {
+          config[arrayKey] = []
+        }
+        // label is included so the entry survives the platform's clean-up of
+        // entries that contain nothing but a device id
+        config[arrayKey].push({ deviceId: acc.context.gvDeviceId, label: acc.displayName })
+      }
+
+      document.getElementById('deviceConfigBtn').addEventListener('click', async () => {
+        try {
+          const btn = document.getElementById('deviceConfigBtn')
+          const selectedId = document.getElementById('deviceSelect').value
+          const acc = pickerAccessories.find(x => x.context.gvDeviceId === selectedId)
+          if (!acc) {
+            return
+          }
+          const blocks = await getConfigBlocks()
+          const config = blocks[0]
+          const found = findInConfig(config, selectedId)
+          if (btn.dataset.state === 'add') {
+            // The config may have changed since the button was drawn, so
+            // re-check and never add a duplicate - just correct the button
+            if (found) {
+              setConfigButton(true)
+              setHideCheckbox(!!config[found.key][found.index].ignoreDevice)
+              homebridge.toast.info(acc.displayName + ' is already in the config.', 'Not Added')
+              return
+            }
+            addDeviceToConfig(config, acc)
+            await homebridge.updatePluginConfig(blocks)
+            setConfigButton(true)
+            setHideCheckbox(false)
+            homebridge.toast.success(acc.displayName + ' added - press Save to apply.', 'Added To Config')
+          } else {
+            if (!found) {
+              setConfigButton(false)
+              setHideCheckbox(false)
+              homebridge.toast.info(acc.displayName + ' is not in the config.', 'Not Removed')
+              return
+            }
+            const entry = config[found.key][found.index]
+            const extraKeys = Object.keys(entry).filter(k => !['deviceId', 'label'].includes(k))
+            if (extraKeys.length > 0 && btn.dataset.confirm !== 'yes') {
+              // The entry has settings beyond id and label which would be
+              // lost, so ask for a second click within five seconds
+              btn.dataset.confirm = 'yes'
+              btn.classList.remove('btn-primary')
+              btn.classList.add('btn-danger')
+              btn.innerHTML = 'Click Again To Remove (entry has settings)'
+              removeConfirmTimer = setTimeout(() => setConfigButton(true), 5000)
+              return
+            }
+            config[found.key].splice(found.index, 1)
+            if (config[found.key].length === 0) {
+              delete config[found.key]
+            }
+            await homebridge.updatePluginConfig(blocks)
+            setConfigButton(false)
+            setHideCheckbox(false)
+            homebridge.toast.success(acc.displayName + ' removed - press Save to apply.', 'Removed From Config')
+          }
+        } catch (err) {
+          homebridge.toast.error(err.message, 'Error')
+        }
+      })
+
+      document.getElementById('hideDeviceCheck').addEventListener('change', async (e) => {
+        try {
+          const selectedId = document.getElementById('deviceSelect').value
+          const acc = pickerAccessories.find(x => x.context.gvDeviceId === selectedId)
+          if (!acc) {
+            return
+          }
+          const blocks = await getConfigBlocks()
+          const config = blocks[0]
+          let found = findInConfig(config, selectedId)
+          if (e.target.checked) {
+            // Hiding needs a config entry to carry the flag, so create one if
+            // the device is not in the config yet
+            if (!found) {
+              addDeviceToConfig(config, acc)
+              found = findInConfig(config, selectedId)
+            }
+            config[found.key][found.index].ignoreDevice = true
+            await homebridge.updatePluginConfig(blocks)
+            setConfigButton(true)
+            homebridge.toast.success(acc.displayName + ' will be hidden from HomeKit - press Save to apply.', 'Device Hidden')
+          } else {
+            if (found) {
+              // Drop the flag rather than storing ignoreDevice false, to keep
+              // the entry clean
+              delete config[found.key][found.index].ignoreDevice
+              await homebridge.updatePluginConfig(blocks)
+            }
+            setConfigButton(!!found)
+            homebridge.toast.success(acc.displayName + ' will be shown in HomeKit - press Save to apply.', 'Device Unhidden')
+          }
+        } catch (err) {
+          homebridge.toast.error(err.message, 'Error')
+        }
+      })
+
+      document.getElementById('addAllBtn').addEventListener('click', async () => {
+        try {
+          const blocks = await getConfigBlocks()
+          const config = blocks[0]
+          let added = 0
+          let skipped = 0
+          pickerAccessories.forEach(acc => {
+            if (findInConfig(config, acc.context.gvDeviceId)) {
+              skipped += 1
+              return
+            }
+            addDeviceToConfig(config, acc)
+            added += 1
+          })
+          if (added > 0) {
+            await homebridge.updatePluginConfig(blocks)
+            homebridge.toast.success(
+              added + ' device(s) added, ' + skipped + ' already in the config - press Save to apply.',
+              'Added To Config',
+            )
+          } else {
+            homebridge.toast.info('All devices are already in the config.', 'Nothing To Add')
+          }
+          const selectedId = document.getElementById('deviceSelect').value
+          if (selectedId) {
+            const nowFound = findInConfig(config, selectedId)
+            setConfigButton(!!nowFound)
+            if (nowFound) {
+              setHideCheckbox(!!config[nowFound.key][nowFound.index].ignoreDevice)
+            }
+          }
+        } catch (err) {
+          homebridge.toast.error(err.message, 'Error')
+        }
+      })
+      // ===== End device picker =====
+
       showIntro = () => {
         homebridge.disableSaveButton?.()
         const introContinue = document.getElementById('introContinue')
@@ -319,7 +534,9 @@
       }
       showDevices = async () => {
         homebridge.showSpinner()
-        homebridge.disableSaveButton?.()
+        // The save button stays enabled here so entries staged by the picker
+        // buttons can be saved without switching back to the Settings tab
+        homebridge.enableSaveButton?.()
         homebridge.hideSchemaForm()
         document.getElementById('menuHome').classList.remove('btn-elegant')
         document.getElementById('menuHome').classList.add('btn-primary')
@@ -342,6 +559,16 @@
               : 0
           })
         }
+        pickerAccessories = cachedAccessories
+        if (Object.keys(pickerModelMap).length === 0) {
+          try {
+            pickerModelMap = await homebridge.request('/getModelMap')
+          } catch (err) {
+            // Without the map every added device falls back to lightDevices,
+            // which still works because the platform merges all the arrays
+            pickerModelMap = {}
+          }
+        }
         // Build connection overview
         if (cachedAccessories.length > 0) {
           const counts = { lan: 0, aws: 0, openapi: 0, ble: 0 }
@@ -461,6 +688,11 @@
             ? '<img src="' + context.image + '" style="width: 150px;">'
             : ''
           document.getElementById('deviceTable').style.display = 'inline-table'
+          const configBlocks = await getConfigBlocks()
+          const configEntry = findInConfig(configBlocks[0], context.gvDeviceId)
+          setConfigButton(!!configEntry)
+          setHideCheckbox(!!(configEntry && configBlocks[0][configEntry.key][configEntry.index].ignoreDevice))
+          document.getElementById('configBtnRow').style.display = 'block'
           homebridge.hideSpinner()
         }
         deviceSelect.addEventListener('change', event => showDeviceInfo(event.target.value))
@@ -471,6 +703,7 @@
           option.text = 'No Devices'
           deviceSelect.add(option)
           deviceSelect.disabled = true
+          document.getElementById('configBtnRow').style.display = 'none'
         }
         homebridge.hideSpinner()
       }

package/lib/homebridge-ui/server.js

@@ -1,8 +1,52 @@
 import { HomebridgePluginUiServer } from '@homebridge/plugin-ui-utils'
 
+import platformConsts from '../utils/constants.js'
+
+// Which config array each model category belongs in. The platform flattens
+// every array into one lookup by device id, so this only decides which set of
+// options the schema editor shows next to the entry. Sensor categories without
+// an array of their own sit best in thermoDevices (the general sensor bucket).
+const categoryToArray = {
+  rgb: 'lightDevices',
+  switchSingle: 'switchDevices',
+  switchDouble: 'switchDevices',
+  switchTriple: 'switchDevices',
+  sensorLeak: 'leakDevices',
+  sensorThermo: 'thermoDevices',
+  sensorThermo4: 'thermoDevices',
+  sensorMonitor: 'thermoDevices',
+  sensorCO2: 'thermoDevices',
+  sensorPresence: 'thermoDevices',
+  sensorButton: 'thermoDevices',
+  sensorContact: 'thermoDevices',
+  fan: 'fanDevices',
+  heater1: 'heaterDevices',
+  heater2: 'heaterDevices',
+  humidifier: 'humidifierDevices',
+  dehumidifier: 'dehumidifierDevices',
+  purifier: 'purifierDevices',
+  diffuser: 'diffuserDevices',
+  kettle: 'kettleDevices',
+  iceMaker: 'iceMakerDevices',
+  template: 'lightDevices',
+}
+
 class PluginUiServer extends HomebridgePluginUiServer {
   constructor() {
     super()
+
+    // Used by the My Devices tab to know which config array a model belongs
+    // in, built from the same model lists the plugin itself uses
+    this.onRequest('/getModelMap', () => {
+      const modelToArray = {}
+      Object.entries(categoryToArray).forEach(([category, arrayKey]) => {
+        (platformConsts.models[category] || []).forEach((model) => {
+          modelToArray[model] = arrayKey
+        })
+      })
+      return modelToArray
+    })
+
     this.ready()
   }
 }

package/package.json

@@ -2,7 +2,7 @@
   "name": "@homebridge-plugins/homebridge-govee",
   "alias": "Govee",
   "type": "module",
-  "version": "11.31.0",
+  "version": "11.32.0-beta.1",
   "description": "Homebridge plugin to integrate Govee devices into HomeKit.",
   "author": {
     "name": "bwp91",