2016-04-03 20:27:56 +02:00
2016-04-03 20:27:56 +02:00
2016-04-03 19:52:13 +02:00
2016-04-03 19:52:13 +02:00
2016-04-03 20:27:56 +02:00
2016-04-03 20:13:22 +02:00
2016-03-24 17:19:32 +01:00
2016-04-03 19:52:13 +02:00
2016-04-01 17:35:29 +02:00
2016-04-01 17:35:29 +02:00
2016-04-03 19:52:13 +02:00
2016-03-30 12:49:41 +02:00
2016-04-03 20:27:56 +02:00

MagicMirror V2

This version of the Magic Mirror software focusses on a modular plugin system. Besides that, the Magic Mirror software now also uses Electron, so no more webserver or browser installs necessary.

#WARNING: THIS VERSION IS IN A VERY EARLY STAGE. IT IS NOT COMPLETED YET. PLEASE USE THE MASTER BRANCH.

##Usage

  1. Download the latest node version: wget https://nodejs.org/dist/latest/node-v5.10.0-linux-armv6l.tar.gz for Pi 1 wget https://nodejs.org/dist/latest/node-v5.10.0-linux-armv7l.tar.gz for Pi 2
  2. Unpack file tar -xvf filename
  3. Install cd foldername && sudo cp -R * /usr/local/
  4. Set loglevel npm config set loglevel info
  5. npm install && npm start (You may have to restart your terminal before this works)

Important: npm start does NOT work via SSH you have to execute it in a terminal session running in a window-manager.

##Configuration

  1. Duplicate config/config.js.sample to config/config.js.
  2. Modify your required settings.

##Todo Things that still have to be implemented or changed.

####Main

  • Allow show/hide animations to animate the height. This way the other modules won't jump around.

####Alert

  • Vertical centering of alerts
  • Rewrite the alert module in vanilla JavaScript

####Documentation

  • Write all the documentation. :)

##Modules

Default modules:

3rd Party Modules:

##Contributing Contributions of all kinds are welcome, not only in the form of code but also with regards bug reports and documentation.

But please keep the following in mind:

  • Bug reports: Make sure you're running the latest version. If the issue still persist: please open a clearly documented issue with a clear title.
  • Minor bug fixes: Please send a pull request with a clear explanation of the issue or a link to the isssue it solves.
  • Major bug fixes: please discuss your approach in an github issue before you start to alter a big part of the code.
  • New features: please please discuss in an github issue before you start to alter a big part of the code. Without discussion upfront, pull request will not be accepted / merged.

Thanks for your help in making Magic Mirror better!

Description
MagicMirror² is an open source modular smart mirror platform. With a growing list of installable modules, the MagicMirror² allows you to convert your hallway or bathroom mirror into your personal assistant.
Readme 47 MiB
Languages
JavaScript 88.6%
CSS 8.2%
Nunjucks 2.5%
HTML 0.5%
TypeScript 0.2%