Sign up for the National Rail Enquiries OpenLDBWS API, which will generate an token for you to use as the API key.
Only the API key is required to make the project run, everything else is optional but of course it may make sense for you to at least choose your preferred your station.
These environment variables are specified using the in the config file, allowing you to set up the station and key.
| Key | Example Value |
|---|---|
apiKey (REQUIRED) |
xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx (OpenLDBWS API key) |
TZ |
Europe/London (timezone) |
departureStation |
PAD (station code) |
destinationStation |
HWV (station code) [optional] Filters trains shown to only those that call at this station |
timeOffset |
5 [optional] (Time offset, in minutes, for the departure board. Can be used to see into the future (positive value) or past (negative value). Set 5 if you live 5 min from the station and want to hide departures that are too soon to catch) |
refreshTime |
60 (seconds between data refresh) |
screenRotation |
2 (rotates the output of the OLED) |
operatingHours |
8-22 (hours during which the data will refresh at the interval above - leave blank to run all day) |
screenBlankHours |
1-6 (hours during which the screen will be blank and data will not refresh - leave blank to never blank) |
outOfHoursName |
London Paddington (name shown when current time is outside the operatingHours) |