Home

1. Introduction

The purpose of this repository is to contain all code for the team's Wireless Telemetry front-end GUI application. This is entirely focused on the new version of the software (version 2). For reference the first version of the wireless telemetry GUI that was written in Python can be viewed here. (Please note that the linked repo is no longer maintained.)

This project is going to be designed in a way that is as least dependent on the back-end server as possible. This way any further developments on the back-end server won't and shouldn't affect the operation of the front-end system.

The back-end intermediate server that powers the GUI system can be found in this link.

2. What this Wiki Covers

Further into the future this Wiki page is designed to contain all information needed about the front-end GUI system. As development on the project continues these pages are going to be populated with relevant topics regarding the understand and methodology behind the system's development. The main purpose of this wiki is to help current and future members of the GUI project get an understanding in the development of the project.

3. Building & Running

First make sure you have have git and Node.js installed on your machine. You can download git from here, and Node.js from here.

To build and run the GUI application follow the steps outlined below:

1. Clone the react-electron branch of this repo using https://github.com/sufst/wireless-telemetry-gui.git
2. Open the folder in a Terminal window.
3. Enter the app folder with cd app.
4. Run npm install to install all needed dependencies
5. Run npm run start.

To connect to the back-end server follow the steps outlined in the corresponding repo here and run main.py together with car_emulator.py. At this point you should see raw packets being output on terminal window.

Note: If you run the backend server after you start the GUI app, you will need to restart the GUI for it to show up