Merge

Don't know what happened here.. Hopefully good now

Author: mudape

.github/workflows/hacs_action.yml

@@ -0,0 +1,15 @@
+name: "HACS Validate"
+
+on:
+  push:
+  pull_request:
+
+jobs:
+  hacs:
+    name: "HACS validation"
+    runs-on: "ubuntu-latest"
+    steps:
+      - name: HACS Action
+        uses: "hacs/action@main"
+        with:
+          category: "integration"

.github/workflows/hassfest.yaml

@@ -10,5 +10,5 @@ jobs:
   validate:
     runs-on: "ubuntu-latest"
     steps:
-      - uses: "actions/checkout@v3"
+      - uses: "actions/checkout@v4"
       - uses: home-assistant/actions/hassfest@master

.github/workflows/release.yml

@@ -5,31 +5,33 @@ on:
     types: [published]
 
 jobs:
-  release_zip_file:
+  release:
     name: Prepare release asset
     runs-on: ubuntu-latest
     steps:
-      - name: Check out repository
-        uses: actions/checkout@v1
-      
-      - name: Get version
-        id: version
-        uses: home-assistant/actions/helpers/version@master
+      - name: ⤵️ Check out code from GitHub
+        uses: actions/checkout@v4
 
-      - name: "Set version number"
+      - name: 🔢 Adjust version number
+        shell: bash
         run: |
-          python3 ${{ github.workspace }}/manage/update_manifest.py --version ${{ steps.version.outputs.version }}
-      
-      - name: ZIP files
+          version="${{ github.event.release.tag_name }}"
+          version="${version,,}"
+          version="${version#v}"
+          yq e -P -o=json \
+            -i ".version = \"${version}\"" \
+            "${{ github.workspace }}/custom_components/iphonedetect/manifest.json"
+
+      - name: 📦 Created zipped release package
         run: |
-          cd /home/runner/work/iphonedetect/iphonedetect/custom_components/iphonedetect
+          cd "${{ github.workspace }}/custom_components/iphonedetect"
           zip iphonedetect.zip -r ./
-      - name: Upload zip to release
-        uses: svenstaro/upload-release-action@v1-release
 
+      - name: ⬆️ Upload zip to release
+        uses: svenstaro/upload-release-action@v2
         with:
           repo_token: ${{ secrets.GITHUB_TOKEN }}
-          file: /home/runner/work/iphonedetect/iphonedetect/custom_components/iphonedetect/iphonedetect.zip
+          file: "${{ github.workspace }}/custom_components/iphonedetect/iphonedetect.zip"
           asset_name: iphonedetect.zip
           tag: ${{ github.ref }}
           overwrite: true

README.md

@@ -1,44 +1,94 @@
-[![hacs_badge](https://img.shields.io/badge/HACS-Default-orange.svg)](https://github.com/custom-components/hacs) 
-![GitHub release](https://img.shields.io/github/release/mudape/iphonedetect.svg)
-# iPhone Detect
-This integration sends a message to the defined hosts on UDP port 5353.  
-The iPhone responds, _even when in deep sleep_, and an entry in the ARP cache is made .  
+# iPhone Detect for Home-Assistant
 
-Uses Home Assistant's [device_tracker](https://www.home-assistant.io/components/device_tracker/) and idea/script from [return01](https://community.home-assistant.io/u/return01)
+[![Validate with hassfest](https://github.com/mudape/iphonedetect/actions/workflows/hassfest.yaml/badge.svg)](https://github.com/mudape/iphonedetect/actions/workflows/hassfest.yaml)
+[![HACS Validate](https://github.com/mudape/iphonedetect/actions/workflows/hacs_action.yml/badge.svg)](https://github.com/mudape/iphonedetect/actions/workflows/hacs_action.yml)
+[![hacs_badge](https://img.shields.io/badge/HACS-Default-blue.svg)](https://github.com/custom-components/hacs)
 
-Only **IP addresses** will work, _no hostnames_!  
-You have to assign a **static** IP address(es) to your iPhones, probably in your router. 
+![downloads](https://img.shields.io/github/downloads/mudape/iphonedetect/total.svg)
+![downloads](https://img.shields.io/github/downloads/mudape/iphonedetect/1.4.2/total.svg)
+![downloads](https://img.shields.io/github/downloads/mudape/iphonedetect/latest/total.svg)
 
-_The interval_seconds time must be shorter than the timeout in which the ARP cache is cleared (usally 15-45sec), or the phone will be marked not_home._
-_So, leave it at the default value (12sec) or make it shorter._
+This integration sends a mDNS message to defined hosts.  
+The device responds if it's connected to the network, even when in deep sleep, and an entry in the ARP cache is made and read.  
+Usefull as a [device_tracker](https://www.home-assistant.io/integrations/device_tracker/) for your [person](https://www.home-assistant.io/integrations/person/) integration to see if users are at home.
 
-<a href="https://www.buymeacoffee.com/MudApe" target="_blank"><img src="https://www.buymeacoffee.com/assets/img/custom_images/orange_img.png" alt="Buy Me A Coffee" style="height: auto !important;width: auto !important;" ></a>
+## Installation
+
+After installation you need to **restart** Home-Assistant before using the integration.
+
+### Using HACS  
+
+If you dont' have [HACS](https://hacs.xyz) installed yet, I highly recommend it.  
+[![Open your Home Assistant instance and open a repository inside the Home Assistant Community Store.](https://my.home-assistant.io/badges/hacs_repository.svg)](https://my.home-assistant.io/redirect/hacs_repository/?owner=mudape&repository=iphonedetect&category=integration) or search for `iPhone Device Tracker`.
+
+### Manual  
+
+Download the `iphonedetect` directory and place in your `<config>/custom_component`
+
+## Configuration  
+
+### Network
+
+Assign a **static** IP address to the device you want to track, probably in your router.  
+Alternative, set a manual IP in your device WiFi configuration.  
+Avoid automatically connect to differtent SSID's (2.4 and 5 ghz bands)  
+
+### Setup
+
+[![Open your Home Assistant instance and start setting up a new integration.](https://my.home-assistant.io/badges/config_flow_start.svg)](https://my.home-assistant.io/redirect/config_flow_start/?domain=iphonedetect)
+
+If you don't have [My Home Assistant](https://my.home-assistant.io/) redirects set up, go to Settings -> Devices & Services  
+Click "Add integration" and search for `iPhone Device Tracker`
+
+Give the entity a unique `name` and enter its IP address.  
+
+![image](https://github.com/user-attachments/assets/c4583955-72d8-4c3a-81b4-062a134af11e)
 
-## Example configuration.yaml
-
-```yaml
-device_tracker:
-  - platform: iphonedetect
-    consider_home: 60
-    scan_interval: 12
-    new_device_defaults:
-      track_new_devices: true
-    hosts:
-      hostname1: 192.168.0.17
-      hostname2: 192.168.0.24
-```
-This will create `device_tracker.hostname1` and `device_tracker.hostname2` once the devices have been detected on your network.  
-(Re)start the Wi-Fi on your device/phone to trigger their creation on first run. 
-
-__Note__  
-If you have `track_new_devices: false` (in this or any integrations specified before this) for the device_tracker component you need to manually change `track:` to true for each device in `known_devices.yaml`  
-(see component settings for [device_tracker](https://www.home-assistant.io/components/device_tracker/#configuring-a-device_tracker-platform))  
-```yaml
-hostname1:
-  icon:
-  mac:
-  name: hostname1
-  picture:
-  track: true
-```
+This will create an entity `device_tracker.<name>`  
 
+Repeat the steps for additional entities.
+
+#### Options
+
+You can change the consider home timeout per tracked device in the UI.  
+Default is 24 seconds.  
+![image](https://github.com/user-attachments/assets/caf31775-333d-448c-b8f2-660534d856d7)
+
+#### Reconfigure
+
+You can change the IP address of the tracked device in the UI.  
+![image](https://github.com/user-attachments/assets/4fc98224-eee6-4451-aaf1-b16c858014d2)
+
+## Troubleshooting | FAQ  
+
+<details>
+<summary>Private Wi-Fi address</summary>
+The device private MAC address will remain the same for each network, as long as the network isn't recreated or rotating (iOS 18+) MAC is used.  
+
+In other words, if a tracked device no longer can be found the user have propably recreated the connection to your Wi-Fi forcing a new random MAC address to be used.  
+<br />
+Note that if your WiFi has different SSID for the 2.4 and 5 ghz bands, and the phone has private network enabled, two different MAC will be presented to the DHCP.  
+Most likely that will require the integration to track two IP's per user/Person.
+<br />
+So, for best result only have/connect to one SSID, turn off private network and assign static IP.
+</details>
+<details>
+<summary>False or flaky not_home status</summary>
+Especially when the network has multiple Access Points, tracked devices sometimes are marked as not_home when actually connected to the network.  
+Increasing the consider home timeout might help this.  
+Most likely it's a network issue though, try placing your AP's at different locations.  
+
+Devices might auto-update during night, they of course then will be not_home for awhile.  
+</details>
+
+## Attribution
+
+Original idea from [return01](https://community.home-assistant.io/u/return01)
+
+## Disclaimer  
+
+Author is in no way affiliated with Apple Inc.  
+Author does not guarantee functionality of this integration and is not responsible for any damage.  
+All product names, trademarks and registered trademarks in this repository, are property of their respective owners.  
+
+<a href="https://www.buymeacoffee.com/MudApe" target="_blank"><img src="https://www.buymeacoffee.com/assets/img/custom_images/orange_img.png" alt="Buy Me A Coffee" style="height: auto !important;width: auto !important;" ></a>

custom_components/iphonedetect/__init__.py

@@ -1 +1,115 @@
-""" iPhone Detect """
+"""iPhone Device Tracker"""
+
+from __future__ import annotations
+
+import logging
+from datetime import timedelta
+from typing import TYPE_CHECKING
+
+from homeassistant.components.device_tracker import CONF_CONSIDER_HOME
+from homeassistant.config_entries import ConfigEntry
+from homeassistant.const import CONF_DEVICES, CONF_IP_ADDRESS, Platform
+from homeassistant.exceptions import PlatformNotReady
+from homeassistant.helpers import config_validation as cv
+from homeassistant.helpers.event import async_track_time_interval
+
+from .const import DOMAIN, PROBE_INTERVAL
+from .coordinator import IphoneDetectUpdateCoordinator
+from .scanner import (
+    DeviceData,
+    Scanner,
+    ScannerException,
+    async_get_scanner,
+    async_update_devices,
+)
+
+if TYPE_CHECKING:
+    from homeassistant.core import HomeAssistant
+    from homeassistant.helpers.typing import ConfigType
+
+_LOGGER = logging.getLogger(__name__)
+
+CONFIG_SCHEMA = cv.config_entry_only_config_schema(DOMAIN)
+PLATFORMS = [Platform.DEVICE_TRACKER]
+TRACKER_INTERVAL = timedelta(seconds=PROBE_INTERVAL)
+
+
+async def async_setup(hass: HomeAssistant, config: ConfigType) -> bool:
+    """Set up the integration."""
+    devices: dict[str, DeviceData]
+    devices = hass.data.setdefault(DOMAIN, {})[CONF_DEVICES] = {}
+
+    try:
+        scanner: Scanner = await async_get_scanner(hass)
+    except ScannerException as error:
+        raise PlatformNotReady(error)
+
+    async def _update_devices(*_) -> None:
+        """Update reachability for all tracked devices."""
+        await async_update_devices(hass, scanner, devices)
+
+    async_track_time_interval(hass, _update_devices, TRACKER_INTERVAL, cancel_on_shutdown=True)
+
+    return True
+
+
+async def async_setup_entry(hass: HomeAssistant, entry: ConfigEntry) -> bool:
+    """Set up config entries."""
+    _LOGGER.debug("Adding '%s' to tracked devices", entry.options[CONF_IP_ADDRESS])
+
+    device = hass.data[DOMAIN][CONF_DEVICES][entry.entry_id] = DeviceData(
+        ip_address=entry.options[CONF_IP_ADDRESS],
+        consider_home=timedelta(seconds=entry.options[CONF_CONSIDER_HOME]),
+        title=entry.title,
+    )
+
+    coordinator = IphoneDetectUpdateCoordinator(hass, device)
+    await coordinator.async_config_entry_first_refresh()
+    hass.data[DOMAIN].setdefault("coordinators", {})[entry.entry_id] = coordinator
+
+    await hass.config_entries.async_forward_entry_setups(entry, PLATFORMS)
+    entry.async_on_unload(entry.add_update_listener(async_reload_entry))
+
+    return True
+
+
+async def async_reload_entry(hass: HomeAssistant, entry: ConfigEntry) -> None:
+    """Update options."""
+    _LOGGER.debug("Reloading entity '%s' with '%s'", entry.title, entry.options)
+    await hass.config_entries.async_reload(entry.entry_id)
+
+
+async def async_unload_entry(hass: HomeAssistant, entry: ConfigEntry) -> bool:
+    """Handle removal of an entry."""
+    unload_ok = await hass.config_entries.async_unload_platforms(entry, PLATFORMS)
+    if unload_ok:
+        _LOGGER.debug("Removing '%s' from tracked devices", entry.options[CONF_IP_ADDRESS])
+        hass.data[DOMAIN][CONF_DEVICES].pop(entry.entry_id)
+
+    return unload_ok
+
+
+async def async_migrate_entry(hass: HomeAssistant, config_entry: ConfigEntry) -> bool:
+    """Migrate old config entry to a new format."""
+
+    if config_entry.version == 1:
+        _LOGGER.debug("Migrating from version 1")
+        # Move IP address from data to options
+        new_options = config_entry.options.copy()
+        if config_entry.data.get(CONF_IP_ADDRESS):
+            new_options[CONF_IP_ADDRESS] = config_entry.data[CONF_IP_ADDRESS]
+
+        # Set unique_id
+        new_unique_id = config_entry.unique_id
+        if not new_unique_id:
+            new_unique_id = f"{DOMAIN}_{config_entry.title}".lower()
+
+        hass.config_entries.async_update_entry(
+            config_entry,
+            unique_id=new_unique_id,
+            data={},
+            options=new_options,
+            version=2,
+        )
+
+    return True