db-infoscreen Homeassistant Sensor

The db-infoscreen sensor will give you the departure time of the next trains for the given station, containing many more attribute informations. It aims to aggregate departure and train data from different sources and combine them in a useful (and user-friendly) manner. It is intended both for a quick glance at the departure board and for public transportation geeks looking for details about specific trains. The backend has many datasources available with it's main source being IRIS-TTS - Deutsche Bahn.

This integration works great side-by-side with ha-bahnvorhersage. This is a superior to ha-deutschebahn.

Installation

1. Using HACS (recommended way)

This integration is NO official HACS Integration right now.

Open HACS then install the "db-infoscreen" integration or use the link below.

If you use this method, your component will always update to the latest version.

2. Manual

• Download the latest zip release from here
• Extract the zip file
• Copy the folder "db_infoscreen" from within custom_components with all of its components to <config>/custom_components/

where <config> is your Home Assistant configuration directory.

NOTE: Do not download the file by using the link above directly, the status in the "master" branch can be in development and therefore is maybe not working.

Configuration

Go to Configuration -> Integrations and click on "add integration". Then search for "db-infoscreen".

You can set up one sensor per station, except using different via_stations configurations.

Configuration Variables

• station: The name of the station or Trip number to be tracked.
  • Please check your station at dbf.finalrewind.org if it is working.
• next_departures (optional): The number of upcoming departures to display. Default is 4, but you can adjust it according to your preferences.
• update_interval (optional): The time interval (in minutes) at which the integration will fetch updated departure data. Default is 3 minutes, minimum is 1 minute (data wont be refreshed more often in the backend).
• hide_low_delay (optional): If enabled, departures with a delay of less than 5 minutes will be hidden. Default is false.
• drop_late_trains (optional): Hide trains whose departure is in the past but would be delayed within the time. For example with the option turned on a train at 09:00 with 5 Minutes delay will be dropped after 09:00 o'clock. With the option enabled this train will be displayed until 09:05 o'clock
• detailed (optional): If enabled, additional details about the departures will be shown. Default is false.
• past_60_minutes (optional): If enabled, shows departures from the past 60 minutes. Default is false.
• custom_api_url (optional): If you wish to use a custom API URL (f.e. your self hosted server) instead of the default one, you can specify it here. The URL should contain only the base domain (e.g., https://example.com).
• data_source (optional): Choose the data source for fetching departure information. The available options are:
  • The integration supports fetching departure data from various data sources, including:
    • IRIS-TTS – Deutsche Bahn (default and used by most)
    • MVV – Münchener Verkehrs- und Tarifverbund Bayern
    • ÖBB – Österreichische Bundesbahnen Österreich
    • BSVG – Braunschweiger Verkehrs-GmbH
    • DING – Donau-Iller Nahverkehrsverbund
    • KVV – Karlsruher Verkehrsverbund Baden-Württemberg
    • LinzAG – Linz AG
    • NVBW – Nahverkehrsgesellschaft Baden-Württemberg
    • NWL – Nahverkehr Westfalen-Lippe
    • VGN – Verkehrsverbund Großraum Nürnberg Bayern
    • VMV – Verkehrsgesellschaft Mecklenburg-Vorpommern Mecklenburg-Vorpommern
    • VRN – Verkehrsverbund Rhein-Neckar
    • VRR – Verkehrsverbund Rhein-Ruhr Nordrhein-Westfalen
    • VRR2 – Verkehrsverbund Rhein-Ruhr Nordrhein-Westfalen
    • VRR3 – Verkehrsverbund Rhein-Ruhr Nordrhein-Westfalen
    • VVO – Verkehrsverbund Oberelbe
    • VVS – Verkehrs- und Tarifverbund Stuttgart Baden-Württemberg
    • bwegt – bwegt Baden-Württemberg
    • AVV – Aachener Verkehrsverbund Nordrhein-Westfalen (avv.de)
    • BART – Bay Area Rapid Transit California (bart.gov)
    • BLS – BLS AG Kanton Bern, Kanton Luzern (bls.ch)
    • BVG – Berliner Verkehrsbetriebe Berlin, Brandenburg (bvg.de)
    • CMTA – Capital Metro Austin Public Transport Texas (capmetro.org)
    • DSB – Rejseplanen Dänemark (rejseplanen.dk)
    • IE – Iarnród Éireann Irland, Nordirland (irishrail.ie)
    • KVB – Kölner Verkehrs-Betriebe (kvb.koeln)
    • NAHSH – Nahverkehrsverbund Schleswig-Holstein Schleswig-Holstein (nah.sh)
    • NASA – Personennahverkehr in Sachsen-Anhalt Sachsen-Anhalt (nasa.de)
    • NVV – Nordhessischer Verkehrsverbund Hessen (nvv.de)
    • RMV – Rhein-Main-Verkehrsverbund Hessen, Baden-Württemberg, Bayern, Rheinland-Pfalz (rmv.de)
    • RSAG – Rostocker Straßenbahn Mecklenburg-Vorpommern (rsag-online.de)
    • Resrobot – Resrobot
    • STV – Steirischer Verkehrsverbund AT-6 (verbundlinie.at)
    • SaarVV – Saarländischer Verkehrsverbund DE-SL (saarvv.de)
    • TPG – Transports publics genevois Kanton Genf (tpg.ch)
    • VBB – Verkehrsverbund Berlin-Brandenburg Berlin, Brandenburg (vbb.de)
    • VBN – Verkehrsverbund Bremen/Niedersachsen Niedersachsen, Bremen (vbn.de)
    • VMT – Verkehrsverbund Mittelthüringen Thüringen (vmt-thueringen.de)
    • VOS – Verkehrsgemeinschaft Osnabrück Niedersachsen (vos.info)
    • ZVV – Züricher Verkehrsverbund Kanton Zürich (zvv.ch)
    • mobiliteit – mobilitéits zentral Luxembourg (mobiliteit.lu)
  • Some stations can be searched via "IRIS-TTS" but need hafas=1 for data retrival, f.e. "Frankenforst Kippekausen, Bergisch Gladbach", choose hafas=1 in the list to archive this. GitHub issue about this
• offset (optional): Do not display departures leaving sooner than this number of seconds. You can specify the offset in "HH:MM" or "HH:MM:SS" format. Default is 00:00 (no offset).
• admode (optional): Defines whether to display departure times, arrival times, or the default behavior (departure preferred). Available options:
  • departure prefered (default): Displays the preferred time based on the system's default behavior (usually departures).
  • arrival: Only shows arrival times.
  • departure: Only shows departure times.
• platforms (optional): If your station has multiple platforms and you want to filter by a specific platform, you can use this setting. Enter the platform(s) as a comma-separated list (e.g., 1, 2, 3). This will ensure that the integration fetches data only for the specified platforms. If left empty, data for all platforms will be shown.
• via_stations (optional): You can filter one or more stations where the Train has to go through. Enter the platform(s) as a comma-separated list (e.g., München-Pasing,München-Ost). This will ensure that the integration fetches data only when the Train has a stop at those stations.
• ignored_train_types (optional): You can configure the integration to ignore certain types of trains or buses. This is useful if you only want to see specific types of departures. If you are missing a train type, please add a feature request or pull request. Please note, that filtering wont work for all stations, it wont work for Bensberg, Bergisch Gladbach as an example.

Note: You are limited to adding 30 sensors, if you are not using a custom_api_url.

Migrating from ha-deutschebahn

There is no direct way of migrating the ha-deutschebahn integration to ha-db_infoscreen due to the fact, that those are two completly different integrations with different API sources. The old ha-deutschebahn api provided a start and destination option, which is not (yet) available with this newer API backend. To get a most similar option about this, I recommend starting playing around with the platforms option to only display one direction for your direction and afterwards filtering with a custom sensor to only display trains with a specific end station or using for example two sensors for the same station but choosing different via_stations to only display "one direction".

All other features of ha-deutschebahn are ported to this integration or will be ported soon.

Discussion about this

Accessing the data

Automations

automation:
  - alias: Notify Train Delay
    description: "Notify when the next train is delayed by more than 10 minutes."
    trigger:
      - platform: template
        value_template: "{{ state_attr('sensor.station_departures', 'next_departures')[0]['delayArrival'] | int > 10 }}"
    action:
      - service: notify.notify
        data:
          message: >
            The next train to {{ state_attr('sensor.station_departures', 'next_departures')[0]['destination'] }}
            is delayed by {{ state_attr('sensor.station_departures', 'next_departures')[0]['delayArrival'] }} minutes.
    mode: single

Custom sensor

Add a custom sensor in your configuration.yaml

sensor:
  - platform: template
    sensors:
      next_train_departure:
        friendly_name: "Next Train Departure"
        value_template: >
          {{ state_attr('sensor.station_departures', 'next_departures')[0]['scheduledArrival'] }}
        icon_template: mdi:train

Community submit by kRew94 (Improved by kaffeetrinker71)

This is a template sensor which gives the information for a destination in the format "HH:MM +DELAY":

{%- set number = 0 -%}
{%- set connections = state_attr('sensor.uelzen_departures_via_hannover_hbf', 'next_departures') | selectattr('isCancelled', 'equalto', 0) | list -%}
{% if connections is not none and connections | length > number %}
  {% set connection = connections[number] %}
  {% set product = connection.train %}
  {% set departure = connection.scheduledDeparture %}
  {% set delay = connection.delayDeparture | int %}
  {{ product }} um {{ departure }}{% if delay > 0 %} +{{ delay }}{% endif %}
{% else %}
  No data
{% endif %}

The result looks like this: "ICE 2935 um 07:15"

YAML Snippets

There are some examples that can be used within automations or custom sensors.

Community submit by Kanecaine

I have a sensor for Berlin Central Station and would now like to know which connections there are to Leipzig and should give you the following output: IC 495 um 22:28 +1.

More informations.

{%- set target = "Leipzig Hbf" -%}
{%- set number = 0 -%}
{%- set connections = state_attr('sensor.berlin_hbf_departures', 'next_departures') | selectattr('destination', 'equalto', target) | list -%}
{% if connections is not none and connections | length > number %}
  {% set connection = connections[number] %}
  {% set product = connection.train %}
  {% set departure = connection.scheduledDeparture %}
  {% set delay = connection.delayDeparture | int %}
  {{ product }} um {{ departure }}{% if delay > 0 %} +{{ delay }}{% endif %}
{% else %}
  --
{% endif %}

JSON Format

The API returns data in the following json format usually:

{
  "departures": [
    {
      "scheduledArrival": "08:08",
      "destination": "München-Pasing",
      "train": "S 4",
      "platform": "4",
      "delayArrival": 18,
      "messages": {
        "delay": [
          {"text": "delay of a train ahead", "timestamp": "2025-01-21T07:53:00"}
        ]
      }
    }
  ]
}

There are some differences depending on the stations, for example:

{
  "departures": [
    {
      "delay": 0,
      "destination": "Bensberg, Bergisch Gladbach",
      "direction": "Bensberg, Bergisch Gladbach",
      "isCancelled": null,
      "messages": [],
      "platform": null,
      "route": [],
      "scheduledPlatform": null,
      "scheduledTime": 1737619740,
      "time": 1737619740,
      "train": "STR 1",
      "trainNumber": "54726",
      "via": []
    }
  ]
}

Lovelace Custom Cards

There are some lovelace custom cards, which bringt you a better overview on your dashboard. Be sure to check them out.

ha-departureCard

Check out the card here.

ha-public-transport-connection-card

This is currently Work-in-Progress by the maintainer, more informations are here.

Bug reporting

Open an issue over at github issues. Please prefer sending over a log with debugging enabled.

To enable debugging enter the following in your configuration.yaml

logger:
    logs:
        custom_components.db_infoscreen: debug

You can then find the log in the HA settings -> System -> Logs -> Enter "db-infoscreen" in the search bar -> "Load full logs"

Thanks to

The data is coming from the dbf.finalrewind.org website (if no custom API Server is specified). The backend data is coming from a db-infoscreen - (formerly db-fakedisplay) server - with a huge thanks to derf for this great project!