Skip to content

Sanjit1/WizardMirror

Repository files navigation

Wizard Mirror

badge badge badge badge badge badge badge badge badge badge badge

Wizard Mirror is an open-source Electronjs app, that can give a regular mirror mysterious powers with the help of a Raspberry Pi!

Contents

Installation

To install WizardMirror: run this on your Raspberry PI's terminal

bash -c "$(curl -sL https://raw.githubusercontent.com/Sanjit1/WizardMirror/master/scripts/install.sh)"

Getting Started

To start your WizardMirror, run npm start from the WizardMirror directory. Your WizardMirror can run apps under it, for example, a time app or a weather app. App settings can be set in apps.json (which is duplicated from appsSample.json by the installation script). apps.json Here are some preinstalled applications:

Time:

Time shows the current time on your WizardMirror.

Configuration:

There are configurations for the time app, which can be changed from apps.json.apps["time"].config:

Setting Possible Values Default Description
div List of positions pos-topLeft The div where time will be displayed
showSeconds true/false false To show seconds or not
twentyfourhourclock true/false false 24 Hour clock or not

Time Screenshot

Current Weather:

Current Weather shows the weather of a certain location. It updates every 20 minutes.

Configuration:

There are configurations for the time app, which can be changed from apps.json.apps["Current Weather"].config:

Setting Possible Values Default Description
div List of positions pos-topRight The div where time will be displayed
tempunit C/F C The unit of temperature to use
speedunit km/h or m/h km/h The unit of speed to use
apikey Free API key from OpenWeatherMap None The API key to get weather information from OpenWeatherMap
city City List 5391832 List of city ID's by OpenWeatherMap

Current Weather Screenshot

Weather Forecast:

Weather Forecast shows the weather of a certain location. It updates every 3 hours.

Configuration:

There are configurations for the time app, which can be changed from apps.json.apps["Weather Forecast"].config:

Setting Possible Values Default Description
div List of positions pos-topRight The div where time will be displayed
unit C/F C The unit of temperature to use
apikey Free API key from OpenWeatherMap None The API key to get weather information from OpenWeatherMap
city City List 5391832 List of city ID's by OpenWeatherMap

Weather Forecast Screenshot

Hardware

Once you have finished installing WizardMirror and configured all the software, you can move on to the hardware: the actual mirror design. You will need

  • LCD screen
  • 2-way mirror glass/film
  • Wooden frame to frame the mirror.
  • Cables to get your Raspberry Pi running and connect it to the Screen
  • Other tools

What you will need to do: Open up your LCD Monitor, attach the mirror film on top of it, frame it, attach the Raspberry pi and attach it to the wall. School's starting, so I can't do much right now, but as soon as winter break starts I'll try to make a build video.

Check out how to contribute to WizardMirror.

Positions

Here is a list of positions, where you can place your apps Positions

Feature Request

You can request features for WizardMirror through its feathub link. Here are requested features, you can vote for them, by clicking on the picture.

Feature Requests