remoteFile in compliments module

[DvdEnde]

@schlachtkreuzer6
The way you do it is the way it should be.
BUT i also cannot get it to work like this.

please try following:
Open config/config.js and remove

"config": {
		"remoteFile": "compliments.json"
	}

Then open your compliments.js and check:

defaults: {
		updateInterval: 30000,
		remoteFile: null,
		fadeSpeed: 4000
	},

change remoteFile to a useable name:

defaults: {
		updateInterval: 30000,
		remoteFile: "~/path to your/compliments.json",
		fadeSpeed: 4000
	},

then restart MM (or restart the PI)

[schlachtkreuzer6]

@DvdEnde i think my mirror has it´s own brain ^^ so i changed it like your post above. but MM just showing the default compliments. I don´t know whats wrong, but i think i will rebuild MM from the ground.

[DvdEnde]

#@schlachtkreuzer6
If MM is showing the default compliments, where are they?
Please post the complete defaults from your compliments.js AND
the complete part of the json for compliments from your config.js.

also post your jsonfile where to get your custom compliments.

maybe we all misunderstand you?

[schlachtkreuzer6]

@DvdEnde the default compliments are in the module itself ok, here we go:
~/MagicMirror/config/config.js

/* Magic Mirror Config Sample
*
* By Michael Teeuw http://michaelteeuw.nl
* MIT Licensed.
*/
var config = {
	"port": 8080,
	"language": "de",
	"timeFormat": 24,
	"units": "metric",
	"modules": [
		{
			"module": "alert"
		},
		{
			"module": "clock",
			"position": "top_left"
		},
		{
			"module": "calendar",
			"header": "Google Kalender",
			"position": "top_left",
			"config": {
				"calendars": [
					{
						"symbol": "calendar",
						"url": "my link 1"
					},
					{
						"symbol": "calendar",
						"url": "my link 2"
					},
					{
						"symbol": "calendar",
						"url": "my link 3"
					},
					{
						"symbol": "calendar",
						"url": "my link 4"
					},
					{
						"symbol": "calendar",
						"url": "my link 4"
					},
					{
						"symbol": "calendar",
						"url": "my link 5"
					}
				],
				"timeFormat": "absolute",
				"maximumEntries": "20",
				"fadePoint": "0.55"
			}
		},
		{
			"module": "compliments",
			"position": "lower_third",
			"config": {
				"compliments": {
     					 morning: [
         					 'Guten Morgen!',
         					 'Wie hast du geschlafen?',
         					 'Ich wünsche dir einen schönen Tag!'
              					 ],
    					 afternoon: [
        		 			 'Guten Tag!',
         					 'Du schaust gut aus!',
         					 'Wie war dein Tag!'
                 				 ],
     					 evening: [
          					 'Guten Abend!',
          					 'Na wie war dein Tag?',
          					 'Du warst heute fleßig!'
              					 ],

					"remoteFile": "compliments.json"
				},
				"updateInterval": 15000
			}
		},
		{
			"module": "currentweather",
			"position": "top_right",
			"config": {
				"location": "my location",
				"locationID": "",
				"appid": "my api"
			}
		},
		{
			"module": "weatherforecast",
			"header": "Wetter in den kommenden Tagen",
			"position": "top_right",
			"config": {
				"location": "my location",
				"locationID": "",
				"appid": "my api"
			}
		},
		{
			"module": "newsfeed",
			"position": "bottom_bar",
			"config": {
				"feeds": [
					{
						"title": "Die Presse",
						"url": "http://diepresse.com/rss/home"
					}
				],
				"showSourceTitle": true,
				"showPublishDate": true
			}
		},
		{
			"module": "MMM-Remote-Control"
		},
		{
			"module": "mmm-wu-moonphase",
			"header": "Aktuelle Mondphase",
			"position": "top_right",
			"config": {
				"apikey": "my api",
				"country": "Austria",
				"city": "Vienna",
				"apiLang": "DL"
			}
		},
		{
			"module": "MMM-WienerLinien",
			"position": "top_right",
			"config": {
				"api_key": "my api",
				"stations": [
					"abcd",
					"abcd"
				]
			}
		},
		{
			"module": "MMM-SpotifyConnectUI",
			"position": "fullscreen_below",
			"config": {}
		},
		{
			"module": "MMM-Globe",
			"config": {
				"style": "europeDiscNat",
				"imageSize": 250,
				"ownImagePath": "",
				"updateInterval": 600000
			}
		},
		{
			"module": "internet-monitor",
			"position": "top_bar",
			"config": {
				"type": "minimal",
				"maxTime": 20000,
				"updateInterval": 0,
				"verbose": false,
				"displayStrength": true,
				"displaySpeed": false,
				"strengthIconSize": 40,
				"maxGaugeScale": 100
			}
		},
		{
			"module": "MMM-Traffic",
			"position": "top_right",
			"config": {
				"api_key": "my api",
				"mode": "driving",
				"origin": "my home",
				"destination": "my work",
				"arrival_time": "",
				"route_name": "Home-work",
				"changeColor": true,
				"showGreen": false,
				"limitYellow": 5,
				"limitRed": 20,
				"traffic_model": "pessimistic",
				"interval": 120000,
				"language": "de",
				"prependText": "Derzeit"
			},
			"classes": "dimmed medium"
		},
		{
			"module": "MMM-RandomPhoto",
			"position": "fullscreen_below",
			"config": {
				"opacity": 0.3,
				"animationSpeed": 1500,
				"updateInterval": 15,
				"url": "https://unsplash.it/1080/1920/?random"
			}
		},
		{
			"module": "MMM-SystemStats",
			"position": "bottom_right",
			"config": {
				"updateInterval": 10000,
				"animationSpeed": 0
			},
			"classes": "small dimmed"
		},
		{
			"module": "MMM-Admin-Interface"
		}
	],
	"ipWhitelist": [
		"::fff:0.0.0.0/1",
		"::fff:128.0.0.0/2",
		"::fff:192.0.0.0/3",
		"::fff:224.0.0.0/4",
		"127.0.0.1",
		"::ffff:127.0.0.1",
		"::1"
	]
};
/*************** DO NOT EDIT THE LINE BELOW ***************/ 
if (typeof module !== 'undefined') {module.exports = config;}

this config is working perfect.

~/MagicMirror/modules/default/compliments/compliments.json (remoteFile) tried it also here ~/MagicMirror/config/compliments.json with and without absolut path.

{
      "morning": [
          "Test1!",
          "Test2?",
          "Test3!"
               ],
     "afternoon": [
          "Test4!",
          "Test5!",
          "Test6!"
                  ],
     "evening": [
           "Test7!",
           "Test8?",
           "Test9!"
               ]
}

and ~/MagicMirror/modules/default/compliments/compliments.js

* global Log, Module, moment */

/* Magic Mirror
 * Module: Compliments
 *
 * By Michael Teeuw http://michaelteeuw.nl
 * MIT Licensed.
 */

Module.register("compliments",{

	// Module config defaults.
	defaults: {
		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!"
			]
		},
		updateInterval: 30000,
		remoteFile: null,
		fadeSpeed: 4000
	},

	// Set currentweather from module
	currentWeatherType: "",

	// Define required scripts.
	getScripts: function() {
		return ["moment.js"];
	},

	// Define start sequence.
	start: function() {
		Log.info("Starting module: " + this.name);

		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() {
			self.updateDom(self.config.fadeSpeed);
		}, this.config.updateInterval);
	},

	/* randomIndex(compliments)
	 * Generate a random index for a list of compliments.
	 *
	 * argument compliments Array<String> - Array with compliments.
	 *
	 * return Number - Random index.
	 */
	randomIndex: function(compliments) {
		if (compliments.length === 1) {
			return 0;
		}

		var generate = function() {
			return Math.floor(Math.random() * compliments.length);
		};

		var complimentIndex = generate();

		while (complimentIndex === this.lastComplimentIndex) {
			complimentIndex = generate();
		}

		this.lastComplimentIndex = complimentIndex;

		return complimentIndex;
	},

	/* complimentArray()
	 * Retrieve an array of compliments for the time of the day.
	 *
	 * return compliments Array<String> - Array with compliments for the time of the day.
	 */
	complimentArray: function() {
		var hour = moment().hour();
		var compliments  = null;

		if (hour >= 3 && hour < 12) {
			compliments = this.config.compliments.morning;
		} else if (hour >= 12 && hour < 17) {
			compliments = this.config.compliments.afternoon;
		} else {
			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()
	 * Retrieve a random compliment.
	 *
	 * return compliment string - A compliment.
	 */
	randomCompliment: function() {
		var compliments = this.complimentArray();
		var index = this.randomIndex(compliments);

		return compliments[index];
	},

	// Override dom generator.
	getDom: function() {
		var complimentText = this.randomCompliment();

		var compliment = document.createTextNode(complimentText);
		var wrapper = document.createElement("div");
		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);
		}
	},

});

even when i change it like you said above:

defaults: {
		updateInterval: 30000,
		remoteFile: "~/MagicMirror/modules/default/compliments/compliments.json",
		fadeSpeed: 4000
	},

It´s showing then the default compliments. (hi sexy etc.)

it´s working with my custom compliments in the config.js perfectly. but when i try this code:

{
	"module": "compliments",
	"position": "lower_third",
	"config": {
		"remoteFile": "compliments.json"
	}
},

MM showing the error srceen that i had to set up a config file.

[jcorraliza]

@schlachtkreuzer6

it´s working with my custom compliments in the config.js perfectly. but when i try this code:

{
	"module": "compliments",
	"position": "lower_third",
	"config": {
		"remoteFile": "compliments.json"
	}
},

MM showing the error srceen that i had to set up a config file.

You have to get rid of those quotes around module, position, config, and remoteFile. It should look like this:

{
	module: 'compliments',
	position: 'lower_third',
	config: {
		remoteFile: 'compliments.json'
	}
},

[schlachtkreuzer6]

@jcorraliza it´s from the MMM-Admin-Interface… after initializing this module, there quotes are everywhere… but sure i will try this too

[DvdEnde]

@schlachtkreuzer6
You have tried many things, we can see it.

Maybe you cleanup the mess a little.
IN de config/confg.js remove the complete “config” from “module”: “compliments”.

"config": {
				"compliments": {

take away the quotes also like @jcorraliza adviced.

So the config.js looks like this (for your compliment module)

{
	module: "compliments",
	position: "lower_third"
},

then in the compliments.js you default sould look like this:

defaults: {
		updateInterval: 30000,
		remoteFile: "~/MagicMirror/modules/default/compliments/compliments.json",
		fadeSpeed: 4000
	},

It should run.

[schlachtkreuzer6]

@jcorraliza haha I can not believe it!!! now it´s working. okay so here is what i did:

so after ending with an error and resetting all the configs and .js files to default and my latest working config.js (post it above)
i shut it down
some hours later i boot it up again, and via putty ssh I copy and paste this code in the config.js:

{
	module: 'compliments',
	position: 'lower_third',
	config: {
		remoteFile: 'compliments.json'
	}
},

the comliments.js file is still located here: ~/MagicMirror/modules/default/compliments
then i restart the MM via pm2 restart mm
now it´s working with the compliments from the readme:

{
    "morning" : [
        "heyho"
    ],
    "afternoon" : [
        "home early?"
    ],
    "evening" : [
        "finally home"
    ],
        "fog" : [
                "fog, oh no :("
        ]
}

but anyway, the MMM-Admin-Interface changed the config.json to this again ^^:

{
  "module": "compliments",
  "position": "lower_third",
  "config": {
    "remoteFile": "compliments.json"
  }
}

many thanks for your help, and time!

[A Former User]

hey, sorry for being a bit silent. was travelling with no access to my raspberry. will give your solution a shot, too. why does it have to be a local file, though? my plan was to (in a 2nd step) place the compliments.json in my dropbox folder, so i can easily change the compliments remotely.

[bhepler]

@skr Because I’m a crap coder in Javascript.

Sorry for not helping earlier, folks. I was at a wedding and delivering my mirror as a gift. I’ll investigate and see if I can’t improve the mirror code.

You should not ever have to modify the compliments.js file. You should be able to pull it off with just modifications to the config.js file.

[DvdEnde]

@schlachtkreuzer6
Because it worked with you as it should be, so I changed my whole MM installation.
I did manage to keep the compliments unchanged too.
:D I am happy …

@strawberry-3-141 @yawns thanks guys. Your info helped me too a lot!

[DvdEnde]

@skr I am working on that now.
@strawberry-3-141 has some good information in this project:
https://forum.magicmirror.builders/topic/240/soccer-standings

I am struggling with the CORS at the moment but it is solvable…

[schlachtkreuzer6]

@DvdEnde Great :) did you manage to run the weather-dependent compliments? My goal is to add all weather conditions based compliments. The normal compliments work, just need some time to load after starting MM from 30 seconds to 3mins. But if a add all of them:

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_wind

in this format:

 ],
        "fog" : [
                "fog, oh no :("
 ],
......

MM starts to show the default comliments. Any Idea?

[jcorraliza]

@schlachtkreuzer6 said in remoteFile in compliments module:

@DvdEnde Great :) did you manage to run the weather-dependent compliments? My goal is to add all weather conditions based compliments. The normal compliments work, just need some time to load after starting MM from 30 seconds to 3mins. But if a add all of them:

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_wind

in this format:

 ],
        "fog" : [
                "fog, oh no :("
 ],
......

MM starts to show the default comliments. Any Idea?

This is the exact problem I’m running into as well. I can get the remoteFile to work if I just use the default times of day, but if I try using the currentweather objects, it just goes back to the default compliments.

[schlachtkreuzer6]

@jcorraliza yeah… the only reason why i would use the remote file is the weather stuff, and obviously this feature has a bug, or we are to weak in coding ^^

[bhepler]

Okay, I have the weather integration working. I’ll spare you the process I went through to figure it out, but the short version is that I am a worse developer than I originally suspected. The remoteFile capability works by replacing the three compliment arrays (morning, afternoon & evening). The weather integration works (sensibly, IMHO) by adding weather-specific compliments to the existing arrays.

So in order to get them both working, you need to specify both the original arrays and the weather-specific arrays. You can delete any weather-specific arrays you wish, but you must have the morning, afternoon & evening arrays. Copy & paste this compliments.json file to your mirror and then modify accordingly.

{
  "morning": ["Morning compliment"],
  "afternoon": ["Afternoon compliment"],
  "evening": ["Evening compliment"],
  "day_sunny" : [
    "Day Sunny Compliment 1",
    "Day Sunny Compliment 2"
  ],
  "day_cloudy" : [
    "Day Cloudy Compliment 1",
    "Day Cloudy Compliment 2"
  ],
  "cloudy" : ["Cloud 1"],
  "cloudy_windy" : ["Cloud windy"],
  "showers" : ["Showers"],
  "rain" : ["Rain"],
  "thunderstorm" : ["Thunderstorm"],
  "snow" : ["Snow"],
  "fog" : ["Fog"],
  "night_clear" : ["Night clear"],
  "night_cloudy" : ["Night Cloudy"],
  "night_showers" : ["Night showers"],
  "night_rain" : ["Night Rain"],
  "night_thunderstorm" : ["Night thunderstorm"],
  "night_snow" : ["Night Snow"],
  "night_alt_cloudy_wind": ["Night Cloudy Winds"]
}

I’m going to work on this a bit and hopefully the next release of the MirrorMirror software will be a bit more friendly. As an aside, I’ve noticed that the weather integration technique continually adds to the arrays. So the memory usage will grow and grow at whatever frequency you set the compliment refresh. This isn’t terrible, as straight text doesn’t take a whole lot of memory. But it may have unintended effects if you leave your mirror running for months at a time or if you are expecting a true randomization of the compliments you enter.

[schlachtkreuzer6]

@bhepler okay a bit weird^^ anyway thank you! It worked perfecly!
@Steff the config above :)

[roramirez]

@bhepler said in remoteFile in compliments module:

I’m going to work on this a bit and hopefully the next release of the MirrorMirror software will be a bit more friendly. As an aside, I’ve noticed that the weather integration technique continually adds to the arrays. So the memory usage will grow and grow at whatever frequency you set the compliment refresh. This isn’t terrible, as straight text doesn’t take a whole lot of memory. But it may have unintended effects if you leave your mirror running for months at a time or if you are expecting a true randomization of the compliments you enter.

Hi, when I worked in this feature I remember was a flashing about this.

If you can help how improved this is welcome :)

[Snille]

Hi! I’m using a separate compliments file (for each user). I’ve noticed that when I use non english characters they are not shown correctly.
The complement in the picture should say: “Tänk positivt”.
Now it says:

If I don’t use a compliments file and put the compliments directly in the config, it works fine.

What to do? :)

Best regards Snille

[strawberry 3.141]

@Snille did you save the compliments file as utf8 encoded?