Raven Setup Instructions

Version 1.0.0 Beta

Prerequisites

Please read the full documentation here

Before proceeding, ensure you have the following installed on your system.

• Python 3
• pip + virtualenv
• rtl-sdr package, including rtl_tcp and rtl_power
• hackrf_sweep for the HackRF
• Optionally docker

Installation and Setup

Before starting Rave, make sure that you have the backend tools like rtl_tcp, rtl_power, or hackrf_sweep installed and updated to the most current version. If you're on Windoze, make sure that you have these in your system PATH. Instuctions for all of this can be found with some quick Googleing.

1. Clone the Source Code

   git clone https://github.com/fosatech/Raven.git

2. Navigate to the Project Directory

   cd Raven/

3. Create a Python Virtual Environment:

   python3 -m venv venv

4. Activate the Virtual Environment:

   source venv/bin/activate

5. Install Dependencies:

   python -m pip install -r requirements.txt

6. Run the Flask Application:

   python raven.py

   Note: this currently starts the Flask development server. Proper WSGI server support is coming soon.

Docker

Dockerfile and docker-compose.yml files have been added to the repo.

To build and run application run the following command

./startContainer.sh

Additionally, the Docker image is built with GitHub actions on the main branch.

If you open up the docker-compose.yml and modify this line:

    image: raven

to be

    image: ghcr.io/fosatech/raven:latest

Then run docker compose run --publish 5000:5000 raven to start the container

This bash script will build the docker image from the Docker file and then run the container from the docker compose file.

Usage

After completing the setup, the Flask application will be running on your local server. You can access it via localhost:5000/rtl_data.

1. Open the settings window, enter the desired wideband scan range and bin size, and start the scan.

2. Start the rtl_tcp server with the desired port and IP, and connect to it with your SDR software.

3. Select your desired rtl-tcp server instance by clicking on the current frequency, then ctrl + left click on the wideband window and Raven will automatically tune your SDR to it.