add timestamp format pointing to serial monitor timestamp

Author: gcampbell-msft

package.json

@@ -43,6 +43,7 @@
     "onCommand:arduino.selectSerialPort",
     "onCommand:arduino.selectSketch",
     "onCommand:arduino.openSerialMonitor",
+    "onCommand:arduino.viewTimestampFormat",
     "onCommand:arduino.closeSerialMonitor",
     "onCommand:arduino.changeBoardType",
     "onCommand:arduino.showBoardConfig",
@@ -125,6 +126,10 @@
         "command": "arduino.openSerialMonitor",
         "title": "Arduino: Open Serial Monitor"
       },
+      {
+        "command": "arduino.viewTimestampFormat",
+        "title": "Arduino: View Timestamp"
+      },
       {
         "command": "arduino.closeSerialMonitor",
         "title": "Arduino: Close Serial Monitor"

src/common/constants.ts

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

src/extension.ts

@@ -283,6 +283,7 @@ export async function activate(context: vscode.ExtensionContext) {
     context.subscriptions.push(serialMonitor);
     registerNonArduinoCommand("arduino.selectSerialPort", () => serialMonitor.selectSerialPort());
     registerNonArduinoCommand("arduino.openSerialMonitor", () => serialMonitor.openSerialMonitor());
+    registerNonArduinoCommand("arduino.viewTimestampFormat", () => serialMonitor.viewTimestampFormat());
     registerNonArduinoCommand("arduino.closeSerialMonitor", (port) => serialMonitor.closeSerialMonitor(port));
 
     const completionProvider = new completionProviderModule.CompletionProvider();

src/serialmonitor/serialMonitor.ts

@@ -26,6 +26,8 @@ export class SerialMonitor implements vscode.Disposable {
         return SerialMonitor._serialMonitor;
     }
 
+    public static DEFAULT_TIMESTAMP_FORMAT: string = "";
+
     private static _serialMonitor: SerialMonitor = null;
 
     private serialMonitorApi: SerialMonitorApi | undefined;
@@ -36,6 +38,7 @@ export class SerialMonitor implements vscode.Disposable {
 
     private openPortStatusBar: vscode.StatusBarItem;
     private portsStatusBar: vscode.StatusBarItem;
+    private timestampFormatStatusBar: vscode.StatusBarItem;
 
     public async initialize(extensionContext: vscode.ExtensionContext) {
         this.extensionContext = extensionContext;
@@ -51,6 +54,13 @@ export class SerialMonitor implements vscode.Disposable {
         this.openPortStatusBar.tooltip = "Open Serial Monitor";
         this.openPortStatusBar.show();
 
+        this.timestampFormatStatusBar = vscode.window.createStatusBarItem(vscode.StatusBarAlignment.Right,
+                                                                           constants.statusBarPriority.TIMESTAMP_FORMAT);
+        this.timestampFormatStatusBar.command = "arduino.viewTimestampFormat";
+        // Get the value from the serial monitor extension settings.
+        this.timestampFormatStatusBar.tooltip = `View timestamp format`;
+        this.timestampFormatStatusBar.text = `$(watch)`;
+
         this.updatePortListStatus();
 
         const dc = DeviceContext.getInstance();
@@ -109,13 +119,19 @@ export class SerialMonitor implements vscode.Disposable {
             this.openPortStatusBar.command = "arduino.closeSerialMonitor";
             this.openPortStatusBar.text = `$(x)`;
             this.openPortStatusBar.tooltip = "Close Serial Monitor";
+            this.timestampFormatStatusBar.show();
         } else {
             this.openPortStatusBar.command = "arduino.openSerialMonitor";
             this.openPortStatusBar.text = `$(plug)`;
             this.openPortStatusBar.tooltip = "Open Serial Monitor";
+            this.timestampFormatStatusBar.hide();
         }
     }
 
+    public async viewTimestampFormat(): Promise<void> {
+        await vscode.commands.executeCommand("workbench.action.openSettings", "vscode-serial-monitor.timestampFormat");
+    }
+
     public async selectBaudRate(): Promise<number | undefined> {
         const rates = SerialMonitor.listBaudRates();
         const chosen = await vscode.window.showQuickPick(rates.map((rate) => rate.toString()));

test/extension.test.ts

@@ -47,6 +47,7 @@ suite("Arduino: Extension Tests", () => {
                     "arduino.initialize",
                     "arduino.selectSerialPort",
                     "arduino.openSerialMonitor",
+                    "arduino.viewTimestampFormat",
                     "arduino.closeSerialMonitor",
                     "arduino.reloadExample",
                     "arduino.showExampleExplorer",