homeassistant.components.nmbs.sensor Namespace Reference

Classes
class	NMBSLiveBoard
class	NMBSSensor

Functions
def	get_delay_in_minutes (delay=0)
def	get_ride_duration (departure_time, arrival_time, delay=0)
def	get_time_until (departure_time=None)
None	setup_platform (HomeAssistant hass, ConfigType config, AddEntitiesCallback add_entities, DiscoveryInfoType|None discovery_info=None)

Variables
	_LOGGER = logging.getLogger(__name__)
int	API_FAILURE = -1
string	CONF_EXCLUDE_VIAS = "exclude_vias"
string	CONF_STATION_FROM = "station_from"
string	CONF_STATION_LIVE = "station_live"
string	CONF_STATION_TO = "station_to"
string	DEFAULT_ICON = "mdi:train"
string	DEFAULT_ICON_ALERT = "mdi:alert-octagon"
string	DEFAULT_NAME = "NMBS"
	PLATFORM_SCHEMA

Detailed Description

Get ride details and liveboard details for NMBS (Belgian railway).

Function Documentation

get_delay_in_minutes()

def homeassistant.components.nmbs.sensor.get_delay_in_minutes

(

delay = 0

)

Get the delay in minutes from a delay in seconds.

Definition at line 62 of file sensor.py.

get_ride_duration()

def homeassistant.components.nmbs.sensor.get_ride_duration	(		departure_time,
			arrival_time,
			delay = 0
	)

Calculate the total travel time in minutes.

Definition at line 67 of file sensor.py.

get_time_until()

def homeassistant.components.nmbs.sensor.get_time_until

(

departure_time = None

)

Calculate the time between now and a train's departure time.

Definition at line 53 of file sensor.py.

setup_platform()

None homeassistant.components.nmbs.sensor.setup_platform	(	HomeAssistant	hass,
		ConfigType	config,
		AddEntitiesCallback	add_entities,
		DiscoveryInfoType | None	discovery_info = None
	)

Set up the NMBS sensor with iRail API.

Definition at line 76 of file sensor.py.

Variable Documentation

_LOGGER

homeassistant.components.nmbs.sensor._LOGGER = logging.getLogger(__name__)

private

Definition at line 27 of file sensor.py.

API_FAILURE

int homeassistant.components.nmbs.sensor.API_FAILURE = -1

Definition at line 29 of file sensor.py.

CONF_EXCLUDE_VIAS

string homeassistant.components.nmbs.sensor.CONF_EXCLUDE_VIAS = "exclude_vias"

Definition at line 39 of file sensor.py.

CONF_STATION_FROM

string homeassistant.components.nmbs.sensor.CONF_STATION_FROM = "station_from"

Definition at line 36 of file sensor.py.

CONF_STATION_LIVE

string homeassistant.components.nmbs.sensor.CONF_STATION_LIVE = "station_live"

Definition at line 38 of file sensor.py.

CONF_STATION_TO

string homeassistant.components.nmbs.sensor.CONF_STATION_TO = "station_to"

Definition at line 37 of file sensor.py.

DEFAULT_ICON

string homeassistant.components.nmbs.sensor.DEFAULT_ICON = "mdi:train"

Definition at line 33 of file sensor.py.

DEFAULT_ICON_ALERT

string homeassistant.components.nmbs.sensor.DEFAULT_ICON_ALERT = "mdi:alert-octagon"

Definition at line 34 of file sensor.py.

DEFAULT_NAME

string homeassistant.components.nmbs.sensor.DEFAULT_NAME = "NMBS"

Definition at line 31 of file sensor.py.

PLATFORM_SCHEMA

homeassistant.components.nmbs.sensor.PLATFORM_SCHEMA

Initial value:

=  SENSOR_PLATFORM_SCHEMA.extend(
    {
        vol.Required(CONF_STATION_FROM): cv.string,
        vol.Required(CONF_STATION_TO): cv.string,
        vol.Optional(CONF_STATION_LIVE): cv.string,
        vol.Optional(CONF_EXCLUDE_VIAS, default=False): cv.boolean,
        vol.Optional(CONF_NAME, default=DEFAULT_NAME): cv.string,
        vol.Optional(CONF_SHOW_ON_MAP, default=False): cv.boolean,
    }
)

Definition at line 41 of file sensor.py.