Skip to content

Commit 5c772c6

Browse files
authored
Merge pull request #65 from joecupano/develop
v8.0 release
2 parents 5145b9a + 6419561 commit 5c772c6

File tree

259 files changed

+6734
-6938
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

259 files changed

+6734
-6938
lines changed

DEVELOPER_NOTES.md

Lines changed: 0 additions & 214 deletions
This file was deleted.

README.md

Lines changed: 45 additions & 49 deletions
Original file line numberDiff line numberDiff line change
@@ -1,18 +1,21 @@
11
# SIGpi
22

3-
RELEASE 7.0
4-
53
## Introduction
64

7-
SIGpi is a "go-kit" for Signal Intelligence (SIGINT) enthusiasts with capabilities in the HF, VHF, UHF, and SHF spectrum. It includes a framework for simple installation and management of popular SIGINT appliucations and devices made mostly from bash scripts building/installing SIGINT tools on the following platforms:
5+
SIGpi is a "go-kit" for Signal Intelligence (SIGINT) enthusiasts with capabilities in the HF, VHF, UHF, and SHF spectrum. It includes a framework for simple installation and management of popular SIGINT applications and devices building/installing SIGINT tools on the following platforms:
6+
7+
**Full Install**
8+
- Ubuntu 22.04 LTS (64-bit) on Intel or Rasberry Pi 4/5
9+
- 4GB RAM, 32GB storage
810

9-
- **Raspberry Pi4 4GB RAM** or **Raspberry Pi 400** with 32GB microSD card running **Raspberry Pi OS "Bullseye" or "Bookworm" Full (64-bit)**
10-
- arm64 or amd64 platforms with 4GB RAM and 32GB storage minimum runniing **Ubuntu 22.04 LTS**
11+
**Server Only**
12+
- Ubuntu 22.04 LTS (64-bit) on Intel or Rasberry Pi 3/4/5
1113

12-
## Quick Setup
14+
The [wiki](https://github.com/joecupano/SIGpi/wiki) goes deep on all things SIGpi.
15+
16+
## Setup
1317

1418
- Login as pi or sudo user on supported platform
15-
- Update and install pre-requisite packages to install SIGpi
1619
- From your home directory, create a directory called SIG and switch into it
1720
- Clone the SIGpi repo
1821
- Change directory into SIGpi
@@ -26,95 +29,88 @@ git clone https://github.com/joecupano/SIGpi.git
2629
cd SIGpi
2730
```
2831

29-
Run the following command from $HOME/SIG/SIGpi to install the framework and package management
32+
Run the following command from **$HOME/SIG/SIGpi** to install
3033

3134
```
3235
./SIGpi setup standard
3336
```
3437

35-
After setup system will reboot.
38+
## Adding Devices
39+
40+
Once started you will be given a menu of devices you can choose to install with RTLSDR and HackRF selected as default. Select the additional devices you would like to install and then click **OK**. For the next 15 to 20 minutes you will see messages scroll by as the SIGpi platform components are installed
3641

37-
### Add a Package
42+
After setup the system will reboot.
3843

39-
Once setup, you can list the inventory of packages SIGpi includes as well as those already installed
40-
with the following command (note that ./ is no longer required for thr SIGpi command after setup)
44+
Don't worry about missing a device. Post install you can add it using **SIGpi device install <DEVICE>**
45+
46+
## Adding Packages
47+
48+
Once setup, you can list the inventory of packages SIGpi includes as well as those already installed with the following
4149

4250
```
4351
SIGpi list library
4452
```
4553

46-
An asterisk in the INSTALLED column indicates that package is already installed while those withou asterisks
47-
have not been installed. For example, you will see SDRangel has not been installed. You can do so with the following command.
54+
Note that **./** is no longer required for the SIGpi command after setup. An **asterisk** in the INSTALLED column indicates that package is already installed while those without asterisks
55+
have not been installed. For example, you will see **SDRangel** has not been installed. You can do so with the following
4856

4957
```
5058
SIGpi install sdrangel
5159
```
5260

5361
Go back and list again to install other packages of interest
5462

55-
## Overview of Commands
63+
## Managing Packages
5664

57-
Typing SIGpi by itself will give you the list of commands available.
58-
59-
SIGpi includes it's own package management platform to update applications to their latest releases using familiar syntax from package management systems. Here is an overview of available commands.
65+
Packages can be installed, removed and purged using the following commands respectively
6066

6167
```
62-
Usage: SIGpi [ACTION] [TARGET]
63-
64-
ACTION
65-
66-
install install TARGET from current release
67-
remove remove installed TARGET
68-
purge remove installed TARGET and purge configs
69-
build compile and install TARGET (option may not be available)
70-
update check for update of TARGET
71-
upgrade upgrade TARGET to latest release
72-
73-
TARGET
68+
SIGpi install <package>
69+
SIGpi remove <package>
70+
SIGpi purge <package>
71+
```
7472

75-
A SIGpi package
76-
73+
Periodically new applications will be added to SIGpiand notifications sent to those watching the repo. To add applcations available for install into your SIGpi instance simple run run the following from within your /home/pi/SIG/SIGpi directory
7774

78-
Usage: SIGpi [ACTION]
75+
```
76+
git pull
77+
```
7978

80-
ACTION
79+
You will see the new applications as available running the list library command
8180

82-
SIGpi setup standard First time setup for desktop
83-
SIGpi setup server First time setup for server
84-
SIGpi list packages List all packages included with SIGpi
85-
SIGpi list installed List installed SIGpi packages
86-
SIGpi list library List all packages included with SIGpi with installed ones marked with an *
87-
SIGpi shell provide SIGpi env variables around a TARGET
81+
```
82+
SIGpi list library
8883
```
8984

90-
You can update packages in your existing SIGpi install. For example, Is there a **SDRangel** update. If so install it:
85+
You can update packages in your existing SIGpi install. For example, if there is a **SDRangel** update you can run
9186

9287
```
9388
SIGpi update sdrangel
9489
95-
Update 7.17.4 is available
90+
Update 7.22.123 is available
9691
9792
SIGpi upgrade sdrangel
9893
```
9994

100-
You can add/remove Packages anytime
95+
## Server-only Setup
96+
97+
SIGpi includes a headless server option. From a fresh **Ubuntu 22.04 LTS server** install run the following
10198

10299
```
103-
SIGpi install audacity
104-
SIGpi remove audacity
100+
./SIGpi setup server
105101
```
106102

103+
During setup you will have the option to run either **RTL-TCP, SDRangel Server, or SoapySDR server** on startup or choose not to start any of them. After setup system will reboot.
104+
107105
## Example Hardware Setup
108106
![alt-test](https://github.com/joecupano/SIGpi/blob/main/backgrounds/SIGpi_architecture.png)
109107

110108
### Power
111-
In this setup a 12V@17A switching supply powers all the kit. Since RPi4 are picky about getting 5.1V a set-up converter is added to power it. A 12V Rpi4 are pickya bout getting 5.1V. USB peripherals can be hungry so a powered USB hub is included. While 7 ports are available no more than three devices requiring power should be enabled since hub produces a maximum of 36 Watts ( 3 x 5V x 2.4A = 36 Watts)
109+
In this setup a 12V@17A switching supply powers all the kit. Since RPi4 are picky about getting 5.1V a set-up converter is added to power it. A 12V Rpi4 are picky about getting 5.1V. USB peripherals can be hungry so a powered USB hub is included. While 7 ports are available no more than three devices requiring power should be enabled since hub produces a maximum of 36 Watts ( 3 x 5V x 2.4A = 36 Watts)
112110

113-
### Raspberry RPi4
111+
### Raspberry RPi4/5
114112
Since this is a SIGINT platform we do not want to be generating any RF so onboard Bluetooth and WiFi should be disabled. If Internet is needed and only available via WiFi then so be it and use your onboard WiFi.
115113

116114
### USB Peripherals
117115
Only three USB devices requiring power should be enabled at a time. The range of devices depicted is only to demonstrate what you could potentially connect to it.
118116

119-
## What Else
120-
Check out the [wiki](https://github.com/joecupano/SIGpi/wiki)

RELEASE_NOTES.md renamed to RELEASE_HISTORY.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,8 @@
11
# Release Notes
22

3+
## Release 8.0: 2026-01-26
4+
- Major Release. See [wiki](https://github.com/joecupano/SIGpi/wiki)
5+
36
## Release 7.0: 2024-01-15
47
- Major Release. See [wiki](https://github.com/joecupano/SIGpi/wiki)
58

0 commit comments

Comments
 (0)