s-cotton / MMM-AlarmClock

Alarm Clock Module for MagicMirror2

MMM-AlarmClock

Alarm Clock Module for MagicMirror²

Example

Dependencies

• An installation of MagicMirror²

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!"},
               ...
           ],
           ...
       }
   }
   

Config Options

Option	Default	Description
alarm	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 and message.
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.

Alarm Sounds

There are already two alarm sounds:

• alarm.mp3 | From Alexander licensed under CC BY-NC 4.0
• blackforest.mp3 | From Alexander licensed under CC BY-NC 4.0