Add time and offset config to Swiss public transport connections

[miaucl]

Proposed change

Instead of only getting connections departing now, this PR adds functionality to choose between departure and arrival, a fixed time of day and a moving offset.

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: Improve docs of Swiss public transport for new options home-assistant.io#35609

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]

Hey there @fabaff, mind taking a look at this pull request as it has been labeled with an integration (swiss_public_transport) you are listed as a code owner for? Thanks!

Code owner commands

Code owners of swiss_public_transport can trigger bot actions by commenting:

• @home-assistant close Closes the pull request.
• @home-assistant rename Awesome new title Renames the pull request.
• @home-assistant reopen Reopen the pull request.
• @home-assistant unassign swiss_public_transport Removes the current integration label and assignees on the pull request, add the integration domain after the command.
• @home-assistant add-label needs-more-information Add a label (needs-more-information, problem in dependency, problem in custom component) to the pull request.
• @home-assistant remove-label needs-more-information Remove a label (needs-more-information, problem in dependency, problem in custom component) on the pull request.

[tsvi]

Wouldn't it be better if we allow timestamp sensors in general to add a trigger with an offset. I've been looking at this problem for a while. I've seen other integrations with timestamps also implementing this kind of functionality.
I think this calls for a change in the way core handles timestamp sensors.

[miaucl]

Wouldn't it be better if we allow timestamp sensors in general to add a trigger with an offset. I've been looking at this problem for a while. I've seen other integrations with timestamps also implementing this kind of functionality.

I think this calls for a change in the way core handles timestamp sensors.

Are you sure we are talking about the same thing? This aims to get information from an api using an offset related to that external api, not the homeassistant timestamps. The information is loaded instantaneously and not by an offset. @tsvi

[tsvi]

Ok, so this is information coming from the API. My bad.
BTW shouldn't the docs be updated to reflect this change?

[miaucl]

Ok, so this is information coming from the API. My bad.

BTW shouldn't the docs be updated to reflect this change?

Not to my knowledge as the docs are generated using the strings.json about the fields to be configured.

[joostlek]

Wouldn't this use case be covered by service calls? I am just a bit scared that this will end up with a lot of extra configuration options in the future

[miaucl]

Wouldn't this use case be covered by service calls? I am just a bit scared that this will end up with a lot of extra configuration options in the future

There is currently no possibility to get the connections at time X or in Y minutes. Only instantly. This applies for sensors and services. There a minimum set of options to specify in a transport app: location, via, time/date and transportation mode. If you have a better idea how to specify that bedsides the config or service call params, I am all ear. But being able to factor in the duration of path to a station and discard impossible connections is really useful. @joostlek

[emontnemery]

the docs are generated using the strings.json about the fields to be configured

That's not the case @miaucl, although it's an interesting idea to do that.
You should consider updating the documentation at https://www.home-assistant.io/integrations/swiss_public_transport/

[gjohansson-ST]

Some initial remarks

[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.

[gjohansson-ST]

Some minor remarks 👍
The last video posted 2 days ago does not reflect the code...

[miaucl]

Thanks @gjohansson-ST, here is the up-to-date video.

Bildschirmaufnahme.2024-11-08.um.14.09.08.mp4

[gjohansson-ST]

LGTM 👍