Merge pull request #18 from koenvervloesem/ui_improvements

UI improvements

Author: koenvervloesem

docs/_static/screenshot.png

@@ -51,8 +51,9 @@ The footer shows shortcut keys that are recognized by the program:
 
 * Q: Quit the program
 * F: Filter the devices that are shown
-* A: Choose which advertisement data to show
-* S: Start or stop scan
+* S: Change settings
+* T: Start or stop scan
+* C: Clear all advertisements
 
 Filtering devices
 -----------------
@@ -61,17 +62,22 @@ If you press the **F** key, an input widget appears where you can start typing a
 
 When you click outside the filter widget or press **Tab** to bring the focus to the next visible widget, the filter widget disappears, but the filter is still applied to limit the shown advertisements. Just press **F** again to change the filter, for instance by removing the filter with **Backspace** or changing the Bluetooth address part to filter on.
 
-Showing and hiding advertisement data
--------------------------------------
+Changing settings
+-----------------
 
-If you press the **A** key, you can choose which advertising data types are shown in the table. By default all data types are shown, but you can enable or disable each of them individually by clicking on the checkbox or focusing it with **Tab** and then press **Enter** or **Space** to toggle it.
+If you press the **S** key, you can choose which advertising data types are shown in the table. By default all data types are shown, but you can enable or disable each of them individually by clicking on the checkbox or focusing it with **Tab** and then press **Enter** or **Space** to toggle it. You can also change some other settings, such as autoscrolling.
 
 Starting and stopping the scan
 ------------------------------
 
-If you press the **S** key, you stop the scan if it's running and you start the scan if it's stopped.
+If you press the **T** key, you stop the scan if it's running and you start the scan if it's stopped.
+
+When the scan is running and autoscrolling is enabled in the settings, the program continuously scrolls the table with advertisements so you are always seeing the most recent results. When the scan isn't running or autoscrolling is disabled, you can scroll through the history of received advertisements with the scroll wheel, by dragging the scroll bar, or by pressing **PgUp**, **PgDown** or the arrow keys up and down when the table widget is focused.
+
+Clearing all advertisements
+---------------------------
 
-When the scan is running, the program continuously scrolls the table with advertisements so you are always seeing the most recent results. When the scan isn't running, you can scroll through the history of received advertisements with the scroll wheel, by dragging the scroll bar, or by pressing **PgUp**, **PgDown** or the arrow keys up and down when the table widget is focused.
+If you press the **C** key, the program clears all received advertisements. The table is filled again with newly received advertisements.
 
 Quitting the program
 --------------------

docs/usage.rst

@@ -16,7 +16,7 @@
     from bleak.backends.bluezdbus.scanner import BlueZScannerArgs
 
 from humble_explorer.renderables import DeviceAddress, RichAdvertisement, Time
-from humble_explorer.widgets import FilterWidget, ShowDataWidget
+from humble_explorer.widgets import FilterWidget, SettingsWidget
 
 from . import __version__
 
@@ -31,12 +31,12 @@ class BLEScannerApp(App[None]):
     """A Textual app to scan for Bluetooth Low Energy advertisements."""
 
     CSS_PATH = "app.css"
-    TITLE = f"HumBLE Explorer {__version__}"
     BINDINGS = [
         ("q", "quit", "Quit"),
         ("f", "toggle_filter", "Filter"),
-        ("a", "toggle_data", "Data"),
-        ("s", "toggle_scan", "Toggle scan"),
+        ("s", "toggle_settings", "Settings"),
+        ("t", "toggle_scan", "Toggle scan"),
+        ("c", "clear_advertisements", "Clear"),
     ]
 
     address_filter = reactive("")
@@ -70,10 +70,14 @@ def __init__(self, cli_args: Namespace):
 
         super().__init__()
 
-    def action_toggle_data(self) -> None:
-        """Enable or disable data widget."""
-        data_widget = self.query_one(ShowDataWidget)
-        data_widget.display = not data_widget.display
+    def set_title(self, scanning_description):
+        """Set the title of the app with a description of the scanning status."""
+        self.title = f"HumBLE Explorer {__version__} ({scanning_description})"
+
+    def action_toggle_settings(self) -> None:
+        """Enable or disable settings widget."""
+        settings_widget = self.query_one(SettingsWidget)
+        settings_widget.display = not settings_widget.display
 
     def action_toggle_filter(self) -> None:
         """Enable or disable filter input widget."""
@@ -89,11 +93,16 @@ async def action_toggle_scan(self) -> None:
         else:
             await self.start_scan()
 
+    def action_clear_advertisements(self) -> None:
+        """Clear the list of received advertisements."""
+        self.advertisements = []
+        self.query_one(DataTable).clear()
+
     def compose(self) -> ComposeResult:
         """Create child widgets for the app."""
         yield Header()
         yield Footer()
-        yield ShowDataWidget(id="sidebar")
+        yield SettingsWidget(id="sidebar")
         yield FilterWidget(placeholder="address=")
         yield DataTable(zebra_stripes=True)
 
@@ -141,7 +150,8 @@ def on_checkbox_changed(self, message: Checkbox.Changed) -> None:
         """Show or hide advertisement data depending on the state of
         the checkboxes.
         """
-        self.recreate_table()
+        if "view" in message.input.classes:
+            self.recreate_table()
 
     def on_input_changed(self, message: Input.Changed) -> None:
         """Filter advertisements with user-supplied filter."""
@@ -168,6 +178,11 @@ def recreate_table(self):
                 RichAdvertisement(advertisement[2], self.show_data_config()),
             )
 
+    def scroll_if_autoscroll(self):
+        """Scroll to the end if autoscroll is enabled."""
+        if self.query_one("#autoscroll").value:
+            self.query_one(DataTable).scroll_end(animate=False)
+
     def add_advertisement_to_table(
         self, table, now, device_address, rich_advertisement
     ):
@@ -179,17 +194,19 @@ def add_advertisement_to_table(
                 rich_advertisement,
                 height=rich_advertisement.height(),
             )
-            table.scroll_end(animate=False)
+            self.scroll_if_autoscroll()
 
     async def start_scan(self) -> None:
         """Start BLE scan."""
         self.scanning = True
+        self.set_title("Scanning")
         await self.scanner.start()
 
     async def stop_scan(self) -> None:
         """Stop BLE scan."""
         self.scanning = False
+        self.set_title("Stopped")
         await self.scanner.stop()
         table = self.query_one(DataTable)
         table.add_row(Time(datetime.now(), style=_PAUSE_STYLE))
-        table.scroll_end(animate=False)
+        self.scroll_if_autoscroll()

src/humble_explorer/app.py

@@ -19,44 +19,50 @@ def on_blur(self, message: Input.on_blur) -> None:
         self.display = False
 
 
-class ShowDataWidget(Static):
-    """A Textual widget to let the user choose what advertisement data to show."""
+class SettingsWidget(Static):
+    """A Textual widget to let the user choose settings."""
 
     def __init__(self, *args, **kwargs):
         super().__init__(*args, **kwargs)
         self.display = False
 
     def compose(self) -> ComposeResult:
         """Show checkboxes."""
-        yield Static("[b]Show data\n")
+        yield Static("[b]Show data types[/b]\n")
         yield Horizontal(
             Static("Local name       ", classes="label"),
-            Checkbox(value=True, id="local_name"),
+            Checkbox(value=True, id="local_name", classes="view"),
             classes="container",
         )
         yield Horizontal(
             Static("RSSI             ", classes="label"),
-            Checkbox(value=True, id="rssi"),
+            Checkbox(value=True, id="rssi", classes="view"),
             classes="container",
         )
         yield Horizontal(
             Static("TX power         ", classes="label"),
-            Checkbox(value=True, id="tx_power"),
+            Checkbox(value=True, id="tx_power", classes="view"),
             classes="container",
         )
         yield Horizontal(
             Static("Manufacturer data", classes="label"),
-            Checkbox(value=True, id="manufacturer_data"),
+            Checkbox(value=True, id="manufacturer_data", classes="view"),
             classes="container",
         )
         yield Horizontal(
             Static("Service data     ", classes="label"),
-            Checkbox(value=True, id="service_data"),
+            Checkbox(value=True, id="service_data", classes="view"),
             classes="container",
         )
         yield Horizontal(
             Static("Service UUIDs    ", classes="label"),
-            Checkbox(value=True, id="service_uuids"),
+            Checkbox(value=True, id="service_uuids", classes="view"),
+            classes="container",
+        )
+        yield Static("\n[b]Other settings[/b]\n")
+        yield Horizontal(
+            Static("Auto-scroll      ", classes="label"),
+            Checkbox(value=True, id="autoscroll", classes="view"),
             classes="container",
         )