-
Notifications
You must be signed in to change notification settings - Fork 4
/
utils.js
282 lines (253 loc) · 9.35 KB
/
utils.js
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
//utils.js - Utility functions for CellarWarden.
var fs = require( 'fs' );
//var act = require('./actuators.js');
//var display1 = require('./display.js');
//var io =
var writeLogFile = false;
var fileName = './server.log';
//mergeJsonProto: merges two JSON/node objects into one, preserving structure defined in prototype.
// protoObject - prototype object, contains desired object structure.
// updObject - object to update the prototype with.
// returns - merged JSON object that follows the structure of the protoObject.
exports.mergeJsonProto = function( protoObject, updObject) {
return Object.assign( protoObject, updObject );
};
//readFromJsonFile: reads from JSON file asynchronously.
// Returns parsed JSON object or error in callback.
exports.readFromJsonFile = function( fileName, callback ) {
var obj = [];
fs.readFile( fileName, 'utf8', function(err, data) {
if (err) {
console.log( err );
return callback( err, null );
} else {
obj = JSON.parse( data );
//console.log( 'obj.length=' + obj.length );
//console.log( 'obj[0].param1=' + obj[0].param1 );
return callback( err, obj );
};
});
};
//writeToJsonFile: Writes JSON object to file.
// Writes JSON object (ctrlObj) to fileName. Returns error or null.
exports.writeToJsonFile = function( ctrlObj, fileName, callback ) {
fs.writeFile( fileName, JSON.stringify( ctrlObj ), function( err ) {
if (err) {
console.log( 'Error writing to controllers file ' + fileName + '. Error: ' + err );
return callback( err, null );
} else {
return callback( null, null );
};
});
};
//Time functions.
//Generate Date - time string for display and logging
exports.getDateTime = function() {
var date = new Date();
var hour = date.getHours();
hour = (hour < 10 ? "0" : "") + hour;
var min = date.getMinutes();
min = (min < 10 ? "0" : "") + min;
var sec = date.getSeconds();
sec = (sec < 10 ? "0" : "") + sec;
var year = date.getFullYear();
var month = date.getMonth() + 1;
month = (month < 10 ? "0" : "") + month;
var day = date.getDate();
day = (day < 10 ? "0" : "") + day;
return year + "-" + month + "-" + day + " " + hour + ":" + min + ":" + sec;
};
//millisElapsed(). Milliseconds elapsed from time1 to time2
exports.millisElapsed = function( time1, time2 ) {
var timeN1 = Date.parse( time1 );
var timeN2 = Date.parse( time2 );
var retVal = parseInt(time2 - time1);
return retVal;
};
//secondsElapsed(). Seconds elapsed from time1 to time2
exports.secondsElapsed = function( time1, time2 ) {
var timeN1 = Date.parse( time1 );
var timeN2 = Date.parse( time2 );
var retVal = parseInt((time2 - time1) / 1000);
return retVal;
};
//secondsElapsedFloat(). Seconds elapsed from time1 to time2 with floating point
exports.secondsElapsedFloat = function( time1, time2 ) {
var timeN1 = Date.parse( time1 );
var timeN2 = Date.parse( time2 );
var retVal = (time2 - time1) / 1000;
return retVal;
};
//minutesElapsed(). Minutes elapsed from time1 to time2
exports.minutesElapsed = function( time1, time2 ) {
var timeN1 = Date.parse( time1 );
var timeN2 = Date.parse( time2 );
var retVal = parseInt((timeN2 - timeN1) / 60000);
return retVal;
};
//minutesElapsedFloat(). Minutes elapsed from time1 to time2 with floating point
exports.minutesElapsedFloat = function( time1, time2 ) {
var timeN1 = Date.parse( time1 );
var timeN2 = Date.parse( time2 );
var retVal = (timeN2 - timeN1) / 60000;
return retVal;
};
//hoursElapsed(). Hours elapsed from time1 to time2.
exports.hoursElapsed = function( time1, time2 ) {
var timeN1 = Date.parse( time1 );
var timeN2 = Date.parse( time2 );
var retVal = parseInt((timeN2 - timeN1) / 3600000);
return retVal;
};
//hoursElapsedFloat(). hours elapsed from time1 to time2 with floating point.
exports.hoursElapsedFloat = function( time1, time2 ) {
var timeN1 = Date.parse( time1 );
var timeN2 = Date.parse( time2 );
var retVal = (timeN2 - timeN1) / 3600000;
return retVal;
};
//daysElapsed(). Days elapsed from time1 to time2.
exports.daysElapsed = function( time1, time2 ) {
var timeN1 = Date.parse( time1 );
var timeN2 = Date.parse( time2 );
var retVal = parseInt((timeN2 - timeN1) / 86400000);
return retVal;
};
//daysElapsedFloat(). Days elapsed from time1 to time2 with floating point.
exports.daysElapsedFloat = function( time1, time2 ) {
var timeN1 = Date.parse( time1 );
var timeN2 = Date.parse( time2 );
var retVal = (timeN2 - timeN1) / 86400000;
return retVal;
};
//Misc. functions.
//log() - make a nicer console.log.
// text - text to print
// color - color string
// timestamp - true or false if we want to add a timestamp
// emit - emit a socket to send this message to client?
exports.log = function( text, color, timestamp, emit ) {
var now1 = new Date();
var sendText = ( timestamp ) ? now1 + ': ' + text : text;
var sendHtml = sendText;
var sendPlain = sendText;
switch ( color ) {
case "yellow":
sendText = '\x1b[33m' + sendText + '\x1b[37m';
sendHtml = '<span style="color: yellow">' + sendHtml + '</span>';
break;
case "green":
sendText = '\x1b[32m' + sendText + '\x1b[37m';
sendHtml = '<span style="color: green">' + sendHtml + '</span>';
break;
case "red":
sendText = '\x1b[31m' + sendText + '\x1b[37m';
sendHtml = '<span style="color: red">' + sendHtml + '</span>';
break;
case "blue":
sendText = '\x1b[34m' + sendText + '\x1b[37m';
sendHtml = '<span style="color: blue">' + sendHtml + '</span>';
break;
case "magenta":
sendText = '\x1b[35m' + sendText + '\x1b[37m';
sendHtml = '<span style="color: magenta">' + sendHtml + '</span>';
break;
case "cyan":
sendText = '\x1b[36m' + sendText + '\x1b[37m';
sendHtml = '<span style="color: cyan">' + sendHtml + '</span>';
break;
case "white":
sendText = '\x1b[37m' + sendText + '\x1b[37m';
sendHtml = '<span style="color: white">' + sendHtml + '</span>';
break;
case "black":
sendText = '\x1b[37m' + sendText + '\x1b[37m';
sendHtml = '<span style="color: black">' + sendHtml + '</span>';
break;
case "inverted":
sendText = '\x1b[7m' + sendText + '\x1b[37m';
sendHtml = sendHtml;
break;
case "blink":
sendText = '\x1b[5m' + sendText + '\x1b[37m';
sendHtml = sendHtml;
break;
case "default":
sendText = '\x1b[37m' + sendText + '\x1b[37m';
sendHtml = '<span style="color: white">' + sendHtml + '</span>';
};
//console.log( sendText );
console.log( sendPlain );
sendHtml = sendHtml + '<br>';
if ( writeLogFile == true ) {
fs.appendFile( fileName, sendHtml, encoding='utf8', function (err) {
if (err) {
this.log( 'Unable to write to ' + fileName + '. ERROR: ' + err, 'red', true, false );
console.log( 'Unable to write to ' + fileName + '. ERROR: ' + err );
console.error( 'Unable to write to ' + fileName + '. ERROR: ' + err );
};
});
};
/*
//Add logic here to send socket to client(s).
if ( emit ) {
//Package data into object to send via websockets
var logMsg = {
text: text,
color: color,
timestamp: timestamp
};
//Emit logMsg via websockets
socket.emit( 'logMessage', logMsg );
};
*/
};
//File functions.
//fileExists() - checks for existence of file.
// filename - name of file (including path)
// returns - true (file exists) or false (file does not exist)
exports.fileExists = function( filename ) {
var retVal = false;
try {
fs.accessSync( filename, fs.F_OK );
retVal = true;
} catch (e) {
retVal = false;
};
return retVal;
};
//deleteFile() - deletes files
exports.deleteFile = function( fileName, callback ) {
console.log( 'Deleting file ' + fileName + '...');
fs.unlink( fileName, function( err ) {
if ( err ) {
console.log( 'Unable to delete file ' + fileName + '. ERROR: ' + err );
return callback( err );
} else {
console.log( 'File ' + fileName + ' deleted successfully.' );
return callback( null );
};
});
};
// Numerical functions
//minMax() - returns a number within a range between min and max
// value - number
// min - minimum value to return
// max - maximum value to return
// returns - number within range
exports.minMax = function( value, min, max ) {
var retVal = value;
if ( value > max ) retVal = max;
if ( value < min ) retVal = min;
return retVal;
};
//rollAvg() - Calculate rolling average. Provide the average and the new sample.
// avg = previous average
// newSample = new sample value
// rollWindow = number of samples to average over
// returns new average
function rollAvg( avg, newSample, rollWindow ) {
avg -= avg / rollWindow;
avg += newSample / rollWindow;
return avg;
};