388 lines
17 KiB
Python
388 lines
17 KiB
Python
# target_simulator/gui/sfp_debug_window.py
|
|
"""
|
|
Provides a Toplevel window for debugging the SFP transport layer.
|
|
This version uses a sampling approach to handle high-frequency data streams
|
|
without overwhelming the GUI thread.
|
|
"""
|
|
|
|
import tkinter as tk
|
|
from tkinter import ttk, scrolledtext
|
|
import logging
|
|
import threading
|
|
import ctypes
|
|
import time
|
|
from typing import Dict, Callable, Optional, Any
|
|
|
|
# Third-party imports for image display
|
|
try:
|
|
from PIL import Image, ImageTk
|
|
import numpy as np
|
|
import cv2
|
|
_IMAGE_LIBS_AVAILABLE = True
|
|
except ImportError:
|
|
_IMAGE_LIBS_AVAILABLE = False
|
|
|
|
# Imports from the project structure
|
|
from target_simulator.core.sfp_transport import SfpTransport, PayloadHandler
|
|
from target_simulator.core.sfp_structures import ImageLeaderData, SFPHeader
|
|
|
|
# --- Helper Class for Routing and Buffering Payloads ---
|
|
|
|
class DebugPayloadRouter:
|
|
"""
|
|
A router that buffers the last received payload for each flow,
|
|
allowing the GUI to sample the data at a lower frequency.
|
|
This class is thread-safe.
|
|
"""
|
|
def __init__(self):
|
|
self._log_prefix = "[DebugPayloadRouter]"
|
|
self._lock = threading.Lock()
|
|
# Buffer to store the last received payload for each flow type
|
|
self._latest_payloads: Dict[str, bytearray] = {}
|
|
logging.info(f"{self._log_prefix} Initialized.")
|
|
|
|
def get_handlers(self) -> Dict[int, PayloadHandler]:
|
|
"""Returns handlers that update the internal last-payload buffer."""
|
|
return {
|
|
ord('M'): lambda payload: self._update_last_payload('MFD', payload),
|
|
ord('S'): lambda payload: self._update_last_payload('SAR', payload),
|
|
ord('B'): lambda payload: self._update_last_payload('BIN', payload),
|
|
ord('J'): lambda payload: self._update_last_payload('JSON', payload),
|
|
}
|
|
|
|
def _update_last_payload(self, flow_id: str, payload: bytearray):
|
|
"""Thread-safely stores the latest payload for a given flow."""
|
|
with self._lock:
|
|
self._latest_payloads[flow_id] = payload
|
|
|
|
def get_and_clear_latest_payloads(self) -> Dict[str, bytearray]:
|
|
"""
|
|
Thread-safely retrieves all new payloads received since the last call
|
|
and clears the internal buffer.
|
|
|
|
Returns:
|
|
Dict[str, bytearray]: A dictionary of the latest payload for each flow.
|
|
"""
|
|
with self._lock:
|
|
# Atomically swap the buffer with an empty one
|
|
new_payloads = self._latest_payloads
|
|
self._latest_payloads = {}
|
|
return new_payloads
|
|
|
|
# --- Main Debug Window Class ---
|
|
|
|
class SfpDebugWindow(tk.Toplevel):
|
|
"""A self-contained SFP debugging and packet inspection window."""
|
|
|
|
GUI_POLL_INTERVAL_MS = 250 # Poll for new data 4 times per second
|
|
|
|
def __init__(self, master):
|
|
super().__init__(master)
|
|
self.title("SFP Packet Inspector")
|
|
self.geometry("900x700")
|
|
self.transient(master)
|
|
|
|
self.logger = logging.getLogger(__name__)
|
|
self.sfp_transport: Optional[SfpTransport] = None
|
|
self.payload_router = DebugPayloadRouter()
|
|
|
|
self.mfd_photo: Optional[ImageTk.PhotoImage] = None
|
|
self.sar_photo: Optional[ImageTk.PhotoImage] = None
|
|
|
|
# Read image display size from settings (general.image_display.size)
|
|
try:
|
|
gm = getattr(master, "config_manager", None)
|
|
general = gm.get_general_settings() if gm else {}
|
|
img_conf = general.get("image_display", {})
|
|
self.image_area_size = int(img_conf.get("size", 150))
|
|
except Exception:
|
|
self.image_area_size = 150
|
|
|
|
self._create_widgets()
|
|
self.protocol("WM_DELETE_WINDOW", self._on_close)
|
|
|
|
self.after(self.GUI_POLL_INTERVAL_MS, self._process_latest_payloads)
|
|
|
|
def _create_widgets(self):
|
|
# --- Connection Controls (unchanged) ---
|
|
conn_frame = ttk.LabelFrame(self, text="Connection", padding=5)
|
|
conn_frame.pack(side=tk.TOP, fill=tk.X, padx=5, pady=5)
|
|
ttk.Label(conn_frame, text="IP:").pack(side=tk.LEFT, padx=(5, 2))
|
|
self.ip_var = tk.StringVar(value="127.0.0.1")
|
|
ttk.Entry(conn_frame, textvariable=self.ip_var, width=15).pack(side=tk.LEFT)
|
|
ttk.Label(conn_frame, text="Port:").pack(side=tk.LEFT, padx=(10, 2))
|
|
self.port_var = tk.StringVar(value="55556")
|
|
ttk.Entry(conn_frame, textvariable=self.port_var, width=7).pack(side=tk.LEFT)
|
|
self.connect_btn = ttk.Button(conn_frame, text="Connect", command=self._on_connect)
|
|
self.connect_btn.pack(side=tk.LEFT, padx=(10, 5))
|
|
self.disconnect_btn = ttk.Button(conn_frame, text="Disconnect", command=self._on_disconnect, state=tk.DISABLED)
|
|
self.disconnect_btn.pack(side=tk.LEFT, padx=5)
|
|
# Button to configure image display size
|
|
self.image_size_btn = ttk.Button(conn_frame, text="Image size...", command=self._open_image_size_dialog)
|
|
self.image_size_btn.pack(side=tk.LEFT, padx=5)
|
|
|
|
# --- Data Display Notebook (unchanged) ---
|
|
self.notebook = ttk.Notebook(self)
|
|
self.notebook.pack(fill=tk.BOTH, expand=True, padx=5, pady=5)
|
|
self.log_tab = scrolledtext.ScrolledText(self.notebook, state=tk.DISABLED, wrap=tk.WORD, font=("Consolas", 9))
|
|
self.notebook.add(self.log_tab, text="Raw Log")
|
|
if _IMAGE_LIBS_AVAILABLE:
|
|
self.mfd_tab = self._create_image_tab("MFD Image")
|
|
self.notebook.add(self.mfd_tab["frame"], text="MFD Image")
|
|
self.sar_tab = self._create_image_tab("SAR Image")
|
|
self.notebook.add(self.sar_tab["frame"], text="SAR Image")
|
|
self.bin_tab = scrolledtext.ScrolledText(self.notebook, state=tk.DISABLED, wrap=tk.NONE, font=("Consolas", 10))
|
|
self.notebook.add(self.bin_tab, text="Binary (Hex)")
|
|
self.json_tab = scrolledtext.ScrolledText(self.notebook, state=tk.DISABLED, wrap=tk.WORD, font=("Consolas", 10))
|
|
self.notebook.add(self.json_tab, text="JSON")
|
|
|
|
def _create_image_tab(self, title: str) -> Dict:
|
|
frame = ttk.Frame(self.notebook)
|
|
# Fixed-size container to keep UI tidy. Image area will be size x size px.
|
|
image_container = ttk.Frame(frame, width=self.image_area_size, height=self.image_area_size, relief=tk.SUNKEN)
|
|
image_container.pack(pady=5, padx=5)
|
|
image_container.pack_propagate(False)
|
|
image_label = ttk.Label(image_container, text=f"Waiting for {title}...", anchor=tk.CENTER)
|
|
image_label.pack(fill=tk.BOTH, expand=True)
|
|
hex_view = scrolledtext.ScrolledText(frame, height=8, state=tk.DISABLED, wrap=tk.NONE, font=("Consolas", 9))
|
|
hex_view.pack(fill=tk.BOTH, expand=True, pady=5, padx=5)
|
|
return {"frame": frame, "image_label": image_label, "hex_view": hex_view, "image_container": image_container}
|
|
|
|
def _open_image_size_dialog(self):
|
|
"""Open a small dialog to change the image display size and persist it to settings."""
|
|
dlg = tk.Toplevel(self)
|
|
dlg.title("Image Size")
|
|
dlg.transient(self)
|
|
dlg.grab_set()
|
|
ttk.Label(dlg, text="Image area size (px):").pack(padx=10, pady=(10, 2))
|
|
size_var = tk.StringVar(value=str(self.image_area_size))
|
|
entry = ttk.Entry(dlg, textvariable=size_var, width=8)
|
|
entry.pack(padx=10, pady=(0, 10))
|
|
|
|
btn_frame = ttk.Frame(dlg)
|
|
btn_frame.pack(padx=10, pady=(0, 10))
|
|
|
|
def on_save():
|
|
try:
|
|
v = int(size_var.get())
|
|
if v <= 0:
|
|
raise ValueError()
|
|
except Exception:
|
|
message = "Please enter a positive integer for image size."
|
|
try:
|
|
tk.messagebox.showerror("Invalid value", message, parent=dlg)
|
|
except Exception:
|
|
pass
|
|
return
|
|
|
|
# Apply to current window
|
|
self.image_area_size = v
|
|
# Update existing containers if present
|
|
for tab in (getattr(self, 'mfd_tab', None), getattr(self, 'sar_tab', None)):
|
|
if tab and 'image_container' in tab:
|
|
tab['image_container'].config(width=v, height=v)
|
|
|
|
# Persist to settings via ConfigManager on master (if available)
|
|
gm = getattr(self.master, 'config_manager', None)
|
|
if gm:
|
|
general = gm.get_general_settings() or {}
|
|
image_display = general.get('image_display', {})
|
|
image_display['size'] = v
|
|
general['image_display'] = image_display
|
|
gm.save_general_settings(general)
|
|
|
|
dlg.destroy()
|
|
|
|
def on_cancel():
|
|
dlg.destroy()
|
|
|
|
ttk.Button(btn_frame, text="Cancel", command=on_cancel).pack(side=tk.RIGHT, padx=(0, 5))
|
|
ttk.Button(btn_frame, text="Save", command=on_save).pack(side=tk.RIGHT)
|
|
|
|
def _on_connect(self):
|
|
ip = self.ip_var.get()
|
|
try:
|
|
port = int(self.port_var.get())
|
|
except ValueError:
|
|
self._log_to_widget("ERROR: Invalid port number.", "ERROR")
|
|
return
|
|
self._log_to_widget(f"Attempting to connect to {ip}:{port}...")
|
|
ack_config = {ord('M'): 32, ord('S'): 16}
|
|
self.sfp_transport = SfpTransport(
|
|
host=ip, port=port,
|
|
payload_handlers=self.payload_router.get_handlers(),
|
|
ack_config=ack_config
|
|
)
|
|
if self.sfp_transport.start():
|
|
self._log_to_widget("Connection successful. Listening for packets...", "INFO")
|
|
self.connect_btn.config(state=tk.DISABLED)
|
|
self.disconnect_btn.config(state=tk.NORMAL)
|
|
else:
|
|
self._log_to_widget("Connection failed. Check IP/Port and logs.", "ERROR")
|
|
self.sfp_transport = None
|
|
|
|
def _on_disconnect(self):
|
|
if self.sfp_transport:
|
|
self._log_to_widget("Disconnecting...", "INFO")
|
|
self.sfp_transport.shutdown()
|
|
self.sfp_transport = None
|
|
self.connect_btn.config(state=tk.NORMAL)
|
|
self.disconnect_btn.config(state=tk.DISABLED)
|
|
self._log_to_widget("Disconnected.", "INFO")
|
|
|
|
def _on_close(self):
|
|
self.logger.info("SFP Debug Window closing.")
|
|
self._on_disconnect()
|
|
self.destroy()
|
|
|
|
def _process_latest_payloads(self):
|
|
"""GUI-thread loop to sample and display the latest payloads."""
|
|
# Get all new payloads that have arrived since the last check
|
|
new_payloads = self.payload_router.get_and_clear_latest_payloads()
|
|
|
|
# If there are new payloads, process them
|
|
if new_payloads:
|
|
self._log_to_widget(f"Processing {len(new_payloads)} new payload(s) for flows: {list(new_payloads.keys())}")
|
|
for flow_id, payload in new_payloads.items():
|
|
if flow_id == 'MFD' and _IMAGE_LIBS_AVAILABLE:
|
|
self._display_image_data(payload, self.mfd_tab, 'mfd_photo')
|
|
#self.notebook.select(self.mfd_tab["frame"])
|
|
elif flow_id == 'SAR' and _IMAGE_LIBS_AVAILABLE:
|
|
self._display_image_data(payload, self.sar_tab, 'sar_photo')
|
|
#self.notebook.select(self.sar_tab["frame"])
|
|
elif flow_id == 'BIN':
|
|
self._display_hex_data(payload, self.bin_tab)
|
|
#self.notebook.select(self.bin_tab)
|
|
elif flow_id == 'JSON':
|
|
self._display_json_data(payload, self.json_tab)
|
|
#self.notebook.select(self.json_tab)
|
|
|
|
# Reschedule the next check
|
|
self.after(self.GUI_POLL_INTERVAL_MS, self._process_latest_payloads)
|
|
|
|
def _display_image_data(self, payload: bytearray, tab_widgets: Dict[str, Any], photo_attr: str):
|
|
"""Parses an image payload and displays it. Now handles simplified structure."""
|
|
try:
|
|
if len(payload) < ctypes.sizeof(ImageLeaderData):
|
|
raise ValueError("Payload smaller than ImageLeaderData header.")
|
|
|
|
leader = ImageLeaderData.from_buffer(payload)
|
|
h, w, bpp = leader.HEADER_DATA.DY, leader.HEADER_DATA.DX, leader.HEADER_DATA.BPP
|
|
stride = leader.HEADER_DATA.STRIDE
|
|
offset = ctypes.sizeof(ImageLeaderData)
|
|
|
|
if not (h > 0 and w > 0 and bpp in [1, 2] and stride >= w):
|
|
raise ValueError(f"Invalid image dimensions in header: {w}x{h}, bpp={bpp}, stride={stride}")
|
|
|
|
if bpp == 1: dtype = np.uint8
|
|
else: dtype = np.uint16
|
|
|
|
expected_size = stride * h * bpp
|
|
if (offset + expected_size) > len(payload):
|
|
# Fallback for old format where PIXEL_TAG was at the end of leader
|
|
offset_fallback = ctypes.sizeof(SFPHeader) + ctypes.sizeof(ImageLeaderData) - ctypes.sizeof(leader.PIXEL_TAG)
|
|
if (offset_fallback + expected_size) <= len(payload):
|
|
offset = offset_fallback
|
|
else:
|
|
raise ValueError(f"Incomplete image data. Expected {expected_size} bytes, got {len(payload) - offset}")
|
|
|
|
pixel_data_view = np.ndarray(
|
|
shape=(h, stride),
|
|
dtype=dtype,
|
|
buffer=payload,
|
|
offset=offset
|
|
)
|
|
# Crop to actual width if stride is larger
|
|
image_data = pixel_data_view[:, :w]
|
|
|
|
display_img_8bit = cv2.normalize(image_data, None, 0, 255, cv2.NORM_MINMAX, cv2.CV_8U)
|
|
img_pil = Image.fromarray(cv2.cvtColor(display_img_8bit, cv2.COLOR_GRAY2RGB))
|
|
|
|
# Resize image to fit the label area while preserving aspect ratio
|
|
try:
|
|
# Use the fixed-size container (150x150) for resizing target
|
|
resized = self._resize_pil_to_label(img_pil, tab_widgets.get("image_container", tab_widgets["image_label"]))
|
|
except Exception:
|
|
# Fallback to original if anything goes wrong
|
|
resized = img_pil
|
|
|
|
photo = ImageTk.PhotoImage(image=resized)
|
|
tab_widgets["image_label"].config(image=photo, text="")
|
|
setattr(self, photo_attr, photo)
|
|
|
|
except Exception as e:
|
|
self.logger.error(f"Error parsing image payload: {e}")
|
|
tab_widgets["image_label"].config(image=None, text=f"Error parsing image:\n{e}")
|
|
setattr(self, photo_attr, None)
|
|
|
|
self._display_hex_data(payload, tab_widgets["hex_view"])
|
|
|
|
def _resize_pil_to_label(self, img: 'Image.Image', label_widget: ttk.Label) -> 'Image.Image':
|
|
"""Resize a PIL Image to fit within the current label widget size.
|
|
|
|
If the label widget has not been mapped yet (width/height == 1), this
|
|
will fallback to the image's original size.
|
|
"""
|
|
try:
|
|
# Get current allocated size for label (in pixels)
|
|
width = label_widget.winfo_width()
|
|
height = label_widget.winfo_height()
|
|
# If the widget isn't yet laid out, width/height may be 1 -> use geometry
|
|
if width <= 1 or height <= 1:
|
|
geom = self.geometry() # format: WxH+X+Y
|
|
if 'x' in geom:
|
|
parts = geom.split('+', 1)[0].split('x')
|
|
win_w, win_h = int(parts[0]), int(parts[1])
|
|
# Use a fraction of window size for image area
|
|
width = max(1, int(win_w * 0.9))
|
|
height = max(1, int(win_h * 0.6))
|
|
|
|
if width <= 1 or height <= 1:
|
|
return img
|
|
|
|
img_w, img_h = img.size
|
|
# Compute scale preserving aspect ratio
|
|
scale = min(width / img_w, height / img_h)
|
|
if scale >= 1.0:
|
|
return img
|
|
|
|
new_w = max(1, int(img_w * scale))
|
|
new_h = max(1, int(img_h * scale))
|
|
return img.resize((new_w, new_h), Image.LANCZOS)
|
|
except Exception:
|
|
return img
|
|
|
|
def _display_hex_data(self, payload: bytearray, widget: scrolledtext.ScrolledText):
|
|
hex_dump = self._format_hex_dump(payload)
|
|
widget.config(state=tk.NORMAL)
|
|
widget.delete("1.0", tk.END)
|
|
widget.insert("1.0", hex_dump)
|
|
widget.config(state=tk.DISABLED)
|
|
|
|
def _display_json_data(self, payload: bytearray, widget: scrolledtext.ScrolledText):
|
|
try:
|
|
import json
|
|
text = json.dumps(json.loads(payload.decode('utf-8')), indent=2)
|
|
except Exception as e:
|
|
text = f"--- FAILED TO PARSE JSON ---\n{e}\n\n--- RAW HEX DUMP ---\n"
|
|
text += self._format_hex_dump(payload)
|
|
widget.config(state=tk.NORMAL)
|
|
widget.delete("1.0", tk.END)
|
|
widget.insert("1.0", text)
|
|
widget.config(state=tk.DISABLED)
|
|
|
|
def _log_to_widget(self, message: str, level: str = "DEBUG"):
|
|
self.logger.info(message)
|
|
self.log_tab.config(state=tk.NORMAL)
|
|
self.log_tab.insert(tk.END, f"[{level}] {message}\n")
|
|
self.log_tab.config(state=tk.DISABLED)
|
|
self.log_tab.see(tk.END)
|
|
|
|
def _format_hex_dump(self, data: bytes, length=16) -> str:
|
|
lines = []
|
|
for i in range(0, len(data), length):
|
|
chunk = data[i:i+length]
|
|
hex_part = ' '.join(f'{b:02X}' for b in chunk)
|
|
ascii_part = ''.join(chr(b) if 32 <= b < 127 else '.' for b in chunk)
|
|
lines.append(f"{i:08X} {hex_part:<{length*3}} |{ascii_part}|")
|
|
return '\n'.join(lines) |