From c84fbb2a5a7d602de52087cb049fff5a0cfa1859 Mon Sep 17 00:00:00 2001 From: Fabian Affolter Date: Sat, 7 Jan 2017 11:39:53 +0100 Subject: [PATCH] Add ping docs (#1723) * Add ping docs * Fix style and update wording (thanks @michaelarnauts) --- .../_components/device_tracker.ping.markdown | 33 +++++++++++++++++++ 1 file changed, 33 insertions(+) create mode 100644 source/_components/device_tracker.ping.markdown diff --git a/source/_components/device_tracker.ping.markdown b/source/_components/device_tracker.ping.markdown new file mode 100644 index 00000000000..79798811983 --- /dev/null +++ b/source/_components/device_tracker.ping.markdown @@ -0,0 +1,33 @@ +--- +layout: page +title: "Ping (ICMP)" +description: "Instructions how to integrate Ping (ICMP)-based presence detection into Home Assistant." +date: 2017-01-06 08:00 +sidebar: true +comments: false +sharing: true +footer: true +logo: home-assistant.png +ha_category: Presence Detection +ha_release: 0.36 +--- + + +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. + +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 variables: + +- **hosts** array (*Required*): List of device names and their corresponding IP address or hostname. +- **count** (*Optional*): Number of packet used for each device (avoid false detection). + +See the [device tracker component page](/components/device_tracker/) for instructions how to configure the people to be tracked.