/MMM-Trimet

Display Trimet (Portland, OR) arrival times on a MagicMirror

Primary LanguageJavaScriptMIT LicenseMIT

MMM-Trimet

MMM-Trimet Screenshot

This MagicMirror module retrieves data from Portland, Oregon's Trimet transit group, and displays the upcoming arrivals to up to 10 stops. This will require you to get your own Trimet developer AppID, but this is free and relatively painless.

Initial Setup

Install MagicMirror From Source

Find more information about this on MagicMirror's website: https://magicmirror.builders/

Download This Module

cd MagicMirror/modules
git clone https://github.com/shortword/MMM-Trimet.git

Configure The Module

  1. Return to the MagicMirror root directory: cd ../
  2. Setup the master MagicMirror config file in config/
  1. Add a section for MMM-Trimet in the config.modules section of the JSON file

Minimum Required

The minimum required configuration section will look something like this:

{
    module: "MMM-Trimet",
    position: "top_right",      // Replace with your preferred location
    header: "Trimet Arrivals",  // Not a hard requirement, but useful for multiple stop setups
    config: {
        appId: "REPLACE_WITH_YOUR_APPID"    // <--- Hey, you'll have to replace this
    }
}

Additional Config Options

There are also additional config options which you can set, and will almost certainly want to (otherwise you'll just get the default example stops).

Key Default Description Expected Type
arrivalCount 2 A minimum number of arrivals to retrieve positive int
arrivalURL "https://developer.trimet.org/ws/v2/arrivals" Trimet's arrival URL string
maxTotalArrivals 6 Maximum number of arrivals to display for each stop positive int
maxStopNameLen 25 Max number of letters to display in a stop name (they can be quite long) positive int
minutes 20 Get arrivals for this many minutes plus one more arrival; maxTotalArrivals will override this if more arrivals are retrieved in this timeframe positive int
stopIds [7631, 7789, 8343, 9831] Up to 10 Trimet stop IDs; find numbers here list of ints
updateInterval 15000 How often to update in ms. Default is every 15s positive int