Skip to content

Rumpick/MMM-BusyWeekends

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

3 Commits
 
 
 
 
 
 

Repository files navigation

MMM-BusyWeekends

A MagicMirror module that highlights upcoming weekend days and shows a simple event/activity overview by time bucket, with optional weather icons.

Features

  • Displays weekend days for the next configured number of weeks
  • Shows morning / afternoon / evening event indicators
  • Uses event colors or a configurable calendar color map
  • Optional weather icon display for each weekend day
  • Ignores past weekend dates and only shows current/future dates

Installation

  1. Copy the module folder into MagicMirror/modules/
  2. Ensure the module folder name matches:
    • MMM-BusyWeekends
  3. Add the module to your config/config.js

Example configuration

{
  module: "MMM-BusyWeekends",
  header: "Busy Weekends",
  position: "top_right",
  config: {
    weeksToShow: 6,
    weekendDays: [6, 0],
    fontSize: "14px",
    calendarColorMap: {
      "Work": "#ff4081",
      "Personal": "#00e676"
    },
    showWeather: true,
    weatherModuleName: "weather",
    weatherIconSize: 32,
    timeBuckets: [
      { name: "morning", start: 5, end: 11, icon: "sunrise" },
      { name: "afternoon", start: 12, end: 17, icon: "sun" },
      { name: "evening", start: 18, end: 23, icon: "sunset" }
    ]
  }
}

Configuration options

  • header (string) — the module header to display (optional)
  • fontSize (string) — the font size for the module (e.g., "14px", "0.8em", "2vw")
  • weeksToShow (number) — number of weekend weeks to display
  • weekendDays (array) — day indexes to treat as weekend days, defaults to [6, 0]
  • calendarColorMap (object) — mapping from calendar name to fallback color
  • showWeather (boolean) — enable weather icons
  • weatherModuleName (string) — weather module name that sends WEATHER_DATA
  • weatherIconSize (number) — icon width in pixels
  • timeBuckets (array) — bucket definitions for morning/afternoon/evening display

Notes

  • This module expects calendar events from CALENDAR_EVENTS
  • Weather support requires a weather module that sends WEATHER_DATA and includes a forecast array
  • If your weather module uses a different notification scheme, update the module accordingly

Known limitations

  • Only future weekend dates are shown
  • Event matching is done by date overlap per bucket
  • Recurring event handling depends on the calendar data source

About

No description, website, or topics provided.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors