HA-Nysse

Introduction

Home Assistant integration to fetch public transport data for Tampere, Finland

Installation

Copy the files to your custom_components folder or install as a HACS custom repository. More info on HACS here.

Setup

The integration can be set up from the frontend by searching for Nysse.

Usage

Each station creates a sensor which contains data for departures from that station. Explanations for attributes are listed below.

General

Attribute	Description
last_refresh	Timestamp (ISO 8601 format) indicating when real-time departures were last fetched.
departures	A list of departure objects representing the next available departures.
station_name	Name of the monitored stop.

Departures

Attribute	Description
destination	Name of the line's destination stop.
line	Reference identifier for the line, such as 4 or 36A.
departure	Departure time in %H:%M (24-hour format), e.g., 16:09. When realtime is false, this value is taken directly from the timetable. When realtime is true, it is calculated based on the real-time position of the vehicle.
time_to_station	Remaining time in whole minutes until the vehicle departs from the stop. Rounded down (e.g., 1 min 0 sec to 1 min 59 sec displays as 1). When realtime is false, this value is taken directly from the timetable. When realtime is true, it is calculated based on the real-time position of the vehicle.
icon	Icon representing the vehicle operating the line. Possible values are mdi:tram or mdi:bus.
realtime	Boolean (true or false) indicating whether the data is based on real-time vehicle position or a static timetable. Real-time vehicle data is used whenever available.

Realtime departure specific

Attribute	Description
aimed_departure	Scheduled departure time according to the timetable, in %H:%M (24-hour format), e.g., 16:09.
delay	Number of seconds the vehicle is ahead of or behind schedule. Negative values indicate the vehicle is ahead of schedule.

Frontend examples

Simple frontend examples using custom:html-template-card

type: custom:html-template-card
title: Keskustori D
ignore_line_breaks: true
content: >
  {% set departures = state_attr('sensor.keskustori_d_0015','departures')
  %} {% for i in range(0, departures | count, 1) %}

  <div style="display:grid; grid-template-columns: 2fr 1fr; font-size: 20px;
  padding: 10px 0px 0px 0px"> <div>{{ departures[i].line }} - {{
  departures[i].destination }}</div><div style="text-align: right">{% if
  departures[i].realtime %}<ha-icon style="color:green; padding: 0px 10px 0px
  0px" icon="mdi:signal-variant"></ha-icon>{% endif %} {% if
  departures[i].time_to_station | int < 21  %} {{departures[i].time_to_station}}
  min {% else %}{{departures[i].departure}}{% endif %}</div></div>

  {% endfor %}

type: custom:html-template-card
ignore_line_breaks: true
title: Service Alerts
content: >
  {% set alerts = state_attr('sensor.nysse_service_alerts','alerts')
  %} {% for i in range(0, alerts | count, 1) %}

  <b>{{ alerts[i].start.strftime('%d.%m.%Y') }} - {{ alerts[i].end.strftime('%d.%m.%Y') }}</b><br>
  {{ alerts[i].description }}<br><br>

  {% endfor %}

Advanced usage

Combine data from multiple stops

 - platform: template
    sensors:
      combined_stops:
        value_template: "{{ states('sensor.stop1') }}"
        attribute_templates:
          departures: >-
            {% set combined_data = state_attr('sensor.stop1', 'departures') + state_attr('sensor.stop2', 'departures') %}
            {{ combined_data | sort(attribute='time_to_station') }}

Known issues / limitations

• Nysse API sometimes functions incorrectly. Errors logged with Nysse API error can be resolved on their own over time.
• Line icons are resolved from a hardcoded list of tram lines. If new tram lines are built, the list needs to be updated in const.py.

Troubleshooting

If the integration is not working correctly, follow these steps as a first measure:

1. Remove all files from config/www/nysse
2. Reload the integration

This forces the integration to fetch latest data from Nysse and recreates the database.