Search specific train in Nederlandse Spoorwegen

[gurbyz]

Description:

Added optional configuration variable time to search for a specific train.

Why is this needed? The current implementation was searching for the next train only. For some travelers and/or stations this isn't convenient. E.g. when you want to get trip information about your fast train ("Intercity"), but a slow train ("Sprinter") for same departing station and arrival station is departing only a few minutes before the fast train. Then the time interval in where you get the information for your specific train is too small and you can't make automations for it, like notify you in time (!) when your train is delayed.

To not hit the FUP threshold for NS API calls (when e.g. watching for all specific trains that your household uses) the sensor only updates around the searched specific trip time. Outside this interval the sensor gives unknown in Home Assistant.

Related issue (if applicable): n.a.

Pull request with documentation for home-assistant.io (if applicable): home-assistant/home-assistant.io#11235

Example entry for configuration.yaml (if applicable):

sensor:
  - platform: nederlandse_spoorwegen
    email: YOUR_NS_API_USERNAME
    password: YOUR_NS_API_PASSWORD
    routes:
      - name: 'The next train'
        from: Dvd
        to: Almb
      - name: 'A specific train'
        from: Dvd
        to: Almb
        time: '17:31:00'

Checklist:

• The code change is tested and works locally.
• Local tests pass with tox. Your PR cannot be merged unless tests pass
• There is no commented out code in this PR.
• I have followed the development checklist

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

• Documentation added/updated in home-assistant.io

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

• The manifest file has all fields filled out correctly. Update and include derived files by running python3 -m script.hassfest.
• New or updated dependencies have been added to requirements_all.txt by running python3 -m script.gen_requirements_all.
• Untested files have been added to .coveragerc.

If the code does not interact with devices:

• Tests have been added to verify that the new code works.

[homeassistant]

Hi @gurbyz,

It seems you haven't yet signed a CLA. Please do so here.

Once you do that we will be able to review and accept this pull request.

Thanks!

[springstan]

@gurbyz any updates on this PR? Please adjust the code according to the suggestions and solve the merge conflict. Thanks 👍

[springstan]

You will need to format your code with black and run python3 -m script.gen_requirements_all to fix the checkformat and validate error ✌

[MartinHjelmare]

Can be merged when build passes.

[gurbyz]

When I perform python3 -m script.gen_requirements_all nothing happens locally. git status gives no changes.