Merge pull request 'Added close() method to all controller classes. /JL' (#16) from 0.1.7 into main

Reviewed-on: #16

pygameControls/controller.py

@@ -9,7 +9,7 @@ from .xbox_series_x_controller import XboxSeriesXController
 from .generic_controller import GenericController
 from .logitech_dual_action_controller import LogitechDualActionController
 
-__version__ = "0.1.2"
+__version__ = "0.1.7"
 
 CONTROLLERS = {
     "DualSense Wireless Controller": DualSenseController,

pygameControls/controlsbase.py

@@ -30,4 +30,12 @@ class ControlsBase(ABC):
     
     @abstractmethod
     def rumble(self):
+        pass
+    
+    @abstractmethod
+    def stop_rumble(self):
+        pass
+    
+    @abstractmethod
+    def close(self):
         pass

pygameControls/dualsense_controller.py

@@ -77,7 +77,7 @@ class DualSenseController(ControlsBase):
         pass
     
     def rumble(self, left, right):
-        if not left in range(255) or not right in range(255):
+        if not left in range(256) or not right in range(256):
             raise ValueError("left and right values must be in the range 0 - 255")
         self.device.setLeftMotor(left)
         self.device.setRightMotor(right)

pygameControls/dualsense_edge_controller.py

@@ -69,7 +69,7 @@ class DualSenseEdgeController(ControlsBase):
         pass
     
     def rumble(self, left, right):
-        if not left in range(255) or not right in range(255):
+        if not left in range(256) or not right in range(256):
             raise ValueError("left and right values must be in the range 0 - 255")
         self.device.setLeftMotor(left)
         self.device.setRightMotor(right)

pygameControls/generic_controller.py

@@ -36,6 +36,9 @@ class GenericController(ControlsBase):
             }
         print(f"{self.name} connected.")
     
+    def close(self):
+        pass
+    
     def handle_input(self, event):
         pass
     
@@ -57,6 +60,9 @@ class GenericController(ControlsBase):
     def rumble(self):
         pass
     
+    def stop_rumble(self):
+        pass
+    
     @property
     def name(self) -> str:
         return self._name

pygameControls/logitech_dual_action_controller.py

@@ -56,7 +56,10 @@ class LogitechDualActionController(ControlsBase):
             "logo button": None
             }
         print(f"{self.name} connected.")
-        
+    
+    def close(self):
+        pass
+    
     def handle_input(self, event):
         pass
     
@@ -78,6 +81,9 @@ class LogitechDualActionController(ControlsBase):
     def rumble(self):
         pass
     
+    def stop_rumble(self):
+        pass
+    
     @property
     def name(self) -> str:
         return self._name

pygameControls/logitech_f310_controller.py

@@ -57,6 +57,9 @@ class LogitechF310Controller(ControlsBase):
             }
         print(f"{self.name} connected.")
     
+    def close(self):
+        pass
+    
     def handle_input(self, event):
         pass
     
@@ -78,6 +81,9 @@ class LogitechF310Controller(ControlsBase):
     def rumble(self):
         pass
     
+    def stop_rumble(self):
+        pass
+    
     @property
     def name(self) -> str:
         return self._name

pygameControls/logitech_f510_controller.py

@@ -59,6 +59,9 @@ class LogitechF510Controller(ControlsBase):
             }
         print(f"{self.name} connected.")
     
+    def close(self):
+        pass
+    
     def handle_input(self, event):
         pass
     
@@ -80,6 +83,9 @@ class LogitechF510Controller(ControlsBase):
     def rumble(self):
         pass
     
+    def stop_rumble(self):
+        pass
+    
     @property
     def name(self) -> str:
         return self._name

pygameControls/logitech_f710_controller.py

@@ -59,6 +59,9 @@ class LogitechF710Controller(ControlsBase):
             }
         print(f"{self.name} connected.")
     
+    def close(self):
+        pass
+    
     def handle_input(self, event):
         pass
     
@@ -80,6 +83,9 @@ class LogitechF710Controller(ControlsBase):
     def rumble(self):
         pass
     
+    def stop_rumble(self):
+        pass
+    
     @property
     def name(self) -> str:
         return self._name

pygameControls/xbox_series_x_controller.py

@@ -1,7 +1,6 @@
-import time
-import threading
+from pygameControls.controlsbase import ControlsBase
 
-class XboxSeriesXController:
+class XboxSeriesXController(ControlsBase):
     def __init__(self, joy):
         self.device = joy
         self.instance_id: int = self.device.get_instance_id()
@@ -37,6 +36,9 @@ class XboxSeriesXController:
             }
         print(f"{self.name} connected.")
     
+    def close(self):
+        pass
+    
     def handle_input(self, event):
         pass
     
@@ -55,9 +57,14 @@ class XboxSeriesXController:
     def pause(self):
         pass
     
-    def rumble(self):
-        pass
+    def rumble(self, left, right):
+        if not left in range(256) or not right in range(256):
+            raise ValueError("left and right values must be in the range 0 - 255")
+        self.joy.rumble(left, right)
     
+    def stop_rumble(self):
+        self.joy.rumble(0, 0)
+        
     @property
     def name(self) -> str:
         return self._name

setup.py

@@ -3,7 +3,7 @@ if __name__ == "__main__":
 
     setup(
         name='pygameControls',
-        version='0.1.2',
+        version='0.1.7',
         packages=find_packages(),
         install_requires=[],
         author='Jan Lerking',