-
-
Notifications
You must be signed in to change notification settings - Fork 16
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #25 from dmamontov/2-beta
2 beta
- Loading branch information
Showing
34 changed files
with
35,682 additions
and
1,663 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,36 @@ | ||
| name: "CodeQL" | ||
|
|
||
| on: | ||
| push: | ||
| pull_request: | ||
| schedule: | ||
| - cron: '22 20 * * 6' | ||
|
|
||
| jobs: | ||
| analyze: | ||
| name: Analyze | ||
| runs-on: ubuntu-latest | ||
| permissions: | ||
| actions: read | ||
| contents: read | ||
| security-events: write | ||
|
|
||
| strategy: | ||
| fail-fast: false | ||
| matrix: | ||
| language: [ 'python' ] | ||
|
|
||
| steps: | ||
| - name: Checkout repository | ||
| uses: actions/checkout@v2 | ||
|
|
||
| - name: Initialize CodeQL | ||
| uses: github/codeql-action/init@v1 | ||
| with: | ||
| languages: ${{ matrix.language }} | ||
|
|
||
| - name: Autobuild | ||
| uses: github/codeql-action/autobuild@v1 | ||
|
|
||
| - name: Perform CodeQL Analysis | ||
| uses: github/codeql-action/analyze@v1 |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,15 @@ | ||
| name: Validate HASS and HACS | ||
|
|
||
| on: | ||
| push: | ||
| pull_request: | ||
|
|
||
| jobs: | ||
| validate: | ||
| runs-on: "ubuntu-latest" | ||
| steps: | ||
| - uses: "actions/checkout@v2" | ||
| - uses: "home-assistant/actions/hassfest@master" | ||
| - uses: "hacs/action@main" | ||
| with: | ||
| category: "integration" |
This file was deleted.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -10,10 +10,11 @@ Component for tracking devices and managing routers based on [MiWiFi](http://miw | |
| - [Conflicts](#conflicts) | ||
| - [Install](#install) | ||
| - [Config](#config) | ||
| - [Advanced config](#advanced-config) | ||
| - [Services](#services) | ||
| - [Advanced config](#advanced-config) | ||
| - [Performance table](#performance-table) | ||
| - [Routers tested](#routers-tested) | ||
| - [Supported routers](#supported-routers) | ||
| - [API check list](#api-check-list) | ||
| - [Summary](#summary) | ||
|
|
||
| ## FAQ | ||
| **Q. Do I need to get telnet or ssh?** | ||
|
|
@@ -22,23 +23,15 @@ Component for tracking devices and managing routers based on [MiWiFi](http://miw | |
|
|
||
| **Q. How often are states updated?** | ||
|
|
||
| **A.** Once every 10 seconds. This is the most optimal time for correct work. | ||
|
|
||
| **Q. In addition to tracking devices, what else does the integration allow you to do?** | ||
|
|
||
| **A.** The integration creates sensors to track the number of connected devices through different types of connections (`5 Ghz`, `2.4 Ghz`, `lan`, `guest`). Creates binary sensors that track (`mode`, `wifi state`, `wan state`). Creates switches to control `LEDs` and `reboot` the router. It also collects statistics on connected devices (Signal, Uptime, etc.) | ||
|
|
||
| **Q. Does the integration support legacy device tracking via `known_devices.yaml`?** | ||
|
|
||
| **A.** This is a legacy device tracking option. But the integration allows importing names, dev_id, icon from the file `known_devices.yaml` and associating with new devices by mac-address. To do this, simply create or rename the file to `legacy_known_devices.yaml` | ||
| **A.** The default is every 30 seconds, but this setting can be configured. It is not recommended to set less than 10 seconds. | ||
|
|
||
| **Q. Does the integration support routers connected in `repeater mode` or `access point mode`?** | ||
|
|
||
| **A.** Yes, the integration supports devices connected in `repeater mode` or `access point mode`. But to get the number of devices and their tracking, you will also need to connect and configure the parent router. | ||
|
|
||
| **Q. Can I use the router in `repeater mode` or `access point mode` without a parent MiWiFi device?** | ||
|
|
||
| **A.** It is possible with the `force_load_repeater_devices` option enabled. But there is a limitation. You will not see IP, uptime, and connection type, but the name will be the mac-address. | ||
| **A.** It is possible with the `is_force_load` option enabled. But there is a limitation. You will not see IP, uptime, and connection type, but the name will be the mac-address. | ||
|
|
||
| **Q. Does Mesh support routers?** | ||
|
|
||
|
|
@@ -53,7 +46,6 @@ The following component conflicts are currently known: | |
| * **xiaomi** (device_tracker) | ||
| * **Cause**: Due to the fact that they use the same API, logout occurs after each scan | ||
| * **Solution**: I recommend turning it off for this router | ||
|
|
||
|
|
||
| * **nmap** (device_tracker) | ||
| * **Cause**: Because nmap uses the old integration and finds your devices, it simply overwrites their attributes | ||
|
|
@@ -70,76 +62,94 @@ Installed through the custom repository [HACS](https://hacs.xyz/) - `dmamontov/h | |
| Or by copying the `miwifi` folder from [the latest release](https://github.com/dmamontov/hass-miwifi/releases/latest) to the custom_components folder (create if necessary) of the configs directory. | ||
|
|
||
| ## Config | ||
| **Via GUI (Recommended)** | ||
| **Via GUI** | ||
|
|
||
| `Settings` > `Integrations` > `Plus` > `MiWiFi` | ||
|
|
||
| For authorization, use the ip of your router and its password | ||
|
|
||
| **Via YAML (legacy way)** | ||
| ```yaml | ||
| miwifi: | ||
| ip_address: router_ip | ||
| password: router_pass | ||
| scan_interval: 10 # in seconds [PRO] | ||
| timeout: 5 # in seconds [PRO] | ||
| force_load_repeater_devices: False # [PRO] | ||
| ``` | ||
| ## Advanced config | ||
| ❗ Via YAML (legacy way) not supported | ||
|
|
||
| ### Advanced config | ||
| #### Automatically remove devices | ||
| The component supports automatic deletion of monitored devices after a specified number of days (Default: 30 days) after the last activity. If you specify 0, then automatic deletion will be disabled. | ||
|
|
||
| **Via GUI (Recommended)** | ||
|
|
||
| `Settings` > `Integrations` > `Your integration MiWiFi` > `Settings` | ||
|
|
||
| **Via YAML (legacy way)** | ||
| ```yaml | ||
| miwifi: | ||
| ... | ||
| last_activity_days: 30 # [PRO] | ||
| ``` | ||
|
|
||
| ## Services | ||
| #### Remove devices | ||
| The component contains a service that allows you to delete a device by device_id or entity_id | ||
|
|
||
| **Via GUI (Recommended)** | ||
|
|
||
| `Developer-tools` > `Service` > `miwifi.remove_devices` | ||
|
|
||
| **Via YAML (legacy way)** | ||
| ```yaml | ||
| service: miwifi.remove_devices | ||
| target: | ||
| device_id: | ||
| - ... | ||
| entity_id: | ||
| - device_tracker.... | ||
| ``` | ||
|
|
||
| ## Performance table | ||
|  | ||
|
|
||
| 1. Install [Auto-entities](https://github.com/thomasloven/lovelace-auto-entities) from HACS | ||
| 2. Install [Flex Table](https://github.com/custom-cards/flex-table-card) from HACS | ||
| 3. Add new Lovelace tab with **Panel Mode** | ||
| 4. Add new Lovelace card: | ||
| - [example](https://gist.github.com/dmamontov/e6fa1842c486388387aaf061d3a82818) | ||
| - [example (force mode)](https://gist.github.com/dmamontov/9a6183ee5fafd32017c3e8fe0661dde4) | ||
| - [example](https://gist.github.com/dmamontov/d977cd01c861d1f5e66327af22fd084b) | ||
| - [example (force mode)](https://gist.github.com/dmamontov/95990dfd155c6ef92e0e7f46762bfcc2) | ||
|
|
||
| ## Routers tested | ||
| ## Supported routers | ||
| Many more Xiaomi and Redmi routers supported by MiWiFi (OpenWRT - Luci API) | ||
|
|
||
| | Image | Router | Firmware version | Status | | ||
| | --------------------------------------------------- | ---------------------------------------------------------------- | ---------------------------------------------------- | ----------------------------- | | ||
| |  | [Xiaomi AX9000](https://www.mi.com/mirouter/ax9000) | <ul><li>1.0.108(CN)</li><li>3.0.40(Global)</li></ul> | Supported | | ||
| |  | [Xiaomi AX3600](https://www.mi.com/r3600) | <ul><li>1.1.19(CN)</li><li>3.0.22(Global)</li></ul> | Supported | | ||
| |  | [Xiaomi AX1800](https://www.mi.com/buy/detail?product_id=12027) | <ul><li>1.0.378(CN)</li></ul> | Supported | | ||
| |  | [Redmi AX5](https://www.mi.com/buy/detail?product_id=12258) | <ul><li>1.0.33(CN)</li><li>3.0.34(Global)</li></ul> | Supported | | ||
| |  | [Xiaomi AC2100](https://www.mi.com/miwifiac) | <ul><li>2.0.23(CN)</li><li>2.0.743(CN)</li></ul> | Supported | | ||
| |  | [Xiaomi Mi Wifi 4A](https://www.mi.com/miwifi4a/) | <ul><li>2.28.58(CN)</li></ul> | Supported | | ||
| |  | [Xiaomi PRO R3P](http://item.mi.com/1172800043.html) | <ul><li>2.16.29(CN)</li></ul> | With restrictions<sup>*</sup> | | ||
|
|
||
| <sup>*</sup> Not all integration options may be supported. | ||
| ### API check list | ||
|
|
||
| ##### Required | ||
| - `xqsystem/login` - Authorization. | ||
| - `xqsystem/init_info` - Basic information about the router. | ||
| - `misystem/status` - Basic information about the router. Diagnostic data, memory, temperature, etc. | ||
| - `xqnetwork/mode` - Operating mode. Repeater, Access Point, Mesh, etc. | ||
|
|
||
| ##### Additional | ||
| - `misystem/topo_graph` - Topography, auto discovery does not work without it. | ||
| - `xqnetwork/wan_info` - WAN port information. | ||
| - `misystem/led` - Interaction with LEDs. | ||
| - `xqnetwork/wifi_detail_all` - Getting information about WiFi adapters | ||
| - `xqnetwork/wifi_up` - Turning on | ||
| - `xqnetwork/wifi_down` - Turning off | ||
| - `xqnetwork/wifi_connect_devices` - Get information about connected devices | ||
| - `misystem/devicelist` - More information about connected devices | ||
| - `xqsystem/reboot` - Reboot | ||
| - `misystem/newstatus` - Additional information about connected devices for force load mode | ||
|
|
||
| ❗ If your router is not listed or not tested, try adding an integration, it will check everything and give a link to create an issue. You just have to click `Submit new issue` | ||
|
|
||
| ❗ If at the time of adding the integration only `Router {ip} not supported` message is displayed, please create an issue with the message that the router is not supported, indicating the model of the router. | ||
|
|
||
| ### Summary | ||
|
|
||
| - 🟢 - Supported | ||
| - 🔴 - Not supported | ||
| - ⚪ - Not tested | ||
|
|
||
| | Image | Router | Code | API check list | | ||
| | --------------------------------------------------- | -------------------------------------- | ------ | ------------------------- | | ||
| |  | **Xiaomi Router Xiaomi AX9000** | RA70 | 🟢🟢🟢🟢 ➖ 🟢🟢🟢🟢🟢🟢🟢🟢 | | ||
| |  | **Xiaomi Router AX6000** | RA72 | 🟢🟢🟢🟢 ➖ 🟢🟢🟢🟢🟢🟢🟢🟢 | | ||
| |  | **Xiaomi Router AX3000** | RA80 | 🟢🟢🟢🟢 ➖ 🟢🟢🟢🟢🟢🟢🟢🟢 | | ||
| |  | **Redmi Router AX6S** | RB03 | 🟢🟢🟢🟢 ➖ 🟢🟢🟢🟢🟢🟢🟢🟢 | | ||
| |  | **Redmi Router AX3000** | RA81 | 🟢🟢🟢🟢 ➖ 🟢🟢🟢🟢🟢🟢🟢🟢 | | ||
| |  | **Redmi Router AX1800** | RA71 | 🟢🟢🟢🟢 ➖ 🟢🟢🟢🟢🟢🟢🟢🟢 | | ||
| |  | **Redmi Router AX6** | RA69 | 🟢🟢🟢🟢 ➖ 🟢🟢🟢🟢🟢🟢🟢🟢 | | ||
| |  | **Redmi Router AX5** | RA67 | 🟢🟢🟢🟢 ➖ 🟢🟢🟢🟢🟢🟢🟢🟢 | | ||
| |  | **Mi Router AX1800** | RM1800 | 🟢🟢🟢🟢 ➖ 🟢🟢🟢🟢🟢🟢🟢🟢 | | ||
| |  | **Xiaomi AIoT Router AX3600** | R3600 | 🟢🟢🟢🟢 ➖ 🟢🟢🟢🟢🟢🟢🟢🟢 | | ||
| |  | **Redmi Router AC2100** | RM2100 | 🟢🟢🟢🟢 ➖ 🟢🟢🟢🟢🟢🟢🟢🟢 | | ||
| |  | **Mi Router AC2100** | R2100 | 🟢🟢🟢🟢 ➖ 🟢🟢🟢🟢🟢🟢🟢🟢 | | ||
| |  | **Mi Router 4 Pro** | R1350 | 🟢🟢🟢🟢 ➖ 🟢🟢🟢🟢🟢🟢🟢🟢 | | ||
| |  | **Mi AIoT Router AC2350** | R2350 | 🟢🟢🟢🟢 ➖ 🟢🟢🟢🟢🟢🟢🟢🟢 | | ||
| |  | **Mi Router Mesh** | D01 | 🟢🟢🟢🟢 ➖ 🟢🟢🟢🟢🟢🟢🟢🔴 | | ||
| |  | **Mi Router 4A** | R4AC | 🟢🟢🟢🟢 ➖ 🟢🟢🟢🟢🟢🟢🟢🔴 | | ||
| |  | **Mi Router 4A Gigabit** | R4A | 🟢🟢🟢🟢 ➖ 🟢🟢🟢🟢🟢🟢🟢🔴 | | ||
| |  | **Mi Router 4C** | R4CM | 🟢🟢🟢🟢 ➖ 🟢🟢🟢🟢🟢🟢🟢🔴 | | ||
| |  | **Mi Router 4** | R4 | 🟢🟢🟢🟢 ➖ 🟢🟢🟢🟢🟢🟢🟢🔴 | | ||
| |  | **Mi Router 4Q** | R4C | 🟢🟢🟢🟢 ➖ 🟢🟢🟢🟢🟢🟢🟢🔴 | | ||
| |  | **Mi Router 3A** | R3A | 🟢🟢🟢🟢 ➖ 🟢🟢🟢🟢🟢🟢🟢🔴 | | ||
| |  | **Mi Router 3C** | R3L | 🟢🟢🟢🟢 ➖ 🟢🟢🟢🟢🟢🟢🟢🔴 | | ||
| |  | **Mi Router HD** | R3D | 🟢🟢🟢🟢 ➖ 🟢🟢🟢🟢🟢🟢🟢🔴 | | ||
| |  | **Mi Router Pro** | R3P | 🟢🟢🟢🟢 ➖ 🟢🟢🟢🟢🟢🟢🟢🔴 | | ||
| |  | **Mi Router 3** | R3 | 🟢🟢🟢🟢 ➖ 🟢🟢🟢🟢🟢🟢🟢🔴 | | ||
| |  | **Mi Router 3G** | R3G | 🟢🟢🟢🟢 ➖ 🟢🟢🟢🟢🟢🟢🟢🔴 | | ||
| |  | **Mi Router Lite** | R1CL | 🟢🟢🟢🟢 ➖ 🟢🟢🟢🟢🟢🟢🟢🔴 | | ||
| |  | **Mi Router Mini** | R1CM | 🟢🟢🟢🟢 ➖ 🟢🟢🟢🟢🟢🟢🟢🔴 | | ||
| |  | **Mi Router R2D** | R2D | 🟢🟢🟢🟢 ➖ 🟢🟢🟢🟢🟢🟢🟢🔴 | | ||
| |  | **Mi Router R1D** | R1D | 🟢🟢🟢🟢 ➖ 🟢🟢🟢🟢🟢🟢🟢🔴 | | ||
Oops, something went wrong.