Update setup.py

Add bluetooth readout

.github/workflows/docs_publish.yml

@@ -0,0 +1,22 @@
+name: publish_docs
+on: [push, workflow_dispatch]
+jobs:
+  docs:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+      - uses: actions/setup-python@v2
+      - name: Install dependencies
+        run: |
+          pip install sphinx furo
+      - name: Sphinx build
+        run: |
+          sphinx-build docs/source docs/build
+      - name: Deploy
+        uses: peaceiris/actions-gh-pages@v3
+        if: ${{ github.event_name == 'push' && github.ref == 'refs/heads/master' }}
+        with:
+          publish_branch: gh-pages
+          github_token: ${{ secrets.GITHUB_TOKEN }}
+          publish_dir: docs/build/
+          force_orphan: true

70-ps5-controller.rules

@@ -0,0 +1,11 @@
+# ref.: https://boilingsteam.com/the-dualsense-is-making-even-more-sense/
+# copy this file to /etc/udev/rules.d
+# reload udev rules with:
+#   udevadm control --reload-rules
+#   udevadm trigger
+
+# PS5 DualSense controller over USB hidraw
+KERNEL=="hidraw*", ATTRS{idVendor}=="054c", ATTRS{idProduct}=="0ce6", MODE="0660", TAG+="uaccess"
+
+# PS5 DualSense controller over bluetooth hidraw
+KERNEL=="hidraw*", KERNELS=="*054C:0CE6*", MODE="0660", TAG+="uaccess"

README.md

@@ -1,28 +1,64 @@
 # pydualsense
-control your dualsense through python. using the hid library this package implements the report features for controlling your new PS5 controller. 
+control your dualsense through python. using the hid library this package implements the report features for controlling your PS5 controller.
 
-# install
+# Documentation
 
+You can find the documentation at [docs](https://flok.github.io/pydualsense/)
+
+# Installation
+
+
+## Windows 
 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
+pip install --upgrade pydualsense
 ```
+
+## Linux
+
+On Linux based system you first need to add a udev rule to let the user access the PS5 controller without requiring root privileges.
+
+```bash
+sudo cp 70-ps5-controller.rules /etc/udev/rules.d
+sudo udevadm control --reload-rules
+sudo udevadm trigger
+```
+
+Then install the hidapi through your package manager of your system.
+
+On an Ubuntu system the package ```libhidapi-dev``` is required.
+
+```bash
+sudo apt install libhidapi-dev
+```
+
+After that install the package from [pypi](https://pypi.org/project/pydualsense/). 
+
+```bash
+pip install --upgrade pydualsense
+```
+
 # usage
 
 ```python
 
 from pydualsense import pydualsense, TriggerModes
 
+def cross_pressed(state):
+    print(state)
+
 ds = pydualsense() # open controller
 ds.init() # initialize controller
+
+ds.cross_pressed += cross_pressed
 ds.light.setColorI(255,0,0) # set touchpad color to red
 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
+See [examples](https://github.com/flok/pydualsense/tree/master/examples) or [examples docs](https://flok.github.io/pydualsense/examples.html) folder for some more ideas
 
 # Help wanted
 
@@ -30,7 +66,7 @@ Help wanted from people that want to use this and have feature requests. Just op
 
 # dependecies
 
-- hidapi-usb >= 0.2.6
+- hidapi-usb >= 0.3
 
 # Credits
 
@@ -45,5 +81,5 @@ Most stuff for this implementation were provided by and used from:
 
 - add bluetooth support
 - add multiple controllers
-- reading the states of the controller to enable a fully compatibility with python - partially done
+- partially done
 - add documentation using sphinx

docs/Makefile

@@ -0,0 +1,23 @@
+# Minimal makefile for Sphinx documentation
+#
+
+# You can set these variables from the command line, and also
+# from the environment for the first two.
+SPHINXOPTS    ?=
+SPHINXBUILD   ?= sphinx-build
+SOURCEDIR     = source
+BUILDDIR      = build
+
+# Put it first so that "make" without argument is like "make help".
+help:
+	@$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
+
+.PHONY: help Makefile
+
+# Catch-all target: route all unknown targets to Sphinx using the new
+# "make mode" option.  $(O) is meant as a shortcut for $(SPHINXOPTS).
+%: Makefile
+	@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
+
+generate_doc:
+	sphinx-apidoc ../pydualsense -f -o ./source  --ext-autodoc --ext-coverage --ext-todo

docs/source/api.rst

@@ -0,0 +1,10 @@
+API
+===
+
+This is the front page for the API documentation of the **pydualsense** library.
+
+
+.. toctree::
+    ds_enum
+    ds_main
+    ds_eventsystem

docs/source/conf.py

@@ -0,0 +1,43 @@
+import sys
+import os
+# Configuration file for the Sphinx documentation builder.
+#
+# For the full list of built-in configuration values, see the documentation:
+# https://www.sphinx-doc.org/en/master/usage/configuration.html
+
+# -- Project information -----------------------------------------------------
+# https://www.sphinx-doc.org/en/master/usage/configuration.html#project-information
+
+project = 'pydualsense'
+copyright = '2022, Florian (flok) K'
+author = 'Florian (flok) K'
+release = '0.6.1'
+
+sys.path.insert(0, os.path.abspath('..'))
+sys.path.insert(0, os.path.abspath('../../'))
+
+# -- General configuration ---------------------------------------------------
+# https://www.sphinx-doc.org/en/master/usage/configuration.html#general-configuration
+
+extensions = ['sphinx.ext.autodoc', 'sphinx.ext.napoleon', 'sphinx.ext.coverage', 'sphinx.ext.todo']
+
+templates_path = ['templates']
+exclude_patterns = []
+
+# -- Options for HTML output -------------------------------------------------
+# https://www.sphinx-doc.org/en/master/usage/configuration.html#options-for-html-output
+
+html_theme = 'furo'
+html_static_path = ['static']
+
+autodoc_default_options = {
+    'members': True,
+    'member-order': 'bysource',
+    'special-members': '__init__',
+    'undoc-members': True,
+    'exclude-members': '__weakref__'
+}
+
+autoclass_content = 'both'
+todo_include_todos = True
+

docs/source/ds_enum.rst

@@ -0,0 +1,11 @@
+pydualsense enums classes
+=========================
+
+The enum module provides the used `enums` by **pydualsense**. These `enums` are used to update the state of the controller as a parameter to call the used functions.
+
+
+.. automodule:: pydualsense.enums
+   :noindex:
+   :members:
+   :undoc-members:
+   :show-inheritance:

docs/source/ds_eventsystem.rst

@@ -0,0 +1,10 @@
+pydualsense event system classes
+=========================
+
+The `Event System` implements the event system used for the button callbacks
+
+.. automodule:: pydualsense.event_system
+   :noindex:
+   :members:
+   :undoc-members:
+   :show-inheritance:

docs/source/ds_main.rst

@@ -0,0 +1,11 @@
+pydualsense main class
+======================
+
+`pydualsense` is the main class of the library with the same name. It provides access to the states of the controller through manual reading of the :class:`DSState <pydualsense.pydualsense.DSState>`
+
+
+.. automodule:: pydualsense.pydualsense
+   :noindex:
+   :members:
+   :undoc-members:
+   :show-inheritance:

docs/source/examples.rst

@@ -0,0 +1,82 @@
+Examples
+========
+
+This pages displays some examples that on how the library can be used. All the examples can also be found inside the `examples` folder on the github repository.
+
+.. code-block:: python
+
+    from pydualsense import *
+
+    def cross_down(state):
+        print(f'cross {state}')
+
+
+    def circle_down(state):
+        print(f'circle {state}')
+
+
+    def dpad_down(state):
+        print(f'dpad down {state}')
+
+
+    def joystick(stateX, stateY):
+        print(f'joystick {stateX} {stateY}')
+
+
+    def gyro_changed(pitch, yaw, roll):
+        print(f'{pitch}, {yaw}, {roll}')
+
+    # create dualsense
+    dualsense = pydualsense()
+    # find device and initialize
+    dualsense.init()
+
+    # add events handler functions
+    dualsense.cross_pressed += cross_down
+    dualsense.circle_pressed += circle_down
+    dualsense.dpad_down += dpad_down
+    dualsense.left_joystick_changed += joystick
+    dualsense.gyro_changed += gyro_changed
+
+    # read controller state until R1 is pressed
+    while not dualsense.state.R1:
+        ...
+
+    # close device
+    dualsense.close()
+
+
+The above example demonstrates the newly added c# like event system that makes it possible to trigger an event for the inputs of the controller.
+
+
+.. code-block:: python
+
+    from pydualsense import *
+
+    # get dualsense instance
+    dualsense = pydualsense()
+    # initialize controller and connect
+    dualsense.init()
+
+    print('Trigger Effect demo started')
+
+    # set left and right rumble motors
+    dualsense.setLeftMotor(255)
+    dualsense.setRightMotor(100)
+
+    # set left l2 trigger to Rigid and set index 1 to force 255
+    dualsense.triggerL.setMode(TriggerModes.Rigid)
+    dualsense.triggerL.setForce(1, 255)
+
+    # set left r2 trigger to Rigid
+    dualsense.triggerR.setMode(TriggerModes.Pulse_A)
+    dualsense.triggerR.setForce(0, 200)
+    dualsense.triggerR.setForce(1, 255)
+    dualsense.triggerR.setForce(2, 175)
+
+    # loop until r1 is pressed to feel effect
+    while not dualsense.state.R1:
+        ...
+
+    # terminate the thread for message and close the device
+    dualsense.close()

docs/source/index.rst

@@ -0,0 +1,26 @@
+Welcome to pydualsense's documentation!
+=======================================
+
+
+**pydualsense** is a Python library that helps you interact with your PlayStation 5 DualSense controller. It reads the current state of the controller and also allows to update the triggers and other options on the controller.
+
+To get started check out the :doc:`usage` section for more information on how to install.
+
+
+.. note::
+   This project is under active development.
+
+Contents
+--------
+
+.. toctree::
+   usage
+   api
+   examples
+   modules
+
+
+TODOs
+-----
+
+.. todolist::

docs/source/modules.rst

@@ -0,0 +1,7 @@
+pydualsense
+===========
+
+.. toctree::
+   :maxdepth: 4
+
+   pydualsense

docs/source/pydualsense.rst

@@ -0,0 +1,45 @@
+pydualsense package
+===================
+
+Submodules
+----------
+
+pydualsense.enums module
+------------------------
+
+.. automodule:: pydualsense.enums
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+pydualsense.event\_system module
+--------------------------------
+
+.. automodule:: pydualsense.event_system
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+pydualsense.hidguardian module
+------------------------------
+
+.. automodule:: pydualsense.hidguardian
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+pydualsense.pydualsense module
+------------------------------
+
+.. automodule:: pydualsense.pydualsense
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+Module contents
+---------------
+
+.. automodule:: pydualsense
+   :members:
+   :undoc-members:
+   :show-inheritance:

docs/source/usage.rst

@@ -0,0 +1,38 @@
+Usage
+=====
+
+Installation
+------------
+
+To use **pydualsense**, first install it using pip:
+
+.. code-block:: console
+
+   (.venv) $ pip install --upgrade pydualsense
+
+This install the needed dependencies and the **pydualsense** library itself.
+
+
+Windows
+-------
+
+If you are on Windows the hidapi need to downloaded from `here <https://github.com/libusb/hidapi/releases>`_. 
+The downloaded `.dll` file need to be placed in a path that is in your environments variable `path`.
+
+
+Linux based
+-----------
+
+If you are on a linux based system (e.g debian) you need to first need to install the hidapi through your package manager.
+
+On Ubuntu systems the package `libhidapi-dev` is required.
+
+.. code-block:: console
+
+    sudo apt install libhidapi-dev
+
+
+Examples
+--------
+
+For code examles on using the library see :doc:`examples`

examples/effects.py

@@ -16,7 +16,8 @@ dualsense.triggerR.setForce(0, 200)
 dualsense.triggerR.setForce(1, 255)
 dualsense.triggerR.setForce(2, 175)
 
-import time; time.sleep(3)
-
+# loop until r1 is pressed to feel effect
+while not dualsense.state.R1:
+    ...
 # terminate the thread for message and close the device
 dualsense.close()

examples/leds.py

@@ -6,11 +6,11 @@ dualsense.init()
 # set color around touchpad to red
 dualsense.light.setColorI(255,0,0)
 # mute microphone
-dualsense.audio.setMicrophoneMute(True)
+dualsense.audio.setMicrophoneState(True)
 # set all player 1 indicator on
-dualsense.light.setPlayerID(PlayerID.player1)
+dualsense.light.setPlayerID(PlayerID.PLAYER_1)
 # 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()
+dualsense.close()

examples/read_all_input_channels.py

@@ -0,0 +1,53 @@
+import curses
+import time
+from pydualsense import *
+
+
+def print_states(stdscr):
+    curses.curs_set(0)
+    curses.use_default_colors()
+    stdscr.nodelay(1)
+    while True:
+        stdscr.erase()
+        pretty_states = [f"{state:03}" for state in dualsense.states]
+
+        stdscr.addstr(f"epoch: {time.time():.2f}\n")
+        stdscr.addstr(f"states[0:10]:  {pretty_states[0:10]}\n")
+        stdscr.addstr(f"states[10:20]: {pretty_states[10:20]}\n")
+        stdscr.addstr(f"states[20:30]: {pretty_states[20:30]}\n")
+        stdscr.addstr(f"states[30:40]: {pretty_states[30:40]}\n")
+        stdscr.addstr(f"states[40:50]: {pretty_states[40:50]}\n")
+        stdscr.addstr(f"states[50:60]: {pretty_states[50:60]}\n")
+        stdscr.addstr(f"states[60:70]: {pretty_states[60:70]}\n")
+        stdscr.addstr(f"states[70:78]: {pretty_states[70:78]}\n")
+        stdscr.addstr("\n")
+        stdscr.addstr(f"square: {dualsense.state.square!s:>5} \t triangle: {dualsense.state.triangle!s:>5} \t circle: {dualsense.state.circle!s:>5} \t cross: {dualsense.state.cross!s:>5}\n")
+        stdscr.addstr(f"DpadUp: {dualsense.state.DpadUp!s:>5} \t DpadDown: {dualsense.state.DpadDown!s:>5} \t DpadLeft: {dualsense.state.DpadLeft!s:>5} \t DpadRight: {dualsense.state.DpadRight!s:>5}\n")
+        stdscr.addstr(f"L1: {dualsense.state.L1!s:>5} \t L2: {dualsense.state.L2:3} \t L2Btn: {dualsense.state.L2Btn!s:>5} \t L3: {dualsense.state.L3!s:>5} \t R1: {dualsense.state.R1!s:>5} \t R2: {dualsense.state.R2:3d} \t R2Btn: {dualsense.state.R2Btn!s:>5} \t R3: {dualsense.state.R3!s:>5}\n")
+        stdscr.addstr(f"share: {dualsense.state.share!s:>5} \t options: {dualsense.state.options!s:>5} \t ps: {dualsense.state.ps!s:>5} \t touch1: {dualsense.state.touch1!s:>5} \t touch2: {dualsense.state.touch2!s:>5} \t touchBtn: {dualsense.state.touchBtn!s:>5} \t touchRight: {dualsense.state.touchRight!s:>5} \t touchLeft: {dualsense.state.touchLeft!s:>5}\n")
+        stdscr.addstr(f"touchFinger1: {dualsense.state.touchFinger1} \t touchFinger2: {dualsense.state.touchFinger2}\n")
+        stdscr.addstr(f"micBtn: {dualsense.state.micBtn!s:>5}\n")
+        stdscr.addstr(f"RX: {dualsense.state.RX:4} \t RY: {dualsense.state.RY:4} \t LX: {dualsense.state.LX:4} \t LY: {dualsense.state.LY:4}\n")
+        stdscr.addstr(f"trackPadTouch0: ID: {dualsense.state.trackPadTouch0.ID} \t isActive: {dualsense.state.trackPadTouch0.isActive!s:>5} \t X: {dualsense.state.trackPadTouch0.X:4d} \t Y: {dualsense.state.trackPadTouch0.Y:4d}\n")
+        stdscr.addstr(f"trackPadTouch1: ID: {dualsense.state.trackPadTouch1.ID} \t isActive: {dualsense.state.trackPadTouch1.isActive!s:>5} \t X: {dualsense.state.trackPadTouch1.X:4d} \t Y: {dualsense.state.trackPadTouch1.Y:4d}\n")
+        stdscr.addstr(f"gyro: roll: {dualsense.state.gyro.Roll:6} \t pitch: {dualsense.state.gyro.Pitch:6} \t yaw: {dualsense.state.gyro.Yaw:6}\n")
+        stdscr.addstr(f"acc: X: {dualsense.state.accelerometer.X:6} \t Y: {dualsense.state.accelerometer.Y:6} \t Z: {dualsense.state.accelerometer.Z:6}\n")
+        stdscr.addstr("\n")
+        stdscr.addstr("Exit script with 'q'\n")
+
+        stdscr.refresh()
+        if stdscr.getch() == ord('q'):
+            break
+
+
+dualsense = pydualsense()
+dualsense.init()
+
+while dualsense.states is None:
+    print("Waiting until connection is established...")
+    print(f"epoch: {time.time():.0f}")
+    time.sleep(0.5)
+
+
+curses.wrapper(print_states)
+dualsense.close()

examples/read_controller.py

@@ -1,15 +1,41 @@
 from pydualsense import *
 
+
+def cross_down(state):
+    print(f'cross {state}')
+
+
+def circle_down(state):
+    print(f'circle {state}')
+
+
+def dpad_down(state):
+    print(f'dpad {state}')
+
+
+def joystick(stateX, stateY):
+    print(f'lj {stateX} {stateY}')
+
+
+def gyro_changed(pitch, yaw, roll):
+    print(f'{pitch}, {yaw}, {roll}')
+
+
 # create dualsense
 dualsense = pydualsense()
 # find device and initialize
 dualsense.init()
 
+# add events handler functions
+dualsense.cross_pressed += cross_down
+dualsense.circle_pressed += circle_down
+dualsense.dpad_down += dpad_down
+dualsense.left_joystick_changed += joystick
+dualsense.gyro_changed += gyro_changed
+
 # 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,3 @@
-from .enums import LedOptions,Brightness,PlayerID,PulseOptions,TriggerModes
-from .pydualsense import pydualsense, DSLight, DSState, DSTouchpad, DSTrigger, DSAudio
+from .enums import LedOptions, Brightness, PlayerID, PulseOptions, TriggerModes
+from .event_system import Event
+from .pydualsense import pydualsense, DSLight, DSState, DSTouchpad, DSTrigger, DSAudio

pydualsense/enums.py

@@ -1,41 +1,46 @@
 from enum import IntFlag
 
+
 class ConnectionType(IntFlag):
-    BT = 0x0,
+    BT = 0x0
     USB = 0x1
+
+
 class LedOptions(IntFlag):
-    Off=0x0,
-    PlayerLedBrightness=0x1,
-    UninterrumpableLed=0x2,
-    Both=0x01 | 0x02
+    Off = 0x0
+    PlayerLedBrightness = 0x1
+    UninterrumpableLed = 0x2
+    Both = 0x01 | 0x02
+
 
 class PulseOptions(IntFlag):
-    Off=0x0,
-    FadeBlue=0x1,
-    FadeOut=0x2
+    Off = 0x0
+    FadeBlue = 0x1
+    FadeOut = 0x2
+
 
 class Brightness(IntFlag):
-    high = 0x0,
-    medium = 0x1,
+    high = 0x0
+    medium = 0x1
     low = 0x2
 
+
 class PlayerID(IntFlag):
-    player1 = 4,
-    player2 = 10,
-    player3 = 21,
-    player4 = 27,
-    all = 31
+    PLAYER_1 = 4
+    PLAYER_2 = 10
+    PLAYER_3 = 21
+    PLAYER_4 = 27
+    ALL = 31
 
 
 class TriggerModes(IntFlag):
-    Off = 0x0, # no resistance
-    Rigid = 0x1, # continous resistance
-    Pulse = 0x2, # section resistance
-    Rigid_A = 0x1 | 0x20,
-    Rigid_B = 0x1 | 0x04,
-    Rigid_AB = 0x1 | 0x20 | 0x04,
-    Pulse_A = 0x2 | 0x20,
-    Pulse_B = 0x2 | 0x04,
-    Pulse_AB = 0x2 | 0x20 | 0x04,
-    Calibration= 0xFC
-
+    Off = 0x0  # no resistance
+    Rigid = 0x1  # continous resistance
+    Pulse = 0x2  # section resistance
+    Rigid_A = 0x1 | 0x20
+    Rigid_B = 0x1 | 0x04
+    Rigid_AB = 0x1 | 0x20 | 0x04
+    Pulse_A = 0x2 | 0x20
+    Pulse_B = 0x2 | 0x04
+    Pulse_AB = 0x2 | 0x20 | 0x04
+    Calibration = 0xFC

pydualsense/event_system.py

@@ -0,0 +1,60 @@
+from collections import defaultdict
+
+
+class Event(object):
+    """
+    Base class for the event driven system
+    """
+
+    def __init__(self) -> None:
+        """
+        initialise event system
+        """
+        self._event_handler = []
+
+    def subscribe(self, fn):
+        """
+        add a event subscription
+
+        Args:
+            fn (function): _description_
+        """
+        self._event_handler.append(fn)
+        return self
+
+    def unsubscribe(self, fn):
+        """
+        delete event subscription fn
+
+        Args:
+            fn (function): _description_
+        """
+        self._event_handler.remove(fn)
+        return self
+
+    def __iadd__(self, fn):
+        """
+        add event subscription fn
+
+        Args:
+            fn (function): _description_
+        """
+        self._event_handler.append(fn)
+        return self
+
+    def __isub__(self, fn):
+        """
+        delete event subscription fn
+
+        Args:
+            fn (function): _description_
+        """
+        self._event_handler.remove(fn)
+        return self
+
+    def __call__(self, *args, **keywargs):
+        """
+        calls all event subscription functions
+        """
+        for eventhandler in self._event_handler:
+            eventhandler(*args, **keywargs)

pydualsense/hidguardian.py

@@ -1,18 +1,20 @@
 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:
-                pass
 
-        return False
+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, r'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:
+            pass
+
+    return False

pydualsense/pydualsense.py

@@ -1,72 +1,148 @@
-
-# needed for python > 3.8
-import os, sys
+import logging
+import os
+import sys
 from sys import platform
 
-if platform.startswith('Windows') and sys.version_info >= (3,8):
+if platform.startswith('Windows') and sys.version_info >= (3, 8):
     os.add_dll_directory(os.getcwd())
 
 import hidapi
 from .enums import (LedOptions, PlayerID, PulseOptions, TriggerModes, Brightness, ConnectionType) # type: ignore
 import threading
+from .event_system import Event
+from copy import deepcopy
+
+
+logger = logging.getLogger()
+FORMAT = '%(asctime)s %(message)s'
+logging.basicConfig(format=FORMAT)
+logger.setLevel(logging.INFO)
+
 class pydualsense:
 
-    def __init__(self, verbose: bool = False) -> None:#
+    def __init__(self, verbose: bool = False) -> None:
+        """
+        initialise the library but dont connect to the controller. call :func:`init() <pydualsense.pydualsense.init>` to connect to the controller
+
+        Args:
+            verbose (bool, optional): display verbose out (debug prints of input and output). Defaults to False.
+        """
         # TODO: maybe add a init function to not automatically allocate controller when class is declared
         self.verbose = verbose
 
+        if self.verbose:
+            logger.setLevel(logging.DEBUG)
+
         self.leftMotor = 0
         self.rightMotor = 0
 
+        self.last_states = None
 
-    def init(self):
-        """initialize module and device states
+        self.register_available_events()
+
+    def register_available_events(self) -> None:
+        """
+        register all available events that can be used for the controller
+        """
+
+        # button events
+        self.triangle_pressed = Event()
+        self.circle_pressed = Event()
+        self.cross_pressed = Event()
+        self.square_pressed = Event()
+
+        # dpad events
+        # TODO: add a event that sends the pressed key if any key is pressed
+        # self.dpad_changed = Event()
+        self.dpad_up = Event()
+        self.dpad_down = Event()
+        self.dpad_left = Event()
+        self.dpad_right = Event()
+
+        # joystick
+        self.left_joystick_changed = Event()
+        self.right_joystick_changed = Event()
+
+        # trigger back buttons
+        self.r1_changed = Event()
+        self.r2_changed = Event()
+        self.r3_changed = Event()
+
+        self.l1_changed = Event()
+        self.l2_changed = Event()
+        self.l3_changed = Event()
+
+        # misc
+        self.ps_pressed = Event()
+        self.touch_pressed = Event()
+        self.microphone_pressed = Event()
+        self.share_pressed = Event()
+        self.option_pressed = Event()
+
+        # trackpad touch
+        # handles 1 or 2 fingers
+        #self.trackpad_frame_reported = Event()
+
+        # gyrometer events
+        self.gyro_changed = Event()
+
+        self.accelerometer_changed = Event()
+
+    def init(self) -> None:
+        """
+        initialize module and device states. Starts the sendReport background thread at the end
         """
         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
-
-        if platform.startswith('Windows'):
-            self.conType = self.determineConnectionType() # determine USB or BT connection
-        else:
-            # set for usb manually
-            self.input_report_length = 64
-            self.output_report_length = 64
-
-
-        # thread for receiving and sending
+        self.conType = self.determineConnectionType() # determine USB or BT connection
         self.ds_thread = True
         self.report_thread = threading.Thread(target=self.sendReport)
         self.report_thread.start()
+        self.states = None
 
     def determineConnectionType(self) -> ConnectionType:
+        """
+        Determine the connection type of the controller. eg USB or BT.
 
-        if self.device._device.input_report_length == 64:
+        We ask the controller for an input report with a length up to 100 bytes
+        and afterwords check the lenght of the received input report.
+        The connection type determines the length of the report.
+
+        This way of determining is not pretty but it works..
+
+        Returns:
+            ConnectionType: Detected connection type of the controller.
+        """
+
+        dummy_report = self.device.read(100)
+        input_report_length = len(dummy_report)
+
+        if input_report_length == 64:
             self.input_report_length = 64
             self.output_report_length = 64
             return ConnectionType.USB
-        elif  self.device._device.input_report_length == 78:
+        elif input_report_length == 78:
             self.input_report_length = 78
             self.output_report_length = 78
             return ConnectionType.BT
 
-
-    def close(self):
+    def close(self) -> None:
         """
         Stops the report thread and closes the HID device
         """
+        # TODO: reset trigger effect to default
+
         self.ds_thread = False
         self.report_thread.join()
         self.device.close()
 
-
     def __find_device(self) -> hidapi.Device:
         """
-        find HID device and open it
+        find HID dualsense device and open it
 
         Raises:
             Exception: HIDGuardian detected
@@ -87,14 +163,13 @@ class pydualsense:
             if device.vendor_id == 0x054c and device.product_id == 0x0CE6:
                 detected_device = device
 
-
-        if detected_device == None:
+        if detected_device is 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):
+    def setLeftMotor(self, intensity: int) -> None:
         """
         set left motor rumble
 
@@ -112,8 +187,7 @@ class pydualsense:
             raise Exception('maximum intensity is 255')
         self.leftMotor = intensity
 
-
-    def setRightMotor(self, intensity: int):
+    def setRightMotor(self, intensity: int) -> None:
         """
         set right motor rumble
 
@@ -131,33 +205,39 @@ class pydualsense:
             raise Exception('maximum intensity is 255')
         self.rightMotor = intensity
 
-
-    def sendReport(self):
+    def sendReport(self) -> None:
         """background thread handling the reading of the device and updating its states
         """
         while self.ds_thread:
             # read data from the input report of the controller
             inReport = self.device.read(self.input_report_length)
             if self.verbose:
-                print(inReport)
+                logger.debug(inReport)
             # decrypt the packet and bind the inputs
             self.readInput(inReport)
 
-
             # prepare new report for device
             outReport = self.prepareReport()
 
             # write the report to the device
             self.writeReport(outReport)
 
-    def readInput(self, inReport):
+    def readInput(self, inReport) -> None:
         """
         read the input from the controller and assign the states
 
         Args:
             inReport (bytearray): read bytearray containing the state of the whole controller
         """
-        states = list(inReport) # convert bytes to list
+        if self.conType == ConnectionType.BT:
+            # the reports for BT and USB are structured the same,
+            # but there is one more byte at the start of the bluetooth report.
+            # We drop that byte, so that the format matches up again.
+            states = list(inReport)[1:] # convert bytes to list
+        else: # USB
+            states = list(inReport) # convert bytes to list
+
+        self.states = states
         # states 0 is always 1
         self.state.LX = states[1] - 127
         self.state.LY = states[2] - 127
@@ -174,7 +254,6 @@ class pydualsense:
         self.state.cross = (buttonState & (1 << 5)) != 0
         self.state.square = (buttonState & (1 << 4)) != 0
 
-
         # dpad
         dpad_state = buttonState & 0x0F
         self.state.setDPadState(dpad_state)
@@ -194,7 +273,6 @@ class pydualsense:
         self.state.touchBtn = (misc2 & 0x02) != 0
         self.state.micBtn = (misc2 & 0x04) != 0
 
-
         # trackpad touch
         self.state.trackPadTouch0.ID = inReport[33] & 0x7F
         self.state.trackPadTouch0.isActive = (inReport[33] & 0x80) == 0
@@ -207,18 +285,104 @@ class pydualsense:
         self.state.trackPadTouch1.X = ((inReport[39] & 0x0f) << 8) | (inReport[38])
         self.state.trackPadTouch1.Y = ((inReport[40]) << 4) | ((inReport[39] & 0xf0) >> 4)
 
-       # print(f'1Active = {self.state.trackPadTouch0.isActive}')
-       # print(f'X1: {self.state.trackPadTouch0.X} Y2: {self.state.trackPadTouch0.Y}')
+        # accelerometer
+        self.state.accelerometer.X = int.from_bytes(([inReport[16], inReport[17]]), byteorder='little', signed=True)
+        self.state.accelerometer.Y = int.from_bytes(([inReport[18], inReport[19]]), byteorder='little', signed=True)
+        self.state.accelerometer.Z = int.from_bytes(([inReport[20], inReport[21]]), byteorder='little', signed=True)
 
-       # print(f'2Active = {self.state.trackPadTouch1.isActive}')
-       # print(f'X2: {self.state.trackPadTouch1.X} Y2: {self.state.trackPadTouch1.Y}')
-       # print(f'DPAD {self.state.DpadLeft} {self.state.DpadUp} {self.state.DpadRight} {self.state.DpadDown}')
+        # gyrometer
+        self.state.gyro.Pitch = int.from_bytes(([inReport[22], inReport[23]]), byteorder='little', signed=True)
+        self.state.gyro.Yaw = int.from_bytes(([inReport[24], inReport[25]]), byteorder='little', signed=True)
+        self.state.gyro.Roll = int.from_bytes(([inReport[26], inReport[27]]), byteorder='little', signed=True)
+
+        # first call we dont have a "last state" so we create if with the first occurence
+        if self.last_states is None:
+            self.last_states = deepcopy(self.state)
+            return
+
+        # send all events if neede
+        if self.state.circle != self.last_states.circle:
+            self.circle_pressed(self.state.circle)
+
+        if self.state.cross != self.last_states.cross:
+            self.cross_pressed(self.state.cross)
+
+        if self.state.triangle != self.last_states.triangle:
+            self.triangle_pressed(self.state.triangle)
+
+        if self.state.square != self.last_states.square:
+            self.square_pressed(self.state.square)
+
+        if self.state.DpadDown != self.last_states.DpadDown:
+            self.dpad_down(self.state.DpadDown)
+
+        if self.state.DpadLeft != self.last_states.DpadLeft:
+            self.dpad_left(self.state.DpadLeft)
+
+        if self.state.DpadRight != self.last_states.DpadRight:
+            self.dpad_right(self.state.DpadRight)
+
+        if self.state.DpadUp != self.last_states.DpadUp:
+            self.dpad_up(self.state.DpadUp)
+
+        if self.state.LX != self.last_states.LX or self.state.LY != self.last_states.LY:
+            self.left_joystick_changed(self.state.LX, self.state.LY)
+
+        if self.state.RX != self.last_states.RX or self.state.RY != self.last_states.RY:
+            self.right_joystick_changed(self.state.RX, self.state.RY)
+
+        if self.state.R1 != self.last_states.R1:
+            self.r1_changed(self.state.R1)
+
+        if self.state.R2 != self.last_states.R2:
+            self.r2_changed(self.state.R2)
+
+        if self.state.L1 != self.last_states.L1:
+            self.l1_changed(self.state.L1)
+
+        if self.state.L2 != self.last_states.L2:
+            self.l2_changed(self.state.L2)
+
+        if self.state.R3 != self.last_states.R3:
+            self.r3_changed(self.state.R3)
+
+        if self.state.L3 != self.last_states.L3:
+            self.l3_changed(self.state.L3)
+
+        if self.state.ps != self.last_states.ps:
+            self.ps_pressed(self.state.ps)
+
+        if self.state.touchBtn != self.last_states.touchBtn:
+            self.touch_pressed(self.state.touchBtn)
+
+        if self.state.micBtn != self.last_states.micBtn:
+            self.microphone_pressed(self.state.micBtn)
+
+        if self.state.share != self.last_states.share:
+            self.share_pressed(self.state.share)
+
+        if self.state.options != self.last_states.options:
+            self.option_pressed(self.state.options)
+
+        if self.state.accelerometer.X != self.last_states.accelerometer.X or \
+            self.state.accelerometer.Y != self.last_states.accelerometer.Y or \
+                self.state.accelerometer.Z != self.last_states.accelerometer.Z:
+            self.accelerometer_changed(self.state.accelerometer.X, self.state.accelerometer.Y, self.state.accelerometer.Z)
+
+        if self.state.gyro.Pitch != self.last_states.gyro.Pitch or \
+            self.state.gyro.Yaw != self.last_states.gyro.Yaw or \
+                self.state.gyro.Roll != self.last_states.gyro.Roll:
+            self.gyro_changed(self.state.gyro.Pitch, self.state.gyro.Yaw, self.state.gyro.Roll)
+
+        """
+        copy current state into temp object to check next cycle if a change occuret
+        and event trigger is needed
+        """
+        self.last_states = deepcopy(self.state) # copy current state into object to check next time
 
-        # TODO: implement gyrometer and accelerometer
         # TODO: control mouse with touchpad for fun as DS4Windows
 
-
-    def writeReport(self, outReport):
+    def writeReport(self, outReport) -> None:
         """
         write the report to the device
 
@@ -227,8 +391,7 @@ class pydualsense:
         """
         self.device.write(bytes(outReport))
 
-
-    def prepareReport(self):
+    def prepareReport(self) -> None:
         """
         prepare the output to be send to the controller
 
@@ -240,7 +403,6 @@ class pydualsense:
         # packet type
         outReport[0] = 0x2
 
-
         # flags determing what changes this packet will perform
         # 0x01 set the main motors (also requires flag 0x02); setting this by itself will allow rumble to gracefully terminate and then re-enable audio haptics, whereas not setting it will kill the rumble instantly and re-enable audio haptics.
         # 0x02 set the main motors (also requires flag 0x01; without bit 0x01 motors are allowed to time out without re-enabling audio haptics)
@@ -262,15 +424,15 @@ class pydualsense:
         # 0x80 ???
         outReport[2] = 0x1 | 0x2 | 0x4 | 0x10 | 0x40 # [2]
 
-        outReport[3] = self.leftMotor # left low freq motor 0-255 # [3]
-        outReport[4] = self.rightMotor # right low freq motor 0-255 # [4]
+        outReport[3] = self.rightMotor # right low freq motor 0-255 # [3]
+        outReport[4] = self.leftMotor # left low freq motor 0-255 # [4]
 
         # outReport[5] - outReport[8] audio related
 
         # set Micrphone LED, setting doesnt effect microphone settings
         outReport[9] = self.audio.microphone_led # [9]
 
-        outReport[10] = 0x10 if self.audio.microphone_mute == True else 0x00
+        outReport[10] = 0x10 if self.audio.microphone_mute is True else 0x00
 
         # add right trigger mode + parameters to packet
         outReport[11] = self.triggerR.mode.value
@@ -298,11 +460,17 @@ class pydualsense:
         outReport[45] = self.light.TouchpadColor[0]
         outReport[46] = self.light.TouchpadColor[1]
         outReport[47] = self.light.TouchpadColor[2]
+
         if self.verbose:
-            print(outReport)
+            logger.debug(outReport)
+
         return outReport
 
+
 class DSTouchpad:
+    """
+    Dualsense Touchpad class. Contains X and Y position of touch and if the touch isActive
+    """
     def __init__(self) -> None:
         """
         Class represents the Touchpad of the controller
@@ -312,19 +480,31 @@ class DSTouchpad:
         self.X = 0
         self.Y = 0
 
+
 class DSState:
 
     def __init__(self) -> None:
-        self.packerC = 0
+        """
+        All dualsense states (inputs) that can be read. Second method to check if a input is pressed.
+        """
         self.square, self.triangle, self.circle, self.cross = False, False, False, False
         self.DpadUp, self.DpadDown, self.DpadLeft, self.DpadRight = False, False, False, False
         self.L1, self.L2, self.L3, self.R1, self.R2, self.R3, self.R2Btn, self.L2Btn = False, False, False, False, False, False, False, False
         self.share, self.options, self.ps, self.touch1, self.touch2, self.touchBtn, self.touchRight, self.touchLeft = False, False, False, False, False, False, False, False
         self.touchFinger1, self.touchFinger2 = False, False
-        self.RX, self.RY, self.LX, self.LY = 128,128,128,128
+        self.micBtn = False
+        self.RX, self.RY, self.LX, self.LY = 128, 128, 128, 128
         self.trackPadTouch0, self.trackPadTouch1 = DSTouchpad(), DSTouchpad()
+        self.gyro = DSGyro()
+        self.accelerometer = DSAccelerometer()
 
-    def setDPadState(self, dpad_state):
+    def setDPadState(self, dpad_state: int):
+        """
+        Sets the dpad state variables according to the integers that was read from the controller
+
+        Args:
+            dpad_state (int): integer number representing the dpad state
+        """
         if dpad_state == 0:
             self.DpadUp = True
             self.DpadDown = False
@@ -378,10 +558,10 @@ class DSLight:
     """
     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)
+        self.playerNumber: PlayerID = PlayerID.PLAYER_1
+        self.ledOption: LedOptions = LedOptions.Both
+        self.pulseOptions: PulseOptions = PulseOptions.Off
+        self.TouchpadColor = (0, 0, 255)
 
     def setLEDOption(self, option: LedOptions):
         """
@@ -425,7 +605,7 @@ class DSLight:
             raise TypeError('Need Brightness type')
         self.brightness = brightness
 
-    def setPlayerID(self, player : PlayerID):
+    def setPlayerID(self, player: PlayerID):
         """
         Sets the PlayerID of the controller with the choosen LEDs.
         The controller has 4 Player states
@@ -440,7 +620,7 @@ class DSLight:
             raise TypeError('Need PlayerID type')
         self.playerNumber = player
 
-    def setColorI(self, r: int , g: int, b: int) -> None:
+    def setColorI(self, r: int, g: int, b: int) -> None:
         """
         Sets the Color around the Touchpad of the controller
 
@@ -458,8 +638,7 @@ class DSLight:
         # 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)
-
+        self.TouchpadColor = (r, g, b)
 
     def setColorT(self, color: tuple) -> None:
         """
@@ -475,15 +654,18 @@ class DSLight:
         if not isinstance(color, tuple):
             raise TypeError('Color type is tuple')
         # unpack for out of bounds check
-        r,g,b = map(int, color)
+        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)
+        self.TouchpadColor = (r, g, b)
 
 
 class DSAudio:
     def __init__(self) -> None:
+        """
+        initialize the limited Audio features of the controller
+        """
         self.microphone_mute = 0
         self.microphone_led = 0
 
@@ -499,10 +681,19 @@ class DSAudio:
             Exception: false state for the led
         """
         if not isinstance(value, bool):
-           raise TypeError('MicrophoneLED can only be a bool')
+            raise TypeError('MicrophoneLED can only be a bool')
         self.microphone_led = value
 
-    def setMicrophoneMute(self, state):
+    def setMicrophoneState(self, state: bool):
+        """
+        Set the microphone state and also sets the microphone led accordingle
+
+        Args:
+            state (bool): desired state of the microphone
+
+        Raises:
+            TypeError: state was not a bool
+        """
 
         if not isinstance(state, bool):
             raise TypeError('state needs to be bool')
@@ -512,9 +703,14 @@ class DSAudio:
 
 
 class DSTrigger:
+    """
+    Dualsense trigger class. Allowes for multiple :class:`TriggerModes <pydualsense.enums.TriggerModes>` and multiple forces
+
+    # TODO: make this interface more userfriendly so a developer knows what he is doing
+    """
     def __init__(self) -> None:
         # trigger modes
-        self.mode : TriggerModes = TriggerModes.Off
+        self.mode: TriggerModes = TriggerModes.Off
 
         # force parameters for the triggers
         self.forces = [0 for i in range(7)]
@@ -553,3 +749,23 @@ class DSTrigger:
             raise TypeError('Trigger mode parameter needs to be of type `TriggerModes`')
 
         self.mode = mode
+
+
+class DSGyro:
+    """
+    Class representing the Gyro2 of the controller
+    """
+    def __init__(self) -> None:
+        self.Pitch = 0
+        self.Yaw = 0
+        self.Roll = 0
+
+
+class DSAccelerometer:
+    """
+    Class representing the Accelerometer of the controller
+    """
+    def __init__(self) -> None:
+        self.X = 0
+        self.Y = 0
+        self.Z = 0

requirements.txt

@@ -1 +1,3 @@
-hid==1.0.4
+hid-usb
+sphinx
+furo

setup.py

@@ -6,12 +6,12 @@ with open("README.md", "r") as fh:
 
 setup(
     name='pydualsense',
-    version='0.5.5',
+    version='0.6.4',
     description='use your DualSense (PS5) controller with python',
     long_description=long_description,
     long_description_content_type="text/markdown",
     url='https://github.com/flok/pydualsense',
-    author='Florian K',
+    author='Florian (flok) K',
     license='MIT License',
     packages=setuptools.find_packages(),
     install_requires=['hidapi-usb>=0.3', 'cffi']