Merge pull request #1430 from BelKed/serial-timestamp

Add option for printing timestamp before each line of Serial Monitor output

Author: gcampbell-msft

README.md

@@ -47,6 +47,7 @@ This extension provides several commands in the Command Palette (<kbd>F1</kbd> o
 - **Arduino: Board Manager**: Manage packages for boards. You can add 3rd party Arduino board by configuring `Additional Board Manager URLs` in the board manager.
 - **Arduino: Change Baud Rate**: Change the baud rate of the selected serial port.
 - **Arduino: Change Board Type**: Change board type or platform.
+- **Arduino: Change Timestamp Format**: Change format of timestamp printed before each line of Serial Monitor output.
 - **Arduino: Close Serial Monitor**: Stop the serial monitor and release the serial port.
 - **Arduino: Examples**: Show list of examples.
 - **Arduino: Initialize**: Scaffold a VS Code project with an Arduino sketch.
@@ -79,6 +80,7 @@ This extension provides several commands in the Command Palette (<kbd>F1</kbd> o
 | `arduino.disableTestingOpen` | Enable/disable automatic sending of a test message to the serial port for checking the open status. The default value is `false` (a test message will be sent). |
 | `arduino.skipHeaderProvider` | Enable/disable the extension providing completion items for headers. This functionality is included in newer versions of the C++ extension. The default value is `false`.|
 | `arduino.defaultBaudRate` | Default baud rate for the serial port monitor. The default value is 115200. Supported values are 300, 1200, 2400, 4800, 9600, 19200, 38400, 57600, 74880, 115200, 230400 and 250000 |
+| `arduino.defaultTimestampFormat` | Format of timestamp printed before each line of Serial Monitor output. You can find list of all available placeholders [here](https://strftime.org). |
 | `arduino.disableIntelliSenseAutoGen` | When `true` vscode-arduino will not auto-generate an IntelliSense configuration (i.e. `.vscode/c_cpp_properties.json`) by analyzing Arduino's compiler output. |
 
 The following Visual Studio Code settings are available for the Arduino extension. These can be set in global user preferences <kbd>Ctrl</kbd> + <kbd>,</kbd> or workspace settings (`.vscode/settings.json`). The latter overrides the former.

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"
@@ -531,6 +536,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.defaultTimestampFormat": {
+          "type": "string",
+          "default": "",
+          "markdownDescription": "Format of timestamp printed before each line of Serial Monitor output. You can find list of all available placeholders [here](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",
+    DEFAULT_TIMESTAMP_FORMAT: "arduino.defaultTimestampFormat",
 };
 
 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.DEFAULT_TIMESTAMP_FORMAT);
+    }
+
     public async updateAdditionalUrls(value) {
         await this.setConfigValue(configKeys.ADDITIONAL_URLS, value, true);
     }

src/common/constants.ts

@@ -43,6 +43,7 @@ export const statusBarPriority = {
     PORT: 20,
     OPEN_PORT: 30,
     BAUD_RATE: 40,
+    TIMESTAMP_FORMAT: 50,
     BOARD: 60,
     ENDING: 70,
     SKETCH: 80,

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

@@ -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];
     }
@@ -40,12 +42,16 @@ 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;
@@ -59,9 +65,16 @@ export class SerialMonitor implements vscode.Disposable {
         } else {
             defaultBaudRate = SerialMonitor.DEFAULT_BAUD_RATE;
         }
+        let defaultTimestampFormat;
+        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._currentTimestampFormat = defaultTimestampFormat;
         this._portsStatusBar = vscode.window.createStatusBarItem(vscode.StatusBarAlignment.Right, constants.statusBarPriority.PORT);
         this._portsStatusBar.command = "arduino.selectSerialPort";
         this._portsStatusBar.tooltip = "Select Serial Port";
@@ -77,6 +90,12 @@ 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: "${defaultTimestampFormat}"`;
+        this._timestampFormatStatusBar.text = `$(watch)`;
         this.updatePortListStatus();
 
         const dc = DeviceContext.getInstance();
@@ -154,6 +173,7 @@ export class SerialMonitor implements vscode.Disposable {
             this._serialPortCtrl = new SerialPortCtrl(
                 this._currentPort,
                 this._currentBaudRate,
+                this._currentTimestampFormat,
                 this._bufferedOutputChannel,
                 this._outputChannel.show);
         }
@@ -206,6 +226,25 @@ export class SerialMonitor implements vscode.Disposable {
         this._baudRateStatusBar.text = chosen;
     }
 
+    public async changeTimestampFormat() {
+        const timestampFormat = await vscode.window.showInputBox();
+        if (!timestampFormat) {
+            Logger.warn("No timestamp format inputted, keeping previous timestamp format.");
+            return;
+        }
+        if (timestampFormat.indexOf("%") < 0) {
+            Logger.warn("Invalid timestamp format, keeping previous timestamp format.", { value: timestampFormat });
+            return;
+        }
+        if (!this._serialPortCtrl) {
+            Logger.warn("Serial Monitor has not been started.");
+            return;
+        }
+        await this._serialPortCtrl.changeTimestampFormat(timestampFormat);
+        this._currentTimestampFormat = timestampFormat;
+        this._timestampFormatStatusBar.tooltip = `Timestamp Format: "${timestampFormat}"`;
+    }
+
     public async closeSerialMonitor(port: string, showWarning: boolean = true): Promise<boolean> {
         if (this._serialPortCtrl) {
             if (port && port !== this._serialPortCtrl.currentPort) {
@@ -241,11 +280,13 @@ export class SerialMonitor implements vscode.Disposable {
             this._openPortStatusBar.text = `$(x)`;
             this._openPortStatusBar.tooltip = "Close Serial Monitor";
             this._baudRateStatusBar.show();
+            this._timestampFormatStatusBar.show();
         } else {
             this._openPortStatusBar.command = "arduino.openSerialMonitor";
             this._openPortStatusBar.text = `$(plug)`;
             this._openPortStatusBar.tooltip = "Open Serial Monitor";
             this._baudRateStatusBar.hide();
+            this._timestampFormatStatusBar.hide();
         }
 
     }

src/serialmonitor/serialportctrl.ts

@@ -62,14 +62,17 @@ export class SerialPortCtrl {
   private _currentPort: string;
   private _currentBaudRate: number;
   private _currentSerialPort = null;
+  private _currentTimestampFormat: string;
 
   public constructor(
       port: string,
       baudRate: number,
+      timestampFormat: string,
       private _bufferedOutputChannel: BufferedOutputChannel,
       private showOutputChannel: (preserveFocus?: boolean) => void) {
     this._currentBaudRate = baudRate;
     this._currentPort = port;
+    this._currentTimestampFormat = 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._currentTimestampFormat, "--json"])
 
         this._child.on("error", (err) => {
             reject(err)
@@ -102,7 +105,7 @@ export class SerialPortCtrl {
         this._child.stdout.on("data", (data) => {
             if (this.isActive) {
                 const jsonObj = JSON.parse(data.toString())
-                this._bufferedOutputChannel.append(jsonObj["payload"] + "\n");
+                this._bufferedOutputChannel.append(jsonObj["timestamp"] + jsonObj["payload"] + "\n");
             }
         });
         // TODO: add message check to ensure _child spawned without errors
@@ -189,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",