Added options

Author: cyberjunky

CHANGELOG.md

@@ -1,5 +1,11 @@
 ## Changelog
 
+### 2.0.9
+
+- Added **Enable Found Devices** option to enable/disable all device tracker entities
+- Added **Track New Devices** option to control auto-creation of entities for newly discovered devices
+- Fixed mypy type errors in scanner.py
+
 ### 2.0.8
 
 - Added ZeroTier/VPN Hosts option to probe specific IPs instead of network scanning

README.md

@@ -81,6 +81,8 @@ Alternatively:
 | **Consider Home** | 180 seconds | Time before marking device as not_home (10-1800) |
 | **ARP Timeout** | 1.0 seconds | Timeout for each ARP request (0.5-10) |
 | **Resolve Hostnames** | Enabled | Look up device hostnames via reverse DNS |
+| **Enable Found Devices** | Enabled | Enable newly found device tracker entities by default |
+| **Track New Devices** | Enabled | Automatically create entities for newly discovered devices |
 | **Specific Hosts** | Empty | Probe only these IPs (for ZeroTier/VPN networks) |
 | **Include IPs** | Empty | Only track these IP addresses (comma-separated) |
 | **Exclude IPs** | Empty | Skip tracking these IP addresses (comma-separated) |
@@ -105,7 +107,8 @@ After initial setup, you can modify settings via:
 > [!NOTE]
 > All device trackers are separate devices—they aren't linked to ARP-Scanner instance by design.
 > If you see devices linked to the ARP-Scanner in the UI, it's Home Assistant linking other known devices because of MAC address matches.
-> All found devices are disabled by default, so you need to enable them in the Home Assistant UI.
+> When **Enable Found Devices** is off, new device trackers are added but disabled by default—enable them in the Home Assistant UI.
+> When **Track New Devices** is off, only previously known devices are tracked—new discoveries are ignored.
 
 ## Migration from YAML
 

custom_components/arpscan_tracker/__init__.py

@@ -118,17 +118,17 @@ async def async_update_data() -> dict[str, dict[str, Any]]:
 
         # Filter devices based on include/exclude lists
         result: dict[str, dict[str, Any]] = {}
-        _LOGGER.debug("Processing %d scanned devices (include_list=%s, exclude_list=%s)", 
+        _LOGGER.debug("Processing %d scanned devices (include_list=%s, exclude_list=%s)",
                       len(devices), include_list, exclude_list)
-        
+
         for device in devices:
             ip = device["ip"]
             mac = device["mac"]
 
             # Apply include filter (if specified, only include listed IPs)
             if include_list:
                 if ip not in include_list:
-                    _LOGGER.debug("Device %s (%s) not in include list %s, skipping", 
+                    _LOGGER.debug("Device %s (%s) not in include list %s, skipping",
                                   ip, mac, include_list)
                     continue
                 else:
@@ -147,7 +147,7 @@ async def async_update_data() -> dict[str, dict[str, Any]]:
                           ip, mac, device.get("hostname"), device.get("vendor"))
             result[mac] = device
 
-        _LOGGER.debug("ARP scan returned %d devices after filtering: %s", 
+        _LOGGER.debug("ARP scan returned %d devices after filtering: %s",
                       len(result), list(result.keys()))
         return result
 

custom_components/arpscan_tracker/config_flow.py

@@ -18,6 +18,7 @@
 
 from .const import (
     CONF_CONSIDER_HOME,
+    CONF_DEVICES_ENABLED,
     CONF_EXCLUDE,
     CONF_HOSTS,
     CONF_INCLUDE,
@@ -26,10 +27,13 @@
     CONF_RESOLVE_HOSTNAMES,
     CONF_SCAN_INTERVAL,
     CONF_TIMEOUT,
+    CONF_TRACK_NEW_DEVICES,
     DEFAULT_CONSIDER_HOME,
+    DEFAULT_DEVICES_ENABLED,
     DEFAULT_RESOLVE_HOSTNAMES,
     DEFAULT_SCAN_INTERVAL,
     DEFAULT_TIMEOUT,
+    DEFAULT_TRACK_NEW_DEVICES,
     DOMAIN,
 )
 from .scanner import get_available_interfaces, get_default_interface, get_interface_network
@@ -140,6 +144,12 @@ async def async_step_user(self, user_input: dict[str, Any] | None = None) -> Con
                         CONF_RESOLVE_HOSTNAMES: user_input.get(
                             CONF_RESOLVE_HOSTNAMES, DEFAULT_RESOLVE_HOSTNAMES
                         ),
+                        CONF_DEVICES_ENABLED: user_input.get(
+                            CONF_DEVICES_ENABLED, DEFAULT_DEVICES_ENABLED
+                        ),
+                        CONF_TRACK_NEW_DEVICES: user_input.get(
+                            CONF_TRACK_NEW_DEVICES, DEFAULT_TRACK_NEW_DEVICES
+                        ),
                         CONF_INCLUDE: include_list,
                         CONF_EXCLUDE: exclude_list,
                         CONF_HOSTS: hosts_list,
@@ -177,6 +187,8 @@ async def async_step_user(self, user_input: dict[str, Any] | None = None) -> Con
                     vol.Coerce(float), vol.Range(min=0.5, max=10.0)
                 ),
                 vol.Optional(CONF_RESOLVE_HOSTNAMES, default=DEFAULT_RESOLVE_HOSTNAMES): bool,
+                vol.Optional(CONF_DEVICES_ENABLED, default=DEFAULT_DEVICES_ENABLED): bool,
+                vol.Optional(CONF_TRACK_NEW_DEVICES, default=DEFAULT_TRACK_NEW_DEVICES): bool,
                 vol.Optional(CONF_INCLUDE, default=""): str,
                 vol.Optional(CONF_EXCLUDE, default=""): str,
                 vol.Optional(CONF_HOSTS, default=""): str,
@@ -290,6 +302,12 @@ async def async_step_init(self, user_input: dict[str, Any] | None = None) -> Con
                     CONF_RESOLVE_HOSTNAMES: user_input.get(
                         CONF_RESOLVE_HOSTNAMES, DEFAULT_RESOLVE_HOSTNAMES
                     ),
+                    CONF_DEVICES_ENABLED: user_input.get(
+                        CONF_DEVICES_ENABLED, DEFAULT_DEVICES_ENABLED
+                    ),
+                    CONF_TRACK_NEW_DEVICES: user_input.get(
+                        CONF_TRACK_NEW_DEVICES, DEFAULT_TRACK_NEW_DEVICES
+                    ),
                     CONF_INCLUDE: include_list,
                     CONF_EXCLUDE: exclude_list,
                     CONF_HOSTS: hosts_list,
@@ -325,6 +343,18 @@ async def async_step_init(self, user_input: dict[str, Any] | None = None) -> Con
                         CONF_RESOLVE_HOSTNAMES, DEFAULT_RESOLVE_HOSTNAMES
                     ),
                 ): bool,
+                vol.Required(
+                    CONF_DEVICES_ENABLED,
+                    default=self.config_entry.options.get(
+                        CONF_DEVICES_ENABLED, DEFAULT_DEVICES_ENABLED
+                    ),
+                ): bool,
+                vol.Required(
+                    CONF_TRACK_NEW_DEVICES,
+                    default=self.config_entry.options.get(
+                        CONF_TRACK_NEW_DEVICES, DEFAULT_TRACK_NEW_DEVICES
+                    ),
+                ): bool,
                 vol.Optional(
                     CONF_INCLUDE,
                     default=", ".join(current_include) if current_include else "",

custom_components/arpscan_tracker/const.py

@@ -14,6 +14,8 @@
 CONF_TIMEOUT: Final = "timeout"
 CONF_RESOLVE_HOSTNAMES: Final = "resolve_hostnames"
 CONF_HOSTS: Final = "hosts"
+CONF_DEVICES_ENABLED: Final = "devices_enabled"
+CONF_TRACK_NEW_DEVICES: Final = "track_new_devices"
 
 # Defaults
 DEFAULT_SCAN_INTERVAL: Final = 15  # seconds
@@ -22,6 +24,8 @@
 DEFAULT_INTERFACE: Final = None  # Auto-detect
 DEFAULT_NETWORK: Final = None  # Auto-detect from interface
 DEFAULT_RESOLVE_HOSTNAMES: Final = True
+DEFAULT_DEVICES_ENABLED: Final = True
+DEFAULT_TRACK_NEW_DEVICES: Final = True
 
 # Platforms
 PLATFORMS: Final = ["device_tracker"]

custom_components/arpscan_tracker/device_tracker.py

@@ -23,9 +23,13 @@
     ATTR_MAC,
     ATTR_VENDOR,
     CONF_CONSIDER_HOME,
+    CONF_DEVICES_ENABLED,
     CONF_INTERFACE,
+    CONF_TRACK_NEW_DEVICES,
     DATA_COORDINATOR,
     DEFAULT_CONSIDER_HOME,
+    DEFAULT_DEVICES_ENABLED,
+    DEFAULT_TRACK_NEW_DEVICES,
     DOMAIN,
 )
 
@@ -46,6 +50,8 @@ async def async_setup_entry(
     if isinstance(consider_home, timedelta):
         consider_home = int(consider_home.total_seconds())
     interface = entry.data.get(CONF_INTERFACE, "unknown")
+    devices_enabled = entry.options.get(CONF_DEVICES_ENABLED, DEFAULT_DEVICES_ENABLED)
+    track_new_devices = entry.options.get(CONF_TRACK_NEW_DEVICES, DEFAULT_TRACK_NEW_DEVICES)
 
     # Track which devices we've already created entities for
     tracked_macs: set[str] = set()
@@ -73,6 +79,16 @@ async def async_setup_entry(
             )
             continue
 
+        # Update enabled/disabled state in registry based on config option
+        if devices_enabled and entity.disabled_by == er.RegistryEntryDisabler.INTEGRATION:
+            ent_reg.async_update_entity(entity.entity_id, disabled_by=None)
+            _LOGGER.info("Enabling device tracker %s (devices_enabled=True)", entity.entity_id)
+        elif not devices_enabled and entity.disabled_by is None:
+            ent_reg.async_update_entity(
+                entity.entity_id, disabled_by=er.RegistryEntryDisabler.INTEGRATION
+            )
+            _LOGGER.info("Disabling device tracker %s (devices_enabled=False)", entity.entity_id)
+
         if mac_formatted not in tracked_macs:
             tracked_macs.add(mac_formatted)
             restored_entities.append(
@@ -82,6 +98,7 @@ async def async_setup_entry(
                     consider_home=consider_home,
                     interface=interface,
                     entry_id=entry.entry_id,
+                    devices_enabled=devices_enabled,
                     restored_name=entity.original_name or entity.name,
                 )
             )
@@ -100,6 +117,10 @@ async def async_setup_entry(
     @callback
     def async_add_new_entities() -> None:
         """Add entities for newly discovered devices."""
+        if not track_new_devices:
+            _LOGGER.debug("Track new devices is disabled, skipping new entity creation")
+            return
+
         new_entities: list[ArpScanDeviceTracker] = []
 
         _LOGGER.debug("Checking for new entities: coordinator has %d devices, %d already tracked",
@@ -115,6 +136,7 @@ def async_add_new_entities() -> None:
                         consider_home=consider_home,
                         interface=interface,
                         entry_id=entry.entry_id,
+                        devices_enabled=devices_enabled,
                     )
                 )
                 _LOGGER.info("Creating NEW device tracker entity for MAC %s (IP: %s, hostname: %s)",
@@ -144,6 +166,7 @@ def __init__(
         consider_home: int,
         interface: str,
         entry_id: str,
+        devices_enabled: bool = True,
         restored_name: str | None = None,
     ) -> None:
         """Initialize the device tracker."""
@@ -153,6 +176,7 @@ def __init__(
         self._consider_home = consider_home
         self._interface = interface
         self._entry_id = entry_id
+        self._attr_entity_registry_enabled_default = devices_enabled
         self._last_seen: datetime | None = dt_util.utcnow() - timedelta(days=365)
 
         # Get initial device data

custom_components/arpscan_tracker/manifest.json

@@ -13,5 +13,5 @@
     "scapy>=2.5.0",
     "ouilookup>=0.2.4"
   ],
-  "version": "2.1.2"
+  "version": "2.1.3"
 }

custom_components/arpscan_tracker/scanner.py

@@ -208,7 +208,7 @@ def _get_interface_info(self, interface: str) -> tuple[str | None, str | None]:
             Tuple of (ip_address, mac_address) or (None, None) if not available
         """
         try:
-            from scapy.all import get_if_addr, get_if_hwaddr  # type: ignore[attr-defined]
+            from scapy.all import get_if_addr, get_if_hwaddr
 
             ip_addr = get_if_addr(interface)
             mac_addr = get_if_hwaddr(interface)
@@ -223,7 +223,8 @@ def _get_interface_info(self, interface: str) -> tuple[str | None, str | None]:
 
                     network = IPv4Network(network_str)
                     # Use the interface's actual IP (first host in network)
-                    ip_addr = str(next(network.hosts(), None))
+                    first_host = next(iter(network.hosts()), None)
+                    ip_addr = str(first_host) if first_host else "0.0.0.0"
 
             return (
                 ip_addr if ip_addr and ip_addr != "0.0.0.0" else None,

custom_components/arpscan_tracker/strings.json

@@ -11,6 +11,8 @@
                     "consider_home": "Consider Home",
                     "timeout": "ARP Timeout",
                     "resolve_hostnames": "Resolve Hostnames (DNS)",
+                    "devices_enabled": "Enable Found Devices",
+                    "track_new_devices": "Track New Devices",
                     "include": "Include IPs",
                     "exclude": "Exclude IPs",
                     "hosts": "ZeroTier/VPN Hosts (IPs)"
@@ -22,6 +24,8 @@
                     "consider_home": "How long to wait before marking a device as not home (10-1800 seconds)",
                     "timeout": "Timeout for each ARP request (0.5-10 seconds)",
                     "resolve_hostnames": "Look up device hostnames via reverse DNS lookup",
+                    "devices_enabled": "Enable newly found device tracker entities by default. When disabled, new entities are added but disabled in the entity registry.",
+                    "track_new_devices": "Automatically create device tracker entities for newly discovered devices. When disabled, only previously known devices are tracked.",
                     "include": "Only track devices with these IP addresses (comma-separated list)",
                     "exclude": "Skip tracking devices with these IP addresses (comma-separated list)",
                     "hosts": "Probe only these IPs instead of scanning the network (for ZeroTier, WireGuard, Tailscale, etc.)"
@@ -47,6 +51,8 @@
                     "consider_home": "Consider Home",
                     "timeout": "ARP Timeout",
                     "resolve_hostnames": "Resolve Hostnames (DNS)",
+                    "devices_enabled": "Enable Found Devices",
+                    "track_new_devices": "Track New Devices",
                     "hosts": "ZeroTier/VPN Hosts (IPs)",
                     "include": "Include IPs",
                     "exclude": "Exclude IPs"
@@ -56,6 +62,8 @@
                     "consider_home": "How long to wait before marking a device as not home (10-1800 seconds)",
                     "timeout": "Timeout for each ARP request (0.5-10 seconds)",
                     "resolve_hostnames": "Look up device hostnames via reverse DNS lookup (may slow down scans)",
+                    "devices_enabled": "Enable newly found device tracker entities by default. When disabled, new entities are added but disabled in the entity registry.",
+                    "track_new_devices": "Automatically create device tracker entities for newly discovered devices. When disabled, only previously known devices are tracked.",
                     "hosts": "Probe only these IPs instead of scanning the network (for ZeroTier, WireGuard, Tailscale, etc.)",
                     "include": "Only track devices with these IP addresses (comma-separated list)",
                     "exclude": "Skip tracking devices with these IP addresses (comma-separated list)"

custom_components/arpscan_tracker/translations/en.json

@@ -7,10 +7,12 @@
                 "data": {
                     "interface": "Network Interface",
                     "network": "Network Range (CIDR)",
-                    "scan_interval": "Scan Interval (seconds)",
-                    "consider_home": "Consider Home (seconds)",
-                    "timeout": "ARP Timeout (seconds)",
+                    "scan_interval": "Scan Interval",
+                    "consider_home": "Consider Home",
+                    "timeout": "ARP Timeout",
                     "resolve_hostnames": "Resolve Hostnames (DNS)",
+                    "devices_enabled": "Enable Found Devices",
+                    "track_new_devices": "Track New Devices",
                     "include": "Include IPs",
                     "exclude": "Exclude IPs",
                     "hosts": "ZeroTier/VPN Hosts (IPs)"
@@ -22,6 +24,8 @@
                     "consider_home": "How long to wait before marking a device as not home (10-1800 seconds)",
                     "timeout": "Timeout for each ARP request (0.5-10 seconds)",
                     "resolve_hostnames": "Look up device hostnames via reverse DNS lookup",
+                    "devices_enabled": "Enable newly found device tracker entities by default. When disabled, new entities are added but disabled in the entity registry.",
+                    "track_new_devices": "Automatically create device tracker entities for newly discovered devices. When disabled, only previously known devices are tracked.",
                     "include": "Only track devices with these IP addresses (comma-separated list)",
                     "exclude": "Skip tracking devices with these IP addresses (comma-separated list)",
                     "hosts": "Probe only these IPs instead of scanning the network (for ZeroTier, WireGuard, Tailscale, etc.)"
@@ -47,6 +51,8 @@
                     "consider_home": "Consider Home",
                     "timeout": "ARP Timeout",
                     "resolve_hostnames": "Resolve Hostnames (DNS)",
+                    "devices_enabled": "Enable Found Devices",
+                    "track_new_devices": "Track New Devices",
                     "hosts": "ZeroTier/VPN Hosts (IPs)",
                     "include": "Include IPs",
                     "exclude": "Exclude IPs"
@@ -56,6 +62,8 @@
                     "consider_home": "How long to wait before marking a device as not home (10-1800 seconds)",
                     "timeout": "Timeout for each ARP request (0.5-10 seconds)",
                     "resolve_hostnames": "Look up device hostnames via reverse DNS lookup (may slow down scans)",
+                    "devices_enabled": "Enable newly found device tracker entities by default. When disabled, new entities are added but disabled in the entity registry.",
+                    "track_new_devices": "Automatically create device tracker entities for newly discovered devices. When disabled, only previously known devices are tracked.",
                     "hosts": "Probe only these IPs instead of scanning the network (for ZeroTier, WireGuard, Tailscale, etc.)",
                     "include": "Only track devices with these IP addresses (comma-separated list)",
                     "exclude": "Skip tracking devices with these IP addresses (comma-separated list)"