AOR GQRX Raspberry Pi Package 0.1.0
===================================

Overview
--------

This package provides native live I/Q support for compatible AOR receivers
with GQRX on Raspberry Pi.

It includes:

- SoapyAOR 0.1.0 native SoapySDR driver
- AOR FX2 I/Q interface firmware
- Automatic firmware loader
- Stable /dev/aor-control receiver control interface
- Raspberry Pi GQRX launcher
- Installer and uninstaller

Supported Platform
------------------

Tested and supported:

    Raspberry Pi 4 Model B
    Raspberry Pi OS 64-bit (Trixie)

Experimental / untested:

    Raspberry Pi 5 Model B

The installer refuses installation on other hardware.

Supported AOR Receivers
-----------------------

Current model support includes:

    AR2300
    AR5001D
    AR5700D
    AR6000

The AR5700D has been used for development and testing of this release.

I/Q Interface
-------------

USB VID/PID:

    08d0:a001

Native sample rate:

    1125000 samples/second

Native stream format:

    CF32

Receiver Control
----------------

Receiver control uses the AOR FTDI serial interface.

The installer automatically detects the connected FTDI interface and creates:

    /dev/aor-control

This stable device name is used by SoapyAOR for receiver tuning.

Installation
------------

Connect both the receiver control USB cable and I/Q USB cable.

From this package directory run:

    ./install.sh

Do not run install.sh with sudo.

The installer requests sudo privileges only when system changes are required.

The installer:

- installs required Raspberry Pi OS packages
- builds and installs SoapyAOR
- installs the AOR firmware and launcher
- installs USB/udev rules
- creates /dev/aor-control
- installs the Raspberry Pi GQRX menu launcher

Starting GQRX
-------------

After installation, start Gqrx from the Raspberry Pi menu.

The AOR launcher automatically:

- verifies supported Raspberry Pi hardware
- temporarily selects the performance CPU governor
- detects the AOR I/Q USB interface
- loads the volatile FX2 firmware when required
- starts GQRX
- restores the previous CPU governor when GQRX exits

On first use in GQRX select the AOR I/Q Receiver and use:

    Input rate: 1125000

The FX2 firmware is volatile and must be loaded again whenever the I/Q
interface loses power. The launcher handles this automatically.

Uninstallation
--------------

From this package directory run:

    ./uninstall.sh

The uninstaller removes the AOR-specific driver, runtime files, udev rules,
and GQRX menu override.

It does not remove GQRX or shared Debian packages.

License
-------

SoapyAOR is free software distributed under the GNU General Public License,
version 3 or, at your option, any later version.

See:

    COPYING
    soapyaor/COPYING
    soapyaor/README.txt

The AOR FX2 firmware file fx2fw.hex is distributed separately from the
GPL-licensed SoapyAOR software.

See:

    FIRMWARE-LICENSE.txt

Copyright
---------

Copyright 2021 AOR, LTD.
Copyright 2026 AOR, LTD.
