UPS Accessory - ebaauw/homebridge-ups GitHub Wiki
Homebridge UPS exposes an accessory for each UPS device, with an Outlet service, a Battery service, and a History service for Eve history.
Outlet Service
The table below lists the characteristics of the Outlet service, mapped to the corresponding NUT variable(s).
| Characteristic | NUT variable | RW | Description |
|---|---|---|---|
| On | ups.state |
R | Indicates whether UPS is using mains power.The characteristic is read/write, but changing it won't do anything. |
| In Use | R | Indicates whether upsmon clients are connected. |
|
| Total Consumption | R | Total lifetime consumption of devices powered through the UPS in kWh.This is computed by Homebridge UPS for the benefit of Eve history, and only reflects the lifetime consumption while Homebridge UPS is running. | |
| Consumption | ups.realpower.nominalups.load |
R | Current consumption of devices powered through the UPS in Watt. |
| Voltage | input.voltage |
R | The input voltage of the UPS device. |
| Last Updated | R | The date/time when Homebridge UPS last polled the UPS device through upsd. |
|
| Mute | ups.beeper.status |
RW | Whether the audible alarm is disabled or muted. |
| Status Fault | ups.stateups.alarm |
R | Whether the UPS device reports an alarm.The alarm message is logged as a warning to the Homebridge log and reported under Last Event. |
| Last Event | ups.test.resultups.alarm |
R | The last test result and alarm message.Issue Identify from HomeKit to start a quick test. |
| Lock Physical Controls | RW | This dummy characteristic is required for Eve to show history for On. |
Note that Apple's Home doesn't support all of HomeKit. You need another HomeKit app, like Eve, to use the full features of Homebridge UPS.
Battery Service
The Battery service has the following Characteristics:
| Characteristic | NUT variable | RW | Description |
|---|---|---|---|
| Battery Level | battery.charge |
R | Battery level in %. |
| Charging State | ups.state |
R | Whether battery is charging. |
| Low Battery Threshold | battery.charge.lowups.state |
RW | Threshold for low battery alarm.Reported as 100% when UPS device reports that battery needs to be changed, so battery alarm is visible in HomeKit. |
| Status Low Battery | R | Computed from Battery Level and Low Battery Threshold. | |
| Voltage | battery.voltage |
R | The battery voltage. |
| Remaining Duration | battery.runtime |
R | The expected remaining duration, when the UPS is on battery power. |