Skip to content
master
Switch branches/tags
Code

Latest commit

 

Git stats

Files

Permalink
Failed to load latest commit information.
Type
Name
Latest commit message
Commit time
 
 
 
 
 
 
 
 
 
 

MMM-Traffic

module screenshot

This a module for the MagicMirror. It displays travel time between two locations, using the Mapbox directions API to factor in current traffic conditions.

Table of Contents

Installation

Navigate into your MagicMirror's modules folder and execute these commands:

git clone https://github.com/SamLewis0602/MMM-Traffic.git
cd MMM-Traffic
npm install

Mapbox Access Token

  1. Create an account at Mapbox
  2. Copy the access token visible after account creation (go here if you don't see it)

Styling

You can use a global MagicMirror/css/custom.css file to customize the styles for each line of MMM-Traffic separately. Each line has its own class that should be used to apply styles:

  • .mmmtraffic-firstline
  • .mmmtraffic-secondline

For example, this css

.mmmtraffic-firstline {
  font-size: 40px;
  color: yellow;
}

.mmmtraffic-secondline {
  color: green;
}

leads to this abomination: css example screenshot

Configuration

Required

See here for instructions on how to use Google Maps webpage/app to get coordinates for your origin/destination.

Note: Google maps coordinates are latitude,longitude, but Mapbox uses longitude,latitude so be sure to reverse what you copy from Google.

Option Description Type Example
accessToken Mapbox access token string -
originCoords longitude,latitude of the origin location. string '-84.504259,33.882107'
destinationCoords longitude,latitude of the origin location. string '-84.504259,33.882107'

Basic Options

Option Description Type Default Value Supported Options
mode Change the module to cycling or walking. string 'driving' 'walking' 'cycling'
language Define the commute time language. string config.language Any language string
interval How often the traffic is updated in milliseconds. integer 300000
(5 minutes)
showSymbol Whether to show the car symbol or not. boolean true

Translation/Display

Use these options to customize/translate the module's text.

*Note: See tokens below to see what tokens will be replaced with real values in firstLine/secondLine.

Option Description Type Default Value Token Replacement
loadingText The text used when loading the initial duration. string 'Loading...'
firstLine The main line of the module string 'Current duration is {duration} mins' ✔️
secondLine The second line of the module, appears below the first line in smaller, dimmer text string undefined ✔️

Tokens

Token Value
{duration} The driving time returned from the mapbox API

Per Day/Time Customization

Using these options to hide the module when you're not using it will save API calls, allowing you to have a shorter interval or more MMM-Traffic modules without getting rate limited.

Option Description Type Default
days Which days of the week to show the traffic module, with 0 being Sunday Array[int] [0, 1, 2, 3, 4, 5, 6]
hoursStart What time to begin showing the module on the days it shows, 24 hour time String "00:00"
hoursEnd What time to stop showing the module on the days it shows, 24 hour time String "23:59"

Examples

Simplest Config

{
	module: "MMM-Traffic",
	position: "top_left",
	config: {
		accessToken: "your_key_here",
		originCoords: "-84.398848,33.755165",
		destinationCoords: "-84.504259,33.88210",
	}
},

simple config screenshot

Minimal Look

{
	module: "MMM-Traffic",
	position: "top_left",
	config: {
		accessToken: "your_key_here",
		originCoords: "-84.398848,33.755165",
		destinationCoords: "-84.504259,33.88210",
		showSymbol: false,
		firstLine: "{duration} mins"
	}
},

minimal screenshot

Use both lines

{
	module: "MMM-Traffic",
	position: "top_left",
	config: {
		accessToken: "your_key_here",
		originCoords: "-84.398848,33.755165",
		destinationCoords: "-84.504259,33.88210",
		firstLine: "{duration} mins",
		secondLine: "Coffee Run"
	}
},

both lines custom screenshot

Multiple Routes

{
	module: "MMM-Traffic",
	position: "top_left",
	config: {
		accessToken: "your_key_here",
		originCoords: "-84.398848,33.755165",
		destinationCoords: "-84.504259,33.88210",
		firstLine: "{duration} mins",
		secondLine: "Home To School",
	}
},
{
	module: "MMM-Traffic",
	position: "top_left",
	config: {
		accessToken: "your_key_here",
		originCoords: "-84.398848,33.755165",
		destinationCoords: "-84.504259,33.88210",
		firstLine: "{duration} mins",
		secondLine: "Home To Work"
	}
},

multiple routes screenshot

Per day customization

This setup would show one route for Monday, Wednesday, and Friday, and another for Tuesday and Thursday. It would only show between 07:00 and 09:00 each day. It would be completely hidden on weekends.

{
	module: "MMM-Traffic",
	position: "top_left",
	config: {
		accessToken: "your_key_here",
		originCoords: "-84.398848,33.755165",
		destinationCoords: "-84.504259,33.88210",
		firstLine: "{duration} mins",
		secondLine: "School",
		days: [0,2,4],
		hoursStart: "07:00",
		hoursEnd: "09:00"
	}
},
{
	module: "MMM-Traffic",
	position: "top_left",
	config: {
		accessToken: "your_key_here",
		originCoords: "-84.398848,33.755165",
		destinationCoords: "-84.504259,33.88210",
		firstLine: "{duration} mins",
		secondLine: "Work",
		days: [1,3],
		hoursStart: "07:00",
		hoursEnd: "09:00"
	}
},
Day View
Mon/Wed/Fri minimal screenshot
Tu/Th minimal screenshot

Dependencies

Legacy

If you want to continue using the old version with Google Maps and more customization, use the 1.0-not-supported branch.

NOTE: this version is no longer supported, please do not open issues on the repo if you run into issues with this version.

About

This a module for the MagicMirror. It displays travel time between two locations, using the Mapbox directions API to factor in current traffic conditions.

Topics

Resources