+
+
+
+
+
display_timefloat int
- 3.5
+ int
+ 3500
welcome_messagestring false
- Welcome, start was successfull!
+ false (no message at startup)
titleReplace
titleReplace: {'Birthday of ' : '', 'foo':'bar'}
+
+ {
+ "De verjaardag van ": "",
+ "'s birthday": ""
+ }
+
false
dateFormatMMM Do (e.g. Jan 18th)
+ timeFormatrelative
getRelative0 (events stay absolute) - 48 (48 hours before the event starts)
+ 6
+ urgencyabsolute, the urgency setting allows you to display events within a specific time frame as relative
This allows events within a certain time frame to be displayed as relative (in xx days) while others are displayed as absolute dates7 (for 7 days)0 (disabled)
+ 7
+ broadcastEventsCALENDAR_EVENTS. The event objects are stored in an array and contain the following fields: title, startDate, endDate, fullDayEvent, location and geo.true, false true
+ hidePrivatetrue or false
+ false
symbol symbol repeatingCountTitle repeatingCountTitle'Birthday'
user user pass passtop
+ timezoneAmerica/New_York, America/Santiago, Etc/GMT+10
+ none
+ remoteFilecompliments.json
+ null (Do not load from file)
+ 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.
+
+If use the currentweather is possible use a actual weather for set compliments. The availables properties are:
+* 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'
+ ],
+ snow: [
+ 'Snowball battle!'
+ ],
+ rain: [
+ 'Don\'t forget your umbrella'
+ ]
+ }
+}
+````
+
+
#### Default value:
````javascript
config: {
@@ -85,3 +132,32 @@ config: {
}
}
````
+
+### External Compliment File
+You may specify an external file that contains the three compliment arrays. This is particularly useful if you have a
+large number of compliments and do not wish to crowd your `config.js` file with a large array of compliments.
+Adding the `remoteFile` variable will override an array you specify in the configuration file.
+
+This file must be straight JSON. Note that the array names need quotes
+around them ("morning", "afternoon", "evening", "snow", "rain", etc.).
+#### Example compliments.json file:
+````json
+{
+ "morning" : [
+ "Good morning, sunshine!",
+ "Who needs coffee when you have your smile?",
+ "Go get 'em, Tiger!"
+ ],
+ "afternoon" : [
+ "Hitting your stride!",
+ "You are making a difference!",
+ "You're more fun than bubble wrap!"
+ ],
+ "evening" : [
+ "You made someone smile today, I know it.",
+ "You are making a difference.",
+ "The day was better for your efforts."
+ ]
+}
+````
+
diff --git a/modules/default/compliments/compliments.js b/modules/default/compliments/compliments.js
index 61f9ec5f..9f514ff1 100644
--- a/modules/default/compliments/compliments.js
+++ b/modules/default/compliments/compliments.js
@@ -29,9 +29,13 @@ Module.register("compliments",{
]
},
updateInterval: 30000,
+ remoteFile: null,
fadeSpeed: 4000
},
+ // Set currentweather from module
+ currentWeatherType: "",
+
// Define required scripts.
getScripts: function() {
return ["moment.js"];
@@ -43,6 +47,12 @@ Module.register("compliments",{
this.lastComplimentIndex = -1;
+ if (this.config.remoteFile != null) {
+ this.complimentFile((response) => {
+ this.config.compliments = JSON.parse(response);
+ });
+ }
+
// Schedule update timer.
var self = this;
setInterval(function() {
@@ -84,14 +94,36 @@ Module.register("compliments",{
*/
complimentArray: function() {
var hour = moment().hour();
+ var compliments = null;
if (hour >= 3 && hour < 12) {
- return this.config.compliments.morning;
+ compliments = this.config.compliments.morning;
} else if (hour >= 12 && hour < 17) {
- return this.config.compliments.afternoon;
+ compliments = this.config.compliments.afternoon;
} else {
- return this.config.compliments.evening;
+ compliments = this.config.compliments.evening;
}
+
+ if ( this.currentWeatherType in this.config.compliments) {
+ compliments.push.apply(compliments, this.config.compliments[this.currentWeatherType]);
+ }
+ return compliments;
+
+ },
+
+ /* complimentFile(callback)
+ * Retrieve a file from the local filesystem
+ */
+ complimentFile: function(callback) {
+ var xobj = new XMLHttpRequest();
+ xobj.overrideMimeType("application/json");
+ xobj.open("GET", this.file(this.config.remoteFile), true);
+ xobj.onreadystatechange = function () {
+ if (xobj.readyState == 4 && xobj.status == "200") {
+ callback(xobj.responseText);
+ }
+ };
+ xobj.send(null);
},
/* complimentArray()
@@ -112,10 +144,44 @@ Module.register("compliments",{
var compliment = document.createTextNode(complimentText);
var wrapper = document.createElement("div");
- wrapper.className = "thin xlarge bright";
+ wrapper.className = this.config.classes ? this.config.classes : "thin xlarge bright";
wrapper.appendChild(compliment);
return wrapper;
- }
+ },
+
+
+ // From data currentweather set weather type
+ setCurrentWeatherType: function(data) {
+ var weatherIconTable = {
+ "01d": "day_sunny",
+ "02d": "day_cloudy",
+ "03d": "cloudy",
+ "04d": "cloudy_windy",
+ "09d": "showers",
+ "10d": "rain",
+ "11d": "thunderstorm",
+ "13d": "snow",
+ "50d": "fog",
+ "01n": "night_clear",
+ "02n": "night_cloudy",
+ "03n": "night_cloudy",
+ "04n": "night_cloudy",
+ "09n": "night_showers",
+ "10n": "night_rain",
+ "11n": "night_thunderstorm",
+ "13n": "night_snow",
+ "50n": "night_alt_cloudy_windy"
+ };
+ this.currentWeatherType = weatherIconTable[data.weather[0].icon];
+ },
+
+
+ // Override notification handler.
+ notificationReceived: function(notification, payload, sender) {
+ if (notification == "CURRENTWEATHER_DATA") {
+ this.setCurrentWeatherType(payload.data);
+ }
+ },
});
diff --git a/modules/default/currentweather/README.md b/modules/default/currentweather/README.md
index 2a6f7844..ccef543c 100644
--- a/modules/default/currentweather/README.md
+++ b/modules/default/currentweather/README.md
@@ -14,7 +14,7 @@ modules: [
config: {
// See 'Configuration options' for more information.
location: 'Amsterdam,Netherlands',
- locationID: '', //Location ID from http://bulk.openweather.org/sample/
+ locationID: '', //Location ID from http://openweathermap.org/help/city_list.txt
appid: 'abcde12345abcde12345abcde12345ab' //openweathermap.org API key.
}
}
@@ -35,19 +35,20 @@ The following properties can be configured:
-
locationAmsterdam,Netherlands
- New York
+ 'Amsterdam,Netherlands'
+ falselocation 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.
locationID1234567
- falselocation 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.
config.units
roundTemptrue (round to integer) or false (display exact value with decimal point)
+ false
+ updateInterval1000 - 86400000
- 300000 (10 minutes)
+ 600000 (10 minutes)
animationSpeed0 - 5000
- 2000 (2 seconds)
+ 1000 (1 second)
true
showHumiditytrue or false
+ false
+ onlyTemptrue or false
+ false
+ useBeaufort'weather'
appendLocationNameToHeadertrue, 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.true
+ calendarClass'calendar'
+ iconTableanimationSpeed0 - 5000
- 2000 (2 seconds)
+ 2500 (2.5 seconds)
removeStartTags'title', 'description', 'both'
+ 'title', 'description', 'both'
removeEndTags'title', 'description', 'both'
+ 'title', 'description', 'both'
'UTF-8', 'ISO-8859-1', etc ...
- 'UTF-8'
+ 'UTF-8'
updateInterval60000 (1 minute);
+ 600000 (10 minutes);
+ locationAmsterdam,Netherlands
- New York
+ 'Amsterdam,Netherlands'
+ falselocation 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.
locationID1234567
- falselocation 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.
config.units
roundTemptrue (round to integer) or false (display exact value with decimal point)
+ false
+ maxNumberOfDaysshowRainAmounttrue or false
+ false
+ updateInterval1000 - 86400000
- 300000 (10 minutes)
+ 600000 (10 minutes)
animationSpeed0 - 5000
- 2000 (2 seconds)
+ 1000 (1 second)
langinitialLoadDelay1000 - 5000
- 0
+ 2500 (2.5 seconds delay. This delay is used to keep the OpenWeather API happy.)
weatherEndpointforecastEndpoint'forecast/daily'
appendLocationNameToHeadertrue, 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.true
+ calendarClass'calendar'
+ iconTable