serialportctrl.ts

// Copyright (c) Microsoft Corporation. All rights reserved.
// Licensed under the MIT license.

import { ChildProcess, execFileSync, spawn  } from "child_process";
import * as os from "os";
import * as path from "path";
import { DeviceContext } from "../deviceContext";
import { BufferedOutputChannel } from "./outputBuffer";

interface ISerialPortDetail {
  port: string;
  desc: string;
  hwid: string;
  vendorId: string;
  productId: string;
}

export class SerialPortCtrl {

/**
 * Launches the serial monitor to check which external usb devices are connected.
 *
 * @returns An array of ISerialPortDetail from external serial devices.
 *
 */
  public static list(): Promise<ISerialPortDetail[]> {
    // TODO: Wrap this in a try catch block, catch error if no serial monitor at path
    const stdout =  execFileSync(SerialPortCtrl._serialCliPath, ["list-ports"]);
    const lists = JSON.parse(stdout.toString("utf-8"));
    lists.forEach((port) => {
        const vidPid = this._parseVidPid(port["hwid"]);
        port["vendorId"] = vidPid["vid"];
        port["productId"] = vidPid["pid"];
    });
    return lists;
  }

  /**
   * Parse out vendor id and product id from the hardware id provided by the device.
   *
   * @param hwid: The hardware information for a sepcific device
   *
   * @returns vendor id and product id values in an array. Returns null if none are found.
   */
  private static _parseVidPid(hwid: string): any {
    const result = hwid.match(/VID:PID=(?<vid>\w+):(?<pid>\w+)/i);
    return result !== null ? result["groups"] : [null, null];
  }

  private static get _serialCliPath(): string {
    let fileName: string;
    if (os.platform() === "win32") {
        fileName = "main.exe"
    } else if (os.platform() === "linux" || os.platform() === "darwin") {
        fileName = "main.out"
    }
    const deviceContext = DeviceContext.getInstance();
    return path.resolve(deviceContext.extensionPath, "out", "serial-monitor-cli", `${os.platform}`, fileName);
  }

  private _child: ChildProcess;
  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;
  }

  /*
  * Return true if child proccess is currently running
  */
  public get isActive(): boolean {
    return this._child ? true : false;
  }

  public get currentPort(): string {
    return this._currentPort;
  }

  public open(): Promise<void> {
    this._bufferedOutputChannel.appendLine(`[Starting] Opening the serial port - ${this._currentPort}`);
    this.showOutputChannel();

    if (this._child) {
        this.stop();
    }

    return new Promise((resolve, reject) => {
        this._child = spawn(SerialPortCtrl._serialCliPath,
            ["open", this._currentPort, "-b", this._currentBaudRate.toString(), "-t", this._currentTimestampFormat, "--json"])

        this._child.on("error", (err) => {
            reject(err)
        });

        this._child.stdout.on("data", (data) => {
            if (this.isActive) {
                const jsonObj = JSON.parse(data.toString())
                this._bufferedOutputChannel.append(jsonObj["timestamp"] + jsonObj["payload"]);
            }
        });
        // TODO: add message check to ensure _child spawned without errors
        resolve();
        // The spawn event is only supported in node v15+ vscode
        // this._child.on("spawn", (spawn) => {
        //     resolve();
        // });

     });
  }

  public sendMessage(text: string): Promise<void> {
    return new Promise((resolve, reject) => {
      if (!text || !this.isActive) {
        resolve();
        return;
      }
      this._child.stdin.write(`{"cmd": "write", "payload": "${text}"}\n`, (error) => {
        if (!error) {
          resolve();
        } else {
          return reject(error);
        }
      });
    });
  }

  public changePort(newPort: string): Promise<void> {
    return new Promise((resolve, reject) => {
      if (newPort === this._currentPort) {
        resolve();
        return;
      }
      this._currentPort = newPort;
      if (!this._currentSerialPort || !this.isActive) {
        resolve();
        return;
      }
      this._currentSerialPort.close((err) => {
        if (err) {
          reject(err);
        } else {
          this._currentSerialPort = null;
          resolve();
        }
      });
    });
  }

  public stop(): Promise<boolean> {
    return new Promise((resolve, reject) => {
      if (!this.isActive) {
        resolve(false);
        return;
      }
      try {
        this._child.stdin.write('{"cmd": "close"}\n');
        if (this._bufferedOutputChannel) {
          this._bufferedOutputChannel.appendLine(`[Done] Closed the serial port ${os.EOL}`);
        }
        this._child = null;
        resolve(true);
      } catch (error) {
          reject(error);
      }
      });
  }

  public changeBaudRate(newRate: number): Promise<void> {
    return new Promise((resolve, reject) => {
      this._currentBaudRate = newRate;
      if (!this._child || !this.isActive) {
        resolve();
        return;
      } else {
            try {
                this.stop();
                this.open();
                resolve();
            } catch (error) {
                reject(error);
            }
        }
    });
  }

  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);
            }
        }
    });
  }
}