mirror of
https://github.com/wpilibsuite/allwpilib
synced 2026-06-25 01:41:43 +00:00
[wpilib] Document only first party controllers are guaranteed to have correct mapping (#6112)
This commit is contained in:
@@ -11,10 +11,14 @@ namespace frc {
|
||||
/**
|
||||
* Handle input from PS4 controllers connected to the Driver Station.
|
||||
*
|
||||
* <p>This class handles PS4 input that comes from the Driver Station. Each time
|
||||
* 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.
|
||||
*
|
||||
* 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.
|
||||
*/
|
||||
class PS4Controller : public GenericHID {
|
||||
public:
|
||||
|
||||
@@ -11,10 +11,14 @@ namespace frc {
|
||||
/**
|
||||
* Handle input from PS5 controllers connected to the Driver Station.
|
||||
*
|
||||
* <p>This class handles PS5 input that comes from the Driver Station. Each time
|
||||
* 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.
|
||||
*
|
||||
* 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.
|
||||
*/
|
||||
class PS5Controller : public GenericHID {
|
||||
public:
|
||||
|
||||
@@ -16,6 +16,10 @@ namespace frc {
|
||||
* 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.
|
||||
*
|
||||
* 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.
|
||||
*/
|
||||
class XboxController : public GenericHID {
|
||||
public:
|
||||
|
||||
@@ -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 {
|
||||
/**
|
||||
|
||||
@@ -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 {
|
||||
/**
|
||||
|
||||
@@ -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. */
|
||||
|
||||
Reference in New Issue
Block a user