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

Classes

class  PublicTransportData
 
class  TransportNSWSensor
 

Functions

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

Variables

string ATTR_DELAY = "delay"
 
string ATTR_DESTINATION = "destination"
 
string ATTR_DUE_IN = "due"
 
string ATTR_REAL_TIME = "real_time"
 
string ATTR_ROUTE = "route"
 
string ATTR_STOP_ID = "stop_id"
 
string CONF_DESTINATION = "destination"
 
string CONF_ROUTE = "route"
 
string CONF_STOP_ID = "stop_id"
 
string DEFAULT_NAME = "Next Bus"
 
dictionary ICONS
 
 PLATFORM_SCHEMA
 
 SCAN_INTERVAL = timedelta(seconds=60)
 

Detailed Description

Support for Transport NSW (AU) to query next leave event.

Function Documentation

◆ _get_value()

def homeassistant.components.transport_nsw.sensor._get_value (   value)
private
Replace the API response 'n/a' value with None.

Definition at line 134 of file sensor.py.

◆ setup_platform()

None homeassistant.components.transport_nsw.sensor.setup_platform ( HomeAssistant  hass,
ConfigType  config,
AddEntitiesCallback  add_entities,
DiscoveryInfoType | None   discovery_info = None 
)
Set up the Transport NSW sensor.

Definition at line 59 of file sensor.py.

Variable Documentation

◆ ATTR_DELAY

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

Definition at line 26 of file sensor.py.

◆ ATTR_DESTINATION

string homeassistant.components.transport_nsw.sensor.ATTR_DESTINATION = "destination"

Definition at line 28 of file sensor.py.

◆ ATTR_DUE_IN

string homeassistant.components.transport_nsw.sensor.ATTR_DUE_IN = "due"

Definition at line 25 of file sensor.py.

◆ ATTR_REAL_TIME

string homeassistant.components.transport_nsw.sensor.ATTR_REAL_TIME = "real_time"

Definition at line 27 of file sensor.py.

◆ ATTR_ROUTE

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

Definition at line 24 of file sensor.py.

◆ ATTR_STOP_ID

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

Definition at line 23 of file sensor.py.

◆ CONF_DESTINATION

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

Definition at line 32 of file sensor.py.

◆ CONF_ROUTE

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

Definition at line 31 of file sensor.py.

◆ CONF_STOP_ID

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

Definition at line 30 of file sensor.py.

◆ DEFAULT_NAME

string homeassistant.components.transport_nsw.sensor.DEFAULT_NAME = "Next Bus"

Definition at line 34 of file sensor.py.

◆ ICONS

dictionary homeassistant.components.transport_nsw.sensor.ICONS
Initial value:
1 = {
2  "Train": "mdi:train",
3  "Lightrail": "mdi:tram",
4  "Bus": "mdi:bus",
5  "Coach": "mdi:bus",
6  "Ferry": "mdi:ferry",
7  "Schoolbus": "mdi:bus",
8  "n/a": "mdi:clock",
9  None: "mdi:clock",
10 }

Definition at line 35 of file sensor.py.

◆ PLATFORM_SCHEMA

homeassistant.components.transport_nsw.sensor.PLATFORM_SCHEMA
Initial value:
1 = SENSOR_PLATFORM_SCHEMA.extend(
2  {
3  vol.Required(CONF_STOP_ID): cv.string,
4  vol.Required(CONF_API_KEY): cv.string,
5  vol.Optional(CONF_NAME, default=DEFAULT_NAME): cv.string,
6  vol.Optional(CONF_ROUTE, default=""): cv.string,
7  vol.Optional(CONF_DESTINATION, default=""): cv.string,
8  }
9 )

Definition at line 48 of file sensor.py.

◆ SCAN_INTERVAL

homeassistant.components.transport_nsw.sensor.SCAN_INTERVAL = timedelta(seconds=60)

Definition at line 46 of file sensor.py.