Merge pull request #470 from Hyperloop-UPV/develop

Author: JavierRibaldelRio

.github/workflows/release.yaml

@@ -90,7 +90,6 @@ jobs:
         if: runner.os == 'Linux'
         run: |
           sudo apt-get update
-          sudo apt-get install -y rpm libarchive-tools
 
       # Download ONLY the appropriate backend for this platform
       - name: Download Linux backend
@@ -188,8 +187,6 @@ jobs:
             electron-app/dist/*.exe
             electron-app/dist/*.AppImage
             electron-app/dist/*.deb
-            electron-app/dist/*.rpm
-            electron-app/dist/*.pacman
             electron-app/dist/*.dmg
             electron-app/dist/*.zip
             electron-app/dist/*.yml

README.md

@@ -1,5 +1,6 @@
 # Hyperloop Control Station H11
- ![Testing View](https://raw.githubusercontent.com/Hyperloop-UPV/webpage/5c1c827d82d380689856ee61af43da30da22e0fc/src/assets/backgrounds/testing-view.png)
+
+![Testing View](https://raw.githubusercontent.com/Hyperloop-UPV/webpage/5c1c827d82d380689856ee61af43da30da22e0fc/src/assets/backgrounds/testing-view.png)
 
 ## Monorepo usage
 
@@ -20,17 +21,17 @@ Before starting, ensure you have the following installed:
 
 Our `pnpm-workspace.yaml` defines the following workspaces:
 
-| Workspace                      | Language | Description                                    |
-| :----------------------------- | :------- | :--------------------------------------------- |
-| `testing-view`                 | TS/React | Web interface for telemetry testing            |
-| `competition-view`             | TS/React | UI for the competition                         |
-| `backend`                      | Go       | Data ingestion and pod communication server    |
-| `packet-sender`                | Rust     | Utility for simulating vehicle packets         |
-| `electron-app`                 | JS       | The main Control Station desktop application   |
-| `@workspace/ui`                | TS/React | Shared UI component library (frontend-kit)     |
-| `@workspace/core`              | TS       | Shared business logic and types (frontend-kit) |
-| `@workspace/eslint-config`     | ESLint   | Common ESLint configuration (frontend-kit)     |
-| `@workspace/typescript-config` | TS       | Common TypeScript configuration (frontend-kit) |
+| Workspace                      | Language | Description                                           |
+| :----------------------------- | :------- | :---------------------------------------------------- |
+| `testing-view`                 | TS/React | Web interface for telemetry testing                   |
+| `competition-view`             | TS/React | UI for the competition                                |
+| `backend`                      | Go       | Data ingestion and pod communication server           |
+| `packet-sender`                | Rust     | Utility for simulating vehicle packets                |
+| `hyperloop-control-station`    | JS       | The main Control Station electron desktop application |
+| `@workspace/ui`                | TS/React | Shared UI component library (frontend-kit)            |
+| `@workspace/core`              | TS       | Shared business logic and types (frontend-kit)        |
+| `@workspace/eslint-config`     | ESLint   | Common ESLint configuration (frontend-kit)            |
+| `@workspace/typescript-config` | TS       | Common TypeScript configuration (frontend-kit)        |
 
 ---
 

backend/cmd/config.toml

@@ -18,6 +18,7 @@ boards = ["BCU", "BMSL", "HVSCU", "HVSCU-Cabinet", "LCU", "PCU", "VCU", "BLCU"]
 # ADJ (Architecture Description JSON) Configuration
 [adj]
 branch = "main" # Leave blank when using ADJ as a submodule (like this: "")
+validate = true # Execute ADJ validator before starting backend
 
 # Transport Configuration
 [transport]
@@ -33,6 +34,12 @@ max_retries = 0              # Maximum retries before cycling (0 = infinite retr
 connection_timeout_ms = 1000 # Connection timeout in milliseconds
 keep_alive_ms = 1000         # Keep-alive interval in milliseconds
 
+# UDP Configuration
+# These settings control the UDP server's buffer sizes and performance characteristics
+[udp]
+ring_buffer_size = 64      # Size of the ring buffer for incoming packets (number of packets, not bytes)
+packet_chan_size = 16      # Size of the channel buffer
+
 # TFTP Configuration
 [tftp]
 block_size = 131072    # TFTP block size in bytes (128kB)

backend/cmd/dev-config.toml

@@ -19,7 +19,7 @@ boards = ["HVSCU", "HVSCU-Cabinet", "PCU", "LCU", "BCU", "BMSL"]
 # ADJ (Architecture Description JSON) Configuration
 [adj]
 branch = "software" # Leave blank when using ADJ as a submodule (like this: "")
-
+validate = true # Execute ADJ validator before starting backend
 
 # Transport Configuration
 [transport]
@@ -35,6 +35,12 @@ max_retries = 0                # Maximum retries before cycling (0 = infinite re
 connection_timeout_ms = 999999 # Timeout for the initial connection attempt
 keep_alive_ms = 0              # Keep-alive interval in milliseconds (0 to disable)
 
+# UDP Configuration
+# These settings control the UDP server's buffer sizes and performance characteristics
+[udp]
+ring_buffer_size = 64      # Size of the ring buffer for incoming packets (number of packets, not bytes)
+packet_chan_size = 16      # Size of the channel buffer
+
 # Server Configuration
 [server.ethernet-view]
 address = "127.0.0.1:4040"

backend/cmd/main.go

@@ -9,6 +9,8 @@ import (
 	"github.com/HyperloopUPV-H8/h9-backend/internal/flags"
 	"github.com/HyperloopUPV-H8/h9-backend/internal/pod_data"
 	"github.com/HyperloopUPV-H8/h9-backend/internal/update_factory"
+	tracelogger "github.com/HyperloopUPV-H8/h9-backend/pkg/logger/trace"
+
 	vehicle_models "github.com/HyperloopUPV-H8/h9-backend/internal/vehicle/models"
 	adj_module "github.com/HyperloopUPV-H8/h9-backend/pkg/adj"
 	"github.com/HyperloopUPV-H8/h9-backend/pkg/transport"
@@ -33,7 +35,7 @@ func main() {
 	handleVersionFlag()
 
 	// Configure trace
-	traceFile := initTrace(flags.TraceLevel, flags.TraceFile)
+	traceFile := tracelogger.InitTrace(flags.TraceLevel)
 	if traceFile != nil {
 		defer traceFile.Close()
 	}
@@ -49,7 +51,7 @@ func main() {
 	}
 
 	// <--- ADJ --->
-	adj, err := adj_module.NewADJ(config.Adj.Branch)
+	adj, err := adj_module.NewADJ(config.Adj)
 	if err != nil {
 		trace.Fatal().Err(err).Msg("setting up ADJ")
 	}

backend/cmd/setup_transport.go

@@ -50,7 +50,7 @@ func configureTransport(
 	configureTCPServerTransport(adj, transp)
 
 	// Start handling network packets using UDP server
-	configureUDPServerTransport(adj, transp)
+	configureUDPServerTransport(adj, transp, config)
 
 }
 
@@ -133,12 +133,14 @@ func configureTCPServerTransport(
 func configureUDPServerTransport(
 	adj adj_module.ADJ,
 	transp *transport.Transport,
+	config config.Config,
+
 ) {
 	trace.Info().Msg("Starting UDP server")
-	udpServer := udp.NewServer(adj.Info.Addresses[BACKEND], adj.Info.Ports[UDP], &trace.Logger)
+	udpServer := udp.NewServer(adj.Info.Addresses[BACKEND], adj.Info.Ports[UDP], &trace.Logger, config.UDP.RingBufferSize, config.UDP.PacketChanSize)
 	err := udpServer.Start()
 	if err != nil {
-		panic("failed to start UDP server: " + err.Error())
+		trace.Fatal().Err(err).Msg("failed to start UDP server: " + err.Error())
 	}
 	go transp.HandleUDPServer(udpServer)
 }

backend/internal/config/config_types.go

@@ -11,7 +11,8 @@ type App struct {
 }
 
 type Adj struct {
-	Branch string `toml:"branch"`
+	Branch   string `toml:"branch"`
+	Validate bool   `toml:"validate"`
 }
 
 type Transport struct {
@@ -35,6 +36,11 @@ type TCP struct {
 	KeepAlive         int     `toml:"keep_alive_ms"`
 }
 
+type UDP struct {
+	RingBufferSize int `toml:"ring_buffer_size"`
+	PacketChanSize int `toml:"packet_chan_size"`
+}
+
 type Logging struct {
 	TimeUnit    logger.TimeUnit `toml:"time_unit"`
 	LoggingPath string          `toml:"logging_path"`
@@ -48,5 +54,6 @@ type Config struct {
 	Transport Transport
 	TFTP      TFTP
 	TCP       TCP
+	UDP       UDP
 	Logging   Logging
 }

backend/internal/flags/flags.go

@@ -32,7 +32,6 @@ func Init() {
 	flag.StringVar(&ConfigFile, "config", "config.toml", "path to configuration file")
 	flag.BoolVar(&ConfigAllowUnknown, "config-allow-unknown", false, "allow unknown fields in configuration file")
 	flag.StringVar(&TraceLevel, "trace", "info", "set the trace level (\"fatal\", \"error\", \"warn\", \"info\", \"debug\", \"trace\")")
-	flag.StringVar(&TraceFile, "log", "", "set the trace log file")
 	flag.StringVar(&CPUProfile, "cpuprofile", "", "write cpu profile to file")
 	flag.BoolVar(&EnableSNTP, "sntp", false, "enables a simple SNTP server on port 123")
 	flag.IntVar(&BlockProfile, "blockprofile", 0, "number of block profiles to include")

backend/pkg/adj/adj.go

@@ -6,11 +6,13 @@ import (
 	"os"
 	"path/filepath"
 
+	"github.com/HyperloopUPV-H8/h9-backend/internal/config"
 	"github.com/HyperloopUPV-H8/h9-backend/internal/utils"
 )
 
 const (
-	RepoURL = "https://github.com/Hyperloop-UPV/adj.git" // URL of the ADJ repository
+	RepoURL            = "https://github.com/Hyperloop-UPV/adj.git"     // URL of the ADJ repository
+	ADJValidatorScript = ".github/workflows/scripts/adj-tester/main.py" // Path of ADJ valdiator
 )
 
 var RepoPath = getRepoPath()
@@ -32,8 +34,8 @@ func getRepoPath() string {
 	return absPath + string(filepath.Separator)
 }
 
-func NewADJ(AdjBranch string) (ADJ, error) {
-	infoRaw, boardsRaw, err := downloadADJ(AdjBranch)
+func NewADJ(AdjSettings config.Adj) (ADJ, error) {
+	infoRaw, boardsRaw, err := downloadADJ(AdjSettings)
 	if err != nil {
 		return ADJ{}, err
 	}
@@ -87,8 +89,16 @@ func NewADJ(AdjBranch string) (ADJ, error) {
 	return adj, nil
 }
 
-func downloadADJ(AdjBranch string) (json.RawMessage, json.RawMessage, error) {
-	updateRepo(AdjBranch)
+func downloadADJ(AdjSettings config.Adj) (json.RawMessage, json.RawMessage, error) {
+	updateRepo(AdjSettings.Branch)
+
+	// After downloading adj apply adj validator
+
+	if AdjSettings.Validate {
+
+		Validate()
+
+	}
 
 	info, err := os.ReadFile(RepoPath + "general_info.json")
 	if err != nil {

backend/pkg/adj/git.go

@@ -1,10 +1,11 @@
 package adj
 
 import (
-	"log"
 	"os"
 	"path/filepath"
 
+	trace "github.com/rs/zerolog/log"
+
 	"github.com/go-git/go-git/v5"
 	"github.com/go-git/go-git/v5/plumbing"
 )
@@ -20,8 +21,10 @@ func updateRepo(AdjBranch string) error {
 
 	if AdjBranch == "" {
 		// Makes use of user's custom ADJ
+		trace.Info().Msg("No ADJ branch specified. Using local ADJ.")
 		return nil
 	} else {
+		trace.Info().Msgf("Updating local ADJ repository to match remote branch '%s'", AdjBranch)
 		cloneOptions := &git.CloneOptions{
 			URL:           RepoURL,
 			ReferenceName: plumbing.NewBranchReferenceName(AdjBranch),
@@ -41,7 +44,7 @@ func updateRepo(AdjBranch string) error {
 		_, err = git.PlainClone(tempPath, false, cloneOptions)
 		if err != nil {
 			// If the clone fails, work with the local ADJ
-			log.Printf("Warning: Could not clone ADJ branch '%s' from remote. Working with local ADJ. Error: %v", AdjBranch, err)
+			trace.Info().Msgf("Warning: Could not clone ADJ branch '%s' from remote. Working with local ADJ. Error: %v", AdjBranch, err)
 			return nil
 		}