Home Assistant Unofficial Reference 2024.12.1
homeassistant.components.rejseplanen.sensor Namespace Reference

Classes

class  PublicTransportData
 
class  RejseplanenTransportSensor
 

Functions

def due_in_minutes (timestamp)
 
None setup_platform (HomeAssistant hass, ConfigType config, AddEntitiesCallback add_devices, DiscoveryInfoType|None discovery_info=None)
 

Variables

 _LOGGER = logging.getLogger(__name__)
 
string ATTR_DIRECTION = "direction"
 
string ATTR_DUE_AT = "due_at"
 
string ATTR_DUE_IN = "due_in"
 
string ATTR_FINAL_STOP = "final_stop"
 
string ATTR_NEXT_UP = "next_departures"
 
string ATTR_REAL_TIME_AT = "real_time_at"
 
string ATTR_ROUTE = "route"
 
string ATTR_SCHEDULED_AT = "scheduled_at"
 
string ATTR_STOP_ID = "stop_id"
 
string ATTR_STOP_NAME = "stop"
 
string ATTR_TRACK = "track"
 
string ATTR_TYPE = "type"
 
list BUS_TYPES = ["BUS", "EXB", "TB"]
 
string CONF_DEPARTURE_TYPE = "departure_type"
 
string CONF_DIRECTION = "direction"
 
string CONF_ROUTE = "route"
 
string CONF_STOP_ID = "stop_id"
 
string DEFAULT_NAME = "Next departure"
 
list METRO_TYPES = ["M"]
 
 PLATFORM_SCHEMA
 
 SCAN_INTERVAL = timedelta(minutes=1)
 
list TRAIN_TYPES = ["LET", "S", "REG", "IC", "LYN", "TOG"]
 

Detailed Description

Support for Rejseplanen information from rejseplanen.dk.

For more info on the API see:
https://help.rejseplanen.dk/hc/en-us/articles/214174465-Rejseplanen-s-API

Function Documentation

◆ due_in_minutes()

def homeassistant.components.rejseplanen.sensor.due_in_minutes (   timestamp)
Get the time in minutes from a timestamp.

The timestamp should be in the format day.month.year hour:minute

Definition at line 70 of file sensor.py.

◆ setup_platform()

None homeassistant.components.rejseplanen.sensor.setup_platform ( HomeAssistant  hass,
ConfigType  config,
AddEntitiesCallback  add_devices,
DiscoveryInfoType | None   discovery_info = None 
)
Set up the Rejseplanen transport sensor.

Definition at line 82 of file sensor.py.

Variable Documentation

◆ _LOGGER

homeassistant.components.rejseplanen.sensor._LOGGER = logging.getLogger(__name__)
private

Definition at line 28 of file sensor.py.

◆ ATTR_DIRECTION

string homeassistant.components.rejseplanen.sensor.ATTR_DIRECTION = "direction"

Definition at line 34 of file sensor.py.

◆ ATTR_DUE_AT

string homeassistant.components.rejseplanen.sensor.ATTR_DUE_AT = "due_at"

Definition at line 37 of file sensor.py.

◆ ATTR_DUE_IN

string homeassistant.components.rejseplanen.sensor.ATTR_DUE_IN = "due_in"

Definition at line 36 of file sensor.py.

◆ ATTR_FINAL_STOP

string homeassistant.components.rejseplanen.sensor.ATTR_FINAL_STOP = "final_stop"

Definition at line 35 of file sensor.py.

◆ ATTR_NEXT_UP

string homeassistant.components.rejseplanen.sensor.ATTR_NEXT_UP = "next_departures"

Definition at line 41 of file sensor.py.

◆ ATTR_REAL_TIME_AT

string homeassistant.components.rejseplanen.sensor.ATTR_REAL_TIME_AT = "real_time_at"

Definition at line 39 of file sensor.py.

◆ ATTR_ROUTE

string homeassistant.components.rejseplanen.sensor.ATTR_ROUTE = "route"

Definition at line 32 of file sensor.py.

◆ ATTR_SCHEDULED_AT

string homeassistant.components.rejseplanen.sensor.ATTR_SCHEDULED_AT = "scheduled_at"

Definition at line 38 of file sensor.py.

◆ ATTR_STOP_ID

string homeassistant.components.rejseplanen.sensor.ATTR_STOP_ID = "stop_id"

Definition at line 30 of file sensor.py.

◆ ATTR_STOP_NAME

string homeassistant.components.rejseplanen.sensor.ATTR_STOP_NAME = "stop"

Definition at line 31 of file sensor.py.

◆ ATTR_TRACK

string homeassistant.components.rejseplanen.sensor.ATTR_TRACK = "track"

Definition at line 40 of file sensor.py.

◆ ATTR_TYPE

string homeassistant.components.rejseplanen.sensor.ATTR_TYPE = "type"

Definition at line 33 of file sensor.py.

◆ BUS_TYPES

list homeassistant.components.rejseplanen.sensor.BUS_TYPES = ["BUS", "EXB", "TB"]

Definition at line 53 of file sensor.py.

◆ CONF_DEPARTURE_TYPE

string homeassistant.components.rejseplanen.sensor.CONF_DEPARTURE_TYPE = "departure_type"

Definition at line 46 of file sensor.py.

◆ CONF_DIRECTION

string homeassistant.components.rejseplanen.sensor.CONF_DIRECTION = "direction"

Definition at line 45 of file sensor.py.

◆ CONF_ROUTE

string homeassistant.components.rejseplanen.sensor.CONF_ROUTE = "route"

Definition at line 44 of file sensor.py.

◆ CONF_STOP_ID

string homeassistant.components.rejseplanen.sensor.CONF_STOP_ID = "stop_id"

Definition at line 43 of file sensor.py.

◆ DEFAULT_NAME

string homeassistant.components.rejseplanen.sensor.DEFAULT_NAME = "Next departure"

Definition at line 48 of file sensor.py.

◆ METRO_TYPES

list homeassistant.components.rejseplanen.sensor.METRO_TYPES = ["M"]

Definition at line 55 of file sensor.py.

◆ PLATFORM_SCHEMA

homeassistant.components.rejseplanen.sensor.PLATFORM_SCHEMA
Initial value:
1 = SENSOR_PLATFORM_SCHEMA.extend(
2  {
3  vol.Required(CONF_STOP_ID): cv.string,
4  vol.Optional(CONF_NAME, default=DEFAULT_NAME): cv.string,
5  vol.Optional(CONF_ROUTE, default=[]): vol.All(cv.ensure_list, [cv.string]),
6  vol.Optional(CONF_DIRECTION, default=[]): vol.All(cv.ensure_list, [cv.string]),
7  vol.Optional(CONF_DEPARTURE_TYPE, default=[]): vol.All(
8  cv.ensure_list, [vol.In([*BUS_TYPES, *TRAIN_TYPES, *METRO_TYPES])]
9  ),
10  }
11 )

Definition at line 57 of file sensor.py.

◆ SCAN_INTERVAL

homeassistant.components.rejseplanen.sensor.SCAN_INTERVAL = timedelta(minutes=1)

Definition at line 51 of file sensor.py.

◆ TRAIN_TYPES

list homeassistant.components.rejseplanen.sensor.TRAIN_TYPES = ["LET", "S", "REG", "IC", "LYN", "TOG"]

Definition at line 54 of file sensor.py.