kenmirrors/MagicMirror
1
0
Fork 0
mirror of https://github.com/MichMich/MagicMirror.git synced 2025-06-27 19:53:36 +00:00
Code Issues Projects Releases Wiki Activity

Updated Home (markdown)

linuxguy467 2016-12-05 22:38:51 -05:00
parent f81b8d74f8
commit 75b15c9d91
1 changed files with 259 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

261
Home.md

@ -1,3 +1,260 @@
#Welcome to the **MagicMirror²** wiki! ###Jump to:
- [Default Modules](#default-modules)
- [3rd Party Modules](#3rd-party-modules)
Please select one of the items in the menu on the right. ##Default modules:
The following modules are installed by default.
- [**Clock**](https://github.com/MichMich/MagicMirror/tree/develop/modules/default/clock)
- [**Calendar**](https://github.com/MichMich/MagicMirror/tree/develop/modules/default/calendar)
- [**Current Weather**](https://github.com/MichMich/MagicMirror/tree/develop/modules/default/currentweather)
- [**Weather Forecast**](https://github.com/MichMich/MagicMirror/tree/develop/modules/default/weatherforecast)
- [**News Feed**](https://github.com/MichMich/MagicMirror/tree/develop/modules/default/newsfeed)
- [**Compliments**](https://github.com/MichMich/MagicMirror/tree/develop/modules/default/compliments)
- [**Hello World**](https://github.com/MichMich/MagicMirror/tree/develop/modules/default/helloworld)
- [**Alert**](https://github.com/MichMich/MagicMirror/tree/develop/modules/default/alert)
##Optional Modules:
##Installing:
To install 3rd party or your own custom modules just follow these steps:
- Navigate to the modules folder via the follow command: `cd ~/MagicMirror/modules`.
- Clone the module from github: `git clone https://github.com/author/module-name` (remembering to replace the URL with that of the module on github).
- Follow any additional instruction on from the modules readme.
- Add your brand new module to your config! This is the file `config/config.js` that you duplicated earlier. Edit this in your favourite editor and add:
```
{
module: 'module name',
position: 'position',
header: 'optional header',
config: {
extra option: 'value'
}
},
```
to the list of modules. You can look at the default modules for examples and further details can be found on the main readme.
##3rd party modules:
The following modules are created by their respective authors:
- **[MMM-Advent by Jopyth](https://github.com/Jopyth/MMM-Advent)** <br> Display a candle burning down towards a specific date (e.g. an advent candle).
- **[MMM-AirQuality by CFenner](https://github.com/CFenner/MagicMirror-AirQuality-Module)** <br> Display the air quality index a for a certain location.
- **[MMM-Alexa by sakirtemel](https://github.com/sakirtemel/MMM-alexa)** <br> Amazon Alexa integration with using Javascript only.
- **[MMM-bitcoin by valmassoi](https://github.com/valmassoi/MMM-bitcoin)** <br> Display bitcoin ticker price.
- **[MMM-Button by PtrBld](https://github.com/ptrbld/MMM-Button)** <br> Use a button to hide or show different modules via a broadcast message.
- **[calendar_monthly by KirAsh4](https://github.com/KirAsh4/calendar_monthly/)** <br> Display a compact monthly calendar view.
- **[MMM-Callmonitor-Current-Call by PaViRo](https://github.com/paviro/MMM-Callmonitor-Current-Call)** <br> Extension for [MMM-FRITZ-Box-Callmonitor](https://github.com/paviro/MMM-FRITZ-Box-Callmonitor) (Displays the currently active call)
- **[camera by alexyak](https://github.com/alexyak/camera)** <br> Display a webcamera video feed.
- **[MMM-Carousel by barnabycolby](https://github.com/barnabycolby/MMM-Carousel)** <br> Rotate modules, to save space on screen.
- **[MMM-Clash-Royale by ian](https://github.com/ianperrin/MMM-Clash-Royale)** <br> A module that displays random Clash Royale decks.
- **[DailyXKCD by Blastitt](https://github.com/Blastitt/DailyXKCD)** <br> Displays the daily XKCD web comic.
- **[MMM-DWD-WarnWeather by LukeSkywalker92](https://github.com/LukeSkywalker92/MMM-DWD-WarnWeather)** <br> Displays weather warnings for Germany.
- **[email-mirror by ronny3050](https://github.com/ronny3050/email-mirror)** <br> Display incoming emails.
- **[MMM-FAA-Delay by nigel-daniels](https://github.com/nigel-daniels/MMM-FAA-Delay)** <br> Display information published by the FAA on delays and weather conditions at some US airports.
- **[MMM-Facial-Recognition by PaViRo](https://github.com/paviro/MMM-Facial-Recognition)** <br> Facial recognition and module swapping based on the current user ...
- **[MMM-FHEM by BenRoe](https://github.com/BenRoe/MMM-FHEM)** <br> Display Readings/Values from your FHEM device like temperature or humidity.
- **[MMM-fitbit by SVendittelli](https://github.com/SVendittelli/MMM-fitbit)** <br> Display your Fitbit statistics.
- **[MMM-Flickr by kapsolas](http://bit.ly/MMM-Flickr)** <br> A module to load last 20 images posted to user's Flickr photostream to mirror and animate them; with the need of an API_KEY
- **[MMM-forecast-io by dmcinnes](https://github.com/dmcinnes/MMM-forecast-io)** <br> Display weather based on forecast API.
- **[MMM-Formula1 by ian](https://github.com/ianperrin/MMM-Formula1)** <br> A module that displays the driver standings from the current Formula 1 season.
- **[MMM-FreeBox-Monitor by tataille](https://github.com/tataille/MMM-FreeBox-Monitor)** <br> Display data from your FreeBox v6 server (Revolution) from the french ISP free.
- **[MMM-FRITZ-Box-Callmonitor by PaViRo](https://github.com/paviro/MMM-FRITZ-Box-Callmonitor)** <br> FRITZ!Box Callmonitor (Display an alert when someone is calling and offers a call history...)
- **[MMM-Fuel by fewieden](https://github.com/fewieden/MMM-Fuel)** <br> Display Gas Station prices.
- **[MMM-Globe by LukeSkywalker92](https://github.com/LukeSkywalker92/MMM-Globe)** <br> Displays live image of our planet.
- **[MMM-GPSWeather by mochman](https://github.com/mochman/MMM-GPSWeather)** <br> Display weather from a self-updated GPS Location.
- **[MMM-HH-LocalTransport by georg90](https://github.com/georg90/MMM-HH-LocalTransport)** <br> Display local transport in Hamburg/Germany.
- **[mm-hide-all by masters1222](https://github.com/masters1222/mm-hide-all)** <br> Hide all modules on your screen.
- **[MMM-HTTPRequestDisplay by Eunanibus](https://github.com/Eunanibus/MMM-HTTPRequestDisplay)** <br> Display XML data from a HTTP response.
- **[MMM-Hue by MitchSS](https://github.com/MitchSS/MMM-Hue)** <br> Display the status of groups or lights in your Philips Hue setup.
- **[MMM-iCloud-Client by Bitte-ein-Bit](https://github.com/bitte-ein-bit/MMM-iCloud-Client)** <br> Load iCloud addressbook and provide birthday iCal feed for calendar module and addressbook for [MMM-FRITZ-Box-Callmonitor](https://github.com/paviro/MMM-FRITZ-Box-Callmonitor).
- **[iFrame by desertblade](https://github.com/desertblade/iFrame)** <br> A simple way to add an iFrame of any web content to your MagicMirror.
- **[MMM-Instagram by kapsolas](http://bit.ly/MMM-Instagram)** <br> A module load the images from a users Instagram feed. The images are displayed on the mirror and animated; it requires an API_KEY
- **[internet-monitor by ronny3050](https://github.com/ronny3050/internet-monitor)** <br> Display internet statistics such as strength and speed information.
- **[MMM-ip by fewieden](https://github.com/fewieden/MMM-ip)** <br> Display IPv4/IPv6 Network Address.
- **[MMM-IPCam by RedNax67](https://github.com/RedNax67/MMM-IPCam)** <br> Display ipcam feed on MagicMirror.
- **[MMM-jokes by pvyParts](https://github.com/pvyParts/MMM-jokes)** <br> A module to load random jokes from the web.
- **[MMM-KVV by yo-less](https://github.com/yo-less/MMM-KVV)** <br> Station monitor for the Karlsruhe/Germany local transport (KVV) bus, tram and train system.
- **[MMM-LocalTransport by CFenner](https://github.com/CFenner/MagicMirror-LocalTransport-Module)** <br> Display the next public transport connections for a certain route.
- **[MMM-meteoblueCurrent by Bangee44](https://github.com/Bangee44/MMM-meteoblueCurrent)** <br> Display current weather based on the Meteoblue.com API.
- **[MMM-ModuleScheduler by ianperrin](https://github.com/ianperrin/MMM-ModuleScheduler)** <br> Create schedules to control when other modules are shown, hidden or dimmed and to send notifications to other modules.
- **[motiondetector by alexyak](https://github.com/alexyak/motiondetector)** <br> Camera based motion detector.
- **[MMM-MovieInfo by fewieden](https://github.com/fewieden/MMM-MovieInfo)** <br> Display information about upcoming movies (title, cover, genre, rating, plot).
- **[mm-music-player by masters1222](https://github.com/masters1222/mm-music-player)** <br> Simple player to play your music.
- **[MMM-nagios by qistoph](https://github.com/qistoph/MMM-nagios)** <br> A Magic Mirror Module for Nagios.
- **[MMM-Nest by Mochman](https://github.com/mochman/MMM-Nest)** <br> A Magic Mirror Module for the Nest Thermostat.
- **[MMM-Netatmo by CFenner](https://github.com/CFenner/MagicMirror-Netatmo-Module)** <br> Display your Netatmo in/outdoor weather station data on your MagicMirror.
- **[MMM-NetworkScanner by ianperrin](https://github.com/ianperrin/MMM-NetworkScanner)** <br> Display the status of devices on the network based on their MAC address
- **[MMM-nextbike by yo-less](https://github.com/yo-less/MMM-nextbike)** <br> Station monitor for the nextbike bike-sharing network.
- **[MMM-NFL by fewieden](https://github.com/fewieden/MMM-NFL)** <br> Display scores of National Football League.
- **[MMM-nstreinen by qistoph](https://github.com/qistoph/MMM-nstreinen)** <br> Shows informantion on trains departuring a configurable Dutch trainstation.
- **[MMM-Olympia by ghlasse](https://github.com/GHLasse/MagicMirror-Olympia-Module)** <br> A module that displays the medals for the current summer olympics.
- **[MMM-OlympicGames by fewieden](https://github.com/fewieden/MMM-OlympicGames)** <br> Displays the medals for olympic games in Rio.
- **[MMM-openhabfloorplan by paphko](https://github.com/paphko/mmm-openhabfloorplan)** <br> Show lights and window states on a floorplan of an openhab server.
- **[MMM-OpenTherm by RedNax67](https://github.com/RedNax67/MMM-OpenTherm)** <br> Display information from your OpenTherm gateway.
- **[MMM-pihole-stats by SheyaBernstein](https://github.com/sheyabernstein/MMM-pihole-stats)** <br> Display stats from Pi-Hole DNS ad blocking.
- **[phone-notification-mirror by ronny3050](https://github.com/ronny3050/phone-notification-mirror)** <br> Displays and alerts mirror users on new phone notifications.
- **[MMM-Ping by CFenner](https://github.com/CFenner/MagicMirror-Ping-Module)** <br> Display the mirrors connection status.
- **[MMM-ping by fewieden](https://github.com/fewieden/MMM-ping)** <br> Display status from website/ip's.
- **[MMM-PIR-Sensor by PaViRo](https://github.com/paviro/MMM-PIR-Sensor)** <br> This module can monitor a PIR motion sensor and put your mirror to sleep if nobody uses it.
- **[planetrise by croxis](https://github.com/croxis/planetrise)** <br> Display the rise and set times of the planets.
- **[PlutoTime by croxis](https://github.com/croxis/PlutoTime)** <br> Display the next time on a clear morning or evening that you can go outside and experience the brightness of high noon on Pluto.
- **[MMM-Podcast by PtrBld](https://github.com/ptrbld/MMM-Podcast)** <br> This module can show/hide a video downloaded from a Podcast or a private server (needs static file path). At the moment you can only display the video by clicking a button (use the MMM-Button module).
- **[MMM-PublicTransportBerlin by deg0nz](https://github.com/deg0nz/MMM-PublicTransportBerlin)** <br> Display departures for public transport in Berlin and Brandenburg (Covers VBB Area).
- **[MMM-RandomPhoto by diego-vieira](https://github.com/diego-vieira/MMM-RandomPhoto)** <br> A module that will load a random photo from an URL.
- **[random_quotes by KirAsh4](https://github.com/KirAsh4/random_quotes/)** <br> Display random quotes from brainyquote.
- **[MMM-Remote-Control by Jopyth](https://github.com/Jopyth/MMM-Remote-Control)** <br> Cleanly shutdown (or reboot) your mirror, edit which modules are shown on your mirror and turn your monitor off and on from a simple website, i.e. from your smartphone.
- **[DWD-RealtimeIrishRail by archerydwd](https://github.com/archerydwd/DWD-RealtimeIrishRail)** <br> Display Realtime Irish Rail data for a targeted station.
- **[MMM-Rest by Tuxdiver](https://github.com/Tuxdiver/MMM-Rest)** <br> Fetching REST data and display them on the mirror.
- **[MMM-RNV by yawns](https://github.com/yawnsde/MMM-RNV)** <br> Monitor a given station in the RNV traffic network
- **[MMM-Ruter by CatoAntonsen](https://github.com/CatoAntonsen/MMM-Ruter)** <br> Display public transport information for Oslo and Akershus in Norway
- **[MMM-ScottishPremierLeague by fewieden](https://github.com/fewieden/MMM-ScottishPremierLeague)** <br> Display scottish premiere league standings.
- **[MMM-Scrobbler by PtrBld](https://github.com/PtrBld/MMM-Scrobbler)** <br> Display the current playing song from Spotify, ITunes and Co.
- **[MMM-shabbat by SheyaBernstein](https://github.com/sheyabernstein/MMM-shabbat)** <br> Display shabbat times for the current week and optionally hide all modules.
- **[MMM-ShipmentTracking by fewieden](https://github.com/fewieden/MMM-ShipmentTracking)** <br> Display your shipment tracking status.
- **[Snow by nhubbard](https://github.com/nhubbard/MagicPlugins/tree/master/snow)** <br> Get your festive on. Put snow in the background for winter or anti burn-in purposes... your family won't know the difference.
- **[MMM-soccer by fewieden](https://github.com/fewieden/MMM-soccer)** <br> A module that displays standings from European Soccer (Football) leagues.
- **[MMM-Sonos by CFenner](https://github.com/CFenner/MagicMirror-Sonos-Module)** <br> Display the currently playing track of your Sonos system.
- **[MMM-SpotifyConnectUI by CatoAntonsen](https://github.com/CatoAntonsen/MMM-SpotifyConnectUI)** <br> Display information from Spotify Connect e.g. cover, artist and track information.
- **[MMM-stib by danito](https://github.com/danito/MMM-stib)** <br> Display the next transports for any given STIB (Brussel/Belgium) station.
- **[stocks by alexyak](https://github.com/alexyak/stocks)** <br> Display a scrolling stocks ticker.
- **[MMM-Stock by hakanmhmd](https://github.com/hakanmhmd/MMM-Stock)** <br> Displays current stock prices of companies using YAHHO FINANCE API...
- **[MMM-Strava by ian](https://github.com/ianperrin/MMM-Strava)** <br> A module that displays your activity data from [Strava.com](https://www.strava.com).
- **[MMM-Swipe by mochman](https://github.com/mochman/MMM-Swipe)** <br> Uses 2 HC-SR04 ultrasonic sensors to determing hand position to produce a "Swipe Left", "Swipe Right", or "Press".
- **[MMM-swisstransport by Bangee44](https://github.com/Bangee44/MMM-swisstransport)** <br> Display train departures from your favourit trainstation.
- **[MMM-syslog by paviro](https://github.com/paviro/MMM-syslog)** <br> API for sending notifications to your mirror.
- **[MMM-SystemStats by BenRoe](https://github.com/BenRoe/MMM-SystemStats)** <br> Shows Raspberry Pi system stats like CPU temperature, free Ram and System load
- **[MMM-SystemTemperature by MichMich](https://github.com/MichMich/mmm-systemtemperature)** <br> Display your Raspberry Pi's processor temperature on your MagicMirror.
- **[MMM-Todoist by CBrooker](https://github.com/cbrooker/MMM-Todoist)** <br> Displays your todos from Todoist on your MagicMirror.
- **[MMM-Toon by MichMich](https://github.com/MichMich/MMM-Toon)** <br> A Magic Mirror Module for the Toon Thermostat.
- **[MMM-Traffic by SamLewis0602](https://github.com/SamLewis0602/MMM-Traffic)** <br> Display commute travel time with current traffic conditions factored in. Can be used for driving, biking, walking, and public transit.
- **[MMM-TrainConnections by Bangee44](https://github.com/Bangee44/MMM-TrainConnections)** <br> Display trains from your favourit departure station to any destination in Europe.
- **[MMM-Trello by Jopyth](https://github.com/Jopyth/MMM-Trello)** <br> This module can show [Trello](https://trello.com/) cards on your mirror.
- **[MMM-TTS by fewieden](https://github.com/fewieden/MMM-TTS)** <br> Offline Text-To-Speech based on festival.
- **[twitControl by Blastitt](https://github.com/Blastitt/twitControl)** <br> Display your Twitter feed.
- **[MMM-Vindsiden by erikmohn](https://github.com/erikmohn/MMM-Vindsiden)** <br> Display weather data from weather stations available at vindsiden.no(Norway)...
- **[magic-mirror-voice by whyjustin](https://github.com/whyjustin/magic-mirror-voice)** <br> Voice control based on based on Sphinx and Alexa.
- **[voicecontrol by alexyak](https://github.com/alexyak/voicecontrol)** <br> Voice control based on snowboy.
- **[MMM-Voice-Control by dr4ke616](https://github.com/dr4ke616/MMM-Voice-Control)** <br> Voice control based on annyang.
- **[MMM-WatchDog by MichMich](https://github.com/MichMich/MMM-WatchDog)** <br> Keeps an eye on your UI and quits app in case the UI crashes. If you combine this with the PM2 process manager, MM2 will automaticly restart after a UI failure.
- **[MMM-weatherchart by paphko](https://github.com/paphko/mmm-weatherchart)** <br> Display a weather diagram provided by yr.no.
- **[MMM-WienerLinien by fewieden](https://github.com/fewieden/MMM-WienerLinien)** <br> Display Public Transport timetable of Vienna/Austria.
- **[MMM-Windfinder by CFenner](https://github.com/CFenner/MagicMirror-Windfinder-Module)** <br> Display the wind forecast for a location, important for surfers & sailors.
- **[MMM-wordnik by Vendittelli](https://github.com/SVendittelli/MMM-wordnik)** <br> Get the word of the day, its definition, and origin ...
- **[MMM-WorldTides by yawns](https://github.com/yawnsde/MMM-WorldTides)** <br> Displays low and high water time predictions for a given tide station, derived from worldtides.info
- **[wuforecast by MattLugar](https://github.com/MattLugar/wuforecast)** <br> Weather Underground Forecast Module Retrieves forecast from Weather Underground. Also adds a percentage probability of precipitation to forecast display.
- **[MMM-WunderGround by RedNax67](https://github.com/RedNax67/MMM-WunderGround)** <br> Display weather based on wunderground API.
- **[MMM-Wunderlist by PaViRo](https://github.com/paviro/MMM-Wunderlist)** <br> Displays your Wunderlist todos on your mirror ...
## Create your own module
If you want to build your own modules, check out the [MagicMirror² Module Development Documentation](https://github.com/MichMich/MagicMirror/tree/develop/modules)