Skip to content

Update UK Transport documentation as per latest API #41672

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: next
Choose a base branch
from
Open

Update UK Transport documentation as per latest API #41672

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 7 additions & 3 deletions source/_integrations/uk_transport.markdown
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ Additional sensors can be added but at the expense of a reduced refresh rate. 2

Queries are entered as a list, with the two transport modes available being `bus` and `train`.

Train departure sensors require three character long `origin` and `destination` station codes which are searchable on the [National Rail enquiries](https://www.nationalrail.co.uk/times_fares/ldb.aspx) website (e.g., `WAT` is London Waterloo). The validity of a route can be checked by performing a GET request to `/uk/train/station/{station_code}/live.json` in the [API reference webpage](https://developer.transportapi.com/docs?raml=https://transportapi.com/v3/raml/transportapi.raml#request_uk_train_station_station_code_live_json).
Train departure sensors require three character long `origin` and `destination` station codes which are searchable on the [National Rail enquiries](https://www.nationalrail.co.uk/times_fares/ldb.aspx) website (e.g., `WAT` is London Waterloo). The validity of a route can be checked by performing a GET request to `/uk/train/station_timetables/{station_code}.json` in the [API reference webpage](https://developer.transportapi.com/docs?raml=https://transportapi.com/v3/raml/transportapi.raml#request_uk_train_station_station_code_live_json).

To add a single train departure {% term integration %} add the following to your {% term "`configuration.yaml`" %} file.
{% include integrations/restart_ha_after_config_inclusion.md %}
Expand All @@ -49,6 +49,10 @@ app_key:
description: Your application Key.
required: true
type: string
app_limit:
description: Maximum number of allowed API calls in a day
required: false
type: integer
queries:
description: At least one entry required.
required: true
Expand Down Expand Up @@ -117,7 +121,7 @@ follows:
3. Tick the 'map data' layer, and wait for clickable objects to load.
4. Click the bus stop node to reveal its tags on the left.

The `destination` must be a valid location in the "direction" field returned by a GET query to `/uk/bus/stop/{atcocode}/live.json` as described in the [API reference webpage](https://developer.transportapi.com/docs?raml=https://transportapi.com/v3/raml/transportapi.raml##bus_information). A bus sensor is added in the following {% term "`configuration.yaml`" %} file entry:
The `destination` must be a valid location in the "direction" field returned by a GET query to `/uk/bus/stop_timetables/{atcocode}.json` as described in the [API reference webpage](https://developer.transportapi.com/docs?raml=https://transportapi.com/v3/raml/transportapi.raml##bus_information). Multiple destinations separated by comma can be provided in `destination`. A bus sensor is added in the following {% term "`configuration.yaml`" %} file entry:

```yaml
# Example configuration.yaml entry for multiple sensors
Expand Down Expand Up @@ -158,4 +162,4 @@ template:

If you wish to manage the rate of API requests (e.g., to disable requests when you aren't interested in travel, so that you can request updates more frequently when you do travel) set a really long `scan_interval` in the configuration options, and use the `homeassistant.update_entity` action to request the update of an {% term entity %}, rather than waiting for the next scheduled update.

Powered by [transportAPI](https://www.transportapi.com/)
Powered by [transportAPI](https://www.transportapi.com/)****