Add arduino.changeTimestampFormat command

Author: BelKed

package.json

@@ -44,6 +44,7 @@
     "onCommand:arduino.selectSerialPort",
     "onCommand:arduino.selectSketch",
     "onCommand:arduino.changeBaudRate",
+    "onCommand:arduino.changeTimestampFormat",
     "onCommand:arduino.openSerialMonitor",
     "onCommand:arduino.sendMessageToSerialPort",
     "onCommand:arduino.closeSerialMonitor",
@@ -128,6 +129,10 @@
         "command": "arduino.changeBaudRate",
         "title": "Arduino: Change Baud Rate"
       },
+      {
+        "command": "arduino.changeTimestampFormat",
+        "title": "Arduino: Change Timestamp Format"
+      },
       {
         "command": "arduino.openSerialMonitor",
         "title": "Arduino: Open Serial Monitor"
@@ -532,7 +537,7 @@
           "default": false,
           "description": "When disabled vscode-arduino will not auto-generate an IntelliSense configuration (i.e. c_cpp_properties.json) by analyzing the compiler output."
         },
-        "arduino.timestampFormat": {
+        "arduino.defaultTimestampFormat": {
           "type": "string",
           "default": "",
           "description": "Format of timestamp added before each line. List of all possible formats: https://strftime.org"

src/arduino/vscodeSettings.ts

@@ -19,7 +19,7 @@ const configKeys = {
     DEFAULT_BAUD_RATE: "arduino.defaultBaudRate",
     USE_ARDUINO_CLI: "arduino.useArduinoCli",
     DISABLE_INTELLISENSE_AUTO_GEN: "arduino.disableIntelliSenseAutoGen",
-    TIMESTAMP_FORMAT: "arduino.timestampFormat",
+    DEFAULT_TIMESTAMP_FORMAT: "arduino.defaultTimestampFormat",
 };
 
 export interface IVscodeSettings {
@@ -121,7 +121,7 @@ export class VscodeSettings implements IVscodeSettings {
     }
 
     public get defaultTimestampFormat(): string {
-        return this.getConfigValue<string>(configKeys.TIMESTAMP_FORMAT);
+        return this.getConfigValue<string>(configKeys.DEFAULT_TIMESTAMP_FORMAT);
     }
 
     public async updateAdditionalUrls(value) {

src/common/constants.ts

@@ -47,4 +47,5 @@ export const statusBarPriority = {
     ENDING: 70,
     SKETCH: 80,
     PROGRAMMER: 90,
+    TIMESTAMP_FORMAT: 100,
 };

src/extension.ts

@@ -284,6 +284,7 @@ export async function activate(context: vscode.ExtensionContext) {
     registerNonArduinoCommand("arduino.selectSerialPort", () => serialMonitor.selectSerialPort(null, null));
     registerNonArduinoCommand("arduino.openSerialMonitor", () => serialMonitor.openSerialMonitor());
     registerNonArduinoCommand("arduino.changeBaudRate", () => serialMonitor.changeBaudRate());
+    registerNonArduinoCommand("arduino.changeTimestampFormat", () => serialMonitor.changeTimestampFormat());
     registerNonArduinoCommand("arduino.sendMessageToSerialPort", () => serialMonitor.sendMessageToSerialPort());
     registerNonArduinoCommand("arduino.closeSerialMonitor", (port, showWarning = true) => serialMonitor.closeSerialMonitor(port, showWarning));
 

src/serialmonitor/serialMonitor.ts

@@ -42,19 +42,22 @@ export class SerialMonitor implements vscode.Disposable {
 
     private _currentBaudRate: number;
 
+    private _currentTimestampFormat: string;
+
     private _portsStatusBar: vscode.StatusBarItem;
 
     private _openPortStatusBar: vscode.StatusBarItem;
 
     private _baudRateStatusBar: vscode.StatusBarItem;
 
+    private _timestampFormatStatusBar: vscode.StatusBarItem;
+
     private _serialPortCtrl: SerialPortCtrl = null;
 
     private _outputChannel: vscode.OutputChannel;
 
     private _bufferedOutputChannel: BufferedOutputChannel;
 
-    private _timestampFormat: string;
 
     public initialize() {
         let defaultBaudRate;
@@ -64,15 +67,15 @@ export class SerialMonitor implements vscode.Disposable {
             defaultBaudRate = SerialMonitor.DEFAULT_BAUD_RATE;
         }
         let defaultTimestampFormat;
-        if (ArduinoContext.arduinoApp && ArduinoContext.arduinoApp.settings && ArduinoContext.arduinoApp.settings.defaultBaudRate) {
+        if (ArduinoContext.arduinoApp && ArduinoContext.arduinoApp.settings && ArduinoContext.arduinoApp.settings.defaultTimestampFormat) {
             defaultTimestampFormat = ArduinoContext.arduinoApp.settings.defaultTimestampFormat;
         } else {
             defaultTimestampFormat = SerialMonitor.DEFAULT_TIMESTAMP_FORMAT;
         }
         this._outputChannel = vscode.window.createOutputChannel(SerialMonitor.SERIAL_MONITOR);
         this._bufferedOutputChannel = new BufferedOutputChannel(this._outputChannel.append, 300);
         this._currentBaudRate = defaultBaudRate;
-        this._timestampFormat = defaultTimestampFormat;
+        this._currentTimestampFormat = defaultTimestampFormat;
         this._portsStatusBar = vscode.window.createStatusBarItem(vscode.StatusBarAlignment.Right, constants.statusBarPriority.PORT);
         this._portsStatusBar.command = "arduino.selectSerialPort";
         this._portsStatusBar.tooltip = "Select Serial Port";
@@ -88,6 +91,11 @@ export class SerialMonitor implements vscode.Disposable {
         this._baudRateStatusBar.command = "arduino.changeBaudRate";
         this._baudRateStatusBar.tooltip = "Baud Rate";
         this._baudRateStatusBar.text = defaultBaudRate.toString();
+
+        this._timestampFormatStatusBar = vscode.window.createStatusBarItem(vscode.StatusBarAlignment.Right, constants.statusBarPriority.TIMESTAMP_FORMAT);
+        this._timestampFormatStatusBar.command = "arduino.changeTimestampFormat";
+        this._timestampFormatStatusBar.tooltip = "Timestamp Format";
+        this._timestampFormatStatusBar.text = defaultTimestampFormat;
         this.updatePortListStatus();
 
         const dc = DeviceContext.getInstance();
@@ -165,7 +173,7 @@ export class SerialMonitor implements vscode.Disposable {
             this._serialPortCtrl = new SerialPortCtrl(
                 this._currentPort,
                 this._currentBaudRate,
-                this._timestampFormat,
+                this._currentTimestampFormat,
                 this._bufferedOutputChannel,
                 this._outputChannel.show);
         }
@@ -218,6 +226,13 @@ export class SerialMonitor implements vscode.Disposable {
         this._baudRateStatusBar.text = chosen;
     }
 
+    public async changeTimestampFormat() {
+        const timestampFormat = await vscode.window.showInputBox();
+        await this._serialPortCtrl.changeTimestampFormat(timestampFormat);
+        this._currentTimestampFormat = timestampFormat;
+        this._timestampFormatStatusBar.text = timestampFormat;
+    }
+
     public async closeSerialMonitor(port: string, showWarning: boolean = true): Promise<boolean> {
         if (this._serialPortCtrl) {
             if (port && port !== this._serialPortCtrl.currentPort) {

src/serialmonitor/serialportctrl.ts

@@ -62,7 +62,7 @@ export class SerialPortCtrl {
   private _currentPort: string;
   private _currentBaudRate: number;
   private _currentSerialPort = null;
-  private _timestampFormat: string;
+  private _currentTimestampFormat: string;
 
   public constructor(
       port: string,
@@ -72,7 +72,7 @@ export class SerialPortCtrl {
       private showOutputChannel: (preserveFocus?: boolean) => void) {
     this._currentBaudRate = baudRate;
     this._currentPort = port;
-    this._timestampFormat = timestampFormat;
+    this._currentTimestampFormat = timestampFormat;
   }
 
   /*
@@ -96,7 +96,7 @@ export class SerialPortCtrl {
 
     return new Promise((resolve, reject) => {
         this._child = spawn(SerialPortCtrl._serialCliPath,
-            ["open", this._currentPort, "-b", this._currentBaudRate.toString(), "-t", this._timestampFormat, "--json"])
+            ["open", this._currentPort, "-b", this._currentBaudRate.toString(), "-t", this._currentTimestampFormat, "--json"])
 
         this._child.on("error", (err) => {
             reject(err)
@@ -192,4 +192,22 @@ export class SerialPortCtrl {
         }
     });
   }
+
+  public changeTimestampFormat(newTimestampFormat: string): Promise<void> {
+    return new Promise((resolve, reject) => {
+      this._currentTimestampFormat = newTimestampFormat;
+      if (!this._child || !this.isActive) {
+        resolve();
+        return;
+      } else {
+            try {
+                this.stop();
+                this.open();
+                resolve();
+            } catch (error) {
+                reject(error);
+            }
+        }
+    });
+  }
 }

test/extension.test.ts

@@ -48,6 +48,7 @@ suite("Arduino: Extension Tests", () => {
                     "arduino.selectSerialPort",
                     "arduino.openSerialMonitor",
                     "arduino.changeBaudRate",
+                    "arduino.changeTimestampFormat",
                     "arduino.sendMessageToSerialPort",
                     "arduino.closeSerialMonitor",
                     "arduino.reloadExample",