#gamepad #controller #hid #messages #wrapper #dual-sense #ps5

dualsense-rs

Rust programmatic wrapper over HID messages sent and received by the PS5 DualSense controller

6 releases (breaking)

0.6.0 Mar 23, 2024
0.5.0 Feb 19, 2024
0.4.0 Feb 4, 2024
0.3.0 Jan 8, 2024
0.1.0 Dec 18, 2023

#507 in Hardware support

MIT license

60KB
1.5K SLoC

DualSense

Rust programmatic wrapper over HID messages sent and received by the PS5 DualSense controller. Allows support for simultaneous key presses or combos that require consecutive presses in a given time interval(wip).

Usage

Read

Add callback functions to detect when properties change.

Log details about the left and right sticks' positions:

use dualsense_rs::DualSense;


fn main() {
    let mut controller = DualSense::new();

    controller.on_left_pad_x_changed(&|lpx| println!("left pad x: {lpx}"));
    controller.on_left_pad_x_changed(&|lpx| {
        if lpx > 127 {
            println!("left pad x in right region: {lpx}")
        }
    });
    controller.on_left_pad_y_changed(&|lpy| println!("left pad y: {lpy}"));
    controller.on_right_pad_x_changed(&|rpx| println!("right pad x: {rpx}"));

    let handle = controller.run();
    // can also add after the `.run()` call
    controller.on_right_pad_y_changed(&|rpy| println!("right pad y: {rpy}"));
    // make sure to join the thread so the program doesn't stop immediately
    handle.join().ok();
}

Write

Output values are stored in an internal cache and will be sent in the following read/write cycle. Packets will not be sent if nothing changed.


use dualsense_rs::DualSense;


fn main() {
    let mut controller = DualSense::new();
    controller.set_left_trigger_effect(TriggerEffect::Mode1);

    let handle = controller.run();
    controller.set_light_red(255);
    handle.join().ok();
}

Examples

Try examples for:

  • log_all -> log values for all buttons, analog sticks and touchpad
  • sensors -> log values for the gyroscope and accelerometer
  • triggers -> log values for the triggers and change their modes
cargo run --example <example>

Roadmap

Currently the following features are of priority:

  • bluetooth support
  • CRC creation and validation
  • charging status
  • improve API:
    • make callbacks return structs with utilitary methods
    • fix borrow issue when trying to update local variable in callback
  • combos:
    • add the possibility to detect when multiple keys are pressed in a time frame

Dependencies

~0.4–10MB
~54K SLoC