From a49c8395148810cca7412dfe978b30a117881665 Mon Sep 17 00:00:00 2001 From: trainman419 Date: Mon, 15 Dec 2014 11:22:10 -0800 Subject: [PATCH] Add nmap_tracker documentation --- README.md | 8 ++++++++ config/home-assistant.conf.example | 5 ++++- 2 files changed, 12 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 26b9460e53a..215eccff76a 100644 --- a/README.md +++ b/README.md @@ -91,6 +91,14 @@ password=MY_PASSWORD Once tracking the `device_tracker` component will maintain a file in your config dir called `known_devices.csv`. Edit this file to adjust which devices have to be tracked. +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`). + +``` +[device_tracker] +platform=nmap_tracker +hosts=192.168.1.1/24 +``` + ## Further customizing Home Assistant diff --git a/config/home-assistant.conf.example b/config/home-assistant.conf.example index e5f8db42a9b..0edd11e98f6 100644 --- a/config/home-assistant.conf.example +++ b/config/home-assistant.conf.example @@ -12,13 +12,16 @@ api_password=mypass platform=hue [device_tracker] -# The following types are available: netgear, tomato, luci +# The following types are available: netgear, tomato, luci, nmap_tracker platform=netgear host=192.168.1.1 username=admin password=PASSWORD # http_id is needed for Tomato routers only # http_id=ABCDEFGHH +# For nmap_tracker, only the IP addresses to scan are needed: +# hosts=192.168.1.1/24 # netmask prefix notation or +# hosts=192.168.1.1-255 # address range [chromecast] # Optional: hard code the hosts (comma seperated) to find chromecasts