Mirror/inav-configurator
1
0
Fork 0
mirror of https://github.com/iNavFlight/inav-configurator.git synced 2025-07-16 04:45:18 +03:00
Code Wiki Activity

Rebase CLI tab on latest CF

Browse source 
Integrates Save to File and Clear Output buttons, plus some minor
iNav compatibility patches
This commit is contained in:
Niccolò Maggioni 2018-11-29 14:26:02 +01:00
parent 66e43c0603
commit a340443c43
No known key found for this signature in database
GPG key ID: 4874B0C841E33264
8 changed files with 324 additions and 106 deletions
Download patch file Download diff file Expand all files Collapse all files

15
_locales/en/messages.json
View file

@ -1441,6 +1441,21 @@
"cliReboot": {
"message": "CLI reboot detected"
},
"cliSaveToFileBtn": {
"message": "Save to File"
},
"cliSaveToFileFailed": {
"message": "Failed to save CLI output to file"
},
"cliSaveToFileAborted": {
"message": "Saving CLI output to file was aborted"
},
"cliSaveToFileCompleted": {
"message": "CLI output successfully saved to file"
},
"cliClearOutputHistoryBtn": {
"message": "Clear output history"
},
"loggingNote": {
"message": "Data will be logged in this tab <span style=\"color: red\">only</span>, leaving the tab will <span style=\"color: red\">cancel</span> logging and application will return to its normal <strong>\"configurator\"</strong> state.<br /> You are free to select the global update period, data will be written into the log file every <strong>1</strong> second for performance reasons."

3
js/fc.js
View file

@ -103,7 +103,8 @@ var FC = {
battery_profile: 0,
uid: [0, 0, 0],
accelerometerTrims: [0, 0],
armingFlags: 0
armingFlags: 0,
name: ''
};
BF_CONFIG = {

33
js/helpers.js
View file

@ -13,3 +13,36 @@ function constrain(input, min, max) {
return input;
}
function zeroPad(value, width) {
value = "" + value;
while (value.length < width) {
value = "0" + value;
}
return value;
}
function generateFilename(prefix, suffix) {
var date = new Date();
var filename = prefix;
if (CONFIG) {
if (CONFIG.flightControllerIdentifier) {
filename = CONFIG.flightControllerIdentifier + '_' + filename;
}
if (CONFIG.name && CONFIG.name.trim() !== '') {
filename = filename + '_' + CONFIG.name.trim().replace(' ', '_');
}
}
filename = filename + '_' + date.getFullYear()
+ zeroPad(date.getMonth() + 1, 2)
+ zeroPad(date.getDate(), 2)
+ '_' + zeroPad(date.getHours(), 2)
+ zeroPad(date.getMinutes(), 2)
+ zeroPad(date.getSeconds(), 2);
return filename + '.' + suffix;
}

5
js/msp/MSPHelper.js
View file

@ -1341,6 +1341,11 @@ var mspHelper = (function (gui) {
console.log('OSD char uploaded');
break;
case MSPCodes.MSP_NAME:
CONFIG.name = '';
var char;
while ((char = data.readU8()) !== null) {
CONFIG.name += String.fromCharCode(char);
}
break;
case MSPCodes.MSP_SET_NAME:
console.log("Craft name set");

5
js/serial_backend.js
View file

@ -306,7 +306,12 @@ function onOpen(openInfo) {
googleAnalytics.sendEvent('Firmware', 'Variant', CONFIG.flightControllerIdentifier + ',' + CONFIG.flightControllerVersion);
GUI.log(chrome.i18n.getMessage('fcInfoReceived', [CONFIG.flightControllerIdentifier, CONFIG.flightControllerVersion]));
if (semver.gte(CONFIG.flightControllerVersion, CONFIGURATOR.firmwareVersionAccepted)) {
mspHelper.getCraftName(function(name) {
if (name) {
CONFIG.name = name;
}
onValidFirmware();
});
} else {
onInvalidFirmwareVersion();
}

7
tabs/cli.html
View file

@ -5,6 +5,7 @@
<p i18n="cliInfo"></p>
</div>
</div>
<div class="backdrop">
<div class="window">
<div class="wrapper"></div>
@ -12,4 +13,10 @@
</div>
<textarea name="commands" i18n_placeholder="cliInputPlaceholder" rows="1" cols="0"></textarea>
</div>
<div class="content_toolbar">
<div class="btn save_btn pull-right">
<a class="save" href="#" i18n="cliSaveToFileBtn"></a>
<a class="clear" href="#" i18n="cliClearOutputHistoryBtn"></a>
</div>
</div>
</div>

292
tabs/cli.js
View file

@ -1,11 +1,46 @@
'use strict';
/*global chrome*/
TABS.cli = {
'validateText': "",
'currentLine': "",
'sequenceElements': 0
lineDelayMs: 15,
profileSwitchDelayMs: 100,
outputHistory: "",
cliBuffer: ""
};
function removePromptHash(promptText) {
return promptText.replace(/^# /, '');
}
function cliBufferCharsToDelete(command, buffer) {
var commonChars = 0;
for (var i = 0;i < buffer.length;i++) {
if (command[i] === buffer[i]) {
commonChars++;
} else {
break;
}
}
return buffer.length - commonChars;
}
function commandWithBackSpaces(command, buffer, noOfCharsToDelete) {
const backspace = String.fromCharCode(127);
return backspace.repeat(noOfCharsToDelete) + command.substring(buffer.length - noOfCharsToDelete, command.length);
}
function getCliCommand(command, cliBuffer) {
const buffer = removePromptHash(cliBuffer);
const bufferRegex = new RegExp('^' + buffer, 'g');
if (command.match(bufferRegex)) {
return command.replace(bufferRegex, '');
}
const noOfCharsToDelete = cliBufferCharsToDelete(command, buffer);
return commandWithBackSpaces(command, buffer, noOfCharsToDelete);
}
TABS.cli.initialize = function (callback) {
var self = this;
@ -14,11 +49,8 @@ TABS.cli.initialize = function (callback) {
googleAnalytics.sendAppView('CLI');
}
/*
* Flush MSP queue as well as all MSP registered callbacks
*/
helper.mspQueue.flush();
MSP.callbacks_cleanup();
self.outputHistory = "";
self.cliBuffer = "";
$('#content').load("./tabs/cli.html", function () {
// translate to user-selected language
@ -28,18 +60,101 @@ TABS.cli.initialize = function (callback) {
var textarea = $('.tab-cli textarea');
$('.tab-cli .save').click(function() {
var prefix = 'cli';
var suffix = 'txt';
var filename = generateFilename(prefix, suffix);
var accepts = [{
description: suffix.toUpperCase() + ' files', extensions: [suffix],
}];
chrome.fileSystem.chooseEntry({type: 'saveFile', suggestedName: filename, accepts: accepts}, function(entry) {
if (chrome.runtime.lastError) {
if (chrome.runtime.lastError.message === 'User cancelled') {
GUI.log(chrome.i18n.getMessage('cliSaveToFileAborted'));
} else {
GUI.log(chrome.i18n.getMessage('cliSaveToFileFailed'));
console.error(chrome.runtime.lastError.message);
}
return;
}
if (!entry) {
GUI.log(chrome.i18n.getMessage('cliSaveToFileAborted'));
return;
}
entry.createWriter(function (writer) {
writer.onerror = function (){
GUI.log(chrome.i18n.getMessage('cliSaveToFileFailed'));
};
writer.onwriteend = function () {
if (self.outputHistory.length > 0 && writer.length === 0) {
writer.write(new Blob([self.outputHistory], {type: 'text/plain'}));
} else {
GUI.log(chrome.i18n.getMessage('cliSaveToFileCompleted'));
}
};
writer.truncate(0);
}, function (){
GUI.log(chrome.i18n.getMessage('cliSaveToFileFailed'));
console.error('Failed to get file writer');
});
});
});
$('.tab-cli .clear').click(function() {
self.outputHistory = "";
$('.tab-cli .window .wrapper').empty();
});
// Tab key detection must be on keydown,
// `keypress`/`keyup` happens too late, as `textarea` will have already lost focus.
textarea.keydown(function (event) {
const tabKeyCode = 9;
if (event.which == tabKeyCode) {
// prevent default tabbing behaviour
event.preventDefault();
const outString = textarea.val();
const lastCommand = outString.split("\n").pop();
const command = getCliCommand(lastCommand, self.cliBuffer);
if (command) {
self.sendAutoComplete(command);
textarea.val('');
}
}
});
textarea.keypress(function (event) {
if (event.which == 13) { // enter
const enterKeyCode = 13;
if (event.which == enterKeyCode) {
event.preventDefault(); // prevent the adding of new line
var out_string = textarea.val();
var out_arr = out_string.split("\n");
self.history.add(out_string.trim());
var timeout_needle = 0;
for (var i = 0; i < out_arr.length; i++) {
self.sendSlowly(out_arr, i, timeout_needle++);
var outputArray = out_string.split("\n");
Promise.reduce(outputArray, function(delay, line, index) {
return new Promise(function (resolve) {
helper.timeout.add('CLI_send_slowly', function () {
var processingDelay = self.lineDelayMs;
if (line.toLowerCase().startsWith('profile')) {
processingDelay = self.profileSwitchDelayMs;
}
const isLastCommand = outputArray.length === index + 1;
if (isLastCommand && self.cliBuffer) {
line = getCliCommand(line, self.cliBuffer);
}
self.sendLine(line, function () {
resolve(processingDelay);
});
}, delay)
})
}, 0);
textarea.val('');
}
@ -84,29 +199,33 @@ TABS.cli.history.add = function (str) {
this.history.push(str);
this.index = this.history.length;
};
TABS.cli.history.prev = function () {
if (this.index > 0) this.index -= 1;
return this.history[this.index];
};
TABS.cli.history.next = function () {
if (this.index < this.history.length) this.index += 1;
return this.history[this.index - 1];
};
TABS.cli.sendSlowly = function (out_arr, i, timeout_needle) {
helper.timeout.add('CLI_send_slowly', function () {
var bufferOut = new ArrayBuffer(out_arr[i].length + 1);
var bufView = new Uint8Array(bufferOut);
const backspaceCode = 8;
const lineFeedCode = 10;
const carriageReturnCode = 13;
for (var c_key = 0; c_key < out_arr[i].length; c_key++) {
bufView[c_key] = out_arr[i].charCodeAt(c_key);
}
function writeToOutput(text) {
$('.tab-cli .window .wrapper').append(text);
$('.tab-cli .window').scrollTop($('.tab-cli .window .wrapper').height());
}
bufView[out_arr[i].length] = 0x0D; // enter (\n)
function writeLineToOutput(text) {
writeToOutput(text + "<br>");
}
serial.send(bufferOut);
}, timeout_needle * 100);
};
function setPrompt(text) {
$('.tab-cli textarea').val(text);
}
TABS.cli.read = function (readInfo) {
/* Some info about handling line feeds and carriage return
@ -117,93 +236,122 @@ TABS.cli.read = function (readInfo) {
MAC only understands CR
Linux and Unix only understand LF
Windows understands (both) CRLF
Chrome OS currenty unknown
Chrome OS currently unknown
*/
var data = new Uint8Array(readInfo.data),
text = "";
validateText = "",
sequenceCharsToSkip = 0;
for (var i = 0; i < data.length; i++) {
if (CONFIGURATOR.cliValid) {
if (data[i] == 27 || this.sequenceElements > 0) { // ESC + other
this.sequenceElements++;
const currentChar = String.fromCharCode(data[i]);
// delete previous space
if (this.sequenceElements == 1) {
text = text.substring(0, text.length -1);
if (!CONFIGURATOR.cliValid) {
// try to catch part of valid CLI enter message
validateText += currentChar;
writeToOutput(currentChar);
continue;
}
// Reset
if (this.sequenceElements >= 5) {
this.sequenceElements = 0;
}
const escapeSequenceCode = 27;
const escapeSequenceCharLength = 3;
if (data[i] == escapeSequenceCode && !sequenceCharsToSkip) { // ESC + other
sequenceCharsToSkip = escapeSequenceCharLength;
}
if (sequenceCharsToSkip) {
sequenceCharsToSkip--;
continue;
}
if (this.sequenceElements == 0) {
switch (data[i]) {
case 10: // line feed
if (GUI.operating_system != "MacOS") {
text += "<br />";
case lineFeedCode:
if (GUI.operating_system === "Windows") {
writeLineToOutput(this.cliBuffer);
this.cliBuffer = "";
}
this.currentLine = "";
break;
case 13: // carriage return
if (GUI.operating_system == "MacOS") {
text += "<br />";
case carriageReturnCode:
if (GUI.operating_system !== "Windows") {
writeLineToOutput(this.cliBuffer);
this.cliBuffer = "";
}
this.currentLine = "";
break;
case 60:
text += '&lt';
this.cliBuffer += '&lt';
break;
case 62:
text += '&gt';
this.cliBuffer += '&gt';
break;
case backspaceCode:
this.cliBuffer = this.cliBuffer.slice(0, -1);
break;
default:
text += String.fromCharCode(data[i]);
this.currentLine += String.fromCharCode(data[i]);
this.cliBuffer += currentChar;
}
}
if (this.currentLine == 'Rebooting') {
this.outputHistory += currentChar;
if (this.cliBuffer == 'Rebooting') {
CONFIGURATOR.cliActive = false;
CONFIGURATOR.cliValid = false;
GUI.log(chrome.i18n.getMessage('cliReboot'));
GUI.log(chrome.i18n.getMessage('deviceRebooting'));
GUI.handleReconnect();
}
if (BOARD.find_board_definition(CONFIG.boardIdentifier).vcp) { // VCP-based flight controls may crash old drivers, we catch and reconnect
$('a.connect').click();
helper.timeout.add('start_connection', function start_connection() {
$('a.connect').click();
}, 2500);
} else {
// try to catch part of valid CLI enter message
this.validateText += String.fromCharCode(data[i]);
text += String.fromCharCode(data[i]);
helper.timeout.add('waiting_for_bootup', function waiting_for_bootup() {
MSP.send_message(MSPCodes.MSP_STATUS, false, false, function () {
GUI.log(chrome.i18n.getMessage('deviceReady'));
if (!GUI.tab_switch_in_progress) {
$('#tabs ul.mode-connected .tab_setup a').click();
}
});
}, 1500); // 1500 ms seems to be just the right amount of delay to prevent data request timeouts
}
}
if (!CONFIGURATOR.cliValid && this.validateText.indexOf('CLI') != -1) {
}
if (!CONFIGURATOR.cliValid && validateText.indexOf('CLI') !== -1) {
GUI.log(chrome.i18n.getMessage('cliEnter'));
CONFIGURATOR.cliValid = true;
this.validateText = "";
validateText = "";
}
$('.tab-cli .window .wrapper').append(text);
$('.tab-cli .window').scrollTop($('.tab-cli .window .wrapper').height());
setPrompt(removePromptHash(this.cliBuffer));
};
TABS.cli.sendLine = function (line, callback) {
this.send(line + '\n', callback);
};
TABS.cli.sendAutoComplete = function (line, callback) {
this.send(line + '\t', callback);
};
TABS.cli.send = function (line, callback) {
var bufferOut = new ArrayBuffer(line.length);
var bufView = new Uint8Array(bufferOut);
for (var c_key = 0; c_key < line.length; c_key++) {
bufView[c_key] = line.charCodeAt(c_key);
}
serial.send(bufferOut, callback);
};
TABS.cli.cleanup = function (callback) {
if (!CONFIGURATOR.connectionValid || !CONFIGURATOR.cliValid) {
if (!(CONFIGURATOR.connectionValid && CONFIGURATOR.cliValid && CONFIGURATOR.cliActive)) {
if (callback) callback();
return;
}
var bufferOut = new ArrayBuffer(5);
var bufView = new Uint8Array(bufferOut);
bufView[0] = 0x65; // e
bufView[1] = 0x78; // x
bufView[2] = 0x69; // i
bufView[3] = 0x74; // t
bufView[4] = 0x0D; // enter
serial.send(bufferOut, function (writeInfo) {
this.send(getCliCommand('exit\r', this.cliBuffer), function (writeInfo) {
// we could handle this "nicely", but this will do for now
// (another approach is however much more complicated):
// we can setup an interval asking for data lets say every 200ms, when data arrives, callback will be triggered and tab switched

4
tabs/configuration.js
View file

@ -12,10 +12,14 @@ TABS.configuration.initialize = function (callback, scrollPosition) {
var craftName = null;
var loadCraftName = function(callback) {
if (!CONFIG.name || CONFIG.name.trim() === '') {
mspHelper.getCraftName(function(name) {
craftName = name;
callback();
});
} else {
callback();
}
};
var saveCraftName = function(callback) {