multilatgui

An Electron application with Solid and TypeScript

Install

$ npm install

Development

$ npm run dev

to generate changes.patch

$ git diff --output=changes.patch

Main to Renderer IPC

preload/index.ts creates a custom api channel called serial-data that the main process can use to send data to the renderer process.

main/index.ts

Sends data to the renderer process. serial-data is a channel.

mainWindow.webContents.send('serial-data', serialData)

renderer/src/components/canvas.tsx

This is how the renderer receives serial data from the main process.

// Listen for Serial data
window.api.onSerialData((data: string) => {
    console.log("Received serial data in renderer:", data);
})

Simulate Serial Data

The multilat GUI is supposed to receive ranging data through a serial port. A UWB receiver is connected through USB will receive ranging data from the other anchors and pass it to the GUI.

For testing reasons, the GUI has an Express server exposing port 3000 to receive generated test data from a python script. simulator.py will generate and send mock serial data to the GUI for testing purposes.

In root directory

npm run dev

In /testingUtil

python3 simulator.py

Build

# For windows
$ npm run build:win

# For macOS
$ npm run build:mac

# For Linux
$ npm run build:linux

Practices

git commit message template

<type> (ticket#): Description
feat #31: Receives a ping from Red GUI through a Blue API endpoint.
Ping will start the virtual missile launch

Description is written in imperative tone.

Branch naming scheme

<type>(ticket#):_(ticket name)
feat#32_MissileLauncher_location_Red_GUI

ticket writing template

# Detail
Include necessary context for the ticket.
Include  existing errors or what needs to be changed in the codebase if needed.

# Goal
Describe the desired function and changes
- [ ] use task lists if needed

# Note (optional)
Include misc notes if needed.
Include notes for future tickets if needed