2. Fruitful Functions and the Micro:bit

Quick Overview of Day

WDTPD on variable scope. Functions practice quiz. Micro:bit fruitful functions.

2.1. What Does This Program Do?

Remember that variables created inside of a function have local scope (can only be used inside that function), whereas variables created outside of a function have global scope (can be accessed from anywhere).

Note

Your teacher may choose to use the following examples as a class activity, by displaying the examples, and having you take a guess as to what you think each will do before running the code.

What will the following programs output? Why?

2.2. Functions Practice Quiz

To confirm that you understand the ideas behind using functions, you should try the Functions Practice Quiz using only your brain (in other words, try to figure out what will happen without running the code).

2.3. An Accelerometer Fruitful Function

Let’s adapt the code above to use a fruitful function. We will make a function called horizontal_tilt() that returns either “left”, “right”, or “flat”.

import microbit

def horizontal_tilt(sensitivity_amount):
    """Returns left, right or flat, depending on which way the micro:bit is tilted. Small sensitivity_amount is more sensitive, large sensitivity_amount is less sensitive."""
    x_tilt = microbit.accelerometer.get_x()

    if x_tilt > sensitivity_amount:
        return "right"

    elif x_tilt < -1 * sensitivity_amount:
        return "left"

    else:
        return "flat"


while True:
    horizontal_tilt_direction = horizontal_tilt(100)

    if horizontal_tilt_direction == "right":
        microbit.display.show("R")
        print("Tilted right.")

    elif horizontal_tilt_direction == "left":
        microbit.display.show("L")
        print("Tilted left.")

    else:
        microbit.display.show("-")
        print("Flat!")

Notice that in the horizontal_tilt function, an if/elif/else structure is used. Since one (and only one) branch of the if/elif/else must occur, we are guaranteed to return either “right”, “left”, or “flat”. The parameter sensitivity_amount in the function definition allows the user of the function to easily set how sensitive their program is to the tilting of the micro:bit.

Inside the while True loop, we start by calling the horizontal_tilt function, so we will call the function many times per second.

2.4. Adapt the Code

Try the following (either by yourself or with a partner):

  • create a fruitful function vertical_tilt(sensitivity_amount) that uses get_y and returns either “forward”, “backward”, or None

  • create a fruitful function held_up_down(sensitivity_amount) that uses get_z and returns either “up”, “down”, or None

2.5. A More Involved Micro:bit Function Example

One of the great things about using functions is that you can use a function without having to know all of the details about how it works. In the following example, you do not need to worry about how the functions work (though you can definitely try to figure them out, if you want to). The important things you need to understand are all inside the while True loop. We are using two things that you may not have seen before:

  • some_list.append("thing") adds “thing” to the end of a list. We use this to keep track of the actions the user has made in a list called actions.

  • break forces the current looping structure to terminate. We use this to exit out of the while True loop if the user enters in a secret code.

import microbit

actions = []
current_action = ""

def get_konami_action(sensitivity_amount):
    """Returns a single action that has occured on the Micro:bit, either a button a or b, then a tilt
    value of right, left, up or down. The sensitivity_amount affects all the tilt options."""
    x_tilt = microbit.accelerometer.get_x()
    y_tilt = microbit.accelerometer.get_y()

    if microbit.button_a.was_pressed():
        return "a"

    elif microbit.button_b.was_pressed():
        return "b"

    # if tilted more on one axis, use that axis to determine the 'direction' of the tilt
    elif abs(x_tilt) > abs(y_tilt):
        # use x axis
        if x_tilt > sensitivity_amount:
            return "right"

        elif x_tilt < -1 * sensitivity_amount:
            return "left"

    else:
        # use y axis
        if y_tilt > sensitivity_amount:
            return "down"

        elif y_tilt < -1 * sensitivity_amount:
            return "up"

def konami_code(action_list):
    """Look for the pattern up, up, down, down, left, left, right, right, b, a at the end of a list.
    Return True if the pattern is found, False if it is not."""

    if len(action_list) < 10:
        return False
    else:
        return (action_list[-1] == "a" and action_list[-2] == "b" and
                action_list[-3] == "right" and action_list[-4] == "right" and
                action_list[-5] == "left" and action_list[-6] == "left" and
                action_list[-7] == "down" and action_list[-8] == "down" and
                action_list[-9] == "up" and action_list[-10] == "up")



while True:
    # remember what the action was last time through the loop
    last_action = current_action
    current_action = get_konami_action(700)

    # is this a "new" action?
    if current_action != last_action and current_action != None:
        actions.append(current_action)
        print(actions)

    if konami_code(actions):
        break

print("Easter egg time!!!")

Note

If your class doesn’t have access to Micro:bits, you will be working on an assignment that focuses on creating fruitful and non-fruitful functions.

2.6. Micro:bit Game Assignment

Use the examples we’ve done as a starting point, and come up with your own game that uses the Micro:bit and functions! You are welcome to combine the turtle module as well. At a minimum, your game must:

  • use at least one fruitful function (that you have created). You are welcome to use the fruitful functions shown in our demos, but you need to create at least one of your own!

  • use at least one non-fruitful function (that you have created).

Some ideas of things you might want to try creating include:

  • “guess the time” game (in which a number of seconds is displayed on the Micro:bit, and the user needs to try to press a button as close to the correct amount of time as possible)

  • bop-it game (display an A or B, and user needs to press the correct button. User gets more points the faster they can press the correct button. The game ends if the user presses the wrong button, or after a certain number of clicks.)

  • have an “object” (led) fall from the top of the screen. The user needs to catch the object, and can move left/right by using the buttons or accelerometer. If they do not catch the object, the game ends.

  • create a morse code visualizer, in which the user can type in a message, and the Micro:bit will display the message by flashing the LEDs using morse code. Another option would be to have the Micro:bit flash AND play beeps on your headphones (see how to connect your headphones to the Micro:bit)

    • dice rolling simulator, in which a random number is displayed on the Micro:bit, and used in the program you have running in Thonny

  • anything else you can dream up!

Next Section - 3. Micro:bit Custom Images