0.0.3 • Published 1 year ago
wbb-realtimetrains v0.0.3
Realtime Trains
Using this module you can find live arrival and departures for trains in the UK, thanks to APIs provided by Real Time Trains. Please see their website for more information.
Setup
In order to use this integration you will need to have registered with the service. As part of this process you'll be given a username and password which is then used in the configuration options of the responses below. You can register for an account on this page.
Responses Provided
There are three responses provided as part of this integration. These are as follows :
RTT Arrivals- Find times and platform information for trains arriving at a given station, at a specified time.RTT Departures- Similar toRTT Arrivalsexcept looking for when trains are leaving a given station.RTT Invalid Parameters- an error reponse in cases where the responses have not been configured correctly.
Handler Names
The following handler names and their functions are available :
| Handler Name | Purpose |
|---|---|
rtt-arrivals | Find times of trains arriving at a station |
rtt-departures | Find details of departing trains |
Configuration Options
Both handlers provided by the integration are configured with the same options. These are explained below :
rtt-arrivals or rtt-departures
| Property | Required | Description |
|---|---|---|
username | true | The username provided to you when registering for the RTT Service |
password | true | The password provided during registration |
noStationFoundMessageResponse | false | A message to display if the integration is unable to find the station mentioned. Alternatively you can use noStationFoundMessageBlock and provide a response ID to redirect the user to a predetermined response that might contain buttons etc. |
noResultsFoundMessage | false | What to display to the user when there are no results returned for the date, time and station specified |
multipleStationsFoundMessage | false | Sometimes a search term entered by the user can return multiple stations. This message helps the user know what to select when this happens. |
servicesCount | false | The number of results to return to the user. |