This an extension for the MagicMirror. It is specifically for Irish rail customers, It accesses the Realtime Irish Rail API via the node_helper.js module, which makes the request, then parses the response and returns json formatted data to the module for use in the MagicMirror. Some ad-hoc test have been written but the module neeeds refactoring to thoroughly test the functionality.
This is version 2.0 and may still be prone to some bugs/failure.
- Navigate into your MagicMirror's
modulesfolder and executegit clone https://github.com/archerydwd/DWD-RealtimeIrishRail.git. A new folder will appear. - Change directory into the new folder: cd DWD-RealtimeIrishRail/
- Run npm install
- Add DWD-RealtimeIrishRail to the modules array in the
config/config.js(see next step below)
- Navigate into your MagicMirror's
modules/DWD-RealtimeIrishRailfolder - Run npm test
To use this module, add it to the modules array in the config/config.js file:
modules: [
{
module: 'DWD-RealtimeIrishRail',
position: 'bottom_bar', // This can be any of the regions. Best results in bottom_bar or top_bar (if clear of other modules) regions.
header: 'DWD-RealtimeIrishRail', // This is optional
config: {
// See 'Configuration options' for more information.
}
}
]The following properties can be configured:
| Option | Description |
|---|---|
updateInterval |
The rate (in ms) in which the module will refresh the train data. Possible values: int
Default value: 60000
|
httpRequestURL
|
http://127.0.0.1:5554/ (this is the url for the python trains server we just started above) |
TrainUrl |
The api request url for the specific train station that you want to target. API URLs can be found here: http://api.irishrail.ie/realtime/realtime.asmx Possible values: Default value: "http://api.irishrail.ie/realtime/realtime.asmx/getStationDataByCodeXML_WithNumMins?StationCode=crlow&NumMins=90"
|
Copyright © 2016 Darren Daly
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the “Software”), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
The software is provided “as is”, without warranty of any kind, express or implied, including but not limited to the warranties of merchantability, fitness for a particular purpose and non infringement. In no event shall the authors or copyright holders be liable for any claim, damages or other liability, whether in an action of contract, tort or otherwise, arising from, out of or in connection with the software or the use or other dealings in the software.