@homebridge-plugins/homebridge-wemo 7.0.0

package/lib/fakegato/fakegato-storage.js

@@ -0,0 +1,108 @@
+import fs from 'node:fs'
+import os from 'node:os'
+import path from 'node:path'
+
+const hostname = os.hostname().split('.')[0]
+
+export default class {
+  constructor(params) {
+    if (!params) {
+      params = {}
+    }
+    this.writers = []
+    this.log = params.log || {}
+    if (!this.log) {
+      this.log = () => {}
+    }
+    this.addingWriter = false
+  }
+
+  addWriter(service, params) {
+    if (!this.addingWriter) {
+      this.addingWriter = true
+      if (!params) {
+        params = {}
+      }
+      this.log('[%s] FGS addWriter().', service.accessoryName)
+      const newWriter = {
+        service,
+        callback: params.callback,
+        fileName: `${hostname}_${service.accessoryName}_persist.json`,
+      }
+      const onReady = typeof params.onReady === 'function' ? params.onReady : () => {}
+      newWriter.storageHandler = fs
+      newWriter.path = params.path || path.join(os.homedir(), '.homebridge')
+      this.writers.push(newWriter)
+      this.addingWriter = false
+      onReady()
+    } else {
+      setTimeout(() => this.addWriter(service, params), 100)
+    }
+  }
+
+  getWriter(service) {
+    return this.writers.find(ele => ele.service === service)
+  }
+
+  _getWriterIndex(service) {
+    return this.writers.findIndex(ele => ele.service === service)
+  }
+
+  getWriters() {
+    return this.writers
+  }
+
+  delWriter(service) {
+    const index = this._getWriterIndex(service)
+    this.writers.splice(index, 1)
+  }
+
+  write(params) {
+    if (!this.writing) {
+      this.writing = true
+      const writer = this.getWriter(params.service)
+      const callBack = typeof params.callback === 'function'
+        ? params.callback
+        : typeof writer.callback === 'function'
+          ? writer.callback
+          : () => {}
+      const fileLoc = path.join(writer.path, writer.fileName)
+      this.log(
+        '[%s] FGS write file [%s] [%s].',
+        params.service.accessoryName,
+        fileLoc,
+        params.data.substr(1, 80),
+      )
+      writer.storageHandler.writeFile(fileLoc, params.data, 'utf8', (...args) => {
+        this.writing = false
+        callBack(args)
+      })
+    } else {
+      setTimeout(() => this.write(params), 100)
+    }
+  }
+
+  read(params) {
+    const writer = this.getWriter(params.service)
+    const callBack = typeof params.callback === 'function'
+      ? params.callback
+      : typeof writer.callback === 'function'
+        ? writer.callback
+        : () => {}
+    const fileLoc = path.join(writer.path, writer.fileName)
+    this.log('[%s] FGS read file [%s].', params.service.accessoryName, fileLoc)
+    writer.storageHandler.readFile(fileLoc, 'utf8', callBack)
+  }
+
+  remove(params) {
+    const writer = this.getWriter(params.service)
+    const callBack = typeof params.callback === 'function'
+      ? params.callback
+      : typeof writer.callback === 'function'
+        ? writer.callback
+        : () => {}
+    const fileLoc = path.join(writer.path, writer.fileName)
+    this.log('[%s] FGS delete file [%s].', params.service.accessoryName, fileLoc)
+    writer.storageHandler.unlink(fileLoc, callBack)
+  }
+}

package/lib/fakegato/fakegato-timer.js

@@ -0,0 +1,125 @@
+export default class {
+  constructor(params) {
+    if (!params) {
+      params = {}
+    }
+    this.subscribedServices = []
+    this.minutes = params.minutes || 10
+    this.intervalID = null
+    this.running = false
+    this.log = params.log || {}
+    if (!this.log) {
+      this.log = () => {}
+    }
+  }
+
+  subscribe(service, callback) {
+    this.log('[%s] FGT new subscription.', service.accessoryName)
+    const newService = {
+      service,
+      callback,
+      backLog: [],
+      previousBackLog: [],
+      previousAvrg: {},
+    }
+    this.subscribedServices.push(newService)
+  }
+
+  getSubscriber(service) {
+    return this.subscribedServices.find(el => el.service === service)
+  }
+
+  _getSubscriberIndex(service) {
+    return this.subscribedServices.findIndex(el => el.service === service)
+  }
+
+  getSubscribers() {
+    return this.subscribedServices
+  }
+
+  unsubscribe(service) {
+    const index = this._getSubscriberIndex(service)
+    this.subscribedServices.splice(index, 1)
+    if (this.subscribedServices.length === 0 && this.running) {
+      this.stop()
+    }
+  }
+
+  start() {
+    this.log('Starting global FGT [%s minutes].', this.minutes)
+    if (this.running) {
+      this.stop()
+    }
+    this.running = true
+    this.intervalID = setInterval(this.executeCallbacks.bind(this), this.minutes * 60 * 1000)
+  }
+
+  stop() {
+    this.log('Stopping global FGT.')
+    clearInterval(this.intervalID)
+    this.running = false
+    this.intervalID = null
+  }
+
+  executeCallbacks() {
+    this.log('FGT executeCallbacks().')
+    if (this.subscribedServices.length !== 0) {
+      for (const s in this.subscribedServices) {
+        if (Object.prototype.hasOwnProperty.call(this.subscribedServices, s)) {
+          const service = this.subscribedServices[s]
+          if (typeof service.callback === 'function') {
+            service.previousAvrg = service.callback({
+              backLog: service.backLog,
+              previousAvrg: service.previousAvrg,
+              timer: this,
+              immediate: false,
+            })
+          }
+        }
+      }
+    }
+  }
+
+  executeImmediateCallback(service) {
+    this.log('[%s] FGT executeImmediateCallback().', service.accessoryName)
+    if (typeof service.callback === 'function' && service.backLog.length) {
+      service.callback({
+        backLog: service.backLog,
+        timer: this,
+        immediate: true,
+      })
+    }
+  }
+
+  addData(params) {
+    const data = params.entry
+    const { service } = params
+    const immediateCallback = params.immediateCallback || false
+    this.log(
+      '[%s] FGT addData() [%s] immediate [%s].',
+      service.accessoryName,
+      data,
+      immediateCallback,
+    )
+    if (immediateCallback) {
+      this.getSubscriber(service).backLog[0] = data
+    } else {
+      this.getSubscriber(service).backLog.push(data)
+    }
+    if (immediateCallback) {
+      this.executeImmediateCallback(this.getSubscriber(service))
+    }
+    if (!this.running) {
+      this.start()
+    }
+  }
+
+  emptyData(service) {
+    this.log('[%s] FGT emptyData().', service.accessoryName)
+    const source = this.getSubscriber(service)
+    if (source.backLog.length) {
+      source.previousBackLog = source.backLog
+    }
+    source.backLog = []
+  }
+}

package/lib/fakegato/uuid.js

@@ -0,0 +1,27 @@
+// https://github.com/homebridge/HAP-NodeJS/blob/master/src/lib/util/uuid.ts
+
+function isValid(UUID) {
+  const uuidRegex = /^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$/i
+  return uuidRegex.test(UUID)
+}
+
+function toLongFormUUID(uuid, base = '-0000-1000-8000-0026BB765291') {
+  const shortRegex = /^[0-9a-f]{1,8}$/i
+  if (isValid(uuid)) {
+    return uuid.toUpperCase()
+  }
+  if (!shortRegex.test(uuid)) {
+    throw new TypeError('uuid was not a valid UUID or short form UUID')
+  }
+  if (!isValid(`00000000${base}`)) {
+    throw new TypeError('base was not a valid base UUID')
+  }
+  return ((`00000000${uuid}`).substr(-8) + base).toUpperCase()
+}
+
+function toShortFormUUID(uuid, base = '-0000-1000-8000-0026BB765291') {
+  uuid = toLongFormUUID(uuid, base)
+  return uuid.substr(0, 8)
+}
+
+export { toLongFormUUID, toShortFormUUID }

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

@@ -0,0 +1,315 @@
+<p class="text-center">
+  <img
+    src="https://user-images.githubusercontent.com/43026681/126868557-d0983348-d124-4247-bea9-7dcc62849cdf.png"
+    alt="homebridge-wemo logo"
+    style="width: 60%;"
+  />
+</p>
+<div id="pageIntro" class="text-center" style="display: none;">
+  <p class="lead">Thank you for installing <strong>homebridge-wemo</strong></p>
+  <p>Remember to click Save on the next page</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="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" 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>
+        <tr>
+          <th scope="row">HTTP Status</th>
+          <td id="http_status"></td>
+        </tr>
+        <tr>
+          <th scope="row">UPnP Status</th>
+          <td id="upnp_status"></td>
+        </tr>
+        <tr>
+          <th scope="row">IP Address</th>
+          <td id="ipAddress"></td>
+        </tr>
+        <tr>
+          <th scope="row">Port</th>
+          <td id="port"></td>
+        </tr>
+        <tr>
+          <th scope="row">UPnP Info</th>
+          <td id="upnpInfo"></td>
+        </tr>
+        <tr>
+          <th scope="row">Serial Number</th>
+          <td id="serialNumber"></td>
+        </tr>
+        <tr>
+          <th scope="row">MAC Address</th>
+          <td id="macAddress"></td>
+        </tr>
+        <tr>
+          <th scope="row">Firmware</th>
+          <td id="firmware"></td>
+        </tr>
+        <tr>
+          <td colspan="2" style="text-align: center" id="imgIcon"></td>
+        </tr>
+      </tbody>
+    </table>
+  </div>
+</div>
+<div id="pageSupport" class="mt-4" style="display: none;">
+  <p class="text-center lead">Thank you for using <strong>homebridge-wemo</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-plugins/homebridge-wemo/wiki/Installation" target="_blank"
+        >Installation</a
+      >
+    </li>
+    <li>
+      <a href="https://github.com/homebridge-plugins/homebridge-wemo/wiki/Configuration" target="_blank"
+        >Configuration</a
+      >
+    </li>
+    <li>
+      <a href="https://github.com/homebridge/homebridge/wiki/How-to-Install-Alternate-Plugin-Versions" target="_blank"
+        >Beta Version</a
+      >
+    </li>
+    <li>
+      <a href="https://github.com/homebridge-plugins/homebridge-wemo/wiki/Node-Version" target="_blank"
+        >Node Version</a
+      >
+    </li>
+  </ul>
+  <h4>Features</h4>
+  <ul>
+    <li>
+      <a href="https://github.com/homebridge-plugins/homebridge-wemo/wiki/Supported-Devices" target="_blank"
+        >Supported Devices</a
+      >
+    </li>
+  </ul>
+  <h4>Help/About</h4>
+  <ul>
+    <li>
+      <a href="https://github.com/homebridge-plugins/homebridge-wemo/wiki/Common-Errors" target="_blank"
+        >Common Errors</a
+      >
+    </li>
+    <li>
+      <a href="https://github.com/homebridge-plugins/homebridge-wemo/issues/new/choose" target="_blank"
+        >Support Request</a
+      >
+    </li>
+    <li>
+      <a href="https://github.com/homebridge-plugins/homebridge-wemo/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 creator of this plugin:
+      <a href="https://github.com/rudders" target="_blank">@rudders</a>, and to
+      <a href="https://github.com/devbobo" target="_blank">@devbobo</a> for his contributions.
+    </li>
+    <li>
+      To the creator of
+      <a href="https://github.com/timonreinhard/wemo-client" target="_blank">wemo-client</a> (which
+      is now contained within this plugin):
+      <a href="https://github.com/timonreinhard" target="_blank">@timonreinhard</a>.
+    </li>
+    <li>
+      To <a href="http://www.hardill.me.uk/wordpress/tag/wemo/" target="_blank">Ben Hardill</a> for
+      his research on Wemo devices.
+    </li>
+    <li>To all users who have helped/tested to enable functionality for new devices.</li>
+    <li>
+      To the creators/contributors of
+      <a href="https://github.com/simont77/fakegato-history" target="_blank">Fakegato</a>:
+      <a href="https://github.com/simont77" target="_blank">@simont77</a> and
+      <a href="https://github.com/NorthernMan54" target="_blank">@NorthernMan54</a>.
+    </li>
+    <li>
+      To the creator of the awesome plugin header logo:
+      <a href="https://www.instagram.com/keryan.me" target="_blank">Keryan Belahcene</a>.
+    </li>
+    <li>
+      To the creators/contributors of
+      <a href="https://homebridge.io" target="_blank">Homebridge</a> who make this plugin possible.
+    </li>
+  </ul>
+  <h4>Disclaimer</h4>
+  <ul>
+    <li>
+      I am in no way affiliated with Belkin/Wemo 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 = () => {
+        const introContinue = document.getElementById('introContinue')
+        introContinue.addEventListener('click', () => {
+          homebridge.showSpinner()
+          homebridge.disableSaveButton?.()
+          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.serialNumber
+          deviceSelect.add(option)
+        })
+        showDeviceInfo = async serialNumber => {
+          homebridge.showSpinner()
+          const thisAcc = cachedAccessories.find(x => x.context.serialNumber === serialNumber)
+          const context = thisAcc.context
+          document.getElementById('displayName').innerHTML = thisAcc.displayName
+          document.getElementById('http_status').innerHTML = context.httpOnline
+            ? '<i class="fas fa-circle mr-1 green-text"></i> Yes'
+            : '<i class="fas fa-circle mr-1 red-text"></i> No'
+          document.getElementById('upnp_status').innerHTML = context.upnpOnline
+            ? '<i class="fas fa-circle mr-1 green-text"></i> Yes'
+            : '<i class="fas fa-circle mr-1 red-text"></i> No'
+          document.getElementById('ipAddress').innerHTML = context.ipAddress || 'N/A'
+          document.getElementById('port').innerHTML = context.port || 'N/A'
+          document.getElementById('upnpInfo').innerHTML =
+            context.ipAddress && context.port
+              ? '<a href="http://' +
+                context.ipAddress +
+                ':' +
+                context.port +
+                '/setup.xml" target="_blank" class="primary-text">Visit XML &rarr;</a>'
+              : 'N/A'
+          document.getElementById('serialNumber').innerHTML = context.serialNumber || 'N/A'
+          document.getElementById('macAddress').innerHTML = context.macAddress || 'N/A'
+          document.getElementById('firmware').innerHTML = context.firmware || 'N/A'
+          document.getElementById('imgIcon').innerHTML =
+            context.icon && context.ipAddress && context.port
+              ? '<img src="http://' +
+                context.ipAddress +
+                ':' +
+                context.port +
+                '/' +
+                context.icon +
+                '" style="width: 150px;">'
+              : ''
+          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.serialNumber)
+        } 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()
+      }
+      menuHome.addEventListener('click', () => showSupport())
+      menuDevices.addEventListener('click', () => showDevices())
+      menuSettings.addEventListener('click', () => showSettings())
+      if (currentConfig.length) {
+        document.getElementById('menuWrapper').style.display = 'inline-flex'
+        showSettings()
+      } else {
+        currentConfig.push({ name: 'Wemo' })
+        await homebridge.updatePluginConfig(currentConfig)
+        showIntro()
+      }
+    } catch (err) {
+      homebridge.toast.error(err.message, 'Error')
+    } finally {
+      homebridge.hideSpinner()
+    }
+  })()
+</script>

package/lib/homebridge-ui/server.js

@@ -0,0 +1,10 @@
+import { HomebridgePluginUiServer } from '@homebridge/plugin-ui-utils'
+
+class PluginUiServer extends HomebridgePluginUiServer {
+  constructor() {
+    super()
+    this.ready()
+  }
+}
+
+(() => new PluginUiServer())()

package/lib/index.js

@@ -0,0 +1,8 @@
+import { createRequire } from 'node:module'
+
+import wemoPlatform from './platform.js'
+
+const require = createRequire(import.meta.url)
+const plugin = require('../package.json')
+
+export default hb => hb.registerPlatform(plugin.alias, wemoPlatform)