pbio/sys/hmi_ev3: Add closing credits.

Author: laurensvalk

bricks/_common/common.mk

@@ -163,6 +163,7 @@ PYDFU = $(TOP)/tools/pydfu.py
 PYBRICKSDEV = pybricksdev
 METADATA = $(PBTOP)/tools/metadata.py
 MEDIA_CONVERT = $(PBTOP)/lib/pbio/src/image/media.py
+CREDITS_CONVERT = $(PBTOP)/bricks/ev3/make_credits.py
 OPENOCD ?= openocd
 OPENOCD_CONFIG ?= openocd_stm32$(PB_MCU_SERIES_LCASE).cfg
 TEXT0_ADDR ?= 0x08000000
@@ -553,6 +554,7 @@ endif
 ifeq ($(PB_MEDIA),1)
 PYBRICKS_PYBRICKS_SRC_C += $(BUILD)/pb_type_image_attributes.c
 PBIO_SRC_C += $(BUILD)/pbio_image_media.c
+PBIO_SRC_C += $(BUILD)/hmi_ev3_ui_credits.c
 endif
 
 OBJ = $(PY_O)
@@ -671,9 +673,13 @@ FW_SECTIONS :=
 endif
 
 $(BUILD)/pbio_image_media.c $(BUILD)/pb_type_image_attributes.c: $(MEDIA_CONVERT)
-	$(ECHO) "MEDIA generating image media files"
+	$(ECHO) "Generating image media files"
 	$(Q)$(PYTHON) $(MEDIA_CONVERT) $(BUILD)
 
+$(BUILD)/hmi_ev3_ui_credits.c: $(CREDITS_CONVERT)
+	$(ECHO) "Generating EV3 credits file"
+	$(Q)$(PYTHON) $(CREDITS_CONVERT) $(BUILD)
+
 $(BUILD)/firmware.elf $(BUILD)/pybricks-virtualhub: $(LD_FILES) $(OBJ)
 	$(ECHO) "LINK $@"
 	$(Q)$(CC) $(CFLAGS) $(LDFLAGS) -o $@ $(OBJ) $(LIBS)

bricks/ev3/credits.txt

@@ -0,0 +1,10 @@
+Somename Willbeshown
+Itsa Supporter
+Will Beincluded
+Builton Ci Itshall
+Morena Msonfirstpage
+Another Namethisis
+Laston Thislist
+Firston Nextpage
+Andthelist Goeson
+Longname Middlename Istoolong

bricks/ev3/make_credits.py

@@ -0,0 +1,35 @@
+#!/usr/bin/env python3
+import argparse
+from pathlib import Path
+
+parser = argparse.ArgumentParser(description="Generate EV3 credits.")
+parser.add_argument("dest", help="Destination build folder.")
+args = parser.parse_args()
+
+build_dir = Path(args.dest)
+build_dir.mkdir(parents=True, exist_ok=True)
+
+source_dir = Path(__file__).parent
+source_path = (
+    source_dir / "ci_credits.txt"
+    if (source_dir / "ci_credits.txt").exists()
+    else source_dir / "credits.txt"
+)
+names = open(source_path, "r").read().splitlines()
+
+# Write the result as a list of C strings.
+destination = open(build_dir / "hmi_ev3_ui_credits.c", "w")
+destination.write("""// SPDX-License-Identifier: MIT
+//Copyright (c) 2026 The Pybricks Authors
+
+#include <stddef.h>
+
+const char * const hmi_ev3_ui_credits_names[] = {
+""")
+
+for name in names:
+    destination.write(f'    "{name}",\n')
+
+destination.write(
+    "};\n\nconst size_t hmi_ev3_ui_credits_size = sizeof(hmi_ev3_ui_credits_names) / sizeof(hmi_ev3_ui_credits_names[0]);"
+)

lib/pbio/src/image/media.py

@@ -5,7 +5,7 @@
 import cairosvg
 
 # Take build directory as argument to save generated C files and PNG files.
-parser = argparse.ArgumentParser(description="Convert SVG files to PNG.")
+parser = argparse.ArgumentParser(description="Convert image files to C structs.")
 parser.add_argument("dest", help="Destination build folder for PNG files.")
 args = parser.parse_args()
 

lib/pbio/src/image/media/ui/pybricks_join.png

@@ -16,6 +16,7 @@
 #include <pbdrv/display.h>
 #include <pbdrv/usb.h>
 
+#include <pbio/busy_count.h>
 #include <pbio/button.h>
 #include <pbio/os.h>
 #include <pbsys/host.h>
@@ -69,9 +70,10 @@ void pbsys_hmi_deinit(void) {
     pbdrv_usb_set_host_connection_changed_callback(NULL);
     pbsys_status_clear(PBIO_PYBRICKS_STATUS_USB_HOST_CONNECTED);
 
-    pbio_image_t *display = pbdrv_display_get_image();
-    pbio_image_fill(display, 0);
-    pbdrv_display_update();
+    // Start shutdown animation and wait for completion.
+    static pbio_os_process_t shutdown_animation_process;
+    pbio_busy_count_up();
+    pbio_os_process_start(&shutdown_animation_process, pbsys_hmi_ev3_ui_closing_credits, NULL);
 }
 
 static pbio_error_t run_ui(pbio_os_state_t *state, pbio_os_timer_t *timer) {

lib/pbio/sys/hmi_ev3.c

@@ -11,14 +11,16 @@
 #include <pbsys/main.h>
 #include <pbsys/status.h>
 
+#include <pbdrv/clock.h>
 #include <pbdrv/display.h>
 
-#include <pbio/light_animation.h>
 #include <pbio/battery.h>
+#include <pbio/busy_count.h>
 #include <pbio/button.h>
 #include <pbio/image.h>
-#include <pbio/version.h>
 #include <pbio/int_math.h>
+#include <pbio/light_animation.h>
+#include <pbio/version.h>
 
 #include "hmi_ev3_ui.h"
 #include "pbio_image_media.h"
@@ -315,7 +317,7 @@ static void pbsys_hmi_ev3_ui_draw_centered_text(const pbio_font_t *font, const c
     pbio_image_rect_t rect;
     pbio_image_bbox_text(font, text, strlen(text), &rect);
     int x = (display->width - rect.width) / 2 + x_offset;
-    pbio_image_draw_text(display, &pbio_font_terminus_normal_16, x, y, text, strlen(text), BLACK);
+    pbio_image_draw_text(display, font, x, y, text, strlen(text), BLACK);
 }
 
 /**
@@ -488,26 +490,22 @@ static void pbsys_hmi_ev3_ui_draw_pybricks_logo(uint32_t x, uint32_t y, uint32_t
 
     pbio_image_t *display = pbdrv_display_get_image();
 
-    uint8_t v = pbdrv_display_get_max_value();
-
     // Rounded rectangles making up the left and right side of the head.
-    pbio_image_fill_rounded_rect(display, sx(0), sy(0), sr(42), sr(84), sr(11), v);
-    pbio_image_fill_rounded_rect(display, sx(112), sy(0), sr(42), sr(84), sr(11), v);
+    pbio_image_fill_rounded_rect(display, sx(0), sy(0), sr(42), sr(84), sr(11), BLACK);
+    pbio_image_fill_rounded_rect(display, sx(112), sy(0), sr(42), sr(84), sr(11), BLACK);
 
     // Forehead, main fill, and jaw.
-    pbio_image_fill_rect(display, sx(14), sy(0), sr(126), sr(14), v);
+    pbio_image_fill_rect(display, sx(14), sy(0), sr(126), sr(14), BLACK);
     pbio_image_fill_rect(display, sx(14), sy(14), sr(126), sr(56), 0);
-    pbio_image_fill_rect(display, sx(28), sy(56), sr(98), sr(14), v);
+    pbio_image_fill_rect(display, sx(28), sy(56), sr(98), sr(14), BLACK);
 
     // Eyes.
-    if (!blink) {
-        pbio_image_fill_circle(display, sx(49), sy(29), sr(10), v);
-        pbio_image_fill_circle(display, sx(106), sy(29), sr(10), v);
-    }
+    pbio_image_fill_circle(display, sx(49), sy(29), sr(10), blink ? WHITE : BLACK);
+    pbio_image_fill_circle(display, sx(106), sy(29), sr(10), blink ? WHITE : BLACK);
 
     // Teeth.
     for (uint32_t i = 0; i < 6; i++) {
-        pbio_image_fill_rect(display, sx(40 + 14 * i), sy(51), sr(4), sr(5), v);
+        pbio_image_fill_rect(display, sx(40 + 14 * i), sy(51), sr(4), sr(5), BLACK);
     }
 }
 
@@ -553,6 +551,106 @@ static uint32_t pbsys_hmi_ev3_ui_run_animation_next(pbio_light_animation_t *anim
     return ANIMATION_REFRESH_MS;
 }
 
+// List of supporters created during build process.
+extern const char *const hmi_ev3_ui_credits_names[];
+extern const size_t hmi_ev3_ui_credits_size;
+
+#define NUM_NAMES_PER_PAGE (7)
+
+static const char *pbsys_hmi_ev3_ui_closing_credits_get_name(size_t page, size_t entry) {
+
+    // Choose first name randomly, keeping order.
+    static size_t random = SIZE_MAX;
+    if (random == SIZE_MAX) {
+        random = pbdrv_clock_get_ms() % hmi_ev3_ui_credits_size;
+    }
+
+    size_t offset = page * NUM_NAMES_PER_PAGE + entry;
+    if (offset >= hmi_ev3_ui_credits_size) {
+        // Last page may contain some empty entries.
+        return NULL;
+    }
+
+    return hmi_ev3_ui_credits_names[(random + offset) % hmi_ev3_ui_credits_size];
+}
+
+pbio_error_t pbsys_hmi_ev3_ui_closing_credits(pbio_os_state_t *state, void *context) {
+
+    pbio_image_t *display = pbdrv_display_get_image();
+
+    static pbio_os_timer_t timer;
+    static size_t page;
+
+    // Pressing cancel exits closing credits.
+    if (pbdrv_button_get_pressed() & PBIO_BUTTON_LEFT_UP) {
+        goto close;
+    }
+
+    PBIO_OS_ASYNC_BEGIN(state);
+
+    // Display all supporter names across several pages.
+    for (page = 0; page < (hmi_ev3_ui_credits_size + NUM_NAMES_PER_PAGE - 1) / NUM_NAMES_PER_PAGE; page++) {
+
+        pbio_image_fill(display, WHITE);
+
+        // Populate page with list of names to fit.
+        for (size_t entry = 0; entry < NUM_NAMES_PER_PAGE; entry++) {
+            const char *name = pbsys_hmi_ev3_ui_closing_credits_get_name(page, entry);
+            if (!name) {
+                continue;
+            }
+            int name_y = 28 + entry * display->print_font->line_height;
+            pbio_image_draw_text(display, &pbio_font_terminus_normal_16, 10, name_y, name, strlen(name), BLACK);
+        }
+
+        // Header with line.
+        const char *thanks = "Thanks to our supporters!";
+        pbio_image_draw_text(display, &pbio_font_mono_8x5_8, 10, 12, thanks, strlen(thanks), BLACK);
+        pbio_image_draw_hline(display, 0, 14, 178, 3);
+
+        // Show the page.
+        pbdrv_display_update();
+        PBIO_OS_AWAIT_MS(state, &timer, 1000);
+    }
+
+    // Display creator info.
+    pbio_image_fill(display, WHITE);
+    const char *thanks = "Made by:";
+    pbio_image_draw_hline(display, 0, 14, 178, 3);
+    pbio_image_draw_text(display, &pbio_font_mono_8x5_8, 10, 12, thanks, strlen(thanks), BLACK);
+    pbsys_hmi_ev3_ui_draw_centered_text(&pbio_font_terminus_normal_16, "Laurens Valk", 0, 40);
+    pbsys_hmi_ev3_ui_draw_centered_text(&pbio_font_terminus_normal_16, "David Lechner", 0, 70);
+    pbsys_hmi_ev3_ui_draw_centered_text(&pbio_font_terminus_normal_16, "Pybricks Community", 0, 100);
+    pbdrv_display_update();
+    PBIO_OS_AWAIT_MS(state, &timer, 1500);
+
+    // Display animated Pybricks thanks message.
+    pbio_image_fill(display, WHITE);
+    pbio_image_draw_image_transparent_from_monochrome(display, &pbio_image_media_pybricks_join, 31, 6, BLACK);
+    pbdrv_display_update();
+    PBIO_OS_AWAIT_MS(state, &timer, 1500);
+    pbio_image_fill(display, WHITE);
+    pbsys_hmi_ev3_ui_draw_pybricks_logo(12, 12, 154, false);
+    pbsys_hmi_ev3_ui_draw_centered_text(&pbio_font_terminus_normal_16, "Thanks for your help!", 0, 114);
+    pbdrv_display_update();
+    PBIO_OS_AWAIT_MS(state, &timer, 500);
+    pbsys_hmi_ev3_ui_draw_pybricks_logo(12, 12, 154, true);
+    pbdrv_display_update();
+    PBIO_OS_AWAIT_MS(state, &timer, 400);
+    pbsys_hmi_ev3_ui_draw_pybricks_logo(12, 12, 154, false);
+    pbdrv_display_update();
+    PBIO_OS_AWAIT_MS(state, &timer, 600);
+
+close:
+
+    // Prepare for shutdown and release lock.
+    pbio_image_fill(display, WHITE);
+    pbdrv_display_update();
+    pbio_busy_count_down();
+
+    PBIO_OS_ASYNC_END(PBIO_SUCCESS);
+}
+
 /**
  * User animation state.
  */

lib/pbio/sys/hmi_ev3_ui.c

@@ -5,6 +5,7 @@
 #define _PBSYS_SYS_HMI_EV3_UI_H_
 
 #include <pbio/button.h>
+#include <pbio/os.h>
 
 typedef enum {
     /**
@@ -35,4 +36,6 @@ void pbsys_hmi_ev3_ui_draw(void);
 
 void pbsys_hmi_ev3_ui_run_animation_start(void);
 
+pbio_error_t pbsys_hmi_ev3_ui_closing_credits(pbio_os_state_t *state, void *context);
+
 #endif // _PBSYS_SYS_HMI_EV3_UI_H_

lib/pbio/sys/hmi_ev3_ui.h

@@ -11,6 +11,7 @@
 
 #include <pbdrv/display.h>
 
+#include <pbio/busy_count.h>
 #include <pbio/button.h>
 #include <pbio/image.h>
 #include <pbio/os.h>
@@ -140,9 +141,9 @@ void pbsys_hmi_init(void) {
 }
 
 void pbsys_hmi_deinit(void) {
-    pbio_image_t *display = pbdrv_display_get_image();
-    pbio_image_fill(display, 0);
-    pbdrv_display_update();
+    static pbio_os_process_t shutdown_animation_process;
+    pbio_busy_count_up();
+    pbio_os_process_start(&shutdown_animation_process, pbsys_hmi_ev3_ui_closing_credits, NULL);
 }
 
 static pbio_error_t run_ui(pbio_os_state_t *state, pbio_os_timer_t *timer) {