Add option for printing timestamp before each line of Serial Monitor

Author: BelKed

package.json

@@ -531,6 +531,11 @@
           "type": "boolean",
           "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": {
+          "type": "string",
+          "default": "",
+          "description": "Format of timestamp added before each line. List of all possible formats: https://strftime.org"
         }
       }
     },

src/arduino/arduinoSettings.ts

@@ -22,6 +22,7 @@ export interface IArduinoSettings {
     defaultBaudRate: number;
     preferences: Map<string, string>;
     useArduinoCli: boolean;
+    defaultTimestampFormat: string;
     reloadPreferences(): void;
 }
 
@@ -40,6 +41,8 @@ export class ArduinoSettings implements IArduinoSettings {
 
     private _useArduinoCli: boolean;
 
+    private _defaultTimestampFormat: string;
+
     public constructor() {
     }
 
@@ -49,6 +52,7 @@ export class ArduinoSettings implements IArduinoSettings {
         this._useArduinoCli = VscodeSettings.getInstance().useArduinoCli;
         await this.tryResolveArduinoPath();
         await this.tryGetDefaultBaudRate();
+        await this.tryGetDefaultTimestampFormat();
         if (platform === "win32") {
             await this.updateWindowsPath();
             if (this._commandPath === "") {
@@ -161,6 +165,10 @@ export class ArduinoSettings implements IArduinoSettings {
         return this._defaultBaudRate;
     }
 
+    public get defaultTimestampFormat() {
+        return this._defaultTimestampFormat;
+    }
+
     public reloadPreferences() {
         this._preferences = util.parseConfigFile(this.preferencePath);
         if (this.preferences.get("sketchbook.path")) {
@@ -234,4 +242,13 @@ export class ArduinoSettings implements IArduinoSettings {
             this._defaultBaudRate = configValue;
         }
     }
+
+    private async tryGetDefaultTimestampFormat(): Promise<void> {
+        const configValue = VscodeSettings.getInstance().defaultTimestampFormat;
+        if (!configValue) {
+            this._defaultTimestampFormat = "";
+        } else {
+            this._defaultTimestampFormat = configValue;
+        }
+    }
 }

src/arduino/vscodeSettings.ts

@@ -19,6 +19,7 @@ const configKeys = {
     DEFAULT_BAUD_RATE: "arduino.defaultBaudRate",
     USE_ARDUINO_CLI: "arduino.useArduinoCli",
     DISABLE_INTELLISENSE_AUTO_GEN: "arduino.disableIntelliSenseAutoGen",
+    TIMESTAMP_FORMAT: "arduino.timestampFormat",
 };
 
 export interface IVscodeSettings {
@@ -35,6 +36,7 @@ export interface IVscodeSettings {
     defaultBaudRate: number;
     useArduinoCli: boolean;
     disableIntelliSenseAutoGen: boolean;
+    defaultTimestampFormat: string;
     updateAdditionalUrls(urls: string[]): void;
 }
 
@@ -118,6 +120,10 @@ export class VscodeSettings implements IVscodeSettings {
         return this.getConfigValue<boolean>(configKeys.DISABLE_INTELLISENSE_AUTO_GEN);
     }
 
+    public get defaultTimestampFormat(): string {
+        return this.getConfigValue<string>(configKeys.TIMESTAMP_FORMAT);
+    }
+
     public async updateAdditionalUrls(value) {
         await this.setConfigValue(configKeys.ADDITIONAL_URLS, value, true);
     }

src/serialmonitor/serialMonitor.ts

@@ -23,6 +23,8 @@ export class SerialMonitor implements vscode.Disposable {
 
     public static DEFAULT_BAUD_RATE: number = 115200;
 
+    public static DEFAULT_TIMESTAMP_FORMAT: string = "";
+
     public static listBaudRates(): number[] {
         return [300, 1200, 2400, 4800, 9600, 19200, 38400, 57600, 74880, 115200, 230400, 250000, 500000, 1000000, 2000000];
     }
@@ -52,13 +54,21 @@ export class SerialMonitor implements vscode.Disposable {
 
     private _bufferedOutputChannel: BufferedOutputChannel;
 
+    private _timestampFormat: string;
+
     public initialize() {
         let defaultBaudRate;
         if (ArduinoContext.arduinoApp && ArduinoContext.arduinoApp.settings && ArduinoContext.arduinoApp.settings.defaultBaudRate) {
             defaultBaudRate = ArduinoContext.arduinoApp.settings.defaultBaudRate;
         } else {
             defaultBaudRate = SerialMonitor.DEFAULT_BAUD_RATE;
         }
+        let defaultTimestampFormat;
+        if (ArduinoContext.arduinoApp && ArduinoContext.arduinoApp.settings && ArduinoContext.arduinoApp.settings.defaultBaudRate) {
+            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;
@@ -154,6 +164,7 @@ export class SerialMonitor implements vscode.Disposable {
             this._serialPortCtrl = new SerialPortCtrl(
                 this._currentPort,
                 this._currentBaudRate,
+                this._timestampFormat,
                 this._bufferedOutputChannel,
                 this._outputChannel.show);
         }

src/serialmonitor/serialportctrl.ts

@@ -62,14 +62,17 @@ export class SerialPortCtrl {
   private _currentPort: string;
   private _currentBaudRate: number;
   private _currentSerialPort = null;
+  private _timestampFormat: string;
 
   public constructor(
       port: string,
       baudRate: number,
+      timestampFormat: string,
       private _bufferedOutputChannel: BufferedOutputChannel,
       private showOutputChannel: (preserveFocus?: boolean) => void) {
     this._currentBaudRate = baudRate;
     this._currentPort = port;
+    this._timestampFormat = timestampFormat;
   }
 
   /*
@@ -93,7 +96,7 @@ export class SerialPortCtrl {
 
     return new Promise((resolve, reject) => {
         this._child = spawn(SerialPortCtrl._serialCliPath,
-            ["open", this._currentPort, "-b", this._currentBaudRate.toString(), "--json"])
+            ["open", this._currentPort, "-b", this._currentBaudRate.toString(), "-t", this._timestampFormat, "--json"])
 
         this._child.on("error", (err) => {
             reject(err)