Skip to content

Commit

Permalink
Update README
Browse files Browse the repository at this point in the history
  • Loading branch information
Zach Cheatham committed Feb 24, 2023
1 parent eb26807 commit ed823c7
Showing 1 changed file with 25 additions and 9 deletions.
34 changes: 25 additions & 9 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,23 +1,39 @@
# Home Assistant TP-Link Omada Integration

[![hacs_badge](https://img.shields.io/badge/HACS-Custom-41BDF5.svg)](https://github.com/hacs/integration)

Adds Omada SDN Controller support to Home assistant. This integration requires [HACS](https://hacs.xyz).

## Features

- Device tracker for WLAN clients
- Device and client attributes and sensors.
- Device tracker for clients.
- Client and device bandwidth sensors.
- Client and device statistics sensors.
- WLAN Radio controls
- WLAN SSID controls
- Client blocking toggles.
- SSID filter.

## Planned Features

- Additional sensors.
- Switches for toggling Omada settings.
- Client filters
- Support for additional hardware such as switches and routers.
- Better wired client support (help wanted.)
- Better switch and router support (help wanted.)
- Individual client filters.
- SDN and site controls and statistics.



## Installation

- [Add this custom repository to HACS](https://hacs.xyz/docs/faq/custom_repositories)
- Install via HACS UI
- Add and configure integration via Home Assistant
Recommended to be installed via [HACS](https://github.com/hacs/integration)

1. Go to HACS -> Integrations
2. [Add this repo to your HACS custom repositories](https://hacs.xyz/docs/faq/custom_repositories)
3. Search for TP-Link Omada and install.
4. Restart Home Assistant
5. Open Home Assistant Settings -> Devices & Serivces
6. Shift+reload your browser to clear config flow caches.
7. Click ADD INTEGRATION
8. Search for TP-Link Omada
9. Enter the URL you use to access your Omada SDN, the username you would like HA to connect with, and its password.
10. If no errors occur, you're all set! Otherwise, feel free to browse the issue track or open a new issue to help resolve the issue.

0 comments on commit ed823c7

Please sign in to comment.