JavaScript CSS
Switch branches/tags
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
.examples initial commit Nov 20, 2016
CHANGELOG.md four candles Dec 4, 2016
MMM-Advent.css add config options, animation disable possible Nov 22, 2016
MMM-Advent.js four candles Dec 4, 2016
README.md readme Dec 4, 2016
custom.css initial commit Nov 20, 2016
package.json Update package.json Dec 9, 2016

README.md

Magic Mirror Module Advent

This module for the MagicMirror shows a candle, which burns turn towards a specified date (e.g. as an advent candle).

Three example candles

Installation

1. Execute the following commands to install the module:

cd ~/MagicMirror/modules # navigate to module folder
git clone https://github.com/Jopyth/MMM-Advent.git # clone this repository

2. Then, add the following into the modules section of your config/config.js file:

{
    module: 'MMM-Advent',
    position: 'bottom_center', // This can be any of the regions, best results in center regions
    config: {
        // See 'Configuration options' for more information.
    }
},

3. (Optional) Customize your candle with configuration options or the custom.css stylesheet.

Candle customization

The rules in the custom.css stylesheet will be applied before any configuration options are applied (e.g. candleColor), therefore if you want to set e.g. a candle color, you will need to set the corresponding config option to an empty string "".

Configuration options

The following properties can be configured:

option description
updateInterval time between updates in ms, default is 10 * 60 * 1000 (10 minutes)
marks number of marks on the candle, default is 24
height height of the (whole) candle in pixel, default is 425
showFlameBeforeStart whether to show the flame before the start time, default is false
start date and time as a string, when the candle should start burning (down), format is YYYY-MM-DD HH-MM-SS, default is "2016-12-01 08:00:00", can be an array of timestamps, should match the length of end, one candle will be created for each entry
end date and time as a string, when the candle should stop burning (down), format is YYYY-MM-DD HH-MM-SS, default is "2016-12-24 22:00:00", can be an array of timestamps, should match the length of start, one candle will be created for each entry
enableAnimation set to false to disable flame animation, default is true
fontCSS link to a custom font stylesheet, default is https://fonts.googleapis.com/css?family=Dosis
fontColor the color of the marks on the candle, default is #000000 (black)
candleColor the color of the candle, default is #FFFFFF (white)
font the font used (probably depends on the fontCSS option, default is 'Dosis', sans-serif