-
Notifications
You must be signed in to change notification settings - Fork 2
/
app.js
1234 lines (751 loc) · 34.6 KB
/
app.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
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
/****************************************************************************
* app.js
* openacousticdevices.info
* October 2019
*****************************************************************************/
'use strict';
/* global document */
const electron = require('electron');
const {dialog, getCurrentWindow} = require('@electron/remote');
const fs = require('fs');
const path = require('path');
const electronLog = require('electron-log');
const firmwareInterface = require('./firmwareInterface.js');
const comms = require('./communication.js');
const versionChecker = require('./versionChecker.js');
const nightMode = require('./nightMode.js');
/* File size limits for local binary files */
const MAX_FILE_SIZE = 256 * 1024 - 0x4000;
const MAX_FILE_SIZE_DESTRUCTIVE = 256 * 1024;
const MILLISECONDS_IN_SECOND = 1000;
/* UI elements */
const downloadTabLink = document.getElementById('download-tab-link');
const localTabLink = document.getElementById('local-tab-link');
const TAB_DOWNLOAD = 0;
const TAB_LOCAL = 1;
let currentTab = TAB_DOWNLOAD;
const fileButton = document.getElementById('file-button');
const destructiveCheckbox = document.getElementById('destructive-checkbox');
const flashButtonDownloaded = document.getElementById('flash-button0');
const flashButtonLocal = document.getElementById('flash-button1');
const statusDiv = document.getElementById('status-div');
const versionSelect = document.getElementById('version-select');
const downloadButton = document.getElementById('download-button');
const overwriteBootloaderDiv = document.getElementById('overwrite-bootloader-div');
let deviceStatus = comms.STATUS_NO_AUDIOMOTH;
/* Status set getStatus which enables/disables flash buttons */
let inFlashableState = false;
let inSerialBootloader = false;
/* The names of supported firmware */
const FIRMWARE_NAMES = ['AudioMoth-Firmware-Basic', 'AudioMoth-USB-Microphone', 'AudioMoth-GPS-Sync'];
/* Is overwrite bootloader option available */
let overwriteBootloaderOptionEnabled = false;
/* Should the user data be cleared of configuration when flashing */
let clearUserDataEnabled = true;
/* Should the USB HID flashing be used to flash devices */
let useUSBHIDFlashing = true;
/* Counter for user data clear attempts */
let clearUserDataAttempts = 0;
const MAX_CLEAR_USER_DATA_ATTEMPTS = 5;
/* Counter for port opening attempts */
let portOpenReattempts = 0;
const MAX_PORT_OPEN_ATTEMPTS = 5;
const PORT_OPEN_ATTEMPT_DELAY = 500;
/* Counter for bootloader version check attempts */
let bootloaderVersionReattempts = 0;
const MAX_BOOTLOADER_VERSION_ATTEMPTS = 5;
const BOOTLOADER_VERSION_ATTEMPT_DELAY = 500;
/* Function called when bootloader has successfully been updated */
let bootloaderUpdateCompleteCallback;
/* Flag indicating waiting for progress window to stop showing bootloader update success message */
let displayingBootloaderSuccess = false;
/* Build packed path to bootloader update file] */
let directory = path.join(__dirname, 'firmware');
const unpackedDirectory = directory.replace('app.asar', 'app.asar.unpacked');
if (fs.existsSync(directory)) {
directory = unpackedDirectory;
}
/* Current status object used to update information panel and flash button status */
let statusResult;
let supportsUSBHIDFlash = false;
let supportsBootloaderSwitching = false;
let firmwareVersion = [0, 0, 0];
let firmwareDescription = '';
const bootloaderUpdatePath = path.join(directory, 'audiomoth_bootloader_updater.bin');
const bootloaderCRC = 'A435';
electronLog.transports.file.fileName = 'audiomoth_flash.log';
electronLog.transports.file.maxSize = 3145728;
console.log('Writing log to: ' + electronLog.transports.file.getFile().path);
/* Menu button to open log file pressed */
electron.ipcRenderer.on('logfile', () => {
const srcLogLocation = electronLog.transports.file.getFile().path;
const destLogLocation = dialog.showSaveDialogSync({
title: 'Save log',
nameFieldLabel: 'Log location',
defaultPath: electronLog.transports.file.fileName,
filters: [{
name: 'log',
extensions: ['log']
}]
});
if (destLogLocation) {
electronLog.log('Saving log...');
fs.copyFile(srcLogLocation, destLogLocation, (err) => {
if (err) {
electronLog.log('Failed to save log: ');
electronLog.err(err);
}
});
}
});
/**
* Debug function used to print the current device status
*/
function printDeviceStatus () {
switch (deviceStatus) {
case comms.STATUS_AUDIOMOTH_AUTO:
console.log('STATUS_AUDIOMOTH_AUTO');
break;
case comms.STATUS_AUDIOMOTH_MANUAL:
console.log('STATUS_AUDIOMOTH_MANUAL');
break;
case comms.STATUS_AUDIOMOTH_USB:
console.log('STATUS_AUDIOMOTH_USB');
break;
case comms.STATUS_NO_AUDIOMOTH:
console.log('STATUS_NO_AUDIOMOTH');
break;
case comms.STATUS_SERIAL_BOOTLOADER:
console.log('STATUS_SERIAL_BOOTLOADER');
break;
default:
break;
}
}
/**
* Enable flash buttons based on whether or not the app and connected device are in a state which permits flashing
*/
function updateFlashButtonState () {
flashButtonDownloaded.disabled = (!inFlashableState || !firmwareInterface.isSelectionDownloaded() || comms.isCommunicating());
flashButtonLocal.disabled = (!inFlashableState || firmwareInterface.getLocalFirmwarePath() === '' || comms.isCommunicating());
}
versionSelect.addEventListener('change', updateFlashButtonState);
downloadButton.addEventListener('click', updateFlashButtonState);
function communicateDeviceStatus (newStatus) {
deviceStatus = newStatus;
electron.ipcRenderer.send('status-app', newStatus);
}
/**
* Work out the status of a connected device
* @param {function} callback Completion callback
*/
async function getStatus (callback) {
inFlashableState = false;
inSerialBootloader = false;
/* Check if a serial device matching AudioMoth IDs can be found */
const serialBootloader = await comms.isInBootloader();
if (serialBootloader) {
inFlashableState = true;
inSerialBootloader = true;
callback();
return;
}
try {
statusResult = await comms.getStatus();
if (statusResult === null) {
throw ('No AudioMoth found.');
}
callback();
} catch (error) {
callback();
}
}
/**
* Send message to main process, triggering the completion message in the progress window
*/
function displayCompleteMessage () {
electron.ipcRenderer.send('set-bar-completed');
electronLog.log('--- Firmware write complete ---');
}
/* Re-enable the status box when the progress window closes */
electron.ipcRenderer.on('flash-success', comms.stopCommunicating);
/**
* Create string to display on progress bar during flashing
* @param {string} version Version number as a string (x.x.x)
* @returns String to display on progress bar
*/
function getInfoText (version) {
let infoText = '';
if (version) {
infoText = 'Applying firmware version ' + version + ' to attached AudioMoth.';
} else {
infoText = 'Applying firmware to attached AudioMoth.';
}
return infoText;
}
/**
* Clear the connected device of all user data (config settings)
* @param {function} successCallback Success callback
*/
function clearUserData (successCallback) {
if (clearUserDataAttempts < MAX_CLEAR_USER_DATA_ATTEMPTS) {
clearUserDataAttempts++;
electronLog.log('Attempting to clear user data. Attempt ' + clearUserDataAttempts);
comms.startUserDataClear(() => {
clearUserData(successCallback);
}, () => {
clearUserDataAttempts = 0;
successCallback();
});
} else {
electronLog.error('Failed to clear user data after ' + MAX_CLEAR_USER_DATA_ATTEMPTS + ' attempts.');
comms.displayError('Flash failure', 'Failed to clear user data after ' + MAX_CLEAR_USER_DATA_ATTEMPTS + ' attempts. Detach and reattach your AudioMoth, and try again.');
comms.stopCommunicating();
}
}
/**
* Open file and write contents to serial port
* @param {string} firmwarePath Path to firmware
* @param {boolean} destructive Whether or not the flash will overwrite the bootloader
* @param {string} infoText Text to display on the loading bar window
* @param {string} expectedCRC Expected CRC value. If resulting CRC doesn't match, the user will be warned
* @param {function} successCallback Success callback
*/
function serialWrite (firmwarePath, destructive, infoText, expectedCRC, successCallback) {
/* Calculate max size of progress bar and start */
const maxBlocks = Math.ceil(fs.statSync(firmwarePath).size / comms.BLOCK_SIZE);
/* Make process end rather than retry in case of port failure, mid-way through flashing */
comms.setPortErrorCallback(function () {
comms.failFlash();
comms.stopCommunicating();
});
fs.readFile(firmwarePath, (err, contents) => {
if (err) {
comms.displayError('Flash failure', 'Firmware binary cannot be read. Download again and retry.');
comms.stopCommunicating();
} else {
if (clearUserDataEnabled) {
clearUserData(() => {
electronLog.log('Successfully cleared user data');
comms.sendFirmware(contents, destructive, expectedCRC, successCallback, infoText, maxBlocks);
});
} else {
comms.sendFirmware(contents, destructive, expectedCRC, successCallback, infoText, maxBlocks);
}
}
});
}
/**
* Open port, open file and write contents to that port
* @param {string} firmwarePath Path to firmware
* @param {boolean} destructive Whether or not the flash will overwrite the bootloader
* @param {string} infoText Text to display on the loading bar window
* @param {string} expectedCRC Expected CRC value. If resulting CRC doesn't match, the user will be warned
* @param {function} successCallback Success callback
*/
async function openPortAndSerialWrite (firmwarePath, destructive, infoText, expectedCRC, successCallback) {
const portName = await comms.getAudioMothPortName();
if (!portName) {
if (portOpenReattempts <= MAX_PORT_OPEN_ATTEMPTS) {
electronLog.log('Reattempting to get port name. Attempt', (portOpenReattempts + 1));
setTimeout(function () {
portOpenReattempts++;
openPortAndSerialWrite(firmwarePath, destructive, infoText, expectedCRC, successCallback);
}, PORT_OPEN_ATTEMPT_DELAY * Math.pow(2, portOpenReattempts));
} else {
electronLog.log('Gave up trying to open port after', portOpenReattempts, 'failed attempts.');
comms.displayError('Communication failure', 'Could not connect to AudioMoth. Reconnect AudioMoth and try again.');
comms.stopCommunicating();
portOpenReattempts = 0;
}
return;
}
comms.openPort(portName, () => {
serialWrite(firmwarePath, destructive, infoText, expectedCRC, successCallback);
}, () => {
electronLog.log('Closed port');
}, () => {
if (portOpenReattempts <= MAX_PORT_OPEN_ATTEMPTS) {
electronLog.log('Reattempting to open port. Attempt', (portOpenReattempts + 1));
setTimeout(function () {
portOpenReattempts++;
openPortAndSerialWrite(firmwarePath, destructive, infoText, expectedCRC, successCallback);
}, PORT_OPEN_ATTEMPT_DELAY * Math.pow(2, portOpenReattempts));
} else {
electronLog.log('Gave up trying to open port after', portOpenReattempts, 'failed attempts.');
comms.displayError('Communication failure', 'Could not connect to AudioMoth. Reconnect AudioMoth and try again.');
comms.stopCommunicating();
portOpenReattempts = 0;
}
});
}
/**
* Open the port to the device, check bootloader version and then continue with flashing process
* @param {string} firmwarePath Path to firmware
* @param {boolean} destructive Whether or not the flash will overwrite the bootloader
* @param {string} version Firmware version as a string (x.x.x)
* @param {string} expectedCRC Expected CRC value. If resulting CRC doesn't match, the user will be warned
*/
async function openPortCheckBootloader (firmwarePath, destructive, version, expectedCRC) {
const portName = await comms.getAudioMothPortName();
if (!portName) {
if (portOpenReattempts <= MAX_PORT_OPEN_ATTEMPTS) {
electronLog.log('Reattempting to get port name to check bootloader version. Attempt', (portOpenReattempts + 1));
setTimeout(function () {
portOpenReattempts++;
openPortCheckBootloader(firmwarePath, destructive, version, expectedCRC);
}, PORT_OPEN_ATTEMPT_DELAY * Math.pow(2, portOpenReattempts));
} else {
electronLog.log('Gave up trying to open port to check bootloader after', portOpenReattempts, 'failed attempts.');
comms.displayError('Communication failure', 'Could not connect to AudioMoth. Reconnect AudioMoth and try again.');
comms.stopCommunicating();
portOpenReattempts = 0;
}
return;
}
electron.ipcRenderer.send('set-bar-checking-bootloader');
setTimeout(() => {
comms.openPort(portName, () => {
bootloaderVersionReattempts = 0;
checkBootloaderThenSerialWrite(firmwarePath, destructive, version, expectedCRC);
}, () => {
electronLog.log('Closed port');
}, () => {
if (portOpenReattempts <= MAX_PORT_OPEN_ATTEMPTS) {
electronLog.log('Reattempting to open port to check bootloader version. Attempt', (portOpenReattempts + 1));
setTimeout(function () {
portOpenReattempts++;
openPortCheckBootloader(firmwarePath, destructive, version, expectedCRC);
}, PORT_OPEN_ATTEMPT_DELAY * Math.pow(2, portOpenReattempts));
} else {
electronLog.log('Gave up trying to open port to check bootloader after', portOpenReattempts, 'failed attempts.');
comms.displayError('Communication failure', 'Could not connect to AudioMoth. Reconnect AudioMoth and try again.');
comms.stopCommunicating();
portOpenReattempts = 0;
}
});
}, 1000);
}
/**
* Check if bootloader needs updating, update it if necessary and then start serial write
* @param {string} firmwarePath Path to firmware
* @param {boolean} destructive Whether or not the flash will overwrite the bootloader
* @param {string} version Firmware version as a string (x.x.x)
* @param {string} expectedCRC Expected CRC value. If resulting CRC doesn't match, the user will be warned
*/
async function checkBootloaderThenSerialWrite (firmwarePath, destructive, version, expectedCRC) {
comms.requestBootloaderVersion((err, bootloaderVersion) => {
if (err) {
if (bootloaderVersionReattempts < MAX_BOOTLOADER_VERSION_ATTEMPTS) {
electronLog.log('Reattempting to check bootloader version. Attempt', (bootloaderVersionReattempts + 1));
setTimeout(function () {
bootloaderVersionReattempts++;
checkBootloaderThenSerialWrite(firmwarePath, destructive, version, expectedCRC);
}, BOOTLOADER_VERSION_ATTEMPT_DELAY * Math.pow(2, bootloaderVersionReattempts));
} else {
electronLog.log('--- Gave up trying to check bootloader after', bootloaderVersionReattempts, 'failed attempts. ---');
comms.displayError('Communication failure', err + ' Reconnect AudioMoth and try again.');
comms.stopCommunicating();
}
return;
}
/* Check if bootloader is on a version which requires updating */
if (bootloaderVersion === 1.01 || bootloaderVersion === 1.0) {
electronLog.log('Bootloader needs updating from version ' + bootloaderVersion);
const buttonIndex = dialog.showMessageBoxSync({
type: 'warning',
icon: path.join(__dirname, '/icon-64.png'),
noLink: true,
buttons: ['Continue', 'Cancel'],
title: 'Update bootloader',
message: 'The bootloader requires an update before being flashed. Current version: ' + bootloaderVersion
});
if (buttonIndex === 0) {
/* Function to run when the bootloader update is a success */
bootloaderUpdateCompleteCallback = () => {
electronLog.log('Resuming firmware flash.');
portOpenReattempts = 0;
electronLog.log('--- Starting serial write ---');
openPortAndSerialWrite(firmwarePath, destructive, getInfoText(version), expectedCRC, displayCompleteMessage);
};
/* Text which appears above progress bar while bootloader update is running */
const infoText = 'Applying bootloader update to attached AudioMoth.';
/* Wait a short period for port to close before reopening */
setTimeout(() => {
electronLog.log('--- Starting bootloader update ---');
serialWrite(bootloaderUpdatePath, false, infoText, bootloaderCRC, () => {
displayingBootloaderSuccess = true;
/* Display success message to user */
electron.ipcRenderer.send('set-bar-bootloader-update-completed');
electronLog.log('--- Bootloader update complete ---');
});
}, PORT_OPEN_ATTEMPT_DELAY);
} else {
comms.stopCommunicating();
electron.ipcRenderer.send('set-bar-aborted');
electronLog.log('--- Flash cancelled. User declined updating bootloader ---');
}
} else {
/* If update isn't necessary, flash as usual after short delay */
electronLog.log('Bootloader does not need updating from version ' + bootloaderVersion);
setTimeout(() => {
serialWrite(firmwarePath, destructive, getInfoText(version), expectedCRC, displayCompleteMessage);
}, PORT_OPEN_ATTEMPT_DELAY);
}
});
}
/* Message sent when bootloader update has succeeded and message has been briefly shown to the user telling them this */
electron.ipcRenderer.on('bootloader-update-success', () => {
if (displayingBootloaderSuccess) {
displayingBootloaderSuccess = false;
/* Reset the progress bar for the actual firmware flash */
electron.ipcRenderer.send('reset-bar');
/* Run the originally requested serial write */
bootloaderUpdateCompleteCallback();
}
});
/* Work out what type of flash is appropriate for the current device */
async function flashButtonOnClick (firmwarePath, destructive, version, expectedCRC) {
/* If the app is already communicating with the device, don't try overriding it */
if (comms.isCommunicating()) {
return;
}
electronLog.log('--- Starting communication ---');
comms.startCommunicating();
/* Set status bar text and flash button state */
statusDiv.innerHTML = 'Communicating with AudioMoth.';
inFlashableState = false;
updateFlashButtonState();
/* Verify user really wants to overwrite the bootloader (if on downloaded pane, 'destructive' will always be false) */
if (destructive) {
const fileRegex = /(audiomoth-firmware-basic|audiomoth-usb-microphone|audiomoth-gps-sync)-\d+\.\d+\.\d+\.bin/;
const regexResult = fileRegex.exec(path.basename(firmwarePath.toLowerCase()));
if (regexResult) {
dialog.showMessageBox({
type: 'error',
icon: path.join(__dirname, '/icon-64.png'),
title: 'Cannot overwrite bootloader',
buttons: ['Cancel'],
message: 'This firmware version is intended to be installed alongside the bootloader. Click below to cancel the operation.'
});
electron.ipcRenderer.send('set-bar-aborted');
comms.stopCommunicating();
return;
} else {
const buttonIndex = dialog.showMessageBoxSync({
type: 'warning',
icon: path.join(__dirname, '/icon-64.png'),
buttons: ['Yes', 'No'],
title: 'Overwrite bootloader',
message: 'You are about to overwrite the bootloader. This should only be done with specific versions of firmware. Are you sure you want to do this?'
});
if (buttonIndex !== 0) {
electron.ipcRenderer.send('set-bar-aborted');
comms.stopCommunicating();
return;
} else {
electronLog.log('PERFORMING DESTRUCTIVE WRITE');
}
}
}
/* Open progress bar */
electron.ipcRenderer.send('start-bar');
const overwriteBootloaderEnabled = overwriteBootloaderOptionEnabled && destructiveCheckbox.checked;
if (useUSBHIDFlashing) {
if (!supportsUSBHIDFlash) {
electronLog.error('USB HID flashing not supported by current AudioMoth. Switching to serial');
} else if (overwriteBootloaderEnabled) {
electronLog.error('USB HID flashing not supported when bootloader overwriting is enabled. Switching to serial');
} else if (deviceStatus === comms.STATUS_SERIAL_BOOTLOADER) {
electronLog.log('Device supports USB HID flashing but is already in the serial bootloader. Switching to serial');
} else {
const firmwareNameValid = /^.+\.bin/.test(firmwarePath);
if (firmwareNameValid === false) {
electron.ipcRenderer.send('set-bar-aborted');
comms.displayError('Flash failure', 'Firmware is not a .BIN file.');
comms.stopCommunicating();
return;
}
comms.USBHIDFlash(firmwarePath, clearUserDataEnabled, expectedCRC, getInfoText(version), displayCompleteMessage, (err) => {
electronLog.error(err);
electron.ipcRenderer.send('set-bar-aborted');
comms.displayError('Flash failure', 'An error occurred during flashing. Detach and reattach your AudioMoth, and try again.');
comms.stopCommunicating();
});
return;
}
}
electronLog.log('Flashing using serial flash...');
portOpenReattempts = 0;
/* Check for serial bootloader if device is already in bootloader */
let serialBootloader = await comms.isInBootloader();
if (serialBootloader) {
openPortCheckBootloader(firmwarePath, destructive, version, expectedCRC);
return;
}
if (supportsBootloaderSwitching) {
/* Switch device to bootloader */
comms.requestBootloader(async (bootloaderErr) => {
if (bootloaderErr) {
electron.ipcRenderer.send('set-bar-aborted');
comms.displayError('Flash failure', 'Could not switch to serial flash mode. Detach and reattach your AudioMoth, and try again.');
comms.stopCommunicating();
} else {
/* Check for serial bootloader again */
serialBootloader = await comms.isInBootloader();
if (serialBootloader) {
/* Wait and then flash using serial communication */
setTimeout(function () {
openPortCheckBootloader(firmwarePath, destructive, version, expectedCRC);
}, PORT_OPEN_ATTEMPT_DELAY);
return;
}
electron.ipcRenderer.send('set-bar-aborted');
comms.displayError('Flash failure', 'Could not switch to serial flash mode. Detach and reattach your AudioMoth, and try again.');
comms.stopCommunicating();
}
});
}
}
/* Flash button on downloaded firmware tab */
flashButtonDownloaded.addEventListener('click', async () => {
const currentFirmwareID = requestCurrentFirmwareID();
electronLog.log('Attempting to apply firmware:', FIRMWARE_NAMES[currentFirmwareID]);
const firmwarePath = firmwareInterface.getCurrentFirmwareDirectory(currentFirmwareID);
const version = firmwareInterface.getSelectedFirmwareVersion(currentFirmwareID);
const expectedCRC = firmwareInterface.getSelectedFirmwareCRC(currentFirmwareID);
/* Firmware downloaded from Github releases never includes a bootloader so a destructive write is never needed */
flashButtonOnClick(firmwarePath, false, version, expectedCRC);
});
/* Flash button on local firmware tab */
flashButtonLocal.addEventListener('click', () => {
let errorMessage = '';
/* Check the selected firmware binary can be used to flash */
const firmwarePath = firmwareInterface.getLocalFirmwarePath();
if (!firmwarePath) {
errorMessage = 'No binary file selected.';
} else if (!fs.existsSync(firmwarePath)) {
errorMessage = 'Selected binary no longer exists.';
} else {
/* Calculate firmware file size */
const stats = fs.statSync(firmwarePath);
/* Max file size is larger for destructive writes as it includes the bootloader size */
const maxSize = destructiveCheckbox.checked ? MAX_FILE_SIZE_DESTRUCTIVE : MAX_FILE_SIZE;
if (stats.size > maxSize) {
errorMessage = 'Selected binary is too large.';
}
}
if (errorMessage !== '') {
comms.displayError('Invalid binary', errorMessage + ' Select a valid file and try again.');
firmwareInterface.updateFirmwareDirectoryDisplay('');
return;
}
electronLog.log('Attempting to apply local firmware binary');
/* As the firmware can be any custom firmware, version number and CRC are not known before flashing */
flashButtonOnClick(firmwareInterface.getLocalFirmwarePath(), destructiveCheckbox.checked);
});
/**
* File select button for local firmware files
*/
async function selectBinary () {
const filenames = await dialog.showOpenDialog({
title: 'Select firmware binary',
nameFieldLabel: 'Binary file',
multiSelections: false,
filters: [{
name: 'bin',
extensions: ['bin']
}]
});
if (filenames && !filenames.canceled) {
/* Check if binary is a valid firmware file */
const isValid = await firmwareInterface.isFirmwareFile(filenames.filePaths[0]);
if (isValid) {
firmwareInterface.updateFirmwareDirectoryDisplay(filenames.filePaths[0]);
} else {
comms.displayError('Invalid binary', 'Chosen firmware binary is not valid AudioMoth firmware. Select a different file and try again.');
}
updateStatusUI();
}
}
fileButton.addEventListener('click', selectBinary);
/**
* Update the information text using cached information and flash button state after a status request
*/
function updateStatusUI () {
if (inSerialBootloader) {
statusDiv.innerHTML = 'Found an AudioMoth in serial flash mode.';
updateFlashButtonState();
communicateDeviceStatus(comms.STATUS_SERIAL_BOOTLOADER);
return;
}
if (statusResult === undefined || statusResult === null) {
inFlashableState = false;
statusDiv.innerHTML = 'No AudioMoth found.<br>Make sure the USB cable is connected and the switch is in USB/OFF.';
updateFlashButtonState();
communicateDeviceStatus(comms.STATUS_NO_AUDIOMOTH);
return;
}
supportsUSBHIDFlash = statusResult.supportsUSBHIDFlash;
supportsBootloaderSwitching = statusResult.supportsBootloaderSwitch;
firmwareVersion = statusResult.firmwareVersion;
firmwareDescription = statusResult.firmwareDescription;
let statusText;
if (supportsBootloaderSwitching) {
statusText = 'Found an AudioMoth with ' + firmwareDescription + ' (' + firmwareVersion[0] + '.' + firmwareVersion[1] + '.' + firmwareVersion[2] + ') installed.<br>';
if (overwriteBootloaderOptionEnabled && destructiveCheckbox.checked && currentTab === TAB_LOCAL) {
statusText += 'This AudioMoth will automatically enter serial flash mode and overwrite the bootloader.';
communicateDeviceStatus(comms.STATUS_AUDIOMOTH_AUTO);
} else {
if (supportsUSBHIDFlash && useUSBHIDFlashing) {
statusText += 'This AudioMoth will use USB HID flashing.';
communicateDeviceStatus(comms.STATUS_AUDIOMOTH_USB);
} else {
statusText += 'This AudioMoth will automatically enter serial flash mode.';
communicateDeviceStatus(comms.STATUS_AUDIOMOTH_AUTO);
}
}
inFlashableState = true;
if (!comms.isCommunicating()) {
statusDiv.innerHTML = statusText;
updateFlashButtonState();
}
} else {
/* Add link which opens instructions window */
if ((firmwareVersion[0] === 0 && firmwareVersion[1] === 0 && firmwareVersion[2] === 0) || !firmwareDescription === '') {