Skip to content

Instantly share code, notes, and snippets.

@AnderssonPeter
Last active June 18, 2022 18:34
Show Gist options
  • Save AnderssonPeter/36c5462055356c610b37d73b50ae8682 to your computer and use it in GitHub Desktop.
Save AnderssonPeter/36c5462055356c610b37d73b50ae8682 to your computer and use it in GitHub Desktop.
custom sensor component to work against trafikverket in home assistant
#example configuration
sensor:
- platform: trafikverket
api_key: !secret trafikverket_api_key
trains:
- name: "Train to work"
from: Sölvesborg
to: Kristianstad C
time: "07:28"
- name: "Train from work early"
from: Kristianstad C
to: Sölvesborg
time: "16:38"
- name: "Train from work late"
from: Kristianstad C
to: Sölvesborg
time: "17:02"
script:
notify_train_status:
alias: Notify train status
sequence:
- service: notify.notify
data_template:
title: "{{ states.sensor[train_entity_id].attributes.friendly_name }}"
message: >
{{ states.sensor[train_entity_id].attributes.friendly_name }} är {{ '' }}
{%- if is_state('sensor.' + train_entity_id, 'delayed') -%}
försenat med {{ '' }}
{{- states.sensor[train_entity_id].attributes.number_of_minutes_delayed|int -}}
{{ '' }} minuter
{%- elif is_state('sensor.' + train_entity_id, 'canceled') -%}
inställt
{%- else -%}
i tid
{%- endif -%}
{%- if states.sensor[train_entity_id].attributes.other_information -%}
, övrig information: {{ states.sensor[train_entity_id].attributes.other_information -}}
{%- endif -%}
{%- if states.sensor[train_entity_id].attributes.deviations -%}
, avvikelser: {{ states.sensor[train_entity_id].attributes.deviations -}}
{%- endif -%}
.
data:
icon: "https://materialdesignicons.com/api/download/B6E1232A-3A43-4200-BE34-1BC436B34BF1/FFFFFF/1/FFFFFF/0/128"
automation:
- alias: "Train to work notification"
trigger:
platform: state
entity_id: sensor.train_to_work
condition:
- condition: and
conditions:
- condition: time
weekday:
- mon
- tue
- wed
- thu
- fri
- condition: or
conditions:
- condition: state
entity_id: sensor.train_to_work
state: 'delayed'
- condition: state
entity_id: sensor.train_to_work
state: 'canceled'
action:
service: script.turn_on
entity_id: script.notify_train_status
data:
variables:
train_entity_id: 'train_to_work'
- alias: "Train from work early notification"
trigger:
platform: state
entity_id: sensor.train_from_work_early
condition:
- condition: and
conditions:
- condition: time
weekday:
- mon
- tue
- wed
- thu
- fri
- condition: or
conditions:
- condition: state
entity_id: sensor.train_from_work_early
state: 'delayed'
- condition: state
entity_id: sensor.train_from_work_early
state: 'canceled'
action:
service: script.turn_on
entity_id: script.notify_train_status
data:
variables:
train_entity_id: 'train_from_work_early'
- alias: "Train from work late notification"
trigger:
platform: state
entity_id: sensor.train_from_work_late
condition:
- condition: and
conditions:
- condition: time
weekday:
- mon
- tue
- wed
- thu
- fri
- condition: or
conditions:
- condition: state
entity_id: sensor.train_from_work_late
state: 'delayed'
- condition: state
entity_id: sensor.train_from_work_late
state: 'canceled'
action:
service: script.turn_on
entity_id: script.notify_train_status
data:
variables:
train_entity_id: 'train_from_work_late'
from datetime import date, datetime, time, timedelta
import logging
import voluptuous as vol
import asyncio
from homeassistant.components.sensor import PLATFORM_SCHEMA
import homeassistant.helpers.config_validation as cv
from homeassistant.helpers.aiohttp_client import (async_get_clientsession)
from homeassistant.helpers.entity import Entity
REQUIREMENTS = ["aiohttp==2.0.7", "pytrafikverket==0.1.5.5"]
_LOGGER = logging.getLogger(__name__)
CONF_API_KEY = "api_key"
CONF_TRAINS = "trains"
CONF_NAME = "name"
CONF_FROM = "from"
CONF_TO = "to"
CONF_TIME = "time"
ATTR_CANCELED = "canceled"
ATTR_DELAY_TIME = "number_of_minutes_delayed"
ATTR_PLANNED_TIME = "planned_time" #When it planned to arrive if no delays occure
ATTR_ESTIMATED_TIME = "estimated_time" #When its estimated to arrive when delays occure
ATTR_ACTUAL_TIME = "actual_time" #When it did arrive
ATTR_OTHER_INFORMATION = "other_information"
ATTR_DEVIATIONS = "deviations"
ICON = "mdi:train"
SCAN_INTERVAL = timedelta(minutes=5)
PLATFORM_SCHEMA = PLATFORM_SCHEMA.extend({
vol.Required(CONF_API_KEY): cv.string,
vol.Required(CONF_TRAINS): [{
vol.Required(CONF_NAME): cv.string,
vol.Required(CONF_TO): cv.string,
vol.Required(CONF_FROM): cv.string,
vol.Optional(CONF_TIME): cv.time}]
})
@asyncio.coroutine
def async_setup_platform(hass, config, async_add_devices, discovery_info=None):
"""Setup the departure sensor."""
_LOGGER.debug("start async_setup_platform")
from pytrafikverket import TrafikverketTrain
httpsession = async_get_clientsession(hass)
train_api = TrafikverketTrain(httpsession, config.get(CONF_API_KEY))
sensors = []
for train in config.get(CONF_TRAINS):
from_sig = yield from train_api.async_get_train_station(train.get(CONF_FROM))
to_sig = yield from train_api.async_get_train_station(train.get(CONF_TO))
sensor = TrainSensor(train_api,
train.get(CONF_NAME),
from_sig,
to_sig,
train.get(CONF_TIME))
#yield from sensor.async_update()
sensors.append(sensor)
# For some reason the function below is never called with `yield from` in the code base?
async_add_devices(sensors, update_before_add=True)
_LOGGER.debug("end async_setup_platform")
class TrainSensor(Entity):
""" contains data about a train depature """
def __init__(self, train_api, name, from_sig, to_sig, time):
self._train_api = train_api
self._name = name
self._from_sig = from_sig
self._to_sig = to_sig
self._time = time
self._state = None
@asyncio.coroutine
def async_update(self):
"""Retrieve latest state."""
_LOGGER.debug("start async_update")
if self._time is not None:
when = datetime.combine(date.today(), self._time)
_LOGGER.debug("self._from_sig: %s, self._to_sig: %s, when: %s", self._from_sig.name, self._to_sig.name, when)
self._state = yield from self._train_api.async_get_train_stop(self._from_sig, self._to_sig, when)
else:
_LOGGER.debug("self._from_sig: %s, self._to_sig: %s", self._from_sig, self._to_sig)
self._state = yield from self._train_api.async_get_next_train_stop(self._from_sig.name, self._to_sig.name)
_LOGGER.debug("end async_update")
@property
def device_state_attributes(self):
"""Return the state attributes."""
if self._state is not None:
state = self._state
other_information = None
if state.other_information is not None and len(state.other_information) > 0:
other_information = ", ".join(state.other_information)
deviations = None
if state.deviations is not None and len(state.deviations) > 0:
deviations = ", ".join(state.deviations)
delay_in_minutes = state.get_delay_time()
if delay_in_minutes is not None:
delay_in_minutes = delay.total_seconds() / 60
return {ATTR_CANCELED: state.canceled,
ATTR_DELAY_TIME: delay_in_minutes,
ATTR_PLANNED_TIME: state.advertised_time_at_location,
ATTR_ESTIMATED_TIME: state.estimated_time_at_location,
ATTR_ACTUAL_TIME : state.time_at_location,
ATTR_OTHER_INFORMATION: other_information,
ATTR_DEVIATIONS: deviations}
else:
return None
@property
def name(self):
"""Return the name of the sensor."""
return self._name
@property
def icon(self):
"""Return the icon for the frontend."""
return ICON
@property
def state(self):
"""Return the departure state."""
if self._state is not None:
return self._state.get_state().name
else:
return None
@ChristopherSathen
Copy link

Hej, har haft stor nytta av detta script men det har slutat fungera för ett tag sedan eftersom det är nya värden ifrån Trafikverkets API. Nu verkar status flyttat ifrån entity_status till attributes. Jag kan tyvärr inte koda och undrar om du skulle kunna göra en uppdatering av scriptet mot de nya värdena.

@AnderssonPeter
Copy link
Author

Hej @ChristopherSathen Om du använder detta i homeassistant så tror jag dom har en egen integration med trafikverket, som bygger på https://github.com/endor-force/pytrafikverket https://www.home-assistant.io/integrations/trafikverket_train/

Alternativ så kan du kolla om endor-force/pytrafikverket har fixat buggen och fixa den på samma sätt? (Jag har typ ingen koll på python och använder själv inte koden ovan längre)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment