bobaejeon / rainAndSnow

MagicMirror module: displays rain and snow animation

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

MagicMirror² Module: rainAndSnow

Displays raining or snowing animations according to the weather type.

This module is based on OpenWeatherMap API. Get an APIkey, write it with location information in config, then it's all done.

Snow(horizontal) Rain(vertical)

Installation

cd ~/MagicMirror/modules
git clone https://github.com/bobaejeon/rainAndSnow.git
cd rainAndSnow
npm install

Configuration

Add this module to the modules array in the config/config.js. You can copy this and make some changes:

    {
        module: 'rainAndSnow',
        position: "fullscreen_above",
        config: {
                    //stated below
                }
    },

Configuration options

Option Description Possible values
apiKey [required] The OpenWeatherMap APIKey to get the weather.

Default: null
APIkey you've got from OpenWeatherMap
location [required] The location name to get the weather.

Default: null
"Seoul"
locationID [required] The locationID to get the weather.

Default: null
Here you can find the list of cities
*You can choose between location and locationID
"1835848"
updateInterval [optional] How often the information will be updated.

Default: 10 * 60 * 1000 // every 10 minutes
60 * 1000 // every minute
animationSpeed [optional] The speed of the update animation in milliseconds.

Default: 1000 // 1 second
500 // 0.5 second

About

MagicMirror module: displays rain and snow animation


Languages

Language:JavaScript 51.0%Language:CSS 49.0%