https://github.com/kristjanesperanto/mmm-swh

Module for MagicMirror² to display content from SWH website
https://github.com/kristjanesperanto/mmm-swh

Last synced: about 2 months ago
JSON representation

Module for MagicMirror² to display content from SWH website

• Host: GitHub
• URL: https://github.com/kristjanesperanto/mmm-swh
• Owner: KristjanESPERANTO
• License: isc
• Created: 2024-09-05T21:12:25.000Z (9 months ago)
• Default Branch: main
• Last Pushed: 2025-03-25T22:26:08.000Z (about 2 months ago)
• Last Synced: 2025-03-25T23:24:28.607Z (about 2 months ago)
• Language: JavaScript
• Size: 1.07 MB
• Stars: 1
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE.md

Awesome Lists containing this project

README

        
# MMM-SWH

**MMM-SWH** is a module for [MagicMirror²](https://github.com/MagicMirrorOrg/MagicMirror) to display advertising images from the websites of SWH or its daughter companies.

_Disclaimer_: Before using this module, you must ensure that you are authorised to use the content from SWH (or one of its daughter companies) on your device.

## Screenshot

Blurred screenshot of the module with all companies:

![Screenshot](screenshot.png)

## Installation

Just clone the module into your modules folder of your MagicMirror² and execute `npm ci` in the module’s directory:

```bash

cd ~/MagicMirror/modules

git clone https://github.com/KristjanESPERANTO/MMM-SWH

cd MMM-SWH

npm ci

```

## Update

Go to the module’s folder inside MagicMirror modules folder and pull the latest version from GitHub and install:

```bash

cd ~/MagicMirror/modules/MMM-SWH

git pull

npm ci

```

## Configuration

These are the possible options:

| Option           | Description                                                                                                                   |

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

| `company`        | The company to show: `"bäder"`, `"evh"`, `"hafen"`, `"havag"`, `"hws"`, `"itc"`, `"maya mare"`, `"netz halle"` or `"swh"`.    |

| `updateInterval` | Interval (in milliseconds) to get the images from the website. Default: `60 * 60 * 1000` (1 hour).                            |

| `slideInterval`  | Interval (in milliseconds) to switch between the images. Default: `15 * 1000` (15 seconds).                                   |

| `showHeader`     | Show header (`true`) or not (`false`). Default: `true`.                                                                       |

| `showMoreInfo`   | Show part with URL or not. `true` or `false`. Default: `true`.                                                                |

| `animationSpeed` | Speed of the update animation.
**Possible values:** `0` - `5000`
**Default value:** `2000`
**Unit:** `milliseconds`. |

Here is a minimal example for an entry in your `config.js`:

```javascript

    {

      module: "MMM-SWH",

      position: "top_right",

      config: {

        company: "havag",

        showHeader: true

      }

    },

```

## Contributing

If you find any problems, bugs or have questions, please [open a GitHub issue](https://github.com/KristjanESPERANTO/MMM-SWH/issues) in this repository.

Pull requests are very welcome 🙂