Terrapin-Rocket-Team / Ground-Station

A Node.js/Electron ground station user interface to display and log APRS messages recieved over Serial
0 stars 0 forks source link

Terp Rockets Ground Station

An Electron based ground station user interface to display and log APRS messages recieved over serial

Installation

The easiest way to install is to download the executable for your platform if it is available for the latest release. However, you can also build the application from source.

First, make sure to install Node.js and npm.

Then install depedencies.

npm install 

If you want to generate an installer in addtion to the basic zip file, add the maker for your platform from makers.txt under config.makers in package.json.

{

"config": {
    "forge": {
      "packagerConfig": {
        "icon": "assets/icon"
      },
      "makers": [
        {
          "name": "@electron-forge/maker-zip"
        }
      ]
    }
  },

}

Then make the app using npm.

npm run make

The executable will be located under "out/Terp Rockets Ground Station" and the output from the makers at "out/make/\<name of the maker>".

Usage

To get started, first plug in a device that will send messages over serial in the following format:

"s\r\nSource:xxx,Destination:xxx,Path:xxx,Type:xxx,Data:xxx,RSSI:xxx\r\ne\r\n"

Where

The "Data" field is expected to be in the format:

"!DDMM.hhd/DDDMM.hhd[hhh/sss/A=aaaaaa/Sx/HH:MM:SS"

Where

Connecting via the Main Window

To connect the application to the device, select it from the dropdown menu in the application's top bar. If your device is transmitting, you should see data begin to appear. You can check if the device is connected by the plug icon in the top bar. You can also see the signal strength of the receiver by the "wifi" icon in the top bar. The information available in main window is further explained in the user guide.

Note If data does not appear, open the debug window using the console icon in the top bar and check for an error message. Make sure the port is not already in use! The application's GUI can be reloaded using the reload icon in the top bar.

Connecting via the Debug Window

The debug window relies on a command based system, similar to that in operating system terminals. To connect to the device from the debug window, use the command

serial -connect "port-name"

Where "port-name" is the name of the serial port (eg. COM5) to connect to without the quotation marks. To see the list of available connections, use the command

serial -list

Other available commands can be seen using the "help" command, and are explained in further detail in the user guide.

Data

Received data is logged in .csv format and is placed in the /data directory under the name YYYY-MM-DDTHH-MM-SS.csv

Configuration

Certain application settings can be configured using the settings page (the gear icon in the top bar), commands in the debug window, or by directly editing the config.json file.

The available configuration options are

Future development

Features that may be added in the future include