Update setup.py

Refactor hidapi

.gitignore

@@ -149,6 +149,9 @@ dmypy.json
 !.vscode/extensions.json
 *.code-workspace
 
+### pycharm ###
+.idea/*
+
 # End of https://www.toptal.com/developers/gitignore/api/python,vscode
 
 pydualsense/interface.py

README.md

@@ -1,9 +1,9 @@
 # pydualsense
-control your dualsense through python. using the hid library this module implements the sending report for controlling you new PS5 controller. It creates a background thread to constantly update the controller.
+control your dualsense through python. using the hid library this package implements the report features for controlling your new PS5 controller. 
 
 # install
 
-Just install the package from pypi
+Download [hidapi](https://github.com/libusb/hidapi/releases) and place the x64 .dll file into your Workspace. After that install the package from [pypi](https://pypi.org/project/pydualsense/). 
 
 ```bash
 pip install pydualsense
@@ -12,18 +12,38 @@ pip install pydualsense
 
 ```python
 
-from pydualsense import pydualsense
+from pydualsense import pydualsense, TriggerModes
 
 ds = pydualsense() # open controller
-ds.setColor(255,0,0) # set touchpad color to red
+ds.init() # initialize controller
-ds.setLeftTriggerMode(TriggerModes.Rigid)
+ds.light.setColorI(255,0,0) # set touchpad color to red
-ds.setLeftTriggerForce(1, 255)
+ds.triggerL.setMode(TriggerModes.Rigid)
+ds.triggerL.setForce(1, 255)
 ds.close() # closing the controller
 ```
+
+See [examples](https://github.com/flok/pydualsense/tree/master/examples) folder for some more ideas
+
+# Help wanted
+
+Help wanted from people that want to use this and have feature requests. Just open a issue with the correct label.
+
 # dependecies
 
 - hid >= 1.0.4
+
+# Credits
+
+
+Most stuff for this implementation were provided by and used from:
+
+
+- [https://www.reddit.com/r/gamedev/comments/jumvi5/dualsense_haptics_leds_and_more_hid_output_report/](https://www.reddit.com/r/gamedev/comments/jumvi5/dualsense_haptics_leds_and_more_hid_output_report/)
+- [https://github.com/Ryochan7/DS4Windows](https://github.com/Ryochan7/DS4Windows)
+
 # Coming soon
 
+- add bluetooth support
+- add multiple controllers
 - reading the states of the controller to enable a fully compatibility with python - partially done
 - add documentation using sphinx

examples/README.md

@@ -0,0 +1,15 @@
+# Examples
+
+This folder contains some examples on applications for the library and its usage
+
+## leds.py
+
+The leds.py shows you how you can interact and change the lights of the controller
+
+## effects.py
+
+The effects.py show some effects of the controller
+
+## read_controller.py
+
+The read_controller.py display how you can access the button state of the controller

examples/effects.py

@@ -0,0 +1,22 @@
+from pydualsense import *
+
+# get dualsense instance
+dualsense = pydualsense()
+dualsense.init()
+
+print('Trigger Effect demo started')
+
+dualsense.setLeftMotor(255)
+dualsense.setRightMotor(100)
+dualsense.triggerL.setMode(TriggerModes.Rigid)
+dualsense.triggerL.setForce(1, 255)
+
+dualsense.triggerR.setMode(TriggerModes.Pulse_A)
+dualsense.triggerR.setForce(0, 200)
+dualsense.triggerR.setForce(1, 255)
+dualsense.triggerR.setForce(2, 175)
+
+import time; time.sleep(3)
+
+# terminate the thread for message and close the device
+dualsense.close()

examples/leds.py

@@ -0,0 +1,16 @@
+from pydualsense import *
+
+# get dualsense instance
+dualsense = pydualsense()
+dualsense.init()
+# set color around touchpad to red
+dualsense.light.setColorI(255,0,0)
+# enable microphone indicator
+dualsense.audio.setMicrophoneLED(1)
+# set all player 1 indicator on
+dualsense.light.setPlayerID(PlayerID.player1)
+# sleep a little to see the result on the controller
+# this is not needed in normal usage
+import time; time.sleep(2)
+# terminate the thread for message and close the device
+dualsense.close()

examples/read_controller.py

@@ -0,0 +1,15 @@
+from pydualsense import *
+
+# create dualsense
+dualsense = pydualsense()
+# find device and initialize
+dualsense.init()
+
+# read controller state until R1 is pressed
+while not dualsense.state.R1:
+    print(f"Circle : {dualsense.state.circle} Cross : {dualsense.state.cross} L Stick X : {dualsense.state.LX} L Stick Y : {dualsense.state.LY}")
+
+# close device
+dualsense.close()
+
+

pydualsense/__init__.py

@@ -1,2 +1,2 @@
 from .enums import LedOptions,Brightness,PlayerID,PulseOptions,TriggerModes
-from .pydualsense import pydualsense, DSAudio, DSLight, DSTrigger
+from .pydualsense import pydualsense, DSLight, DSState, DSTouchpad, DSTrigger, DSAudio

pydualsense/enums.py

@@ -17,20 +17,20 @@ class Brightness(IntFlag):
     low = 0x2
 
 class PlayerID(IntFlag):
-    player1 = 1,
+    player1 = 4,
-    player2 = 2,
+    player2 = 10,
-    player3 = 4,
+    player3 = 21,
-    player4 = 8,
+    player4 = 27,
-    player5 = 16,
     all = 31
 
+
 class TriggerModes(IntFlag):
-    Off =0x0, # no resistance
+    Off = 0x0, # no resistance
-    Rigid =0x1, # continous resistance
+    Rigid = 0x1, # continous resistance
-    Pulse =0x2, # section resistance
+    Pulse = 0x2, # section resistance
-    Rigid_A=0x1 | 0x20,
+    Rigid_A = 0x1 | 0x20,
-    Rigid_B=0x1 | 0x04,
+    Rigid_B = 0x1 | 0x04,
-    Rigid_AB=0x1 | 0x20 | 0x04,
+    Rigid_AB = 0x1 | 0x20 | 0x04,
     Pulse_A = 0x2 | 0x20,
     Pulse_B = 0x2 | 0x04,
     Pulse_AB = 0x2 | 0x20 | 0x04,

pydualsense/hidguardian.py

@@ -0,0 +1,18 @@
+import winreg
+import sys
+
+def check_hide() -> bool:
+        """check if hidguardian is used and controller is hidden
+        """
+        if sys.platform.startswith('win32'):
+            try:
+                access_reg = winreg.ConnectRegistry(None, winreg.HKEY_LOCAL_MACHINE)
+                access_key = winreg.OpenKey(access_reg, 'SYSTEM\CurrentControlSet\Services\HidGuardian\Parameters', 0, winreg.KEY_READ)
+                affected_devices = winreg.QueryValueEx(access_key, 'AffectedDevices')[0]
+                if "054C" in affected_devices and "0CE6" in affected_devices:
+                    return True
+                return False
+            except OSError as e:
+                print(e)
+
+        return False

pydualsense/pydualsense-demo.py

@@ -1,34 +0,0 @@
-from PyQt5 import QtCore, QtGui, QtWidgets 
-import sys 
-from interface import Ui_MainWindow
-from pydualsense import pydualsense
-
-def colorR(value):
-    global colorR
-    colorR = value
-
-def colorG(value):
-    global colorG
-    colorG = value
-
-def colorB(value):
-    global colorB
-    colorB = value
-
-def send():
-    ds.setColor(colorR, colorG, colorB)
-    ds.sendReport()
-if __name__ == "__main__":
-    global ds
-    app = QtWidgets.QApplication(sys.argv)
-    MainWindow = QtWidgets.QMainWindow()
-    ui = Ui_MainWindow()
-    ui.setupUi(MainWindow)
-    ds = pydualsense()
-    # connect interface to  
-    ui.slider_r.valueChanged.connect(colorR)
-    ui.slider_g.valueChanged.connect(colorG)
-    ui.slider_b.valueChanged.connect(colorB)
-    ui.pushButton.clicked.connect(send)
-    MainWindow.show()
-    sys.exit(app.exec_())

pydualsense/pydualsense.py

@@ -1,24 +1,35 @@
-import hid
-from .enums import (LedOptions, PlayerID,
-                   PulseOptions, TriggerModes, Brightness)
-import threading
 
+# needed for python > 3.8
+import os, sys
+if sys.platform.startswith('win32') and sys.version_info >= (3,8):
+    os.add_dll_directory(os.getcwd())
+
+import hidapi
+from .enums import (LedOptions, PlayerID, PulseOptions, TriggerModes, Brightness) # type: ignore
+import threading
 class pydualsense:
 
-    def __init__(self) -> None:
+    def __init__(self, verbose: bool = False) -> None:#
         # TODO: maybe add a init function to not automatically allocate controller when class is declared
-        self.device: hid.Device = self.__find_device()
+        self.verbose = verbose
-        self.light = DSLight() # control led light of ds
-        self.audio = DSAudio()
-        self.triggerL = DSTrigger()
-        self.triggerR = DSTrigger()
-
-        self.color = (0,0,255) # set color around touchpad to blue
-
         self.receive_buffer_size = 64
         self.send_report_size = 48
-        # controller states
+
-        self.state = DSState()
+        self.leftMotor = 0
+        self.rightMotor = 0
+
+
+    def init(self):
+        """initialize module and device states
+        """
+        self.device: hidapi.Device = self.__find_device()
+        self.light = DSLight() # control led light of ds
+        self.audio = DSAudio() # ds audio setting
+        self.triggerL = DSTrigger() # left trigger
+        self.triggerR = DSTrigger() # right trigger
+
+        self.state = DSState() # controller states
+
 
         # thread for receiving and sending
         self.ds_thread = True
@@ -26,83 +37,80 @@ class pydualsense:
         self.report_thread.start()
 
     def close(self):
+        """
+        Stops the report thread and closes the HID device
+        """
         self.ds_thread = False
         self.report_thread.join()
+        self.device.close()
 
-    def __find_device(self):
-        devices = hid.enumerate(vid=0x054c)
-        found_devices = []
-        for device in devices:
-            if device['vendor_id'] == 0x054c and device['product_id'] == 0x0CE6:
-                found_devices.append(device)
 
+    def __find_device(self) -> hidapi.Device:
+        """
+        find HID device and open it
+
+        Raises:
+            Exception: HIDGuardian detected
+            Exception: No device detected
+
+        Returns:
+            hid.Device: returns opened controller device
+        """
         # TODO: detect connection mode, bluetooth has a bigger write buffer
         # TODO: implement multiple controllers working
-        if len(found_devices) != 1:
+        if sys.platform.startswith('win32'):
-            raise Exception('no dualsense controller detected')
+            import pydualsense.hidguardian as hidguardian
+            if hidguardian.check_hide():
+                raise Exception('HIDGuardian detected. Delete the controller from HIDGuardian and restart PC to connect to controller')
+        detected_device: hidapi.Device = None
+        devices = hidapi.enumerate(vendor_id=0x054c)
+        for device in devices:
+            if device.vendor_id == 0x054c and device.product_id == 0x0CE6:
+                detected_device = device
 
 
-        dual_sense = hid.Device(vid=found_devices[0]['vendor_id'], pid=found_devices[0]['product_id'])
+        if detected_device == None:
+            raise Exception('No device detected')
+
+        dual_sense = hidapi.Device(vendor_id=detected_device.vendor_id, product_id=detected_device.product_id)
         return dual_sense
 
-
+    def setLeftMotor(self, intensity: int):
-    # color stuff
-    def setColor(self, r: int, g:int, b:int):
-        if r > 255 or g > 255 or b > 255:
-            raise Exception('colors have values from 0 to 255 only')
-        self.color = (r,g,b)
-
-
-    # right trigger
-    def setRightTriggerMode(self, mode: TriggerModes):
-        """set the trigger mode for R2
-
-        :param mode: enum of Trigger mode
-        :type mode: TriggerModes
         """
-        self.triggerR.mode = mode
+        set left motor rumble
 
-    def setRightTriggerForce(self, forceID: int, force: int):
+        Args:
-        """set the right trigger force. trigger consist of 7 parameter
+            intensity (int): rumble intensity
 
-        :param forceID: parameter id from  0 to 6
+        Raises:
-        :type forceID: int
+            TypeError: intensity false type
-        :param force: force from 0..ff (0..255) applied to the trigger
+            Exception: intensity out of bounds 0..255
-        :type force: int
         """
-        if forceID > 6:
+        if not isinstance(intensity, int):
-            raise Exception('only 7 parameters available')
+            raise TypeError('left motor intensity needs to be an int')
 
-        self.triggerR.setForce(id=forceID, force=force)
+        if intensity > 255 or intensity < 0:
+            raise Exception('maximum intensity is 255')
+        self.leftMotor = intensity
 
 
-    # left trigger
+    def setRightMotor(self, intensity: int):
-    def setLeftTriggerMode(self, mode: TriggerModes):
-        """set the trigger mode for L2
-
-        :param mode: enum of Trigger mode
-        :type mode: TriggerModes
         """
-        self.triggerL.mode = mode
+        set right motor rumble
 
-    def setLeftTriggerForce(self, forceID: int, force: int):
+        Args:
-        """set the left trigger force. trigger consist of 7 parameter
+            intensity (int): rumble intensity
 
-        :param forceID: parameter id from  0 to 6
+        Raises:
-        :type forceID: int
+            TypeError: intensity false type
-        :param force: force from 0..ff (0..255) applied to the trigger
+            Exception: intensity out of bounds 0..255
-        :type force: int
         """
+        if not isinstance(intensity, int):
+            raise TypeError('right motor intensity needs to be an int')
 
-        if forceID > 6:
+        if intensity > 255 or intensity < 0:
-            raise Exception('only 7 parameters available')
+            raise Exception('maximum intensity is 255')
-        self.triggerL.setForce(id=forceID, force=force)
+        self.rightMotor = intensity
-
-
-    # TODO: audio
-    # audio stuff
-    def setMicrophoneLED(self, value):
-        self.audio.microphoneLED = value
 
 
     def sendReport(self):
@@ -112,7 +120,7 @@ class pydualsense:
 
             # read data from the input report of the controller
             inReport = self.device.read(self.receive_buffer_size)
-            
+            print(inReport)
             # decrypt the packet and bind the inputs
             self.readInput(inReport)
 
@@ -124,17 +132,18 @@ class pydualsense:
             self.writeReport(outReport)
 
     def readInput(self, inReport):
-        """read the reported data from the controller
+        """
+        read the input from the controller and assign the states
 
-        :param inReport: report of the controller
+        Args:
-        :type inReport: bytes
+            inReport (bytearray): read bytearray containing the state of the whole controller
         """
         states = list(inReport) # convert bytes to list
         # states 0 is always 1
-        self.state.LX = states[1]
+        self.state.LX = states[1] - 127
-        self.state.LY = states[2]
+        self.state.LY = states[2] - 127
-        self.state.RX = states[3]
+        self.state.RX = states[3] - 127
-        self.state.RY = states[4]
+        self.state.RY = states[4] - 127
         self.state.L2 = states[5]
         self.state.R2 = states[6]
 
@@ -189,21 +198,22 @@ class pydualsense:
         # TODO: control mouse with touchpad for fun as DS4Windows
 
 
-
     def writeReport(self, outReport):
-        """Write the given report to the device
+        """
+        write the report to the device
 
-        :param outReport: report with data for the controller
+        Args:
-        :type outReport: list
+            outReport (list): report to be written to device
         """
         self.device.write(bytes(outReport))
 
 
     def prepareReport(self):
-        """prepare the report for the controller with all the settings set since the previous update
+        """
+        prepare the output to be send to the controller
 
-        :return: report for the controller with all infos
+        Returns:
-        :rtype: list
+            list: report to send to controller
         """
         outReport = [0] * 48 # create empty list with range of output report
         # packet type
@@ -231,8 +241,8 @@ class pydualsense:
         # 0x80 ???
         outReport[2] = 0x1 | 0x2 | 0x4 | 0x10 | 0x40 # [2]
 
-        outReport[3]= 0 # left low freq motor 0-255 # [3]
+        outReport[3] = self.leftMotor # left low freq motor 0-255 # [3]
-        outReport[4] = 0 # right low freq motor 0-255 # [4]
+        outReport[4] = self.rightMotor # right low freq motor 0-255 # [4]
 
         # outReport[5] - outReport[8] audio related
 
@@ -262,14 +272,18 @@ class pydualsense:
         outReport[42] = self.light.pulseOptions.value
         outReport[43] = self.light.brightness.value
         outReport[44] = self.light.playerNumber.value
-        outReport[45] = self.color[0]
+        outReport[45] = self.light.TouchpadColor[0]
-        outReport[46] = self.color[1]
+        outReport[46] = self.light.TouchpadColor[1]
-        outReport[47] = self.color[2]
+        outReport[47] = self.light.TouchpadColor[2]
-
+        if self.verbose:
+            print(outReport)
         return outReport
 
 class DSTouchpad:
     def __init__(self) -> None:
+        """
+        Class represents the Touchpad of the controller
+        """
         self.isActive = False
         self.ID = 0
         self.X = 0
@@ -336,23 +350,113 @@ class DSState:
 
 
 class DSLight:
-    """DualSense Light class
+    """
-
+    Represents all features of lights on the controller
-        make it simple, no get or set functions. quick and dirty
     """
     def __init__(self) -> None:
         self.brightness: Brightness = Brightness.low # sets
         self.playerNumber: PlayerID = PlayerID.player1
         self.ledOption : LedOptions = LedOptions.Both
         self.pulseOptions : PulseOptions = PulseOptions.Off
+        self.TouchpadColor = (0,0,255)
+
+    def setLEDOption(self, option: LedOptions):
+        """
+        Sets the LED Option
+
+        Args:
+            option (LedOptions): Led option
+
+        Raises:
+            TypeError: LedOption is false type
+        """
+        if not isinstance(option, LedOptions):
+            raise TypeError('Need LEDOption type')
+        self.ledOption = option
+
+    def setPulseOption(self, option: PulseOptions):
+        """
+        Sets the Pulse Option of the LEDs
+
+        Args:
+            option (PulseOptions): pulse option of the LEDs
+
+        Raises:
+            TypeError: Pulse option is false type
+        """
+        if not isinstance(option, PulseOptions):
+            raise TypeError('Need PulseOption type')
+        self.pulseOptions = option
 
     def setBrightness(self, brightness: Brightness):
-        self._brightness = brightness
+        """
+        Defines the brightness of the Player LEDs
 
-    def setPlayerNumer(self, player):
+        Args:
-        if player > 5:
+            brightness (Brightness): brightness of LEDS
-            raise Exception('only 5 players supported. choose 1-5')
 
+        Raises:
+            TypeError: brightness false type
+        """
+        if not isinstance(brightness, Brightness):
+            raise TypeError('Need Brightness type')
+        self.brightness = brightness
+
+    def setPlayerID(self, player : PlayerID):
+        """
+        Sets the PlayerID of the controller with the choosen LEDs.
+        The controller has 4 Player states
+
+        Args:
+            player (PlayerID): chosen PlayerID for the Controller
+
+        Raises:
+            TypeError: [description]
+        """
+        if not isinstance(player, PlayerID):
+            raise TypeError('Need PlayerID type')
+        self.playerNumber = player
+
+    def setColorI(self, r: int , g: int, b: int) -> None:
+        """
+        Sets the Color around the Touchpad of the controller
+
+        Args:
+            r (int): red channel
+            g (int): green channel
+            b (int): blue channel
+
+        Raises:
+            TypeError: color channels have wrong type
+            Exception: color channels are out of bounds
+        """
+        if not isinstance(r, int) or not isinstance(g, int) or not isinstance(b, int):
+            raise TypeError('Color parameter need to be int')
+        # check if color is out of bounds
+        if (r > 255 or g > 255 or b > 255) or (r < 0 or g < 0 or b < 0):
+            raise Exception('colors have values from 0 to 255 only')
+        self.TouchpadColor = (r,g,b)
+
+
+    def setColorT(self, color: tuple) -> None:
+        """
+        Sets the Color around the Touchpad as a tuple
+
+        Args:
+            color (tuple): color as tuple
+
+        Raises:
+            TypeError: color has wrong type
+            Exception: color channels are out of bounds
+        """
+        if not isinstance(color, tuple):
+            raise TypeError('Color type is tuple')
+        # unpack for out of bounds check
+        r,g,b = map(int, color)
+        # check if color is out of bounds
+        if (r > 255 or g > 255 or b > 255) or (r < 0 or g < 0 or b < 0):
+            raise Exception('colors have values from 0 to 255 only')
+        self.TouchpadColor = (r,g,b)
 
 
 class DSAudio:
@@ -360,6 +464,21 @@ class DSAudio:
         self.microphone_mute = 0
         self.microphone_led = 0
 
+    def setMicrophoneLED(self, value):
+        """
+        Activates or disables the microphone led.
+        This doesnt change the mute/unmutes the microphone itself.
+
+        Args:
+            value (int): On or off microphone LED
+
+        Raises:
+            Exception: false state for the led
+        """
+        if value > 1 or value < 0:
+            raise Exception('Microphone LED can only be on or off (0 .. 1)')
+        self.microphone_led = value
+
 class DSTrigger:
     def __init__(self) -> None:
         # trigger modes
@@ -368,36 +487,37 @@ class DSTrigger:
         # force parameters for the triggers
         self.forces = [0 for i in range(7)]
 
-    def setForce(self, id:int = 0, force:int = 0):
+    def setForce(self, forceID: int = 0, force: int = 0):
-        """set the force of the trigger
-
-        :param id: id of the trigger parameters. 6 possible, defaults to 0
-        :type id: int, optional
-        :param force: force 0 to 255, defaults to 0
-        :type force: int, optional
-        :raises Exception: false trigger parameter accessed. only available trigger parameters from 0 to 6
         """
-        if id > 6 or id < 0:
+        Sets the forces of the choosen force parameter
-            raise Exception('only trigger parameters 0 to 6 available')
+
-        self.forces[id] = force
+        Args:
+            forceID (int, optional): force parameter. Defaults to 0.
+            force (int, optional): applied force to the parameter. Defaults to 0.
+
+        Raises:
+            TypeError: wrong type of forceID or force
+            Exception: choosen a false force parameter
+        """
+        if not isinstance(forceID, int) or not isinstance(force, int):
+            raise TypeError('forceID and force needs to be type int')
+
+        if forceID > 6 or forceID < 0:
+            raise Exception('only 7 parameters available')
+
+        self.forces[forceID] = force
 
     def setMode(self, mode: TriggerModes):
-        """set mode on the trigger
-
-        :param mode: mode for trigger
-        :type mode: TriggerModes
         """
+        Set the Mode for the Trigger
+
+        Args:
+            mode (TriggerModes): Trigger mode
+
+        Raises:
+            TypeError: false Trigger mode type
+        """
+        if not isinstance(mode, TriggerModes):
+            raise TypeError('Trigger mode parameter needs to be of type `TriggerModes`')
+
         self.mode = mode
-
-    def getTriggerPacket(self):
-        """returns array of the trigger modes and its parameters
-
-        :return: packet of the trigger settings
-        :rtype: list
-        """
-        # create packet
-        packet = [self.mode.value]
-        packet += [self.forces[i] for i in range(6)]
-        packet += [0,0] # unknown what these do ?
-        packet.append(self.forces[-1]) # last force has a offset of 2 from the other forces. this is the frequency of the actuation
-        return packet

requirements.txt

@@ -0,0 +1 @@
+hid==1.0.4

setup.py

@@ -6,7 +6,7 @@ with open("README.md", "r") as fh:
 
 setup(
     name='pydualsense',
-    version='0.1.0',    
+    version='0.5.1',
     description='use your DualSense (PS5) controller with python',
     long_description=long_description,
     long_description_content_type="text/markdown",
@@ -14,5 +14,5 @@ setup(
     author='Florian K',
     license='MIT License',
     packages=setuptools.find_packages(),
-    install_requires=['hid>=1.0.4']
+    install_requires=['hidapi-usb', 'cffi']
 )