Skip to content

Commit

Permalink
Added warning when flashing unstable firmware.
Browse files Browse the repository at this point in the history
  • Loading branch information
@mikeller
mikeller committed Mar 19, 2020
1 parent 4eda5f8 commit 3146f02
Show file tree
Hide file tree
Showing 6 changed files with 183 additions and 82 deletions.
15 changes: 15 additions & 0 deletions locales/en/messages.json
View file
Original file line number Diff line number Diff line change
Expand Up @@ -68,6 +68,9 @@
"cancel": {
"message": "Cancel"
},
"cancel": {
"message": "Cancel"
},
"autoConnectEnabled": {
"message": "Auto-Connect: Enabled - Configurator automatically tries to connect when new port is detected"
},
Expand Down Expand Up @@ -2923,6 +2926,18 @@
"firmwareFlasherFlashTrigger": {
"message": "Detected: <strong>$1</strong> - triggering flash on connect"
},
"unstableFirmwareAcknoledgementDialog": {
"message": "You are about to flash a <strong>development build of the firmware</strong>. These builds are a work in progress, and any of the following can be the case:<strong><ul><li>the firmware does not work at all;</li><li>the firmware is not flyable;</li><li>there are safety issues with the firmware, for example flyaways</li><li>the firmware can cause the flight controller to become unresponsive, or damaged</li></ul></strong>If you proceed with flashing this firmware, <strong>you are assuming full responsibility for the risk of any of the above happening</strong>. Furthermore you acknowledge that it is necessary to perform <strong>thorough bench tests with props off</strong> before any attempts to fly this firmware."
},
"unstableFirmwareAcknoledgementAcknowledge": {
"message": "I have read the above and <strong>I assume full responsibility<strong> for flashing unstable firmware"
},
"unstableFirmwareAcknoledgementFlash": {
"message": "Flash"
},
"firmwareFlasherPreviousDevice": {
"message": "Detected: <strong>$1</strong> - previous device still flashing, please replug to try again"
},
"firmwareFlasherPreviousDevice": {
"message": "Detected: <strong>$1</strong> - previous device still flashing, please replug to try again"
},
Expand Down
42 changes: 42 additions & 0 deletions src/css/main.css
View file
Original file line number Diff line number Diff line change
Expand Up @@ -1044,6 +1044,48 @@ dialog {
border: 1px solid silver;
}

dialog .dialog_toolbar .btn a {
/* common styles for content toolbar buttons */
margin-top: 0px;
margin-bottom: 0px;
margin-right: 20px;
background-color: var(--accent);
border-radius: 3px;
border: 1px solid #dba718;
color: #000;
float: left;
font-weight: bold;
font-size: 12px;
text-shadow: 0px 1px rgba(255, 255, 255, 0.25);
display: block;
cursor: pointer;
transition: all ease 0.2s;
padding: 0px;
padding-left: 9px;
padding-right: 9px;
line-height: 28px;
}

dialog .dialog_toolbar .btn a:hover {
background-color: #ffcc3e;
transition: all ease 0.2s;
}

dialog .dialog_toolbar .btn a:active {
background-color: var(--accent);
transition: all ease 0.0s;
box-shadow: inset 0px 1px 5px rgba(0, 0, 0, 0.35);
}

dialog .dialog_toolbar .btn a.disabled {
cursor: default;
color: #fff;
background-color: #AFAFAF;
border: 1px solid #AFAFAF;
pointer-events: none;
text-shadow: none;
opacity: 0.5;
}
/* Border of the Tab */

/* Tab Title */
Expand Down
70 changes: 13 additions & 57 deletions src/css/tabs/firmware_flasher.css
View file
Original file line number Diff line number Diff line change
Expand Up @@ -192,63 +192,6 @@
text-decoration: underline;
}

.tab-firmware_flasher .buttons {
width: calc(100% - 20px);
margin-top: 10px;
bottom: 10px;
}

.tab-firmware_flasher .buttons a {
display: block;
float: left;
margin: 0 10px 0 0;
padding: 0 15px 0 15px;
height: 28px;
line-height: 28px;
text-align: center;
font-weight: bold;
border: 1px solid var(--subtleAccent);
background-color: #ececec;
}

.tab-firmware_flasher .buttons a:hover {
background-color: #dedcdc;
}

.tab-firmware_flasher .buttons a.exit_dfu.locked {
float: left;
background-color: #b8b8b8;
}

.tab-firmware_flasher .buttons a.exit_dfu.locked:hover {
float: left;
cursor: default;
background-color: #b8b8b8;
}

.tab-firmware_flasher .buttons a.flash_firmware.locked {
background-color: #b8b8b8;
}

.tab-firmware_flasher .buttons a.flash_firmware.locked:hover {
cursor: default;
background-color: #b8b8b8;
}

.tab-firmware_flasher .buttons a.load_remote_file.locked {
background-color: #b8b8b8;
}

.tab-firmware_flasher .buttons a.load_remote_file.locked:hover {
cursor: default;
background-color: #b8b8b8;
}

.tab-firmware_flasher .buttons .back {
float: right;
margin: 0;
}

.btn .disabled {
cursor: default;
color: #fff;
Expand All @@ -258,3 +201,16 @@
text-shadow: none;
opacity: 0.5;
}

#dialogUnstableFirmwareAcknoledgement .content {
margin-top: 10px;
}

#dialogUnstableFirmwareAcknoledgement .content div {
margin-bottom: 10px;
}

#dialogUnstableFirmwareAcknoledgement .content ul {
margin-top: 5px;
margin-bottom: 5px;
}
117 changes: 93 additions & 24 deletions src/js/tabs/firmware_flasher.js
View file
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,7 @@ TABS.firmware_flasher = {
unifiedTargetConfigName: undefined,
isConfigLocal: false, // Set to true if the user loads one locally
remoteUnifiedTargetConfig: undefined, // Unified target configuration loaded from the menu, used when throwing out a local config
developmentFirmwareLoaded: false, // Is the firmware to be flashed from the development branch?
};

TABS.firmware_flasher.initialize = function (callback) {
Expand Down Expand Up @@ -236,7 +237,7 @@ TABS.firmware_flasher.initialize = function (callback) {
var checkTime = Math.floor(Date.now() / 1000); // Lets deal in seconds.
if (builds && hasUnifiedTargetBuild(builds)) {
console.log('loaded some builds for later');
var storageTag = 'unifiedSourceCache';
const storageTag = 'unifiedSourceCache';
chrome.storage.local.get(storageTag, function (result) {
let storageObj = result[storageTag];
if(!storageObj || !storageObj.lastUpdate || checkTime - storageObj.lastUpdate > expirationPeriod ) {
Expand Down Expand Up @@ -350,7 +351,7 @@ TABS.firmware_flasher.initialize = function (callback) {
buildTypesToShow.forEach((build, index) => {
buildType_e.append($("<option value='{0}'>{1}</option>".format(index, build.tag ? i18n.getMessage(build.tag) : build.title)))
});
$('select[name="build_type"]').val($('select[name="build_type"] option:first').val());
buildType_e.val($('select[name="build_type"] option:first').val());
}

function showOrHideBuildTypes() {
Expand Down Expand Up @@ -583,7 +584,7 @@ TABS.firmware_flasher.initialize = function (callback) {
};

if (TABS.firmware_flasher.unifiedConfigs[target]) {
var storageTag = 'unifiedConfigLast';
const storageTag = 'unifiedConfigLast';
var expirationPeriod = 3600; // One of your earth hours.
var checkTime = Math.floor(Date.now() / 1000); // Lets deal in seconds.
chrome.storage.local.get(storageTag, function (result) {
Expand Down Expand Up @@ -814,7 +815,7 @@ TABS.firmware_flasher.initialize = function (callback) {
// UI Hooks
$('a.load_file').click(function () {
self.enableFlashing(false);
//self.localFileLoaded = true;
self.developmentFirmwareLoaded = false;

analytics.setFirmwareData(analytics.DATA.FIRMWARE_CHANNEL, undefined);
analytics.setFirmwareData(analytics.DATA.FIRMWARE_SOURCE, 'file');
Expand Down Expand Up @@ -910,6 +911,9 @@ TABS.firmware_flasher.initialize = function (callback) {
FirmwareCache.get(release, cached => {
analytics.setFirmwareData(analytics.DATA.FIRMWARE_NAME, release.file);
console.info("Release found in cache: " + release.file);

self.developmentFirmwareLoaded = buildTypesToShow[$('select[name="build_type"]').val()].tag === 'firmwareFlasherOptionLabelBuildTypeDevelopment';

onLoadSuccess(cached.hexdata, release);
});
}
Expand All @@ -923,6 +927,7 @@ TABS.firmware_flasher.initialize = function (callback) {
$('a.load_remote_file').click(function (evt) {
self.enableFlashing(false);
self.localFirmwareLoaded = false;
self.developmentFirmwareLoaded = buildTypesToShow[$('select[name="build_type"]').val()].tag === 'firmwareFlasherOptionLabelBuildTypeDevelopment';

analytics.setFirmwareData(analytics.DATA.FIRMWARE_SOURCE, 'http');

Expand Down Expand Up @@ -984,33 +989,97 @@ TABS.firmware_flasher.initialize = function (callback) {

$('a.flash_firmware').click(function () {
if (!$(this).hasClass('disabled')) {
if (!GUI.connect_lock) { // button disabled while flashing is in progress
if (self.parsed_hex) {
try {
if (self.unifiedTargetConfig && !self.parsed_hex.configInserted) {
var configInserter = new ConfigInserter();
if (self.developmentFirmwareLoaded) {
checkShowAcknowledgementDialog();
} else {
startFlashing();
}
}
});

if (configInserter.insertConfig(self.parsed_hex, self.unifiedTargetConfig)) {
self.parsed_hex.configInserted = true;
} else {
console.log('Firmware does not support custom defaults.');
function checkShowAcknowledgementDialog() {
const DAY_MS = 86400 * 1000;
const storageTag = 'lastDevelopmentWarningTimestamp';

self.unifiedTargetConfig = undefined;
self.unifiedTargetConfigName = undefined;
}
}
function setAcknowledgementTimestamp() {
const storageObj = {};
storageObj[storageTag] = Date.now();
chrome.storage.local.set(storageObj);
}

chrome.storage.local.get(storageTag, function (result) {
if (!result[storageTag] || Date.now() - result[storageTag] > DAY_MS) {

showAcknowledgementDialog(setAcknowledgementTimestamp);
} else {
startFlashing();
}
});
}

function showAcknowledgementDialog(acknowledgementCallback) {
const dialog = $('#dialogUnstableFirmwareAcknoledgement')[0];
const flashButtonElement = $('#dialogUnstableFirmwareAcknoledgement-flashbtn');
const acknowledgeCheckboxElement = $('input[name="dialogUnstableFirmwareAcknoledgement-acknowledge"]');

acknowledgeCheckboxElement.change(function () {
if ($(this).is(':checked')) {
flashButtonElement.removeClass('disabled');
} else {
flashButtonElement.addClass('disabled');
}
});

flashButtonElement.click(function() {
dialog.close();

flashFirmware(self.parsed_hex);
} catch (e) {
console.log(`Flashing failed: ${e.message}`);
if (acknowledgeCheckboxElement.is(':checked')) {
if (acknowledgementCallback) {
acknowledgementCallback();
}

startFlashing();
}
});

$('#dialogUnstableFirmwareAcknoledgement-cancelbtn').click(function() {
dialog.close();
});

dialog.addEventListener('close', function () {
acknowledgeCheckboxElement.prop('checked', false).change();
});

dialog.showModal();
}

function startFlashing() {
if (!GUI.connect_lock) { // button disabled while flashing is in progress
if (self.parsed_hex) {
try {
if (self.unifiedTargetConfig && !self.parsed_hex.configInserted) {
var configInserter = new ConfigInserter();

if (configInserter.insertConfig(self.parsed_hex, self.unifiedTargetConfig)) {
self.parsed_hex.configInserted = true;
} else {
console.log('Firmware does not support custom defaults.');

self.unifiedTargetConfig = undefined;
self.unifiedTargetConfigName = undefined;
}
}
} else {
$('span.progressLabel').attr('i18n','firmwareFlasherFirmwareNotLoaded').removeClass('i18n-replaced');
i18n.localizePage();

flashFirmware(self.parsed_hex);
} catch (e) {
console.log(`Flashing failed: ${e.message}`);
}
} else {
$('span.progressLabel').attr('i18n','firmwareFlasherFirmwareNotLoaded').removeClass('i18n-replaced');
i18n.localizePage();
}
}
});
}

$('span.progressLabel a.save_firmware').click(function () {
var summary = $('select[name="firmware_version"] option:selected').data('summary');
Expand Down
2 changes: 1 addition & 1 deletion src/js/tabs/pid_tuning.js
View file
Original file line number Diff line number Diff line change
Expand Up @@ -1145,7 +1145,7 @@ TABS.pid_tuning.initialize = function (callback) {
showAllPids();
updatePidDisplay();

showAllButton.on('click', function(){
showAllButton.on('click', function() {
self.showAllPids = !self.showAllPids;

updatePidDisplay();
Expand Down
19 changes: 19 additions & 0 deletions src/tabs/firmware_flasher.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -151,4 +151,23 @@
<a class="load_file" href="#" i18n="firmwareFlasherButtonLoadLocal"></a>
</div>
</div>

<dialog id="dialogUnstableFirmwareAcknoledgement">
<h3 i18n="warningTitle"></h3>
<div class="content">
<div i18n="unstableFirmwareAcknoledgementDialog"></div>
<div>
<input name="dialogUnstableFirmwareAcknoledgement-acknowledge" class="togglesmall" type="checkbox"/>
<span i18n="unstableFirmwareAcknoledgementAcknowledge"></span>
</div>
</div>
<div class="dialog_toolbar">
<div class="btn">
<a class="disabled" href="#" id="dialogUnstableFirmwareAcknoledgement-flashbtn" class="regular-button" i18n="unstableFirmwareAcknoledgementFlash"></a>
</div>
<div class="btn">
<a href="#" id="dialogUnstableFirmwareAcknoledgement-cancelbtn" class="regular-button" i18n="cancel"></a>
</div>
</div>
</dialog>
</div>

0 comments on commit 3146f02

Please sign in to comment.