-
-
Notifications
You must be signed in to change notification settings - Fork 6
/
MMM-ping.js
222 lines (205 loc) · 6.36 KB
/
MMM-ping.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
/**
* @file MMM-ping.js
*
* @author fewieden
* @license MIT
*
* @see https://github.com/fewieden/MMM-ping
*/
/* global Module Log */
/**
* @external Module
* @see https://github.com/MichMich/MagicMirror/blob/master/js/module.js
*/
/**
* @external Log
* @see https://github.com/MichMich/MagicMirror/blob/master/js/logger.js
*/
/**
* @module MMM-ping
* @description Frontend for the module to display data.
*
* @requires external:Module
* @requires external:Log
*/
Module.register('MMM-ping', {
/** @member {Object} status - List of results with hosts and their online status. */
status: [],
/** @member {Object} onlineMapping - Map online states to strings. */
onlineMapping: {
true: 'online',
false: 'offline'
},
/**
* @member {Object} defaults - Defines the default config values.
* @property {boolean} colored - Flag to render map in color or greyscale.
* @property {string} display - Online states which should be displayed.
* @property {string[]} hosts - List of hosts to ping.
* @property {int} updateInterval - Speed of update.
* @property {string} font - Class name for font size.
* @property {number} transitionTime - Time the transition for a new update in the DOM should take.
*/
defaults: {
colored: false,
display: 'both',
hosts: [],
updateInterval: 5,
font: 'medium',
transitionTime: 300
},
/**
* @member {Object} voice - Defines the voice recognition part.
* @property {string} mode - MMM-voice mode of this module.
* @property {string[]} sentences - All commands of this module.
*/
voice: {
mode: 'PING',
sentences: [
'OPEN HELP',
'CLOSE HELP',
'SHOW ALL Hosts',
'HIDE HOSTS'
]
},
/**
* @function getTranslations
* @description Translations for this module.
* @override
*
* @returns {Object.<string, string>} Available translations for this module (key: language code, value: filepath).
*/
getTranslations() {
return {
en: 'translations/en.json',
de: 'translations/de.json'
};
},
/**
* @function getStyles
* @description Style dependencies for this module.
* @override
*
* @returns {string[]} List of the style dependency filepaths.
*/
getStyles() {
return ['MMM-ping.css'];
},
/**
* @function getTemplate
* @description Nunjuck template.
* @override
*
* @returns {string} Path to nunjuck template.
*/
getTemplate() {
return 'templates/MMM-ping.njk';
},
/**
* @function getTemplateData
* @description Data that gets rendered in the nunjuck template.
* @override
*
* @returns {object} Data for the nunjuck template.
*/
getTemplateData() {
const status = this.status.filter(entry => this.config.display === 'both' || this.config.display === this.onlineMapping[entry.online]);
return {
config: this.config,
status
};
},
/**
* @function start
* @description Initiates ping interval.
* @override
*
* @returns {void}
*/
start() {
Log.info(`Starting module: ${this.name}`);
this.checkHosts();
setInterval(() => {
this.checkHosts();
}, this.config.updateInterval * 60000);
},
/**
* @function checkHosts
* @description Sends a notification to node_helper to ping hosts again.
* @override
*
* @returns {void}
*/
checkHosts() {
this.sendSocketNotification('CHECK_HOSTS', this.config.hosts);
},
/**
* @function socketNotificationReceived
* @description Handles incoming messages from node_helper.
* @override
*
* @param {string} notification - Notification name
* @param {*} payload - Detailed payload of the notification.
*/
socketNotificationReceived(notification, payload) {
if (notification === 'STATUS_UPDATE') {
this.status = payload;
this.updateDom(this.config.transitionTime);
}
},
/**
* @function notificationReceived
* @description Handles incoming broadcasts from other modules or the MagicMirror core.
* @override
*
* @param {string} notification - Notification name
* @param {*} payload - Detailed payload of the notification.
* @param {MM} [sender] - The sender of the notification. If sender is undefined the sender is the core.
*/
notificationReceived(notification, payload, sender) {
if (notification === 'ALL_MODULES_STARTED') {
this.sendNotification('REGISTER_VOICE_MODULE', this.voice);
} else if (notification === 'VOICE_PING' && sender.name === 'MMM-voice') {
this.checkCommands(payload);
} else if (notification === 'VOICE_MODE_CHANGED' && sender.name === 'MMM-voice' && payload.old === this.voice.mode) {
this.sendNotification('CLOSE_MODAL');
}
},
/**
* @function checkCommands
* @description Checks for voice commands.
*
* @param {string} data - Text with commands.
*
* @returns {void}
*/
checkCommands(data) {
if (/(HELP)/g.test(data)) {
if (/(CLOSE)/g.test(data) && !/(OPEN)/g.test(data)) {
this.sendNotification('CLOSE_MODAL');
} else if (/(OPEN)/g.test(data) && !/(CLOSE)/g.test(data)) {
this.sendNotification('OPEN_MODAL', {
template: 'templates/HelpModal.njk',
data: {
...this.voice,
fns: {
translate: this.translate.bind(this)
}
}
});
}
} else if (/(HIDE)/g.test(data) && /(HOSTS)/g.test(data)) {
this.sendNotification('CLOSE_MODAL');
} else if (/(SHOW)/g.test(data) && /(HOSTS)/g.test(data)) {
this.sendNotification('OPEN_MODAL', {
template: 'templates/PingModal.njk',
data: {
config: this.config,
status: this.status,
fns: {
translate: this.translate.bind(this)
}
}
});
}
}
});