FreeDATA/modem/daemon.py

631 lines
20 KiB
Python
Raw Normal View History

#!/usr/bin/python3
# -*- coding: utf-8 -*-
"""
daemon.py
Author: DJ2LS, January 2022
daemon for providing basic information for the modem like audio or serial devices
"""
# pylint: disable=invalid-name, line-too-long, c-extension-no-member
# pylint: disable=import-outside-toplevel
import argparse
import atexit
import multiprocessing
import os
import signal
import socketserver
2021-09-25 13:24:25 +00:00
import subprocess
import sys
import threading
import time
import audio
import crcengine
import log_handler
import serial.tools.list_ports
import sock
from global_instances import ARQ, AudioParam, Beacon, Channel, Daemon, HamlibParam, ModemParam, Station, Statistics, TCIParam, Modem
2023-04-26 17:54:53 +00:00
import structlog
import ujson as json
2022-09-20 09:34:28 +00:00
import config
# signal handler for closing application
def signal_handler(sig, frame):
"""
Signal handler for closing the network socket on app exit
Args:
2022-05-09 00:41:49 +00:00
sig:
frame:
Returns: system exit
"""
print("Closing daemon...")
sock.CLOSE_SIGNAL = True
sys.exit(0)
2022-04-11 09:03:54 +00:00
signal.signal(signal.SIGINT, signal_handler)
class DAEMON:
2022-05-09 00:41:49 +00:00
"""
Daemon class
2022-05-09 00:41:49 +00:00
"""
2022-05-30 17:47:51 +00:00
log = structlog.get_logger("DAEMON")
def __init__(self):
2022-05-09 00:41:49 +00:00
# load crc engine
self.crc_algorithm = crcengine.new("crc16-ccitt-false") # load crc8 library
2022-05-09 00:41:49 +00:00
self.daemon_queue = sock.DAEMON_QUEUE
update_audio_devices = threading.Thread(
target=self.update_audio_devices, name="UPDATE_AUDIO_DEVICES", daemon=True
)
update_audio_devices.start()
update_serial_devices = threading.Thread(
target=self.update_serial_devices, name="UPDATE_SERIAL_DEVICES", daemon=True
)
update_serial_devices.start()
worker = threading.Thread(target=self.worker, name="WORKER", daemon=True)
worker.start()
2022-05-09 00:41:49 +00:00
2023-10-26 18:04:57 +00:00
rigctld_watchdog_thread = threading.Thread(target=self.rigctld_watchdog, name="WORKER", daemon=True)
rigctld_watchdog_thread.start()
def rigctld_watchdog(self):
"""
Check for rigctld status
Returns:
"""
while True:
2023-10-27 12:25:11 +00:00
threading.Event().wait(0.01)
2023-10-26 18:04:57 +00:00
# only continue, if we have a process object initialized
if hasattr(Daemon.rigctldprocess, "returncode"):
if Daemon.rigctldprocess.returncode in [None, "None"] or not Daemon.rigctldstarted:
Daemon.rigctldstarted = True
2023-10-27 20:50:21 +00:00
# outs, errs = Daemon.rigctldprocess.communicate(timeout=10)
# print(f"outs: {outs}")
# print(f"errs: {errs}")
2023-10-27 12:25:11 +00:00
2023-10-26 18:04:57 +00:00
else:
self.log.warning("[DMN] [RIGCTLD] [Watchdog] returncode detected",process=Daemon.rigctldprocess)
Daemon.rigctldstarted = False
# triggering another kill
Daemon.rigctldprocess.kill()
# erase process object
Daemon.rigctldprocess = None
else:
2023-10-27 20:03:11 +00:00
Daemon.rigctldstarted = False
2023-10-26 18:04:57 +00:00
def update_audio_devices(self):
2022-05-09 00:41:49 +00:00
"""
Update audio devices and set to static
"""
while True:
2022-02-15 17:10:14 +00:00
try:
if not Daemon.modemstarted:
(
2023-04-27 19:43:56 +00:00
AudioParam.audio_input_devices,
AudioParam.audio_output_devices,
) = audio.get_audio_devices()
except Exception as err1:
self.log.error(
"[DMN] update_audio_devices: Exception gathering audio devices:",
e=err1,
)
threading.Event().wait(1)
2022-05-09 00:41:49 +00:00
def update_serial_devices(self):
"""
Update serial devices and set to static
"""
while True:
2022-02-15 17:10:14 +00:00
try:
serial_devices = []
ports = serial.tools.list_ports.comports()
for port, desc, hwid in ports:
# calculate hex of hwid if we have unique names
crc_hwid = self.crc_algorithm(bytes(hwid, encoding="utf-8"))
crc_hwid = crc_hwid.to_bytes(2, byteorder="big")
2022-02-15 17:10:14 +00:00
crc_hwid = crc_hwid.hex()
description = f"{desc} [{crc_hwid}]"
serial_devices.append(
{"port": str(port), "description": str(description)}
)
2022-05-09 00:41:49 +00:00
2023-04-27 19:43:56 +00:00
Daemon.serial_devices = serial_devices
threading.Event().wait(1)
except Exception as err1:
self.log.error(
"[DMN] update_serial_devices: Exception gathering serial devices:",
e=err1,
)
2022-05-09 00:41:49 +00:00
def worker(self):
"""
Worker to handle the received commands
"""
while True:
2022-02-15 17:10:14 +00:00
try:
data = self.daemon_queue.get()
# increase length of list for storing additional
# parameters starting at entry 64
data = data[:64] + [None] * (64 - len(data))
2022-02-15 17:10:14 +00:00
# data[1] mycall
# data[2] mygrid
# data[3] rx_audio
# data[4] tx_audio
2023-02-09 20:56:20 +00:00
# data[5] radiocontrol
# data[6] rigctld_ip
# data[7] rigctld_port
# data[8] send_scatter
# data[9] send_fft
# data[10] low_bandwidth_mode
# data[11] tuning_range_fmin
# data[12] tuning_range_fmax
# data[13] enable FSK
# data[14] tx-audio-level
# data[15] respond_to_cq
# data[16] rx_buffer_size
# data[17] explorer
# data[18] ssid_list
# data[19] auto_tune
# data[20] stats
2023-03-06 11:48:27 +00:00
# data[21] tx_delay
2022-05-09 00:41:49 +00:00
if data[0] == "STARTModem":
self.start_modem(data)
2022-02-15 17:10:14 +00:00
2023-02-09 20:56:20 +00:00
if data[0] == "TEST_HAMLIB":
# data[9] radiocontrol
# data[10] rigctld_ip
# data[11] rigctld_port
self.test_hamlib_ptt(data)
2022-05-09 00:41:49 +00:00
if data[0] == "START_RIGCTLD":
"""
data[0] START_RIGCTLD,
data[1] hamlib_deviceid,
data[2] hamlib_deviceport,
data[3] hamlib_stop_bits,
data[4] hamlib_data_bits,
data[5] hamlib_handshake,
data[6] hamlib_serialspeed,
data[7] hamlib_dtrstate,
data[8] hamlib_pttprotocol,
data[9] hamlib_ptt_port,
data[10] hamlib_dcd,
data[11] hamlbib_serialspeed_ptt,
data[12] hamlib_rigctld_port,
data[13] hamlib_rigctld_ip,
data[14] hamlib_rigctld_path,
data[15] hamlib_rigctld_server_port,
2023-10-31 15:45:18 +00:00
data[16] hamlib_rigctld_custom_args
"""
self.start_rigctld(data)
2023-02-09 20:56:20 +00:00
except Exception as err1:
self.log.error("[DMN] worker: Exception: ", e=err1)
2022-05-09 00:41:49 +00:00
2023-02-09 20:56:20 +00:00
def test_hamlib_ptt(self, data):
radiocontrol = data[1]
# check how we want to control the radio
2023-10-27 21:26:54 +00:00
if radiocontrol == "rigctld":
2023-02-09 20:56:20 +00:00
import rigctld as rig
2023-05-24 13:29:12 +00:00
rigctld_ip = data[2]
rigctld_port = data[3]
elif radiocontrol == "tci":
import tci as rig
rigctld_ip = data[22]
rigctld_port = data[23]
2023-02-09 20:56:20 +00:00
else:
import rigdummy as rig
2023-05-24 13:29:12 +00:00
rigctld_ip = '127.0.0.1'
rigctld_port = '0'
2023-02-09 20:56:20 +00:00
hamlib = rig.radio()
hamlib.open_rig(
rigctld_ip=rigctld_ip,
rigctld_port=rigctld_port,
)
2022-05-09 00:41:49 +00:00
2023-02-09 20:56:20 +00:00
# hamlib_version = rig.hamlib_version
2022-05-09 00:41:49 +00:00
2023-02-09 20:56:20 +00:00
hamlib.set_ptt(True)
#Allow a little time for network based rig to register PTT is active
2023-05-24 13:29:12 +00:00
time.sleep(.250)
2023-02-09 20:56:20 +00:00
if hamlib.get_ptt():
self.log.info("[DMN] Hamlib PTT", status="SUCCESS")
response = {"command": "test_hamlib", "result": "SUCCESS"}
else:
self.log.warning("[DMN] Hamlib PTT", status="NO SUCCESS")
response = {"command": "test_hamlib", "result": "NOSUCCESS"}
2023-02-09 20:56:20 +00:00
hamlib.set_ptt(False)
hamlib.close_rig()
2023-02-09 20:56:20 +00:00
jsondata = json.dumps(response)
sock.SOCKET_QUEUE.put(jsondata)
2022-05-09 00:41:49 +00:00
def start_rigctld(self, data):
2023-10-15 07:32:44 +00:00
# Seems to be working on Win
"""
data[0] START_RIGCTLD,
data[1] hamlib_deviceid,
data[2] hamlib_deviceport,
data[3] hamlib_stop_bits,
data[4] hamlib_data_bits,
data[5] hamlib_handshake,
data[6] hamlib_serialspeed,
data[7] hamlib_dtrstate,
data[8] hamlib_pttprotocol,
data[9] hamlib_ptt_port,
data[10] hamlib_dcd,
data[11] hamlbib_serialspeed_ptt,
data[12] hamlib_rigctld_port,
data[13] hamlib_rigctld_ip,
data[14] hamlib_rigctld_path,
data[15] hamlib_rigctld_server_port,
data[16] hamlib_rigctld_custom_args
"""
try:
command = []
isWin = False
if sys.platform in ["darwin"]:
if data[14] not in [""]:
# hamlib_rigctld_path
application_path = data[14]
else:
application_path = "rigctld"
command.append(f'{application_path}')
elif sys.platform in ["linux", "darwin"]:
if data[14] not in [""]:
# hamlib_rigctld_path
application_path = data[14]
else:
application_path = "rigctld"
command.append(f'{application_path}')
elif sys.platform in ["win32", "win64"]:
isWin=True
2023-10-15 07:56:26 +00:00
if data[13].lower() == "localhost":
2023-10-15 07:32:44 +00:00
data[13]="127.0.0.1"
if data[14] not in [""]:
# hamlib_rigctld_path
application_path = data[14]
else:
application_path = "rigctld.exe"
command.append(f'{application_path}')
options = []
# hamlib_deviceid
if data[1] not in [None, "None", "ignore"]:
2023-10-15 07:32:44 +00:00
options.append(("--model=" + data[1] ))
# hamlib_deviceport
if data[2] not in [None, "None", "ignore"]:
2023-10-15 07:32:44 +00:00
options.append(("--rig-file="+ data[2]))
# hamlib_stop_bits
if data[3] not in [None, "None", "ignore"]:
2023-10-15 07:32:44 +00:00
options.append(("--set-conf=stop_bits=" + data[3]))
# hamlib_data_bits
if data[4] not in [None, "None", "ignore"]:
2023-10-15 07:32:44 +00:00
options.append(("--set-conf=data_bits=" + data[4]))
2023-10-08 21:24:06 +00:00
# hamlib_handshake
if data[5] not in [None, "None", "ignore"]:
2023-10-15 07:32:44 +00:00
options.append(("--set-conf=serial_handshake=" + data[5]))
2023-10-08 21:24:06 +00:00
# hamlib_serialspeed
if data[6] not in [None, "None", "ignore"]:
2023-10-15 07:32:44 +00:00
options.append(("--serial-speed=" + data[6]))
# hamlib_dtrstate
if data[7] not in [None, "None", "ignore"]:
2023-10-15 07:32:44 +00:00
options.append(("--set-conf=dtr_state=" + data[7]))
2023-10-08 21:24:06 +00:00
# hamlib_pttprotocol
if data[8] not in [None, "None", "ignore"]:
2023-10-15 07:32:44 +00:00
options.append(("--ptt-type=" + data[8]))
2023-10-08 21:24:06 +00:00
# hamlib_ptt_port
if data[9] not in [None, "None", "ignore"]:
2023-10-15 07:32:44 +00:00
options.append(("--ptt-file=" + data[9]))
2023-10-08 21:24:06 +00:00
# hamlib_dcd
if data[10] not in [None, "None", "ignore"]:
2023-10-15 07:32:44 +00:00
options.append(("--dcd-type=" + data[10]))
2023-10-08 21:24:06 +00:00
# hamlbib_serialspeed_ptt
if data[11] not in [None, "None", "ignore"]:
# options.extend(("-m", data[11]))
pass
# hamlib_rigctld_port
2023-10-15 07:32:44 +00:00
# Using this ensures rigctld starts on port configured in GUI
if data[12] not in [None, "None", "ignore"]:
2023-10-15 07:32:44 +00:00
options.append(("--port="+ data[12]))
# hamlib_rigctld_ip
if data[13] not in [None, "None", "ignore"]:
2023-10-15 07:32:44 +00:00
options.append(("--listen-addr="+ data[13]))
# data[14] == hamlib_rigctld_path
# maybe at wrong place in list...
2023-10-15 07:32:44 +00:00
#Not needed for setting command line arguments
# hamlib_rigctld_server_port
2023-10-15 07:32:44 +00:00
# Ignore configured value and use value configured in GUI
#if data[15] not in [None, "None", "ignore"]:
# options.extend(("-m", data[15]))
2023-10-15 07:32:44 +00:00
# pass
# hamlib_rigctld_custom_args
if data[16] not in [None, "None", "ignore"]:
2023-10-15 07:32:44 +00:00
for o in data[16].split(" "):
options.append(o)
# append debugging paramter
2023-10-27 20:58:11 +00:00
# disabled as this could be set via gui
#options.append(("-vvv"))
command += options
self.log.info("[DMN] starting rigctld: ", param=command)
if not isWin:
2023-10-27 20:47:10 +00:00
# NOTE --> It seems Popen is non blocking, while run is blocking
2023-10-27 12:25:11 +00:00
#proc = subprocess.Popen(command, stdout=subprocess.PIPE, stderr=subprocess.PIPE, shell=True)
2023-10-27 20:47:10 +00:00
proc = subprocess.Popen(command)
#proc = subprocess.run(command, shell=False, check=True, text=True, capture_output=True)
else:
#On windows, open rigctld in new window for easier troubleshooting
proc = subprocess.Popen(command, creationflags=subprocess.CREATE_NEW_CONSOLE,close_fds=True)
Daemon.rigctldstarted = True
2023-10-11 18:26:50 +00:00
Daemon.rigctldprocess = proc
2023-10-27 20:03:11 +00:00
atexit.register(proc.kill)
except Exception as err:
self.log.warning("[DMN] err starting rigctld: ", e=err)
def start_modem(self, data):
self.log.warning("[DMN] Starting Modem", rig=data[5], port=data[6])
2023-02-09 20:56:20 +00:00
# list of parameters, necessary for running subprocess command as a list
2023-04-26 17:54:53 +00:00
options = ["--port", str(DAEMON.port - 1)]
2023-02-09 20:56:20 +00:00
# create an additional list entry for parameters not covered by gui
2023-04-26 17:54:53 +00:00
data[50] = int(DAEMON.port - 1)
2022-11-05 21:27:33 +00:00
2023-02-09 20:56:20 +00:00
options.append("--mycall")
options.extend((data[1], "--mygrid"))
options.extend((data[2], "--rx"))
options.extend((data[3], "--tx"))
options.append(data[4])
2023-02-09 20:56:20 +00:00
# if radiocontrol != disabled
# this should hopefully avoid a ton of problems if we are just running in
# disabled mode
2023-02-02 17:03:22 +00:00
2023-02-09 20:56:20 +00:00
if data[5] != "disabled":
2023-01-22 20:47:14 +00:00
2023-02-09 20:56:20 +00:00
options.append("--radiocontrol")
options.append(data[5])
2023-01-22 20:47:14 +00:00
2023-02-09 20:56:20 +00:00
if data[5] == "rigctld":
options.append("--rigctld_ip")
options.extend((data[6], "--rigctld_port"))
options.append(data[7])
2023-01-22 20:47:14 +00:00
2023-05-20 07:53:57 +00:00
if data[5] == "tci":
2023-05-24 13:29:12 +00:00
options.append("--tci-ip")
options.extend((data[22], "--tci-port"))
2023-05-20 07:53:57 +00:00
options.append(data[23])
2023-02-09 20:56:20 +00:00
if data[8] == "True":
options.append("--scatter")
2022-09-20 09:34:28 +00:00
2023-02-09 20:56:20 +00:00
if data[9] == "True":
options.append("--fft")
2023-01-22 20:47:14 +00:00
2023-02-09 20:56:20 +00:00
if data[10] == "True":
options.append("--500hz")
2023-01-22 20:47:14 +00:00
2023-02-09 20:56:20 +00:00
options.append("--tuning_range_fmin")
options.extend((data[11], "--tuning_range_fmax"))
options.extend((data[12], "--tx-audio-level"))
options.append(data[14])
2022-05-09 00:41:49 +00:00
2023-02-09 20:56:20 +00:00
if data[15] == "True":
options.append("--qrv")
2022-05-09 00:41:49 +00:00
2023-02-09 20:56:20 +00:00
options.append("--rx-buffer-size")
options.append(data[16])
2023-02-09 20:56:20 +00:00
if data[17] == "True":
options.append("--explorer")
2023-01-22 20:47:14 +00:00
2023-02-09 20:56:20 +00:00
options.append("--ssid")
options.extend(str(i) for i in data[18])
if data[19] == "True":
options.append("--tune")
2022-05-09 00:41:49 +00:00
2023-02-09 20:56:20 +00:00
if data[20] == "True":
options.append("--stats")
2023-03-04 09:59:43 +00:00
if data[13] == "True":
options.append("--fsk")
2023-03-06 11:48:27 +00:00
options.append("--tx-delay")
options.append(data[21])
2023-07-03 04:32:46 +00:00
#Mesh
if data[24] == "True":
options.append("--mesh")
2023-10-27 21:26:54 +00:00
2023-10-31 15:45:18 +00:00
options.append("--rx-audio-level")
options.append(data[25])
2023-10-31 08:53:31 +00:00
#Morse identifier
2023-10-31 15:45:18 +00:00
if data[26] == "True":
2023-10-31 08:53:31 +00:00
options.append("--morse")
2023-02-09 20:56:20 +00:00
# safe data to config file
config.write_entire_config(data)
# Try running modem from binary, else run from source
# This helps running the modem in a developer environment
2023-02-09 20:56:20 +00:00
try:
command = []
2023-02-02 22:06:47 +00:00
2023-02-09 20:56:20 +00:00
if (getattr(sys, 'frozen', False) or hasattr(sys, "_MEIPASS")) and sys.platform in ["darwin"]:
# If the application is run as a bundle, the PyInstaller bootloader
# extends the sys module by a flag frozen=True and sets the app
# path into variable _MEIPASS'.
application_path = sys._MEIPASS
command.append(f'{application_path}/freedata-modem')
2023-02-02 22:06:47 +00:00
2023-02-09 20:56:20 +00:00
elif sys.platform in ["linux", "darwin"]:
command.append("./freedata-modem")
2023-02-09 20:56:20 +00:00
elif sys.platform in ["win32", "win64"]:
command.append("freedata-modem.exe")
2023-02-09 20:56:20 +00:00
command += options
2023-05-24 13:29:12 +00:00
2023-02-09 20:56:20 +00:00
proc = subprocess.Popen(command)
2023-02-09 20:56:20 +00:00
atexit.register(proc.kill)
2022-05-09 00:41:49 +00:00
Daemon.modemprocess = proc
Daemon.modemstarted = True
2023-10-11 18:26:50 +00:00
self.log.info("[DMN] Modem started", path="binary")
2023-02-09 20:56:20 +00:00
except FileNotFoundError as err1:
2022-05-09 00:41:49 +00:00
2023-10-11 18:26:50 +00:00
try:
self.log.info("[DMN] worker: ", e=err1)
command = []
if sys.platform in ["linux", "darwin"]:
command.append("python3")
elif sys.platform in ["win32", "win64"]:
command.append("python")
command.append("main.py")
command += options
proc = subprocess.Popen(command)
atexit.register(proc.kill)
self.log.info("[DMN] Modem started", path="source")
2023-10-11 18:26:50 +00:00
Daemon.modemprocess = proc
Daemon.modemstarted = True
2023-10-11 18:26:50 +00:00
except Exception as e:
self.log.error("[DMN] Modem not started", error=e)
Daemon.modemstarted = False
if __name__ == "__main__":
mainlog = structlog.get_logger(__file__)
2022-05-23 07:37:24 +00:00
# we need to run this on Windows for multiprocessing support
2022-02-17 13:25:22 +00:00
multiprocessing.freeze_support()
# --------------------------------------------GET PARAMETER INPUTS
PARSER = argparse.ArgumentParser(description="FreeDATA Daemon")
PARSER.add_argument(
"--port",
dest="socket_port",
default=3001,
help="Socket port in the range of 1024-65535",
type=int,
)
ARGS = PARSER.parse_args()
2022-05-09 00:41:49 +00:00
2023-04-26 17:54:53 +00:00
DAEMON.port = ARGS.socket_port
2022-02-21 16:58:44 +00:00
try:
if sys.platform == "linux":
logging_path = os.getenv("HOME") + "/.config/" + "FreeDATA/" + "daemon"
2022-05-09 00:41:49 +00:00
if sys.platform == "darwin":
logging_path = (
os.getenv("HOME")
+ "/Library/"
+ "Application Support/"
+ "FreeDATA/"
+ "daemon"
)
2022-05-09 00:41:49 +00:00
if sys.platform in ["win32", "win64"]:
logging_path = os.getenv("APPDATA") + "/" + "FreeDATA/" + "daemon"
2022-05-09 00:41:49 +00:00
2022-02-21 16:58:44 +00:00
if not os.path.exists(logging_path):
os.makedirs(logging_path)
log_handler.setup_logging(logging_path)
except Exception as err:
mainlog.error("[DMN] logger init error", exception=err)
2022-09-20 09:34:28 +00:00
# init config
2022-12-10 12:34:26 +00:00
config = config.CONFIG("config.ini")
2022-09-20 09:34:28 +00:00
try:
2023-04-26 17:54:53 +00:00
mainlog.info("[DMN] Starting TCP/IP socket", port=DAEMON.port)
# https://stackoverflow.com/a/16641793
socketserver.TCPServer.allow_reuse_address = True
cmdserver = sock.ThreadedTCPServer(
(Modem.host, DAEMON.port), sock.ThreadedTCPRequestHandler
)
server_thread = threading.Thread(target=cmdserver.serve_forever)
server_thread.daemon = True
server_thread.start()
except Exception as err:
mainlog.error(
2023-04-26 17:54:53 +00:00
"[DMN] Starting TCP/IP socket failed", port=DAEMON.port, e=err
)
sys.exit(1)
2022-05-09 01:27:24 +00:00
daemon = DAEMON()
2022-05-09 00:41:49 +00:00
mainlog.info(
"[DMN] Starting FreeDATA Daemon",
author="DJ2LS",
2023-03-05 06:35:41 +00:00
year="2023",
version=Modem.version,
)
while True:
threading.Event().wait(1)