--- title: "TP-Link Omada Open API" description: "TP-Link Omada Open API is a Marketplace integration for Home Assistant. It has 194 installs sharing analytics, needs the vendor's cloud and was last updated October 27, 2026." canonical: "https://vulpo.app/integrations/marketplace/bullitt186-ha-omada-open-api" url: "https://vulpo.app/integrations/marketplace/bullitt186-ha-omada-open-api.md" last-updated: "2026-10-22" version: "1.4" --- # TP-Link Omada Open API > TP-Link Omada Open API is a Marketplace integration for Home Assistant. It has 194 installs sharing analytics, needs the vendor's cloud and was last updated October 27, 2026. 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](https://vulpo.app/contact) [Open in My Home Assistant](https://my.home-assistant.io/redirect/hacs_repository/?owner=bullitt186&repository=ha-omada-open-api&category=integration) On Home Assistant 2026.11 or newer? [Open it in the Marketplace](https://my.home-assistant.io/redirect/marketplace_repository/?owner=bullitt186&repository=ha-omada-open-api&category=integration) ## 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. ## Setting it up Install it from the Marketplace and restart Home Assistant, then add it under Settings, Devices and services. ### Select Controller Type - **Controller Type**: Cloud-hosted uses TP-Link cloud; local connects directly to your controller ### Omada API Credentials - **Omada ID**: MSP ID or Customer ID from your Open API application - **Client ID**: OAuth2 Client ID from your Open API application - **Client Secret**: OAuth2 Client Secret from your Open API application ### Select Cloud Region - **Region**: Choose the cloud region matching your Omada controller deployment ### Local Controller URL - **Controller URL**: Full URL including protocol and port - **Verify TLS certificate**: Leave 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 URL**: Full URL including protocol (e.g., https://192.168.1.1) - **Username**: Web interface login username - **Password**: Web interface login password ### Select Sites - **Sites to Monitor**: Select 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 Track**: Select 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 days**: Default 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 clients**: When disabled, only wireless clients matching the SSID selection are discovered. - **Exclude guest clients**: Prevents temporary guest-network clients from creating registry entries. - **Exclude locally administered or private MAC addresses**: Locally 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 name**: Skip clients for which Omada reports only a MAC address and no name or hostname. - **Clients to exclude from automatic discovery**: Explicitly excluded MAC addresses remain ignored if they reconnect. - **Show Wi-Fi RSSI, SNR and signal quality on existing client trackers**: Enabled 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](https://github.com/bullitt186/ha-omada-open-api). ## Entities - **Binary sensors**: Status, Power save, Connected, Internet, Speed test running, WLAN optimization running - **Buttons**: Reboot, Reconnect, WLAN optimization, Locate, Run speed test - **Sensors**: Connected clients, Wired clients, Wireless clients, Guest clients, Total clients, PoE consumption, Uptime, CPU utilization, Memory utilization, Device type, Tag, Uplink device, and 69 more - **Switches**: PoE, Network access, LED, Broadcast, SSID, 2.4 GHz radio, 5 GHz radio, 5 GHz-1 radio, 5 GHz-2 radio, 6 GHz radio - **Updates**: Firmware ## Troubleshooting - **Diagnostics**: Downloads a diagnostics file to attach to a bug report. - **Repair notices**: Notices it can show in Settings, Repairs: Omada API credentials have read-only access, Application traffic tracking requires a gateway ## From the README > Monitor and control your TP-Link Omada SDN infrastructure directly from Home Assistant. From the README of [bullitt186/ha-omada-open-api](https://github.com/bullitt186/ha-omada-open-api#readme), [MIT License](https://spdx.org/licenses/MIT.html). Shortened. ## At a glance - Kind: Marketplace integration - Category: [Computers and network](https://vulpo.app/integrations/category/computers-and-network.md), Routers and network - Brand: [TP-Link](https://vulpo.app/integrations/tp-link.md) - Number: 194 installs sharing analytics; 42 GitHub stars - Connection: Needs the vendor's cloud - Upkeep: Updated in the last 6 months - Needs: Needs the Marketplace (HACS on 2026.10 and older) - Latest version: v1.11.1, last updated October 27, 2026 - Domain: `omada_open_api` - Source: - Issues: In Vulpo: Quick Toggle card, Button card, Chart card, Apple Watch, Control Center ## Other ways in for TP-Link | Name | Kind | Installs or stars | Connection | Upkeep | | --- | --- | --- | --- | --- | | [TP-Link Smart Home](https://vulpo.app/integrations/core/tplink.md) | Built-in integration | 77.5k installs sharing analytics | Works locally | Part of Home Assistant | | [Tapo: Cameras Control](https://vulpo.app/integrations/marketplace/jurajnyiri-homeassistant-tapo-control.md) | Marketplace integration | 17.4k installs sharing analytics | Connection not stated | Updated in the last 6 months | | [TP-Link Tapo](https://vulpo.app/integrations/marketplace/petretiandrea-home-assistant-tapo-p100.md) | Marketplace integration | 5.7k installs sharing analytics | Works locally | Updated in the last 6 months | | [TP-Link Omada](https://vulpo.app/integrations/core/tplink-omada.md) | Built-in integration | 3.5k installs sharing analytics | Works locally | Part of Home Assistant | | [TP-Link Deco](https://vulpo.app/integrations/marketplace/amosyuen-ha-tplink-deco.md) | Marketplace integration | 3.3k installs sharing analytics | Works locally | Updated in the last 6 months | Independent directory, made by the developer of Vulpo. Not affiliated with Home Assistant or the Open Home Foundation. [About these numbers](https://vulpo.app/integrations/about) Last updated 2026-10-22. Source: https://vulpo.app/integrations/marketplace/bullitt186-ha-omada-open-api --- - HTML version of this page: https://vulpo.app/integrations/marketplace/bullitt186-ha-omada-open-api - Site index for agents: https://vulpo.app/llms.txt - Everything in one document: https://vulpo.app/llms-full.txt - All pages: https://vulpo.app/sitemap.xml