unifi_skill

Overview

This skill monitors and queries UniFi network infrastructure using the UniFi Controller API. It provides real-time site status, device lists, client information, bandwidth stats, device health, WAN status, and recent alerts to help you understand and troubleshoot your home or small-office network.

How this skill works

The skill runs a local CLI wrapper that communicates with your Cloud Key / UniFi Controller over the LAN. It reads controller credentials from a local config file and executes read-only queries (site-status, devices, clients, health, wan, bandwidth, alerts) then parses results into human-readable summaries and tables. It requires the controller to be reachable on port 8443 and the config.json to be populated with controller host and admin credentials.

When to use it

• Check overall network health or controller site status
• List all UniFi devices (USG, APs, switches) and their firmware/uptime
• See which clients are connected and view per-client bandwidth
• Investigate device health metrics (CPU, memory, uptime) and alerts
• Verify WAN/public IP, connection speeds, and internet uptime

Best practices

• Keep config.json out of version control and protect controller credentials
• Run queries from the same LAN as the Cloud Key to avoid connectivity issues
• Use site-status and devices for quick health checks before deeper troubleshooting
• Highlight high-bandwidth clients and offline devices when reporting issues
• Test the CLI after setup with site-status to confirm connectivity

Example use cases

• User asks "Who's connected to my network?" → run clients and report hostnames, IPs, and bandwidth
• User asks "Is my internet working?" → run wan to show public IP, speeds, and uptime
• User reports slow Wi‑Fi → run bandwidth and health, flag high-usage clients or overloaded APs
• Routine checkup → run site-status and devices to verify controller version, device firmware, and uptime
• Investigating outages → run alerts and health to surface recent events and failing hardware