Arpscan Device Tracker Component

This is a Custom Component for Home-Assistant (https://home-assistant.io) that tracks devices using the arp-scan linux command, it's very fast, and reasonably accurate.

Installation

HACS - Recommended

• Have HACS installed, this will allow you to easily manage and track updates.
• Search for 'Arpscan'.
• Click Install below the found integration.
• Configure using the configuration instructions below.
• Restart Home-Assistant.

Manual

• Copy directory custom_components/arpscan_tracker to your <config dir>/custom_components directory.

• Install the arp-scan command and set it's sticky bit, so it can be run as root.

  NOTE: This step is not needed on Hass.io, it contains the arp-scan command already.

  $ sudo apt-get install arp-scan
  $ sudo chmod +s /usr/bin/arp-scan

• Configure with config below.
• Restart Home-Assistant.

Usage

To use this component in your installation, add the following to your configuration.yaml file:

# Example configuration.yaml entry with exclude

device_tracker:
  - platform: arpscan_tracker
    interval_seconds: 15
    consider_home: 60
    track_new_devices: true
    exclude:
      - 192.168.178.1
      - 192.168.178.3

or

# Example configuration.yaml entry with include

device_tracker:
  - platform: arpscan_tracker
    interval_seconds: 15
    consider_home: 60
    track_new_devices: false
    include:
      - 192.168.178.1
      - 192.168.178.3

Configuration variables:

• interval_seconds (Optional) Seconds between each scan for new devices. (default = 12)
• consider_home (Optional): Seconds to marking device as 'not home' after not being seen (default = 180)
• track_new_device (Optional): If new discovered devices are tracked by default. (default = True)
• exclude (Optional): List of IP addresses to skip tracking for.
• include (Optional): List of IP addresses to track only them. If specified, exclude will be ignored
• scan_options (Optional): Configurable scan options for arp-scan. (default is -l -g -t1 -q)

Network adapter

Sometimes your host has more than one network adapter (on Hass.io for example), and you need to figure out which one to use for the scans, you can specify the correct one using scan_options.

Examples:

scan_options: " --interface=enp2s0 192.168.178.0/24 -g"

LAN interface:

scan_options: " --interface=eth0 192.168.1.0/24 -g"

Debugging

Add the relevant lines below to the configuration.yaml:

logger:
  default: info
  logs:
    custom_components.arpscan_tracker: debug

Donation