Crash_Override/FreeDATA
1
0
Fork 0
mirror of https://github.com/DJ2LS/FreeDATA synced 2024-05-14 08:04:33 +00:00
Code Issues Packages Projects Releases Wiki Activity

Merge branch 'main' into refactor_N2KIQ_data_enums

Browse source
This commit is contained in:
Paul Kronenwetter 2022-06-24 10:03:42 -04:00 committed by GitHub
parent 1d760d61af c8eaad9ecd
commit 5922c722ad
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
3 changed files with 73 additions and 70 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

7
CMakeLists.txt
View file

@ -64,6 +64,13 @@ add_test(NAME datac0_frames
python3 test_datac0.py") python3 test_datac0.py")
set_tests_properties(datac0_frames PROPERTIES PASS_REGULAR_EXPRESSION "errors: 0") set_tests_properties(datac0_frames PROPERTIES PASS_REGULAR_EXPRESSION "errors: 0")
add_test(NAME datac0_frames_negative
COMMAND sh -c "export LD_LIBRARY_PATH=${CODEC2_BUILD_DIR}/src;
export PYTHONPATH=../tnc;
cd ${CMAKE_CURRENT_SOURCE_DIR}/test;
python3 test_datac0_negative.py")
set_tests_properties(datac0_frames_negative PROPERTIES PASS_REGULAR_EXPRESSION "errors: 0")
add_test(NAME helper_routines add_test(NAME helper_routines
COMMAND sh -c "export LD_LIBRARY_PATH=${CODEC2_BUILD_DIR}/src; COMMAND sh -c "export LD_LIBRARY_PATH=${CODEC2_BUILD_DIR}/src;
export PYTHONPATH=../tnc; export PYTHONPATH=../tnc;

1
tnc/codec2.py
View file

@ -24,7 +24,6 @@ class FREEDV_MODE(Enum):
Enumeration for codec2 modes and names Enumeration for codec2 modes and names
""" """
allmodes = 255
datac0 = 14 datac0 = 14
datac1 = 10 datac1 = 10
datac3 = 12 datac3 = 12

135
tnc/data_handler.py
View file

@ -24,6 +24,7 @@ import sock
import static import static
import structlog import structlog
import ujson as json import ujson as json
from codec2 import FREEDV_MODE
from exceptions import NoCallsign from exceptions import NoCallsign
from static import FRAME_TYPE as FR_TYPE from static import FRAME_TYPE as FR_TYPE
@ -85,17 +86,15 @@ class DATA:
# List of codec2 modes to use in "low bandwidth" mode. # List of codec2 modes to use in "low bandwidth" mode.
self.mode_list_low_bw = [ self.mode_list_low_bw = [
codec2.FREEDV_MODE.datac0.value, FREEDV_MODE.datac3.value,
codec2.FREEDV_MODE.datac3.value,
] ]
# List for time to wait for corresponding mode in seconds # List for time to wait for corresponding mode in seconds
self.time_list_low_bw = [3, 7] self.time_list_low_bw = [3, 7]
# List of codec2 modes to use in "high bandwidth" mode. # List of codec2 modes to use in "high bandwidth" mode.
self.mode_list_high_bw = [ self.mode_list_high_bw = [
codec2.FREEDV_MODE.datac0.value, FREEDV_MODE.datac3.value,
codec2.FREEDV_MODE.datac3.value, FREEDV_MODE.datac1.value,
codec2.FREEDV_MODE.datac1.value,
] ]
# List for time to wait for corresponding mode in seconds # List for time to wait for corresponding mode in seconds
self.time_list_high_bw = [3, 7, 8, 30] self.time_list_high_bw = [3, 7, 8, 30]
@ -372,7 +371,7 @@ class DATA:
def enqueue_frame_for_tx( def enqueue_frame_for_tx(
self, self,
frame_to_tx: bytearray, frame_to_tx: bytearray,
c2_mode=codec2.FREEDV_MODE.datac0.value, c2_mode=FREEDV_MODE.datac0.value,
copies=1, copies=1,
repeat_delay=0, repeat_delay=0,
) -> None: ) -> None:
@ -388,7 +387,7 @@ class DATA:
:param repeat_delay: Delay time before sending repeat frame, defaults to 0 :param repeat_delay: Delay time before sending repeat frame, defaults to 0
:type repeat_delay: int, optional :type repeat_delay: int, optional
""" """
self.log.debug("[TNC] enqueue_frame_for_tx", c2_mode=c2_mode) self.log.debug("[TNC] enqueue_frame_for_tx", c2_mode=FREEDV_MODE(c2_mode).name)
# Set the TRANSMITTING flag before adding an object to the transmit queue # Set the TRANSMITTING flag before adding an object to the transmit queue
# TODO: This is not that nice, we could improve this somehow # TODO: This is not that nice, we could improve this somehow
@ -805,8 +804,8 @@ class DATA:
self.log.warning( self.log.warning(
"[TNC] ARQ | RX | DATA FRAME NOT SUCCESSFULLY RECEIVED!", "[TNC] ARQ | RX | DATA FRAME NOT SUCCESSFULLY RECEIVED!",
e="wrong crc", e="wrong crc",
expected=data_frame_crc, expected=data_frame_crc.hex(),
received=data_frame_crc_received, received=data_frame_crc_received.hex(),
overflows=static.BUFFER_OVERFLOW_COUNTER, overflows=static.BUFFER_OVERFLOW_COUNTER,
) )
@ -859,7 +858,11 @@ class DATA:
bytesperminute=static.ARQ_BYTES_PER_MINUTE, bytesperminute=static.ARQ_BYTES_PER_MINUTE,
) )
self.log.info("[TNC] | TX | DATACHANNEL", mode=mode, Bytes=static.TOTAL_BYTES) self.log.info(
"[TNC] | TX | DATACHANNEL",
mode=FREEDV_MODE(mode).name,
Bytes=static.TOTAL_BYTES,
)
# Compress data frame # Compress data frame
data_frame_compressed = zlib.compress(data_out) data_frame_compressed = zlib.compress(data_out)
@ -875,7 +878,7 @@ class DATA:
# Append a crc at the beginning and end of file indicators # Append a crc at the beginning and end of file indicators
frame_payload_crc = helpers.get_crc_32(data_out) frame_payload_crc = helpers.get_crc_32(data_out)
self.log.debug("[TNC] frame payload CRC:", crc=frame_payload_crc) self.log.debug("[TNC] frame payload CRC:", crc=frame_payload_crc.hex())
# Assemble the data frame # Assemble the data frame
data_out = ( data_out = (
@ -894,39 +897,35 @@ class DATA:
while not self.data_frame_ack_received and static.ARQ_STATE: while not self.data_frame_ack_received and static.ARQ_STATE:
# we have TX_N_MAX_RETRIES_PER_BURST attempts for sending a burst # we have TX_N_MAX_RETRIES_PER_BURST attempts for sending a burst
for self.tx_n_retry_of_burst in range(TX_N_MAX_RETRIES_PER_BURST): for self.tx_n_retry_of_burst in range(TX_N_MAX_RETRIES_PER_BURST):
# AUTO MODE SELECTION data_mode = mode
# mode 255 == AUTO MODE self.log.debug("[TNC] FIXED MODE:", mode=FREEDV_MODE(data_mode).name)
# force usage of selected mode
if mode != 255:
data_mode = mode
self.log.debug("[TNC] FIXED MODE:", mode=data_mode)
else:
# 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: # we are doing a modulo check of transmission retries of the actual burst
# self.speed_level += 1 # every 2nd retry which fails, decreases speedlevel by 1.
# self.speed_level = max(self.speed_level + 1, len(self.mode_list) - 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)
# Bound speed level to: # if self.tx_n_retry_of_burst <= 1:
# - minimum of either the speed or the length of mode list - 1 # self.speed_level += 1
# - maximum of either the speed or zero # self.speed_level = max(self.speed_level + 1, len(self.mode_list) - 1)
self.speed_level = min(self.speed_level, len(self.mode_list) - 1)
self.speed_level = max(self.speed_level, 0)
static.ARQ_SPEED_LEVEL = self.speed_level
data_mode = self.mode_list[self.speed_level]
self.log.debug( # Bound speed level to:
"[TNC] Speed-level:", # - minimum of either the speed or the length of mode list - 1
level=self.speed_level, # - maximum of either the speed or zero
retry=self.tx_n_retry_of_burst, self.speed_level = min(self.speed_level, len(self.mode_list) - 1)
mode=data_mode, self.speed_level = max(self.speed_level, 0)
) static.ARQ_SPEED_LEVEL = self.speed_level
data_mode = self.mode_list[self.speed_level]
self.log.debug(
"[TNC] Speed-level:",
level=self.speed_level,
retry=self.tx_n_retry_of_burst,
mode=FREEDV_MODE(data_mode).name,
)
# Payload information # Payload information
payload_per_frame = modem.get_bytes_per_frame(data_mode) - 2 payload_per_frame = modem.get_bytes_per_frame(data_mode) - 2
@ -967,7 +966,7 @@ class DATA:
self.log.debug("[TNC] tempbuffer:", tempbuffer=tempbuffer) self.log.debug("[TNC] tempbuffer:", tempbuffer=tempbuffer)
self.log.info( self.log.info(
"[TNC] ARQ | TX | FRAMES", "[TNC] ARQ | TX | FRAMES",
mode=data_mode, mode=FREEDV_MODE(data_mode).name,
fpb=TX_N_FRAMES_PER_BURST, fpb=TX_N_FRAMES_PER_BURST,
retry=self.tx_n_retry_of_burst, retry=self.tx_n_retry_of_burst,
) )
@ -1135,7 +1134,11 @@ class DATA:
self.burst_ack_snr = int.from_bytes(bytes(data_in[7:8]), "big") self.burst_ack_snr = int.from_bytes(bytes(data_in[7:8]), "big")
self.speed_level = int.from_bytes(bytes(data_in[8:9]), "big") self.speed_level = int.from_bytes(bytes(data_in[8:9]), "big")
static.ARQ_SPEED_LEVEL = self.speed_level static.ARQ_SPEED_LEVEL = self.speed_level
self.log.debug("[TNC] burst_ack_received:", speed_level=self.speed_level) self.log.debug(
"[TNC] burst_ack_received:",
speed_level=self.speed_level,
c2_mode=FREEDV_MODE(self.mode_list[self.speed_level]).name,
)
# Reset burst nack counter # Reset burst nack counter
self.burst_nack_counter = 0 self.burst_nack_counter = 0
@ -1173,7 +1176,11 @@ class DATA:
self.speed_level = int.from_bytes(bytes(data_in[8:9]), "big") self.speed_level = int.from_bytes(bytes(data_in[8:9]), "big")
static.ARQ_SPEED_LEVEL = self.speed_level static.ARQ_SPEED_LEVEL = self.speed_level
self.burst_nack_counter += 1 self.burst_nack_counter += 1
self.log.debug("[TNC] burst_nack_received:", speed_level=self.speed_level) self.log.debug(
"[TNC] burst_nack_received:",
speed_level=self.speed_level,
c2_mode=FREEDV_MODE(self.mode_list[self.speed_level]).name,
)
def frame_ack_received(self): def frame_ack_received(self):
"""Received an ACK for a transmitted frame""" """Received an ACK for a transmitted frame"""
@ -1856,13 +1863,9 @@ class DATA:
self.log.info("[TNC] ENABLE FSK", state=static.ENABLE_FSK) self.log.info("[TNC] ENABLE FSK", state=static.ENABLE_FSK)
if static.ENABLE_FSK: if static.ENABLE_FSK:
self.enqueue_frame_for_tx( self.enqueue_frame_for_tx(ping_frame, c2_mode=FREEDV_MODE.fsk_ldpc_0.value)
ping_frame, c2_mode=codec2.FREEDV_MODE.fsk_ldpc_0.value
)
else: else:
self.enqueue_frame_for_tx( self.enqueue_frame_for_tx(ping_frame, c2_mode=FREEDV_MODE.datac0.value)
ping_frame, c2_mode=codec2.FREEDV_MODE.datac0.value
)
def received_ping(self, data_in: bytes) -> None: def received_ping(self, data_in: bytes) -> None:
""" """
@ -1917,13 +1920,9 @@ class DATA:
self.log.info("[TNC] ENABLE FSK", state=static.ENABLE_FSK) self.log.info("[TNC] ENABLE FSK", state=static.ENABLE_FSK)
if static.ENABLE_FSK: if static.ENABLE_FSK:
self.enqueue_frame_for_tx( self.enqueue_frame_for_tx(ping_frame, c2_mode=FREEDV_MODE.fsk_ldpc_0.value)
ping_frame, c2_mode=codec2.FREEDV_MODE.fsk_ldpc_0.value
)
else: else:
self.enqueue_frame_for_tx( self.enqueue_frame_for_tx(ping_frame, c2_mode=FREEDV_MODE.datac0.value)
ping_frame, c2_mode=codec2.FREEDV_MODE.datac0.value
)
def received_ping_ack(self, data_in: bytes) -> None: def received_ping_ack(self, data_in: bytes) -> None:
""" """
@ -2042,7 +2041,7 @@ class DATA:
if static.ENABLE_FSK: if static.ENABLE_FSK:
self.enqueue_frame_for_tx( self.enqueue_frame_for_tx(
beacon_frame, beacon_frame,
c2_mode=codec2.FREEDV_MODE.fsk_ldpc_0.value, c2_mode=FREEDV_MODE.fsk_ldpc_0.value,
) )
else: else:
self.enqueue_frame_for_tx(beacon_frame) self.enqueue_frame_for_tx(beacon_frame)
@ -2120,9 +2119,7 @@ class DATA:
self.log.debug("[TNC] CQ Frame:", data=[cq_frame]) self.log.debug("[TNC] CQ Frame:", data=[cq_frame])
if static.ENABLE_FSK: if static.ENABLE_FSK:
self.enqueue_frame_for_tx( self.enqueue_frame_for_tx(cq_frame, c2_mode=FREEDV_MODE.fsk_ldpc_0.value)
cq_frame, c2_mode=codec2.FREEDV_MODE.fsk_ldpc_0.value
)
else: else:
self.enqueue_frame_for_tx(cq_frame) self.enqueue_frame_for_tx(cq_frame)
@ -2192,9 +2189,7 @@ class DATA:
self.log.info("[TNC] ENABLE FSK", state=static.ENABLE_FSK) self.log.info("[TNC] ENABLE FSK", state=static.ENABLE_FSK)
if static.ENABLE_FSK: if static.ENABLE_FSK:
self.enqueue_frame_for_tx( self.enqueue_frame_for_tx(qrv_frame, c2_mode=FREEDV_MODE.fsk_ldpc_0.value)
qrv_frame, c2_mode=codec2.FREEDV_MODE.fsk_ldpc_0.value
)
else: else:
self.enqueue_frame_for_tx(qrv_frame) self.enqueue_frame_for_tx(qrv_frame)
@ -2410,16 +2405,16 @@ class DATA:
""" """
# set modes we want to listen to # set modes we want to listen to
if mode == codec2.FREEDV_MODE.datac1.value: if mode == FREEDV_MODE.datac1.value:
modem.RECEIVE_DATAC1 = True modem.RECEIVE_DATAC1 = True
self.log.debug("[TNC] Changing listening data mode", mode="datac1") self.log.debug("[TNC] Changing listening data mode", mode="datac1")
elif mode == codec2.FREEDV_MODE.datac3.value: elif mode == FREEDV_MODE.datac3.value:
modem.RECEIVE_DATAC3 = True modem.RECEIVE_DATAC3 = True
self.log.debug("[TNC] Changing listening data mode", mode="datac3") self.log.debug("[TNC] Changing listening data mode", mode="datac3")
elif mode == codec2.FREEDV_MODE.fsk_ldpc_1.value: elif mode == FREEDV_MODE.fsk_ldpc_1.value:
modem.RECEIVE_FSK_LDPC_1 = True modem.RECEIVE_FSK_LDPC_1 = True
self.log.debug("[TNC] Changing listening data mode", mode="fsk_ldpc_1") self.log.debug("[TNC] Changing listening data mode", mode="fsk_ldpc_1")
elif mode == codec2.FREEDV_MODE.allmodes.value: else:
modem.RECEIVE_DATAC1 = True modem.RECEIVE_DATAC1 = True
modem.RECEIVE_DATAC3 = True modem.RECEIVE_DATAC3 = True
modem.RECEIVE_FSK_LDPC_1 = True modem.RECEIVE_FSK_LDPC_1 = True
@ -2568,5 +2563,7 @@ class DATA:
time.sleep(2) time.sleep(2)
def send_test_frame(self) -> None: def send_test_frame(self) -> None:
"""Send a test (type 12) frame""" """Send an empty test frame"""
self.enqueue_frame_for_tx(frame_to_tx=bytearray(126), c2_mode=12) self.enqueue_frame_for_tx(
frame_to_tx=bytearray(126), c2_mode=FREEDV_MODE.datac3.value
)