This module provides blocks to build an Iridium burst detector and demodulator.

It provides a sample application which can be used to detect and demodulate data from the Iridium satellite network.

You should also have a look at the iridium-toolkit.

⚠️ If you want to build for GNU Radio 3.8: Make sure to use the maint-3.8 branch of this repository (i.e. run git checkout maint-3.8 before installation). Also make sure to check the README.md from that branch for correct build instructions.

A working GNU Radio 3.10 installation is necessary to use gr-iridium.

Installation instructions for:

• Ubuntu 22.04 (from source)
• Ubuntu 22.04 on Rasperry Pi 4 (from source)
• DragonOS Pi64 Beta

If your operating system is not listed above, first install the following dependencies:

• gnuradio-dev
• libvolk-dev
• pybind11-dev
• libsndfile1-dev

Afterwards try these generic build instructions:

cmake -B build
cmake --build build
sudo cmake --install build
sudo ldconfig

The recommended GNU Radio versions to use gr-iridium with is GNU Radio 3.10. If you use a Ubuntu version older than Ubuntu 22.04 or Debian stable (bullseye) our recommended way to install GNU Radio is to use PyBOMBS as described here: https://github.com/Sec42/sec-gr/. Please expect trouble if you install GNU Radio any other way on these systems.

The following commands are examples how to use the iridium-extractor tool. To further parse the demodulated frames have a look at the iridium-toolkit. It provides scripts to extract meaningful information.

To our knowledge Iridium is currently using the spectrum between 1.618 GHz and 1.6265 GHz which is a bandwidth of 8.5 MHz. Many modern SDRs support such a bandwidth with sample rates >= 10 MSPS. RTL-SDR devices do not though and you need to make a choice which section of the band you want to listen to. The configurations in the example/ folder for RTL-SDRs include the "Time and Location", "Ring Alert" and "Pager / Global Burst" channels. If you are more interested in user payloads (like ACARS) you might want to move the center frequency of the RTL-SDR configurations to a lower frequency (e.g. 1622 MHz) to capture more of the duplex band. You can also experiment with the sample rate and for example raise it to 2.5 MSPS or 3.0 MSPS.

If your SDR supports at maximum 8 MSPS you will have to decide if the simplex band is of interest to you or if you want to capture the first 500 kHz of the duplex band.

SDRs which support more than 10 MSPS capture the whole used band.

iridium-extractor -D 4 examples/hackrf.conf > output.bits

This will capture the complete Iridium band using a connected HackRF and demodulate detected bursts into frames. It uses decimation to keep up if there are many bursts at the same time.

hackrf_transfer -f 1626000000 -s 10000000 -r - | iridium-extractor -c 1626000000 -r 10000000 -f hackrf -

You can also pipe a raw sample stream into iridium-extractor. This may be useful if your SDR is not supported or if you stream samples from another computer via TCP (e.g. with rtl_tcp).

iridium-extractor -c 1626000000 -r 2000000 -f float name-f1.626000e+09-s2.000000e+06-t20160401000000.cfile > output.bits

This processes the file in offline mode and supplies the needed options via the command line.

iridium-extractor -c 1622000000 baseband.wav > output.bits

A 2-channel 16bit wav file is also accepted as input. Command line option -r can be used to override the sample rate.

iridium-extractor recording-test.sigmf-data > output.bits

iridium-extractor supports both SigMF files (.sigmf-meta / .sigmf-data) as well as SigMF archives (.sigmf).

Command line options -c, -r and -f can be used to override the SigMF information.

To capture and demodulate Iridium frames use iridium-extractor. You can either process a file offline or stream data into the tool.

The extractor can talk directly to an SDR with the help of SoapySDR or OsmoSDR. This is enabled via a configuration file.

The examples/ directory contains example configuration files for common use cases.

If no configuration file is used, a file name can be provided to read samples from a file. If no file is specified, samples are read from stdin.

Configuration files need to have a .conf file extension. The configuration file must contain exactly one source section and start with a corresponding [section-name] line.

If the [osmosdr-source] section is present, an OsmoSDR source is instantiated.

The following options are available in this section:

1: Mostly used to enable bias tee - check files under examples/

If the [soapy-source] section is present, a SoapySDR source is instantiated.

The following options are available in this section:

1: Run SoapySDRUtil --info |grep factories to see available drivers on your system. 2: Mostly used to enable an integrated bias tee - check files under examples/. 3: These arguments are highly device specific. You might find hints in examples/ or your SDR's SoapySDR driver. 4: Check the output of SoapySDRUtil --probe to find valid gain names for your SDR. Gain names are usually different between OsmoSDR and SoapySDR.

If the [zeromq-sub-source] section is present, ZeroMQ is used to receive data from a ZMQ PUB Sink running in another flow graph.

The following options are available in this section:

See examples/zeromq-sub.conf and experimental/zmq-publisher.grc for examples how to use this source. Also have a look at https://wiki.gnuradio.org/index.php/ZMQ_SUB_Source and https://wiki.gnuradio.org/index.php/ZMQ_PUB_Sink .

Also consider https://github.com/muaddib1984/stillsuit as a solution to create a compatible source.

Warning: If you set pass_tags to True make sure that your source is not supplying bogus rx_time tags. This is by default the case when using a USRP without a properly configured external time source. In this case the timestamps reported by gr-iridium will follow what ever the rx_time tags of the source tell it. Sometimes this might be based on the uptime of some system part or something similar.

If the [uhd-source] section is present, UHD is used to connect to a USRP.

This is mainly of interest when working with an internal GPSDO as gr-iridium will wait for it to lock if clock_source or time_source specifies an internal GPSDO. This source will always use channel 0 of the chosen USRP.

Please refer to the UHD documentation for your device to understand the options for antenna, clock_source and time_source. Tested options so far are external, gpsdo and jacksonlabs (see below).

gr-iridium implements a special clock_source and time_source for USRP B2x0 devices jacksonlabs. It improves waiting for proper GPS lock before starting a capture. Use this if you have an internal Jacksonlabs GPSDO.

See examples/usrp-b2x0-uhd.conf for an example how to use this with a B2x0 device.

The optional [demodulator] section can be used to influence the demodulator behavior.

The samples_per_symbol option is useful if you are running on a constrained system like a single board ARM computer (e.g. a Raspberry Pi). It also allows you to use sample rates which are not a multiple of 250000 samples per second. E.g. a setting of 5 samples per symbol allows your SDRs sample rate to be a multiple of 25000 * 5 = 125000 samples per second. A setting of 8 allows the sample rate to be a multiple of 200000 samples per second which for example works out well with 3.2 MSPS RTL-SDRs.

Command line options can be used instead of a configuration file. If a configuration file is also specified, command line options take precedence.

In live/SDR mode, the extractor will drop samples or bursts if the computing power available is not enough to keep up. (See -q option).

In offline/file mode, the extractor will pause reading the file (or stream) until it can process more samples again.

When reading samples from a pipe / stdin iridium-extractor does not know which mode is correct and defaults to live mode. You can use this option to override this choice and avoid dropping bursts.

This option is only necessary to use if you pipe samples from stdin.

This option enables decimation and channelization of the input stream before it gets handled by the burst based components. This helps to reduce the needed memory bandwidth when many bursts appear at the same time. Use this option if you get dropped bursts during online operation.

The decimation has to be even. Internally a poly phase filter bank will be used to channelize the input spectrum. Each channel will be decimated by the chosen decimation. To account for Doppler shift, the channels overlap each other. To provide the needed additional sample rate, one more channel than needed is created and oversampling activated. This results in a total output bandwidth of input bandwidth * (1 + 1/decimation).

It is not recommended to use a decimation smaller than 4, as there is only little benefit otherwise.

Decimating the input signal can improve real time performance but is not recommended for offline processing. During offline processing it tends to become a major bottleneck.

This value is limited to even values and the sample rate divided by decimation must be a multiple of 250000.

The center frequency for the source or the file in Hz.

The sample rate of the source or the file. Must be divisible by 100000.

The following 4 formats are supported for sample input. For ease of use the names in the alias column can also be used.

If not specified otherwise, iridium-extractor tries to use the file extension to identify the format.

This option has no effect while directly reading from an SDR.

For each channel (by default there is one channel, unless specified with -D ), a queue is filled with samples where the detector has detected activity. By default each queue is 500 frames long. You can tweak the length of the queue(s) with this option.

Each burst which is detected gets assigned an id. It appears in the output data as I:xxxxxxxxxxx for bursts which were decoded into frames.

For example --debug-id=230 to output debug information for the burst containing frames 230 up to 239.

Debug information includes:

• Debug prints on stdout.
• Raw sample files written to /tmp/signals.

Note: Last digit needs to always be 0

Manually set the file info field (second field) in the output data. If this option is not used, the default will be:

• basename of the sample source file if available
• current time otherwise (i.e. when reading from an SDR or stdin)

will output some additional info when starting up.

how much stronger a signal needs to be over the noise floor to attempt to extract it.

Default value is 18. Values lower than 16 are rarely useful, as the QPSK decoder will produce too many bit errors.

write a copy of the samples to a SigMF recording.

The parameter specifies the path & basename of the SigMF files.

This is mostly useful for debugging when using SDR mode to process live data.

The samples will be written in ci16_le format.

During normal operation iridium-extractor will output a status line once per second on stderr.

1577922120 | i: 0/s | i_avg: 0/s | q_max: 0 | i_ok: 0% | o: 0/s | ok: 0% | ok: 0/s | ok_avg: 0% | ok: 0 | ok_avg: 0/s | d: 0

During normal operation drops should remain 0, while queue max should be in the lower double digits "most" of the time. The input number is largely dependent on your antenna and will also vary depending on satellite location.

1577922120 | srr: 0.0% | i_avg: 0/s | q_max: 0 | i_ok: 0% | o: 0/s | ok: 0% | ok: 0/s | ok_avg: 0% | ok: 0 | ok_avg: 0/s | d: 0

All columns here have the same content as in SDR/live mode, except

If this value is consistently lower than 100% it is likely that you would loose/drop bursts in SDR/live mode.

During normal operation iridium-extractor will output one line of bits per "ok" frame on stdout. Usually stdout should be redirected to a file. By convention this file should have the extension .bits.

RAW: prbs15-2M-20dB 0000599.9996 1622000000 N:32.12-80.05 I:00000000000 100% 0.13551 179 0011000000110000111100111000000000000011000000000000101000000000001111000000000010001000000000110011000000001010101000000011111111000000100000001000001100000011000010100000101000111100001111001000100010001011001100110011101010101010100111111111111101000000000000111000000000001001000000000011011000000000101101000000001110111000000010011001000000110101011000001011111101000011100000

• Accessing the RF Spectrum with GNU Radio: https://www.osti.gov/servlets/purl/1639511
• PAST-AI: Physical-layer Authentication of Satellite Transmitters via Deep Learning: https://arxiv.org/pdf/2010.05470.pdf
• Hacker-Attacks Against Satellites - An Evaluation of Space Law in Regard to the Nature of Hacker-Attacks: https://www.researchgate.net/publication/353846410_Hacker-Attacks_Against_Satellites_An_Evaluation_of_Space_Law_in_Regard_to_the_Nature_of_Hacker-Attacks
• GNSS Spoofing Detection via Opportunistic IRIDIUM Signals - https://arxiv.org/pdf/2006.10284.pdf
• The GR PDU Utilities: https://www.osti.gov/servlets/purl/1641974