api/reboot: change confirmation text based on reboot purpose

Author: benma

py/bitbox02/bitbox02/communication/bitbox_api_protocol.py

@@ -647,11 +647,17 @@ def _msg_query(
             print(response)
         return response
 
-    def reboot(self) -> bool:
-        """TODO: Document"""
+    def reboot(
+        self, purpose: system.RebootRequest.Purpose = system.RebootRequest.Purpose.UPGRADE
+    ) -> bool:
+        """
+        Sends the reboot request. If the user confirms the request on the device, the device reboots
+        into the bootloader.
+        The purpose defines what confirmation message the user gets to see on the device.
+        """
         # pylint: disable=no-member
         request = hww.Request()
-        request.reboot.CopyFrom(system.RebootRequest())
+        request.reboot.CopyFrom(system.RebootRequest(purpose=purpose))
         try:
             self._msg_query(request)
         except OSError:

py/send_message.py

@@ -241,7 +241,12 @@ def _list_device_info(self) -> None:
         print(f"All info: {self._device.device_info()}")
 
     def _reboot(self) -> None:
-        if self._device.reboot():
+        inp = input("Select one of: 1=upgrade; 2=go to startup settings: ").strip()
+        purpose = {
+            "1": bitbox02.system.RebootRequest.Purpose.UPGRADE,  # pylint: disable=no-member
+            "2": bitbox02.system.RebootRequest.Purpose.SETTINGS,  # pylint: disable=no-member
+        }[inp]
+        if self._device.reboot(purpose=purpose):
             print("Device rebooted")
             self._stop = True
         else:
@@ -577,13 +582,6 @@ def _create_backup(self) -> None:
         except UserAbortException:
             print("Aborted by user")
 
-    def _reboot_bootloader(self) -> None:
-        if self._device.reboot():
-            print("Device rebooted")
-            self._stop = True
-            return
-        print("User aborted")
-
     def _toggle_mnemonic_passphrase(self) -> None:
         enabled = self._device.device_info()["mnemonic_passphrase_enabled"]
         try:
@@ -735,7 +733,7 @@ def _menu_init(self) -> None:
             ("Check backup", self._check_backup),
             ("Show mnemonic", self._show_mnemnoic_seed),
             ("Create backup", self._create_backup),
-            ("Reboot into bootloader", self._reboot_bootloader),
+            ("Reboot into bootloader", self._reboot),
             ("Check if SD card inserted", self._check_sd_presence),
             ("Insert SD card", self._insert_sdcard),
             ("Remove SD card", self._remove_sdcard),

src/rust/bitbox02-rust/src/hww/api/system.rs

@@ -15,14 +15,21 @@
 use super::Error;
 use crate::pb;
 
+use pb::reboot_request::Purpose;
 use pb::response::Response;
 
 use crate::workflow::confirm;
 
-pub async fn reboot(&pb::RebootRequest {}: &pb::RebootRequest) -> Result<Response, Error> {
+pub async fn reboot(&pb::RebootRequest { purpose }: &pb::RebootRequest) -> Result<Response, Error> {
     confirm::confirm(&confirm::Params {
         title: "",
-        body: "Proceed to upgrade?",
+        body: match Purpose::from_i32(purpose) {
+            Some(Purpose::Upgrade) => "Proceed to upgrade?",
+            Some(Purpose::Settings) => "Go to\nstartup settings?",
+            // No error, if new client library sends a purpose that we don't understand,
+            // we reboot anyway.
+            None => "Reboot?",
+        },
         ..Default::default()
     })
     .await?;