mirror of
https://github.com/home-assistant/home-assistant.io.git
synced 2025-06-03 00:36:50 +00:00
c464056402
* 🔥 Removes octopress.js * 🔥 Removes use of root_url var * 🔥 Removes Octopress generator reference from feed * 🔥 Removes delicious support * 🔥 Removes support for Pinboard * 🔥 Removes support for Disqus * 🔥 Removes support for Google Plus * ↩️ Migrate custom after_footer to default template * ↩️ Migrate custom footer to default template * ↩️ Migrate custom header to default template * 🔥 Removes unused template files * 🚀 Places time to read directly in post template * 🚀 Removes unneeded capture from archive_post.html template * 🔥 🚀 Removes unused, but heaving sorting call in component page * 🚀 Merged javascripts into a single file * 🔥 Removes more uses of root_url * 🚀 Removal of unneeded captures from head * 🔥 🚀 Removal of expensive liquid HTML compressor * 🔥 Removes unneeded templates * 🚀 Replaces kramdown with GitHub's CommonMark 🚀 * 💄 Adds Prism code syntax highlighting * ✨ Adds support for redirect in Netlify * ↩️ 🔥 Let Netlify handle all developer doc redirects * ✏️ Fixes typo in redirects file: Netify -> Netlify * 🔥 Removes unused .themes folder * 🔥 Removes unused aside.html template * 🔥 Removes Disqus config leftover * 🔥 Removes rouge highlighter config * 🔥 Removes Octopress 🎉 * 💄 Adjust code block font size and adds soft wraps * 💄 Adds styling for inline code blocks * 💄 Improve styling of note/warning/info boxes + div support * 🔨 Rewrites all note/warning/info boxes
105 lines
3.5 KiB
Markdown
105 lines
3.5 KiB
Markdown
---
|
|
title: "Ping (ICMP)"
|
|
description: "Instructions on how to integrate Ping (ICMP)-based into Home Assistant."
|
|
logo: home-assistant.png
|
|
ha_category:
|
|
- Network
|
|
- Binary Sensor
|
|
- Presence Detection
|
|
ha_release: 0.43
|
|
ha_qa_scale: internal
|
|
redirect_from:
|
|
- /components/binary_sensor.ping/
|
|
- /components/device_tracker.ping/
|
|
---
|
|
|
|
There is currently support for the following device types within Home Assistant:
|
|
|
|
- [Binary Sensor](#binary-sensor)
|
|
- [Presence Detection](#presence-detection)
|
|
|
|
## 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.
|
|
|
|
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 integrations [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
|
|
```
|
|
|
|
<div class='note'>
|
|
When run on Windows systems, the round trip time attributes are rounded to the nearest millisecond and the mdev value is unavailable.
|
|
</div>
|
|
|
|
## 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.
|
|
|
|
<div class='note'>
|
|
Please keep in mind that modern smart phones will usually turn off WiFi when they are idle. Simple trackers like this may not be reliable on their own.
|
|
</div>
|
|
|
|
### Configuration
|
|
|
|
To use this presence detection in your installation, add the following to your `configuration.yaml` file:
|
|
|
|
```yaml
|
|
# Example configuration.yaml entry
|
|
device_tracker:
|
|
- platform: ping
|
|
hosts:
|
|
hostone: 192.168.2.10
|
|
```
|
|
|
|
{% configuration %}
|
|
hosts:
|
|
description: List of device names and their corresponding IP address or hostname.
|
|
required: true
|
|
type: list
|
|
count:
|
|
description: Number of packet used for each device (avoid false detection).
|
|
required: false
|
|
type: integer
|
|
{% endconfiguration %}
|
|
|
|
See the [device tracker integration page](/components/device_tracker/) for instructions how to configure the people to be tracked.
|