UnifiApi.Network.UPS (UnifiApi v0.4.0)

Copy Markdown View Source

UniFi Network API (v1) — UPS devices.

Returns connected UPS units (typically attached to a UDM Pro via USB) with battery, runtime, and load telemetry.

Requires cookie + CSRF authentication. See UnifiApi.Auth.Cookie.

UPS fields

  • name, model, serial
  • ups_status — "OL" (online), "OB" (on battery), "LB" (low battery)
  • battery_charge (0..100 percent), battery_runtime (seconds)
  • input_voltage, output_voltage
  • load_pct

Summary

Functions

list(client, site_id, opts \\ [])

Lists connected UPS devices on a site.

Functions

list(client, site_id, opts \\ [])

@spec list(Req.Request.t(), String.t(), keyword()) ::
  {:ok, term()} | {:error, UnifiApi.Error.t()}

Lists connected UPS devices on a site.

Options

Validated with Keyword.validate!/2 — an unknown key raises ArgumentError rather than being silently dropped.

  • :limit — page size, sent as the v1 _limit query param.
  • :start — page offset, sent as the v1 _start query param.
  • :params — extra query params, merged verbatim ahead of _limit / _start.
  • :raw — when true, return the raw response body binary (skips JSON decoding and the v1 envelope unwrap).

Pagination — first page only, and there is no stream/3

/stat/ups-devices is a v1 collection endpoint: it pages on _start / _limit and the meta envelope carries no total count, so a full page is indistinguishable from a truncated one. list/3 returns the first page only whenever :limit is set, and whatever the controller's own default cap allows otherwise. This module has no stream/3 — a site has a handful of UPS units at most, so paging is not normally needed. Page manually when it is: request limit: n and walk :start in steps of n until a page returns fewer than n items.

Examples

{:ok, upses} = UnifiApi.Network.UPS.list(authed, "default")

# Explicit first page of 50
{:ok, upses} = UnifiApi.Network.UPS.list(authed, "default", limit: 50, start: 0)