release of 0.6.2

Update to 0.6.2 for typo and new release

.github/workflows/docs_publish.yml

@@ -0,0 +1,22 @@
+name: publish_docs
+on: [push, pull_request, 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

.gitignore

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

LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2020 Florian K.
+
+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.

README.md

@@ -1,2 +1,77 @@
 # pydualsense
-controll your dualsense through python
+control your dualsense through python. using the hid library this package implements the report features for controlling your PS5 controller.
+
+# 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 --upgrade pydualsense
+```
+
+## Linux
+
+On Linux based system you first need to 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) or [examples docs](https://flok.github.io/pydualsense/examples.html) 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
+
+- hidapi-usb >= 0.3
+
+# 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
+- 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,9 @@
+API
+===
+
+This is the front page for the API documentation of the **pydualsense** library.
+
+
+.. toctree::
+    ds_enum
+    ds_main

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_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,25 @@
+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
+
+
+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/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,23 @@
+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)
+
+# 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

@@ -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)
+# mute microphone
+dualsense.audio.setMicrophoneState(True)
+# 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,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:
+    ...
+
+# close device
+dualsense.close()

pydualsense/__init__.py

@@ -0,0 +1,3 @@
+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,39 +1,46 @@
-from enum import Enum, IntFlag
-from flags import Flags # bitflag
+from enum import IntFlag
+
+
+class ConnectionType(IntFlag):
+    BT = 0x0
+    USB = 0x1
+
+
+class LedOptions(IntFlag):
+    Off = 0x0
+    PlayerLedBrightness = 0x1
+    UninterrumpableLed = 0x2
+    Both = 0x01 | 0x02
 
-class LedOptions(IntFlag): 
-    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 = 1,
-    player2 = 2,
-    player3 = 4,
-    player4 = 8,
-    player5 = 16,
-    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

@@ -0,0 +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, 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-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,116 +1,406 @@
-import hid
-from enums import (LedOptions, PlayerID,
-                   PulseOptions, TriggerModes, Brightness)
+import logging
+import os
+import sys
+from sys import platform
+
+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) -> 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.device = self.__find_device()
+        self.verbose = verbose
+
+        if self.verbose:
+            logger.setLevel(logging.DEBUG)
+
+        self.leftMotor = 0
+        self.rightMotor = 0
+
+        self.last_states = None
+
+        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()
-        self.triggerL = DSTrigger()
-        self.triggerR = DSTrigger()
+        self.audio = DSAudio() # ds audio setting
+        self.triggerL = DSTrigger() # left trigger
+        self.triggerR = DSTrigger() # right trigger
+        self.state = DSState() # controller states
 
-        # set default for the controller
-        self.color = (0,0,255) # set dualsense color around the touchpad to blue
+        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
 
-        self.send_thread = True
-        send_report = threading.Thread(target=self.sendReport)
-        #send_report.start()
-        # create thread for sending
+        self.ds_thread = True
+        self.report_thread = threading.Thread(target=self.sendReport)
+        self.report_thread.start()
 
-    def __find_device(self):
-        devices = hid.enumerate(vid=0x054c)
-        found_devices = []
-        for device in devices:
-            if device['vendor_id'] == 0x54c and device['product_id'] == 0xCE6:
-                found_devices.append(device)
+    def determineConnectionType(self) -> ConnectionType:
+        """
+        Determine the connection type of the controller. eg USB or BT.
 
+        Currently only USB is supported.
+
+        Returns:
+            ConnectionType: Detected connection type of the controller.
+        """
+
+        if self.device._device.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:
+            self.input_report_length = 78
+            self.output_report_length = 78
+            return ConnectionType.BT
+
+    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 dualsense 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:
-            raise Exception('no dualsense controller detected')
+        if sys.platform.startswith('win32'):
+            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 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
-    
 
-    # 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
+    def setLeftMotor(self, intensity: int) -> None:
         """
-        self.triggerR.mode = mode
+        set left motor rumble
 
-    def setRightTriggerForce(self, forceID: int, force: int):
-        """set the right trigger force. trigger consist of 7 parameter
+        Args:
+            intensity (int): rumble intensity
 
-        :param forceID: parameter id from  0 to 6
-        :type forceID: int
-        :param force: force from 0..ff (0..255) applied to the trigger
-        :type force: int
+        Raises:
+            TypeError: intensity false type
+            Exception: intensity out of bounds 0..255
         """
-        if forceID > 6:
-            raise Exception('only 7 parameters available')
+        if not isinstance(intensity, int):
+            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 setLeftTriggerMode(self, mode: TriggerModes):
-        """set the trigger mode for L2
-
-        :param mode: enum of Trigger mode
-        :type mode: TriggerModes
+    def setRightMotor(self, intensity: int) -> None:
         """
-        self.triggerL.mode = mode
+        set right motor rumble
 
-    def setLeftTriggerForce(self, forceID: int, force: int):
-        """set the left trigger force. trigger consist of 7 parameter
+        Args:
+            intensity (int): rumble intensity
 
-        :param forceID: parameter id from  0 to 6
-        :type forceID: int
-        :param force: force from 0..ff (0..255) applied to the trigger
-        :type force: int
+        Raises:
+            TypeError: intensity false type
+            Exception: intensity out of bounds 0..255
+        """
+        if not isinstance(intensity, int):
+            raise TypeError('right motor intensity needs to be an int')
+
+        if intensity > 255 or intensity < 0:
+            raise Exception('maximum intensity is 255')
+        self.rightMotor = intensity
+
+    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:
+                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) -> 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
+        # states 0 is always 1
+        self.state.LX = states[1] - 127
+        self.state.LY = states[2] - 127
+        self.state.RX = states[3] - 127
+        self.state.RY = states[4] - 127
+        self.state.L2 = states[5]
+        self.state.R2 = states[6]
+
+        # state 7 always increments -> not used anywhere
+
+        buttonState = states[8]
+        self.state.triangle = (buttonState & (1 << 7)) != 0
+        self.state.circle = (buttonState & (1 << 6)) != 0
+        self.state.cross = (buttonState & (1 << 5)) != 0
+        self.state.square = (buttonState & (1 << 4)) != 0
+
+        # dpad
+        dpad_state = buttonState & 0x0F
+        self.state.setDPadState(dpad_state)
+
+        misc = states[9]
+        self.state.R3 = (misc & (1 << 7)) != 0
+        self.state.L3 = (misc & (1 << 6)) != 0
+        self.state.options = (misc & (1 << 5)) != 0
+        self.state.share = (misc & (1 << 4)) != 0
+        self.state.R2Btn = (misc & (1 << 3)) != 0
+        self.state.L2Btn = (misc & (1 << 2)) != 0
+        self.state.R1 = (misc & (1 << 1)) != 0
+        self.state.L1 = (misc & (1 << 0)) != 0
+
+        misc2 = states[10]
+        self.state.ps = (misc2 & (1 << 0)) != 0
+        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
+        self.state.trackPadTouch0.X = ((inReport[35] & 0x0f) << 8) | (inReport[34])
+        self.state.trackPadTouch0.Y = ((inReport[36]) << 4) | ((inReport[35] & 0xf0) >> 4)
+
+        # trackpad touch
+        self.state.trackPadTouch1.ID = inReport[37] & 0x7F
+        self.state.trackPadTouch1.isActive = (inReport[37] & 0x80) == 0
+        self.state.trackPadTouch1.X = ((inReport[39] & 0x0f) << 8) | (inReport[38])
+        self.state.trackPadTouch1.Y = ((inReport[40]) << 4) | ((inReport[39] & 0xf0) >> 4)
+
+        # 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)
+
+        # 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: control mouse with touchpad for fun as DS4Windows
+
+    def writeReport(self, outReport) -> None:
+        """
+        write the report to the device
+
+        Args:
+            outReport (list): report to be written to device
+        """
+        self.device.write(bytes(outReport))
+
+    def prepareReport(self) -> None:
+        """
+        prepare the output to be send to the controller
+
+        Returns:
+            list: report to send to controller
         """
 
-        if forceID > 6:
-            raise Exception('only 7 parameters available')
-        self.triggerL.setForce(id=forceID, force=force)
-
-
-    # TODO: audio
-    # audio stuff
-    def setMicrophoneLED(self, value):
-        self.audio.microphoneLED = 0x1
-
-
-    def sendReport(self):
-       # while self.send_thread:
-        outReport = [0] * 48 # create empty list with range of output report
-        # packet type 
+        outReport = [0] * self.output_report_length # create empty list with range of output report
+        # 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)
         # 0x04 set the right trigger motor
         # 0x08 set the left trigger motor
         # 0x10 modification of audio volume
-        # 0x20 toggling of internal speaker while headset is connected 
+        # 0x20 toggling of internal speaker while headset is connected
         # 0x40 modification of microphone volume
         outReport[1] = 0xff # [1]
 
@@ -121,23 +411,19 @@ class pydualsense:
         # 0x08 will actively turn all LEDs off? Convenience flag? (if so, third parties might not support it properly)
         # 0x10 toggling white player indicator LEDs below touchpad
         # 0x20 ???
-        # 0x40 adjustment of overall motor/effect power (index 37 - read note on triggers) 
+        # 0x40 adjustment of overall motor/effect power (index 37 - read note on triggers)
         # 0x80 ???
         outReport[2] = 0x1 | 0x2 | 0x4 | 0x10 | 0x40 # [2]
-        
-        outReport[3]= 0 # left low freq motor 0-255 # [3]
-        outReport[4] = 0 # right low freq motor 0-255 # [4]
 
+        outReport[3] = self.leftMotor # left low freq motor 0-255 # [3]
+        outReport[4] = self.rightMotor # right 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]
 
-        # set microphone muting
-        
-
+        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
@@ -158,104 +444,319 @@ class pydualsense:
         outReport[28] = self.triggerL.forces[5]
         outReport[31] = self.triggerL.forces[6]
 
-
-        """
-        outReport.append(self.light.ledOption.value[0]) # 
-        outReport.append(self.light.pulseOptions.value[0])
-        outReport.append(self.light.brightness.value[0])
-        outReport.append(self.light.playerNumber.value[0])
-        outReport.append(self.color[0]) # r
-        outReport.append(self.color[1]) # g
-        outReport.append(self.color[2]) # b
-        """
         outReport[39] = self.light.ledOption.value
         outReport[42] = self.light.pulseOptions.value
         outReport[43] = self.light.brightness.value
         outReport[44] = self.light.playerNumber.value
-        outReport[45] = self.color[0]
-        outReport[46] = self.color[1]
-        outReport[47] = self.color[2]
-        self.device.write(bytes(outReport)) # send to controller
+        outReport[45] = self.light.TouchpadColor[0]
+        outReport[46] = self.light.TouchpadColor[1]
+        outReport[47] = self.light.TouchpadColor[2]
 
+        if self.verbose:
+            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
+        """
+        self.isActive = False
+        self.ID = 0
+        self.X = 0
+        self.Y = 0
+
+
+class DSState:
+
+    def __init__(self) -> None:
+        """
+        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.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: 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
+            self.DpadLeft = False
+            self.DpadRight = False
+        elif dpad_state == 1:
+            self.DpadUp = True
+            self.DpadDown = False
+            self.DpadLeft = False
+            self.DpadRight = True
+        elif dpad_state == 2:
+            self.DpadUp = False
+            self.DpadDown = False
+            self.DpadLeft = False
+            self.DpadRight = True
+        elif dpad_state == 3:
+            self.DpadUp = False
+            self.DpadDown = True
+            self.DpadLeft = False
+            self.DpadRight = True
+        elif dpad_state == 4:
+            self.DpadUp = False
+            self.DpadDown = True
+            self.DpadLeft = False
+            self.DpadRight = False
+        elif dpad_state == 5:
+            self.DpadUp = False
+            self.DpadDown = True
+            self.DpadLeft = False
+            self.DpadRight = False
+        elif dpad_state == 6:
+            self.DpadUp = False
+            self.DpadDown = False
+            self.DpadLeft = True
+            self.DpadRight = False
+        elif dpad_state == 7:
+            self.DpadUp = True
+            self.DpadDown = False
+            self.DpadLeft = True
+            self.DpadRight = False
+        else:
+            self.DpadUp = False
+            self.DpadDown = False
+            self.DpadLeft = False
+            self.DpadRight = False
 
 
 class DSLight:
-    """DualSense Light class
-
-        make it simple, no get or set functions. quick and dirty
+    """
+    Represents all features of lights on the controller
     """
     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.brightness: Brightness = Brightness.low # sets
+        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):
+        """
+        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):
-        if player > 5:
-            raise Exception('only 5 players supported. choose 1-5')
+        Args:
+            brightness (Brightness): brightness of LEDS
+
+        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:
     def __init__(self) -> None:
+        """
+        initialize the limited Audio features of the controller
+        """
         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 (bool): On or off microphone LED
+
+        Raises:
+            Exception: false state for the led
+        """
+        if not isinstance(value, bool):
+            raise TypeError('MicrophoneLED can only be a bool')
+        self.microphone_led = value
+
+    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')
+
+        self.setMicrophoneLED(state) # set led accordingly
+        self.microphone_mute = state
+
+
 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)]
 
-    def setForce(self, id: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
+    def setForce(self, forceID: int = 0, force: int = 0):
         """
-        if id > 6 or id < 0:
-            raise Exception('only trigger parameters 0 to 6 available')
-        self.forces[id] = force
+        Sets the forces of the choosen force parameter
+
+        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
-    
-if __name__ == "__main__":
-    ds = pydualsense()
-    import time
-  #  ds.triggerR.setMode(TriggerModes.Rigid)
- #   ds.triggerR.setForce(0, 255)
-    ds.setLeftTriggerMode(TriggerModes.Pulse)
-    ds.setLeftTriggerForce(1, 255)
-    ds.setRightTriggerMode(TriggerModes.Rigid)
-    ds.setRightTriggerForce(1, 255)
-#    ds.triggerL.setForce(6,255)
-    ds.sendReport()
-    time.sleep(2)
-    time.sleep(3)
+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

@@ -0,0 +1,3 @@
+hid-usb
+sphinx
+furo

setup.py

@@ -6,14 +6,13 @@ with open("README.md", "r") as fh:
 
 setup(
     name='pydualsense',
-    version='0.0.1',    
-    description='control your dualsense controller with python',
+    version='0.6.2',
+    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 Kaiser',
-    author_email='shudson@anl.gov',
-    license='BSD 2-clause',
+    author='Florian (flok) K',
+    license='MIT License',
     packages=setuptools.find_packages(),
-    install_requires=['hid>=1.0.4']
+    install_requires=['hidapi-usb>=0.3', 'cffi']
 )