TP-Link Omada Open API for Home Assistant (Marketplace integration)

Installs: 194 sharing analytics
GitHub stars: 42
Connection: Uses the vendor's cloud
Upkeep: Updated in the last 6 months
Version: v1.11.1, October 27, 2026
Category: Computers and network, Routers and network
Kind: Marketplace integration
Brand: TP-Link
Needs: Needs the Marketplace (HACS on 2026.10 and older)
Domain: omada_open_api
Source: github.com/bullitt186/ha-omada-open-api
Issues: Report an issue

Independent directory, made by the developer of Vulpo. Not affiliated with Home Assistant or the Open Home Foundation.

About

TP-Link Omada Open API monitors and controls Omada SDN access points, switches, gateways and clients from Home Assistant. It connects to a cloud-hosted or local Omada controller through the Omada Open API, and Fusion gateways sign in with their web interface username and password instead. It adds sensors, binary sensors, device trackers, buttons, switches and firmware update entities. Switches cover PoE, LED, SSID, radio bands and client network access, and buttons cover reboot, locate, reconnect and a gateway speed test. Client presence tracking can be limited by SSID, can include or exclude wired and guest clients, and has an opt-in automatic discovery mode. Optional sensors include threat heatmaps, VPN tunnel monitoring and radio utilization, and update intervals are adjustable in the options. Control entities need Open API write permissions, and free cloud accounts are not supported.

Automatic summary of the README and code of bullitt186/ha-omada-open-api. Something wrong, or are you the maintainer and want your own text here? Get in touch

Supports

Uses the vendor's cloud Needs an internet connection and an account with the vendor.
From the Marketplace Installed through the Marketplace, formerly HACS.
Actively maintained Its author released or pushed a change in the last six months.

Provides

Switches
Sensors
Presence

Setting it up

Install it from the Marketplace and restart Home Assistant, then add it under Settings, Devices and services.

Select Controller Type

Controller TypeCloud-hosted uses TP-Link cloud; local connects directly to your controller

Omada API Credentials

Omada IDMSP ID or Customer ID from your Open API application
Client IDOAuth2 Client ID from your Open API application
Client SecretOAuth2 Client Secret from your Open API application

Select Cloud Region

RegionChoose the cloud region matching your Omada controller deployment

Local Controller URL

Controller URLFull URL including protocol and port
Verify TLS certificateLeave enabled for valid HTTPS certificates. Disable to connect to a hardware controller (e.g. OC200/OC300) that uses the factory self-signed certificate.

Fusion Gateway Credentials

Gateway URLFull URL including protocol (e.g., https://192.168.1.1)
UsernameWeb interface login username
PasswordWeb interface login password

Select Sites

Sites to MonitorSelect one or more Omada sites to monitor devices and clients

Filter Clients by SSID (Optional)

Filter by SSID (optional)Select SSIDs to restrict the client list — wired clients always shown

Select Clients to Track (Optional)

Clients to TrackSelect network clients to create device tracker entities for

After setup

Filter by SSID (optional)Select SSIDs to restrict the client list — wired clients always shown
Clients to Track
Applications to Track
Device polling interval (seconds)
Client polling interval (seconds)
Application traffic polling interval (seconds)
Client disconnect timeout (minutes)Set to 0 for immediate disconnect detection. Values 1–60 keep the device marked as home for this many minutes after it disappears from the network.
Automatically discover client presence trackers (opt-in; off by default)Off by default. Opt in to create one presence-only tracker per active network client; large networks may create hundreds. Existing tracked clients keep their identity and richer controls.
Remove inactive auto-discovered clients after this many daysDefault 30 days. Set to 0 to retain auto-discovered registry entries forever. Cleanup never removes manually selected clients or devices that still have other entities.
Only these wireless SSIDs (blank means all)Optional exact SSID names. A blank selection includes every wireless SSID.
Include wired clientsWhen disabled, only wireless clients matching the SSID selection are discovered.
Exclude guest clientsPrevents temporary guest-network clients from creating registry entries.
Exclude locally administered or private MAC addressesLocally administered MACs often represent private Wi-Fi addresses, which rotate and create duplicate trackers. Disable only if those devices are useful for presence detection.
Only discover clients with a nameSkip clients for which Omada reports only a MAC address and no name or hostname.
Clients to exclude from automatic discoveryExplicitly excluded MAC addresses remain ignored if they reconnect.
Show Wi-Fi RSSI, SNR and signal quality on existing client trackersEnabled by default. Shows controller-reported RSSI (dBm), SNR (dB) and signal level (%) as attributes of each existing tracker. SSID changes update the same device; no separate signal sensor entities are created.
Daily bandwidth sensors (download/upload totals)
Client count sensors per device
Diagnostic sensors (CPU, memory, uptime, IP, firmware)
Radio utilization sensors (TX/RX/interference per band)
Bandwidth sensors (downloaded, uploaded, RX/TX activity rate)
Signal sensors (RSSI, SNR, signal strength)
Network access (block/unblock) switch
Reconnect button
Threat heatmap sensors (daily/weekly/monthly)
VPN monitoring sensors (tunnels and peers)
WAN speed test (trigger button, results, and running status)

Texts from the code of bullitt186/ha-omada-open-api.

Entities

Binary sensorsStatus, Power save, Connected, Internet, Speed test running, WLAN optimization running
ButtonsReboot, Reconnect, WLAN optimization, Locate, Run speed test
SensorsConnected clients, Wired clients, Wireless clients, Guest clients, Total clients, PoE consumption, Uptime, CPU utilization, Memory utilization, Device type, Tag, Uplink device, and 69 more
SwitchesPoE, Network access, LED, Broadcast, SSID, 2.4 GHz radio, 5 GHz radio, 5 GHz-1 radio, 5 GHz-2 radio, 6 GHz radio
UpdatesFirmware

Troubleshooting

DiagnosticsDownloads a diagnostics file to attach to a bug report.
Repair noticesNotices it can show in Settings, Repairs:Omada API credentials have read-only access, Application traffic tracking requires a gateway