jeena/home-assistant.github.io
1
0
Fork 0
Code Issues Pull requests Projects Packages Wiki Activity Actions

Minimizing of the configuration sample (#1040)

Browse source
This commit is contained in:
Fabian Affolter 2016-10-02 17:13:58 +02:00 • committed by GitHub
parent 1ee63170cf
commit be80d1bb7b
23 changed files with 151 additions and 130 deletions
Download patch file Download diff file Expand all files Collapse all files

26
source/_components/device_tracker.nmap_tracker.markdown
View file

@ -15,25 +15,35 @@ featured: false
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`).
If you're on Debian or Ubuntu, you might have to install the packages for `arp` and `nmap`. Do so by running `apt-get install net-tools nmap`. On a Fedora host run `sudo dnf -y install nmap`.
If you're on Debian or Ubuntu, you might have to install the packages for `arp` and `nmap`. Do so by running `$ sudo apt-get install net-tools nmap`. On a Fedora host run `$ sudo dnf -y install nmap`.
To use this device tracker in your installation, add the following to your `configuration.yaml` file:
```yaml
# Example configuration.yaml entry
device_tracker:
platform: nmap_tracker
hosts: 192.168.1.1/24
home_interval: 10
exclude:
- 192.168.1.12
- 192.168.1.13
- platform: nmap_tracker
hosts: 192.168.1.1/24
```
Configuration variables:
- **hosts** (*Required*): The network range to scan in CIDR notation, eg. 192.168.1.1/24
- **hosts** (*Required*): The network range to scan in CIDR notation, eg. `192.168.1.1/24`.
- **home_interval** (*Optional*): The number of minutes nmap will not scan this device, assuming it is home, in order to preserve the device battery.
- **exclude** (*Optional*): Hosts not to include in nmap scanning.
A full example for the `nmap` tracker could look like the following sample:
```yaml
# Example configuration.yaml entry for nmap
device_tracker:
- platform: nmap_tracker
hosts: 192.168.1.1/24
home_interval: 10
exclude:
- 192.168.1.12
- 192.168.1.13
```
See the [device tracker component page](/components/device_tracker/) for instructions how to configure the people to be tracked.