@homebridge-plugins/homebridge-govee 10.12.1

package/lib/connection/lan.js

@@ -0,0 +1,284 @@
+import dgram from 'node:dgram'
+
+import { parseError } from '../utils/functions.js'
+import platformLang from '../utils/lang-en.js'
+
+const commands = { scan: 'scan', deviceStatus: 'devStatus' }
+const multicastIp = '239.255.255.250'
+const scanCommandPort = 4001
+const receiverPort = 4002
+const devicePort = 4003
+const getDevicesScanTimeoutMs = 2000
+
+/*
+This class handles LAN discovery and communication with Govee devices.
+
+The documentation can be fount at https://app-h5.govee.com/user-manual/wlan-guide.
+
+The connection is UDP based and uses multicast to discover devices on the network.
+  - The discovery flow is as follows:
+                                       ┌──────┐          ┌───────────┐
+                                       │Client│          │GoveeDevice│
+                                       └──┬───┘          └─────┬─────┘
+                                          │    Request Scan    │
+                                          │ ──────────────────>│
+                                          │                    │ ╔═══════════════════════════════════════╗
+                                          │                    │ ║Group address of 239.255.255.250:4001 ░║
+                                          │                    │ ╚═══════════════════════════════════════╝
+                                          │   Response Scan    │
+                                          │ <─ ─ ─ ─ ─ ─ ─ ─ ─ │
+                                          │                    │
+    ╔════════════════════════════════════╗│                    │
+    ║Response will be sent to port 4002 ░║│                    │
+    ╚════════════════════════════════════╝┴───┐          ┌─────┴─────┐
+                                       │Client│          │GoveeDevice│
+                                       └──────┘          └───────────┘
+
+    1. On devices that have `LAN control` turned on, the device will join the multicast address `239.255.255.250` and listen for information sent to port `4001` of the multicast.
+    2. The client (sender) will send a scan request to that group address, on port 4001.
+    3. Each Govee device will send to the server (receiver) on port `4002` a send response scan message.
+
+    After the discovery process, we keep track of the devices found and keep polling for new devices every 5 seconds.
+
+  - The communication flow is as follows:
+                                       ┌──────┐                                     ┌───────────┐
+                                       │Client│                                     │GoveeDevice│
+                                       └──┬───┘                                     └─────┬─────┘
+                                          │                Control Command                │
+                                          │ ──────────────────────────────────────────────>
+                                          │                                               │
+                                          │                                               │  ╔════════════════════════╗
+                                          │                                               │  ║Device IP on port 4003 ░║
+                                          │                                               │  ╚════════════════════════╝
+                                          │ Device Status (only for Device Status Command)│
+                                          │ <─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─│
+                                          │                                               │
+    ╔════════════════════════════════════╗│                                               │
+    ║Response will be sent to port 4002 ░║│                                               │
+    ╚════════════════════════════════════╝┴───┐                                     ┌─────┴─────┐
+                                       │Client│                                     │GoveeDevice│
+                                       └──────┘                                     └───────────┘
+   1. Once the IP of the device is known, we will send a control command to the device on port `4003`.
+   2. The device will respond with the device status only if Device Status Command is sent on port `4002`.
+*/
+export default class {
+  constructor(platform) {
+    this.log = platform.log
+    this.config = platform.config
+
+    // Keeps track of all devices that are found on the network
+    this.lanDevices = []
+
+    // Add any devices that have a custom IP address in the config
+    Object.keys(platform.deviceConf).forEach((device) => {
+      if (platform.deviceConf[device].customIPAddress) {
+        this.lanDevices.push({
+          ip: platform.deviceConf[device].customIPAddress,
+          device,
+          isPendingDiscovery: true,
+          isManual: true,
+        })
+      }
+    })
+
+    // Create a UDP socket to listen for messages sent by Govee devices in a multicast group
+    this.receiver = dgram.createSocket('udp4')
+
+    // Create a UDP socket to send messages to Govee devices from host
+    this.sender = dgram.createSocket('udp4')
+
+    this.latestDeviceScanTimestamp = Date.now()
+
+    this.connectionPromise = new Promise((resolve, reject) => {
+      // Handle messages received
+      this.receiver.on('message', (msg, rinfo) => {
+        const strMessage = msg.toString()
+        try {
+          const message = JSON.parse(strMessage)
+          const command = message.msg.cmd
+
+          switch (command) {
+            case commands.scan: {
+              // Handle scan responses sent by devices registered in the multicast group
+              this.latestDeviceScanTimestamp = Date.now()
+              const deviceData = message.msg.data
+
+              const existingIndex = this.lanDevices.findIndex(value => value.device === deviceData.device)
+
+              if (existingIndex === -1) {
+                this.log.debug(
+                  '[LAN] %s [isNew=true,isManual=false] [%s] [%s].',
+                  platformLang.lanFoundDevice,
+                  strMessage,
+                  JSON.stringify(rinfo),
+                )
+                this.lanDevices.push(deviceData)
+
+                platform.receiveUpdateLAN(deviceData.device, {}, deviceData.ip)
+              } else if (this.lanDevices[existingIndex].isPendingDiscovery) {
+                // This device was added in the constructor as a manual device
+                // Now we have discovered this device, replace the manual info with the received info
+                this.lanDevices[existingIndex] = {
+                  ...deviceData,
+                  isManual: true,
+                }
+                this.log.debug(
+                  '[LAN] %s [isNew=true,isManual=true] [%s] [%s].',
+                  platformLang.lanFoundDevice,
+                  strMessage,
+                  JSON.stringify(rinfo),
+                )
+                platform.receiveUpdateLAN(deviceData.device, {}, deviceData.ip)
+              } else {
+                this.log.debug(
+                  '[LAN] %s [isNew=false] [%s] [%s].',
+                  platformLang.lanFoundDevice,
+                  strMessage,
+                  JSON.stringify(rinfo),
+                )
+              }
+              break
+            }
+            case commands.deviceStatus: {
+              // Handle device status responses sent by devices
+              const deviceAddress = rinfo.address
+
+              const foundDeviceId = this.lanDevices.find(value => value.ip === deviceAddress)
+
+              if (foundDeviceId) {
+                // Send the update to the receiver function
+                platform.receiveUpdateLAN(foundDeviceId.device, message.msg.data, deviceAddress)
+              } else {
+                this.log.warn('[LAN] %s [%s].', platformLang.lanUnkDevice, deviceAddress)
+              }
+              break
+            }
+            default:
+              break
+          }
+        } catch (err) {
+          this.log('[LAN] %s [%s] [%s].', platformLang.lanParseError, strMessage, parseError(err))
+        }
+      })
+
+      // Handle errors
+      this.receiver.on('error', (err) => {
+        this.log.warn('[LAN] server error: %s.', parseError(err))
+        reject(err)
+      })
+
+      // Handle started listening for messages
+      this.receiver.on('listening', () => {
+        const { address, port } = this.receiver.address()
+        this.log.debug('[LAN] %s %s:%s.', platformLang.lanServerStarted, address, port)
+        resolve()
+      })
+
+      this.receiver.bind(receiverPort, () => {
+        this.receiver.addMembership(multicastIp, '0.0.0.0')
+      })
+
+      this.sender.bind()
+    })
+  }
+
+  // Send a request that asks for all devices in the multicast group
+  sendScanCommand() {
+    const scanCommand = JSON.stringify({ msg: { cmd: commands.scan, data: { account_topic: 'reserve' } } })
+    this.log.debug('[LAN] scanning for devices over LAN...')
+    this.sender.send(scanCommand, scanCommandPort, multicastIp)
+  }
+
+  // Get all available LAN devices
+  async getDevices() {
+    return new Promise((resolve) => {
+      this.connectionPromise.then(() => {
+        this.sendScanCommand()
+
+        // Since there is no list of devices to be gathered, we will send a scan request and wait until
+        // there are no more devices announcing themselves in the multicast group.
+        const checkPeriod = setInterval(() => {
+          const diff = Date.now() - this.latestDeviceScanTimestamp
+          if (diff >= getDevicesScanTimeoutMs) {
+            clearInterval(checkPeriod)
+            resolve(this.lanDevices)
+          }
+        }, 100)
+      }, () => {
+        resolve([])
+      })
+    })
+  }
+
+  // Send a request to a device to ask for its current state
+  async sendDeviceStateRequest(device) {
+    const stateCommand = JSON.stringify({ msg: { cmd: commands.deviceStatus, data: {} } })
+    return new Promise((resolve, reject) => {
+      this.sender.send(stateCommand, devicePort, device.ip, (err) => {
+        if (err) {
+          reject(err)
+        }
+        resolve()
+      })
+    })
+  }
+
+  // This is called by the platform on sending a device update via LAN
+  async updateDevice(accessory, params) {
+    const updatedParams = { msg: params }
+
+    accessory.logDebug(`[LAN] ${platformLang.sendingUpdate} [${JSON.stringify(updatedParams)}]`)
+
+    const foundDeviceId = this.lanDevices.findIndex(value => value.device === accessory.context.gvDeviceId)
+
+    if (foundDeviceId === -1) {
+      throw new Error(platformLang.lanDevNotFound)
+    }
+
+    const foundDevice = this.lanDevices[foundDeviceId]
+
+    return new Promise((resolve, reject) => {
+      const command = JSON.stringify(updatedParams)
+
+      this.sender.send(command, devicePort, foundDevice.ip, async (err) => {
+        if (err) {
+          // We can assume the device is offline or not available anymore, so we will remove it from the devices list
+          // We should only do this if it is not a device that the user has configured manually with an IP
+          if (!foundDevice.isManual) {
+            this.lanDevices.splice(foundDeviceId, 1)
+            accessory.logDebugWarn(`[LAN] ${platformLang.lanDevRemoved}`)
+          }
+          reject(err)
+        } else {
+          accessory.logDebug(`[LAN] ${platformLang.lanCmdSent} ${foundDevice.ip}`)
+          resolve()
+        }
+      })
+    })
+  }
+
+  startDevicesPolling() {
+    this.devicesPolling = setInterval(() => {
+      this.sendScanCommand()
+    }, this.config.lanScanInterval * 1000)
+  }
+
+  startStatusPolling() {
+    this.statusPolling = setInterval(async () => {
+      this.lanDevices.forEach(async (device) => {
+        try {
+          await this.sendDeviceStateRequest(device)
+        } catch (err) {
+          this.log.warn('[%s] [LAN] %s %s.', device.device, platformLang.lanReqError, parseError(err))
+        }
+      })
+    }, this.config.lanRefreshTime * 1000)
+  }
+
+  close() {
+    clearInterval(this.devicesPolling)
+    clearInterval(this.statusPolling)
+    this.receiver.close()
+    this.sender.close()
+  }
+}

package/lib/device/cooler-single.js

@@ -0,0 +1,300 @@
+import { generateRandomString, hasProperty, parseError } from '../utils/functions.js'
+import platformLang from '../utils/lang-en.js'
+
+export default class {
+  constructor(platform, accessory) {
+    // Set up variables from the platform
+    this.hapChar = platform.api.hap.Characteristic
+    this.hapErr = platform.api.hap.HapStatusError
+    this.hapServ = platform.api.hap.Service
+    this.platform = platform
+
+    // Set up variables from the accessory
+    this.accessory = accessory
+    this.temperatureSource = accessory.context.temperatureSource;
+
+    // Remove any old services from simulations
+    ['AirPurifier', 'Lightbulb', 'Outlet', 'Switch', 'Valve'].forEach((service) => {
+      if (this.accessory.getService(this.hapServ[service])) {
+        this.accessory.removeService(this.accessory.getService(this.hapServ[service]))
+      }
+    })
+
+    // Set up the accessory with default target temp when added the first time
+    if (!hasProperty(this.accessory.context, 'cacheTarget')) {
+      this.accessory.context.cacheTarget = 20
+    }
+
+    // Check to make sure user has not switched from cooler to heater
+    if (this.accessory.context.cacheType !== 'cooler') {
+      // Remove and re-setup as a HeaterCooler
+      if (this.accessory.getService(this.hapServ.HeaterCooler)) {
+        this.accessory.removeService(this.accessory.getService(this.hapServ.HeaterCooler))
+      }
+      this.accessory.context.cacheType = 'cooler'
+      this.accessory.context.cacheTarget = 20
+    }
+
+    // Add the heater service if it doesn't already exist
+    this.service = this.accessory.getService(this.hapServ.HeaterCooler)
+    || this.accessory.addService(this.hapServ.HeaterCooler)
+
+    // Set custom properties of the current temperature characteristic
+    this.service.getCharacteristic(this.hapChar.CurrentTemperature).setProps({
+      minStep: 0.1,
+    })
+    this.cacheTemp = this.service.getCharacteristic(this.hapChar.CurrentTemperature).value
+
+    // Add the set handler to the heater active characteristic
+    this.service
+      .getCharacteristic(this.hapChar.Active)
+      .onSet(async value => this.internalStateUpdate(value))
+
+    // Add options to the target state characteristic
+    this.service.getCharacteristic(this.hapChar.TargetHeaterCoolerState).setProps({
+      minValue: 0,
+      maxValue: 0,
+      validValues: [0],
+    })
+
+    // Add the set handler to the target temperature characteristic
+    this.service
+      .getCharacteristic(this.hapChar.CoolingThresholdTemperature)
+      .updateValue(this.accessory.context.cacheTarget)
+      .setProps({ minStep: 0.5 })
+      .onSet(async value => this.internalTargetTempUpdate(value))
+
+    // Initialise these caches now since they aren't determined by the initial externalUpdate()
+    this.cacheState = this.service.getCharacteristic(this.hapChar.Active).value === 1 ? 'on' : 'off'
+    this.cacheCool = this.cacheState === 'on'
+    && this.service.getCharacteristic(this.hapChar.CurrentHeaterCoolerState).value === 3
+      ? 'on'
+      : 'off'
+
+    // Pass the accessory to Fakegato to set up with Eve
+    this.accessory.eveService = new platform.eveService('custom', this.accessory, {
+      log: () => {},
+    })
+
+    // Set up an interval to get regular temperature updates
+    setTimeout(() => {
+      this.getTemperature()
+      this.intervalPoll = setInterval(() => this.getTemperature(), 120000)
+    }, 5000)
+
+    // Stop the intervals on Homebridge shutdown
+    platform.api.on('shutdown', () => {
+      clearInterval(this.intervalPoll)
+    })
+
+    // Output the customised options to the log
+    const opts = JSON.stringify({
+      showAs: 'cooler',
+      temperatureSource: this.temperatureSource,
+    })
+    platform.log('[%s] %s %s.', accessory.displayName, platformLang.devInitOpts, opts)
+  }
+
+  async internalStateUpdate(value) {
+    try {
+      let newState
+      let newCool
+      let newValue
+      if (value === 0) {
+        newValue = 'off'
+        newState = 'off'
+        newCool = 'off'
+      } else if (this.cacheTemp > this.accessory.context.cacheTarget) {
+        newValue = 'on'
+        newState = 'on'
+        newCool = 'on'
+      } else {
+        newValue = 'off'
+        newState = 'on'
+        newCool = 'off'
+      }
+
+      // Only send the update if either:
+      // * The new value (state) is OFF and the cacheCool was ON
+      // * The new value (state) is ON and newCool is 'on'
+      if ((value === 0 && this.cacheCool === 'on') || (value === 1 && newCool === 'on')) {
+        // Set up a one-minute timeout for the plugin to ignore incoming updates
+        const timerKey = generateRandomString(5)
+        this.updateTimeout = timerKey
+        setTimeout(() => {
+          if (this.updateTimeout === timerKey) {
+            this.updateTimeout = false
+          }
+        }, 60000)
+
+        // Send the request to the platform sender function
+        await this.platform.sendDeviceUpdate(this.accessory, {
+          cmd: 'stateOutlet',
+          value: newValue,
+        })
+      }
+
+      // Cache and log
+      if (newState !== this.cacheState) {
+        this.cacheState = newState
+        this.accessory.log(`${platformLang.curState} [${this.cacheState}]`)
+      }
+      if (newCool !== this.cacheCool) {
+        this.cacheCool = newCool
+        this.accessory.log(`${platformLang.curCool} [${this.cacheCool}]`)
+      }
+      const newOnState = this.cacheCool === 'on' ? 3 : 1
+      this.service.updateCharacteristic(
+        this.hapChar.CurrentHeaterCoolerState,
+        value === 1 ? newOnState : 0,
+      )
+    } catch (err) {
+      // Catch any errors during the process
+      this.accessory.logWarn(`${platformLang.devNotUpdated} ${parseError(err)}`)
+
+      // Throw a 'no response' error and set a timeout to revert this after 2 seconds
+      setTimeout(() => {
+        this.service.updateCharacteristic(this.hapChar.Active, this.cacheState === 'on' ? 1 : 0)
+      }, 2000)
+      throw new this.hapErr(-70402)
+    }
+  }
+
+  async internalTargetTempUpdate(value) {
+    try {
+      // Don't continue if the new value is the same as before
+      if (value === this.accessory.context.cacheTarget) {
+        return
+      }
+      this.accessory.context.cacheTarget = value
+      this.accessory.log(`${platformLang.curTarg} [${value}°C]`)
+      if (this.cacheState === 'off') {
+        return
+      }
+
+      // Check to see if we need to turn on or off
+      let newValue
+      let newCool
+      if (this.cacheTemp > value) {
+        newValue = 'on'
+        newCool = 'on'
+      } else {
+        newValue = 'off'
+        newCool = 'off'
+      }
+
+      // Don't continue if no change needed to device state
+      if (newCool === this.cacheCool) {
+        return
+      }
+
+      // Set up a one-minute timeout for the plugin to ignore incoming updates
+      const timerKey = generateRandomString(5)
+      this.updateTimeout = timerKey
+      setTimeout(() => {
+        if (this.updateTimeout === timerKey) {
+          this.updateTimeout = false
+        }
+      }, 60000)
+
+      // Send the request to the platform sender function
+      await this.platform.sendDeviceUpdate(this.accessory, {
+        cmd: 'stateOutlet',
+        value: newValue,
+      })
+
+      // Cache and log
+      this.cacheCool = newCool
+      this.accessory.log(`${platformLang.curCool} [${this.cacheCool}]`)
+      this.service.updateCharacteristic(
+        this.hapChar.CurrentHeaterCoolerState,
+        this.cacheCool === 'on' ? 3 : 1,
+      )
+    } catch (err) {
+      // Catch any errors during the process
+      this.accessory.logWarn(`${platformLang.devNotUpdated} ${parseError(err)}`)
+
+      // Throw a 'no response' error and set a timeout to revert this after 2 seconds
+      setTimeout(() => {
+        this.service.updateCharacteristic(
+          this.hapChar.CoolingThresholdTemperature,
+          this.accessory.context.cacheTarget,
+        )
+      }, 2000)
+      throw new this.hapErr(-70402)
+    }
+  }
+
+  async internalCurrentTempUpdate() {
+    try {
+      // Don't continue if the device is off
+      if (this.cacheState === 'off') {
+        return
+      }
+
+      // Check to see if we need to turn on or off
+      let newValue
+      let newCool
+      if (this.cacheTemp > this.accessory.context.cacheTarget) {
+        newValue = 'on'
+        newCool = 'on'
+      } else {
+        newValue = 'off'
+        newCool = 'off'
+      }
+
+      // Don't continue if no change needed to device state
+      if (newCool === this.cacheCool) {
+        return
+      }
+
+      // Set up a one-minute timeout for the plugin to ignore incoming updates
+      const timerKey = generateRandomString(5)
+      this.updateTimeout = timerKey
+      setTimeout(() => {
+        if (this.updateTimeout === timerKey) {
+          this.updateTimeout = false
+        }
+      }, 60000)
+
+      // Send the request to the platform sender function
+      await this.platform.sendDeviceUpdate(this.accessory, {
+        cmd: 'stateOutlet',
+        value: newValue,
+      })
+
+      // Log and cache
+      this.cacheCool = newCool
+      this.accessory.log(`${platformLang.curCool} [${this.cacheCool}]`)
+      this.service.updateCharacteristic(
+        this.hapChar.CurrentHeaterCoolerState,
+        this.cacheCool === 'on' ? 3 : 1,
+      )
+    } catch (err) {
+      // Catch any errors during the process
+      this.accessory.logWarn(parseError(err))
+    }
+  }
+
+  async getTemperature() {
+    try {
+      // Skip polling if the storage hasn't initialised properly
+      if (!this.platform.storageClientData) {
+        return
+      }
+
+      const newTemp = await this.platform.storageData.getItem(`${this.temperatureSource}_temp`)
+      if (newTemp && newTemp !== this.cacheTemp) {
+        this.cacheTemp = newTemp
+        this.service.updateCharacteristic(this.hapChar.CurrentTemperature, this.cacheTemp)
+        this.accessory.eveService.addEntry({ temp: this.cacheTemp })
+        this.accessory.log(`${platformLang.curTemp} [${this.cacheTemp}°C]`)
+        await this.internalCurrentTempUpdate()
+      }
+    } catch (err) {
+      this.accessory.logWarn(parseError(err))
+    }
+  }
+
+  externalUpdate() {}
+}