How magicmirrororg/magicmirror works
MagicMirror² is a modular smart-mirror platform wrapped by Electron, with a server-only mode and a client-only launcher for connecting to a remote server. The principal workflow is application startup, configuration and module loading, serving the mirror interface, and displaying module-provided information. Major built-in capabilities include calendar, news, weather, clock, compliments, alerts, and update notifications. The graph includes those documented-by-tree product features, but the sampled source does not show all their wiring; unverified module relationships are therefore omitted.
Main entry points: server.js HTTP and Socket server · main.js Mirror bootstrap · app.js Application lifecycle · fmi.js FMI provider
Components 29
Application runtime
- Electron wrapper
js/electron.js - Remote client launcher
clientonly/index.js - Application lifecycle
js/app.js - Server-only entry
serveronly/index.js
Serving and communication
- HTTP and Socket server
js/server.js - Mirror bootstrap
js/main.js - Module loader
js/loader.js - Module API
js/module.js - Module socket client
js/socketclient.js
Calendar and news
- Calendar display
defaultmodules/calendar/calendar.js - Calendar fetcher
defaultmodules/calendar/calendarfetcher.js - Calendar data utilities
defaultmodules/calendar/calendarfetcherutils.js - Calendar server helper
defaultmodules/calendar/node_helper.js - News display
defaultmodules/newsfeed/newsfeed.js - News fetcher
defaultmodules/newsfeed/newsfeedfetcher.js - Feed item normalization
defaultmodules/newsfeed/feeditem.js - News server helper
defaultmodules/newsfeed/node_helper.js
Weather
- Weather display
defaultmodules/weather/weather.js - Weather objects
defaultmodules/weather/weatherobject.js - Weather server helper
defaultmodules/weather/node_helper.js - Weather provider base
defaultmodules/weather/weatherprovider.js - Provider utilities
defaultmodules/weather/provider-utils.js - Open-Meteo provider
defaultmodules/weather/providers/openmeteo.js - FMI provider
defaultmodules/weather/providers/fmi.js
Display modules
- Clock
defaultmodules/clock/clock.js - Compliments
defaultmodules/compliments/compliments.js - Alerts and notifications
defaultmodules/alert/alert.js - Update notifications
defaultmodules/updatenotification/updatenotification.js
Other components
- Mirror user
Connections 16
- Mirror user → Electron wrapper: starts mirror
- Electron wrapper → Application lifecycle: starts application
- Mirror user → Remote client launcher: starts remote client
clientonly/index.js - Remote client launcher → HTTP and Socket server: requests config
clientonly/index.js - Server-only entry → Application lifecycle: starts application
serveronly/index.js - Application lifecycle → HTTP and Socket server: creates server
js/app.js - HTTP and Socket server → Mirror user: serves mirror UI
js/server.js - Mirror bootstrap → Module loader: loads modules
js/main.js - Mirror bootstrap → Module API: initializes bridge
js/main.js - Mirror bootstrap → Mirror user: renders interface
- Calendar fetcher → Calendar data utilities: filters calendar data
defaultmodules/calendar/calendarfetcher.js - News fetcher → Feed item normalization: normalizes feed items
defaultmodules/newsfeed/newsfeedfetcher.js - FMI provider → Weather provider base: extends provider
defaultmodules/weather/providers/fmi.js - FMI provider → Provider utilities: validates coordinates
defaultmodules/weather/providers/fmi.js - Open-Meteo provider → Weather provider base: extends provider
defaultmodules/weather/providers/openmeteo.js - Module socket client → HTTP and Socket server: opens Socket.IO connection