https://github.com/adman/mmm-imhdsk

MagicMirror module for displaying real-time estimations for public transport stops in Bratislava, Slovakia
https://github.com/adman/mmm-imhdsk

Last synced: 4 months ago
JSON representation

MagicMirror module for displaying real-time estimations for public transport stops in Bratislava, Slovakia

• Host: GitHub
• URL: https://github.com/adman/mmm-imhdsk
• Owner: Adman
• License: mit
• Created: 2019-10-04T16:00:24.000Z (over 6 years ago)
• Default Branch: master
• Last Pushed: 2022-12-10T04:35:08.000Z (over 3 years ago)
• Last Synced: 2025-07-02T15:50:01.525Z (11 months ago)
• Language: JavaScript
• Homepage:
• Size: 60.5 KB
• Stars: 2
• Watchers: 2
• Forks: 0
• Open Issues: 2
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# MMM-imhdsk

This is a module for the [MagicMirror²](https://github.com/MichMich/MagicMirror/) to display

real time estimations for public transport stops in Bratislava, Slovakia.

![screenshoot](img/screenshoot.png)

## Installation

Go to your MagicMirror's `modules` folder and execute `git clone https://github.com/Adman/MMM-imhdsk.git`.

In order to install module dependendencies, move to the cloned module and

run `npm install`.

## Using the module

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

```js

var config = {

    modules: [

        {

            module: 'MMM-imhdsk',

            header: ' stop',

            position: 'bottom_right',   // You can specify the region

            config: {

                stopId: id, // Id of the stop (parameter "st" in stop's livetable url)

                /* other configurations */

            }

        }

    ]

}

```

## Finding the stop ID

If you want to use this module, you need to find the `ID` of the stop. Visit

[imhd.sk](https://imhd.sk) and search for your favorite stop. Afterwards,

a livetable of this stop should appear - open this livetable in new window.

The url should contain parameter `st`, which is the stop's ID we are looking for.

## Configuration options

| Option               | Description

|--------------------- |------------

| `stopId`             | *Required* Id of the stop (parameter "st" in stop's livetable url).

 **Type:** `int` 
 **Default value:** `none`

| `maximumEntries`     | *Optional* The maximum entries shown. 

 **Type:** `int` 
 **Default value:** `10`

| `refreshInterval`    | *Optional* How often to check for the next lines. 

 **Type:** `int`
 **Default value:** `30000` milliseconds (30 seconds)

| `minimumTimeLeft`    | *Optional* Show only lines departing at least in x seconds. 

 **Type:** `int`
 **Default value:** `0` seconds (turned off)

| `ignoredLines`     | *Optional* Do not display lines specified. 

 **Type:** `array of strings`
 **Default value:** `[]`

| `onlyPlatforms`      | *Optional* Display only lines departing from specific platforms. If left empty, the module shows everything. 

 **Type:** `array of ints`
 **Default value:** `[]`

| `fade`               | *Optional* Fade the future lines to black. (Gradient) 

 **Type:** `boolean`
 **Default value:** `true`

| `fadePoint`          | *Optional* Where to start fade? 

 **Type:** `float`
 **Default value:** `0.25` (start on the 1/4 th of the list)

| `blinkingUnder`      | *Optional* Time for blinking alarm. Start blinking when the arrival is in less than x seconds. 

 **Type:** `int`
 **Default value:** `60` seconds

| `displaySymbol`      | *Optional* Whether to display bus/tram symbols. 

 **Type:** `boolean`
 **Default value:** `true`

| `displayLineNumber`  | *Optional* Whether to display line number. 

 **Type:** `boolean`
 **Default value:** `true`

| `displayDestination` | *Optional* Whether to display destination stop. 

 **Type:** `boolean`
 **Default value:** `true`

*Beware that by using this you might be violating imhd.sk ToS*