2022-05-23 00:54:12 +00:00
# -*- coding: UTF-8 -*-
2021-02-24 13:22:28 +00:00
"""
Created on Sun Dec 27 20 : 43 : 40 2020
@author : DJ2LS
"""
2022-05-11 22:10:59 +00:00
# pylint: disable=invalid-name, line-too-long, c-extension-no-member
2022-05-23 00:54:12 +00:00
# pylint: disable=import-outside-toplevel, attribute-defined-outside-init
2022-05-11 22:10:59 +00:00
2022-12-26 09:25:50 +00:00
import os
2022-05-11 22:10:59 +00:00
import base64
2021-12-19 18:45:08 +00:00
import sys
2021-02-24 13:22:28 +00:00
import threading
import time
2022-05-11 22:10:59 +00:00
import uuid
2022-12-12 14:02:57 +00:00
import lzma
2023-01-25 11:47:18 +00:00
from random import randrange
2022-05-11 22:10:59 +00:00
2022-01-04 22:02:29 +00:00
import codec2
2022-05-11 22:10:59 +00:00
import helpers
import modem
2022-05-23 00:54:12 +00:00
import numpy as np
2022-01-28 19:07:39 +00:00
import sock
2022-05-11 22:10:59 +00:00
import static
2022-05-23 00:54:12 +00:00
import structlog
import ujson as json
2022-06-24 13:22:46 +00:00
from codec2 import FREEDV_MODE
2022-06-17 23:48:47 +00:00
from exceptions import NoCallsign
2022-09-05 08:37:50 +00:00
from queues import DATA_QUEUE_RECEIVED , DATA_QUEUE_TRANSMIT , RX_BUFFER
2022-06-21 22:33:55 +00:00
from static import FRAME_TYPE as FR_TYPE
2021-09-26 15:51:11 +00:00
2022-01-07 10:25:28 +00:00
TESTMODE = False
2022-05-09 00:41:49 +00:00
2022-05-09 01:27:24 +00:00
2022-05-19 20:15:24 +00:00
class DATA :
2022-05-23 00:54:12 +00:00
""" Terminal Node Controller for FreeDATA """
2022-05-28 02:17:15 +00:00
log = structlog . get_logger ( " DATA " )
2022-05-19 20:15:24 +00:00
2022-05-23 00:54:12 +00:00
def __init__ ( self ) - > None :
# Initial call sign. Will be overwritten later
self . mycallsign = static . MYCALLSIGN
2022-12-03 12:59:05 +00:00
self . dxcallsign = static . DXCALLSIGN
2022-01-04 15:34:20 +00:00
2022-01-07 10:25:28 +00:00
self . data_queue_transmit = DATA_QUEUE_TRANSMIT
self . data_queue_received = DATA_QUEUE_RECEIVED
2022-01-04 15:34:20 +00:00
2022-09-16 15:07:58 +00:00
# length of signalling frame
2022-10-10 07:39:26 +00:00
self . length_sig0_frame = 14
self . length_sig1_frame = 14
2022-09-16 15:07:58 +00:00
2022-10-05 17:24:50 +00:00
# hold session id
self . session_id = bytes ( 1 )
2022-03-04 15:50:32 +00:00
# ------- ARQ SESSION
self . arq_file_transfer = False
self . IS_ARQ_SESSION_MASTER = False
self . arq_session_last_received = 0
self . arq_session_timeout = 30
2022-09-08 09:18:50 +00:00
self . session_connect_max_retries = 15
2022-03-04 15:50:32 +00:00
2022-10-05 18:27:38 +00:00
# actual n retries of burst
self . tx_n_retry_of_burst = 0
2022-05-23 00:54:12 +00:00
self . transmission_uuid = " "
2022-05-09 00:41:49 +00:00
2023-01-04 10:04:10 +00:00
self . burst_last_received = 0.0 # time of last "live sign" of a burst
2022-05-19 20:15:24 +00:00
self . data_channel_last_received = 0.0 # time of last "live sign" of a frame
2022-05-23 00:54:12 +00:00
self . burst_ack_snr = 0 # SNR from received burst ack frames
# Flag to indicate if we received an acknowledge frame for a burst
self . burst_ack = False
# Flag to indicate if we received an acknowledge frame for a data frame
self . data_frame_ack_received = False
# Flag to indicate if we received an request for repeater frames
self . rpt_request_received = False
2022-05-19 20:15:24 +00:00
self . rpt_request_buffer = [ ] # requested frames, saved in a list
self . rx_start_of_transmission = 0 # time of transmission start
2022-05-23 00:54:12 +00:00
# 3 bytes for the BOF Beginning of File indicator in a data frame
self . data_frame_bof = b " BOF "
# 3 bytes for the EOF End of File indicator in a data frame
self . data_frame_eof = b " EOF "
2021-09-26 15:51:11 +00:00
2022-12-24 17:07:49 +00:00
self . tx_n_max_retries_per_burst = 40
self . rx_n_max_retries_per_burst = 40
2022-02-08 14:27:34 +00:00
self . n_retries_per_burst = 0
2022-05-09 00:41:49 +00:00
2022-05-23 01:11:40 +00:00
# Flag to indicate if we recevied a low bandwidth mode channel opener
2022-05-28 15:52:05 +00:00
self . received_LOW_BANDWIDTH_MODE = False
2022-02-08 14:27:34 +00:00
2022-09-08 09:18:50 +00:00
self . data_channel_max_retries = 15
2022-05-11 22:10:59 +00:00
self . datachannel_timeout = False
2022-05-09 00:41:49 +00:00
2022-11-30 16:58:50 +00:00
# -------------- AVAILABLE MODES START-----------
# IMPORTANT: LISTS MUST BE OF EQUAL LENGTH
# --------------------- LOW BANDWIDTH
2022-05-26 01:23:30 +00:00
# List of codec2 modes to use in "low bandwidth" mode.
2022-05-23 00:54:12 +00:00
self . mode_list_low_bw = [
2022-06-24 13:22:46 +00:00
FREEDV_MODE . datac3 . value ,
2022-05-23 00:54:12 +00:00
]
2022-09-08 12:54:39 +00:00
# List for minimum SNR operating level for the corresponding mode in self.mode_list
self . snr_list_low_bw = [ 0 ]
2022-05-23 00:54:12 +00:00
# List for time to wait for corresponding mode in seconds
2022-12-01 10:15:49 +00:00
self . time_list_low_bw = [ 6 ]
2022-11-30 16:58:50 +00:00
# --------------------- HIGH BANDWIDTH
2022-02-08 14:27:34 +00:00
2022-05-26 01:23:30 +00:00
# List of codec2 modes to use in "high bandwidth" mode.
2022-05-23 00:54:12 +00:00
self . mode_list_high_bw = [
2022-06-24 13:22:46 +00:00
FREEDV_MODE . datac3 . value ,
FREEDV_MODE . datac1 . value ,
2022-05-23 00:54:12 +00:00
]
2022-09-08 12:54:39 +00:00
# List for minimum SNR operating level for the corresponding mode in self.mode_list
2022-12-09 13:55:09 +00:00
self . snr_list_high_bw = [ 0 , 3 ]
2022-05-23 00:54:12 +00:00
# List for time to wait for corresponding mode in seconds
2022-12-13 07:59:10 +00:00
# test with 6,7 --> caused sometimes a frame timeout if ack frame takes longer
# TODO: Need to check why ACK frames needs more time
self . time_list_high_bw = [ 7 , 8 ]
2022-11-30 16:58:50 +00:00
# -------------- AVAILABLE MODES END-----------
2022-05-23 00:54:12 +00:00
# Mode list for selecting between low bandwidth ( 500Hz ) and modes with higher bandwidth
# but ability to fall back to low bandwidth modes if needed.
2022-05-28 12:08:33 +00:00
if static . LOW_BANDWIDTH_MODE :
2022-05-26 01:23:30 +00:00
# List of codec2 modes to use in "low bandwidth" mode.
2022-05-23 00:54:12 +00:00
self . mode_list = self . mode_list_low_bw
# list of times to wait for corresponding mode in seconds
self . time_list = self . time_list_low_bw
2022-02-08 14:27:34 +00:00
else :
2022-05-26 01:23:30 +00:00
# List of codec2 modes to use in "high bandwidth" mode.
2022-05-23 00:54:12 +00:00
self . mode_list = self . mode_list_high_bw
# list of times to wait for corresponding mode in seconds
self . time_list = self . time_list_high_bw
2022-05-09 00:41:49 +00:00
2022-05-19 20:15:24 +00:00
self . speed_level = len ( self . mode_list ) - 1 # speed level for selecting mode
2022-02-22 20:05:48 +00:00
static . ARQ_SPEED_LEVEL = self . speed_level
2022-05-09 00:41:49 +00:00
2022-02-02 20:12:16 +00:00
self . is_IRS = False
self . burst_nack = False
self . burst_nack_counter = 0
2022-12-13 08:10:40 +00:00
self . frame_nack_counter = 0
2022-02-02 20:12:16 +00:00
self . frame_received_counter = 0
2022-05-09 00:41:49 +00:00
2022-01-07 10:44:35 +00:00
self . rx_frame_bof_received = False
self . rx_frame_eof_received = False
2021-12-26 16:52:05 +00:00
2022-10-05 18:27:38 +00:00
# TIMEOUTS
self . burst_ack_timeout_seconds = 3.0 # timeout for burst acknowledges
self . data_frame_ack_timeout_seconds = 3.0 # timeout for data frame acknowledges
self . rpt_ack_timeout_seconds = 3.0 # timeout for rpt frame acknowledges
2022-12-11 10:13:55 +00:00
self . transmission_timeout = 180 # transmission timeout in seconds
2021-02-24 13:22:28 +00:00
2022-07-02 20:14:05 +00:00
# Dictionary of functions and log messages used in process_data
# instead of a long series of if-elif-else statements.
self . rx_dispatcher = {
FR_TYPE . ARQ_DC_OPEN_ACK_N . value : (
self . arq_received_channel_is_open ,
" ARQ OPEN ACK (Narrow) " ,
) ,
FR_TYPE . ARQ_DC_OPEN_ACK_W . value : (
self . arq_received_channel_is_open ,
" ARQ OPEN ACK (Wide) " ,
) ,
FR_TYPE . ARQ_DC_OPEN_N . value : (
self . arq_received_data_channel_opener ,
" ARQ Data Channel Open (Narrow) " ,
) ,
FR_TYPE . ARQ_DC_OPEN_W . value : (
self . arq_received_data_channel_opener ,
" ARQ Data Channel Open (Wide) " ,
) ,
FR_TYPE . ARQ_SESSION_CLOSE . value : (
self . received_session_close ,
" ARQ CLOSE SESSION " ,
) ,
FR_TYPE . ARQ_SESSION_HB . value : (
self . received_session_heartbeat ,
" ARQ HEARTBEAT " ,
) ,
FR_TYPE . ARQ_SESSION_OPEN . value : (
self . received_session_opener ,
" ARQ OPEN SESSION " ,
) ,
FR_TYPE . ARQ_STOP . value : ( self . received_stop_transmission , " ARQ STOP TX " ) ,
FR_TYPE . BEACON . value : ( self . received_beacon , " BEACON " ) ,
FR_TYPE . BURST_ACK . value : ( self . burst_ack_nack_received , " BURST ACK " ) ,
FR_TYPE . BURST_NACK . value : ( self . burst_ack_nack_received , " BURST NACK " ) ,
FR_TYPE . CQ . value : ( self . received_cq , " CQ " ) ,
FR_TYPE . FR_ACK . value : ( self . frame_ack_received , " FRAME ACK " ) ,
FR_TYPE . FR_NACK . value : ( self . frame_nack_received , " FRAME NACK " ) ,
FR_TYPE . FR_REPEAT . value : ( self . burst_rpt_received , " REPEAT REQUEST " ) ,
FR_TYPE . PING_ACK . value : ( self . received_ping_ack , " PING ACK " ) ,
FR_TYPE . PING . value : ( self . received_ping , " PING " ) ,
FR_TYPE . QRV . value : ( self . received_qrv , " QRV " ) ,
}
self . command_dispatcher = {
2022-11-20 10:44:29 +00:00
#"CONNECT": (self.arq_session_handler, "CONNECT"),
2022-07-02 20:14:05 +00:00
" CQ " : ( self . transmit_cq , " CQ " ) ,
" DISCONNECT " : ( self . close_session , " DISCONNECT " ) ,
" SEND_TEST_FRAME " : ( self . send_test_frame , " TEST " ) ,
" STOP " : ( self . stop_transmission , " STOP " ) ,
}
2022-05-23 00:54:12 +00:00
# Start worker and watchdog threads
worker_thread_transmit = threading . Thread (
target = self . worker_transmit , name = " worker thread transmit " , daemon = True
)
2022-01-07 10:25:28 +00:00
worker_thread_transmit . start ( )
2022-05-09 00:41:49 +00:00
2022-05-23 00:54:12 +00:00
worker_thread_receive = threading . Thread (
target = self . worker_receive , name = " worker thread receive " , daemon = True
)
2022-01-07 10:25:28 +00:00
worker_thread_receive . start ( )
2022-05-09 00:41:49 +00:00
2022-01-07 10:25:28 +00:00
# START THE THREAD FOR THE TIMEOUT WATCHDOG
2022-05-23 00:54:12 +00:00
watchdog_thread = threading . Thread (
target = self . watchdog , name = " watchdog " , daemon = True
)
2022-01-07 10:25:28 +00:00
watchdog_thread . start ( )
2022-05-09 00:41:49 +00:00
2022-05-23 00:54:12 +00:00
arq_session_thread = threading . Thread (
target = self . heartbeat , name = " watchdog " , daemon = True
)
2022-05-09 00:41:49 +00:00
arq_session_thread . start ( )
2022-03-10 19:46:34 +00:00
self . beacon_interval = 0
2022-05-23 00:54:12 +00:00
self . beacon_thread = threading . Thread (
target = self . run_beacon , name = " watchdog " , daemon = True
)
2022-03-10 19:46:34 +00:00
self . beacon_thread . start ( )
2022-05-09 00:41:49 +00:00
2022-05-23 00:54:12 +00:00
def worker_transmit ( self ) - > None :
""" Dispatch incoming UI instructions for transmitting operations """
2022-03-04 15:50:32 +00:00
while True :
2022-01-07 10:25:28 +00:00
data = self . data_queue_transmit . get ( )
2023-01-29 11:29:36 +00:00
# if we are already in ARQ_STATE, or we're receiving codec2 traffic
# let's wait with processing data
2023-01-25 12:20:57 +00:00
# this should avoid weird toggle states where both stations
# stuck in IRS
#
# send transmission queued information once
2023-01-29 11:36:39 +00:00
if static . ARQ_STATE or static . IS_CODEC2_TRAFFIC :
2023-01-25 12:23:09 +00:00
self . log . debug ( f " [TNC] TX DISPATCHER - waiting with processing command " , arq_state = static . ARQ_STATE )
2023-01-25 12:20:57 +00:00
self . send_data_to_socket_queue (
freedata = " tnc-message " ,
2023-01-25 13:17:09 +00:00
command = data [ 0 ] ,
2023-01-25 13:17:41 +00:00
status = " queued " ,
2023-01-25 12:20:57 +00:00
)
2023-02-02 14:22:32 +00:00
# now stay in while loop until state released
while static . ARQ_STATE or static . IS_CODEC2_TRAFFIC :
threading . Event ( ) . wait ( 0.01 )
# and finally sleep some time
threading . Event ( ) . wait ( 1.0 )
2023-01-25 12:20:57 +00:00
2022-07-02 20:14:05 +00:00
# Dispatch commands known to command_dispatcher
if data [ 0 ] in self . command_dispatcher :
self . log . debug ( f " [TNC] TX { self . command_dispatcher [ data [ 0 ] ] [ 1 ] } ... " )
self . command_dispatcher [ data [ 0 ] ] [ 0 ] ( )
2022-03-04 15:50:32 +00:00
2022-07-02 20:14:05 +00:00
# Dispatch commands that need more arguments.
2022-11-20 10:44:29 +00:00
elif data [ 0 ] == " CONNECT " :
2022-12-05 15:57:45 +00:00
# [1] mycallsign
# [2] dxcallsign
# [3] attempts
2022-12-04 11:52:25 +00:00
self . arq_session_handler ( data [ 1 ] , data [ 2 ] , data [ 3 ] )
2022-11-20 10:44:29 +00:00
2022-05-23 00:54:12 +00:00
elif data [ 0 ] == " PING " :
2022-12-05 15:57:45 +00:00
# [1] mycallsign
# [2] dxcallsign
self . transmit_ping ( data [ 1 ] , data [ 2 ] )
2022-05-09 00:41:49 +00:00
2022-05-23 00:54:12 +00:00
elif data [ 0 ] == " BEACON " :
2022-01-07 10:25:28 +00:00
# [1] INTERVAL int
# [2] STATE bool
2022-03-10 19:46:34 +00:00
if data [ 2 ] :
self . beacon_interval = data [ 1 ]
static . BEACON_STATE = True
else :
static . BEACON_STATE = False
2022-05-09 00:41:49 +00:00
2022-05-23 00:54:12 +00:00
elif data [ 0 ] == " ARQ_RAW " :
2022-01-28 19:07:39 +00:00
# [1] DATA_OUT bytes
# [2] MODE int
# [3] N_FRAMES_PER_BURST int
2022-03-14 19:21:15 +00:00
# [4] self.transmission_uuid str
2022-03-19 11:42:10 +00:00
# [5] mycallsign with ssid
2022-12-04 15:12:56 +00:00
# [6] dxcallsign with ssid
# [7] attempts
2022-12-04 11:22:35 +00:00
self . open_dc_and_transmit ( data [ 1 ] , data [ 2 ] , data [ 3 ] , data [ 4 ] , data [ 5 ] , data [ 6 ] , data [ 7 ] )
2022-03-19 11:42:10 +00:00
2022-01-07 10:25:28 +00:00
else :
2022-05-23 00:54:12 +00:00
self . log . error (
" [TNC] worker_transmit: received invalid command: " , data = data
)
2022-03-04 15:50:32 +00:00
2022-05-23 00:54:12 +00:00
def worker_receive ( self ) - > None :
""" Queue received data for processing """
2022-03-04 15:50:32 +00:00
while True :
2022-01-07 10:25:28 +00:00
data = self . data_queue_received . get ( )
# [0] bytes
# [1] freedv instance
# [2] bytes_per_frame
2022-05-23 00:54:12 +00:00
self . process_data (
bytes_out = data [ 0 ] , freedv = data [ 1 ] , bytes_per_frame = data [ 2 ]
)
2022-01-07 10:25:28 +00:00
2022-05-23 00:54:12 +00:00
def process_data ( self , bytes_out , freedv , bytes_per_frame : int ) - > None :
2022-03-04 15:50:32 +00:00
"""
2022-05-23 00:54:12 +00:00
Process incoming data and decide what to do with the frame .
2022-03-04 15:50:32 +00:00
Args :
2022-05-09 00:41:49 +00:00
bytes_out :
freedv :
bytes_per_frame :
2022-03-04 15:50:32 +00:00
Returns :
"""
2022-05-23 00:54:12 +00:00
self . log . debug (
" [TNC] process_data: " , n_retries_per_burst = self . n_retries_per_burst
)
2022-05-11 22:10:59 +00:00
2022-05-23 00:54:12 +00:00
# Process data only if broadcast or we are the receiver
2022-05-09 00:41:49 +00:00
# bytes_out[1:4] == callsign check for signalling frames,
2022-04-19 09:09:11 +00:00
# bytes_out[2:5] == transmission
2022-01-24 18:42:59 +00:00
# we could also create an own function, which returns True.
2022-04-11 09:03:54 +00:00
frametype = int . from_bytes ( bytes ( bytes_out [ : 1 ] ) , " big " )
2022-10-05 17:24:50 +00:00
# check for callsign CRC
2022-04-19 09:09:11 +00:00
_valid1 , _ = helpers . check_callsign ( self . mycallsign , bytes ( bytes_out [ 1 : 4 ] ) )
_valid2 , _ = helpers . check_callsign ( self . mycallsign , bytes ( bytes_out [ 2 : 5 ] ) )
2022-10-05 17:24:50 +00:00
# check for session ID
2022-10-06 09:21:36 +00:00
# signalling frames
2022-10-05 17:24:50 +00:00
_valid3 = helpers . check_session_id ( self . session_id , bytes ( bytes_out [ 1 : 2 ] ) )
2022-10-06 09:21:36 +00:00
# arq data frames
_valid4 = helpers . check_session_id ( self . session_id , bytes ( bytes_out [ 2 : 3 ] ) )
2022-06-21 22:33:55 +00:00
if (
2022-09-08 13:47:23 +00:00
_valid1
or _valid2
2022-10-05 17:24:50 +00:00
or _valid3
2022-10-06 09:21:36 +00:00
or _valid4
2022-09-08 13:47:23 +00:00
or frametype
in [
2022-10-05 18:27:38 +00:00
FR_TYPE . CQ . value ,
FR_TYPE . QRV . value ,
FR_TYPE . PING . value ,
FR_TYPE . BEACON . value ,
]
2022-06-21 22:33:55 +00:00
) :
2022-05-09 00:41:49 +00:00
2022-01-07 10:25:28 +00:00
# CHECK IF FRAMETYPE IS BETWEEN 10 and 50 ------------------------
2022-10-05 18:27:38 +00:00
# frame = frametype - 10
# n_frames_per_burst = int.from_bytes(bytes(bytes_out[1:2]), "big")
2022-01-07 10:25:28 +00:00
2022-07-02 20:14:05 +00:00
# Dispatch activity based on received frametype
if frametype in self . rx_dispatcher :
# Process frames "known" by rx_dispatcher
2022-12-11 10:57:37 +00:00
# self.log.debug(f"[TNC] {self.rx_dispatcher[frametype][1]} RECEIVED....")
2022-07-02 20:14:05 +00:00
self . rx_dispatcher [ frametype ] [ 0 ] ( bytes_out [ : - 2 ] )
# Process frametypes requiring a different set of arguments.
elif FR_TYPE . BURST_51 . value > = frametype > = FR_TYPE . BURST_01 . value :
2022-01-07 10:25:28 +00:00
# get snr of received data
2022-05-23 00:54:12 +00:00
# FIXME: find a fix for this - after moving to classes, this no longer works
2022-05-19 20:15:24 +00:00
# snr = self.calculate_snr(freedv)
2022-01-07 10:44:35 +00:00
snr = static . SNR
2022-05-23 00:54:12 +00:00
self . log . debug ( " [TNC] RX SNR " , snr = snr )
2022-01-07 10:25:28 +00:00
# send payload data to arq checker without CRC16
2022-05-23 00:54:12 +00:00
self . arq_data_received (
bytes ( bytes_out [ : - 2 ] ) , bytes_per_frame , snr , freedv
)
2022-01-07 10:25:28 +00:00
# if we received the last frame of a burst or the last remaining rpt frame, do a modem unsync
2022-05-19 20:15:24 +00:00
# if static.RX_BURST_BUFFER.count(None) <= 1 or (frame+1) == n_frames_per_burst:
2022-05-23 00:54:12 +00:00
# self.log.debug(f"[TNC] LAST FRAME OF BURST --> UNSYNC {frame+1}/{n_frames_per_burst}")
2022-01-07 10:44:35 +00:00
# self.c_lib.freedv_set_sync(freedv, 0)
2022-01-07 10:25:28 +00:00
# TESTFRAMES
2022-06-21 22:33:55 +00:00
elif frametype == FR_TYPE . TEST_FRAME . value :
2022-05-23 00:54:12 +00:00
self . log . debug ( " [TNC] TESTFRAME RECEIVED " , frame = bytes_out [ : ] )
2022-05-09 00:41:49 +00:00
2022-05-11 22:10:59 +00:00
# Unknown frame type
2022-01-07 10:25:28 +00:00
else :
2022-07-02 20:20:51 +00:00
self . log . warning (
" [TNC] ARQ - other frame type " , frametype = FR_TYPE ( frametype ) . name
)
2021-03-12 13:14:36 +00:00
2022-01-07 10:25:28 +00:00
else :
# for debugging purposes to receive all data
2022-06-24 18:55:59 +00:00
self . log . debug (
" [TNC] Foreign frame received " ,
frame = bytes_out [ : - 2 ] . hex ( ) ,
frame_type = FR_TYPE ( int . from_bytes ( bytes_out [ : 1 ] , byteorder = " big " ) ) . name ,
)
2022-04-11 09:10:32 +00:00
2022-05-23 00:54:12 +00:00
def enqueue_frame_for_tx (
2022-09-08 13:47:23 +00:00
self ,
2022-11-07 14:14:20 +00:00
frame_to_tx , # : list[bytearray], # this causes a crash on python 3.7
2022-09-08 13:47:23 +00:00
c2_mode = FREEDV_MODE . datac0 . value ,
copies = 1 ,
repeat_delay = 0 ,
2022-05-23 00:54:12 +00:00
) - > None :
2022-03-04 15:50:32 +00:00
"""
2022-05-11 22:10:59 +00:00
Send ( transmit ) supplied frame to TNC
: param frame_to_tx : Frame data to send
2022-10-28 08:55:50 +00:00
: type frame_to_tx : list of bytearrays
2022-05-23 00:54:12 +00:00
: param c2_mode : Codec2 mode to use , defaults to 14 ( datac0 )
: type c2_mode : int , optional
2022-05-11 22:10:59 +00:00
: param copies : Number of frame copies to send , defaults to 1
: type copies : int , optional
: param repeat_delay : Delay time before sending repeat frame , defaults to 0
: type repeat_delay : int , optional
"""
2023-01-06 14:08:58 +00:00
frame_type = FR_TYPE ( int . from_bytes ( frame_to_tx [ 0 ] [ : 1 ] , byteorder = " big " ) ) . name
2023-01-06 14:03:05 +00:00
self . log . debug ( " [TNC] enqueue_frame_for_tx " , c2_mode = FREEDV_MODE ( c2_mode ) . name , data = frame_to_tx , type = frame_type )
2022-05-23 00:54:12 +00:00
# Set the TRANSMITTING flag before adding an object to the transmit queue
# TODO: This is not that nice, we could improve this somehow
2022-05-11 22:10:59 +00:00
static . TRANSMITTING = True
2022-10-28 08:55:50 +00:00
modem . MODEM_TRANSMIT_QUEUE . put ( [ c2_mode , copies , repeat_delay , frame_to_tx ] )
2022-05-23 00:54:12 +00:00
2022-05-11 22:10:59 +00:00
# Wait while transmitting
while static . TRANSMITTING :
2022-12-12 11:28:52 +00:00
threading . Event ( ) . wait ( 0.01 )
2022-03-04 15:50:32 +00:00
2022-07-04 21:09:08 +00:00
def send_data_to_socket_queue ( self , * * jsondata ) :
2022-05-30 15:41:24 +00:00
"""
Send information to the UI via JSON and the sock . SOCKET_QUEUE .
Args :
Dictionary containing the data to be sent , in the format :
key = value , for each item . E . g . :
self . send_data_to_socket_queue (
2022-06-06 18:50:36 +00:00
freedata = " tnc-message " ,
2022-05-30 15:41:24 +00:00
arq = " received " ,
2022-06-05 17:11:09 +00:00
status = " success " ,
2022-06-06 19:07:41 +00:00
uuid = self . transmission_uuid ,
2022-05-30 15:41:24 +00:00
timestamp = timestamp ,
2022-06-06 19:07:41 +00:00
mycallsign = str ( self . mycallsign , " UTF-8 " ) ,
2022-05-30 15:41:24 +00:00
dxcallsign = str ( static . DXCALLSIGN , " UTF-8 " ) ,
dxgrid = str ( static . DXGRID , " UTF-8 " ) ,
data = base64_data ,
)
"""
2022-11-30 18:35:23 +00:00
# add mycallsign and dxcallsign to network message if they not exist
# and make sure we are not overwrite them if they exist
try :
2022-12-16 16:09:48 +00:00
if " mycallsign " not in jsondata :
2022-11-30 18:35:23 +00:00
jsondata [ " mycallsign " ] = str ( self . mycallsign , " UTF-8 " )
2022-12-16 16:09:48 +00:00
if " dxcallsign " not in jsondata :
2022-11-30 18:35:23 +00:00
jsondata [ " dxcallsign " ] = str ( static . DXCALLSIGN , " UTF-8 " )
except Exception as e :
self . log . debug ( " [TNC] error adding callsigns to network message " , e = e )
2022-12-01 08:06:28 +00:00
# run json dumps
2022-05-30 15:41:24 +00:00
json_data_out = json . dumps ( jsondata )
2022-12-01 08:06:28 +00:00
self . log . debug ( " [TNC] send_data_to_socket_queue: " , jsondata = json_data_out )
# finally push data to our network queue
2022-05-30 15:41:24 +00:00
sock . SOCKET_QUEUE . put ( json_data_out )
2022-10-28 08:55:50 +00:00
def send_ident_frame ( self , transmit ) - > None :
2022-10-21 19:59:26 +00:00
""" Build and send IDENT frame """
ident_frame = bytearray ( self . length_sig1_frame )
ident_frame [ : 1 ] = bytes ( [ FR_TYPE . IDENT . value ] )
ident_frame [ 1 : self . length_sig1_frame ] = self . mycallsign
# Transmit frame
2022-10-28 08:55:50 +00:00
if transmit :
self . enqueue_frame_for_tx ( [ ident_frame ] , c2_mode = FREEDV_MODE . datac0 . value )
else :
return ident_frame
2022-10-21 19:59:26 +00:00
2022-05-23 00:54:12 +00:00
def send_burst_ack_frame ( self , snr ) - > None :
""" Build and send ACK frame for burst DATA frame """
2022-11-09 19:47:46 +00:00
2022-10-10 07:39:26 +00:00
ack_frame = bytearray ( self . length_sig1_frame )
2022-06-24 13:48:50 +00:00
ack_frame [ : 1 ] = bytes ( [ FR_TYPE . BURST_ACK . value ] )
2022-10-05 17:24:50 +00:00
ack_frame [ 1 : 2 ] = self . session_id
2022-11-09 19:47:46 +00:00
ack_frame [ 2 : 3 ] = helpers . snr_to_bytes ( snr )
2022-10-10 07:00:45 +00:00
ack_frame [ 3 : 4 ] = bytes ( [ int ( self . speed_level ) ] )
2022-05-11 22:10:59 +00:00
2022-12-29 16:57:55 +00:00
# wait while timeout not reached and our busy state is busy
channel_busy_timeout = time . time ( ) + 5
while static . CHANNEL_BUSY and time . time ( ) < channel_busy_timeout :
threading . Event ( ) . wait ( 0.01 )
2022-05-11 22:10:59 +00:00
# Transmit frame
2022-11-02 21:48:50 +00:00
self . enqueue_frame_for_tx ( [ ack_frame ] , c2_mode = FREEDV_MODE . sig1 . value )
2022-05-11 22:10:59 +00:00
2023-01-06 14:50:25 +00:00
# reset burst timeout in case we had to wait too long
self . burst_last_received = time . time ( )
2023-01-25 12:20:57 +00:00
2022-05-23 00:54:12 +00:00
def send_data_ack_frame ( self , snr ) - > None :
""" Build and send ACK frame for received DATA frame """
2022-11-09 19:47:46 +00:00
2022-10-10 07:39:26 +00:00
ack_frame = bytearray ( self . length_sig1_frame )
2022-06-21 22:33:55 +00:00
ack_frame [ : 1 ] = bytes ( [ FR_TYPE . FR_ACK . value ] )
2022-10-05 17:24:50 +00:00
ack_frame [ 1 : 2 ] = self . session_id
2022-11-09 19:47:46 +00:00
ack_frame [ 2 : 3 ] = helpers . snr_to_bytes ( snr )
2022-05-11 22:10:59 +00:00
2022-12-29 16:57:55 +00:00
# wait while timeout not reached and our busy state is busy
channel_busy_timeout = time . time ( ) + 5
while static . CHANNEL_BUSY and time . time ( ) < channel_busy_timeout :
threading . Event ( ) . wait ( 0.01 )
2022-05-11 22:10:59 +00:00
# Transmit frame
2022-10-28 09:02:23 +00:00
# TODO: Do we have to send , self.send_ident_frame(False) ?
2022-11-02 21:48:50 +00:00
# self.enqueue_frame_for_tx([ack_frame, self.send_ident_frame(False)], c2_mode=FREEDV_MODE.sig1.value, copies=3, repeat_delay=0)
2022-12-11 10:00:58 +00:00
self . enqueue_frame_for_tx ( [ ack_frame ] , c2_mode = FREEDV_MODE . sig1 . value , copies = 6 , repeat_delay = 0 )
2022-05-11 22:10:59 +00:00
2023-01-06 14:50:25 +00:00
# reset burst timeout in case we had to wait too long
self . burst_last_received = time . time ( )
2022-05-23 00:54:12 +00:00
def send_retransmit_request_frame ( self , freedv ) - > None :
2022-10-28 09:02:23 +00:00
# check where a None is in our burst buffer and do frame+1, because lists start at 0
2022-05-28 15:52:05 +00:00
# FIXME: Check to see if there's a `frame - 1` in the receive portion. Remove both if there is.
2022-05-23 00:54:12 +00:00
missing_frames = [
frame + 1
for frame , element in enumerate ( static . RX_BURST_BUFFER )
if element is None
]
2022-05-11 22:10:59 +00:00
# set n frames per burst to modem
2022-05-23 07:37:24 +00:00
# this is an idea, so it's not getting lost....
2022-05-11 22:10:59 +00:00
# we need to work on this
2022-05-19 20:15:24 +00:00
codec2 . api . freedv_set_frames_per_burst ( freedv , len ( missing_frames ) )
2022-05-11 22:10:59 +00:00
# TODO: Trim `missing_frames` bytesarray to [7:13] (6) frames, if it's larger.
2022-10-10 07:00:45 +00:00
# TODO: Instead of using int we could use a binary flag
2022-05-11 22:10:59 +00:00
# then create a repeat frame
2022-10-10 07:39:26 +00:00
rpt_frame = bytearray ( self . length_sig1_frame )
2022-06-21 22:33:55 +00:00
rpt_frame [ : 1 ] = bytes ( [ FR_TYPE . FR_REPEAT . value ] )
2022-10-05 17:24:50 +00:00
rpt_frame [ 1 : 2 ] = self . session_id
2022-05-11 22:10:59 +00:00
2022-05-23 00:54:12 +00:00
self . log . info ( " [TNC] ARQ | RX | Requesting " , frames = missing_frames )
2022-05-11 22:10:59 +00:00
# Transmit frame
2022-11-02 21:48:50 +00:00
self . enqueue_frame_for_tx ( [ rpt_frame ] , c2_mode = FREEDV_MODE . sig1 . value , copies = 1 , repeat_delay = 0 )
2022-10-10 07:39:26 +00:00
2022-11-09 19:47:46 +00:00
def send_burst_nack_frame ( self , snr : bytes ) - > None :
2022-05-23 00:54:12 +00:00
""" Build and send NACK frame for received DATA frame """
2022-11-09 19:47:46 +00:00
2022-10-10 07:39:26 +00:00
nack_frame = bytearray ( self . length_sig1_frame )
2022-06-21 22:33:55 +00:00
nack_frame [ : 1 ] = bytes ( [ FR_TYPE . FR_NACK . value ] )
2022-10-05 17:24:50 +00:00
nack_frame [ 1 : 2 ] = self . session_id
2022-11-12 11:40:32 +00:00
nack_frame [ 2 : 3 ] = helpers . snr_to_bytes ( snr )
2022-10-10 07:00:45 +00:00
nack_frame [ 3 : 4 ] = bytes ( [ int ( self . speed_level ) ] )
2022-05-11 22:10:59 +00:00
# TRANSMIT NACK FRAME FOR BURST
2022-10-28 09:03:15 +00:00
# TODO: Do we have to send ident frame?
2022-11-02 21:48:50 +00:00
# self.enqueue_frame_for_tx([ack_frame, self.send_ident_frame(False)], c2_mode=FREEDV_MODE.sig1.value, copies=3, repeat_delay=0)
2022-12-29 16:57:55 +00:00
# wait while timeout not reached and our busy state is busy
channel_busy_timeout = time . time ( ) + 5
while static . CHANNEL_BUSY and time . time ( ) < channel_busy_timeout :
threading . Event ( ) . wait ( 0.01 )
2022-12-11 11:23:37 +00:00
self . enqueue_frame_for_tx ( [ nack_frame ] , c2_mode = FREEDV_MODE . sig1 . value , copies = 6 , repeat_delay = 0 )
2023-01-06 14:50:25 +00:00
# reset burst timeout in case we had to wait too long
self . burst_last_received = time . time ( )
2023-01-25 12:20:57 +00:00
2022-11-09 19:47:46 +00:00
def send_burst_nack_frame_watchdog ( self , snr : bytes ) - > None :
2022-05-23 00:54:12 +00:00
""" Build and send NACK frame for watchdog timeout """
2022-12-13 08:10:40 +00:00
# increment nack counter for transmission stats
self . frame_nack_counter + = 1
2022-12-13 07:59:10 +00:00
# Create and send ACK frame
self . log . info ( " [TNC] ARQ | RX | SENDING NACK " )
2022-10-10 07:39:26 +00:00
nack_frame = bytearray ( self . length_sig1_frame )
2022-06-21 22:33:55 +00:00
nack_frame [ : 1 ] = bytes ( [ FR_TYPE . BURST_NACK . value ] )
2022-10-05 17:24:50 +00:00
nack_frame [ 1 : 2 ] = self . session_id
2022-11-09 19:47:46 +00:00
nack_frame [ 2 : 3 ] = helpers . snr_to_bytes ( snr )
2022-10-10 07:00:45 +00:00
nack_frame [ 3 : 4 ] = bytes ( [ int ( self . speed_level ) ] )
2022-05-11 22:10:59 +00:00
2022-12-29 16:57:55 +00:00
# wait while timeout not reached and our busy state is busy
channel_busy_timeout = time . time ( ) + 5
while static . CHANNEL_BUSY and time . time ( ) < channel_busy_timeout :
threading . Event ( ) . wait ( 0.01 )
2022-05-11 22:10:59 +00:00
# TRANSMIT NACK FRAME FOR BURST
2022-11-02 21:48:50 +00:00
self . enqueue_frame_for_tx ( [ nack_frame ] , c2_mode = FREEDV_MODE . sig1 . value , copies = 1 , repeat_delay = 0 )
2023-01-06 14:50:25 +00:00
# reset burst timeout in case we had to wait too long
self . burst_last_received = time . time ( )
2023-01-11 15:18:29 +00:00
2022-05-23 00:54:12 +00:00
def send_disconnect_frame ( self ) - > None :
""" Build and send a disconnect frame """
2022-10-10 07:39:26 +00:00
disconnection_frame = bytearray ( self . length_sig1_frame )
2022-06-21 22:33:55 +00:00
disconnection_frame [ : 1 ] = bytes ( [ FR_TYPE . ARQ_SESSION_CLOSE . value ] )
2022-10-05 17:24:50 +00:00
disconnection_frame [ 1 : 2 ] = self . session_id
2022-12-07 15:30:59 +00:00
disconnection_frame [ 2 : 5 ] = static . DXCALLSIGN_CRC
2022-10-10 07:00:45 +00:00
# TODO: Needed? disconnection_frame[7:13] = helpers.callsign_to_bytes(self.mycallsign)
2022-11-02 21:48:50 +00:00
# self.enqueue_frame_for_tx([disconnection_frame, self.send_ident_frame(False)], c2_mode=FREEDV_MODE.sig0.value, copies=5, repeat_delay=0)
2022-11-02 14:29:22 +00:00
# TODO: We need to add the ident frame feature with a seperate PR after publishing latest protocol
# TODO: We need to wait some time between last arq related signalling frame and ident frame
# TODO: Maybe about 500ms - 1500ms to avoid confusion and too much PTT toggles
2022-12-29 16:57:55 +00:00
# wait while timeout not reached and our busy state is busy
channel_busy_timeout = time . time ( ) + 5
while static . CHANNEL_BUSY and time . time ( ) < channel_busy_timeout :
threading . Event ( ) . wait ( 0.01 )
2022-11-20 15:39:42 +00:00
self . enqueue_frame_for_tx ( [ disconnection_frame ] , c2_mode = FREEDV_MODE . sig0 . value , copies = 6 , repeat_delay = 0 )
2022-05-11 22:10:59 +00:00
2022-05-23 00:54:12 +00:00
def arq_data_received (
2022-09-08 13:47:23 +00:00
self , data_in : bytes , bytes_per_frame : int , snr : float , freedv
2022-05-23 00:54:12 +00:00
) - > None :
2022-05-11 22:10:59 +00:00
"""
2022-03-04 15:50:32 +00:00
Args :
2022-05-09 00:41:49 +00:00
data_in : bytes :
bytes_per_frame : int :
2022-05-28 15:52:05 +00:00
snr : float :
2022-05-09 00:41:49 +00:00
freedv :
2022-03-04 15:50:32 +00:00
Returns :
"""
2022-07-02 20:19:33 +00:00
# We've arrived here from process_data which already checked that the frame
# is intended for this station.
2022-05-09 00:41:49 +00:00
data_in = bytes ( data_in )
2022-10-06 09:35:12 +00:00
# TODO: this seems not to work anymore
2022-03-19 11:42:10 +00:00
# get received crc for different mycall ssids
# check if callsign ssid override
2022-11-02 14:29:22 +00:00
# _, mycallsign = helpers.check_callsign(
2022-10-06 09:35:12 +00:00
# self.mycallsign, data_in[2:5]
2022-11-02 14:29:22 +00:00
# )
2022-10-06 09:35:12 +00:00
# attempt fixing this
mycallsign = self . mycallsign
2022-05-09 00:41:49 +00:00
2022-01-07 10:25:28 +00:00
# only process data if we are in ARQ and BUSY state else return to quit
2022-12-24 16:55:31 +00:00
if not static . ARQ_STATE and static . TNC_STATE not in [ " BUSY " ] :
self . log . warning ( " [TNC] wrong tnc state - dropping data " , arq_state = static . ARQ_STATE , tnc_state = static . TNC_STATE )
2022-01-07 10:25:28 +00:00
return
2022-03-04 15:50:32 +00:00
self . arq_file_transfer = True
2022-05-23 00:54:12 +00:00
static . TNC_STATE = " BUSY "
2022-01-07 10:25:28 +00:00
static . ARQ_STATE = True
2022-05-23 00:54:12 +00:00
2022-05-23 02:13:43 +00:00
# Update data_channel timestamp
2022-01-07 10:25:28 +00:00
self . data_channel_last_received = int ( time . time ( ) )
2023-01-04 10:04:10 +00:00
self . burst_last_received = int ( time . time ( ) )
2022-05-09 00:41:49 +00:00
2022-05-23 00:54:12 +00:00
# Extract some important data from the frame
# Get sequence number of burst frame
2022-10-05 18:27:38 +00:00
rx_n_frame_of_burst = int . from_bytes ( bytes ( data_in [ : 1 ] ) , " big " ) - 10
2022-05-23 00:54:12 +00:00
# Get number of bursts from received frame
2022-10-05 18:27:38 +00:00
rx_n_frames_per_burst = int . from_bytes ( bytes ( data_in [ 1 : 2 ] ) , " big " )
2022-04-11 09:10:32 +00:00
2022-05-11 22:10:59 +00:00
# The RX burst buffer needs to have a fixed length filled with "None".
# We need this later for counting the "Nones" to detect missing data.
# Check if burst buffer has expected length else create it
2022-10-05 18:27:38 +00:00
if len ( static . RX_BURST_BUFFER ) != rx_n_frames_per_burst :
static . RX_BURST_BUFFER = [ None ] * rx_n_frames_per_burst
2022-01-07 10:25:28 +00:00
2022-05-11 22:10:59 +00:00
# Append data to rx burst buffer
2022-05-23 00:54:12 +00:00
# [frame_type][n_frames_per_burst][CRC24][CRC24]
2022-10-10 07:00:45 +00:00
# static.RX_BURST_BUFFER[rx_n_frame_of_burst] = data_in[8:] # type: ignore
2022-10-06 09:21:36 +00:00
static . RX_BURST_BUFFER [ rx_n_frame_of_burst ] = data_in [ 3 : ] # type: ignore
2022-05-09 00:41:49 +00:00
2022-05-23 00:54:12 +00:00
self . log . debug ( " [TNC] static.RX_BURST_BUFFER " , buffer = static . RX_BURST_BUFFER )
2022-05-09 00:41:49 +00:00
2023-01-25 11:30:07 +00:00
static . DXGRID = b ' ------ '
2022-05-23 00:54:12 +00:00
helpers . add_to_heard_stations (
static . DXCALLSIGN ,
static . DXGRID ,
" DATA-CHANNEL " ,
snr ,
static . FREQ_OFFSET ,
static . HAMLIB_FREQUENCY ,
)
2022-05-09 00:41:49 +00:00
2022-05-11 22:10:59 +00:00
# Check if we received all frames in the burst by checking if burst buffer has no more "Nones"
# This is the ideal case because we received all data
if None not in static . RX_BURST_BUFFER :
2022-01-10 16:01:33 +00:00
# then iterate through burst buffer and stick the burst together
2022-11-02 14:29:22 +00:00
# the temp burst buffer is needed for checking, if we already received data
2022-05-23 00:54:12 +00:00
temp_burst_buffer = b " "
2022-05-11 22:10:59 +00:00
for value in static . RX_BURST_BUFFER :
2022-05-19 20:15:24 +00:00
# static.RX_FRAME_BUFFER += static.RX_BURST_BUFFER[i]
2022-05-23 00:54:12 +00:00
temp_burst_buffer + = bytes ( value ) # type: ignore
2022-01-10 16:01:33 +00:00
2023-01-01 09:56:09 +00:00
# TODO: Needs to be removed as soon as mode error is fixed
# catch possible modem error which leads into false byteorder
# modem possibly decodes too late - data then is pushed to buffer
# which leads into wrong byteorder
# Lets put this in try/except so we are not crashing tnc as its hihgly experimental
# This might only work for datac1 and datac3
try :
#area_of_interest = (modem.get_bytes_per_frame(self.mode_list[speed_level] - 1) -3) * 2
2023-01-01 15:41:27 +00:00
if static . RX_FRAME_BUFFER . endswith ( temp_burst_buffer [ : 246 ] ) and len ( temp_burst_buffer ) > = 246 :
2023-01-01 09:56:09 +00:00
self . log . warning (
" [TNC] ARQ | RX | wrong byteorder received - dropping data "
)
# we need to run a return here, so we are not sending an ACK
return
except Exception as e :
self . log . warning (
" [TNC] ARQ | RX | wrong byteorder check failed " , e = e
)
2022-01-10 16:01:33 +00:00
# if frame buffer ends not with the current frame, we are going to append new data
2022-05-23 00:54:12 +00:00
# if data already exists, we received the frame correctly,
# but the ACK frame didn't receive its destination (ISS)
2022-02-18 08:58:49 +00:00
if static . RX_FRAME_BUFFER . endswith ( temp_burst_buffer ) :
2022-05-23 00:54:12 +00:00
self . log . info (
" [TNC] ARQ | RX | Frame already received - sending ACK again "
)
2022-01-07 10:25:28 +00:00
static . RX_BURST_BUFFER = [ ]
2022-05-09 00:41:49 +00:00
2022-02-18 08:58:49 +00:00
else :
2022-05-11 22:10:59 +00:00
# Here we are going to search for our data in the last received bytes.
# This reduces the chance we will lose the entire frame in the case of signalling frame loss
2022-05-23 07:37:24 +00:00
# static.RX_FRAME_BUFFER --> existing data
2022-02-18 08:58:49 +00:00
# temp_burst_buffer --> new data
# search_area --> area where we want to search
2022-12-30 22:24:31 +00:00
2022-12-31 10:53:24 +00:00
#data_mode = self.mode_list[self.speed_level]
#payload_per_frame = modem.get_bytes_per_frame(data_mode) - 2
#search_area = payload_per_frame - 3 # (3 bytes arq frame header)
2022-12-12 09:06:45 +00:00
search_area = 510 - 3 # (3 bytes arq frame header)
2022-02-18 08:58:49 +00:00
2022-05-19 20:15:24 +00:00
search_position = len ( static . RX_FRAME_BUFFER ) - search_area
2022-02-18 09:04:00 +00:00
# find position of data. returns -1 if nothing found in area else >= 0
2022-05-23 00:54:12 +00:00
# we are beginning from the end, so if data exists twice or more,
# only the last one should be replaced
get_position = static . RX_FRAME_BUFFER [ search_position : ] . rfind (
temp_burst_buffer
)
2022-02-18 08:58:49 +00:00
# if we find data, replace it at this position with the new data and strip it
if get_position > = 0 :
2022-05-23 00:54:12 +00:00
static . RX_FRAME_BUFFER = static . RX_FRAME_BUFFER [
2022-09-08 13:47:23 +00:00
: search_position + get_position
]
2022-02-18 08:58:49 +00:00
static . RX_FRAME_BUFFER + = temp_burst_buffer
2022-05-23 00:54:12 +00:00
self . log . warning (
" [TNC] ARQ | RX | replacing existing buffer data " ,
area = search_area ,
pos = get_position ,
)
2022-05-28 15:52:05 +00:00
# If we don't find data in this range, we really have new data and going to replace it
2022-02-18 08:58:49 +00:00
else :
static . RX_FRAME_BUFFER + = temp_burst_buffer
2022-05-23 00:54:12 +00:00
self . log . debug ( " [TNC] ARQ | RX | appending data to buffer " )
2022-05-09 00:41:49 +00:00
2022-05-28 15:52:05 +00:00
# Check if we didn't receive a BOF and EOF yet to avoid sending
2022-05-23 00:54:12 +00:00
# ack frames if we already received all data
if (
2022-09-08 13:47:23 +00:00
not self . rx_frame_bof_received
and not self . rx_frame_eof_received
and data_in . find ( self . data_frame_eof ) < 0
2022-05-23 00:54:12 +00:00
) :
2022-05-09 00:41:49 +00:00
self . frame_received_counter + = 1
2022-11-30 16:58:50 +00:00
# try increasing speed level only if we had two successful decodes
2022-02-02 20:12:16 +00:00
if self . frame_received_counter > = 2 :
self . frame_received_counter = 0
2022-11-30 16:58:50 +00:00
# make sure new speed level isn't higher than available modes
new_speed_level = min ( self . speed_level + 1 , len ( self . mode_list ) - 1 )
# check if actual snr is higher than minimum snr for next mode
if static . SNR > = self . snr_list [ new_speed_level ] :
self . speed_level = new_speed_level
2022-12-01 07:51:21 +00:00
else :
self . log . info ( " [TNC] ARQ | increasing speed level not possible because of SNR limit " ,
given_snr = static . SNR ,
needed_snr = self . snr_list [ new_speed_level ]
)
2022-05-23 02:13:43 +00:00
static . ARQ_SPEED_LEVEL = self . speed_level
2022-02-02 20:12:16 +00:00
2022-05-11 22:10:59 +00:00
# Update modes we are listening to
2022-10-10 07:00:45 +00:00
self . set_listening_modes ( False , True , self . mode_list [ self . speed_level ] )
2022-02-02 20:12:16 +00:00
2022-05-11 22:10:59 +00:00
# Create and send ACK frame
2022-12-31 11:38:46 +00:00
self . log . info ( " [TNC] ARQ | RX | SENDING ACK " , finished = static . ARQ_SECONDS_UNTIL_FINISH , bytesperminute = static . ARQ_BYTES_PER_MINUTE )
2022-05-11 22:10:59 +00:00
self . send_burst_ack_frame ( snr )
# Reset n retries per burst counter
2022-04-05 09:29:20 +00:00
self . n_retries_per_burst = 0
2022-05-09 00:41:49 +00:00
2022-04-05 09:29:20 +00:00
# calculate statistics
2022-05-23 00:54:12 +00:00
self . calculate_transfer_rate_rx (
self . rx_start_of_transmission , len ( static . RX_FRAME_BUFFER )
)
2022-05-09 00:41:49 +00:00
2022-12-05 07:23:18 +00:00
# send a network message with information
self . send_data_to_socket_queue (
freedata = " tnc-message " ,
arq = " transmission " ,
status = " receiving " ,
uuid = self . transmission_uuid ,
percent = static . ARQ_TRANSMISSION_PERCENT ,
bytesperminute = static . ARQ_BYTES_PER_MINUTE ,
2023-01-25 11:35:29 +00:00
compression = static . ARQ_COMPRESSION_FACTOR ,
2022-12-05 07:23:18 +00:00
mycallsign = str ( self . mycallsign , ' UTF-8 ' ) ,
dxcallsign = str ( self . dxcallsign , ' UTF-8 ' ) ,
2022-12-31 11:38:46 +00:00
finished = static . ARQ_SECONDS_UNTIL_FINISH ,
2022-12-05 07:23:18 +00:00
)
2022-10-05 18:27:38 +00:00
elif rx_n_frame_of_burst == rx_n_frames_per_burst - 1 :
2022-05-11 22:10:59 +00:00
# We have "Nones" in our rx buffer,
# Check if we received last frame of burst - this is an indicator for missed frames.
2022-05-23 00:54:12 +00:00
# With this way of doing this, we always MUST receive the last
# frame of a burst otherwise the entire burst is lost
2022-05-28 15:52:05 +00:00
# TODO: See if a timeout on the send side with re-transmit last burst would help.
2022-05-23 00:54:12 +00:00
self . log . debug (
" [TNC] all frames in burst received: " ,
2022-10-05 18:27:38 +00:00
frame = rx_n_frame_of_burst ,
frames = rx_n_frames_per_burst ,
2022-05-23 00:54:12 +00:00
)
2022-05-11 22:10:59 +00:00
self . send_retransmit_request_frame ( freedv )
2022-05-23 00:54:12 +00:00
self . calculate_transfer_rate_rx (
self . rx_start_of_transmission , len ( static . RX_FRAME_BUFFER )
)
2022-05-09 00:41:49 +00:00
2022-05-11 22:10:59 +00:00
# Should never reach this point
2022-01-07 10:25:28 +00:00
else :
2022-05-23 00:54:12 +00:00
self . log . error (
" [TNC] data_handler: Should not reach this point... " ,
2022-10-05 18:27:38 +00:00
frame = rx_n_frame_of_burst ,
frames = rx_n_frames_per_burst ,
2022-05-23 00:54:12 +00:00
)
2022-01-24 18:42:59 +00:00
2022-01-07 10:25:28 +00:00
# We have a BOF and EOF flag in our data. If we received both we received our frame.
2022-05-19 20:37:27 +00:00
# In case of loosing data, but we received already a BOF and EOF we need to make sure, we
2022-05-09 00:41:49 +00:00
# received the complete last burst by checking it for Nones
2022-01-07 10:25:28 +00:00
bof_position = static . RX_FRAME_BUFFER . find ( self . data_frame_bof )
eof_position = static . RX_FRAME_BUFFER . find ( self . data_frame_eof )
2022-01-24 18:42:59 +00:00
2022-11-02 14:29:22 +00:00
# get total bytes per transmission information as soon we received a frame with a BOF
2022-05-09 00:41:49 +00:00
2022-05-19 20:15:24 +00:00
if bof_position > = 0 :
2022-05-23 00:54:12 +00:00
payload = static . RX_FRAME_BUFFER [
2022-09-08 13:47:23 +00:00
bof_position + len ( self . data_frame_bof ) : eof_position
]
2022-05-19 20:15:24 +00:00
frame_length = int . from_bytes ( payload [ 4 : 8 ] , " big " ) # 4:8 4bytes
2022-02-08 14:27:34 +00:00
static . TOTAL_BYTES = frame_length
2022-05-19 20:15:24 +00:00
compression_factor = int . from_bytes ( payload [ 8 : 9 ] , " big " ) # 4:8 4bytes
2022-05-23 02:13:43 +00:00
# limit to max value of 255
compression_factor = np . clip ( compression_factor , 0 , 255 )
2022-02-08 14:27:34 +00:00
static . ARQ_COMPRESSION_FACTOR = compression_factor / 10
2022-05-23 00:54:12 +00:00
self . calculate_transfer_rate_rx (
self . rx_start_of_transmission , len ( static . RX_FRAME_BUFFER )
)
if (
2022-09-08 13:47:23 +00:00
bof_position > = 0
and eof_position > 0
and None not in static . RX_BURST_BUFFER
2022-05-23 00:54:12 +00:00
) :
self . log . debug (
" [TNC] arq_data_received: " ,
bof_position = bof_position ,
eof_position = eof_position ,
)
2022-01-07 10:44:35 +00:00
self . rx_frame_bof_received = True
self . rx_frame_eof_received = True
2022-05-09 00:41:49 +00:00
2022-05-11 22:10:59 +00:00
# Extract raw data from buffer
2022-05-23 00:54:12 +00:00
payload = static . RX_FRAME_BUFFER [
2022-09-08 13:47:23 +00:00
bof_position + len ( self . data_frame_bof ) : eof_position
]
2022-05-11 22:10:59 +00:00
# Get the data frame crc
2022-05-23 00:54:12 +00:00
data_frame_crc = payload [ : 4 ] # 0:4 = 4 bytes
2022-05-11 22:10:59 +00:00
# Get the data frame length
2022-05-23 00:54:12 +00:00
frame_length = int . from_bytes ( payload [ 4 : 8 ] , " big " ) # 4:8 = 4 bytes
2022-02-08 14:27:34 +00:00
static . TOTAL_BYTES = frame_length
# 8:9 = compression factor
2022-01-07 10:25:28 +00:00
2022-02-08 14:27:34 +00:00
data_frame = payload [ 9 : ]
2022-01-24 18:42:59 +00:00
data_frame_crc_received = helpers . get_crc_32 ( data_frame )
2022-05-09 00:41:49 +00:00
2022-05-11 22:10:59 +00:00
# Check if data_frame_crc is equal with received crc
2022-01-07 10:25:28 +00:00
if data_frame_crc == data_frame_crc_received :
2022-12-13 08:10:40 +00:00
# transmittion duration
duration = time . time ( ) - self . rx_start_of_transmission
2022-12-31 12:16:10 +00:00
self . calculate_transfer_rate_rx (
self . rx_start_of_transmission , len ( static . RX_FRAME_BUFFER )
)
self . log . info ( " [TNC] ARQ | RX | DATA FRAME SUCCESSFULLY RECEIVED " , nacks = self . frame_nack_counter , bytesperminute = static . ARQ_BYTES_PER_MINUTE , total_bytes = static . TOTAL_BYTES , duration = duration )
2022-05-09 00:41:49 +00:00
2022-05-11 22:10:59 +00:00
# Decompress the data frame
2022-12-12 14:02:57 +00:00
data_frame_decompressed = lzma . decompress ( data_frame )
2022-05-23 00:54:12 +00:00
static . ARQ_COMPRESSION_FACTOR = len ( data_frame_decompressed ) / len (
data_frame
)
2022-01-07 10:25:28 +00:00
data_frame = data_frame_decompressed
2022-05-09 00:41:49 +00:00
2022-06-06 19:07:41 +00:00
self . transmission_uuid = str ( uuid . uuid4 ( ) )
2022-03-12 14:06:49 +00:00
timestamp = int ( time . time ( ) )
2022-05-09 00:41:49 +00:00
2022-05-11 22:10:59 +00:00
# Re-code data_frame in base64, UTF-8 for JSON UI communication.
2022-05-23 00:54:12 +00:00
base64_data = base64 . b64encode ( data_frame ) . decode ( " UTF-8 " )
2022-09-05 08:37:50 +00:00
2022-09-05 09:54:50 +00:00
# check if RX_BUFFER isn't full
2022-09-05 08:37:50 +00:00
if not RX_BUFFER . full ( ) :
2022-09-05 09:54:50 +00:00
# make sure we have always the correct buffer size
2022-12-07 14:41:37 +00:00
RX_BUFFER . maxsize = int ( static . RX_BUFFER_SIZE )
2022-09-05 08:37:50 +00:00
else :
# if full, free space by getting an item
self . log . info (
" [TNC] ARQ | RX | RX_BUFFER FULL - dropping old data " ,
buffer_size = RX_BUFFER . qsize ( ) ,
2022-12-05 07:43:19 +00:00
maxsize = int ( static . RX_BUFFER_SIZE )
2022-09-05 08:37:50 +00:00
)
RX_BUFFER . get ( )
# add item to RX_BUFFER
2022-09-05 09:54:50 +00:00
self . log . info (
" [TNC] ARQ | RX | saving data to rx buffer " ,
buffer_size = RX_BUFFER . qsize ( ) + 1 ,
maxsize = RX_BUFFER . maxsize
)
2022-12-05 07:43:19 +00:00
try :
RX_BUFFER . put (
[
self . transmission_uuid ,
timestamp ,
static . DXCALLSIGN ,
static . DXGRID ,
base64_data ,
]
)
except Exception as e :
# File "/usr/lib/python3.7/queue.py", line 133, in put
# if self.maxsize > 0
# TypeError: '>' not supported between instances of 'str' and 'int'
#
# Occurs on Raspberry Pi and Python 3.7
self . log . error (
2022-12-05 14:46:57 +00:00
" [TNC] ARQ | RX | error occurred when saving data! " ,
e = e ,
2022-12-26 09:25:50 +00:00
uuid = self . transmission_uuid ,
timestamp = timestamp ,
dxcall = static . DXCALLSIGN ,
dxgrid = static . DXGRID ,
data = base64_data
2022-12-05 07:43:19 +00:00
)
2022-09-05 08:37:50 +00:00
2022-12-26 09:25:50 +00:00
if static . ARQ_SAVE_TO_FOLDER :
try :
self . save_data_to_folder (
self . transmission_uuid ,
timestamp ,
mycallsign ,
static . DXCALLSIGN ,
static . DXGRID ,
data_frame
)
except Exception as e :
self . log . error (
" [TNC] ARQ | RX | can ' t save file to folder " ,
e = e ,
uuid = self . transmission_uuid ,
timestamp = timestamp ,
dxcall = static . DXCALLSIGN ,
dxgrid = static . DXGRID ,
data = base64_data
)
2022-05-30 15:41:24 +00:00
self . send_data_to_socket_queue (
2022-06-06 18:50:36 +00:00
freedata = " tnc-message " ,
2022-06-06 18:31:15 +00:00
arq = " transmission " ,
status = " received " ,
2022-06-06 19:07:41 +00:00
uuid = self . transmission_uuid ,
2022-05-30 15:41:24 +00:00
timestamp = timestamp ,
mycallsign = str ( mycallsign , " UTF-8 " ) ,
dxcallsign = str ( static . DXCALLSIGN , " UTF-8 " ) ,
dxgrid = str ( static . DXGRID , " UTF-8 " ) ,
data = base64_data ,
)
2022-05-09 00:41:49 +00:00
2022-05-23 00:54:12 +00:00
self . log . info (
" [TNC] ARQ | RX | SENDING DATA FRAME ACK " ,
snr = snr ,
crc = data_frame_crc . hex ( ) ,
)
2022-10-06 09:21:36 +00:00
2022-05-11 22:10:59 +00:00
self . send_data_ack_frame ( snr )
2022-05-23 00:54:12 +00:00
# Update statistics AFTER the frame ACK is sent
self . calculate_transfer_rate_rx (
self . rx_start_of_transmission , len ( static . RX_FRAME_BUFFER )
)
self . log . info (
" [TNC] | RX | DATACHANNEL [ "
+ str ( self . mycallsign , " UTF-8 " )
+ " ]<< >>[ "
+ str ( static . DXCALLSIGN , " UTF-8 " )
+ " ] " ,
snr = snr ,
)
2021-12-29 19:53:11 +00:00
2022-01-07 10:25:28 +00:00
else :
2022-06-05 17:11:09 +00:00
self . send_data_to_socket_queue (
2022-06-06 18:50:36 +00:00
freedata = " tnc-message " ,
2022-06-05 17:11:09 +00:00
arq = " transmission " ,
status = " failed " ,
2022-06-06 19:07:41 +00:00
uuid = self . transmission_uuid ,
2022-12-05 07:23:18 +00:00
mycallsign = str ( self . mycallsign , ' UTF-8 ' ) ,
dxcallsign = str ( self . dxcallsign , ' UTF-8 ' ) ,
2022-06-05 17:11:09 +00:00
)
2022-12-13 08:10:40 +00:00
duration = time . time ( ) - self . rx_start_of_transmission
2022-05-23 00:54:12 +00:00
self . log . warning (
2022-06-06 18:31:15 +00:00
" [TNC] ARQ | RX | DATA FRAME NOT SUCCESSFULLY RECEIVED! " ,
2022-05-23 00:54:12 +00:00
e = " wrong crc " ,
2022-06-24 13:22:46 +00:00
expected = data_frame_crc . hex ( ) ,
received = data_frame_crc_received . hex ( ) ,
2022-05-23 00:54:12 +00:00
overflows = static . BUFFER_OVERFLOW_COUNTER ,
2022-12-13 08:10:40 +00:00
nacks = self . frame_nack_counter ,
duration = duration ,
2022-12-31 10:55:41 +00:00
bytesperminute = static . ARQ_BYTES_PER_MINUTE ,
2023-01-25 11:35:29 +00:00
compression = static . ARQ_COMPRESSION_FACTOR ,
2022-12-31 10:55:41 +00:00
data = data_frame ,
2022-12-13 08:10:40 +00:00
2022-05-23 00:54:12 +00:00
)
2022-12-31 11:38:46 +00:00
self . log . info ( " [TNC] ARQ | RX | Sending NACK " , finished = static . ARQ_SECONDS_UNTIL_FINISH , bytesperminute = static . ARQ_BYTES_PER_MINUTE )
2022-05-11 22:10:59 +00:00
self . send_burst_nack_frame ( snr )
2022-05-09 00:41:49 +00:00
2022-05-23 02:13:43 +00:00
# Update arq_session timestamp
2022-05-23 00:54:12 +00:00
self . arq_session_last_received = int ( time . time ( ) )
2022-05-09 00:41:49 +00:00
2022-05-23 00:54:12 +00:00
# Finally cleanup our buffers and states,
self . arq_cleanup ( )
2022-05-09 00:41:49 +00:00
2022-05-19 20:15:24 +00:00
def arq_transmit ( self , data_out : bytes , mode : int , n_frames_per_burst : int ) :
2022-03-04 15:50:32 +00:00
"""
2022-05-23 00:54:12 +00:00
Transmit ARQ frame
2022-03-04 15:50:32 +00:00
Args :
2022-05-09 00:41:49 +00:00
data_out : bytes :
mode : int :
n_frames_per_burst : int :
2022-03-04 15:50:32 +00:00
"""
self . arq_file_transfer = True
2022-05-09 00:41:49 +00:00
2022-10-10 07:00:45 +00:00
# set signalling modes we want to listen to
# we are in an ongoing arq transmission, so we don't need sig0 actually
modem . RECEIVE_SIG0 = False
modem . RECEIVE_SIG1 = True
2022-05-19 20:15:24 +00:00
self . tx_n_retry_of_burst = 0 # retries we already sent data
2022-05-23 00:54:12 +00:00
# Maximum number of retries to send before declaring a frame is lost
2022-04-11 09:10:32 +00:00
2022-01-07 10:25:28 +00:00
# save len of data_out to TOTAL_BYTES for our statistics --> kBytes
2022-05-19 20:15:24 +00:00
# static.TOTAL_BYTES = round(len(data_out) / 1024, 2)
2022-01-24 18:42:59 +00:00
static . TOTAL_BYTES = len ( data_out )
2022-05-23 00:54:12 +00:00
frame_total_size = len ( data_out ) . to_bytes ( 4 , byteorder = " big " )
2022-05-09 00:41:49 +00:00
2023-01-23 03:31:13 +00:00
# Compress data frame
data_frame_compressed = lzma . compress ( data_out )
compression_factor = len ( data_out ) / len ( data_frame_compressed )
static . ARQ_COMPRESSION_FACTOR = np . clip ( compression_factor , 0 , 255 )
compression_factor = bytes ( [ int ( static . ARQ_COMPRESSION_FACTOR * 10 ) ] )
2022-05-30 15:41:24 +00:00
self . send_data_to_socket_queue (
2022-06-06 18:50:36 +00:00
freedata = " tnc-message " ,
2022-05-30 15:41:24 +00:00
arq = " transmission " ,
status = " transmitting " ,
uuid = self . transmission_uuid ,
percent = static . ARQ_TRANSMISSION_PERCENT ,
bytesperminute = static . ARQ_BYTES_PER_MINUTE ,
2023-01-25 11:35:29 +00:00
compression = static . ARQ_COMPRESSION_FACTOR ,
2022-12-31 11:38:46 +00:00
finished = static . ARQ_SECONDS_UNTIL_FINISH ,
2022-12-05 07:23:18 +00:00
mycallsign = str ( self . mycallsign , ' UTF-8 ' ) ,
dxcallsign = str ( self . dxcallsign , ' UTF-8 ' ) ,
2022-05-30 15:41:24 +00:00
)
2022-05-09 00:41:49 +00:00
2022-06-24 13:22:46 +00:00
self . log . info (
" [TNC] | TX | DATACHANNEL " ,
Bytes = static . TOTAL_BYTES ,
)
2022-01-05 10:38:39 +00:00
2022-05-09 00:41:49 +00:00
data_out = data_frame_compressed
2022-01-07 10:25:28 +00:00
2022-05-11 22:10:59 +00:00
# Reset data transfer statistics
2022-01-07 10:25:28 +00:00
tx_start_of_transmission = time . time ( )
self . calculate_transfer_rate_tx ( tx_start_of_transmission , 0 , len ( data_out ) )
2022-05-28 12:31:58 +00:00
# Append a crc at the beginning and end of file indicators
2022-01-24 18:42:59 +00:00
frame_payload_crc = helpers . get_crc_32 ( data_out )
2022-06-24 13:22:46 +00:00
self . log . debug ( " [TNC] frame payload CRC: " , crc = frame_payload_crc . hex ( ) )
2022-05-23 00:54:12 +00:00
# Assemble the data frame
data_out = (
2022-09-08 13:47:23 +00:00
self . data_frame_bof
+ frame_payload_crc
+ frame_total_size
+ compression_factor
+ data_out
+ self . data_frame_eof
2022-05-23 00:54:12 +00:00
)
2022-12-31 15:05:08 +00:00
self . log . debug ( " [TNC] frame raw data: " , data = data_out )
2022-05-23 00:54:12 +00:00
# Initial bufferposition is 0
2022-05-11 22:10:59 +00:00
bufferposition = bufferposition_end = 0
2022-01-05 09:59:09 +00:00
2022-05-23 00:54:12 +00:00
# Iterate through data_out buffer
2022-06-05 18:09:38 +00:00
while not self . data_frame_ack_received and static . ARQ_STATE :
2022-10-05 18:27:38 +00:00
# we have self.tx_n_max_retries_per_burst attempts for sending a burst
for self . tx_n_retry_of_burst in range ( self . tx_n_max_retries_per_burst ) :
# data_mode = mode
2022-09-05 07:04:35 +00:00
# self.log.debug("[TNC] FIXED MODE:", mode=FREEDV_MODE(data_mode).name)
2022-05-09 00:41:49 +00:00
2022-06-23 22:16:32 +00:00
# we are doing a modulo check of transmission retries of the actual burst
# every 2nd retry which fails, decreases speedlevel by 1.
# as soon as we received an ACK for the current burst, speed_level will increase
# by 1.
# The intent is to optimize speed by adapting to the current RF conditions.
# if not self.tx_n_retry_of_burst % 2 and self.tx_n_retry_of_burst > 0:
# self.speed_level = max(self.speed_level - 1, 0)
# if self.tx_n_retry_of_burst <= 1:
# self.speed_level += 1
# self.speed_level = max(self.speed_level + 1, len(self.mode_list) - 1)
# Bound speed level to:
# - minimum of either the speed or the length of mode list - 1
# - maximum of either the speed or zero
self . speed_level = min ( self . speed_level , len ( self . mode_list ) - 1 )
self . speed_level = max ( self . speed_level , 0 )
2022-09-08 13:21:45 +00:00
2022-06-23 22:16:32 +00:00
static . ARQ_SPEED_LEVEL = self . speed_level
data_mode = self . mode_list [ self . speed_level ]
2022-05-09 00:41:49 +00:00
2022-06-23 22:16:32 +00:00
self . log . debug (
" [TNC] Speed-level: " ,
level = self . speed_level ,
retry = self . tx_n_retry_of_burst ,
2022-06-24 13:22:46 +00:00
mode = FREEDV_MODE ( data_mode ) . name ,
2022-06-23 22:16:32 +00:00
)
2022-05-09 00:41:49 +00:00
2022-05-23 00:54:12 +00:00
# Payload information
2022-05-19 20:15:24 +00:00
payload_per_frame = modem . get_bytes_per_frame ( data_mode ) - 2
2022-01-07 10:25:28 +00:00
2022-05-23 00:54:12 +00:00
# Tempbuffer list for storing our data frames
2022-01-07 10:25:28 +00:00
tempbuffer = [ ]
2022-05-09 00:41:49 +00:00
2022-10-05 18:27:38 +00:00
# Append data frames with n_frames_per_burst to tempbuffer
2022-05-11 22:10:59 +00:00
# TODO: this part needs a complete rewrite!
2022-10-05 18:27:38 +00:00
# n_frames_per_burst = 1 is working
2022-05-11 22:10:59 +00:00
2022-05-19 20:15:24 +00:00
arqheader = bytearray ( )
2022-07-02 20:20:51 +00:00
# arqheader[:1] = bytes([FR_TYPE.BURST_01.value + i])
arqheader [ : 1 ] = bytes ( [ FR_TYPE . BURST_01 . value ] )
2022-10-05 18:27:38 +00:00
arqheader [ 1 : 2 ] = bytes ( [ n_frames_per_burst ] )
2022-10-05 17:24:50 +00:00
arqheader [ 2 : 3 ] = self . session_id
2022-05-09 00:41:49 +00:00
2022-05-23 00:54:12 +00:00
bufferposition_end = bufferposition + payload_per_frame - len ( arqheader )
2022-01-04 13:16:50 +00:00
2022-05-23 00:54:12 +00:00
# Normal condition
2022-01-07 10:25:28 +00:00
if bufferposition_end < = len ( data_out ) :
2022-05-19 20:15:24 +00:00
frame = data_out [ bufferposition : bufferposition_end ]
frame = arqheader + frame
2022-05-09 00:41:49 +00:00
2022-05-23 00:54:12 +00:00
# Pad the last bytes of a frame
2022-01-07 10:25:28 +00:00
else :
extended_data_out = data_out [ bufferposition : ]
2022-05-23 00:54:12 +00:00
extended_data_out + = bytes ( [ 0 ] ) * (
2022-09-08 13:47:23 +00:00
payload_per_frame - len ( extended_data_out ) - len ( arqheader )
2022-05-23 00:54:12 +00:00
)
2022-01-07 10:25:28 +00:00
frame = arqheader + extended_data_out
2022-05-09 00:41:49 +00:00
2022-05-23 00:54:12 +00:00
# Append frame to tempbuffer for transmission
2022-01-07 10:25:28 +00:00
tempbuffer . append ( frame )
2022-05-09 00:41:49 +00:00
2022-05-23 00:54:12 +00:00
self . log . debug ( " [TNC] tempbuffer: " , tempbuffer = tempbuffer )
self . log . info (
" [TNC] ARQ | TX | FRAMES " ,
2022-06-24 13:22:46 +00:00
mode = FREEDV_MODE ( data_mode ) . name ,
2022-10-05 18:27:38 +00:00
fpb = n_frames_per_burst ,
2022-05-23 00:54:12 +00:00
retry = self . tx_n_retry_of_burst ,
)
2022-05-09 00:41:49 +00:00
2022-05-29 12:42:38 +00:00
for t_buf_item in tempbuffer :
2022-10-28 08:55:50 +00:00
self . enqueue_frame_for_tx ( [ t_buf_item ] , c2_mode = data_mode )
2022-05-09 00:41:49 +00:00
2022-05-23 00:54:12 +00:00
# After transmission finished, wait for an ACK or RPT frame
2022-10-05 18:27:38 +00:00
# burstacktimeout = time.time() + self.burst_ack_timeout_seconds + 100
2022-05-23 00:54:12 +00:00
# while (not self.burst_ack and not self.burst_nack and
# not self.rpt_request_received and not self.data_frame_ack_received and
# time.time() < burstacktimeout and static.ARQ_STATE):
2022-12-12 11:28:52 +00:00
# threading.Event().wait(0.01)
2022-05-23 00:54:12 +00:00
2022-10-05 18:27:38 +00:00
# burstacktimeout = time.time() + self.burst_ack_timeout_seconds + 100
2022-05-23 00:54:12 +00:00
while static . ARQ_STATE and not (
2022-09-08 13:47:23 +00:00
self . burst_ack
or self . burst_nack
or self . rpt_request_received
or self . data_frame_ack_received
2022-05-23 00:54:12 +00:00
) :
2022-12-12 11:28:52 +00:00
threading . Event ( ) . wait ( 0.01 )
2022-05-09 00:41:49 +00:00
2022-06-24 18:55:59 +00:00
# Once we receive a burst ack, reset its state and break the RETRIES loop
2022-01-07 11:55:03 +00:00
if self . burst_ack :
2022-05-19 20:15:24 +00:00
self . burst_ack = False # reset ack state
self . tx_n_retry_of_burst = 0 # reset retries
2022-06-05 18:09:38 +00:00
self . log . debug (
" [TNC] arq_transmit: Received BURST ACK. Sending next chunk. "
2022-12-11 10:57:37 +00:00
, irs_snr = self . burst_ack_snr )
2022-05-19 20:15:24 +00:00
break # break retry loop
2022-01-05 09:59:09 +00:00
2022-02-02 20:12:16 +00:00
if self . burst_nack :
2022-05-19 20:15:24 +00:00
self . burst_nack = False # reset nack state
2022-02-02 20:12:16 +00:00
# not yet implemented
2022-01-07 10:25:28 +00:00
if self . rpt_request_received :
pass
2022-01-05 10:38:39 +00:00
2022-01-07 10:25:28 +00:00
if self . data_frame_ack_received :
2022-06-05 18:09:38 +00:00
self . log . debug (
" [TNC] arq_transmit: Received FRAME ACK. Sending next chunk. "
)
2022-05-19 20:15:24 +00:00
break # break retry loop
2022-05-09 00:41:49 +00:00
2022-05-23 00:54:12 +00:00
# We need this part for leaving the repeat loop
2022-05-26 01:23:30 +00:00
# static.ARQ_STATE == "DATA" --> when stopping transmission manually
2022-01-07 10:25:28 +00:00
if not static . ARQ_STATE :
2022-05-19 20:15:24 +00:00
# print("not ready for data...leaving loop....")
2022-06-05 18:09:38 +00:00
self . log . debug (
" [TNC] arq_transmit: ARQ State changed to FALSE. Breaking retry loop. "
)
2022-01-07 10:25:28 +00:00
break
2022-05-09 00:41:49 +00:00
2022-05-23 00:54:12 +00:00
self . calculate_transfer_rate_tx (
tx_start_of_transmission , bufferposition_end , len ( data_out )
)
2022-01-07 10:25:28 +00:00
# NEXT ATTEMPT
2022-05-23 00:54:12 +00:00
self . log . debug (
" [TNC] ATTEMPT: " ,
retry = self . tx_n_retry_of_burst ,
2022-10-05 18:27:38 +00:00
maxretries = self . tx_n_max_retries_per_burst ,
2022-05-23 00:54:12 +00:00
overflows = static . BUFFER_OVERFLOW_COUNTER ,
)
# End of FOR loop
2022-05-09 00:41:49 +00:00
2022-01-07 10:25:28 +00:00
# update buffer position
bufferposition = bufferposition_end
2021-03-12 13:14:36 +00:00
2022-04-07 09:19:29 +00:00
# update stats
2022-05-23 00:54:12 +00:00
self . calculate_transfer_rate_tx (
tx_start_of_transmission , bufferposition_end , len ( data_out )
)
2022-05-30 15:41:24 +00:00
self . send_data_to_socket_queue (
2022-06-06 18:50:36 +00:00
freedata = " tnc-message " ,
2022-05-30 15:41:24 +00:00
arq = " transmission " ,
status = " transmitting " ,
uuid = self . transmission_uuid ,
percent = static . ARQ_TRANSMISSION_PERCENT ,
bytesperminute = static . ARQ_BYTES_PER_MINUTE ,
2023-01-25 11:35:29 +00:00
compression = static . ARQ_COMPRESSION_FACTOR ,
2022-12-31 11:38:46 +00:00
finished = static . ARQ_SECONDS_UNTIL_FINISH ,
2022-11-11 11:57:14 +00:00
irs_snr = self . burst_ack_snr ,
2022-12-05 07:23:18 +00:00
mycallsign = str ( self . mycallsign , ' UTF-8 ' ) ,
dxcallsign = str ( self . dxcallsign , ' UTF-8 ' ) ,
2022-05-30 15:41:24 +00:00
)
2022-05-09 00:41:49 +00:00
2022-11-02 14:29:22 +00:00
# Stay in the while loop until we receive a data_frame_ack. Otherwise,
2022-06-05 18:09:38 +00:00
# the loop exits after sending the last frame only once and doesn't
# wait for an acknowledgement.
if self . data_frame_ack_received and bufferposition > len ( data_out ) :
self . log . debug ( " [TNC] arq_tx: Last fragment sent and acknowledged. " )
break
2022-05-19 20:15:24 +00:00
# GOING TO NEXT ITERATION
2022-05-09 00:41:49 +00:00
2022-01-07 10:25:28 +00:00
if self . data_frame_ack_received :
2022-06-09 12:11:39 +00:00
# we need to wait until sending "transmitted" state
# gui database is too slow for handling this within 0.001 seconds
# so let's sleep a little
2022-12-12 11:28:52 +00:00
threading . Event ( ) . wait ( 0.2 )
2022-05-30 15:41:24 +00:00
self . send_data_to_socket_queue (
2022-06-06 18:50:36 +00:00
freedata = " tnc-message " ,
2022-05-30 15:41:24 +00:00
arq = " transmission " ,
2022-06-05 17:11:09 +00:00
status = " transmitted " ,
2022-05-30 15:41:24 +00:00
uuid = self . transmission_uuid ,
percent = static . ARQ_TRANSMISSION_PERCENT ,
bytesperminute = static . ARQ_BYTES_PER_MINUTE ,
2023-01-25 11:35:29 +00:00
compression = static . ARQ_COMPRESSION_FACTOR ,
2022-12-31 11:38:46 +00:00
finished = static . ARQ_SECONDS_UNTIL_FINISH ,
2022-12-05 07:23:18 +00:00
mycallsign = str ( self . mycallsign , ' UTF-8 ' ) ,
dxcallsign = str ( self . dxcallsign , ' UTF-8 ' ) ,
2022-05-30 15:41:24 +00:00
)
2022-05-09 00:41:49 +00:00
2022-05-23 00:54:12 +00:00
self . log . info (
" [TNC] ARQ | TX | DATA TRANSMITTED! " ,
BytesPerMinute = static . ARQ_BYTES_PER_MINUTE ,
2022-12-27 22:32:52 +00:00
total_bytes = static . TOTAL_BYTES ,
2022-05-23 00:54:12 +00:00
BitsPerSecond = static . ARQ_BITS_PER_SECOND ,
overflows = static . BUFFER_OVERFLOW_COUNTER ,
2022-12-13 08:10:40 +00:00
2022-05-23 00:54:12 +00:00
)
2021-03-12 13:14:36 +00:00
2022-01-07 10:25:28 +00:00
else :
2022-05-30 15:41:24 +00:00
self . send_data_to_socket_queue (
2022-06-06 18:50:36 +00:00
freedata = " tnc-message " ,
2022-05-30 15:41:24 +00:00
arq = " transmission " ,
status = " failed " ,
uuid = self . transmission_uuid ,
percent = static . ARQ_TRANSMISSION_PERCENT ,
bytesperminute = static . ARQ_BYTES_PER_MINUTE ,
2023-01-25 11:35:29 +00:00
compression = static . ARQ_COMPRESSION_FACTOR ,
2022-12-05 07:23:18 +00:00
mycallsign = str ( self . mycallsign , ' UTF-8 ' ) ,
dxcallsign = str ( self . dxcallsign , ' UTF-8 ' ) ,
2022-05-30 15:41:24 +00:00
)
2022-05-09 00:41:49 +00:00
2022-05-23 00:54:12 +00:00
self . log . info (
" [TNC] ARQ | TX | TRANSMISSION FAILED OR TIME OUT! " ,
overflows = static . BUFFER_OVERFLOW_COUNTER ,
)
2022-03-10 19:46:34 +00:00
self . stop_transmission ( )
2021-03-17 10:22:06 +00:00
2022-05-23 00:54:12 +00:00
# Last but not least do a state cleanup
self . arq_cleanup ( )
if TESTMODE :
# Quit after transmission
2022-06-05 18:09:38 +00:00
self . log . debug ( " [TNC] TESTMODE: arq_transmit exiting. " )
2022-05-11 22:10:59 +00:00
sys . exit ( 0 )
2021-10-02 09:29:08 +00:00
2022-07-02 20:14:05 +00:00
def burst_ack_nack_received ( self , data_in : bytes ) - > None :
2022-03-04 15:50:32 +00:00
"""
2022-11-02 14:29:22 +00:00
Received an ACK / NACK for a transmitted frame , keep track and
2022-05-23 00:54:12 +00:00
make adjustments to speed level if needed .
2022-03-04 15:50:32 +00:00
Args :
2022-05-09 00:41:49 +00:00
data_in : bytes :
2022-03-04 15:50:32 +00:00
Returns :
"""
2022-05-23 00:54:12 +00:00
# Process data only if we are in ARQ and BUSY state
2022-01-07 10:25:28 +00:00
if static . ARQ_STATE :
2023-01-25 11:30:07 +00:00
static . DXGRID = b ' ------ '
2022-05-23 00:54:12 +00:00
helpers . add_to_heard_stations (
2023-01-25 11:30:07 +00:00
self . dxcallsign ,
2022-05-23 00:54:12 +00:00
static . DXGRID ,
" DATA-CHANNEL " ,
static . SNR ,
static . FREQ_OFFSET ,
static . HAMLIB_FREQUENCY ,
)
2022-07-02 20:14:05 +00:00
frametype = int . from_bytes ( bytes ( data_in [ : 1 ] ) , " big " )
desc = " ack "
if frametype == FR_TYPE . BURST_ACK . value :
# Increase speed level if we received a burst ack
# self.speed_level = min(self.speed_level + 1, len(self.mode_list) - 1)
2022-07-02 20:20:51 +00:00
# Force data retry loops of TX TNC to stop and continue with next frame
self . burst_ack = True
# Reset burst nack counter
self . burst_nack_counter = 0
# Reset n retries per burst counter
self . n_retries_per_burst = 0
2022-07-02 20:14:05 +00:00
else :
2022-07-02 20:20:51 +00:00
# Decrease speed level if we received a burst nack
# self.speed_level = max(self.speed_level - 1, 0)
2022-07-02 20:14:05 +00:00
# Set flag to retry frame again.
2022-07-02 20:20:51 +00:00
self . burst_nack = True
2022-07-02 20:14:05 +00:00
# Increment burst nack counter
self . burst_nack_counter + = 1
desc = " nack "
2022-05-23 02:13:43 +00:00
# Update data_channel timestamp
self . data_channel_last_received = int ( time . time ( ) )
2022-11-09 19:47:46 +00:00
# self.burst_ack_snr = int.from_bytes(bytes(data_in[2:3]), "big")
self . burst_ack_snr = helpers . snr_from_bytes ( data_in [ 2 : 3 ] )
2022-12-11 10:57:37 +00:00
# self.log.info("SNR ON IRS", snr=self.burst_ack_snr)
2022-11-09 19:47:46 +00:00
2022-10-10 07:00:45 +00:00
self . speed_level = int . from_bytes ( bytes ( data_in [ 3 : 4 ] ) , " big " )
2022-02-22 20:05:48 +00:00
static . ARQ_SPEED_LEVEL = self . speed_level
2022-07-02 20:14:05 +00:00
2022-12-11 10:57:37 +00:00
#self.log.debug(
# f"[TNC] burst_{desc}_received:",
# speed_level=self.speed_level,
# c2_mode=FREEDV_MODE(self.mode_list[self.speed_level]).name,
#)
2021-03-12 13:14:36 +00:00
2022-07-02 20:14:05 +00:00
def frame_ack_received (
2022-09-08 13:47:23 +00:00
self , data_in : bytes # pylint: disable=unused-argument
2022-07-02 20:14:05 +00:00
) - > None :
2022-05-23 00:54:12 +00:00
""" Received an ACK for a transmitted frame """
# Process data only if we are in ARQ and BUSY state
2022-05-09 00:41:49 +00:00
if static . ARQ_STATE :
2023-01-25 11:30:07 +00:00
static . DXGRID = b ' ------ '
2022-05-23 00:54:12 +00:00
helpers . add_to_heard_stations (
static . DXCALLSIGN ,
static . DXGRID ,
" DATA-CHANNEL " ,
static . SNR ,
static . FREQ_OFFSET ,
static . HAMLIB_FREQUENCY ,
)
2022-05-23 02:13:43 +00:00
# Force data loops of TNC to stop and continue with next frame
self . data_frame_ack_received = True
# Update arq_session and data_channel timestamp
self . data_channel_last_received = int ( time . time ( ) )
self . arq_session_last_received = int ( time . time ( ) )
2022-04-11 09:10:32 +00:00
2022-07-02 20:14:05 +00:00
def frame_nack_received (
2022-09-08 13:47:23 +00:00
self , data_in : bytes # pylint: disable=unused-argument
2022-07-02 20:14:05 +00:00
) - > None :
2022-03-04 15:50:32 +00:00
"""
2022-07-02 20:14:05 +00:00
Received a NACK for a transmitted frame
2022-03-04 15:50:32 +00:00
Args :
2022-05-09 00:41:49 +00:00
data_in : bytes :
2022-03-04 15:50:32 +00:00
"""
2022-12-11 12:07:56 +00:00
self . log . warning ( " [TNC] ARQ FRAME NACK RECEIVED - cleanup! " ,
arq = " transmission " ,
status = " failed " ,
uuid = self . transmission_uuid ,
percent = static . ARQ_TRANSMISSION_PERCENT ,
bytesperminute = static . ARQ_BYTES_PER_MINUTE ,
mycallsign = str ( self . mycallsign , ' UTF-8 ' ) ,
dxcallsign = str ( self . dxcallsign , ' UTF-8 ' ) ,
)
2023-01-25 11:30:07 +00:00
static . DXGRID = b ' ------ '
2022-05-23 00:54:12 +00:00
helpers . add_to_heard_stations (
static . DXCALLSIGN ,
static . DXGRID ,
" DATA-CHANNEL " ,
static . SNR ,
static . FREQ_OFFSET ,
static . HAMLIB_FREQUENCY ,
)
2022-05-30 15:41:24 +00:00
self . send_data_to_socket_queue (
2022-06-06 18:50:36 +00:00
freedata = " tnc-message " ,
2022-05-30 15:41:24 +00:00
arq = " transmission " ,
status = " failed " ,
uuid = self . transmission_uuid ,
percent = static . ARQ_TRANSMISSION_PERCENT ,
bytesperminute = static . ARQ_BYTES_PER_MINUTE ,
2023-01-25 11:35:29 +00:00
compression = static . ARQ_COMPRESSION_FACTOR ,
2022-12-05 07:23:18 +00:00
mycallsign = str ( self . mycallsign , ' UTF-8 ' ) ,
dxcallsign = str ( self . dxcallsign , ' UTF-8 ' ) ,
2022-05-30 15:41:24 +00:00
)
2022-05-23 02:13:43 +00:00
# Update data_channel timestamp
2022-05-23 00:54:12 +00:00
self . arq_session_last_received = int ( time . time ( ) )
2022-05-09 00:41:49 +00:00
2022-05-23 00:54:12 +00:00
self . arq_cleanup ( )
2022-01-04 11:11:21 +00:00
2022-05-19 20:15:24 +00:00
def burst_rpt_received ( self , data_in : bytes ) :
2022-03-04 15:50:32 +00:00
"""
2022-05-23 00:54:12 +00:00
Repeat request frame received for transmitted frame
2022-03-04 15:50:32 +00:00
Args :
2022-05-09 00:41:49 +00:00
data_in : bytes :
2022-03-04 15:50:32 +00:00
"""
2022-05-23 00:54:12 +00:00
# Only process data if we are in ARQ and BUSY state
if static . ARQ_STATE and static . TNC_STATE == " BUSY " :
2023-01-25 11:30:07 +00:00
static . DXGRID = b ' ------ '
2022-05-23 00:54:12 +00:00
helpers . add_to_heard_stations (
static . DXCALLSIGN ,
static . DXGRID ,
" DATA-CHANNEL " ,
static . SNR ,
static . FREQ_OFFSET ,
static . HAMLIB_FREQUENCY ,
)
2022-05-09 00:41:49 +00:00
2022-01-07 10:25:28 +00:00
self . rpt_request_received = True
2022-05-23 02:13:43 +00:00
# Update data_channel timestamp
self . data_channel_last_received = int ( time . time ( ) )
2022-01-07 10:25:28 +00:00
self . rpt_request_buffer = [ ]
2021-03-12 13:14:36 +00:00
2022-01-07 10:25:28 +00:00
missing_area = bytes ( data_in [ 3 : 12 ] ) # 1:9
2021-02-28 14:24:14 +00:00
2022-01-07 10:25:28 +00:00
for i in range ( 0 , 6 , 2 ) :
2022-09-08 13:47:23 +00:00
if not missing_area [ i : i + 2 ] . endswith ( b " \x00 \x00 " ) :
missing = missing_area [ i : i + 2 ]
2022-01-07 10:25:28 +00:00
self . rpt_request_buffer . insert ( 0 , missing )
2021-03-12 13:14:36 +00:00
2022-05-28 15:52:05 +00:00
############################################################################################################
2022-03-04 15:50:32 +00:00
# ARQ SESSION HANDLER
2022-05-28 15:52:05 +00:00
############################################################################################################
2022-12-04 11:52:25 +00:00
def arq_session_handler ( self , mycallsign , dxcallsign , attempts ) - > bool :
2022-03-04 15:50:32 +00:00
"""
2022-05-26 01:23:30 +00:00
Create a session with ` static . DXCALLSIGN ` and wait until the session is open .
2022-03-04 15:50:32 +00:00
Returns :
2022-05-23 00:54:12 +00:00
True if the session was opened successfully
False if the session open request failed
2022-03-04 15:50:32 +00:00
"""
2022-11-20 10:44:29 +00:00
# override connection attempts
self . session_connect_max_retries = attempts
2022-12-04 11:52:25 +00:00
self . mycallsign = mycallsign
self . dxcallsign = dxcallsign
static . DXCALLSIGN = self . dxcallsign
static . DXCALLSIGN_CRC = helpers . get_crc_24 ( self . dxcallsign )
2022-05-23 07:37:24 +00:00
# TODO: we need to check this, maybe placing it to class init
2022-03-04 15:50:32 +00:00
self . datachannel_timeout = False
2022-05-23 00:54:12 +00:00
self . log . info (
" [TNC] SESSION [ "
+ str ( self . mycallsign , " UTF-8 " )
+ " ]>> <<[ "
2022-12-04 11:52:25 +00:00
+ str ( self . dxcallsign , " UTF-8 " )
2022-05-23 00:54:12 +00:00
+ " ] " ,
state = static . ARQ_SESSION_STATE ,
)
2022-05-09 00:41:49 +00:00
2022-11-17 23:03:18 +00:00
# Let's check if we have a busy channel
if static . CHANNEL_BUSY :
self . log . warning ( " [TNC] Channel busy, waiting until free... " )
self . send_data_to_socket_queue (
freedata = " tnc-message " ,
arq = " session " ,
status = " waiting " ,
2022-12-04 11:52:25 +00:00
mycallsign = str ( self . mycallsign , ' UTF-8 ' ) ,
dxcallsign = str ( self . dxcallsign , ' UTF-8 ' ) ,
2022-11-17 23:03:18 +00:00
)
# wait while timeout not reached and our busy state is busy
2022-12-30 20:29:22 +00:00
channel_busy_timeout = time . time ( ) + 15
2022-11-17 23:03:18 +00:00
while static . CHANNEL_BUSY and time . time ( ) < channel_busy_timeout :
2022-12-12 11:28:52 +00:00
threading . Event ( ) . wait ( 0.01 )
2022-11-17 23:03:18 +00:00
# if channel busy timeout reached stop connecting
if time . time ( ) > channel_busy_timeout :
self . log . warning ( " [TNC] Channel busy, try again later... " )
static . ARQ_SESSION_STATE = " failed "
self . send_data_to_socket_queue (
freedata = " tnc-message " ,
arq = " session " ,
status = " failed " ,
2022-12-04 12:04:29 +00:00
reason = " busy " ,
2022-12-04 11:52:25 +00:00
mycallsign = str ( self . mycallsign , ' UTF-8 ' ) ,
dxcallsign = str ( self . dxcallsign , ' UTF-8 ' ) ,
2022-11-17 23:03:18 +00:00
)
return False
2022-05-23 00:54:12 +00:00
self . open_session ( )
2022-03-04 15:50:32 +00:00
# wait until data channel is open
while not static . ARQ_SESSION and not self . arq_session_timeout :
2022-12-12 11:28:52 +00:00
threading . Event ( ) . wait ( 0.01 )
2022-05-23 00:54:12 +00:00
static . ARQ_SESSION_STATE = " connecting "
2022-06-15 08:40:54 +00:00
self . send_data_to_socket_queue (
freedata = " tnc-message " ,
arq = " session " ,
status = " connecting " ,
2022-12-04 11:52:25 +00:00
mycallsign = str ( self . mycallsign , ' UTF-8 ' ) ,
dxcallsign = str ( self . dxcallsign , ' UTF-8 ' ) ,
2022-06-15 08:40:54 +00:00
)
2022-05-23 00:54:12 +00:00
if static . ARQ_SESSION and static . ARQ_SESSION_STATE == " connected " :
2022-05-26 01:23:30 +00:00
# static.ARQ_SESSION_STATE = "connected"
2022-06-15 08:40:54 +00:00
self . send_data_to_socket_queue (
freedata = " tnc-message " ,
arq = " session " ,
status = " connected " ,
2022-12-04 11:52:25 +00:00
mycallsign = str ( self . mycallsign , ' UTF-8 ' ) ,
dxcallsign = str ( self . dxcallsign , ' UTF-8 ' ) ,
2022-06-15 08:40:54 +00:00
)
2022-03-04 15:50:32 +00:00
return True
2022-05-11 22:10:59 +00:00
2022-11-20 17:34:45 +00:00
self . log . warning (
" [TNC] SESSION FAILED [ "
+ str ( self . mycallsign , " UTF-8 " )
+ " ]>>X<<[ "
2022-12-04 11:52:25 +00:00
+ str ( self . dxcallsign , " UTF-8 " )
2022-11-20 17:34:45 +00:00
+ " ] " ,
2022-11-20 17:37:44 +00:00
attempts = self . session_connect_max_retries , # Adjust for 0-based for user display
2022-11-20 17:34:45 +00:00
reason = " maximum connection attempts reached " ,
state = static . ARQ_SESSION_STATE ,
)
2022-05-23 00:54:12 +00:00
static . ARQ_SESSION_STATE = " failed "
2022-06-15 08:40:54 +00:00
self . send_data_to_socket_queue (
freedata = " tnc-message " ,
arq = " session " ,
status = " failed " ,
reason = " timeout " ,
2022-12-04 11:52:25 +00:00
mycallsign = str ( self . mycallsign , ' UTF-8 ' ) ,
dxcallsign = str ( self . dxcallsign , ' UTF-8 ' ) ,
2022-06-15 08:40:54 +00:00
)
2022-05-11 22:10:59 +00:00
return False
2022-03-04 15:50:32 +00:00
2022-05-23 00:54:12 +00:00
def open_session ( self ) - > bool :
2022-03-04 15:50:32 +00:00
"""
2022-05-23 00:54:12 +00:00
Create and send the frame to request a connection .
2022-03-04 15:50:32 +00:00
Returns :
2022-05-23 00:54:12 +00:00
True if the session was opened successfully
False if the session open request failed
2022-03-04 15:50:32 +00:00
"""
self . IS_ARQ_SESSION_MASTER = True
2022-05-23 00:54:12 +00:00
static . ARQ_SESSION_STATE = " connecting "
2022-03-04 15:50:32 +00:00
2022-10-05 17:24:50 +00:00
# create a random session id
2022-11-07 14:14:20 +00:00
self . session_id = np . random . bytes ( 1 )
2022-10-05 17:24:50 +00:00
2022-10-10 07:39:26 +00:00
connection_frame = bytearray ( self . length_sig0_frame )
2022-06-21 22:33:55 +00:00
connection_frame [ : 1 ] = bytes ( [ FR_TYPE . ARQ_SESSION_OPEN . value ] )
2022-10-05 17:24:50 +00:00
connection_frame [ 1 : 2 ] = self . session_id
2022-10-12 05:40:39 +00:00
connection_frame [ 2 : 5 ] = static . DXCALLSIGN_CRC
connection_frame [ 5 : 8 ] = static . MYCALLSIGN_CRC
connection_frame [ 8 : 14 ] = helpers . callsign_to_bytes ( self . mycallsign )
2022-05-09 00:41:49 +00:00
2022-03-04 15:50:32 +00:00
while not static . ARQ_SESSION :
2022-12-12 11:28:52 +00:00
threading . Event ( ) . wait ( 0.01 )
2022-05-23 02:13:43 +00:00
for attempt in range ( self . session_connect_max_retries ) :
2022-05-23 00:54:12 +00:00
self . log . info (
" [TNC] SESSION [ "
+ str ( self . mycallsign , " UTF-8 " )
+ " ]>>?<<[ "
2022-12-04 11:52:25 +00:00
+ str ( self . dxcallsign , " UTF-8 " )
2022-05-23 00:54:12 +00:00
+ " ] " ,
2022-12-27 17:17:12 +00:00
a = f " { str ( attempt + 1 ) } / { str ( self . session_connect_max_retries ) } " ,
2022-05-23 00:54:12 +00:00
state = static . ARQ_SESSION_STATE ,
)
2022-05-09 00:41:49 +00:00
2022-12-01 08:50:44 +00:00
self . send_data_to_socket_queue (
freedata = " tnc-message " ,
arq = " session " ,
status = " connecting " ,
2022-12-01 09:09:44 +00:00
attempt = attempt + 1 ,
maxattempts = self . session_connect_max_retries ,
2022-12-04 11:52:25 +00:00
mycallsign = str ( self . mycallsign , ' UTF-8 ' ) ,
dxcallsign = str ( self . dxcallsign , ' UTF-8 ' ) ,
2022-12-01 08:50:44 +00:00
)
2022-10-28 08:55:50 +00:00
self . enqueue_frame_for_tx ( [ connection_frame ] , c2_mode = FREEDV_MODE . datac0 . value , copies = 1 , repeat_delay = 0 )
2022-05-09 00:41:49 +00:00
2022-05-23 00:54:12 +00:00
# Wait for a time, looking to see if `static.ARQ_SESSION`
# indicates we've received a positive response from the far station.
2022-05-09 00:41:49 +00:00
timeout = time . time ( ) + 3
while time . time ( ) < timeout :
2022-12-12 11:28:52 +00:00
threading . Event ( ) . wait ( 0.01 )
2022-05-23 00:54:12 +00:00
# Stop waiting if data channel is opened
2022-03-04 15:50:32 +00:00
if static . ARQ_SESSION :
2022-04-24 15:05:11 +00:00
return True
2022-11-17 13:55:20 +00:00
# Stop waiting and interrupt if data channel is getting closed while opening
if static . ARQ_SESSION_STATE == " disconnecting " :
2022-11-20 15:39:42 +00:00
# disabled this session close as its called twice
# self.close_session()
2022-11-17 13:55:20 +00:00
return False
2022-04-24 15:05:11 +00:00
# Session connect timeout, send close_session frame to
2022-05-28 12:31:58 +00:00
# attempt to clean up the far-side, if it received the
2022-04-24 15:05:11 +00:00
# open_session frame and can still hear us.
if not static . ARQ_SESSION :
self . close_session ( )
return False
2022-05-09 00:41:49 +00:00
2022-05-23 00:54:12 +00:00
# Given the while condition, it will only exit when `static.ARQ_SESSION` is True
2022-12-01 08:50:44 +00:00
self . send_data_to_socket_queue (
freedata = " tnc-message " ,
arq = " session " ,
status = " connected " ,
2022-12-04 11:52:25 +00:00
mycallsign = str ( self . mycallsign , ' UTF-8 ' ) ,
dxcallsign = str ( self . dxcallsign , ' UTF-8 ' ) ,
2022-12-01 08:50:44 +00:00
)
2022-05-23 00:54:12 +00:00
return True
def received_session_opener ( self , data_in : bytes ) - > None :
2022-03-04 15:50:32 +00:00
"""
2022-05-23 00:54:12 +00:00
Received a session open request packet .
2022-03-04 15:50:32 +00:00
Args :
2022-05-09 00:41:49 +00:00
data_in : bytes :
2022-03-04 15:50:32 +00:00
"""
2022-12-04 15:56:12 +00:00
# if we don't want to respond to calls, return False
if not static . RESPOND_TO_CALL :
return False
2022-12-29 18:16:47 +00:00
# ignore channel opener if already in ARQ STATE
# use case: Station A is connecting to Station B while
# Station B already tries connecting to Station A.
# For avoiding ignoring repeated connect request in case of packet loss
# we are only ignoring packets in case we are ISS
2022-12-29 22:27:16 +00:00
if static . ARQ_SESSION and self . IS_ARQ_SESSION_MASTER :
2022-12-29 18:16:47 +00:00
return False
2022-03-04 15:50:32 +00:00
self . IS_ARQ_SESSION_MASTER = False
2022-05-23 00:54:12 +00:00
static . ARQ_SESSION_STATE = " connecting "
2022-03-04 15:50:32 +00:00
2022-05-23 02:13:43 +00:00
# Update arq_session timestamp
2022-03-04 15:50:32 +00:00
self . arq_session_last_received = int ( time . time ( ) )
2022-10-12 05:40:39 +00:00
self . session_id = bytes ( data_in [ 1 : 2 ] )
static . DXCALLSIGN_CRC = bytes ( data_in [ 5 : 8 ] )
2022-12-03 12:59:05 +00:00
self . dxcallsign = helpers . bytes_to_callsign ( bytes ( data_in [ 8 : 14 ] ) )
static . DXCALLSIGN = self . dxcallsign
2022-05-09 00:41:49 +00:00
2022-12-07 15:30:59 +00:00
# check if callsign ssid override
valid , mycallsign = helpers . check_callsign ( self . mycallsign , data_in [ 2 : 5 ] )
self . mycallsign = mycallsign
2023-01-25 11:30:07 +00:00
static . DXGRID = b ' ------ '
2022-05-23 00:54:12 +00:00
helpers . add_to_heard_stations (
static . DXCALLSIGN ,
static . DXGRID ,
" DATA-CHANNEL " ,
static . SNR ,
static . FREQ_OFFSET ,
static . HAMLIB_FREQUENCY ,
)
self . log . info (
" [TNC] SESSION [ "
+ str ( self . mycallsign , " UTF-8 " )
+ " ]>>|<<[ "
2022-12-03 12:59:05 +00:00
+ str ( self . dxcallsign , " UTF-8 " )
2022-05-23 00:54:12 +00:00
+ " ] " ,
state = static . ARQ_SESSION_STATE ,
)
2022-03-04 15:50:32 +00:00
static . ARQ_SESSION = True
2022-05-23 00:54:12 +00:00
static . TNC_STATE = " BUSY "
2022-03-04 15:50:32 +00:00
2022-12-01 08:50:44 +00:00
self . send_data_to_socket_queue (
freedata = " tnc-message " ,
arq = " session " ,
2022-12-04 12:04:29 +00:00
status = " connected " ,
2022-12-04 11:52:25 +00:00
mycallsign = str ( self . mycallsign , ' UTF-8 ' ) ,
dxcallsign = str ( self . dxcallsign , ' UTF-8 ' ) ,
2022-12-01 08:50:44 +00:00
)
2022-03-04 15:50:32 +00:00
self . transmit_session_heartbeat ( )
2022-05-23 00:54:12 +00:00
def close_session ( self ) - > None :
""" Close the ARQ session """
static . ARQ_SESSION_STATE = " disconnecting "
2022-11-09 11:19:56 +00:00
2022-05-23 00:54:12 +00:00
self . log . info (
" [TNC] SESSION [ "
+ str ( self . mycallsign , " UTF-8 " )
+ " ]<<X>>[ "
2022-12-03 12:59:05 +00:00
+ str ( self . dxcallsign , " UTF-8 " )
2022-05-23 00:54:12 +00:00
+ " ] " ,
state = static . ARQ_SESSION_STATE ,
)
2022-06-05 17:11:09 +00:00
self . send_data_to_socket_queue (
2022-06-06 18:50:36 +00:00
freedata = " tnc-message " ,
2022-06-05 17:11:09 +00:00
arq = " session " ,
status = " close " ,
2022-12-04 12:04:29 +00:00
mycallsign = str ( self . mycallsign , ' UTF-8 ' ) ,
dxcallsign = str ( self . dxcallsign , ' UTF-8 ' ) ,
2022-06-05 17:11:09 +00:00
)
2022-03-04 15:50:32 +00:00
self . IS_ARQ_SESSION_MASTER = False
static . ARQ_SESSION = False
2022-05-09 00:41:49 +00:00
2022-10-06 09:47:19 +00:00
# we need to send disconnect frame before doing arq cleanup
2022-10-26 06:56:55 +00:00
# we would lose our session id then
2022-05-11 22:10:59 +00:00
self . send_disconnect_frame ( )
2022-10-06 09:47:19 +00:00
self . arq_cleanup ( )
2022-11-17 13:55:20 +00:00
static . ARQ_SESSION_STATE = " disconnected "
2022-05-19 20:15:24 +00:00
def received_session_close ( self , data_in : bytes ) :
2022-05-01 15:41:40 +00:00
"""
Closes the session when a close session frame is received and
the DXCALLSIGN_CRC matches the remote station participating in the session .
Args :
2022-05-09 00:41:49 +00:00
data_in : bytes :
2022-05-01 15:41:40 +00:00
"""
2022-12-23 09:30:32 +00:00
print ( static . ARQ_SESSION_STATE )
2022-07-02 20:19:33 +00:00
# We've arrived here from process_data which already checked that the frame
# is intended for this station.
# Close the session if the CRC matches the remote station in static.
2022-12-07 15:30:59 +00:00
_valid_crc , mycallsign = helpers . check_callsign ( self . mycallsign , bytes ( data_in [ 2 : 5 ] ) )
2022-10-05 18:27:38 +00:00
_valid_session = helpers . check_session_id ( self . session_id , bytes ( data_in [ 1 : 2 ] ) )
2022-12-19 20:57:57 +00:00
if ( _valid_crc or _valid_session ) and static . ARQ_SESSION_STATE not in [ " disconnected " ] :
2022-05-23 00:54:12 +00:00
static . ARQ_SESSION_STATE = " disconnected "
2023-01-25 11:30:07 +00:00
static . DXGRID = b ' ------ '
2022-05-23 00:54:12 +00:00
helpers . add_to_heard_stations (
static . DXCALLSIGN ,
static . DXGRID ,
" DATA-CHANNEL " ,
static . SNR ,
static . FREQ_OFFSET ,
static . HAMLIB_FREQUENCY ,
)
self . log . info (
" [TNC] SESSION [ "
2022-12-07 15:30:59 +00:00
+ str ( mycallsign , " UTF-8 " )
2022-05-23 00:54:12 +00:00
+ " ]<<X>>[ "
2022-12-03 12:59:05 +00:00
+ str ( self . dxcallsign , " UTF-8 " )
2022-05-23 00:54:12 +00:00
+ " ] " ,
state = static . ARQ_SESSION_STATE ,
)
2022-06-05 17:11:09 +00:00
self . send_data_to_socket_queue (
2022-06-06 18:50:36 +00:00
freedata = " tnc-message " ,
2022-06-05 17:11:09 +00:00
arq = " session " ,
status = " close " ,
2022-12-07 15:30:59 +00:00
mycallsign = str ( mycallsign , ' UTF-8 ' ) ,
2022-12-04 12:04:29 +00:00
dxcallsign = str ( self . dxcallsign , ' UTF-8 ' ) ,
2022-06-05 17:11:09 +00:00
)
2022-03-11 19:38:28 +00:00
2022-04-30 11:03:24 +00:00
self . IS_ARQ_SESSION_MASTER = False
static . ARQ_SESSION = False
self . arq_cleanup ( )
2022-03-04 15:50:32 +00:00
2022-05-23 00:54:12 +00:00
def transmit_session_heartbeat ( self ) - > None :
""" Send ARQ sesion heartbeat while connected """
2022-04-24 15:05:11 +00:00
# static.ARQ_SESSION = True
2022-05-26 01:23:30 +00:00
# static.TNC_STATE = "BUSY"
# static.ARQ_SESSION_STATE = "connected"
2022-03-04 15:50:32 +00:00
2022-10-10 07:39:26 +00:00
connection_frame = bytearray ( self . length_sig0_frame )
2022-06-21 22:33:55 +00:00
connection_frame [ : 1 ] = bytes ( [ FR_TYPE . ARQ_SESSION_HB . value ] )
2022-10-05 17:24:50 +00:00
connection_frame [ 1 : 2 ] = self . session_id
2022-03-19 11:42:10 +00:00
2022-12-01 08:50:44 +00:00
self . send_data_to_socket_queue (
freedata = " tnc-message " ,
arq = " session " ,
status = " connected " ,
heartbeat = " transmitting " ,
2022-12-04 12:04:29 +00:00
mycallsign = str ( self . mycallsign , ' UTF-8 ' ) ,
dxcallsign = str ( self . dxcallsign , ' UTF-8 ' ) ,
2022-12-01 08:50:44 +00:00
)
2022-10-28 08:55:50 +00:00
self . enqueue_frame_for_tx ( [ connection_frame ] , c2_mode = FREEDV_MODE . datac0 . value , copies = 1 , repeat_delay = 0 )
2022-10-10 07:39:26 +00:00
2022-05-23 00:54:12 +00:00
def received_session_heartbeat ( self , data_in : bytes ) - > None :
2022-03-04 15:50:32 +00:00
"""
2022-05-23 00:54:12 +00:00
Received an ARQ session heartbeat , record and update state accordingly .
2022-03-04 15:50:32 +00:00
Args :
2022-05-09 00:41:49 +00:00
data_in : bytes :
2022-03-04 15:50:32 +00:00
"""
2022-10-05 17:24:50 +00:00
# Accept session data if the DXCALLSIGN_CRC matches the station in static or session id.
2022-12-03 12:59:05 +00:00
_valid_crc , _ = helpers . check_callsign ( self . dxcallsign , bytes ( data_in [ 4 : 7 ] ) )
2022-10-05 17:24:50 +00:00
_valid_session = helpers . check_session_id ( self . session_id , bytes ( data_in [ 1 : 2 ] ) )
2022-12-19 14:42:48 +00:00
if _valid_crc or _valid_session and static . ARQ_SESSION_STATE in [ " connected " , " connecting " ] :
2022-05-23 00:54:12 +00:00
self . log . debug ( " [TNC] Received session heartbeat " )
2023-01-25 11:30:07 +00:00
static . DXGRID = b ' ------ '
2022-05-23 00:54:12 +00:00
helpers . add_to_heard_stations (
2022-12-03 12:59:05 +00:00
self . dxcallsign ,
2022-05-23 00:54:12 +00:00
static . DXGRID ,
" SESSION-HB " ,
static . SNR ,
static . FREQ_OFFSET ,
static . HAMLIB_FREQUENCY ,
)
2022-05-09 00:41:49 +00:00
2022-12-01 08:50:44 +00:00
self . send_data_to_socket_queue (
freedata = " tnc-message " ,
arq = " session " ,
status = " connected " ,
2022-12-04 12:04:29 +00:00
heartbeat = " received " ,
2022-12-04 11:52:25 +00:00
mycallsign = str ( self . mycallsign , ' UTF-8 ' ) ,
dxcallsign = str ( self . dxcallsign , ' UTF-8 ' ) ,
2022-12-01 08:50:44 +00:00
)
2022-04-30 11:03:24 +00:00
static . ARQ_SESSION = True
2022-05-23 00:54:12 +00:00
static . ARQ_SESSION_STATE = " connected "
static . TNC_STATE = " BUSY "
# Update the timeout timestamps
self . arq_session_last_received = int ( time . time ( ) )
2022-04-30 11:03:24 +00:00
self . data_channel_last_received = int ( time . time ( ) )
2022-10-26 06:56:55 +00:00
# transmit session heartbeat only
# -> if not session master
# --> this will be triggered by heartbeat watchdog
# -> if not during a file transfer
2022-12-01 08:04:11 +00:00
# -> if ARQ_SESSION_STATE != disconnecting, disconnected, failed
2022-10-26 07:05:47 +00:00
# --> to avoid heartbeat toggle loops while disconnecting
2022-10-26 06:56:55 +00:00
if (
not self . IS_ARQ_SESSION_MASTER
and not self . arq_file_transfer
and static . ARQ_SESSION_STATE != ' disconnecting '
and static . ARQ_SESSION_STATE != ' disconnected '
and static . ARQ_SESSION_STATE != ' failed '
) :
2022-04-30 11:03:24 +00:00
self . transmit_session_heartbeat ( )
2022-03-04 15:50:32 +00:00
2022-05-23 00:54:12 +00:00
##########################################################################################################
2022-03-04 15:50:32 +00:00
# ARQ DATA CHANNEL HANDLER
2022-05-23 00:54:12 +00:00
##########################################################################################################
def open_dc_and_transmit (
2022-09-08 13:47:23 +00:00
self ,
data_out : bytes ,
mode : int ,
n_frames_per_burst : int ,
transmission_uuid : str ,
mycallsign ,
2022-12-04 11:22:35 +00:00
dxcallsign ,
2022-11-20 11:02:53 +00:00
attempts : int ,
2022-05-23 00:54:12 +00:00
) - > bool :
"""
Open data channel and transmit data
2022-03-04 15:50:32 +00:00
Args :
2022-05-09 00:41:49 +00:00
data_out : bytes :
mode : int :
n_frames_per_burst : int :
2022-10-05 18:27:38 +00:00
transmission_uuid : str :
mycallsign : bytes :
2022-11-20 10:54:43 +00:00
attempts : int : Overriding number of attempts initiating a connection
2022-03-04 15:50:32 +00:00
Returns :
2022-05-23 00:54:12 +00:00
True if the data session was opened and the data was sent
False if the data session was not opened
2022-03-04 15:50:32 +00:00
"""
2022-03-24 19:49:13 +00:00
# overwrite mycallsign in case of different SSID
self . mycallsign = mycallsign
2022-12-04 11:22:35 +00:00
self . dxcallsign = dxcallsign
2022-05-09 00:41:49 +00:00
2022-11-20 10:58:15 +00:00
# override session connection attempts
self . data_channel_max_retries = attempts
2022-05-23 00:54:12 +00:00
static . TNC_STATE = " BUSY "
2022-03-04 15:50:32 +00:00
self . arq_file_transfer = True
2022-05-09 00:41:49 +00:00
2022-03-14 19:21:15 +00:00
self . transmission_uuid = transmission_uuid
2022-05-09 00:41:49 +00:00
2022-05-28 12:31:58 +00:00
# wait a moment for the case, a heartbeat is already on the way back to us
2022-10-26 06:25:47 +00:00
# this makes channel establishment more clean
2022-03-04 15:50:32 +00:00
if static . ARQ_SESSION :
2022-12-12 11:28:52 +00:00
threading . Event ( ) . wait ( 2 )
2022-05-09 00:41:49 +00:00
2022-01-24 22:29:34 +00:00
self . datachannel_timeout = False
2022-05-09 00:41:49 +00:00
2022-10-12 11:01:20 +00:00
# we need to compress data for getting a compression factor.
2022-05-28 12:31:58 +00:00
# so we are compressing twice. This is not that nice and maybe there is another way
2022-01-07 10:25:28 +00:00
# for calculating transmission statistics
2022-12-12 14:02:57 +00:00
# static.ARQ_COMPRESSION_FACTOR = len(data_out) / len(lzma.compress(data_out))
2022-05-09 00:41:49 +00:00
2022-11-20 11:03:45 +00:00
self . arq_open_data_channel ( mode , n_frames_per_burst , mycallsign )
2022-05-09 00:41:49 +00:00
2022-01-07 10:25:28 +00:00
# wait until data channel is open
2022-01-24 22:29:34 +00:00
while not static . ARQ_STATE and not self . datachannel_timeout :
2022-12-12 11:28:52 +00:00
threading . Event ( ) . wait ( 0.01 )
2022-05-09 00:41:49 +00:00
2022-01-24 22:29:34 +00:00
if static . ARQ_STATE :
self . arq_transmit ( data_out , mode , n_frames_per_burst )
2022-05-23 00:54:12 +00:00
return True
2022-05-09 00:41:49 +00:00
2022-05-23 00:54:12 +00:00
return False
def arq_open_data_channel (
2022-11-20 11:02:53 +00:00
self , mode : int , n_frames_per_burst : int , mycallsign
2022-05-23 00:54:12 +00:00
) - > bool :
2022-03-04 15:50:32 +00:00
"""
2022-05-23 00:54:12 +00:00
Open an ARQ data channel .
2022-03-04 15:50:32 +00:00
Args :
2022-05-09 00:41:49 +00:00
mode : int :
n_frames_per_burst : int :
2022-10-05 18:27:38 +00:00
mycallsign : bytes :
2022-03-04 15:50:32 +00:00
Returns :
2022-05-23 00:54:12 +00:00
True if the data channel was opened successfully
False if the data channel failed to open
2022-03-04 15:50:32 +00:00
"""
2022-05-09 00:41:49 +00:00
self . is_IRS = False
2022-05-23 00:54:12 +00:00
2022-10-05 18:27:38 +00:00
# init a new random session id if we are not in an arq session
if not static . ARQ_SESSION :
2022-11-07 14:14:20 +00:00
# self.session_id = randbytes(1)
self . session_id = np . random . bytes ( 1 )
2022-10-05 17:24:50 +00:00
2022-05-23 02:13:43 +00:00
# Update data_channel timestamp
2022-01-07 10:25:28 +00:00
self . data_channel_last_received = int ( time . time ( ) )
2022-06-19 20:45:06 +00:00
if static . LOW_BANDWIDTH_MODE :
2022-06-21 22:33:55 +00:00
frametype = bytes ( [ FR_TYPE . ARQ_DC_OPEN_N . value ] )
2022-05-23 00:54:12 +00:00
self . log . debug ( " [TNC] Requesting low bandwidth mode " )
2022-01-07 10:25:28 +00:00
2022-02-08 14:27:34 +00:00
else :
2022-06-21 22:33:55 +00:00
frametype = bytes ( [ FR_TYPE . ARQ_DC_OPEN_W . value ] )
2022-05-23 00:54:12 +00:00
self . log . debug ( " [TNC] Requesting high bandwidth mode " )
2022-01-07 10:25:28 +00:00
2022-10-10 07:39:26 +00:00
connection_frame = bytearray ( self . length_sig0_frame )
2022-05-19 20:15:24 +00:00
connection_frame [ : 1 ] = frametype
connection_frame [ 1 : 4 ] = static . DXCALLSIGN_CRC
connection_frame [ 4 : 7 ] = static . MYCALLSIGN_CRC
connection_frame [ 7 : 13 ] = helpers . callsign_to_bytes ( mycallsign )
2022-10-05 18:27:38 +00:00
# connection_frame[13:14] = bytes([n_frames_per_burst])
2022-10-05 17:24:50 +00:00
connection_frame [ 13 : 14 ] = self . session_id
2022-05-09 00:41:49 +00:00
2022-01-07 10:25:28 +00:00
while not static . ARQ_STATE :
2022-12-12 11:28:52 +00:00
threading . Event ( ) . wait ( 0.01 )
2022-05-23 00:54:12 +00:00
for attempt in range ( self . data_channel_max_retries ) :
2022-06-05 17:11:09 +00:00
self . send_data_to_socket_queue (
2022-06-06 18:50:36 +00:00
freedata = " tnc-message " ,
2022-06-05 17:11:09 +00:00
arq = " transmission " ,
status = " opening " ,
2022-12-04 11:22:35 +00:00
mycallsign = str ( mycallsign , ' UTF-8 ' ) ,
dxcallsign = str ( self . dxcallsign , ' UTF-8 ' ) ,
2022-06-05 17:11:09 +00:00
)
2022-05-23 00:54:12 +00:00
self . log . info (
" [TNC] ARQ | DATA | TX | [ "
+ str ( mycallsign , " UTF-8 " )
+ " ]>> <<[ "
2022-12-04 11:22:35 +00:00
+ str ( self . dxcallsign , " UTF-8 " )
2022-05-23 00:54:12 +00:00
+ " ] " ,
2022-09-08 13:47:23 +00:00
attempt = f " { str ( attempt + 1 ) } / { str ( self . data_channel_max_retries ) } " ,
2022-05-23 00:54:12 +00:00
)
2022-05-11 22:10:59 +00:00
2022-12-27 16:11:46 +00:00
# Let's check if we have a busy channel and if we are not in a running arq session.
if static . CHANNEL_BUSY and not static . ARQ_STATE :
self . log . warning ( " [TNC] Channel busy, waiting until free... " )
self . send_data_to_socket_queue (
freedata = " tnc-message " ,
arq = " transmission " ,
status = " waiting " ,
mycallsign = str ( self . mycallsign , ' UTF-8 ' ) ,
dxcallsign = str ( self . dxcallsign , ' UTF-8 ' ) ,
)
# wait while timeout not reached and our busy state is busy
2023-01-04 10:23:30 +00:00
channel_busy_timeout = time . time ( ) + 10
2022-12-27 16:11:46 +00:00
while static . CHANNEL_BUSY and time . time ( ) < channel_busy_timeout :
threading . Event ( ) . wait ( 0.01 )
2022-10-28 08:55:50 +00:00
self . enqueue_frame_for_tx ( [ connection_frame ] , c2_mode = FREEDV_MODE . datac0 . value , copies = 1 , repeat_delay = 0 )
2022-05-09 00:41:49 +00:00
2022-12-12 09:06:45 +00:00
timeout = time . time ( ) + 3
2022-05-09 00:41:49 +00:00
while time . time ( ) < timeout :
2022-12-12 11:28:52 +00:00
threading . Event ( ) . wait ( 0.01 )
2022-05-23 00:54:12 +00:00
# Stop waiting if data channel is opened
2022-01-07 10:25:28 +00:00
if static . ARQ_STATE :
2022-05-23 00:54:12 +00:00
return True
2022-12-28 16:22:17 +00:00
if static . TNC_STATE in [ " IDLE " ] :
return False
2022-05-11 22:10:59 +00:00
2022-05-23 00:54:12 +00:00
# `data_channel_max_retries` attempts have been sent. Aborting attempt & cleaning up
2022-06-05 17:11:09 +00:00
2022-05-23 00:54:12 +00:00
self . log . debug (
" [TNC] arq_open_data_channel: " , transmission_uuid = self . transmission_uuid
)
2022-05-30 15:41:24 +00:00
self . send_data_to_socket_queue (
2022-06-06 18:50:36 +00:00
freedata = " tnc-message " ,
2022-05-30 15:41:24 +00:00
arq = " transmission " ,
status = " failed " ,
2022-06-06 18:44:35 +00:00
reason = " unknown " ,
2022-05-30 15:41:24 +00:00
uuid = self . transmission_uuid ,
percent = static . ARQ_TRANSMISSION_PERCENT ,
bytesperminute = static . ARQ_BYTES_PER_MINUTE ,
2023-01-25 11:35:29 +00:00
compression = static . ARQ_COMPRESSION_FACTOR ,
2022-12-04 11:52:25 +00:00
mycallsign = str ( self . mycallsign , ' UTF-8 ' ) ,
dxcallsign = str ( self . dxcallsign , ' UTF-8 ' ) ,
2022-05-30 15:41:24 +00:00
)
2022-05-23 00:54:12 +00:00
self . log . warning (
" [TNC] ARQ | TX | DATA [ "
+ str ( mycallsign , " UTF-8 " )
+ " ]>>X<<[ "
2022-12-04 11:22:35 +00:00
+ str ( self . dxcallsign , " UTF-8 " )
2022-05-23 00:54:12 +00:00
+ " ] "
)
self . datachannel_timeout = True
2022-10-06 09:47:19 +00:00
2022-11-02 14:29:22 +00:00
# Attempt to clean up the far-side, if it received the
2022-05-23 00:54:12 +00:00
# open_session frame and can still hear us.
self . close_session ( )
2022-10-06 09:47:19 +00:00
self . arq_cleanup ( )
2022-05-23 00:54:12 +00:00
return False
2022-11-02 14:29:22 +00:00
# Shouldn't get here...
2022-05-23 00:54:12 +00:00
return True
2022-04-11 09:10:32 +00:00
2022-05-19 20:15:24 +00:00
def arq_received_data_channel_opener ( self , data_in : bytes ) :
2022-03-04 15:50:32 +00:00
"""
2022-11-02 14:29:22 +00:00
Received request to open data channel frame
2022-03-04 15:50:32 +00:00
Args :
2022-05-09 00:41:49 +00:00
data_in : bytes :
2022-03-04 15:50:32 +00:00
"""
2022-07-02 20:19:33 +00:00
# We've arrived here from process_data which already checked that the frame
# is intended for this station.
2022-12-04 15:56:12 +00:00
# stop processing if we don't want to respond to a call when not in a arq session
if not static . RESPOND_TO_CALL and not static . ARQ_SESSION :
return False
2022-03-04 15:50:32 +00:00
self . arq_file_transfer = True
2022-12-04 11:52:25 +00:00
2022-12-19 14:42:48 +00:00
# check if callsign ssid override
_ , self . mycallsign = helpers . check_callsign ( self . mycallsign , data_in [ 1 : 4 ] )
2022-12-29 18:16:47 +00:00
# ignore channel opener if already in ARQ STATE
# use case: Station A is connecting to Station B while
# Station B already tries connecting to Station A.
# For avoiding ignoring repeated connect request in case of packet loss
# we are only ignoring packets in case we are ISS
if static . ARQ_STATE and not self . is_IRS :
return False
2023-01-29 11:20:30 +00:00
self . is_IRS = True
2022-12-04 11:52:25 +00:00
static . DXCALLSIGN_CRC = bytes ( data_in [ 4 : 7 ] )
self . dxcallsign = helpers . bytes_to_callsign ( bytes ( data_in [ 7 : 13 ] ) )
static . DXCALLSIGN = self . dxcallsign
2022-06-05 17:11:09 +00:00
self . send_data_to_socket_queue (
2022-06-06 18:50:36 +00:00
freedata = " tnc-message " ,
2022-06-05 17:11:09 +00:00
arq = " transmission " ,
status = " opening " ,
2022-12-04 11:52:25 +00:00
mycallsign = str ( self . mycallsign , ' UTF-8 ' ) ,
dxcallsign = str ( self . dxcallsign , ' UTF-8 ' ) ,
2022-06-05 17:11:09 +00:00
)
2022-07-02 20:19:33 +00:00
# n_frames_per_burst is currently unused
# n_frames_per_burst = int.from_bytes(bytes(data_in[13:14]), "big")
2022-02-08 14:27:34 +00:00
frametype = int . from_bytes ( bytes ( data_in [ : 1 ] ) , " big " )
2022-05-23 01:11:40 +00:00
# check if we received low bandwidth mode
2022-09-08 08:18:47 +00:00
# possible channel constellations
# ISS(w) <-> IRS(w)
# ISS(w) <-> IRS(n)
# ISS(n) <-> IRS(w)
# ISS(n) <-> IRS(n)
if frametype == FR_TYPE . ARQ_DC_OPEN_W . value and not static . LOW_BANDWIDTH_MODE :
# ISS(w) <-> IRS(w)
constellation = " ISS(w) <-> IRS(w) "
2022-05-28 12:08:33 +00:00
self . received_LOW_BANDWIDTH_MODE = False
2022-05-09 00:41:49 +00:00
self . mode_list = self . mode_list_high_bw
2022-02-08 14:27:34 +00:00
self . time_list = self . time_list_high_bw
2022-09-08 12:54:39 +00:00
self . snr_list = self . snr_list_high_bw
2022-09-08 08:18:47 +00:00
elif frametype == FR_TYPE . ARQ_DC_OPEN_W . value and static . LOW_BANDWIDTH_MODE :
# ISS(w) <-> IRS(n)
constellation = " ISS(w) <-> IRS(n) "
self . received_LOW_BANDWIDTH_MODE = False
self . mode_list = self . mode_list_low_bw
self . time_list = self . time_list_low_bw
2022-09-08 12:54:39 +00:00
self . snr_list = self . snr_list_low_bw
2022-09-08 08:18:47 +00:00
elif frametype == FR_TYPE . ARQ_DC_OPEN_N . value and not static . LOW_BANDWIDTH_MODE :
# ISS(n) <-> IRS(w)
constellation = " ISS(n) <-> IRS(w) "
self . received_LOW_BANDWIDTH_MODE = True
self . mode_list = self . mode_list_low_bw
self . time_list = self . time_list_low_bw
2022-09-08 12:54:39 +00:00
self . snr_list = self . snr_list_low_bw
2022-09-08 08:18:47 +00:00
elif frametype == FR_TYPE . ARQ_DC_OPEN_N . value and static . LOW_BANDWIDTH_MODE :
# ISS(n) <-> IRS(n)
constellation = " ISS(n) <-> IRS(n) "
self . received_LOW_BANDWIDTH_MODE = True
self . mode_list = self . mode_list_low_bw
self . time_list = self . time_list_low_bw
2022-09-08 12:54:39 +00:00
self . snr_list = self . snr_list_low_bw
2022-02-08 14:27:34 +00:00
else :
2022-09-08 08:18:47 +00:00
constellation = " not matched "
2022-05-28 12:08:33 +00:00
self . received_LOW_BANDWIDTH_MODE = True
2022-05-09 00:41:49 +00:00
self . mode_list = self . mode_list_low_bw
2022-02-08 14:27:34 +00:00
self . time_list = self . time_list_low_bw
2022-09-08 12:54:39 +00:00
self . snr_list = self . snr_list_low_bw
2022-09-08 08:18:47 +00:00
2022-09-08 13:36:53 +00:00
# get mode which fits to given SNR
2022-09-08 13:47:23 +00:00
# initially set speed_level 0 in case of really bad SNR and no matching mode
self . speed_level = 0
2022-09-08 12:54:39 +00:00
for i in range ( len ( self . mode_list ) ) :
if static . SNR > = self . snr_list [ i ] :
self . speed_level = i
2022-09-08 13:47:23 +00:00
self . log . debug (
" [TNC] calculated speed level " ,
speed_level = self . speed_level ,
given_snr = static . SNR ,
min_snr = self . snr_list [ self . speed_level ] ,
)
2022-05-09 00:41:49 +00:00
2022-05-23 00:54:12 +00:00
# Update modes we are listening to
2022-10-10 07:00:45 +00:00
self . set_listening_modes ( True , True , self . mode_list [ self . speed_level ] )
2023-01-25 11:30:07 +00:00
static . DXGRID = b ' ------ '
2022-05-23 00:54:12 +00:00
helpers . add_to_heard_stations (
static . DXCALLSIGN ,
static . DXGRID ,
" DATA-CHANNEL " ,
static . SNR ,
static . FREQ_OFFSET ,
static . HAMLIB_FREQUENCY ,
)
2022-05-09 00:41:49 +00:00
2022-10-05 17:24:50 +00:00
self . session_id = data_in [ 13 : 14 ]
2022-12-19 14:42:48 +00:00
# check again if callsign ssid override
_ , self . mycallsign = helpers . check_callsign ( self . mycallsign , data_in [ 1 : 4 ] )
2022-05-09 00:41:49 +00:00
2022-05-23 00:54:12 +00:00
self . log . info (
" [TNC] ARQ | DATA | RX | [ "
2022-12-19 14:42:48 +00:00
+ str ( self . mycallsign , " UTF-8 " )
2022-05-23 00:54:12 +00:00
+ " ]>> <<[ "
2022-12-03 12:59:05 +00:00
+ str ( self . dxcallsign , " UTF-8 " )
2022-05-23 00:54:12 +00:00
+ " ] " ,
2022-09-08 08:18:47 +00:00
channel_constellation = constellation ,
2022-05-23 00:54:12 +00:00
)
2022-05-09 00:41:49 +00:00
2023-01-06 13:41:15 +00:00
# Reset data_channel/burst timestamps
self . data_channel_last_received = int ( time . time ( ) )
2023-01-29 12:11:38 +00:00
self . burst_last_received = int ( time . time ( ) + 6 ) # we might need some more time so lets increase this
2023-01-06 13:41:15 +00:00
# Set ARQ State AFTER resetting timeouts
# this avoids timeouts starting too early
2022-04-11 09:03:54 +00:00
static . ARQ_STATE = True
2022-05-23 00:54:12 +00:00
static . TNC_STATE = " BUSY "
2022-04-11 09:10:32 +00:00
2022-02-08 14:27:34 +00:00
self . reset_statistics ( )
2021-03-16 14:21:58 +00:00
2022-05-28 15:52:05 +00:00
# Select the frame type based on the current TNC mode
2022-05-28 12:08:33 +00:00
if static . LOW_BANDWIDTH_MODE or self . received_LOW_BANDWIDTH_MODE :
2022-06-21 22:33:55 +00:00
frametype = bytes ( [ FR_TYPE . ARQ_DC_OPEN_ACK_N . value ] )
2022-05-23 00:54:12 +00:00
self . log . debug ( " [TNC] Responding with low bandwidth mode " )
2022-02-08 14:27:34 +00:00
else :
2022-06-21 22:33:55 +00:00
frametype = bytes ( [ FR_TYPE . ARQ_DC_OPEN_ACK_W . value ] )
2022-05-23 00:54:12 +00:00
self . log . debug ( " [TNC] Responding with high bandwidth mode " )
2022-05-09 00:41:49 +00:00
2022-10-10 07:39:26 +00:00
connection_frame = bytearray ( self . length_sig0_frame )
2022-05-19 20:15:24 +00:00
connection_frame [ : 1 ] = frametype
2022-10-05 17:24:50 +00:00
connection_frame [ 1 : 2 ] = self . session_id
2022-09-08 13:21:45 +00:00
connection_frame [ 8 : 9 ] = bytes ( [ self . speed_level ] )
2022-09-08 12:54:39 +00:00
2022-05-23 02:13:43 +00:00
# For checking protocol version on the receiving side
connection_frame [ 13 : 14 ] = bytes ( [ static . ARQ_PROTOCOL_VERSION ] )
2022-01-07 11:55:03 +00:00
2022-10-28 08:55:50 +00:00
self . enqueue_frame_for_tx ( [ connection_frame ] , c2_mode = FREEDV_MODE . datac0 . value , copies = 1 , repeat_delay = 0 )
2022-10-10 07:39:26 +00:00
2022-12-05 07:23:18 +00:00
self . send_data_to_socket_queue (
freedata = " tnc-message " ,
arq = " transmission " ,
status = " opened " ,
2022-12-19 14:42:48 +00:00
mycallsign = str ( self . mycallsign , ' UTF-8 ' ) ,
2022-12-05 07:23:18 +00:00
dxcallsign = str ( self . dxcallsign , ' UTF-8 ' ) ,
)
2022-05-23 00:54:12 +00:00
self . log . info (
" [TNC] ARQ | DATA | RX | [ "
2022-12-19 14:42:48 +00:00
+ str ( self . mycallsign , " UTF-8 " )
2022-05-23 00:54:12 +00:00
+ " ]>>|<<[ "
2022-12-03 12:59:05 +00:00
+ str ( self . dxcallsign , " UTF-8 " )
2022-05-23 00:54:12 +00:00
+ " ] " ,
2022-05-23 01:11:40 +00:00
bandwidth = " wide " ,
2022-05-23 00:54:12 +00:00
snr = static . SNR ,
)
2022-05-09 00:41:49 +00:00
2022-01-07 10:25:28 +00:00
# set start of transmission for our statistics
self . rx_start_of_transmission = time . time ( )
2021-02-28 14:24:14 +00:00
2023-01-06 13:41:15 +00:00
# Reset data_channel/burst timestamps once again for avoiding running into timeout
2022-05-19 20:15:24 +00:00
self . data_channel_last_received = int ( time . time ( ) )
2023-01-29 12:11:38 +00:00
self . burst_last_received = int ( time . time ( ) + 6 ) # we might need some more time so lets increase this
2022-05-19 20:15:24 +00:00
2022-05-23 00:54:12 +00:00
def arq_received_channel_is_open ( self , data_in : bytes ) - > None :
2022-03-04 15:50:32 +00:00
"""
2022-03-06 16:23:04 +00:00
Called if we received a data channel opener
2022-03-04 15:50:32 +00:00
Args :
2022-05-09 00:41:49 +00:00
data_in : bytes :
2022-03-04 15:50:32 +00:00
"""
2022-02-08 14:27:34 +00:00
protocol_version = int . from_bytes ( bytes ( data_in [ 13 : 14 ] ) , " big " )
if protocol_version == static . ARQ_PROTOCOL_VERSION :
2022-06-05 17:11:09 +00:00
self . send_data_to_socket_queue (
2022-06-06 18:50:36 +00:00
freedata = " tnc-message " ,
2022-06-05 17:11:09 +00:00
arq = " transmission " ,
2022-06-06 18:31:15 +00:00
status = " opened " ,
2022-12-04 11:52:25 +00:00
mycallsign = str ( self . mycallsign , ' UTF-8 ' ) ,
dxcallsign = str ( self . dxcallsign , ' UTF-8 ' ) ,
2022-06-05 17:11:09 +00:00
)
2022-05-09 00:41:49 +00:00
frametype = int . from_bytes ( bytes ( data_in [ : 1 ] ) , " big " )
2022-06-21 22:33:55 +00:00
if frametype == FR_TYPE . ARQ_DC_OPEN_ACK_N . value :
2022-05-28 12:08:33 +00:00
self . received_LOW_BANDWIDTH_MODE = True
2022-05-09 00:41:49 +00:00
self . mode_list = self . mode_list_low_bw
2022-02-08 14:27:34 +00:00
self . time_list = self . time_list_low_bw
2022-05-23 00:54:12 +00:00
self . log . debug ( " [TNC] low bandwidth mode " , modes = self . mode_list )
2022-02-08 14:27:34 +00:00
else :
2022-05-28 12:08:33 +00:00
self . received_LOW_BANDWIDTH_MODE = False
2022-05-09 00:41:49 +00:00
self . mode_list = self . mode_list_high_bw
2022-02-08 14:27:34 +00:00
self . time_list = self . time_list_high_bw
2022-05-23 00:54:12 +00:00
self . log . debug ( " [TNC] high bandwidth mode " , modes = self . mode_list )
2022-09-08 12:54:39 +00:00
# set speed level from session opener frame which is selected by SNR measurement
self . speed_level = int . from_bytes ( bytes ( data_in [ 8 : 9 ] ) , " big " )
2022-09-08 13:21:45 +00:00
self . log . debug ( " [TNC] speed level selected for given SNR " , speed_level = self . speed_level )
2022-09-08 13:47:23 +00:00
# self.speed_level = len(self.mode_list) - 1
2023-01-25 11:30:07 +00:00
static . DXGRID = b ' ------ '
2022-05-23 00:54:12 +00:00
helpers . add_to_heard_stations (
static . DXCALLSIGN ,
static . DXGRID ,
" DATA-CHANNEL " ,
static . SNR ,
static . FREQ_OFFSET ,
static . HAMLIB_FREQUENCY ,
)
self . log . info (
" [TNC] ARQ | DATA | TX | [ "
+ str ( self . mycallsign , " UTF-8 " )
+ " ]>>|<<[ "
2022-12-03 12:59:05 +00:00
+ str ( self . dxcallsign , " UTF-8 " )
2022-05-23 00:54:12 +00:00
+ " ] " ,
snr = static . SNR ,
)
2022-04-11 09:10:32 +00:00
2022-05-09 00:41:49 +00:00
# as soon as we set ARQ_STATE to DATA, transmission starts
2022-02-08 14:27:34 +00:00
static . ARQ_STATE = True
2022-05-23 02:13:43 +00:00
# Update data_channel timestamp
2022-02-08 14:27:34 +00:00
self . data_channel_last_received = int ( time . time ( ) )
else :
2022-05-23 00:54:12 +00:00
static . TNC_STATE = " IDLE "
2022-02-08 14:27:34 +00:00
static . ARQ_STATE = False
2022-06-05 17:11:09 +00:00
self . send_data_to_socket_queue (
2022-06-06 18:50:36 +00:00
freedata = " tnc-message " ,
2022-06-05 17:11:09 +00:00
arq = " transmission " ,
status = " failed " ,
reason = " protocol version missmatch " ,
2022-12-04 11:52:25 +00:00
mycallsign = str ( self . mycallsign , ' UTF-8 ' ) ,
dxcallsign = str ( self . dxcallsign , ' UTF-8 ' ) ,
2022-06-05 17:11:09 +00:00
)
2022-05-28 15:52:05 +00:00
# TODO: We should display a message to this effect on the UI.
2022-05-23 00:54:12 +00:00
self . log . warning (
" [TNC] protocol version mismatch: " ,
received = protocol_version ,
own = static . ARQ_PROTOCOL_VERSION ,
)
2022-12-29 08:19:35 +00:00
self . stop_transmission ( )
2021-02-28 14:24:14 +00:00
2022-01-07 10:25:28 +00:00
# ---------- PING
2022-12-05 15:57:45 +00:00
def transmit_ping ( self , mycallsign : bytes , dxcallsign : bytes ) - > None :
2022-03-04 15:50:32 +00:00
"""
2022-03-06 16:23:04 +00:00
Funktion for controlling pings
2022-03-04 15:50:32 +00:00
Args :
2022-12-05 15:57:45 +00:00
mycallsign : bytes :
2022-05-09 00:41:49 +00:00
dxcallsign : bytes :
2022-03-04 15:50:32 +00:00
"""
2022-06-17 23:48:47 +00:00
if not str ( dxcallsign ) . strip ( ) :
2022-07-03 18:06:01 +00:00
# TODO: We should display a message to this effect on the UI.
2022-06-17 23:48:47 +00:00
self . log . warning ( " [TNC] Missing required callsign " , dxcallsign = dxcallsign )
return
2022-02-21 11:20:36 +00:00
static . DXCALLSIGN = dxcallsign
2022-04-19 09:09:11 +00:00
static . DXCALLSIGN_CRC = helpers . get_crc_24 ( static . DXCALLSIGN )
2022-12-19 14:42:48 +00:00
self . send_data_to_socket_queue (
freedata = " tnc-message " ,
ping = " transmitting " ,
dxcallsign = str ( dxcallsign , " UTF-8 " ) ,
mycallsign = str ( mycallsign , " UTF-8 " ) ,
snr = str ( static . SNR ) ,
)
2022-05-23 00:54:12 +00:00
self . log . info (
" [TNC] PING REQ [ "
2022-12-05 15:57:45 +00:00
+ str ( mycallsign , " UTF-8 " )
2022-05-23 00:54:12 +00:00
+ " ] >>> [ "
2022-12-03 12:59:05 +00:00
+ str ( dxcallsign , " UTF-8 " )
2022-05-23 00:54:12 +00:00
+ " ] "
)
2022-04-11 09:10:32 +00:00
2022-10-10 07:39:26 +00:00
ping_frame = bytearray ( self . length_sig0_frame )
2022-06-21 22:33:55 +00:00
ping_frame [ : 1 ] = bytes ( [ FR_TYPE . PING . value ] )
2022-05-19 20:15:24 +00:00
ping_frame [ 1 : 4 ] = static . DXCALLSIGN_CRC
2022-12-19 15:00:47 +00:00
ping_frame [ 4 : 7 ] = helpers . get_crc_24 ( mycallsign )
2022-12-05 15:57:45 +00:00
ping_frame [ 7 : 13 ] = helpers . callsign_to_bytes ( mycallsign )
2021-10-17 14:59:15 +00:00
2022-05-23 00:54:12 +00:00
self . log . info ( " [TNC] ENABLE FSK " , state = static . ENABLE_FSK )
2022-03-31 10:45:44 +00:00
if static . ENABLE_FSK :
2022-10-28 08:55:50 +00:00
self . enqueue_frame_for_tx ( [ ping_frame ] , c2_mode = FREEDV_MODE . fsk_ldpc_0 . value )
2022-03-31 10:45:44 +00:00
else :
2022-10-28 08:55:50 +00:00
self . enqueue_frame_for_tx ( [ ping_frame ] , c2_mode = FREEDV_MODE . datac0 . value )
2022-05-09 00:41:49 +00:00
2022-05-23 00:54:12 +00:00
def received_ping ( self , data_in : bytes ) - > None :
2022-03-04 15:50:32 +00:00
"""
2022-03-06 16:23:04 +00:00
Called if we received a ping
2022-03-04 15:50:32 +00:00
Args :
2022-05-09 00:41:49 +00:00
data_in : bytes :
2022-03-04 15:50:32 +00:00
"""
2022-11-30 18:35:23 +00:00
dxcallsign_crc = bytes ( data_in [ 4 : 7 ] )
2022-07-02 20:20:14 +00:00
dxcallsign = helpers . bytes_to_callsign ( bytes ( data_in [ 7 : 13 ] ) )
2022-05-09 00:41:49 +00:00
2022-03-19 11:42:10 +00:00
# check if callsign ssid override
2022-04-19 09:09:11 +00:00
valid , mycallsign = helpers . check_callsign ( self . mycallsign , data_in [ 1 : 4 ] )
2022-04-10 20:45:05 +00:00
if not valid :
# PING packet not for me.
2022-05-23 00:54:12 +00:00
self . log . debug ( " [TNC] received_ping: ping not for this station. " )
2022-04-10 20:45:05 +00:00
return
2022-05-09 00:41:49 +00:00
2022-11-30 18:35:23 +00:00
static . DXCALLSIGN_CRC = dxcallsign_crc
2022-07-02 20:20:14 +00:00
static . DXCALLSIGN = dxcallsign
2022-05-23 00:54:12 +00:00
self . log . info (
" [TNC] PING REQ [ "
+ str ( mycallsign , " UTF-8 " )
+ " ] <<< [ "
2022-12-03 12:59:05 +00:00
+ str ( dxcallsign , " UTF-8 " )
2022-05-23 00:54:12 +00:00
+ " ] " ,
snr = static . SNR ,
)
2021-02-24 15:47:52 +00:00
2023-01-09 17:37:00 +00:00
static . DXGRID = b ' ------ '
2022-11-30 18:35:23 +00:00
helpers . add_to_heard_stations (
2022-12-03 13:04:09 +00:00
dxcallsign ,
2022-11-30 18:35:23 +00:00
static . DXGRID ,
" PING " ,
static . SNR ,
static . FREQ_OFFSET ,
static . HAMLIB_FREQUENCY ,
)
self . send_data_to_socket_queue (
freedata = " tnc-message " ,
ping = " received " ,
uuid = str ( uuid . uuid4 ( ) ) ,
timestamp = int ( time . time ( ) ) ,
dxgrid = str ( static . DXGRID , " UTF-8 " ) ,
2022-12-03 12:59:05 +00:00
dxcallsign = str ( dxcallsign , " UTF-8 " ) ,
2022-12-07 15:30:59 +00:00
mycallsign = str ( mycallsign , " UTF-8 " ) ,
2022-11-30 18:35:23 +00:00
snr = str ( static . SNR ) ,
)
2022-12-04 15:56:12 +00:00
if static . RESPOND_TO_CALL :
ping_frame = bytearray ( self . length_sig0_frame )
ping_frame [ : 1 ] = bytes ( [ FR_TYPE . PING_ACK . value ] )
ping_frame [ 1 : 4 ] = static . DXCALLSIGN_CRC
ping_frame [ 4 : 7 ] = static . MYCALLSIGN_CRC
2023-01-25 11:30:07 +00:00
ping_frame [ 7 : 11 ] = helpers . encode_grid ( static . MYGRID . decode ( " UTF-8 " ) )
2022-12-10 19:46:17 +00:00
ping_frame [ 13 : 14 ] = helpers . snr_to_bytes ( static . SNR )
2022-12-04 15:56:12 +00:00
if static . ENABLE_FSK :
self . enqueue_frame_for_tx ( [ ping_frame ] , c2_mode = FREEDV_MODE . fsk_ldpc_0 . value )
else :
self . enqueue_frame_for_tx ( [ ping_frame ] , c2_mode = FREEDV_MODE . datac0 . value )
2022-05-09 00:41:49 +00:00
2022-05-23 00:54:12 +00:00
def received_ping_ack ( self , data_in : bytes ) - > None :
2022-03-04 15:50:32 +00:00
"""
2022-03-06 16:23:04 +00:00
Called if a PING ack has been received
2022-03-04 15:50:32 +00:00
Args :
2022-05-09 00:41:49 +00:00
data_in : bytes :
2022-03-04 15:50:32 +00:00
"""
2022-05-23 00:54:12 +00:00
2022-12-03 13:04:09 +00:00
# check if we received correct ping
2022-12-19 15:00:47 +00:00
# check if callsign ssid override
_valid , mycallsign = helpers . check_callsign ( self . mycallsign , data_in [ 1 : 4 ] )
if _valid :
2022-05-09 00:41:49 +00:00
2023-01-25 11:30:07 +00:00
static . DXGRID = bytes ( helpers . decode_grid ( data_in [ 7 : 11 ] ) , " UTF-8 " )
2022-12-10 19:46:17 +00:00
dxsnr = helpers . snr_from_bytes ( data_in [ 13 : 14 ] )
2022-12-03 13:04:09 +00:00
self . send_data_to_socket_queue (
freedata = " tnc-message " ,
ping = " acknowledge " ,
uuid = str ( uuid . uuid4 ( ) ) ,
timestamp = int ( time . time ( ) ) ,
dxgrid = str ( static . DXGRID , " UTF-8 " ) ,
2023-01-25 19:43:00 +00:00
dxcallsign = str ( static . DXCALLSIGN , " UTF-8 " ) ,
2022-12-19 15:00:47 +00:00
mycallsign = str ( mycallsign , " UTF-8 " ) ,
2022-12-03 13:04:09 +00:00
snr = str ( static . SNR ) ,
2022-12-10 19:46:17 +00:00
dxsnr = str ( dxsnr )
2022-12-03 13:04:09 +00:00
)
2022-12-10 19:46:17 +00:00
# combined_snr = own rx snr / snr on dx side
combined_snr = f " { static . SNR } / { dxsnr } "
2022-12-03 13:04:09 +00:00
helpers . add_to_heard_stations (
2022-12-19 15:04:30 +00:00
static . DXCALLSIGN ,
2022-12-03 13:04:09 +00:00
static . DXGRID ,
" PING-ACK " ,
2022-12-10 19:46:17 +00:00
combined_snr ,
2022-12-03 13:04:09 +00:00
static . FREQ_OFFSET ,
static . HAMLIB_FREQUENCY ,
)
2022-05-09 00:41:49 +00:00
2022-12-03 13:04:09 +00:00
self . log . info (
" [TNC] PING ACK [ "
2022-12-19 15:00:47 +00:00
+ str ( mycallsign , " UTF-8 " )
2022-12-03 13:04:09 +00:00
+ " ] >|< [ "
2022-12-19 15:04:30 +00:00
+ str ( static . DXCALLSIGN , " UTF-8 " )
2022-12-03 13:04:09 +00:00
+ " ] " ,
snr = static . SNR ,
2022-12-10 19:46:17 +00:00
dxsnr = dxsnr ,
2022-12-03 13:04:09 +00:00
)
static . TNC_STATE = " IDLE "
else :
self . log . info (
" [TNC] FOREIGN PING ACK [ "
+ str ( self . mycallsign , " UTF-8 " )
+ " ] ??? [ "
+ str ( bytes ( data_in [ 4 : 7 ] ) , " UTF-8 " )
+ " ] " ,
snr = static . SNR ,
)
2022-12-03 13:05:39 +00:00
2022-05-23 00:54:12 +00:00
def stop_transmission ( self ) - > None :
2022-03-06 16:23:04 +00:00
"""
Force a stop of the running transmission
"""
2022-05-23 00:54:12 +00:00
self . log . warning ( " [TNC] Stopping transmission! " )
2022-12-24 22:13:21 +00:00
2022-05-23 00:54:12 +00:00
static . TNC_STATE = " IDLE "
2022-01-10 17:09:38 +00:00
static . ARQ_STATE = False
2022-06-05 17:11:09 +00:00
self . send_data_to_socket_queue (
2022-06-06 18:50:36 +00:00
freedata = " tnc-message " ,
2022-06-05 17:11:09 +00:00
arq = " transmission " ,
2022-12-24 22:13:21 +00:00
status = " stopped " ,
2022-12-04 11:52:25 +00:00
mycallsign = str ( self . mycallsign , ' UTF-8 ' ) ,
dxcallsign = str ( self . dxcallsign , ' UTF-8 ' ) ,
2022-06-06 18:31:15 +00:00
)
2022-12-24 22:13:21 +00:00
stop_frame = bytearray ( self . length_sig0_frame )
stop_frame [ : 1 ] = bytes ( [ FR_TYPE . ARQ_STOP . value ] )
stop_frame [ 1 : 4 ] = static . DXCALLSIGN_CRC
stop_frame [ 4 : 7 ] = static . MYCALLSIGN_CRC
# TODO: Not sure if we really need the session id when disconnecting
# stop_frame[1:2] = self.session_id
stop_frame [ 7 : 13 ] = helpers . callsign_to_bytes ( self . mycallsign )
self . enqueue_frame_for_tx ( [ stop_frame ] , c2_mode = FREEDV_MODE . sig1 . value , copies = 6 , repeat_delay = 0 )
2022-01-10 17:09:38 +00:00
self . arq_cleanup ( )
2021-12-06 19:16:14 +00:00
2022-07-02 20:14:05 +00:00
def received_stop_transmission (
2022-09-08 13:47:23 +00:00
self , data_in : bytes
2022-07-02 20:14:05 +00:00
) - > None : # pylint: disable=unused-argument
2022-03-06 16:23:04 +00:00
"""
Received a transmission stop
"""
2022-05-23 00:54:12 +00:00
self . log . warning ( " [TNC] Stopping transmission! " )
static . TNC_STATE = " IDLE "
2022-01-10 17:09:38 +00:00
static . ARQ_STATE = False
2022-06-05 17:11:09 +00:00
self . send_data_to_socket_queue (
2022-06-06 18:50:36 +00:00
freedata = " tnc-message " ,
2022-06-05 17:11:09 +00:00
arq = " transmission " ,
2022-12-24 22:13:21 +00:00
status = " stopped " ,
2022-12-04 11:52:25 +00:00
mycallsign = str ( self . mycallsign , ' UTF-8 ' ) ,
dxcallsign = str ( self . dxcallsign , ' UTF-8 ' ) ,
2022-06-06 19:07:41 +00:00
uuid = self . transmission_uuid ,
2022-06-05 17:11:09 +00:00
)
2022-01-10 17:09:38 +00:00
self . arq_cleanup ( )
2022-05-09 00:41:49 +00:00
2022-01-07 10:25:28 +00:00
# ----------- BROADCASTS
2022-05-23 00:54:12 +00:00
def run_beacon ( self ) - > None :
2022-03-04 15:50:32 +00:00
"""
2022-05-19 20:15:24 +00:00
Controlling function for running a beacon
2022-03-04 15:50:32 +00:00
Args :
2022-05-23 07:46:42 +00:00
2022-05-19 20:15:24 +00:00
self : arq class
2022-03-04 15:50:32 +00:00
Returns :
"""
2022-01-07 10:25:28 +00:00
try :
2022-05-28 02:17:15 +00:00
while True :
2022-12-12 11:28:52 +00:00
threading . Event ( ) . wait ( 0.5 )
2022-03-10 19:46:34 +00:00
while static . BEACON_STATE :
2022-05-23 00:54:12 +00:00
if (
2022-09-08 13:47:23 +00:00
not static . ARQ_SESSION
and not self . arq_file_transfer
and not static . BEACON_PAUSE
2022-12-25 08:19:55 +00:00
and not static . CHANNEL_BUSY
and static . TNC_STATE not in [ " busy " ]
and not static . ARQ_STATE
2022-05-23 00:54:12 +00:00
) :
2022-06-05 17:11:09 +00:00
self . send_data_to_socket_queue (
2022-06-06 18:50:36 +00:00
freedata = " tnc-message " ,
2022-06-05 17:11:09 +00:00
beacon = " transmitting " ,
2022-12-01 08:50:44 +00:00
dxcallsign = " None " ,
2022-06-06 18:44:35 +00:00
interval = self . beacon_interval ,
2022-06-05 17:11:09 +00:00
)
2022-05-23 00:54:12 +00:00
self . log . info (
" [TNC] Sending beacon! " , interval = self . beacon_interval
)
2022-05-09 00:41:49 +00:00
2022-10-10 07:39:26 +00:00
beacon_frame = bytearray ( self . length_sig0_frame )
2022-06-21 22:33:55 +00:00
beacon_frame [ : 1 ] = bytes ( [ FR_TYPE . BEACON . value ] )
2022-05-19 20:15:24 +00:00
beacon_frame [ 1 : 7 ] = helpers . callsign_to_bytes ( self . mycallsign )
2023-01-25 11:30:07 +00:00
beacon_frame [ 7 : 11 ] = helpers . encode_grid ( static . MYGRID . decode ( " UTF-8 " ) )
2022-05-23 00:54:12 +00:00
self . log . info ( " [TNC] ENABLE FSK " , state = static . ENABLE_FSK )
2022-03-10 19:46:34 +00:00
2022-03-31 10:45:44 +00:00
if static . ENABLE_FSK :
2022-05-23 00:54:12 +00:00
self . enqueue_frame_for_tx (
2022-10-28 08:55:50 +00:00
[ beacon_frame ] ,
2022-06-24 13:22:46 +00:00
c2_mode = FREEDV_MODE . fsk_ldpc_0 . value ,
2022-05-23 00:54:12 +00:00
)
2022-03-31 10:45:44 +00:00
else :
2022-10-28 08:55:50 +00:00
self . enqueue_frame_for_tx ( [ beacon_frame ] , c2_mode = FREEDV_MODE . datac0 . value , copies = 1 ,
2022-10-10 07:39:26 +00:00
repeat_delay = 0 )
2022-05-09 00:41:49 +00:00
2022-03-10 19:46:34 +00:00
interval_timer = time . time ( ) + self . beacon_interval
2022-05-23 00:54:12 +00:00
while (
2022-09-08 13:47:23 +00:00
time . time ( ) < interval_timer
and static . BEACON_STATE
and not static . BEACON_PAUSE
2022-05-23 00:54:12 +00:00
) :
2022-12-12 11:28:52 +00:00
threading . Event ( ) . wait ( 0.01 )
2022-02-21 11:20:36 +00:00
2022-05-25 22:27:33 +00:00
except Exception as err :
2022-05-28 02:17:15 +00:00
self . log . debug ( " [TNC] run_beacon: " , exception = err )
2022-01-07 10:25:28 +00:00
2022-05-23 00:54:12 +00:00
def received_beacon ( self , data_in : bytes ) - > None :
2022-03-04 15:50:32 +00:00
"""
2022-03-06 16:23:04 +00:00
Called if we received a beacon
2022-03-04 15:50:32 +00:00
Args :
2022-05-09 00:41:49 +00:00
data_in : bytes :
2022-03-04 15:50:32 +00:00
"""
2022-04-15 14:49:40 +00:00
# here we add the received station to the heard stations buffer
2022-11-30 18:35:23 +00:00
beacon_callsign = helpers . bytes_to_callsign ( bytes ( data_in [ 1 : 7 ] ) )
2023-01-25 11:30:07 +00:00
static . DXGRID = bytes ( helpers . decode_grid ( data_in [ 7 : 11 ] ) , " UTF-8 " )
2022-05-30 15:41:24 +00:00
self . send_data_to_socket_queue (
2022-06-06 18:50:36 +00:00
freedata = " tnc-message " ,
2022-06-07 08:08:15 +00:00
beacon = " received " ,
2022-05-30 15:41:24 +00:00
uuid = str ( uuid . uuid4 ( ) ) ,
timestamp = int ( time . time ( ) ) ,
2022-11-30 18:35:23 +00:00
dxcallsign = str ( beacon_callsign , " UTF-8 " ) ,
2023-01-25 11:30:07 +00:00
dxgrid = str ( static . DXGRID , " UTF-8 " ) ,
2022-05-30 15:41:24 +00:00
snr = str ( static . SNR ) ,
)
2022-06-07 08:08:15 +00:00
2022-05-23 00:54:12 +00:00
self . log . info (
" [TNC] BEACON RCVD [ "
2022-11-30 18:35:23 +00:00
+ str ( beacon_callsign , " UTF-8 " )
2022-05-23 00:54:12 +00:00
+ " ][ "
2023-01-25 11:30:07 +00:00
+ str ( static . DXGRID , " UTF-8 " )
2022-05-23 00:54:12 +00:00
+ " ] " ,
snr = static . SNR ,
)
helpers . add_to_heard_stations (
2022-11-30 18:35:23 +00:00
beacon_callsign ,
2023-01-25 11:30:07 +00:00
static . DXGRID ,
2022-05-23 00:54:12 +00:00
" BEACON " ,
static . SNR ,
static . FREQ_OFFSET ,
static . HAMLIB_FREQUENCY ,
)
def transmit_cq ( self ) - > None :
2022-04-15 19:13:03 +00:00
"""
Transmit a CQ
2022-05-11 22:10:59 +00:00
Args :
2022-10-05 18:27:38 +00:00
self
2022-05-11 22:10:59 +00:00
Returns :
Nothing
2022-04-15 19:13:03 +00:00
"""
2022-05-23 00:54:12 +00:00
self . log . info ( " [TNC] CQ CQ CQ " )
2022-06-05 17:11:09 +00:00
self . send_data_to_socket_queue (
2022-06-06 18:50:36 +00:00
freedata = " tnc-message " ,
2022-06-05 17:11:09 +00:00
cq = " transmitting " ,
2022-12-05 07:23:18 +00:00
mycallsign = str ( self . mycallsign , " UTF-8 " ) ,
2022-12-01 08:50:44 +00:00
dxcallsign = " None " ,
2022-06-05 17:11:09 +00:00
)
2022-10-10 07:39:26 +00:00
cq_frame = bytearray ( self . length_sig0_frame )
2022-06-21 22:33:55 +00:00
cq_frame [ : 1 ] = bytes ( [ FR_TYPE . CQ . value ] )
2022-05-19 20:15:24 +00:00
cq_frame [ 1 : 7 ] = helpers . callsign_to_bytes ( self . mycallsign )
2022-05-23 00:54:12 +00:00
cq_frame [ 7 : 11 ] = helpers . encode_grid ( static . MYGRID . decode ( " UTF-8 " ) )
2022-05-09 00:41:49 +00:00
2022-05-23 00:54:12 +00:00
self . log . info ( " [TNC] ENABLE FSK " , state = static . ENABLE_FSK )
self . log . debug ( " [TNC] CQ Frame: " , data = [ cq_frame ] )
2022-05-11 22:10:59 +00:00
2022-04-15 14:49:40 +00:00
if static . ENABLE_FSK :
2022-10-28 08:55:50 +00:00
self . enqueue_frame_for_tx ( [ cq_frame ] , c2_mode = FREEDV_MODE . fsk_ldpc_0 . value )
2022-04-15 14:49:40 +00:00
else :
2022-10-28 08:55:50 +00:00
self . enqueue_frame_for_tx ( [ cq_frame ] , c2_mode = FREEDV_MODE . datac0 . value , copies = 1 , repeat_delay = 0 )
2022-04-15 14:49:40 +00:00
2022-05-23 00:54:12 +00:00
def received_cq ( self , data_in : bytes ) - > None :
2022-04-15 14:49:40 +00:00
"""
2022-05-11 22:10:59 +00:00
Called when we receive a CQ frame
2022-04-15 14:49:40 +00:00
Args :
2022-05-09 00:41:49 +00:00
data_in : bytes :
2022-04-15 14:49:40 +00:00
Returns :
2022-05-11 22:10:59 +00:00
Nothing
2022-04-15 14:49:40 +00:00
"""
# here we add the received station to the heard stations buffer
2022-04-17 20:16:13 +00:00
dxcallsign = helpers . bytes_to_callsign ( bytes ( data_in [ 1 : 7 ] ) )
2022-05-23 00:54:12 +00:00
self . log . debug ( " [TNC] received_cq: " , dxcallsign = dxcallsign )
2023-01-25 11:30:07 +00:00
static . DXGRID = bytes ( helpers . decode_grid ( data_in [ 7 : 11 ] ) , " UTF-8 " )
2022-06-05 17:11:09 +00:00
self . send_data_to_socket_queue (
2022-06-06 18:50:36 +00:00
freedata = " tnc-message " ,
2022-06-07 08:08:15 +00:00
cq = " received " ,
2022-06-06 19:07:41 +00:00
mycallsign = str ( self . mycallsign , " UTF-8 " ) ,
2022-11-30 18:35:23 +00:00
dxcallsign = str ( dxcallsign , " UTF-8 " ) ,
2022-06-05 17:11:09 +00:00
dxgrid = str ( static . DXGRID , " UTF-8 " ) ,
)
2022-05-23 00:54:12 +00:00
self . log . info (
" [TNC] CQ RCVD [ "
+ str ( dxcallsign , " UTF-8 " )
+ " ][ "
2023-01-25 11:30:07 +00:00
+ str ( static . DXGRID , " UTF-8 " )
2022-05-23 00:54:12 +00:00
+ " ] " ,
snr = static . SNR ,
)
helpers . add_to_heard_stations (
dxcallsign ,
2023-01-25 11:30:07 +00:00
static . DXGRID ,
2022-05-23 00:54:12 +00:00
" CQ CQ CQ " ,
static . SNR ,
static . FREQ_OFFSET ,
static . HAMLIB_FREQUENCY ,
)
2022-04-15 14:49:40 +00:00
2022-12-04 15:56:12 +00:00
if static . RESPOND_TO_CQ and static . RESPOND_TO_CALL :
2022-12-01 08:50:44 +00:00
self . transmit_qrv ( dxcallsign )
2022-04-11 09:10:32 +00:00
2022-12-01 08:50:44 +00:00
def transmit_qrv ( self , dxcallsign : bytes ) - > None :
2022-03-06 16:23:04 +00:00
"""
2022-05-11 22:10:59 +00:00
Called when we send a QRV frame
2022-04-15 19:13:03 +00:00
Args :
2022-12-01 08:50:44 +00:00
self ,
dxcallsign
2022-04-15 19:13:03 +00:00
2022-03-06 16:23:04 +00:00
"""
2022-04-15 19:13:03 +00:00
# Sleep a random amount of time before responding to make it more likely to be
# heard when many stations respond. Each DATAC0 frame is 0.44 sec (440ms) in
# duration, plus overhead. Set the wait interval to be random between 0 and 2s
2022-04-15 23:59:12 +00:00
# in 0.5s increments.
helpers . wait ( randrange ( 0 , 20 , 5 ) / 10.0 )
2022-06-05 17:11:09 +00:00
self . send_data_to_socket_queue (
2022-06-06 18:50:36 +00:00
freedata = " tnc-message " ,
2022-06-05 17:11:09 +00:00
qrv = " transmitting " ,
2022-12-01 08:50:44 +00:00
dxcallsign = str ( dxcallsign , " UTF-8 " ) ,
2022-06-05 17:11:09 +00:00
)
2022-05-23 00:54:12 +00:00
self . log . info ( " [TNC] Sending QRV! " )
2022-04-15 19:13:03 +00:00
2022-10-10 07:39:26 +00:00
qrv_frame = bytearray ( self . length_sig0_frame )
2022-06-21 22:33:55 +00:00
qrv_frame [ : 1 ] = bytes ( [ FR_TYPE . QRV . value ] )
2022-05-19 20:15:24 +00:00
qrv_frame [ 1 : 7 ] = helpers . callsign_to_bytes ( self . mycallsign )
2022-05-23 00:54:12 +00:00
qrv_frame [ 7 : 11 ] = helpers . encode_grid ( static . MYGRID . decode ( " UTF-8 " ) )
2022-12-19 15:46:18 +00:00
qrv_frame [ 11 : 12 ] = helpers . snr_to_bytes ( static . SNR )
2022-04-15 19:13:03 +00:00
2022-05-11 22:10:59 +00:00
2022-03-31 10:45:44 +00:00
if static . ENABLE_FSK :
2022-12-19 15:46:18 +00:00
self . log . info ( " [TNC] ENABLE FSK " , state = static . ENABLE_FSK )
2022-10-28 08:55:50 +00:00
self . enqueue_frame_for_tx ( [ qrv_frame ] , c2_mode = FREEDV_MODE . fsk_ldpc_0 . value )
2022-03-31 10:45:44 +00:00
else :
2022-10-28 08:55:50 +00:00
self . enqueue_frame_for_tx ( [ qrv_frame ] , c2_mode = FREEDV_MODE . datac0 . value , copies = 1 , repeat_delay = 0 )
2021-09-26 15:51:11 +00:00
2022-05-23 00:54:12 +00:00
def received_qrv ( self , data_in : bytes ) - > None :
2022-03-04 15:50:32 +00:00
"""
2022-05-11 22:10:59 +00:00
Called when we receive a QRV frame
2022-03-04 15:50:32 +00:00
Args :
2022-04-15 19:13:03 +00:00
data_in : bytes :
2022-03-04 15:50:32 +00:00
"""
2022-01-07 10:25:28 +00:00
# here we add the received station to the heard stations buffer
2022-04-17 20:16:13 +00:00
dxcallsign = helpers . bytes_to_callsign ( bytes ( data_in [ 1 : 7 ] ) )
2023-01-25 11:30:07 +00:00
static . DXGRID = bytes ( helpers . decode_grid ( data_in [ 7 : 11 ] ) , " UTF-8 " )
2022-12-19 15:46:18 +00:00
dxsnr = helpers . snr_from_bytes ( data_in [ 11 : 12 ] )
combined_snr = f " { static . SNR } / { dxsnr } "
2022-05-23 00:54:12 +00:00
2022-05-30 15:41:24 +00:00
self . send_data_to_socket_queue (
2022-06-06 18:50:36 +00:00
freedata = " tnc-message " ,
2022-06-06 18:44:35 +00:00
qrv = " received " ,
2022-12-01 09:09:44 +00:00
dxcallsign = str ( dxcallsign , " UTF-8 " ) ,
2023-01-25 11:30:07 +00:00
dxgrid = str ( static . DXGRID , " UTF-8 " ) ,
2022-12-19 15:46:18 +00:00
snr = str ( static . SNR ) ,
dxsnr = str ( dxsnr )
2022-05-30 15:41:24 +00:00
)
2022-05-23 00:54:12 +00:00
self . log . info (
" [TNC] QRV RCVD [ "
+ str ( dxcallsign , " UTF-8 " )
+ " ][ "
2023-01-25 11:30:07 +00:00
+ str ( static . DXGRID , " UTF-8 " )
2022-05-23 00:54:12 +00:00
+ " ] " ,
snr = static . SNR ,
2022-12-19 15:46:18 +00:00
dxsnr = dxsnr
2022-05-23 00:54:12 +00:00
)
helpers . add_to_heard_stations (
dxcallsign ,
2023-01-25 11:30:07 +00:00
static . DXGRID ,
2022-05-23 00:54:12 +00:00
" QRV " ,
2022-12-19 15:46:18 +00:00
combined_snr ,
2022-05-23 00:54:12 +00:00
static . FREQ_OFFSET ,
static . HAMLIB_FREQUENCY ,
)
2022-04-15 19:13:03 +00:00
2022-11-02 14:29:22 +00:00
# ------------ CALCULATE TRANSFER RATES
2022-05-23 00:54:12 +00:00
def calculate_transfer_rate_rx (
2022-09-08 13:47:23 +00:00
self , rx_start_of_transmission : float , receivedbytes : int
2022-05-23 00:54:12 +00:00
) - > list :
2022-03-04 15:50:32 +00:00
"""
2022-05-11 22:10:59 +00:00
Calculate transfer rate for received data
2022-03-04 15:50:32 +00:00
Args :
2022-05-09 00:41:49 +00:00
rx_start_of_transmission : float :
receivedbytes : int :
2022-03-04 15:50:32 +00:00
2022-05-11 22:10:59 +00:00
Returns : List of :
bits_per_second : float ,
bytes_per_minute : float ,
transmission_percent : float
2022-03-04 15:50:32 +00:00
"""
2022-05-09 00:41:49 +00:00
try :
2022-03-14 19:21:15 +00:00
if static . TOTAL_BYTES == 0 :
static . TOTAL_BYTES = 1
2022-05-19 20:15:24 +00:00
static . ARQ_TRANSMISSION_PERCENT = min (
2022-05-23 00:54:12 +00:00
int (
(
2022-09-08 13:47:23 +00:00
receivedbytes
* static . ARQ_COMPRESSION_FACTOR
2022-10-05 18:27:38 +00:00
/ static . TOTAL_BYTES
2022-05-23 00:54:12 +00:00
)
* 100
) ,
100 ,
)
2022-05-09 00:41:49 +00:00
2022-01-07 10:25:28 +00:00
transmissiontime = time . time ( ) - self . rx_start_of_transmission
2022-05-09 00:41:49 +00:00
2022-01-07 10:25:28 +00:00
if receivedbytes > 0 :
2022-05-11 22:10:59 +00:00
static . ARQ_BITS_PER_SECOND = int ( ( receivedbytes * 8 ) / transmissiontime )
2022-05-23 00:54:12 +00:00
static . ARQ_BYTES_PER_MINUTE = int (
2022-10-05 18:27:38 +00:00
receivedbytes / ( transmissiontime / 60 )
2022-05-23 00:54:12 +00:00
)
2022-12-31 12:22:34 +00:00
static . ARQ_SECONDS_UNTIL_FINISH = int ( ( ( static . TOTAL_BYTES - receivedbytes ) / ( static . ARQ_BYTES_PER_MINUTE * static . ARQ_COMPRESSION_FACTOR ) ) * 60 ) - 20 # offset because of frame ack/nack
2023-01-16 09:11:45 +00:00
speed_chart = { " snr " : static . SNR , " bpm " : static . ARQ_BYTES_PER_MINUTE , " timestamp " : int ( time . time ( ) ) }
# check if data already in list
if speed_chart not in static . SPEED_LIST :
static . SPEED_LIST . append ( speed_chart )
2022-01-07 10:25:28 +00:00
else :
static . ARQ_BITS_PER_SECOND = 0
2022-05-09 00:41:49 +00:00
static . ARQ_BYTES_PER_MINUTE = 0
2022-12-31 11:38:46 +00:00
static . ARQ_SECONDS_UNTIL_FINISH = 0
2022-05-25 22:27:33 +00:00
except Exception as err :
2022-05-28 02:17:15 +00:00
self . log . error ( f " [TNC] calculate_transfer_rate_rx: Exception: { err } " )
2022-01-07 10:25:28 +00:00
static . ARQ_TRANSMISSION_PERCENT = 0.0
2021-09-26 15:51:11 +00:00
static . ARQ_BITS_PER_SECOND = 0
2022-01-07 10:25:28 +00:00
static . ARQ_BYTES_PER_MINUTE = 0
2021-10-05 17:59:32 +00:00
2022-05-23 00:54:12 +00:00
return [
static . ARQ_BITS_PER_SECOND ,
static . ARQ_BYTES_PER_MINUTE ,
static . ARQ_TRANSMISSION_PERCENT ,
]
2022-04-11 09:10:32 +00:00
2022-05-23 00:54:12 +00:00
def reset_statistics ( self ) - > None :
2022-03-06 16:23:04 +00:00
"""
Reset statistics
"""
2022-02-08 14:27:34 +00:00
# reset ARQ statistics
static . ARQ_BYTES_PER_MINUTE_BURST = 0
2022-06-19 12:47:56 +00:00
static . ARQ_BYTES_PER_MINUTE = 0
static . ARQ_BITS_PER_SECOND_BURST = 0
static . ARQ_BITS_PER_SECOND = 0
static . ARQ_TRANSMISSION_PERCENT = 0
static . TOTAL_BYTES = 0
2022-12-31 11:38:46 +00:00
static . ARQ_SECONDS_UNTIL_FINISH = 0
2022-05-09 00:41:49 +00:00
2022-05-23 00:54:12 +00:00
def calculate_transfer_rate_tx (
2022-09-08 13:47:23 +00:00
self , tx_start_of_transmission : float , sentbytes : int , tx_buffer_length : int
2022-05-23 00:54:12 +00:00
) - > list :
2022-03-04 15:50:32 +00:00
"""
2022-05-23 07:37:24 +00:00
Calculate transfer rate for transmission
2022-03-04 15:50:32 +00:00
Args :
2022-05-09 00:41:49 +00:00
tx_start_of_transmission : float :
sentbytes : int :
tx_buffer_length : int :
2022-03-04 15:50:32 +00:00
2022-05-23 00:54:12 +00:00
Returns : List of :
bits_per_second : float ,
bytes_per_minute : float ,
transmission_percent : float
2022-03-04 15:50:32 +00:00
"""
2022-01-07 10:25:28 +00:00
try :
2022-05-23 00:54:12 +00:00
static . ARQ_TRANSMISSION_PERCENT = min (
int ( ( sentbytes / tx_buffer_length ) * 100 ) , 100
)
2022-05-09 00:41:49 +00:00
2022-01-07 10:25:28 +00:00
transmissiontime = time . time ( ) - tx_start_of_transmission
2021-09-27 15:33:59 +00:00
2022-01-07 10:25:28 +00:00
if sentbytes > 0 :
2022-05-23 02:13:43 +00:00
static . ARQ_BITS_PER_SECOND = int ( ( sentbytes * 8 ) / transmissiontime )
2022-10-05 18:27:38 +00:00
static . ARQ_BYTES_PER_MINUTE = int ( sentbytes / ( transmissiontime / 60 ) )
2022-12-31 12:16:10 +00:00
static . ARQ_SECONDS_UNTIL_FINISH = int ( ( ( tx_buffer_length - sentbytes ) / ( static . ARQ_BYTES_PER_MINUTE * static . ARQ_COMPRESSION_FACTOR ) ) * 60 )
2023-01-16 09:11:45 +00:00
speed_chart = { " snr " : self . burst_ack_snr , " bpm " : static . ARQ_BYTES_PER_MINUTE , " timestamp " : int ( time . time ( ) ) }
# check if data already in list
if speed_chart not in static . SPEED_LIST :
static . SPEED_LIST . append ( speed_chart )
2022-01-07 10:25:28 +00:00
else :
static . ARQ_BITS_PER_SECOND = 0
2022-05-09 00:41:49 +00:00
static . ARQ_BYTES_PER_MINUTE = 0
2022-12-31 11:38:46 +00:00
static . ARQ_SECONDS_UNTIL_FINISH = 0
2022-05-09 00:41:49 +00:00
2022-05-25 22:27:33 +00:00
except Exception as err :
2022-05-28 02:17:15 +00:00
self . log . error ( f " [TNC] calculate_transfer_rate_tx: Exception: { err } " )
2022-01-07 10:25:28 +00:00
static . ARQ_TRANSMISSION_PERCENT = 0.0
static . ARQ_BITS_PER_SECOND = 0
static . ARQ_BYTES_PER_MINUTE = 0
2021-09-26 15:51:11 +00:00
2022-05-23 00:54:12 +00:00
return [
static . ARQ_BITS_PER_SECOND ,
static . ARQ_BYTES_PER_MINUTE ,
static . ARQ_TRANSMISSION_PERCENT ,
]
2022-04-11 09:10:32 +00:00
2022-01-07 10:25:28 +00:00
# ----------------------CLEANUP AND RESET FUNCTIONS
2022-05-23 00:54:12 +00:00
def arq_cleanup ( self ) - > None :
2022-03-06 16:23:04 +00:00
"""
2022-05-23 00:54:12 +00:00
Cleanup function which clears all ARQ states
2022-03-06 16:23:04 +00:00
"""
2022-05-23 00:54:12 +00:00
if TESTMODE :
2022-06-05 18:09:38 +00:00
self . log . debug ( " [TNC] TESTMODE: arq_cleanup: Not performing cleanup. " )
2022-05-23 00:54:12 +00:00
return
self . log . debug ( " [TNC] arq_cleanup " )
2023-01-29 17:50:09 +00:00
# wait a second for smoother arq behaviour
helpers . wait ( 1.0 )
2023-01-11 15:18:29 +00:00
2022-01-07 10:44:35 +00:00
self . rx_frame_bof_received = False
self . rx_frame_eof_received = False
2022-01-07 11:55:03 +00:00
self . burst_ack = False
2022-01-07 10:25:28 +00:00
self . rpt_request_received = False
self . data_frame_ack_received = False
static . RX_BURST_BUFFER = [ ]
2022-05-23 00:54:12 +00:00
static . RX_FRAME_BUFFER = b " "
2023-01-12 23:14:42 +00:00
self . burst_ack_snr = 0
2022-01-07 10:25:28 +00:00
2022-01-15 18:23:28 +00:00
# reset modem receiving state to reduce cpu load
2022-10-10 07:00:45 +00:00
modem . RECEIVE_SIG0 = True
modem . RECEIVE_SIG1 = False
2022-01-15 18:23:28 +00:00
modem . RECEIVE_DATAC1 = False
modem . RECEIVE_DATAC3 = False
2022-05-19 20:15:24 +00:00
# modem.RECEIVE_FSK_LDPC_0 = False
2022-03-24 19:49:13 +00:00
modem . RECEIVE_FSK_LDPC_1 = False
2022-05-09 00:41:49 +00:00
2022-01-15 19:17:19 +00:00
# reset buffer overflow counter
2022-05-11 22:10:59 +00:00
static . BUFFER_OVERFLOW_COUNTER = [ 0 , 0 , 0 , 0 , 0 ]
2022-02-02 20:12:16 +00:00
self . is_IRS = False
self . burst_nack = False
self . burst_nack_counter = 0
2022-12-13 08:10:40 +00:00
self . frame_nack_counter = 0
2022-02-02 20:12:16 +00:00
self . frame_received_counter = 0
self . speed_level = len ( self . mode_list ) - 1
2022-02-22 20:05:48 +00:00
static . ARQ_SPEED_LEVEL = self . speed_level
2022-05-09 00:41:49 +00:00
2022-05-23 01:11:40 +00:00
# low bandwidth mode indicator
2022-05-28 12:08:33 +00:00
self . received_LOW_BANDWIDTH_MODE = False
2022-05-09 00:41:49 +00:00
2022-02-08 14:27:34 +00:00
# reset retry counter for rx channel / burst
self . n_retries_per_burst = 0
2022-05-09 00:41:49 +00:00
2022-11-20 10:44:29 +00:00
# reset max retries possibly overriden by api
2022-12-25 13:24:39 +00:00
self . session_connect_max_retries = 10
self . data_channel_max_retries = 10
2022-11-20 10:44:29 +00:00
2023-01-11 15:18:29 +00:00
# we need to keep these values if in ARQ_SESSION
2022-03-04 15:50:32 +00:00
if not static . ARQ_SESSION :
2022-05-23 00:54:12 +00:00
static . TNC_STATE = " IDLE "
2022-12-04 11:52:25 +00:00
self . dxcallsign = b " AA0AA-0 "
2022-12-05 07:23:18 +00:00
self . mycallsign = static . MYCALLSIGN
2023-01-11 15:18:29 +00:00
self . session_id = bytes ( 1 )
2022-05-09 00:41:49 +00:00
2023-01-12 23:14:42 +00:00
static . SPEED_LIST = [ ]
2022-03-04 15:50:32 +00:00
static . ARQ_STATE = False
self . arq_file_transfer = False
2022-05-09 00:41:49 +00:00
2022-03-10 19:46:34 +00:00
static . BEACON_PAUSE = False
2022-05-09 00:41:49 +00:00
2022-05-23 00:54:12 +00:00
def arq_reset_ack ( self , state : bool ) - > None :
2022-03-04 15:50:32 +00:00
"""
2022-03-06 16:23:04 +00:00
Funktion for resetting acknowledge states
2022-03-04 15:50:32 +00:00
Args :
2022-05-09 00:41:49 +00:00
state : bool :
2022-03-04 15:50:32 +00:00
"""
2022-01-07 11:55:03 +00:00
self . burst_ack = state
2022-01-07 10:25:28 +00:00
self . rpt_request_received = state
self . data_frame_ack_received = state
2021-09-26 15:51:11 +00:00
2022-10-10 07:00:45 +00:00
def set_listening_modes ( self , enable_sig0 : bool , enable_sig1 : bool , mode : int ) - > None :
2022-03-04 15:50:32 +00:00
"""
2022-03-06 16:23:04 +00:00
Function for setting the data modes we are listening to for saving cpu power
2022-03-04 15:50:32 +00:00
Args :
2022-10-10 07:00:45 +00:00
enable_sig0 : int : Enable / Disable signalling mode 0
enable_sig1 : int : Enable / Disable signalling mode 1
2022-05-23 00:54:12 +00:00
mode : int : Codec2 mode to listen for
2022-03-04 15:50:32 +00:00
"""
2022-05-11 22:10:59 +00:00
# set modes we want to listen to
2022-10-10 07:00:45 +00:00
modem . RECEIVE_SIG0 = enable_sig0
modem . RECEIVE_SIG1 = enable_sig1
2022-06-24 13:22:46 +00:00
if mode == FREEDV_MODE . datac1 . value :
2022-02-02 20:12:16 +00:00
modem . RECEIVE_DATAC1 = True
2022-12-12 10:43:42 +00:00
modem . RECEIVE_DATAC3 = False
modem . RECEIVE_FSK_LDPC_1 = False
2022-05-23 00:54:12 +00:00
self . log . debug ( " [TNC] Changing listening data mode " , mode = " datac1 " )
2022-06-24 13:22:46 +00:00
elif mode == FREEDV_MODE . datac3 . value :
2022-12-12 10:43:42 +00:00
modem . RECEIVE_DATAC1 = False
2022-02-02 20:12:16 +00:00
modem . RECEIVE_DATAC3 = True
2022-12-12 10:43:42 +00:00
modem . RECEIVE_FSK_LDPC_1 = False
2022-05-23 00:54:12 +00:00
self . log . debug ( " [TNC] Changing listening data mode " , mode = " datac3 " )
2022-06-24 13:22:46 +00:00
elif mode == FREEDV_MODE . fsk_ldpc_1 . value :
2022-12-12 10:43:42 +00:00
modem . RECEIVE_DATAC1 = False
modem . RECEIVE_DATAC3 = False
2022-03-24 19:49:13 +00:00
modem . RECEIVE_FSK_LDPC_1 = True
2022-05-23 00:54:12 +00:00
self . log . debug ( " [TNC] Changing listening data mode " , mode = " fsk_ldpc_1 " )
2022-06-21 22:47:18 +00:00
else :
2022-02-02 20:12:16 +00:00
modem . RECEIVE_DATAC1 = True
modem . RECEIVE_DATAC3 = True
2022-03-24 19:49:13 +00:00
modem . RECEIVE_FSK_LDPC_1 = True
2022-05-23 00:54:12 +00:00
self . log . debug (
" [TNC] Changing listening data mode " , mode = " datac1/datac3/fsk_ldpc "
)
2022-05-09 00:41:49 +00:00
2022-01-07 10:25:28 +00:00
# ------------------------- WATCHDOG FUNCTIONS FOR TIMER
2022-05-23 00:54:12 +00:00
def watchdog ( self ) - > None :
2022-03-04 15:50:32 +00:00
""" Author: DJ2LS
2022-05-09 00:41:49 +00:00
2022-05-23 00:54:12 +00:00
Watchdog master function . From here , " pet " the watchdogs
2022-03-04 15:50:32 +00:00
2022-01-07 10:25:28 +00:00
"""
while True :
2022-12-12 11:28:52 +00:00
threading . Event ( ) . wait ( 0.1 )
2022-01-07 10:25:28 +00:00
self . data_channel_keep_alive_watchdog ( )
2022-02-02 20:12:16 +00:00
self . burst_watchdog ( )
2022-03-04 15:50:32 +00:00
self . arq_session_keep_alive_watchdog ( )
2021-09-26 15:51:11 +00:00
2022-05-23 00:54:12 +00:00
def burst_watchdog ( self ) - > None :
2022-03-06 16:23:04 +00:00
"""
2022-05-23 00:54:12 +00:00
Watchdog which checks if we are running into a connection timeout
2022-03-06 16:23:04 +00:00
DATA BURST
"""
2022-05-09 00:41:49 +00:00
# IRS SIDE
2022-05-19 20:15:24 +00:00
# TODO: We need to redesign this part for cleaner state handling
2022-05-23 00:54:12 +00:00
# Return if not ARQ STATE and not ARQ SESSION STATE as they are different use cases
if (
2022-09-08 13:47:23 +00:00
not static . ARQ_STATE
and static . ARQ_SESSION_STATE != " connected "
or not self . is_IRS
2022-05-23 00:54:12 +00:00
) :
2022-05-20 12:38:43 +00:00
return
2022-05-23 00:54:12 +00:00
2022-12-05 14:49:10 +00:00
# get modem error state
modem_error_state = modem . get_modem_error_state ( )
2022-05-23 00:54:12 +00:00
# We want to reach this state only if connected ( == return above not called )
2023-01-04 10:04:10 +00:00
timeout = self . burst_last_received + self . time_list [ self . speed_level ]
if timeout < = time . time ( ) or modem_error_state :
print ( " timeout---------------- " )
print ( time . time ( ) - timeout )
print ( time . time ( ) - ( self . burst_last_received + self . time_list [ self . speed_level ] ) )
print ( " ----------------------- " )
2022-12-05 14:49:10 +00:00
if modem_error_state :
self . log . warning (
" [TNC] Decoding Error " ,
attempt = self . n_retries_per_burst ,
max_attempts = self . rx_n_max_retries_per_burst ,
speed_level = self . speed_level ,
)
else :
self . log . warning (
2023-01-04 10:04:10 +00:00
" [TNC] Burst timeout " ,
2022-12-05 14:49:10 +00:00
attempt = self . n_retries_per_burst ,
max_attempts = self . rx_n_max_retries_per_burst ,
speed_level = self . speed_level ,
)
2023-01-04 10:04:10 +00:00
# reset self.burst_last_received
self . burst_last_received = time . time ( ) + self . time_list [ self . speed_level ]
2022-12-01 07:51:21 +00:00
# reduce speed level if nack counter increased
2022-05-11 22:10:59 +00:00
self . frame_received_counter = 0
self . burst_nack_counter + = 1
if self . burst_nack_counter > = 2 :
self . burst_nack_counter = 0
2022-05-23 02:13:43 +00:00
self . speed_level = max ( self . speed_level - 1 , 0 )
2022-05-11 22:10:59 +00:00
static . ARQ_SPEED_LEVEL = self . speed_level
2022-05-09 00:41:49 +00:00
2022-05-23 00:54:12 +00:00
# Update modes we are listening to
2022-10-10 07:00:45 +00:00
self . set_listening_modes ( True , True , self . mode_list [ self . speed_level ] )
2022-05-09 00:41:49 +00:00
2022-05-23 02:13:43 +00:00
# Why not pass `snr` or `static.SNR`?
self . send_burst_nack_frame_watchdog ( 0 )
2022-05-11 22:10:59 +00:00
2022-05-23 02:13:43 +00:00
# Update data_channel timestamp
2022-12-24 17:39:51 +00:00
# TODO: Disabled this one for testing.
# self.data_channel_last_received = time.time()
2022-05-11 22:10:59 +00:00
self . n_retries_per_burst + = 1
2022-05-23 00:54:12 +00:00
else :
# print((self.data_channel_last_received + self.time_list[self.speed_level])-time.time())
pass
2022-05-11 22:10:59 +00:00
if self . n_retries_per_burst > = self . rx_n_max_retries_per_burst :
self . stop_transmission ( )
2022-05-09 00:41:49 +00:00
2022-05-23 00:54:12 +00:00
def data_channel_keep_alive_watchdog ( self ) - > None :
2022-03-06 16:23:04 +00:00
"""
watchdog which checks if we are running into a connection timeout
2022-05-09 00:41:49 +00:00
DATA CHANNEL
2022-03-06 16:23:04 +00:00
"""
2022-01-07 10:25:28 +00:00
# and not static.ARQ_SEND_KEEP_ALIVE:
2022-05-23 00:54:12 +00:00
if static . ARQ_STATE and static . TNC_STATE == " BUSY " :
2022-12-12 11:28:52 +00:00
threading . Event ( ) . wait ( 0.01 )
2022-05-23 00:54:12 +00:00
if (
2022-09-08 13:47:23 +00:00
self . data_channel_last_received + self . transmission_timeout
> time . time ( )
2022-05-23 00:54:12 +00:00
) :
2022-12-11 12:07:56 +00:00
2023-01-04 10:04:10 +00:00
timeleft = int ( ( self . data_channel_last_received + self . transmission_timeout ) - time . time ( ) )
if timeleft % 10 == 0 :
self . log . debug ( " Time left until timeout " , seconds = timeleft )
# threading.Event().wait(5)
2022-05-19 20:15:24 +00:00
# print(self.data_channel_last_received + self.transmission_timeout - time.time())
# pass
2022-01-07 10:25:28 +00:00
else :
2022-05-23 02:13:43 +00:00
# Clear the timeout timestamp
2022-01-07 10:25:28 +00:00
self . data_channel_last_received = 0
2022-05-23 00:54:12 +00:00
self . log . info (
" [TNC] DATA [ "
+ str ( self . mycallsign , " UTF-8 " )
+ " ]<<T>>[ "
+ str ( static . DXCALLSIGN , " UTF-8 " )
+ " ] "
)
2022-06-05 17:11:09 +00:00
self . send_data_to_socket_queue (
2022-06-06 18:50:36 +00:00
freedata = " tnc-message " ,
2022-06-05 17:11:09 +00:00
arq = " transmission " ,
status = " failed " ,
2022-06-06 19:07:41 +00:00
uuid = self . transmission_uuid ,
2022-12-05 07:23:18 +00:00
mycallsign = str ( self . mycallsign , ' UTF-8 ' ) ,
dxcallsign = str ( self . dxcallsign , ' UTF-8 ' ) ,
2022-06-05 17:11:09 +00:00
)
2022-05-23 00:54:12 +00:00
self . arq_cleanup ( )
2022-05-09 00:41:49 +00:00
2022-05-23 00:54:12 +00:00
def arq_session_keep_alive_watchdog ( self ) - > None :
2022-03-06 16:23:04 +00:00
"""
watchdog which checks if we are running into a connection timeout
ARQ SESSION
"""
2022-05-23 00:54:12 +00:00
if (
2022-09-08 13:47:23 +00:00
static . ARQ_SESSION
and static . TNC_STATE == " BUSY "
and not self . arq_file_transfer
2022-05-23 00:54:12 +00:00
) :
2022-03-04 15:50:32 +00:00
if self . arq_session_last_received + self . arq_session_timeout > time . time ( ) :
2022-12-12 11:28:52 +00:00
threading . Event ( ) . wait ( 0.01 )
2022-03-04 15:50:32 +00:00
else :
2022-05-23 00:54:12 +00:00
self . log . info (
" [TNC] SESSION [ "
+ str ( self . mycallsign , " UTF-8 " )
+ " ]<<T>>[ "
2022-12-04 12:04:29 +00:00
+ str ( self . dxcallsign , " UTF-8 " )
2022-05-23 00:54:12 +00:00
+ " ] "
)
2022-06-05 17:11:09 +00:00
self . send_data_to_socket_queue (
2022-06-06 18:50:36 +00:00
freedata = " tnc-message " ,
2022-06-05 17:11:09 +00:00
arq = " session " ,
status = " failed " ,
reason = " timeout " ,
2022-12-04 12:04:29 +00:00
mycallsign = str ( self . mycallsign , ' UTF-8 ' ) ,
dxcallsign = str ( self . dxcallsign , ' UTF-8 ' ) ,
2022-06-05 17:11:09 +00:00
)
2022-03-04 15:50:32 +00:00
self . close_session ( )
2022-05-09 00:41:49 +00:00
2022-05-23 00:54:12 +00:00
def heartbeat ( self ) - > None :
2022-03-06 16:23:04 +00:00
"""
2022-05-28 15:52:05 +00:00
Heartbeat thread which auto pauses and resumes the heartbeat signal when in an arq session
2022-03-06 16:23:04 +00:00
"""
2022-05-28 02:17:15 +00:00
while True :
2022-12-12 11:28:52 +00:00
threading . Event ( ) . wait ( 0.01 )
2022-10-12 10:54:37 +00:00
# additional check for smoother stopping if heartbeat transmission
while not self . arq_file_transfer :
2022-12-12 11:28:52 +00:00
threading . Event ( ) . wait ( 0.01 )
2022-10-12 10:54:37 +00:00
if (
static . ARQ_SESSION
and self . IS_ARQ_SESSION_MASTER
and static . ARQ_SESSION_STATE == " connected "
2022-11-02 14:29:22 +00:00
# and not self.arq_file_transfer
2022-10-12 10:54:37 +00:00
) :
2022-12-12 11:28:52 +00:00
threading . Event ( ) . wait ( 1 )
2022-10-12 10:54:37 +00:00
self . transmit_session_heartbeat ( )
2022-12-12 11:28:52 +00:00
threading . Event ( ) . wait ( 2 )
2022-05-09 00:41:49 +00:00
2022-05-23 00:54:12 +00:00
def send_test_frame ( self ) - > None :
2022-06-24 13:39:56 +00:00
""" Send an empty test frame """
2023-01-06 16:02:21 +00:00
test_frame = bytearray ( 126 )
test_frame [ : 1 ] = bytes ( [ FR_TYPE . TEST_FRAME . value ] )
2022-06-24 13:39:56 +00:00
self . enqueue_frame_for_tx (
2023-01-06 16:02:21 +00:00
frame_to_tx = [ test_frame ] , c2_mode = FREEDV_MODE . datac3 . value
2022-06-24 13:39:56 +00:00
)
2022-12-26 09:25:50 +00:00
def save_data_to_folder ( self ,
transmission_uuid ,
timestamp ,
mycallsign ,
dxcallsign ,
dxgrid ,
data_frame
) :
2022-12-26 09:49:37 +00:00
"""
Save received data to folder
Also supports chat messages
"""
2022-12-26 09:25:50 +00:00
2022-12-26 09:49:37 +00:00
try :
2022-12-26 09:25:50 +00:00
2022-12-26 09:49:37 +00:00
self . log . info ( " [TNC] ARQ | RX | saving data to folder " )
2022-12-26 09:35:58 +00:00
2022-12-26 09:49:37 +00:00
mycallsign = str ( mycallsign , " UTF-8 " )
dxcallsign = str ( dxcallsign , " UTF-8 " )
2022-12-26 09:25:50 +00:00
folder_path = " received "
if not os . path . exists ( folder_path ) :
os . makedirs ( folder_path )
callsign_path = f " { mycallsign } _ { dxcallsign } "
if not os . path . exists ( f " { folder_path } / { callsign_path } " ) :
os . makedirs ( f " { folder_path } / { callsign_path } " )
2022-12-28 10:59:00 +00:00
split_char = b " \0 ; \1 ; "
2022-12-28 17:03:05 +00:00
n_objects = 9
2022-12-26 09:49:37 +00:00
decoded_data = data_frame . split ( split_char )
2022-12-28 16:37:50 +00:00
# if we have a false positive in case our split_char is available in data
# lets stick the data together, so we are not loosing it
if len ( decoded_data ) > n_objects :
2022-12-28 22:47:13 +00:00
file_data = b ' ' . join ( decoded_data [ n_objects : ] )
2022-12-28 22:21:39 +00:00
# slice is crashing nuitka
# decoded_data = [*decoded_data[:n_objects], file_data]
decoded_data = decoded_data [ : n_objects ] + [ file_data ]
2022-12-26 09:49:37 +00:00
if decoded_data [ 0 ] in [ b ' m ' ] :
2022-12-27 22:30:15 +00:00
checksum_delivered = str ( decoded_data [ 2 ] , " utf-8 " ) . lower ( )
2022-12-27 21:57:54 +00:00
# transmission_uuid = decoded_data[3]
2022-12-28 11:40:10 +00:00
message = decoded_data [ 5 ]
filename = decoded_data [ 6 ]
# filetype = decoded_data[7]
# timestamp = decoded_data[4]
2022-12-28 10:32:33 +00:00
data = decoded_data [ 8 ]
2022-12-26 09:49:37 +00:00
else :
message = b ' '
2022-12-28 11:27:09 +00:00
filename = b ' '
2022-12-26 09:49:37 +00:00
2022-12-26 09:25:50 +00:00
# save file to folder
2022-12-26 09:35:58 +00:00
if filename not in [ b ' ' , b ' undefined ' ] :
2022-12-27 21:58:18 +00:00
# doing crc check
2022-12-27 22:02:52 +00:00
crc = helpers . get_crc_32 ( data ) . hex ( ) . lower ( )
2022-12-27 21:57:54 +00:00
validity = checksum_delivered == crc
2022-12-27 22:04:57 +00:00
self . log . info (
2022-12-27 21:57:54 +00:00
" [TNC] ARQ | RX | checking data crc " ,
crc_delivered = checksum_delivered ,
crc_calculated = crc ,
valid = validity ,
)
2022-12-26 09:35:58 +00:00
filename = str ( filename , " UTF-8 " )
filename_complex = f " { timestamp } _ { transmission_uuid } _ { filename } "
with open ( f " { folder_path } / { callsign_path } / { filename_complex } " , " wb " ) as file :
file . write ( data )
if message not in [ b ' ' , b ' undefined ' ] :
# save message to folder
message_name = f " { timestamp } _ { transmission_uuid } _msg.txt "
with open ( f " { folder_path } / { callsign_path } / { message_name } " , " wb " ) as file :
file . write ( message )
2022-12-26 09:25:50 +00:00
except Exception as e :
2022-12-26 09:49:37 +00:00
self . log . error ( " [TNC] error saving data to folder " , e = e )