README.md

MMM-Star-Metro

This a module for MagicMirror
https://magicmirror.builders/
https://github.com/MichMich/MagicMirror

A module that displays the next records from the Rennes Star metro.

Installation

1. Navigate into your MagicMirror modules folder and execute
   git clone https://github.com/alexandreLavenant/MMM-Star-Metro.git.
2. Add the module inside config.js.

Configuration

Option	Description
updateInterval	How frequently, in seconds, to update the display. Type Number Defaults to 60
stationName	Name of the metro station in the city of Rennes. See https://data.explore.star.fr/explore/dataset/tco-metro-circulation-passages-tr/api/ for the list Type String Defaults to République
direction	Wich way the metro is going. 0 from North to South. 1 from South to North. Type Number Defaults to 1
displayedRecords	Number of metro records to display. Type String Defaults to 2

Sample Configuration

{
  module: "MMM-Star-Metro",
  header: "Metro",
  position: "top_right",
  config: {
    updateInterval: 30 // 30 seconds
    stationName: "Saint-Anne",
    direction: 1,
    displayedRecords: 3
  }
},

Attributions

Metro data provided by the city of Rennes
https://data.explore.star.fr/explore/dataset/tco-metro-circulation-passages-tr/information/