[wpilib] Document only first party controllers are guaranteed to have correct mapping (#6112)

This commit is contained in:
Thad House
2023-12-30 07:16:59 -08:00
committed by GitHub
parent 636ef58d94
commit af46034b7f
6 changed files with 26 additions and 2 deletions

View File

@@ -15,6 +15,10 @@ import edu.wpi.first.wpilibj.event.EventLoop;
* <p>This class handles PS4 input that comes from the Driver Station. Each time a value is
* requested the most recent value is returned. There is a single class instance for each controller
* and the mapping of ports to hardware buttons depends on the code in the Driver Station.
*
* <p>Only first party controllers from Sony are guaranteed to have the correct mapping, and only
* through the official NI DS. Sim is not guaranteed to have the same mapping, as well as any 3rd
* party controllers.
*/
public class PS4Controller extends GenericHID {
/**

View File

@@ -13,6 +13,10 @@ import edu.wpi.first.wpilibj.event.EventLoop;
* <p>This class handles PS5 input that comes from the Driver Station. Each time a value is
* requested the most recent value is returned. There is a single class instance for each controller
* and the mapping of ports to hardware buttons depends on the code in the Driver Station.
*
* <p>Only first party controllers from Sony are guaranteed to have the correct mapping, and only
* through the official NI DS. Sim is not guaranteed to have the same mapping, as well as any 3rd
* party controllers.
*/
public class PS5Controller extends GenericHID {
/**

View File

@@ -15,6 +15,10 @@ import edu.wpi.first.wpilibj.event.EventLoop;
* <p>This class handles Xbox input that comes from the Driver Station. Each time a value is
* requested the most recent value is returned. There is a single class instance for each controller
* and the mapping of ports to hardware buttons depends on the code in the Driver Station.
*
* <p>Only first party controllers from Microsoft are guaranteed to have the correct mapping, and
* only through the official NI DS. Sim is not guaranteed to have the same mapping, as well as any
* 3rd party controllers.
*/
public class XboxController extends GenericHID {
/** Represents a digital button on an XboxController. */