@spec alarms([map()] | map()) :: :ok

Shortcut: prints alarms from UnifiApi.Network.Alarms.list/3 as a table with severity colour-coding.

@spec anomalies([map()] | map()) :: :ok

Shortcut: prints anomalies from UnifiApi.Network.Anomalies.list/3.

@spec cameras([map()] | map()) :: :ok

Shortcut: prints cameras as a pre-configured table.

Examples

{:ok, cameras} = UnifiApi.Protect.Cameras.list(client)
UnifiApi.Formatter.cameras(cameras)

@spec clients([map()] | map()) :: :ok

Shortcut: prints clients as a pre-configured table.

Examples

{:ok, clients} = UnifiApi.Network.Clients.list(client, site_id)
UnifiApi.Formatter.clients(clients)

@spec clients_live([map()] | map()) :: :ok

Shortcut: prints live wireless clients from UnifiApi.Network.ClientsLive.list/2.

@spec detail(
  map(),
  keyword()
) :: :ok

Prints a single map as a colored key-value detail view.

Handles wrapped responses (%{"data" => %{...}}).

Examples

{:ok, device} = UnifiApi.Network.Devices.get(client, site_id, device_id)
UnifiApi.Formatter.detail(device)

{:ok, nvr} = UnifiApi.Protect.NVR.get(client)
UnifiApi.Formatter.detail(nvr, title: "NVR Info")

@spec devices([map()] | map()) :: :ok

Shortcut: prints devices as a pre-configured table.

Examples

{:ok, devices} = UnifiApi.Network.Devices.list(client, site_id)
UnifiApi.Formatter.devices(devices)

@spec events([map()] | map()) :: :ok

Shortcut: prints events from UnifiApi.Network.Events.list/3 as a table with subsystem colour-coding.

Examples

{:ok, events} = UnifiApi.Network.Events.list(authed, "default", within_hours: 1)
UnifiApi.Formatter.events(events)

@spec networks([map()] | map()) :: :ok

Shortcut: prints networks as a pre-configured table.

Examples

{:ok, networks} = UnifiApi.Network.Networks.list(client, site_id)
UnifiApi.Formatter.networks(networks)

@spec sites([map()] | map()) :: :ok

Shortcut: prints sites as a pre-configured table.

Examples

{:ok, sites} = UnifiApi.Network.Sites.list(client)
UnifiApi.Formatter.sites(sites)

@spec table([map()] | map(), [String.t()], keyword()) :: :ok

Prints a list of maps as a colored ANSI table.

Accepts a plain list or a wrapped response (%{"data" => [...]}).

Options

• :title — optional title printed above the table
• :colors — map of column names to color atoms (e.g. %{"state" => :state})

Examples

UnifiApi.Formatter.table(devices, ["name", "macAddress", "state"], title: "Devices")

UnifiApi.Formatter.table(clients, ["name", "ipAddress", "type"],
  title: "Connected Clients",
  colors: %{"type" => :type}
)