jeans/home-assistant.io
jeans/home-assistant.io
1
0
Fork 0
mirror of https://github.com/home-assistant/home-assistant.io.git synced 2025-05-02 09:17:35 +00:00
Code Issues Packages Projects Releases Wiki Activity
home-assistant.io/source/_components/binary_sensor.ping.markdown
Fabian Affolter 580d5d20db
Fix category
2017-04-25 20:48:14 +02:00

1.2 KiB
Raw Blame History

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

The ping binary sensor platform allows you to using 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.

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 variables:

  • host (Required): The IP address or hostname of the system you want to track.
  • count (Optional): Number of packets to send. Defaults to 5.
  • name (Optional): Let you overwrite the name of the device. Defaults to Ping Binary sensor.

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

This sensor was only tested on a Linux-based system.