@homebridge-plugins/homebridge-matter 0.0.6 → 0.1.0

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

@@ -0,0 +1,269 @@
+<style>
+  .dark-mode {
+    background-color: #242424;
+    color: lightgrey;
+
+    .form-control {
+      background-color: #333333 !important;
+      border: none !important;
+      color: #eeeeee !important;
+    }
+
+    thead, tbody, tr {
+      border-style: hidden;
+    }
+
+    th {
+      color: #eeeeee !important;
+      font-weight: 500 !important;
+    }
+  }
+  select {
+    background-image:
+      linear-gradient(45deg, transparent 50%, gray 50%),
+      linear-gradient(135deg, gray 50%, transparent 50%),
+      linear-gradient(to right, #ccc, #ccc);
+    background-position:
+      calc(100% - 20px) calc(1em + 2px),
+      calc(100% - 15px) calc(1em + 2px),
+      calc(100% - 2.5em) 0.5em;
+    background-size:
+      5px 5px,
+      5px 5px,
+      1px 1.5em;
+    background-repeat: no-repeat;
+  }
+</style>
+<p class="text-center">
+  <img
+    src="https://github.com/homebridge-plugins/homebridge-matter/blob/latest/plugin-header.png?raw=true"
+    alt="homebridge-matter logo"
+    style="width: 60%;"
+  />
+</p>
+<div id="pageIntro" class="text-center" style="display: none;">
+  <p class="lead">Thank you for installing <strong>homebridge-matter</strong></p>
+  <button type="button" class="btn btn-primary" id="introContinue">
+    Continue &rarr;
+  </button>
+</div>
+<div
+  id="menuWrapper"
+  class="btn-group w-100 mb-0"
+  role="group"
+  aria-label="UI Menu"
+  style="display: none;"
+>
+  <button type="button" class="btn btn-primary ml-0" id="menuSettings">
+    Settings
+  </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>
+</div>
+<div
+  id="disabledBanner"
+  class="alert alert-secondary mb-0 mt-3"
+  role="alert"
+  style="display: none;"
+>
+  Plugin is currently disabled
+  <button id="disabledEnable" type="button" class="btn btn-link p-0 m-0 float-right">
+    Enable
+  </button>
+</div>
+<div id="pageDevices" class="mt-4" style="display: none;">
+  <div id="deviceInfo">
+    <form>
+      <div class="form-group">
+        <select class="form-control" id="deviceSelect"></select>
+      </div>
+    </form>
+    <table class="table w-100 mt-3" id="deviceTable" style="display: none;">
+      <thead>
+        <tr class="table-active">
+          <th scope="col" style="width: 40%;">Device Name</th>
+          <th scope="col" style="width: 60%;" id="displayName"></th>
+        </tr>
+      </thead>
+      <tbody>
+      </tbody>
+    </table>
+  </div>
+</div>
+<div id="pageSupport" class="mt-4" style="display: none;">
+  <p class="text-center lead">Thank you for using <strong>homebridge-matter</strong></p>
+  <p class="text-center">The links below will take you to our GitHub wiki</p>
+  <h4>Setup</h4>
+  <ul>
+    <li>
+      <a href="https://github.com/homebridge/homebridge/wiki/How-to-Install-Alternate-Plugin-Versions" target="_blank"
+        >Beta Version</a
+      >
+    </li>
+  </ul>
+  <h4>Help/About</h4>
+  <ul>
+    <li>
+      <a href="https://github.com/homebridge-plugins/homebridge-matter/issues/new/choose" target="_blank"
+        >Support Request</a
+      >
+    </li>
+    <li>
+      <a href="https://github.com/homebridge-plugins/homebridge-matter/blob/latest/CHANGELOG.md" target="_blank"
+        >Changelog</a
+      >
+    </li>
+    <li>
+      <a href="https://github.com/sponsors/bwp91" target="_blank">About Me</a>
+    </li>
+  </ul>
+  <h4>Credits</h4>
+  <ul>
+    <li>
+      To the developers of <a href="https://github.com/matter-js/matter.js" target="_blank">matter.js</a> who make the Matter integration possible.
+    </li>
+  </ul>
+
+  <h4>Disclaimer</h4>
+  <ul>
+    <li>
+      I am in no way affiliated with Matter 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()
+      showIntro = () => {
+        homebridge.disableSaveButton?.()
+        const introContinue = document.getElementById('introContinue')
+        introContinue.addEventListener('click', () => {
+          homebridge.showSpinner()
+          document.getElementById('pageIntro').style.display = 'none'
+          document.getElementById('menuWrapper').style.display = 'inline-flex'
+          showSettings()
+          homebridge.hideSpinner()
+        })
+        document.getElementById('pageIntro').style.display = 'block'
+      }
+      showDevices = async () => {
+        homebridge.showSpinner()
+        homebridge.disableSaveButton?.()
+        homebridge.hideSchemaForm()
+        document.getElementById('menuHome').classList.remove('btn-elegant')
+        document.getElementById('menuHome').classList.add('btn-primary')
+        document.getElementById('menuDevices').classList.add('btn-elegant')
+        document.getElementById('menuDevices').classList.remove('btn-primary')
+        document.getElementById('menuSettings').classList.remove('btn-elegant')
+        document.getElementById('menuSettings').classList.add('btn-primary')
+        document.getElementById('pageSupport').style.display = 'none'
+        document.getElementById('pageDevices').style.display = 'block'
+        const cachedAccessories =
+          typeof homebridge.getCachedAccessories === 'function'
+            ? await homebridge.getCachedAccessories()
+            : await homebridge.request('/getCachedAccessories')
+        if (cachedAccessories.length > 0) {
+          cachedAccessories.sort((a, b) => {
+            return a.displayName.toLowerCase() > b.displayName.toLowerCase()
+              ? 1
+              : b.displayName.toLowerCase() > a.displayName.toLowerCase()
+              ? -1
+              : 0
+          })
+        }
+        const deviceSelect = document.getElementById('deviceSelect')
+        deviceSelect.innerHTML = ''
+        cachedAccessories.forEach(a => {
+          const option = document.createElement('option')
+          option.text = a.displayName
+          option.value = a.context.hbDeviceId
+          deviceSelect.add(option)
+        })
+        showDeviceInfo = async hbDeviceId => {
+          homebridge.showSpinner()
+          const thisAcc = cachedAccessories.find(x => x.context.hbDeviceId === hbDeviceId)
+          const context = thisAcc.context
+          document.getElementById('deviceTable').style.display = 'inline-table'
+          homebridge.hideSpinner()
+        }
+        deviceSelect.addEventListener('change', event => showDeviceInfo(event.target.value))
+        if (cachedAccessories.length > 0) {
+          showDeviceInfo(cachedAccessories[0].context.hbDeviceId)
+        } else {
+          const option = document.createElement('option')
+          option.text = 'No Devices'
+          deviceSelect.add(option)
+          deviceSelect.disabled = true
+        }
+        homebridge.hideSpinner()
+      }
+      showSupport = () => {
+        homebridge.showSpinner()
+        homebridge.disableSaveButton?.()
+        homebridge.hideSchemaForm()
+        document.getElementById('menuHome').classList.add('btn-elegant')
+        document.getElementById('menuHome').classList.remove('btn-primary')
+        document.getElementById('menuDevices').classList.remove('btn-elegant')
+        document.getElementById('menuDevices').classList.add('btn-primary')
+        document.getElementById('menuSettings').classList.remove('btn-elegant')
+        document.getElementById('menuSettings').classList.add('btn-primary')
+        document.getElementById('pageSupport').style.display = 'block'
+        document.getElementById('pageDevices').style.display = 'none'
+        homebridge.hideSpinner()
+      }
+      showSettings = () => {
+        homebridge.showSpinner()
+        homebridge.enableSaveButton?.()
+        document.getElementById('menuHome').classList.remove('btn-elegant')
+        document.getElementById('menuHome').classList.add('btn-primary')
+        document.getElementById('menuDevices').classList.remove('btn-elegant')
+        document.getElementById('menuDevices').classList.add('btn-primary')
+        document.getElementById('menuSettings').classList.add('btn-elegant')
+        document.getElementById('menuSettings').classList.remove('btn-primary')
+        document.getElementById('pageSupport').style.display = 'none'
+        document.getElementById('pageDevices').style.display = 'none'
+        homebridge.showSchemaForm()
+        homebridge.hideSpinner()
+      }
+      showDisabledBanner = () => {
+        document.getElementById('disabledBanner').style.display = 'block'
+      }
+      enablePlugin = async () => {
+        homebridge.showSpinner()
+        document.getElementById('disabledBanner').style.display = 'none'
+        currentConfig[0].disablePlugin = false
+        await homebridge.updatePluginConfig(currentConfig)
+        await homebridge.savePluginConfig()
+        homebridge.hideSpinner()
+      }
+      menuHome.addEventListener('click', () => showSupport())
+      menuDevices.addEventListener('click', () => showDevices())
+      menuSettings.addEventListener('click', () => showSettings())
+      disabledEnable.addEventListener('click', () => enablePlugin())
+      if (currentConfig.length) {
+        document.getElementById('menuWrapper').style.display = 'inline-flex'
+        showSettings()
+        if (currentConfig[0].disablePlugin) {
+          showDisabledBanner()
+        }
+      } else {
+        currentConfig.push({ name: 'Homebridge Matter' })
+        await homebridge.updatePluginConfig(currentConfig)
+        showIntro()
+      }
+    } catch (err) {
+      homebridge.toast.error(err.message, 'Error')
+    } finally {
+      homebridge.hideSpinner()
+    }
+  })()
+</script>

package/dist/homebridge-ui/server.js

@@ -0,0 +1,47 @@
+import fs from 'node:fs'
+
+import { HomebridgePluginUiServer } from '@homebridge/plugin-ui-utils'
+
+class PluginUiServer extends HomebridgePluginUiServer {
+  constructor() {
+    super()
+
+    /*
+      A native method getCachedAccessories() was introduced in config-ui-x v4.37.0
+      The following is for users who have a lower version of config-ui-x
+    */
+    this.onRequest('/getCachedAccessories', async () => {
+      try {
+        // Define the plugin and create the array to return
+        const plugin = '@homebridge-plugins/homebridge-matter'
+        const devicesToReturn = []
+
+        // The path and file of the cached accessories
+        const accFile = `${this.homebridgeStoragePath}/accessories/cachedAccessories`
+
+        // Check the file exists
+        if (fs.existsSync(accFile)) {
+          // Read the cached accessories file
+          let cachedAccessories = await fs.promises.readFile(accFile)
+
+          // Parse the JSON
+          cachedAccessories = JSON.parse(cachedAccessories)
+
+          // We only want the accessories for this plugin
+          cachedAccessories
+            .filter(accessory => accessory.plugin === plugin)
+            .forEach(accessory => devicesToReturn.push(accessory))
+        }
+
+        // Return the array
+        return devicesToReturn
+      } catch (err) {
+        // Just return an empty accessory list in case of any errors
+        return []
+      }
+    })
+    this.ready()
+  }
+}
+
+(() => new PluginUiServer())()

package/dist/platform.d.ts

@@ -1,59 +1,63 @@
-import type { API, DynamicPlatformPlugin, Logging, PlatformAccessory, PlatformConfig } from 'homebridge';
+import type { API, DynamicPlatformPlugin, Logging, PlatformConfig } from 'homebridge';
 /**
  * MatterPlatform
  * Demonstrates all available Matter device types in Homebridge
+ *
+ * Organized by official Matter Specification v1.4.1 categories
  */
 export declare class ExampleHomebridgePlatform implements DynamicPlatformPlugin {
     readonly log: Logging;
     readonly config: PlatformConfig;
     readonly api: API;
-    readonly accessories: Map<string, PlatformAccessory>;
     readonly matterAccessories: Map<string, any>;
     constructor(log: Logging, config: PlatformConfig, api: API);
     /**
      * Required for DynamicPlatformPlugin
      * Called when homebridge restores cached accessories from disk at startup
      */
-    configureAccessory(accessory: PlatformAccessory): void;
+    configureAccessory(): void;
     /**
-     * Called for each cached Matter accessory restored from disk
-     * Track these so we can determine which accessories to remove in didFinishLaunching
+     * Called when homebridge restores cached Matter accessories from disk at startup
      */
     configureMatterAccessory(accessory: any): void;
     /**
-     * Register all Matter accessory examples
+     * Register all Matter accessories
      */
     private registerMatterAccessories;
     /**
-     * Remove disabled accessories from cache
+     * Remove accessories that are disabled in config
      */
     private removeDisabledAccessories;
     /**
-     * Lighting Devices
+     * Section 4: Lighting Devices (Matter Spec § 4)
      */
-    private registerLightingDevices;
+    private registerSection4Lighting;
     /**
-     * Switches and Outlets
+     * Section 5: Smart Plugs/Actuators (Matter Spec § 5)
      */
-    private registerSwitchesAndOutlets;
+    private registerSection5SmartPlugs;
     /**
-     * Register Matter sensor accessories
+     * Section 6: Switches & Controllers (Matter Spec § 6)
      */
-    private registerSensors;
+    private registerSection6Switches;
     /**
-     * Register Matter HVAC accessories (Thermostats, Fans)
+     * Section 7: Sensors (Matter Spec § 7)
      */
-    private registerHVAC;
+    private registerSection7Sensors;
     /**
-     * Register Matter Security & Access accessories (Door Locks, Garage Doors)
+     * Section 8: Closure Devices (Matter Spec § 8)
      */
-    private registerSecurity;
+    private registerSection8Closure;
     /**
-     * Register Matter Window Covering accessories (Blinds, Shades)
+     * Section 9: HVAC (Matter Spec § 9)
      */
-    private registerWindowCoverings;
+    private registerSection9HVAC;
     /**
-     * Register Matter Appliance accessories (Robotic Vacuum Cleaners, etc.)
+     * Section 12: Robotic Devices (Matter Spec § 12)
+     *
+     * ⚠️ IMPORTANT: RVC devices are published as external accessories
+     * Apple Home requires RVC devices to be on their own dedicated Matter bridge.
+     * Using publishExternalAccessories ensures each RVC device gets its own bridge.
      */
-    private registerAppliances;
+    private registerSection12Robotic;
 }