MagicMirror/README.md
2015-10-23 17:03:24 -04:00

1.8 KiB

MagicMirror

##Configuration

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.

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

##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 (I think).

###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.