Spis treści
- 1. Hardware Requirements
- 2. Setup & Configuration
- 2.1. Software Dependencies
- 2.2 RTL-SDR from source
- 2.2.1 RTL-DVB Kernel Module Blacklisting
- 2.2.2 - Check your RTLSDRs are working!
- 2.3. Downloading this Repository
- 2.4. Compiling HorusDemodLib
- 2.5. Installing the horusdemodlib Python library
- 3. Configuration File Changes
- 4. Startup Script Modification
- 5. Startup on Boot.
- 6. Updating
This guide is intended to assist setting up a demodulator for a Horus Binary signal on a single-board computer like a Raspberry Pi, that may or may-not have a screen attached (and hence is 'headless'). Reception is performed using a RTLSDR - I recommend the RTLSDR v3 dongles.
I use this headless approach as the primary telemetry reception system in my HAB chase car.
1. Hardware Requirements
-
Ideally, a standalone single-board computer (Raspberry Pi 3, ODroid, etc...) to run the software. Other Linux machines will also work.
-
A RTLSDR receiver.
- A receiver with a TCXO is not 100% critical as the demodulator can track a bit of drift, but it does help. The warm-up drift of the non-TCXO RTLSDRs can be significant enough that the wanted signal doesn't stay within the receiver passband. I've had great success with the RTL-SDR.com 'v3' dongles. The NooElec SMArt dongles (with the TCXO option) are also good. You can determine the ppm offset via a number of methods, such as kalibrate-rtl (if you have GSM signals nearby) or using LTE-Cell-Scanner, if you only have LTE around (i.e. Australia).
-
An antenna suitable for receiving on 434 MHz (a basic 1/4 wave monopole is usually good enough, or any other amateur 70cm antenna.
-
For optimal receive performance, a preamplifier and a band-pass filter, like this one. You can still achieve pretty good results without one.
2. Setup & Configuration
This section is intended to assist with setup under a fresh Raspbian installation. The instructions should be usable on other Debian-based systems.
For a good guide on setting up a 'headless' (no display) Raspberry Pi 2/3/Zero/ZeroW, look here.
2.1. Software Dependencies
We may require a few dependencies to be able to compile and use the new modem and uploader scripts. Under Ubuntu/Debian/Raspbian, you can install the required packages using:
$ sudo apt-get install cmake build-essential libusb-1.0-0-dev git python3-venv python3-crcmod python3-requests python3-pip sox bc rtl-sdr libatlas-base-dev libopenblas-dev
Under OSX, Macports or Homebrew should be able to provide the above packages, though they may be named slightly differently.
If the python-crcmod and python-requests packages are not available via your package manager, you can try installing them via pip using sudo pip install crcmod requests.
2.2 RTL-SDR from source
As we may we wish to use the bias-tee option in the newer v3 RTLSDRs, we need a fairly recent version of the rtl-sdr software. Recent ubuntu distributions provide this support in the rtl-sdr package (package version 0.5.3-12 or newer), and as of 2020, Raspbian supports it too!
Note: There have been some reports that the version of rtl-sdr provided by Raspbian results in dropped samples on the RPi 4. If you encounter this issue, then it is recommended that rtl-sdr be compiled from source instead.
If you install via the system package manager, then most likely the required udev rules (which enable the pi user to access the RTLSDR) will not NOT have been installed (... sigh). To install these, run:
$ sudo wget -O /etc/udev/rules.d/20-rtlsdr.rules https://raw.githubusercontent.com/osmocom/rtl-sdr/master/rtl-sdr.rules
Then, reboot the RPi.
If your package manager's version of rtl-sdr does not provide bias-tee support (no -T option) and you need it, then you will need to compile from source:
$ git clone https://github.com/osmocom/rtl-sdr.git
$ cd rtl-sdr
$ mkdir build
$ cd build
$ cmake -DINSTALL_UDEV_RULES=ON -DDETACH_KERNEL_DRIVER=ON ../
$ sudo make install
$ sudo ldconfig
IMPORTANT NOTE: Make sure to remove any installations of rtl-sdr already on your system before compiling/installing from source. (i.e. sudo apt-get remove rtl-sdr librtlsdr0 librtlsdr-dev
2.2.1 RTL-DVB Kernel Module Blacklisting
Because the kernel rtl_dvb driver (yes, these SDRs can be used to watch TV after all) will inhibit our intended use, we need to blacklist a few kernel modules.
If you installed rtl-sdr from source as above, then a blacklist file should have already been installed, otherwise create a new module blacklist file using:
$ sudo nano /etc/modprobe.d/rtlsdr-blacklist.conf
and add the lines:
blacklist dvb_usb_rtl28xxu
blacklist rtl2832
blacklist rtl2830
blacklist dvb_usb_rtl2832u
blacklist dvb_usb_v2
blacklist dvb_core
Save the file (Ctrl+x, y), and reboot the Raspberry Pi.
2.2.2 - Check your RTLSDRs are working!
At this point it is worth checking that you can communicate with your RTLSDR, which can be achieved by running:
$ rtl_test
Found 1 device(s):
0: Realtek, RTL2838UHIDIR, SN: 00000002
Using device 0: Generic RTL2832U OEM
Found Rafael Micro R820T tuner
Supported gain values (29): 0.0 0.9 1.4 2.7 3.7 7.7 8.7 12.5 14.4 15.7 16.6 19.7 20.7 22.9 25.4 28.0 29.7 32.8 33.8 36.4 37.2 38.6 40.2 42.1 43.4 43.9 44.5 48.0 49.6
[R82XX] PLL not locked!
Sampling at 2048000 S/s.
Info: This tool will continuously read from the device, and report if
samples get lost. If you observe no further output, everything is fine.
Reading samples in async mode...
Hit Ctrl+C to kill rtl_test. If you see lots of warnings such as lost at least <X> bytes, this indicates USB bandwidth issues, or some other issue with the RTLSDR. One or two lines are usually OK...
2.3. Downloading this Repository
You can now grab this repository using git:
$ git clone https://github.com/projecthorus/horusdemodlib.git
$ cd horusdemodlib
2.4. Compiling HorusDemodLib
We need to compile and install the horusdemodlib C library. This can be accomplished by performing (within this directory):
$ mkdir build
$ cd build
$ cmake ..
$ make
$ sudo make install
# ctest (which should result in output ending in '100% tests passed')
$ cd ../
2.5. Installing the horusdemodlib Python library
From within the horusdemodlib directory, run:
$ python3 -m venv venv
$ . venv/bin/activate
$ pip install -r requirements.txt
$ pip install horusdemodlib
Errors along the lines of 'Failed building wheel for ' can be ignored.
3. Configuration File Changes
Copy the example configuration file user.cfg.example to user.cfg, i.e.:
$ cp user.cfg.example user.cfg
The file user.cfg should then be modified to reflect the callsign you wish to use when uploading data to Habitat.
Simply change the following section as appropriate:
[user]
# Your callsign - used when uploading to the HabHub Tracker.
callsign = YOUR_CALL_HERE
# Your station latitude/longitude, which will show up on tracker.habhub.org.
# These values must be in Decimal Degree format.
# Leave the lat/lon at 0.0 if you do not wish your station plotted on the map,
# or if you are uploading your position via other means (i.e. using chasemapper)
station_lat = 0.0
station_lon = 0.0
# Radio/Antenna descriptions.
# An optional short description of your radio/antenna setup.
radio_comment = Your Radio Description Here
antenna_comment = Your Antenna Description Here
4. Startup Script Modification
There are two receiver startup scripts available:
- start_rtlsdr.sh - Receives a single Horus Binary signal.
- start_dual_rtty_4fsk.sh - Receives a closely spaced (~10 kHz) Horus Binary and RTTY payload simultaneously.
- start_dual_4fsk.sh - Receives two closely spaced (~10kHz) Horus Binary signals simultaneously.
You will likely need to edit these scripts to change settings such as receive frequency, PPM offset, or Chasemapper output settings. The scripts are fairly well commented, and should be reasonably self-explanatory.
Once modified, you can simply start reception by running:
$ ./start_rtlsdr.sh
This will produce output similar to the following:
$ ./start_rtlsdr.sh
Found horus_demod.
Found bc.
Entering venv.
Using SDR Centre Frequency: 434654000 Hz.
Using FSK estimation range: 1000 - 11000 Hz
Using AGC.
Setting estimator limits to 1000 to 11000 Hz.
Found 1 device(s):
0: Realtek, RTL2838UHIDIR, SN: 00000001
Using device 0: Generic RTL2832U OEM
Detached kernel driver
Found Rafael Micro R820T tuner
Tuner gain set to automatic.
Tuned to 435038000 Hz.
oversampling input by: 32x.
Oversampling output by: 1x.
Buffer size: 5.33ms
Create UDP thread
Created UDP thread
Main socket started! :-) Tuning enabled on UDP/6020
Allocating 15 zero-copy buffers
Sampling at 1536000 S/s.
Output at 48000 Hz.
2020-07-18 09:13:57,386 INFO: Attempting to download latest payload ID list from GitHub...
2020-07-18 09:13:57,910 INFO: Payload list contains 23 entries.
2020-07-18 09:13:57,910 INFO: Attempting to download latest custom field list from GitHub...
2020-07-18 09:13:58,495 INFO: Custom Field list contains 2 entries.
2020-07-18 09:13:58,496 INFO: Started Habitat Uploader Thread.
2020-07-18 09:13:58,496 INFO: Using User Callsign: YOUR_CALL_HERE
2020-07-18 09:13:58,497 INFO: Started Horus Demod Uploader. Hit CTRL-C to exit.
2020-07-18 09:13:58,997 WARNING: Listener position set to 0.0/0.0 - not uploading.
2020-07-18 09:14:01,672 INFO: Received raw binary packet: 010200173B300000000000000000000000001A971553
2020-07-18 09:14:01,695 ERROR: Horus UDP - Zero Latitude/Longitude, not sending.
2020-07-18 09:14:01,696 INFO: Decoded Binary Packet (SNR 10.7 dB): $$HORUSBINARY,2,23:59:48,0.00000,0.00000,0,0,0,26,2.96*3841
2020-07-18 09:14:03,431 INFO: Habitat - Uploaded sentence: $$HORUSBINARY,2,23:59:48,0.00000,0.00000,0,0,0,26,2.96*3841
Note that output from rtl_fm and the horus binary uploader are interleaved, which can be a bit confusing at first.
5. Startup on Boot.
Basic rc.local startup
There are a number of ways of starting up a script when a Linux machine starts up. One of the simplest is to add the script to be run to /etc/rc.local
For example, you could add the following line to the end of your /etc/rc.local file:
/home/pi/horusdemodlib/start_rtlsdr.sh &
Note the &, which places the process into the background and lets the system continue to boot.
rc.local startup using screen
The 'screen' utility (which you will probably need to install first using: sudo apt-get install screen) lets you run terminal programs in a session which you can detach from and reconnect to later.
In this case, you'd put the following line in your /etc/rc.local file:
su - pi -c "screen -dm -S horus /home/pi/horusdemodlib/start_rtlsdr.sh"
This runs the start_rtlsdr.sh script within a screen session named 'horus', as the 'pi' user. If you're not using the 'pi' user, you will need to replace 'pi' in the above command as appropriate.
Once started, you can access the session by running: screen -r horus
To detach from the session you need to hold Ctrl+a, release the keys, then press d.
Systemd-based startup
** TODO: Systemd unit file **
6. Updating
To update an existing horusdemodlib installation, you should be able to perform the following:
$ git pull
(Note - if you get a warning when running this, you will probably need to run git stash first, which will result in any changes to version-controlled files to be lost.)
Then, re-build:
$ rm -rf build
$ mkdir build
$ cd build
$ cmake ..
$ make
$ sudo make install
# ctest (which should result in output ending in '100% tests passed')
$ cd ../
To update the python library, enter the venv, and update:
$ . venv/bin/activate
$ pip install -U horusdemodlib