SL Traffic Information Sensor for Home Assistant

This is a fork of DSorlov SL sensor (https://github.com/DSorlov/ha-sensor-sl) which is a fork of fredrikbaberg SL sensor (https://github.com/fredrikbaberg/ha-sensor-sl).

This is a simple component for Home Assistant that can be used to create a "Departure board" for buses and trains in Stockholm, Sweden. You have to install it as a custom component and you need to get your own API keys from SL / Trafiklab.

• First, visit https://www.trafiklab.se/api and create a free account. They provide multiple APIs, the ones you want is "SL Trafikinformation 4" and "SL Störningsinformation 2". When you have your API keys, you're ready to add the component to your Home Assistant. Since this is a custom component, you need to add it manually to your config directory.

• Create a folder named custom_components under your Home Assistant config folder.

• Create a folder named sensor under the custom_components folder.

• Download sl.py from here and put it in the sensor folder.

• Edit your configuration.yaml file and add the component

# Example configuration.yaml entry
- platform: sl
  name: mölnvik
  ri4key: YOUR-RI4-KEY-HERE
  si2key: YOUR-SI2-KEY-HERE
  siteid: 4244
  lines: 474, 480C
  direction: 1
  sensor: binary_sensor.test

Configuration variables

• name: The name of the sensor (will be prefixed with "sl_")

• ri4key: Your API key from Trafiklab for the Realtidsinformation 4 API

• si2key: Your API key from Trafiklab for the Störningsinformation 2 API

• siteid: The ID of the bus stop or station you want to monitor. You can find the ID with some help from another API, sl-platsuppslag. In the example above, site 4244 is Mölnvik. (Console for the API can be found on https://www.trafiklab.se/api/sl-platsuppslag/konsol)

• lines: (optional) A comma separated list of line numbers that you are interested in. Most likely, you only want info on the bus that you usually ride. If omitted, all lines at the specified site id will be included. In the example above, lines 17, 18 and 19 will be included.

• direction: (optional) Unless your site id happens to be the end of the line, buses and trains goes in both directions. You can enter 1 or 2. If omitted, both directions are included.

• sensor: (optional) Sensor to determine if status should be updated. If sensor is 'on', or if this option is not set, update will be done.

sensor value

The sensor value is the number of minutes to the next departure. There are also a number of attributes:

unit_of_measurement: min
icon: mdi:subway
friendly_name: sl molnvik
attribution: Stockholms Lokaltrafik
departure_board: [{
 line: 474
 direction: 1
 departure: 10 min
 destination: Slussen
 diff: 10
 type: Buses
 icon: mdi:bus
}]
deviances: [{
 updated: 2018-11-16T15:59:40.063+01:00
 title: Inställd avgång
 fromDate: 2018-11-16T15:59:40.663
 toDate: 2018-11-17T00:00:00
 details: "Mölnvik kl 16:17 till Slussen är inställd pga framkomlighetsproblem - köer."
 sortOrder: 1
}]

API-call restrictions

The Bronze level API is limited to 30 API calls per minute, 10.000 per month. For a private project, Silver level does not seem possible. With 10.000 calls per month, that allows for less than one call every 4 minute.

custom_updater

For update check of this sensor, add the following to your configuration.yaml. For more information, see [custom_updater]

custom_updater:
  component_urls:
    - https://raw.githubusercontent.com/lokanx-home-assistant/ha-sensor-sl/dev/custom_updater.json
  card_urls:
    - https://raw.githubusercontent.com/lokanx-home-assistant/ha-sensor-sl/dev/custom_cards.json

Lovelace card

To display data using Lovelace, you can try the included card. Present departure times from custom component SL-sensor in a card.

Install it throgh copying the file www/sl-card.js into config_dir/www/, and use the following in your ui-lovelace.yaml file:

resources:
  - url: /local/sl-card.js
    type: js

and use the card throgh

cards:
  - type: "custom:sl-card"
    departures: true
    deviations: true
    updated: true
    adjust_times: true
    hide_departured: true
    name: Departures
    entities:
      - sensor.sl_name

• departures: Render departure section

• deviations: Render deviation section

• updated: Render the last updated time

• adjust_times: Recalculates time to departure to real time and not what was when latest updated

• hide_departured: Already departed connections are hidden. Requires adjust_times to be set to true.

• name: If specified it will not render titles per entitiy in the card, but rather have this as the card name. If not speficied it will render each sensors name