Additional Module for MagicMirror² https://github.com/MichMich/MagicMirror
Please note - I no longer run a MagicMirror, so this module is no-longer supported. Feel free to fork and update as necessary.
Magic Mirror Module for UK bus information. Returns real-time info about a SPECIFIC bus stop(s).
Git clone from this repository into the modules sub-directory of the Magic Mirror installation, change directory into the newly cloned code and then run npm install.
git clone https://github.com/nwootton/MMM-UKLiveBusStopInfo.git
cd MMM-UKLiveBusStopInfo
npm installTo use this module, add it to the modules array in the config/config.js file:
modules: [
{
module: 'MMM-UKLiveBusStopInfo',
position: 'bottom_left',
header: 'Departures', //Optional - delete this line to turn OFF the header completely
config: {
atcocode: '490015165B', // ATCO code for specific bus stop
app_id: '', // TransportAPI App ID
app_key: '', // TransportAPI App Key
limit: 5, // Optional - Maximum results to display.
nextBuses: 'no', // Optional - Use expensive RealTime info from NextBuses
showRealTime: false, // Optional - show realtime departure info
showDelay: false // Optional - show delay in minutes based on Real Time info vs Time table
}
},
]There are 3 MANDATORY fields - atcocode, app_id and app_key. All the others are used to limit the amount of info you get back, especially useful for busy bus stops that serve multiple routes.
PLEASE NOTE The TransportAPI provides a sample key in their documentation that I previously referenced here. This is being removed very soon, so you MUST register to get this module to work!
The following is taken from the TransportAPI documentation here
| Option | Required Settings Description |
|---|---|
atcocode |
String. The bus stop you require information about. This value is REQUIRED Example: 490015165A |
api_id |
String. Your TransportAPI app_id Get yours here. This value is REQUIRED Example: 03zf7118 |
app_key |
String. Your TransportAPI app_key Get yours here. This value is REQUIRED Example: z9307fd87b0000c107e098d5effedc97 |
| Option | Optional Settings Description |
|---|---|
updateInterval |
Time between updates in ms. Default: 300000 (5 minutes) |
limit |
Integer. Number of departures to return. Default: 5 |
nextBuses |
String. Set this to 'yes' if you want to enable expensive calls to NextBuses. See notes below. Default: 'no' |
showRealTime |
Boolean. Show realtime departure info when used with NextBuses. Default: false |
showDelay |
Boolean. Show delay in minutes based on Real Time info vs Time table. Only accurate when used with NextBuses Default: false |
showBearing |
Boolean. Show compass direction/bearing of bus. Default: false |
To find the ATCOCode of a bus stop look at the OpenStreetMap.org transport layer and query the bus stop you are interested in.
By EXPENSIVE the cost of a call to the API without nextBuses is 1. With nextBuses it is 10. The limit is 1000 hits per day for a free account. So with a refresh rate of 5 minutes (default) and nextBuses on, you will make 288 calls per module per day (1440 minutes/day divided by 5 = 288). At 10 API points per request, that's 2880 points, almost 2000 more points a day than the free TransportAPI access allows.
To setup an account for the App_id & app_key sign up for an account here: http://www.transportapi.com/
If there are issue getting data out of the module I'm ALWAYS going to ask the following:
- Do you have an account set up at Transportapi.com?
- Do you have an app_id and app_key set up?
- Do you know the ATCOCode for the bus stop??
- If you use the live api documentation here and put in the info you want to use does it respond without an error?
- Is the info in your config the same as that you’ve used successfully in the live api docs?
- Please provide your config - at the minimum include the ATCOCode in the report - each operator supplies information slightly differently. While TransportAPI does catch most of these, I might not have.