Skip to content

Commit

Permalink
Added check-install.sh
Browse files Browse the repository at this point in the history
  • Loading branch information
lk-iqt committed Mar 20, 2024
1 parent dd88909 commit eb1b23b
Show file tree
Hide file tree
Showing 3 changed files with 84 additions and 0 deletions.
43 changes: 43 additions & 0 deletions bin/check-install.sh
Original file line number Diff line number Diff line change
@@ -0,0 +1,43 @@
#! /usr/bin/env bash

# Script to check GamutRF install

#Check Docker
if [ -x "$(command -v docker)" ]; then
echo "Docker install...PASS"
else
echo "Docker install...FAIL"
echo "ERROR: Please check your installation of docker"
fi

#Check UHD Driver
if [ -x "$(command -v uhd_find_devices)" ]; then
echo "UHD install...PASS"
else
echo "ERROR: UHD install...FAIL"
echo "ERROR: Please check your installation of uhd_host"
fi

#Check for SDR
if uhd_find_devices >&/dev/null; then
echo "Ettus SDR found...PASS"
else
echo "ERROR: Ettus SDR found...FAIL"
echo "ERROR: Please check your B200 is plugged in"
fi

#Check Folders
if [ -d /flash/gamutrf ]; then
echo "Flash directory install...PASS"
else
echo "WARNING: Flash directory install...FAIL"
echo "WARNING: Please check your directory structure"
fi

#Check GamutRF containters
if docker images | grep 'iqtlabs/gamutRF'; then
echo "GamutRF containers install...PASS"
else
echo "WARNING: GamutRF containers install...FAIL"
echo "WARNING: Please pull the GamutRF containers. Run ./bin/update.sh"
fi
1 change: 1 addition & 0 deletions bin/install-deps.sh
Original file line number Diff line number Diff line change
Expand Up @@ -22,4 +22,5 @@ if [[ $PWD != *"gamutRF"* ]]; then
git clone https://github.com/IQTLabs/gamutRF
git clone https://github.com/IQTLabs/BirdsEye
fi

sudo mkdir -p /flash/gamutrf
40 changes: 40 additions & 0 deletions docs/3-BUILD.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,6 +23,46 @@ These instructions are for 2 different machines:

## Orchestrator

### Quick Installation

If you installing on x86 or Arm without need for GPIO or GPS.

1. Either clone the repo or copy the `gamutRF/bin/install-deps.sh` install script.
```bash
git clone https://github.com/IQTLabs/gamutRF
```

2. Run install script
```bash
cd gamutRF
chmod +x bin/install-deps.sh
./bin/install-deps.sh
```

3. Check install was completed
```bash
chmod +x bin/check-install.sh
./bin/check-install.sh
```

4. Pull/Update GamutRF containers
```bash
chmod +x bin/update.sh
./bin/update.sh
```

5. Start the Orchestrator containers
```bash
VOL_PREFIX=/flash/gamutrf/ FREQ_START=70e6 FREQ_END=6e9 docker compose -f orchestrator.yml -f torchserve.yml up mqtt gamutrf waterfall -d
```
If successful, you should see the containers running with `docker ps`.

5. Navigate to localhost:9003 to see GUI.

### Advanced Installation

If you are installing on a Raspberry Pi, need access to GPIO, or you will need a few additional steps for installation.

1. Install Raspberry Pi4 to 7" Touchscreen

2. Install GPS module to the 7" Touchscreen 40-pin header
Expand Down

0 comments on commit eb1b23b

Please sign in to comment.