3.2 KiB
title, description, ha_category, ha_release, ha_iot_class, ha_quality_scale, ha_domain, ha_platforms, ha_integration_type, ha_config_flow, ha_codeowners
title | description | ha_category | ha_release | ha_iot_class | ha_quality_scale | ha_domain | ha_platforms | ha_integration_type | ha_config_flow | ha_codeowners | ||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Ping (ICMP) | Instructions on how to integrate Ping (ICMP)-based into Home Assistant. |
|
0.43 | Local Polling | internal | ping |
|
integration | true |
|
There is currently support for the following device types within Home Assistant:
{% include integrations/config_flow.md %}
Polling interval
By default, the integration will ping the device every 30 seconds. If you wish to do a ping at a different interval, you can disable the automatic refresh in the integration's system options (Enable polling for updates) and create your own automation with your desired frequency.
For more detailed steps on how to define a custom interval, follow the procedure below.
Defining a custom polling interval
{% include common-tasks/define_custom_polling.md %}
Integration options
It is possible to change some behaviors through the integration options. To change the settings, go to {% my integrations title="Settings > Devices & Services" %}. Select the Ping integration, then select Configure.
- Ping count: Number of echo requests to send to the target. The default is 5.
- Consider home: Number of seconds that must elapse before considering a disconnected device "not at home". The default is 180 seconds (3 minutes).
Binary sensor
The ping
binary sensor platform allows you to use ping
to send ICMP echo requests. This way you can check if a given host is online and determine the round trip times from your Home Assistant instance to that system.
This sensor is enabled by default. The default polling interval is 30 seconds.
The sensor exposes the different round trip times in milliseconds measured by ping
as attributes:
round_trip_time_mdev
- the standard deviationround_trip_time_avg
- the average round trip timeround_trip_time_min
- the shortest round trip timeround_trip_time_max
- the longest round trip time
Presence detection
The ping
device tracker platform offers presence detection by using ping
to send ICMP echo requests. This can be useful when devices are running a firewall and are blocking UDP or TCP packets but responding to ICMP requests (like Android phones). This tracker doesn't need to know the MAC address since the host can be on a different subnet. This makes this an option to detect hosts on a different subnet when nmap
or other solutions don't work since arp
doesn't work.
The device tracker is disabled by default and can be enabled in the UI.
See the person integration page for instructions on how to configure the people to be tracked.