Skip to content

Latest commit

 

History

History
41 lines (33 loc) · 2.55 KB

README.md

File metadata and controls

41 lines (33 loc) · 2.55 KB
Raw

MMM-Tube-Status

Tube status

This a module for the MagicMirror. This module shows the status of the London Underground.

Installation

  1. Navigate into your MagicMirror's modules folder and execute git clone https://github.com/nigel-daniels/MMM-Tube-Status. A new folder MMM-Tube-Status will appear, navigate into it.
  2. Execute npm install to install the node dependencies.

Config

The entry in config.js can include the following options:

Option Description
app_id Required (SEE NOTES) This is the App ID assigned to you on the TfL Open Data Portal. Details on how to request an App ID can be found here

Type: string
api_key Required (SEE NOTES) This is the API key assigned to you on the TfL Open Data Portal. Details on how to request an API key can be found here

Type: string
show_all This determines if the module displays all of the tube lines all the time (true) or just those currently affected by some sort of outage (false). If this is used and all lines are good then a single line indicates this.

Type: boolean
Default value: true
interval How often the tube status is updated.

Type: integer
Default value: 600000 // 10 minutes

Here is an example of an entry in config.js

{
    module:		'MMM-Tube-Status',
    position:	'top_left',
    header:		'Tube Status',
    config:		{
                show_all:	 false
                }
},

Dependencies

  • request (installed via npm install)

Notes

IMPORTANT In this first version, while shown as required, the app_id and the api_key are unused until I get a response from TfL on how to apply the data limits correctly. As a result this uses an anonymous request and it is possible this may break after a period of requests. Again I am awaiting to hear what the request and data limits are so that this can be used correctly. I hope you like this module, this was built at the request of djbenny07on the MagicMirror2 forum. Feel free to submit pull requests or post issues and I'll do my best to respond.

Thanks To...