sdr-scanner 0.1.0__tar.gz

sdr_scanner-0.1.0/LICENSE

@@ -0,0 +1,18 @@
+MIT License
+
+Copyright (c) 2026 Johan Sheby Melethe
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

sdr_scanner-0.1.0/MANIFEST.in

@@ -0,0 +1,4 @@
+include README.md
+include LICENSE
+include pyproject.toml
+recursive-include libs *

sdr_scanner-0.1.0/PKG-INFO

@@ -0,0 +1,59 @@
+Metadata-Version: 2.4
+Name: sdr-scanner
+Version: 0.1.0
+Summary: SDR Scanner utilities and tools
+Author-email: Johan Sheby <Jotheexplorer123@gmail.com>
+License: MIT
+Keywords: sdr,rtl-sdr,radio,scanner,spectrum
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.8
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: OS Independent
+Requires-Python: >=3.8
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: numpy>=1.24
+Requires-Dist: matplotlib>=3.0
+Requires-Dist: pyrtlsdr>=0.2.9
+Dynamic: license-file
+
+# **SDRScan**
+**by Johan Sheby**
+
+---
+SDRSCan is a simple python program that lets you automatically scan through large radio spectrums and bands using an Software Defined Radio .
+
+
+
+# Features
+SDRScan features two modes of scanning , custom where you are able to input the : 
+* Start frequency
+* End frequency
+* Step Frequency
+* Step Length (seconds)
+
+and band mode where you are able to select pre programed frquency ranges : 
+* FM
+* AM
+* Aviation
+* Maritime
+
+# Hardware Support
+This program currently only supports RTL-SDRS (Tested with the [ RTL-SDR V4](https://www.rtl-sdr.com/rtl-sdr-blog-v4-end-of-line/))
+Airspy and Noolec Support : Maybe :man-shrugging: 
+
+# Installation
+1. Ensure Proper Drivers are installed (refer [here](https://www.rtl-sdr.com/rtl-sdr-quick-start-guide/))
+
+# AI Use 
+
+AI Has been used in this project to : 
+* Set up folder structure for PyPi
+* Autofill
+* Repetive copy pasting 
+* Running Tests 
+* Troupleshooting drivers 
+

sdr_scanner-0.1.0/README.md

@@ -0,0 +1,37 @@
+# **SDRScan**
+**by Johan Sheby**
+
+---
+SDRSCan is a simple python program that lets you automatically scan through large radio spectrums and bands using an Software Defined Radio .
+
+
+
+# Features
+SDRScan features two modes of scanning , custom where you are able to input the : 
+* Start frequency
+* End frequency
+* Step Frequency
+* Step Length (seconds)
+
+and band mode where you are able to select pre programed frquency ranges : 
+* FM
+* AM
+* Aviation
+* Maritime
+
+# Hardware Support
+This program currently only supports RTL-SDRS (Tested with the [ RTL-SDR V4](https://www.rtl-sdr.com/rtl-sdr-blog-v4-end-of-line/))
+Airspy and Noolec Support : Maybe :man-shrugging: 
+
+# Installation
+1. Ensure Proper Drivers are installed (refer [here](https://www.rtl-sdr.com/rtl-sdr-quick-start-guide/))
+
+# AI Use 
+
+AI Has been used in this project to : 
+* Set up folder structure for PyPi
+* Autofill
+* Repetive copy pasting 
+* Running Tests 
+* Troupleshooting drivers 
+

sdr_scanner-0.1.0/libs/FilePlacementREADME.md

@@ -0,0 +1,3 @@
+Add this inside the lib folder of You Virtual Enviroment if you face errors . I had mine here :
+sdr_env\Lib\site-packages\rtlsdr\librtlsdr.dll
+sdr_env\Lib\site-packages\rtlsdr\librtlsdr.dll

sdr_scanner-0.1.0/pyproject.toml

@@ -0,0 +1,31 @@
+[build-system]
+requires = ["setuptools>=61.0", "wheel"]
+build-backend = "setuptools.build_meta"
+
+[project]
+name = "sdr-scanner"
+version = "0.1.0"
+description = "SDR Scanner utilities and tools"
+readme = "README.md"
+requires-python = ">=3.8"
+license = { text = "MIT" }
+authors = [ { name = "Johan Sheby", email = "Jotheexplorer123@gmail.com" } ]
+dependencies = [
+  "numpy>=1.24",
+  "matplotlib>=3.0",
+  "pyrtlsdr>=0.2.9",
+]
+classifiers = [
+  "Programming Language :: Python :: 3",
+  "Programming Language :: Python :: 3.8",
+  "Programming Language :: Python :: 3.9",
+  "Programming Language :: Python :: 3.10",
+  "Programming Language :: Python :: 3.11",
+  "License :: OSI Approved :: MIT License",
+  "Operating System :: OS Independent",
+]
+keywords = ["sdr", "rtl-sdr", "radio", "scanner", "spectrum"]
+
+[tool.setuptools]
+packages = ["sdr_scanner"]
+include-package-data = true

sdr_scanner-0.1.0/sdr_scanner/__init__.py

@@ -0,0 +1,9 @@
+"""sdr_scanner package
+
+Expose a tiny API and package version.
+"""
+
+__version__ = "0.1.0"
+
+
+__all__ = []

sdr_scanner-0.1.0/sdr_scanner/core.py

@@ -0,0 +1,202 @@
+"""Author : Johan Sheby
+   Date : 23/06/2025
+   Project : Multipurpose SDR CLI Toolkit
+"""
+######IMPORTS#####
+import os
+from time import sleep, time
+from datetime import datetime
+
+try:
+    from rtlsdr import RtlSdr as sdr
+except Exception:
+    sdr = None
+import numpy as np
+import math 
+import json
+import matplotlib.pyplot as plt
+from dataclasses import dataclass
+
+#####INITS########
+
+
+####FUNCTIONS#####
+
+
+def clear_terminal():
+    """Clear the terminal screen"""
+    os.system('cls' if os.name == 'nt' else 'clear')
+    
+
+def write(file_path:str , write_material) :
+    with open(file_path, "w", encoding="utf-8") as file:
+        file.write(write_material)
+
+
+def listen_freq(sdr_device, freq: float):
+    """
+    Function to listen to a specific frequency using the selected SDR device.
+
+    Parameters:
+    sdr_device: The SDR device instance
+    freq (float): The frequency to listen to in   Mhz
+    """
+    
+    sdr_device.center_freq = (freq*10**6)
+
+
+    samples = sdr_device.read_samples(256*1024)
+
+    return samples
+   
+
+def scanner(sdr_device, freq_start: float, freq_end: float, step: float , step_time:float , peak_check : bool):
+    """
+    Function to scan a range of frequencies using selected SDR device """
+    
+    freq_start = float(freq_start) 
+    freq_end = float(freq_end)
+
+    @dataclass
+    class ScanResults:
+        full_range: dict
+        peak_freq: float
+        peak_power: float
+
+    results = {}
+
+    sdr_device.center_freq = (freq_start*10**6)
+
+    # Calculate decimal precision based on step size
+    decimal_places = len(str(step).split('.')[-1]) if '.' in str(step) else 0
+    
+    for freq in np.arange(freq_start, freq_end+step, step):
+        freq = round(freq, decimal_places + 1)
+        sleep(step_time)
+        samples = sdr_device.read_samples(256*1024)
+        power = np.mean(np.abs(samples) ** 2)
+        db = 10 * np.log10(power + 1e-10)
+        results[freq] = db
+        
+    if peak_check == True and results:
+        peak_freq = max(results, key=results.get)
+        peak_power = results[peak_freq]
+    else:
+        peak_freq = None
+        peak_power = None
+    return ScanResults(results, peak_freq, peak_power)
+
+def plot(data_sourcefile : str) :
+
+ with open(data_sourcefile , 'r') as f :
+     data = json.load(f)
+     frequencies = sorted([float(freq) for freq in data.keys()])
+     db_values = [data[str(f)] for f in frequencies]
+     plt.figure(figsize = (12,16))
+
+     plt.plot(frequencies, db_values, 'b-o', linewidth=2, markersize=6)
+     plt.xlabel('Frequency (MHz)')
+     plt.ylabel('Power (dB)')
+     plt.title('SDR Frequency Scan')
+     plt.grid(True, alpha=0.3)
+     plt.tight_layout()
+     plt.show()
+
+def main_menu():
+    clear_terminal()
+    print("SDR Scanner Main Menu")
+    print("1. Custom Scan")
+    print("2. Band Scan")
+    print("3. Exit")
+    choice = input("Select an option: ")
+    
+    if choice == '1':
+        custom_scan()
+    elif choice == '2':
+        band_scan()
+    elif choice == '3':
+        print("Exiting...")
+        exit()
+    else:
+        print("Invalid choice. Please try again.")
+        sleep(2)
+        main_menu()
+def custom_scan():
+    global sdr_device
+
+    clear_terminal()
+    freq_start_selection = float(input("Input start frequency (Mhz) :  "))
+    clear_terminal()
+    end_freq_selection = float(input("Input End frequency (Mhz) : "))
+    clear_terminal()
+    freq_step_selection = float(input("Input step frequency (Mhz) : "))
+    clear_terminal()
+    step_time_selection = float(input("Input step time (Seconds) : "))
+    clear_terminal()
+    clear_terminal()
+    filenameinput = str(input("What Should the result File Called ? : "))
+    clear_terminal()
+    
+    print(f"starting Scan from {freq_start_selection} to {end_freq_selection}")
+    scan_result = scanner(sdr_device,freq_start_selection,end_freq_selection, freq_step_selection, step_time_selection,True)
+    clear_terminal()
+    
+    write(f"sdr_scanner/{filenameinput}.json", json.dumps(scan_result.full_range, indent=2))    
+    print(f"Result saved to '{filenameinput}.json' ")
+    plot(f"sdr_scanner/{filenameinput}.json")
+    print(f"Peak Frequency: {scan_result.peak_freq} MHz, Peak Power: {scan_result.peak_power} dB")
+def band_scan():
+    global sdr_device
+    clear_terminal()
+
+    input_band= input("Press Enter to start Band Scan (1.FM, 2.AM, 3.Aviation 4.Maritime) : ")
+    
+    if input_band == "1" :
+        print("Starting FM Band Scan from 88.0 MHz to 108.0 MHz")
+        scan_result = scanner(sdr_device, 88.0, 108.0, 0.2, 0.5, True)
+        write(f"sdr_scanner/fm_scan_{datetime.now().strftime('%Y-%m-%d_%H-%M-%S')}.json", json.dumps(scan_result.full_range, indent=2))
+        print("FM Band Scan Complete ")
+    elif input_band == "2" :
+        print("Starting AM Band Scan from 530.0 KHz to 1700.0 KHz")
+        scan_result = scanner(sdr_device, 530.0, 1700.0, 1.0, 0.5, True)
+        write(f"sdr_scanner/am_scan_{datetime.now().strftime('%Y-%m-%d_%H-%M-%S')}.json", json.dumps(scan_result.full_range, indent=2))
+        print("AM Band Scan Complete ")
+    
+    elif input_band == "3" :
+        print("Starting Aviation Band Scan from 118.0 MHz to 137.0 MHz")
+        scan_result = scanner(sdr_device, 118.0, 137.0, 0.2, 0.5, True)
+        write(f"sdr_scanner/aviation_scan_{datetime.now().strftime('%Y-%m-%d_%H-%M-%S')}.json", json.dumps(scan_result.full_range, indent=2))
+        print("Aviation Band Scan Complete ")
+
+    elif input_band == "4" :
+        print("Starting Maritime Band Scan from 156.0 MHz to 174.0 MHz")
+        scan_result = scanner(sdr_device, 156.0, 174.0, 0.2, 0.5, True)
+        write(f"sdr_scanner/maritime_scan_{datetime.now().strftime('%Y-%m-%d_%H-%M-%S')}.json", json.dumps(scan_result.full_range, indent=2))
+        print("Maritime Band Scan Complete ")
+        
+##################
+def main():
+    global sdr_device
+
+    SDR_SELECTION = input("Select SDR Device (1 for RTL-SDR, 2 for Airspy): ")
+    if SDR_SELECTION == '1':
+        sdr_device = sdr()
+    
+    sdr_device.sample_rate = 2.4e6
+    sdr_device.center_freq = 98.6e6
+    sdr_device.gain = 'auto'
+    main_menu()
+    clear_terminal()
+
+
+
+
+
+if __name__ == "__main__":
+    main()
+
+
+        
+
+
+ 

sdr_scanner-0.1.0/sdr_scanner.egg-info/PKG-INFO

@@ -0,0 +1,59 @@
+Metadata-Version: 2.4
+Name: sdr-scanner
+Version: 0.1.0
+Summary: SDR Scanner utilities and tools
+Author-email: Johan Sheby <Jotheexplorer123@gmail.com>
+License: MIT
+Keywords: sdr,rtl-sdr,radio,scanner,spectrum
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.8
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: OS Independent
+Requires-Python: >=3.8
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: numpy>=1.24
+Requires-Dist: matplotlib>=3.0
+Requires-Dist: pyrtlsdr>=0.2.9
+Dynamic: license-file
+
+# **SDRScan**
+**by Johan Sheby**
+
+---
+SDRSCan is a simple python program that lets you automatically scan through large radio spectrums and bands using an Software Defined Radio .
+
+
+
+# Features
+SDRScan features two modes of scanning , custom where you are able to input the : 
+* Start frequency
+* End frequency
+* Step Frequency
+* Step Length (seconds)
+
+and band mode where you are able to select pre programed frquency ranges : 
+* FM
+* AM
+* Aviation
+* Maritime
+
+# Hardware Support
+This program currently only supports RTL-SDRS (Tested with the [ RTL-SDR V4](https://www.rtl-sdr.com/rtl-sdr-blog-v4-end-of-line/))
+Airspy and Noolec Support : Maybe :man-shrugging: 
+
+# Installation
+1. Ensure Proper Drivers are installed (refer [here](https://www.rtl-sdr.com/rtl-sdr-quick-start-guide/))
+
+# AI Use 
+
+AI Has been used in this project to : 
+* Set up folder structure for PyPi
+* Autofill
+* Repetive copy pasting 
+* Running Tests 
+* Troupleshooting drivers 
+

sdr_scanner-0.1.0/sdr_scanner.egg-info/SOURCES.txt

@@ -0,0 +1,15 @@
+LICENSE
+MANIFEST.in
+README.md
+pyproject.toml
+libs/FilePlacementREADME.md
+libs/librtlsdr.dll
+libs/libusb-1.0.dll
+sdr_scanner/__init__.py
+sdr_scanner/core.py
+sdr_scanner.egg-info/PKG-INFO
+sdr_scanner.egg-info/SOURCES.txt
+sdr_scanner.egg-info/dependency_links.txt
+sdr_scanner.egg-info/requires.txt
+sdr_scanner.egg-info/top_level.txt
+tests/test_core.py

sdr_scanner-0.1.0/sdr_scanner.egg-info/dependency_links.txt

@@ -0,0 +1 @@
+

sdr_scanner-0.1.0/sdr_scanner.egg-info/requires.txt

@@ -0,0 +1,3 @@
+numpy>=1.24
+matplotlib>=3.0
+pyrtlsdr>=0.2.9

sdr_scanner-0.1.0/sdr_scanner.egg-info/top_level.txt

@@ -0,0 +1 @@
+sdr_scanner

sdr_scanner-0.1.0/setup.cfg

@@ -0,0 +1,4 @@
+[egg_info]
+tag_build = 
+tag_date = 0
+

sdr_scanner-0.1.0/tests/test_core.py

@@ -0,0 +1,14 @@
+import json
+
+from sdr_scanner.core import write
+
+
+def test_write_and_read(tmp_path):
+	temp_scan = {"100.0": -10.5, "101.0": -20.0}
+	file_path = tmp_path / "scanned_frequencies.json"
+	write(str(file_path), json.dumps(temp_scan, indent=2))
+
+	with open(file_path, "r", encoding="utf-8") as f:
+		data = json.load(f)
+
+	assert data == temp_scan