Skip to content

Commit c84fbb2

Browse files
authored
Add ping docs (home-assistant#1723)
* Add ping docs * Fix style and update wording (thanks @michaelarnauts)
1 parent cecd1ff commit c84fbb2

File tree

1 file changed

+33
-0
lines changed

1 file changed

+33
-0
lines changed
Lines changed: 33 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,33 @@
1+
---
2+
layout: page
3+
title: "Ping (ICMP)"
4+
description: "Instructions how to integrate Ping (ICMP)-based presence detection into Home Assistant."
5+
date: 2017-01-06 08:00
6+
sidebar: true
7+
comments: false
8+
sharing: true
9+
footer: true
10+
logo: home-assistant.png
11+
ha_category: Presence Detection
12+
ha_release: 0.36
13+
---
14+
15+
16+
The `ping` 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.
17+
18+
To use this presence detection in your installation, add the following to your `configuration.yaml` file:
19+
20+
```yaml
21+
# Example configuration.yaml entry
22+
device_tracker:
23+
- platform: ping
24+
hosts:
25+
hostone: 192.168.2.10
26+
```
27+
28+
Configuration variables:
29+
30+
- **hosts** array (*Required*): List of device names and their corresponding IP address or hostname.
31+
- **count** (*Optional*): Number of packet used for each device (avoid false detection).
32+
33+
See the [device tracker component page](/components/device_tracker/) for instructions how to configure the people to be tracked.

0 commit comments

Comments
 (0)