Ubiquity
@stack72/ubiquityv2026.03.10.1
01README
Collects and monitors traffic data from a Ubiquiti UniFi Dream Machine (UDM, UDM Pro, UDM SE, etc.).
Data Collected
- Site Traffic - Hourly WAN and WLAN traffic totals for the past 24 hours
- Client Traffic - Per-device usage, signal strength, and connection details
- DPI Stats - Deep packet inspection category breakdown (when available)
Connection Modes
- Local - Direct connection to the UDM over your local network
- Cloud - Via Ubiquiti's cloud API (better device name resolution)
- Both (recommended) - Cloud mode with local credentials as fallback
02Behaviors
unifi_traffic.tsv2026.03.06.13
Global Arguments
| Argument | Type | Description |
|---|---|---|
| mode | enum | Connection mode: 'local' for direct UDM access, 'cloud' for remote via api.ui.com |
| host? | string | UDM IP address or hostname (required for local mode, e.g. 192.168.1.1) |
| username? | string | Local admin username (required for local mode) |
| password? | string | Local admin password (required for local mode) |
| site | string | UniFi site name |
| apiKey? | string | UniFi Cloud API key (required for cloud mode) |
fn collect()
Collect traffic data from the UniFi Dream Machine for the past 24 hours (local or cloud)
Resources
siteTraffic— Hourly site traffic data for the past 24 hours
clientTraffic— Current client traffic snapshot with top talkers
03Previous Versions
2026.03.08.1
04Stats
B
86 / 100
Downloads
104
Archive size
17.0 KB
- Has README or module doc2/2earned
- README has a code example1/1earned
- README is substantive1/1earned
- Most symbols documented0/1missing
- No slow types (deprecated)1/1earned
- Dependencies pass trust audit2/2earned
- Has description1/1earned
- Platform support declared (or universal)2/2earned
- License1/2partial
no SPDX license declared
- Verified public repository2/2earned
05Platforms