home-assistant.io/source/_integrations/nmap_tracker.markdown
2021-08-26 21:54:08 +02:00

1.7 KiB

title, description, ha_category, ha_release, ha_iot_class, ha_domain, ha_platforms, ha_config_flow, ha_codeowners
title description ha_category ha_release ha_iot_class ha_domain ha_platforms ha_config_flow ha_codeowners
Nmap Tracker Instructions on how to integrate Nmap into Home Assistant.
Presence Detection
0.7 Local Polling nmap_tracker
device_tracker
true
@bdraco

As an alternative to the router-based device tracking, it is possible to directly scan the network for devices by using Nmap. The IP addresses to scan can be specified in any format that Nmap understands, including the network-prefix notation (192.168.1.1/24) and the range notation (192.168.1.1-255).

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.

If you are running Home Assistant Core in a Python virtual environment, you might have to install the packages for arp and nmap. On Debian based hosts (for example Raspbian) do so by running sudo apt-get install net-tools nmap. On a Fedora host run sudo dnf -y install nmap.

{% include integrations/config_flow.md %}

An example of how the Nmap scanner can be customized:

Linux capabilities

On Linux systems (such as Hass.io) you can extend the functionality of Nmap, without having to run it as root, by using Linux capabilities. Be sure to specify the full path to wherever you installed Nmap:

sudo setcap cap_net_raw,cap_net_admin,cap_net_bind_service+eip /usr/bin/nmap

And you can set up the device tracker scan options with --privileged -sn

See the device tracker integration page for instructions how to configure the people to be tracked.