cfclient 2017.4__py3-none-any.whl → 2025.12.1__py3-none-any.whl

cfclient/__init__.py

@@ -24,6 +24,7 @@
 #  this program; if not, write to the Free Software Foundation, Inc., 51
 #  Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
 
+import json
 import os
 from appdirs import AppDirs
 import sys
@@ -32,20 +33,24 @@ import sys
 if not hasattr(sys, 'frozen'):
     module_path = os.path.dirname(__file__)
 else:
-    module_path = os.path.dirname(sys.executable)
+    module_path = os.path.join(os.path.dirname(sys.executable),
+                               'lib', 'cfclient')
 config_path = AppDirs("cfclient", "Bitcraze").user_config_dir
 
-# Locate the sdl2 lib on Windows (should be in cfclient/thirst_party/)
-if os.name == 'nt':
-    os.environ["PYSDL2_DLL_PATH"] = os.path.join(module_path, "third_party")
-
 if not hasattr(sys, 'frozen'):
-    import pkg_resources
+    from importlib.metadata import version, PackageNotFoundError
     try:
-        VERSION = pkg_resources.require("cfclient")[0].version
-    except pkg_resources.DistributionNotFound:
+        VERSION = version("cfclient")
+    except PackageNotFoundError:
         VERSION = "dev"
 else:
-    import json
-    with open(os.path.join(module_path, "version.json")) as f:
-        VERSION = json.load(f)['version']
+    try:
+        from .version import __version__ as imported_version
+        VERSION = imported_version
+    except ImportError:
+        VERSION = "dev"
+try:
+    with open(os.path.join(module_path, "resources/log_param_doc.json")) as f:
+        log_param_doc = json.load(f)
+except (IOError, OSError, json.JSONDecodeError):
+    log_param_doc = None

cfclient/configs/config.json

@@ -12,13 +12,14 @@
     "min_thrust": 25,
     "max_yaw": 200,
     "max_rp": 30,
-    "client_side_xmode": false,
     "auto_reconnect": false,
     "device_config_mapping": {},
     "enable_debug_driver": false,
-    "input_device_blacklist": "(VirtualBox|VMware)",
+    "input_device_blacklist": "(VirtualBox|VMware|keyd virtual pointer)",
     "ui_update_period": 100,
-    "enable_zmq_input": false
+    "enable_zmq_input": false,
+    "enable_zmq_param": false,
+    "enable_zmq_led": false
   },
   "read-only" : {
     "normal_slew_limit": 45,

cfclient/configs/input/Generic_OS_X.json

@@ -2,6 +2,7 @@
   "inputconfig": {
     "inputdevice":
     {"name": "Generic 2-axis gamepad on OS X", "updateperiod":10,
+     "rp_dead_band": 0.1,
      "axis": [
           {"name":"Roll", "type":"Input.AXIS", "id":3, "scale":1.0, "key":"roll"},
           {"name":"Pitch", "type":"Input.AXIS", "id":4, "scale":-1.0, "key":"pitch"},

cfclient/configs/input/Joystick.json

@@ -4,6 +4,7 @@
       "updateperiod": 10,
       "springythrottle": false,
       "name": "Joystick",
+      "rp_dead_band": 0.1,
       "axis": [
         {
           "scale": -1.0,

cfclient/configs/input/PS3_Mode_1.json

@@ -2,6 +2,7 @@
   "inputconfig": {
     "inputdevice":
     {"name": "Playstation 3 Mode 1", "updateperiod":10,
+     "rp_dead_band": 0.1,
      "axis": [
           {"name":"Roll", "type":"Input.AXIS", "id":0, "scale":1.0, "key":"roll"},
           {"name":"Pitch", "type":"Input.AXIS", "id":1, "scale":-1.0, "key":"pitch"},

cfclient/configs/input/PS3_Mode_2.json

@@ -2,6 +2,7 @@
   "inputconfig": {
     "inputdevice":
     {"name": "Playstation 3 Mode 2", "updateperiod":10,
+     "rp_dead_band": 0.1,
      "axis": [
           {"name":"Roll", "type":"Input.AXIS", "id":2, "scale":1.0, "key":"roll"},
           {"name":"Pitch", "type":"Input.AXIS", "id":3, "scale":-1.0, "key":"pitch"},

cfclient/configs/input/PS3_Mode_3.json

@@ -3,6 +3,7 @@
     "inputdevice": {
       "updateperiod": 10,
       "name": "PS3_Mode_3",
+      "rp_dead_band": 0.1,
       "axis": [
         {
           "scale": -1.0,

cfclient/configs/input/PS4_Mode_1.json

@@ -3,6 +3,7 @@
     "inputdevice": {
       "updateperiod": 10,
       "name": "PS4_Mode_1",
+      "rp_dead_band": 0.1,
       "axis": [
         {
           "scale": -1.0,

cfclient/configs/input/PS4_Mode_2.json

@@ -3,6 +3,7 @@
     "inputdevice": {
       "updateperiod": 10,
       "name": "PS4_Mode_2",
+      "rp_dead_band": 0.1,
       "axis": [
         {
           "scale": -1.0,

cfclient/configs/input/PS4_shoulder_btns_yaw.json

@@ -3,6 +3,7 @@
     "inputdevice": {
       "updateperiod": 10,
       "name": "PS4_shoulder_btns_yaw",
+      "rp_dead_band": 0.1,
       "axis": [
         {
           "scale": -1.0,

cfclient/configs/input/xbox360_mode1.json

@@ -3,6 +3,7 @@
     "inputdevice": {
       "updateperiod": 10,
       "name": "xbox360_mode1_linux",
+      "rp_dead_band": 0.1,
       "axis": [
         {
           "scale": -1.0,

cfclient/configs/log/PID_tuning/Attitude.json

@@ -0,0 +1,46 @@
+{
+  "logconfig": {
+    "logblock": {
+      "variables": [
+        {
+          "name": "controller.pitch",
+          "stored_as": "",
+          "fetch_as": "float",
+          "type": "TOC"
+        },
+        {
+          "name": "controller.roll",
+          "stored_as": "",
+          "fetch_as": "float",
+          "type": "TOC"
+        },
+        {
+          "name": "controller.yaw",
+          "stored_as": "",
+          "fetch_as": "float",
+          "type": "TOC"
+        },
+        {
+          "name": "stateEstimate.pitch",
+          "stored_as": "",
+          "fetch_as": "float",
+          "type": "TOC"
+        },
+        {
+          "name": "stateEstimate.roll",
+          "stored_as": "",
+          "fetch_as": "float",
+          "type": "TOC"
+        },
+        {
+          "name": "stateEstimate.yaw",
+          "stored_as": "",
+          "fetch_as": "float",
+          "type": "TOC"
+        }
+      ],
+      "name": "Attitude",
+      "period": 10
+    }
+  }
+}

cfclient/configs/log/PID_tuning/Attitude_rate.json

@@ -0,0 +1,46 @@
+{
+  "logconfig": {
+    "logblock": {
+      "variables": [
+        {
+          "name": "controller.pitchRate",
+          "stored_as": "",
+          "fetch_as": "float",
+          "type": "TOC"
+        },
+        {
+          "name": "controller.rollRate",
+          "stored_as": "",
+          "fetch_as": "float",
+          "type": "TOC"
+        },
+        {
+          "name": "controller.yawRate",
+          "stored_as": "",
+          "fetch_as": "float",
+          "type": "TOC"
+        },
+        {
+          "name": "gyro.x",
+          "stored_as": "",
+          "fetch_as": "float",
+          "type": "TOC"
+        },
+        {
+          "name": "gyro.y",
+          "stored_as": "",
+          "fetch_as": "float",
+          "type": "TOC"
+        },
+        {
+          "name": "gyro.z",
+          "stored_as": "",
+          "fetch_as": "float",
+          "type": "TOC"
+        }
+      ],
+      "name": "Attitude rate",
+      "period": 10
+    }
+  }
+}

cfclient/configs/log/PID_tuning/Position.json

@@ -0,0 +1,46 @@
+{
+  "logconfig": {
+    "logblock": {
+      "variables": [
+        {
+          "name": "posCtl.targetX",
+          "stored_as": "",
+          "fetch_as": "float",
+          "type": "TOC"
+        },
+        {
+          "name": "posCtl.targetY",
+          "stored_as": "",
+          "fetch_as": "float",
+          "type": "TOC"
+        },
+        {
+          "name": "posCtl.targetZ",
+          "stored_as": "",
+          "fetch_as": "float",
+          "type": "TOC"
+        },
+        {
+          "name": "stateEstimate.x",
+          "stored_as": "",
+          "fetch_as": "float",
+          "type": "TOC"
+        },
+        {
+          "name": "stateEstimate.y",
+          "stored_as": "",
+          "fetch_as": "float",
+          "type": "TOC"
+        },
+        {
+          "name": "stateEstimate.z",
+          "stored_as": "",
+          "fetch_as": "float",
+          "type": "TOC"
+        }
+      ],
+      "name": "Position",
+      "period": 10
+    }
+  }
+}

cfclient/configs/log/PID_tuning/Velocity.json

@@ -0,0 +1,46 @@
+{
+  "logconfig": {
+    "logblock": {
+      "variables": [
+        {
+          "name": "posCtl.targetVX",
+          "stored_as": "",
+          "fetch_as": "float",
+          "type": "TOC"
+        },
+        {
+          "name": "posCtl.targetVY",
+          "stored_as": "",
+          "fetch_as": "float",
+          "type": "TOC"
+        },
+        {
+          "name": "posCtl.targetVZ",
+          "stored_as": "",
+          "fetch_as": "float",
+          "type": "TOC"
+        },
+        {
+          "name": "stateEstimate.vx",
+          "stored_as": "",
+          "fetch_as": "float",
+          "type": "TOC"
+        },
+        {
+          "name": "stateEstimate.vy",
+          "stored_as": "",
+          "fetch_as": "float",
+          "type": "TOC"
+        },
+        {
+          "name": "stateEstimate.vz",
+          "stored_as": "",
+          "fetch_as": "float",
+          "type": "TOC"
+        }
+      ],
+      "name": "Velocity",
+      "period": 10
+    }
+  }
+}

cfclient/configs/log/PID_tuning_components/Pitch.json

@@ -0,0 +1,22 @@
+{
+  "logconfig": {
+    "logblock": {
+      "variables": [
+        {
+          "name": "controller.pitch",
+          "stored_as": "",
+          "fetch_as": "float",
+          "type": "TOC"
+        },
+        {
+          "name": "stateEstimate.pitch",
+          "stored_as": "",
+          "fetch_as": "float",
+          "type": "TOC"
+        }
+      ],
+      "name": "Pitch",
+      "period": 10
+    }
+  }
+}

cfclient/configs/log/PID_tuning_components/Pitch_rate.json

@@ -0,0 +1,22 @@
+{
+  "logconfig": {
+    "logblock": {
+      "variables": [
+        {
+          "name": "controller.pitchRate",
+          "stored_as": "",
+          "fetch_as": "float",
+          "type": "TOC"
+        },
+        {
+          "name": "gyro.y",
+          "stored_as": "",
+          "fetch_as": "float",
+          "type": "TOC"
+        }
+      ],
+      "name": "Pitch rate",
+      "period": 10
+    }
+  }
+}

cfclient/configs/log/PID_tuning_components/Position_x.json

@@ -0,0 +1,22 @@
+{
+  "logconfig": {
+    "logblock": {
+      "variables": [
+        {
+          "name": "posCtl.targetX",
+          "stored_as": "",
+          "fetch_as": "float",
+          "type": "TOC"
+        },
+        {
+          "name": "stateEstimate.x",
+          "stored_as": "",
+          "fetch_as": "float",
+          "type": "TOC"
+        }
+      ],
+      "name": "Position x",
+      "period": 10
+    }
+  }
+}

cfclient/configs/log/PID_tuning_components/Position_y.json

@@ -0,0 +1,22 @@
+{
+  "logconfig": {
+    "logblock": {
+      "variables": [
+        {
+          "name": "posCtl.targetY",
+          "stored_as": "",
+          "fetch_as": "float",
+          "type": "TOC"
+        },
+        {
+          "name": "stateEstimate.y",
+          "stored_as": "",
+          "fetch_as": "float",
+          "type": "TOC"
+        }
+      ],
+      "name": "Position y",
+      "period": 10
+    }
+  }
+}

cfclient/configs/log/PID_tuning_components/Position_z.json

@@ -0,0 +1,22 @@
+{
+  "logconfig": {
+    "logblock": {
+      "variables": [
+        {
+          "name": "posCtl.targetZ",
+          "stored_as": "",
+          "fetch_as": "float",
+          "type": "TOC"
+        },
+        {
+          "name": "stateEstimate.z",
+          "stored_as": "",
+          "fetch_as": "float",
+          "type": "TOC"
+        }
+      ],
+      "name": "Position z",
+      "period": 10
+    }
+  }
+}

cfclient/configs/log/PID_tuning_components/Roll.json

@@ -0,0 +1,22 @@
+{
+  "logconfig": {
+    "logblock": {
+      "variables": [
+        {
+          "name": "controller.roll",
+          "stored_as": "",
+          "fetch_as": "float",
+          "type": "TOC"
+        },
+        {
+          "name": "stateEstimate.roll",
+          "stored_as": "",
+          "fetch_as": "float",
+          "type": "TOC"
+        }
+      ],
+      "name": "Roll",
+      "period": 10
+    }
+  }
+}

cfclient/configs/log/PID_tuning_components/Roll_rate.json

@@ -0,0 +1,22 @@
+{
+  "logconfig": {
+    "logblock": {
+      "variables": [
+        {
+          "name": "controller.rollRate",
+          "stored_as": "",
+          "fetch_as": "float",
+          "type": "TOC"
+        },
+        {
+          "name": "gyro.x",
+          "stored_as": "",
+          "fetch_as": "float",
+          "type": "TOC"
+        }
+      ],
+      "name": "Roll rate",
+      "period": 10
+    }
+  }
+}

cfclient/configs/log/PID_tuning_components/Velocity_x.json

@@ -0,0 +1,22 @@
+{
+  "logconfig": {
+    "logblock": {
+      "variables": [
+        {
+          "name": "posCtl.targetVX",
+          "stored_as": "",
+          "fetch_as": "float",
+          "type": "TOC"
+        },
+        {
+          "name": "stateEstimate.vx",
+          "stored_as": "",
+          "fetch_as": "float",
+          "type": "TOC"
+        }
+      ],
+      "name": "Velocity x",
+      "period": 10
+    }
+  }
+}

cfclient/configs/log/PID_tuning_components/Velocity_y.json

@@ -0,0 +1,22 @@
+{
+  "logconfig": {
+    "logblock": {
+      "variables": [
+        {
+          "name": "posCtl.targetVY",
+          "stored_as": "",
+          "fetch_as": "float",
+          "type": "TOC"
+        },
+        {
+          "name": "stateEstimate.vy",
+          "stored_as": "",
+          "fetch_as": "float",
+          "type": "TOC"
+        }
+      ],
+      "name": "Velocity y",
+      "period": 10
+    }
+  }
+}

cfclient/configs/log/PID_tuning_components/Velocity_z.json

@@ -0,0 +1,22 @@
+{
+  "logconfig": {
+    "logblock": {
+      "variables": [
+        {
+          "name": "posCtl.targetVZ",
+          "stored_as": "",
+          "fetch_as": "float",
+          "type": "TOC"
+        },
+        {
+          "name": "stateEstimate.vz",
+          "stored_as": "",
+          "fetch_as": "float",
+          "type": "TOC"
+        }
+      ],
+      "name": "Velocity z",
+      "period": 10
+    }
+  }
+}

cfclient/configs/log/PID_tuning_components/Yaw.json

@@ -0,0 +1,22 @@
+{
+  "logconfig": {
+    "logblock": {
+      "variables": [
+        {
+          "name": "controller.yaw",
+          "stored_as": "",
+          "fetch_as": "float",
+          "type": "TOC"
+        },
+        {
+          "name": "stateEstimate.yaw",
+          "stored_as": "",
+          "fetch_as": "float",
+          "type": "TOC"
+        }
+      ],
+      "name": "Yaw",
+      "period": 10
+    }
+  }
+}

cfclient/configs/log/PID_tuning_components/Yaw_rate.json

@@ -0,0 +1,22 @@
+{
+  "logconfig": {
+    "logblock": {
+      "variables": [
+        {
+          "name": "controller.yawRate",
+          "stored_as": "",
+          "fetch_as": "float",
+          "type": "TOC"
+        },
+        {
+          "name": "gyro.z",
+          "stored_as": "",
+          "fetch_as": "float",
+          "type": "TOC"
+        }
+      ],
+      "name": "Yaw rate",
+      "period": 10
+    }
+  }
+}