Improve installation instructions

[iMartyn]

Hey, I would love to use this integration, but the instruction :

Add this repository to HACS and install the FindMy integration.

Is a little unclear, or HACS is not working/github is not generating the zipfile HACS needs/I'm using the "wrong url".

In the logs I see

2025-01-24 13:15:59.619 ERROR (MainThread) [custom_components.hacs] Download failed - Got status code 404 when trying to download https://github.com/malmeloo/hass-FindMy/archive/refs/heads/cc76e5b.zip
Traceback (most recent call last):
  File "/config/custom_components/hacs/base.py", line 709, in async_download_file
    raise HacsException(
custom_components.hacs.exceptions.HacsException: Got status code 404 when trying to download https://github.com/malmeloo/hass-FindMy/archive/refs/heads/cc76e5b.zip
2025-01-24 13:15:59.622 ERROR (MainThread) [custom_components.hacs] [<Integration malmeloo/hass-FindMy>] Failed to download zipball
Traceback (most recent call last):
  File "/config/custom_components/hacs/repositories/base.py", line 631, in download_content
    await self.download_repository_zip()
  File "/config/custom_components/hacs/repositories/base.py", line 677, in download_repository_zip
    raise HacsException(f"[{self}] Failed to download zipball")
custom_components.hacs.exceptions.HacsException: [<Integration malmeloo/hass-FindMy>] Failed to download zipball

And it's true, that zip file doesn't exist. When adding in HACS I gave it the https clone url, and selected integration as the type. Perhaps that was wrong?

If there were a couple more lines in the installation script it would avoid others hitting this wall, until you publish to HACS main store.

I'm gonna keep trying with other variations, and if I find one that works, might raise a PR.

[iMartyn]

This might be a red herring because exec'ing into my HA, I see the files in /config/custom_components/findmy, so it's "installed" but adding the integration in settings raises the following logline :

2025-01-24 13:28:20.652 ERROR (MainThread) [homeassistant.config_entries] Error occurred loading flow for integration findmy: No module named 'findmy'

and the following error in the GUI :

Error

Config flow could not be loaded: {"message":"Invalid handler specified"}

So my best guess is a missing dependency (I've seen similar with other home assistant integrations).

[malmeloo]

Installation instructions are currently explicitly lacking because the integration is still very experimental. It's usable, and I have been dog-feeding it for a little while now, but I cannot make any guarantees about how stable it will be. I will publish the integration properly once it's ready.

That said, the way you installed it appears to be correct, so I'm not sure why HACS is selecting the wrong zip url. Once it's added as a custom repository you can just select it from the list of integrations to install. I assume you're on the latest version of HA/HACS?

It does indeed require external python dependencies, but home assistant should install them for you, so I'm not sure why that isn't happening. You might want to check your logs after a restart, as I assume that's where something is going wrong. Otherwise, try entering HA's python environment from a terminal to manually install the "findmy" package using pip.

[iMartyn]

Yeah, that's fair, but I'm up and running and seeing my tracker, so to wrap up :

• The error message is from HACS but should be a warning, because it tries zipball first, and then fetches manually if not. That'll teach me to assume error means error.
• HACS and containerised homeassistant don't work too well together, I've seen this in the past. I've added the pip install to my k8s startup to manually install FindMy.

Given that there wasn't actually any error in install aside from HACS ignoring the dependency stuff, I think the documentation is fine as is, especially given your comment about wanting to be sure before publishing.

Thanks so much for this project, I was just about to wrap https://github.com/biemster/FindMy/blob/main/request_reports.py in a web server, and use node-red to wire that to HA, when someone pointed me here, so you have saved me a LOT of time and hacky solutioning.

[malmeloo]

That's still really strange, I run home assistant in docker and have not had any issues with HACS whatsoever. But nice to hear that you got it working!