hslhrt-hass-custom is a Home Assistant custom component for real time public transsport information in Helsinki Metropoliton Area. Data is provided via Digitransit platform APIs.
1. Using a tool of choice open the directory (folder) for HA configuration (where you find configuration YAML file).
2. If `custom_components` directory does not exist, create one.
3. In the `custom_components` directory create a new folder called `hslhrt`.
4. Download all the files from the this repository and place the files in this directory.
5. If the files are placed correctly, it should have the hierarchy as: <HA configuration directory>/custom_components/hslhrt
6. Restart Home Assistant
7. Install integration from UI (Configuration --> Intergations --> + --> Search for "hsl")
8. Specify stop name (e.g. töölöntori) or stop code (e.g. H0209). Optionally the route number (e.g. 8) or the destination can be specified as well.
1. Stop name is case in-sensitive, but stop code is not. E.g. töölöntori and Töölöntori are OK. H0209 is OK. h0209 is NOT OK.
2. Route takes precedence over destination, if specified. Both options are case in-sensitive.
3. In case, route and destination are not needed, leave the default values as "ALL" or "all".
Sensor provides real time arrival information of a route (bus/tram) if available. If real time info is unavailable, it provides the scheduled arrival time of the route. If integration is configured with a route, sensor provides arrival times filtered for that route only. If the integration is configured without a route, it provides arrival times for all routes arriving at the given stop, in order of their arrival time. Sensor attributes provide the Stop Name, Stop Code, Stop GTFS ID and a list of upcoming routes with their arrival times for a limit number of entries.
Display HSL stops as a list also showing the upcoming route
type: entities
entities:
- entity: sensor.toolontori_h0209_2
- entity: sensor.toolontori_h0209_all
- entity: sensor.toolontori_h0209_8
- entity: sensor.jupperi_e1465_all
title: HSL Lines
show_header_toggle: false
Display a HSL stop with attributes showing route, arrival time and destination
type: entities
title: HSL - Route - 8
entities:
- type: attribute
icon: 'mdi:city-variant'
entity: sensor.toolontori_h0209_8
attribute: STOP NAME
name: Stop Name
- type: attribute
icon: 'mdi:format-title'
entity: sensor.toolontori_h0209_8
attribute: STOP CODE
name: Stop Code
- type: attribute
icon: 'mdi:bus'
entity: sensor.toolontori_h0209_8
attribute: ROUTE
name: Next Line
- type: attribute
icon: 'mdi:city'
entity: sensor.toolontori_h0209_8
attribute: DESTINATION
name: Destination
- type: attribute
icon: 'mdi:clock'
entity: sensor.toolontori_h0209_8
attribute: ARRIVAL TIME
name: Arrival Time
With a template sensor, more UI options are possible, such as displaying remaining time until next arrival and next two upcoming arrival times:
- platform: template
sensors:
next_route_533_1:
friendly_name: Next 533 - 1
value_template: "{% if state_attr('sensor.henttaanaukio_e3313_533', 'ROUTES') != None %}
{% if state_attr('sensor.henttaanaukio_e3313_533', 'ROUTES') | length > 0 %}
{{ state_attr('sensor.henttaanaukio_e3313_533', 'ROUTES')[0]['ARRIVAL TIME'] }}
{% else %}
'No more lines today'
{% endif %}
{% else %}
'No more lines today'
{% endif %}"
attribute_templates:
route: "{% if state_attr('sensor.henttaanaukio_e3313_533', 'ROUTES') != None %}
{% if state_attr('sensor.henttaanaukio_e3313_533', 'ROUTES') | length > 0 %}
{{ state_attr('sensor.henttaanaukio_e3313_533', 'ROUTES')[0]['ROUTE'] }}
{% else %}
'Unavailable'
{% endif %}
{% else %}
'Unavailable'
{% endif %}"
destination: "{% if state_attr('sensor.henttaanaukio_e3313_533', 'ROUTES') != None %}
{% if state_attr('sensor.henttaanaukio_e3313_533', 'ROUTES') | length > 0 %}
{{ state_attr('sensor.henttaanaukio_e3313_533', 'ROUTES')[0]['DESTINATION'] }}
{% else %}
'Unavailable'
{% endif %}
{% else %}
'Unavailable'
{% endif %}"
next_route_533_2:
friendly_name: Next 533 - 2
value_template: "{% if state_attr('sensor.henttaanaukio_e3313_533', 'ROUTES') != None %}
{% if state_attr('sensor.henttaanaukio_e3313_533', 'ROUTES') | length > 1 %}
{{ state_attr('sensor.henttaanaukio_e3313_533', 'ROUTES')[1]['ARRIVAL TIME'] }}
{% else %}
'No more lines today'
{% endif %}
{% else %}
'No more lines today'
{% endif %}"
attribute_templates:
route: "{% if state_attr('sensor.henttaanaukio_e3313_533', 'ROUTES') != None %}
{% if state_attr('sensor.henttaanaukio_e3313_533', 'ROUTES') | length > 1 %}
{{ state_attr('sensor.henttaanaukio_e3313_533', 'ROUTES')[1]['ROUTE'] }}
{% else %}
'Unavailable'
{% endif %}
{% else %}
'Unavailable'
{% endif %}"
destination: "{% if state_attr('sensor.henttaanaukio_e3313_533', 'ROUTES') != None %}
{% if state_attr('sensor.henttaanaukio_e3313_533', 'ROUTES') | length > 1 %}
{{ state_attr('sensor.henttaanaukio_e3313_533', 'ROUTES')[1]['DESTINATION'] }}
{% else %}
'Unavailable'
{% endif %}
{% else %}
'Unavailable'
{% endif %}"
time_533_remaining:
friendly_name: "Time Until Next 533 Arrival"
value_template: "{% if state_attr('sensor.henttaanaukio_e3313_533', 'ARRIVAL TIME') != None %}
{% set curr_time = now().replace(tzinfo=None) %}
{% set time_str = state_attr('sensor.henttaanaukio_e3313_533', 'ARRIVAL TIME') %}
{% set time_obj = strptime(time_str, '%H:%M:%S') %}
{% set right_time = time_obj.replace(year=curr_time.year, day=curr_time.day, month=curr_time.month) %}
{% set td = right_time - curr_time %}
{{ td.seconds | int| timestamp_custom('%H:%M:%S', false) }}
{% else %}
'Unavailable'
{% endif %}"
type: entities
title: HSL - School - 533
entities:
- type: attribute
icon: 'mdi:city-variant'
entity: sensor.henttaanaukio_e3313_533
attribute: STOP NAME
name: Stop Name
- type: attribute
icon: 'mdi:format-title'
entity: sensor.henttaanaukio_e3313_533
attribute: STOP CODE
name: Stop Code
- type: attribute
icon: 'mdi:bus'
entity: sensor.henttaanaukio_e3313_533
attribute: ROUTE
name: Next Line
- type: attribute
icon: 'mdi:city'
entity: sensor.henttaanaukio_e3313_533
attribute: DESTINATION
name: Destination
- type: attribute
icon: 'mdi:clock'
entity: sensor.henttaanaukio_e3313_533
attribute: ARRIVAL TIME
name: Arrival Time
- entity: sensor.time_533_remaining
name: Time Until Next Arrival
- entity: sensor.next_route_533_1
name: Next 533 Option 1
- entity: sensor.next_route_533_2
name: Next 533 Option 2
With a template sensor, show the upcoming routes at a stop as a table:
##
## HSL Next Routes and Remaining Times!
##
## Norotie V1530
- platform: template
sensors:
next_route_v1530_1:
friendly_name: Next Route - 1
value_template: "{% if state_attr('sensor.norotie_v1530_all', 'ROUTES') != None %}
{% if state_attr('sensor.norotie_v1530_all', 'ROUTES') | length > 0 %}
{{ state_attr('sensor.norotie_v1530_all', 'ROUTES')[0]['ROUTE'] }}
{% else %}
'NA'
{% endif %}
{% else %}
'NA'
{% endif %}"
attribute_templates:
arrival_time: "{% if state_attr('sensor.norotie_v1530_all', 'ROUTES') != None %}
{% if state_attr('sensor.norotie_v1530_all', 'ROUTES') | length > 0 %}
{{ state_attr('sensor.norotie_v1530_all', 'ROUTES')[0]['ARRIVAL TIME'] }}
{% else %}
'Unavailable'
{% endif %}
{% else %}
'Unavailable'
{% endif %}"
destination: "{% if state_attr('sensor.norotie_v1530_all', 'ROUTES') != None %}
{% if state_attr('sensor.norotie_v1530_all', 'ROUTES') | length > 0 %}
{{ state_attr('sensor.norotie_v1530_all', 'ROUTES')[0]['DESTINATION'] }}
{% else %}
'Unavailable'
{% endif %}
{% else %}
'Unavailable'
{% endif %}"
next_route_v1530_2:
friendly_name: Next Route - 2
value_template: "{% if state_attr('sensor.norotie_v1530_all', 'ROUTES') != None %}
{% if state_attr('sensor.norotie_v1530_all', 'ROUTES') | length > 1 %}
{{ state_attr('sensor.norotie_v1530_all', 'ROUTES')[1]['ROUTE'] }}
{% else %}
'NA'
{% endif %}
{% else %}
'NA'
{% endif %}"
attribute_templates:
arrival_time: "{% if state_attr('sensor.norotie_v1530_all', 'ROUTES') != None %}
{% if state_attr('sensor.norotie_v1530_all', 'ROUTES') | length > 1 %}
{{ state_attr('sensor.norotie_v1530_all', 'ROUTES')[1]['ARRIVAL TIME'] }}
{% else %}
'Unavailable'
{% endif %}
{% else %}
'Unavailable'
{% endif %}"
destination: "{% if state_attr('sensor.norotie_v1530_all', 'ROUTES') != None %}
{% if state_attr('sensor.norotie_v1530_all', 'ROUTES') | length > 1 %}
{{ state_attr('sensor.norotie_v1530_all', 'ROUTES')[1]['DESTINATION'] }}
{% else %}
'Unavailable'
{% endif %}
{% else %}
'Unavailable'
{% endif %}"
next_route_v1530_3:
friendly_name: Next Route - 3
value_template: "{% if state_attr('sensor.norotie_v1530_all', 'ROUTES') != None %}
{% if state_attr('sensor.norotie_v1530_all', 'ROUTES') | length > 2 %}
{{ state_attr('sensor.norotie_v1530_all', 'ROUTES')[2]['ROUTE'] }}
{% else %}
'NA'
{% endif %}
{% else %}
'NA'
{% endif %}"
attribute_templates:
arrival_time: "{% if state_attr('sensor.norotie_v1530_all', 'ROUTES') != None %}
{% if state_attr('sensor.norotie_v1530_all', 'ROUTES') | length > 2 %}
{{ state_attr('sensor.norotie_v1530_all', 'ROUTES')[2]['ARRIVAL TIME'] }}
{% else %}
'Unavailable'
{% endif %}
{% else %}
'Unavailable'
{% endif %}"
destination: "{% if state_attr('sensor.norotie_v1530_all', 'ROUTES') != None %}
{% if state_attr('sensor.norotie_v1530_all', 'ROUTES') | length > 2 %}
{{ state_attr('sensor.norotie_v1530_all', 'ROUTES')[2]['DESTINATION'] }}
{% else %}
'Unavailable'
{% endif %}
{% else %}
'Unavailable'
{% endif %}"
next_route_v1530_4:
friendly_name: Next Route - 4
value_template: "{% if state_attr('sensor.norotie_v1530_all', 'ROUTES') != None %}
{% if state_attr('sensor.norotie_v1530_all', 'ROUTES') | length > 3 %}
{{ state_attr('sensor.norotie_v1530_all', 'ROUTES')[3]['ROUTE'] }}
{% else %}
'NA'
{% endif %}
{% else %}
'NA'
{% endif %}"
attribute_templates:
arrival_time: "{% if state_attr('sensor.norotie_v1530_all', 'ROUTES') != None %}
{% if state_attr('sensor.norotie_v1530_all', 'ROUTES') | length > 3 %}
{{ state_attr('sensor.norotie_v1530_all', 'ROUTES')[3]['ARRIVAL TIME'] }}
{% else %}
'Unavailable'
{% endif %}
{% else %}
'Unavailable'
{% endif %}"
destination: "{% if state_attr('sensor.norotie_v1530_all', 'ROUTES') != None %}
{% if state_attr('sensor.norotie_v1530_all', 'ROUTES') | length > 3 %}
{{ state_attr('sensor.norotie_v1530_all', 'ROUTES')[3]['DESTINATION'] }}
{% else %}
'Unavailable'
{% endif %}
{% else %}
'Unavailable'
{% endif %}"
next_route_v1530_5:
friendly_name: Next Route - 5
value_template: "{% if state_attr('sensor.norotie_v1530_all', 'ROUTES') != None %}
{% if state_attr('sensor.norotie_v1530_all', 'ROUTES') | length > 4 %}
{{ state_attr('sensor.norotie_v1530_all', 'ROUTES')[4]['ROUTE'] }}
{% else %}
'NA'
{% endif %}
{% else %}
'NA'
{% endif %}"
attribute_templates:
arrival_time: "{% if state_attr('sensor.norotie_v1530_all', 'ROUTES') != None %}
{% if state_attr('sensor.norotie_v1530_all', 'ROUTES') | length > 4 %}
{{ state_attr('sensor.norotie_v1530_all', 'ROUTES')[4]['ARRIVAL TIME'] }}
{% else %}
'Unavailable'
{% endif %}
{% else %}
'Unavailable'
{% endif %}"
destination: "{% if state_attr('sensor.norotie_v1530_all', 'ROUTES') != None %}
{% if state_attr('sensor.norotie_v1530_all', 'ROUTES') | length > 4 %}
{{ state_attr('sensor.norotie_v1530_all', 'ROUTES')[4]['DESTINATION'] }}
{% else %}
'Unavailable'
{% endif %}
{% else %}
'Unavailable'
{% endif %}"
type: entity-filter
entities:
- sensor.next_route_v1530_1
- sensor.next_route_v1530_2
- sensor.next_route_v1530_3
- sensor.next_route_v1530_4
- sensor.next_route_v1530_5
state_filter:
- operator: '!='
value: "'NA'"
card:
type: markdown
content: >-
| Arrival Time | Route | Destination |
| :----------- | :---- | :---------- |
| {% set n = 0 %} {% if config.entities | length > n %} {{
state_attr(config.entities[n].entity, 'arrival_time') }} | {{
states(config.entities[n].entity) }} | {{
state_attr(config.entities[n].entity, 'destination') }} {% endif %} |
| {% set n = 1 %} {% if config.entities | length > n %} {{
state_attr(config.entities[n].entity, 'arrival_time') }} | {{
states(config.entities[n].entity) }} | {{
state_attr(config.entities[n].entity, 'destination') }} {% endif %} |
| {% set n = 2 %} {% if config.entities | length > n %} {{
state_attr(config.entities[n].entity, 'arrival_time') }} | {{
states(config.entities[n].entity) }} | {{
state_attr(config.entities[n].entity, 'destination') }} {% endif %} |
| {% set n = 3 %} {% if config.entities | length > n %} {{
state_attr(config.entities[n].entity, 'arrival_time') }} | {{
states(config.entities[n].entity) }} | {{
state_attr(config.entities[n].entity, 'destination') }} {% endif %} |
| {% set n = 4 %} {% if config.entities | length > n %} {{
state_attr(config.entities[n].entity, 'arrival_time') }} | {{
states(config.entities[n].entity) }} | {{
state_attr(config.entities[n].entity, 'destination') }} {% endif %} |
| {% set n = 5 %} {% if config.entities | length > n %} {{
state_attr(config.entities[n].entity, 'arrival_time') }} | {{
states(config.entities[n].entity) }} | {{
state_attr(config.entities[n].entity, 'destination') }} {% endif %} |
title: V1530 Next Lines
Note: Sometimes the API query returns wierd results such as blank destinations or route numbers. If you see something like this, leave a comment and I can take a look at pruning the results further.
Anand Radhakrishnan @anand-p-r
Mathias Backman @fimathias
Harri Kapanen @hkapanen