Repository navigation
UPS: read NUT as well as apcupsd in upsDevices #2115
Description
Is your feature request related to a problem?
upsDevices only reads apcupsd (UPSService.getUPSData() runs /sbin/apcaccess). Many Unraid servers monitor their UPS with NUT instead, through the popular NUT plugin, often as a NUT client of another box (a firewall or another server) that the UPS is plugged into. On those servers apcupsd is disabled, apcaccess returns nothing, and upsDevices fails with Failed to get UPS data: No UPS data returned from apcaccess. So API clients can't show the UPS the server actually depends on, even though the webGUI shows it through the NUT plugin.
Related: #1765 (a NUT user seeing wrong values in a mobile client) and #1825 (placeholder values returned when no UPS is connected).
Describe the solution you'd like
When apcupsd has no data and NUT is configured, read the UPS through NUT (upsc <ups>@<host>, or the NUT network protocol on port 3493 using the plugin's configured NAME / IPADDR, which works in both server and client mode), and map it onto the existing UPSDevice fields:
| UPSDevice field | NUT variable |
|---|---|
model |
device.model / ups.model |
status |
ups.status (OL, OB, LB, ...), mapped to the same words as apcupsd |
battery.chargeLevel |
battery.charge |
battery.estimatedRuntime |
battery.runtime (already seconds) |
power.inputVoltage |
input.voltage |
power.outputVoltage |
output.voltage |
power.loadPercentage |
ups.load |
power.nominalPower |
ups.realpower.nominal |
A source field (APCUPSD / NUT) on UPSDevice or UPSConfiguration would help clients explain where the data comes from.
Describe alternatives you've considered
- Enabling apcupsd alongside NUT: not supported; the two conflict over the USB device, and a NUT client has no local UPS to read.
- Querying NUT directly from the client: needs another port and credentials outside the API, and only works on the LAN.
Additional context
While adding a UPS card to an Android client (urrt) on API 4.37.5, two more things showed up:
upsConfiguration.serviceis the useful "is a UPS configured" signal for apcupsd, but there is no equivalent for NUT, so a client can't tell "no UPS" from "UPS monitored by NUT".- When an apcaccess field is missing,
createUPSDevicefills in placeholders (LOADPCT25,BCHARGE100,TIMELEFT60 min,LINEV/OUTPUTV120.5, model "APC Back-UPS Pro 1500",healthalways "Good"). A client can't tell those from real readings. Returningnullfor missing values (the fields would need to become nullable) would let clients show "unknown" instead. This overlaps API returns hardcoded UPS data when no UPS is connected #1825.
Environment (if relevant)
Unraid OS Version: 7.3.3 and 7.4.0-rc.1 (API 4.37.5). The server is a NUT client (MODE="slave") of a NUT server on the firewall; apcupsd disabled.
Pre-submission Checklist
- I have searched existing issues to ensure this feature hasn't already been requested
- This is not an Unraid Connect related feature (if it is, please submit via the support form instead)
- I have provided clear examples or use cases for the feature
Activity