homeassistant.components.entur_public_transport.sensor Namespace Reference

Classes
class	EnturProxy
class	EnturPublicTransportSensor

Functions
None	async_setup_platform (HomeAssistant hass, ConfigType config, AddEntitiesCallback async_add_entities, DiscoveryInfoType|None discovery_info=None)
int	due_in_minutes (datetime timestamp)

Variables
string	API_CLIENT_NAME = "homeassistant-{}"
string	ATTR_DELAY = "delay"
string	ATTR_EXPECTED_AT = "due_at"
string	ATTR_NEXT_UP_AT = "next_due_at"
string	ATTR_NEXT_UP_DELAY = "next_delay"
string	ATTR_NEXT_UP_IN = "next_due_in"
string	ATTR_NEXT_UP_REALTIME = "next_real_time"
string	ATTR_NEXT_UP_ROUTE = "next_route"
string	ATTR_NEXT_UP_ROUTE_ID = "next_route_id"
string	ATTR_REALTIME = "real_time"
string	ATTR_ROUTE = "route"
string	ATTR_ROUTE_ID = "route_id"
string	ATTR_STOP_ID = "stop_id"
string	ATTR_TRANSPORT_MODE = "transport_mode"
string	CONF_EXPAND_PLATFORMS = "expand_platforms"
string	CONF_NUMBER_OF_DEPARTURES = "number_of_departures"
string	CONF_OMIT_NON_BOARDING = "omit_non_boarding"
string	CONF_STOP_IDS = "stop_ids"
string	CONF_WHITELIST_LINES = "line_whitelist"
string	DEFAULT_ICON_KEY = "bus"
string	DEFAULT_NAME = "Entur"
dictionary	ICONS
	PLATFORM_SCHEMA
	SCAN_INTERVAL = timedelta(seconds=45)

Detailed Description

Real-time information about public transport departures in Norway.

Function Documentation

async_setup_platform()

None homeassistant.components.entur_public_transport.sensor.async_setup_platform	(	HomeAssistant	hass,
		ConfigType	config,
		AddEntitiesCallback	async_add_entities,
		DiscoveryInfoType | None	discovery_info = None
	)

Set up the Entur public transport sensor.

Definition at line 93 of file sensor.py.

due_in_minutes()

int homeassistant.components.entur_public_transport.sensor.due_in_minutes

(

datetime

timestamp

)

Get the time in minutes from a timestamp.

Definition at line 85 of file sensor.py.

Variable Documentation

API_CLIENT_NAME

string homeassistant.components.entur_public_transport.sensor.API_CLIENT_NAME = "homeassistant-{}"

Definition at line 30 of file sensor.py.

ATTR_DELAY

string homeassistant.components.entur_public_transport.sensor.ATTR_DELAY = "delay"

Definition at line 72 of file sensor.py.

ATTR_EXPECTED_AT

string homeassistant.components.entur_public_transport.sensor.ATTR_EXPECTED_AT = "due_at"

Definition at line 71 of file sensor.py.

ATTR_NEXT_UP_AT

string homeassistant.components.entur_public_transport.sensor.ATTR_NEXT_UP_AT = "next_due_at"

Definition at line 78 of file sensor.py.

ATTR_NEXT_UP_DELAY

string homeassistant.components.entur_public_transport.sensor.ATTR_NEXT_UP_DELAY = "next_delay"

Definition at line 79 of file sensor.py.

ATTR_NEXT_UP_IN

string homeassistant.components.entur_public_transport.sensor.ATTR_NEXT_UP_IN = "next_due_in"

Definition at line 75 of file sensor.py.

ATTR_NEXT_UP_REALTIME

string homeassistant.components.entur_public_transport.sensor.ATTR_NEXT_UP_REALTIME = "next_real_time"

Definition at line 80 of file sensor.py.

ATTR_NEXT_UP_ROUTE

string homeassistant.components.entur_public_transport.sensor.ATTR_NEXT_UP_ROUTE = "next_route"

Definition at line 76 of file sensor.py.

ATTR_NEXT_UP_ROUTE_ID

string homeassistant.components.entur_public_transport.sensor.ATTR_NEXT_UP_ROUTE_ID = "next_route_id"

Definition at line 77 of file sensor.py.

ATTR_REALTIME

string homeassistant.components.entur_public_transport.sensor.ATTR_REALTIME = "real_time"

Definition at line 73 of file sensor.py.

ATTR_ROUTE

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

Definition at line 69 of file sensor.py.

ATTR_ROUTE_ID

string homeassistant.components.entur_public_transport.sensor.ATTR_ROUTE_ID = "route_id"

Definition at line 70 of file sensor.py.

ATTR_STOP_ID

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

Definition at line 67 of file sensor.py.

ATTR_TRANSPORT_MODE

string homeassistant.components.entur_public_transport.sensor.ATTR_TRANSPORT_MODE = "transport_mode"

Definition at line 82 of file sensor.py.

CONF_EXPAND_PLATFORMS

string homeassistant.components.entur_public_transport.sensor.CONF_EXPAND_PLATFORMS = "expand_platforms"

Definition at line 33 of file sensor.py.

CONF_NUMBER_OF_DEPARTURES

string homeassistant.components.entur_public_transport.sensor.CONF_NUMBER_OF_DEPARTURES = "number_of_departures"

Definition at line 36 of file sensor.py.

CONF_OMIT_NON_BOARDING

string homeassistant.components.entur_public_transport.sensor.CONF_OMIT_NON_BOARDING = "omit_non_boarding"

Definition at line 35 of file sensor.py.

CONF_STOP_IDS

string homeassistant.components.entur_public_transport.sensor.CONF_STOP_IDS = "stop_ids"

Definition at line 32 of file sensor.py.

CONF_WHITELIST_LINES

string homeassistant.components.entur_public_transport.sensor.CONF_WHITELIST_LINES = "line_whitelist"

Definition at line 34 of file sensor.py.

DEFAULT_ICON_KEY

string homeassistant.components.entur_public_transport.sensor.DEFAULT_ICON_KEY = "bus"

Definition at line 39 of file sensor.py.

DEFAULT_NAME

string homeassistant.components.entur_public_transport.sensor.DEFAULT_NAME = "Entur"

Definition at line 38 of file sensor.py.

ICONS

dictionary homeassistant.components.entur_public_transport.sensor.ICONS

Initial value:

=  {
    "air": "mdi:airplane",
    "bus": "mdi:bus",
    "metro": "mdi:subway",
    "rail": "mdi:train",
    "tram": "mdi:tram",
    "water": "mdi:ferry",
}

Definition at line 41 of file sensor.py.

PLATFORM_SCHEMA

homeassistant.components.entur_public_transport.sensor.PLATFORM_SCHEMA

Initial value:

=  SENSOR_PLATFORM_SCHEMA.extend(
    {
        vol.Required(CONF_STOP_IDS): vol.All(cv.ensure_list, [cv.string]),
        vol.Optional(CONF_EXPAND_PLATFORMS, default=True): cv.boolean,
        vol.Optional(CONF_NAME, default=DEFAULT_NAME): cv.string,
        vol.Optional(CONF_SHOW_ON_MAP, default=False): cv.boolean,
        vol.Optional(CONF_WHITELIST_LINES, default=[]): cv.ensure_list,
        vol.Optional(CONF_OMIT_NON_BOARDING, default=True): cv.boolean,
        vol.Optional(CONF_NUMBER_OF_DEPARTURES, default=2): vol.All(
            cv.positive_int, vol.Range(min=2, max=10)
        ),
    }
)

Definition at line 52 of file sensor.py.

SCAN_INTERVAL

homeassistant.components.entur_public_transport.sensor.SCAN_INTERVAL = timedelta(seconds=45)

Definition at line 50 of file sensor.py.