Skip to content

Add Save and Erase button for onboard logging #4673

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 8 commits into
base: master
Choose a base branch
from
Open

Add Save and Erase button for onboard logging #4673

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
407b843
Add Save and Erase button for onboard logging
haslinghuis Oct 20, 2025
4345031
Add missing handler
haslinghuis Oct 20, 2025
7f50936
Update disabled state toggle
haslinghuis Oct 20, 2025
4841e2b
Nitpicks
haslinghuis Oct 20, 2025
81f49ac
Nitpicks 2
haslinghuis Oct 20, 2025
bdd06e9
Remove unsupported
haslinghuis Oct 22, 2025
9380578
Repeat check for not cancelled for consistency
haslinghuis Oct 22, 2025
888ff0b
Only close dialog when open
haslinghuis Oct 22, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 4 additions & 3 deletions locales/en/messages.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3549,15 +3549,16 @@
"dataflashButtonSaveFile": {
"message": "Save flash to file..."
},
"dataflashButtonSaveFileDeprecated": {
"message": "Save flash to file... (unsupported)"
},
"dataflashSavetoFileNote": {
"message": "Directly saving flash to file is slow and inherently prone to error / file corruption.<br>In some cases it will work for small files, but this is not supported and support requests for it will be closed without comment - use Mass Storage mode instead."
},
"dataflashSaveFileDepreciationHint": {
"message": "This method is slow and inherently prone to error / file corruption, because the MSP connection itself has intrinsic, fundamental limitations that make it unsuitable for file transfers. It may work for small log files only. Do not create support requests if file transfers fail when saved using this method. The recommended method is to use '<b>$t(onboardLoggingRebootMscText.message)</b>' (below) to activate the Mass Storage Mode, and access your flight controller as a storage device to download the log files."
},
"dataflashButtonSaveAndErase": {
"message": "Save & Erase",
"description": "Button text to save blackbox logs to file and then erase the flash"
},
"dataflashButtonErase": {
"message": "Erase flash"
},
Expand Down
47 changes: 39 additions & 8 deletions src/js/tabs/onboard_logging.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -102,7 +102,16 @@ onboard_logging.initialize = function (callback) {
$(".tab-onboard_logging a.erase-flash-confirm").click(flash_erase);
$(".tab-onboard_logging a.erase-flash-cancel").click(flash_erase_cancel);

$(".tab-onboard_logging a.save-flash").click(flash_save_begin);
$(".tab-onboard_logging a.save-flash").on("click", (e) => {
e.preventDefault();
flash_save_begin(false);
});

$(".tab-onboard_logging a.save-flash-erase").on("click", (e) => {
e.preventDefault();
flash_save_begin(true);
});

$(".tab-onboard_logging a.save-flash-cancel").click(flash_save_cancel);
$(".tab-onboard_logging a.save-flash-dismiss").click(dismiss_saving_dialog);
}
Expand Down Expand Up @@ -355,10 +364,9 @@ onboard_logging.initialize = function (callback) {
true,
);

$("a.regular-button erase-flash, a.regular-button.require-msc-supported.save-flash").toggleClass(
"disabled",
FC.DATAFLASH.usedSize === 0,
);
$(
"a.regular-button.erase-flash, a.regular-button.save-flash-erase, a.regular-button.require-msc-supported.save-flash",
).toggleClass("disabled", FC.DATAFLASH.usedSize === 0);

$(".tab-onboard_logging")
.toggleClass("sdcard-error", FC.SDCARD.state === MSP.SDCARD_STATE_FATAL)
Expand Down Expand Up @@ -478,7 +486,20 @@ onboard_logging.initialize = function (callback) {
});
}

function flash_save_begin() {
function conditionallyEraseFlash(maxBytes, nextAddress) {
if (Number.isFinite(maxBytes) && nextAddress >= maxBytes) {
eraseCancelled = false;
$(".dataflash-confirm-erase").addClass("erasing");
MSP.send_message(MSPCodes.MSP_DATAFLASH_ERASE, false, false, poll_for_erase_completion);
} else {
gui_log(
i18n.getMessage("dataflashSaveIncompleteWarning") ||
"Downloaded size did not match expected size - not erasing flash.",
);
}
}

function flash_save_begin(alsoErase = false) {
if (GUI.connected_to) {
self.blockSize = self.BLOCK_SIZE;

Expand All @@ -498,7 +519,7 @@ onboard_logging.initialize = function (callback) {
// Did we receive any data?
if (chunkDataView.byteLength > 0) {
nextAddress += chunkDataView.byteLength;
if (isNaN(bytesCompressed) || isNaN(totalBytesCompressed)) {
if (Number.isNaN(bytesCompressed) || Number.isNaN(totalBytesCompressed)) {
totalBytesCompressed = null;
} else {
totalBytesCompressed += bytesCompressed;
Expand All @@ -515,6 +536,10 @@ onboard_logging.initialize = function (callback) {
mark_saving_dialog_done(startTime, nextAddress, totalBytesCompressed);
}
FileSystem.closeFile(openedFile);
// Optionally erase after successful full download
if (!saveCancelled && alsoErase) {
conditionallyEraseFlash(maxBytes, nextAddress);
}
} else {
if (!self.writeError) {
mspHelper.dataflashRead(nextAddress, self.blockSize, onChunkRead);
Expand All @@ -528,6 +553,9 @@ onboard_logging.initialize = function (callback) {
// A zero-byte block indicates end-of-file, so we're done
mark_saving_dialog_done(startTime, nextAddress, totalBytesCompressed);
FileSystem.closeFile(openedFile);
if (!saveCancelled && alsoErase) {
conditionallyEraseFlash(maxBytes, nextAddress);
}
}
} else {
// There was an error with the received block (address didn't match the one we asked for), retry
Expand Down Expand Up @@ -582,7 +610,10 @@ onboard_logging.initialize = function (callback) {
flash_update_summary(function () {
if (CONFIGURATOR.connectionValid && !eraseCancelled) {
if (FC.DATAFLASH.ready) {
$(".dataflash-confirm-erase")[0].close();
const dialog = $(".dataflash-confirm-erase")[0];
if (dialog?.open) {
dialog.close();
}
if (getConfig("showNotifications").showNotifications) {
NotificationManager.showNotification("Betaflight Configurator", {
body: i18n.getMessage("flashEraseDoneNotification"),
Expand Down
4 changes: 3 additions & 1 deletion src/tabs/onboard_logging.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -110,8 +110,10 @@ <h3 i18n="dataflashSavingTitle"></h3>

<div class="dataflash-buttons">
<a class="regular-button erase-flash" href="#" i18n="dataflashButtonErase"></a>
<a class="regular-button require-msc-not-supported save-flash-erase" href="#" i18n="dataflashButtonSaveAndErase"></a>
<a class="regular-button require-msc-not-supported save-flash" href="#" i18n="dataflashButtonSaveFile"></a>
<a class="regular-button require-msc-supported save-flash" href="#"><span i18n="dataflashButtonSaveFileDeprecated"></span><span class="helpicon cf_tip" i18n_title="dataflashSaveFileDepreciationHint"></span></a>
<a class="regular-button require-msc-supported save-flash-erase" href="#" i18n="dataflashButtonSaveAndErase"></a>
<a class="regular-button require-msc-supported save-flash" href="#"><span i18n="dataflashButtonSaveFile"></span><span class="helpicon cf_tip" i18n_title="dataflashSaveFileDepreciationHint"></span></a>
<p i18n="dataflashSavetoFileNote"></p>
</div>
</div>
Expand Down