@homebridge-plugins/homebridge-ewelink 12.3.3

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,365 @@
+<p class="text-center">
+  <img
+    src="https://user-images.githubusercontent.com/43026681/101325266-63126600-3863-11eb-9382-4a2924f0e540.png"
+    alt="homebridge-ewelink logo"
+    style="width: 60%;"
+  />
+</p>
+<div id="pageIntro" class="text-center" style="display: none;">
+  <p class="lead">Thank you for installing <strong>homebridge-ewelink</strong></p>
+  <p>
+    You will need to enter your eWeLink username and password 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="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" 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">Cloud Status</th>
+          <td id="reachableWAN"></td>
+        </tr>
+        <tr>
+          <th scope="row">LAN Status</th>
+          <td id="reachableLAN"></td>
+        </tr>
+        <tr>
+          <th scope="row">LAN IP</th>
+          <td id="lanIP"></td>
+        </tr>
+        <tr>
+          <th scope="row">Homebridge ID</th>
+          <td id="hbDeviceId"></td>
+        </tr>
+        <tr>
+          <th scope="row">eWeLink ID</th>
+          <td id="eweDeviceId"></td>
+        </tr>
+        <tr>
+          <th scope="row">Brand</th>
+          <td id="eweBrandName"></td>
+        </tr>
+        <tr>
+          <th scope="row">Model (UIID)</th>
+          <td id="eweModel"></td>
+        </tr>
+        <tr>
+          <th scope="row">Firmware</th>
+          <td id="eweFirmware"></td>
+        </tr>
+        <tr>
+          <th scope="row">MAC Address</th>
+          <td id="eweMacAddress"></td>
+        </tr>
+        <tr>
+          <th scope="row">Shared Device</th>
+          <td id="eweShared"></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-ewelink</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-ewelink/wiki/Installation" target="_blank"
+        >Installation</a
+      >
+    </li>
+    <li>
+      <a href="https://github.com/homebridge-plugins/homebridge-ewelink/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-ewelink/wiki/Node-Version" target="_blank"
+        >Node Version</a
+      >
+    </li>
+  </ul>
+  <h4>Features</h4>
+  <ul>
+    <li>
+      <a href="https://github.com/homebridge-plugins/homebridge-ewelink/wiki/Supported-Devices" target="_blank"
+        >Supported Devices</a
+      >
+    </li>
+    <li>
+      <a
+        href="https://github.com/homebridge-plugins/homebridge-ewelink/wiki/Accessory-Simulations"
+        target="_blank"
+        >Accessory Simulations</a
+      >
+    </li>
+    <li>
+      <a href="https://github.com/homebridge-plugins/homebridge-ewelink/wiki/Connection-Methods" target="_blank"
+        >Connection Methods</a
+      >
+    </li>
+    <li>
+      <a href="https://github.com/homebridge-plugins/homebridge-ewelink/wiki/Internal-API" target="_blank"
+        >Internal API</a
+      >
+    </li>
+  </ul>
+  <h4>Help/About</h4>
+  <ul>
+    <li>
+      <a href="https://github.com/homebridge-plugins/homebridge-ewelink/wiki/Common-Errors" target="_blank"
+        >Common Errors</a
+      >
+    </li>
+    <li>
+      <a href="https://github.com/homebridge-plugins/homebridge-ewelink/issues/new/choose" target="_blank"
+        >Support Request</a
+      >
+    </li>
+    <li>
+      <a href="https://github.com/homebridge-plugins/homebridge-ewelink/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 original plugin maintainer:
+      <a href="https://github.com/gbro115" target="_blank">@gbro115</a>.
+    </li>
+    <li>
+      To successive contributors:
+      <a href="https://github.com/MrTomAsh" target="_blank">@MrTomAsh</a> and
+      <a href="https://github.com/howanghk" target="_blank">@howanghk</a> for
+      <a href="https://github.com/howanghk/homebridge-ewelink" target="_blank"
+        >homebridge-ewelink-max</a
+      >.
+    </li>
+    <li>
+      To the creators/contributors of
+      <a href="https://homebridge.io" target="_blank">Homebridge</a> who make this plugin possible.
+    </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 all users who have shared their devices to enable functionality.</li>
+  </ul>
+
+  <h4>Disclaimer</h4>
+  <ul>
+    <li>
+      I am in no way affiliated with eWeLink nor any of the device brands (like Sonoff) 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()
+          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.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('displayName').innerHTML = thisAcc.displayName
+          document.getElementById('reachableWAN').innerHTML = context.reachableWAN
+            ? '<i class="fas fa-circle mr-1 green-text"></i> Online'
+            : '<i class="fas fa-circle mr-1 red-text"></i> Offline'
+          document.getElementById('reachableLAN').innerHTML = context.reachableLAN
+            ? '<i class="fas fa-circle mr-1 green-text"></i> Online'
+            : '<i class="fas fa-circle mr-1 red-text"></i> Offline'
+          document.getElementById('lanIP').innerHTML = context.ip || 'N/A'
+          document.getElementById('hbDeviceId').innerHTML = context.hbDeviceId || 'N/A'
+          document.getElementById('eweDeviceId').innerHTML = context.eweDeviceId || 'N/A'
+          document.getElementById('eweBrandName').innerHTML = context.eweBrandName || 'N/A'
+          document.getElementById('eweFirmware').innerHTML = context.firmware || 'N/A'
+          document.getElementById('eweMacAddress').innerHTML = context.macAddress || 'N/A'
+          document.getElementById('eweModel').innerHTML =
+            (context.eweModel || 'N/A') + ' (' + (context.eweUIID || 'N/A') + ')'
+          document.getElementById('eweShared').innerHTML = context.eweShared
+            ? 'Yes (by ' + context.eweShared + ')'
+            : 'No'
+          document.getElementById('imgIcon').innerHTML = context.eweBrandLogo
+            ? '<img src="' + context.eweBrandLogo + '" 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.hbDeviceId)
+        } else {
+          const option = document.createElement('option')
+          option.text = 'No Devices'
+          deviceSelect.add(option)
+          deviceSelect.disabled = true
+        }
+        homebridge.hideSpinner()
+      }
+      showSupport = () => {
+        homebridge.showSpinner()
+        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()
+        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: 'eWeLink' })
+        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,46 @@
+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-ewelink'
+        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/lib/index.js

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