@homebridge-plugins/homebridge-resideo 3.1.5 → 3.2.0-beta.1

package/CHANGELOG.md

@@ -1,3 +1,10 @@
+## v3.2.0 (Pending Release)
+
+### Changed
+
+- feat(ui): add, remove and hide devices from the config via the devices tab
+- style(ui): standardise the custom ui layout and sync the support tab with the readme
+
 ## v3.1.5 (2026-07-24)
 
 ### Changed

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

@@ -1,3 +1,19 @@
+<style>
+   .min-w-50 {
+      min-width: 50px;
+   }
+   .action-desc {
+      font-size: 0.85rem;
+   }
+   .dark-mode .list-group-item {
+      background-color: #333333;
+      border-color: #444444;
+      color: #eeeeee;
+   }
+   .dark-mode .text-muted {
+      color: #aaaaaa !important;
+   }
+</style>
 <p class="text-center">
    <img
       src="https://raw.githubusercontent.com/homebridge-plugins/homebridge-resideo/latest/branding/Homebridge_x_Resideo.svg"
@@ -46,9 +62,7 @@
    <button type="button" class="btn btn-primary" id="menuSettings">
       Settings
    </button>
-   <button type="button" class="btn btn-primary" id="menuDevices">
-      Devices
-   </button>
+   <button type="button" class="btn btn-primary" id="menuDevices">My Devices</button>
    <button type="button" class="btn btn-primary mr-0" id="menuHome">
       Support
    </button>
@@ -88,11 +102,46 @@
 <div id="pageDevices" class="mt-4" style="display: none;">
    <div id="deviceInfo">
       <form>
-         <div class="form-group">
+         <div class="form-group mb-0">
             <select class="form-control" id="deviceSelect"></select>
          </div>
       </form>
-      <table class="table w-100" id="deviceTable" style="display: none;">
+      <ul class="list-group mt-4 mb-4 mx-0" id="configActionList" style="display: none;">
+         <li class="list-group-item">
+            <div class="d-flex justify-content-between align-items-center">
+               <div class="pr-2">
+                  <div>Add All Devices</div>
+                  <div class="text-muted action-desc">Add all devices to the config that are not already in the config.</div>
+               </div>
+               <button type="button" class="btn btn-primary m-0 ml-3 py-1 min-w-50" id="addAllBtn" aria-label="Add all devices to the config">
+                  <i aria-hidden="true" class="fas fa-arrow-right"></i>
+               </button>
+            </div>
+         </li>
+         <li class="list-group-item">
+            <div class="d-flex justify-content-between align-items-center">
+               <div class="pr-2">
+                  <div id="deviceConfigTitle">Add This Device</div>
+                  <div class="text-muted action-desc" id="deviceConfigText">Add this device to the plugin config.</div>
+               </div>
+               <button type="button" class="btn btn-primary m-0 ml-3 py-1 min-w-50" id="deviceConfigBtn" aria-label="Add this device to the config">
+                  <i aria-hidden="true" class="fas fa-arrow-right"></i>
+               </button>
+            </div>
+         </li>
+         <li class="list-group-item">
+            <div class="d-flex justify-content-between align-items-center">
+               <div class="pr-2">
+                  <div id="hideDeviceTitle">Hide This Device</div>
+                  <div class="text-muted action-desc" id="hideDeviceText">Hide this device from HomeKit. This adds the device to the config if needed.</div>
+               </div>
+               <button type="button" class="btn btn-primary m-0 ml-3 py-1 min-w-50" id="hideDeviceBtn" aria-label="Hide this device from HomeKit">
+                  <i aria-hidden="true" class="fas fa-arrow-right"></i>
+               </button>
+            </div>
+         </li>
+      </ul>
+      <table class="table w-100 mt-0" id="deviceTable" style="display: none;">
          <thead>
             <tr class="table-active">
                <th scope="col" style="width: 40%;">Device Name</th>
@@ -116,71 +165,291 @@
       </table>
    </div>
 </div>
-<div id="pageSupport" class="mt-4" style="display: none;">
-   <p class="text-center lead">Thank you for using <strong>homebridge-resideo</strong></p>
-   <p class="text-center">The links below will take you to our GitHub wiki</p>
-   <h5>Setup</h5>
-   <ul>
-      <li>
-         <a href="https://github.com/homebridge-plugins/homebridge-resideo/wiki" target="_blank">Wiki Home</a>
-      </li>
-      <li>
-         <a href="https://github.com/homebridge-plugins/homebridge-resideo/wiki/Configuration"
-            target="_blank">Configuration</a>
-      </li>
-      <li>
-         <a href="https://github.com/homebridge-plugins/homebridge-resideo/wiki/Beta-Version" target="_blank">Beta
-            Version</a>
-      </li>
-      <li>
-         <a href="https://github.com/homebridge-plugins/homebridge-resideo/wiki/Node-Version" target="_blank">Node
-            Version</a>
-      </li>
-      <li>
-         <a href="https://github.com/homebridge-plugins/homebridge-resideo/wiki/Uninstallation"
-            target="_blank">Uninstallation</a>
-      </li>
-   </ul>
-   <h5>Features</h5>
-   <ul>
-      <li>
-         <a href="https://github.com/homebridge-plugins/homebridge-resideo/wiki/Supported-Devices" target="_blank">Supported
-            Devices</a>
-      </li>
-      <li>
-         <a href="https://github.com/homebridge-plugins/homebridge-resideo/wiki/Fan-Modes" target="_blank">Fan
-            Modes</a>
-      </li>
-   </ul>
-   <h5>Help/About</h5>
-   <ul>
-      <li>
-         <a href="https://github.com/homebridge-plugins/homebridge-resideo/issues/new/choose" target="_blank">Support
-            Request</a>
-      </li>
-      <li>
-         <a href="https://github.com/homebridge-plugins/homebridge-resideo/blob/latest/CHANGELOG.md"
-            target="_blank">Changelog</a>
-      </li>
-      <li>
-         <a href="https://github.com/sponsors/donavanbecker" target="_blank">About Me</a>
-      </li>
-   </ul>
-   <h5>Disclaimer</h5>
-   <ul>
-      <li>
-         I am in no way affiliated with Resideo and this plugin is a personal project that I maintain in
-         my free time.
-      </li>
-      <li>
-         Use this plugin entirely at your own risk - please see licence for more information.
-      </li>
-   </ul>
+<div id="pageSupport" class="mt-4" style="display: none">
+  <p class="text-center lead">Thank you for using <strong>homebridge-resideo</strong></p>
+  <h5>Plugin Information</h5>
+<ul>
+  <li>This plugin allows you to view and control your <a href="https://www.resideo.com" target="_blank">Resideo</a> (Honeywell Home) devices within HomeKit. The plugin:</li>
+  <ul>
+    <li>requires a (free) Resideo developer account to work - this is separate from the Resideo account you use in the Resideo app</li>
+    <li>connects to the Resideo cloud to discover and control your devices</li>
+  </ul>
+</ul>
+  <h5>Prerequisites</h5>
+<ul>
+  <li>To use this plugin, you will need to already have:</li>
+  <ul>
+    <li><a href="https://nodejs.org" target="_blank">Node</a>: latest version of <code>v22</code> or <code>v24</code> - any other major version is not supported.</li>
+    <li><a href="https://homebridge.io" target="_blank">Homebridge</a>: <code>v2</code> - refer to link for more information and installation instructions.</li>
+  </ul>
+</ul>
+  <h5>Setup</h5>
+<ul>
+  <li><a href="https://github.com/homebridge-plugins/homebridge-resideo/wiki/Installation" target="_blank">Installation</a></li>
+  <li><a href="https://github.com/homebridge-plugins/homebridge-resideo/wiki/Configuration" target="_blank">Configuration</a></li>
+  <li><a href="https://github.com/homebridge-plugins/homebridge-resideo/wiki/Beta-Version" target="_blank">Beta Version</a></li>
+  <li><a href="https://github.com/homebridge-plugins/homebridge-resideo/wiki/Node-Version" target="_blank">Node Version</a></li>
+</ul>
+  <h5>Supported Devices</h5>
+<ul>
+  <li><a href="https://www.resideo.com/us/en/products/air/thermostats/wifi-thermostats/t10-pro-smart-thermostat-with-redlinkr-room-sensor-thx321wfs2001w-u/" target="_blank">T10 Thermostat</a> - already HomeKit certified</li>
+  <li><a href="https://www.resideo.com/us/en/products/air/thermostats/wifi-thermostats/t9-smart-thermostat-with-sensor-rcht9610wfsw2003-u/" target="_blank">T9 Thermostat</a> - already HomeKit certified</li>
+  <ul>
+    <li><a href="https://www.resideo.com/us/en/products/air/thermostat-accessories/t9-smart-sensor-rchtsensor-1pk-u/" target="_blank">T9 Smart Roomsensors</a></li>
+  </ul>
+  <li><a href="https://www.resideo.com/us/en/products/air/thermostats/wifi-thermostats/t6-pro-smart-thermostat-multi-stage-3-heat-2-cool-th6320wf2003-u/" target="_blank">T6 Thermostat</a> - already HomeKit certified</li>
+  <li><a href="https://www.resideo.com/us/en/products/air/thermostats/wifi-thermostats/t5-smart-thermostat-with-c-wire-adapter-rcht8612wf2005-u/" target="_blank">T5 Thermostat</a> - already HomeKit certified</li>
+  <li><a href="https://www.resideo.com/us/en/products/air/thermostats/wifi-thermostats/the-round-smart-thermostat-rch9310wf5003-u/" target="_blank">Round Thermostat</a> - already HomeKit certified</li>
+  <li>Some Total Comfort Control thermostats</li>
+  <ul>
+    <li>Pushing commands may not be supported on some.</li>
+  </ul>
+  <li><a href="https://www.resideo.com/us/en/products/water/spot-leak-detection/wifi-water-leak-freeze-detector-rchw3610wf1001-u/" target="_blank">WiFi Water Leak &amp; Freeze Detector</a></li>
+  <li>Water Shutoff Valves</li>
+</ul>
+  <h5>Help/About</h5>
+<ul>
+  <li><a href="https://github.com/homebridge-plugins/homebridge-resideo/wiki/Common-Errors" target="_blank">Common Errors</a></li>
+  <li><a href="https://github.com/homebridge-plugins/homebridge-resideo/issues/new/choose" target="_blank">Support Request</a></li>
+  <li><a href="https://github.com/homebridge-plugins/homebridge-resideo/blob/latest/CHANGELOG.md" target="_blank">Changelog</a></li>
+  <li><a href="https://github.com/sponsors/bwp91" target="_blank">About Me</a></li>
+</ul>
+  <h5>Credits</h5>
+<ul>
+  <li>To <a href="https://github.com/donavanbecker" target="_blank">@donavanbecker</a>: the original creator and maintainer of this plugin.</li>
+  <li>To the creators/contributors of <a href="https://homebridge.io" target="_blank">Homebridge</a> who make this plugin possible.</li>
+</ul>
+  <h5>Disclaimer</h5>
+<ul>
+  <li>I am in no way affiliated with Resideo or Honeywell and this plugin is a personal project that I maintain in my free time.</li>
+  <li>Use this plugin entirely at your own risk - please see licence for more information.</li>
+</ul>
 </div>
 <script>
    ; (async () => {
       try {
          const currentConfig = await homebridge.getPluginConfig()
+
+         // ===== Device picker (add/remove/hide config entries from the Devices tab) =====
+         // The control state is always computed from a fresh getPluginConfig() call,
+         // so staged-but-unsaved edits made in the Settings tab are respected
+         let pickerAccessories = []
+         let removeConfirmTimer
+
+         // The action buttons always show the settings-page arrow; the row text
+         // (and the button's aria-label) says what the arrow will do
+         const actionArrow = '<i aria-hidden="true" class="fas fa-arrow-right"></i>'
+
+         // The platform merges device config by exact trimmed id, so the
+         // picker mirrors that rather than a looser comparison
+         const cleanId = id => (id || '').toString().trim()
+
+         const getConfigBlocks = async () => {
+            const blocks = await homebridge.getPluginConfig()
+            if (!blocks.length) {
+               blocks.push({ name: 'Resideo' })
+            }
+            return blocks
+         }
+
+         // The devices array lives nested under options
+         const getDevicesArray = (config, create) => {
+            if (!config.options || typeof config.options !== 'object') {
+               if (!create) {
+                  return null
+               }
+               config.options = {}
+            }
+            if (!Array.isArray(config.options.devices)) {
+               if (!create) {
+                  return null
+               }
+               config.options.devices = []
+            }
+            return config.options.devices
+         }
+
+         const findInConfig = (config, deviceID) => {
+            const target = cleanId(deviceID)
+            const devices = getDevicesArray(config, false)
+            if (!devices) {
+               return null
+            }
+            const index = devices.findIndex(entry => entry && cleanId(entry.deviceID) === target)
+            return index === -1 ? null : { index }
+         }
+
+         const selectedAccessory = () => {
+            const uuid = document.getElementById('deviceSelect').value
+            return pickerAccessories.find(x => x.UUID === uuid)
+         }
+
+         const setHideControl = hidden => {
+            const btn = document.getElementById('hideDeviceBtn')
+            btn.dataset.hidden = hidden ? 'yes' : 'no'
+            btn.innerHTML = actionArrow
+            btn.setAttribute('aria-label', hidden ? 'Show this device in HomeKit' : 'Hide this device from HomeKit')
+            document.getElementById('hideDeviceTitle').innerHTML = hidden ? 'Show This Device' : 'Hide This Device'
+            document.getElementById('hideDeviceText').innerHTML = hidden
+               ? 'Show this device in HomeKit again. The config entry is kept.'
+               : 'Hide this device from HomeKit. This adds the device to the config if needed.'
+         }
+
+         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 = actionArrow
+            btn.setAttribute('aria-label', inConfig ? 'Remove this device from the config' : 'Add this device to the config')
+            document.getElementById('deviceConfigTitle').innerHTML = inConfig ? 'Remove This Device' : 'Add This Device'
+            document.getElementById('deviceConfigText').innerHTML = inConfig
+               ? 'Remove this device from the plugin config.'
+               : 'Add this device to the plugin config.'
+         }
+
+         const addDeviceToConfig = (config, acc) => {
+            const devices = getDevicesArray(config, true)
+            // configDeviceName is included so the entry is identifiable in the
+            // config editor; it matches the current name so nothing is renamed
+            devices.push({ deviceID: acc.context.deviceID, configDeviceName: acc.displayName })
+         }
+
+         document.getElementById('deviceConfigBtn').addEventListener('click', async () => {
+            try {
+               const btn = document.getElementById('deviceConfigBtn')
+               const acc = selectedAccessory()
+               if (!acc) {
+                  return
+               }
+               const blocks = await getConfigBlocks()
+               const config = blocks[0]
+               const found = findInConfig(config, acc.context.deviceID)
+               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)
+                     setHideControl(!!config.options.devices[found.index].hide_device)
+                     homebridge.toast.info(acc.displayName + ' is already in the config.', 'Not Added')
+                     return
+                  }
+                  addDeviceToConfig(config, acc)
+                  await homebridge.updatePluginConfig(blocks)
+                  setConfigButton(true)
+                  setHideControl(false)
+                  homebridge.toast.success(acc.displayName + ' added - press Save to apply.', 'Added To Config')
+               } else {
+                  if (!found) {
+                     setConfigButton(false)
+                     setHideControl(false)
+                     homebridge.toast.info(acc.displayName + ' is not in the config.', 'Not Removed')
+                     return
+                  }
+                  const entry = config.options.devices[found.index]
+                  const extraKeys = Object.keys(entry).filter(k => !['deviceID', 'configDeviceName'].includes(k))
+                  if (extraKeys.length > 0 && btn.dataset.confirm !== 'yes') {
+                     // The entry has settings beyond id and name 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 = actionArrow
+                     btn.setAttribute('aria-label', 'Confirm removing this device from the config')
+                     document.getElementById('deviceConfigText').innerHTML = 'This entry has extra settings which will be lost. Click again to remove it.'
+                     removeConfirmTimer = setTimeout(() => setConfigButton(true), 5000)
+                     return
+                  }
+                  config.options.devices.splice(found.index, 1)
+                  if (config.options.devices.length === 0) {
+                     delete config.options.devices
+                  }
+                  await homebridge.updatePluginConfig(blocks)
+                  setConfigButton(false)
+                  setHideControl(false)
+                  homebridge.toast.success(acc.displayName + ' removed - press Save to apply.', 'Removed From Config')
+               }
+            } catch (err) {
+               homebridge.toast.error(err.message, 'Error')
+            }
+         })
+
+         document.getElementById('hideDeviceBtn').addEventListener('click', async () => {
+            try {
+               const acc = selectedAccessory()
+               if (!acc) {
+                  return
+               }
+               const blocks = await getConfigBlocks()
+               const config = blocks[0]
+               let found = findInConfig(config, acc.context.deviceID)
+               const currentlyHidden = document.getElementById('hideDeviceBtn').dataset.hidden === 'yes'
+               if (!currentlyHidden) {
+                  // 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, acc.context.deviceID)
+                  }
+                  config.options.devices[found.index].hide_device = true
+                  await homebridge.updatePluginConfig(blocks)
+                  setConfigButton(true)
+                  setHideControl(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 hide_device false, to
+                     // keep the entry clean
+                     delete config.options.devices[found.index].hide_device
+                     await homebridge.updatePluginConfig(blocks)
+                  }
+                  setConfigButton(!!found)
+                  setHideControl(false)
+                  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 (!acc.context?.deviceID) {
+                     return
+                  }
+                  if (findInConfig(config, acc.context.deviceID)) {
+                     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 acc = selectedAccessory()
+               if (acc) {
+                  const nowFound = findInConfig(config, acc.context.deviceID)
+                  setConfigButton(!!nowFound)
+                  if (nowFound) {
+                     setHideControl(!!config.options.devices[nowFound.index].hide_device)
+                  }
+               }
+            } catch (err) {
+               homebridge.toast.error(err.message, 'Error')
+            }
+         })
+         // ===== End device picker =====
          const hostname = window.location.hostname
          try {
             await homebridge.request('Start Resideo Login Server')
@@ -303,6 +572,7 @@
                         : 0
                })
             }
+            pickerAccessories = cachedAccessories
             const deviceSelect = document.getElementById('deviceSelect')
             deviceSelect.innerHTML = ''
             cachedAccessories.forEach(a => {
@@ -320,6 +590,11 @@
                document.getElementById('model').innerHTML = context.model
                document.getElementById('firmwareRevision').innerHTML = context.firmwareRevision || 'N/A'
                document.getElementById('deviceTable').style.display = 'inline-table'
+               const configBlocks = await getConfigBlocks()
+               const configEntry = findInConfig(configBlocks[0], context.deviceID)
+               setConfigButton(!!configEntry)
+               setHideControl(!!(configEntry && configBlocks[0].options.devices[configEntry.index].hide_device))
+               document.getElementById('configActionList').style.display = 'block'
                homebridge.hideSpinner()
             }
             deviceSelect.addEventListener('change', event => showDeviceInfo(event.target.value))
@@ -330,6 +605,7 @@
                option.text = 'No Devices'
                deviceSelect.add(option)
                deviceSelect.disabled = true
+               document.getElementById('configActionList').style.display = 'none'
             }
             homebridge.hideSpinner()
          }

package/package.json

@@ -2,7 +2,7 @@
   "name": "@homebridge-plugins/homebridge-resideo",
   "displayName": "Resideo",
   "type": "module",
-  "version": "3.1.5",
+  "version": "3.2.0-beta.1",
   "description": "The Resideo plugin allows you to access your Resideo device(s) from HomeKit.",
   "author": {
     "name": "bwp91",