#!/usr/bin/env python # # Horus Binary - fsk_demod modem statistics parser # # Copyright (C) 2019 Mark Jessop # Released under GNU GPL v3 or later # # This utility ingests fsk_demod stats output via stdin, and optionally emits time-averaged modem statistics # data via UDP. # import argparse import json import logging import socket import sys import time import numpy as np class FSKDemodStats(object): """ Process modem statistics produced by horus/fsk_demod and provide access to filtered or instantaneous modem data. This class expects the JSON output from horus_demod to be arriving in *realtime*. The test script below will emulate relatime input based on a file. """ FSK_STATS_FIELDS = ['EbNodB', 'ppm', 'f1_est', 'f2_est', 'samp_fft'] def __init__(self, averaging_time = 5.0, peak_hold = False, decoder_id = "" ): """ Required Fields: averaging_time (float): Use the last X seconds of data in calculations. peak_hold (bool): If true, use a peak-hold SNR metric instead of a mean. decoder_id (str): A unique ID for this object (suggest use of the SDR device ID) """ self.averaging_time = float(averaging_time) self.peak_hold = peak_hold self.decoder_id = str(decoder_id) # Input data stores. self.in_times = np.array([]) self.in_snr = np.array([]) self.in_ppm = np.array([]) # Output State variables. self.snr = -999.0 self.fest = [0.0,0.0, 0.0,0.0] self.fest_mean = 0.0 self.fft = [] self.ppm = 0.0 def update(self, data): """ Update the statistics parser with a new set of output from fsk_demod. This can accept either a string (which will be parsed as JSON), or a dict. Required Fields: data (str, dict): One set of statistics from fsk_demod. """ # Check input type if type(data) == str: # Attempt to parse string. try: # Clean up any nan entries, which aren't valid JSON. # For now we just replace these with 0, since they only seem to occur # in the eye diagram data, which we don't use anyway. if 'nan' in data: data = data.replace('nan', '0.0') _data = json.loads(data) except Exception as e: self.log_error("FSK Demod Stats - %s" % str(e)) return elif type(data) == dict: _data = data else: return # Check for required fields in incoming dictionary. for _field in self.FSK_STATS_FIELDS: if _field not in _data: self.log_error("Missing Field %s" % _field) return # Now we can process the data. _time = time.time() self.fft = _data['samp_fft'] self.fest = [0.0,0.0,0.0,0.0] self.fest[0] = _data['f1_est'] self.fest[1] = _data['f2_est'] if 'f3_est' in _data: self.fest[2] = _data['f3_est'] if 'f4_est' in _data: self.fest[3] = _data['f4_est'] else: self.fest = self.fest[:2] self.fest_mean = np.mean(self.fest) # Time-series data self.in_times = np.append(self.in_times, _time) self.in_snr = np.append(self.in_snr, _data['EbNodB']) self.in_ppm = np.append(self.in_ppm, _data['ppm']) # Calculate SNR / PPM _time_range = self.in_times>(_time-self.averaging_time) # Clip arrays to just the values we want self.in_ppm = self.in_ppm[_time_range] self.in_snr = self.in_snr[_time_range] self.in_times = self.in_times[_time_range] # Always just take a mean of the PPM values. self.ppm = np.mean(self.in_ppm) if self.peak_hold: self.snr = np.max(self.in_snr) else: self.snr = np.mean(self.in_snr) def log_debug(self, line): """ Helper function to log a debug message with a descriptive heading. Args: line (str): Message to be logged. """ logging.debug("FSK Demod Stats #%s - %s" % (str(self.decoder_id), line)) def log_info(self, line): """ Helper function to log an informational message with a descriptive heading. Args: line (str): Message to be logged. """ logging.info("FSK Demod Stats #%s - %s" % (str(self.decoder_id), line)) def log_error(self, line): """ Helper function to log an error message with a descriptive heading. Args: line (str): Message to be logged. """ logging.error("FSK Demod Stats #%s - %s" % (str(self.decoder_id), line)) def send_modem_stats(stats, udp_port=55672): """ Send a JSON-encoded dictionary to the wenet frontend """ try: s = socket.socket(socket.AF_INET,socket.SOCK_DGRAM) s.settimeout(1) # Set up socket for broadcast, and allow re-use of the address s.setsockopt(socket.SOL_SOCKET,socket.SO_BROADCAST,1) s.setsockopt(socket.SOL_SOCKET, socket.SO_REUSEADDR, 1) try: s.setsockopt(socket.SOL_SOCKET, socket.SO_REUSEPORT, 1) except: pass s.bind(('',udp_port)) try: s.sendto(json.dumps(stats).encode('ascii'), ('', udp_port)) except socket.error: s.sendto(json.dumps(stats).encode('ascii'), ('127.0.0.1', udp_port)) except Exception as e: logging.error("Error updating GUI with modem status: %s" % str(e)) if __name__ == "__main__": # Command line arguments. parser = argparse.ArgumentParser() parser.add_argument("-r", "--rate", default=1, type=int, help="Update Rate (Hz). Default: 2 Hz") parser.add_argument("-p", "--port", default=55672, type=int, help="Output UDP port. Default: 55672") parser.add_argument("-s", "--source", default='MFSK', help="Source name (must be unique if running multiple decoders). Default: MFSK") args = parser.parse_args() _averaging_time = 1.0/args.rate stats_parser = FSKDemodStats(averaging_time=_averaging_time, peak_hold=True) _last_update_time = time.time() try: while True: data = sys.stdin.readline() # An empty line indicates that stdin has been closed. if data == '': break # Otherwise, feed it to the stats parser. stats_parser.update(data.rstrip()) if (time.time() - _last_update_time) > _averaging_time: # Send latest modem stats to the Wenet frontend. _stats = { 'type': 'MODEM_STATS', 'source': args.source, 'snr': stats_parser.snr, 'ppm': stats_parser.ppm, 'fft': stats_parser.fft, 'fest': stats_parser.fest } send_modem_stats(_stats, args.port) _last_update_time = time.time() except KeyboardInterrupt: pass