read csv-data and put it in an array

Perlchamp

so i’m bloody happy :

var NodeHelper = require("node_helper");
var moment = require("moment");

// add require of other javascripot components here
// var xxx = require('yyy'); here
const csv = require("csvtojson");
var birthdaysArray = [];


module.exports = NodeHelper.create({

	init(){
		console.log("init module helper perlchamp");
	},

	start() {
		console.log("Starting module helper: " + this.name);
		console.log("Pfad zur csv-Datei: ", this.path + "/data/birthdays.csv");
		
		const csvFilePath = this.path + '/data/birthdays.csv';
		csv()
		.fromFile(csvFilePath)
		.then((jsonObj)=>{      
			birthdaysArray = JSON.stringify(jsonObj);
			console.log("birthdaysArray: ", birthdaysArray);
			
		var result = Object.entries(jsonObj.reduce((a, {birth, name}) => {
			const day = +birth.split('.')[0];
			a[day] = [...(a[day] || []), name];
			return a
		}, {})).map(([day, name]) => ({day, name})).sort((a, b) => +a.day - b.day)
		console.log("sorted birthdays : ", result);

		var today_day_month = moment().format("DD.MM");
		var today_month = moment().format("MM");
		})
		
	},

	stop(){
		console.log("Stopping module helper: " + this.name);
	},

	// handle messages from our module// each notification indicates a different messages
	// payload is a data structure that is different per message.. up to you to design this
	socketNotificationReceived(notification, payload) {
		//	console.log(this.name + " received a socket notification: " + notification + " - Payload: " + payload);
		console.log(this.name + " received a socket notification: " + birthdaysArray);
		// if config message from module
		if (notification === "CONFIG") {
			// save payload config info
			this.config=payload
			// wait 15 seconds, send a message back to module
			setTimeout(()=> { this.sendSocketNotification("message_from_helper"," this is a test_message")}, 15000)
		}
		else if(notification === "????2") {
		}

	},
});

so now I just have to manage to filter out the people from the complete csv-file who have their birthday in the current month …

Perlchamp

if i run :

		for(var birthday of birthdaysArray) {
			if(birthday.birth.startsWith(today_day_month)) {
				// this birthday is for today
				console.log(" birthday on "+ today_day_month+" is for "+birthday.name);
			} 
		}

than i get the following error-messages:

 Unhandled rejection TypeError: Cannot read property 'startsWith' of undefined
    at /home/dirk/MagicMirror/modules/perlchamp/node_helper.js:33:22
    at Object.onfulfilled (/home/dirk/MagicMirror/node_modules/csvtojson/v2/Converter.js:112:33)
    at Result.endProcess (/home/dirk/MagicMirror/node_modules/csvtojson/v2/Result.js:83:50)
    at Converter.processEnd (/home/dirk/MagicMirror/node_modules/csvtojson/v2/Converter.js:179:21)
    at /home/dirk/MagicMirror/node_modules/csvtojson/v2/Converter.js:172:19
    at tryCatcher (/home/dirk/MagicMirror/node_modules/bluebird/js/release/util.js:16:23)
    at Promise._settlePromiseFromHandler (/home/dirk/MagicMirror/node_modules/bluebird/js/release/promise.js:547:31)
    at Promise._settlePromise (/home/dirk/MagicMirror/node_modules/bluebird/js/release/promise.js:604:18)
    at Promise._settlePromise0 (/home/dirk/MagicMirror/node_modules/bluebird/js/release/promise.js:649:10)
    at Promise._settlePromises (/home/dirk/MagicMirror/node_modules/bluebird/js/release/promise.js:729:18)
    at _drainQueueStep (/home/dirk/MagicMirror/node_modules/bluebird/js/release/async.js:93:12)
    at _drainQueue (/home/dirk/MagicMirror/node_modules/bluebird/js/release/async.js:86:9)
    at Async._drainQueues (/home/dirk/MagicMirror/node_modules/bluebird/js/release/async.js:102:5)
    at Immediate.Async.drainQueues [as _onImmediate] (/home/dirk/MagicMirror/node_modules/bluebird/js/release/async.js:15:14)
    at processImmediate (internal/timers.js:439:21)

I was probably happy too early ;-( … shit happens.

sdetweil

@Perlchamp you converted the array to text format, so now its just one big string…

	birthdaysArray = JSON.stringify(jsonObj);

to print it out do this

                        birthdaysArray = jsonObj;
			console.log("birthdaysArray: "+JSON.stringify(jsonObj););

why do you need to sort them?
as you go thru you can just not save the ones not for today, plus/minus some lookahead

once you get to the today list you can sort the names if you need to.

sdetweil

@Perlchamp said in read csv-data and put it in an array:

now i’m looking for another one. is the birthdaysArray a json-Array or a javascript-array or … someone told me, it’s an object-Array and that this has nothing to do witch json … but: csvtojson, so …

json is a TEXT structure…

but it just so happens that javascript represents objects the same way… so the JSON library provides utilities to convert in both directions.

json text to object JSON.parse(text)
object to json text JSON.stringify(object)

text is text and has no meaning (its called opaque because u cannot tell what it is)

no reason to split the birthdate, as u won’t do anything with the individual parts
don’t do work if u don’t need the results

you do NOT Need to do this data reformatting IN the node helper… you can do it all in the modulename.js file, which would let you use the code debugger in the dev console.
in the .then of the node_helper csvtojson, just send the data to the module
self.sendsocketNotification(“have data”, jsonObj)
and the helper is done

on the modulename.js side

socketNotificationReceived(notification, payload){
if(notification =='have data'){

var now = moment()
var active_birthdays={}
for( var birthday of payload) {
// get 1st 5 chars of birthdate, thru month
// we will use this as the key in the hash
var birth_date=birthday.birth.subString(0,4)

// get the birthday as a moment in this year, for comparing
var birth_date_moment = moment(birth_date+now.getYear(),"DD.MMYYYY")

  
// u can add days to a moment object and then compare if the birthdate is before that date (and after now)
// so within the next xx days

  // if the date is the same or later, don't use time of day
   if(birth_date.startOf('day').isSame(now.startOf('day')){

       // birthday is in this month
      // check the hash if we've seen anything for today yet
      // if we haven't see this date yet
      if(active_birthdays[birth_date] == undefined){
           //  create the holder for its info (array of names) in the hash
           active_birthdays[birth_date]=[]
      }
      // save the persons name on the list
      active_birthdays[birth_date].push(birthday.name)
     
   }
}
     // tell MM to call and get our content
     self. updateDom()
}

at the end, you will have just birthdays in this month and for people with the same day
a list of people on that day

in the hash reader (getDom(), Object.keys(active_birthdays) will get you back an array of the
DD.MM strings that are present

but you can probably do without that… u know what today is, so if there is an object with todays DD.MM
then u have the list of people for today

if u want to allow (in the next 5 days,matching what the node_helper did), using moment, u can add a day, extract the DD.MM, check the hash,
repeat 4 more times

Perlchamp

ok, thank you sam.
Now I have to process the whole thing first, otherwise my head will burst ;-) …

Perlchamp

this is the actual node_helper.js:

var NodeHelper = require("node_helper");
var moment = require("moment");

// add require of other javascripot components here
// var xxx = require('yyy'); here
const csv = require("csvtojson");

var birthdaysArray = [];


module.exports = NodeHelper.create({

	init(){
		console.log("init module helper perlchamp");
	},

	start() {
		console.log("Starting module helper: " + this.name);
		//console.log("Pfad zur csv-Datei: ", this.path + "/data/birthdays.csv");

		moment.locale(config.language);  // set locale
		
		// convert the csv-file into a JSON-String
		const csvFilePath = this.path + '/data/birthdays.csv';
		csv()
		.fromFile(csvFilePath)
		.then((jsonObj)=>{      
			birthdaysArray = JSON.stringify(jsonObj);
			
			// for debugging only
			//console.log("birthdaysArray: ", birthdaysArray);
			
			// send data to [modulname].js
			self.sendsocketNotification("have data", birthdaysArray)

			// loop thru the array of birthday_info from file (jsonObj),
			// one 'row' per birthday
		
		})		
	},
	

	stop(){
		console.log("Stopping module helper: " + this.name);
	},

	// handle messages from our module// each notification indicates a different messages
	// payload is a data structure that is different per message.. up to you to design this
	socketNotificationReceived(notification, payload) {				
		// if config message from module
		if (notification === "CONFIG") {
			// save payload config info
			this.config=payload
			// wait 15 seconds, send a message back to module
			setTimeout(()=> { this.sendSocketNotification("message_from_helper"," this is a test_message")}, 15000)
		}
		else if(notification === "????2") {
		}
	},
});

i got an error-message :

[2020-05-01 23:21:12.072] [WARN]   Unhandled rejection ReferenceError: self is not defined
    at /home/dirk/MagicMirror/modules/perlchamp/node_helper.js:34:4

i think this could be the problem:

// send data to [modulname].js
self.sendsocketNotification("have data", birthdaysArray)

i tried “this.” and without “self.” and “this.” but nothing changed. now i’m searching in the web, maybe i will found some answers ;-)

Perlchamp

// send data to [modulname].js
self.sendsocketNotification("have data", birthdaysArray)

i have found a typing error. Socket instead socket. if i than change self. to this. no errror messages will displayed. but still black screen.
maybe i did not understand how to handle the getDom-section … i will still try …
but:
i see no notification in the terminal. ‘have data’ should actually appear there, shouldn’t it ?

sdetweil

@Perlchamp

do this, you need self

start() {
		var self = this
		console.log("Starting module helper: " + this.name);

the use self

                self.sendsocketNotification("have data", jsonObj)

u need to send the obj, not the string

as for black screen , that means the modulename side died…

f12 on the keyboard or ctrl-shift-i, select the console tab, and look for red text … usually a syntax error…

sdetweil

@Perlchamp

i see no notification in the terminal. ‘have data’ should actually appear there, shouldn’t it ?

no, the message is sent to the modulename.js side of your module…
using my sample code , right here

        // messages received from from your node helper (NOT other modules or the system)
	// payload is a notification dependent data structure, up to you to design between module and node_helper
	socketNotificationReceived: function(notification, payload) {

sdetweil

the two parts look like this

--------------------------------------------------------------------------------------------------
|                                  browser  side                                                 |
|                                       modulename.js (SampleModule.js)                          |
|                                                                                                |
|     receive (socketNotificationReceived)                send ( sendSocketNotification)         |
--------------------------------------------------------------------------------------------------
                    ^                                                     |
                    |                                                     |
--------------------------------------------------------------------------------------------------
                    |                                                     |
                    |                                                     V 
--------------------------------------------------------------------------------------------------
|      send ( sendSocketNotification)                   receive (socketNotificationReceived)     |
|                                                                                                |
|                                       node_helper.js                                           |
|                                  server side                                                   |
--------------------------------------------------------------------------------------------------

Perlchamp

yes, i understood. here’s my perlchamp.js (only socketNitificationReceived)

	// messages received from from your node helper (NOT other modules or the system)
	// payload is a notification dependent data structure, up to you to design between module and node_helper
	socketNotificationReceived: function(notification, payload) {
		Log.log(this.name + " received a socket notification: " + notification + " - Payload: " + payload);
		if(notification === "message_from_helper"){
			this.config.message = payload;
			// tell mirror runtime that our data has changed,
			// we will be called back at GetDom() to provide the updated content
			this.updateDom(1000)
		}

		if(notification === "have data"){

			Log.log(this.name + " received a socket notification: " + notification + " - Payload: " + payload);
			
			var now = moment()
			var active_birthdays={}

			for( var birthday of payload) {
				// get 1st 5 chars of birthdate, thru month
				// we will use this as the key in the hash
				var birth_date = birthday.birth.subString(0,4)
				
				// for debugging only
				Log.log("Tag.Monat :", birth_date)
				
				// get the birthday as a moment in this year, for comparing
				var birth_date_moment = moment(birth_date + now.getYear(),"DD.MMYYYY")

				// u can add days to a moment object and then compare 
				//     if the birthdate is before that date (and after now)
				//     so within the next xx days

				// if the date is the same or later, don't use time of day
				if(birth_date.startOf('day').isSame(now.startOf('day')){

					// birthday is in this month
					// check the hash if we've seen anything for today yet
					// if we haven't see this date yet
					if(active_birthdays[birth_date] == undefined){
           
						//  create the holder for its info (array of 
						//		names) in the hash
						active_birthdays[birth_date] = []
					}
					// save the persons name on the list
					active_birthdays[birth_date].push(birthday.name)
				}
			}
     
			// tell MM to call and get our content
			self.updateDom();
		}     			
},

sdetweil

@Perlchamp very good… now, I didn’t test the code I wrote, so there are a couple errors…

but you should be able to see that code in the developers window, sources tab,
navigate on the left tree, modules, your module_name (which has to be perchamp,
folder, filename and the register at the top) all have to match)

Perlchamp

i can’t find … so everything’s right ?

sdetweil

@Perlchamp you should Screenshot at 2020-05-01 18-12-15.png see an error like this

note that I put part of the module name in the filter field

Perlchamp

ok, thanks

sdetweil

@Perlchamp and if something not spelled right (this image also shows the module tree navigation on the left)

when its used !
Screenshot at 2020-05-01 18-17-05.png

Perlchamp

so, sam, everything is fixed :-)
but now i don’t know how to handle the receiving data. i only need a little entry … don’t know how to handle this object-element. actually nothing is displayed except the header i configured …

sdetweil

@Perlchamp cool, now you’ve collected the data… you should be able to see the results on the exit from the notification handler…

now to tell MM to come get the stuff to display…

thats the self.updateDom() call

hey MM, get my stuff

then MM will call getDom()

I have implemented the module too

getDom: function() {
		var wrapper = document.createElement("div");

		for(var birthday of Object.keys(this.active_birthdays)){
				for(var name of this.active_birthdays[birthday]){
					var m=document.createElement('div')
					m.innerText=birthday + ' '+ name
					wrapper.appendChild(m)
				}
		}

		// pass the created content back to MM to add to DOM.
		return wrapper;
	},

sdetweil

@Perlchamp one thing to watch out for, getDom() will be called immediately, long before you have any data,
but you MUST return something… so an empty div works… (this is where that 'Loading…" message would be presented

Perlchamp

black screen, again. this is my perlchamp.js:

Module.register("perlchamp", {

	defaults: {
		language: "de",
		dimmEntries: true   // true: dims entries and the associated 
							//       symbol when the date has expired.
							// false: delete entries and the associated 
							//        symbol when the date has expired.
	},

	init: function(){
		Log.log(this.name + " is in init!");
	},

	start: function(){
		Log.log("Starting module: " + this.name);

		// Set locale
		moment.locale(config.language);
	},

	loaded: function(callback) {
		Log.log(this.name + " is loaded!");
		callback();
	},

	// return list of other functional scripts to use, if any (like require in node_helper)
	getScripts: function() {
		return	["moment.js"];
	}, 

	// return list of stylesheet files to use if any
	getStyles: function() {
		return 	[this.data.path + "/css/perlchamp.css"];
	},

/*
	// return list of translation files to use, if any
	getTranslations: function() {
		return {
			// sample of list of files to specify here, if no files, do not use this routine, , or return empty list

			// en: "translations/en.json",  (folders and filenames in your module folder)
			// de: "translations/de.json"
		}
	},
*/


	// only called if the module header was configured in module config in config.js
	getHeader: function() {
		return this.data.header;
	},

	// messages received from other modules and the system (NOT from your node helper)
	// payload is a notification dependent data structure
	notificationReceived: function(notification, payload, sender) {
		// once everybody is loaded up
		if(notification==="ALL_MODULES_STARTED"){
			// send our config to our node_helper
			this.sendSocketNotification("CONFIG",this.config);
		}
		if (sender) {
			Log.log(this.name + " received a module notification: " + notification + " from sender: " + sender.name);
		} else {
			Log.log(this.name + " received a system notification: " + notification);
		}
	},

	
	// messages received from from your node helper (NOT other modules or the system)
	// payload is a notification dependent data structure, up to you to design between module and node_helper
	socketNotificationReceived: function(notification, payload) {
/*
		Log.log(this.name + " received a socket notification: " + notification + " - Payload: " + payload);
		if(notification === "message_from_helper"){
			this.config.message = payload;
			// tell mirror runtime that our data has changed,
			// we will be called back at GetDom() to provide the updated content
			this.updateDom(1000);
		}
*/
		if(notification === "have data"){

			Log.log(this.name + " received a socket notification: " + notification + " - Payload: " + payload);
			
			var now = moment();
			var active_birthdays = {};

			for(var birthday of payload) {
				// get 1st 5 chars of birthdate, thru month
				// we will use this as the key in the hash
				var birth_date = birthday.birth.subString(0,4);
				
				// get the birthday as a moment in this year, for comparing
				var birth_date_moment = moment(birth_date + now.getYear(),"DD.MMYYYY");

				// u can add days to a moment object and then compare 
				//     if the birthdate is before that date (and after now)
				//     so within the next xx days

				// if the date is the same or later, don't use time of day
				if(birth_date.startOf('day').isSame(now.startOf('day'))) {

					// birthday is in this month
					// check the hash if we've seen anything for today yet
					// if we haven't see this date yet
					if(active_birthdays[birth_date] == undefined){
           
						//  create the holder for its info (array of 
						//		names) in the hash
						active_birthdays[birth_date] = [];
					}
					// save the persons name on the list
					active_birthdays[birth_date].push(birthday.name);
				}
			}
     
			// tell MM to call and get our content
			self.updateDom();
		}     			
			
/*			
			this.config.message = payload;
			// tell mirror runtime that our data has changed,
			// we will be called back at GetDom() to provide the updated content
			this.updateDom(1000)
			
			// filters the birthdaylist and output only the birthdays
			// of the current month, sorted (ascending) by days in 
			// the following format: 
			// [{ day: "10", name: ["firstname lastname",...] }]

			// set variables
			var today_month = moment().format("MM");
			var today_day_month = moment().format("DD.MM");

			var result = Object.entries(jsonObj
			.filter(({birth}) => birth.split('.')[1] === today_month)
			.reduce((a, {birth, name}) => {
				const day = +birth.split('.')[0];
				a[day] = [...(a[day] || []), name];
				return a
			}, {})
			).map(([day, name]) => ({day, name})).sort((a, b) => +a.day - b.day);
			birthdaysArray = result;
			
			// for debugging only
			//console.log("filtered and sorted: ", birthdaysArray);
*/
			
	},

	// system notification your module is being hidden
	// typically you would stop doing UI updates (getDom/updateDom) if the module is hidden
	suspend: function(){

	},

	// system notification your module is being unhidden/shown
	// typically you would resume doing UI updates (getDom/updateDom) if the module is shown
	resume: function(){

	},

	// this is the major worker of the module, it provides the displayable content for this module
	getDom: function() {
		var wrapper = document.createElement("div");

		for(var birthday of Object.keys(this.active_birthdays)){
			for(var name of this.active_birthdays[birthday]){
				var m = document.createElement('div');
				m.innerText = birthday + ' '+ name;
				wrapper.appendChild(m);
			}
		}

		// pass the created content back to MM to add to DOM.
		return wrapper;
	}
})

this the node_helper.js:

var NodeHelper = require("node_helper");
var moment = require("moment");

// add require of other javascripot components here
// var xxx = require('yyy'); here
const csv = require("csvtojson");
var birthdaysArray = [];

module.exports = NodeHelper.create({

	init(){
		console.log("init module helper perlchamp");
	},

	start() {
		var self = this;
		console.log("Starting module helper: " + this.name);

		// convert the csv-file into a JSON-String
		const csvFilePath = this.path + '/data/birthdays.csv';
		csv()
		.fromFile(csvFilePath)
		.then((jsonObj)=>{      
			birthdaysArray = JSON.stringify(jsonObj);
			
			// for debugging only
			//console.log("birthdaysArray: ", birthdaysArray);
			
			// send data to [modulname].js
			self.sendSocketNotification("have data", jsonObj);
		})		
	},
	
	stop(){
		console.log("Stopping module helper: " + this.name);
	},

	// handle messages from our module// each notification indicates a different messages
	// payload is a data structure that is different per message.. up to you to design this
	socketNotificationReceived(notification, payload) {				
		// if config message from module
		if (notification === "CONFIG") {
			// save payload config info
			this.config = payload;
			// wait 15 seconds, send a message back to module
			setTimeout(()=> { this.sendSocketNotification("message_from_helper"," this is a test_message")}, 15000);
		}
		else if(notification === "????2") {
		}
	},
});

these are the terminal outputs:

dirk@raspberrypi:~/MagicMirror/modules/perlchamp $ npm start

> magicmirror@2.11.0 start /home/dirk/MagicMirror
> DISPLAY="${DISPLAY:=:0}" ./node_modules/.bin/electron js/electron.js

[2020-05-02 02:52:02.407] [LOG]    Starting MagicMirror: v2.11.0
[2020-05-02 02:52:02.414] [LOG]    Loading config ...
[2020-05-02 02:52:02.418] [LOG]    Loading module helpers ...
[2020-05-02 02:52:02.424] [LOG]    Initializing new module helper ...
[2020-05-02 02:52:02.425] [LOG]    Module helper loaded: MMM-Logging
[2020-05-02 02:52:02.579] [LOG]    init module helper perlchamp
[2020-05-02 02:52:02.580] [LOG]    Module helper loaded: perlchamp
[2020-05-02 02:52:02.580] [LOG]    All module helpers loaded.
[2020-05-02 02:52:02.711] [LOG]    Starting server on port 8080 ... 
[2020-05-02 02:52:02.718] [INFO]   You're using a full whitelist configuration to allow for all IPs
[2020-05-02 02:52:02.726] [LOG]    Server started ...
[2020-05-02 02:52:02.727] [LOG]    Connecting socket for: MMM-Logging
[2020-05-02 02:52:02.727] [LOG]    Module helper started for MMM-Logging
[2020-05-02 02:52:02.728] [LOG]    Connecting socket for: perlchamp
[2020-05-02 02:52:02.728] [LOG]    Starting module helper: perlchamp
[2020-05-02 02:52:02.732] [LOG]    Sockets connected & modules started ...
[2020-05-02 02:52:02.829] [LOG]    Launching application.
[2020-05-02 02:52:04.803] [LOG]    Starting module: perlchamp (/home/dirk/MagicMirror/modules/MMM-Logging/node_helper.js:34 Class.socketNotificationReceived)
[2020-05-02 02:52:04.805] [LOG]    All modules started! (/home/dirk/MagicMirror/modules/MMM-Logging/node_helper.js:37 Class.socketNotificationReceived)
[2020-05-02 02:52:04.806] [LOG]     payload: undefined (/home/dirk/MagicMirror/modules/MMM-Logging/node_helper.js:31 Class.socketNotificationReceived)
[2020-05-02 02:52:04.807] [LOG]    perlchamp received a system notification: ALL_MODULES_STARTED (/home/dirk/MagicMirror/modules/MMM-Logging/node_helper.js:34 Class.socketNotificationReceived)
[2020-05-02 02:52:04.810] [ERROR]  {} (/home/dirk/MagicMirror/modules/MMM-Logging/node_helper.js:43 Class.socketNotificationReceived)
[2020-05-02 02:52:04.811] [LOG]    Browser Error: {} (/home/dirk/MagicMirror/modules/MMM-Logging/node_helper.js:46 Class.socketNotificationReceived)
[2020-05-02 02:52:07.185] [LOG]    Shutting down server... (/home/dirk/MagicMirror/js/electron.js:105 App.<anonymous>)
[2020-05-02 02:52:07.188] [LOG]    Stopping module helper: MMM-Logging (/home/dirk/MagicMirror/js/node_helper.js:33 Class.stop)
[2020-05-02 02:52:07.190] [LOG]    Stopping module helper: perlchamp (/home/dirk/MagicMirror/modules/perlchamp/node_helper.js:39 Class.stop)
dirk@raspberrypi:~/MagicMirror/modules/perlchamp $

i didn’t never seen the notification “have data” …