mirror of
https://github.com/home-assistant/home-assistant.io.git
synced 2025-05-02 17:18:58 +00:00
683ff69383
Fixes typo in the first sentence of "Ping (ICMP) Binary sensor" docs: https://www.home-assistant.io/components/binary_sensor.ping/
67 lines
2.0 KiB
Markdown
67 lines
2.0 KiB
Markdown
---
|
|
layout: page
|
|
title: "Ping (ICMP) Binary sensor"
|
|
description: "Instructions on how to integrate Ping (ICMP)-based binary sensors into Home Assistant."
|
|
date: 2017-04-11 08:00
|
|
sidebar: true
|
|
comments: false
|
|
sharing: true
|
|
footer: true
|
|
logo: home-assistant.png
|
|
ha_category: Network
|
|
ha_release: 0.43
|
|
ha_qa_scale: 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:
|
|
|
|
```yaml
|
|
# 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](/docs/configuration/platform_options), 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.
|
|
|
|
```yaml
|
|
# 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
|
|
```
|
|
|
|
<p class='note'>
|
|
When run on Windows systems, the round trip time attributes are rounded to the nearest millisecond and the mdev value is unavailable.
|
|
</p>
|