@homebridge-plugins/homebridge-meross 10.16.5 → 10.17.0-beta.0

package/CHANGELOG.md

@@ -2,6 +2,12 @@
 
 All notable changes to `@homebridge-plugins/homebridge-meross` will be documented in this file.
 
+## v10.17.0 (Pending Release)
+
+### Changed
+
+- feat(ui): add, remove and hide devices from the config via the my devices tab
+
 ## v10.16.5 (2026-07-18)
 
 ### Changed

package/README.md

@@ -1,5 +1,5 @@
 <p align="center">
- <a href="https://github.com/homebridge-plugins/homebridge-meross"><img alt="Homebridge Verified" src="https://user-images.githubusercontent.com/43026681/127397024-8b15fc07-f31b-44bd-89e3-51d738d2609a.png" width="600px"></a>
+ <a href="https://github.com/homebridge-plugins/homebridge-meross"><img alt="Homebridge Verified" src="https://raw.githubusercontent.com/homebridge-plugins/homebridge-meross/latest/branding/Homebridge_x_Meross.png" width="600px"></a>
 </p>
 <span align="center">
 
@@ -35,7 +35,7 @@ Homebridge plugin to integrate Meross devices into HomeKit
 
 - [Installation](https://github.com/homebridge-plugins/homebridge-meross/wiki/Installation)
 - [Configuration](https://github.com/homebridge-plugins/homebridge-meross/wiki/Configuration)
-- [Beta Version](https://github.com/homebridge/homebridge/wiki/How-to-Install-Alternate-Plugin-Versions)
+- [Beta Version](https://github.com/homebridge-plugins/homebridge-meross/wiki/Beta-Version)
 - [Node Version](https://github.com/homebridge-plugins/homebridge-meross/wiki/Node-Version)
 
 ### Features

package/config.schema.json

@@ -5,7 +5,7 @@
   "strictValidation": true,
   "customUi": true,
   "customUiPath": "./lib/homebridge-ui",
-  "headerDisplay": "<p align=\"center\"><img width=\"60%\" src=\"https://user-images.githubusercontent.com/43026681/127397024-8b15fc07-f31b-44bd-89e3-51d738d2609a.png\"></p><p align=\"center\">For help and support please visit our <a href=\"https://github.com/homebridge-plugins/homebridge-meross/wiki\">GitHub Wiki</a>. We hope you find this plugin useful!</p>",
+  "headerDisplay": "<p align=\"center\"><img width=\"250px\" src=\"https://raw.githubusercontent.com/homebridge-plugins/homebridge-meross/latest/branding/Homebridge_x_Meross.png\"></p><p align=\"center\">For help and support please visit our <a href=\"https://github.com/homebridge-plugins/homebridge-meross/wiki\">GitHub Wiki</a>. We hope you find this plugin useful!</p>",
   "schema": {
     "name": {
       "type": "string",

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

@@ -17,6 +17,22 @@
       color: #eeeeee !important;
       font-weight: 500 !important;
     }
+
+    .list-group-item {
+      background-color: #333333;
+      border-color: #444444;
+      color: #eeeeee;
+    }
+
+    .text-muted {
+      color: #aaaaaa !important;
+    }
+  }
+  .min-w-50 {
+    min-width: 50px;
+  }
+  .action-desc {
+    font-size: 0.85rem;
   }
   select {
     background-image:
@@ -70,11 +86,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 mt-3" 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>
@@ -114,17 +165,6 @@
           <th scope="row">Firmware Version</th>
           <td id="firmware"></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="hideDevice">
-              <label class="custom-control-label" for="hideDevice">
-                Hide this device from HomeKit
-              </label>
-            </div>
-          </td>
-        </tr>
       </tbody>
     </table>
   </div>
@@ -242,6 +282,249 @@
   ;(async () => {
     try {
       const currentConfig = await homebridge.getPluginConfig()
+
+      // ===== Device picker (add/remove/hide config entries from the My 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
+      const deviceArrays = [
+        'singleDevices',
+        'multiDevices',
+        'lightDevices',
+        'fanDevices',
+        'diffuserDevices',
+        'purifierDevices',
+        'humidifierDevices',
+        'thermostatDevices',
+        'garageDevices',
+        'rollerDevices',
+        'babyDevices',
+        'sensorDevices',
+      ]
+      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>'
+
+      // Compare serial numbers ignoring case and separators, so an entry typed
+      // by hand in a different format still counts as the same device
+      const looseId = id => (id || '').toString().toLowerCase().replace(/[^a-z0-9]+/g, '')
+
+      const getConfigBlocks = async () => {
+        const blocks = await homebridge.getPluginConfig()
+        if (!blocks.length) {
+          blocks.push({ name: 'Meross' })
+        }
+        return blocks
+      }
+
+      const findInConfig = (config, serialNumber) => {
+        const target = looseId(serialNumber)
+        for (const key of deviceArrays) {
+          if (Array.isArray(config[key])) {
+            const index = config[key].findIndex(entry => entry && looseId(entry.serialNumber) === target)
+            if (index !== -1) {
+              return { key, index }
+            }
+          }
+        }
+        return null
+      }
+
+      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.'
+      }
+
+      // Which config array a model belongs in comes from the plugin's own
+      // model lists via the UI server; a model in none of them cannot be added
+      const addDeviceToConfig = async (config, acc) => {
+        const arrayKey = await homebridge.request('/getDeviceConfigKey', { model: acc.context.model })
+        if (!arrayKey) {
+          return false
+        }
+        if (!Array.isArray(config[arrayKey])) {
+          config[arrayKey] = []
+        }
+        config[arrayKey].push({ name: acc.displayName, serialNumber: looseId(acc.context.serialNumber) })
+        return true
+      }
+
+      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.serialNumber)
+          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[found.key][found.index].ignoreDevice)
+              homebridge.toast.info(acc.displayName + ' is already in the config.', 'Not Added')
+              return
+            }
+            if (!(await addDeviceToConfig(config, acc))) {
+              homebridge.toast.error('Unsupported device model: ' + acc.context.model, 'Cannot Add Device')
+              return
+            }
+            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[found.key][found.index]
+            const extraKeys = Object.keys(entry).filter(k => !['serialNumber', 'name'].includes(k))
+            if (extraKeys.length > 0 && btn.dataset.confirm !== 'yes') {
+              // The entry has settings beyond serial 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[found.key].splice(found.index, 1)
+            if (config[found.key].length === 0) {
+              delete config[found.key]
+            }
+            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.serialNumber)
+          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) {
+              if (!(await addDeviceToConfig(config, acc))) {
+                homebridge.toast.error('Unsupported device model: ' + acc.context.model, 'Cannot Hide Device')
+                return
+              }
+              found = findInConfig(config, acc.context.serialNumber)
+            }
+            config[found.key][found.index].ignoreDevice = 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 ignoreDevice false, to keep
+              // the entry clean
+              delete config[found.key][found.index].ignoreDevice
+              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
+          let unsupported = 0
+          for (const acc of pickerAccessories) {
+            if (!acc.context?.serialNumber) {
+              continue
+            }
+            if (findInConfig(config, acc.context.serialNumber)) {
+              skipped += 1
+              continue
+            }
+            if (await addDeviceToConfig(config, acc)) {
+              added += 1
+            } else {
+              unsupported += 1
+            }
+          }
+          if (added > 0) {
+            await homebridge.updatePluginConfig(blocks)
+            const parts = [added + ' device(s) added', skipped + ' already in the config']
+            if (unsupported > 0) {
+              parts.push(unsupported + ' unsupported')
+            }
+            homebridge.toast.success(parts.join(', ') + ' - 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.serialNumber)
+            setConfigButton(!!nowFound)
+            if (nowFound) {
+              setHideControl(!!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')
@@ -256,7 +539,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')
@@ -279,6 +564,7 @@
               : 0
           })
         }
+        pickerAccessories = cachedAccessories
         const deviceSelect = document.getElementById('deviceSelect')
         deviceSelect.innerHTML = ''
         cachedAccessories.forEach(a => {
@@ -306,80 +592,12 @@
           document.getElementById('hardware').innerHTML = context.hardware || 'N/A'
           document.getElementById('firmware').innerHTML = context.firmware || 'N/A'
 
-          // Handle hide device checkbox
-          const hideCheckbox = document.getElementById('hideDevice')
-          const deviceUUID = context.serialNumber.toLowerCase().replace(/[^a-z0-9]/g, '')
-          const deviceArrays = [
-            'singleDevices', 'multiDevices', 'lightDevices', 'fanDevices',
-            'diffuserDevices', 'purifierDevices', 'humidifierDevices',
-            'thermostatDevices', 'garageDevices', 'rollerDevices',
-            'babyDevices', 'sensorDevices',
-          ]
-          const findEntry = (cfg) => {
-            for (const key of deviceArrays) {
-              const arr = cfg[0]?.[key]
-              if (!Array.isArray(arr)) continue
-              const idx = arr.findIndex(e => e.serialNumber?.toLowerCase().replace(/[^a-z0-9]/g, '') === deviceUUID)
-              if (idx !== -1) return { key, idx, entry: arr[idx] }
-            }
-            return null
-          }
-
-          // Check if device is currently hidden
-          const config = await homebridge.getPluginConfig()
-          const existing = findEntry(config)
-          hideCheckbox.checked = !!existing?.entry?.ignoreDevice
-
-          // Remove previous event listeners by cloning the element
-          const newCheckbox = hideCheckbox.cloneNode(true)
-          hideCheckbox.parentNode.replaceChild(newCheckbox, hideCheckbox)
-
-          // Add event listener for checkbox changes
-          newCheckbox.addEventListener('change', async (e) => {
-            try {
-              homebridge.showSpinner()
-              const cfg = await homebridge.getPluginConfig()
-              const found = findEntry(cfg)
-
-              if (e.target.checked) {
-                if (found) {
-                  cfg[0][found.key][found.idx].ignoreDevice = true
-                } else {
-                  const arrayKey = await homebridge.request('/getDeviceConfigKey', { model: context.model })
-                  if (!arrayKey) {
-                    homebridge.toast.error(`Unsupported device model: ${context.model}`, 'Cannot hide device')
-                    e.target.checked = false
-                    homebridge.hideSpinner()
-                    return
-                  }
-                  if (!Array.isArray(cfg[0][arrayKey])) {
-                    cfg[0][arrayKey] = []
-                  }
-                  cfg[0][arrayKey].push({
-                    name: thisAcc.displayName,
-                    serialNumber: deviceUUID,
-                    ignoreDevice: true,
-                  })
-                }
-                homebridge.toast.success(`${thisAcc.displayName} will be hidden from HomeKit after restart`, 'Device Hidden')
-              } else if (found) {
-                cfg[0][found.key][found.idx].ignoreDevice = false
-                homebridge.toast.success(`${thisAcc.displayName} will be shown in HomeKit after restart`, 'Device Unhidden')
-              }
-
-              await homebridge.updatePluginConfig(cfg)
-
-              // Switch to Settings tab to sync the form with updated config
-              showSettings()
-              homebridge.toast.info('Please click Save to persist your changes', 'Settings Updated')
-              homebridge.hideSpinner()
-            } catch (err) {
-              homebridge.toast.error(err.message, 'Error')
-              homebridge.hideSpinner()
-            }
-          })
-
           document.getElementById('deviceTable').style.display = 'inline-table'
+          const configBlocks = await getConfigBlocks()
+          const configEntry = findInConfig(configBlocks[0], context.serialNumber)
+          setConfigButton(!!configEntry)
+          setHideControl(!!(configEntry && configBlocks[0][configEntry.key][configEntry.index].ignoreDevice))
+          document.getElementById('configActionList').style.display = 'block'
           homebridge.hideSpinner()
         }
         deviceSelect.addEventListener('change', event => showDeviceInfo(event.target.value))
@@ -390,6 +608,7 @@
           option.text = 'No Devices'
           deviceSelect.add(option)
           deviceSelect.disabled = true
+          document.getElementById('configActionList').style.display = 'none'
         }
         homebridge.hideSpinner()
       }

package/lib/platform.js

@@ -137,7 +137,10 @@ export default class {
                 return
               }
               const entries = Object.entries(x)
-              if (entries.length < 3) {
+              // An entry with just a serial number carries nothing; two keys
+              // (serial number plus name) is kept, as that is what the UI
+              // device picker creates for users to build on
+              if (entries.length < 2) {
                 logRemove(`${key}.${id}`)
                 return
               }

package/package.json

@@ -2,7 +2,7 @@
   "name": "@homebridge-plugins/homebridge-meross",
   "alias": "Meross",
   "type": "module",
-  "version": "10.16.5",
+  "version": "10.17.0-beta.0",
   "description": "Homebridge plugin to integrate Meross devices into HomeKit.",
   "author": {
     "name": "bwp91",