API.md

BricktronicsButton API

This library interfaces with LEGO NXT and EV3 pushbutton sensors. It can be used with the Bricktronics Shield, Bricktronics Megashield, or standalone with the Bricktronics Breakout Board. For the shield/megashield, use the constructor below with the BricktronicsSensorSettings struct, otherwise use the constructor below that accepts the input pin number.

Connection with Bricktronics Shield

Use the pushbutton sensor with any sensor port on the Bricktronics Shield. If the chosen sensor port has jumpers, connect pins 2-3 and 4-5.

Constructor usage for Bricktronics Shield

#include <BricktronicsShield.h>
#include <BricktronicsButton.h>
BricktronicsButton b(BricktronicsShield::SENSOR_1);

Connection with Bricktronics Megashield

Use the pushbutton sensor with any sensor port on the Bricktronics Megashield. Use the jumpers to connect pins 2-3 and 4-5.

Constructor usage for Bricktronics Megashield

#include <BricktronicsMegashield.h>
#include <BricktronicsButton.h>
BricktronicsButton b(BricktronicsMegashield::SENSOR_1);

Connection with Bricktronics Breakout Board

• Pin 1 - Connect to any digital input pin (this is the constructor argument below)
• Pin 2 - Connect to Ground
• Pin 3 - Connect to Ground
• Pin 4 - Connect to 5V
• Pin 5 - No connection
• Pin 6 - No connection

Constructor usage for Bricktronics Breakout Board:

#include <BricktronicsButton.h>
BricktronicsButton b(7); // Arduino pin 7 is connected to breakout board pin 1.

Quick Example

#include <BricktronicsButton.h>

// Use one of the constructor options listed above.
BricktronicsButton b(7);

void setup()
{
    Serial.begin(115200);
    // If using a Bricktronics Shield, you need to call
    // BricktronicsShield::begin();
    b.begin();
}

void loop()
{
    while(b.isReleased());
    Serial.println("pressed");
    delay(100);
            
    while(b.isPressed());
    Serial.println("released");
    delay(100);
}

Constructors and begin()

BricktronicsButton(uint8_t inputPin)

Constructor - Simple constructor that accepts an input pin

Parameters

• uint8_t inputPin - The Arduino pin number where the button's pin 1 is connected.

BricktronicsButton(const BricktronicsSensorSettings &settings)

Constructor - Advanced constructor that accepts a SensorSettings struct to also override the low-level Arduino functions.

Parameters

• const BricktronicsSensorSettings &settings - A const reference to the struct containing all the sensor settings. Get these structs from the BricktronicsShield or BricktronicsMegashield library.

void begin(void)

Set up the sensor library internals and pin modes. Call this function once for each instance during your setup() function.

Button status functions

bool isPressed(void)

Query the button to see if it is current pressed. Returns true if the button is pressed, false if released.

bool isReleased(void)

Query the button to see if it is current released. Returns true if the button is released, false if pressed.