tests: Add screenshot method for testdisplay

This allows to take a screenshot at any point in test execution, e.g.
see basic_slider.py start and final screenshots.

Author: Carglglz

tests/api/basic.py

@@ -11,7 +11,7 @@
 # RGB colors, layout aligment and events.
 
 
-async def demo(scr, display=None):
+async def buttons(scr, display=None):
     def get_button(scr, text, align, color):
         _btn = lv.button(scr)
         _btn.set_size(lv.pct(25), lv.pct(10))
@@ -41,7 +41,7 @@ def button_cb(event, name):
         )
 
     await asyncio.sleep_ms(500)  # await so the frame can be rendered
-    display._save_frame = False
+    await display.screenshot()
     print("EVENT TEST:")
     for _btn, name in _all_btns:
         _btn.send_event(lv.EVENT.CLICKED, None)
@@ -60,5 +60,5 @@ def button_cb(event, name):
 except Exception:
     display_config = testrunner.display_config
 
-testrunner.run(demo, __file__, disp_config=display_config)
+testrunner.run(buttons, __file__, disp_config=display_config)
 testrunner.devicereset()

tests/api/basic_indev.py

@@ -11,7 +11,7 @@
 # RGB colors, layout aligment and events.
 
 
-async def demo(scr, display=None):
+async def buttons(scr, display=None):
     def get_button(scr, text, align, color):
         _btn = lv.button(scr)
         _btn.set_size(lv.pct(25), lv.pct(10))
@@ -41,8 +41,7 @@ def button_cb(event, name):
         )
 
     await asyncio.sleep_ms(500)  # await so the frame can be rendered
-    display._save_frame = False
-
+    await display.screenshot()
     print("EVENT TEST:")
     for _btn, name in _all_btns:
         _btn.send_event(lv.EVENT.CLICKED, None)
@@ -78,5 +77,5 @@ def button_cb(event, name):
 except Exception:
     display_config = testrunner.display_config
 
-testrunner.run(demo, __file__, disp_config=display_config)
+testrunner.run(buttons, __file__, disp_config=display_config)
 testrunner.devicereset()

tests/api/basic_slider.py

@@ -11,52 +11,52 @@
 # RGB colors, layout aligment and events.
 
 
-async def demo(scr, display=None):
-    def get_button(scr, text, align, color):
+async def sliders(scr, display=None):
+    def get_slider(scr, text, align, color):
         scr.set_style_pad_all(10, 0)
-        _btn = lv.slider(scr)
-        _btn.set_width(lv.pct(75))
-        _btn.set_height(lv.pct(10))
-        _lab = lv.label(_btn)
+        slider = lv.slider(scr)
+        slider.set_width(lv.pct(75))
+        slider.set_height(lv.pct(10))
+        _lab = lv.label(slider)
         _lab.set_text(text)
         _lab.set_style_text_color(lv.color_white(), 0)
         _lab.center()
-        _btn.set_style_align(align, 0)
-        _btn.set_style_bg_color(lv.color_make(*color), lv.PART.INDICATOR)
-        _btn.set_style_bg_color(lv.color_make(*color), lv.PART.MAIN)
-        _btn.set_style_bg_color(lv.color_make(*color), lv.PART.KNOB)
-        return _btn, text
+        slider.set_style_align(align, 0)
+        slider.set_style_bg_color(lv.color_make(*color), lv.PART.INDICATOR)
+        slider.set_style_bg_color(lv.color_make(*color), lv.PART.MAIN)
+        slider.set_style_bg_color(lv.color_make(*color), lv.PART.KNOB)
+        return slider, text
 
-    buttons = [
+    sliders = [
         ("RED", lv.ALIGN.TOP_MID, (255, 0, 0)),
         ("GREEN", lv.ALIGN.BOTTOM_MID, (0, 255, 0)),
         ("BLUE", lv.ALIGN.CENTER, (0, 0, 255)),
     ]
 
-    def button_cb(event, name, slider):
+    def slider_cb(event, name, slider):
         if slider.get_value() == 100:
             print(f"{name} VALUE: {slider.get_value()}")
 
-    _all_btns = [get_button(scr, *btn) for btn in buttons]
+    _all_objs = [get_slider(scr, *slider) for slider in sliders]
 
-    for btn, name in _all_btns:
-        btn.add_event_cb(
-            lambda event, button_name=name, slider=btn: button_cb(
+    for sld, name in _all_objs:
+        sld.add_event_cb(
+            lambda event, button_name=name, slider=sld: slider_cb(
                 event, button_name, slider
             ),
             lv.EVENT.VALUE_CHANGED,
             None,
         )
 
     await asyncio.sleep_ms(500)  # await so the frame can be rendered
-    display._save_frame = False
+    await display.screenshot()
 
     # simulate touch events
     if display:
         print("INDEV + SLIDER TEST:")
         display.debug_indev(press=False)
         display.debug_display(False)
-        for _btn, name in _all_btns:
+        for _btn, name in _all_objs:
             pos = _btn.get_x(), _btn.get_y()
             pos2 = _btn.get_x2(), _btn.get_y2()
             x1, y1 = pos
@@ -65,7 +65,8 @@ def button_cb(event, name, slider):
             await display.swipe(x1 + 5, y_mid, x2 + (y2 - y1), y_mid, ms=500)
             await asyncio.sleep_ms(100)
 
-    return _all_btns
+    await display.screenshot("final")
+    return _all_objs
 
 
 __file__ = globals().get("__file__", "test")
@@ -78,5 +79,5 @@ def button_cb(event, name, slider):
 except Exception:
     display_config = testrunner.display_config
 
-testrunner.run(demo, __file__, disp_config=display_config)
+testrunner.run(sliders, __file__, disp_config=display_config)
 testrunner.devicereset()

tests/testdisplay.py

@@ -171,6 +171,10 @@ def _read_cb(self, indev, data):
                 print(f"[RELEASED]: ({self._x},{self._y})")
             data.state = self._dstate
 
+    def screenshot(self, name="screenshot"):
+        if hasattr(self.display_drv, "screenshot"):
+            return self.display_drv.screenshot(name)
+
 
 class DummyDisplay:
     def __init__(self, width=240, height=320, color_format=lv.COLOR_FORMAT.RGB565):
@@ -182,8 +186,11 @@ def __init__(self, width=240, height=320, color_format=lv.COLOR_FORMAT.RGB565):
         self.test_name = "testframe"
         self._header_set = False
         self._save_frame = sys.platform in ["darwin", "linux"]
+        # TODO use framebuf for snapshot
         self._debug = True
-        self._pbuff = bytearray(self.color_size)
+        if self._save_frame:
+            self._pbuff = bytearray(self.color_size)
+        self._save_frame = False
 
     @property
     def debug(self):
@@ -216,7 +223,27 @@ def save_frame(self, data, w, h):
                         pi += self.color_size
                     except Exception:
                         print(pi)
-            # fr.write(data)
+
+    async def screenshot(self, name="screenshot"):
+        _debug = self._debug
+        self._debug = False
+        self._save_frame = False
+
+        # Reset
+        self._rst_scr = lv.obj()
+        c_scr = lv.screen_active()
+        lv.screen_load(self._rst_scr)
+        await asyncio.sleep_ms(100)
+
+        # Load test screen
+        self._save_frame = sys.platform in ["darwin", "linux"]
+        self._header_set = False
+        self.test_name = f"{self.test_name}@{name}"
+        lv.screen_load(c_scr)
+        await asyncio.sleep_ms(100)
+
+        self._debug = _debug
+        self._save_frame = sys.platform in ["darwin", "linux"]
 
     def _shasum_frame(self, data):
         _hash = hashlib.sha256()
@@ -276,13 +303,13 @@ def get_display(
             if sys.platform not in ["darwin", "linux"]:
                 sys.print_exception(e)
     assert hasattr(disp, "width") is True, "expected width attribute in display driver"
-    assert hasattr(disp, "height") is True, (
-        "expected height attribute in display driver"
-    )
+    assert (
+        hasattr(disp, "height") is True
+    ), "expected height attribute in display driver"
 
-    assert hasattr(disp, "color_depth") is True, (
-        "expected color_depth attribute in display driver"
-    )
+    assert (
+        hasattr(disp, "color_depth") is True
+    ), "expected color_depth attribute in display driver"
 
     alloc_buffer = lambda buffersize: memoryview(bytearray(buffer_size))