TRAVELERS Control Panel

This repository contains the source code for the UI of the command board.

Introduction

This control panel serves the project TRAVELERS to display and monitor the data of the different sensors of the project (camera, temperature, humidity, etc.). It is a Flutter application that can be run on web for now but could be extended to other platforms (if the libraries used are available on these platforms).

Installation

Prerequisites

Tu build and run the project, you need to have Flutter installed on your machine. You can follow the instructions on the official website.

Be sure to have Google Chrome installed on your machine.

Finally, run the following command to encure the Flutter web support is enabled:

flutter doctor

You may ignore the warnings about the Android and iOS tools if you are not planning to run the app on these platforms.

Install

To install the project, download the project from GitHub or clone it using the following command:

git clone https://github.com/THE-TRAVELERS/Frontend-UI.git

Then, navigate to the project directory and run the following command to install the dependencies:

cd Frontend-UI/src/control_panel
flutter pub get

Usage

Build & Run

To build and run the project, run the following command (considering you are in the project directory Frontend-UI/src/control_panel):

flutter run -d chrome

It should download the web sdk and create a web directory in the project containing the basic toolkit to run the app on the web.

Warning

If you see an error or no results, consider checking that you opened chrome beforehand.

Build the Web App

We start by the configuration:

flutter config --enable-web

Then we add the web support (if you do not see the web directory in the project) by running the following command:

flutter create .

To build the web app, run the following command:

flutter build web

Then run the following command to serve the web app locally:

python -m http.server 8000 --directory build/web

Finally, open your browser and go to this URL: http://localhost:8000.

Start dummy websockets

You may start dummy websockets to simulate the data sent by the sensors. To do so, open a terminal and run the following command:

python debug_server.py 8765

To open multiple websockets, just open another terminal and change the port number, like so:

python debug_server.py 8766

Start the raspberry pi health server

To start the server that will send the health data of the raspberry pi, run the following command:

python rasp_server.py --cpu-temp-port 8768 --cpu-usage-port 8769 --ram-usage-port 8770

Troubleshooting

If you encouter the issue Missing index.html., you can run the following command to fix it:

flutter channel beta
flutter upgrade
flutter config --enable-web

This will switch to the beta channel, upgrade the Flutter SDK and enable the web support.

Finally run again:

flutter create .
flutter build web

License

This project is licensed under the Apache 2.0 License - see the LICENSE file for details.