Button class with callbacks in Raspberry Pi

Introduction

A Button class with callbacks helps you run specific code when a button is pressed or released. It makes your program respond to button actions easily.

You want to turn on a light when a button is pressed.

You want to play a sound when a button is released.

You want to count how many times a button is pressed.

You want to control a robot using button presses.

You want to make a menu selection using buttons.

Syntax

Raspberry Pi

class Button:
    def __init__(self, pin):
        # Setup button on given pin
        pass

    def on_press(self, callback):
        # Set function to call when button is pressed
        pass

    def on_release(self, callback):
        # Set function to call when button is released
        pass

The __init__ method sets up the button on a specific pin.

The on_press and on_release methods let you assign functions that run when the button is pressed or released.

Examples

This example creates a button on pin 17 and prints messages when pressed or released.

Raspberry Pi

button = Button(pin=17)

button.on_press(lambda: print('Button pressed!'))
button.on_release(lambda: print('Button released!'))

Here, a named function greet is called when the button is pressed.

Raspberry Pi

def greet():
    print('Hello!')

button = Button(pin=4)
button.on_press(greet)

Sample Program

This program creates a Button object and assigns print functions to run when the button is pressed and released. It then simulates pressing and releasing the button.

Raspberry Pi

import time

class Button:
    def __init__(self, pin):
        self.pin = pin
        self._press_callback = None
        self._release_callback = None
        self._pressed = False

    def on_press(self, callback):
        self._press_callback = callback

    def on_release(self, callback):
        self._release_callback = callback

    # Simulate button press
    def press(self):
        if not self._pressed:
            self._pressed = True
            if self._press_callback:
                self._press_callback()

    # Simulate button release
    def release(self):
        if self._pressed:
            self._pressed = False
            if self._release_callback:
                self._release_callback()

# Example usage
button = Button(pin=21)

button.on_press(lambda: print('Button was pressed!'))
button.on_release(lambda: print('Button was released!'))

# Simulate button actions
button.press()
time.sleep(0.5)
button.release()

Important Notes

Callbacks are functions you give to the Button class to run later when events happen.

In real Raspberry Pi projects, you connect the button to a GPIO pin and detect physical presses.

This example simulates button presses for easy testing without hardware.

Summary

A Button class with callbacks lets your program react to button presses and releases.

You assign functions to run on press or release using on_press and on_release.

This makes your code cleaner and easier to manage for button actions.

Practice

1.

What is the main purpose of using a Button class with callbacks in Raspberry Pi programming?

easy

A. To run specific functions automatically when the button is pressed or released

B. To make the button physically larger

C. To change the button's color on the screen

D. To connect the button to the internet

Solution

1. Step 1: Understand what callbacks do

   Callbacks are functions that run automatically when an event happens, like pressing a button.

2. Step 2: Connect callbacks to button actions

   The Button class uses callbacks to run code when the button is pressed or released, making the program respond to these events.

3. Final Answer:

   To run specific functions automatically when the button is pressed or released -> Option A

4. Quick Check:

   Callbacks run functions on events = A [OK]

Hint: Callbacks run code on button press/release events [OK]

Common Mistakes:

• Thinking callbacks change button size or color
• Confusing callbacks with hardware features
• Assuming callbacks connect buttons to the internet

2.

Which of the following is the correct way to assign a function my_function to run when a button is pressed using a Button class?

button = Button(17)
# What goes here?

easy

A. button.on_press(my_function)

B. button.on_press = my_function()

C. button.on_press = my_function

D. button.on_press: my_function

Solution

1. Step 1: Understand function assignment

   Assigning a function as a callback means giving the function name without parentheses, so it can be called later.

2. Step 2: Check syntax for callback assignment

   Using button.on_press = my_function assigns the function correctly. Adding parentheses calls it immediately, which is wrong.

3. Final Answer:

   button.on_press = my_function -> Option C

4. Quick Check:

   Assign function without () for callback = A [OK]

Hint: Assign function name without () for callbacks [OK]

Common Mistakes:

• Adding parentheses calls function immediately
• Using parentheses like a function call in assignment
• Using incorrect syntax like colons or parentheses

3.

What will be the output when the following code runs and the button is pressed once?

class Button:
    def __init__(self):
        self.on_press = None
    def press(self):
        if self.on_press:
            self.on_press()

def greet():
    print('Hello!')

button = Button()
button.on_press = greet
button.press()

medium

A. Hello!

B. None

C. Error: on_press is not callable

D. No output

Solution

1. Step 1: Understand the press method

   The press method checks if on_press is set and calls it if so.

2. Step 2: Trace the code execution

   The greet function prints 'Hello!'. It is assigned to on_press, so pressing the button calls greet and prints 'Hello!'.

3. Final Answer:

   Hello! -> Option A

4. Quick Check:

   Callback runs greet() printing Hello! = C [OK]

Hint: Callbacks run assigned function on press, printing output [OK]

Common Mistakes:

• Forgetting to assign the function before pressing
• Expecting no output if on_press is None
• Confusing function call with function assignment

4.

Find the error in this code snippet that uses a Button class with callbacks:

class Button:
    def __init__(self):
        self.on_press = None
    def press(self):
        self.on_press()

button = Button()
button.press()

medium

A. Button class is missing the on_release callback

B. on_press is called without checking if it is None, causing an error

C. The press method should not call on_press at all

D. The button object is not created correctly

Solution

1. Step 1: Analyze the press method

   The press method calls self.on_press() without checking if on_press is set.

2. Step 2: Identify the error cause

   Since on_press is None by default and never assigned, calling None() causes a TypeError.

3. Final Answer:

   on_press is called without checking if it is None, causing an error -> Option B

4. Quick Check:

   Calling None as function causes error = B [OK]

Hint: Always check callback is set before calling it [OK]

Common Mistakes:

• Ignoring None check before calling callback
• Assuming on_press is set automatically
• Thinking missing on_release causes this error

5.

You want to create a Button class that supports both on_press and on_release callbacks. Which code correctly implements this so pressing and releasing the button calls the right functions?

class Button:
    def __init__(self):
        # What should go here?
    def press(self):
        # What should go here?
    def release(self):
        # What should go here?

button = Button()
button.on_press = lambda: print('Pressed')
button.on_release = lambda: print('Released')

button.press()
button.release()

hard

A. Initialize on_press and on_release as True; check if True before calling

B. Initialize on_press and on_release to empty strings; print them in press and release

C. Do not initialize callbacks; call them directly in press and release methods

D. Initialize on_press and on_release to None; call them if set in press and release methods

Solution

1. Step 1: Initialize callbacks properly

   Set self.on_press and self.on_release to None in __init__ to indicate no function assigned yet.

2. Step 2: Call callbacks safely in methods

   In press and release, check if the callback is not None before calling it to avoid errors.

3. Final Answer:

   Initialize on_press and on_release to None; call them if set in press and release methods -> Option D

4. Quick Check:

   Initialize None and check before call = D [OK]

Hint: Set callbacks to None and check before calling [OK]

Common Mistakes:

• Using wrong default values like empty strings or True
• Calling callbacks without checking if assigned
• Not supporting both press and release callbacks