ZTE Router Integration for Home Assistant

ZTE Router Integration for Home Assistant

Component to integrate some ZTE routers as a device tracker in Home Assistant. This repository contains the ZTE Router custom integration and an add-on to deploy it in Home Assistant. The custom integration is located in the custom_components/zte_router directory.

🚀 Overview

This is a custom Home Assistant integration for several ZTE 5G routers. It adds full sensor tracking, diagnostics, and control over supported devices.

✅ Features

• Support for MC801A, MC889, MC888, MC889A, MC888A, and similar models with or without username
• Automatically discovers devices and sensors
• Wi-Fi and LAN client tracking
• FLUX usage monitoring (TX/RX rates, data limit, usage alerts) - for newer versions of routers
• SMS inbox access and diagnostics + sending predefined sms
• Auto-config flow setup
• Multiple sensor categories and diagnostic grouping

Note: This integration is in beta. It is stable enough for testing and general use, but expect some features to evolve.

Installation

Manual Installation

1. Download the latest zte-router release
2. Place the files of the .zip in your root directory of Home Assistant (That should only effectively place files into /custom_components/zte_router)
3. Restart Home Assistant
4. Go to Settings > Devices and Services to search and add the ZTE Router integration
5. Select the model you have and enter the Router IP, password and wait for the integration to install all the device sensors.

Installation with HACS

Method 1

Method 2

1. HACS > Integrations > ⋮ > Custom Repositories
2. Repository: paste the URL of this repo
3. Category: Integration
4. Click Add
5. Close Custom Repositories modal
6. Click + EXPLORE & DOWNLOAD REPOSITORIES
7. Search for ZTE router
8. Click Download
9. Restart Home Assistant
10. Search for "integration" in the ZTE Router integration and add it to Home Assistant or click on this link:

11. Select the model and enter the router's IP and password.
12. Wait for the integration to install all the device sensors.

🧪 Beta Features

To install beta versions from HACS:

1. In HACS → Integrations → ZTE Router → ⋮ → Redownload
2. Toggle "Show beta versions" or Need a different version
3. Select the latest -b1 or -beta.x version
4. Restart Home Assistant

🐞 Known Issues

• Some sensors may occasionally show unknown until refreshed
• SMS parsing may behave differently between router models
• Occasional log errors (under investigation)
• Errors in Home Assistant log - They are for now present until I polish the addon
• Various errors in sensors etc. - This integration is classified as beta right now but can be tested by anyone.
• For suggestions, please open a new issue
• I will push new builds as soon I will have more time. Make sure you "star" this integration.

Contributors

If u have any suggestion, or you are doing pull requests and adding new features, increment the version number by 1 in manifest.json, so that GitHub automation automatically creates a new release.

🙏 Special Thanks

Huge thanks to @rosenrot00 for helping rewrite major portions of the code and improving overall quality!