Skip to content

Commit

Permalink
Updated documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
@vmakeev
vmakeev committed Jan 8, 2024
1 parent 338e573 commit f166955
Show file tree
Hide file tree
Showing 6 changed files with 37 additions and 25 deletions.
4 changes: 2 additions & 2 deletions README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -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:
Expand All @@ -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)
Expand Down
2 changes: 1 addition & 1 deletion custom_components/huawei_mesh_router/manifest.json
View file
Original file line number Diff line number Diff line change
Expand Up @@ -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"
}
36 changes: 21 additions & 15 deletions docs/device-tracking.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -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:

```
Expand Down
Binary file modified docs/images/device_tracker.png
View file
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs/images/sensor_internet_connection.png
View file
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
20 changes: 13 additions & 7 deletions docs/sensors.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -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._
| 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)._

0 comments on commit f166955

Please sign in to comment.