Added desktop notifications and improved LightBurn upload

Author: 1RandomDev

main/app.js

@@ -1,4 +1,4 @@
-const { app, BrowserWindow, ipcMain } = require('electron/main');
+const { app, BrowserWindow, ipcMain, Notification } = require('electron/main');
 const path = require('node:path');
 const fs = require('node:fs');
 const discovery = require('./discovery.js');
@@ -12,6 +12,7 @@ let appSettings = {
     moveDistance: 10,
     laserSpotIntensity: 3,
     grblBridgeEnabled: true,
+    desktopNotifications: true,
 }
 const confDir = (process.env.APPDATA || (process.platform == 'darwin' ? process.env.HOME + '/Library/Preferences' : process.env.HOME + "/.local/share"))+'/xTool-Connect';
 if(!fs.existsSync(confDir)) {
@@ -21,11 +22,22 @@ const confFile = confDir+'/config.json';
 if(!fs.existsSync(confFile)) {
     fs.writeFileSync(confFile, '{}');
 } else {
-    appSettings = {...appSettings, ...JSON.parse(fs.readFileSync(confFile))};
+    Object.assign(appSettings, JSON.parse(fs.readFileSync(confFile)));
 }
 function saveSettings() {
     fs.writeFileSync(confFile, JSON.stringify(appSettings));
 }
+
+function desktopNotification(msg) {
+    if(!appSettings.desktopNotifications) return;
+    const template = {
+        title: 'xTool Connect',
+        icon: path.join(__dirname, '../icon.png'),
+    };
+    Object.assign(template, msg);
+    new Notification(template).show();
+}
+
 function createWindow() {
     const window = new BrowserWindow({
         width: 500,
@@ -81,10 +93,30 @@ app.whenReady().then(() => {
     ipcMain.handle('deviceMenu:connect', async () => {
         firstConnect = false;
         const result = await deviceController.connect(appSettings.deviceAddress, data => {
-            if(data == 'err:TIMEOUT') {
-                window.loadFile('../renderer/index.html', {
-                    query: {message: 'timeout'}
-                });
+            switch(data) {
+                case 'err:TIMEOUT':
+                    desktopNotification({body: 'Connection to device lost. Please check your internet connection and reconnect.'});
+                    window.loadFile('../renderer/index.html', {
+                        query: {message: 'timeout'}
+                    });
+                    grblBridge.stop();
+                    break;
+                case 'err:tiltCheck':
+                case 'err:movingCheck':
+                    desktopNotification({body: 'Movement detected!\nThe current job was aborted because the device was moved during operation.', urgency: 'critical'});
+                    break;
+                case 'err:flameCheck':
+                    desktopNotification({body: 'Flame detected!\nThe current job was aborted because a flame was detected. Please check the state of the device immediately.', urgency: 'critical'});
+                    break;
+                case 'err:limitCheck':
+                    desktopNotification({body: 'Limit reached!\nThe current job was aborted because a limit switch was activated.', urgency: 'critical'});
+                    break;
+                case 'grbl:complete':
+                    desktopNotification({body: 'LightBurn upload complete!\nou can now start the job by pressing the start button on the device.'});
+                    break;
+                case 'grbl:timeout':
+                    desktopNotification({body: 'LightBurn upload failed!\nFile could not be sent to the device.'});
+                    break;
             }
             window.webContents.send('websocket:message', data);
         });

main/device-controller.js

@@ -67,10 +67,9 @@ module.exports.connect = async (address, callback) => {
                 websocket.ping();
                 if(lastHeartbeat + 4100 < Date.now()) {
                     wsCallback('err:TIMEOUT');
-                    clearInterval(heartbeatTimer);
+                    console.log('Connection to device timed out.');
                     websocket.terminate();
-                    connected = false;
-                    console.log('Connection to current device timed out.');
+                    this.disconnect();
                 }
             }, 2000);
             console.log('Successfully connected to device '+deviceAddress);

renderer/assets/js/control.js

@@ -11,7 +11,7 @@ const currentStatus = document.getElementById('currentStatus');
 const currentProgress = document.getElementById('currentProgress');
 const currentProgressNum = document.getElementById('currentProgressNum');
 
-let progressUpdateTimer, laserSpotActive;
+let progressUpdateTimer, laserSpotActive, uploadNotification;
 
 disconnectBtn.addEventListener('click', () => {
     window.electronAPI.disconnectDevice();
@@ -81,20 +81,21 @@ stopBtn.addEventListener('click', () => {
     laserSpotIntensity.value = settings.laserSpotIntensity;
 
     window.electronAPI.onWebsocketMessage(data => {
-        if(data.startsWith('ok:WORKING_')) {
-            gcodeDropzone.classList.add('disabled');
-            disableMoveButtons(true);
-            pauseBtn.disabled = false;
-            stopBtn.disabled = false;
-            currentStatus.innerText = 'Working';
-            pauseBtn.innerText = 'Pause';
-            pauseBtn.value = 'pause';
-            if(!progressUpdateTimer) {
-                updateProgress();
-                progressUpdateTimer = setInterval(updateProgress, 5000);
-            }
-        }
         switch(data) {
+            case 'ok:WORKING_OFFLINE':
+            case 'ok:WORKING_FRAMING':
+                gcodeDropzone.classList.add('disabled');
+                disableMoveButtons(true);
+                pauseBtn.disabled = false;
+                stopBtn.disabled = false;
+                currentStatus.innerText = 'Working';
+                pauseBtn.innerText = 'Pause';
+                pauseBtn.value = 'pause';
+                if(!progressUpdateTimer) {
+                    updateProgress();
+                    progressUpdateTimer = setInterval(updateProgress, 5000);
+                }
+                break;
             case 'ok:IDLE':
                 gcodeDropzone.classList.remove('disabled');
                 disableMoveButtons(false);
@@ -132,12 +133,14 @@ stopBtn.addEventListener('click', () => {
                 toastr.error('The current job was aborted because a limit switch was activated.', 'Limit reached!', {timeOut: 8000});
                 break;
             case 'grbl:started':
-                toastr.success('Please wait until the file is received and the upload is complete.', 'Receiving data from LightBurn...');
+                uploadNotification = toastr.success('Please wait until the file is received and the upload is complete.', 'Receiving data from LightBurn...', {timeOut: 0});
                 break;
-                case 'grbl:complete':
+            case 'grbl:complete':
+                uploadNotification.remove();
                 toastr.success('You can now start the job by pressing the start button on the device.', 'LightBurn upload complete');
                 break;
             case 'grbl:timeout':
+                uploadNotification.remove();
                 toastr.success('File could not be sent to the device.', 'LightBurn upload failed');
                 break;
         }