update requirements.txt, add DCS IPC listener, TelemManager refactoring, some code cleanups, fix some pylint warnings

Author: walmis

.pylintrc

@@ -177,7 +177,7 @@ const-naming-style=UPPER_CASE
 docstring-min-length=-1
 
 # Naming style matching correct function names.
-function-naming-style=snake_case
+function-naming-style=snake_case,camelCase
 
 # Regular expression matching correct function names. Overrides function-
 # naming-style. If left empty, function names will be checked with the set

requirements.txt

@@ -1,6 +1,7 @@
 pyqt6
 configobj
 pysimconnect @ https://github.com/walmis/pysimconnect/archive/refs/heads/master.zip
+libipc_ctypes @ https://github.com/walmis/libipc_ctypes/archive/refs/heads/master.zip
 stransi
 libusb1
 pygetwindow

telemffb/globals.py

@@ -17,7 +17,7 @@
 #
 
 
-from typing import TYPE_CHECKING, Dict
+from typing import TYPE_CHECKING, Dict, Optional, Any
 if TYPE_CHECKING:
     # from PyQt5.QtCore import QSettings
     from .LogWindow import LogWindow
@@ -29,61 +29,61 @@
     from telemffb.MainWindow import MainWindow
     from subprocess import Popen
     from telemffb.CmdLineArgs import CmdLineArgs
+    from telemffb.ConfiguratorDialog import ConfiguratorDialog
 
+# Application state
 is_exe: bool = False
+args : 'CmdLineArgs'
 
-settings_mgr : 'SettingsWindow' = None
-userconfig_rootpath = None
-userconfig_path = None
-defaults_path = None
-defaults_path = None
-current_vpconf_profile = None
-
-# main window instance
-main_window : 'MainWindow' = None
-
-device_type : str = None
-device_usbpid : str = None
-device_usbvidpid : str = None # "FFFF:2055"
-device_ident : str = None #Joystick, Pedals, etc.. as set in configurator
-
-launched_instances : Dict[str, 'ChildPopen'] = {}
-instance_dev_dict : dict = {}
-master_instance : bool = False
-ipc_instance : 'IPCNetworkThread' = None
-child_instance : bool = None
-active_buttons: list = []
-master_buttons: list = []
-child_buttons: dict = {}
-
-force_reload_aircraft_trigger: bool = False
-
-current_device_config_scope: str = None # add current device config scope to globals for tracking across telemffb modules
-
-# systems settings
-system_settings : 'SystemSettings' = None
-
-#parsed startup arguments
-args : 'CmdLineArgs' = None
-
-# telemetry manager instance
-telem_manager : 'TelemManager' = None
-
-# configurator gains read at startup
-startup_configurator_gains = None  # Gain object direct from 'device.get_gains'.  Gains get read at TelemFFB startup fallback baseline values.
-vpconf_configurator_gains = None  # Gain object direct from 'device.get_gains'. Updated every time a configurator profile is pushed to the device to use as revert data
-current_configurator_gains = None  # Gain settings table set by gain override dialog.  Updated when gains set/saved in dialog or read from config
-gain_override_dialog = None
-
-sim_listeners : 'SimListenerManager' = None
-
-log_window : 'LogWindow' = None
-
-vpf_logo: str = ":/image/vpforcelogo.png"
+# Version and build configuration
 release_version : bool = False
 release_version_str: str = "Vx.x.x"
 dev_build : bool = False # when True, build versions will use 'dev_build_str' as the version string and will not look for updates
 dev_userconfig: bool = True  # will use/create userconfig.xml in root when True (dev_build must also be true)
 dev_build_str: str = "DEV_BUILD"
+vpf_logo: str = ":/image/vpforcelogo.png"
+
+# UI components
+main_window :  'MainWindow' 
+settings_mgr : 'SettingsWindow' 
+log_window :   'LogWindow' 
+useDarkMode : bool = False
+
+# Configuration paths and profiles
+userconfig_rootpath : str = ""
+userconfig_path : str = ""
+defaults_path : str = ""
+current_vpconf_profile : Optional[str] = None
+current_device_config_scope: Optional[str] = None # add current device config scope to globals for tracking across telemffb modules
+
+# Device information
+device_type : str = ""
+device_usbpid : str 
+device_usbvidpid : str  # "FFFF:2055"
+device_ident : str  #Joystick, Pedals, etc.. as set in configurator
+
+# Gain management
+startup_configurator_gains: Optional[Any] = None  # Gain object direct from 'device.get_gains'.  Gains get read at TelemFFB startup fallback baseline values.
+vpconf_configurator_gains: Optional[Any] = None  # Gain object direct from 'device.get_gains'. Updated every time a configurator profile is pushed to the device to use as revert data
+current_configurator_gains: Optional[Any] = None  # Gain settings table set by gain override dialog.  Updated when gains set/saved in dialog or read from config
+gain_override_dialog: 'ConfiguratorDialog'
+
+# Instance management
+launched_instances : Dict[str, 'ChildPopen'] = {}
+instance_dev_dict : Dict[str, Any] = {}
+master_instance : bool = False
+child_instance : bool = False
+ipc_instance : 'IPCNetworkThread'
+
+# Button management
+active_buttons: list[Any] = []
+master_buttons: list[Any] = []
+child_buttons: Dict[str, Any] = {}
+
+# System components
+system_settings : 'SystemSettings'
+telem_manager : 'TelemManager'
+sim_listeners : 'SimListenerManager' 
 
-useDarkMode : bool = False
+# Triggers and flags
+force_reload_aircraft_trigger: bool = False

telemffb/sim/aircraft_base.py

@@ -32,13 +32,13 @@
 
 # by accessing effects dict directly new effects will be automatically allocated
 # example: effects["myUniqueName"]
-effects: Dict[str, HapticEffect] = utils.Dispenser(HapticEffect)
+effects: utils.Dispenser = utils.Dispenser(HapticEffect)
 
 # Highpass filter dispenser
-HPFs: Dict[str, utils.HighPassFilter] = utils.Dispenser(utils.HighPassFilter)
+HPFs: utils.Dispenser = utils.Dispenser(utils.HighPassFilter)
 
 # Lowpass filter dispenser
-LPFs: Dict[str, utils.LowPassFilter] = utils.Dispenser(utils.LowPassFilter)
+LPFs: utils.Dispenser = utils.Dispenser(utils.LowPassFilter)
 
 perftracker = utils.PerformanceTracker()
 
@@ -332,9 +332,6 @@ def __init__(self, name: str, **kwargs):
 
         self.friction_effect_overridden: bool = False
 
-        self.friction_effect_overridden: bool = False
-
-        self.friction_effect_overridden: bool = False
 
     def step_value_over_time(self, key, value, timeframe_ms, dst_val, floatpoint=False):
         '''
@@ -399,6 +396,14 @@ def step_value_over_time(self, key, value, timeframe_ms, dst_val, floatpoint=Fal
         return data['value']
 
     def apply_settings(self, settings_dict):
+        """Apply settings from a configuration dictionary to the aircraft instance.
+        
+        Args:
+            settings_dict (dict): Dictionary containing configuration key-value pairs.
+                                Keys should match aircraft attribute names.
+        
+        Logs warnings for unknown parameters and info for each applied setting.
+        """
         for k, v in settings_dict.items():
             if k in ["type"]: continue
             if getattr(self, k, None) is None and k != 'vpconf' and 'dummy' not in k and 'command_runner' not in k:
@@ -408,6 +413,17 @@ def apply_settings(self, settings_dict):
             setattr(self, k, v)
 
     def has_changed(self, item: str, delta_ms=0, data=None) -> bool:
+        """Check if a telemetry data item has changed since last call.
+        
+        Args:
+            item (str): Name of the telemetry data item to check
+            delta_ms (int, optional): Time window in milliseconds to consider as "recently changed". Defaults to 0.
+            data (dict, optional): Telemetry data dictionary to use. Defaults to self._telem_data.
+        
+        Returns:
+            bool: True if the item changed, False otherwise. 
+                 If the item changed, returns a tuple (prev_val, new_val) instead.
+        """
         if data == None:
             data = self._telem_data
 
@@ -430,21 +446,46 @@ def has_changed(self, item: str, delta_ms=0, data=None) -> bool:
         return False
 
     def flag_error(self, message):
+        """Flag an error message for display in the UI.
+        
+        Args:
+            message (str): Error message to display
+        """
         dev = self.telem_data.get('FFBType', 'joystick').capitalize()
         self.telem_data['error'] = message
         if not master_instance:
             self._ipc_telem['error'] = f"{dev}: {message}"
 
     def is_joystick(self):
+        """Check if the current FFB device is a joystick.
+        
+        Returns:
+            bool: True if device is a joystick, False otherwise
+        """
         return self._telem_data.get("FFBType", "joystick") == "joystick"
 
     def is_pedals(self):
+        """Check if the current FFB device is pedals.
+        
+        Returns:
+            bool: True if device is pedals, False otherwise
+        """
         return self._telem_data.get("FFBType") == "pedals"
 
     def is_collective(self):
+        """Check if the current FFB device is a collective.
+        
+        Returns:
+            bool: True if device is a collective, False otherwise
+        """
         return self._telem_data.get("FFBType") == "collective"
 
     def is_trimwheel(self):
+        """Check if the current FFB device is a trim wheel.
+        
+        Returns:
+            bool: True if device is a trim wheel, False otherwise
+        """
         return self._telem_data.get("FFBType") == "trimwheel"
 
 
@@ -479,23 +520,47 @@ def anything_has_changed(self, item: str, value, delta_ms=0):
         return False
 
     def _sim_is_msfs(self, *unused):
+        """Check if the current simulator is Microsoft Flight Simulator.
+        
+        Returns:
+            int: 1 if MSFS, 0 otherwise
+        """
         if self._telem_data.get("src") == "MSFS":
             return 1
         else:
             return 0
 
     def _sim_is_xplane(self):
+        """Check if the current simulator is X-Plane.
+        
+        Returns:
+            bool: True if X-Plane, False otherwise
+        """
         if self._telem_data.get('src') == "XPLANE":
             return True
         else:
             return False
 
     def _sim_is_dcs(self, *unused):
+        """Check if the current simulator is DCS World.
+        
+        Returns:
+            int: 1 if DCS, 0 otherwise
+        """
         if self._telem_data.get("src") == "DCS":
             return 1
         else:
             return 0
+            
     def _sim_is(self, sim, *unused):
+        """Check if the current simulator matches the specified name.
+        
+        Args:
+            sim (str): Simulator name to check against
+            
+        Returns:
+            int: 1 if matches, 0 otherwise
+        """
         if self._telem_data.get('src') == sim:
             return 1
         else:
@@ -569,6 +634,15 @@ def _update_runway_rumble(self, telem_data):
             effects.dispose("runway1")
 
     def new_gforce_effect(self, telem_data):
+        """Apply new G-force effects based on aircraft acceleration.
+        
+        Generates force feedback effects that vary with G-forces experienced by the aircraft.
+        The effect strength is modulated by stick deflection and can handle both positive
+        and negative G-forces if configured.
+        
+        Args:
+            telem_data (dict): Telemetry data containing acceleration information
+        """
         if not self.is_joystick() or not self.new_gforce_effect_enable or not self.gforce_effect_master:
             effects.dispose("new_gforce")
             return
@@ -1960,13 +2034,14 @@ def set_deadzone(self):
 
 
 
-    def on_event(self):
+    def on_event(self, event, *args):
         pass
 
     def on_timeout(self):  # override me
         logging.info("Telemetry Timeout, stopping effects")
         # effects.foreach(lambda e: e.stop())
         for key, effect in effects.dict.items():
+            effect: HapticEffect
             if self.keep_forces_on_pause:
                 if effect.effect_type in [EFFECT_SPRING, EFFECT_DAMPER, EFFECT_INERTIA, EFFECT_FRICTION, EFFECT_SPRING_ADJUSTER]:
                     continue

telemffb/sim/aircrafts_dcs.py

@@ -46,7 +46,7 @@
 from telemffb.hw.ffb_rhino import (EFFECT_SINE, EFFECT_SQUARE, EFFECT_TRIANGLE, EFFECT_SAWTOOTHUP, EFFECT_SAWTOOTHDOWN, HapticEffect)
 
 from telemffb.sim.aircraft_base import AircraftBase, LPFs, effects, perftracker
-
+from telemffb.telem.DcsIpcThread import DcsIpcThread
 #unit conversions (to m/s)
 knots = 0.514444
 kmh = 1.0/3.6
@@ -231,10 +231,7 @@ def on_timeout(self):
 
     def send_commands(self, cmds):
         cmds = "\n".join(cmds)
-        if not getattr(self, "_socket", None):
-            self._socket = socket.socket(socket.AF_INET, socket.SOCK_DGRAM, 0)
-        
-        self._socket.sendto(bytes(cmds, "utf-8"), ("127.0.0.1", 34381))
+        DcsIpcThread.send_commands(cmds)
 
     def _update_damage(self, telem_data):
         if not self.damage_effect_enabled: return