NovaOps Backend

Overview

TBD

Directory Structure

/novaOps
│
├── backend/
│   └── app/
│       ├── __init__.py            # Marks this directory as a Python package
│       ├── main.py                # Main application entry point for FastAPI
│       ├── auth.py                # Handles authentication using OAuth2 and JWT tokens
│       ├── data_file.py           # Stores mock sensor and actuator data used in the system
│       ├── html_generator.py      # Temporary generator for the HTML for the sensor and actuator dashboard
├── docker-compose.yml              # Defines services and configurations for running Docker containers
├── Dockerfile                      # Docker instructions for building the FastAPI app image
└── README.md                       # This README file

Important Notes

1. The html_generator.py file is currently used as a small simple ui for backend testing but it will be replaced soon

2. The server is not currently connected to any ground hardware so the dummy_pi.py file randomly generates new data and changes the actuator status in the data file. This will eventually be replaced by the MQTT hardware interface.

Requirements

To run this project, you will need Docker and Docker Compose installed on your machine. Installation guides for Docker can be found here and for Docker Compose here.

Running the Application

1. Clone the Repository:

   git clone https://github.com/UTATRocketry/novaOps-back.git
   cd /path/to/novaOps-back
   git checkout fastapi_server

2. Build and Run the Docker Containers:

   sudo docker-compose up --build

3. Viewing the Application: Once the container is running, you can access the application in your browser at: http://localhost:8000 To see the stdin, stdout, stderr from the container run:

   docker attach CONTAINER
   

4. Stopping the Application: To stop the application, use CTRL+C in the original terminal where you started the app or run sudo docker-compose stop in a second terminal within the novaOps-back directory.

To setup a Raspberry Pi with the Config Scripts

1. Clone the Repository:

   git clone https://github.com/UTATRocketry/novaOps-back.git
   cd /path/to/novaOps-back
   git checkout fastapi_server

2. Update Log File Path: # Save a log of all commands and their output Update line 4 exec > /path/to/nova/session.log 2>&1 of the initial_config.sh file, so that the file path is accurate

3. Make the scripts executable:

chmod +x /path/to/nova/initial_config.sh
chmod +x /path/to/nova/post_reboot_config.sh

4. Run the scripts:

• Run initial_config.sh wait for it to reboot the Pi and then run post_reboot_config.sh.
• This will start the server on http://192.168.0.1:8000. Use that if connected by ethernet or http://raspberrypi.local:8000 to see the application in a browser.
• Use sudo docker-compose stop to stop and sudo docker-compose up to run again.
• The HTTP data endpoint is at http://raspberrypi.local:8000/front and the Websocket data endpoint is at http://raspberrypi.local:8000/ws_basic

Troubleshooting

Stopping the Application: To stop the application and remove the containers entirely, run:

sudo docker-compose down

Can't connect to server via client:

• Check if server is accessible from the pi at http://0.0.0.0:8000
• Check if the static IP address is configured correctly with ip addr show eth0
• Check if DHCP is enabled and running with sudo systemctl status dhcpcd
• Check if DNS is enabled and running with sudo systemctl status dnsmasq
• Check if the Docker container is running with sudo docker ps