diff --git a/README.md b/README.md index 30e9049..0fc21ef 100644 --- a/README.md +++ b/README.md @@ -22,7 +22,7 @@ Home Assistant custom component for control Huawei mesh routers over LAN. - obtaining information about all routers and connected devices in the entire mesh network: - connected devices tracking and tagging - - device connection parameters (frequency, signal strength, guest and hilink devices) + - device connection parameters (frequency, signal strength, guest and hilink devices, upload/download rates) - name of the specific router to which the device is connected - number of connected devices (total and for each individual router) - Wi-Fi access management: @@ -32,7 +32,7 @@ Home Assistant custom component for control Huawei mesh routers over LAN. - Wi-Fi access switch per client device - enabling and disabling access to specific sites - hardware and firmware version of the primary router -- internet connection details +- Internet connection details (IP address, status, upload/download rates) - uptime of each router - control of the NFC (OneHop Connect) on each router separately - control of the Fast Roaming function (802.11r) diff --git a/custom_components/huawei_mesh_router/manifest.json b/custom_components/huawei_mesh_router/manifest.json index b2573de..521a387 100644 --- a/custom_components/huawei_mesh_router/manifest.json +++ b/custom_components/huawei_mesh_router/manifest.json @@ -13,5 +13,5 @@ "iot_class": "local_polling", "issue_tracker": "https://github.com/vmakeev/huawei_mesh_router/issues", "requirements": ["pycryptodome>=3.12.0"], - "version": "0.9.0.2" + "version": "0.9.1" } diff --git a/docs/device-tracking.md b/docs/device-tracking.md index 54e7b23..f36f6bc 100644 --- a/docs/device-tracking.md +++ b/docs/device-tracking.md @@ -6,26 +6,32 @@ This feature is disabled by default and can be enabled in [advanced options](../ Each tracked device exposes the following attributes: -| Attribute | Description | Only when connected | -|------------------|--------------------------------------------------------------------------------------------------------------------------|---------------------| -| `source_type` | `router` if the router-specific zones are disabled in [advanced options](../README.md#advanced-options), `gps` otherwise | No | -| `ip` | Device IP address | Yes | -| `mac` | MAC address of the device | No | -| `hostname` | Device name according to the device itself | No | -| `connected_via` | The name of the router through which the connection was made | Yes | -| `interface_type` | Connection interface type (`5GHz`, `2.4GHz`, `LAN`) | Yes | -| `rssi` | Signal strength for wireless connections | Yes | -| `is_guest` | Is the device connected to the guest network | Yes | -| `is_hilink` | Is the device connected via HiLink | Yes | -| `is_router` | Is the device are router | Yes | -| `tags` | List of [tags](device-tags.md#device-tags) that marked the device | No | -| `filter_list` | Blacklist, Whitelist or None (see [access control mode](controls.md#wi-fi-access-control-mode)) | No | -| `friendly_name` | Device name provided by the router | No | +| Attribute | Description | Only when connected | +|-----------------------------|--------------------------------------------------------------------------------------------------------------------------|---------------------| +| `source_type` | `router` if the router-specific zones are disabled in [advanced options](../README.md#advanced-options), `gps` otherwise | No | +| `ip` | Device IP address | Yes | +| `mac` | MAC address of the device | No | +| `hostname` | Device name according to the device itself | No | +| `connected_via` | The name of the router through which the connection was made | Yes | +| `interface_type` | Connection interface type (`5GHz`, `2.4GHz`, `LAN`) | Yes | +| `rssi` | Signal strength for wireless connections | Yes | +| `is_guest` | Is the device connected to the guest network | Yes | +| `is_hilink` | Is the device connected via HiLink | Yes | +| `is_router` | Is the device are router | Yes | +| `upload_rate_kilobytes_s` | Current upload speed in kilobytes per second | Yes | +| `download_rate_kilobytes_s` | Current download speed in kilobytes per second | Yes | +| `upload_rate` | Human-readable current upload speed | Yes | +| `download_rate` | Human-readable current download speed | Yes | +| `tags` | List of [tags](device-tags.md#device-tags) that marked the device | No | +| `filter_list` | Blacklist, Whitelist or None (see [access control mode](controls.md#wi-fi-access-control-mode)) | No | +| `friendly_name` | Device name provided by the router | No | ![Device tracker](images/device_tracker.png) Tracked device names, including routers, can be changed in [your mesh control interface](http://192.168.3.1/html/index.html#/devicecontrol), after which the component will update them in Home Assistant +_Note: The `upload_rate_kilobytes_s`/`download_rate_kilobytes_s` are specified in kilobytes, not in kilobits. To convert it to kilobits per second, the value must be multiplied by 8. The values are updated at the interval specified in the [advanced options](../README.md#advanced-options)._ + An example of a markdown card that displays some of the information about the tracked device: ``` diff --git a/docs/images/device_tracker.png b/docs/images/device_tracker.png index dd49fc7..f63e2aa 100644 Binary files a/docs/images/device_tracker.png and b/docs/images/device_tracker.png differ diff --git a/docs/images/sensor_internet_connection.png b/docs/images/sensor_internet_connection.png index db5acfb..13d2eb9 100644 Binary files a/docs/images/sensor_internet_connection.png and b/docs/images/sensor_internet_connection.png differ diff --git a/docs/sensors.md b/docs/sensors.md index be70c68..cbf7804 100644 --- a/docs/sensors.md +++ b/docs/sensors.md @@ -83,10 +83,16 @@ _Note: Sensors for additional routers are located in their own devices._ Each sensor exposes the following attributes: -| Attribute | Description | -|----------------------|-------------------------------------------------------------| -| `external_ip` | WAN IP address | -| `uptime_seconds` | Connection uptime in seconds | -| `connected_at` | The date and time when the connection was last established | - -_Note: The `connected_at` attribute value may not be entirely accurate if the clocks on the router and on the Home Assistant server are out of sync._ \ No newline at end of file +| Attribute | Description | +|-----------------------------|-------------------------------------------------------------| +| `external_ip` | WAN IP address | +| `uptime_seconds` | Connection uptime in seconds | +| `connected_at` | The date and time when the connection was last established | +| `upload_rate_kilobytes_s` | Current upload speed in kilobytes per second | +| `download_rate_kilobytes_s` | Current download speed in kilobytes per second | +| `upload_rate` | Human-readable current upload speed | +| `download_rate` | Human-readable current download speed | + +_Note: The `connected_at` attribute value may not be entirely accurate if the clocks on the router and on the Home Assistant server are out of sync._ + +_Note: The `upload_rate_kilobytes_s`/`download_rate_kilobytes_s` are specified in kilobytes, not in kilobits. To convert it to kilobits per second, the value must be multiplied by 8. The values are updated at the interval specified in the [advanced options](../README.md#advanced-options)._ \ No newline at end of file