Skip to content
MagicMirror module showing STIB waiting times for configured stops.
JavaScript CSS
Branch: master
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
translations
.eslintrc.json
.gitignore
.stylelintrc.json
Gruntfile.js
LICENSE
MMM-stib2.css
MMM-stib2.js
README.md
package.json

README.md

MMM-stib2

This is a module for the MagicMirror².

This module shows waiting times for STIB transport (Brussels). It is a re-write of https://github.com/danito/MMM-stib which didn't really fit the bill for me.

This module will group stops and will only a single bus (or tram, metro) route once. I.e. the same line will not show in multiple stops. This reduces noise if you want to configure the module to show multiple stops that belong to the same line (but have overall different sets of lines.)

The module also queries the STIB messages API for disruptions and shows such disruptions. It also shows icons when the actual waiting time is unknown (only theoretical time is available), the vehicle is blocked or the vehicle is the last of the day (end of service).

It relies on the STIB OpenData API: https://opendata.stib-mivb.be . It requires an access token that can be obtained for free.

I wrote this module for my own usage, and it comes with no guarantee. However, I'm not opposed to fixing (small) issues or merging pull requests.

Using the module

To use this module, add the following configuration block to the modules array in the config/config.js file:

var config = {
    modules: [
      {
        module: "MMM-stib2",
        position: "bottom_right",
        config: {
          apiToken: "STIB OPEN DATA API TOKEN",
          stops: [{
            name: "Delta",
            id: ["3546", "3520"]
          }, {
            name: "Flagey",
            id: ["1280", "1354", "3508", "3572"]
          }]
        }
        }
    ]
}

See below for details

Configuration options

Option Description
apiToken Required STIB open data API token. See below for instructions on getting such a token.
stops Required Array of stop objects. A stop object has a freetext name and an ìd property. id is an array of ids for bus stops. These id can be found in the stops.txt file from the STIB GTFS dataset.

STIB OpenData

To create a STIB OpenData token, go to https://opendata.stib-mivb.be/ and create an account. In "My Space", click on "Operation Monitoring", then "Subscribe". Then, go to "Subscriptions" and generate keys. The token you should use in the configuration of this module is the "Access Token".

Ideas / TODO list

  • Scroll vertically if too many lines need to be shown (?)
  • Internationalize. Messages are currently hardcoded to French.
You can’t perform that action at this time.