search

j-hiller / MMM-AC-aseag

Magic Mirror 2 module to show departures of ASEAG busses in Aachen, Germany
MIT License
2 stars 2 forks source link

readme

MMM-AC-aseag

This is a module for the MagicMirror². It display the realtime departures of busses in Aachen using the API provided by the ASEAG. The module is still work in progress.

This is my first module for the MagicMirror and my first project in js, so feel free to contribute or comment.

Installation

  1. Navigate into your MagicMirror's modules folder and excecute git clone https://github.com/neandertaler19/MMM-AC-aseag
  2. Navigate into the newly created folder.
  3. Execute npm installto install the node dependencies.

Using the module

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

{
    module: "MMM-AC-aseag",
    position: "top_center",
    header: "Ponttor Abfahrten",
    config: {
                retryDelay: 5 * 1000, // Time to wait before retrying in case of failure
                maximumEntries: 10, // Maximum number of entries shown in table
                updateInterval: 1 * 60 * 1000, // Update interval in microseconds
                stopID: "1055", // default: Ponttor
                accessID: "access-id-here", // access id which has to get from the avv, see AVV acknowledgements below
                animationSpeed: 0
            }
},

Configuration options

Option Description
retryDelay optional TIme to wait before retrying in case of failure
maximumEntries optional Maximum number of entries shown in the table (not used at the moment)
updateInterval optional Update interval for querying for new connections

Type: int(milliseconds)
Default 60000 milliseconds (1 minute)
stop optional name of the stop. If you don't provide this information, you should leave it empty ("") and provide a stopID instead (not used at the moment)
stopID required ID of the stop

Acknowledgements