MMM-Traffic

This a module for the MagicMirror. It can display commute time between two given addresses by car, walking, bicycling, or transit. The module uses the Google Maps Directions API to get commute time, which factors in traffic information.

Installation

1. Navigate into your MagicMirror's modules folder and execute git clone https://github.com/SamLewis0602/MMM-Traffic.git. A new folder 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
api_key	The API key, which can be obtained here. Type: string This value is REQUIRED
origin	The start location as the address or name of a location. Example: 'Yankee Stadium' or '500 Main Street New York NY' This value is REQUIRED
destination	The end location as the address or name of a location. Example: 'PNC Arena' or '1000 Main Street New York NY' This value is REQUIRED
mon_destination	If you want to specify a different destination for every Monday, use this. This Option exists for all of the other days of the week as well: tues_destination, wed_destination, thurs_destination, fri_destination, sat_destination, sun_destination Example: 'PNC Arena' or '1000 Main Street New York NY'
arrival_time	If you want the module to give you a departure time, put a 24 hour formatted time that you would like to arrive. Example: '1445'
mon_arrival_time	If you want to set different arrival times to match your day-specific destinations, use this option. It exists for all other days of the week as well: tues_arrival_time, wed_arrival_time, thurs_arrival_time, fri_arrival_time, sat_arrival_time, sun_arrival_time Example: '1445'
waypoints	A string containing a pipe separated list of locations that you want your route to pass through. Example: 'PNC Arena|1000 Main Street New York NY'
mode	Mode of transportation. Default value: 'driving' Other Options:'walking' 'bicycling' 'transit'
avoid	Set to 'tolls','highways', or 'ferries' to avoid them in the route. Default value: false
showRouteInfo	Set to true to show info about your route below the commute time. Default value: None
showRouteInfoText	Text that determines what route info is shown. The following token values will be replaced with their actual values: {routeName} {summary} (not supported when mode is 'transit') {arrivalTime} {detailedSummary} (recommended to have this at the end of the string) Default value: '{routeName} via {summary}'
route_name	A nickname for the route that can appear in the route info line below the commute. Example: 'Home to school' Default value: None
mon_route_name	If you want to specify a different route_name for every Monday, use this. This Option exists for all of the other days of the week as well: tues_route_name, wed_route_name, thurs_route_name, fri_route_name, sat_route_name, sun_route_name Default value: None
traffic_model	Model for traffic estimation. Default value: 'best_guess' Other Options:'optimistic' 'pessimistic'
changeColor	When changeColor is set to true, the color of the commute info will change based on traffic. If traffic increases the commute by limitYellow, the symbol and commute text will be yellow. An increase of limitRed will change the color to red. If the traffic doesn't increase the commute by at least limitYellow, the color will be green. Default value: false
limitYellow	Percentage increase in commute time due to traffic to turn commute text yellow. Default value: 10
limitRed	Percentage increase in commute time due to traffic to turn commute text red. Default value: 30
showGreen	If you've set changeColor to true but would like the commute text to remain white instead of turn green when there's light/no traffic, set showGreen to false. Default value: true
interval	How often the traffic is updated. Default value: 300000 //5 minutes
loadingText	The text used when loading the initial commute time. Default value: 'Loading commute...'
prependText	The text used in front of the commute time. Default value: 'Current commute is'
arriveByText	The text used in the route summary when arrival_time is set. Default value: 'to arrive by'
language	Define the commute time language. Example: en Default value: config.language
showWeekend	A boolean flag used to set if the commute time is requested at the weekend. Default value: true
allTime	A boolean flag used to set if the commute time is requested 24hrs a day. If this is set to false then the startHr and endHr are used to set when the times are displayed. Default value: true
startHr	An integer used to set the hour when the commute times are first requested if allTime is false. The range is 0 to 23. Default value: 7
endHr	An integer used to set the hour when the commute times are last requested if allTime is false. The range is 0 to 23. Default value: 22
hideOffHours	A boolean flag used to set if the module will be hidden when outside the days/times designated in the above 4 parameters. Default value: false
showAddress	A boolean flag used to set if the address will be shown underneath the commute time. Default value: false
showAddressText	A string used to customize the address below the commute time. {origin} and {destination} will be replaced with the actual values, and <br> can be used to insert a line break. Default value: 'From {origin}<br>To {destination}'

Here is an example of an entry in config.js

{
	module: 'MMM-Traffic',
	position: 'top_left',
	classes: 'dimmed medium', //optional, default is 'bright medium', only applies to commute info not route_name
	config: {
		api_key: 'your_apikey_here',
		mode: 'driving',
		origin: '4 Pennsylvania Plaza, New York, NY 10001',
		destination: '1 MetLife Stadium Dr, East Rutherford, NJ 07073',
		mon_destination: '116th St & Broadway, New York, NY 10027',
		fri_destination: '1 E 161st St, Bronx, NY 10451',
		arrival_time: '0800', //optional, but needs to be in 24 hour time if used.
		route_name: 'Home to Work',
		changeColor: true,
		showGreen: false,
		limitYellow: 5, //Greater than 5% of journey time due to traffic
		limitRed: 20, //Greater than 20% of journey time due to traffic
		traffic_model: 'pessimistic',
		interval: 120000 //2 minutes
	}
},

Dependencies

• request (installed via npm install)

Important Notes

• This is my first project using Node, so feel free to submit pull requests or post on the issues/wiki and I will do my best to improve the project.

Special Thanks

• Michael Teeuw for creating the awesome MagicMirror2 project that made this module possible.
• Paul-Vincent Roll for creating the Wunderlist module that I used as guidance in creating this module.