homebridge-ups/lib/UpsAccessory.js

Homebridge plugin for Network UPS Tools

// homebridge-ups/lib/UpsAccessory.js
// Copyright © 2022-2026 Erik Baauw. All rights reserved.
//
// Homebridge plugin for UPS.

import { AccessoryDelegate } from 'homebridge-lib/AccessoryDelegate'
import { ServiceDelegate } from 'homebridge-lib/ServiceDelegate'
import 'homebridge-lib/ServiceDelegate/History'

import { UpsClient } from './UpsClient.js'
import { UpsService } from './UpsService.js'

function exists (value) {
  return value != null && value !== ''
}

function parse (constants) {
  const result = {}
  if (exists(constants['ups.status'])) {
    result.status = constants['ups.status'].split(' ')
  } else {
    result.status = []
  }
  if (exists(constants['ups.load'])) {
    if (exists(constants['ups.realpower.nominal'])) {
      result.power = Math.round(
        parseFloat(constants['ups.realpower.nominal']) *
          parseFloat(constants['ups.load']) / 10
      ) / 10
    } else if (exists(constants['ups.power.nominal'])) {
      result.power = Math.round(
        parseFloat(constants['ups.power.nominal']) *
          parseFloat(constants['ups.load']) / 10
      ) / 10
    } else if (exists(constants['output.current'])) {
      if (exists(constants['output.voltage'])) {
        result.power = Math.round(
          parseFloat(constants['output.voltage']) *
            parseFloat(constants['output.current']) * 10
        ) / 10
      }
    }
  }
  if (exists(constants['input.voltage'])) {
    result.voltage = parseFloat(constants['input.voltage'])
  } else if (exists(constants['output.voltage'])) {
    result.voltage = parseFloat(constants['output.voltage'])
  }
  if (exists(constants['ups.beeper.status'])) {
    result.mute = constants['ups.beeper.status'] !== 'enabled'
  }
  if (exists(constants['ups.alarm'])) {
    result.alarm = constants['ups.alarm']
  }
  if (exists(constants['ups.test.result'])) {
    result.testResult = constants['ups.test.result']
  }
  if (exists(constants['battery.charge'])) {
    result.batteryLevel = parseInt(constants['battery.charge'])
  }
  if (exists(constants['battery.charge.low'])) {
    result.lowBatteryThreshold = parseInt(constants['battery.charge.low'])
  }
  if (exists(constants['battery.voltage'])) {
    result.batteryVoltage = parseFloat(constants['battery.voltage'])
  }
  if (exists(constants['battery.runtime'])) {
    result.batteryRuntime = parseInt(constants['battery.runtime'])
  }
  return result
}

class UpsAccessory extends AccessoryDelegate {
  constructor (upsHost, params) {
    super(upsHost.platform, params)
    this.upsHost = upsHost
    this.device = params.device
    this.values.firmware = params.firmware
    const body = parse(params.constants)

    this.log(
      '%s: %s %s %sV UPS with %sV %s battery from %s',
      params.id, params.manufacturer, params.model,
      parseFloat(params.constants['input.voltage.nominal']),
      parseFloat(params.constants['battery.voltage.nominal']),
      params.constants['battery.type'], params.constants['battery.mfr.date']
    )
    this.debug('state: %j', body)

    this.service = new UpsService.Contact(this, body)
    this.manageLogLevel(this.service.characteristicDelegate('logLevel'))
    this.batteryService = new UpsService.Battery(this, body)
    this.consumptionService = new UpsService.Consumption(this, body)
    this.historyService = new ServiceDelegate.History(this, {
      consumptionDelegate: this.consumptionService.characteristicDelegate('consumption'),
      computedTotalConsumptionDelegate: this.consumptionService.characteristicDelegate('totalConsumption'),
      contactDelegate: this.service.characteristicDelegate('contact'),
      lastContactDelegate: this.service.characteristicDelegate('lastActivation'),
      timesOpenedDelegate: this.service.characteristicDelegate('timesOpened')
    })

    this.on('identify', this.identify)

    setImmediate(() => {
      this.emit('initialised')
    })
  }

  async heartbeat (beat) {
    try {
      const nClients = await this.device.nClients()
      const constants = await this.device.constants()
      const body = parse(constants)
      this.debug('state: %j', body)
      this.service.update(body, nClients)
      this.consumptionService.update(body)
      this.batteryService.update(body)
      if (nClients > 0) {
        const clients = await this.device.clients()
        this.debug(
          '%d clients: %j', nClients, clients
        )
      }
    } catch (error) {
      if (!(error instanceof UpsClient.UpsError)) {
        this.error('heartbeat error: %s', error)
      }
      this.setFault()
    }
  }

  async identify () {
    try {
      await this.device.command('test.battery.start.quick')
    } catch (error) {
      if (!(error instanceof UpsClient.UpsError)) {
        this.error('error: %s', error)
      }
    }
  }

  setFault () {
    this.service.setFault()
  }
}

export { UpsAccessory }