Alarm Clock Module for MagicMirror²
Switch branches/tags
Nothing to show
Clone or download
Latest commit c5a4cda May 27, 2018

README.md

MMM-AlarmClock GitHub license Build Status Code Climate Known Vulnerabilities API Doc

Alarm Clock Module for MagicMirror2

Example

Dependencies

Installation

  1. Clone this repo into ~/MagicMirror/modules directory.

  2. Configure your ~/MagicMirror/config/config.js:

    {
        module: 'MMM-AlarmClock',
        position: 'top_right',
        config: {
            alarms: [
                {time: "18:30", days: [2,4], title: "Soccer", message: "Get ready for soccer training!", sound: "alarm.mp3"},
                ...
            ],
            ...
        }
    }
    

Config Options

Option Default Description
alarms REQUIRED An Array with all your alarms as objects. Those objects need to have the properties -> time: 24h format, days: Array of all days the alarm should be fired (0 = Sunday, 6 = Saturday), title, message, and sound. If sound is not defined, alarm will be fired with module defined/default alarm sound.
sound 'alarm.mp3' Name and extension of your alarm sound. File needs to be placed in ~/MagicMirror/modules/MMM-AlarmClock/sounds. Standard files are alarm.mp3 and blackforest.mp3. Alternatively specify a web stream http or https.
volume 1.0 The volume of the alarm sound in a range from 0.0 to 1.0
touch false If you are using a touch screen device you need to press a button to disable an alarm..
format 'ddd, h:mmA' In which format the alarm in the header should be displayed. All Options
timer 60000 (1 min) How long the alarm should ring for non touch screen or without interaction on touch screen devices.
fade false Set to enable a gradual fade-in of the alarm sound.
fadeTimer 60 * 1000 (1 min) How long to fade into the alarm before volume is set.
fadeStep .005 (.5%) Increase the volume this percent amount each second until fadeTimer is reached.

Alarm Sounds

There are already two alarm sounds:

Developer

  • npm run lint - Lints JS and CSS files.
  • npm run docs - Generates documentation.

Documentation

The documentation can be found here