Skip to content

A magic mirror module to play a sound notification for upcoming calendar events.

Notifications You must be signed in to change notification settings

yashatgit/MMM-CalendarNotifications

Repository files navigation

MMM-CalendarNotifications

This a module for the MagicMirror.

It plays a sound notification for upcoming calendar events alongwith any custom message.

Installation

  1. Navigate into your MagicMirror modules folder and execute git clone https://github.com/yashatgit/MMM-CalendarNotifications.git.
  2. Enter the MMM-CalendarNotifications directory and execute npm install. cd MMM-CalendarNotifications && npm install.

This module depends on the CALENDAR_EVENTS notification sent by the default calendar module.

Module Config

Option Description
notificationLeadTime Play notification before these many milliseconds.

Type: number
Defaults to 5*60*1000
announcementText Read this message before playing the event name.

Type: string


Example of an entry in `config.js` which displays 2 tables as shown in Screenshot
{
  module: 'MMM-CalendarNotifications',
  position: 'top_right',
  config: {
	  notificationLeadTime: 5 * 60 * 1000, //5mins in millis
    announcementText: 'Upcoming event',
  },
},

Setup

  • For the Text-to-Speech to work correctly please install these packages sudo apt-get install festival festvox-kallpc16k. Link.
  • Only .wav format is supported for notifications.

About

A magic mirror module to play a sound notification for upcoming calendar events.

Topics

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published