MMM-ShulSchedule

MMM-ShulSchedule is a module for the MagicMirror² project. It displays the schedule for your local synagogue, including prayer times, events, and other important information.

It also allows for filtering the events collected, letting you only display what you care about.

Installation

1. Navigate to your MagicMirror's modules folder:

   cd ~/MagicMirror/modules

2. Clone the repository:

   git clone https://github.com/yourusername/MMM-ShulSchedule.git

3. Navigate to the module's folder:

   cd MMM-ShulSchedule

4. Install the dependencies:

   npm install

Configuration

To use this module, add it to the modules array in the config/config.js file of your MagicMirror² installation:

{
    module: 'MMM-ShulSchedule',
    header: 'Shul Schedule',
    position: 'bottom_left',
    config: {
        fade: false,
        fetchInterval: 7200000, // 2 hours
        calendars: [
            {
                symbol: 'calendar',
                url: 'https://www.someshul.org/ical2.php?12,daed,schedule,mitzvah,parsha,holiday'
            },
        ],
        excludedEvents: [
            { filterBy: 'Daf Yomi', regex: false },
            { filterBy: 'Siddur', regex: false },
            { filterBy: 'Chavruta', regex: false },
            { filterBy: 'Ping Pong', regex: false },
            { filterBy: 'Ulpan', regex: false },
            { filterBy: 'Parshat HaShavua', regex: false },
            { filterBy: 'Parent Child Learning', regex: false },
            { filterBy: 'Tot', regex: false },
            { filterBy: 'Doctor', regex: false },
        ]
    }
}

Configuration Options

Option	Description	Type	Default
fade	Whether to fade out events as they get closer to the end time.	Boolean	false
fetchInterval	How often the schedule should be updated (in milliseconds).	Number	7200000
calendars	Array of calendar objects to fetch events from.	Array	[]
excludedEvents	Array of event filters to exclude certain events from being displayed.	Array	[]
excludedEvents.filterBy	The string to match against event titles to determine if they should be excluded.	String	''
excludedEvents.regex	Whether the filterBy string should be treated as a regular expression.	Boolean	false
calendars.symbol	The symbol to display next to events from this calendar.	String	'calendar'
calendars.url	The URL of the calendar to fetch events from.	String	''

To retrieve the calendar URL, if your Shul uses ShulCloud:

1. Log in to your ShulCloud account.
2. Navigate to the calendar section.
3. Look for an option to export or sync your calendar. This might be labeled as "Export," "ICS," "Subscribe," or something similar.
4. Select the ICS format for export.
5. Copy the URL.
6. If you don't see an option to export directly, you might need to check ShulCloud's help documentation or contact their support for specific instructions.

Credits

This module is directly built upon the default Calendar module by Michael Teeuw (http://michaelteeuw.nl).

License

This project is licensed under the MIT License - see the LICENSE file for details.