GithubHelp home page GithubHelp logo

crisvirus / mmm-nsinfo Goto Github PK

View Code? Open in Web Editor NEW

This project forked from itscrotix/mmm-nsinfo

0.0 0.0 0.0 48 KB

A Magic Mirror Module which shows real time Dutch train information

License: MIT License

JavaScript 92.34% CSS 7.66%

mmm-nsinfo's Introduction

Module: MMM-OvInfo

Description

This Magic Mirror module shows Dutch train departures requested from the NS API.

Installation

Clone this repository in you modules folder with: git clone https://github.com/mfurious/MMM-NsInfo.git

Configuration

To use this module, add the follwing configuration to your config/config.js file. This is an example for the departure times from Utrecht Central.

modules: [
    {
        module: "MMM-NsInfo",
        position: "top_right",
        config: {
            station: "Utrecht Centraal",
            stationId: "UT",
            apiKey: "YOUR_API_KEY_HERE",
            maxDepartures: 5
        }
    },
}]
Option Description
module Module Name. (See MM Documentation)
position Postion of the module. (See MM Documentation)
header Title displayed. (See MM Documentation)
apiKey Your NS API key.
station The name of your station.
Type: String Default: Utrecht centraal
stationId The ID of your station.
Type String Default: UT
maxDepartures The maximum amout of departures shown on the dashboard.
Type integer Default: 5
updateInterval The amount of time between updates (in minutes)..
Type integer Default: 5

This module is based on the NS API, you can request a key from this website

Looking up Station ID codes

To lookup a Station ID, you can use to stations.js file. Make sure to set you API Key in stations.js itself, as it cannot access the config file variable.

Disclaimer

Neither the author or NS are in any way reliable for inaccuracies and have no liabilities regarding usage of the module in any kind.

Version info

v1.0.1

mmm-nsinfo's People

Contributors

crisvirus avatar itscrotix avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.