Deprecate legacy Proximity entity

[mib1185]

Breaking change

The proximity entity is deprecated (will be removed in 2024.8). It is superseded by sensor entities.
For each tracked person or device one sensor for the distance and the direction of travel to/from the monitored zone is created. Further for each Proximity configuration one sensor which shows the nearest device or person to the monitored zone is created.
With this you can use the Min/Max integration to determine the nearest and furthest distance.

Proposed change

This is the deprecation of the legacy Proximity entity, after sensor entities has been implemented (#101497)

Type of change

• Dependency upgrade
• Bugfix (non-breaking change which fixes an issue)
• New integration (thank you!)
• New feature (which adds functionality to an existing integration)
• Deprecation (breaking change to happen in the future)
• Breaking change (fix/feature causing existing functionality to break)
• Code quality improvements to existing code or addition of tests

Additional information

• This PR fixes or closes issue: fixes #
• This PR is related to issue:
• Link to documentation pull request:

Checklist

• The code change is tested and works locally.
• Local tests pass. Your PR cannot be merged unless tests pass
• There is no commented out code in this PR.
• I have followed the development checklist
• I have followed the perfect PR recommendations
• The code has been formatted using Ruff (ruff format homeassistant tests)
• Tests have been added to verify that the new code works.

If user exposed functionality or configuration variables are added/changed:

• Documentation added/updated for www.home-assistant.io

If the code communicates with devices, web services, or third-party tools:

• The manifest file has all fields filled out correctly.
  Updated and included derived files by running: python3 -m script.hassfest.
• New or updated dependencies have been added to requirements_all.txt.
  Updated by running python3 -m script.gen_requirements_all.
• For the updated dependencies - a link to the changelog, or at minimum a diff between library versions is added to the PR description.
• Untested files have been added to .coveragerc.

To help with the load of incoming pull requests:

• I have reviewed two other open pull requests in this repository.

[home-assistant]

There is a merge conflict.

[home-assistant]

Please take a look at the requested changes, and use the Ready for review button when you are done, thanks 👍

Learn more about our pull request process.

Stale

[mkmer]

2024.6 (Breaking change "words") or 2024.8 (in picture)?

[mib1185]

oops ... this change was postponed multiple times ... i've corrected the breaking change message

[mkmer]

Not to slow down this update, but I thought we had to add config flow to any integration before updating things.
Maybe that should be the next PR for this one?

[mib1185]

• it is already in the pipeline Add configflow to Proximity integration #103894 😉

nevertheless, you can change things/integrations without the need of migrating to a config flow, except changes on yaml based parameters (see ADR 7)

[MartinHjelmare]

Issues like these should be fixable and persistent so that the user can fix them when they've updated their automations and scripts.

[mib1185]

I'm not sure if this should be persistent (the issue is re-created as long as these automations and/or scripts exists on ever HA reboot), nor that we can implement a automatic fix for that 🤔

further as soon as is_fixable=True is set, the description is not shown anymore (already tried to clear browser cache)

[MartinHjelmare]

I think we need to put the strings as part of a repair flow in the strings.json.

[mib1185]

ok, i got it work

[MartinHjelmare]

We don't need to create a repair flow. A default repair flow will be created for us. Just write the strings like so:

core/homeassistant/components/calendar/strings.json

Lines 112 to 124 in 195ef6d

	"issues": {
	"deprecated_service_calendar_list_events": {
	"title": "Detected use of deprecated service `calendar.list_events`",
	"fix_flow": {
	"step": {
	"confirm": {
	"title": "[%key:component::calendar::issues::deprecated_service_calendar_list_events::title%]",
	"description": "Use `calendar.get_events` instead which supports multiple entities.\n\nPlease replace this service and adjust your automations and scripts and select **submit** to close this issue."
	}
	}
	}
	}
	}

[mib1185]

but this default repair flow will not do any re-check if the issue is really fixed, or do i oversee something?

[MartinHjelmare]

Yes, that's correct. The user will fix it manually, hopefully after they have updated their automations and scripts. We'll create the issue again though, the next time they start Home Assistant if we detect automations or scripts with an entity.

[mib1185]

ok, this makes it quiet simpler to implement 👍

[MartinHjelmare]

Thanks!