Skip to content

Latest commit

 

History

History
98 lines (63 loc) · 5.19 KB

sensors.md

File metadata and controls

98 lines (63 loc) · 5.19 KB

Sensors

The component creates a separate device for each router connected to the mesh network.

Devices

Each device has its own set of sensors.

The primary router has more sensors than the additional ones.

Primary router sensors:

Primary device

Additional router sensors:

Additional device

Number of connected devices

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 - number of devices connected to the primary router *
  • sensor.<integration_name>_total_clients - total number of devices connected to the mesh network

Clients sensor

Also, one sensor is created for each additional router in the mesh network: *

  • sensor.<integration_name>_clients_<router_name>

Clients sensor

* These sensors will not be added if individual client sensors are not enabled in advanced options.

Note: Sensors for additional routers are located in their own devices.

Each sensor exposes the following attributes:

Attribute Description
guest_clients Number of devices connected to the guest network
hilink_clients Number of devices connected via HiLink
wireless_clients Number of devices connected wirelessly
lan_clients Number of devices connected by cable
wifi_2_4_clients Number of devices connected to Wi-Fi 2.4 GHz
wifi_5_clients Number of devices connected to Wi-Fi 5 GHz
tagged_<tag_name>_clients Number of connected devices with a specific tag <tag_name>
untagged_clients Number of connected devices without any tags

Uptime

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

Also, one sensor is created for each additional router in the mesh network:

  • sensor.<integration_name>_uptime_<router_name>

Uptime sensor

Note: Sensors for additional routers are located in their own devices. The sensor value may not be entirely accurate if the clocks on the router and on the Home Assistant server are out of sync.

Each sensor exposes the following attributes:

Attribute Description
seconds Uptime of the router in seconds

Internet connection

The component is able to track information about the connection of the router to the Internet. 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

Internet connection sensor

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
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.