From 6efc127917b03d6aa530ec2e1cea5f5b3e1ee4dd Mon Sep 17 00:00:00 2001 From: Peter Prince Date: Mon, 13 Nov 2023 13:39:13 +0000 Subject: [PATCH] Add 1.10.0 changes --- about.html | 2 +- about.js | 9 +- ariaSpeak.js | 32 ++ builder.js | 7 +- constants.js | 19 + index.css | 25 +- index.html | 800 ++++++++++++++++++++++++++++++++--- lifeDisplay.js | 47 +- main.js | 788 ++++++++++++++++++++++++---------- nightMode.js | 8 +- package.json | 43 +- packetReader.js | 33 +- processing/downsampling.html | 232 ++++++---- processing/expansion.html | 447 +++++++++++-------- processing/split.html | 270 +++++++----- processing/summarise.html | 92 ++++ processing/uiDownsampling.js | 19 +- processing/uiExpansion.js | 21 +- processing/uiInput.js | 171 ++++++++ processing/uiOutput.js | 89 +--- processing/uiSplit.js | 19 +- processing/uiSummarise.js | 232 ++++++++++ saveLoad.js | 207 +++++---- schedule/dateInput.js | 59 +-- schedule/schedule.js | 44 +- schedule/scheduleEditor.js | 181 +++++--- schedule/timeInput.js | 38 +- schedule/uiSchedule.js | 50 +-- schedule/uiScheduleEditor.js | 78 ++-- scheduleBar.js | 102 ++--- settings/durationInput.js | 34 +- settings/sliderControl.js | 2 +- settings/uiAdvanced.js | 5 +- settings/uiFiltering.js | 49 ++- settings/uiSettings.js | 11 +- timeHandler.js | 269 ++++-------- timeZoneSelection.html | 60 +++ ubuntu.mono.ttf | Bin 0 -> 205748 bytes ui.css | 6 + ui.js | 125 +++--- uiIndex.js | 299 +++++++------ uiNight.css | 19 +- uiTimeZoneSelection.js | 479 +++++++++++++++++++++ versionChecker.js | 35 +- 44 files changed, 3965 insertions(+), 1592 deletions(-) create mode 100644 ariaSpeak.js create mode 100644 processing/summarise.html create mode 100644 processing/uiInput.js create mode 100644 processing/uiSummarise.js create mode 100644 timeZoneSelection.html create mode 100644 ubuntu.mono.ttf create mode 100644 uiTimeZoneSelection.js diff --git a/about.html b/about.html index fc6bedb..8253987 100644 --- a/about.html +++ b/about.html @@ -29,7 +29,7 @@
- www.openacousticdevices.info + www.openacousticdevices.info
diff --git a/about.js b/about.js index 94c1f64..6a31267 100644 --- a/about.js +++ b/about.js @@ -9,17 +9,18 @@ /* global document */ const electron = require('electron'); +const {app, process} = require('@electron/remote'); const audiomoth = require('audiomoth-hid'); const nightMode = require('./nightMode.js'); const versionDisplay = document.getElementById('version-display'); const electronVersionDisplay = document.getElementById('electron-version-display'); -const audiomothHidVersionDisplay = document.getElementById('audiomoth-hid-version-display'); const websiteLink = document.getElementById('website-link'); +const audiomothHidVersionDisplay = document.getElementById('audiomoth-hid-version-display'); -versionDisplay.textContent = 'Version ' + electron.remote.app.getVersion(); -electronVersionDisplay.textContent = 'Running on Electron version ' + electron.remote.process.versions.electron; +versionDisplay.textContent = 'Version ' + app.getVersion(); +electronVersionDisplay.textContent = 'Running on Electron version ' + process.versions.electron; audiomothHidVersionDisplay.textContent = 'AudioMoth-HID module ' + audiomoth.version; electron.ipcRenderer.on('night-mode', (e, nm) => { @@ -36,7 +37,7 @@ electron.ipcRenderer.on('night-mode', (e, nm) => { }); -websiteLink.addEventListener('click', function () { +websiteLink.addEventListener('click', () => { electron.shell.openExternal('https://openacousticdevices.info'); diff --git a/ariaSpeak.js b/ariaSpeak.js new file mode 100644 index 0000000..646442a --- /dev/null +++ b/ariaSpeak.js @@ -0,0 +1,32 @@ +/**************************************************************************** + * ariaSpeak.js + * openacousticdevices.info + * May 2023 + *****************************************************************************/ + +/** + * Say something if user is using a screen reader + * @param {string} text Text which should be said if viewed on a screen reader + */ +exports.speak = (text) => { + + const element = document.createElement('div'); + const id = 'speak-' + Date.now(); + element.setAttribute('id', id); + element.setAttribute('aria-live', 'polite'); + element.classList.add('visually-hidden'); + document.body.appendChild(element); + + window.setTimeout(() => { + + document.getElementById(id).innerHTML = text; + + }, 100); + + window.setTimeout(() => { + + document.body.removeChild(document.getElementById(id)); + + }, 1000); + +}; diff --git a/builder.js b/builder.js index d5b7d09..9e0b7d4 100755 --- a/builder.js +++ b/builder.js @@ -1,12 +1,11 @@ - 'use strict'; const builder = require('electron-builder'); const Platform = builder.Platform; -var config, target, argTarget; +let config, target; -argTarget = process.argv[2]; +const argTarget = process.argv[2]; switch (argTarget) { @@ -55,7 +54,7 @@ default: builder.build({ targets: target, - config: config + config }).then(function (m) { console.log('Generated files:'); diff --git a/constants.js b/constants.js index 7e6b1fc..fc613c1 100644 --- a/constants.js +++ b/constants.js @@ -198,3 +198,22 @@ exports.getFirmwareClassification = (desc) => { exports.latestFirmwareVersionArray = [1, 8, 0]; exports.latestFirmwareVersionString = '1.8.0'; + +/* Time zone modes */ + +exports.TIME_ZONE_MODE_UTC = 0; +exports.TIME_ZONE_MODE_LOCAL = 1; +exports.TIME_ZONE_MODE_CUSTOM = 2; +exports.TIME_ZONE_MODE_STRINGS = ['UTC', 'LOCAL', 'CUSTOM']; + +/* Calculation values */ + +exports.UINT32_MAX = 0xFFFFFFFF; +exports.UINT16_MAX = 0xFFFF; + +exports.MILLISECONDS_IN_SECOND = 1000; + +exports.SECONDS_IN_MINUTE = 60; +exports.SECONDS_IN_DAY = 86400; + +exports.MINUTES_IN_HOUR = 60; \ No newline at end of file diff --git a/index.css b/index.css index c9183c5..7308ace 100644 --- a/index.css +++ b/index.css @@ -1,3 +1,8 @@ +@font-face { + font-family: 'Ubuntu'; + src: url('./ubuntu.mono.ttf'); +} + input[type=number]::-webkit-inner-spin-button, input[type=number]::-webkit-outer-spin-button { -webkit-appearance: none; @@ -13,6 +18,7 @@ input[type=number]::-webkit-outer-spin-button { .table>tbody>tr>td, .table>tbody>tr>th { + border-color: transparent; border-top: none; } @@ -21,11 +27,12 @@ input[type=number]::-webkit-outer-spin-button { } .grey { - color:#808080; + color: #D3D3D3; } .mono-text { - font-variant-numeric: tabular-nums; + font-family: 'Ubuntu'; + font-size: 27px; } input { @@ -35,3 +42,17 @@ input { span { font-variant-numeric: tabular-nums; } + +.groupBorder { + border: #cdcdcd thin solid; + padding: 5px; +} + +.leftElement { + margin-left: 16px; +} + +.rightElement { + margin-right: 16px; + text-align: right; +} diff --git a/index.html b/index.html index 544932f..7d152f5 100644 --- a/index.html +++ b/index.html @@ -9,105 +9,794 @@ -
+
-
-
-
- -
-
- -
+
+
+ +
--:--:-- --/--/----
+
UTC
+
-
-
-
-
- Device ID: -
-
- - -
-
-
-
- Firmware description: -
-
- - -
-
-
-
- Firmware version: +
+ +
+ +
+ +
+
+ Device ID: +
+
+ - +
-
- - + +
+
+ Firmware description: +
+
+ - +
-
-
-
- Battery: + +
+
+ Firmware version: +
+
+ - +
-
- - + +
+
+ Battery: +
+
+ - +
+
+
+
-
-
    +
    + +
    -
    +
    -
    -
    +
    + + + +
    +
    +
    +
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    +
    +
    + +
    +
    + +
    +
    + +
    +
    + +
    +
    + Sleep duration (s): +
    +
    +
    + +
    +
    +
    + +
    +
    + Recording duration (s): +
    +
    +
    + +
    +
    +
    +
    + +
    +
    +
    + +
    +
    + +
    +
    + +
    +
    + +
    +
    + +
    +
    + +
    +
    + +
    +
    + +
    +
    +
    +
    -
    + +
    +
    +
    + +
    + +
    +
    + + + +
    +
    + +
    +
    +
    Start recording:
    +
    +
    + +
    +
    +
    +
    +
    End recording:
    +
    +
    + +
    +
    +
    +
    +
    + + +
    +
    +
    + +
    + + +
    +
    +
    + +
    +
    +
    + + +
    +
    + First recording date (UTC): +
    +
    + +
    +
    + +
    +
    + + +
    +
    + Last recording date (UTC): +
    +
    + +
    +
    +
    + +
    -
    + +
    +
    +
    + + + +
    +
    +
    + + + + + + + + + + + + + + + + + + + + + + + + +
    +
    +
    + +
    +
    +
    + + + +
    +
    +
    + +
    +
    +
    + + + + + + + + + + + + + + + + + + + + + + + + +
    +
    +
    + + +
    +
    + 0kHz +
    +
    + +
    +
    + 24kHz +
    +
    + + + + + + + + + + +
    +
    + +
    +
    + +
    +
    +
    + +
    +
    +
    + + + +
    + +
    +
    +
    + + + + + + + + + + + + + + + + + + + + + + + + +
    +
    +
    + +
    +
    + 0.001% +
    +
    + +
    +
    + 100% +
    +
    + +
    + + + +
    + +
    +
    +
    + + + + + + + + + + + + + + + + + + + + + + + + +
    +
    +
    + +
    +
    + 0kHz +
    +
    + +
    +
    + 24kHz +
    +
    + + + +
    +
    + +
    +
    + +
    +
    +
    + + + + + + + + + + + + + + + + + + + + + + + + +
    +
    +
    + +
    +
    + 0.001% +
    +
    + +
    +
    + 100% +
    +
    + +
    + + + +
    +
    + +
    +
    + +
    +
    +
    +
    -
    + +
    +
    +
    + +
    +
    + +
    +
    + +
    +
    + +
    +
    + +
    +
    + +
    + +
    + +
    +
    + +
    +
    + +
    +
    + +
    +
    + +
    +
    + +
    +
    + +
    +
    + +
    +
    + +
    +
    + +
    +
    + +
    +
    + +
    +
    +
    + +
    +
    +
    + +
    +
    + +
    +
    +
    +
    + +
    +
    + +
    +
    +
    + +
    -
    +
    -
    +
    @@ -129,13 +818,6 @@
    - diff --git a/lifeDisplay.js b/lifeDisplay.js index 1dc506e..d4edb6b 100644 --- a/lifeDisplay.js +++ b/lifeDisplay.js @@ -18,7 +18,7 @@ const lifeDisplayPanel = document.getElementById('life-display-panel'); /* Whether or not the life display box should display the warning or original information */ -var displaySizeWarning = true; +let displaySizeWarning = true; exports.getPanel = () => { @@ -40,7 +40,26 @@ function getDailyCounts (timePeriods, recSecs, sleepSecs) { for (let i = 0; i < timePeriods.length; i += 1) { - let periodSecs = (timePeriods[i].endMins - timePeriods[i].startMins) * 60; + const startMins = timePeriods[i].startMins; + const endMins = timePeriods[i].endMins; + + let periodSecs = 0; + + if (startMins < endMins) { + + periodSecs = endMins - startMins; + + } else if (startMins === endMins) { + + periodSecs = 1440; + + } else if (startMins > endMins) { + + periodSecs = (1440 - startMins) + endMins; + + } + + periodSecs *= constants.SECONDS_IN_MINUTE; /* First recording in a period has prep time scheduled for just before period */ @@ -104,9 +123,9 @@ function getDailyCounts (timePeriods, recSecs, sleepSecs) { return { prepTime: totalPrepTime, - recordingTimes: recordingTimes, + recordingTimes, sleepTime: totalSleepTime, - containsTruncatedRecording: containsTruncatedRecording + containsTruncatedRecording }; } @@ -215,8 +234,24 @@ exports.updateLifeDisplay = (schedule, configuration, recLength, sleepLength, am for (let i = 0; i < schedule.length; i++) { - const period = schedule[i]; - const length = period.endMins - period.startMins; + const startMins = schedule[i].startMins; + const endMins = schedule[i].endMins; + + let length; + + if (startMins < endMins) { + + length = endMins - startMins; + + } else if (startMins === endMins) { + + length = 1440; + + } else if (startMins > endMins) { + + length = (1440 - startMins) + endMins; + + } preparationInstances += 1; diff --git a/main.js b/main.js index cf194ac..5cfa5ae 100644 --- a/main.js +++ b/main.js @@ -6,19 +6,13 @@ 'use strict'; -const electron = require('electron'); +const {app, Menu, shell, ipcMain, BrowserWindow} = require('electron'); -const app = electron.app; - -const Menu = electron.Menu; - -const shell = electron.shell; - -const ipcMain = electron.ipcMain; +require('@electron/remote/main').initialize(); const path = require('path'); -const BrowserWindow = electron.BrowserWindow; +const constants = require('./constants.js'); const ProgressBar = require('electron-progressbar'); @@ -27,54 +21,111 @@ require('electron-debug')({ devToolsMode: 'undocked' }); -var mainWindow, aboutWindow, expansionWindow, splitWindow, downsampleWindow; +let mainWindow, aboutWindow, expansionWindow, splitWindow, downsampleWindow, summariseWindow, timeZoneSelectionWindow; + +const iconLocation = (process.platform === 'linux') ? '/build/icon.png' : '/build/icon.ico'; +const standardWindowSettings = { + resizable: false, + fullscreenable: false, + autoHideMenuBar: true, + icon: path.join(__dirname, iconLocation), + useContentSize: true, + webPreferences: { + enableRemoteModule: true, + nodeIntegration: true, + contextIsolation: false + } +}; -var expandProgressBar, splitProgressBar, downsampleProgressBar; +let expandProgressBar, splitProgressBar, downsampleProgressBar, summariseProgressBar; -function shrinkWindowHeight (windowHeight) { +const standardProgressBarSettings = { + closeOnComplete: false, + indeterminate: false +}; - if (process.platform === 'darwin') { +let timeZoneMode = constants.TIME_ZONE_MODE_UTC; - windowHeight -= 20; +let customTimeZone = 0; - } else if (process.platform === 'linux') { +/* Generate settings objects for windows and progress bars */ - windowHeight -= 20; +function generateSettings (width, height, title) { - } + const uniqueSettings = { + width, + height, + title + }; + + const settings = Object.assign({}, standardWindowSettings, uniqueSettings); + settings.parent = mainWindow; + + return settings; + +} + +function generateProgressBarSettings (title, text, detail, fileCount, parent) { + + const uniqueSettings = { + title, + text, + detail, + maxValue: fileCount * 100 + }; + + const settings = Object.assign({}, standardProgressBarSettings, uniqueSettings); + + settings.browserWindow = { + parent, + webPreferences: { + enableRemoteModule: true, + nodeIntegration: true, + contextIsolation: false + }, + closable: true, + modal: false + }; - return windowHeight; + return settings; } +/* Open subwindows */ + function openSplitWindow () { if (splitWindow) { + splitWindow.show(); return; } - const iconLocation = (process.platform === 'linux') ? '/build/icon.png' : '/build/icon.ico'; + let windowWidth = 565; + let windowHeight = 430; - splitWindow = new BrowserWindow({ - width: 565, - height: shrinkWindowHeight(468), - title: 'Split AudioMoth WAV Files', - useContentSize: true, - resizable: false, - fullscreenable: false, - icon: path.join(__dirname, iconLocation), - parent: mainWindow, - webPreferences: { - nodeIntegration: true - } - }); + if (process.platform === 'linux') { + + windowWidth = 560; + windowHeight = 428; + + } else if (process.platform === 'darwin') { + + windowWidth = 560; + windowHeight = 428; + + } + + const settings = generateSettings(windowWidth, windowHeight, 'Split AudioMoth WAV Files'); + splitWindow = new BrowserWindow(settings); splitWindow.setMenu(null); splitWindow.loadURL(path.join('file://', __dirname, 'processing/split.html')); - splitWindow.webContents.on('dom-ready', function () { + require('@electron/remote/main').enable(splitWindow.webContents); + + splitWindow.webContents.on('dom-ready', () => { mainWindow.webContents.send('poll-night-mode'); @@ -90,15 +141,17 @@ function openSplitWindow () { }); - splitWindow.on('close', function (e) { + splitWindow.on('close', (e) => { + + e.preventDefault(); if (splitProgressBar) { - e.preventDefault(); + return; } - splitWindow = null; + splitWindow.hide(); }); @@ -108,30 +161,35 @@ function openExpansionWindow () { if (expansionWindow) { + expansionWindow.show(); return; } - const iconLocation = (process.platform === 'linux') ? '/build/icon.png' : '/build/icon.ico'; + let windowWidth = 565; + let windowHeight = 615; - expansionWindow = new BrowserWindow({ - width: 565, - height: shrinkWindowHeight(643), - title: 'Expand AudioMoth T.WAV Files', - useContentSize: true, - resizable: false, - fullscreenable: false, - icon: path.join(__dirname, iconLocation), - parent: mainWindow, - webPreferences: { - nodeIntegration: true - } - }); + if (process.platform === 'linux') { + + windowWidth = 560; + windowHeight = 615; + + } else if (process.platform === 'darwin') { + + windowWidth = 560; + windowHeight = 615; + + } + + const settings = generateSettings(windowWidth, windowHeight, 'Expand AudioMoth T.WAV Files'); + expansionWindow = new BrowserWindow(settings); expansionWindow.setMenu(null); expansionWindow.loadURL(path.join('file://', __dirname, 'processing/expansion.html')); - expansionWindow.webContents.on('dom-ready', function () { + require('@electron/remote/main').enable(expansionWindow.webContents); + + expansionWindow.webContents.on('dom-ready', () => { mainWindow.webContents.send('poll-night-mode'); @@ -147,15 +205,17 @@ function openExpansionWindow () { }); - expansionWindow.on('close', function (e) { + expansionWindow.on('close', (e) => { + + e.preventDefault(); if (expandProgressBar) { - e.preventDefault(); + return; } - expansionWindow = null; + expansionWindow.hide(); }); @@ -165,30 +225,35 @@ function openDownsamplingWindow () { if (downsampleWindow) { + downsampleWindow.show(); return; } - const iconLocation = (process.platform === 'linux') ? '/build/icon.png' : '/build/icon.ico'; + let windowWidth = 565; + let windowHeight = 428; - downsampleWindow = new BrowserWindow({ - width: 565, - height: shrinkWindowHeight(448), - title: 'Downsample AudioMoth WAV Files', - useContentSize: true, - resizable: false, - fullscreenable: false, - icon: path.join(__dirname, iconLocation), - parent: mainWindow, - webPreferences: { - nodeIntegration: true - } - }); + if (process.platform === 'linux') { + + windowWidth = 560; + windowHeight = 428; + + } else if (process.platform === 'darwin') { + + windowWidth = 560; + windowHeight = 428; + + } + + const settings = generateSettings(windowWidth, windowHeight, 'Downsample AudioMoth WAV Files'); + downsampleWindow = new BrowserWindow(settings); downsampleWindow.setMenu(null); downsampleWindow.loadURL(path.join('file://', __dirname, 'processing/downsampling.html')); - downsampleWindow.webContents.on('dom-ready', function () { + require('@electron/remote/main').enable(downsampleWindow.webContents); + + downsampleWindow.webContents.on('dom-ready', () => { mainWindow.webContents.send('poll-night-mode'); @@ -204,53 +269,127 @@ function openDownsamplingWindow () { }); - downsampleWindow.on('close', function (e) { + downsampleWindow.on('close', (e) => { + + e.preventDefault(); if (downsampleProgressBar) { - e.preventDefault(); + return; } - downsampleWindow = null; + downsampleWindow.hide(); }); } -function openAboutWindow () { +function openSummariseWindow () { - if (aboutWindow) { + if (summariseWindow) { + summariseWindow.show(); return; } - const iconLocation = (process.platform === 'linux') ? '/build/icon.png' : '/build/icon.ico'; + let windowWidth = 565; + let windowHeight = 235; + + if (process.platform === 'linux') { + + windowWidth = 560; + windowHeight = 235; + + } else if (process.platform === 'darwin') { + + windowWidth = 560; + windowHeight = 235; + + } + + const settings = generateSettings(windowWidth, windowHeight, 'Summarise AudioMoth Files'); + summariseWindow = new BrowserWindow(settings); + + summariseWindow.setMenu(null); + summariseWindow.loadURL(path.join('file://', __dirname, 'processing/summarise.html')); + + require('@electron/remote/main').enable(summariseWindow.webContents); + + summariseWindow.webContents.on('dom-ready', () => { + + mainWindow.webContents.send('poll-night-mode'); + + }); + + ipcMain.on('night-mode-poll-reply', (e, nightMode) => { + + if (summariseWindow) { + + summariseWindow.webContents.send('night-mode', nightMode); + + } + + }); + + summariseWindow.on('close', (e) => { + + e.preventDefault(); + + if (summariseProgressBar) { + + return; - aboutWindow = new BrowserWindow({ - width: 400, - height: shrinkWindowHeight(340), - title: 'About', - resizable: false, - fullscreenable: false, - icon: path.join(__dirname, iconLocation), - parent: mainWindow, - webPreferences: { - nodeIntegration: true } + + summariseWindow.hide(); + }); +} + +function openAboutWindow () { + + if (aboutWindow) { + + aboutWindow.show(); + return; + + } + + let windowWidth = 400; + let windowHeight = 310; + + if (process.platform === 'linux') { + + windowWidth = 395; + windowHeight = 310; + + } else if (process.platform === 'darwin') { + + windowWidth = 395; + windowHeight = 310; + + } + + const settings = generateSettings(windowWidth, windowHeight, 'About'); + aboutWindow = new BrowserWindow(settings); + aboutWindow.setMenu(null); aboutWindow.loadURL(path.join('file://', __dirname, '/about.html')); - aboutWindow.on('close', function () { + require('@electron/remote/main').enable(aboutWindow.webContents); + + aboutWindow.on('close', (e) => { + + e.preventDefault(); - aboutWindow = null; + aboutWindow.hide(); }); - aboutWindow.webContents.on('dom-ready', function () { + aboutWindow.webContents.on('dom-ready', () => { mainWindow.webContents.send('poll-night-mode'); @@ -268,72 +407,121 @@ function openAboutWindow () { } -function toggleNightMode () { +function openTimeZoneSelectionWindow () { - mainWindow.webContents.send('night-mode'); + let windowWidth = 448; + let windowHeight = 135; - if (splitWindow) { + if (process.platform === 'linux') { + + windowWidth = 443; + windowHeight = 138; + + } else if (process.platform === 'darwin') { - splitWindow.webContents.send('night-mode'); + windowWidth = 443; + windowHeight = 138; } - if (expansionWindow) { + if (timeZoneSelectionWindow) { - expansionWindow.webContents.send('night-mode'); + timeZoneSelectionWindow.show(); + return; } - if (downsampleWindow) { + const settings = generateSettings(windowWidth, windowHeight, 'Select Custom Time Zone'); + timeZoneSelectionWindow = new BrowserWindow(settings); - downsampleWindow.webContents.send('night-mode'); + timeZoneSelectionWindow.setMenu(null); + timeZoneSelectionWindow.loadURL(path.join('file://', __dirname, '/timeZoneSelection.html')); - } + require('@electron/remote/main').enable(timeZoneSelectionWindow.webContents); - if (aboutWindow) { + timeZoneSelectionWindow.on('close', (e) => { + + e.preventDefault(); + timeZoneSelectionWindow.hide(); + + }); + + timeZoneSelectionWindow.webContents.on('dom-ready', () => { + + mainWindow.webContents.send('poll-night-mode'); - aboutWindow.webContents.send('night-mode'); + }); + + ipcMain.on('night-mode-poll-reply', (e, nightMode) => { + + if (timeZoneSelectionWindow) { + + timeZoneSelectionWindow.webContents.send('night-mode', nightMode); + + } + + }); + +} + +function toggleNightMode () { + + mainWindow.webContents.send('night-mode'); + + const subwindows = [aboutWindow, expansionWindow, splitWindow, downsampleWindow, summariseWindow, timeZoneSelectionWindow]; + + for (let index = 0; index < subwindows.length; index++) { + + if (subwindows[index]) { + + subwindows[index].webContents.send('night-mode'); + + } } } -app.on('ready', function () { +app.on('ready', () => { + + let windowWidth = 565; + let windowHeight = 680; - const iconLocation = (process.platform === 'linux') ? '/build/icon.png' : '/build/icon.ico'; - const windowHeight = shrinkWindowHeight(665); + if (process.platform === 'linux') { + + windowWidth = 560; + windowHeight = 660; + + } else if (process.platform === 'darwin') { + + windowWidth = 560; + windowHeight = 656; + + } mainWindow = new BrowserWindow({ title: 'AudioMoth Configuration App', - width: 565, + width: windowWidth, height: windowHeight, - useContentSize: true, resizable: false, fullscreenable: false, + useContentSize: true, icon: path.join(__dirname, iconLocation), webPreferences: { - nodeIntegration: true + enableRemoteModule: true, + nodeIntegration: true, + contextIsolation: false } }); - mainWindow.on('restore', function () { - - /* When minimised and restored, Windows platforms alter the BrowserWindow such that the height no longer includes the menu bar */ - /* This resize cannot be blocked so this fix resizes it, taking into account the menu change */ - if (process.platform === 'win32') { - - mainWindow.setSize(565, windowHeight + 20); - - } - - }); + require('@electron/remote/main').enable(mainWindow.webContents); - const menuTemplate = [{ + const fileMenu = { label: 'File', submenu: [{ label: 'Open Configuration', accelerator: 'CommandOrControl+O', - click: function () { + click: () => { mainWindow.webContents.send('load'); @@ -341,7 +529,7 @@ app.on('ready', function () { }, { label: 'Save Configuration', accelerator: 'CommandOrControl+S', - click: function () { + click: () => { mainWindow.webContents.send('save'); @@ -352,7 +540,7 @@ app.on('ready', function () { id: 'copyid', label: 'Copy Device ID', accelerator: 'CommandOrControl+I', - click: function () { + click: () => { mainWindow.webContents.send('copy-id'); @@ -360,18 +548,6 @@ app.on('ready', function () { enabled: false }, { type: 'separator' - }, { - type: 'checkbox', - id: 'localTime', - label: 'Local Time', - accelerator: 'CommandOrControl+T', - checked: false, - click: function () { - - mainWindow.webContents.send('local-time'); - mainWindow.webContents.send('local-time-schedule'); - - } }, { type: 'checkbox', id: 'nightmode', @@ -386,7 +562,7 @@ app.on('ready', function () { id: 'scale1', label: '16-Bit Amplitude Threshold Scale', checked: false, - click: function () { + click: () => { mainWindow.webContents.send('amplitude-threshold-scale', 1); @@ -396,7 +572,7 @@ app.on('ready', function () { id: 'scale2', label: 'Decibel Amplitude Threshold Scale', checked: false, - click: function () { + click: () => { mainWindow.webContents.send('amplitude-threshold-scale', 2); @@ -406,7 +582,7 @@ app.on('ready', function () { id: 'scale0', label: 'Percentage Amplitude Threshold Scale', checked: true, - click: function () { + click: () => { mainWindow.webContents.send('amplitude-threshold-scale', 0); @@ -414,52 +590,86 @@ app.on('ready', function () { }, { type: 'separator' }, { - label: 'Split AudioMoth WAV Files', - accelerator: 'CommandOrControl+P', - click: function () { + label: 'Quit', + accelerator: 'CommandOrControl+Q', + click: () => { - openSplitWindow(); + app.quit(); } - }, { - label: 'Expand AudioMoth T.WAV Files', - accelerator: 'CommandOrControl+E', - click: function () { + }] + }; - openExpansionWindow(); + const timeZoneMenu = { + label: 'Time', + submenu: [{ + type: 'checkbox', + id: 'timeZone0', + label: 'UTC', + checked: true, + click: () => { + + setTimeZoneModeMenu(constants.TIME_ZONE_MODE_UTC); + + mainWindow.webContents.send('change-time-zone-mode', constants.TIME_ZONE_MODE_UTC); + mainWindow.webContents.send('update-schedule'); } }, { - label: 'Downsample AudioMoth WAV Files', - accelerator: 'CommandOrControl+D', - click: function () { + type: 'checkbox', + id: 'timeZone1', + label: 'Local', + checked: false, + click: () => { + + setTimeZoneModeMenu(constants.TIME_ZONE_MODE_LOCAL); - openDownsamplingWindow(); + mainWindow.webContents.send('change-time-zone-mode', constants.TIME_ZONE_MODE_LOCAL); + mainWindow.webContents.send('update-schedule'); } }, { - type: 'separator' - }, { - label: 'Quit', - accelerator: 'CommandOrControl+Q', - click: function () { + type: 'checkbox', + id: 'timeZone2', + label: 'Custom', + checked: false, + click: () => { - app.quit(); + updateTimeZoneMenuCheckbox(); + + openTimeZoneSelectionWindow(); } }] - }, { + }; + + const processMenu = { + label: 'Process', + submenu: [{ + label: 'Split AudioMoth WAV Files', + click: openSplitWindow + }, { + label: 'Expand AudioMoth T.WAV Files', + click: openExpansionWindow + }, { + label: 'Downsample AudioMoth WAV Files', + click: openDownsamplingWindow + }, { + type: 'separator' + }, { + label: 'Summarise AudioMoth Files', + click: openSummariseWindow + }] + }; + + const helpMenu = { label: 'Help', submenu: [{ label: 'About', - click: function () { - - openAboutWindow(); - - } + click: openAboutWindow }, { label: 'Check For Updates', - click: function () { + click: () => { mainWindow.webContents.send('update-check'); @@ -467,23 +677,25 @@ app.on('ready', function () { }, { type: 'separator' }, { - label: 'AudioMoth Filter Playground', - click: function () { + label: 'AudioMoth Play Website', + click: () => { - shell.openExternal('https://playground.openacousticdevices.info/'); + shell.openExternal('https://play.openacousticdevices.info/'); } }, { type: 'separator' }, { label: 'Open Acoustic Devices Website', - click: function () { + click: () => { shell.openExternal('https://openacousticdevices.info'); } }] - }]; + }; + + const menuTemplate = [fileMenu, processMenu, timeZoneMenu, helpMenu]; const menu = Menu.buildFromTemplate(menuTemplate); @@ -493,7 +705,7 @@ app.on('ready', function () { }); -app.on('window-all-closed', function () { +app.on('window-all-closed', () => { app.quit(); @@ -515,22 +727,9 @@ ipcMain.on('start-expansion-bar', (event, fileCount) => { detail += (fileCount > 1) ? 's' : ''; detail += '.'; - expandProgressBar = new ProgressBar({ - title: 'AudioMoth Configuration App', - text: 'Expanding files...', - detail: detail, - closeOnComplete: false, - indeterminate: false, - browserWindow: { - parent: expansionWindow, - webPreferences: { - nodeIntegration: true - }, - closable: true, - modal: false - }, - maxValue: fileCount * 100 - }); + const settings = generateProgressBarSettings('AudioMoth Configuration App - Expansion', 'Expanding files...', detail, fileCount, expansionWindow); + + expandProgressBar = new ProgressBar(settings); expandProgressBar.on('aborted', () => { @@ -557,11 +756,11 @@ ipcMain.on('set-expansion-bar-progress', (event, fileNum, progress) => { ipcMain.on('set-expansion-bar-file', (event, fileNum, name) => { - const index = fileNum + 1; - const fileCount = expandProgressBar.getOptions().maxValue / 100; - if (expandProgressBar) { + const index = fileNum + 1; + const fileCount = expandProgressBar.getOptions().maxValue / 100; + expandProgressBar.detail = 'Expanding ' + name + ' (' + index + ' of ' + fileCount + ').'; } @@ -657,22 +856,9 @@ ipcMain.on('start-split-bar', (event, fileCount) => { detail += (fileCount > 1) ? 's' : ''; detail += '.'; - splitProgressBar = new ProgressBar({ - title: 'AudioMoth Configuration App', - text: 'Splitting files...', - detail: detail, - closeOnComplete: false, - indeterminate: false, - browserWindow: { - parent: splitWindow, - webPreferences: { - nodeIntegration: true - }, - closable: true, - modal: false - }, - maxValue: fileCount * 100 - }); + const settings = generateProgressBarSettings('AudioMoth Configuration App - Splitting', 'Splitting files...', detail, fileCount, splitWindow); + + splitProgressBar = new ProgressBar(settings); splitProgressBar.on('aborted', () => { @@ -699,11 +885,11 @@ ipcMain.on('set-split-bar-progress', (event, fileNum, progress) => { ipcMain.on('set-split-bar-file', (event, fileNum, name) => { - const index = fileNum + 1; - const fileCount = splitProgressBar.getOptions().maxValue / 100; - if (splitProgressBar) { + const index = fileNum + 1; + const fileCount = splitProgressBar.getOptions().maxValue / 100; + splitProgressBar.detail = 'Splitting ' + name + ' (' + index + ' of ' + fileCount + ').'; } @@ -799,22 +985,9 @@ ipcMain.on('start-downsample-bar', (event, fileCount) => { detail += (fileCount > 1) ? 's' : ''; detail += '.'; - downsampleProgressBar = new ProgressBar({ - title: 'AudioMoth Configuration App', - text: 'Downsampling files...', - detail: detail, - closeOnComplete: false, - indeterminate: false, - browserWindow: { - parent: splitWindow, - webPreferences: { - nodeIntegration: true - }, - closable: true, - modal: false - }, - maxValue: fileCount * 100 - }); + const settings = generateProgressBarSettings('AudioMoth Configuration App - Downsampling', 'Downsampling files...', detail, fileCount, downsampleWindow); + + downsampleProgressBar = new ProgressBar(settings); downsampleProgressBar.on('aborted', () => { @@ -841,11 +1014,11 @@ ipcMain.on('set-downsample-bar-progress', (event, fileNum, progress) => { ipcMain.on('set-downsample-bar-file', (event, fileNum, name) => { - const index = fileNum + 1; - const fileCount = downsampleProgressBar.getOptions().maxValue / 100; - if (downsampleProgressBar) { + const index = fileNum + 1; + const fileCount = downsampleProgressBar.getOptions().maxValue / 100; + downsampleProgressBar.detail = 'Downsampling ' + name + ' (' + index + ' of ' + fileCount + ').'; } @@ -927,6 +1100,124 @@ ipcMain.on('poll-downsample-cancelled', (event) => { }); +/* Summarising progress bar functions */ + +ipcMain.on('start-summarise-bar', (event, fileCount) => { + + if (summariseProgressBar) { + + return; + + } + + let detail = 'Starting to summarise file'; + detail += (fileCount > 1) ? 's' : ''; + detail += '.'; + + const settings = generateProgressBarSettings('AudioMoth Configuration App - Summarising', 'Summarising files...', detail, fileCount, summariseWindow); + + summariseProgressBar = new ProgressBar(settings); + + summariseProgressBar.on('aborted', () => { + + if (summariseProgressBar) { + + summariseProgressBar.close(); + summariseProgressBar = null; + + } + + }); + +}); + +ipcMain.on('set-summarise-bar-progress', (event, fileNum, progress) => { + + if (summariseProgressBar) { + + summariseProgressBar.value = (fileNum * 100) + progress; + + } + +}); + +ipcMain.on('set-summarise-bar-file', (event, fileNum, name) => { + + if (summariseProgressBar) { + + const index = fileNum + 1; + const fileCount = summariseProgressBar.getOptions().maxValue / 100; + + summariseProgressBar.detail = 'Summarising ' + name + ' (' + index + ' of ' + fileCount + ').'; + + } + +}); + +ipcMain.on('set-summarise-bar-error', (event, name) => { + + if (summariseProgressBar) { + + summariseProgressBar.detail = 'Error when summarising ' + name + '.'; + + } + +}); + +ipcMain.on('set-summarise-bar-completed', (event, successCount, finaliseResult) => { + + if (summariseProgressBar) { + + let messageText; + + summariseProgressBar.setCompleted(); + + if (finaliseResult.success) { + + messageText = 'Successfully summarised ' + successCount + ' file'; + messageText += (successCount === 1 ? '' : 's'); + messageText += '.'; + + } else { + + messageText = 'Failed to write summary file. '; + messageText += finaliseResult.error; + + } + + summariseProgressBar.detail = messageText; + + setTimeout(function () { + + summariseProgressBar.close(); + summariseProgressBar = null; + + if (summariseWindow) { + + summariseWindow.send('summarise-summary-closed'); + + } + + }, 5000); + + } + +}); + +ipcMain.on('poll-summarise-cancelled', (event) => { + + if (summariseProgressBar) { + + event.returnValue = false; + + } else { + + event.returnValue = true; + + } + +}); + /* Update which amplitude threshold scale option is checked in menu */ ipcMain.on('set-amplitude-threshold-scale', (event, index) => { @@ -938,3 +1229,52 @@ ipcMain.on('set-amplitude-threshold-scale', (event, index) => { scaleMenuItems[index].checked = true; }); + +/* Update which time zone option is checked in menu */ + +function updateTimeZoneMenuCheckbox () { + + const menu = Menu.getApplicationMenu(); + + const timeZoneMenuItems = [menu.getMenuItemById('timeZone0'), menu.getMenuItemById('timeZone1'), menu.getMenuItemById('timeZone2')]; + + for (let i = 0; i < timeZoneMenuItems.length; i++) { + + timeZoneMenuItems[i].checked = i === timeZoneMode; + + } + +} + +function setTimeZoneModeMenu (index) { + + timeZoneMode = index; + + updateTimeZoneMenuCheckbox(); + +} + +ipcMain.on('set-time-zone-menu', (event, mode) => { + + setTimeZoneModeMenu(mode); + +}); + +ipcMain.on('set-custom-time-zone', (event, tz) => { + + const newTimeZoneMode = tz === 0 ? constants.TIME_ZONE_MODE_UTC : constants.TIME_ZONE_MODE_CUSTOM; + + setTimeZoneModeMenu(newTimeZoneMode); + + customTimeZone = tz; + + mainWindow.webContents.send('change-time-zone-mode', newTimeZoneMode); + mainWindow.webContents.send('update-schedule'); + +}); + +ipcMain.on('request-custom-time-zone', (event) => { + + event.returnValue = customTimeZone; + +}); diff --git a/nightMode.js b/nightMode.js index 5b6ddd4..5d76571 100644 --- a/nightMode.js +++ b/nightMode.js @@ -6,9 +6,9 @@ 'use strict'; -const electron = require('electron'); +const {app} = require('@electron/remote'); -var nightMode = false; +let nightMode = false; exports.isEnabled = () => { @@ -29,11 +29,11 @@ function setNightMode (nm) { if (nightMode) { - newLink.setAttribute('href', electron.remote.app.getAppPath() + '/uiNight.css'); + newLink.setAttribute('href', app.getAppPath() + '/uiNight.css'); } else { - newLink.setAttribute('href', electron.remote.app.getAppPath() + '/ui.css'); + newLink.setAttribute('href', app.getAppPath() + '/ui.css'); } diff --git a/package.json b/package.json index a98b608..0996732 100755 --- a/package.json +++ b/package.json @@ -1,6 +1,6 @@ { "name": "AudioMoth-Config", - "version": "1.9.2", + "version": "1.10.0", "description": "The configuration app for the AudioMoth acoustic monitoring device.", "main": "main.js", "author": "openacousticdevices.info", @@ -57,28 +57,33 @@ } }, "devDependencies": { - "electron": "8.5.2", - "electron-builder": "^23.0.2", - "eslint": "^7.27.0", - "eslint-config-standard": "^14.1.0", - "eslint-plugin-import": "^2.22.1", - "eslint-plugin-node": "^10.0.0", - "eslint-plugin-promise": "^4.3.1", - "eslint-plugin-standard": "^4.0.2" + "electron": "25.3.2", + "electron-builder": "^24.6.3", + "eslint": "^8.45.0", + "eslint-config-standard": "^17.1.0", + "eslint-plugin-import": "^2.27.5", + "eslint-plugin-n": "^16.0.1", + "eslint-plugin-node": "^11.1.0", + "eslint-plugin-promise": "^6.1.1", + "eslint-plugin-standard": "^4.1.0" }, "dependencies": { + "@electron/remote": "^2.0.10", + "@popperjs/core": "^2.11.8", "audiomoth-hid": "^2.1.0", - "audiomoth-utils": "^1.2.0", - "bootstrap": "4.3.1", - "bootstrap-slider": "^10.6.2", - "electron-debug": "3.0.1", + "audiomoth-utils": "^1.4.1", + "bootstrap": "5.3.1", + "bootstrap-slider": "^11.0.2", + "electron-debug": "3.2.0", "electron-localshortcut": "^3.2.1", - "electron-progressbar": "^1.2.0", - "jquery": "^3.5.1", - "jsonschema": "1.2.4", - "popper.js": "^1.15.0", - "showdown": "^1.9.1", - "strftime": "0.10.0" + "electron-progressbar": "^2.1.0", + "http-cache-semantics": "^4.1.1", + "jquery": "^3.7.0", + "jsonschema": "1.4.1", + "minimatch": "^9.0.3", + "semver": "^7.5.4", + "showdown": "^2.1.0", + "strftime": "0.10.2" }, "engines": { "node": ">=10.16.2" diff --git a/packetReader.js b/packetReader.js index d0b52d9..708d653 100644 --- a/packetReader.js +++ b/packetReader.js @@ -8,7 +8,7 @@ const audiomoth = require('audiomoth-hid'); -const UINT16_MAX = 0xFFFF; +const constants = require('./constants.js'); function fourBytesToNumber (buffer, offset) { @@ -32,7 +32,7 @@ function digitWithLeadingZero (value) { function formatTime (minutes) { - return digitWithLeadingZero(Math.floor(minutes / 60)) + ':' + digitWithLeadingZero(minutes % 60); + return digitWithLeadingZero(Math.floor(minutes / constants.MINUTES_IN_HOUR)) + ':' + digitWithLeadingZero(minutes % constants.MINUTES_IN_HOUR); } @@ -82,10 +82,10 @@ typedef struct { uint8_t enableLED; uint8_t activeStartStopPeriods; startStopPeriod_t startStopPeriods[MAX_START_STOP_PERIODS]; - int8_t timezoneHours; + int8_t timeZoneHours; uint8_t enableLowVoltageCutoff; uint8_t disableBatteryLevelDisplay; - int8_t timezoneMinutes; + int8_t timeZoneMinutes; uint8_t disableSleepRecordCycle; uint32_t earliestRecordingTime; uint32_t latestRecordingTime; @@ -125,8 +125,6 @@ typedef struct { exports.read = (packet) => { - let startMinutes, stopMinutes; - /* Read and decode configuration packet */ const time = audiomoth.convertFourBytesFromBufferToDate(packet, 0); @@ -149,19 +147,19 @@ exports.read = (packet) => { for (let i = 0; i < activeStartStopPeriods; i += 1) { - startMinutes = twoBytesToNumber(packet, 19 + 4 * i); - stopMinutes = twoBytesToNumber(packet, 21 + 4 * i); + const startMinutes = twoBytesToNumber(packet, 19 + 4 * i); + const endMinutes = twoBytesToNumber(packet, 21 + 4 * i); - startStopPeriods.push({startMinutes: startMinutes, stopMinutes: stopMinutes}); + startStopPeriods.push({startMinutes, endMinutes}); } - const timezoneHours = packet[39]; + const timeZoneHours = packet[39] > 127 ? packet[39] - 256 : packet[39]; const enableLowVoltageCutoff = packet[40]; const disableBatteryLevelDisplay = packet[41]; - const timezoneMinutes = packet[42]; + const timeZoneMinutes = packet[42] > 127 ? packet[42] - 256 : packet[42]; const disableSleepRecordCycle = packet[43]; @@ -276,8 +274,8 @@ exports.read = (packet) => { console.log('Current time: ', formatDate(time)); - console.log('Timezone Hours:', timezoneHours); - console.log('Timezone Minutes:', timezoneMinutes); + console.log('TimeZone Hours:', timeZoneHours); + console.log('TimeZone Minutes:', timeZoneMinutes); console.log('Gain:', gain); console.log('Clock divider:', clockDivider); @@ -298,19 +296,22 @@ exports.read = (packet) => { for (let j = 0; j < activeStartStopPeriods; j++) { - console.log('Start: ' + formatTime(startStopPeriods[j].startMinutes) + ' - Stop: ' + formatTime(startStopPeriods[j].stopMinutes)); + const startMins = startStopPeriods[j].startMinutes; + const endMins = startStopPeriods[j].endMinutes; + + console.log('Start: ' + formatTime(startMins) + ' (' + startMins + ') - End: ' + formatTime(endMins) + ' (' + endMins + ')'); } console.log('Earliest recording time:', formatDate(earliestRecordingTime)); console.log('Latest recording time:', formatDate(latestRecordingTime)); - if (lowerFilterFreq === UINT16_MAX) { + if (lowerFilterFreq === constants.UINT16_MAX) { // Low-pass console.log('Low-pass filter set at:', higherFilterFreq / 10, 'kHz'); - } else if (higherFilterFreq === UINT16_MAX) { + } else if (higherFilterFreq === constants.UINT16_MAX) { // High-pass console.log('High-pass filter set at:', lowerFilterFreq / 10, 'kHz'); diff --git a/processing/downsampling.html b/processing/downsampling.html index 12001bc..8981b84 100644 --- a/processing/downsampling.html +++ b/processing/downsampling.html @@ -10,72 +10,88 @@ -
    +
    -
    -
    -
    -
    - +
    + +
    + +
    + +
    + +
    - - - - - - - - - + + + + + + + + + - +
    816324896192250384816324896192250384
    +
    +
    +
    +
    -