Skip to content
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

Jump to bottom

Adding support for CLI commands over an active MSP port. #4189

Merged
merged 3 commits into from
Oct 3, 2024
Merged

Adding support for CLI commands over an active MSP port. #4189

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
a3ca766
Adding support for CLI commands over MSP
blckmn Sep 29, 2024
fa3b4ed
Adding comment for magic number 4
blckmn Sep 29, 2024
4ba13b6
Remove $ prefix when sending cli command (STX is adequate)
blckmn Sep 30, 2024
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
76 changes: 68 additions & 8 deletions src/js/msp.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,12 +6,17 @@ let serial = serialShim();

const MSP = {
symbols: {
BEGIN: '$'.charCodeAt(0),
PROTO_V1: 'M'.charCodeAt(0),
PROTO_V2: 'X'.charCodeAt(0),
FROM_MWC: '>'.charCodeAt(0),
TO_MWC: '<'.charCodeAt(0),
UNSUPPORTED: '!'.charCodeAt(0),
BEGIN: '$'.charCodeAt(0),
PROTO_V1: 'M'.charCodeAt(0),
PROTO_V2: 'X'.charCodeAt(0),
FROM_MWC: '>'.charCodeAt(0),
TO_MWC: '<'.charCodeAt(0),
UNSUPPORTED: '!'.charCodeAt(0),
START_OF_TEXT: 0x02,
END_OF_TEXT: 0x03,
END_OF_TRANSMISSION: 0x04,
LINE_FEED: 0x0A,
CARRIAGE_RETURN: 0x0D,
},
constants: {
PROTOCOL_V1: 1,
Expand All @@ -37,6 +42,7 @@ const MSP = {
PAYLOAD_V2: 15,
CHECKSUM_V1: 16,
CHECKSUM_V2: 17,
CLI_COMMAND: 18,
},
state: 0,
message_direction: 1,
Expand All @@ -63,6 +69,10 @@ const MSP = {

JUMBO_FRAME_SIZE_LIMIT: 255,

cli_buffer: [], // buffer for CLI charactor output
cli_output: [],
cli_callback: null,

read(readInfo) {
if (CONFIGURATOR.virtualMode) {
return;
Expand All @@ -72,9 +82,37 @@ const MSP = {

for (const chunk of data) {
switch (this.state) {
case this.decoder_states.CLI_COMMAND:
switch (chunk) {
case this.symbols.END_OF_TEXT:
this.cli_output.push(this.cli_buffer.join(''));
this.cli_buffer.length = 0;
blckmn marked this conversation as resolved.
Show resolved Hide resolved
if (this.cli_callback) {
this.cli_callback(this.cli_output);
this.cli_output.length = 0;
}
this.state = this.decoder_states.IDLE;
break;
case this.symbols.LINE_FEED:
this.cli_output.push(this.cli_buffer.join(''));
this.cli_buffer.length = 0;
break;
case this.symbols.CARRIAGE_RETURN:
// ignore CRs
break;
default:
this.cli_buffer.push(String.fromCharCode(chunk));
break;
}
break;
case this.decoder_states.IDLE: // sync char 1
if (chunk === this.symbols.BEGIN) {
this.state = this.decoder_states.PROTO_IDENTIFIER;
switch (chunk) {
case this.symbols.BEGIN:
this.state = this.decoder_states.PROTO_IDENTIFIER;
break;
case this.symbols.START_OF_TEXT:
this.state = this.decoder_states.CLI_COMMAND;
break;
}
break;
case this.decoder_states.PROTO_IDENTIFIER: // sync char 2
Expand Down Expand Up @@ -305,6 +343,28 @@ const MSP = {
bufView[bufferSize - 1] = this.crc8_dvb_s2_data(bufView, 3, bufferSize - 1);
return bufferOut;
},
encode_message_cli(str) {
const data = Array.from(str, c => c.charCodeAt(0));
const dataLength = data ? data.length : 0;
const bufferSize = dataLength + 3; // 3 bytes for protocol overhead
const bufferOut = new ArrayBuffer(bufferSize);
const bufView = new Uint8Array(bufferOut);
bufView[0] = this.symbols.START_OF_TEXT; // STX
for (let ii = 0; ii < dataLength; ii++) {
bufView[1 + ii] = data[ii];
}
bufView[bufferSize - 2] = this.symbols.LINE_FEED; // LF
bufView[bufferSize - 1] = this.symbols.END_OF_TEXT; // ETX
return bufferOut;
},
send_cli_command(str, callback) {
serial = serialShim();

const bufferOut = this.encode_message_cli(str);
this.cli_callback = callback;

serial.send(bufferOut);
},
send_message(code, data, callback_sent, callback_msp, doCallbackOnError) {
// Hack to make BT work
serial = serialShim();
Expand Down