py-feedback-controller 0.1.0__cp313-cp313-win_amd64.whl

py_feedback_controller-0.1.0.dist-info/METADATA

@@ -0,0 +1,5 @@
+Metadata-Version: 2.4
+Name: py-feedback-controller
+Version: 0.1.0
+License-File: LICENSE
+Dynamic: license-file

py_feedback_controller-0.1.0.dist-info/RECORD

@@ -0,0 +1,10 @@
+py_feedback_controller-0.1.0.dist-info/licenses/LICENSE,sha256=ZeaUNPVVyknEeHj39vIoGzfUyZ-ZQrzpNAEIfyTZ80Y,1086
+pyfc/__init__.py,sha256=cxJ6zyYlFtj0VhnA2MMyXK4xUa-eZZlPsn2nIWATkVo,232
+pyfc/_core.cp313-win_amd64.pyd,sha256=HDwozFxtW9VQac-1VytIxNhHYi1vEIjIxV6UKettGgQ,238080
+pyfc/_core.pyi,sha256=4NLxKupNMVJu2hKMCQYQVMHY8AYDmme0ZDtCjd58ldY,3972
+pyfc/pid/__init__.py,sha256=L_YP9Ljz_Z32-CYZz1fkk5iPvBnr2CDiOlz1D_zCJ-g,125
+pyfc/timer/__init__.py,sha256=bJWAgNoFiHcYiDmhcnbirQNxwJvbJS8sWlNJGjBUFzg,69
+py_feedback_controller-0.1.0.dist-info/METADATA,sha256=LsrGJaLvWX28DFMlZVlyv05hxyhZeHqg_5cyFVtVovk,115
+py_feedback_controller-0.1.0.dist-info/WHEEL,sha256=0LUNoHxLvcpw9db_x0XozE5jW73-_GOAO7fDDJ4Xt4Q,101
+py_feedback_controller-0.1.0.dist-info/top_level.txt,sha256=4sqJeaC4Egdk59eh1l9GudJUf1AUTfjO1Y-WTKz7lTU,5
+py_feedback_controller-0.1.0.dist-info/RECORD,,

py_feedback_controller-0.1.0.dist-info/WHEEL

@@ -0,0 +1,5 @@
+Wheel-Version: 1.0
+Generator: setuptools (84.0.0)
+Root-Is-Purelib: false
+Tag: cp313-cp313-win_amd64
+

py_feedback_controller-0.1.0.dist-info/licenses/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Patrik-J
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

py_feedback_controller-0.1.0.dist-info/top_level.txt

@@ -0,0 +1 @@
+pyfc

pyfc/__init__.py

@@ -0,0 +1,11 @@
+from pyfc import pid, timer
+from pyfc._core import VectorMathException, FeedbackControllerException
+
+__all__ = [
+    "pid",
+    "timer",
+    "VectorMathException",
+    "FeedbackControllerException"
+]
+
+__version__ = "0.1.0"

pyfc/_core.pyi

@@ -0,0 +1,101 @@
+"""
+Bindings for the PyFC module.
+"""
+from __future__ import annotations
+import collections.abc
+import typing
+__all__: list[str] = ['AutoOptimizingPID', 'FeedbackController', 'FeedbackControllerException', 'PIDController', 'Timer', 'VectorMathException']
+class AutoOptimizingPID(FeedbackController):
+    @typing.overload
+    def __init__(self, params: collections.abc.Sequence[typing.SupportsFloat | typing.SupportsIndex], setpoint: typing.SupportsFloat | typing.SupportsIndex, lr: typing.SupportsFloat | typing.SupportsIndex = 0.001) -> None:
+        ...
+    @typing.overload
+    def __init__(self, setpoint: typing.SupportsFloat | typing.SupportsIndex, lr: typing.SupportsFloat | typing.SupportsIndex = 0.001) -> None:
+        ...
+    def getAsPID(self) -> PIDController:
+        """
+        Get the auto-optimizing PID controller as a simple PID controller.
+        """
+    def getCaps(self) -> list[float]:
+        """
+        Get the upper and lower caps of the integral and derivative.
+        """
+    def getLearningRate(self) -> float:
+        """
+        Get the learning rate of the gradient descent algorithm.
+        """
+    def init(self) -> None:
+        """
+        Initialize the auto-optimizing PID controller
+        """
+    def requestLoop(self, input: typing.SupportsFloat | typing.SupportsIndex) -> float:
+        """
+        Request a single loop of the auto-optimizing PID controller.
+        """
+    def setCaps(self, time_integral: typing.SupportsFloat | typing.SupportsIndex, derivative: typing.SupportsFloat | typing.SupportsIndex) -> None:
+        """
+        Set the upper and lower caps of the integral and derivative.
+        """
+    def setLearningRate(self, lr: typing.SupportsFloat | typing.SupportsIndex) -> None:
+        """
+        Set the learning rate of the gradient descent algorithm.
+        """
+class FeedbackController:
+    def __repr__(self) -> str:
+        ...
+    def getSetpoint(self) -> float:
+        """
+        Get the setpoint of the feedback controller.
+        """
+    def setSetpoint(self, setpoint: typing.SupportsFloat | typing.SupportsIndex) -> None:
+        """
+        Set the setpoint of the feedback controller.
+        """
+class FeedbackControllerException(Exception):
+    pass
+class PIDController(FeedbackController):
+    def __init__(self, params: collections.abc.Sequence[typing.SupportsFloat | typing.SupportsIndex], setpoint: typing.SupportsFloat | typing.SupportsIndex) -> None:
+        ...
+    def getCaps(self) -> list[float]:
+        """
+        Get the upper and lower caps of the integral and derivative.
+        """
+    def getGains(self) -> list[float]:
+        """
+        Get the parameter gains of the PID controller.
+        """
+    def init(self) -> None:
+        """
+        Initialize the PID controller
+        """
+    def requestLoop(self, input: typing.SupportsFloat | typing.SupportsIndex) -> float:
+        """
+        Request a single loop of the PID controller.
+        """
+    def setCaps(self, time_integral: typing.SupportsFloat | typing.SupportsIndex, derivative: typing.SupportsFloat | typing.SupportsIndex) -> None:
+        """
+        Set the upper and lower caps of the integral and derivative.
+        """
+    def setGains(self, gains: collections.abc.Sequence[typing.SupportsFloat | typing.SupportsIndex]) -> None:
+        """
+        Set the parameter gains of the PID controller.
+        """
+class Timer:
+    def __init__(self) -> None:
+        """
+        Create an instance of the Timer class
+        """
+    def micros(self) -> int:
+        """
+        Get the microseconds since the timer was started
+        """
+    def millis(self) -> int:
+        """
+        Get the milliseconds since the timer was started
+        """
+    def start(self) -> None:
+        """
+        Set the start time of the timer.
+        """
+class VectorMathException(Exception):
+    pass

pyfc/pid/__init__.py

@@ -0,0 +1,4 @@
+from .._core import PIDController, AutoOptimizingPID
+
+# Re-export classes
+__all__ = ["PIDController", "AutoOptimizingPID"]

pyfc/timer/__init__.py

@@ -0,0 +1,4 @@
+from .._core import Timer
+
+# Re-export classes
+__all__ = ["Timer"]