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

Classes

class  IrishRailTransportData
 
class  IrishRailTransportSensor
 

Functions

None setup_platform (HomeAssistant hass, ConfigType config, AddEntitiesCallback add_entities, DiscoveryInfoType|None discovery_info=None)
 

Variables

string ATTR_DESTINATION = "Destination"
 
string ATTR_DIRECTION = "Direction"
 
string ATTR_DUE_AT = "Due at"
 
string ATTR_DUE_IN = "Due in"
 
string ATTR_EXPECT_AT = "Expected at"
 
string ATTR_NEXT_UP = "Later Train"
 
string ATTR_ORIGIN = "Origin"
 
string ATTR_STATION = "Station"
 
string ATTR_STOPS_AT = "Stops at"
 
string ATTR_TRAIN_TYPE = "Train type"
 
string CONF_DESTINATION = "destination"
 
string CONF_DIRECTION = "direction"
 
string CONF_STATION = "station"
 
string CONF_STOPS_AT = "stops_at"
 
string DEFAULT_NAME = "Next Train"
 
 PLATFORM_SCHEMA
 
 SCAN_INTERVAL = timedelta(minutes=2)
 
string TIME_STR_FORMAT = "%H:%M"
 

Detailed Description

Support for Irish Rail RTPI information.

Function Documentation

◆ setup_platform()

None homeassistant.components.irish_rail_transport.sensor.setup_platform ( HomeAssistant  hass,
ConfigType  config,
AddEntitiesCallback  add_entities,
DiscoveryInfoType | None   discovery_info = None 
)
Set up the Irish Rail transport sensor.

Definition at line 54 of file sensor.py.

Variable Documentation

◆ ATTR_DESTINATION

string homeassistant.components.irish_rail_transport.sensor.ATTR_DESTINATION = "Destination"

Definition at line 23 of file sensor.py.

◆ ATTR_DIRECTION

string homeassistant.components.irish_rail_transport.sensor.ATTR_DIRECTION = "Direction"

Definition at line 24 of file sensor.py.

◆ ATTR_DUE_AT

string homeassistant.components.irish_rail_transport.sensor.ATTR_DUE_AT = "Due at"

Definition at line 27 of file sensor.py.

◆ ATTR_DUE_IN

string homeassistant.components.irish_rail_transport.sensor.ATTR_DUE_IN = "Due in"

Definition at line 26 of file sensor.py.

◆ ATTR_EXPECT_AT

string homeassistant.components.irish_rail_transport.sensor.ATTR_EXPECT_AT = "Expected at"

Definition at line 28 of file sensor.py.

◆ ATTR_NEXT_UP

string homeassistant.components.irish_rail_transport.sensor.ATTR_NEXT_UP = "Later Train"

Definition at line 29 of file sensor.py.

◆ ATTR_ORIGIN

string homeassistant.components.irish_rail_transport.sensor.ATTR_ORIGIN = "Origin"

Definition at line 22 of file sensor.py.

◆ ATTR_STATION

string homeassistant.components.irish_rail_transport.sensor.ATTR_STATION = "Station"

Definition at line 21 of file sensor.py.

◆ ATTR_STOPS_AT

string homeassistant.components.irish_rail_transport.sensor.ATTR_STOPS_AT = "Stops at"

Definition at line 25 of file sensor.py.

◆ ATTR_TRAIN_TYPE

string homeassistant.components.irish_rail_transport.sensor.ATTR_TRAIN_TYPE = "Train type"

Definition at line 30 of file sensor.py.

◆ CONF_DESTINATION

string homeassistant.components.irish_rail_transport.sensor.CONF_DESTINATION = "destination"

Definition at line 33 of file sensor.py.

◆ CONF_DIRECTION

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

Definition at line 34 of file sensor.py.

◆ CONF_STATION

string homeassistant.components.irish_rail_transport.sensor.CONF_STATION = "station"

Definition at line 32 of file sensor.py.

◆ CONF_STOPS_AT

string homeassistant.components.irish_rail_transport.sensor.CONF_STOPS_AT = "stops_at"

Definition at line 35 of file sensor.py.

◆ DEFAULT_NAME

string homeassistant.components.irish_rail_transport.sensor.DEFAULT_NAME = "Next Train"

Definition at line 37 of file sensor.py.

◆ PLATFORM_SCHEMA

homeassistant.components.irish_rail_transport.sensor.PLATFORM_SCHEMA
Initial value:
1 = SENSOR_PLATFORM_SCHEMA.extend(
2  {
3  vol.Required(CONF_STATION): cv.string,
4  vol.Optional(CONF_DIRECTION): cv.string,
5  vol.Optional(CONF_DESTINATION): cv.string,
6  vol.Optional(CONF_STOPS_AT): cv.string,
7  vol.Optional(CONF_NAME, default=DEFAULT_NAME): cv.string,
8  }
9 )

Definition at line 43 of file sensor.py.

◆ SCAN_INTERVAL

homeassistant.components.irish_rail_transport.sensor.SCAN_INTERVAL = timedelta(minutes=2)

Definition at line 40 of file sensor.py.

◆ TIME_STR_FORMAT

string homeassistant.components.irish_rail_transport.sensor.TIME_STR_FORMAT = "%H:%M"

Definition at line 41 of file sensor.py.