diff --git a/README.md b/README.md index 397349d8..e952ca02 100644 --- a/README.md +++ b/README.md @@ -26,11 +26,11 @@ Things that still have to be implemented or changed. ### Default modules: - [**Clock**](modules/clock) - [**Calendar**](modules/calendar) -- **Current Weather** -- **Weather Forecast** -- **News Feed** +- [**Current Weather**](modules/currentweather) +- [**Weather Forecast**](modules/weatherforecast) +- [**News Feed**](modules/newsfeed) - [**Compliments**](modules/compliments) -- **Hello World** +- [**Hello World**](modules/helloworld) ### 3rd Party Modules: diff --git a/modules/clock/README.md b/modules/clock/README.md index a7f45af0..c0674b28 100644 --- a/modules/clock/README.md +++ b/modules/clock/README.md @@ -33,9 +33,9 @@ The following properties can be configured: timeFormat - Use 12 of 24 hour format.
+ Use 12 or 24 hour format.

Possible values: 12 or 24 -
Default value: 24 +
Default value: uses value of config.timeFormat diff --git a/modules/currentweather/README.md b/modules/currentweather/README.md new file mode 100644 index 00000000..c3834674 --- /dev/null +++ b/modules/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/helloworld/README.md b/modules/helloworld/README.md new file mode 100644 index 00000000..5e8be905 --- /dev/null +++ b/modules/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/newsfeed/README.md b/modules/newsfeed/README.md new file mode 100644 index 00000000..ca28bb37 --- /dev/null +++ b/modules/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/weatherforecast/README.md b/modules/weatherforecast/README.md new file mode 100644 index 00000000..07deca8d --- /dev/null +++ b/modules/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