MMM-DCMetroTimes.js

/* MMM-DCMetroTimes.js
 * 
 * Magic Mirror
 * Module: MMM-DCMetroTimes
 * 
 * Magic Mirror By Michael Teeuw http://michaelteeuw.nl
 * MIT Licensed.
 * 
 * Module MMM-DCMetroTimes By Kyle Kelly
 *
 * Forked From:
 *
 * Module MMM-DCMetroTrainTimes By Adam Moses http://adammoses.com
 */

// main module setup stuff
Module.register("MMM-DCMetroTimes", {
    // setup the default config options
    defaults: {     
        // required
        wmata_api_key: null, // this must be set
        // optional
        // bus parameters
        showIncidents: true, // show incidents by default
        showStationTrainTimes: true, // show train times by default
        stationsToShowList: [ 'A01', 'C01' ], // both metro centers default
        destinationsToExcludeList: [ ], // exclude nothing default
        refreshRateIncidents: 2 * 60 * 1000, // two minute default
        refreshRateStationTrainTimes: 30 * 1000, // thirty second default
        maxTrainTimesPerStation: 0, // default shows all train times
        // header parameters
        showHeader: true, // show the header by default
        headerText: "DC Metro Times", // default header text
        limitWidth: "200px", // limits the incident list (widest cell) width
        colorizeLines: false, // default to no color
        incidentCodesOnly: false, // default to full text incident line listing
        hideTrainTimesLessThan: 0, // default to show all train times
        showDestinationFullName: true, // default to show full train destination names
        // bus parameters
        showBusStopTimes: false, // hide bus times by default
        stopsToShowList: ['1001451'], // stopIDs which can be pulled from https://www.wmata.com/schedules/service-nearby/
        routesToExcludeList: [], // routeIDs (list of lists) for each stop which can be pulled from https://www.wmata.com/schedules/service-nearby/
        directionText: true, // default to hide "customer-friendly description of direction and destination for a bus"
        hideBusTimesLessThan: 0, // default to show all bus times within 45 min
        hideBusTimesGreaterThan: 45, // default to show all bus times within 45 min
        refreshRateBusStopTimes: 30 * 1000, // thirty second default
        maxBusTimesPerStop: 0, // default shows all train times
    },
    // the start function
    start: function() {
        // log starting
        Log.info("Starting module: " + this.name);
        this.config.identifier = this.identifier;
        this.config.path = this.data.path;
        this.firstUpdateDOMFlag = false;
        this.dataLoaded = false;        
        this.errorMessage = null;
        this.dataIncidentDescriptionList = null;
        this.dataIncidentLinesList = null;
        this.dataStationTrainTimesList = null;
        this.dataBusStopTimesList = null;
        // if set to show the header, set it
        if (this.config.showHeader)
            this.data.header = this.config.headerText;
         // the api key is set, send the config
        if (this.config.wmata_api_key !== null) 
            this.sendSocketNotification('REGISTER_CONFIG', this.config);    
        // if not, flag the error
        else 
            this.errorMessage = 'Error: Missing API Key';
        // schedule the first dom update
        var self = this;
        setTimeout(function() { self.firstUpdateDOM(); }, 2000);
    }, 
    // delayed call for first DOM update
    firstUpdateDOM: function() {
        this.firstUpdateDOMFlag = true;
        this.updateDom();     
    },
    // the socket handler
    socketNotificationReceived: function(notification, payload) {
        if (notification === "DCMETRO_INCIDENT_UPDATE")
        { // if an incident update check matching id, load data, and update dom
            if (payload.identifier === this.identifier)
            {
                this.errorMessage = null;
                this.dataIncidentDescriptionList = payload.descriptionList;
                this.dataIncidentLinesList = payload.linesList;
                this.dataLoaded = true;
                if (this.firstUpdateDOMFlag)
                    this.updateDom();               
            }
        }
        if (notification === "DCMETRO_STATIONTRAINTIMES_UPDATE")
        { // if an station train times update check matching id, load data, and update dom
            if (payload.identifier === this.identifier)
            {
                this.errorMessage = null;
                this.dataStationTrainTimesList = payload.stationTrainList;
                this.dataLoaded = true;
                if (this.firstUpdateDOMFlag) 
                    this.updateDom();               
            }
        }
        if (notification === "DCMETRO_BUSTOPTIMES_UPDATE")
        { // if a bus stop times update check matching id, load data, and update dom
            if (payload.identifier === this.identifier)
            {
                this.errorMessage = null;
                this.dataBusStopTimesList = payload.busStopList;
                this.dataLoaded = true;
                if (this.firstUpdateDOMFlag) 
                    this.updateDom();               
            }
        }
        if (notification === "DCMETRO_ERROR")
        { // if an error, set the error flag and update dom
            this.errorMessage = 'Error: Too Many REST Failures';
            this.updateDom();
        }
        if (notification === "DEBUG")
        {
            Log.log("DEBUG " + payload);
        }
    },
    // gets a fulltext name based on a color code
    getLineCodeName: function(theColorCode) {
        var colorNames = { BL: 'Blue',
                    GR: 'Green',
                    OR: 'Orange',
                    RD: 'Red',
                    SV: 'Silver',
                    YL: 'Yellow'
                    };
        return colorNames[theColorCode];
    },
    // gets an HTML color code based on a station color name or code
    getLineCodeColor: function(theColorCode) {
        var colorValues = { BL: 'DeepSkyBlue',
                    GR: 'Green',
                    OR: 'Orange',
                    RD: 'Red',
                    SV: 'Snow',
                    YL: 'Yellow'
                    };
        return colorValues[theColorCode];
    },
    // the get dom handler
    getDom: function() {    
        // if error has occured indicate so and return
        if (this.errorMessage !== null)
        {
            var wrapper = document.createElement("div");
            wrapper.className = "small";
            wrapper.innerHTML = this.errorMessage;
            return wrapper;     
        }      
        // if no data has been loaded yet indicate so and return
        if (!this.dataLoaded)
        {
            var wrapper = document.createElement("div");
            wrapper.className = "small";
            wrapper.innerHTML = "Waiting For Update...";
            return wrapper;         
        }
        // if no error or no lack of data proceed with main HTML generation
        var wrapper = document.createElement("table");
        // if set to show incidents and there is data for it
        if (this.config.showIncidents && (this.dataIncidentLinesList !== null))
        {
            // create the header row titled "incidents"
            var headRow = document.createElement("tr");
            var headElement = document.createElement("td");
            headElement.className = "small";
            headElement.colSpan = "3";
            headElement.innerHTML = "Incidents";                    
            headRow.appendChild(headElement);
            wrapper.appendChild(headRow);   
            // if there are lines with incidents on them list them
            if (this.dataIncidentLinesList.length > 0)
            {
                var iRow = document.createElement("tr");
                var iElement = document.createElement("td");
                var incidentCount = this.dataIncidentLinesList.length
                iElement.width = this.config.limitWidth;
                iElement.className = "xsmall";
                iElement.colSpan = "3";         
                if (this.config.incidentCodesOnly) {
                    iElement.align = "center";
                    var incidentHTML = "";
                    for (var lineIndex = 0; lineIndex < incidentCount; lineIndex++){
                        var lineCode = this.dataIncidentLinesList[lineIndex];
                        if (this.config.colorizeLines)
                            incidentHTML += "<div style=\'display:inline;color:"
                            + this.getLineCodeColor(lineCode) 
                            + "\'>";
                        else
                            incidentHTML += "<div style=\'display:inline;\'>";
                        incidentHTML += lineCode + "</div>";
                        if (lineIndex < incidentCount - 1)
                            incidentHTML += "&nbsp;&nbsp;";
                    }
                    iElement.innerHTML = incidentHTML;
                }
                else {                    
                     // create a string and add each incident line's color to the string
                    iElement.align = "left";
                    var incidentHTML = "";
                    if (this.dataIncidentLinesList.length === 1)
                        incidentHTML += "Incident Reported On ";
                    else
                        incidentHTML += "Incidents Reported On ";
                    for (var lineIndex = 0; lineIndex < incidentCount; lineIndex++){
                        var lineCode = this.dataIncidentLinesList[lineIndex];
                        if ((lineIndex === incidentCount - 1) 
                            && (this.dataIncidentLinesList.length > 1))
                            incidentHTML += "and ";
                        if (this.config.colorizeLines)
                            incidentHTML += "<div style=\'display:inline;color:"
                            + this.getLineCodeColor(lineCode) 
                            + "\'>";
                        else
                            incidentHTML += "<div style=\'display:inline;\'>";
                        incidentHTML += this.getLineCodeName(lineCode) + "</div>";
                        if ((lineIndex !== incidentCount - 1)
                            && (incidentCount > 2))
                            incidentHTML += ",";
                         incidentHTML += " ";
                    }
                    // add the right post-fix based on count
                    if (this.dataIncidentLinesList.length === 1)
                        incidentHTML += "Line";
                    else
                        incidentHTML += "Lines";
                    iElement.innerHTML += incidentHTML;                
                }
   
                iRow.appendChild(iElement);
                wrapper.appendChild(iRow);
            }
            // if no lines with incidents then say so
            else
            {
                var iRow = document.createElement("tr");
                var iElement = document.createElement("td");
                iElement.align = "left";
                iElement.colSpan = "3";
                iElement.className = "xsmall";
                iElement.innerHTML += "No Incidents Reported";
                iRow.appendChild(iElement);
                wrapper.appendChild(iRow);
            }            
        }
        // if set to show station train times and there is data for it
        if (this.config.showStationTrainTimes && (this.dataStationTrainTimesList !== null))
        {
            // iterate through each station in config station list
            for (var curStationIndex = 0; curStationIndex < this.config.stationsToShowList.length; curStationIndex++)
            {                      
                var stationCode = this.config.stationsToShowList[curStationIndex];
                var cStation = this.dataStationTrainTimesList[stationCode];
                // if a matching station was found in the data returned from the helper
                if (cStation !== undefined)
                {
                    // create a header row of the station name
                    var headRow = document.createElement("tr");
                    var headElement = document.createElement("td");
                    headElement.align = "right";
                    headElement.colSpan = "3";
                    headElement.className = "small";                    
                    headElement.innerHTML = cStation.StationName;                   
                    headRow.appendChild(headElement);
                    wrapper.appendChild(headRow);                               
                    // if there are train times in the list
                    if (cStation.TrainList.length > 0)
                    {
                        // cap the number of train times to show if config-ed to do so
                        var countTrainTimesToShow = cStation.TrainList.length;
                        if ((this.config.maxTrainTimesPerStation !== 0)
                            && (countTrainTimesToShow > this.config.maxTrainTimesPerStation))
                            countTrainTimesToShow = this.config.maxTrainTimesPerStation;
                        // iterate through the train times list
                        for (var cTrainIndex = 0; cTrainIndex < countTrainTimesToShow; cTrainIndex++)
                        {
                            // each row should be the train line color, it's destination, and arrival time
                            var cTrain = cStation.TrainList[cTrainIndex];
                            var trainRow = document.createElement("tr");
                            trainRow.className = "xsmall";
                            trainRow.align = "left";
                            var lineElement = document.createElement("td");
                            if (this.config.colorizeLines)
                                lineElement.style = 'color:' + this.getLineCodeColor(cTrain.Line);
                            lineElement.innerHTML = cTrain.Line;
                            var destElement = document.createElement("td");
                            destElement.align = "left";
                            destElement.innerHTML = cTrain.Destination;
                            var minElement = document.createElement("td");
                            minElement.align = "right";                                 
                            minElement.innerHTML = cTrain.Min;
                            trainRow.appendChild(lineElement);
                            trainRow.appendChild(destElement);
                            trainRow.appendChild(minElement);
                            wrapper.appendChild(trainRow);                                  
                        }
                    }
                    // if no train times for this station then say so
                    else
                    {                        
                        var trainRow = document.createElement("tr");
                        trainRow.className = "xsmall";
                        trainRow.align = "left";
                        var lineElement = document.createElement("td");
                        lineElement.innerHTML = "--";
                        var destElement = document.createElement("td");
                        destElement.align = "left";
                        destElement.innerHTML = "No Trains"
                        var minElement = document.createElement("td");
                        minElement.align = "right";                                 
                        minElement.innerHTML = "";
                        trainRow.appendChild(lineElement);
                        trainRow.appendChild(destElement);
                        trainRow.appendChild(minElement);
                        wrapper.appendChild(trainRow);  
                    }                           
                }                                           
            }   
        }
        // if set to show bus times and there is data for it
        if (this.config.showBusStopTimes && (this.dataBusStopTimesList !== null))
        {
            // iterate through each stop in config stop list
            for (var curStopIndex = 0; curStopIndex < this.config.stopsToShowList.length; curStopIndex++)
            {                      
                var stopID = this.config.stopsToShowList[curStopIndex];
                var cStop = this.dataBusStopTimesList[stopID];
                // if a matching station was found in the data returned from the helper
                if (cStop !== undefined)
                {
                    // create a header row of the station name
                    var headRow = document.createElement("tr");
                    var headElement = document.createElement("td");
                    headElement.align = "right";
                    headElement.colSpan = "3";
                    headElement.className = "small";                    
                    headElement.innerHTML = cStop.StopName;                   
                    headRow.appendChild(headElement);
                    wrapper.appendChild(headRow);                               
                    // if there are bus times in the list
                    if (cStop.BusList.length > 0)
                    {
                        // cap the number of bus times to show if config-ed to do so
                        var countBusTimesToShow = cStop.BusList.length;
                        if ((this.config.maxBusTimesPerStop !== 0)
                            && (countBusTimesToShow > this.config.maxBusTimesPerStop))
                            countBusTimesToShow = this.config.maxBusTimesPerStop;
                        // iterate through the train times list
                        for (var cBusIndex = 0; cBusIndex < countBusTimesToShow; cBusIndex++)
                        {
                            // each row should be the destination, and arrival time
                            var cBus = cStop.BusList[cBusIndex];
                            var busRow = document.createElement("tr");
                            busRow.className = "xsmall";
                            busRow.align = "left";
                            var lineElement = document.createElement("td");
                            lineElement.innerHTML = cBus.RouteID;
                            var destElement = document.createElement("td");
                            destElement.align = "left";
                            destElement.innerHTML = cBus.DirectionText;
                            var minElement = document.createElement("td");
                            minElement.align = "right";                                 
                            minElement.innerHTML = cBus.Min;
                            busRow.appendChild(lineElement);
                            busRow.appendChild(destElement);
                            busRow.appendChild(minElement);
                            wrapper.appendChild(busRow);                                  
                        }
                    }
                    // if no train times for this station then say so
                    else
                    {                        
                        var busRow = document.createElement("tr");
                        busRow.className = "xsmall";
                        busRow.align = "left";
                        var lineElement = document.createElement("td");
                        lineElement.innerHTML = "--";
                        var destElement = document.createElement("td");
                        destElement.align = "left";
                        destElement.innerHTML = "No Buses"
                        var minElement = document.createElement("td");
                        minElement.align = "right";                                 
                        minElement.innerHTML = "";
                        busRow.appendChild(lineElement);
                        busRow.appendChild(destElement);
                        busRow.appendChild(minElement);
                        wrapper.appendChild(busRow);  
                    }                           
                }                                           
            }
        } 
        // return the generated code
        return wrapper;     
    }
    
});

// ------------ END -------------