Skip to content

Commit

Permalink
Documentation improvements
Browse files Browse the repository at this point in the history
  • Loading branch information
vmakeev committed Feb 3, 2023
1 parent 07360d5 commit 6490acc
Show file tree
Hide file tree
Showing 2 changed files with 6 additions and 6 deletions.
4 changes: 2 additions & 2 deletions docs/controls.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ The primary router has more controls than the additional ones.
Allows you to reboot the selected router.

There is one button that is always present:
* `button.<integration_name>_reboot_primary_router`
* `button.<integration_name>_reboot`

Also, one button is created for each additional router in the mesh network:
* `button.<integration_name>_reboot_<router_name>`
Expand All @@ -40,7 +40,7 @@ Allows you to manage the [OneHop connect](https://consumer.huawei.com/ph/support
The switches will not be added to Home Assistant if the router does not support NFC.

Primary router have the following switch:
* `switch.<integration_name>_nfc_primary_router`
* `switch.<integration_name>_nfc`

Also, one switch is created for each supported additional router in the mesh network:
* `switch.<integration_name>_nfc_<router_name>`
Expand Down
8 changes: 4 additions & 4 deletions docs/sensors.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,8 +21,8 @@ The primary router has more sensors than the additional ones.
The component provides the ability to obtain the number of connected devices both to the entire mesh network and to specific routers using sensors.

There are two sensors for Primary router:
* `sensor.<integration_name>_clients_primary_router` - number of devices connected to the primary router **\***
* `sensor.<integration_name>_total_clients_primary_router` - total number of devices connected to the mesh network
* `sensor.<integration_name>_clients` - number of devices connected to the primary router **\***
* `sensor.<integration_name>_total_clients` - total number of devices connected to the mesh network

![Clients sensor](images/sensor_total_clients.png)

Expand Down Expand Up @@ -54,7 +54,7 @@ The component allows you to get the uptime of each router in your mesh network.
The sensor value is the date and time when the router was last turned on.

There is one sensor that is always present:
* `sensor.<integration_name>_uptime_primary_router`
* `sensor.<integration_name>_uptime`

Also, one sensor is created for each additional router in the mesh network:
* `sensor.<integration_name>_uptime_<router_name>`
Expand All @@ -75,7 +75,7 @@ The component is able to track information about the connection of the router to
The sensor is in the "on" state if the Internet connection is established.

There is one sensor that is always present:
* `binary_sensor.<integration_name>_internet_connection_primary_router`
* `binary_sensor.<integration_name>_internet_connection`

![Internet connection sensor](images/sensor_internet_connection.png)

Expand Down

0 comments on commit 6490acc

Please sign in to comment.