radiosonde_auto_rx/auto_rx/autorx/decode.py

1845 wiersze
74 KiB
Python
Czysty Zwykły widok Historia

#!/usr/bin/env python
#
# radiosonde_auto_rx - Sonde Decoder Class.
#
# Copyright (C) 2018 Mark Jessop <vk5qi@rfhead.net>
# Released under GNU GPL v3 or later
#
import autorx
import datetime
import logging
import json
import os
import os.path
import signal
import subprocess
import time
import traceback
2018-05-13 12:53:29 +00:00
from dateutil.parser import parse
from threading import Thread
2018-05-13 12:53:29 +00:00
from types import FunctionType, MethodType
from .utils import AsynchronousFileReader, rtlsdr_test, position_info, generate_aprs_id
from .gps import get_ephemeris, get_almanac
from .sonde_specific import fix_datetime, imet_unique_id
from .fsk_demod import FSKDemodStats
2022-11-05 16:26:41 +00:00
from .sdr_wrappers import test_sdr, get_sdr_iq_cmd, get_sdr_fm_cmd, get_sdr_name
from .email_notification import EmailNotification
# Global valid sonde types list.
VALID_SONDE_TYPES = [
"RS92",
"RS41",
"DFM",
"M10",
"M20",
"IMET",
2021-01-24 11:48:20 +00:00
"IMET5",
"MK2LMS",
"LMS6",
"MEISEI",
"MRZ",
"MTS01",
"UDP",
"WXR301"
]
# Known 'Drifty' Radiosonde types
# NOTE: Due to observed adjacent channel detections of RS41s, the adjacent channel decoder restriction
# is now applied to all radiosonde types. This may need to be re-evaluated in the future.
DRIFTY_SONDE_TYPES = VALID_SONDE_TYPES # ['RS92', 'DFM', 'LMS6']
class SondeDecoder(object):
"""
Radiosonde Sonde Decoder class. Run a radiosonde decoder program as a subprocess, and pass the output onto exporters.
Notes:
The sonde decoder binary needs to output telemetry data as a valid JSON, with one frame of telemetry per line.
Example:
{ "frame": 1909, "id": "N3710309", "datetime": "2018-05-12T11:32:20.000Z", "lat": -34.90842, "lon": 138.49243, "alt": 3896.43871, "vel_h": 8.60708, "heading": 342.43237, "vel_v": 6.83107 }
Required Fields are:
"frame" (int): Frame counter. Usually provided by the radiosonde, and increments per telemetry frame.
"id" (str): Unique identifier for the radiosonde, usually some kind of serial number.
"datetime" (str): UTC Date/Time string, which indicates the time applicable to the telemetry sentence.
Must be parseable with dateutil.
"lat" (float): Radiosonde Latitude (decmial degrees)
"lon" (float): Radiosonde Longitude (decimal degrees)
"alt" (float): Radiosonde Altitude (metres)
Optional Fields:
These fields will be set to dummy values if they are not provided within the JSON blob.
"temp" (float): Atmospheric temperature reported by the Radiosonde (degrees Celsius)
"humidity" (float): Humidity value, reported by the radiosonde (%)
"vel_h" (float): Horizontal Velocity (metres/s)
"vel_v" (float): Vertical Velocity (metres/s)
"heading" (float): Heading of the movement of the payload (degrees true)
2018-05-13 12:53:29 +00:00
The following fields are added to the dictionary:
"type" (str): Radiosonde type
"freq_float" (float): Radiosonde frequency in MHz, as a float.
"freq" (str): Radiosonde frequency as a string (XXX.XXX MHz).
"datetime_dt" (datetime): Telemetry sentence time, as a datetime object.
"""
# IF we don't have any of the following fields provided, we discard the incoming packet.
DECODER_REQUIRED_FIELDS = [
"frame",
"id",
"datetime",
"lat",
"lon",
"alt",
"version",
]
# If we are missing any of the following fields, we add in default values to the telemetry
# object which is passed on to the various other consumers.
DECODER_OPTIONAL_FIELDS = {
"temp": -273.0,
"humidity": -1.0,
"pressure": -1,
"batt": -1,
"vel_h": -9999.0,
"vel_v": -9999.0,
"heading": -9999.0,
}
# Note: The decoders may also supply other fields, such as:
# 'batt' - Battery voltage, in volts.
# 'pressure' - Pressure, in hPa
# 'bt' - RS41 burst timer data.
2019-09-08 08:46:18 +00:00
# TODO: Use the global valid sonde type list.
VALID_SONDE_TYPES = [
"RS92",
"RS41",
"DFM",
"M10",
"M20",
"IMET",
2021-01-24 11:48:20 +00:00
"IMET5",
"MK2LMS",
"LMS6",
"MEISEI",
"MRZ",
"MTS01",
"UDP",
"WXR301"
]
def __init__(
self,
sonde_type="None",
2018-05-25 14:29:16 +00:00
sonde_freq=400000000.0,
sdr_type="RTLSDR",
sdr_hostname="localhost",
sdr_port=12345,
ss_iq_path="./ss_iq",
rs_path="./",
rtl_fm_path="rtl_fm",
rtl_device_idx=0,
ppm=0,
gain=-1,
bias=False,
save_decode_audio=False,
save_decode_iq=False,
exporter=None,
timeout=180,
telem_filter=None,
rs92_ephemeris=None,
rs41_drift_tweak=False,
experimental_decoder=False,
save_raw_hex=False,
wideband_sondes=False
):
""" Initialise and start a Sonde Decoder.
Args:
sonde_type (str): The radiosonde type, as returned by SondeScanner. Valid types listed in VALID_SONDE_TYPES
sonde_freq (int/float): The radiosonde frequency, in Hz.
sdr_type (str): 'RTLSDR', 'Spyserver' or 'KA9Q'
Arguments for KA9Q SDR Server / SpyServer:
sdr_hostname (str): Hostname of KA9Q Server
sdr_port (int): Port number of KA9Q Server
Arguments for RTLSDRs:
rtl_fm_path (str): Path to rtl_fm, or drop-in equivalent. Defaults to 'rtl_fm'
rtl_device_idx (int or str): Device index or serial number of the RTLSDR. Defaults to 0 (the first SDR found).
ppm (int): SDR Frequency accuracy correction, in ppm.
gain (int): SDR Gain setting, in dB. A gain setting of -1 enables the RTLSDR AGC.
bias (bool): If True, enable the bias tee on the SDR.
rs_path (str): Path to the RS binaries (i.e rs_detect). Defaults to ./
save_decode_audio (bool): If True, save the FM-demodulated audio to disk to decode_<device_idx>.wav.
Note: This may use up a lot of disk space!
save_decode_iq (bool): If True, save the decimated IQ stream (48 or 96k complex s16 samples) to disk to decode_IQ_<device_idx>.bin
Note: This will use up a lot of disk space!
exporter (function, list): Either a function, or a list of functions, which accept a single dictionary. Fields described above.
timeout (int): Timeout after X seconds of no valid data received from the decoder. Defaults to 180.
telem_filter (function): An optional filter function, which determines if a telemetry frame is valid.
This can be used to allow the decoder to timeout based on telemetry contents (i.e. no lock, too far away, etc),
not just lack-of-telemetry. This function is passed the telemetry dict, and must return a boolean based on the telemetry validity.
rs92_ephemeris (str): OPTIONAL - A fixed ephemeris file to use if decoding a RS92. If not supplied, one will be downloaded.
2019-03-17 11:28:09 +00:00
2019-04-23 12:15:42 +00:00
rs41_drift_tweak (bool): If True, add a high-pass filter in the decode chain, which can improve decode performance on drifty SDRs.
experimental_decoder (bool): If True, use the experimental fsk_demod-based decode chain.
save_raw_hex (bool): If True, save the raw hex output from the decoder to a file.
wideband_sondes (bool): If True, use a wider bandwidth for iMet sondes. Does not affect settings for any other radiosonde types.
"""
2018-05-25 14:29:16 +00:00
# Thread running flag
self.decoder_running = True
# Local copy of init arguments
self.sonde_type = sonde_type
self.sonde_freq = sonde_freq
self.sdr_type = sdr_type
self.sdr_hostname = sdr_hostname
self.sdr_port = sdr_port
self.ss_iq_path = ss_iq_path
self.rs_path = rs_path
self.rtl_fm_path = rtl_fm_path
self.rtl_device_idx = rtl_device_idx
self.ppm = ppm
self.gain = gain
self.bias = bias
self.save_decode_audio = save_decode_audio
self.save_decode_iq = save_decode_iq
self.telem_filter = telem_filter
self.timeout = timeout
self.rs92_ephemeris = rs92_ephemeris
2019-04-23 12:15:42 +00:00
self.rs41_drift_tweak = rs41_drift_tweak
self.experimental_decoder = experimental_decoder
self.save_raw_hex = save_raw_hex
self.raw_file = None
self.wideband_sondes = wideband_sondes
# Raw hex filename
if self.save_raw_hex:
_outfilename = f"{datetime.datetime.utcnow().strftime('%Y%m%d-%H%M%S')}_{self.sonde_type}_{int(self.sonde_freq)}.raw"
_outfilename = os.path.join(autorx.logging_path, _outfilename)
self.raw_file_option = "-r"
else:
self.raw_file_option = ""
self.save_decode_iq_path = os.path.join(autorx.logging_path, f"decode_IQ_{self.sonde_freq}_{self.sonde_type}_{str(self.rtl_device_idx)}.raw")
self.save_decode_audio_path = os.path.join(autorx.logging_path, f"decode_audio_{self.sonde_freq}_{self.sonde_type}_{str(self.rtl_device_idx)}.wav")
# iMet ID store. We latch in the first iMet ID we calculate, to avoid issues with iMet-1-RS units
# which don't necessarily have a consistent packet count to time increment ratio.
# This is a tradeoff between being able to handle multiple iMet sondes on a single frequency, and
# not flooding the various databases with sonde IDs in the case of a bad sonde.
2021-12-03 08:45:49 +00:00
# iMet ID store v2
# Now instead of just latching onto an ID, we allow up to 4 new IDs to be created per decoder.
# This should hopefully handle a few iMets on the same frequency in a graceful manner.
self.imet_max_ids = 4
self.imet_id = []
# iMet-1 and iMet-4 sondes behave differently.
# iMet-1 sondes increment the frame counter *twice* each second, imet-4 only once per second.
# We need to detect this to be able to calculate a start time, and hence generate a serial number.
self.imet_type = None
self.imet_prev_time = None
self.imet_prev_frame = None
2018-05-25 14:29:16 +00:00
# This will become our decoder thread.
self.decoder = None
self.exit_state = "OK"
# UDP Mode - Accepts incoming data via UDP.
self.udp_mode = sonde_type == "UDP"
# Detect if we have an 'inverted' sonde.
if self.sonde_type.startswith("-"):
self.inverted = True
# Strip off the leading '-' character'
self.sonde_type = self.sonde_type[1:]
else:
self.inverted = False
# Check if the sonde type is valid.
if self.sonde_type not in self.VALID_SONDE_TYPES:
self.log_error("Unsupported sonde type: %s" % self.sonde_type)
2018-05-25 14:29:16 +00:00
self.decoder_running = False
return
# Test if the supplied SDR is working.
_sdr_ok = test_sdr(
self.sdr_type,
rtl_device_idx = self.rtl_device_idx,
sdr_hostname = self.sdr_hostname,
sdr_port = self.sdr_port,
ss_iq_path = self.ss_iq_path,
check_freq = self.sonde_freq
)
if not _sdr_ok:
# test_sdr will provide an error message
2018-05-25 14:29:16 +00:00
self.decoder_running = False
self.exit_state = "FAILED SDR"
return
# We can accept a few different types in the exporter argument..
# Nothing...
if exporter == None:
self.exporters = None
# A single function...
elif type(exporter) == FunctionType:
self.exporters = [exporter]
# A list of functions...
elif type(exporter) == list:
# Check everything in the list is a function
for _func in exporter:
if (type(_func) is not FunctionType) and (
type(_func) is not MethodType
):
raise TypeError(
"Supplied exporter list does not contain functions."
)
# If it all checks out, use the supplied list.
self.exporters = exporter
else:
# Otherwise, bomb out.
raise TypeError("Supplied exporter has incorrect type.")
self.decoder_command = None # Decoder command for 'regular' decoders.
self.decoder_command_2 = (
None # Second part of split demod/decode command for experimental decoders.
)
self.demod_stats = (
None # FSKDemodStats object, used to parse demodulator statistics.
)
# Generate the decoder command.
2019-04-26 08:55:48 +00:00
if self.experimental_decoder:
# Create a copy of the RX frequency, which will be updated when generating the decoder command.
self.rx_frequency = self.sonde_freq
# Generate the demodulator / decoder commands, and get the fsk_demod stats parser, tuned for the particular
# sonde.
(
self.decoder_command,
self.decoder_command_2,
self.demod_stats,
) = self.generate_decoder_command_experimental()
2019-04-26 08:55:48 +00:00
else:
# 'Regular' decoder - just a single command.
2019-04-26 08:55:48 +00:00
self.decoder_command = self.generate_decoder_command()
if self.decoder_command is None:
self.log_error("Could not generate decoder command. Not starting decoder.")
2018-05-25 14:29:16 +00:00
self.decoder_running = False
else:
if self.save_raw_hex:
self.log_debug(f"Opening {_outfilename} to save decoder raw data.")
# Open the log file in binary mode.
self.raw_file = open(_outfilename, 'wb')
# Start up the decoder thread.
self.decode_process = None
self.async_reader = None
self.decoder_running = True
self.decoder = Thread(target=self.decoder_thread)
self.decoder.start()
def generate_decoder_command(self):
2019-04-26 08:55:48 +00:00
""" Generate the shell command which runs the relevant radiosonde decoder - Standard decoders.
2019-04-26 08:55:48 +00:00
Returns:
str/None: The shell command which will be run in the decoder thread, or none if a valid decoder could not be found.
"""
# Common options to rtl_fm
# Add a -T option if bias is enabled
bias_option = "-T " if self.bias else ""
# Add a gain parameter if we have been provided one.
if self.gain != -1:
gain_param = "-g %.1f " % self.gain
2019-04-26 08:55:48 +00:00
else:
gain_param = ""
2019-04-26 08:55:48 +00:00
if self.sonde_type == "RS41":
# RS41 Decoder command.
2022-04-02 09:38:13 +00:00
_sample_rate = 48000
_filter_bandwidth = 15000
2019-04-26 08:55:48 +00:00
2022-04-02 09:38:13 +00:00
decode_cmd = get_sdr_fm_cmd(
sdr_type = self.sdr_type,
frequency = self.sonde_freq,
filter_bandwidth=_filter_bandwidth,
sample_rate = _sample_rate,
sdr_hostname = self.sdr_hostname,
sdr_port = self.sdr_port,
rtl_device_idx = self.rtl_device_idx,
ppm = self.ppm,
gain = self.gain,
bias = self.bias,
highpass = 20,
lowpass = 2600
)
2019-04-26 08:55:48 +00:00
# Add in tee command to save audio to disk if debugging is enabled.
if self.save_decode_audio:
decode_cmd += f" tee {self.save_decode_audio_path} |"
2019-04-26 08:55:48 +00:00
decode_cmd += "./rs41mod --ptu2 --json 2>/dev/null"
2019-04-26 08:55:48 +00:00
elif self.sonde_type == "RS92":
# Decoding a RS92 requires either an ephemeris or an almanac file.
# If we have been supplied an ephemeris file, we will attempt to use it, otherwise
# we will try and download one.
if self.rs92_ephemeris == None:
# If no ephemeris data defined, attempt to download it.
# get_ephemeris will either return the saved file name, or None.
self.rs92_ephemeris = get_ephemeris(destination="ephemeris.dat")
# If ephemeris is still None, then we failed to download the ephemeris data.
# Try and grab the almanac data instead
if self.rs92_ephemeris == None:
self.log_error(
"Could not obtain ephemeris data, trying to download an almanac."
)
2019-04-26 08:55:48 +00:00
almanac = get_almanac(destination="almanac.txt")
if almanac == None:
# We probably don't have an internet connection. Bomb out, since we can't do much with the sonde telemetry without an almanac!
self.log_error(
"Could not obtain GPS ephemeris or almanac data."
)
2019-04-26 08:55:48 +00:00
return None
else:
_rs92_gps_data = "-a almanac.txt --gpsepoch 2" # Note - This will need to be updated in... 19 years.
2019-04-26 08:55:48 +00:00
else:
_rs92_gps_data = "-e ephemeris.dat"
else:
_rs92_gps_data = "-e %s" % self.rs92_ephemeris
# Adjust the receive bandwidth based on the band the scanning is occuring in.
if self.sonde_freq < 1000e6:
# 400-406 MHz sondes - use a 12 kHz FM demod bandwidth.
_rx_bw = 12000
2021-02-24 08:06:42 +00:00
# We may be able to get PTU data from these!
_ptu_opts = "--ptu"
2019-04-26 08:55:48 +00:00
else:
# 1680 MHz sondes - use a 28 kHz FM demod bandwidth.
# NOTE: This is a first-pass of this bandwidth, and may need to be optimized.
_rx_bw = 28000
2021-02-24 08:06:42 +00:00
# No PTU data availble for RS92-NGP sondes.
2021-03-10 11:03:54 +00:00
_ptu_opts = "--ngp --ptu"
2019-04-26 08:55:48 +00:00
2022-04-02 09:38:13 +00:00
_sample_rate = 48000
decode_cmd = get_sdr_fm_cmd(
sdr_type = self.sdr_type,
frequency = self.sonde_freq,
filter_bandwidth=_rx_bw,
sample_rate = _sample_rate,
sdr_hostname = self.sdr_hostname,
sdr_port = self.sdr_port,
rtl_device_idx = self.rtl_device_idx,
ppm = self.ppm,
gain = self.gain,
bias = self.bias,
highpass = 20,
lowpass = 2500
)
2019-04-26 08:55:48 +00:00
# Add in tee command to save audio to disk if debugging is enabled.
if self.save_decode_audio:
decode_cmd += f" tee {self.save_decode_audio_path} |"
2019-04-26 08:55:48 +00:00
decode_cmd += (
2021-02-24 08:06:42 +00:00
"./rs92mod -vx -v --crc --ecc --vel --json %s %s 2>/dev/null"
% (_rs92_gps_data, _ptu_opts)
)
2019-04-26 08:55:48 +00:00
elif self.sonde_type == "DFM":
# DFM06/DFM09 Sondes.
# As of 2019-02-10, dfm09ecc auto-detects if the signal is inverted,
# so we don't need to specify an invert flag.
# 2019-02-27: Added the --dist flag, which should reduce bad positions a bit.
2022-04-02 09:38:13 +00:00
_sample_rate = 48000
_filter_bandwidth = 15000
decode_cmd = get_sdr_fm_cmd(
sdr_type = self.sdr_type,
frequency = self.sonde_freq,
filter_bandwidth=_filter_bandwidth,
sample_rate = _sample_rate,
sdr_hostname = self.sdr_hostname,
sdr_port = self.sdr_port,
rtl_device_idx = self.rtl_device_idx,
ppm = self.ppm,
gain = self.gain,
bias = self.bias,
highpass = 20,
lowpass = 2000
)
2019-04-26 08:55:48 +00:00
# Add in tee command to save audio to disk if debugging is enabled.
if self.save_decode_audio:
decode_cmd += f" tee {self.save_decode_audio_path} |"
2019-04-26 08:55:48 +00:00
# DFM decoder
decode_cmd += "./dfm09mod -vv --ecc --json --dist --auto 2>/dev/null"
2019-04-26 08:55:48 +00:00
elif self.sonde_type == "M10":
# M10 Sondes
2022-04-02 09:38:13 +00:00
_sample_rate = 48000
_filter_bandwidth = 22000
decode_cmd = get_sdr_fm_cmd(
sdr_type = self.sdr_type,
frequency = self.sonde_freq,
filter_bandwidth=_filter_bandwidth,
sample_rate = _sample_rate,
sdr_hostname = self.sdr_hostname,
sdr_port = self.sdr_port,
rtl_device_idx = self.rtl_device_idx,
ppm = self.ppm,
gain = self.gain,
bias = self.bias,
highpass = 20
)
2019-04-26 08:55:48 +00:00
# Add in tee command to save audio to disk if debugging is enabled.
if self.save_decode_audio:
decode_cmd += f" tee {self.save_decode_audio_path} |"
2019-04-26 08:55:48 +00:00
# M10 decoder
2019-10-14 20:08:55 +00:00
decode_cmd += "./m10mod --json --ptu -vvv 2>/dev/null"
2019-04-26 08:55:48 +00:00
elif self.sonde_type == "IMET":
2019-04-26 08:55:48 +00:00
# iMet-4 Sondes
# These samples rates probably need to be revisited.
if self.wideband_sondes:
_sample_rate = 96000
else:
_sample_rate = 48000
2022-04-02 09:38:13 +00:00
decode_cmd = get_sdr_iq_cmd(
sdr_type = self.sdr_type,
frequency = self.sonde_freq,
sample_rate = _sample_rate,
sdr_hostname = self.sdr_hostname,
sdr_port = self.sdr_port,
ss_iq_path = self.ss_iq_path,
2022-04-02 09:38:13 +00:00
rtl_device_idx = self.rtl_device_idx,
ppm = self.ppm,
gain = self.gain,
bias = self.bias
)
2019-04-26 08:55:48 +00:00
# Add in tee command to save audio to disk if debugging is enabled.
2022-04-02 09:38:13 +00:00
if self.save_decode_iq:
decode_cmd += f" tee {self.save_decode_iq_path} |"
2019-04-26 08:55:48 +00:00
# iMet-4 (IMET1RS) decoder
2022-04-02 09:38:13 +00:00
decode_cmd += f"./imet4iq --iq 0.0 --lpIQ --dc - {_sample_rate} 16 --json 2>/dev/null"
2019-04-26 08:55:48 +00:00
2021-01-24 11:48:20 +00:00
elif self.sonde_type == "IMET5":
# iMet-54 Sondes
2021-01-24 07:47:11 +00:00
2022-04-02 09:38:13 +00:00
_sample_rate = 48000
decode_cmd = get_sdr_iq_cmd(
sdr_type = self.sdr_type,
frequency = self.sonde_freq,
sample_rate = _sample_rate,
sdr_hostname = self.sdr_hostname,
sdr_port = self.sdr_port,
ss_iq_path = self.ss_iq_path,
2022-04-02 09:38:13 +00:00
rtl_device_idx = self.rtl_device_idx,
ppm = self.ppm,
gain = self.gain,
bias = self.bias
2021-01-24 07:47:11 +00:00
)
# Add in tee command to save audio to disk if debugging is enabled.
if self.save_decode_iq:
decode_cmd += f" tee {self.save_decode_iq_path} |"
2021-01-24 07:47:11 +00:00
# iMet-54 Decoder
decode_cmd += (
f"./imet54mod --ecc --IQ 0.0 --lp - 48000 16 --json --ptu 2>/dev/null"
2021-01-24 07:47:11 +00:00
)
elif self.sonde_type == "MRZ":
# Meteo-Radiy MRZ Sondes
2022-04-02 09:38:13 +00:00
_sample_rate = 48000
decode_cmd = get_sdr_iq_cmd(
sdr_type = self.sdr_type,
frequency = self.sonde_freq,
sample_rate = _sample_rate,
sdr_hostname = self.sdr_hostname,
sdr_port = self.sdr_port,
ss_iq_path = self.ss_iq_path,
2022-04-02 09:38:13 +00:00
rtl_device_idx = self.rtl_device_idx,
ppm = self.ppm,
gain = self.gain,
bias = self.bias
)
# Add in tee command to save audio to disk if debugging is enabled.
2022-04-02 09:38:13 +00:00
if self.save_decode_iq:
decode_cmd += f" tee {self.save_decode_iq_path} |"
# MRZ decoder
2022-04-02 09:38:13 +00:00
#decode_cmd += "./mp3h1mod --auto --json --ptu 2>/dev/null"
decode_cmd += "./mp3h1mod --IQ 0.0 --lp - 48000 16 --json --ptu 2>/dev/null"
elif self.sonde_type == "MK2LMS":
# 1680 MHz LMS6 sondes, using 9600 baud MK2A-format telemetry.
# This fsk_demod command *almost* works (using the updated fsk_demod)
# rtl_fm -p 0 -d 0 -M raw -F9 -s 307712 -f 1676000000 2>/dev/null |~/Dev/codec2-upstream/build/src/fsk_demod --cs16 -p 32 --mask=100000 --stats=5 2 307712 9616 - - 2> stats.txt | python ./test/bit_to_samples.py 48080 9616 | sox -t raw -r 48080 -e unsigned-integer -b 8 -c 1 - -r 48080 -b 8 -t wav - 2>/dev/null| ./mk2a_lms1680 --json
# Notes:
# - Have dropped the low-leakage FIR filter (-F9) to save a bit of CPU
# Have scaled back sample rate to 220 kHz to again save CPU.
# mk2a1680mod runs at ~90% CPU on a RPi 3, with rtl_fm using ~50% of another core.
# Update 2021-07-24: Updated version with speedups now taking 240 kHz BW and only using 50% of a core.
2022-04-02 09:38:13 +00:00
_baud_rate = 4800
_sample_rate = 240000
demod_cmd = get_sdr_iq_cmd(
sdr_type = self.sdr_type,
frequency = self.sonde_freq,
sample_rate = _sample_rate,
sdr_hostname = self.sdr_hostname,
sdr_port = self.sdr_port,
ss_iq_path = self.ss_iq_path,
2022-04-02 09:38:13 +00:00
rtl_device_idx = self.rtl_device_idx,
ppm = self.ppm,
gain = self.gain,
bias = self.bias,
fast_filter = True
)
# Add in tee command to save audio to disk if debugging is enabled.
if self.save_decode_iq:
decode_cmd += f" tee {self.save_decode_iq_path} |"
# LMS6-1680 decoder
decode_cmd += f"./mk2a1680mod --iq 0.0 --lpIQ --lpbw 160 --decFM --dc --crc --json {self.raw_file_option} - 240000 16 2>/dev/null"
# Settings for old decoder, which cares about FM inversion.
# if self.inverted:
# self.log_debug("Using inverted MK2A decoder.")
# decode_cmd += f"./mk2a_lms1680 -i --json {self.raw_file_option} 2>/dev/null"
# else:
# decode_cmd += f"./mk2a_lms1680 --json {self.raw_file_option} 2>/dev/null"
elif self.sonde_type.startswith("LMS"):
# LMS6 Decoder command.
# rtl_fm -p 0 -g -1 -M fm -F9 -s 15k -f 405500000 | sox -t raw -r 15k -e s -b 16 -c 1 - -r 48000 -b 8 -t wav - lowpass 2600 2>/dev/null | ./rs41ecc --crc --ecc --ptu
# Note: Have removed a 'highpass 20' filter from the sox line, will need to re-evaluate if adding that is useful in the future.
2022-04-02 09:38:13 +00:00
_sample_rate = 48000
_filter_bandwidth = 15000
2022-04-02 09:38:13 +00:00
decode_cmd = get_sdr_fm_cmd(
sdr_type = self.sdr_type,
frequency = self.sonde_freq,
filter_bandwidth=_filter_bandwidth,
sample_rate = _sample_rate,
sdr_hostname = self.sdr_hostname,
sdr_port = self.sdr_port,
rtl_device_idx = self.rtl_device_idx,
ppm = self.ppm,
gain = self.gain,
bias = self.bias,
highpass = 20,
lowpass = 2600
)
# Add in tee command to save audio to disk if debugging is enabled.
if self.save_decode_audio:
decode_cmd += f" tee {self.save_decode_audio_path} |"
2019-09-10 11:12:36 +00:00
decode_cmd += "./lms6Xmod --json 2>/dev/null"
2019-09-08 08:46:18 +00:00
elif self.sonde_type == "MEISEI":
# Meisei IMS-100 Sondes
2022-04-02 09:38:13 +00:00
_sample_rate = 48000
decode_cmd = get_sdr_iq_cmd(
2022-04-02 09:38:13 +00:00
sdr_type = self.sdr_type,
frequency = self.sonde_freq,
sample_rate = _sample_rate,
sdr_hostname = self.sdr_hostname,
sdr_port = self.sdr_port,
ss_iq_path = self.ss_iq_path,
2022-04-02 09:38:13 +00:00
rtl_device_idx = self.rtl_device_idx,
ppm = self.ppm,
gain = self.gain,
bias = self.bias
)
2019-09-08 08:46:18 +00:00
# Add in tee command to save IQ to disk if debugging is enabled.
if self.save_decode_iq:
decode_cmd += f" tee {self.save_decode_iq_path} |"
2019-09-08 08:46:18 +00:00
# Meisei Decoder, in IQ input mode
decode_cmd += f"./meisei100mod --IQ 0.0 --lpIQ --dc - {_sample_rate} 16 --json --ptu --ecc 2>/dev/null"
2019-09-08 08:46:18 +00:00
elif self.sonde_type == "MTS01":
# Meteosis MTS-01
_sample_rate = 48000
decode_cmd = get_sdr_iq_cmd(
sdr_type = self.sdr_type,
frequency = self.sonde_freq,
sample_rate = _sample_rate,
sdr_hostname = self.sdr_hostname,
sdr_port = self.sdr_port,
ss_iq_path = self.ss_iq_path,
rtl_device_idx = self.rtl_device_idx,
ppm = self.ppm,
gain = self.gain,
bias = self.bias
)
# Add in tee command to save IQ to disk if debugging is enabled.
if self.save_decode_iq:
decode_cmd += f" tee {self.save_decode_iq_path} |"
# Meteosis MTS01 decoder
2022-11-12 03:28:25 +00:00
decode_cmd += f"./mts01mod --json --IQ 0.0 --lpIQ --dc - {_sample_rate} 16 2>/dev/null"
elif self.sonde_type == "WXR301":
# Weathex WxR-301D
_sample_rate = 96000
_if_bw = 64
decode_cmd = get_sdr_iq_cmd(
sdr_type = self.sdr_type,
frequency = self.sonde_freq,
sample_rate = _sample_rate,
sdr_hostname = self.sdr_hostname,
sdr_port = self.sdr_port,
ss_iq_path = self.ss_iq_path,
rtl_device_idx = self.rtl_device_idx,
ppm = self.ppm,
gain = self.gain,
bias = self.bias
)
# Add in tee command to save IQ to disk if debugging is enabled.
if self.save_decode_iq:
decode_cmd += f" tee {self.save_decode_iq_path} |"
# WXR301, via iq_dec as a FM Demod.
decode_cmd += f"./iq_dec --FM --IFbw {_if_bw} --lpFM --wav --iq 0.0 - {_sample_rate} 16 2>/dev/null | ./weathex301d -b --json"
elif self.sonde_type == "UDP":
# UDP Input Mode.
# Used only for testing of new decoders, prior to them being integrated into auto_rx.
decode_cmd = "python -m autorx.udplistener"
2019-04-26 08:55:48 +00:00
else:
return None
return decode_cmd
def generate_decoder_command_experimental(self):
""" Generate the shell command which runs the relevant radiosonde decoder - Experimental Decoders
Returns:
Tuple(str, str, FSKDemodState) / None: The demod & decoder commands, and a FSKDemodStats object to process the demodulator statistics.
"""
2019-04-26 08:55:48 +00:00
self.log_info("Using fsk_demod decoder chain.")
# Common options to rtl_fm
# Add a -T option if bias is enabled
bias_option = "-T " if self.bias else ""
# Add a gain parameter if we have been provided one.
if self.gain != -1:
gain_param = "-g %.1f " % self.gain
else:
gain_param = ""
# Emit demodulator statistics every X modem frames.
_stats_rate = 5
if self.sonde_type == "RS41":
# RS41 Decoder
_baud_rate = 4800
2022-04-02 09:38:13 +00:00
_sample_rate = 48000 # 10x Oversampling
2022-03-27 07:18:50 +00:00
# Limit FSK estimator window to roughly +/- 10 kHz
2022-04-02 09:38:13 +00:00
_lower = -10000
_upper = 10000
demod_cmd = get_sdr_iq_cmd(
sdr_type = self.sdr_type,
frequency = self.sonde_freq,
sample_rate = _sample_rate,
sdr_hostname = self.sdr_hostname,
sdr_port = self.sdr_port,
ss_iq_path = self.ss_iq_path,
rtl_device_idx = self.rtl_device_idx,
ppm = self.ppm,
gain = self.gain,
bias = self.bias,
dc_block = True
)
# Add in tee command to save IQ to disk if debugging is enabled.
2022-11-26 07:03:59 +00:00
if self.save_decode_iq:
demod_cmd += f" tee {self.save_decode_iq_path} |"
demod_cmd += "./fsk_demod --cs16 -b %d -u %d -s --stats=%d 2 %d %d - -" % (
_lower,
_upper,
_stats_rate,
_sample_rate,
_baud_rate,
)
decode_cmd = f"./rs41mod --ptu2 --json --softin -i {self.raw_file_option} 2>/dev/null"
# RS41s transmit pulsed beacons - average over the last 2 frames, and use a peak-hold
demod_stats = FSKDemodStats(averaging_time=2.0, peak_hold=True)
2022-03-27 07:18:50 +00:00
self.rx_frequency = self.sonde_freq
elif self.sonde_type == "RS92":
# Decoding a RS92 requires either an ephemeris or an almanac file.
# If we have been supplied an ephemeris file, we will attempt to use it, otherwise
# we will try and download one.
if self.rs92_ephemeris == None:
# If no ephemeris data defined, attempt to download it.
# get_ephemeris will either return the saved file name, or None.
self.rs92_ephemeris = get_ephemeris(destination="ephemeris.dat")
# If ephemeris is still None, then we failed to download the ephemeris data.
# Try and grab the almanac data instead
if self.rs92_ephemeris == None:
self.log_error(
"Could not obtain ephemeris data, trying to download an almanac."
)
almanac = get_almanac(destination="almanac.txt")
if almanac == None:
# We probably don't have an internet connection. Bomb out, since we can't do much with the sonde telemetry without an almanac!
self.log_error(
"Could not obtain GPS ephemeris or almanac data."
)
return None
else:
_rs92_gps_data = "-a almanac.txt --gpsepoch 2" # Note - This will need to be updated in... 19 years.
else:
_rs92_gps_data = "-e ephemeris.dat"
else:
_rs92_gps_data = "-e %s" % self.rs92_ephemeris
2022-04-02 09:38:13 +00:00
_baud_rate = 4800
2019-03-11 06:13:39 +00:00
if self.sonde_freq > 1000e6:
2022-04-02 09:38:13 +00:00
_sample_rate = 96000
2021-03-10 11:03:54 +00:00
_ptu_ops = "--ngp --ptu"
2022-04-02 09:38:13 +00:00
_lower = -10000
_upper = 10000
else:
2022-04-02 09:38:13 +00:00
_sample_rate = 48000
2021-02-24 08:06:42 +00:00
_ptu_ops = "--ptu"
2022-04-02 09:38:13 +00:00
_lower = -20000
_upper = 20000
2019-03-11 06:13:39 +00:00
2022-04-02 09:38:13 +00:00
demod_cmd = get_sdr_iq_cmd(
sdr_type = self.sdr_type,
frequency = self.sonde_freq,
sample_rate = _sample_rate,
sdr_hostname = self.sdr_hostname,
sdr_port = self.sdr_port,
ss_iq_path = self.ss_iq_path,
2022-04-02 09:38:13 +00:00
rtl_device_idx = self.rtl_device_idx,
ppm = self.ppm,
gain = self.gain,
bias = self.bias,
dc_block = True
)
# Add in tee command to save IQ to disk if debugging is enabled.
if self.save_decode_iq:
demod_cmd += f" tee {self.save_decode_iq_path} |"
demod_cmd += "./fsk_demod --cs16 -b %d -u %d -s --stats=%d 2 %d %d - -" % (
_lower,
_upper,
_stats_rate,
2022-04-02 09:38:13 +00:00
_sample_rate,
_baud_rate,
)
decode_cmd = (
"./rs92mod -vx -v --crc --ecc --vel --json --softin -i %s %s 2>/dev/null"
% (_rs92_gps_data, _ptu_ops)
)
# RS92s transmit continuously - average over the last 2 frames, and use a mean
demod_stats = FSKDemodStats(averaging_time=2.0, peak_hold=True)
2022-04-02 09:38:13 +00:00
self.rx_frequency = self.sonde_freq
2018-06-01 13:26:49 +00:00
elif self.sonde_type == "DFM":
2022-04-02 09:38:13 +00:00
# DFM06/DFM09/DFM17 Sondes.
2019-03-11 06:13:39 +00:00
_baud_rate = 2500
2022-04-02 09:38:13 +00:00
_sample_rate = 50000 # 10x Oversampling
# Limit FSK estimator window to roughly +/- 10 kHz
_lower = -10000
_upper = 10000
2022-07-15 09:25:50 +00:00
if (abs(403200000 - self.sonde_freq) < 20000) and (self.sdr_type == "RTLSDR"):
2022-04-02 09:38:13 +00:00
# Narrow up the frequency estimator window if we are close to
# the 403.2 MHz RTLSDR Spur.
_lower = -8000
_upper = 8000
demod_cmd = get_sdr_iq_cmd(
sdr_type = self.sdr_type,
frequency = self.sonde_freq,
sample_rate = _sample_rate,
sdr_hostname = self.sdr_hostname,
sdr_port = self.sdr_port,
ss_iq_path = self.ss_iq_path,
2022-04-02 09:38:13 +00:00
rtl_device_idx = self.rtl_device_idx,
ppm = self.ppm,
gain = self.gain,
bias = self.bias,
dc_block = True
)
# Add in tee command to save IQ to disk if debugging is enabled.
if self.save_decode_iq:
demod_cmd += f" tee {self.save_decode_iq_path} |"
demod_cmd += "./fsk_demod --cs16 -b %d -u %d -s --stats=%d 2 %d %d - -" % (
_lower,
_upper,
_stats_rate,
2022-04-02 09:38:13 +00:00
_sample_rate,
_baud_rate,
)
# DFM decoder
if len(self.raw_file_option)>0:
# Use raw ecc detailed raw output for DFM sondes.
self.raw_file_option = "--rawecc"
decode_cmd = (
f"./dfm09mod -vv --ecc --json --dist --auto --softin -i {self.raw_file_option} 2>/dev/null"
)
# DFM sondes transmit continuously - average over the last 2 frames, and peak hold
demod_stats = FSKDemodStats(averaging_time=2.0, peak_hold=True)
2022-04-02 09:38:13 +00:00
self.rx_frequency = self.sonde_freq
elif self.sonde_type == "M10":
# M10 Sondes
2019-04-26 08:55:48 +00:00
# These have a 'weird' baud rate, and as fsk_demod requires the input sample rate to be an integer multiple of the baud rate,
# our required sample rate is correspondingly weird!
2022-04-02 09:38:13 +00:00
2019-03-11 06:13:39 +00:00
_baud_rate = 9616
2022-04-02 09:38:13 +00:00
_sample_rate = 48080
_p = 5 # Override the oversampling rate
# Limit FSK estimator window to roughly +/- 10 kHz
_lower = -10000
_upper = 10000
demod_cmd = get_sdr_iq_cmd(
sdr_type = self.sdr_type,
frequency = self.sonde_freq,
sample_rate = _sample_rate,
sdr_hostname = self.sdr_hostname,
sdr_port = self.sdr_port,
ss_iq_path = self.ss_iq_path,
2022-04-02 09:38:13 +00:00
rtl_device_idx = self.rtl_device_idx,
ppm = self.ppm,
gain = self.gain,
bias = self.bias,
dc_block = True
)
# Add in tee command to save IQ to disk if debugging is enabled.
if self.save_decode_iq:
demod_cmd += f" tee {self.save_decode_iq_path} |"
demod_cmd += (
2022-04-02 09:38:13 +00:00
"./fsk_demod --cs16 -b %d -u %d -s -p %d --stats=%d 2 %d %d - -"
% (_lower, _upper, _p, _stats_rate, _sample_rate, _baud_rate)
)
# M10 decoder
decode_cmd = f"./m10mod --json --ptu -vvv --softin -i {self.raw_file_option} 2>/dev/null"
# M10 sondes transmit in short, irregular pulses - average over the last 2 frames, and use a peak hold
demod_stats = FSKDemodStats(averaging_time=2.0, peak_hold=True)
2022-04-02 09:38:13 +00:00
self.rx_frequency = self.sonde_freq
2019-03-17 11:28:09 +00:00
2020-06-27 01:47:51 +00:00
elif self.sonde_type == "M20":
# M20 Sondes
# 9600 baud.
2022-04-02 09:38:13 +00:00
2020-06-27 01:47:51 +00:00
_baud_rate = 9600
2022-04-02 09:38:13 +00:00
_sample_rate = 48000
_p = 5
# Limit FSK estimator window to roughly +/- 10 kHz
_lower = -10000
_upper = 10000
demod_cmd = get_sdr_iq_cmd(
sdr_type = self.sdr_type,
frequency = self.sonde_freq,
sample_rate = _sample_rate,
sdr_hostname = self.sdr_hostname,
sdr_port = self.sdr_port,
ss_iq_path = self.ss_iq_path,
2022-04-02 09:38:13 +00:00
rtl_device_idx = self.rtl_device_idx,
ppm = self.ppm,
gain = self.gain,
bias = self.bias,
dc_block = True
)
2020-06-27 01:47:51 +00:00
# Add in tee command to save IQ to disk if debugging is enabled.
if self.save_decode_iq:
demod_cmd += f" tee {self.save_decode_iq_path} |"
2020-06-27 01:47:51 +00:00
demod_cmd += (
2022-04-02 09:38:13 +00:00
"./fsk_demod --cs16 -b %d -u %d -s -p %d --stats=%d 2 %d %d - -"
% (_lower, _upper, _p, _stats_rate, _sample_rate, _baud_rate)
)
2020-06-27 01:47:51 +00:00
# M20 decoder
decode_cmd = f"./m20mod --json --ptu -vvv --softin -i {self.raw_file_option} 2>/dev/null"
2020-06-27 01:47:51 +00:00
# M20 sondes transmit in short, irregular pulses - average over the last 2 frames, and use a peak hold
demod_stats = FSKDemodStats(averaging_time=2.0, peak_hold=True)
2022-04-02 09:38:13 +00:00
self.rx_frequency = self.sonde_freq
2020-06-27 01:47:51 +00:00
elif self.sonde_type.startswith("LMS"):
# LMS6 (400 MHz variant) Decoder command.
2022-04-02 09:38:13 +00:00
_baud_rate = 4800
2022-04-02 09:38:13 +00:00
_sample_rate = 48000
# Limit FSK estimator window to roughly +/- 10 kHz
_lower = -10000
_upper = 10000
demod_cmd = get_sdr_iq_cmd(
sdr_type = self.sdr_type,
frequency = self.sonde_freq,
sample_rate = _sample_rate,
sdr_hostname = self.sdr_hostname,
sdr_port = self.sdr_port,
ss_iq_path = self.ss_iq_path,
2022-04-02 09:38:13 +00:00
rtl_device_idx = self.rtl_device_idx,
ppm = self.ppm,
gain = self.gain,
bias = self.bias,
dc_block = True
)
2022-04-02 09:38:13 +00:00
# Add in tee command to save IQ to disk if debugging is enabled.
if self.save_decode_iq:
demod_cmd += f" tee {self.save_decode_iq_path} |"
demod_cmd += "./fsk_demod --cs16 -b %d -u %d -s --stats=%d 2 %d %d - -" % (
_lower,
_upper,
_stats_rate,
2022-04-02 09:38:13 +00:00
_sample_rate,
_baud_rate,
)
decode_cmd = f"./lms6Xmod --json --softin --vit2 -i {self.raw_file_option} 2>/dev/null"
# LMS sondes transmit continuously - average over the last 2 frames, and use a peak hold
demod_stats = FSKDemodStats(averaging_time=2.0, peak_hold=True)
2022-04-02 09:38:13 +00:00
self.rx_frequency = self.sonde_freq
2021-01-25 03:32:09 +00:00
elif self.sonde_type == "IMET5":
# iMet-54 Decoder command.
2022-04-02 09:38:13 +00:00
2021-01-25 03:32:09 +00:00
_baud_rate = 4800
2022-04-02 09:38:13 +00:00
_sample_rate = 48000
# Limit FSK estimator window to roughly +/- 10 kHz
_lower = -10000
_upper = 10000
demod_cmd = get_sdr_iq_cmd(
sdr_type = self.sdr_type,
frequency = self.sonde_freq,
sample_rate = _sample_rate,
sdr_hostname = self.sdr_hostname,
sdr_port = self.sdr_port,
ss_iq_path = self.ss_iq_path,
2022-04-02 09:38:13 +00:00
rtl_device_idx = self.rtl_device_idx,
ppm = self.ppm,
gain = self.gain,
bias = self.bias,
dc_block = True
2021-01-25 03:32:09 +00:00
)
# Add in tee command to save IQ to disk if debugging is enabled.
if self.save_decode_iq:
demod_cmd += f" tee {self.save_decode_iq_path} |"
2021-01-25 03:32:09 +00:00
demod_cmd += "./fsk_demod --cs16 -b %d -u %d -s --stats=%d 2 %d %d - -" % (
_lower,
_upper,
_stats_rate,
2022-04-02 09:38:13 +00:00
_sample_rate,
2021-01-25 03:32:09 +00:00
_baud_rate,
)
decode_cmd = f"./imet54mod --ecc --json --softin -i --ptu 2>/dev/null"
2021-01-25 03:32:09 +00:00
# iMet54 sondes transmit in bursts. Use a peak hold.
demod_stats = FSKDemodStats(averaging_time=2.0, peak_hold=True)
2022-04-02 09:38:13 +00:00
self.rx_frequency = self.sonde_freq
2021-01-25 03:32:09 +00:00
elif self.sonde_type == "MRZ":
# MRZ Sondes.
_baud_rate = 2400
2022-04-02 09:38:13 +00:00
_sample_rate = 48000
# Limit FSK estimator window to roughly +/- 10 kHz
_lower = -10000
_upper = 10000
demod_cmd = get_sdr_iq_cmd(
sdr_type = self.sdr_type,
frequency = self.sonde_freq,
sample_rate = _sample_rate,
sdr_hostname = self.sdr_hostname,
sdr_port = self.sdr_port,
ss_iq_path = self.ss_iq_path,
2022-04-02 09:38:13 +00:00
rtl_device_idx = self.rtl_device_idx,
ppm = self.ppm,
gain = self.gain,
bias = self.bias,
dc_block = True
)
# Add in tee command to save IQ to disk if debugging is enabled.
if self.save_decode_iq:
demod_cmd += f" tee {self.save_decode_iq_path} |"
demod_cmd += "./fsk_demod --cs16 -s -b %d -u %d --stats=%d 2 %d %d - -" % (
_lower,
_upper,
_stats_rate,
2022-04-02 09:38:13 +00:00
_sample_rate,
_baud_rate,
)
2021-03-16 07:49:38 +00:00
# MRZ decoder
decode_cmd = f"./mp3h1mod --auto --json --softin --ptu 2>/dev/null"
# MRZ sondes transmit continuously - average over the last frame, and use a peak hold
demod_stats = FSKDemodStats(averaging_time=1.0, peak_hold=True)
2022-04-02 09:38:13 +00:00
self.rx_frequency = self.sonde_freq
elif self.sonde_type == "MK2LMS":
# 1680 MHz LMS6 sondes, using 9600 baud MK2A-format telemetry.
# This fsk_demod command *almost* works (using the updated fsk_demod)
# rtl_fm -p 0 -d 0 -M raw -F9 -s 307712 -f 1676000000 2>/dev/null |~/Dev/codec2-upstream/build/src/fsk_demod --cs16 -p 32 --mask=100000 --stats=5 2 307712 9616 - - 2> stats.txt | python ./test/bit_to_samples.py 48080 9616 | sox -t raw -r 48080 -e unsigned-integer -b 8 -c 1 - -r 48080 -b 8 -t wav - 2>/dev/null| ./mk2a_lms1680 --json
# Notes:
# - Have dropped the low-leakage FIR filter (-F9) to save a bit of CPU
# Have scaled back sample rate to 220 kHz to again save CPU.
# mk2a1680mod runs at ~90% CPU on a RPi 3, with rtl_fm using ~50% of another core.
2022-04-02 09:38:13 +00:00
_baud_rate = 4800
_sample_rate = 220000
demod_cmd = get_sdr_iq_cmd(
sdr_type = self.sdr_type,
frequency = self.sonde_freq,
sample_rate = _sample_rate,
sdr_hostname = self.sdr_hostname,
sdr_port = self.sdr_port,
ss_iq_path = self.ss_iq_path,
2022-04-02 09:38:13 +00:00
rtl_device_idx = self.rtl_device_idx,
ppm = self.ppm,
gain = self.gain,
bias = self.bias,
fast_filter = True # Don't use -F9
)
# Add in tee command to save audio to disk if debugging is enabled.
if self.save_decode_iq:
demod_cmd += f" tee {self.save_decode_iq_path} |"
# LMS6-1680 decoder
demod_cmd += f"./mk2a1680mod --iq 0.0 --lpIQ --lpbw 160 --lpFM --dc --crc --json {self.raw_file_option} - 220000 16 2>/dev/null"
decode_cmd = None
demod_stats = None
2022-04-02 09:38:13 +00:00
self.rx_frequency = self.sonde_freq
# Settings for old decoder, which cares about FM inversion.
# if self.inverted:
# self.log_debug("Using inverted MK2A decoder.")
# decode_cmd += f"./mk2a_lms1680 -i --json {self.raw_file_option} 2>/dev/null"
# else:
# decode_cmd += f"./mk2a_lms1680 --json {self.raw_file_option} 2>/dev/null"
elif self.sonde_type == "MEISEI":
# Meisei iMS100 Sondes.
_baud_rate = 2400
_sample_rate = 48000
# Limit FSK estimator window to roughly +/- 15 kHz
_lower = -15000
_upper = 15000
demod_cmd = get_sdr_iq_cmd(
sdr_type = self.sdr_type,
frequency = self.sonde_freq,
sample_rate = _sample_rate,
sdr_hostname = self.sdr_hostname,
sdr_port = self.sdr_port,
ss_iq_path = self.ss_iq_path,
rtl_device_idx = self.rtl_device_idx,
ppm = self.ppm,
gain = self.gain,
bias = self.bias,
dc_block = True
)
# Add in tee command to save IQ to disk if debugging is enabled.
if self.save_decode_iq:
demod_cmd += f" tee {self.save_decode_iq_path} |"
demod_cmd += "./fsk_demod --cs16 -s -b %d -u %d --stats=%d 2 %d %d - -" % (
_lower,
_upper,
_stats_rate,
_sample_rate,
_baud_rate,
)
decode_cmd = f"./meisei100mod --softin --json --ptu --ecc 2>/dev/null"
# Meisei sondes transmit continuously - average over the last frame, and use a peak hold
demod_stats = FSKDemodStats(averaging_time=1.0, peak_hold=True)
self.rx_frequency = self.sonde_freq
else:
return None
return (demod_cmd, decode_cmd, demod_stats)
def stats_thread(self, asyncreader):
""" Process demodulator statistics from a supplied AsynchronousFileReader object (which will be hooked into stderr from fsk_demod) """
while (not asyncreader.eof()) and self.decoder_running:
for _line in asyncreader.readlines():
self.demod_stats.update(_line)
# Avoid spinlocking..
# Probably about time we looked at using async for this stuff...
time.sleep(0.2)
asyncreader.stop()
2019-09-21 11:24:09 +00:00
def decoder_thread(self):
""" Runs the supplied decoder command(s) as a subprocess, and passes returned lines to handle_decoder_line. """
# Timeout Counter.
_last_packet = time.time()
if self.decoder_command_2 is None:
# No second decoder command, so we only need to process stdout from the one process.
self.log_debug("Decoder Command: %s" % self.decoder_command)
# Start the thread.
self.decode_process = subprocess.Popen(
self.decoder_command,
shell=True,
stdin=None,
stdout=subprocess.PIPE,
preexec_fn=os.setsid,
)
else:
# Two decoder commands! This means one is a demod command, from which we need to handle stderr,
# and one is a decoder, which we pipe in stdout from the demodulator.
self.log_debug("Demodulator Command: %s" % self.decoder_command)
self.log_debug("Decoder Command: %s" % self.decoder_command_2)
# Startup the subprocesses
self.demod_process = subprocess.Popen(
self.decoder_command,
shell=True,
stdin=None,
stdout=subprocess.PIPE,
stderr=subprocess.PIPE,
preexec_fn=os.setsid,
)
self.decode_process = subprocess.Popen(
self.decoder_command_2,
shell=True,
stdin=self.demod_process.stdout,
stdout=subprocess.PIPE,
preexec_fn=os.setsid,
)
self.demod_reader = AsynchronousFileReader(
self.demod_process.stderr, autostart=True
)
# Start thread to process demodulator stats.
self.demod_stats_thread = Thread(
target=self.stats_thread, args=(self.demod_reader,)
)
self.demod_stats_thread.start()
self.async_reader = AsynchronousFileReader(
self.decode_process.stdout, autostart=True
)
self.log_info("Starting decoder subprocess.")
while (not self.async_reader.eof()) and self.decoder_running:
# Read in any lines available in the async reader queue.
for _line in self.async_reader.readlines():
if (_line != None) and (_line != ""):
# Pass the line into the handler, and see if it is OK.
_ok = self.handle_decoder_line(_line)
# If we decoded a valid JSON blob, update our last-packet time.
if _ok:
_last_packet = time.time()
# Check timeout counter.
if (
(self.timeout > 0)
and (time.time() > (_last_packet + self.timeout))
and (not self.udp_mode)
):
# If we have not seen data for a while, break.
self.log_error("RX Timed out.")
self.exit_state = "Timeout"
break
else:
# Otherwise, sleep for a short time.
time.sleep(0.1)
# Either our subprocess has exited, or the user has asked to close the process.
# Try many things to kill off the subprocess.
try:
# Stop the async reader
self.async_reader.stop()
# Send a SIGKILL to the subprocess PID via OS.
try:
os.killpg(os.getpgid(self.decode_process.pid), signal.SIGKILL)
if self.experimental_decoder:
os.killpg(os.getpgid(self.demod_process.pid), signal.SIGKILL)
except Exception as e:
self.log_debug("SIGKILL via os.killpg failed. - %s" % str(e))
time.sleep(1)
try:
# Send a SIGKILL via subprocess
self.decode_process.kill()
if self.experimental_decoder:
self.demod_process.kill()
except Exception as e:
self.log_debug("SIGKILL via subprocess.kill failed - %s" % str(e))
# Finally, join the async reader.
self.async_reader.join()
except Exception as e:
traceback.print_exc()
self.log_error("Error while killing subprocess - %s" % str(e))
self.log_info("Closed decoder subprocess.")
self.decoder_running = False
def handle_decoder_line(self, data):
""" Handle a line of output from the decoder subprocess, and pass it onto all of the telemetry
exporters.
Args:
data (str, bytearray): One line of text output from the decoder subprocess.
Returns:
bool: True if the line was decoded to a JSON object correctly, False otherwise.
"""
# Catch 'bad' first characters.
try:
_first_char = data.decode("ascii")[0]
except UnicodeDecodeError:
return
# Don't even try and decode lines which don't start with a '{'
# These may be other output from the decoder, which we shouldn't try to parse.
# If we have raw logging enabled, log these lines to disk.
if data.decode("ascii")[0] != "{":
# Save the line verbatim to the raw data file, if we have that enabled
if self.raw_file:
self.raw_file.write(data)
else:
return
else:
try:
_telemetry = json.loads(data.decode("ascii"))
except Exception as e:
self.log_debug("Line could not be parsed as JSON - %s" % str(e))
return False
# Check the JSON blob has been parsed as a dictionary
if type(_telemetry) is not dict:
self.log_error("Parsed JSON object is not a dictionary!")
return False
# Check that the required fields are in the telemetry blob
for _field in self.DECODER_REQUIRED_FIELDS:
if _field not in _telemetry:
self.log_error(
"JSON object missing required field %s. Have you re-built the decoders? (./build.sh)"
% _field
)
return False
# Check the decoder version matches our current version.
# Note that we allow any version in UDP mode, as this is commonly used for experimentation work.
if (_telemetry["version"] != autorx.__version__) and (not self.udp_mode):
self.log_critical(
"Decoder version (%s) does not match auto_rx version (%s). Have you re-built the decoders? (./build.sh)"
% (_telemetry["version"], autorx.__version__)
)
self.exit_state = "Decoder Version Mismatch"
self.decoder_running = False
return False
# Check for fields which we need for logging purposes, but may not always be provided
# in the incoming JSON object.
# These get added in with dummy values.
for _field in self.DECODER_OPTIONAL_FIELDS.keys():
if _field not in _telemetry:
_telemetry[_field] = self.DECODER_OPTIONAL_FIELDS[_field]
# Check for an encrypted flag, and check if it is set.
# Currently encrypted == true indicates an encrypted RS41-SGM. There's no point
# trying to decode this, so we close the decoder at this point.
if "encrypted" in _telemetry:
if _telemetry["encrypted"]:
self.log_error(
"Radiosonde %s has encrypted telemetry (Possible encrypted RS41-SGM)! We cannot decode this, closing decoder."
% _telemetry["id"]
)
# Overwrite the datetime field to make the email notifier happy
_telemetry['datetime_dt'] = datetime.datetime.utcnow()
_telemetry["freq"] = "%.3f MHz" % (self.sonde_freq / 1e6)
# Send this to only the Email Notifier, if it exists.
for _exporter in self.exporters:
try:
if _exporter.__self__.__module__ == EmailNotification.__module__:
_exporter(_telemetry)
except Exception as e:
self.log_error("Exporter Error %s" % str(e))
# Close the decoder.
self.exit_state = "Encrypted"
self.decoder_running = False
return False
2019-04-08 06:05:16 +00:00
2018-05-13 12:53:29 +00:00
# Check the datetime field is parseable.
try:
_telemetry["datetime_dt"] = parse(_telemetry["datetime"])
2018-05-13 12:53:29 +00:00
except Exception as e:
self.log_error(
"Invalid date/time in telemetry dict - %s (Sonde may not have GPS lock)"
% str(e)
)
2018-05-13 12:53:29 +00:00
return False
if self.udp_mode:
2020-05-23 07:06:20 +00:00
# If we are accepting sondes via UDP, we make use of the 'type' field provided by
# the decoder.
self.sonde_type = _telemetry["type"]
2020-05-23 07:06:20 +00:00
# If frequency has been provided, make used of it.
2020-10-26 11:07:22 +00:00
# Frequency must be supplied in kHz!
if "freq" in _telemetry:
self.sonde_freq = float(_telemetry["freq"]) * 1e3
# Add in the sonde type field.
if "subtype" in _telemetry:
if self.sonde_type == "RS41":
# For RS41 sondes, we are provided with a more specific subtype string (RS41-SG, RS41-SGP, RS41-SGM)
# in the subtype field, so we can use this directly.
_telemetry["type"] = _telemetry["subtype"]
elif self.sonde_type == "DFM":
# As of 2021-2, the decoder provides a guess of the DFM subtype, provided as
# a subtype field of "0xX:GUESS", e.g. "0xD:DFM17P"
if ":" in _telemetry["subtype"]:
_subtype = _telemetry["subtype"].split(":")[1]
_telemetry["dfmcode"] = _telemetry["subtype"].split(":")[0]
_telemetry["type"] = _subtype
_telemetry["subtype"] = _subtype
else:
_telemetry["type"] = "DFM"
_telemetry["subtype"] = "DFM"
# Check frame ID here to ensure we are on dfm09mod version with the frame number fixes (2020-12).
if _telemetry["frame"] < 256:
self.log_error(
"DFM Frame ID is <256, have you run build.sh recently?"
)
return False
2022-12-22 06:27:58 +00:00
elif self.sonde_type == "MEISEI":
# For meisei sondes, we are provided a subtype that distinguishes iMS-100 and RS11G sondes.
_telemetry["type"] = _telemetry["subtype"]
else:
# For other sonde types, we leave the type field as it is, even if we are provided
# a subtype field. (This shouldn't happen)
_telemetry["type"] = self.sonde_type
else:
# If no subtype field provided, we use the identified sonde type.
_telemetry["type"] = self.sonde_type
# Don't include the subtype field if we don't have a subtype.
#_telemetry["subtype"] = self.sonde_type
_telemetry["freq_float"] = self.sonde_freq / 1e6
_telemetry["freq"] = "%.3f MHz" % (self.sonde_freq / 1e6)
2018-05-13 12:53:29 +00:00
# Add in information about the SDR used.
_telemetry["sdr_device_idx"] = self.rtl_device_idx
2018-05-13 12:53:29 +00:00
# Check for an 'aux' field, this indicates that the sonde has an auxilliary payload,
2020-05-23 07:06:20 +00:00
# which is most likely an Ozone sensor (though could be something different!)
# We append -Ozone to the sonde type field to indicate this.
# TODO: Decode device ID from aux field to indicate what the aux payload actually is?
if "aux" in _telemetry:
_telemetry["type"] += "-Ozone"
2019-03-17 11:28:09 +00:00
# iMet Specific actions
if self.sonde_type == "IMET":
2019-03-17 11:28:09 +00:00
# Check we have GPS lock.
if _telemetry["sats"] < 4:
2019-03-17 11:28:09 +00:00
# No GPS lock means an invalid time, which means we can't accurately calculate a unique ID.
# We need to quit at this point before the telemetry processing gos any further.
2019-03-17 11:28:09 +00:00
self.log_error("iMet sonde has no GPS lock - discarding frame.")
return False
# Fix up the time.
_telemetry["datetime_dt"] = fix_datetime(_telemetry["datetime"])
2021-12-03 08:45:49 +00:00
# An attempt at detecting iMet-1 vs iMet-4 sondes based on how the frame count increments
# compared to the time.
# Note that this is going to break horribly if an iMet-1 and an iMet-4 are on the same frequency,
# or if there are multiple iMet-4's in the air when this is performed. I don't have a nice
# solution to that second problem.
# This may also break when running in UDP mode for long periods.
if self.imet_type is None:
if self.imet_prev_frame is None:
self.imet_prev_frame = _telemetry['frame']
self.imet_prev_time = _telemetry["datetime_dt"]
self.log_info("Waiting for additional frames to determine iMet type (1 or 4)")
return False
else:
# Calculate and compare frame vs time deltas.
_time_delta = (_telemetry["datetime_dt"] - self.imet_prev_time).total_seconds()
_frame_delta = _telemetry['frame'] - self.imet_prev_frame
if _time_delta == _frame_delta//2:
# Frame counter increments at twice the rate of the time counter = iMet-1
self.log_info("iMet sonde is most likely an iMet-1")
self.imet_type = "iMet-1"
elif _time_delta == _frame_delta:
# Frame counter increments at the same rate as the time counter = iMet-4
self.log_info("iMet sonde is most likely an iMet-4")
self.imet_type = "iMet-4"
else:
# Some other case (possibly 2 sondes on the same frequency?)
# Assume iMet-4...
self.log_info("iMet sonde is most likely an iMet-4 (less confidence)")
self.imet_type = "iMet-4"
else:
_telemetry['subtype'] = self.imet_type
2021-12-03 08:45:49 +00:00
# Generate a unique ID based on the power-on time and frequency, as iMet sonde telemetry is painful
# and doesn't send any ID.
_new_imet_id = imet_unique_id(_telemetry, imet1=(self.imet_type=="iMet-1"))
2021-12-03 08:45:49 +00:00
# If we have seen this ID before, keep using it.
if _new_imet_id in self.imet_id:
_telemetry["id"] = _new_imet_id
else:
# We have seen less than 4 different IDs while this decoder has been runing.
# Accept that this may be a new iMet sonde, and add the ID to the iMet ID list.
if len(self.imet_id) < self.imet_max_ids:
self.imet_id.append(_new_imet_id)
_telemetry["id"] = _new_imet_id
else:
# We have seen see many IDs this decode run, suspect this is likely an old iMet-1
# Which doesn't have a useful frame counter.
self.log_error("Exceeded maximum number of iMet sonde IDs for a decoder (4) - discarding this frame.")
return False
2019-03-17 11:28:09 +00:00
# Re-generate the datetime string.
_telemetry["datetime"] = _telemetry["datetime_dt"].strftime(
"%Y-%m-%dT%H:%M:%SZ"
)
# iMet-5x Specific Actions
2021-01-24 11:48:20 +00:00
if self.sonde_type == "IMET5":
# Fix up the time.
_telemetry["datetime_dt"] = fix_datetime(_telemetry["datetime"])
2021-03-29 07:12:30 +00:00
# Re-generate the datetime string.
_telemetry["datetime"] = _telemetry["datetime_dt"].strftime(
"%Y-%m-%dT%H:%M:%SZ"
)
2021-01-24 11:48:20 +00:00
2020-05-23 07:06:20 +00:00
# LMS Specific Actions (LMS6, MK2LMS)
if "LMS" in self.sonde_type:
# We are only provided with HH:MM:SS, so the timestamp needs to be fixed, just like with the iMet sondes
_telemetry["datetime_dt"] = fix_datetime(_telemetry["datetime"])
# Re-generate the datetime string.
_telemetry["datetime"] = _telemetry["datetime_dt"].strftime(
"%Y-%m-%dT%H:%M:%SZ"
)
# Weathex Specific Actions
# Same datetime issues as with iMets, and LMS6
if self.sonde_type == "WXR301":
# Fix up the time.
_telemetry["datetime_dt"] = fix_datetime(_telemetry["datetime"])
# Re-generate the datetime string.
_telemetry["datetime"] = _telemetry["datetime_dt"].strftime(
"%Y-%m-%dT%H:%M:%SZ"
)
# Grab a snapshot of modem statistics, if we are using an experimental decoder.
if self.demod_stats is not None:
if self.demod_stats.snr != -999.0:
_telemetry["snr"] = self.demod_stats.snr
_telemetry["fest"] = self.demod_stats.fest
_telemetry["ppm"] = self.demod_stats.ppm
# Calculate an estimate of the radiosonde's centre frequency, based on the SDR frequency
# and the modem's tone estimates.
_telemetry["f_centre"] = (
self.rx_frequency
+ (_telemetry["fest"][0] + _telemetry["fest"][1]) / 2.0
)
# Calculate estimated frequency error from where we expected the sonde to be.
_telemetry["f_error"] = _telemetry["f_centre"] - self.sonde_freq
# TODO - Compare the frequency estimate with any frequency information supplied in the sonde telemetry.
# If there is a large difference (> 5 kHz or so), log a warning.
# Try and generate an APRS callsign for this sonde.
# Doing this calculation here allows us to pass it to the web interface to generate an appropriate link
try:
_telemetry["aprsid"] = generate_aprs_id(_telemetry)
except Exception as e:
self.log_debug(
f"Couldn't generate APRS ID for {_telemetry['id']}"
)
_telemetry["aprsid"] = None
# If we have been provided a telemetry filter function, pass the telemetry data
# through the filter, and return the response
# By default, we will assume the telemetry is OK.
2020-06-20 08:07:22 +00:00
_telem_ok = "OK"
if self.telem_filter is not None:
try:
_telem_ok = self.telem_filter(_telemetry)
except Exception as e:
self.log_error("Failed to run telemetry filter - %s" % str(e))
return False
2020-06-20 08:07:22 +00:00
# Check if the telemetry filter has indicated that we should block this frequency for some time.
if _telem_ok == "TempBlock":
self.log_error(
"Temporary block requested by Telemetry Filter. Closing Decoder."
)
2020-06-20 08:07:22 +00:00
self.exit_state = "TempBlock"
self.decoder_running = False
return False
# If the telemetry is OK, send to the exporter functions (if we have any).
if self.exporters is None:
return
else:
2020-06-20 08:07:22 +00:00
if _telem_ok == "OK":
for _exporter in self.exporters:
try:
_exporter(_telemetry)
except Exception as e:
self.log_error("Exporter Error %s" % str(e))
return _telem_ok
def log_debug(self, line):
""" Helper function to log a debug message with a descriptive heading.
Args:
line (str): Message to be logged.
"""
2022-04-02 09:38:13 +00:00
_sdr_name = get_sdr_name(
self.sdr_type,
rtl_device_idx = self.rtl_device_idx,
sdr_hostname = self.sdr_hostname,
sdr_port = self.sdr_port
)
logging.debug(
2022-04-02 09:38:13 +00:00
f"Decoder ({_sdr_name}) {self.sonde_type} {self.sonde_freq/1e6:.3f} - {line}"
)
def log_info(self, line):
""" Helper function to log an informational message with a descriptive heading.
Args:
line (str): Message to be logged.
"""
2022-04-02 09:38:13 +00:00
_sdr_name = get_sdr_name(
self.sdr_type,
rtl_device_idx = self.rtl_device_idx,
sdr_hostname = self.sdr_hostname,
sdr_port = self.sdr_port
)
logging.info(
2022-04-02 09:38:13 +00:00
f"Decoder ({_sdr_name}) {self.sonde_type} {self.sonde_freq/1e6:.3f} - {line}"
)
def log_error(self, line):
""" Helper function to log an error message with a descriptive heading.
Args:
line (str): Message to be logged.
"""
2022-04-02 09:38:13 +00:00
_sdr_name = get_sdr_name(
self.sdr_type,
rtl_device_idx = self.rtl_device_idx,
sdr_hostname = self.sdr_hostname,
sdr_port = self.sdr_port
)
logging.error(
2022-04-02 09:38:13 +00:00
f"Decoder ({_sdr_name}) {self.sonde_type} {self.sonde_freq/1e6:.3f} - {line}"
)
def log_critical(self, line):
""" Helper function to log an critical error message with a descriptive heading.
Args:
line (str): Message to be logged.
"""
2022-04-02 09:38:13 +00:00
_sdr_name = get_sdr_name(
self.sdr_type,
rtl_device_idx = self.rtl_device_idx,
sdr_hostname = self.sdr_hostname,
sdr_port = self.sdr_port
)
logging.critical(
2022-04-02 09:38:13 +00:00
f"Decoder ({_sdr_name}) {self.sonde_type} {self.sonde_freq/1e6:.3f} - {line}"
)
2021-04-23 09:23:50 +00:00
def stop(self, nowait=False):
""" Kill the currently running decoder subprocess """
self.decoder_running = False
2021-04-23 09:23:50 +00:00
if self.decoder is not None and (not nowait):
self.decoder.join()
if self.raw_file:
self.raw_file.close()
def running(self):
""" Check if the decoder subprocess is running.
Returns:
bool: True if the decoder subprocess is running.
"""
return self.decoder_running
if __name__ == "__main__":
# Test script.
2018-05-13 12:53:29 +00:00
from .logger import TelemetryLogger
from .habitat import HabitatUploader
logging.basicConfig(
format="%(asctime)s %(levelname)s:%(message)s", level=logging.DEBUG
)
# Make requests & urllib3 STFU
requests_log = logging.getLogger("requests")
requests_log.setLevel(logging.CRITICAL)
urllib3_log = logging.getLogger("urllib3")
urllib3_log.setLevel(logging.CRITICAL)
2018-05-14 10:13:49 +00:00
_log = TelemetryLogger(log_directory="./testlog/")
_habitat = HabitatUploader(user_callsign="VK5QI_AUTO_RX_DEV", inhibit=False)
2018-05-13 12:53:29 +00:00
try:
_decoder = SondeDecoder(
sonde_freq=401.5 * 1e6,
sonde_type="RS41",
timeout=50,
rtl_device_idx="00000002",
exporter=[_habitat.add, _log.add],
)
# _decoder2 = SondeDecoder(sonde_freq = 405.5*1e6,
# sonde_type = "RS41",
# timeout = 50,
# rtl_device_idx="00000001",
# exporter=[_habitat.add, _log.add])
while True:
time.sleep(5)
if not _decoder.running():
break
except KeyboardInterrupt:
2018-05-20 06:53:53 +00:00
_decoder.stop()
# _decoder2.stop()
except:
traceback.print_exc()
pass
_habitat.close()
_log.close()