Clarified API requirement (#9839)

Clarified the API key needed and simplified the stop finding method. 

The transport NSW API documentation wasn't super clear and it's easy to get lost in the OpenData portal. Hopefully this helps the next person.
This commit is contained in:
danu5 2019-07-12 21:27:16 +10:00 committed by Fabian Affolter
parent 0190af09b7
commit 19b1583712

View File

@ -14,9 +14,11 @@ The `transport_nsw` sensor will give you the time until the next departure from
## Setup
Prerequisite is a free API key from [Transport NSW](https://opendata.transport.nsw.gov.au/).
Prerequisite is a free API key from [Transport NSW](https://opendata.transport.nsw.gov.au/). You will need to register an account and then create a new application. You will need to add the 'Trip Planner APIs' to your application.
In order to find your stop id, go to Google maps and click on any bus/train/ferry stop. The pop up window shows the stop ID underneath the station name. For train stations the easist way to get a stop id for a platform is through [Transport NSW Info](https://transportnsw.info/).
In order to find your stop id, use the [Transport NSW stop finder](https://transportnsw.info/stop#/) and search for your stop. The URL will contain the stop id as a number.
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 easist way to get a stop id for a platform is through [Transport NSW Info](https://transportnsw.info/).
As a default the sensor picks up the next mode of transport leaving from a stop id.