WIP

Author: jurgelenas

.husky/pre-commit

@@ -1,4 +1,4 @@
 #!/bin/sh
 . "$(dirname "$0")/_/husky.sh"
 
-npm run lint staged
+npm run lint

package.json

@@ -225,6 +225,7 @@
     "@types/react-router-dom": "^5.1.7",
     "@types/react-test-renderer": "^17.0.1",
     "@types/rimraf": "^3.0.0",
+    "@types/serialport": "^8.0.1",
     "@types/uuid": "^8.3.0",
     "@types/webpack-env": "^1.16.0",
     "@typescript-eslint/eslint-plugin": "^4.15.0",

src/api/index.ts

@@ -22,6 +22,7 @@ import './src/graphql/enum/UserDefineKey';
 import UserDefinesBuilder from './src/services/UserDefinesBuilder';
 import UpdatesService from './src/services/Updates';
 import UpdatesResolver from './src/graphql/resolvers/Updates.resolver';
+import SerialMonitorResolver from './src/graphql/resolvers/SerialMonitor.resolver';
 
 export default class ApiServer {
   app: Express | undefined;
@@ -75,7 +76,12 @@ export default class ApiServer {
     );
 
     const schema = await buildSchema({
-      resolvers: [FirmwareResolver, SourcesResolver, UpdatesResolver],
+      resolvers: [
+        FirmwareResolver,
+        SourcesResolver,
+        UpdatesResolver,
+        SerialMonitorResolver,
+      ],
       container: Container,
       pubSub,
     });

src/api/src/graphql/resolvers/SerialMonitor.resolver.ts

@@ -0,0 +1,15 @@
+import { Query, Resolver } from 'type-graphql';
+import { Service } from 'typedi';
+import SerialMonitorService from '../../services/SerialMonitor';
+import SerialPortInformation from '../../models/SerialPortInformation';
+
+@Service()
+@Resolver()
+export default class SerialMonitorResolver {
+  constructor(private serialMonitorService: SerialMonitorService) {}
+
+  @Query(() => [SerialPortInformation])
+  async availableDevicesList() {
+    return this.serialMonitorService.getAvailableDevices();
+  }
+}

src/api/src/models/SerialPortInformation.ts

@@ -0,0 +1,15 @@
+import { Field, ObjectType } from 'type-graphql';
+
+@ObjectType('SerialPortInformation')
+export default class SerialPortInformation {
+  @Field()
+  path: string;
+
+  @Field()
+  manufacturer: string;
+
+  constructor(path: string, manufacturer: string) {
+    this.path = path;
+    this.manufacturer = manufacturer;
+  }
+}

src/api/src/pubsub/enum/PubSubTopic.ts

@@ -1,6 +1,8 @@
 enum PubSubTopic {
   BuildProgressNotification = 'BUILD_PROGRESS_NOTIFICATION',
   BuildLogsUpdate = 'BUILD_LOGS_UPDATE',
+  SerialMonitorEvents = 'SERIAL_MONITOR_EVENTS',
+  SerialMonitorStream = 'SERIAL_MONITOR_STREAM',
 }
 
 export default PubSubTopic;

src/api/src/services/SerialMonitor/index.ts

@@ -0,0 +1,64 @@
+import { Service } from 'typedi';
+import SerialPort from 'serialport';
+import { PubSubEngine } from 'graphql-subscriptions';
+import SerialPortInformation from '../../models/SerialPortInformation';
+import PubSubTopic from '../../pubsub/enum/PubSubTopic';
+import { LoggerService } from '../../logger';
+
+@Service()
+export default class SerialMonitorService {
+  port: SerialPort | null;
+
+  constructor(private pubSub: PubSubEngine, private logger: LoggerService) {
+    this.port = null;
+  }
+
+  private async sendLogs(data: string): Promise<void> {
+    this.logger?.log('serial monitor stream message', {
+      data,
+    });
+    return this.pubSub!.publish(PubSubTopic.SerialMonitorStream, {
+      data,
+    });
+  }
+
+  async getAvailableDevices(): Promise<SerialPortInformation[]> {
+    const list = await SerialPort.list();
+    return list.map(
+      (item) => new SerialPortInformation(item.path, item.manufacturer || '')
+    );
+  }
+
+  async connect(device: string, baudRate: number): Promise<void> {
+    if (this.port !== null) {
+      throw new Error('serial port is already being used');
+    }
+
+    this.port = new SerialPort(device, {
+      baudRate,
+    });
+
+    // Open errors will be emitted as an error event
+    this.port.on('error', (err) => {
+      this.sendLogs(`Serial port error: ${err.message}`);
+      this.port = null;
+    });
+
+    // this.port.on('');
+  }
+
+  async disconnect(): Promise<void> {
+    if (this.port === null) {
+      throw new Error('not connected');
+    }
+    return new Promise((resolve, reject) => {
+      this.port?.close((err) => {
+        if (err) {
+          reject(err);
+        } else {
+          resolve();
+        }
+      });
+    });
+  }
+}

src/package.json

@@ -14,5 +14,7 @@
     "postinstall": "yarn electron-rebuild"
   },
   "license": "GPL-3.0-or-later",
-  "dependencies": {}
+  "dependencies": {
+    "serialport": "^9.0.7"
+  }
 }