import stripAnsi from 'strip-ansi' import SerialPort from 'serialport' import { Logger, LogService, NotificationsService, Profile } from 'tabby-core' import { Subject, Observable } from 'rxjs' import { Injector, NgZone } from '@angular/core' import { BaseSession, StreamProcessingOptions, TerminalStreamProcessor } from 'tabby-terminal' export interface LoginScript { expect: string send: string isRegex?: boolean optional?: boolean } export interface SerialProfile extends Profile { options: SerialProfileOptions } export interface SerialProfileOptions extends StreamProcessingOptions { port: string baudrate?: number databits?: number stopbits?: number parity?: string rtscts?: boolean xon?: boolean xoff?: boolean xany?: boolean scripts?: LoginScript[] color?: string } export const BAUD_RATES = [ 110, 150, 300, 1200, 2400, 4800, 9600, 19200, 38400, 57600, 115200, 230400, 460800, 921600, 1500000, ] export interface SerialPortInfo { name: string description?: string } export class SerialSession extends BaseSession { scripts?: LoginScript[] serial: SerialPort logger: Logger get serviceMessage$ (): Observable { return this.serviceMessage } private serviceMessage = new Subject() private streamProcessor: TerminalStreamProcessor private zone: NgZone private notifications: NotificationsService constructor (injector: Injector, public profile: SerialProfile) { super() this.logger = injector.get(LogService).create(`serial-${profile.options.port}`) this.zone = injector.get(NgZone) this.notifications = injector.get(NotificationsService) this.scripts = profile.options.scripts ?? [] this.streamProcessor = new TerminalStreamProcessor(profile.options) this.streamProcessor.outputToSession$.subscribe(data => { this.serial?.write(data.toString()) }) this.streamProcessor.outputToTerminal$.subscribe(data => { this.emitOutput(data) const dataString = data.toString() if (this.scripts) { let found = false for (const script of this.scripts) { let match = false let cmd = '' if (script.isRegex) { const re = new RegExp(script.expect, 'g') if (re.test(dataString)) { cmd = dataString.replace(re, script.send) match = true found = true } } else { if (dataString.includes(script.expect)) { cmd = script.send match = true found = true } } if (match) { this.logger.info('Executing script: "' + cmd + '"') this.serial.write(cmd + '\n') this.scripts = this.scripts.filter(x => x !== script) } else { if (script.optional) { this.logger.debug('Skip optional script: ' + script.expect) found = true this.scripts = this.scripts.filter(x => x !== script) } else { break } } } if (found) { this.executeUnconditionalScripts() } } }) } async start (): Promise { this.serial = new SerialPort(this.profile.options.port, { autoOpen: false, baudRate: parseInt(this.profile.options.baudrate as any), dataBits: this.profile.options.databits ?? 8, stopBits: this.profile.options.stopbits ?? 1, parity: this.profile.options.parity ?? 'none', rtscts: this.profile.options.rtscts ?? false, xon: this.profile.options.xon ?? false, xoff: this.profile.options.xoff ?? false, xany: this.profile.options.xany ?? false, }) let connected = false await new Promise(async (resolve, reject) => { this.serial.on('open', () => { connected = true this.zone.run(resolve) }) this.serial.on('error', error => { this.zone.run(() => { if (connected) { this.notifications.error(error.toString()) } else { reject(error) } this.destroy() }) }) this.serial.on('close', () => { this.emitServiceMessage('Port closed') this.destroy() }) try { this.serial.open() } catch (e) { this.notifications.error(e.message) reject(e) } }) this.open = true this.serial.on('readable', () => { this.streamProcessor.feedFromSession(this.serial.read()) }) this.serial.on('end', () => { this.logger.info('Shell session ended') if (this.open) { this.destroy() } }) this.executeUnconditionalScripts() } write (data: Buffer): void { this.streamProcessor.feedFromTerminal(data) } async destroy (): Promise { this.streamProcessor.close() this.serviceMessage.complete() await super.destroy() } // eslint-disable-next-line @typescript-eslint/no-empty-function, @typescript-eslint/explicit-module-boundary-types, @typescript-eslint/no-empty-function resize (_, __) { this.streamProcessor.resize() } kill (_?: string): void { this.serial.close() } emitServiceMessage (msg: string): void { this.serviceMessage.next(msg) this.logger.info(stripAnsi(msg)) } async getChildProcesses (): Promise { return [] } async gracefullyKillProcess (): Promise { this.kill('TERM') } supportsWorkingDirectory (): boolean { return false } async getWorkingDirectory (): Promise { return null } private executeUnconditionalScripts () { if (this.scripts) { for (const script of this.scripts) { if (!script.expect) { console.log('Executing script:', script.send) this.serial.write(script.send + '\n') this.scripts = this.scripts.filter(x => x !== script) } else { break } } } } }