Merge pull request #512 from rough-street/swipe-hint-for-touchscreen-keyboards

odudex · web-flow · commit 94f0b8b2918d · 2025-02-24T10:42:08.000-03:00
Swipe hint for touchscreen keypads
diff --git a/.gitignore b/.gitignore
@@ -81,3 +81,6 @@ simulator/sd
 
 # ignore build-release files
 krux-*/ktool*
+
+# IDE files
+.vscode
diff --git a/i18n/translations/de-DE.json b/i18n/translations/de-DE.json
@@ -264,6 +264,7 @@
     "Store on Flash": "Auf Flash speichern",
     "Store on SD Card": "Auf der SD-Karte speichern",
     "Swipe to change mode": "Wischen um den Modus zu ändern",
+    "swipe" : "wischen",
     "TC Flash Hash": "TC Flash-Hash",
     "TC Flash Hash at Boot": "TC Flash-Hash beim Start",
     "TOUCH or ENTER to capture": "TOUCH oder ENTER zum Erfassen",
diff --git a/i18n/translations/es-MX.json b/i18n/translations/es-MX.json
@@ -263,6 +263,7 @@
     "Stats for Nerds": "Estadísticas para Entendidos",
     "Store on Flash": "Almacenar en Flash",
     "Store on SD Card": "Almacenar en la Tarjeta SD",
+    "swipe" : "deslizar",
     "Swipe to change mode": "Deslizar para cambiar de modo",
     "TC Flash Hash": "TC Hash Flash",
     "TC Flash Hash at Boot": "TC Flash Hash al arranque",
diff --git a/i18n/translations/fr-FR.json b/i18n/translations/fr-FR.json
@@ -263,6 +263,7 @@
     "Stats for Nerds": "Statistiques pour les geeks",
     "Store on Flash": "Stocker sur flash",
     "Store on SD Card": "Stocker sur la carte SD",
+    "swipe": "glisser",
     "Swipe to change mode": "Faites glisser pour changer de mode",
     "TC Flash Hash": "TC Flash Hash",
     "TC Flash Hash at Boot": "TC Flash Hash au démarrage",
diff --git a/i18n/translations/ja-JP.json b/i18n/translations/ja-JP.json
@@ -263,6 +263,7 @@
     "Stats for Nerds": "オタクのための統計",
     "Store on Flash": "フラッシュに保存する",
     "Store on SD Card": "SDカードに保存する",
+    "swipe": "スワイプ",
     "Swipe to change mode": "スワイプしてモードを変更する",
     "TC Flash Hash": "TCフラッシュハッシュ",
     "TC Flash Hash at Boot": "起動時のTCフラッシュハッシュ",
diff --git a/i18n/translations/ko-KR.json b/i18n/translations/ko-KR.json
@@ -263,6 +263,7 @@
     "Stats for Nerds": "전문가를 위한 통계",
     "Store on Flash": "플래시 메모리에 저장",
     "Store on SD Card": "SD카드에 저장",
+    "swipe": "스와이프",
     "Swipe to change mode": "모드를 변경하려면 화면을 옆으로 쓸어내리세요",
     "TC Flash Hash": "TC Flash Hash",
     "TC Flash Hash at Boot": "부팅 시 플래시 탬퍼 확인 해시",
diff --git a/i18n/translations/nl-NL.json b/i18n/translations/nl-NL.json
@@ -263,6 +263,7 @@
     "Stats for Nerds": "Statistieken voor nerds",
     "Store on Flash": "Opslaan op apparaat",
     "Store on SD Card": "Opslaan op SD kaart",
+    "swipe": "veeg", 
     "Swipe to change mode": "Verander modus",
     "TC Flash Hash": "TC Flash Hash",
     "TC Flash Hash at Boot": "Hash Flash bij het opstarten",
diff --git a/i18n/translations/pt-BR.json b/i18n/translations/pt-BR.json
@@ -263,6 +263,7 @@
     "Stats for Nerds": "Estatísticas para Nerds",
     "Store on Flash": "Armazene na Flash",
     "Store on SD Card": "Armazene no Cartão SD",
+    "swipe": "deslize",
     "Swipe to change mode": "Deslize para mudar de modo",
     "TC Flash Hash": "TC Flash Hash",
     "TC Flash Hash at Boot": "TC Hash Flash na Inicialização",
diff --git a/i18n/translations/ru-RU.json b/i18n/translations/ru-RU.json
@@ -263,6 +263,7 @@
     "Stats for Nerds": "Статистика для Гиков",
     "Store on Flash": "Сохранить на Флэш Память",
     "Store on SD Card": "Сохранить на SD Карту",
+    "swipe": "проведите",
     "Swipe to change mode": "Свайпните, чтобы сменить режим",
     "TC Flash Hash": "TC Flash Hash",
     "TC Flash Hash at Boot": "Проверка хэша Flash при загрузке",
diff --git a/i18n/translations/tr-TR.json b/i18n/translations/tr-TR.json
@@ -263,6 +263,7 @@
     "Stats for Nerds": "İnekler İçin İstatistikler",
     "Store on Flash": "Flash'ta Sakla",
     "Store on SD Card": "SD Kartta Sakla",
+    "swipe": "kaydırın",
     "Swipe to change mode": "Modu değiştirmek için kaydırın",
     "TC Flash Hash": "TC Flash Hash",
     "TC Flash Hash at Boot": "Önyüklemede TC Flash Hash",
diff --git a/i18n/translations/vi-VN.json b/i18n/translations/vi-VN.json
@@ -263,6 +263,7 @@
     "Stats for Nerds": "Số liệu thống kê cho Mọt sách",
     "Store on Flash": "Lưu trữ trên flash",
     "Store on SD Card": "Lưu trữ trên thẻ SD",
+    "swipe": "vuốt",
     "Swipe to change mode": "Vuốt để thay đổi chế độ",
     "TC Flash Hash": "TC Flash Hash",
     "TC Flash Hash at Boot": "Hash Flash TC khi khởi động",
diff --git a/i18n/translations/zh-CN.json b/i18n/translations/zh-CN.json
@@ -263,6 +263,7 @@
     "Stats for Nerds": "极客统计数据",
     "Store on Flash": "存储到 Flash",
     "Store on SD Card": "存储到 SD 卡",
+    "swipe": "滑动",
     "Swipe to change mode": "滑动切换模式",
     "TC Flash Hash": "TC Flash Hash",
     "TC Flash Hash at Boot": "启动时的 TC Flash Hash",
diff --git a/src/krux/pages/__init__.py b/src/krux/pages/__init__.py
@@ -33,6 +33,8 @@
     BUTTON_TOUCH,
     SWIPE_DOWN,
     SWIPE_UP,
+    SWIPE_LEFT,
+    SWIPE_RIGHT,
     ONE_MINUTE,
 )
 from ..display import (
@@ -142,11 +144,15 @@ def capture_from_keypad(
         buffer = starting_buffer
         pad = Keypad(self.ctx, keysets, possible_keys_fn)
         big_title = len(self.ctx.display.to_lines(title)) > 1
+        swipe_has_not_been_used = True
+        swipe_hint = "« " + t("swipe") + " »"
+        show_swipe_hint = False
         while True:
             self.ctx.display.clear()
             offset_y = MINIMAL_PADDING if big_title else DEFAULT_PADDING
             if lcd.string_width_px(buffer) < self.ctx.display.width():
-                self.ctx.display.draw_hcentered_text(title, offset_y)
+                text_to_show = title if not show_swipe_hint else swipe_hint
+                self.ctx.display.draw_hcentered_text(text_to_show, offset_y)
                 offset_y += 2 * FONT_HEIGHT if big_title else (FONT_HEIGHT * 3 // 2)
             self.ctx.display.draw_hcentered_text(buffer, offset_y)
             if progress_bar_fn:
@@ -156,6 +162,8 @@ def capture_from_keypad(
             pad.draw_keys()
             pad.draw_keyset_index()
             btn = self.ctx.input.wait_for_button()
+            show_swipe_hint = False  # unless overridden by a particular key,
+            # don't show the swipe hint after a key press
             if btn == BUTTON_TOUCH:
                 btn = pad.touch_to_physical()
             if btn == BUTTON_ENTER:
@@ -173,6 +181,9 @@ def capture_from_keypad(
                 elif pad.cur_key_index == pad.go_index:
                     break
                 elif pad.cur_key_index == pad.more_index:
+                    swipeable = self.ctx.input.touch is not None
+                    if swipeable and swipe_has_not_been_used:
+                        show_swipe_hint = True
                     pad.next_keyset()
                 elif pad.cur_key_index < len(pad.keys):
                     buffer += pad.keys[pad.cur_key_index]
@@ -188,6 +199,8 @@ def capture_from_keypad(
                 if changed and go_on_change:
                     break
             else:
+                if btn in (SWIPE_RIGHT, SWIPE_LEFT):
+                    swipe_has_not_been_used = False
                 pad.navigate(btn)
         if self.ctx.input.touch is not None:
             self.ctx.input.touch.clear_regions()
diff --git a/src/krux/translations/__init__.py b/src/krux/translations/__init__.py
@@ -345,6 +345,7 @@
     1303016265,
     619317523,
     2171149824,
+    3680102825,
     2904991687,
     1875891934,
 ]
diff --git a/src/krux/translations/de.py b/src/krux/translations/de.py
@@ -333,6 +333,7 @@
     "Ja",
     "Zoommodus",
     "ist eine gültige Adresse!",
+    "wischen",
     "unbekannt",
     "wurde in den ersten %d Adressen nicht gefunden",
 ]
diff --git a/src/krux/translations/es.py b/src/krux/translations/es.py
@@ -333,6 +333,7 @@
     "Sí",
     "Modo ampliado",
     "es una dirección válida!",
+    "deslizar",
     "desconocido",
     "NO FUE ENCONTRADO en las primeras %d direcciones",
 ]
diff --git a/src/krux/translations/fr.py b/src/krux/translations/fr.py
@@ -333,6 +333,7 @@
     "Oui",
     "Mode zoomé",
     "Adresse non valide\u2009!",
+    "glisser",
     "inconnu",
     "INTROUVABLE dans les %d premières adresses",
 ]
diff --git a/src/krux/translations/ja.py b/src/krux/translations/ja.py
@@ -333,6 +333,7 @@
     "はい",
     "ズームモード",
     "有効なアドレスです！",
+    "スワイプ",
     "不明",
     "最初の%dアドレスに見つかりませんでした",
 ]
diff --git a/src/krux/translations/ko.py b/src/krux/translations/ko.py
@@ -333,6 +333,7 @@
     "예",
     "확대 모드",
     "는 유효한 주소입니다!",
+    "스와이프",
     "알 수 없음",
     "첫 번째 %d개의 주소에서 찾을 수 없습니다",
 ]
diff --git a/src/krux/translations/nl.py b/src/krux/translations/nl.py
@@ -333,6 +333,7 @@
     "Yes",
     "Ingezoomde modus",
     "is geen geldig adres",
+    "veeg",
     "onbekend",
     "werd NIET GEVONDEN in de eerste %d adressen",
 ]
diff --git a/src/krux/translations/pt.py b/src/krux/translations/pt.py
@@ -333,6 +333,7 @@
     "Sim",
     "Modo ampliado",
     "é um endereço válido!",
+    "deslize",
     "desconhecida",
     "NÃO FOI ENCONTRADO nos primeiros %d endereços",
 ]
diff --git a/src/krux/translations/ru.py b/src/krux/translations/ru.py
@@ -333,6 +333,7 @@
     "Да",
     "Режим масштабирования",
     "некорректный адрес",
+    "проведите",
     "неизвестный",
     "нЕ НАЙДЕНО в первых %d адресах",
 ]
diff --git a/src/krux/translations/tr.py b/src/krux/translations/tr.py
@@ -333,6 +333,7 @@
     "Evet",
     "Zoom Mod",
     "geçerli bir adres!",
+    "kaydırın",
     "bilinmiyor",
     "ilk %d adreste BULUNAMADI",
 ]
diff --git a/src/krux/translations/vi.py b/src/krux/translations/vi.py
@@ -333,6 +333,7 @@
     "Đúng",
     "Chế độ thu phóng",
     "là một địa chỉ hợp lệ!",
+    "vuốt",
     "không rõ",
     "kHÔNG TÌM THẤY trong %d địa chỉ đầu tiên",
 ]
diff --git a/src/krux/translations/zh.py b/src/krux/translations/zh.py
@@ -333,6 +333,7 @@
     "是",
     "放大模式",
     " 非有效地址",
+    "滑动",
     "未知",
     "在前 %d 个地址中未找到",
 ]
diff --git a/tests/pages/test_page.py b/tests/pages/test_page.py
@@ -155,3 +155,111 @@ def test_display_qr_code_loop_through_brightness(mocker, m5stickv, mock_page_cls
         mocker.call(0, TEST_QR_DATA_IMAGE, light_color=DARKGREY),  # Darker
         mocker.call(0, TEST_QR_DATA_IMAGE),  # Default
     ]
+
+
+def get_frame_titles_resulting_from_input(
+    mocker, mock_page_cls, title, input_seq, use_buttons=False, has_touch=True
+):
+    from krux.input import BUTTON_TOUCH, SWIPE_RIGHT, BUTTON_PAGE, BUTTON_ENTER
+    from krux.pages.keypads import Keypad
+
+    def get_button_seq(key_index):
+        return [*([BUTTON_PAGE] * (key_index - 1))] + [BUTTON_ENTER]
+
+    keysets = ["123", "456"]  # both should be the same length
+    pad = Keypad(create_ctx(mocker, None), keysets, None)
+
+    button_seq = []
+    touch_seq = [] if has_touch else None
+    input_seq.append("go key")  # to exit capture_from_keypad
+
+    if has_touch and not use_buttons:
+        for i in input_seq:
+            if i == "more key":
+                button_seq.append(BUTTON_TOUCH)
+                touch_seq.append(pad.more_index)
+            elif i == "go key":
+                button_seq.append(BUTTON_TOUCH)
+                touch_seq.append(pad.go_index)
+            elif i == "normal key":
+                button_seq.append(BUTTON_TOUCH)
+                touch_seq.append(1)
+            elif i == "swipe":
+                button_seq.append(SWIPE_RIGHT)
+    else:
+        for i in input_seq:
+            if i == "more key":
+                button_seq = button_seq + get_button_seq(pad.more_index)
+            elif i == "go key":
+                button_seq = button_seq + get_button_seq(pad.go_index)
+            elif i == "normal key":
+                button_seq = button_seq + get_button_seq(1)
+
+    ctx = create_ctx(mocker, button_seq, None, None, touch_seq)
+    if not has_touch:
+        ctx.input.touch = None
+    page = mock_page_cls(ctx)
+    captured = page.capture_from_keypad(title, keysets)
+    frame_titles = [
+        t[0][0] for t in ctx.display.draw_hcentered_text.call_args_list if t[0][1] == 10
+    ]
+    return frame_titles
+
+
+def test_keypad_swipe_hint_is_shown_after_more_keypress_and_cleared_after_other_keypress(
+    mocker, amigo, mock_page_cls
+):
+    frame_titles = get_frame_titles_resulting_from_input(
+        mocker,
+        mock_page_cls,
+        "title",
+        ["more key", "normal key", "normal key", "more key"],
+    )
+    assert frame_titles[0] == "title"  # initial
+    assert frame_titles[1] == "« swipe »"  # after more key
+    assert frame_titles[2] == "title"  # after normal key
+    assert frame_titles[3] == "title"  # after normal key
+    assert frame_titles[4] == "« swipe »"  # after more key
+
+
+def test_keypad_swipe_hint_is_not_shown_once_user_has_swiped(
+    mocker, amigo, mock_page_cls
+):
+    frame_titles = get_frame_titles_resulting_from_input(
+        mocker,
+        mock_page_cls,
+        "title",
+        ["normal key", "more key", "normal key", "swipe", "more key"],
+    )
+    assert frame_titles[0] == "title"  # initial
+    assert frame_titles[1] == "title"  # after normal key
+    assert frame_titles[2] == "« swipe »"  # after more key
+    assert frame_titles[3] == "title"  # after normal key
+    assert frame_titles[4] == "title"  # after swipe
+    assert frame_titles[5] == "title"  # after more key (NO MORE HINT)
+
+
+def test_keypad_swipe_hint_is_not_shown_on_nontouch_device(
+    mocker, amigo, mock_page_cls
+):
+    # first check we get a hint if we have a touchscreen
+    frame_titles = get_frame_titles_resulting_from_input(
+        mocker,
+        mock_page_cls,
+        "title",
+        ["more key"],
+        use_buttons=True,  # force use of buttons so that we're using non-touch input
+        has_touch=True,
+    )
+    assert "« swipe »" in frame_titles
+
+    # now check that the same input does *not* show hint if we don't have a touchscreen
+    frame_titles = get_frame_titles_resulting_from_input(
+        mocker,
+        mock_page_cls,
+        "title",
+        ["more key"],
+        use_buttons=True,
+        has_touch=False,  # this time no touch screen
+    )
+    assert "« swipe »" not in frame_titles
