diff --git a/.gitignore b/.gitignore index fbe259c4..708870ec 100644 --- a/.gitignore +++ b/.gitignore @@ -3,11 +3,5 @@ !/modules/node_helper !/modules/node_helper/** -/modules/* -!/modules/calendar -!/modules/clock -!/modules/compliments -!/modules/currentweather -!/modules/helloworld -!/modules/newsfeed -!/modules/weatherforecast +/modules/** +!/modules/default/** diff --git a/README.md b/README.md index 80bc19f9..3df3738a 100644 --- a/README.md +++ b/README.md @@ -24,13 +24,13 @@ Things that still have to be implemented or changed. ##Modules ### Default modules: -- **Clock** -- **Calendar** -- **Current Weather** -- **Weather Forecast** -- **News Feed** -- **Compliments** -- **Hello World** +- [**Clock**](modules/default/clock) +- [**Calendar**](modules/default/calendar) +- [**Current Weather**](modules/default/currentweather) +- [**Weather Forecast**](modules/default/weatherforecast) +- [**News Feed**](modules/default/newsfeed) +- [**Compliments**](modules/default/compliments) +- [**Hello World**](modules/default/helloworld) ### 3rd Party Modules: diff --git a/index.html b/index.html index 70b73040..18eb65e9 100644 --- a/index.html +++ b/index.html @@ -31,6 +31,7 @@ + diff --git a/js/electron.js b/js/electron.js index fc05c10e..74192f6c 100755 --- a/js/electron.js +++ b/js/electron.js @@ -6,7 +6,7 @@ const fs = require('fs'); const Server = require(__dirname + '/server.js'); const spawn = require('child_process').spawn; const electron = require('electron'); - +const defaultModules = require(__dirname + '/../modules/default/defaultmodules.js'); // Config var config = {}; @@ -56,8 +56,18 @@ function loadConfig (callback) { } } -function loadModule(moduleName) { - var helperPath = __dirname + '/../modules/' + moduleName + '/node_helper.js'; +function loadModule(module) { + + var elements = module.split('/'); + var moduleName = elements[elements.length - 1]; + var moduleFolder = __dirname + '/../modules/' + module; + + if (defaultModules.indexOf(moduleName) !== -1) { + moduleFolder = __dirname + '/../modules/default/' + module; + } + + var helperPath = moduleFolder + '/node_helper.js'; + var loadModule = true; try { fs.accessSync(helperPath, fs.R_OK); diff --git a/js/loader.js b/js/loader.js index a35c013c..0c6f661c 100644 --- a/js/loader.js +++ b/js/loader.js @@ -79,12 +79,20 @@ var Loader = (function() { var moduleData = modules[m]; var module = moduleData.module; + var elements = module.split('/'); + var moduleName = elements[elements.length - 1]; + var moduleFolder = config.paths.modules + '/' + module; + + if (defaultModules.indexOf(moduleName) !== -1) { + moduleFolder = config.paths.modules + '/default/' + module; + } + moduleFiles.push({ index: m, identifier: 'module_' + m + '_' + module, - name: module, - path: config.paths.modules + '/' + module, - file: module + '.js', + name: moduleName, + path: moduleFolder + '/' , + file: moduleName + '.js', position: moduleData.position, header: moduleData.header, config: moduleData.config, diff --git a/js/main.js b/js/main.js index cf81ca3f..4bc15d02 100644 --- a/js/main.js +++ b/js/main.js @@ -49,7 +49,7 @@ var MM = (function() { - updateDom(module, 500); + updateDom(module, 0); } } diff --git a/modules/default/calendar/README.md b/modules/default/calendar/README.md new file mode 100644 index 00000000..41d6242e --- /dev/null +++ b/modules/default/calendar/README.md @@ -0,0 +1,152 @@ +# Module: Calendar +The `calendar` module is one of the default modules of the MagicMirror. +This module displays events from a public .ical calendar. It can combine multiple calendars. + +## Using the module + +To use this module, add it to the modules array in the `config/config.js` file: +````javascript +modules: [ + { + module: 'calendar', + position: 'top_left', // This can be any of the regions. Best results in left or right regions. + config: { + // The config property is optional. + // If no config is set, an example calendar is shown. + // See 'Configuration options' for more information. + } + } +] +```` + +## Configuration options + +The following properties can be configured: + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
OptionDescription
maximumEntriesThe maximum number of events shown.
+
Possible values: 0 - 100 +
Default value: 10 +
displaySymbolDisplay a symbol in front of an entry.
+
Possible values: true or false +
Default value: true +
defaultSymbolThe default symbol.
+
Possible values: See Font Awsome website. +
Default value: calendar +
maxTitleLengthThe maximum title length.
+
Possible values: 10 - 50 +
Default value: 25 +
fetchIntervalHow often does the content needs to be fetched? (Milliseconds)
+
Possible values: 1000 - 86400000 +
Default value: 300000 (5 minutes) +
animationSpeedSpeed of the update animation. (Milliseconds)
+
Possible values:0 - 5000 +
Default value: 2000 (2 seconds) +
fadeFade the future events to black. (Gradient)
+
Possible values: true or false +
Default value: true +
fadePointWhere to start fade?
+
Possible values: 0 (top of the list) - 1 (bottom of list) +
Default value: 0.25 +
calendarsThe list of calendars.
+
Possible values: An array, see calendar configuration below. +
Default value: An example calendar. +
titleReplaceAn object of textual replacements applied to the tile of the event. This allow to remove or replace certains words in the title.
+
Example:
+ + + titleReplace: {'Birthday of ' : '', 'foo':'bar'} + +
+ +### Calendar configuration + +The `calendars` property contains an array of the configured calendars. + +#### Default value: +````javascript +config: { + calendars: [ + { + url: 'http://www.calendarlabs.com/templates/ical/US-Holidays.ics', + symbol: 'calendar', + }, + ], +} +```` + + +#### Calendar configuration options: + + + + + + + + + + + + + + + + + + +
OptionDescription
urlThe url of the calendar .ical. This property is required.
+
Possible values: Any public accessble .ical calendar. +
symbol The symbol to show in front of an event. This property is optional.
+
Possible values: See Font Awsome website. +
\ No newline at end of file diff --git a/modules/calendar/calendar.css b/modules/default/calendar/calendar.css similarity index 100% rename from modules/calendar/calendar.css rename to modules/default/calendar/calendar.css diff --git a/modules/calendar/calendar.js b/modules/default/calendar/calendar.js similarity index 100% rename from modules/calendar/calendar.js rename to modules/default/calendar/calendar.js diff --git a/modules/calendar/node_helper.js b/modules/default/calendar/node_helper.js similarity index 100% rename from modules/calendar/node_helper.js rename to modules/default/calendar/node_helper.js diff --git a/modules/default/clock/README.md b/modules/default/clock/README.md new file mode 100644 index 00000000..c0674b28 --- /dev/null +++ b/modules/default/clock/README.md @@ -0,0 +1,49 @@ +# Module: Clock +The `clock` module is one of the default modules of the MagicMirror. +This module displays the current date and time. The information will be updated realtime. + +## Using the module + +To use this module, add it to the modules array in the `config/config.js` file: +````javascript +modules: [ + { + module: 'clock', + position: 'top_left', // This can be any of the regions. + config: { + // The config property is optional. + // See 'Configuration options' for more information. + } + } +] +```` + +## Configuration options + +The following properties can be configured: + + + + + + + + + + + + + + + + + + + +
OptionDescription
timeFormatUse 12 or 24 hour format.
+
Possible values: 12 or 24 +
Default value: uses value of config.timeFormat +
displaySecondsDisplay seconds.
+
Possible values: true or false +
Default value: true +
diff --git a/modules/clock/clock.js b/modules/default/clock/clock.js similarity index 100% rename from modules/clock/clock.js rename to modules/default/clock/clock.js diff --git a/modules/default/compliments/README.md b/modules/default/compliments/README.md new file mode 100644 index 00000000..210f88ed --- /dev/null +++ b/modules/default/compliments/README.md @@ -0,0 +1,87 @@ +# Module: Compliments +The `compliments` module is one of the default modules of the MagicMirror. +This module displays a random compliment. + +## Using the module + +To use this module, add it to the modules array in the `config/config.js` file: +````javascript +modules: [ + { + module: 'compliments', + position: 'lower_third', // This can be any of the regions. + // Best results in one of the middle regions like: lower_third + config: { + // The config property is optional. + // If no config is set, an example calendar is shown. + // See 'Configuration options' for more information. + } + } +] +```` + +## Configuration options + +The following properties can be configured: + + + + + + + + + + + + + + + + + + + + + + + + + +
OptionDescription
updateIntervalHow often does the compliment have to change? (Milliseconds)
+
Possible values: 1000 - 86400000 +
Default value: 30000 (30 seconds) +
fadeSpeedSpeed of the update animation. (Milliseconds)
+
Possible values:0 - 5000 +
Default value: 4000 (4 seconds) +
complimentsThe list of compliments.
+
Possible values: An object with three arrays: morning, afternoon andevening. See compliment configuration below. +
Default value: See compliment configuration below. +
+ +### Compliment configuration + +The `compliments` property contains an object with three arrays: morning, afternoon andevening. Based on the time of the day, the compliments will be picked out of one of these arrays. The arrays contain one or multiple compliments. + +#### Default value: +````javascript +config: { + compliments: { + morning: [ + 'Good morning, handsome!', + 'Enjoy your day!', + 'How was your sleep?' + ], + afternoon: [ + 'Hello, beauty!', + 'You look sexy!', + 'Looking good today!' + ], + evening: [ + 'Wow, you look hot!', + 'You look nice!', + 'Hi, sexy!' + ] + } +} +```` \ No newline at end of file diff --git a/modules/compliments/compliments.js b/modules/default/compliments/compliments.js similarity index 100% rename from modules/compliments/compliments.js rename to modules/default/compliments/compliments.js diff --git a/modules/default/currentweather/README.md b/modules/default/currentweather/README.md new file mode 100644 index 00000000..c3834674 --- /dev/null +++ b/modules/default/currentweather/README.md @@ -0,0 +1,145 @@ +# Module: Current Weather +The `currentweather` module is one of the default modules of the MagicMirror. +This module displays the current weather, including the windspeed, the sunset or sunrise time, the temperature and an icon to display the current conditions. + +## Using the module + +To use this module, add it to the modules array in the `config/config.js` file: +````javascript +modules: [ + { + module: 'currentweather', + position: 'top_right', // This can be any of the regions. + // Best results in left or right regions. + config: { + // See 'Configuration options' for more information. + location: 'Amsterdam,Netherlands', + appid: 'abcde12345abcde12345abcde12345ab' //openweathermap.org API key. + } + } +] +```` + +## Configuration options + +The following properties can be configured: + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
OptionDescription
locationThe location used for weather information.
+
Example: Amsterdam,Netherlands +
Default value: New York +
appidThe OpenWeatherMap API key, which can be obtained by creating an OpenWeatherMap account.
+
This value is REQUIRED +
unitsWhat units to use?
+
Possible values: default = Kelvin, metric = Celsius, imperial =Fahrenheit +
Default value: metric +
updateIntervalHow often does the content needs to be fetched? (Milliseconds)
+
Possible values: 1000 - 86400000 +
Default value: 300000 (10 minutes) +
animationSpeedSpeed of the update animation. (Milliseconds)
+
Possible values:0 - 5000 +
Default value: 2000 (2 seconds) +
timeFormatUse 12 or 24 hour format.
+
Possible values: 12 or 24 +
Default value: uses value of config.timeFormat +
langThe language of the days.
+
Possible values: en, nl, ru, etc ... +
Default value: uses value of config.language +
initialLoadDelayThe initial delay before loading. If you have multiple modules that use the same API key, you might want to delay one of the requests. (Milliseconds)
+
Possible values: 1000 - 5000 +
Default value: 0 +
retryDelayThe delay before retrying after a request failure. (Milliseconds)
+
Possible values: 1000 - 60000 +
Default value: 2500 +
apiVersionThe OpenWeatherMap API version to use.
+
Default value: 2.5 +
apiBaseThe OpenWeatherMap base URL.
+
Default value: 'http://api.openweathermap.org/data/' +
weatherEndpointThe OpenWeatherMap API endPoint.
+
Default value: 'weather' +
iconTableThe conversion table to convert the weather conditions to weather-icons.
+
Default value: iconTable: { + '01d':'wi-day-sunny', + '02d':'wi-day-cloudy', + '03d':'wi-cloudy', + '04d':'wi-cloudy-windy', + '09d':'wi-showers', + '10d':'wi-rain', + '11d':'wi-thunderstorm', + '13d':'wi-snow', + '50d':'wi-fog', + '01n':'wi-night-clear', + '02n':'wi-night-cloudy', + '03n':'wi-night-cloudy', + '04n':'wi-night-cloudy', + '09n':'wi-night-showers', + '10n':'wi-night-rain', + '11n':'wi-night-thunderstorm', + '13n':'wi-night-snow', + '50n':'wi-night-alt-cloudy-windy' + } +
\ No newline at end of file diff --git a/modules/currentweather/currentweather.css b/modules/default/currentweather/currentweather.css similarity index 100% rename from modules/currentweather/currentweather.css rename to modules/default/currentweather/currentweather.css diff --git a/modules/currentweather/currentweather.js b/modules/default/currentweather/currentweather.js similarity index 100% rename from modules/currentweather/currentweather.js rename to modules/default/currentweather/currentweather.js diff --git a/modules/default/defaultmodules.js b/modules/default/defaultmodules.js new file mode 100644 index 00000000..a6b81c88 --- /dev/null +++ b/modules/default/defaultmodules.js @@ -0,0 +1,22 @@ +/* Magic Mirror + * Default Modules List + * + * By Michael Teeuw http://michaelteeuw.nl + * MIT Licensed. + */ + +// Modules listed below can be loaded without the 'default/' prefix. Omitting the default folder name. + +var defaultModules = [ + 'calendar', + 'clock', + 'compliments', + 'currentweather', + 'helloworld', + 'newsfeed', + 'weatherforecast' +]; + + +/*************** DO NOT EDIT THE LINE BELOW ***************/ +if (typeof module !== 'undefined') {module.exports = defaultModules;} \ No newline at end of file diff --git a/modules/default/helloworld/README.md b/modules/default/helloworld/README.md new file mode 100644 index 00000000..5e8be905 --- /dev/null +++ b/modules/default/helloworld/README.md @@ -0,0 +1,51 @@ +# Module: Hello World +The `helloworld` module is one of the default modules of the MagicMirror. It is a simple way to display a static text on the mirror. +## Using the module + +To use this module, add it to the modules array in the `config/config.js` file: +````javascript +modules: [ + { + module: 'helloworld', + position: 'bottom_bar', // This can be any of the regions. + config: { + // See 'Configuration options' for more information. + text: 'Hello world!', + } + } +] +```` + +## Configuration options + +The following properties can be configured: + + + + + + + + + + + + + + + + + + + + + + + +
OptionDescription
textThe text to display.
+
Example: 'Hello world!' +
Default value: 'Hello world!' +
classesClasses to apply to the text.
+
Example: 'xsmall bold' +
Default value: 'normal medium' +
\ No newline at end of file diff --git a/modules/helloworld/helloworld.js b/modules/default/helloworld/helloworld.js similarity index 100% rename from modules/helloworld/helloworld.js rename to modules/default/helloworld/helloworld.js diff --git a/modules/default/newsfeed/README.md b/modules/default/newsfeed/README.md new file mode 100644 index 00000000..ca28bb37 --- /dev/null +++ b/modules/default/newsfeed/README.md @@ -0,0 +1,76 @@ +# Module: News Feed +The `newsfeed ` module is one of the default modules of the MagicMirror. +This module displays news headlines based on an RSS feed. + +## Using the module + +To use this module, add it to the modules array in the `config/config.js` file: +````javascript +modules: [ + { + module: 'newsfeed', + position: 'bottom_bar', // This can be any of the regions. Best results in center regions. + config: { + // The config property is optional. + // If no config is set, an example calendar is shown. + // See 'Configuration options' for more information. + } + } +] +```` + +## Configuration options + +The following properties can be configured: + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
OptionDescription
feedUrlThe url of the feed used for the headlines.
+
Default value: 'http://www.nytimes.com/services/xml/rss/nyt/HomePage.xml' +
showPublishDateDisplay the publish date of an headline.
+
Default value: true +
Default value: true or false +
reloadIntervalHow often does the content needs to be fetched? (Milliseconds)
+
Possible values: 1000 - 86400000 +
Default value: 300000 (5 minutes) +
updateIntervalHow often do you want to display a new headline? (Milliseconds)
+
Possible values:1000 - 60000 +
Default value: 7500 (7.5 seconds) +
animationSpeedSpeed of the update animation. (Milliseconds)
+
Possible values:0 - 5000 +
Default value: 2000 (2.5 seconds) +
+ diff --git a/modules/newsfeed/fetcher.js b/modules/default/newsfeed/fetcher.js similarity index 100% rename from modules/newsfeed/fetcher.js rename to modules/default/newsfeed/fetcher.js diff --git a/modules/newsfeed/newsfeed.js b/modules/default/newsfeed/newsfeed.js similarity index 100% rename from modules/newsfeed/newsfeed.js rename to modules/default/newsfeed/newsfeed.js diff --git a/modules/newsfeed/newsfetcher.js b/modules/default/newsfeed/newsfetcher.js similarity index 100% rename from modules/newsfeed/newsfetcher.js rename to modules/default/newsfeed/newsfetcher.js diff --git a/modules/newsfeed/node_helper.js b/modules/default/newsfeed/node_helper.js similarity index 100% rename from modules/newsfeed/node_helper.js rename to modules/default/newsfeed/node_helper.js diff --git a/modules/default/weatherforecast/README.md b/modules/default/weatherforecast/README.md new file mode 100644 index 00000000..07deca8d --- /dev/null +++ b/modules/default/weatherforecast/README.md @@ -0,0 +1,153 @@ +# Module: Weather Forecast +The `weatherforecast` module is one of the default modules of the MagicMirror. +This module displays the weather forecast for the coming week, including an an icon to display the current conditions, the minimum temperature and the maximum temperature. + +## Using the module + +To use this module, add it to the modules array in the `config/config.js` file: +````javascript +modules: [ + { + module: 'weatherforecast', + position: 'top_right', // This can be any of the regions. + // Best results in left or right regions. + config: { + // See 'Configuration options' for more information. + location: 'Amsterdam,Netherlands', + appid: 'abcde12345abcde12345abcde12345ab' //openweathermap.org API key. + } + } +] +```` + +## Configuration options + +The following properties can be configured: + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
OptionDescription
locationThe location used for weather information.
+
Example: Amsterdam,Netherlands +
Default value: New York +
appidThe OpenWeatherMap API key, which can be obtained by creating an OpenWeatherMap account.
+
This value is REQUIRED +
unitsWhat units to use?
+
Possible values: default = Kelvin, metric = Celsius, imperial =Fahrenheit +
Default value: metric +
updateIntervalHow often does the content needs to be fetched? (Milliseconds)
+
Possible values: 1000 - 86400000 +
Default value: 300000 (10 minutes) +
animationSpeedSpeed of the update animation. (Milliseconds)
+
Possible values:0 - 5000 +
Default value: 2000 (2 seconds) +
langThe language of the days.
+
Possible values: en, nl, ru, etc ... +
Default value: uses value of config.language +
fadeFade the future events to black. (Gradient)
+
Possible values: true or false +
Default value: true +
fadePointWhere to start fade?
+
Possible values: 0 (top of the list) - 1 (bottom of list) +
Default value: 0.25 +
initialLoadDelayThe initial delay before loading. If you have multiple modules that use the same API key, you might want to delay one of the requests. (Milliseconds)
+
Possible values: 1000 - 5000 +
Default value: 0 +
retryDelayThe delay before retrying after a request failure. (Milliseconds)
+
Possible values: 1000 - 60000 +
Default value: 2500 +
apiVersionThe OpenWeatherMap API version to use.
+
Default value: 2.5 +
apiBaseThe OpenWeatherMap base URL.
+
Default value: 'http://api.openweathermap.org/data/' +
weatherEndpointThe OpenWeatherMap API endPoint.
+
Default value: 'forecast/daily' +
iconTableThe conversion table to convert the weather conditions to weather-icons.
+
Default value: iconTable: { + '01d':'wi-day-sunny', + '02d':'wi-day-cloudy', + '03d':'wi-cloudy', + '04d':'wi-cloudy-windy', + '09d':'wi-showers', + '10d':'wi-rain', + '11d':'wi-thunderstorm', + '13d':'wi-snow', + '50d':'wi-fog', + '01n':'wi-night-clear', + '02n':'wi-night-cloudy', + '03n':'wi-night-cloudy', + '04n':'wi-night-cloudy', + '09n':'wi-night-showers', + '10n':'wi-night-rain', + '11n':'wi-night-thunderstorm', + '13n':'wi-night-snow', + '50n':'wi-night-alt-cloudy-windy' + } +
\ No newline at end of file diff --git a/modules/weatherforecast/weatherforecast.css b/modules/default/weatherforecast/weatherforecast.css similarity index 100% rename from modules/weatherforecast/weatherforecast.css rename to modules/default/weatherforecast/weatherforecast.css diff --git a/modules/weatherforecast/weatherforecast.js b/modules/default/weatherforecast/weatherforecast.js similarity index 100% rename from modules/weatherforecast/weatherforecast.js rename to modules/default/weatherforecast/weatherforecast.js