|
1 | | -# DualSense / PS5 Controller on Windows [API] |
2 | | -Windows API for the PS5 DualSense controller. Written in C++ for C++ |
| 1 | +# DualSense on Windows [API] |
| 2 | + |
3 | 3 |
|
4 | | -First Release coming soon! |
5 | 4 |
|
6 | | -#### Road map to first preview release: |
7 | 5 |
|
8 | | -- ~~Reading the input state from the controller using USB~~. DONE! |
9 | | -- ~~Reading input via bluetooth~~. DONE! |
10 | | -- ~~Writing Output state to the controller using USB~~. DONE! |
11 | | -- ~~Controlling and reading the adaptive triggers.~~ DONE! |
12 | | -- ~~Writing Output state via bluetooth.~~ DONE! |
13 | | -- Addition input / output parameters. *Work in progress* |
14 | | -- Calibrating the gyroscope *Work in progress* |
15 | | -- Documenting the API *Work in progress* |
16 | | -- Updating the github repo and publish release |
| 6 | +Windows API for the PS5 DualSense controller. Written in C++ for C++. This API will help you using the DualSense controller in your windows C++ Applications / Projects. |
17 | 7 |
|
18 | | -First preview should be released before 28.11.2020 (The hard work is done - The USB and BT protocol is, at least partially, reverse engineered) |
| 8 | +> :exclamation: Warning: The current release state is still a preview release. The library may not work as intended! |
19 | 9 |
|
20 | | -#### Features of the first preview |
| 10 | +## Features |
21 | 11 |
|
22 | | -- Reading all buttons and analog values (triggers and sticks) which are on the controller |
| 12 | +- Reading all button input from the controller |
| 13 | +- Reading the analog sticks and analog triggers |
23 | 14 | - Reading the two finger touch positions |
24 | | -- Reading the accelerometer |
25 | | -- Reading the gyroscope (Currently only raw / uncalibrated values) |
26 | | -- Reading the connection state of the headphone jack |
27 | | -- Setting the rumble motors speed |
28 | | -- Setting various effects to the force feedback triggers |
29 | | -- Retrieving force feedback triggers feedback |
30 | | -- controlling the RGB-Leds, Microphone Led and User Leds |
| 15 | +- Reading the Accelerometer and Gyroscope |
| 16 | +- Using the haptic feedback for default rumbleing |
| 17 | +- Controlling the adaptive triggers (3 Types of effects) and reading back the users force while active |
| 18 | +- Controlling the RGB color of the lighbar |
| 19 | +- Setting the player indication LEDs and the microphone LED |
31 | 20 |
|
32 | | -Fully working over USB and Bluetooth! |
| 21 | +The library is still in active development and will be extended with additional features soon. Consider checking out our [Road-map](https://github.com/Ohjurot/DualSense-Windows/blob/main/ROADMAP.md) for further information. |
33 | 22 |
|
34 | | -#### Feature planed for the future |
| 23 | +## Using the API |
35 | 24 |
|
36 | | -- Using the haptic feedback |
37 | | -- Internal speaker and mic |
| 25 | +1. Download the `DualSenseWindows_VX.X.zip` file from the latest release found at the [Release Page](https://github.com/Ohjurot/DualSense-Windows/releases) |
| 26 | +2. Unzip the archive to your computer |
| 27 | +3. Read the `DualSenseWindows.pdf` PDF documentation to get the specific information for your current release |
38 | 28 |
|
39 | | -#### Know issues |
| 29 | +If you don't want to mess your time documentation - this is the minimal example on how to use the library: |
| 30 | + |
| 31 | +```c++ |
| 32 | +#include <Windows.h> |
| 33 | +#include <ds5w.h> |
| 34 | +#include <iostream> |
| 35 | + |
| 36 | +int main(int argc, char** argv){ |
| 37 | + // Array of controller infos |
| 38 | + DS5W::DeviceEnumInfo infos[16]; |
| 39 | + |
| 40 | + // Number of controllers found |
| 41 | + unsigned int controllersCount = 0; |
| 42 | + |
| 43 | + // Call enumerate function and switch on return value |
| 44 | + switch(DS5W::enumDevices(infos, 16, &controllersCount)){ |
| 45 | + case DS5W_OK: |
| 46 | + // The buffer was not big enough. Ignore for now |
| 47 | + case DS5W_E_INSUFFICIENT_BUFFER: |
| 48 | + break; |
| 49 | + |
| 50 | + // Any other error will terminate the application |
| 51 | + default: |
| 52 | + // Insert your error handling |
| 53 | + return -1; |
| 54 | + } |
| 55 | + |
| 56 | + // Check number of controllers |
| 57 | + if(!controllersCount){ |
| 58 | + return -1; |
| 59 | + } |
| 60 | + |
| 61 | + // Context for controller |
| 62 | + DS5W::DeviceContext con; |
| 63 | + |
| 64 | + // Init controller and close application is failed |
| 65 | + if(DS5W_FAILED(DS5W::initDeviceContext(&infos[0], &con))){ |
| 66 | + return -1; |
| 67 | + } |
| 68 | + |
| 69 | + // Main loop |
| 70 | + while(true){ |
| 71 | + // Input state |
| 72 | + DS5W::DS5InputState inState; |
| 73 | + |
| 74 | + // Retrieve data |
| 75 | + if (DS5W_SUCCESS(DS5W::getDeviceInputState(&con, &inState))){ |
| 76 | + // Check for the Logo button |
| 77 | + if(inState.buttonsB & DS5W_ISTATE_BTN_B_PLAYSTATION_LOGO){ |
| 78 | + // Break from while loop |
| 79 | + break; |
| 80 | + } |
| 81 | + |
| 82 | + // Create struct and zero it |
| 83 | + DS5W::DS5OutputState outState; |
| 84 | + ZeroMemory(&outState, sizeof(DS5W::DS5OutputState)); |
| 85 | + |
| 86 | + // Set output data |
| 87 | + outState.leftRumble = inState.leftTrigger; |
| 88 | + outState.rightRumble = inState.rightTrigger; |
| 89 | + |
| 90 | + // Send output to the controller |
| 91 | + DS5W::setDeviceOutputState(&con, &outState); |
| 92 | + } |
| 93 | + } |
| 94 | + |
| 95 | + // Shutdown context |
| 96 | + DS5W::freeDeviceContext(&con); |
| 97 | + |
| 98 | + // Return zero |
| 99 | + return 0; |
| 100 | +} |
| 101 | +``` |
| 102 | +
|
| 103 | +## Known issues |
40 | 104 |
|
41 | 105 | - When the controller being shut down while connected via Bluetooth (Holding the PS button). The lib will encounter a dead lock within `getDeviceInputState(...)` call. The function will return as soon as the controller is getting reconnected. Not encountering over USB, over USB the expected `DS5W_E_DEVICE_REMOVED` error is returned. |
42 | 106 |
|
43 | | -#### Sources |
| 107 | +## Special thanks to |
44 | 108 |
|
45 | 109 | I have partially used the following sources to implement the functionality: |
46 | 110 |
|
47 | 111 | - The GitHub community on this project and https://github.com/Ryochan7/DS4Windows/issues/1545 |
| 112 | +- https://www.reddit.com/r/gamedev/comments/jumvi5/dualsense_haptics_leds_and_more_hid_output_report/ |
48 | 113 | - https://gist.github.com/dogtopus/894da226d73afb3bdd195df41b3a26aa |
49 | 114 | - https://gist.github.com/Ryochan7/ef8fabae34c0d8b30e2ab057f3e6e039 |
50 | 115 | - https://gist.github.com/Ryochan7/91a9759deb5dff3096fc5afd50ba19e2 |
51 | | -- https://github.com/Ryochan7/DS4Windows/tree/dualsense-integration (Copyright (c) 2019 Travis Nickles - [MIT License](https://github.com/Ryochan7/DS4Windows/blob/jay/LICENSE.txt)) |
52 | | -- https://www.reddit.com/r/gamedev/comments/jumvi5/dualsense_haptics_leds_and_more_hid_output_report/ |
| 116 | +
|
| 117 | +
|
| 118 | +
|
| 119 | +[Important Informations about Trademarks](https://github.com/Ohjurot/DualSense-Windows/blob/main/TRADEMARKS.md) |
53 | 120 |
|
0 commit comments