toscoding / magicmirror

Magic Mirror Project

MagicMirror

Note: Please check out the v2-beta branch if you are looking for a modular system with simple installer.

##Introduction

The super magic interface of my personal Magic Mirror. More information about this project can be found on my blog.

Runs as a php script on a web server with basically no external dependencies. Can use socket.io for XBEE integration, but isn't required for basic functionality.

##Configuration

Modify js/config.js to change some general variables (language, weather location, compliments, news feed RSS and to add your own ICS calendars)

To use the OpenWeatherMap API, you'll need a free API key. Checkout this blogpost for more information.

##Code

###main.js

This file initiates the separate pieces of functionality that will appear in the view. It also includes various utility functions that are used to update what is visible.

###Calendar

Parsing functionality for the calendar that retrieves and updates the calendar based on the interval set at the top of the calendar.js file. This was actually a straight pull from the original main.js file but the parsing code may deserve an upgrade.

###Compliments

Functionality related to inserting compliments into the view and rotating them based on a specific interval set at the top of the compliments.js file.

###News

Takes an array of news feeds (or a single string) from the config file and retrieves each one so that it can be displayed in a loop based on the interval set at the top of the news.js file.

###Time

Updates the time on the screen on one second interval. Can be changed to omit displaying seconds by adding the config option displaySeconds = false in config.js. When the seconds are disabled the interval is set to 60 seconds on the full minute.

With the option digitFade = true, changing digits are faded. This looks best if the seconds are omitted.

###Version

Checks the git version and refreshes if a new version has been pulled.

###Weather

Takes the user's inserted location, language, unit type, and OpenWeatherMap API key and grabs the five day weather forecast from OpenWeatherMap. You need to set the API key in the config for this to work. (See configuration.)

##Modules

###MagicMirror-Modules by PaViRo

Current features: FRITZ!Box Callmonitor
Future features: Faceregognition, personalized views, online banking through HBCI and multiple calenders based on faceregognition.

###MagicMirror-Netatmo-Module by cfenner

Current features: display data of Netatmo weather station (inside/outside)
Future features: display of local warnings (severe weather)