repeatingCountTitle |
The count title for yearly repating events in this calendar.
diff --git a/modules/default/calendar/calendar.js b/modules/default/calendar/calendar.js
index d74d1f96..1ca137ca 100644
--- a/modules/default/calendar/calendar.js
+++ b/modules/default/calendar/calendar.js
@@ -390,7 +390,7 @@ Module.register("calendar", {
/* capFirst(string)
* Capitalize the first letter of a string
- * Eeturn capitalized string
+ * Return capitalized string
*/
capFirst: function (string) {
@@ -409,6 +409,13 @@ Module.register("calendar", {
titleTransform: function (title) {
for (var needle in this.config.titleReplace) {
var replacement = this.config.titleReplace[needle];
+
+ var regParts = needle.match(/^\/(.+)\/([gim]*)$/);
+ if (regParts) {
+ // the parsed pattern is a regexp.
+ needle = new RegExp(regParts[1], regParts[2]);
+ }
+
title = title.replace(needle, replacement);
}
diff --git a/modules/default/calendar/node_helper.js b/modules/default/calendar/node_helper.js
index a1b8db09..cc511659 100644
--- a/modules/default/calendar/node_helper.js
+++ b/modules/default/calendar/node_helper.js
@@ -12,7 +12,6 @@ var CalendarFetcher = require("./calendarfetcher.js");
module.exports = NodeHelper.create({
// Override start method.
start: function() {
- var self = this;
var events = [];
this.fetchers = [];
diff --git a/modules/default/calendar/vendor/ical.js/ical.js b/modules/default/calendar/vendor/ical.js/ical.js
index 252e426b..f60c5357 100644
--- a/modules/default/calendar/vendor/ical.js/ical.js
+++ b/modules/default/calendar/vendor/ical.js/ical.js
@@ -90,7 +90,6 @@
return dt
}
-
var dateParam = function(name){
return function(val, params, curr){
@@ -143,6 +142,16 @@
}
}
+ var exdateParam = function(name){
+ return function(val, params, curr){
+ var date = dateParam(name)(val, params, curr);
+ if (date.exdates === undefined) {
+ date.exdates = [];
+ }
+ date.exdates.push(date.exdate);
+ return date;
+ }
+ }
var geoParam = function(name){
return function(val, params, curr){
@@ -240,6 +249,7 @@
, 'LOCATION' : storeParam('location')
, 'DTSTART' : dateParam('start')
, 'DTEND' : dateParam('end')
+ , 'EXDATE' : exdateParam('exdate')
,' CLASS' : storeParam('class')
, 'TRANSP' : storeParam('transparency')
, 'GEO' : geoParam('geo')
diff --git a/modules/default/calendar/vendor/ical.js/node-ical.js b/modules/default/calendar/vendor/ical.js/node-ical.js
index 2f6ef3ef..c954e722 100644
--- a/modules/default/calendar/vendor/ical.js/node-ical.js
+++ b/modules/default/calendar/vendor/ical.js/node-ical.js
@@ -17,7 +17,8 @@ exports.parseFile = function(filename){
}
-var rrule = require('rrule').RRule
+var rrule = require('rrule-alt').RRule
+var rrulestr = rrule.rrulestr
ical.objectHandlers['RRULE'] = function(val, params, curr, stack, line){
curr.rrule = line;
@@ -26,7 +27,7 @@ ical.objectHandlers['RRULE'] = function(val, params, curr, stack, line){
var originalEnd = ical.objectHandlers['END'];
ical.objectHandlers['END'] = function(val, params, curr, stack){
if (curr.rrule) {
- var rule = curr.rrule.replace('RRULE:', '');
+ var rule = curr.rrule;
if (rule.indexOf('DTSTART') === -1) {
if (curr.start.length === 8) {
@@ -36,10 +37,14 @@ ical.objectHandlers['END'] = function(val, params, curr, stack){
}
}
- rule += ';DTSTART=' + curr.start.toISOString().replace(/[-:]/g, '');
+ rule += ' DTSTART:' + curr.start.toISOString().replace(/[-:]/g, '');
rule = rule.replace(/\.[0-9]{3}/, '');
}
- curr.rrule = rrule.fromString(rule);
+ for (var i in curr.exdates) {
+ rule += ' EXDATE:' + curr.exdates[i].toISOString().replace(/[-:]/g, '');
+ rule = rule.replace(/\.[0-9]{3}/, '');
+ }
+ curr.rrule = rrulestr(rule);
}
return originalEnd.call(this, val, params, curr, stack);
}
diff --git a/modules/default/clock/README.md b/modules/default/clock/README.md
index 76a979d4..5570ff5a 100644
--- a/modules/default/clock/README.md
+++ b/modules/default/clock/README.md
@@ -8,8 +8,8 @@ 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.
+ module: "clock",
+ position: "top_left", // This can be any of the regions.
config: {
// The config property is optional.
// See 'Configuration options' for more information.
@@ -22,106 +22,18 @@ modules: [
The following properties can be configured:
-
-
-
-
- | Option |
- Description |
-
-
-
-
- timeFormat |
- Use 12 or 24 hour format.
-
Possible values: 12 or 24
-
Default value: uses value of config.timeFormat
- |
-
-
- displaySeconds |
- Display seconds.
-
Possible values: true or false
-
Default value: true
- |
-
-
- showPeriod |
- Show the period (am/pm) with 12 hour format.
-
Possible values: true or false
-
Default value: true
- |
-
-
- showPeriodUpper |
- Show the period (AM/PM) with 12 hour format as uppercase.
-
Possible values: true or false
-
Default value: false
- |
-
-
- clockBold |
- Remove the colon and bold the minutes to make a more modern look.
-
Possible values: true or false
-
Default value: false
- |
-
-
- showDate |
- Turn off or on the Date section.
-
Possible values: true or false
-
Default value: true
- |
-
-
- displayType |
- Display a digital clock, analog clock, or both together.
-
Possible values: digital, analog, or both
-
Default value: digital
- |
-
-
- analogSize |
- Specific to the analog clock. Defines how large the analog display is.
-
Possible values: A positive number of pixels
-
Default value: 200px
- |
-
-
- analogFace |
- Specific to the analog clock. Specifies which clock face to use.
-
Possible values: simple for a simple border, none for no face or border, or face-### (where ### is currently a value between 001 and 012, inclusive)
-
Default value: simple
- |
-
-
- secondsColor |
- Specific to the analog clock. Specifies what color to make the 'seconds' hand.
-
Possible values: any HTML RGB Color
-
Default value: #888888
- |
-
-
- analogPlacement |
- Specific to the analog clock. (requires displayType set to 'both') Specifies where the analog clock is in relation to the digital clock
-
Possible values: top, right, bottom, or left
-
Default value: bottom
- |
-
-
- analogShowDate |
- Specific to the analog clock. If the clock is used as a separate module and set to analog only, this configures whether a date is also displayed with the clock.
-
Possible values: false, top, or bottom
-
Default value: top
- |
-
-
- timezone |
- Specific a timezone to show clock.
-
Possible examples values: America/New_York, America/Santiago, Etc/GMT+10
-
Default value: none
- |
-
-
-
-
+| Option | Description
+| ----------------- | -----------
+| `timeFormat` | Use 12 or 24 hour format.
**Possible values:** `12` or `24`
**Default value:** uses value of _config.timeFormat_
+| `displaySeconds` | Display seconds.
**Possible values:** `true` or `false`
**Default value:** `true`
+| `showPeriod` | Show the period (am/pm) with 12 hour format.
**Possible values:** `true` or `false`
**Default value:** `true`
+| `showPeriodUpper` | Show the period (AM/PM) with 12 hour format as uppercase.
**Possible values:** `true` or `false`
**Default value:** `false`
+| `clockBold` | Remove the colon and bold the minutes to make a more modern look.
**Possible values:** `true` or `false`
**Default value:** `false`
+| `showDate` | Turn off or on the Date section.
**Possible values:** `true` or `false`
**Default value:** `true`
+| `displayType` | Display a digital clock, analog clock, or both together.
**Possible values:** `digital`, `analog`, or `both`
**Default value:** `digital`
+| `analogSize` | **Specific to the analog clock.** Defines how large the analog display is.
**Possible values:** A positive number of pixels`
**Default value:** `200px`
+| `analogFace` | **Specific to the analog clock.** Specifies which clock face to use.
**Possible values:** `simple` for a simple border, `none` for no face or border, or `face-###` (where ### is currently a value between 001 and 012, inclusive)
**Default value:** `simple`
+| `secondsColor` | **Specific to the analog clock.** Specifies what color to make the 'seconds' hand.
**Possible values:** `any HTML RGB Color`
**Default value:** `#888888`
+| `analogPlacement` | **Specific to the analog clock. _(requires displayType set to `'both'`)_** Specifies where the analog clock is in relation to the digital clock
**Possible values:** `top`, `right`, `bottom`, or `left`
**Default value:** `bottom`
+| `analogShowDate` | **Specific to the analog clock.** If the clock is used as a separate module and set to analog only, this configures whether a date is also displayed with the clock.
**Possible values:** `false`, `top`, or `bottom`
**Default value:** `top`
+| `timezone` | Specific a timezone to show clock.
**Possible examples values:** `America/New_York`, `America/Santiago`, `Etc/GMT+10`
**Default value:** `none`
diff --git a/modules/default/clock/clock.js b/modules/default/clock/clock.js
index c84c133e..1882c52e 100644
--- a/modules/default/clock/clock.js
+++ b/modules/default/clock/clock.js
@@ -134,6 +134,10 @@ Module.register("clock",{
if (this.config.analogFace != "" && this.config.analogFace != "simple" && this.config.analogFace != "none") {
clockCircle.style.background = "url("+ this.data.path + "faces/" + this.config.analogFace + ".svg)";
clockCircle.style.backgroundSize = "100%";
+
+ // The following line solves issue: https://github.com/MichMich/MagicMirror/issues/611
+ clockCircle.style.border = "1px solid black";
+
} else if (this.config.analogFace != "none") {
clockCircle.style.border = "2px solid white";
}
diff --git a/modules/default/compliments/README.md b/modules/default/compliments/README.md
index 430c4fbf..8ef9e2fb 100644
--- a/modules/default/compliments/README.md
+++ b/modules/default/compliments/README.md
@@ -8,8 +8,8 @@ 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.
+ 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.
@@ -25,48 +25,12 @@ modules: [
The following properties can be configured:
-
-
-
-
- | Option |
- Description |
-
-
-
-
-
- updateInterval |
- How often does the compliment have to change? (Milliseconds)
-
Possible values: 1000 - 86400000
-
Default value: 30000 (30 seconds)
- |
-
-
- fadeSpeed |
- Speed of the update animation. (Milliseconds)
-
Possible values:0 - 5000
-
Default value: 4000 (4 seconds)
- |
-
-
- compliments |
- The list of compliments.
-
Possible values: An object with three arrays: morning, afternoon andevening. See compliment configuration below.
-
Default value: See compliment configuration below.
- |
-
-
- remoteFile |
- External file from which to load the compliments
-
Possible values:Path to a JSON file containing compliments, configured
- as per the value of the compliments configuration (see below). An object with three arrays:
- morning, afternoon and evening. - compliments.json
-
Default value: null (Do not load from file)
- |
-
-
-
+| Option | Description
+| ---------------- | -----------
+| `updateInterval` | How often does the compliment have to change? (Milliseconds)
**Possible values:** `1000` - `86400000`
**Default value:** `30000` (30 seconds)
+| `fadeSpeed` | Speed of the update animation. (Milliseconds)
**Possible values:**`0` - `5000`
**Default value:** `4000` (4 seconds)
+| `compliments` | The list of compliments.
**Possible values:** An object with three arrays: `morning`, `afternoon` and`evening`. See _compliment configuration_ below.
**Default value:** See _compliment configuration_ below.
+| `remoteFile` | External file from which to load the compliments
**Possible values:** Path to a JSON file containing compliments, configured as per the value of the _compliments configuration_ (see below). An object with three arrays: `morning`, `afternoon` and `evening`. - `compliments.json`
**Default value:** `null` (Do not load from file)
### Compliment configuration
@@ -74,36 +38,36 @@ The `compliments` property contains an object with three arrays: morningday_sunny
-* day_cloudy
-* cloudy
-* cloudy_windy
-* showers
-* rain
-* thunderstorm
-* snow
-* fog
-* night_clear
-* night_cloudy
-* night_showers
-* night_rain
-* night_thunderstorm
-* night_snow
-* night_alt_cloudy_windy
+* `day_sunny`
+* `day_cloudy`
+* `cloudy`
+* `cloudy_windy`
+* `showers`
+* `rain`
+* `thunderstorm`
+* `snow`
+* `fog`
+* `night_clear`
+* `night_cloudy`
+* `night_showers`
+* `night_rain`
+* `night_thunderstorm`
+* `night_snow`
+* `night_alt_cloudy_windy`
#### Example use with currentweather module
````javascript
config: {
compliments: {
day_sunny: [
- 'Today is a sunny day',
- 'It\'s a beautiful day'
+ "Today is a sunny day",
+ "It's a beautiful day"
],
snow: [
- 'Snowball battle!'
+ "Snowball battle!"
],
rain: [
- 'Don\'t forget your umbrella'
+ "Don't forget your umbrella"
]
}
}
@@ -115,19 +79,19 @@ config: {
config: {
compliments: {
morning: [
- 'Good morning, handsome!',
- 'Enjoy your day!',
- 'How was your sleep?'
+ "Good morning, handsome!",
+ "Enjoy your day!",
+ "How was your sleep?"
],
afternoon: [
- 'Hello, beauty!',
+ "Hello, beauty!",
'You look sexy!',
- 'Looking good today!'
+ "Looking good today!"
],
evening: [
- 'Wow, you look hot!',
- 'You look nice!',
- 'Hi, sexy!'
+ "Wow, you look hot!",
+ "You look nice!",
+ "Hi, sexy!"
]
}
}
diff --git a/modules/default/currentweather/README.md b/modules/default/currentweather/README.md
index ccef543c..65913d82 100644
--- a/modules/default/currentweather/README.md
+++ b/modules/default/currentweather/README.md
@@ -8,14 +8,14 @@ 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.
+ 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',
- locationID: '', //Location ID from http://openweathermap.org/help/city_list.txt
- appid: 'abcde12345abcde12345abcde12345ab' //openweathermap.org API key.
+ location: "Amsterdam,Netherlands",
+ locationID: "", //Location ID from http://openweathermap.org/help/city_list.txt
+ appid: "abcde12345abcde12345abcde12345ab" //openweathermap.org API key.
}
}
]
@@ -26,189 +26,52 @@ modules: [
The following properties can be configured:
-
-
-
-
- | Option |
- Description |
-
-
-
-
- location |
- The location used for weather information.
-
Example: 'Amsterdam,Netherlands'
-
Default value: false
- Note: When the location and locationID are both not set, the location will be based on the information provided by the calendar module. The first upcoming event with location data will be used.
- |
-
-
- locationID |
- Location ID from OpenWeatherMap This will override anything you put in location.
Leave blank if you want to use location.
-
Example: 1234567
-
Default value: false
- Note: When the location and locationID are both not set, the location will be based on the information provided by the calendar module. The first upcoming event with location data will be used.
- |
-
-
- appid |
- The OpenWeatherMap API key, which can be obtained by creating an OpenWeatherMap account.
-
This value is REQUIRED
- |
-
-
- units |
- What units to use. Specified by config.js
-
Possible values: config.units = Specified by config.js, default = Kelvin, metric = Celsius, imperial =Fahrenheit
-
Default value: config.units
- |
-
-
- roundTemp |
- Round temperature value to nearest integer.
-
Possible values: true (round to integer) or false (display exact value with decimal point)
-
Default value: false
- |
-
-
- updateInterval |
- How often does the content needs to be fetched? (Milliseconds)
-
Possible values: 1000 - 86400000
-
Default value: 600000 (10 minutes)
- |
-
-
- animationSpeed |
- Speed of the update animation. (Milliseconds)
-
Possible values:0 - 5000
-
Default value: 1000 (1 second)
- |
-
-
- timeFormat |
- Use 12 or 24 hour format.
-
Possible values: 12 or 24
-
Default value: uses value of config.timeFormat
- |
-
-
- showPeriod |
- Show the period (am/pm) with 12 hour format
-
Possible values: true or false
-
Default value: true
- |
-
-
- showPeriodUpper |
- Show the period (AM/PM) with 12 hour format as uppercase
-
Possible values: true or false
-
Default value: false
- |
-
-
- showWindDirection |
- Show the wind direction next to the wind speed.
-
Possible values: true or false
-
Default value: true
- |
-
-
- showHumidity |
- Show the current humidity
-
Possible values: true or false
-
Default value: false
- |
-
-
- onlyTemp |
- Show only current Temperature and weather icon.
-
Possible values: true or false
-
Default value: false
- |
-
-
- useBeaufort |
- Pick between using the Beaufort scale for wind speed or using the default units.
-
Possible values: true or false
-
Default value: true
- |
-
-
- lang |
- The language of the days.
-
Possible values: en, nl, ru, etc ...
-
Default value: uses value of config.language
- |
-
-
- initialLoadDelay |
- The 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
- |
-
-
- retryDelay |
- The delay before retrying after a request failure. (Milliseconds)
-
Possible values: 1000 - 60000
-
Default value: 2500
- |
-
-
- apiVersion |
- The OpenWeatherMap API version to use.
-
Default value: 2.5
- |
-
-
- apiBase |
- The OpenWeatherMap base URL.
-
Default value: 'http://api.openweathermap.org/data/'
- |
-
-
- weatherEndpoint |
- The OpenWeatherMap API endPoint.
-
Default value: 'weather'
- |
-
-
- appendLocationNameToHeader |
- If set to true, the returned location name will be appended to the header of the module, if the header is enabled. This is mainly intresting when using calender based weather.
-
Default value: true
- |
-
-
- calendarClass |
- The class for the calender module to base the event based weather information on.
-
Default value: 'calendar'
- |
-
-
- iconTable |
- The 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'
- }
- |
-
-
-
+| Option | Description
+| ---------------------------- | -----------
+| `location` | The location used for weather information.
**Example:** `'Amsterdam,Netherlands'`
**Default value:** `false`
**Note:** When the `location` and `locationID` are both not set, the location will be based on the information provided by the calendar module. The first upcoming event with location data will be used.
+| `locationID` | Location ID from [OpenWeatherMap](http://openweathermap.org/help/city_list.txt) **This will override anything you put in location.**
Leave blank if you want to use location.
**Example:** `1234567`
**Default value:** `false`
**Note:** When the `location` and `locationID` are both not set, the location will be based on the information provided by the calendar module. The first upcoming event with location data will be used.
+| `appid` | The [OpenWeatherMap](https://home.openweathermap.org) API key, which can be obtained by creating an OpenWeatherMap account.
This value is **REQUIRED**
+| `units` | What units to use. Specified by config.js
**Possible values:** `config.units` = Specified by config.js, `default` = Kelvin, `metric` = Celsius, `imperial` =Fahrenheit
**Default value:** `config.units`
+| `roundTemp` | Round temperature value to nearest integer.
**Possible values:** `true` (round to integer) or `false` (display exact value with decimal point)
**Default value:** `false`
+| `updateInterval` | How often does the content needs to be fetched? (Milliseconds)
**Possible values:** `1000` - `86400000`
**Default value:** `600000` (10 minutes)
+| `animationSpeed` | Speed of the update animation. (Milliseconds)
**Possible values:**`0` - `5000`
**Default value:** `1000` (1 second)
+| `timeFormat` | Use 12 or 24 hour format.
**Possible values:** `12` or `24`
**Default value:** uses value of _config.timeFormat_
+| `showPeriod` | Show the period (am/pm) with 12 hour format
**Possible values:** `true` or `false`
**Default value:** `true`
+| `showPeriodUpper` | Show the period (AM/PM) with 12 hour format as uppercase
**Possible values:** `true` or `false`
**Default value:** `false`
+| `showWindDirection` | Show the wind direction next to the wind speed.
**Possible values:** `true` or `false`
**Default value:** `true`
+| `showHumidity` | Show the current humidity
**Possible values:** `true` or `false`
**Default value:** `false`
+| `onlyTemp` | Show only current Temperature and weather icon.
**Possible values:** `true` or `false`
**Default value:** `false`
+| `useBeaufort` | Pick between using the Beaufort scale for wind speed or using the default units.
**Possible values:** `true` or `false`
**Default value:** `true`
+| `lang` | The language of the days.
**Possible values:** `en`, `nl`, `ru`, etc ...
**Default value:** uses value of _config.language_
+| `initialLoadDelay` | The 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`
+| `retryDelay` | The delay before retrying after a request failure. (Milliseconds)
**Possible values:** `1000` - `60000`
**Default value:** `2500`
+| `apiVersion` | The OpenWeatherMap API version to use.
**Default value:** `2.5`
+| `apiBase` | The OpenWeatherMap base URL.
**Default value:** `'http://api.openweathermap.org/data/'`
+| `weatherEndpoint` | The OpenWeatherMap API endPoint.
**Default value:** `'weather'`
+| `appendLocationNameToHeader` | If set to `true`, the returned location name will be appended to the header of the module, if the header is enabled. This is mainly intresting when using calender based weather.
**Default value:** `true`
+| `calendarClass` | The class for the calender module to base the event based weather information on.
**Default value:** `'calendar'`
+| `iconTable` | The conversion table to convert the weather conditions to weather-icons.
**Default value:** view tabel below.
+
+#### Default Icon Table
+````javascript
+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'
+}
+````
diff --git a/modules/default/currentweather/currentweather.js b/modules/default/currentweather/currentweather.js
index e92550ea..135af54a 100644
--- a/modules/default/currentweather/currentweather.js
+++ b/modules/default/currentweather/currentweather.js
@@ -296,7 +296,7 @@ Module.register("currentweather",{
*/
processWeather: function(data) {
- if (!data || !data.main || !data.main.temp) {
+ if (!data || !data.main || typeof data.main.temp === "undefined") {
// Did not receive usable new data.
// Maybe this needs a better check?
return;
diff --git a/modules/default/helloworld/README.md b/modules/default/helloworld/README.md
index 72e7d023..d86fce3d 100644
--- a/modules/default/helloworld/README.md
+++ b/modules/default/helloworld/README.md
@@ -6,11 +6,11 @@ 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.
+ module: "helloworld",
+ position: "bottom_bar", // This can be any of the regions.
config: {
// See 'Configuration options' for more information.
- text: 'Hello world!'
+ text: "Hello world!"
}
}
]
@@ -20,23 +20,6 @@ modules: [
The following properties can be configured:
-
-
-
-
-
- | Option |
- Description |
-
-
-
-
-
- text |
- The text to display.
-
Example: 'Hello world!'
-
Default value: 'Hello world!'
- |
-
-
-
+| Option | Description
+| ------ | -----------
+| `text` | The text to display.
**Example:** `'Hello world!'`
**Default value:** `'Hello world!'`
diff --git a/modules/default/newsfeed/README.md b/modules/default/newsfeed/README.md
index 58c7b9ae..bfaa1aad 100644
--- a/modules/default/newsfeed/README.md
+++ b/modules/default/newsfeed/README.md
@@ -1,15 +1,16 @@
# 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.
+This module displays news headlines based on an RSS feed. Scrolling through news headlines happens time-based (````updateInterval````), but can also be controlled by sending news feed specific notifications to the module.
## Using the module
+### Configuration
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.
+ 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.
@@ -30,152 +31,51 @@ modules: [
]
````
+### Notifications
+#### Interacting with the module
+MagicMirror's [notification mechanism](https://github.com/MichMich/MagicMirror/tree/master/modules#thissendnotificationnotification-payload) allows to send notifications to the `newsfeed` module. The following notifications are supported:
+
+| Notification Identifier | Description
+| ----------------------- | -----------
+| `ARTICLE_NEXT` | Shows the next news title (hiding the summary or previously fully displayed article)
+| `ARTICLE_PREVIOUS` | Shows the previous news title (hiding the summary or previously fully displayed article)
+| `ARTICLE_MORE_DETAILS` | When received the _first time_, shows the corresponding description of the currently displayed news title.
The module expects that the module's configuration option `showDescription` is set to `false` (default value).
When received a _second consecutive time_, shows the full news article in an IFRAME.
This requires that the news page can be embedded in an IFRAME, e.g. doesn't have the HTTP response header [X-Frame-Options](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/X-Frame-Options) set to e.g. `DENY`.
+| `ARTICLE_LESS_DETAILS` | Hides the summary or full news article and only displays the news title of the currently viewed news item.
+
+Note the payload of the sent notification event is ignored.
+
+#### Example
+The following example shows how the next news article title can be displayed on the MagicMirror.
+````javascript
+this.sendNotification('ARTICLE_NEXT');
+````
+
+#### `newsfeed` specific notification emitting modules
+The third party [MMM-Gestures](https://github.com/thobach/MMM-Gestures) module supports above notifications when moving your hand up, down, left or right in front of a gesture sensor attached to the MagicMirror. See module's readme for more details.
+
## Configuration options
The following properties can be configured:
-
-
-
-
-
- | Option |
- Description |
-
-
-
-
-
- feeds |
- An array of feed urls that will be used as source.
- More info about this object can be found below.
-
Default value: [
- {
- title: "New York Times",
- url: "http://www.nytimes.com/services/xml/rss/nyt/HomePage.xml",
- encoding: "UTF-8"
- }
- ]
- |
-
-
-
- showSourceTitle |
- Display the title of the source.
-
Possible values: true or false
-
Default value: true
- |
-
-
- showPublishDate |
- Display the publish date of an headline.
-
Possible values: true or false
-
Default value: true
- |
-
-
- showDescription |
- Display the description of an item.
-
Possible values: true or false
-
Default value: false
- |
-
-
-
- reloadInterval |
- How often does the content needs to be fetched? (Milliseconds)
-
Possible values: 1000 - 86400000
-
Default value: 300000 (5 minutes)
- |
-
-
- updateInterval |
- How often do you want to display a new headline? (Milliseconds)
-
Possible values:1000 - 60000
-
Default value: 10000 (10 seconds)
- |
-
-
- animationSpeed |
- Speed of the update animation. (Milliseconds)
-
Possible values:0 - 5000
-
Default value: 2500 (2.5 seconds)
- |
-
-
- maxNewsItems |
- Total amount of news items to cycle through. (0 for unlimited)
-
Possible values:0 - ...
-
Default value: 0
- |
-
- removeStartTags: false,
- removeEndTags: false,
- startTags: [],
- endTags: []
-
-
-
- removeStartTags |
- Some newsfeeds feature tags at the beginning of their titles or descriptions, such as [VIDEO].
- This setting allows for the removal of specified tags from the beginning of an item's description and/or title.
-
Possible values:'title', 'description', 'both'
- |
-
-
- startTags |
- List the tags you would like to have removed at the beginning of the feed item
-
Possible values: ['TAG'] or ['TAG1','TAG2',...]
- |
-
-
- removeEndTags |
- Remove specified tags from the end of an item's description and/or title.
-
Possible values:'title', 'description', 'both'
- |
-
-
- endTags |
- List the tags you would like to have removed at the end of the feed item
-
Possible values: ['TAG'] or ['TAG1','TAG2',...]
- |
-
-
-
+| Option | Description
+| ----------------- | -----------
+| `feeds` | An array of feed urls that will be used as source.
More info about this object can be found below.
**Default value:** `[{ title: "New York Times", url: "http://www.nytimes.com/services/xml/rss/nyt/HomePage.xml", encoding: "UTF-8" }]`
+| `showSourceTitle` | Display the title of the source.
**Possible values:** `true` or `false`
**Default value:** `true`
+| `showPublishDate` | Display the publish date of an headline.
**Possible values:** `true` or `false`
**Default value:** `true`
+| `showDescription` | Display the description of an item.
**Possible values:** `true` or `false`
**Default value:** `false`
+| `reloadInterval` | How often does the content needs to be fetched? (Milliseconds)
**Possible values:** `1000` - `86400000`
**Default value:** `300000` (5 minutes)
+| `updateInterval` | How often do you want to display a new headline? (Milliseconds)
**Possible values:**`1000` - `60000`
**Default value:** `10000` (10 seconds)
+| `animationSpeed` | Speed of the update animation. (Milliseconds)
**Possible values:**`0` - `5000`
**Default value:** `2500` (2.5 seconds)
+| `maxNewsItems` | Total amount of news items to cycle through. (0 for unlimited)
**Possible values:**`0` - `...`
**Default value:** `0`
+| `removeStartTags` | Some newsfeeds feature tags at the **beginning** of their titles or descriptions, such as _[VIDEO]_. This setting allows for the removal of specified tags from the beginning of an item's description and/or title.
**Possible values:**`'title'`, `'description'`, `'both'`
+| `startTags` | List the tags you would like to have removed at the beginning of the feed item
**Possible values:** `['TAG']` or `['TAG1','TAG2',...]`
+| `removeEndTags` | Remove specified tags from the **end** of an item's description and/or title.
**Possible values:**`'title'`, `'description'`, `'both'`
+| `endTags` | List the tags you would like to have removed at the end of the feed item
**Possible values:** `['TAG']` or `['TAG1','TAG2',...]`
The `feeds` property contains an array with multiple objects. These objects have the following properties:
-
-
-
-
- | Option |
- Description |
-
-
-
-
-
- title |
- The name of the feed source to be displayed above the news items.
-
This property is optional.
- |
-
-
-
- url |
- The url of the feed used for the headlines.
-
Example: 'http://www.nytimes.com/services/xml/rss/nyt/HomePage.xml'
- |
-
-
- encoding |
- The encoding of the news feed.
-
This property is optional.
-
Possible values:'UTF-8', 'ISO-8859-1', etc ...
-
Default value: 'UTF-8'
- |
-
-
-
-
+| Option | Description
+| ---------- | -----------
+| `title` | The name of the feed source to be displayed above the news items.
This property is optional.
+| `url` | The url of the feed used for the headlines.
**Example:** `'http://www.nytimes.com/services/xml/rss/nyt/HomePage.xml'`
+| `encoding` | The encoding of the news feed.
This property is optional.
**Possible values:**`'UTF-8'`, `'ISO-8859-1'`, etc ...
**Default value:** `'UTF-8'`
diff --git a/modules/default/newsfeed/fetcher.js b/modules/default/newsfeed/fetcher.js
index b7511de9..f4fb44d9 100644
--- a/modules/default/newsfeed/fetcher.js
+++ b/modules/default/newsfeed/fetcher.js
@@ -85,7 +85,12 @@ var Fetcher = function(url, reloadInterval, encoding) {
nodeVersion = Number(process.version.match(/^v(\d+\.\d+)/)[1]);
headers = {"User-Agent": "Mozilla/5.0 (Node.js "+ nodeVersion + ") MagicMirror/" + global.version + " (https://github.com/MichMich/MagicMirror/)"}
- request({uri: url, encoding: null, headers: headers}).pipe(iconv.decodeStream(encoding)).pipe(parser);
+ request({uri: url, encoding: null, headers: headers})
+ .on("error", function(error) {
+ fetchFailedCallback(self, error);
+ scheduleTimer();
+ })
+ .pipe(iconv.decodeStream(encoding)).pipe(parser);
};
diff --git a/modules/default/newsfeed/newsfeed.js b/modules/default/newsfeed/newsfeed.js
index 74014208..aed917f8 100644
--- a/modules/default/newsfeed/newsfeed.js
+++ b/modules/default/newsfeed/newsfeed.js
@@ -89,7 +89,8 @@ Module.register("newsfeed",{
if (this.newsItems.length > 0) {
- if (this.config.showSourceTitle || this.config.showPublishDate) {
+ // this.config.showFullArticle is a run-time configuration, triggered by optional notifications
+ if (!this.config.showFullArticle && (this.config.showSourceTitle || this.config.showPublishDate)) {
var sourceAndTimestamp = document.createElement("div");
sourceAndTimestamp.className = "light small dimmed";
@@ -152,10 +153,12 @@ Module.register("newsfeed",{
}
- var title = document.createElement("div");
- title.className = "bright medium light";
- title.innerHTML = this.newsItems[this.activeItem].title;
- wrapper.appendChild(title);
+ if(!this.config.showFullArticle){
+ var title = document.createElement("div");
+ title.className = "bright medium light";
+ title.innerHTML = this.newsItems[this.activeItem].title;
+ wrapper.appendChild(title);
+ }
if (this.config.showDescription) {
var description = document.createElement("div");
@@ -164,6 +167,21 @@ Module.register("newsfeed",{
wrapper.appendChild(description);
}
+ if (this.config.showFullArticle) {
+ var fullArticle = document.createElement("iframe");
+ fullArticle.className = "";
+ fullArticle.style.width = "100%";
+ fullArticle.style.top = "0";
+ fullArticle.style.left = "0";
+ fullArticle.style.position = "fixed";
+ fullArticle.height = window.innerHeight;
+ fullArticle.style.border = "none";
+ fullArticle.src = this.newsItems[this.activeItem].url;
+ wrapper.appendChild(fullArticle);
+ }
+
+
+
} else {
wrapper.innerHTML = this.translate("LOADING");
wrapper.className = "small dimmed";
@@ -256,7 +274,7 @@ Module.register("newsfeed",{
self.updateDom(self.config.animationSpeed);
- setInterval(function() {
+ timer = setInterval(function() {
self.activeItem++;
self.updateDom(self.config.animationSpeed);
}, this.config.updateInterval);
@@ -273,5 +291,50 @@ Module.register("newsfeed",{
return string.charAt(0).toUpperCase() + string.slice(1);
},
+ resetDescrOrFullArticleAndTimer: function() {
+ this.config.showDescription = false;
+ this.config.showFullArticle = false;
+ if(!timer){
+ this.scheduleUpdateInterval();
+ }
+ },
+
+ notificationReceived: function(notification, payload, sender) {
+ Log.info(this.name + " - received notification: " + notification);
+ if(notification == "ARTICLE_NEXT"){
+ var before = this.activeItem;
+ this.activeItem++;
+ if (this.activeItem >= this.newsItems.length) {
+ this.activeItem = 0;
+ }
+ this.resetDescrOrFullArticleAndTimer();
+ Log.info(this.name + " - going from article #" + before + " to #" + this.activeItem + " (of " + this.newsItems.length + ")");
+ this.updateDom(100);
+ } else if(notification == "ARTICLE_PREVIOUS"){
+ var before = this.activeItem;
+ this.activeItem--;
+ if (this.activeItem < 0) {
+ this.activeItem = this.newsItems.length - 1;
+ }
+ this.resetDescrOrFullArticleAndTimer();
+ Log.info(this.name + " - going from article #" + before + " to #" + this.activeItem + " (of " + this.newsItems.length + ")");
+ this.updateDom(100);
+ }
+ // if "more details" is received the first time: show article summary, on second time show full article
+ else if(notification == "ARTICLE_MORE_DETAILS"){
+ this.config.showDescription = !this.config.showDescription;
+ this.config.showFullArticle = !this.config.showDescription;
+ clearInterval(timer);
+ timer = null;
+ Log.info(this.name + " - showing " + this.config.showDescription ? "article description" : "full article");
+ this.updateDom(100);
+ } else if(notification == "ARTICLE_LESS_DETAILS"){
+ this.resetDescrOrFullArticleAndTimer();
+ Log.info(this.name + " - showing only article titles again");
+ this.updateDom(100);
+ } else {
+ Log.info(this.name + " - unknown notification, ignoring: " + notification);
+ }
+ },
});
diff --git a/modules/default/updatenotification/README.md b/modules/default/updatenotification/README.md
index 7d839087..54ba213a 100644
--- a/modules/default/updatenotification/README.md
+++ b/modules/default/updatenotification/README.md
@@ -8,8 +8,8 @@ To use this module, add it to the modules array in the `config/config.js` file:
````javascript
modules: [
{
- module: 'updatenotification',
- position: 'top_center', // This can be any of the regions.
+ module: "updatenotification",
+ position: "top_center", // This can be any of the regions.
config: {
// The config property is optional.
// See 'Configuration options' for more information.
@@ -22,21 +22,6 @@ modules: [
The following properties can be configured:
-
-
-
-
- | Option |
- Description |
-
-
-
-
- updateInterval |
- How often do you want to check for a new version? This value represents the interval in milliseconds.
-
Possible values: Any value above 60000 (1 minute);
-
Default value: 600000 (10 minutes);
- |
-
-
-
\ No newline at end of file
+| Option | Description
+| ---------------- | -----------
+| `updateInterval` | How often do you want to check for a new version? This value represents the interval in milliseconds.
**Possible values:** Any value above `60000` (1 minute)
**Default value:** `600000` (10 minutes);
diff --git a/modules/default/weatherforecast/README.md b/modules/default/weatherforecast/README.md
index 6b5e3930..3568f7de 100644
--- a/modules/default/weatherforecast/README.md
+++ b/modules/default/weatherforecast/README.md
@@ -8,14 +8,14 @@ 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.
+ 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',
- locationID: '', //Location ID from http://openweathermap.org/help/city_list.txt
- appid: 'abcde12345abcde12345abcde12345ab' //openweathermap.org API key.
+ location: "Amsterdam,Netherlands",
+ locationID: "", //Location ID from http://openweathermap.org/help/city_list.txt
+ appid: "abcde12345abcde12345abcde12345ab" //openweathermap.org API key.
}
}
]
@@ -25,177 +25,50 @@ modules: [
The following properties can be configured:
+| Option | Description
+| ---------------------------- | -----------
+| `location` | The location used for weather information.
**Example:** `'Amsterdam,Netherlands'`
**Default value:** `false`
**Note:** When the `location` and `locationID` are both not set, the location will be based on the information provided by the calendar module. The first upcoming event with location data will be used.
+| `locationID` | Location ID from [OpenWeatherMap](http://openweathermap.org/help/city_list.txt) **This will override anything you put in location.**
Leave blank if you want to use location.
**Example:** `1234567`
**Default value:** `false`
**Note:** When the `location` and `locationID` are both not set, the location will be based on the information provided by the calendar module. The first upcoming event with location data will be used.
+| `appid` | The [OpenWeatherMap](https://home.openweathermap.org) API key, which can be obtained by creating an OpenWeatherMap account.
This value is **REQUIRED**
+| `units` | What units to use. Specified by config.js
**Possible values:** `config.units` = Specified by config.js, `default` = Kelvin, `metric` = Celsius, `imperial` =Fahrenheit
**Default value:** `config.units`
+| `roundTemp` | Round temperature values to nearest integer.
**Possible values:** `true` (round to integer) or `false` (display exact value with decimal point)
**Default value:** `false`
+| `maxNumberOfDays` | How many days of forecast to return. Specified by config.js
**Possible values:** `1` - `16`
**Default value:** `7` (7 days)
This value is optional. By default the weatherforecast module will return 7 days.
+| `showRainAmount` | Should the predicted rain amount be displayed?
**Possible values:** `true` or `false`
**Default value:** `false`
This value is optional. By default the weatherforecast module will not display the predicted amount of rain.
+| `updateInterval` | How often does the content needs to be fetched? (Milliseconds)
**Possible values:** `1000` - `86400000`
**Default value:** `600000` (10 minutes)
+| `animationSpeed` | Speed of the update animation. (Milliseconds)
**Possible values:**`0` - `5000`
**Default value:** `1000` (1 second)
+| `lang` | The language of the days.
**Possible values:** `en`, `nl`, `ru`, etc ...
**Default value:** uses value of _config.language_
+| `fade` | Fade the future events to black. (Gradient)
**Possible values:** `true` or `false`
**Default value:** `true`
+| `fadePoint` | Where to start fade?
**Possible values:** `0` (top of the list) - `1` (bottom of list)
**Default value:** `0.25`
+| `initialLoadDelay` | The 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:** `2500` (2.5 seconds delay. This delay is used to keep the OpenWeather API happy.)
+| `retryDelay` | The delay before retrying after a request failure. (Milliseconds)
**Possible values:** `1000` - `60000`
**Default value:** `2500`
+| `apiVersion` | The OpenWeatherMap API version to use.
**Default value:** `2.5`
+| `apiBase` | The OpenWeatherMap base URL.
**Default value:** `'http://api.openweathermap.org/data/'`
+| `forecastEndpoint` | The OpenWeatherMap API endPoint.
**Default value:** `'forecast/daily'`
+| `appendLocationNameToHeader` | If set to `true`, the returned location name will be appended to the header of the module, if the header is enabled. This is mainly intresting when using calender based weather.
**Default value:** `true`
+| `calendarClass` | The class for the calender module to base the event based weather information on.
**Default value:** `'calendar'`
+| `iconTable` | The conversion table to convert the weather conditions to weather-icons.
**Default value:** view table below
+ `colored` | If set 'colored' to true the min-temp get a blue tone and the max-temp get a red tone.
**Default value:** `'false'`
-
-
-
-
- | Option |
- Description |
-
-
-
-
- location |
- The location used for weather information.
-
Example: 'Amsterdam,Netherlands'
-
Default value: false
- Note: When the location and locationID are both not set, the location will be based on the information provided by the calendar module. The first upcoming event with location data will be used.
- |
-
-
- locationID |
- Location ID from OpenWeatherMap This will override anything you put in location.
Leave blank if you want to use location.
-
Example: 1234567
-
Default value: false
- Note: When the location and locationID are both not set, the location will be based on the information provided by the calendar module. The first upcoming event with location data will be used.
- |
-
-
- appid |
- The OpenWeatherMap API key, which can be obtained by creating an OpenWeatherMap account.
-
This value is REQUIRED
- |
-
-
- units |
- What units to use. Specified by config.js
-
Possible values: config.units = Specified by config.js, default = Kelvin, metric = Celsius, imperial =Fahrenheit
-
Default value: config.units
- |
-
-
- roundTemp |
- Round temperature values to nearest integer.
-
Possible values: true (round to integer) or false (display exact value with decimal point)
-
Default value: false
- |
-
-
- maxNumberOfDays |
- How many days of forecast to return. Specified by config.js
-
Possible values: 1 - 16
-
Default value: 7 (7 days)
-
This value is optional. By default the weatherforecast module will return 7 days.
- |
-
-
- showRainAmount |
- Should the predicted rain amount be displayed?
-
Possible values: true or false
-
Default value: false
-
This value is optional. By default the weatherforecast module will not display the predicted amount of rain.
- |
-
-
- updateInterval |
- How often does the content needs to be fetched? (Milliseconds)
-
Possible values: 1000 - 86400000
-
Default value: 600000 (10 minutes)
- |
-
-
- animationSpeed |
- Speed of the update animation. (Milliseconds)
-
Possible values:0 - 5000
-
Default value: 1000 (1 second)
- |
-
-
- lang |
- The language of the days.
-
Possible values: en, nl, ru, etc ...
-
Default value: uses value of config.language
- |
-
-
- fade |
- Fade the future events to black. (Gradient)
-
Possible values: true or false
-
Default value: true
- |
-
-
- fadePoint |
- Where to start fade?
-
Possible values: 0 (top of the list) - 1 (bottom of list)
-
Default value: 0.25
- |
-
-
- initialLoadDelay |
- The 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: 2500 (2.5 seconds delay. This delay is used to keep the OpenWeather API happy.)
- |
-
-
- retryDelay |
- The delay before retrying after a request failure. (Milliseconds)
-
Possible values: 1000 - 60000
-
Default value: 2500
- |
-
-
- apiVersion |
- The OpenWeatherMap API version to use.
-
Default value: 2.5
- |
-
-
- apiBase |
- The OpenWeatherMap base URL.
-
Default value: 'http://api.openweathermap.org/data/'
- |
-
-
- forecastEndpoint |
- The OpenWeatherMap API endPoint.
-
Default value: 'forecast/daily'
- |
-
-
- appendLocationNameToHeader |
- If set to true, the returned location name will be appended to the header of the module, if the header is enabled. This is mainly intresting when using calender based weather.
-
Default value: true
- |
-
-
- calendarClass |
- The class for the calender module to base the event based weather information on.
-
Default value: 'calendar'
- |
-
-
- iconTable |
- The 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'
- }
- |
-
-
- colored |
- If set 'colored' to true the min-temp get a blue tone and the max-temp get a red tone.
-
Default value: false
- |
-
-
-
+#### Default Icon Table
+````javascript
+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'
+}
+````
diff --git a/modules/default/weatherforecast/weatherforecast.js b/modules/default/weatherforecast/weatherforecast.js
index 32daec30..211e5082 100644
--- a/modules/default/weatherforecast/weatherforecast.js
+++ b/modules/default/weatherforecast/weatherforecast.js
@@ -154,7 +154,11 @@ Module.register("weatherforecast",{
if (isNaN(forecast.rain)) {
rainCell.innerHTML = "";
} else {
- rainCell.innerHTML = forecast.rain + " mm";
+ if(config.units !== "imperial") {
+ rainCell.innerHTML = forecast.rain + " mm";
+ } else {
+ rainCell.innerHTML = (parseFloat(forecast.rain) / 25.4).toFixed(2) + " in";
+ }
}
rainCell.className = "align-right bright rain";
row.appendChild(rainCell);
diff --git a/modules/node_modules/node_helper/index.js b/modules/node_modules/node_helper/index.js
index dc57ef36..bdeccf8b 100644
--- a/modules/node_modules/node_helper/index.js
+++ b/modules/node_modules/node_helper/index.js
@@ -14,6 +14,11 @@ NodeHelper = Class.extend({
console.log("Initializing new module helper ...");
},
+ loaded: function(callback) {
+ console.log("Module helper loaded: " + this.name);
+ callback();
+ },
+
start: function() {
console.log("Staring module helper: " + this.name);
},
diff --git a/package.json b/package.json
index 118c9837..9d94a012 100644
--- a/package.json
+++ b/package.json
@@ -1,10 +1,12 @@
{
"name": "magicmirror",
- "version": "2.1.0",
+ "version": "2.1.1",
"description": "A modular interface for smart mirrors.",
"main": "js/electron.js",
"scripts": {
- "start": "electron js/electron.js"
+ "start": "sh run-start.sh",
+ "postinstall": "sh installers/postinstall/postinstall.sh",
+ "test": "./node_modules/mocha/bin/mocha tests --recursive"
},
"repository": {
"type": "git",
@@ -26,12 +28,14 @@
},
"homepage": "https://github.com/MichMich/MagicMirror#readme",
"devDependencies": {
+ "chai": "^3.5.0",
"grunt": "latest",
"grunt-eslint": "latest",
"grunt-jsonlint": "latest",
"grunt-markdownlint": "^1.0.13",
"grunt-stylelint": "latest",
"grunt-yamllint": "latest",
+ "mocha": "^3.2.0",
"stylelint-config-standard": "latest",
"time-grunt": "latest"
},
@@ -44,7 +48,7 @@
"iconv-lite": "latest",
"moment": "latest",
"request": "^2.78.0",
- "rrule": "latest",
+ "rrule-alt": "^2.2.3",
"simple-git": "^1.62.0",
"socket.io": "^1.5.1",
"valid-url": "latest",
diff --git a/run-start.sh b/run-start.sh
new file mode 100644
index 00000000..6c4d4003
--- /dev/null
+++ b/run-start.sh
@@ -0,0 +1,4 @@
+if [ -z "$DISPLAY" ]; then #If not set DISPLAY is SSH remote or tty
+ export DISPLAY=:0 # Set by defaul display
+fi
+electron js/electron.js
diff --git a/splashscreen/splash.png b/splashscreen/splash.png
index f3da394b..b2acc495 100644
Binary files a/splashscreen/splash.png and b/splashscreen/splash.png differ
diff --git a/tests/functions/compare-version.js b/tests/functions/compare-version.js
new file mode 100644
index 00000000..8cc22101
--- /dev/null
+++ b/tests/functions/compare-version.js
@@ -0,0 +1,20 @@
+var chai = require("chai");
+var expect = chai.expect;
+var classMM = require("../../js/class.js"); // require for load module.js
+var moduleMM = require("../../js/module.js")
+
+describe("Test function cmpVersions in js/module.js", function() {
+
+ it("should return -1 when comparing 2.1 to 2.2", function() {
+ expect(moduleMM._test.cmpVersions("2.1", "2.2")).to.equal(-1);
+ });
+
+ it("should be return 0 when comparing 2.2 to 2.2", function() {
+ expect(moduleMM._test.cmpVersions("2.2", "2.2")).to.equal(0);
+ });
+
+ it("should be return 1 when comparing 1.1 to 1.0", function() {
+ expect(moduleMM._test.cmpVersions("1.1", "1.0")).to.equal(1);
+ });
+});
+
diff --git a/tests/global_vars/root_path.js b/tests/global_vars/root_path.js
new file mode 100644
index 00000000..04edc03f
--- /dev/null
+++ b/tests/global_vars/root_path.js
@@ -0,0 +1,25 @@
+var fs = require("fs");
+var path = require("path");
+var chai = require("chai");
+var expect = chai.expect;
+
+describe("Test global.root_path, set in js/app.js", function() {
+ var appMM = require("../../js/app.js")
+
+ var expectedSubPaths = [
+ "modules",
+ "serveronly",
+ "js",
+ "js/app.js",
+ "js/main.js",
+ "js/electron.js",
+ "config"
+ ];
+
+ expectedSubPaths.forEach(subpath => {
+ it(`should contain a file/folder "${subpath}"`, function() {
+ expect(fs.existsSync(path.join(global.root_path, subpath))).to.equal(true);
+ });
+ });
+});
+
diff --git a/translations/af.json b/translations/af.json
new file mode 100644
index 00000000..894b14ea
--- /dev/null
+++ b/translations/af.json
@@ -0,0 +1,34 @@
+{
+ /* GENERAL */
+ "LOADING": "Besig om te laai …",
+
+ /* CALENDAR */
+ "TODAY": "Vandag",
+ "TOMORROW": "Môre",
+ "DAYAFTERTOMORROW": "Oormôre",
+ "RUNNING": "Eindig in",
+ "EMPTY": "Geen komende gebeurtenisse.",
+
+ /* WEATHER */
+ "N": "N",
+ "NNE": "NNO",
+ "NE": "NO",
+ "ENE": "ONO",
+ "E": "O",
+ "ESE": "OSO",
+ "SE": "SO",
+ "SSE": "SSO",
+ "S": "S",
+ "SSW": "SSW",
+ "SW": "SW",
+ "WSW": "WSW",
+ "W": "W",
+ "WNW": "WNW",
+ "NW": "NW",
+ "NNW": "NNW",
+
+ /* UPDATE INFO */
+ "UPDATE_NOTIFICATION": "MagicMirror² update beskikbaar.",
+ "UPDATE_NOTIFICATION_MODULE": "Update beskikbaar vir MODULE_NAME module.",
+ "UPDATE_INFO": "Die huidige installasie is COMMIT_COUNT agter op die BRANCH_NAME branch."
+}
diff --git a/translations/da.json b/translations/da.json
index 4b346437..5ad271fe 100644
--- a/translations/da.json
+++ b/translations/da.json
@@ -25,7 +25,7 @@
"W": "V",
"WNW": "VNV",
"NW": "NV",
- "NNW": "NNV"
+ "NNW": "NNV",
/* UPDATE INFO */
diff --git a/translations/fi.json b/translations/fi.json
index b753039e..59fa0180 100644
--- a/translations/fi.json
+++ b/translations/fi.json
@@ -5,6 +5,7 @@
/* CALENDAR */
"TODAY": "Tänään",
"TOMORROW": "Huomenna",
+ "DAYAFTERTOMORROW": "Ylihuomenna",
"RUNNING": "Meneillään",
"EMPTY": "Ei tulevia tapahtumia.",
@@ -24,5 +25,9 @@
"W": "L",
"WNW": "LPL",
"NW": "PL",
- "NNW": "PPL"
+ "NNW": "PPL",
+
+ /* UPDATE INFO */
+ "UPDATE_NOTIFICATION": "MagicMirror² päivitys saatavilla.",
+ "UPDATE_NOTIFICATION_MODULE": "Päivitys saatavilla moduulille MODULE_NAME."
}
diff --git a/translations/hu.json b/translations/hu.json
new file mode 100644
index 00000000..069ad1ad
--- /dev/null
+++ b/translations/hu.json
@@ -0,0 +1,34 @@
+{
+ /* GENERAL */
+ "LOADING": "Betöltés …",
+
+ /* CALENDAR */
+ "TODAY": "Ma",
+ "TOMORROW": "Holnap",
+ "DAYAFTERTOMORROW": "Holnapután",
+ "RUNNING": "Vége lesz",
+ "EMPTY": "Nincs közelgő esemény.",
+
+ /* WEATHER */
+ "N": "É",
+ "NNE": "ÉÉK",
+ "NE": "ÉK",
+ "ENE": "KÉK",
+ "E": "K",
+ "ESE": "KDK",
+ "SE": "DK",
+ "SSE": "DDK",
+ "S": "D",
+ "SSW": "DDNy",
+ "SW": "DNy",
+ "WSW": "NyDNy",
+ "W": "Ny",
+ "WNW": "NyÉNy",
+ "NW": "ÉNy",
+ "NNW": "ÉÉNy",
+
+ /* UPDATE INFO */
+ "UPDATE_NOTIFICATION": "MagicMirror² elérhető egy frissítés!",
+ "UPDATE_NOTIFICATION_MODULE": "A frissítés MODULE_NAME modul néven érhető el.",
+ "UPDATE_INFO": "A jelenlegi telepítés COMMIT_COUNT mögött BRANCH_NAME ágon található."
+}
\ No newline at end of file
diff --git a/translations/is.json b/translations/is.json
new file mode 100644
index 00000000..d3e6d6cb
--- /dev/null
+++ b/translations/is.json
@@ -0,0 +1,34 @@
+{
+ /* GENERAL */
+ "LOADING": "Hleð upp …",
+
+ /* CALENDAR */
+ "TODAY": "Í dag",
+ "TOMORROW": "Á morgun",
+ "DAYAFTERTOMORROW": "Ekki á morgun, heldur hinn",
+ "RUNNING": "Endar eftir",
+ "EMPTY": "Ekkert framundan.",
+
+ /* WEATHER */
+ "N": "N",
+ "NNE": "NNA",
+ "NE": "NA",
+ "ENE": "ANA",
+ "E": "A",
+ "ESE": "ASA",
+ "SE": "SA",
+ "SSE": "SSA",
+ "S": "S",
+ "SSW": "SSV",
+ "SW": "SV",
+ "WSW": "VSV",
+ "W": "V",
+ "WNW": "VNV",
+ "NW": "NV",
+ "NNW": "NNV",
+
+ /* UPDATE INFO */
+ "UPDATE_NOTIFICATION": "MagicMirror² uppfærsla í boði.",
+ "UPDATE_NOTIFICATION_MODULE": "Uppfærsla í boði fyrir MODULE_NAME module.",
+ "UPDATE_INFO": "Núverandi kerfi er COMMIT_COUNT á eftir BRANCH_NAME branchinu."
+}
diff --git a/translations/pl.json b/translations/pl.json
index 7a47745b..06bf3b5c 100644
--- a/translations/pl.json
+++ b/translations/pl.json
@@ -24,10 +24,10 @@
"W": "W",
"WNW": "WNW",
"NW": "NW",
- "NNW": "NNW"
-
+ "NNW": "NNW",
+
/* UPDATE INFO */
"UPDATE_NOTIFICATION": "Dostępna jest aktualizacja MagicMirror².",
"UPDATE_NOTIFICATION_MODULE": "Dostępna jest aktualizacja modułu MODULE_NAME.",
- "UPDATE_INFO": "The current installation is COMMIT_COUNT behind on the BRANCH_NAME branch."
+ "UPDATE_INFO": "Zainstalowana wersja odbiega o COMMIT_COUNT commitów od gałęzi BRANCH_NAME."
}
diff --git a/translations/ru.json b/translations/ru.json
new file mode 100644
index 00000000..053385ee
--- /dev/null
+++ b/translations/ru.json
@@ -0,0 +1,34 @@
+{
+ /* GENERAL */
+ "LOADING": "Загрузка …",
+
+ /* CALENDAR */
+ "TODAY": "Сегодня",
+ "TOMORROW": "Завтра",
+ "DAYAFTERTOMORROW": "Послезавтра",
+ "RUNNING": "Заканчивается через",
+ "EMPTY": "Нет предстоящих событий",
+
+ /* WEATHER */
+ "N": "С",
+ "NNE": "ССВ",
+ "NE": "СВ",
+ "ENE": "ВСВ",
+ "E": "В",
+ "ESE": "ВЮВ",
+ "SE": "ЮВ",
+ "SSE": "ЮЮВ",
+ "S": "Ю",
+ "SSW": "ЮЮЗ",
+ "SW": "ЮЗ",
+ "WSW": "ЗЮЗ",
+ "W": "З",
+ "WNW": "ЗСЗ",
+ "NW": "СЗ",
+ "NNW": "ССЗ",
+
+ /* UPDATE INFO */
+ "UPDATE_NOTIFICATION": "Есть обновление для MagicMirror².",
+ "UPDATE_NOTIFICATION_MODULE": "Есть обновление для MODULE_NAME модуля.",
+ "UPDATE_INFO": "Данная инсталляция позади BRANCH_NAME ветки на COMMIT_COUNT коммитов."
+}
diff --git a/translations/translations.js b/translations/translations.js
index d572c803..c10da418 100644
--- a/translations/translations.js
+++ b/translations/translations.js
@@ -26,4 +26,8 @@ var translations = {
"gr" : "translations/gr.json", // Greek
"da" : "translations/da.json", // Danish
"tr" : "translations/tr.json", // Turkish
+ "ru" : "translations/ru.json", // Russian
+ "af" : "translations/af.json", // Afrikaans
+ "hu" : "translations/hu.json", // Hungarian
+ "is" : "translations/is.json", // Icelandic
};
|