first initialization

Author: GvozdevLeonid

.flake8

@@ -0,0 +1,7 @@
+[flake8]
+filename = *.py,*.pyx,*.pxd,*.pxi
+ignore = E501,E203,E225,E226,E227,E402,E741,E901,E999,W503,W504
+force-check = True
+exclude =
+    __pycache__,
+    .venv,

.gitignore

@@ -0,0 +1,9 @@
+__pycache__/
+
+dist/
+.venv/
+
+.DS_Store
+.pypirc
+
+*.egg-info

LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 GvozdevLeonid
+
+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 above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+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.

MANIFEST.in

@@ -0,0 +1,3 @@
+include python_bladerf/pylibbladerf/pybladerf.pyx
+include README.md
+include pyproject.toml

README.md

@@ -0,0 +1,87 @@
+# python_bladerf
+
+python_bladerf is a cython wrapper for bladerf (https://github.com/Nuand/bladeRF). It also contains some additional tools.
+
+You can install this library using
+```
+pip install python_bladerf
+```
+Or assemble it manually using the following steps:
+
+In order to build the library you need to go to the python_bladerf directory
+```
+cd python_bladerf
+```
+call
+```
+python setup.py build_ext --inplace.
+```
+If the build fails, you will need to specify the paths for the libusb library.
+```
+CFLAGS="-I/path to libusb.h -I/path to libbladeRF.h" \
+LDFLAGS="-L/path to libusb-1.0.so -L/path to libBladeRF.so" \
+python setup.py build_ext --inplace
+```
+
+## Requirements:
+* libusb-1.0 (https://github.com/libusb/libusb)
+* libBladeRF (https://github.com/Nuand/bladeRF)
+* Cython==0.29.36
+* Numpy>=1.26
+* Scipy (optional, for faster work)
+* pyFFTW (optional, for faster work)
+
+## bladerf:
+Almost all the functionality of the standard library is implemented. Some features will be added later. (async recieve and transmit).
+
+## pybladerf tools:
+* pybladerf_info.py - Reading information about found devices.
+* pybladerf_sweep.py - Possibility to get extended range fft ( same as hackrf_sweep)
+
+## usage
+```
+usage: python_bladerf [-h] {info, sweep} ...
+
+python_bladerf is a Python wrapper for libbladerf. It also contains some additional tools.
+
+options:
+  -h, --help    show this help message and exit
+
+Available commands:
+  {info,sweep}
+    info        Read device information from Bladerf such as serial number and FPGA version.
+    sweep       a command-line spectrum analyzer.
+```
+```
+usage: python_bladerf info [-h] [-f] [-s]
+
+options:
+  -h, --help            show this help message and exit
+  -f, --full            show full info
+  -i, --device_identifiers
+                        show only founded device_identifiers
+```
+```
+usage: python_bladerf sweep [-h] [-d] [-f] [-g] [-w] [-ch] [-1] [-N] [-o] [-B] [-s] [-SR] [-BW] -[FIR] [-r]
+
+options:
+  -h, --help  show this help message and exit
+  -d          device_identifier. device identifier of desired BladeRF
+  -f          freq_min:freq_max. minimum and maximum frequencies in MHz start:stop. Default is 71:5999
+  -g          gain_db. RX gain, -15 - 60dB, 1dB steps
+  -w          bin_width. FFT bin width (frequency resolution) in Hz, 245-30000000
+  -ch         RX channel. which channel to use (0, 1). Default is 0
+  -1          one shot mode. If specified = Enable
+  -N          num_sweeps. Number of sweeps to perform
+  -o          oversample. If specified = Enable
+  -B          binary output. If specified = Enable
+  -s          sweep style ("L" - LINEAR, "I" - INTERLEAVED). Default is INTERLEAVED
+  -SR         sample rate in Hz (0.5 MHz - 122 MHz). Default is 57. To use a sample rate higher than 61, specify oversample
+  -BW         bandwidth in Hz (0.2 MHz - 56 MHz). Default is 56000000
+  -FIR        RFIC RX FIR filter ("1" - Enable, "0" - Disable). Default is Disable
+  -r          filename. output file
+```
+## Note
+This library probably can work on android. To do this, go to the android directory and download two recipes for p4a.
+## Examples
+Examples will be added later.

android/libusb/__init__.py

@@ -0,0 +1,47 @@
+from pythonforandroid.util import current_directory
+from pythonforandroid.recipe import NDKRecipe
+from pythonforandroid.logger import shprint
+from os.path import join
+import shutil
+import sh
+
+
+class LibusbRecipe(NDKRecipe):
+    version = '1.0.26'
+    url = 'https://github.com/libusb/libusb/archive/refs/tags/v{version}.tar.gz'
+    site_packages_name = 'libusb'
+    name = 'libusb'
+    generated_libraries = ['libusb1.0.so']
+
+    def should_build(self, arch):
+        return True
+
+    def get_recipe_env(self, arch):
+        env = super().get_recipe_env(arch)
+
+        env['LOCAL_C_INCLUDES'] = ' $(LIBUSB_ROOT_ABS)'
+        env['LOCAL_SHARED_LIBRARIES'] = ' libusb1.0'
+        return env
+
+    def get_lib_dir(self, arch):
+        return join(self.get_build_dir(arch.arch), 'android', 'obj', 'local', arch.arch)
+
+    def get_jni_dir(self, arch):
+        return join(self.get_build_dir(arch.arch), 'android', 'jni')
+
+    def build_arch(self, arch, *extra_args):
+        env = self.get_recipe_env(arch)
+        with current_directory(self.get_build_dir(arch.arch)):
+            shprint(
+                sh.Command(join(self.ctx.ndk_dir, "ndk-build")),
+                'NDK_PROJECT_PATH=' + self.get_build_dir(arch.arch) + '/android',
+                'NDK='+self.ctx.ndk_dir,
+                'APP_PLATFORM=android-' + str(self.ctx.ndk_api),
+                'APP_ABI=' + arch.arch,
+                *extra_args, _env=env
+            )
+
+        shutil.copyfile(join(self.get_build_dir(arch.arch), 'android', 'libs', arch.arch, 'libusb1.0.so'), join(self.ctx.get_libs_dir(arch.arch), 'libusb1.0.so'))
+
+
+recipe = LibusbRecipe()

android/python_bladerf/__init__.py

@@ -0,0 +1,45 @@
+from pythonforandroid.recipe import CythonRecipe  # type: ignore
+from pythonforandroid.recipe import Recipe  # type: ignore
+import shutil
+import os
+
+
+class PythonBladerfRecipe(CythonRecipe):
+    version = '1.0.0'
+    url = 'https://github.com/GvozdevLeonid/python_bladerf/releases/download/v.{version}/python_bladerf-{version}.tar.gz'
+    depends = ['python3', 'setuptools', 'numpy', 'libusb', 'libbladeRF']
+    site_packages_name = 'python_bladerf'
+    name = 'python_bladerf'
+
+    def get_recipe_env(self, arch):
+        env = super().get_recipe_env(arch)
+
+        libusb_recipe = Recipe.get_recipe('libusb', arch)
+        libusb_h_dir = os.path.join(libusb_recipe.get_build_dir(arch), 'libusb')
+        libusb_so_dir = libusb_recipe.get_lib_dir(arch)
+
+        libbladeRF_recipe = Recipe.get_recipe('libbladeRF', arch)
+        libbladeRF_h_dir = os.path.join(libbladeRF_recipe.get_build_dir(arch), 'libbladeRF')
+        libbladeRF_so_dir = libbladeRF_recipe.get_lib_dir(arch)
+
+        env['CFLAGS'] += ' -I' + libusb_h_dir + ' -I' + libbladeRF_h_dir
+        env['LDFLAGS'] += ' -L' + libusb_so_dir + ' -L' + libbladeRF_so_dir
+
+        return env
+
+    def postbuild_arch(self, arch):
+        super().postbuild_arch(arch)
+
+        python_bladerf_dir = os.path.join(self.ctx.get_python_install_dir(arch.arch), 'python_bladerf')
+        os.makedirs(python_bladerf_dir, exist_ok=True)
+        try:
+            shutil.move(os.path.join(self.ctx.get_python_install_dir(arch.arch), 'pylibbladerf'), os.path.join(python_bladerf_dir, 'pylibbladerf'))
+            shutil.move(os.path.join(self.ctx.get_python_install_dir(arch.arch), 'pybladerf_tools'), os.path.join(python_bladerf_dir, 'pybladerf_tools'))
+
+            shutil.copy(os.path.join(self.get_build_dir(arch.arch), '__init__.py'), python_bladerf_dir)
+            shutil.copy(os.path.join(self.get_build_dir(arch.arch), '__main__.py'), python_bladerf_dir)
+        except FileNotFoundError:
+            pass
+
+
+recipe = PythonBladerfRecipe()

pyproject.toml

@@ -0,0 +1,30 @@
+[project]
+name = "python_bladerf"
+version = "1.0.0"
+authors = [
+  {name="Leonid Gvozdev", email="[email protected]"},
+]
+description = "This is a wrapper for bladerf."
+readme = "README.md"
+requires-python = ">=3.9"
+classifiers = [
+    "Programming Language :: Python :: 3",
+    "License :: OSI Approved :: MIT License",
+    "Operating System :: MacOS",
+    "Operating System :: POSIX :: Linux",
+    "Operating System :: Android",
+]
+
+[project.urls]
+"Homepage" = "https://github.com/GvozdevLeonid/python_bladerf"
+"Bug Tracker" = "https://github.com/GvozdevLeonid/python_bladerf/issues"
+
+[build-system]
+requires = [
+    "setuptools",
+    "wheel",
+    "numpy"
+]
+
+[project.scripts]
+python_bladerf= "python_bladerf.__main__:main"

python_bladerf/__init__.py

@@ -0,0 +1,4 @@
+__version__ = '1.0.0'
+
+from python_bladerf.pylibbladerf import pybladerf  # noqa F401
+from python_bladerf.pybladerf_tools import pybladerf_sweep  # noqa F401

python_bladerf/__main__.py

@@ -0,0 +1,85 @@
+from .pybladerf_tools import (
+    pybladerf_sweep,
+    pybladerf_info,
+)
+from .pylibbladerf import pybladerf
+import argparse
+import sys
+
+
+def main():
+    parser = argparse.ArgumentParser(
+        description="python_bladerf is a Python wrapper for libbladerf. It also contains some additional tools.",
+        usage="python_bladerf [-h] {info, sweep} ..."
+    )
+    subparsers = parser.add_subparsers(dest="command", title="Available commands")
+    subparsers.required = True
+    pybladerf_info_parser = subparsers.add_parser(
+        'info', help='Read device information from Bladerf such as serial number and FPGA version.', usage="python_bladerf info [-h] [-f] [-s]"
+    )
+    pybladerf_info_parser.add_argument('-f', '--full', action='store_true', help='show full info')
+    pybladerf_info_parser.add_argument('-i', '--device_identifiers', action='store_true', help='show only founded device_identifiers')
+
+    pybladerf_sweep_parser = subparsers.add_parser(
+        'sweep', help='a command-line spectrum analyzer.', usage='python_bladerf sweep [-h] [-d] [-f] [-g] [-w] [-ch] [-1] [-N] [-o] [-B] [-s] [-SR] [-BW] -[FIR] [-r]'
+    )
+    pybladerf_sweep_parser.add_argument('-d', action='store', help='device_identifier. device identifier of desired BladeRF', metavar='', default='')
+    pybladerf_sweep_parser.add_argument('-f', action='store', help='freq_min:freq_max. minimum and maximum frequencies in MHz start:stop. Default is 71:5999', metavar='', default='71:5999')
+    pybladerf_sweep_parser.add_argument('-g', action='store', help='gain_db. RX gain, -15 - 60dB, 1dB steps', metavar='', default=20)
+    pybladerf_sweep_parser.add_argument('-w', action='store', help='bin_width. FFT bin width (frequency resolution) in Hz, 245-30000000', metavar='', default=1000000)
+    pybladerf_sweep_parser.add_argument('-ch', action='store', help='RX channel. which channel to use (0, 1). Default is 0', metavar='', default=0)
+    pybladerf_sweep_parser.add_argument('-1', action='store_true', help='one shot mode. If specified = Enable')
+    pybladerf_sweep_parser.add_argument('-N', action='store', help='num_sweeps. Number of sweeps to perform', metavar='')
+    pybladerf_sweep_parser.add_argument('-o', action='store_true', help='oversample. If specified = Enable')
+    pybladerf_sweep_parser.add_argument('-B', action='store_true', help='binary output. If specified = Enable')
+    pybladerf_sweep_parser.add_argument('-s', action='store', help='sweep style ("L" - LINEAR, "I" - INTERLEAVED). Default is INTERLEAVED', metavar='', default='I')
+    pybladerf_sweep_parser.add_argument('-SR', action='store', help='sample rate in Hz (0.5 MHz - 122 MHz). Default is 57. To use a sample rate higher than 61, specify oversample', metavar='', default=57)
+    pybladerf_sweep_parser.add_argument('-BW', action='store', help='bandwidth in Hz (0.2 MHz - 56 MHz). Default is 56000000', metavar='', default=56.0)
+    pybladerf_sweep_parser.add_argument('-FIR', action='store', help='RFIC RX FIR filter ("1" - Enable, "0" - Disable). Default is Disable', metavar='', default='0')
+    pybladerf_sweep_parser.add_argument('-r', action='store', help='filename. output file', metavar='')
+
+    if len(sys.argv) == 1:
+        parser.print_help()
+        sys.exit(0)
+
+    args, unparsed_args = parser.parse_known_args()
+    if args.command == 'info':
+        if args.device_identifiers:
+            pybladerf_info.pybladerf_device_identifiers_list_info()
+        else:
+            pybladerf_info.pybladerf_info()
+
+    elif args.command == 'sweep':
+        frequency_range = args.f.split(':')
+        frequencies = [71, 5999]
+        freq_min, freq_max = None, None
+        try:
+            freq_min = int(frequency_range[0])
+        except Exception:
+            pass
+        try:
+            freq_max = int(frequency_range[1])
+        except Exception:
+            pass
+        if freq_min is not None and freq_max is not None:
+            frequencies = [freq_min, freq_max]
+
+        pybladerf_sweep.pybladerf_sweep(frequencies=frequencies,
+                                        gain=int(args.g),
+                                        bin_width=int(args.w),
+                                        sample_rate=float(args.SR) * 1e6,
+                                        bandwidth=float(args.BW) * 1e6,
+                                        channel=int(args.ch),
+                                        oversample=args.o,
+                                        num_sweeps=int(args.N) if args.N is not None else None,
+                                        binary_output=args.B,
+                                        one_shot=args.__dict__.get('1'),
+                                        filename=args.r,
+                                        device_identifier=args.d,
+                                        rxfir=pybladerf.pybladerf_rfic_rxfir.PYBLADERF_RFIC_RXFIR_DEC1 if args.FIR == '1' else (pybladerf.pybladerf_rfic_rxfir.PYBLADERF_RFIC_RXFIR_BYPASS if args.FIR == '0' else -1),
+                                        sweep_style=pybladerf.pybladerf_sweep_style.PYBLADERF_SWEEP_STYLE_LINEAR if args.s == 'L' else (pybladerf.pybladerf_sweep_style.PYBLADERF_SWEEP_STYLE_INTERLEAVED if args.s == 'I' else -1),
+                                        print_to_console=True)
+
+
+if __name__ == '__main__':
+    main()