MagicMirror

MagicMirror² is an open-source modular smart mirror platform. It allows users to create a personalized smart mirror display with customizable modules for information such as weather, calendar events, news, and more. The project is designed to be easily extendable and configurable, making it popular among DIY enthusiasts and developers.

Pros

• Highly customizable with a wide range of available modules
• Active community contributing to development and support
• Easy to set up and configure for both beginners and advanced users
• Cross-platform compatibility (works on various operating systems)

Cons

• Requires some technical knowledge for initial setup and customization
• Hardware costs can be significant for a full mirror setup
• Some modules may require additional configuration or API keys
• Performance can vary depending on the hardware used

Code Examples

// Example of creating a custom module
Module.register("mymodule", {
  defaults: {
    text: "Hello World!"
  },
  
  getDom: function() {
    var wrapper = document.createElement("div");
    wrapper.innerHTML = this.config.text;
    return wrapper;
  }
});

// Example of configuring modules in config.js
modules: [
  {
    module: "clock",
    position: "top_left"
  },
  {
    module: "calendar",
    position: "top_left",
    config: {
      calendars: [
        {
          symbol: "calendar-check",
          url: "https://www.calendarlabs.com/ical-calendar/ics/76/US_Holidays.ics"
        }
      ]
    }
  }
]

// Example of using the notification system
this.sendNotification("SHOW_ALERT", {
  title: "Hello World!",
  message: "This is a test notification.",
  timer: 4000
});

Getting Started

1. Clone the repository:

   git clone https://github.com/MagicMirrorOrg/MagicMirror
   

2. Install dependencies:

   cd MagicMirror
   npm install
   

3. Copy the config sample file:

   cp config/config.js.sample config/config.js
   

4. Start the application:

   npm run start
   

5. Access the MagicMirror² interface at http://localhost:8080 in your web browser.