Skip to content

Magic Mirror² module to count down to or up from a datetime

License

Notifications You must be signed in to change notification settings

daterrell/MMM-CountDown

Repository files navigation

MMM-CountDown

This is a module for the MagicMirror² which can count down the days to a date/event, or up from a date/time

Screenshot Screenshot2

Why?

Yes, there's another CountDown module, and again I didn't like the style/output, and wanted to have a few customizations that I didn't think fit with the original by Boaz. This module is really meant for countdown/up to/from days within the year, and thus only has a "Days" label, and a "T-" countdown when within 24hrs of the target date.

How?

Manual install

  1. Clone this repository in your modules folder:
cd ~/MagicMirror/modules # adapt directory if you are using a different one
git clone https://github.com/daterrell/MMM-CountDown.git
  1. Add the module to your config/config.js file.
{
  module: 'MMM-CountDown',
  position: 'bottom_center',
  config: {
      // See configuration options
  }
},

Configuration options

Option Description
position Required Where do you want to place the counter (use standard magicmirror positions)
event Required Label of event to count down to (displayed above counter)
date Required Date to count down to (YYYY-MM-DD or YYYY-MM-DDTHH:MM:SS)
daysLabel Required What to show for "days" label
toTime Optional false When counting down to a time, don't show "TODAY!", but instead count down to a specific time
allowNegative Optional Show a countUP timer; time/days since a specific date (ex. baby is X days old)
isAnnual Optional The configured date happens on the same date anually; show automatically within annualDaysDiff days
annualDaysDiff Optional When isAnnual is true, show this countdown automatically when date is this many days away

About

Magic Mirror² module to count down to or up from a datetime

Resources

License

Stars

Watchers

Forks