Merge pull request #56 from hnez/button-labels

ui: add button labels that tell the user which button does what

Author: hnez

src/ui/display.rs

@@ -73,6 +73,10 @@ pub struct ScreenShooter {
     inner: Arc<Mutex<DisplayExclusive>>,
 }
 
+pub struct DisplayRotated<'a> {
+    inner: &'a mut DisplayExclusive,
+}
+
 impl Display {
     pub fn new() -> Self {
         let mut fb = Framebuffer::new("/dev/fb0").unwrap();
@@ -136,6 +140,20 @@ impl ScreenShooter {
     }
 }
 
+impl DisplayExclusive {
+    /// Return an DrawTarget that draws everything rotated by 90deg
+    ///
+    /// Drawing a pixel to the bottom of DisplayRotated results in the pixel
+    /// appearing on the right of the actual screen.
+    pub fn rotate(&mut self) -> DisplayRotated {
+        // This could easily be made more generic, by accepting a direction
+        // parameter, but that would result in dead code because we only
+        // draw the button legend rotated.
+
+        DisplayRotated { inner: self }
+    }
+}
+
 impl DrawTarget for DisplayExclusive {
     type Color = BinaryColor;
     type Error = core::convert::Infallible;
@@ -176,3 +194,30 @@ impl OriginDimensions for DisplayExclusive {
         Size::new(self.0.var_screen_info.xres, self.0.var_screen_info.yres)
     }
 }
+
+impl<'a> DrawTarget for DisplayRotated<'a> {
+    type Color = BinaryColor;
+    type Error = core::convert::Infallible;
+
+    fn draw_iter<I>(&mut self, pixels: I) -> Result<(), Self::Error>
+    where
+        I: IntoIterator<Item = Pixel<Self::Color>>,
+    {
+        let res = self.size();
+        let res_y = res.height as i32;
+
+        let rotated_pixels = pixels
+            .into_iter()
+            .map(|Pixel(coord, color)| Pixel(Point::new(coord.y, res_y - coord.x), color));
+
+        self.inner.draw_iter(rotated_pixels)
+    }
+}
+
+impl<'a> OriginDimensions for DisplayRotated<'a> {
+    fn size(&self) -> Size {
+        let orig = self.inner.size();
+
+        Size::new(orig.height, orig.width)
+    }
+}

src/ui/screens.rs

@@ -134,31 +134,29 @@ pub(super) trait ActivatableScreen: Sync + Send {
 
 /// Draw static screen border containing a title and an indicator for the
 /// position of the screen in the list of screens.
-fn draw_border(text: &str, screen: NormalScreen, display: &Display) {
-    display.with_lock(|target| {
-        Text::new(
-            text,
-            Point::new(8, 17),
-            MonoTextStyle::new(&UI_TEXT_FONT, BinaryColor::On),
-        )
+fn draw_border(target: &mut DisplayExclusive, text: &str, screen: NormalScreen) {
+    Text::new(
+        text,
+        Point::new(8, 17),
+        MonoTextStyle::new(&UI_TEXT_FONT, BinaryColor::On),
+    )
+    .draw(target)
+    .unwrap();
+
+    Line::new(Point::new(0, 23), Point::new(240, 23))
+        .into_styled(PrimitiveStyle::with_stroke(BinaryColor::On, 2))
         .draw(target)
         .unwrap();
 
-        Line::new(Point::new(0, 24), Point::new(240, 24))
-            .into_styled(PrimitiveStyle::with_stroke(BinaryColor::On, 2))
-            .draw(target)
-            .unwrap();
-
-        let screen_idx = screen as i32;
-        let num_screens = (NormalScreen::Uart as i32) + 1;
-        let x_start = screen_idx * 240 / num_screens;
-        let x_end = (screen_idx + 1) * 240 / num_screens;
-
-        Line::new(Point::new(x_start, 240), Point::new(x_end, 240))
-            .into_styled(PrimitiveStyle::with_stroke(BinaryColor::On, 4))
-            .draw(target)
-            .unwrap();
-    });
+    let screen_idx = screen as i32;
+    let num_screens = (NormalScreen::Uart as i32) + 1;
+    let x_start = screen_idx * 240 / num_screens;
+    let x_end = (screen_idx + 1) * 240 / num_screens;
+
+    Line::new(Point::new(x_start, 240), Point::new(x_end, 240))
+        .into_styled(PrimitiveStyle::with_stroke(BinaryColor::On, 4))
+        .draw(target)
+        .unwrap();
 }
 
 const fn row_anchor(row_num: u8) -> Point {

src/ui/screens/dig_out.rs

@@ -33,7 +33,7 @@ const SCREEN_TYPE: NormalScreen = NormalScreen::DigOut;
 const VOLTAGE_MAX: f32 = 5.0;
 const OFFSET_INDICATOR: Point = Point::new(170, -10);
 const OFFSET_BAR: Point = Point::new(140, -14);
-const WIDTH_BAR: u32 = 72;
+const WIDTH_BAR: u32 = 62;
 const HEIGHT_BAR: u32 = 18;
 
 pub struct DigOutScreen {
@@ -60,8 +60,6 @@ impl ActivatableScreen for DigOutScreen {
     }
 
     fn activate(&mut self, ui: &Ui, display: Display) -> Box<dyn ActiveScreen> {
-        draw_border("Digital Out", SCREEN_TYPE, &display);
-
         let ports = [
             (
                 0,
@@ -81,6 +79,9 @@ impl ActivatableScreen for DigOutScreen {
             MonoTextStyle::new(&UI_TEXT_FONT, BinaryColor::On);
 
         display.with_lock(|target| {
+            draw_border(target, "Digital Out", SCREEN_TYPE);
+            draw_button_legend(target, "Action", "Screen");
+
             for (idx, name, _, _) in ports {
                 let anchor_name = row_anchor(idx * 4);
 

src/ui/screens/help.rs

@@ -96,6 +96,8 @@ impl ActivatableScreen for HelpScreen {
     }
 
     fn activate(&mut self, ui: &Ui, display: Display) -> Box<dyn ActiveScreen> {
+        display.with_lock(|target| draw_button_legend(target, "Action", "Leave"));
+
         let mut widgets = WidgetContainer::new(display);
 
         let up = Topic::anonymous(Some(false));

src/ui/screens/iobus.rs

@@ -51,12 +51,12 @@ impl ActivatableScreen for IoBusScreen {
     }
 
     fn activate(&mut self, ui: &Ui, display: Display) -> Box<dyn ActiveScreen> {
-        draw_border("IOBus", SCREEN_TYPE, &display);
-
         let ui_text_style: MonoTextStyle<BinaryColor> =
             MonoTextStyle::new(&UI_TEXT_FONT, BinaryColor::On);
 
         display.with_lock(|target| {
+            draw_border(target, "IOBus", SCREEN_TYPE);
+
             Text::new("CAN Status:", row_anchor(0), ui_text_style)
                 .draw(target)
                 .unwrap();
@@ -133,6 +133,21 @@ impl ActivatableScreen for IoBusScreen {
             )
         });
 
+        widgets.push(|display| {
+            DynamicWidget::button_legend(
+                ui.res.regulators.iobus_pwr_en.clone(),
+                display,
+                |state: &bool| {
+                    let lower = match *state {
+                        false => "Turn On",
+                        true => "Turn Off",
+                    };
+
+                    (lower.into(), "Screen".into())
+                },
+            )
+        });
+
         let iobus_pwr_en = ui.res.regulators.iobus_pwr_en.clone();
 
         let active = Active {

src/ui/screens/iobus_health.rs

@@ -76,6 +76,8 @@ impl ActivatableScreen for IoBusHealthScreen {
             MonoTextStyle::new(&UI_TEXT_FONT, BinaryColor::On);
 
         display.with_lock(|target| {
+            draw_button_legend(target, "Dismiss", "-");
+
             Text::new(
                 "IOBus supply overload",
                 row_anchor(0) - (row_anchor(1) - row_anchor(0)),

src/ui/screens/locator.rs

@@ -81,6 +81,8 @@ impl ActivatableScreen for LocatorScreen {
             MonoTextStyle::new(&UI_TEXT_FONT, BinaryColor::On);
 
         display.with_lock(|target| {
+            draw_button_legend(target, "Found it!", "-");
+
             Text::with_alignment(
                 "Locating this TAC",
                 Point::new(120, 80),

src/ui/screens/overtemperature.rs

@@ -75,6 +75,9 @@ impl ActivatableScreen for OverTemperatureScreen {
             MonoTextStyle::new(&UI_TEXT_FONT, BinaryColor::On);
 
         display.with_lock(|target| {
+            // This screen can only be left by resolving the underlying issue
+            draw_button_legend(target, "-", "-");
+
             Text::new("Temperature alert!", row_anchor(0), ui_text_style)
                 .draw(target)
                 .unwrap();

src/ui/screens/power.rs

@@ -33,7 +33,7 @@ const CURRENT_LIMIT: f32 = 5.0;
 const VOLTAGE_LIMIT: f32 = 48.0;
 const OFFSET_INDICATOR: Point = Point::new(155, -10);
 const OFFSET_BAR: Point = Point::new(112, -14);
-const WIDTH_BAR: u32 = 100;
+const WIDTH_BAR: u32 = 90;
 const HEIGHT_BAR: u32 = 18;
 
 pub struct PowerScreen;
@@ -56,7 +56,7 @@ impl ActivatableScreen for PowerScreen {
     }
 
     fn activate(&mut self, ui: &Ui, display: Display) -> Box<dyn ActiveScreen> {
-        draw_border("DUT Power", SCREEN_TYPE, &display);
+        display.with_lock(|target| draw_border(target, "DUT Power", SCREEN_TYPE));
 
         let mut widgets = WidgetContainer::new(display);
 
@@ -132,6 +132,21 @@ impl ActivatableScreen for PowerScreen {
             )
         });
 
+        widgets.push(|display| {
+            DynamicWidget::button_legend(
+                ui.res.dut_pwr.state.clone(),
+                display,
+                |state: &OutputState| {
+                    let lower = match state {
+                        OutputState::On => "Turn Off",
+                        _ => "Turn On",
+                    };
+
+                    (lower.into(), "Screen".into())
+                },
+            )
+        });
+
         let power_state = ui.res.dut_pwr.state.clone();
         let power_request = ui.res.dut_pwr.request.clone();
 

src/ui/screens/power_fail.rs

@@ -99,6 +99,8 @@ impl ActivatableScreen for PowerFailScreen {
             MonoTextStyle::new(&UI_TEXT_FONT, BinaryColor::On);
 
         display.with_lock(|target| {
+            draw_button_legend(target, "Select", "-");
+
             Text::new(
                 "DUT Power error",
                 row_anchor(0) - (row_anchor(1) - row_anchor(0)),
@@ -121,12 +123,16 @@ impl ActivatableScreen for PowerFailScreen {
                             "The error was resolved"
                         }
                         OutputState::InvertedPolarity => {
-                            "Output disabled due to\ninverted polarity."
+                            "Output disabled due\nto inverted polarity."
+                        }
+                        OutputState::OverCurrent => {
+                            "DUT powered off due\nto an overcurrent\nevent."
+                        }
+                        OutputState::OverVoltage => {
+                            "DUT powered off due\nto an overvoltage\nevent."
                         }
-                        OutputState::OverCurrent => "DUT powered off due to\nan overcurrent event.",
-                        OutputState::OverVoltage => "DUT powered off due to\nan overvoltage event.",
                         OutputState::RealtimeViolation => {
-                            "Output disabled due to\na realtime violation."
+                            "Output disabled due\n to a realtime\nviolation."
                         }
                         OutputState::Changing => "",
                     };
@@ -145,8 +151,8 @@ impl ActivatableScreen for PowerFailScreen {
                 row_anchor(6),
                 Box::new(|highlight: &Highlight| {
                     let msg = match highlight {
-                        Highlight::TurnOn => "> Turn output back on\n  Keep output off",
-                        Highlight::KeepOff => "  Turn output back on\n> Keep output off",
+                        Highlight::TurnOn => "> Turn back on\n  Keep output off",
+                        Highlight::KeepOff => "  Turn back on\n> Keep output off",
                     };
 
                     msg.to_string()