Skip to content

Commit

Permalink
[wpilib] Document only first party controllers are guaranteed to have…
Browse files Browse the repository at this point in the history
… correct mapping (#6112)
  • Loading branch information
ThadHouse authored Dec 30, 2023
1 parent 636ef58 commit af46034
Show file tree
Hide file tree
Showing 6 changed files with 26 additions and 2 deletions.
6 changes: 5 additions & 1 deletion wpilibc/src/main/native/include/frc/PS4Controller.h
Original file line number Diff line number Diff line change
Expand Up @@ -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:
Expand Down
6 changes: 5 additions & 1 deletion wpilibc/src/main/native/include/frc/PS5Controller.h
Original file line number Diff line number Diff line change
Expand Up @@ -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:
Expand Down
4 changes: 4 additions & 0 deletions wpilibc/src/main/native/include/frc/XboxController.h
Original file line number Diff line number Diff line change
Expand Up @@ -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:
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,10 @@
* <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 {
/**
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,10 @@
* <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 {
/**
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,10 @@
* <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. */
Expand Down

0 comments on commit af46034

Please sign in to comment.