feat: Initialize backend with NestJS framework and serial communication

- Added package.json for backend dependencies and scripts. - Implemented basic AppController and AppService with a simple "Hello World!" endpoint. - Created SerialModule for handling serial communication with the Pico. - Developed SerialController and SerialService to manage serial ports and commands. - Implemented event streaming for serial data. - Added Jest tests for AppController and e2e tests for the application. - Set up TypeScript configuration for the backend. - Created frontend SendBox component for sending commands to the backend. - Established Pico firmware for controlling a stepper motor via serial commands. - Documented project structure and usage in README files.
2025-12-15 11:29:32 +01:00 · 2025-08-27 22:11:33 +02:00
parent bd41ffbe79
commit d607308b1d
32 changed files with 11622 additions and 165 deletions
--- a/backend/.gitignore
+++ b/backend/.gitignore
@@ -0,0 +1,56 @@
+# compiled output
+/dist
+/node_modules
+/build
+
+# Logs
+logs
+*.log
+npm-debug.log*
+pnpm-debug.log*
+yarn-debug.log*
+yarn-error.log*
+lerna-debug.log*
+
+# OS
+.DS_Store
+
+# Tests
+/coverage
+/.nyc_output
+
+# IDEs and editors
+/.idea
+.project
+.classpath
+.c9/
+*.launch
+.settings/
+*.sublime-workspace
+
+# IDE - VSCode
+.vscode/*
+!.vscode/settings.json
+!.vscode/tasks.json
+!.vscode/launch.json
+!.vscode/extensions.json
+
+# dotenv environment variable files
+.env
+.env.development.local
+.env.test.local
+.env.production.local
+.env.local
+
+# temp directory
+.temp
+.tmp
+
+# Runtime data
+pids
+*.pid
+*.seed
+*.pid.lock
+
+# Diagnostic reports (https://nodejs.org/api/report.html)
+report.[0-9]*.[0-9]*.[0-9]*.[0-9]*.json
--- a/backend/.prettierrc
+++ b/backend/.prettierrc
@@ -0,0 +1,4 @@
+{
+  "singleQuote": true,
+  "trailingComma": "all"
+}
--- a/backend/README.md
+++ b/backend/README.md
@@ -0,0 +1,98 @@
+<p align="center">
+  <a href="http://nestjs.com/" target="blank"><img src="https://nestjs.com/img/logo-small.svg" width="120" alt="Nest Logo" /></a>
+</p>
+
+[circleci-image]: https://img.shields.io/circleci/build/github/nestjs/nest/master?token=abc123def456
+[circleci-url]: https://circleci.com/gh/nestjs/nest
+
+  <p align="center">A progressive <a href="http://nodejs.org" target="_blank">Node.js</a> framework for building efficient and scalable server-side applications.</p>
+    <p align="center">
+<a href="https://www.npmjs.com/~nestjscore" target="_blank"><img src="https://img.shields.io/npm/v/@nestjs/core.svg" alt="NPM Version" /></a>
+<a href="https://www.npmjs.com/~nestjscore" target="_blank"><img src="https://img.shields.io/npm/l/@nestjs/core.svg" alt="Package License" /></a>
+<a href="https://www.npmjs.com/~nestjscore" target="_blank"><img src="https://img.shields.io/npm/dm/@nestjs/common.svg" alt="NPM Downloads" /></a>
+<a href="https://circleci.com/gh/nestjs/nest" target="_blank"><img src="https://img.shields.io/circleci/build/github/nestjs/nest/master" alt="CircleCI" /></a>
+<a href="https://discord.gg/G7Qnnhy" target="_blank"><img src="https://img.shields.io/badge/discord-online-brightgreen.svg" alt="Discord"/></a>
+<a href="https://opencollective.com/nest#backer" target="_blank"><img src="https://opencollective.com/nest/backers/badge.svg" alt="Backers on Open Collective" /></a>
+<a href="https://opencollective.com/nest#sponsor" target="_blank"><img src="https://opencollective.com/nest/sponsors/badge.svg" alt="Sponsors on Open Collective" /></a>
+  <a href="https://paypal.me/kamilmysliwiec" target="_blank"><img src="https://img.shields.io/badge/Donate-PayPal-ff3f59.svg" alt="Donate us"/></a>
+    <a href="https://opencollective.com/nest#sponsor"  target="_blank"><img src="https://img.shields.io/badge/Support%20us-Open%20Collective-41B883.svg" alt="Support us"></a>
+  <a href="https://twitter.com/nestframework" target="_blank"><img src="https://img.shields.io/twitter/follow/nestframework.svg?style=social&label=Follow" alt="Follow us on Twitter"></a>
+</p>
+  <!--[![Backers on Open Collective](https://opencollective.com/nest/backers/badge.svg)](https://opencollective.com/nest#backer)
+  [![Sponsors on Open Collective](https://opencollective.com/nest/sponsors/badge.svg)](https://opencollective.com/nest#sponsor)-->
+
+## Description
+
+[Nest](https://github.com/nestjs/nest) framework TypeScript starter repository.
+
+## Project setup
+
+```bash
+$ npm install
+```
+
+## Compile and run the project
+
+```bash
+# development
+$ npm run start
+
+# watch mode
+$ npm run start:dev
+
+# production mode
+$ npm run start:prod
+```
+
+## Run tests
+
+```bash
+# unit tests
+$ npm run test
+
+# e2e tests
+$ npm run test:e2e
+
+# test coverage
+$ npm run test:cov
+```
+
+## Deployment
+
+When you're ready to deploy your NestJS application to production, there are some key steps you can take to ensure it runs as efficiently as possible. Check out the [deployment documentation](https://docs.nestjs.com/deployment) for more information.
+
+If you are looking for a cloud-based platform to deploy your NestJS application, check out [Mau](https://mau.nestjs.com), our official platform for deploying NestJS applications on AWS. Mau makes deployment straightforward and fast, requiring just a few simple steps:
+
+```bash
+$ npm install -g @nestjs/mau
+$ mau deploy
+```
+
+With Mau, you can deploy your application in just a few clicks, allowing you to focus on building features rather than managing infrastructure.
+
+## Resources
+
+Check out a few resources that may come in handy when working with NestJS:
+
+- Visit the [NestJS Documentation](https://docs.nestjs.com) to learn more about the framework.
+- For questions and support, please visit our [Discord channel](https://discord.gg/G7Qnnhy).
+- To dive deeper and get more hands-on experience, check out our official video [courses](https://courses.nestjs.com/).
+- Deploy your application to AWS with the help of [NestJS Mau](https://mau.nestjs.com) in just a few clicks.
+- Visualize your application graph and interact with the NestJS application in real-time using [NestJS Devtools](https://devtools.nestjs.com).
+- Need help with your project (part-time to full-time)? Check out our official [enterprise support](https://enterprise.nestjs.com).
+- To stay in the loop and get updates, follow us on [X](https://x.com/nestframework) and [LinkedIn](https://linkedin.com/company/nestjs).
+- Looking for a job, or have a job to offer? Check out our official [Jobs board](https://jobs.nestjs.com).
+
+## Support
+
+Nest is an MIT-licensed open source project. It can grow thanks to the sponsors and support by the amazing backers. If you'd like to join them, please [read more here](https://docs.nestjs.com/support).
+
+## Stay in touch
+
+- Author - [Kamil Myśliwiec](https://twitter.com/kammysliwiec)
+- Website - [https://nestjs.com](https://nestjs.com/)
+- Twitter - [@nestframework](https://twitter.com/nestframework)
+
+## License
+
+Nest is [MIT licensed](https://github.com/nestjs/nest/blob/master/LICENSE).
--- a/backend/eslint.config.mjs
+++ b/backend/eslint.config.mjs
@@ -0,0 +1,34 @@
+// @ts-check
+import eslint from '@eslint/js';
+import eslintPluginPrettierRecommended from 'eslint-plugin-prettier/recommended';
+import globals from 'globals';
+import tseslint from 'typescript-eslint';
+
+export default tseslint.config(
+  {
+    ignores: ['eslint.config.mjs'],
+  },
+  eslint.configs.recommended,
+  ...tseslint.configs.recommendedTypeChecked,
+  eslintPluginPrettierRecommended,
+  {
+    languageOptions: {
+      globals: {
+        ...globals.node,
+        ...globals.jest,
+      },
+      sourceType: 'commonjs',
+      parserOptions: {
+        projectService: true,
+        tsconfigRootDir: import.meta.dirname,
+      },
+    },
+  },
+  {
+    rules: {
+      '@typescript-eslint/no-explicit-any': 'off',
+      '@typescript-eslint/no-floating-promises': 'warn',
+      '@typescript-eslint/no-unsafe-argument': 'warn'
+    },
+  },
+);
--- a/backend/nest-cli.json
+++ b/backend/nest-cli.json
@@ -0,0 +1,8 @@
+{
+  "$schema": "https://json.schemastore.org/nest-cli",
+  "collection": "@nestjs/schematics",
+  "sourceRoot": "src",
+  "compilerOptions": {
+    "deleteOutDir": true
+  }
+}
--- a/backend/package-lock.json
+++ b/backend/package-lock.json
--- a/backend/package.json
+++ b/backend/package.json
@@ -0,0 +1,73 @@
+{
+  "name": "backend",
+  "version": "0.0.1",
+  "description": "",
+  "author": "",
+  "private": true,
+  "license": "UNLICENSED",
+  "scripts": {
+    "build": "nest build",
+    "format": "prettier --write \"src/**/*.ts\" \"test/**/*.ts\"",
+    "start": "nest start",
+    "start:dev": "nest start --watch",
+    "start:debug": "nest start --debug --watch",
+    "start:prod": "node dist/main",
+    "lint": "eslint \"{src,apps,libs,test}/**/*.ts\" --fix",
+    "test": "jest",
+    "test:watch": "jest --watch",
+    "test:cov": "jest --coverage",
+    "test:debug": "node --inspect-brk -r tsconfig-paths/register -r ts-node/register node_modules/.bin/jest --runInBand",
+    "test:e2e": "jest --config ./test/jest-e2e.json"
+  },
+  "dependencies": {
+    "@nestjs/common": "^11.0.1",
+    "@nestjs/core": "^11.0.1",
+    "@nestjs/platform-express": "^11.0.1",
+  "reflect-metadata": "^0.2.2",
+  "serialport": "^10.5.0",
+  "@serialport/parser-readline": "^2.0.0",
+    "rxjs": "^7.8.1"
+  },
+  "devDependencies": {
+    "@eslint/eslintrc": "^3.2.0",
+    "@eslint/js": "^9.18.0",
+    "@nestjs/cli": "^11.0.0",
+    "@nestjs/schematics": "^11.0.0",
+    "@nestjs/testing": "^11.0.1",
+    "@types/express": "^5.0.0",
+    "@types/jest": "^30.0.0",
+    "@types/node": "^22.10.7",
+    "@types/supertest": "^6.0.2",
+    "eslint": "^9.18.0",
+    "eslint-config-prettier": "^10.0.1",
+    "eslint-plugin-prettier": "^5.2.2",
+    "globals": "^16.0.0",
+    "jest": "^30.0.0",
+    "prettier": "^3.4.2",
+    "source-map-support": "^0.5.21",
+    "supertest": "^7.0.0",
+    "ts-jest": "^29.2.5",
+    "ts-loader": "^9.5.2",
+    "ts-node": "^10.9.2",
+    "tsconfig-paths": "^4.2.0",
+    "typescript": "^5.7.3",
+    "typescript-eslint": "^8.20.0"
+  },
+  "jest": {
+    "moduleFileExtensions": [
+      "js",
+      "json",
+      "ts"
+    ],
+    "rootDir": "src",
+    "testRegex": ".*\\.spec\\.ts$",
+    "transform": {
+      "^.+\\.(t|j)s$": "ts-jest"
+    },
+    "collectCoverageFrom": [
+      "**/*.(t|j)s"
+    ],
+    "coverageDirectory": "../coverage",
+    "testEnvironment": "node"
+  }
+}
--- a/backend/src/app.controller.spec.ts
+++ b/backend/src/app.controller.spec.ts
@@ -0,0 +1,22 @@
+import { Test, TestingModule } from '@nestjs/testing';
+import { AppController } from './app.controller';
+import { AppService } from './app.service';
+
+describe('AppController', () => {
+  let appController: AppController;
+
+  beforeEach(async () => {
+    const app: TestingModule = await Test.createTestingModule({
+      controllers: [AppController],
+      providers: [AppService],
+    }).compile();
+
+    appController = app.get<AppController>(AppController);
+  });
+
+  describe('root', () => {
+    it('should return "Hello World!"', () => {
+      expect(appController.getHello()).toBe('Hello World!');
+    });
+  });
+});
--- a/backend/src/app.controller.ts
+++ b/backend/src/app.controller.ts
@@ -0,0 +1,12 @@
+import { Controller, Get } from '@nestjs/common';
+import { AppService } from './app.service';
+
+@Controller()
+export class AppController {
+  constructor(private readonly appService: AppService) {}
+
+  @Get()
+  getHello(): string {
+    return this.appService.getHello();
+  }
+}
--- a/backend/src/app.module.ts
+++ b/backend/src/app.module.ts
@@ -0,0 +1,11 @@
+import { Module } from '@nestjs/common';
+import { AppController } from './app.controller';
+import { AppService } from './app.service';
+import { SerialModule } from './serial/serial.module';
+
+@Module({
+  imports: [SerialModule],
+  controllers: [AppController],
+  providers: [AppService],
+})
+export class AppModule {}
--- a/backend/src/app.service.ts
+++ b/backend/src/app.service.ts
@@ -0,0 +1,8 @@
+import { Injectable } from '@nestjs/common';
+
+@Injectable()
+export class AppService {
+  getHello(): string {
+    return 'Hello World!';
+  }
+}
--- a/backend/src/main.ts
+++ b/backend/src/main.ts
@@ -0,0 +1,8 @@
+import { NestFactory } from '@nestjs/core';
+import { AppModule } from './app.module';
+
+async function bootstrap() {
+  const app = await NestFactory.create(AppModule);
+  await app.listen(process.env.PORT ?? 3000);
+}
+bootstrap();
--- a/backend/src/serial/serial.controller.ts
+++ b/backend/src/serial/serial.controller.ts
@@ -0,0 +1,89 @@
+import { Controller, Get, Post, Body, Res, Req } from '@nestjs/common';
+import type { Response, Request } from 'express';
+import { SerialService } from './serial.service';
+
+@Controller('serial')
+export class SerialController {
+  constructor(private readonly serial: SerialService) {}
+
+  @Get('ports')
+  async ports() {
+  console.log('[SerialController] GET /serial/ports');
+  const p = await this.serial.listPorts();
+  console.log('[SerialController] ports ->', p);
+  return p;
+  }
+
+  @Post('open')
+  async open(@Body() body: { path: string; baud?: number }) {
+    console.log('[SerialController] POST /serial/open', body);
+    try {
+      this.serial.open(body.path, body.baud ?? 115200);
+      return { ok: true };
+    } catch (e: any) {
+      console.error('[SerialController] open error', e);
+      return { ok: false, error: String(e) };
+    }
+  }
+
+  @Post('close')
+  async close() {
+  console.log('[SerialController] POST /serial/close');
+  this.serial.close();
+  return { ok: true };
+  }
+
+  @Post('send')
+  async send(@Body() body: { payload: string }) {
+    console.log('[SerialController] POST /serial/send', body.payload);
+    try {
+      this.serial.send(body.payload);
+      return { ok: true };
+    } catch (e: any) {
+      console.error('[SerialController] send error', e);
+      return { ok: false, error: String(e) };
+    }
+  }
+
+  @Get('status')
+  status() {
+    return this.serial.status();
+  }
+
+  @Get('stream')
+  stream(@Req() req: Request, @Res() res: Response) {
+    // SSE stream
+    res.set({
+      'Content-Type': 'text/event-stream',
+      'Cache-Control': 'no-cache',
+      Connection: 'keep-alive',
+    });
+    res.flushHeaders?.();
+
+    const sendEvent = (event: string, data: any) => {
+      res.write(`event: ${event}\n`);
+      res.write(`data: ${JSON.stringify(data)}\n\n`);
+    };
+
+    const offData = this.serial.on('data', (line) => sendEvent('data', { line }));
+    const offOpen = this.serial.on('open', () => sendEvent('open', { ts: Date.now() }));
+    const offClose = this.serial.on('close', () => sendEvent('close', { ts: Date.now() }));
+    const offErr = this.serial.on('error', (err) => sendEvent('error', { message: String(err) }));
+
+  console.log('[SerialController] SSE client connected');
+
+    // send a ping every 20s to keep connection alive
+    const ping = setInterval(() => res.write(': ping\n\n'), 20000);
+
+    req.on('close', () => {
+  console.log('[SerialController] SSE client disconnected');
+      clearInterval(ping);
+      offData();
+      offOpen();
+      offClose();
+      offErr();
+    });
+
+    return res;
+  }
+}
--- a/backend/src/serial/serial.module.ts
+++ b/backend/src/serial/serial.module.ts
@@ -0,0 +1,10 @@
+import { Module } from '@nestjs/common';
+import { SerialService } from './serial.service';
+import { SerialController } from './serial.controller';
+
+@Module({
+  providers: [SerialService],
+  controllers: [SerialController],
+  exports: [SerialService],
+})
+export class SerialModule {}
--- a/backend/src/serial/serial.service.ts
+++ b/backend/src/serial/serial.service.ts
@@ -0,0 +1,154 @@
+import { Injectable, OnModuleDestroy, OnModuleInit } from '@nestjs/common';
+import { EventEmitter } from 'events';
+// serialport has ESM/CJS shape differences and limited typings; require at runtime and keep as any
+const SP: any = require('serialport');
+const ReadlineParserModule: any = require('@serialport/parser-readline');
+// normalize constructor and parser
+const SerialCtor: any = SP?.SerialPort ?? SP;
+const ParserCtor: any = ReadlineParserModule?.ReadlineParser ?? ReadlineParserModule;
+
+type PortInfo = {
+  path: string;
+  manufacturer?: string;
+  serialNumber?: string;
+  pnpId?: string;
+  locationId?: string;
+  productId?: string;
+  vendorId?: string;
+};
+
+@Injectable()
+export class SerialService implements OnModuleDestroy, OnModuleInit {
+  private emitter = new EventEmitter();
+  private port: any = null;
+  private parser: any = null;
+
+  async listPorts(): Promise<PortInfo[]> {
+  console.log('[SerialService] listPorts()');
+  let ports: any[] = [];
+    try {
+      if (typeof SP.list === 'function') {
+        ports = await SP.list();
+      } else {
+        // try the separate list package
+        try {
+          const listMod: any = require('@serialport/list');
+          if (typeof listMod.list === 'function') ports = await listMod.list();
+          else if (typeof listMod === 'function') ports = await listMod();
+        } catch (e) {
+          // fallback: empty list
+          ports = [];
+        }
+      }
+    } catch (e) {
+      console.error('[SerialService] listPorts error', e);
+      ports = [];
+    }
+    console.log('[SerialService] listPorts ->', ports);
+    return ports.map((p: any) => ({
+      path: p.path || p.comName,
+      manufacturer: p.manufacturer,
+      serialNumber: p.serialNumber,
+      pnpId: p.pnpId,
+      locationId: p.locationId,
+      productId: p.productId,
+      vendorId: p.vendorId,
+    }));
+  }
+
+  open(path: string, baudRate = 115200) {
+    this.close();
+    console.log('[SerialService] opening port', path, 'baud', baudRate);
+    this.port = new SerialCtor({ path, baudRate, autoOpen: false } as any);
+    this.parser = this.port.pipe(new ParserCtor({ delimiter: '\n' }));
+
+    this.port.on('open', () => {
+      console.log('[SerialService] port open', path);
+      this.emitter.emit('open');
+    });
+    this.port.on('error', (err: any) => {
+      console.error('[SerialService] port error', err);
+      this.emitter.emit('error', err?.message ?? String(err));
+    });
+    this.parser.on('data', (line: string) => {
+      console.log('[SerialService] RX:', line);
+      this.emitter.emit('data', line);
+    });
+
+    // open the port
+    try {
+      this.port.open((err: any) => {
+        if (err) {
+          console.error('[SerialService] open callback error', err);
+          this.emitter.emit('error', err?.message ?? String(err));
+        } else {
+          console.log('[SerialService] open callback success');
+        }
+      });
+    } catch (e: any) {
+      console.error('[SerialService] open exception', e);
+      this.emitter.emit('error', e?.message ?? String(e));
+    }
+  }
+
+  close() {
+    if (this.parser) {
+      this.parser.removeAllListeners();
+      this.parser = null;
+    }
+    if (this.port) {
+      try {
+  console.log('[SerialService] closing port', this.port?.path ?? '(unknown)');
+  this.port.close();
+      } catch (e) {
+  console.error('[SerialService] close error', e);
+      }
+      this.port = null;
+    }
+    this.emitter.emit('close');
+  }
+
+  send(line: string) {
+    if (!this.port || !(this.port.writable || this.port.isOpen)) {
+      console.warn('[SerialService] send called but port not open');
+      throw new Error('Port not open');
+    }
+    // write and flush
+    console.log('[SerialService] TX:', line);
+    this.port.write(line + '\n', (err: any) => {
+      if (err) console.error('[SerialService] write error', err);
+      else console.log('[SerialService] write success');
+    });
+  }
+
+  status() {
+    const s = {
+      open: !!(this.port && (this.port.isOpen || this.port.writable)),
+      path: this.port?.path ?? null,
+    };
+    console.log('[SerialService] status ->', s);
+    return s;
+  }
+
+  on(event: 'data' | 'open' | 'close' | 'error', cb: (...args: any[]) => void) {
+    this.emitter.on(event, cb);
+    return () => this.emitter.off(event, cb);
+  }
+
+  onModuleDestroy() {
+    this.close();
+  }
+
+  onModuleInit() {
+    const port = process.env.SERIAL_PORT;
+    const baud = process.env.SERIAL_BAUD ? Number(process.env.SERIAL_BAUD) : undefined;
+    if (port) {
+      try {
+        console.log('[SerialService] AUTO opening port from SERIAL_PORT=', port, 'baud=', baud ?? 115200);
+        this.open(port, baud ?? 115200);
+      } catch (e: any) {
+        console.warn('[SerialService] AUTO open failed', e?.message ?? e);
+      }
+    }
+  }
+}
--- a/backend/test/app.e2e-spec.ts
+++ b/backend/test/app.e2e-spec.ts
@@ -0,0 +1,25 @@
+import { Test, TestingModule } from '@nestjs/testing';
+import { INestApplication } from '@nestjs/common';
+import * as request from 'supertest';
+import { App } from 'supertest/types';
+import { AppModule } from './../src/app.module';
+
+describe('AppController (e2e)', () => {
+  let app: INestApplication<App>;
+
+  beforeEach(async () => {
+    const moduleFixture: TestingModule = await Test.createTestingModule({
+      imports: [AppModule],
+    }).compile();
+
+    app = moduleFixture.createNestApplication();
+    await app.init();
+  });
+
+  it('/ (GET)', () => {
+    return request(app.getHttpServer())
+      .get('/')
+      .expect(200)
+      .expect('Hello World!');
+  });
+});
--- a/backend/test/jest-e2e.json
+++ b/backend/test/jest-e2e.json
@@ -0,0 +1,9 @@
+{
+  "moduleFileExtensions": ["js", "json", "ts"],
+  "rootDir": ".",
+  "testEnvironment": "node",
+  "testRegex": ".e2e-spec.ts$",
+  "transform": {
+    "^.+\\.(t|j)s$": "ts-jest"
+  }
+}
--- a/backend/tsconfig.build.json
+++ b/backend/tsconfig.build.json
@@ -0,0 +1,4 @@
+{
+  "extends": "./tsconfig.json",
+  "exclude": ["node_modules", "test", "dist", "**/*spec.ts"]
+}
--- a/backend/tsconfig.json
+++ b/backend/tsconfig.json
@@ -0,0 +1,25 @@
+{
+  "compilerOptions": {
+    "module": "nodenext",
+    "moduleResolution": "nodenext",
+    "resolvePackageJsonExports": true,
+    "esModuleInterop": true,
+    "isolatedModules": true,
+    "declaration": true,
+    "removeComments": true,
+    "emitDecoratorMetadata": true,
+    "experimentalDecorators": true,
+    "allowSyntheticDefaultImports": true,
+    "target": "ES2023",
+    "sourceMap": true,
+    "outDir": "./dist",
+    "baseUrl": "./",
+    "incremental": true,
+    "skipLibCheck": true,
+    "strictNullChecks": true,
+    "forceConsistentCasingInFileNames": true,
+    "noImplicitAny": true,
+    "strictBindCallApply": true,
+    "noFallthroughCasesInSwitch": true
+  }
+}