Bumper Switch#

Introduction #

The bumper class is used to detect when the Bumper Switch is pressed and released.

Class Constructor #

bumper( 
  triport::port &port );

Class Destructor #

Destroys the bumper object and releases associated resources.

virtual ~bumper();

Parameters #

Parameter	Type	Description
`port`	`triport::port&`	The 3-Wire Port that the Bumper Switch is connected to, written as `Brain.ThreeWirePort.X` or `ExpanderName.X`, where `X` is the port letter (for example, `Brain.ThreeWirePort.A` or `Expander1.A`).

Example #

// Create a bumper instance in Port A
bumper BumperA = bumper(Brain.ThreeWirePort.A);

Member Functions #

The bumper class includes the following member functions:

pressing — Returns if the Bumper Switch is being pressed.
pressed — Registers a function to be called when the Bumper Switch is pressed.
released — Registers a function to be called when the Bumper Switch is released.

Before calling any bumper member functions, a bumper instance must be created, as shown below:

/* This constructor is required when using VS Code.
Bumper Switch configuration is generated automatically
in VEXcode using the Device Menu. Replace the values
as needed. */

// Create a bumper instance in Port A
bumper BumperA = bumper(Brain.ThreeWirePort.A);

pressing #

Returns if the Bumper Switch is currently being pressed.

Available Functions

int32_t pressing();

Parameters

This function does not accept any parameters.

Return Values

Returns an int32_t indicating whether the Bumper Switch is being pressed.

1 — The Bumper Switch is being pressed.
0 — The Bumper Switch is not being pressed.

pressed #

Registers a function to be called when the Bumper Switch is pressed.

Available Functions

void pressed( void (* callback)(void) );

Parameters

Parameter	Type	Description
`callback`	`void (*)(void)`	A pointer to a function that will be called when the bumper is pressed. The function must take no parameters and return void.

Return Values

This function does not return a value.

Examples

void BumperPressed() {
  Brain.Screen.print("Bumper pressed");
}

// Run BumperPressed when the value of the Bumper Switch is pressed.
  BumperA.pressed(BumperPressed);

released #

Registers a function to be called when the Bumper Switch is released.

Available Functions

void released( void (* callback)(void) );

Parameters

Parameter	Type	Description
`callback`	`void (*)(void)`	A pointer to a function that will be called when the bumper is released. The function must take no parameters and return void.

Return Values

This function does not return a value.

Examples

void BumperReleased() {
  Brain.Screen.print("Bumper released");
}

// Run BumperReleased when the value of the Bumper Switch is released.
  BumperA.released(BumperReleased);