@homebridge-plugins/homebridge-wemo 7.0.0

package/lib/utils/colour.js

@@ -0,0 +1,135 @@
+function hs2rgb(h, s) {
+  /*
+    Credit:
+    https://github.com/WickyNilliams/pure-color
+  */
+  h = Number.parseInt(h, 10) / 60
+  s = Number.parseInt(s, 10) / 100
+  const f = h - Math.floor(h)
+  const p = 255 * (1 - s)
+  const q = 255 * (1 - s * f)
+  const t = 255 * (1 - s * (1 - f))
+  let rgb
+  switch (Math.floor(h) % 6) {
+    case 0:
+      rgb = [255, t, p]
+      break
+    case 1:
+      rgb = [q, 255, p]
+      break
+    case 2:
+      rgb = [p, 255, t]
+      break
+    case 3:
+      rgb = [p, q, 255]
+      break
+    case 4:
+      rgb = [t, p, 255]
+      break
+    case 5:
+      rgb = [255, p, q]
+      break
+    default:
+      return []
+  }
+  if (rgb[0] === 255 && rgb[1] <= 25 && rgb[2] <= 25) {
+    rgb[1] = 0
+    rgb[2] = 0
+  }
+  return [Math.round(rgb[0]), Math.round(rgb[1]), Math.round(rgb[2])]
+}
+
+function rgb2hs(r, g, b) {
+  /*
+    Credit:
+    https://github.com/WickyNilliams/pure-color
+  */
+  r = Number.parseInt(r, 10)
+  g = Number.parseInt(g, 10)
+  b = Number.parseInt(b, 10)
+  const min = Math.min(r, g, b)
+  const max = Math.max(r, g, b)
+  const delta = max - min
+  let h
+  let s
+  if (max === 0) {
+    s = 0
+  } else {
+    s = (delta / max) * 100
+  }
+  if (max === min) {
+    h = 0
+  } else if (r === max) {
+    h = (g - b) / delta
+  } else if (g === max) {
+    h = 2 + (b - r) / delta
+  } else if (b === max) {
+    h = 4 + (r - g) / delta
+  }
+  h = Math.min(h * 60, 360)
+
+  if (h < 0) {
+    h += 360
+  }
+  return [Math.round(h), Math.round(s)]
+}
+
+function rgb2xy(r, g, b) {
+  const redC = r / 255
+  const greenC = g / 255
+  const blueC = b / 255
+  const redN = redC > 0.04045 ? ((redC + 0.055) / (1.0 + 0.055)) ** 2.4 : redC / 12.92
+  const greenN = greenC > 0.04045 ? ((greenC + 0.055) / (1.0 + 0.055)) ** 2.4 : greenC / 12.92
+  const blueN = blueC > 0.04045 ? ((blueC + 0.055) / (1.0 + 0.055)) ** 2.4 : blueC / 12.92
+  const X = redN * 0.664511 + greenN * 0.154324 + blueN * 0.162028
+  const Y = redN * 0.283881 + greenN * 0.668433 + blueN * 0.047685
+  const Z = redN * 0.000088 + greenN * 0.07231 + blueN * 0.986039
+  const x = X / (X + Y + Z)
+  const y = Y / (X + Y + Z)
+  return [x, y]
+}
+
+function xy2rgb(x, y) {
+  const z = 1 - x - y
+  const X = x / y
+  const Z = z / y
+  let red = X * 1.656492 - 1 * 0.354851 - Z * 0.255038
+  let green = -X * 0.707196 + 1 * 1.655397 + Z * 0.036152
+  let blue = X * 0.051713 - 1 * 0.121364 + Z * 1.01153
+  if (red > blue && red > green && red > 1) {
+    green /= red
+    blue /= red
+    red = 1
+  } else if (green > blue && green > red && green > 1) {
+    red /= green
+    blue /= green
+    green = 1
+  } else if (blue > red && blue > green && blue > 1.0) {
+    red /= blue
+    green /= blue
+    blue = 1.0
+  }
+  red = red <= 0.0031308 ? 12.92 * red : (1.0 + 0.055) * red ** (1.0 / 2.4) - 0.055
+  green = green <= 0.0031308 ? 12.92 * green : (1.0 + 0.055) * green ** (1.0 / 2.4) - 0.055
+  blue = blue <= 0.0031308 ? 12.92 * blue : (1.0 + 0.055) * blue ** (1.0 / 2.4) - 0.055
+  red = Math.abs(Math.round(red * 255))
+  green = Math.abs(Math.round(green * 255))
+  blue = Math.abs(Math.round(blue * 255))
+  if (Number.isNaN(red)) {
+    red = 0
+  }
+  if (Number.isNaN(green)) {
+    green = 0
+  }
+  if (Number.isNaN(blue)) {
+    blue = 0
+  }
+  return [red, green, blue]
+}
+
+export {
+  hs2rgb,
+  rgb2hs,
+  rgb2xy,
+  xy2rgb,
+}

package/lib/utils/constants.js

@@ -0,0 +1,129 @@
+export default {
+  defaultConfig: {
+    name: 'Wemo',
+    mode: 'auto',
+    hideConnectionErrors: false,
+    disablePlugin: false,
+    discoveryInterval: 30,
+    pollingInterval: 30,
+    upnpInterval: 300,
+    disableUPNP: false,
+    disableDeviceLogging: false,
+    removeByName: '',
+    wemoClient: {
+      callback_url: '',
+      listen_interface: '',
+      port: 0,
+      discover_opts: {
+        interfaces: '',
+        explicitSocketBind: true,
+      },
+    },
+    makerTypes: [],
+    wemoInsights: [],
+    wemoLights: [],
+    wemoLinks: [],
+    wemoMotions: [],
+    wemoOthers: [],
+    wemoOutlets: [],
+    platform: 'Wemo',
+  },
+
+  defaultValues: {
+    adaptiveLightingShift: 0,
+    brightnessStep: 1,
+    discoveryInterval: 30,
+    makerTimer: 20,
+    noMotionTimer: 60,
+    pollingInterval: 30,
+    port: 0,
+    showAs: 'default',
+    timeDiff: 1,
+    transitionTime: 0,
+    upnpInterval: 300,
+    wattDiff: 1,
+  },
+
+  minValues: {
+    adaptiveLightingShift: -1,
+    discoveryInterval: 15,
+    brightnessStep: 1,
+    makerTimer: 1,
+    noMotionTimer: 0,
+    pollingInterval: 15,
+    port: 0,
+    timeDiff: 1,
+    transitionTime: 0,
+    upnpInterval: 60,
+    wattDiff: 1,
+  },
+
+  allowed: {
+    mode: ['auto', 'semi', 'manual'],
+    makerTypes: [
+      'label',
+      'serialNumber',
+      'ignoreDevice',
+      'makerType',
+      'makerTimer',
+      'reversePolarity',
+      'manualIP',
+      'listenerType',
+    ],
+    wemoInsights: [
+      'label',
+      'serialNumber',
+      'ignoreDevice',
+      'showTodayTC',
+      'wattDiff',
+      'timeDiff',
+      'showAs',
+      'outletInUseTrue',
+      'manualIP',
+      'listenerType',
+    ],
+    wemoLights: [
+      'label',
+      'serialNumber',
+      'ignoreDevice',
+      'enableColourControl',
+      'adaptiveLightingShift',
+      'brightnessStep',
+      'transitionTime',
+      'manualIP',
+      'listenerType',
+    ],
+    wemoLinks: ['label', 'serialNumber', 'ignoreDevice', 'manualIP', 'listenerType'],
+    wemoMotions: [
+      'label',
+      'serialNumber',
+      'ignoreDevice',
+      'noMotionTimer',
+      'manualIP',
+    ],
+    wemoOthers: [
+      'label',
+      'serialNumber',
+      'ignoreDevice',
+      'manualIP',
+      'listenerType',
+    ],
+    wemoOutlets: [
+      'label',
+      'serialNumber',
+      'ignoreDevice',
+      'showAs',
+      'manualIP',
+      'listenerType',
+    ],
+    listenerType: ['default', 'http'],
+    showAs: ['default', 'switch', 'purifier'],
+  },
+
+  portsToScan: [49153, 49152, 49154, 49155, 49151, 49156, 49157, 49158, 49159],
+  servicesToSubscribe: [
+    'urn:Belkin:service:basicevent:1',
+    'urn:Belkin:service:insight:1',
+    'urn:Belkin:service:bridge:1',
+  ],
+}

package/lib/utils/eve-chars.js

@@ -0,0 +1,130 @@
+import { inherits } from 'node:util'
+
+export default class {
+  constructor(api) {
+    this.hapServ = api.hap.Service
+    this.hapChar = api.hap.Characteristic
+    this.uuids = {
+      currentConsumption: 'E863F10D-079E-48FF-8F27-9C2605A29F52',
+      totalConsumption: 'E863F10C-079E-48FF-8F27-9C2605A29F52',
+      voltage: 'E863F10A-079E-48FF-8F27-9C2605A29F52',
+      electricCurrent: 'E863F126-079E-48FF-8F27-9C2605A29F52',
+      resetTotal: 'E863F112-079E-48FF-8F27-9C2605A29F52',
+      lastActivation: 'E863F11A-079E-48FF-8F27-9C2605A29F52',
+      openDuration: 'E863F118-079E-48FF-8F27-9C2605A29F52',
+      closedDuration: 'E863F119-079E-48FF-8F27-9C2605A29F52',
+      timesOpened: 'E863F129-079E-48FF-8F27-9C2605A29F52',
+    }
+    const self = this
+    this.CurrentConsumption = function CurrentConsumption() {
+      self.hapChar.call(this, 'Current Consumption', self.uuids.currentConsumption)
+      this.setProps({
+        format: api.hap.Formats.UINT16,
+        unit: 'W',
+        maxValue: 100000,
+        minValue: 0,
+        minStep: 1,
+        perms: [api.hap.Perms.PAIRED_READ, api.hap.Perms.NOTIFY],
+      })
+      this.value = this.getDefaultValue()
+    }
+    this.TotalConsumption = function TotalConsumption() {
+      self.hapChar.call(this, 'Total Consumption', self.uuids.totalConsumption)
+      this.setProps({
+        format: api.hap.Formats.FLOAT,
+        unit: 'kWh',
+        maxValue: 100000000000,
+        minValue: 0,
+        minStep: 0.01,
+        perms: [api.hap.Perms.PAIRED_READ, api.hap.Perms.NOTIFY],
+      })
+      this.value = this.getDefaultValue()
+    }
+    this.Voltage = function Voltage() {
+      self.hapChar.call(this, 'Voltage', self.uuids.voltage)
+      this.setProps({
+        format: api.hap.Formats.FLOAT,
+        unit: 'V',
+        maxValue: 100000000000,
+        minValue: 0,
+        minStep: 1,
+        perms: [api.hap.Perms.PAIRED_READ, api.hap.Perms.NOTIFY],
+      })
+      this.value = this.getDefaultValue()
+    }
+    this.ElectricCurrent = function ElectricCurrent() {
+      self.hapChar.call(this, 'Electric Current', self.uuids.electricCurrent)
+      this.setProps({
+        format: api.hap.Formats.FLOAT,
+        unit: 'A',
+        maxValue: 100000000000,
+        minValue: 0,
+        minStep: 0.1,
+        perms: [api.hap.Perms.PAIRED_READ, api.hap.Perms.NOTIFY],
+      })
+      this.value = this.getDefaultValue()
+    }
+    this.ResetTotal = function ResetTotal() {
+      self.hapChar.call(this, 'Reset Total', self.uuids.resetTotal)
+      this.setProps({
+        format: api.hap.Formats.UINT32,
+        unit: api.hap.Units.seconds,
+        perms: [api.hap.Perms.PAIRED_READ, api.hap.Perms.NOTIFY, api.hap.Perms.PAIRED_WRITE],
+      })
+      this.value = this.getDefaultValue()
+    }
+    this.LastActivation = function LastActivation() {
+      self.hapChar.call(this, 'Last Activation', self.uuids.lastActivation)
+      this.setProps({
+        format: api.hap.Formats.UINT32,
+        unit: api.hap.Units.SECONDS,
+        perms: [api.hap.Perms.PAIRED_READ, api.hap.Perms.NOTIFY],
+      })
+      this.value = this.getDefaultValue()
+    }
+    this.OpenDuration = function OpenDuration() {
+      self.hapChar.call(this, 'Open Duration', self.uuids.openDuration)
+      this.setProps({
+        format: api.hap.Formats.UINT32,
+        unit: api.hap.Units.SECONDS,
+        perms: [api.hap.Perms.PAIRED_READ, api.hap.Perms.NOTIFY, api.hap.Perms.PAIRED_WRITE],
+      })
+      this.value = this.getDefaultValue()
+    }
+    this.ClosedDuration = function ClosedDuration() {
+      self.hapChar.call(this, 'Closed Duration', self.uuids.closedDuration)
+      this.setProps({
+        format: api.hap.Formats.UINT32,
+        unit: api.hap.Units.SECONDS,
+        perms: [api.hap.Perms.PAIRED_READ, api.hap.Perms.NOTIFY, api.hap.Perms.PAIRED_WRITE],
+      })
+      this.value = this.getDefaultValue()
+    }
+    this.TimesOpened = function TimesOpened() {
+      self.hapChar.call(this, 'Times Opened', self.uuids.timesOpened)
+      this.setProps({
+        format: api.hap.Formats.UINT32,
+        perms: [api.hap.Perms.PAIRED_READ, api.hap.Perms.NOTIFY],
+      })
+      this.value = this.getDefaultValue()
+    }
+    inherits(this.CurrentConsumption, this.hapChar)
+    inherits(this.TotalConsumption, this.hapChar)
+    inherits(this.Voltage, this.hapChar)
+    inherits(this.ElectricCurrent, this.hapChar)
+    inherits(this.LastActivation, this.hapChar)
+    inherits(this.ResetTotal, this.hapChar)
+    inherits(this.OpenDuration, this.hapChar)
+    inherits(this.ClosedDuration, this.hapChar)
+    inherits(this.TimesOpened, this.hapChar)
+    this.CurrentConsumption.UUID = this.uuids.currentConsumption
+    this.TotalConsumption.UUID = this.uuids.totalConsumption
+    this.Voltage.UUID = this.uuids.voltage
+    this.ElectricCurrent.UUID = this.uuids.electricCurrent
+    this.LastActivation.UUID = this.uuids.lastActivation
+    this.ResetTotal.UUID = this.uuids.resetTotal
+    this.OpenDuration.UUID = this.uuids.openDuration
+    this.ClosedDuration.UUID = this.uuids.closedDuration
+    this.TimesOpened.UUID = this.uuids.timesOpened
+  }
+}

package/lib/utils/functions.js

@@ -0,0 +1,52 @@
+function decodeXML(input) {
+  return input
+    .replace(/&lt;/g, '<')
+    .replace(/&gt;/g, '>')
+    .replace(/&quot;/g, '"')
+    .replace(/&#039;/g, '\'')
+    .replace(/&amp;/g, '&')
+}
+
+function generateRandomString(length) {
+  const chars = 'abcdefghijklmnopqrstuvwxyz0123456789'
+  let nonce = ''
+  while (nonce.length < length) {
+    nonce += chars.charAt(Math.floor(Math.random() * chars.length))
+  }
+  return nonce
+}
+
+const hasProperty = (obj, prop) => Object.prototype.hasOwnProperty.call(obj, prop)
+
+function parseError(err, hideStack = []) {
+  let toReturn = err.message
+  if (err?.stack?.length > 0 && !hideStack.includes(err.message)) {
+    const stack = err.stack.split('\n')
+    if (stack[1]) {
+      toReturn += stack[1].replace('   ', '')
+    }
+  }
+  return toReturn
+}
+
+function parseSerialNumber(input) {
+  return input
+    .toString()
+    .replace(/[\s'"]+/g, '')
+    .toUpperCase()
+}
+
+function sleep(ms) {
+  return new Promise((resolve) => {
+    setTimeout(resolve, ms)
+  })
+}
+
+export {
+  decodeXML,
+  generateRandomString,
+  hasProperty,
+  parseError,
+  parseSerialNumber,
+  sleep,
+}

package/lib/utils/lang-en.js

@@ -0,0 +1,125 @@
+export default {
+  accNotFound: 'accessory not found',
+  accNotReady: 'has not been discovered yet so commands will fail',
+  alDisabled: 'adaptive lighting disabled due to significant colour change',
+  awaiting: 'The following devices have still not been initially found',
+  beta: 'You are using a beta version of the plugin - you will experience more logging than normal',
+  brand: 'Belkin Wemo',
+  brightnessFail: 'could not obtain updated brightness as',
+  cantCtl: 'sending update failed as',
+  cantUpd: 'receiving update failed as',
+  cfgDef: 'is not a valid number so using default of',
+  cfgDup: 'will be ignored since another entry with this ID already exists',
+  cfgIgn: 'is not configured correctly so ignoring',
+  cfgIgnItem: 'has an invalid entry which will be ignored',
+  cfgItem: 'Config entry',
+  cfgLow: 'is set too low so increasing to',
+  cfgRmv: 'is unused and can be removed',
+  cfgQts: 'should not have quotes around its entry',
+  complete: '✓ Setup complete',
+  connError: 'connection error',
+  curAir: 'current air quality',
+  curBright: 'current brightness',
+  curCCT: 'current cct',
+  curColour: 'current colour',
+  curCons: 'current consumption',
+  curCont: 'current contact',
+  curFilter: 'current filter level',
+  curHumi: 'current humidity',
+  curIon: 'current ionizer',
+  curOIU: 'current outlet-in-use',
+  curMode: 'current mode',
+  curState: 'current state',
+  curTemp: 'current temperature',
+  curTimer: 'current timer',
+  detectedNo: 'not detected',
+  detectedYes: 'detected',
+  devAdd: 'has been added to Homebridge',
+  devInitOpts: 'initialising with options',
+  devNotAdd: 'could not be added to Homebridge as',
+  devNotConf: 'could not be configured as',
+  devNotInit: 'could not be initialised as',
+  devNotRemove: 'could not be removed from Homebridge as',
+  devOffline: 'appears to be offline',
+  devRemove: 'has been removed from Homebridge',
+  disabling: 'Disabling plugin',
+  hbVersionFail: 'Your version of Homebridge is too low - please update to v1.6',
+  identify: 'identify button pressed',
+  incFail: 'failed to process incoming message as',
+  incKnown: 'incoming notification',
+  incUnknown: 'incoming notification from unknown accessory',
+  initSer: 'initialised with s/n',
+  initMac: 'and ip/port',
+  initialised: 'Plugin initialised. Setting up accessories...',
+  initialising: 'Initialising plugin',
+  insCons: 'consumption',
+  insOnTime: 'today ontime',
+  insTC: 'total consumption',
+  httpFail: 'http error (will be re-attempted)',
+  httpGood: 'http has been established',
+  labelAuto: 'auto',
+  labelClosed: 'closed',
+  labelClosing: 'closing',
+  labelEco: 'eco',
+  labelExc: 'excellent',
+  labelFair: 'fair',
+  labelFP: 'frost-protect',
+  labelHigh: 'high',
+  labelLow: 'low',
+  labelMax: 'max',
+  labelMed: 'med',
+  labelMin: 'min',
+  labelPoor: 'poor',
+  labelOff: 'off',
+  labelOpen: 'open',
+  labelOpening: 'opening',
+  labelStopped: 'stopped',
+  labelWarm: 'warm',
+  listenerClosed: 'Listener server gracefully closed',
+  listenerError: 'Listener server error',
+  listenerPort: 'Listener server port',
+  makerClosed: 'is already closed so ignoring command',
+  makerClosing: 'is already closing so ignoring command',
+  makerNeedMMode: 'must be set to momentary mode to work as a garage door',
+  makerOpen: 'is already open so ignoring command',
+  makerOpening: 'is already opening so ignoring command',
+  makerTrigExt: 'triggered externally',
+  modelLED: 'LED Bulb (Via Link)',
+  motionNo: 'clear',
+  motionSensor: 'motion sensor',
+  motionYes: 'motion detected',
+  noInterface: 'Unable to find interface',
+  noPort: 'could not find correct port for device',
+  noService: 'device does not have this service',
+  noServices: 'device does not have any upnp services',
+  noSockets: 'NodeSSDP error [no sockets], if this continues to happen try restarting Homebridge',
+  notConfigured: 'Plugin has not been configured',
+  proEr: 'could not be processed as',
+  purifyNo: 'not purifying',
+  purifyYes: 'purifying',
+  rduErr: 'http polling failed as',
+  recUpd: 'receiving update',
+  repError: 'reported error',
+  senUpd: 'sending update',
+  ssdpFail: 'SSDP search failed as',
+  ssdpStopped: 'SSDP client gracefully stopped',
+  stoppedSubs: 'existing upnp subscriptions have been stopped',
+  subError: 'subscription error, retrying in 10 seconds',
+  subInit: 'initial subscription for service',
+  subPending: 'subscription still pending',
+  subscribeError: 'could not subscribe as',
+  tarHumi: 'target humidity',
+  tarState: 'target state',
+  tarTemp: 'target temperature',
+  timeout: 'a connection timeout occurred',
+  timeoutUnreach: 'a connection timeout occurred (EHOSTUNREACH)',
+  timerComplete: 'timer complete',
+  timerStarted: 'timer started',
+  timerStopped: 'timer stopped',
+  unsubFail: 'unsubscribe failed',
+  unsupported: 'is unsupported but feel free to create a GitHub issue',
+  upnpFail: 'upnp error (will be re-attempted)',
+  upnpGood: 'upnp has been established',
+  viaAL: 'via adaptive lighting',
+  welcome: 'This plugin has been made with ♥ by bwp91, please consider a ☆ on GitHub if you are finding it useful!',
+}

package/package.json

@@ -0,0 +1,70 @@
+{
+  "name": "@homebridge-plugins/homebridge-wemo",
+  "alias": "Wemo",
+  "type": "module",
+  "version": "7.0.0",
+  "description": "Homebridge plugin to integrate Wemo devices into HomeKit.",
+  "author": {
+    "name": "bwp91",
+    "email": "bwp91@icloud.com"
+  },
+  "license": "MIT",
+  "funding": [
+    {
+      "type": "github",
+      "url": "https://github.com/sponsors/bwp91"
+    },
+    {
+      "type": "kofi",
+      "url": "https://ko-fi.com/bwp91"
+    },
+    {
+      "type": "patreon",
+      "url": "https://www.patreon.com/bwp91"
+    },
+    {
+      "type": "paypal",
+      "url": "https://www.paypal.me/BenPotter"
+    }
+  ],
+  "homepage": "https://github.com/homebridge-plugins/homebridge-wemo",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/homebridge-plugins/homebridge-wemo.git"
+  },
+  "bugs": {
+    "url": "https://github.com/homebridge-plugins/homebridge-wemo/issues"
+  },
+  "keywords": [
+    "homebridge",
+    "homebridge-plugin",
+    "hoobs",
+    "hoobs-plugin",
+    "homekit",
+    "siri",
+    "wemo",
+    "belkin"
+  ],
+  "main": "lib/index.js",
+  "engines": {
+    "homebridge": "^1.6.0 || ^2.0.0-beta.0",
+    "node": "^18.20.7 || ^20.19.0 || ^22.14.0"
+  },
+  "scripts": {
+    "lint": "eslint . --fix",
+    "rebuild": "rm -rf package-lock.json && rm -rf node_modules && npm install"
+  },
+  "dependencies": {
+    "@homebridge/plugin-ui-utils": "^2.0.1",
+    "axios": "^1.8.4",
+    "ip": "^2.0.1",
+    "node-ssdp": "^4.0.1",
+    "p-queue": "^8.1.0",
+    "xml2js": "^0.6.2",
+    "xmlbuilder": "^15.1.1"
+  },
+  "devDependencies": {
+    "@antfu/eslint-config": "^4.10.2",
+    "eslint": "^9.23.0"
+  }
+}