Transport NSW
The transport_nsw
sensor will give you the time until the next departure from a Transport NSW stop for bus, train, light rail or ferry.
Setup
Prerequisite is a free API key from Transport NSW
In order to find your stop id, use the Transport NSW stop finder
You may also try going to Google maps and clicking on any bus/train/ferry stop. The pop up window shows the stop ID underneath the station name. For train stations the easiest way to get a stop id for a platform is through Transport NSW Info
As a default the sensor picks up the next mode of transport leaving from a stop id.
Configuration
To enable the sensor, add the following lines to your configuration.yaml
The configuration.yaml file is the main configuration file for Home Assistant. It lists the integrations to be loaded and their specific configurations. In some cases, the configuration needs to be edited manually directly in the configuration.yaml file. Most integrations can be configured in the UI. [Learn more] file:
# Example configuration.yaml entry
sensor:
- platform: transport_nsw
stop_id: "200024"
api_key: "YOUR API KEY"
Configuration Variables
Filter on bus route at the stop. This is the same as the bus number, e.g., 83
.
Useful for ferry or train stops to filter the destination of the sensor, e.g., Circular Quay
.
The public information is provided from Transport NSW
Examples
More example configurations for bus or ferry.
# Example bus route configuration.yaml entry
sensor:
- platform: transport_nsw
name: "Bus"
stop_id: "209516"
route: '199'
api_key: "YOUR API KEY"
# Example ferry configuration.yaml entry
sensor:
- platform: transport_nsw
name: "Ferry"
stop_id: "10102008"
destination: "Circular Quay"
api_key: "YOUR API KEY"
The sensor returns n/a if no stop event is found within the next 24h. A template
sensor can help building a more meaningful string.
# Sample template sensor
template:
- sensor:
- name: "Bus monitor 199"
state: >-
{% if is_state_attr('sensor.bus', 'due', 'n/a') %}
No schedule found
{% else %}
{{ state_attr('sensor.bus', 'route') }} in {{ state_attr('sensor.bus', 'due') }}m ({{ state_attr('sensor.bus', 'delay') }})
{% endif %}