wpilibsuite/allwpilib

Document what the rumble types mean

Closed

#7,094 opened on Sep 19, 2024

View on GitHubContributor guide
 (3 comments) (0 reactions) (0 assignees)C++ (714 forks)auto 404
component: wpilibccomponent: wpilibjgood first issuetype: docs

Repository metrics

Stars
 (1,281 stars)
PR merge metrics
 (PR metrics pending)

Description

On Xbox controllers, left is the low frequency motor and right is the high frequency motor. Not sure if PS4 is the same. It'd be good to test.

https://learn.microsoft.com/en-us/gaming/gdk/_content/gc/reference/input/xinputongameinput/structs/xinput_vibration

Contributor guide

Research direction
Test rumble behavior on Xbox and PS4 controllers to confirm low frequency is left motor, high frequency is right motor. Document the mapping and reference the Microsoft documentation.
Tech stack
cpp
Domain
documentation
Issue type
Documentation
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
Git
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
75