home-assistant.io/source/_components/binary_sensor.ping.markdown

layout	title	description	date	sidebar	comments	sharing	footer	logo	ha_category	ha_release	ha_qa_scale
page	Ping (ICMP) Binary sensor	Instructions on how to integrate Ping (ICMP)-based binary sensors into Home Assistant.	2017-04-11 08:00	true	false	true	true	home-assistant.png	Network	0.43	internal

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.

{% linkable_title Configuration %}

To use this sensor in your installation, add the following to your configuration.yaml file:

# Example configuration.yaml entry
binary_sensor:
  - platform: ping
    host: 192.168.0.1

{% configuration %} host: description: The IP address or hostname of the system you want to track. required: true type: string count: description: Number of packets to send. required: false type: integer default: 5 name: description: Let you overwrite the name of the device. required: false type: string default: Ping Binary sensor {% endconfiguration %}

The sensor exposes the different round trip times values measured by ping as attributes:

• round trip time mdev
• round trip time avg
• round trip time min
• round trip time max

The default polling interval is 5 minutes. As many components based on the entity class, it is possible to overwrite this scan interval by specifying a scan_interval configuration key (value in seconds). In the example below we setup the ping binary sensor to poll the devices every 30 seconds.

# Example configuration.yaml entry to ping host 192.168.0.1 with 2 packets every 30 seconds.
binary_sensor:
  - platform: ping
    host: 192.168.0.1
    count: 2
    scan_interval: 30

When run on Windows systems, the round trip time attributes are rounded to the nearest millisecond and the mdev value is unavailable.