Compare commits
40 Commits
Author | SHA1 | Date | |
---|---|---|---|
|
b3ff9fd375 | ||
|
98b13798cd | ||
|
b51c8b49f6 | ||
|
cdbe03ad56 | ||
|
3a14ab3e7a | ||
|
32f9042abb | ||
|
4c86d71633 | ||
|
9c79d961f1 | ||
|
c1c10e4eac | ||
|
04ce807bc0 | ||
|
71a49da5d2 | ||
|
f4e1d73dd3 | ||
|
e766dca70f | ||
|
1e0b23da41 | ||
|
ff01788c89 | ||
|
c07b975bc5 | ||
|
7b0270fa7d | ||
|
d76717c163 | ||
|
786657cc90 | ||
|
11e78fbece | ||
|
a3f697866b | ||
|
1530c79dd7 | ||
|
83a37750d1 | ||
|
bc0eb35c3c | ||
|
93b5e38e6e | ||
|
94cb09dbdd | ||
|
8fb31f86ba | ||
|
e04766d48d | ||
|
c39f3f2ea5 | ||
|
ea319db5a3 | ||
|
d62e8d133e | ||
|
fe435f6e36 | ||
|
cc767d5fcd | ||
|
1ab69d6c96 | ||
|
b004d2bc7b | ||
|
3f16538555 | ||
|
f1be774e68 | ||
|
9560d8e637 | ||
|
ecb42d9c0a | ||
|
604c5f2800 |
3
.gitignore
vendored
3
.gitignore
vendored
@@ -149,6 +149,9 @@ dmypy.json
|
|||||||
!.vscode/extensions.json
|
!.vscode/extensions.json
|
||||||
*.code-workspace
|
*.code-workspace
|
||||||
|
|
||||||
|
### pycharm ###
|
||||||
|
.idea/*
|
||||||
|
|
||||||
# End of https://www.toptal.com/developers/gitignore/api/python,vscode
|
# End of https://www.toptal.com/developers/gitignore/api/python,vscode
|
||||||
|
|
||||||
pydualsense/interface.py
|
pydualsense/interface.py
|
||||||
|
36
README.md
36
README.md
@@ -1,35 +1,49 @@
|
|||||||
# pydualsense
|
# pydualsense
|
||||||
control your dualsense through python. using the hid library this module implements the sending report for controlling you new PS5 controller. It creates a background thread to constantly receive and update the controller.
|
control your dualsense through python. using the hid library this package implements the report features for controlling your new PS5 controller.
|
||||||
|
|
||||||
# install
|
# install
|
||||||
|
|
||||||
Just install the package from pypi
|
Download [hidapi](https://github.com/libusb/hidapi/releases) and place the x64 .dll file into your Workspace. After that install the package from [pypi](https://pypi.org/project/pydualsense/).
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
pip install pydualsense
|
pip install pydualsense
|
||||||
```
|
```
|
||||||
# usage
|
# usage
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
```python
|
```python
|
||||||
|
|
||||||
from pydualsense import pydualsense
|
from pydualsense import pydualsense, TriggerModes
|
||||||
|
|
||||||
ds = pydualsense() # open controller
|
ds = pydualsense() # open controller
|
||||||
ds.setColor(255,0,0) # set touchpad color to red
|
ds.init() # initialize controller
|
||||||
ds.setLeftTriggerMode(TriggerModes.Rigid)
|
ds.light.setColorI(255,0,0) # set touchpad color to red
|
||||||
ds.setLeftTriggerForce(1, 255)
|
ds.triggerL.setMode(TriggerModes.Rigid)
|
||||||
|
ds.triggerL.setForce(1, 255)
|
||||||
ds.close() # closing the controller
|
ds.close() # closing the controller
|
||||||
```
|
```
|
||||||
|
|
||||||
See ``examples`` folder for some more ideas
|
See [examples](https://github.com/flok/pydualsense/tree/master/examples) folder for some more ideas
|
||||||
|
|
||||||
|
# Help wanted
|
||||||
|
|
||||||
|
Help wanted from people that want to use this and have feature requests. Just open a issue with the correct label.
|
||||||
|
|
||||||
# dependecies
|
# dependecies
|
||||||
|
|
||||||
- hid >= 1.0.4
|
- hidapi-usb >= 0.2.6
|
||||||
|
|
||||||
|
# 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
|
# Coming soon
|
||||||
|
|
||||||
|
- add bluetooth support
|
||||||
|
- add multiple controllers
|
||||||
- reading the states of the controller to enable a fully compatibility with python - partially done
|
- reading the states of the controller to enable a fully compatibility with python - partially done
|
||||||
- add documentation using sphinx
|
- add documentation using sphinx
|
||||||
|
15
examples/README.md
Normal file
15
examples/README.md
Normal file
@@ -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
|
22
examples/effects.py
Normal file
22
examples/effects.py
Normal file
@@ -0,0 +1,22 @@
|
|||||||
|
from pydualsense import *
|
||||||
|
|
||||||
|
# get dualsense instance
|
||||||
|
dualsense = pydualsense()
|
||||||
|
dualsense.init()
|
||||||
|
|
||||||
|
print('Trigger Effect demo started')
|
||||||
|
|
||||||
|
dualsense.setLeftMotor(255)
|
||||||
|
dualsense.setRightMotor(100)
|
||||||
|
dualsense.triggerL.setMode(TriggerModes.Rigid)
|
||||||
|
dualsense.triggerL.setForce(1, 255)
|
||||||
|
|
||||||
|
dualsense.triggerR.setMode(TriggerModes.Pulse_A)
|
||||||
|
dualsense.triggerR.setForce(0, 200)
|
||||||
|
dualsense.triggerR.setForce(1, 255)
|
||||||
|
dualsense.triggerR.setForce(2, 175)
|
||||||
|
|
||||||
|
import time; time.sleep(3)
|
||||||
|
|
||||||
|
# terminate the thread for message and close the device
|
||||||
|
dualsense.close()
|
@@ -2,12 +2,13 @@ from pydualsense import *
|
|||||||
|
|
||||||
# get dualsense instance
|
# get dualsense instance
|
||||||
dualsense = pydualsense()
|
dualsense = pydualsense()
|
||||||
|
dualsense.init()
|
||||||
# set color around touchpad to red
|
# set color around touchpad to red
|
||||||
dualsense.setColor(0,0,255)
|
dualsense.light.setColorI(255,0,0)
|
||||||
# enable microphone indicator
|
# mute microphone
|
||||||
dualsense.setMicrophoneLED(1)
|
dualsense.audio.setMicrophoneMute(True)
|
||||||
# set all player indicators on
|
# set all player 1 indicator on
|
||||||
dualsense.setPlayer(PlayerID.all)
|
dualsense.light.setPlayerID(PlayerID.player1)
|
||||||
# sleep a little to see the result on the controller
|
# sleep a little to see the result on the controller
|
||||||
# this is not needed in normal usage
|
# this is not needed in normal usage
|
||||||
import time; time.sleep(2)
|
import time; time.sleep(2)
|
||||||
|
15
examples/read_controller.py
Normal file
15
examples/read_controller.py
Normal file
@@ -0,0 +1,15 @@
|
|||||||
|
from pydualsense import *
|
||||||
|
|
||||||
|
# create dualsense
|
||||||
|
dualsense = pydualsense()
|
||||||
|
# find device and initialize
|
||||||
|
dualsense.init()
|
||||||
|
|
||||||
|
# read controller state until R1 is pressed
|
||||||
|
while not dualsense.state.R1:
|
||||||
|
print(f"Circle : {dualsense.state.circle} Cross : {dualsense.state.cross} L Stick X : {dualsense.state.LX} L Stick Y : {dualsense.state.LY}")
|
||||||
|
|
||||||
|
# close device
|
||||||
|
dualsense.close()
|
||||||
|
|
||||||
|
|
@@ -1,12 +0,0 @@
|
|||||||
from pydualsense import *
|
|
||||||
|
|
||||||
# get dualsense instance
|
|
||||||
dualsense = pydualsense()
|
|
||||||
# set left trigger mode to rigid and put some force values on it
|
|
||||||
dualsense.setLeftTriggerMode(TriggerModes.Rigid)
|
|
||||||
dualsense.setLeftTriggerForce(1, 255)
|
|
||||||
# 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()
|
|
@@ -1,2 +1,2 @@
|
|||||||
from .enums import LedOptions,Brightness,PlayerID,PulseOptions,TriggerModes
|
from .enums import LedOptions,Brightness,PlayerID,PulseOptions,TriggerModes
|
||||||
from .pydualsense import pydualsense, DSAudio, DSLight, DSTrigger
|
from .pydualsense import pydualsense, DSLight, DSState, DSTouchpad, DSTrigger, DSAudio
|
@@ -1,5 +1,8 @@
|
|||||||
from enum import IntFlag
|
from enum import IntFlag
|
||||||
|
|
||||||
|
class ConnectionType(IntFlag):
|
||||||
|
BT = 0x0,
|
||||||
|
USB = 0x1
|
||||||
class LedOptions(IntFlag):
|
class LedOptions(IntFlag):
|
||||||
Off=0x0,
|
Off=0x0,
|
||||||
PlayerLedBrightness=0x1,
|
PlayerLedBrightness=0x1,
|
||||||
@@ -17,13 +20,13 @@ class Brightness(IntFlag):
|
|||||||
low = 0x2
|
low = 0x2
|
||||||
|
|
||||||
class PlayerID(IntFlag):
|
class PlayerID(IntFlag):
|
||||||
player1 = 1,
|
player1 = 4,
|
||||||
player2 = 2,
|
player2 = 10,
|
||||||
player3 = 4,
|
player3 = 21,
|
||||||
player4 = 8,
|
player4 = 27,
|
||||||
player5 = 16,
|
|
||||||
all = 31
|
all = 31
|
||||||
|
|
||||||
|
|
||||||
class TriggerModes(IntFlag):
|
class TriggerModes(IntFlag):
|
||||||
Off = 0x0, # no resistance
|
Off = 0x0, # no resistance
|
||||||
Rigid = 0x1, # continous resistance
|
Rigid = 0x1, # continous resistance
|
||||||
|
18
pydualsense/hidguardian.py
Normal file
18
pydualsense/hidguardian.py
Normal file
@@ -0,0 +1,18 @@
|
|||||||
|
import winreg
|
||||||
|
import sys
|
||||||
|
|
||||||
|
def check_hide() -> bool:
|
||||||
|
"""check if hidguardian is used and controller is hidden
|
||||||
|
"""
|
||||||
|
if sys.platform.startswith('win32'):
|
||||||
|
try:
|
||||||
|
access_reg = winreg.ConnectRegistry(None, winreg.HKEY_LOCAL_MACHINE)
|
||||||
|
access_key = winreg.OpenKey(access_reg, 'SYSTEM\CurrentControlSet\Services\HidGuardian\Parameters', 0, winreg.KEY_READ)
|
||||||
|
affected_devices = winreg.QueryValueEx(access_key, 'AffectedDevices')[0]
|
||||||
|
if "054C" in affected_devices and "0CE6" in affected_devices:
|
||||||
|
return True
|
||||||
|
return False
|
||||||
|
except OSError as e:
|
||||||
|
pass
|
||||||
|
|
||||||
|
return False
|
@@ -1,167 +1,138 @@
|
|||||||
import hid
|
|
||||||
from .enums import (LedOptions, PlayerID,
|
|
||||||
PulseOptions, TriggerModes, Brightness)
|
|
||||||
import threading
|
|
||||||
|
|
||||||
|
# needed for python > 3.8
|
||||||
|
import os, sys
|
||||||
|
if sys.platform.startswith('win32') and sys.version_info >= (3,8):
|
||||||
|
os.add_dll_directory(os.getcwd())
|
||||||
|
|
||||||
|
import hidapi
|
||||||
|
from .enums import (LedOptions, PlayerID, PulseOptions, TriggerModes, Brightness, ConnectionType) # type: ignore
|
||||||
|
import threading
|
||||||
class pydualsense:
|
class pydualsense:
|
||||||
|
|
||||||
def __init__(self, verbose: bool = False) -> None:
|
def __init__(self, verbose: bool = False) -> None:#
|
||||||
# TODO: maybe add a init function to not automatically allocate controller when class is declared
|
# TODO: maybe add a init function to not automatically allocate controller when class is declared
|
||||||
self.verbose = verbose
|
self.verbose = verbose
|
||||||
|
|
||||||
self.device: hid.Device = self.__find_device()
|
self.leftMotor = 0
|
||||||
|
self.rightMotor = 0
|
||||||
|
|
||||||
|
|
||||||
|
def init(self):
|
||||||
|
"""initialize module and device states
|
||||||
|
"""
|
||||||
|
self.device: hidapi.Device = self.__find_device()
|
||||||
self.light = DSLight() # control led light of ds
|
self.light = DSLight() # control led light of ds
|
||||||
self.audio = DSAudio()
|
self.audio = DSAudio() # ds audio setting
|
||||||
self.triggerL = DSTrigger()
|
self.triggerL = DSTrigger() # left trigger
|
||||||
self.triggerR = DSTrigger()
|
self.triggerR = DSTrigger() # right trigger
|
||||||
|
|
||||||
self.color = (0,0,255) # set color around touchpad to blue
|
self.state = DSState() # controller states
|
||||||
|
|
||||||
|
self.conType = self.determineConnectionType() # determine USB or BT connection
|
||||||
|
|
||||||
self.receive_buffer_size = 64
|
|
||||||
self.send_report_size = 48
|
|
||||||
# controller states
|
|
||||||
self.state = DSState()
|
|
||||||
|
|
||||||
# thread for receiving and sending
|
# thread for receiving and sending
|
||||||
self.ds_thread = True
|
self.ds_thread = True
|
||||||
self.report_thread = threading.Thread(target=self.sendReport)
|
self.report_thread = threading.Thread(target=self.sendReport)
|
||||||
self.report_thread.start()
|
self.report_thread.start()
|
||||||
|
|
||||||
|
def determineConnectionType(self) -> ConnectionType:
|
||||||
|
|
||||||
|
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):
|
def close(self):
|
||||||
|
"""
|
||||||
|
Stops the report thread and closes the HID device
|
||||||
|
"""
|
||||||
self.ds_thread = False
|
self.ds_thread = False
|
||||||
self.report_thread.join()
|
self.report_thread.join()
|
||||||
self.device.close()
|
self.device.close()
|
||||||
|
|
||||||
def __find_device(self):
|
|
||||||
devices = hid.enumerate(vid=0x054c)
|
|
||||||
found_devices = []
|
|
||||||
for device in devices:
|
|
||||||
if device['vendor_id'] == 0x054c and device['product_id'] == 0x0CE6:
|
|
||||||
found_devices.append(device)
|
|
||||||
|
|
||||||
|
def __find_device(self) -> hidapi.Device:
|
||||||
|
"""
|
||||||
|
find HID device and open it
|
||||||
|
|
||||||
|
Raises:
|
||||||
|
Exception: HIDGuardian detected
|
||||||
|
Exception: No device detected
|
||||||
|
|
||||||
|
Returns:
|
||||||
|
hid.Device: returns opened controller device
|
||||||
|
"""
|
||||||
# TODO: detect connection mode, bluetooth has a bigger write buffer
|
# TODO: detect connection mode, bluetooth has a bigger write buffer
|
||||||
# TODO: implement multiple controllers working
|
# TODO: implement multiple controllers working
|
||||||
if len(found_devices) != 1:
|
if sys.platform.startswith('win32'):
|
||||||
raise Exception('no dualsense controller detected')
|
import pydualsense.hidguardian as hidguardian
|
||||||
|
if hidguardian.check_hide():
|
||||||
|
raise Exception('HIDGuardian detected. Delete the controller from HIDGuardian and restart PC to connect to controller')
|
||||||
|
detected_device: hidapi.Device = None
|
||||||
|
devices = hidapi.enumerate(vendor_id=0x054c)
|
||||||
|
for device in devices:
|
||||||
|
if device.vendor_id == 0x054c and device.product_id == 0x0CE6:
|
||||||
|
detected_device = device
|
||||||
|
|
||||||
|
|
||||||
dual_sense = hid.Device(vid=found_devices[0]['vendor_id'], pid=found_devices[0]['product_id'])
|
if detected_device == None:
|
||||||
|
raise Exception('No device detected')
|
||||||
|
|
||||||
|
dual_sense = hidapi.Device(vendor_id=detected_device.vendor_id, product_id=detected_device.product_id)
|
||||||
return dual_sense
|
return dual_sense
|
||||||
|
|
||||||
|
def setLeftMotor(self, intensity: int):
|
||||||
|
|
||||||
# right trigger
|
|
||||||
def setRightTriggerMode(self, mode: TriggerModes):
|
|
||||||
"""set the trigger mode for R2
|
|
||||||
|
|
||||||
:param mode: enum of Trigger mode
|
|
||||||
:type mode: TriggerModes
|
|
||||||
"""
|
"""
|
||||||
self.triggerR.mode = mode
|
set left motor rumble
|
||||||
|
|
||||||
def setRightTriggerForce(self, forceID: int, force: int):
|
Args:
|
||||||
"""set the right trigger force. trigger consist of 7 parameter
|
intensity (int): rumble intensity
|
||||||
|
|
||||||
:param forceID: parameter id from 0 to 6
|
Raises:
|
||||||
:type forceID: int
|
TypeError: intensity false type
|
||||||
:param force: force from 0..ff (0..255) applied to the trigger
|
Exception: intensity out of bounds 0..255
|
||||||
:type force: int
|
|
||||||
"""
|
"""
|
||||||
if forceID > 6:
|
if not isinstance(intensity, int):
|
||||||
raise Exception('only 7 parameters available')
|
raise TypeError('left motor intensity needs to be an int')
|
||||||
|
|
||||||
self.triggerR.setForce(id=forceID, force=force)
|
if intensity > 255 or intensity < 0:
|
||||||
|
raise Exception('maximum intensity is 255')
|
||||||
|
self.leftMotor = intensity
|
||||||
|
|
||||||
|
|
||||||
# left trigger
|
def setRightMotor(self, intensity: int):
|
||||||
def setLeftTriggerMode(self, mode: TriggerModes):
|
|
||||||
"""set the trigger mode for L2
|
|
||||||
|
|
||||||
:param mode: enum of Trigger mode
|
|
||||||
:type mode: TriggerModes
|
|
||||||
"""
|
"""
|
||||||
self.triggerL.mode = mode
|
set right motor rumble
|
||||||
|
|
||||||
def setLeftTriggerForce(self, forceID: int, force: int):
|
Args:
|
||||||
"""set the left trigger force. trigger consist of 7 parameter
|
intensity (int): rumble intensity
|
||||||
|
|
||||||
:param forceID: parameter id from 0 to 6
|
Raises:
|
||||||
:type forceID: int
|
TypeError: intensity false type
|
||||||
:param force: force from 0..ff (0..255) applied to the trigger
|
Exception: intensity out of bounds 0..255
|
||||||
:type force: int
|
|
||||||
"""
|
"""
|
||||||
|
if not isinstance(intensity, int):
|
||||||
|
raise TypeError('right motor intensity needs to be an int')
|
||||||
|
|
||||||
if forceID > 6:
|
if intensity > 255 or intensity < 0:
|
||||||
raise Exception('only 7 parameters available')
|
raise Exception('maximum intensity is 255')
|
||||||
self.triggerL.setForce(id=forceID, force=force)
|
self.rightMotor = intensity
|
||||||
|
|
||||||
|
|
||||||
# TODO: audio
|
|
||||||
# audio stuff
|
|
||||||
def setMicrophoneLED(self, value):
|
|
||||||
self.audio.microphone_led = value
|
|
||||||
|
|
||||||
# color stuff
|
|
||||||
def setColor(self, r: int, g:int, b:int):
|
|
||||||
"""sets the led colour around the touchpad
|
|
||||||
|
|
||||||
:param r: red channel, 0..255
|
|
||||||
:type r: int
|
|
||||||
:param g: green channel, 0..255
|
|
||||||
:type g: int
|
|
||||||
:param b: blue channel, 0..255
|
|
||||||
:type b: int
|
|
||||||
:raises Exception: wron color values
|
|
||||||
"""
|
|
||||||
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.color = (r,g,b)
|
|
||||||
|
|
||||||
def setLEDOption(self, option: LedOptions):
|
|
||||||
"""set led option
|
|
||||||
|
|
||||||
:param option: led option
|
|
||||||
:type option: LedOptions
|
|
||||||
"""
|
|
||||||
self.light.ledOption = option
|
|
||||||
|
|
||||||
def setPulseOption(self, option: PulseOptions):
|
|
||||||
"""set the pulse option for the leds
|
|
||||||
|
|
||||||
:param option: [description]
|
|
||||||
:type option: PulseOptions
|
|
||||||
"""
|
|
||||||
self.light.pulseOptions = option
|
|
||||||
|
|
||||||
def setBrightness(self, brightness: Brightness):
|
|
||||||
"""set the brightness of the player leds
|
|
||||||
|
|
||||||
:param brightness: brightness for the leds
|
|
||||||
:type brightness: Brightness
|
|
||||||
"""
|
|
||||||
self.light.brightness = brightness
|
|
||||||
|
|
||||||
def setPlayerID(self, player : PlayerID):
|
|
||||||
"""set the player ID. The controller has 5 white LED which signals
|
|
||||||
which player the controller is
|
|
||||||
|
|
||||||
:param player: the player id from 1 to 5
|
|
||||||
:type player: PlayerID
|
|
||||||
"""
|
|
||||||
self.light.playerNumber = player
|
|
||||||
|
|
||||||
def sendReport(self):
|
def sendReport(self):
|
||||||
"""background thread handling the reading of the device and updating its states
|
"""background thread handling the reading of the device and updating its states
|
||||||
"""
|
"""
|
||||||
while self.ds_thread:
|
while self.ds_thread:
|
||||||
|
|
||||||
# read data from the input report of the controller
|
# read data from the input report of the controller
|
||||||
inReport = self.device.read(self.receive_buffer_size)
|
inReport = self.device.read(self.input_report_length)
|
||||||
|
if self.verbose:
|
||||||
|
print(inReport)
|
||||||
# decrypt the packet and bind the inputs
|
# decrypt the packet and bind the inputs
|
||||||
self.readInput(inReport)
|
self.readInput(inReport)
|
||||||
|
|
||||||
@@ -173,17 +144,18 @@ class pydualsense:
|
|||||||
self.writeReport(outReport)
|
self.writeReport(outReport)
|
||||||
|
|
||||||
def readInput(self, inReport):
|
def readInput(self, inReport):
|
||||||
"""read the reported data from the controller
|
"""
|
||||||
|
read the input from the controller and assign the states
|
||||||
|
|
||||||
:param inReport: report of the controller
|
Args:
|
||||||
:type inReport: bytes
|
inReport (bytearray): read bytearray containing the state of the whole controller
|
||||||
"""
|
"""
|
||||||
states = list(inReport) # convert bytes to list
|
states = list(inReport) # convert bytes to list
|
||||||
# states 0 is always 1
|
# states 0 is always 1
|
||||||
self.state.LX = states[1]
|
self.state.LX = states[1] - 127
|
||||||
self.state.LY = states[2]
|
self.state.LY = states[2] - 127
|
||||||
self.state.RX = states[3]
|
self.state.RX = states[3] - 127
|
||||||
self.state.RY = states[4]
|
self.state.RY = states[4] - 127
|
||||||
self.state.L2 = states[5]
|
self.state.L2 = states[5]
|
||||||
self.state.R2 = states[6]
|
self.state.R2 = states[6]
|
||||||
|
|
||||||
@@ -239,21 +211,24 @@ class pydualsense:
|
|||||||
|
|
||||||
|
|
||||||
def writeReport(self, outReport):
|
def writeReport(self, outReport):
|
||||||
"""Write the given report to the device
|
"""
|
||||||
|
write the report to the device
|
||||||
|
|
||||||
:param outReport: report with data for the controller
|
Args:
|
||||||
:type outReport: list
|
outReport (list): report to be written to device
|
||||||
"""
|
"""
|
||||||
self.device.write(bytes(outReport))
|
self.device.write(bytes(outReport))
|
||||||
|
|
||||||
|
|
||||||
def prepareReport(self):
|
def prepareReport(self):
|
||||||
"""prepare the report for the controller with all the settings set since the previous update
|
|
||||||
|
|
||||||
:return: report for the controller with all infos
|
|
||||||
:rtype: list
|
|
||||||
"""
|
"""
|
||||||
outReport = [0] * 48 # create empty list with range of output report
|
prepare the output to be send to the controller
|
||||||
|
|
||||||
|
Returns:
|
||||||
|
list: report to send to controller
|
||||||
|
"""
|
||||||
|
|
||||||
|
outReport = [0] * self.output_report_length # create empty list with range of output report
|
||||||
# packet type
|
# packet type
|
||||||
outReport[0] = 0x2
|
outReport[0] = 0x2
|
||||||
|
|
||||||
@@ -279,14 +254,16 @@ class pydualsense:
|
|||||||
# 0x80 ???
|
# 0x80 ???
|
||||||
outReport[2] = 0x1 | 0x2 | 0x4 | 0x10 | 0x40 # [2]
|
outReport[2] = 0x1 | 0x2 | 0x4 | 0x10 | 0x40 # [2]
|
||||||
|
|
||||||
outReport[3] = 0 # left low freq motor 0-255 # [3]
|
outReport[3] = self.leftMotor # left low freq motor 0-255 # [3]
|
||||||
outReport[4] = 0 # right low freq motor 0-255 # [4]
|
outReport[4] = self.rightMotor # right low freq motor 0-255 # [4]
|
||||||
|
|
||||||
# outReport[5] - outReport[8] audio related
|
# outReport[5] - outReport[8] audio related
|
||||||
|
|
||||||
# set Micrphone LED, setting doesnt effect microphone settings
|
# set Micrphone LED, setting doesnt effect microphone settings
|
||||||
outReport[9] = self.audio.microphone_led # [9]
|
outReport[9] = self.audio.microphone_led # [9]
|
||||||
|
|
||||||
|
outReport[10] = 0x10 if self.audio.microphone_state == True else 0x00
|
||||||
|
|
||||||
# add right trigger mode + parameters to packet
|
# add right trigger mode + parameters to packet
|
||||||
outReport[11] = self.triggerR.mode.value
|
outReport[11] = self.triggerR.mode.value
|
||||||
outReport[12] = self.triggerR.forces[0]
|
outReport[12] = self.triggerR.forces[0]
|
||||||
@@ -310,15 +287,18 @@ class pydualsense:
|
|||||||
outReport[42] = self.light.pulseOptions.value
|
outReport[42] = self.light.pulseOptions.value
|
||||||
outReport[43] = self.light.brightness.value
|
outReport[43] = self.light.brightness.value
|
||||||
outReport[44] = self.light.playerNumber.value
|
outReport[44] = self.light.playerNumber.value
|
||||||
outReport[45] = self.color[0]
|
outReport[45] = self.light.TouchpadColor[0]
|
||||||
outReport[46] = self.color[1]
|
outReport[46] = self.light.TouchpadColor[1]
|
||||||
outReport[47] = self.color[2]
|
outReport[47] = self.light.TouchpadColor[2]
|
||||||
if self.verbose:
|
if self.verbose:
|
||||||
print(outReport)
|
print(outReport)
|
||||||
return outReport
|
return outReport
|
||||||
|
|
||||||
class DSTouchpad:
|
class DSTouchpad:
|
||||||
def __init__(self) -> None:
|
def __init__(self) -> None:
|
||||||
|
"""
|
||||||
|
Class represents the Touchpad of the controller
|
||||||
|
"""
|
||||||
self.isActive = False
|
self.isActive = False
|
||||||
self.ID = 0
|
self.ID = 0
|
||||||
self.X = 0
|
self.X = 0
|
||||||
@@ -385,23 +365,113 @@ class DSState:
|
|||||||
|
|
||||||
|
|
||||||
class DSLight:
|
class DSLight:
|
||||||
"""DualSense Light class
|
"""
|
||||||
|
Represents all features of lights on the controller
|
||||||
make it simple, no get or set functions. quick and dirty
|
|
||||||
"""
|
"""
|
||||||
def __init__(self) -> None:
|
def __init__(self) -> None:
|
||||||
self.brightness: Brightness = Brightness.low # sets
|
self.brightness: Brightness = Brightness.low # sets
|
||||||
self.playerNumber: PlayerID = PlayerID.player1
|
self.playerNumber: PlayerID = PlayerID.player1
|
||||||
self.ledOption : LedOptions = LedOptions.Both
|
self.ledOption : LedOptions = LedOptions.Both
|
||||||
self.pulseOptions : PulseOptions = PulseOptions.Off
|
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):
|
def setBrightness(self, brightness: Brightness):
|
||||||
self._brightness = brightness
|
"""
|
||||||
|
Defines the brightness of the Player LEDs
|
||||||
|
|
||||||
def setPlayerNumer(self, player):
|
Args:
|
||||||
if player > 5:
|
brightness (Brightness): brightness of LEDS
|
||||||
raise Exception('only 5 players supported. choose 1-5')
|
|
||||||
|
|
||||||
|
Raises:
|
||||||
|
TypeError: brightness false type
|
||||||
|
"""
|
||||||
|
if not isinstance(brightness, Brightness):
|
||||||
|
raise TypeError('Need Brightness type')
|
||||||
|
self.brightness = brightness
|
||||||
|
|
||||||
|
def setPlayerID(self, player : PlayerID):
|
||||||
|
"""
|
||||||
|
Sets the PlayerID of the controller with the choosen LEDs.
|
||||||
|
The controller has 4 Player states
|
||||||
|
|
||||||
|
Args:
|
||||||
|
player (PlayerID): chosen PlayerID for the Controller
|
||||||
|
|
||||||
|
Raises:
|
||||||
|
TypeError: [description]
|
||||||
|
"""
|
||||||
|
if not isinstance(player, PlayerID):
|
||||||
|
raise TypeError('Need PlayerID type')
|
||||||
|
self.playerNumber = player
|
||||||
|
|
||||||
|
def setColorI(self, r: int , g: int, b: int) -> None:
|
||||||
|
"""
|
||||||
|
Sets the Color around the Touchpad of the controller
|
||||||
|
|
||||||
|
Args:
|
||||||
|
r (int): red channel
|
||||||
|
g (int): green channel
|
||||||
|
b (int): blue channel
|
||||||
|
|
||||||
|
Raises:
|
||||||
|
TypeError: color channels have wrong type
|
||||||
|
Exception: color channels are out of bounds
|
||||||
|
"""
|
||||||
|
if not isinstance(r, int) or not isinstance(g, int) or not isinstance(b, int):
|
||||||
|
raise TypeError('Color parameter need to be int')
|
||||||
|
# check if color is out of bounds
|
||||||
|
if (r > 255 or g > 255 or b > 255) or (r < 0 or g < 0 or b < 0):
|
||||||
|
raise Exception('colors have values from 0 to 255 only')
|
||||||
|
self.TouchpadColor = (r,g,b)
|
||||||
|
|
||||||
|
|
||||||
|
def setColorT(self, color: tuple) -> None:
|
||||||
|
"""
|
||||||
|
Sets the Color around the Touchpad as a tuple
|
||||||
|
|
||||||
|
Args:
|
||||||
|
color (tuple): color as tuple
|
||||||
|
|
||||||
|
Raises:
|
||||||
|
TypeError: color has wrong type
|
||||||
|
Exception: color channels are out of bounds
|
||||||
|
"""
|
||||||
|
if not isinstance(color, tuple):
|
||||||
|
raise TypeError('Color type is tuple')
|
||||||
|
# unpack for out of bounds check
|
||||||
|
r,g,b = map(int, color)
|
||||||
|
# check if color is out of bounds
|
||||||
|
if (r > 255 or g > 255 or b > 255) or (r < 0 or g < 0 or b < 0):
|
||||||
|
raise Exception('colors have values from 0 to 255 only')
|
||||||
|
self.TouchpadColor = (r,g,b)
|
||||||
|
|
||||||
|
|
||||||
class DSAudio:
|
class DSAudio:
|
||||||
@@ -409,6 +479,30 @@ class DSAudio:
|
|||||||
self.microphone_mute = 0
|
self.microphone_mute = 0
|
||||||
self.microphone_led = 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 setMicrophoneMute(self, state):
|
||||||
|
|
||||||
|
if not isinstance(state, bool):
|
||||||
|
raise TypeError('state needs to be bool')
|
||||||
|
|
||||||
|
self.setMicrophoneLED(state) # set led accordingly
|
||||||
|
self.microphone_state = state
|
||||||
|
|
||||||
|
|
||||||
class DSTrigger:
|
class DSTrigger:
|
||||||
def __init__(self) -> None:
|
def __init__(self) -> None:
|
||||||
# trigger modes
|
# trigger modes
|
||||||
@@ -417,36 +511,37 @@ class DSTrigger:
|
|||||||
# force parameters for the triggers
|
# force parameters for the triggers
|
||||||
self.forces = [0 for i in range(7)]
|
self.forces = [0 for i in range(7)]
|
||||||
|
|
||||||
def setForce(self, id:int = 0, force:int = 0):
|
def setForce(self, forceID: int = 0, force: int = 0):
|
||||||
"""set the force of the trigger
|
|
||||||
|
|
||||||
:param id: id of the trigger parameters. 6 possible, defaults to 0
|
|
||||||
:type id: int, optional
|
|
||||||
:param force: force 0 to 255, defaults to 0
|
|
||||||
:type force: int, optional
|
|
||||||
:raises Exception: false trigger parameter accessed. only available trigger parameters from 0 to 6
|
|
||||||
"""
|
"""
|
||||||
if id > 6 or id < 0:
|
Sets the forces of the choosen force parameter
|
||||||
raise Exception('only trigger parameters 0 to 6 available')
|
|
||||||
self.forces[id] = force
|
Args:
|
||||||
|
forceID (int, optional): force parameter. Defaults to 0.
|
||||||
|
force (int, optional): applied force to the parameter. Defaults to 0.
|
||||||
|
|
||||||
|
Raises:
|
||||||
|
TypeError: wrong type of forceID or force
|
||||||
|
Exception: choosen a false force parameter
|
||||||
|
"""
|
||||||
|
if not isinstance(forceID, int) or not isinstance(force, int):
|
||||||
|
raise TypeError('forceID and force needs to be type int')
|
||||||
|
|
||||||
|
if forceID > 6 or forceID < 0:
|
||||||
|
raise Exception('only 7 parameters available')
|
||||||
|
|
||||||
|
self.forces[forceID] = force
|
||||||
|
|
||||||
def setMode(self, mode: TriggerModes):
|
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
|
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
|
|
||||||
|
1
requirements.txt
Normal file
1
requirements.txt
Normal file
@@ -0,0 +1 @@
|
|||||||
|
hid==1.0.4
|
4
setup.py
4
setup.py
@@ -6,7 +6,7 @@ with open("README.md", "r") as fh:
|
|||||||
|
|
||||||
setup(
|
setup(
|
||||||
name='pydualsense',
|
name='pydualsense',
|
||||||
version='0.2.0',
|
version='0.5.2',
|
||||||
description='use your DualSense (PS5) controller with python',
|
description='use your DualSense (PS5) controller with python',
|
||||||
long_description=long_description,
|
long_description=long_description,
|
||||||
long_description_content_type="text/markdown",
|
long_description_content_type="text/markdown",
|
||||||
@@ -14,5 +14,5 @@ setup(
|
|||||||
author='Florian K',
|
author='Florian K',
|
||||||
license='MIT License',
|
license='MIT License',
|
||||||
packages=setuptools.find_packages(),
|
packages=setuptools.find_packages(),
|
||||||
install_requires=['hid>=1.0.4']
|
install_requires=['hidapi-usb', 'cffi']
|
||||||
)
|
)
|
||||||
|
Reference in New Issue
Block a user