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 Usage section for more information on how to install.

Note

This project is under active development.

Contents

• Usage
  • Installation
  • Windows
  • Linux based
  • Examples
• API
  • pydualsense enums classes
  • pydualsense main class
    • Features
    • Initialization
    • Core Properties
    • State Properties
    • Event System
      • Button Events
      • D-pad Events
      • Trigger Events
      • Motion Events
      • Joystick Events
      • Other Events
    • Examples
      • Basic Usage
      • Event Handling
    • Error Handling
    • API Reference
  • pydualsense event system classes
• Examples
• pydualsense
  • pydualsense package
    • Submodules
    • pydualsense.enums module
      • ConnectionType
        • ConnectionType.BT
        • ConnectionType.USB
        • ConnectionType.ERROR
      • LedOptions
        • LedOptions.Off
        • LedOptions.PlayerLedBrightness
        • LedOptions.UninterrumpableLed
        • LedOptions.Both
      • PulseOptions
        • PulseOptions.Off
        • PulseOptions.FadeBlue
        • PulseOptions.FadeOut
      • Brightness
        • Brightness.high
        • Brightness.medium
        • Brightness.low
      • PlayerID
        • PlayerID.PLAYER_1
        • PlayerID.PLAYER_2
        • PlayerID.PLAYER_3
        • PlayerID.PLAYER_4
        • PlayerID.ALL
      • TriggerModes
        • TriggerModes.Off
        • TriggerModes.Rigid
        • TriggerModes.Pulse
        • TriggerModes.Rigid_A
        • TriggerModes.Rigid_B
        • TriggerModes.Rigid_AB
        • TriggerModes.Pulse_A
        • TriggerModes.Pulse_B
        • TriggerModes.Pulse_AB
        • TriggerModes.Calibration
      • BatteryState
        • BatteryState.POWER_SUPPLY_STATUS_DISCHARGING
        • BatteryState.POWER_SUPPLY_STATUS_CHARGING
        • BatteryState.POWER_SUPPLY_STATUS_FULL
        • BatteryState.POWER_SUPPLY_STATUS_NOT_CHARGING
        • BatteryState.POWER_SUPPLY_STATUS_ERROR
        • BatteryState.POWER_SUPPLY_TEMP_OR_VOLTAGE_OUT_OF_RANGE
        • BatteryState.POWER_SUPPLY_STATUS_UNKNOWN
    • pydualsense.event_system module
      • Event
        • Event.__init__()
        • Event.subscribe()
        • Event.unsubscribe()
    • pydualsense.hidguardian module
    • pydualsense.pydualsense module
    • Module contents

TODOs